diff --git a/CHANGELOG.md b/CHANGELOG.md index 82642fddf52..9aeda88d4fb 100644 --- a/CHANGELOG.md +++ b/CHANGELOG.md @@ -1,5 +1,41 @@ # Changelog +## [2.133.0](https://github.com/googleapis/google-api-python-client/compare/v2.132.0...v2.133.0) (2024-06-11) + + +### Features + +* **accessapproval:** Update the api https://togithub.com/googleapis/google-api-python-client/commit/ed68923d2629cd1bddf10b804e63bddbcef907e2 ([46e3cf4](https://github.com/googleapis/google-api-python-client/commit/46e3cf4a5639facb4cb3603c470314195c715218)) +* **aiplatform:** Update the api https://togithub.com/googleapis/google-api-python-client/commit/50938ea02875c567c3a823009c3b8952d28a8489 ([46e3cf4](https://github.com/googleapis/google-api-python-client/commit/46e3cf4a5639facb4cb3603c470314195c715218)) +* **alloydb:** Update the api https://togithub.com/googleapis/google-api-python-client/commit/411cad83fe5941066e8173a60d73cf2118d65925 ([46e3cf4](https://github.com/googleapis/google-api-python-client/commit/46e3cf4a5639facb4cb3603c470314195c715218)) +* **androidmanagement:** Update the api https://togithub.com/googleapis/google-api-python-client/commit/94ac9e050260aa9165143854a93771fe3451a1ae ([46e3cf4](https://github.com/googleapis/google-api-python-client/commit/46e3cf4a5639facb4cb3603c470314195c715218)) +* **bigqueryconnection:** Update the api https://togithub.com/googleapis/google-api-python-client/commit/80d62812069074e284c9d5268ddcde6330b9cd34 ([46e3cf4](https://github.com/googleapis/google-api-python-client/commit/46e3cf4a5639facb4cb3603c470314195c715218)) +* **bigquery:** Update the api https://togithub.com/googleapis/google-api-python-client/commit/c2584ebfc726d29b86312fe0bc048b65f7052554 ([46e3cf4](https://github.com/googleapis/google-api-python-client/commit/46e3cf4a5639facb4cb3603c470314195c715218)) +* **clouddeploy:** Update the api https://togithub.com/googleapis/google-api-python-client/commit/ec43c8d4db18af457874deba233f4066dfa23e67 ([46e3cf4](https://github.com/googleapis/google-api-python-client/commit/46e3cf4a5639facb4cb3603c470314195c715218)) +* **connectors:** Update the api https://togithub.com/googleapis/google-api-python-client/commit/bb4945c6c627b5703c7495d6370e3be04debac9e ([46e3cf4](https://github.com/googleapis/google-api-python-client/commit/46e3cf4a5639facb4cb3603c470314195c715218)) +* **contactcenteraiplatform:** Update the api https://togithub.com/googleapis/google-api-python-client/commit/e554c80ea06035a150deebebb06aa1a4fd41dcfd ([46e3cf4](https://github.com/googleapis/google-api-python-client/commit/46e3cf4a5639facb4cb3603c470314195c715218)) +* **dataplex:** Update the api https://togithub.com/googleapis/google-api-python-client/commit/7a985a7f845be1e8eed58949eeab5392ceb9d681 ([46e3cf4](https://github.com/googleapis/google-api-python-client/commit/46e3cf4a5639facb4cb3603c470314195c715218)) +* **dataproc:** Update the api https://togithub.com/googleapis/google-api-python-client/commit/cf27327e622c696bacdbfec1321f45d6598f3bae ([46e3cf4](https://github.com/googleapis/google-api-python-client/commit/46e3cf4a5639facb4cb3603c470314195c715218)) +* **datastream:** Update the api https://togithub.com/googleapis/google-api-python-client/commit/51d984487911e49c5eb4a19570cfbfb944a249c8 ([46e3cf4](https://github.com/googleapis/google-api-python-client/commit/46e3cf4a5639facb4cb3603c470314195c715218)) +* **dialogflow:** Update the api https://togithub.com/googleapis/google-api-python-client/commit/da84cc40a9af0574b5ef4eb615964f7d57a9f144 ([46e3cf4](https://github.com/googleapis/google-api-python-client/commit/46e3cf4a5639facb4cb3603c470314195c715218)) +* **discoveryengine:** Update the api https://togithub.com/googleapis/google-api-python-client/commit/092bfcec6254957bbf1dc5145d4865d13e10dcf7 ([46e3cf4](https://github.com/googleapis/google-api-python-client/commit/46e3cf4a5639facb4cb3603c470314195c715218)) +* **dns:** Update the api https://togithub.com/googleapis/google-api-python-client/commit/40dd8f65e5a8b82b4046fdd7c1f484e88507bc8c ([46e3cf4](https://github.com/googleapis/google-api-python-client/commit/46e3cf4a5639facb4cb3603c470314195c715218)) +* **domains:** Update the api https://togithub.com/googleapis/google-api-python-client/commit/53fba763fafc0eba376e65bc57d9d9a3fe29a5a1 ([46e3cf4](https://github.com/googleapis/google-api-python-client/commit/46e3cf4a5639facb4cb3603c470314195c715218)) +* **games:** Update the api https://togithub.com/googleapis/google-api-python-client/commit/b9ed87df9b6b17c668e0b7d341c3a2fc551d7b7a ([46e3cf4](https://github.com/googleapis/google-api-python-client/commit/46e3cf4a5639facb4cb3603c470314195c715218)) +* **memcache:** Update the api https://togithub.com/googleapis/google-api-python-client/commit/6ba2a752a38345ac996f3139158363ed2ce6c403 ([46e3cf4](https://github.com/googleapis/google-api-python-client/commit/46e3cf4a5639facb4cb3603c470314195c715218)) +* **networkconnectivity:** Update the api https://togithub.com/googleapis/google-api-python-client/commit/6a3bf3dca4a96dfc8f8f6c6596fd8b21c40a04bd ([46e3cf4](https://github.com/googleapis/google-api-python-client/commit/46e3cf4a5639facb4cb3603c470314195c715218)) +* **notebooks:** Update the api https://togithub.com/googleapis/google-api-python-client/commit/a045dba9ffa6bdbce19c5431ea3f7c517398706a ([46e3cf4](https://github.com/googleapis/google-api-python-client/commit/46e3cf4a5639facb4cb3603c470314195c715218)) +* **pubsub:** Update the api https://togithub.com/googleapis/google-api-python-client/commit/3349e843ce895e1b3b7b1564b1ec504c0b12a00d ([46e3cf4](https://github.com/googleapis/google-api-python-client/commit/46e3cf4a5639facb4cb3603c470314195c715218)) +* **redis:** Update the api https://togithub.com/googleapis/google-api-python-client/commit/fb4d4b5141f37978005a21f8155d7b19280dcc77 ([46e3cf4](https://github.com/googleapis/google-api-python-client/commit/46e3cf4a5639facb4cb3603c470314195c715218)) +* **sqladmin:** Update the api https://togithub.com/googleapis/google-api-python-client/commit/08f0aa1824f505721a09c10238e59bc2777ab453 ([46e3cf4](https://github.com/googleapis/google-api-python-client/commit/46e3cf4a5639facb4cb3603c470314195c715218)) +* **vmmigration:** Update the api https://togithub.com/googleapis/google-api-python-client/commit/cb830e416867a2f0666f92a73572d4e42988098a ([46e3cf4](https://github.com/googleapis/google-api-python-client/commit/46e3cf4a5639facb4cb3603c470314195c715218)) + + +### Bug Fixes + +* **chat:** Update the api https://togithub.com/googleapis/google-api-python-client/commit/17071ef9f24d25408e063d37a4840445ece1b3e4 ([46e3cf4](https://github.com/googleapis/google-api-python-client/commit/46e3cf4a5639facb4cb3603c470314195c715218)) +* **dataflow:** Update the api https://togithub.com/googleapis/google-api-python-client/commit/743be6674070e92425fee6ff124e8fbc111e2ffd ([46e3cf4](https://github.com/googleapis/google-api-python-client/commit/46e3cf4a5639facb4cb3603c470314195c715218)) + ## [2.132.0](https://github.com/googleapis/google-api-python-client/compare/v2.131.0...v2.132.0) (2024-06-04) diff --git a/docs/dyn/accessapproval_v1.folders.html b/docs/dyn/accessapproval_v1.folders.html index 5a75d51b387..4857ff7c92d 100644 --- a/docs/dyn/accessapproval_v1.folders.html +++ b/docs/dyn/accessapproval_v1.folders.html @@ -150,6 +150,7 @@

Method Details

"notificationPubsubTopic": "A String", # Optional. A pubsub topic to which notifications relating to approval requests should be sent. "preferNoBroadApprovalRequests": True or False, # This preference is communicated to Google personnel when sending an approval request but can be overridden if necessary. "preferredRequestExpirationDays": 42, # This preference is shared with Google personnel, but can be overridden if said personnel deems necessary. The approver ultimately can set the expiration at approval time. + "requestScopeMaxWidthPreference": "A String", # Optional. A setting to indicate the maximum width of an Access Approval request. "requireCustomerVisibleJustification": True or False, # Optional. A setting to require approval request justifications to be customer visible. } @@ -201,6 +202,7 @@

Method Details

"notificationPubsubTopic": "A String", # Optional. A pubsub topic to which notifications relating to approval requests should be sent. "preferNoBroadApprovalRequests": True or False, # This preference is communicated to Google personnel when sending an approval request but can be overridden if necessary. "preferredRequestExpirationDays": 42, # This preference is shared with Google personnel, but can be overridden if said personnel deems necessary. The approver ultimately can set the expiration at approval time. + "requestScopeMaxWidthPreference": "A String", # Optional. A setting to indicate the maximum width of an Access Approval request. "requireCustomerVisibleJustification": True or False, # Optional. A setting to require approval request justifications to be customer visible. } @@ -231,6 +233,7 @@

Method Details

"notificationPubsubTopic": "A String", # Optional. A pubsub topic to which notifications relating to approval requests should be sent. "preferNoBroadApprovalRequests": True or False, # This preference is communicated to Google personnel when sending an approval request but can be overridden if necessary. "preferredRequestExpirationDays": 42, # This preference is shared with Google personnel, but can be overridden if said personnel deems necessary. The approver ultimately can set the expiration at approval time. + "requestScopeMaxWidthPreference": "A String", # Optional. A setting to indicate the maximum width of an Access Approval request. "requireCustomerVisibleJustification": True or False, # Optional. A setting to require approval request justifications to be customer visible. } diff --git a/docs/dyn/accessapproval_v1.organizations.html b/docs/dyn/accessapproval_v1.organizations.html index 3278dd2182b..28742c492a3 100644 --- a/docs/dyn/accessapproval_v1.organizations.html +++ b/docs/dyn/accessapproval_v1.organizations.html @@ -150,6 +150,7 @@

Method Details

"notificationPubsubTopic": "A String", # Optional. A pubsub topic to which notifications relating to approval requests should be sent. "preferNoBroadApprovalRequests": True or False, # This preference is communicated to Google personnel when sending an approval request but can be overridden if necessary. "preferredRequestExpirationDays": 42, # This preference is shared with Google personnel, but can be overridden if said personnel deems necessary. The approver ultimately can set the expiration at approval time. + "requestScopeMaxWidthPreference": "A String", # Optional. A setting to indicate the maximum width of an Access Approval request. "requireCustomerVisibleJustification": True or False, # Optional. A setting to require approval request justifications to be customer visible. } @@ -201,6 +202,7 @@

Method Details

"notificationPubsubTopic": "A String", # Optional. A pubsub topic to which notifications relating to approval requests should be sent. "preferNoBroadApprovalRequests": True or False, # This preference is communicated to Google personnel when sending an approval request but can be overridden if necessary. "preferredRequestExpirationDays": 42, # This preference is shared with Google personnel, but can be overridden if said personnel deems necessary. The approver ultimately can set the expiration at approval time. + "requestScopeMaxWidthPreference": "A String", # Optional. A setting to indicate the maximum width of an Access Approval request. "requireCustomerVisibleJustification": True or False, # Optional. A setting to require approval request justifications to be customer visible. } @@ -231,6 +233,7 @@

Method Details

"notificationPubsubTopic": "A String", # Optional. A pubsub topic to which notifications relating to approval requests should be sent. "preferNoBroadApprovalRequests": True or False, # This preference is communicated to Google personnel when sending an approval request but can be overridden if necessary. "preferredRequestExpirationDays": 42, # This preference is shared with Google personnel, but can be overridden if said personnel deems necessary. The approver ultimately can set the expiration at approval time. + "requestScopeMaxWidthPreference": "A String", # Optional. A setting to indicate the maximum width of an Access Approval request. "requireCustomerVisibleJustification": True or False, # Optional. A setting to require approval request justifications to be customer visible. } diff --git a/docs/dyn/accessapproval_v1.projects.html b/docs/dyn/accessapproval_v1.projects.html index f032e0e7eb4..5e71fe99a72 100644 --- a/docs/dyn/accessapproval_v1.projects.html +++ b/docs/dyn/accessapproval_v1.projects.html @@ -150,6 +150,7 @@

Method Details

"notificationPubsubTopic": "A String", # Optional. A pubsub topic to which notifications relating to approval requests should be sent. "preferNoBroadApprovalRequests": True or False, # This preference is communicated to Google personnel when sending an approval request but can be overridden if necessary. "preferredRequestExpirationDays": 42, # This preference is shared with Google personnel, but can be overridden if said personnel deems necessary. The approver ultimately can set the expiration at approval time. + "requestScopeMaxWidthPreference": "A String", # Optional. A setting to indicate the maximum width of an Access Approval request. "requireCustomerVisibleJustification": True or False, # Optional. A setting to require approval request justifications to be customer visible. } @@ -201,6 +202,7 @@

Method Details

"notificationPubsubTopic": "A String", # Optional. A pubsub topic to which notifications relating to approval requests should be sent. "preferNoBroadApprovalRequests": True or False, # This preference is communicated to Google personnel when sending an approval request but can be overridden if necessary. "preferredRequestExpirationDays": 42, # This preference is shared with Google personnel, but can be overridden if said personnel deems necessary. The approver ultimately can set the expiration at approval time. + "requestScopeMaxWidthPreference": "A String", # Optional. A setting to indicate the maximum width of an Access Approval request. "requireCustomerVisibleJustification": True or False, # Optional. A setting to require approval request justifications to be customer visible. } @@ -231,6 +233,7 @@

Method Details

"notificationPubsubTopic": "A String", # Optional. A pubsub topic to which notifications relating to approval requests should be sent. "preferNoBroadApprovalRequests": True or False, # This preference is communicated to Google personnel when sending an approval request but can be overridden if necessary. "preferredRequestExpirationDays": 42, # This preference is shared with Google personnel, but can be overridden if said personnel deems necessary. The approver ultimately can set the expiration at approval time. + "requestScopeMaxWidthPreference": "A String", # Optional. A setting to indicate the maximum width of an Access Approval request. "requireCustomerVisibleJustification": True or False, # Optional. A setting to require approval request justifications to be customer visible. } diff --git a/docs/dyn/admin_directory_v1.chromeosdevices.html b/docs/dyn/admin_directory_v1.chromeosdevices.html index 8c71bab50b6..303526701a9 100644 --- a/docs/dyn/admin_directory_v1.chromeosdevices.html +++ b/docs/dyn/admin_directory_v1.chromeosdevices.html @@ -309,7 +309,7 @@

Method Details

Args: customerId: string, The unique ID for the customer's Google Workspace account. As an account administrator, you can also use the `my_customer` alias to represent your account's `customerId`. The `customerId` is also returned as part of the [Users resource](/admin-sdk/directory/v1/reference/users). (required) includeChildOrgunits: boolean, Return devices from all child orgunits, as well as the specified org unit. If this is set to true, 'orgUnitPath' must be provided. - maxResults: integer, Maximum number of results to return, value should not exceed 300. + maxResults: integer, Maximum number of results to return. Value should not exceed 300. orderBy: string, Device property to use for sorting results. Allowed values annotatedLocation - Chrome device location as annotated by the administrator. diff --git a/docs/dyn/aiplatform_v1.publishers.models.html b/docs/dyn/aiplatform_v1.publishers.models.html index 5a326d1bac6..a8d9a2e2202 100644 --- a/docs/dyn/aiplatform_v1.publishers.models.html +++ b/docs/dyn/aiplatform_v1.publishers.models.html @@ -218,20 +218,6 @@

Method Details

"A String", ], }, - "fineTune": { # The regional resource name or the URI. Key is region, e.g., us-central1, europe-west2, global, etc.. # Optional. Fine tune the PublisherModel with the third-party model tuning UI. - "references": { # Required. - "a_key": { # Reference to a resource. - "description": "A String", # Description of the resource. - "resourceName": "A String", # The resource name of the Google Cloud resource. - "uri": "A String", # The URI of the resource. - "useCase": "A String", # Use case (CUJ) of the resource. - }, - }, - "resourceDescription": "A String", # Optional. Description of the resource. - "resourceTitle": "A String", # Optional. Title of the resource. - "resourceUseCase": "A String", # Optional. Use case (CUJ) of the resource. - "title": "A String", # Required. - }, "openEvaluationPipeline": { # The regional resource name or the URI. Key is region, e.g., us-central1, europe-west2, global, etc.. # Optional. Open evaluation pipeline of the PublisherModel. "references": { # Required. "a_key": { # Reference to a resource. diff --git a/docs/dyn/aiplatform_v1beta1.projects.locations.cachedContents.html b/docs/dyn/aiplatform_v1beta1.projects.locations.cachedContents.html index ee23f781c9c..f47b4294764 100644 --- a/docs/dyn/aiplatform_v1beta1.projects.locations.cachedContents.html +++ b/docs/dyn/aiplatform_v1beta1.projects.locations.cachedContents.html @@ -477,24 +477,7 @@

Method Details

Returns: An object of the form: - { # This resource represents a long-running operation that is the result of a network API call. - "done": True or False, # If the value is `false`, it means the operation is still in progress. If `true`, the operation is completed, and either `error` or `response` is available. - "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). # The error result of the operation in case of failure or cancellation. - "code": 42, # The status code, which should be an enum value of google.rpc.Code. - "details": [ # A list of messages that carry the error details. There is a common set of message types for APIs to use. - { - "a_key": "", # Properties of the object. Contains field @type with type URL. - }, - ], - "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. - }, - "metadata": { # Service-specific metadata associated with the operation. It typically contains progress information and common metadata such as create time. Some services might not provide such metadata. Any method that returns a long-running operation should document the metadata type, if any. - "a_key": "", # Properties of the object. Contains field @type with type URL. - }, - "name": "A String", # The server-assigned name, which is only unique within the same service that originally returns it. If you use the default HTTP mapping, the `name` should be a resource name ending with `operations/{unique_id}`. - "response": { # The normal, successful response of the operation. If the original method returns no data on success, such as `Delete`, the response is `google.protobuf.Empty`. If the original method is standard `Get`/`Create`/`Update`, the response should be the resource. For other methods, the response should have the type `XxxResponse`, where `Xxx` is the original method name. For example, if the original method name is `TakeSnapshot()`, the inferred response type is `TakeSnapshotResponse`. - "a_key": "", # Properties of the object. Contains field @type with type URL. - }, + { # A generic empty message that you can re-use to avoid defining duplicated empty messages in your APIs. A typical example is to use it as the request or the response type of an API method. For instance: service Foo { rpc Bar(google.protobuf.Empty) returns (google.protobuf.Empty); } } diff --git a/docs/dyn/aiplatform_v1beta1.projects.locations.endpoints.html b/docs/dyn/aiplatform_v1beta1.projects.locations.endpoints.html index 50820bc6cdb..fe9bd3c437e 100644 --- a/docs/dyn/aiplatform_v1beta1.projects.locations.endpoints.html +++ b/docs/dyn/aiplatform_v1beta1.projects.locations.endpoints.html @@ -147,6 +147,9 @@

Instance Methods

streamGenerateContent(model, body=None, x__xgafv=None)

Generate content with multimodal inputs with streaming support.

+

+ streamRawPredict(endpoint, body=None, x__xgafv=None)

+

Perform a streaming online prediction with an arbitrary HTTP payload.

testIamPermissions(resource, permissions=None, x__xgafv=None)

Returns permissions that a caller has on the specified resource. If the resource does not exist, this will return an empty set of permissions, not a `NOT_FOUND` error. Note: This operation is designed to be used for building permission-aware UIs and command-line tools, not for authorization checking. This operation may "fail open" without warning.

@@ -3238,6 +3241,46 @@

Method Details

} +
+ streamRawPredict(endpoint, body=None, x__xgafv=None) +
Perform a streaming online prediction with an arbitrary HTTP payload.
+
+Args:
+  endpoint: string, Required. The name of the Endpoint requested to serve the prediction. Format: `projects/{project}/locations/{location}/endpoints/{endpoint}` (required)
+  body: object, The request body.
+    The object takes the form of:
+
+{ # Request message for PredictionService.StreamRawPredict.
+  "httpBody": { # Message that represents an arbitrary HTTP body. It should only be used for payload formats that can't be represented as JSON, such as raw binary or an HTML page. This message can be used both in streaming and non-streaming API methods in the request as well as the response. It can be used as a top-level request field, which is convenient if one wants to extract parameters from either the URL or HTTP template into the request fields and also want access to the raw HTTP body. Example: message GetResourceRequest { // A unique request id. string request_id = 1; // The raw HTTP body is bound to this field. google.api.HttpBody http_body = 2; } service ResourceService { rpc GetResource(GetResourceRequest) returns (google.api.HttpBody); rpc UpdateResource(google.api.HttpBody) returns (google.protobuf.Empty); } Example with streaming methods: service CaldavService { rpc GetCalendar(stream google.api.HttpBody) returns (stream google.api.HttpBody); rpc UpdateCalendar(stream google.api.HttpBody) returns (stream google.api.HttpBody); } Use of this type only changes how the request and response bodies are handled, all other features will continue to work unchanged. # The prediction input. Supports HTTP headers and arbitrary data payload.
+    "contentType": "A String", # The HTTP Content-Type header value specifying the content type of the body.
+    "data": "A String", # The HTTP request/response body as raw binary.
+    "extensions": [ # Application specific response metadata. Must be set in the first response for streaming APIs.
+      {
+        "a_key": "", # Properties of the object. Contains field @type with type URL.
+      },
+    ],
+  },
+}
+
+  x__xgafv: string, V1 error format.
+    Allowed values
+      1 - v1 error format
+      2 - v2 error format
+
+Returns:
+  An object of the form:
+
+    { # Message that represents an arbitrary HTTP body. It should only be used for payload formats that can't be represented as JSON, such as raw binary or an HTML page. This message can be used both in streaming and non-streaming API methods in the request as well as the response. It can be used as a top-level request field, which is convenient if one wants to extract parameters from either the URL or HTTP template into the request fields and also want access to the raw HTTP body. Example: message GetResourceRequest { // A unique request id. string request_id = 1; // The raw HTTP body is bound to this field. google.api.HttpBody http_body = 2; } service ResourceService { rpc GetResource(GetResourceRequest) returns (google.api.HttpBody); rpc UpdateResource(google.api.HttpBody) returns (google.protobuf.Empty); } Example with streaming methods: service CaldavService { rpc GetCalendar(stream google.api.HttpBody) returns (stream google.api.HttpBody); rpc UpdateCalendar(stream google.api.HttpBody) returns (stream google.api.HttpBody); } Use of this type only changes how the request and response bodies are handled, all other features will continue to work unchanged.
+  "contentType": "A String", # The HTTP Content-Type header value specifying the content type of the body.
+  "data": "A String", # The HTTP request/response body as raw binary.
+  "extensions": [ # Application specific response metadata. Must be set in the first response for streaming APIs.
+    {
+      "a_key": "", # Properties of the object. Contains field @type with type URL.
+    },
+  ],
+}
+
+
testIamPermissions(resource, permissions=None, x__xgafv=None)
Returns permissions that a caller has on the specified resource. If the resource does not exist, this will return an empty set of permissions, not a `NOT_FOUND` error. Note: This operation is designed to be used for building permission-aware UIs and command-line tools, not for authorization checking. This operation may "fail open" without warning.
diff --git a/docs/dyn/aiplatform_v1beta1.projects.locations.modelMonitors.html b/docs/dyn/aiplatform_v1beta1.projects.locations.modelMonitors.html
index 73ea3b1fbd8..c8be57a2d1b 100644
--- a/docs/dyn/aiplatform_v1beta1.projects.locations.modelMonitors.html
+++ b/docs/dyn/aiplatform_v1beta1.projects.locations.modelMonitors.html
@@ -1404,13 +1404,6 @@ 

Method Details

"pageSize": 42, # The standard list page size. "pageToken": "A String", # A page token received from a previous ModelMonitoringService.SearchModelMonitoringStats call. "statsFilter": { # Filter for searching ModelMonitoringStats. # Filter for search different stats. - "genAiStatsFilter": { # GenAi statistics filter. # GenAi statistics filter. - "clusterId": "A String", # From a particular cluster of monitoring results. - "modelMonitoringJob": "A String", # From a particular monitoring job. - "modelMonitoringSchedule": "A String", # From a particular monitoring schedule. - "objectiveType": "A String", # One of the supported monitoring objectives: `gen-ai-general` `gen-ai-evaluation` `gen-ai-safety` - "statsName": "A String", # If not specified, will return all the stats_names. - }, "tabularStatsFilter": { # Tabular statistics filter. # Tabular statistics filter. "algorithm": "A String", # Specify the algorithm type used for distance calculation, eg: jensen_shannon_divergence, l_infinity. "modelMonitoringJob": "A String", # From a particular monitoring job. @@ -1436,34 +1429,6 @@

Method Details

{ # Response message for ModelMonitoringService.SearchModelMonitoringStats. "monitoringStats": [ # Stats retrieved for requested objectives. { # Represents the collection of statistics for a metric. - "genAiStats": { # A collection of data points that describes the time-varying values of a gen ai metric. # Generated gen ai statistics. - "dataPoints": [ # The data points of this time series. When listing time series, points are returned in reverse time order. - { # Represents a single statistics data point. - "algorithm": "A String", # Algorithm used to calculated the metrics, eg: jensen_shannon_divergence, l_infinity. - "baselineStats": { # Typed value of the statistics. # Statistics from baseline dataset. - "distributionValue": { # Summary statistics for a population of values. # Distribution. - "distribution": "", # Predictive monitoring drift distribution in `tensorflow.metadata.v0.DatasetFeatureStatistics` format. - "distributionDeviation": 3.14, # Distribution distance deviation from the current dataset's statistics to baseline dataset's statistics. * For categorical feature, the distribution distance is calculated by L-inifinity norm or Jensen–Shannon divergence. * For numerical feature, the distribution distance is calculated by Jensen–Shannon divergence. - }, - "doubleValue": 3.14, # Double. - }, - "createTime": "A String", # Statistics create time. - "currentStats": { # Typed value of the statistics. # Statistics from current dataset. - "distributionValue": { # Summary statistics for a population of values. # Distribution. - "distribution": "", # Predictive monitoring drift distribution in `tensorflow.metadata.v0.DatasetFeatureStatistics` format. - "distributionDeviation": 3.14, # Distribution distance deviation from the current dataset's statistics to baseline dataset's statistics. * For categorical feature, the distribution distance is calculated by L-inifinity norm or Jensen–Shannon divergence. * For numerical feature, the distribution distance is calculated by Jensen–Shannon divergence. - }, - "doubleValue": 3.14, # Double. - }, - "hasAnomaly": True or False, # Indicate if the statistics has anomaly. - "modelMonitoringJob": "A String", # Model monitoring job resource name. - "schedule": "A String", # Schedule resource name. - "thresholdValue": 3.14, # Threshold value. - }, - ], - "objectiveType": "A String", # One of the supported monitoring objectives: `gen-ai-general` `gen-ai-evaluation` `gen-ai-safety` - "statsName": "A String", # The stats name. - }, "tabularStats": { # A collection of data points that describes the time-varying values of a tabular metric. # Generated tabular statistics. "dataPoints": [ # The data points of this time series. When listing time series, points are returned in reverse time order. { # Represents a single statistics data point. diff --git a/docs/dyn/aiplatform_v1beta1.projects.locations.publishers.models.html b/docs/dyn/aiplatform_v1beta1.projects.locations.publishers.models.html index cde13c36aee..a6a0aca6fe4 100644 --- a/docs/dyn/aiplatform_v1beta1.projects.locations.publishers.models.html +++ b/docs/dyn/aiplatform_v1beta1.projects.locations.publishers.models.html @@ -101,6 +101,9 @@

Instance Methods

streamGenerateContent(model, body=None, x__xgafv=None)

Generate content with multimodal inputs with streaming support.

+

+ streamRawPredict(endpoint, body=None, x__xgafv=None)

+

Perform a streaming online prediction with an arbitrary HTTP payload.

Method Details

close() @@ -1171,4 +1174,44 @@

Method Details

}
+
+ streamRawPredict(endpoint, body=None, x__xgafv=None) +
Perform a streaming online prediction with an arbitrary HTTP payload.
+
+Args:
+  endpoint: string, Required. The name of the Endpoint requested to serve the prediction. Format: `projects/{project}/locations/{location}/endpoints/{endpoint}` (required)
+  body: object, The request body.
+    The object takes the form of:
+
+{ # Request message for PredictionService.StreamRawPredict.
+  "httpBody": { # Message that represents an arbitrary HTTP body. It should only be used for payload formats that can't be represented as JSON, such as raw binary or an HTML page. This message can be used both in streaming and non-streaming API methods in the request as well as the response. It can be used as a top-level request field, which is convenient if one wants to extract parameters from either the URL or HTTP template into the request fields and also want access to the raw HTTP body. Example: message GetResourceRequest { // A unique request id. string request_id = 1; // The raw HTTP body is bound to this field. google.api.HttpBody http_body = 2; } service ResourceService { rpc GetResource(GetResourceRequest) returns (google.api.HttpBody); rpc UpdateResource(google.api.HttpBody) returns (google.protobuf.Empty); } Example with streaming methods: service CaldavService { rpc GetCalendar(stream google.api.HttpBody) returns (stream google.api.HttpBody); rpc UpdateCalendar(stream google.api.HttpBody) returns (stream google.api.HttpBody); } Use of this type only changes how the request and response bodies are handled, all other features will continue to work unchanged. # The prediction input. Supports HTTP headers and arbitrary data payload.
+    "contentType": "A String", # The HTTP Content-Type header value specifying the content type of the body.
+    "data": "A String", # The HTTP request/response body as raw binary.
+    "extensions": [ # Application specific response metadata. Must be set in the first response for streaming APIs.
+      {
+        "a_key": "", # Properties of the object. Contains field @type with type URL.
+      },
+    ],
+  },
+}
+
+  x__xgafv: string, V1 error format.
+    Allowed values
+      1 - v1 error format
+      2 - v2 error format
+
+Returns:
+  An object of the form:
+
+    { # Message that represents an arbitrary HTTP body. It should only be used for payload formats that can't be represented as JSON, such as raw binary or an HTML page. This message can be used both in streaming and non-streaming API methods in the request as well as the response. It can be used as a top-level request field, which is convenient if one wants to extract parameters from either the URL or HTTP template into the request fields and also want access to the raw HTTP body. Example: message GetResourceRequest { // A unique request id. string request_id = 1; // The raw HTTP body is bound to this field. google.api.HttpBody http_body = 2; } service ResourceService { rpc GetResource(GetResourceRequest) returns (google.api.HttpBody); rpc UpdateResource(google.api.HttpBody) returns (google.protobuf.Empty); } Example with streaming methods: service CaldavService { rpc GetCalendar(stream google.api.HttpBody) returns (stream google.api.HttpBody); rpc UpdateCalendar(stream google.api.HttpBody) returns (stream google.api.HttpBody); } Use of this type only changes how the request and response bodies are handled, all other features will continue to work unchanged.
+  "contentType": "A String", # The HTTP Content-Type header value specifying the content type of the body.
+  "data": "A String", # The HTTP request/response body as raw binary.
+  "extensions": [ # Application specific response metadata. Must be set in the first response for streaming APIs.
+    {
+      "a_key": "", # Properties of the object. Contains field @type with type URL.
+    },
+  ],
+}
+
+ \ No newline at end of file diff --git a/docs/dyn/aiplatform_v1beta1.projects.locations.ragCorpora.html b/docs/dyn/aiplatform_v1beta1.projects.locations.ragCorpora.html index e255cbab287..88f01e84c96 100644 --- a/docs/dyn/aiplatform_v1beta1.projects.locations.ragCorpora.html +++ b/docs/dyn/aiplatform_v1beta1.projects.locations.ragCorpora.html @@ -122,6 +122,13 @@

Method Details

"description": "A String", # Optional. The description of the RagCorpus. "displayName": "A String", # Required. The display name of the RagCorpus. The name can be up to 128 characters long and can consist of any UTF-8 characters. "name": "A String", # Output only. The resource name of the RagCorpus. + "ragEmbeddingModelConfig": { # Config for the embedding model to use for RAG. # Optional. Immutable. The embedding model config of the RagCorpus. + "vertexPredictionEndpoint": { # Config representing a model hosted on Vertex Prediction Endpoint. # The Vertex AI Prediction Endpoint that either refers to a publisher model or an endpoint that is hosting a 1P fine-tuned text embedding model. Endpoints hosting non-1P fine-tuned text embedding models are currently not supported. + "endpoint": "A String", # Required. The endpoint resource name. Format: `projects/{project}/locations/{location}/publishers/{publisher}/models/{model}` or `projects/{project}/locations/{location}/endpoints/{endpoint}` + "model": "A String", # Output only. The resource name of the model that is deployed on the endpoint. Present only when the endpoint is not a publisher model. Pattern: `projects/{project}/locations/{location}/models/{model}` + "modelVersionId": "A String", # Output only. Version ID of the model that is deployed on the endpoint. Present only when the endpoint is not a publisher model. + }, + }, "updateTime": "A String", # Output only. Timestamp when this RagCorpus was last updated. } @@ -209,6 +216,13 @@

Method Details

"description": "A String", # Optional. The description of the RagCorpus. "displayName": "A String", # Required. The display name of the RagCorpus. The name can be up to 128 characters long and can consist of any UTF-8 characters. "name": "A String", # Output only. The resource name of the RagCorpus. + "ragEmbeddingModelConfig": { # Config for the embedding model to use for RAG. # Optional. Immutable. The embedding model config of the RagCorpus. + "vertexPredictionEndpoint": { # Config representing a model hosted on Vertex Prediction Endpoint. # The Vertex AI Prediction Endpoint that either refers to a publisher model or an endpoint that is hosting a 1P fine-tuned text embedding model. Endpoints hosting non-1P fine-tuned text embedding models are currently not supported. + "endpoint": "A String", # Required. The endpoint resource name. Format: `projects/{project}/locations/{location}/publishers/{publisher}/models/{model}` or `projects/{project}/locations/{location}/endpoints/{endpoint}` + "model": "A String", # Output only. The resource name of the model that is deployed on the endpoint. Present only when the endpoint is not a publisher model. Pattern: `projects/{project}/locations/{location}/models/{model}` + "modelVersionId": "A String", # Output only. Version ID of the model that is deployed on the endpoint. Present only when the endpoint is not a publisher model. + }, + }, "updateTime": "A String", # Output only. Timestamp when this RagCorpus was last updated. } @@ -237,6 +251,13 @@

Method Details

"description": "A String", # Optional. The description of the RagCorpus. "displayName": "A String", # Required. The display name of the RagCorpus. The name can be up to 128 characters long and can consist of any UTF-8 characters. "name": "A String", # Output only. The resource name of the RagCorpus. + "ragEmbeddingModelConfig": { # Config for the embedding model to use for RAG. # Optional. Immutable. The embedding model config of the RagCorpus. + "vertexPredictionEndpoint": { # Config representing a model hosted on Vertex Prediction Endpoint. # The Vertex AI Prediction Endpoint that either refers to a publisher model or an endpoint that is hosting a 1P fine-tuned text embedding model. Endpoints hosting non-1P fine-tuned text embedding models are currently not supported. + "endpoint": "A String", # Required. The endpoint resource name. Format: `projects/{project}/locations/{location}/publishers/{publisher}/models/{model}` or `projects/{project}/locations/{location}/endpoints/{endpoint}` + "model": "A String", # Output only. The resource name of the model that is deployed on the endpoint. Present only when the endpoint is not a publisher model. Pattern: `projects/{project}/locations/{location}/models/{model}` + "modelVersionId": "A String", # Output only. Version ID of the model that is deployed on the endpoint. Present only when the endpoint is not a publisher model. + }, + }, "updateTime": "A String", # Output only. Timestamp when this RagCorpus was last updated. }, ], diff --git a/docs/dyn/aiplatform_v1beta1.projects.locations.ragCorpora.ragFiles.html b/docs/dyn/aiplatform_v1beta1.projects.locations.ragCorpora.ragFiles.html index eadd3888959..62ebe65c71b 100644 --- a/docs/dyn/aiplatform_v1beta1.projects.locations.ragCorpora.ragFiles.html +++ b/docs/dyn/aiplatform_v1beta1.projects.locations.ragCorpora.ragFiles.html @@ -202,6 +202,7 @@

Method Details

}, ], }, + "maxEmbeddingRequestsPerMin": 42, # Optional. The max number of queries per minute that this job is allowed to make to the embedding model specified on the corpus. This value is specific to this job and not shared across other import jobs. Consult the Quotas page on the project to set an appropriate value here. If unspecified, a default value of 1,000 QPM would be used. "ragFileChunkingConfig": { # Specifies the size and overlap of chunks for RagFiles. # Specifies the size and overlap of chunks after importing RagFiles. "chunkOverlap": 42, # The overlap between chunks. "chunkSize": 42, # The size of the chunks. diff --git a/docs/dyn/aiplatform_v1beta1.publishers.models.html b/docs/dyn/aiplatform_v1beta1.publishers.models.html index 9b1091ee5e2..e338fef5858 100644 --- a/docs/dyn/aiplatform_v1beta1.publishers.models.html +++ b/docs/dyn/aiplatform_v1beta1.publishers.models.html @@ -233,20 +233,6 @@

Method Details

"A String", ], }, - "fineTune": { # The regional resource name or the URI. Key is region, e.g., us-central1, europe-west2, global, etc.. # Optional. Fine tune the PublisherModel with the third-party model tuning UI. - "references": { # Required. - "a_key": { # Reference to a resource. - "description": "A String", # Description of the resource. - "resourceName": "A String", # The resource name of the Google Cloud resource. - "uri": "A String", # The URI of the resource. - "useCase": "A String", # Use case (CUJ) of the resource. - }, - }, - "resourceDescription": "A String", # Optional. Description of the resource. - "resourceTitle": "A String", # Optional. Title of the resource. - "resourceUseCase": "A String", # Optional. Use case (CUJ) of the resource. - "title": "A String", # Required. - }, "openEvaluationPipeline": { # The regional resource name or the URI. Key is region, e.g., us-central1, europe-west2, global, etc.. # Optional. Open evaluation pipeline of the PublisherModel. "references": { # Required. "a_key": { # Reference to a resource. @@ -544,20 +530,6 @@

Method Details

"A String", ], }, - "fineTune": { # The regional resource name or the URI. Key is region, e.g., us-central1, europe-west2, global, etc.. # Optional. Fine tune the PublisherModel with the third-party model tuning UI. - "references": { # Required. - "a_key": { # Reference to a resource. - "description": "A String", # Description of the resource. - "resourceName": "A String", # The resource name of the Google Cloud resource. - "uri": "A String", # The URI of the resource. - "useCase": "A String", # Use case (CUJ) of the resource. - }, - }, - "resourceDescription": "A String", # Optional. Description of the resource. - "resourceTitle": "A String", # Optional. Title of the resource. - "resourceUseCase": "A String", # Optional. Use case (CUJ) of the resource. - "title": "A String", # Required. - }, "openEvaluationPipeline": { # The regional resource name or the URI. Key is region, e.g., us-central1, europe-west2, global, etc.. # Optional. Open evaluation pipeline of the PublisherModel. "references": { # Required. "a_key": { # Reference to a resource. diff --git a/docs/dyn/airquality_v1.currentConditions.html b/docs/dyn/airquality_v1.currentConditions.html new file mode 100644 index 00000000000..27aab20c79e --- /dev/null +++ b/docs/dyn/airquality_v1.currentConditions.html @@ -0,0 +1,170 @@ + + + +

Air Quality API . currentConditions

+

Instance Methods

+

+ close()

+

Close httplib2 connections.

+

+ lookup(body=None, x__xgafv=None)

+

The Current Conditions endpoint provides hourly air quality information in more than 100 countries, up to a 500 x 500 meters resolution. Includes over 70 local indexes and global air quality index and categories.

+

Method Details

+
+ close() +
Close httplib2 connections.
+
+ +
+ lookup(body=None, x__xgafv=None) +
The Current Conditions endpoint provides hourly air quality information in more than 100 countries, up to a 500 x 500 meters resolution. Includes over 70 local indexes and global air quality index and categories.
+
+Args:
+  body: object, The request body.
+    The object takes the form of:
+
+{ # The request definition of the air quality current conditions.
+  "customLocalAqis": [ # Optional. Expresses a 'country/region to AQI' relationship. Pairs a country/region with a desired AQI so that air quality data that is required for that country/region will be displayed according to the chosen AQI. This parameter can be used to specify a non-default AQI for a given country, for example, to get the US EPA index for Canada rather than the default index for Canada.
+    { # Expresses a 'country/region to AQI' relationship. Pairs a country/region with a desired AQI so that air quality data that is required for that country/region will be displayed according to the chosen AQI.
+      "aqi": "A String", # The AQI to associate the country/region with. Value should be a [valid index](/maps/documentation/air-quality/laqis) code.
+      "regionCode": "A String", # The country/region requiring the custom AQI. Value should be provided using [ISO 3166-1 alpha-2](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2) code.
+    },
+  ],
+  "extraComputations": [ # Optional. Additional features that can be optionally enabled. Specifying extra computations will result in the relevant elements and fields to be returned in the response.
+    "A String",
+  ],
+  "languageCode": "A String", # Optional. Allows the client to choose the language for the response. If data cannot be provided for that language the API uses the closest match. Allowed values rely on the IETF standard. Default value is en.
+  "location": { # 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. # Required. The longitude and latitude from which the API looks for air quality current conditions data.
+    "latitude": 3.14, # The latitude in degrees. It must be in the range [-90.0, +90.0].
+    "longitude": 3.14, # The longitude in degrees. It must be in the range [-180.0, +180.0].
+  },
+  "uaqiColorPalette": "A String", # Optional. Determines the color palette used for data provided by the 'Universal Air Quality Index' (UAQI). This color palette is relevant just for UAQI, other AQIs have a predetermined color palette that can't be controlled.
+  "universalAqi": True or False, # Optional. If set to true, the Universal AQI will be included in the 'indexes' field of the response. Default value is true.
+}
+
+  x__xgafv: string, V1 error format.
+    Allowed values
+      1 - v1 error format
+      2 - v2 error format
+
+Returns:
+  An object of the form:
+
+    {
+  "dateTime": "A String", # A rounded down timestamp in RFC3339 UTC "Zulu" format, with nanosecond resolution and up to nine fractional digits. For example: "2014-10-02T15:00:00Z".
+  "healthRecommendations": { # Health recommendations for different population groups in a free text format. The recommendations are derived from their associated air quality conditions. # Health advice and recommended actions related to the reported air quality conditions. Recommendations are tailored differently for populations at risk, groups with greater sensitivities to pollutants, and the general population.
+    "athletes": "A String", # Sports and other strenuous outdoor activities.
+    "children": "A String", # Younger populations including children, toddlers, and babies.
+    "elderly": "A String", # Retirees and people older than the general population.
+    "generalPopulation": "A String", # No specific sensitivities.
+    "heartDiseasePopulation": "A String", # Heart and circulatory system diseases.
+    "lungDiseasePopulation": "A String", # Respiratory related problems and asthma suffers.
+    "pregnantWomen": "A String", # Women at all stages of pregnancy.
+  },
+  "indexes": [ # Based on the request parameters, this list will include (up to) two air quality indexes: - Universal AQI. Will be returned if the universalAqi boolean is set to true. - Local AQI. Will be returned if the LOCAL_AQI extra computation is specified.
+    { # The basic object for representing different air quality metrics. When brought together, these metrics provide a snapshot about the current air quality conditions. There are multiple indexes in the world serving different purposes and groups interested in measuring different aspects of air quality.
+      "aqi": 42, #  The index's numeric score. Examples: 10, 100. The value is not normalized and should only be interpreted in the context of its related air-quality index. For non-numeric indexes, this field will not be returned. Note: This field should be used for calculations, graph display, etc. For displaying the index score, you should use the AQI display field.
+      "aqiDisplay": "A String", # Textual representation of the index numeric score, that may include prefix or suffix symbols, which usually represents the worst index score. Example: >100 or 10+. Note: This field should be used when you want to display the index score. For non-numeric indexes, this field is empty.
+      "category": "A String", # Textual classification of the index numeric score interpretation. For example: "Excellent air quality".
+      "code": "A String", # The index's code. This field represents the index for programming purposes by using snake case instead of spaces. Examples: "uaqi", "fra_atmo".
+      "color": { # Represents a color in the RGBA color space. This representation is designed for simplicity of conversion to and from color representations in various languages over compactness. For example, the fields of this representation can be trivially provided to the constructor of `java.awt.Color` in Java; it can also be trivially provided to UIColor's `+colorWithRed:green:blue:alpha` method in iOS; and, with just a little work, it can be easily formatted into a CSS `rgba()` string in JavaScript. This reference page doesn't have information about the absolute color space that should be used to interpret the RGB value—for example, sRGB, Adobe RGB, DCI-P3, and BT.2020. By default, applications should assume the sRGB color space. When color equality needs to be decided, implementations, unless documented otherwise, treat two colors as equal if all their red, green, blue, and alpha values each differ by at most `1e-5`. Example (Java): import com.google.type.Color; // ... public static java.awt.Color fromProto(Color protocolor) { float alpha = protocolor.hasAlpha() ? protocolor.getAlpha().getValue() : 1.0; return new java.awt.Color( protocolor.getRed(), protocolor.getGreen(), protocolor.getBlue(), alpha); } public static Color toProto(java.awt.Color color) { float red = (float) color.getRed(); float green = (float) color.getGreen(); float blue = (float) color.getBlue(); float denominator = 255.0; Color.Builder resultBuilder = Color .newBuilder() .setRed(red / denominator) .setGreen(green / denominator) .setBlue(blue / denominator); int alpha = color.getAlpha(); if (alpha != 255) { result.setAlpha( FloatValue .newBuilder() .setValue(((float) alpha) / denominator) .build()); } return resultBuilder.build(); } // ... Example (iOS / Obj-C): // ... static UIColor* fromProto(Color* protocolor) { float red = [protocolor red]; float green = [protocolor green]; float blue = [protocolor blue]; FloatValue* alpha_wrapper = [protocolor alpha]; float alpha = 1.0; if (alpha_wrapper != nil) { alpha = [alpha_wrapper value]; } return [UIColor colorWithRed:red green:green blue:blue alpha:alpha]; } static Color* toProto(UIColor* color) { CGFloat red, green, blue, alpha; if (![color getRed:&red green:&green blue:&blue alpha:&alpha]) { return nil; } Color* result = [[Color alloc] init]; [result setRed:red]; [result setGreen:green]; [result setBlue:blue]; if (alpha <= 0.9999) { [result setAlpha:floatWrapperWithValue(alpha)]; } [result autorelease]; return result; } // ... Example (JavaScript): // ... var protoToCssColor = function(rgb_color) { var redFrac = rgb_color.red || 0.0; var greenFrac = rgb_color.green || 0.0; var blueFrac = rgb_color.blue || 0.0; var red = Math.floor(redFrac * 255); var green = Math.floor(greenFrac * 255); var blue = Math.floor(blueFrac * 255); if (!('alpha' in rgb_color)) { return rgbToCssColor(red, green, blue); } var alphaFrac = rgb_color.alpha.value || 0.0; var rgbParams = [red, green, blue].join(','); return ['rgba(', rgbParams, ',', alphaFrac, ')'].join(''); }; var rgbToCssColor = function(red, green, blue) { var rgbNumber = new Number((red << 16) | (green << 8) | blue); var hexString = rgbNumber.toString(16); var missingZeros = 6 - hexString.length; var resultBuilder = ['#']; for (var i = 0; i < missingZeros; i++) { resultBuilder.push('0'); } resultBuilder.push(hexString); return resultBuilder.join(''); }; // ... # The color used to represent the AQI numeric score.
+        "alpha": 3.14, # The fraction of this color that should be applied to the pixel. That is, the final pixel color is defined by the equation: `pixel color = alpha * (this color) + (1.0 - alpha) * (background color)` This means that a value of 1.0 corresponds to a solid color, whereas a value of 0.0 corresponds to a completely transparent color. This uses a wrapper message rather than a simple float scalar so that it is possible to distinguish between a default value and the value being unset. If omitted, this color object is rendered as a solid color (as if the alpha value had been explicitly given a value of 1.0).
+        "blue": 3.14, # The amount of blue in the color as a value in the interval [0, 1].
+        "green": 3.14, # The amount of green in the color as a value in the interval [0, 1].
+        "red": 3.14, # The amount of red in the color as a value in the interval [0, 1].
+      },
+      "displayName": "A String", # A human readable representation of the index name. Example: "AQI (US)"
+      "dominantPollutant": "A String", # The chemical symbol of the dominant pollutant. For example: "CO".
+    },
+  ],
+  "pollutants": [ # A list of pollutants affecting the location specified in the request. Note: This field will be returned only for requests that specified one or more of the following extra computations: POLLUTANT_ADDITIONAL_INFO, DOMINANT_POLLUTANT_CONCENTRATION, POLLUTANT_CONCENTRATION.
+    { # Data regarding an air quality pollutant.
+      "additionalInfo": { # The emission sources and health effects of a given pollutant. # Additional information about the pollutant.
+        "effects": "A String", # Text representing the pollutant's main health effects.
+        "sources": "A String", # Text representing the pollutant's main emission sources.
+      },
+      "code": "A String", # The pollutant's code name. For example: "so2". A list of all available codes could be found [here](/maps/documentation/air-quality/pollutants#reported_pollutants).
+      "concentration": { # The concentration of a given pollutant in the air. # The pollutant's concentration level measured by one of the standard air pollutation measure units.
+        "units": "A String", # Units for measuring this pollutant concentration.
+        "value": 3.14, # Value of pollutant concentration.
+      },
+      "displayName": "A String", # The pollutant's display name. For example: "NOx".
+      "fullName": "A String", # The pollutant's full name. For chemical compounds, this is the IUPAC name. Example: "Sulfur Dioxide". For more information about the IUPAC names table, see https://iupac.org/what-we-do/periodic-table-of-elements/
+    },
+  ],
+  "regionCode": "A String", # The ISO_3166-1 alpha-2 code of the country/region corresponding to the location provided in the request. This field might be omitted from the response if the location provided in the request resides in a disputed territory.
+}
+
+ + \ No newline at end of file diff --git a/docs/dyn/airquality_v1.forecast.html b/docs/dyn/airquality_v1.forecast.html new file mode 100644 index 00000000000..36da836cb9b --- /dev/null +++ b/docs/dyn/airquality_v1.forecast.html @@ -0,0 +1,199 @@ + + + +

Air Quality API . forecast

+

Instance Methods

+

+ close()

+

Close httplib2 connections.

+

+ lookup(body=None, x__xgafv=None)

+

Returns air quality forecast for a specific location for a given time range.

+

+ lookup_next()

+

Retrieves the next page of results.

+

Method Details

+
+ close() +
Close httplib2 connections.
+
+ +
+ lookup(body=None, x__xgafv=None) +
Returns air quality forecast for a specific location for a given time range.
+
+Args:
+  body: object, The request body.
+    The object takes the form of:
+
+{ # The request object of the air quality forecast API.
+  "customLocalAqis": [ # Optional. Expresses a 'country/region to AQI' relationship. Pairs a country/region with a desired AQI so that air quality data that is required for that country/region will be displayed according to the chosen AQI. This parameter can be used to specify a non-default AQI for a given country, for example, to get the US EPA index for Canada rather than the default index for Canada.
+    { # Expresses a 'country/region to AQI' relationship. Pairs a country/region with a desired AQI so that air quality data that is required for that country/region will be displayed according to the chosen AQI.
+      "aqi": "A String", # The AQI to associate the country/region with. Value should be a [valid index](/maps/documentation/air-quality/laqis) code.
+      "regionCode": "A String", # The country/region requiring the custom AQI. Value should be provided using [ISO 3166-1 alpha-2](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2) code.
+    },
+  ],
+  "dateTime": "A String", # A timestamp for which to return the data for a specific point in time. The timestamp is rounded to the previous exact hour. Note: this will return hourly data for the requested timestamp only (i.e. a single hourly info element). For example, a request sent where the date_time parameter is set to 2023-01-03T11:05:49Z will be rounded down to 2023-01-03T11:00:00Z.
+  "extraComputations": [ # Optional. Additional features that can be optionally enabled. Specifying extra computations will result in the relevant elements and fields to be returned in the response.
+    "A String",
+  ],
+  "languageCode": "A String", # Optional. Allows the client to choose the language for the response. If data cannot be provided for that language the API uses the closest match. Allowed values rely on the IETF standard (default = 'en').
+  "location": { # 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. # Required. The latitude and longitude for which the API looks for air quality data.
+    "latitude": 3.14, # The latitude in degrees. It must be in the range [-90.0, +90.0].
+    "longitude": 3.14, # The longitude in degrees. It must be in the range [-180.0, +180.0].
+  },
+  "pageSize": 42, # Optional. The maximum number of hourly info records to return per page (default = 24).
+  "pageToken": "A String", # Optional. A page token received from a previous forecast call. It is used to retrieve the subsequent page.
+  "period": { # Represents a time interval, encoded as a Timestamp start (inclusive) and a Timestamp end (exclusive). The start must be less than or equal to the end. When the start equals the end, the interval is empty (matches no time). When both start and end are unspecified, the interval matches any time. # Indicates the start and end period for which to get the forecast data. The timestamp is rounded to the previous exact hour.
+    "endTime": "A String", # Optional. Exclusive end of the interval. If specified, a Timestamp matching this interval will have to be before the end.
+    "startTime": "A String", # Optional. Inclusive start of the interval. If specified, a Timestamp matching this interval will have to be the same or after the start.
+  },
+  "uaqiColorPalette": "A String", # Optional. Determines the color palette used for data provided by the 'Universal Air Quality Index' (UAQI). This color palette is relevant just for UAQI, other AQIs have a predetermined color palette that can't be controlled.
+  "universalAqi": True or False, # Optional. If set to true, the Universal AQI will be included in the 'indexes' field of the response (default = true).
+}
+
+  x__xgafv: string, V1 error format.
+    Allowed values
+      1 - v1 error format
+      2 - v2 error format
+
+Returns:
+  An object of the form:
+
+    { # The response object of the air quality forecast API.
+  "hourlyForecasts": [ # Optional. Contains the air quality information for each hour in the requested range. For example, if the request is for 48 hours of forecast there will be 48 elements of hourly forecasts.
+    { # Contains the air quality information for each hour in the requested range. For example, if the request is for 48 hours of forecast there will be 48 elements of hourly forecasts.
+      "dateTime": "A String", # A rounded down timestamp indicating the time (hour) the data refers to in RFC3339 UTC "Zulu" format. For example: "2014-10-02T15:00:00Z".
+      "healthRecommendations": { # Health recommendations for different population groups in a free text format. The recommendations are derived from their associated air quality conditions. # Health advice and recommended actions related to the reported air quality conditions. Recommendations are tailored differently for populations at risk, groups with greater sensitivities to pollutants, and the general population.
+        "athletes": "A String", # Sports and other strenuous outdoor activities.
+        "children": "A String", # Younger populations including children, toddlers, and babies.
+        "elderly": "A String", # Retirees and people older than the general population.
+        "generalPopulation": "A String", # No specific sensitivities.
+        "heartDiseasePopulation": "A String", # Heart and circulatory system diseases.
+        "lungDiseasePopulation": "A String", # Respiratory related problems and asthma suffers.
+        "pregnantWomen": "A String", # Women at all stages of pregnancy.
+      },
+      "indexes": [ # Based on the request parameters, this list will include (up to) two air quality indexes: - Universal AQI. Will be returned if the `universal_aqi` boolean is set to true. - Local AQI. Will be returned if the LOCAL_AQI extra computation is specified.
+        { # The basic object for representing different air quality metrics. When brought together, these metrics provide a snapshot about the current air quality conditions. There are multiple indexes in the world serving different purposes and groups interested in measuring different aspects of air quality.
+          "aqi": 42, #  The index's numeric score. Examples: 10, 100. The value is not normalized and should only be interpreted in the context of its related air-quality index. For non-numeric indexes, this field will not be returned. Note: This field should be used for calculations, graph display, etc. For displaying the index score, you should use the AQI display field.
+          "aqiDisplay": "A String", # Textual representation of the index numeric score, that may include prefix or suffix symbols, which usually represents the worst index score. Example: >100 or 10+. Note: This field should be used when you want to display the index score. For non-numeric indexes, this field is empty.
+          "category": "A String", # Textual classification of the index numeric score interpretation. For example: "Excellent air quality".
+          "code": "A String", # The index's code. This field represents the index for programming purposes by using snake case instead of spaces. Examples: "uaqi", "fra_atmo".
+          "color": { # Represents a color in the RGBA color space. This representation is designed for simplicity of conversion to and from color representations in various languages over compactness. For example, the fields of this representation can be trivially provided to the constructor of `java.awt.Color` in Java; it can also be trivially provided to UIColor's `+colorWithRed:green:blue:alpha` method in iOS; and, with just a little work, it can be easily formatted into a CSS `rgba()` string in JavaScript. This reference page doesn't have information about the absolute color space that should be used to interpret the RGB value—for example, sRGB, Adobe RGB, DCI-P3, and BT.2020. By default, applications should assume the sRGB color space. When color equality needs to be decided, implementations, unless documented otherwise, treat two colors as equal if all their red, green, blue, and alpha values each differ by at most `1e-5`. Example (Java): import com.google.type.Color; // ... public static java.awt.Color fromProto(Color protocolor) { float alpha = protocolor.hasAlpha() ? protocolor.getAlpha().getValue() : 1.0; return new java.awt.Color( protocolor.getRed(), protocolor.getGreen(), protocolor.getBlue(), alpha); } public static Color toProto(java.awt.Color color) { float red = (float) color.getRed(); float green = (float) color.getGreen(); float blue = (float) color.getBlue(); float denominator = 255.0; Color.Builder resultBuilder = Color .newBuilder() .setRed(red / denominator) .setGreen(green / denominator) .setBlue(blue / denominator); int alpha = color.getAlpha(); if (alpha != 255) { result.setAlpha( FloatValue .newBuilder() .setValue(((float) alpha) / denominator) .build()); } return resultBuilder.build(); } // ... Example (iOS / Obj-C): // ... static UIColor* fromProto(Color* protocolor) { float red = [protocolor red]; float green = [protocolor green]; float blue = [protocolor blue]; FloatValue* alpha_wrapper = [protocolor alpha]; float alpha = 1.0; if (alpha_wrapper != nil) { alpha = [alpha_wrapper value]; } return [UIColor colorWithRed:red green:green blue:blue alpha:alpha]; } static Color* toProto(UIColor* color) { CGFloat red, green, blue, alpha; if (![color getRed:&red green:&green blue:&blue alpha:&alpha]) { return nil; } Color* result = [[Color alloc] init]; [result setRed:red]; [result setGreen:green]; [result setBlue:blue]; if (alpha <= 0.9999) { [result setAlpha:floatWrapperWithValue(alpha)]; } [result autorelease]; return result; } // ... Example (JavaScript): // ... var protoToCssColor = function(rgb_color) { var redFrac = rgb_color.red || 0.0; var greenFrac = rgb_color.green || 0.0; var blueFrac = rgb_color.blue || 0.0; var red = Math.floor(redFrac * 255); var green = Math.floor(greenFrac * 255); var blue = Math.floor(blueFrac * 255); if (!('alpha' in rgb_color)) { return rgbToCssColor(red, green, blue); } var alphaFrac = rgb_color.alpha.value || 0.0; var rgbParams = [red, green, blue].join(','); return ['rgba(', rgbParams, ',', alphaFrac, ')'].join(''); }; var rgbToCssColor = function(red, green, blue) { var rgbNumber = new Number((red << 16) | (green << 8) | blue); var hexString = rgbNumber.toString(16); var missingZeros = 6 - hexString.length; var resultBuilder = ['#']; for (var i = 0; i < missingZeros; i++) { resultBuilder.push('0'); } resultBuilder.push(hexString); return resultBuilder.join(''); }; // ... # The color used to represent the AQI numeric score.
+            "alpha": 3.14, # The fraction of this color that should be applied to the pixel. That is, the final pixel color is defined by the equation: `pixel color = alpha * (this color) + (1.0 - alpha) * (background color)` This means that a value of 1.0 corresponds to a solid color, whereas a value of 0.0 corresponds to a completely transparent color. This uses a wrapper message rather than a simple float scalar so that it is possible to distinguish between a default value and the value being unset. If omitted, this color object is rendered as a solid color (as if the alpha value had been explicitly given a value of 1.0).
+            "blue": 3.14, # The amount of blue in the color as a value in the interval [0, 1].
+            "green": 3.14, # The amount of green in the color as a value in the interval [0, 1].
+            "red": 3.14, # The amount of red in the color as a value in the interval [0, 1].
+          },
+          "displayName": "A String", # A human readable representation of the index name. Example: "AQI (US)"
+          "dominantPollutant": "A String", # The chemical symbol of the dominant pollutant. For example: "CO".
+        },
+      ],
+      "pollutants": [ # A list of pollutants affecting the location specified in the request. Note: This field will be returned only for requests that specified one or more of the following extra computations: POLLUTANT_ADDITIONAL_INFO, DOMINANT_POLLUTANT_CONCENTRATION, POLLUTANT_CONCENTRATION.
+        { # Data regarding an air quality pollutant.
+          "additionalInfo": { # The emission sources and health effects of a given pollutant. # Additional information about the pollutant.
+            "effects": "A String", # Text representing the pollutant's main health effects.
+            "sources": "A String", # Text representing the pollutant's main emission sources.
+          },
+          "code": "A String", # The pollutant's code name. For example: "so2". A list of all available codes could be found [here](/maps/documentation/air-quality/pollutants#reported_pollutants).
+          "concentration": { # The concentration of a given pollutant in the air. # The pollutant's concentration level measured by one of the standard air pollutation measure units.
+            "units": "A String", # Units for measuring this pollutant concentration.
+            "value": 3.14, # Value of pollutant concentration.
+          },
+          "displayName": "A String", # The pollutant's display name. For example: "NOx".
+          "fullName": "A String", # The pollutant's full name. For chemical compounds, this is the IUPAC name. Example: "Sulfur Dioxide". For more information about the IUPAC names table, see https://iupac.org/what-we-do/periodic-table-of-elements/
+        },
+      ],
+    },
+  ],
+  "nextPageToken": "A String", # Optional. The token to retrieve the next page.
+  "regionCode": "A String", # Optional. The ISO_3166-1 alpha-2 code of the country/region corresponding to the location provided in the request. This field might be omitted from the response if the location provided in the request resides in a disputed territory.
+}
+
+ +
+ lookup_next() +
Retrieves the next page of results.
+
+        Args:
+          previous_request: The request for the previous page. (required)
+          previous_response: The response from the request for the previous page. (required)
+
+        Returns:
+          A request object that you can call 'execute()' on to request the next
+          page. Returns None if there are no more items in the collection.
+        
+
+ + \ No newline at end of file diff --git a/docs/dyn/airquality_v1.history.html b/docs/dyn/airquality_v1.history.html new file mode 100644 index 00000000000..95e6b0a12e0 --- /dev/null +++ b/docs/dyn/airquality_v1.history.html @@ -0,0 +1,200 @@ + + + +

Air Quality API . history

+

Instance Methods

+

+ close()

+

Close httplib2 connections.

+

+ lookup(body=None, x__xgafv=None)

+

Returns air quality history for a specific location for a given time range.

+

+ lookup_next()

+

Retrieves the next page of results.

+

Method Details

+
+ close() +
Close httplib2 connections.
+
+ +
+ lookup(body=None, x__xgafv=None) +
Returns air quality history for a specific location for a given time range.
+
+Args:
+  body: object, The request body.
+    The object takes the form of:
+
+{ # The request object of the air quality history API.
+  "customLocalAqis": [ # Optional. Expresses a 'country/region to AQI' relationship. Pairs a country/region with a desired AQI so that air quality data that is required for that country/region will be displayed according to the chosen AQI. This parameter can be used to specify a non-default AQI for a given country, for example, to get the US EPA index for Canada rather than the default index for Canada.
+    { # Expresses a 'country/region to AQI' relationship. Pairs a country/region with a desired AQI so that air quality data that is required for that country/region will be displayed according to the chosen AQI.
+      "aqi": "A String", # The AQI to associate the country/region with. Value should be a [valid index](/maps/documentation/air-quality/laqis) code.
+      "regionCode": "A String", # The country/region requiring the custom AQI. Value should be provided using [ISO 3166-1 alpha-2](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2) code.
+    },
+  ],
+  "dateTime": "A String", # A timestamp for which to return historical data. The timestamp is rounded to the previous exact hour. Note: this will return hourly data for the requested timestamp only (i.e. a single hourly info element). For example, a request sent where the dateTime parameter is set to 2023-01-03T11:05:49Z will be rounded down to 2023-01-03T11:00:00Z. A timestamp in RFC3339 UTC "Zulu" format, with nanosecond resolution and up to nine fractional digits. Examples: "2014-10-02T15:01:23Z" and "2014-10-02T15:01:23.045123456Z".
+  "extraComputations": [ # Optional. Additional features that can be optionally enabled. Specifying extra computations will result in the relevant elements and fields to be returned in the response.
+    "A String",
+  ],
+  "hours": 42, # Number from 1 to 720 that indicates the hours range for the request. For example: A value of 48 will yield data from the last 48 hours.
+  "languageCode": "A String", # Optional. Allows the client to choose the language for the response. If data cannot be provided for that language the API uses the closest match. Allowed values rely on the IETF standard. Default value is en.
+  "location": { # 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. # Required. The latitude and longitude for which the API looks for air quality history data.
+    "latitude": 3.14, # The latitude in degrees. It must be in the range [-90.0, +90.0].
+    "longitude": 3.14, # The longitude in degrees. It must be in the range [-180.0, +180.0].
+  },
+  "pageSize": 42, # Optional. The maximum number of hourly info records to return per page. The default is 72 and the max value is 168 (7 days of data).
+  "pageToken": "A String", # Optional. A page token received from a previous history call. It is used to retrieve the subsequent page. Note that when providing a value for this parameter all other parameters provided must match the call that provided the page token (the previous call).
+  "period": { # Represents a time interval, encoded as a Timestamp start (inclusive) and a Timestamp end (exclusive). The start must be less than or equal to the end. When the start equals the end, the interval is empty (matches no time). When both start and end are unspecified, the interval matches any time. # Indicates the start and end period for which to get the historical data. The timestamp is rounded to the previous exact hour.
+    "endTime": "A String", # Optional. Exclusive end of the interval. If specified, a Timestamp matching this interval will have to be before the end.
+    "startTime": "A String", # Optional. Inclusive start of the interval. If specified, a Timestamp matching this interval will have to be the same or after the start.
+  },
+  "uaqiColorPalette": "A String", # Optional. Determines the color palette used for data provided by the 'Universal Air Quality Index' (UAQI). This color palette is relevant just for UAQI, other AQIs have a predetermined color palette that can't be controlled.
+  "universalAqi": True or False, # Optional. If set to true, the Universal AQI will be included in the 'indexes' field of the response. Default value is true.
+}
+
+  x__xgafv: string, V1 error format.
+    Allowed values
+      1 - v1 error format
+      2 - v2 error format
+
+Returns:
+  An object of the form:
+
+    {
+  "hoursInfo": [ # Optional. Contains the air quality information for each hour in the requested range. For example, if the request is for 48 hours of history there will be 48 elements of hourly info.
+    { # Contains the air quality information for each hour in the requested range. For example, if the request is for 48 hours of history there will be 48 elements of hourly info.
+      "dateTime": "A String", # A rounded down timestamp indicating the time the data refers to in RFC3339 UTC "Zulu" format, with nanosecond resolution and up to nine fractional digits. For example: "2014-10-02T15:00:00Z".
+      "healthRecommendations": { # Health recommendations for different population groups in a free text format. The recommendations are derived from their associated air quality conditions. # Health advice and recommended actions related to the reported air quality conditions. Recommendations are tailored differently for populations at risk, groups with greater sensitivities to pollutants, and the general population.
+        "athletes": "A String", # Sports and other strenuous outdoor activities.
+        "children": "A String", # Younger populations including children, toddlers, and babies.
+        "elderly": "A String", # Retirees and people older than the general population.
+        "generalPopulation": "A String", # No specific sensitivities.
+        "heartDiseasePopulation": "A String", # Heart and circulatory system diseases.
+        "lungDiseasePopulation": "A String", # Respiratory related problems and asthma suffers.
+        "pregnantWomen": "A String", # Women at all stages of pregnancy.
+      },
+      "indexes": [ # Based on the request parameters, this list will include (up to) two air quality indexes: - Universal AQI. Will be returned if the universalAqi boolean is set to true. - Local AQI. Will be returned if the LOCAL_AQI extra computation is specified.
+        { # The basic object for representing different air quality metrics. When brought together, these metrics provide a snapshot about the current air quality conditions. There are multiple indexes in the world serving different purposes and groups interested in measuring different aspects of air quality.
+          "aqi": 42, #  The index's numeric score. Examples: 10, 100. The value is not normalized and should only be interpreted in the context of its related air-quality index. For non-numeric indexes, this field will not be returned. Note: This field should be used for calculations, graph display, etc. For displaying the index score, you should use the AQI display field.
+          "aqiDisplay": "A String", # Textual representation of the index numeric score, that may include prefix or suffix symbols, which usually represents the worst index score. Example: >100 or 10+. Note: This field should be used when you want to display the index score. For non-numeric indexes, this field is empty.
+          "category": "A String", # Textual classification of the index numeric score interpretation. For example: "Excellent air quality".
+          "code": "A String", # The index's code. This field represents the index for programming purposes by using snake case instead of spaces. Examples: "uaqi", "fra_atmo".
+          "color": { # Represents a color in the RGBA color space. This representation is designed for simplicity of conversion to and from color representations in various languages over compactness. For example, the fields of this representation can be trivially provided to the constructor of `java.awt.Color` in Java; it can also be trivially provided to UIColor's `+colorWithRed:green:blue:alpha` method in iOS; and, with just a little work, it can be easily formatted into a CSS `rgba()` string in JavaScript. This reference page doesn't have information about the absolute color space that should be used to interpret the RGB value—for example, sRGB, Adobe RGB, DCI-P3, and BT.2020. By default, applications should assume the sRGB color space. When color equality needs to be decided, implementations, unless documented otherwise, treat two colors as equal if all their red, green, blue, and alpha values each differ by at most `1e-5`. Example (Java): import com.google.type.Color; // ... public static java.awt.Color fromProto(Color protocolor) { float alpha = protocolor.hasAlpha() ? protocolor.getAlpha().getValue() : 1.0; return new java.awt.Color( protocolor.getRed(), protocolor.getGreen(), protocolor.getBlue(), alpha); } public static Color toProto(java.awt.Color color) { float red = (float) color.getRed(); float green = (float) color.getGreen(); float blue = (float) color.getBlue(); float denominator = 255.0; Color.Builder resultBuilder = Color .newBuilder() .setRed(red / denominator) .setGreen(green / denominator) .setBlue(blue / denominator); int alpha = color.getAlpha(); if (alpha != 255) { result.setAlpha( FloatValue .newBuilder() .setValue(((float) alpha) / denominator) .build()); } return resultBuilder.build(); } // ... Example (iOS / Obj-C): // ... static UIColor* fromProto(Color* protocolor) { float red = [protocolor red]; float green = [protocolor green]; float blue = [protocolor blue]; FloatValue* alpha_wrapper = [protocolor alpha]; float alpha = 1.0; if (alpha_wrapper != nil) { alpha = [alpha_wrapper value]; } return [UIColor colorWithRed:red green:green blue:blue alpha:alpha]; } static Color* toProto(UIColor* color) { CGFloat red, green, blue, alpha; if (![color getRed:&red green:&green blue:&blue alpha:&alpha]) { return nil; } Color* result = [[Color alloc] init]; [result setRed:red]; [result setGreen:green]; [result setBlue:blue]; if (alpha <= 0.9999) { [result setAlpha:floatWrapperWithValue(alpha)]; } [result autorelease]; return result; } // ... Example (JavaScript): // ... var protoToCssColor = function(rgb_color) { var redFrac = rgb_color.red || 0.0; var greenFrac = rgb_color.green || 0.0; var blueFrac = rgb_color.blue || 0.0; var red = Math.floor(redFrac * 255); var green = Math.floor(greenFrac * 255); var blue = Math.floor(blueFrac * 255); if (!('alpha' in rgb_color)) { return rgbToCssColor(red, green, blue); } var alphaFrac = rgb_color.alpha.value || 0.0; var rgbParams = [red, green, blue].join(','); return ['rgba(', rgbParams, ',', alphaFrac, ')'].join(''); }; var rgbToCssColor = function(red, green, blue) { var rgbNumber = new Number((red << 16) | (green << 8) | blue); var hexString = rgbNumber.toString(16); var missingZeros = 6 - hexString.length; var resultBuilder = ['#']; for (var i = 0; i < missingZeros; i++) { resultBuilder.push('0'); } resultBuilder.push(hexString); return resultBuilder.join(''); }; // ... # The color used to represent the AQI numeric score.
+            "alpha": 3.14, # The fraction of this color that should be applied to the pixel. That is, the final pixel color is defined by the equation: `pixel color = alpha * (this color) + (1.0 - alpha) * (background color)` This means that a value of 1.0 corresponds to a solid color, whereas a value of 0.0 corresponds to a completely transparent color. This uses a wrapper message rather than a simple float scalar so that it is possible to distinguish between a default value and the value being unset. If omitted, this color object is rendered as a solid color (as if the alpha value had been explicitly given a value of 1.0).
+            "blue": 3.14, # The amount of blue in the color as a value in the interval [0, 1].
+            "green": 3.14, # The amount of green in the color as a value in the interval [0, 1].
+            "red": 3.14, # The amount of red in the color as a value in the interval [0, 1].
+          },
+          "displayName": "A String", # A human readable representation of the index name. Example: "AQI (US)"
+          "dominantPollutant": "A String", # The chemical symbol of the dominant pollutant. For example: "CO".
+        },
+      ],
+      "pollutants": [ # A list of pollutants affecting the location specified in the request. Note: This field will be returned only for requests that specified one or more of the following extra computations: POLLUTANT_ADDITIONAL_INFO, DOMINANT_POLLUTANT_CONCENTRATION, POLLUTANT_CONCENTRATION.
+        { # Data regarding an air quality pollutant.
+          "additionalInfo": { # The emission sources and health effects of a given pollutant. # Additional information about the pollutant.
+            "effects": "A String", # Text representing the pollutant's main health effects.
+            "sources": "A String", # Text representing the pollutant's main emission sources.
+          },
+          "code": "A String", # The pollutant's code name. For example: "so2". A list of all available codes could be found [here](/maps/documentation/air-quality/pollutants#reported_pollutants).
+          "concentration": { # The concentration of a given pollutant in the air. # The pollutant's concentration level measured by one of the standard air pollutation measure units.
+            "units": "A String", # Units for measuring this pollutant concentration.
+            "value": 3.14, # Value of pollutant concentration.
+          },
+          "displayName": "A String", # The pollutant's display name. For example: "NOx".
+          "fullName": "A String", # The pollutant's full name. For chemical compounds, this is the IUPAC name. Example: "Sulfur Dioxide". For more information about the IUPAC names table, see https://iupac.org/what-we-do/periodic-table-of-elements/
+        },
+      ],
+    },
+  ],
+  "nextPageToken": "A String", # Optional. The token to retrieve the next page.
+  "regionCode": "A String", # Optional. The ISO_3166-1 alpha-2 code of the country/region corresponding to the location provided in the request. This field might be omitted from the response if the location provided in the request resides in a disputed territory.
+}
+
+ +
+ lookup_next() +
Retrieves the next page of results.
+
+        Args:
+          previous_request: The request for the previous page. (required)
+          previous_response: The response from the request for the previous page. (required)
+
+        Returns:
+          A request object that you can call 'execute()' on to request the next
+          page. Returns None if there are no more items in the collection.
+        
+
+ + \ No newline at end of file diff --git a/docs/dyn/airquality_v1.html b/docs/dyn/airquality_v1.html new file mode 100644 index 00000000000..234864f8368 --- /dev/null +++ b/docs/dyn/airquality_v1.html @@ -0,0 +1,126 @@ + + + +

Air Quality API

+

Instance Methods

+

+ currentConditions() +

+

Returns the currentConditions Resource.

+ +

+ forecast() +

+

Returns the forecast Resource.

+ +

+ history() +

+

Returns the history Resource.

+ +

+ mapTypes() +

+

Returns the mapTypes Resource.

+ +

+ close()

+

Close httplib2 connections.

+

+ new_batch_http_request()

+

Create a BatchHttpRequest object based on the discovery document.

+

Method Details

+
+ close() +
Close httplib2 connections.
+
+ +
+ new_batch_http_request() +
Create a BatchHttpRequest object based on the discovery document.
+
+                Args:
+                  callback: callable, A callback to be called for each response, of the
+                    form callback(id, response, exception). The first parameter is the
+                    request id, and the second is the deserialized response object. The
+                    third is an apiclient.errors.HttpError exception object if an HTTP
+                    error occurred while processing the request, or None if no error
+                    occurred.
+
+                Returns:
+                  A BatchHttpRequest object based on the discovery document.
+                
+
+ + \ No newline at end of file diff --git a/docs/dyn/airquality_v1.mapTypes.heatmapTiles.html b/docs/dyn/airquality_v1.mapTypes.heatmapTiles.html new file mode 100644 index 00000000000..ecade1e2d1d --- /dev/null +++ b/docs/dyn/airquality_v1.mapTypes.heatmapTiles.html @@ -0,0 +1,127 @@ + + + +

Air Quality API . mapTypes . heatmapTiles

+

Instance Methods

+

+ close()

+

Close httplib2 connections.

+

+ lookupHeatmapTile(mapType, zoom, x, y, x__xgafv=None)

+

Returns a bytes array containing the data of the tile PNG image.

+

Method Details

+
+ close() +
Close httplib2 connections.
+
+ +
+ lookupHeatmapTile(mapType, zoom, x, y, x__xgafv=None) +
Returns a bytes array containing the data of the tile PNG image.
+
+Args:
+  mapType: string, Required. The type of the air quality heatmap. Defines the pollutant that the map will graphically represent. Allowed values: - UAQI_RED_GREEN (UAQI, red-green palette) - UAQI_INDIGO_PERSIAN (UAQI, indigo-persian palette) - PM25_INDIGO_PERSIAN - GBR_DEFRA - DEU_UBA - CAN_EC - FRA_ATMO - US_AQI (required)
+    Allowed values
+      MAP_TYPE_UNSPECIFIED - The default value. The server ignores it if it is passed as a parameter.
+      UAQI_RED_GREEN - Universal Air Quality Index red-green palette.
+      UAQI_INDIGO_PERSIAN - Universal Air Quality Index indigo-persian palette.
+      PM25_INDIGO_PERSIAN - PM2.5 index indigo-persian palette.
+      GBR_DEFRA - Daily Air Quality Index (UK) color palette.
+      DEU_UBA - German Local Air Quality Index color palette.
+      CAN_EC - Canadian Air Quality Health Index color palette.
+      FRA_ATMO - France Air Quality Index color palette.
+      US_AQI - US Air Quality Index color palette.
+  zoom: integer, Required. The map's zoom level. Defines how large or small the contents of a map appear in a map view. Zoom level 0 is the entire world in a single tile. Zoom level 1 is the entire world in 4 tiles. Zoom level 2 is the entire world in 16 tiles. Zoom level 16 is the entire world in 65,536 tiles. Allowed values: 0-16 (required)
+  x: integer, Required. Defines the east-west point in the requested tile. (required)
+  y: integer, Required. Defines the north-south point in the requested tile. (required)
+  x__xgafv: string, V1 error format.
+    Allowed values
+      1 - v1 error format
+      2 - v2 error format
+
+Returns:
+  An object of the form:
+
+    { # Message that represents an arbitrary HTTP body. It should only be used for payload formats that can't be represented as JSON, such as raw binary or an HTML page. This message can be used both in streaming and non-streaming API methods in the request as well as the response. It can be used as a top-level request field, which is convenient if one wants to extract parameters from either the URL or HTTP template into the request fields and also want access to the raw HTTP body. Example: message GetResourceRequest { // A unique request id. string request_id = 1; // The raw HTTP body is bound to this field. google.api.HttpBody http_body = 2; } service ResourceService { rpc GetResource(GetResourceRequest) returns (google.api.HttpBody); rpc UpdateResource(google.api.HttpBody) returns (google.protobuf.Empty); } Example with streaming methods: service CaldavService { rpc GetCalendar(stream google.api.HttpBody) returns (stream google.api.HttpBody); rpc UpdateCalendar(stream google.api.HttpBody) returns (stream google.api.HttpBody); } Use of this type only changes how the request and response bodies are handled, all other features will continue to work unchanged.
+  "contentType": "A String", # The HTTP Content-Type header value specifying the content type of the body.
+  "data": "A String", # The HTTP request/response body as raw binary.
+  "extensions": [ # Application specific response metadata. Must be set in the first response for streaming APIs.
+    {
+      "a_key": "", # Properties of the object. Contains field @type with type URL.
+    },
+  ],
+}
+
+ + \ No newline at end of file diff --git a/docs/dyn/airquality_v1.mapTypes.html b/docs/dyn/airquality_v1.mapTypes.html new file mode 100644 index 00000000000..a168d8842ac --- /dev/null +++ b/docs/dyn/airquality_v1.mapTypes.html @@ -0,0 +1,91 @@ + + + +

Air Quality API . mapTypes

+

Instance Methods

+

+ heatmapTiles() +

+

Returns the heatmapTiles Resource.

+ +

+ close()

+

Close httplib2 connections.

+

Method Details

+
+ close() +
Close httplib2 connections.
+
+ + \ No newline at end of file diff --git a/docs/dyn/androidmanagement_v1.enterprises.enrollmentTokens.html b/docs/dyn/androidmanagement_v1.enterprises.enrollmentTokens.html index 6e2e2e9e7fc..11d52e788a4 100644 --- a/docs/dyn/androidmanagement_v1.enterprises.enrollmentTokens.html +++ b/docs/dyn/androidmanagement_v1.enterprises.enrollmentTokens.html @@ -85,10 +85,10 @@

Instance Methods

Deletes an enrollment token. This operation invalidates the token, preventing its future use.

get(name, x__xgafv=None)

-

Gets an active, unexpired enrollment token. Only a partial view of EnrollmentToken is returned: all the fields but name and expiration_timestamp are empty. This method is meant to help manage active enrollment tokens lifecycle. For security reasons, it's recommended to delete active enrollment tokens as soon as they're not intended to be used anymore.

+

Gets an active, unexpired enrollment token. A partial view of the enrollment token is returned. Only the following fields are populated: name, expirationTimestamp, allowPersonalUsage, value, qrCode. This method is meant to help manage active enrollment tokens lifecycle. For security reasons, it's recommended to delete active enrollment tokens as soon as they're not intended to be used anymore.

list(parent, pageSize=None, pageToken=None, x__xgafv=None)

-

Lists active, unexpired enrollment tokens for a given enterprise. The list items contain only a partial view of EnrollmentToken: all the fields but name and expiration_timestamp are empty. This method is meant to help manage active enrollment tokens lifecycle. For security reasons, it's recommended to delete active enrollment tokens as soon as they're not intended to be used anymore.

+

Lists active, unexpired enrollment tokens for a given enterprise. The list items contain only a partial view of EnrollmentToken object. Only the following fields are populated: name, expirationTimestamp, allowPersonalUsage, value, qrCode. This method is meant to help manage active enrollment tokens lifecycle. For security reasons, it's recommended to delete active enrollment tokens as soon as they're not intended to be used anymore.

list_next()

Retrieves the next page of results.

@@ -166,7 +166,7 @@

Method Details

get(name, x__xgafv=None) -
Gets an active, unexpired enrollment token. Only a partial view of EnrollmentToken is returned: all the fields but name and expiration_timestamp are empty. This method is meant to help manage active enrollment tokens lifecycle. For security reasons, it's recommended to delete active enrollment tokens as soon as they're not intended to be used anymore.
+  
Gets an active, unexpired enrollment token. A partial view of the enrollment token is returned. Only the following fields are populated: name, expirationTimestamp, allowPersonalUsage, value, qrCode. This method is meant to help manage active enrollment tokens lifecycle. For security reasons, it's recommended to delete active enrollment tokens as soon as they're not intended to be used anymore.
 
 Args:
   name: string, Required. The name of the enrollment token in the form enterprises/{enterpriseId}/enrollmentTokens/{enrollmentTokenId}. (required)
@@ -196,7 +196,7 @@ 

Method Details

list(parent, pageSize=None, pageToken=None, x__xgafv=None) -
Lists active, unexpired enrollment tokens for a given enterprise. The list items contain only a partial view of EnrollmentToken: all the fields but name and expiration_timestamp are empty. This method is meant to help manage active enrollment tokens lifecycle. For security reasons, it's recommended to delete active enrollment tokens as soon as they're not intended to be used anymore.
+  
Lists active, unexpired enrollment tokens for a given enterprise. The list items contain only a partial view of EnrollmentToken object. Only the following fields are populated: name, expirationTimestamp, allowPersonalUsage, value, qrCode. This method is meant to help manage active enrollment tokens lifecycle. For security reasons, it's recommended to delete active enrollment tokens as soon as they're not intended to be used anymore.
 
 Args:
   parent: string, Required. The name of the enterprise in the form enterprises/{enterpriseId}. (required)
diff --git a/docs/dyn/androidmanagement_v1.provisioningInfo.html b/docs/dyn/androidmanagement_v1.provisioningInfo.html
index d60459bf6ca..c0c76f1a782 100644
--- a/docs/dyn/androidmanagement_v1.provisioningInfo.html
+++ b/docs/dyn/androidmanagement_v1.provisioningInfo.html
@@ -102,6 +102,7 @@ 

Method Details

{ # Information about a device that is available during setup. "apiLevel": 42, # The API level of the Android platform version running on the device. + "authenticatedUserEmail": "A String", # The email address of the authenticated user (only present for Google Account provisioning method). "brand": "A String", # The brand of the device. For example, Google. "enterprise": "A String", # The name of the enterprise in the form enterprises/{enterprise}. "imei": "A String", # For corporate-owned devices, IMEI number of the GSM device. For example, A1000031212. diff --git a/docs/dyn/androidpublisher_v3.purchases.voidedpurchases.html b/docs/dyn/androidpublisher_v3.purchases.voidedpurchases.html index 37bca9d5845..d6a3d2f27df 100644 --- a/docs/dyn/androidpublisher_v3.purchases.voidedpurchases.html +++ b/docs/dyn/androidpublisher_v3.purchases.voidedpurchases.html @@ -124,7 +124,7 @@

Method Details

"purchaseTimeMillis": "A String", # The time at which the purchase was made, in milliseconds since the epoch (Jan 1, 1970). "purchaseToken": "A String", # The token which uniquely identifies a one-time purchase or subscription. To uniquely identify subscription renewals use order_id (available starting from version 3 of the API). "voidedQuantity": 42, # The voided quantity as the result of a quantity-based partial refund. Voided purchases of quantity-based partial refunds may only be returned when includeQuantityBasedPartialRefund is set to true. - "voidedReason": 42, # The reason why the purchase was voided, possible values are: 0. Other 1. Remorse 2. Not_received 3. Defective 4. Accidental_purchase 5. Fraud 6. Friendly_fraud 7. Chargeback + "voidedReason": 42, # The reason why the purchase was voided, possible values are: 0. Other 1. Remorse 2. Not_received 3. Defective 4. Accidental_purchase 5. Fraud 6. Friendly_fraud 7. Chargeback 8. Unacknowledged_purchase "voidedSource": 42, # The initiator of voided purchase, possible values are: 0. User 1. Developer 2. Google "voidedTimeMillis": "A String", # The time at which the purchase was canceled/refunded/charged-back, in milliseconds since the epoch (Jan 1, 1970). }, diff --git a/docs/dyn/artifactregistry_v1.projects.locations.repositories.packages.tags.html b/docs/dyn/artifactregistry_v1.projects.locations.repositories.packages.tags.html index 1521c991c93..3cc9134b797 100644 --- a/docs/dyn/artifactregistry_v1.projects.locations.repositories.packages.tags.html +++ b/docs/dyn/artifactregistry_v1.projects.locations.repositories.packages.tags.html @@ -174,7 +174,7 @@

Method Details

Args: parent: string, The name of the parent package whose tags will be listed. For example: `projects/p1/locations/us-central1/repositories/repo1/packages/pkg1`. (required) - filter: string, An expression for filtering the results of the request. Filter rules are case insensitive. The fields eligible for filtering are: * `version` An example of using a filter: * `version="projects/p1/locations/us-central1/repositories/repo1/packages/pkg1/versions/1.0"` --> Tags that are applied to the version `1.0` in package `pkg1`. + filter: string, An expression for filtering the results of the request. Filter rules are case insensitive. The fields eligible for filtering are: * `version` An example of using a filter: * `version="projects/p1/locations/us-central1/repositories/repo1/packages/pkg1/versions/1.0"` --> Tags that are applied to the version `1.0` in package `pkg1`. * `name="projects/p1/locations/us-central1/repositories/repo1/packages/pkg1/tags/a%2Fb%2F*"` --> tags with an ID starting with "a/b/". * `name="projects/p1/locations/us-central1/repositories/repo1/packages/pkg1/tags/*%2Fb%2Fc"` --> tags with an ID ending with "/b/c". * `name="projects/p1/locations/us-central1/repositories/repo1/packages/pkg1/tags/*%2Fb%2F*"` --> tags with an ID containing "/b/". pageSize: integer, The maximum number of tags to return. Maximum page size is 1,000. pageToken: string, The next_page_token value returned from a previous list request, if any. x__xgafv: string, V1 error format. diff --git a/docs/dyn/artifactregistry_v1beta1.projects.locations.repositories.packages.tags.html b/docs/dyn/artifactregistry_v1beta1.projects.locations.repositories.packages.tags.html index 1196c545954..4b0a215dc27 100644 --- a/docs/dyn/artifactregistry_v1beta1.projects.locations.repositories.packages.tags.html +++ b/docs/dyn/artifactregistry_v1beta1.projects.locations.repositories.packages.tags.html @@ -174,7 +174,7 @@

Method Details

Args: parent: string, The name of the parent package whose tags will be listed. For example: `projects/p1/locations/us-central1/repositories/repo1/packages/pkg1`. (required) - filter: string, An expression for filtering the results of the request. Filter rules are case insensitive. The fields eligible for filtering are: * `version` An example of using a filter: * `version="projects/p1/locations/us-central1/repositories/repo1/packages/pkg1/versions/1.0"` --> Tags that are applied to the version `1.0` in package `pkg1`. + filter: string, An expression for filtering the results of the request. Filter rules are case insensitive. The fields eligible for filtering are: * `version` An example of using a filter: * `version="projects/p1/locations/us-central1/repositories/repo1/packages/pkg1/versions/1.0"` --> Tags that are applied to the version `1.0` in package `pkg1`. * `name="projects/p1/locations/us-central1/repositories/repo1/packages/pkg1/tags/a%2Fb%2F*"` --> tags with an ID starting with "a/b/". * `name="projects/p1/locations/us-central1/repositories/repo1/packages/pkg1/tags/*%2Fb%2Fc"` --> tags with an ID ending with "/b/c". * `name="projects/p1/locations/us-central1/repositories/repo1/packages/pkg1/tags/*%2Fb%2F*"` --> tags with an ID containing "/b/". pageSize: integer, The maximum number of tags to return. Maximum page size is 1,000. pageToken: string, The next_page_token value returned from a previous list request, if any. x__xgafv: string, V1 error format. diff --git a/docs/dyn/artifactregistry_v1beta2.projects.locations.repositories.packages.tags.html b/docs/dyn/artifactregistry_v1beta2.projects.locations.repositories.packages.tags.html index eb11fde56e6..3863f6760ef 100644 --- a/docs/dyn/artifactregistry_v1beta2.projects.locations.repositories.packages.tags.html +++ b/docs/dyn/artifactregistry_v1beta2.projects.locations.repositories.packages.tags.html @@ -174,7 +174,7 @@

Method Details

Args: parent: string, The name of the parent package whose tags will be listed. For example: `projects/p1/locations/us-central1/repositories/repo1/packages/pkg1`. (required) - filter: string, An expression for filtering the results of the request. Filter rules are case insensitive. The fields eligible for filtering are: * `version` An example of using a filter: * `version="projects/p1/locations/us-central1/repositories/repo1/packages/pkg1/versions/1.0"` --> Tags that are applied to the version `1.0` in package `pkg1`. + filter: string, An expression for filtering the results of the request. Filter rules are case insensitive. The fields eligible for filtering are: * `version` An example of using a filter: * `version="projects/p1/locations/us-central1/repositories/repo1/packages/pkg1/versions/1.0"` --> Tags that are applied to the version `1.0` in package `pkg1`. * `name="projects/p1/locations/us-central1/repositories/repo1/packages/pkg1/tags/a%2Fb%2F*"` --> tags with an ID starting with "a/b/". * `name="projects/p1/locations/us-central1/repositories/repo1/packages/pkg1/tags/*%2Fb%2Fc"` --> tags with an ID ending with "/b/c". * `name="projects/p1/locations/us-central1/repositories/repo1/packages/pkg1/tags/*%2Fb%2F*"` --> tags with an ID containing "/b/". pageSize: integer, The maximum number of tags to return. Maximum page size is 1,000. pageToken: string, The next_page_token value returned from a previous list request, if any. x__xgafv: string, V1 error format. diff --git a/docs/dyn/authorizedbuyersmarketplace_v1.buyers.finalizedDeals.html b/docs/dyn/authorizedbuyersmarketplace_v1.buyers.finalizedDeals.html index db0e7cf36ae..b26a5dda76e 100644 --- a/docs/dyn/authorizedbuyersmarketplace_v1.buyers.finalizedDeals.html +++ b/docs/dyn/authorizedbuyersmarketplace_v1.buyers.finalizedDeals.html @@ -91,10 +91,10 @@

Instance Methods

Retrieves the next page of results.

pause(name, body=None, x__xgafv=None)

-

Pauses serving of the given finalized deal. This call only pauses the serving status, and does not affect other fields of the finalized deal. Calling this method for an already paused deal has no effect. This method only applies to programmatic guaranteed deals.

+

Pauses serving of the given finalized deal. This call only pauses the serving status, and does not affect other fields of the finalized deal. Calling this method for an already paused deal has no effect. This method only applies to programmatic guaranteed deals and preferred deals.

resume(name, body=None, x__xgafv=None)

-

Resumes serving of the given finalized deal. Calling this method for an running deal has no effect. If a deal is initially paused by the seller, calling this method will not resume serving of the deal until the seller also resumes the deal. This method only applies to programmatic guaranteed deals.

+

Resumes serving of the given finalized deal. Calling this method for an running deal has no effect. If a deal is initially paused by the seller, calling this method will not resume serving of the deal until the seller also resumes the deal. This method only applies to programmatic guaranteed deals and preferred deals.

setReadyToServe(deal, body=None, x__xgafv=None)

Sets the given finalized deal as ready to serve. By default, deals are set as ready to serve as soon as they're finalized. If you want to opt out of the default behavior, and manually indicate that deals are ready to serve, ask your Technical Account Manager to add you to the allowlist. If you choose to use this method, finalized deals belonging to the bidder and its child seats don't start serving until after you call `setReadyToServe`, and after the deals become active. For example, you can use this method to delay receiving bid requests until your creative is ready. This method only applies to programmatic guaranteed deals.

@@ -901,7 +901,7 @@

Method Details

pause(name, body=None, x__xgafv=None) -
Pauses serving of the given finalized deal. This call only pauses the serving status, and does not affect other fields of the finalized deal. Calling this method for an already paused deal has no effect. This method only applies to programmatic guaranteed deals.
+  
Pauses serving of the given finalized deal. This call only pauses the serving status, and does not affect other fields of the finalized deal. Calling this method for an already paused deal has no effect. This method only applies to programmatic guaranteed deals and preferred deals.
 
 Args:
   name: string, Required. Format: `buyers/{accountId}/finalizedDeals/{dealId}` (required)
@@ -1163,7 +1163,7 @@ 

Method Details

resume(name, body=None, x__xgafv=None) -
Resumes serving of the given finalized deal. Calling this method for an running deal has no effect. If a deal is initially paused by the seller, calling this method will not resume serving of the deal until the seller also resumes the deal. This method only applies to programmatic guaranteed deals.
+  
Resumes serving of the given finalized deal. Calling this method for an running deal has no effect. If a deal is initially paused by the seller, calling this method will not resume serving of the deal until the seller also resumes the deal. This method only applies to programmatic guaranteed deals and preferred deals.
 
 Args:
   name: string, Required. Format: `buyers/{accountId}/finalizedDeals/{dealId}` (required)
diff --git a/docs/dyn/bigquery_v2.datasets.html b/docs/dyn/bigquery_v2.datasets.html
index b16d8c0979a..46f0c37d85c 100644
--- a/docs/dyn/bigquery_v2.datasets.html
+++ b/docs/dyn/bigquery_v2.datasets.html
@@ -179,7 +179,7 @@ 

Method Details

"projectId": "A String", # Optional. The ID of the project containing this dataset. }, "defaultCollation": "A String", # Optional. Defines the default collation specification of future tables created in the dataset. If a table is created in this dataset without table-level default collation, then the table inherits the dataset default collation, which is applied to the string fields that do not have explicit collation specified. A change to this field affects only tables created afterwards, and does not alter the existing tables. The following values are supported: * 'und:ci': undetermined locale, case insensitive. * '': empty string. Default to case-sensitive behavior. - "defaultEncryptionConfiguration": { # The default encryption key for all tables in the dataset. Once this property is set, all newly-created partitioned tables in the dataset will have encryption key set to this value, unless table creation request (or query) overrides the key. + "defaultEncryptionConfiguration": { # The default encryption key for all tables in the dataset. After this property is set, the encryption key of all newly-created tables in the dataset is set to this value unless the table creation request or query explicitly overrides the key. "kmsKeyName": "A String", # Optional. Describes the Cloud KMS encryption key that will be used to protect destination BigQuery table. The BigQuery Service Account associated with your project requires access to this encryption key. }, "defaultPartitionExpirationMs": "A String", # This default partition expiration, expressed in milliseconds. When new time-partitioned tables are created in a dataset where this property is set, the table will inherit this value, propagated as the `TimePartitioning.expirationMs` property on the new table. If you set `TimePartitioning.expirationMs` explicitly when creating a table, the `defaultPartitionExpirationMs` of the containing dataset is ignored. When creating a partitioned table, if `defaultPartitionExpirationMs` is set, the `defaultTableExpirationMs` value is ignored and the table will not be inherit a table expiration deadline. @@ -216,6 +216,9 @@

Method Details

}, "location": "A String", # The geographic location where the dataset should reside. See https://cloud.google.com/bigquery/docs/locations for supported locations. "maxTimeTravelHours": "A String", # Optional. Defines the time travel window in hours. The value can be from 48 to 168 hours (2 to 7 days). The default value is 168 hours if this is not set. + "resourceTags": { # Optional. The [tags](/bigquery/docs/tags) attached to this dataset. Tag keys are globally unique. Tag key is expected to be in the namespaced format, for example "123456789012/environment" where 123456789012 is the ID of the parent organization or project resource for this tag key. Tag value is expected to be the short name, for example "Production". See [Tag definitions](/iam/docs/tags-access-control#definitions) for more details. + "a_key": "A String", + }, "restrictions": { # Optional. Output only. Restriction config for all tables and dataset. If set, restrict certain accesses on the dataset and all its tables based on the config. See [Data egress](/bigquery/docs/analytics-hub-introduction#data_egress) for more details. "type": "A String", # Output only. Specifies the type of dataset/table restriction. }, @@ -278,7 +281,7 @@

Method Details

"projectId": "A String", # Optional. The ID of the project containing this dataset. }, "defaultCollation": "A String", # Optional. Defines the default collation specification of future tables created in the dataset. If a table is created in this dataset without table-level default collation, then the table inherits the dataset default collation, which is applied to the string fields that do not have explicit collation specified. A change to this field affects only tables created afterwards, and does not alter the existing tables. The following values are supported: * 'und:ci': undetermined locale, case insensitive. * '': empty string. Default to case-sensitive behavior. - "defaultEncryptionConfiguration": { # The default encryption key for all tables in the dataset. Once this property is set, all newly-created partitioned tables in the dataset will have encryption key set to this value, unless table creation request (or query) overrides the key. + "defaultEncryptionConfiguration": { # The default encryption key for all tables in the dataset. After this property is set, the encryption key of all newly-created tables in the dataset is set to this value unless the table creation request or query explicitly overrides the key. "kmsKeyName": "A String", # Optional. Describes the Cloud KMS encryption key that will be used to protect destination BigQuery table. The BigQuery Service Account associated with your project requires access to this encryption key. }, "defaultPartitionExpirationMs": "A String", # This default partition expiration, expressed in milliseconds. When new time-partitioned tables are created in a dataset where this property is set, the table will inherit this value, propagated as the `TimePartitioning.expirationMs` property on the new table. If you set `TimePartitioning.expirationMs` explicitly when creating a table, the `defaultPartitionExpirationMs` of the containing dataset is ignored. When creating a partitioned table, if `defaultPartitionExpirationMs` is set, the `defaultTableExpirationMs` value is ignored and the table will not be inherit a table expiration deadline. @@ -315,6 +318,9 @@

Method Details

}, "location": "A String", # The geographic location where the dataset should reside. See https://cloud.google.com/bigquery/docs/locations for supported locations. "maxTimeTravelHours": "A String", # Optional. Defines the time travel window in hours. The value can be from 48 to 168 hours (2 to 7 days). The default value is 168 hours if this is not set. + "resourceTags": { # Optional. The [tags](/bigquery/docs/tags) attached to this dataset. Tag keys are globally unique. Tag key is expected to be in the namespaced format, for example "123456789012/environment" where 123456789012 is the ID of the parent organization or project resource for this tag key. Tag value is expected to be the short name, for example "Production". See [Tag definitions](/iam/docs/tags-access-control#definitions) for more details. + "a_key": "A String", + }, "restrictions": { # Optional. Output only. Restriction config for all tables and dataset. If set, restrict certain accesses on the dataset and all its tables based on the config. See [Data egress](/bigquery/docs/analytics-hub-introduction#data_egress) for more details. "type": "A String", # Output only. Specifies the type of dataset/table restriction. }, @@ -375,7 +381,7 @@

Method Details

"projectId": "A String", # Optional. The ID of the project containing this dataset. }, "defaultCollation": "A String", # Optional. Defines the default collation specification of future tables created in the dataset. If a table is created in this dataset without table-level default collation, then the table inherits the dataset default collation, which is applied to the string fields that do not have explicit collation specified. A change to this field affects only tables created afterwards, and does not alter the existing tables. The following values are supported: * 'und:ci': undetermined locale, case insensitive. * '': empty string. Default to case-sensitive behavior. - "defaultEncryptionConfiguration": { # The default encryption key for all tables in the dataset. Once this property is set, all newly-created partitioned tables in the dataset will have encryption key set to this value, unless table creation request (or query) overrides the key. + "defaultEncryptionConfiguration": { # The default encryption key for all tables in the dataset. After this property is set, the encryption key of all newly-created tables in the dataset is set to this value unless the table creation request or query explicitly overrides the key. "kmsKeyName": "A String", # Optional. Describes the Cloud KMS encryption key that will be used to protect destination BigQuery table. The BigQuery Service Account associated with your project requires access to this encryption key. }, "defaultPartitionExpirationMs": "A String", # This default partition expiration, expressed in milliseconds. When new time-partitioned tables are created in a dataset where this property is set, the table will inherit this value, propagated as the `TimePartitioning.expirationMs` property on the new table. If you set `TimePartitioning.expirationMs` explicitly when creating a table, the `defaultPartitionExpirationMs` of the containing dataset is ignored. When creating a partitioned table, if `defaultPartitionExpirationMs` is set, the `defaultTableExpirationMs` value is ignored and the table will not be inherit a table expiration deadline. @@ -412,6 +418,9 @@

Method Details

}, "location": "A String", # The geographic location where the dataset should reside. See https://cloud.google.com/bigquery/docs/locations for supported locations. "maxTimeTravelHours": "A String", # Optional. Defines the time travel window in hours. The value can be from 48 to 168 hours (2 to 7 days). The default value is 168 hours if this is not set. + "resourceTags": { # Optional. The [tags](/bigquery/docs/tags) attached to this dataset. Tag keys are globally unique. Tag key is expected to be in the namespaced format, for example "123456789012/environment" where 123456789012 is the ID of the parent organization or project resource for this tag key. Tag value is expected to be the short name, for example "Production". See [Tag definitions](/iam/docs/tags-access-control#definitions) for more details. + "a_key": "A String", + }, "restrictions": { # Optional. Output only. Restriction config for all tables and dataset. If set, restrict certain accesses on the dataset and all its tables based on the config. See [Data egress](/bigquery/docs/analytics-hub-introduction#data_egress) for more details. "type": "A String", # Output only. Specifies the type of dataset/table restriction. }, @@ -532,7 +541,7 @@

Method Details

"projectId": "A String", # Optional. The ID of the project containing this dataset. }, "defaultCollation": "A String", # Optional. Defines the default collation specification of future tables created in the dataset. If a table is created in this dataset without table-level default collation, then the table inherits the dataset default collation, which is applied to the string fields that do not have explicit collation specified. A change to this field affects only tables created afterwards, and does not alter the existing tables. The following values are supported: * 'und:ci': undetermined locale, case insensitive. * '': empty string. Default to case-sensitive behavior. - "defaultEncryptionConfiguration": { # The default encryption key for all tables in the dataset. Once this property is set, all newly-created partitioned tables in the dataset will have encryption key set to this value, unless table creation request (or query) overrides the key. + "defaultEncryptionConfiguration": { # The default encryption key for all tables in the dataset. After this property is set, the encryption key of all newly-created tables in the dataset is set to this value unless the table creation request or query explicitly overrides the key. "kmsKeyName": "A String", # Optional. Describes the Cloud KMS encryption key that will be used to protect destination BigQuery table. The BigQuery Service Account associated with your project requires access to this encryption key. }, "defaultPartitionExpirationMs": "A String", # This default partition expiration, expressed in milliseconds. When new time-partitioned tables are created in a dataset where this property is set, the table will inherit this value, propagated as the `TimePartitioning.expirationMs` property on the new table. If you set `TimePartitioning.expirationMs` explicitly when creating a table, the `defaultPartitionExpirationMs` of the containing dataset is ignored. When creating a partitioned table, if `defaultPartitionExpirationMs` is set, the `defaultTableExpirationMs` value is ignored and the table will not be inherit a table expiration deadline. @@ -569,6 +578,9 @@

Method Details

}, "location": "A String", # The geographic location where the dataset should reside. See https://cloud.google.com/bigquery/docs/locations for supported locations. "maxTimeTravelHours": "A String", # Optional. Defines the time travel window in hours. The value can be from 48 to 168 hours (2 to 7 days). The default value is 168 hours if this is not set. + "resourceTags": { # Optional. The [tags](/bigquery/docs/tags) attached to this dataset. Tag keys are globally unique. Tag key is expected to be in the namespaced format, for example "123456789012/environment" where 123456789012 is the ID of the parent organization or project resource for this tag key. Tag value is expected to be the short name, for example "Production". See [Tag definitions](/iam/docs/tags-access-control#definitions) for more details. + "a_key": "A String", + }, "restrictions": { # Optional. Output only. Restriction config for all tables and dataset. If set, restrict certain accesses on the dataset and all its tables based on the config. See [Data egress](/bigquery/docs/analytics-hub-introduction#data_egress) for more details. "type": "A String", # Output only. Specifies the type of dataset/table restriction. }, @@ -629,7 +641,7 @@

Method Details

"projectId": "A String", # Optional. The ID of the project containing this dataset. }, "defaultCollation": "A String", # Optional. Defines the default collation specification of future tables created in the dataset. If a table is created in this dataset without table-level default collation, then the table inherits the dataset default collation, which is applied to the string fields that do not have explicit collation specified. A change to this field affects only tables created afterwards, and does not alter the existing tables. The following values are supported: * 'und:ci': undetermined locale, case insensitive. * '': empty string. Default to case-sensitive behavior. - "defaultEncryptionConfiguration": { # The default encryption key for all tables in the dataset. Once this property is set, all newly-created partitioned tables in the dataset will have encryption key set to this value, unless table creation request (or query) overrides the key. + "defaultEncryptionConfiguration": { # The default encryption key for all tables in the dataset. After this property is set, the encryption key of all newly-created tables in the dataset is set to this value unless the table creation request or query explicitly overrides the key. "kmsKeyName": "A String", # Optional. Describes the Cloud KMS encryption key that will be used to protect destination BigQuery table. The BigQuery Service Account associated with your project requires access to this encryption key. }, "defaultPartitionExpirationMs": "A String", # This default partition expiration, expressed in milliseconds. When new time-partitioned tables are created in a dataset where this property is set, the table will inherit this value, propagated as the `TimePartitioning.expirationMs` property on the new table. If you set `TimePartitioning.expirationMs` explicitly when creating a table, the `defaultPartitionExpirationMs` of the containing dataset is ignored. When creating a partitioned table, if `defaultPartitionExpirationMs` is set, the `defaultTableExpirationMs` value is ignored and the table will not be inherit a table expiration deadline. @@ -666,6 +678,9 @@

Method Details

}, "location": "A String", # The geographic location where the dataset should reside. See https://cloud.google.com/bigquery/docs/locations for supported locations. "maxTimeTravelHours": "A String", # Optional. Defines the time travel window in hours. The value can be from 48 to 168 hours (2 to 7 days). The default value is 168 hours if this is not set. + "resourceTags": { # Optional. The [tags](/bigquery/docs/tags) attached to this dataset. Tag keys are globally unique. Tag key is expected to be in the namespaced format, for example "123456789012/environment" where 123456789012 is the ID of the parent organization or project resource for this tag key. Tag value is expected to be the short name, for example "Production". See [Tag definitions](/iam/docs/tags-access-control#definitions) for more details. + "a_key": "A String", + }, "restrictions": { # Optional. Output only. Restriction config for all tables and dataset. If set, restrict certain accesses on the dataset and all its tables based on the config. See [Data egress](/bigquery/docs/analytics-hub-introduction#data_egress) for more details. "type": "A String", # Output only. Specifies the type of dataset/table restriction. }, @@ -694,7 +709,7 @@

Method Details

The object takes the form of: { # Request format for undeleting a dataset. - "deletionTime": "A String", # Optional. The exact time when the dataset was deleted. If not specified, the most recently deleted version is undeleted. + "deletionTime": "A String", # Optional. The exact time when the dataset was deleted. If not specified, the most recently deleted version is undeleted. Undeleting a dataset using deletion time is not supported. } x__xgafv: string, V1 error format. @@ -741,7 +756,7 @@

Method Details

"projectId": "A String", # Optional. The ID of the project containing this dataset. }, "defaultCollation": "A String", # Optional. Defines the default collation specification of future tables created in the dataset. If a table is created in this dataset without table-level default collation, then the table inherits the dataset default collation, which is applied to the string fields that do not have explicit collation specified. A change to this field affects only tables created afterwards, and does not alter the existing tables. The following values are supported: * 'und:ci': undetermined locale, case insensitive. * '': empty string. Default to case-sensitive behavior. - "defaultEncryptionConfiguration": { # The default encryption key for all tables in the dataset. Once this property is set, all newly-created partitioned tables in the dataset will have encryption key set to this value, unless table creation request (or query) overrides the key. + "defaultEncryptionConfiguration": { # The default encryption key for all tables in the dataset. After this property is set, the encryption key of all newly-created tables in the dataset is set to this value unless the table creation request or query explicitly overrides the key. "kmsKeyName": "A String", # Optional. Describes the Cloud KMS encryption key that will be used to protect destination BigQuery table. The BigQuery Service Account associated with your project requires access to this encryption key. }, "defaultPartitionExpirationMs": "A String", # This default partition expiration, expressed in milliseconds. When new time-partitioned tables are created in a dataset where this property is set, the table will inherit this value, propagated as the `TimePartitioning.expirationMs` property on the new table. If you set `TimePartitioning.expirationMs` explicitly when creating a table, the `defaultPartitionExpirationMs` of the containing dataset is ignored. When creating a partitioned table, if `defaultPartitionExpirationMs` is set, the `defaultTableExpirationMs` value is ignored and the table will not be inherit a table expiration deadline. @@ -778,6 +793,9 @@

Method Details

}, "location": "A String", # The geographic location where the dataset should reside. See https://cloud.google.com/bigquery/docs/locations for supported locations. "maxTimeTravelHours": "A String", # Optional. Defines the time travel window in hours. The value can be from 48 to 168 hours (2 to 7 days). The default value is 168 hours if this is not set. + "resourceTags": { # Optional. The [tags](/bigquery/docs/tags) attached to this dataset. Tag keys are globally unique. Tag key is expected to be in the namespaced format, for example "123456789012/environment" where 123456789012 is the ID of the parent organization or project resource for this tag key. Tag value is expected to be the short name, for example "Production". See [Tag definitions](/iam/docs/tags-access-control#definitions) for more details. + "a_key": "A String", + }, "restrictions": { # Optional. Output only. Restriction config for all tables and dataset. If set, restrict certain accesses on the dataset and all its tables based on the config. See [Data egress](/bigquery/docs/analytics-hub-introduction#data_egress) for more details. "type": "A String", # Output only. Specifies the type of dataset/table restriction. }, @@ -841,7 +859,7 @@

Method Details

"projectId": "A String", # Optional. The ID of the project containing this dataset. }, "defaultCollation": "A String", # Optional. Defines the default collation specification of future tables created in the dataset. If a table is created in this dataset without table-level default collation, then the table inherits the dataset default collation, which is applied to the string fields that do not have explicit collation specified. A change to this field affects only tables created afterwards, and does not alter the existing tables. The following values are supported: * 'und:ci': undetermined locale, case insensitive. * '': empty string. Default to case-sensitive behavior. - "defaultEncryptionConfiguration": { # The default encryption key for all tables in the dataset. Once this property is set, all newly-created partitioned tables in the dataset will have encryption key set to this value, unless table creation request (or query) overrides the key. + "defaultEncryptionConfiguration": { # The default encryption key for all tables in the dataset. After this property is set, the encryption key of all newly-created tables in the dataset is set to this value unless the table creation request or query explicitly overrides the key. "kmsKeyName": "A String", # Optional. Describes the Cloud KMS encryption key that will be used to protect destination BigQuery table. The BigQuery Service Account associated with your project requires access to this encryption key. }, "defaultPartitionExpirationMs": "A String", # This default partition expiration, expressed in milliseconds. When new time-partitioned tables are created in a dataset where this property is set, the table will inherit this value, propagated as the `TimePartitioning.expirationMs` property on the new table. If you set `TimePartitioning.expirationMs` explicitly when creating a table, the `defaultPartitionExpirationMs` of the containing dataset is ignored. When creating a partitioned table, if `defaultPartitionExpirationMs` is set, the `defaultTableExpirationMs` value is ignored and the table will not be inherit a table expiration deadline. @@ -878,6 +896,9 @@

Method Details

}, "location": "A String", # The geographic location where the dataset should reside. See https://cloud.google.com/bigquery/docs/locations for supported locations. "maxTimeTravelHours": "A String", # Optional. Defines the time travel window in hours. The value can be from 48 to 168 hours (2 to 7 days). The default value is 168 hours if this is not set. + "resourceTags": { # Optional. The [tags](/bigquery/docs/tags) attached to this dataset. Tag keys are globally unique. Tag key is expected to be in the namespaced format, for example "123456789012/environment" where 123456789012 is the ID of the parent organization or project resource for this tag key. Tag value is expected to be the short name, for example "Production". See [Tag definitions](/iam/docs/tags-access-control#definitions) for more details. + "a_key": "A String", + }, "restrictions": { # Optional. Output only. Restriction config for all tables and dataset. If set, restrict certain accesses on the dataset and all its tables based on the config. See [Data egress](/bigquery/docs/analytics-hub-introduction#data_egress) for more details. "type": "A String", # Output only. Specifies the type of dataset/table restriction. }, @@ -938,7 +959,7 @@

Method Details

"projectId": "A String", # Optional. The ID of the project containing this dataset. }, "defaultCollation": "A String", # Optional. Defines the default collation specification of future tables created in the dataset. If a table is created in this dataset without table-level default collation, then the table inherits the dataset default collation, which is applied to the string fields that do not have explicit collation specified. A change to this field affects only tables created afterwards, and does not alter the existing tables. The following values are supported: * 'und:ci': undetermined locale, case insensitive. * '': empty string. Default to case-sensitive behavior. - "defaultEncryptionConfiguration": { # The default encryption key for all tables in the dataset. Once this property is set, all newly-created partitioned tables in the dataset will have encryption key set to this value, unless table creation request (or query) overrides the key. + "defaultEncryptionConfiguration": { # The default encryption key for all tables in the dataset. After this property is set, the encryption key of all newly-created tables in the dataset is set to this value unless the table creation request or query explicitly overrides the key. "kmsKeyName": "A String", # Optional. Describes the Cloud KMS encryption key that will be used to protect destination BigQuery table. The BigQuery Service Account associated with your project requires access to this encryption key. }, "defaultPartitionExpirationMs": "A String", # This default partition expiration, expressed in milliseconds. When new time-partitioned tables are created in a dataset where this property is set, the table will inherit this value, propagated as the `TimePartitioning.expirationMs` property on the new table. If you set `TimePartitioning.expirationMs` explicitly when creating a table, the `defaultPartitionExpirationMs` of the containing dataset is ignored. When creating a partitioned table, if `defaultPartitionExpirationMs` is set, the `defaultTableExpirationMs` value is ignored and the table will not be inherit a table expiration deadline. @@ -975,6 +996,9 @@

Method Details

}, "location": "A String", # The geographic location where the dataset should reside. See https://cloud.google.com/bigquery/docs/locations for supported locations. "maxTimeTravelHours": "A String", # Optional. Defines the time travel window in hours. The value can be from 48 to 168 hours (2 to 7 days). The default value is 168 hours if this is not set. + "resourceTags": { # Optional. The [tags](/bigquery/docs/tags) attached to this dataset. Tag keys are globally unique. Tag key is expected to be in the namespaced format, for example "123456789012/environment" where 123456789012 is the ID of the parent organization or project resource for this tag key. Tag value is expected to be the short name, for example "Production". See [Tag definitions](/iam/docs/tags-access-control#definitions) for more details. + "a_key": "A String", + }, "restrictions": { # Optional. Output only. Restriction config for all tables and dataset. If set, restrict certain accesses on the dataset and all its tables based on the config. See [Data egress](/bigquery/docs/analytics-hub-introduction#data_egress) for more details. "type": "A String", # Output only. Specifies the type of dataset/table restriction. }, diff --git a/docs/dyn/bigquery_v2.jobs.html b/docs/dyn/bigquery_v2.jobs.html index 0dfc5566a08..3c9e0b852da 100644 --- a/docs/dyn/bigquery_v2.jobs.html +++ b/docs/dyn/bigquery_v2.jobs.html @@ -175,7 +175,7 @@

Method Details

}, "useAvroLogicalTypes": True or False, # Whether to use logical types when extracting to AVRO format. Not applicable when extracting models. }, - "jobTimeoutMs": "A String", # Optional. Job timeout in milliseconds. If this time limit is exceeded, BigQuery might attempt to stop the job. + "jobTimeoutMs": "A String", # Optional. Job timeout in milliseconds. If this time limit is exceeded, BigQuery will attempt to stop a longer job, but may not always succeed in canceling it before the job completes. For example, a job that takes more than 60 seconds to complete has a better chance of being stopped than a job that takes 10 seconds to complete. "jobType": "A String", # Output only. The type of the job. Can be QUERY, LOAD, EXTRACT, COPY or UNKNOWN. "labels": { # The labels associated with this job. You can use these to organize and group your jobs. Label keys and values can be no longer than 63 characters, can only contain lowercase letters, numeric characters, underscores and dashes. International characters are allowed. Label values are optional. Label keys must start with a letter and each label in the list must have a different key. "a_key": "A String", @@ -189,6 +189,7 @@

Method Details

"A String", ], }, + "columnNameCharacterMap": "A String", # Optional. Character map supported for column names in CSV/Parquet loads. Defaults to STRICT and can be overridden by Project Config Service. Using this option with unsupporting load formats will result in an error. "connectionProperties": [ # Optional. Connection properties which can modify the load job behavior. Currently, only the 'session_id' connection property is supported, and is used to resolve _SESSION appearing as the dataset id. { # A connection-level property to customize query behavior. Under JDBC, these correspond directly to connection properties passed to the DriverManager. Under ODBC, these correspond to properties in the connection string. Currently supported connection properties: * **dataset_project_id**: represents the default project for datasets that are used in the query. Setting the system variable `@@dataset_project_id` achieves the same behavior. For more information about system variables, see: https://cloud.google.com/bigquery/docs/reference/system-variables * **time_zone**: represents the default timezone used to run the query. * **session_id**: associates the query with a given session. * **query_label**: associates the query with a given job label. If set, all subsequent queries in a script or session will have this label. For the format in which a you can specify a query label, see labels in the JobConfiguration resource type: https://cloud.google.com/bigquery/docs/reference/rest/v2/Job#jobconfiguration Additional properties are allowed, but ignored. Specifying multiple connection properties with the same key returns an error. "key": "A String", # The key of the property to set. @@ -235,7 +236,7 @@

Method Details

"parquetOptions": { # Parquet Options for load and make external tables. # Optional. Additional properties to set if sourceFormat is set to PARQUET. "enableListInference": True or False, # Optional. Indicates whether to use schema inference specifically for Parquet LIST logical type. "enumAsString": True or False, # Optional. Indicates whether to infer Parquet ENUM logical type as STRING instead of BYTES by default. - "mapTargetType": "A String", # Optional. Will indicate how to represent a parquet map if present. + "mapTargetType": "A String", # Optional. Indicates how to represent a Parquet map if present. }, "preserveAsciiControlCharacters": True or False, # Optional. When sourceFormat is set to "CSV", this indicates whether the embedded ASCII control characters (the first 32 characters in the ASCII-table, from '\x00' to '\x1F') are preserved. "projectionFields": [ # If sourceFormat is set to "DATASTORE_BACKUP", indicates which entity properties to load into BigQuery from a Cloud Datastore backup. Property names are case sensitive and must be top-level properties. If no properties are specified, BigQuery loads all properties. If any named property isn't found in the Cloud Datastore backup, an invalid error is returned in the job result. @@ -243,7 +244,7 @@

Method Details

], "quote": """, # Optional. The value that is used to quote data sections in a CSV file. BigQuery converts the string to ISO-8859-1 encoding, and then uses the first byte of the encoded string to split the data in its raw, binary state. The default value is a double-quote ('"'). If your data does not contain quoted sections, set the property value to an empty string. If your data contains quoted newline characters, you must also set the allowQuotedNewlines property to true. To include the specific quote character within a quoted value, precede it with an additional matching quote character. For example, if you want to escape the default character ' " ', use ' "" '. @default " "rangePartitioning": { # Range partitioning specification for the destination table. Only one of timePartitioning and rangePartitioning should be specified. - "field": "A String", # Required. [Experimental] The table is partitioned by this field. The field must be a top-level NULLABLE/REQUIRED field. The only supported type is INTEGER/INT64. + "field": "A String", # Required. The name of the column to partition the table on. It must be a top-level, INT64 column whose mode is NULLABLE or REQUIRED. "range": { # [Experimental] Defines the ranges for range partitioning. "end": "A String", # [Experimental] The end of range partitioning, exclusive. "interval": "A String", # [Experimental] The width of each interval. @@ -372,7 +373,7 @@

Method Details

}, ], "rangePartitioning": { # Range partitioning specification for the destination table. Only one of timePartitioning and rangePartitioning should be specified. - "field": "A String", # Required. [Experimental] The table is partitioned by this field. The field must be a top-level NULLABLE/REQUIRED field. The only supported type is INTEGER/INT64. + "field": "A String", # Required. The name of the column to partition the table on. It must be a top-level, INT64 column whose mode is NULLABLE or REQUIRED. "range": { # [Experimental] Defines the ranges for range partitioning. "end": "A String", # [Experimental] The end of range partitioning, exclusive. "interval": "A String", # [Experimental] The width of each interval. @@ -475,7 +476,7 @@

Method Details

"parquetOptions": { # Parquet Options for load and make external tables. # Optional. Additional properties to set if sourceFormat is set to PARQUET. "enableListInference": True or False, # Optional. Indicates whether to use schema inference specifically for Parquet LIST logical type. "enumAsString": True or False, # Optional. Indicates whether to infer Parquet ENUM logical type as STRING instead of BYTES by default. - "mapTargetType": "A String", # Optional. Will indicate how to represent a parquet map if present. + "mapTargetType": "A String", # Optional. Indicates how to represent a Parquet map if present. }, "referenceFileSchemaUri": "A String", # Optional. When creating an external table, the user can provide a reference file with the table schema. This is enabled for the following formats: AVRO, PARQUET, ORC. "schema": { # Schema of a table # Optional. The schema for the data. Schema is required for CSV and JSON formats if autodetect is not on. Schema is disallowed for Google Cloud Bigtable, Cloud Datastore backups, Avro, ORC and Parquet formats. @@ -1571,7 +1572,7 @@

Method Details

}, "useAvroLogicalTypes": True or False, # Whether to use logical types when extracting to AVRO format. Not applicable when extracting models. }, - "jobTimeoutMs": "A String", # Optional. Job timeout in milliseconds. If this time limit is exceeded, BigQuery might attempt to stop the job. + "jobTimeoutMs": "A String", # Optional. Job timeout in milliseconds. If this time limit is exceeded, BigQuery will attempt to stop a longer job, but may not always succeed in canceling it before the job completes. For example, a job that takes more than 60 seconds to complete has a better chance of being stopped than a job that takes 10 seconds to complete. "jobType": "A String", # Output only. The type of the job. Can be QUERY, LOAD, EXTRACT, COPY or UNKNOWN. "labels": { # The labels associated with this job. You can use these to organize and group your jobs. Label keys and values can be no longer than 63 characters, can only contain lowercase letters, numeric characters, underscores and dashes. International characters are allowed. Label values are optional. Label keys must start with a letter and each label in the list must have a different key. "a_key": "A String", @@ -1585,6 +1586,7 @@

Method Details

"A String", ], }, + "columnNameCharacterMap": "A String", # Optional. Character map supported for column names in CSV/Parquet loads. Defaults to STRICT and can be overridden by Project Config Service. Using this option with unsupporting load formats will result in an error. "connectionProperties": [ # Optional. Connection properties which can modify the load job behavior. Currently, only the 'session_id' connection property is supported, and is used to resolve _SESSION appearing as the dataset id. { # A connection-level property to customize query behavior. Under JDBC, these correspond directly to connection properties passed to the DriverManager. Under ODBC, these correspond to properties in the connection string. Currently supported connection properties: * **dataset_project_id**: represents the default project for datasets that are used in the query. Setting the system variable `@@dataset_project_id` achieves the same behavior. For more information about system variables, see: https://cloud.google.com/bigquery/docs/reference/system-variables * **time_zone**: represents the default timezone used to run the query. * **session_id**: associates the query with a given session. * **query_label**: associates the query with a given job label. If set, all subsequent queries in a script or session will have this label. For the format in which a you can specify a query label, see labels in the JobConfiguration resource type: https://cloud.google.com/bigquery/docs/reference/rest/v2/Job#jobconfiguration Additional properties are allowed, but ignored. Specifying multiple connection properties with the same key returns an error. "key": "A String", # The key of the property to set. @@ -1631,7 +1633,7 @@

Method Details

"parquetOptions": { # Parquet Options for load and make external tables. # Optional. Additional properties to set if sourceFormat is set to PARQUET. "enableListInference": True or False, # Optional. Indicates whether to use schema inference specifically for Parquet LIST logical type. "enumAsString": True or False, # Optional. Indicates whether to infer Parquet ENUM logical type as STRING instead of BYTES by default. - "mapTargetType": "A String", # Optional. Will indicate how to represent a parquet map if present. + "mapTargetType": "A String", # Optional. Indicates how to represent a Parquet map if present. }, "preserveAsciiControlCharacters": True or False, # Optional. When sourceFormat is set to "CSV", this indicates whether the embedded ASCII control characters (the first 32 characters in the ASCII-table, from '\x00' to '\x1F') are preserved. "projectionFields": [ # If sourceFormat is set to "DATASTORE_BACKUP", indicates which entity properties to load into BigQuery from a Cloud Datastore backup. Property names are case sensitive and must be top-level properties. If no properties are specified, BigQuery loads all properties. If any named property isn't found in the Cloud Datastore backup, an invalid error is returned in the job result. @@ -1639,7 +1641,7 @@

Method Details

], "quote": """, # Optional. The value that is used to quote data sections in a CSV file. BigQuery converts the string to ISO-8859-1 encoding, and then uses the first byte of the encoded string to split the data in its raw, binary state. The default value is a double-quote ('"'). If your data does not contain quoted sections, set the property value to an empty string. If your data contains quoted newline characters, you must also set the allowQuotedNewlines property to true. To include the specific quote character within a quoted value, precede it with an additional matching quote character. For example, if you want to escape the default character ' " ', use ' "" '. @default " "rangePartitioning": { # Range partitioning specification for the destination table. Only one of timePartitioning and rangePartitioning should be specified. - "field": "A String", # Required. [Experimental] The table is partitioned by this field. The field must be a top-level NULLABLE/REQUIRED field. The only supported type is INTEGER/INT64. + "field": "A String", # Required. The name of the column to partition the table on. It must be a top-level, INT64 column whose mode is NULLABLE or REQUIRED. "range": { # [Experimental] Defines the ranges for range partitioning. "end": "A String", # [Experimental] The end of range partitioning, exclusive. "interval": "A String", # [Experimental] The width of each interval. @@ -1768,7 +1770,7 @@

Method Details

}, ], "rangePartitioning": { # Range partitioning specification for the destination table. Only one of timePartitioning and rangePartitioning should be specified. - "field": "A String", # Required. [Experimental] The table is partitioned by this field. The field must be a top-level NULLABLE/REQUIRED field. The only supported type is INTEGER/INT64. + "field": "A String", # Required. The name of the column to partition the table on. It must be a top-level, INT64 column whose mode is NULLABLE or REQUIRED. "range": { # [Experimental] Defines the ranges for range partitioning. "end": "A String", # [Experimental] The end of range partitioning, exclusive. "interval": "A String", # [Experimental] The width of each interval. @@ -1871,7 +1873,7 @@

Method Details

"parquetOptions": { # Parquet Options for load and make external tables. # Optional. Additional properties to set if sourceFormat is set to PARQUET. "enableListInference": True or False, # Optional. Indicates whether to use schema inference specifically for Parquet LIST logical type. "enumAsString": True or False, # Optional. Indicates whether to infer Parquet ENUM logical type as STRING instead of BYTES by default. - "mapTargetType": "A String", # Optional. Will indicate how to represent a parquet map if present. + "mapTargetType": "A String", # Optional. Indicates how to represent a Parquet map if present. }, "referenceFileSchemaUri": "A String", # Optional. When creating an external table, the user can provide a reference file with the table schema. This is enabled for the following formats: AVRO, PARQUET, ORC. "schema": { # Schema of a table # Optional. The schema for the data. Schema is required for CSV and JSON formats if autodetect is not on. Schema is disallowed for Google Cloud Bigtable, Cloud Datastore backups, Avro, ORC and Parquet formats. @@ -3043,7 +3045,7 @@

Method Details

}, "useAvroLogicalTypes": True or False, # Whether to use logical types when extracting to AVRO format. Not applicable when extracting models. }, - "jobTimeoutMs": "A String", # Optional. Job timeout in milliseconds. If this time limit is exceeded, BigQuery might attempt to stop the job. + "jobTimeoutMs": "A String", # Optional. Job timeout in milliseconds. If this time limit is exceeded, BigQuery will attempt to stop a longer job, but may not always succeed in canceling it before the job completes. For example, a job that takes more than 60 seconds to complete has a better chance of being stopped than a job that takes 10 seconds to complete. "jobType": "A String", # Output only. The type of the job. Can be QUERY, LOAD, EXTRACT, COPY or UNKNOWN. "labels": { # The labels associated with this job. You can use these to organize and group your jobs. Label keys and values can be no longer than 63 characters, can only contain lowercase letters, numeric characters, underscores and dashes. International characters are allowed. Label values are optional. Label keys must start with a letter and each label in the list must have a different key. "a_key": "A String", @@ -3057,6 +3059,7 @@

Method Details

"A String", ], }, + "columnNameCharacterMap": "A String", # Optional. Character map supported for column names in CSV/Parquet loads. Defaults to STRICT and can be overridden by Project Config Service. Using this option with unsupporting load formats will result in an error. "connectionProperties": [ # Optional. Connection properties which can modify the load job behavior. Currently, only the 'session_id' connection property is supported, and is used to resolve _SESSION appearing as the dataset id. { # A connection-level property to customize query behavior. Under JDBC, these correspond directly to connection properties passed to the DriverManager. Under ODBC, these correspond to properties in the connection string. Currently supported connection properties: * **dataset_project_id**: represents the default project for datasets that are used in the query. Setting the system variable `@@dataset_project_id` achieves the same behavior. For more information about system variables, see: https://cloud.google.com/bigquery/docs/reference/system-variables * **time_zone**: represents the default timezone used to run the query. * **session_id**: associates the query with a given session. * **query_label**: associates the query with a given job label. If set, all subsequent queries in a script or session will have this label. For the format in which a you can specify a query label, see labels in the JobConfiguration resource type: https://cloud.google.com/bigquery/docs/reference/rest/v2/Job#jobconfiguration Additional properties are allowed, but ignored. Specifying multiple connection properties with the same key returns an error. "key": "A String", # The key of the property to set. @@ -3103,7 +3106,7 @@

Method Details

"parquetOptions": { # Parquet Options for load and make external tables. # Optional. Additional properties to set if sourceFormat is set to PARQUET. "enableListInference": True or False, # Optional. Indicates whether to use schema inference specifically for Parquet LIST logical type. "enumAsString": True or False, # Optional. Indicates whether to infer Parquet ENUM logical type as STRING instead of BYTES by default. - "mapTargetType": "A String", # Optional. Will indicate how to represent a parquet map if present. + "mapTargetType": "A String", # Optional. Indicates how to represent a Parquet map if present. }, "preserveAsciiControlCharacters": True or False, # Optional. When sourceFormat is set to "CSV", this indicates whether the embedded ASCII control characters (the first 32 characters in the ASCII-table, from '\x00' to '\x1F') are preserved. "projectionFields": [ # If sourceFormat is set to "DATASTORE_BACKUP", indicates which entity properties to load into BigQuery from a Cloud Datastore backup. Property names are case sensitive and must be top-level properties. If no properties are specified, BigQuery loads all properties. If any named property isn't found in the Cloud Datastore backup, an invalid error is returned in the job result. @@ -3111,7 +3114,7 @@

Method Details

], "quote": """, # Optional. The value that is used to quote data sections in a CSV file. BigQuery converts the string to ISO-8859-1 encoding, and then uses the first byte of the encoded string to split the data in its raw, binary state. The default value is a double-quote ('"'). If your data does not contain quoted sections, set the property value to an empty string. If your data contains quoted newline characters, you must also set the allowQuotedNewlines property to true. To include the specific quote character within a quoted value, precede it with an additional matching quote character. For example, if you want to escape the default character ' " ', use ' "" '. @default " "rangePartitioning": { # Range partitioning specification for the destination table. Only one of timePartitioning and rangePartitioning should be specified. - "field": "A String", # Required. [Experimental] The table is partitioned by this field. The field must be a top-level NULLABLE/REQUIRED field. The only supported type is INTEGER/INT64. + "field": "A String", # Required. The name of the column to partition the table on. It must be a top-level, INT64 column whose mode is NULLABLE or REQUIRED. "range": { # [Experimental] Defines the ranges for range partitioning. "end": "A String", # [Experimental] The end of range partitioning, exclusive. "interval": "A String", # [Experimental] The width of each interval. @@ -3240,7 +3243,7 @@

Method Details

}, ], "rangePartitioning": { # Range partitioning specification for the destination table. Only one of timePartitioning and rangePartitioning should be specified. - "field": "A String", # Required. [Experimental] The table is partitioned by this field. The field must be a top-level NULLABLE/REQUIRED field. The only supported type is INTEGER/INT64. + "field": "A String", # Required. The name of the column to partition the table on. It must be a top-level, INT64 column whose mode is NULLABLE or REQUIRED. "range": { # [Experimental] Defines the ranges for range partitioning. "end": "A String", # [Experimental] The end of range partitioning, exclusive. "interval": "A String", # [Experimental] The width of each interval. @@ -3343,7 +3346,7 @@

Method Details

"parquetOptions": { # Parquet Options for load and make external tables. # Optional. Additional properties to set if sourceFormat is set to PARQUET. "enableListInference": True or False, # Optional. Indicates whether to use schema inference specifically for Parquet LIST logical type. "enumAsString": True or False, # Optional. Indicates whether to infer Parquet ENUM logical type as STRING instead of BYTES by default. - "mapTargetType": "A String", # Optional. Will indicate how to represent a parquet map if present. + "mapTargetType": "A String", # Optional. Indicates how to represent a Parquet map if present. }, "referenceFileSchemaUri": "A String", # Optional. When creating an external table, the user can provide a reference file with the table schema. This is enabled for the following formats: AVRO, PARQUET, ORC. "schema": { # Schema of a table # Optional. The schema for the data. Schema is required for CSV and JSON formats if autodetect is not on. Schema is disallowed for Google Cloud Bigtable, Cloud Datastore backups, Avro, ORC and Parquet formats. @@ -4410,7 +4413,7 @@

Method Details

}, "useAvroLogicalTypes": True or False, # Whether to use logical types when extracting to AVRO format. Not applicable when extracting models. }, - "jobTimeoutMs": "A String", # Optional. Job timeout in milliseconds. If this time limit is exceeded, BigQuery might attempt to stop the job. + "jobTimeoutMs": "A String", # Optional. Job timeout in milliseconds. If this time limit is exceeded, BigQuery will attempt to stop a longer job, but may not always succeed in canceling it before the job completes. For example, a job that takes more than 60 seconds to complete has a better chance of being stopped than a job that takes 10 seconds to complete. "jobType": "A String", # Output only. The type of the job. Can be QUERY, LOAD, EXTRACT, COPY or UNKNOWN. "labels": { # The labels associated with this job. You can use these to organize and group your jobs. Label keys and values can be no longer than 63 characters, can only contain lowercase letters, numeric characters, underscores and dashes. International characters are allowed. Label values are optional. Label keys must start with a letter and each label in the list must have a different key. "a_key": "A String", @@ -4424,6 +4427,7 @@

Method Details

"A String", ], }, + "columnNameCharacterMap": "A String", # Optional. Character map supported for column names in CSV/Parquet loads. Defaults to STRICT and can be overridden by Project Config Service. Using this option with unsupporting load formats will result in an error. "connectionProperties": [ # Optional. Connection properties which can modify the load job behavior. Currently, only the 'session_id' connection property is supported, and is used to resolve _SESSION appearing as the dataset id. { # A connection-level property to customize query behavior. Under JDBC, these correspond directly to connection properties passed to the DriverManager. Under ODBC, these correspond to properties in the connection string. Currently supported connection properties: * **dataset_project_id**: represents the default project for datasets that are used in the query. Setting the system variable `@@dataset_project_id` achieves the same behavior. For more information about system variables, see: https://cloud.google.com/bigquery/docs/reference/system-variables * **time_zone**: represents the default timezone used to run the query. * **session_id**: associates the query with a given session. * **query_label**: associates the query with a given job label. If set, all subsequent queries in a script or session will have this label. For the format in which a you can specify a query label, see labels in the JobConfiguration resource type: https://cloud.google.com/bigquery/docs/reference/rest/v2/Job#jobconfiguration Additional properties are allowed, but ignored. Specifying multiple connection properties with the same key returns an error. "key": "A String", # The key of the property to set. @@ -4470,7 +4474,7 @@

Method Details

"parquetOptions": { # Parquet Options for load and make external tables. # Optional. Additional properties to set if sourceFormat is set to PARQUET. "enableListInference": True or False, # Optional. Indicates whether to use schema inference specifically for Parquet LIST logical type. "enumAsString": True or False, # Optional. Indicates whether to infer Parquet ENUM logical type as STRING instead of BYTES by default. - "mapTargetType": "A String", # Optional. Will indicate how to represent a parquet map if present. + "mapTargetType": "A String", # Optional. Indicates how to represent a Parquet map if present. }, "preserveAsciiControlCharacters": True or False, # Optional. When sourceFormat is set to "CSV", this indicates whether the embedded ASCII control characters (the first 32 characters in the ASCII-table, from '\x00' to '\x1F') are preserved. "projectionFields": [ # If sourceFormat is set to "DATASTORE_BACKUP", indicates which entity properties to load into BigQuery from a Cloud Datastore backup. Property names are case sensitive and must be top-level properties. If no properties are specified, BigQuery loads all properties. If any named property isn't found in the Cloud Datastore backup, an invalid error is returned in the job result. @@ -4478,7 +4482,7 @@

Method Details

], "quote": """, # Optional. The value that is used to quote data sections in a CSV file. BigQuery converts the string to ISO-8859-1 encoding, and then uses the first byte of the encoded string to split the data in its raw, binary state. The default value is a double-quote ('"'). If your data does not contain quoted sections, set the property value to an empty string. If your data contains quoted newline characters, you must also set the allowQuotedNewlines property to true. To include the specific quote character within a quoted value, precede it with an additional matching quote character. For example, if you want to escape the default character ' " ', use ' "" '. @default " "rangePartitioning": { # Range partitioning specification for the destination table. Only one of timePartitioning and rangePartitioning should be specified. - "field": "A String", # Required. [Experimental] The table is partitioned by this field. The field must be a top-level NULLABLE/REQUIRED field. The only supported type is INTEGER/INT64. + "field": "A String", # Required. The name of the column to partition the table on. It must be a top-level, INT64 column whose mode is NULLABLE or REQUIRED. "range": { # [Experimental] Defines the ranges for range partitioning. "end": "A String", # [Experimental] The end of range partitioning, exclusive. "interval": "A String", # [Experimental] The width of each interval. @@ -4607,7 +4611,7 @@

Method Details

}, ], "rangePartitioning": { # Range partitioning specification for the destination table. Only one of timePartitioning and rangePartitioning should be specified. - "field": "A String", # Required. [Experimental] The table is partitioned by this field. The field must be a top-level NULLABLE/REQUIRED field. The only supported type is INTEGER/INT64. + "field": "A String", # Required. The name of the column to partition the table on. It must be a top-level, INT64 column whose mode is NULLABLE or REQUIRED. "range": { # [Experimental] Defines the ranges for range partitioning. "end": "A String", # [Experimental] The end of range partitioning, exclusive. "interval": "A String", # [Experimental] The width of each interval. @@ -4710,7 +4714,7 @@

Method Details

"parquetOptions": { # Parquet Options for load and make external tables. # Optional. Additional properties to set if sourceFormat is set to PARQUET. "enableListInference": True or False, # Optional. Indicates whether to use schema inference specifically for Parquet LIST logical type. "enumAsString": True or False, # Optional. Indicates whether to infer Parquet ENUM logical type as STRING instead of BYTES by default. - "mapTargetType": "A String", # Optional. Will indicate how to represent a parquet map if present. + "mapTargetType": "A String", # Optional. Indicates how to represent a Parquet map if present. }, "referenceFileSchemaUri": "A String", # Optional. When creating an external table, the user can provide a reference file with the table schema. This is enabled for the following formats: AVRO, PARQUET, ORC. "schema": { # Schema of a table # Optional. The schema for the data. Schema is required for CSV and JSON formats if autodetect is not on. Schema is disallowed for Google Cloud Bigtable, Cloud Datastore backups, Avro, ORC and Parquet formats. @@ -5800,7 +5804,7 @@

Method Details

}, "useAvroLogicalTypes": True or False, # Whether to use logical types when extracting to AVRO format. Not applicable when extracting models. }, - "jobTimeoutMs": "A String", # Optional. Job timeout in milliseconds. If this time limit is exceeded, BigQuery might attempt to stop the job. + "jobTimeoutMs": "A String", # Optional. Job timeout in milliseconds. If this time limit is exceeded, BigQuery will attempt to stop a longer job, but may not always succeed in canceling it before the job completes. For example, a job that takes more than 60 seconds to complete has a better chance of being stopped than a job that takes 10 seconds to complete. "jobType": "A String", # Output only. The type of the job. Can be QUERY, LOAD, EXTRACT, COPY or UNKNOWN. "labels": { # The labels associated with this job. You can use these to organize and group your jobs. Label keys and values can be no longer than 63 characters, can only contain lowercase letters, numeric characters, underscores and dashes. International characters are allowed. Label values are optional. Label keys must start with a letter and each label in the list must have a different key. "a_key": "A String", @@ -5814,6 +5818,7 @@

Method Details

"A String", ], }, + "columnNameCharacterMap": "A String", # Optional. Character map supported for column names in CSV/Parquet loads. Defaults to STRICT and can be overridden by Project Config Service. Using this option with unsupporting load formats will result in an error. "connectionProperties": [ # Optional. Connection properties which can modify the load job behavior. Currently, only the 'session_id' connection property is supported, and is used to resolve _SESSION appearing as the dataset id. { # A connection-level property to customize query behavior. Under JDBC, these correspond directly to connection properties passed to the DriverManager. Under ODBC, these correspond to properties in the connection string. Currently supported connection properties: * **dataset_project_id**: represents the default project for datasets that are used in the query. Setting the system variable `@@dataset_project_id` achieves the same behavior. For more information about system variables, see: https://cloud.google.com/bigquery/docs/reference/system-variables * **time_zone**: represents the default timezone used to run the query. * **session_id**: associates the query with a given session. * **query_label**: associates the query with a given job label. If set, all subsequent queries in a script or session will have this label. For the format in which a you can specify a query label, see labels in the JobConfiguration resource type: https://cloud.google.com/bigquery/docs/reference/rest/v2/Job#jobconfiguration Additional properties are allowed, but ignored. Specifying multiple connection properties with the same key returns an error. "key": "A String", # The key of the property to set. @@ -5860,7 +5865,7 @@

Method Details

"parquetOptions": { # Parquet Options for load and make external tables. # Optional. Additional properties to set if sourceFormat is set to PARQUET. "enableListInference": True or False, # Optional. Indicates whether to use schema inference specifically for Parquet LIST logical type. "enumAsString": True or False, # Optional. Indicates whether to infer Parquet ENUM logical type as STRING instead of BYTES by default. - "mapTargetType": "A String", # Optional. Will indicate how to represent a parquet map if present. + "mapTargetType": "A String", # Optional. Indicates how to represent a Parquet map if present. }, "preserveAsciiControlCharacters": True or False, # Optional. When sourceFormat is set to "CSV", this indicates whether the embedded ASCII control characters (the first 32 characters in the ASCII-table, from '\x00' to '\x1F') are preserved. "projectionFields": [ # If sourceFormat is set to "DATASTORE_BACKUP", indicates which entity properties to load into BigQuery from a Cloud Datastore backup. Property names are case sensitive and must be top-level properties. If no properties are specified, BigQuery loads all properties. If any named property isn't found in the Cloud Datastore backup, an invalid error is returned in the job result. @@ -5868,7 +5873,7 @@

Method Details

], "quote": """, # Optional. The value that is used to quote data sections in a CSV file. BigQuery converts the string to ISO-8859-1 encoding, and then uses the first byte of the encoded string to split the data in its raw, binary state. The default value is a double-quote ('"'). If your data does not contain quoted sections, set the property value to an empty string. If your data contains quoted newline characters, you must also set the allowQuotedNewlines property to true. To include the specific quote character within a quoted value, precede it with an additional matching quote character. For example, if you want to escape the default character ' " ', use ' "" '. @default " "rangePartitioning": { # Range partitioning specification for the destination table. Only one of timePartitioning and rangePartitioning should be specified. - "field": "A String", # Required. [Experimental] The table is partitioned by this field. The field must be a top-level NULLABLE/REQUIRED field. The only supported type is INTEGER/INT64. + "field": "A String", # Required. The name of the column to partition the table on. It must be a top-level, INT64 column whose mode is NULLABLE or REQUIRED. "range": { # [Experimental] Defines the ranges for range partitioning. "end": "A String", # [Experimental] The end of range partitioning, exclusive. "interval": "A String", # [Experimental] The width of each interval. @@ -5997,7 +6002,7 @@

Method Details

}, ], "rangePartitioning": { # Range partitioning specification for the destination table. Only one of timePartitioning and rangePartitioning should be specified. - "field": "A String", # Required. [Experimental] The table is partitioned by this field. The field must be a top-level NULLABLE/REQUIRED field. The only supported type is INTEGER/INT64. + "field": "A String", # Required. The name of the column to partition the table on. It must be a top-level, INT64 column whose mode is NULLABLE or REQUIRED. "range": { # [Experimental] Defines the ranges for range partitioning. "end": "A String", # [Experimental] The end of range partitioning, exclusive. "interval": "A String", # [Experimental] The width of each interval. @@ -6100,7 +6105,7 @@

Method Details

"parquetOptions": { # Parquet Options for load and make external tables. # Optional. Additional properties to set if sourceFormat is set to PARQUET. "enableListInference": True or False, # Optional. Indicates whether to use schema inference specifically for Parquet LIST logical type. "enumAsString": True or False, # Optional. Indicates whether to infer Parquet ENUM logical type as STRING instead of BYTES by default. - "mapTargetType": "A String", # Optional. Will indicate how to represent a parquet map if present. + "mapTargetType": "A String", # Optional. Indicates how to represent a Parquet map if present. }, "referenceFileSchemaUri": "A String", # Optional. When creating an external table, the user can provide a reference file with the table schema. This is enabled for the following formats: AVRO, PARQUET, ORC. "schema": { # Schema of a table # Optional. The schema for the data. Schema is required for CSV and JSON formats if autodetect is not on. Schema is disallowed for Google Cloud Bigtable, Cloud Datastore backups, Avro, ORC and Parquet formats. diff --git a/docs/dyn/bigquery_v2.tables.html b/docs/dyn/bigquery_v2.tables.html index f9ed22cf31a..7a0dce36a8a 100644 --- a/docs/dyn/bigquery_v2.tables.html +++ b/docs/dyn/bigquery_v2.tables.html @@ -265,7 +265,7 @@

Method Details

"parquetOptions": { # Parquet Options for load and make external tables. # Optional. Additional properties to set if sourceFormat is set to PARQUET. "enableListInference": True or False, # Optional. Indicates whether to use schema inference specifically for Parquet LIST logical type. "enumAsString": True or False, # Optional. Indicates whether to infer Parquet ENUM logical type as STRING instead of BYTES by default. - "mapTargetType": "A String", # Optional. Will indicate how to represent a parquet map if present. + "mapTargetType": "A String", # Optional. Indicates how to represent a Parquet map if present. }, "referenceFileSchemaUri": "A String", # Optional. When creating an external table, the user can provide a reference file with the table schema. This is enabled for the following formats: AVRO, PARQUET, ORC. "schema": { # Schema of a table # Optional. The schema for the data. Schema is required for CSV and JSON formats if autodetect is not on. Schema is disallowed for Google Cloud Bigtable, Cloud Datastore backups, Avro, ORC and Parquet formats. @@ -373,6 +373,7 @@

Method Details

"numActiveLogicalBytes": "A String", # Output only. Number of logical bytes that are less than 90 days old. "numActivePhysicalBytes": "A String", # Output only. Number of physical bytes less than 90 days old. This data is not kept in real time, and might be delayed by a few seconds to a few minutes. "numBytes": "A String", # Output only. The size of this table in logical bytes, excluding any data in the streaming buffer. + "numCurrentPhysicalBytes": "A String", # Output only. Number of physical bytes used by current live data storage. This data is not kept in real time, and might be delayed by a few seconds to a few minutes. "numLongTermBytes": "A String", # Output only. The number of logical bytes in the table that are considered "long-term storage". "numLongTermLogicalBytes": "A String", # Output only. Number of logical bytes that are more than 90 days old. "numLongTermPhysicalBytes": "A String", # Output only. Number of physical bytes more than 90 days old. This data is not kept in real time, and might be delayed by a few seconds to a few minutes. @@ -390,7 +391,7 @@

Method Details

], }, "rangePartitioning": { # If specified, configures range partitioning for this table. - "field": "A String", # Required. [Experimental] The table is partitioned by this field. The field must be a top-level NULLABLE/REQUIRED field. The only supported type is INTEGER/INT64. + "field": "A String", # Required. The name of the column to partition the table on. It must be a top-level, INT64 column whose mode is NULLABLE or REQUIRED. "range": { # [Experimental] Defines the ranges for range partitioning. "end": "A String", # [Experimental] The end of range partitioning, exclusive. "interval": "A String", # [Experimental] The width of each interval. @@ -497,7 +498,7 @@

Method Details

"message": "A String", # A human-readable description of the error. "reason": "A String", # A short error code that summarizes the error. }, - "replicationIntervalMs": "A String", # Required. Specifies the interval at which the source table is polled for updates. + "replicationIntervalMs": "A String", # Optional. Specifies the interval at which the source table is polled for updates. It's Optional. If not specified, default replication interval would be applied. "replicationStatus": "A String", # Optional. Output only. Replication status of configured replication. "sourceTable": { # Required. Source table reference that is replicated. "datasetId": "A String", # Required. The ID of the dataset containing this table. @@ -513,6 +514,12 @@

Method Details

}, "type": "A String", # Output only. Describes the table type. The following values are supported: * `TABLE`: A normal BigQuery table. * `VIEW`: A virtual table defined by a SQL query. * `EXTERNAL`: A table that references data stored in an external storage system, such as Google Cloud Storage. * `MATERIALIZED_VIEW`: A precomputed view defined by a SQL query. * `SNAPSHOT`: An immutable BigQuery table that preserves the contents of a base table at a particular time. See additional information on [table snapshots](/bigquery/docs/table-snapshots-intro). The default value is `TABLE`. "view": { # Describes the definition of a logical view. # Optional. The view definition. + "foreignDefinitions": [ # Optional. Foreign view representations. + { # A view can be represented in multiple ways. Each representation has its own dialect. This message stores the metadata required for these representations. + "dialect": "A String", # Optional. Represents the dialect of the query. + "query": "A String", # Required. The query that defines the view. + }, + ], "privacyPolicy": { # Represents privacy policy that contains the privacy requirements specified by the data owner. Currently, this is only supported on views. # Optional. Specifices the privacy policy for the view. "aggregationThresholdPolicy": { # Represents privacy policy associated with "aggregation threshold" method. # Optional. Policy used for aggregation thresholds. "privacyUnitColumns": [ # Optional. The privacy unit column(s) associated with this policy. For now, only one column per data source object (table, view) is allowed as a privacy unit column. Representing as a repeated field in metadata for extensibility to multiple columns in future. Duplicates and Repeated struct fields are not allowed. For nested fields, use dot notation ("outer.inner") @@ -730,7 +737,7 @@

Method Details

"parquetOptions": { # Parquet Options for load and make external tables. # Optional. Additional properties to set if sourceFormat is set to PARQUET. "enableListInference": True or False, # Optional. Indicates whether to use schema inference specifically for Parquet LIST logical type. "enumAsString": True or False, # Optional. Indicates whether to infer Parquet ENUM logical type as STRING instead of BYTES by default. - "mapTargetType": "A String", # Optional. Will indicate how to represent a parquet map if present. + "mapTargetType": "A String", # Optional. Indicates how to represent a Parquet map if present. }, "referenceFileSchemaUri": "A String", # Optional. When creating an external table, the user can provide a reference file with the table schema. This is enabled for the following formats: AVRO, PARQUET, ORC. "schema": { # Schema of a table # Optional. The schema for the data. Schema is required for CSV and JSON formats if autodetect is not on. Schema is disallowed for Google Cloud Bigtable, Cloud Datastore backups, Avro, ORC and Parquet formats. @@ -838,6 +845,7 @@

Method Details

"numActiveLogicalBytes": "A String", # Output only. Number of logical bytes that are less than 90 days old. "numActivePhysicalBytes": "A String", # Output only. Number of physical bytes less than 90 days old. This data is not kept in real time, and might be delayed by a few seconds to a few minutes. "numBytes": "A String", # Output only. The size of this table in logical bytes, excluding any data in the streaming buffer. + "numCurrentPhysicalBytes": "A String", # Output only. Number of physical bytes used by current live data storage. This data is not kept in real time, and might be delayed by a few seconds to a few minutes. "numLongTermBytes": "A String", # Output only. The number of logical bytes in the table that are considered "long-term storage". "numLongTermLogicalBytes": "A String", # Output only. Number of logical bytes that are more than 90 days old. "numLongTermPhysicalBytes": "A String", # Output only. Number of physical bytes more than 90 days old. This data is not kept in real time, and might be delayed by a few seconds to a few minutes. @@ -855,7 +863,7 @@

Method Details

], }, "rangePartitioning": { # If specified, configures range partitioning for this table. - "field": "A String", # Required. [Experimental] The table is partitioned by this field. The field must be a top-level NULLABLE/REQUIRED field. The only supported type is INTEGER/INT64. + "field": "A String", # Required. The name of the column to partition the table on. It must be a top-level, INT64 column whose mode is NULLABLE or REQUIRED. "range": { # [Experimental] Defines the ranges for range partitioning. "end": "A String", # [Experimental] The end of range partitioning, exclusive. "interval": "A String", # [Experimental] The width of each interval. @@ -962,7 +970,7 @@

Method Details

"message": "A String", # A human-readable description of the error. "reason": "A String", # A short error code that summarizes the error. }, - "replicationIntervalMs": "A String", # Required. Specifies the interval at which the source table is polled for updates. + "replicationIntervalMs": "A String", # Optional. Specifies the interval at which the source table is polled for updates. It's Optional. If not specified, default replication interval would be applied. "replicationStatus": "A String", # Optional. Output only. Replication status of configured replication. "sourceTable": { # Required. Source table reference that is replicated. "datasetId": "A String", # Required. The ID of the dataset containing this table. @@ -978,6 +986,12 @@

Method Details

}, "type": "A String", # Output only. Describes the table type. The following values are supported: * `TABLE`: A normal BigQuery table. * `VIEW`: A virtual table defined by a SQL query. * `EXTERNAL`: A table that references data stored in an external storage system, such as Google Cloud Storage. * `MATERIALIZED_VIEW`: A precomputed view defined by a SQL query. * `SNAPSHOT`: An immutable BigQuery table that preserves the contents of a base table at a particular time. See additional information on [table snapshots](/bigquery/docs/table-snapshots-intro). The default value is `TABLE`. "view": { # Describes the definition of a logical view. # Optional. The view definition. + "foreignDefinitions": [ # Optional. Foreign view representations. + { # A view can be represented in multiple ways. Each representation has its own dialect. This message stores the metadata required for these representations. + "dialect": "A String", # Optional. Represents the dialect of the query. + "query": "A String", # Required. The query that defines the view. + }, + ], "privacyPolicy": { # Represents privacy policy that contains the privacy requirements specified by the data owner. Currently, this is only supported on views. # Optional. Specifices the privacy policy for the view. "aggregationThresholdPolicy": { # Represents privacy policy associated with "aggregation threshold" method. # Optional. Policy used for aggregation thresholds. "privacyUnitColumns": [ # Optional. The privacy unit column(s) associated with this policy. For now, only one column per data source object (table, view) is allowed as a privacy unit column. Representing as a repeated field in metadata for extensibility to multiple columns in future. Duplicates and Repeated struct fields are not allowed. For nested fields, use dot notation ("outer.inner") @@ -1136,7 +1150,7 @@

Method Details

"parquetOptions": { # Parquet Options for load and make external tables. # Optional. Additional properties to set if sourceFormat is set to PARQUET. "enableListInference": True or False, # Optional. Indicates whether to use schema inference specifically for Parquet LIST logical type. "enumAsString": True or False, # Optional. Indicates whether to infer Parquet ENUM logical type as STRING instead of BYTES by default. - "mapTargetType": "A String", # Optional. Will indicate how to represent a parquet map if present. + "mapTargetType": "A String", # Optional. Indicates how to represent a Parquet map if present. }, "referenceFileSchemaUri": "A String", # Optional. When creating an external table, the user can provide a reference file with the table schema. This is enabled for the following formats: AVRO, PARQUET, ORC. "schema": { # Schema of a table # Optional. The schema for the data. Schema is required for CSV and JSON formats if autodetect is not on. Schema is disallowed for Google Cloud Bigtable, Cloud Datastore backups, Avro, ORC and Parquet formats. @@ -1244,6 +1258,7 @@

Method Details

"numActiveLogicalBytes": "A String", # Output only. Number of logical bytes that are less than 90 days old. "numActivePhysicalBytes": "A String", # Output only. Number of physical bytes less than 90 days old. This data is not kept in real time, and might be delayed by a few seconds to a few minutes. "numBytes": "A String", # Output only. The size of this table in logical bytes, excluding any data in the streaming buffer. + "numCurrentPhysicalBytes": "A String", # Output only. Number of physical bytes used by current live data storage. This data is not kept in real time, and might be delayed by a few seconds to a few minutes. "numLongTermBytes": "A String", # Output only. The number of logical bytes in the table that are considered "long-term storage". "numLongTermLogicalBytes": "A String", # Output only. Number of logical bytes that are more than 90 days old. "numLongTermPhysicalBytes": "A String", # Output only. Number of physical bytes more than 90 days old. This data is not kept in real time, and might be delayed by a few seconds to a few minutes. @@ -1261,7 +1276,7 @@

Method Details

], }, "rangePartitioning": { # If specified, configures range partitioning for this table. - "field": "A String", # Required. [Experimental] The table is partitioned by this field. The field must be a top-level NULLABLE/REQUIRED field. The only supported type is INTEGER/INT64. + "field": "A String", # Required. The name of the column to partition the table on. It must be a top-level, INT64 column whose mode is NULLABLE or REQUIRED. "range": { # [Experimental] Defines the ranges for range partitioning. "end": "A String", # [Experimental] The end of range partitioning, exclusive. "interval": "A String", # [Experimental] The width of each interval. @@ -1368,7 +1383,7 @@

Method Details

"message": "A String", # A human-readable description of the error. "reason": "A String", # A short error code that summarizes the error. }, - "replicationIntervalMs": "A String", # Required. Specifies the interval at which the source table is polled for updates. + "replicationIntervalMs": "A String", # Optional. Specifies the interval at which the source table is polled for updates. It's Optional. If not specified, default replication interval would be applied. "replicationStatus": "A String", # Optional. Output only. Replication status of configured replication. "sourceTable": { # Required. Source table reference that is replicated. "datasetId": "A String", # Required. The ID of the dataset containing this table. @@ -1384,6 +1399,12 @@

Method Details

}, "type": "A String", # Output only. Describes the table type. The following values are supported: * `TABLE`: A normal BigQuery table. * `VIEW`: A virtual table defined by a SQL query. * `EXTERNAL`: A table that references data stored in an external storage system, such as Google Cloud Storage. * `MATERIALIZED_VIEW`: A precomputed view defined by a SQL query. * `SNAPSHOT`: An immutable BigQuery table that preserves the contents of a base table at a particular time. See additional information on [table snapshots](/bigquery/docs/table-snapshots-intro). The default value is `TABLE`. "view": { # Describes the definition of a logical view. # Optional. The view definition. + "foreignDefinitions": [ # Optional. Foreign view representations. + { # A view can be represented in multiple ways. Each representation has its own dialect. This message stores the metadata required for these representations. + "dialect": "A String", # Optional. Represents the dialect of the query. + "query": "A String", # Required. The query that defines the view. + }, + ], "privacyPolicy": { # Represents privacy policy that contains the privacy requirements specified by the data owner. Currently, this is only supported on views. # Optional. Specifices the privacy policy for the view. "aggregationThresholdPolicy": { # Represents privacy policy associated with "aggregation threshold" method. # Optional. Policy used for aggregation thresholds. "privacyUnitColumns": [ # Optional. The privacy unit column(s) associated with this policy. For now, only one column per data source object (table, view) is allowed as a privacy unit column. Representing as a repeated field in metadata for extensibility to multiple columns in future. Duplicates and Repeated struct fields are not allowed. For nested fields, use dot notation ("outer.inner") @@ -1458,7 +1479,7 @@

Method Details

"a_key": "A String", }, "rangePartitioning": { # The range partitioning for this table. - "field": "A String", # Required. [Experimental] The table is partitioned by this field. The field must be a top-level NULLABLE/REQUIRED field. The only supported type is INTEGER/INT64. + "field": "A String", # Required. The name of the column to partition the table on. It must be a top-level, INT64 column whose mode is NULLABLE or REQUIRED. "range": { # [Experimental] Defines the ranges for range partitioning. "end": "A String", # [Experimental] The end of range partitioning, exclusive. "interval": "A String", # [Experimental] The width of each interval. @@ -1650,7 +1671,7 @@

Method Details

"parquetOptions": { # Parquet Options for load and make external tables. # Optional. Additional properties to set if sourceFormat is set to PARQUET. "enableListInference": True or False, # Optional. Indicates whether to use schema inference specifically for Parquet LIST logical type. "enumAsString": True or False, # Optional. Indicates whether to infer Parquet ENUM logical type as STRING instead of BYTES by default. - "mapTargetType": "A String", # Optional. Will indicate how to represent a parquet map if present. + "mapTargetType": "A String", # Optional. Indicates how to represent a Parquet map if present. }, "referenceFileSchemaUri": "A String", # Optional. When creating an external table, the user can provide a reference file with the table schema. This is enabled for the following formats: AVRO, PARQUET, ORC. "schema": { # Schema of a table # Optional. The schema for the data. Schema is required for CSV and JSON formats if autodetect is not on. Schema is disallowed for Google Cloud Bigtable, Cloud Datastore backups, Avro, ORC and Parquet formats. @@ -1758,6 +1779,7 @@

Method Details

"numActiveLogicalBytes": "A String", # Output only. Number of logical bytes that are less than 90 days old. "numActivePhysicalBytes": "A String", # Output only. Number of physical bytes less than 90 days old. This data is not kept in real time, and might be delayed by a few seconds to a few minutes. "numBytes": "A String", # Output only. The size of this table in logical bytes, excluding any data in the streaming buffer. + "numCurrentPhysicalBytes": "A String", # Output only. Number of physical bytes used by current live data storage. This data is not kept in real time, and might be delayed by a few seconds to a few minutes. "numLongTermBytes": "A String", # Output only. The number of logical bytes in the table that are considered "long-term storage". "numLongTermLogicalBytes": "A String", # Output only. Number of logical bytes that are more than 90 days old. "numLongTermPhysicalBytes": "A String", # Output only. Number of physical bytes more than 90 days old. This data is not kept in real time, and might be delayed by a few seconds to a few minutes. @@ -1775,7 +1797,7 @@

Method Details

], }, "rangePartitioning": { # If specified, configures range partitioning for this table. - "field": "A String", # Required. [Experimental] The table is partitioned by this field. The field must be a top-level NULLABLE/REQUIRED field. The only supported type is INTEGER/INT64. + "field": "A String", # Required. The name of the column to partition the table on. It must be a top-level, INT64 column whose mode is NULLABLE or REQUIRED. "range": { # [Experimental] Defines the ranges for range partitioning. "end": "A String", # [Experimental] The end of range partitioning, exclusive. "interval": "A String", # [Experimental] The width of each interval. @@ -1882,7 +1904,7 @@

Method Details

"message": "A String", # A human-readable description of the error. "reason": "A String", # A short error code that summarizes the error. }, - "replicationIntervalMs": "A String", # Required. Specifies the interval at which the source table is polled for updates. + "replicationIntervalMs": "A String", # Optional. Specifies the interval at which the source table is polled for updates. It's Optional. If not specified, default replication interval would be applied. "replicationStatus": "A String", # Optional. Output only. Replication status of configured replication. "sourceTable": { # Required. Source table reference that is replicated. "datasetId": "A String", # Required. The ID of the dataset containing this table. @@ -1898,6 +1920,12 @@

Method Details

}, "type": "A String", # Output only. Describes the table type. The following values are supported: * `TABLE`: A normal BigQuery table. * `VIEW`: A virtual table defined by a SQL query. * `EXTERNAL`: A table that references data stored in an external storage system, such as Google Cloud Storage. * `MATERIALIZED_VIEW`: A precomputed view defined by a SQL query. * `SNAPSHOT`: An immutable BigQuery table that preserves the contents of a base table at a particular time. See additional information on [table snapshots](/bigquery/docs/table-snapshots-intro). The default value is `TABLE`. "view": { # Describes the definition of a logical view. # Optional. The view definition. + "foreignDefinitions": [ # Optional. Foreign view representations. + { # A view can be represented in multiple ways. Each representation has its own dialect. This message stores the metadata required for these representations. + "dialect": "A String", # Optional. Represents the dialect of the query. + "query": "A String", # Required. The query that defines the view. + }, + ], "privacyPolicy": { # Represents privacy policy that contains the privacy requirements specified by the data owner. Currently, this is only supported on views. # Optional. Specifices the privacy policy for the view. "aggregationThresholdPolicy": { # Represents privacy policy associated with "aggregation threshold" method. # Optional. Policy used for aggregation thresholds. "privacyUnitColumns": [ # Optional. The privacy unit column(s) associated with this policy. For now, only one column per data source object (table, view) is allowed as a privacy unit column. Representing as a repeated field in metadata for extensibility to multiple columns in future. Duplicates and Repeated struct fields are not allowed. For nested fields, use dot notation ("outer.inner") @@ -2057,7 +2085,7 @@

Method Details

"parquetOptions": { # Parquet Options for load and make external tables. # Optional. Additional properties to set if sourceFormat is set to PARQUET. "enableListInference": True or False, # Optional. Indicates whether to use schema inference specifically for Parquet LIST logical type. "enumAsString": True or False, # Optional. Indicates whether to infer Parquet ENUM logical type as STRING instead of BYTES by default. - "mapTargetType": "A String", # Optional. Will indicate how to represent a parquet map if present. + "mapTargetType": "A String", # Optional. Indicates how to represent a Parquet map if present. }, "referenceFileSchemaUri": "A String", # Optional. When creating an external table, the user can provide a reference file with the table schema. This is enabled for the following formats: AVRO, PARQUET, ORC. "schema": { # Schema of a table # Optional. The schema for the data. Schema is required for CSV and JSON formats if autodetect is not on. Schema is disallowed for Google Cloud Bigtable, Cloud Datastore backups, Avro, ORC and Parquet formats. @@ -2165,6 +2193,7 @@

Method Details

"numActiveLogicalBytes": "A String", # Output only. Number of logical bytes that are less than 90 days old. "numActivePhysicalBytes": "A String", # Output only. Number of physical bytes less than 90 days old. This data is not kept in real time, and might be delayed by a few seconds to a few minutes. "numBytes": "A String", # Output only. The size of this table in logical bytes, excluding any data in the streaming buffer. + "numCurrentPhysicalBytes": "A String", # Output only. Number of physical bytes used by current live data storage. This data is not kept in real time, and might be delayed by a few seconds to a few minutes. "numLongTermBytes": "A String", # Output only. The number of logical bytes in the table that are considered "long-term storage". "numLongTermLogicalBytes": "A String", # Output only. Number of logical bytes that are more than 90 days old. "numLongTermPhysicalBytes": "A String", # Output only. Number of physical bytes more than 90 days old. This data is not kept in real time, and might be delayed by a few seconds to a few minutes. @@ -2182,7 +2211,7 @@

Method Details

], }, "rangePartitioning": { # If specified, configures range partitioning for this table. - "field": "A String", # Required. [Experimental] The table is partitioned by this field. The field must be a top-level NULLABLE/REQUIRED field. The only supported type is INTEGER/INT64. + "field": "A String", # Required. The name of the column to partition the table on. It must be a top-level, INT64 column whose mode is NULLABLE or REQUIRED. "range": { # [Experimental] Defines the ranges for range partitioning. "end": "A String", # [Experimental] The end of range partitioning, exclusive. "interval": "A String", # [Experimental] The width of each interval. @@ -2289,7 +2318,7 @@

Method Details

"message": "A String", # A human-readable description of the error. "reason": "A String", # A short error code that summarizes the error. }, - "replicationIntervalMs": "A String", # Required. Specifies the interval at which the source table is polled for updates. + "replicationIntervalMs": "A String", # Optional. Specifies the interval at which the source table is polled for updates. It's Optional. If not specified, default replication interval would be applied. "replicationStatus": "A String", # Optional. Output only. Replication status of configured replication. "sourceTable": { # Required. Source table reference that is replicated. "datasetId": "A String", # Required. The ID of the dataset containing this table. @@ -2305,6 +2334,12 @@

Method Details

}, "type": "A String", # Output only. Describes the table type. The following values are supported: * `TABLE`: A normal BigQuery table. * `VIEW`: A virtual table defined by a SQL query. * `EXTERNAL`: A table that references data stored in an external storage system, such as Google Cloud Storage. * `MATERIALIZED_VIEW`: A precomputed view defined by a SQL query. * `SNAPSHOT`: An immutable BigQuery table that preserves the contents of a base table at a particular time. See additional information on [table snapshots](/bigquery/docs/table-snapshots-intro). The default value is `TABLE`. "view": { # Describes the definition of a logical view. # Optional. The view definition. + "foreignDefinitions": [ # Optional. Foreign view representations. + { # A view can be represented in multiple ways. Each representation has its own dialect. This message stores the metadata required for these representations. + "dialect": "A String", # Optional. Represents the dialect of the query. + "query": "A String", # Required. The query that defines the view. + }, + ], "privacyPolicy": { # Represents privacy policy that contains the privacy requirements specified by the data owner. Currently, this is only supported on views. # Optional. Specifices the privacy policy for the view. "aggregationThresholdPolicy": { # Represents privacy policy associated with "aggregation threshold" method. # Optional. Policy used for aggregation thresholds. "privacyUnitColumns": [ # Optional. The privacy unit column(s) associated with this policy. For now, only one column per data source object (table, view) is allowed as a privacy unit column. Representing as a repeated field in metadata for extensibility to multiple columns in future. Duplicates and Repeated struct fields are not allowed. For nested fields, use dot notation ("outer.inner") @@ -2582,7 +2617,7 @@

Method Details

"parquetOptions": { # Parquet Options for load and make external tables. # Optional. Additional properties to set if sourceFormat is set to PARQUET. "enableListInference": True or False, # Optional. Indicates whether to use schema inference specifically for Parquet LIST logical type. "enumAsString": True or False, # Optional. Indicates whether to infer Parquet ENUM logical type as STRING instead of BYTES by default. - "mapTargetType": "A String", # Optional. Will indicate how to represent a parquet map if present. + "mapTargetType": "A String", # Optional. Indicates how to represent a Parquet map if present. }, "referenceFileSchemaUri": "A String", # Optional. When creating an external table, the user can provide a reference file with the table schema. This is enabled for the following formats: AVRO, PARQUET, ORC. "schema": { # Schema of a table # Optional. The schema for the data. Schema is required for CSV and JSON formats if autodetect is not on. Schema is disallowed for Google Cloud Bigtable, Cloud Datastore backups, Avro, ORC and Parquet formats. @@ -2690,6 +2725,7 @@

Method Details

"numActiveLogicalBytes": "A String", # Output only. Number of logical bytes that are less than 90 days old. "numActivePhysicalBytes": "A String", # Output only. Number of physical bytes less than 90 days old. This data is not kept in real time, and might be delayed by a few seconds to a few minutes. "numBytes": "A String", # Output only. The size of this table in logical bytes, excluding any data in the streaming buffer. + "numCurrentPhysicalBytes": "A String", # Output only. Number of physical bytes used by current live data storage. This data is not kept in real time, and might be delayed by a few seconds to a few minutes. "numLongTermBytes": "A String", # Output only. The number of logical bytes in the table that are considered "long-term storage". "numLongTermLogicalBytes": "A String", # Output only. Number of logical bytes that are more than 90 days old. "numLongTermPhysicalBytes": "A String", # Output only. Number of physical bytes more than 90 days old. This data is not kept in real time, and might be delayed by a few seconds to a few minutes. @@ -2707,7 +2743,7 @@

Method Details

], }, "rangePartitioning": { # If specified, configures range partitioning for this table. - "field": "A String", # Required. [Experimental] The table is partitioned by this field. The field must be a top-level NULLABLE/REQUIRED field. The only supported type is INTEGER/INT64. + "field": "A String", # Required. The name of the column to partition the table on. It must be a top-level, INT64 column whose mode is NULLABLE or REQUIRED. "range": { # [Experimental] Defines the ranges for range partitioning. "end": "A String", # [Experimental] The end of range partitioning, exclusive. "interval": "A String", # [Experimental] The width of each interval. @@ -2814,7 +2850,7 @@

Method Details

"message": "A String", # A human-readable description of the error. "reason": "A String", # A short error code that summarizes the error. }, - "replicationIntervalMs": "A String", # Required. Specifies the interval at which the source table is polled for updates. + "replicationIntervalMs": "A String", # Optional. Specifies the interval at which the source table is polled for updates. It's Optional. If not specified, default replication interval would be applied. "replicationStatus": "A String", # Optional. Output only. Replication status of configured replication. "sourceTable": { # Required. Source table reference that is replicated. "datasetId": "A String", # Required. The ID of the dataset containing this table. @@ -2830,6 +2866,12 @@

Method Details

}, "type": "A String", # Output only. Describes the table type. The following values are supported: * `TABLE`: A normal BigQuery table. * `VIEW`: A virtual table defined by a SQL query. * `EXTERNAL`: A table that references data stored in an external storage system, such as Google Cloud Storage. * `MATERIALIZED_VIEW`: A precomputed view defined by a SQL query. * `SNAPSHOT`: An immutable BigQuery table that preserves the contents of a base table at a particular time. See additional information on [table snapshots](/bigquery/docs/table-snapshots-intro). The default value is `TABLE`. "view": { # Describes the definition of a logical view. # Optional. The view definition. + "foreignDefinitions": [ # Optional. Foreign view representations. + { # A view can be represented in multiple ways. Each representation has its own dialect. This message stores the metadata required for these representations. + "dialect": "A String", # Optional. Represents the dialect of the query. + "query": "A String", # Required. The query that defines the view. + }, + ], "privacyPolicy": { # Represents privacy policy that contains the privacy requirements specified by the data owner. Currently, this is only supported on views. # Optional. Specifices the privacy policy for the view. "aggregationThresholdPolicy": { # Represents privacy policy associated with "aggregation threshold" method. # Optional. Policy used for aggregation thresholds. "privacyUnitColumns": [ # Optional. The privacy unit column(s) associated with this policy. For now, only one column per data source object (table, view) is allowed as a privacy unit column. Representing as a repeated field in metadata for extensibility to multiple columns in future. Duplicates and Repeated struct fields are not allowed. For nested fields, use dot notation ("outer.inner") @@ -2989,7 +3031,7 @@

Method Details

"parquetOptions": { # Parquet Options for load and make external tables. # Optional. Additional properties to set if sourceFormat is set to PARQUET. "enableListInference": True or False, # Optional. Indicates whether to use schema inference specifically for Parquet LIST logical type. "enumAsString": True or False, # Optional. Indicates whether to infer Parquet ENUM logical type as STRING instead of BYTES by default. - "mapTargetType": "A String", # Optional. Will indicate how to represent a parquet map if present. + "mapTargetType": "A String", # Optional. Indicates how to represent a Parquet map if present. }, "referenceFileSchemaUri": "A String", # Optional. When creating an external table, the user can provide a reference file with the table schema. This is enabled for the following formats: AVRO, PARQUET, ORC. "schema": { # Schema of a table # Optional. The schema for the data. Schema is required for CSV and JSON formats if autodetect is not on. Schema is disallowed for Google Cloud Bigtable, Cloud Datastore backups, Avro, ORC and Parquet formats. @@ -3097,6 +3139,7 @@

Method Details

"numActiveLogicalBytes": "A String", # Output only. Number of logical bytes that are less than 90 days old. "numActivePhysicalBytes": "A String", # Output only. Number of physical bytes less than 90 days old. This data is not kept in real time, and might be delayed by a few seconds to a few minutes. "numBytes": "A String", # Output only. The size of this table in logical bytes, excluding any data in the streaming buffer. + "numCurrentPhysicalBytes": "A String", # Output only. Number of physical bytes used by current live data storage. This data is not kept in real time, and might be delayed by a few seconds to a few minutes. "numLongTermBytes": "A String", # Output only. The number of logical bytes in the table that are considered "long-term storage". "numLongTermLogicalBytes": "A String", # Output only. Number of logical bytes that are more than 90 days old. "numLongTermPhysicalBytes": "A String", # Output only. Number of physical bytes more than 90 days old. This data is not kept in real time, and might be delayed by a few seconds to a few minutes. @@ -3114,7 +3157,7 @@

Method Details

], }, "rangePartitioning": { # If specified, configures range partitioning for this table. - "field": "A String", # Required. [Experimental] The table is partitioned by this field. The field must be a top-level NULLABLE/REQUIRED field. The only supported type is INTEGER/INT64. + "field": "A String", # Required. The name of the column to partition the table on. It must be a top-level, INT64 column whose mode is NULLABLE or REQUIRED. "range": { # [Experimental] Defines the ranges for range partitioning. "end": "A String", # [Experimental] The end of range partitioning, exclusive. "interval": "A String", # [Experimental] The width of each interval. @@ -3221,7 +3264,7 @@

Method Details

"message": "A String", # A human-readable description of the error. "reason": "A String", # A short error code that summarizes the error. }, - "replicationIntervalMs": "A String", # Required. Specifies the interval at which the source table is polled for updates. + "replicationIntervalMs": "A String", # Optional. Specifies the interval at which the source table is polled for updates. It's Optional. If not specified, default replication interval would be applied. "replicationStatus": "A String", # Optional. Output only. Replication status of configured replication. "sourceTable": { # Required. Source table reference that is replicated. "datasetId": "A String", # Required. The ID of the dataset containing this table. @@ -3237,6 +3280,12 @@

Method Details

}, "type": "A String", # Output only. Describes the table type. The following values are supported: * `TABLE`: A normal BigQuery table. * `VIEW`: A virtual table defined by a SQL query. * `EXTERNAL`: A table that references data stored in an external storage system, such as Google Cloud Storage. * `MATERIALIZED_VIEW`: A precomputed view defined by a SQL query. * `SNAPSHOT`: An immutable BigQuery table that preserves the contents of a base table at a particular time. See additional information on [table snapshots](/bigquery/docs/table-snapshots-intro). The default value is `TABLE`. "view": { # Describes the definition of a logical view. # Optional. The view definition. + "foreignDefinitions": [ # Optional. Foreign view representations. + { # A view can be represented in multiple ways. Each representation has its own dialect. This message stores the metadata required for these representations. + "dialect": "A String", # Optional. Represents the dialect of the query. + "query": "A String", # Required. The query that defines the view. + }, + ], "privacyPolicy": { # Represents privacy policy that contains the privacy requirements specified by the data owner. Currently, this is only supported on views. # Optional. Specifices the privacy policy for the view. "aggregationThresholdPolicy": { # Represents privacy policy associated with "aggregation threshold" method. # Optional. Policy used for aggregation thresholds. "privacyUnitColumns": [ # Optional. The privacy unit column(s) associated with this policy. For now, only one column per data source object (table, view) is allowed as a privacy unit column. Representing as a repeated field in metadata for extensibility to multiple columns in future. Duplicates and Repeated struct fields are not allowed. For nested fields, use dot notation ("outer.inner") diff --git a/docs/dyn/bigqueryconnection_v1.projects.locations.connections.html b/docs/dyn/bigqueryconnection_v1.projects.locations.connections.html index b978485eb1a..0f8188301f8 100644 --- a/docs/dyn/bigqueryconnection_v1.projects.locations.connections.html +++ b/docs/dyn/bigqueryconnection_v1.projects.locations.connections.html @@ -157,11 +157,12 @@

Method Details

"type": "A String", # Type of the Cloud SQL database. }, "configuration": { # Represents concrete parameter values for Connector Configuration. # Optional. Connector configuration. - "asset": { # Data Asset - a resource within instance of the system, reachable under specified endpoint. For example a database name in a SQL DB. # Optional. Data asset. - "database": "A String", # Optional. Name of the database. + "asset": { # Data Asset - a resource within instance of the system, reachable under specified endpoint. For example a database name in a SQL DB. # Data asset. + "database": "A String", # Name of the database. "googleCloudResource": "A String", # Full Google Cloud resource name - https://cloud.google.com/apis/design/resource_names#full_resource_name. Example: `//library.googleapis.com/shelves/shelf1/books/book2` }, "authentication": { # Client authentication. # Client authentication. + "serviceAccount": "A String", # Output only. Google-managed service account associated with this connection, e.g., `service-{project_number}@gcp-sa-bigqueryconnection.iam.gserviceaccount.com`. BigQuery jobs using this connection will act as `service_account` identity while connecting to the datasource. "usernamePassword": { # Username and Password authentication. # Username/password authentication. "password": { # Secret value parameter. # Required. Password. "plaintext": "A String", # Input only. Secret as plaintext. @@ -250,11 +251,12 @@

Method Details

"type": "A String", # Type of the Cloud SQL database. }, "configuration": { # Represents concrete parameter values for Connector Configuration. # Optional. Connector configuration. - "asset": { # Data Asset - a resource within instance of the system, reachable under specified endpoint. For example a database name in a SQL DB. # Optional. Data asset. - "database": "A String", # Optional. Name of the database. + "asset": { # Data Asset - a resource within instance of the system, reachable under specified endpoint. For example a database name in a SQL DB. # Data asset. + "database": "A String", # Name of the database. "googleCloudResource": "A String", # Full Google Cloud resource name - https://cloud.google.com/apis/design/resource_names#full_resource_name. Example: `//library.googleapis.com/shelves/shelf1/books/book2` }, "authentication": { # Client authentication. # Client authentication. + "serviceAccount": "A String", # Output only. Google-managed service account associated with this connection, e.g., `service-{project_number}@gcp-sa-bigqueryconnection.iam.gserviceaccount.com`. BigQuery jobs using this connection will act as `service_account` identity while connecting to the datasource. "usernamePassword": { # Username and Password authentication. # Username/password authentication. "password": { # Secret value parameter. # Required. Password. "plaintext": "A String", # Input only. Secret as plaintext. @@ -367,11 +369,12 @@

Method Details

"type": "A String", # Type of the Cloud SQL database. }, "configuration": { # Represents concrete parameter values for Connector Configuration. # Optional. Connector configuration. - "asset": { # Data Asset - a resource within instance of the system, reachable under specified endpoint. For example a database name in a SQL DB. # Optional. Data asset. - "database": "A String", # Optional. Name of the database. + "asset": { # Data Asset - a resource within instance of the system, reachable under specified endpoint. For example a database name in a SQL DB. # Data asset. + "database": "A String", # Name of the database. "googleCloudResource": "A String", # Full Google Cloud resource name - https://cloud.google.com/apis/design/resource_names#full_resource_name. Example: `//library.googleapis.com/shelves/shelf1/books/book2` }, "authentication": { # Client authentication. # Client authentication. + "serviceAccount": "A String", # Output only. Google-managed service account associated with this connection, e.g., `service-{project_number}@gcp-sa-bigqueryconnection.iam.gserviceaccount.com`. BigQuery jobs using this connection will act as `service_account` identity while connecting to the datasource. "usernamePassword": { # Username and Password authentication. # Username/password authentication. "password": { # Secret value parameter. # Required. Password. "plaintext": "A String", # Input only. Secret as plaintext. @@ -526,11 +529,12 @@

Method Details

"type": "A String", # Type of the Cloud SQL database. }, "configuration": { # Represents concrete parameter values for Connector Configuration. # Optional. Connector configuration. - "asset": { # Data Asset - a resource within instance of the system, reachable under specified endpoint. For example a database name in a SQL DB. # Optional. Data asset. - "database": "A String", # Optional. Name of the database. + "asset": { # Data Asset - a resource within instance of the system, reachable under specified endpoint. For example a database name in a SQL DB. # Data asset. + "database": "A String", # Name of the database. "googleCloudResource": "A String", # Full Google Cloud resource name - https://cloud.google.com/apis/design/resource_names#full_resource_name. Example: `//library.googleapis.com/shelves/shelf1/books/book2` }, "authentication": { # Client authentication. # Client authentication. + "serviceAccount": "A String", # Output only. Google-managed service account associated with this connection, e.g., `service-{project_number}@gcp-sa-bigqueryconnection.iam.gserviceaccount.com`. BigQuery jobs using this connection will act as `service_account` identity while connecting to the datasource. "usernamePassword": { # Username and Password authentication. # Username/password authentication. "password": { # Secret value parameter. # Required. Password. "plaintext": "A String", # Input only. Secret as plaintext. @@ -637,11 +641,12 @@

Method Details

"type": "A String", # Type of the Cloud SQL database. }, "configuration": { # Represents concrete parameter values for Connector Configuration. # Optional. Connector configuration. - "asset": { # Data Asset - a resource within instance of the system, reachable under specified endpoint. For example a database name in a SQL DB. # Optional. Data asset. - "database": "A String", # Optional. Name of the database. + "asset": { # Data Asset - a resource within instance of the system, reachable under specified endpoint. For example a database name in a SQL DB. # Data asset. + "database": "A String", # Name of the database. "googleCloudResource": "A String", # Full Google Cloud resource name - https://cloud.google.com/apis/design/resource_names#full_resource_name. Example: `//library.googleapis.com/shelves/shelf1/books/book2` }, "authentication": { # Client authentication. # Client authentication. + "serviceAccount": "A String", # Output only. Google-managed service account associated with this connection, e.g., `service-{project_number}@gcp-sa-bigqueryconnection.iam.gserviceaccount.com`. BigQuery jobs using this connection will act as `service_account` identity while connecting to the datasource. "usernamePassword": { # Username and Password authentication. # Username/password authentication. "password": { # Secret value parameter. # Required. Password. "plaintext": "A String", # Input only. Secret as plaintext. @@ -730,11 +735,12 @@

Method Details

"type": "A String", # Type of the Cloud SQL database. }, "configuration": { # Represents concrete parameter values for Connector Configuration. # Optional. Connector configuration. - "asset": { # Data Asset - a resource within instance of the system, reachable under specified endpoint. For example a database name in a SQL DB. # Optional. Data asset. - "database": "A String", # Optional. Name of the database. + "asset": { # Data Asset - a resource within instance of the system, reachable under specified endpoint. For example a database name in a SQL DB. # Data asset. + "database": "A String", # Name of the database. "googleCloudResource": "A String", # Full Google Cloud resource name - https://cloud.google.com/apis/design/resource_names#full_resource_name. Example: `//library.googleapis.com/shelves/shelf1/books/book2` }, "authentication": { # Client authentication. # Client authentication. + "serviceAccount": "A String", # Output only. Google-managed service account associated with this connection, e.g., `service-{project_number}@gcp-sa-bigqueryconnection.iam.gserviceaccount.com`. BigQuery jobs using this connection will act as `service_account` identity while connecting to the datasource. "usernamePassword": { # Username and Password authentication. # Username/password authentication. "password": { # Secret value parameter. # Required. Password. "plaintext": "A String", # Input only. Secret as plaintext. diff --git a/docs/dyn/bigtableadmin_v2.projects.instances.tables.html b/docs/dyn/bigtableadmin_v2.projects.instances.tables.html index 3d59b6eb4d3..f9ce9a29f6b 100644 --- a/docs/dyn/bigtableadmin_v2.projects.instances.tables.html +++ b/docs/dyn/bigtableadmin_v2.projects.instances.tables.html @@ -227,7 +227,7 @@

Method Details

"averageColumnsPerRow": 3.14, # How many column qualifiers are present in this column family, averaged over all rows in the table. e.g. For column family "family" in a table with 3 rows: * A row with cells in "family:col" and "other:col" (1 column in "family") * A row with cells in "family:col", "family:other_col", and "other:data" (2 columns in "family") * A row with cells in "other:col" (0 columns in "family", "family" not present) would report (1 + 2 + 0)/3 = 1.5 in this field. "logicalDataBytes": "A String", # How much space the data in the column family occupies. This is roughly how many bytes would be needed to read the contents of the entire column family (e.g. by streaming all contents out). }, - "valueType": { # `Type` represents the type of data that is written to, read from, or stored in Bigtable. It is heavily based on the GoogleSQL standard to help maintain familiarity and consistency across products and features. For compatibility with Bigtable's existing untyped APIs, each `Type` includes an `Encoding` which describes how to convert to/from the underlying data. This might involve composing a series of steps into an "encoding chain," for example to convert from INT64 -> STRING -> raw bytes. In most cases, a "link" in the encoding chain will be based an on existing GoogleSQL conversion function like `CAST`. Each link in the encoding chain also defines the following properties: * Natural sort: Does the encoded value sort consistently with the original typed value? Note that Bigtable will always sort data based on the raw encoded value, *not* the decoded type. - Example: STRING values sort in the same order as their UTF-8 encodings. - Counterexample: Encoding INT64 to a fixed-width STRING does *not* preserve sort order when dealing with negative numbers. INT64(1) > INT64(-1), but STRING("-00001") > STRING("00001). - The overall encoding chain sorts naturally if *every* link does. * Self-delimiting: If we concatenate two encoded values, can we always tell where the first one ends and the second one begins? - Example: If we encode INT64s to fixed-width STRINGs, the first value will always contain exactly N digits, possibly preceded by a sign. - Counterexample: If we concatenate two UTF-8 encoded STRINGs, we have no way to tell where the first one ends. - The overall encoding chain is self-delimiting if *any* link is. * Compatibility: Which other systems have matching encoding schemes? For example, does this encoding have a GoogleSQL equivalent? HBase? Java? # The type of data stored in each of this family's cell values, including its full encoding. If omitted, the family only serves raw untyped bytes. For now, only the `Aggregate` type is supported. `Aggregate` can only be set at family creation and is immutable afterwards. If `value_type` is `Aggregate`, written data must be compatible with: * `value_type.input_type` for `AddInput` mutations + "valueType": { # `Type` represents the type of data that is written to, read from, or stored in Bigtable. It is heavily based on the GoogleSQL standard to help maintain familiarity and consistency across products and features. For compatibility with Bigtable's existing untyped APIs, each `Type` includes an `Encoding` which describes how to convert to/from the underlying data. This might involve composing a series of steps into an "encoding chain," for example to convert from INT64 -> STRING -> raw bytes. In most cases, a "link" in the encoding chain will be based an on existing GoogleSQL conversion function like `CAST`. Each link in the encoding chain also defines the following properties: * Natural sort: Does the encoded value sort consistently with the original typed value? Note that Bigtable will always sort data based on the raw encoded value, *not* the decoded type. - Example: BYTES values sort in the same order as their raw encodings. - Counterexample: Encoding INT64 to a fixed-width STRING does *not* preserve sort order when dealing with negative numbers. INT64(1) > INT64(-1), but STRING("-00001") > STRING("00001). - The overall encoding chain has this property if *every* link does. * Self-delimiting: If we concatenate two encoded values, can we always tell where the first one ends and the second one begins? - Example: If we encode INT64s to fixed-width STRINGs, the first value will always contain exactly N digits, possibly preceded by a sign. - Counterexample: If we concatenate two UTF-8 encoded STRINGs, we have no way to tell where the first one ends. - The overall encoding chain has this property if *any* link does. * Compatibility: Which other systems have matching encoding schemes? For example, does this encoding have a GoogleSQL equivalent? HBase? Java? # The type of data stored in each of this family's cell values, including its full encoding. If omitted, the family only serves raw untyped bytes. For now, only the `Aggregate` type is supported. `Aggregate` can only be set at family creation and is immutable afterwards. If `value_type` is `Aggregate`, written data must be compatible with: * `value_type.input_type` for `AddInput` mutations "aggregateType": { # A value that combines incremental updates into a summarized value. Data is never directly written or read using type `Aggregate`. Writes will provide either the `input_type` or `state_type`, and reads will always return the `state_type` . # Aggregate "inputType": # Object with schema name: Type # Type of the inputs that are accumulated by this `Aggregate`, which must specify a full encoding. Use `AddInput` mutations to accumulate new inputs. "stateType": # Object with schema name: Type # Output only. Type that holds the internal accumulator state for the `Aggregate`. This is a function of the `input_type` and `aggregator` chosen, and will always specify a full encoding. @@ -335,7 +335,7 @@

Method Details

"averageColumnsPerRow": 3.14, # How many column qualifiers are present in this column family, averaged over all rows in the table. e.g. For column family "family" in a table with 3 rows: * A row with cells in "family:col" and "other:col" (1 column in "family") * A row with cells in "family:col", "family:other_col", and "other:data" (2 columns in "family") * A row with cells in "other:col" (0 columns in "family", "family" not present) would report (1 + 2 + 0)/3 = 1.5 in this field. "logicalDataBytes": "A String", # How much space the data in the column family occupies. This is roughly how many bytes would be needed to read the contents of the entire column family (e.g. by streaming all contents out). }, - "valueType": { # `Type` represents the type of data that is written to, read from, or stored in Bigtable. It is heavily based on the GoogleSQL standard to help maintain familiarity and consistency across products and features. For compatibility with Bigtable's existing untyped APIs, each `Type` includes an `Encoding` which describes how to convert to/from the underlying data. This might involve composing a series of steps into an "encoding chain," for example to convert from INT64 -> STRING -> raw bytes. In most cases, a "link" in the encoding chain will be based an on existing GoogleSQL conversion function like `CAST`. Each link in the encoding chain also defines the following properties: * Natural sort: Does the encoded value sort consistently with the original typed value? Note that Bigtable will always sort data based on the raw encoded value, *not* the decoded type. - Example: STRING values sort in the same order as their UTF-8 encodings. - Counterexample: Encoding INT64 to a fixed-width STRING does *not* preserve sort order when dealing with negative numbers. INT64(1) > INT64(-1), but STRING("-00001") > STRING("00001). - The overall encoding chain sorts naturally if *every* link does. * Self-delimiting: If we concatenate two encoded values, can we always tell where the first one ends and the second one begins? - Example: If we encode INT64s to fixed-width STRINGs, the first value will always contain exactly N digits, possibly preceded by a sign. - Counterexample: If we concatenate two UTF-8 encoded STRINGs, we have no way to tell where the first one ends. - The overall encoding chain is self-delimiting if *any* link is. * Compatibility: Which other systems have matching encoding schemes? For example, does this encoding have a GoogleSQL equivalent? HBase? Java? # The type of data stored in each of this family's cell values, including its full encoding. If omitted, the family only serves raw untyped bytes. For now, only the `Aggregate` type is supported. `Aggregate` can only be set at family creation and is immutable afterwards. If `value_type` is `Aggregate`, written data must be compatible with: * `value_type.input_type` for `AddInput` mutations + "valueType": { # `Type` represents the type of data that is written to, read from, or stored in Bigtable. It is heavily based on the GoogleSQL standard to help maintain familiarity and consistency across products and features. For compatibility with Bigtable's existing untyped APIs, each `Type` includes an `Encoding` which describes how to convert to/from the underlying data. This might involve composing a series of steps into an "encoding chain," for example to convert from INT64 -> STRING -> raw bytes. In most cases, a "link" in the encoding chain will be based an on existing GoogleSQL conversion function like `CAST`. Each link in the encoding chain also defines the following properties: * Natural sort: Does the encoded value sort consistently with the original typed value? Note that Bigtable will always sort data based on the raw encoded value, *not* the decoded type. - Example: BYTES values sort in the same order as their raw encodings. - Counterexample: Encoding INT64 to a fixed-width STRING does *not* preserve sort order when dealing with negative numbers. INT64(1) > INT64(-1), but STRING("-00001") > STRING("00001). - The overall encoding chain has this property if *every* link does. * Self-delimiting: If we concatenate two encoded values, can we always tell where the first one ends and the second one begins? - Example: If we encode INT64s to fixed-width STRINGs, the first value will always contain exactly N digits, possibly preceded by a sign. - Counterexample: If we concatenate two UTF-8 encoded STRINGs, we have no way to tell where the first one ends. - The overall encoding chain has this property if *any* link does. * Compatibility: Which other systems have matching encoding schemes? For example, does this encoding have a GoogleSQL equivalent? HBase? Java? # The type of data stored in each of this family's cell values, including its full encoding. If omitted, the family only serves raw untyped bytes. For now, only the `Aggregate` type is supported. `Aggregate` can only be set at family creation and is immutable afterwards. If `value_type` is `Aggregate`, written data must be compatible with: * `value_type.input_type` for `AddInput` mutations "aggregateType": { # A value that combines incremental updates into a summarized value. Data is never directly written or read using type `Aggregate`. Writes will provide either the `input_type` or `state_type`, and reads will always return the `state_type` . # Aggregate "inputType": # Object with schema name: Type # Type of the inputs that are accumulated by this `Aggregate`, which must specify a full encoding. Use `AddInput` mutations to accumulate new inputs. "stateType": # Object with schema name: Type # Output only. Type that holds the internal accumulator state for the `Aggregate`. This is a function of the `input_type` and `aggregator` chosen, and will always specify a full encoding. @@ -526,7 +526,7 @@

Method Details

"averageColumnsPerRow": 3.14, # How many column qualifiers are present in this column family, averaged over all rows in the table. e.g. For column family "family" in a table with 3 rows: * A row with cells in "family:col" and "other:col" (1 column in "family") * A row with cells in "family:col", "family:other_col", and "other:data" (2 columns in "family") * A row with cells in "other:col" (0 columns in "family", "family" not present) would report (1 + 2 + 0)/3 = 1.5 in this field. "logicalDataBytes": "A String", # How much space the data in the column family occupies. This is roughly how many bytes would be needed to read the contents of the entire column family (e.g. by streaming all contents out). }, - "valueType": { # `Type` represents the type of data that is written to, read from, or stored in Bigtable. It is heavily based on the GoogleSQL standard to help maintain familiarity and consistency across products and features. For compatibility with Bigtable's existing untyped APIs, each `Type` includes an `Encoding` which describes how to convert to/from the underlying data. This might involve composing a series of steps into an "encoding chain," for example to convert from INT64 -> STRING -> raw bytes. In most cases, a "link" in the encoding chain will be based an on existing GoogleSQL conversion function like `CAST`. Each link in the encoding chain also defines the following properties: * Natural sort: Does the encoded value sort consistently with the original typed value? Note that Bigtable will always sort data based on the raw encoded value, *not* the decoded type. - Example: STRING values sort in the same order as their UTF-8 encodings. - Counterexample: Encoding INT64 to a fixed-width STRING does *not* preserve sort order when dealing with negative numbers. INT64(1) > INT64(-1), but STRING("-00001") > STRING("00001). - The overall encoding chain sorts naturally if *every* link does. * Self-delimiting: If we concatenate two encoded values, can we always tell where the first one ends and the second one begins? - Example: If we encode INT64s to fixed-width STRINGs, the first value will always contain exactly N digits, possibly preceded by a sign. - Counterexample: If we concatenate two UTF-8 encoded STRINGs, we have no way to tell where the first one ends. - The overall encoding chain is self-delimiting if *any* link is. * Compatibility: Which other systems have matching encoding schemes? For example, does this encoding have a GoogleSQL equivalent? HBase? Java? # The type of data stored in each of this family's cell values, including its full encoding. If omitted, the family only serves raw untyped bytes. For now, only the `Aggregate` type is supported. `Aggregate` can only be set at family creation and is immutable afterwards. If `value_type` is `Aggregate`, written data must be compatible with: * `value_type.input_type` for `AddInput` mutations + "valueType": { # `Type` represents the type of data that is written to, read from, or stored in Bigtable. It is heavily based on the GoogleSQL standard to help maintain familiarity and consistency across products and features. For compatibility with Bigtable's existing untyped APIs, each `Type` includes an `Encoding` which describes how to convert to/from the underlying data. This might involve composing a series of steps into an "encoding chain," for example to convert from INT64 -> STRING -> raw bytes. In most cases, a "link" in the encoding chain will be based an on existing GoogleSQL conversion function like `CAST`. Each link in the encoding chain also defines the following properties: * Natural sort: Does the encoded value sort consistently with the original typed value? Note that Bigtable will always sort data based on the raw encoded value, *not* the decoded type. - Example: BYTES values sort in the same order as their raw encodings. - Counterexample: Encoding INT64 to a fixed-width STRING does *not* preserve sort order when dealing with negative numbers. INT64(1) > INT64(-1), but STRING("-00001") > STRING("00001). - The overall encoding chain has this property if *every* link does. * Self-delimiting: If we concatenate two encoded values, can we always tell where the first one ends and the second one begins? - Example: If we encode INT64s to fixed-width STRINGs, the first value will always contain exactly N digits, possibly preceded by a sign. - Counterexample: If we concatenate two UTF-8 encoded STRINGs, we have no way to tell where the first one ends. - The overall encoding chain has this property if *any* link does. * Compatibility: Which other systems have matching encoding schemes? For example, does this encoding have a GoogleSQL equivalent? HBase? Java? # The type of data stored in each of this family's cell values, including its full encoding. If omitted, the family only serves raw untyped bytes. For now, only the `Aggregate` type is supported. `Aggregate` can only be set at family creation and is immutable afterwards. If `value_type` is `Aggregate`, written data must be compatible with: * `value_type.input_type` for `AddInput` mutations "aggregateType": { # A value that combines incremental updates into a summarized value. Data is never directly written or read using type `Aggregate`. Writes will provide either the `input_type` or `state_type`, and reads will always return the `state_type` . # Aggregate "inputType": # Object with schema name: Type # Type of the inputs that are accumulated by this `Aggregate`, which must specify a full encoding. Use `AddInput` mutations to accumulate new inputs. "stateType": # Object with schema name: Type # Output only. Type that holds the internal accumulator state for the `Aggregate`. This is a function of the `input_type` and `aggregator` chosen, and will always specify a full encoding. @@ -709,7 +709,7 @@

Method Details

"averageColumnsPerRow": 3.14, # How many column qualifiers are present in this column family, averaged over all rows in the table. e.g. For column family "family" in a table with 3 rows: * A row with cells in "family:col" and "other:col" (1 column in "family") * A row with cells in "family:col", "family:other_col", and "other:data" (2 columns in "family") * A row with cells in "other:col" (0 columns in "family", "family" not present) would report (1 + 2 + 0)/3 = 1.5 in this field. "logicalDataBytes": "A String", # How much space the data in the column family occupies. This is roughly how many bytes would be needed to read the contents of the entire column family (e.g. by streaming all contents out). }, - "valueType": { # `Type` represents the type of data that is written to, read from, or stored in Bigtable. It is heavily based on the GoogleSQL standard to help maintain familiarity and consistency across products and features. For compatibility with Bigtable's existing untyped APIs, each `Type` includes an `Encoding` which describes how to convert to/from the underlying data. This might involve composing a series of steps into an "encoding chain," for example to convert from INT64 -> STRING -> raw bytes. In most cases, a "link" in the encoding chain will be based an on existing GoogleSQL conversion function like `CAST`. Each link in the encoding chain also defines the following properties: * Natural sort: Does the encoded value sort consistently with the original typed value? Note that Bigtable will always sort data based on the raw encoded value, *not* the decoded type. - Example: STRING values sort in the same order as their UTF-8 encodings. - Counterexample: Encoding INT64 to a fixed-width STRING does *not* preserve sort order when dealing with negative numbers. INT64(1) > INT64(-1), but STRING("-00001") > STRING("00001). - The overall encoding chain sorts naturally if *every* link does. * Self-delimiting: If we concatenate two encoded values, can we always tell where the first one ends and the second one begins? - Example: If we encode INT64s to fixed-width STRINGs, the first value will always contain exactly N digits, possibly preceded by a sign. - Counterexample: If we concatenate two UTF-8 encoded STRINGs, we have no way to tell where the first one ends. - The overall encoding chain is self-delimiting if *any* link is. * Compatibility: Which other systems have matching encoding schemes? For example, does this encoding have a GoogleSQL equivalent? HBase? Java? # The type of data stored in each of this family's cell values, including its full encoding. If omitted, the family only serves raw untyped bytes. For now, only the `Aggregate` type is supported. `Aggregate` can only be set at family creation and is immutable afterwards. If `value_type` is `Aggregate`, written data must be compatible with: * `value_type.input_type` for `AddInput` mutations + "valueType": { # `Type` represents the type of data that is written to, read from, or stored in Bigtable. It is heavily based on the GoogleSQL standard to help maintain familiarity and consistency across products and features. For compatibility with Bigtable's existing untyped APIs, each `Type` includes an `Encoding` which describes how to convert to/from the underlying data. This might involve composing a series of steps into an "encoding chain," for example to convert from INT64 -> STRING -> raw bytes. In most cases, a "link" in the encoding chain will be based an on existing GoogleSQL conversion function like `CAST`. Each link in the encoding chain also defines the following properties: * Natural sort: Does the encoded value sort consistently with the original typed value? Note that Bigtable will always sort data based on the raw encoded value, *not* the decoded type. - Example: BYTES values sort in the same order as their raw encodings. - Counterexample: Encoding INT64 to a fixed-width STRING does *not* preserve sort order when dealing with negative numbers. INT64(1) > INT64(-1), but STRING("-00001") > STRING("00001). - The overall encoding chain has this property if *every* link does. * Self-delimiting: If we concatenate two encoded values, can we always tell where the first one ends and the second one begins? - Example: If we encode INT64s to fixed-width STRINGs, the first value will always contain exactly N digits, possibly preceded by a sign. - Counterexample: If we concatenate two UTF-8 encoded STRINGs, we have no way to tell where the first one ends. - The overall encoding chain has this property if *any* link does. * Compatibility: Which other systems have matching encoding schemes? For example, does this encoding have a GoogleSQL equivalent? HBase? Java? # The type of data stored in each of this family's cell values, including its full encoding. If omitted, the family only serves raw untyped bytes. For now, only the `Aggregate` type is supported. `Aggregate` can only be set at family creation and is immutable afterwards. If `value_type` is `Aggregate`, written data must be compatible with: * `value_type.input_type` for `AddInput` mutations "aggregateType": { # A value that combines incremental updates into a summarized value. Data is never directly written or read using type `Aggregate`. Writes will provide either the `input_type` or `state_type`, and reads will always return the `state_type` . # Aggregate "inputType": # Object with schema name: Type # Type of the inputs that are accumulated by this `Aggregate`, which must specify a full encoding. Use `AddInput` mutations to accumulate new inputs. "stateType": # Object with schema name: Type # Output only. Type that holds the internal accumulator state for the `Aggregate`. This is a function of the `input_type` and `aggregator` chosen, and will always specify a full encoding. @@ -808,7 +808,7 @@

Method Details

"averageColumnsPerRow": 3.14, # How many column qualifiers are present in this column family, averaged over all rows in the table. e.g. For column family "family" in a table with 3 rows: * A row with cells in "family:col" and "other:col" (1 column in "family") * A row with cells in "family:col", "family:other_col", and "other:data" (2 columns in "family") * A row with cells in "other:col" (0 columns in "family", "family" not present) would report (1 + 2 + 0)/3 = 1.5 in this field. "logicalDataBytes": "A String", # How much space the data in the column family occupies. This is roughly how many bytes would be needed to read the contents of the entire column family (e.g. by streaming all contents out). }, - "valueType": { # `Type` represents the type of data that is written to, read from, or stored in Bigtable. It is heavily based on the GoogleSQL standard to help maintain familiarity and consistency across products and features. For compatibility with Bigtable's existing untyped APIs, each `Type` includes an `Encoding` which describes how to convert to/from the underlying data. This might involve composing a series of steps into an "encoding chain," for example to convert from INT64 -> STRING -> raw bytes. In most cases, a "link" in the encoding chain will be based an on existing GoogleSQL conversion function like `CAST`. Each link in the encoding chain also defines the following properties: * Natural sort: Does the encoded value sort consistently with the original typed value? Note that Bigtable will always sort data based on the raw encoded value, *not* the decoded type. - Example: STRING values sort in the same order as their UTF-8 encodings. - Counterexample: Encoding INT64 to a fixed-width STRING does *not* preserve sort order when dealing with negative numbers. INT64(1) > INT64(-1), but STRING("-00001") > STRING("00001). - The overall encoding chain sorts naturally if *every* link does. * Self-delimiting: If we concatenate two encoded values, can we always tell where the first one ends and the second one begins? - Example: If we encode INT64s to fixed-width STRINGs, the first value will always contain exactly N digits, possibly preceded by a sign. - Counterexample: If we concatenate two UTF-8 encoded STRINGs, we have no way to tell where the first one ends. - The overall encoding chain is self-delimiting if *any* link is. * Compatibility: Which other systems have matching encoding schemes? For example, does this encoding have a GoogleSQL equivalent? HBase? Java? # The type of data stored in each of this family's cell values, including its full encoding. If omitted, the family only serves raw untyped bytes. For now, only the `Aggregate` type is supported. `Aggregate` can only be set at family creation and is immutable afterwards. If `value_type` is `Aggregate`, written data must be compatible with: * `value_type.input_type` for `AddInput` mutations + "valueType": { # `Type` represents the type of data that is written to, read from, or stored in Bigtable. It is heavily based on the GoogleSQL standard to help maintain familiarity and consistency across products and features. For compatibility with Bigtable's existing untyped APIs, each `Type` includes an `Encoding` which describes how to convert to/from the underlying data. This might involve composing a series of steps into an "encoding chain," for example to convert from INT64 -> STRING -> raw bytes. In most cases, a "link" in the encoding chain will be based an on existing GoogleSQL conversion function like `CAST`. Each link in the encoding chain also defines the following properties: * Natural sort: Does the encoded value sort consistently with the original typed value? Note that Bigtable will always sort data based on the raw encoded value, *not* the decoded type. - Example: BYTES values sort in the same order as their raw encodings. - Counterexample: Encoding INT64 to a fixed-width STRING does *not* preserve sort order when dealing with negative numbers. INT64(1) > INT64(-1), but STRING("-00001") > STRING("00001). - The overall encoding chain has this property if *every* link does. * Self-delimiting: If we concatenate two encoded values, can we always tell where the first one ends and the second one begins? - Example: If we encode INT64s to fixed-width STRINGs, the first value will always contain exactly N digits, possibly preceded by a sign. - Counterexample: If we concatenate two UTF-8 encoded STRINGs, we have no way to tell where the first one ends. - The overall encoding chain has this property if *any* link does. * Compatibility: Which other systems have matching encoding schemes? For example, does this encoding have a GoogleSQL equivalent? HBase? Java? # The type of data stored in each of this family's cell values, including its full encoding. If omitted, the family only serves raw untyped bytes. For now, only the `Aggregate` type is supported. `Aggregate` can only be set at family creation and is immutable afterwards. If `value_type` is `Aggregate`, written data must be compatible with: * `value_type.input_type` for `AddInput` mutations "aggregateType": { # A value that combines incremental updates into a summarized value. Data is never directly written or read using type `Aggregate`. Writes will provide either the `input_type` or `state_type`, and reads will always return the `state_type` . # Aggregate "inputType": # Object with schema name: Type # Type of the inputs that are accumulated by this `Aggregate`, which must specify a full encoding. Use `AddInput` mutations to accumulate new inputs. "stateType": # Object with schema name: Type # Output only. Type that holds the internal accumulator state for the `Aggregate`. This is a function of the `input_type` and `aggregator` chosen, and will always specify a full encoding. @@ -857,7 +857,7 @@

Method Details

"averageColumnsPerRow": 3.14, # How many column qualifiers are present in this column family, averaged over all rows in the table. e.g. For column family "family" in a table with 3 rows: * A row with cells in "family:col" and "other:col" (1 column in "family") * A row with cells in "family:col", "family:other_col", and "other:data" (2 columns in "family") * A row with cells in "other:col" (0 columns in "family", "family" not present) would report (1 + 2 + 0)/3 = 1.5 in this field. "logicalDataBytes": "A String", # How much space the data in the column family occupies. This is roughly how many bytes would be needed to read the contents of the entire column family (e.g. by streaming all contents out). }, - "valueType": { # `Type` represents the type of data that is written to, read from, or stored in Bigtable. It is heavily based on the GoogleSQL standard to help maintain familiarity and consistency across products and features. For compatibility with Bigtable's existing untyped APIs, each `Type` includes an `Encoding` which describes how to convert to/from the underlying data. This might involve composing a series of steps into an "encoding chain," for example to convert from INT64 -> STRING -> raw bytes. In most cases, a "link" in the encoding chain will be based an on existing GoogleSQL conversion function like `CAST`. Each link in the encoding chain also defines the following properties: * Natural sort: Does the encoded value sort consistently with the original typed value? Note that Bigtable will always sort data based on the raw encoded value, *not* the decoded type. - Example: STRING values sort in the same order as their UTF-8 encodings. - Counterexample: Encoding INT64 to a fixed-width STRING does *not* preserve sort order when dealing with negative numbers. INT64(1) > INT64(-1), but STRING("-00001") > STRING("00001). - The overall encoding chain sorts naturally if *every* link does. * Self-delimiting: If we concatenate two encoded values, can we always tell where the first one ends and the second one begins? - Example: If we encode INT64s to fixed-width STRINGs, the first value will always contain exactly N digits, possibly preceded by a sign. - Counterexample: If we concatenate two UTF-8 encoded STRINGs, we have no way to tell where the first one ends. - The overall encoding chain is self-delimiting if *any* link is. * Compatibility: Which other systems have matching encoding schemes? For example, does this encoding have a GoogleSQL equivalent? HBase? Java? # The type of data stored in each of this family's cell values, including its full encoding. If omitted, the family only serves raw untyped bytes. For now, only the `Aggregate` type is supported. `Aggregate` can only be set at family creation and is immutable afterwards. If `value_type` is `Aggregate`, written data must be compatible with: * `value_type.input_type` for `AddInput` mutations + "valueType": { # `Type` represents the type of data that is written to, read from, or stored in Bigtable. It is heavily based on the GoogleSQL standard to help maintain familiarity and consistency across products and features. For compatibility with Bigtable's existing untyped APIs, each `Type` includes an `Encoding` which describes how to convert to/from the underlying data. This might involve composing a series of steps into an "encoding chain," for example to convert from INT64 -> STRING -> raw bytes. In most cases, a "link" in the encoding chain will be based an on existing GoogleSQL conversion function like `CAST`. Each link in the encoding chain also defines the following properties: * Natural sort: Does the encoded value sort consistently with the original typed value? Note that Bigtable will always sort data based on the raw encoded value, *not* the decoded type. - Example: BYTES values sort in the same order as their raw encodings. - Counterexample: Encoding INT64 to a fixed-width STRING does *not* preserve sort order when dealing with negative numbers. INT64(1) > INT64(-1), but STRING("-00001") > STRING("00001). - The overall encoding chain has this property if *every* link does. * Self-delimiting: If we concatenate two encoded values, can we always tell where the first one ends and the second one begins? - Example: If we encode INT64s to fixed-width STRINGs, the first value will always contain exactly N digits, possibly preceded by a sign. - Counterexample: If we concatenate two UTF-8 encoded STRINGs, we have no way to tell where the first one ends. - The overall encoding chain has this property if *any* link does. * Compatibility: Which other systems have matching encoding schemes? For example, does this encoding have a GoogleSQL equivalent? HBase? Java? # The type of data stored in each of this family's cell values, including its full encoding. If omitted, the family only serves raw untyped bytes. For now, only the `Aggregate` type is supported. `Aggregate` can only be set at family creation and is immutable afterwards. If `value_type` is `Aggregate`, written data must be compatible with: * `value_type.input_type` for `AddInput` mutations "aggregateType": { # A value that combines incremental updates into a summarized value. Data is never directly written or read using type `Aggregate`. Writes will provide either the `input_type` or `state_type`, and reads will always return the `state_type` . # Aggregate "inputType": # Object with schema name: Type # Type of the inputs that are accumulated by this `Aggregate`, which must specify a full encoding. Use `AddInput` mutations to accumulate new inputs. "stateType": # Object with schema name: Type # Output only. Type that holds the internal accumulator state for the `Aggregate`. This is a function of the `input_type` and `aggregator` chosen, and will always specify a full encoding. @@ -946,7 +946,7 @@

Method Details

"averageColumnsPerRow": 3.14, # How many column qualifiers are present in this column family, averaged over all rows in the table. e.g. For column family "family" in a table with 3 rows: * A row with cells in "family:col" and "other:col" (1 column in "family") * A row with cells in "family:col", "family:other_col", and "other:data" (2 columns in "family") * A row with cells in "other:col" (0 columns in "family", "family" not present) would report (1 + 2 + 0)/3 = 1.5 in this field. "logicalDataBytes": "A String", # How much space the data in the column family occupies. This is roughly how many bytes would be needed to read the contents of the entire column family (e.g. by streaming all contents out). }, - "valueType": { # `Type` represents the type of data that is written to, read from, or stored in Bigtable. It is heavily based on the GoogleSQL standard to help maintain familiarity and consistency across products and features. For compatibility with Bigtable's existing untyped APIs, each `Type` includes an `Encoding` which describes how to convert to/from the underlying data. This might involve composing a series of steps into an "encoding chain," for example to convert from INT64 -> STRING -> raw bytes. In most cases, a "link" in the encoding chain will be based an on existing GoogleSQL conversion function like `CAST`. Each link in the encoding chain also defines the following properties: * Natural sort: Does the encoded value sort consistently with the original typed value? Note that Bigtable will always sort data based on the raw encoded value, *not* the decoded type. - Example: STRING values sort in the same order as their UTF-8 encodings. - Counterexample: Encoding INT64 to a fixed-width STRING does *not* preserve sort order when dealing with negative numbers. INT64(1) > INT64(-1), but STRING("-00001") > STRING("00001). - The overall encoding chain sorts naturally if *every* link does. * Self-delimiting: If we concatenate two encoded values, can we always tell where the first one ends and the second one begins? - Example: If we encode INT64s to fixed-width STRINGs, the first value will always contain exactly N digits, possibly preceded by a sign. - Counterexample: If we concatenate two UTF-8 encoded STRINGs, we have no way to tell where the first one ends. - The overall encoding chain is self-delimiting if *any* link is. * Compatibility: Which other systems have matching encoding schemes? For example, does this encoding have a GoogleSQL equivalent? HBase? Java? # The type of data stored in each of this family's cell values, including its full encoding. If omitted, the family only serves raw untyped bytes. For now, only the `Aggregate` type is supported. `Aggregate` can only be set at family creation and is immutable afterwards. If `value_type` is `Aggregate`, written data must be compatible with: * `value_type.input_type` for `AddInput` mutations + "valueType": { # `Type` represents the type of data that is written to, read from, or stored in Bigtable. It is heavily based on the GoogleSQL standard to help maintain familiarity and consistency across products and features. For compatibility with Bigtable's existing untyped APIs, each `Type` includes an `Encoding` which describes how to convert to/from the underlying data. This might involve composing a series of steps into an "encoding chain," for example to convert from INT64 -> STRING -> raw bytes. In most cases, a "link" in the encoding chain will be based an on existing GoogleSQL conversion function like `CAST`. Each link in the encoding chain also defines the following properties: * Natural sort: Does the encoded value sort consistently with the original typed value? Note that Bigtable will always sort data based on the raw encoded value, *not* the decoded type. - Example: BYTES values sort in the same order as their raw encodings. - Counterexample: Encoding INT64 to a fixed-width STRING does *not* preserve sort order when dealing with negative numbers. INT64(1) > INT64(-1), but STRING("-00001") > STRING("00001). - The overall encoding chain has this property if *every* link does. * Self-delimiting: If we concatenate two encoded values, can we always tell where the first one ends and the second one begins? - Example: If we encode INT64s to fixed-width STRINGs, the first value will always contain exactly N digits, possibly preceded by a sign. - Counterexample: If we concatenate two UTF-8 encoded STRINGs, we have no way to tell where the first one ends. - The overall encoding chain has this property if *any* link does. * Compatibility: Which other systems have matching encoding schemes? For example, does this encoding have a GoogleSQL equivalent? HBase? Java? # The type of data stored in each of this family's cell values, including its full encoding. If omitted, the family only serves raw untyped bytes. For now, only the `Aggregate` type is supported. `Aggregate` can only be set at family creation and is immutable afterwards. If `value_type` is `Aggregate`, written data must be compatible with: * `value_type.input_type` for `AddInput` mutations "aggregateType": { # A value that combines incremental updates into a summarized value. Data is never directly written or read using type `Aggregate`. Writes will provide either the `input_type` or `state_type`, and reads will always return the `state_type` . # Aggregate "inputType": # Object with schema name: Type # Type of the inputs that are accumulated by this `Aggregate`, which must specify a full encoding. Use `AddInput` mutations to accumulate new inputs. "stateType": # Object with schema name: Type # Output only. Type that holds the internal accumulator state for the `Aggregate`. This is a function of the `input_type` and `aggregator` chosen, and will always specify a full encoding. @@ -1054,7 +1054,7 @@

Method Details

"averageColumnsPerRow": 3.14, # How many column qualifiers are present in this column family, averaged over all rows in the table. e.g. For column family "family" in a table with 3 rows: * A row with cells in "family:col" and "other:col" (1 column in "family") * A row with cells in "family:col", "family:other_col", and "other:data" (2 columns in "family") * A row with cells in "other:col" (0 columns in "family", "family" not present) would report (1 + 2 + 0)/3 = 1.5 in this field. "logicalDataBytes": "A String", # How much space the data in the column family occupies. This is roughly how many bytes would be needed to read the contents of the entire column family (e.g. by streaming all contents out). }, - "valueType": { # `Type` represents the type of data that is written to, read from, or stored in Bigtable. It is heavily based on the GoogleSQL standard to help maintain familiarity and consistency across products and features. For compatibility with Bigtable's existing untyped APIs, each `Type` includes an `Encoding` which describes how to convert to/from the underlying data. This might involve composing a series of steps into an "encoding chain," for example to convert from INT64 -> STRING -> raw bytes. In most cases, a "link" in the encoding chain will be based an on existing GoogleSQL conversion function like `CAST`. Each link in the encoding chain also defines the following properties: * Natural sort: Does the encoded value sort consistently with the original typed value? Note that Bigtable will always sort data based on the raw encoded value, *not* the decoded type. - Example: STRING values sort in the same order as their UTF-8 encodings. - Counterexample: Encoding INT64 to a fixed-width STRING does *not* preserve sort order when dealing with negative numbers. INT64(1) > INT64(-1), but STRING("-00001") > STRING("00001). - The overall encoding chain sorts naturally if *every* link does. * Self-delimiting: If we concatenate two encoded values, can we always tell where the first one ends and the second one begins? - Example: If we encode INT64s to fixed-width STRINGs, the first value will always contain exactly N digits, possibly preceded by a sign. - Counterexample: If we concatenate two UTF-8 encoded STRINGs, we have no way to tell where the first one ends. - The overall encoding chain is self-delimiting if *any* link is. * Compatibility: Which other systems have matching encoding schemes? For example, does this encoding have a GoogleSQL equivalent? HBase? Java? # The type of data stored in each of this family's cell values, including its full encoding. If omitted, the family only serves raw untyped bytes. For now, only the `Aggregate` type is supported. `Aggregate` can only be set at family creation and is immutable afterwards. If `value_type` is `Aggregate`, written data must be compatible with: * `value_type.input_type` for `AddInput` mutations + "valueType": { # `Type` represents the type of data that is written to, read from, or stored in Bigtable. It is heavily based on the GoogleSQL standard to help maintain familiarity and consistency across products and features. For compatibility with Bigtable's existing untyped APIs, each `Type` includes an `Encoding` which describes how to convert to/from the underlying data. This might involve composing a series of steps into an "encoding chain," for example to convert from INT64 -> STRING -> raw bytes. In most cases, a "link" in the encoding chain will be based an on existing GoogleSQL conversion function like `CAST`. Each link in the encoding chain also defines the following properties: * Natural sort: Does the encoded value sort consistently with the original typed value? Note that Bigtable will always sort data based on the raw encoded value, *not* the decoded type. - Example: BYTES values sort in the same order as their raw encodings. - Counterexample: Encoding INT64 to a fixed-width STRING does *not* preserve sort order when dealing with negative numbers. INT64(1) > INT64(-1), but STRING("-00001") > STRING("00001). - The overall encoding chain has this property if *every* link does. * Self-delimiting: If we concatenate two encoded values, can we always tell where the first one ends and the second one begins? - Example: If we encode INT64s to fixed-width STRINGs, the first value will always contain exactly N digits, possibly preceded by a sign. - Counterexample: If we concatenate two UTF-8 encoded STRINGs, we have no way to tell where the first one ends. - The overall encoding chain has this property if *any* link does. * Compatibility: Which other systems have matching encoding schemes? For example, does this encoding have a GoogleSQL equivalent? HBase? Java? # The type of data stored in each of this family's cell values, including its full encoding. If omitted, the family only serves raw untyped bytes. For now, only the `Aggregate` type is supported. `Aggregate` can only be set at family creation and is immutable afterwards. If `value_type` is `Aggregate`, written data must be compatible with: * `value_type.input_type` for `AddInput` mutations "aggregateType": { # A value that combines incremental updates into a summarized value. Data is never directly written or read using type `Aggregate`. Writes will provide either the `input_type` or `state_type`, and reads will always return the `state_type` . # Aggregate "inputType": # Object with schema name: Type # Type of the inputs that are accumulated by this `Aggregate`, which must specify a full encoding. Use `AddInput` mutations to accumulate new inputs. "stateType": # Object with schema name: Type # Output only. Type that holds the internal accumulator state for the `Aggregate`. This is a function of the `input_type` and `aggregator` chosen, and will always specify a full encoding. diff --git a/docs/dyn/chat_v1.spaces.html b/docs/dyn/chat_v1.spaces.html index 8cf0d1a2507..bd826eea92e 100644 --- a/docs/dyn/chat_v1.spaces.html +++ b/docs/dyn/chat_v1.spaces.html @@ -109,7 +109,7 @@

Instance Methods

Returns details about a space. For an example, see [Get details about a space](https://developers.google.com/workspace/chat/get-spaces). Requires [authentication](https://developers.google.com/workspace/chat/authenticate-authorize). Supports [app authentication](https://developers.google.com/workspace/chat/authenticate-authorize-chat-app) and [user authentication](https://developers.google.com/workspace/chat/authenticate-authorize-chat-user).

list(filter=None, pageSize=None, pageToken=None, x__xgafv=None)

-

Lists spaces the caller is a member of. Group chats and DMs aren't listed until the first message is sent. For an example, see [List spaces](https://developers.google.com/workspace/chat/list-spaces). Requires [authentication](https://developers.google.com/workspace/chat/authenticate-authorize). Supports [app authentication](https://developers.google.com/workspace/chat/authenticate-authorize-chat-app) and [user authentication](https://developers.google.com/workspace/chat/authenticate-authorize-chat-user). Lists spaces visible to the caller or authenticated user. Group chats and DMs aren't listed until the first message is sent. To list all named spaces by Google Workspace organization, use the `spaces.search()` method using Workspace administrator privileges instead.

+

Lists spaces the caller is a member of. Group chats and DMs aren't listed until the first message is sent. For an example, see [List spaces](https://developers.google.com/workspace/chat/list-spaces). Requires [authentication](https://developers.google.com/workspace/chat/authenticate-authorize). Supports [app authentication](https://developers.google.com/workspace/chat/authenticate-authorize-chat-app) and [user authentication](https://developers.google.com/workspace/chat/authenticate-authorize-chat-user). Lists spaces visible to the caller or authenticated user. Group chats and DMs aren't listed until the first message is sent. To list all named spaces by Google Workspace organization, use the [`spaces.search()`](https://developers.google.com/workspace/chat/api/reference/rest/v1/spaces/search) method using Workspace administrator privileges instead.

list_next()

Retrieves the next page of results.

@@ -311,7 +311,7 @@

Method Details

list(filter=None, pageSize=None, pageToken=None, x__xgafv=None) -
Lists spaces the caller is a member of. Group chats and DMs aren't listed until the first message is sent. For an example, see [List spaces](https://developers.google.com/workspace/chat/list-spaces). Requires [authentication](https://developers.google.com/workspace/chat/authenticate-authorize). Supports [app authentication](https://developers.google.com/workspace/chat/authenticate-authorize-chat-app) and [user authentication](https://developers.google.com/workspace/chat/authenticate-authorize-chat-user). Lists spaces visible to the caller or authenticated user. Group chats and DMs aren't listed until the first message is sent. To list all named spaces by Google Workspace organization, use the `spaces.search()` method using Workspace administrator privileges instead.
+  
Lists spaces the caller is a member of. Group chats and DMs aren't listed until the first message is sent. For an example, see [List spaces](https://developers.google.com/workspace/chat/list-spaces). Requires [authentication](https://developers.google.com/workspace/chat/authenticate-authorize). Supports [app authentication](https://developers.google.com/workspace/chat/authenticate-authorize-chat-app) and [user authentication](https://developers.google.com/workspace/chat/authenticate-authorize-chat-user). Lists spaces visible to the caller or authenticated user. Group chats and DMs aren't listed until the first message is sent. To list all named spaces by Google Workspace organization, use the [`spaces.search()`](https://developers.google.com/workspace/chat/api/reference/rest/v1/spaces/search) method using Workspace administrator privileges instead.
 
 Args:
   filter: string, Optional. A query filter. You can filter spaces by the space type ([`space_type`](https://developers.google.com/workspace/chat/api/reference/rest/v1/spaces#spacetype)). To filter by space type, you must specify valid enum value, such as `SPACE` or `GROUP_CHAT` (the `space_type` can't be `SPACE_TYPE_UNSPECIFIED`). To query for multiple space types, use the `OR` operator. For example, the following queries are valid: ``` space_type = "SPACE" spaceType = "GROUP_CHAT" OR spaceType = "DIRECT_MESSAGE" ``` Invalid queries are rejected by the server with an `INVALID_ARGUMENT` error.
diff --git a/docs/dyn/clouddeploy_v1.projects.locations.deliveryPipelines.automationRuns.html b/docs/dyn/clouddeploy_v1.projects.locations.deliveryPipelines.automationRuns.html
index 0b5baaf5c0c..2affb8f6082 100644
--- a/docs/dyn/clouddeploy_v1.projects.locations.deliveryPipelines.automationRuns.html
+++ b/docs/dyn/clouddeploy_v1.projects.locations.deliveryPipelines.automationRuns.html
@@ -199,21 +199,6 @@ 

Method Details

"jobs": [ # Optional. Jobs to repair. Proceeds only after job name matched any one in the list, or for all jobs if unspecified or empty. The phase that includes the job must match the phase ID specified in `source_phase`. This value must consist of lower-case letters, numbers, and hyphens, start with a letter and end with a letter or a number, and have a max length of 63 characters. In other words, it must match the following regex: `^[a-z]([a-z0-9-]{0,61}[a-z0-9])?$`. "A String", ], - "repairModes": [ # Required. Defines the types of automatic repair actions for failed jobs. - { # Configuration of the repair action. - "retry": { # Retries the failed job. # Optional. Retries a failed job. - "attempts": "A String", # Required. Total number of retries. Retry is skipped if set to 0; The minimum value is 1, and the maximum value is 10. - "backoffMode": "A String", # Optional. The pattern of how wait time will be increased. Default is linear. Backoff mode will be ignored if `wait` is 0. - "wait": "A String", # Optional. How long to wait for the first retry. Default is 0, and the maximum value is 14d. - }, - "rollback": { # Rolls back a `Rollout`. # Optional. Rolls back a `Rollout`. - "destinationPhase": "A String", # Optional. The starting phase ID for the `Rollout`. If unspecified, the `Rollout` will start in the stable phase. - }, - }, - ], - "sourcePhases": [ # Optional. Phases within which jobs are subject to automatic repair actions on failure. Proceeds only after phase name matched any one in the list, or for all phases if unspecified. This value must consist of lower-case letters, numbers, and hyphens, start with a letter and end with a letter or a number, and have a max length of 63 characters. In other words, it must match the following regex: `^[a-z]([a-z0-9-]{0,61}[a-z0-9])?$`. - "A String", - ], }, }, ], @@ -243,11 +228,10 @@

Method Details

"wait": "A String", # Output only. How long the operation will be paused. }, "repairRolloutOperation": { # Contains the information for an automated `repair rollout` operation. # Output only. Repairs a failed 'Rollout'. - "currentRepairModeIndex": "A String", # Output only. The index of the current repair action in the repair sequence. "jobId": "A String", # Output only. The job ID for the Job to repair. "phaseId": "A String", # Output only. The phase ID of the phase that includes the job being repaired. "repairPhases": [ # Output only. Records of the repair attempts. Each repair phase may have multiple retry attempts or single rollback attempt. - { # RepairPhase tracks the repair attempts that have been made for each `RepairMode` specified in the `Automation` resource. + { # RepairPhase tracks the repair attempts that have been made for each `RepairPhaseConfig` specified in the `Automation` resource. "retry": { # RetryPhase contains the retry attempts and the metadata for initiating a new attempt. # Output only. Records of the retry attempts for retry repair mode. "attempts": [ # Output only. Detail of a retry action. { # RetryAttempt represents an action of retrying the failed Cloud Deploy job. @@ -258,8 +242,6 @@

Method Details

}, ], "backoffMode": "A String", # Output only. The pattern of how the wait time of the retry attempt is calculated. - "jobId": "A String", # Output only. The job ID for the Job to retry. - "phaseId": "A String", # Output only. The phase ID of the phase that includes the job being retried. "totalAttempts": "A String", # Output only. The number of attempts that have been made. }, "rollback": { # RollbackAttempt represents an action of rolling back a Cloud Deploy 'Target'. # Output only. Rollback attempt for rollback repair mode . @@ -368,21 +350,6 @@

Method Details

"jobs": [ # Optional. Jobs to repair. Proceeds only after job name matched any one in the list, or for all jobs if unspecified or empty. The phase that includes the job must match the phase ID specified in `source_phase`. This value must consist of lower-case letters, numbers, and hyphens, start with a letter and end with a letter or a number, and have a max length of 63 characters. In other words, it must match the following regex: `^[a-z]([a-z0-9-]{0,61}[a-z0-9])?$`. "A String", ], - "repairModes": [ # Required. Defines the types of automatic repair actions for failed jobs. - { # Configuration of the repair action. - "retry": { # Retries the failed job. # Optional. Retries a failed job. - "attempts": "A String", # Required. Total number of retries. Retry is skipped if set to 0; The minimum value is 1, and the maximum value is 10. - "backoffMode": "A String", # Optional. The pattern of how wait time will be increased. Default is linear. Backoff mode will be ignored if `wait` is 0. - "wait": "A String", # Optional. How long to wait for the first retry. Default is 0, and the maximum value is 14d. - }, - "rollback": { # Rolls back a `Rollout`. # Optional. Rolls back a `Rollout`. - "destinationPhase": "A String", # Optional. The starting phase ID for the `Rollout`. If unspecified, the `Rollout` will start in the stable phase. - }, - }, - ], - "sourcePhases": [ # Optional. Phases within which jobs are subject to automatic repair actions on failure. Proceeds only after phase name matched any one in the list, or for all phases if unspecified. This value must consist of lower-case letters, numbers, and hyphens, start with a letter and end with a letter or a number, and have a max length of 63 characters. In other words, it must match the following regex: `^[a-z]([a-z0-9-]{0,61}[a-z0-9])?$`. - "A String", - ], }, }, ], @@ -412,11 +379,10 @@

Method Details

"wait": "A String", # Output only. How long the operation will be paused. }, "repairRolloutOperation": { # Contains the information for an automated `repair rollout` operation. # Output only. Repairs a failed 'Rollout'. - "currentRepairModeIndex": "A String", # Output only. The index of the current repair action in the repair sequence. "jobId": "A String", # Output only. The job ID for the Job to repair. "phaseId": "A String", # Output only. The phase ID of the phase that includes the job being repaired. "repairPhases": [ # Output only. Records of the repair attempts. Each repair phase may have multiple retry attempts or single rollback attempt. - { # RepairPhase tracks the repair attempts that have been made for each `RepairMode` specified in the `Automation` resource. + { # RepairPhase tracks the repair attempts that have been made for each `RepairPhaseConfig` specified in the `Automation` resource. "retry": { # RetryPhase contains the retry attempts and the metadata for initiating a new attempt. # Output only. Records of the retry attempts for retry repair mode. "attempts": [ # Output only. Detail of a retry action. { # RetryAttempt represents an action of retrying the failed Cloud Deploy job. @@ -427,8 +393,6 @@

Method Details

}, ], "backoffMode": "A String", # Output only. The pattern of how the wait time of the retry attempt is calculated. - "jobId": "A String", # Output only. The job ID for the Job to retry. - "phaseId": "A String", # Output only. The phase ID of the phase that includes the job being retried. "totalAttempts": "A String", # Output only. The number of attempts that have been made. }, "rollback": { # RollbackAttempt represents an action of rolling back a Cloud Deploy 'Target'. # Output only. Rollback attempt for rollback repair mode . diff --git a/docs/dyn/clouddeploy_v1.projects.locations.deliveryPipelines.automations.html b/docs/dyn/clouddeploy_v1.projects.locations.deliveryPipelines.automations.html index 583ebee62f0..6500a0a5da7 100644 --- a/docs/dyn/clouddeploy_v1.projects.locations.deliveryPipelines.automations.html +++ b/docs/dyn/clouddeploy_v1.projects.locations.deliveryPipelines.automations.html @@ -168,21 +168,6 @@

Method Details

"jobs": [ # Optional. Jobs to repair. Proceeds only after job name matched any one in the list, or for all jobs if unspecified or empty. The phase that includes the job must match the phase ID specified in `source_phase`. This value must consist of lower-case letters, numbers, and hyphens, start with a letter and end with a letter or a number, and have a max length of 63 characters. In other words, it must match the following regex: `^[a-z]([a-z0-9-]{0,61}[a-z0-9])?$`. "A String", ], - "repairModes": [ # Required. Defines the types of automatic repair actions for failed jobs. - { # Configuration of the repair action. - "retry": { # Retries the failed job. # Optional. Retries a failed job. - "attempts": "A String", # Required. Total number of retries. Retry is skipped if set to 0; The minimum value is 1, and the maximum value is 10. - "backoffMode": "A String", # Optional. The pattern of how wait time will be increased. Default is linear. Backoff mode will be ignored if `wait` is 0. - "wait": "A String", # Optional. How long to wait for the first retry. Default is 0, and the maximum value is 14d. - }, - "rollback": { # Rolls back a `Rollout`. # Optional. Rolls back a `Rollout`. - "destinationPhase": "A String", # Optional. The starting phase ID for the `Rollout`. If unspecified, the `Rollout` will start in the stable phase. - }, - }, - ], - "sourcePhases": [ # Optional. Phases within which jobs are subject to automatic repair actions on failure. Proceeds only after phase name matched any one in the list, or for all phases if unspecified. This value must consist of lower-case letters, numbers, and hyphens, start with a letter and end with a letter or a number, and have a max length of 63 characters. In other words, it must match the following regex: `^[a-z]([a-z0-9-]{0,61}[a-z0-9])?$`. - "A String", - ], }, }, ], @@ -345,21 +330,6 @@

Method Details

"jobs": [ # Optional. Jobs to repair. Proceeds only after job name matched any one in the list, or for all jobs if unspecified or empty. The phase that includes the job must match the phase ID specified in `source_phase`. This value must consist of lower-case letters, numbers, and hyphens, start with a letter and end with a letter or a number, and have a max length of 63 characters. In other words, it must match the following regex: `^[a-z]([a-z0-9-]{0,61}[a-z0-9])?$`. "A String", ], - "repairModes": [ # Required. Defines the types of automatic repair actions for failed jobs. - { # Configuration of the repair action. - "retry": { # Retries the failed job. # Optional. Retries a failed job. - "attempts": "A String", # Required. Total number of retries. Retry is skipped if set to 0; The minimum value is 1, and the maximum value is 10. - "backoffMode": "A String", # Optional. The pattern of how wait time will be increased. Default is linear. Backoff mode will be ignored if `wait` is 0. - "wait": "A String", # Optional. How long to wait for the first retry. Default is 0, and the maximum value is 14d. - }, - "rollback": { # Rolls back a `Rollout`. # Optional. Rolls back a `Rollout`. - "destinationPhase": "A String", # Optional. The starting phase ID for the `Rollout`. If unspecified, the `Rollout` will start in the stable phase. - }, - }, - ], - "sourcePhases": [ # Optional. Phases within which jobs are subject to automatic repair actions on failure. Proceeds only after phase name matched any one in the list, or for all phases if unspecified. This value must consist of lower-case letters, numbers, and hyphens, start with a letter and end with a letter or a number, and have a max length of 63 characters. In other words, it must match the following regex: `^[a-z]([a-z0-9-]{0,61}[a-z0-9])?$`. - "A String", - ], }, }, ], @@ -458,21 +428,6 @@

Method Details

"jobs": [ # Optional. Jobs to repair. Proceeds only after job name matched any one in the list, or for all jobs if unspecified or empty. The phase that includes the job must match the phase ID specified in `source_phase`. This value must consist of lower-case letters, numbers, and hyphens, start with a letter and end with a letter or a number, and have a max length of 63 characters. In other words, it must match the following regex: `^[a-z]([a-z0-9-]{0,61}[a-z0-9])?$`. "A String", ], - "repairModes": [ # Required. Defines the types of automatic repair actions for failed jobs. - { # Configuration of the repair action. - "retry": { # Retries the failed job. # Optional. Retries a failed job. - "attempts": "A String", # Required. Total number of retries. Retry is skipped if set to 0; The minimum value is 1, and the maximum value is 10. - "backoffMode": "A String", # Optional. The pattern of how wait time will be increased. Default is linear. Backoff mode will be ignored if `wait` is 0. - "wait": "A String", # Optional. How long to wait for the first retry. Default is 0, and the maximum value is 14d. - }, - "rollback": { # Rolls back a `Rollout`. # Optional. Rolls back a `Rollout`. - "destinationPhase": "A String", # Optional. The starting phase ID for the `Rollout`. If unspecified, the `Rollout` will start in the stable phase. - }, - }, - ], - "sourcePhases": [ # Optional. Phases within which jobs are subject to automatic repair actions on failure. Proceeds only after phase name matched any one in the list, or for all phases if unspecified. This value must consist of lower-case letters, numbers, and hyphens, start with a letter and end with a letter or a number, and have a max length of 63 characters. In other words, it must match the following regex: `^[a-z]([a-z0-9-]{0,61}[a-z0-9])?$`. - "A String", - ], }, }, ], @@ -580,21 +535,6 @@

Method Details

"jobs": [ # Optional. Jobs to repair. Proceeds only after job name matched any one in the list, or for all jobs if unspecified or empty. The phase that includes the job must match the phase ID specified in `source_phase`. This value must consist of lower-case letters, numbers, and hyphens, start with a letter and end with a letter or a number, and have a max length of 63 characters. In other words, it must match the following regex: `^[a-z]([a-z0-9-]{0,61}[a-z0-9])?$`. "A String", ], - "repairModes": [ # Required. Defines the types of automatic repair actions for failed jobs. - { # Configuration of the repair action. - "retry": { # Retries the failed job. # Optional. Retries a failed job. - "attempts": "A String", # Required. Total number of retries. Retry is skipped if set to 0; The minimum value is 1, and the maximum value is 10. - "backoffMode": "A String", # Optional. The pattern of how wait time will be increased. Default is linear. Backoff mode will be ignored if `wait` is 0. - "wait": "A String", # Optional. How long to wait for the first retry. Default is 0, and the maximum value is 14d. - }, - "rollback": { # Rolls back a `Rollout`. # Optional. Rolls back a `Rollout`. - "destinationPhase": "A String", # Optional. The starting phase ID for the `Rollout`. If unspecified, the `Rollout` will start in the stable phase. - }, - }, - ], - "sourcePhases": [ # Optional. Phases within which jobs are subject to automatic repair actions on failure. Proceeds only after phase name matched any one in the list, or for all phases if unspecified. This value must consist of lower-case letters, numbers, and hyphens, start with a letter and end with a letter or a number, and have a max length of 63 characters. In other words, it must match the following regex: `^[a-z]([a-z0-9-]{0,61}[a-z0-9])?$`. - "A String", - ], }, }, ], diff --git a/docs/dyn/clouddeploy_v1.projects.locations.deliveryPipelines.html b/docs/dyn/clouddeploy_v1.projects.locations.deliveryPipelines.html index 7f2547924de..037eb107636 100644 --- a/docs/dyn/clouddeploy_v1.projects.locations.deliveryPipelines.html +++ b/docs/dyn/clouddeploy_v1.projects.locations.deliveryPipelines.html @@ -935,7 +935,6 @@

Method Details

"advanceAutomationRuns": [ # Output only. The names of the AutomationRuns initiated by an advance rollout rule. "A String", ], - "currentRepairAutomationRun": "A String", # Output only. The current AutomationRun repairing the rollout. "promoteAutomationRun": "A String", # Output only. The name of the AutomationRun initiated by a promote release rule. "repairAutomationRuns": [ # Output only. The names of the AutomationRuns initiated by a repair rollout rule. "A String", @@ -1165,7 +1164,6 @@

Method Details

"advanceAutomationRuns": [ # Output only. The names of the AutomationRuns initiated by an advance rollout rule. "A String", ], - "currentRepairAutomationRun": "A String", # Output only. The current AutomationRun repairing the rollout. "promoteAutomationRun": "A String", # Output only. The name of the AutomationRun initiated by a promote release rule. "repairAutomationRuns": [ # Output only. The names of the AutomationRuns initiated by a repair rollout rule. "A String", diff --git a/docs/dyn/clouddeploy_v1.projects.locations.deliveryPipelines.releases.html b/docs/dyn/clouddeploy_v1.projects.locations.deliveryPipelines.releases.html index b0e88bf6698..ef222da5c23 100644 --- a/docs/dyn/clouddeploy_v1.projects.locations.deliveryPipelines.releases.html +++ b/docs/dyn/clouddeploy_v1.projects.locations.deliveryPipelines.releases.html @@ -424,6 +424,7 @@

Method Details

"gke": { # Information specifying a GKE Cluster. # Optional. Information specifying a GKE Cluster. "cluster": "A String", # Optional. Information specifying a GKE Cluster. Format is `projects/{project_id}/locations/{location_id}/clusters/{cluster_id}`. "internalIp": True or False, # Optional. If true, `cluster` is accessed using the private IP address of the control plane endpoint. Otherwise, the default IP address of the control plane endpoint is used. The default IP address is the private IP address for clusters with private control-plane endpoints and the public IP address otherwise. Only specify this option when `cluster` is a [private GKE cluster](https://cloud.google.com/kubernetes-engine/docs/concepts/private-cluster-concept). + "proxyUrl": "A String", # Optional. If set, used to configure a [proxy](https://kubernetes.io/docs/concepts/configuration/organize-cluster-access-kubeconfig/#proxy) to the Kubernetes server. }, "labels": { # Optional. Labels are attributes that can be set and used by both the user and by Cloud Deploy. Labels must meet the following constraints: * Keys and values can contain only lowercase letters, numeric characters, underscores, and dashes. * All characters must use UTF-8 encoding, and international characters are allowed. * Keys must start with a lowercase letter or international character. * Each resource is limited to a maximum of 64 labels. Both keys and values are additionally constrained to be <= 128 bytes. "a_key": "A String", @@ -780,6 +781,7 @@

Method Details

"gke": { # Information specifying a GKE Cluster. # Optional. Information specifying a GKE Cluster. "cluster": "A String", # Optional. Information specifying a GKE Cluster. Format is `projects/{project_id}/locations/{location_id}/clusters/{cluster_id}`. "internalIp": True or False, # Optional. If true, `cluster` is accessed using the private IP address of the control plane endpoint. Otherwise, the default IP address of the control plane endpoint is used. The default IP address is the private IP address for clusters with private control-plane endpoints and the public IP address otherwise. Only specify this option when `cluster` is a [private GKE cluster](https://cloud.google.com/kubernetes-engine/docs/concepts/private-cluster-concept). + "proxyUrl": "A String", # Optional. If set, used to configure a [proxy](https://kubernetes.io/docs/concepts/configuration/organize-cluster-access-kubeconfig/#proxy) to the Kubernetes server. }, "labels": { # Optional. Labels are attributes that can be set and used by both the user and by Cloud Deploy. Labels must meet the following constraints: * Keys and values can contain only lowercase letters, numeric characters, underscores, and dashes. * All characters must use UTF-8 encoding, and international characters are allowed. * Keys must start with a lowercase letter or international character. * Each resource is limited to a maximum of 64 labels. Both keys and values are additionally constrained to be <= 128 bytes. "a_key": "A String", @@ -1112,6 +1114,7 @@

Method Details

"gke": { # Information specifying a GKE Cluster. # Optional. Information specifying a GKE Cluster. "cluster": "A String", # Optional. Information specifying a GKE Cluster. Format is `projects/{project_id}/locations/{location_id}/clusters/{cluster_id}`. "internalIp": True or False, # Optional. If true, `cluster` is accessed using the private IP address of the control plane endpoint. Otherwise, the default IP address of the control plane endpoint is used. The default IP address is the private IP address for clusters with private control-plane endpoints and the public IP address otherwise. Only specify this option when `cluster` is a [private GKE cluster](https://cloud.google.com/kubernetes-engine/docs/concepts/private-cluster-concept). + "proxyUrl": "A String", # Optional. If set, used to configure a [proxy](https://kubernetes.io/docs/concepts/configuration/organize-cluster-access-kubeconfig/#proxy) to the Kubernetes server. }, "labels": { # Optional. Labels are attributes that can be set and used by both the user and by Cloud Deploy. Labels must meet the following constraints: * Keys and values can contain only lowercase letters, numeric characters, underscores, and dashes. * All characters must use UTF-8 encoding, and international characters are allowed. * Keys must start with a lowercase letter or international character. * Each resource is limited to a maximum of 64 labels. Both keys and values are additionally constrained to be <= 128 bytes. "a_key": "A String", diff --git a/docs/dyn/clouddeploy_v1.projects.locations.deliveryPipelines.releases.rollouts.html b/docs/dyn/clouddeploy_v1.projects.locations.deliveryPipelines.releases.rollouts.html index e1bf12595c1..d53589e8d56 100644 --- a/docs/dyn/clouddeploy_v1.projects.locations.deliveryPipelines.releases.rollouts.html +++ b/docs/dyn/clouddeploy_v1.projects.locations.deliveryPipelines.releases.rollouts.html @@ -222,7 +222,6 @@

Method Details

"advanceAutomationRuns": [ # Output only. The names of the AutomationRuns initiated by an advance rollout rule. "A String", ], - "currentRepairAutomationRun": "A String", # Output only. The current AutomationRun repairing the rollout. "promoteAutomationRun": "A String", # Output only. The name of the AutomationRun initiated by a promote release rule. "repairAutomationRuns": [ # Output only. The names of the AutomationRuns initiated by a repair rollout rule. "A String", @@ -482,7 +481,6 @@

Method Details

"advanceAutomationRuns": [ # Output only. The names of the AutomationRuns initiated by an advance rollout rule. "A String", ], - "currentRepairAutomationRun": "A String", # Output only. The current AutomationRun repairing the rollout. "promoteAutomationRun": "A String", # Output only. The name of the AutomationRun initiated by a promote release rule. "repairAutomationRuns": [ # Output only. The names of the AutomationRuns initiated by a repair rollout rule. "A String", @@ -743,7 +741,6 @@

Method Details

"advanceAutomationRuns": [ # Output only. The names of the AutomationRuns initiated by an advance rollout rule. "A String", ], - "currentRepairAutomationRun": "A String", # Output only. The current AutomationRun repairing the rollout. "promoteAutomationRun": "A String", # Output only. The name of the AutomationRun initiated by a promote release rule. "repairAutomationRuns": [ # Output only. The names of the AutomationRuns initiated by a repair rollout rule. "A String", diff --git a/docs/dyn/clouddeploy_v1.projects.locations.targets.html b/docs/dyn/clouddeploy_v1.projects.locations.targets.html index a18ddc3272a..47a070f6b30 100644 --- a/docs/dyn/clouddeploy_v1.projects.locations.targets.html +++ b/docs/dyn/clouddeploy_v1.projects.locations.targets.html @@ -159,6 +159,7 @@

Method Details

"gke": { # Information specifying a GKE Cluster. # Optional. Information specifying a GKE Cluster. "cluster": "A String", # Optional. Information specifying a GKE Cluster. Format is `projects/{project_id}/locations/{location_id}/clusters/{cluster_id}`. "internalIp": True or False, # Optional. If true, `cluster` is accessed using the private IP address of the control plane endpoint. Otherwise, the default IP address of the control plane endpoint is used. The default IP address is the private IP address for clusters with private control-plane endpoints and the public IP address otherwise. Only specify this option when `cluster` is a [private GKE cluster](https://cloud.google.com/kubernetes-engine/docs/concepts/private-cluster-concept). + "proxyUrl": "A String", # Optional. If set, used to configure a [proxy](https://kubernetes.io/docs/concepts/configuration/organize-cluster-access-kubeconfig/#proxy) to the Kubernetes server. }, "labels": { # Optional. Labels are attributes that can be set and used by both the user and by Cloud Deploy. Labels must meet the following constraints: * Keys and values can contain only lowercase letters, numeric characters, underscores, and dashes. * All characters must use UTF-8 encoding, and international characters are allowed. * Keys must start with a lowercase letter or international character. * Each resource is limited to a maximum of 64 labels. Both keys and values are additionally constrained to be <= 128 bytes. "a_key": "A String", @@ -303,6 +304,7 @@

Method Details

"gke": { # Information specifying a GKE Cluster. # Optional. Information specifying a GKE Cluster. "cluster": "A String", # Optional. Information specifying a GKE Cluster. Format is `projects/{project_id}/locations/{location_id}/clusters/{cluster_id}`. "internalIp": True or False, # Optional. If true, `cluster` is accessed using the private IP address of the control plane endpoint. Otherwise, the default IP address of the control plane endpoint is used. The default IP address is the private IP address for clusters with private control-plane endpoints and the public IP address otherwise. Only specify this option when `cluster` is a [private GKE cluster](https://cloud.google.com/kubernetes-engine/docs/concepts/private-cluster-concept). + "proxyUrl": "A String", # Optional. If set, used to configure a [proxy](https://kubernetes.io/docs/concepts/configuration/organize-cluster-access-kubeconfig/#proxy) to the Kubernetes server. }, "labels": { # Optional. Labels are attributes that can be set and used by both the user and by Cloud Deploy. Labels must meet the following constraints: * Keys and values can contain only lowercase letters, numeric characters, underscores, and dashes. * All characters must use UTF-8 encoding, and international characters are allowed. * Keys must start with a lowercase letter or international character. * Each resource is limited to a maximum of 64 labels. Both keys and values are additionally constrained to be <= 128 bytes. "a_key": "A String", @@ -432,6 +434,7 @@

Method Details

"gke": { # Information specifying a GKE Cluster. # Optional. Information specifying a GKE Cluster. "cluster": "A String", # Optional. Information specifying a GKE Cluster. Format is `projects/{project_id}/locations/{location_id}/clusters/{cluster_id}`. "internalIp": True or False, # Optional. If true, `cluster` is accessed using the private IP address of the control plane endpoint. Otherwise, the default IP address of the control plane endpoint is used. The default IP address is the private IP address for clusters with private control-plane endpoints and the public IP address otherwise. Only specify this option when `cluster` is a [private GKE cluster](https://cloud.google.com/kubernetes-engine/docs/concepts/private-cluster-concept). + "proxyUrl": "A String", # Optional. If set, used to configure a [proxy](https://kubernetes.io/docs/concepts/configuration/organize-cluster-access-kubeconfig/#proxy) to the Kubernetes server. }, "labels": { # Optional. Labels are attributes that can be set and used by both the user and by Cloud Deploy. Labels must meet the following constraints: * Keys and values can contain only lowercase letters, numeric characters, underscores, and dashes. * All characters must use UTF-8 encoding, and international characters are allowed. * Keys must start with a lowercase letter or international character. * Each resource is limited to a maximum of 64 labels. Both keys and values are additionally constrained to be <= 128 bytes. "a_key": "A String", @@ -520,6 +523,7 @@

Method Details

"gke": { # Information specifying a GKE Cluster. # Optional. Information specifying a GKE Cluster. "cluster": "A String", # Optional. Information specifying a GKE Cluster. Format is `projects/{project_id}/locations/{location_id}/clusters/{cluster_id}`. "internalIp": True or False, # Optional. If true, `cluster` is accessed using the private IP address of the control plane endpoint. Otherwise, the default IP address of the control plane endpoint is used. The default IP address is the private IP address for clusters with private control-plane endpoints and the public IP address otherwise. Only specify this option when `cluster` is a [private GKE cluster](https://cloud.google.com/kubernetes-engine/docs/concepts/private-cluster-concept). + "proxyUrl": "A String", # Optional. If set, used to configure a [proxy](https://kubernetes.io/docs/concepts/configuration/organize-cluster-access-kubeconfig/#proxy) to the Kubernetes server. }, "labels": { # Optional. Labels are attributes that can be set and used by both the user and by Cloud Deploy. Labels must meet the following constraints: * Keys and values can contain only lowercase letters, numeric characters, underscores, and dashes. * All characters must use UTF-8 encoding, and international characters are allowed. * Keys must start with a lowercase letter or international character. * Each resource is limited to a maximum of 64 labels. Both keys and values are additionally constrained to be <= 128 bytes. "a_key": "A String", diff --git a/docs/dyn/connectors_v2.projects.locations.connections.entityTypes.entitieswithacls.html b/docs/dyn/connectors_v2.projects.locations.connections.entityTypes.entitieswithacls.html index a6cbef26b24..7bd14c8f63c 100644 --- a/docs/dyn/connectors_v2.projects.locations.connections.entityTypes.entitieswithacls.html +++ b/docs/dyn/connectors_v2.projects.locations.connections.entityTypes.entitieswithacls.html @@ -78,11 +78,8 @@

Instance Methods

close()

Close httplib2 connections.

- list(parent, conditions=None, gsutilUri=None, pageSize=None, pageToken=None, sortBy=None, x__xgafv=None)

+ list(parent, conditions=None, gsutilUri=None, x__xgafv=None)

Lists entity rows with ACLs of a particular entity type contained in the request. Note: 1. Currently, only max of one 'sort_by' column is supported. 2. If no 'sort_by' column is provided, the primary key of the table is used. If zero or more than one primary key is available, we default to the unpaginated list entities logic which only returns the first page. 3. The values of the 'sort_by' columns must uniquely identify an entity row, otherwise undefined behaviors may be observed during pagination. 4. Since transactions are not supported, any updates, inserts or deletes during pagination can lead to stale data being returned or other unexpected behaviors.

-

- list_next()

-

Retrieves the next page of results.

Method Details

close() @@ -90,16 +87,13 @@

Method Details

- list(parent, conditions=None, gsutilUri=None, pageSize=None, pageToken=None, sortBy=None, x__xgafv=None) + list(parent, conditions=None, gsutilUri=None, x__xgafv=None)
Lists entity rows with ACLs of a particular entity type contained in the request. Note: 1. Currently, only max of one 'sort_by' column is supported. 2. If no 'sort_by' column is provided, the primary key of the table is used. If zero or more than one primary key is available, we default to the unpaginated list entities logic which only returns the first page. 3. The values of the 'sort_by' columns must uniquely identify an entity row, otherwise undefined behaviors may be observed during pagination. 4. Since transactions are not supported, any updates, inserts or deletes during pagination can lead to stale data being returned or other unexpected behaviors.
 
 Args:
   parent: string, Required. Resource name of the Entity Type. Format: projects/{project}/locations/{location}/connections/{connection}/entityTypes/{type} (required)
   conditions: string, Conditions to be used when listing entities. From a proto standpoint, There are no restrictions on what can be passed using this field. The connector documentation should have information about what format of filters/conditions are supported.
   gsutilUri: string, Format: gs://object_path
-  pageSize: integer, Number of entity rows to return. Defaults page size = 25. Max page size = 200.
-  pageToken: string, Page token value if available from a previous request.
-  sortBy: string, List of 'sort_by' columns to use when returning the results. (repeated)
   x__xgafv: string, V1 error format.
     Allowed values
       1 - v1 error format
@@ -108,41 +102,25 @@ 

Method Details

Returns: An object of the form: - { # Response message for EntityService.ListEntitiesWithACLs - "entitiesWithAcl": [ # List containing entity rows. - { # EntityWithACL refers to a single row of an entity type with ACL information. - "acl_info": { # AclInfo has a list of readers for a resource. This is defined as per the below docs https://cloud.google.com/generative-ai-app-builder/docs/reference/rest/v1alpha/projects.locations.collections.dataStores.branches.documents#aclinfo # ACL information of the entity. - "readers": [ # A list of readers for a resource. - { # Readers is a list of principals that have read access to a resource. - "principals": [ # A list of principals that have read access to a resource. - { # Principal is a user or group that has access to a resource. - "group_id": "A String", # The group that has access to a resource. - "user_id": "A String", # The user that has access to a resource. - }, - ], - }, - ], + { # This resource represents a long-running operation that is the result of a network API call. + "done": True or False, # If the value is `false`, it means the operation is still in progress. If `true`, the operation is completed, and either `error` or `response` is available. + "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). # The error result of the operation in case of failure or cancellation. + "code": 42, # The status code, which should be an enum value of google.rpc.Code. + "details": [ # A list of messages that carry the error details. There is a common set of message types for APIs to use. + { + "a_key": "", # Properties of the object. Contains field @type with type URL. }, - "id": "A String", - "jsonData": "A String", # Entity data in JSON format. - }, - ], - "nextPageToken": "A String", # Next page token if more records are available. + ], + "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. + }, + "metadata": { # Service-specific metadata associated with the operation. It typically contains progress information and common metadata such as create time. Some services might not provide such metadata. Any method that returns a long-running operation should document the metadata type, if any. + "a_key": "", # Properties of the object. Contains field @type with type URL. + }, + "name": "A String", # The server-assigned name, which is only unique within the same service that originally returns it. If you use the default HTTP mapping, the `name` should be a resource name ending with `operations/{unique_id}`. + "response": { # The normal, successful response of the operation. If the original method returns no data on success, such as `Delete`, the response is `google.protobuf.Empty`. If the original method is standard `Get`/`Create`/`Update`, the response should be the resource. For other methods, the response should have the type `XxxResponse`, where `Xxx` is the original method name. For example, if the original method name is `TakeSnapshot()`, the inferred response type is `TakeSnapshotResponse`. + "a_key": "", # Properties of the object. Contains field @type with type URL. + }, }
-
- list_next() -
Retrieves the next page of results.
-
-        Args:
-          previous_request: The request for the previous page. (required)
-          previous_response: The response from the request for the previous page. (required)
-
-        Returns:
-          A request object that you can call 'execute()' on to request the next
-          page. Returns None if there are no more items in the collection.
-        
-
- \ No newline at end of file diff --git a/docs/dyn/contactcenteraiplatform_v1alpha1.projects.locations.contactCenters.html b/docs/dyn/contactcenteraiplatform_v1alpha1.projects.locations.contactCenters.html index 9e9da011b60..96c72077cf5 100644 --- a/docs/dyn/contactcenteraiplatform_v1alpha1.projects.locations.contactCenters.html +++ b/docs/dyn/contactcenteraiplatform_v1alpha1.projects.locations.contactCenters.html @@ -157,29 +157,24 @@

Method Details

"egressSettings": [ # List of egress components that should not be accessed via the Internet. For more information see go/ccaip-private-path-v2. { # Defines a logical CCAIP component that e.g. “EMAIL”, "CRM". For more information see go/ccaip-private-path-v2. Each logical component is associated with a list of service attachments. "name": "A String", # Name of the component. - "serviceAttachments": [ # Associated service attachments. - { # Container for the VPC-SC networking configurations. - "allowedProjectIds": [ # The list of project ids that are allowed to send traffic to the service attachment. This field should be filled only for the ingress service attachments. - "A String", - ], - "name": "A String", # The service attachment name that will be used for sending private traffic to the CCAIP tenant project. Example: "projects/${TENANT_PROJECT_ID}/regions/${REGION}/serviceAttachments/ingress-default". - }, + "serviceAttachmentNames": [ # Associated service attachments. The service attachment names that will be used for sending private traffic to the CCAIP tenant project. Example service attachment name: "projects/${TENANT_PROJECT_ID}/regions/${REGION}/serviceAttachments/ingress-default". + "A String", ], }, ], "ingressSettings": [ # List of ingress components that should not be accessed via the Internet. For more information see go/ccaip-private-path-v2. { # Defines a logical CCAIP component that e.g. “EMAIL”, "CRM". For more information see go/ccaip-private-path-v2. Each logical component is associated with a list of service attachments. "name": "A String", # Name of the component. - "serviceAttachments": [ # Associated service attachments. - { # Container for the VPC-SC networking configurations. - "allowedProjectIds": [ # The list of project ids that are allowed to send traffic to the service attachment. This field should be filled only for the ingress service attachments. - "A String", - ], - "name": "A String", # The service attachment name that will be used for sending private traffic to the CCAIP tenant project. Example: "projects/${TENANT_PROJECT_ID}/regions/${REGION}/serviceAttachments/ingress-default". - }, + "serviceAttachmentNames": [ # Associated service attachments. The service attachment names that will be used for sending private traffic to the CCAIP tenant project. Example service attachment name: "projects/${TENANT_PROJECT_ID}/regions/${REGION}/serviceAttachments/ingress-default". + "A String", ], }, ], + "pscSetting": { # Private service connect settings. # Private service connect settings. + "allowedConsumerProjectIds": [ # The list of project ids that are allowed to send traffic to the service attachment. This field should be filled only for the ingress components. + "A String", + ], + }, }, "privateComponents": [ # Output only. A list of UJET components that should be privately accessed. This field is set by reading settings from the data plane. For more information about the format of the component please refer to go/ccaip-vpc-sc-org-policy. This field is must be fully populated only for Create/Update resource operations. The main use case for this field is OrgPolicy checks via CPE. "A String", @@ -333,29 +328,24 @@

Method Details

"egressSettings": [ # List of egress components that should not be accessed via the Internet. For more information see go/ccaip-private-path-v2. { # Defines a logical CCAIP component that e.g. “EMAIL”, "CRM". For more information see go/ccaip-private-path-v2. Each logical component is associated with a list of service attachments. "name": "A String", # Name of the component. - "serviceAttachments": [ # Associated service attachments. - { # Container for the VPC-SC networking configurations. - "allowedProjectIds": [ # The list of project ids that are allowed to send traffic to the service attachment. This field should be filled only for the ingress service attachments. - "A String", - ], - "name": "A String", # The service attachment name that will be used for sending private traffic to the CCAIP tenant project. Example: "projects/${TENANT_PROJECT_ID}/regions/${REGION}/serviceAttachments/ingress-default". - }, + "serviceAttachmentNames": [ # Associated service attachments. The service attachment names that will be used for sending private traffic to the CCAIP tenant project. Example service attachment name: "projects/${TENANT_PROJECT_ID}/regions/${REGION}/serviceAttachments/ingress-default". + "A String", ], }, ], "ingressSettings": [ # List of ingress components that should not be accessed via the Internet. For more information see go/ccaip-private-path-v2. { # Defines a logical CCAIP component that e.g. “EMAIL”, "CRM". For more information see go/ccaip-private-path-v2. Each logical component is associated with a list of service attachments. "name": "A String", # Name of the component. - "serviceAttachments": [ # Associated service attachments. - { # Container for the VPC-SC networking configurations. - "allowedProjectIds": [ # The list of project ids that are allowed to send traffic to the service attachment. This field should be filled only for the ingress service attachments. - "A String", - ], - "name": "A String", # The service attachment name that will be used for sending private traffic to the CCAIP tenant project. Example: "projects/${TENANT_PROJECT_ID}/regions/${REGION}/serviceAttachments/ingress-default". - }, + "serviceAttachmentNames": [ # Associated service attachments. The service attachment names that will be used for sending private traffic to the CCAIP tenant project. Example service attachment name: "projects/${TENANT_PROJECT_ID}/regions/${REGION}/serviceAttachments/ingress-default". + "A String", ], }, ], + "pscSetting": { # Private service connect settings. # Private service connect settings. + "allowedConsumerProjectIds": [ # The list of project ids that are allowed to send traffic to the service attachment. This field should be filled only for the ingress components. + "A String", + ], + }, }, "privateComponents": [ # Output only. A list of UJET components that should be privately accessed. This field is set by reading settings from the data plane. For more information about the format of the component please refer to go/ccaip-vpc-sc-org-policy. This field is must be fully populated only for Create/Update resource operations. The main use case for this field is OrgPolicy checks via CPE. "A String", @@ -449,29 +439,24 @@

Method Details

"egressSettings": [ # List of egress components that should not be accessed via the Internet. For more information see go/ccaip-private-path-v2. { # Defines a logical CCAIP component that e.g. “EMAIL”, "CRM". For more information see go/ccaip-private-path-v2. Each logical component is associated with a list of service attachments. "name": "A String", # Name of the component. - "serviceAttachments": [ # Associated service attachments. - { # Container for the VPC-SC networking configurations. - "allowedProjectIds": [ # The list of project ids that are allowed to send traffic to the service attachment. This field should be filled only for the ingress service attachments. - "A String", - ], - "name": "A String", # The service attachment name that will be used for sending private traffic to the CCAIP tenant project. Example: "projects/${TENANT_PROJECT_ID}/regions/${REGION}/serviceAttachments/ingress-default". - }, + "serviceAttachmentNames": [ # Associated service attachments. The service attachment names that will be used for sending private traffic to the CCAIP tenant project. Example service attachment name: "projects/${TENANT_PROJECT_ID}/regions/${REGION}/serviceAttachments/ingress-default". + "A String", ], }, ], "ingressSettings": [ # List of ingress components that should not be accessed via the Internet. For more information see go/ccaip-private-path-v2. { # Defines a logical CCAIP component that e.g. “EMAIL”, "CRM". For more information see go/ccaip-private-path-v2. Each logical component is associated with a list of service attachments. "name": "A String", # Name of the component. - "serviceAttachments": [ # Associated service attachments. - { # Container for the VPC-SC networking configurations. - "allowedProjectIds": [ # The list of project ids that are allowed to send traffic to the service attachment. This field should be filled only for the ingress service attachments. - "A String", - ], - "name": "A String", # The service attachment name that will be used for sending private traffic to the CCAIP tenant project. Example: "projects/${TENANT_PROJECT_ID}/regions/${REGION}/serviceAttachments/ingress-default". - }, + "serviceAttachmentNames": [ # Associated service attachments. The service attachment names that will be used for sending private traffic to the CCAIP tenant project. Example service attachment name: "projects/${TENANT_PROJECT_ID}/regions/${REGION}/serviceAttachments/ingress-default". + "A String", ], }, ], + "pscSetting": { # Private service connect settings. # Private service connect settings. + "allowedConsumerProjectIds": [ # The list of project ids that are allowed to send traffic to the service attachment. This field should be filled only for the ingress components. + "A String", + ], + }, }, "privateComponents": [ # Output only. A list of UJET components that should be privately accessed. This field is set by reading settings from the data plane. For more information about the format of the component please refer to go/ccaip-vpc-sc-org-policy. This field is must be fully populated only for Create/Update resource operations. The main use case for this field is OrgPolicy checks via CPE. "A String", @@ -574,29 +559,24 @@

Method Details

"egressSettings": [ # List of egress components that should not be accessed via the Internet. For more information see go/ccaip-private-path-v2. { # Defines a logical CCAIP component that e.g. “EMAIL”, "CRM". For more information see go/ccaip-private-path-v2. Each logical component is associated with a list of service attachments. "name": "A String", # Name of the component. - "serviceAttachments": [ # Associated service attachments. - { # Container for the VPC-SC networking configurations. - "allowedProjectIds": [ # The list of project ids that are allowed to send traffic to the service attachment. This field should be filled only for the ingress service attachments. - "A String", - ], - "name": "A String", # The service attachment name that will be used for sending private traffic to the CCAIP tenant project. Example: "projects/${TENANT_PROJECT_ID}/regions/${REGION}/serviceAttachments/ingress-default". - }, + "serviceAttachmentNames": [ # Associated service attachments. The service attachment names that will be used for sending private traffic to the CCAIP tenant project. Example service attachment name: "projects/${TENANT_PROJECT_ID}/regions/${REGION}/serviceAttachments/ingress-default". + "A String", ], }, ], "ingressSettings": [ # List of ingress components that should not be accessed via the Internet. For more information see go/ccaip-private-path-v2. { # Defines a logical CCAIP component that e.g. “EMAIL”, "CRM". For more information see go/ccaip-private-path-v2. Each logical component is associated with a list of service attachments. "name": "A String", # Name of the component. - "serviceAttachments": [ # Associated service attachments. - { # Container for the VPC-SC networking configurations. - "allowedProjectIds": [ # The list of project ids that are allowed to send traffic to the service attachment. This field should be filled only for the ingress service attachments. - "A String", - ], - "name": "A String", # The service attachment name that will be used for sending private traffic to the CCAIP tenant project. Example: "projects/${TENANT_PROJECT_ID}/regions/${REGION}/serviceAttachments/ingress-default". - }, + "serviceAttachmentNames": [ # Associated service attachments. The service attachment names that will be used for sending private traffic to the CCAIP tenant project. Example service attachment name: "projects/${TENANT_PROJECT_ID}/regions/${REGION}/serviceAttachments/ingress-default". + "A String", ], }, ], + "pscSetting": { # Private service connect settings. # Private service connect settings. + "allowedConsumerProjectIds": [ # The list of project ids that are allowed to send traffic to the service attachment. This field should be filled only for the ingress components. + "A String", + ], + }, }, "privateComponents": [ # Output only. A list of UJET components that should be privately accessed. This field is set by reading settings from the data plane. For more information about the format of the component please refer to go/ccaip-vpc-sc-org-policy. This field is must be fully populated only for Create/Update resource operations. The main use case for this field is OrgPolicy checks via CPE. "A String", diff --git a/docs/dyn/content_v2_1.merchantsupport.html b/docs/dyn/content_v2_1.merchantsupport.html index a368a526265..44fe500d285 100644 --- a/docs/dyn/content_v2_1.merchantsupport.html +++ b/docs/dyn/content_v2_1.merchantsupport.html @@ -370,7 +370,7 @@

Method Details

"message": "A String", # Optional. Message summarizing the overall impact of the issue. If present, it should be rendered to the merchant. For example: "Limits visibility in France" "severity": "A String", # The severity of the issue. }, - "prerenderedContent": "A String", # Details of the issue as a pre-rendered HTML. HTML elements contain CSS classes that can be used to customize the style of the content. Always sanitize the HTML before embedding it directly to your application. The sanitizer needs to allow basic HTML tags, such as: `div`, `span`, `p`, `a`, `ul`, `li`, `table`, `tr`, `td`. For example, you can use [DOMPurify](https://www.npmjs.com/package/dompurify). CSS classes: * `issue-detail` - top level container for the detail of the issue * `callout-banners` - section of the `issue-detail` with callout banners * `callout-banner` - single callout banner, inside `callout-banners` * `callout-banner-info` - callout with important information (default) * `callout-banner-warning` - callout with a warning * `callout-banner-error` - callout informing about an error (most severe) * `issue-content` - section of the `issue-detail`, contains multiple `content-element` * `content-element` - content element such as a list, link or paragraph, inside `issue-content` * `root-causes` - unordered list with items describing root causes of the issue, inside `issue-content` * `root-causes-intro` - intro text before the `root-causes` list, inside `issue-content` * `segment` - section of the text, `span` inside paragraph * `segment-attribute` - section of the text that represents a product attribute, for example 'image\_link' * `segment-literal` - section of the text that contains a special value, for example '0-1000 kg' * `segment-bold` - section of the text that should be rendered as bold * `segment-italic` - section of the text that should be rendered as italic * `tooltip` - used on paragraphs that should be rendered with a tooltip. A section of the text in such a paragraph will have a class `tooltip-text` and is intended to be shown in a mouse over dialog. If the style is not used, the `tooltip-text` section would be shown on a new line, after the main part of the text. * `tooltip-text` - marks a section of the text within a `tooltip`, that is intended to be shown in a mouse over dialog. * `tooltip-icon` - marks a section of the text within a `tooltip`, that can be replaced with a tooltip icon, for example '?' or 'i'. By default, this section contains a `br` tag, that is separating the main text and the tooltip text when the style is not used. * `tooltip-style-question` - the tooltip shows helpful information, can use the '?' as an icon. * `tooltip-style-info` - the tooltip adds additional information fitting to the context, can use the 'i' as an icon. * `content-moderation` - marks the paragraph that explains how the issue was identified. * `new-element` - Present for new elements added to the pre-rendered content in the future. To make sure that a new content element does not break your style, you can hide everything with this class. + "prerenderedContent": "A String", # Details of the issue as a pre-rendered HTML. HTML elements contain CSS classes that can be used to customize the style of the content. Always sanitize the HTML before embedding it directly to your application. The sanitizer needs to allow basic HTML tags, such as: `div`, `span`, `p`, `a`, `ul`, `li`, `table`, `tr`, `td`. For example, you can use [DOMPurify](https://www.npmjs.com/package/dompurify). CSS classes: * `issue-detail` - top level container for the detail of the issue * `callout-banners` - section of the `issue-detail` with callout banners * `callout-banner` - single callout banner, inside `callout-banners` * `callout-banner-info` - callout with important information (default) * `callout-banner-warning` - callout with a warning * `callout-banner-error` - callout informing about an error (most severe) * `issue-content` - section of the `issue-detail`, contains multiple `content-element` * `content-element` - content element such as a list, link or paragraph, inside `issue-content` * `root-causes` - unordered list with items describing root causes of the issue, inside `issue-content` * `root-causes-intro` - intro text before the `root-causes` list, inside `issue-content` * `segment` - section of the text, `span` inside paragraph * `segment-attribute` - section of the text that represents a product attribute, for example 'image\_link' * `segment-literal` - section of the text that contains a special value, for example '0-1000 kg' * `segment-bold` - section of the text that should be rendered as bold * `segment-italic` - section of the text that should be rendered as italic * `tooltip` - used on paragraphs that should be rendered with a tooltip. A section of the text in such a paragraph will have a class `tooltip-text` and is intended to be shown in a mouse over dialog. If the style is not used, the `tooltip-text` section would be shown on a new line, after the main part of the text. * `tooltip-text` - marks a section of the text within a `tooltip`, that is intended to be shown in a mouse over dialog. * `tooltip-icon` - marks a section of the text within a `tooltip`, that can be replaced with a tooltip icon, for example '?' or 'i'. By default, this section contains a `br` tag, that is separating the main text and the tooltip text when the style is not used. * `tooltip-style-question` - the tooltip shows helpful information, can use the '?' as an icon. * `tooltip-style-info` - the tooltip adds additional information fitting to the context, can use the 'i' as an icon. * `content-moderation` - marks the paragraph that explains how the issue was identified. * `list-intro` - marks the paragraph that contains an intro for a list. This paragraph will be always followed by a list. * `new-element` - Present for new elements added to the pre-rendered content in the future. To make sure that a new content element does not break your style, you can hide everything with this class. "title": "A String", # Title of the issue. }, ], diff --git a/docs/dyn/dataplex_v1.projects.locations.dataScans.html b/docs/dyn/dataplex_v1.projects.locations.dataScans.html index 7d51b67f2e3..78322a7c3c0 100644 --- a/docs/dyn/dataplex_v1.projects.locations.dataScans.html +++ b/docs/dyn/dataplex_v1.projects.locations.dataScans.html @@ -90,7 +90,7 @@

Instance Methods

Deletes a DataScan resource.

generateDataQualityRules(name, body=None, x__xgafv=None)

-

Generates recommended DataQualityRule from a data profiling DataScan.

+

Generates recommended data quality rules based on the results of a data profiling scan.Use the recommendations to build rules for a data quality scan.

get(name, view=None, x__xgafv=None)

Gets a DataScan resource.

@@ -461,14 +461,14 @@

Method Details

generateDataQualityRules(name, body=None, x__xgafv=None) -
Generates recommended DataQualityRule from a data profiling DataScan.
+  
Generates recommended data quality rules based on the results of a data profiling scan.Use the recommendations to build rules for a data quality scan.
 
 Args:
-  name: string, Required. The name should be either * the name of a datascan with at least one successful completed data profiling job, or * the name of a successful completed data profiling datascan job. (required)
+  name: string, Required. The name must be one of the following: The name of a data scan with at least one successful, completed data profiling job The name of a successful, completed data profiling job (a data scan job where the job type is data profiling) (required)
   body: object, The request body.
     The object takes the form of:
 
-{ # Generate recommended DataQualityRules request.
+{ # Request details for generating data quality rule recommendations.
 }
 
   x__xgafv: string, V1 error format.
@@ -479,8 +479,8 @@ 

Method Details

Returns: An object of the form: - { # Generate recommended DataQualityRules response. - "rule": [ # Generated recommended {@link DataQualityRule}s. + { # Response details for data quality rule recommendations. + "rule": [ # The data quality rules that Dataplex generates based on the results of a data profiling scan. { # A rule captures data quality intent about a data source. "column": "A String", # Optional. The unnested column which this rule is evaluated against. "description": "A String", # Optional. Description of the rule. The maximum length is 1,024 characters. diff --git a/docs/dyn/dataplex_v1.projects.locations.dataScans.jobs.html b/docs/dyn/dataplex_v1.projects.locations.dataScans.jobs.html index e22431801bc..ad0821a912d 100644 --- a/docs/dyn/dataplex_v1.projects.locations.dataScans.jobs.html +++ b/docs/dyn/dataplex_v1.projects.locations.dataScans.jobs.html @@ -79,7 +79,7 @@

Instance Methods

Close httplib2 connections.

generateDataQualityRules(name, body=None, x__xgafv=None)

-

Generates recommended DataQualityRule from a data profiling DataScan.

+

Generates recommended data quality rules based on the results of a data profiling scan.Use the recommendations to build rules for a data quality scan.

get(name, view=None, x__xgafv=None)

Gets a DataScanJob resource.

@@ -97,14 +97,14 @@

Method Details

generateDataQualityRules(name, body=None, x__xgafv=None) -
Generates recommended DataQualityRule from a data profiling DataScan.
+  
Generates recommended data quality rules based on the results of a data profiling scan.Use the recommendations to build rules for a data quality scan.
 
 Args:
-  name: string, Required. The name should be either * the name of a datascan with at least one successful completed data profiling job, or * the name of a successful completed data profiling datascan job. (required)
+  name: string, Required. The name must be one of the following: The name of a data scan with at least one successful, completed data profiling job The name of a successful, completed data profiling job (a data scan job where the job type is data profiling) (required)
   body: object, The request body.
     The object takes the form of:
 
-{ # Generate recommended DataQualityRules request.
+{ # Request details for generating data quality rule recommendations.
 }
 
   x__xgafv: string, V1 error format.
@@ -115,8 +115,8 @@ 

Method Details

Returns: An object of the form: - { # Generate recommended DataQualityRules response. - "rule": [ # Generated recommended {@link DataQualityRule}s. + { # Response details for data quality rule recommendations. + "rule": [ # The data quality rules that Dataplex generates based on the results of a data profiling scan. { # A rule captures data quality intent about a data source. "column": "A String", # Optional. The unnested column which this rule is evaluated against. "description": "A String", # Optional. Description of the rule. The maximum length is 1,024 characters. diff --git a/docs/dyn/dataplex_v1.projects.locations.entryGroups.entries.html b/docs/dyn/dataplex_v1.projects.locations.entryGroups.entries.html index 87809eea8e2..2eca255d200 100644 --- a/docs/dyn/dataplex_v1.projects.locations.entryGroups.entries.html +++ b/docs/dyn/dataplex_v1.projects.locations.entryGroups.entries.html @@ -140,6 +140,7 @@

Method Details

"labels": { # User-defined labels. The maximum size of keys and values is 128 characters each. "a_key": "A String", }, + "location": "A String", # Output only. Location of the resource in the source system. Entry will be searchable by this location. By default, this should match the location of the EntryGroup containing this entry. A different value allows capturing source location for data external to GCP. "platform": "A String", # The platform containing the source system. The maximum size of the field is 64 characters. "resource": "A String", # The name of the resource in the source system. The maximum size of the field is 4000 characters. "system": "A String", # The name of the source system. The maximum size of the field is 64 characters. @@ -191,6 +192,7 @@

Method Details

"labels": { # User-defined labels. The maximum size of keys and values is 128 characters each. "a_key": "A String", }, + "location": "A String", # Output only. Location of the resource in the source system. Entry will be searchable by this location. By default, this should match the location of the EntryGroup containing this entry. A different value allows capturing source location for data external to GCP. "platform": "A String", # The platform containing the source system. The maximum size of the field is 64 characters. "resource": "A String", # The name of the resource in the source system. The maximum size of the field is 4000 characters. "system": "A String", # The name of the source system. The maximum size of the field is 64 characters. @@ -248,6 +250,7 @@

Method Details

"labels": { # User-defined labels. The maximum size of keys and values is 128 characters each. "a_key": "A String", }, + "location": "A String", # Output only. Location of the resource in the source system. Entry will be searchable by this location. By default, this should match the location of the EntryGroup containing this entry. A different value allows capturing source location for data external to GCP. "platform": "A String", # The platform containing the source system. The maximum size of the field is 64 characters. "resource": "A String", # The name of the resource in the source system. The maximum size of the field is 4000 characters. "system": "A String", # The name of the source system. The maximum size of the field is 64 characters. @@ -314,6 +317,7 @@

Method Details

"labels": { # User-defined labels. The maximum size of keys and values is 128 characters each. "a_key": "A String", }, + "location": "A String", # Output only. Location of the resource in the source system. Entry will be searchable by this location. By default, this should match the location of the EntryGroup containing this entry. A different value allows capturing source location for data external to GCP. "platform": "A String", # The platform containing the source system. The maximum size of the field is 64 characters. "resource": "A String", # The name of the resource in the source system. The maximum size of the field is 4000 characters. "system": "A String", # The name of the source system. The maximum size of the field is 64 characters. @@ -376,6 +380,7 @@

Method Details

"labels": { # User-defined labels. The maximum size of keys and values is 128 characters each. "a_key": "A String", }, + "location": "A String", # Output only. Location of the resource in the source system. Entry will be searchable by this location. By default, this should match the location of the EntryGroup containing this entry. A different value allows capturing source location for data external to GCP. "platform": "A String", # The platform containing the source system. The maximum size of the field is 64 characters. "resource": "A String", # The name of the resource in the source system. The maximum size of the field is 4000 characters. "system": "A String", # The name of the source system. The maximum size of the field is 64 characters. @@ -445,6 +450,7 @@

Method Details

"labels": { # User-defined labels. The maximum size of keys and values is 128 characters each. "a_key": "A String", }, + "location": "A String", # Output only. Location of the resource in the source system. Entry will be searchable by this location. By default, this should match the location of the EntryGroup containing this entry. A different value allows capturing source location for data external to GCP. "platform": "A String", # The platform containing the source system. The maximum size of the field is 64 characters. "resource": "A String", # The name of the resource in the source system. The maximum size of the field is 4000 characters. "system": "A String", # The name of the source system. The maximum size of the field is 64 characters. @@ -499,6 +505,7 @@

Method Details

"labels": { # User-defined labels. The maximum size of keys and values is 128 characters each. "a_key": "A String", }, + "location": "A String", # Output only. Location of the resource in the source system. Entry will be searchable by this location. By default, this should match the location of the EntryGroup containing this entry. A different value allows capturing source location for data external to GCP. "platform": "A String", # The platform containing the source system. The maximum size of the field is 64 characters. "resource": "A String", # The name of the resource in the source system. The maximum size of the field is 4000 characters. "system": "A String", # The name of the source system. The maximum size of the field is 64 characters. diff --git a/docs/dyn/dataplex_v1.projects.locations.html b/docs/dyn/dataplex_v1.projects.locations.html index bd73d38aa5b..68a021266ba 100644 --- a/docs/dyn/dataplex_v1.projects.locations.html +++ b/docs/dyn/dataplex_v1.projects.locations.html @@ -276,6 +276,7 @@

Method Details

"labels": { # User-defined labels. The maximum size of keys and values is 128 characters each. "a_key": "A String", }, + "location": "A String", # Output only. Location of the resource in the source system. Entry will be searchable by this location. By default, this should match the location of the EntryGroup containing this entry. A different value allows capturing source location for data external to GCP. "platform": "A String", # The platform containing the source system. The maximum size of the field is 64 characters. "resource": "A String", # The name of the resource in the source system. The maximum size of the field is 4000 characters. "system": "A String", # The name of the source system. The maximum size of the field is 64 characters. @@ -342,6 +343,7 @@

Method Details

"labels": { # User-defined labels. The maximum size of keys and values is 128 characters each. "a_key": "A String", }, + "location": "A String", # Output only. Location of the resource in the source system. Entry will be searchable by this location. By default, this should match the location of the EntryGroup containing this entry. A different value allows capturing source location for data external to GCP. "platform": "A String", # The platform containing the source system. The maximum size of the field is 64 characters. "resource": "A String", # The name of the resource in the source system. The maximum size of the field is 4000 characters. "system": "A String", # The name of the source system. The maximum size of the field is 64 characters. @@ -385,6 +387,7 @@

Method Details

"labels": { # User-defined labels. The maximum size of keys and values is 128 characters each. "a_key": "A String", }, + "location": "A String", # Output only. Location of the resource in the source system. Entry will be searchable by this location. By default, this should match the location of the EntryGroup containing this entry. A different value allows capturing source location for data external to GCP. "platform": "A String", # The platform containing the source system. The maximum size of the field is 64 characters. "resource": "A String", # The name of the resource in the source system. The maximum size of the field is 4000 characters. "system": "A String", # The name of the source system. The maximum size of the field is 64 characters. diff --git a/docs/dyn/dataproc_v1.projects.locations.batches.html b/docs/dyn/dataproc_v1.projects.locations.batches.html index eb2141b91b4..7c858c90a2e 100644 --- a/docs/dyn/dataproc_v1.projects.locations.batches.html +++ b/docs/dyn/dataproc_v1.projects.locations.batches.html @@ -199,6 +199,12 @@

Method Details

], }, "runtimeConfig": { # Runtime configuration for a workload. # Optional. Runtime configuration for the batch execution. + "autotuningConfig": { # Autotuning configuration of the workload. # Optional. Autotuning configuration of the workload. + "scenarios": [ # Optional. Scenarios for which tunings are applied. + "A String", + ], + }, + "cohort": "A String", # Optional. Cohort identifier. Identifies families of the workloads having the same shape, e.g. daily ETL jobs. "containerImage": "A String", # Optional. Optional custom container image for the job runtime environment. If not specified, a default container image will be used. "properties": { # Optional. A mapping of property names to values, which are used to configure workload execution. "a_key": "A String", @@ -392,6 +398,12 @@

Method Details

], }, "runtimeConfig": { # Runtime configuration for a workload. # Optional. Runtime configuration for the batch execution. + "autotuningConfig": { # Autotuning configuration of the workload. # Optional. Autotuning configuration of the workload. + "scenarios": [ # Optional. Scenarios for which tunings are applied. + "A String", + ], + }, + "cohort": "A String", # Optional. Cohort identifier. Identifies families of the workloads having the same shape, e.g. daily ETL jobs. "containerImage": "A String", # Optional. Optional custom container image for the job runtime environment. If not specified, a default container image will be used. "properties": { # Optional. A mapping of property names to values, which are used to configure workload execution. "a_key": "A String", @@ -543,6 +555,12 @@

Method Details

], }, "runtimeConfig": { # Runtime configuration for a workload. # Optional. Runtime configuration for the batch execution. + "autotuningConfig": { # Autotuning configuration of the workload. # Optional. Autotuning configuration of the workload. + "scenarios": [ # Optional. Scenarios for which tunings are applied. + "A String", + ], + }, + "cohort": "A String", # Optional. Cohort identifier. Identifies families of the workloads having the same shape, e.g. daily ETL jobs. "containerImage": "A String", # Optional. Optional custom container image for the job runtime environment. If not specified, a default container image will be used. "properties": { # Optional. A mapping of property names to values, which are used to configure workload execution. "a_key": "A String", diff --git a/docs/dyn/dataproc_v1.projects.locations.sessionTemplates.html b/docs/dyn/dataproc_v1.projects.locations.sessionTemplates.html index f7699c67f7f..160b6080d97 100644 --- a/docs/dyn/dataproc_v1.projects.locations.sessionTemplates.html +++ b/docs/dyn/dataproc_v1.projects.locations.sessionTemplates.html @@ -143,6 +143,12 @@

Method Details

}, "name": "A String", # Required. The resource name of the session template. "runtimeConfig": { # Runtime configuration for a workload. # Optional. Runtime configuration for session execution. + "autotuningConfig": { # Autotuning configuration of the workload. # Optional. Autotuning configuration of the workload. + "scenarios": [ # Optional. Scenarios for which tunings are applied. + "A String", + ], + }, + "cohort": "A String", # Optional. Cohort identifier. Identifies families of the workloads having the same shape, e.g. daily ETL jobs. "containerImage": "A String", # Optional. Optional custom container image for the job runtime environment. If not specified, a default container image will be used. "properties": { # Optional. A mapping of property names to values, which are used to configure workload execution. "a_key": "A String", @@ -199,6 +205,12 @@

Method Details

}, "name": "A String", # Required. The resource name of the session template. "runtimeConfig": { # Runtime configuration for a workload. # Optional. Runtime configuration for session execution. + "autotuningConfig": { # Autotuning configuration of the workload. # Optional. Autotuning configuration of the workload. + "scenarios": [ # Optional. Scenarios for which tunings are applied. + "A String", + ], + }, + "cohort": "A String", # Optional. Cohort identifier. Identifies families of the workloads having the same shape, e.g. daily ETL jobs. "containerImage": "A String", # Optional. Optional custom container image for the job runtime environment. If not specified, a default container image will be used. "properties": { # Optional. A mapping of property names to values, which are used to configure workload execution. "a_key": "A String", @@ -280,6 +292,12 @@

Method Details

}, "name": "A String", # Required. The resource name of the session template. "runtimeConfig": { # Runtime configuration for a workload. # Optional. Runtime configuration for session execution. + "autotuningConfig": { # Autotuning configuration of the workload. # Optional. Autotuning configuration of the workload. + "scenarios": [ # Optional. Scenarios for which tunings are applied. + "A String", + ], + }, + "cohort": "A String", # Optional. Cohort identifier. Identifies families of the workloads having the same shape, e.g. daily ETL jobs. "containerImage": "A String", # Optional. Optional custom container image for the job runtime environment. If not specified, a default container image will be used. "properties": { # Optional. A mapping of property names to values, which are used to configure workload execution. "a_key": "A String", @@ -349,6 +367,12 @@

Method Details

}, "name": "A String", # Required. The resource name of the session template. "runtimeConfig": { # Runtime configuration for a workload. # Optional. Runtime configuration for session execution. + "autotuningConfig": { # Autotuning configuration of the workload. # Optional. Autotuning configuration of the workload. + "scenarios": [ # Optional. Scenarios for which tunings are applied. + "A String", + ], + }, + "cohort": "A String", # Optional. Cohort identifier. Identifies families of the workloads having the same shape, e.g. daily ETL jobs. "containerImage": "A String", # Optional. Optional custom container image for the job runtime environment. If not specified, a default container image will be used. "properties": { # Optional. A mapping of property names to values, which are used to configure workload execution. "a_key": "A String", @@ -423,6 +447,12 @@

Method Details

}, "name": "A String", # Required. The resource name of the session template. "runtimeConfig": { # Runtime configuration for a workload. # Optional. Runtime configuration for session execution. + "autotuningConfig": { # Autotuning configuration of the workload. # Optional. Autotuning configuration of the workload. + "scenarios": [ # Optional. Scenarios for which tunings are applied. + "A String", + ], + }, + "cohort": "A String", # Optional. Cohort identifier. Identifies families of the workloads having the same shape, e.g. daily ETL jobs. "containerImage": "A String", # Optional. Optional custom container image for the job runtime environment. If not specified, a default container image will be used. "properties": { # Optional. A mapping of property names to values, which are used to configure workload execution. "a_key": "A String", @@ -479,6 +509,12 @@

Method Details

}, "name": "A String", # Required. The resource name of the session template. "runtimeConfig": { # Runtime configuration for a workload. # Optional. Runtime configuration for session execution. + "autotuningConfig": { # Autotuning configuration of the workload. # Optional. Autotuning configuration of the workload. + "scenarios": [ # Optional. Scenarios for which tunings are applied. + "A String", + ], + }, + "cohort": "A String", # Optional. Cohort identifier. Identifies families of the workloads having the same shape, e.g. daily ETL jobs. "containerImage": "A String", # Optional. Optional custom container image for the job runtime environment. If not specified, a default container image will be used. "properties": { # Optional. A mapping of property names to values, which are used to configure workload execution. "a_key": "A String", diff --git a/docs/dyn/dataproc_v1.projects.locations.sessions.html b/docs/dyn/dataproc_v1.projects.locations.sessions.html index f237771cdf4..45497f6dc35 100644 --- a/docs/dyn/dataproc_v1.projects.locations.sessions.html +++ b/docs/dyn/dataproc_v1.projects.locations.sessions.html @@ -142,6 +142,12 @@

Method Details

}, "name": "A String", # Required. The resource name of the session. "runtimeConfig": { # Runtime configuration for a workload. # Optional. Runtime configuration for the session execution. + "autotuningConfig": { # Autotuning configuration of the workload. # Optional. Autotuning configuration of the workload. + "scenarios": [ # Optional. Scenarios for which tunings are applied. + "A String", + ], + }, + "cohort": "A String", # Optional. Cohort identifier. Identifies families of the workloads having the same shape, e.g. daily ETL jobs. "containerImage": "A String", # Optional. Optional custom container image for the job runtime environment. If not specified, a default container image will be used. "properties": { # Optional. A mapping of property names to values, which are used to configure workload execution. "a_key": "A String", @@ -303,6 +309,12 @@

Method Details

}, "name": "A String", # Required. The resource name of the session. "runtimeConfig": { # Runtime configuration for a workload. # Optional. Runtime configuration for the session execution. + "autotuningConfig": { # Autotuning configuration of the workload. # Optional. Autotuning configuration of the workload. + "scenarios": [ # Optional. Scenarios for which tunings are applied. + "A String", + ], + }, + "cohort": "A String", # Optional. Cohort identifier. Identifies families of the workloads having the same shape, e.g. daily ETL jobs. "containerImage": "A String", # Optional. Optional custom container image for the job runtime environment. If not specified, a default container image will be used. "properties": { # Optional. A mapping of property names to values, which are used to configure workload execution. "a_key": "A String", @@ -404,6 +416,12 @@

Method Details

}, "name": "A String", # Required. The resource name of the session. "runtimeConfig": { # Runtime configuration for a workload. # Optional. Runtime configuration for the session execution. + "autotuningConfig": { # Autotuning configuration of the workload. # Optional. Autotuning configuration of the workload. + "scenarios": [ # Optional. Scenarios for which tunings are applied. + "A String", + ], + }, + "cohort": "A String", # Optional. Cohort identifier. Identifies families of the workloads having the same shape, e.g. daily ETL jobs. "containerImage": "A String", # Optional. Optional custom container image for the job runtime environment. If not specified, a default container image will be used. "properties": { # Optional. A mapping of property names to values, which are used to configure workload execution. "a_key": "A String", diff --git a/docs/dyn/datastream_v1.projects.locations.connectionProfiles.html b/docs/dyn/datastream_v1.projects.locations.connectionProfiles.html index 52ff1e30d67..1535e45fd35 100644 --- a/docs/dyn/datastream_v1.projects.locations.connectionProfiles.html +++ b/docs/dyn/datastream_v1.projects.locations.connectionProfiles.html @@ -408,6 +408,30 @@

Method Details

}, ], }, + "sqlServerRdbms": { # SQLServer database structure. # SQLServer RDBMS to enrich with child data objects and metadata. + "schemas": [ # SQLServer schemas in the database server. + { # SQLServer schema. + "schema": "A String", # Schema name. + "tables": [ # Tables in the schema. + { # SQLServer table. + "columns": [ # SQLServer columns in the schema. When unspecified as part of include/exclude objects, includes/excludes everything. + { # SQLServer Column. + "column": "A String", # Column name. + "dataType": "A String", # The SQLServer data type. + "length": 42, # Column length. + "nullable": True or False, # Whether or not the column can accept a null value. + "ordinalPosition": 42, # The ordinal position of the column in the table. + "precision": 42, # Column precision. + "primaryKey": True or False, # Whether or not the column represents a primary key. + "scale": 42, # Column scale. + }, + ], + "table": "A String", # Table name. + }, + ], + }, + ], + }, } x__xgafv: string, V1 error format. @@ -493,6 +517,30 @@

Method Details

}, ], }, + "sqlServerRdbms": { # SQLServer database structure. # Enriched SQLServer RDBMS object. + "schemas": [ # SQLServer schemas in the database server. + { # SQLServer schema. + "schema": "A String", # Schema name. + "tables": [ # Tables in the schema. + { # SQLServer table. + "columns": [ # SQLServer columns in the schema. When unspecified as part of include/exclude objects, includes/excludes everything. + { # SQLServer Column. + "column": "A String", # Column name. + "dataType": "A String", # The SQLServer data type. + "length": 42, # Column length. + "nullable": True or False, # Whether or not the column can accept a null value. + "ordinalPosition": 42, # The ordinal position of the column in the table. + "precision": 42, # Column precision. + "primaryKey": True or False, # Whether or not the column represents a primary key. + "scale": 42, # Column scale. + }, + ], + "table": "A String", # Table name. + }, + ], + }, + ], + }, }
diff --git a/docs/dyn/dialogflow_v2.projects.answerRecords.html b/docs/dyn/dialogflow_v2.projects.answerRecords.html index c0bef1e623d..8372fd53e42 100644 --- a/docs/dyn/dialogflow_v2.projects.answerRecords.html +++ b/docs/dyn/dialogflow_v2.projects.answerRecords.html @@ -605,6 +605,12 @@

Method Details

"answerRelevance": "A String", # Optional. Whether or not the suggested answer is relevant. For example: * Query: "Can I change my mailing address?" * Suggested document says: "Items must be returned/exchanged within 60 days of the purchase date." * answer_relevance: AnswerRelevance.IRRELEVANT "documentCorrectness": "A String", # Optional. Whether or not the information in the document is correct. For example: * Query: "Can I return the package in 2 days once received?" * Suggested document says: "Items must be returned/exchanged within 60 days of the purchase date." * Ground truth: "No return or exchange is allowed." * [document_correctness]: INCORRECT "documentEfficiency": "A String", # Optional. Whether or not the suggested document is efficient. For example, if the document is poorly written, hard to understand, hard to use or too long to find useful information, document_efficiency is DocumentEfficiency.INEFFICIENT. + "knowledgeAssistFeedback": { # Feedback for knowledge assist. # Optional. Feedback for knowledge assist. + "answerCopied": True or False, # Whether the suggested answer was copied by the human agent. If the value is set to be true, AnswerFeedback.clicked will be updated to be true. + "clickedUris": [ # The URIs clicked by the human agent. The value is appended for each UpdateAnswerRecordRequest. If the value is not empty, AnswerFeedback.clicked will be updated to be true. + "A String", + ], + }, "knowledgeSearchFeedback": { # Feedback for knowledge search. # Optional. Feedback for knowledge search. "answerCopied": True or False, # Whether the answer was copied by the human agent or not. If the value is set to be true, AnswerFeedback.clicked will be updated to be true. "clickedUris": [ # The URIs clicked by the human agent. The value is appended for each UpdateAnswerRecordRequest. If the value is not empty, AnswerFeedback.clicked will be updated to be true. @@ -1150,6 +1156,12 @@

Method Details

"answerRelevance": "A String", # Optional. Whether or not the suggested answer is relevant. For example: * Query: "Can I change my mailing address?" * Suggested document says: "Items must be returned/exchanged within 60 days of the purchase date." * answer_relevance: AnswerRelevance.IRRELEVANT "documentCorrectness": "A String", # Optional. Whether or not the information in the document is correct. For example: * Query: "Can I return the package in 2 days once received?" * Suggested document says: "Items must be returned/exchanged within 60 days of the purchase date." * Ground truth: "No return or exchange is allowed." * [document_correctness]: INCORRECT "documentEfficiency": "A String", # Optional. Whether or not the suggested document is efficient. For example, if the document is poorly written, hard to understand, hard to use or too long to find useful information, document_efficiency is DocumentEfficiency.INEFFICIENT. + "knowledgeAssistFeedback": { # Feedback for knowledge assist. # Optional. Feedback for knowledge assist. + "answerCopied": True or False, # Whether the suggested answer was copied by the human agent. If the value is set to be true, AnswerFeedback.clicked will be updated to be true. + "clickedUris": [ # The URIs clicked by the human agent. The value is appended for each UpdateAnswerRecordRequest. If the value is not empty, AnswerFeedback.clicked will be updated to be true. + "A String", + ], + }, "knowledgeSearchFeedback": { # Feedback for knowledge search. # Optional. Feedback for knowledge search. "answerCopied": True or False, # Whether the answer was copied by the human agent or not. If the value is set to be true, AnswerFeedback.clicked will be updated to be true. "clickedUris": [ # The URIs clicked by the human agent. The value is appended for each UpdateAnswerRecordRequest. If the value is not empty, AnswerFeedback.clicked will be updated to be true. @@ -1677,6 +1689,12 @@

Method Details

"answerRelevance": "A String", # Optional. Whether or not the suggested answer is relevant. For example: * Query: "Can I change my mailing address?" * Suggested document says: "Items must be returned/exchanged within 60 days of the purchase date." * answer_relevance: AnswerRelevance.IRRELEVANT "documentCorrectness": "A String", # Optional. Whether or not the information in the document is correct. For example: * Query: "Can I return the package in 2 days once received?" * Suggested document says: "Items must be returned/exchanged within 60 days of the purchase date." * Ground truth: "No return or exchange is allowed." * [document_correctness]: INCORRECT "documentEfficiency": "A String", # Optional. Whether or not the suggested document is efficient. For example, if the document is poorly written, hard to understand, hard to use or too long to find useful information, document_efficiency is DocumentEfficiency.INEFFICIENT. + "knowledgeAssistFeedback": { # Feedback for knowledge assist. # Optional. Feedback for knowledge assist. + "answerCopied": True or False, # Whether the suggested answer was copied by the human agent. If the value is set to be true, AnswerFeedback.clicked will be updated to be true. + "clickedUris": [ # The URIs clicked by the human agent. The value is appended for each UpdateAnswerRecordRequest. If the value is not empty, AnswerFeedback.clicked will be updated to be true. + "A String", + ], + }, "knowledgeSearchFeedback": { # Feedback for knowledge search. # Optional. Feedback for knowledge search. "answerCopied": True or False, # Whether the answer was copied by the human agent or not. If the value is set to be true, AnswerFeedback.clicked will be updated to be true. "clickedUris": [ # The URIs clicked by the human agent. The value is appended for each UpdateAnswerRecordRequest. If the value is not empty, AnswerFeedback.clicked will be updated to be true. diff --git a/docs/dyn/dialogflow_v2.projects.conversationProfiles.html b/docs/dyn/dialogflow_v2.projects.conversationProfiles.html index c23e7ee4e92..bb2a5b90af7 100644 --- a/docs/dyn/dialogflow_v2.projects.conversationProfiles.html +++ b/docs/dyn/dialogflow_v2.projects.conversationProfiles.html @@ -168,6 +168,7 @@

Method Details

"displayName": "A String", # Required. Human readable name for this profile. Max length 1024 bytes. "humanAgentAssistantConfig": { # Defines the Human Agent Assist to connect to a conversation. # Configuration for agent assistance to use with this profile. "endUserSuggestionConfig": { # Detail human agent assistant config. # Configuration for agent assistance of end user participant. Currently, this feature is not general available, please contact Google to get access. + "disableHighLatencyFeaturesSyncDelivery": True or False, # Optional. When disable_high_latency_features_sync_delivery is true and using the AnalyzeContent API, we will not deliver the responses from high latency features in the API response. The human_agent_assistant_config.notification_config must be configured and enable_event_based_suggestion must be set to true to receive the responses from high latency features in Pub/Sub. High latency feature(s): KNOWLEDGE_ASSIST. "featureConfigs": [ # Configuration of different suggestion features. One feature can have only one config. { # Config for suggestion features. "conversationModelConfig": { # Custom conversation models used in agent assist feature. Supported feature: ARTICLE_SUGGESTION, SMART_COMPOSE, SMART_REPLY, CONVERSATION_SUMMARIZATION. # Configs of custom conversation model. @@ -180,6 +181,8 @@

Method Details

"disableAgentQueryLogging": True or False, # Optional. Disable the logging of search queries sent by human agents. It can prevent those queries from being stored at answer records. Supported features: KNOWLEDGE_SEARCH. "enableConversationAugmentedQuery": True or False, # Optional. Enable including conversation context during query answer generation. Supported features: KNOWLEDGE_SEARCH. "enableEventBasedSuggestion": True or False, # Automatically iterates all participants and tries to compile suggestions. Supported features: ARTICLE_SUGGESTION, FAQ, DIALOGFLOW_ASSIST, KNOWLEDGE_ASSIST. + "enableQuerySuggestionOnly": True or False, # Optional. Enable query suggestion only. Supported features: KNOWLEDGE_ASSIST + "enableQuerySuggestionWhenNoAnswer": True or False, # Optional. Enable query suggestion even if we can't find its answer. By default, queries are suggested only if we find its answer. Supported features: KNOWLEDGE_ASSIST "queryConfig": { # Config for suggestion query. # Configs of query. "confidenceThreshold": 3.14, # Confidence threshold of query result. Agent Assist gives each suggestion a score in the range [0.0, 1.0], based on the relevance between the suggestion and the current conversation context. A score of 0.0 has no relevance, while a score of 1.0 has high relevance. Only suggestions with a score greater than or equal to the value of this field are included in the results. For a baseline model (the default), the recommended value is in the range [0.05, 0.1]. For a custom model, there is no recommended value. Tune this value by starting from a very low value and slowly increasing until you have desired results. If this field is not set, it defaults to 0.0, which means that all suggestions are returned. Supported features: ARTICLE_SUGGESTION, FAQ, SMART_REPLY, SMART_COMPOSE, KNOWLEDGE_SEARCH, KNOWLEDGE_ASSIST, ENTITY_EXTRACTION. "contextFilterSettings": { # Settings that determine how to filter recent conversation context when generating suggestions. # Determines how recent conversation context is filtered when generating suggestions. If unspecified, no messages will be dropped. @@ -225,6 +228,7 @@

Method Details

"groupSuggestionResponses": True or False, # If `group_suggestion_responses` is false, and there are multiple `feature_configs` in `event based suggestion` or StreamingAnalyzeContent, we will try to deliver suggestions to customers as soon as we get new suggestion. Different type of suggestions based on the same context will be in separate Pub/Sub event or `StreamingAnalyzeContentResponse`. If `group_suggestion_responses` set to true. All the suggestions to the same participant based on the same context will be grouped into a single Pub/Sub event or StreamingAnalyzeContentResponse. }, "humanAgentSuggestionConfig": { # Detail human agent assistant config. # Configuration for agent assistance of human agent participant. + "disableHighLatencyFeaturesSyncDelivery": True or False, # Optional. When disable_high_latency_features_sync_delivery is true and using the AnalyzeContent API, we will not deliver the responses from high latency features in the API response. The human_agent_assistant_config.notification_config must be configured and enable_event_based_suggestion must be set to true to receive the responses from high latency features in Pub/Sub. High latency feature(s): KNOWLEDGE_ASSIST. "featureConfigs": [ # Configuration of different suggestion features. One feature can have only one config. { # Config for suggestion features. "conversationModelConfig": { # Custom conversation models used in agent assist feature. Supported feature: ARTICLE_SUGGESTION, SMART_COMPOSE, SMART_REPLY, CONVERSATION_SUMMARIZATION. # Configs of custom conversation model. @@ -237,6 +241,8 @@

Method Details

"disableAgentQueryLogging": True or False, # Optional. Disable the logging of search queries sent by human agents. It can prevent those queries from being stored at answer records. Supported features: KNOWLEDGE_SEARCH. "enableConversationAugmentedQuery": True or False, # Optional. Enable including conversation context during query answer generation. Supported features: KNOWLEDGE_SEARCH. "enableEventBasedSuggestion": True or False, # Automatically iterates all participants and tries to compile suggestions. Supported features: ARTICLE_SUGGESTION, FAQ, DIALOGFLOW_ASSIST, KNOWLEDGE_ASSIST. + "enableQuerySuggestionOnly": True or False, # Optional. Enable query suggestion only. Supported features: KNOWLEDGE_ASSIST + "enableQuerySuggestionWhenNoAnswer": True or False, # Optional. Enable query suggestion even if we can't find its answer. By default, queries are suggested only if we find its answer. Supported features: KNOWLEDGE_ASSIST "queryConfig": { # Config for suggestion query. # Configs of query. "confidenceThreshold": 3.14, # Confidence threshold of query result. Agent Assist gives each suggestion a score in the range [0.0, 1.0], based on the relevance between the suggestion and the current conversation context. A score of 0.0 has no relevance, while a score of 1.0 has high relevance. Only suggestions with a score greater than or equal to the value of this field are included in the results. For a baseline model (the default), the recommended value is in the range [0.05, 0.1]. For a custom model, there is no recommended value. Tune this value by starting from a very low value and slowly increasing until you have desired results. If this field is not set, it defaults to 0.0, which means that all suggestions are returned. Supported features: ARTICLE_SUGGESTION, FAQ, SMART_REPLY, SMART_COMPOSE, KNOWLEDGE_SEARCH, KNOWLEDGE_ASSIST, ENTITY_EXTRACTION. "contextFilterSettings": { # Settings that determine how to filter recent conversation context when generating suggestions. # Determines how recent conversation context is filtered when generating suggestions. If unspecified, no messages will be dropped. @@ -353,6 +359,7 @@

Method Details

"displayName": "A String", # Required. Human readable name for this profile. Max length 1024 bytes. "humanAgentAssistantConfig": { # Defines the Human Agent Assist to connect to a conversation. # Configuration for agent assistance to use with this profile. "endUserSuggestionConfig": { # Detail human agent assistant config. # Configuration for agent assistance of end user participant. Currently, this feature is not general available, please contact Google to get access. + "disableHighLatencyFeaturesSyncDelivery": True or False, # Optional. When disable_high_latency_features_sync_delivery is true and using the AnalyzeContent API, we will not deliver the responses from high latency features in the API response. The human_agent_assistant_config.notification_config must be configured and enable_event_based_suggestion must be set to true to receive the responses from high latency features in Pub/Sub. High latency feature(s): KNOWLEDGE_ASSIST. "featureConfigs": [ # Configuration of different suggestion features. One feature can have only one config. { # Config for suggestion features. "conversationModelConfig": { # Custom conversation models used in agent assist feature. Supported feature: ARTICLE_SUGGESTION, SMART_COMPOSE, SMART_REPLY, CONVERSATION_SUMMARIZATION. # Configs of custom conversation model. @@ -365,6 +372,8 @@

Method Details

"disableAgentQueryLogging": True or False, # Optional. Disable the logging of search queries sent by human agents. It can prevent those queries from being stored at answer records. Supported features: KNOWLEDGE_SEARCH. "enableConversationAugmentedQuery": True or False, # Optional. Enable including conversation context during query answer generation. Supported features: KNOWLEDGE_SEARCH. "enableEventBasedSuggestion": True or False, # Automatically iterates all participants and tries to compile suggestions. Supported features: ARTICLE_SUGGESTION, FAQ, DIALOGFLOW_ASSIST, KNOWLEDGE_ASSIST. + "enableQuerySuggestionOnly": True or False, # Optional. Enable query suggestion only. Supported features: KNOWLEDGE_ASSIST + "enableQuerySuggestionWhenNoAnswer": True or False, # Optional. Enable query suggestion even if we can't find its answer. By default, queries are suggested only if we find its answer. Supported features: KNOWLEDGE_ASSIST "queryConfig": { # Config for suggestion query. # Configs of query. "confidenceThreshold": 3.14, # Confidence threshold of query result. Agent Assist gives each suggestion a score in the range [0.0, 1.0], based on the relevance between the suggestion and the current conversation context. A score of 0.0 has no relevance, while a score of 1.0 has high relevance. Only suggestions with a score greater than or equal to the value of this field are included in the results. For a baseline model (the default), the recommended value is in the range [0.05, 0.1]. For a custom model, there is no recommended value. Tune this value by starting from a very low value and slowly increasing until you have desired results. If this field is not set, it defaults to 0.0, which means that all suggestions are returned. Supported features: ARTICLE_SUGGESTION, FAQ, SMART_REPLY, SMART_COMPOSE, KNOWLEDGE_SEARCH, KNOWLEDGE_ASSIST, ENTITY_EXTRACTION. "contextFilterSettings": { # Settings that determine how to filter recent conversation context when generating suggestions. # Determines how recent conversation context is filtered when generating suggestions. If unspecified, no messages will be dropped. @@ -410,6 +419,7 @@

Method Details

"groupSuggestionResponses": True or False, # If `group_suggestion_responses` is false, and there are multiple `feature_configs` in `event based suggestion` or StreamingAnalyzeContent, we will try to deliver suggestions to customers as soon as we get new suggestion. Different type of suggestions based on the same context will be in separate Pub/Sub event or `StreamingAnalyzeContentResponse`. If `group_suggestion_responses` set to true. All the suggestions to the same participant based on the same context will be grouped into a single Pub/Sub event or StreamingAnalyzeContentResponse. }, "humanAgentSuggestionConfig": { # Detail human agent assistant config. # Configuration for agent assistance of human agent participant. + "disableHighLatencyFeaturesSyncDelivery": True or False, # Optional. When disable_high_latency_features_sync_delivery is true and using the AnalyzeContent API, we will not deliver the responses from high latency features in the API response. The human_agent_assistant_config.notification_config must be configured and enable_event_based_suggestion must be set to true to receive the responses from high latency features in Pub/Sub. High latency feature(s): KNOWLEDGE_ASSIST. "featureConfigs": [ # Configuration of different suggestion features. One feature can have only one config. { # Config for suggestion features. "conversationModelConfig": { # Custom conversation models used in agent assist feature. Supported feature: ARTICLE_SUGGESTION, SMART_COMPOSE, SMART_REPLY, CONVERSATION_SUMMARIZATION. # Configs of custom conversation model. @@ -422,6 +432,8 @@

Method Details

"disableAgentQueryLogging": True or False, # Optional. Disable the logging of search queries sent by human agents. It can prevent those queries from being stored at answer records. Supported features: KNOWLEDGE_SEARCH. "enableConversationAugmentedQuery": True or False, # Optional. Enable including conversation context during query answer generation. Supported features: KNOWLEDGE_SEARCH. "enableEventBasedSuggestion": True or False, # Automatically iterates all participants and tries to compile suggestions. Supported features: ARTICLE_SUGGESTION, FAQ, DIALOGFLOW_ASSIST, KNOWLEDGE_ASSIST. + "enableQuerySuggestionOnly": True or False, # Optional. Enable query suggestion only. Supported features: KNOWLEDGE_ASSIST + "enableQuerySuggestionWhenNoAnswer": True or False, # Optional. Enable query suggestion even if we can't find its answer. By default, queries are suggested only if we find its answer. Supported features: KNOWLEDGE_ASSIST "queryConfig": { # Config for suggestion query. # Configs of query. "confidenceThreshold": 3.14, # Confidence threshold of query result. Agent Assist gives each suggestion a score in the range [0.0, 1.0], based on the relevance between the suggestion and the current conversation context. A score of 0.0 has no relevance, while a score of 1.0 has high relevance. Only suggestions with a score greater than or equal to the value of this field are included in the results. For a baseline model (the default), the recommended value is in the range [0.05, 0.1]. For a custom model, there is no recommended value. Tune this value by starting from a very low value and slowly increasing until you have desired results. If this field is not set, it defaults to 0.0, which means that all suggestions are returned. Supported features: ARTICLE_SUGGESTION, FAQ, SMART_REPLY, SMART_COMPOSE, KNOWLEDGE_SEARCH, KNOWLEDGE_ASSIST, ENTITY_EXTRACTION. "contextFilterSettings": { # Settings that determine how to filter recent conversation context when generating suggestions. # Determines how recent conversation context is filtered when generating suggestions. If unspecified, no messages will be dropped. @@ -563,6 +575,7 @@

Method Details

"displayName": "A String", # Required. Human readable name for this profile. Max length 1024 bytes. "humanAgentAssistantConfig": { # Defines the Human Agent Assist to connect to a conversation. # Configuration for agent assistance to use with this profile. "endUserSuggestionConfig": { # Detail human agent assistant config. # Configuration for agent assistance of end user participant. Currently, this feature is not general available, please contact Google to get access. + "disableHighLatencyFeaturesSyncDelivery": True or False, # Optional. When disable_high_latency_features_sync_delivery is true and using the AnalyzeContent API, we will not deliver the responses from high latency features in the API response. The human_agent_assistant_config.notification_config must be configured and enable_event_based_suggestion must be set to true to receive the responses from high latency features in Pub/Sub. High latency feature(s): KNOWLEDGE_ASSIST. "featureConfigs": [ # Configuration of different suggestion features. One feature can have only one config. { # Config for suggestion features. "conversationModelConfig": { # Custom conversation models used in agent assist feature. Supported feature: ARTICLE_SUGGESTION, SMART_COMPOSE, SMART_REPLY, CONVERSATION_SUMMARIZATION. # Configs of custom conversation model. @@ -575,6 +588,8 @@

Method Details

"disableAgentQueryLogging": True or False, # Optional. Disable the logging of search queries sent by human agents. It can prevent those queries from being stored at answer records. Supported features: KNOWLEDGE_SEARCH. "enableConversationAugmentedQuery": True or False, # Optional. Enable including conversation context during query answer generation. Supported features: KNOWLEDGE_SEARCH. "enableEventBasedSuggestion": True or False, # Automatically iterates all participants and tries to compile suggestions. Supported features: ARTICLE_SUGGESTION, FAQ, DIALOGFLOW_ASSIST, KNOWLEDGE_ASSIST. + "enableQuerySuggestionOnly": True or False, # Optional. Enable query suggestion only. Supported features: KNOWLEDGE_ASSIST + "enableQuerySuggestionWhenNoAnswer": True or False, # Optional. Enable query suggestion even if we can't find its answer. By default, queries are suggested only if we find its answer. Supported features: KNOWLEDGE_ASSIST "queryConfig": { # Config for suggestion query. # Configs of query. "confidenceThreshold": 3.14, # Confidence threshold of query result. Agent Assist gives each suggestion a score in the range [0.0, 1.0], based on the relevance between the suggestion and the current conversation context. A score of 0.0 has no relevance, while a score of 1.0 has high relevance. Only suggestions with a score greater than or equal to the value of this field are included in the results. For a baseline model (the default), the recommended value is in the range [0.05, 0.1]. For a custom model, there is no recommended value. Tune this value by starting from a very low value and slowly increasing until you have desired results. If this field is not set, it defaults to 0.0, which means that all suggestions are returned. Supported features: ARTICLE_SUGGESTION, FAQ, SMART_REPLY, SMART_COMPOSE, KNOWLEDGE_SEARCH, KNOWLEDGE_ASSIST, ENTITY_EXTRACTION. "contextFilterSettings": { # Settings that determine how to filter recent conversation context when generating suggestions. # Determines how recent conversation context is filtered when generating suggestions. If unspecified, no messages will be dropped. @@ -620,6 +635,7 @@

Method Details

"groupSuggestionResponses": True or False, # If `group_suggestion_responses` is false, and there are multiple `feature_configs` in `event based suggestion` or StreamingAnalyzeContent, we will try to deliver suggestions to customers as soon as we get new suggestion. Different type of suggestions based on the same context will be in separate Pub/Sub event or `StreamingAnalyzeContentResponse`. If `group_suggestion_responses` set to true. All the suggestions to the same participant based on the same context will be grouped into a single Pub/Sub event or StreamingAnalyzeContentResponse. }, "humanAgentSuggestionConfig": { # Detail human agent assistant config. # Configuration for agent assistance of human agent participant. + "disableHighLatencyFeaturesSyncDelivery": True or False, # Optional. When disable_high_latency_features_sync_delivery is true and using the AnalyzeContent API, we will not deliver the responses from high latency features in the API response. The human_agent_assistant_config.notification_config must be configured and enable_event_based_suggestion must be set to true to receive the responses from high latency features in Pub/Sub. High latency feature(s): KNOWLEDGE_ASSIST. "featureConfigs": [ # Configuration of different suggestion features. One feature can have only one config. { # Config for suggestion features. "conversationModelConfig": { # Custom conversation models used in agent assist feature. Supported feature: ARTICLE_SUGGESTION, SMART_COMPOSE, SMART_REPLY, CONVERSATION_SUMMARIZATION. # Configs of custom conversation model. @@ -632,6 +648,8 @@

Method Details

"disableAgentQueryLogging": True or False, # Optional. Disable the logging of search queries sent by human agents. It can prevent those queries from being stored at answer records. Supported features: KNOWLEDGE_SEARCH. "enableConversationAugmentedQuery": True or False, # Optional. Enable including conversation context during query answer generation. Supported features: KNOWLEDGE_SEARCH. "enableEventBasedSuggestion": True or False, # Automatically iterates all participants and tries to compile suggestions. Supported features: ARTICLE_SUGGESTION, FAQ, DIALOGFLOW_ASSIST, KNOWLEDGE_ASSIST. + "enableQuerySuggestionOnly": True or False, # Optional. Enable query suggestion only. Supported features: KNOWLEDGE_ASSIST + "enableQuerySuggestionWhenNoAnswer": True or False, # Optional. Enable query suggestion even if we can't find its answer. By default, queries are suggested only if we find its answer. Supported features: KNOWLEDGE_ASSIST "queryConfig": { # Config for suggestion query. # Configs of query. "confidenceThreshold": 3.14, # Confidence threshold of query result. Agent Assist gives each suggestion a score in the range [0.0, 1.0], based on the relevance between the suggestion and the current conversation context. A score of 0.0 has no relevance, while a score of 1.0 has high relevance. Only suggestions with a score greater than or equal to the value of this field are included in the results. For a baseline model (the default), the recommended value is in the range [0.05, 0.1]. For a custom model, there is no recommended value. Tune this value by starting from a very low value and slowly increasing until you have desired results. If this field is not set, it defaults to 0.0, which means that all suggestions are returned. Supported features: ARTICLE_SUGGESTION, FAQ, SMART_REPLY, SMART_COMPOSE, KNOWLEDGE_SEARCH, KNOWLEDGE_ASSIST, ENTITY_EXTRACTION. "contextFilterSettings": { # Settings that determine how to filter recent conversation context when generating suggestions. # Determines how recent conversation context is filtered when generating suggestions. If unspecified, no messages will be dropped. @@ -759,6 +777,7 @@

Method Details

"displayName": "A String", # Required. Human readable name for this profile. Max length 1024 bytes. "humanAgentAssistantConfig": { # Defines the Human Agent Assist to connect to a conversation. # Configuration for agent assistance to use with this profile. "endUserSuggestionConfig": { # Detail human agent assistant config. # Configuration for agent assistance of end user participant. Currently, this feature is not general available, please contact Google to get access. + "disableHighLatencyFeaturesSyncDelivery": True or False, # Optional. When disable_high_latency_features_sync_delivery is true and using the AnalyzeContent API, we will not deliver the responses from high latency features in the API response. The human_agent_assistant_config.notification_config must be configured and enable_event_based_suggestion must be set to true to receive the responses from high latency features in Pub/Sub. High latency feature(s): KNOWLEDGE_ASSIST. "featureConfigs": [ # Configuration of different suggestion features. One feature can have only one config. { # Config for suggestion features. "conversationModelConfig": { # Custom conversation models used in agent assist feature. Supported feature: ARTICLE_SUGGESTION, SMART_COMPOSE, SMART_REPLY, CONVERSATION_SUMMARIZATION. # Configs of custom conversation model. @@ -771,6 +790,8 @@

Method Details

"disableAgentQueryLogging": True or False, # Optional. Disable the logging of search queries sent by human agents. It can prevent those queries from being stored at answer records. Supported features: KNOWLEDGE_SEARCH. "enableConversationAugmentedQuery": True or False, # Optional. Enable including conversation context during query answer generation. Supported features: KNOWLEDGE_SEARCH. "enableEventBasedSuggestion": True or False, # Automatically iterates all participants and tries to compile suggestions. Supported features: ARTICLE_SUGGESTION, FAQ, DIALOGFLOW_ASSIST, KNOWLEDGE_ASSIST. + "enableQuerySuggestionOnly": True or False, # Optional. Enable query suggestion only. Supported features: KNOWLEDGE_ASSIST + "enableQuerySuggestionWhenNoAnswer": True or False, # Optional. Enable query suggestion even if we can't find its answer. By default, queries are suggested only if we find its answer. Supported features: KNOWLEDGE_ASSIST "queryConfig": { # Config for suggestion query. # Configs of query. "confidenceThreshold": 3.14, # Confidence threshold of query result. Agent Assist gives each suggestion a score in the range [0.0, 1.0], based on the relevance between the suggestion and the current conversation context. A score of 0.0 has no relevance, while a score of 1.0 has high relevance. Only suggestions with a score greater than or equal to the value of this field are included in the results. For a baseline model (the default), the recommended value is in the range [0.05, 0.1]. For a custom model, there is no recommended value. Tune this value by starting from a very low value and slowly increasing until you have desired results. If this field is not set, it defaults to 0.0, which means that all suggestions are returned. Supported features: ARTICLE_SUGGESTION, FAQ, SMART_REPLY, SMART_COMPOSE, KNOWLEDGE_SEARCH, KNOWLEDGE_ASSIST, ENTITY_EXTRACTION. "contextFilterSettings": { # Settings that determine how to filter recent conversation context when generating suggestions. # Determines how recent conversation context is filtered when generating suggestions. If unspecified, no messages will be dropped. @@ -816,6 +837,7 @@

Method Details

"groupSuggestionResponses": True or False, # If `group_suggestion_responses` is false, and there are multiple `feature_configs` in `event based suggestion` or StreamingAnalyzeContent, we will try to deliver suggestions to customers as soon as we get new suggestion. Different type of suggestions based on the same context will be in separate Pub/Sub event or `StreamingAnalyzeContentResponse`. If `group_suggestion_responses` set to true. All the suggestions to the same participant based on the same context will be grouped into a single Pub/Sub event or StreamingAnalyzeContentResponse. }, "humanAgentSuggestionConfig": { # Detail human agent assistant config. # Configuration for agent assistance of human agent participant. + "disableHighLatencyFeaturesSyncDelivery": True or False, # Optional. When disable_high_latency_features_sync_delivery is true and using the AnalyzeContent API, we will not deliver the responses from high latency features in the API response. The human_agent_assistant_config.notification_config must be configured and enable_event_based_suggestion must be set to true to receive the responses from high latency features in Pub/Sub. High latency feature(s): KNOWLEDGE_ASSIST. "featureConfigs": [ # Configuration of different suggestion features. One feature can have only one config. { # Config for suggestion features. "conversationModelConfig": { # Custom conversation models used in agent assist feature. Supported feature: ARTICLE_SUGGESTION, SMART_COMPOSE, SMART_REPLY, CONVERSATION_SUMMARIZATION. # Configs of custom conversation model. @@ -828,6 +850,8 @@

Method Details

"disableAgentQueryLogging": True or False, # Optional. Disable the logging of search queries sent by human agents. It can prevent those queries from being stored at answer records. Supported features: KNOWLEDGE_SEARCH. "enableConversationAugmentedQuery": True or False, # Optional. Enable including conversation context during query answer generation. Supported features: KNOWLEDGE_SEARCH. "enableEventBasedSuggestion": True or False, # Automatically iterates all participants and tries to compile suggestions. Supported features: ARTICLE_SUGGESTION, FAQ, DIALOGFLOW_ASSIST, KNOWLEDGE_ASSIST. + "enableQuerySuggestionOnly": True or False, # Optional. Enable query suggestion only. Supported features: KNOWLEDGE_ASSIST + "enableQuerySuggestionWhenNoAnswer": True or False, # Optional. Enable query suggestion even if we can't find its answer. By default, queries are suggested only if we find its answer. Supported features: KNOWLEDGE_ASSIST "queryConfig": { # Config for suggestion query. # Configs of query. "confidenceThreshold": 3.14, # Confidence threshold of query result. Agent Assist gives each suggestion a score in the range [0.0, 1.0], based on the relevance between the suggestion and the current conversation context. A score of 0.0 has no relevance, while a score of 1.0 has high relevance. Only suggestions with a score greater than or equal to the value of this field are included in the results. For a baseline model (the default), the recommended value is in the range [0.05, 0.1]. For a custom model, there is no recommended value. Tune this value by starting from a very low value and slowly increasing until you have desired results. If this field is not set, it defaults to 0.0, which means that all suggestions are returned. Supported features: ARTICLE_SUGGESTION, FAQ, SMART_REPLY, SMART_COMPOSE, KNOWLEDGE_SEARCH, KNOWLEDGE_ASSIST, ENTITY_EXTRACTION. "contextFilterSettings": { # Settings that determine how to filter recent conversation context when generating suggestions. # Determines how recent conversation context is filtered when generating suggestions. If unspecified, no messages will be dropped. @@ -963,6 +987,7 @@

Method Details

"displayName": "A String", # Required. Human readable name for this profile. Max length 1024 bytes. "humanAgentAssistantConfig": { # Defines the Human Agent Assist to connect to a conversation. # Configuration for agent assistance to use with this profile. "endUserSuggestionConfig": { # Detail human agent assistant config. # Configuration for agent assistance of end user participant. Currently, this feature is not general available, please contact Google to get access. + "disableHighLatencyFeaturesSyncDelivery": True or False, # Optional. When disable_high_latency_features_sync_delivery is true and using the AnalyzeContent API, we will not deliver the responses from high latency features in the API response. The human_agent_assistant_config.notification_config must be configured and enable_event_based_suggestion must be set to true to receive the responses from high latency features in Pub/Sub. High latency feature(s): KNOWLEDGE_ASSIST. "featureConfigs": [ # Configuration of different suggestion features. One feature can have only one config. { # Config for suggestion features. "conversationModelConfig": { # Custom conversation models used in agent assist feature. Supported feature: ARTICLE_SUGGESTION, SMART_COMPOSE, SMART_REPLY, CONVERSATION_SUMMARIZATION. # Configs of custom conversation model. @@ -975,6 +1000,8 @@

Method Details

"disableAgentQueryLogging": True or False, # Optional. Disable the logging of search queries sent by human agents. It can prevent those queries from being stored at answer records. Supported features: KNOWLEDGE_SEARCH. "enableConversationAugmentedQuery": True or False, # Optional. Enable including conversation context during query answer generation. Supported features: KNOWLEDGE_SEARCH. "enableEventBasedSuggestion": True or False, # Automatically iterates all participants and tries to compile suggestions. Supported features: ARTICLE_SUGGESTION, FAQ, DIALOGFLOW_ASSIST, KNOWLEDGE_ASSIST. + "enableQuerySuggestionOnly": True or False, # Optional. Enable query suggestion only. Supported features: KNOWLEDGE_ASSIST + "enableQuerySuggestionWhenNoAnswer": True or False, # Optional. Enable query suggestion even if we can't find its answer. By default, queries are suggested only if we find its answer. Supported features: KNOWLEDGE_ASSIST "queryConfig": { # Config for suggestion query. # Configs of query. "confidenceThreshold": 3.14, # Confidence threshold of query result. Agent Assist gives each suggestion a score in the range [0.0, 1.0], based on the relevance between the suggestion and the current conversation context. A score of 0.0 has no relevance, while a score of 1.0 has high relevance. Only suggestions with a score greater than or equal to the value of this field are included in the results. For a baseline model (the default), the recommended value is in the range [0.05, 0.1]. For a custom model, there is no recommended value. Tune this value by starting from a very low value and slowly increasing until you have desired results. If this field is not set, it defaults to 0.0, which means that all suggestions are returned. Supported features: ARTICLE_SUGGESTION, FAQ, SMART_REPLY, SMART_COMPOSE, KNOWLEDGE_SEARCH, KNOWLEDGE_ASSIST, ENTITY_EXTRACTION. "contextFilterSettings": { # Settings that determine how to filter recent conversation context when generating suggestions. # Determines how recent conversation context is filtered when generating suggestions. If unspecified, no messages will be dropped. @@ -1020,6 +1047,7 @@

Method Details

"groupSuggestionResponses": True or False, # If `group_suggestion_responses` is false, and there are multiple `feature_configs` in `event based suggestion` or StreamingAnalyzeContent, we will try to deliver suggestions to customers as soon as we get new suggestion. Different type of suggestions based on the same context will be in separate Pub/Sub event or `StreamingAnalyzeContentResponse`. If `group_suggestion_responses` set to true. All the suggestions to the same participant based on the same context will be grouped into a single Pub/Sub event or StreamingAnalyzeContentResponse. }, "humanAgentSuggestionConfig": { # Detail human agent assistant config. # Configuration for agent assistance of human agent participant. + "disableHighLatencyFeaturesSyncDelivery": True or False, # Optional. When disable_high_latency_features_sync_delivery is true and using the AnalyzeContent API, we will not deliver the responses from high latency features in the API response. The human_agent_assistant_config.notification_config must be configured and enable_event_based_suggestion must be set to true to receive the responses from high latency features in Pub/Sub. High latency feature(s): KNOWLEDGE_ASSIST. "featureConfigs": [ # Configuration of different suggestion features. One feature can have only one config. { # Config for suggestion features. "conversationModelConfig": { # Custom conversation models used in agent assist feature. Supported feature: ARTICLE_SUGGESTION, SMART_COMPOSE, SMART_REPLY, CONVERSATION_SUMMARIZATION. # Configs of custom conversation model. @@ -1032,6 +1060,8 @@

Method Details

"disableAgentQueryLogging": True or False, # Optional. Disable the logging of search queries sent by human agents. It can prevent those queries from being stored at answer records. Supported features: KNOWLEDGE_SEARCH. "enableConversationAugmentedQuery": True or False, # Optional. Enable including conversation context during query answer generation. Supported features: KNOWLEDGE_SEARCH. "enableEventBasedSuggestion": True or False, # Automatically iterates all participants and tries to compile suggestions. Supported features: ARTICLE_SUGGESTION, FAQ, DIALOGFLOW_ASSIST, KNOWLEDGE_ASSIST. + "enableQuerySuggestionOnly": True or False, # Optional. Enable query suggestion only. Supported features: KNOWLEDGE_ASSIST + "enableQuerySuggestionWhenNoAnswer": True or False, # Optional. Enable query suggestion even if we can't find its answer. By default, queries are suggested only if we find its answer. Supported features: KNOWLEDGE_ASSIST "queryConfig": { # Config for suggestion query. # Configs of query. "confidenceThreshold": 3.14, # Confidence threshold of query result. Agent Assist gives each suggestion a score in the range [0.0, 1.0], based on the relevance between the suggestion and the current conversation context. A score of 0.0 has no relevance, while a score of 1.0 has high relevance. Only suggestions with a score greater than or equal to the value of this field are included in the results. For a baseline model (the default), the recommended value is in the range [0.05, 0.1]. For a custom model, there is no recommended value. Tune this value by starting from a very low value and slowly increasing until you have desired results. If this field is not set, it defaults to 0.0, which means that all suggestions are returned. Supported features: ARTICLE_SUGGESTION, FAQ, SMART_REPLY, SMART_COMPOSE, KNOWLEDGE_SEARCH, KNOWLEDGE_ASSIST, ENTITY_EXTRACTION. "contextFilterSettings": { # Settings that determine how to filter recent conversation context when generating suggestions. # Determines how recent conversation context is filtered when generating suggestions. If unspecified, no messages will be dropped. @@ -1149,6 +1179,7 @@

Method Details

"displayName": "A String", # Required. Human readable name for this profile. Max length 1024 bytes. "humanAgentAssistantConfig": { # Defines the Human Agent Assist to connect to a conversation. # Configuration for agent assistance to use with this profile. "endUserSuggestionConfig": { # Detail human agent assistant config. # Configuration for agent assistance of end user participant. Currently, this feature is not general available, please contact Google to get access. + "disableHighLatencyFeaturesSyncDelivery": True or False, # Optional. When disable_high_latency_features_sync_delivery is true and using the AnalyzeContent API, we will not deliver the responses from high latency features in the API response. The human_agent_assistant_config.notification_config must be configured and enable_event_based_suggestion must be set to true to receive the responses from high latency features in Pub/Sub. High latency feature(s): KNOWLEDGE_ASSIST. "featureConfigs": [ # Configuration of different suggestion features. One feature can have only one config. { # Config for suggestion features. "conversationModelConfig": { # Custom conversation models used in agent assist feature. Supported feature: ARTICLE_SUGGESTION, SMART_COMPOSE, SMART_REPLY, CONVERSATION_SUMMARIZATION. # Configs of custom conversation model. @@ -1161,6 +1192,8 @@

Method Details

"disableAgentQueryLogging": True or False, # Optional. Disable the logging of search queries sent by human agents. It can prevent those queries from being stored at answer records. Supported features: KNOWLEDGE_SEARCH. "enableConversationAugmentedQuery": True or False, # Optional. Enable including conversation context during query answer generation. Supported features: KNOWLEDGE_SEARCH. "enableEventBasedSuggestion": True or False, # Automatically iterates all participants and tries to compile suggestions. Supported features: ARTICLE_SUGGESTION, FAQ, DIALOGFLOW_ASSIST, KNOWLEDGE_ASSIST. + "enableQuerySuggestionOnly": True or False, # Optional. Enable query suggestion only. Supported features: KNOWLEDGE_ASSIST + "enableQuerySuggestionWhenNoAnswer": True or False, # Optional. Enable query suggestion even if we can't find its answer. By default, queries are suggested only if we find its answer. Supported features: KNOWLEDGE_ASSIST "queryConfig": { # Config for suggestion query. # Configs of query. "confidenceThreshold": 3.14, # Confidence threshold of query result. Agent Assist gives each suggestion a score in the range [0.0, 1.0], based on the relevance between the suggestion and the current conversation context. A score of 0.0 has no relevance, while a score of 1.0 has high relevance. Only suggestions with a score greater than or equal to the value of this field are included in the results. For a baseline model (the default), the recommended value is in the range [0.05, 0.1]. For a custom model, there is no recommended value. Tune this value by starting from a very low value and slowly increasing until you have desired results. If this field is not set, it defaults to 0.0, which means that all suggestions are returned. Supported features: ARTICLE_SUGGESTION, FAQ, SMART_REPLY, SMART_COMPOSE, KNOWLEDGE_SEARCH, KNOWLEDGE_ASSIST, ENTITY_EXTRACTION. "contextFilterSettings": { # Settings that determine how to filter recent conversation context when generating suggestions. # Determines how recent conversation context is filtered when generating suggestions. If unspecified, no messages will be dropped. @@ -1206,6 +1239,7 @@

Method Details

"groupSuggestionResponses": True or False, # If `group_suggestion_responses` is false, and there are multiple `feature_configs` in `event based suggestion` or StreamingAnalyzeContent, we will try to deliver suggestions to customers as soon as we get new suggestion. Different type of suggestions based on the same context will be in separate Pub/Sub event or `StreamingAnalyzeContentResponse`. If `group_suggestion_responses` set to true. All the suggestions to the same participant based on the same context will be grouped into a single Pub/Sub event or StreamingAnalyzeContentResponse. }, "humanAgentSuggestionConfig": { # Detail human agent assistant config. # Configuration for agent assistance of human agent participant. + "disableHighLatencyFeaturesSyncDelivery": True or False, # Optional. When disable_high_latency_features_sync_delivery is true and using the AnalyzeContent API, we will not deliver the responses from high latency features in the API response. The human_agent_assistant_config.notification_config must be configured and enable_event_based_suggestion must be set to true to receive the responses from high latency features in Pub/Sub. High latency feature(s): KNOWLEDGE_ASSIST. "featureConfigs": [ # Configuration of different suggestion features. One feature can have only one config. { # Config for suggestion features. "conversationModelConfig": { # Custom conversation models used in agent assist feature. Supported feature: ARTICLE_SUGGESTION, SMART_COMPOSE, SMART_REPLY, CONVERSATION_SUMMARIZATION. # Configs of custom conversation model. @@ -1218,6 +1252,8 @@

Method Details

"disableAgentQueryLogging": True or False, # Optional. Disable the logging of search queries sent by human agents. It can prevent those queries from being stored at answer records. Supported features: KNOWLEDGE_SEARCH. "enableConversationAugmentedQuery": True or False, # Optional. Enable including conversation context during query answer generation. Supported features: KNOWLEDGE_SEARCH. "enableEventBasedSuggestion": True or False, # Automatically iterates all participants and tries to compile suggestions. Supported features: ARTICLE_SUGGESTION, FAQ, DIALOGFLOW_ASSIST, KNOWLEDGE_ASSIST. + "enableQuerySuggestionOnly": True or False, # Optional. Enable query suggestion only. Supported features: KNOWLEDGE_ASSIST + "enableQuerySuggestionWhenNoAnswer": True or False, # Optional. Enable query suggestion even if we can't find its answer. By default, queries are suggested only if we find its answer. Supported features: KNOWLEDGE_ASSIST "queryConfig": { # Config for suggestion query. # Configs of query. "confidenceThreshold": 3.14, # Confidence threshold of query result. Agent Assist gives each suggestion a score in the range [0.0, 1.0], based on the relevance between the suggestion and the current conversation context. A score of 0.0 has no relevance, while a score of 1.0 has high relevance. Only suggestions with a score greater than or equal to the value of this field are included in the results. For a baseline model (the default), the recommended value is in the range [0.05, 0.1]. For a custom model, there is no recommended value. Tune this value by starting from a very low value and slowly increasing until you have desired results. If this field is not set, it defaults to 0.0, which means that all suggestions are returned. Supported features: ARTICLE_SUGGESTION, FAQ, SMART_REPLY, SMART_COMPOSE, KNOWLEDGE_SEARCH, KNOWLEDGE_ASSIST, ENTITY_EXTRACTION. "contextFilterSettings": { # Settings that determine how to filter recent conversation context when generating suggestions. # Determines how recent conversation context is filtered when generating suggestions. If unspecified, no messages will be dropped. @@ -1340,6 +1376,8 @@

Method Details

"disableAgentQueryLogging": True or False, # Optional. Disable the logging of search queries sent by human agents. It can prevent those queries from being stored at answer records. Supported features: KNOWLEDGE_SEARCH. "enableConversationAugmentedQuery": True or False, # Optional. Enable including conversation context during query answer generation. Supported features: KNOWLEDGE_SEARCH. "enableEventBasedSuggestion": True or False, # Automatically iterates all participants and tries to compile suggestions. Supported features: ARTICLE_SUGGESTION, FAQ, DIALOGFLOW_ASSIST, KNOWLEDGE_ASSIST. + "enableQuerySuggestionOnly": True or False, # Optional. Enable query suggestion only. Supported features: KNOWLEDGE_ASSIST + "enableQuerySuggestionWhenNoAnswer": True or False, # Optional. Enable query suggestion even if we can't find its answer. By default, queries are suggested only if we find its answer. Supported features: KNOWLEDGE_ASSIST "queryConfig": { # Config for suggestion query. # Configs of query. "confidenceThreshold": 3.14, # Confidence threshold of query result. Agent Assist gives each suggestion a score in the range [0.0, 1.0], based on the relevance between the suggestion and the current conversation context. A score of 0.0 has no relevance, while a score of 1.0 has high relevance. Only suggestions with a score greater than or equal to the value of this field are included in the results. For a baseline model (the default), the recommended value is in the range [0.05, 0.1]. For a custom model, there is no recommended value. Tune this value by starting from a very low value and slowly increasing until you have desired results. If this field is not set, it defaults to 0.0, which means that all suggestions are returned. Supported features: ARTICLE_SUGGESTION, FAQ, SMART_REPLY, SMART_COMPOSE, KNOWLEDGE_SEARCH, KNOWLEDGE_ASSIST, ENTITY_EXTRACTION. "contextFilterSettings": { # Settings that determine how to filter recent conversation context when generating suggestions. # Determines how recent conversation context is filtered when generating suggestions. If unspecified, no messages will be dropped. diff --git a/docs/dyn/dialogflow_v2.projects.conversations.participants.html b/docs/dyn/dialogflow_v2.projects.conversations.participants.html index 588e2cfe102..db49f4e466d 100644 --- a/docs/dyn/dialogflow_v2.projects.conversations.participants.html +++ b/docs/dyn/dialogflow_v2.projects.conversations.participants.html @@ -740,6 +740,31 @@

Method Details

], "latestMessage": "A String", # The name of the latest conversation message used to compile suggestion for. Format: `projects//locations//conversations//messages/`. }, + "suggestKnowledgeAssistResponse": { # The response message for Participants.SuggestKnowledgeAssist. # SuggestKnowledgeAssistResponse if request is for KNOWLEDGE_ASSIST. + "contextSize": 42, # Number of messages prior to and including latest_message to compile the suggestion. It may be smaller than the SuggestKnowledgeAssistRequest.context_size field in the request if there are fewer messages in the conversation. + "knowledgeAssistAnswer": { # Represents a Knowledge Assist answer. # Output only. Knowledge Assist suggestion. + "answerRecord": "A String", # The name of the answer record. Format: `projects//locations//answer Records/`. + "suggestedQuery": { # Represents a suggested query. # The query suggested based on the context. Suggestion is made only if it is different from the previous suggestion. + "queryText": "A String", # Suggested query text. + }, + "suggestedQueryAnswer": { # Represents an answer from Knowledge. Currently supports FAQ and Generative answers. # The answer generated for the suggested query. Whether or not an answer is generated depends on how confident we are about the generated query. + "answerText": "A String", # The piece of text from the `source` that answers this suggested query. + "faqSource": { # Details about source of FAQ answer. # Populated if the prediction came from FAQ. + "question": "A String", # The corresponding FAQ question. + }, + "generativeSource": { # Details about source of Generative answer. # Populated if the prediction was Generative. + "snippets": [ # All snippets used for this Generative Prediction, with their source URI and data. + { # Snippet Source for a Generative Prediction. + "text": "A String", # Text taken from that URI. + "title": "A String", # Title of the document. + "uri": "A String", # URI the data is sourced from. + }, + ], + }, + }, + }, + "latestMessage": "A String", # The name of the latest conversation message used to compile suggestion for. Format: `projects//locations//conversations//messages/`. + }, "suggestSmartRepliesResponse": { # The response message for Participants.SuggestSmartReplies. # SuggestSmartRepliesResponse if request is for SMART_REPLY. "contextSize": 42, # Number of messages prior to and including latest_message to compile the suggestion. It may be smaller than the SuggestSmartRepliesRequest.context_size field in the request if there aren't that many messages in the conversation. "latestMessage": "A String", # The name of the latest conversation message used to compile suggestion for. Format: `projects//locations//conversations//messages/`. @@ -798,6 +823,31 @@

Method Details

], "latestMessage": "A String", # The name of the latest conversation message used to compile suggestion for. Format: `projects//locations//conversations//messages/`. }, + "suggestKnowledgeAssistResponse": { # The response message for Participants.SuggestKnowledgeAssist. # SuggestKnowledgeAssistResponse if request is for KNOWLEDGE_ASSIST. + "contextSize": 42, # Number of messages prior to and including latest_message to compile the suggestion. It may be smaller than the SuggestKnowledgeAssistRequest.context_size field in the request if there are fewer messages in the conversation. + "knowledgeAssistAnswer": { # Represents a Knowledge Assist answer. # Output only. Knowledge Assist suggestion. + "answerRecord": "A String", # The name of the answer record. Format: `projects//locations//answer Records/`. + "suggestedQuery": { # Represents a suggested query. # The query suggested based on the context. Suggestion is made only if it is different from the previous suggestion. + "queryText": "A String", # Suggested query text. + }, + "suggestedQueryAnswer": { # Represents an answer from Knowledge. Currently supports FAQ and Generative answers. # The answer generated for the suggested query. Whether or not an answer is generated depends on how confident we are about the generated query. + "answerText": "A String", # The piece of text from the `source` that answers this suggested query. + "faqSource": { # Details about source of FAQ answer. # Populated if the prediction came from FAQ. + "question": "A String", # The corresponding FAQ question. + }, + "generativeSource": { # Details about source of Generative answer. # Populated if the prediction was Generative. + "snippets": [ # All snippets used for this Generative Prediction, with their source URI and data. + { # Snippet Source for a Generative Prediction. + "text": "A String", # Text taken from that URI. + "title": "A String", # Title of the document. + "uri": "A String", # URI the data is sourced from. + }, + ], + }, + }, + }, + "latestMessage": "A String", # The name of the latest conversation message used to compile suggestion for. Format: `projects//locations//conversations//messages/`. + }, "suggestSmartRepliesResponse": { # The response message for Participants.SuggestSmartReplies. # SuggestSmartRepliesResponse if request is for SMART_REPLY. "contextSize": 42, # Number of messages prior to and including latest_message to compile the suggestion. It may be smaller than the SuggestSmartRepliesRequest.context_size field in the request if there aren't that many messages in the conversation. "latestMessage": "A String", # The name of the latest conversation message used to compile suggestion for. Format: `projects//locations//conversations//messages/`. diff --git a/docs/dyn/dialogflow_v2.projects.conversations.participants.suggestions.html b/docs/dyn/dialogflow_v2.projects.conversations.participants.suggestions.html index 6bae88db3bc..9cb090992b0 100644 --- a/docs/dyn/dialogflow_v2.projects.conversations.participants.suggestions.html +++ b/docs/dyn/dialogflow_v2.projects.conversations.participants.suggestions.html @@ -83,6 +83,9 @@

Instance Methods

suggestFaqAnswers(parent, body=None, x__xgafv=None)

Gets suggested faq answers for a participant based on specific historical messages.

+

+ suggestKnowledgeAssist(parent, body=None, x__xgafv=None)

+

Gets knowledge assist suggestions based on historical messages.

suggestSmartReplies(parent, body=None, x__xgafv=None)

Gets smart replies for a participant based on specific historical messages.

@@ -184,6 +187,56 @@

Method Details

}
+
+ suggestKnowledgeAssist(parent, body=None, x__xgafv=None) +
Gets knowledge assist suggestions based on historical messages.
+
+Args:
+  parent: string, Required. The name of the participant to fetch suggestions for. Format: `projects//locations//conversations//participants/`. (required)
+  body: object, The request body.
+    The object takes the form of:
+
+{ # The request message for Participants.SuggestKnowledgeAssist.
+  "contextSize": 42, # Optional. Max number of messages prior to and including latest_message to use as context when compiling the suggestion. The context size is by default 100 and at most 100.
+  "latestMessage": "A String", # Optional. The name of the latest conversation message to compile suggestions for. If empty, it will be the latest message of the conversation. Format: `projects//locations//conversations//messages/`.
+  "previousSuggestedQuery": "A String", # Optional. The previously suggested query for the given conversation. This helps identify whether the next suggestion we generate is resonably different from the previous one. This is useful to avoid similar suggestions within the conversation.
+}
+
+  x__xgafv: string, V1 error format.
+    Allowed values
+      1 - v1 error format
+      2 - v2 error format
+
+Returns:
+  An object of the form:
+
+    { # The response message for Participants.SuggestKnowledgeAssist.
+  "contextSize": 42, # Number of messages prior to and including latest_message to compile the suggestion. It may be smaller than the SuggestKnowledgeAssistRequest.context_size field in the request if there are fewer messages in the conversation.
+  "knowledgeAssistAnswer": { # Represents a Knowledge Assist answer. # Output only. Knowledge Assist suggestion.
+    "answerRecord": "A String", # The name of the answer record. Format: `projects//locations//answer Records/`.
+    "suggestedQuery": { # Represents a suggested query. # The query suggested based on the context. Suggestion is made only if it is different from the previous suggestion.
+      "queryText": "A String", # Suggested query text.
+    },
+    "suggestedQueryAnswer": { # Represents an answer from Knowledge. Currently supports FAQ and Generative answers. # The answer generated for the suggested query. Whether or not an answer is generated depends on how confident we are about the generated query.
+      "answerText": "A String", # The piece of text from the `source` that answers this suggested query.
+      "faqSource": { # Details about source of FAQ answer. # Populated if the prediction came from FAQ.
+        "question": "A String", # The corresponding FAQ question.
+      },
+      "generativeSource": { # Details about source of Generative answer. # Populated if the prediction was Generative.
+        "snippets": [ # All snippets used for this Generative Prediction, with their source URI and data.
+          { # Snippet Source for a Generative Prediction.
+            "text": "A String", # Text taken from that URI.
+            "title": "A String", # Title of the document.
+            "uri": "A String", # URI the data is sourced from.
+          },
+        ],
+      },
+    },
+  },
+  "latestMessage": "A String", # The name of the latest conversation message used to compile suggestion for. Format: `projects//locations//conversations//messages/`.
+}
+
+
suggestSmartReplies(parent, body=None, x__xgafv=None)
Gets smart replies for a participant based on specific historical messages.
diff --git a/docs/dyn/dialogflow_v2.projects.locations.answerRecords.html b/docs/dyn/dialogflow_v2.projects.locations.answerRecords.html
index da9a0dda3f7..957e1671ed3 100644
--- a/docs/dyn/dialogflow_v2.projects.locations.answerRecords.html
+++ b/docs/dyn/dialogflow_v2.projects.locations.answerRecords.html
@@ -605,6 +605,12 @@ 

Method Details

"answerRelevance": "A String", # Optional. Whether or not the suggested answer is relevant. For example: * Query: "Can I change my mailing address?" * Suggested document says: "Items must be returned/exchanged within 60 days of the purchase date." * answer_relevance: AnswerRelevance.IRRELEVANT "documentCorrectness": "A String", # Optional. Whether or not the information in the document is correct. For example: * Query: "Can I return the package in 2 days once received?" * Suggested document says: "Items must be returned/exchanged within 60 days of the purchase date." * Ground truth: "No return or exchange is allowed." * [document_correctness]: INCORRECT "documentEfficiency": "A String", # Optional. Whether or not the suggested document is efficient. For example, if the document is poorly written, hard to understand, hard to use or too long to find useful information, document_efficiency is DocumentEfficiency.INEFFICIENT. + "knowledgeAssistFeedback": { # Feedback for knowledge assist. # Optional. Feedback for knowledge assist. + "answerCopied": True or False, # Whether the suggested answer was copied by the human agent. If the value is set to be true, AnswerFeedback.clicked will be updated to be true. + "clickedUris": [ # The URIs clicked by the human agent. The value is appended for each UpdateAnswerRecordRequest. If the value is not empty, AnswerFeedback.clicked will be updated to be true. + "A String", + ], + }, "knowledgeSearchFeedback": { # Feedback for knowledge search. # Optional. Feedback for knowledge search. "answerCopied": True or False, # Whether the answer was copied by the human agent or not. If the value is set to be true, AnswerFeedback.clicked will be updated to be true. "clickedUris": [ # The URIs clicked by the human agent. The value is appended for each UpdateAnswerRecordRequest. If the value is not empty, AnswerFeedback.clicked will be updated to be true. @@ -1150,6 +1156,12 @@

Method Details

"answerRelevance": "A String", # Optional. Whether or not the suggested answer is relevant. For example: * Query: "Can I change my mailing address?" * Suggested document says: "Items must be returned/exchanged within 60 days of the purchase date." * answer_relevance: AnswerRelevance.IRRELEVANT "documentCorrectness": "A String", # Optional. Whether or not the information in the document is correct. For example: * Query: "Can I return the package in 2 days once received?" * Suggested document says: "Items must be returned/exchanged within 60 days of the purchase date." * Ground truth: "No return or exchange is allowed." * [document_correctness]: INCORRECT "documentEfficiency": "A String", # Optional. Whether or not the suggested document is efficient. For example, if the document is poorly written, hard to understand, hard to use or too long to find useful information, document_efficiency is DocumentEfficiency.INEFFICIENT. + "knowledgeAssistFeedback": { # Feedback for knowledge assist. # Optional. Feedback for knowledge assist. + "answerCopied": True or False, # Whether the suggested answer was copied by the human agent. If the value is set to be true, AnswerFeedback.clicked will be updated to be true. + "clickedUris": [ # The URIs clicked by the human agent. The value is appended for each UpdateAnswerRecordRequest. If the value is not empty, AnswerFeedback.clicked will be updated to be true. + "A String", + ], + }, "knowledgeSearchFeedback": { # Feedback for knowledge search. # Optional. Feedback for knowledge search. "answerCopied": True or False, # Whether the answer was copied by the human agent or not. If the value is set to be true, AnswerFeedback.clicked will be updated to be true. "clickedUris": [ # The URIs clicked by the human agent. The value is appended for each UpdateAnswerRecordRequest. If the value is not empty, AnswerFeedback.clicked will be updated to be true. @@ -1677,6 +1689,12 @@

Method Details

"answerRelevance": "A String", # Optional. Whether or not the suggested answer is relevant. For example: * Query: "Can I change my mailing address?" * Suggested document says: "Items must be returned/exchanged within 60 days of the purchase date." * answer_relevance: AnswerRelevance.IRRELEVANT "documentCorrectness": "A String", # Optional. Whether or not the information in the document is correct. For example: * Query: "Can I return the package in 2 days once received?" * Suggested document says: "Items must be returned/exchanged within 60 days of the purchase date." * Ground truth: "No return or exchange is allowed." * [document_correctness]: INCORRECT "documentEfficiency": "A String", # Optional. Whether or not the suggested document is efficient. For example, if the document is poorly written, hard to understand, hard to use or too long to find useful information, document_efficiency is DocumentEfficiency.INEFFICIENT. + "knowledgeAssistFeedback": { # Feedback for knowledge assist. # Optional. Feedback for knowledge assist. + "answerCopied": True or False, # Whether the suggested answer was copied by the human agent. If the value is set to be true, AnswerFeedback.clicked will be updated to be true. + "clickedUris": [ # The URIs clicked by the human agent. The value is appended for each UpdateAnswerRecordRequest. If the value is not empty, AnswerFeedback.clicked will be updated to be true. + "A String", + ], + }, "knowledgeSearchFeedback": { # Feedback for knowledge search. # Optional. Feedback for knowledge search. "answerCopied": True or False, # Whether the answer was copied by the human agent or not. If the value is set to be true, AnswerFeedback.clicked will be updated to be true. "clickedUris": [ # The URIs clicked by the human agent. The value is appended for each UpdateAnswerRecordRequest. If the value is not empty, AnswerFeedback.clicked will be updated to be true. diff --git a/docs/dyn/dialogflow_v2.projects.locations.conversationProfiles.html b/docs/dyn/dialogflow_v2.projects.locations.conversationProfiles.html index 16ef84b53ad..3d514fb4958 100644 --- a/docs/dyn/dialogflow_v2.projects.locations.conversationProfiles.html +++ b/docs/dyn/dialogflow_v2.projects.locations.conversationProfiles.html @@ -168,6 +168,7 @@

Method Details

"displayName": "A String", # Required. Human readable name for this profile. Max length 1024 bytes. "humanAgentAssistantConfig": { # Defines the Human Agent Assist to connect to a conversation. # Configuration for agent assistance to use with this profile. "endUserSuggestionConfig": { # Detail human agent assistant config. # Configuration for agent assistance of end user participant. Currently, this feature is not general available, please contact Google to get access. + "disableHighLatencyFeaturesSyncDelivery": True or False, # Optional. When disable_high_latency_features_sync_delivery is true and using the AnalyzeContent API, we will not deliver the responses from high latency features in the API response. The human_agent_assistant_config.notification_config must be configured and enable_event_based_suggestion must be set to true to receive the responses from high latency features in Pub/Sub. High latency feature(s): KNOWLEDGE_ASSIST. "featureConfigs": [ # Configuration of different suggestion features. One feature can have only one config. { # Config for suggestion features. "conversationModelConfig": { # Custom conversation models used in agent assist feature. Supported feature: ARTICLE_SUGGESTION, SMART_COMPOSE, SMART_REPLY, CONVERSATION_SUMMARIZATION. # Configs of custom conversation model. @@ -180,6 +181,8 @@

Method Details

"disableAgentQueryLogging": True or False, # Optional. Disable the logging of search queries sent by human agents. It can prevent those queries from being stored at answer records. Supported features: KNOWLEDGE_SEARCH. "enableConversationAugmentedQuery": True or False, # Optional. Enable including conversation context during query answer generation. Supported features: KNOWLEDGE_SEARCH. "enableEventBasedSuggestion": True or False, # Automatically iterates all participants and tries to compile suggestions. Supported features: ARTICLE_SUGGESTION, FAQ, DIALOGFLOW_ASSIST, KNOWLEDGE_ASSIST. + "enableQuerySuggestionOnly": True or False, # Optional. Enable query suggestion only. Supported features: KNOWLEDGE_ASSIST + "enableQuerySuggestionWhenNoAnswer": True or False, # Optional. Enable query suggestion even if we can't find its answer. By default, queries are suggested only if we find its answer. Supported features: KNOWLEDGE_ASSIST "queryConfig": { # Config for suggestion query. # Configs of query. "confidenceThreshold": 3.14, # Confidence threshold of query result. Agent Assist gives each suggestion a score in the range [0.0, 1.0], based on the relevance between the suggestion and the current conversation context. A score of 0.0 has no relevance, while a score of 1.0 has high relevance. Only suggestions with a score greater than or equal to the value of this field are included in the results. For a baseline model (the default), the recommended value is in the range [0.05, 0.1]. For a custom model, there is no recommended value. Tune this value by starting from a very low value and slowly increasing until you have desired results. If this field is not set, it defaults to 0.0, which means that all suggestions are returned. Supported features: ARTICLE_SUGGESTION, FAQ, SMART_REPLY, SMART_COMPOSE, KNOWLEDGE_SEARCH, KNOWLEDGE_ASSIST, ENTITY_EXTRACTION. "contextFilterSettings": { # Settings that determine how to filter recent conversation context when generating suggestions. # Determines how recent conversation context is filtered when generating suggestions. If unspecified, no messages will be dropped. @@ -225,6 +228,7 @@

Method Details

"groupSuggestionResponses": True or False, # If `group_suggestion_responses` is false, and there are multiple `feature_configs` in `event based suggestion` or StreamingAnalyzeContent, we will try to deliver suggestions to customers as soon as we get new suggestion. Different type of suggestions based on the same context will be in separate Pub/Sub event or `StreamingAnalyzeContentResponse`. If `group_suggestion_responses` set to true. All the suggestions to the same participant based on the same context will be grouped into a single Pub/Sub event or StreamingAnalyzeContentResponse. }, "humanAgentSuggestionConfig": { # Detail human agent assistant config. # Configuration for agent assistance of human agent participant. + "disableHighLatencyFeaturesSyncDelivery": True or False, # Optional. When disable_high_latency_features_sync_delivery is true and using the AnalyzeContent API, we will not deliver the responses from high latency features in the API response. The human_agent_assistant_config.notification_config must be configured and enable_event_based_suggestion must be set to true to receive the responses from high latency features in Pub/Sub. High latency feature(s): KNOWLEDGE_ASSIST. "featureConfigs": [ # Configuration of different suggestion features. One feature can have only one config. { # Config for suggestion features. "conversationModelConfig": { # Custom conversation models used in agent assist feature. Supported feature: ARTICLE_SUGGESTION, SMART_COMPOSE, SMART_REPLY, CONVERSATION_SUMMARIZATION. # Configs of custom conversation model. @@ -237,6 +241,8 @@

Method Details

"disableAgentQueryLogging": True or False, # Optional. Disable the logging of search queries sent by human agents. It can prevent those queries from being stored at answer records. Supported features: KNOWLEDGE_SEARCH. "enableConversationAugmentedQuery": True or False, # Optional. Enable including conversation context during query answer generation. Supported features: KNOWLEDGE_SEARCH. "enableEventBasedSuggestion": True or False, # Automatically iterates all participants and tries to compile suggestions. Supported features: ARTICLE_SUGGESTION, FAQ, DIALOGFLOW_ASSIST, KNOWLEDGE_ASSIST. + "enableQuerySuggestionOnly": True or False, # Optional. Enable query suggestion only. Supported features: KNOWLEDGE_ASSIST + "enableQuerySuggestionWhenNoAnswer": True or False, # Optional. Enable query suggestion even if we can't find its answer. By default, queries are suggested only if we find its answer. Supported features: KNOWLEDGE_ASSIST "queryConfig": { # Config for suggestion query. # Configs of query. "confidenceThreshold": 3.14, # Confidence threshold of query result. Agent Assist gives each suggestion a score in the range [0.0, 1.0], based on the relevance between the suggestion and the current conversation context. A score of 0.0 has no relevance, while a score of 1.0 has high relevance. Only suggestions with a score greater than or equal to the value of this field are included in the results. For a baseline model (the default), the recommended value is in the range [0.05, 0.1]. For a custom model, there is no recommended value. Tune this value by starting from a very low value and slowly increasing until you have desired results. If this field is not set, it defaults to 0.0, which means that all suggestions are returned. Supported features: ARTICLE_SUGGESTION, FAQ, SMART_REPLY, SMART_COMPOSE, KNOWLEDGE_SEARCH, KNOWLEDGE_ASSIST, ENTITY_EXTRACTION. "contextFilterSettings": { # Settings that determine how to filter recent conversation context when generating suggestions. # Determines how recent conversation context is filtered when generating suggestions. If unspecified, no messages will be dropped. @@ -353,6 +359,7 @@

Method Details

"displayName": "A String", # Required. Human readable name for this profile. Max length 1024 bytes. "humanAgentAssistantConfig": { # Defines the Human Agent Assist to connect to a conversation. # Configuration for agent assistance to use with this profile. "endUserSuggestionConfig": { # Detail human agent assistant config. # Configuration for agent assistance of end user participant. Currently, this feature is not general available, please contact Google to get access. + "disableHighLatencyFeaturesSyncDelivery": True or False, # Optional. When disable_high_latency_features_sync_delivery is true and using the AnalyzeContent API, we will not deliver the responses from high latency features in the API response. The human_agent_assistant_config.notification_config must be configured and enable_event_based_suggestion must be set to true to receive the responses from high latency features in Pub/Sub. High latency feature(s): KNOWLEDGE_ASSIST. "featureConfigs": [ # Configuration of different suggestion features. One feature can have only one config. { # Config for suggestion features. "conversationModelConfig": { # Custom conversation models used in agent assist feature. Supported feature: ARTICLE_SUGGESTION, SMART_COMPOSE, SMART_REPLY, CONVERSATION_SUMMARIZATION. # Configs of custom conversation model. @@ -365,6 +372,8 @@

Method Details

"disableAgentQueryLogging": True or False, # Optional. Disable the logging of search queries sent by human agents. It can prevent those queries from being stored at answer records. Supported features: KNOWLEDGE_SEARCH. "enableConversationAugmentedQuery": True or False, # Optional. Enable including conversation context during query answer generation. Supported features: KNOWLEDGE_SEARCH. "enableEventBasedSuggestion": True or False, # Automatically iterates all participants and tries to compile suggestions. Supported features: ARTICLE_SUGGESTION, FAQ, DIALOGFLOW_ASSIST, KNOWLEDGE_ASSIST. + "enableQuerySuggestionOnly": True or False, # Optional. Enable query suggestion only. Supported features: KNOWLEDGE_ASSIST + "enableQuerySuggestionWhenNoAnswer": True or False, # Optional. Enable query suggestion even if we can't find its answer. By default, queries are suggested only if we find its answer. Supported features: KNOWLEDGE_ASSIST "queryConfig": { # Config for suggestion query. # Configs of query. "confidenceThreshold": 3.14, # Confidence threshold of query result. Agent Assist gives each suggestion a score in the range [0.0, 1.0], based on the relevance between the suggestion and the current conversation context. A score of 0.0 has no relevance, while a score of 1.0 has high relevance. Only suggestions with a score greater than or equal to the value of this field are included in the results. For a baseline model (the default), the recommended value is in the range [0.05, 0.1]. For a custom model, there is no recommended value. Tune this value by starting from a very low value and slowly increasing until you have desired results. If this field is not set, it defaults to 0.0, which means that all suggestions are returned. Supported features: ARTICLE_SUGGESTION, FAQ, SMART_REPLY, SMART_COMPOSE, KNOWLEDGE_SEARCH, KNOWLEDGE_ASSIST, ENTITY_EXTRACTION. "contextFilterSettings": { # Settings that determine how to filter recent conversation context when generating suggestions. # Determines how recent conversation context is filtered when generating suggestions. If unspecified, no messages will be dropped. @@ -410,6 +419,7 @@

Method Details

"groupSuggestionResponses": True or False, # If `group_suggestion_responses` is false, and there are multiple `feature_configs` in `event based suggestion` or StreamingAnalyzeContent, we will try to deliver suggestions to customers as soon as we get new suggestion. Different type of suggestions based on the same context will be in separate Pub/Sub event or `StreamingAnalyzeContentResponse`. If `group_suggestion_responses` set to true. All the suggestions to the same participant based on the same context will be grouped into a single Pub/Sub event or StreamingAnalyzeContentResponse. }, "humanAgentSuggestionConfig": { # Detail human agent assistant config. # Configuration for agent assistance of human agent participant. + "disableHighLatencyFeaturesSyncDelivery": True or False, # Optional. When disable_high_latency_features_sync_delivery is true and using the AnalyzeContent API, we will not deliver the responses from high latency features in the API response. The human_agent_assistant_config.notification_config must be configured and enable_event_based_suggestion must be set to true to receive the responses from high latency features in Pub/Sub. High latency feature(s): KNOWLEDGE_ASSIST. "featureConfigs": [ # Configuration of different suggestion features. One feature can have only one config. { # Config for suggestion features. "conversationModelConfig": { # Custom conversation models used in agent assist feature. Supported feature: ARTICLE_SUGGESTION, SMART_COMPOSE, SMART_REPLY, CONVERSATION_SUMMARIZATION. # Configs of custom conversation model. @@ -422,6 +432,8 @@

Method Details

"disableAgentQueryLogging": True or False, # Optional. Disable the logging of search queries sent by human agents. It can prevent those queries from being stored at answer records. Supported features: KNOWLEDGE_SEARCH. "enableConversationAugmentedQuery": True or False, # Optional. Enable including conversation context during query answer generation. Supported features: KNOWLEDGE_SEARCH. "enableEventBasedSuggestion": True or False, # Automatically iterates all participants and tries to compile suggestions. Supported features: ARTICLE_SUGGESTION, FAQ, DIALOGFLOW_ASSIST, KNOWLEDGE_ASSIST. + "enableQuerySuggestionOnly": True or False, # Optional. Enable query suggestion only. Supported features: KNOWLEDGE_ASSIST + "enableQuerySuggestionWhenNoAnswer": True or False, # Optional. Enable query suggestion even if we can't find its answer. By default, queries are suggested only if we find its answer. Supported features: KNOWLEDGE_ASSIST "queryConfig": { # Config for suggestion query. # Configs of query. "confidenceThreshold": 3.14, # Confidence threshold of query result. Agent Assist gives each suggestion a score in the range [0.0, 1.0], based on the relevance between the suggestion and the current conversation context. A score of 0.0 has no relevance, while a score of 1.0 has high relevance. Only suggestions with a score greater than or equal to the value of this field are included in the results. For a baseline model (the default), the recommended value is in the range [0.05, 0.1]. For a custom model, there is no recommended value. Tune this value by starting from a very low value and slowly increasing until you have desired results. If this field is not set, it defaults to 0.0, which means that all suggestions are returned. Supported features: ARTICLE_SUGGESTION, FAQ, SMART_REPLY, SMART_COMPOSE, KNOWLEDGE_SEARCH, KNOWLEDGE_ASSIST, ENTITY_EXTRACTION. "contextFilterSettings": { # Settings that determine how to filter recent conversation context when generating suggestions. # Determines how recent conversation context is filtered when generating suggestions. If unspecified, no messages will be dropped. @@ -563,6 +575,7 @@

Method Details

"displayName": "A String", # Required. Human readable name for this profile. Max length 1024 bytes. "humanAgentAssistantConfig": { # Defines the Human Agent Assist to connect to a conversation. # Configuration for agent assistance to use with this profile. "endUserSuggestionConfig": { # Detail human agent assistant config. # Configuration for agent assistance of end user participant. Currently, this feature is not general available, please contact Google to get access. + "disableHighLatencyFeaturesSyncDelivery": True or False, # Optional. When disable_high_latency_features_sync_delivery is true and using the AnalyzeContent API, we will not deliver the responses from high latency features in the API response. The human_agent_assistant_config.notification_config must be configured and enable_event_based_suggestion must be set to true to receive the responses from high latency features in Pub/Sub. High latency feature(s): KNOWLEDGE_ASSIST. "featureConfigs": [ # Configuration of different suggestion features. One feature can have only one config. { # Config for suggestion features. "conversationModelConfig": { # Custom conversation models used in agent assist feature. Supported feature: ARTICLE_SUGGESTION, SMART_COMPOSE, SMART_REPLY, CONVERSATION_SUMMARIZATION. # Configs of custom conversation model. @@ -575,6 +588,8 @@

Method Details

"disableAgentQueryLogging": True or False, # Optional. Disable the logging of search queries sent by human agents. It can prevent those queries from being stored at answer records. Supported features: KNOWLEDGE_SEARCH. "enableConversationAugmentedQuery": True or False, # Optional. Enable including conversation context during query answer generation. Supported features: KNOWLEDGE_SEARCH. "enableEventBasedSuggestion": True or False, # Automatically iterates all participants and tries to compile suggestions. Supported features: ARTICLE_SUGGESTION, FAQ, DIALOGFLOW_ASSIST, KNOWLEDGE_ASSIST. + "enableQuerySuggestionOnly": True or False, # Optional. Enable query suggestion only. Supported features: KNOWLEDGE_ASSIST + "enableQuerySuggestionWhenNoAnswer": True or False, # Optional. Enable query suggestion even if we can't find its answer. By default, queries are suggested only if we find its answer. Supported features: KNOWLEDGE_ASSIST "queryConfig": { # Config for suggestion query. # Configs of query. "confidenceThreshold": 3.14, # Confidence threshold of query result. Agent Assist gives each suggestion a score in the range [0.0, 1.0], based on the relevance between the suggestion and the current conversation context. A score of 0.0 has no relevance, while a score of 1.0 has high relevance. Only suggestions with a score greater than or equal to the value of this field are included in the results. For a baseline model (the default), the recommended value is in the range [0.05, 0.1]. For a custom model, there is no recommended value. Tune this value by starting from a very low value and slowly increasing until you have desired results. If this field is not set, it defaults to 0.0, which means that all suggestions are returned. Supported features: ARTICLE_SUGGESTION, FAQ, SMART_REPLY, SMART_COMPOSE, KNOWLEDGE_SEARCH, KNOWLEDGE_ASSIST, ENTITY_EXTRACTION. "contextFilterSettings": { # Settings that determine how to filter recent conversation context when generating suggestions. # Determines how recent conversation context is filtered when generating suggestions. If unspecified, no messages will be dropped. @@ -620,6 +635,7 @@

Method Details

"groupSuggestionResponses": True or False, # If `group_suggestion_responses` is false, and there are multiple `feature_configs` in `event based suggestion` or StreamingAnalyzeContent, we will try to deliver suggestions to customers as soon as we get new suggestion. Different type of suggestions based on the same context will be in separate Pub/Sub event or `StreamingAnalyzeContentResponse`. If `group_suggestion_responses` set to true. All the suggestions to the same participant based on the same context will be grouped into a single Pub/Sub event or StreamingAnalyzeContentResponse. }, "humanAgentSuggestionConfig": { # Detail human agent assistant config. # Configuration for agent assistance of human agent participant. + "disableHighLatencyFeaturesSyncDelivery": True or False, # Optional. When disable_high_latency_features_sync_delivery is true and using the AnalyzeContent API, we will not deliver the responses from high latency features in the API response. The human_agent_assistant_config.notification_config must be configured and enable_event_based_suggestion must be set to true to receive the responses from high latency features in Pub/Sub. High latency feature(s): KNOWLEDGE_ASSIST. "featureConfigs": [ # Configuration of different suggestion features. One feature can have only one config. { # Config for suggestion features. "conversationModelConfig": { # Custom conversation models used in agent assist feature. Supported feature: ARTICLE_SUGGESTION, SMART_COMPOSE, SMART_REPLY, CONVERSATION_SUMMARIZATION. # Configs of custom conversation model. @@ -632,6 +648,8 @@

Method Details

"disableAgentQueryLogging": True or False, # Optional. Disable the logging of search queries sent by human agents. It can prevent those queries from being stored at answer records. Supported features: KNOWLEDGE_SEARCH. "enableConversationAugmentedQuery": True or False, # Optional. Enable including conversation context during query answer generation. Supported features: KNOWLEDGE_SEARCH. "enableEventBasedSuggestion": True or False, # Automatically iterates all participants and tries to compile suggestions. Supported features: ARTICLE_SUGGESTION, FAQ, DIALOGFLOW_ASSIST, KNOWLEDGE_ASSIST. + "enableQuerySuggestionOnly": True or False, # Optional. Enable query suggestion only. Supported features: KNOWLEDGE_ASSIST + "enableQuerySuggestionWhenNoAnswer": True or False, # Optional. Enable query suggestion even if we can't find its answer. By default, queries are suggested only if we find its answer. Supported features: KNOWLEDGE_ASSIST "queryConfig": { # Config for suggestion query. # Configs of query. "confidenceThreshold": 3.14, # Confidence threshold of query result. Agent Assist gives each suggestion a score in the range [0.0, 1.0], based on the relevance between the suggestion and the current conversation context. A score of 0.0 has no relevance, while a score of 1.0 has high relevance. Only suggestions with a score greater than or equal to the value of this field are included in the results. For a baseline model (the default), the recommended value is in the range [0.05, 0.1]. For a custom model, there is no recommended value. Tune this value by starting from a very low value and slowly increasing until you have desired results. If this field is not set, it defaults to 0.0, which means that all suggestions are returned. Supported features: ARTICLE_SUGGESTION, FAQ, SMART_REPLY, SMART_COMPOSE, KNOWLEDGE_SEARCH, KNOWLEDGE_ASSIST, ENTITY_EXTRACTION. "contextFilterSettings": { # Settings that determine how to filter recent conversation context when generating suggestions. # Determines how recent conversation context is filtered when generating suggestions. If unspecified, no messages will be dropped. @@ -759,6 +777,7 @@

Method Details

"displayName": "A String", # Required. Human readable name for this profile. Max length 1024 bytes. "humanAgentAssistantConfig": { # Defines the Human Agent Assist to connect to a conversation. # Configuration for agent assistance to use with this profile. "endUserSuggestionConfig": { # Detail human agent assistant config. # Configuration for agent assistance of end user participant. Currently, this feature is not general available, please contact Google to get access. + "disableHighLatencyFeaturesSyncDelivery": True or False, # Optional. When disable_high_latency_features_sync_delivery is true and using the AnalyzeContent API, we will not deliver the responses from high latency features in the API response. The human_agent_assistant_config.notification_config must be configured and enable_event_based_suggestion must be set to true to receive the responses from high latency features in Pub/Sub. High latency feature(s): KNOWLEDGE_ASSIST. "featureConfigs": [ # Configuration of different suggestion features. One feature can have only one config. { # Config for suggestion features. "conversationModelConfig": { # Custom conversation models used in agent assist feature. Supported feature: ARTICLE_SUGGESTION, SMART_COMPOSE, SMART_REPLY, CONVERSATION_SUMMARIZATION. # Configs of custom conversation model. @@ -771,6 +790,8 @@

Method Details

"disableAgentQueryLogging": True or False, # Optional. Disable the logging of search queries sent by human agents. It can prevent those queries from being stored at answer records. Supported features: KNOWLEDGE_SEARCH. "enableConversationAugmentedQuery": True or False, # Optional. Enable including conversation context during query answer generation. Supported features: KNOWLEDGE_SEARCH. "enableEventBasedSuggestion": True or False, # Automatically iterates all participants and tries to compile suggestions. Supported features: ARTICLE_SUGGESTION, FAQ, DIALOGFLOW_ASSIST, KNOWLEDGE_ASSIST. + "enableQuerySuggestionOnly": True or False, # Optional. Enable query suggestion only. Supported features: KNOWLEDGE_ASSIST + "enableQuerySuggestionWhenNoAnswer": True or False, # Optional. Enable query suggestion even if we can't find its answer. By default, queries are suggested only if we find its answer. Supported features: KNOWLEDGE_ASSIST "queryConfig": { # Config for suggestion query. # Configs of query. "confidenceThreshold": 3.14, # Confidence threshold of query result. Agent Assist gives each suggestion a score in the range [0.0, 1.0], based on the relevance between the suggestion and the current conversation context. A score of 0.0 has no relevance, while a score of 1.0 has high relevance. Only suggestions with a score greater than or equal to the value of this field are included in the results. For a baseline model (the default), the recommended value is in the range [0.05, 0.1]. For a custom model, there is no recommended value. Tune this value by starting from a very low value and slowly increasing until you have desired results. If this field is not set, it defaults to 0.0, which means that all suggestions are returned. Supported features: ARTICLE_SUGGESTION, FAQ, SMART_REPLY, SMART_COMPOSE, KNOWLEDGE_SEARCH, KNOWLEDGE_ASSIST, ENTITY_EXTRACTION. "contextFilterSettings": { # Settings that determine how to filter recent conversation context when generating suggestions. # Determines how recent conversation context is filtered when generating suggestions. If unspecified, no messages will be dropped. @@ -816,6 +837,7 @@

Method Details

"groupSuggestionResponses": True or False, # If `group_suggestion_responses` is false, and there are multiple `feature_configs` in `event based suggestion` or StreamingAnalyzeContent, we will try to deliver suggestions to customers as soon as we get new suggestion. Different type of suggestions based on the same context will be in separate Pub/Sub event or `StreamingAnalyzeContentResponse`. If `group_suggestion_responses` set to true. All the suggestions to the same participant based on the same context will be grouped into a single Pub/Sub event or StreamingAnalyzeContentResponse. }, "humanAgentSuggestionConfig": { # Detail human agent assistant config. # Configuration for agent assistance of human agent participant. + "disableHighLatencyFeaturesSyncDelivery": True or False, # Optional. When disable_high_latency_features_sync_delivery is true and using the AnalyzeContent API, we will not deliver the responses from high latency features in the API response. The human_agent_assistant_config.notification_config must be configured and enable_event_based_suggestion must be set to true to receive the responses from high latency features in Pub/Sub. High latency feature(s): KNOWLEDGE_ASSIST. "featureConfigs": [ # Configuration of different suggestion features. One feature can have only one config. { # Config for suggestion features. "conversationModelConfig": { # Custom conversation models used in agent assist feature. Supported feature: ARTICLE_SUGGESTION, SMART_COMPOSE, SMART_REPLY, CONVERSATION_SUMMARIZATION. # Configs of custom conversation model. @@ -828,6 +850,8 @@

Method Details

"disableAgentQueryLogging": True or False, # Optional. Disable the logging of search queries sent by human agents. It can prevent those queries from being stored at answer records. Supported features: KNOWLEDGE_SEARCH. "enableConversationAugmentedQuery": True or False, # Optional. Enable including conversation context during query answer generation. Supported features: KNOWLEDGE_SEARCH. "enableEventBasedSuggestion": True or False, # Automatically iterates all participants and tries to compile suggestions. Supported features: ARTICLE_SUGGESTION, FAQ, DIALOGFLOW_ASSIST, KNOWLEDGE_ASSIST. + "enableQuerySuggestionOnly": True or False, # Optional. Enable query suggestion only. Supported features: KNOWLEDGE_ASSIST + "enableQuerySuggestionWhenNoAnswer": True or False, # Optional. Enable query suggestion even if we can't find its answer. By default, queries are suggested only if we find its answer. Supported features: KNOWLEDGE_ASSIST "queryConfig": { # Config for suggestion query. # Configs of query. "confidenceThreshold": 3.14, # Confidence threshold of query result. Agent Assist gives each suggestion a score in the range [0.0, 1.0], based on the relevance between the suggestion and the current conversation context. A score of 0.0 has no relevance, while a score of 1.0 has high relevance. Only suggestions with a score greater than or equal to the value of this field are included in the results. For a baseline model (the default), the recommended value is in the range [0.05, 0.1]. For a custom model, there is no recommended value. Tune this value by starting from a very low value and slowly increasing until you have desired results. If this field is not set, it defaults to 0.0, which means that all suggestions are returned. Supported features: ARTICLE_SUGGESTION, FAQ, SMART_REPLY, SMART_COMPOSE, KNOWLEDGE_SEARCH, KNOWLEDGE_ASSIST, ENTITY_EXTRACTION. "contextFilterSettings": { # Settings that determine how to filter recent conversation context when generating suggestions. # Determines how recent conversation context is filtered when generating suggestions. If unspecified, no messages will be dropped. @@ -963,6 +987,7 @@

Method Details

"displayName": "A String", # Required. Human readable name for this profile. Max length 1024 bytes. "humanAgentAssistantConfig": { # Defines the Human Agent Assist to connect to a conversation. # Configuration for agent assistance to use with this profile. "endUserSuggestionConfig": { # Detail human agent assistant config. # Configuration for agent assistance of end user participant. Currently, this feature is not general available, please contact Google to get access. + "disableHighLatencyFeaturesSyncDelivery": True or False, # Optional. When disable_high_latency_features_sync_delivery is true and using the AnalyzeContent API, we will not deliver the responses from high latency features in the API response. The human_agent_assistant_config.notification_config must be configured and enable_event_based_suggestion must be set to true to receive the responses from high latency features in Pub/Sub. High latency feature(s): KNOWLEDGE_ASSIST. "featureConfigs": [ # Configuration of different suggestion features. One feature can have only one config. { # Config for suggestion features. "conversationModelConfig": { # Custom conversation models used in agent assist feature. Supported feature: ARTICLE_SUGGESTION, SMART_COMPOSE, SMART_REPLY, CONVERSATION_SUMMARIZATION. # Configs of custom conversation model. @@ -975,6 +1000,8 @@

Method Details

"disableAgentQueryLogging": True or False, # Optional. Disable the logging of search queries sent by human agents. It can prevent those queries from being stored at answer records. Supported features: KNOWLEDGE_SEARCH. "enableConversationAugmentedQuery": True or False, # Optional. Enable including conversation context during query answer generation. Supported features: KNOWLEDGE_SEARCH. "enableEventBasedSuggestion": True or False, # Automatically iterates all participants and tries to compile suggestions. Supported features: ARTICLE_SUGGESTION, FAQ, DIALOGFLOW_ASSIST, KNOWLEDGE_ASSIST. + "enableQuerySuggestionOnly": True or False, # Optional. Enable query suggestion only. Supported features: KNOWLEDGE_ASSIST + "enableQuerySuggestionWhenNoAnswer": True or False, # Optional. Enable query suggestion even if we can't find its answer. By default, queries are suggested only if we find its answer. Supported features: KNOWLEDGE_ASSIST "queryConfig": { # Config for suggestion query. # Configs of query. "confidenceThreshold": 3.14, # Confidence threshold of query result. Agent Assist gives each suggestion a score in the range [0.0, 1.0], based on the relevance between the suggestion and the current conversation context. A score of 0.0 has no relevance, while a score of 1.0 has high relevance. Only suggestions with a score greater than or equal to the value of this field are included in the results. For a baseline model (the default), the recommended value is in the range [0.05, 0.1]. For a custom model, there is no recommended value. Tune this value by starting from a very low value and slowly increasing until you have desired results. If this field is not set, it defaults to 0.0, which means that all suggestions are returned. Supported features: ARTICLE_SUGGESTION, FAQ, SMART_REPLY, SMART_COMPOSE, KNOWLEDGE_SEARCH, KNOWLEDGE_ASSIST, ENTITY_EXTRACTION. "contextFilterSettings": { # Settings that determine how to filter recent conversation context when generating suggestions. # Determines how recent conversation context is filtered when generating suggestions. If unspecified, no messages will be dropped. @@ -1020,6 +1047,7 @@

Method Details

"groupSuggestionResponses": True or False, # If `group_suggestion_responses` is false, and there are multiple `feature_configs` in `event based suggestion` or StreamingAnalyzeContent, we will try to deliver suggestions to customers as soon as we get new suggestion. Different type of suggestions based on the same context will be in separate Pub/Sub event or `StreamingAnalyzeContentResponse`. If `group_suggestion_responses` set to true. All the suggestions to the same participant based on the same context will be grouped into a single Pub/Sub event or StreamingAnalyzeContentResponse. }, "humanAgentSuggestionConfig": { # Detail human agent assistant config. # Configuration for agent assistance of human agent participant. + "disableHighLatencyFeaturesSyncDelivery": True or False, # Optional. When disable_high_latency_features_sync_delivery is true and using the AnalyzeContent API, we will not deliver the responses from high latency features in the API response. The human_agent_assistant_config.notification_config must be configured and enable_event_based_suggestion must be set to true to receive the responses from high latency features in Pub/Sub. High latency feature(s): KNOWLEDGE_ASSIST. "featureConfigs": [ # Configuration of different suggestion features. One feature can have only one config. { # Config for suggestion features. "conversationModelConfig": { # Custom conversation models used in agent assist feature. Supported feature: ARTICLE_SUGGESTION, SMART_COMPOSE, SMART_REPLY, CONVERSATION_SUMMARIZATION. # Configs of custom conversation model. @@ -1032,6 +1060,8 @@

Method Details

"disableAgentQueryLogging": True or False, # Optional. Disable the logging of search queries sent by human agents. It can prevent those queries from being stored at answer records. Supported features: KNOWLEDGE_SEARCH. "enableConversationAugmentedQuery": True or False, # Optional. Enable including conversation context during query answer generation. Supported features: KNOWLEDGE_SEARCH. "enableEventBasedSuggestion": True or False, # Automatically iterates all participants and tries to compile suggestions. Supported features: ARTICLE_SUGGESTION, FAQ, DIALOGFLOW_ASSIST, KNOWLEDGE_ASSIST. + "enableQuerySuggestionOnly": True or False, # Optional. Enable query suggestion only. Supported features: KNOWLEDGE_ASSIST + "enableQuerySuggestionWhenNoAnswer": True or False, # Optional. Enable query suggestion even if we can't find its answer. By default, queries are suggested only if we find its answer. Supported features: KNOWLEDGE_ASSIST "queryConfig": { # Config for suggestion query. # Configs of query. "confidenceThreshold": 3.14, # Confidence threshold of query result. Agent Assist gives each suggestion a score in the range [0.0, 1.0], based on the relevance between the suggestion and the current conversation context. A score of 0.0 has no relevance, while a score of 1.0 has high relevance. Only suggestions with a score greater than or equal to the value of this field are included in the results. For a baseline model (the default), the recommended value is in the range [0.05, 0.1]. For a custom model, there is no recommended value. Tune this value by starting from a very low value and slowly increasing until you have desired results. If this field is not set, it defaults to 0.0, which means that all suggestions are returned. Supported features: ARTICLE_SUGGESTION, FAQ, SMART_REPLY, SMART_COMPOSE, KNOWLEDGE_SEARCH, KNOWLEDGE_ASSIST, ENTITY_EXTRACTION. "contextFilterSettings": { # Settings that determine how to filter recent conversation context when generating suggestions. # Determines how recent conversation context is filtered when generating suggestions. If unspecified, no messages will be dropped. @@ -1149,6 +1179,7 @@

Method Details

"displayName": "A String", # Required. Human readable name for this profile. Max length 1024 bytes. "humanAgentAssistantConfig": { # Defines the Human Agent Assist to connect to a conversation. # Configuration for agent assistance to use with this profile. "endUserSuggestionConfig": { # Detail human agent assistant config. # Configuration for agent assistance of end user participant. Currently, this feature is not general available, please contact Google to get access. + "disableHighLatencyFeaturesSyncDelivery": True or False, # Optional. When disable_high_latency_features_sync_delivery is true and using the AnalyzeContent API, we will not deliver the responses from high latency features in the API response. The human_agent_assistant_config.notification_config must be configured and enable_event_based_suggestion must be set to true to receive the responses from high latency features in Pub/Sub. High latency feature(s): KNOWLEDGE_ASSIST. "featureConfigs": [ # Configuration of different suggestion features. One feature can have only one config. { # Config for suggestion features. "conversationModelConfig": { # Custom conversation models used in agent assist feature. Supported feature: ARTICLE_SUGGESTION, SMART_COMPOSE, SMART_REPLY, CONVERSATION_SUMMARIZATION. # Configs of custom conversation model. @@ -1161,6 +1192,8 @@

Method Details

"disableAgentQueryLogging": True or False, # Optional. Disable the logging of search queries sent by human agents. It can prevent those queries from being stored at answer records. Supported features: KNOWLEDGE_SEARCH. "enableConversationAugmentedQuery": True or False, # Optional. Enable including conversation context during query answer generation. Supported features: KNOWLEDGE_SEARCH. "enableEventBasedSuggestion": True or False, # Automatically iterates all participants and tries to compile suggestions. Supported features: ARTICLE_SUGGESTION, FAQ, DIALOGFLOW_ASSIST, KNOWLEDGE_ASSIST. + "enableQuerySuggestionOnly": True or False, # Optional. Enable query suggestion only. Supported features: KNOWLEDGE_ASSIST + "enableQuerySuggestionWhenNoAnswer": True or False, # Optional. Enable query suggestion even if we can't find its answer. By default, queries are suggested only if we find its answer. Supported features: KNOWLEDGE_ASSIST "queryConfig": { # Config for suggestion query. # Configs of query. "confidenceThreshold": 3.14, # Confidence threshold of query result. Agent Assist gives each suggestion a score in the range [0.0, 1.0], based on the relevance between the suggestion and the current conversation context. A score of 0.0 has no relevance, while a score of 1.0 has high relevance. Only suggestions with a score greater than or equal to the value of this field are included in the results. For a baseline model (the default), the recommended value is in the range [0.05, 0.1]. For a custom model, there is no recommended value. Tune this value by starting from a very low value and slowly increasing until you have desired results. If this field is not set, it defaults to 0.0, which means that all suggestions are returned. Supported features: ARTICLE_SUGGESTION, FAQ, SMART_REPLY, SMART_COMPOSE, KNOWLEDGE_SEARCH, KNOWLEDGE_ASSIST, ENTITY_EXTRACTION. "contextFilterSettings": { # Settings that determine how to filter recent conversation context when generating suggestions. # Determines how recent conversation context is filtered when generating suggestions. If unspecified, no messages will be dropped. @@ -1206,6 +1239,7 @@

Method Details

"groupSuggestionResponses": True or False, # If `group_suggestion_responses` is false, and there are multiple `feature_configs` in `event based suggestion` or StreamingAnalyzeContent, we will try to deliver suggestions to customers as soon as we get new suggestion. Different type of suggestions based on the same context will be in separate Pub/Sub event or `StreamingAnalyzeContentResponse`. If `group_suggestion_responses` set to true. All the suggestions to the same participant based on the same context will be grouped into a single Pub/Sub event or StreamingAnalyzeContentResponse. }, "humanAgentSuggestionConfig": { # Detail human agent assistant config. # Configuration for agent assistance of human agent participant. + "disableHighLatencyFeaturesSyncDelivery": True or False, # Optional. When disable_high_latency_features_sync_delivery is true and using the AnalyzeContent API, we will not deliver the responses from high latency features in the API response. The human_agent_assistant_config.notification_config must be configured and enable_event_based_suggestion must be set to true to receive the responses from high latency features in Pub/Sub. High latency feature(s): KNOWLEDGE_ASSIST. "featureConfigs": [ # Configuration of different suggestion features. One feature can have only one config. { # Config for suggestion features. "conversationModelConfig": { # Custom conversation models used in agent assist feature. Supported feature: ARTICLE_SUGGESTION, SMART_COMPOSE, SMART_REPLY, CONVERSATION_SUMMARIZATION. # Configs of custom conversation model. @@ -1218,6 +1252,8 @@

Method Details

"disableAgentQueryLogging": True or False, # Optional. Disable the logging of search queries sent by human agents. It can prevent those queries from being stored at answer records. Supported features: KNOWLEDGE_SEARCH. "enableConversationAugmentedQuery": True or False, # Optional. Enable including conversation context during query answer generation. Supported features: KNOWLEDGE_SEARCH. "enableEventBasedSuggestion": True or False, # Automatically iterates all participants and tries to compile suggestions. Supported features: ARTICLE_SUGGESTION, FAQ, DIALOGFLOW_ASSIST, KNOWLEDGE_ASSIST. + "enableQuerySuggestionOnly": True or False, # Optional. Enable query suggestion only. Supported features: KNOWLEDGE_ASSIST + "enableQuerySuggestionWhenNoAnswer": True or False, # Optional. Enable query suggestion even if we can't find its answer. By default, queries are suggested only if we find its answer. Supported features: KNOWLEDGE_ASSIST "queryConfig": { # Config for suggestion query. # Configs of query. "confidenceThreshold": 3.14, # Confidence threshold of query result. Agent Assist gives each suggestion a score in the range [0.0, 1.0], based on the relevance between the suggestion and the current conversation context. A score of 0.0 has no relevance, while a score of 1.0 has high relevance. Only suggestions with a score greater than or equal to the value of this field are included in the results. For a baseline model (the default), the recommended value is in the range [0.05, 0.1]. For a custom model, there is no recommended value. Tune this value by starting from a very low value and slowly increasing until you have desired results. If this field is not set, it defaults to 0.0, which means that all suggestions are returned. Supported features: ARTICLE_SUGGESTION, FAQ, SMART_REPLY, SMART_COMPOSE, KNOWLEDGE_SEARCH, KNOWLEDGE_ASSIST, ENTITY_EXTRACTION. "contextFilterSettings": { # Settings that determine how to filter recent conversation context when generating suggestions. # Determines how recent conversation context is filtered when generating suggestions. If unspecified, no messages will be dropped. @@ -1340,6 +1376,8 @@

Method Details

"disableAgentQueryLogging": True or False, # Optional. Disable the logging of search queries sent by human agents. It can prevent those queries from being stored at answer records. Supported features: KNOWLEDGE_SEARCH. "enableConversationAugmentedQuery": True or False, # Optional. Enable including conversation context during query answer generation. Supported features: KNOWLEDGE_SEARCH. "enableEventBasedSuggestion": True or False, # Automatically iterates all participants and tries to compile suggestions. Supported features: ARTICLE_SUGGESTION, FAQ, DIALOGFLOW_ASSIST, KNOWLEDGE_ASSIST. + "enableQuerySuggestionOnly": True or False, # Optional. Enable query suggestion only. Supported features: KNOWLEDGE_ASSIST + "enableQuerySuggestionWhenNoAnswer": True or False, # Optional. Enable query suggestion even if we can't find its answer. By default, queries are suggested only if we find its answer. Supported features: KNOWLEDGE_ASSIST "queryConfig": { # Config for suggestion query. # Configs of query. "confidenceThreshold": 3.14, # Confidence threshold of query result. Agent Assist gives each suggestion a score in the range [0.0, 1.0], based on the relevance between the suggestion and the current conversation context. A score of 0.0 has no relevance, while a score of 1.0 has high relevance. Only suggestions with a score greater than or equal to the value of this field are included in the results. For a baseline model (the default), the recommended value is in the range [0.05, 0.1]. For a custom model, there is no recommended value. Tune this value by starting from a very low value and slowly increasing until you have desired results. If this field is not set, it defaults to 0.0, which means that all suggestions are returned. Supported features: ARTICLE_SUGGESTION, FAQ, SMART_REPLY, SMART_COMPOSE, KNOWLEDGE_SEARCH, KNOWLEDGE_ASSIST, ENTITY_EXTRACTION. "contextFilterSettings": { # Settings that determine how to filter recent conversation context when generating suggestions. # Determines how recent conversation context is filtered when generating suggestions. If unspecified, no messages will be dropped. diff --git a/docs/dyn/dialogflow_v2.projects.locations.conversations.participants.html b/docs/dyn/dialogflow_v2.projects.locations.conversations.participants.html index 4a23af0e18f..64587a4e13c 100644 --- a/docs/dyn/dialogflow_v2.projects.locations.conversations.participants.html +++ b/docs/dyn/dialogflow_v2.projects.locations.conversations.participants.html @@ -740,6 +740,31 @@

Method Details

], "latestMessage": "A String", # The name of the latest conversation message used to compile suggestion for. Format: `projects//locations//conversations//messages/`. }, + "suggestKnowledgeAssistResponse": { # The response message for Participants.SuggestKnowledgeAssist. # SuggestKnowledgeAssistResponse if request is for KNOWLEDGE_ASSIST. + "contextSize": 42, # Number of messages prior to and including latest_message to compile the suggestion. It may be smaller than the SuggestKnowledgeAssistRequest.context_size field in the request if there are fewer messages in the conversation. + "knowledgeAssistAnswer": { # Represents a Knowledge Assist answer. # Output only. Knowledge Assist suggestion. + "answerRecord": "A String", # The name of the answer record. Format: `projects//locations//answer Records/`. + "suggestedQuery": { # Represents a suggested query. # The query suggested based on the context. Suggestion is made only if it is different from the previous suggestion. + "queryText": "A String", # Suggested query text. + }, + "suggestedQueryAnswer": { # Represents an answer from Knowledge. Currently supports FAQ and Generative answers. # The answer generated for the suggested query. Whether or not an answer is generated depends on how confident we are about the generated query. + "answerText": "A String", # The piece of text from the `source` that answers this suggested query. + "faqSource": { # Details about source of FAQ answer. # Populated if the prediction came from FAQ. + "question": "A String", # The corresponding FAQ question. + }, + "generativeSource": { # Details about source of Generative answer. # Populated if the prediction was Generative. + "snippets": [ # All snippets used for this Generative Prediction, with their source URI and data. + { # Snippet Source for a Generative Prediction. + "text": "A String", # Text taken from that URI. + "title": "A String", # Title of the document. + "uri": "A String", # URI the data is sourced from. + }, + ], + }, + }, + }, + "latestMessage": "A String", # The name of the latest conversation message used to compile suggestion for. Format: `projects//locations//conversations//messages/`. + }, "suggestSmartRepliesResponse": { # The response message for Participants.SuggestSmartReplies. # SuggestSmartRepliesResponse if request is for SMART_REPLY. "contextSize": 42, # Number of messages prior to and including latest_message to compile the suggestion. It may be smaller than the SuggestSmartRepliesRequest.context_size field in the request if there aren't that many messages in the conversation. "latestMessage": "A String", # The name of the latest conversation message used to compile suggestion for. Format: `projects//locations//conversations//messages/`. @@ -798,6 +823,31 @@

Method Details

], "latestMessage": "A String", # The name of the latest conversation message used to compile suggestion for. Format: `projects//locations//conversations//messages/`. }, + "suggestKnowledgeAssistResponse": { # The response message for Participants.SuggestKnowledgeAssist. # SuggestKnowledgeAssistResponse if request is for KNOWLEDGE_ASSIST. + "contextSize": 42, # Number of messages prior to and including latest_message to compile the suggestion. It may be smaller than the SuggestKnowledgeAssistRequest.context_size field in the request if there are fewer messages in the conversation. + "knowledgeAssistAnswer": { # Represents a Knowledge Assist answer. # Output only. Knowledge Assist suggestion. + "answerRecord": "A String", # The name of the answer record. Format: `projects//locations//answer Records/`. + "suggestedQuery": { # Represents a suggested query. # The query suggested based on the context. Suggestion is made only if it is different from the previous suggestion. + "queryText": "A String", # Suggested query text. + }, + "suggestedQueryAnswer": { # Represents an answer from Knowledge. Currently supports FAQ and Generative answers. # The answer generated for the suggested query. Whether or not an answer is generated depends on how confident we are about the generated query. + "answerText": "A String", # The piece of text from the `source` that answers this suggested query. + "faqSource": { # Details about source of FAQ answer. # Populated if the prediction came from FAQ. + "question": "A String", # The corresponding FAQ question. + }, + "generativeSource": { # Details about source of Generative answer. # Populated if the prediction was Generative. + "snippets": [ # All snippets used for this Generative Prediction, with their source URI and data. + { # Snippet Source for a Generative Prediction. + "text": "A String", # Text taken from that URI. + "title": "A String", # Title of the document. + "uri": "A String", # URI the data is sourced from. + }, + ], + }, + }, + }, + "latestMessage": "A String", # The name of the latest conversation message used to compile suggestion for. Format: `projects//locations//conversations//messages/`. + }, "suggestSmartRepliesResponse": { # The response message for Participants.SuggestSmartReplies. # SuggestSmartRepliesResponse if request is for SMART_REPLY. "contextSize": 42, # Number of messages prior to and including latest_message to compile the suggestion. It may be smaller than the SuggestSmartRepliesRequest.context_size field in the request if there aren't that many messages in the conversation. "latestMessage": "A String", # The name of the latest conversation message used to compile suggestion for. Format: `projects//locations//conversations//messages/`. diff --git a/docs/dyn/dialogflow_v2.projects.locations.conversations.participants.suggestions.html b/docs/dyn/dialogflow_v2.projects.locations.conversations.participants.suggestions.html index 14c52586aca..7fa0f69b2ac 100644 --- a/docs/dyn/dialogflow_v2.projects.locations.conversations.participants.suggestions.html +++ b/docs/dyn/dialogflow_v2.projects.locations.conversations.participants.suggestions.html @@ -83,6 +83,9 @@

Instance Methods

suggestFaqAnswers(parent, body=None, x__xgafv=None)

Gets suggested faq answers for a participant based on specific historical messages.

+

+ suggestKnowledgeAssist(parent, body=None, x__xgafv=None)

+

Gets knowledge assist suggestions based on historical messages.

suggestSmartReplies(parent, body=None, x__xgafv=None)

Gets smart replies for a participant based on specific historical messages.

@@ -184,6 +187,56 @@

Method Details

}
+
+ suggestKnowledgeAssist(parent, body=None, x__xgafv=None) +
Gets knowledge assist suggestions based on historical messages.
+
+Args:
+  parent: string, Required. The name of the participant to fetch suggestions for. Format: `projects//locations//conversations//participants/`. (required)
+  body: object, The request body.
+    The object takes the form of:
+
+{ # The request message for Participants.SuggestKnowledgeAssist.
+  "contextSize": 42, # Optional. Max number of messages prior to and including latest_message to use as context when compiling the suggestion. The context size is by default 100 and at most 100.
+  "latestMessage": "A String", # Optional. The name of the latest conversation message to compile suggestions for. If empty, it will be the latest message of the conversation. Format: `projects//locations//conversations//messages/`.
+  "previousSuggestedQuery": "A String", # Optional. The previously suggested query for the given conversation. This helps identify whether the next suggestion we generate is resonably different from the previous one. This is useful to avoid similar suggestions within the conversation.
+}
+
+  x__xgafv: string, V1 error format.
+    Allowed values
+      1 - v1 error format
+      2 - v2 error format
+
+Returns:
+  An object of the form:
+
+    { # The response message for Participants.SuggestKnowledgeAssist.
+  "contextSize": 42, # Number of messages prior to and including latest_message to compile the suggestion. It may be smaller than the SuggestKnowledgeAssistRequest.context_size field in the request if there are fewer messages in the conversation.
+  "knowledgeAssistAnswer": { # Represents a Knowledge Assist answer. # Output only. Knowledge Assist suggestion.
+    "answerRecord": "A String", # The name of the answer record. Format: `projects//locations//answer Records/`.
+    "suggestedQuery": { # Represents a suggested query. # The query suggested based on the context. Suggestion is made only if it is different from the previous suggestion.
+      "queryText": "A String", # Suggested query text.
+    },
+    "suggestedQueryAnswer": { # Represents an answer from Knowledge. Currently supports FAQ and Generative answers. # The answer generated for the suggested query. Whether or not an answer is generated depends on how confident we are about the generated query.
+      "answerText": "A String", # The piece of text from the `source` that answers this suggested query.
+      "faqSource": { # Details about source of FAQ answer. # Populated if the prediction came from FAQ.
+        "question": "A String", # The corresponding FAQ question.
+      },
+      "generativeSource": { # Details about source of Generative answer. # Populated if the prediction was Generative.
+        "snippets": [ # All snippets used for this Generative Prediction, with their source URI and data.
+          { # Snippet Source for a Generative Prediction.
+            "text": "A String", # Text taken from that URI.
+            "title": "A String", # Title of the document.
+            "uri": "A String", # URI the data is sourced from.
+          },
+        ],
+      },
+    },
+  },
+  "latestMessage": "A String", # The name of the latest conversation message used to compile suggestion for. Format: `projects//locations//conversations//messages/`.
+}
+
+
suggestSmartReplies(parent, body=None, x__xgafv=None)
Gets smart replies for a participant based on specific historical messages.
diff --git a/docs/dyn/dialogflow_v2.projects.locations.suggestions.html b/docs/dyn/dialogflow_v2.projects.locations.suggestions.html
index 5f04593c75d..d9249ed49eb 100644
--- a/docs/dyn/dialogflow_v2.projects.locations.suggestions.html
+++ b/docs/dyn/dialogflow_v2.projects.locations.suggestions.html
@@ -108,6 +108,7 @@ 

Method Details

"displayName": "A String", # Required. Human readable name for this profile. Max length 1024 bytes. "humanAgentAssistantConfig": { # Defines the Human Agent Assist to connect to a conversation. # Configuration for agent assistance to use with this profile. "endUserSuggestionConfig": { # Detail human agent assistant config. # Configuration for agent assistance of end user participant. Currently, this feature is not general available, please contact Google to get access. + "disableHighLatencyFeaturesSyncDelivery": True or False, # Optional. When disable_high_latency_features_sync_delivery is true and using the AnalyzeContent API, we will not deliver the responses from high latency features in the API response. The human_agent_assistant_config.notification_config must be configured and enable_event_based_suggestion must be set to true to receive the responses from high latency features in Pub/Sub. High latency feature(s): KNOWLEDGE_ASSIST. "featureConfigs": [ # Configuration of different suggestion features. One feature can have only one config. { # Config for suggestion features. "conversationModelConfig": { # Custom conversation models used in agent assist feature. Supported feature: ARTICLE_SUGGESTION, SMART_COMPOSE, SMART_REPLY, CONVERSATION_SUMMARIZATION. # Configs of custom conversation model. @@ -120,6 +121,8 @@

Method Details

"disableAgentQueryLogging": True or False, # Optional. Disable the logging of search queries sent by human agents. It can prevent those queries from being stored at answer records. Supported features: KNOWLEDGE_SEARCH. "enableConversationAugmentedQuery": True or False, # Optional. Enable including conversation context during query answer generation. Supported features: KNOWLEDGE_SEARCH. "enableEventBasedSuggestion": True or False, # Automatically iterates all participants and tries to compile suggestions. Supported features: ARTICLE_SUGGESTION, FAQ, DIALOGFLOW_ASSIST, KNOWLEDGE_ASSIST. + "enableQuerySuggestionOnly": True or False, # Optional. Enable query suggestion only. Supported features: KNOWLEDGE_ASSIST + "enableQuerySuggestionWhenNoAnswer": True or False, # Optional. Enable query suggestion even if we can't find its answer. By default, queries are suggested only if we find its answer. Supported features: KNOWLEDGE_ASSIST "queryConfig": { # Config for suggestion query. # Configs of query. "confidenceThreshold": 3.14, # Confidence threshold of query result. Agent Assist gives each suggestion a score in the range [0.0, 1.0], based on the relevance between the suggestion and the current conversation context. A score of 0.0 has no relevance, while a score of 1.0 has high relevance. Only suggestions with a score greater than or equal to the value of this field are included in the results. For a baseline model (the default), the recommended value is in the range [0.05, 0.1]. For a custom model, there is no recommended value. Tune this value by starting from a very low value and slowly increasing until you have desired results. If this field is not set, it defaults to 0.0, which means that all suggestions are returned. Supported features: ARTICLE_SUGGESTION, FAQ, SMART_REPLY, SMART_COMPOSE, KNOWLEDGE_SEARCH, KNOWLEDGE_ASSIST, ENTITY_EXTRACTION. "contextFilterSettings": { # Settings that determine how to filter recent conversation context when generating suggestions. # Determines how recent conversation context is filtered when generating suggestions. If unspecified, no messages will be dropped. @@ -165,6 +168,7 @@

Method Details

"groupSuggestionResponses": True or False, # If `group_suggestion_responses` is false, and there are multiple `feature_configs` in `event based suggestion` or StreamingAnalyzeContent, we will try to deliver suggestions to customers as soon as we get new suggestion. Different type of suggestions based on the same context will be in separate Pub/Sub event or `StreamingAnalyzeContentResponse`. If `group_suggestion_responses` set to true. All the suggestions to the same participant based on the same context will be grouped into a single Pub/Sub event or StreamingAnalyzeContentResponse. }, "humanAgentSuggestionConfig": { # Detail human agent assistant config. # Configuration for agent assistance of human agent participant. + "disableHighLatencyFeaturesSyncDelivery": True or False, # Optional. When disable_high_latency_features_sync_delivery is true and using the AnalyzeContent API, we will not deliver the responses from high latency features in the API response. The human_agent_assistant_config.notification_config must be configured and enable_event_based_suggestion must be set to true to receive the responses from high latency features in Pub/Sub. High latency feature(s): KNOWLEDGE_ASSIST. "featureConfigs": [ # Configuration of different suggestion features. One feature can have only one config. { # Config for suggestion features. "conversationModelConfig": { # Custom conversation models used in agent assist feature. Supported feature: ARTICLE_SUGGESTION, SMART_COMPOSE, SMART_REPLY, CONVERSATION_SUMMARIZATION. # Configs of custom conversation model. @@ -177,6 +181,8 @@

Method Details

"disableAgentQueryLogging": True or False, # Optional. Disable the logging of search queries sent by human agents. It can prevent those queries from being stored at answer records. Supported features: KNOWLEDGE_SEARCH. "enableConversationAugmentedQuery": True or False, # Optional. Enable including conversation context during query answer generation. Supported features: KNOWLEDGE_SEARCH. "enableEventBasedSuggestion": True or False, # Automatically iterates all participants and tries to compile suggestions. Supported features: ARTICLE_SUGGESTION, FAQ, DIALOGFLOW_ASSIST, KNOWLEDGE_ASSIST. + "enableQuerySuggestionOnly": True or False, # Optional. Enable query suggestion only. Supported features: KNOWLEDGE_ASSIST + "enableQuerySuggestionWhenNoAnswer": True or False, # Optional. Enable query suggestion even if we can't find its answer. By default, queries are suggested only if we find its answer. Supported features: KNOWLEDGE_ASSIST "queryConfig": { # Config for suggestion query. # Configs of query. "confidenceThreshold": 3.14, # Confidence threshold of query result. Agent Assist gives each suggestion a score in the range [0.0, 1.0], based on the relevance between the suggestion and the current conversation context. A score of 0.0 has no relevance, while a score of 1.0 has high relevance. Only suggestions with a score greater than or equal to the value of this field are included in the results. For a baseline model (the default), the recommended value is in the range [0.05, 0.1]. For a custom model, there is no recommended value. Tune this value by starting from a very low value and slowly increasing until you have desired results. If this field is not set, it defaults to 0.0, which means that all suggestions are returned. Supported features: ARTICLE_SUGGESTION, FAQ, SMART_REPLY, SMART_COMPOSE, KNOWLEDGE_SEARCH, KNOWLEDGE_ASSIST, ENTITY_EXTRACTION. "contextFilterSettings": { # Settings that determine how to filter recent conversation context when generating suggestions. # Determines how recent conversation context is filtered when generating suggestions. If unspecified, no messages will be dropped. diff --git a/docs/dyn/dialogflow_v2.projects.suggestions.html b/docs/dyn/dialogflow_v2.projects.suggestions.html index 786ad5780c6..337596da07f 100644 --- a/docs/dyn/dialogflow_v2.projects.suggestions.html +++ b/docs/dyn/dialogflow_v2.projects.suggestions.html @@ -108,6 +108,7 @@

Method Details

"displayName": "A String", # Required. Human readable name for this profile. Max length 1024 bytes. "humanAgentAssistantConfig": { # Defines the Human Agent Assist to connect to a conversation. # Configuration for agent assistance to use with this profile. "endUserSuggestionConfig": { # Detail human agent assistant config. # Configuration for agent assistance of end user participant. Currently, this feature is not general available, please contact Google to get access. + "disableHighLatencyFeaturesSyncDelivery": True or False, # Optional. When disable_high_latency_features_sync_delivery is true and using the AnalyzeContent API, we will not deliver the responses from high latency features in the API response. The human_agent_assistant_config.notification_config must be configured and enable_event_based_suggestion must be set to true to receive the responses from high latency features in Pub/Sub. High latency feature(s): KNOWLEDGE_ASSIST. "featureConfigs": [ # Configuration of different suggestion features. One feature can have only one config. { # Config for suggestion features. "conversationModelConfig": { # Custom conversation models used in agent assist feature. Supported feature: ARTICLE_SUGGESTION, SMART_COMPOSE, SMART_REPLY, CONVERSATION_SUMMARIZATION. # Configs of custom conversation model. @@ -120,6 +121,8 @@

Method Details

"disableAgentQueryLogging": True or False, # Optional. Disable the logging of search queries sent by human agents. It can prevent those queries from being stored at answer records. Supported features: KNOWLEDGE_SEARCH. "enableConversationAugmentedQuery": True or False, # Optional. Enable including conversation context during query answer generation. Supported features: KNOWLEDGE_SEARCH. "enableEventBasedSuggestion": True or False, # Automatically iterates all participants and tries to compile suggestions. Supported features: ARTICLE_SUGGESTION, FAQ, DIALOGFLOW_ASSIST, KNOWLEDGE_ASSIST. + "enableQuerySuggestionOnly": True or False, # Optional. Enable query suggestion only. Supported features: KNOWLEDGE_ASSIST + "enableQuerySuggestionWhenNoAnswer": True or False, # Optional. Enable query suggestion even if we can't find its answer. By default, queries are suggested only if we find its answer. Supported features: KNOWLEDGE_ASSIST "queryConfig": { # Config for suggestion query. # Configs of query. "confidenceThreshold": 3.14, # Confidence threshold of query result. Agent Assist gives each suggestion a score in the range [0.0, 1.0], based on the relevance between the suggestion and the current conversation context. A score of 0.0 has no relevance, while a score of 1.0 has high relevance. Only suggestions with a score greater than or equal to the value of this field are included in the results. For a baseline model (the default), the recommended value is in the range [0.05, 0.1]. For a custom model, there is no recommended value. Tune this value by starting from a very low value and slowly increasing until you have desired results. If this field is not set, it defaults to 0.0, which means that all suggestions are returned. Supported features: ARTICLE_SUGGESTION, FAQ, SMART_REPLY, SMART_COMPOSE, KNOWLEDGE_SEARCH, KNOWLEDGE_ASSIST, ENTITY_EXTRACTION. "contextFilterSettings": { # Settings that determine how to filter recent conversation context when generating suggestions. # Determines how recent conversation context is filtered when generating suggestions. If unspecified, no messages will be dropped. @@ -165,6 +168,7 @@

Method Details

"groupSuggestionResponses": True or False, # If `group_suggestion_responses` is false, and there are multiple `feature_configs` in `event based suggestion` or StreamingAnalyzeContent, we will try to deliver suggestions to customers as soon as we get new suggestion. Different type of suggestions based on the same context will be in separate Pub/Sub event or `StreamingAnalyzeContentResponse`. If `group_suggestion_responses` set to true. All the suggestions to the same participant based on the same context will be grouped into a single Pub/Sub event or StreamingAnalyzeContentResponse. }, "humanAgentSuggestionConfig": { # Detail human agent assistant config. # Configuration for agent assistance of human agent participant. + "disableHighLatencyFeaturesSyncDelivery": True or False, # Optional. When disable_high_latency_features_sync_delivery is true and using the AnalyzeContent API, we will not deliver the responses from high latency features in the API response. The human_agent_assistant_config.notification_config must be configured and enable_event_based_suggestion must be set to true to receive the responses from high latency features in Pub/Sub. High latency feature(s): KNOWLEDGE_ASSIST. "featureConfigs": [ # Configuration of different suggestion features. One feature can have only one config. { # Config for suggestion features. "conversationModelConfig": { # Custom conversation models used in agent assist feature. Supported feature: ARTICLE_SUGGESTION, SMART_COMPOSE, SMART_REPLY, CONVERSATION_SUMMARIZATION. # Configs of custom conversation model. @@ -177,6 +181,8 @@

Method Details

"disableAgentQueryLogging": True or False, # Optional. Disable the logging of search queries sent by human agents. It can prevent those queries from being stored at answer records. Supported features: KNOWLEDGE_SEARCH. "enableConversationAugmentedQuery": True or False, # Optional. Enable including conversation context during query answer generation. Supported features: KNOWLEDGE_SEARCH. "enableEventBasedSuggestion": True or False, # Automatically iterates all participants and tries to compile suggestions. Supported features: ARTICLE_SUGGESTION, FAQ, DIALOGFLOW_ASSIST, KNOWLEDGE_ASSIST. + "enableQuerySuggestionOnly": True or False, # Optional. Enable query suggestion only. Supported features: KNOWLEDGE_ASSIST + "enableQuerySuggestionWhenNoAnswer": True or False, # Optional. Enable query suggestion even if we can't find its answer. By default, queries are suggested only if we find its answer. Supported features: KNOWLEDGE_ASSIST "queryConfig": { # Config for suggestion query. # Configs of query. "confidenceThreshold": 3.14, # Confidence threshold of query result. Agent Assist gives each suggestion a score in the range [0.0, 1.0], based on the relevance between the suggestion and the current conversation context. A score of 0.0 has no relevance, while a score of 1.0 has high relevance. Only suggestions with a score greater than or equal to the value of this field are included in the results. For a baseline model (the default), the recommended value is in the range [0.05, 0.1]. For a custom model, there is no recommended value. Tune this value by starting from a very low value and slowly increasing until you have desired results. If this field is not set, it defaults to 0.0, which means that all suggestions are returned. Supported features: ARTICLE_SUGGESTION, FAQ, SMART_REPLY, SMART_COMPOSE, KNOWLEDGE_SEARCH, KNOWLEDGE_ASSIST, ENTITY_EXTRACTION. "contextFilterSettings": { # Settings that determine how to filter recent conversation context when generating suggestions. # Determines how recent conversation context is filtered when generating suggestions. If unspecified, no messages will be dropped. diff --git a/docs/dyn/dialogflow_v2beta1.projects.answerRecords.html b/docs/dyn/dialogflow_v2beta1.projects.answerRecords.html index 802e5582607..8d35d633741 100644 --- a/docs/dyn/dialogflow_v2beta1.projects.answerRecords.html +++ b/docs/dyn/dialogflow_v2beta1.projects.answerRecords.html @@ -814,6 +814,12 @@

Method Details

"answerRelevance": "A String", # Optional. Whether or not the suggested answer is relevant. For example: * Query: "Can I change my mailing address?" * Suggested document says: "Items must be returned/exchanged within 60 days of the purchase date." * answer_relevance: AnswerRelevance.IRRELEVANT "documentCorrectness": "A String", # Optional. Whether or not the information in the document is correct. For example: * Query: "Can I return the package in 2 days once received?" * Suggested document says: "Items must be returned/exchanged within 60 days of the purchase date." * Ground truth: "No return or exchange is allowed." * [document_correctness]: INCORRECT "documentEfficiency": "A String", # Optional. Whether or not the suggested document is efficient. For example, if the document is poorly written, hard to understand, hard to use or too long to find useful information, document_efficiency is DocumentEfficiency.INEFFICIENT. + "knowledgeAssistFeedback": { # Feedback for knowledge assist. # Optional. Feedback for knowledge assist. + "answerCopied": True or False, # Whether the suggested answer was copied by the human agent. If the value is set to be true, AnswerFeedback.clicked will be updated to be true. + "clickedUris": [ # The URIs clicked by the human agent. The value is appended for each UpdateAnswerRecordRequest. If the value is not empty, AnswerFeedback.clicked will be updated to be true. + "A String", + ], + }, "knowledgeSearchFeedback": { # Feedback for knowledge search. # Optional. Feedback for knowledge search. "answerCopied": True or False, # Whether the answer was copied by the human agent or not. If the value is set to be true, AnswerFeedback.clicked will be updated to be true. "clickedUris": [ # The URIs clicked by the human agent. The value is appended for each UpdateAnswerRecordRequest. If the value is not empty, AnswerFeedback.clicked will be updated to be true. @@ -1563,6 +1569,12 @@

Method Details

"answerRelevance": "A String", # Optional. Whether or not the suggested answer is relevant. For example: * Query: "Can I change my mailing address?" * Suggested document says: "Items must be returned/exchanged within 60 days of the purchase date." * answer_relevance: AnswerRelevance.IRRELEVANT "documentCorrectness": "A String", # Optional. Whether or not the information in the document is correct. For example: * Query: "Can I return the package in 2 days once received?" * Suggested document says: "Items must be returned/exchanged within 60 days of the purchase date." * Ground truth: "No return or exchange is allowed." * [document_correctness]: INCORRECT "documentEfficiency": "A String", # Optional. Whether or not the suggested document is efficient. For example, if the document is poorly written, hard to understand, hard to use or too long to find useful information, document_efficiency is DocumentEfficiency.INEFFICIENT. + "knowledgeAssistFeedback": { # Feedback for knowledge assist. # Optional. Feedback for knowledge assist. + "answerCopied": True or False, # Whether the suggested answer was copied by the human agent. If the value is set to be true, AnswerFeedback.clicked will be updated to be true. + "clickedUris": [ # The URIs clicked by the human agent. The value is appended for each UpdateAnswerRecordRequest. If the value is not empty, AnswerFeedback.clicked will be updated to be true. + "A String", + ], + }, "knowledgeSearchFeedback": { # Feedback for knowledge search. # Optional. Feedback for knowledge search. "answerCopied": True or False, # Whether the answer was copied by the human agent or not. If the value is set to be true, AnswerFeedback.clicked will be updated to be true. "clickedUris": [ # The URIs clicked by the human agent. The value is appended for each UpdateAnswerRecordRequest. If the value is not empty, AnswerFeedback.clicked will be updated to be true. @@ -2319,6 +2331,12 @@

Method Details

"answerRelevance": "A String", # Optional. Whether or not the suggested answer is relevant. For example: * Query: "Can I change my mailing address?" * Suggested document says: "Items must be returned/exchanged within 60 days of the purchase date." * answer_relevance: AnswerRelevance.IRRELEVANT "documentCorrectness": "A String", # Optional. Whether or not the information in the document is correct. For example: * Query: "Can I return the package in 2 days once received?" * Suggested document says: "Items must be returned/exchanged within 60 days of the purchase date." * Ground truth: "No return or exchange is allowed." * [document_correctness]: INCORRECT "documentEfficiency": "A String", # Optional. Whether or not the suggested document is efficient. For example, if the document is poorly written, hard to understand, hard to use or too long to find useful information, document_efficiency is DocumentEfficiency.INEFFICIENT. + "knowledgeAssistFeedback": { # Feedback for knowledge assist. # Optional. Feedback for knowledge assist. + "answerCopied": True or False, # Whether the suggested answer was copied by the human agent. If the value is set to be true, AnswerFeedback.clicked will be updated to be true. + "clickedUris": [ # The URIs clicked by the human agent. The value is appended for each UpdateAnswerRecordRequest. If the value is not empty, AnswerFeedback.clicked will be updated to be true. + "A String", + ], + }, "knowledgeSearchFeedback": { # Feedback for knowledge search. # Optional. Feedback for knowledge search. "answerCopied": True or False, # Whether the answer was copied by the human agent or not. If the value is set to be true, AnswerFeedback.clicked will be updated to be true. "clickedUris": [ # The URIs clicked by the human agent. The value is appended for each UpdateAnswerRecordRequest. If the value is not empty, AnswerFeedback.clicked will be updated to be true. @@ -3057,6 +3075,12 @@

Method Details

"answerRelevance": "A String", # Optional. Whether or not the suggested answer is relevant. For example: * Query: "Can I change my mailing address?" * Suggested document says: "Items must be returned/exchanged within 60 days of the purchase date." * answer_relevance: AnswerRelevance.IRRELEVANT "documentCorrectness": "A String", # Optional. Whether or not the information in the document is correct. For example: * Query: "Can I return the package in 2 days once received?" * Suggested document says: "Items must be returned/exchanged within 60 days of the purchase date." * Ground truth: "No return or exchange is allowed." * [document_correctness]: INCORRECT "documentEfficiency": "A String", # Optional. Whether or not the suggested document is efficient. For example, if the document is poorly written, hard to understand, hard to use or too long to find useful information, document_efficiency is DocumentEfficiency.INEFFICIENT. + "knowledgeAssistFeedback": { # Feedback for knowledge assist. # Optional. Feedback for knowledge assist. + "answerCopied": True or False, # Whether the suggested answer was copied by the human agent. If the value is set to be true, AnswerFeedback.clicked will be updated to be true. + "clickedUris": [ # The URIs clicked by the human agent. The value is appended for each UpdateAnswerRecordRequest. If the value is not empty, AnswerFeedback.clicked will be updated to be true. + "A String", + ], + }, "knowledgeSearchFeedback": { # Feedback for knowledge search. # Optional. Feedback for knowledge search. "answerCopied": True or False, # Whether the answer was copied by the human agent or not. If the value is set to be true, AnswerFeedback.clicked will be updated to be true. "clickedUris": [ # The URIs clicked by the human agent. The value is appended for each UpdateAnswerRecordRequest. If the value is not empty, AnswerFeedback.clicked will be updated to be true. diff --git a/docs/dyn/dialogflow_v2beta1.projects.conversationProfiles.html b/docs/dyn/dialogflow_v2beta1.projects.conversationProfiles.html index a0b7c0002c3..2893221f650 100644 --- a/docs/dyn/dialogflow_v2beta1.projects.conversationProfiles.html +++ b/docs/dyn/dialogflow_v2beta1.projects.conversationProfiles.html @@ -168,6 +168,7 @@

Method Details

"displayName": "A String", # Required. Human readable name for this profile. Max length 1024 bytes. "humanAgentAssistantConfig": { # Defines the Human Agent Assistant to connect to a conversation. # Configuration for agent assistance to use with this profile. "endUserSuggestionConfig": { # Detail human agent assistant config. # Configuration for agent assistance of end user participant. Currently, this feature is not general available, please contact Google to get access. + "disableHighLatencyFeaturesSyncDelivery": True or False, # Optional. When disable_high_latency_features_sync_delivery is true and using the AnalyzeContent API, we will not deliver the responses from high latency features in the API response. The human_agent_assistant_config.notification_config must be configured and enable_event_based_suggestion must be set to true to receive the responses from high latency features in Pub/Sub. High latency feature(s): KNOWLEDGE_ASSIST. "featureConfigs": [ # Configuration of different suggestion features. One feature can have only one config. { # Config for suggestion features. "conversationModelConfig": { # Custom conversation models used in agent assist feature. Supported feature: ARTICLE_SUGGESTION, SMART_COMPOSE, SMART_REPLY, CONVERSATION_SUMMARIZATION. # Configs of custom conversation model. @@ -180,6 +181,8 @@

Method Details

"disableAgentQueryLogging": True or False, # Optional. Disable the logging of search queries sent by human agents. It can prevent those queries from being stored at answer records. Supported features: KNOWLEDGE_SEARCH. "enableConversationAugmentedQuery": True or False, # Optional. Enable including conversation context during query answer generation. Supported features: KNOWLEDGE_SEARCH. "enableEventBasedSuggestion": True or False, # Automatically iterates all participants and tries to compile suggestions. Supported features: ARTICLE_SUGGESTION, FAQ, DIALOGFLOW_ASSIST, ENTITY_EXTRACTION, KNOWLEDGE_ASSIST. + "enableQuerySuggestionOnly": True or False, # Optional. Enable query suggestion only. Supported features: KNOWLEDGE_ASSIST + "enableQuerySuggestionWhenNoAnswer": True or False, # Optional. Enable query suggestion even if we can't find its answer. By default, queries are suggested only if we find its answer. Supported features: KNOWLEDGE_ASSIST "queryConfig": { # Config for suggestion query. # Configs of query. "confidenceThreshold": 3.14, # Confidence threshold of query result. Agent Assist gives each suggestion a score in the range [0.0, 1.0], based on the relevance between the suggestion and the current conversation context. A score of 0.0 has no relevance, while a score of 1.0 has high relevance. Only suggestions with a score greater than or equal to the value of this field are included in the results. For a baseline model (the default), the recommended value is in the range [0.05, 0.1]. For a custom model, there is no recommended value. Tune this value by starting from a very low value and slowly increasing until you have desired results. If this field is not set, it is default to 0.0, which means that all suggestions are returned. Supported features: ARTICLE_SUGGESTION, FAQ, SMART_REPLY, SMART_COMPOSE, KNOWLEDGE_SEARCH, KNOWLEDGE_ASSIST, ENTITY_EXTRACTION. "contextFilterSettings": { # Settings that determine how to filter recent conversation context when generating suggestions. # Determines how recent conversation context is filtered when generating suggestions. If unspecified, no messages will be dropped. @@ -225,6 +228,7 @@

Method Details

"groupSuggestionResponses": True or False, # If `group_suggestion_responses` is false, and there are multiple `feature_configs` in `event based suggestion` or StreamingAnalyzeContent, we will try to deliver suggestions to customers as soon as we get new suggestion. Different type of suggestions based on the same context will be in separate Pub/Sub event or `StreamingAnalyzeContentResponse`. If `group_suggestion_responses` set to true. All the suggestions to the same participant based on the same context will be grouped into a single Pub/Sub event or StreamingAnalyzeContentResponse. }, "humanAgentSuggestionConfig": { # Detail human agent assistant config. # Configuration for agent assistance of human agent participant. + "disableHighLatencyFeaturesSyncDelivery": True or False, # Optional. When disable_high_latency_features_sync_delivery is true and using the AnalyzeContent API, we will not deliver the responses from high latency features in the API response. The human_agent_assistant_config.notification_config must be configured and enable_event_based_suggestion must be set to true to receive the responses from high latency features in Pub/Sub. High latency feature(s): KNOWLEDGE_ASSIST. "featureConfigs": [ # Configuration of different suggestion features. One feature can have only one config. { # Config for suggestion features. "conversationModelConfig": { # Custom conversation models used in agent assist feature. Supported feature: ARTICLE_SUGGESTION, SMART_COMPOSE, SMART_REPLY, CONVERSATION_SUMMARIZATION. # Configs of custom conversation model. @@ -237,6 +241,8 @@

Method Details

"disableAgentQueryLogging": True or False, # Optional. Disable the logging of search queries sent by human agents. It can prevent those queries from being stored at answer records. Supported features: KNOWLEDGE_SEARCH. "enableConversationAugmentedQuery": True or False, # Optional. Enable including conversation context during query answer generation. Supported features: KNOWLEDGE_SEARCH. "enableEventBasedSuggestion": True or False, # Automatically iterates all participants and tries to compile suggestions. Supported features: ARTICLE_SUGGESTION, FAQ, DIALOGFLOW_ASSIST, ENTITY_EXTRACTION, KNOWLEDGE_ASSIST. + "enableQuerySuggestionOnly": True or False, # Optional. Enable query suggestion only. Supported features: KNOWLEDGE_ASSIST + "enableQuerySuggestionWhenNoAnswer": True or False, # Optional. Enable query suggestion even if we can't find its answer. By default, queries are suggested only if we find its answer. Supported features: KNOWLEDGE_ASSIST "queryConfig": { # Config for suggestion query. # Configs of query. "confidenceThreshold": 3.14, # Confidence threshold of query result. Agent Assist gives each suggestion a score in the range [0.0, 1.0], based on the relevance between the suggestion and the current conversation context. A score of 0.0 has no relevance, while a score of 1.0 has high relevance. Only suggestions with a score greater than or equal to the value of this field are included in the results. For a baseline model (the default), the recommended value is in the range [0.05, 0.1]. For a custom model, there is no recommended value. Tune this value by starting from a very low value and slowly increasing until you have desired results. If this field is not set, it is default to 0.0, which means that all suggestions are returned. Supported features: ARTICLE_SUGGESTION, FAQ, SMART_REPLY, SMART_COMPOSE, KNOWLEDGE_SEARCH, KNOWLEDGE_ASSIST, ENTITY_EXTRACTION. "contextFilterSettings": { # Settings that determine how to filter recent conversation context when generating suggestions. # Determines how recent conversation context is filtered when generating suggestions. If unspecified, no messages will be dropped. @@ -353,6 +359,7 @@

Method Details

"displayName": "A String", # Required. Human readable name for this profile. Max length 1024 bytes. "humanAgentAssistantConfig": { # Defines the Human Agent Assistant to connect to a conversation. # Configuration for agent assistance to use with this profile. "endUserSuggestionConfig": { # Detail human agent assistant config. # Configuration for agent assistance of end user participant. Currently, this feature is not general available, please contact Google to get access. + "disableHighLatencyFeaturesSyncDelivery": True or False, # Optional. When disable_high_latency_features_sync_delivery is true and using the AnalyzeContent API, we will not deliver the responses from high latency features in the API response. The human_agent_assistant_config.notification_config must be configured and enable_event_based_suggestion must be set to true to receive the responses from high latency features in Pub/Sub. High latency feature(s): KNOWLEDGE_ASSIST. "featureConfigs": [ # Configuration of different suggestion features. One feature can have only one config. { # Config for suggestion features. "conversationModelConfig": { # Custom conversation models used in agent assist feature. Supported feature: ARTICLE_SUGGESTION, SMART_COMPOSE, SMART_REPLY, CONVERSATION_SUMMARIZATION. # Configs of custom conversation model. @@ -365,6 +372,8 @@

Method Details

"disableAgentQueryLogging": True or False, # Optional. Disable the logging of search queries sent by human agents. It can prevent those queries from being stored at answer records. Supported features: KNOWLEDGE_SEARCH. "enableConversationAugmentedQuery": True or False, # Optional. Enable including conversation context during query answer generation. Supported features: KNOWLEDGE_SEARCH. "enableEventBasedSuggestion": True or False, # Automatically iterates all participants and tries to compile suggestions. Supported features: ARTICLE_SUGGESTION, FAQ, DIALOGFLOW_ASSIST, ENTITY_EXTRACTION, KNOWLEDGE_ASSIST. + "enableQuerySuggestionOnly": True or False, # Optional. Enable query suggestion only. Supported features: KNOWLEDGE_ASSIST + "enableQuerySuggestionWhenNoAnswer": True or False, # Optional. Enable query suggestion even if we can't find its answer. By default, queries are suggested only if we find its answer. Supported features: KNOWLEDGE_ASSIST "queryConfig": { # Config for suggestion query. # Configs of query. "confidenceThreshold": 3.14, # Confidence threshold of query result. Agent Assist gives each suggestion a score in the range [0.0, 1.0], based on the relevance between the suggestion and the current conversation context. A score of 0.0 has no relevance, while a score of 1.0 has high relevance. Only suggestions with a score greater than or equal to the value of this field are included in the results. For a baseline model (the default), the recommended value is in the range [0.05, 0.1]. For a custom model, there is no recommended value. Tune this value by starting from a very low value and slowly increasing until you have desired results. If this field is not set, it is default to 0.0, which means that all suggestions are returned. Supported features: ARTICLE_SUGGESTION, FAQ, SMART_REPLY, SMART_COMPOSE, KNOWLEDGE_SEARCH, KNOWLEDGE_ASSIST, ENTITY_EXTRACTION. "contextFilterSettings": { # Settings that determine how to filter recent conversation context when generating suggestions. # Determines how recent conversation context is filtered when generating suggestions. If unspecified, no messages will be dropped. @@ -410,6 +419,7 @@

Method Details

"groupSuggestionResponses": True or False, # If `group_suggestion_responses` is false, and there are multiple `feature_configs` in `event based suggestion` or StreamingAnalyzeContent, we will try to deliver suggestions to customers as soon as we get new suggestion. Different type of suggestions based on the same context will be in separate Pub/Sub event or `StreamingAnalyzeContentResponse`. If `group_suggestion_responses` set to true. All the suggestions to the same participant based on the same context will be grouped into a single Pub/Sub event or StreamingAnalyzeContentResponse. }, "humanAgentSuggestionConfig": { # Detail human agent assistant config. # Configuration for agent assistance of human agent participant. + "disableHighLatencyFeaturesSyncDelivery": True or False, # Optional. When disable_high_latency_features_sync_delivery is true and using the AnalyzeContent API, we will not deliver the responses from high latency features in the API response. The human_agent_assistant_config.notification_config must be configured and enable_event_based_suggestion must be set to true to receive the responses from high latency features in Pub/Sub. High latency feature(s): KNOWLEDGE_ASSIST. "featureConfigs": [ # Configuration of different suggestion features. One feature can have only one config. { # Config for suggestion features. "conversationModelConfig": { # Custom conversation models used in agent assist feature. Supported feature: ARTICLE_SUGGESTION, SMART_COMPOSE, SMART_REPLY, CONVERSATION_SUMMARIZATION. # Configs of custom conversation model. @@ -422,6 +432,8 @@

Method Details

"disableAgentQueryLogging": True or False, # Optional. Disable the logging of search queries sent by human agents. It can prevent those queries from being stored at answer records. Supported features: KNOWLEDGE_SEARCH. "enableConversationAugmentedQuery": True or False, # Optional. Enable including conversation context during query answer generation. Supported features: KNOWLEDGE_SEARCH. "enableEventBasedSuggestion": True or False, # Automatically iterates all participants and tries to compile suggestions. Supported features: ARTICLE_SUGGESTION, FAQ, DIALOGFLOW_ASSIST, ENTITY_EXTRACTION, KNOWLEDGE_ASSIST. + "enableQuerySuggestionOnly": True or False, # Optional. Enable query suggestion only. Supported features: KNOWLEDGE_ASSIST + "enableQuerySuggestionWhenNoAnswer": True or False, # Optional. Enable query suggestion even if we can't find its answer. By default, queries are suggested only if we find its answer. Supported features: KNOWLEDGE_ASSIST "queryConfig": { # Config for suggestion query. # Configs of query. "confidenceThreshold": 3.14, # Confidence threshold of query result. Agent Assist gives each suggestion a score in the range [0.0, 1.0], based on the relevance between the suggestion and the current conversation context. A score of 0.0 has no relevance, while a score of 1.0 has high relevance. Only suggestions with a score greater than or equal to the value of this field are included in the results. For a baseline model (the default), the recommended value is in the range [0.05, 0.1]. For a custom model, there is no recommended value. Tune this value by starting from a very low value and slowly increasing until you have desired results. If this field is not set, it is default to 0.0, which means that all suggestions are returned. Supported features: ARTICLE_SUGGESTION, FAQ, SMART_REPLY, SMART_COMPOSE, KNOWLEDGE_SEARCH, KNOWLEDGE_ASSIST, ENTITY_EXTRACTION. "contextFilterSettings": { # Settings that determine how to filter recent conversation context when generating suggestions. # Determines how recent conversation context is filtered when generating suggestions. If unspecified, no messages will be dropped. @@ -563,6 +575,7 @@

Method Details

"displayName": "A String", # Required. Human readable name for this profile. Max length 1024 bytes. "humanAgentAssistantConfig": { # Defines the Human Agent Assistant to connect to a conversation. # Configuration for agent assistance to use with this profile. "endUserSuggestionConfig": { # Detail human agent assistant config. # Configuration for agent assistance of end user participant. Currently, this feature is not general available, please contact Google to get access. + "disableHighLatencyFeaturesSyncDelivery": True or False, # Optional. When disable_high_latency_features_sync_delivery is true and using the AnalyzeContent API, we will not deliver the responses from high latency features in the API response. The human_agent_assistant_config.notification_config must be configured and enable_event_based_suggestion must be set to true to receive the responses from high latency features in Pub/Sub. High latency feature(s): KNOWLEDGE_ASSIST. "featureConfigs": [ # Configuration of different suggestion features. One feature can have only one config. { # Config for suggestion features. "conversationModelConfig": { # Custom conversation models used in agent assist feature. Supported feature: ARTICLE_SUGGESTION, SMART_COMPOSE, SMART_REPLY, CONVERSATION_SUMMARIZATION. # Configs of custom conversation model. @@ -575,6 +588,8 @@

Method Details

"disableAgentQueryLogging": True or False, # Optional. Disable the logging of search queries sent by human agents. It can prevent those queries from being stored at answer records. Supported features: KNOWLEDGE_SEARCH. "enableConversationAugmentedQuery": True or False, # Optional. Enable including conversation context during query answer generation. Supported features: KNOWLEDGE_SEARCH. "enableEventBasedSuggestion": True or False, # Automatically iterates all participants and tries to compile suggestions. Supported features: ARTICLE_SUGGESTION, FAQ, DIALOGFLOW_ASSIST, ENTITY_EXTRACTION, KNOWLEDGE_ASSIST. + "enableQuerySuggestionOnly": True or False, # Optional. Enable query suggestion only. Supported features: KNOWLEDGE_ASSIST + "enableQuerySuggestionWhenNoAnswer": True or False, # Optional. Enable query suggestion even if we can't find its answer. By default, queries are suggested only if we find its answer. Supported features: KNOWLEDGE_ASSIST "queryConfig": { # Config for suggestion query. # Configs of query. "confidenceThreshold": 3.14, # Confidence threshold of query result. Agent Assist gives each suggestion a score in the range [0.0, 1.0], based on the relevance between the suggestion and the current conversation context. A score of 0.0 has no relevance, while a score of 1.0 has high relevance. Only suggestions with a score greater than or equal to the value of this field are included in the results. For a baseline model (the default), the recommended value is in the range [0.05, 0.1]. For a custom model, there is no recommended value. Tune this value by starting from a very low value and slowly increasing until you have desired results. If this field is not set, it is default to 0.0, which means that all suggestions are returned. Supported features: ARTICLE_SUGGESTION, FAQ, SMART_REPLY, SMART_COMPOSE, KNOWLEDGE_SEARCH, KNOWLEDGE_ASSIST, ENTITY_EXTRACTION. "contextFilterSettings": { # Settings that determine how to filter recent conversation context when generating suggestions. # Determines how recent conversation context is filtered when generating suggestions. If unspecified, no messages will be dropped. @@ -620,6 +635,7 @@

Method Details

"groupSuggestionResponses": True or False, # If `group_suggestion_responses` is false, and there are multiple `feature_configs` in `event based suggestion` or StreamingAnalyzeContent, we will try to deliver suggestions to customers as soon as we get new suggestion. Different type of suggestions based on the same context will be in separate Pub/Sub event or `StreamingAnalyzeContentResponse`. If `group_suggestion_responses` set to true. All the suggestions to the same participant based on the same context will be grouped into a single Pub/Sub event or StreamingAnalyzeContentResponse. }, "humanAgentSuggestionConfig": { # Detail human agent assistant config. # Configuration for agent assistance of human agent participant. + "disableHighLatencyFeaturesSyncDelivery": True or False, # Optional. When disable_high_latency_features_sync_delivery is true and using the AnalyzeContent API, we will not deliver the responses from high latency features in the API response. The human_agent_assistant_config.notification_config must be configured and enable_event_based_suggestion must be set to true to receive the responses from high latency features in Pub/Sub. High latency feature(s): KNOWLEDGE_ASSIST. "featureConfigs": [ # Configuration of different suggestion features. One feature can have only one config. { # Config for suggestion features. "conversationModelConfig": { # Custom conversation models used in agent assist feature. Supported feature: ARTICLE_SUGGESTION, SMART_COMPOSE, SMART_REPLY, CONVERSATION_SUMMARIZATION. # Configs of custom conversation model. @@ -632,6 +648,8 @@

Method Details

"disableAgentQueryLogging": True or False, # Optional. Disable the logging of search queries sent by human agents. It can prevent those queries from being stored at answer records. Supported features: KNOWLEDGE_SEARCH. "enableConversationAugmentedQuery": True or False, # Optional. Enable including conversation context during query answer generation. Supported features: KNOWLEDGE_SEARCH. "enableEventBasedSuggestion": True or False, # Automatically iterates all participants and tries to compile suggestions. Supported features: ARTICLE_SUGGESTION, FAQ, DIALOGFLOW_ASSIST, ENTITY_EXTRACTION, KNOWLEDGE_ASSIST. + "enableQuerySuggestionOnly": True or False, # Optional. Enable query suggestion only. Supported features: KNOWLEDGE_ASSIST + "enableQuerySuggestionWhenNoAnswer": True or False, # Optional. Enable query suggestion even if we can't find its answer. By default, queries are suggested only if we find its answer. Supported features: KNOWLEDGE_ASSIST "queryConfig": { # Config for suggestion query. # Configs of query. "confidenceThreshold": 3.14, # Confidence threshold of query result. Agent Assist gives each suggestion a score in the range [0.0, 1.0], based on the relevance between the suggestion and the current conversation context. A score of 0.0 has no relevance, while a score of 1.0 has high relevance. Only suggestions with a score greater than or equal to the value of this field are included in the results. For a baseline model (the default), the recommended value is in the range [0.05, 0.1]. For a custom model, there is no recommended value. Tune this value by starting from a very low value and slowly increasing until you have desired results. If this field is not set, it is default to 0.0, which means that all suggestions are returned. Supported features: ARTICLE_SUGGESTION, FAQ, SMART_REPLY, SMART_COMPOSE, KNOWLEDGE_SEARCH, KNOWLEDGE_ASSIST, ENTITY_EXTRACTION. "contextFilterSettings": { # Settings that determine how to filter recent conversation context when generating suggestions. # Determines how recent conversation context is filtered when generating suggestions. If unspecified, no messages will be dropped. @@ -759,6 +777,7 @@

Method Details

"displayName": "A String", # Required. Human readable name for this profile. Max length 1024 bytes. "humanAgentAssistantConfig": { # Defines the Human Agent Assistant to connect to a conversation. # Configuration for agent assistance to use with this profile. "endUserSuggestionConfig": { # Detail human agent assistant config. # Configuration for agent assistance of end user participant. Currently, this feature is not general available, please contact Google to get access. + "disableHighLatencyFeaturesSyncDelivery": True or False, # Optional. When disable_high_latency_features_sync_delivery is true and using the AnalyzeContent API, we will not deliver the responses from high latency features in the API response. The human_agent_assistant_config.notification_config must be configured and enable_event_based_suggestion must be set to true to receive the responses from high latency features in Pub/Sub. High latency feature(s): KNOWLEDGE_ASSIST. "featureConfigs": [ # Configuration of different suggestion features. One feature can have only one config. { # Config for suggestion features. "conversationModelConfig": { # Custom conversation models used in agent assist feature. Supported feature: ARTICLE_SUGGESTION, SMART_COMPOSE, SMART_REPLY, CONVERSATION_SUMMARIZATION. # Configs of custom conversation model. @@ -771,6 +790,8 @@

Method Details

"disableAgentQueryLogging": True or False, # Optional. Disable the logging of search queries sent by human agents. It can prevent those queries from being stored at answer records. Supported features: KNOWLEDGE_SEARCH. "enableConversationAugmentedQuery": True or False, # Optional. Enable including conversation context during query answer generation. Supported features: KNOWLEDGE_SEARCH. "enableEventBasedSuggestion": True or False, # Automatically iterates all participants and tries to compile suggestions. Supported features: ARTICLE_SUGGESTION, FAQ, DIALOGFLOW_ASSIST, ENTITY_EXTRACTION, KNOWLEDGE_ASSIST. + "enableQuerySuggestionOnly": True or False, # Optional. Enable query suggestion only. Supported features: KNOWLEDGE_ASSIST + "enableQuerySuggestionWhenNoAnswer": True or False, # Optional. Enable query suggestion even if we can't find its answer. By default, queries are suggested only if we find its answer. Supported features: KNOWLEDGE_ASSIST "queryConfig": { # Config for suggestion query. # Configs of query. "confidenceThreshold": 3.14, # Confidence threshold of query result. Agent Assist gives each suggestion a score in the range [0.0, 1.0], based on the relevance between the suggestion and the current conversation context. A score of 0.0 has no relevance, while a score of 1.0 has high relevance. Only suggestions with a score greater than or equal to the value of this field are included in the results. For a baseline model (the default), the recommended value is in the range [0.05, 0.1]. For a custom model, there is no recommended value. Tune this value by starting from a very low value and slowly increasing until you have desired results. If this field is not set, it is default to 0.0, which means that all suggestions are returned. Supported features: ARTICLE_SUGGESTION, FAQ, SMART_REPLY, SMART_COMPOSE, KNOWLEDGE_SEARCH, KNOWLEDGE_ASSIST, ENTITY_EXTRACTION. "contextFilterSettings": { # Settings that determine how to filter recent conversation context when generating suggestions. # Determines how recent conversation context is filtered when generating suggestions. If unspecified, no messages will be dropped. @@ -816,6 +837,7 @@

Method Details

"groupSuggestionResponses": True or False, # If `group_suggestion_responses` is false, and there are multiple `feature_configs` in `event based suggestion` or StreamingAnalyzeContent, we will try to deliver suggestions to customers as soon as we get new suggestion. Different type of suggestions based on the same context will be in separate Pub/Sub event or `StreamingAnalyzeContentResponse`. If `group_suggestion_responses` set to true. All the suggestions to the same participant based on the same context will be grouped into a single Pub/Sub event or StreamingAnalyzeContentResponse. }, "humanAgentSuggestionConfig": { # Detail human agent assistant config. # Configuration for agent assistance of human agent participant. + "disableHighLatencyFeaturesSyncDelivery": True or False, # Optional. When disable_high_latency_features_sync_delivery is true and using the AnalyzeContent API, we will not deliver the responses from high latency features in the API response. The human_agent_assistant_config.notification_config must be configured and enable_event_based_suggestion must be set to true to receive the responses from high latency features in Pub/Sub. High latency feature(s): KNOWLEDGE_ASSIST. "featureConfigs": [ # Configuration of different suggestion features. One feature can have only one config. { # Config for suggestion features. "conversationModelConfig": { # Custom conversation models used in agent assist feature. Supported feature: ARTICLE_SUGGESTION, SMART_COMPOSE, SMART_REPLY, CONVERSATION_SUMMARIZATION. # Configs of custom conversation model. @@ -828,6 +850,8 @@

Method Details

"disableAgentQueryLogging": True or False, # Optional. Disable the logging of search queries sent by human agents. It can prevent those queries from being stored at answer records. Supported features: KNOWLEDGE_SEARCH. "enableConversationAugmentedQuery": True or False, # Optional. Enable including conversation context during query answer generation. Supported features: KNOWLEDGE_SEARCH. "enableEventBasedSuggestion": True or False, # Automatically iterates all participants and tries to compile suggestions. Supported features: ARTICLE_SUGGESTION, FAQ, DIALOGFLOW_ASSIST, ENTITY_EXTRACTION, KNOWLEDGE_ASSIST. + "enableQuerySuggestionOnly": True or False, # Optional. Enable query suggestion only. Supported features: KNOWLEDGE_ASSIST + "enableQuerySuggestionWhenNoAnswer": True or False, # Optional. Enable query suggestion even if we can't find its answer. By default, queries are suggested only if we find its answer. Supported features: KNOWLEDGE_ASSIST "queryConfig": { # Config for suggestion query. # Configs of query. "confidenceThreshold": 3.14, # Confidence threshold of query result. Agent Assist gives each suggestion a score in the range [0.0, 1.0], based on the relevance between the suggestion and the current conversation context. A score of 0.0 has no relevance, while a score of 1.0 has high relevance. Only suggestions with a score greater than or equal to the value of this field are included in the results. For a baseline model (the default), the recommended value is in the range [0.05, 0.1]. For a custom model, there is no recommended value. Tune this value by starting from a very low value and slowly increasing until you have desired results. If this field is not set, it is default to 0.0, which means that all suggestions are returned. Supported features: ARTICLE_SUGGESTION, FAQ, SMART_REPLY, SMART_COMPOSE, KNOWLEDGE_SEARCH, KNOWLEDGE_ASSIST, ENTITY_EXTRACTION. "contextFilterSettings": { # Settings that determine how to filter recent conversation context when generating suggestions. # Determines how recent conversation context is filtered when generating suggestions. If unspecified, no messages will be dropped. @@ -963,6 +987,7 @@

Method Details

"displayName": "A String", # Required. Human readable name for this profile. Max length 1024 bytes. "humanAgentAssistantConfig": { # Defines the Human Agent Assistant to connect to a conversation. # Configuration for agent assistance to use with this profile. "endUserSuggestionConfig": { # Detail human agent assistant config. # Configuration for agent assistance of end user participant. Currently, this feature is not general available, please contact Google to get access. + "disableHighLatencyFeaturesSyncDelivery": True or False, # Optional. When disable_high_latency_features_sync_delivery is true and using the AnalyzeContent API, we will not deliver the responses from high latency features in the API response. The human_agent_assistant_config.notification_config must be configured and enable_event_based_suggestion must be set to true to receive the responses from high latency features in Pub/Sub. High latency feature(s): KNOWLEDGE_ASSIST. "featureConfigs": [ # Configuration of different suggestion features. One feature can have only one config. { # Config for suggestion features. "conversationModelConfig": { # Custom conversation models used in agent assist feature. Supported feature: ARTICLE_SUGGESTION, SMART_COMPOSE, SMART_REPLY, CONVERSATION_SUMMARIZATION. # Configs of custom conversation model. @@ -975,6 +1000,8 @@

Method Details

"disableAgentQueryLogging": True or False, # Optional. Disable the logging of search queries sent by human agents. It can prevent those queries from being stored at answer records. Supported features: KNOWLEDGE_SEARCH. "enableConversationAugmentedQuery": True or False, # Optional. Enable including conversation context during query answer generation. Supported features: KNOWLEDGE_SEARCH. "enableEventBasedSuggestion": True or False, # Automatically iterates all participants and tries to compile suggestions. Supported features: ARTICLE_SUGGESTION, FAQ, DIALOGFLOW_ASSIST, ENTITY_EXTRACTION, KNOWLEDGE_ASSIST. + "enableQuerySuggestionOnly": True or False, # Optional. Enable query suggestion only. Supported features: KNOWLEDGE_ASSIST + "enableQuerySuggestionWhenNoAnswer": True or False, # Optional. Enable query suggestion even if we can't find its answer. By default, queries are suggested only if we find its answer. Supported features: KNOWLEDGE_ASSIST "queryConfig": { # Config for suggestion query. # Configs of query. "confidenceThreshold": 3.14, # Confidence threshold of query result. Agent Assist gives each suggestion a score in the range [0.0, 1.0], based on the relevance between the suggestion and the current conversation context. A score of 0.0 has no relevance, while a score of 1.0 has high relevance. Only suggestions with a score greater than or equal to the value of this field are included in the results. For a baseline model (the default), the recommended value is in the range [0.05, 0.1]. For a custom model, there is no recommended value. Tune this value by starting from a very low value and slowly increasing until you have desired results. If this field is not set, it is default to 0.0, which means that all suggestions are returned. Supported features: ARTICLE_SUGGESTION, FAQ, SMART_REPLY, SMART_COMPOSE, KNOWLEDGE_SEARCH, KNOWLEDGE_ASSIST, ENTITY_EXTRACTION. "contextFilterSettings": { # Settings that determine how to filter recent conversation context when generating suggestions. # Determines how recent conversation context is filtered when generating suggestions. If unspecified, no messages will be dropped. @@ -1020,6 +1047,7 @@

Method Details

"groupSuggestionResponses": True or False, # If `group_suggestion_responses` is false, and there are multiple `feature_configs` in `event based suggestion` or StreamingAnalyzeContent, we will try to deliver suggestions to customers as soon as we get new suggestion. Different type of suggestions based on the same context will be in separate Pub/Sub event or `StreamingAnalyzeContentResponse`. If `group_suggestion_responses` set to true. All the suggestions to the same participant based on the same context will be grouped into a single Pub/Sub event or StreamingAnalyzeContentResponse. }, "humanAgentSuggestionConfig": { # Detail human agent assistant config. # Configuration for agent assistance of human agent participant. + "disableHighLatencyFeaturesSyncDelivery": True or False, # Optional. When disable_high_latency_features_sync_delivery is true and using the AnalyzeContent API, we will not deliver the responses from high latency features in the API response. The human_agent_assistant_config.notification_config must be configured and enable_event_based_suggestion must be set to true to receive the responses from high latency features in Pub/Sub. High latency feature(s): KNOWLEDGE_ASSIST. "featureConfigs": [ # Configuration of different suggestion features. One feature can have only one config. { # Config for suggestion features. "conversationModelConfig": { # Custom conversation models used in agent assist feature. Supported feature: ARTICLE_SUGGESTION, SMART_COMPOSE, SMART_REPLY, CONVERSATION_SUMMARIZATION. # Configs of custom conversation model. @@ -1032,6 +1060,8 @@

Method Details

"disableAgentQueryLogging": True or False, # Optional. Disable the logging of search queries sent by human agents. It can prevent those queries from being stored at answer records. Supported features: KNOWLEDGE_SEARCH. "enableConversationAugmentedQuery": True or False, # Optional. Enable including conversation context during query answer generation. Supported features: KNOWLEDGE_SEARCH. "enableEventBasedSuggestion": True or False, # Automatically iterates all participants and tries to compile suggestions. Supported features: ARTICLE_SUGGESTION, FAQ, DIALOGFLOW_ASSIST, ENTITY_EXTRACTION, KNOWLEDGE_ASSIST. + "enableQuerySuggestionOnly": True or False, # Optional. Enable query suggestion only. Supported features: KNOWLEDGE_ASSIST + "enableQuerySuggestionWhenNoAnswer": True or False, # Optional. Enable query suggestion even if we can't find its answer. By default, queries are suggested only if we find its answer. Supported features: KNOWLEDGE_ASSIST "queryConfig": { # Config for suggestion query. # Configs of query. "confidenceThreshold": 3.14, # Confidence threshold of query result. Agent Assist gives each suggestion a score in the range [0.0, 1.0], based on the relevance between the suggestion and the current conversation context. A score of 0.0 has no relevance, while a score of 1.0 has high relevance. Only suggestions with a score greater than or equal to the value of this field are included in the results. For a baseline model (the default), the recommended value is in the range [0.05, 0.1]. For a custom model, there is no recommended value. Tune this value by starting from a very low value and slowly increasing until you have desired results. If this field is not set, it is default to 0.0, which means that all suggestions are returned. Supported features: ARTICLE_SUGGESTION, FAQ, SMART_REPLY, SMART_COMPOSE, KNOWLEDGE_SEARCH, KNOWLEDGE_ASSIST, ENTITY_EXTRACTION. "contextFilterSettings": { # Settings that determine how to filter recent conversation context when generating suggestions. # Determines how recent conversation context is filtered when generating suggestions. If unspecified, no messages will be dropped. @@ -1149,6 +1179,7 @@

Method Details

"displayName": "A String", # Required. Human readable name for this profile. Max length 1024 bytes. "humanAgentAssistantConfig": { # Defines the Human Agent Assistant to connect to a conversation. # Configuration for agent assistance to use with this profile. "endUserSuggestionConfig": { # Detail human agent assistant config. # Configuration for agent assistance of end user participant. Currently, this feature is not general available, please contact Google to get access. + "disableHighLatencyFeaturesSyncDelivery": True or False, # Optional. When disable_high_latency_features_sync_delivery is true and using the AnalyzeContent API, we will not deliver the responses from high latency features in the API response. The human_agent_assistant_config.notification_config must be configured and enable_event_based_suggestion must be set to true to receive the responses from high latency features in Pub/Sub. High latency feature(s): KNOWLEDGE_ASSIST. "featureConfigs": [ # Configuration of different suggestion features. One feature can have only one config. { # Config for suggestion features. "conversationModelConfig": { # Custom conversation models used in agent assist feature. Supported feature: ARTICLE_SUGGESTION, SMART_COMPOSE, SMART_REPLY, CONVERSATION_SUMMARIZATION. # Configs of custom conversation model. @@ -1161,6 +1192,8 @@

Method Details

"disableAgentQueryLogging": True or False, # Optional. Disable the logging of search queries sent by human agents. It can prevent those queries from being stored at answer records. Supported features: KNOWLEDGE_SEARCH. "enableConversationAugmentedQuery": True or False, # Optional. Enable including conversation context during query answer generation. Supported features: KNOWLEDGE_SEARCH. "enableEventBasedSuggestion": True or False, # Automatically iterates all participants and tries to compile suggestions. Supported features: ARTICLE_SUGGESTION, FAQ, DIALOGFLOW_ASSIST, ENTITY_EXTRACTION, KNOWLEDGE_ASSIST. + "enableQuerySuggestionOnly": True or False, # Optional. Enable query suggestion only. Supported features: KNOWLEDGE_ASSIST + "enableQuerySuggestionWhenNoAnswer": True or False, # Optional. Enable query suggestion even if we can't find its answer. By default, queries are suggested only if we find its answer. Supported features: KNOWLEDGE_ASSIST "queryConfig": { # Config for suggestion query. # Configs of query. "confidenceThreshold": 3.14, # Confidence threshold of query result. Agent Assist gives each suggestion a score in the range [0.0, 1.0], based on the relevance between the suggestion and the current conversation context. A score of 0.0 has no relevance, while a score of 1.0 has high relevance. Only suggestions with a score greater than or equal to the value of this field are included in the results. For a baseline model (the default), the recommended value is in the range [0.05, 0.1]. For a custom model, there is no recommended value. Tune this value by starting from a very low value and slowly increasing until you have desired results. If this field is not set, it is default to 0.0, which means that all suggestions are returned. Supported features: ARTICLE_SUGGESTION, FAQ, SMART_REPLY, SMART_COMPOSE, KNOWLEDGE_SEARCH, KNOWLEDGE_ASSIST, ENTITY_EXTRACTION. "contextFilterSettings": { # Settings that determine how to filter recent conversation context when generating suggestions. # Determines how recent conversation context is filtered when generating suggestions. If unspecified, no messages will be dropped. @@ -1206,6 +1239,7 @@

Method Details

"groupSuggestionResponses": True or False, # If `group_suggestion_responses` is false, and there are multiple `feature_configs` in `event based suggestion` or StreamingAnalyzeContent, we will try to deliver suggestions to customers as soon as we get new suggestion. Different type of suggestions based on the same context will be in separate Pub/Sub event or `StreamingAnalyzeContentResponse`. If `group_suggestion_responses` set to true. All the suggestions to the same participant based on the same context will be grouped into a single Pub/Sub event or StreamingAnalyzeContentResponse. }, "humanAgentSuggestionConfig": { # Detail human agent assistant config. # Configuration for agent assistance of human agent participant. + "disableHighLatencyFeaturesSyncDelivery": True or False, # Optional. When disable_high_latency_features_sync_delivery is true and using the AnalyzeContent API, we will not deliver the responses from high latency features in the API response. The human_agent_assistant_config.notification_config must be configured and enable_event_based_suggestion must be set to true to receive the responses from high latency features in Pub/Sub. High latency feature(s): KNOWLEDGE_ASSIST. "featureConfigs": [ # Configuration of different suggestion features. One feature can have only one config. { # Config for suggestion features. "conversationModelConfig": { # Custom conversation models used in agent assist feature. Supported feature: ARTICLE_SUGGESTION, SMART_COMPOSE, SMART_REPLY, CONVERSATION_SUMMARIZATION. # Configs of custom conversation model. @@ -1218,6 +1252,8 @@

Method Details

"disableAgentQueryLogging": True or False, # Optional. Disable the logging of search queries sent by human agents. It can prevent those queries from being stored at answer records. Supported features: KNOWLEDGE_SEARCH. "enableConversationAugmentedQuery": True or False, # Optional. Enable including conversation context during query answer generation. Supported features: KNOWLEDGE_SEARCH. "enableEventBasedSuggestion": True or False, # Automatically iterates all participants and tries to compile suggestions. Supported features: ARTICLE_SUGGESTION, FAQ, DIALOGFLOW_ASSIST, ENTITY_EXTRACTION, KNOWLEDGE_ASSIST. + "enableQuerySuggestionOnly": True or False, # Optional. Enable query suggestion only. Supported features: KNOWLEDGE_ASSIST + "enableQuerySuggestionWhenNoAnswer": True or False, # Optional. Enable query suggestion even if we can't find its answer. By default, queries are suggested only if we find its answer. Supported features: KNOWLEDGE_ASSIST "queryConfig": { # Config for suggestion query. # Configs of query. "confidenceThreshold": 3.14, # Confidence threshold of query result. Agent Assist gives each suggestion a score in the range [0.0, 1.0], based on the relevance between the suggestion and the current conversation context. A score of 0.0 has no relevance, while a score of 1.0 has high relevance. Only suggestions with a score greater than or equal to the value of this field are included in the results. For a baseline model (the default), the recommended value is in the range [0.05, 0.1]. For a custom model, there is no recommended value. Tune this value by starting from a very low value and slowly increasing until you have desired results. If this field is not set, it is default to 0.0, which means that all suggestions are returned. Supported features: ARTICLE_SUGGESTION, FAQ, SMART_REPLY, SMART_COMPOSE, KNOWLEDGE_SEARCH, KNOWLEDGE_ASSIST, ENTITY_EXTRACTION. "contextFilterSettings": { # Settings that determine how to filter recent conversation context when generating suggestions. # Determines how recent conversation context is filtered when generating suggestions. If unspecified, no messages will be dropped. @@ -1340,6 +1376,8 @@

Method Details

"disableAgentQueryLogging": True or False, # Optional. Disable the logging of search queries sent by human agents. It can prevent those queries from being stored at answer records. Supported features: KNOWLEDGE_SEARCH. "enableConversationAugmentedQuery": True or False, # Optional. Enable including conversation context during query answer generation. Supported features: KNOWLEDGE_SEARCH. "enableEventBasedSuggestion": True or False, # Automatically iterates all participants and tries to compile suggestions. Supported features: ARTICLE_SUGGESTION, FAQ, DIALOGFLOW_ASSIST, ENTITY_EXTRACTION, KNOWLEDGE_ASSIST. + "enableQuerySuggestionOnly": True or False, # Optional. Enable query suggestion only. Supported features: KNOWLEDGE_ASSIST + "enableQuerySuggestionWhenNoAnswer": True or False, # Optional. Enable query suggestion even if we can't find its answer. By default, queries are suggested only if we find its answer. Supported features: KNOWLEDGE_ASSIST "queryConfig": { # Config for suggestion query. # Configs of query. "confidenceThreshold": 3.14, # Confidence threshold of query result. Agent Assist gives each suggestion a score in the range [0.0, 1.0], based on the relevance between the suggestion and the current conversation context. A score of 0.0 has no relevance, while a score of 1.0 has high relevance. Only suggestions with a score greater than or equal to the value of this field are included in the results. For a baseline model (the default), the recommended value is in the range [0.05, 0.1]. For a custom model, there is no recommended value. Tune this value by starting from a very low value and slowly increasing until you have desired results. If this field is not set, it is default to 0.0, which means that all suggestions are returned. Supported features: ARTICLE_SUGGESTION, FAQ, SMART_REPLY, SMART_COMPOSE, KNOWLEDGE_SEARCH, KNOWLEDGE_ASSIST, ENTITY_EXTRACTION. "contextFilterSettings": { # Settings that determine how to filter recent conversation context when generating suggestions. # Determines how recent conversation context is filtered when generating suggestions. If unspecified, no messages will be dropped. diff --git a/docs/dyn/dialogflow_v2beta1.projects.conversations.participants.html b/docs/dyn/dialogflow_v2beta1.projects.conversations.participants.html index b5f0c0d787a..c3935c1e89b 100644 --- a/docs/dyn/dialogflow_v2beta1.projects.conversations.participants.html +++ b/docs/dyn/dialogflow_v2beta1.projects.conversations.participants.html @@ -262,6 +262,7 @@

Method Details

"automatedAgentReply": { # Represents a response from an automated agent. # Optional. 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. "allowCancellation": True or False, # Indicates whether the partial automated agent reply is interruptible when a later reply message arrives. e.g. if the agent specified some music as partial response, it can be cancelled. "automatedAgentReplyType": "A String", # AutomatedAgentReply type. + "callCompanionAuthCode": "A String", # The auth code for accessing Call Companion UI. "cxCurrentPage": "A String", # The unique identifier of the current Dialogflow CX conversation page. Format: `projects//locations//agents//flows//pages/`. "cxSessionParameters": { # The collection of current Dialogflow CX agent session parameters at the time of this response. Deprecated: Use `parameters` instead. "a_key": "", # Properties of the object. @@ -3083,6 +3084,31 @@

Method Details

], "latestMessage": "A String", # The name of the latest conversation message used to compile suggestion for. Format: `projects//locations//conversations//messages/`. }, + "suggestKnowledgeAssistResponse": { # The response message for Participants.SuggestKnowledgeAssist. # SuggestKnowledgeAssistResponse if request is for KNOWLEDGE_ASSIST. + "contextSize": 42, # Number of messages prior to and including latest_message to compile the suggestion. It may be smaller than the SuggestKnowledgeAssistRequest.context_size field in the request if there are fewer messages in the conversation. + "knowledgeAssistAnswer": { # Represents a Knowledge Assist answer. # Output only. Knowledge Assist suggestion. + "answerRecord": "A String", # The name of the answer record. Format: `projects//locations//answer Records/`. + "suggestedQuery": { # Represents a suggested query. # The query suggested based on the context. Suggestion is made only if it is different from the previous suggestion. + "queryText": "A String", # Suggested query text. + }, + "suggestedQueryAnswer": { # Represents an answer from Knowledge. Currently supports FAQ and Generative answers. # The answer generated for the suggested query. Whether or not an answer is generated depends on how confident we are about the generated query. + "answerText": "A String", # The piece of text from the `source` that answers this suggested query. + "faqSource": { # Details about source of FAQ answer. # Populated if the prediction came from FAQ. + "question": "A String", # The corresponding FAQ question. + }, + "generativeSource": { # Details about source of Generative answer. # Populated if the prediction was Generative. + "snippets": [ # All snippets used for this Generative Prediction, with their source URI and data. + { # Snippet Source for a Generative Prediction. + "text": "A String", # Text taken from that URI. + "title": "A String", # Title of the document. + "uri": "A String", # URI the data is sourced from. + }, + ], + }, + }, + }, + "latestMessage": "A String", # The name of the latest conversation message used to compile suggestion for. Format: `projects//locations//conversations//messages/`. + }, "suggestSmartRepliesResponse": { # The response message for Participants.SuggestSmartReplies. # SuggestSmartRepliesResponse if request is for SMART_REPLY. "contextSize": 42, # Number of messages prior to and including latest_message to compile the suggestion. It may be smaller than the SuggestSmartRepliesRequest.context_size field in the request if there aren't that many messages in the conversation. "latestMessage": "A String", # The name of the latest conversation message used to compile suggestion for. Format: `projects//locations//conversations//messages/`. @@ -4504,6 +4530,31 @@

Method Details

], "latestMessage": "A String", # The name of the latest conversation message used to compile suggestion for. Format: `projects//locations//conversations//messages/`. }, + "suggestKnowledgeAssistResponse": { # The response message for Participants.SuggestKnowledgeAssist. # SuggestKnowledgeAssistResponse if request is for KNOWLEDGE_ASSIST. + "contextSize": 42, # Number of messages prior to and including latest_message to compile the suggestion. It may be smaller than the SuggestKnowledgeAssistRequest.context_size field in the request if there are fewer messages in the conversation. + "knowledgeAssistAnswer": { # Represents a Knowledge Assist answer. # Output only. Knowledge Assist suggestion. + "answerRecord": "A String", # The name of the answer record. Format: `projects//locations//answer Records/`. + "suggestedQuery": { # Represents a suggested query. # The query suggested based on the context. Suggestion is made only if it is different from the previous suggestion. + "queryText": "A String", # Suggested query text. + }, + "suggestedQueryAnswer": { # Represents an answer from Knowledge. Currently supports FAQ and Generative answers. # The answer generated for the suggested query. Whether or not an answer is generated depends on how confident we are about the generated query. + "answerText": "A String", # The piece of text from the `source` that answers this suggested query. + "faqSource": { # Details about source of FAQ answer. # Populated if the prediction came from FAQ. + "question": "A String", # The corresponding FAQ question. + }, + "generativeSource": { # Details about source of Generative answer. # Populated if the prediction was Generative. + "snippets": [ # All snippets used for this Generative Prediction, with their source URI and data. + { # Snippet Source for a Generative Prediction. + "text": "A String", # Text taken from that URI. + "title": "A String", # Title of the document. + "uri": "A String", # URI the data is sourced from. + }, + ], + }, + }, + }, + "latestMessage": "A String", # The name of the latest conversation message used to compile suggestion for. Format: `projects//locations//conversations//messages/`. + }, "suggestSmartRepliesResponse": { # The response message for Participants.SuggestSmartReplies. # SuggestSmartRepliesResponse if request is for SMART_REPLY. "contextSize": 42, # Number of messages prior to and including latest_message to compile the suggestion. It may be smaller than the SuggestSmartRepliesRequest.context_size field in the request if there aren't that many messages in the conversation. "latestMessage": "A String", # The name of the latest conversation message used to compile suggestion for. Format: `projects//locations//conversations//messages/`. diff --git a/docs/dyn/dialogflow_v2beta1.projects.conversations.participants.suggestions.html b/docs/dyn/dialogflow_v2beta1.projects.conversations.participants.suggestions.html index 491440d6707..101b962ebaf 100644 --- a/docs/dyn/dialogflow_v2beta1.projects.conversations.participants.suggestions.html +++ b/docs/dyn/dialogflow_v2beta1.projects.conversations.participants.suggestions.html @@ -92,6 +92,9 @@

Instance Methods

suggestFaqAnswers(parent, body=None, x__xgafv=None)

Gets suggested faq answers for a participant based on specific historical messages.

+

+ suggestKnowledgeAssist(parent, body=None, x__xgafv=None)

+

Gets knowledge assist suggestions based on historical messages.

suggestSmartReplies(parent, body=None, x__xgafv=None)

Gets smart replies for a participant based on specific historical messages.

@@ -318,6 +321,56 @@

Method Details

}
+
+ suggestKnowledgeAssist(parent, body=None, x__xgafv=None) +
Gets knowledge assist suggestions based on historical messages.
+
+Args:
+  parent: string, Required. The name of the participant to fetch suggestions for. Format: `projects//locations//conversations//participants/`. (required)
+  body: object, The request body.
+    The object takes the form of:
+
+{ # The request message for Participants.SuggestKnowledgeAssist.
+  "contextSize": 42, # Optional. Max number of messages prior to and including latest_message to use as context when compiling the suggestion. The context size is by default 100 and at most 100.
+  "latestMessage": "A String", # Optional. The name of the latest conversation message to compile suggestions for. If empty, it will be the latest message of the conversation. Format: `projects//locations//conversations//messages/`.
+  "previousSuggestedQuery": "A String", # Optional. The previously suggested query for the given conversation. This helps identify whether the next suggestion we generate is resonably different from the previous one. This is useful to avoid similar suggestions within the conversation.
+}
+
+  x__xgafv: string, V1 error format.
+    Allowed values
+      1 - v1 error format
+      2 - v2 error format
+
+Returns:
+  An object of the form:
+
+    { # The response message for Participants.SuggestKnowledgeAssist.
+  "contextSize": 42, # Number of messages prior to and including latest_message to compile the suggestion. It may be smaller than the SuggestKnowledgeAssistRequest.context_size field in the request if there are fewer messages in the conversation.
+  "knowledgeAssistAnswer": { # Represents a Knowledge Assist answer. # Output only. Knowledge Assist suggestion.
+    "answerRecord": "A String", # The name of the answer record. Format: `projects//locations//answer Records/`.
+    "suggestedQuery": { # Represents a suggested query. # The query suggested based on the context. Suggestion is made only if it is different from the previous suggestion.
+      "queryText": "A String", # Suggested query text.
+    },
+    "suggestedQueryAnswer": { # Represents an answer from Knowledge. Currently supports FAQ and Generative answers. # The answer generated for the suggested query. Whether or not an answer is generated depends on how confident we are about the generated query.
+      "answerText": "A String", # The piece of text from the `source` that answers this suggested query.
+      "faqSource": { # Details about source of FAQ answer. # Populated if the prediction came from FAQ.
+        "question": "A String", # The corresponding FAQ question.
+      },
+      "generativeSource": { # Details about source of Generative answer. # Populated if the prediction was Generative.
+        "snippets": [ # All snippets used for this Generative Prediction, with their source URI and data.
+          { # Snippet Source for a Generative Prediction.
+            "text": "A String", # Text taken from that URI.
+            "title": "A String", # Title of the document.
+            "uri": "A String", # URI the data is sourced from.
+          },
+        ],
+      },
+    },
+  },
+  "latestMessage": "A String", # The name of the latest conversation message used to compile suggestion for. Format: `projects//locations//conversations//messages/`.
+}
+
+
suggestSmartReplies(parent, body=None, x__xgafv=None)
Gets smart replies for a participant based on specific historical messages.
diff --git a/docs/dyn/dialogflow_v2beta1.projects.locations.answerRecords.html b/docs/dyn/dialogflow_v2beta1.projects.locations.answerRecords.html
index 6896c498566..8c9cd6d23c9 100644
--- a/docs/dyn/dialogflow_v2beta1.projects.locations.answerRecords.html
+++ b/docs/dyn/dialogflow_v2beta1.projects.locations.answerRecords.html
@@ -814,6 +814,12 @@ 

Method Details

"answerRelevance": "A String", # Optional. Whether or not the suggested answer is relevant. For example: * Query: "Can I change my mailing address?" * Suggested document says: "Items must be returned/exchanged within 60 days of the purchase date." * answer_relevance: AnswerRelevance.IRRELEVANT "documentCorrectness": "A String", # Optional. Whether or not the information in the document is correct. For example: * Query: "Can I return the package in 2 days once received?" * Suggested document says: "Items must be returned/exchanged within 60 days of the purchase date." * Ground truth: "No return or exchange is allowed." * [document_correctness]: INCORRECT "documentEfficiency": "A String", # Optional. Whether or not the suggested document is efficient. For example, if the document is poorly written, hard to understand, hard to use or too long to find useful information, document_efficiency is DocumentEfficiency.INEFFICIENT. + "knowledgeAssistFeedback": { # Feedback for knowledge assist. # Optional. Feedback for knowledge assist. + "answerCopied": True or False, # Whether the suggested answer was copied by the human agent. If the value is set to be true, AnswerFeedback.clicked will be updated to be true. + "clickedUris": [ # The URIs clicked by the human agent. The value is appended for each UpdateAnswerRecordRequest. If the value is not empty, AnswerFeedback.clicked will be updated to be true. + "A String", + ], + }, "knowledgeSearchFeedback": { # Feedback for knowledge search. # Optional. Feedback for knowledge search. "answerCopied": True or False, # Whether the answer was copied by the human agent or not. If the value is set to be true, AnswerFeedback.clicked will be updated to be true. "clickedUris": [ # The URIs clicked by the human agent. The value is appended for each UpdateAnswerRecordRequest. If the value is not empty, AnswerFeedback.clicked will be updated to be true. @@ -1563,6 +1569,12 @@

Method Details

"answerRelevance": "A String", # Optional. Whether or not the suggested answer is relevant. For example: * Query: "Can I change my mailing address?" * Suggested document says: "Items must be returned/exchanged within 60 days of the purchase date." * answer_relevance: AnswerRelevance.IRRELEVANT "documentCorrectness": "A String", # Optional. Whether or not the information in the document is correct. For example: * Query: "Can I return the package in 2 days once received?" * Suggested document says: "Items must be returned/exchanged within 60 days of the purchase date." * Ground truth: "No return or exchange is allowed." * [document_correctness]: INCORRECT "documentEfficiency": "A String", # Optional. Whether or not the suggested document is efficient. For example, if the document is poorly written, hard to understand, hard to use or too long to find useful information, document_efficiency is DocumentEfficiency.INEFFICIENT. + "knowledgeAssistFeedback": { # Feedback for knowledge assist. # Optional. Feedback for knowledge assist. + "answerCopied": True or False, # Whether the suggested answer was copied by the human agent. If the value is set to be true, AnswerFeedback.clicked will be updated to be true. + "clickedUris": [ # The URIs clicked by the human agent. The value is appended for each UpdateAnswerRecordRequest. If the value is not empty, AnswerFeedback.clicked will be updated to be true. + "A String", + ], + }, "knowledgeSearchFeedback": { # Feedback for knowledge search. # Optional. Feedback for knowledge search. "answerCopied": True or False, # Whether the answer was copied by the human agent or not. If the value is set to be true, AnswerFeedback.clicked will be updated to be true. "clickedUris": [ # The URIs clicked by the human agent. The value is appended for each UpdateAnswerRecordRequest. If the value is not empty, AnswerFeedback.clicked will be updated to be true. @@ -2319,6 +2331,12 @@

Method Details

"answerRelevance": "A String", # Optional. Whether or not the suggested answer is relevant. For example: * Query: "Can I change my mailing address?" * Suggested document says: "Items must be returned/exchanged within 60 days of the purchase date." * answer_relevance: AnswerRelevance.IRRELEVANT "documentCorrectness": "A String", # Optional. Whether or not the information in the document is correct. For example: * Query: "Can I return the package in 2 days once received?" * Suggested document says: "Items must be returned/exchanged within 60 days of the purchase date." * Ground truth: "No return or exchange is allowed." * [document_correctness]: INCORRECT "documentEfficiency": "A String", # Optional. Whether or not the suggested document is efficient. For example, if the document is poorly written, hard to understand, hard to use or too long to find useful information, document_efficiency is DocumentEfficiency.INEFFICIENT. + "knowledgeAssistFeedback": { # Feedback for knowledge assist. # Optional. Feedback for knowledge assist. + "answerCopied": True or False, # Whether the suggested answer was copied by the human agent. If the value is set to be true, AnswerFeedback.clicked will be updated to be true. + "clickedUris": [ # The URIs clicked by the human agent. The value is appended for each UpdateAnswerRecordRequest. If the value is not empty, AnswerFeedback.clicked will be updated to be true. + "A String", + ], + }, "knowledgeSearchFeedback": { # Feedback for knowledge search. # Optional. Feedback for knowledge search. "answerCopied": True or False, # Whether the answer was copied by the human agent or not. If the value is set to be true, AnswerFeedback.clicked will be updated to be true. "clickedUris": [ # The URIs clicked by the human agent. The value is appended for each UpdateAnswerRecordRequest. If the value is not empty, AnswerFeedback.clicked will be updated to be true. @@ -3057,6 +3075,12 @@

Method Details

"answerRelevance": "A String", # Optional. Whether or not the suggested answer is relevant. For example: * Query: "Can I change my mailing address?" * Suggested document says: "Items must be returned/exchanged within 60 days of the purchase date." * answer_relevance: AnswerRelevance.IRRELEVANT "documentCorrectness": "A String", # Optional. Whether or not the information in the document is correct. For example: * Query: "Can I return the package in 2 days once received?" * Suggested document says: "Items must be returned/exchanged within 60 days of the purchase date." * Ground truth: "No return or exchange is allowed." * [document_correctness]: INCORRECT "documentEfficiency": "A String", # Optional. Whether or not the suggested document is efficient. For example, if the document is poorly written, hard to understand, hard to use or too long to find useful information, document_efficiency is DocumentEfficiency.INEFFICIENT. + "knowledgeAssistFeedback": { # Feedback for knowledge assist. # Optional. Feedback for knowledge assist. + "answerCopied": True or False, # Whether the suggested answer was copied by the human agent. If the value is set to be true, AnswerFeedback.clicked will be updated to be true. + "clickedUris": [ # The URIs clicked by the human agent. The value is appended for each UpdateAnswerRecordRequest. If the value is not empty, AnswerFeedback.clicked will be updated to be true. + "A String", + ], + }, "knowledgeSearchFeedback": { # Feedback for knowledge search. # Optional. Feedback for knowledge search. "answerCopied": True or False, # Whether the answer was copied by the human agent or not. If the value is set to be true, AnswerFeedback.clicked will be updated to be true. "clickedUris": [ # The URIs clicked by the human agent. The value is appended for each UpdateAnswerRecordRequest. If the value is not empty, AnswerFeedback.clicked will be updated to be true. diff --git a/docs/dyn/dialogflow_v2beta1.projects.locations.conversationProfiles.html b/docs/dyn/dialogflow_v2beta1.projects.locations.conversationProfiles.html index d8284cfe6b5..e1ec7cb3fa8 100644 --- a/docs/dyn/dialogflow_v2beta1.projects.locations.conversationProfiles.html +++ b/docs/dyn/dialogflow_v2beta1.projects.locations.conversationProfiles.html @@ -168,6 +168,7 @@

Method Details

"displayName": "A String", # Required. Human readable name for this profile. Max length 1024 bytes. "humanAgentAssistantConfig": { # Defines the Human Agent Assistant to connect to a conversation. # Configuration for agent assistance to use with this profile. "endUserSuggestionConfig": { # Detail human agent assistant config. # Configuration for agent assistance of end user participant. Currently, this feature is not general available, please contact Google to get access. + "disableHighLatencyFeaturesSyncDelivery": True or False, # Optional. When disable_high_latency_features_sync_delivery is true and using the AnalyzeContent API, we will not deliver the responses from high latency features in the API response. The human_agent_assistant_config.notification_config must be configured and enable_event_based_suggestion must be set to true to receive the responses from high latency features in Pub/Sub. High latency feature(s): KNOWLEDGE_ASSIST. "featureConfigs": [ # Configuration of different suggestion features. One feature can have only one config. { # Config for suggestion features. "conversationModelConfig": { # Custom conversation models used in agent assist feature. Supported feature: ARTICLE_SUGGESTION, SMART_COMPOSE, SMART_REPLY, CONVERSATION_SUMMARIZATION. # Configs of custom conversation model. @@ -180,6 +181,8 @@

Method Details

"disableAgentQueryLogging": True or False, # Optional. Disable the logging of search queries sent by human agents. It can prevent those queries from being stored at answer records. Supported features: KNOWLEDGE_SEARCH. "enableConversationAugmentedQuery": True or False, # Optional. Enable including conversation context during query answer generation. Supported features: KNOWLEDGE_SEARCH. "enableEventBasedSuggestion": True or False, # Automatically iterates all participants and tries to compile suggestions. Supported features: ARTICLE_SUGGESTION, FAQ, DIALOGFLOW_ASSIST, ENTITY_EXTRACTION, KNOWLEDGE_ASSIST. + "enableQuerySuggestionOnly": True or False, # Optional. Enable query suggestion only. Supported features: KNOWLEDGE_ASSIST + "enableQuerySuggestionWhenNoAnswer": True or False, # Optional. Enable query suggestion even if we can't find its answer. By default, queries are suggested only if we find its answer. Supported features: KNOWLEDGE_ASSIST "queryConfig": { # Config for suggestion query. # Configs of query. "confidenceThreshold": 3.14, # Confidence threshold of query result. Agent Assist gives each suggestion a score in the range [0.0, 1.0], based on the relevance between the suggestion and the current conversation context. A score of 0.0 has no relevance, while a score of 1.0 has high relevance. Only suggestions with a score greater than or equal to the value of this field are included in the results. For a baseline model (the default), the recommended value is in the range [0.05, 0.1]. For a custom model, there is no recommended value. Tune this value by starting from a very low value and slowly increasing until you have desired results. If this field is not set, it is default to 0.0, which means that all suggestions are returned. Supported features: ARTICLE_SUGGESTION, FAQ, SMART_REPLY, SMART_COMPOSE, KNOWLEDGE_SEARCH, KNOWLEDGE_ASSIST, ENTITY_EXTRACTION. "contextFilterSettings": { # Settings that determine how to filter recent conversation context when generating suggestions. # Determines how recent conversation context is filtered when generating suggestions. If unspecified, no messages will be dropped. @@ -225,6 +228,7 @@

Method Details

"groupSuggestionResponses": True or False, # If `group_suggestion_responses` is false, and there are multiple `feature_configs` in `event based suggestion` or StreamingAnalyzeContent, we will try to deliver suggestions to customers as soon as we get new suggestion. Different type of suggestions based on the same context will be in separate Pub/Sub event or `StreamingAnalyzeContentResponse`. If `group_suggestion_responses` set to true. All the suggestions to the same participant based on the same context will be grouped into a single Pub/Sub event or StreamingAnalyzeContentResponse. }, "humanAgentSuggestionConfig": { # Detail human agent assistant config. # Configuration for agent assistance of human agent participant. + "disableHighLatencyFeaturesSyncDelivery": True or False, # Optional. When disable_high_latency_features_sync_delivery is true and using the AnalyzeContent API, we will not deliver the responses from high latency features in the API response. The human_agent_assistant_config.notification_config must be configured and enable_event_based_suggestion must be set to true to receive the responses from high latency features in Pub/Sub. High latency feature(s): KNOWLEDGE_ASSIST. "featureConfigs": [ # Configuration of different suggestion features. One feature can have only one config. { # Config for suggestion features. "conversationModelConfig": { # Custom conversation models used in agent assist feature. Supported feature: ARTICLE_SUGGESTION, SMART_COMPOSE, SMART_REPLY, CONVERSATION_SUMMARIZATION. # Configs of custom conversation model. @@ -237,6 +241,8 @@

Method Details

"disableAgentQueryLogging": True or False, # Optional. Disable the logging of search queries sent by human agents. It can prevent those queries from being stored at answer records. Supported features: KNOWLEDGE_SEARCH. "enableConversationAugmentedQuery": True or False, # Optional. Enable including conversation context during query answer generation. Supported features: KNOWLEDGE_SEARCH. "enableEventBasedSuggestion": True or False, # Automatically iterates all participants and tries to compile suggestions. Supported features: ARTICLE_SUGGESTION, FAQ, DIALOGFLOW_ASSIST, ENTITY_EXTRACTION, KNOWLEDGE_ASSIST. + "enableQuerySuggestionOnly": True or False, # Optional. Enable query suggestion only. Supported features: KNOWLEDGE_ASSIST + "enableQuerySuggestionWhenNoAnswer": True or False, # Optional. Enable query suggestion even if we can't find its answer. By default, queries are suggested only if we find its answer. Supported features: KNOWLEDGE_ASSIST "queryConfig": { # Config for suggestion query. # Configs of query. "confidenceThreshold": 3.14, # Confidence threshold of query result. Agent Assist gives each suggestion a score in the range [0.0, 1.0], based on the relevance between the suggestion and the current conversation context. A score of 0.0 has no relevance, while a score of 1.0 has high relevance. Only suggestions with a score greater than or equal to the value of this field are included in the results. For a baseline model (the default), the recommended value is in the range [0.05, 0.1]. For a custom model, there is no recommended value. Tune this value by starting from a very low value and slowly increasing until you have desired results. If this field is not set, it is default to 0.0, which means that all suggestions are returned. Supported features: ARTICLE_SUGGESTION, FAQ, SMART_REPLY, SMART_COMPOSE, KNOWLEDGE_SEARCH, KNOWLEDGE_ASSIST, ENTITY_EXTRACTION. "contextFilterSettings": { # Settings that determine how to filter recent conversation context when generating suggestions. # Determines how recent conversation context is filtered when generating suggestions. If unspecified, no messages will be dropped. @@ -353,6 +359,7 @@

Method Details

"displayName": "A String", # Required. Human readable name for this profile. Max length 1024 bytes. "humanAgentAssistantConfig": { # Defines the Human Agent Assistant to connect to a conversation. # Configuration for agent assistance to use with this profile. "endUserSuggestionConfig": { # Detail human agent assistant config. # Configuration for agent assistance of end user participant. Currently, this feature is not general available, please contact Google to get access. + "disableHighLatencyFeaturesSyncDelivery": True or False, # Optional. When disable_high_latency_features_sync_delivery is true and using the AnalyzeContent API, we will not deliver the responses from high latency features in the API response. The human_agent_assistant_config.notification_config must be configured and enable_event_based_suggestion must be set to true to receive the responses from high latency features in Pub/Sub. High latency feature(s): KNOWLEDGE_ASSIST. "featureConfigs": [ # Configuration of different suggestion features. One feature can have only one config. { # Config for suggestion features. "conversationModelConfig": { # Custom conversation models used in agent assist feature. Supported feature: ARTICLE_SUGGESTION, SMART_COMPOSE, SMART_REPLY, CONVERSATION_SUMMARIZATION. # Configs of custom conversation model. @@ -365,6 +372,8 @@

Method Details

"disableAgentQueryLogging": True or False, # Optional. Disable the logging of search queries sent by human agents. It can prevent those queries from being stored at answer records. Supported features: KNOWLEDGE_SEARCH. "enableConversationAugmentedQuery": True or False, # Optional. Enable including conversation context during query answer generation. Supported features: KNOWLEDGE_SEARCH. "enableEventBasedSuggestion": True or False, # Automatically iterates all participants and tries to compile suggestions. Supported features: ARTICLE_SUGGESTION, FAQ, DIALOGFLOW_ASSIST, ENTITY_EXTRACTION, KNOWLEDGE_ASSIST. + "enableQuerySuggestionOnly": True or False, # Optional. Enable query suggestion only. Supported features: KNOWLEDGE_ASSIST + "enableQuerySuggestionWhenNoAnswer": True or False, # Optional. Enable query suggestion even if we can't find its answer. By default, queries are suggested only if we find its answer. Supported features: KNOWLEDGE_ASSIST "queryConfig": { # Config for suggestion query. # Configs of query. "confidenceThreshold": 3.14, # Confidence threshold of query result. Agent Assist gives each suggestion a score in the range [0.0, 1.0], based on the relevance between the suggestion and the current conversation context. A score of 0.0 has no relevance, while a score of 1.0 has high relevance. Only suggestions with a score greater than or equal to the value of this field are included in the results. For a baseline model (the default), the recommended value is in the range [0.05, 0.1]. For a custom model, there is no recommended value. Tune this value by starting from a very low value and slowly increasing until you have desired results. If this field is not set, it is default to 0.0, which means that all suggestions are returned. Supported features: ARTICLE_SUGGESTION, FAQ, SMART_REPLY, SMART_COMPOSE, KNOWLEDGE_SEARCH, KNOWLEDGE_ASSIST, ENTITY_EXTRACTION. "contextFilterSettings": { # Settings that determine how to filter recent conversation context when generating suggestions. # Determines how recent conversation context is filtered when generating suggestions. If unspecified, no messages will be dropped. @@ -410,6 +419,7 @@

Method Details

"groupSuggestionResponses": True or False, # If `group_suggestion_responses` is false, and there are multiple `feature_configs` in `event based suggestion` or StreamingAnalyzeContent, we will try to deliver suggestions to customers as soon as we get new suggestion. Different type of suggestions based on the same context will be in separate Pub/Sub event or `StreamingAnalyzeContentResponse`. If `group_suggestion_responses` set to true. All the suggestions to the same participant based on the same context will be grouped into a single Pub/Sub event or StreamingAnalyzeContentResponse. }, "humanAgentSuggestionConfig": { # Detail human agent assistant config. # Configuration for agent assistance of human agent participant. + "disableHighLatencyFeaturesSyncDelivery": True or False, # Optional. When disable_high_latency_features_sync_delivery is true and using the AnalyzeContent API, we will not deliver the responses from high latency features in the API response. The human_agent_assistant_config.notification_config must be configured and enable_event_based_suggestion must be set to true to receive the responses from high latency features in Pub/Sub. High latency feature(s): KNOWLEDGE_ASSIST. "featureConfigs": [ # Configuration of different suggestion features. One feature can have only one config. { # Config for suggestion features. "conversationModelConfig": { # Custom conversation models used in agent assist feature. Supported feature: ARTICLE_SUGGESTION, SMART_COMPOSE, SMART_REPLY, CONVERSATION_SUMMARIZATION. # Configs of custom conversation model. @@ -422,6 +432,8 @@

Method Details

"disableAgentQueryLogging": True or False, # Optional. Disable the logging of search queries sent by human agents. It can prevent those queries from being stored at answer records. Supported features: KNOWLEDGE_SEARCH. "enableConversationAugmentedQuery": True or False, # Optional. Enable including conversation context during query answer generation. Supported features: KNOWLEDGE_SEARCH. "enableEventBasedSuggestion": True or False, # Automatically iterates all participants and tries to compile suggestions. Supported features: ARTICLE_SUGGESTION, FAQ, DIALOGFLOW_ASSIST, ENTITY_EXTRACTION, KNOWLEDGE_ASSIST. + "enableQuerySuggestionOnly": True or False, # Optional. Enable query suggestion only. Supported features: KNOWLEDGE_ASSIST + "enableQuerySuggestionWhenNoAnswer": True or False, # Optional. Enable query suggestion even if we can't find its answer. By default, queries are suggested only if we find its answer. Supported features: KNOWLEDGE_ASSIST "queryConfig": { # Config for suggestion query. # Configs of query. "confidenceThreshold": 3.14, # Confidence threshold of query result. Agent Assist gives each suggestion a score in the range [0.0, 1.0], based on the relevance between the suggestion and the current conversation context. A score of 0.0 has no relevance, while a score of 1.0 has high relevance. Only suggestions with a score greater than or equal to the value of this field are included in the results. For a baseline model (the default), the recommended value is in the range [0.05, 0.1]. For a custom model, there is no recommended value. Tune this value by starting from a very low value and slowly increasing until you have desired results. If this field is not set, it is default to 0.0, which means that all suggestions are returned. Supported features: ARTICLE_SUGGESTION, FAQ, SMART_REPLY, SMART_COMPOSE, KNOWLEDGE_SEARCH, KNOWLEDGE_ASSIST, ENTITY_EXTRACTION. "contextFilterSettings": { # Settings that determine how to filter recent conversation context when generating suggestions. # Determines how recent conversation context is filtered when generating suggestions. If unspecified, no messages will be dropped. @@ -563,6 +575,7 @@

Method Details

"displayName": "A String", # Required. Human readable name for this profile. Max length 1024 bytes. "humanAgentAssistantConfig": { # Defines the Human Agent Assistant to connect to a conversation. # Configuration for agent assistance to use with this profile. "endUserSuggestionConfig": { # Detail human agent assistant config. # Configuration for agent assistance of end user participant. Currently, this feature is not general available, please contact Google to get access. + "disableHighLatencyFeaturesSyncDelivery": True or False, # Optional. When disable_high_latency_features_sync_delivery is true and using the AnalyzeContent API, we will not deliver the responses from high latency features in the API response. The human_agent_assistant_config.notification_config must be configured and enable_event_based_suggestion must be set to true to receive the responses from high latency features in Pub/Sub. High latency feature(s): KNOWLEDGE_ASSIST. "featureConfigs": [ # Configuration of different suggestion features. One feature can have only one config. { # Config for suggestion features. "conversationModelConfig": { # Custom conversation models used in agent assist feature. Supported feature: ARTICLE_SUGGESTION, SMART_COMPOSE, SMART_REPLY, CONVERSATION_SUMMARIZATION. # Configs of custom conversation model. @@ -575,6 +588,8 @@

Method Details

"disableAgentQueryLogging": True or False, # Optional. Disable the logging of search queries sent by human agents. It can prevent those queries from being stored at answer records. Supported features: KNOWLEDGE_SEARCH. "enableConversationAugmentedQuery": True or False, # Optional. Enable including conversation context during query answer generation. Supported features: KNOWLEDGE_SEARCH. "enableEventBasedSuggestion": True or False, # Automatically iterates all participants and tries to compile suggestions. Supported features: ARTICLE_SUGGESTION, FAQ, DIALOGFLOW_ASSIST, ENTITY_EXTRACTION, KNOWLEDGE_ASSIST. + "enableQuerySuggestionOnly": True or False, # Optional. Enable query suggestion only. Supported features: KNOWLEDGE_ASSIST + "enableQuerySuggestionWhenNoAnswer": True or False, # Optional. Enable query suggestion even if we can't find its answer. By default, queries are suggested only if we find its answer. Supported features: KNOWLEDGE_ASSIST "queryConfig": { # Config for suggestion query. # Configs of query. "confidenceThreshold": 3.14, # Confidence threshold of query result. Agent Assist gives each suggestion a score in the range [0.0, 1.0], based on the relevance between the suggestion and the current conversation context. A score of 0.0 has no relevance, while a score of 1.0 has high relevance. Only suggestions with a score greater than or equal to the value of this field are included in the results. For a baseline model (the default), the recommended value is in the range [0.05, 0.1]. For a custom model, there is no recommended value. Tune this value by starting from a very low value and slowly increasing until you have desired results. If this field is not set, it is default to 0.0, which means that all suggestions are returned. Supported features: ARTICLE_SUGGESTION, FAQ, SMART_REPLY, SMART_COMPOSE, KNOWLEDGE_SEARCH, KNOWLEDGE_ASSIST, ENTITY_EXTRACTION. "contextFilterSettings": { # Settings that determine how to filter recent conversation context when generating suggestions. # Determines how recent conversation context is filtered when generating suggestions. If unspecified, no messages will be dropped. @@ -620,6 +635,7 @@

Method Details

"groupSuggestionResponses": True or False, # If `group_suggestion_responses` is false, and there are multiple `feature_configs` in `event based suggestion` or StreamingAnalyzeContent, we will try to deliver suggestions to customers as soon as we get new suggestion. Different type of suggestions based on the same context will be in separate Pub/Sub event or `StreamingAnalyzeContentResponse`. If `group_suggestion_responses` set to true. All the suggestions to the same participant based on the same context will be grouped into a single Pub/Sub event or StreamingAnalyzeContentResponse. }, "humanAgentSuggestionConfig": { # Detail human agent assistant config. # Configuration for agent assistance of human agent participant. + "disableHighLatencyFeaturesSyncDelivery": True or False, # Optional. When disable_high_latency_features_sync_delivery is true and using the AnalyzeContent API, we will not deliver the responses from high latency features in the API response. The human_agent_assistant_config.notification_config must be configured and enable_event_based_suggestion must be set to true to receive the responses from high latency features in Pub/Sub. High latency feature(s): KNOWLEDGE_ASSIST. "featureConfigs": [ # Configuration of different suggestion features. One feature can have only one config. { # Config for suggestion features. "conversationModelConfig": { # Custom conversation models used in agent assist feature. Supported feature: ARTICLE_SUGGESTION, SMART_COMPOSE, SMART_REPLY, CONVERSATION_SUMMARIZATION. # Configs of custom conversation model. @@ -632,6 +648,8 @@

Method Details

"disableAgentQueryLogging": True or False, # Optional. Disable the logging of search queries sent by human agents. It can prevent those queries from being stored at answer records. Supported features: KNOWLEDGE_SEARCH. "enableConversationAugmentedQuery": True or False, # Optional. Enable including conversation context during query answer generation. Supported features: KNOWLEDGE_SEARCH. "enableEventBasedSuggestion": True or False, # Automatically iterates all participants and tries to compile suggestions. Supported features: ARTICLE_SUGGESTION, FAQ, DIALOGFLOW_ASSIST, ENTITY_EXTRACTION, KNOWLEDGE_ASSIST. + "enableQuerySuggestionOnly": True or False, # Optional. Enable query suggestion only. Supported features: KNOWLEDGE_ASSIST + "enableQuerySuggestionWhenNoAnswer": True or False, # Optional. Enable query suggestion even if we can't find its answer. By default, queries are suggested only if we find its answer. Supported features: KNOWLEDGE_ASSIST "queryConfig": { # Config for suggestion query. # Configs of query. "confidenceThreshold": 3.14, # Confidence threshold of query result. Agent Assist gives each suggestion a score in the range [0.0, 1.0], based on the relevance between the suggestion and the current conversation context. A score of 0.0 has no relevance, while a score of 1.0 has high relevance. Only suggestions with a score greater than or equal to the value of this field are included in the results. For a baseline model (the default), the recommended value is in the range [0.05, 0.1]. For a custom model, there is no recommended value. Tune this value by starting from a very low value and slowly increasing until you have desired results. If this field is not set, it is default to 0.0, which means that all suggestions are returned. Supported features: ARTICLE_SUGGESTION, FAQ, SMART_REPLY, SMART_COMPOSE, KNOWLEDGE_SEARCH, KNOWLEDGE_ASSIST, ENTITY_EXTRACTION. "contextFilterSettings": { # Settings that determine how to filter recent conversation context when generating suggestions. # Determines how recent conversation context is filtered when generating suggestions. If unspecified, no messages will be dropped. @@ -759,6 +777,7 @@

Method Details

"displayName": "A String", # Required. Human readable name for this profile. Max length 1024 bytes. "humanAgentAssistantConfig": { # Defines the Human Agent Assistant to connect to a conversation. # Configuration for agent assistance to use with this profile. "endUserSuggestionConfig": { # Detail human agent assistant config. # Configuration for agent assistance of end user participant. Currently, this feature is not general available, please contact Google to get access. + "disableHighLatencyFeaturesSyncDelivery": True or False, # Optional. When disable_high_latency_features_sync_delivery is true and using the AnalyzeContent API, we will not deliver the responses from high latency features in the API response. The human_agent_assistant_config.notification_config must be configured and enable_event_based_suggestion must be set to true to receive the responses from high latency features in Pub/Sub. High latency feature(s): KNOWLEDGE_ASSIST. "featureConfigs": [ # Configuration of different suggestion features. One feature can have only one config. { # Config for suggestion features. "conversationModelConfig": { # Custom conversation models used in agent assist feature. Supported feature: ARTICLE_SUGGESTION, SMART_COMPOSE, SMART_REPLY, CONVERSATION_SUMMARIZATION. # Configs of custom conversation model. @@ -771,6 +790,8 @@

Method Details

"disableAgentQueryLogging": True or False, # Optional. Disable the logging of search queries sent by human agents. It can prevent those queries from being stored at answer records. Supported features: KNOWLEDGE_SEARCH. "enableConversationAugmentedQuery": True or False, # Optional. Enable including conversation context during query answer generation. Supported features: KNOWLEDGE_SEARCH. "enableEventBasedSuggestion": True or False, # Automatically iterates all participants and tries to compile suggestions. Supported features: ARTICLE_SUGGESTION, FAQ, DIALOGFLOW_ASSIST, ENTITY_EXTRACTION, KNOWLEDGE_ASSIST. + "enableQuerySuggestionOnly": True or False, # Optional. Enable query suggestion only. Supported features: KNOWLEDGE_ASSIST + "enableQuerySuggestionWhenNoAnswer": True or False, # Optional. Enable query suggestion even if we can't find its answer. By default, queries are suggested only if we find its answer. Supported features: KNOWLEDGE_ASSIST "queryConfig": { # Config for suggestion query. # Configs of query. "confidenceThreshold": 3.14, # Confidence threshold of query result. Agent Assist gives each suggestion a score in the range [0.0, 1.0], based on the relevance between the suggestion and the current conversation context. A score of 0.0 has no relevance, while a score of 1.0 has high relevance. Only suggestions with a score greater than or equal to the value of this field are included in the results. For a baseline model (the default), the recommended value is in the range [0.05, 0.1]. For a custom model, there is no recommended value. Tune this value by starting from a very low value and slowly increasing until you have desired results. If this field is not set, it is default to 0.0, which means that all suggestions are returned. Supported features: ARTICLE_SUGGESTION, FAQ, SMART_REPLY, SMART_COMPOSE, KNOWLEDGE_SEARCH, KNOWLEDGE_ASSIST, ENTITY_EXTRACTION. "contextFilterSettings": { # Settings that determine how to filter recent conversation context when generating suggestions. # Determines how recent conversation context is filtered when generating suggestions. If unspecified, no messages will be dropped. @@ -816,6 +837,7 @@

Method Details

"groupSuggestionResponses": True or False, # If `group_suggestion_responses` is false, and there are multiple `feature_configs` in `event based suggestion` or StreamingAnalyzeContent, we will try to deliver suggestions to customers as soon as we get new suggestion. Different type of suggestions based on the same context will be in separate Pub/Sub event or `StreamingAnalyzeContentResponse`. If `group_suggestion_responses` set to true. All the suggestions to the same participant based on the same context will be grouped into a single Pub/Sub event or StreamingAnalyzeContentResponse. }, "humanAgentSuggestionConfig": { # Detail human agent assistant config. # Configuration for agent assistance of human agent participant. + "disableHighLatencyFeaturesSyncDelivery": True or False, # Optional. When disable_high_latency_features_sync_delivery is true and using the AnalyzeContent API, we will not deliver the responses from high latency features in the API response. The human_agent_assistant_config.notification_config must be configured and enable_event_based_suggestion must be set to true to receive the responses from high latency features in Pub/Sub. High latency feature(s): KNOWLEDGE_ASSIST. "featureConfigs": [ # Configuration of different suggestion features. One feature can have only one config. { # Config for suggestion features. "conversationModelConfig": { # Custom conversation models used in agent assist feature. Supported feature: ARTICLE_SUGGESTION, SMART_COMPOSE, SMART_REPLY, CONVERSATION_SUMMARIZATION. # Configs of custom conversation model. @@ -828,6 +850,8 @@

Method Details

"disableAgentQueryLogging": True or False, # Optional. Disable the logging of search queries sent by human agents. It can prevent those queries from being stored at answer records. Supported features: KNOWLEDGE_SEARCH. "enableConversationAugmentedQuery": True or False, # Optional. Enable including conversation context during query answer generation. Supported features: KNOWLEDGE_SEARCH. "enableEventBasedSuggestion": True or False, # Automatically iterates all participants and tries to compile suggestions. Supported features: ARTICLE_SUGGESTION, FAQ, DIALOGFLOW_ASSIST, ENTITY_EXTRACTION, KNOWLEDGE_ASSIST. + "enableQuerySuggestionOnly": True or False, # Optional. Enable query suggestion only. Supported features: KNOWLEDGE_ASSIST + "enableQuerySuggestionWhenNoAnswer": True or False, # Optional. Enable query suggestion even if we can't find its answer. By default, queries are suggested only if we find its answer. Supported features: KNOWLEDGE_ASSIST "queryConfig": { # Config for suggestion query. # Configs of query. "confidenceThreshold": 3.14, # Confidence threshold of query result. Agent Assist gives each suggestion a score in the range [0.0, 1.0], based on the relevance between the suggestion and the current conversation context. A score of 0.0 has no relevance, while a score of 1.0 has high relevance. Only suggestions with a score greater than or equal to the value of this field are included in the results. For a baseline model (the default), the recommended value is in the range [0.05, 0.1]. For a custom model, there is no recommended value. Tune this value by starting from a very low value and slowly increasing until you have desired results. If this field is not set, it is default to 0.0, which means that all suggestions are returned. Supported features: ARTICLE_SUGGESTION, FAQ, SMART_REPLY, SMART_COMPOSE, KNOWLEDGE_SEARCH, KNOWLEDGE_ASSIST, ENTITY_EXTRACTION. "contextFilterSettings": { # Settings that determine how to filter recent conversation context when generating suggestions. # Determines how recent conversation context is filtered when generating suggestions. If unspecified, no messages will be dropped. @@ -963,6 +987,7 @@

Method Details

"displayName": "A String", # Required. Human readable name for this profile. Max length 1024 bytes. "humanAgentAssistantConfig": { # Defines the Human Agent Assistant to connect to a conversation. # Configuration for agent assistance to use with this profile. "endUserSuggestionConfig": { # Detail human agent assistant config. # Configuration for agent assistance of end user participant. Currently, this feature is not general available, please contact Google to get access. + "disableHighLatencyFeaturesSyncDelivery": True or False, # Optional. When disable_high_latency_features_sync_delivery is true and using the AnalyzeContent API, we will not deliver the responses from high latency features in the API response. The human_agent_assistant_config.notification_config must be configured and enable_event_based_suggestion must be set to true to receive the responses from high latency features in Pub/Sub. High latency feature(s): KNOWLEDGE_ASSIST. "featureConfigs": [ # Configuration of different suggestion features. One feature can have only one config. { # Config for suggestion features. "conversationModelConfig": { # Custom conversation models used in agent assist feature. Supported feature: ARTICLE_SUGGESTION, SMART_COMPOSE, SMART_REPLY, CONVERSATION_SUMMARIZATION. # Configs of custom conversation model. @@ -975,6 +1000,8 @@

Method Details

"disableAgentQueryLogging": True or False, # Optional. Disable the logging of search queries sent by human agents. It can prevent those queries from being stored at answer records. Supported features: KNOWLEDGE_SEARCH. "enableConversationAugmentedQuery": True or False, # Optional. Enable including conversation context during query answer generation. Supported features: KNOWLEDGE_SEARCH. "enableEventBasedSuggestion": True or False, # Automatically iterates all participants and tries to compile suggestions. Supported features: ARTICLE_SUGGESTION, FAQ, DIALOGFLOW_ASSIST, ENTITY_EXTRACTION, KNOWLEDGE_ASSIST. + "enableQuerySuggestionOnly": True or False, # Optional. Enable query suggestion only. Supported features: KNOWLEDGE_ASSIST + "enableQuerySuggestionWhenNoAnswer": True or False, # Optional. Enable query suggestion even if we can't find its answer. By default, queries are suggested only if we find its answer. Supported features: KNOWLEDGE_ASSIST "queryConfig": { # Config for suggestion query. # Configs of query. "confidenceThreshold": 3.14, # Confidence threshold of query result. Agent Assist gives each suggestion a score in the range [0.0, 1.0], based on the relevance between the suggestion and the current conversation context. A score of 0.0 has no relevance, while a score of 1.0 has high relevance. Only suggestions with a score greater than or equal to the value of this field are included in the results. For a baseline model (the default), the recommended value is in the range [0.05, 0.1]. For a custom model, there is no recommended value. Tune this value by starting from a very low value and slowly increasing until you have desired results. If this field is not set, it is default to 0.0, which means that all suggestions are returned. Supported features: ARTICLE_SUGGESTION, FAQ, SMART_REPLY, SMART_COMPOSE, KNOWLEDGE_SEARCH, KNOWLEDGE_ASSIST, ENTITY_EXTRACTION. "contextFilterSettings": { # Settings that determine how to filter recent conversation context when generating suggestions. # Determines how recent conversation context is filtered when generating suggestions. If unspecified, no messages will be dropped. @@ -1020,6 +1047,7 @@

Method Details

"groupSuggestionResponses": True or False, # If `group_suggestion_responses` is false, and there are multiple `feature_configs` in `event based suggestion` or StreamingAnalyzeContent, we will try to deliver suggestions to customers as soon as we get new suggestion. Different type of suggestions based on the same context will be in separate Pub/Sub event or `StreamingAnalyzeContentResponse`. If `group_suggestion_responses` set to true. All the suggestions to the same participant based on the same context will be grouped into a single Pub/Sub event or StreamingAnalyzeContentResponse. }, "humanAgentSuggestionConfig": { # Detail human agent assistant config. # Configuration for agent assistance of human agent participant. + "disableHighLatencyFeaturesSyncDelivery": True or False, # Optional. When disable_high_latency_features_sync_delivery is true and using the AnalyzeContent API, we will not deliver the responses from high latency features in the API response. The human_agent_assistant_config.notification_config must be configured and enable_event_based_suggestion must be set to true to receive the responses from high latency features in Pub/Sub. High latency feature(s): KNOWLEDGE_ASSIST. "featureConfigs": [ # Configuration of different suggestion features. One feature can have only one config. { # Config for suggestion features. "conversationModelConfig": { # Custom conversation models used in agent assist feature. Supported feature: ARTICLE_SUGGESTION, SMART_COMPOSE, SMART_REPLY, CONVERSATION_SUMMARIZATION. # Configs of custom conversation model. @@ -1032,6 +1060,8 @@

Method Details

"disableAgentQueryLogging": True or False, # Optional. Disable the logging of search queries sent by human agents. It can prevent those queries from being stored at answer records. Supported features: KNOWLEDGE_SEARCH. "enableConversationAugmentedQuery": True or False, # Optional. Enable including conversation context during query answer generation. Supported features: KNOWLEDGE_SEARCH. "enableEventBasedSuggestion": True or False, # Automatically iterates all participants and tries to compile suggestions. Supported features: ARTICLE_SUGGESTION, FAQ, DIALOGFLOW_ASSIST, ENTITY_EXTRACTION, KNOWLEDGE_ASSIST. + "enableQuerySuggestionOnly": True or False, # Optional. Enable query suggestion only. Supported features: KNOWLEDGE_ASSIST + "enableQuerySuggestionWhenNoAnswer": True or False, # Optional. Enable query suggestion even if we can't find its answer. By default, queries are suggested only if we find its answer. Supported features: KNOWLEDGE_ASSIST "queryConfig": { # Config for suggestion query. # Configs of query. "confidenceThreshold": 3.14, # Confidence threshold of query result. Agent Assist gives each suggestion a score in the range [0.0, 1.0], based on the relevance between the suggestion and the current conversation context. A score of 0.0 has no relevance, while a score of 1.0 has high relevance. Only suggestions with a score greater than or equal to the value of this field are included in the results. For a baseline model (the default), the recommended value is in the range [0.05, 0.1]. For a custom model, there is no recommended value. Tune this value by starting from a very low value and slowly increasing until you have desired results. If this field is not set, it is default to 0.0, which means that all suggestions are returned. Supported features: ARTICLE_SUGGESTION, FAQ, SMART_REPLY, SMART_COMPOSE, KNOWLEDGE_SEARCH, KNOWLEDGE_ASSIST, ENTITY_EXTRACTION. "contextFilterSettings": { # Settings that determine how to filter recent conversation context when generating suggestions. # Determines how recent conversation context is filtered when generating suggestions. If unspecified, no messages will be dropped. @@ -1149,6 +1179,7 @@

Method Details

"displayName": "A String", # Required. Human readable name for this profile. Max length 1024 bytes. "humanAgentAssistantConfig": { # Defines the Human Agent Assistant to connect to a conversation. # Configuration for agent assistance to use with this profile. "endUserSuggestionConfig": { # Detail human agent assistant config. # Configuration for agent assistance of end user participant. Currently, this feature is not general available, please contact Google to get access. + "disableHighLatencyFeaturesSyncDelivery": True or False, # Optional. When disable_high_latency_features_sync_delivery is true and using the AnalyzeContent API, we will not deliver the responses from high latency features in the API response. The human_agent_assistant_config.notification_config must be configured and enable_event_based_suggestion must be set to true to receive the responses from high latency features in Pub/Sub. High latency feature(s): KNOWLEDGE_ASSIST. "featureConfigs": [ # Configuration of different suggestion features. One feature can have only one config. { # Config for suggestion features. "conversationModelConfig": { # Custom conversation models used in agent assist feature. Supported feature: ARTICLE_SUGGESTION, SMART_COMPOSE, SMART_REPLY, CONVERSATION_SUMMARIZATION. # Configs of custom conversation model. @@ -1161,6 +1192,8 @@

Method Details

"disableAgentQueryLogging": True or False, # Optional. Disable the logging of search queries sent by human agents. It can prevent those queries from being stored at answer records. Supported features: KNOWLEDGE_SEARCH. "enableConversationAugmentedQuery": True or False, # Optional. Enable including conversation context during query answer generation. Supported features: KNOWLEDGE_SEARCH. "enableEventBasedSuggestion": True or False, # Automatically iterates all participants and tries to compile suggestions. Supported features: ARTICLE_SUGGESTION, FAQ, DIALOGFLOW_ASSIST, ENTITY_EXTRACTION, KNOWLEDGE_ASSIST. + "enableQuerySuggestionOnly": True or False, # Optional. Enable query suggestion only. Supported features: KNOWLEDGE_ASSIST + "enableQuerySuggestionWhenNoAnswer": True or False, # Optional. Enable query suggestion even if we can't find its answer. By default, queries are suggested only if we find its answer. Supported features: KNOWLEDGE_ASSIST "queryConfig": { # Config for suggestion query. # Configs of query. "confidenceThreshold": 3.14, # Confidence threshold of query result. Agent Assist gives each suggestion a score in the range [0.0, 1.0], based on the relevance between the suggestion and the current conversation context. A score of 0.0 has no relevance, while a score of 1.0 has high relevance. Only suggestions with a score greater than or equal to the value of this field are included in the results. For a baseline model (the default), the recommended value is in the range [0.05, 0.1]. For a custom model, there is no recommended value. Tune this value by starting from a very low value and slowly increasing until you have desired results. If this field is not set, it is default to 0.0, which means that all suggestions are returned. Supported features: ARTICLE_SUGGESTION, FAQ, SMART_REPLY, SMART_COMPOSE, KNOWLEDGE_SEARCH, KNOWLEDGE_ASSIST, ENTITY_EXTRACTION. "contextFilterSettings": { # Settings that determine how to filter recent conversation context when generating suggestions. # Determines how recent conversation context is filtered when generating suggestions. If unspecified, no messages will be dropped. @@ -1206,6 +1239,7 @@

Method Details

"groupSuggestionResponses": True or False, # If `group_suggestion_responses` is false, and there are multiple `feature_configs` in `event based suggestion` or StreamingAnalyzeContent, we will try to deliver suggestions to customers as soon as we get new suggestion. Different type of suggestions based on the same context will be in separate Pub/Sub event or `StreamingAnalyzeContentResponse`. If `group_suggestion_responses` set to true. All the suggestions to the same participant based on the same context will be grouped into a single Pub/Sub event or StreamingAnalyzeContentResponse. }, "humanAgentSuggestionConfig": { # Detail human agent assistant config. # Configuration for agent assistance of human agent participant. + "disableHighLatencyFeaturesSyncDelivery": True or False, # Optional. When disable_high_latency_features_sync_delivery is true and using the AnalyzeContent API, we will not deliver the responses from high latency features in the API response. The human_agent_assistant_config.notification_config must be configured and enable_event_based_suggestion must be set to true to receive the responses from high latency features in Pub/Sub. High latency feature(s): KNOWLEDGE_ASSIST. "featureConfigs": [ # Configuration of different suggestion features. One feature can have only one config. { # Config for suggestion features. "conversationModelConfig": { # Custom conversation models used in agent assist feature. Supported feature: ARTICLE_SUGGESTION, SMART_COMPOSE, SMART_REPLY, CONVERSATION_SUMMARIZATION. # Configs of custom conversation model. @@ -1218,6 +1252,8 @@

Method Details

"disableAgentQueryLogging": True or False, # Optional. Disable the logging of search queries sent by human agents. It can prevent those queries from being stored at answer records. Supported features: KNOWLEDGE_SEARCH. "enableConversationAugmentedQuery": True or False, # Optional. Enable including conversation context during query answer generation. Supported features: KNOWLEDGE_SEARCH. "enableEventBasedSuggestion": True or False, # Automatically iterates all participants and tries to compile suggestions. Supported features: ARTICLE_SUGGESTION, FAQ, DIALOGFLOW_ASSIST, ENTITY_EXTRACTION, KNOWLEDGE_ASSIST. + "enableQuerySuggestionOnly": True or False, # Optional. Enable query suggestion only. Supported features: KNOWLEDGE_ASSIST + "enableQuerySuggestionWhenNoAnswer": True or False, # Optional. Enable query suggestion even if we can't find its answer. By default, queries are suggested only if we find its answer. Supported features: KNOWLEDGE_ASSIST "queryConfig": { # Config for suggestion query. # Configs of query. "confidenceThreshold": 3.14, # Confidence threshold of query result. Agent Assist gives each suggestion a score in the range [0.0, 1.0], based on the relevance between the suggestion and the current conversation context. A score of 0.0 has no relevance, while a score of 1.0 has high relevance. Only suggestions with a score greater than or equal to the value of this field are included in the results. For a baseline model (the default), the recommended value is in the range [0.05, 0.1]. For a custom model, there is no recommended value. Tune this value by starting from a very low value and slowly increasing until you have desired results. If this field is not set, it is default to 0.0, which means that all suggestions are returned. Supported features: ARTICLE_SUGGESTION, FAQ, SMART_REPLY, SMART_COMPOSE, KNOWLEDGE_SEARCH, KNOWLEDGE_ASSIST, ENTITY_EXTRACTION. "contextFilterSettings": { # Settings that determine how to filter recent conversation context when generating suggestions. # Determines how recent conversation context is filtered when generating suggestions. If unspecified, no messages will be dropped. @@ -1340,6 +1376,8 @@

Method Details

"disableAgentQueryLogging": True or False, # Optional. Disable the logging of search queries sent by human agents. It can prevent those queries from being stored at answer records. Supported features: KNOWLEDGE_SEARCH. "enableConversationAugmentedQuery": True or False, # Optional. Enable including conversation context during query answer generation. Supported features: KNOWLEDGE_SEARCH. "enableEventBasedSuggestion": True or False, # Automatically iterates all participants and tries to compile suggestions. Supported features: ARTICLE_SUGGESTION, FAQ, DIALOGFLOW_ASSIST, ENTITY_EXTRACTION, KNOWLEDGE_ASSIST. + "enableQuerySuggestionOnly": True or False, # Optional. Enable query suggestion only. Supported features: KNOWLEDGE_ASSIST + "enableQuerySuggestionWhenNoAnswer": True or False, # Optional. Enable query suggestion even if we can't find its answer. By default, queries are suggested only if we find its answer. Supported features: KNOWLEDGE_ASSIST "queryConfig": { # Config for suggestion query. # Configs of query. "confidenceThreshold": 3.14, # Confidence threshold of query result. Agent Assist gives each suggestion a score in the range [0.0, 1.0], based on the relevance between the suggestion and the current conversation context. A score of 0.0 has no relevance, while a score of 1.0 has high relevance. Only suggestions with a score greater than or equal to the value of this field are included in the results. For a baseline model (the default), the recommended value is in the range [0.05, 0.1]. For a custom model, there is no recommended value. Tune this value by starting from a very low value and slowly increasing until you have desired results. If this field is not set, it is default to 0.0, which means that all suggestions are returned. Supported features: ARTICLE_SUGGESTION, FAQ, SMART_REPLY, SMART_COMPOSE, KNOWLEDGE_SEARCH, KNOWLEDGE_ASSIST, ENTITY_EXTRACTION. "contextFilterSettings": { # Settings that determine how to filter recent conversation context when generating suggestions. # Determines how recent conversation context is filtered when generating suggestions. If unspecified, no messages will be dropped. diff --git a/docs/dyn/dialogflow_v2beta1.projects.locations.conversations.participants.html b/docs/dyn/dialogflow_v2beta1.projects.locations.conversations.participants.html index f1f5c2c0b1b..79f806031f5 100644 --- a/docs/dyn/dialogflow_v2beta1.projects.locations.conversations.participants.html +++ b/docs/dyn/dialogflow_v2beta1.projects.locations.conversations.participants.html @@ -262,6 +262,7 @@

Method Details

"automatedAgentReply": { # Represents a response from an automated agent. # Optional. 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. "allowCancellation": True or False, # Indicates whether the partial automated agent reply is interruptible when a later reply message arrives. e.g. if the agent specified some music as partial response, it can be cancelled. "automatedAgentReplyType": "A String", # AutomatedAgentReply type. + "callCompanionAuthCode": "A String", # The auth code for accessing Call Companion UI. "cxCurrentPage": "A String", # The unique identifier of the current Dialogflow CX conversation page. Format: `projects//locations//agents//flows//pages/`. "cxSessionParameters": { # The collection of current Dialogflow CX agent session parameters at the time of this response. Deprecated: Use `parameters` instead. "a_key": "", # Properties of the object. @@ -3083,6 +3084,31 @@

Method Details

], "latestMessage": "A String", # The name of the latest conversation message used to compile suggestion for. Format: `projects//locations//conversations//messages/`. }, + "suggestKnowledgeAssistResponse": { # The response message for Participants.SuggestKnowledgeAssist. # SuggestKnowledgeAssistResponse if request is for KNOWLEDGE_ASSIST. + "contextSize": 42, # Number of messages prior to and including latest_message to compile the suggestion. It may be smaller than the SuggestKnowledgeAssistRequest.context_size field in the request if there are fewer messages in the conversation. + "knowledgeAssistAnswer": { # Represents a Knowledge Assist answer. # Output only. Knowledge Assist suggestion. + "answerRecord": "A String", # The name of the answer record. Format: `projects//locations//answer Records/`. + "suggestedQuery": { # Represents a suggested query. # The query suggested based on the context. Suggestion is made only if it is different from the previous suggestion. + "queryText": "A String", # Suggested query text. + }, + "suggestedQueryAnswer": { # Represents an answer from Knowledge. Currently supports FAQ and Generative answers. # The answer generated for the suggested query. Whether or not an answer is generated depends on how confident we are about the generated query. + "answerText": "A String", # The piece of text from the `source` that answers this suggested query. + "faqSource": { # Details about source of FAQ answer. # Populated if the prediction came from FAQ. + "question": "A String", # The corresponding FAQ question. + }, + "generativeSource": { # Details about source of Generative answer. # Populated if the prediction was Generative. + "snippets": [ # All snippets used for this Generative Prediction, with their source URI and data. + { # Snippet Source for a Generative Prediction. + "text": "A String", # Text taken from that URI. + "title": "A String", # Title of the document. + "uri": "A String", # URI the data is sourced from. + }, + ], + }, + }, + }, + "latestMessage": "A String", # The name of the latest conversation message used to compile suggestion for. Format: `projects//locations//conversations//messages/`. + }, "suggestSmartRepliesResponse": { # The response message for Participants.SuggestSmartReplies. # SuggestSmartRepliesResponse if request is for SMART_REPLY. "contextSize": 42, # Number of messages prior to and including latest_message to compile the suggestion. It may be smaller than the SuggestSmartRepliesRequest.context_size field in the request if there aren't that many messages in the conversation. "latestMessage": "A String", # The name of the latest conversation message used to compile suggestion for. Format: `projects//locations//conversations//messages/`. @@ -4504,6 +4530,31 @@

Method Details

], "latestMessage": "A String", # The name of the latest conversation message used to compile suggestion for. Format: `projects//locations//conversations//messages/`. }, + "suggestKnowledgeAssistResponse": { # The response message for Participants.SuggestKnowledgeAssist. # SuggestKnowledgeAssistResponse if request is for KNOWLEDGE_ASSIST. + "contextSize": 42, # Number of messages prior to and including latest_message to compile the suggestion. It may be smaller than the SuggestKnowledgeAssistRequest.context_size field in the request if there are fewer messages in the conversation. + "knowledgeAssistAnswer": { # Represents a Knowledge Assist answer. # Output only. Knowledge Assist suggestion. + "answerRecord": "A String", # The name of the answer record. Format: `projects//locations//answer Records/`. + "suggestedQuery": { # Represents a suggested query. # The query suggested based on the context. Suggestion is made only if it is different from the previous suggestion. + "queryText": "A String", # Suggested query text. + }, + "suggestedQueryAnswer": { # Represents an answer from Knowledge. Currently supports FAQ and Generative answers. # The answer generated for the suggested query. Whether or not an answer is generated depends on how confident we are about the generated query. + "answerText": "A String", # The piece of text from the `source` that answers this suggested query. + "faqSource": { # Details about source of FAQ answer. # Populated if the prediction came from FAQ. + "question": "A String", # The corresponding FAQ question. + }, + "generativeSource": { # Details about source of Generative answer. # Populated if the prediction was Generative. + "snippets": [ # All snippets used for this Generative Prediction, with their source URI and data. + { # Snippet Source for a Generative Prediction. + "text": "A String", # Text taken from that URI. + "title": "A String", # Title of the document. + "uri": "A String", # URI the data is sourced from. + }, + ], + }, + }, + }, + "latestMessage": "A String", # The name of the latest conversation message used to compile suggestion for. Format: `projects//locations//conversations//messages/`. + }, "suggestSmartRepliesResponse": { # The response message for Participants.SuggestSmartReplies. # SuggestSmartRepliesResponse if request is for SMART_REPLY. "contextSize": 42, # Number of messages prior to and including latest_message to compile the suggestion. It may be smaller than the SuggestSmartRepliesRequest.context_size field in the request if there aren't that many messages in the conversation. "latestMessage": "A String", # The name of the latest conversation message used to compile suggestion for. Format: `projects//locations//conversations//messages/`. diff --git a/docs/dyn/dialogflow_v2beta1.projects.locations.conversations.participants.suggestions.html b/docs/dyn/dialogflow_v2beta1.projects.locations.conversations.participants.suggestions.html index ff597b1521e..6d2200c454a 100644 --- a/docs/dyn/dialogflow_v2beta1.projects.locations.conversations.participants.suggestions.html +++ b/docs/dyn/dialogflow_v2beta1.projects.locations.conversations.participants.suggestions.html @@ -83,6 +83,9 @@

Instance Methods

suggestFaqAnswers(parent, body=None, x__xgafv=None)

Gets suggested faq answers for a participant based on specific historical messages.

+

+ suggestKnowledgeAssist(parent, body=None, x__xgafv=None)

+

Gets knowledge assist suggestions based on historical messages.

suggestSmartReplies(parent, body=None, x__xgafv=None)

Gets smart replies for a participant based on specific historical messages.

@@ -183,6 +186,56 @@

Method Details

}
+
+ suggestKnowledgeAssist(parent, body=None, x__xgafv=None) +
Gets knowledge assist suggestions based on historical messages.
+
+Args:
+  parent: string, Required. The name of the participant to fetch suggestions for. Format: `projects//locations//conversations//participants/`. (required)
+  body: object, The request body.
+    The object takes the form of:
+
+{ # The request message for Participants.SuggestKnowledgeAssist.
+  "contextSize": 42, # Optional. Max number of messages prior to and including latest_message to use as context when compiling the suggestion. The context size is by default 100 and at most 100.
+  "latestMessage": "A String", # Optional. The name of the latest conversation message to compile suggestions for. If empty, it will be the latest message of the conversation. Format: `projects//locations//conversations//messages/`.
+  "previousSuggestedQuery": "A String", # Optional. The previously suggested query for the given conversation. This helps identify whether the next suggestion we generate is resonably different from the previous one. This is useful to avoid similar suggestions within the conversation.
+}
+
+  x__xgafv: string, V1 error format.
+    Allowed values
+      1 - v1 error format
+      2 - v2 error format
+
+Returns:
+  An object of the form:
+
+    { # The response message for Participants.SuggestKnowledgeAssist.
+  "contextSize": 42, # Number of messages prior to and including latest_message to compile the suggestion. It may be smaller than the SuggestKnowledgeAssistRequest.context_size field in the request if there are fewer messages in the conversation.
+  "knowledgeAssistAnswer": { # Represents a Knowledge Assist answer. # Output only. Knowledge Assist suggestion.
+    "answerRecord": "A String", # The name of the answer record. Format: `projects//locations//answer Records/`.
+    "suggestedQuery": { # Represents a suggested query. # The query suggested based on the context. Suggestion is made only if it is different from the previous suggestion.
+      "queryText": "A String", # Suggested query text.
+    },
+    "suggestedQueryAnswer": { # Represents an answer from Knowledge. Currently supports FAQ and Generative answers. # The answer generated for the suggested query. Whether or not an answer is generated depends on how confident we are about the generated query.
+      "answerText": "A String", # The piece of text from the `source` that answers this suggested query.
+      "faqSource": { # Details about source of FAQ answer. # Populated if the prediction came from FAQ.
+        "question": "A String", # The corresponding FAQ question.
+      },
+      "generativeSource": { # Details about source of Generative answer. # Populated if the prediction was Generative.
+        "snippets": [ # All snippets used for this Generative Prediction, with their source URI and data.
+          { # Snippet Source for a Generative Prediction.
+            "text": "A String", # Text taken from that URI.
+            "title": "A String", # Title of the document.
+            "uri": "A String", # URI the data is sourced from.
+          },
+        ],
+      },
+    },
+  },
+  "latestMessage": "A String", # The name of the latest conversation message used to compile suggestion for. Format: `projects//locations//conversations//messages/`.
+}
+
+
suggestSmartReplies(parent, body=None, x__xgafv=None)
Gets smart replies for a participant based on specific historical messages.
diff --git a/docs/dyn/dialogflow_v2beta1.projects.locations.suggestions.html b/docs/dyn/dialogflow_v2beta1.projects.locations.suggestions.html
index 462615c5026..91b69a493c4 100644
--- a/docs/dyn/dialogflow_v2beta1.projects.locations.suggestions.html
+++ b/docs/dyn/dialogflow_v2beta1.projects.locations.suggestions.html
@@ -108,6 +108,7 @@ 

Method Details

"displayName": "A String", # Required. Human readable name for this profile. Max length 1024 bytes. "humanAgentAssistantConfig": { # Defines the Human Agent Assistant to connect to a conversation. # Configuration for agent assistance to use with this profile. "endUserSuggestionConfig": { # Detail human agent assistant config. # Configuration for agent assistance of end user participant. Currently, this feature is not general available, please contact Google to get access. + "disableHighLatencyFeaturesSyncDelivery": True or False, # Optional. When disable_high_latency_features_sync_delivery is true and using the AnalyzeContent API, we will not deliver the responses from high latency features in the API response. The human_agent_assistant_config.notification_config must be configured and enable_event_based_suggestion must be set to true to receive the responses from high latency features in Pub/Sub. High latency feature(s): KNOWLEDGE_ASSIST. "featureConfigs": [ # Configuration of different suggestion features. One feature can have only one config. { # Config for suggestion features. "conversationModelConfig": { # Custom conversation models used in agent assist feature. Supported feature: ARTICLE_SUGGESTION, SMART_COMPOSE, SMART_REPLY, CONVERSATION_SUMMARIZATION. # Configs of custom conversation model. @@ -120,6 +121,8 @@

Method Details

"disableAgentQueryLogging": True or False, # Optional. Disable the logging of search queries sent by human agents. It can prevent those queries from being stored at answer records. Supported features: KNOWLEDGE_SEARCH. "enableConversationAugmentedQuery": True or False, # Optional. Enable including conversation context during query answer generation. Supported features: KNOWLEDGE_SEARCH. "enableEventBasedSuggestion": True or False, # Automatically iterates all participants and tries to compile suggestions. Supported features: ARTICLE_SUGGESTION, FAQ, DIALOGFLOW_ASSIST, ENTITY_EXTRACTION, KNOWLEDGE_ASSIST. + "enableQuerySuggestionOnly": True or False, # Optional. Enable query suggestion only. Supported features: KNOWLEDGE_ASSIST + "enableQuerySuggestionWhenNoAnswer": True or False, # Optional. Enable query suggestion even if we can't find its answer. By default, queries are suggested only if we find its answer. Supported features: KNOWLEDGE_ASSIST "queryConfig": { # Config for suggestion query. # Configs of query. "confidenceThreshold": 3.14, # Confidence threshold of query result. Agent Assist gives each suggestion a score in the range [0.0, 1.0], based on the relevance between the suggestion and the current conversation context. A score of 0.0 has no relevance, while a score of 1.0 has high relevance. Only suggestions with a score greater than or equal to the value of this field are included in the results. For a baseline model (the default), the recommended value is in the range [0.05, 0.1]. For a custom model, there is no recommended value. Tune this value by starting from a very low value and slowly increasing until you have desired results. If this field is not set, it is default to 0.0, which means that all suggestions are returned. Supported features: ARTICLE_SUGGESTION, FAQ, SMART_REPLY, SMART_COMPOSE, KNOWLEDGE_SEARCH, KNOWLEDGE_ASSIST, ENTITY_EXTRACTION. "contextFilterSettings": { # Settings that determine how to filter recent conversation context when generating suggestions. # Determines how recent conversation context is filtered when generating suggestions. If unspecified, no messages will be dropped. @@ -165,6 +168,7 @@

Method Details

"groupSuggestionResponses": True or False, # If `group_suggestion_responses` is false, and there are multiple `feature_configs` in `event based suggestion` or StreamingAnalyzeContent, we will try to deliver suggestions to customers as soon as we get new suggestion. Different type of suggestions based on the same context will be in separate Pub/Sub event or `StreamingAnalyzeContentResponse`. If `group_suggestion_responses` set to true. All the suggestions to the same participant based on the same context will be grouped into a single Pub/Sub event or StreamingAnalyzeContentResponse. }, "humanAgentSuggestionConfig": { # Detail human agent assistant config. # Configuration for agent assistance of human agent participant. + "disableHighLatencyFeaturesSyncDelivery": True or False, # Optional. When disable_high_latency_features_sync_delivery is true and using the AnalyzeContent API, we will not deliver the responses from high latency features in the API response. The human_agent_assistant_config.notification_config must be configured and enable_event_based_suggestion must be set to true to receive the responses from high latency features in Pub/Sub. High latency feature(s): KNOWLEDGE_ASSIST. "featureConfigs": [ # Configuration of different suggestion features. One feature can have only one config. { # Config for suggestion features. "conversationModelConfig": { # Custom conversation models used in agent assist feature. Supported feature: ARTICLE_SUGGESTION, SMART_COMPOSE, SMART_REPLY, CONVERSATION_SUMMARIZATION. # Configs of custom conversation model. @@ -177,6 +181,8 @@

Method Details

"disableAgentQueryLogging": True or False, # Optional. Disable the logging of search queries sent by human agents. It can prevent those queries from being stored at answer records. Supported features: KNOWLEDGE_SEARCH. "enableConversationAugmentedQuery": True or False, # Optional. Enable including conversation context during query answer generation. Supported features: KNOWLEDGE_SEARCH. "enableEventBasedSuggestion": True or False, # Automatically iterates all participants and tries to compile suggestions. Supported features: ARTICLE_SUGGESTION, FAQ, DIALOGFLOW_ASSIST, ENTITY_EXTRACTION, KNOWLEDGE_ASSIST. + "enableQuerySuggestionOnly": True or False, # Optional. Enable query suggestion only. Supported features: KNOWLEDGE_ASSIST + "enableQuerySuggestionWhenNoAnswer": True or False, # Optional. Enable query suggestion even if we can't find its answer. By default, queries are suggested only if we find its answer. Supported features: KNOWLEDGE_ASSIST "queryConfig": { # Config for suggestion query. # Configs of query. "confidenceThreshold": 3.14, # Confidence threshold of query result. Agent Assist gives each suggestion a score in the range [0.0, 1.0], based on the relevance between the suggestion and the current conversation context. A score of 0.0 has no relevance, while a score of 1.0 has high relevance. Only suggestions with a score greater than or equal to the value of this field are included in the results. For a baseline model (the default), the recommended value is in the range [0.05, 0.1]. For a custom model, there is no recommended value. Tune this value by starting from a very low value and slowly increasing until you have desired results. If this field is not set, it is default to 0.0, which means that all suggestions are returned. Supported features: ARTICLE_SUGGESTION, FAQ, SMART_REPLY, SMART_COMPOSE, KNOWLEDGE_SEARCH, KNOWLEDGE_ASSIST, ENTITY_EXTRACTION. "contextFilterSettings": { # Settings that determine how to filter recent conversation context when generating suggestions. # Determines how recent conversation context is filtered when generating suggestions. If unspecified, no messages will be dropped. diff --git a/docs/dyn/dialogflow_v2beta1.projects.suggestions.html b/docs/dyn/dialogflow_v2beta1.projects.suggestions.html index a06739ce92b..b66cf0acd1d 100644 --- a/docs/dyn/dialogflow_v2beta1.projects.suggestions.html +++ b/docs/dyn/dialogflow_v2beta1.projects.suggestions.html @@ -108,6 +108,7 @@

Method Details

"displayName": "A String", # Required. Human readable name for this profile. Max length 1024 bytes. "humanAgentAssistantConfig": { # Defines the Human Agent Assistant to connect to a conversation. # Configuration for agent assistance to use with this profile. "endUserSuggestionConfig": { # Detail human agent assistant config. # Configuration for agent assistance of end user participant. Currently, this feature is not general available, please contact Google to get access. + "disableHighLatencyFeaturesSyncDelivery": True or False, # Optional. When disable_high_latency_features_sync_delivery is true and using the AnalyzeContent API, we will not deliver the responses from high latency features in the API response. The human_agent_assistant_config.notification_config must be configured and enable_event_based_suggestion must be set to true to receive the responses from high latency features in Pub/Sub. High latency feature(s): KNOWLEDGE_ASSIST. "featureConfigs": [ # Configuration of different suggestion features. One feature can have only one config. { # Config for suggestion features. "conversationModelConfig": { # Custom conversation models used in agent assist feature. Supported feature: ARTICLE_SUGGESTION, SMART_COMPOSE, SMART_REPLY, CONVERSATION_SUMMARIZATION. # Configs of custom conversation model. @@ -120,6 +121,8 @@

Method Details

"disableAgentQueryLogging": True or False, # Optional. Disable the logging of search queries sent by human agents. It can prevent those queries from being stored at answer records. Supported features: KNOWLEDGE_SEARCH. "enableConversationAugmentedQuery": True or False, # Optional. Enable including conversation context during query answer generation. Supported features: KNOWLEDGE_SEARCH. "enableEventBasedSuggestion": True or False, # Automatically iterates all participants and tries to compile suggestions. Supported features: ARTICLE_SUGGESTION, FAQ, DIALOGFLOW_ASSIST, ENTITY_EXTRACTION, KNOWLEDGE_ASSIST. + "enableQuerySuggestionOnly": True or False, # Optional. Enable query suggestion only. Supported features: KNOWLEDGE_ASSIST + "enableQuerySuggestionWhenNoAnswer": True or False, # Optional. Enable query suggestion even if we can't find its answer. By default, queries are suggested only if we find its answer. Supported features: KNOWLEDGE_ASSIST "queryConfig": { # Config for suggestion query. # Configs of query. "confidenceThreshold": 3.14, # Confidence threshold of query result. Agent Assist gives each suggestion a score in the range [0.0, 1.0], based on the relevance between the suggestion and the current conversation context. A score of 0.0 has no relevance, while a score of 1.0 has high relevance. Only suggestions with a score greater than or equal to the value of this field are included in the results. For a baseline model (the default), the recommended value is in the range [0.05, 0.1]. For a custom model, there is no recommended value. Tune this value by starting from a very low value and slowly increasing until you have desired results. If this field is not set, it is default to 0.0, which means that all suggestions are returned. Supported features: ARTICLE_SUGGESTION, FAQ, SMART_REPLY, SMART_COMPOSE, KNOWLEDGE_SEARCH, KNOWLEDGE_ASSIST, ENTITY_EXTRACTION. "contextFilterSettings": { # Settings that determine how to filter recent conversation context when generating suggestions. # Determines how recent conversation context is filtered when generating suggestions. If unspecified, no messages will be dropped. @@ -165,6 +168,7 @@

Method Details

"groupSuggestionResponses": True or False, # If `group_suggestion_responses` is false, and there are multiple `feature_configs` in `event based suggestion` or StreamingAnalyzeContent, we will try to deliver suggestions to customers as soon as we get new suggestion. Different type of suggestions based on the same context will be in separate Pub/Sub event or `StreamingAnalyzeContentResponse`. If `group_suggestion_responses` set to true. All the suggestions to the same participant based on the same context will be grouped into a single Pub/Sub event or StreamingAnalyzeContentResponse. }, "humanAgentSuggestionConfig": { # Detail human agent assistant config. # Configuration for agent assistance of human agent participant. + "disableHighLatencyFeaturesSyncDelivery": True or False, # Optional. When disable_high_latency_features_sync_delivery is true and using the AnalyzeContent API, we will not deliver the responses from high latency features in the API response. The human_agent_assistant_config.notification_config must be configured and enable_event_based_suggestion must be set to true to receive the responses from high latency features in Pub/Sub. High latency feature(s): KNOWLEDGE_ASSIST. "featureConfigs": [ # Configuration of different suggestion features. One feature can have only one config. { # Config for suggestion features. "conversationModelConfig": { # Custom conversation models used in agent assist feature. Supported feature: ARTICLE_SUGGESTION, SMART_COMPOSE, SMART_REPLY, CONVERSATION_SUMMARIZATION. # Configs of custom conversation model. @@ -177,6 +181,8 @@

Method Details

"disableAgentQueryLogging": True or False, # Optional. Disable the logging of search queries sent by human agents. It can prevent those queries from being stored at answer records. Supported features: KNOWLEDGE_SEARCH. "enableConversationAugmentedQuery": True or False, # Optional. Enable including conversation context during query answer generation. Supported features: KNOWLEDGE_SEARCH. "enableEventBasedSuggestion": True or False, # Automatically iterates all participants and tries to compile suggestions. Supported features: ARTICLE_SUGGESTION, FAQ, DIALOGFLOW_ASSIST, ENTITY_EXTRACTION, KNOWLEDGE_ASSIST. + "enableQuerySuggestionOnly": True or False, # Optional. Enable query suggestion only. Supported features: KNOWLEDGE_ASSIST + "enableQuerySuggestionWhenNoAnswer": True or False, # Optional. Enable query suggestion even if we can't find its answer. By default, queries are suggested only if we find its answer. Supported features: KNOWLEDGE_ASSIST "queryConfig": { # Config for suggestion query. # Configs of query. "confidenceThreshold": 3.14, # Confidence threshold of query result. Agent Assist gives each suggestion a score in the range [0.0, 1.0], based on the relevance between the suggestion and the current conversation context. A score of 0.0 has no relevance, while a score of 1.0 has high relevance. Only suggestions with a score greater than or equal to the value of this field are included in the results. For a baseline model (the default), the recommended value is in the range [0.05, 0.1]. For a custom model, there is no recommended value. Tune this value by starting from a very low value and slowly increasing until you have desired results. If this field is not set, it is default to 0.0, which means that all suggestions are returned. Supported features: ARTICLE_SUGGESTION, FAQ, SMART_REPLY, SMART_COMPOSE, KNOWLEDGE_SEARCH, KNOWLEDGE_ASSIST, ENTITY_EXTRACTION. "contextFilterSettings": { # Settings that determine how to filter recent conversation context when generating suggestions. # Determines how recent conversation context is filtered when generating suggestions. If unspecified, no messages will be dropped. diff --git a/docs/dyn/dialogflow_v3.projects.locations.agents.environments.sessions.html b/docs/dyn/dialogflow_v3.projects.locations.agents.environments.sessions.html index b1b63166b94..b215ff76f33 100644 --- a/docs/dyn/dialogflow_v3.projects.locations.agents.environments.sessions.html +++ b/docs/dyn/dialogflow_v3.projects.locations.agents.environments.sessions.html @@ -272,8 +272,8 @@

Method Details

"maxDigits": 42, # Max length of DTMF digits. }, "loggingSettings": { # Define behaviors on logging. # Settings for logging. Settings for Dialogflow History, Contact Center messages, StackDriver logs, and speech logging. Exposed at the following levels: - Agent level. - "enableInteractionLogging": True or False, # If true, DF Interaction logging is currently enabled. - "enableStackdriverLogging": True or False, # If true, StackDriver logging is currently enabled. + "enableInteractionLogging": True or False, # Enables DF Interaction logging. + "enableStackdriverLogging": True or False, # Enables StackDriver logging. }, "speechSettings": { # Define behaviors of speech to text detection. # Settings for speech to text detection. Exposed at the following levels: - Agent level - Flow level - Page level - Parameter level "endpointerSensitivity": 42, # Sensitivity of the speech model that detects the end of speech. Scale from 0 to 100. @@ -298,8 +298,8 @@

Method Details

"maxDigits": 42, # Max length of DTMF digits. }, "loggingSettings": { # Define behaviors on logging. # Settings for logging. Settings for Dialogflow History, Contact Center messages, StackDriver logs, and speech logging. Exposed at the following levels: - Agent level. - "enableInteractionLogging": True or False, # If true, DF Interaction logging is currently enabled. - "enableStackdriverLogging": True or False, # If true, StackDriver logging is currently enabled. + "enableInteractionLogging": True or False, # Enables DF Interaction logging. + "enableStackdriverLogging": True or False, # Enables StackDriver logging. }, "speechSettings": { # Define behaviors of speech to text detection. # Settings for speech to text detection. Exposed at the following levels: - Agent level - Flow level - Page level - Parameter level "endpointerSensitivity": 42, # Sensitivity of the speech model that detects the end of speech. Scale from 0 to 100. @@ -325,8 +325,8 @@

Method Details

"maxDigits": 42, # Max length of DTMF digits. }, "loggingSettings": { # Define behaviors on logging. # Settings for logging. Settings for Dialogflow History, Contact Center messages, StackDriver logs, and speech logging. Exposed at the following levels: - Agent level. - "enableInteractionLogging": True or False, # If true, DF Interaction logging is currently enabled. - "enableStackdriverLogging": True or False, # If true, StackDriver logging is currently enabled. + "enableInteractionLogging": True or False, # Enables DF Interaction logging. + "enableStackdriverLogging": True or False, # Enables StackDriver logging. }, "speechSettings": { # Define behaviors of speech to text detection. # Settings for speech to text detection. Exposed at the following levels: - Agent level - Flow level - Page level - Parameter level "endpointerSensitivity": 42, # Sensitivity of the speech model that detects the end of speech. Scale from 0 to 100. @@ -479,8 +479,8 @@

Method Details

"maxDigits": 42, # Max length of DTMF digits. }, "loggingSettings": { # Define behaviors on logging. # Settings for logging. Settings for Dialogflow History, Contact Center messages, StackDriver logs, and speech logging. Exposed at the following levels: - Agent level. - "enableInteractionLogging": True or False, # If true, DF Interaction logging is currently enabled. - "enableStackdriverLogging": True or False, # If true, StackDriver logging is currently enabled. + "enableInteractionLogging": True or False, # Enables DF Interaction logging. + "enableStackdriverLogging": True or False, # Enables StackDriver logging. }, "speechSettings": { # Define behaviors of speech to text detection. # Settings for speech to text detection. Exposed at the following levels: - Agent level - Flow level - Page level - Parameter level "endpointerSensitivity": 42, # Sensitivity of the speech model that detects the end of speech. Scale from 0 to 100. @@ -631,8 +631,8 @@

Method Details

"maxDigits": 42, # Max length of DTMF digits. }, "loggingSettings": { # Define behaviors on logging. # Settings for logging. Settings for Dialogflow History, Contact Center messages, StackDriver logs, and speech logging. Exposed at the following levels: - Agent level. - "enableInteractionLogging": True or False, # If true, DF Interaction logging is currently enabled. - "enableStackdriverLogging": True or False, # If true, StackDriver logging is currently enabled. + "enableInteractionLogging": True or False, # Enables DF Interaction logging. + "enableStackdriverLogging": True or False, # Enables StackDriver logging. }, "speechSettings": { # Define behaviors of speech to text detection. # Settings for speech to text detection. Exposed at the following levels: - Agent level - Flow level - Page level - Parameter level "endpointerSensitivity": 42, # Sensitivity of the speech model that detects the end of speech. Scale from 0 to 100. @@ -660,8 +660,8 @@

Method Details

"maxDigits": 42, # Max length of DTMF digits. }, "loggingSettings": { # Define behaviors on logging. # Settings for logging. Settings for Dialogflow History, Contact Center messages, StackDriver logs, and speech logging. Exposed at the following levels: - Agent level. - "enableInteractionLogging": True or False, # If true, DF Interaction logging is currently enabled. - "enableStackdriverLogging": True or False, # If true, StackDriver logging is currently enabled. + "enableInteractionLogging": True or False, # Enables DF Interaction logging. + "enableStackdriverLogging": True or False, # Enables StackDriver logging. }, "speechSettings": { # Define behaviors of speech to text detection. # Settings for speech to text detection. Exposed at the following levels: - Agent level - Flow level - Page level - Parameter level "endpointerSensitivity": 42, # Sensitivity of the speech model that detects the end of speech. Scale from 0 to 100. @@ -814,8 +814,8 @@

Method Details

"maxDigits": 42, # Max length of DTMF digits. }, "loggingSettings": { # Define behaviors on logging. # Settings for logging. Settings for Dialogflow History, Contact Center messages, StackDriver logs, and speech logging. Exposed at the following levels: - Agent level. - "enableInteractionLogging": True or False, # If true, DF Interaction logging is currently enabled. - "enableStackdriverLogging": True or False, # If true, StackDriver logging is currently enabled. + "enableInteractionLogging": True or False, # Enables DF Interaction logging. + "enableStackdriverLogging": True or False, # Enables StackDriver logging. }, "speechSettings": { # Define behaviors of speech to text detection. # Settings for speech to text detection. Exposed at the following levels: - Agent level - Flow level - Page level - Parameter level "endpointerSensitivity": 42, # Sensitivity of the speech model that detects the end of speech. Scale from 0 to 100. @@ -981,8 +981,8 @@

Method Details

"maxDigits": 42, # Max length of DTMF digits. }, "loggingSettings": { # Define behaviors on logging. # Settings for logging. Settings for Dialogflow History, Contact Center messages, StackDriver logs, and speech logging. Exposed at the following levels: - Agent level. - "enableInteractionLogging": True or False, # If true, DF Interaction logging is currently enabled. - "enableStackdriverLogging": True or False, # If true, StackDriver logging is currently enabled. + "enableInteractionLogging": True or False, # Enables DF Interaction logging. + "enableStackdriverLogging": True or False, # Enables StackDriver logging. }, "speechSettings": { # Define behaviors of speech to text detection. # Settings for speech to text detection. Exposed at the following levels: - Agent level - Flow level - Page level - Parameter level "endpointerSensitivity": 42, # Sensitivity of the speech model that detects the end of speech. Scale from 0 to 100. @@ -1142,8 +1142,8 @@

Method Details

"maxDigits": 42, # Max length of DTMF digits. }, "loggingSettings": { # Define behaviors on logging. # Settings for logging. Settings for Dialogflow History, Contact Center messages, StackDriver logs, and speech logging. Exposed at the following levels: - Agent level. - "enableInteractionLogging": True or False, # If true, DF Interaction logging is currently enabled. - "enableStackdriverLogging": True or False, # If true, StackDriver logging is currently enabled. + "enableInteractionLogging": True or False, # Enables DF Interaction logging. + "enableStackdriverLogging": True or False, # Enables StackDriver logging. }, "speechSettings": { # Define behaviors of speech to text detection. # Settings for speech to text detection. Exposed at the following levels: - Agent level - Flow level - Page level - Parameter level "endpointerSensitivity": 42, # Sensitivity of the speech model that detects the end of speech. Scale from 0 to 100. @@ -1700,8 +1700,8 @@

Method Details

"maxDigits": 42, # Max length of DTMF digits. }, "loggingSettings": { # Define behaviors on logging. # Settings for logging. Settings for Dialogflow History, Contact Center messages, StackDriver logs, and speech logging. Exposed at the following levels: - Agent level. - "enableInteractionLogging": True or False, # If true, DF Interaction logging is currently enabled. - "enableStackdriverLogging": True or False, # If true, StackDriver logging is currently enabled. + "enableInteractionLogging": True or False, # Enables DF Interaction logging. + "enableStackdriverLogging": True or False, # Enables StackDriver logging. }, "speechSettings": { # Define behaviors of speech to text detection. # Settings for speech to text detection. Exposed at the following levels: - Agent level - Flow level - Page level - Parameter level "endpointerSensitivity": 42, # Sensitivity of the speech model that detects the end of speech. Scale from 0 to 100. @@ -1726,8 +1726,8 @@

Method Details

"maxDigits": 42, # Max length of DTMF digits. }, "loggingSettings": { # Define behaviors on logging. # Settings for logging. Settings for Dialogflow History, Contact Center messages, StackDriver logs, and speech logging. Exposed at the following levels: - Agent level. - "enableInteractionLogging": True or False, # If true, DF Interaction logging is currently enabled. - "enableStackdriverLogging": True or False, # If true, StackDriver logging is currently enabled. + "enableInteractionLogging": True or False, # Enables DF Interaction logging. + "enableStackdriverLogging": True or False, # Enables StackDriver logging. }, "speechSettings": { # Define behaviors of speech to text detection. # Settings for speech to text detection. Exposed at the following levels: - Agent level - Flow level - Page level - Parameter level "endpointerSensitivity": 42, # Sensitivity of the speech model that detects the end of speech. Scale from 0 to 100. @@ -1753,8 +1753,8 @@

Method Details

"maxDigits": 42, # Max length of DTMF digits. }, "loggingSettings": { # Define behaviors on logging. # Settings for logging. Settings for Dialogflow History, Contact Center messages, StackDriver logs, and speech logging. Exposed at the following levels: - Agent level. - "enableInteractionLogging": True or False, # If true, DF Interaction logging is currently enabled. - "enableStackdriverLogging": True or False, # If true, StackDriver logging is currently enabled. + "enableInteractionLogging": True or False, # Enables DF Interaction logging. + "enableStackdriverLogging": True or False, # Enables StackDriver logging. }, "speechSettings": { # Define behaviors of speech to text detection. # Settings for speech to text detection. Exposed at the following levels: - Agent level - Flow level - Page level - Parameter level "endpointerSensitivity": 42, # Sensitivity of the speech model that detects the end of speech. Scale from 0 to 100. @@ -1907,8 +1907,8 @@

Method Details

"maxDigits": 42, # Max length of DTMF digits. }, "loggingSettings": { # Define behaviors on logging. # Settings for logging. Settings for Dialogflow History, Contact Center messages, StackDriver logs, and speech logging. Exposed at the following levels: - Agent level. - "enableInteractionLogging": True or False, # If true, DF Interaction logging is currently enabled. - "enableStackdriverLogging": True or False, # If true, StackDriver logging is currently enabled. + "enableInteractionLogging": True or False, # Enables DF Interaction logging. + "enableStackdriverLogging": True or False, # Enables StackDriver logging. }, "speechSettings": { # Define behaviors of speech to text detection. # Settings for speech to text detection. Exposed at the following levels: - Agent level - Flow level - Page level - Parameter level "endpointerSensitivity": 42, # Sensitivity of the speech model that detects the end of speech. Scale from 0 to 100. @@ -2059,8 +2059,8 @@

Method Details

"maxDigits": 42, # Max length of DTMF digits. }, "loggingSettings": { # Define behaviors on logging. # Settings for logging. Settings for Dialogflow History, Contact Center messages, StackDriver logs, and speech logging. Exposed at the following levels: - Agent level. - "enableInteractionLogging": True or False, # If true, DF Interaction logging is currently enabled. - "enableStackdriverLogging": True or False, # If true, StackDriver logging is currently enabled. + "enableInteractionLogging": True or False, # Enables DF Interaction logging. + "enableStackdriverLogging": True or False, # Enables StackDriver logging. }, "speechSettings": { # Define behaviors of speech to text detection. # Settings for speech to text detection. Exposed at the following levels: - Agent level - Flow level - Page level - Parameter level "endpointerSensitivity": 42, # Sensitivity of the speech model that detects the end of speech. Scale from 0 to 100. @@ -2088,8 +2088,8 @@

Method Details

"maxDigits": 42, # Max length of DTMF digits. }, "loggingSettings": { # Define behaviors on logging. # Settings for logging. Settings for Dialogflow History, Contact Center messages, StackDriver logs, and speech logging. Exposed at the following levels: - Agent level. - "enableInteractionLogging": True or False, # If true, DF Interaction logging is currently enabled. - "enableStackdriverLogging": True or False, # If true, StackDriver logging is currently enabled. + "enableInteractionLogging": True or False, # Enables DF Interaction logging. + "enableStackdriverLogging": True or False, # Enables StackDriver logging. }, "speechSettings": { # Define behaviors of speech to text detection. # Settings for speech to text detection. Exposed at the following levels: - Agent level - Flow level - Page level - Parameter level "endpointerSensitivity": 42, # Sensitivity of the speech model that detects the end of speech. Scale from 0 to 100. @@ -2242,8 +2242,8 @@

Method Details

"maxDigits": 42, # Max length of DTMF digits. }, "loggingSettings": { # Define behaviors on logging. # Settings for logging. Settings for Dialogflow History, Contact Center messages, StackDriver logs, and speech logging. Exposed at the following levels: - Agent level. - "enableInteractionLogging": True or False, # If true, DF Interaction logging is currently enabled. - "enableStackdriverLogging": True or False, # If true, StackDriver logging is currently enabled. + "enableInteractionLogging": True or False, # Enables DF Interaction logging. + "enableStackdriverLogging": True or False, # Enables StackDriver logging. }, "speechSettings": { # Define behaviors of speech to text detection. # Settings for speech to text detection. Exposed at the following levels: - Agent level - Flow level - Page level - Parameter level "endpointerSensitivity": 42, # Sensitivity of the speech model that detects the end of speech. Scale from 0 to 100. @@ -2409,8 +2409,8 @@

Method Details

"maxDigits": 42, # Max length of DTMF digits. }, "loggingSettings": { # Define behaviors on logging. # Settings for logging. Settings for Dialogflow History, Contact Center messages, StackDriver logs, and speech logging. Exposed at the following levels: - Agent level. - "enableInteractionLogging": True or False, # If true, DF Interaction logging is currently enabled. - "enableStackdriverLogging": True or False, # If true, StackDriver logging is currently enabled. + "enableInteractionLogging": True or False, # Enables DF Interaction logging. + "enableStackdriverLogging": True or False, # Enables StackDriver logging. }, "speechSettings": { # Define behaviors of speech to text detection. # Settings for speech to text detection. Exposed at the following levels: - Agent level - Flow level - Page level - Parameter level "endpointerSensitivity": 42, # Sensitivity of the speech model that detects the end of speech. Scale from 0 to 100. @@ -2570,8 +2570,8 @@

Method Details

"maxDigits": 42, # Max length of DTMF digits. }, "loggingSettings": { # Define behaviors on logging. # Settings for logging. Settings for Dialogflow History, Contact Center messages, StackDriver logs, and speech logging. Exposed at the following levels: - Agent level. - "enableInteractionLogging": True or False, # If true, DF Interaction logging is currently enabled. - "enableStackdriverLogging": True or False, # If true, StackDriver logging is currently enabled. + "enableInteractionLogging": True or False, # Enables DF Interaction logging. + "enableStackdriverLogging": True or False, # Enables StackDriver logging. }, "speechSettings": { # Define behaviors of speech to text detection. # Settings for speech to text detection. Exposed at the following levels: - Agent level - Flow level - Page level - Parameter level "endpointerSensitivity": 42, # Sensitivity of the speech model that detects the end of speech. Scale from 0 to 100. @@ -3053,8 +3053,8 @@

Method Details

"maxDigits": 42, # Max length of DTMF digits. }, "loggingSettings": { # Define behaviors on logging. # Settings for logging. Settings for Dialogflow History, Contact Center messages, StackDriver logs, and speech logging. Exposed at the following levels: - Agent level. - "enableInteractionLogging": True or False, # If true, DF Interaction logging is currently enabled. - "enableStackdriverLogging": True or False, # If true, StackDriver logging is currently enabled. + "enableInteractionLogging": True or False, # Enables DF Interaction logging. + "enableStackdriverLogging": True or False, # Enables StackDriver logging. }, "speechSettings": { # Define behaviors of speech to text detection. # Settings for speech to text detection. Exposed at the following levels: - Agent level - Flow level - Page level - Parameter level "endpointerSensitivity": 42, # Sensitivity of the speech model that detects the end of speech. Scale from 0 to 100. @@ -3080,8 +3080,8 @@

Method Details

"maxDigits": 42, # Max length of DTMF digits. }, "loggingSettings": { # Define behaviors on logging. # Settings for logging. Settings for Dialogflow History, Contact Center messages, StackDriver logs, and speech logging. Exposed at the following levels: - Agent level. - "enableInteractionLogging": True or False, # If true, DF Interaction logging is currently enabled. - "enableStackdriverLogging": True or False, # If true, StackDriver logging is currently enabled. + "enableInteractionLogging": True or False, # Enables DF Interaction logging. + "enableStackdriverLogging": True or False, # Enables StackDriver logging. }, "speechSettings": { # Define behaviors of speech to text detection. # Settings for speech to text detection. Exposed at the following levels: - Agent level - Flow level - Page level - Parameter level "endpointerSensitivity": 42, # Sensitivity of the speech model that detects the end of speech. Scale from 0 to 100. @@ -3234,8 +3234,8 @@

Method Details

"maxDigits": 42, # Max length of DTMF digits. }, "loggingSettings": { # Define behaviors on logging. # Settings for logging. Settings for Dialogflow History, Contact Center messages, StackDriver logs, and speech logging. Exposed at the following levels: - Agent level. - "enableInteractionLogging": True or False, # If true, DF Interaction logging is currently enabled. - "enableStackdriverLogging": True or False, # If true, StackDriver logging is currently enabled. + "enableInteractionLogging": True or False, # Enables DF Interaction logging. + "enableStackdriverLogging": True or False, # Enables StackDriver logging. }, "speechSettings": { # Define behaviors of speech to text detection. # Settings for speech to text detection. Exposed at the following levels: - Agent level - Flow level - Page level - Parameter level "endpointerSensitivity": 42, # Sensitivity of the speech model that detects the end of speech. Scale from 0 to 100. @@ -3386,8 +3386,8 @@

Method Details

"maxDigits": 42, # Max length of DTMF digits. }, "loggingSettings": { # Define behaviors on logging. # Settings for logging. Settings for Dialogflow History, Contact Center messages, StackDriver logs, and speech logging. Exposed at the following levels: - Agent level. - "enableInteractionLogging": True or False, # If true, DF Interaction logging is currently enabled. - "enableStackdriverLogging": True or False, # If true, StackDriver logging is currently enabled. + "enableInteractionLogging": True or False, # Enables DF Interaction logging. + "enableStackdriverLogging": True or False, # Enables StackDriver logging. }, "speechSettings": { # Define behaviors of speech to text detection. # Settings for speech to text detection. Exposed at the following levels: - Agent level - Flow level - Page level - Parameter level "endpointerSensitivity": 42, # Sensitivity of the speech model that detects the end of speech. Scale from 0 to 100. @@ -3415,8 +3415,8 @@

Method Details

"maxDigits": 42, # Max length of DTMF digits. }, "loggingSettings": { # Define behaviors on logging. # Settings for logging. Settings for Dialogflow History, Contact Center messages, StackDriver logs, and speech logging. Exposed at the following levels: - Agent level. - "enableInteractionLogging": True or False, # If true, DF Interaction logging is currently enabled. - "enableStackdriverLogging": True or False, # If true, StackDriver logging is currently enabled. + "enableInteractionLogging": True or False, # Enables DF Interaction logging. + "enableStackdriverLogging": True or False, # Enables StackDriver logging. }, "speechSettings": { # Define behaviors of speech to text detection. # Settings for speech to text detection. Exposed at the following levels: - Agent level - Flow level - Page level - Parameter level "endpointerSensitivity": 42, # Sensitivity of the speech model that detects the end of speech. Scale from 0 to 100. @@ -3569,8 +3569,8 @@

Method Details

"maxDigits": 42, # Max length of DTMF digits. }, "loggingSettings": { # Define behaviors on logging. # Settings for logging. Settings for Dialogflow History, Contact Center messages, StackDriver logs, and speech logging. Exposed at the following levels: - Agent level. - "enableInteractionLogging": True or False, # If true, DF Interaction logging is currently enabled. - "enableStackdriverLogging": True or False, # If true, StackDriver logging is currently enabled. + "enableInteractionLogging": True or False, # Enables DF Interaction logging. + "enableStackdriverLogging": True or False, # Enables StackDriver logging. }, "speechSettings": { # Define behaviors of speech to text detection. # Settings for speech to text detection. Exposed at the following levels: - Agent level - Flow level - Page level - Parameter level "endpointerSensitivity": 42, # Sensitivity of the speech model that detects the end of speech. Scale from 0 to 100. @@ -3736,8 +3736,8 @@

Method Details

"maxDigits": 42, # Max length of DTMF digits. }, "loggingSettings": { # Define behaviors on logging. # Settings for logging. Settings for Dialogflow History, Contact Center messages, StackDriver logs, and speech logging. Exposed at the following levels: - Agent level. - "enableInteractionLogging": True or False, # If true, DF Interaction logging is currently enabled. - "enableStackdriverLogging": True or False, # If true, StackDriver logging is currently enabled. + "enableInteractionLogging": True or False, # Enables DF Interaction logging. + "enableStackdriverLogging": True or False, # Enables StackDriver logging. }, "speechSettings": { # Define behaviors of speech to text detection. # Settings for speech to text detection. Exposed at the following levels: - Agent level - Flow level - Page level - Parameter level "endpointerSensitivity": 42, # Sensitivity of the speech model that detects the end of speech. Scale from 0 to 100. @@ -3897,8 +3897,8 @@

Method Details

"maxDigits": 42, # Max length of DTMF digits. }, "loggingSettings": { # Define behaviors on logging. # Settings for logging. Settings for Dialogflow History, Contact Center messages, StackDriver logs, and speech logging. Exposed at the following levels: - Agent level. - "enableInteractionLogging": True or False, # If true, DF Interaction logging is currently enabled. - "enableStackdriverLogging": True or False, # If true, StackDriver logging is currently enabled. + "enableInteractionLogging": True or False, # Enables DF Interaction logging. + "enableStackdriverLogging": True or False, # Enables StackDriver logging. }, "speechSettings": { # Define behaviors of speech to text detection. # Settings for speech to text detection. Exposed at the following levels: - Agent level - Flow level - Page level - Parameter level "endpointerSensitivity": 42, # Sensitivity of the speech model that detects the end of speech. Scale from 0 to 100. @@ -4255,8 +4255,8 @@

Method Details

"maxDigits": 42, # Max length of DTMF digits. }, "loggingSettings": { # Define behaviors on logging. # Settings for logging. Settings for Dialogflow History, Contact Center messages, StackDriver logs, and speech logging. Exposed at the following levels: - Agent level. - "enableInteractionLogging": True or False, # If true, DF Interaction logging is currently enabled. - "enableStackdriverLogging": True or False, # If true, StackDriver logging is currently enabled. + "enableInteractionLogging": True or False, # Enables DF Interaction logging. + "enableStackdriverLogging": True or False, # Enables StackDriver logging. }, "speechSettings": { # Define behaviors of speech to text detection. # Settings for speech to text detection. Exposed at the following levels: - Agent level - Flow level - Page level - Parameter level "endpointerSensitivity": 42, # Sensitivity of the speech model that detects the end of speech. Scale from 0 to 100. @@ -4281,8 +4281,8 @@

Method Details

"maxDigits": 42, # Max length of DTMF digits. }, "loggingSettings": { # Define behaviors on logging. # Settings for logging. Settings for Dialogflow History, Contact Center messages, StackDriver logs, and speech logging. Exposed at the following levels: - Agent level. - "enableInteractionLogging": True or False, # If true, DF Interaction logging is currently enabled. - "enableStackdriverLogging": True or False, # If true, StackDriver logging is currently enabled. + "enableInteractionLogging": True or False, # Enables DF Interaction logging. + "enableStackdriverLogging": True or False, # Enables StackDriver logging. }, "speechSettings": { # Define behaviors of speech to text detection. # Settings for speech to text detection. Exposed at the following levels: - Agent level - Flow level - Page level - Parameter level "endpointerSensitivity": 42, # Sensitivity of the speech model that detects the end of speech. Scale from 0 to 100. @@ -4308,8 +4308,8 @@

Method Details

"maxDigits": 42, # Max length of DTMF digits. }, "loggingSettings": { # Define behaviors on logging. # Settings for logging. Settings for Dialogflow History, Contact Center messages, StackDriver logs, and speech logging. Exposed at the following levels: - Agent level. - "enableInteractionLogging": True or False, # If true, DF Interaction logging is currently enabled. - "enableStackdriverLogging": True or False, # If true, StackDriver logging is currently enabled. + "enableInteractionLogging": True or False, # Enables DF Interaction logging. + "enableStackdriverLogging": True or False, # Enables StackDriver logging. }, "speechSettings": { # Define behaviors of speech to text detection. # Settings for speech to text detection. Exposed at the following levels: - Agent level - Flow level - Page level - Parameter level "endpointerSensitivity": 42, # Sensitivity of the speech model that detects the end of speech. Scale from 0 to 100. @@ -4462,8 +4462,8 @@

Method Details

"maxDigits": 42, # Max length of DTMF digits. }, "loggingSettings": { # Define behaviors on logging. # Settings for logging. Settings for Dialogflow History, Contact Center messages, StackDriver logs, and speech logging. Exposed at the following levels: - Agent level. - "enableInteractionLogging": True or False, # If true, DF Interaction logging is currently enabled. - "enableStackdriverLogging": True or False, # If true, StackDriver logging is currently enabled. + "enableInteractionLogging": True or False, # Enables DF Interaction logging. + "enableStackdriverLogging": True or False, # Enables StackDriver logging. }, "speechSettings": { # Define behaviors of speech to text detection. # Settings for speech to text detection. Exposed at the following levels: - Agent level - Flow level - Page level - Parameter level "endpointerSensitivity": 42, # Sensitivity of the speech model that detects the end of speech. Scale from 0 to 100. @@ -4614,8 +4614,8 @@

Method Details

"maxDigits": 42, # Max length of DTMF digits. }, "loggingSettings": { # Define behaviors on logging. # Settings for logging. Settings for Dialogflow History, Contact Center messages, StackDriver logs, and speech logging. Exposed at the following levels: - Agent level. - "enableInteractionLogging": True or False, # If true, DF Interaction logging is currently enabled. - "enableStackdriverLogging": True or False, # If true, StackDriver logging is currently enabled. + "enableInteractionLogging": True or False, # Enables DF Interaction logging. + "enableStackdriverLogging": True or False, # Enables StackDriver logging. }, "speechSettings": { # Define behaviors of speech to text detection. # Settings for speech to text detection. Exposed at the following levels: - Agent level - Flow level - Page level - Parameter level "endpointerSensitivity": 42, # Sensitivity of the speech model that detects the end of speech. Scale from 0 to 100. @@ -4643,8 +4643,8 @@

Method Details

"maxDigits": 42, # Max length of DTMF digits. }, "loggingSettings": { # Define behaviors on logging. # Settings for logging. Settings for Dialogflow History, Contact Center messages, StackDriver logs, and speech logging. Exposed at the following levels: - Agent level. - "enableInteractionLogging": True or False, # If true, DF Interaction logging is currently enabled. - "enableStackdriverLogging": True or False, # If true, StackDriver logging is currently enabled. + "enableInteractionLogging": True or False, # Enables DF Interaction logging. + "enableStackdriverLogging": True or False, # Enables StackDriver logging. }, "speechSettings": { # Define behaviors of speech to text detection. # Settings for speech to text detection. Exposed at the following levels: - Agent level - Flow level - Page level - Parameter level "endpointerSensitivity": 42, # Sensitivity of the speech model that detects the end of speech. Scale from 0 to 100. @@ -4797,8 +4797,8 @@

Method Details

"maxDigits": 42, # Max length of DTMF digits. }, "loggingSettings": { # Define behaviors on logging. # Settings for logging. Settings for Dialogflow History, Contact Center messages, StackDriver logs, and speech logging. Exposed at the following levels: - Agent level. - "enableInteractionLogging": True or False, # If true, DF Interaction logging is currently enabled. - "enableStackdriverLogging": True or False, # If true, StackDriver logging is currently enabled. + "enableInteractionLogging": True or False, # Enables DF Interaction logging. + "enableStackdriverLogging": True or False, # Enables StackDriver logging. }, "speechSettings": { # Define behaviors of speech to text detection. # Settings for speech to text detection. Exposed at the following levels: - Agent level - Flow level - Page level - Parameter level "endpointerSensitivity": 42, # Sensitivity of the speech model that detects the end of speech. Scale from 0 to 100. @@ -4964,8 +4964,8 @@

Method Details

"maxDigits": 42, # Max length of DTMF digits. }, "loggingSettings": { # Define behaviors on logging. # Settings for logging. Settings for Dialogflow History, Contact Center messages, StackDriver logs, and speech logging. Exposed at the following levels: - Agent level. - "enableInteractionLogging": True or False, # If true, DF Interaction logging is currently enabled. - "enableStackdriverLogging": True or False, # If true, StackDriver logging is currently enabled. + "enableInteractionLogging": True or False, # Enables DF Interaction logging. + "enableStackdriverLogging": True or False, # Enables StackDriver logging. }, "speechSettings": { # Define behaviors of speech to text detection. # Settings for speech to text detection. Exposed at the following levels: - Agent level - Flow level - Page level - Parameter level "endpointerSensitivity": 42, # Sensitivity of the speech model that detects the end of speech. Scale from 0 to 100. @@ -5125,8 +5125,8 @@

Method Details

"maxDigits": 42, # Max length of DTMF digits. }, "loggingSettings": { # Define behaviors on logging. # Settings for logging. Settings for Dialogflow History, Contact Center messages, StackDriver logs, and speech logging. Exposed at the following levels: - Agent level. - "enableInteractionLogging": True or False, # If true, DF Interaction logging is currently enabled. - "enableStackdriverLogging": True or False, # If true, StackDriver logging is currently enabled. + "enableInteractionLogging": True or False, # Enables DF Interaction logging. + "enableStackdriverLogging": True or False, # Enables StackDriver logging. }, "speechSettings": { # Define behaviors of speech to text detection. # Settings for speech to text detection. Exposed at the following levels: - Agent level - Flow level - Page level - Parameter level "endpointerSensitivity": 42, # Sensitivity of the speech model that detects the end of speech. Scale from 0 to 100. diff --git a/docs/dyn/dialogflow_v3.projects.locations.agents.flows.html b/docs/dyn/dialogflow_v3.projects.locations.agents.flows.html index 5d4bf46c376..f56af6a979d 100644 --- a/docs/dyn/dialogflow_v3.projects.locations.agents.flows.html +++ b/docs/dyn/dialogflow_v3.projects.locations.agents.flows.html @@ -153,8 +153,8 @@

Method Details

"maxDigits": 42, # Max length of DTMF digits. }, "loggingSettings": { # Define behaviors on logging. # Settings for logging. Settings for Dialogflow History, Contact Center messages, StackDriver logs, and speech logging. Exposed at the following levels: - Agent level. - "enableInteractionLogging": True or False, # If true, DF Interaction logging is currently enabled. - "enableStackdriverLogging": True or False, # If true, StackDriver logging is currently enabled. + "enableInteractionLogging": True or False, # Enables DF Interaction logging. + "enableStackdriverLogging": True or False, # Enables StackDriver logging. }, "speechSettings": { # Define behaviors of speech to text detection. # Settings for speech to text detection. Exposed at the following levels: - Agent level - Flow level - Page level - Parameter level "endpointerSensitivity": 42, # Sensitivity of the speech model that detects the end of speech. Scale from 0 to 100. @@ -186,8 +186,8 @@

Method Details

"maxDigits": 42, # Max length of DTMF digits. }, "loggingSettings": { # Define behaviors on logging. # Settings for logging. Settings for Dialogflow History, Contact Center messages, StackDriver logs, and speech logging. Exposed at the following levels: - Agent level. - "enableInteractionLogging": True or False, # If true, DF Interaction logging is currently enabled. - "enableStackdriverLogging": True or False, # If true, StackDriver logging is currently enabled. + "enableInteractionLogging": True or False, # Enables DF Interaction logging. + "enableStackdriverLogging": True or False, # Enables StackDriver logging. }, "speechSettings": { # Define behaviors of speech to text detection. # Settings for speech to text detection. Exposed at the following levels: - Agent level - Flow level - Page level - Parameter level "endpointerSensitivity": 42, # Sensitivity of the speech model that detects the end of speech. Scale from 0 to 100. @@ -346,8 +346,8 @@

Method Details

"maxDigits": 42, # Max length of DTMF digits. }, "loggingSettings": { # Define behaviors on logging. # Settings for logging. Settings for Dialogflow History, Contact Center messages, StackDriver logs, and speech logging. Exposed at the following levels: - Agent level. - "enableInteractionLogging": True or False, # If true, DF Interaction logging is currently enabled. - "enableStackdriverLogging": True or False, # If true, StackDriver logging is currently enabled. + "enableInteractionLogging": True or False, # Enables DF Interaction logging. + "enableStackdriverLogging": True or False, # Enables StackDriver logging. }, "speechSettings": { # Define behaviors of speech to text detection. # Settings for speech to text detection. Exposed at the following levels: - Agent level - Flow level - Page level - Parameter level "endpointerSensitivity": 42, # Sensitivity of the speech model that detects the end of speech. Scale from 0 to 100. @@ -518,8 +518,8 @@

Method Details

"maxDigits": 42, # Max length of DTMF digits. }, "loggingSettings": { # Define behaviors on logging. # Settings for logging. Settings for Dialogflow History, Contact Center messages, StackDriver logs, and speech logging. Exposed at the following levels: - Agent level. - "enableInteractionLogging": True or False, # If true, DF Interaction logging is currently enabled. - "enableStackdriverLogging": True or False, # If true, StackDriver logging is currently enabled. + "enableInteractionLogging": True or False, # Enables DF Interaction logging. + "enableStackdriverLogging": True or False, # Enables StackDriver logging. }, "speechSettings": { # Define behaviors of speech to text detection. # Settings for speech to text detection. Exposed at the following levels: - Agent level - Flow level - Page level - Parameter level "endpointerSensitivity": 42, # Sensitivity of the speech model that detects the end of speech. Scale from 0 to 100. @@ -679,8 +679,8 @@

Method Details

"maxDigits": 42, # Max length of DTMF digits. }, "loggingSettings": { # Define behaviors on logging. # Settings for logging. Settings for Dialogflow History, Contact Center messages, StackDriver logs, and speech logging. Exposed at the following levels: - Agent level. - "enableInteractionLogging": True or False, # If true, DF Interaction logging is currently enabled. - "enableStackdriverLogging": True or False, # If true, StackDriver logging is currently enabled. + "enableInteractionLogging": True or False, # Enables DF Interaction logging. + "enableStackdriverLogging": True or False, # Enables StackDriver logging. }, "speechSettings": { # Define behaviors of speech to text detection. # Settings for speech to text detection. Exposed at the following levels: - Agent level - Flow level - Page level - Parameter level "endpointerSensitivity": 42, # Sensitivity of the speech model that detects the end of speech. Scale from 0 to 100. @@ -712,8 +712,8 @@

Method Details

"maxDigits": 42, # Max length of DTMF digits. }, "loggingSettings": { # Define behaviors on logging. # Settings for logging. Settings for Dialogflow History, Contact Center messages, StackDriver logs, and speech logging. Exposed at the following levels: - Agent level. - "enableInteractionLogging": True or False, # If true, DF Interaction logging is currently enabled. - "enableStackdriverLogging": True or False, # If true, StackDriver logging is currently enabled. + "enableInteractionLogging": True or False, # Enables DF Interaction logging. + "enableStackdriverLogging": True or False, # Enables StackDriver logging. }, "speechSettings": { # Define behaviors of speech to text detection. # Settings for speech to text detection. Exposed at the following levels: - Agent level - Flow level - Page level - Parameter level "endpointerSensitivity": 42, # Sensitivity of the speech model that detects the end of speech. Scale from 0 to 100. @@ -872,8 +872,8 @@

Method Details

"maxDigits": 42, # Max length of DTMF digits. }, "loggingSettings": { # Define behaviors on logging. # Settings for logging. Settings for Dialogflow History, Contact Center messages, StackDriver logs, and speech logging. Exposed at the following levels: - Agent level. - "enableInteractionLogging": True or False, # If true, DF Interaction logging is currently enabled. - "enableStackdriverLogging": True or False, # If true, StackDriver logging is currently enabled. + "enableInteractionLogging": True or False, # Enables DF Interaction logging. + "enableStackdriverLogging": True or False, # Enables StackDriver logging. }, "speechSettings": { # Define behaviors of speech to text detection. # Settings for speech to text detection. Exposed at the following levels: - Agent level - Flow level - Page level - Parameter level "endpointerSensitivity": 42, # Sensitivity of the speech model that detects the end of speech. Scale from 0 to 100. @@ -1044,8 +1044,8 @@

Method Details

"maxDigits": 42, # Max length of DTMF digits. }, "loggingSettings": { # Define behaviors on logging. # Settings for logging. Settings for Dialogflow History, Contact Center messages, StackDriver logs, and speech logging. Exposed at the following levels: - Agent level. - "enableInteractionLogging": True or False, # If true, DF Interaction logging is currently enabled. - "enableStackdriverLogging": True or False, # If true, StackDriver logging is currently enabled. + "enableInteractionLogging": True or False, # Enables DF Interaction logging. + "enableStackdriverLogging": True or False, # Enables StackDriver logging. }, "speechSettings": { # Define behaviors of speech to text detection. # Settings for speech to text detection. Exposed at the following levels: - Agent level - Flow level - Page level - Parameter level "endpointerSensitivity": 42, # Sensitivity of the speech model that detects the end of speech. Scale from 0 to 100. @@ -1274,8 +1274,8 @@

Method Details

"maxDigits": 42, # Max length of DTMF digits. }, "loggingSettings": { # Define behaviors on logging. # Settings for logging. Settings for Dialogflow History, Contact Center messages, StackDriver logs, and speech logging. Exposed at the following levels: - Agent level. - "enableInteractionLogging": True or False, # If true, DF Interaction logging is currently enabled. - "enableStackdriverLogging": True or False, # If true, StackDriver logging is currently enabled. + "enableInteractionLogging": True or False, # Enables DF Interaction logging. + "enableStackdriverLogging": True or False, # Enables StackDriver logging. }, "speechSettings": { # Define behaviors of speech to text detection. # Settings for speech to text detection. Exposed at the following levels: - Agent level - Flow level - Page level - Parameter level "endpointerSensitivity": 42, # Sensitivity of the speech model that detects the end of speech. Scale from 0 to 100. @@ -1307,8 +1307,8 @@

Method Details

"maxDigits": 42, # Max length of DTMF digits. }, "loggingSettings": { # Define behaviors on logging. # Settings for logging. Settings for Dialogflow History, Contact Center messages, StackDriver logs, and speech logging. Exposed at the following levels: - Agent level. - "enableInteractionLogging": True or False, # If true, DF Interaction logging is currently enabled. - "enableStackdriverLogging": True or False, # If true, StackDriver logging is currently enabled. + "enableInteractionLogging": True or False, # Enables DF Interaction logging. + "enableStackdriverLogging": True or False, # Enables StackDriver logging. }, "speechSettings": { # Define behaviors of speech to text detection. # Settings for speech to text detection. Exposed at the following levels: - Agent level - Flow level - Page level - Parameter level "endpointerSensitivity": 42, # Sensitivity of the speech model that detects the end of speech. Scale from 0 to 100. @@ -1467,8 +1467,8 @@

Method Details

"maxDigits": 42, # Max length of DTMF digits. }, "loggingSettings": { # Define behaviors on logging. # Settings for logging. Settings for Dialogflow History, Contact Center messages, StackDriver logs, and speech logging. Exposed at the following levels: - Agent level. - "enableInteractionLogging": True or False, # If true, DF Interaction logging is currently enabled. - "enableStackdriverLogging": True or False, # If true, StackDriver logging is currently enabled. + "enableInteractionLogging": True or False, # Enables DF Interaction logging. + "enableStackdriverLogging": True or False, # Enables StackDriver logging. }, "speechSettings": { # Define behaviors of speech to text detection. # Settings for speech to text detection. Exposed at the following levels: - Agent level - Flow level - Page level - Parameter level "endpointerSensitivity": 42, # Sensitivity of the speech model that detects the end of speech. Scale from 0 to 100. @@ -1639,8 +1639,8 @@

Method Details

"maxDigits": 42, # Max length of DTMF digits. }, "loggingSettings": { # Define behaviors on logging. # Settings for logging. Settings for Dialogflow History, Contact Center messages, StackDriver logs, and speech logging. Exposed at the following levels: - Agent level. - "enableInteractionLogging": True or False, # If true, DF Interaction logging is currently enabled. - "enableStackdriverLogging": True or False, # If true, StackDriver logging is currently enabled. + "enableInteractionLogging": True or False, # Enables DF Interaction logging. + "enableStackdriverLogging": True or False, # Enables StackDriver logging. }, "speechSettings": { # Define behaviors of speech to text detection. # Settings for speech to text detection. Exposed at the following levels: - Agent level - Flow level - Page level - Parameter level "endpointerSensitivity": 42, # Sensitivity of the speech model that detects the end of speech. Scale from 0 to 100. @@ -1895,8 +1895,8 @@

Method Details

"maxDigits": 42, # Max length of DTMF digits. }, "loggingSettings": { # Define behaviors on logging. # Settings for logging. Settings for Dialogflow History, Contact Center messages, StackDriver logs, and speech logging. Exposed at the following levels: - Agent level. - "enableInteractionLogging": True or False, # If true, DF Interaction logging is currently enabled. - "enableStackdriverLogging": True or False, # If true, StackDriver logging is currently enabled. + "enableInteractionLogging": True or False, # Enables DF Interaction logging. + "enableStackdriverLogging": True or False, # Enables StackDriver logging. }, "speechSettings": { # Define behaviors of speech to text detection. # Settings for speech to text detection. Exposed at the following levels: - Agent level - Flow level - Page level - Parameter level "endpointerSensitivity": 42, # Sensitivity of the speech model that detects the end of speech. Scale from 0 to 100. @@ -1928,8 +1928,8 @@

Method Details

"maxDigits": 42, # Max length of DTMF digits. }, "loggingSettings": { # Define behaviors on logging. # Settings for logging. Settings for Dialogflow History, Contact Center messages, StackDriver logs, and speech logging. Exposed at the following levels: - Agent level. - "enableInteractionLogging": True or False, # If true, DF Interaction logging is currently enabled. - "enableStackdriverLogging": True or False, # If true, StackDriver logging is currently enabled. + "enableInteractionLogging": True or False, # Enables DF Interaction logging. + "enableStackdriverLogging": True or False, # Enables StackDriver logging. }, "speechSettings": { # Define behaviors of speech to text detection. # Settings for speech to text detection. Exposed at the following levels: - Agent level - Flow level - Page level - Parameter level "endpointerSensitivity": 42, # Sensitivity of the speech model that detects the end of speech. Scale from 0 to 100. @@ -2088,8 +2088,8 @@

Method Details

"maxDigits": 42, # Max length of DTMF digits. }, "loggingSettings": { # Define behaviors on logging. # Settings for logging. Settings for Dialogflow History, Contact Center messages, StackDriver logs, and speech logging. Exposed at the following levels: - Agent level. - "enableInteractionLogging": True or False, # If true, DF Interaction logging is currently enabled. - "enableStackdriverLogging": True or False, # If true, StackDriver logging is currently enabled. + "enableInteractionLogging": True or False, # Enables DF Interaction logging. + "enableStackdriverLogging": True or False, # Enables StackDriver logging. }, "speechSettings": { # Define behaviors of speech to text detection. # Settings for speech to text detection. Exposed at the following levels: - Agent level - Flow level - Page level - Parameter level "endpointerSensitivity": 42, # Sensitivity of the speech model that detects the end of speech. Scale from 0 to 100. @@ -2260,8 +2260,8 @@

Method Details

"maxDigits": 42, # Max length of DTMF digits. }, "loggingSettings": { # Define behaviors on logging. # Settings for logging. Settings for Dialogflow History, Contact Center messages, StackDriver logs, and speech logging. Exposed at the following levels: - Agent level. - "enableInteractionLogging": True or False, # If true, DF Interaction logging is currently enabled. - "enableStackdriverLogging": True or False, # If true, StackDriver logging is currently enabled. + "enableInteractionLogging": True or False, # Enables DF Interaction logging. + "enableStackdriverLogging": True or False, # Enables StackDriver logging. }, "speechSettings": { # Define behaviors of speech to text detection. # Settings for speech to text detection. Exposed at the following levels: - Agent level - Flow level - Page level - Parameter level "endpointerSensitivity": 42, # Sensitivity of the speech model that detects the end of speech. Scale from 0 to 100. @@ -2439,8 +2439,8 @@

Method Details

"maxDigits": 42, # Max length of DTMF digits. }, "loggingSettings": { # Define behaviors on logging. # Settings for logging. Settings for Dialogflow History, Contact Center messages, StackDriver logs, and speech logging. Exposed at the following levels: - Agent level. - "enableInteractionLogging": True or False, # If true, DF Interaction logging is currently enabled. - "enableStackdriverLogging": True or False, # If true, StackDriver logging is currently enabled. + "enableInteractionLogging": True or False, # Enables DF Interaction logging. + "enableStackdriverLogging": True or False, # Enables StackDriver logging. }, "speechSettings": { # Define behaviors of speech to text detection. # Settings for speech to text detection. Exposed at the following levels: - Agent level - Flow level - Page level - Parameter level "endpointerSensitivity": 42, # Sensitivity of the speech model that detects the end of speech. Scale from 0 to 100. @@ -2472,8 +2472,8 @@

Method Details

"maxDigits": 42, # Max length of DTMF digits. }, "loggingSettings": { # Define behaviors on logging. # Settings for logging. Settings for Dialogflow History, Contact Center messages, StackDriver logs, and speech logging. Exposed at the following levels: - Agent level. - "enableInteractionLogging": True or False, # If true, DF Interaction logging is currently enabled. - "enableStackdriverLogging": True or False, # If true, StackDriver logging is currently enabled. + "enableInteractionLogging": True or False, # Enables DF Interaction logging. + "enableStackdriverLogging": True or False, # Enables StackDriver logging. }, "speechSettings": { # Define behaviors of speech to text detection. # Settings for speech to text detection. Exposed at the following levels: - Agent level - Flow level - Page level - Parameter level "endpointerSensitivity": 42, # Sensitivity of the speech model that detects the end of speech. Scale from 0 to 100. @@ -2632,8 +2632,8 @@

Method Details

"maxDigits": 42, # Max length of DTMF digits. }, "loggingSettings": { # Define behaviors on logging. # Settings for logging. Settings for Dialogflow History, Contact Center messages, StackDriver logs, and speech logging. Exposed at the following levels: - Agent level. - "enableInteractionLogging": True or False, # If true, DF Interaction logging is currently enabled. - "enableStackdriverLogging": True or False, # If true, StackDriver logging is currently enabled. + "enableInteractionLogging": True or False, # Enables DF Interaction logging. + "enableStackdriverLogging": True or False, # Enables StackDriver logging. }, "speechSettings": { # Define behaviors of speech to text detection. # Settings for speech to text detection. Exposed at the following levels: - Agent level - Flow level - Page level - Parameter level "endpointerSensitivity": 42, # Sensitivity of the speech model that detects the end of speech. Scale from 0 to 100. @@ -2804,8 +2804,8 @@

Method Details

"maxDigits": 42, # Max length of DTMF digits. }, "loggingSettings": { # Define behaviors on logging. # Settings for logging. Settings for Dialogflow History, Contact Center messages, StackDriver logs, and speech logging. Exposed at the following levels: - Agent level. - "enableInteractionLogging": True or False, # If true, DF Interaction logging is currently enabled. - "enableStackdriverLogging": True or False, # If true, StackDriver logging is currently enabled. + "enableInteractionLogging": True or False, # Enables DF Interaction logging. + "enableStackdriverLogging": True or False, # Enables StackDriver logging. }, "speechSettings": { # Define behaviors of speech to text detection. # Settings for speech to text detection. Exposed at the following levels: - Agent level - Flow level - Page level - Parameter level "endpointerSensitivity": 42, # Sensitivity of the speech model that detects the end of speech. Scale from 0 to 100. @@ -2966,8 +2966,8 @@

Method Details

"maxDigits": 42, # Max length of DTMF digits. }, "loggingSettings": { # Define behaviors on logging. # Settings for logging. Settings for Dialogflow History, Contact Center messages, StackDriver logs, and speech logging. Exposed at the following levels: - Agent level. - "enableInteractionLogging": True or False, # If true, DF Interaction logging is currently enabled. - "enableStackdriverLogging": True or False, # If true, StackDriver logging is currently enabled. + "enableInteractionLogging": True or False, # Enables DF Interaction logging. + "enableStackdriverLogging": True or False, # Enables StackDriver logging. }, "speechSettings": { # Define behaviors of speech to text detection. # Settings for speech to text detection. Exposed at the following levels: - Agent level - Flow level - Page level - Parameter level "endpointerSensitivity": 42, # Sensitivity of the speech model that detects the end of speech. Scale from 0 to 100. @@ -2999,8 +2999,8 @@

Method Details

"maxDigits": 42, # Max length of DTMF digits. }, "loggingSettings": { # Define behaviors on logging. # Settings for logging. Settings for Dialogflow History, Contact Center messages, StackDriver logs, and speech logging. Exposed at the following levels: - Agent level. - "enableInteractionLogging": True or False, # If true, DF Interaction logging is currently enabled. - "enableStackdriverLogging": True or False, # If true, StackDriver logging is currently enabled. + "enableInteractionLogging": True or False, # Enables DF Interaction logging. + "enableStackdriverLogging": True or False, # Enables StackDriver logging. }, "speechSettings": { # Define behaviors of speech to text detection. # Settings for speech to text detection. Exposed at the following levels: - Agent level - Flow level - Page level - Parameter level "endpointerSensitivity": 42, # Sensitivity of the speech model that detects the end of speech. Scale from 0 to 100. @@ -3159,8 +3159,8 @@

Method Details

"maxDigits": 42, # Max length of DTMF digits. }, "loggingSettings": { # Define behaviors on logging. # Settings for logging. Settings for Dialogflow History, Contact Center messages, StackDriver logs, and speech logging. Exposed at the following levels: - Agent level. - "enableInteractionLogging": True or False, # If true, DF Interaction logging is currently enabled. - "enableStackdriverLogging": True or False, # If true, StackDriver logging is currently enabled. + "enableInteractionLogging": True or False, # Enables DF Interaction logging. + "enableStackdriverLogging": True or False, # Enables StackDriver logging. }, "speechSettings": { # Define behaviors of speech to text detection. # Settings for speech to text detection. Exposed at the following levels: - Agent level - Flow level - Page level - Parameter level "endpointerSensitivity": 42, # Sensitivity of the speech model that detects the end of speech. Scale from 0 to 100. @@ -3331,8 +3331,8 @@

Method Details

"maxDigits": 42, # Max length of DTMF digits. }, "loggingSettings": { # Define behaviors on logging. # Settings for logging. Settings for Dialogflow History, Contact Center messages, StackDriver logs, and speech logging. Exposed at the following levels: - Agent level. - "enableInteractionLogging": True or False, # If true, DF Interaction logging is currently enabled. - "enableStackdriverLogging": True or False, # If true, StackDriver logging is currently enabled. + "enableInteractionLogging": True or False, # Enables DF Interaction logging. + "enableStackdriverLogging": True or False, # Enables StackDriver logging. }, "speechSettings": { # Define behaviors of speech to text detection. # Settings for speech to text detection. Exposed at the following levels: - Agent level - Flow level - Page level - Parameter level "endpointerSensitivity": 42, # Sensitivity of the speech model that detects the end of speech. Scale from 0 to 100. diff --git a/docs/dyn/dialogflow_v3.projects.locations.agents.flows.pages.html b/docs/dyn/dialogflow_v3.projects.locations.agents.flows.pages.html index 39810987dd3..04bcb82fb12 100644 --- a/docs/dyn/dialogflow_v3.projects.locations.agents.flows.pages.html +++ b/docs/dyn/dialogflow_v3.projects.locations.agents.flows.pages.html @@ -123,8 +123,8 @@

Method Details

"maxDigits": 42, # Max length of DTMF digits. }, "loggingSettings": { # Define behaviors on logging. # Settings for logging. Settings for Dialogflow History, Contact Center messages, StackDriver logs, and speech logging. Exposed at the following levels: - Agent level. - "enableInteractionLogging": True or False, # If true, DF Interaction logging is currently enabled. - "enableStackdriverLogging": True or False, # If true, StackDriver logging is currently enabled. + "enableInteractionLogging": True or False, # Enables DF Interaction logging. + "enableStackdriverLogging": True or False, # Enables StackDriver logging. }, "speechSettings": { # Define behaviors of speech to text detection. # Settings for speech to text detection. Exposed at the following levels: - Agent level - Flow level - Page level - Parameter level "endpointerSensitivity": 42, # Sensitivity of the speech model that detects the end of speech. Scale from 0 to 100. @@ -150,8 +150,8 @@

Method Details

"maxDigits": 42, # Max length of DTMF digits. }, "loggingSettings": { # Define behaviors on logging. # Settings for logging. Settings for Dialogflow History, Contact Center messages, StackDriver logs, and speech logging. Exposed at the following levels: - Agent level. - "enableInteractionLogging": True or False, # If true, DF Interaction logging is currently enabled. - "enableStackdriverLogging": True or False, # If true, StackDriver logging is currently enabled. + "enableInteractionLogging": True or False, # Enables DF Interaction logging. + "enableStackdriverLogging": True or False, # Enables StackDriver logging. }, "speechSettings": { # Define behaviors of speech to text detection. # Settings for speech to text detection. Exposed at the following levels: - Agent level - Flow level - Page level - Parameter level "endpointerSensitivity": 42, # Sensitivity of the speech model that detects the end of speech. Scale from 0 to 100. @@ -304,8 +304,8 @@

Method Details

"maxDigits": 42, # Max length of DTMF digits. }, "loggingSettings": { # Define behaviors on logging. # Settings for logging. Settings for Dialogflow History, Contact Center messages, StackDriver logs, and speech logging. Exposed at the following levels: - Agent level. - "enableInteractionLogging": True or False, # If true, DF Interaction logging is currently enabled. - "enableStackdriverLogging": True or False, # If true, StackDriver logging is currently enabled. + "enableInteractionLogging": True or False, # Enables DF Interaction logging. + "enableStackdriverLogging": True or False, # Enables StackDriver logging. }, "speechSettings": { # Define behaviors of speech to text detection. # Settings for speech to text detection. Exposed at the following levels: - Agent level - Flow level - Page level - Parameter level "endpointerSensitivity": 42, # Sensitivity of the speech model that detects the end of speech. Scale from 0 to 100. @@ -456,8 +456,8 @@

Method Details

"maxDigits": 42, # Max length of DTMF digits. }, "loggingSettings": { # Define behaviors on logging. # Settings for logging. Settings for Dialogflow History, Contact Center messages, StackDriver logs, and speech logging. Exposed at the following levels: - Agent level. - "enableInteractionLogging": True or False, # If true, DF Interaction logging is currently enabled. - "enableStackdriverLogging": True or False, # If true, StackDriver logging is currently enabled. + "enableInteractionLogging": True or False, # Enables DF Interaction logging. + "enableStackdriverLogging": True or False, # Enables StackDriver logging. }, "speechSettings": { # Define behaviors of speech to text detection. # Settings for speech to text detection. Exposed at the following levels: - Agent level - Flow level - Page level - Parameter level "endpointerSensitivity": 42, # Sensitivity of the speech model that detects the end of speech. Scale from 0 to 100. @@ -485,8 +485,8 @@

Method Details

"maxDigits": 42, # Max length of DTMF digits. }, "loggingSettings": { # Define behaviors on logging. # Settings for logging. Settings for Dialogflow History, Contact Center messages, StackDriver logs, and speech logging. Exposed at the following levels: - Agent level. - "enableInteractionLogging": True or False, # If true, DF Interaction logging is currently enabled. - "enableStackdriverLogging": True or False, # If true, StackDriver logging is currently enabled. + "enableInteractionLogging": True or False, # Enables DF Interaction logging. + "enableStackdriverLogging": True or False, # Enables StackDriver logging. }, "speechSettings": { # Define behaviors of speech to text detection. # Settings for speech to text detection. Exposed at the following levels: - Agent level - Flow level - Page level - Parameter level "endpointerSensitivity": 42, # Sensitivity of the speech model that detects the end of speech. Scale from 0 to 100. @@ -639,8 +639,8 @@

Method Details

"maxDigits": 42, # Max length of DTMF digits. }, "loggingSettings": { # Define behaviors on logging. # Settings for logging. Settings for Dialogflow History, Contact Center messages, StackDriver logs, and speech logging. Exposed at the following levels: - Agent level. - "enableInteractionLogging": True or False, # If true, DF Interaction logging is currently enabled. - "enableStackdriverLogging": True or False, # If true, StackDriver logging is currently enabled. + "enableInteractionLogging": True or False, # Enables DF Interaction logging. + "enableStackdriverLogging": True or False, # Enables StackDriver logging. }, "speechSettings": { # Define behaviors of speech to text detection. # Settings for speech to text detection. Exposed at the following levels: - Agent level - Flow level - Page level - Parameter level "endpointerSensitivity": 42, # Sensitivity of the speech model that detects the end of speech. Scale from 0 to 100. @@ -806,8 +806,8 @@

Method Details

"maxDigits": 42, # Max length of DTMF digits. }, "loggingSettings": { # Define behaviors on logging. # Settings for logging. Settings for Dialogflow History, Contact Center messages, StackDriver logs, and speech logging. Exposed at the following levels: - Agent level. - "enableInteractionLogging": True or False, # If true, DF Interaction logging is currently enabled. - "enableStackdriverLogging": True or False, # If true, StackDriver logging is currently enabled. + "enableInteractionLogging": True or False, # Enables DF Interaction logging. + "enableStackdriverLogging": True or False, # Enables StackDriver logging. }, "speechSettings": { # Define behaviors of speech to text detection. # Settings for speech to text detection. Exposed at the following levels: - Agent level - Flow level - Page level - Parameter level "endpointerSensitivity": 42, # Sensitivity of the speech model that detects the end of speech. Scale from 0 to 100. @@ -967,8 +967,8 @@

Method Details

"maxDigits": 42, # Max length of DTMF digits. }, "loggingSettings": { # Define behaviors on logging. # Settings for logging. Settings for Dialogflow History, Contact Center messages, StackDriver logs, and speech logging. Exposed at the following levels: - Agent level. - "enableInteractionLogging": True or False, # If true, DF Interaction logging is currently enabled. - "enableStackdriverLogging": True or False, # If true, StackDriver logging is currently enabled. + "enableInteractionLogging": True or False, # Enables DF Interaction logging. + "enableStackdriverLogging": True or False, # Enables StackDriver logging. }, "speechSettings": { # Define behaviors of speech to text detection. # Settings for speech to text detection. Exposed at the following levels: - Agent level - Flow level - Page level - Parameter level "endpointerSensitivity": 42, # Sensitivity of the speech model that detects the end of speech. Scale from 0 to 100. @@ -1128,8 +1128,8 @@

Method Details

"maxDigits": 42, # Max length of DTMF digits. }, "loggingSettings": { # Define behaviors on logging. # Settings for logging. Settings for Dialogflow History, Contact Center messages, StackDriver logs, and speech logging. Exposed at the following levels: - Agent level. - "enableInteractionLogging": True or False, # If true, DF Interaction logging is currently enabled. - "enableStackdriverLogging": True or False, # If true, StackDriver logging is currently enabled. + "enableInteractionLogging": True or False, # Enables DF Interaction logging. + "enableStackdriverLogging": True or False, # Enables StackDriver logging. }, "speechSettings": { # Define behaviors of speech to text detection. # Settings for speech to text detection. Exposed at the following levels: - Agent level - Flow level - Page level - Parameter level "endpointerSensitivity": 42, # Sensitivity of the speech model that detects the end of speech. Scale from 0 to 100. @@ -1155,8 +1155,8 @@

Method Details

"maxDigits": 42, # Max length of DTMF digits. }, "loggingSettings": { # Define behaviors on logging. # Settings for logging. Settings for Dialogflow History, Contact Center messages, StackDriver logs, and speech logging. Exposed at the following levels: - Agent level. - "enableInteractionLogging": True or False, # If true, DF Interaction logging is currently enabled. - "enableStackdriverLogging": True or False, # If true, StackDriver logging is currently enabled. + "enableInteractionLogging": True or False, # Enables DF Interaction logging. + "enableStackdriverLogging": True or False, # Enables StackDriver logging. }, "speechSettings": { # Define behaviors of speech to text detection. # Settings for speech to text detection. Exposed at the following levels: - Agent level - Flow level - Page level - Parameter level "endpointerSensitivity": 42, # Sensitivity of the speech model that detects the end of speech. Scale from 0 to 100. @@ -1309,8 +1309,8 @@

Method Details

"maxDigits": 42, # Max length of DTMF digits. }, "loggingSettings": { # Define behaviors on logging. # Settings for logging. Settings for Dialogflow History, Contact Center messages, StackDriver logs, and speech logging. Exposed at the following levels: - Agent level. - "enableInteractionLogging": True or False, # If true, DF Interaction logging is currently enabled. - "enableStackdriverLogging": True or False, # If true, StackDriver logging is currently enabled. + "enableInteractionLogging": True or False, # Enables DF Interaction logging. + "enableStackdriverLogging": True or False, # Enables StackDriver logging. }, "speechSettings": { # Define behaviors of speech to text detection. # Settings for speech to text detection. Exposed at the following levels: - Agent level - Flow level - Page level - Parameter level "endpointerSensitivity": 42, # Sensitivity of the speech model that detects the end of speech. Scale from 0 to 100. @@ -1461,8 +1461,8 @@

Method Details

"maxDigits": 42, # Max length of DTMF digits. }, "loggingSettings": { # Define behaviors on logging. # Settings for logging. Settings for Dialogflow History, Contact Center messages, StackDriver logs, and speech logging. Exposed at the following levels: - Agent level. - "enableInteractionLogging": True or False, # If true, DF Interaction logging is currently enabled. - "enableStackdriverLogging": True or False, # If true, StackDriver logging is currently enabled. + "enableInteractionLogging": True or False, # Enables DF Interaction logging. + "enableStackdriverLogging": True or False, # Enables StackDriver logging. }, "speechSettings": { # Define behaviors of speech to text detection. # Settings for speech to text detection. Exposed at the following levels: - Agent level - Flow level - Page level - Parameter level "endpointerSensitivity": 42, # Sensitivity of the speech model that detects the end of speech. Scale from 0 to 100. @@ -1490,8 +1490,8 @@

Method Details

"maxDigits": 42, # Max length of DTMF digits. }, "loggingSettings": { # Define behaviors on logging. # Settings for logging. Settings for Dialogflow History, Contact Center messages, StackDriver logs, and speech logging. Exposed at the following levels: - Agent level. - "enableInteractionLogging": True or False, # If true, DF Interaction logging is currently enabled. - "enableStackdriverLogging": True or False, # If true, StackDriver logging is currently enabled. + "enableInteractionLogging": True or False, # Enables DF Interaction logging. + "enableStackdriverLogging": True or False, # Enables StackDriver logging. }, "speechSettings": { # Define behaviors of speech to text detection. # Settings for speech to text detection. Exposed at the following levels: - Agent level - Flow level - Page level - Parameter level "endpointerSensitivity": 42, # Sensitivity of the speech model that detects the end of speech. Scale from 0 to 100. @@ -1644,8 +1644,8 @@

Method Details

"maxDigits": 42, # Max length of DTMF digits. }, "loggingSettings": { # Define behaviors on logging. # Settings for logging. Settings for Dialogflow History, Contact Center messages, StackDriver logs, and speech logging. Exposed at the following levels: - Agent level. - "enableInteractionLogging": True or False, # If true, DF Interaction logging is currently enabled. - "enableStackdriverLogging": True or False, # If true, StackDriver logging is currently enabled. + "enableInteractionLogging": True or False, # Enables DF Interaction logging. + "enableStackdriverLogging": True or False, # Enables StackDriver logging. }, "speechSettings": { # Define behaviors of speech to text detection. # Settings for speech to text detection. Exposed at the following levels: - Agent level - Flow level - Page level - Parameter level "endpointerSensitivity": 42, # Sensitivity of the speech model that detects the end of speech. Scale from 0 to 100. @@ -1811,8 +1811,8 @@

Method Details

"maxDigits": 42, # Max length of DTMF digits. }, "loggingSettings": { # Define behaviors on logging. # Settings for logging. Settings for Dialogflow History, Contact Center messages, StackDriver logs, and speech logging. Exposed at the following levels: - Agent level. - "enableInteractionLogging": True or False, # If true, DF Interaction logging is currently enabled. - "enableStackdriverLogging": True or False, # If true, StackDriver logging is currently enabled. + "enableInteractionLogging": True or False, # Enables DF Interaction logging. + "enableStackdriverLogging": True or False, # Enables StackDriver logging. }, "speechSettings": { # Define behaviors of speech to text detection. # Settings for speech to text detection. Exposed at the following levels: - Agent level - Flow level - Page level - Parameter level "endpointerSensitivity": 42, # Sensitivity of the speech model that detects the end of speech. Scale from 0 to 100. @@ -1972,8 +1972,8 @@

Method Details

"maxDigits": 42, # Max length of DTMF digits. }, "loggingSettings": { # Define behaviors on logging. # Settings for logging. Settings for Dialogflow History, Contact Center messages, StackDriver logs, and speech logging. Exposed at the following levels: - Agent level. - "enableInteractionLogging": True or False, # If true, DF Interaction logging is currently enabled. - "enableStackdriverLogging": True or False, # If true, StackDriver logging is currently enabled. + "enableInteractionLogging": True or False, # Enables DF Interaction logging. + "enableStackdriverLogging": True or False, # Enables StackDriver logging. }, "speechSettings": { # Define behaviors of speech to text detection. # Settings for speech to text detection. Exposed at the following levels: - Agent level - Flow level - Page level - Parameter level "endpointerSensitivity": 42, # Sensitivity of the speech model that detects the end of speech. Scale from 0 to 100. @@ -2159,8 +2159,8 @@

Method Details

"maxDigits": 42, # Max length of DTMF digits. }, "loggingSettings": { # Define behaviors on logging. # Settings for logging. Settings for Dialogflow History, Contact Center messages, StackDriver logs, and speech logging. Exposed at the following levels: - Agent level. - "enableInteractionLogging": True or False, # If true, DF Interaction logging is currently enabled. - "enableStackdriverLogging": True or False, # If true, StackDriver logging is currently enabled. + "enableInteractionLogging": True or False, # Enables DF Interaction logging. + "enableStackdriverLogging": True or False, # Enables StackDriver logging. }, "speechSettings": { # Define behaviors of speech to text detection. # Settings for speech to text detection. Exposed at the following levels: - Agent level - Flow level - Page level - Parameter level "endpointerSensitivity": 42, # Sensitivity of the speech model that detects the end of speech. Scale from 0 to 100. @@ -2186,8 +2186,8 @@

Method Details

"maxDigits": 42, # Max length of DTMF digits. }, "loggingSettings": { # Define behaviors on logging. # Settings for logging. Settings for Dialogflow History, Contact Center messages, StackDriver logs, and speech logging. Exposed at the following levels: - Agent level. - "enableInteractionLogging": True or False, # If true, DF Interaction logging is currently enabled. - "enableStackdriverLogging": True or False, # If true, StackDriver logging is currently enabled. + "enableInteractionLogging": True or False, # Enables DF Interaction logging. + "enableStackdriverLogging": True or False, # Enables StackDriver logging. }, "speechSettings": { # Define behaviors of speech to text detection. # Settings for speech to text detection. Exposed at the following levels: - Agent level - Flow level - Page level - Parameter level "endpointerSensitivity": 42, # Sensitivity of the speech model that detects the end of speech. Scale from 0 to 100. @@ -2340,8 +2340,8 @@

Method Details

"maxDigits": 42, # Max length of DTMF digits. }, "loggingSettings": { # Define behaviors on logging. # Settings for logging. Settings for Dialogflow History, Contact Center messages, StackDriver logs, and speech logging. Exposed at the following levels: - Agent level. - "enableInteractionLogging": True or False, # If true, DF Interaction logging is currently enabled. - "enableStackdriverLogging": True or False, # If true, StackDriver logging is currently enabled. + "enableInteractionLogging": True or False, # Enables DF Interaction logging. + "enableStackdriverLogging": True or False, # Enables StackDriver logging. }, "speechSettings": { # Define behaviors of speech to text detection. # Settings for speech to text detection. Exposed at the following levels: - Agent level - Flow level - Page level - Parameter level "endpointerSensitivity": 42, # Sensitivity of the speech model that detects the end of speech. Scale from 0 to 100. @@ -2492,8 +2492,8 @@

Method Details

"maxDigits": 42, # Max length of DTMF digits. }, "loggingSettings": { # Define behaviors on logging. # Settings for logging. Settings for Dialogflow History, Contact Center messages, StackDriver logs, and speech logging. Exposed at the following levels: - Agent level. - "enableInteractionLogging": True or False, # If true, DF Interaction logging is currently enabled. - "enableStackdriverLogging": True or False, # If true, StackDriver logging is currently enabled. + "enableInteractionLogging": True or False, # Enables DF Interaction logging. + "enableStackdriverLogging": True or False, # Enables StackDriver logging. }, "speechSettings": { # Define behaviors of speech to text detection. # Settings for speech to text detection. Exposed at the following levels: - Agent level - Flow level - Page level - Parameter level "endpointerSensitivity": 42, # Sensitivity of the speech model that detects the end of speech. Scale from 0 to 100. @@ -2521,8 +2521,8 @@

Method Details

"maxDigits": 42, # Max length of DTMF digits. }, "loggingSettings": { # Define behaviors on logging. # Settings for logging. Settings for Dialogflow History, Contact Center messages, StackDriver logs, and speech logging. Exposed at the following levels: - Agent level. - "enableInteractionLogging": True or False, # If true, DF Interaction logging is currently enabled. - "enableStackdriverLogging": True or False, # If true, StackDriver logging is currently enabled. + "enableInteractionLogging": True or False, # Enables DF Interaction logging. + "enableStackdriverLogging": True or False, # Enables StackDriver logging. }, "speechSettings": { # Define behaviors of speech to text detection. # Settings for speech to text detection. Exposed at the following levels: - Agent level - Flow level - Page level - Parameter level "endpointerSensitivity": 42, # Sensitivity of the speech model that detects the end of speech. Scale from 0 to 100. @@ -2675,8 +2675,8 @@

Method Details

"maxDigits": 42, # Max length of DTMF digits. }, "loggingSettings": { # Define behaviors on logging. # Settings for logging. Settings for Dialogflow History, Contact Center messages, StackDriver logs, and speech logging. Exposed at the following levels: - Agent level. - "enableInteractionLogging": True or False, # If true, DF Interaction logging is currently enabled. - "enableStackdriverLogging": True or False, # If true, StackDriver logging is currently enabled. + "enableInteractionLogging": True or False, # Enables DF Interaction logging. + "enableStackdriverLogging": True or False, # Enables StackDriver logging. }, "speechSettings": { # Define behaviors of speech to text detection. # Settings for speech to text detection. Exposed at the following levels: - Agent level - Flow level - Page level - Parameter level "endpointerSensitivity": 42, # Sensitivity of the speech model that detects the end of speech. Scale from 0 to 100. @@ -2842,8 +2842,8 @@

Method Details

"maxDigits": 42, # Max length of DTMF digits. }, "loggingSettings": { # Define behaviors on logging. # Settings for logging. Settings for Dialogflow History, Contact Center messages, StackDriver logs, and speech logging. Exposed at the following levels: - Agent level. - "enableInteractionLogging": True or False, # If true, DF Interaction logging is currently enabled. - "enableStackdriverLogging": True or False, # If true, StackDriver logging is currently enabled. + "enableInteractionLogging": True or False, # Enables DF Interaction logging. + "enableStackdriverLogging": True or False, # Enables StackDriver logging. }, "speechSettings": { # Define behaviors of speech to text detection. # Settings for speech to text detection. Exposed at the following levels: - Agent level - Flow level - Page level - Parameter level "endpointerSensitivity": 42, # Sensitivity of the speech model that detects the end of speech. Scale from 0 to 100. @@ -3003,8 +3003,8 @@

Method Details

"maxDigits": 42, # Max length of DTMF digits. }, "loggingSettings": { # Define behaviors on logging. # Settings for logging. Settings for Dialogflow History, Contact Center messages, StackDriver logs, and speech logging. Exposed at the following levels: - Agent level. - "enableInteractionLogging": True or False, # If true, DF Interaction logging is currently enabled. - "enableStackdriverLogging": True or False, # If true, StackDriver logging is currently enabled. + "enableInteractionLogging": True or False, # Enables DF Interaction logging. + "enableStackdriverLogging": True or False, # Enables StackDriver logging. }, "speechSettings": { # Define behaviors of speech to text detection. # Settings for speech to text detection. Exposed at the following levels: - Agent level - Flow level - Page level - Parameter level "endpointerSensitivity": 42, # Sensitivity of the speech model that detects the end of speech. Scale from 0 to 100. @@ -3176,8 +3176,8 @@

Method Details

"maxDigits": 42, # Max length of DTMF digits. }, "loggingSettings": { # Define behaviors on logging. # Settings for logging. Settings for Dialogflow History, Contact Center messages, StackDriver logs, and speech logging. Exposed at the following levels: - Agent level. - "enableInteractionLogging": True or False, # If true, DF Interaction logging is currently enabled. - "enableStackdriverLogging": True or False, # If true, StackDriver logging is currently enabled. + "enableInteractionLogging": True or False, # Enables DF Interaction logging. + "enableStackdriverLogging": True or False, # Enables StackDriver logging. }, "speechSettings": { # Define behaviors of speech to text detection. # Settings for speech to text detection. Exposed at the following levels: - Agent level - Flow level - Page level - Parameter level "endpointerSensitivity": 42, # Sensitivity of the speech model that detects the end of speech. Scale from 0 to 100. @@ -3203,8 +3203,8 @@

Method Details

"maxDigits": 42, # Max length of DTMF digits. }, "loggingSettings": { # Define behaviors on logging. # Settings for logging. Settings for Dialogflow History, Contact Center messages, StackDriver logs, and speech logging. Exposed at the following levels: - Agent level. - "enableInteractionLogging": True or False, # If true, DF Interaction logging is currently enabled. - "enableStackdriverLogging": True or False, # If true, StackDriver logging is currently enabled. + "enableInteractionLogging": True or False, # Enables DF Interaction logging. + "enableStackdriverLogging": True or False, # Enables StackDriver logging. }, "speechSettings": { # Define behaviors of speech to text detection. # Settings for speech to text detection. Exposed at the following levels: - Agent level - Flow level - Page level - Parameter level "endpointerSensitivity": 42, # Sensitivity of the speech model that detects the end of speech. Scale from 0 to 100. @@ -3357,8 +3357,8 @@

Method Details

"maxDigits": 42, # Max length of DTMF digits. }, "loggingSettings": { # Define behaviors on logging. # Settings for logging. Settings for Dialogflow History, Contact Center messages, StackDriver logs, and speech logging. Exposed at the following levels: - Agent level. - "enableInteractionLogging": True or False, # If true, DF Interaction logging is currently enabled. - "enableStackdriverLogging": True or False, # If true, StackDriver logging is currently enabled. + "enableInteractionLogging": True or False, # Enables DF Interaction logging. + "enableStackdriverLogging": True or False, # Enables StackDriver logging. }, "speechSettings": { # Define behaviors of speech to text detection. # Settings for speech to text detection. Exposed at the following levels: - Agent level - Flow level - Page level - Parameter level "endpointerSensitivity": 42, # Sensitivity of the speech model that detects the end of speech. Scale from 0 to 100. @@ -3509,8 +3509,8 @@

Method Details

"maxDigits": 42, # Max length of DTMF digits. }, "loggingSettings": { # Define behaviors on logging. # Settings for logging. Settings for Dialogflow History, Contact Center messages, StackDriver logs, and speech logging. Exposed at the following levels: - Agent level. - "enableInteractionLogging": True or False, # If true, DF Interaction logging is currently enabled. - "enableStackdriverLogging": True or False, # If true, StackDriver logging is currently enabled. + "enableInteractionLogging": True or False, # Enables DF Interaction logging. + "enableStackdriverLogging": True or False, # Enables StackDriver logging. }, "speechSettings": { # Define behaviors of speech to text detection. # Settings for speech to text detection. Exposed at the following levels: - Agent level - Flow level - Page level - Parameter level "endpointerSensitivity": 42, # Sensitivity of the speech model that detects the end of speech. Scale from 0 to 100. @@ -3538,8 +3538,8 @@

Method Details

"maxDigits": 42, # Max length of DTMF digits. }, "loggingSettings": { # Define behaviors on logging. # Settings for logging. Settings for Dialogflow History, Contact Center messages, StackDriver logs, and speech logging. Exposed at the following levels: - Agent level. - "enableInteractionLogging": True or False, # If true, DF Interaction logging is currently enabled. - "enableStackdriverLogging": True or False, # If true, StackDriver logging is currently enabled. + "enableInteractionLogging": True or False, # Enables DF Interaction logging. + "enableStackdriverLogging": True or False, # Enables StackDriver logging. }, "speechSettings": { # Define behaviors of speech to text detection. # Settings for speech to text detection. Exposed at the following levels: - Agent level - Flow level - Page level - Parameter level "endpointerSensitivity": 42, # Sensitivity of the speech model that detects the end of speech. Scale from 0 to 100. @@ -3692,8 +3692,8 @@

Method Details

"maxDigits": 42, # Max length of DTMF digits. }, "loggingSettings": { # Define behaviors on logging. # Settings for logging. Settings for Dialogflow History, Contact Center messages, StackDriver logs, and speech logging. Exposed at the following levels: - Agent level. - "enableInteractionLogging": True or False, # If true, DF Interaction logging is currently enabled. - "enableStackdriverLogging": True or False, # If true, StackDriver logging is currently enabled. + "enableInteractionLogging": True or False, # Enables DF Interaction logging. + "enableStackdriverLogging": True or False, # Enables StackDriver logging. }, "speechSettings": { # Define behaviors of speech to text detection. # Settings for speech to text detection. Exposed at the following levels: - Agent level - Flow level - Page level - Parameter level "endpointerSensitivity": 42, # Sensitivity of the speech model that detects the end of speech. Scale from 0 to 100. @@ -3859,8 +3859,8 @@

Method Details

"maxDigits": 42, # Max length of DTMF digits. }, "loggingSettings": { # Define behaviors on logging. # Settings for logging. Settings for Dialogflow History, Contact Center messages, StackDriver logs, and speech logging. Exposed at the following levels: - Agent level. - "enableInteractionLogging": True or False, # If true, DF Interaction logging is currently enabled. - "enableStackdriverLogging": True or False, # If true, StackDriver logging is currently enabled. + "enableInteractionLogging": True or False, # Enables DF Interaction logging. + "enableStackdriverLogging": True or False, # Enables StackDriver logging. }, "speechSettings": { # Define behaviors of speech to text detection. # Settings for speech to text detection. Exposed at the following levels: - Agent level - Flow level - Page level - Parameter level "endpointerSensitivity": 42, # Sensitivity of the speech model that detects the end of speech. Scale from 0 to 100. @@ -4020,8 +4020,8 @@

Method Details

"maxDigits": 42, # Max length of DTMF digits. }, "loggingSettings": { # Define behaviors on logging. # Settings for logging. Settings for Dialogflow History, Contact Center messages, StackDriver logs, and speech logging. Exposed at the following levels: - Agent level. - "enableInteractionLogging": True or False, # If true, DF Interaction logging is currently enabled. - "enableStackdriverLogging": True or False, # If true, StackDriver logging is currently enabled. + "enableInteractionLogging": True or False, # Enables DF Interaction logging. + "enableStackdriverLogging": True or False, # Enables StackDriver logging. }, "speechSettings": { # Define behaviors of speech to text detection. # Settings for speech to text detection. Exposed at the following levels: - Agent level - Flow level - Page level - Parameter level "endpointerSensitivity": 42, # Sensitivity of the speech model that detects the end of speech. Scale from 0 to 100. @@ -4198,8 +4198,8 @@

Method Details

"maxDigits": 42, # Max length of DTMF digits. }, "loggingSettings": { # Define behaviors on logging. # Settings for logging. Settings for Dialogflow History, Contact Center messages, StackDriver logs, and speech logging. Exposed at the following levels: - Agent level. - "enableInteractionLogging": True or False, # If true, DF Interaction logging is currently enabled. - "enableStackdriverLogging": True or False, # If true, StackDriver logging is currently enabled. + "enableInteractionLogging": True or False, # Enables DF Interaction logging. + "enableStackdriverLogging": True or False, # Enables StackDriver logging. }, "speechSettings": { # Define behaviors of speech to text detection. # Settings for speech to text detection. Exposed at the following levels: - Agent level - Flow level - Page level - Parameter level "endpointerSensitivity": 42, # Sensitivity of the speech model that detects the end of speech. Scale from 0 to 100. @@ -4225,8 +4225,8 @@

Method Details

"maxDigits": 42, # Max length of DTMF digits. }, "loggingSettings": { # Define behaviors on logging. # Settings for logging. Settings for Dialogflow History, Contact Center messages, StackDriver logs, and speech logging. Exposed at the following levels: - Agent level. - "enableInteractionLogging": True or False, # If true, DF Interaction logging is currently enabled. - "enableStackdriverLogging": True or False, # If true, StackDriver logging is currently enabled. + "enableInteractionLogging": True or False, # Enables DF Interaction logging. + "enableStackdriverLogging": True or False, # Enables StackDriver logging. }, "speechSettings": { # Define behaviors of speech to text detection. # Settings for speech to text detection. Exposed at the following levels: - Agent level - Flow level - Page level - Parameter level "endpointerSensitivity": 42, # Sensitivity of the speech model that detects the end of speech. Scale from 0 to 100. @@ -4379,8 +4379,8 @@

Method Details

"maxDigits": 42, # Max length of DTMF digits. }, "loggingSettings": { # Define behaviors on logging. # Settings for logging. Settings for Dialogflow History, Contact Center messages, StackDriver logs, and speech logging. Exposed at the following levels: - Agent level. - "enableInteractionLogging": True or False, # If true, DF Interaction logging is currently enabled. - "enableStackdriverLogging": True or False, # If true, StackDriver logging is currently enabled. + "enableInteractionLogging": True or False, # Enables DF Interaction logging. + "enableStackdriverLogging": True or False, # Enables StackDriver logging. }, "speechSettings": { # Define behaviors of speech to text detection. # Settings for speech to text detection. Exposed at the following levels: - Agent level - Flow level - Page level - Parameter level "endpointerSensitivity": 42, # Sensitivity of the speech model that detects the end of speech. Scale from 0 to 100. @@ -4531,8 +4531,8 @@

Method Details

"maxDigits": 42, # Max length of DTMF digits. }, "loggingSettings": { # Define behaviors on logging. # Settings for logging. Settings for Dialogflow History, Contact Center messages, StackDriver logs, and speech logging. Exposed at the following levels: - Agent level. - "enableInteractionLogging": True or False, # If true, DF Interaction logging is currently enabled. - "enableStackdriverLogging": True or False, # If true, StackDriver logging is currently enabled. + "enableInteractionLogging": True or False, # Enables DF Interaction logging. + "enableStackdriverLogging": True or False, # Enables StackDriver logging. }, "speechSettings": { # Define behaviors of speech to text detection. # Settings for speech to text detection. Exposed at the following levels: - Agent level - Flow level - Page level - Parameter level "endpointerSensitivity": 42, # Sensitivity of the speech model that detects the end of speech. Scale from 0 to 100. @@ -4560,8 +4560,8 @@

Method Details

"maxDigits": 42, # Max length of DTMF digits. }, "loggingSettings": { # Define behaviors on logging. # Settings for logging. Settings for Dialogflow History, Contact Center messages, StackDriver logs, and speech logging. Exposed at the following levels: - Agent level. - "enableInteractionLogging": True or False, # If true, DF Interaction logging is currently enabled. - "enableStackdriverLogging": True or False, # If true, StackDriver logging is currently enabled. + "enableInteractionLogging": True or False, # Enables DF Interaction logging. + "enableStackdriverLogging": True or False, # Enables StackDriver logging. }, "speechSettings": { # Define behaviors of speech to text detection. # Settings for speech to text detection. Exposed at the following levels: - Agent level - Flow level - Page level - Parameter level "endpointerSensitivity": 42, # Sensitivity of the speech model that detects the end of speech. Scale from 0 to 100. @@ -4714,8 +4714,8 @@

Method Details

"maxDigits": 42, # Max length of DTMF digits. }, "loggingSettings": { # Define behaviors on logging. # Settings for logging. Settings for Dialogflow History, Contact Center messages, StackDriver logs, and speech logging. Exposed at the following levels: - Agent level. - "enableInteractionLogging": True or False, # If true, DF Interaction logging is currently enabled. - "enableStackdriverLogging": True or False, # If true, StackDriver logging is currently enabled. + "enableInteractionLogging": True or False, # Enables DF Interaction logging. + "enableStackdriverLogging": True or False, # Enables StackDriver logging. }, "speechSettings": { # Define behaviors of speech to text detection. # Settings for speech to text detection. Exposed at the following levels: - Agent level - Flow level - Page level - Parameter level "endpointerSensitivity": 42, # Sensitivity of the speech model that detects the end of speech. Scale from 0 to 100. @@ -4881,8 +4881,8 @@

Method Details

"maxDigits": 42, # Max length of DTMF digits. }, "loggingSettings": { # Define behaviors on logging. # Settings for logging. Settings for Dialogflow History, Contact Center messages, StackDriver logs, and speech logging. Exposed at the following levels: - Agent level. - "enableInteractionLogging": True or False, # If true, DF Interaction logging is currently enabled. - "enableStackdriverLogging": True or False, # If true, StackDriver logging is currently enabled. + "enableInteractionLogging": True or False, # Enables DF Interaction logging. + "enableStackdriverLogging": True or False, # Enables StackDriver logging. }, "speechSettings": { # Define behaviors of speech to text detection. # Settings for speech to text detection. Exposed at the following levels: - Agent level - Flow level - Page level - Parameter level "endpointerSensitivity": 42, # Sensitivity of the speech model that detects the end of speech. Scale from 0 to 100. @@ -5042,8 +5042,8 @@

Method Details

"maxDigits": 42, # Max length of DTMF digits. }, "loggingSettings": { # Define behaviors on logging. # Settings for logging. Settings for Dialogflow History, Contact Center messages, StackDriver logs, and speech logging. Exposed at the following levels: - Agent level. - "enableInteractionLogging": True or False, # If true, DF Interaction logging is currently enabled. - "enableStackdriverLogging": True or False, # If true, StackDriver logging is currently enabled. + "enableInteractionLogging": True or False, # Enables DF Interaction logging. + "enableStackdriverLogging": True or False, # Enables StackDriver logging. }, "speechSettings": { # Define behaviors of speech to text detection. # Settings for speech to text detection. Exposed at the following levels: - Agent level - Flow level - Page level - Parameter level "endpointerSensitivity": 42, # Sensitivity of the speech model that detects the end of speech. Scale from 0 to 100. @@ -5204,8 +5204,8 @@

Method Details

"maxDigits": 42, # Max length of DTMF digits. }, "loggingSettings": { # Define behaviors on logging. # Settings for logging. Settings for Dialogflow History, Contact Center messages, StackDriver logs, and speech logging. Exposed at the following levels: - Agent level. - "enableInteractionLogging": True or False, # If true, DF Interaction logging is currently enabled. - "enableStackdriverLogging": True or False, # If true, StackDriver logging is currently enabled. + "enableInteractionLogging": True or False, # Enables DF Interaction logging. + "enableStackdriverLogging": True or False, # Enables StackDriver logging. }, "speechSettings": { # Define behaviors of speech to text detection. # Settings for speech to text detection. Exposed at the following levels: - Agent level - Flow level - Page level - Parameter level "endpointerSensitivity": 42, # Sensitivity of the speech model that detects the end of speech. Scale from 0 to 100. @@ -5231,8 +5231,8 @@

Method Details

"maxDigits": 42, # Max length of DTMF digits. }, "loggingSettings": { # Define behaviors on logging. # Settings for logging. Settings for Dialogflow History, Contact Center messages, StackDriver logs, and speech logging. Exposed at the following levels: - Agent level. - "enableInteractionLogging": True or False, # If true, DF Interaction logging is currently enabled. - "enableStackdriverLogging": True or False, # If true, StackDriver logging is currently enabled. + "enableInteractionLogging": True or False, # Enables DF Interaction logging. + "enableStackdriverLogging": True or False, # Enables StackDriver logging. }, "speechSettings": { # Define behaviors of speech to text detection. # Settings for speech to text detection. Exposed at the following levels: - Agent level - Flow level - Page level - Parameter level "endpointerSensitivity": 42, # Sensitivity of the speech model that detects the end of speech. Scale from 0 to 100. @@ -5385,8 +5385,8 @@

Method Details

"maxDigits": 42, # Max length of DTMF digits. }, "loggingSettings": { # Define behaviors on logging. # Settings for logging. Settings for Dialogflow History, Contact Center messages, StackDriver logs, and speech logging. Exposed at the following levels: - Agent level. - "enableInteractionLogging": True or False, # If true, DF Interaction logging is currently enabled. - "enableStackdriverLogging": True or False, # If true, StackDriver logging is currently enabled. + "enableInteractionLogging": True or False, # Enables DF Interaction logging. + "enableStackdriverLogging": True or False, # Enables StackDriver logging. }, "speechSettings": { # Define behaviors of speech to text detection. # Settings for speech to text detection. Exposed at the following levels: - Agent level - Flow level - Page level - Parameter level "endpointerSensitivity": 42, # Sensitivity of the speech model that detects the end of speech. Scale from 0 to 100. @@ -5537,8 +5537,8 @@

Method Details

"maxDigits": 42, # Max length of DTMF digits. }, "loggingSettings": { # Define behaviors on logging. # Settings for logging. Settings for Dialogflow History, Contact Center messages, StackDriver logs, and speech logging. Exposed at the following levels: - Agent level. - "enableInteractionLogging": True or False, # If true, DF Interaction logging is currently enabled. - "enableStackdriverLogging": True or False, # If true, StackDriver logging is currently enabled. + "enableInteractionLogging": True or False, # Enables DF Interaction logging. + "enableStackdriverLogging": True or False, # Enables StackDriver logging. }, "speechSettings": { # Define behaviors of speech to text detection. # Settings for speech to text detection. Exposed at the following levels: - Agent level - Flow level - Page level - Parameter level "endpointerSensitivity": 42, # Sensitivity of the speech model that detects the end of speech. Scale from 0 to 100. @@ -5566,8 +5566,8 @@

Method Details

"maxDigits": 42, # Max length of DTMF digits. }, "loggingSettings": { # Define behaviors on logging. # Settings for logging. Settings for Dialogflow History, Contact Center messages, StackDriver logs, and speech logging. Exposed at the following levels: - Agent level. - "enableInteractionLogging": True or False, # If true, DF Interaction logging is currently enabled. - "enableStackdriverLogging": True or False, # If true, StackDriver logging is currently enabled. + "enableInteractionLogging": True or False, # Enables DF Interaction logging. + "enableStackdriverLogging": True or False, # Enables StackDriver logging. }, "speechSettings": { # Define behaviors of speech to text detection. # Settings for speech to text detection. Exposed at the following levels: - Agent level - Flow level - Page level - Parameter level "endpointerSensitivity": 42, # Sensitivity of the speech model that detects the end of speech. Scale from 0 to 100. @@ -5720,8 +5720,8 @@

Method Details

"maxDigits": 42, # Max length of DTMF digits. }, "loggingSettings": { # Define behaviors on logging. # Settings for logging. Settings for Dialogflow History, Contact Center messages, StackDriver logs, and speech logging. Exposed at the following levels: - Agent level. - "enableInteractionLogging": True or False, # If true, DF Interaction logging is currently enabled. - "enableStackdriverLogging": True or False, # If true, StackDriver logging is currently enabled. + "enableInteractionLogging": True or False, # Enables DF Interaction logging. + "enableStackdriverLogging": True or False, # Enables StackDriver logging. }, "speechSettings": { # Define behaviors of speech to text detection. # Settings for speech to text detection. Exposed at the following levels: - Agent level - Flow level - Page level - Parameter level "endpointerSensitivity": 42, # Sensitivity of the speech model that detects the end of speech. Scale from 0 to 100. @@ -5887,8 +5887,8 @@

Method Details

"maxDigits": 42, # Max length of DTMF digits. }, "loggingSettings": { # Define behaviors on logging. # Settings for logging. Settings for Dialogflow History, Contact Center messages, StackDriver logs, and speech logging. Exposed at the following levels: - Agent level. - "enableInteractionLogging": True or False, # If true, DF Interaction logging is currently enabled. - "enableStackdriverLogging": True or False, # If true, StackDriver logging is currently enabled. + "enableInteractionLogging": True or False, # Enables DF Interaction logging. + "enableStackdriverLogging": True or False, # Enables StackDriver logging. }, "speechSettings": { # Define behaviors of speech to text detection. # Settings for speech to text detection. Exposed at the following levels: - Agent level - Flow level - Page level - Parameter level "endpointerSensitivity": 42, # Sensitivity of the speech model that detects the end of speech. Scale from 0 to 100. @@ -6048,8 +6048,8 @@

Method Details

"maxDigits": 42, # Max length of DTMF digits. }, "loggingSettings": { # Define behaviors on logging. # Settings for logging. Settings for Dialogflow History, Contact Center messages, StackDriver logs, and speech logging. Exposed at the following levels: - Agent level. - "enableInteractionLogging": True or False, # If true, DF Interaction logging is currently enabled. - "enableStackdriverLogging": True or False, # If true, StackDriver logging is currently enabled. + "enableInteractionLogging": True or False, # Enables DF Interaction logging. + "enableStackdriverLogging": True or False, # Enables StackDriver logging. }, "speechSettings": { # Define behaviors of speech to text detection. # Settings for speech to text detection. Exposed at the following levels: - Agent level - Flow level - Page level - Parameter level "endpointerSensitivity": 42, # Sensitivity of the speech model that detects the end of speech. Scale from 0 to 100. diff --git a/docs/dyn/dialogflow_v3.projects.locations.agents.flows.transitionRouteGroups.html b/docs/dyn/dialogflow_v3.projects.locations.agents.flows.transitionRouteGroups.html index d14605b6cef..3eaeaa77c6c 100644 --- a/docs/dyn/dialogflow_v3.projects.locations.agents.flows.transitionRouteGroups.html +++ b/docs/dyn/dialogflow_v3.projects.locations.agents.flows.transitionRouteGroups.html @@ -134,8 +134,8 @@

Method Details

"maxDigits": 42, # Max length of DTMF digits. }, "loggingSettings": { # Define behaviors on logging. # Settings for logging. Settings for Dialogflow History, Contact Center messages, StackDriver logs, and speech logging. Exposed at the following levels: - Agent level. - "enableInteractionLogging": True or False, # If true, DF Interaction logging is currently enabled. - "enableStackdriverLogging": True or False, # If true, StackDriver logging is currently enabled. + "enableInteractionLogging": True or False, # Enables DF Interaction logging. + "enableStackdriverLogging": True or False, # Enables StackDriver logging. }, "speechSettings": { # Define behaviors of speech to text detection. # Settings for speech to text detection. Exposed at the following levels: - Agent level - Flow level - Page level - Parameter level "endpointerSensitivity": 42, # Sensitivity of the speech model that detects the end of speech. Scale from 0 to 100. @@ -306,8 +306,8 @@

Method Details

"maxDigits": 42, # Max length of DTMF digits. }, "loggingSettings": { # Define behaviors on logging. # Settings for logging. Settings for Dialogflow History, Contact Center messages, StackDriver logs, and speech logging. Exposed at the following levels: - Agent level. - "enableInteractionLogging": True or False, # If true, DF Interaction logging is currently enabled. - "enableStackdriverLogging": True or False, # If true, StackDriver logging is currently enabled. + "enableInteractionLogging": True or False, # Enables DF Interaction logging. + "enableStackdriverLogging": True or False, # Enables StackDriver logging. }, "speechSettings": { # Define behaviors of speech to text detection. # Settings for speech to text detection. Exposed at the following levels: - Agent level - Flow level - Page level - Parameter level "endpointerSensitivity": 42, # Sensitivity of the speech model that detects the end of speech. Scale from 0 to 100. @@ -504,8 +504,8 @@

Method Details

"maxDigits": 42, # Max length of DTMF digits. }, "loggingSettings": { # Define behaviors on logging. # Settings for logging. Settings for Dialogflow History, Contact Center messages, StackDriver logs, and speech logging. Exposed at the following levels: - Agent level. - "enableInteractionLogging": True or False, # If true, DF Interaction logging is currently enabled. - "enableStackdriverLogging": True or False, # If true, StackDriver logging is currently enabled. + "enableInteractionLogging": True or False, # Enables DF Interaction logging. + "enableStackdriverLogging": True or False, # Enables StackDriver logging. }, "speechSettings": { # Define behaviors of speech to text detection. # Settings for speech to text detection. Exposed at the following levels: - Agent level - Flow level - Page level - Parameter level "endpointerSensitivity": 42, # Sensitivity of the speech model that detects the end of speech. Scale from 0 to 100. @@ -688,8 +688,8 @@

Method Details

"maxDigits": 42, # Max length of DTMF digits. }, "loggingSettings": { # Define behaviors on logging. # Settings for logging. Settings for Dialogflow History, Contact Center messages, StackDriver logs, and speech logging. Exposed at the following levels: - Agent level. - "enableInteractionLogging": True or False, # If true, DF Interaction logging is currently enabled. - "enableStackdriverLogging": True or False, # If true, StackDriver logging is currently enabled. + "enableInteractionLogging": True or False, # Enables DF Interaction logging. + "enableStackdriverLogging": True or False, # Enables StackDriver logging. }, "speechSettings": { # Define behaviors of speech to text detection. # Settings for speech to text detection. Exposed at the following levels: - Agent level - Flow level - Page level - Parameter level "endpointerSensitivity": 42, # Sensitivity of the speech model that detects the end of speech. Scale from 0 to 100. @@ -877,8 +877,8 @@

Method Details

"maxDigits": 42, # Max length of DTMF digits. }, "loggingSettings": { # Define behaviors on logging. # Settings for logging. Settings for Dialogflow History, Contact Center messages, StackDriver logs, and speech logging. Exposed at the following levels: - Agent level. - "enableInteractionLogging": True or False, # If true, DF Interaction logging is currently enabled. - "enableStackdriverLogging": True or False, # If true, StackDriver logging is currently enabled. + "enableInteractionLogging": True or False, # Enables DF Interaction logging. + "enableStackdriverLogging": True or False, # Enables StackDriver logging. }, "speechSettings": { # Define behaviors of speech to text detection. # Settings for speech to text detection. Exposed at the following levels: - Agent level - Flow level - Page level - Parameter level "endpointerSensitivity": 42, # Sensitivity of the speech model that detects the end of speech. Scale from 0 to 100. @@ -1050,8 +1050,8 @@

Method Details

"maxDigits": 42, # Max length of DTMF digits. }, "loggingSettings": { # Define behaviors on logging. # Settings for logging. Settings for Dialogflow History, Contact Center messages, StackDriver logs, and speech logging. Exposed at the following levels: - Agent level. - "enableInteractionLogging": True or False, # If true, DF Interaction logging is currently enabled. - "enableStackdriverLogging": True or False, # If true, StackDriver logging is currently enabled. + "enableInteractionLogging": True or False, # Enables DF Interaction logging. + "enableStackdriverLogging": True or False, # Enables StackDriver logging. }, "speechSettings": { # Define behaviors of speech to text detection. # Settings for speech to text detection. Exposed at the following levels: - Agent level - Flow level - Page level - Parameter level "endpointerSensitivity": 42, # Sensitivity of the speech model that detects the end of speech. Scale from 0 to 100. diff --git a/docs/dyn/dialogflow_v3.projects.locations.agents.html b/docs/dyn/dialogflow_v3.projects.locations.agents.html index 1109c39c12f..c3a58cc1362 100644 --- a/docs/dyn/dialogflow_v3.projects.locations.agents.html +++ b/docs/dyn/dialogflow_v3.projects.locations.agents.html @@ -191,8 +191,8 @@

Method Details

"maxDigits": 42, # Max length of DTMF digits. }, "loggingSettings": { # Define behaviors on logging. # Settings for logging. Settings for Dialogflow History, Contact Center messages, StackDriver logs, and speech logging. Exposed at the following levels: - Agent level. - "enableInteractionLogging": True or False, # If true, DF Interaction logging is currently enabled. - "enableStackdriverLogging": True or False, # If true, StackDriver logging is currently enabled. + "enableInteractionLogging": True or False, # Enables DF Interaction logging. + "enableStackdriverLogging": True or False, # Enables StackDriver logging. }, "speechSettings": { # Define behaviors of speech to text detection. # Settings for speech to text detection. Exposed at the following levels: - Agent level - Flow level - Page level - Parameter level "endpointerSensitivity": 42, # Sensitivity of the speech model that detects the end of speech. Scale from 0 to 100. @@ -282,8 +282,8 @@

Method Details

"maxDigits": 42, # Max length of DTMF digits. }, "loggingSettings": { # Define behaviors on logging. # Settings for logging. Settings for Dialogflow History, Contact Center messages, StackDriver logs, and speech logging. Exposed at the following levels: - Agent level. - "enableInteractionLogging": True or False, # If true, DF Interaction logging is currently enabled. - "enableStackdriverLogging": True or False, # If true, StackDriver logging is currently enabled. + "enableInteractionLogging": True or False, # Enables DF Interaction logging. + "enableStackdriverLogging": True or False, # Enables StackDriver logging. }, "speechSettings": { # Define behaviors of speech to text detection. # Settings for speech to text detection. Exposed at the following levels: - Agent level - Flow level - Page level - Parameter level "endpointerSensitivity": 42, # Sensitivity of the speech model that detects the end of speech. Scale from 0 to 100. @@ -447,8 +447,8 @@

Method Details

"maxDigits": 42, # Max length of DTMF digits. }, "loggingSettings": { # Define behaviors on logging. # Settings for logging. Settings for Dialogflow History, Contact Center messages, StackDriver logs, and speech logging. Exposed at the following levels: - Agent level. - "enableInteractionLogging": True or False, # If true, DF Interaction logging is currently enabled. - "enableStackdriverLogging": True or False, # If true, StackDriver logging is currently enabled. + "enableInteractionLogging": True or False, # Enables DF Interaction logging. + "enableStackdriverLogging": True or False, # Enables StackDriver logging. }, "speechSettings": { # Define behaviors of speech to text detection. # Settings for speech to text detection. Exposed at the following levels: - Agent level - Flow level - Page level - Parameter level "endpointerSensitivity": 42, # Sensitivity of the speech model that detects the end of speech. Scale from 0 to 100. @@ -638,8 +638,8 @@

Method Details

"maxDigits": 42, # Max length of DTMF digits. }, "loggingSettings": { # Define behaviors on logging. # Settings for logging. Settings for Dialogflow History, Contact Center messages, StackDriver logs, and speech logging. Exposed at the following levels: - Agent level. - "enableInteractionLogging": True or False, # If true, DF Interaction logging is currently enabled. - "enableStackdriverLogging": True or False, # If true, StackDriver logging is currently enabled. + "enableInteractionLogging": True or False, # Enables DF Interaction logging. + "enableStackdriverLogging": True or False, # Enables StackDriver logging. }, "speechSettings": { # Define behaviors of speech to text detection. # Settings for speech to text detection. Exposed at the following levels: - Agent level - Flow level - Page level - Parameter level "endpointerSensitivity": 42, # Sensitivity of the speech model that detects the end of speech. Scale from 0 to 100. @@ -748,8 +748,8 @@

Method Details

"maxDigits": 42, # Max length of DTMF digits. }, "loggingSettings": { # Define behaviors on logging. # Settings for logging. Settings for Dialogflow History, Contact Center messages, StackDriver logs, and speech logging. Exposed at the following levels: - Agent level. - "enableInteractionLogging": True or False, # If true, DF Interaction logging is currently enabled. - "enableStackdriverLogging": True or False, # If true, StackDriver logging is currently enabled. + "enableInteractionLogging": True or False, # Enables DF Interaction logging. + "enableStackdriverLogging": True or False, # Enables StackDriver logging. }, "speechSettings": { # Define behaviors of speech to text detection. # Settings for speech to text detection. Exposed at the following levels: - Agent level - Flow level - Page level - Parameter level "endpointerSensitivity": 42, # Sensitivity of the speech model that detects the end of speech. Scale from 0 to 100. @@ -840,8 +840,8 @@

Method Details

"maxDigits": 42, # Max length of DTMF digits. }, "loggingSettings": { # Define behaviors on logging. # Settings for logging. Settings for Dialogflow History, Contact Center messages, StackDriver logs, and speech logging. Exposed at the following levels: - Agent level. - "enableInteractionLogging": True or False, # If true, DF Interaction logging is currently enabled. - "enableStackdriverLogging": True or False, # If true, StackDriver logging is currently enabled. + "enableInteractionLogging": True or False, # Enables DF Interaction logging. + "enableStackdriverLogging": True or False, # Enables StackDriver logging. }, "speechSettings": { # Define behaviors of speech to text detection. # Settings for speech to text detection. Exposed at the following levels: - Agent level - Flow level - Page level - Parameter level "endpointerSensitivity": 42, # Sensitivity of the speech model that detects the end of speech. Scale from 0 to 100. diff --git a/docs/dyn/dialogflow_v3.projects.locations.agents.sessions.html b/docs/dyn/dialogflow_v3.projects.locations.agents.sessions.html index 8c1fbf356ff..502eb2ab9cc 100644 --- a/docs/dyn/dialogflow_v3.projects.locations.agents.sessions.html +++ b/docs/dyn/dialogflow_v3.projects.locations.agents.sessions.html @@ -275,8 +275,8 @@

Method Details

"maxDigits": 42, # Max length of DTMF digits. }, "loggingSettings": { # Define behaviors on logging. # Settings for logging. Settings for Dialogflow History, Contact Center messages, StackDriver logs, and speech logging. Exposed at the following levels: - Agent level. - "enableInteractionLogging": True or False, # If true, DF Interaction logging is currently enabled. - "enableStackdriverLogging": True or False, # If true, StackDriver logging is currently enabled. + "enableInteractionLogging": True or False, # Enables DF Interaction logging. + "enableStackdriverLogging": True or False, # Enables StackDriver logging. }, "speechSettings": { # Define behaviors of speech to text detection. # Settings for speech to text detection. Exposed at the following levels: - Agent level - Flow level - Page level - Parameter level "endpointerSensitivity": 42, # Sensitivity of the speech model that detects the end of speech. Scale from 0 to 100. @@ -301,8 +301,8 @@

Method Details

"maxDigits": 42, # Max length of DTMF digits. }, "loggingSettings": { # Define behaviors on logging. # Settings for logging. Settings for Dialogflow History, Contact Center messages, StackDriver logs, and speech logging. Exposed at the following levels: - Agent level. - "enableInteractionLogging": True or False, # If true, DF Interaction logging is currently enabled. - "enableStackdriverLogging": True or False, # If true, StackDriver logging is currently enabled. + "enableInteractionLogging": True or False, # Enables DF Interaction logging. + "enableStackdriverLogging": True or False, # Enables StackDriver logging. }, "speechSettings": { # Define behaviors of speech to text detection. # Settings for speech to text detection. Exposed at the following levels: - Agent level - Flow level - Page level - Parameter level "endpointerSensitivity": 42, # Sensitivity of the speech model that detects the end of speech. Scale from 0 to 100. @@ -328,8 +328,8 @@

Method Details

"maxDigits": 42, # Max length of DTMF digits. }, "loggingSettings": { # Define behaviors on logging. # Settings for logging. Settings for Dialogflow History, Contact Center messages, StackDriver logs, and speech logging. Exposed at the following levels: - Agent level. - "enableInteractionLogging": True or False, # If true, DF Interaction logging is currently enabled. - "enableStackdriverLogging": True or False, # If true, StackDriver logging is currently enabled. + "enableInteractionLogging": True or False, # Enables DF Interaction logging. + "enableStackdriverLogging": True or False, # Enables StackDriver logging. }, "speechSettings": { # Define behaviors of speech to text detection. # Settings for speech to text detection. Exposed at the following levels: - Agent level - Flow level - Page level - Parameter level "endpointerSensitivity": 42, # Sensitivity of the speech model that detects the end of speech. Scale from 0 to 100. @@ -482,8 +482,8 @@

Method Details

"maxDigits": 42, # Max length of DTMF digits. }, "loggingSettings": { # Define behaviors on logging. # Settings for logging. Settings for Dialogflow History, Contact Center messages, StackDriver logs, and speech logging. Exposed at the following levels: - Agent level. - "enableInteractionLogging": True or False, # If true, DF Interaction logging is currently enabled. - "enableStackdriverLogging": True or False, # If true, StackDriver logging is currently enabled. + "enableInteractionLogging": True or False, # Enables DF Interaction logging. + "enableStackdriverLogging": True or False, # Enables StackDriver logging. }, "speechSettings": { # Define behaviors of speech to text detection. # Settings for speech to text detection. Exposed at the following levels: - Agent level - Flow level - Page level - Parameter level "endpointerSensitivity": 42, # Sensitivity of the speech model that detects the end of speech. Scale from 0 to 100. @@ -634,8 +634,8 @@

Method Details

"maxDigits": 42, # Max length of DTMF digits. }, "loggingSettings": { # Define behaviors on logging. # Settings for logging. Settings for Dialogflow History, Contact Center messages, StackDriver logs, and speech logging. Exposed at the following levels: - Agent level. - "enableInteractionLogging": True or False, # If true, DF Interaction logging is currently enabled. - "enableStackdriverLogging": True or False, # If true, StackDriver logging is currently enabled. + "enableInteractionLogging": True or False, # Enables DF Interaction logging. + "enableStackdriverLogging": True or False, # Enables StackDriver logging. }, "speechSettings": { # Define behaviors of speech to text detection. # Settings for speech to text detection. Exposed at the following levels: - Agent level - Flow level - Page level - Parameter level "endpointerSensitivity": 42, # Sensitivity of the speech model that detects the end of speech. Scale from 0 to 100. @@ -663,8 +663,8 @@

Method Details

"maxDigits": 42, # Max length of DTMF digits. }, "loggingSettings": { # Define behaviors on logging. # Settings for logging. Settings for Dialogflow History, Contact Center messages, StackDriver logs, and speech logging. Exposed at the following levels: - Agent level. - "enableInteractionLogging": True or False, # If true, DF Interaction logging is currently enabled. - "enableStackdriverLogging": True or False, # If true, StackDriver logging is currently enabled. + "enableInteractionLogging": True or False, # Enables DF Interaction logging. + "enableStackdriverLogging": True or False, # Enables StackDriver logging. }, "speechSettings": { # Define behaviors of speech to text detection. # Settings for speech to text detection. Exposed at the following levels: - Agent level - Flow level - Page level - Parameter level "endpointerSensitivity": 42, # Sensitivity of the speech model that detects the end of speech. Scale from 0 to 100. @@ -817,8 +817,8 @@

Method Details

"maxDigits": 42, # Max length of DTMF digits. }, "loggingSettings": { # Define behaviors on logging. # Settings for logging. Settings for Dialogflow History, Contact Center messages, StackDriver logs, and speech logging. Exposed at the following levels: - Agent level. - "enableInteractionLogging": True or False, # If true, DF Interaction logging is currently enabled. - "enableStackdriverLogging": True or False, # If true, StackDriver logging is currently enabled. + "enableInteractionLogging": True or False, # Enables DF Interaction logging. + "enableStackdriverLogging": True or False, # Enables StackDriver logging. }, "speechSettings": { # Define behaviors of speech to text detection. # Settings for speech to text detection. Exposed at the following levels: - Agent level - Flow level - Page level - Parameter level "endpointerSensitivity": 42, # Sensitivity of the speech model that detects the end of speech. Scale from 0 to 100. @@ -984,8 +984,8 @@

Method Details

"maxDigits": 42, # Max length of DTMF digits. }, "loggingSettings": { # Define behaviors on logging. # Settings for logging. Settings for Dialogflow History, Contact Center messages, StackDriver logs, and speech logging. Exposed at the following levels: - Agent level. - "enableInteractionLogging": True or False, # If true, DF Interaction logging is currently enabled. - "enableStackdriverLogging": True or False, # If true, StackDriver logging is currently enabled. + "enableInteractionLogging": True or False, # Enables DF Interaction logging. + "enableStackdriverLogging": True or False, # Enables StackDriver logging. }, "speechSettings": { # Define behaviors of speech to text detection. # Settings for speech to text detection. Exposed at the following levels: - Agent level - Flow level - Page level - Parameter level "endpointerSensitivity": 42, # Sensitivity of the speech model that detects the end of speech. Scale from 0 to 100. @@ -1145,8 +1145,8 @@

Method Details

"maxDigits": 42, # Max length of DTMF digits. }, "loggingSettings": { # Define behaviors on logging. # Settings for logging. Settings for Dialogflow History, Contact Center messages, StackDriver logs, and speech logging. Exposed at the following levels: - Agent level. - "enableInteractionLogging": True or False, # If true, DF Interaction logging is currently enabled. - "enableStackdriverLogging": True or False, # If true, StackDriver logging is currently enabled. + "enableInteractionLogging": True or False, # Enables DF Interaction logging. + "enableStackdriverLogging": True or False, # Enables StackDriver logging. }, "speechSettings": { # Define behaviors of speech to text detection. # Settings for speech to text detection. Exposed at the following levels: - Agent level - Flow level - Page level - Parameter level "endpointerSensitivity": 42, # Sensitivity of the speech model that detects the end of speech. Scale from 0 to 100. @@ -1703,8 +1703,8 @@

Method Details

"maxDigits": 42, # Max length of DTMF digits. }, "loggingSettings": { # Define behaviors on logging. # Settings for logging. Settings for Dialogflow History, Contact Center messages, StackDriver logs, and speech logging. Exposed at the following levels: - Agent level. - "enableInteractionLogging": True or False, # If true, DF Interaction logging is currently enabled. - "enableStackdriverLogging": True or False, # If true, StackDriver logging is currently enabled. + "enableInteractionLogging": True or False, # Enables DF Interaction logging. + "enableStackdriverLogging": True or False, # Enables StackDriver logging. }, "speechSettings": { # Define behaviors of speech to text detection. # Settings for speech to text detection. Exposed at the following levels: - Agent level - Flow level - Page level - Parameter level "endpointerSensitivity": 42, # Sensitivity of the speech model that detects the end of speech. Scale from 0 to 100. @@ -1729,8 +1729,8 @@

Method Details

"maxDigits": 42, # Max length of DTMF digits. }, "loggingSettings": { # Define behaviors on logging. # Settings for logging. Settings for Dialogflow History, Contact Center messages, StackDriver logs, and speech logging. Exposed at the following levels: - Agent level. - "enableInteractionLogging": True or False, # If true, DF Interaction logging is currently enabled. - "enableStackdriverLogging": True or False, # If true, StackDriver logging is currently enabled. + "enableInteractionLogging": True or False, # Enables DF Interaction logging. + "enableStackdriverLogging": True or False, # Enables StackDriver logging. }, "speechSettings": { # Define behaviors of speech to text detection. # Settings for speech to text detection. Exposed at the following levels: - Agent level - Flow level - Page level - Parameter level "endpointerSensitivity": 42, # Sensitivity of the speech model that detects the end of speech. Scale from 0 to 100. @@ -1756,8 +1756,8 @@

Method Details

"maxDigits": 42, # Max length of DTMF digits. }, "loggingSettings": { # Define behaviors on logging. # Settings for logging. Settings for Dialogflow History, Contact Center messages, StackDriver logs, and speech logging. Exposed at the following levels: - Agent level. - "enableInteractionLogging": True or False, # If true, DF Interaction logging is currently enabled. - "enableStackdriverLogging": True or False, # If true, StackDriver logging is currently enabled. + "enableInteractionLogging": True or False, # Enables DF Interaction logging. + "enableStackdriverLogging": True or False, # Enables StackDriver logging. }, "speechSettings": { # Define behaviors of speech to text detection. # Settings for speech to text detection. Exposed at the following levels: - Agent level - Flow level - Page level - Parameter level "endpointerSensitivity": 42, # Sensitivity of the speech model that detects the end of speech. Scale from 0 to 100. @@ -1910,8 +1910,8 @@

Method Details

"maxDigits": 42, # Max length of DTMF digits. }, "loggingSettings": { # Define behaviors on logging. # Settings for logging. Settings for Dialogflow History, Contact Center messages, StackDriver logs, and speech logging. Exposed at the following levels: - Agent level. - "enableInteractionLogging": True or False, # If true, DF Interaction logging is currently enabled. - "enableStackdriverLogging": True or False, # If true, StackDriver logging is currently enabled. + "enableInteractionLogging": True or False, # Enables DF Interaction logging. + "enableStackdriverLogging": True or False, # Enables StackDriver logging. }, "speechSettings": { # Define behaviors of speech to text detection. # Settings for speech to text detection. Exposed at the following levels: - Agent level - Flow level - Page level - Parameter level "endpointerSensitivity": 42, # Sensitivity of the speech model that detects the end of speech. Scale from 0 to 100. @@ -2062,8 +2062,8 @@

Method Details

"maxDigits": 42, # Max length of DTMF digits. }, "loggingSettings": { # Define behaviors on logging. # Settings for logging. Settings for Dialogflow History, Contact Center messages, StackDriver logs, and speech logging. Exposed at the following levels: - Agent level. - "enableInteractionLogging": True or False, # If true, DF Interaction logging is currently enabled. - "enableStackdriverLogging": True or False, # If true, StackDriver logging is currently enabled. + "enableInteractionLogging": True or False, # Enables DF Interaction logging. + "enableStackdriverLogging": True or False, # Enables StackDriver logging. }, "speechSettings": { # Define behaviors of speech to text detection. # Settings for speech to text detection. Exposed at the following levels: - Agent level - Flow level - Page level - Parameter level "endpointerSensitivity": 42, # Sensitivity of the speech model that detects the end of speech. Scale from 0 to 100. @@ -2091,8 +2091,8 @@

Method Details

"maxDigits": 42, # Max length of DTMF digits. }, "loggingSettings": { # Define behaviors on logging. # Settings for logging. Settings for Dialogflow History, Contact Center messages, StackDriver logs, and speech logging. Exposed at the following levels: - Agent level. - "enableInteractionLogging": True or False, # If true, DF Interaction logging is currently enabled. - "enableStackdriverLogging": True or False, # If true, StackDriver logging is currently enabled. + "enableInteractionLogging": True or False, # Enables DF Interaction logging. + "enableStackdriverLogging": True or False, # Enables StackDriver logging. }, "speechSettings": { # Define behaviors of speech to text detection. # Settings for speech to text detection. Exposed at the following levels: - Agent level - Flow level - Page level - Parameter level "endpointerSensitivity": 42, # Sensitivity of the speech model that detects the end of speech. Scale from 0 to 100. @@ -2245,8 +2245,8 @@

Method Details

"maxDigits": 42, # Max length of DTMF digits. }, "loggingSettings": { # Define behaviors on logging. # Settings for logging. Settings for Dialogflow History, Contact Center messages, StackDriver logs, and speech logging. Exposed at the following levels: - Agent level. - "enableInteractionLogging": True or False, # If true, DF Interaction logging is currently enabled. - "enableStackdriverLogging": True or False, # If true, StackDriver logging is currently enabled. + "enableInteractionLogging": True or False, # Enables DF Interaction logging. + "enableStackdriverLogging": True or False, # Enables StackDriver logging. }, "speechSettings": { # Define behaviors of speech to text detection. # Settings for speech to text detection. Exposed at the following levels: - Agent level - Flow level - Page level - Parameter level "endpointerSensitivity": 42, # Sensitivity of the speech model that detects the end of speech. Scale from 0 to 100. @@ -2412,8 +2412,8 @@

Method Details

"maxDigits": 42, # Max length of DTMF digits. }, "loggingSettings": { # Define behaviors on logging. # Settings for logging. Settings for Dialogflow History, Contact Center messages, StackDriver logs, and speech logging. Exposed at the following levels: - Agent level. - "enableInteractionLogging": True or False, # If true, DF Interaction logging is currently enabled. - "enableStackdriverLogging": True or False, # If true, StackDriver logging is currently enabled. + "enableInteractionLogging": True or False, # Enables DF Interaction logging. + "enableStackdriverLogging": True or False, # Enables StackDriver logging. }, "speechSettings": { # Define behaviors of speech to text detection. # Settings for speech to text detection. Exposed at the following levels: - Agent level - Flow level - Page level - Parameter level "endpointerSensitivity": 42, # Sensitivity of the speech model that detects the end of speech. Scale from 0 to 100. @@ -2573,8 +2573,8 @@

Method Details

"maxDigits": 42, # Max length of DTMF digits. }, "loggingSettings": { # Define behaviors on logging. # Settings for logging. Settings for Dialogflow History, Contact Center messages, StackDriver logs, and speech logging. Exposed at the following levels: - Agent level. - "enableInteractionLogging": True or False, # If true, DF Interaction logging is currently enabled. - "enableStackdriverLogging": True or False, # If true, StackDriver logging is currently enabled. + "enableInteractionLogging": True or False, # Enables DF Interaction logging. + "enableStackdriverLogging": True or False, # Enables StackDriver logging. }, "speechSettings": { # Define behaviors of speech to text detection. # Settings for speech to text detection. Exposed at the following levels: - Agent level - Flow level - Page level - Parameter level "endpointerSensitivity": 42, # Sensitivity of the speech model that detects the end of speech. Scale from 0 to 100. @@ -3056,8 +3056,8 @@

Method Details

"maxDigits": 42, # Max length of DTMF digits. }, "loggingSettings": { # Define behaviors on logging. # Settings for logging. Settings for Dialogflow History, Contact Center messages, StackDriver logs, and speech logging. Exposed at the following levels: - Agent level. - "enableInteractionLogging": True or False, # If true, DF Interaction logging is currently enabled. - "enableStackdriverLogging": True or False, # If true, StackDriver logging is currently enabled. + "enableInteractionLogging": True or False, # Enables DF Interaction logging. + "enableStackdriverLogging": True or False, # Enables StackDriver logging. }, "speechSettings": { # Define behaviors of speech to text detection. # Settings for speech to text detection. Exposed at the following levels: - Agent level - Flow level - Page level - Parameter level "endpointerSensitivity": 42, # Sensitivity of the speech model that detects the end of speech. Scale from 0 to 100. @@ -3083,8 +3083,8 @@

Method Details

"maxDigits": 42, # Max length of DTMF digits. }, "loggingSettings": { # Define behaviors on logging. # Settings for logging. Settings for Dialogflow History, Contact Center messages, StackDriver logs, and speech logging. Exposed at the following levels: - Agent level. - "enableInteractionLogging": True or False, # If true, DF Interaction logging is currently enabled. - "enableStackdriverLogging": True or False, # If true, StackDriver logging is currently enabled. + "enableInteractionLogging": True or False, # Enables DF Interaction logging. + "enableStackdriverLogging": True or False, # Enables StackDriver logging. }, "speechSettings": { # Define behaviors of speech to text detection. # Settings for speech to text detection. Exposed at the following levels: - Agent level - Flow level - Page level - Parameter level "endpointerSensitivity": 42, # Sensitivity of the speech model that detects the end of speech. Scale from 0 to 100. @@ -3237,8 +3237,8 @@

Method Details

"maxDigits": 42, # Max length of DTMF digits. }, "loggingSettings": { # Define behaviors on logging. # Settings for logging. Settings for Dialogflow History, Contact Center messages, StackDriver logs, and speech logging. Exposed at the following levels: - Agent level. - "enableInteractionLogging": True or False, # If true, DF Interaction logging is currently enabled. - "enableStackdriverLogging": True or False, # If true, StackDriver logging is currently enabled. + "enableInteractionLogging": True or False, # Enables DF Interaction logging. + "enableStackdriverLogging": True or False, # Enables StackDriver logging. }, "speechSettings": { # Define behaviors of speech to text detection. # Settings for speech to text detection. Exposed at the following levels: - Agent level - Flow level - Page level - Parameter level "endpointerSensitivity": 42, # Sensitivity of the speech model that detects the end of speech. Scale from 0 to 100. @@ -3389,8 +3389,8 @@

Method Details

"maxDigits": 42, # Max length of DTMF digits. }, "loggingSettings": { # Define behaviors on logging. # Settings for logging. Settings for Dialogflow History, Contact Center messages, StackDriver logs, and speech logging. Exposed at the following levels: - Agent level. - "enableInteractionLogging": True or False, # If true, DF Interaction logging is currently enabled. - "enableStackdriverLogging": True or False, # If true, StackDriver logging is currently enabled. + "enableInteractionLogging": True or False, # Enables DF Interaction logging. + "enableStackdriverLogging": True or False, # Enables StackDriver logging. }, "speechSettings": { # Define behaviors of speech to text detection. # Settings for speech to text detection. Exposed at the following levels: - Agent level - Flow level - Page level - Parameter level "endpointerSensitivity": 42, # Sensitivity of the speech model that detects the end of speech. Scale from 0 to 100. @@ -3418,8 +3418,8 @@

Method Details

"maxDigits": 42, # Max length of DTMF digits. }, "loggingSettings": { # Define behaviors on logging. # Settings for logging. Settings for Dialogflow History, Contact Center messages, StackDriver logs, and speech logging. Exposed at the following levels: - Agent level. - "enableInteractionLogging": True or False, # If true, DF Interaction logging is currently enabled. - "enableStackdriverLogging": True or False, # If true, StackDriver logging is currently enabled. + "enableInteractionLogging": True or False, # Enables DF Interaction logging. + "enableStackdriverLogging": True or False, # Enables StackDriver logging. }, "speechSettings": { # Define behaviors of speech to text detection. # Settings for speech to text detection. Exposed at the following levels: - Agent level - Flow level - Page level - Parameter level "endpointerSensitivity": 42, # Sensitivity of the speech model that detects the end of speech. Scale from 0 to 100. @@ -3572,8 +3572,8 @@

Method Details

"maxDigits": 42, # Max length of DTMF digits. }, "loggingSettings": { # Define behaviors on logging. # Settings for logging. Settings for Dialogflow History, Contact Center messages, StackDriver logs, and speech logging. Exposed at the following levels: - Agent level. - "enableInteractionLogging": True or False, # If true, DF Interaction logging is currently enabled. - "enableStackdriverLogging": True or False, # If true, StackDriver logging is currently enabled. + "enableInteractionLogging": True or False, # Enables DF Interaction logging. + "enableStackdriverLogging": True or False, # Enables StackDriver logging. }, "speechSettings": { # Define behaviors of speech to text detection. # Settings for speech to text detection. Exposed at the following levels: - Agent level - Flow level - Page level - Parameter level "endpointerSensitivity": 42, # Sensitivity of the speech model that detects the end of speech. Scale from 0 to 100. @@ -3739,8 +3739,8 @@

Method Details

"maxDigits": 42, # Max length of DTMF digits. }, "loggingSettings": { # Define behaviors on logging. # Settings for logging. Settings for Dialogflow History, Contact Center messages, StackDriver logs, and speech logging. Exposed at the following levels: - Agent level. - "enableInteractionLogging": True or False, # If true, DF Interaction logging is currently enabled. - "enableStackdriverLogging": True or False, # If true, StackDriver logging is currently enabled. + "enableInteractionLogging": True or False, # Enables DF Interaction logging. + "enableStackdriverLogging": True or False, # Enables StackDriver logging. }, "speechSettings": { # Define behaviors of speech to text detection. # Settings for speech to text detection. Exposed at the following levels: - Agent level - Flow level - Page level - Parameter level "endpointerSensitivity": 42, # Sensitivity of the speech model that detects the end of speech. Scale from 0 to 100. @@ -3900,8 +3900,8 @@

Method Details

"maxDigits": 42, # Max length of DTMF digits. }, "loggingSettings": { # Define behaviors on logging. # Settings for logging. Settings for Dialogflow History, Contact Center messages, StackDriver logs, and speech logging. Exposed at the following levels: - Agent level. - "enableInteractionLogging": True or False, # If true, DF Interaction logging is currently enabled. - "enableStackdriverLogging": True or False, # If true, StackDriver logging is currently enabled. + "enableInteractionLogging": True or False, # Enables DF Interaction logging. + "enableStackdriverLogging": True or False, # Enables StackDriver logging. }, "speechSettings": { # Define behaviors of speech to text detection. # Settings for speech to text detection. Exposed at the following levels: - Agent level - Flow level - Page level - Parameter level "endpointerSensitivity": 42, # Sensitivity of the speech model that detects the end of speech. Scale from 0 to 100. @@ -4258,8 +4258,8 @@

Method Details

"maxDigits": 42, # Max length of DTMF digits. }, "loggingSettings": { # Define behaviors on logging. # Settings for logging. Settings for Dialogflow History, Contact Center messages, StackDriver logs, and speech logging. Exposed at the following levels: - Agent level. - "enableInteractionLogging": True or False, # If true, DF Interaction logging is currently enabled. - "enableStackdriverLogging": True or False, # If true, StackDriver logging is currently enabled. + "enableInteractionLogging": True or False, # Enables DF Interaction logging. + "enableStackdriverLogging": True or False, # Enables StackDriver logging. }, "speechSettings": { # Define behaviors of speech to text detection. # Settings for speech to text detection. Exposed at the following levels: - Agent level - Flow level - Page level - Parameter level "endpointerSensitivity": 42, # Sensitivity of the speech model that detects the end of speech. Scale from 0 to 100. @@ -4284,8 +4284,8 @@

Method Details

"maxDigits": 42, # Max length of DTMF digits. }, "loggingSettings": { # Define behaviors on logging. # Settings for logging. Settings for Dialogflow History, Contact Center messages, StackDriver logs, and speech logging. Exposed at the following levels: - Agent level. - "enableInteractionLogging": True or False, # If true, DF Interaction logging is currently enabled. - "enableStackdriverLogging": True or False, # If true, StackDriver logging is currently enabled. + "enableInteractionLogging": True or False, # Enables DF Interaction logging. + "enableStackdriverLogging": True or False, # Enables StackDriver logging. }, "speechSettings": { # Define behaviors of speech to text detection. # Settings for speech to text detection. Exposed at the following levels: - Agent level - Flow level - Page level - Parameter level "endpointerSensitivity": 42, # Sensitivity of the speech model that detects the end of speech. Scale from 0 to 100. @@ -4311,8 +4311,8 @@

Method Details

"maxDigits": 42, # Max length of DTMF digits. }, "loggingSettings": { # Define behaviors on logging. # Settings for logging. Settings for Dialogflow History, Contact Center messages, StackDriver logs, and speech logging. Exposed at the following levels: - Agent level. - "enableInteractionLogging": True or False, # If true, DF Interaction logging is currently enabled. - "enableStackdriverLogging": True or False, # If true, StackDriver logging is currently enabled. + "enableInteractionLogging": True or False, # Enables DF Interaction logging. + "enableStackdriverLogging": True or False, # Enables StackDriver logging. }, "speechSettings": { # Define behaviors of speech to text detection. # Settings for speech to text detection. Exposed at the following levels: - Agent level - Flow level - Page level - Parameter level "endpointerSensitivity": 42, # Sensitivity of the speech model that detects the end of speech. Scale from 0 to 100. @@ -4465,8 +4465,8 @@

Method Details

"maxDigits": 42, # Max length of DTMF digits. }, "loggingSettings": { # Define behaviors on logging. # Settings for logging. Settings for Dialogflow History, Contact Center messages, StackDriver logs, and speech logging. Exposed at the following levels: - Agent level. - "enableInteractionLogging": True or False, # If true, DF Interaction logging is currently enabled. - "enableStackdriverLogging": True or False, # If true, StackDriver logging is currently enabled. + "enableInteractionLogging": True or False, # Enables DF Interaction logging. + "enableStackdriverLogging": True or False, # Enables StackDriver logging. }, "speechSettings": { # Define behaviors of speech to text detection. # Settings for speech to text detection. Exposed at the following levels: - Agent level - Flow level - Page level - Parameter level "endpointerSensitivity": 42, # Sensitivity of the speech model that detects the end of speech. Scale from 0 to 100. @@ -4617,8 +4617,8 @@

Method Details

"maxDigits": 42, # Max length of DTMF digits. }, "loggingSettings": { # Define behaviors on logging. # Settings for logging. Settings for Dialogflow History, Contact Center messages, StackDriver logs, and speech logging. Exposed at the following levels: - Agent level. - "enableInteractionLogging": True or False, # If true, DF Interaction logging is currently enabled. - "enableStackdriverLogging": True or False, # If true, StackDriver logging is currently enabled. + "enableInteractionLogging": True or False, # Enables DF Interaction logging. + "enableStackdriverLogging": True or False, # Enables StackDriver logging. }, "speechSettings": { # Define behaviors of speech to text detection. # Settings for speech to text detection. Exposed at the following levels: - Agent level - Flow level - Page level - Parameter level "endpointerSensitivity": 42, # Sensitivity of the speech model that detects the end of speech. Scale from 0 to 100. @@ -4646,8 +4646,8 @@

Method Details

"maxDigits": 42, # Max length of DTMF digits. }, "loggingSettings": { # Define behaviors on logging. # Settings for logging. Settings for Dialogflow History, Contact Center messages, StackDriver logs, and speech logging. Exposed at the following levels: - Agent level. - "enableInteractionLogging": True or False, # If true, DF Interaction logging is currently enabled. - "enableStackdriverLogging": True or False, # If true, StackDriver logging is currently enabled. + "enableInteractionLogging": True or False, # Enables DF Interaction logging. + "enableStackdriverLogging": True or False, # Enables StackDriver logging. }, "speechSettings": { # Define behaviors of speech to text detection. # Settings for speech to text detection. Exposed at the following levels: - Agent level - Flow level - Page level - Parameter level "endpointerSensitivity": 42, # Sensitivity of the speech model that detects the end of speech. Scale from 0 to 100. @@ -4800,8 +4800,8 @@

Method Details

"maxDigits": 42, # Max length of DTMF digits. }, "loggingSettings": { # Define behaviors on logging. # Settings for logging. Settings for Dialogflow History, Contact Center messages, StackDriver logs, and speech logging. Exposed at the following levels: - Agent level. - "enableInteractionLogging": True or False, # If true, DF Interaction logging is currently enabled. - "enableStackdriverLogging": True or False, # If true, StackDriver logging is currently enabled. + "enableInteractionLogging": True or False, # Enables DF Interaction logging. + "enableStackdriverLogging": True or False, # Enables StackDriver logging. }, "speechSettings": { # Define behaviors of speech to text detection. # Settings for speech to text detection. Exposed at the following levels: - Agent level - Flow level - Page level - Parameter level "endpointerSensitivity": 42, # Sensitivity of the speech model that detects the end of speech. Scale from 0 to 100. @@ -4967,8 +4967,8 @@

Method Details

"maxDigits": 42, # Max length of DTMF digits. }, "loggingSettings": { # Define behaviors on logging. # Settings for logging. Settings for Dialogflow History, Contact Center messages, StackDriver logs, and speech logging. Exposed at the following levels: - Agent level. - "enableInteractionLogging": True or False, # If true, DF Interaction logging is currently enabled. - "enableStackdriverLogging": True or False, # If true, StackDriver logging is currently enabled. + "enableInteractionLogging": True or False, # Enables DF Interaction logging. + "enableStackdriverLogging": True or False, # Enables StackDriver logging. }, "speechSettings": { # Define behaviors of speech to text detection. # Settings for speech to text detection. Exposed at the following levels: - Agent level - Flow level - Page level - Parameter level "endpointerSensitivity": 42, # Sensitivity of the speech model that detects the end of speech. Scale from 0 to 100. @@ -5128,8 +5128,8 @@

Method Details

"maxDigits": 42, # Max length of DTMF digits. }, "loggingSettings": { # Define behaviors on logging. # Settings for logging. Settings for Dialogflow History, Contact Center messages, StackDriver logs, and speech logging. Exposed at the following levels: - Agent level. - "enableInteractionLogging": True or False, # If true, DF Interaction logging is currently enabled. - "enableStackdriverLogging": True or False, # If true, StackDriver logging is currently enabled. + "enableInteractionLogging": True or False, # Enables DF Interaction logging. + "enableStackdriverLogging": True or False, # Enables StackDriver logging. }, "speechSettings": { # Define behaviors of speech to text detection. # Settings for speech to text detection. Exposed at the following levels: - Agent level - Flow level - Page level - Parameter level "endpointerSensitivity": 42, # Sensitivity of the speech model that detects the end of speech. Scale from 0 to 100. diff --git a/docs/dyn/dialogflow_v3.projects.locations.agents.testCases.html b/docs/dyn/dialogflow_v3.projects.locations.agents.testCases.html index 560362162d0..64486e551ff 100644 --- a/docs/dyn/dialogflow_v3.projects.locations.agents.testCases.html +++ b/docs/dyn/dialogflow_v3.projects.locations.agents.testCases.html @@ -248,8 +248,8 @@

Method Details

"maxDigits": 42, # Max length of DTMF digits. }, "loggingSettings": { # Define behaviors on logging. # Settings for logging. Settings for Dialogflow History, Contact Center messages, StackDriver logs, and speech logging. Exposed at the following levels: - Agent level. - "enableInteractionLogging": True or False, # If true, DF Interaction logging is currently enabled. - "enableStackdriverLogging": True or False, # If true, StackDriver logging is currently enabled. + "enableInteractionLogging": True or False, # Enables DF Interaction logging. + "enableStackdriverLogging": True or False, # Enables StackDriver logging. }, "speechSettings": { # Define behaviors of speech to text detection. # Settings for speech to text detection. Exposed at the following levels: - Agent level - Flow level - Page level - Parameter level "endpointerSensitivity": 42, # Sensitivity of the speech model that detects the end of speech. Scale from 0 to 100. @@ -409,8 +409,8 @@

Method Details

"maxDigits": 42, # Max length of DTMF digits. }, "loggingSettings": { # Define behaviors on logging. # Settings for logging. Settings for Dialogflow History, Contact Center messages, StackDriver logs, and speech logging. Exposed at the following levels: - Agent level. - "enableInteractionLogging": True or False, # If true, DF Interaction logging is currently enabled. - "enableStackdriverLogging": True or False, # If true, StackDriver logging is currently enabled. + "enableInteractionLogging": True or False, # Enables DF Interaction logging. + "enableStackdriverLogging": True or False, # Enables StackDriver logging. }, "speechSettings": { # Define behaviors of speech to text detection. # Settings for speech to text detection. Exposed at the following levels: - Agent level - Flow level - Page level - Parameter level "endpointerSensitivity": 42, # Sensitivity of the speech model that detects the end of speech. Scale from 0 to 100. @@ -573,8 +573,8 @@

Method Details

"maxDigits": 42, # Max length of DTMF digits. }, "loggingSettings": { # Define behaviors on logging. # Settings for logging. Settings for Dialogflow History, Contact Center messages, StackDriver logs, and speech logging. Exposed at the following levels: - Agent level. - "enableInteractionLogging": True or False, # If true, DF Interaction logging is currently enabled. - "enableStackdriverLogging": True or False, # If true, StackDriver logging is currently enabled. + "enableInteractionLogging": True or False, # Enables DF Interaction logging. + "enableStackdriverLogging": True or False, # Enables StackDriver logging. }, "speechSettings": { # Define behaviors of speech to text detection. # Settings for speech to text detection. Exposed at the following levels: - Agent level - Flow level - Page level - Parameter level "endpointerSensitivity": 42, # Sensitivity of the speech model that detects the end of speech. Scale from 0 to 100. @@ -724,8 +724,8 @@

Method Details

"maxDigits": 42, # Max length of DTMF digits. }, "loggingSettings": { # Define behaviors on logging. # Settings for logging. Settings for Dialogflow History, Contact Center messages, StackDriver logs, and speech logging. Exposed at the following levels: - Agent level. - "enableInteractionLogging": True or False, # If true, DF Interaction logging is currently enabled. - "enableStackdriverLogging": True or False, # If true, StackDriver logging is currently enabled. + "enableInteractionLogging": True or False, # Enables DF Interaction logging. + "enableStackdriverLogging": True or False, # Enables StackDriver logging. }, "speechSettings": { # Define behaviors of speech to text detection. # Settings for speech to text detection. Exposed at the following levels: - Agent level - Flow level - Page level - Parameter level "endpointerSensitivity": 42, # Sensitivity of the speech model that detects the end of speech. Scale from 0 to 100. @@ -757,8 +757,8 @@

Method Details

"maxDigits": 42, # Max length of DTMF digits. }, "loggingSettings": { # Define behaviors on logging. # Settings for logging. Settings for Dialogflow History, Contact Center messages, StackDriver logs, and speech logging. Exposed at the following levels: - Agent level. - "enableInteractionLogging": True or False, # If true, DF Interaction logging is currently enabled. - "enableStackdriverLogging": True or False, # If true, StackDriver logging is currently enabled. + "enableInteractionLogging": True or False, # Enables DF Interaction logging. + "enableStackdriverLogging": True or False, # Enables StackDriver logging. }, "speechSettings": { # Define behaviors of speech to text detection. # Settings for speech to text detection. Exposed at the following levels: - Agent level - Flow level - Page level - Parameter level "endpointerSensitivity": 42, # Sensitivity of the speech model that detects the end of speech. Scale from 0 to 100. @@ -917,8 +917,8 @@

Method Details

"maxDigits": 42, # Max length of DTMF digits. }, "loggingSettings": { # Define behaviors on logging. # Settings for logging. Settings for Dialogflow History, Contact Center messages, StackDriver logs, and speech logging. Exposed at the following levels: - Agent level. - "enableInteractionLogging": True or False, # If true, DF Interaction logging is currently enabled. - "enableStackdriverLogging": True or False, # If true, StackDriver logging is currently enabled. + "enableInteractionLogging": True or False, # Enables DF Interaction logging. + "enableStackdriverLogging": True or False, # Enables StackDriver logging. }, "speechSettings": { # Define behaviors of speech to text detection. # Settings for speech to text detection. Exposed at the following levels: - Agent level - Flow level - Page level - Parameter level "endpointerSensitivity": 42, # Sensitivity of the speech model that detects the end of speech. Scale from 0 to 100. @@ -1089,8 +1089,8 @@

Method Details

"maxDigits": 42, # Max length of DTMF digits. }, "loggingSettings": { # Define behaviors on logging. # Settings for logging. Settings for Dialogflow History, Contact Center messages, StackDriver logs, and speech logging. Exposed at the following levels: - Agent level. - "enableInteractionLogging": True or False, # If true, DF Interaction logging is currently enabled. - "enableStackdriverLogging": True or False, # If true, StackDriver logging is currently enabled. + "enableInteractionLogging": True or False, # Enables DF Interaction logging. + "enableStackdriverLogging": True or False, # Enables StackDriver logging. }, "speechSettings": { # Define behaviors of speech to text detection. # Settings for speech to text detection. Exposed at the following levels: - Agent level - Flow level - Page level - Parameter level "endpointerSensitivity": 42, # Sensitivity of the speech model that detects the end of speech. Scale from 0 to 100. @@ -1240,8 +1240,8 @@

Method Details

"maxDigits": 42, # Max length of DTMF digits. }, "loggingSettings": { # Define behaviors on logging. # Settings for logging. Settings for Dialogflow History, Contact Center messages, StackDriver logs, and speech logging. Exposed at the following levels: - Agent level. - "enableInteractionLogging": True or False, # If true, DF Interaction logging is currently enabled. - "enableStackdriverLogging": True or False, # If true, StackDriver logging is currently enabled. + "enableInteractionLogging": True or False, # Enables DF Interaction logging. + "enableStackdriverLogging": True or False, # Enables StackDriver logging. }, "speechSettings": { # Define behaviors of speech to text detection. # Settings for speech to text detection. Exposed at the following levels: - Agent level - Flow level - Page level - Parameter level "endpointerSensitivity": 42, # Sensitivity of the speech model that detects the end of speech. Scale from 0 to 100. @@ -1267,8 +1267,8 @@

Method Details

"maxDigits": 42, # Max length of DTMF digits. }, "loggingSettings": { # Define behaviors on logging. # Settings for logging. Settings for Dialogflow History, Contact Center messages, StackDriver logs, and speech logging. Exposed at the following levels: - Agent level. - "enableInteractionLogging": True or False, # If true, DF Interaction logging is currently enabled. - "enableStackdriverLogging": True or False, # If true, StackDriver logging is currently enabled. + "enableInteractionLogging": True or False, # Enables DF Interaction logging. + "enableStackdriverLogging": True or False, # Enables StackDriver logging. }, "speechSettings": { # Define behaviors of speech to text detection. # Settings for speech to text detection. Exposed at the following levels: - Agent level - Flow level - Page level - Parameter level "endpointerSensitivity": 42, # Sensitivity of the speech model that detects the end of speech. Scale from 0 to 100. @@ -1421,8 +1421,8 @@

Method Details

"maxDigits": 42, # Max length of DTMF digits. }, "loggingSettings": { # Define behaviors on logging. # Settings for logging. Settings for Dialogflow History, Contact Center messages, StackDriver logs, and speech logging. Exposed at the following levels: - Agent level. - "enableInteractionLogging": True or False, # If true, DF Interaction logging is currently enabled. - "enableStackdriverLogging": True or False, # If true, StackDriver logging is currently enabled. + "enableInteractionLogging": True or False, # Enables DF Interaction logging. + "enableStackdriverLogging": True or False, # Enables StackDriver logging. }, "speechSettings": { # Define behaviors of speech to text detection. # Settings for speech to text detection. Exposed at the following levels: - Agent level - Flow level - Page level - Parameter level "endpointerSensitivity": 42, # Sensitivity of the speech model that detects the end of speech. Scale from 0 to 100. @@ -1573,8 +1573,8 @@

Method Details

"maxDigits": 42, # Max length of DTMF digits. }, "loggingSettings": { # Define behaviors on logging. # Settings for logging. Settings for Dialogflow History, Contact Center messages, StackDriver logs, and speech logging. Exposed at the following levels: - Agent level. - "enableInteractionLogging": True or False, # If true, DF Interaction logging is currently enabled. - "enableStackdriverLogging": True or False, # If true, StackDriver logging is currently enabled. + "enableInteractionLogging": True or False, # Enables DF Interaction logging. + "enableStackdriverLogging": True or False, # Enables StackDriver logging. }, "speechSettings": { # Define behaviors of speech to text detection. # Settings for speech to text detection. Exposed at the following levels: - Agent level - Flow level - Page level - Parameter level "endpointerSensitivity": 42, # Sensitivity of the speech model that detects the end of speech. Scale from 0 to 100. @@ -1602,8 +1602,8 @@

Method Details

"maxDigits": 42, # Max length of DTMF digits. }, "loggingSettings": { # Define behaviors on logging. # Settings for logging. Settings for Dialogflow History, Contact Center messages, StackDriver logs, and speech logging. Exposed at the following levels: - Agent level. - "enableInteractionLogging": True or False, # If true, DF Interaction logging is currently enabled. - "enableStackdriverLogging": True or False, # If true, StackDriver logging is currently enabled. + "enableInteractionLogging": True or False, # Enables DF Interaction logging. + "enableStackdriverLogging": True or False, # Enables StackDriver logging. }, "speechSettings": { # Define behaviors of speech to text detection. # Settings for speech to text detection. Exposed at the following levels: - Agent level - Flow level - Page level - Parameter level "endpointerSensitivity": 42, # Sensitivity of the speech model that detects the end of speech. Scale from 0 to 100. @@ -1756,8 +1756,8 @@

Method Details

"maxDigits": 42, # Max length of DTMF digits. }, "loggingSettings": { # Define behaviors on logging. # Settings for logging. Settings for Dialogflow History, Contact Center messages, StackDriver logs, and speech logging. Exposed at the following levels: - Agent level. - "enableInteractionLogging": True or False, # If true, DF Interaction logging is currently enabled. - "enableStackdriverLogging": True or False, # If true, StackDriver logging is currently enabled. + "enableInteractionLogging": True or False, # Enables DF Interaction logging. + "enableStackdriverLogging": True or False, # Enables StackDriver logging. }, "speechSettings": { # Define behaviors of speech to text detection. # Settings for speech to text detection. Exposed at the following levels: - Agent level - Flow level - Page level - Parameter level "endpointerSensitivity": 42, # Sensitivity of the speech model that detects the end of speech. Scale from 0 to 100. @@ -1923,8 +1923,8 @@

Method Details

"maxDigits": 42, # Max length of DTMF digits. }, "loggingSettings": { # Define behaviors on logging. # Settings for logging. Settings for Dialogflow History, Contact Center messages, StackDriver logs, and speech logging. Exposed at the following levels: - Agent level. - "enableInteractionLogging": True or False, # If true, DF Interaction logging is currently enabled. - "enableStackdriverLogging": True or False, # If true, StackDriver logging is currently enabled. + "enableInteractionLogging": True or False, # Enables DF Interaction logging. + "enableStackdriverLogging": True or False, # Enables StackDriver logging. }, "speechSettings": { # Define behaviors of speech to text detection. # Settings for speech to text detection. Exposed at the following levels: - Agent level - Flow level - Page level - Parameter level "endpointerSensitivity": 42, # Sensitivity of the speech model that detects the end of speech. Scale from 0 to 100. @@ -2084,8 +2084,8 @@

Method Details

"maxDigits": 42, # Max length of DTMF digits. }, "loggingSettings": { # Define behaviors on logging. # Settings for logging. Settings for Dialogflow History, Contact Center messages, StackDriver logs, and speech logging. Exposed at the following levels: - Agent level. - "enableInteractionLogging": True or False, # If true, DF Interaction logging is currently enabled. - "enableStackdriverLogging": True or False, # If true, StackDriver logging is currently enabled. + "enableInteractionLogging": True or False, # Enables DF Interaction logging. + "enableStackdriverLogging": True or False, # Enables StackDriver logging. }, "speechSettings": { # Define behaviors of speech to text detection. # Settings for speech to text detection. Exposed at the following levels: - Agent level - Flow level - Page level - Parameter level "endpointerSensitivity": 42, # Sensitivity of the speech model that detects the end of speech. Scale from 0 to 100. @@ -2237,8 +2237,8 @@

Method Details

"maxDigits": 42, # Max length of DTMF digits. }, "loggingSettings": { # Define behaviors on logging. # Settings for logging. Settings for Dialogflow History, Contact Center messages, StackDriver logs, and speech logging. Exposed at the following levels: - Agent level. - "enableInteractionLogging": True or False, # If true, DF Interaction logging is currently enabled. - "enableStackdriverLogging": True or False, # If true, StackDriver logging is currently enabled. + "enableInteractionLogging": True or False, # Enables DF Interaction logging. + "enableStackdriverLogging": True or False, # Enables StackDriver logging. }, "speechSettings": { # Define behaviors of speech to text detection. # Settings for speech to text detection. Exposed at the following levels: - Agent level - Flow level - Page level - Parameter level "endpointerSensitivity": 42, # Sensitivity of the speech model that detects the end of speech. Scale from 0 to 100. @@ -2270,8 +2270,8 @@

Method Details

"maxDigits": 42, # Max length of DTMF digits. }, "loggingSettings": { # Define behaviors on logging. # Settings for logging. Settings for Dialogflow History, Contact Center messages, StackDriver logs, and speech logging. Exposed at the following levels: - Agent level. - "enableInteractionLogging": True or False, # If true, DF Interaction logging is currently enabled. - "enableStackdriverLogging": True or False, # If true, StackDriver logging is currently enabled. + "enableInteractionLogging": True or False, # Enables DF Interaction logging. + "enableStackdriverLogging": True or False, # Enables StackDriver logging. }, "speechSettings": { # Define behaviors of speech to text detection. # Settings for speech to text detection. Exposed at the following levels: - Agent level - Flow level - Page level - Parameter level "endpointerSensitivity": 42, # Sensitivity of the speech model that detects the end of speech. Scale from 0 to 100. @@ -2430,8 +2430,8 @@

Method Details

"maxDigits": 42, # Max length of DTMF digits. }, "loggingSettings": { # Define behaviors on logging. # Settings for logging. Settings for Dialogflow History, Contact Center messages, StackDriver logs, and speech logging. Exposed at the following levels: - Agent level. - "enableInteractionLogging": True or False, # If true, DF Interaction logging is currently enabled. - "enableStackdriverLogging": True or False, # If true, StackDriver logging is currently enabled. + "enableInteractionLogging": True or False, # Enables DF Interaction logging. + "enableStackdriverLogging": True or False, # Enables StackDriver logging. }, "speechSettings": { # Define behaviors of speech to text detection. # Settings for speech to text detection. Exposed at the following levels: - Agent level - Flow level - Page level - Parameter level "endpointerSensitivity": 42, # Sensitivity of the speech model that detects the end of speech. Scale from 0 to 100. @@ -2602,8 +2602,8 @@

Method Details

"maxDigits": 42, # Max length of DTMF digits. }, "loggingSettings": { # Define behaviors on logging. # Settings for logging. Settings for Dialogflow History, Contact Center messages, StackDriver logs, and speech logging. Exposed at the following levels: - Agent level. - "enableInteractionLogging": True or False, # If true, DF Interaction logging is currently enabled. - "enableStackdriverLogging": True or False, # If true, StackDriver logging is currently enabled. + "enableInteractionLogging": True or False, # Enables DF Interaction logging. + "enableStackdriverLogging": True or False, # Enables StackDriver logging. }, "speechSettings": { # Define behaviors of speech to text detection. # Settings for speech to text detection. Exposed at the following levels: - Agent level - Flow level - Page level - Parameter level "endpointerSensitivity": 42, # Sensitivity of the speech model that detects the end of speech. Scale from 0 to 100. @@ -2753,8 +2753,8 @@

Method Details

"maxDigits": 42, # Max length of DTMF digits. }, "loggingSettings": { # Define behaviors on logging. # Settings for logging. Settings for Dialogflow History, Contact Center messages, StackDriver logs, and speech logging. Exposed at the following levels: - Agent level. - "enableInteractionLogging": True or False, # If true, DF Interaction logging is currently enabled. - "enableStackdriverLogging": True or False, # If true, StackDriver logging is currently enabled. + "enableInteractionLogging": True or False, # Enables DF Interaction logging. + "enableStackdriverLogging": True or False, # Enables StackDriver logging. }, "speechSettings": { # Define behaviors of speech to text detection. # Settings for speech to text detection. Exposed at the following levels: - Agent level - Flow level - Page level - Parameter level "endpointerSensitivity": 42, # Sensitivity of the speech model that detects the end of speech. Scale from 0 to 100. @@ -2780,8 +2780,8 @@

Method Details

"maxDigits": 42, # Max length of DTMF digits. }, "loggingSettings": { # Define behaviors on logging. # Settings for logging. Settings for Dialogflow History, Contact Center messages, StackDriver logs, and speech logging. Exposed at the following levels: - Agent level. - "enableInteractionLogging": True or False, # If true, DF Interaction logging is currently enabled. - "enableStackdriverLogging": True or False, # If true, StackDriver logging is currently enabled. + "enableInteractionLogging": True or False, # Enables DF Interaction logging. + "enableStackdriverLogging": True or False, # Enables StackDriver logging. }, "speechSettings": { # Define behaviors of speech to text detection. # Settings for speech to text detection. Exposed at the following levels: - Agent level - Flow level - Page level - Parameter level "endpointerSensitivity": 42, # Sensitivity of the speech model that detects the end of speech. Scale from 0 to 100. @@ -2934,8 +2934,8 @@

Method Details

"maxDigits": 42, # Max length of DTMF digits. }, "loggingSettings": { # Define behaviors on logging. # Settings for logging. Settings for Dialogflow History, Contact Center messages, StackDriver logs, and speech logging. Exposed at the following levels: - Agent level. - "enableInteractionLogging": True or False, # If true, DF Interaction logging is currently enabled. - "enableStackdriverLogging": True or False, # If true, StackDriver logging is currently enabled. + "enableInteractionLogging": True or False, # Enables DF Interaction logging. + "enableStackdriverLogging": True or False, # Enables StackDriver logging. }, "speechSettings": { # Define behaviors of speech to text detection. # Settings for speech to text detection. Exposed at the following levels: - Agent level - Flow level - Page level - Parameter level "endpointerSensitivity": 42, # Sensitivity of the speech model that detects the end of speech. Scale from 0 to 100. @@ -3086,8 +3086,8 @@

Method Details

"maxDigits": 42, # Max length of DTMF digits. }, "loggingSettings": { # Define behaviors on logging. # Settings for logging. Settings for Dialogflow History, Contact Center messages, StackDriver logs, and speech logging. Exposed at the following levels: - Agent level. - "enableInteractionLogging": True or False, # If true, DF Interaction logging is currently enabled. - "enableStackdriverLogging": True or False, # If true, StackDriver logging is currently enabled. + "enableInteractionLogging": True or False, # Enables DF Interaction logging. + "enableStackdriverLogging": True or False, # Enables StackDriver logging. }, "speechSettings": { # Define behaviors of speech to text detection. # Settings for speech to text detection. Exposed at the following levels: - Agent level - Flow level - Page level - Parameter level "endpointerSensitivity": 42, # Sensitivity of the speech model that detects the end of speech. Scale from 0 to 100. @@ -3115,8 +3115,8 @@

Method Details

"maxDigits": 42, # Max length of DTMF digits. }, "loggingSettings": { # Define behaviors on logging. # Settings for logging. Settings for Dialogflow History, Contact Center messages, StackDriver logs, and speech logging. Exposed at the following levels: - Agent level. - "enableInteractionLogging": True or False, # If true, DF Interaction logging is currently enabled. - "enableStackdriverLogging": True or False, # If true, StackDriver logging is currently enabled. + "enableInteractionLogging": True or False, # Enables DF Interaction logging. + "enableStackdriverLogging": True or False, # Enables StackDriver logging. }, "speechSettings": { # Define behaviors of speech to text detection. # Settings for speech to text detection. Exposed at the following levels: - Agent level - Flow level - Page level - Parameter level "endpointerSensitivity": 42, # Sensitivity of the speech model that detects the end of speech. Scale from 0 to 100. @@ -3269,8 +3269,8 @@

Method Details

"maxDigits": 42, # Max length of DTMF digits. }, "loggingSettings": { # Define behaviors on logging. # Settings for logging. Settings for Dialogflow History, Contact Center messages, StackDriver logs, and speech logging. Exposed at the following levels: - Agent level. - "enableInteractionLogging": True or False, # If true, DF Interaction logging is currently enabled. - "enableStackdriverLogging": True or False, # If true, StackDriver logging is currently enabled. + "enableInteractionLogging": True or False, # Enables DF Interaction logging. + "enableStackdriverLogging": True or False, # Enables StackDriver logging. }, "speechSettings": { # Define behaviors of speech to text detection. # Settings for speech to text detection. Exposed at the following levels: - Agent level - Flow level - Page level - Parameter level "endpointerSensitivity": 42, # Sensitivity of the speech model that detects the end of speech. Scale from 0 to 100. @@ -3436,8 +3436,8 @@

Method Details

"maxDigits": 42, # Max length of DTMF digits. }, "loggingSettings": { # Define behaviors on logging. # Settings for logging. Settings for Dialogflow History, Contact Center messages, StackDriver logs, and speech logging. Exposed at the following levels: - Agent level. - "enableInteractionLogging": True or False, # If true, DF Interaction logging is currently enabled. - "enableStackdriverLogging": True or False, # If true, StackDriver logging is currently enabled. + "enableInteractionLogging": True or False, # Enables DF Interaction logging. + "enableStackdriverLogging": True or False, # Enables StackDriver logging. }, "speechSettings": { # Define behaviors of speech to text detection. # Settings for speech to text detection. Exposed at the following levels: - Agent level - Flow level - Page level - Parameter level "endpointerSensitivity": 42, # Sensitivity of the speech model that detects the end of speech. Scale from 0 to 100. @@ -3597,8 +3597,8 @@

Method Details

"maxDigits": 42, # Max length of DTMF digits. }, "loggingSettings": { # Define behaviors on logging. # Settings for logging. Settings for Dialogflow History, Contact Center messages, StackDriver logs, and speech logging. Exposed at the following levels: - Agent level. - "enableInteractionLogging": True or False, # If true, DF Interaction logging is currently enabled. - "enableStackdriverLogging": True or False, # If true, StackDriver logging is currently enabled. + "enableInteractionLogging": True or False, # Enables DF Interaction logging. + "enableStackdriverLogging": True or False, # Enables StackDriver logging. }, "speechSettings": { # Define behaviors of speech to text detection. # Settings for speech to text detection. Exposed at the following levels: - Agent level - Flow level - Page level - Parameter level "endpointerSensitivity": 42, # Sensitivity of the speech model that detects the end of speech. Scale from 0 to 100. @@ -3756,8 +3756,8 @@

Method Details

"maxDigits": 42, # Max length of DTMF digits. }, "loggingSettings": { # Define behaviors on logging. # Settings for logging. Settings for Dialogflow History, Contact Center messages, StackDriver logs, and speech logging. Exposed at the following levels: - Agent level. - "enableInteractionLogging": True or False, # If true, DF Interaction logging is currently enabled. - "enableStackdriverLogging": True or False, # If true, StackDriver logging is currently enabled. + "enableInteractionLogging": True or False, # Enables DF Interaction logging. + "enableStackdriverLogging": True or False, # Enables StackDriver logging. }, "speechSettings": { # Define behaviors of speech to text detection. # Settings for speech to text detection. Exposed at the following levels: - Agent level - Flow level - Page level - Parameter level "endpointerSensitivity": 42, # Sensitivity of the speech model that detects the end of speech. Scale from 0 to 100. @@ -3974,8 +3974,8 @@

Method Details

"maxDigits": 42, # Max length of DTMF digits. }, "loggingSettings": { # Define behaviors on logging. # Settings for logging. Settings for Dialogflow History, Contact Center messages, StackDriver logs, and speech logging. Exposed at the following levels: - Agent level. - "enableInteractionLogging": True or False, # If true, DF Interaction logging is currently enabled. - "enableStackdriverLogging": True or False, # If true, StackDriver logging is currently enabled. + "enableInteractionLogging": True or False, # Enables DF Interaction logging. + "enableStackdriverLogging": True or False, # Enables StackDriver logging. }, "speechSettings": { # Define behaviors of speech to text detection. # Settings for speech to text detection. Exposed at the following levels: - Agent level - Flow level - Page level - Parameter level "endpointerSensitivity": 42, # Sensitivity of the speech model that detects the end of speech. Scale from 0 to 100. @@ -4001,8 +4001,8 @@

Method Details

"maxDigits": 42, # Max length of DTMF digits. }, "loggingSettings": { # Define behaviors on logging. # Settings for logging. Settings for Dialogflow History, Contact Center messages, StackDriver logs, and speech logging. Exposed at the following levels: - Agent level. - "enableInteractionLogging": True or False, # If true, DF Interaction logging is currently enabled. - "enableStackdriverLogging": True or False, # If true, StackDriver logging is currently enabled. + "enableInteractionLogging": True or False, # Enables DF Interaction logging. + "enableStackdriverLogging": True or False, # Enables StackDriver logging. }, "speechSettings": { # Define behaviors of speech to text detection. # Settings for speech to text detection. Exposed at the following levels: - Agent level - Flow level - Page level - Parameter level "endpointerSensitivity": 42, # Sensitivity of the speech model that detects the end of speech. Scale from 0 to 100. @@ -4155,8 +4155,8 @@

Method Details

"maxDigits": 42, # Max length of DTMF digits. }, "loggingSettings": { # Define behaviors on logging. # Settings for logging. Settings for Dialogflow History, Contact Center messages, StackDriver logs, and speech logging. Exposed at the following levels: - Agent level. - "enableInteractionLogging": True or False, # If true, DF Interaction logging is currently enabled. - "enableStackdriverLogging": True or False, # If true, StackDriver logging is currently enabled. + "enableInteractionLogging": True or False, # Enables DF Interaction logging. + "enableStackdriverLogging": True or False, # Enables StackDriver logging. }, "speechSettings": { # Define behaviors of speech to text detection. # Settings for speech to text detection. Exposed at the following levels: - Agent level - Flow level - Page level - Parameter level "endpointerSensitivity": 42, # Sensitivity of the speech model that detects the end of speech. Scale from 0 to 100. @@ -4307,8 +4307,8 @@

Method Details

"maxDigits": 42, # Max length of DTMF digits. }, "loggingSettings": { # Define behaviors on logging. # Settings for logging. Settings for Dialogflow History, Contact Center messages, StackDriver logs, and speech logging. Exposed at the following levels: - Agent level. - "enableInteractionLogging": True or False, # If true, DF Interaction logging is currently enabled. - "enableStackdriverLogging": True or False, # If true, StackDriver logging is currently enabled. + "enableInteractionLogging": True or False, # Enables DF Interaction logging. + "enableStackdriverLogging": True or False, # Enables StackDriver logging. }, "speechSettings": { # Define behaviors of speech to text detection. # Settings for speech to text detection. Exposed at the following levels: - Agent level - Flow level - Page level - Parameter level "endpointerSensitivity": 42, # Sensitivity of the speech model that detects the end of speech. Scale from 0 to 100. @@ -4336,8 +4336,8 @@

Method Details

"maxDigits": 42, # Max length of DTMF digits. }, "loggingSettings": { # Define behaviors on logging. # Settings for logging. Settings for Dialogflow History, Contact Center messages, StackDriver logs, and speech logging. Exposed at the following levels: - Agent level. - "enableInteractionLogging": True or False, # If true, DF Interaction logging is currently enabled. - "enableStackdriverLogging": True or False, # If true, StackDriver logging is currently enabled. + "enableInteractionLogging": True or False, # Enables DF Interaction logging. + "enableStackdriverLogging": True or False, # Enables StackDriver logging. }, "speechSettings": { # Define behaviors of speech to text detection. # Settings for speech to text detection. Exposed at the following levels: - Agent level - Flow level - Page level - Parameter level "endpointerSensitivity": 42, # Sensitivity of the speech model that detects the end of speech. Scale from 0 to 100. @@ -4490,8 +4490,8 @@

Method Details

"maxDigits": 42, # Max length of DTMF digits. }, "loggingSettings": { # Define behaviors on logging. # Settings for logging. Settings for Dialogflow History, Contact Center messages, StackDriver logs, and speech logging. Exposed at the following levels: - Agent level. - "enableInteractionLogging": True or False, # If true, DF Interaction logging is currently enabled. - "enableStackdriverLogging": True or False, # If true, StackDriver logging is currently enabled. + "enableInteractionLogging": True or False, # Enables DF Interaction logging. + "enableStackdriverLogging": True or False, # Enables StackDriver logging. }, "speechSettings": { # Define behaviors of speech to text detection. # Settings for speech to text detection. Exposed at the following levels: - Agent level - Flow level - Page level - Parameter level "endpointerSensitivity": 42, # Sensitivity of the speech model that detects the end of speech. Scale from 0 to 100. @@ -4657,8 +4657,8 @@

Method Details

"maxDigits": 42, # Max length of DTMF digits. }, "loggingSettings": { # Define behaviors on logging. # Settings for logging. Settings for Dialogflow History, Contact Center messages, StackDriver logs, and speech logging. Exposed at the following levels: - Agent level. - "enableInteractionLogging": True or False, # If true, DF Interaction logging is currently enabled. - "enableStackdriverLogging": True or False, # If true, StackDriver logging is currently enabled. + "enableInteractionLogging": True or False, # Enables DF Interaction logging. + "enableStackdriverLogging": True or False, # Enables StackDriver logging. }, "speechSettings": { # Define behaviors of speech to text detection. # Settings for speech to text detection. Exposed at the following levels: - Agent level - Flow level - Page level - Parameter level "endpointerSensitivity": 42, # Sensitivity of the speech model that detects the end of speech. Scale from 0 to 100. @@ -4818,8 +4818,8 @@

Method Details

"maxDigits": 42, # Max length of DTMF digits. }, "loggingSettings": { # Define behaviors on logging. # Settings for logging. Settings for Dialogflow History, Contact Center messages, StackDriver logs, and speech logging. Exposed at the following levels: - Agent level. - "enableInteractionLogging": True or False, # If true, DF Interaction logging is currently enabled. - "enableStackdriverLogging": True or False, # If true, StackDriver logging is currently enabled. + "enableInteractionLogging": True or False, # Enables DF Interaction logging. + "enableStackdriverLogging": True or False, # Enables StackDriver logging. }, "speechSettings": { # Define behaviors of speech to text detection. # Settings for speech to text detection. Exposed at the following levels: - Agent level - Flow level - Page level - Parameter level "endpointerSensitivity": 42, # Sensitivity of the speech model that detects the end of speech. Scale from 0 to 100. @@ -5086,8 +5086,8 @@

Method Details

"maxDigits": 42, # Max length of DTMF digits. }, "loggingSettings": { # Define behaviors on logging. # Settings for logging. Settings for Dialogflow History, Contact Center messages, StackDriver logs, and speech logging. Exposed at the following levels: - Agent level. - "enableInteractionLogging": True or False, # If true, DF Interaction logging is currently enabled. - "enableStackdriverLogging": True or False, # If true, StackDriver logging is currently enabled. + "enableInteractionLogging": True or False, # Enables DF Interaction logging. + "enableStackdriverLogging": True or False, # Enables StackDriver logging. }, "speechSettings": { # Define behaviors of speech to text detection. # Settings for speech to text detection. Exposed at the following levels: - Agent level - Flow level - Page level - Parameter level "endpointerSensitivity": 42, # Sensitivity of the speech model that detects the end of speech. Scale from 0 to 100. @@ -5113,8 +5113,8 @@

Method Details

"maxDigits": 42, # Max length of DTMF digits. }, "loggingSettings": { # Define behaviors on logging. # Settings for logging. Settings for Dialogflow History, Contact Center messages, StackDriver logs, and speech logging. Exposed at the following levels: - Agent level. - "enableInteractionLogging": True or False, # If true, DF Interaction logging is currently enabled. - "enableStackdriverLogging": True or False, # If true, StackDriver logging is currently enabled. + "enableInteractionLogging": True or False, # Enables DF Interaction logging. + "enableStackdriverLogging": True or False, # Enables StackDriver logging. }, "speechSettings": { # Define behaviors of speech to text detection. # Settings for speech to text detection. Exposed at the following levels: - Agent level - Flow level - Page level - Parameter level "endpointerSensitivity": 42, # Sensitivity of the speech model that detects the end of speech. Scale from 0 to 100. @@ -5267,8 +5267,8 @@

Method Details

"maxDigits": 42, # Max length of DTMF digits. }, "loggingSettings": { # Define behaviors on logging. # Settings for logging. Settings for Dialogflow History, Contact Center messages, StackDriver logs, and speech logging. Exposed at the following levels: - Agent level. - "enableInteractionLogging": True or False, # If true, DF Interaction logging is currently enabled. - "enableStackdriverLogging": True or False, # If true, StackDriver logging is currently enabled. + "enableInteractionLogging": True or False, # Enables DF Interaction logging. + "enableStackdriverLogging": True or False, # Enables StackDriver logging. }, "speechSettings": { # Define behaviors of speech to text detection. # Settings for speech to text detection. Exposed at the following levels: - Agent level - Flow level - Page level - Parameter level "endpointerSensitivity": 42, # Sensitivity of the speech model that detects the end of speech. Scale from 0 to 100. @@ -5419,8 +5419,8 @@

Method Details

"maxDigits": 42, # Max length of DTMF digits. }, "loggingSettings": { # Define behaviors on logging. # Settings for logging. Settings for Dialogflow History, Contact Center messages, StackDriver logs, and speech logging. Exposed at the following levels: - Agent level. - "enableInteractionLogging": True or False, # If true, DF Interaction logging is currently enabled. - "enableStackdriverLogging": True or False, # If true, StackDriver logging is currently enabled. + "enableInteractionLogging": True or False, # Enables DF Interaction logging. + "enableStackdriverLogging": True or False, # Enables StackDriver logging. }, "speechSettings": { # Define behaviors of speech to text detection. # Settings for speech to text detection. Exposed at the following levels: - Agent level - Flow level - Page level - Parameter level "endpointerSensitivity": 42, # Sensitivity of the speech model that detects the end of speech. Scale from 0 to 100. @@ -5448,8 +5448,8 @@

Method Details

"maxDigits": 42, # Max length of DTMF digits. }, "loggingSettings": { # Define behaviors on logging. # Settings for logging. Settings for Dialogflow History, Contact Center messages, StackDriver logs, and speech logging. Exposed at the following levels: - Agent level. - "enableInteractionLogging": True or False, # If true, DF Interaction logging is currently enabled. - "enableStackdriverLogging": True or False, # If true, StackDriver logging is currently enabled. + "enableInteractionLogging": True or False, # Enables DF Interaction logging. + "enableStackdriverLogging": True or False, # Enables StackDriver logging. }, "speechSettings": { # Define behaviors of speech to text detection. # Settings for speech to text detection. Exposed at the following levels: - Agent level - Flow level - Page level - Parameter level "endpointerSensitivity": 42, # Sensitivity of the speech model that detects the end of speech. Scale from 0 to 100. @@ -5602,8 +5602,8 @@

Method Details

"maxDigits": 42, # Max length of DTMF digits. }, "loggingSettings": { # Define behaviors on logging. # Settings for logging. Settings for Dialogflow History, Contact Center messages, StackDriver logs, and speech logging. Exposed at the following levels: - Agent level. - "enableInteractionLogging": True or False, # If true, DF Interaction logging is currently enabled. - "enableStackdriverLogging": True or False, # If true, StackDriver logging is currently enabled. + "enableInteractionLogging": True or False, # Enables DF Interaction logging. + "enableStackdriverLogging": True or False, # Enables StackDriver logging. }, "speechSettings": { # Define behaviors of speech to text detection. # Settings for speech to text detection. Exposed at the following levels: - Agent level - Flow level - Page level - Parameter level "endpointerSensitivity": 42, # Sensitivity of the speech model that detects the end of speech. Scale from 0 to 100. @@ -5769,8 +5769,8 @@

Method Details

"maxDigits": 42, # Max length of DTMF digits. }, "loggingSettings": { # Define behaviors on logging. # Settings for logging. Settings for Dialogflow History, Contact Center messages, StackDriver logs, and speech logging. Exposed at the following levels: - Agent level. - "enableInteractionLogging": True or False, # If true, DF Interaction logging is currently enabled. - "enableStackdriverLogging": True or False, # If true, StackDriver logging is currently enabled. + "enableInteractionLogging": True or False, # Enables DF Interaction logging. + "enableStackdriverLogging": True or False, # Enables StackDriver logging. }, "speechSettings": { # Define behaviors of speech to text detection. # Settings for speech to text detection. Exposed at the following levels: - Agent level - Flow level - Page level - Parameter level "endpointerSensitivity": 42, # Sensitivity of the speech model that detects the end of speech. Scale from 0 to 100. @@ -5930,8 +5930,8 @@

Method Details

"maxDigits": 42, # Max length of DTMF digits. }, "loggingSettings": { # Define behaviors on logging. # Settings for logging. Settings for Dialogflow History, Contact Center messages, StackDriver logs, and speech logging. Exposed at the following levels: - Agent level. - "enableInteractionLogging": True or False, # If true, DF Interaction logging is currently enabled. - "enableStackdriverLogging": True or False, # If true, StackDriver logging is currently enabled. + "enableInteractionLogging": True or False, # Enables DF Interaction logging. + "enableStackdriverLogging": True or False, # Enables StackDriver logging. }, "speechSettings": { # Define behaviors of speech to text detection. # Settings for speech to text detection. Exposed at the following levels: - Agent level - Flow level - Page level - Parameter level "endpointerSensitivity": 42, # Sensitivity of the speech model that detects the end of speech. Scale from 0 to 100. @@ -6209,8 +6209,8 @@

Method Details

"maxDigits": 42, # Max length of DTMF digits. }, "loggingSettings": { # Define behaviors on logging. # Settings for logging. Settings for Dialogflow History, Contact Center messages, StackDriver logs, and speech logging. Exposed at the following levels: - Agent level. - "enableInteractionLogging": True or False, # If true, DF Interaction logging is currently enabled. - "enableStackdriverLogging": True or False, # If true, StackDriver logging is currently enabled. + "enableInteractionLogging": True or False, # Enables DF Interaction logging. + "enableStackdriverLogging": True or False, # Enables StackDriver logging. }, "speechSettings": { # Define behaviors of speech to text detection. # Settings for speech to text detection. Exposed at the following levels: - Agent level - Flow level - Page level - Parameter level "endpointerSensitivity": 42, # Sensitivity of the speech model that detects the end of speech. Scale from 0 to 100. @@ -6236,8 +6236,8 @@

Method Details

"maxDigits": 42, # Max length of DTMF digits. }, "loggingSettings": { # Define behaviors on logging. # Settings for logging. Settings for Dialogflow History, Contact Center messages, StackDriver logs, and speech logging. Exposed at the following levels: - Agent level. - "enableInteractionLogging": True or False, # If true, DF Interaction logging is currently enabled. - "enableStackdriverLogging": True or False, # If true, StackDriver logging is currently enabled. + "enableInteractionLogging": True or False, # Enables DF Interaction logging. + "enableStackdriverLogging": True or False, # Enables StackDriver logging. }, "speechSettings": { # Define behaviors of speech to text detection. # Settings for speech to text detection. Exposed at the following levels: - Agent level - Flow level - Page level - Parameter level "endpointerSensitivity": 42, # Sensitivity of the speech model that detects the end of speech. Scale from 0 to 100. @@ -6390,8 +6390,8 @@

Method Details

"maxDigits": 42, # Max length of DTMF digits. }, "loggingSettings": { # Define behaviors on logging. # Settings for logging. Settings for Dialogflow History, Contact Center messages, StackDriver logs, and speech logging. Exposed at the following levels: - Agent level. - "enableInteractionLogging": True or False, # If true, DF Interaction logging is currently enabled. - "enableStackdriverLogging": True or False, # If true, StackDriver logging is currently enabled. + "enableInteractionLogging": True or False, # Enables DF Interaction logging. + "enableStackdriverLogging": True or False, # Enables StackDriver logging. }, "speechSettings": { # Define behaviors of speech to text detection. # Settings for speech to text detection. Exposed at the following levels: - Agent level - Flow level - Page level - Parameter level "endpointerSensitivity": 42, # Sensitivity of the speech model that detects the end of speech. Scale from 0 to 100. @@ -6542,8 +6542,8 @@

Method Details

"maxDigits": 42, # Max length of DTMF digits. }, "loggingSettings": { # Define behaviors on logging. # Settings for logging. Settings for Dialogflow History, Contact Center messages, StackDriver logs, and speech logging. Exposed at the following levels: - Agent level. - "enableInteractionLogging": True or False, # If true, DF Interaction logging is currently enabled. - "enableStackdriverLogging": True or False, # If true, StackDriver logging is currently enabled. + "enableInteractionLogging": True or False, # Enables DF Interaction logging. + "enableStackdriverLogging": True or False, # Enables StackDriver logging. }, "speechSettings": { # Define behaviors of speech to text detection. # Settings for speech to text detection. Exposed at the following levels: - Agent level - Flow level - Page level - Parameter level "endpointerSensitivity": 42, # Sensitivity of the speech model that detects the end of speech. Scale from 0 to 100. @@ -6571,8 +6571,8 @@

Method Details

"maxDigits": 42, # Max length of DTMF digits. }, "loggingSettings": { # Define behaviors on logging. # Settings for logging. Settings for Dialogflow History, Contact Center messages, StackDriver logs, and speech logging. Exposed at the following levels: - Agent level. - "enableInteractionLogging": True or False, # If true, DF Interaction logging is currently enabled. - "enableStackdriverLogging": True or False, # If true, StackDriver logging is currently enabled. + "enableInteractionLogging": True or False, # Enables DF Interaction logging. + "enableStackdriverLogging": True or False, # Enables StackDriver logging. }, "speechSettings": { # Define behaviors of speech to text detection. # Settings for speech to text detection. Exposed at the following levels: - Agent level - Flow level - Page level - Parameter level "endpointerSensitivity": 42, # Sensitivity of the speech model that detects the end of speech. Scale from 0 to 100. @@ -6725,8 +6725,8 @@

Method Details

"maxDigits": 42, # Max length of DTMF digits. }, "loggingSettings": { # Define behaviors on logging. # Settings for logging. Settings for Dialogflow History, Contact Center messages, StackDriver logs, and speech logging. Exposed at the following levels: - Agent level. - "enableInteractionLogging": True or False, # If true, DF Interaction logging is currently enabled. - "enableStackdriverLogging": True or False, # If true, StackDriver logging is currently enabled. + "enableInteractionLogging": True or False, # Enables DF Interaction logging. + "enableStackdriverLogging": True or False, # Enables StackDriver logging. }, "speechSettings": { # Define behaviors of speech to text detection. # Settings for speech to text detection. Exposed at the following levels: - Agent level - Flow level - Page level - Parameter level "endpointerSensitivity": 42, # Sensitivity of the speech model that detects the end of speech. Scale from 0 to 100. @@ -6892,8 +6892,8 @@

Method Details

"maxDigits": 42, # Max length of DTMF digits. }, "loggingSettings": { # Define behaviors on logging. # Settings for logging. Settings for Dialogflow History, Contact Center messages, StackDriver logs, and speech logging. Exposed at the following levels: - Agent level. - "enableInteractionLogging": True or False, # If true, DF Interaction logging is currently enabled. - "enableStackdriverLogging": True or False, # If true, StackDriver logging is currently enabled. + "enableInteractionLogging": True or False, # Enables DF Interaction logging. + "enableStackdriverLogging": True or False, # Enables StackDriver logging. }, "speechSettings": { # Define behaviors of speech to text detection. # Settings for speech to text detection. Exposed at the following levels: - Agent level - Flow level - Page level - Parameter level "endpointerSensitivity": 42, # Sensitivity of the speech model that detects the end of speech. Scale from 0 to 100. @@ -7053,8 +7053,8 @@

Method Details

"maxDigits": 42, # Max length of DTMF digits. }, "loggingSettings": { # Define behaviors on logging. # Settings for logging. Settings for Dialogflow History, Contact Center messages, StackDriver logs, and speech logging. Exposed at the following levels: - Agent level. - "enableInteractionLogging": True or False, # If true, DF Interaction logging is currently enabled. - "enableStackdriverLogging": True or False, # If true, StackDriver logging is currently enabled. + "enableInteractionLogging": True or False, # Enables DF Interaction logging. + "enableStackdriverLogging": True or False, # Enables StackDriver logging. }, "speechSettings": { # Define behaviors of speech to text detection. # Settings for speech to text detection. Exposed at the following levels: - Agent level - Flow level - Page level - Parameter level "endpointerSensitivity": 42, # Sensitivity of the speech model that detects the end of speech. Scale from 0 to 100. @@ -7321,8 +7321,8 @@

Method Details

"maxDigits": 42, # Max length of DTMF digits. }, "loggingSettings": { # Define behaviors on logging. # Settings for logging. Settings for Dialogflow History, Contact Center messages, StackDriver logs, and speech logging. Exposed at the following levels: - Agent level. - "enableInteractionLogging": True or False, # If true, DF Interaction logging is currently enabled. - "enableStackdriverLogging": True or False, # If true, StackDriver logging is currently enabled. + "enableInteractionLogging": True or False, # Enables DF Interaction logging. + "enableStackdriverLogging": True or False, # Enables StackDriver logging. }, "speechSettings": { # Define behaviors of speech to text detection. # Settings for speech to text detection. Exposed at the following levels: - Agent level - Flow level - Page level - Parameter level "endpointerSensitivity": 42, # Sensitivity of the speech model that detects the end of speech. Scale from 0 to 100. @@ -7348,8 +7348,8 @@

Method Details

"maxDigits": 42, # Max length of DTMF digits. }, "loggingSettings": { # Define behaviors on logging. # Settings for logging. Settings for Dialogflow History, Contact Center messages, StackDriver logs, and speech logging. Exposed at the following levels: - Agent level. - "enableInteractionLogging": True or False, # If true, DF Interaction logging is currently enabled. - "enableStackdriverLogging": True or False, # If true, StackDriver logging is currently enabled. + "enableInteractionLogging": True or False, # Enables DF Interaction logging. + "enableStackdriverLogging": True or False, # Enables StackDriver logging. }, "speechSettings": { # Define behaviors of speech to text detection. # Settings for speech to text detection. Exposed at the following levels: - Agent level - Flow level - Page level - Parameter level "endpointerSensitivity": 42, # Sensitivity of the speech model that detects the end of speech. Scale from 0 to 100. @@ -7502,8 +7502,8 @@

Method Details

"maxDigits": 42, # Max length of DTMF digits. }, "loggingSettings": { # Define behaviors on logging. # Settings for logging. Settings for Dialogflow History, Contact Center messages, StackDriver logs, and speech logging. Exposed at the following levels: - Agent level. - "enableInteractionLogging": True or False, # If true, DF Interaction logging is currently enabled. - "enableStackdriverLogging": True or False, # If true, StackDriver logging is currently enabled. + "enableInteractionLogging": True or False, # Enables DF Interaction logging. + "enableStackdriverLogging": True or False, # Enables StackDriver logging. }, "speechSettings": { # Define behaviors of speech to text detection. # Settings for speech to text detection. Exposed at the following levels: - Agent level - Flow level - Page level - Parameter level "endpointerSensitivity": 42, # Sensitivity of the speech model that detects the end of speech. Scale from 0 to 100. @@ -7654,8 +7654,8 @@

Method Details

"maxDigits": 42, # Max length of DTMF digits. }, "loggingSettings": { # Define behaviors on logging. # Settings for logging. Settings for Dialogflow History, Contact Center messages, StackDriver logs, and speech logging. Exposed at the following levels: - Agent level. - "enableInteractionLogging": True or False, # If true, DF Interaction logging is currently enabled. - "enableStackdriverLogging": True or False, # If true, StackDriver logging is currently enabled. + "enableInteractionLogging": True or False, # Enables DF Interaction logging. + "enableStackdriverLogging": True or False, # Enables StackDriver logging. }, "speechSettings": { # Define behaviors of speech to text detection. # Settings for speech to text detection. Exposed at the following levels: - Agent level - Flow level - Page level - Parameter level "endpointerSensitivity": 42, # Sensitivity of the speech model that detects the end of speech. Scale from 0 to 100. @@ -7683,8 +7683,8 @@

Method Details

"maxDigits": 42, # Max length of DTMF digits. }, "loggingSettings": { # Define behaviors on logging. # Settings for logging. Settings for Dialogflow History, Contact Center messages, StackDriver logs, and speech logging. Exposed at the following levels: - Agent level. - "enableInteractionLogging": True or False, # If true, DF Interaction logging is currently enabled. - "enableStackdriverLogging": True or False, # If true, StackDriver logging is currently enabled. + "enableInteractionLogging": True or False, # Enables DF Interaction logging. + "enableStackdriverLogging": True or False, # Enables StackDriver logging. }, "speechSettings": { # Define behaviors of speech to text detection. # Settings for speech to text detection. Exposed at the following levels: - Agent level - Flow level - Page level - Parameter level "endpointerSensitivity": 42, # Sensitivity of the speech model that detects the end of speech. Scale from 0 to 100. @@ -7837,8 +7837,8 @@

Method Details

"maxDigits": 42, # Max length of DTMF digits. }, "loggingSettings": { # Define behaviors on logging. # Settings for logging. Settings for Dialogflow History, Contact Center messages, StackDriver logs, and speech logging. Exposed at the following levels: - Agent level. - "enableInteractionLogging": True or False, # If true, DF Interaction logging is currently enabled. - "enableStackdriverLogging": True or False, # If true, StackDriver logging is currently enabled. + "enableInteractionLogging": True or False, # Enables DF Interaction logging. + "enableStackdriverLogging": True or False, # Enables StackDriver logging. }, "speechSettings": { # Define behaviors of speech to text detection. # Settings for speech to text detection. Exposed at the following levels: - Agent level - Flow level - Page level - Parameter level "endpointerSensitivity": 42, # Sensitivity of the speech model that detects the end of speech. Scale from 0 to 100. @@ -8004,8 +8004,8 @@

Method Details

"maxDigits": 42, # Max length of DTMF digits. }, "loggingSettings": { # Define behaviors on logging. # Settings for logging. Settings for Dialogflow History, Contact Center messages, StackDriver logs, and speech logging. Exposed at the following levels: - Agent level. - "enableInteractionLogging": True or False, # If true, DF Interaction logging is currently enabled. - "enableStackdriverLogging": True or False, # If true, StackDriver logging is currently enabled. + "enableInteractionLogging": True or False, # Enables DF Interaction logging. + "enableStackdriverLogging": True or False, # Enables StackDriver logging. }, "speechSettings": { # Define behaviors of speech to text detection. # Settings for speech to text detection. Exposed at the following levels: - Agent level - Flow level - Page level - Parameter level "endpointerSensitivity": 42, # Sensitivity of the speech model that detects the end of speech. Scale from 0 to 100. @@ -8165,8 +8165,8 @@

Method Details

"maxDigits": 42, # Max length of DTMF digits. }, "loggingSettings": { # Define behaviors on logging. # Settings for logging. Settings for Dialogflow History, Contact Center messages, StackDriver logs, and speech logging. Exposed at the following levels: - Agent level. - "enableInteractionLogging": True or False, # If true, DF Interaction logging is currently enabled. - "enableStackdriverLogging": True or False, # If true, StackDriver logging is currently enabled. + "enableInteractionLogging": True or False, # Enables DF Interaction logging. + "enableStackdriverLogging": True or False, # Enables StackDriver logging. }, "speechSettings": { # Define behaviors of speech to text detection. # Settings for speech to text detection. Exposed at the following levels: - Agent level - Flow level - Page level - Parameter level "endpointerSensitivity": 42, # Sensitivity of the speech model that detects the end of speech. Scale from 0 to 100. @@ -8495,8 +8495,8 @@

Method Details

"maxDigits": 42, # Max length of DTMF digits. }, "loggingSettings": { # Define behaviors on logging. # Settings for logging. Settings for Dialogflow History, Contact Center messages, StackDriver logs, and speech logging. Exposed at the following levels: - Agent level. - "enableInteractionLogging": True or False, # If true, DF Interaction logging is currently enabled. - "enableStackdriverLogging": True or False, # If true, StackDriver logging is currently enabled. + "enableInteractionLogging": True or False, # Enables DF Interaction logging. + "enableStackdriverLogging": True or False, # Enables StackDriver logging. }, "speechSettings": { # Define behaviors of speech to text detection. # Settings for speech to text detection. Exposed at the following levels: - Agent level - Flow level - Page level - Parameter level "endpointerSensitivity": 42, # Sensitivity of the speech model that detects the end of speech. Scale from 0 to 100. @@ -8522,8 +8522,8 @@

Method Details

"maxDigits": 42, # Max length of DTMF digits. }, "loggingSettings": { # Define behaviors on logging. # Settings for logging. Settings for Dialogflow History, Contact Center messages, StackDriver logs, and speech logging. Exposed at the following levels: - Agent level. - "enableInteractionLogging": True or False, # If true, DF Interaction logging is currently enabled. - "enableStackdriverLogging": True or False, # If true, StackDriver logging is currently enabled. + "enableInteractionLogging": True or False, # Enables DF Interaction logging. + "enableStackdriverLogging": True or False, # Enables StackDriver logging. }, "speechSettings": { # Define behaviors of speech to text detection. # Settings for speech to text detection. Exposed at the following levels: - Agent level - Flow level - Page level - Parameter level "endpointerSensitivity": 42, # Sensitivity of the speech model that detects the end of speech. Scale from 0 to 100. @@ -8676,8 +8676,8 @@

Method Details

"maxDigits": 42, # Max length of DTMF digits. }, "loggingSettings": { # Define behaviors on logging. # Settings for logging. Settings for Dialogflow History, Contact Center messages, StackDriver logs, and speech logging. Exposed at the following levels: - Agent level. - "enableInteractionLogging": True or False, # If true, DF Interaction logging is currently enabled. - "enableStackdriverLogging": True or False, # If true, StackDriver logging is currently enabled. + "enableInteractionLogging": True or False, # Enables DF Interaction logging. + "enableStackdriverLogging": True or False, # Enables StackDriver logging. }, "speechSettings": { # Define behaviors of speech to text detection. # Settings for speech to text detection. Exposed at the following levels: - Agent level - Flow level - Page level - Parameter level "endpointerSensitivity": 42, # Sensitivity of the speech model that detects the end of speech. Scale from 0 to 100. @@ -8828,8 +8828,8 @@

Method Details

"maxDigits": 42, # Max length of DTMF digits. }, "loggingSettings": { # Define behaviors on logging. # Settings for logging. Settings for Dialogflow History, Contact Center messages, StackDriver logs, and speech logging. Exposed at the following levels: - Agent level. - "enableInteractionLogging": True or False, # If true, DF Interaction logging is currently enabled. - "enableStackdriverLogging": True or False, # If true, StackDriver logging is currently enabled. + "enableInteractionLogging": True or False, # Enables DF Interaction logging. + "enableStackdriverLogging": True or False, # Enables StackDriver logging. }, "speechSettings": { # Define behaviors of speech to text detection. # Settings for speech to text detection. Exposed at the following levels: - Agent level - Flow level - Page level - Parameter level "endpointerSensitivity": 42, # Sensitivity of the speech model that detects the end of speech. Scale from 0 to 100. @@ -8857,8 +8857,8 @@

Method Details

"maxDigits": 42, # Max length of DTMF digits. }, "loggingSettings": { # Define behaviors on logging. # Settings for logging. Settings for Dialogflow History, Contact Center messages, StackDriver logs, and speech logging. Exposed at the following levels: - Agent level. - "enableInteractionLogging": True or False, # If true, DF Interaction logging is currently enabled. - "enableStackdriverLogging": True or False, # If true, StackDriver logging is currently enabled. + "enableInteractionLogging": True or False, # Enables DF Interaction logging. + "enableStackdriverLogging": True or False, # Enables StackDriver logging. }, "speechSettings": { # Define behaviors of speech to text detection. # Settings for speech to text detection. Exposed at the following levels: - Agent level - Flow level - Page level - Parameter level "endpointerSensitivity": 42, # Sensitivity of the speech model that detects the end of speech. Scale from 0 to 100. @@ -9011,8 +9011,8 @@

Method Details

"maxDigits": 42, # Max length of DTMF digits. }, "loggingSettings": { # Define behaviors on logging. # Settings for logging. Settings for Dialogflow History, Contact Center messages, StackDriver logs, and speech logging. Exposed at the following levels: - Agent level. - "enableInteractionLogging": True or False, # If true, DF Interaction logging is currently enabled. - "enableStackdriverLogging": True or False, # If true, StackDriver logging is currently enabled. + "enableInteractionLogging": True or False, # Enables DF Interaction logging. + "enableStackdriverLogging": True or False, # Enables StackDriver logging. }, "speechSettings": { # Define behaviors of speech to text detection. # Settings for speech to text detection. Exposed at the following levels: - Agent level - Flow level - Page level - Parameter level "endpointerSensitivity": 42, # Sensitivity of the speech model that detects the end of speech. Scale from 0 to 100. @@ -9178,8 +9178,8 @@

Method Details

"maxDigits": 42, # Max length of DTMF digits. }, "loggingSettings": { # Define behaviors on logging. # Settings for logging. Settings for Dialogflow History, Contact Center messages, StackDriver logs, and speech logging. Exposed at the following levels: - Agent level. - "enableInteractionLogging": True or False, # If true, DF Interaction logging is currently enabled. - "enableStackdriverLogging": True or False, # If true, StackDriver logging is currently enabled. + "enableInteractionLogging": True or False, # Enables DF Interaction logging. + "enableStackdriverLogging": True or False, # Enables StackDriver logging. }, "speechSettings": { # Define behaviors of speech to text detection. # Settings for speech to text detection. Exposed at the following levels: - Agent level - Flow level - Page level - Parameter level "endpointerSensitivity": 42, # Sensitivity of the speech model that detects the end of speech. Scale from 0 to 100. @@ -9339,8 +9339,8 @@

Method Details

"maxDigits": 42, # Max length of DTMF digits. }, "loggingSettings": { # Define behaviors on logging. # Settings for logging. Settings for Dialogflow History, Contact Center messages, StackDriver logs, and speech logging. Exposed at the following levels: - Agent level. - "enableInteractionLogging": True or False, # If true, DF Interaction logging is currently enabled. - "enableStackdriverLogging": True or False, # If true, StackDriver logging is currently enabled. + "enableInteractionLogging": True or False, # Enables DF Interaction logging. + "enableStackdriverLogging": True or False, # Enables StackDriver logging. }, "speechSettings": { # Define behaviors of speech to text detection. # Settings for speech to text detection. Exposed at the following levels: - Agent level - Flow level - Page level - Parameter level "endpointerSensitivity": 42, # Sensitivity of the speech model that detects the end of speech. Scale from 0 to 100. @@ -9607,8 +9607,8 @@

Method Details

"maxDigits": 42, # Max length of DTMF digits. }, "loggingSettings": { # Define behaviors on logging. # Settings for logging. Settings for Dialogflow History, Contact Center messages, StackDriver logs, and speech logging. Exposed at the following levels: - Agent level. - "enableInteractionLogging": True or False, # If true, DF Interaction logging is currently enabled. - "enableStackdriverLogging": True or False, # If true, StackDriver logging is currently enabled. + "enableInteractionLogging": True or False, # Enables DF Interaction logging. + "enableStackdriverLogging": True or False, # Enables StackDriver logging. }, "speechSettings": { # Define behaviors of speech to text detection. # Settings for speech to text detection. Exposed at the following levels: - Agent level - Flow level - Page level - Parameter level "endpointerSensitivity": 42, # Sensitivity of the speech model that detects the end of speech. Scale from 0 to 100. @@ -9634,8 +9634,8 @@

Method Details

"maxDigits": 42, # Max length of DTMF digits. }, "loggingSettings": { # Define behaviors on logging. # Settings for logging. Settings for Dialogflow History, Contact Center messages, StackDriver logs, and speech logging. Exposed at the following levels: - Agent level. - "enableInteractionLogging": True or False, # If true, DF Interaction logging is currently enabled. - "enableStackdriverLogging": True or False, # If true, StackDriver logging is currently enabled. + "enableInteractionLogging": True or False, # Enables DF Interaction logging. + "enableStackdriverLogging": True or False, # Enables StackDriver logging. }, "speechSettings": { # Define behaviors of speech to text detection. # Settings for speech to text detection. Exposed at the following levels: - Agent level - Flow level - Page level - Parameter level "endpointerSensitivity": 42, # Sensitivity of the speech model that detects the end of speech. Scale from 0 to 100. @@ -9788,8 +9788,8 @@

Method Details

"maxDigits": 42, # Max length of DTMF digits. }, "loggingSettings": { # Define behaviors on logging. # Settings for logging. Settings for Dialogflow History, Contact Center messages, StackDriver logs, and speech logging. Exposed at the following levels: - Agent level. - "enableInteractionLogging": True or False, # If true, DF Interaction logging is currently enabled. - "enableStackdriverLogging": True or False, # If true, StackDriver logging is currently enabled. + "enableInteractionLogging": True or False, # Enables DF Interaction logging. + "enableStackdriverLogging": True or False, # Enables StackDriver logging. }, "speechSettings": { # Define behaviors of speech to text detection. # Settings for speech to text detection. Exposed at the following levels: - Agent level - Flow level - Page level - Parameter level "endpointerSensitivity": 42, # Sensitivity of the speech model that detects the end of speech. Scale from 0 to 100. @@ -9940,8 +9940,8 @@

Method Details

"maxDigits": 42, # Max length of DTMF digits. }, "loggingSettings": { # Define behaviors on logging. # Settings for logging. Settings for Dialogflow History, Contact Center messages, StackDriver logs, and speech logging. Exposed at the following levels: - Agent level. - "enableInteractionLogging": True or False, # If true, DF Interaction logging is currently enabled. - "enableStackdriverLogging": True or False, # If true, StackDriver logging is currently enabled. + "enableInteractionLogging": True or False, # Enables DF Interaction logging. + "enableStackdriverLogging": True or False, # Enables StackDriver logging. }, "speechSettings": { # Define behaviors of speech to text detection. # Settings for speech to text detection. Exposed at the following levels: - Agent level - Flow level - Page level - Parameter level "endpointerSensitivity": 42, # Sensitivity of the speech model that detects the end of speech. Scale from 0 to 100. @@ -9969,8 +9969,8 @@

Method Details

"maxDigits": 42, # Max length of DTMF digits. }, "loggingSettings": { # Define behaviors on logging. # Settings for logging. Settings for Dialogflow History, Contact Center messages, StackDriver logs, and speech logging. Exposed at the following levels: - Agent level. - "enableInteractionLogging": True or False, # If true, DF Interaction logging is currently enabled. - "enableStackdriverLogging": True or False, # If true, StackDriver logging is currently enabled. + "enableInteractionLogging": True or False, # Enables DF Interaction logging. + "enableStackdriverLogging": True or False, # Enables StackDriver logging. }, "speechSettings": { # Define behaviors of speech to text detection. # Settings for speech to text detection. Exposed at the following levels: - Agent level - Flow level - Page level - Parameter level "endpointerSensitivity": 42, # Sensitivity of the speech model that detects the end of speech. Scale from 0 to 100. @@ -10123,8 +10123,8 @@

Method Details

"maxDigits": 42, # Max length of DTMF digits. }, "loggingSettings": { # Define behaviors on logging. # Settings for logging. Settings for Dialogflow History, Contact Center messages, StackDriver logs, and speech logging. Exposed at the following levels: - Agent level. - "enableInteractionLogging": True or False, # If true, DF Interaction logging is currently enabled. - "enableStackdriverLogging": True or False, # If true, StackDriver logging is currently enabled. + "enableInteractionLogging": True or False, # Enables DF Interaction logging. + "enableStackdriverLogging": True or False, # Enables StackDriver logging. }, "speechSettings": { # Define behaviors of speech to text detection. # Settings for speech to text detection. Exposed at the following levels: - Agent level - Flow level - Page level - Parameter level "endpointerSensitivity": 42, # Sensitivity of the speech model that detects the end of speech. Scale from 0 to 100. @@ -10290,8 +10290,8 @@

Method Details

"maxDigits": 42, # Max length of DTMF digits. }, "loggingSettings": { # Define behaviors on logging. # Settings for logging. Settings for Dialogflow History, Contact Center messages, StackDriver logs, and speech logging. Exposed at the following levels: - Agent level. - "enableInteractionLogging": True or False, # If true, DF Interaction logging is currently enabled. - "enableStackdriverLogging": True or False, # If true, StackDriver logging is currently enabled. + "enableInteractionLogging": True or False, # Enables DF Interaction logging. + "enableStackdriverLogging": True or False, # Enables StackDriver logging. }, "speechSettings": { # Define behaviors of speech to text detection. # Settings for speech to text detection. Exposed at the following levels: - Agent level - Flow level - Page level - Parameter level "endpointerSensitivity": 42, # Sensitivity of the speech model that detects the end of speech. Scale from 0 to 100. @@ -10451,8 +10451,8 @@

Method Details

"maxDigits": 42, # Max length of DTMF digits. }, "loggingSettings": { # Define behaviors on logging. # Settings for logging. Settings for Dialogflow History, Contact Center messages, StackDriver logs, and speech logging. Exposed at the following levels: - Agent level. - "enableInteractionLogging": True or False, # If true, DF Interaction logging is currently enabled. - "enableStackdriverLogging": True or False, # If true, StackDriver logging is currently enabled. + "enableInteractionLogging": True or False, # Enables DF Interaction logging. + "enableStackdriverLogging": True or False, # Enables StackDriver logging. }, "speechSettings": { # Define behaviors of speech to text detection. # Settings for speech to text detection. Exposed at the following levels: - Agent level - Flow level - Page level - Parameter level "endpointerSensitivity": 42, # Sensitivity of the speech model that detects the end of speech. Scale from 0 to 100. @@ -10790,8 +10790,8 @@

Method Details

"maxDigits": 42, # Max length of DTMF digits. }, "loggingSettings": { # Define behaviors on logging. # Settings for logging. Settings for Dialogflow History, Contact Center messages, StackDriver logs, and speech logging. Exposed at the following levels: - Agent level. - "enableInteractionLogging": True or False, # If true, DF Interaction logging is currently enabled. - "enableStackdriverLogging": True or False, # If true, StackDriver logging is currently enabled. + "enableInteractionLogging": True or False, # Enables DF Interaction logging. + "enableStackdriverLogging": True or False, # Enables StackDriver logging. }, "speechSettings": { # Define behaviors of speech to text detection. # Settings for speech to text detection. Exposed at the following levels: - Agent level - Flow level - Page level - Parameter level "endpointerSensitivity": 42, # Sensitivity of the speech model that detects the end of speech. Scale from 0 to 100. @@ -10817,8 +10817,8 @@

Method Details

"maxDigits": 42, # Max length of DTMF digits. }, "loggingSettings": { # Define behaviors on logging. # Settings for logging. Settings for Dialogflow History, Contact Center messages, StackDriver logs, and speech logging. Exposed at the following levels: - Agent level. - "enableInteractionLogging": True or False, # If true, DF Interaction logging is currently enabled. - "enableStackdriverLogging": True or False, # If true, StackDriver logging is currently enabled. + "enableInteractionLogging": True or False, # Enables DF Interaction logging. + "enableStackdriverLogging": True or False, # Enables StackDriver logging. }, "speechSettings": { # Define behaviors of speech to text detection. # Settings for speech to text detection. Exposed at the following levels: - Agent level - Flow level - Page level - Parameter level "endpointerSensitivity": 42, # Sensitivity of the speech model that detects the end of speech. Scale from 0 to 100. @@ -10971,8 +10971,8 @@

Method Details

"maxDigits": 42, # Max length of DTMF digits. }, "loggingSettings": { # Define behaviors on logging. # Settings for logging. Settings for Dialogflow History, Contact Center messages, StackDriver logs, and speech logging. Exposed at the following levels: - Agent level. - "enableInteractionLogging": True or False, # If true, DF Interaction logging is currently enabled. - "enableStackdriverLogging": True or False, # If true, StackDriver logging is currently enabled. + "enableInteractionLogging": True or False, # Enables DF Interaction logging. + "enableStackdriverLogging": True or False, # Enables StackDriver logging. }, "speechSettings": { # Define behaviors of speech to text detection. # Settings for speech to text detection. Exposed at the following levels: - Agent level - Flow level - Page level - Parameter level "endpointerSensitivity": 42, # Sensitivity of the speech model that detects the end of speech. Scale from 0 to 100. @@ -11123,8 +11123,8 @@

Method Details

"maxDigits": 42, # Max length of DTMF digits. }, "loggingSettings": { # Define behaviors on logging. # Settings for logging. Settings for Dialogflow History, Contact Center messages, StackDriver logs, and speech logging. Exposed at the following levels: - Agent level. - "enableInteractionLogging": True or False, # If true, DF Interaction logging is currently enabled. - "enableStackdriverLogging": True or False, # If true, StackDriver logging is currently enabled. + "enableInteractionLogging": True or False, # Enables DF Interaction logging. + "enableStackdriverLogging": True or False, # Enables StackDriver logging. }, "speechSettings": { # Define behaviors of speech to text detection. # Settings for speech to text detection. Exposed at the following levels: - Agent level - Flow level - Page level - Parameter level "endpointerSensitivity": 42, # Sensitivity of the speech model that detects the end of speech. Scale from 0 to 100. @@ -11152,8 +11152,8 @@

Method Details

"maxDigits": 42, # Max length of DTMF digits. }, "loggingSettings": { # Define behaviors on logging. # Settings for logging. Settings for Dialogflow History, Contact Center messages, StackDriver logs, and speech logging. Exposed at the following levels: - Agent level. - "enableInteractionLogging": True or False, # If true, DF Interaction logging is currently enabled. - "enableStackdriverLogging": True or False, # If true, StackDriver logging is currently enabled. + "enableInteractionLogging": True or False, # Enables DF Interaction logging. + "enableStackdriverLogging": True or False, # Enables StackDriver logging. }, "speechSettings": { # Define behaviors of speech to text detection. # Settings for speech to text detection. Exposed at the following levels: - Agent level - Flow level - Page level - Parameter level "endpointerSensitivity": 42, # Sensitivity of the speech model that detects the end of speech. Scale from 0 to 100. @@ -11306,8 +11306,8 @@

Method Details

"maxDigits": 42, # Max length of DTMF digits. }, "loggingSettings": { # Define behaviors on logging. # Settings for logging. Settings for Dialogflow History, Contact Center messages, StackDriver logs, and speech logging. Exposed at the following levels: - Agent level. - "enableInteractionLogging": True or False, # If true, DF Interaction logging is currently enabled. - "enableStackdriverLogging": True or False, # If true, StackDriver logging is currently enabled. + "enableInteractionLogging": True or False, # Enables DF Interaction logging. + "enableStackdriverLogging": True or False, # Enables StackDriver logging. }, "speechSettings": { # Define behaviors of speech to text detection. # Settings for speech to text detection. Exposed at the following levels: - Agent level - Flow level - Page level - Parameter level "endpointerSensitivity": 42, # Sensitivity of the speech model that detects the end of speech. Scale from 0 to 100. @@ -11473,8 +11473,8 @@

Method Details

"maxDigits": 42, # Max length of DTMF digits. }, "loggingSettings": { # Define behaviors on logging. # Settings for logging. Settings for Dialogflow History, Contact Center messages, StackDriver logs, and speech logging. Exposed at the following levels: - Agent level. - "enableInteractionLogging": True or False, # If true, DF Interaction logging is currently enabled. - "enableStackdriverLogging": True or False, # If true, StackDriver logging is currently enabled. + "enableInteractionLogging": True or False, # Enables DF Interaction logging. + "enableStackdriverLogging": True or False, # Enables StackDriver logging. }, "speechSettings": { # Define behaviors of speech to text detection. # Settings for speech to text detection. Exposed at the following levels: - Agent level - Flow level - Page level - Parameter level "endpointerSensitivity": 42, # Sensitivity of the speech model that detects the end of speech. Scale from 0 to 100. @@ -11634,8 +11634,8 @@

Method Details

"maxDigits": 42, # Max length of DTMF digits. }, "loggingSettings": { # Define behaviors on logging. # Settings for logging. Settings for Dialogflow History, Contact Center messages, StackDriver logs, and speech logging. Exposed at the following levels: - Agent level. - "enableInteractionLogging": True or False, # If true, DF Interaction logging is currently enabled. - "enableStackdriverLogging": True or False, # If true, StackDriver logging is currently enabled. + "enableInteractionLogging": True or False, # Enables DF Interaction logging. + "enableStackdriverLogging": True or False, # Enables StackDriver logging. }, "speechSettings": { # Define behaviors of speech to text detection. # Settings for speech to text detection. Exposed at the following levels: - Agent level - Flow level - Page level - Parameter level "endpointerSensitivity": 42, # Sensitivity of the speech model that detects the end of speech. Scale from 0 to 100. @@ -11902,8 +11902,8 @@

Method Details

"maxDigits": 42, # Max length of DTMF digits. }, "loggingSettings": { # Define behaviors on logging. # Settings for logging. Settings for Dialogflow History, Contact Center messages, StackDriver logs, and speech logging. Exposed at the following levels: - Agent level. - "enableInteractionLogging": True or False, # If true, DF Interaction logging is currently enabled. - "enableStackdriverLogging": True or False, # If true, StackDriver logging is currently enabled. + "enableInteractionLogging": True or False, # Enables DF Interaction logging. + "enableStackdriverLogging": True or False, # Enables StackDriver logging. }, "speechSettings": { # Define behaviors of speech to text detection. # Settings for speech to text detection. Exposed at the following levels: - Agent level - Flow level - Page level - Parameter level "endpointerSensitivity": 42, # Sensitivity of the speech model that detects the end of speech. Scale from 0 to 100. @@ -11929,8 +11929,8 @@

Method Details

"maxDigits": 42, # Max length of DTMF digits. }, "loggingSettings": { # Define behaviors on logging. # Settings for logging. Settings for Dialogflow History, Contact Center messages, StackDriver logs, and speech logging. Exposed at the following levels: - Agent level. - "enableInteractionLogging": True or False, # If true, DF Interaction logging is currently enabled. - "enableStackdriverLogging": True or False, # If true, StackDriver logging is currently enabled. + "enableInteractionLogging": True or False, # Enables DF Interaction logging. + "enableStackdriverLogging": True or False, # Enables StackDriver logging. }, "speechSettings": { # Define behaviors of speech to text detection. # Settings for speech to text detection. Exposed at the following levels: - Agent level - Flow level - Page level - Parameter level "endpointerSensitivity": 42, # Sensitivity of the speech model that detects the end of speech. Scale from 0 to 100. @@ -12083,8 +12083,8 @@

Method Details

"maxDigits": 42, # Max length of DTMF digits. }, "loggingSettings": { # Define behaviors on logging. # Settings for logging. Settings for Dialogflow History, Contact Center messages, StackDriver logs, and speech logging. Exposed at the following levels: - Agent level. - "enableInteractionLogging": True or False, # If true, DF Interaction logging is currently enabled. - "enableStackdriverLogging": True or False, # If true, StackDriver logging is currently enabled. + "enableInteractionLogging": True or False, # Enables DF Interaction logging. + "enableStackdriverLogging": True or False, # Enables StackDriver logging. }, "speechSettings": { # Define behaviors of speech to text detection. # Settings for speech to text detection. Exposed at the following levels: - Agent level - Flow level - Page level - Parameter level "endpointerSensitivity": 42, # Sensitivity of the speech model that detects the end of speech. Scale from 0 to 100. @@ -12235,8 +12235,8 @@

Method Details

"maxDigits": 42, # Max length of DTMF digits. }, "loggingSettings": { # Define behaviors on logging. # Settings for logging. Settings for Dialogflow History, Contact Center messages, StackDriver logs, and speech logging. Exposed at the following levels: - Agent level. - "enableInteractionLogging": True or False, # If true, DF Interaction logging is currently enabled. - "enableStackdriverLogging": True or False, # If true, StackDriver logging is currently enabled. + "enableInteractionLogging": True or False, # Enables DF Interaction logging. + "enableStackdriverLogging": True or False, # Enables StackDriver logging. }, "speechSettings": { # Define behaviors of speech to text detection. # Settings for speech to text detection. Exposed at the following levels: - Agent level - Flow level - Page level - Parameter level "endpointerSensitivity": 42, # Sensitivity of the speech model that detects the end of speech. Scale from 0 to 100. @@ -12264,8 +12264,8 @@

Method Details

"maxDigits": 42, # Max length of DTMF digits. }, "loggingSettings": { # Define behaviors on logging. # Settings for logging. Settings for Dialogflow History, Contact Center messages, StackDriver logs, and speech logging. Exposed at the following levels: - Agent level. - "enableInteractionLogging": True or False, # If true, DF Interaction logging is currently enabled. - "enableStackdriverLogging": True or False, # If true, StackDriver logging is currently enabled. + "enableInteractionLogging": True or False, # Enables DF Interaction logging. + "enableStackdriverLogging": True or False, # Enables StackDriver logging. }, "speechSettings": { # Define behaviors of speech to text detection. # Settings for speech to text detection. Exposed at the following levels: - Agent level - Flow level - Page level - Parameter level "endpointerSensitivity": 42, # Sensitivity of the speech model that detects the end of speech. Scale from 0 to 100. @@ -12418,8 +12418,8 @@

Method Details

"maxDigits": 42, # Max length of DTMF digits. }, "loggingSettings": { # Define behaviors on logging. # Settings for logging. Settings for Dialogflow History, Contact Center messages, StackDriver logs, and speech logging. Exposed at the following levels: - Agent level. - "enableInteractionLogging": True or False, # If true, DF Interaction logging is currently enabled. - "enableStackdriverLogging": True or False, # If true, StackDriver logging is currently enabled. + "enableInteractionLogging": True or False, # Enables DF Interaction logging. + "enableStackdriverLogging": True or False, # Enables StackDriver logging. }, "speechSettings": { # Define behaviors of speech to text detection. # Settings for speech to text detection. Exposed at the following levels: - Agent level - Flow level - Page level - Parameter level "endpointerSensitivity": 42, # Sensitivity of the speech model that detects the end of speech. Scale from 0 to 100. @@ -12585,8 +12585,8 @@

Method Details

"maxDigits": 42, # Max length of DTMF digits. }, "loggingSettings": { # Define behaviors on logging. # Settings for logging. Settings for Dialogflow History, Contact Center messages, StackDriver logs, and speech logging. Exposed at the following levels: - Agent level. - "enableInteractionLogging": True or False, # If true, DF Interaction logging is currently enabled. - "enableStackdriverLogging": True or False, # If true, StackDriver logging is currently enabled. + "enableInteractionLogging": True or False, # Enables DF Interaction logging. + "enableStackdriverLogging": True or False, # Enables StackDriver logging. }, "speechSettings": { # Define behaviors of speech to text detection. # Settings for speech to text detection. Exposed at the following levels: - Agent level - Flow level - Page level - Parameter level "endpointerSensitivity": 42, # Sensitivity of the speech model that detects the end of speech. Scale from 0 to 100. @@ -12746,8 +12746,8 @@

Method Details

"maxDigits": 42, # Max length of DTMF digits. }, "loggingSettings": { # Define behaviors on logging. # Settings for logging. Settings for Dialogflow History, Contact Center messages, StackDriver logs, and speech logging. Exposed at the following levels: - Agent level. - "enableInteractionLogging": True or False, # If true, DF Interaction logging is currently enabled. - "enableStackdriverLogging": True or False, # If true, StackDriver logging is currently enabled. + "enableInteractionLogging": True or False, # Enables DF Interaction logging. + "enableStackdriverLogging": True or False, # Enables StackDriver logging. }, "speechSettings": { # Define behaviors of speech to text detection. # Settings for speech to text detection. Exposed at the following levels: - Agent level - Flow level - Page level - Parameter level "endpointerSensitivity": 42, # Sensitivity of the speech model that detects the end of speech. Scale from 0 to 100. @@ -13043,8 +13043,8 @@

Method Details

"maxDigits": 42, # Max length of DTMF digits. }, "loggingSettings": { # Define behaviors on logging. # Settings for logging. Settings for Dialogflow History, Contact Center messages, StackDriver logs, and speech logging. Exposed at the following levels: - Agent level. - "enableInteractionLogging": True or False, # If true, DF Interaction logging is currently enabled. - "enableStackdriverLogging": True or False, # If true, StackDriver logging is currently enabled. + "enableInteractionLogging": True or False, # Enables DF Interaction logging. + "enableStackdriverLogging": True or False, # Enables StackDriver logging. }, "speechSettings": { # Define behaviors of speech to text detection. # Settings for speech to text detection. Exposed at the following levels: - Agent level - Flow level - Page level - Parameter level "endpointerSensitivity": 42, # Sensitivity of the speech model that detects the end of speech. Scale from 0 to 100. @@ -13070,8 +13070,8 @@

Method Details

"maxDigits": 42, # Max length of DTMF digits. }, "loggingSettings": { # Define behaviors on logging. # Settings for logging. Settings for Dialogflow History, Contact Center messages, StackDriver logs, and speech logging. Exposed at the following levels: - Agent level. - "enableInteractionLogging": True or False, # If true, DF Interaction logging is currently enabled. - "enableStackdriverLogging": True or False, # If true, StackDriver logging is currently enabled. + "enableInteractionLogging": True or False, # Enables DF Interaction logging. + "enableStackdriverLogging": True or False, # Enables StackDriver logging. }, "speechSettings": { # Define behaviors of speech to text detection. # Settings for speech to text detection. Exposed at the following levels: - Agent level - Flow level - Page level - Parameter level "endpointerSensitivity": 42, # Sensitivity of the speech model that detects the end of speech. Scale from 0 to 100. @@ -13224,8 +13224,8 @@

Method Details

"maxDigits": 42, # Max length of DTMF digits. }, "loggingSettings": { # Define behaviors on logging. # Settings for logging. Settings for Dialogflow History, Contact Center messages, StackDriver logs, and speech logging. Exposed at the following levels: - Agent level. - "enableInteractionLogging": True or False, # If true, DF Interaction logging is currently enabled. - "enableStackdriverLogging": True or False, # If true, StackDriver logging is currently enabled. + "enableInteractionLogging": True or False, # Enables DF Interaction logging. + "enableStackdriverLogging": True or False, # Enables StackDriver logging. }, "speechSettings": { # Define behaviors of speech to text detection. # Settings for speech to text detection. Exposed at the following levels: - Agent level - Flow level - Page level - Parameter level "endpointerSensitivity": 42, # Sensitivity of the speech model that detects the end of speech. Scale from 0 to 100. @@ -13376,8 +13376,8 @@

Method Details

"maxDigits": 42, # Max length of DTMF digits. }, "loggingSettings": { # Define behaviors on logging. # Settings for logging. Settings for Dialogflow History, Contact Center messages, StackDriver logs, and speech logging. Exposed at the following levels: - Agent level. - "enableInteractionLogging": True or False, # If true, DF Interaction logging is currently enabled. - "enableStackdriverLogging": True or False, # If true, StackDriver logging is currently enabled. + "enableInteractionLogging": True or False, # Enables DF Interaction logging. + "enableStackdriverLogging": True or False, # Enables StackDriver logging. }, "speechSettings": { # Define behaviors of speech to text detection. # Settings for speech to text detection. Exposed at the following levels: - Agent level - Flow level - Page level - Parameter level "endpointerSensitivity": 42, # Sensitivity of the speech model that detects the end of speech. Scale from 0 to 100. @@ -13405,8 +13405,8 @@

Method Details

"maxDigits": 42, # Max length of DTMF digits. }, "loggingSettings": { # Define behaviors on logging. # Settings for logging. Settings for Dialogflow History, Contact Center messages, StackDriver logs, and speech logging. Exposed at the following levels: - Agent level. - "enableInteractionLogging": True or False, # If true, DF Interaction logging is currently enabled. - "enableStackdriverLogging": True or False, # If true, StackDriver logging is currently enabled. + "enableInteractionLogging": True or False, # Enables DF Interaction logging. + "enableStackdriverLogging": True or False, # Enables StackDriver logging. }, "speechSettings": { # Define behaviors of speech to text detection. # Settings for speech to text detection. Exposed at the following levels: - Agent level - Flow level - Page level - Parameter level "endpointerSensitivity": 42, # Sensitivity of the speech model that detects the end of speech. Scale from 0 to 100. @@ -13559,8 +13559,8 @@

Method Details

"maxDigits": 42, # Max length of DTMF digits. }, "loggingSettings": { # Define behaviors on logging. # Settings for logging. Settings for Dialogflow History, Contact Center messages, StackDriver logs, and speech logging. Exposed at the following levels: - Agent level. - "enableInteractionLogging": True or False, # If true, DF Interaction logging is currently enabled. - "enableStackdriverLogging": True or False, # If true, StackDriver logging is currently enabled. + "enableInteractionLogging": True or False, # Enables DF Interaction logging. + "enableStackdriverLogging": True or False, # Enables StackDriver logging. }, "speechSettings": { # Define behaviors of speech to text detection. # Settings for speech to text detection. Exposed at the following levels: - Agent level - Flow level - Page level - Parameter level "endpointerSensitivity": 42, # Sensitivity of the speech model that detects the end of speech. Scale from 0 to 100. @@ -13726,8 +13726,8 @@

Method Details

"maxDigits": 42, # Max length of DTMF digits. }, "loggingSettings": { # Define behaviors on logging. # Settings for logging. Settings for Dialogflow History, Contact Center messages, StackDriver logs, and speech logging. Exposed at the following levels: - Agent level. - "enableInteractionLogging": True or False, # If true, DF Interaction logging is currently enabled. - "enableStackdriverLogging": True or False, # If true, StackDriver logging is currently enabled. + "enableInteractionLogging": True or False, # Enables DF Interaction logging. + "enableStackdriverLogging": True or False, # Enables StackDriver logging. }, "speechSettings": { # Define behaviors of speech to text detection. # Settings for speech to text detection. Exposed at the following levels: - Agent level - Flow level - Page level - Parameter level "endpointerSensitivity": 42, # Sensitivity of the speech model that detects the end of speech. Scale from 0 to 100. @@ -13887,8 +13887,8 @@

Method Details

"maxDigits": 42, # Max length of DTMF digits. }, "loggingSettings": { # Define behaviors on logging. # Settings for logging. Settings for Dialogflow History, Contact Center messages, StackDriver logs, and speech logging. Exposed at the following levels: - Agent level. - "enableInteractionLogging": True or False, # If true, DF Interaction logging is currently enabled. - "enableStackdriverLogging": True or False, # If true, StackDriver logging is currently enabled. + "enableInteractionLogging": True or False, # Enables DF Interaction logging. + "enableStackdriverLogging": True or False, # Enables StackDriver logging. }, "speechSettings": { # Define behaviors of speech to text detection. # Settings for speech to text detection. Exposed at the following levels: - Agent level - Flow level - Page level - Parameter level "endpointerSensitivity": 42, # Sensitivity of the speech model that detects the end of speech. Scale from 0 to 100. @@ -14155,8 +14155,8 @@

Method Details

"maxDigits": 42, # Max length of DTMF digits. }, "loggingSettings": { # Define behaviors on logging. # Settings for logging. Settings for Dialogflow History, Contact Center messages, StackDriver logs, and speech logging. Exposed at the following levels: - Agent level. - "enableInteractionLogging": True or False, # If true, DF Interaction logging is currently enabled. - "enableStackdriverLogging": True or False, # If true, StackDriver logging is currently enabled. + "enableInteractionLogging": True or False, # Enables DF Interaction logging. + "enableStackdriverLogging": True or False, # Enables StackDriver logging. }, "speechSettings": { # Define behaviors of speech to text detection. # Settings for speech to text detection. Exposed at the following levels: - Agent level - Flow level - Page level - Parameter level "endpointerSensitivity": 42, # Sensitivity of the speech model that detects the end of speech. Scale from 0 to 100. @@ -14182,8 +14182,8 @@

Method Details

"maxDigits": 42, # Max length of DTMF digits. }, "loggingSettings": { # Define behaviors on logging. # Settings for logging. Settings for Dialogflow History, Contact Center messages, StackDriver logs, and speech logging. Exposed at the following levels: - Agent level. - "enableInteractionLogging": True or False, # If true, DF Interaction logging is currently enabled. - "enableStackdriverLogging": True or False, # If true, StackDriver logging is currently enabled. + "enableInteractionLogging": True or False, # Enables DF Interaction logging. + "enableStackdriverLogging": True or False, # Enables StackDriver logging. }, "speechSettings": { # Define behaviors of speech to text detection. # Settings for speech to text detection. Exposed at the following levels: - Agent level - Flow level - Page level - Parameter level "endpointerSensitivity": 42, # Sensitivity of the speech model that detects the end of speech. Scale from 0 to 100. @@ -14336,8 +14336,8 @@

Method Details

"maxDigits": 42, # Max length of DTMF digits. }, "loggingSettings": { # Define behaviors on logging. # Settings for logging. Settings for Dialogflow History, Contact Center messages, StackDriver logs, and speech logging. Exposed at the following levels: - Agent level. - "enableInteractionLogging": True or False, # If true, DF Interaction logging is currently enabled. - "enableStackdriverLogging": True or False, # If true, StackDriver logging is currently enabled. + "enableInteractionLogging": True or False, # Enables DF Interaction logging. + "enableStackdriverLogging": True or False, # Enables StackDriver logging. }, "speechSettings": { # Define behaviors of speech to text detection. # Settings for speech to text detection. Exposed at the following levels: - Agent level - Flow level - Page level - Parameter level "endpointerSensitivity": 42, # Sensitivity of the speech model that detects the end of speech. Scale from 0 to 100. @@ -14488,8 +14488,8 @@

Method Details

"maxDigits": 42, # Max length of DTMF digits. }, "loggingSettings": { # Define behaviors on logging. # Settings for logging. Settings for Dialogflow History, Contact Center messages, StackDriver logs, and speech logging. Exposed at the following levels: - Agent level. - "enableInteractionLogging": True or False, # If true, DF Interaction logging is currently enabled. - "enableStackdriverLogging": True or False, # If true, StackDriver logging is currently enabled. + "enableInteractionLogging": True or False, # Enables DF Interaction logging. + "enableStackdriverLogging": True or False, # Enables StackDriver logging. }, "speechSettings": { # Define behaviors of speech to text detection. # Settings for speech to text detection. Exposed at the following levels: - Agent level - Flow level - Page level - Parameter level "endpointerSensitivity": 42, # Sensitivity of the speech model that detects the end of speech. Scale from 0 to 100. @@ -14517,8 +14517,8 @@

Method Details

"maxDigits": 42, # Max length of DTMF digits. }, "loggingSettings": { # Define behaviors on logging. # Settings for logging. Settings for Dialogflow History, Contact Center messages, StackDriver logs, and speech logging. Exposed at the following levels: - Agent level. - "enableInteractionLogging": True or False, # If true, DF Interaction logging is currently enabled. - "enableStackdriverLogging": True or False, # If true, StackDriver logging is currently enabled. + "enableInteractionLogging": True or False, # Enables DF Interaction logging. + "enableStackdriverLogging": True or False, # Enables StackDriver logging. }, "speechSettings": { # Define behaviors of speech to text detection. # Settings for speech to text detection. Exposed at the following levels: - Agent level - Flow level - Page level - Parameter level "endpointerSensitivity": 42, # Sensitivity of the speech model that detects the end of speech. Scale from 0 to 100. @@ -14671,8 +14671,8 @@

Method Details

"maxDigits": 42, # Max length of DTMF digits. }, "loggingSettings": { # Define behaviors on logging. # Settings for logging. Settings for Dialogflow History, Contact Center messages, StackDriver logs, and speech logging. Exposed at the following levels: - Agent level. - "enableInteractionLogging": True or False, # If true, DF Interaction logging is currently enabled. - "enableStackdriverLogging": True or False, # If true, StackDriver logging is currently enabled. + "enableInteractionLogging": True or False, # Enables DF Interaction logging. + "enableStackdriverLogging": True or False, # Enables StackDriver logging. }, "speechSettings": { # Define behaviors of speech to text detection. # Settings for speech to text detection. Exposed at the following levels: - Agent level - Flow level - Page level - Parameter level "endpointerSensitivity": 42, # Sensitivity of the speech model that detects the end of speech. Scale from 0 to 100. @@ -14838,8 +14838,8 @@

Method Details

"maxDigits": 42, # Max length of DTMF digits. }, "loggingSettings": { # Define behaviors on logging. # Settings for logging. Settings for Dialogflow History, Contact Center messages, StackDriver logs, and speech logging. Exposed at the following levels: - Agent level. - "enableInteractionLogging": True or False, # If true, DF Interaction logging is currently enabled. - "enableStackdriverLogging": True or False, # If true, StackDriver logging is currently enabled. + "enableInteractionLogging": True or False, # Enables DF Interaction logging. + "enableStackdriverLogging": True or False, # Enables StackDriver logging. }, "speechSettings": { # Define behaviors of speech to text detection. # Settings for speech to text detection. Exposed at the following levels: - Agent level - Flow level - Page level - Parameter level "endpointerSensitivity": 42, # Sensitivity of the speech model that detects the end of speech. Scale from 0 to 100. @@ -14999,8 +14999,8 @@

Method Details

"maxDigits": 42, # Max length of DTMF digits. }, "loggingSettings": { # Define behaviors on logging. # Settings for logging. Settings for Dialogflow History, Contact Center messages, StackDriver logs, and speech logging. Exposed at the following levels: - Agent level. - "enableInteractionLogging": True or False, # If true, DF Interaction logging is currently enabled. - "enableStackdriverLogging": True or False, # If true, StackDriver logging is currently enabled. + "enableInteractionLogging": True or False, # Enables DF Interaction logging. + "enableStackdriverLogging": True or False, # Enables StackDriver logging. }, "speechSettings": { # Define behaviors of speech to text detection. # Settings for speech to text detection. Exposed at the following levels: - Agent level - Flow level - Page level - Parameter level "endpointerSensitivity": 42, # Sensitivity of the speech model that detects the end of speech. Scale from 0 to 100. @@ -15279,8 +15279,8 @@

Method Details

"maxDigits": 42, # Max length of DTMF digits. }, "loggingSettings": { # Define behaviors on logging. # Settings for logging. Settings for Dialogflow History, Contact Center messages, StackDriver logs, and speech logging. Exposed at the following levels: - Agent level. - "enableInteractionLogging": True or False, # If true, DF Interaction logging is currently enabled. - "enableStackdriverLogging": True or False, # If true, StackDriver logging is currently enabled. + "enableInteractionLogging": True or False, # Enables DF Interaction logging. + "enableStackdriverLogging": True or False, # Enables StackDriver logging. }, "speechSettings": { # Define behaviors of speech to text detection. # Settings for speech to text detection. Exposed at the following levels: - Agent level - Flow level - Page level - Parameter level "endpointerSensitivity": 42, # Sensitivity of the speech model that detects the end of speech. Scale from 0 to 100. @@ -15306,8 +15306,8 @@

Method Details

"maxDigits": 42, # Max length of DTMF digits. }, "loggingSettings": { # Define behaviors on logging. # Settings for logging. Settings for Dialogflow History, Contact Center messages, StackDriver logs, and speech logging. Exposed at the following levels: - Agent level. - "enableInteractionLogging": True or False, # If true, DF Interaction logging is currently enabled. - "enableStackdriverLogging": True or False, # If true, StackDriver logging is currently enabled. + "enableInteractionLogging": True or False, # Enables DF Interaction logging. + "enableStackdriverLogging": True or False, # Enables StackDriver logging. }, "speechSettings": { # Define behaviors of speech to text detection. # Settings for speech to text detection. Exposed at the following levels: - Agent level - Flow level - Page level - Parameter level "endpointerSensitivity": 42, # Sensitivity of the speech model that detects the end of speech. Scale from 0 to 100. @@ -15460,8 +15460,8 @@

Method Details

"maxDigits": 42, # Max length of DTMF digits. }, "loggingSettings": { # Define behaviors on logging. # Settings for logging. Settings for Dialogflow History, Contact Center messages, StackDriver logs, and speech logging. Exposed at the following levels: - Agent level. - "enableInteractionLogging": True or False, # If true, DF Interaction logging is currently enabled. - "enableStackdriverLogging": True or False, # If true, StackDriver logging is currently enabled. + "enableInteractionLogging": True or False, # Enables DF Interaction logging. + "enableStackdriverLogging": True or False, # Enables StackDriver logging. }, "speechSettings": { # Define behaviors of speech to text detection. # Settings for speech to text detection. Exposed at the following levels: - Agent level - Flow level - Page level - Parameter level "endpointerSensitivity": 42, # Sensitivity of the speech model that detects the end of speech. Scale from 0 to 100. @@ -15612,8 +15612,8 @@

Method Details

"maxDigits": 42, # Max length of DTMF digits. }, "loggingSettings": { # Define behaviors on logging. # Settings for logging. Settings for Dialogflow History, Contact Center messages, StackDriver logs, and speech logging. Exposed at the following levels: - Agent level. - "enableInteractionLogging": True or False, # If true, DF Interaction logging is currently enabled. - "enableStackdriverLogging": True or False, # If true, StackDriver logging is currently enabled. + "enableInteractionLogging": True or False, # Enables DF Interaction logging. + "enableStackdriverLogging": True or False, # Enables StackDriver logging. }, "speechSettings": { # Define behaviors of speech to text detection. # Settings for speech to text detection. Exposed at the following levels: - Agent level - Flow level - Page level - Parameter level "endpointerSensitivity": 42, # Sensitivity of the speech model that detects the end of speech. Scale from 0 to 100. @@ -15641,8 +15641,8 @@

Method Details

"maxDigits": 42, # Max length of DTMF digits. }, "loggingSettings": { # Define behaviors on logging. # Settings for logging. Settings for Dialogflow History, Contact Center messages, StackDriver logs, and speech logging. Exposed at the following levels: - Agent level. - "enableInteractionLogging": True or False, # If true, DF Interaction logging is currently enabled. - "enableStackdriverLogging": True or False, # If true, StackDriver logging is currently enabled. + "enableInteractionLogging": True or False, # Enables DF Interaction logging. + "enableStackdriverLogging": True or False, # Enables StackDriver logging. }, "speechSettings": { # Define behaviors of speech to text detection. # Settings for speech to text detection. Exposed at the following levels: - Agent level - Flow level - Page level - Parameter level "endpointerSensitivity": 42, # Sensitivity of the speech model that detects the end of speech. Scale from 0 to 100. @@ -15795,8 +15795,8 @@

Method Details

"maxDigits": 42, # Max length of DTMF digits. }, "loggingSettings": { # Define behaviors on logging. # Settings for logging. Settings for Dialogflow History, Contact Center messages, StackDriver logs, and speech logging. Exposed at the following levels: - Agent level. - "enableInteractionLogging": True or False, # If true, DF Interaction logging is currently enabled. - "enableStackdriverLogging": True or False, # If true, StackDriver logging is currently enabled. + "enableInteractionLogging": True or False, # Enables DF Interaction logging. + "enableStackdriverLogging": True or False, # Enables StackDriver logging. }, "speechSettings": { # Define behaviors of speech to text detection. # Settings for speech to text detection. Exposed at the following levels: - Agent level - Flow level - Page level - Parameter level "endpointerSensitivity": 42, # Sensitivity of the speech model that detects the end of speech. Scale from 0 to 100. @@ -15962,8 +15962,8 @@

Method Details

"maxDigits": 42, # Max length of DTMF digits. }, "loggingSettings": { # Define behaviors on logging. # Settings for logging. Settings for Dialogflow History, Contact Center messages, StackDriver logs, and speech logging. Exposed at the following levels: - Agent level. - "enableInteractionLogging": True or False, # If true, DF Interaction logging is currently enabled. - "enableStackdriverLogging": True or False, # If true, StackDriver logging is currently enabled. + "enableInteractionLogging": True or False, # Enables DF Interaction logging. + "enableStackdriverLogging": True or False, # Enables StackDriver logging. }, "speechSettings": { # Define behaviors of speech to text detection. # Settings for speech to text detection. Exposed at the following levels: - Agent level - Flow level - Page level - Parameter level "endpointerSensitivity": 42, # Sensitivity of the speech model that detects the end of speech. Scale from 0 to 100. @@ -16123,8 +16123,8 @@

Method Details

"maxDigits": 42, # Max length of DTMF digits. }, "loggingSettings": { # Define behaviors on logging. # Settings for logging. Settings for Dialogflow History, Contact Center messages, StackDriver logs, and speech logging. Exposed at the following levels: - Agent level. - "enableInteractionLogging": True or False, # If true, DF Interaction logging is currently enabled. - "enableStackdriverLogging": True or False, # If true, StackDriver logging is currently enabled. + "enableInteractionLogging": True or False, # Enables DF Interaction logging. + "enableStackdriverLogging": True or False, # Enables StackDriver logging. }, "speechSettings": { # Define behaviors of speech to text detection. # Settings for speech to text detection. Exposed at the following levels: - Agent level - Flow level - Page level - Parameter level "endpointerSensitivity": 42, # Sensitivity of the speech model that detects the end of speech. Scale from 0 to 100. @@ -16391,8 +16391,8 @@

Method Details

"maxDigits": 42, # Max length of DTMF digits. }, "loggingSettings": { # Define behaviors on logging. # Settings for logging. Settings for Dialogflow History, Contact Center messages, StackDriver logs, and speech logging. Exposed at the following levels: - Agent level. - "enableInteractionLogging": True or False, # If true, DF Interaction logging is currently enabled. - "enableStackdriverLogging": True or False, # If true, StackDriver logging is currently enabled. + "enableInteractionLogging": True or False, # Enables DF Interaction logging. + "enableStackdriverLogging": True or False, # Enables StackDriver logging. }, "speechSettings": { # Define behaviors of speech to text detection. # Settings for speech to text detection. Exposed at the following levels: - Agent level - Flow level - Page level - Parameter level "endpointerSensitivity": 42, # Sensitivity of the speech model that detects the end of speech. Scale from 0 to 100. @@ -16418,8 +16418,8 @@

Method Details

"maxDigits": 42, # Max length of DTMF digits. }, "loggingSettings": { # Define behaviors on logging. # Settings for logging. Settings for Dialogflow History, Contact Center messages, StackDriver logs, and speech logging. Exposed at the following levels: - Agent level. - "enableInteractionLogging": True or False, # If true, DF Interaction logging is currently enabled. - "enableStackdriverLogging": True or False, # If true, StackDriver logging is currently enabled. + "enableInteractionLogging": True or False, # Enables DF Interaction logging. + "enableStackdriverLogging": True or False, # Enables StackDriver logging. }, "speechSettings": { # Define behaviors of speech to text detection. # Settings for speech to text detection. Exposed at the following levels: - Agent level - Flow level - Page level - Parameter level "endpointerSensitivity": 42, # Sensitivity of the speech model that detects the end of speech. Scale from 0 to 100. @@ -16572,8 +16572,8 @@

Method Details

"maxDigits": 42, # Max length of DTMF digits. }, "loggingSettings": { # Define behaviors on logging. # Settings for logging. Settings for Dialogflow History, Contact Center messages, StackDriver logs, and speech logging. Exposed at the following levels: - Agent level. - "enableInteractionLogging": True or False, # If true, DF Interaction logging is currently enabled. - "enableStackdriverLogging": True or False, # If true, StackDriver logging is currently enabled. + "enableInteractionLogging": True or False, # Enables DF Interaction logging. + "enableStackdriverLogging": True or False, # Enables StackDriver logging. }, "speechSettings": { # Define behaviors of speech to text detection. # Settings for speech to text detection. Exposed at the following levels: - Agent level - Flow level - Page level - Parameter level "endpointerSensitivity": 42, # Sensitivity of the speech model that detects the end of speech. Scale from 0 to 100. @@ -16724,8 +16724,8 @@

Method Details

"maxDigits": 42, # Max length of DTMF digits. }, "loggingSettings": { # Define behaviors on logging. # Settings for logging. Settings for Dialogflow History, Contact Center messages, StackDriver logs, and speech logging. Exposed at the following levels: - Agent level. - "enableInteractionLogging": True or False, # If true, DF Interaction logging is currently enabled. - "enableStackdriverLogging": True or False, # If true, StackDriver logging is currently enabled. + "enableInteractionLogging": True or False, # Enables DF Interaction logging. + "enableStackdriverLogging": True or False, # Enables StackDriver logging. }, "speechSettings": { # Define behaviors of speech to text detection. # Settings for speech to text detection. Exposed at the following levels: - Agent level - Flow level - Page level - Parameter level "endpointerSensitivity": 42, # Sensitivity of the speech model that detects the end of speech. Scale from 0 to 100. @@ -16753,8 +16753,8 @@

Method Details

"maxDigits": 42, # Max length of DTMF digits. }, "loggingSettings": { # Define behaviors on logging. # Settings for logging. Settings for Dialogflow History, Contact Center messages, StackDriver logs, and speech logging. Exposed at the following levels: - Agent level. - "enableInteractionLogging": True or False, # If true, DF Interaction logging is currently enabled. - "enableStackdriverLogging": True or False, # If true, StackDriver logging is currently enabled. + "enableInteractionLogging": True or False, # Enables DF Interaction logging. + "enableStackdriverLogging": True or False, # Enables StackDriver logging. }, "speechSettings": { # Define behaviors of speech to text detection. # Settings for speech to text detection. Exposed at the following levels: - Agent level - Flow level - Page level - Parameter level "endpointerSensitivity": 42, # Sensitivity of the speech model that detects the end of speech. Scale from 0 to 100. @@ -16907,8 +16907,8 @@

Method Details

"maxDigits": 42, # Max length of DTMF digits. }, "loggingSettings": { # Define behaviors on logging. # Settings for logging. Settings for Dialogflow History, Contact Center messages, StackDriver logs, and speech logging. Exposed at the following levels: - Agent level. - "enableInteractionLogging": True or False, # If true, DF Interaction logging is currently enabled. - "enableStackdriverLogging": True or False, # If true, StackDriver logging is currently enabled. + "enableInteractionLogging": True or False, # Enables DF Interaction logging. + "enableStackdriverLogging": True or False, # Enables StackDriver logging. }, "speechSettings": { # Define behaviors of speech to text detection. # Settings for speech to text detection. Exposed at the following levels: - Agent level - Flow level - Page level - Parameter level "endpointerSensitivity": 42, # Sensitivity of the speech model that detects the end of speech. Scale from 0 to 100. @@ -17074,8 +17074,8 @@

Method Details

"maxDigits": 42, # Max length of DTMF digits. }, "loggingSettings": { # Define behaviors on logging. # Settings for logging. Settings for Dialogflow History, Contact Center messages, StackDriver logs, and speech logging. Exposed at the following levels: - Agent level. - "enableInteractionLogging": True or False, # If true, DF Interaction logging is currently enabled. - "enableStackdriverLogging": True or False, # If true, StackDriver logging is currently enabled. + "enableInteractionLogging": True or False, # Enables DF Interaction logging. + "enableStackdriverLogging": True or False, # Enables StackDriver logging. }, "speechSettings": { # Define behaviors of speech to text detection. # Settings for speech to text detection. Exposed at the following levels: - Agent level - Flow level - Page level - Parameter level "endpointerSensitivity": 42, # Sensitivity of the speech model that detects the end of speech. Scale from 0 to 100. @@ -17235,8 +17235,8 @@

Method Details

"maxDigits": 42, # Max length of DTMF digits. }, "loggingSettings": { # Define behaviors on logging. # Settings for logging. Settings for Dialogflow History, Contact Center messages, StackDriver logs, and speech logging. Exposed at the following levels: - Agent level. - "enableInteractionLogging": True or False, # If true, DF Interaction logging is currently enabled. - "enableStackdriverLogging": True or False, # If true, StackDriver logging is currently enabled. + "enableInteractionLogging": True or False, # Enables DF Interaction logging. + "enableStackdriverLogging": True or False, # Enables StackDriver logging. }, "speechSettings": { # Define behaviors of speech to text detection. # Settings for speech to text detection. Exposed at the following levels: - Agent level - Flow level - Page level - Parameter level "endpointerSensitivity": 42, # Sensitivity of the speech model that detects the end of speech. Scale from 0 to 100. diff --git a/docs/dyn/dialogflow_v3.projects.locations.agents.testCases.results.html b/docs/dyn/dialogflow_v3.projects.locations.agents.testCases.results.html index edccc875e79..fd26293be46 100644 --- a/docs/dyn/dialogflow_v3.projects.locations.agents.testCases.results.html +++ b/docs/dyn/dialogflow_v3.projects.locations.agents.testCases.results.html @@ -165,8 +165,8 @@

Method Details

"maxDigits": 42, # Max length of DTMF digits. }, "loggingSettings": { # Define behaviors on logging. # Settings for logging. Settings for Dialogflow History, Contact Center messages, StackDriver logs, and speech logging. Exposed at the following levels: - Agent level. - "enableInteractionLogging": True or False, # If true, DF Interaction logging is currently enabled. - "enableStackdriverLogging": True or False, # If true, StackDriver logging is currently enabled. + "enableInteractionLogging": True or False, # Enables DF Interaction logging. + "enableStackdriverLogging": True or False, # Enables StackDriver logging. }, "speechSettings": { # Define behaviors of speech to text detection. # Settings for speech to text detection. Exposed at the following levels: - Agent level - Flow level - Page level - Parameter level "endpointerSensitivity": 42, # Sensitivity of the speech model that detects the end of speech. Scale from 0 to 100. @@ -192,8 +192,8 @@

Method Details

"maxDigits": 42, # Max length of DTMF digits. }, "loggingSettings": { # Define behaviors on logging. # Settings for logging. Settings for Dialogflow History, Contact Center messages, StackDriver logs, and speech logging. Exposed at the following levels: - Agent level. - "enableInteractionLogging": True or False, # If true, DF Interaction logging is currently enabled. - "enableStackdriverLogging": True or False, # If true, StackDriver logging is currently enabled. + "enableInteractionLogging": True or False, # Enables DF Interaction logging. + "enableStackdriverLogging": True or False, # Enables StackDriver logging. }, "speechSettings": { # Define behaviors of speech to text detection. # Settings for speech to text detection. Exposed at the following levels: - Agent level - Flow level - Page level - Parameter level "endpointerSensitivity": 42, # Sensitivity of the speech model that detects the end of speech. Scale from 0 to 100. @@ -346,8 +346,8 @@

Method Details

"maxDigits": 42, # Max length of DTMF digits. }, "loggingSettings": { # Define behaviors on logging. # Settings for logging. Settings for Dialogflow History, Contact Center messages, StackDriver logs, and speech logging. Exposed at the following levels: - Agent level. - "enableInteractionLogging": True or False, # If true, DF Interaction logging is currently enabled. - "enableStackdriverLogging": True or False, # If true, StackDriver logging is currently enabled. + "enableInteractionLogging": True or False, # Enables DF Interaction logging. + "enableStackdriverLogging": True or False, # Enables StackDriver logging. }, "speechSettings": { # Define behaviors of speech to text detection. # Settings for speech to text detection. Exposed at the following levels: - Agent level - Flow level - Page level - Parameter level "endpointerSensitivity": 42, # Sensitivity of the speech model that detects the end of speech. Scale from 0 to 100. @@ -498,8 +498,8 @@

Method Details

"maxDigits": 42, # Max length of DTMF digits. }, "loggingSettings": { # Define behaviors on logging. # Settings for logging. Settings for Dialogflow History, Contact Center messages, StackDriver logs, and speech logging. Exposed at the following levels: - Agent level. - "enableInteractionLogging": True or False, # If true, DF Interaction logging is currently enabled. - "enableStackdriverLogging": True or False, # If true, StackDriver logging is currently enabled. + "enableInteractionLogging": True or False, # Enables DF Interaction logging. + "enableStackdriverLogging": True or False, # Enables StackDriver logging. }, "speechSettings": { # Define behaviors of speech to text detection. # Settings for speech to text detection. Exposed at the following levels: - Agent level - Flow level - Page level - Parameter level "endpointerSensitivity": 42, # Sensitivity of the speech model that detects the end of speech. Scale from 0 to 100. @@ -527,8 +527,8 @@

Method Details

"maxDigits": 42, # Max length of DTMF digits. }, "loggingSettings": { # Define behaviors on logging. # Settings for logging. Settings for Dialogflow History, Contact Center messages, StackDriver logs, and speech logging. Exposed at the following levels: - Agent level. - "enableInteractionLogging": True or False, # If true, DF Interaction logging is currently enabled. - "enableStackdriverLogging": True or False, # If true, StackDriver logging is currently enabled. + "enableInteractionLogging": True or False, # Enables DF Interaction logging. + "enableStackdriverLogging": True or False, # Enables StackDriver logging. }, "speechSettings": { # Define behaviors of speech to text detection. # Settings for speech to text detection. Exposed at the following levels: - Agent level - Flow level - Page level - Parameter level "endpointerSensitivity": 42, # Sensitivity of the speech model that detects the end of speech. Scale from 0 to 100. @@ -681,8 +681,8 @@

Method Details

"maxDigits": 42, # Max length of DTMF digits. }, "loggingSettings": { # Define behaviors on logging. # Settings for logging. Settings for Dialogflow History, Contact Center messages, StackDriver logs, and speech logging. Exposed at the following levels: - Agent level. - "enableInteractionLogging": True or False, # If true, DF Interaction logging is currently enabled. - "enableStackdriverLogging": True or False, # If true, StackDriver logging is currently enabled. + "enableInteractionLogging": True or False, # Enables DF Interaction logging. + "enableStackdriverLogging": True or False, # Enables StackDriver logging. }, "speechSettings": { # Define behaviors of speech to text detection. # Settings for speech to text detection. Exposed at the following levels: - Agent level - Flow level - Page level - Parameter level "endpointerSensitivity": 42, # Sensitivity of the speech model that detects the end of speech. Scale from 0 to 100. @@ -848,8 +848,8 @@

Method Details

"maxDigits": 42, # Max length of DTMF digits. }, "loggingSettings": { # Define behaviors on logging. # Settings for logging. Settings for Dialogflow History, Contact Center messages, StackDriver logs, and speech logging. Exposed at the following levels: - Agent level. - "enableInteractionLogging": True or False, # If true, DF Interaction logging is currently enabled. - "enableStackdriverLogging": True or False, # If true, StackDriver logging is currently enabled. + "enableInteractionLogging": True or False, # Enables DF Interaction logging. + "enableStackdriverLogging": True or False, # Enables StackDriver logging. }, "speechSettings": { # Define behaviors of speech to text detection. # Settings for speech to text detection. Exposed at the following levels: - Agent level - Flow level - Page level - Parameter level "endpointerSensitivity": 42, # Sensitivity of the speech model that detects the end of speech. Scale from 0 to 100. @@ -1009,8 +1009,8 @@

Method Details

"maxDigits": 42, # Max length of DTMF digits. }, "loggingSettings": { # Define behaviors on logging. # Settings for logging. Settings for Dialogflow History, Contact Center messages, StackDriver logs, and speech logging. Exposed at the following levels: - Agent level. - "enableInteractionLogging": True or False, # If true, DF Interaction logging is currently enabled. - "enableStackdriverLogging": True or False, # If true, StackDriver logging is currently enabled. + "enableInteractionLogging": True or False, # Enables DF Interaction logging. + "enableStackdriverLogging": True or False, # Enables StackDriver logging. }, "speechSettings": { # Define behaviors of speech to text detection. # Settings for speech to text detection. Exposed at the following levels: - Agent level - Flow level - Page level - Parameter level "endpointerSensitivity": 42, # Sensitivity of the speech model that detects the end of speech. Scale from 0 to 100. @@ -1295,8 +1295,8 @@

Method Details

"maxDigits": 42, # Max length of DTMF digits. }, "loggingSettings": { # Define behaviors on logging. # Settings for logging. Settings for Dialogflow History, Contact Center messages, StackDriver logs, and speech logging. Exposed at the following levels: - Agent level. - "enableInteractionLogging": True or False, # If true, DF Interaction logging is currently enabled. - "enableStackdriverLogging": True or False, # If true, StackDriver logging is currently enabled. + "enableInteractionLogging": True or False, # Enables DF Interaction logging. + "enableStackdriverLogging": True or False, # Enables StackDriver logging. }, "speechSettings": { # Define behaviors of speech to text detection. # Settings for speech to text detection. Exposed at the following levels: - Agent level - Flow level - Page level - Parameter level "endpointerSensitivity": 42, # Sensitivity of the speech model that detects the end of speech. Scale from 0 to 100. @@ -1322,8 +1322,8 @@

Method Details

"maxDigits": 42, # Max length of DTMF digits. }, "loggingSettings": { # Define behaviors on logging. # Settings for logging. Settings for Dialogflow History, Contact Center messages, StackDriver logs, and speech logging. Exposed at the following levels: - Agent level. - "enableInteractionLogging": True or False, # If true, DF Interaction logging is currently enabled. - "enableStackdriverLogging": True or False, # If true, StackDriver logging is currently enabled. + "enableInteractionLogging": True or False, # Enables DF Interaction logging. + "enableStackdriverLogging": True or False, # Enables StackDriver logging. }, "speechSettings": { # Define behaviors of speech to text detection. # Settings for speech to text detection. Exposed at the following levels: - Agent level - Flow level - Page level - Parameter level "endpointerSensitivity": 42, # Sensitivity of the speech model that detects the end of speech. Scale from 0 to 100. @@ -1476,8 +1476,8 @@

Method Details

"maxDigits": 42, # Max length of DTMF digits. }, "loggingSettings": { # Define behaviors on logging. # Settings for logging. Settings for Dialogflow History, Contact Center messages, StackDriver logs, and speech logging. Exposed at the following levels: - Agent level. - "enableInteractionLogging": True or False, # If true, DF Interaction logging is currently enabled. - "enableStackdriverLogging": True or False, # If true, StackDriver logging is currently enabled. + "enableInteractionLogging": True or False, # Enables DF Interaction logging. + "enableStackdriverLogging": True or False, # Enables StackDriver logging. }, "speechSettings": { # Define behaviors of speech to text detection. # Settings for speech to text detection. Exposed at the following levels: - Agent level - Flow level - Page level - Parameter level "endpointerSensitivity": 42, # Sensitivity of the speech model that detects the end of speech. Scale from 0 to 100. @@ -1628,8 +1628,8 @@

Method Details

"maxDigits": 42, # Max length of DTMF digits. }, "loggingSettings": { # Define behaviors on logging. # Settings for logging. Settings for Dialogflow History, Contact Center messages, StackDriver logs, and speech logging. Exposed at the following levels: - Agent level. - "enableInteractionLogging": True or False, # If true, DF Interaction logging is currently enabled. - "enableStackdriverLogging": True or False, # If true, StackDriver logging is currently enabled. + "enableInteractionLogging": True or False, # Enables DF Interaction logging. + "enableStackdriverLogging": True or False, # Enables StackDriver logging. }, "speechSettings": { # Define behaviors of speech to text detection. # Settings for speech to text detection. Exposed at the following levels: - Agent level - Flow level - Page level - Parameter level "endpointerSensitivity": 42, # Sensitivity of the speech model that detects the end of speech. Scale from 0 to 100. @@ -1657,8 +1657,8 @@

Method Details

"maxDigits": 42, # Max length of DTMF digits. }, "loggingSettings": { # Define behaviors on logging. # Settings for logging. Settings for Dialogflow History, Contact Center messages, StackDriver logs, and speech logging. Exposed at the following levels: - Agent level. - "enableInteractionLogging": True or False, # If true, DF Interaction logging is currently enabled. - "enableStackdriverLogging": True or False, # If true, StackDriver logging is currently enabled. + "enableInteractionLogging": True or False, # Enables DF Interaction logging. + "enableStackdriverLogging": True or False, # Enables StackDriver logging. }, "speechSettings": { # Define behaviors of speech to text detection. # Settings for speech to text detection. Exposed at the following levels: - Agent level - Flow level - Page level - Parameter level "endpointerSensitivity": 42, # Sensitivity of the speech model that detects the end of speech. Scale from 0 to 100. @@ -1811,8 +1811,8 @@

Method Details

"maxDigits": 42, # Max length of DTMF digits. }, "loggingSettings": { # Define behaviors on logging. # Settings for logging. Settings for Dialogflow History, Contact Center messages, StackDriver logs, and speech logging. Exposed at the following levels: - Agent level. - "enableInteractionLogging": True or False, # If true, DF Interaction logging is currently enabled. - "enableStackdriverLogging": True or False, # If true, StackDriver logging is currently enabled. + "enableInteractionLogging": True or False, # Enables DF Interaction logging. + "enableStackdriverLogging": True or False, # Enables StackDriver logging. }, "speechSettings": { # Define behaviors of speech to text detection. # Settings for speech to text detection. Exposed at the following levels: - Agent level - Flow level - Page level - Parameter level "endpointerSensitivity": 42, # Sensitivity of the speech model that detects the end of speech. Scale from 0 to 100. @@ -1978,8 +1978,8 @@

Method Details

"maxDigits": 42, # Max length of DTMF digits. }, "loggingSettings": { # Define behaviors on logging. # Settings for logging. Settings for Dialogflow History, Contact Center messages, StackDriver logs, and speech logging. Exposed at the following levels: - Agent level. - "enableInteractionLogging": True or False, # If true, DF Interaction logging is currently enabled. - "enableStackdriverLogging": True or False, # If true, StackDriver logging is currently enabled. + "enableInteractionLogging": True or False, # Enables DF Interaction logging. + "enableStackdriverLogging": True or False, # Enables StackDriver logging. }, "speechSettings": { # Define behaviors of speech to text detection. # Settings for speech to text detection. Exposed at the following levels: - Agent level - Flow level - Page level - Parameter level "endpointerSensitivity": 42, # Sensitivity of the speech model that detects the end of speech. Scale from 0 to 100. @@ -2139,8 +2139,8 @@

Method Details

"maxDigits": 42, # Max length of DTMF digits. }, "loggingSettings": { # Define behaviors on logging. # Settings for logging. Settings for Dialogflow History, Contact Center messages, StackDriver logs, and speech logging. Exposed at the following levels: - Agent level. - "enableInteractionLogging": True or False, # If true, DF Interaction logging is currently enabled. - "enableStackdriverLogging": True or False, # If true, StackDriver logging is currently enabled. + "enableInteractionLogging": True or False, # Enables DF Interaction logging. + "enableStackdriverLogging": True or False, # Enables StackDriver logging. }, "speechSettings": { # Define behaviors of speech to text detection. # Settings for speech to text detection. Exposed at the following levels: - Agent level - Flow level - Page level - Parameter level "endpointerSensitivity": 42, # Sensitivity of the speech model that detects the end of speech. Scale from 0 to 100. diff --git a/docs/dyn/dialogflow_v3.projects.locations.agents.transitionRouteGroups.html b/docs/dyn/dialogflow_v3.projects.locations.agents.transitionRouteGroups.html index 87b0116db42..8277a93481a 100644 --- a/docs/dyn/dialogflow_v3.projects.locations.agents.transitionRouteGroups.html +++ b/docs/dyn/dialogflow_v3.projects.locations.agents.transitionRouteGroups.html @@ -134,8 +134,8 @@

Method Details

"maxDigits": 42, # Max length of DTMF digits. }, "loggingSettings": { # Define behaviors on logging. # Settings for logging. Settings for Dialogflow History, Contact Center messages, StackDriver logs, and speech logging. Exposed at the following levels: - Agent level. - "enableInteractionLogging": True or False, # If true, DF Interaction logging is currently enabled. - "enableStackdriverLogging": True or False, # If true, StackDriver logging is currently enabled. + "enableInteractionLogging": True or False, # Enables DF Interaction logging. + "enableStackdriverLogging": True or False, # Enables StackDriver logging. }, "speechSettings": { # Define behaviors of speech to text detection. # Settings for speech to text detection. Exposed at the following levels: - Agent level - Flow level - Page level - Parameter level "endpointerSensitivity": 42, # Sensitivity of the speech model that detects the end of speech. Scale from 0 to 100. @@ -306,8 +306,8 @@

Method Details

"maxDigits": 42, # Max length of DTMF digits. }, "loggingSettings": { # Define behaviors on logging. # Settings for logging. Settings for Dialogflow History, Contact Center messages, StackDriver logs, and speech logging. Exposed at the following levels: - Agent level. - "enableInteractionLogging": True or False, # If true, DF Interaction logging is currently enabled. - "enableStackdriverLogging": True or False, # If true, StackDriver logging is currently enabled. + "enableInteractionLogging": True or False, # Enables DF Interaction logging. + "enableStackdriverLogging": True or False, # Enables StackDriver logging. }, "speechSettings": { # Define behaviors of speech to text detection. # Settings for speech to text detection. Exposed at the following levels: - Agent level - Flow level - Page level - Parameter level "endpointerSensitivity": 42, # Sensitivity of the speech model that detects the end of speech. Scale from 0 to 100. @@ -504,8 +504,8 @@

Method Details

"maxDigits": 42, # Max length of DTMF digits. }, "loggingSettings": { # Define behaviors on logging. # Settings for logging. Settings for Dialogflow History, Contact Center messages, StackDriver logs, and speech logging. Exposed at the following levels: - Agent level. - "enableInteractionLogging": True or False, # If true, DF Interaction logging is currently enabled. - "enableStackdriverLogging": True or False, # If true, StackDriver logging is currently enabled. + "enableInteractionLogging": True or False, # Enables DF Interaction logging. + "enableStackdriverLogging": True or False, # Enables StackDriver logging. }, "speechSettings": { # Define behaviors of speech to text detection. # Settings for speech to text detection. Exposed at the following levels: - Agent level - Flow level - Page level - Parameter level "endpointerSensitivity": 42, # Sensitivity of the speech model that detects the end of speech. Scale from 0 to 100. @@ -688,8 +688,8 @@

Method Details

"maxDigits": 42, # Max length of DTMF digits. }, "loggingSettings": { # Define behaviors on logging. # Settings for logging. Settings for Dialogflow History, Contact Center messages, StackDriver logs, and speech logging. Exposed at the following levels: - Agent level. - "enableInteractionLogging": True or False, # If true, DF Interaction logging is currently enabled. - "enableStackdriverLogging": True or False, # If true, StackDriver logging is currently enabled. + "enableInteractionLogging": True or False, # Enables DF Interaction logging. + "enableStackdriverLogging": True or False, # Enables StackDriver logging. }, "speechSettings": { # Define behaviors of speech to text detection. # Settings for speech to text detection. Exposed at the following levels: - Agent level - Flow level - Page level - Parameter level "endpointerSensitivity": 42, # Sensitivity of the speech model that detects the end of speech. Scale from 0 to 100. @@ -877,8 +877,8 @@

Method Details

"maxDigits": 42, # Max length of DTMF digits. }, "loggingSettings": { # Define behaviors on logging. # Settings for logging. Settings for Dialogflow History, Contact Center messages, StackDriver logs, and speech logging. Exposed at the following levels: - Agent level. - "enableInteractionLogging": True or False, # If true, DF Interaction logging is currently enabled. - "enableStackdriverLogging": True or False, # If true, StackDriver logging is currently enabled. + "enableInteractionLogging": True or False, # Enables DF Interaction logging. + "enableStackdriverLogging": True or False, # Enables StackDriver logging. }, "speechSettings": { # Define behaviors of speech to text detection. # Settings for speech to text detection. Exposed at the following levels: - Agent level - Flow level - Page level - Parameter level "endpointerSensitivity": 42, # Sensitivity of the speech model that detects the end of speech. Scale from 0 to 100. @@ -1050,8 +1050,8 @@

Method Details

"maxDigits": 42, # Max length of DTMF digits. }, "loggingSettings": { # Define behaviors on logging. # Settings for logging. Settings for Dialogflow History, Contact Center messages, StackDriver logs, and speech logging. Exposed at the following levels: - Agent level. - "enableInteractionLogging": True or False, # If true, DF Interaction logging is currently enabled. - "enableStackdriverLogging": True or False, # If true, StackDriver logging is currently enabled. + "enableInteractionLogging": True or False, # Enables DF Interaction logging. + "enableStackdriverLogging": True or False, # Enables StackDriver logging. }, "speechSettings": { # Define behaviors of speech to text detection. # Settings for speech to text detection. Exposed at the following levels: - Agent level - Flow level - Page level - Parameter level "endpointerSensitivity": 42, # Sensitivity of the speech model that detects the end of speech. Scale from 0 to 100. diff --git a/docs/dyn/dialogflow_v3beta1.projects.locations.agents.conversations.html b/docs/dyn/dialogflow_v3beta1.projects.locations.agents.conversations.html index 99b191ad44d..1dd4b87b981 100644 --- a/docs/dyn/dialogflow_v3beta1.projects.locations.agents.conversations.html +++ b/docs/dyn/dialogflow_v3beta1.projects.locations.agents.conversations.html @@ -229,8 +229,8 @@

Method Details

"maxDigits": 42, # Max length of DTMF digits. }, "loggingSettings": { # Define behaviors on logging. # Settings for logging. Settings for Dialogflow History, Contact Center messages, StackDriver logs, and speech logging. Exposed at the following levels: - Agent level. - "enableInteractionLogging": True or False, # If true, DF Interaction logging is currently enabled. - "enableStackdriverLogging": True or False, # If true, StackDriver logging is currently enabled. + "enableInteractionLogging": True or False, # Enables DF Interaction logging. + "enableStackdriverLogging": True or False, # Enables StackDriver logging. }, "speechSettings": { # Define behaviors of speech to text detection. # Settings for speech to text detection. Exposed at the following levels: - Agent level - Flow level - Page level - Parameter level "endpointerSensitivity": 42, # Sensitivity of the speech model that detects the end of speech. Scale from 0 to 100. @@ -262,8 +262,8 @@

Method Details

"maxDigits": 42, # Max length of DTMF digits. }, "loggingSettings": { # Define behaviors on logging. # Settings for logging. Settings for Dialogflow History, Contact Center messages, StackDriver logs, and speech logging. Exposed at the following levels: - Agent level. - "enableInteractionLogging": True or False, # If true, DF Interaction logging is currently enabled. - "enableStackdriverLogging": True or False, # If true, StackDriver logging is currently enabled. + "enableInteractionLogging": True or False, # Enables DF Interaction logging. + "enableStackdriverLogging": True or False, # Enables StackDriver logging. }, "speechSettings": { # Define behaviors of speech to text detection. # Settings for speech to text detection. Exposed at the following levels: - Agent level - Flow level - Page level - Parameter level "endpointerSensitivity": 42, # Sensitivity of the speech model that detects the end of speech. Scale from 0 to 100. @@ -327,6 +327,13 @@

Method Details

"A String", ], }, + "toolCall": { # Represents a call of a specific tool's action with the specified inputs. # Returns the definition of a tool call that should be executed by the client. + "action": "A String", # Required. The name of the tool's action associated with this call. + "inputParameters": { # Optional. The action's input parameters. + "a_key": "", # Properties of the object. + }, + "tool": "A String", # Required. The tool associated with this call. Format: `projects//locations//agents//tools/`. + }, }, }, ], @@ -383,6 +390,13 @@

Method Details

"A String", ], }, + "toolCall": { # Represents a call of a specific tool's action with the specified inputs. # Returns the definition of a tool call that should be executed by the client. + "action": "A String", # Required. The name of the tool's action associated with this call. + "inputParameters": { # Optional. The action's input parameters. + "a_key": "", # Properties of the object. + }, + "tool": "A String", # Required. The tool associated with this call. Format: `projects//locations//agents//tools/`. + }, }, ], "returnPartialResponses": True or False, # Whether Dialogflow should return currently queued fulfillment response messages in streaming APIs. If a webhook is specified, it happens before Dialogflow invokes webhook. Warning: 1) This flag only affects streaming API. Responses are still queued and returned once in non-streaming API. 2) The flag can be enabled in any fulfillment but only the first 3 partial responses will be returned. You may only want to apply it to fulfillments that have slow webhooks. @@ -420,8 +434,8 @@

Method Details

"maxDigits": 42, # Max length of DTMF digits. }, "loggingSettings": { # Define behaviors on logging. # Settings for logging. Settings for Dialogflow History, Contact Center messages, StackDriver logs, and speech logging. Exposed at the following levels: - Agent level. - "enableInteractionLogging": True or False, # If true, DF Interaction logging is currently enabled. - "enableStackdriverLogging": True or False, # If true, StackDriver logging is currently enabled. + "enableInteractionLogging": True or False, # Enables DF Interaction logging. + "enableStackdriverLogging": True or False, # Enables StackDriver logging. }, "speechSettings": { # Define behaviors of speech to text detection. # Settings for speech to text detection. Exposed at the following levels: - Agent level - Flow level - Page level - Parameter level "endpointerSensitivity": 42, # Sensitivity of the speech model that detects the end of speech. Scale from 0 to 100. @@ -485,6 +499,13 @@

Method Details

"A String", ], }, + "toolCall": { # Represents a call of a specific tool's action with the specified inputs. # Returns the definition of a tool call that should be executed by the client. + "action": "A String", # Required. The name of the tool's action associated with this call. + "inputParameters": { # Optional. The action's input parameters. + "a_key": "", # Properties of the object. + }, + "tool": "A String", # Required. The tool associated with this call. Format: `projects//locations//agents//tools/`. + }, }, }, ], @@ -541,6 +562,13 @@

Method Details

"A String", ], }, + "toolCall": { # Represents a call of a specific tool's action with the specified inputs. # Returns the definition of a tool call that should be executed by the client. + "action": "A String", # Required. The name of the tool's action associated with this call. + "inputParameters": { # Optional. The action's input parameters. + "a_key": "", # Properties of the object. + }, + "tool": "A String", # Required. The tool associated with this call. Format: `projects//locations//agents//tools/`. + }, }, ], "returnPartialResponses": True or False, # Whether Dialogflow should return currently queued fulfillment response messages in streaming APIs. If a webhook is specified, it happens before Dialogflow invokes webhook. Warning: 1) This flag only affects streaming API. Responses are still queued and returned once in non-streaming API. 2) The flag can be enabled in any fulfillment but only the first 3 partial responses will be returned. You may only want to apply it to fulfillments that have slow webhooks. @@ -590,8 +618,8 @@

Method Details

"maxDigits": 42, # Max length of DTMF digits. }, "loggingSettings": { # Define behaviors on logging. # Settings for logging. Settings for Dialogflow History, Contact Center messages, StackDriver logs, and speech logging. Exposed at the following levels: - Agent level. - "enableInteractionLogging": True or False, # If true, DF Interaction logging is currently enabled. - "enableStackdriverLogging": True or False, # If true, StackDriver logging is currently enabled. + "enableInteractionLogging": True or False, # Enables DF Interaction logging. + "enableStackdriverLogging": True or False, # Enables StackDriver logging. }, "speechSettings": { # Define behaviors of speech to text detection. # Settings for speech to text detection. Exposed at the following levels: - Agent level - Flow level - Page level - Parameter level "endpointerSensitivity": 42, # Sensitivity of the speech model that detects the end of speech. Scale from 0 to 100. @@ -655,6 +683,13 @@

Method Details

"A String", ], }, + "toolCall": { # Represents a call of a specific tool's action with the specified inputs. # Returns the definition of a tool call that should be executed by the client. + "action": "A String", # Required. The name of the tool's action associated with this call. + "inputParameters": { # Optional. The action's input parameters. + "a_key": "", # Properties of the object. + }, + "tool": "A String", # Required. The tool associated with this call. Format: `projects//locations//agents//tools/`. + }, }, }, ], @@ -711,6 +746,13 @@

Method Details

"A String", ], }, + "toolCall": { # Represents a call of a specific tool's action with the specified inputs. # Returns the definition of a tool call that should be executed by the client. + "action": "A String", # Required. The name of the tool's action associated with this call. + "inputParameters": { # Optional. The action's input parameters. + "a_key": "", # Properties of the object. + }, + "tool": "A String", # Required. The tool associated with this call. Format: `projects//locations//agents//tools/`. + }, }, ], "returnPartialResponses": True or False, # Whether Dialogflow should return currently queued fulfillment response messages in streaming APIs. If a webhook is specified, it happens before Dialogflow invokes webhook. Warning: 1) This flag only affects streaming API. Responses are still queued and returned once in non-streaming API. 2) The flag can be enabled in any fulfillment but only the first 3 partial responses will be returned. You may only want to apply it to fulfillments that have slow webhooks. @@ -799,8 +841,8 @@

Method Details

"maxDigits": 42, # Max length of DTMF digits. }, "loggingSettings": { # Define behaviors on logging. # Settings for logging. Settings for Dialogflow History, Contact Center messages, StackDriver logs, and speech logging. Exposed at the following levels: - Agent level. - "enableInteractionLogging": True or False, # If true, DF Interaction logging is currently enabled. - "enableStackdriverLogging": True or False, # If true, StackDriver logging is currently enabled. + "enableInteractionLogging": True or False, # Enables DF Interaction logging. + "enableStackdriverLogging": True or False, # Enables StackDriver logging. }, "speechSettings": { # Define behaviors of speech to text detection. # Settings for speech to text detection. Exposed at the following levels: - Agent level - Flow level - Page level - Parameter level "endpointerSensitivity": 42, # Sensitivity of the speech model that detects the end of speech. Scale from 0 to 100. @@ -812,8 +854,8 @@

Method Details

}, }, "allowAnswerFeedback": True or False, # Indicates whether the Thumbs up/Thumbs down rating controls are need to be shown for the response in the Dialogflow Messenger widget. - "currentPage": { # A Dialogflow CX conversation (session) can be described and visualized as a state machine. The states of a CX session are represented by pages. For each flow, you define many pages, where your combined pages can handle a complete conversation on the topics the flow is designed for. At any given moment, exactly one page is the current page, the current page is considered active, and the flow associated with that page is considered active. Every flow has a special start page. When a flow initially becomes active, the start page page becomes the current page. For each conversational turn, the current page will either stay the same or transition to another page. You configure each page to collect information from the end-user that is relevant for the conversational state represented by the page. For more information, see the [Page guide](https://cloud.google.com/dialogflow/cx/docs/concept/page). # The current Page. Some, not all fields are filled in this message, including but not limited to `name` and `display_name`. - "advancedSettings": { # Hierarchical advanced settings for agent/flow/page/fulfillment/parameter. Settings exposed at lower level overrides the settings exposed at higher level. Overriding occurs at the sub-setting level. For example, the playback_interruption_settings at fulfillment level only overrides the playback_interruption_settings at the agent level, leaving other settings at the agent level unchanged. DTMF settings does not override each other. DTMF settings set at different levels define DTMF detections running in parallel. Hierarchy: Agent->Flow->Page->Fulfillment/Parameter. # Hierarchical advanced settings for this page. The settings exposed at the lower level overrides the settings exposed at the higher level. + "currentFlow": { # Flows represents the conversation flows when you build your chatbot agent. A flow consists of many pages connected by the transition routes. Conversations always start with the built-in Start Flow (with an all-0 ID). Transition routes can direct the conversation session from the current flow (parent flow) to another flow (sub flow). When the sub flow is finished, Dialogflow will bring the session back to the parent flow, where the sub flow is started. Usually, when a transition route is followed by a matched intent, the intent will be "consumed". This means the intent won't activate more transition routes. However, when the followed transition route moves the conversation session into a different flow, the matched intent can be carried over and to be consumed in the target flow. # The current Flow. Some, not all fields are filled in this message, including but not limited to `name` and `display_name`. + "advancedSettings": { # Hierarchical advanced settings for agent/flow/page/fulfillment/parameter. Settings exposed at lower level overrides the settings exposed at higher level. Overriding occurs at the sub-setting level. For example, the playback_interruption_settings at fulfillment level only overrides the playback_interruption_settings at the agent level, leaving other settings at the agent level unchanged. DTMF settings does not override each other. DTMF settings set at different levels define DTMF detections running in parallel. Hierarchy: Agent->Flow->Page->Fulfillment/Parameter. # Hierarchical advanced settings for this flow. The settings exposed at the lower level overrides the settings exposed at the higher level. "audioExportGcsDestination": { # Google Cloud Storage location for a Dialogflow operation that writes or exports objects (e.g. exported agent or transcripts) outside of Dialogflow. # If present, incoming audio is exported by Dialogflow to the configured Google Cloud Storage destination. Exposed at the following levels: - Agent level - Flow level "uri": "A String", # Required. The Google Cloud Storage URI for the exported objects. A URI is of the form: `gs://bucket/object-name-or-prefix` Whether a full object name, or just a prefix, its usage depends on the Dialogflow operation. }, @@ -825,8 +867,8 @@

Method Details

"maxDigits": 42, # Max length of DTMF digits. }, "loggingSettings": { # Define behaviors on logging. # Settings for logging. Settings for Dialogflow History, Contact Center messages, StackDriver logs, and speech logging. Exposed at the following levels: - Agent level. - "enableInteractionLogging": True or False, # If true, DF Interaction logging is currently enabled. - "enableStackdriverLogging": True or False, # If true, StackDriver logging is currently enabled. + "enableInteractionLogging": True or False, # Enables DF Interaction logging. + "enableStackdriverLogging": True or False, # Enables StackDriver logging. }, "speechSettings": { # Define behaviors of speech to text detection. # Settings for speech to text detection. Exposed at the following levels: - Agent level - Flow level - Page level - Parameter level "endpointerSensitivity": 42, # Sensitivity of the speech model that detects the end of speech. Scale from 0 to 100. @@ -837,155 +879,9 @@

Method Details

"useTimeoutBasedEndpointing": True or False, # Use timeout based endpointing, interpreting endpointer sensitivy as seconds of timeout value. }, }, - "description": "A String", # The description of the page. The maximum length is 500 characters. - "displayName": "A String", # Required. The human-readable name of the page, unique within the flow. - "entryFulfillment": { # A fulfillment can do one or more of the following actions at the same time: * Generate rich message responses. * Set parameter values. * Call the webhook. Fulfillments can be called at various stages in the Page or Form lifecycle. For example, when a DetectIntentRequest drives a session to enter a new page, the page's entry fulfillment can add a static response to the QueryResult in the returning DetectIntentResponse, call the webhook (for example, to load user data from a database), or both. # The fulfillment to call when the session is entering the page. - "advancedSettings": { # Hierarchical advanced settings for agent/flow/page/fulfillment/parameter. Settings exposed at lower level overrides the settings exposed at higher level. Overriding occurs at the sub-setting level. For example, the playback_interruption_settings at fulfillment level only overrides the playback_interruption_settings at the agent level, leaving other settings at the agent level unchanged. DTMF settings does not override each other. DTMF settings set at different levels define DTMF detections running in parallel. Hierarchy: Agent->Flow->Page->Fulfillment/Parameter. # Hierarchical advanced settings for this fulfillment. The settings exposed at the lower level overrides the settings exposed at the higher level. - "audioExportGcsDestination": { # Google Cloud Storage location for a Dialogflow operation that writes or exports objects (e.g. exported agent or transcripts) outside of Dialogflow. # If present, incoming audio is exported by Dialogflow to the configured Google Cloud Storage destination. Exposed at the following levels: - Agent level - Flow level - "uri": "A String", # Required. The Google Cloud Storage URI for the exported objects. A URI is of the form: `gs://bucket/object-name-or-prefix` Whether a full object name, or just a prefix, its usage depends on the Dialogflow operation. - }, - "dtmfSettings": { # Define behaviors for DTMF (dual tone multi frequency). # Settings for DTMF. Exposed at the following levels: - Agent level - Flow level - Page level - Parameter level. - "enabled": True or False, # If true, incoming audio is processed for DTMF (dual tone multi frequency) events. For example, if the caller presses a button on their telephone keypad and DTMF processing is enabled, Dialogflow will detect the event (e.g. a "3" was pressed) in the incoming audio and pass the event to the bot to drive business logic (e.g. when 3 is pressed, return the account balance). - "endpointingTimeoutDuration": "A String", # Endpoint timeout setting for matching dtmf input to regex. - "finishDigit": "A String", # The digit that terminates a DTMF digit sequence. - "interdigitTimeoutDuration": "A String", # Interdigit timeout setting for matching dtmf input to regex. - "maxDigits": 42, # Max length of DTMF digits. - }, - "loggingSettings": { # Define behaviors on logging. # Settings for logging. Settings for Dialogflow History, Contact Center messages, StackDriver logs, and speech logging. Exposed at the following levels: - Agent level. - "enableInteractionLogging": True or False, # If true, DF Interaction logging is currently enabled. - "enableStackdriverLogging": True or False, # If true, StackDriver logging is currently enabled. - }, - "speechSettings": { # Define behaviors of speech to text detection. # Settings for speech to text detection. Exposed at the following levels: - Agent level - Flow level - Page level - Parameter level - "endpointerSensitivity": 42, # Sensitivity of the speech model that detects the end of speech. Scale from 0 to 100. - "models": { # Mapping from language to Speech-to-Text model. The mapped Speech-to-Text model will be selected for requests from its corresponding language. For more information, see [Speech models](https://cloud.google.com/dialogflow/cx/docs/concept/speech-models). - "a_key": "A String", - }, - "noSpeechTimeout": "A String", # Timeout before detecting no speech. - "useTimeoutBasedEndpointing": True or False, # Use timeout based endpointing, interpreting endpointer sensitivy as seconds of timeout value. - }, - }, - "conditionalCases": [ # Conditional cases for this fulfillment. - { # A list of cascading if-else conditions. Cases are mutually exclusive. The first one with a matching condition is selected, all the rest ignored. - "cases": [ # A list of cascading if-else conditions. - { # Each case has a Boolean condition. When it is evaluated to be True, the corresponding messages will be selected and evaluated recursively. - "caseContent": [ # A list of case content. - { # The list of messages or conditional cases to activate for this case. - "additionalCases": # Object with schema name: GoogleCloudDialogflowCxV3beta1FulfillmentConditionalCases # Additional cases to be evaluated. - "message": { # 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. # Returned message. - "channel": "A String", # The channel which the response is associated with. Clients can specify the channel via QueryParameters.channel, and only associated channel response will be returned. - "conversationSuccess": { # 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. # Indicates that the conversation succeeded. - "metadata": { # Custom metadata. Dialogflow doesn't impose any structure on this. - "a_key": "", # Properties of the object. - }, - }, - "endInteraction": { # 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. # Output only. A signal that indicates the interaction with the Dialogflow agent has ended. This message is generated by Dialogflow only when the conversation reaches `END_SESSION` page. It is not supposed to be defined by the user. It's guaranteed that there is at most one such message in each response. - }, - "knowledgeInfoCard": { # Represents info card response. If the response contains generative knowledge prediction, Dialogflow will return a payload with Infobot Messenger compatible info card. Otherwise, the info card response is skipped. # Represents info card for knowledge answers, to be better rendered in Dialogflow Messenger. - }, - "liveAgentHandoff": { # 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. # Hands off conversation to a human agent. - "metadata": { # Custom metadata for your handoff procedure. Dialogflow doesn't impose any structure on this. - "a_key": "", # Properties of the object. - }, - }, - "mixedAudio": { # 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. # Output only. An audio response message composed of both the synthesized Dialogflow agent responses and responses defined via play_audio. This message is generated by Dialogflow only and not supposed to be defined by the user. - "segments": [ # Segments this audio response is composed of. - { # Represents one segment of audio. - "allowPlaybackInterruption": True or False, # 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. - "audio": "A String", # Raw audio synthesized from the Dialogflow agent's response using the output config specified in the request. - "uri": "A String", # Client-specific URI that points to an audio clip accessible to the client. Dialogflow does not impose any validation on it. - }, - ], - }, - "outputAudioText": { # A text or ssml response that is preferentially used for TTS output audio synthesis, as described in the comment on the ResponseMessage message. # A text or ssml response that is preferentially used for TTS output audio synthesis, as described in the comment on the ResponseMessage message. - "allowPlaybackInterruption": True or False, # 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. - "ssml": "A String", # The SSML text to be synthesized. For more information, see [SSML](/speech/text-to-speech/docs/ssml). - "text": "A String", # The raw text to be synthesized. - }, - "payload": { # Returns a response containing a custom, platform-specific payload. - "a_key": "", # Properties of the object. - }, - "playAudio": { # Specifies an audio clip to be played by the client as part of the response. # Signal that the client should play an audio clip hosted at a client-specific URI. Dialogflow uses this to construct mixed_audio. However, Dialogflow itself does not try to read or process the URI in any way. - "allowPlaybackInterruption": True or False, # 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. - "audioUri": "A String", # Required. URI of the audio clip. Dialogflow does not impose any validation on this value. It is specific to the client that reads it. - }, - "telephonyTransferCall": { # Represents the signal that telles the client to transfer the phone call connected to the agent to a third-party endpoint. # A signal that the client should transfer the phone call connected to this agent to a third-party endpoint. - "phoneNumber": "A String", # Transfer the call to a phone number in [E.164 format](https://en.wikipedia.org/wiki/E.164). - }, - "text": { # The text response message. # Returns a text response. - "allowPlaybackInterruption": True or False, # 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. - "text": [ # Required. A collection of text responses. - "A String", - ], - }, - }, - }, - ], - "condition": "A String", # The condition to activate and select this case. Empty means the condition is always true. The condition is evaluated against form parameters or session parameters. See the [conditions reference](https://cloud.google.com/dialogflow/cx/docs/reference/condition). - }, - ], - }, - ], - "enableGenerativeFallback": True or False, # If the flag is true, the agent will utilize LLM to generate a text response. If LLM generation fails, the defined responses in the fulfillment will be respected. This flag is only useful for fulfillments associated with no-match event handlers. - "messages": [ # The list of rich message responses to present to the user. - { # 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. - "channel": "A String", # The channel which the response is associated with. Clients can specify the channel via QueryParameters.channel, and only associated channel response will be returned. - "conversationSuccess": { # 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. # Indicates that the conversation succeeded. - "metadata": { # Custom metadata. Dialogflow doesn't impose any structure on this. - "a_key": "", # Properties of the object. - }, - }, - "endInteraction": { # 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. # Output only. A signal that indicates the interaction with the Dialogflow agent has ended. This message is generated by Dialogflow only when the conversation reaches `END_SESSION` page. It is not supposed to be defined by the user. It's guaranteed that there is at most one such message in each response. - }, - "knowledgeInfoCard": { # Represents info card response. If the response contains generative knowledge prediction, Dialogflow will return a payload with Infobot Messenger compatible info card. Otherwise, the info card response is skipped. # Represents info card for knowledge answers, to be better rendered in Dialogflow Messenger. - }, - "liveAgentHandoff": { # 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. # Hands off conversation to a human agent. - "metadata": { # Custom metadata for your handoff procedure. Dialogflow doesn't impose any structure on this. - "a_key": "", # Properties of the object. - }, - }, - "mixedAudio": { # 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. # Output only. An audio response message composed of both the synthesized Dialogflow agent responses and responses defined via play_audio. This message is generated by Dialogflow only and not supposed to be defined by the user. - "segments": [ # Segments this audio response is composed of. - { # Represents one segment of audio. - "allowPlaybackInterruption": True or False, # 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. - "audio": "A String", # Raw audio synthesized from the Dialogflow agent's response using the output config specified in the request. - "uri": "A String", # Client-specific URI that points to an audio clip accessible to the client. Dialogflow does not impose any validation on it. - }, - ], - }, - "outputAudioText": { # A text or ssml response that is preferentially used for TTS output audio synthesis, as described in the comment on the ResponseMessage message. # A text or ssml response that is preferentially used for TTS output audio synthesis, as described in the comment on the ResponseMessage message. - "allowPlaybackInterruption": True or False, # 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. - "ssml": "A String", # The SSML text to be synthesized. For more information, see [SSML](/speech/text-to-speech/docs/ssml). - "text": "A String", # The raw text to be synthesized. - }, - "payload": { # Returns a response containing a custom, platform-specific payload. - "a_key": "", # Properties of the object. - }, - "playAudio": { # Specifies an audio clip to be played by the client as part of the response. # Signal that the client should play an audio clip hosted at a client-specific URI. Dialogflow uses this to construct mixed_audio. However, Dialogflow itself does not try to read or process the URI in any way. - "allowPlaybackInterruption": True or False, # 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. - "audioUri": "A String", # Required. URI of the audio clip. Dialogflow does not impose any validation on this value. It is specific to the client that reads it. - }, - "telephonyTransferCall": { # Represents the signal that telles the client to transfer the phone call connected to the agent to a third-party endpoint. # A signal that the client should transfer the phone call connected to this agent to a third-party endpoint. - "phoneNumber": "A String", # Transfer the call to a phone number in [E.164 format](https://en.wikipedia.org/wiki/E.164). - }, - "text": { # The text response message. # Returns a text response. - "allowPlaybackInterruption": True or False, # 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. - "text": [ # Required. A collection of text responses. - "A String", - ], - }, - }, - ], - "returnPartialResponses": True or False, # Whether Dialogflow should return currently queued fulfillment response messages in streaming APIs. If a webhook is specified, it happens before Dialogflow invokes webhook. Warning: 1) This flag only affects streaming API. Responses are still queued and returned once in non-streaming API. 2) The flag can be enabled in any fulfillment but only the first 3 partial responses will be returned. You may only want to apply it to fulfillments that have slow webhooks. - "setParameterActions": [ # Set parameter values before executing the webhook. - { # Setting a parameter value. - "parameter": "A String", # Display name of the parameter. - "value": "", # The new value of the parameter. A null value clears the parameter. - }, - ], - "tag": "A String", # The value of this field will be populated in the WebhookRequest `fulfillmentInfo.tag` field by Dialogflow when the associated webhook is called. The tag is typically used by the webhook service to identify which fulfillment is being called, but it could be used for other purposes. This field is required if `webhook` is specified. - "webhook": "A String", # The webhook to call. Format: `projects//locations//agents//webhooks/`. - }, - "eventHandlers": [ # Handlers associated with the page to handle events such as webhook errors, no match or no input. + "description": "A String", # The description of the flow. The maximum length is 500 characters. If exceeded, the request is rejected. + "displayName": "A String", # Required. The human-readable name of the flow. + "eventHandlers": [ # A flow's event handlers serve two purposes: * They are responsible for handling events (e.g. no match, webhook errors) in the flow. * They are inherited by every page's event handlers, which can be used to handle common events regardless of the current page. Event handlers defined in the page have higher priority than those defined in the flow. Unlike transition_routes, these handlers are evaluated on a first-match basis. The first one that matches the event get executed, with the rest being ignored. { # An event handler specifies an event that can be handled during a session. When the specified event happens, the following actions are taken in order: * If there is a `trigger_fulfillment` associated with the event, it will be called. * If there is a `target_page` associated with the event, the session will transition into the specified page. * If there is a `target_flow` associated with the event, the session will transition into the specified flow. "event": "A String", # Required. The name of the event to handle. "name": "A String", # Output only. The unique identifier of this event handler. @@ -1004,8 +900,8 @@

Method Details

"maxDigits": 42, # Max length of DTMF digits. }, "loggingSettings": { # Define behaviors on logging. # Settings for logging. Settings for Dialogflow History, Contact Center messages, StackDriver logs, and speech logging. Exposed at the following levels: - Agent level. - "enableInteractionLogging": True or False, # If true, DF Interaction logging is currently enabled. - "enableStackdriverLogging": True or False, # If true, StackDriver logging is currently enabled. + "enableInteractionLogging": True or False, # Enables DF Interaction logging. + "enableStackdriverLogging": True or False, # Enables StackDriver logging. }, "speechSettings": { # Define behaviors of speech to text detection. # Settings for speech to text detection. Exposed at the following levels: - Agent level - Flow level - Page level - Parameter level "endpointerSensitivity": 42, # Sensitivity of the speech model that detects the end of speech. Scale from 0 to 100. @@ -1069,6 +965,13 @@

Method Details

"A String", ], }, + "toolCall": { # Represents a call of a specific tool's action with the specified inputs. # Returns the definition of a tool call that should be executed by the client. + "action": "A String", # Required. The name of the tool's action associated with this call. + "inputParameters": { # Optional. The action's input parameters. + "a_key": "", # Properties of the object. + }, + "tool": "A String", # Required. The tool associated with this call. Format: `projects//locations//agents//tools/`. + }, }, }, ], @@ -1125,6 +1028,13 @@

Method Details

"A String", ], }, + "toolCall": { # Represents a call of a specific tool's action with the specified inputs. # Returns the definition of a tool call that should be executed by the client. + "action": "A String", # Required. The name of the tool's action associated with this call. + "inputParameters": { # Optional. The action's input parameters. + "a_key": "", # Properties of the object. + }, + "tool": "A String", # Required. The tool associated with this call. Format: `projects//locations//agents//tools/`. + }, }, ], "returnPartialResponses": True or False, # Whether Dialogflow should return currently queued fulfillment response messages in streaming APIs. If a webhook is specified, it happens before Dialogflow invokes webhook. Warning: 1) This flag only affects streaming API. Responses are still queued and returned once in non-streaming API. 2) The flag can be enabled in any fulfillment but only the first 3 partial responses will be returned. You may only want to apply it to fulfillments that have slow webhooks. @@ -1139,278 +1049,49 @@

Method Details

}, }, ], - "form": { # A form is a data model that groups related parameters that can be collected from the user. The process in which the agent prompts the user and collects parameter values from the user is called form filling. A form can be added to a page. When form filling is done, the filled parameters will be written to the session. # The form associated with the page, used for collecting parameters relevant to the page. - "parameters": [ # Parameters to collect from the user. - { # Represents a form parameter. - "advancedSettings": { # Hierarchical advanced settings for agent/flow/page/fulfillment/parameter. Settings exposed at lower level overrides the settings exposed at higher level. Overriding occurs at the sub-setting level. For example, the playback_interruption_settings at fulfillment level only overrides the playback_interruption_settings at the agent level, leaving other settings at the agent level unchanged. DTMF settings does not override each other. DTMF settings set at different levels define DTMF detections running in parallel. Hierarchy: Agent->Flow->Page->Fulfillment/Parameter. # Hierarchical advanced settings for this parameter. The settings exposed at the lower level overrides the settings exposed at the higher level. - "audioExportGcsDestination": { # Google Cloud Storage location for a Dialogflow operation that writes or exports objects (e.g. exported agent or transcripts) outside of Dialogflow. # If present, incoming audio is exported by Dialogflow to the configured Google Cloud Storage destination. Exposed at the following levels: - Agent level - Flow level - "uri": "A String", # Required. The Google Cloud Storage URI for the exported objects. A URI is of the form: `gs://bucket/object-name-or-prefix` Whether a full object name, or just a prefix, its usage depends on the Dialogflow operation. - }, - "dtmfSettings": { # Define behaviors for DTMF (dual tone multi frequency). # Settings for DTMF. Exposed at the following levels: - Agent level - Flow level - Page level - Parameter level. - "enabled": True or False, # If true, incoming audio is processed for DTMF (dual tone multi frequency) events. For example, if the caller presses a button on their telephone keypad and DTMF processing is enabled, Dialogflow will detect the event (e.g. a "3" was pressed) in the incoming audio and pass the event to the bot to drive business logic (e.g. when 3 is pressed, return the account balance). - "endpointingTimeoutDuration": "A String", # Endpoint timeout setting for matching dtmf input to regex. - "finishDigit": "A String", # The digit that terminates a DTMF digit sequence. - "interdigitTimeoutDuration": "A String", # Interdigit timeout setting for matching dtmf input to regex. - "maxDigits": 42, # Max length of DTMF digits. - }, - "loggingSettings": { # Define behaviors on logging. # Settings for logging. Settings for Dialogflow History, Contact Center messages, StackDriver logs, and speech logging. Exposed at the following levels: - Agent level. - "enableInteractionLogging": True or False, # If true, DF Interaction logging is currently enabled. - "enableStackdriverLogging": True or False, # If true, StackDriver logging is currently enabled. - }, - "speechSettings": { # Define behaviors of speech to text detection. # Settings for speech to text detection. Exposed at the following levels: - Agent level - Flow level - Page level - Parameter level - "endpointerSensitivity": 42, # Sensitivity of the speech model that detects the end of speech. Scale from 0 to 100. - "models": { # Mapping from language to Speech-to-Text model. The mapped Speech-to-Text model will be selected for requests from its corresponding language. For more information, see [Speech models](https://cloud.google.com/dialogflow/cx/docs/concept/speech-models). - "a_key": "A String", - }, - "noSpeechTimeout": "A String", # Timeout before detecting no speech. - "useTimeoutBasedEndpointing": True or False, # Use timeout based endpointing, interpreting endpointer sensitivy as seconds of timeout value. + "knowledgeConnectorSettings": { # The Knowledge Connector settings for this page or flow. This includes information such as the attached Knowledge Bases, and the way to execute fulfillment. # Optional. Knowledge connector configuration. + "dataStoreConnections": [ # Optional. List of related data store connections. + { # A data store connection. It represents a data store in Discovery Engine and the type of the contents it contains. + "dataStore": "A String", # The full name of the referenced data store. Formats: `projects/{project}/locations/{location}/collections/{collection}/dataStores/{data_store}` `projects/{project}/locations/{location}/dataStores/{data_store}` + "dataStoreType": "A String", # The type of the connected data store. + }, + ], + "enabled": True or False, # Whether Knowledge Connector is enabled or not. + "targetFlow": "A String", # The target flow to transition to. Format: `projects//locations//agents//flows/`. + "targetPage": "A String", # The target page to transition to. Format: `projects//locations//agents//flows//pages/`. + "triggerFulfillment": { # A fulfillment can do one or more of the following actions at the same time: * Generate rich message responses. * Set parameter values. * Call the webhook. Fulfillments can be called at various stages in the Page or Form lifecycle. For example, when a DetectIntentRequest drives a session to enter a new page, the page's entry fulfillment can add a static response to the QueryResult in the returning DetectIntentResponse, call the webhook (for example, to load user data from a database), or both. # The fulfillment to be triggered. When the answers from the Knowledge Connector are selected by Dialogflow, you can utitlize the request scoped parameter `$request.knowledge.answers` (contains up to the 5 highest confidence answers) and `$request.knowledge.questions` (contains the corresponding questions) to construct the fulfillment. + "advancedSettings": { # Hierarchical advanced settings for agent/flow/page/fulfillment/parameter. Settings exposed at lower level overrides the settings exposed at higher level. Overriding occurs at the sub-setting level. For example, the playback_interruption_settings at fulfillment level only overrides the playback_interruption_settings at the agent level, leaving other settings at the agent level unchanged. DTMF settings does not override each other. DTMF settings set at different levels define DTMF detections running in parallel. Hierarchy: Agent->Flow->Page->Fulfillment/Parameter. # Hierarchical advanced settings for this fulfillment. The settings exposed at the lower level overrides the settings exposed at the higher level. + "audioExportGcsDestination": { # Google Cloud Storage location for a Dialogflow operation that writes or exports objects (e.g. exported agent or transcripts) outside of Dialogflow. # If present, incoming audio is exported by Dialogflow to the configured Google Cloud Storage destination. Exposed at the following levels: - Agent level - Flow level + "uri": "A String", # Required. The Google Cloud Storage URI for the exported objects. A URI is of the form: `gs://bucket/object-name-or-prefix` Whether a full object name, or just a prefix, its usage depends on the Dialogflow operation. + }, + "dtmfSettings": { # Define behaviors for DTMF (dual tone multi frequency). # Settings for DTMF. Exposed at the following levels: - Agent level - Flow level - Page level - Parameter level. + "enabled": True or False, # If true, incoming audio is processed for DTMF (dual tone multi frequency) events. For example, if the caller presses a button on their telephone keypad and DTMF processing is enabled, Dialogflow will detect the event (e.g. a "3" was pressed) in the incoming audio and pass the event to the bot to drive business logic (e.g. when 3 is pressed, return the account balance). + "endpointingTimeoutDuration": "A String", # Endpoint timeout setting for matching dtmf input to regex. + "finishDigit": "A String", # The digit that terminates a DTMF digit sequence. + "interdigitTimeoutDuration": "A String", # Interdigit timeout setting for matching dtmf input to regex. + "maxDigits": 42, # Max length of DTMF digits. + }, + "loggingSettings": { # Define behaviors on logging. # Settings for logging. Settings for Dialogflow History, Contact Center messages, StackDriver logs, and speech logging. Exposed at the following levels: - Agent level. + "enableInteractionLogging": True or False, # Enables DF Interaction logging. + "enableStackdriverLogging": True or False, # Enables StackDriver logging. + }, + "speechSettings": { # Define behaviors of speech to text detection. # Settings for speech to text detection. Exposed at the following levels: - Agent level - Flow level - Page level - Parameter level + "endpointerSensitivity": 42, # Sensitivity of the speech model that detects the end of speech. Scale from 0 to 100. + "models": { # Mapping from language to Speech-to-Text model. The mapped Speech-to-Text model will be selected for requests from its corresponding language. For more information, see [Speech models](https://cloud.google.com/dialogflow/cx/docs/concept/speech-models). + "a_key": "A String", }, + "noSpeechTimeout": "A String", # Timeout before detecting no speech. + "useTimeoutBasedEndpointing": True or False, # Use timeout based endpointing, interpreting endpointer sensitivy as seconds of timeout value. }, - "defaultValue": "", # The default value of an optional parameter. If the parameter is required, the default value will be ignored. - "displayName": "A String", # Required. The human-readable name of the parameter, unique within the form. - "entityType": "A String", # Required. The entity type of the parameter. Format: `projects/-/locations/-/agents/-/entityTypes/` for system entity types (for example, `projects/-/locations/-/agents/-/entityTypes/sys.date`), or `projects//locations//agents//entityTypes/` for developer entity types. - "fillBehavior": { # Configuration for how the filling of a parameter should be handled. # Required. Defines fill behavior for the parameter. - "initialPromptFulfillment": { # A fulfillment can do one or more of the following actions at the same time: * Generate rich message responses. * Set parameter values. * Call the webhook. Fulfillments can be called at various stages in the Page or Form lifecycle. For example, when a DetectIntentRequest drives a session to enter a new page, the page's entry fulfillment can add a static response to the QueryResult in the returning DetectIntentResponse, call the webhook (for example, to load user data from a database), or both. # Required. The fulfillment to provide the initial prompt that the agent can present to the user in order to fill the parameter. - "advancedSettings": { # Hierarchical advanced settings for agent/flow/page/fulfillment/parameter. Settings exposed at lower level overrides the settings exposed at higher level. Overriding occurs at the sub-setting level. For example, the playback_interruption_settings at fulfillment level only overrides the playback_interruption_settings at the agent level, leaving other settings at the agent level unchanged. DTMF settings does not override each other. DTMF settings set at different levels define DTMF detections running in parallel. Hierarchy: Agent->Flow->Page->Fulfillment/Parameter. # Hierarchical advanced settings for this fulfillment. The settings exposed at the lower level overrides the settings exposed at the higher level. - "audioExportGcsDestination": { # Google Cloud Storage location for a Dialogflow operation that writes or exports objects (e.g. exported agent or transcripts) outside of Dialogflow. # If present, incoming audio is exported by Dialogflow to the configured Google Cloud Storage destination. Exposed at the following levels: - Agent level - Flow level - "uri": "A String", # Required. The Google Cloud Storage URI for the exported objects. A URI is of the form: `gs://bucket/object-name-or-prefix` Whether a full object name, or just a prefix, its usage depends on the Dialogflow operation. - }, - "dtmfSettings": { # Define behaviors for DTMF (dual tone multi frequency). # Settings for DTMF. Exposed at the following levels: - Agent level - Flow level - Page level - Parameter level. - "enabled": True or False, # If true, incoming audio is processed for DTMF (dual tone multi frequency) events. For example, if the caller presses a button on their telephone keypad and DTMF processing is enabled, Dialogflow will detect the event (e.g. a "3" was pressed) in the incoming audio and pass the event to the bot to drive business logic (e.g. when 3 is pressed, return the account balance). - "endpointingTimeoutDuration": "A String", # Endpoint timeout setting for matching dtmf input to regex. - "finishDigit": "A String", # The digit that terminates a DTMF digit sequence. - "interdigitTimeoutDuration": "A String", # Interdigit timeout setting for matching dtmf input to regex. - "maxDigits": 42, # Max length of DTMF digits. - }, - "loggingSettings": { # Define behaviors on logging. # Settings for logging. Settings for Dialogflow History, Contact Center messages, StackDriver logs, and speech logging. Exposed at the following levels: - Agent level. - "enableInteractionLogging": True or False, # If true, DF Interaction logging is currently enabled. - "enableStackdriverLogging": True or False, # If true, StackDriver logging is currently enabled. - }, - "speechSettings": { # Define behaviors of speech to text detection. # Settings for speech to text detection. Exposed at the following levels: - Agent level - Flow level - Page level - Parameter level - "endpointerSensitivity": 42, # Sensitivity of the speech model that detects the end of speech. Scale from 0 to 100. - "models": { # Mapping from language to Speech-to-Text model. The mapped Speech-to-Text model will be selected for requests from its corresponding language. For more information, see [Speech models](https://cloud.google.com/dialogflow/cx/docs/concept/speech-models). - "a_key": "A String", - }, - "noSpeechTimeout": "A String", # Timeout before detecting no speech. - "useTimeoutBasedEndpointing": True or False, # Use timeout based endpointing, interpreting endpointer sensitivy as seconds of timeout value. - }, - }, - "conditionalCases": [ # Conditional cases for this fulfillment. - { # A list of cascading if-else conditions. Cases are mutually exclusive. The first one with a matching condition is selected, all the rest ignored. - "cases": [ # A list of cascading if-else conditions. - { # Each case has a Boolean condition. When it is evaluated to be True, the corresponding messages will be selected and evaluated recursively. - "caseContent": [ # A list of case content. - { # The list of messages or conditional cases to activate for this case. - "additionalCases": # Object with schema name: GoogleCloudDialogflowCxV3beta1FulfillmentConditionalCases # Additional cases to be evaluated. - "message": { # 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. # Returned message. - "channel": "A String", # The channel which the response is associated with. Clients can specify the channel via QueryParameters.channel, and only associated channel response will be returned. - "conversationSuccess": { # 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. # Indicates that the conversation succeeded. - "metadata": { # Custom metadata. Dialogflow doesn't impose any structure on this. - "a_key": "", # Properties of the object. - }, - }, - "endInteraction": { # 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. # Output only. A signal that indicates the interaction with the Dialogflow agent has ended. This message is generated by Dialogflow only when the conversation reaches `END_SESSION` page. It is not supposed to be defined by the user. It's guaranteed that there is at most one such message in each response. - }, - "knowledgeInfoCard": { # Represents info card response. If the response contains generative knowledge prediction, Dialogflow will return a payload with Infobot Messenger compatible info card. Otherwise, the info card response is skipped. # Represents info card for knowledge answers, to be better rendered in Dialogflow Messenger. - }, - "liveAgentHandoff": { # 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. # Hands off conversation to a human agent. - "metadata": { # Custom metadata for your handoff procedure. Dialogflow doesn't impose any structure on this. - "a_key": "", # Properties of the object. - }, - }, - "mixedAudio": { # 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. # Output only. An audio response message composed of both the synthesized Dialogflow agent responses and responses defined via play_audio. This message is generated by Dialogflow only and not supposed to be defined by the user. - "segments": [ # Segments this audio response is composed of. - { # Represents one segment of audio. - "allowPlaybackInterruption": True or False, # 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. - "audio": "A String", # Raw audio synthesized from the Dialogflow agent's response using the output config specified in the request. - "uri": "A String", # Client-specific URI that points to an audio clip accessible to the client. Dialogflow does not impose any validation on it. - }, - ], - }, - "outputAudioText": { # A text or ssml response that is preferentially used for TTS output audio synthesis, as described in the comment on the ResponseMessage message. # A text or ssml response that is preferentially used for TTS output audio synthesis, as described in the comment on the ResponseMessage message. - "allowPlaybackInterruption": True or False, # 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. - "ssml": "A String", # The SSML text to be synthesized. For more information, see [SSML](/speech/text-to-speech/docs/ssml). - "text": "A String", # The raw text to be synthesized. - }, - "payload": { # Returns a response containing a custom, platform-specific payload. - "a_key": "", # Properties of the object. - }, - "playAudio": { # Specifies an audio clip to be played by the client as part of the response. # Signal that the client should play an audio clip hosted at a client-specific URI. Dialogflow uses this to construct mixed_audio. However, Dialogflow itself does not try to read or process the URI in any way. - "allowPlaybackInterruption": True or False, # 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. - "audioUri": "A String", # Required. URI of the audio clip. Dialogflow does not impose any validation on this value. It is specific to the client that reads it. - }, - "telephonyTransferCall": { # Represents the signal that telles the client to transfer the phone call connected to the agent to a third-party endpoint. # A signal that the client should transfer the phone call connected to this agent to a third-party endpoint. - "phoneNumber": "A String", # Transfer the call to a phone number in [E.164 format](https://en.wikipedia.org/wiki/E.164). - }, - "text": { # The text response message. # Returns a text response. - "allowPlaybackInterruption": True or False, # 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. - "text": [ # Required. A collection of text responses. - "A String", - ], - }, - }, - }, - ], - "condition": "A String", # The condition to activate and select this case. Empty means the condition is always true. The condition is evaluated against form parameters or session parameters. See the [conditions reference](https://cloud.google.com/dialogflow/cx/docs/reference/condition). - }, - ], - }, - ], - "enableGenerativeFallback": True or False, # If the flag is true, the agent will utilize LLM to generate a text response. If LLM generation fails, the defined responses in the fulfillment will be respected. This flag is only useful for fulfillments associated with no-match event handlers. - "messages": [ # The list of rich message responses to present to the user. - { # 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. - "channel": "A String", # The channel which the response is associated with. Clients can specify the channel via QueryParameters.channel, and only associated channel response will be returned. - "conversationSuccess": { # 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. # Indicates that the conversation succeeded. - "metadata": { # Custom metadata. Dialogflow doesn't impose any structure on this. - "a_key": "", # Properties of the object. - }, - }, - "endInteraction": { # 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. # Output only. A signal that indicates the interaction with the Dialogflow agent has ended. This message is generated by Dialogflow only when the conversation reaches `END_SESSION` page. It is not supposed to be defined by the user. It's guaranteed that there is at most one such message in each response. - }, - "knowledgeInfoCard": { # Represents info card response. If the response contains generative knowledge prediction, Dialogflow will return a payload with Infobot Messenger compatible info card. Otherwise, the info card response is skipped. # Represents info card for knowledge answers, to be better rendered in Dialogflow Messenger. - }, - "liveAgentHandoff": { # 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. # Hands off conversation to a human agent. - "metadata": { # Custom metadata for your handoff procedure. Dialogflow doesn't impose any structure on this. - "a_key": "", # Properties of the object. - }, - }, - "mixedAudio": { # 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. # Output only. An audio response message composed of both the synthesized Dialogflow agent responses and responses defined via play_audio. This message is generated by Dialogflow only and not supposed to be defined by the user. - "segments": [ # Segments this audio response is composed of. - { # Represents one segment of audio. - "allowPlaybackInterruption": True or False, # 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. - "audio": "A String", # Raw audio synthesized from the Dialogflow agent's response using the output config specified in the request. - "uri": "A String", # Client-specific URI that points to an audio clip accessible to the client. Dialogflow does not impose any validation on it. - }, - ], - }, - "outputAudioText": { # A text or ssml response that is preferentially used for TTS output audio synthesis, as described in the comment on the ResponseMessage message. # A text or ssml response that is preferentially used for TTS output audio synthesis, as described in the comment on the ResponseMessage message. - "allowPlaybackInterruption": True or False, # 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. - "ssml": "A String", # The SSML text to be synthesized. For more information, see [SSML](/speech/text-to-speech/docs/ssml). - "text": "A String", # The raw text to be synthesized. - }, - "payload": { # Returns a response containing a custom, platform-specific payload. - "a_key": "", # Properties of the object. - }, - "playAudio": { # Specifies an audio clip to be played by the client as part of the response. # Signal that the client should play an audio clip hosted at a client-specific URI. Dialogflow uses this to construct mixed_audio. However, Dialogflow itself does not try to read or process the URI in any way. - "allowPlaybackInterruption": True or False, # 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. - "audioUri": "A String", # Required. URI of the audio clip. Dialogflow does not impose any validation on this value. It is specific to the client that reads it. - }, - "telephonyTransferCall": { # Represents the signal that telles the client to transfer the phone call connected to the agent to a third-party endpoint. # A signal that the client should transfer the phone call connected to this agent to a third-party endpoint. - "phoneNumber": "A String", # Transfer the call to a phone number in [E.164 format](https://en.wikipedia.org/wiki/E.164). - }, - "text": { # The text response message. # Returns a text response. - "allowPlaybackInterruption": True or False, # 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. - "text": [ # Required. A collection of text responses. - "A String", - ], - }, - }, - ], - "returnPartialResponses": True or False, # Whether Dialogflow should return currently queued fulfillment response messages in streaming APIs. If a webhook is specified, it happens before Dialogflow invokes webhook. Warning: 1) This flag only affects streaming API. Responses are still queued and returned once in non-streaming API. 2) The flag can be enabled in any fulfillment but only the first 3 partial responses will be returned. You may only want to apply it to fulfillments that have slow webhooks. - "setParameterActions": [ # Set parameter values before executing the webhook. - { # Setting a parameter value. - "parameter": "A String", # Display name of the parameter. - "value": "", # The new value of the parameter. A null value clears the parameter. - }, - ], - "tag": "A String", # The value of this field will be populated in the WebhookRequest `fulfillmentInfo.tag` field by Dialogflow when the associated webhook is called. The tag is typically used by the webhook service to identify which fulfillment is being called, but it could be used for other purposes. This field is required if `webhook` is specified. - "webhook": "A String", # The webhook to call. Format: `projects//locations//agents//webhooks/`. - }, - "repromptEventHandlers": [ # The handlers for parameter-level events, used to provide reprompt for the parameter or transition to a different page/flow. The supported events are: * `sys.no-match-`, where N can be from 1 to 6 * `sys.no-match-default` * `sys.no-input-`, where N can be from 1 to 6 * `sys.no-input-default` * `sys.invalid-parameter` `initial_prompt_fulfillment` provides the first prompt for the parameter. If the user's response does not fill the parameter, a no-match/no-input event will be triggered, and the fulfillment associated with the `sys.no-match-1`/`sys.no-input-1` handler (if defined) will be called to provide a prompt. The `sys.no-match-2`/`sys.no-input-2` handler (if defined) will respond to the next no-match/no-input event, and so on. A `sys.no-match-default` or `sys.no-input-default` handler will be used to handle all following no-match/no-input events after all numbered no-match/no-input handlers for the parameter are consumed. A `sys.invalid-parameter` handler can be defined to handle the case where the parameter values have been `invalidated` by webhook. For example, if the user's response fill the parameter, however the parameter was invalidated by webhook, the fulfillment associated with the `sys.invalid-parameter` handler (if defined) will be called to provide a prompt. If the event handler for the corresponding event can't be found on the parameter, `initial_prompt_fulfillment` will be re-prompted. - { # An event handler specifies an event that can be handled during a session. When the specified event happens, the following actions are taken in order: * If there is a `trigger_fulfillment` associated with the event, it will be called. * If there is a `target_page` associated with the event, the session will transition into the specified page. * If there is a `target_flow` associated with the event, the session will transition into the specified flow. - "event": "A String", # Required. The name of the event to handle. - "name": "A String", # Output only. The unique identifier of this event handler. - "targetFlow": "A String", # The target flow to transition to. Format: `projects//locations//agents//flows/`. - "targetPage": "A String", # The target page to transition to. Format: `projects//locations//agents//flows//pages/`. - "triggerFulfillment": { # A fulfillment can do one or more of the following actions at the same time: * Generate rich message responses. * Set parameter values. * Call the webhook. Fulfillments can be called at various stages in the Page or Form lifecycle. For example, when a DetectIntentRequest drives a session to enter a new page, the page's entry fulfillment can add a static response to the QueryResult in the returning DetectIntentResponse, call the webhook (for example, to load user data from a database), or both. # The fulfillment to call when the event occurs. Handling webhook errors with a fulfillment enabled with webhook could cause infinite loop. It is invalid to specify such fulfillment for a handler handling webhooks. - "advancedSettings": { # Hierarchical advanced settings for agent/flow/page/fulfillment/parameter. Settings exposed at lower level overrides the settings exposed at higher level. Overriding occurs at the sub-setting level. For example, the playback_interruption_settings at fulfillment level only overrides the playback_interruption_settings at the agent level, leaving other settings at the agent level unchanged. DTMF settings does not override each other. DTMF settings set at different levels define DTMF detections running in parallel. Hierarchy: Agent->Flow->Page->Fulfillment/Parameter. # Hierarchical advanced settings for this fulfillment. The settings exposed at the lower level overrides the settings exposed at the higher level. - "audioExportGcsDestination": { # Google Cloud Storage location for a Dialogflow operation that writes or exports objects (e.g. exported agent or transcripts) outside of Dialogflow. # If present, incoming audio is exported by Dialogflow to the configured Google Cloud Storage destination. Exposed at the following levels: - Agent level - Flow level - "uri": "A String", # Required. The Google Cloud Storage URI for the exported objects. A URI is of the form: `gs://bucket/object-name-or-prefix` Whether a full object name, or just a prefix, its usage depends on the Dialogflow operation. - }, - "dtmfSettings": { # Define behaviors for DTMF (dual tone multi frequency). # Settings for DTMF. Exposed at the following levels: - Agent level - Flow level - Page level - Parameter level. - "enabled": True or False, # If true, incoming audio is processed for DTMF (dual tone multi frequency) events. For example, if the caller presses a button on their telephone keypad and DTMF processing is enabled, Dialogflow will detect the event (e.g. a "3" was pressed) in the incoming audio and pass the event to the bot to drive business logic (e.g. when 3 is pressed, return the account balance). - "endpointingTimeoutDuration": "A String", # Endpoint timeout setting for matching dtmf input to regex. - "finishDigit": "A String", # The digit that terminates a DTMF digit sequence. - "interdigitTimeoutDuration": "A String", # Interdigit timeout setting for matching dtmf input to regex. - "maxDigits": 42, # Max length of DTMF digits. - }, - "loggingSettings": { # Define behaviors on logging. # Settings for logging. Settings for Dialogflow History, Contact Center messages, StackDriver logs, and speech logging. Exposed at the following levels: - Agent level. - "enableInteractionLogging": True or False, # If true, DF Interaction logging is currently enabled. - "enableStackdriverLogging": True or False, # If true, StackDriver logging is currently enabled. - }, - "speechSettings": { # Define behaviors of speech to text detection. # Settings for speech to text detection. Exposed at the following levels: - Agent level - Flow level - Page level - Parameter level - "endpointerSensitivity": 42, # Sensitivity of the speech model that detects the end of speech. Scale from 0 to 100. - "models": { # Mapping from language to Speech-to-Text model. The mapped Speech-to-Text model will be selected for requests from its corresponding language. For more information, see [Speech models](https://cloud.google.com/dialogflow/cx/docs/concept/speech-models). - "a_key": "A String", - }, - "noSpeechTimeout": "A String", # Timeout before detecting no speech. - "useTimeoutBasedEndpointing": True or False, # Use timeout based endpointing, interpreting endpointer sensitivy as seconds of timeout value. - }, - }, - "conditionalCases": [ # Conditional cases for this fulfillment. - { # A list of cascading if-else conditions. Cases are mutually exclusive. The first one with a matching condition is selected, all the rest ignored. - "cases": [ # A list of cascading if-else conditions. - { # Each case has a Boolean condition. When it is evaluated to be True, the corresponding messages will be selected and evaluated recursively. - "caseContent": [ # A list of case content. - { # The list of messages or conditional cases to activate for this case. - "additionalCases": # Object with schema name: GoogleCloudDialogflowCxV3beta1FulfillmentConditionalCases # Additional cases to be evaluated. - "message": { # 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. # Returned message. - "channel": "A String", # The channel which the response is associated with. Clients can specify the channel via QueryParameters.channel, and only associated channel response will be returned. - "conversationSuccess": { # 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. # Indicates that the conversation succeeded. - "metadata": { # Custom metadata. Dialogflow doesn't impose any structure on this. - "a_key": "", # Properties of the object. - }, - }, - "endInteraction": { # 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. # Output only. A signal that indicates the interaction with the Dialogflow agent has ended. This message is generated by Dialogflow only when the conversation reaches `END_SESSION` page. It is not supposed to be defined by the user. It's guaranteed that there is at most one such message in each response. - }, - "knowledgeInfoCard": { # Represents info card response. If the response contains generative knowledge prediction, Dialogflow will return a payload with Infobot Messenger compatible info card. Otherwise, the info card response is skipped. # Represents info card for knowledge answers, to be better rendered in Dialogflow Messenger. - }, - "liveAgentHandoff": { # 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. # Hands off conversation to a human agent. - "metadata": { # Custom metadata for your handoff procedure. Dialogflow doesn't impose any structure on this. - "a_key": "", # Properties of the object. - }, - }, - "mixedAudio": { # 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. # Output only. An audio response message composed of both the synthesized Dialogflow agent responses and responses defined via play_audio. This message is generated by Dialogflow only and not supposed to be defined by the user. - "segments": [ # Segments this audio response is composed of. - { # Represents one segment of audio. - "allowPlaybackInterruption": True or False, # 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. - "audio": "A String", # Raw audio synthesized from the Dialogflow agent's response using the output config specified in the request. - "uri": "A String", # Client-specific URI that points to an audio clip accessible to the client. Dialogflow does not impose any validation on it. - }, - ], - }, - "outputAudioText": { # A text or ssml response that is preferentially used for TTS output audio synthesis, as described in the comment on the ResponseMessage message. # A text or ssml response that is preferentially used for TTS output audio synthesis, as described in the comment on the ResponseMessage message. - "allowPlaybackInterruption": True or False, # 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. - "ssml": "A String", # The SSML text to be synthesized. For more information, see [SSML](/speech/text-to-speech/docs/ssml). - "text": "A String", # The raw text to be synthesized. - }, - "payload": { # Returns a response containing a custom, platform-specific payload. - "a_key": "", # Properties of the object. - }, - "playAudio": { # Specifies an audio clip to be played by the client as part of the response. # Signal that the client should play an audio clip hosted at a client-specific URI. Dialogflow uses this to construct mixed_audio. However, Dialogflow itself does not try to read or process the URI in any way. - "allowPlaybackInterruption": True or False, # 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. - "audioUri": "A String", # Required. URI of the audio clip. Dialogflow does not impose any validation on this value. It is specific to the client that reads it. - }, - "telephonyTransferCall": { # Represents the signal that telles the client to transfer the phone call connected to the agent to a third-party endpoint. # A signal that the client should transfer the phone call connected to this agent to a third-party endpoint. - "phoneNumber": "A String", # Transfer the call to a phone number in [E.164 format](https://en.wikipedia.org/wiki/E.164). - }, - "text": { # The text response message. # Returns a text response. - "allowPlaybackInterruption": True or False, # 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. - "text": [ # Required. A collection of text responses. - "A String", - ], - }, - }, - }, - ], - "condition": "A String", # The condition to activate and select this case. Empty means the condition is always true. The condition is evaluated against form parameters or session parameters. See the [conditions reference](https://cloud.google.com/dialogflow/cx/docs/reference/condition). - }, - ], - }, - ], - "enableGenerativeFallback": True or False, # If the flag is true, the agent will utilize LLM to generate a text response. If LLM generation fails, the defined responses in the fulfillment will be respected. This flag is only useful for fulfillments associated with no-match event handlers. - "messages": [ # The list of rich message responses to present to the user. - { # 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. + }, + "conditionalCases": [ # Conditional cases for this fulfillment. + { # A list of cascading if-else conditions. Cases are mutually exclusive. The first one with a matching condition is selected, all the rest ignored. + "cases": [ # A list of cascading if-else conditions. + { # Each case has a Boolean condition. When it is evaluated to be True, the corresponding messages will be selected and evaluated recursively. + "caseContent": [ # A list of case content. + { # The list of messages or conditional cases to activate for this case. + "additionalCases": # Object with schema name: GoogleCloudDialogflowCxV3beta1FulfillmentConditionalCases # Additional cases to be evaluated. + "message": { # 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. # Returned message. "channel": "A String", # The channel which the response is associated with. Clients can specify the channel via QueryParameters.channel, and only associated channel response will be returned. "conversationSuccess": { # 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. # Indicates that the conversation succeeded. "metadata": { # Custom metadata. Dialogflow doesn't impose any structure on this. @@ -1456,119 +1137,17 @@

Method Details

"A String", ], }, + "toolCall": { # Represents a call of a specific tool's action with the specified inputs. # Returns the definition of a tool call that should be executed by the client. + "action": "A String", # Required. The name of the tool's action associated with this call. + "inputParameters": { # Optional. The action's input parameters. + "a_key": "", # Properties of the object. + }, + "tool": "A String", # Required. The tool associated with this call. Format: `projects//locations//agents//tools/`. + }, }, - ], - "returnPartialResponses": True or False, # Whether Dialogflow should return currently queued fulfillment response messages in streaming APIs. If a webhook is specified, it happens before Dialogflow invokes webhook. Warning: 1) This flag only affects streaming API. Responses are still queued and returned once in non-streaming API. 2) The flag can be enabled in any fulfillment but only the first 3 partial responses will be returned. You may only want to apply it to fulfillments that have slow webhooks. - "setParameterActions": [ # Set parameter values before executing the webhook. - { # Setting a parameter value. - "parameter": "A String", # Display name of the parameter. - "value": "", # The new value of the parameter. A null value clears the parameter. - }, - ], - "tag": "A String", # The value of this field will be populated in the WebhookRequest `fulfillmentInfo.tag` field by Dialogflow when the associated webhook is called. The tag is typically used by the webhook service to identify which fulfillment is being called, but it could be used for other purposes. This field is required if `webhook` is specified. - "webhook": "A String", # The webhook to call. Format: `projects//locations//agents//webhooks/`. - }, - }, - ], - }, - "isList": True or False, # Indicates whether the parameter represents a list of values. - "redact": True or False, # Indicates whether the parameter content should be redacted in log. If redaction is enabled, the parameter content will be replaced by parameter name during logging. Note: the parameter content is subject to redaction if either parameter level redaction or entity type level redaction is enabled. - "required": True or False, # 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. - }, - ], - }, - "knowledgeConnectorSettings": { # The Knowledge Connector settings for this page or flow. This includes information such as the attached Knowledge Bases, and the way to execute fulfillment. # Optional. Knowledge connector configuration. - "dataStoreConnections": [ # Optional. List of related data store connections. - { # A data store connection. It represents a data store in Discovery Engine and the type of the contents it contains. - "dataStore": "A String", # The full name of the referenced data store. Formats: `projects/{project}/locations/{location}/collections/{collection}/dataStores/{data_store}` `projects/{project}/locations/{location}/dataStores/{data_store}` - "dataStoreType": "A String", # The type of the connected data store. - }, - ], - "enabled": True or False, # Whether Knowledge Connector is enabled or not. - "targetFlow": "A String", # The target flow to transition to. Format: `projects//locations//agents//flows/`. - "targetPage": "A String", # The target page to transition to. Format: `projects//locations//agents//flows//pages/`. - "triggerFulfillment": { # A fulfillment can do one or more of the following actions at the same time: * Generate rich message responses. * Set parameter values. * Call the webhook. Fulfillments can be called at various stages in the Page or Form lifecycle. For example, when a DetectIntentRequest drives a session to enter a new page, the page's entry fulfillment can add a static response to the QueryResult in the returning DetectIntentResponse, call the webhook (for example, to load user data from a database), or both. # The fulfillment to be triggered. When the answers from the Knowledge Connector are selected by Dialogflow, you can utitlize the request scoped parameter `$request.knowledge.answers` (contains up to the 5 highest confidence answers) and `$request.knowledge.questions` (contains the corresponding questions) to construct the fulfillment. - "advancedSettings": { # Hierarchical advanced settings for agent/flow/page/fulfillment/parameter. Settings exposed at lower level overrides the settings exposed at higher level. Overriding occurs at the sub-setting level. For example, the playback_interruption_settings at fulfillment level only overrides the playback_interruption_settings at the agent level, leaving other settings at the agent level unchanged. DTMF settings does not override each other. DTMF settings set at different levels define DTMF detections running in parallel. Hierarchy: Agent->Flow->Page->Fulfillment/Parameter. # Hierarchical advanced settings for this fulfillment. The settings exposed at the lower level overrides the settings exposed at the higher level. - "audioExportGcsDestination": { # Google Cloud Storage location for a Dialogflow operation that writes or exports objects (e.g. exported agent or transcripts) outside of Dialogflow. # If present, incoming audio is exported by Dialogflow to the configured Google Cloud Storage destination. Exposed at the following levels: - Agent level - Flow level - "uri": "A String", # Required. The Google Cloud Storage URI for the exported objects. A URI is of the form: `gs://bucket/object-name-or-prefix` Whether a full object name, or just a prefix, its usage depends on the Dialogflow operation. - }, - "dtmfSettings": { # Define behaviors for DTMF (dual tone multi frequency). # Settings for DTMF. Exposed at the following levels: - Agent level - Flow level - Page level - Parameter level. - "enabled": True or False, # If true, incoming audio is processed for DTMF (dual tone multi frequency) events. For example, if the caller presses a button on their telephone keypad and DTMF processing is enabled, Dialogflow will detect the event (e.g. a "3" was pressed) in the incoming audio and pass the event to the bot to drive business logic (e.g. when 3 is pressed, return the account balance). - "endpointingTimeoutDuration": "A String", # Endpoint timeout setting for matching dtmf input to regex. - "finishDigit": "A String", # The digit that terminates a DTMF digit sequence. - "interdigitTimeoutDuration": "A String", # Interdigit timeout setting for matching dtmf input to regex. - "maxDigits": 42, # Max length of DTMF digits. - }, - "loggingSettings": { # Define behaviors on logging. # Settings for logging. Settings for Dialogflow History, Contact Center messages, StackDriver logs, and speech logging. Exposed at the following levels: - Agent level. - "enableInteractionLogging": True or False, # If true, DF Interaction logging is currently enabled. - "enableStackdriverLogging": True or False, # If true, StackDriver logging is currently enabled. - }, - "speechSettings": { # Define behaviors of speech to text detection. # Settings for speech to text detection. Exposed at the following levels: - Agent level - Flow level - Page level - Parameter level - "endpointerSensitivity": 42, # Sensitivity of the speech model that detects the end of speech. Scale from 0 to 100. - "models": { # Mapping from language to Speech-to-Text model. The mapped Speech-to-Text model will be selected for requests from its corresponding language. For more information, see [Speech models](https://cloud.google.com/dialogflow/cx/docs/concept/speech-models). - "a_key": "A String", - }, - "noSpeechTimeout": "A String", # Timeout before detecting no speech. - "useTimeoutBasedEndpointing": True or False, # Use timeout based endpointing, interpreting endpointer sensitivy as seconds of timeout value. - }, - }, - "conditionalCases": [ # Conditional cases for this fulfillment. - { # A list of cascading if-else conditions. Cases are mutually exclusive. The first one with a matching condition is selected, all the rest ignored. - "cases": [ # A list of cascading if-else conditions. - { # Each case has a Boolean condition. When it is evaluated to be True, the corresponding messages will be selected and evaluated recursively. - "caseContent": [ # A list of case content. - { # The list of messages or conditional cases to activate for this case. - "additionalCases": # Object with schema name: GoogleCloudDialogflowCxV3beta1FulfillmentConditionalCases # Additional cases to be evaluated. - "message": { # 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. # Returned message. - "channel": "A String", # The channel which the response is associated with. Clients can specify the channel via QueryParameters.channel, and only associated channel response will be returned. - "conversationSuccess": { # 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. # Indicates that the conversation succeeded. - "metadata": { # Custom metadata. Dialogflow doesn't impose any structure on this. - "a_key": "", # Properties of the object. - }, - }, - "endInteraction": { # 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. # Output only. A signal that indicates the interaction with the Dialogflow agent has ended. This message is generated by Dialogflow only when the conversation reaches `END_SESSION` page. It is not supposed to be defined by the user. It's guaranteed that there is at most one such message in each response. - }, - "knowledgeInfoCard": { # Represents info card response. If the response contains generative knowledge prediction, Dialogflow will return a payload with Infobot Messenger compatible info card. Otherwise, the info card response is skipped. # Represents info card for knowledge answers, to be better rendered in Dialogflow Messenger. - }, - "liveAgentHandoff": { # 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. # Hands off conversation to a human agent. - "metadata": { # Custom metadata for your handoff procedure. Dialogflow doesn't impose any structure on this. - "a_key": "", # Properties of the object. - }, - }, - "mixedAudio": { # 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. # Output only. An audio response message composed of both the synthesized Dialogflow agent responses and responses defined via play_audio. This message is generated by Dialogflow only and not supposed to be defined by the user. - "segments": [ # Segments this audio response is composed of. - { # Represents one segment of audio. - "allowPlaybackInterruption": True or False, # 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. - "audio": "A String", # Raw audio synthesized from the Dialogflow agent's response using the output config specified in the request. - "uri": "A String", # Client-specific URI that points to an audio clip accessible to the client. Dialogflow does not impose any validation on it. - }, - ], - }, - "outputAudioText": { # A text or ssml response that is preferentially used for TTS output audio synthesis, as described in the comment on the ResponseMessage message. # A text or ssml response that is preferentially used for TTS output audio synthesis, as described in the comment on the ResponseMessage message. - "allowPlaybackInterruption": True or False, # 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. - "ssml": "A String", # The SSML text to be synthesized. For more information, see [SSML](/speech/text-to-speech/docs/ssml). - "text": "A String", # The raw text to be synthesized. - }, - "payload": { # Returns a response containing a custom, platform-specific payload. - "a_key": "", # Properties of the object. - }, - "playAudio": { # Specifies an audio clip to be played by the client as part of the response. # Signal that the client should play an audio clip hosted at a client-specific URI. Dialogflow uses this to construct mixed_audio. However, Dialogflow itself does not try to read or process the URI in any way. - "allowPlaybackInterruption": True or False, # 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. - "audioUri": "A String", # Required. URI of the audio clip. Dialogflow does not impose any validation on this value. It is specific to the client that reads it. - }, - "telephonyTransferCall": { # Represents the signal that telles the client to transfer the phone call connected to the agent to a third-party endpoint. # A signal that the client should transfer the phone call connected to this agent to a third-party endpoint. - "phoneNumber": "A String", # Transfer the call to a phone number in [E.164 format](https://en.wikipedia.org/wiki/E.164). - }, - "text": { # The text response message. # Returns a text response. - "allowPlaybackInterruption": True or False, # 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. - "text": [ # Required. A collection of text responses. - "A String", - ], - }, - }, - }, - ], - "condition": "A String", # The condition to activate and select this case. Empty means the condition is always true. The condition is evaluated against form parameters or session parameters. See the [conditions reference](https://cloud.google.com/dialogflow/cx/docs/reference/condition). + }, + ], + "condition": "A String", # The condition to activate and select this case. Empty means the condition is always true. The condition is evaluated against form parameters or session parameters. See the [conditions reference](https://cloud.google.com/dialogflow/cx/docs/reference/condition). }, ], }, @@ -1621,6 +1200,13 @@

Method Details

"A String", ], }, + "toolCall": { # Represents a call of a specific tool's action with the specified inputs. # Returns the definition of a tool call that should be executed by the client. + "action": "A String", # Required. The name of the tool's action associated with this call. + "inputParameters": { # Optional. The action's input parameters. + "a_key": "", # Properties of the object. + }, + "tool": "A String", # Required. The tool associated with this call. Format: `projects//locations//agents//tools/`. + }, }, ], "returnPartialResponses": True or False, # Whether Dialogflow should return currently queued fulfillment response messages in streaming APIs. If a webhook is specified, it happens before Dialogflow invokes webhook. Warning: 1) This flag only affects streaming API. Responses are still queued and returned once in non-streaming API. 2) The flag can be enabled in any fulfillment but only the first 3 partial responses will be returned. You may only want to apply it to fulfillments that have slow webhooks. @@ -1634,11 +1220,22 @@

Method Details

"webhook": "A String", # The webhook to call. Format: `projects//locations//agents//webhooks/`. }, }, - "name": "A String", # The unique identifier of the page. Required for the Pages.UpdatePage method. Pages.CreatePage populates the name automatically. Format: `projects//locations//agents//flows//pages/`. - "transitionRouteGroups": [ # Ordered list of `TransitionRouteGroups` added to the page. Transition route groups must be unique within a page. If the page links both flow-level transition route groups and agent-level transition route groups, the flow-level ones will have higher priority and will be put before the agent-level ones. * If multiple transition routes within a page scope refer to the same intent, then the precedence order is: page's transition route -> page's transition route group -> flow's transition routes. * If multiple transition route groups within a page contain the same intent, then the first group in the ordered list takes precedence. Format:`projects//locations//agents//flows//transitionRouteGroups/` or `projects//locations//agents//transitionRouteGroups/` for agent-level groups. + "multiLanguageSettings": { # Settings for multi-lingual agents. # Optional. Multi-lingual agent settings for this flow. + "enableMultiLanguageDetection": True or False, # Optional. Enable multi-language detection for this flow. This can be set only if agent level multi language setting is enabled. + "supportedResponseLanguageCodes": [ # Optional. Agent will respond in the detected language if the detected language code is in the supported resolved languages for this flow. This will be used only if multi-language training is enabled in the agent and multi-language detection is enabled in the flow. The supported languages must be a subset of the languages supported by the agent. + "A String", + ], + }, + "name": "A String", # The unique identifier of the flow. Format: `projects//locations//agents//flows/`. + "nluSettings": { # Settings related to NLU. # NLU related settings of the flow. + "classificationThreshold": 3.14, # To filter out false positive results and still get variety in matched natural language inputs for your agent, you can tune the machine learning classification threshold. If the returned score value is less than the threshold value, then a no-match event will be triggered. The score values range from 0.0 (completely uncertain) to 1.0 (completely certain). If set to 0.0, the default of 0.3 is used. + "modelTrainingMode": "A String", # Indicates NLU model training mode. + "modelType": "A String", # Indicates the type of NLU model. + }, + "transitionRouteGroups": [ # A flow's transition route group serve two purposes: * They are responsible for matching the user's first utterances in the flow. * They are inherited by every page's transition route groups. Transition route groups defined in the page have higher priority than those defined in the flow. Format:`projects//locations//agents//flows//transitionRouteGroups/` or `projects//locations//agents//transitionRouteGroups/` for agent-level groups. "A String", ], - "transitionRoutes": [ # A list of transitions for the transition rules of this page. They route the conversation to another page in the same flow, or another flow. When we are in a certain page, the TransitionRoutes are evalauted in the following order: * TransitionRoutes defined in the page with intent specified. * TransitionRoutes defined in the transition route groups with intent specified. * TransitionRoutes defined in flow with intent specified. * TransitionRoutes defined in the transition route groups with intent specified. * TransitionRoutes defined in the page with only condition specified. * TransitionRoutes defined in the transition route groups with only condition specified. + "transitionRoutes": [ # A flow's transition routes serve two purposes: * They are responsible for matching the user's first utterances in the flow. * They are inherited by every page's transition routes and can support use cases such as the user saying "help" or "can I talk to a human?", which can be handled in a common way regardless of the current page. Transition routes defined in the page have higher priority than those defined in the flow. TransitionRoutes are evalauted in the following order: * TransitionRoutes with intent specified. * TransitionRoutes with only condition specified. TransitionRoutes with intent specified are inherited by pages in the flow. { # A transition route specifies a intent that can be matched and/or a data condition that can be evaluated during a session. When a specified transition is matched, the following actions are taken in order: * If there is a `trigger_fulfillment` associated with the transition, it will be called. * If there is a `target_page` associated with the transition, the session will transition into the specified page. * If there is a `target_flow` associated with the transition, the session will transition into the specified flow. "condition": "A String", # The condition to evaluate against form parameters or session parameters. See the [conditions reference](https://cloud.google.com/dialogflow/cx/docs/reference/condition). At least one of `intent` or `condition` must be specified. When both `intent` and `condition` are specified, the transition can only happen when both are fulfilled. "description": "A String", # Optional. The description of the transition route. The maximum length is 500 characters. @@ -1659,8 +1256,8 @@

Method Details

"maxDigits": 42, # Max length of DTMF digits. }, "loggingSettings": { # Define behaviors on logging. # Settings for logging. Settings for Dialogflow History, Contact Center messages, StackDriver logs, and speech logging. Exposed at the following levels: - Agent level. - "enableInteractionLogging": True or False, # If true, DF Interaction logging is currently enabled. - "enableStackdriverLogging": True or False, # If true, StackDriver logging is currently enabled. + "enableInteractionLogging": True or False, # Enables DF Interaction logging. + "enableStackdriverLogging": True or False, # Enables StackDriver logging. }, "speechSettings": { # Define behaviors of speech to text detection. # Settings for speech to text detection. Exposed at the following levels: - Agent level - Flow level - Page level - Parameter level "endpointerSensitivity": 42, # Sensitivity of the speech model that detects the end of speech. Scale from 0 to 100. @@ -1724,6 +1321,13 @@

Method Details

"A String", ], }, + "toolCall": { # Represents a call of a specific tool's action with the specified inputs. # Returns the definition of a tool call that should be executed by the client. + "action": "A String", # Required. The name of the tool's action associated with this call. + "inputParameters": { # Optional. The action's input parameters. + "a_key": "", # Properties of the object. + }, + "tool": "A String", # Required. The tool associated with this call. Format: `projects//locations//agents//tools/`. + }, }, }, ], @@ -1780,6 +1384,13 @@

Method Details

"A String", ], }, + "toolCall": { # Represents a call of a specific tool's action with the specified inputs. # Returns the definition of a tool call that should be executed by the client. + "action": "A String", # Required. The name of the tool's action associated with this call. + "inputParameters": { # Optional. The action's input parameters. + "a_key": "", # Properties of the object. + }, + "tool": "A String", # Required. The tool associated with this call. Format: `projects//locations//agents//tools/`. + }, }, ], "returnPartialResponses": True or False, # Whether Dialogflow should return currently queued fulfillment response messages in streaming APIs. If a webhook is specified, it happens before Dialogflow invokes webhook. Warning: 1) This flag only affects streaming API. Responses are still queued and returned once in non-streaming API. 2) The flag can be enabled in any fulfillment but only the first 3 partial responses will be returned. You may only want to apply it to fulfillments that have slow webhooks. @@ -1795,1249 +1406,760 @@

Method Details

}, ], }, - "dataStoreConnectionSignals": { # Data store connection feature output signals. Might be only partially field if processing stop before the final answer. Reasons for this can be, but are not limited to: empty UCS search results, positive RAI check outcome, grounding failure, ... # Optional. Data store connection feature output signals. Filled only when data stores are involved in serving the query and DetectIntentRequest.populate data_store_connection_quality_signals is set to true in the request. - "answer": "A String", # Optional. The final compiled answer. - "answerGenerationModelCallSignals": { # Diagnostic info related to the answer generation model call. # Optional. Diagnostic info related to the answer generation model call. - "modelOutput": "A String", # Output of the generative model. - "renderedPrompt": "A String", # Prompt as sent to the model. - }, - "answerParts": [ # Optional. Answer parts with relevant citations. Concatenation of texts should add up the `answer` (not counting whitespaces). - { # Answer part with citation. - "supportingIndices": [ # Citations for this answer part. Indices of `search_snippets`. - 42, - ], - "text": "A String", # Substring of the answer. - }, - ], - "citedSnippets": [ # Optional. Snippets cited by the answer generation model from the most to least relevant. - { # Snippet cited by the answer generation model. - "searchSnippet": { # Search snippet details. # Details of the snippet. - "documentTitle": "A String", # Title of the enclosing document. - "documentUri": "A String", # Uri for the document. Present if specified for the document. - "text": "A String", # Text included in the prompt. - }, - "snippetIndex": 42, # Index of the snippet in `search_snippets` field. - }, - ], - "groundingSignals": { # Grounding signals. # Optional. Grounding signals. - "decision": "A String", # Represents the decision of the grounding check. - "score": "A String", # Grounding score bucket setting. - }, - "rewriterModelCallSignals": { # Diagnostic info related to the rewriter model call. # Optional. Diagnostic info related to the rewriter model call. - "modelOutput": "A String", # Output of the generative model. - "renderedPrompt": "A String", # Prompt as sent to the model. - }, - "rewrittenQuery": "A String", # Optional. Rewritten string query used for search. - "safetySignals": { # Safety check results. # Optional. Safety check result. - "bannedPhraseMatch": "A String", # Specifies banned phrase match subject. - "decision": "A String", # Safety decision. - "matchedBannedPhrase": "A String", # The matched banned phrase if there was a match. - }, - "searchSnippets": [ # Optional. Search snippets included in the answer generation prompt. - { # Search snippet details. - "documentTitle": "A String", # Title of the enclosing document. - "documentUri": "A String", # Uri for the document. Present if specified for the document. - "text": "A String", # Text included in the prompt. + "currentPage": { # A Dialogflow CX conversation (session) can be described and visualized as a state machine. The states of a CX session are represented by pages. For each flow, you define many pages, where your combined pages can handle a complete conversation on the topics the flow is designed for. At any given moment, exactly one page is the current page, the current page is considered active, and the flow associated with that page is considered active. Every flow has a special start page. When a flow initially becomes active, the start page page becomes the current page. For each conversational turn, the current page will either stay the same or transition to another page. You configure each page to collect information from the end-user that is relevant for the conversational state represented by the page. For more information, see the [Page guide](https://cloud.google.com/dialogflow/cx/docs/concept/page). # The current Page. Some, not all fields are filled in this message, including but not limited to `name` and `display_name`. + "advancedSettings": { # Hierarchical advanced settings for agent/flow/page/fulfillment/parameter. Settings exposed at lower level overrides the settings exposed at higher level. Overriding occurs at the sub-setting level. For example, the playback_interruption_settings at fulfillment level only overrides the playback_interruption_settings at the agent level, leaving other settings at the agent level unchanged. DTMF settings does not override each other. DTMF settings set at different levels define DTMF detections running in parallel. Hierarchy: Agent->Flow->Page->Fulfillment/Parameter. # Hierarchical advanced settings for this page. The settings exposed at the lower level overrides the settings exposed at the higher level. + "audioExportGcsDestination": { # Google Cloud Storage location for a Dialogflow operation that writes or exports objects (e.g. exported agent or transcripts) outside of Dialogflow. # If present, incoming audio is exported by Dialogflow to the configured Google Cloud Storage destination. Exposed at the following levels: - Agent level - Flow level + "uri": "A String", # Required. The Google Cloud Storage URI for the exported objects. A URI is of the form: `gs://bucket/object-name-or-prefix` Whether a full object name, or just a prefix, its usage depends on the Dialogflow operation. }, - ], - }, - "diagnosticInfo": { # The free-form diagnostic info. For example, this field could contain webhook call latency. The fields of this data can change without notice, so you should not write code that depends on its structure. One of the fields is called "Alternative Matched Intents", which may aid with debugging. The following describes these intent results: - The list is empty if no intent was matched to end-user input. - Only intents that are referenced in the currently active flow are included. - The matched intent is included. - Other intents that could have matched end-user input, but did not match because they are referenced by intent routes that are out of [scope](https://cloud.google.com/dialogflow/cx/docs/concept/handler#scope), are included. - Other intents referenced by intent routes in scope that matched end-user input, but had a lower confidence score. - "a_key": "", # Properties of the object. - }, - "dtmf": { # Represents the input for dtmf event. # If a DTMF was provided as input, this field will contain a copy of the DtmfInput. - "digits": "A String", # The dtmf digits. - "finishDigit": "A String", # The finish digit (if any). - }, - "intent": { # An intent represents a user's intent to interact with a conversational agent. You can provide information for the Dialogflow API to use to match user input to an intent by adding training phrases (i.e., examples of user input) to your intent. # The Intent that matched the conversational query. Some, not all fields are filled in this message, including but not limited to: `name` and `display_name`. This field is deprecated, please use QueryResult.match instead. - "description": "A String", # Human readable description for better understanding an intent like its scope, content, result etc. Maximum character limit: 140 characters. - "displayName": "A String", # Required. The human-readable name of the intent, unique within the agent. - "isFallback": True or False, # Indicates whether this is a fallback intent. Currently only default fallback intent is allowed in the agent, which is added upon agent creation. Adding training phrases to fallback intent is useful in the case of requests that are mistakenly matched, since training phrases assigned to fallback intents act as negative examples that triggers no-match event. - "labels": { # The key/value metadata to label an intent. Labels can contain lowercase letters, digits and the symbols '-' and '_'. International characters are allowed, including letters from unicase alphabets. Keys must start with a letter. Keys and values can be no longer than 63 characters and no more than 128 bytes. Prefix "sys-" is reserved for Dialogflow defined labels. Currently allowed Dialogflow defined labels include: * sys-head * sys-contextual The above labels do not require value. "sys-head" means the intent is a head intent. "sys-contextual" means the intent is a contextual intent. - "a_key": "A String", - }, - "name": "A String", # The unique identifier of the intent. Required for the Intents.UpdateIntent method. Intents.CreateIntent populates the name automatically. Format: `projects//locations//agents//intents/`. - "parameters": [ # The collection of parameters associated with the intent. - { # Represents an intent parameter. - "entityType": "A String", # Required. The entity type of the parameter. Format: `projects/-/locations/-/agents/-/entityTypes/` for system entity types (for example, `projects/-/locations/-/agents/-/entityTypes/sys.date`), or `projects//locations//agents//entityTypes/` for developer entity types. - "id": "A String", # Required. The unique identifier of the parameter. This field is used by training phrases to annotate their parts. - "isList": True or False, # Indicates whether the parameter represents a list of values. - "redact": True or False, # Indicates whether the parameter content should be redacted in log. If redaction is enabled, the parameter content will be replaced by parameter name during logging. Note: the parameter content is subject to redaction if either parameter level redaction or entity type level redaction is enabled. + "dtmfSettings": { # Define behaviors for DTMF (dual tone multi frequency). # Settings for DTMF. Exposed at the following levels: - Agent level - Flow level - Page level - Parameter level. + "enabled": True or False, # If true, incoming audio is processed for DTMF (dual tone multi frequency) events. For example, if the caller presses a button on their telephone keypad and DTMF processing is enabled, Dialogflow will detect the event (e.g. a "3" was pressed) in the incoming audio and pass the event to the bot to drive business logic (e.g. when 3 is pressed, return the account balance). + "endpointingTimeoutDuration": "A String", # Endpoint timeout setting for matching dtmf input to regex. + "finishDigit": "A String", # The digit that terminates a DTMF digit sequence. + "interdigitTimeoutDuration": "A String", # Interdigit timeout setting for matching dtmf input to regex. + "maxDigits": 42, # Max length of DTMF digits. }, - ], - "priority": 42, # 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. - "trainingPhrases": [ # The collection of training phrases the agent is trained on to identify the intent. - { # Represents an example that the agent is trained on to identify the intent. - "id": "A String", # Output only. The unique identifier of the training phrase. - "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 `parameter_id` field is set. - { # Represents a part of a training phrase. - "parameterId": "A String", # The parameter used to annotate this part of the training phrase. This field is required for annotated parts of the training phrase. - "text": "A String", # Required. The text for this part. - }, - ], - "repeatCount": 42, # Indicates how many times this example was added to the intent. + "loggingSettings": { # Define behaviors on logging. # Settings for logging. Settings for Dialogflow History, Contact Center messages, StackDriver logs, and speech logging. Exposed at the following levels: - Agent level. + "enableInteractionLogging": True or False, # Enables DF Interaction logging. + "enableStackdriverLogging": True or False, # Enables StackDriver logging. }, - ], - }, - "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. This field is deprecated, please use QueryResult.match instead. - "languageCode": "A String", # The language that was triggered during intent detection. See [Language Support](https://cloud.google.com/dialogflow/cx/docs/reference/language) for a list of the currently supported language codes. - "match": { # Represents one match result of MatchIntent. # Intent match result, could be an intent or an event. - "confidence": 3.14, # The confidence of this match. 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. - "event": "A String", # The event that matched the query. Filled for `EVENT`, `NO_MATCH` and `NO_INPUT` match types. - "intent": { # An intent represents a user's intent to interact with a conversational agent. You can provide information for the Dialogflow API to use to match user input to an intent by adding training phrases (i.e., examples of user input) to your intent. # The Intent that matched the query. Some, not all fields are filled in this message, including but not limited to: `name` and `display_name`. Only filled for `INTENT` match type. - "description": "A String", # Human readable description for better understanding an intent like its scope, content, result etc. Maximum character limit: 140 characters. - "displayName": "A String", # Required. The human-readable name of the intent, unique within the agent. - "isFallback": True or False, # Indicates whether this is a fallback intent. Currently only default fallback intent is allowed in the agent, which is added upon agent creation. Adding training phrases to fallback intent is useful in the case of requests that are mistakenly matched, since training phrases assigned to fallback intents act as negative examples that triggers no-match event. - "labels": { # The key/value metadata to label an intent. Labels can contain lowercase letters, digits and the symbols '-' and '_'. International characters are allowed, including letters from unicase alphabets. Keys must start with a letter. Keys and values can be no longer than 63 characters and no more than 128 bytes. Prefix "sys-" is reserved for Dialogflow defined labels. Currently allowed Dialogflow defined labels include: * sys-head * sys-contextual The above labels do not require value. "sys-head" means the intent is a head intent. "sys-contextual" means the intent is a contextual intent. - "a_key": "A String", + "speechSettings": { # Define behaviors of speech to text detection. # Settings for speech to text detection. Exposed at the following levels: - Agent level - Flow level - Page level - Parameter level + "endpointerSensitivity": 42, # Sensitivity of the speech model that detects the end of speech. Scale from 0 to 100. + "models": { # Mapping from language to Speech-to-Text model. The mapped Speech-to-Text model will be selected for requests from its corresponding language. For more information, see [Speech models](https://cloud.google.com/dialogflow/cx/docs/concept/speech-models). + "a_key": "A String", + }, + "noSpeechTimeout": "A String", # Timeout before detecting no speech. + "useTimeoutBasedEndpointing": True or False, # Use timeout based endpointing, interpreting endpointer sensitivy as seconds of timeout value. }, - "name": "A String", # The unique identifier of the intent. Required for the Intents.UpdateIntent method. Intents.CreateIntent populates the name automatically. Format: `projects//locations//agents//intents/`. - "parameters": [ # The collection of parameters associated with the intent. - { # Represents an intent parameter. - "entityType": "A String", # Required. The entity type of the parameter. Format: `projects/-/locations/-/agents/-/entityTypes/` for system entity types (for example, `projects/-/locations/-/agents/-/entityTypes/sys.date`), or `projects//locations//agents//entityTypes/` for developer entity types. - "id": "A String", # Required. The unique identifier of the parameter. This field is used by training phrases to annotate their parts. - "isList": True or False, # Indicates whether the parameter represents a list of values. - "redact": True or False, # Indicates whether the parameter content should be redacted in log. If redaction is enabled, the parameter content will be replaced by parameter name during logging. Note: the parameter content is subject to redaction if either parameter level redaction or entity type level redaction is enabled. + }, + "description": "A String", # The description of the page. The maximum length is 500 characters. + "displayName": "A String", # Required. The human-readable name of the page, unique within the flow. + "entryFulfillment": { # A fulfillment can do one or more of the following actions at the same time: * Generate rich message responses. * Set parameter values. * Call the webhook. Fulfillments can be called at various stages in the Page or Form lifecycle. For example, when a DetectIntentRequest drives a session to enter a new page, the page's entry fulfillment can add a static response to the QueryResult in the returning DetectIntentResponse, call the webhook (for example, to load user data from a database), or both. # The fulfillment to call when the session is entering the page. + "advancedSettings": { # Hierarchical advanced settings for agent/flow/page/fulfillment/parameter. Settings exposed at lower level overrides the settings exposed at higher level. Overriding occurs at the sub-setting level. For example, the playback_interruption_settings at fulfillment level only overrides the playback_interruption_settings at the agent level, leaving other settings at the agent level unchanged. DTMF settings does not override each other. DTMF settings set at different levels define DTMF detections running in parallel. Hierarchy: Agent->Flow->Page->Fulfillment/Parameter. # Hierarchical advanced settings for this fulfillment. The settings exposed at the lower level overrides the settings exposed at the higher level. + "audioExportGcsDestination": { # Google Cloud Storage location for a Dialogflow operation that writes or exports objects (e.g. exported agent or transcripts) outside of Dialogflow. # If present, incoming audio is exported by Dialogflow to the configured Google Cloud Storage destination. Exposed at the following levels: - Agent level - Flow level + "uri": "A String", # Required. The Google Cloud Storage URI for the exported objects. A URI is of the form: `gs://bucket/object-name-or-prefix` Whether a full object name, or just a prefix, its usage depends on the Dialogflow operation. }, - ], - "priority": 42, # 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. - "trainingPhrases": [ # The collection of training phrases the agent is trained on to identify the intent. - { # Represents an example that the agent is trained on to identify the intent. - "id": "A String", # Output only. The unique identifier of the training phrase. - "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 `parameter_id` field is set. - { # Represents a part of a training phrase. - "parameterId": "A String", # The parameter used to annotate this part of the training phrase. This field is required for annotated parts of the training phrase. - "text": "A String", # Required. The text for this part. - }, - ], - "repeatCount": 42, # Indicates how many times this example was added to the intent. + "dtmfSettings": { # Define behaviors for DTMF (dual tone multi frequency). # Settings for DTMF. Exposed at the following levels: - Agent level - Flow level - Page level - Parameter level. + "enabled": True or False, # If true, incoming audio is processed for DTMF (dual tone multi frequency) events. For example, if the caller presses a button on their telephone keypad and DTMF processing is enabled, Dialogflow will detect the event (e.g. a "3" was pressed) in the incoming audio and pass the event to the bot to drive business logic (e.g. when 3 is pressed, return the account balance). + "endpointingTimeoutDuration": "A String", # Endpoint timeout setting for matching dtmf input to regex. + "finishDigit": "A String", # The digit that terminates a DTMF digit sequence. + "interdigitTimeoutDuration": "A String", # Interdigit timeout setting for matching dtmf input to regex. + "maxDigits": 42, # Max length of DTMF digits. }, - ], - }, - "matchType": "A String", # Type of this Match. - "parameters": { # The collection of parameters extracted from the query. 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 then use map, otherwise, depending on the parameter value type, it could be one of string, number, boolean, null, list or map. * MapValue value: If parameter's entity type is a composite entity then use map from composite entity property names to property values, otherwise, use parameter value. - "a_key": "", # Properties of the object. - }, - "resolvedInput": "A String", # Final text input which was matched during MatchIntent. This value can be different from original input sent in request because of spelling correction or other processing. - }, - "parameters": { # The collected session 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 then use map, otherwise, depending on the parameter value type, it could be one of string, number, boolean, null, list or map. * MapValue value: If parameter's entity type is a composite entity then use map from composite entity property names to property values, otherwise, use parameter value. - "a_key": "", # Properties of the object. - }, - "responseMessages": [ # The list of rich messages returned to the client. Responses vary from simple text messages to more sophisticated, structured payloads used to drive complex logic. - { # 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. - "channel": "A String", # The channel which the response is associated with. Clients can specify the channel via QueryParameters.channel, and only associated channel response will be returned. - "conversationSuccess": { # 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. # Indicates that the conversation succeeded. - "metadata": { # Custom metadata. Dialogflow doesn't impose any structure on this. - "a_key": "", # Properties of the object. + "loggingSettings": { # Define behaviors on logging. # Settings for logging. Settings for Dialogflow History, Contact Center messages, StackDriver logs, and speech logging. Exposed at the following levels: - Agent level. + "enableInteractionLogging": True or False, # Enables DF Interaction logging. + "enableStackdriverLogging": True or False, # Enables StackDriver logging. }, - }, - "endInteraction": { # 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. # Output only. A signal that indicates the interaction with the Dialogflow agent has ended. This message is generated by Dialogflow only when the conversation reaches `END_SESSION` page. It is not supposed to be defined by the user. It's guaranteed that there is at most one such message in each response. - }, - "knowledgeInfoCard": { # Represents info card response. If the response contains generative knowledge prediction, Dialogflow will return a payload with Infobot Messenger compatible info card. Otherwise, the info card response is skipped. # Represents info card for knowledge answers, to be better rendered in Dialogflow Messenger. - }, - "liveAgentHandoff": { # 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. # Hands off conversation to a human agent. - "metadata": { # Custom metadata for your handoff procedure. Dialogflow doesn't impose any structure on this. - "a_key": "", # Properties of the object. - }, - }, - "mixedAudio": { # 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. # Output only. An audio response message composed of both the synthesized Dialogflow agent responses and responses defined via play_audio. This message is generated by Dialogflow only and not supposed to be defined by the user. - "segments": [ # Segments this audio response is composed of. - { # Represents one segment of audio. - "allowPlaybackInterruption": True or False, # 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. - "audio": "A String", # Raw audio synthesized from the Dialogflow agent's response using the output config specified in the request. - "uri": "A String", # Client-specific URI that points to an audio clip accessible to the client. Dialogflow does not impose any validation on it. + "speechSettings": { # Define behaviors of speech to text detection. # Settings for speech to text detection. Exposed at the following levels: - Agent level - Flow level - Page level - Parameter level + "endpointerSensitivity": 42, # Sensitivity of the speech model that detects the end of speech. Scale from 0 to 100. + "models": { # Mapping from language to Speech-to-Text model. The mapped Speech-to-Text model will be selected for requests from its corresponding language. For more information, see [Speech models](https://cloud.google.com/dialogflow/cx/docs/concept/speech-models). + "a_key": "A String", }, - ], - }, - "outputAudioText": { # A text or ssml response that is preferentially used for TTS output audio synthesis, as described in the comment on the ResponseMessage message. # A text or ssml response that is preferentially used for TTS output audio synthesis, as described in the comment on the ResponseMessage message. - "allowPlaybackInterruption": True or False, # 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. - "ssml": "A String", # The SSML text to be synthesized. For more information, see [SSML](/speech/text-to-speech/docs/ssml). - "text": "A String", # The raw text to be synthesized. - }, - "payload": { # Returns a response containing a custom, platform-specific payload. - "a_key": "", # Properties of the object. - }, - "playAudio": { # Specifies an audio clip to be played by the client as part of the response. # Signal that the client should play an audio clip hosted at a client-specific URI. Dialogflow uses this to construct mixed_audio. However, Dialogflow itself does not try to read or process the URI in any way. - "allowPlaybackInterruption": True or False, # 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. - "audioUri": "A String", # Required. URI of the audio clip. Dialogflow does not impose any validation on this value. It is specific to the client that reads it. - }, - "telephonyTransferCall": { # Represents the signal that telles the client to transfer the phone call connected to the agent to a third-party endpoint. # A signal that the client should transfer the phone call connected to this agent to a third-party endpoint. - "phoneNumber": "A String", # Transfer the call to a phone number in [E.164 format](https://en.wikipedia.org/wiki/E.164). - }, - "text": { # The text response message. # Returns a text response. - "allowPlaybackInterruption": True or False, # 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. - "text": [ # Required. A collection of text responses. - "A String", - ], - }, - }, - ], - "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. # The sentiment analyss result, which depends on `analyze_query_text_sentiment`, specified in the request. - "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). - "score": 3.14, # Sentiment score between -1.0 (negative sentiment) and 1.0 (positive sentiment). - }, - "text": "A String", # If natural language text was provided as input, this field will contain a copy of the text. - "transcript": "A String", # If natural language speech audio was provided as input, this field will contain the transcript for the audio. - "triggerEvent": "A String", # If an event was provided as input, this field will contain the name of the event. - "triggerIntent": "A String", # If an intent was provided as input, this field will contain a copy of the intent identifier. Format: `projects//locations//agents//intents/`. - "webhookDisplayNames": [ # The list of webhook display names in the order of call sequence. - "A String", - ], - "webhookIds": [ # The list of webhook ids in the order of call sequence. - "A String", - ], - "webhookLatencies": [ # The list of webhook latencies in the order of call sequence. - "A String", - ], - "webhookPayloads": [ # The list of webhook payload in WebhookResponse.payload, in the order of call sequence. If some webhook call fails or doesn't return any payload, an empty `Struct` would be used instead. - { - "a_key": "", # Properties of the object. - }, - ], - "webhookStatuses": [ # The list of webhook call status in the order of call sequence. - { # 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). - "code": 42, # The status code, which should be an enum value of google.rpc.Code. - "details": [ # A list of messages that carry the error details. There is a common set of message types for APIs to use. - { - "a_key": "", # Properties of the object. Contains field @type with type URL. + "noSpeechTimeout": "A String", # Timeout before detecting no speech. + "useTimeoutBasedEndpointing": True or False, # Use timeout based endpointing, interpreting endpointer sensitivy as seconds of timeout value. }, - ], - "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. - }, - ], - "webhookTags": [ # The list of webhook tags in the order of call sequence. - "A String", - ], - }, - "responseId": "A String", # Output only. The unique identifier of the response. It can be used to locate a response in the training example set or for reporting issues. - "responseType": "A String", # Response type. - }, - ], - "request": { # The request to detect user's intent. # The request of the interaction. - "outputAudioConfig": { # Instructs the speech synthesizer how to generate the output audio content. # Instructs the speech synthesizer how to generate the output audio. - "audioEncoding": "A String", # Required. Audio encoding of the synthesized audio content. - "sampleRateHertz": 42, # Optional. 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). - "synthesizeSpeechConfig": { # Configuration of how speech should be synthesized. # Optional. Configuration of how speech should be synthesized. If not specified, Agent.text_to_speech_settings is applied. - "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. - "A String", - ], - "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. - "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. - "voice": { # Description of which voice to use for speech synthesis. # Optional. The desired voice of the synthesized audio. - "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. For the list of available voices, please refer to [Supported voices and languages](https://cloud.google.com/text-to-speech/docs/voices). - "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. - }, - "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. - }, - }, - "queryInput": { # Represents the query input. It can contain one of: 1. A conversational query in the form of text. 2. An intent query that specifies which intent to trigger. 3. Natural language speech audio to be processed. 4. An event to be triggered. 5. DTMF digits to invoke an intent and fill in parameter value. 6. The results of a tool executed by the client. # Required. The input specification. - "audio": { # Represents the natural speech audio to be processed. # The natural language speech audio to be processed. - "audio": "A String", # The natural language speech audio to be processed. A single request can contain up to 2 minutes of speech audio data. The transcribed text cannot contain more than 256 bytes. For non-streaming audio detect intent, both `config` and `audio` must be provided. For streaming audio detect intent, `config` must be provided in the first request and `audio` must be provided in all following requests. - "config": { # Instructs the speech recognizer on how to process the audio content. # Required. Instructs the speech recognizer how to process the speech audio. - "audioEncoding": "A String", # Required. Audio encoding of the audio content to process. - "bargeInConfig": { # Configuration of the barge-in behavior. Barge-in instructs the API to return a detected utterance at a proper time while the client is playing back the response audio from a previous request. When the client sees the utterance, it should stop the playback and immediately get ready for receiving the responses for the current request. The barge-in handling requires the client to start streaming audio input as soon as it starts playing back the audio from the previous response. The playback is modeled into two phases: * No barge-in phase: which goes first and during which speech detection should not be carried out. * Barge-in phase: which follows the no barge-in phase and during which the API starts speech detection and may inform the client that an utterance has been detected. Note that no-speech event is not expected in this phase. The client provides this configuration in terms of the durations of those two phases. The durations are measured in terms of the audio length from the the start of the input audio. No-speech event is a response with END_OF_UTTERANCE without any transcript following up. # Configuration of barge-in behavior during the streaming of input audio. - "noBargeInDuration": "A String", # Duration that is not eligible for barge-in at the beginning of the input audio. - "totalDuration": "A String", # Total duration for the playback at the beginning of the input audio. - }, - "enableWordInfo": True or False, # Optional. If `true`, Dialogflow returns SpeechWordInfo in StreamingRecognitionResult with information about the recognized speech words, e.g. start and end time offsets. If false or unspecified, Speech doesn't return any word-level information. - "model": "A String", # Optional. Which Speech model to select for the given request. For more information, see [Speech models](https://cloud.google.com/dialogflow/cx/docs/concept/speech-models). - "modelVariant": "A String", # Optional. Which variant of the Speech model to use. - "optOutConformerModelMigration": True or False, # If `true`, the request will opt out for STT conformer model migration. This field will be deprecated once force migration takes place in June 2024. Please refer to [Dialogflow CX Speech model migration](https://cloud.google.com/dialogflow/cx/docs/concept/speech-model-migration). - "phraseHints": [ # Optional. A list of strings containing words and phrases that the speech recognizer should recognize with higher likelihood. See [the Cloud Speech documentation](https://cloud.google.com/speech-to-text/docs/basics#phrase-hints) for more details. - "A String", - ], - "sampleRateHertz": 42, # Sample rate (in Hertz) of the audio content sent in the query. Refer to [Cloud Speech API documentation](https://cloud.google.com/speech-to-text/docs/basics) for more details. - "singleUtterance": True or False, # Optional. If `false` (default), recognition does not cease until the client closes the stream. If `true`, the recognizer will detect a single spoken utterance in input audio. Recognition ceases when it detects the audio's voice has stopped or paused. In this case, once a detected intent is received, the client should close the stream and start a new request with a new stream as needed. Note: This setting is relevant only for streaming methods. - }, - }, - "dtmf": { # Represents the input for dtmf event. # The DTMF event to be handled. - "digits": "A String", # The dtmf digits. - "finishDigit": "A String", # The finish digit (if any). - }, - "event": { # Represents the event to trigger. # The event to be triggered. - "event": "A String", # Name of the event. - }, - "intent": { # Represents the intent to trigger programmatically rather than as a result of natural language processing. # The intent to be triggered. - "intent": "A String", # Required. The unique identifier of the intent. Format: `projects//locations//agents//intents/`. - }, - "languageCode": "A String", # Required. The language of the input. See [Language Support](https://cloud.google.com/dialogflow/cx/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. - "text": { # Represents the natural language text to be processed. # The natural language text to be processed. - "text": "A String", # Required. The UTF-8 encoded natural language text to be processed. - }, - }, - "queryParams": { # Represents the parameters of a conversational query. # The parameters of this query. - "analyzeQueryTextSentiment": True or False, # Configures whether sentiment analysis should be performed. If not provided, sentiment analysis is not performed. - "channel": "A String", # The channel which this query is for. If specified, only the ResponseMessage associated with the channel will be returned. If no ResponseMessage is associated with the channel, it falls back to the ResponseMessage with unspecified channel. If unspecified, the ResponseMessage with unspecified channel will be returned. - "currentPage": "A String", # The unique identifier of the page to override the current page in the session. Format: `projects//locations//agents//flows//pages/`. If `current_page` is specified, the previous state of the session will be ignored by Dialogflow, including the previous page and the previous session parameters. In most cases, current_page and parameters should be configured together to direct a session to a specific state. - "disableWebhook": True or False, # Whether to disable webhook calls for this request. - "endUserMetadata": { # Optional. Information about the end-user to improve the relevance and accuracy of generative answers. This will be interpreted and used by a language model, so, for good results, the data should be self-descriptive, and in a simple structure. Example: ```json { "subscription plan": "Business Premium Plus", "devices owned": [ {"model": "Google Pixel 7"}, {"model": "Google Pixel Tablet"} ] } ``` - "a_key": "", # Properties of the object. - }, - "flowVersions": [ # A list of flow versions to override for the request. Format: `projects//locations//agents//flows//versions/`. If version 1 of flow X is included in this list, the traffic of flow X will go through version 1 regardless of the version configuration in the environment. Each flow can have at most one version specified in this list. - "A String", - ], - "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. - "latitude": 3.14, # The latitude in degrees. It must be in the range [-90.0, +90.0]. - "longitude": 3.14, # The longitude in degrees. It must be in the range [-180.0, +180.0]. - }, - "parameters": { # Additional parameters to be put into session parameters. To remove a parameter from the session, clients should explicitly set the parameter value to null. You can reference the session parameters in the agent with the following format: $session.params.parameter-id. 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 then use map, otherwise, depending on the parameter value type, it could be one of string, number, boolean, null, list or map. * MapValue value: If parameter's entity type is a composite entity then use map from composite entity property names to property values, otherwise, use parameter value. - "a_key": "", # Properties of the object. - }, - "payload": { # This field can be used to pass custom data into the webhook associated with the agent. Arbitrary JSON objects are supported. Some integrations that query a Dialogflow agent may provide additional information in the payload. In particular, for the Dialogflow Phone Gateway integration, this field has the form: ``` { "telephony": { "caller_id": "+18558363987" } } ``` - "a_key": "", # Properties of the object. - }, - "populateDataStoreConnectionSignals": True or False, # Optional. If set to true and data stores are involved in serving the request then DetectIntentResponse.query_result.data_store_connection_signals will be filled with data that can help evaluations. - "searchConfig": { # Search configuration for UCS search queries. # Optional. Search configuration for UCS search queries. - "boostSpecs": [ # Optional. Boosting configuration for the datastores. - { # Boost specifications for data stores. - "dataStores": [ # Optional. Data Stores where the boosting configuration is applied. The full names of the referenced data stores. Formats: `projects/{project}/locations/{location}/collections/{collection}/dataStores/{data_store}` `projects/{project}/locations/{location}/dataStores/{data_store} - "A String", - ], - "spec": [ # Optional. A list of boosting specifications. - { # Boost specification to boost certain documents. A copy of google.cloud.discoveryengine.v1main.BoostSpec, field documentation is available at https://cloud.google.com/generative-ai-app-builder/docs/reference/rest/v1alpha/BoostSpec - "conditionBoostSpecs": [ # Optional. Condition boost specifications. If a document matches multiple conditions in the specifictions, boost scores from these specifications are all applied and combined in a non-linear way. Maximum number of specifications is 20. - { # Boost applies to documents which match a condition. - "boost": 3.14, # Optional. Strength of the condition boost, which should be in [-1, 1]. Negative boost means demotion. Default is 0.0. Setting to 1.0 gives the document a big promotion. However, it does not necessarily mean that the boosted document will be the top result at all times, nor that other documents will be excluded. Results could still be shown even when none of them matches the condition. And results that are significantly more relevant to the search query can still trump your heavily favored but irrelevant documents. Setting to -1.0 gives the document a big demotion. However, results that are deeply relevant might still be shown. The document will have an upstream battle to get a fairly high ranking, but it is not blocked out completely. Setting to 0.0 means no boost applied. The boosting condition is ignored. - "condition": "A String", # Optional. An expression which specifies a boost condition. The syntax and supported fields are the same as a filter expression. Examples: * To boost documents with document ID "doc_1" or "doc_2", and color "Red" or "Blue": * (id: ANY("doc_1", "doc_2")) AND (color: ANY("Red","Blue")) + }, + "conditionalCases": [ # Conditional cases for this fulfillment. + { # A list of cascading if-else conditions. Cases are mutually exclusive. The first one with a matching condition is selected, all the rest ignored. + "cases": [ # A list of cascading if-else conditions. + { # Each case has a Boolean condition. When it is evaluated to be True, the corresponding messages will be selected and evaluated recursively. + "caseContent": [ # A list of case content. + { # The list of messages or conditional cases to activate for this case. + "additionalCases": # Object with schema name: GoogleCloudDialogflowCxV3beta1FulfillmentConditionalCases # Additional cases to be evaluated. + "message": { # 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. # Returned message. + "channel": "A String", # The channel which the response is associated with. Clients can specify the channel via QueryParameters.channel, and only associated channel response will be returned. + "conversationSuccess": { # 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. # Indicates that the conversation succeeded. + "metadata": { # Custom metadata. Dialogflow doesn't impose any structure on this. + "a_key": "", # Properties of the object. + }, + }, + "endInteraction": { # 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. # Output only. A signal that indicates the interaction with the Dialogflow agent has ended. This message is generated by Dialogflow only when the conversation reaches `END_SESSION` page. It is not supposed to be defined by the user. It's guaranteed that there is at most one such message in each response. + }, + "knowledgeInfoCard": { # Represents info card response. If the response contains generative knowledge prediction, Dialogflow will return a payload with Infobot Messenger compatible info card. Otherwise, the info card response is skipped. # Represents info card for knowledge answers, to be better rendered in Dialogflow Messenger. + }, + "liveAgentHandoff": { # 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. # Hands off conversation to a human agent. + "metadata": { # Custom metadata for your handoff procedure. Dialogflow doesn't impose any structure on this. + "a_key": "", # Properties of the object. + }, + }, + "mixedAudio": { # 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. # Output only. An audio response message composed of both the synthesized Dialogflow agent responses and responses defined via play_audio. This message is generated by Dialogflow only and not supposed to be defined by the user. + "segments": [ # Segments this audio response is composed of. + { # Represents one segment of audio. + "allowPlaybackInterruption": True or False, # 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. + "audio": "A String", # Raw audio synthesized from the Dialogflow agent's response using the output config specified in the request. + "uri": "A String", # Client-specific URI that points to an audio clip accessible to the client. Dialogflow does not impose any validation on it. + }, + ], + }, + "outputAudioText": { # A text or ssml response that is preferentially used for TTS output audio synthesis, as described in the comment on the ResponseMessage message. # A text or ssml response that is preferentially used for TTS output audio synthesis, as described in the comment on the ResponseMessage message. + "allowPlaybackInterruption": True or False, # 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. + "ssml": "A String", # The SSML text to be synthesized. For more information, see [SSML](/speech/text-to-speech/docs/ssml). + "text": "A String", # The raw text to be synthesized. + }, + "payload": { # Returns a response containing a custom, platform-specific payload. + "a_key": "", # Properties of the object. + }, + "playAudio": { # Specifies an audio clip to be played by the client as part of the response. # Signal that the client should play an audio clip hosted at a client-specific URI. Dialogflow uses this to construct mixed_audio. However, Dialogflow itself does not try to read or process the URI in any way. + "allowPlaybackInterruption": True or False, # 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. + "audioUri": "A String", # Required. URI of the audio clip. Dialogflow does not impose any validation on this value. It is specific to the client that reads it. + }, + "telephonyTransferCall": { # Represents the signal that telles the client to transfer the phone call connected to the agent to a third-party endpoint. # A signal that the client should transfer the phone call connected to this agent to a third-party endpoint. + "phoneNumber": "A String", # Transfer the call to a phone number in [E.164 format](https://en.wikipedia.org/wiki/E.164). + }, + "text": { # The text response message. # Returns a text response. + "allowPlaybackInterruption": True or False, # 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. + "text": [ # Required. A collection of text responses. + "A String", + ], + }, + "toolCall": { # Represents a call of a specific tool's action with the specified inputs. # Returns the definition of a tool call that should be executed by the client. + "action": "A String", # Required. The name of the tool's action associated with this call. + "inputParameters": { # Optional. The action's input parameters. + "a_key": "", # Properties of the object. + }, + "tool": "A String", # Required. The tool associated with this call. Format: `projects//locations//agents//tools/`. + }, + }, + }, + ], + "condition": "A String", # The condition to activate and select this case. Empty means the condition is always true. The condition is evaluated against form parameters or session parameters. See the [conditions reference](https://cloud.google.com/dialogflow/cx/docs/reference/condition). }, ], }, ], - }, - ], - "filterSpecs": [ # Optional. Filter configuration for the datastores. - { # Filter specifications for data stores. - "dataStores": [ # Optional. Data Stores where the boosting configuration is applied. The full names of the referenced data stores. Formats: `projects/{project}/locations/{location}/collections/{collection}/dataStores/{data_store}` `projects/{project}/locations/{location}/dataStores/{data_store} - "A String", - ], - "filter": "A String", # Optional. The filter expression to be applied. Expression syntax is documented at https://cloud.google.com/generative-ai-app-builder/docs/filter-search-metadata#filter-expression-syntax - }, - ], - }, - "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. - { # Session entity types are referred to as **User** entity types and are entities that are built for an individual user such as favorites, preferences, playlists, and so on. You can redefine a session entity type at the session level to extend or replace a custom entity type at the user session level (we refer to the entity types defined at the agent level as "custom entity types"). Note: session entity types apply to all queries, regardless of the language. For more information about entity types, see the [Dialogflow documentation](https://cloud.google.com/dialogflow/docs/entities-overview). - "entities": [ # Required. The collection of entities to override or supplement the custom entity type. - { # An **entity entry** for an associated entity type. - "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`. - "A String", - ], - "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 canonical 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). - }, - ], - "entityOverrideMode": "A String", # Required. Indicates whether the additional data should override or supplement the custom entity type definition. - "name": "A String", # Required. The unique identifier of the session entity type. Format: `projects//locations//agents//sessions//entityTypes/` or `projects//locations//agents//environments//sessions//entityTypes/`. If `Environment ID` is not specified, we assume default 'draft' environment. - }, - ], - "sessionTtl": "A String", # Optional. Configure lifetime of the Dialogflow session. By default, a Dialogflow session remains active and its data is stored for 30 minutes after the last request is sent for the session. This value should be no longer than 1 day. - "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 the agent is used. - "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 Dialogflow web console. The headers defined within this field will overwrite the headers configured through 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. - "a_key": "A String", - }, - }, - "session": "A String", # Required. The name of the session this query is sent to. Format: `projects//locations//agents//sessions/` or `projects//locations//agents//environments//sessions/`. If `Environment ID` is not specified, we assume default 'draft' environment. It's up to the API caller to choose an appropriate `Session ID`. It can be a random number or some type of session identifiers (preferably hashed). The length of the `Session ID` must not exceed 36 characters. For more information, see the [sessions guide](https://cloud.google.com/dialogflow/cx/docs/concept/session). Note: Always use agent versions for production traffic. See [Versions and environments](https://cloud.google.com/dialogflow/cx/docs/concept/version). - }, - "requestUtterances": "A String", # The input text or the transcript of the input audio in the request. - "response": { # The message returned from the DetectIntent method. # The final response of the interaction. - "allowCancellation": True or False, # Indicates whether the partial response can be cancelled when a later response arrives. e.g. if the agent specified some music as partial response, it can be cancelled. - "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.response_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. - "outputAudioConfig": { # Instructs the speech synthesizer how to generate the output audio content. # The config used by the speech synthesizer to generate the output audio. - "audioEncoding": "A String", # Required. Audio encoding of the synthesized audio content. - "sampleRateHertz": 42, # Optional. 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). - "synthesizeSpeechConfig": { # Configuration of how speech should be synthesized. # Optional. Configuration of how speech should be synthesized. If not specified, Agent.text_to_speech_settings is applied. - "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. - "A String", - ], - "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. - "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. - "voice": { # Description of which voice to use for speech synthesis. # Optional. The desired voice of the synthesized audio. - "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. For the list of available voices, please refer to [Supported voices and languages](https://cloud.google.com/text-to-speech/docs/voices). - "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. - }, - "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. - }, - }, - "queryResult": { # Represents the result of a conversational query. # The result of the conversational query. - "advancedSettings": { # Hierarchical advanced settings for agent/flow/page/fulfillment/parameter. Settings exposed at lower level overrides the settings exposed at higher level. Overriding occurs at the sub-setting level. For example, the playback_interruption_settings at fulfillment level only overrides the playback_interruption_settings at the agent level, leaving other settings at the agent level unchanged. DTMF settings does not override each other. DTMF settings set at different levels define DTMF detections running in parallel. Hierarchy: Agent->Flow->Page->Fulfillment/Parameter. # Returns the current advanced settings including IVR settings. Even though the operations configured by these settings are performed by Dialogflow, the client may need to perform special logic at the moment. For example, if Dialogflow exports audio to Google Cloud Storage, then the client may need to wait for the resulting object to appear in the bucket before proceeding. - "audioExportGcsDestination": { # Google Cloud Storage location for a Dialogflow operation that writes or exports objects (e.g. exported agent or transcripts) outside of Dialogflow. # If present, incoming audio is exported by Dialogflow to the configured Google Cloud Storage destination. Exposed at the following levels: - Agent level - Flow level - "uri": "A String", # Required. The Google Cloud Storage URI for the exported objects. A URI is of the form: `gs://bucket/object-name-or-prefix` Whether a full object name, or just a prefix, its usage depends on the Dialogflow operation. - }, - "dtmfSettings": { # Define behaviors for DTMF (dual tone multi frequency). # Settings for DTMF. Exposed at the following levels: - Agent level - Flow level - Page level - Parameter level. - "enabled": True or False, # If true, incoming audio is processed for DTMF (dual tone multi frequency) events. For example, if the caller presses a button on their telephone keypad and DTMF processing is enabled, Dialogflow will detect the event (e.g. a "3" was pressed) in the incoming audio and pass the event to the bot to drive business logic (e.g. when 3 is pressed, return the account balance). - "endpointingTimeoutDuration": "A String", # Endpoint timeout setting for matching dtmf input to regex. - "finishDigit": "A String", # The digit that terminates a DTMF digit sequence. - "interdigitTimeoutDuration": "A String", # Interdigit timeout setting for matching dtmf input to regex. - "maxDigits": 42, # Max length of DTMF digits. - }, - "loggingSettings": { # Define behaviors on logging. # Settings for logging. Settings for Dialogflow History, Contact Center messages, StackDriver logs, and speech logging. Exposed at the following levels: - Agent level. - "enableInteractionLogging": True or False, # If true, DF Interaction logging is currently enabled. - "enableStackdriverLogging": True or False, # If true, StackDriver logging is currently enabled. - }, - "speechSettings": { # Define behaviors of speech to text detection. # Settings for speech to text detection. Exposed at the following levels: - Agent level - Flow level - Page level - Parameter level - "endpointerSensitivity": 42, # Sensitivity of the speech model that detects the end of speech. Scale from 0 to 100. - "models": { # Mapping from language to Speech-to-Text model. The mapped Speech-to-Text model will be selected for requests from its corresponding language. For more information, see [Speech models](https://cloud.google.com/dialogflow/cx/docs/concept/speech-models). - "a_key": "A String", - }, - "noSpeechTimeout": "A String", # Timeout before detecting no speech. - "useTimeoutBasedEndpointing": True or False, # Use timeout based endpointing, interpreting endpointer sensitivy as seconds of timeout value. - }, - }, - "allowAnswerFeedback": True or False, # Indicates whether the Thumbs up/Thumbs down rating controls are need to be shown for the response in the Dialogflow Messenger widget. - "currentPage": { # A Dialogflow CX conversation (session) can be described and visualized as a state machine. The states of a CX session are represented by pages. For each flow, you define many pages, where your combined pages can handle a complete conversation on the topics the flow is designed for. At any given moment, exactly one page is the current page, the current page is considered active, and the flow associated with that page is considered active. Every flow has a special start page. When a flow initially becomes active, the start page page becomes the current page. For each conversational turn, the current page will either stay the same or transition to another page. You configure each page to collect information from the end-user that is relevant for the conversational state represented by the page. For more information, see the [Page guide](https://cloud.google.com/dialogflow/cx/docs/concept/page). # The current Page. Some, not all fields are filled in this message, including but not limited to `name` and `display_name`. - "advancedSettings": { # Hierarchical advanced settings for agent/flow/page/fulfillment/parameter. Settings exposed at lower level overrides the settings exposed at higher level. Overriding occurs at the sub-setting level. For example, the playback_interruption_settings at fulfillment level only overrides the playback_interruption_settings at the agent level, leaving other settings at the agent level unchanged. DTMF settings does not override each other. DTMF settings set at different levels define DTMF detections running in parallel. Hierarchy: Agent->Flow->Page->Fulfillment/Parameter. # Hierarchical advanced settings for this page. The settings exposed at the lower level overrides the settings exposed at the higher level. - "audioExportGcsDestination": { # Google Cloud Storage location for a Dialogflow operation that writes or exports objects (e.g. exported agent or transcripts) outside of Dialogflow. # If present, incoming audio is exported by Dialogflow to the configured Google Cloud Storage destination. Exposed at the following levels: - Agent level - Flow level - "uri": "A String", # Required. The Google Cloud Storage URI for the exported objects. A URI is of the form: `gs://bucket/object-name-or-prefix` Whether a full object name, or just a prefix, its usage depends on the Dialogflow operation. - }, - "dtmfSettings": { # Define behaviors for DTMF (dual tone multi frequency). # Settings for DTMF. Exposed at the following levels: - Agent level - Flow level - Page level - Parameter level. - "enabled": True or False, # If true, incoming audio is processed for DTMF (dual tone multi frequency) events. For example, if the caller presses a button on their telephone keypad and DTMF processing is enabled, Dialogflow will detect the event (e.g. a "3" was pressed) in the incoming audio and pass the event to the bot to drive business logic (e.g. when 3 is pressed, return the account balance). - "endpointingTimeoutDuration": "A String", # Endpoint timeout setting for matching dtmf input to regex. - "finishDigit": "A String", # The digit that terminates a DTMF digit sequence. - "interdigitTimeoutDuration": "A String", # Interdigit timeout setting for matching dtmf input to regex. - "maxDigits": 42, # Max length of DTMF digits. - }, - "loggingSettings": { # Define behaviors on logging. # Settings for logging. Settings for Dialogflow History, Contact Center messages, StackDriver logs, and speech logging. Exposed at the following levels: - Agent level. - "enableInteractionLogging": True or False, # If true, DF Interaction logging is currently enabled. - "enableStackdriverLogging": True or False, # If true, StackDriver logging is currently enabled. - }, - "speechSettings": { # Define behaviors of speech to text detection. # Settings for speech to text detection. Exposed at the following levels: - Agent level - Flow level - Page level - Parameter level - "endpointerSensitivity": 42, # Sensitivity of the speech model that detects the end of speech. Scale from 0 to 100. - "models": { # Mapping from language to Speech-to-Text model. The mapped Speech-to-Text model will be selected for requests from its corresponding language. For more information, see [Speech models](https://cloud.google.com/dialogflow/cx/docs/concept/speech-models). - "a_key": "A String", - }, - "noSpeechTimeout": "A String", # Timeout before detecting no speech. - "useTimeoutBasedEndpointing": True or False, # Use timeout based endpointing, interpreting endpointer sensitivy as seconds of timeout value. - }, - }, - "description": "A String", # The description of the page. The maximum length is 500 characters. - "displayName": "A String", # Required. The human-readable name of the page, unique within the flow. - "entryFulfillment": { # A fulfillment can do one or more of the following actions at the same time: * Generate rich message responses. * Set parameter values. * Call the webhook. Fulfillments can be called at various stages in the Page or Form lifecycle. For example, when a DetectIntentRequest drives a session to enter a new page, the page's entry fulfillment can add a static response to the QueryResult in the returning DetectIntentResponse, call the webhook (for example, to load user data from a database), or both. # The fulfillment to call when the session is entering the page. - "advancedSettings": { # Hierarchical advanced settings for agent/flow/page/fulfillment/parameter. Settings exposed at lower level overrides the settings exposed at higher level. Overriding occurs at the sub-setting level. For example, the playback_interruption_settings at fulfillment level only overrides the playback_interruption_settings at the agent level, leaving other settings at the agent level unchanged. DTMF settings does not override each other. DTMF settings set at different levels define DTMF detections running in parallel. Hierarchy: Agent->Flow->Page->Fulfillment/Parameter. # Hierarchical advanced settings for this fulfillment. The settings exposed at the lower level overrides the settings exposed at the higher level. - "audioExportGcsDestination": { # Google Cloud Storage location for a Dialogflow operation that writes or exports objects (e.g. exported agent or transcripts) outside of Dialogflow. # If present, incoming audio is exported by Dialogflow to the configured Google Cloud Storage destination. Exposed at the following levels: - Agent level - Flow level - "uri": "A String", # Required. The Google Cloud Storage URI for the exported objects. A URI is of the form: `gs://bucket/object-name-or-prefix` Whether a full object name, or just a prefix, its usage depends on the Dialogflow operation. - }, - "dtmfSettings": { # Define behaviors for DTMF (dual tone multi frequency). # Settings for DTMF. Exposed at the following levels: - Agent level - Flow level - Page level - Parameter level. - "enabled": True or False, # If true, incoming audio is processed for DTMF (dual tone multi frequency) events. For example, if the caller presses a button on their telephone keypad and DTMF processing is enabled, Dialogflow will detect the event (e.g. a "3" was pressed) in the incoming audio and pass the event to the bot to drive business logic (e.g. when 3 is pressed, return the account balance). - "endpointingTimeoutDuration": "A String", # Endpoint timeout setting for matching dtmf input to regex. - "finishDigit": "A String", # The digit that terminates a DTMF digit sequence. - "interdigitTimeoutDuration": "A String", # Interdigit timeout setting for matching dtmf input to regex. - "maxDigits": 42, # Max length of DTMF digits. - }, - "loggingSettings": { # Define behaviors on logging. # Settings for logging. Settings for Dialogflow History, Contact Center messages, StackDriver logs, and speech logging. Exposed at the following levels: - Agent level. - "enableInteractionLogging": True or False, # If true, DF Interaction logging is currently enabled. - "enableStackdriverLogging": True or False, # If true, StackDriver logging is currently enabled. - }, - "speechSettings": { # Define behaviors of speech to text detection. # Settings for speech to text detection. Exposed at the following levels: - Agent level - Flow level - Page level - Parameter level - "endpointerSensitivity": 42, # Sensitivity of the speech model that detects the end of speech. Scale from 0 to 100. - "models": { # Mapping from language to Speech-to-Text model. The mapped Speech-to-Text model will be selected for requests from its corresponding language. For more information, see [Speech models](https://cloud.google.com/dialogflow/cx/docs/concept/speech-models). - "a_key": "A String", - }, - "noSpeechTimeout": "A String", # Timeout before detecting no speech. - "useTimeoutBasedEndpointing": True or False, # Use timeout based endpointing, interpreting endpointer sensitivy as seconds of timeout value. - }, - }, - "conditionalCases": [ # Conditional cases for this fulfillment. - { # A list of cascading if-else conditions. Cases are mutually exclusive. The first one with a matching condition is selected, all the rest ignored. - "cases": [ # A list of cascading if-else conditions. - { # Each case has a Boolean condition. When it is evaluated to be True, the corresponding messages will be selected and evaluated recursively. - "caseContent": [ # A list of case content. - { # The list of messages or conditional cases to activate for this case. - "additionalCases": # Object with schema name: GoogleCloudDialogflowCxV3beta1FulfillmentConditionalCases # Additional cases to be evaluated. - "message": { # 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. # Returned message. - "channel": "A String", # The channel which the response is associated with. Clients can specify the channel via QueryParameters.channel, and only associated channel response will be returned. - "conversationSuccess": { # 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. # Indicates that the conversation succeeded. - "metadata": { # Custom metadata. Dialogflow doesn't impose any structure on this. - "a_key": "", # Properties of the object. - }, - }, - "endInteraction": { # 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. # Output only. A signal that indicates the interaction with the Dialogflow agent has ended. This message is generated by Dialogflow only when the conversation reaches `END_SESSION` page. It is not supposed to be defined by the user. It's guaranteed that there is at most one such message in each response. - }, - "knowledgeInfoCard": { # Represents info card response. If the response contains generative knowledge prediction, Dialogflow will return a payload with Infobot Messenger compatible info card. Otherwise, the info card response is skipped. # Represents info card for knowledge answers, to be better rendered in Dialogflow Messenger. - }, - "liveAgentHandoff": { # 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. # Hands off conversation to a human agent. - "metadata": { # Custom metadata for your handoff procedure. Dialogflow doesn't impose any structure on this. - "a_key": "", # Properties of the object. - }, - }, - "mixedAudio": { # 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. # Output only. An audio response message composed of both the synthesized Dialogflow agent responses and responses defined via play_audio. This message is generated by Dialogflow only and not supposed to be defined by the user. - "segments": [ # Segments this audio response is composed of. - { # Represents one segment of audio. - "allowPlaybackInterruption": True or False, # 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. - "audio": "A String", # Raw audio synthesized from the Dialogflow agent's response using the output config specified in the request. - "uri": "A String", # Client-specific URI that points to an audio clip accessible to the client. Dialogflow does not impose any validation on it. - }, - ], - }, - "outputAudioText": { # A text or ssml response that is preferentially used for TTS output audio synthesis, as described in the comment on the ResponseMessage message. # A text or ssml response that is preferentially used for TTS output audio synthesis, as described in the comment on the ResponseMessage message. - "allowPlaybackInterruption": True or False, # 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. - "ssml": "A String", # The SSML text to be synthesized. For more information, see [SSML](/speech/text-to-speech/docs/ssml). - "text": "A String", # The raw text to be synthesized. - }, - "payload": { # Returns a response containing a custom, platform-specific payload. - "a_key": "", # Properties of the object. - }, - "playAudio": { # Specifies an audio clip to be played by the client as part of the response. # Signal that the client should play an audio clip hosted at a client-specific URI. Dialogflow uses this to construct mixed_audio. However, Dialogflow itself does not try to read or process the URI in any way. - "allowPlaybackInterruption": True or False, # 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. - "audioUri": "A String", # Required. URI of the audio clip. Dialogflow does not impose any validation on this value. It is specific to the client that reads it. - }, - "telephonyTransferCall": { # Represents the signal that telles the client to transfer the phone call connected to the agent to a third-party endpoint. # A signal that the client should transfer the phone call connected to this agent to a third-party endpoint. - "phoneNumber": "A String", # Transfer the call to a phone number in [E.164 format](https://en.wikipedia.org/wiki/E.164). - }, - "text": { # The text response message. # Returns a text response. - "allowPlaybackInterruption": True or False, # 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. - "text": [ # Required. A collection of text responses. - "A String", - ], - }, - }, + "enableGenerativeFallback": True or False, # If the flag is true, the agent will utilize LLM to generate a text response. If LLM generation fails, the defined responses in the fulfillment will be respected. This flag is only useful for fulfillments associated with no-match event handlers. + "messages": [ # The list of rich message responses to present to the user. + { # 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. + "channel": "A String", # The channel which the response is associated with. Clients can specify the channel via QueryParameters.channel, and only associated channel response will be returned. + "conversationSuccess": { # 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. # Indicates that the conversation succeeded. + "metadata": { # Custom metadata. Dialogflow doesn't impose any structure on this. + "a_key": "", # Properties of the object. + }, + }, + "endInteraction": { # 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. # Output only. A signal that indicates the interaction with the Dialogflow agent has ended. This message is generated by Dialogflow only when the conversation reaches `END_SESSION` page. It is not supposed to be defined by the user. It's guaranteed that there is at most one such message in each response. + }, + "knowledgeInfoCard": { # Represents info card response. If the response contains generative knowledge prediction, Dialogflow will return a payload with Infobot Messenger compatible info card. Otherwise, the info card response is skipped. # Represents info card for knowledge answers, to be better rendered in Dialogflow Messenger. + }, + "liveAgentHandoff": { # 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. # Hands off conversation to a human agent. + "metadata": { # Custom metadata for your handoff procedure. Dialogflow doesn't impose any structure on this. + "a_key": "", # Properties of the object. + }, + }, + "mixedAudio": { # 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. # Output only. An audio response message composed of both the synthesized Dialogflow agent responses and responses defined via play_audio. This message is generated by Dialogflow only and not supposed to be defined by the user. + "segments": [ # Segments this audio response is composed of. + { # Represents one segment of audio. + "allowPlaybackInterruption": True or False, # 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. + "audio": "A String", # Raw audio synthesized from the Dialogflow agent's response using the output config specified in the request. + "uri": "A String", # Client-specific URI that points to an audio clip accessible to the client. Dialogflow does not impose any validation on it. }, ], - "condition": "A String", # The condition to activate and select this case. Empty means the condition is always true. The condition is evaluated against form parameters or session parameters. See the [conditions reference](https://cloud.google.com/dialogflow/cx/docs/reference/condition). }, - ], - }, - ], - "enableGenerativeFallback": True or False, # If the flag is true, the agent will utilize LLM to generate a text response. If LLM generation fails, the defined responses in the fulfillment will be respected. This flag is only useful for fulfillments associated with no-match event handlers. - "messages": [ # The list of rich message responses to present to the user. - { # 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. - "channel": "A String", # The channel which the response is associated with. Clients can specify the channel via QueryParameters.channel, and only associated channel response will be returned. - "conversationSuccess": { # 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. # Indicates that the conversation succeeded. - "metadata": { # Custom metadata. Dialogflow doesn't impose any structure on this. - "a_key": "", # Properties of the object. + "outputAudioText": { # A text or ssml response that is preferentially used for TTS output audio synthesis, as described in the comment on the ResponseMessage message. # A text or ssml response that is preferentially used for TTS output audio synthesis, as described in the comment on the ResponseMessage message. + "allowPlaybackInterruption": True or False, # 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. + "ssml": "A String", # The SSML text to be synthesized. For more information, see [SSML](/speech/text-to-speech/docs/ssml). + "text": "A String", # The raw text to be synthesized. }, - }, - "endInteraction": { # 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. # Output only. A signal that indicates the interaction with the Dialogflow agent has ended. This message is generated by Dialogflow only when the conversation reaches `END_SESSION` page. It is not supposed to be defined by the user. It's guaranteed that there is at most one such message in each response. - }, - "knowledgeInfoCard": { # Represents info card response. If the response contains generative knowledge prediction, Dialogflow will return a payload with Infobot Messenger compatible info card. Otherwise, the info card response is skipped. # Represents info card for knowledge answers, to be better rendered in Dialogflow Messenger. - }, - "liveAgentHandoff": { # 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. # Hands off conversation to a human agent. - "metadata": { # Custom metadata for your handoff procedure. Dialogflow doesn't impose any structure on this. + "payload": { # Returns a response containing a custom, platform-specific payload. "a_key": "", # Properties of the object. }, - }, - "mixedAudio": { # 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. # Output only. An audio response message composed of both the synthesized Dialogflow agent responses and responses defined via play_audio. This message is generated by Dialogflow only and not supposed to be defined by the user. - "segments": [ # Segments this audio response is composed of. - { # Represents one segment of audio. - "allowPlaybackInterruption": True or False, # 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. - "audio": "A String", # Raw audio synthesized from the Dialogflow agent's response using the output config specified in the request. - "uri": "A String", # Client-specific URI that points to an audio clip accessible to the client. Dialogflow does not impose any validation on it. + "playAudio": { # Specifies an audio clip to be played by the client as part of the response. # Signal that the client should play an audio clip hosted at a client-specific URI. Dialogflow uses this to construct mixed_audio. However, Dialogflow itself does not try to read or process the URI in any way. + "allowPlaybackInterruption": True or False, # 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. + "audioUri": "A String", # Required. URI of the audio clip. Dialogflow does not impose any validation on this value. It is specific to the client that reads it. + }, + "telephonyTransferCall": { # Represents the signal that telles the client to transfer the phone call connected to the agent to a third-party endpoint. # A signal that the client should transfer the phone call connected to this agent to a third-party endpoint. + "phoneNumber": "A String", # Transfer the call to a phone number in [E.164 format](https://en.wikipedia.org/wiki/E.164). + }, + "text": { # The text response message. # Returns a text response. + "allowPlaybackInterruption": True or False, # 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. + "text": [ # Required. A collection of text responses. + "A String", + ], + }, + "toolCall": { # Represents a call of a specific tool's action with the specified inputs. # Returns the definition of a tool call that should be executed by the client. + "action": "A String", # Required. The name of the tool's action associated with this call. + "inputParameters": { # Optional. The action's input parameters. + "a_key": "", # Properties of the object. }, - ], - }, - "outputAudioText": { # A text or ssml response that is preferentially used for TTS output audio synthesis, as described in the comment on the ResponseMessage message. # A text or ssml response that is preferentially used for TTS output audio synthesis, as described in the comment on the ResponseMessage message. - "allowPlaybackInterruption": True or False, # 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. - "ssml": "A String", # The SSML text to be synthesized. For more information, see [SSML](/speech/text-to-speech/docs/ssml). - "text": "A String", # The raw text to be synthesized. - }, - "payload": { # Returns a response containing a custom, platform-specific payload. - "a_key": "", # Properties of the object. - }, - "playAudio": { # Specifies an audio clip to be played by the client as part of the response. # Signal that the client should play an audio clip hosted at a client-specific URI. Dialogflow uses this to construct mixed_audio. However, Dialogflow itself does not try to read or process the URI in any way. - "allowPlaybackInterruption": True or False, # 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. - "audioUri": "A String", # Required. URI of the audio clip. Dialogflow does not impose any validation on this value. It is specific to the client that reads it. - }, - "telephonyTransferCall": { # Represents the signal that telles the client to transfer the phone call connected to the agent to a third-party endpoint. # A signal that the client should transfer the phone call connected to this agent to a third-party endpoint. - "phoneNumber": "A String", # Transfer the call to a phone number in [E.164 format](https://en.wikipedia.org/wiki/E.164). + "tool": "A String", # Required. The tool associated with this call. Format: `projects//locations//agents//tools/`. + }, }, - "text": { # The text response message. # Returns a text response. - "allowPlaybackInterruption": True or False, # 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. - "text": [ # Required. A collection of text responses. - "A String", - ], + ], + "returnPartialResponses": True or False, # Whether Dialogflow should return currently queued fulfillment response messages in streaming APIs. If a webhook is specified, it happens before Dialogflow invokes webhook. Warning: 1) This flag only affects streaming API. Responses are still queued and returned once in non-streaming API. 2) The flag can be enabled in any fulfillment but only the first 3 partial responses will be returned. You may only want to apply it to fulfillments that have slow webhooks. + "setParameterActions": [ # Set parameter values before executing the webhook. + { # Setting a parameter value. + "parameter": "A String", # Display name of the parameter. + "value": "", # The new value of the parameter. A null value clears the parameter. }, - }, - ], - "returnPartialResponses": True or False, # Whether Dialogflow should return currently queued fulfillment response messages in streaming APIs. If a webhook is specified, it happens before Dialogflow invokes webhook. Warning: 1) This flag only affects streaming API. Responses are still queued and returned once in non-streaming API. 2) The flag can be enabled in any fulfillment but only the first 3 partial responses will be returned. You may only want to apply it to fulfillments that have slow webhooks. - "setParameterActions": [ # Set parameter values before executing the webhook. - { # Setting a parameter value. - "parameter": "A String", # Display name of the parameter. - "value": "", # The new value of the parameter. A null value clears the parameter. - }, - ], - "tag": "A String", # The value of this field will be populated in the WebhookRequest `fulfillmentInfo.tag` field by Dialogflow when the associated webhook is called. The tag is typically used by the webhook service to identify which fulfillment is being called, but it could be used for other purposes. This field is required if `webhook` is specified. - "webhook": "A String", # The webhook to call. Format: `projects//locations//agents//webhooks/`. - }, - "eventHandlers": [ # Handlers associated with the page to handle events such as webhook errors, no match or no input. - { # An event handler specifies an event that can be handled during a session. When the specified event happens, the following actions are taken in order: * If there is a `trigger_fulfillment` associated with the event, it will be called. * If there is a `target_page` associated with the event, the session will transition into the specified page. * If there is a `target_flow` associated with the event, the session will transition into the specified flow. - "event": "A String", # Required. The name of the event to handle. - "name": "A String", # Output only. The unique identifier of this event handler. - "targetFlow": "A String", # The target flow to transition to. Format: `projects//locations//agents//flows/`. - "targetPage": "A String", # The target page to transition to. Format: `projects//locations//agents//flows//pages/`. - "triggerFulfillment": { # A fulfillment can do one or more of the following actions at the same time: * Generate rich message responses. * Set parameter values. * Call the webhook. Fulfillments can be called at various stages in the Page or Form lifecycle. For example, when a DetectIntentRequest drives a session to enter a new page, the page's entry fulfillment can add a static response to the QueryResult in the returning DetectIntentResponse, call the webhook (for example, to load user data from a database), or both. # The fulfillment to call when the event occurs. Handling webhook errors with a fulfillment enabled with webhook could cause infinite loop. It is invalid to specify such fulfillment for a handler handling webhooks. - "advancedSettings": { # Hierarchical advanced settings for agent/flow/page/fulfillment/parameter. Settings exposed at lower level overrides the settings exposed at higher level. Overriding occurs at the sub-setting level. For example, the playback_interruption_settings at fulfillment level only overrides the playback_interruption_settings at the agent level, leaving other settings at the agent level unchanged. DTMF settings does not override each other. DTMF settings set at different levels define DTMF detections running in parallel. Hierarchy: Agent->Flow->Page->Fulfillment/Parameter. # Hierarchical advanced settings for this fulfillment. The settings exposed at the lower level overrides the settings exposed at the higher level. - "audioExportGcsDestination": { # Google Cloud Storage location for a Dialogflow operation that writes or exports objects (e.g. exported agent or transcripts) outside of Dialogflow. # If present, incoming audio is exported by Dialogflow to the configured Google Cloud Storage destination. Exposed at the following levels: - Agent level - Flow level - "uri": "A String", # Required. The Google Cloud Storage URI for the exported objects. A URI is of the form: `gs://bucket/object-name-or-prefix` Whether a full object name, or just a prefix, its usage depends on the Dialogflow operation. - }, - "dtmfSettings": { # Define behaviors for DTMF (dual tone multi frequency). # Settings for DTMF. Exposed at the following levels: - Agent level - Flow level - Page level - Parameter level. - "enabled": True or False, # If true, incoming audio is processed for DTMF (dual tone multi frequency) events. For example, if the caller presses a button on their telephone keypad and DTMF processing is enabled, Dialogflow will detect the event (e.g. a "3" was pressed) in the incoming audio and pass the event to the bot to drive business logic (e.g. when 3 is pressed, return the account balance). - "endpointingTimeoutDuration": "A String", # Endpoint timeout setting for matching dtmf input to regex. - "finishDigit": "A String", # The digit that terminates a DTMF digit sequence. - "interdigitTimeoutDuration": "A String", # Interdigit timeout setting for matching dtmf input to regex. - "maxDigits": 42, # Max length of DTMF digits. - }, - "loggingSettings": { # Define behaviors on logging. # Settings for logging. Settings for Dialogflow History, Contact Center messages, StackDriver logs, and speech logging. Exposed at the following levels: - Agent level. - "enableInteractionLogging": True or False, # If true, DF Interaction logging is currently enabled. - "enableStackdriverLogging": True or False, # If true, StackDriver logging is currently enabled. - }, - "speechSettings": { # Define behaviors of speech to text detection. # Settings for speech to text detection. Exposed at the following levels: - Agent level - Flow level - Page level - Parameter level - "endpointerSensitivity": 42, # Sensitivity of the speech model that detects the end of speech. Scale from 0 to 100. - "models": { # Mapping from language to Speech-to-Text model. The mapped Speech-to-Text model will be selected for requests from its corresponding language. For more information, see [Speech models](https://cloud.google.com/dialogflow/cx/docs/concept/speech-models). - "a_key": "A String", + ], + "tag": "A String", # The value of this field will be populated in the WebhookRequest `fulfillmentInfo.tag` field by Dialogflow when the associated webhook is called. The tag is typically used by the webhook service to identify which fulfillment is being called, but it could be used for other purposes. This field is required if `webhook` is specified. + "webhook": "A String", # The webhook to call. Format: `projects//locations//agents//webhooks/`. + }, + "eventHandlers": [ # Handlers associated with the page to handle events such as webhook errors, no match or no input. + { # An event handler specifies an event that can be handled during a session. When the specified event happens, the following actions are taken in order: * If there is a `trigger_fulfillment` associated with the event, it will be called. * If there is a `target_page` associated with the event, the session will transition into the specified page. * If there is a `target_flow` associated with the event, the session will transition into the specified flow. + "event": "A String", # Required. The name of the event to handle. + "name": "A String", # Output only. The unique identifier of this event handler. + "targetFlow": "A String", # The target flow to transition to. Format: `projects//locations//agents//flows/`. + "targetPage": "A String", # The target page to transition to. Format: `projects//locations//agents//flows//pages/`. + "triggerFulfillment": { # A fulfillment can do one or more of the following actions at the same time: * Generate rich message responses. * Set parameter values. * Call the webhook. Fulfillments can be called at various stages in the Page or Form lifecycle. For example, when a DetectIntentRequest drives a session to enter a new page, the page's entry fulfillment can add a static response to the QueryResult in the returning DetectIntentResponse, call the webhook (for example, to load user data from a database), or both. # The fulfillment to call when the event occurs. Handling webhook errors with a fulfillment enabled with webhook could cause infinite loop. It is invalid to specify such fulfillment for a handler handling webhooks. + "advancedSettings": { # Hierarchical advanced settings for agent/flow/page/fulfillment/parameter. Settings exposed at lower level overrides the settings exposed at higher level. Overriding occurs at the sub-setting level. For example, the playback_interruption_settings at fulfillment level only overrides the playback_interruption_settings at the agent level, leaving other settings at the agent level unchanged. DTMF settings does not override each other. DTMF settings set at different levels define DTMF detections running in parallel. Hierarchy: Agent->Flow->Page->Fulfillment/Parameter. # Hierarchical advanced settings for this fulfillment. The settings exposed at the lower level overrides the settings exposed at the higher level. + "audioExportGcsDestination": { # Google Cloud Storage location for a Dialogflow operation that writes or exports objects (e.g. exported agent or transcripts) outside of Dialogflow. # If present, incoming audio is exported by Dialogflow to the configured Google Cloud Storage destination. Exposed at the following levels: - Agent level - Flow level + "uri": "A String", # Required. The Google Cloud Storage URI for the exported objects. A URI is of the form: `gs://bucket/object-name-or-prefix` Whether a full object name, or just a prefix, its usage depends on the Dialogflow operation. + }, + "dtmfSettings": { # Define behaviors for DTMF (dual tone multi frequency). # Settings for DTMF. Exposed at the following levels: - Agent level - Flow level - Page level - Parameter level. + "enabled": True or False, # If true, incoming audio is processed for DTMF (dual tone multi frequency) events. For example, if the caller presses a button on their telephone keypad and DTMF processing is enabled, Dialogflow will detect the event (e.g. a "3" was pressed) in the incoming audio and pass the event to the bot to drive business logic (e.g. when 3 is pressed, return the account balance). + "endpointingTimeoutDuration": "A String", # Endpoint timeout setting for matching dtmf input to regex. + "finishDigit": "A String", # The digit that terminates a DTMF digit sequence. + "interdigitTimeoutDuration": "A String", # Interdigit timeout setting for matching dtmf input to regex. + "maxDigits": 42, # Max length of DTMF digits. + }, + "loggingSettings": { # Define behaviors on logging. # Settings for logging. Settings for Dialogflow History, Contact Center messages, StackDriver logs, and speech logging. Exposed at the following levels: - Agent level. + "enableInteractionLogging": True or False, # Enables DF Interaction logging. + "enableStackdriverLogging": True or False, # Enables StackDriver logging. + }, + "speechSettings": { # Define behaviors of speech to text detection. # Settings for speech to text detection. Exposed at the following levels: - Agent level - Flow level - Page level - Parameter level + "endpointerSensitivity": 42, # Sensitivity of the speech model that detects the end of speech. Scale from 0 to 100. + "models": { # Mapping from language to Speech-to-Text model. The mapped Speech-to-Text model will be selected for requests from its corresponding language. For more information, see [Speech models](https://cloud.google.com/dialogflow/cx/docs/concept/speech-models). + "a_key": "A String", + }, + "noSpeechTimeout": "A String", # Timeout before detecting no speech. + "useTimeoutBasedEndpointing": True or False, # Use timeout based endpointing, interpreting endpointer sensitivy as seconds of timeout value. }, - "noSpeechTimeout": "A String", # Timeout before detecting no speech. - "useTimeoutBasedEndpointing": True or False, # Use timeout based endpointing, interpreting endpointer sensitivy as seconds of timeout value. }, - }, - "conditionalCases": [ # Conditional cases for this fulfillment. - { # A list of cascading if-else conditions. Cases are mutually exclusive. The first one with a matching condition is selected, all the rest ignored. - "cases": [ # A list of cascading if-else conditions. - { # Each case has a Boolean condition. When it is evaluated to be True, the corresponding messages will be selected and evaluated recursively. - "caseContent": [ # A list of case content. - { # The list of messages or conditional cases to activate for this case. - "additionalCases": # Object with schema name: GoogleCloudDialogflowCxV3beta1FulfillmentConditionalCases # Additional cases to be evaluated. - "message": { # 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. # Returned message. - "channel": "A String", # The channel which the response is associated with. Clients can specify the channel via QueryParameters.channel, and only associated channel response will be returned. - "conversationSuccess": { # 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. # Indicates that the conversation succeeded. - "metadata": { # Custom metadata. Dialogflow doesn't impose any structure on this. - "a_key": "", # Properties of the object. + "conditionalCases": [ # Conditional cases for this fulfillment. + { # A list of cascading if-else conditions. Cases are mutually exclusive. The first one with a matching condition is selected, all the rest ignored. + "cases": [ # A list of cascading if-else conditions. + { # Each case has a Boolean condition. When it is evaluated to be True, the corresponding messages will be selected and evaluated recursively. + "caseContent": [ # A list of case content. + { # The list of messages or conditional cases to activate for this case. + "additionalCases": # Object with schema name: GoogleCloudDialogflowCxV3beta1FulfillmentConditionalCases # Additional cases to be evaluated. + "message": { # 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. # Returned message. + "channel": "A String", # The channel which the response is associated with. Clients can specify the channel via QueryParameters.channel, and only associated channel response will be returned. + "conversationSuccess": { # 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. # Indicates that the conversation succeeded. + "metadata": { # Custom metadata. Dialogflow doesn't impose any structure on this. + "a_key": "", # Properties of the object. + }, }, - }, - "endInteraction": { # 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. # Output only. A signal that indicates the interaction with the Dialogflow agent has ended. This message is generated by Dialogflow only when the conversation reaches `END_SESSION` page. It is not supposed to be defined by the user. It's guaranteed that there is at most one such message in each response. - }, - "knowledgeInfoCard": { # Represents info card response. If the response contains generative knowledge prediction, Dialogflow will return a payload with Infobot Messenger compatible info card. Otherwise, the info card response is skipped. # Represents info card for knowledge answers, to be better rendered in Dialogflow Messenger. - }, - "liveAgentHandoff": { # 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. # Hands off conversation to a human agent. - "metadata": { # Custom metadata for your handoff procedure. Dialogflow doesn't impose any structure on this. + "endInteraction": { # 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. # Output only. A signal that indicates the interaction with the Dialogflow agent has ended. This message is generated by Dialogflow only when the conversation reaches `END_SESSION` page. It is not supposed to be defined by the user. It's guaranteed that there is at most one such message in each response. + }, + "knowledgeInfoCard": { # Represents info card response. If the response contains generative knowledge prediction, Dialogflow will return a payload with Infobot Messenger compatible info card. Otherwise, the info card response is skipped. # Represents info card for knowledge answers, to be better rendered in Dialogflow Messenger. + }, + "liveAgentHandoff": { # 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. # Hands off conversation to a human agent. + "metadata": { # Custom metadata for your handoff procedure. Dialogflow doesn't impose any structure on this. + "a_key": "", # Properties of the object. + }, + }, + "mixedAudio": { # 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. # Output only. An audio response message composed of both the synthesized Dialogflow agent responses and responses defined via play_audio. This message is generated by Dialogflow only and not supposed to be defined by the user. + "segments": [ # Segments this audio response is composed of. + { # Represents one segment of audio. + "allowPlaybackInterruption": True or False, # 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. + "audio": "A String", # Raw audio synthesized from the Dialogflow agent's response using the output config specified in the request. + "uri": "A String", # Client-specific URI that points to an audio clip accessible to the client. Dialogflow does not impose any validation on it. + }, + ], + }, + "outputAudioText": { # A text or ssml response that is preferentially used for TTS output audio synthesis, as described in the comment on the ResponseMessage message. # A text or ssml response that is preferentially used for TTS output audio synthesis, as described in the comment on the ResponseMessage message. + "allowPlaybackInterruption": True or False, # 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. + "ssml": "A String", # The SSML text to be synthesized. For more information, see [SSML](/speech/text-to-speech/docs/ssml). + "text": "A String", # The raw text to be synthesized. + }, + "payload": { # Returns a response containing a custom, platform-specific payload. "a_key": "", # Properties of the object. }, - }, - "mixedAudio": { # 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. # Output only. An audio response message composed of both the synthesized Dialogflow agent responses and responses defined via play_audio. This message is generated by Dialogflow only and not supposed to be defined by the user. - "segments": [ # Segments this audio response is composed of. - { # Represents one segment of audio. - "allowPlaybackInterruption": True or False, # 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. - "audio": "A String", # Raw audio synthesized from the Dialogflow agent's response using the output config specified in the request. - "uri": "A String", # Client-specific URI that points to an audio clip accessible to the client. Dialogflow does not impose any validation on it. + "playAudio": { # Specifies an audio clip to be played by the client as part of the response. # Signal that the client should play an audio clip hosted at a client-specific URI. Dialogflow uses this to construct mixed_audio. However, Dialogflow itself does not try to read or process the URI in any way. + "allowPlaybackInterruption": True or False, # 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. + "audioUri": "A String", # Required. URI of the audio clip. Dialogflow does not impose any validation on this value. It is specific to the client that reads it. + }, + "telephonyTransferCall": { # Represents the signal that telles the client to transfer the phone call connected to the agent to a third-party endpoint. # A signal that the client should transfer the phone call connected to this agent to a third-party endpoint. + "phoneNumber": "A String", # Transfer the call to a phone number in [E.164 format](https://en.wikipedia.org/wiki/E.164). + }, + "text": { # The text response message. # Returns a text response. + "allowPlaybackInterruption": True or False, # 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. + "text": [ # Required. A collection of text responses. + "A String", + ], + }, + "toolCall": { # Represents a call of a specific tool's action with the specified inputs. # Returns the definition of a tool call that should be executed by the client. + "action": "A String", # Required. The name of the tool's action associated with this call. + "inputParameters": { # Optional. The action's input parameters. + "a_key": "", # Properties of the object. }, - ], - }, - "outputAudioText": { # A text or ssml response that is preferentially used for TTS output audio synthesis, as described in the comment on the ResponseMessage message. # A text or ssml response that is preferentially used for TTS output audio synthesis, as described in the comment on the ResponseMessage message. - "allowPlaybackInterruption": True or False, # 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. - "ssml": "A String", # The SSML text to be synthesized. For more information, see [SSML](/speech/text-to-speech/docs/ssml). - "text": "A String", # The raw text to be synthesized. - }, - "payload": { # Returns a response containing a custom, platform-specific payload. - "a_key": "", # Properties of the object. - }, - "playAudio": { # Specifies an audio clip to be played by the client as part of the response. # Signal that the client should play an audio clip hosted at a client-specific URI. Dialogflow uses this to construct mixed_audio. However, Dialogflow itself does not try to read or process the URI in any way. - "allowPlaybackInterruption": True or False, # 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. - "audioUri": "A String", # Required. URI of the audio clip. Dialogflow does not impose any validation on this value. It is specific to the client that reads it. - }, - "telephonyTransferCall": { # Represents the signal that telles the client to transfer the phone call connected to the agent to a third-party endpoint. # A signal that the client should transfer the phone call connected to this agent to a third-party endpoint. - "phoneNumber": "A String", # Transfer the call to a phone number in [E.164 format](https://en.wikipedia.org/wiki/E.164). - }, - "text": { # The text response message. # Returns a text response. - "allowPlaybackInterruption": True or False, # 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. - "text": [ # Required. A collection of text responses. - "A String", - ], + "tool": "A String", # Required. The tool associated with this call. Format: `projects//locations//agents//tools/`. + }, }, }, + ], + "condition": "A String", # The condition to activate and select this case. Empty means the condition is always true. The condition is evaluated against form parameters or session parameters. See the [conditions reference](https://cloud.google.com/dialogflow/cx/docs/reference/condition). + }, + ], + }, + ], + "enableGenerativeFallback": True or False, # If the flag is true, the agent will utilize LLM to generate a text response. If LLM generation fails, the defined responses in the fulfillment will be respected. This flag is only useful for fulfillments associated with no-match event handlers. + "messages": [ # The list of rich message responses to present to the user. + { # 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. + "channel": "A String", # The channel which the response is associated with. Clients can specify the channel via QueryParameters.channel, and only associated channel response will be returned. + "conversationSuccess": { # 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. # Indicates that the conversation succeeded. + "metadata": { # Custom metadata. Dialogflow doesn't impose any structure on this. + "a_key": "", # Properties of the object. + }, + }, + "endInteraction": { # 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. # Output only. A signal that indicates the interaction with the Dialogflow agent has ended. This message is generated by Dialogflow only when the conversation reaches `END_SESSION` page. It is not supposed to be defined by the user. It's guaranteed that there is at most one such message in each response. + }, + "knowledgeInfoCard": { # Represents info card response. If the response contains generative knowledge prediction, Dialogflow will return a payload with Infobot Messenger compatible info card. Otherwise, the info card response is skipped. # Represents info card for knowledge answers, to be better rendered in Dialogflow Messenger. + }, + "liveAgentHandoff": { # 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. # Hands off conversation to a human agent. + "metadata": { # Custom metadata for your handoff procedure. Dialogflow doesn't impose any structure on this. + "a_key": "", # Properties of the object. + }, + }, + "mixedAudio": { # 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. # Output only. An audio response message composed of both the synthesized Dialogflow agent responses and responses defined via play_audio. This message is generated by Dialogflow only and not supposed to be defined by the user. + "segments": [ # Segments this audio response is composed of. + { # Represents one segment of audio. + "allowPlaybackInterruption": True or False, # 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. + "audio": "A String", # Raw audio synthesized from the Dialogflow agent's response using the output config specified in the request. + "uri": "A String", # Client-specific URI that points to an audio clip accessible to the client. Dialogflow does not impose any validation on it. }, ], - "condition": "A String", # The condition to activate and select this case. Empty means the condition is always true. The condition is evaluated against form parameters or session parameters. See the [conditions reference](https://cloud.google.com/dialogflow/cx/docs/reference/condition). }, - ], - }, - ], - "enableGenerativeFallback": True or False, # If the flag is true, the agent will utilize LLM to generate a text response. If LLM generation fails, the defined responses in the fulfillment will be respected. This flag is only useful for fulfillments associated with no-match event handlers. - "messages": [ # The list of rich message responses to present to the user. - { # 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. - "channel": "A String", # The channel which the response is associated with. Clients can specify the channel via QueryParameters.channel, and only associated channel response will be returned. - "conversationSuccess": { # 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. # Indicates that the conversation succeeded. - "metadata": { # Custom metadata. Dialogflow doesn't impose any structure on this. - "a_key": "", # Properties of the object. + "outputAudioText": { # A text or ssml response that is preferentially used for TTS output audio synthesis, as described in the comment on the ResponseMessage message. # A text or ssml response that is preferentially used for TTS output audio synthesis, as described in the comment on the ResponseMessage message. + "allowPlaybackInterruption": True or False, # 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. + "ssml": "A String", # The SSML text to be synthesized. For more information, see [SSML](/speech/text-to-speech/docs/ssml). + "text": "A String", # The raw text to be synthesized. }, - }, - "endInteraction": { # 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. # Output only. A signal that indicates the interaction with the Dialogflow agent has ended. This message is generated by Dialogflow only when the conversation reaches `END_SESSION` page. It is not supposed to be defined by the user. It's guaranteed that there is at most one such message in each response. - }, - "knowledgeInfoCard": { # Represents info card response. If the response contains generative knowledge prediction, Dialogflow will return a payload with Infobot Messenger compatible info card. Otherwise, the info card response is skipped. # Represents info card for knowledge answers, to be better rendered in Dialogflow Messenger. - }, - "liveAgentHandoff": { # 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. # Hands off conversation to a human agent. - "metadata": { # Custom metadata for your handoff procedure. Dialogflow doesn't impose any structure on this. + "payload": { # Returns a response containing a custom, platform-specific payload. "a_key": "", # Properties of the object. }, - }, - "mixedAudio": { # 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. # Output only. An audio response message composed of both the synthesized Dialogflow agent responses and responses defined via play_audio. This message is generated by Dialogflow only and not supposed to be defined by the user. - "segments": [ # Segments this audio response is composed of. - { # Represents one segment of audio. - "allowPlaybackInterruption": True or False, # 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. - "audio": "A String", # Raw audio synthesized from the Dialogflow agent's response using the output config specified in the request. - "uri": "A String", # Client-specific URI that points to an audio clip accessible to the client. Dialogflow does not impose any validation on it. + "playAudio": { # Specifies an audio clip to be played by the client as part of the response. # Signal that the client should play an audio clip hosted at a client-specific URI. Dialogflow uses this to construct mixed_audio. However, Dialogflow itself does not try to read or process the URI in any way. + "allowPlaybackInterruption": True or False, # 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. + "audioUri": "A String", # Required. URI of the audio clip. Dialogflow does not impose any validation on this value. It is specific to the client that reads it. + }, + "telephonyTransferCall": { # Represents the signal that telles the client to transfer the phone call connected to the agent to a third-party endpoint. # A signal that the client should transfer the phone call connected to this agent to a third-party endpoint. + "phoneNumber": "A String", # Transfer the call to a phone number in [E.164 format](https://en.wikipedia.org/wiki/E.164). + }, + "text": { # The text response message. # Returns a text response. + "allowPlaybackInterruption": True or False, # 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. + "text": [ # Required. A collection of text responses. + "A String", + ], + }, + "toolCall": { # Represents a call of a specific tool's action with the specified inputs. # Returns the definition of a tool call that should be executed by the client. + "action": "A String", # Required. The name of the tool's action associated with this call. + "inputParameters": { # Optional. The action's input parameters. + "a_key": "", # Properties of the object. }, - ], - }, - "outputAudioText": { # A text or ssml response that is preferentially used for TTS output audio synthesis, as described in the comment on the ResponseMessage message. # A text or ssml response that is preferentially used for TTS output audio synthesis, as described in the comment on the ResponseMessage message. - "allowPlaybackInterruption": True or False, # 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. - "ssml": "A String", # The SSML text to be synthesized. For more information, see [SSML](/speech/text-to-speech/docs/ssml). - "text": "A String", # The raw text to be synthesized. + "tool": "A String", # Required. The tool associated with this call. Format: `projects//locations//agents//tools/`. + }, }, - "payload": { # Returns a response containing a custom, platform-specific payload. - "a_key": "", # Properties of the object. + ], + "returnPartialResponses": True or False, # Whether Dialogflow should return currently queued fulfillment response messages in streaming APIs. If a webhook is specified, it happens before Dialogflow invokes webhook. Warning: 1) This flag only affects streaming API. Responses are still queued and returned once in non-streaming API. 2) The flag can be enabled in any fulfillment but only the first 3 partial responses will be returned. You may only want to apply it to fulfillments that have slow webhooks. + "setParameterActions": [ # Set parameter values before executing the webhook. + { # Setting a parameter value. + "parameter": "A String", # Display name of the parameter. + "value": "", # The new value of the parameter. A null value clears the parameter. }, - "playAudio": { # Specifies an audio clip to be played by the client as part of the response. # Signal that the client should play an audio clip hosted at a client-specific URI. Dialogflow uses this to construct mixed_audio. However, Dialogflow itself does not try to read or process the URI in any way. - "allowPlaybackInterruption": True or False, # 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. - "audioUri": "A String", # Required. URI of the audio clip. Dialogflow does not impose any validation on this value. It is specific to the client that reads it. + ], + "tag": "A String", # The value of this field will be populated in the WebhookRequest `fulfillmentInfo.tag` field by Dialogflow when the associated webhook is called. The tag is typically used by the webhook service to identify which fulfillment is being called, but it could be used for other purposes. This field is required if `webhook` is specified. + "webhook": "A String", # The webhook to call. Format: `projects//locations//agents//webhooks/`. + }, + }, + ], + "form": { # A form is a data model that groups related parameters that can be collected from the user. The process in which the agent prompts the user and collects parameter values from the user is called form filling. A form can be added to a page. When form filling is done, the filled parameters will be written to the session. # The form associated with the page, used for collecting parameters relevant to the page. + "parameters": [ # Parameters to collect from the user. + { # Represents a form parameter. + "advancedSettings": { # Hierarchical advanced settings for agent/flow/page/fulfillment/parameter. Settings exposed at lower level overrides the settings exposed at higher level. Overriding occurs at the sub-setting level. For example, the playback_interruption_settings at fulfillment level only overrides the playback_interruption_settings at the agent level, leaving other settings at the agent level unchanged. DTMF settings does not override each other. DTMF settings set at different levels define DTMF detections running in parallel. Hierarchy: Agent->Flow->Page->Fulfillment/Parameter. # Hierarchical advanced settings for this parameter. The settings exposed at the lower level overrides the settings exposed at the higher level. + "audioExportGcsDestination": { # Google Cloud Storage location for a Dialogflow operation that writes or exports objects (e.g. exported agent or transcripts) outside of Dialogflow. # If present, incoming audio is exported by Dialogflow to the configured Google Cloud Storage destination. Exposed at the following levels: - Agent level - Flow level + "uri": "A String", # Required. The Google Cloud Storage URI for the exported objects. A URI is of the form: `gs://bucket/object-name-or-prefix` Whether a full object name, or just a prefix, its usage depends on the Dialogflow operation. }, - "telephonyTransferCall": { # Represents the signal that telles the client to transfer the phone call connected to the agent to a third-party endpoint. # A signal that the client should transfer the phone call connected to this agent to a third-party endpoint. - "phoneNumber": "A String", # Transfer the call to a phone number in [E.164 format](https://en.wikipedia.org/wiki/E.164). + "dtmfSettings": { # Define behaviors for DTMF (dual tone multi frequency). # Settings for DTMF. Exposed at the following levels: - Agent level - Flow level - Page level - Parameter level. + "enabled": True or False, # If true, incoming audio is processed for DTMF (dual tone multi frequency) events. For example, if the caller presses a button on their telephone keypad and DTMF processing is enabled, Dialogflow will detect the event (e.g. a "3" was pressed) in the incoming audio and pass the event to the bot to drive business logic (e.g. when 3 is pressed, return the account balance). + "endpointingTimeoutDuration": "A String", # Endpoint timeout setting for matching dtmf input to regex. + "finishDigit": "A String", # The digit that terminates a DTMF digit sequence. + "interdigitTimeoutDuration": "A String", # Interdigit timeout setting for matching dtmf input to regex. + "maxDigits": 42, # Max length of DTMF digits. }, - "text": { # The text response message. # Returns a text response. - "allowPlaybackInterruption": True or False, # 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. - "text": [ # Required. A collection of text responses. - "A String", - ], + "loggingSettings": { # Define behaviors on logging. # Settings for logging. Settings for Dialogflow History, Contact Center messages, StackDriver logs, and speech logging. Exposed at the following levels: - Agent level. + "enableInteractionLogging": True or False, # Enables DF Interaction logging. + "enableStackdriverLogging": True or False, # Enables StackDriver logging. }, - }, - ], - "returnPartialResponses": True or False, # Whether Dialogflow should return currently queued fulfillment response messages in streaming APIs. If a webhook is specified, it happens before Dialogflow invokes webhook. Warning: 1) This flag only affects streaming API. Responses are still queued and returned once in non-streaming API. 2) The flag can be enabled in any fulfillment but only the first 3 partial responses will be returned. You may only want to apply it to fulfillments that have slow webhooks. - "setParameterActions": [ # Set parameter values before executing the webhook. - { # Setting a parameter value. - "parameter": "A String", # Display name of the parameter. - "value": "", # The new value of the parameter. A null value clears the parameter. - }, - ], - "tag": "A String", # The value of this field will be populated in the WebhookRequest `fulfillmentInfo.tag` field by Dialogflow when the associated webhook is called. The tag is typically used by the webhook service to identify which fulfillment is being called, but it could be used for other purposes. This field is required if `webhook` is specified. - "webhook": "A String", # The webhook to call. Format: `projects//locations//agents//webhooks/`. - }, - }, - ], - "form": { # A form is a data model that groups related parameters that can be collected from the user. The process in which the agent prompts the user and collects parameter values from the user is called form filling. A form can be added to a page. When form filling is done, the filled parameters will be written to the session. # The form associated with the page, used for collecting parameters relevant to the page. - "parameters": [ # Parameters to collect from the user. - { # Represents a form parameter. - "advancedSettings": { # Hierarchical advanced settings for agent/flow/page/fulfillment/parameter. Settings exposed at lower level overrides the settings exposed at higher level. Overriding occurs at the sub-setting level. For example, the playback_interruption_settings at fulfillment level only overrides the playback_interruption_settings at the agent level, leaving other settings at the agent level unchanged. DTMF settings does not override each other. DTMF settings set at different levels define DTMF detections running in parallel. Hierarchy: Agent->Flow->Page->Fulfillment/Parameter. # Hierarchical advanced settings for this parameter. The settings exposed at the lower level overrides the settings exposed at the higher level. - "audioExportGcsDestination": { # Google Cloud Storage location for a Dialogflow operation that writes or exports objects (e.g. exported agent or transcripts) outside of Dialogflow. # If present, incoming audio is exported by Dialogflow to the configured Google Cloud Storage destination. Exposed at the following levels: - Agent level - Flow level - "uri": "A String", # Required. The Google Cloud Storage URI for the exported objects. A URI is of the form: `gs://bucket/object-name-or-prefix` Whether a full object name, or just a prefix, its usage depends on the Dialogflow operation. - }, - "dtmfSettings": { # Define behaviors for DTMF (dual tone multi frequency). # Settings for DTMF. Exposed at the following levels: - Agent level - Flow level - Page level - Parameter level. - "enabled": True or False, # If true, incoming audio is processed for DTMF (dual tone multi frequency) events. For example, if the caller presses a button on their telephone keypad and DTMF processing is enabled, Dialogflow will detect the event (e.g. a "3" was pressed) in the incoming audio and pass the event to the bot to drive business logic (e.g. when 3 is pressed, return the account balance). - "endpointingTimeoutDuration": "A String", # Endpoint timeout setting for matching dtmf input to regex. - "finishDigit": "A String", # The digit that terminates a DTMF digit sequence. - "interdigitTimeoutDuration": "A String", # Interdigit timeout setting for matching dtmf input to regex. - "maxDigits": 42, # Max length of DTMF digits. - }, - "loggingSettings": { # Define behaviors on logging. # Settings for logging. Settings for Dialogflow History, Contact Center messages, StackDriver logs, and speech logging. Exposed at the following levels: - Agent level. - "enableInteractionLogging": True or False, # If true, DF Interaction logging is currently enabled. - "enableStackdriverLogging": True or False, # If true, StackDriver logging is currently enabled. - }, - "speechSettings": { # Define behaviors of speech to text detection. # Settings for speech to text detection. Exposed at the following levels: - Agent level - Flow level - Page level - Parameter level - "endpointerSensitivity": 42, # Sensitivity of the speech model that detects the end of speech. Scale from 0 to 100. - "models": { # Mapping from language to Speech-to-Text model. The mapped Speech-to-Text model will be selected for requests from its corresponding language. For more information, see [Speech models](https://cloud.google.com/dialogflow/cx/docs/concept/speech-models). - "a_key": "A String", + "speechSettings": { # Define behaviors of speech to text detection. # Settings for speech to text detection. Exposed at the following levels: - Agent level - Flow level - Page level - Parameter level + "endpointerSensitivity": 42, # Sensitivity of the speech model that detects the end of speech. Scale from 0 to 100. + "models": { # Mapping from language to Speech-to-Text model. The mapped Speech-to-Text model will be selected for requests from its corresponding language. For more information, see [Speech models](https://cloud.google.com/dialogflow/cx/docs/concept/speech-models). + "a_key": "A String", + }, + "noSpeechTimeout": "A String", # Timeout before detecting no speech. + "useTimeoutBasedEndpointing": True or False, # Use timeout based endpointing, interpreting endpointer sensitivy as seconds of timeout value. }, - "noSpeechTimeout": "A String", # Timeout before detecting no speech. - "useTimeoutBasedEndpointing": True or False, # Use timeout based endpointing, interpreting endpointer sensitivy as seconds of timeout value. }, - }, - "defaultValue": "", # The default value of an optional parameter. If the parameter is required, the default value will be ignored. - "displayName": "A String", # Required. The human-readable name of the parameter, unique within the form. - "entityType": "A String", # Required. The entity type of the parameter. Format: `projects/-/locations/-/agents/-/entityTypes/` for system entity types (for example, `projects/-/locations/-/agents/-/entityTypes/sys.date`), or `projects//locations//agents//entityTypes/` for developer entity types. - "fillBehavior": { # Configuration for how the filling of a parameter should be handled. # Required. Defines fill behavior for the parameter. - "initialPromptFulfillment": { # A fulfillment can do one or more of the following actions at the same time: * Generate rich message responses. * Set parameter values. * Call the webhook. Fulfillments can be called at various stages in the Page or Form lifecycle. For example, when a DetectIntentRequest drives a session to enter a new page, the page's entry fulfillment can add a static response to the QueryResult in the returning DetectIntentResponse, call the webhook (for example, to load user data from a database), or both. # Required. The fulfillment to provide the initial prompt that the agent can present to the user in order to fill the parameter. - "advancedSettings": { # Hierarchical advanced settings for agent/flow/page/fulfillment/parameter. Settings exposed at lower level overrides the settings exposed at higher level. Overriding occurs at the sub-setting level. For example, the playback_interruption_settings at fulfillment level only overrides the playback_interruption_settings at the agent level, leaving other settings at the agent level unchanged. DTMF settings does not override each other. DTMF settings set at different levels define DTMF detections running in parallel. Hierarchy: Agent->Flow->Page->Fulfillment/Parameter. # Hierarchical advanced settings for this fulfillment. The settings exposed at the lower level overrides the settings exposed at the higher level. - "audioExportGcsDestination": { # Google Cloud Storage location for a Dialogflow operation that writes or exports objects (e.g. exported agent or transcripts) outside of Dialogflow. # If present, incoming audio is exported by Dialogflow to the configured Google Cloud Storage destination. Exposed at the following levels: - Agent level - Flow level - "uri": "A String", # Required. The Google Cloud Storage URI for the exported objects. A URI is of the form: `gs://bucket/object-name-or-prefix` Whether a full object name, or just a prefix, its usage depends on the Dialogflow operation. - }, - "dtmfSettings": { # Define behaviors for DTMF (dual tone multi frequency). # Settings for DTMF. Exposed at the following levels: - Agent level - Flow level - Page level - Parameter level. - "enabled": True or False, # If true, incoming audio is processed for DTMF (dual tone multi frequency) events. For example, if the caller presses a button on their telephone keypad and DTMF processing is enabled, Dialogflow will detect the event (e.g. a "3" was pressed) in the incoming audio and pass the event to the bot to drive business logic (e.g. when 3 is pressed, return the account balance). - "endpointingTimeoutDuration": "A String", # Endpoint timeout setting for matching dtmf input to regex. - "finishDigit": "A String", # The digit that terminates a DTMF digit sequence. - "interdigitTimeoutDuration": "A String", # Interdigit timeout setting for matching dtmf input to regex. - "maxDigits": 42, # Max length of DTMF digits. - }, - "loggingSettings": { # Define behaviors on logging. # Settings for logging. Settings for Dialogflow History, Contact Center messages, StackDriver logs, and speech logging. Exposed at the following levels: - Agent level. - "enableInteractionLogging": True or False, # If true, DF Interaction logging is currently enabled. - "enableStackdriverLogging": True or False, # If true, StackDriver logging is currently enabled. - }, - "speechSettings": { # Define behaviors of speech to text detection. # Settings for speech to text detection. Exposed at the following levels: - Agent level - Flow level - Page level - Parameter level - "endpointerSensitivity": 42, # Sensitivity of the speech model that detects the end of speech. Scale from 0 to 100. - "models": { # Mapping from language to Speech-to-Text model. The mapped Speech-to-Text model will be selected for requests from its corresponding language. For more information, see [Speech models](https://cloud.google.com/dialogflow/cx/docs/concept/speech-models). - "a_key": "A String", + "defaultValue": "", # The default value of an optional parameter. If the parameter is required, the default value will be ignored. + "displayName": "A String", # Required. The human-readable name of the parameter, unique within the form. + "entityType": "A String", # Required. The entity type of the parameter. Format: `projects/-/locations/-/agents/-/entityTypes/` for system entity types (for example, `projects/-/locations/-/agents/-/entityTypes/sys.date`), or `projects//locations//agents//entityTypes/` for developer entity types. + "fillBehavior": { # Configuration for how the filling of a parameter should be handled. # Required. Defines fill behavior for the parameter. + "initialPromptFulfillment": { # A fulfillment can do one or more of the following actions at the same time: * Generate rich message responses. * Set parameter values. * Call the webhook. Fulfillments can be called at various stages in the Page or Form lifecycle. For example, when a DetectIntentRequest drives a session to enter a new page, the page's entry fulfillment can add a static response to the QueryResult in the returning DetectIntentResponse, call the webhook (for example, to load user data from a database), or both. # Required. The fulfillment to provide the initial prompt that the agent can present to the user in order to fill the parameter. + "advancedSettings": { # Hierarchical advanced settings for agent/flow/page/fulfillment/parameter. Settings exposed at lower level overrides the settings exposed at higher level. Overriding occurs at the sub-setting level. For example, the playback_interruption_settings at fulfillment level only overrides the playback_interruption_settings at the agent level, leaving other settings at the agent level unchanged. DTMF settings does not override each other. DTMF settings set at different levels define DTMF detections running in parallel. Hierarchy: Agent->Flow->Page->Fulfillment/Parameter. # Hierarchical advanced settings for this fulfillment. The settings exposed at the lower level overrides the settings exposed at the higher level. + "audioExportGcsDestination": { # Google Cloud Storage location for a Dialogflow operation that writes or exports objects (e.g. exported agent or transcripts) outside of Dialogflow. # If present, incoming audio is exported by Dialogflow to the configured Google Cloud Storage destination. Exposed at the following levels: - Agent level - Flow level + "uri": "A String", # Required. The Google Cloud Storage URI for the exported objects. A URI is of the form: `gs://bucket/object-name-or-prefix` Whether a full object name, or just a prefix, its usage depends on the Dialogflow operation. + }, + "dtmfSettings": { # Define behaviors for DTMF (dual tone multi frequency). # Settings for DTMF. Exposed at the following levels: - Agent level - Flow level - Page level - Parameter level. + "enabled": True or False, # If true, incoming audio is processed for DTMF (dual tone multi frequency) events. For example, if the caller presses a button on their telephone keypad and DTMF processing is enabled, Dialogflow will detect the event (e.g. a "3" was pressed) in the incoming audio and pass the event to the bot to drive business logic (e.g. when 3 is pressed, return the account balance). + "endpointingTimeoutDuration": "A String", # Endpoint timeout setting for matching dtmf input to regex. + "finishDigit": "A String", # The digit that terminates a DTMF digit sequence. + "interdigitTimeoutDuration": "A String", # Interdigit timeout setting for matching dtmf input to regex. + "maxDigits": 42, # Max length of DTMF digits. + }, + "loggingSettings": { # Define behaviors on logging. # Settings for logging. Settings for Dialogflow History, Contact Center messages, StackDriver logs, and speech logging. Exposed at the following levels: - Agent level. + "enableInteractionLogging": True or False, # Enables DF Interaction logging. + "enableStackdriverLogging": True or False, # Enables StackDriver logging. + }, + "speechSettings": { # Define behaviors of speech to text detection. # Settings for speech to text detection. Exposed at the following levels: - Agent level - Flow level - Page level - Parameter level + "endpointerSensitivity": 42, # Sensitivity of the speech model that detects the end of speech. Scale from 0 to 100. + "models": { # Mapping from language to Speech-to-Text model. The mapped Speech-to-Text model will be selected for requests from its corresponding language. For more information, see [Speech models](https://cloud.google.com/dialogflow/cx/docs/concept/speech-models). + "a_key": "A String", + }, + "noSpeechTimeout": "A String", # Timeout before detecting no speech. + "useTimeoutBasedEndpointing": True or False, # Use timeout based endpointing, interpreting endpointer sensitivy as seconds of timeout value. }, - "noSpeechTimeout": "A String", # Timeout before detecting no speech. - "useTimeoutBasedEndpointing": True or False, # Use timeout based endpointing, interpreting endpointer sensitivy as seconds of timeout value. }, - }, - "conditionalCases": [ # Conditional cases for this fulfillment. - { # A list of cascading if-else conditions. Cases are mutually exclusive. The first one with a matching condition is selected, all the rest ignored. - "cases": [ # A list of cascading if-else conditions. - { # Each case has a Boolean condition. When it is evaluated to be True, the corresponding messages will be selected and evaluated recursively. - "caseContent": [ # A list of case content. - { # The list of messages or conditional cases to activate for this case. - "additionalCases": # Object with schema name: GoogleCloudDialogflowCxV3beta1FulfillmentConditionalCases # Additional cases to be evaluated. - "message": { # 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. # Returned message. - "channel": "A String", # The channel which the response is associated with. Clients can specify the channel via QueryParameters.channel, and only associated channel response will be returned. - "conversationSuccess": { # 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. # Indicates that the conversation succeeded. - "metadata": { # Custom metadata. Dialogflow doesn't impose any structure on this. - "a_key": "", # Properties of the object. + "conditionalCases": [ # Conditional cases for this fulfillment. + { # A list of cascading if-else conditions. Cases are mutually exclusive. The first one with a matching condition is selected, all the rest ignored. + "cases": [ # A list of cascading if-else conditions. + { # Each case has a Boolean condition. When it is evaluated to be True, the corresponding messages will be selected and evaluated recursively. + "caseContent": [ # A list of case content. + { # The list of messages or conditional cases to activate for this case. + "additionalCases": # Object with schema name: GoogleCloudDialogflowCxV3beta1FulfillmentConditionalCases # Additional cases to be evaluated. + "message": { # 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. # Returned message. + "channel": "A String", # The channel which the response is associated with. Clients can specify the channel via QueryParameters.channel, and only associated channel response will be returned. + "conversationSuccess": { # 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. # Indicates that the conversation succeeded. + "metadata": { # Custom metadata. Dialogflow doesn't impose any structure on this. + "a_key": "", # Properties of the object. + }, }, - }, - "endInteraction": { # 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. # Output only. A signal that indicates the interaction with the Dialogflow agent has ended. This message is generated by Dialogflow only when the conversation reaches `END_SESSION` page. It is not supposed to be defined by the user. It's guaranteed that there is at most one such message in each response. - }, - "knowledgeInfoCard": { # Represents info card response. If the response contains generative knowledge prediction, Dialogflow will return a payload with Infobot Messenger compatible info card. Otherwise, the info card response is skipped. # Represents info card for knowledge answers, to be better rendered in Dialogflow Messenger. - }, - "liveAgentHandoff": { # 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. # Hands off conversation to a human agent. - "metadata": { # Custom metadata for your handoff procedure. Dialogflow doesn't impose any structure on this. + "endInteraction": { # 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. # Output only. A signal that indicates the interaction with the Dialogflow agent has ended. This message is generated by Dialogflow only when the conversation reaches `END_SESSION` page. It is not supposed to be defined by the user. It's guaranteed that there is at most one such message in each response. + }, + "knowledgeInfoCard": { # Represents info card response. If the response contains generative knowledge prediction, Dialogflow will return a payload with Infobot Messenger compatible info card. Otherwise, the info card response is skipped. # Represents info card for knowledge answers, to be better rendered in Dialogflow Messenger. + }, + "liveAgentHandoff": { # 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. # Hands off conversation to a human agent. + "metadata": { # Custom metadata for your handoff procedure. Dialogflow doesn't impose any structure on this. + "a_key": "", # Properties of the object. + }, + }, + "mixedAudio": { # 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. # Output only. An audio response message composed of both the synthesized Dialogflow agent responses and responses defined via play_audio. This message is generated by Dialogflow only and not supposed to be defined by the user. + "segments": [ # Segments this audio response is composed of. + { # Represents one segment of audio. + "allowPlaybackInterruption": True or False, # 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. + "audio": "A String", # Raw audio synthesized from the Dialogflow agent's response using the output config specified in the request. + "uri": "A String", # Client-specific URI that points to an audio clip accessible to the client. Dialogflow does not impose any validation on it. + }, + ], + }, + "outputAudioText": { # A text or ssml response that is preferentially used for TTS output audio synthesis, as described in the comment on the ResponseMessage message. # A text or ssml response that is preferentially used for TTS output audio synthesis, as described in the comment on the ResponseMessage message. + "allowPlaybackInterruption": True or False, # 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. + "ssml": "A String", # The SSML text to be synthesized. For more information, see [SSML](/speech/text-to-speech/docs/ssml). + "text": "A String", # The raw text to be synthesized. + }, + "payload": { # Returns a response containing a custom, platform-specific payload. "a_key": "", # Properties of the object. }, - }, - "mixedAudio": { # 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. # Output only. An audio response message composed of both the synthesized Dialogflow agent responses and responses defined via play_audio. This message is generated by Dialogflow only and not supposed to be defined by the user. - "segments": [ # Segments this audio response is composed of. - { # Represents one segment of audio. - "allowPlaybackInterruption": True or False, # 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. - "audio": "A String", # Raw audio synthesized from the Dialogflow agent's response using the output config specified in the request. - "uri": "A String", # Client-specific URI that points to an audio clip accessible to the client. Dialogflow does not impose any validation on it. + "playAudio": { # Specifies an audio clip to be played by the client as part of the response. # Signal that the client should play an audio clip hosted at a client-specific URI. Dialogflow uses this to construct mixed_audio. However, Dialogflow itself does not try to read or process the URI in any way. + "allowPlaybackInterruption": True or False, # 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. + "audioUri": "A String", # Required. URI of the audio clip. Dialogflow does not impose any validation on this value. It is specific to the client that reads it. + }, + "telephonyTransferCall": { # Represents the signal that telles the client to transfer the phone call connected to the agent to a third-party endpoint. # A signal that the client should transfer the phone call connected to this agent to a third-party endpoint. + "phoneNumber": "A String", # Transfer the call to a phone number in [E.164 format](https://en.wikipedia.org/wiki/E.164). + }, + "text": { # The text response message. # Returns a text response. + "allowPlaybackInterruption": True or False, # 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. + "text": [ # Required. A collection of text responses. + "A String", + ], + }, + "toolCall": { # Represents a call of a specific tool's action with the specified inputs. # Returns the definition of a tool call that should be executed by the client. + "action": "A String", # Required. The name of the tool's action associated with this call. + "inputParameters": { # Optional. The action's input parameters. + "a_key": "", # Properties of the object. }, - ], - }, - "outputAudioText": { # A text or ssml response that is preferentially used for TTS output audio synthesis, as described in the comment on the ResponseMessage message. # A text or ssml response that is preferentially used for TTS output audio synthesis, as described in the comment on the ResponseMessage message. - "allowPlaybackInterruption": True or False, # 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. - "ssml": "A String", # The SSML text to be synthesized. For more information, see [SSML](/speech/text-to-speech/docs/ssml). - "text": "A String", # The raw text to be synthesized. - }, - "payload": { # Returns a response containing a custom, platform-specific payload. - "a_key": "", # Properties of the object. - }, - "playAudio": { # Specifies an audio clip to be played by the client as part of the response. # Signal that the client should play an audio clip hosted at a client-specific URI. Dialogflow uses this to construct mixed_audio. However, Dialogflow itself does not try to read or process the URI in any way. - "allowPlaybackInterruption": True or False, # 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. - "audioUri": "A String", # Required. URI of the audio clip. Dialogflow does not impose any validation on this value. It is specific to the client that reads it. - }, - "telephonyTransferCall": { # Represents the signal that telles the client to transfer the phone call connected to the agent to a third-party endpoint. # A signal that the client should transfer the phone call connected to this agent to a third-party endpoint. - "phoneNumber": "A String", # Transfer the call to a phone number in [E.164 format](https://en.wikipedia.org/wiki/E.164). - }, - "text": { # The text response message. # Returns a text response. - "allowPlaybackInterruption": True or False, # 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. - "text": [ # Required. A collection of text responses. - "A String", - ], + "tool": "A String", # Required. The tool associated with this call. Format: `projects//locations//agents//tools/`. + }, }, }, - }, - ], - "condition": "A String", # The condition to activate and select this case. Empty means the condition is always true. The condition is evaluated against form parameters or session parameters. See the [conditions reference](https://cloud.google.com/dialogflow/cx/docs/reference/condition). - }, - ], - }, - ], - "enableGenerativeFallback": True or False, # If the flag is true, the agent will utilize LLM to generate a text response. If LLM generation fails, the defined responses in the fulfillment will be respected. This flag is only useful for fulfillments associated with no-match event handlers. - "messages": [ # The list of rich message responses to present to the user. - { # 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. - "channel": "A String", # The channel which the response is associated with. Clients can specify the channel via QueryParameters.channel, and only associated channel response will be returned. - "conversationSuccess": { # 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. # Indicates that the conversation succeeded. - "metadata": { # Custom metadata. Dialogflow doesn't impose any structure on this. - "a_key": "", # Properties of the object. - }, - }, - "endInteraction": { # 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. # Output only. A signal that indicates the interaction with the Dialogflow agent has ended. This message is generated by Dialogflow only when the conversation reaches `END_SESSION` page. It is not supposed to be defined by the user. It's guaranteed that there is at most one such message in each response. - }, - "knowledgeInfoCard": { # Represents info card response. If the response contains generative knowledge prediction, Dialogflow will return a payload with Infobot Messenger compatible info card. Otherwise, the info card response is skipped. # Represents info card for knowledge answers, to be better rendered in Dialogflow Messenger. - }, - "liveAgentHandoff": { # 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. # Hands off conversation to a human agent. - "metadata": { # Custom metadata for your handoff procedure. Dialogflow doesn't impose any structure on this. - "a_key": "", # Properties of the object. - }, - }, - "mixedAudio": { # 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. # Output only. An audio response message composed of both the synthesized Dialogflow agent responses and responses defined via play_audio. This message is generated by Dialogflow only and not supposed to be defined by the user. - "segments": [ # Segments this audio response is composed of. - { # Represents one segment of audio. - "allowPlaybackInterruption": True or False, # 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. - "audio": "A String", # Raw audio synthesized from the Dialogflow agent's response using the output config specified in the request. - "uri": "A String", # Client-specific URI that points to an audio clip accessible to the client. Dialogflow does not impose any validation on it. + ], + "condition": "A String", # The condition to activate and select this case. Empty means the condition is always true. The condition is evaluated against form parameters or session parameters. See the [conditions reference](https://cloud.google.com/dialogflow/cx/docs/reference/condition). }, ], }, - "outputAudioText": { # A text or ssml response that is preferentially used for TTS output audio synthesis, as described in the comment on the ResponseMessage message. # A text or ssml response that is preferentially used for TTS output audio synthesis, as described in the comment on the ResponseMessage message. - "allowPlaybackInterruption": True or False, # 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. - "ssml": "A String", # The SSML text to be synthesized. For more information, see [SSML](/speech/text-to-speech/docs/ssml). - "text": "A String", # The raw text to be synthesized. - }, - "payload": { # Returns a response containing a custom, platform-specific payload. - "a_key": "", # Properties of the object. - }, - "playAudio": { # Specifies an audio clip to be played by the client as part of the response. # Signal that the client should play an audio clip hosted at a client-specific URI. Dialogflow uses this to construct mixed_audio. However, Dialogflow itself does not try to read or process the URI in any way. - "allowPlaybackInterruption": True or False, # 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. - "audioUri": "A String", # Required. URI of the audio clip. Dialogflow does not impose any validation on this value. It is specific to the client that reads it. - }, - "telephonyTransferCall": { # Represents the signal that telles the client to transfer the phone call connected to the agent to a third-party endpoint. # A signal that the client should transfer the phone call connected to this agent to a third-party endpoint. - "phoneNumber": "A String", # Transfer the call to a phone number in [E.164 format](https://en.wikipedia.org/wiki/E.164). - }, - "text": { # The text response message. # Returns a text response. - "allowPlaybackInterruption": True or False, # 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. - "text": [ # Required. A collection of text responses. - "A String", - ], - }, - }, - ], - "returnPartialResponses": True or False, # Whether Dialogflow should return currently queued fulfillment response messages in streaming APIs. If a webhook is specified, it happens before Dialogflow invokes webhook. Warning: 1) This flag only affects streaming API. Responses are still queued and returned once in non-streaming API. 2) The flag can be enabled in any fulfillment but only the first 3 partial responses will be returned. You may only want to apply it to fulfillments that have slow webhooks. - "setParameterActions": [ # Set parameter values before executing the webhook. - { # Setting a parameter value. - "parameter": "A String", # Display name of the parameter. - "value": "", # The new value of the parameter. A null value clears the parameter. - }, - ], - "tag": "A String", # The value of this field will be populated in the WebhookRequest `fulfillmentInfo.tag` field by Dialogflow when the associated webhook is called. The tag is typically used by the webhook service to identify which fulfillment is being called, but it could be used for other purposes. This field is required if `webhook` is specified. - "webhook": "A String", # The webhook to call. Format: `projects//locations//agents//webhooks/`. - }, - "repromptEventHandlers": [ # The handlers for parameter-level events, used to provide reprompt for the parameter or transition to a different page/flow. The supported events are: * `sys.no-match-`, where N can be from 1 to 6 * `sys.no-match-default` * `sys.no-input-`, where N can be from 1 to 6 * `sys.no-input-default` * `sys.invalid-parameter` `initial_prompt_fulfillment` provides the first prompt for the parameter. If the user's response does not fill the parameter, a no-match/no-input event will be triggered, and the fulfillment associated with the `sys.no-match-1`/`sys.no-input-1` handler (if defined) will be called to provide a prompt. The `sys.no-match-2`/`sys.no-input-2` handler (if defined) will respond to the next no-match/no-input event, and so on. A `sys.no-match-default` or `sys.no-input-default` handler will be used to handle all following no-match/no-input events after all numbered no-match/no-input handlers for the parameter are consumed. A `sys.invalid-parameter` handler can be defined to handle the case where the parameter values have been `invalidated` by webhook. For example, if the user's response fill the parameter, however the parameter was invalidated by webhook, the fulfillment associated with the `sys.invalid-parameter` handler (if defined) will be called to provide a prompt. If the event handler for the corresponding event can't be found on the parameter, `initial_prompt_fulfillment` will be re-prompted. - { # An event handler specifies an event that can be handled during a session. When the specified event happens, the following actions are taken in order: * If there is a `trigger_fulfillment` associated with the event, it will be called. * If there is a `target_page` associated with the event, the session will transition into the specified page. * If there is a `target_flow` associated with the event, the session will transition into the specified flow. - "event": "A String", # Required. The name of the event to handle. - "name": "A String", # Output only. The unique identifier of this event handler. - "targetFlow": "A String", # The target flow to transition to. Format: `projects//locations//agents//flows/`. - "targetPage": "A String", # The target page to transition to. Format: `projects//locations//agents//flows//pages/`. - "triggerFulfillment": { # A fulfillment can do one or more of the following actions at the same time: * Generate rich message responses. * Set parameter values. * Call the webhook. Fulfillments can be called at various stages in the Page or Form lifecycle. For example, when a DetectIntentRequest drives a session to enter a new page, the page's entry fulfillment can add a static response to the QueryResult in the returning DetectIntentResponse, call the webhook (for example, to load user data from a database), or both. # The fulfillment to call when the event occurs. Handling webhook errors with a fulfillment enabled with webhook could cause infinite loop. It is invalid to specify such fulfillment for a handler handling webhooks. - "advancedSettings": { # Hierarchical advanced settings for agent/flow/page/fulfillment/parameter. Settings exposed at lower level overrides the settings exposed at higher level. Overriding occurs at the sub-setting level. For example, the playback_interruption_settings at fulfillment level only overrides the playback_interruption_settings at the agent level, leaving other settings at the agent level unchanged. DTMF settings does not override each other. DTMF settings set at different levels define DTMF detections running in parallel. Hierarchy: Agent->Flow->Page->Fulfillment/Parameter. # Hierarchical advanced settings for this fulfillment. The settings exposed at the lower level overrides the settings exposed at the higher level. - "audioExportGcsDestination": { # Google Cloud Storage location for a Dialogflow operation that writes or exports objects (e.g. exported agent or transcripts) outside of Dialogflow. # If present, incoming audio is exported by Dialogflow to the configured Google Cloud Storage destination. Exposed at the following levels: - Agent level - Flow level - "uri": "A String", # Required. The Google Cloud Storage URI for the exported objects. A URI is of the form: `gs://bucket/object-name-or-prefix` Whether a full object name, or just a prefix, its usage depends on the Dialogflow operation. + ], + "enableGenerativeFallback": True or False, # If the flag is true, the agent will utilize LLM to generate a text response. If LLM generation fails, the defined responses in the fulfillment will be respected. This flag is only useful for fulfillments associated with no-match event handlers. + "messages": [ # The list of rich message responses to present to the user. + { # 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. + "channel": "A String", # The channel which the response is associated with. Clients can specify the channel via QueryParameters.channel, and only associated channel response will be returned. + "conversationSuccess": { # 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. # Indicates that the conversation succeeded. + "metadata": { # Custom metadata. Dialogflow doesn't impose any structure on this. + "a_key": "", # Properties of the object. + }, }, - "dtmfSettings": { # Define behaviors for DTMF (dual tone multi frequency). # Settings for DTMF. Exposed at the following levels: - Agent level - Flow level - Page level - Parameter level. - "enabled": True or False, # If true, incoming audio is processed for DTMF (dual tone multi frequency) events. For example, if the caller presses a button on their telephone keypad and DTMF processing is enabled, Dialogflow will detect the event (e.g. a "3" was pressed) in the incoming audio and pass the event to the bot to drive business logic (e.g. when 3 is pressed, return the account balance). - "endpointingTimeoutDuration": "A String", # Endpoint timeout setting for matching dtmf input to regex. - "finishDigit": "A String", # The digit that terminates a DTMF digit sequence. - "interdigitTimeoutDuration": "A String", # Interdigit timeout setting for matching dtmf input to regex. - "maxDigits": 42, # Max length of DTMF digits. + "endInteraction": { # 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. # Output only. A signal that indicates the interaction with the Dialogflow agent has ended. This message is generated by Dialogflow only when the conversation reaches `END_SESSION` page. It is not supposed to be defined by the user. It's guaranteed that there is at most one such message in each response. }, - "loggingSettings": { # Define behaviors on logging. # Settings for logging. Settings for Dialogflow History, Contact Center messages, StackDriver logs, and speech logging. Exposed at the following levels: - Agent level. - "enableInteractionLogging": True or False, # If true, DF Interaction logging is currently enabled. - "enableStackdriverLogging": True or False, # If true, StackDriver logging is currently enabled. + "knowledgeInfoCard": { # Represents info card response. If the response contains generative knowledge prediction, Dialogflow will return a payload with Infobot Messenger compatible info card. Otherwise, the info card response is skipped. # Represents info card for knowledge answers, to be better rendered in Dialogflow Messenger. }, - "speechSettings": { # Define behaviors of speech to text detection. # Settings for speech to text detection. Exposed at the following levels: - Agent level - Flow level - Page level - Parameter level - "endpointerSensitivity": 42, # Sensitivity of the speech model that detects the end of speech. Scale from 0 to 100. - "models": { # Mapping from language to Speech-to-Text model. The mapped Speech-to-Text model will be selected for requests from its corresponding language. For more information, see [Speech models](https://cloud.google.com/dialogflow/cx/docs/concept/speech-models). - "a_key": "A String", + "liveAgentHandoff": { # 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. # Hands off conversation to a human agent. + "metadata": { # Custom metadata for your handoff procedure. Dialogflow doesn't impose any structure on this. + "a_key": "", # Properties of the object. }, - "noSpeechTimeout": "A String", # Timeout before detecting no speech. - "useTimeoutBasedEndpointing": True or False, # Use timeout based endpointing, interpreting endpointer sensitivy as seconds of timeout value. }, - }, - "conditionalCases": [ # Conditional cases for this fulfillment. - { # A list of cascading if-else conditions. Cases are mutually exclusive. The first one with a matching condition is selected, all the rest ignored. - "cases": [ # A list of cascading if-else conditions. - { # Each case has a Boolean condition. When it is evaluated to be True, the corresponding messages will be selected and evaluated recursively. - "caseContent": [ # A list of case content. - { # The list of messages or conditional cases to activate for this case. - "additionalCases": # Object with schema name: GoogleCloudDialogflowCxV3beta1FulfillmentConditionalCases # Additional cases to be evaluated. - "message": { # 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. # Returned message. - "channel": "A String", # The channel which the response is associated with. Clients can specify the channel via QueryParameters.channel, and only associated channel response will be returned. - "conversationSuccess": { # 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. # Indicates that the conversation succeeded. - "metadata": { # Custom metadata. Dialogflow doesn't impose any structure on this. - "a_key": "", # Properties of the object. - }, - }, - "endInteraction": { # 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. # Output only. A signal that indicates the interaction with the Dialogflow agent has ended. This message is generated by Dialogflow only when the conversation reaches `END_SESSION` page. It is not supposed to be defined by the user. It's guaranteed that there is at most one such message in each response. - }, - "knowledgeInfoCard": { # Represents info card response. If the response contains generative knowledge prediction, Dialogflow will return a payload with Infobot Messenger compatible info card. Otherwise, the info card response is skipped. # Represents info card for knowledge answers, to be better rendered in Dialogflow Messenger. - }, - "liveAgentHandoff": { # 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. # Hands off conversation to a human agent. - "metadata": { # Custom metadata for your handoff procedure. Dialogflow doesn't impose any structure on this. - "a_key": "", # Properties of the object. - }, - }, - "mixedAudio": { # 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. # Output only. An audio response message composed of both the synthesized Dialogflow agent responses and responses defined via play_audio. This message is generated by Dialogflow only and not supposed to be defined by the user. - "segments": [ # Segments this audio response is composed of. - { # Represents one segment of audio. - "allowPlaybackInterruption": True or False, # 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. - "audio": "A String", # Raw audio synthesized from the Dialogflow agent's response using the output config specified in the request. - "uri": "A String", # Client-specific URI that points to an audio clip accessible to the client. Dialogflow does not impose any validation on it. - }, - ], - }, - "outputAudioText": { # A text or ssml response that is preferentially used for TTS output audio synthesis, as described in the comment on the ResponseMessage message. # A text or ssml response that is preferentially used for TTS output audio synthesis, as described in the comment on the ResponseMessage message. - "allowPlaybackInterruption": True or False, # 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. - "ssml": "A String", # The SSML text to be synthesized. For more information, see [SSML](/speech/text-to-speech/docs/ssml). - "text": "A String", # The raw text to be synthesized. - }, - "payload": { # Returns a response containing a custom, platform-specific payload. - "a_key": "", # Properties of the object. - }, - "playAudio": { # Specifies an audio clip to be played by the client as part of the response. # Signal that the client should play an audio clip hosted at a client-specific URI. Dialogflow uses this to construct mixed_audio. However, Dialogflow itself does not try to read or process the URI in any way. - "allowPlaybackInterruption": True or False, # 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. - "audioUri": "A String", # Required. URI of the audio clip. Dialogflow does not impose any validation on this value. It is specific to the client that reads it. - }, - "telephonyTransferCall": { # Represents the signal that telles the client to transfer the phone call connected to the agent to a third-party endpoint. # A signal that the client should transfer the phone call connected to this agent to a third-party endpoint. - "phoneNumber": "A String", # Transfer the call to a phone number in [E.164 format](https://en.wikipedia.org/wiki/E.164). - }, - "text": { # The text response message. # Returns a text response. - "allowPlaybackInterruption": True or False, # 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. - "text": [ # Required. A collection of text responses. - "A String", - ], - }, - }, - }, - ], - "condition": "A String", # The condition to activate and select this case. Empty means the condition is always true. The condition is evaluated against form parameters or session parameters. See the [conditions reference](https://cloud.google.com/dialogflow/cx/docs/reference/condition). + "mixedAudio": { # 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. # Output only. An audio response message composed of both the synthesized Dialogflow agent responses and responses defined via play_audio. This message is generated by Dialogflow only and not supposed to be defined by the user. + "segments": [ # Segments this audio response is composed of. + { # Represents one segment of audio. + "allowPlaybackInterruption": True or False, # 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. + "audio": "A String", # Raw audio synthesized from the Dialogflow agent's response using the output config specified in the request. + "uri": "A String", # Client-specific URI that points to an audio clip accessible to the client. Dialogflow does not impose any validation on it. }, ], }, - ], - "enableGenerativeFallback": True or False, # If the flag is true, the agent will utilize LLM to generate a text response. If LLM generation fails, the defined responses in the fulfillment will be respected. This flag is only useful for fulfillments associated with no-match event handlers. - "messages": [ # The list of rich message responses to present to the user. - { # 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. - "channel": "A String", # The channel which the response is associated with. Clients can specify the channel via QueryParameters.channel, and only associated channel response will be returned. - "conversationSuccess": { # 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. # Indicates that the conversation succeeded. - "metadata": { # Custom metadata. Dialogflow doesn't impose any structure on this. - "a_key": "", # Properties of the object. - }, - }, - "endInteraction": { # 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. # Output only. A signal that indicates the interaction with the Dialogflow agent has ended. This message is generated by Dialogflow only when the conversation reaches `END_SESSION` page. It is not supposed to be defined by the user. It's guaranteed that there is at most one such message in each response. - }, - "knowledgeInfoCard": { # Represents info card response. If the response contains generative knowledge prediction, Dialogflow will return a payload with Infobot Messenger compatible info card. Otherwise, the info card response is skipped. # Represents info card for knowledge answers, to be better rendered in Dialogflow Messenger. - }, - "liveAgentHandoff": { # 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. # Hands off conversation to a human agent. - "metadata": { # Custom metadata for your handoff procedure. Dialogflow doesn't impose any structure on this. - "a_key": "", # Properties of the object. - }, - }, - "mixedAudio": { # 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. # Output only. An audio response message composed of both the synthesized Dialogflow agent responses and responses defined via play_audio. This message is generated by Dialogflow only and not supposed to be defined by the user. - "segments": [ # Segments this audio response is composed of. - { # Represents one segment of audio. - "allowPlaybackInterruption": True or False, # 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. - "audio": "A String", # Raw audio synthesized from the Dialogflow agent's response using the output config specified in the request. - "uri": "A String", # Client-specific URI that points to an audio clip accessible to the client. Dialogflow does not impose any validation on it. - }, - ], - }, - "outputAudioText": { # A text or ssml response that is preferentially used for TTS output audio synthesis, as described in the comment on the ResponseMessage message. # A text or ssml response that is preferentially used for TTS output audio synthesis, as described in the comment on the ResponseMessage message. - "allowPlaybackInterruption": True or False, # 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. - "ssml": "A String", # The SSML text to be synthesized. For more information, see [SSML](/speech/text-to-speech/docs/ssml). - "text": "A String", # The raw text to be synthesized. - }, - "payload": { # Returns a response containing a custom, platform-specific payload. + "outputAudioText": { # A text or ssml response that is preferentially used for TTS output audio synthesis, as described in the comment on the ResponseMessage message. # A text or ssml response that is preferentially used for TTS output audio synthesis, as described in the comment on the ResponseMessage message. + "allowPlaybackInterruption": True or False, # 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. + "ssml": "A String", # The SSML text to be synthesized. For more information, see [SSML](/speech/text-to-speech/docs/ssml). + "text": "A String", # The raw text to be synthesized. + }, + "payload": { # Returns a response containing a custom, platform-specific payload. + "a_key": "", # Properties of the object. + }, + "playAudio": { # Specifies an audio clip to be played by the client as part of the response. # Signal that the client should play an audio clip hosted at a client-specific URI. Dialogflow uses this to construct mixed_audio. However, Dialogflow itself does not try to read or process the URI in any way. + "allowPlaybackInterruption": True or False, # 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. + "audioUri": "A String", # Required. URI of the audio clip. Dialogflow does not impose any validation on this value. It is specific to the client that reads it. + }, + "telephonyTransferCall": { # Represents the signal that telles the client to transfer the phone call connected to the agent to a third-party endpoint. # A signal that the client should transfer the phone call connected to this agent to a third-party endpoint. + "phoneNumber": "A String", # Transfer the call to a phone number in [E.164 format](https://en.wikipedia.org/wiki/E.164). + }, + "text": { # The text response message. # Returns a text response. + "allowPlaybackInterruption": True or False, # 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. + "text": [ # Required. A collection of text responses. + "A String", + ], + }, + "toolCall": { # Represents a call of a specific tool's action with the specified inputs. # Returns the definition of a tool call that should be executed by the client. + "action": "A String", # Required. The name of the tool's action associated with this call. + "inputParameters": { # Optional. The action's input parameters. "a_key": "", # Properties of the object. }, - "playAudio": { # Specifies an audio clip to be played by the client as part of the response. # Signal that the client should play an audio clip hosted at a client-specific URI. Dialogflow uses this to construct mixed_audio. However, Dialogflow itself does not try to read or process the URI in any way. - "allowPlaybackInterruption": True or False, # 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. - "audioUri": "A String", # Required. URI of the audio clip. Dialogflow does not impose any validation on this value. It is specific to the client that reads it. + "tool": "A String", # Required. The tool associated with this call. Format: `projects//locations//agents//tools/`. + }, + }, + ], + "returnPartialResponses": True or False, # Whether Dialogflow should return currently queued fulfillment response messages in streaming APIs. If a webhook is specified, it happens before Dialogflow invokes webhook. Warning: 1) This flag only affects streaming API. Responses are still queued and returned once in non-streaming API. 2) The flag can be enabled in any fulfillment but only the first 3 partial responses will be returned. You may only want to apply it to fulfillments that have slow webhooks. + "setParameterActions": [ # Set parameter values before executing the webhook. + { # Setting a parameter value. + "parameter": "A String", # Display name of the parameter. + "value": "", # The new value of the parameter. A null value clears the parameter. + }, + ], + "tag": "A String", # The value of this field will be populated in the WebhookRequest `fulfillmentInfo.tag` field by Dialogflow when the associated webhook is called. The tag is typically used by the webhook service to identify which fulfillment is being called, but it could be used for other purposes. This field is required if `webhook` is specified. + "webhook": "A String", # The webhook to call. Format: `projects//locations//agents//webhooks/`. + }, + "repromptEventHandlers": [ # The handlers for parameter-level events, used to provide reprompt for the parameter or transition to a different page/flow. The supported events are: * `sys.no-match-`, where N can be from 1 to 6 * `sys.no-match-default` * `sys.no-input-`, where N can be from 1 to 6 * `sys.no-input-default` * `sys.invalid-parameter` `initial_prompt_fulfillment` provides the first prompt for the parameter. If the user's response does not fill the parameter, a no-match/no-input event will be triggered, and the fulfillment associated with the `sys.no-match-1`/`sys.no-input-1` handler (if defined) will be called to provide a prompt. The `sys.no-match-2`/`sys.no-input-2` handler (if defined) will respond to the next no-match/no-input event, and so on. A `sys.no-match-default` or `sys.no-input-default` handler will be used to handle all following no-match/no-input events after all numbered no-match/no-input handlers for the parameter are consumed. A `sys.invalid-parameter` handler can be defined to handle the case where the parameter values have been `invalidated` by webhook. For example, if the user's response fill the parameter, however the parameter was invalidated by webhook, the fulfillment associated with the `sys.invalid-parameter` handler (if defined) will be called to provide a prompt. If the event handler for the corresponding event can't be found on the parameter, `initial_prompt_fulfillment` will be re-prompted. + { # An event handler specifies an event that can be handled during a session. When the specified event happens, the following actions are taken in order: * If there is a `trigger_fulfillment` associated with the event, it will be called. * If there is a `target_page` associated with the event, the session will transition into the specified page. * If there is a `target_flow` associated with the event, the session will transition into the specified flow. + "event": "A String", # Required. The name of the event to handle. + "name": "A String", # Output only. The unique identifier of this event handler. + "targetFlow": "A String", # The target flow to transition to. Format: `projects//locations//agents//flows/`. + "targetPage": "A String", # The target page to transition to. Format: `projects//locations//agents//flows//pages/`. + "triggerFulfillment": { # A fulfillment can do one or more of the following actions at the same time: * Generate rich message responses. * Set parameter values. * Call the webhook. Fulfillments can be called at various stages in the Page or Form lifecycle. For example, when a DetectIntentRequest drives a session to enter a new page, the page's entry fulfillment can add a static response to the QueryResult in the returning DetectIntentResponse, call the webhook (for example, to load user data from a database), or both. # The fulfillment to call when the event occurs. Handling webhook errors with a fulfillment enabled with webhook could cause infinite loop. It is invalid to specify such fulfillment for a handler handling webhooks. + "advancedSettings": { # Hierarchical advanced settings for agent/flow/page/fulfillment/parameter. Settings exposed at lower level overrides the settings exposed at higher level. Overriding occurs at the sub-setting level. For example, the playback_interruption_settings at fulfillment level only overrides the playback_interruption_settings at the agent level, leaving other settings at the agent level unchanged. DTMF settings does not override each other. DTMF settings set at different levels define DTMF detections running in parallel. Hierarchy: Agent->Flow->Page->Fulfillment/Parameter. # Hierarchical advanced settings for this fulfillment. The settings exposed at the lower level overrides the settings exposed at the higher level. + "audioExportGcsDestination": { # Google Cloud Storage location for a Dialogflow operation that writes or exports objects (e.g. exported agent or transcripts) outside of Dialogflow. # If present, incoming audio is exported by Dialogflow to the configured Google Cloud Storage destination. Exposed at the following levels: - Agent level - Flow level + "uri": "A String", # Required. The Google Cloud Storage URI for the exported objects. A URI is of the form: `gs://bucket/object-name-or-prefix` Whether a full object name, or just a prefix, its usage depends on the Dialogflow operation. }, - "telephonyTransferCall": { # Represents the signal that telles the client to transfer the phone call connected to the agent to a third-party endpoint. # A signal that the client should transfer the phone call connected to this agent to a third-party endpoint. - "phoneNumber": "A String", # Transfer the call to a phone number in [E.164 format](https://en.wikipedia.org/wiki/E.164). + "dtmfSettings": { # Define behaviors for DTMF (dual tone multi frequency). # Settings for DTMF. Exposed at the following levels: - Agent level - Flow level - Page level - Parameter level. + "enabled": True or False, # If true, incoming audio is processed for DTMF (dual tone multi frequency) events. For example, if the caller presses a button on their telephone keypad and DTMF processing is enabled, Dialogflow will detect the event (e.g. a "3" was pressed) in the incoming audio and pass the event to the bot to drive business logic (e.g. when 3 is pressed, return the account balance). + "endpointingTimeoutDuration": "A String", # Endpoint timeout setting for matching dtmf input to regex. + "finishDigit": "A String", # The digit that terminates a DTMF digit sequence. + "interdigitTimeoutDuration": "A String", # Interdigit timeout setting for matching dtmf input to regex. + "maxDigits": 42, # Max length of DTMF digits. }, - "text": { # The text response message. # Returns a text response. - "allowPlaybackInterruption": True or False, # 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. - "text": [ # Required. A collection of text responses. - "A String", - ], + "loggingSettings": { # Define behaviors on logging. # Settings for logging. Settings for Dialogflow History, Contact Center messages, StackDriver logs, and speech logging. Exposed at the following levels: - Agent level. + "enableInteractionLogging": True or False, # Enables DF Interaction logging. + "enableStackdriverLogging": True or False, # Enables StackDriver logging. + }, + "speechSettings": { # Define behaviors of speech to text detection. # Settings for speech to text detection. Exposed at the following levels: - Agent level - Flow level - Page level - Parameter level + "endpointerSensitivity": 42, # Sensitivity of the speech model that detects the end of speech. Scale from 0 to 100. + "models": { # Mapping from language to Speech-to-Text model. The mapped Speech-to-Text model will be selected for requests from its corresponding language. For more information, see [Speech models](https://cloud.google.com/dialogflow/cx/docs/concept/speech-models). + "a_key": "A String", + }, + "noSpeechTimeout": "A String", # Timeout before detecting no speech. + "useTimeoutBasedEndpointing": True or False, # Use timeout based endpointing, interpreting endpointer sensitivy as seconds of timeout value. }, }, - ], - "returnPartialResponses": True or False, # Whether Dialogflow should return currently queued fulfillment response messages in streaming APIs. If a webhook is specified, it happens before Dialogflow invokes webhook. Warning: 1) This flag only affects streaming API. Responses are still queued and returned once in non-streaming API. 2) The flag can be enabled in any fulfillment but only the first 3 partial responses will be returned. You may only want to apply it to fulfillments that have slow webhooks. - "setParameterActions": [ # Set parameter values before executing the webhook. - { # Setting a parameter value. - "parameter": "A String", # Display name of the parameter. - "value": "", # The new value of the parameter. A null value clears the parameter. - }, - ], - "tag": "A String", # The value of this field will be populated in the WebhookRequest `fulfillmentInfo.tag` field by Dialogflow when the associated webhook is called. The tag is typically used by the webhook service to identify which fulfillment is being called, but it could be used for other purposes. This field is required if `webhook` is specified. - "webhook": "A String", # The webhook to call. Format: `projects//locations//agents//webhooks/`. - }, - }, - ], - }, - "isList": True or False, # Indicates whether the parameter represents a list of values. - "redact": True or False, # Indicates whether the parameter content should be redacted in log. If redaction is enabled, the parameter content will be replaced by parameter name during logging. Note: the parameter content is subject to redaction if either parameter level redaction or entity type level redaction is enabled. - "required": True or False, # 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. - }, - ], - }, - "knowledgeConnectorSettings": { # The Knowledge Connector settings for this page or flow. This includes information such as the attached Knowledge Bases, and the way to execute fulfillment. # Optional. Knowledge connector configuration. - "dataStoreConnections": [ # Optional. List of related data store connections. - { # A data store connection. It represents a data store in Discovery Engine and the type of the contents it contains. - "dataStore": "A String", # The full name of the referenced data store. Formats: `projects/{project}/locations/{location}/collections/{collection}/dataStores/{data_store}` `projects/{project}/locations/{location}/dataStores/{data_store}` - "dataStoreType": "A String", # The type of the connected data store. - }, - ], - "enabled": True or False, # Whether Knowledge Connector is enabled or not. - "targetFlow": "A String", # The target flow to transition to. Format: `projects//locations//agents//flows/`. - "targetPage": "A String", # The target page to transition to. Format: `projects//locations//agents//flows//pages/`. - "triggerFulfillment": { # A fulfillment can do one or more of the following actions at the same time: * Generate rich message responses. * Set parameter values. * Call the webhook. Fulfillments can be called at various stages in the Page or Form lifecycle. For example, when a DetectIntentRequest drives a session to enter a new page, the page's entry fulfillment can add a static response to the QueryResult in the returning DetectIntentResponse, call the webhook (for example, to load user data from a database), or both. # The fulfillment to be triggered. When the answers from the Knowledge Connector are selected by Dialogflow, you can utitlize the request scoped parameter `$request.knowledge.answers` (contains up to the 5 highest confidence answers) and `$request.knowledge.questions` (contains the corresponding questions) to construct the fulfillment. - "advancedSettings": { # Hierarchical advanced settings for agent/flow/page/fulfillment/parameter. Settings exposed at lower level overrides the settings exposed at higher level. Overriding occurs at the sub-setting level. For example, the playback_interruption_settings at fulfillment level only overrides the playback_interruption_settings at the agent level, leaving other settings at the agent level unchanged. DTMF settings does not override each other. DTMF settings set at different levels define DTMF detections running in parallel. Hierarchy: Agent->Flow->Page->Fulfillment/Parameter. # Hierarchical advanced settings for this fulfillment. The settings exposed at the lower level overrides the settings exposed at the higher level. - "audioExportGcsDestination": { # Google Cloud Storage location for a Dialogflow operation that writes or exports objects (e.g. exported agent or transcripts) outside of Dialogflow. # If present, incoming audio is exported by Dialogflow to the configured Google Cloud Storage destination. Exposed at the following levels: - Agent level - Flow level - "uri": "A String", # Required. The Google Cloud Storage URI for the exported objects. A URI is of the form: `gs://bucket/object-name-or-prefix` Whether a full object name, or just a prefix, its usage depends on the Dialogflow operation. - }, - "dtmfSettings": { # Define behaviors for DTMF (dual tone multi frequency). # Settings for DTMF. Exposed at the following levels: - Agent level - Flow level - Page level - Parameter level. - "enabled": True or False, # If true, incoming audio is processed for DTMF (dual tone multi frequency) events. For example, if the caller presses a button on their telephone keypad and DTMF processing is enabled, Dialogflow will detect the event (e.g. a "3" was pressed) in the incoming audio and pass the event to the bot to drive business logic (e.g. when 3 is pressed, return the account balance). - "endpointingTimeoutDuration": "A String", # Endpoint timeout setting for matching dtmf input to regex. - "finishDigit": "A String", # The digit that terminates a DTMF digit sequence. - "interdigitTimeoutDuration": "A String", # Interdigit timeout setting for matching dtmf input to regex. - "maxDigits": 42, # Max length of DTMF digits. - }, - "loggingSettings": { # Define behaviors on logging. # Settings for logging. Settings for Dialogflow History, Contact Center messages, StackDriver logs, and speech logging. Exposed at the following levels: - Agent level. - "enableInteractionLogging": True or False, # If true, DF Interaction logging is currently enabled. - "enableStackdriverLogging": True or False, # If true, StackDriver logging is currently enabled. - }, - "speechSettings": { # Define behaviors of speech to text detection. # Settings for speech to text detection. Exposed at the following levels: - Agent level - Flow level - Page level - Parameter level - "endpointerSensitivity": 42, # Sensitivity of the speech model that detects the end of speech. Scale from 0 to 100. - "models": { # Mapping from language to Speech-to-Text model. The mapped Speech-to-Text model will be selected for requests from its corresponding language. For more information, see [Speech models](https://cloud.google.com/dialogflow/cx/docs/concept/speech-models). - "a_key": "A String", - }, - "noSpeechTimeout": "A String", # Timeout before detecting no speech. - "useTimeoutBasedEndpointing": True or False, # Use timeout based endpointing, interpreting endpointer sensitivy as seconds of timeout value. - }, - }, - "conditionalCases": [ # Conditional cases for this fulfillment. - { # A list of cascading if-else conditions. Cases are mutually exclusive. The first one with a matching condition is selected, all the rest ignored. - "cases": [ # A list of cascading if-else conditions. - { # Each case has a Boolean condition. When it is evaluated to be True, the corresponding messages will be selected and evaluated recursively. - "caseContent": [ # A list of case content. - { # The list of messages or conditional cases to activate for this case. - "additionalCases": # Object with schema name: GoogleCloudDialogflowCxV3beta1FulfillmentConditionalCases # Additional cases to be evaluated. - "message": { # 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. # Returned message. - "channel": "A String", # The channel which the response is associated with. Clients can specify the channel via QueryParameters.channel, and only associated channel response will be returned. - "conversationSuccess": { # 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. # Indicates that the conversation succeeded. - "metadata": { # Custom metadata. Dialogflow doesn't impose any structure on this. - "a_key": "", # Properties of the object. - }, - }, - "endInteraction": { # 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. # Output only. A signal that indicates the interaction with the Dialogflow agent has ended. This message is generated by Dialogflow only when the conversation reaches `END_SESSION` page. It is not supposed to be defined by the user. It's guaranteed that there is at most one such message in each response. - }, - "knowledgeInfoCard": { # Represents info card response. If the response contains generative knowledge prediction, Dialogflow will return a payload with Infobot Messenger compatible info card. Otherwise, the info card response is skipped. # Represents info card for knowledge answers, to be better rendered in Dialogflow Messenger. + "conditionalCases": [ # Conditional cases for this fulfillment. + { # A list of cascading if-else conditions. Cases are mutually exclusive. The first one with a matching condition is selected, all the rest ignored. + "cases": [ # A list of cascading if-else conditions. + { # Each case has a Boolean condition. When it is evaluated to be True, the corresponding messages will be selected and evaluated recursively. + "caseContent": [ # A list of case content. + { # The list of messages or conditional cases to activate for this case. + "additionalCases": # Object with schema name: GoogleCloudDialogflowCxV3beta1FulfillmentConditionalCases # Additional cases to be evaluated. + "message": { # 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. # Returned message. + "channel": "A String", # The channel which the response is associated with. Clients can specify the channel via QueryParameters.channel, and only associated channel response will be returned. + "conversationSuccess": { # 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. # Indicates that the conversation succeeded. + "metadata": { # Custom metadata. Dialogflow doesn't impose any structure on this. + "a_key": "", # Properties of the object. + }, + }, + "endInteraction": { # 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. # Output only. A signal that indicates the interaction with the Dialogflow agent has ended. This message is generated by Dialogflow only when the conversation reaches `END_SESSION` page. It is not supposed to be defined by the user. It's guaranteed that there is at most one such message in each response. + }, + "knowledgeInfoCard": { # Represents info card response. If the response contains generative knowledge prediction, Dialogflow will return a payload with Infobot Messenger compatible info card. Otherwise, the info card response is skipped. # Represents info card for knowledge answers, to be better rendered in Dialogflow Messenger. + }, + "liveAgentHandoff": { # 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. # Hands off conversation to a human agent. + "metadata": { # Custom metadata for your handoff procedure. Dialogflow doesn't impose any structure on this. + "a_key": "", # Properties of the object. + }, + }, + "mixedAudio": { # 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. # Output only. An audio response message composed of both the synthesized Dialogflow agent responses and responses defined via play_audio. This message is generated by Dialogflow only and not supposed to be defined by the user. + "segments": [ # Segments this audio response is composed of. + { # Represents one segment of audio. + "allowPlaybackInterruption": True or False, # 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. + "audio": "A String", # Raw audio synthesized from the Dialogflow agent's response using the output config specified in the request. + "uri": "A String", # Client-specific URI that points to an audio clip accessible to the client. Dialogflow does not impose any validation on it. + }, + ], + }, + "outputAudioText": { # A text or ssml response that is preferentially used for TTS output audio synthesis, as described in the comment on the ResponseMessage message. # A text or ssml response that is preferentially used for TTS output audio synthesis, as described in the comment on the ResponseMessage message. + "allowPlaybackInterruption": True or False, # 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. + "ssml": "A String", # The SSML text to be synthesized. For more information, see [SSML](/speech/text-to-speech/docs/ssml). + "text": "A String", # The raw text to be synthesized. + }, + "payload": { # Returns a response containing a custom, platform-specific payload. + "a_key": "", # Properties of the object. + }, + "playAudio": { # Specifies an audio clip to be played by the client as part of the response. # Signal that the client should play an audio clip hosted at a client-specific URI. Dialogflow uses this to construct mixed_audio. However, Dialogflow itself does not try to read or process the URI in any way. + "allowPlaybackInterruption": True or False, # 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. + "audioUri": "A String", # Required. URI of the audio clip. Dialogflow does not impose any validation on this value. It is specific to the client that reads it. + }, + "telephonyTransferCall": { # Represents the signal that telles the client to transfer the phone call connected to the agent to a third-party endpoint. # A signal that the client should transfer the phone call connected to this agent to a third-party endpoint. + "phoneNumber": "A String", # Transfer the call to a phone number in [E.164 format](https://en.wikipedia.org/wiki/E.164). + }, + "text": { # The text response message. # Returns a text response. + "allowPlaybackInterruption": True or False, # 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. + "text": [ # Required. A collection of text responses. + "A String", + ], + }, + "toolCall": { # Represents a call of a specific tool's action with the specified inputs. # Returns the definition of a tool call that should be executed by the client. + "action": "A String", # Required. The name of the tool's action associated with this call. + "inputParameters": { # Optional. The action's input parameters. + "a_key": "", # Properties of the object. + }, + "tool": "A String", # Required. The tool associated with this call. Format: `projects//locations//agents//tools/`. + }, + }, + }, + ], + "condition": "A String", # The condition to activate and select this case. Empty means the condition is always true. The condition is evaluated against form parameters or session parameters. See the [conditions reference](https://cloud.google.com/dialogflow/cx/docs/reference/condition). + }, + ], }, - "liveAgentHandoff": { # 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. # Hands off conversation to a human agent. - "metadata": { # Custom metadata for your handoff procedure. Dialogflow doesn't impose any structure on this. + ], + "enableGenerativeFallback": True or False, # If the flag is true, the agent will utilize LLM to generate a text response. If LLM generation fails, the defined responses in the fulfillment will be respected. This flag is only useful for fulfillments associated with no-match event handlers. + "messages": [ # The list of rich message responses to present to the user. + { # 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. + "channel": "A String", # The channel which the response is associated with. Clients can specify the channel via QueryParameters.channel, and only associated channel response will be returned. + "conversationSuccess": { # 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. # Indicates that the conversation succeeded. + "metadata": { # Custom metadata. Dialogflow doesn't impose any structure on this. + "a_key": "", # Properties of the object. + }, + }, + "endInteraction": { # 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. # Output only. A signal that indicates the interaction with the Dialogflow agent has ended. This message is generated by Dialogflow only when the conversation reaches `END_SESSION` page. It is not supposed to be defined by the user. It's guaranteed that there is at most one such message in each response. + }, + "knowledgeInfoCard": { # Represents info card response. If the response contains generative knowledge prediction, Dialogflow will return a payload with Infobot Messenger compatible info card. Otherwise, the info card response is skipped. # Represents info card for knowledge answers, to be better rendered in Dialogflow Messenger. + }, + "liveAgentHandoff": { # 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. # Hands off conversation to a human agent. + "metadata": { # Custom metadata for your handoff procedure. Dialogflow doesn't impose any structure on this. + "a_key": "", # Properties of the object. + }, + }, + "mixedAudio": { # 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. # Output only. An audio response message composed of both the synthesized Dialogflow agent responses and responses defined via play_audio. This message is generated by Dialogflow only and not supposed to be defined by the user. + "segments": [ # Segments this audio response is composed of. + { # Represents one segment of audio. + "allowPlaybackInterruption": True or False, # 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. + "audio": "A String", # Raw audio synthesized from the Dialogflow agent's response using the output config specified in the request. + "uri": "A String", # Client-specific URI that points to an audio clip accessible to the client. Dialogflow does not impose any validation on it. + }, + ], + }, + "outputAudioText": { # A text or ssml response that is preferentially used for TTS output audio synthesis, as described in the comment on the ResponseMessage message. # A text or ssml response that is preferentially used for TTS output audio synthesis, as described in the comment on the ResponseMessage message. + "allowPlaybackInterruption": True or False, # 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. + "ssml": "A String", # The SSML text to be synthesized. For more information, see [SSML](/speech/text-to-speech/docs/ssml). + "text": "A String", # The raw text to be synthesized. + }, + "payload": { # Returns a response containing a custom, platform-specific payload. "a_key": "", # Properties of the object. }, - }, - "mixedAudio": { # 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. # Output only. An audio response message composed of both the synthesized Dialogflow agent responses and responses defined via play_audio. This message is generated by Dialogflow only and not supposed to be defined by the user. - "segments": [ # Segments this audio response is composed of. - { # Represents one segment of audio. - "allowPlaybackInterruption": True or False, # 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. - "audio": "A String", # Raw audio synthesized from the Dialogflow agent's response using the output config specified in the request. - "uri": "A String", # Client-specific URI that points to an audio clip accessible to the client. Dialogflow does not impose any validation on it. + "playAudio": { # Specifies an audio clip to be played by the client as part of the response. # Signal that the client should play an audio clip hosted at a client-specific URI. Dialogflow uses this to construct mixed_audio. However, Dialogflow itself does not try to read or process the URI in any way. + "allowPlaybackInterruption": True or False, # 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. + "audioUri": "A String", # Required. URI of the audio clip. Dialogflow does not impose any validation on this value. It is specific to the client that reads it. + }, + "telephonyTransferCall": { # Represents the signal that telles the client to transfer the phone call connected to the agent to a third-party endpoint. # A signal that the client should transfer the phone call connected to this agent to a third-party endpoint. + "phoneNumber": "A String", # Transfer the call to a phone number in [E.164 format](https://en.wikipedia.org/wiki/E.164). + }, + "text": { # The text response message. # Returns a text response. + "allowPlaybackInterruption": True or False, # 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. + "text": [ # Required. A collection of text responses. + "A String", + ], + }, + "toolCall": { # Represents a call of a specific tool's action with the specified inputs. # Returns the definition of a tool call that should be executed by the client. + "action": "A String", # Required. The name of the tool's action associated with this call. + "inputParameters": { # Optional. The action's input parameters. + "a_key": "", # Properties of the object. }, - ], - }, - "outputAudioText": { # A text or ssml response that is preferentially used for TTS output audio synthesis, as described in the comment on the ResponseMessage message. # A text or ssml response that is preferentially used for TTS output audio synthesis, as described in the comment on the ResponseMessage message. - "allowPlaybackInterruption": True or False, # 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. - "ssml": "A String", # The SSML text to be synthesized. For more information, see [SSML](/speech/text-to-speech/docs/ssml). - "text": "A String", # The raw text to be synthesized. - }, - "payload": { # Returns a response containing a custom, platform-specific payload. - "a_key": "", # Properties of the object. - }, - "playAudio": { # Specifies an audio clip to be played by the client as part of the response. # Signal that the client should play an audio clip hosted at a client-specific URI. Dialogflow uses this to construct mixed_audio. However, Dialogflow itself does not try to read or process the URI in any way. - "allowPlaybackInterruption": True or False, # 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. - "audioUri": "A String", # Required. URI of the audio clip. Dialogflow does not impose any validation on this value. It is specific to the client that reads it. - }, - "telephonyTransferCall": { # Represents the signal that telles the client to transfer the phone call connected to the agent to a third-party endpoint. # A signal that the client should transfer the phone call connected to this agent to a third-party endpoint. - "phoneNumber": "A String", # Transfer the call to a phone number in [E.164 format](https://en.wikipedia.org/wiki/E.164). + "tool": "A String", # Required. The tool associated with this call. Format: `projects//locations//agents//tools/`. + }, }, - "text": { # The text response message. # Returns a text response. - "allowPlaybackInterruption": True or False, # 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. - "text": [ # Required. A collection of text responses. - "A String", - ], + ], + "returnPartialResponses": True or False, # Whether Dialogflow should return currently queued fulfillment response messages in streaming APIs. If a webhook is specified, it happens before Dialogflow invokes webhook. Warning: 1) This flag only affects streaming API. Responses are still queued and returned once in non-streaming API. 2) The flag can be enabled in any fulfillment but only the first 3 partial responses will be returned. You may only want to apply it to fulfillments that have slow webhooks. + "setParameterActions": [ # Set parameter values before executing the webhook. + { # Setting a parameter value. + "parameter": "A String", # Display name of the parameter. + "value": "", # The new value of the parameter. A null value clears the parameter. }, - }, + ], + "tag": "A String", # The value of this field will be populated in the WebhookRequest `fulfillmentInfo.tag` field by Dialogflow when the associated webhook is called. The tag is typically used by the webhook service to identify which fulfillment is being called, but it could be used for other purposes. This field is required if `webhook` is specified. + "webhook": "A String", # The webhook to call. Format: `projects//locations//agents//webhooks/`. }, - ], - "condition": "A String", # The condition to activate and select this case. Empty means the condition is always true. The condition is evaluated against form parameters or session parameters. See the [conditions reference](https://cloud.google.com/dialogflow/cx/docs/reference/condition). - }, - ], + }, + ], + }, + "isList": True or False, # Indicates whether the parameter represents a list of values. + "redact": True or False, # Indicates whether the parameter content should be redacted in log. If redaction is enabled, the parameter content will be replaced by parameter name during logging. Note: the parameter content is subject to redaction if either parameter level redaction or entity type level redaction is enabled. + "required": True or False, # 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. }, ], - "enableGenerativeFallback": True or False, # If the flag is true, the agent will utilize LLM to generate a text response. If LLM generation fails, the defined responses in the fulfillment will be respected. This flag is only useful for fulfillments associated with no-match event handlers. - "messages": [ # The list of rich message responses to present to the user. - { # 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. - "channel": "A String", # The channel which the response is associated with. Clients can specify the channel via QueryParameters.channel, and only associated channel response will be returned. - "conversationSuccess": { # 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. # Indicates that the conversation succeeded. - "metadata": { # Custom metadata. Dialogflow doesn't impose any structure on this. - "a_key": "", # Properties of the object. - }, + }, + "knowledgeConnectorSettings": { # The Knowledge Connector settings for this page or flow. This includes information such as the attached Knowledge Bases, and the way to execute fulfillment. # Optional. Knowledge connector configuration. + "dataStoreConnections": [ # Optional. List of related data store connections. + { # A data store connection. It represents a data store in Discovery Engine and the type of the contents it contains. + "dataStore": "A String", # The full name of the referenced data store. Formats: `projects/{project}/locations/{location}/collections/{collection}/dataStores/{data_store}` `projects/{project}/locations/{location}/dataStores/{data_store}` + "dataStoreType": "A String", # The type of the connected data store. + }, + ], + "enabled": True or False, # Whether Knowledge Connector is enabled or not. + "targetFlow": "A String", # The target flow to transition to. Format: `projects//locations//agents//flows/`. + "targetPage": "A String", # The target page to transition to. Format: `projects//locations//agents//flows//pages/`. + "triggerFulfillment": { # A fulfillment can do one or more of the following actions at the same time: * Generate rich message responses. * Set parameter values. * Call the webhook. Fulfillments can be called at various stages in the Page or Form lifecycle. For example, when a DetectIntentRequest drives a session to enter a new page, the page's entry fulfillment can add a static response to the QueryResult in the returning DetectIntentResponse, call the webhook (for example, to load user data from a database), or both. # The fulfillment to be triggered. When the answers from the Knowledge Connector are selected by Dialogflow, you can utitlize the request scoped parameter `$request.knowledge.answers` (contains up to the 5 highest confidence answers) and `$request.knowledge.questions` (contains the corresponding questions) to construct the fulfillment. + "advancedSettings": { # Hierarchical advanced settings for agent/flow/page/fulfillment/parameter. Settings exposed at lower level overrides the settings exposed at higher level. Overriding occurs at the sub-setting level. For example, the playback_interruption_settings at fulfillment level only overrides the playback_interruption_settings at the agent level, leaving other settings at the agent level unchanged. DTMF settings does not override each other. DTMF settings set at different levels define DTMF detections running in parallel. Hierarchy: Agent->Flow->Page->Fulfillment/Parameter. # Hierarchical advanced settings for this fulfillment. The settings exposed at the lower level overrides the settings exposed at the higher level. + "audioExportGcsDestination": { # Google Cloud Storage location for a Dialogflow operation that writes or exports objects (e.g. exported agent or transcripts) outside of Dialogflow. # If present, incoming audio is exported by Dialogflow to the configured Google Cloud Storage destination. Exposed at the following levels: - Agent level - Flow level + "uri": "A String", # Required. The Google Cloud Storage URI for the exported objects. A URI is of the form: `gs://bucket/object-name-or-prefix` Whether a full object name, or just a prefix, its usage depends on the Dialogflow operation. }, - "endInteraction": { # 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. # Output only. A signal that indicates the interaction with the Dialogflow agent has ended. This message is generated by Dialogflow only when the conversation reaches `END_SESSION` page. It is not supposed to be defined by the user. It's guaranteed that there is at most one such message in each response. + "dtmfSettings": { # Define behaviors for DTMF (dual tone multi frequency). # Settings for DTMF. Exposed at the following levels: - Agent level - Flow level - Page level - Parameter level. + "enabled": True or False, # If true, incoming audio is processed for DTMF (dual tone multi frequency) events. For example, if the caller presses a button on their telephone keypad and DTMF processing is enabled, Dialogflow will detect the event (e.g. a "3" was pressed) in the incoming audio and pass the event to the bot to drive business logic (e.g. when 3 is pressed, return the account balance). + "endpointingTimeoutDuration": "A String", # Endpoint timeout setting for matching dtmf input to regex. + "finishDigit": "A String", # The digit that terminates a DTMF digit sequence. + "interdigitTimeoutDuration": "A String", # Interdigit timeout setting for matching dtmf input to regex. + "maxDigits": 42, # Max length of DTMF digits. }, - "knowledgeInfoCard": { # Represents info card response. If the response contains generative knowledge prediction, Dialogflow will return a payload with Infobot Messenger compatible info card. Otherwise, the info card response is skipped. # Represents info card for knowledge answers, to be better rendered in Dialogflow Messenger. + "loggingSettings": { # Define behaviors on logging. # Settings for logging. Settings for Dialogflow History, Contact Center messages, StackDriver logs, and speech logging. Exposed at the following levels: - Agent level. + "enableInteractionLogging": True or False, # Enables DF Interaction logging. + "enableStackdriverLogging": True or False, # Enables StackDriver logging. }, - "liveAgentHandoff": { # 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. # Hands off conversation to a human agent. - "metadata": { # Custom metadata for your handoff procedure. Dialogflow doesn't impose any structure on this. - "a_key": "", # Properties of the object. + "speechSettings": { # Define behaviors of speech to text detection. # Settings for speech to text detection. Exposed at the following levels: - Agent level - Flow level - Page level - Parameter level + "endpointerSensitivity": 42, # Sensitivity of the speech model that detects the end of speech. Scale from 0 to 100. + "models": { # Mapping from language to Speech-to-Text model. The mapped Speech-to-Text model will be selected for requests from its corresponding language. For more information, see [Speech models](https://cloud.google.com/dialogflow/cx/docs/concept/speech-models). + "a_key": "A String", }, - }, - "mixedAudio": { # 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. # Output only. An audio response message composed of both the synthesized Dialogflow agent responses and responses defined via play_audio. This message is generated by Dialogflow only and not supposed to be defined by the user. - "segments": [ # Segments this audio response is composed of. - { # Represents one segment of audio. - "allowPlaybackInterruption": True or False, # 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. - "audio": "A String", # Raw audio synthesized from the Dialogflow agent's response using the output config specified in the request. - "uri": "A String", # Client-specific URI that points to an audio clip accessible to the client. Dialogflow does not impose any validation on it. - }, - ], - }, - "outputAudioText": { # A text or ssml response that is preferentially used for TTS output audio synthesis, as described in the comment on the ResponseMessage message. # A text or ssml response that is preferentially used for TTS output audio synthesis, as described in the comment on the ResponseMessage message. - "allowPlaybackInterruption": True or False, # 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. - "ssml": "A String", # The SSML text to be synthesized. For more information, see [SSML](/speech/text-to-speech/docs/ssml). - "text": "A String", # The raw text to be synthesized. - }, - "payload": { # Returns a response containing a custom, platform-specific payload. - "a_key": "", # Properties of the object. - }, - "playAudio": { # Specifies an audio clip to be played by the client as part of the response. # Signal that the client should play an audio clip hosted at a client-specific URI. Dialogflow uses this to construct mixed_audio. However, Dialogflow itself does not try to read or process the URI in any way. - "allowPlaybackInterruption": True or False, # 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. - "audioUri": "A String", # Required. URI of the audio clip. Dialogflow does not impose any validation on this value. It is specific to the client that reads it. - }, - "telephonyTransferCall": { # Represents the signal that telles the client to transfer the phone call connected to the agent to a third-party endpoint. # A signal that the client should transfer the phone call connected to this agent to a third-party endpoint. - "phoneNumber": "A String", # Transfer the call to a phone number in [E.164 format](https://en.wikipedia.org/wiki/E.164). - }, - "text": { # The text response message. # Returns a text response. - "allowPlaybackInterruption": True or False, # 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. - "text": [ # Required. A collection of text responses. - "A String", - ], - }, - }, - ], - "returnPartialResponses": True or False, # Whether Dialogflow should return currently queued fulfillment response messages in streaming APIs. If a webhook is specified, it happens before Dialogflow invokes webhook. Warning: 1) This flag only affects streaming API. Responses are still queued and returned once in non-streaming API. 2) The flag can be enabled in any fulfillment but only the first 3 partial responses will be returned. You may only want to apply it to fulfillments that have slow webhooks. - "setParameterActions": [ # Set parameter values before executing the webhook. - { # Setting a parameter value. - "parameter": "A String", # Display name of the parameter. - "value": "", # The new value of the parameter. A null value clears the parameter. - }, - ], - "tag": "A String", # The value of this field will be populated in the WebhookRequest `fulfillmentInfo.tag` field by Dialogflow when the associated webhook is called. The tag is typically used by the webhook service to identify which fulfillment is being called, but it could be used for other purposes. This field is required if `webhook` is specified. - "webhook": "A String", # The webhook to call. Format: `projects//locations//agents//webhooks/`. - }, - }, - "name": "A String", # The unique identifier of the page. Required for the Pages.UpdatePage method. Pages.CreatePage populates the name automatically. Format: `projects//locations//agents//flows//pages/`. - "transitionRouteGroups": [ # Ordered list of `TransitionRouteGroups` added to the page. Transition route groups must be unique within a page. If the page links both flow-level transition route groups and agent-level transition route groups, the flow-level ones will have higher priority and will be put before the agent-level ones. * If multiple transition routes within a page scope refer to the same intent, then the precedence order is: page's transition route -> page's transition route group -> flow's transition routes. * If multiple transition route groups within a page contain the same intent, then the first group in the ordered list takes precedence. Format:`projects//locations//agents//flows//transitionRouteGroups/` or `projects//locations//agents//transitionRouteGroups/` for agent-level groups. - "A String", - ], - "transitionRoutes": [ # A list of transitions for the transition rules of this page. They route the conversation to another page in the same flow, or another flow. When we are in a certain page, the TransitionRoutes are evalauted in the following order: * TransitionRoutes defined in the page with intent specified. * TransitionRoutes defined in the transition route groups with intent specified. * TransitionRoutes defined in flow with intent specified. * TransitionRoutes defined in the transition route groups with intent specified. * TransitionRoutes defined in the page with only condition specified. * TransitionRoutes defined in the transition route groups with only condition specified. - { # A transition route specifies a intent that can be matched and/or a data condition that can be evaluated during a session. When a specified transition is matched, the following actions are taken in order: * If there is a `trigger_fulfillment` associated with the transition, it will be called. * If there is a `target_page` associated with the transition, the session will transition into the specified page. * If there is a `target_flow` associated with the transition, the session will transition into the specified flow. - "condition": "A String", # The condition to evaluate against form parameters or session parameters. See the [conditions reference](https://cloud.google.com/dialogflow/cx/docs/reference/condition). At least one of `intent` or `condition` must be specified. When both `intent` and `condition` are specified, the transition can only happen when both are fulfilled. - "description": "A String", # Optional. The description of the transition route. The maximum length is 500 characters. - "intent": "A String", # The unique identifier of an Intent. Format: `projects//locations//agents//intents/`. Indicates that the transition can only happen when the given intent is matched. At least one of `intent` or `condition` must be specified. When both `intent` and `condition` are specified, the transition can only happen when both are fulfilled. - "name": "A String", # Output only. The unique identifier of this transition route. - "targetFlow": "A String", # The target flow to transition to. Format: `projects//locations//agents//flows/`. - "targetPage": "A String", # The target page to transition to. Format: `projects//locations//agents//flows//pages/`. - "triggerFulfillment": { # A fulfillment can do one or more of the following actions at the same time: * Generate rich message responses. * Set parameter values. * Call the webhook. Fulfillments can be called at various stages in the Page or Form lifecycle. For example, when a DetectIntentRequest drives a session to enter a new page, the page's entry fulfillment can add a static response to the QueryResult in the returning DetectIntentResponse, call the webhook (for example, to load user data from a database), or both. # The fulfillment to call when the condition is satisfied. At least one of `trigger_fulfillment` and `target` must be specified. When both are defined, `trigger_fulfillment` is executed first. - "advancedSettings": { # Hierarchical advanced settings for agent/flow/page/fulfillment/parameter. Settings exposed at lower level overrides the settings exposed at higher level. Overriding occurs at the sub-setting level. For example, the playback_interruption_settings at fulfillment level only overrides the playback_interruption_settings at the agent level, leaving other settings at the agent level unchanged. DTMF settings does not override each other. DTMF settings set at different levels define DTMF detections running in parallel. Hierarchy: Agent->Flow->Page->Fulfillment/Parameter. # Hierarchical advanced settings for this fulfillment. The settings exposed at the lower level overrides the settings exposed at the higher level. - "audioExportGcsDestination": { # Google Cloud Storage location for a Dialogflow operation that writes or exports objects (e.g. exported agent or transcripts) outside of Dialogflow. # If present, incoming audio is exported by Dialogflow to the configured Google Cloud Storage destination. Exposed at the following levels: - Agent level - Flow level - "uri": "A String", # Required. The Google Cloud Storage URI for the exported objects. A URI is of the form: `gs://bucket/object-name-or-prefix` Whether a full object name, or just a prefix, its usage depends on the Dialogflow operation. - }, - "dtmfSettings": { # Define behaviors for DTMF (dual tone multi frequency). # Settings for DTMF. Exposed at the following levels: - Agent level - Flow level - Page level - Parameter level. - "enabled": True or False, # If true, incoming audio is processed for DTMF (dual tone multi frequency) events. For example, if the caller presses a button on their telephone keypad and DTMF processing is enabled, Dialogflow will detect the event (e.g. a "3" was pressed) in the incoming audio and pass the event to the bot to drive business logic (e.g. when 3 is pressed, return the account balance). - "endpointingTimeoutDuration": "A String", # Endpoint timeout setting for matching dtmf input to regex. - "finishDigit": "A String", # The digit that terminates a DTMF digit sequence. - "interdigitTimeoutDuration": "A String", # Interdigit timeout setting for matching dtmf input to regex. - "maxDigits": 42, # Max length of DTMF digits. - }, - "loggingSettings": { # Define behaviors on logging. # Settings for logging. Settings for Dialogflow History, Contact Center messages, StackDriver logs, and speech logging. Exposed at the following levels: - Agent level. - "enableInteractionLogging": True or False, # If true, DF Interaction logging is currently enabled. - "enableStackdriverLogging": True or False, # If true, StackDriver logging is currently enabled. - }, - "speechSettings": { # Define behaviors of speech to text detection. # Settings for speech to text detection. Exposed at the following levels: - Agent level - Flow level - Page level - Parameter level - "endpointerSensitivity": 42, # Sensitivity of the speech model that detects the end of speech. Scale from 0 to 100. - "models": { # Mapping from language to Speech-to-Text model. The mapped Speech-to-Text model will be selected for requests from its corresponding language. For more information, see [Speech models](https://cloud.google.com/dialogflow/cx/docs/concept/speech-models). - "a_key": "A String", - }, - "noSpeechTimeout": "A String", # Timeout before detecting no speech. - "useTimeoutBasedEndpointing": True or False, # Use timeout based endpointing, interpreting endpointer sensitivy as seconds of timeout value. + "noSpeechTimeout": "A String", # Timeout before detecting no speech. + "useTimeoutBasedEndpointing": True or False, # Use timeout based endpointing, interpreting endpointer sensitivy as seconds of timeout value. }, }, "conditionalCases": [ # Conditional cases for this fulfillment. @@ -3093,6 +2215,13 @@

Method Details

"A String", ], }, + "toolCall": { # Represents a call of a specific tool's action with the specified inputs. # Returns the definition of a tool call that should be executed by the client. + "action": "A String", # Required. The name of the tool's action associated with this call. + "inputParameters": { # Optional. The action's input parameters. + "a_key": "", # Properties of the object. + }, + "tool": "A String", # Required. The tool associated with this call. Format: `projects//locations//agents//tools/`. + }, }, }, ], @@ -3149,6 +2278,13 @@

Method Details

"A String", ], }, + "toolCall": { # Represents a call of a specific tool's action with the specified inputs. # Returns the definition of a tool call that should be executed by the client. + "action": "A String", # Required. The name of the tool's action associated with this call. + "inputParameters": { # Optional. The action's input parameters. + "a_key": "", # Properties of the object. + }, + "tool": "A String", # Required. The tool associated with this call. Format: `projects//locations//agents//tools/`. + }, }, ], "returnPartialResponses": True or False, # Whether Dialogflow should return currently queued fulfillment response messages in streaming APIs. If a webhook is specified, it happens before Dialogflow invokes webhook. Warning: 1) This flag only affects streaming API. Responses are still queued and returned once in non-streaming API. 2) The flag can be enabled in any fulfillment but only the first 3 partial responses will be returned. You may only want to apply it to fulfillments that have slow webhooks. @@ -3162,522 +2298,382 @@

Method Details

"webhook": "A String", # The webhook to call. Format: `projects//locations//agents//webhooks/`. }, }, - ], - }, - "dataStoreConnectionSignals": { # Data store connection feature output signals. Might be only partially field if processing stop before the final answer. Reasons for this can be, but are not limited to: empty UCS search results, positive RAI check outcome, grounding failure, ... # Optional. Data store connection feature output signals. Filled only when data stores are involved in serving the query and DetectIntentRequest.populate data_store_connection_quality_signals is set to true in the request. - "answer": "A String", # Optional. The final compiled answer. - "answerGenerationModelCallSignals": { # Diagnostic info related to the answer generation model call. # Optional. Diagnostic info related to the answer generation model call. - "modelOutput": "A String", # Output of the generative model. - "renderedPrompt": "A String", # Prompt as sent to the model. - }, - "answerParts": [ # Optional. Answer parts with relevant citations. Concatenation of texts should add up the `answer` (not counting whitespaces). - { # Answer part with citation. - "supportingIndices": [ # Citations for this answer part. Indices of `search_snippets`. - 42, - ], - "text": "A String", # Substring of the answer. - }, - ], - "citedSnippets": [ # Optional. Snippets cited by the answer generation model from the most to least relevant. - { # Snippet cited by the answer generation model. - "searchSnippet": { # Search snippet details. # Details of the snippet. - "documentTitle": "A String", # Title of the enclosing document. - "documentUri": "A String", # Uri for the document. Present if specified for the document. - "text": "A String", # Text included in the prompt. - }, - "snippetIndex": 42, # Index of the snippet in `search_snippets` field. - }, - ], - "groundingSignals": { # Grounding signals. # Optional. Grounding signals. - "decision": "A String", # Represents the decision of the grounding check. - "score": "A String", # Grounding score bucket setting. - }, - "rewriterModelCallSignals": { # Diagnostic info related to the rewriter model call. # Optional. Diagnostic info related to the rewriter model call. - "modelOutput": "A String", # Output of the generative model. - "renderedPrompt": "A String", # Prompt as sent to the model. - }, - "rewrittenQuery": "A String", # Optional. Rewritten string query used for search. - "safetySignals": { # Safety check results. # Optional. Safety check result. - "bannedPhraseMatch": "A String", # Specifies banned phrase match subject. - "decision": "A String", # Safety decision. - "matchedBannedPhrase": "A String", # The matched banned phrase if there was a match. - }, - "searchSnippets": [ # Optional. Search snippets included in the answer generation prompt. - { # Search snippet details. - "documentTitle": "A String", # Title of the enclosing document. - "documentUri": "A String", # Uri for the document. Present if specified for the document. - "text": "A String", # Text included in the prompt. - }, - ], - }, - "diagnosticInfo": { # The free-form diagnostic info. For example, this field could contain webhook call latency. The fields of this data can change without notice, so you should not write code that depends on its structure. One of the fields is called "Alternative Matched Intents", which may aid with debugging. The following describes these intent results: - The list is empty if no intent was matched to end-user input. - Only intents that are referenced in the currently active flow are included. - The matched intent is included. - Other intents that could have matched end-user input, but did not match because they are referenced by intent routes that are out of [scope](https://cloud.google.com/dialogflow/cx/docs/concept/handler#scope), are included. - Other intents referenced by intent routes in scope that matched end-user input, but had a lower confidence score. - "a_key": "", # Properties of the object. - }, - "dtmf": { # Represents the input for dtmf event. # If a DTMF was provided as input, this field will contain a copy of the DtmfInput. - "digits": "A String", # The dtmf digits. - "finishDigit": "A String", # The finish digit (if any). - }, - "intent": { # An intent represents a user's intent to interact with a conversational agent. You can provide information for the Dialogflow API to use to match user input to an intent by adding training phrases (i.e., examples of user input) to your intent. # The Intent that matched the conversational query. Some, not all fields are filled in this message, including but not limited to: `name` and `display_name`. This field is deprecated, please use QueryResult.match instead. - "description": "A String", # Human readable description for better understanding an intent like its scope, content, result etc. Maximum character limit: 140 characters. - "displayName": "A String", # Required. The human-readable name of the intent, unique within the agent. - "isFallback": True or False, # Indicates whether this is a fallback intent. Currently only default fallback intent is allowed in the agent, which is added upon agent creation. Adding training phrases to fallback intent is useful in the case of requests that are mistakenly matched, since training phrases assigned to fallback intents act as negative examples that triggers no-match event. - "labels": { # The key/value metadata to label an intent. Labels can contain lowercase letters, digits and the symbols '-' and '_'. International characters are allowed, including letters from unicase alphabets. Keys must start with a letter. Keys and values can be no longer than 63 characters and no more than 128 bytes. Prefix "sys-" is reserved for Dialogflow defined labels. Currently allowed Dialogflow defined labels include: * sys-head * sys-contextual The above labels do not require value. "sys-head" means the intent is a head intent. "sys-contextual" means the intent is a contextual intent. - "a_key": "A String", - }, - "name": "A String", # The unique identifier of the intent. Required for the Intents.UpdateIntent method. Intents.CreateIntent populates the name automatically. Format: `projects//locations//agents//intents/`. - "parameters": [ # The collection of parameters associated with the intent. - { # Represents an intent parameter. - "entityType": "A String", # Required. The entity type of the parameter. Format: `projects/-/locations/-/agents/-/entityTypes/` for system entity types (for example, `projects/-/locations/-/agents/-/entityTypes/sys.date`), or `projects//locations//agents//entityTypes/` for developer entity types. - "id": "A String", # Required. The unique identifier of the parameter. This field is used by training phrases to annotate their parts. - "isList": True or False, # Indicates whether the parameter represents a list of values. - "redact": True or False, # Indicates whether the parameter content should be redacted in log. If redaction is enabled, the parameter content will be replaced by parameter name during logging. Note: the parameter content is subject to redaction if either parameter level redaction or entity type level redaction is enabled. - }, - ], - "priority": 42, # 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. - "trainingPhrases": [ # The collection of training phrases the agent is trained on to identify the intent. - { # Represents an example that the agent is trained on to identify the intent. - "id": "A String", # Output only. The unique identifier of the training phrase. - "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 `parameter_id` field is set. - { # Represents a part of a training phrase. - "parameterId": "A String", # The parameter used to annotate this part of the training phrase. This field is required for annotated parts of the training phrase. - "text": "A String", # Required. The text for this part. - }, - ], - "repeatCount": 42, # Indicates how many times this example was added to the intent. - }, - ], - }, - "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. This field is deprecated, please use QueryResult.match instead. - "languageCode": "A String", # The language that was triggered during intent detection. See [Language Support](https://cloud.google.com/dialogflow/cx/docs/reference/language) for a list of the currently supported language codes. - "match": { # Represents one match result of MatchIntent. # Intent match result, could be an intent or an event. - "confidence": 3.14, # The confidence of this match. 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. - "event": "A String", # The event that matched the query. Filled for `EVENT`, `NO_MATCH` and `NO_INPUT` match types. - "intent": { # An intent represents a user's intent to interact with a conversational agent. You can provide information for the Dialogflow API to use to match user input to an intent by adding training phrases (i.e., examples of user input) to your intent. # The Intent that matched the query. Some, not all fields are filled in this message, including but not limited to: `name` and `display_name`. Only filled for `INTENT` match type. - "description": "A String", # Human readable description for better understanding an intent like its scope, content, result etc. Maximum character limit: 140 characters. - "displayName": "A String", # Required. The human-readable name of the intent, unique within the agent. - "isFallback": True or False, # Indicates whether this is a fallback intent. Currently only default fallback intent is allowed in the agent, which is added upon agent creation. Adding training phrases to fallback intent is useful in the case of requests that are mistakenly matched, since training phrases assigned to fallback intents act as negative examples that triggers no-match event. - "labels": { # The key/value metadata to label an intent. Labels can contain lowercase letters, digits and the symbols '-' and '_'. International characters are allowed, including letters from unicase alphabets. Keys must start with a letter. Keys and values can be no longer than 63 characters and no more than 128 bytes. Prefix "sys-" is reserved for Dialogflow defined labels. Currently allowed Dialogflow defined labels include: * sys-head * sys-contextual The above labels do not require value. "sys-head" means the intent is a head intent. "sys-contextual" means the intent is a contextual intent. - "a_key": "A String", - }, - "name": "A String", # The unique identifier of the intent. Required for the Intents.UpdateIntent method. Intents.CreateIntent populates the name automatically. Format: `projects//locations//agents//intents/`. - "parameters": [ # The collection of parameters associated with the intent. - { # Represents an intent parameter. - "entityType": "A String", # Required. The entity type of the parameter. Format: `projects/-/locations/-/agents/-/entityTypes/` for system entity types (for example, `projects/-/locations/-/agents/-/entityTypes/sys.date`), or `projects//locations//agents//entityTypes/` for developer entity types. - "id": "A String", # Required. The unique identifier of the parameter. This field is used by training phrases to annotate their parts. - "isList": True or False, # Indicates whether the parameter represents a list of values. - "redact": True or False, # Indicates whether the parameter content should be redacted in log. If redaction is enabled, the parameter content will be replaced by parameter name during logging. Note: the parameter content is subject to redaction if either parameter level redaction or entity type level redaction is enabled. - }, + "name": "A String", # The unique identifier of the page. Required for the Pages.UpdatePage method. Pages.CreatePage populates the name automatically. Format: `projects//locations//agents//flows//pages/`. + "transitionRouteGroups": [ # Ordered list of `TransitionRouteGroups` added to the page. Transition route groups must be unique within a page. If the page links both flow-level transition route groups and agent-level transition route groups, the flow-level ones will have higher priority and will be put before the agent-level ones. * If multiple transition routes within a page scope refer to the same intent, then the precedence order is: page's transition route -> page's transition route group -> flow's transition routes. * If multiple transition route groups within a page contain the same intent, then the first group in the ordered list takes precedence. Format:`projects//locations//agents//flows//transitionRouteGroups/` or `projects//locations//agents//transitionRouteGroups/` for agent-level groups. + "A String", ], - "priority": 42, # 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. - "trainingPhrases": [ # The collection of training phrases the agent is trained on to identify the intent. - { # Represents an example that the agent is trained on to identify the intent. - "id": "A String", # Output only. The unique identifier of the training phrase. - "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 `parameter_id` field is set. - { # Represents a part of a training phrase. - "parameterId": "A String", # The parameter used to annotate this part of the training phrase. This field is required for annotated parts of the training phrase. - "text": "A String", # Required. The text for this part. + "transitionRoutes": [ # A list of transitions for the transition rules of this page. They route the conversation to another page in the same flow, or another flow. When we are in a certain page, the TransitionRoutes are evalauted in the following order: * TransitionRoutes defined in the page with intent specified. * TransitionRoutes defined in the transition route groups with intent specified. * TransitionRoutes defined in flow with intent specified. * TransitionRoutes defined in the transition route groups with intent specified. * TransitionRoutes defined in the page with only condition specified. * TransitionRoutes defined in the transition route groups with only condition specified. + { # A transition route specifies a intent that can be matched and/or a data condition that can be evaluated during a session. When a specified transition is matched, the following actions are taken in order: * If there is a `trigger_fulfillment` associated with the transition, it will be called. * If there is a `target_page` associated with the transition, the session will transition into the specified page. * If there is a `target_flow` associated with the transition, the session will transition into the specified flow. + "condition": "A String", # The condition to evaluate against form parameters or session parameters. See the [conditions reference](https://cloud.google.com/dialogflow/cx/docs/reference/condition). At least one of `intent` or `condition` must be specified. When both `intent` and `condition` are specified, the transition can only happen when both are fulfilled. + "description": "A String", # Optional. The description of the transition route. The maximum length is 500 characters. + "intent": "A String", # The unique identifier of an Intent. Format: `projects//locations//agents//intents/`. Indicates that the transition can only happen when the given intent is matched. At least one of `intent` or `condition` must be specified. When both `intent` and `condition` are specified, the transition can only happen when both are fulfilled. + "name": "A String", # Output only. The unique identifier of this transition route. + "targetFlow": "A String", # The target flow to transition to. Format: `projects//locations//agents//flows/`. + "targetPage": "A String", # The target page to transition to. Format: `projects//locations//agents//flows//pages/`. + "triggerFulfillment": { # A fulfillment can do one or more of the following actions at the same time: * Generate rich message responses. * Set parameter values. * Call the webhook. Fulfillments can be called at various stages in the Page or Form lifecycle. For example, when a DetectIntentRequest drives a session to enter a new page, the page's entry fulfillment can add a static response to the QueryResult in the returning DetectIntentResponse, call the webhook (for example, to load user data from a database), or both. # The fulfillment to call when the condition is satisfied. At least one of `trigger_fulfillment` and `target` must be specified. When both are defined, `trigger_fulfillment` is executed first. + "advancedSettings": { # Hierarchical advanced settings for agent/flow/page/fulfillment/parameter. Settings exposed at lower level overrides the settings exposed at higher level. Overriding occurs at the sub-setting level. For example, the playback_interruption_settings at fulfillment level only overrides the playback_interruption_settings at the agent level, leaving other settings at the agent level unchanged. DTMF settings does not override each other. DTMF settings set at different levels define DTMF detections running in parallel. Hierarchy: Agent->Flow->Page->Fulfillment/Parameter. # Hierarchical advanced settings for this fulfillment. The settings exposed at the lower level overrides the settings exposed at the higher level. + "audioExportGcsDestination": { # Google Cloud Storage location for a Dialogflow operation that writes or exports objects (e.g. exported agent or transcripts) outside of Dialogflow. # If present, incoming audio is exported by Dialogflow to the configured Google Cloud Storage destination. Exposed at the following levels: - Agent level - Flow level + "uri": "A String", # Required. The Google Cloud Storage URI for the exported objects. A URI is of the form: `gs://bucket/object-name-or-prefix` Whether a full object name, or just a prefix, its usage depends on the Dialogflow operation. + }, + "dtmfSettings": { # Define behaviors for DTMF (dual tone multi frequency). # Settings for DTMF. Exposed at the following levels: - Agent level - Flow level - Page level - Parameter level. + "enabled": True or False, # If true, incoming audio is processed for DTMF (dual tone multi frequency) events. For example, if the caller presses a button on their telephone keypad and DTMF processing is enabled, Dialogflow will detect the event (e.g. a "3" was pressed) in the incoming audio and pass the event to the bot to drive business logic (e.g. when 3 is pressed, return the account balance). + "endpointingTimeoutDuration": "A String", # Endpoint timeout setting for matching dtmf input to regex. + "finishDigit": "A String", # The digit that terminates a DTMF digit sequence. + "interdigitTimeoutDuration": "A String", # Interdigit timeout setting for matching dtmf input to regex. + "maxDigits": 42, # Max length of DTMF digits. + }, + "loggingSettings": { # Define behaviors on logging. # Settings for logging. Settings for Dialogflow History, Contact Center messages, StackDriver logs, and speech logging. Exposed at the following levels: - Agent level. + "enableInteractionLogging": True or False, # Enables DF Interaction logging. + "enableStackdriverLogging": True or False, # Enables StackDriver logging. + }, + "speechSettings": { # Define behaviors of speech to text detection. # Settings for speech to text detection. Exposed at the following levels: - Agent level - Flow level - Page level - Parameter level + "endpointerSensitivity": 42, # Sensitivity of the speech model that detects the end of speech. Scale from 0 to 100. + "models": { # Mapping from language to Speech-to-Text model. The mapped Speech-to-Text model will be selected for requests from its corresponding language. For more information, see [Speech models](https://cloud.google.com/dialogflow/cx/docs/concept/speech-models). + "a_key": "A String", + }, + "noSpeechTimeout": "A String", # Timeout before detecting no speech. + "useTimeoutBasedEndpointing": True or False, # Use timeout based endpointing, interpreting endpointer sensitivy as seconds of timeout value. + }, }, - ], - "repeatCount": 42, # Indicates how many times this example was added to the intent. - }, - ], - }, - "matchType": "A String", # Type of this Match. - "parameters": { # The collection of parameters extracted from the query. 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 then use map, otherwise, depending on the parameter value type, it could be one of string, number, boolean, null, list or map. * MapValue value: If parameter's entity type is a composite entity then use map from composite entity property names to property values, otherwise, use parameter value. - "a_key": "", # Properties of the object. - }, - "resolvedInput": "A String", # Final text input which was matched during MatchIntent. This value can be different from original input sent in request because of spelling correction or other processing. - }, - "parameters": { # The collected session 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 then use map, otherwise, depending on the parameter value type, it could be one of string, number, boolean, null, list or map. * MapValue value: If parameter's entity type is a composite entity then use map from composite entity property names to property values, otherwise, use parameter value. - "a_key": "", # Properties of the object. - }, - "responseMessages": [ # The list of rich messages returned to the client. Responses vary from simple text messages to more sophisticated, structured payloads used to drive complex logic. - { # 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. - "channel": "A String", # The channel which the response is associated with. Clients can specify the channel via QueryParameters.channel, and only associated channel response will be returned. - "conversationSuccess": { # 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. # Indicates that the conversation succeeded. - "metadata": { # Custom metadata. Dialogflow doesn't impose any structure on this. - "a_key": "", # Properties of the object. - }, - }, - "endInteraction": { # 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. # Output only. A signal that indicates the interaction with the Dialogflow agent has ended. This message is generated by Dialogflow only when the conversation reaches `END_SESSION` page. It is not supposed to be defined by the user. It's guaranteed that there is at most one such message in each response. - }, - "knowledgeInfoCard": { # Represents info card response. If the response contains generative knowledge prediction, Dialogflow will return a payload with Infobot Messenger compatible info card. Otherwise, the info card response is skipped. # Represents info card for knowledge answers, to be better rendered in Dialogflow Messenger. - }, - "liveAgentHandoff": { # 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. # Hands off conversation to a human agent. - "metadata": { # Custom metadata for your handoff procedure. Dialogflow doesn't impose any structure on this. - "a_key": "", # Properties of the object. - }, - }, - "mixedAudio": { # 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. # Output only. An audio response message composed of both the synthesized Dialogflow agent responses and responses defined via play_audio. This message is generated by Dialogflow only and not supposed to be defined by the user. - "segments": [ # Segments this audio response is composed of. - { # Represents one segment of audio. - "allowPlaybackInterruption": True or False, # 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. - "audio": "A String", # Raw audio synthesized from the Dialogflow agent's response using the output config specified in the request. - "uri": "A String", # Client-specific URI that points to an audio clip accessible to the client. Dialogflow does not impose any validation on it. + "conditionalCases": [ # Conditional cases for this fulfillment. + { # A list of cascading if-else conditions. Cases are mutually exclusive. The first one with a matching condition is selected, all the rest ignored. + "cases": [ # A list of cascading if-else conditions. + { # Each case has a Boolean condition. When it is evaluated to be True, the corresponding messages will be selected and evaluated recursively. + "caseContent": [ # A list of case content. + { # The list of messages or conditional cases to activate for this case. + "additionalCases": # Object with schema name: GoogleCloudDialogflowCxV3beta1FulfillmentConditionalCases # Additional cases to be evaluated. + "message": { # 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. # Returned message. + "channel": "A String", # The channel which the response is associated with. Clients can specify the channel via QueryParameters.channel, and only associated channel response will be returned. + "conversationSuccess": { # 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. # Indicates that the conversation succeeded. + "metadata": { # Custom metadata. Dialogflow doesn't impose any structure on this. + "a_key": "", # Properties of the object. + }, + }, + "endInteraction": { # 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. # Output only. A signal that indicates the interaction with the Dialogflow agent has ended. This message is generated by Dialogflow only when the conversation reaches `END_SESSION` page. It is not supposed to be defined by the user. It's guaranteed that there is at most one such message in each response. + }, + "knowledgeInfoCard": { # Represents info card response. If the response contains generative knowledge prediction, Dialogflow will return a payload with Infobot Messenger compatible info card. Otherwise, the info card response is skipped. # Represents info card for knowledge answers, to be better rendered in Dialogflow Messenger. + }, + "liveAgentHandoff": { # 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. # Hands off conversation to a human agent. + "metadata": { # Custom metadata for your handoff procedure. Dialogflow doesn't impose any structure on this. + "a_key": "", # Properties of the object. + }, + }, + "mixedAudio": { # 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. # Output only. An audio response message composed of both the synthesized Dialogflow agent responses and responses defined via play_audio. This message is generated by Dialogflow only and not supposed to be defined by the user. + "segments": [ # Segments this audio response is composed of. + { # Represents one segment of audio. + "allowPlaybackInterruption": True or False, # 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. + "audio": "A String", # Raw audio synthesized from the Dialogflow agent's response using the output config specified in the request. + "uri": "A String", # Client-specific URI that points to an audio clip accessible to the client. Dialogflow does not impose any validation on it. + }, + ], + }, + "outputAudioText": { # A text or ssml response that is preferentially used for TTS output audio synthesis, as described in the comment on the ResponseMessage message. # A text or ssml response that is preferentially used for TTS output audio synthesis, as described in the comment on the ResponseMessage message. + "allowPlaybackInterruption": True or False, # 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. + "ssml": "A String", # The SSML text to be synthesized. For more information, see [SSML](/speech/text-to-speech/docs/ssml). + "text": "A String", # The raw text to be synthesized. + }, + "payload": { # Returns a response containing a custom, platform-specific payload. + "a_key": "", # Properties of the object. + }, + "playAudio": { # Specifies an audio clip to be played by the client as part of the response. # Signal that the client should play an audio clip hosted at a client-specific URI. Dialogflow uses this to construct mixed_audio. However, Dialogflow itself does not try to read or process the URI in any way. + "allowPlaybackInterruption": True or False, # 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. + "audioUri": "A String", # Required. URI of the audio clip. Dialogflow does not impose any validation on this value. It is specific to the client that reads it. + }, + "telephonyTransferCall": { # Represents the signal that telles the client to transfer the phone call connected to the agent to a third-party endpoint. # A signal that the client should transfer the phone call connected to this agent to a third-party endpoint. + "phoneNumber": "A String", # Transfer the call to a phone number in [E.164 format](https://en.wikipedia.org/wiki/E.164). + }, + "text": { # The text response message. # Returns a text response. + "allowPlaybackInterruption": True or False, # 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. + "text": [ # Required. A collection of text responses. + "A String", + ], + }, + "toolCall": { # Represents a call of a specific tool's action with the specified inputs. # Returns the definition of a tool call that should be executed by the client. + "action": "A String", # Required. The name of the tool's action associated with this call. + "inputParameters": { # Optional. The action's input parameters. + "a_key": "", # Properties of the object. + }, + "tool": "A String", # Required. The tool associated with this call. Format: `projects//locations//agents//tools/`. + }, + }, + }, + ], + "condition": "A String", # The condition to activate and select this case. Empty means the condition is always true. The condition is evaluated against form parameters or session parameters. See the [conditions reference](https://cloud.google.com/dialogflow/cx/docs/reference/condition). + }, + ], + }, + ], + "enableGenerativeFallback": True or False, # If the flag is true, the agent will utilize LLM to generate a text response. If LLM generation fails, the defined responses in the fulfillment will be respected. This flag is only useful for fulfillments associated with no-match event handlers. + "messages": [ # The list of rich message responses to present to the user. + { # 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. + "channel": "A String", # The channel which the response is associated with. Clients can specify the channel via QueryParameters.channel, and only associated channel response will be returned. + "conversationSuccess": { # 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. # Indicates that the conversation succeeded. + "metadata": { # Custom metadata. Dialogflow doesn't impose any structure on this. + "a_key": "", # Properties of the object. + }, + }, + "endInteraction": { # 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. # Output only. A signal that indicates the interaction with the Dialogflow agent has ended. This message is generated by Dialogflow only when the conversation reaches `END_SESSION` page. It is not supposed to be defined by the user. It's guaranteed that there is at most one such message in each response. + }, + "knowledgeInfoCard": { # Represents info card response. If the response contains generative knowledge prediction, Dialogflow will return a payload with Infobot Messenger compatible info card. Otherwise, the info card response is skipped. # Represents info card for knowledge answers, to be better rendered in Dialogflow Messenger. + }, + "liveAgentHandoff": { # 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. # Hands off conversation to a human agent. + "metadata": { # Custom metadata for your handoff procedure. Dialogflow doesn't impose any structure on this. + "a_key": "", # Properties of the object. + }, + }, + "mixedAudio": { # 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. # Output only. An audio response message composed of both the synthesized Dialogflow agent responses and responses defined via play_audio. This message is generated by Dialogflow only and not supposed to be defined by the user. + "segments": [ # Segments this audio response is composed of. + { # Represents one segment of audio. + "allowPlaybackInterruption": True or False, # 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. + "audio": "A String", # Raw audio synthesized from the Dialogflow agent's response using the output config specified in the request. + "uri": "A String", # Client-specific URI that points to an audio clip accessible to the client. Dialogflow does not impose any validation on it. + }, + ], + }, + "outputAudioText": { # A text or ssml response that is preferentially used for TTS output audio synthesis, as described in the comment on the ResponseMessage message. # A text or ssml response that is preferentially used for TTS output audio synthesis, as described in the comment on the ResponseMessage message. + "allowPlaybackInterruption": True or False, # 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. + "ssml": "A String", # The SSML text to be synthesized. For more information, see [SSML](/speech/text-to-speech/docs/ssml). + "text": "A String", # The raw text to be synthesized. + }, + "payload": { # Returns a response containing a custom, platform-specific payload. + "a_key": "", # Properties of the object. + }, + "playAudio": { # Specifies an audio clip to be played by the client as part of the response. # Signal that the client should play an audio clip hosted at a client-specific URI. Dialogflow uses this to construct mixed_audio. However, Dialogflow itself does not try to read or process the URI in any way. + "allowPlaybackInterruption": True or False, # 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. + "audioUri": "A String", # Required. URI of the audio clip. Dialogflow does not impose any validation on this value. It is specific to the client that reads it. + }, + "telephonyTransferCall": { # Represents the signal that telles the client to transfer the phone call connected to the agent to a third-party endpoint. # A signal that the client should transfer the phone call connected to this agent to a third-party endpoint. + "phoneNumber": "A String", # Transfer the call to a phone number in [E.164 format](https://en.wikipedia.org/wiki/E.164). + }, + "text": { # The text response message. # Returns a text response. + "allowPlaybackInterruption": True or False, # 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. + "text": [ # Required. A collection of text responses. + "A String", + ], + }, + "toolCall": { # Represents a call of a specific tool's action with the specified inputs. # Returns the definition of a tool call that should be executed by the client. + "action": "A String", # Required. The name of the tool's action associated with this call. + "inputParameters": { # Optional. The action's input parameters. + "a_key": "", # Properties of the object. + }, + "tool": "A String", # Required. The tool associated with this call. Format: `projects//locations//agents//tools/`. + }, + }, + ], + "returnPartialResponses": True or False, # Whether Dialogflow should return currently queued fulfillment response messages in streaming APIs. If a webhook is specified, it happens before Dialogflow invokes webhook. Warning: 1) This flag only affects streaming API. Responses are still queued and returned once in non-streaming API. 2) The flag can be enabled in any fulfillment but only the first 3 partial responses will be returned. You may only want to apply it to fulfillments that have slow webhooks. + "setParameterActions": [ # Set parameter values before executing the webhook. + { # Setting a parameter value. + "parameter": "A String", # Display name of the parameter. + "value": "", # The new value of the parameter. A null value clears the parameter. + }, + ], + "tag": "A String", # The value of this field will be populated in the WebhookRequest `fulfillmentInfo.tag` field by Dialogflow when the associated webhook is called. The tag is typically used by the webhook service to identify which fulfillment is being called, but it could be used for other purposes. This field is required if `webhook` is specified. + "webhook": "A String", # The webhook to call. Format: `projects//locations//agents//webhooks/`. }, - ], - }, - "outputAudioText": { # A text or ssml response that is preferentially used for TTS output audio synthesis, as described in the comment on the ResponseMessage message. # A text or ssml response that is preferentially used for TTS output audio synthesis, as described in the comment on the ResponseMessage message. - "allowPlaybackInterruption": True or False, # 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. - "ssml": "A String", # The SSML text to be synthesized. For more information, see [SSML](/speech/text-to-speech/docs/ssml). - "text": "A String", # The raw text to be synthesized. - }, - "payload": { # Returns a response containing a custom, platform-specific payload. - "a_key": "", # Properties of the object. + }, + ], + }, + "dataStoreConnectionSignals": { # Data store connection feature output signals. Might be only partially field if processing stop before the final answer. Reasons for this can be, but are not limited to: empty UCS search results, positive RAI check outcome, grounding failure, ... # Optional. Data store connection feature output signals. Filled only when data stores are involved in serving the query and DetectIntentRequest.populate data_store_connection_quality_signals is set to true in the request. + "answer": "A String", # Optional. The final compiled answer. + "answerGenerationModelCallSignals": { # Diagnostic info related to the answer generation model call. # Optional. Diagnostic info related to the answer generation model call. + "modelOutput": "A String", # Output of the generative model. + "renderedPrompt": "A String", # Prompt as sent to the model. }, - "playAudio": { # Specifies an audio clip to be played by the client as part of the response. # Signal that the client should play an audio clip hosted at a client-specific URI. Dialogflow uses this to construct mixed_audio. However, Dialogflow itself does not try to read or process the URI in any way. - "allowPlaybackInterruption": True or False, # 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. - "audioUri": "A String", # Required. URI of the audio clip. Dialogflow does not impose any validation on this value. It is specific to the client that reads it. + "answerParts": [ # Optional. Answer parts with relevant citations. Concatenation of texts should add up the `answer` (not counting whitespaces). + { # Answer part with citation. + "supportingIndices": [ # Citations for this answer part. Indices of `search_snippets`. + 42, + ], + "text": "A String", # Substring of the answer. + }, + ], + "citedSnippets": [ # Optional. Snippets cited by the answer generation model from the most to least relevant. + { # Snippet cited by the answer generation model. + "searchSnippet": { # Search snippet details. # Details of the snippet. + "documentTitle": "A String", # Title of the enclosing document. + "documentUri": "A String", # Uri for the document. Present if specified for the document. + "text": "A String", # Text included in the prompt. + }, + "snippetIndex": 42, # Index of the snippet in `search_snippets` field. + }, + ], + "groundingSignals": { # Grounding signals. # Optional. Grounding signals. + "decision": "A String", # Represents the decision of the grounding check. + "score": "A String", # Grounding score bucket setting. }, - "telephonyTransferCall": { # Represents the signal that telles the client to transfer the phone call connected to the agent to a third-party endpoint. # A signal that the client should transfer the phone call connected to this agent to a third-party endpoint. - "phoneNumber": "A String", # Transfer the call to a phone number in [E.164 format](https://en.wikipedia.org/wiki/E.164). + "rewriterModelCallSignals": { # Diagnostic info related to the rewriter model call. # Optional. Diagnostic info related to the rewriter model call. + "modelOutput": "A String", # Output of the generative model. + "renderedPrompt": "A String", # Prompt as sent to the model. }, - "text": { # The text response message. # Returns a text response. - "allowPlaybackInterruption": True or False, # 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. - "text": [ # Required. A collection of text responses. - "A String", - ], + "rewrittenQuery": "A String", # Optional. Rewritten string query used for search. + "safetySignals": { # Safety check results. # Optional. Safety check result. + "bannedPhraseMatch": "A String", # Specifies banned phrase match subject. + "decision": "A String", # Safety decision. + "matchedBannedPhrase": "A String", # The matched banned phrase if there was a match. }, + "searchSnippets": [ # Optional. Search snippets included in the answer generation prompt. + { # Search snippet details. + "documentTitle": "A String", # Title of the enclosing document. + "documentUri": "A String", # Uri for the document. Present if specified for the document. + "text": "A String", # Text included in the prompt. + }, + ], }, - ], - "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. # The sentiment analyss result, which depends on `analyze_query_text_sentiment`, specified in the request. - "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). - "score": 3.14, # Sentiment score between -1.0 (negative sentiment) and 1.0 (positive sentiment). - }, - "text": "A String", # If natural language text was provided as input, this field will contain a copy of the text. - "transcript": "A String", # If natural language speech audio was provided as input, this field will contain the transcript for the audio. - "triggerEvent": "A String", # If an event was provided as input, this field will contain the name of the event. - "triggerIntent": "A String", # If an intent was provided as input, this field will contain a copy of the intent identifier. Format: `projects//locations//agents//intents/`. - "webhookDisplayNames": [ # The list of webhook display names in the order of call sequence. - "A String", - ], - "webhookIds": [ # The list of webhook ids in the order of call sequence. - "A String", - ], - "webhookLatencies": [ # The list of webhook latencies in the order of call sequence. - "A String", - ], - "webhookPayloads": [ # The list of webhook payload in WebhookResponse.payload, in the order of call sequence. If some webhook call fails or doesn't return any payload, an empty `Struct` would be used instead. - { + "diagnosticInfo": { # The free-form diagnostic info. For example, this field could contain webhook call latency. The fields of this data can change without notice, so you should not write code that depends on its structure. One of the fields is called "Alternative Matched Intents", which may aid with debugging. The following describes these intent results: - The list is empty if no intent was matched to end-user input. - Only intents that are referenced in the currently active flow are included. - The matched intent is included. - Other intents that could have matched end-user input, but did not match because they are referenced by intent routes that are out of [scope](https://cloud.google.com/dialogflow/cx/docs/concept/handler#scope), are included. - Other intents referenced by intent routes in scope that matched end-user input, but had a lower confidence score. "a_key": "", # Properties of the object. }, - ], - "webhookStatuses": [ # The list of webhook call status in the order of call sequence. - { # 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). - "code": 42, # The status code, which should be an enum value of google.rpc.Code. - "details": [ # A list of messages that carry the error details. There is a common set of message types for APIs to use. - { - "a_key": "", # Properties of the object. Contains field @type with type URL. + "dtmf": { # Represents the input for dtmf event. # If a DTMF was provided as input, this field will contain a copy of the DtmfInput. + "digits": "A String", # The dtmf digits. + "finishDigit": "A String", # The finish digit (if any). + }, + "generativeInfo": { # Represents the information of a query if handled by generative agent resources. # The information of a query if handled by generative agent resources. + "actionTracingInfo": { # Example represents a sample execution of the playbook in the conversation. An example consists of a list of ordered actions performed by end user or Dialogflow agent according the playbook instructions to fulfill the task. # The actions performed by the generative playbook for the current agent response. + "actions": [ # Required. The ordered list of actions performed by the end user and the Dialogflow agent. + { # Action performed by end user or Dialogflow agent in the conversation. + "agentUtterance": { # AgentUtterance represents one message sent by the agent. # Optional. Action performed by the agent as a message. + "text": "A String", # Required. Message content in text. + }, + "flowInvocation": { # Stores metadata of the invocation of a CX flow. Next Id: 7 # Optional. Action performed on behalf of the agent by invoking a CX flow. + "flow": "A String", # Required. The unique identifier of the flow. Format: `projects//locations//agents/`. + "flowState": "A String", # Required. Flow invocation's output state. + "inputActionParameters": { # Optional. A list of input parameters for the flow. + "a_key": "", # Properties of the object. + }, + "outputActionParameters": { # Optional. A list of output parameters generated by the flow invocation. + "a_key": "", # Properties of the object. + }, + }, + "playbookInvocation": { # Stores metadata of the invocation of a child playbook. Next Id: 5 # Optional. Action performed on behalf of the agent by invoking a child playbook. + "playbook": "A String", # Required. The unique identifier of the playbook. Format: `projects//locations//agents//playbooks/`. + "playbookInput": { # Input of the playbook. # Optional. Input of the child playbook invocation. + "actionParameters": { # Optional. A list of input parameters for the action. + "a_key": "", # Properties of the object. + }, + "precedingConversationSummary": "A String", # Optional. Summary string of the preceding conversation for the child playbook invocation. + }, + "playbookOutput": { # Output of the playbook. # Optional. Output of the child playbook invocation. + "actionParameters": { # Optional. A Struct object of output parameters for the action. + "a_key": "", # Properties of the object. + }, + "executionSummary": "A String", # Optional. Summary string of the execution result of the child playbook. + }, + "playbookState": "A String", # Required. Playbook invocation's output state. + }, + "toolUse": { # Stores metadata of the invocation of an action supported by a tool. # Optional. Action performed on behalf of the agent by calling a plugin tool. + "action": "A String", # Optional. Name of the action to be called during the tool use. + "inputActionParameters": { # Optional. A list of input parameters for the action. + "a_key": "", # Properties of the object. + }, + "outputActionParameters": { # Optional. A list of output parameters generated by the action. + "a_key": "", # Properties of the object. + }, + "tool": "A String", # Required. The tool that should be used. Format: `projects//locations//agents//tools/`. + }, + "userUtterance": { # UserUtterance represents one message sent by the customer. # Optional. Agent obtained a message from the customer. + "text": "A String", # Required. Message content in text. + }, + }, + ], + "conversationState": "A String", # Required. Example's output state. + "createTime": "A String", # Output only. The timestamp of initial example creation. + "description": "A String", # Optional. The high level concise description of the example. The max number of characters is 200. + "displayName": "A String", # Required. The display name of the example. + "languageCode": "A String", # Optional. The language code of the example. If not specified, the agent's default language is used. Note: languages must be enabled in the agent before they can be used. + "name": "A String", # The unique identifier of the playbook example. Format: `projects//locations//agents//playbooks//examples/`. + "playbookInput": { # Input of the playbook. # Optional. The input to the playbook in the example. + "actionParameters": { # Optional. A list of input parameters for the action. + "a_key": "", # Properties of the object. + }, + "precedingConversationSummary": "A String", # Optional. Summary string of the preceding conversation for the child playbook invocation. + }, + "playbookOutput": { # Output of the playbook. # Optional. The output of the playbook in the example. + "actionParameters": { # Optional. A Struct object of output parameters for the action. + "a_key": "", # Properties of the object. + }, + "executionSummary": "A String", # Optional. Summary string of the execution result of the child playbook. }, + "tokenCount": "A String", # Output only. Estimated number of tokes current example takes when sent to the LLM. + "updateTime": "A String", # Output only. Last time the example was updated. + }, + "currentPlaybooks": [ # The stack of playbooks that the conversation has currently entered, with the most recent one on the top. + "A String", ], - "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. }, - ], - "webhookTags": [ # The list of webhook tags in the order of call sequence. - "A String", - ], - }, - "responseId": "A String", # Output only. The unique identifier of the response. It can be used to locate a response in the training example set or for reporting issues. - "responseType": "A String", # Response type. - }, - "responseUtterances": "A String", # The output text or the transcript of the output audio in the responses. If multiple output messages are returned, they will be concatenated into one. - }, - ], - "languageCode": "A String", # The language of the conversation, which is the language of the first request in the conversation. - "metrics": { # Represents metrics for the conversation. # Conversation metrics. - "averageMatchConfidence": 3.14, # The average confidence all of the Match in the conversation. Values range from 0.0 (completely uncertain) to 1.0 (completely certain). - "hasEndInteraction": True or False, # A signal that indicates the interaction with the Dialogflow agent has ended. If any response has the ResponseMessage.end_interaction signal, this is set to true. - "hasLiveAgentHandoff": True or False, # Hands off conversation to a human agent. If any response has the ResponseMessage.live_agent_handoffsignal, this is set to true. - "inputAudioDuration": "A String", # Duration of all the input's audio in the conversation. - "interactionCount": 42, # The number of interactions in the conversation. - "matchTypeCount": { # Count by Match.MatchType of the matches in the conversation. # Match type counts. - "directIntentCount": 42, # The number of matches with type Match.MatchType.DIRECT_INTENT. - "eventCount": 42, # The number of matches with type Match.MatchType.EVENT. - "intentCount": 42, # The number of matches with type Match.MatchType.INTENT. - "noInputCount": 42, # The number of matches with type Match.MatchType.NO_INPUT. - "noMatchCount": 42, # The number of matches with type Match.MatchType.NO_MATCH. - "parameterFillingCount": 42, # The number of matches with type Match.MatchType.PARAMETER_FILLING. - "unspecifiedCount": 42, # The number of matches with type Match.MatchType.MATCH_TYPE_UNSPECIFIED. - }, - "maxWebhookLatency": "A String", # Maximum latency of the Webhook calls in the conversation. - "outputAudioDuration": "A String", # Duration of all the output's audio in the conversation. - "queryInputCount": { # Count by types of QueryInput of the requests in the conversation. # Query input counts. - "audioCount": 42, # The number of AudioInput in the conversation. - "dtmfCount": 42, # The number of DtmfInput in the conversation. - "eventCount": 42, # The number of EventInput in the conversation. - "intentCount": 42, # The number of IntentInput in the conversation. - "textCount": 42, # The number of TextInput in the conversation. - }, - }, - "name": "A String", # Identifier. The identifier of the conversation. If conversation ID is reused, interactions happened later than 48 hours of the conversation's create time will be ignored. Format: `projects//locations//agents//conversations/` - "pages": [ # All the Page the conversation has went through. Only `name` and `display_name` are filled in this message. - { # A Dialogflow CX conversation (session) can be described and visualized as a state machine. The states of a CX session are represented by pages. For each flow, you define many pages, where your combined pages can handle a complete conversation on the topics the flow is designed for. At any given moment, exactly one page is the current page, the current page is considered active, and the flow associated with that page is considered active. Every flow has a special start page. When a flow initially becomes active, the start page page becomes the current page. For each conversational turn, the current page will either stay the same or transition to another page. You configure each page to collect information from the end-user that is relevant for the conversational state represented by the page. For more information, see the [Page guide](https://cloud.google.com/dialogflow/cx/docs/concept/page). - "advancedSettings": { # Hierarchical advanced settings for agent/flow/page/fulfillment/parameter. Settings exposed at lower level overrides the settings exposed at higher level. Overriding occurs at the sub-setting level. For example, the playback_interruption_settings at fulfillment level only overrides the playback_interruption_settings at the agent level, leaving other settings at the agent level unchanged. DTMF settings does not override each other. DTMF settings set at different levels define DTMF detections running in parallel. Hierarchy: Agent->Flow->Page->Fulfillment/Parameter. # Hierarchical advanced settings for this page. The settings exposed at the lower level overrides the settings exposed at the higher level. - "audioExportGcsDestination": { # Google Cloud Storage location for a Dialogflow operation that writes or exports objects (e.g. exported agent or transcripts) outside of Dialogflow. # If present, incoming audio is exported by Dialogflow to the configured Google Cloud Storage destination. Exposed at the following levels: - Agent level - Flow level - "uri": "A String", # Required. The Google Cloud Storage URI for the exported objects. A URI is of the form: `gs://bucket/object-name-or-prefix` Whether a full object name, or just a prefix, its usage depends on the Dialogflow operation. - }, - "dtmfSettings": { # Define behaviors for DTMF (dual tone multi frequency). # Settings for DTMF. Exposed at the following levels: - Agent level - Flow level - Page level - Parameter level. - "enabled": True or False, # If true, incoming audio is processed for DTMF (dual tone multi frequency) events. For example, if the caller presses a button on their telephone keypad and DTMF processing is enabled, Dialogflow will detect the event (e.g. a "3" was pressed) in the incoming audio and pass the event to the bot to drive business logic (e.g. when 3 is pressed, return the account balance). - "endpointingTimeoutDuration": "A String", # Endpoint timeout setting for matching dtmf input to regex. - "finishDigit": "A String", # The digit that terminates a DTMF digit sequence. - "interdigitTimeoutDuration": "A String", # Interdigit timeout setting for matching dtmf input to regex. - "maxDigits": 42, # Max length of DTMF digits. - }, - "loggingSettings": { # Define behaviors on logging. # Settings for logging. Settings for Dialogflow History, Contact Center messages, StackDriver logs, and speech logging. Exposed at the following levels: - Agent level. - "enableInteractionLogging": True or False, # If true, DF Interaction logging is currently enabled. - "enableStackdriverLogging": True or False, # If true, StackDriver logging is currently enabled. - }, - "speechSettings": { # Define behaviors of speech to text detection. # Settings for speech to text detection. Exposed at the following levels: - Agent level - Flow level - Page level - Parameter level - "endpointerSensitivity": 42, # Sensitivity of the speech model that detects the end of speech. Scale from 0 to 100. - "models": { # Mapping from language to Speech-to-Text model. The mapped Speech-to-Text model will be selected for requests from its corresponding language. For more information, see [Speech models](https://cloud.google.com/dialogflow/cx/docs/concept/speech-models). - "a_key": "A String", - }, - "noSpeechTimeout": "A String", # Timeout before detecting no speech. - "useTimeoutBasedEndpointing": True or False, # Use timeout based endpointing, interpreting endpointer sensitivy as seconds of timeout value. - }, - }, - "description": "A String", # The description of the page. The maximum length is 500 characters. - "displayName": "A String", # Required. The human-readable name of the page, unique within the flow. - "entryFulfillment": { # A fulfillment can do one or more of the following actions at the same time: * Generate rich message responses. * Set parameter values. * Call the webhook. Fulfillments can be called at various stages in the Page or Form lifecycle. For example, when a DetectIntentRequest drives a session to enter a new page, the page's entry fulfillment can add a static response to the QueryResult in the returning DetectIntentResponse, call the webhook (for example, to load user data from a database), or both. # The fulfillment to call when the session is entering the page. - "advancedSettings": { # Hierarchical advanced settings for agent/flow/page/fulfillment/parameter. Settings exposed at lower level overrides the settings exposed at higher level. Overriding occurs at the sub-setting level. For example, the playback_interruption_settings at fulfillment level only overrides the playback_interruption_settings at the agent level, leaving other settings at the agent level unchanged. DTMF settings does not override each other. DTMF settings set at different levels define DTMF detections running in parallel. Hierarchy: Agent->Flow->Page->Fulfillment/Parameter. # Hierarchical advanced settings for this fulfillment. The settings exposed at the lower level overrides the settings exposed at the higher level. - "audioExportGcsDestination": { # Google Cloud Storage location for a Dialogflow operation that writes or exports objects (e.g. exported agent or transcripts) outside of Dialogflow. # If present, incoming audio is exported by Dialogflow to the configured Google Cloud Storage destination. Exposed at the following levels: - Agent level - Flow level - "uri": "A String", # Required. The Google Cloud Storage URI for the exported objects. A URI is of the form: `gs://bucket/object-name-or-prefix` Whether a full object name, or just a prefix, its usage depends on the Dialogflow operation. - }, - "dtmfSettings": { # Define behaviors for DTMF (dual tone multi frequency). # Settings for DTMF. Exposed at the following levels: - Agent level - Flow level - Page level - Parameter level. - "enabled": True or False, # If true, incoming audio is processed for DTMF (dual tone multi frequency) events. For example, if the caller presses a button on their telephone keypad and DTMF processing is enabled, Dialogflow will detect the event (e.g. a "3" was pressed) in the incoming audio and pass the event to the bot to drive business logic (e.g. when 3 is pressed, return the account balance). - "endpointingTimeoutDuration": "A String", # Endpoint timeout setting for matching dtmf input to regex. - "finishDigit": "A String", # The digit that terminates a DTMF digit sequence. - "interdigitTimeoutDuration": "A String", # Interdigit timeout setting for matching dtmf input to regex. - "maxDigits": 42, # Max length of DTMF digits. - }, - "loggingSettings": { # Define behaviors on logging. # Settings for logging. Settings for Dialogflow History, Contact Center messages, StackDriver logs, and speech logging. Exposed at the following levels: - Agent level. - "enableInteractionLogging": True or False, # If true, DF Interaction logging is currently enabled. - "enableStackdriverLogging": True or False, # If true, StackDriver logging is currently enabled. - }, - "speechSettings": { # Define behaviors of speech to text detection. # Settings for speech to text detection. Exposed at the following levels: - Agent level - Flow level - Page level - Parameter level - "endpointerSensitivity": 42, # Sensitivity of the speech model that detects the end of speech. Scale from 0 to 100. - "models": { # Mapping from language to Speech-to-Text model. The mapped Speech-to-Text model will be selected for requests from its corresponding language. For more information, see [Speech models](https://cloud.google.com/dialogflow/cx/docs/concept/speech-models). - "a_key": "A String", + "intent": { # An intent represents a user's intent to interact with a conversational agent. You can provide information for the Dialogflow API to use to match user input to an intent by adding training phrases (i.e., examples of user input) to your intent. # The Intent that matched the conversational query. Some, not all fields are filled in this message, including but not limited to: `name` and `display_name`. This field is deprecated, please use QueryResult.match instead. + "description": "A String", # Human readable description for better understanding an intent like its scope, content, result etc. Maximum character limit: 140 characters. + "displayName": "A String", # Required. The human-readable name of the intent, unique within the agent. + "isFallback": True or False, # Indicates whether this is a fallback intent. Currently only default fallback intent is allowed in the agent, which is added upon agent creation. Adding training phrases to fallback intent is useful in the case of requests that are mistakenly matched, since training phrases assigned to fallback intents act as negative examples that triggers no-match event. + "labels": { # The key/value metadata to label an intent. Labels can contain lowercase letters, digits and the symbols '-' and '_'. International characters are allowed, including letters from unicase alphabets. Keys must start with a letter. Keys and values can be no longer than 63 characters and no more than 128 bytes. Prefix "sys-" is reserved for Dialogflow defined labels. Currently allowed Dialogflow defined labels include: * sys-head * sys-contextual The above labels do not require value. "sys-head" means the intent is a head intent. "sys-contextual" means the intent is a contextual intent. + "a_key": "A String", + }, + "name": "A String", # The unique identifier of the intent. Required for the Intents.UpdateIntent method. Intents.CreateIntent populates the name automatically. Format: `projects//locations//agents//intents/`. + "parameters": [ # The collection of parameters associated with the intent. + { # Represents an intent parameter. + "entityType": "A String", # Required. The entity type of the parameter. Format: `projects/-/locations/-/agents/-/entityTypes/` for system entity types (for example, `projects/-/locations/-/agents/-/entityTypes/sys.date`), or `projects//locations//agents//entityTypes/` for developer entity types. + "id": "A String", # Required. The unique identifier of the parameter. This field is used by training phrases to annotate their parts. + "isList": True or False, # Indicates whether the parameter represents a list of values. + "redact": True or False, # Indicates whether the parameter content should be redacted in log. If redaction is enabled, the parameter content will be replaced by parameter name during logging. Note: the parameter content is subject to redaction if either parameter level redaction or entity type level redaction is enabled. + }, + ], + "priority": 42, # 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. + "trainingPhrases": [ # The collection of training phrases the agent is trained on to identify the intent. + { # Represents an example that the agent is trained on to identify the intent. + "id": "A String", # Output only. The unique identifier of the training phrase. + "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 `parameter_id` field is set. + { # Represents a part of a training phrase. + "parameterId": "A String", # The parameter used to annotate this part of the training phrase. This field is required for annotated parts of the training phrase. + "text": "A String", # Required. The text for this part. + }, + ], + "repeatCount": 42, # Indicates how many times this example was added to the intent. + }, + ], }, - "noSpeechTimeout": "A String", # Timeout before detecting no speech. - "useTimeoutBasedEndpointing": True or False, # Use timeout based endpointing, interpreting endpointer sensitivy as seconds of timeout value. - }, - }, - "conditionalCases": [ # Conditional cases for this fulfillment. - { # A list of cascading if-else conditions. Cases are mutually exclusive. The first one with a matching condition is selected, all the rest ignored. - "cases": [ # A list of cascading if-else conditions. - { # Each case has a Boolean condition. When it is evaluated to be True, the corresponding messages will be selected and evaluated recursively. - "caseContent": [ # A list of case content. - { # The list of messages or conditional cases to activate for this case. - "additionalCases": # Object with schema name: GoogleCloudDialogflowCxV3beta1FulfillmentConditionalCases # Additional cases to be evaluated. - "message": { # 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. # Returned message. - "channel": "A String", # The channel which the response is associated with. Clients can specify the channel via QueryParameters.channel, and only associated channel response will be returned. - "conversationSuccess": { # 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. # Indicates that the conversation succeeded. - "metadata": { # Custom metadata. Dialogflow doesn't impose any structure on this. - "a_key": "", # Properties of the object. - }, - }, - "endInteraction": { # 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. # Output only. A signal that indicates the interaction with the Dialogflow agent has ended. This message is generated by Dialogflow only when the conversation reaches `END_SESSION` page. It is not supposed to be defined by the user. It's guaranteed that there is at most one such message in each response. - }, - "knowledgeInfoCard": { # Represents info card response. If the response contains generative knowledge prediction, Dialogflow will return a payload with Infobot Messenger compatible info card. Otherwise, the info card response is skipped. # Represents info card for knowledge answers, to be better rendered in Dialogflow Messenger. - }, - "liveAgentHandoff": { # 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. # Hands off conversation to a human agent. - "metadata": { # Custom metadata for your handoff procedure. Dialogflow doesn't impose any structure on this. - "a_key": "", # Properties of the object. - }, - }, - "mixedAudio": { # 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. # Output only. An audio response message composed of both the synthesized Dialogflow agent responses and responses defined via play_audio. This message is generated by Dialogflow only and not supposed to be defined by the user. - "segments": [ # Segments this audio response is composed of. - { # Represents one segment of audio. - "allowPlaybackInterruption": True or False, # 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. - "audio": "A String", # Raw audio synthesized from the Dialogflow agent's response using the output config specified in the request. - "uri": "A String", # Client-specific URI that points to an audio clip accessible to the client. Dialogflow does not impose any validation on it. - }, - ], - }, - "outputAudioText": { # A text or ssml response that is preferentially used for TTS output audio synthesis, as described in the comment on the ResponseMessage message. # A text or ssml response that is preferentially used for TTS output audio synthesis, as described in the comment on the ResponseMessage message. - "allowPlaybackInterruption": True or False, # 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. - "ssml": "A String", # The SSML text to be synthesized. For more information, see [SSML](/speech/text-to-speech/docs/ssml). - "text": "A String", # The raw text to be synthesized. - }, - "payload": { # Returns a response containing a custom, platform-specific payload. - "a_key": "", # Properties of the object. - }, - "playAudio": { # Specifies an audio clip to be played by the client as part of the response. # Signal that the client should play an audio clip hosted at a client-specific URI. Dialogflow uses this to construct mixed_audio. However, Dialogflow itself does not try to read or process the URI in any way. - "allowPlaybackInterruption": True or False, # 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. - "audioUri": "A String", # Required. URI of the audio clip. Dialogflow does not impose any validation on this value. It is specific to the client that reads it. - }, - "telephonyTransferCall": { # Represents the signal that telles the client to transfer the phone call connected to the agent to a third-party endpoint. # A signal that the client should transfer the phone call connected to this agent to a third-party endpoint. - "phoneNumber": "A String", # Transfer the call to a phone number in [E.164 format](https://en.wikipedia.org/wiki/E.164). - }, - "text": { # The text response message. # Returns a text response. - "allowPlaybackInterruption": True or False, # 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. - "text": [ # Required. A collection of text responses. - "A String", - ], + "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. This field is deprecated, please use QueryResult.match instead. + "languageCode": "A String", # The language that was triggered during intent detection. See [Language Support](https://cloud.google.com/dialogflow/cx/docs/reference/language) for a list of the currently supported language codes. + "match": { # Represents one match result of MatchIntent. # Intent match result, could be an intent or an event. + "confidence": 3.14, # The confidence of this match. 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. + "event": "A String", # The event that matched the query. Filled for `EVENT`, `NO_MATCH` and `NO_INPUT` match types. + "intent": { # An intent represents a user's intent to interact with a conversational agent. You can provide information for the Dialogflow API to use to match user input to an intent by adding training phrases (i.e., examples of user input) to your intent. # The Intent that matched the query. Some, not all fields are filled in this message, including but not limited to: `name` and `display_name`. Only filled for `INTENT` match type. + "description": "A String", # Human readable description for better understanding an intent like its scope, content, result etc. Maximum character limit: 140 characters. + "displayName": "A String", # Required. The human-readable name of the intent, unique within the agent. + "isFallback": True or False, # Indicates whether this is a fallback intent. Currently only default fallback intent is allowed in the agent, which is added upon agent creation. Adding training phrases to fallback intent is useful in the case of requests that are mistakenly matched, since training phrases assigned to fallback intents act as negative examples that triggers no-match event. + "labels": { # The key/value metadata to label an intent. Labels can contain lowercase letters, digits and the symbols '-' and '_'. International characters are allowed, including letters from unicase alphabets. Keys must start with a letter. Keys and values can be no longer than 63 characters and no more than 128 bytes. Prefix "sys-" is reserved for Dialogflow defined labels. Currently allowed Dialogflow defined labels include: * sys-head * sys-contextual The above labels do not require value. "sys-head" means the intent is a head intent. "sys-contextual" means the intent is a contextual intent. + "a_key": "A String", + }, + "name": "A String", # The unique identifier of the intent. Required for the Intents.UpdateIntent method. Intents.CreateIntent populates the name automatically. Format: `projects//locations//agents//intents/`. + "parameters": [ # The collection of parameters associated with the intent. + { # Represents an intent parameter. + "entityType": "A String", # Required. The entity type of the parameter. Format: `projects/-/locations/-/agents/-/entityTypes/` for system entity types (for example, `projects/-/locations/-/agents/-/entityTypes/sys.date`), or `projects//locations//agents//entityTypes/` for developer entity types. + "id": "A String", # Required. The unique identifier of the parameter. This field is used by training phrases to annotate their parts. + "isList": True or False, # Indicates whether the parameter represents a list of values. + "redact": True or False, # Indicates whether the parameter content should be redacted in log. If redaction is enabled, the parameter content will be replaced by parameter name during logging. Note: the parameter content is subject to redaction if either parameter level redaction or entity type level redaction is enabled. + }, + ], + "priority": 42, # 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. + "trainingPhrases": [ # The collection of training phrases the agent is trained on to identify the intent. + { # Represents an example that the agent is trained on to identify the intent. + "id": "A String", # Output only. The unique identifier of the training phrase. + "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 `parameter_id` field is set. + { # Represents a part of a training phrase. + "parameterId": "A String", # The parameter used to annotate this part of the training phrase. This field is required for annotated parts of the training phrase. + "text": "A String", # Required. The text for this part. }, - }, + ], + "repeatCount": 42, # Indicates how many times this example was added to the intent. }, ], - "condition": "A String", # The condition to activate and select this case. Empty means the condition is always true. The condition is evaluated against form parameters or session parameters. See the [conditions reference](https://cloud.google.com/dialogflow/cx/docs/reference/condition). - }, - ], - }, - ], - "enableGenerativeFallback": True or False, # If the flag is true, the agent will utilize LLM to generate a text response. If LLM generation fails, the defined responses in the fulfillment will be respected. This flag is only useful for fulfillments associated with no-match event handlers. - "messages": [ # The list of rich message responses to present to the user. - { # 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. - "channel": "A String", # The channel which the response is associated with. Clients can specify the channel via QueryParameters.channel, and only associated channel response will be returned. - "conversationSuccess": { # 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. # Indicates that the conversation succeeded. - "metadata": { # Custom metadata. Dialogflow doesn't impose any structure on this. - "a_key": "", # Properties of the object. }, - }, - "endInteraction": { # 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. # Output only. A signal that indicates the interaction with the Dialogflow agent has ended. This message is generated by Dialogflow only when the conversation reaches `END_SESSION` page. It is not supposed to be defined by the user. It's guaranteed that there is at most one such message in each response. - }, - "knowledgeInfoCard": { # Represents info card response. If the response contains generative knowledge prediction, Dialogflow will return a payload with Infobot Messenger compatible info card. Otherwise, the info card response is skipped. # Represents info card for knowledge answers, to be better rendered in Dialogflow Messenger. - }, - "liveAgentHandoff": { # 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. # Hands off conversation to a human agent. - "metadata": { # Custom metadata for your handoff procedure. Dialogflow doesn't impose any structure on this. + "matchType": "A String", # Type of this Match. + "parameters": { # The collection of parameters extracted from the query. 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 then use map, otherwise, depending on the parameter value type, it could be one of string, number, boolean, null, list or map. * MapValue value: If parameter's entity type is a composite entity then use map from composite entity property names to property values, otherwise, use parameter value. "a_key": "", # Properties of the object. }, + "resolvedInput": "A String", # Final text input which was matched during MatchIntent. This value can be different from original input sent in request because of spelling correction or other processing. }, - "mixedAudio": { # 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. # Output only. An audio response message composed of both the synthesized Dialogflow agent responses and responses defined via play_audio. This message is generated by Dialogflow only and not supposed to be defined by the user. - "segments": [ # Segments this audio response is composed of. - { # Represents one segment of audio. - "allowPlaybackInterruption": True or False, # 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. - "audio": "A String", # Raw audio synthesized from the Dialogflow agent's response using the output config specified in the request. - "uri": "A String", # Client-specific URI that points to an audio clip accessible to the client. Dialogflow does not impose any validation on it. - }, - ], - }, - "outputAudioText": { # A text or ssml response that is preferentially used for TTS output audio synthesis, as described in the comment on the ResponseMessage message. # A text or ssml response that is preferentially used for TTS output audio synthesis, as described in the comment on the ResponseMessage message. - "allowPlaybackInterruption": True or False, # 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. - "ssml": "A String", # The SSML text to be synthesized. For more information, see [SSML](/speech/text-to-speech/docs/ssml). - "text": "A String", # The raw text to be synthesized. - }, - "payload": { # Returns a response containing a custom, platform-specific payload. + "parameters": { # The collected session 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 then use map, otherwise, depending on the parameter value type, it could be one of string, number, boolean, null, list or map. * MapValue value: If parameter's entity type is a composite entity then use map from composite entity property names to property values, otherwise, use parameter value. "a_key": "", # Properties of the object. }, - "playAudio": { # Specifies an audio clip to be played by the client as part of the response. # Signal that the client should play an audio clip hosted at a client-specific URI. Dialogflow uses this to construct mixed_audio. However, Dialogflow itself does not try to read or process the URI in any way. - "allowPlaybackInterruption": True or False, # 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. - "audioUri": "A String", # Required. URI of the audio clip. Dialogflow does not impose any validation on this value. It is specific to the client that reads it. - }, - "telephonyTransferCall": { # Represents the signal that telles the client to transfer the phone call connected to the agent to a third-party endpoint. # A signal that the client should transfer the phone call connected to this agent to a third-party endpoint. - "phoneNumber": "A String", # Transfer the call to a phone number in [E.164 format](https://en.wikipedia.org/wiki/E.164). - }, - "text": { # The text response message. # Returns a text response. - "allowPlaybackInterruption": True or False, # 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. - "text": [ # Required. A collection of text responses. - "A String", - ], - }, - }, - ], - "returnPartialResponses": True or False, # Whether Dialogflow should return currently queued fulfillment response messages in streaming APIs. If a webhook is specified, it happens before Dialogflow invokes webhook. Warning: 1) This flag only affects streaming API. Responses are still queued and returned once in non-streaming API. 2) The flag can be enabled in any fulfillment but only the first 3 partial responses will be returned. You may only want to apply it to fulfillments that have slow webhooks. - "setParameterActions": [ # Set parameter values before executing the webhook. - { # Setting a parameter value. - "parameter": "A String", # Display name of the parameter. - "value": "", # The new value of the parameter. A null value clears the parameter. - }, - ], - "tag": "A String", # The value of this field will be populated in the WebhookRequest `fulfillmentInfo.tag` field by Dialogflow when the associated webhook is called. The tag is typically used by the webhook service to identify which fulfillment is being called, but it could be used for other purposes. This field is required if `webhook` is specified. - "webhook": "A String", # The webhook to call. Format: `projects//locations//agents//webhooks/`. - }, - "eventHandlers": [ # Handlers associated with the page to handle events such as webhook errors, no match or no input. - { # An event handler specifies an event that can be handled during a session. When the specified event happens, the following actions are taken in order: * If there is a `trigger_fulfillment` associated with the event, it will be called. * If there is a `target_page` associated with the event, the session will transition into the specified page. * If there is a `target_flow` associated with the event, the session will transition into the specified flow. - "event": "A String", # Required. The name of the event to handle. - "name": "A String", # Output only. The unique identifier of this event handler. - "targetFlow": "A String", # The target flow to transition to. Format: `projects//locations//agents//flows/`. - "targetPage": "A String", # The target page to transition to. Format: `projects//locations//agents//flows//pages/`. - "triggerFulfillment": { # A fulfillment can do one or more of the following actions at the same time: * Generate rich message responses. * Set parameter values. * Call the webhook. Fulfillments can be called at various stages in the Page or Form lifecycle. For example, when a DetectIntentRequest drives a session to enter a new page, the page's entry fulfillment can add a static response to the QueryResult in the returning DetectIntentResponse, call the webhook (for example, to load user data from a database), or both. # The fulfillment to call when the event occurs. Handling webhook errors with a fulfillment enabled with webhook could cause infinite loop. It is invalid to specify such fulfillment for a handler handling webhooks. - "advancedSettings": { # Hierarchical advanced settings for agent/flow/page/fulfillment/parameter. Settings exposed at lower level overrides the settings exposed at higher level. Overriding occurs at the sub-setting level. For example, the playback_interruption_settings at fulfillment level only overrides the playback_interruption_settings at the agent level, leaving other settings at the agent level unchanged. DTMF settings does not override each other. DTMF settings set at different levels define DTMF detections running in parallel. Hierarchy: Agent->Flow->Page->Fulfillment/Parameter. # Hierarchical advanced settings for this fulfillment. The settings exposed at the lower level overrides the settings exposed at the higher level. - "audioExportGcsDestination": { # Google Cloud Storage location for a Dialogflow operation that writes or exports objects (e.g. exported agent or transcripts) outside of Dialogflow. # If present, incoming audio is exported by Dialogflow to the configured Google Cloud Storage destination. Exposed at the following levels: - Agent level - Flow level - "uri": "A String", # Required. The Google Cloud Storage URI for the exported objects. A URI is of the form: `gs://bucket/object-name-or-prefix` Whether a full object name, or just a prefix, its usage depends on the Dialogflow operation. - }, - "dtmfSettings": { # Define behaviors for DTMF (dual tone multi frequency). # Settings for DTMF. Exposed at the following levels: - Agent level - Flow level - Page level - Parameter level. - "enabled": True or False, # If true, incoming audio is processed for DTMF (dual tone multi frequency) events. For example, if the caller presses a button on their telephone keypad and DTMF processing is enabled, Dialogflow will detect the event (e.g. a "3" was pressed) in the incoming audio and pass the event to the bot to drive business logic (e.g. when 3 is pressed, return the account balance). - "endpointingTimeoutDuration": "A String", # Endpoint timeout setting for matching dtmf input to regex. - "finishDigit": "A String", # The digit that terminates a DTMF digit sequence. - "interdigitTimeoutDuration": "A String", # Interdigit timeout setting for matching dtmf input to regex. - "maxDigits": 42, # Max length of DTMF digits. - }, - "loggingSettings": { # Define behaviors on logging. # Settings for logging. Settings for Dialogflow History, Contact Center messages, StackDriver logs, and speech logging. Exposed at the following levels: - Agent level. - "enableInteractionLogging": True or False, # If true, DF Interaction logging is currently enabled. - "enableStackdriverLogging": True or False, # If true, StackDriver logging is currently enabled. - }, - "speechSettings": { # Define behaviors of speech to text detection. # Settings for speech to text detection. Exposed at the following levels: - Agent level - Flow level - Page level - Parameter level - "endpointerSensitivity": 42, # Sensitivity of the speech model that detects the end of speech. Scale from 0 to 100. - "models": { # Mapping from language to Speech-to-Text model. The mapped Speech-to-Text model will be selected for requests from its corresponding language. For more information, see [Speech models](https://cloud.google.com/dialogflow/cx/docs/concept/speech-models). - "a_key": "A String", - }, - "noSpeechTimeout": "A String", # Timeout before detecting no speech. - "useTimeoutBasedEndpointing": True or False, # Use timeout based endpointing, interpreting endpointer sensitivy as seconds of timeout value. - }, - }, - "conditionalCases": [ # Conditional cases for this fulfillment. - { # A list of cascading if-else conditions. Cases are mutually exclusive. The first one with a matching condition is selected, all the rest ignored. - "cases": [ # A list of cascading if-else conditions. - { # Each case has a Boolean condition. When it is evaluated to be True, the corresponding messages will be selected and evaluated recursively. - "caseContent": [ # A list of case content. - { # The list of messages or conditional cases to activate for this case. - "additionalCases": # Object with schema name: GoogleCloudDialogflowCxV3beta1FulfillmentConditionalCases # Additional cases to be evaluated. - "message": { # 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. # Returned message. - "channel": "A String", # The channel which the response is associated with. Clients can specify the channel via QueryParameters.channel, and only associated channel response will be returned. - "conversationSuccess": { # 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. # Indicates that the conversation succeeded. - "metadata": { # Custom metadata. Dialogflow doesn't impose any structure on this. - "a_key": "", # Properties of the object. - }, - }, - "endInteraction": { # 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. # Output only. A signal that indicates the interaction with the Dialogflow agent has ended. This message is generated by Dialogflow only when the conversation reaches `END_SESSION` page. It is not supposed to be defined by the user. It's guaranteed that there is at most one such message in each response. - }, - "knowledgeInfoCard": { # Represents info card response. If the response contains generative knowledge prediction, Dialogflow will return a payload with Infobot Messenger compatible info card. Otherwise, the info card response is skipped. # Represents info card for knowledge answers, to be better rendered in Dialogflow Messenger. - }, - "liveAgentHandoff": { # 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. # Hands off conversation to a human agent. - "metadata": { # Custom metadata for your handoff procedure. Dialogflow doesn't impose any structure on this. - "a_key": "", # Properties of the object. - }, - }, - "mixedAudio": { # 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. # Output only. An audio response message composed of both the synthesized Dialogflow agent responses and responses defined via play_audio. This message is generated by Dialogflow only and not supposed to be defined by the user. - "segments": [ # Segments this audio response is composed of. - { # Represents one segment of audio. - "allowPlaybackInterruption": True or False, # 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. - "audio": "A String", # Raw audio synthesized from the Dialogflow agent's response using the output config specified in the request. - "uri": "A String", # Client-specific URI that points to an audio clip accessible to the client. Dialogflow does not impose any validation on it. - }, - ], - }, - "outputAudioText": { # A text or ssml response that is preferentially used for TTS output audio synthesis, as described in the comment on the ResponseMessage message. # A text or ssml response that is preferentially used for TTS output audio synthesis, as described in the comment on the ResponseMessage message. - "allowPlaybackInterruption": True or False, # 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. - "ssml": "A String", # The SSML text to be synthesized. For more information, see [SSML](/speech/text-to-speech/docs/ssml). - "text": "A String", # The raw text to be synthesized. - }, - "payload": { # Returns a response containing a custom, platform-specific payload. - "a_key": "", # Properties of the object. - }, - "playAudio": { # Specifies an audio clip to be played by the client as part of the response. # Signal that the client should play an audio clip hosted at a client-specific URI. Dialogflow uses this to construct mixed_audio. However, Dialogflow itself does not try to read or process the URI in any way. - "allowPlaybackInterruption": True or False, # 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. - "audioUri": "A String", # Required. URI of the audio clip. Dialogflow does not impose any validation on this value. It is specific to the client that reads it. - }, - "telephonyTransferCall": { # Represents the signal that telles the client to transfer the phone call connected to the agent to a third-party endpoint. # A signal that the client should transfer the phone call connected to this agent to a third-party endpoint. - "phoneNumber": "A String", # Transfer the call to a phone number in [E.164 format](https://en.wikipedia.org/wiki/E.164). - }, - "text": { # The text response message. # Returns a text response. - "allowPlaybackInterruption": True or False, # 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. - "text": [ # Required. A collection of text responses. - "A String", - ], - }, - }, - }, - ], - "condition": "A String", # The condition to activate and select this case. Empty means the condition is always true. The condition is evaluated against form parameters or session parameters. See the [conditions reference](https://cloud.google.com/dialogflow/cx/docs/reference/condition). - }, - ], - }, - ], - "enableGenerativeFallback": True or False, # If the flag is true, the agent will utilize LLM to generate a text response. If LLM generation fails, the defined responses in the fulfillment will be respected. This flag is only useful for fulfillments associated with no-match event handlers. - "messages": [ # The list of rich message responses to present to the user. + "responseMessages": [ # The list of rich messages returned to the client. Responses vary from simple text messages to more sophisticated, structured payloads used to drive complex logic. { # 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. "channel": "A String", # The channel which the response is associated with. Clients can specify the channel via QueryParameters.channel, and only associated channel response will be returned. "conversationSuccess": { # 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. # Indicates that the conversation succeeded. @@ -3724,529 +2720,794 @@

Method Details

"A String", ], }, + "toolCall": { # Represents a call of a specific tool's action with the specified inputs. # Returns the definition of a tool call that should be executed by the client. + "action": "A String", # Required. The name of the tool's action associated with this call. + "inputParameters": { # Optional. The action's input parameters. + "a_key": "", # Properties of the object. + }, + "tool": "A String", # Required. The tool associated with this call. Format: `projects//locations//agents//tools/`. + }, }, ], - "returnPartialResponses": True or False, # Whether Dialogflow should return currently queued fulfillment response messages in streaming APIs. If a webhook is specified, it happens before Dialogflow invokes webhook. Warning: 1) This flag only affects streaming API. Responses are still queued and returned once in non-streaming API. 2) The flag can be enabled in any fulfillment but only the first 3 partial responses will be returned. You may only want to apply it to fulfillments that have slow webhooks. - "setParameterActions": [ # Set parameter values before executing the webhook. - { # Setting a parameter value. - "parameter": "A String", # Display name of the parameter. - "value": "", # The new value of the parameter. A null value clears the parameter. + "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. # The sentiment analyss result, which depends on `analyze_query_text_sentiment`, specified in the request. + "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). + "score": 3.14, # Sentiment score between -1.0 (negative sentiment) and 1.0 (positive sentiment). + }, + "text": "A String", # If natural language text was provided as input, this field will contain a copy of the text. + "transcript": "A String", # If natural language speech audio was provided as input, this field will contain the transcript for the audio. + "triggerEvent": "A String", # If an event was provided as input, this field will contain the name of the event. + "triggerIntent": "A String", # If an intent was provided as input, this field will contain a copy of the intent identifier. Format: `projects//locations//agents//intents/`. + "webhookDisplayNames": [ # The list of webhook display names in the order of call sequence. + "A String", + ], + "webhookIds": [ # The list of webhook ids in the order of call sequence. + "A String", + ], + "webhookLatencies": [ # The list of webhook latencies in the order of call sequence. + "A String", + ], + "webhookPayloads": [ # The list of webhook payload in WebhookResponse.payload, in the order of call sequence. If some webhook call fails or doesn't return any payload, an empty `Struct` would be used instead. + { + "a_key": "", # Properties of the object. }, ], - "tag": "A String", # The value of this field will be populated in the WebhookRequest `fulfillmentInfo.tag` field by Dialogflow when the associated webhook is called. The tag is typically used by the webhook service to identify which fulfillment is being called, but it could be used for other purposes. This field is required if `webhook` is specified. - "webhook": "A String", # The webhook to call. Format: `projects//locations//agents//webhooks/`. + "webhookStatuses": [ # The list of webhook call status in the order of call sequence. + { # 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). + "code": 42, # The status code, which should be an enum value of google.rpc.Code. + "details": [ # A list of messages that carry the error details. There is a common set of message types for APIs to use. + { + "a_key": "", # Properties of the object. Contains field @type with type URL. + }, + ], + "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. + }, + ], + "webhookTags": [ # The list of webhook tags in the order of call sequence. + "A String", + ], }, + "responseId": "A String", # Output only. The unique identifier of the response. It can be used to locate a response in the training example set or for reporting issues. + "responseType": "A String", # Response type. }, ], - "form": { # A form is a data model that groups related parameters that can be collected from the user. The process in which the agent prompts the user and collects parameter values from the user is called form filling. A form can be added to a page. When form filling is done, the filled parameters will be written to the session. # The form associated with the page, used for collecting parameters relevant to the page. - "parameters": [ # Parameters to collect from the user. - { # Represents a form parameter. - "advancedSettings": { # Hierarchical advanced settings for agent/flow/page/fulfillment/parameter. Settings exposed at lower level overrides the settings exposed at higher level. Overriding occurs at the sub-setting level. For example, the playback_interruption_settings at fulfillment level only overrides the playback_interruption_settings at the agent level, leaving other settings at the agent level unchanged. DTMF settings does not override each other. DTMF settings set at different levels define DTMF detections running in parallel. Hierarchy: Agent->Flow->Page->Fulfillment/Parameter. # Hierarchical advanced settings for this parameter. The settings exposed at the lower level overrides the settings exposed at the higher level. - "audioExportGcsDestination": { # Google Cloud Storage location for a Dialogflow operation that writes or exports objects (e.g. exported agent or transcripts) outside of Dialogflow. # If present, incoming audio is exported by Dialogflow to the configured Google Cloud Storage destination. Exposed at the following levels: - Agent level - Flow level - "uri": "A String", # Required. The Google Cloud Storage URI for the exported objects. A URI is of the form: `gs://bucket/object-name-or-prefix` Whether a full object name, or just a prefix, its usage depends on the Dialogflow operation. - }, - "dtmfSettings": { # Define behaviors for DTMF (dual tone multi frequency). # Settings for DTMF. Exposed at the following levels: - Agent level - Flow level - Page level - Parameter level. - "enabled": True or False, # If true, incoming audio is processed for DTMF (dual tone multi frequency) events. For example, if the caller presses a button on their telephone keypad and DTMF processing is enabled, Dialogflow will detect the event (e.g. a "3" was pressed) in the incoming audio and pass the event to the bot to drive business logic (e.g. when 3 is pressed, return the account balance). - "endpointingTimeoutDuration": "A String", # Endpoint timeout setting for matching dtmf input to regex. - "finishDigit": "A String", # The digit that terminates a DTMF digit sequence. - "interdigitTimeoutDuration": "A String", # Interdigit timeout setting for matching dtmf input to regex. - "maxDigits": 42, # Max length of DTMF digits. - }, - "loggingSettings": { # Define behaviors on logging. # Settings for logging. Settings for Dialogflow History, Contact Center messages, StackDriver logs, and speech logging. Exposed at the following levels: - Agent level. - "enableInteractionLogging": True or False, # If true, DF Interaction logging is currently enabled. - "enableStackdriverLogging": True or False, # If true, StackDriver logging is currently enabled. - }, - "speechSettings": { # Define behaviors of speech to text detection. # Settings for speech to text detection. Exposed at the following levels: - Agent level - Flow level - Page level - Parameter level - "endpointerSensitivity": 42, # Sensitivity of the speech model that detects the end of speech. Scale from 0 to 100. - "models": { # Mapping from language to Speech-to-Text model. The mapped Speech-to-Text model will be selected for requests from its corresponding language. For more information, see [Speech models](https://cloud.google.com/dialogflow/cx/docs/concept/speech-models). - "a_key": "A String", - }, - "noSpeechTimeout": "A String", # Timeout before detecting no speech. - "useTimeoutBasedEndpointing": True or False, # Use timeout based endpointing, interpreting endpointer sensitivy as seconds of timeout value. + "request": { # The request to detect user's intent. # The request of the interaction. + "outputAudioConfig": { # Instructs the speech synthesizer how to generate the output audio content. # Instructs the speech synthesizer how to generate the output audio. + "audioEncoding": "A String", # Required. Audio encoding of the synthesized audio content. + "sampleRateHertz": 42, # Optional. 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). + "synthesizeSpeechConfig": { # Configuration of how speech should be synthesized. # Optional. Configuration of how speech should be synthesized. If not specified, Agent.text_to_speech_settings is applied. + "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. + "A String", + ], + "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. + "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. + "voice": { # Description of which voice to use for speech synthesis. # Optional. The desired voice of the synthesized audio. + "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. For the list of available voices, please refer to [Supported voices and languages](https://cloud.google.com/text-to-speech/docs/voices). + "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. + }, + "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. + }, + }, + "queryInput": { # Represents the query input. It can contain one of: 1. A conversational query in the form of text. 2. An intent query that specifies which intent to trigger. 3. Natural language speech audio to be processed. 4. An event to be triggered. 5. DTMF digits to invoke an intent and fill in parameter value. 6. The results of a tool executed by the client. # Required. The input specification. + "audio": { # Represents the natural speech audio to be processed. # The natural language speech audio to be processed. + "audio": "A String", # The natural language speech audio to be processed. A single request can contain up to 2 minutes of speech audio data. The transcribed text cannot contain more than 256 bytes. For non-streaming audio detect intent, both `config` and `audio` must be provided. For streaming audio detect intent, `config` must be provided in the first request and `audio` must be provided in all following requests. + "config": { # Instructs the speech recognizer on how to process the audio content. # Required. Instructs the speech recognizer how to process the speech audio. + "audioEncoding": "A String", # Required. Audio encoding of the audio content to process. + "bargeInConfig": { # Configuration of the barge-in behavior. Barge-in instructs the API to return a detected utterance at a proper time while the client is playing back the response audio from a previous request. When the client sees the utterance, it should stop the playback and immediately get ready for receiving the responses for the current request. The barge-in handling requires the client to start streaming audio input as soon as it starts playing back the audio from the previous response. The playback is modeled into two phases: * No barge-in phase: which goes first and during which speech detection should not be carried out. * Barge-in phase: which follows the no barge-in phase and during which the API starts speech detection and may inform the client that an utterance has been detected. Note that no-speech event is not expected in this phase. The client provides this configuration in terms of the durations of those two phases. The durations are measured in terms of the audio length from the the start of the input audio. No-speech event is a response with END_OF_UTTERANCE without any transcript following up. # Configuration of barge-in behavior during the streaming of input audio. + "noBargeInDuration": "A String", # Duration that is not eligible for barge-in at the beginning of the input audio. + "totalDuration": "A String", # Total duration for the playback at the beginning of the input audio. }, + "enableWordInfo": True or False, # Optional. If `true`, Dialogflow returns SpeechWordInfo in StreamingRecognitionResult with information about the recognized speech words, e.g. start and end time offsets. If false or unspecified, Speech doesn't return any word-level information. + "model": "A String", # Optional. Which Speech model to select for the given request. For more information, see [Speech models](https://cloud.google.com/dialogflow/cx/docs/concept/speech-models). + "modelVariant": "A String", # Optional. Which variant of the Speech model to use. + "optOutConformerModelMigration": True or False, # If `true`, the request will opt out for STT conformer model migration. This field will be deprecated once force migration takes place in June 2024. Please refer to [Dialogflow CX Speech model migration](https://cloud.google.com/dialogflow/cx/docs/concept/speech-model-migration). + "phraseHints": [ # Optional. A list of strings containing words and phrases that the speech recognizer should recognize with higher likelihood. See [the Cloud Speech documentation](https://cloud.google.com/speech-to-text/docs/basics#phrase-hints) for more details. + "A String", + ], + "sampleRateHertz": 42, # Sample rate (in Hertz) of the audio content sent in the query. Refer to [Cloud Speech API documentation](https://cloud.google.com/speech-to-text/docs/basics) for more details. + "singleUtterance": True or False, # Optional. If `false` (default), recognition does not cease until the client closes the stream. If `true`, the recognizer will detect a single spoken utterance in input audio. Recognition ceases when it detects the audio's voice has stopped or paused. In this case, once a detected intent is received, the client should close the stream and start a new request with a new stream as needed. Note: This setting is relevant only for streaming methods. }, - "defaultValue": "", # The default value of an optional parameter. If the parameter is required, the default value will be ignored. - "displayName": "A String", # Required. The human-readable name of the parameter, unique within the form. - "entityType": "A String", # Required. The entity type of the parameter. Format: `projects/-/locations/-/agents/-/entityTypes/` for system entity types (for example, `projects/-/locations/-/agents/-/entityTypes/sys.date`), or `projects//locations//agents//entityTypes/` for developer entity types. - "fillBehavior": { # Configuration for how the filling of a parameter should be handled. # Required. Defines fill behavior for the parameter. - "initialPromptFulfillment": { # A fulfillment can do one or more of the following actions at the same time: * Generate rich message responses. * Set parameter values. * Call the webhook. Fulfillments can be called at various stages in the Page or Form lifecycle. For example, when a DetectIntentRequest drives a session to enter a new page, the page's entry fulfillment can add a static response to the QueryResult in the returning DetectIntentResponse, call the webhook (for example, to load user data from a database), or both. # Required. The fulfillment to provide the initial prompt that the agent can present to the user in order to fill the parameter. - "advancedSettings": { # Hierarchical advanced settings for agent/flow/page/fulfillment/parameter. Settings exposed at lower level overrides the settings exposed at higher level. Overriding occurs at the sub-setting level. For example, the playback_interruption_settings at fulfillment level only overrides the playback_interruption_settings at the agent level, leaving other settings at the agent level unchanged. DTMF settings does not override each other. DTMF settings set at different levels define DTMF detections running in parallel. Hierarchy: Agent->Flow->Page->Fulfillment/Parameter. # Hierarchical advanced settings for this fulfillment. The settings exposed at the lower level overrides the settings exposed at the higher level. - "audioExportGcsDestination": { # Google Cloud Storage location for a Dialogflow operation that writes or exports objects (e.g. exported agent or transcripts) outside of Dialogflow. # If present, incoming audio is exported by Dialogflow to the configured Google Cloud Storage destination. Exposed at the following levels: - Agent level - Flow level - "uri": "A String", # Required. The Google Cloud Storage URI for the exported objects. A URI is of the form: `gs://bucket/object-name-or-prefix` Whether a full object name, or just a prefix, its usage depends on the Dialogflow operation. - }, - "dtmfSettings": { # Define behaviors for DTMF (dual tone multi frequency). # Settings for DTMF. Exposed at the following levels: - Agent level - Flow level - Page level - Parameter level. - "enabled": True or False, # If true, incoming audio is processed for DTMF (dual tone multi frequency) events. For example, if the caller presses a button on their telephone keypad and DTMF processing is enabled, Dialogflow will detect the event (e.g. a "3" was pressed) in the incoming audio and pass the event to the bot to drive business logic (e.g. when 3 is pressed, return the account balance). - "endpointingTimeoutDuration": "A String", # Endpoint timeout setting for matching dtmf input to regex. - "finishDigit": "A String", # The digit that terminates a DTMF digit sequence. - "interdigitTimeoutDuration": "A String", # Interdigit timeout setting for matching dtmf input to regex. - "maxDigits": 42, # Max length of DTMF digits. - }, - "loggingSettings": { # Define behaviors on logging. # Settings for logging. Settings for Dialogflow History, Contact Center messages, StackDriver logs, and speech logging. Exposed at the following levels: - Agent level. - "enableInteractionLogging": True or False, # If true, DF Interaction logging is currently enabled. - "enableStackdriverLogging": True or False, # If true, StackDriver logging is currently enabled. - }, - "speechSettings": { # Define behaviors of speech to text detection. # Settings for speech to text detection. Exposed at the following levels: - Agent level - Flow level - Page level - Parameter level - "endpointerSensitivity": 42, # Sensitivity of the speech model that detects the end of speech. Scale from 0 to 100. - "models": { # Mapping from language to Speech-to-Text model. The mapped Speech-to-Text model will be selected for requests from its corresponding language. For more information, see [Speech models](https://cloud.google.com/dialogflow/cx/docs/concept/speech-models). - "a_key": "A String", - }, - "noSpeechTimeout": "A String", # Timeout before detecting no speech. - "useTimeoutBasedEndpointing": True or False, # Use timeout based endpointing, interpreting endpointer sensitivy as seconds of timeout value. - }, - }, - "conditionalCases": [ # Conditional cases for this fulfillment. - { # A list of cascading if-else conditions. Cases are mutually exclusive. The first one with a matching condition is selected, all the rest ignored. - "cases": [ # A list of cascading if-else conditions. - { # Each case has a Boolean condition. When it is evaluated to be True, the corresponding messages will be selected and evaluated recursively. - "caseContent": [ # A list of case content. - { # The list of messages or conditional cases to activate for this case. - "additionalCases": # Object with schema name: GoogleCloudDialogflowCxV3beta1FulfillmentConditionalCases # Additional cases to be evaluated. - "message": { # 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. # Returned message. - "channel": "A String", # The channel which the response is associated with. Clients can specify the channel via QueryParameters.channel, and only associated channel response will be returned. - "conversationSuccess": { # 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. # Indicates that the conversation succeeded. - "metadata": { # Custom metadata. Dialogflow doesn't impose any structure on this. - "a_key": "", # Properties of the object. - }, - }, - "endInteraction": { # 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. # Output only. A signal that indicates the interaction with the Dialogflow agent has ended. This message is generated by Dialogflow only when the conversation reaches `END_SESSION` page. It is not supposed to be defined by the user. It's guaranteed that there is at most one such message in each response. - }, - "knowledgeInfoCard": { # Represents info card response. If the response contains generative knowledge prediction, Dialogflow will return a payload with Infobot Messenger compatible info card. Otherwise, the info card response is skipped. # Represents info card for knowledge answers, to be better rendered in Dialogflow Messenger. - }, - "liveAgentHandoff": { # 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. # Hands off conversation to a human agent. - "metadata": { # Custom metadata for your handoff procedure. Dialogflow doesn't impose any structure on this. - "a_key": "", # Properties of the object. - }, - }, - "mixedAudio": { # 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. # Output only. An audio response message composed of both the synthesized Dialogflow agent responses and responses defined via play_audio. This message is generated by Dialogflow only and not supposed to be defined by the user. - "segments": [ # Segments this audio response is composed of. - { # Represents one segment of audio. - "allowPlaybackInterruption": True or False, # 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. - "audio": "A String", # Raw audio synthesized from the Dialogflow agent's response using the output config specified in the request. - "uri": "A String", # Client-specific URI that points to an audio clip accessible to the client. Dialogflow does not impose any validation on it. - }, - ], - }, - "outputAudioText": { # A text or ssml response that is preferentially used for TTS output audio synthesis, as described in the comment on the ResponseMessage message. # A text or ssml response that is preferentially used for TTS output audio synthesis, as described in the comment on the ResponseMessage message. - "allowPlaybackInterruption": True or False, # 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. - "ssml": "A String", # The SSML text to be synthesized. For more information, see [SSML](/speech/text-to-speech/docs/ssml). - "text": "A String", # The raw text to be synthesized. - }, - "payload": { # Returns a response containing a custom, platform-specific payload. - "a_key": "", # Properties of the object. - }, - "playAudio": { # Specifies an audio clip to be played by the client as part of the response. # Signal that the client should play an audio clip hosted at a client-specific URI. Dialogflow uses this to construct mixed_audio. However, Dialogflow itself does not try to read or process the URI in any way. - "allowPlaybackInterruption": True or False, # 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. - "audioUri": "A String", # Required. URI of the audio clip. Dialogflow does not impose any validation on this value. It is specific to the client that reads it. - }, - "telephonyTransferCall": { # Represents the signal that telles the client to transfer the phone call connected to the agent to a third-party endpoint. # A signal that the client should transfer the phone call connected to this agent to a third-party endpoint. - "phoneNumber": "A String", # Transfer the call to a phone number in [E.164 format](https://en.wikipedia.org/wiki/E.164). - }, - "text": { # The text response message. # Returns a text response. - "allowPlaybackInterruption": True or False, # 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. - "text": [ # Required. A collection of text responses. - "A String", - ], - }, - }, - }, - ], - "condition": "A String", # The condition to activate and select this case. Empty means the condition is always true. The condition is evaluated against form parameters or session parameters. See the [conditions reference](https://cloud.google.com/dialogflow/cx/docs/reference/condition). + }, + "dtmf": { # Represents the input for dtmf event. # The DTMF event to be handled. + "digits": "A String", # The dtmf digits. + "finishDigit": "A String", # The finish digit (if any). + }, + "event": { # Represents the event to trigger. # The event to be triggered. + "event": "A String", # Name of the event. + }, + "intent": { # Represents the intent to trigger programmatically rather than as a result of natural language processing. # The intent to be triggered. + "intent": "A String", # Required. The unique identifier of the intent. Format: `projects//locations//agents//intents/`. + }, + "languageCode": "A String", # Required. The language of the input. See [Language Support](https://cloud.google.com/dialogflow/cx/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. + "text": { # Represents the natural language text to be processed. # The natural language text to be processed. + "text": "A String", # Required. The UTF-8 encoded natural language text to be processed. + }, + "toolCallResult": { # The result of calling a tool's action that has been executed by the client. # The results of a tool executed by the client. + "action": "A String", # Required. The name of the tool's action associated with this call. + "error": { # An error produced by the tool call. # The tool call's error. + "message": "A String", # Optional. The error message of the function. + }, + "outputParameters": { # The tool call's output parameters. + "a_key": "", # Properties of the object. + }, + "tool": "A String", # Required. The tool associated with this call. Format: `projects//locations//agents//tools/`. + }, + }, + "queryParams": { # Represents the parameters of a conversational query. # The parameters of this query. + "analyzeQueryTextSentiment": True or False, # Configures whether sentiment analysis should be performed. If not provided, sentiment analysis is not performed. + "channel": "A String", # The channel which this query is for. If specified, only the ResponseMessage associated with the channel will be returned. If no ResponseMessage is associated with the channel, it falls back to the ResponseMessage with unspecified channel. If unspecified, the ResponseMessage with unspecified channel will be returned. + "currentPage": "A String", # The unique identifier of the page to override the current page in the session. Format: `projects//locations//agents//flows//pages/`. If `current_page` is specified, the previous state of the session will be ignored by Dialogflow, including the previous page and the previous session parameters. In most cases, current_page and parameters should be configured together to direct a session to a specific state. + "currentPlaybook": "A String", # Optional. Start the session with the specified playbook. You can only specify the playbook at the beginning of the session. Otherwise, an error will be thrown. Format: `projects//locations//agents//playbooks/`. + "disableWebhook": True or False, # Whether to disable webhook calls for this request. + "endUserMetadata": { # Optional. Information about the end-user to improve the relevance and accuracy of generative answers. This will be interpreted and used by a language model, so, for good results, the data should be self-descriptive, and in a simple structure. Example: ```json { "subscription plan": "Business Premium Plus", "devices owned": [ {"model": "Google Pixel 7"}, {"model": "Google Pixel Tablet"} ] } ``` + "a_key": "", # Properties of the object. + }, + "flowVersions": [ # A list of flow versions to override for the request. Format: `projects//locations//agents//flows//versions/`. If version 1 of flow X is included in this list, the traffic of flow X will go through version 1 regardless of the version configuration in the environment. Each flow can have at most one version specified in this list. + "A String", + ], + "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. + "latitude": 3.14, # The latitude in degrees. It must be in the range [-90.0, +90.0]. + "longitude": 3.14, # The longitude in degrees. It must be in the range [-180.0, +180.0]. + }, + "llmModelSettings": { # Settings for LLM models. # Optional. Use the specified LLM model settings for processing the request. + "model": "A String", # The selected LLM model. + "promptText": "A String", # The custom prompt to use. + }, + "parameters": { # Additional parameters to be put into session parameters. To remove a parameter from the session, clients should explicitly set the parameter value to null. You can reference the session parameters in the agent with the following format: $session.params.parameter-id. 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 then use map, otherwise, depending on the parameter value type, it could be one of string, number, boolean, null, list or map. * MapValue value: If parameter's entity type is a composite entity then use map from composite entity property names to property values, otherwise, use parameter value. + "a_key": "", # Properties of the object. + }, + "payload": { # This field can be used to pass custom data into the webhook associated with the agent. Arbitrary JSON objects are supported. Some integrations that query a Dialogflow agent may provide additional information in the payload. In particular, for the Dialogflow Phone Gateway integration, this field has the form: ``` { "telephony": { "caller_id": "+18558363987" } } ``` + "a_key": "", # Properties of the object. + }, + "populateDataStoreConnectionSignals": True or False, # Optional. If set to true and data stores are involved in serving the request then DetectIntentResponse.query_result.data_store_connection_signals will be filled with data that can help evaluations. + "searchConfig": { # Search configuration for UCS search queries. # Optional. Search configuration for UCS search queries. + "boostSpecs": [ # Optional. Boosting configuration for the datastores. + { # Boost specifications for data stores. + "dataStores": [ # Optional. Data Stores where the boosting configuration is applied. The full names of the referenced data stores. Formats: `projects/{project}/locations/{location}/collections/{collection}/dataStores/{data_store}` `projects/{project}/locations/{location}/dataStores/{data_store} + "A String", + ], + "spec": [ # Optional. A list of boosting specifications. + { # Boost specification to boost certain documents. A copy of google.cloud.discoveryengine.v1main.BoostSpec, field documentation is available at https://cloud.google.com/generative-ai-app-builder/docs/reference/rest/v1alpha/BoostSpec + "conditionBoostSpecs": [ # Optional. Condition boost specifications. If a document matches multiple conditions in the specifictions, boost scores from these specifications are all applied and combined in a non-linear way. Maximum number of specifications is 20. + { # Boost applies to documents which match a condition. + "boost": 3.14, # Optional. Strength of the condition boost, which should be in [-1, 1]. Negative boost means demotion. Default is 0.0. Setting to 1.0 gives the document a big promotion. However, it does not necessarily mean that the boosted document will be the top result at all times, nor that other documents will be excluded. Results could still be shown even when none of them matches the condition. And results that are significantly more relevant to the search query can still trump your heavily favored but irrelevant documents. Setting to -1.0 gives the document a big demotion. However, results that are deeply relevant might still be shown. The document will have an upstream battle to get a fairly high ranking, but it is not blocked out completely. Setting to 0.0 means no boost applied. The boosting condition is ignored. + "condition": "A String", # Optional. An expression which specifies a boost condition. The syntax and supported fields are the same as a filter expression. Examples: * To boost documents with document ID "doc_1" or "doc_2", and color "Red" or "Blue": * (id: ANY("doc_1", "doc_2")) AND (color: ANY("Red","Blue")) }, ], }, ], - "enableGenerativeFallback": True or False, # If the flag is true, the agent will utilize LLM to generate a text response. If LLM generation fails, the defined responses in the fulfillment will be respected. This flag is only useful for fulfillments associated with no-match event handlers. - "messages": [ # The list of rich message responses to present to the user. - { # 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. - "channel": "A String", # The channel which the response is associated with. Clients can specify the channel via QueryParameters.channel, and only associated channel response will be returned. - "conversationSuccess": { # 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. # Indicates that the conversation succeeded. - "metadata": { # Custom metadata. Dialogflow doesn't impose any structure on this. - "a_key": "", # Properties of the object. - }, + }, + ], + "filterSpecs": [ # Optional. Filter configuration for the datastores. + { # Filter specifications for data stores. + "dataStores": [ # Optional. Data Stores where the boosting configuration is applied. The full names of the referenced data stores. Formats: `projects/{project}/locations/{location}/collections/{collection}/dataStores/{data_store}` `projects/{project}/locations/{location}/dataStores/{data_store} + "A String", + ], + "filter": "A String", # Optional. The filter expression to be applied. Expression syntax is documented at https://cloud.google.com/generative-ai-app-builder/docs/filter-search-metadata#filter-expression-syntax + }, + ], + }, + "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. + { # Session entity types are referred to as **User** entity types and are entities that are built for an individual user such as favorites, preferences, playlists, and so on. You can redefine a session entity type at the session level to extend or replace a custom entity type at the user session level (we refer to the entity types defined at the agent level as "custom entity types"). Note: session entity types apply to all queries, regardless of the language. For more information about entity types, see the [Dialogflow documentation](https://cloud.google.com/dialogflow/docs/entities-overview). + "entities": [ # Required. The collection of entities to override or supplement the custom entity type. + { # An **entity entry** for an associated entity type. + "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`. + "A String", + ], + "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 canonical 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). + }, + ], + "entityOverrideMode": "A String", # Required. Indicates whether the additional data should override or supplement the custom entity type definition. + "name": "A String", # Required. The unique identifier of the session entity type. Format: `projects//locations//agents//sessions//entityTypes/` or `projects//locations//agents//environments//sessions//entityTypes/`. If `Environment ID` is not specified, we assume default 'draft' environment. + }, + ], + "sessionTtl": "A String", # Optional. Configure lifetime of the Dialogflow session. By default, a Dialogflow session remains active and its data is stored for 30 minutes after the last request is sent for the session. This value should be no longer than 1 day. + "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 the agent is used. + "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 Dialogflow web console. The headers defined within this field will overwrite the headers configured through 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. + "a_key": "A String", + }, + }, + "session": "A String", # Required. The name of the session this query is sent to. Format: `projects//locations//agents//sessions/` or `projects//locations//agents//environments//sessions/`. If `Environment ID` is not specified, we assume default 'draft' environment. It's up to the API caller to choose an appropriate `Session ID`. It can be a random number or some type of session identifiers (preferably hashed). The length of the `Session ID` must not exceed 36 characters. For more information, see the [sessions guide](https://cloud.google.com/dialogflow/cx/docs/concept/session). Note: Always use agent versions for production traffic. See [Versions and environments](https://cloud.google.com/dialogflow/cx/docs/concept/version). + }, + "requestUtterances": "A String", # The input text or the transcript of the input audio in the request. + "response": { # The message returned from the DetectIntent method. # The final response of the interaction. + "allowCancellation": True or False, # Indicates whether the partial response can be cancelled when a later response arrives. e.g. if the agent specified some music as partial response, it can be cancelled. + "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.response_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. + "outputAudioConfig": { # Instructs the speech synthesizer how to generate the output audio content. # The config used by the speech synthesizer to generate the output audio. + "audioEncoding": "A String", # Required. Audio encoding of the synthesized audio content. + "sampleRateHertz": 42, # Optional. 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). + "synthesizeSpeechConfig": { # Configuration of how speech should be synthesized. # Optional. Configuration of how speech should be synthesized. If not specified, Agent.text_to_speech_settings is applied. + "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. + "A String", + ], + "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. + "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. + "voice": { # Description of which voice to use for speech synthesis. # Optional. The desired voice of the synthesized audio. + "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. For the list of available voices, please refer to [Supported voices and languages](https://cloud.google.com/text-to-speech/docs/voices). + "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. + }, + "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. + }, + }, + "queryResult": { # Represents the result of a conversational query. # The result of the conversational query. + "advancedSettings": { # Hierarchical advanced settings for agent/flow/page/fulfillment/parameter. Settings exposed at lower level overrides the settings exposed at higher level. Overriding occurs at the sub-setting level. For example, the playback_interruption_settings at fulfillment level only overrides the playback_interruption_settings at the agent level, leaving other settings at the agent level unchanged. DTMF settings does not override each other. DTMF settings set at different levels define DTMF detections running in parallel. Hierarchy: Agent->Flow->Page->Fulfillment/Parameter. # Returns the current advanced settings including IVR settings. Even though the operations configured by these settings are performed by Dialogflow, the client may need to perform special logic at the moment. For example, if Dialogflow exports audio to Google Cloud Storage, then the client may need to wait for the resulting object to appear in the bucket before proceeding. + "audioExportGcsDestination": { # Google Cloud Storage location for a Dialogflow operation that writes or exports objects (e.g. exported agent or transcripts) outside of Dialogflow. # If present, incoming audio is exported by Dialogflow to the configured Google Cloud Storage destination. Exposed at the following levels: - Agent level - Flow level + "uri": "A String", # Required. The Google Cloud Storage URI for the exported objects. A URI is of the form: `gs://bucket/object-name-or-prefix` Whether a full object name, or just a prefix, its usage depends on the Dialogflow operation. + }, + "dtmfSettings": { # Define behaviors for DTMF (dual tone multi frequency). # Settings for DTMF. Exposed at the following levels: - Agent level - Flow level - Page level - Parameter level. + "enabled": True or False, # If true, incoming audio is processed for DTMF (dual tone multi frequency) events. For example, if the caller presses a button on their telephone keypad and DTMF processing is enabled, Dialogflow will detect the event (e.g. a "3" was pressed) in the incoming audio and pass the event to the bot to drive business logic (e.g. when 3 is pressed, return the account balance). + "endpointingTimeoutDuration": "A String", # Endpoint timeout setting for matching dtmf input to regex. + "finishDigit": "A String", # The digit that terminates a DTMF digit sequence. + "interdigitTimeoutDuration": "A String", # Interdigit timeout setting for matching dtmf input to regex. + "maxDigits": 42, # Max length of DTMF digits. + }, + "loggingSettings": { # Define behaviors on logging. # Settings for logging. Settings for Dialogflow History, Contact Center messages, StackDriver logs, and speech logging. Exposed at the following levels: - Agent level. + "enableInteractionLogging": True or False, # Enables DF Interaction logging. + "enableStackdriverLogging": True or False, # Enables StackDriver logging. + }, + "speechSettings": { # Define behaviors of speech to text detection. # Settings for speech to text detection. Exposed at the following levels: - Agent level - Flow level - Page level - Parameter level + "endpointerSensitivity": 42, # Sensitivity of the speech model that detects the end of speech. Scale from 0 to 100. + "models": { # Mapping from language to Speech-to-Text model. The mapped Speech-to-Text model will be selected for requests from its corresponding language. For more information, see [Speech models](https://cloud.google.com/dialogflow/cx/docs/concept/speech-models). + "a_key": "A String", + }, + "noSpeechTimeout": "A String", # Timeout before detecting no speech. + "useTimeoutBasedEndpointing": True or False, # Use timeout based endpointing, interpreting endpointer sensitivy as seconds of timeout value. + }, + }, + "allowAnswerFeedback": True or False, # Indicates whether the Thumbs up/Thumbs down rating controls are need to be shown for the response in the Dialogflow Messenger widget. + "currentFlow": { # Flows represents the conversation flows when you build your chatbot agent. A flow consists of many pages connected by the transition routes. Conversations always start with the built-in Start Flow (with an all-0 ID). Transition routes can direct the conversation session from the current flow (parent flow) to another flow (sub flow). When the sub flow is finished, Dialogflow will bring the session back to the parent flow, where the sub flow is started. Usually, when a transition route is followed by a matched intent, the intent will be "consumed". This means the intent won't activate more transition routes. However, when the followed transition route moves the conversation session into a different flow, the matched intent can be carried over and to be consumed in the target flow. # The current Flow. Some, not all fields are filled in this message, including but not limited to `name` and `display_name`. + "advancedSettings": { # Hierarchical advanced settings for agent/flow/page/fulfillment/parameter. Settings exposed at lower level overrides the settings exposed at higher level. Overriding occurs at the sub-setting level. For example, the playback_interruption_settings at fulfillment level only overrides the playback_interruption_settings at the agent level, leaving other settings at the agent level unchanged. DTMF settings does not override each other. DTMF settings set at different levels define DTMF detections running in parallel. Hierarchy: Agent->Flow->Page->Fulfillment/Parameter. # Hierarchical advanced settings for this flow. The settings exposed at the lower level overrides the settings exposed at the higher level. + "audioExportGcsDestination": { # Google Cloud Storage location for a Dialogflow operation that writes or exports objects (e.g. exported agent or transcripts) outside of Dialogflow. # If present, incoming audio is exported by Dialogflow to the configured Google Cloud Storage destination. Exposed at the following levels: - Agent level - Flow level + "uri": "A String", # Required. The Google Cloud Storage URI for the exported objects. A URI is of the form: `gs://bucket/object-name-or-prefix` Whether a full object name, or just a prefix, its usage depends on the Dialogflow operation. + }, + "dtmfSettings": { # Define behaviors for DTMF (dual tone multi frequency). # Settings for DTMF. Exposed at the following levels: - Agent level - Flow level - Page level - Parameter level. + "enabled": True or False, # If true, incoming audio is processed for DTMF (dual tone multi frequency) events. For example, if the caller presses a button on their telephone keypad and DTMF processing is enabled, Dialogflow will detect the event (e.g. a "3" was pressed) in the incoming audio and pass the event to the bot to drive business logic (e.g. when 3 is pressed, return the account balance). + "endpointingTimeoutDuration": "A String", # Endpoint timeout setting for matching dtmf input to regex. + "finishDigit": "A String", # The digit that terminates a DTMF digit sequence. + "interdigitTimeoutDuration": "A String", # Interdigit timeout setting for matching dtmf input to regex. + "maxDigits": 42, # Max length of DTMF digits. + }, + "loggingSettings": { # Define behaviors on logging. # Settings for logging. Settings for Dialogflow History, Contact Center messages, StackDriver logs, and speech logging. Exposed at the following levels: - Agent level. + "enableInteractionLogging": True or False, # Enables DF Interaction logging. + "enableStackdriverLogging": True or False, # Enables StackDriver logging. + }, + "speechSettings": { # Define behaviors of speech to text detection. # Settings for speech to text detection. Exposed at the following levels: - Agent level - Flow level - Page level - Parameter level + "endpointerSensitivity": 42, # Sensitivity of the speech model that detects the end of speech. Scale from 0 to 100. + "models": { # Mapping from language to Speech-to-Text model. The mapped Speech-to-Text model will be selected for requests from its corresponding language. For more information, see [Speech models](https://cloud.google.com/dialogflow/cx/docs/concept/speech-models). + "a_key": "A String", + }, + "noSpeechTimeout": "A String", # Timeout before detecting no speech. + "useTimeoutBasedEndpointing": True or False, # Use timeout based endpointing, interpreting endpointer sensitivy as seconds of timeout value. + }, + }, + "description": "A String", # The description of the flow. The maximum length is 500 characters. If exceeded, the request is rejected. + "displayName": "A String", # Required. The human-readable name of the flow. + "eventHandlers": [ # A flow's event handlers serve two purposes: * They are responsible for handling events (e.g. no match, webhook errors) in the flow. * They are inherited by every page's event handlers, which can be used to handle common events regardless of the current page. Event handlers defined in the page have higher priority than those defined in the flow. Unlike transition_routes, these handlers are evaluated on a first-match basis. The first one that matches the event get executed, with the rest being ignored. + { # An event handler specifies an event that can be handled during a session. When the specified event happens, the following actions are taken in order: * If there is a `trigger_fulfillment` associated with the event, it will be called. * If there is a `target_page` associated with the event, the session will transition into the specified page. * If there is a `target_flow` associated with the event, the session will transition into the specified flow. + "event": "A String", # Required. The name of the event to handle. + "name": "A String", # Output only. The unique identifier of this event handler. + "targetFlow": "A String", # The target flow to transition to. Format: `projects//locations//agents//flows/`. + "targetPage": "A String", # The target page to transition to. Format: `projects//locations//agents//flows//pages/`. + "triggerFulfillment": { # A fulfillment can do one or more of the following actions at the same time: * Generate rich message responses. * Set parameter values. * Call the webhook. Fulfillments can be called at various stages in the Page or Form lifecycle. For example, when a DetectIntentRequest drives a session to enter a new page, the page's entry fulfillment can add a static response to the QueryResult in the returning DetectIntentResponse, call the webhook (for example, to load user data from a database), or both. # The fulfillment to call when the event occurs. Handling webhook errors with a fulfillment enabled with webhook could cause infinite loop. It is invalid to specify such fulfillment for a handler handling webhooks. + "advancedSettings": { # Hierarchical advanced settings for agent/flow/page/fulfillment/parameter. Settings exposed at lower level overrides the settings exposed at higher level. Overriding occurs at the sub-setting level. For example, the playback_interruption_settings at fulfillment level only overrides the playback_interruption_settings at the agent level, leaving other settings at the agent level unchanged. DTMF settings does not override each other. DTMF settings set at different levels define DTMF detections running in parallel. Hierarchy: Agent->Flow->Page->Fulfillment/Parameter. # Hierarchical advanced settings for this fulfillment. The settings exposed at the lower level overrides the settings exposed at the higher level. + "audioExportGcsDestination": { # Google Cloud Storage location for a Dialogflow operation that writes or exports objects (e.g. exported agent or transcripts) outside of Dialogflow. # If present, incoming audio is exported by Dialogflow to the configured Google Cloud Storage destination. Exposed at the following levels: - Agent level - Flow level + "uri": "A String", # Required. The Google Cloud Storage URI for the exported objects. A URI is of the form: `gs://bucket/object-name-or-prefix` Whether a full object name, or just a prefix, its usage depends on the Dialogflow operation. }, - "endInteraction": { # 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. # Output only. A signal that indicates the interaction with the Dialogflow agent has ended. This message is generated by Dialogflow only when the conversation reaches `END_SESSION` page. It is not supposed to be defined by the user. It's guaranteed that there is at most one such message in each response. + "dtmfSettings": { # Define behaviors for DTMF (dual tone multi frequency). # Settings for DTMF. Exposed at the following levels: - Agent level - Flow level - Page level - Parameter level. + "enabled": True or False, # If true, incoming audio is processed for DTMF (dual tone multi frequency) events. For example, if the caller presses a button on their telephone keypad and DTMF processing is enabled, Dialogflow will detect the event (e.g. a "3" was pressed) in the incoming audio and pass the event to the bot to drive business logic (e.g. when 3 is pressed, return the account balance). + "endpointingTimeoutDuration": "A String", # Endpoint timeout setting for matching dtmf input to regex. + "finishDigit": "A String", # The digit that terminates a DTMF digit sequence. + "interdigitTimeoutDuration": "A String", # Interdigit timeout setting for matching dtmf input to regex. + "maxDigits": 42, # Max length of DTMF digits. }, - "knowledgeInfoCard": { # Represents info card response. If the response contains generative knowledge prediction, Dialogflow will return a payload with Infobot Messenger compatible info card. Otherwise, the info card response is skipped. # Represents info card for knowledge answers, to be better rendered in Dialogflow Messenger. + "loggingSettings": { # Define behaviors on logging. # Settings for logging. Settings for Dialogflow History, Contact Center messages, StackDriver logs, and speech logging. Exposed at the following levels: - Agent level. + "enableInteractionLogging": True or False, # Enables DF Interaction logging. + "enableStackdriverLogging": True or False, # Enables StackDriver logging. }, - "liveAgentHandoff": { # 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. # Hands off conversation to a human agent. - "metadata": { # Custom metadata for your handoff procedure. Dialogflow doesn't impose any structure on this. - "a_key": "", # Properties of the object. + "speechSettings": { # Define behaviors of speech to text detection. # Settings for speech to text detection. Exposed at the following levels: - Agent level - Flow level - Page level - Parameter level + "endpointerSensitivity": 42, # Sensitivity of the speech model that detects the end of speech. Scale from 0 to 100. + "models": { # Mapping from language to Speech-to-Text model. The mapped Speech-to-Text model will be selected for requests from its corresponding language. For more information, see [Speech models](https://cloud.google.com/dialogflow/cx/docs/concept/speech-models). + "a_key": "A String", }, + "noSpeechTimeout": "A String", # Timeout before detecting no speech. + "useTimeoutBasedEndpointing": True or False, # Use timeout based endpointing, interpreting endpointer sensitivy as seconds of timeout value. }, - "mixedAudio": { # 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. # Output only. An audio response message composed of both the synthesized Dialogflow agent responses and responses defined via play_audio. This message is generated by Dialogflow only and not supposed to be defined by the user. - "segments": [ # Segments this audio response is composed of. - { # Represents one segment of audio. - "allowPlaybackInterruption": True or False, # 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. - "audio": "A String", # Raw audio synthesized from the Dialogflow agent's response using the output config specified in the request. - "uri": "A String", # Client-specific URI that points to an audio clip accessible to the client. Dialogflow does not impose any validation on it. - }, - ], - }, - "outputAudioText": { # A text or ssml response that is preferentially used for TTS output audio synthesis, as described in the comment on the ResponseMessage message. # A text or ssml response that is preferentially used for TTS output audio synthesis, as described in the comment on the ResponseMessage message. - "allowPlaybackInterruption": True or False, # 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. - "ssml": "A String", # The SSML text to be synthesized. For more information, see [SSML](/speech/text-to-speech/docs/ssml). - "text": "A String", # The raw text to be synthesized. - }, - "payload": { # Returns a response containing a custom, platform-specific payload. - "a_key": "", # Properties of the object. - }, - "playAudio": { # Specifies an audio clip to be played by the client as part of the response. # Signal that the client should play an audio clip hosted at a client-specific URI. Dialogflow uses this to construct mixed_audio. However, Dialogflow itself does not try to read or process the URI in any way. - "allowPlaybackInterruption": True or False, # 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. - "audioUri": "A String", # Required. URI of the audio clip. Dialogflow does not impose any validation on this value. It is specific to the client that reads it. - }, - "telephonyTransferCall": { # Represents the signal that telles the client to transfer the phone call connected to the agent to a third-party endpoint. # A signal that the client should transfer the phone call connected to this agent to a third-party endpoint. - "phoneNumber": "A String", # Transfer the call to a phone number in [E.164 format](https://en.wikipedia.org/wiki/E.164). - }, - "text": { # The text response message. # Returns a text response. - "allowPlaybackInterruption": True or False, # 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. - "text": [ # Required. A collection of text responses. - "A String", - ], - }, - }, - ], - "returnPartialResponses": True or False, # Whether Dialogflow should return currently queued fulfillment response messages in streaming APIs. If a webhook is specified, it happens before Dialogflow invokes webhook. Warning: 1) This flag only affects streaming API. Responses are still queued and returned once in non-streaming API. 2) The flag can be enabled in any fulfillment but only the first 3 partial responses will be returned. You may only want to apply it to fulfillments that have slow webhooks. - "setParameterActions": [ # Set parameter values before executing the webhook. - { # Setting a parameter value. - "parameter": "A String", # Display name of the parameter. - "value": "", # The new value of the parameter. A null value clears the parameter. }, - ], - "tag": "A String", # The value of this field will be populated in the WebhookRequest `fulfillmentInfo.tag` field by Dialogflow when the associated webhook is called. The tag is typically used by the webhook service to identify which fulfillment is being called, but it could be used for other purposes. This field is required if `webhook` is specified. - "webhook": "A String", # The webhook to call. Format: `projects//locations//agents//webhooks/`. - }, - "repromptEventHandlers": [ # The handlers for parameter-level events, used to provide reprompt for the parameter or transition to a different page/flow. The supported events are: * `sys.no-match-`, where N can be from 1 to 6 * `sys.no-match-default` * `sys.no-input-`, where N can be from 1 to 6 * `sys.no-input-default` * `sys.invalid-parameter` `initial_prompt_fulfillment` provides the first prompt for the parameter. If the user's response does not fill the parameter, a no-match/no-input event will be triggered, and the fulfillment associated with the `sys.no-match-1`/`sys.no-input-1` handler (if defined) will be called to provide a prompt. The `sys.no-match-2`/`sys.no-input-2` handler (if defined) will respond to the next no-match/no-input event, and so on. A `sys.no-match-default` or `sys.no-input-default` handler will be used to handle all following no-match/no-input events after all numbered no-match/no-input handlers for the parameter are consumed. A `sys.invalid-parameter` handler can be defined to handle the case where the parameter values have been `invalidated` by webhook. For example, if the user's response fill the parameter, however the parameter was invalidated by webhook, the fulfillment associated with the `sys.invalid-parameter` handler (if defined) will be called to provide a prompt. If the event handler for the corresponding event can't be found on the parameter, `initial_prompt_fulfillment` will be re-prompted. - { # An event handler specifies an event that can be handled during a session. When the specified event happens, the following actions are taken in order: * If there is a `trigger_fulfillment` associated with the event, it will be called. * If there is a `target_page` associated with the event, the session will transition into the specified page. * If there is a `target_flow` associated with the event, the session will transition into the specified flow. - "event": "A String", # Required. The name of the event to handle. - "name": "A String", # Output only. The unique identifier of this event handler. - "targetFlow": "A String", # The target flow to transition to. Format: `projects//locations//agents//flows/`. - "targetPage": "A String", # The target page to transition to. Format: `projects//locations//agents//flows//pages/`. - "triggerFulfillment": { # A fulfillment can do one or more of the following actions at the same time: * Generate rich message responses. * Set parameter values. * Call the webhook. Fulfillments can be called at various stages in the Page or Form lifecycle. For example, when a DetectIntentRequest drives a session to enter a new page, the page's entry fulfillment can add a static response to the QueryResult in the returning DetectIntentResponse, call the webhook (for example, to load user data from a database), or both. # The fulfillment to call when the event occurs. Handling webhook errors with a fulfillment enabled with webhook could cause infinite loop. It is invalid to specify such fulfillment for a handler handling webhooks. - "advancedSettings": { # Hierarchical advanced settings for agent/flow/page/fulfillment/parameter. Settings exposed at lower level overrides the settings exposed at higher level. Overriding occurs at the sub-setting level. For example, the playback_interruption_settings at fulfillment level only overrides the playback_interruption_settings at the agent level, leaving other settings at the agent level unchanged. DTMF settings does not override each other. DTMF settings set at different levels define DTMF detections running in parallel. Hierarchy: Agent->Flow->Page->Fulfillment/Parameter. # Hierarchical advanced settings for this fulfillment. The settings exposed at the lower level overrides the settings exposed at the higher level. - "audioExportGcsDestination": { # Google Cloud Storage location for a Dialogflow operation that writes or exports objects (e.g. exported agent or transcripts) outside of Dialogflow. # If present, incoming audio is exported by Dialogflow to the configured Google Cloud Storage destination. Exposed at the following levels: - Agent level - Flow level - "uri": "A String", # Required. The Google Cloud Storage URI for the exported objects. A URI is of the form: `gs://bucket/object-name-or-prefix` Whether a full object name, or just a prefix, its usage depends on the Dialogflow operation. - }, - "dtmfSettings": { # Define behaviors for DTMF (dual tone multi frequency). # Settings for DTMF. Exposed at the following levels: - Agent level - Flow level - Page level - Parameter level. - "enabled": True or False, # If true, incoming audio is processed for DTMF (dual tone multi frequency) events. For example, if the caller presses a button on their telephone keypad and DTMF processing is enabled, Dialogflow will detect the event (e.g. a "3" was pressed) in the incoming audio and pass the event to the bot to drive business logic (e.g. when 3 is pressed, return the account balance). - "endpointingTimeoutDuration": "A String", # Endpoint timeout setting for matching dtmf input to regex. - "finishDigit": "A String", # The digit that terminates a DTMF digit sequence. - "interdigitTimeoutDuration": "A String", # Interdigit timeout setting for matching dtmf input to regex. - "maxDigits": 42, # Max length of DTMF digits. - }, - "loggingSettings": { # Define behaviors on logging. # Settings for logging. Settings for Dialogflow History, Contact Center messages, StackDriver logs, and speech logging. Exposed at the following levels: - Agent level. - "enableInteractionLogging": True or False, # If true, DF Interaction logging is currently enabled. - "enableStackdriverLogging": True or False, # If true, StackDriver logging is currently enabled. - }, - "speechSettings": { # Define behaviors of speech to text detection. # Settings for speech to text detection. Exposed at the following levels: - Agent level - Flow level - Page level - Parameter level - "endpointerSensitivity": 42, # Sensitivity of the speech model that detects the end of speech. Scale from 0 to 100. - "models": { # Mapping from language to Speech-to-Text model. The mapped Speech-to-Text model will be selected for requests from its corresponding language. For more information, see [Speech models](https://cloud.google.com/dialogflow/cx/docs/concept/speech-models). - "a_key": "A String", - }, - "noSpeechTimeout": "A String", # Timeout before detecting no speech. - "useTimeoutBasedEndpointing": True or False, # Use timeout based endpointing, interpreting endpointer sensitivy as seconds of timeout value. - }, - }, - "conditionalCases": [ # Conditional cases for this fulfillment. - { # A list of cascading if-else conditions. Cases are mutually exclusive. The first one with a matching condition is selected, all the rest ignored. - "cases": [ # A list of cascading if-else conditions. - { # Each case has a Boolean condition. When it is evaluated to be True, the corresponding messages will be selected and evaluated recursively. - "caseContent": [ # A list of case content. - { # The list of messages or conditional cases to activate for this case. - "additionalCases": # Object with schema name: GoogleCloudDialogflowCxV3beta1FulfillmentConditionalCases # Additional cases to be evaluated. - "message": { # 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. # Returned message. - "channel": "A String", # The channel which the response is associated with. Clients can specify the channel via QueryParameters.channel, and only associated channel response will be returned. - "conversationSuccess": { # 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. # Indicates that the conversation succeeded. - "metadata": { # Custom metadata. Dialogflow doesn't impose any structure on this. - "a_key": "", # Properties of the object. - }, - }, - "endInteraction": { # 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. # Output only. A signal that indicates the interaction with the Dialogflow agent has ended. This message is generated by Dialogflow only when the conversation reaches `END_SESSION` page. It is not supposed to be defined by the user. It's guaranteed that there is at most one such message in each response. + "conditionalCases": [ # Conditional cases for this fulfillment. + { # A list of cascading if-else conditions. Cases are mutually exclusive. The first one with a matching condition is selected, all the rest ignored. + "cases": [ # A list of cascading if-else conditions. + { # Each case has a Boolean condition. When it is evaluated to be True, the corresponding messages will be selected and evaluated recursively. + "caseContent": [ # A list of case content. + { # The list of messages or conditional cases to activate for this case. + "additionalCases": # Object with schema name: GoogleCloudDialogflowCxV3beta1FulfillmentConditionalCases # Additional cases to be evaluated. + "message": { # 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. # Returned message. + "channel": "A String", # The channel which the response is associated with. Clients can specify the channel via QueryParameters.channel, and only associated channel response will be returned. + "conversationSuccess": { # 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. # Indicates that the conversation succeeded. + "metadata": { # Custom metadata. Dialogflow doesn't impose any structure on this. + "a_key": "", # Properties of the object. }, - "knowledgeInfoCard": { # Represents info card response. If the response contains generative knowledge prediction, Dialogflow will return a payload with Infobot Messenger compatible info card. Otherwise, the info card response is skipped. # Represents info card for knowledge answers, to be better rendered in Dialogflow Messenger. + }, + "endInteraction": { # 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. # Output only. A signal that indicates the interaction with the Dialogflow agent has ended. This message is generated by Dialogflow only when the conversation reaches `END_SESSION` page. It is not supposed to be defined by the user. It's guaranteed that there is at most one such message in each response. + }, + "knowledgeInfoCard": { # Represents info card response. If the response contains generative knowledge prediction, Dialogflow will return a payload with Infobot Messenger compatible info card. Otherwise, the info card response is skipped. # Represents info card for knowledge answers, to be better rendered in Dialogflow Messenger. + }, + "liveAgentHandoff": { # 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. # Hands off conversation to a human agent. + "metadata": { # Custom metadata for your handoff procedure. Dialogflow doesn't impose any structure on this. + "a_key": "", # Properties of the object. }, - "liveAgentHandoff": { # 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. # Hands off conversation to a human agent. - "metadata": { # Custom metadata for your handoff procedure. Dialogflow doesn't impose any structure on this. - "a_key": "", # Properties of the object. + }, + "mixedAudio": { # 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. # Output only. An audio response message composed of both the synthesized Dialogflow agent responses and responses defined via play_audio. This message is generated by Dialogflow only and not supposed to be defined by the user. + "segments": [ # Segments this audio response is composed of. + { # Represents one segment of audio. + "allowPlaybackInterruption": True or False, # 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. + "audio": "A String", # Raw audio synthesized from the Dialogflow agent's response using the output config specified in the request. + "uri": "A String", # Client-specific URI that points to an audio clip accessible to the client. Dialogflow does not impose any validation on it. }, - }, - "mixedAudio": { # 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. # Output only. An audio response message composed of both the synthesized Dialogflow agent responses and responses defined via play_audio. This message is generated by Dialogflow only and not supposed to be defined by the user. - "segments": [ # Segments this audio response is composed of. - { # Represents one segment of audio. - "allowPlaybackInterruption": True or False, # 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. - "audio": "A String", # Raw audio synthesized from the Dialogflow agent's response using the output config specified in the request. - "uri": "A String", # Client-specific URI that points to an audio clip accessible to the client. Dialogflow does not impose any validation on it. - }, - ], - }, - "outputAudioText": { # A text or ssml response that is preferentially used for TTS output audio synthesis, as described in the comment on the ResponseMessage message. # A text or ssml response that is preferentially used for TTS output audio synthesis, as described in the comment on the ResponseMessage message. - "allowPlaybackInterruption": True or False, # 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. - "ssml": "A String", # The SSML text to be synthesized. For more information, see [SSML](/speech/text-to-speech/docs/ssml). - "text": "A String", # The raw text to be synthesized. - }, - "payload": { # Returns a response containing a custom, platform-specific payload. + ], + }, + "outputAudioText": { # A text or ssml response that is preferentially used for TTS output audio synthesis, as described in the comment on the ResponseMessage message. # A text or ssml response that is preferentially used for TTS output audio synthesis, as described in the comment on the ResponseMessage message. + "allowPlaybackInterruption": True or False, # 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. + "ssml": "A String", # The SSML text to be synthesized. For more information, see [SSML](/speech/text-to-speech/docs/ssml). + "text": "A String", # The raw text to be synthesized. + }, + "payload": { # Returns a response containing a custom, platform-specific payload. + "a_key": "", # Properties of the object. + }, + "playAudio": { # Specifies an audio clip to be played by the client as part of the response. # Signal that the client should play an audio clip hosted at a client-specific URI. Dialogflow uses this to construct mixed_audio. However, Dialogflow itself does not try to read or process the URI in any way. + "allowPlaybackInterruption": True or False, # 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. + "audioUri": "A String", # Required. URI of the audio clip. Dialogflow does not impose any validation on this value. It is specific to the client that reads it. + }, + "telephonyTransferCall": { # Represents the signal that telles the client to transfer the phone call connected to the agent to a third-party endpoint. # A signal that the client should transfer the phone call connected to this agent to a third-party endpoint. + "phoneNumber": "A String", # Transfer the call to a phone number in [E.164 format](https://en.wikipedia.org/wiki/E.164). + }, + "text": { # The text response message. # Returns a text response. + "allowPlaybackInterruption": True or False, # 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. + "text": [ # Required. A collection of text responses. + "A String", + ], + }, + "toolCall": { # Represents a call of a specific tool's action with the specified inputs. # Returns the definition of a tool call that should be executed by the client. + "action": "A String", # Required. The name of the tool's action associated with this call. + "inputParameters": { # Optional. The action's input parameters. "a_key": "", # Properties of the object. }, - "playAudio": { # Specifies an audio clip to be played by the client as part of the response. # Signal that the client should play an audio clip hosted at a client-specific URI. Dialogflow uses this to construct mixed_audio. However, Dialogflow itself does not try to read or process the URI in any way. - "allowPlaybackInterruption": True or False, # 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. - "audioUri": "A String", # Required. URI of the audio clip. Dialogflow does not impose any validation on this value. It is specific to the client that reads it. - }, - "telephonyTransferCall": { # Represents the signal that telles the client to transfer the phone call connected to the agent to a third-party endpoint. # A signal that the client should transfer the phone call connected to this agent to a third-party endpoint. - "phoneNumber": "A String", # Transfer the call to a phone number in [E.164 format](https://en.wikipedia.org/wiki/E.164). - }, - "text": { # The text response message. # Returns a text response. - "allowPlaybackInterruption": True or False, # 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. - "text": [ # Required. A collection of text responses. - "A String", - ], - }, + "tool": "A String", # Required. The tool associated with this call. Format: `projects//locations//agents//tools/`. }, }, - ], - "condition": "A String", # The condition to activate and select this case. Empty means the condition is always true. The condition is evaluated against form parameters or session parameters. See the [conditions reference](https://cloud.google.com/dialogflow/cx/docs/reference/condition). - }, - ], - }, - ], - "enableGenerativeFallback": True or False, # If the flag is true, the agent will utilize LLM to generate a text response. If LLM generation fails, the defined responses in the fulfillment will be respected. This flag is only useful for fulfillments associated with no-match event handlers. - "messages": [ # The list of rich message responses to present to the user. - { # 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. - "channel": "A String", # The channel which the response is associated with. Clients can specify the channel via QueryParameters.channel, and only associated channel response will be returned. - "conversationSuccess": { # 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. # Indicates that the conversation succeeded. - "metadata": { # Custom metadata. Dialogflow doesn't impose any structure on this. - "a_key": "", # Properties of the object. - }, - }, - "endInteraction": { # 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. # Output only. A signal that indicates the interaction with the Dialogflow agent has ended. This message is generated by Dialogflow only when the conversation reaches `END_SESSION` page. It is not supposed to be defined by the user. It's guaranteed that there is at most one such message in each response. - }, - "knowledgeInfoCard": { # Represents info card response. If the response contains generative knowledge prediction, Dialogflow will return a payload with Infobot Messenger compatible info card. Otherwise, the info card response is skipped. # Represents info card for knowledge answers, to be better rendered in Dialogflow Messenger. - }, - "liveAgentHandoff": { # 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. # Hands off conversation to a human agent. - "metadata": { # Custom metadata for your handoff procedure. Dialogflow doesn't impose any structure on this. - "a_key": "", # Properties of the object. - }, - }, - "mixedAudio": { # 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. # Output only. An audio response message composed of both the synthesized Dialogflow agent responses and responses defined via play_audio. This message is generated by Dialogflow only and not supposed to be defined by the user. - "segments": [ # Segments this audio response is composed of. - { # Represents one segment of audio. - "allowPlaybackInterruption": True or False, # 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. - "audio": "A String", # Raw audio synthesized from the Dialogflow agent's response using the output config specified in the request. - "uri": "A String", # Client-specific URI that points to an audio clip accessible to the client. Dialogflow does not impose any validation on it. }, ], + "condition": "A String", # The condition to activate and select this case. Empty means the condition is always true. The condition is evaluated against form parameters or session parameters. See the [conditions reference](https://cloud.google.com/dialogflow/cx/docs/reference/condition). }, - "outputAudioText": { # A text or ssml response that is preferentially used for TTS output audio synthesis, as described in the comment on the ResponseMessage message. # A text or ssml response that is preferentially used for TTS output audio synthesis, as described in the comment on the ResponseMessage message. - "allowPlaybackInterruption": True or False, # 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. - "ssml": "A String", # The SSML text to be synthesized. For more information, see [SSML](/speech/text-to-speech/docs/ssml). - "text": "A String", # The raw text to be synthesized. - }, - "payload": { # Returns a response containing a custom, platform-specific payload. + ], + }, + ], + "enableGenerativeFallback": True or False, # If the flag is true, the agent will utilize LLM to generate a text response. If LLM generation fails, the defined responses in the fulfillment will be respected. This flag is only useful for fulfillments associated with no-match event handlers. + "messages": [ # The list of rich message responses to present to the user. + { # 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. + "channel": "A String", # The channel which the response is associated with. Clients can specify the channel via QueryParameters.channel, and only associated channel response will be returned. + "conversationSuccess": { # 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. # Indicates that the conversation succeeded. + "metadata": { # Custom metadata. Dialogflow doesn't impose any structure on this. "a_key": "", # Properties of the object. }, - "playAudio": { # Specifies an audio clip to be played by the client as part of the response. # Signal that the client should play an audio clip hosted at a client-specific URI. Dialogflow uses this to construct mixed_audio. However, Dialogflow itself does not try to read or process the URI in any way. - "allowPlaybackInterruption": True or False, # 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. - "audioUri": "A String", # Required. URI of the audio clip. Dialogflow does not impose any validation on this value. It is specific to the client that reads it. - }, - "telephonyTransferCall": { # Represents the signal that telles the client to transfer the phone call connected to the agent to a third-party endpoint. # A signal that the client should transfer the phone call connected to this agent to a third-party endpoint. - "phoneNumber": "A String", # Transfer the call to a phone number in [E.164 format](https://en.wikipedia.org/wiki/E.164). - }, - "text": { # The text response message. # Returns a text response. - "allowPlaybackInterruption": True or False, # 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. - "text": [ # Required. A collection of text responses. - "A String", - ], + }, + "endInteraction": { # 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. # Output only. A signal that indicates the interaction with the Dialogflow agent has ended. This message is generated by Dialogflow only when the conversation reaches `END_SESSION` page. It is not supposed to be defined by the user. It's guaranteed that there is at most one such message in each response. + }, + "knowledgeInfoCard": { # Represents info card response. If the response contains generative knowledge prediction, Dialogflow will return a payload with Infobot Messenger compatible info card. Otherwise, the info card response is skipped. # Represents info card for knowledge answers, to be better rendered in Dialogflow Messenger. + }, + "liveAgentHandoff": { # 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. # Hands off conversation to a human agent. + "metadata": { # Custom metadata for your handoff procedure. Dialogflow doesn't impose any structure on this. + "a_key": "", # Properties of the object. }, }, - ], - "returnPartialResponses": True or False, # Whether Dialogflow should return currently queued fulfillment response messages in streaming APIs. If a webhook is specified, it happens before Dialogflow invokes webhook. Warning: 1) This flag only affects streaming API. Responses are still queued and returned once in non-streaming API. 2) The flag can be enabled in any fulfillment but only the first 3 partial responses will be returned. You may only want to apply it to fulfillments that have slow webhooks. - "setParameterActions": [ # Set parameter values before executing the webhook. - { # Setting a parameter value. - "parameter": "A String", # Display name of the parameter. - "value": "", # The new value of the parameter. A null value clears the parameter. + "mixedAudio": { # 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. # Output only. An audio response message composed of both the synthesized Dialogflow agent responses and responses defined via play_audio. This message is generated by Dialogflow only and not supposed to be defined by the user. + "segments": [ # Segments this audio response is composed of. + { # Represents one segment of audio. + "allowPlaybackInterruption": True or False, # 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. + "audio": "A String", # Raw audio synthesized from the Dialogflow agent's response using the output config specified in the request. + "uri": "A String", # Client-specific URI that points to an audio clip accessible to the client. Dialogflow does not impose any validation on it. + }, + ], }, - ], - "tag": "A String", # The value of this field will be populated in the WebhookRequest `fulfillmentInfo.tag` field by Dialogflow when the associated webhook is called. The tag is typically used by the webhook service to identify which fulfillment is being called, but it could be used for other purposes. This field is required if `webhook` is specified. - "webhook": "A String", # The webhook to call. Format: `projects//locations//agents//webhooks/`. - }, + "outputAudioText": { # A text or ssml response that is preferentially used for TTS output audio synthesis, as described in the comment on the ResponseMessage message. # A text or ssml response that is preferentially used for TTS output audio synthesis, as described in the comment on the ResponseMessage message. + "allowPlaybackInterruption": True or False, # 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. + "ssml": "A String", # The SSML text to be synthesized. For more information, see [SSML](/speech/text-to-speech/docs/ssml). + "text": "A String", # The raw text to be synthesized. + }, + "payload": { # Returns a response containing a custom, platform-specific payload. + "a_key": "", # Properties of the object. + }, + "playAudio": { # Specifies an audio clip to be played by the client as part of the response. # Signal that the client should play an audio clip hosted at a client-specific URI. Dialogflow uses this to construct mixed_audio. However, Dialogflow itself does not try to read or process the URI in any way. + "allowPlaybackInterruption": True or False, # 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. + "audioUri": "A String", # Required. URI of the audio clip. Dialogflow does not impose any validation on this value. It is specific to the client that reads it. + }, + "telephonyTransferCall": { # Represents the signal that telles the client to transfer the phone call connected to the agent to a third-party endpoint. # A signal that the client should transfer the phone call connected to this agent to a third-party endpoint. + "phoneNumber": "A String", # Transfer the call to a phone number in [E.164 format](https://en.wikipedia.org/wiki/E.164). + }, + "text": { # The text response message. # Returns a text response. + "allowPlaybackInterruption": True or False, # 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. + "text": [ # Required. A collection of text responses. + "A String", + ], + }, + "toolCall": { # Represents a call of a specific tool's action with the specified inputs. # Returns the definition of a tool call that should be executed by the client. + "action": "A String", # Required. The name of the tool's action associated with this call. + "inputParameters": { # Optional. The action's input parameters. + "a_key": "", # Properties of the object. + }, + "tool": "A String", # Required. The tool associated with this call. Format: `projects//locations//agents//tools/`. + }, + }, + ], + "returnPartialResponses": True or False, # Whether Dialogflow should return currently queued fulfillment response messages in streaming APIs. If a webhook is specified, it happens before Dialogflow invokes webhook. Warning: 1) This flag only affects streaming API. Responses are still queued and returned once in non-streaming API. 2) The flag can be enabled in any fulfillment but only the first 3 partial responses will be returned. You may only want to apply it to fulfillments that have slow webhooks. + "setParameterActions": [ # Set parameter values before executing the webhook. + { # Setting a parameter value. + "parameter": "A String", # Display name of the parameter. + "value": "", # The new value of the parameter. A null value clears the parameter. + }, + ], + "tag": "A String", # The value of this field will be populated in the WebhookRequest `fulfillmentInfo.tag` field by Dialogflow when the associated webhook is called. The tag is typically used by the webhook service to identify which fulfillment is being called, but it could be used for other purposes. This field is required if `webhook` is specified. + "webhook": "A String", # The webhook to call. Format: `projects//locations//agents//webhooks/`. + }, + }, + ], + "knowledgeConnectorSettings": { # The Knowledge Connector settings for this page or flow. This includes information such as the attached Knowledge Bases, and the way to execute fulfillment. # Optional. Knowledge connector configuration. + "dataStoreConnections": [ # Optional. List of related data store connections. + { # A data store connection. It represents a data store in Discovery Engine and the type of the contents it contains. + "dataStore": "A String", # The full name of the referenced data store. Formats: `projects/{project}/locations/{location}/collections/{collection}/dataStores/{data_store}` `projects/{project}/locations/{location}/dataStores/{data_store}` + "dataStoreType": "A String", # The type of the connected data store. }, ], - }, - "isList": True or False, # Indicates whether the parameter represents a list of values. - "redact": True or False, # Indicates whether the parameter content should be redacted in log. If redaction is enabled, the parameter content will be replaced by parameter name during logging. Note: the parameter content is subject to redaction if either parameter level redaction or entity type level redaction is enabled. - "required": True or False, # 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. - }, - ], - }, - "knowledgeConnectorSettings": { # The Knowledge Connector settings for this page or flow. This includes information such as the attached Knowledge Bases, and the way to execute fulfillment. # Optional. Knowledge connector configuration. - "dataStoreConnections": [ # Optional. List of related data store connections. - { # A data store connection. It represents a data store in Discovery Engine and the type of the contents it contains. - "dataStore": "A String", # The full name of the referenced data store. Formats: `projects/{project}/locations/{location}/collections/{collection}/dataStores/{data_store}` `projects/{project}/locations/{location}/dataStores/{data_store}` - "dataStoreType": "A String", # The type of the connected data store. - }, - ], - "enabled": True or False, # Whether Knowledge Connector is enabled or not. - "targetFlow": "A String", # The target flow to transition to. Format: `projects//locations//agents//flows/`. - "targetPage": "A String", # The target page to transition to. Format: `projects//locations//agents//flows//pages/`. - "triggerFulfillment": { # A fulfillment can do one or more of the following actions at the same time: * Generate rich message responses. * Set parameter values. * Call the webhook. Fulfillments can be called at various stages in the Page or Form lifecycle. For example, when a DetectIntentRequest drives a session to enter a new page, the page's entry fulfillment can add a static response to the QueryResult in the returning DetectIntentResponse, call the webhook (for example, to load user data from a database), or both. # The fulfillment to be triggered. When the answers from the Knowledge Connector are selected by Dialogflow, you can utitlize the request scoped parameter `$request.knowledge.answers` (contains up to the 5 highest confidence answers) and `$request.knowledge.questions` (contains the corresponding questions) to construct the fulfillment. - "advancedSettings": { # Hierarchical advanced settings for agent/flow/page/fulfillment/parameter. Settings exposed at lower level overrides the settings exposed at higher level. Overriding occurs at the sub-setting level. For example, the playback_interruption_settings at fulfillment level only overrides the playback_interruption_settings at the agent level, leaving other settings at the agent level unchanged. DTMF settings does not override each other. DTMF settings set at different levels define DTMF detections running in parallel. Hierarchy: Agent->Flow->Page->Fulfillment/Parameter. # Hierarchical advanced settings for this fulfillment. The settings exposed at the lower level overrides the settings exposed at the higher level. - "audioExportGcsDestination": { # Google Cloud Storage location for a Dialogflow operation that writes or exports objects (e.g. exported agent or transcripts) outside of Dialogflow. # If present, incoming audio is exported by Dialogflow to the configured Google Cloud Storage destination. Exposed at the following levels: - Agent level - Flow level - "uri": "A String", # Required. The Google Cloud Storage URI for the exported objects. A URI is of the form: `gs://bucket/object-name-or-prefix` Whether a full object name, or just a prefix, its usage depends on the Dialogflow operation. - }, - "dtmfSettings": { # Define behaviors for DTMF (dual tone multi frequency). # Settings for DTMF. Exposed at the following levels: - Agent level - Flow level - Page level - Parameter level. - "enabled": True or False, # If true, incoming audio is processed for DTMF (dual tone multi frequency) events. For example, if the caller presses a button on their telephone keypad and DTMF processing is enabled, Dialogflow will detect the event (e.g. a "3" was pressed) in the incoming audio and pass the event to the bot to drive business logic (e.g. when 3 is pressed, return the account balance). - "endpointingTimeoutDuration": "A String", # Endpoint timeout setting for matching dtmf input to regex. - "finishDigit": "A String", # The digit that terminates a DTMF digit sequence. - "interdigitTimeoutDuration": "A String", # Interdigit timeout setting for matching dtmf input to regex. - "maxDigits": 42, # Max length of DTMF digits. - }, - "loggingSettings": { # Define behaviors on logging. # Settings for logging. Settings for Dialogflow History, Contact Center messages, StackDriver logs, and speech logging. Exposed at the following levels: - Agent level. - "enableInteractionLogging": True or False, # If true, DF Interaction logging is currently enabled. - "enableStackdriverLogging": True or False, # If true, StackDriver logging is currently enabled. - }, - "speechSettings": { # Define behaviors of speech to text detection. # Settings for speech to text detection. Exposed at the following levels: - Agent level - Flow level - Page level - Parameter level - "endpointerSensitivity": 42, # Sensitivity of the speech model that detects the end of speech. Scale from 0 to 100. - "models": { # Mapping from language to Speech-to-Text model. The mapped Speech-to-Text model will be selected for requests from its corresponding language. For more information, see [Speech models](https://cloud.google.com/dialogflow/cx/docs/concept/speech-models). - "a_key": "A String", - }, - "noSpeechTimeout": "A String", # Timeout before detecting no speech. - "useTimeoutBasedEndpointing": True or False, # Use timeout based endpointing, interpreting endpointer sensitivy as seconds of timeout value. - }, - }, - "conditionalCases": [ # Conditional cases for this fulfillment. - { # A list of cascading if-else conditions. Cases are mutually exclusive. The first one with a matching condition is selected, all the rest ignored. - "cases": [ # A list of cascading if-else conditions. - { # Each case has a Boolean condition. When it is evaluated to be True, the corresponding messages will be selected and evaluated recursively. - "caseContent": [ # A list of case content. - { # The list of messages or conditional cases to activate for this case. - "additionalCases": # Object with schema name: GoogleCloudDialogflowCxV3beta1FulfillmentConditionalCases # Additional cases to be evaluated. - "message": { # 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. # Returned message. - "channel": "A String", # The channel which the response is associated with. Clients can specify the channel via QueryParameters.channel, and only associated channel response will be returned. - "conversationSuccess": { # 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. # Indicates that the conversation succeeded. - "metadata": { # Custom metadata. Dialogflow doesn't impose any structure on this. - "a_key": "", # Properties of the object. - }, - }, - "endInteraction": { # 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. # Output only. A signal that indicates the interaction with the Dialogflow agent has ended. This message is generated by Dialogflow only when the conversation reaches `END_SESSION` page. It is not supposed to be defined by the user. It's guaranteed that there is at most one such message in each response. - }, - "knowledgeInfoCard": { # Represents info card response. If the response contains generative knowledge prediction, Dialogflow will return a payload with Infobot Messenger compatible info card. Otherwise, the info card response is skipped. # Represents info card for knowledge answers, to be better rendered in Dialogflow Messenger. - }, - "liveAgentHandoff": { # 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. # Hands off conversation to a human agent. - "metadata": { # Custom metadata for your handoff procedure. Dialogflow doesn't impose any structure on this. - "a_key": "", # Properties of the object. - }, - }, - "mixedAudio": { # 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. # Output only. An audio response message composed of both the synthesized Dialogflow agent responses and responses defined via play_audio. This message is generated by Dialogflow only and not supposed to be defined by the user. - "segments": [ # Segments this audio response is composed of. - { # Represents one segment of audio. - "allowPlaybackInterruption": True or False, # 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. - "audio": "A String", # Raw audio synthesized from the Dialogflow agent's response using the output config specified in the request. - "uri": "A String", # Client-specific URI that points to an audio clip accessible to the client. Dialogflow does not impose any validation on it. + "enabled": True or False, # Whether Knowledge Connector is enabled or not. + "targetFlow": "A String", # The target flow to transition to. Format: `projects//locations//agents//flows/`. + "targetPage": "A String", # The target page to transition to. Format: `projects//locations//agents//flows//pages/`. + "triggerFulfillment": { # A fulfillment can do one or more of the following actions at the same time: * Generate rich message responses. * Set parameter values. * Call the webhook. Fulfillments can be called at various stages in the Page or Form lifecycle. For example, when a DetectIntentRequest drives a session to enter a new page, the page's entry fulfillment can add a static response to the QueryResult in the returning DetectIntentResponse, call the webhook (for example, to load user data from a database), or both. # The fulfillment to be triggered. When the answers from the Knowledge Connector are selected by Dialogflow, you can utitlize the request scoped parameter `$request.knowledge.answers` (contains up to the 5 highest confidence answers) and `$request.knowledge.questions` (contains the corresponding questions) to construct the fulfillment. + "advancedSettings": { # Hierarchical advanced settings for agent/flow/page/fulfillment/parameter. Settings exposed at lower level overrides the settings exposed at higher level. Overriding occurs at the sub-setting level. For example, the playback_interruption_settings at fulfillment level only overrides the playback_interruption_settings at the agent level, leaving other settings at the agent level unchanged. DTMF settings does not override each other. DTMF settings set at different levels define DTMF detections running in parallel. Hierarchy: Agent->Flow->Page->Fulfillment/Parameter. # Hierarchical advanced settings for this fulfillment. The settings exposed at the lower level overrides the settings exposed at the higher level. + "audioExportGcsDestination": { # Google Cloud Storage location for a Dialogflow operation that writes or exports objects (e.g. exported agent or transcripts) outside of Dialogflow. # If present, incoming audio is exported by Dialogflow to the configured Google Cloud Storage destination. Exposed at the following levels: - Agent level - Flow level + "uri": "A String", # Required. The Google Cloud Storage URI for the exported objects. A URI is of the form: `gs://bucket/object-name-or-prefix` Whether a full object name, or just a prefix, its usage depends on the Dialogflow operation. + }, + "dtmfSettings": { # Define behaviors for DTMF (dual tone multi frequency). # Settings for DTMF. Exposed at the following levels: - Agent level - Flow level - Page level - Parameter level. + "enabled": True or False, # If true, incoming audio is processed for DTMF (dual tone multi frequency) events. For example, if the caller presses a button on their telephone keypad and DTMF processing is enabled, Dialogflow will detect the event (e.g. a "3" was pressed) in the incoming audio and pass the event to the bot to drive business logic (e.g. when 3 is pressed, return the account balance). + "endpointingTimeoutDuration": "A String", # Endpoint timeout setting for matching dtmf input to regex. + "finishDigit": "A String", # The digit that terminates a DTMF digit sequence. + "interdigitTimeoutDuration": "A String", # Interdigit timeout setting for matching dtmf input to regex. + "maxDigits": 42, # Max length of DTMF digits. + }, + "loggingSettings": { # Define behaviors on logging. # Settings for logging. Settings for Dialogflow History, Contact Center messages, StackDriver logs, and speech logging. Exposed at the following levels: - Agent level. + "enableInteractionLogging": True or False, # Enables DF Interaction logging. + "enableStackdriverLogging": True or False, # Enables StackDriver logging. + }, + "speechSettings": { # Define behaviors of speech to text detection. # Settings for speech to text detection. Exposed at the following levels: - Agent level - Flow level - Page level - Parameter level + "endpointerSensitivity": 42, # Sensitivity of the speech model that detects the end of speech. Scale from 0 to 100. + "models": { # Mapping from language to Speech-to-Text model. The mapped Speech-to-Text model will be selected for requests from its corresponding language. For more information, see [Speech models](https://cloud.google.com/dialogflow/cx/docs/concept/speech-models). + "a_key": "A String", + }, + "noSpeechTimeout": "A String", # Timeout before detecting no speech. + "useTimeoutBasedEndpointing": True or False, # Use timeout based endpointing, interpreting endpointer sensitivy as seconds of timeout value. + }, + }, + "conditionalCases": [ # Conditional cases for this fulfillment. + { # A list of cascading if-else conditions. Cases are mutually exclusive. The first one with a matching condition is selected, all the rest ignored. + "cases": [ # A list of cascading if-else conditions. + { # Each case has a Boolean condition. When it is evaluated to be True, the corresponding messages will be selected and evaluated recursively. + "caseContent": [ # A list of case content. + { # The list of messages or conditional cases to activate for this case. + "additionalCases": # Object with schema name: GoogleCloudDialogflowCxV3beta1FulfillmentConditionalCases # Additional cases to be evaluated. + "message": { # 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. # Returned message. + "channel": "A String", # The channel which the response is associated with. Clients can specify the channel via QueryParameters.channel, and only associated channel response will be returned. + "conversationSuccess": { # 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. # Indicates that the conversation succeeded. + "metadata": { # Custom metadata. Dialogflow doesn't impose any structure on this. + "a_key": "", # Properties of the object. + }, + }, + "endInteraction": { # 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. # Output only. A signal that indicates the interaction with the Dialogflow agent has ended. This message is generated by Dialogflow only when the conversation reaches `END_SESSION` page. It is not supposed to be defined by the user. It's guaranteed that there is at most one such message in each response. + }, + "knowledgeInfoCard": { # Represents info card response. If the response contains generative knowledge prediction, Dialogflow will return a payload with Infobot Messenger compatible info card. Otherwise, the info card response is skipped. # Represents info card for knowledge answers, to be better rendered in Dialogflow Messenger. + }, + "liveAgentHandoff": { # 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. # Hands off conversation to a human agent. + "metadata": { # Custom metadata for your handoff procedure. Dialogflow doesn't impose any structure on this. + "a_key": "", # Properties of the object. + }, + }, + "mixedAudio": { # 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. # Output only. An audio response message composed of both the synthesized Dialogflow agent responses and responses defined via play_audio. This message is generated by Dialogflow only and not supposed to be defined by the user. + "segments": [ # Segments this audio response is composed of. + { # Represents one segment of audio. + "allowPlaybackInterruption": True or False, # 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. + "audio": "A String", # Raw audio synthesized from the Dialogflow agent's response using the output config specified in the request. + "uri": "A String", # Client-specific URI that points to an audio clip accessible to the client. Dialogflow does not impose any validation on it. + }, + ], + }, + "outputAudioText": { # A text or ssml response that is preferentially used for TTS output audio synthesis, as described in the comment on the ResponseMessage message. # A text or ssml response that is preferentially used for TTS output audio synthesis, as described in the comment on the ResponseMessage message. + "allowPlaybackInterruption": True or False, # 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. + "ssml": "A String", # The SSML text to be synthesized. For more information, see [SSML](/speech/text-to-speech/docs/ssml). + "text": "A String", # The raw text to be synthesized. + }, + "payload": { # Returns a response containing a custom, platform-specific payload. + "a_key": "", # Properties of the object. + }, + "playAudio": { # Specifies an audio clip to be played by the client as part of the response. # Signal that the client should play an audio clip hosted at a client-specific URI. Dialogflow uses this to construct mixed_audio. However, Dialogflow itself does not try to read or process the URI in any way. + "allowPlaybackInterruption": True or False, # 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. + "audioUri": "A String", # Required. URI of the audio clip. Dialogflow does not impose any validation on this value. It is specific to the client that reads it. + }, + "telephonyTransferCall": { # Represents the signal that telles the client to transfer the phone call connected to the agent to a third-party endpoint. # A signal that the client should transfer the phone call connected to this agent to a third-party endpoint. + "phoneNumber": "A String", # Transfer the call to a phone number in [E.164 format](https://en.wikipedia.org/wiki/E.164). + }, + "text": { # The text response message. # Returns a text response. + "allowPlaybackInterruption": True or False, # 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. + "text": [ # Required. A collection of text responses. + "A String", + ], + }, + "toolCall": { # Represents a call of a specific tool's action with the specified inputs. # Returns the definition of a tool call that should be executed by the client. + "action": "A String", # Required. The name of the tool's action associated with this call. + "inputParameters": { # Optional. The action's input parameters. + "a_key": "", # Properties of the object. + }, + "tool": "A String", # Required. The tool associated with this call. Format: `projects//locations//agents//tools/`. + }, }, - ], - }, - "outputAudioText": { # A text or ssml response that is preferentially used for TTS output audio synthesis, as described in the comment on the ResponseMessage message. # A text or ssml response that is preferentially used for TTS output audio synthesis, as described in the comment on the ResponseMessage message. - "allowPlaybackInterruption": True or False, # 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. - "ssml": "A String", # The SSML text to be synthesized. For more information, see [SSML](/speech/text-to-speech/docs/ssml). - "text": "A String", # The raw text to be synthesized. - }, - "payload": { # Returns a response containing a custom, platform-specific payload. - "a_key": "", # Properties of the object. - }, - "playAudio": { # Specifies an audio clip to be played by the client as part of the response. # Signal that the client should play an audio clip hosted at a client-specific URI. Dialogflow uses this to construct mixed_audio. However, Dialogflow itself does not try to read or process the URI in any way. - "allowPlaybackInterruption": True or False, # 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. - "audioUri": "A String", # Required. URI of the audio clip. Dialogflow does not impose any validation on this value. It is specific to the client that reads it. - }, - "telephonyTransferCall": { # Represents the signal that telles the client to transfer the phone call connected to the agent to a third-party endpoint. # A signal that the client should transfer the phone call connected to this agent to a third-party endpoint. - "phoneNumber": "A String", # Transfer the call to a phone number in [E.164 format](https://en.wikipedia.org/wiki/E.164). - }, - "text": { # The text response message. # Returns a text response. - "allowPlaybackInterruption": True or False, # 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. - "text": [ # Required. A collection of text responses. - "A String", - ], + }, + ], + "condition": "A String", # The condition to activate and select this case. Empty means the condition is always true. The condition is evaluated against form parameters or session parameters. See the [conditions reference](https://cloud.google.com/dialogflow/cx/docs/reference/condition). + }, + ], + }, + ], + "enableGenerativeFallback": True or False, # If the flag is true, the agent will utilize LLM to generate a text response. If LLM generation fails, the defined responses in the fulfillment will be respected. This flag is only useful for fulfillments associated with no-match event handlers. + "messages": [ # The list of rich message responses to present to the user. + { # 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. + "channel": "A String", # The channel which the response is associated with. Clients can specify the channel via QueryParameters.channel, and only associated channel response will be returned. + "conversationSuccess": { # 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. # Indicates that the conversation succeeded. + "metadata": { # Custom metadata. Dialogflow doesn't impose any structure on this. + "a_key": "", # Properties of the object. + }, + }, + "endInteraction": { # 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. # Output only. A signal that indicates the interaction with the Dialogflow agent has ended. This message is generated by Dialogflow only when the conversation reaches `END_SESSION` page. It is not supposed to be defined by the user. It's guaranteed that there is at most one such message in each response. + }, + "knowledgeInfoCard": { # Represents info card response. If the response contains generative knowledge prediction, Dialogflow will return a payload with Infobot Messenger compatible info card. Otherwise, the info card response is skipped. # Represents info card for knowledge answers, to be better rendered in Dialogflow Messenger. + }, + "liveAgentHandoff": { # 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. # Hands off conversation to a human agent. + "metadata": { # Custom metadata for your handoff procedure. Dialogflow doesn't impose any structure on this. + "a_key": "", # Properties of the object. + }, + }, + "mixedAudio": { # 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. # Output only. An audio response message composed of both the synthesized Dialogflow agent responses and responses defined via play_audio. This message is generated by Dialogflow only and not supposed to be defined by the user. + "segments": [ # Segments this audio response is composed of. + { # Represents one segment of audio. + "allowPlaybackInterruption": True or False, # 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. + "audio": "A String", # Raw audio synthesized from the Dialogflow agent's response using the output config specified in the request. + "uri": "A String", # Client-specific URI that points to an audio clip accessible to the client. Dialogflow does not impose any validation on it. }, + ], + }, + "outputAudioText": { # A text or ssml response that is preferentially used for TTS output audio synthesis, as described in the comment on the ResponseMessage message. # A text or ssml response that is preferentially used for TTS output audio synthesis, as described in the comment on the ResponseMessage message. + "allowPlaybackInterruption": True or False, # 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. + "ssml": "A String", # The SSML text to be synthesized. For more information, see [SSML](/speech/text-to-speech/docs/ssml). + "text": "A String", # The raw text to be synthesized. + }, + "payload": { # Returns a response containing a custom, platform-specific payload. + "a_key": "", # Properties of the object. + }, + "playAudio": { # Specifies an audio clip to be played by the client as part of the response. # Signal that the client should play an audio clip hosted at a client-specific URI. Dialogflow uses this to construct mixed_audio. However, Dialogflow itself does not try to read or process the URI in any way. + "allowPlaybackInterruption": True or False, # 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. + "audioUri": "A String", # Required. URI of the audio clip. Dialogflow does not impose any validation on this value. It is specific to the client that reads it. + }, + "telephonyTransferCall": { # Represents the signal that telles the client to transfer the phone call connected to the agent to a third-party endpoint. # A signal that the client should transfer the phone call connected to this agent to a third-party endpoint. + "phoneNumber": "A String", # Transfer the call to a phone number in [E.164 format](https://en.wikipedia.org/wiki/E.164). + }, + "text": { # The text response message. # Returns a text response. + "allowPlaybackInterruption": True or False, # 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. + "text": [ # Required. A collection of text responses. + "A String", + ], + }, + "toolCall": { # Represents a call of a specific tool's action with the specified inputs. # Returns the definition of a tool call that should be executed by the client. + "action": "A String", # Required. The name of the tool's action associated with this call. + "inputParameters": { # Optional. The action's input parameters. + "a_key": "", # Properties of the object. }, + "tool": "A String", # Required. The tool associated with this call. Format: `projects//locations//agents//tools/`. }, - ], - "condition": "A String", # The condition to activate and select this case. Empty means the condition is always true. The condition is evaluated against form parameters or session parameters. See the [conditions reference](https://cloud.google.com/dialogflow/cx/docs/reference/condition). - }, + }, + ], + "returnPartialResponses": True or False, # Whether Dialogflow should return currently queued fulfillment response messages in streaming APIs. If a webhook is specified, it happens before Dialogflow invokes webhook. Warning: 1) This flag only affects streaming API. Responses are still queued and returned once in non-streaming API. 2) The flag can be enabled in any fulfillment but only the first 3 partial responses will be returned. You may only want to apply it to fulfillments that have slow webhooks. + "setParameterActions": [ # Set parameter values before executing the webhook. + { # Setting a parameter value. + "parameter": "A String", # Display name of the parameter. + "value": "", # The new value of the parameter. A null value clears the parameter. + }, + ], + "tag": "A String", # The value of this field will be populated in the WebhookRequest `fulfillmentInfo.tag` field by Dialogflow when the associated webhook is called. The tag is typically used by the webhook service to identify which fulfillment is being called, but it could be used for other purposes. This field is required if `webhook` is specified. + "webhook": "A String", # The webhook to call. Format: `projects//locations//agents//webhooks/`. + }, + }, + "multiLanguageSettings": { # Settings for multi-lingual agents. # Optional. Multi-lingual agent settings for this flow. + "enableMultiLanguageDetection": True or False, # Optional. Enable multi-language detection for this flow. This can be set only if agent level multi language setting is enabled. + "supportedResponseLanguageCodes": [ # Optional. Agent will respond in the detected language if the detected language code is in the supported resolved languages for this flow. This will be used only if multi-language training is enabled in the agent and multi-language detection is enabled in the flow. The supported languages must be a subset of the languages supported by the agent. + "A String", ], }, - ], - "enableGenerativeFallback": True or False, # If the flag is true, the agent will utilize LLM to generate a text response. If LLM generation fails, the defined responses in the fulfillment will be respected. This flag is only useful for fulfillments associated with no-match event handlers. - "messages": [ # The list of rich message responses to present to the user. - { # 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. - "channel": "A String", # The channel which the response is associated with. Clients can specify the channel via QueryParameters.channel, and only associated channel response will be returned. - "conversationSuccess": { # 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. # Indicates that the conversation succeeded. - "metadata": { # Custom metadata. Dialogflow doesn't impose any structure on this. - "a_key": "", # Properties of the object. - }, - }, - "endInteraction": { # 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. # Output only. A signal that indicates the interaction with the Dialogflow agent has ended. This message is generated by Dialogflow only when the conversation reaches `END_SESSION` page. It is not supposed to be defined by the user. It's guaranteed that there is at most one such message in each response. - }, - "knowledgeInfoCard": { # Represents info card response. If the response contains generative knowledge prediction, Dialogflow will return a payload with Infobot Messenger compatible info card. Otherwise, the info card response is skipped. # Represents info card for knowledge answers, to be better rendered in Dialogflow Messenger. - }, - "liveAgentHandoff": { # 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. # Hands off conversation to a human agent. - "metadata": { # Custom metadata for your handoff procedure. Dialogflow doesn't impose any structure on this. - "a_key": "", # Properties of the object. - }, - }, - "mixedAudio": { # 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. # Output only. An audio response message composed of both the synthesized Dialogflow agent responses and responses defined via play_audio. This message is generated by Dialogflow only and not supposed to be defined by the user. - "segments": [ # Segments this audio response is composed of. - { # Represents one segment of audio. - "allowPlaybackInterruption": True or False, # 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. - "audio": "A String", # Raw audio synthesized from the Dialogflow agent's response using the output config specified in the request. - "uri": "A String", # Client-specific URI that points to an audio clip accessible to the client. Dialogflow does not impose any validation on it. + "name": "A String", # The unique identifier of the flow. Format: `projects//locations//agents//flows/`. + "nluSettings": { # Settings related to NLU. # NLU related settings of the flow. + "classificationThreshold": 3.14, # To filter out false positive results and still get variety in matched natural language inputs for your agent, you can tune the machine learning classification threshold. If the returned score value is less than the threshold value, then a no-match event will be triggered. The score values range from 0.0 (completely uncertain) to 1.0 (completely certain). If set to 0.0, the default of 0.3 is used. + "modelTrainingMode": "A String", # Indicates NLU model training mode. + "modelType": "A String", # Indicates the type of NLU model. + }, + "transitionRouteGroups": [ # A flow's transition route group serve two purposes: * They are responsible for matching the user's first utterances in the flow. * They are inherited by every page's transition route groups. Transition route groups defined in the page have higher priority than those defined in the flow. Format:`projects//locations//agents//flows//transitionRouteGroups/` or `projects//locations//agents//transitionRouteGroups/` for agent-level groups. + "A String", + ], + "transitionRoutes": [ # A flow's transition routes serve two purposes: * They are responsible for matching the user's first utterances in the flow. * They are inherited by every page's transition routes and can support use cases such as the user saying "help" or "can I talk to a human?", which can be handled in a common way regardless of the current page. Transition routes defined in the page have higher priority than those defined in the flow. TransitionRoutes are evalauted in the following order: * TransitionRoutes with intent specified. * TransitionRoutes with only condition specified. TransitionRoutes with intent specified are inherited by pages in the flow. + { # A transition route specifies a intent that can be matched and/or a data condition that can be evaluated during a session. When a specified transition is matched, the following actions are taken in order: * If there is a `trigger_fulfillment` associated with the transition, it will be called. * If there is a `target_page` associated with the transition, the session will transition into the specified page. * If there is a `target_flow` associated with the transition, the session will transition into the specified flow. + "condition": "A String", # The condition to evaluate against form parameters or session parameters. See the [conditions reference](https://cloud.google.com/dialogflow/cx/docs/reference/condition). At least one of `intent` or `condition` must be specified. When both `intent` and `condition` are specified, the transition can only happen when both are fulfilled. + "description": "A String", # Optional. The description of the transition route. The maximum length is 500 characters. + "intent": "A String", # The unique identifier of an Intent. Format: `projects//locations//agents//intents/`. Indicates that the transition can only happen when the given intent is matched. At least one of `intent` or `condition` must be specified. When both `intent` and `condition` are specified, the transition can only happen when both are fulfilled. + "name": "A String", # Output only. The unique identifier of this transition route. + "targetFlow": "A String", # The target flow to transition to. Format: `projects//locations//agents//flows/`. + "targetPage": "A String", # The target page to transition to. Format: `projects//locations//agents//flows//pages/`. + "triggerFulfillment": { # A fulfillment can do one or more of the following actions at the same time: * Generate rich message responses. * Set parameter values. * Call the webhook. Fulfillments can be called at various stages in the Page or Form lifecycle. For example, when a DetectIntentRequest drives a session to enter a new page, the page's entry fulfillment can add a static response to the QueryResult in the returning DetectIntentResponse, call the webhook (for example, to load user data from a database), or both. # The fulfillment to call when the condition is satisfied. At least one of `trigger_fulfillment` and `target` must be specified. When both are defined, `trigger_fulfillment` is executed first. + "advancedSettings": { # Hierarchical advanced settings for agent/flow/page/fulfillment/parameter. Settings exposed at lower level overrides the settings exposed at higher level. Overriding occurs at the sub-setting level. For example, the playback_interruption_settings at fulfillment level only overrides the playback_interruption_settings at the agent level, leaving other settings at the agent level unchanged. DTMF settings does not override each other. DTMF settings set at different levels define DTMF detections running in parallel. Hierarchy: Agent->Flow->Page->Fulfillment/Parameter. # Hierarchical advanced settings for this fulfillment. The settings exposed at the lower level overrides the settings exposed at the higher level. + "audioExportGcsDestination": { # Google Cloud Storage location for a Dialogflow operation that writes or exports objects (e.g. exported agent or transcripts) outside of Dialogflow. # If present, incoming audio is exported by Dialogflow to the configured Google Cloud Storage destination. Exposed at the following levels: - Agent level - Flow level + "uri": "A String", # Required. The Google Cloud Storage URI for the exported objects. A URI is of the form: `gs://bucket/object-name-or-prefix` Whether a full object name, or just a prefix, its usage depends on the Dialogflow operation. + }, + "dtmfSettings": { # Define behaviors for DTMF (dual tone multi frequency). # Settings for DTMF. Exposed at the following levels: - Agent level - Flow level - Page level - Parameter level. + "enabled": True or False, # If true, incoming audio is processed for DTMF (dual tone multi frequency) events. For example, if the caller presses a button on their telephone keypad and DTMF processing is enabled, Dialogflow will detect the event (e.g. a "3" was pressed) in the incoming audio and pass the event to the bot to drive business logic (e.g. when 3 is pressed, return the account balance). + "endpointingTimeoutDuration": "A String", # Endpoint timeout setting for matching dtmf input to regex. + "finishDigit": "A String", # The digit that terminates a DTMF digit sequence. + "interdigitTimeoutDuration": "A String", # Interdigit timeout setting for matching dtmf input to regex. + "maxDigits": 42, # Max length of DTMF digits. + }, + "loggingSettings": { # Define behaviors on logging. # Settings for logging. Settings for Dialogflow History, Contact Center messages, StackDriver logs, and speech logging. Exposed at the following levels: - Agent level. + "enableInteractionLogging": True or False, # Enables DF Interaction logging. + "enableStackdriverLogging": True or False, # Enables StackDriver logging. + }, + "speechSettings": { # Define behaviors of speech to text detection. # Settings for speech to text detection. Exposed at the following levels: - Agent level - Flow level - Page level - Parameter level + "endpointerSensitivity": 42, # Sensitivity of the speech model that detects the end of speech. Scale from 0 to 100. + "models": { # Mapping from language to Speech-to-Text model. The mapped Speech-to-Text model will be selected for requests from its corresponding language. For more information, see [Speech models](https://cloud.google.com/dialogflow/cx/docs/concept/speech-models). + "a_key": "A String", + }, + "noSpeechTimeout": "A String", # Timeout before detecting no speech. + "useTimeoutBasedEndpointing": True or False, # Use timeout based endpointing, interpreting endpointer sensitivy as seconds of timeout value. + }, }, - ], - }, - "outputAudioText": { # A text or ssml response that is preferentially used for TTS output audio synthesis, as described in the comment on the ResponseMessage message. # A text or ssml response that is preferentially used for TTS output audio synthesis, as described in the comment on the ResponseMessage message. - "allowPlaybackInterruption": True or False, # 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. - "ssml": "A String", # The SSML text to be synthesized. For more information, see [SSML](/speech/text-to-speech/docs/ssml). - "text": "A String", # The raw text to be synthesized. - }, - "payload": { # Returns a response containing a custom, platform-specific payload. - "a_key": "", # Properties of the object. - }, - "playAudio": { # Specifies an audio clip to be played by the client as part of the response. # Signal that the client should play an audio clip hosted at a client-specific URI. Dialogflow uses this to construct mixed_audio. However, Dialogflow itself does not try to read or process the URI in any way. - "allowPlaybackInterruption": True or False, # 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. - "audioUri": "A String", # Required. URI of the audio clip. Dialogflow does not impose any validation on this value. It is specific to the client that reads it. - }, - "telephonyTransferCall": { # Represents the signal that telles the client to transfer the phone call connected to the agent to a third-party endpoint. # A signal that the client should transfer the phone call connected to this agent to a third-party endpoint. - "phoneNumber": "A String", # Transfer the call to a phone number in [E.164 format](https://en.wikipedia.org/wiki/E.164). - }, - "text": { # The text response message. # Returns a text response. - "allowPlaybackInterruption": True or False, # 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. - "text": [ # Required. A collection of text responses. - "A String", - ], + "conditionalCases": [ # Conditional cases for this fulfillment. + { # A list of cascading if-else conditions. Cases are mutually exclusive. The first one with a matching condition is selected, all the rest ignored. + "cases": [ # A list of cascading if-else conditions. + { # Each case has a Boolean condition. When it is evaluated to be True, the corresponding messages will be selected and evaluated recursively. + "caseContent": [ # A list of case content. + { # The list of messages or conditional cases to activate for this case. + "additionalCases": # Object with schema name: GoogleCloudDialogflowCxV3beta1FulfillmentConditionalCases # Additional cases to be evaluated. + "message": { # 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. # Returned message. + "channel": "A String", # The channel which the response is associated with. Clients can specify the channel via QueryParameters.channel, and only associated channel response will be returned. + "conversationSuccess": { # 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. # Indicates that the conversation succeeded. + "metadata": { # Custom metadata. Dialogflow doesn't impose any structure on this. + "a_key": "", # Properties of the object. + }, + }, + "endInteraction": { # 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. # Output only. A signal that indicates the interaction with the Dialogflow agent has ended. This message is generated by Dialogflow only when the conversation reaches `END_SESSION` page. It is not supposed to be defined by the user. It's guaranteed that there is at most one such message in each response. + }, + "knowledgeInfoCard": { # Represents info card response. If the response contains generative knowledge prediction, Dialogflow will return a payload with Infobot Messenger compatible info card. Otherwise, the info card response is skipped. # Represents info card for knowledge answers, to be better rendered in Dialogflow Messenger. + }, + "liveAgentHandoff": { # 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. # Hands off conversation to a human agent. + "metadata": { # Custom metadata for your handoff procedure. Dialogflow doesn't impose any structure on this. + "a_key": "", # Properties of the object. + }, + }, + "mixedAudio": { # 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. # Output only. An audio response message composed of both the synthesized Dialogflow agent responses and responses defined via play_audio. This message is generated by Dialogflow only and not supposed to be defined by the user. + "segments": [ # Segments this audio response is composed of. + { # Represents one segment of audio. + "allowPlaybackInterruption": True or False, # 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. + "audio": "A String", # Raw audio synthesized from the Dialogflow agent's response using the output config specified in the request. + "uri": "A String", # Client-specific URI that points to an audio clip accessible to the client. Dialogflow does not impose any validation on it. + }, + ], + }, + "outputAudioText": { # A text or ssml response that is preferentially used for TTS output audio synthesis, as described in the comment on the ResponseMessage message. # A text or ssml response that is preferentially used for TTS output audio synthesis, as described in the comment on the ResponseMessage message. + "allowPlaybackInterruption": True or False, # 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. + "ssml": "A String", # The SSML text to be synthesized. For more information, see [SSML](/speech/text-to-speech/docs/ssml). + "text": "A String", # The raw text to be synthesized. + }, + "payload": { # Returns a response containing a custom, platform-specific payload. + "a_key": "", # Properties of the object. + }, + "playAudio": { # Specifies an audio clip to be played by the client as part of the response. # Signal that the client should play an audio clip hosted at a client-specific URI. Dialogflow uses this to construct mixed_audio. However, Dialogflow itself does not try to read or process the URI in any way. + "allowPlaybackInterruption": True or False, # 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. + "audioUri": "A String", # Required. URI of the audio clip. Dialogflow does not impose any validation on this value. It is specific to the client that reads it. + }, + "telephonyTransferCall": { # Represents the signal that telles the client to transfer the phone call connected to the agent to a third-party endpoint. # A signal that the client should transfer the phone call connected to this agent to a third-party endpoint. + "phoneNumber": "A String", # Transfer the call to a phone number in [E.164 format](https://en.wikipedia.org/wiki/E.164). + }, + "text": { # The text response message. # Returns a text response. + "allowPlaybackInterruption": True or False, # 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. + "text": [ # Required. A collection of text responses. + "A String", + ], + }, + "toolCall": { # Represents a call of a specific tool's action with the specified inputs. # Returns the definition of a tool call that should be executed by the client. + "action": "A String", # Required. The name of the tool's action associated with this call. + "inputParameters": { # Optional. The action's input parameters. + "a_key": "", # Properties of the object. + }, + "tool": "A String", # Required. The tool associated with this call. Format: `projects//locations//agents//tools/`. + }, + }, + }, + ], + "condition": "A String", # The condition to activate and select this case. Empty means the condition is always true. The condition is evaluated against form parameters or session parameters. See the [conditions reference](https://cloud.google.com/dialogflow/cx/docs/reference/condition). + }, + ], + }, + ], + "enableGenerativeFallback": True or False, # If the flag is true, the agent will utilize LLM to generate a text response. If LLM generation fails, the defined responses in the fulfillment will be respected. This flag is only useful for fulfillments associated with no-match event handlers. + "messages": [ # The list of rich message responses to present to the user. + { # 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. + "channel": "A String", # The channel which the response is associated with. Clients can specify the channel via QueryParameters.channel, and only associated channel response will be returned. + "conversationSuccess": { # 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. # Indicates that the conversation succeeded. + "metadata": { # Custom metadata. Dialogflow doesn't impose any structure on this. + "a_key": "", # Properties of the object. + }, + }, + "endInteraction": { # 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. # Output only. A signal that indicates the interaction with the Dialogflow agent has ended. This message is generated by Dialogflow only when the conversation reaches `END_SESSION` page. It is not supposed to be defined by the user. It's guaranteed that there is at most one such message in each response. + }, + "knowledgeInfoCard": { # Represents info card response. If the response contains generative knowledge prediction, Dialogflow will return a payload with Infobot Messenger compatible info card. Otherwise, the info card response is skipped. # Represents info card for knowledge answers, to be better rendered in Dialogflow Messenger. + }, + "liveAgentHandoff": { # 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. # Hands off conversation to a human agent. + "metadata": { # Custom metadata for your handoff procedure. Dialogflow doesn't impose any structure on this. + "a_key": "", # Properties of the object. + }, + }, + "mixedAudio": { # 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. # Output only. An audio response message composed of both the synthesized Dialogflow agent responses and responses defined via play_audio. This message is generated by Dialogflow only and not supposed to be defined by the user. + "segments": [ # Segments this audio response is composed of. + { # Represents one segment of audio. + "allowPlaybackInterruption": True or False, # 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. + "audio": "A String", # Raw audio synthesized from the Dialogflow agent's response using the output config specified in the request. + "uri": "A String", # Client-specific URI that points to an audio clip accessible to the client. Dialogflow does not impose any validation on it. + }, + ], + }, + "outputAudioText": { # A text or ssml response that is preferentially used for TTS output audio synthesis, as described in the comment on the ResponseMessage message. # A text or ssml response that is preferentially used for TTS output audio synthesis, as described in the comment on the ResponseMessage message. + "allowPlaybackInterruption": True or False, # 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. + "ssml": "A String", # The SSML text to be synthesized. For more information, see [SSML](/speech/text-to-speech/docs/ssml). + "text": "A String", # The raw text to be synthesized. + }, + "payload": { # Returns a response containing a custom, platform-specific payload. + "a_key": "", # Properties of the object. + }, + "playAudio": { # Specifies an audio clip to be played by the client as part of the response. # Signal that the client should play an audio clip hosted at a client-specific URI. Dialogflow uses this to construct mixed_audio. However, Dialogflow itself does not try to read or process the URI in any way. + "allowPlaybackInterruption": True or False, # 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. + "audioUri": "A String", # Required. URI of the audio clip. Dialogflow does not impose any validation on this value. It is specific to the client that reads it. + }, + "telephonyTransferCall": { # Represents the signal that telles the client to transfer the phone call connected to the agent to a third-party endpoint. # A signal that the client should transfer the phone call connected to this agent to a third-party endpoint. + "phoneNumber": "A String", # Transfer the call to a phone number in [E.164 format](https://en.wikipedia.org/wiki/E.164). + }, + "text": { # The text response message. # Returns a text response. + "allowPlaybackInterruption": True or False, # 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. + "text": [ # Required. A collection of text responses. + "A String", + ], + }, + "toolCall": { # Represents a call of a specific tool's action with the specified inputs. # Returns the definition of a tool call that should be executed by the client. + "action": "A String", # Required. The name of the tool's action associated with this call. + "inputParameters": { # Optional. The action's input parameters. + "a_key": "", # Properties of the object. + }, + "tool": "A String", # Required. The tool associated with this call. Format: `projects//locations//agents//tools/`. + }, + }, + ], + "returnPartialResponses": True or False, # Whether Dialogflow should return currently queued fulfillment response messages in streaming APIs. If a webhook is specified, it happens before Dialogflow invokes webhook. Warning: 1) This flag only affects streaming API. Responses are still queued and returned once in non-streaming API. 2) The flag can be enabled in any fulfillment but only the first 3 partial responses will be returned. You may only want to apply it to fulfillments that have slow webhooks. + "setParameterActions": [ # Set parameter values before executing the webhook. + { # Setting a parameter value. + "parameter": "A String", # Display name of the parameter. + "value": "", # The new value of the parameter. A null value clears the parameter. + }, + ], + "tag": "A String", # The value of this field will be populated in the WebhookRequest `fulfillmentInfo.tag` field by Dialogflow when the associated webhook is called. The tag is typically used by the webhook service to identify which fulfillment is being called, but it could be used for other purposes. This field is required if `webhook` is specified. + "webhook": "A String", # The webhook to call. Format: `projects//locations//agents//webhooks/`. + }, }, - }, - ], - "returnPartialResponses": True or False, # Whether Dialogflow should return currently queued fulfillment response messages in streaming APIs. If a webhook is specified, it happens before Dialogflow invokes webhook. Warning: 1) This flag only affects streaming API. Responses are still queued and returned once in non-streaming API. 2) The flag can be enabled in any fulfillment but only the first 3 partial responses will be returned. You may only want to apply it to fulfillments that have slow webhooks. - "setParameterActions": [ # Set parameter values before executing the webhook. - { # Setting a parameter value. - "parameter": "A String", # Display name of the parameter. - "value": "", # The new value of the parameter. A null value clears the parameter. - }, - ], - "tag": "A String", # The value of this field will be populated in the WebhookRequest `fulfillmentInfo.tag` field by Dialogflow when the associated webhook is called. The tag is typically used by the webhook service to identify which fulfillment is being called, but it could be used for other purposes. This field is required if `webhook` is specified. - "webhook": "A String", # The webhook to call. Format: `projects//locations//agents//webhooks/`. - }, - }, - "name": "A String", # The unique identifier of the page. Required for the Pages.UpdatePage method. Pages.CreatePage populates the name automatically. Format: `projects//locations//agents//flows//pages/`. - "transitionRouteGroups": [ # Ordered list of `TransitionRouteGroups` added to the page. Transition route groups must be unique within a page. If the page links both flow-level transition route groups and agent-level transition route groups, the flow-level ones will have higher priority and will be put before the agent-level ones. * If multiple transition routes within a page scope refer to the same intent, then the precedence order is: page's transition route -> page's transition route group -> flow's transition routes. * If multiple transition route groups within a page contain the same intent, then the first group in the ordered list takes precedence. Format:`projects//locations//agents//flows//transitionRouteGroups/` or `projects//locations//agents//transitionRouteGroups/` for agent-level groups. - "A String", - ], - "transitionRoutes": [ # A list of transitions for the transition rules of this page. They route the conversation to another page in the same flow, or another flow. When we are in a certain page, the TransitionRoutes are evalauted in the following order: * TransitionRoutes defined in the page with intent specified. * TransitionRoutes defined in the transition route groups with intent specified. * TransitionRoutes defined in flow with intent specified. * TransitionRoutes defined in the transition route groups with intent specified. * TransitionRoutes defined in the page with only condition specified. * TransitionRoutes defined in the transition route groups with only condition specified. - { # A transition route specifies a intent that can be matched and/or a data condition that can be evaluated during a session. When a specified transition is matched, the following actions are taken in order: * If there is a `trigger_fulfillment` associated with the transition, it will be called. * If there is a `target_page` associated with the transition, the session will transition into the specified page. * If there is a `target_flow` associated with the transition, the session will transition into the specified flow. - "condition": "A String", # The condition to evaluate against form parameters or session parameters. See the [conditions reference](https://cloud.google.com/dialogflow/cx/docs/reference/condition). At least one of `intent` or `condition` must be specified. When both `intent` and `condition` are specified, the transition can only happen when both are fulfilled. - "description": "A String", # Optional. The description of the transition route. The maximum length is 500 characters. - "intent": "A String", # The unique identifier of an Intent. Format: `projects//locations//agents//intents/`. Indicates that the transition can only happen when the given intent is matched. At least one of `intent` or `condition` must be specified. When both `intent` and `condition` are specified, the transition can only happen when both are fulfilled. - "name": "A String", # Output only. The unique identifier of this transition route. - "targetFlow": "A String", # The target flow to transition to. Format: `projects//locations//agents//flows/`. - "targetPage": "A String", # The target page to transition to. Format: `projects//locations//agents//flows//pages/`. - "triggerFulfillment": { # A fulfillment can do one or more of the following actions at the same time: * Generate rich message responses. * Set parameter values. * Call the webhook. Fulfillments can be called at various stages in the Page or Form lifecycle. For example, when a DetectIntentRequest drives a session to enter a new page, the page's entry fulfillment can add a static response to the QueryResult in the returning DetectIntentResponse, call the webhook (for example, to load user data from a database), or both. # The fulfillment to call when the condition is satisfied. At least one of `trigger_fulfillment` and `target` must be specified. When both are defined, `trigger_fulfillment` is executed first. - "advancedSettings": { # Hierarchical advanced settings for agent/flow/page/fulfillment/parameter. Settings exposed at lower level overrides the settings exposed at higher level. Overriding occurs at the sub-setting level. For example, the playback_interruption_settings at fulfillment level only overrides the playback_interruption_settings at the agent level, leaving other settings at the agent level unchanged. DTMF settings does not override each other. DTMF settings set at different levels define DTMF detections running in parallel. Hierarchy: Agent->Flow->Page->Fulfillment/Parameter. # Hierarchical advanced settings for this fulfillment. The settings exposed at the lower level overrides the settings exposed at the higher level. + ], + }, + "currentPage": { # A Dialogflow CX conversation (session) can be described and visualized as a state machine. The states of a CX session are represented by pages. For each flow, you define many pages, where your combined pages can handle a complete conversation on the topics the flow is designed for. At any given moment, exactly one page is the current page, the current page is considered active, and the flow associated with that page is considered active. Every flow has a special start page. When a flow initially becomes active, the start page page becomes the current page. For each conversational turn, the current page will either stay the same or transition to another page. You configure each page to collect information from the end-user that is relevant for the conversational state represented by the page. For more information, see the [Page guide](https://cloud.google.com/dialogflow/cx/docs/concept/page). # The current Page. Some, not all fields are filled in this message, including but not limited to `name` and `display_name`. + "advancedSettings": { # Hierarchical advanced settings for agent/flow/page/fulfillment/parameter. Settings exposed at lower level overrides the settings exposed at higher level. Overriding occurs at the sub-setting level. For example, the playback_interruption_settings at fulfillment level only overrides the playback_interruption_settings at the agent level, leaving other settings at the agent level unchanged. DTMF settings does not override each other. DTMF settings set at different levels define DTMF detections running in parallel. Hierarchy: Agent->Flow->Page->Fulfillment/Parameter. # Hierarchical advanced settings for this page. The settings exposed at the lower level overrides the settings exposed at the higher level. "audioExportGcsDestination": { # Google Cloud Storage location for a Dialogflow operation that writes or exports objects (e.g. exported agent or transcripts) outside of Dialogflow. # If present, incoming audio is exported by Dialogflow to the configured Google Cloud Storage destination. Exposed at the following levels: - Agent level - Flow level "uri": "A String", # Required. The Google Cloud Storage URI for the exported objects. A URI is of the form: `gs://bucket/object-name-or-prefix` Whether a full object name, or just a prefix, its usage depends on the Dialogflow operation. }, @@ -4258,8 +3519,8 @@

Method Details

"maxDigits": 42, # Max length of DTMF digits. }, "loggingSettings": { # Define behaviors on logging. # Settings for logging. Settings for Dialogflow History, Contact Center messages, StackDriver logs, and speech logging. Exposed at the following levels: - Agent level. - "enableInteractionLogging": True or False, # If true, DF Interaction logging is currently enabled. - "enableStackdriverLogging": True or False, # If true, StackDriver logging is currently enabled. + "enableInteractionLogging": True or False, # Enables DF Interaction logging. + "enableStackdriverLogging": True or False, # Enables StackDriver logging. }, "speechSettings": { # Define behaviors of speech to text detection. # Settings for speech to text detection. Exposed at the following levels: - Agent level - Flow level - Page level - Parameter level "endpointerSensitivity": 42, # Sensitivity of the speech model that detects the end of speech. Scale from 0 to 100. @@ -4270,1287 +3531,918 @@

Method Details

"useTimeoutBasedEndpointing": True or False, # Use timeout based endpointing, interpreting endpointer sensitivy as seconds of timeout value. }, }, - "conditionalCases": [ # Conditional cases for this fulfillment. - { # A list of cascading if-else conditions. Cases are mutually exclusive. The first one with a matching condition is selected, all the rest ignored. - "cases": [ # A list of cascading if-else conditions. - { # Each case has a Boolean condition. When it is evaluated to be True, the corresponding messages will be selected and evaluated recursively. - "caseContent": [ # A list of case content. - { # The list of messages or conditional cases to activate for this case. - "additionalCases": # Object with schema name: GoogleCloudDialogflowCxV3beta1FulfillmentConditionalCases # Additional cases to be evaluated. - "message": { # 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. # Returned message. - "channel": "A String", # The channel which the response is associated with. Clients can specify the channel via QueryParameters.channel, and only associated channel response will be returned. - "conversationSuccess": { # 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. # Indicates that the conversation succeeded. - "metadata": { # Custom metadata. Dialogflow doesn't impose any structure on this. - "a_key": "", # Properties of the object. - }, - }, - "endInteraction": { # 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. # Output only. A signal that indicates the interaction with the Dialogflow agent has ended. This message is generated by Dialogflow only when the conversation reaches `END_SESSION` page. It is not supposed to be defined by the user. It's guaranteed that there is at most one such message in each response. - }, - "knowledgeInfoCard": { # Represents info card response. If the response contains generative knowledge prediction, Dialogflow will return a payload with Infobot Messenger compatible info card. Otherwise, the info card response is skipped. # Represents info card for knowledge answers, to be better rendered in Dialogflow Messenger. - }, - "liveAgentHandoff": { # 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. # Hands off conversation to a human agent. - "metadata": { # Custom metadata for your handoff procedure. Dialogflow doesn't impose any structure on this. - "a_key": "", # Properties of the object. - }, - }, - "mixedAudio": { # 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. # Output only. An audio response message composed of both the synthesized Dialogflow agent responses and responses defined via play_audio. This message is generated by Dialogflow only and not supposed to be defined by the user. - "segments": [ # Segments this audio response is composed of. - { # Represents one segment of audio. - "allowPlaybackInterruption": True or False, # 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. - "audio": "A String", # Raw audio synthesized from the Dialogflow agent's response using the output config specified in the request. - "uri": "A String", # Client-specific URI that points to an audio clip accessible to the client. Dialogflow does not impose any validation on it. - }, - ], - }, - "outputAudioText": { # A text or ssml response that is preferentially used for TTS output audio synthesis, as described in the comment on the ResponseMessage message. # A text or ssml response that is preferentially used for TTS output audio synthesis, as described in the comment on the ResponseMessage message. - "allowPlaybackInterruption": True or False, # 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. - "ssml": "A String", # The SSML text to be synthesized. For more information, see [SSML](/speech/text-to-speech/docs/ssml). - "text": "A String", # The raw text to be synthesized. - }, - "payload": { # Returns a response containing a custom, platform-specific payload. - "a_key": "", # Properties of the object. - }, - "playAudio": { # Specifies an audio clip to be played by the client as part of the response. # Signal that the client should play an audio clip hosted at a client-specific URI. Dialogflow uses this to construct mixed_audio. However, Dialogflow itself does not try to read or process the URI in any way. - "allowPlaybackInterruption": True or False, # 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. - "audioUri": "A String", # Required. URI of the audio clip. Dialogflow does not impose any validation on this value. It is specific to the client that reads it. - }, - "telephonyTransferCall": { # Represents the signal that telles the client to transfer the phone call connected to the agent to a third-party endpoint. # A signal that the client should transfer the phone call connected to this agent to a third-party endpoint. - "phoneNumber": "A String", # Transfer the call to a phone number in [E.164 format](https://en.wikipedia.org/wiki/E.164). - }, - "text": { # The text response message. # Returns a text response. - "allowPlaybackInterruption": True or False, # 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. - "text": [ # Required. A collection of text responses. - "A String", - ], + "description": "A String", # The description of the page. The maximum length is 500 characters. + "displayName": "A String", # Required. The human-readable name of the page, unique within the flow. + "entryFulfillment": { # A fulfillment can do one or more of the following actions at the same time: * Generate rich message responses. * Set parameter values. * Call the webhook. Fulfillments can be called at various stages in the Page or Form lifecycle. For example, when a DetectIntentRequest drives a session to enter a new page, the page's entry fulfillment can add a static response to the QueryResult in the returning DetectIntentResponse, call the webhook (for example, to load user data from a database), or both. # The fulfillment to call when the session is entering the page. + "advancedSettings": { # Hierarchical advanced settings for agent/flow/page/fulfillment/parameter. Settings exposed at lower level overrides the settings exposed at higher level. Overriding occurs at the sub-setting level. For example, the playback_interruption_settings at fulfillment level only overrides the playback_interruption_settings at the agent level, leaving other settings at the agent level unchanged. DTMF settings does not override each other. DTMF settings set at different levels define DTMF detections running in parallel. Hierarchy: Agent->Flow->Page->Fulfillment/Parameter. # Hierarchical advanced settings for this fulfillment. The settings exposed at the lower level overrides the settings exposed at the higher level. + "audioExportGcsDestination": { # Google Cloud Storage location for a Dialogflow operation that writes or exports objects (e.g. exported agent or transcripts) outside of Dialogflow. # If present, incoming audio is exported by Dialogflow to the configured Google Cloud Storage destination. Exposed at the following levels: - Agent level - Flow level + "uri": "A String", # Required. The Google Cloud Storage URI for the exported objects. A URI is of the form: `gs://bucket/object-name-or-prefix` Whether a full object name, or just a prefix, its usage depends on the Dialogflow operation. + }, + "dtmfSettings": { # Define behaviors for DTMF (dual tone multi frequency). # Settings for DTMF. Exposed at the following levels: - Agent level - Flow level - Page level - Parameter level. + "enabled": True or False, # If true, incoming audio is processed for DTMF (dual tone multi frequency) events. For example, if the caller presses a button on their telephone keypad and DTMF processing is enabled, Dialogflow will detect the event (e.g. a "3" was pressed) in the incoming audio and pass the event to the bot to drive business logic (e.g. when 3 is pressed, return the account balance). + "endpointingTimeoutDuration": "A String", # Endpoint timeout setting for matching dtmf input to regex. + "finishDigit": "A String", # The digit that terminates a DTMF digit sequence. + "interdigitTimeoutDuration": "A String", # Interdigit timeout setting for matching dtmf input to regex. + "maxDigits": 42, # Max length of DTMF digits. + }, + "loggingSettings": { # Define behaviors on logging. # Settings for logging. Settings for Dialogflow History, Contact Center messages, StackDriver logs, and speech logging. Exposed at the following levels: - Agent level. + "enableInteractionLogging": True or False, # Enables DF Interaction logging. + "enableStackdriverLogging": True or False, # Enables StackDriver logging. + }, + "speechSettings": { # Define behaviors of speech to text detection. # Settings for speech to text detection. Exposed at the following levels: - Agent level - Flow level - Page level - Parameter level + "endpointerSensitivity": 42, # Sensitivity of the speech model that detects the end of speech. Scale from 0 to 100. + "models": { # Mapping from language to Speech-to-Text model. The mapped Speech-to-Text model will be selected for requests from its corresponding language. For more information, see [Speech models](https://cloud.google.com/dialogflow/cx/docs/concept/speech-models). + "a_key": "A String", + }, + "noSpeechTimeout": "A String", # Timeout before detecting no speech. + "useTimeoutBasedEndpointing": True or False, # Use timeout based endpointing, interpreting endpointer sensitivy as seconds of timeout value. + }, + }, + "conditionalCases": [ # Conditional cases for this fulfillment. + { # A list of cascading if-else conditions. Cases are mutually exclusive. The first one with a matching condition is selected, all the rest ignored. + "cases": [ # A list of cascading if-else conditions. + { # Each case has a Boolean condition. When it is evaluated to be True, the corresponding messages will be selected and evaluated recursively. + "caseContent": [ # A list of case content. + { # The list of messages or conditional cases to activate for this case. + "additionalCases": # Object with schema name: GoogleCloudDialogflowCxV3beta1FulfillmentConditionalCases # Additional cases to be evaluated. + "message": { # 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. # Returned message. + "channel": "A String", # The channel which the response is associated with. Clients can specify the channel via QueryParameters.channel, and only associated channel response will be returned. + "conversationSuccess": { # 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. # Indicates that the conversation succeeded. + "metadata": { # Custom metadata. Dialogflow doesn't impose any structure on this. + "a_key": "", # Properties of the object. + }, + }, + "endInteraction": { # 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. # Output only. A signal that indicates the interaction with the Dialogflow agent has ended. This message is generated by Dialogflow only when the conversation reaches `END_SESSION` page. It is not supposed to be defined by the user. It's guaranteed that there is at most one such message in each response. + }, + "knowledgeInfoCard": { # Represents info card response. If the response contains generative knowledge prediction, Dialogflow will return a payload with Infobot Messenger compatible info card. Otherwise, the info card response is skipped. # Represents info card for knowledge answers, to be better rendered in Dialogflow Messenger. + }, + "liveAgentHandoff": { # 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. # Hands off conversation to a human agent. + "metadata": { # Custom metadata for your handoff procedure. Dialogflow doesn't impose any structure on this. + "a_key": "", # Properties of the object. + }, + }, + "mixedAudio": { # 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. # Output only. An audio response message composed of both the synthesized Dialogflow agent responses and responses defined via play_audio. This message is generated by Dialogflow only and not supposed to be defined by the user. + "segments": [ # Segments this audio response is composed of. + { # Represents one segment of audio. + "allowPlaybackInterruption": True or False, # 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. + "audio": "A String", # Raw audio synthesized from the Dialogflow agent's response using the output config specified in the request. + "uri": "A String", # Client-specific URI that points to an audio clip accessible to the client. Dialogflow does not impose any validation on it. + }, + ], + }, + "outputAudioText": { # A text or ssml response that is preferentially used for TTS output audio synthesis, as described in the comment on the ResponseMessage message. # A text or ssml response that is preferentially used for TTS output audio synthesis, as described in the comment on the ResponseMessage message. + "allowPlaybackInterruption": True or False, # 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. + "ssml": "A String", # The SSML text to be synthesized. For more information, see [SSML](/speech/text-to-speech/docs/ssml). + "text": "A String", # The raw text to be synthesized. + }, + "payload": { # Returns a response containing a custom, platform-specific payload. + "a_key": "", # Properties of the object. + }, + "playAudio": { # Specifies an audio clip to be played by the client as part of the response. # Signal that the client should play an audio clip hosted at a client-specific URI. Dialogflow uses this to construct mixed_audio. However, Dialogflow itself does not try to read or process the URI in any way. + "allowPlaybackInterruption": True or False, # 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. + "audioUri": "A String", # Required. URI of the audio clip. Dialogflow does not impose any validation on this value. It is specific to the client that reads it. + }, + "telephonyTransferCall": { # Represents the signal that telles the client to transfer the phone call connected to the agent to a third-party endpoint. # A signal that the client should transfer the phone call connected to this agent to a third-party endpoint. + "phoneNumber": "A String", # Transfer the call to a phone number in [E.164 format](https://en.wikipedia.org/wiki/E.164). + }, + "text": { # The text response message. # Returns a text response. + "allowPlaybackInterruption": True or False, # 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. + "text": [ # Required. A collection of text responses. + "A String", + ], + }, + "toolCall": { # Represents a call of a specific tool's action with the specified inputs. # Returns the definition of a tool call that should be executed by the client. + "action": "A String", # Required. The name of the tool's action associated with this call. + "inputParameters": { # Optional. The action's input parameters. + "a_key": "", # Properties of the object. + }, + "tool": "A String", # Required. The tool associated with this call. Format: `projects//locations//agents//tools/`. + }, }, }, + ], + "condition": "A String", # The condition to activate and select this case. Empty means the condition is always true. The condition is evaluated against form parameters or session parameters. See the [conditions reference](https://cloud.google.com/dialogflow/cx/docs/reference/condition). + }, + ], + }, + ], + "enableGenerativeFallback": True or False, # If the flag is true, the agent will utilize LLM to generate a text response. If LLM generation fails, the defined responses in the fulfillment will be respected. This flag is only useful for fulfillments associated with no-match event handlers. + "messages": [ # The list of rich message responses to present to the user. + { # 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. + "channel": "A String", # The channel which the response is associated with. Clients can specify the channel via QueryParameters.channel, and only associated channel response will be returned. + "conversationSuccess": { # 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. # Indicates that the conversation succeeded. + "metadata": { # Custom metadata. Dialogflow doesn't impose any structure on this. + "a_key": "", # Properties of the object. + }, + }, + "endInteraction": { # 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. # Output only. A signal that indicates the interaction with the Dialogflow agent has ended. This message is generated by Dialogflow only when the conversation reaches `END_SESSION` page. It is not supposed to be defined by the user. It's guaranteed that there is at most one such message in each response. + }, + "knowledgeInfoCard": { # Represents info card response. If the response contains generative knowledge prediction, Dialogflow will return a payload with Infobot Messenger compatible info card. Otherwise, the info card response is skipped. # Represents info card for knowledge answers, to be better rendered in Dialogflow Messenger. + }, + "liveAgentHandoff": { # 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. # Hands off conversation to a human agent. + "metadata": { # Custom metadata for your handoff procedure. Dialogflow doesn't impose any structure on this. + "a_key": "", # Properties of the object. + }, + }, + "mixedAudio": { # 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. # Output only. An audio response message composed of both the synthesized Dialogflow agent responses and responses defined via play_audio. This message is generated by Dialogflow only and not supposed to be defined by the user. + "segments": [ # Segments this audio response is composed of. + { # Represents one segment of audio. + "allowPlaybackInterruption": True or False, # 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. + "audio": "A String", # Raw audio synthesized from the Dialogflow agent's response using the output config specified in the request. + "uri": "A String", # Client-specific URI that points to an audio clip accessible to the client. Dialogflow does not impose any validation on it. }, ], - "condition": "A String", # The condition to activate and select this case. Empty means the condition is always true. The condition is evaluated against form parameters or session parameters. See the [conditions reference](https://cloud.google.com/dialogflow/cx/docs/reference/condition). }, - ], - }, - ], - "enableGenerativeFallback": True or False, # If the flag is true, the agent will utilize LLM to generate a text response. If LLM generation fails, the defined responses in the fulfillment will be respected. This flag is only useful for fulfillments associated with no-match event handlers. - "messages": [ # The list of rich message responses to present to the user. - { # 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. - "channel": "A String", # The channel which the response is associated with. Clients can specify the channel via QueryParameters.channel, and only associated channel response will be returned. - "conversationSuccess": { # 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. # Indicates that the conversation succeeded. - "metadata": { # Custom metadata. Dialogflow doesn't impose any structure on this. - "a_key": "", # Properties of the object. + "outputAudioText": { # A text or ssml response that is preferentially used for TTS output audio synthesis, as described in the comment on the ResponseMessage message. # A text or ssml response that is preferentially used for TTS output audio synthesis, as described in the comment on the ResponseMessage message. + "allowPlaybackInterruption": True or False, # 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. + "ssml": "A String", # The SSML text to be synthesized. For more information, see [SSML](/speech/text-to-speech/docs/ssml). + "text": "A String", # The raw text to be synthesized. }, - }, - "endInteraction": { # 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. # Output only. A signal that indicates the interaction with the Dialogflow agent has ended. This message is generated by Dialogflow only when the conversation reaches `END_SESSION` page. It is not supposed to be defined by the user. It's guaranteed that there is at most one such message in each response. - }, - "knowledgeInfoCard": { # Represents info card response. If the response contains generative knowledge prediction, Dialogflow will return a payload with Infobot Messenger compatible info card. Otherwise, the info card response is skipped. # Represents info card for knowledge answers, to be better rendered in Dialogflow Messenger. - }, - "liveAgentHandoff": { # 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. # Hands off conversation to a human agent. - "metadata": { # Custom metadata for your handoff procedure. Dialogflow doesn't impose any structure on this. + "payload": { # Returns a response containing a custom, platform-specific payload. "a_key": "", # Properties of the object. }, - }, - "mixedAudio": { # 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. # Output only. An audio response message composed of both the synthesized Dialogflow agent responses and responses defined via play_audio. This message is generated by Dialogflow only and not supposed to be defined by the user. - "segments": [ # Segments this audio response is composed of. - { # Represents one segment of audio. - "allowPlaybackInterruption": True or False, # 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. - "audio": "A String", # Raw audio synthesized from the Dialogflow agent's response using the output config specified in the request. - "uri": "A String", # Client-specific URI that points to an audio clip accessible to the client. Dialogflow does not impose any validation on it. + "playAudio": { # Specifies an audio clip to be played by the client as part of the response. # Signal that the client should play an audio clip hosted at a client-specific URI. Dialogflow uses this to construct mixed_audio. However, Dialogflow itself does not try to read or process the URI in any way. + "allowPlaybackInterruption": True or False, # 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. + "audioUri": "A String", # Required. URI of the audio clip. Dialogflow does not impose any validation on this value. It is specific to the client that reads it. + }, + "telephonyTransferCall": { # Represents the signal that telles the client to transfer the phone call connected to the agent to a third-party endpoint. # A signal that the client should transfer the phone call connected to this agent to a third-party endpoint. + "phoneNumber": "A String", # Transfer the call to a phone number in [E.164 format](https://en.wikipedia.org/wiki/E.164). + }, + "text": { # The text response message. # Returns a text response. + "allowPlaybackInterruption": True or False, # 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. + "text": [ # Required. A collection of text responses. + "A String", + ], + }, + "toolCall": { # Represents a call of a specific tool's action with the specified inputs. # Returns the definition of a tool call that should be executed by the client. + "action": "A String", # Required. The name of the tool's action associated with this call. + "inputParameters": { # Optional. The action's input parameters. + "a_key": "", # Properties of the object. }, - ], - }, - "outputAudioText": { # A text or ssml response that is preferentially used for TTS output audio synthesis, as described in the comment on the ResponseMessage message. # A text or ssml response that is preferentially used for TTS output audio synthesis, as described in the comment on the ResponseMessage message. - "allowPlaybackInterruption": True or False, # 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. - "ssml": "A String", # The SSML text to be synthesized. For more information, see [SSML](/speech/text-to-speech/docs/ssml). - "text": "A String", # The raw text to be synthesized. - }, - "payload": { # Returns a response containing a custom, platform-specific payload. - "a_key": "", # Properties of the object. - }, - "playAudio": { # Specifies an audio clip to be played by the client as part of the response. # Signal that the client should play an audio clip hosted at a client-specific URI. Dialogflow uses this to construct mixed_audio. However, Dialogflow itself does not try to read or process the URI in any way. - "allowPlaybackInterruption": True or False, # 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. - "audioUri": "A String", # Required. URI of the audio clip. Dialogflow does not impose any validation on this value. It is specific to the client that reads it. - }, - "telephonyTransferCall": { # Represents the signal that telles the client to transfer the phone call connected to the agent to a third-party endpoint. # A signal that the client should transfer the phone call connected to this agent to a third-party endpoint. - "phoneNumber": "A String", # Transfer the call to a phone number in [E.164 format](https://en.wikipedia.org/wiki/E.164). + "tool": "A String", # Required. The tool associated with this call. Format: `projects//locations//agents//tools/`. + }, }, - "text": { # The text response message. # Returns a text response. - "allowPlaybackInterruption": True or False, # 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. - "text": [ # Required. A collection of text responses. - "A String", - ], + ], + "returnPartialResponses": True or False, # Whether Dialogflow should return currently queued fulfillment response messages in streaming APIs. If a webhook is specified, it happens before Dialogflow invokes webhook. Warning: 1) This flag only affects streaming API. Responses are still queued and returned once in non-streaming API. 2) The flag can be enabled in any fulfillment but only the first 3 partial responses will be returned. You may only want to apply it to fulfillments that have slow webhooks. + "setParameterActions": [ # Set parameter values before executing the webhook. + { # Setting a parameter value. + "parameter": "A String", # Display name of the parameter. + "value": "", # The new value of the parameter. A null value clears the parameter. }, - }, - ], - "returnPartialResponses": True or False, # Whether Dialogflow should return currently queued fulfillment response messages in streaming APIs. If a webhook is specified, it happens before Dialogflow invokes webhook. Warning: 1) This flag only affects streaming API. Responses are still queued and returned once in non-streaming API. 2) The flag can be enabled in any fulfillment but only the first 3 partial responses will be returned. You may only want to apply it to fulfillments that have slow webhooks. - "setParameterActions": [ # Set parameter values before executing the webhook. - { # Setting a parameter value. - "parameter": "A String", # Display name of the parameter. - "value": "", # The new value of the parameter. A null value clears the parameter. - }, - ], - "tag": "A String", # The value of this field will be populated in the WebhookRequest `fulfillmentInfo.tag` field by Dialogflow when the associated webhook is called. The tag is typically used by the webhook service to identify which fulfillment is being called, but it could be used for other purposes. This field is required if `webhook` is specified. - "webhook": "A String", # The webhook to call. Format: `projects//locations//agents//webhooks/`. - }, - }, - ], - }, - ], - "startTime": "A String", # Start time of the conversation, which is the time of the first request of the conversation. - "type": "A String", # The type of the conversation. -}
-
- -
- list(parent, filter=None, pageSize=None, pageToken=None, x__xgafv=None) -
Returns the list of all conversations.
-
-Args:
-  parent: string, Required. The agent to list all conversations for. Format: `projects//locations//agents/`. (required)
-  filter: string, Optional. The filter string. Supports filter by create_time, metrics.has_end_interaction, metrics.has_live_agent_handoff, intents.display_name, pages.display_name and flows.display_name. Timestamps expect an RFC-3339 formatted string (e.g. 2012-04-21T11:30:00-04:00). UTC offsets are supported. Some examples: 1. By create time: create_time > "2022-04-21T11:30:00-04:00" 2. By intent display name: intents.display_name : "billing" 3. By end interaction signal: metrics.has_end_interaction = true
-  pageSize: integer, Optional. The maximum number of items to return in a single page. By default 100 and at most 1000.
-  pageToken: string, Optional. The next_page_token value returned from a previous list request.
-  x__xgafv: string, V1 error format.
-    Allowed values
-      1 - v1 error format
-      2 - v2 error format
-
-Returns:
-  An object of the form:
-
-    { # The response message for Conversations.ListConversations.
-  "conversations": [ # The list of conversations. There will be a maximum number of items returned based on the page_size field. The returned conversations will be sorted by start_time in descending order (newest conversation first).
-    { # Represents a conversation.
-      "duration": "A String", # Duration of the conversation.
-      "environment": { # Represents an environment for an agent. You can create multiple versions of your agent and publish them to separate environments. When you edit an agent, you are editing the draft agent. At any point, you can save the draft agent as an agent version, which is an immutable snapshot of your agent. When you save the draft agent, it is published to the default environment. When you create agent versions, you can publish them to custom environments. You can create a variety of custom environments for testing, development, production, etc. # Environment of the conversation. Only `name` and `display_name` are filled in this message.
-        "description": "A String", # The human-readable description of the environment. The maximum length is 500 characters. If exceeded, the request is rejected.
-        "displayName": "A String", # Required. The human-readable name of the environment (unique in an agent). Limit of 64 characters.
-        "name": "A String", # The name of the environment. Format: `projects//locations//agents//environments/`.
-        "testCasesConfig": { # The configuration for continuous tests. # The test cases config for continuous tests of this environment.
-          "enableContinuousRun": True or False, # Whether to run test cases in TestCasesConfig.test_cases periodically. Default false. If set to true, run once a day.
-          "enablePredeploymentRun": True or False, # Whether to run test cases in TestCasesConfig.test_cases before deploying a flow version to the environment. Default false.
-          "testCases": [ # A list of test case names to run. They should be under the same agent. Format of each test case name: `projects//locations/ /agents//testCases/`
-            "A String",
-          ],
-        },
-        "updateTime": "A String", # Output only. Update time of this environment.
-        "versionConfigs": [ # A list of configurations for flow versions. You should include version configs for all flows that are reachable from `Start Flow` in the agent. Otherwise, an error will be returned.
-          { # Configuration for the version.
-            "version": "A String", # Required. Format: projects//locations//agents//flows//versions/.
-          },
-        ],
-        "webhookConfig": { # Configuration for webhooks. # The webhook configuration for this environment.
-          "webhookOverrides": [ # The list of webhooks to override for the agent environment. The webhook must exist in the agent. You can override fields in `generic_web_service` and `service_directory`.
-            { # Webhooks host the developer's business logic. During a session, webhooks allow the developer to use the data extracted by Dialogflow's natural language processing to generate dynamic responses, validate collected data, or trigger actions on the backend.
-              "disabled": True or False, # Indicates whether the webhook is disabled.
-              "displayName": "A String", # Required. The human-readable name of the webhook, unique within the agent.
-              "genericWebService": { # Represents configuration for a generic web service. # Configuration for a generic web service.
-                "allowedCaCerts": [ # Optional. Specifies a list of allowed custom CA certificates (in DER format) for HTTPS verification. This overrides the default SSL trust store. If this is empty or unspecified, Dialogflow will use Google's default trust store to verify certificates. N.B. Make sure the HTTPS server certificates are signed with "subject alt name". For instance a certificate can be self-signed using the following command, ``` openssl x509 -req -days 200 -in example.com.csr \ -signkey example.com.key \ -out example.com.crt \ -extfile <(printf "\nsubjectAltName='DNS:www.example.com'") ```
-                  "A String",
-                ],
-                "httpMethod": "A String", # Optional. HTTP method for the flexible webhook calls. Standard webhook always uses POST.
-                "oauthConfig": { # Represents configuration of OAuth client credential flow for 3rd party API authentication. # Optional. The OAuth configuration of the webhook. If specified, Dialogflow will initiate the OAuth client credential flow to exchange an access token from the 3rd party platform and put it in the auth header.
-                  "clientId": "A String", # Required. The client ID provided by the 3rd party platform.
-                  "clientSecret": "A String", # Required. The client secret provided by the 3rd party platform.
-                  "scopes": [ # Optional. The OAuth scopes to grant.
-                    "A String",
-                  ],
-                  "tokenEndpoint": "A String", # Required. The token endpoint provided by the 3rd party platform to exchange an access token.
-                },
-                "parameterMapping": { # Optional. Maps the values extracted from specific fields of the flexible webhook response into session parameters. - Key: session parameter name - Value: field path in the webhook response
-                  "a_key": "A String",
-                },
-                "password": "A String", # The password for HTTP Basic authentication.
-                "requestBody": "A String", # Optional. Defines a custom JSON object as request body to send to flexible webhook.
-                "requestHeaders": { # The HTTP request headers to send together with webhook requests.
-                  "a_key": "A String",
-                },
-                "serviceAgentAuth": "A String", # Optional. Indicate the auth token type generated from the [Diglogflow service agent](https://cloud.google.com/iam/docs/service-agents#dialogflow-service-agent). The generated token is sent in the Authorization header.
-                "uri": "A String", # Required. The webhook URI for receiving POST requests. It must use https protocol.
-                "username": "A String", # The user name for HTTP Basic authentication.
-                "webhookType": "A String", # Optional. Type of the webhook.
-              },
-              "name": "A String", # The unique identifier of the webhook. Required for the Webhooks.UpdateWebhook method. Webhooks.CreateWebhook populates the name automatically. Format: `projects//locations//agents//webhooks/`.
-              "serviceDirectory": { # Represents configuration for a [Service Directory](https://cloud.google.com/service-directory) service. # Configuration for a [Service Directory](https://cloud.google.com/service-directory) service.
-                "genericWebService": { # Represents configuration for a generic web service. # Generic Service configuration of this webhook.
-                  "allowedCaCerts": [ # Optional. Specifies a list of allowed custom CA certificates (in DER format) for HTTPS verification. This overrides the default SSL trust store. If this is empty or unspecified, Dialogflow will use Google's default trust store to verify certificates. N.B. Make sure the HTTPS server certificates are signed with "subject alt name". For instance a certificate can be self-signed using the following command, ``` openssl x509 -req -days 200 -in example.com.csr \ -signkey example.com.key \ -out example.com.crt \ -extfile <(printf "\nsubjectAltName='DNS:www.example.com'") ```
-                    "A String",
-                  ],
-                  "httpMethod": "A String", # Optional. HTTP method for the flexible webhook calls. Standard webhook always uses POST.
-                  "oauthConfig": { # Represents configuration of OAuth client credential flow for 3rd party API authentication. # Optional. The OAuth configuration of the webhook. If specified, Dialogflow will initiate the OAuth client credential flow to exchange an access token from the 3rd party platform and put it in the auth header.
-                    "clientId": "A String", # Required. The client ID provided by the 3rd party platform.
-                    "clientSecret": "A String", # Required. The client secret provided by the 3rd party platform.
-                    "scopes": [ # Optional. The OAuth scopes to grant.
-                      "A String",
-                    ],
-                    "tokenEndpoint": "A String", # Required. The token endpoint provided by the 3rd party platform to exchange an access token.
-                  },
-                  "parameterMapping": { # Optional. Maps the values extracted from specific fields of the flexible webhook response into session parameters. - Key: session parameter name - Value: field path in the webhook response
-                    "a_key": "A String",
-                  },
-                  "password": "A String", # The password for HTTP Basic authentication.
-                  "requestBody": "A String", # Optional. Defines a custom JSON object as request body to send to flexible webhook.
-                  "requestHeaders": { # The HTTP request headers to send together with webhook requests.
-                    "a_key": "A String",
-                  },
-                  "serviceAgentAuth": "A String", # Optional. Indicate the auth token type generated from the [Diglogflow service agent](https://cloud.google.com/iam/docs/service-agents#dialogflow-service-agent). The generated token is sent in the Authorization header.
-                  "uri": "A String", # Required. The webhook URI for receiving POST requests. It must use https protocol.
-                  "username": "A String", # The user name for HTTP Basic authentication.
-                  "webhookType": "A String", # Optional. Type of the webhook.
-                },
-                "service": "A String", # Required. The name of [Service Directory](https://cloud.google.com/service-directory) service. Format: `projects//locations//namespaces//services/`. `Location ID` of the service directory must be the same as the location of the agent.
-              },
-              "timeout": "A String", # Webhook execution timeout. Execution is considered failed if Dialogflow doesn't receive a response from webhook at the end of the timeout period. Defaults to 5 seconds, maximum allowed timeout is 30 seconds.
-            },
-          ],
-        },
-      },
-      "flowVersions": { # Flow versions used in the conversation.
-        "a_key": "A String",
-      },
-      "flows": [ # All the Flow the conversation has went through. Only `name` and `display_name` are filled in this message.
-        { # Flows represents the conversation flows when you build your chatbot agent. A flow consists of many pages connected by the transition routes. Conversations always start with the built-in Start Flow (with an all-0 ID). Transition routes can direct the conversation session from the current flow (parent flow) to another flow (sub flow). When the sub flow is finished, Dialogflow will bring the session back to the parent flow, where the sub flow is started. Usually, when a transition route is followed by a matched intent, the intent will be "consumed". This means the intent won't activate more transition routes. However, when the followed transition route moves the conversation session into a different flow, the matched intent can be carried over and to be consumed in the target flow.
-          "advancedSettings": { # Hierarchical advanced settings for agent/flow/page/fulfillment/parameter. Settings exposed at lower level overrides the settings exposed at higher level. Overriding occurs at the sub-setting level. For example, the playback_interruption_settings at fulfillment level only overrides the playback_interruption_settings at the agent level, leaving other settings at the agent level unchanged. DTMF settings does not override each other. DTMF settings set at different levels define DTMF detections running in parallel. Hierarchy: Agent->Flow->Page->Fulfillment/Parameter. # Hierarchical advanced settings for this flow. The settings exposed at the lower level overrides the settings exposed at the higher level.
-            "audioExportGcsDestination": { # Google Cloud Storage location for a Dialogflow operation that writes or exports objects (e.g. exported agent or transcripts) outside of Dialogflow. # If present, incoming audio is exported by Dialogflow to the configured Google Cloud Storage destination. Exposed at the following levels: - Agent level - Flow level
-              "uri": "A String", # Required. The Google Cloud Storage URI for the exported objects. A URI is of the form: `gs://bucket/object-name-or-prefix` Whether a full object name, or just a prefix, its usage depends on the Dialogflow operation.
-            },
-            "dtmfSettings": { # Define behaviors for DTMF (dual tone multi frequency). # Settings for DTMF. Exposed at the following levels: - Agent level - Flow level - Page level - Parameter level.
-              "enabled": True or False, # If true, incoming audio is processed for DTMF (dual tone multi frequency) events. For example, if the caller presses a button on their telephone keypad and DTMF processing is enabled, Dialogflow will detect the event (e.g. a "3" was pressed) in the incoming audio and pass the event to the bot to drive business logic (e.g. when 3 is pressed, return the account balance).
-              "endpointingTimeoutDuration": "A String", # Endpoint timeout setting for matching dtmf input to regex.
-              "finishDigit": "A String", # The digit that terminates a DTMF digit sequence.
-              "interdigitTimeoutDuration": "A String", # Interdigit timeout setting for matching dtmf input to regex.
-              "maxDigits": 42, # Max length of DTMF digits.
-            },
-            "loggingSettings": { # Define behaviors on logging. # Settings for logging. Settings for Dialogflow History, Contact Center messages, StackDriver logs, and speech logging. Exposed at the following levels: - Agent level.
-              "enableInteractionLogging": True or False, # If true, DF Interaction logging is currently enabled.
-              "enableStackdriverLogging": True or False, # If true, StackDriver logging is currently enabled.
-            },
-            "speechSettings": { # Define behaviors of speech to text detection. # Settings for speech to text detection. Exposed at the following levels: - Agent level - Flow level - Page level - Parameter level
-              "endpointerSensitivity": 42, # Sensitivity of the speech model that detects the end of speech. Scale from 0 to 100.
-              "models": { # Mapping from language to Speech-to-Text model. The mapped Speech-to-Text model will be selected for requests from its corresponding language. For more information, see [Speech models](https://cloud.google.com/dialogflow/cx/docs/concept/speech-models).
-                "a_key": "A String",
-              },
-              "noSpeechTimeout": "A String", # Timeout before detecting no speech.
-              "useTimeoutBasedEndpointing": True or False, # Use timeout based endpointing, interpreting endpointer sensitivy as seconds of timeout value.
+              ],
+              "tag": "A String", # The value of this field will be populated in the WebhookRequest `fulfillmentInfo.tag` field by Dialogflow when the associated webhook is called. The tag is typically used by the webhook service to identify which fulfillment is being called, but it could be used for other purposes. This field is required if `webhook` is specified.
+              "webhook": "A String", # The webhook to call. Format: `projects//locations//agents//webhooks/`.
             },
-          },
-          "description": "A String", # The description of the flow. The maximum length is 500 characters. If exceeded, the request is rejected.
-          "displayName": "A String", # Required. The human-readable name of the flow.
-          "eventHandlers": [ # A flow's event handlers serve two purposes: * They are responsible for handling events (e.g. no match, webhook errors) in the flow. * They are inherited by every page's event handlers, which can be used to handle common events regardless of the current page. Event handlers defined in the page have higher priority than those defined in the flow. Unlike transition_routes, these handlers are evaluated on a first-match basis. The first one that matches the event get executed, with the rest being ignored.
-            { # An event handler specifies an event that can be handled during a session. When the specified event happens, the following actions are taken in order: * If there is a `trigger_fulfillment` associated with the event, it will be called. * If there is a `target_page` associated with the event, the session will transition into the specified page. * If there is a `target_flow` associated with the event, the session will transition into the specified flow.
-              "event": "A String", # Required. The name of the event to handle.
-              "name": "A String", # Output only. The unique identifier of this event handler.
-              "targetFlow": "A String", # The target flow to transition to. Format: `projects//locations//agents//flows/`.
-              "targetPage": "A String", # The target page to transition to. Format: `projects//locations//agents//flows//pages/`.
-              "triggerFulfillment": { # A fulfillment can do one or more of the following actions at the same time: * Generate rich message responses. * Set parameter values. * Call the webhook. Fulfillments can be called at various stages in the Page or Form lifecycle. For example, when a DetectIntentRequest drives a session to enter a new page, the page's entry fulfillment can add a static response to the QueryResult in the returning DetectIntentResponse, call the webhook (for example, to load user data from a database), or both. # The fulfillment to call when the event occurs. Handling webhook errors with a fulfillment enabled with webhook could cause infinite loop. It is invalid to specify such fulfillment for a handler handling webhooks.
-                "advancedSettings": { # Hierarchical advanced settings for agent/flow/page/fulfillment/parameter. Settings exposed at lower level overrides the settings exposed at higher level. Overriding occurs at the sub-setting level. For example, the playback_interruption_settings at fulfillment level only overrides the playback_interruption_settings at the agent level, leaving other settings at the agent level unchanged. DTMF settings does not override each other. DTMF settings set at different levels define DTMF detections running in parallel. Hierarchy: Agent->Flow->Page->Fulfillment/Parameter. # Hierarchical advanced settings for this fulfillment. The settings exposed at the lower level overrides the settings exposed at the higher level.
-                  "audioExportGcsDestination": { # Google Cloud Storage location for a Dialogflow operation that writes or exports objects (e.g. exported agent or transcripts) outside of Dialogflow. # If present, incoming audio is exported by Dialogflow to the configured Google Cloud Storage destination. Exposed at the following levels: - Agent level - Flow level
-                    "uri": "A String", # Required. The Google Cloud Storage URI for the exported objects. A URI is of the form: `gs://bucket/object-name-or-prefix` Whether a full object name, or just a prefix, its usage depends on the Dialogflow operation.
-                  },
-                  "dtmfSettings": { # Define behaviors for DTMF (dual tone multi frequency). # Settings for DTMF. Exposed at the following levels: - Agent level - Flow level - Page level - Parameter level.
-                    "enabled": True or False, # If true, incoming audio is processed for DTMF (dual tone multi frequency) events. For example, if the caller presses a button on their telephone keypad and DTMF processing is enabled, Dialogflow will detect the event (e.g. a "3" was pressed) in the incoming audio and pass the event to the bot to drive business logic (e.g. when 3 is pressed, return the account balance).
-                    "endpointingTimeoutDuration": "A String", # Endpoint timeout setting for matching dtmf input to regex.
-                    "finishDigit": "A String", # The digit that terminates a DTMF digit sequence.
-                    "interdigitTimeoutDuration": "A String", # Interdigit timeout setting for matching dtmf input to regex.
-                    "maxDigits": 42, # Max length of DTMF digits.
-                  },
-                  "loggingSettings": { # Define behaviors on logging. # Settings for logging. Settings for Dialogflow History, Contact Center messages, StackDriver logs, and speech logging. Exposed at the following levels: - Agent level.
-                    "enableInteractionLogging": True or False, # If true, DF Interaction logging is currently enabled.
-                    "enableStackdriverLogging": True or False, # If true, StackDriver logging is currently enabled.
-                  },
-                  "speechSettings": { # Define behaviors of speech to text detection. # Settings for speech to text detection. Exposed at the following levels: - Agent level - Flow level - Page level - Parameter level
-                    "endpointerSensitivity": 42, # Sensitivity of the speech model that detects the end of speech. Scale from 0 to 100.
-                    "models": { # Mapping from language to Speech-to-Text model. The mapped Speech-to-Text model will be selected for requests from its corresponding language. For more information, see [Speech models](https://cloud.google.com/dialogflow/cx/docs/concept/speech-models).
-                      "a_key": "A String",
+            "eventHandlers": [ # Handlers associated with the page to handle events such as webhook errors, no match or no input.
+              { # An event handler specifies an event that can be handled during a session. When the specified event happens, the following actions are taken in order: * If there is a `trigger_fulfillment` associated with the event, it will be called. * If there is a `target_page` associated with the event, the session will transition into the specified page. * If there is a `target_flow` associated with the event, the session will transition into the specified flow.
+                "event": "A String", # Required. The name of the event to handle.
+                "name": "A String", # Output only. The unique identifier of this event handler.
+                "targetFlow": "A String", # The target flow to transition to. Format: `projects//locations//agents//flows/`.
+                "targetPage": "A String", # The target page to transition to. Format: `projects//locations//agents//flows//pages/`.
+                "triggerFulfillment": { # A fulfillment can do one or more of the following actions at the same time: * Generate rich message responses. * Set parameter values. * Call the webhook. Fulfillments can be called at various stages in the Page or Form lifecycle. For example, when a DetectIntentRequest drives a session to enter a new page, the page's entry fulfillment can add a static response to the QueryResult in the returning DetectIntentResponse, call the webhook (for example, to load user data from a database), or both. # The fulfillment to call when the event occurs. Handling webhook errors with a fulfillment enabled with webhook could cause infinite loop. It is invalid to specify such fulfillment for a handler handling webhooks.
+                  "advancedSettings": { # Hierarchical advanced settings for agent/flow/page/fulfillment/parameter. Settings exposed at lower level overrides the settings exposed at higher level. Overriding occurs at the sub-setting level. For example, the playback_interruption_settings at fulfillment level only overrides the playback_interruption_settings at the agent level, leaving other settings at the agent level unchanged. DTMF settings does not override each other. DTMF settings set at different levels define DTMF detections running in parallel. Hierarchy: Agent->Flow->Page->Fulfillment/Parameter. # Hierarchical advanced settings for this fulfillment. The settings exposed at the lower level overrides the settings exposed at the higher level.
+                    "audioExportGcsDestination": { # Google Cloud Storage location for a Dialogflow operation that writes or exports objects (e.g. exported agent or transcripts) outside of Dialogflow. # If present, incoming audio is exported by Dialogflow to the configured Google Cloud Storage destination. Exposed at the following levels: - Agent level - Flow level
+                      "uri": "A String", # Required. The Google Cloud Storage URI for the exported objects. A URI is of the form: `gs://bucket/object-name-or-prefix` Whether a full object name, or just a prefix, its usage depends on the Dialogflow operation.
+                    },
+                    "dtmfSettings": { # Define behaviors for DTMF (dual tone multi frequency). # Settings for DTMF. Exposed at the following levels: - Agent level - Flow level - Page level - Parameter level.
+                      "enabled": True or False, # If true, incoming audio is processed for DTMF (dual tone multi frequency) events. For example, if the caller presses a button on their telephone keypad and DTMF processing is enabled, Dialogflow will detect the event (e.g. a "3" was pressed) in the incoming audio and pass the event to the bot to drive business logic (e.g. when 3 is pressed, return the account balance).
+                      "endpointingTimeoutDuration": "A String", # Endpoint timeout setting for matching dtmf input to regex.
+                      "finishDigit": "A String", # The digit that terminates a DTMF digit sequence.
+                      "interdigitTimeoutDuration": "A String", # Interdigit timeout setting for matching dtmf input to regex.
+                      "maxDigits": 42, # Max length of DTMF digits.
+                    },
+                    "loggingSettings": { # Define behaviors on logging. # Settings for logging. Settings for Dialogflow History, Contact Center messages, StackDriver logs, and speech logging. Exposed at the following levels: - Agent level.
+                      "enableInteractionLogging": True or False, # Enables DF Interaction logging.
+                      "enableStackdriverLogging": True or False, # Enables StackDriver logging.
+                    },
+                    "speechSettings": { # Define behaviors of speech to text detection. # Settings for speech to text detection. Exposed at the following levels: - Agent level - Flow level - Page level - Parameter level
+                      "endpointerSensitivity": 42, # Sensitivity of the speech model that detects the end of speech. Scale from 0 to 100.
+                      "models": { # Mapping from language to Speech-to-Text model. The mapped Speech-to-Text model will be selected for requests from its corresponding language. For more information, see [Speech models](https://cloud.google.com/dialogflow/cx/docs/concept/speech-models).
+                        "a_key": "A String",
+                      },
+                      "noSpeechTimeout": "A String", # Timeout before detecting no speech.
+                      "useTimeoutBasedEndpointing": True or False, # Use timeout based endpointing, interpreting endpointer sensitivy as seconds of timeout value.
                     },
-                    "noSpeechTimeout": "A String", # Timeout before detecting no speech.
-                    "useTimeoutBasedEndpointing": True or False, # Use timeout based endpointing, interpreting endpointer sensitivy as seconds of timeout value.
                   },
-                },
-                "conditionalCases": [ # Conditional cases for this fulfillment.
-                  { # A list of cascading if-else conditions. Cases are mutually exclusive. The first one with a matching condition is selected, all the rest ignored.
-                    "cases": [ # A list of cascading if-else conditions.
-                      { # Each case has a Boolean condition. When it is evaluated to be True, the corresponding messages will be selected and evaluated recursively.
-                        "caseContent": [ # A list of case content.
-                          { # The list of messages or conditional cases to activate for this case.
-                            "additionalCases": # Object with schema name: GoogleCloudDialogflowCxV3beta1FulfillmentConditionalCases # Additional cases to be evaluated.
-                            "message": { # 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. # Returned message.
-                              "channel": "A String", # The channel which the response is associated with. Clients can specify the channel via QueryParameters.channel, and only associated channel response will be returned.
-                              "conversationSuccess": { # 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. # Indicates that the conversation succeeded.
-                                "metadata": { # Custom metadata. Dialogflow doesn't impose any structure on this.
-                                  "a_key": "", # Properties of the object.
+                  "conditionalCases": [ # Conditional cases for this fulfillment.
+                    { # A list of cascading if-else conditions. Cases are mutually exclusive. The first one with a matching condition is selected, all the rest ignored.
+                      "cases": [ # A list of cascading if-else conditions.
+                        { # Each case has a Boolean condition. When it is evaluated to be True, the corresponding messages will be selected and evaluated recursively.
+                          "caseContent": [ # A list of case content.
+                            { # The list of messages or conditional cases to activate for this case.
+                              "additionalCases": # Object with schema name: GoogleCloudDialogflowCxV3beta1FulfillmentConditionalCases # Additional cases to be evaluated.
+                              "message": { # 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. # Returned message.
+                                "channel": "A String", # The channel which the response is associated with. Clients can specify the channel via QueryParameters.channel, and only associated channel response will be returned.
+                                "conversationSuccess": { # 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. # Indicates that the conversation succeeded.
+                                  "metadata": { # Custom metadata. Dialogflow doesn't impose any structure on this.
+                                    "a_key": "", # Properties of the object.
+                                  },
                                 },
-                              },
-                              "endInteraction": { # 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. # Output only. A signal that indicates the interaction with the Dialogflow agent has ended. This message is generated by Dialogflow only when the conversation reaches `END_SESSION` page. It is not supposed to be defined by the user. It's guaranteed that there is at most one such message in each response.
-                              },
-                              "knowledgeInfoCard": { # Represents info card response. If the response contains generative knowledge prediction, Dialogflow will return a payload with Infobot Messenger compatible info card. Otherwise, the info card response is skipped. # Represents info card for knowledge answers, to be better rendered in Dialogflow Messenger.
-                              },
-                              "liveAgentHandoff": { # 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. # Hands off conversation to a human agent.
-                                "metadata": { # Custom metadata for your handoff procedure. Dialogflow doesn't impose any structure on this.
+                                "endInteraction": { # 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. # Output only. A signal that indicates the interaction with the Dialogflow agent has ended. This message is generated by Dialogflow only when the conversation reaches `END_SESSION` page. It is not supposed to be defined by the user. It's guaranteed that there is at most one such message in each response.
+                                },
+                                "knowledgeInfoCard": { # Represents info card response. If the response contains generative knowledge prediction, Dialogflow will return a payload with Infobot Messenger compatible info card. Otherwise, the info card response is skipped. # Represents info card for knowledge answers, to be better rendered in Dialogflow Messenger.
+                                },
+                                "liveAgentHandoff": { # 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. # Hands off conversation to a human agent.
+                                  "metadata": { # Custom metadata for your handoff procedure. Dialogflow doesn't impose any structure on this.
+                                    "a_key": "", # Properties of the object.
+                                  },
+                                },
+                                "mixedAudio": { # 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. # Output only. An audio response message composed of both the synthesized Dialogflow agent responses and responses defined via play_audio. This message is generated by Dialogflow only and not supposed to be defined by the user.
+                                  "segments": [ # Segments this audio response is composed of.
+                                    { # Represents one segment of audio.
+                                      "allowPlaybackInterruption": True or False, # 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.
+                                      "audio": "A String", # Raw audio synthesized from the Dialogflow agent's response using the output config specified in the request.
+                                      "uri": "A String", # Client-specific URI that points to an audio clip accessible to the client. Dialogflow does not impose any validation on it.
+                                    },
+                                  ],
+                                },
+                                "outputAudioText": { # A text or ssml response that is preferentially used for TTS output audio synthesis, as described in the comment on the ResponseMessage message. # A text or ssml response that is preferentially used for TTS output audio synthesis, as described in the comment on the ResponseMessage message.
+                                  "allowPlaybackInterruption": True or False, # 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.
+                                  "ssml": "A String", # The SSML text to be synthesized. For more information, see [SSML](/speech/text-to-speech/docs/ssml).
+                                  "text": "A String", # The raw text to be synthesized.
+                                },
+                                "payload": { # Returns a response containing a custom, platform-specific payload.
                                   "a_key": "", # Properties of the object.
                                 },
-                              },
-                              "mixedAudio": { # 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. # Output only. An audio response message composed of both the synthesized Dialogflow agent responses and responses defined via play_audio. This message is generated by Dialogflow only and not supposed to be defined by the user.
-                                "segments": [ # Segments this audio response is composed of.
-                                  { # Represents one segment of audio.
-                                    "allowPlaybackInterruption": True or False, # 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.
-                                    "audio": "A String", # Raw audio synthesized from the Dialogflow agent's response using the output config specified in the request.
-                                    "uri": "A String", # Client-specific URI that points to an audio clip accessible to the client. Dialogflow does not impose any validation on it.
+                                "playAudio": { # Specifies an audio clip to be played by the client as part of the response. # Signal that the client should play an audio clip hosted at a client-specific URI. Dialogflow uses this to construct mixed_audio. However, Dialogflow itself does not try to read or process the URI in any way.
+                                  "allowPlaybackInterruption": True or False, # 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.
+                                  "audioUri": "A String", # Required. URI of the audio clip. Dialogflow does not impose any validation on this value. It is specific to the client that reads it.
+                                },
+                                "telephonyTransferCall": { # Represents the signal that telles the client to transfer the phone call connected to the agent to a third-party endpoint. # A signal that the client should transfer the phone call connected to this agent to a third-party endpoint.
+                                  "phoneNumber": "A String", # Transfer the call to a phone number in [E.164 format](https://en.wikipedia.org/wiki/E.164).
+                                },
+                                "text": { # The text response message. # Returns a text response.
+                                  "allowPlaybackInterruption": True or False, # 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.
+                                  "text": [ # Required. A collection of text responses.
+                                    "A String",
+                                  ],
+                                },
+                                "toolCall": { # Represents a call of a specific tool's action with the specified inputs. # Returns the definition of a tool call that should be executed by the client.
+                                  "action": "A String", # Required. The name of the tool's action associated with this call.
+                                  "inputParameters": { # Optional. The action's input parameters.
+                                    "a_key": "", # Properties of the object.
                                   },
-                                ],
-                              },
-                              "outputAudioText": { # A text or ssml response that is preferentially used for TTS output audio synthesis, as described in the comment on the ResponseMessage message. # A text or ssml response that is preferentially used for TTS output audio synthesis, as described in the comment on the ResponseMessage message.
-                                "allowPlaybackInterruption": True or False, # 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.
-                                "ssml": "A String", # The SSML text to be synthesized. For more information, see [SSML](/speech/text-to-speech/docs/ssml).
-                                "text": "A String", # The raw text to be synthesized.
-                              },
-                              "payload": { # Returns a response containing a custom, platform-specific payload.
-                                "a_key": "", # Properties of the object.
-                              },
-                              "playAudio": { # Specifies an audio clip to be played by the client as part of the response. # Signal that the client should play an audio clip hosted at a client-specific URI. Dialogflow uses this to construct mixed_audio. However, Dialogflow itself does not try to read or process the URI in any way.
-                                "allowPlaybackInterruption": True or False, # 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.
-                                "audioUri": "A String", # Required. URI of the audio clip. Dialogflow does not impose any validation on this value. It is specific to the client that reads it.
-                              },
-                              "telephonyTransferCall": { # Represents the signal that telles the client to transfer the phone call connected to the agent to a third-party endpoint. # A signal that the client should transfer the phone call connected to this agent to a third-party endpoint.
-                                "phoneNumber": "A String", # Transfer the call to a phone number in [E.164 format](https://en.wikipedia.org/wiki/E.164).
-                              },
-                              "text": { # The text response message. # Returns a text response.
-                                "allowPlaybackInterruption": True or False, # 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.
-                                "text": [ # Required. A collection of text responses.
-                                  "A String",
-                                ],
+                                  "tool": "A String", # Required. The tool associated with this call. Format: `projects//locations//agents//tools/`.
+                                },
                               },
                             },
+                          ],
+                          "condition": "A String", # The condition to activate and select this case. Empty means the condition is always true. The condition is evaluated against form parameters or session parameters. See the [conditions reference](https://cloud.google.com/dialogflow/cx/docs/reference/condition).
+                        },
+                      ],
+                    },
+                  ],
+                  "enableGenerativeFallback": True or False, # If the flag is true, the agent will utilize LLM to generate a text response. If LLM generation fails, the defined responses in the fulfillment will be respected. This flag is only useful for fulfillments associated with no-match event handlers.
+                  "messages": [ # The list of rich message responses to present to the user.
+                    { # 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.
+                      "channel": "A String", # The channel which the response is associated with. Clients can specify the channel via QueryParameters.channel, and only associated channel response will be returned.
+                      "conversationSuccess": { # 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. # Indicates that the conversation succeeded.
+                        "metadata": { # Custom metadata. Dialogflow doesn't impose any structure on this.
+                          "a_key": "", # Properties of the object.
+                        },
+                      },
+                      "endInteraction": { # 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. # Output only. A signal that indicates the interaction with the Dialogflow agent has ended. This message is generated by Dialogflow only when the conversation reaches `END_SESSION` page. It is not supposed to be defined by the user. It's guaranteed that there is at most one such message in each response.
+                      },
+                      "knowledgeInfoCard": { # Represents info card response. If the response contains generative knowledge prediction, Dialogflow will return a payload with Infobot Messenger compatible info card. Otherwise, the info card response is skipped. # Represents info card for knowledge answers, to be better rendered in Dialogflow Messenger.
+                      },
+                      "liveAgentHandoff": { # 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. # Hands off conversation to a human agent.
+                        "metadata": { # Custom metadata for your handoff procedure. Dialogflow doesn't impose any structure on this.
+                          "a_key": "", # Properties of the object.
+                        },
+                      },
+                      "mixedAudio": { # 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. # Output only. An audio response message composed of both the synthesized Dialogflow agent responses and responses defined via play_audio. This message is generated by Dialogflow only and not supposed to be defined by the user.
+                        "segments": [ # Segments this audio response is composed of.
+                          { # Represents one segment of audio.
+                            "allowPlaybackInterruption": True or False, # 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.
+                            "audio": "A String", # Raw audio synthesized from the Dialogflow agent's response using the output config specified in the request.
+                            "uri": "A String", # Client-specific URI that points to an audio clip accessible to the client. Dialogflow does not impose any validation on it.
                           },
                         ],
-                        "condition": "A String", # The condition to activate and select this case. Empty means the condition is always true. The condition is evaluated against form parameters or session parameters. See the [conditions reference](https://cloud.google.com/dialogflow/cx/docs/reference/condition).
                       },
-                    ],
-                  },
-                ],
-                "enableGenerativeFallback": True or False, # If the flag is true, the agent will utilize LLM to generate a text response. If LLM generation fails, the defined responses in the fulfillment will be respected. This flag is only useful for fulfillments associated with no-match event handlers.
-                "messages": [ # The list of rich message responses to present to the user.
-                  { # 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.
-                    "channel": "A String", # The channel which the response is associated with. Clients can specify the channel via QueryParameters.channel, and only associated channel response will be returned.
-                    "conversationSuccess": { # 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. # Indicates that the conversation succeeded.
-                      "metadata": { # Custom metadata. Dialogflow doesn't impose any structure on this.
-                        "a_key": "", # Properties of the object.
+                      "outputAudioText": { # A text or ssml response that is preferentially used for TTS output audio synthesis, as described in the comment on the ResponseMessage message. # A text or ssml response that is preferentially used for TTS output audio synthesis, as described in the comment on the ResponseMessage message.
+                        "allowPlaybackInterruption": True or False, # 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.
+                        "ssml": "A String", # The SSML text to be synthesized. For more information, see [SSML](/speech/text-to-speech/docs/ssml).
+                        "text": "A String", # The raw text to be synthesized.
                       },
-                    },
-                    "endInteraction": { # 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. # Output only. A signal that indicates the interaction with the Dialogflow agent has ended. This message is generated by Dialogflow only when the conversation reaches `END_SESSION` page. It is not supposed to be defined by the user. It's guaranteed that there is at most one such message in each response.
-                    },
-                    "knowledgeInfoCard": { # Represents info card response. If the response contains generative knowledge prediction, Dialogflow will return a payload with Infobot Messenger compatible info card. Otherwise, the info card response is skipped. # Represents info card for knowledge answers, to be better rendered in Dialogflow Messenger.
-                    },
-                    "liveAgentHandoff": { # 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. # Hands off conversation to a human agent.
-                      "metadata": { # Custom metadata for your handoff procedure. Dialogflow doesn't impose any structure on this.
+                      "payload": { # Returns a response containing a custom, platform-specific payload.
                         "a_key": "", # Properties of the object.
                       },
-                    },
-                    "mixedAudio": { # 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. # Output only. An audio response message composed of both the synthesized Dialogflow agent responses and responses defined via play_audio. This message is generated by Dialogflow only and not supposed to be defined by the user.
-                      "segments": [ # Segments this audio response is composed of.
-                        { # Represents one segment of audio.
-                          "allowPlaybackInterruption": True or False, # 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.
-                          "audio": "A String", # Raw audio synthesized from the Dialogflow agent's response using the output config specified in the request.
-                          "uri": "A String", # Client-specific URI that points to an audio clip accessible to the client. Dialogflow does not impose any validation on it.
+                      "playAudio": { # Specifies an audio clip to be played by the client as part of the response. # Signal that the client should play an audio clip hosted at a client-specific URI. Dialogflow uses this to construct mixed_audio. However, Dialogflow itself does not try to read or process the URI in any way.
+                        "allowPlaybackInterruption": True or False, # 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.
+                        "audioUri": "A String", # Required. URI of the audio clip. Dialogflow does not impose any validation on this value. It is specific to the client that reads it.
+                      },
+                      "telephonyTransferCall": { # Represents the signal that telles the client to transfer the phone call connected to the agent to a third-party endpoint. # A signal that the client should transfer the phone call connected to this agent to a third-party endpoint.
+                        "phoneNumber": "A String", # Transfer the call to a phone number in [E.164 format](https://en.wikipedia.org/wiki/E.164).
+                      },
+                      "text": { # The text response message. # Returns a text response.
+                        "allowPlaybackInterruption": True or False, # 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.
+                        "text": [ # Required. A collection of text responses.
+                          "A String",
+                        ],
+                      },
+                      "toolCall": { # Represents a call of a specific tool's action with the specified inputs. # Returns the definition of a tool call that should be executed by the client.
+                        "action": "A String", # Required. The name of the tool's action associated with this call.
+                        "inputParameters": { # Optional. The action's input parameters.
+                          "a_key": "", # Properties of the object.
                         },
-                      ],
+                        "tool": "A String", # Required. The tool associated with this call. Format: `projects//locations//agents//tools/`.
+                      },
                     },
-                    "outputAudioText": { # A text or ssml response that is preferentially used for TTS output audio synthesis, as described in the comment on the ResponseMessage message. # A text or ssml response that is preferentially used for TTS output audio synthesis, as described in the comment on the ResponseMessage message.
-                      "allowPlaybackInterruption": True or False, # 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.
-                      "ssml": "A String", # The SSML text to be synthesized. For more information, see [SSML](/speech/text-to-speech/docs/ssml).
-                      "text": "A String", # The raw text to be synthesized.
+                  ],
+                  "returnPartialResponses": True or False, # Whether Dialogflow should return currently queued fulfillment response messages in streaming APIs. If a webhook is specified, it happens before Dialogflow invokes webhook. Warning: 1) This flag only affects streaming API. Responses are still queued and returned once in non-streaming API. 2) The flag can be enabled in any fulfillment but only the first 3 partial responses will be returned. You may only want to apply it to fulfillments that have slow webhooks.
+                  "setParameterActions": [ # Set parameter values before executing the webhook.
+                    { # Setting a parameter value.
+                      "parameter": "A String", # Display name of the parameter.
+                      "value": "", # The new value of the parameter. A null value clears the parameter.
                     },
-                    "payload": { # Returns a response containing a custom, platform-specific payload.
-                      "a_key": "", # Properties of the object.
+                  ],
+                  "tag": "A String", # The value of this field will be populated in the WebhookRequest `fulfillmentInfo.tag` field by Dialogflow when the associated webhook is called. The tag is typically used by the webhook service to identify which fulfillment is being called, but it could be used for other purposes. This field is required if `webhook` is specified.
+                  "webhook": "A String", # The webhook to call. Format: `projects//locations//agents//webhooks/`.
+                },
+              },
+            ],
+            "form": { # A form is a data model that groups related parameters that can be collected from the user. The process in which the agent prompts the user and collects parameter values from the user is called form filling. A form can be added to a page. When form filling is done, the filled parameters will be written to the session. # The form associated with the page, used for collecting parameters relevant to the page.
+              "parameters": [ # Parameters to collect from the user.
+                { # Represents a form parameter.
+                  "advancedSettings": { # Hierarchical advanced settings for agent/flow/page/fulfillment/parameter. Settings exposed at lower level overrides the settings exposed at higher level. Overriding occurs at the sub-setting level. For example, the playback_interruption_settings at fulfillment level only overrides the playback_interruption_settings at the agent level, leaving other settings at the agent level unchanged. DTMF settings does not override each other. DTMF settings set at different levels define DTMF detections running in parallel. Hierarchy: Agent->Flow->Page->Fulfillment/Parameter. # Hierarchical advanced settings for this parameter. The settings exposed at the lower level overrides the settings exposed at the higher level.
+                    "audioExportGcsDestination": { # Google Cloud Storage location for a Dialogflow operation that writes or exports objects (e.g. exported agent or transcripts) outside of Dialogflow. # If present, incoming audio is exported by Dialogflow to the configured Google Cloud Storage destination. Exposed at the following levels: - Agent level - Flow level
+                      "uri": "A String", # Required. The Google Cloud Storage URI for the exported objects. A URI is of the form: `gs://bucket/object-name-or-prefix` Whether a full object name, or just a prefix, its usage depends on the Dialogflow operation.
                     },
-                    "playAudio": { # Specifies an audio clip to be played by the client as part of the response. # Signal that the client should play an audio clip hosted at a client-specific URI. Dialogflow uses this to construct mixed_audio. However, Dialogflow itself does not try to read or process the URI in any way.
-                      "allowPlaybackInterruption": True or False, # 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.
-                      "audioUri": "A String", # Required. URI of the audio clip. Dialogflow does not impose any validation on this value. It is specific to the client that reads it.
+                    "dtmfSettings": { # Define behaviors for DTMF (dual tone multi frequency). # Settings for DTMF. Exposed at the following levels: - Agent level - Flow level - Page level - Parameter level.
+                      "enabled": True or False, # If true, incoming audio is processed for DTMF (dual tone multi frequency) events. For example, if the caller presses a button on their telephone keypad and DTMF processing is enabled, Dialogflow will detect the event (e.g. a "3" was pressed) in the incoming audio and pass the event to the bot to drive business logic (e.g. when 3 is pressed, return the account balance).
+                      "endpointingTimeoutDuration": "A String", # Endpoint timeout setting for matching dtmf input to regex.
+                      "finishDigit": "A String", # The digit that terminates a DTMF digit sequence.
+                      "interdigitTimeoutDuration": "A String", # Interdigit timeout setting for matching dtmf input to regex.
+                      "maxDigits": 42, # Max length of DTMF digits.
                     },
-                    "telephonyTransferCall": { # Represents the signal that telles the client to transfer the phone call connected to the agent to a third-party endpoint. # A signal that the client should transfer the phone call connected to this agent to a third-party endpoint.
-                      "phoneNumber": "A String", # Transfer the call to a phone number in [E.164 format](https://en.wikipedia.org/wiki/E.164).
+                    "loggingSettings": { # Define behaviors on logging. # Settings for logging. Settings for Dialogflow History, Contact Center messages, StackDriver logs, and speech logging. Exposed at the following levels: - Agent level.
+                      "enableInteractionLogging": True or False, # Enables DF Interaction logging.
+                      "enableStackdriverLogging": True or False, # Enables StackDriver logging.
                     },
-                    "text": { # The text response message. # Returns a text response.
-                      "allowPlaybackInterruption": True or False, # 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.
-                      "text": [ # Required. A collection of text responses.
-                        "A String",
-                      ],
+                    "speechSettings": { # Define behaviors of speech to text detection. # Settings for speech to text detection. Exposed at the following levels: - Agent level - Flow level - Page level - Parameter level
+                      "endpointerSensitivity": 42, # Sensitivity of the speech model that detects the end of speech. Scale from 0 to 100.
+                      "models": { # Mapping from language to Speech-to-Text model. The mapped Speech-to-Text model will be selected for requests from its corresponding language. For more information, see [Speech models](https://cloud.google.com/dialogflow/cx/docs/concept/speech-models).
+                        "a_key": "A String",
+                      },
+                      "noSpeechTimeout": "A String", # Timeout before detecting no speech.
+                      "useTimeoutBasedEndpointing": True or False, # Use timeout based endpointing, interpreting endpointer sensitivy as seconds of timeout value.
                     },
                   },
-                ],
-                "returnPartialResponses": True or False, # Whether Dialogflow should return currently queued fulfillment response messages in streaming APIs. If a webhook is specified, it happens before Dialogflow invokes webhook. Warning: 1) This flag only affects streaming API. Responses are still queued and returned once in non-streaming API. 2) The flag can be enabled in any fulfillment but only the first 3 partial responses will be returned. You may only want to apply it to fulfillments that have slow webhooks.
-                "setParameterActions": [ # Set parameter values before executing the webhook.
-                  { # Setting a parameter value.
-                    "parameter": "A String", # Display name of the parameter.
-                    "value": "", # The new value of the parameter. A null value clears the parameter.
-                  },
-                ],
-                "tag": "A String", # The value of this field will be populated in the WebhookRequest `fulfillmentInfo.tag` field by Dialogflow when the associated webhook is called. The tag is typically used by the webhook service to identify which fulfillment is being called, but it could be used for other purposes. This field is required if `webhook` is specified.
-                "webhook": "A String", # The webhook to call. Format: `projects//locations//agents//webhooks/`.
-              },
-            },
-          ],
-          "knowledgeConnectorSettings": { # The Knowledge Connector settings for this page or flow. This includes information such as the attached Knowledge Bases, and the way to execute fulfillment. # Optional. Knowledge connector configuration.
-            "dataStoreConnections": [ # Optional. List of related data store connections.
-              { # A data store connection. It represents a data store in Discovery Engine and the type of the contents it contains.
-                "dataStore": "A String", # The full name of the referenced data store. Formats: `projects/{project}/locations/{location}/collections/{collection}/dataStores/{data_store}` `projects/{project}/locations/{location}/dataStores/{data_store}`
-                "dataStoreType": "A String", # The type of the connected data store.
-              },
-            ],
-            "enabled": True or False, # Whether Knowledge Connector is enabled or not.
-            "targetFlow": "A String", # The target flow to transition to. Format: `projects//locations//agents//flows/`.
-            "targetPage": "A String", # The target page to transition to. Format: `projects//locations//agents//flows//pages/`.
-            "triggerFulfillment": { # A fulfillment can do one or more of the following actions at the same time: * Generate rich message responses. * Set parameter values. * Call the webhook. Fulfillments can be called at various stages in the Page or Form lifecycle. For example, when a DetectIntentRequest drives a session to enter a new page, the page's entry fulfillment can add a static response to the QueryResult in the returning DetectIntentResponse, call the webhook (for example, to load user data from a database), or both. # The fulfillment to be triggered. When the answers from the Knowledge Connector are selected by Dialogflow, you can utitlize the request scoped parameter `$request.knowledge.answers` (contains up to the 5 highest confidence answers) and `$request.knowledge.questions` (contains the corresponding questions) to construct the fulfillment.
-              "advancedSettings": { # Hierarchical advanced settings for agent/flow/page/fulfillment/parameter. Settings exposed at lower level overrides the settings exposed at higher level. Overriding occurs at the sub-setting level. For example, the playback_interruption_settings at fulfillment level only overrides the playback_interruption_settings at the agent level, leaving other settings at the agent level unchanged. DTMF settings does not override each other. DTMF settings set at different levels define DTMF detections running in parallel. Hierarchy: Agent->Flow->Page->Fulfillment/Parameter. # Hierarchical advanced settings for this fulfillment. The settings exposed at the lower level overrides the settings exposed at the higher level.
-                "audioExportGcsDestination": { # Google Cloud Storage location for a Dialogflow operation that writes or exports objects (e.g. exported agent or transcripts) outside of Dialogflow. # If present, incoming audio is exported by Dialogflow to the configured Google Cloud Storage destination. Exposed at the following levels: - Agent level - Flow level
-                  "uri": "A String", # Required. The Google Cloud Storage URI for the exported objects. A URI is of the form: `gs://bucket/object-name-or-prefix` Whether a full object name, or just a prefix, its usage depends on the Dialogflow operation.
-                },
-                "dtmfSettings": { # Define behaviors for DTMF (dual tone multi frequency). # Settings for DTMF. Exposed at the following levels: - Agent level - Flow level - Page level - Parameter level.
-                  "enabled": True or False, # If true, incoming audio is processed for DTMF (dual tone multi frequency) events. For example, if the caller presses a button on their telephone keypad and DTMF processing is enabled, Dialogflow will detect the event (e.g. a "3" was pressed) in the incoming audio and pass the event to the bot to drive business logic (e.g. when 3 is pressed, return the account balance).
-                  "endpointingTimeoutDuration": "A String", # Endpoint timeout setting for matching dtmf input to regex.
-                  "finishDigit": "A String", # The digit that terminates a DTMF digit sequence.
-                  "interdigitTimeoutDuration": "A String", # Interdigit timeout setting for matching dtmf input to regex.
-                  "maxDigits": 42, # Max length of DTMF digits.
-                },
-                "loggingSettings": { # Define behaviors on logging. # Settings for logging. Settings for Dialogflow History, Contact Center messages, StackDriver logs, and speech logging. Exposed at the following levels: - Agent level.
-                  "enableInteractionLogging": True or False, # If true, DF Interaction logging is currently enabled.
-                  "enableStackdriverLogging": True or False, # If true, StackDriver logging is currently enabled.
-                },
-                "speechSettings": { # Define behaviors of speech to text detection. # Settings for speech to text detection. Exposed at the following levels: - Agent level - Flow level - Page level - Parameter level
-                  "endpointerSensitivity": 42, # Sensitivity of the speech model that detects the end of speech. Scale from 0 to 100.
-                  "models": { # Mapping from language to Speech-to-Text model. The mapped Speech-to-Text model will be selected for requests from its corresponding language. For more information, see [Speech models](https://cloud.google.com/dialogflow/cx/docs/concept/speech-models).
-                    "a_key": "A String",
-                  },
-                  "noSpeechTimeout": "A String", # Timeout before detecting no speech.
-                  "useTimeoutBasedEndpointing": True or False, # Use timeout based endpointing, interpreting endpointer sensitivy as seconds of timeout value.
-                },
-              },
-              "conditionalCases": [ # Conditional cases for this fulfillment.
-                { # A list of cascading if-else conditions. Cases are mutually exclusive. The first one with a matching condition is selected, all the rest ignored.
-                  "cases": [ # A list of cascading if-else conditions.
-                    { # Each case has a Boolean condition. When it is evaluated to be True, the corresponding messages will be selected and evaluated recursively.
-                      "caseContent": [ # A list of case content.
-                        { # The list of messages or conditional cases to activate for this case.
-                          "additionalCases": # Object with schema name: GoogleCloudDialogflowCxV3beta1FulfillmentConditionalCases # Additional cases to be evaluated.
-                          "message": { # 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. # Returned message.
-                            "channel": "A String", # The channel which the response is associated with. Clients can specify the channel via QueryParameters.channel, and only associated channel response will be returned.
-                            "conversationSuccess": { # 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. # Indicates that the conversation succeeded.
-                              "metadata": { # Custom metadata. Dialogflow doesn't impose any structure on this.
-                                "a_key": "", # Properties of the object.
-                              },
-                            },
-                            "endInteraction": { # 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. # Output only. A signal that indicates the interaction with the Dialogflow agent has ended. This message is generated by Dialogflow only when the conversation reaches `END_SESSION` page. It is not supposed to be defined by the user. It's guaranteed that there is at most one such message in each response.
-                            },
-                            "knowledgeInfoCard": { # Represents info card response. If the response contains generative knowledge prediction, Dialogflow will return a payload with Infobot Messenger compatible info card. Otherwise, the info card response is skipped. # Represents info card for knowledge answers, to be better rendered in Dialogflow Messenger.
-                            },
-                            "liveAgentHandoff": { # 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. # Hands off conversation to a human agent.
-                              "metadata": { # Custom metadata for your handoff procedure. Dialogflow doesn't impose any structure on this.
-                                "a_key": "", # Properties of the object.
-                              },
-                            },
-                            "mixedAudio": { # 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. # Output only. An audio response message composed of both the synthesized Dialogflow agent responses and responses defined via play_audio. This message is generated by Dialogflow only and not supposed to be defined by the user.
-                              "segments": [ # Segments this audio response is composed of.
-                                { # Represents one segment of audio.
-                                  "allowPlaybackInterruption": True or False, # 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.
-                                  "audio": "A String", # Raw audio synthesized from the Dialogflow agent's response using the output config specified in the request.
-                                  "uri": "A String", # Client-specific URI that points to an audio clip accessible to the client. Dialogflow does not impose any validation on it.
-                                },
-                              ],
-                            },
-                            "outputAudioText": { # A text or ssml response that is preferentially used for TTS output audio synthesis, as described in the comment on the ResponseMessage message. # A text or ssml response that is preferentially used for TTS output audio synthesis, as described in the comment on the ResponseMessage message.
-                              "allowPlaybackInterruption": True or False, # 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.
-                              "ssml": "A String", # The SSML text to be synthesized. For more information, see [SSML](/speech/text-to-speech/docs/ssml).
-                              "text": "A String", # The raw text to be synthesized.
-                            },
-                            "payload": { # Returns a response containing a custom, platform-specific payload.
-                              "a_key": "", # Properties of the object.
-                            },
-                            "playAudio": { # Specifies an audio clip to be played by the client as part of the response. # Signal that the client should play an audio clip hosted at a client-specific URI. Dialogflow uses this to construct mixed_audio. However, Dialogflow itself does not try to read or process the URI in any way.
-                              "allowPlaybackInterruption": True or False, # 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.
-                              "audioUri": "A String", # Required. URI of the audio clip. Dialogflow does not impose any validation on this value. It is specific to the client that reads it.
-                            },
-                            "telephonyTransferCall": { # Represents the signal that telles the client to transfer the phone call connected to the agent to a third-party endpoint. # A signal that the client should transfer the phone call connected to this agent to a third-party endpoint.
-                              "phoneNumber": "A String", # Transfer the call to a phone number in [E.164 format](https://en.wikipedia.org/wiki/E.164).
-                            },
-                            "text": { # The text response message. # Returns a text response.
-                              "allowPlaybackInterruption": True or False, # 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.
-                              "text": [ # Required. A collection of text responses.
-                                "A String",
-                              ],
-                            },
+                  "defaultValue": "", # The default value of an optional parameter. If the parameter is required, the default value will be ignored.
+                  "displayName": "A String", # Required. The human-readable name of the parameter, unique within the form.
+                  "entityType": "A String", # Required. The entity type of the parameter. Format: `projects/-/locations/-/agents/-/entityTypes/` for system entity types (for example, `projects/-/locations/-/agents/-/entityTypes/sys.date`), or `projects//locations//agents//entityTypes/` for developer entity types.
+                  "fillBehavior": { # Configuration for how the filling of a parameter should be handled. # Required. Defines fill behavior for the parameter.
+                    "initialPromptFulfillment": { # A fulfillment can do one or more of the following actions at the same time: * Generate rich message responses. * Set parameter values. * Call the webhook. Fulfillments can be called at various stages in the Page or Form lifecycle. For example, when a DetectIntentRequest drives a session to enter a new page, the page's entry fulfillment can add a static response to the QueryResult in the returning DetectIntentResponse, call the webhook (for example, to load user data from a database), or both. # Required. The fulfillment to provide the initial prompt that the agent can present to the user in order to fill the parameter.
+                      "advancedSettings": { # Hierarchical advanced settings for agent/flow/page/fulfillment/parameter. Settings exposed at lower level overrides the settings exposed at higher level. Overriding occurs at the sub-setting level. For example, the playback_interruption_settings at fulfillment level only overrides the playback_interruption_settings at the agent level, leaving other settings at the agent level unchanged. DTMF settings does not override each other. DTMF settings set at different levels define DTMF detections running in parallel. Hierarchy: Agent->Flow->Page->Fulfillment/Parameter. # Hierarchical advanced settings for this fulfillment. The settings exposed at the lower level overrides the settings exposed at the higher level.
+                        "audioExportGcsDestination": { # Google Cloud Storage location for a Dialogflow operation that writes or exports objects (e.g. exported agent or transcripts) outside of Dialogflow. # If present, incoming audio is exported by Dialogflow to the configured Google Cloud Storage destination. Exposed at the following levels: - Agent level - Flow level
+                          "uri": "A String", # Required. The Google Cloud Storage URI for the exported objects. A URI is of the form: `gs://bucket/object-name-or-prefix` Whether a full object name, or just a prefix, its usage depends on the Dialogflow operation.
+                        },
+                        "dtmfSettings": { # Define behaviors for DTMF (dual tone multi frequency). # Settings for DTMF. Exposed at the following levels: - Agent level - Flow level - Page level - Parameter level.
+                          "enabled": True or False, # If true, incoming audio is processed for DTMF (dual tone multi frequency) events. For example, if the caller presses a button on their telephone keypad and DTMF processing is enabled, Dialogflow will detect the event (e.g. a "3" was pressed) in the incoming audio and pass the event to the bot to drive business logic (e.g. when 3 is pressed, return the account balance).
+                          "endpointingTimeoutDuration": "A String", # Endpoint timeout setting for matching dtmf input to regex.
+                          "finishDigit": "A String", # The digit that terminates a DTMF digit sequence.
+                          "interdigitTimeoutDuration": "A String", # Interdigit timeout setting for matching dtmf input to regex.
+                          "maxDigits": 42, # Max length of DTMF digits.
+                        },
+                        "loggingSettings": { # Define behaviors on logging. # Settings for logging. Settings for Dialogflow History, Contact Center messages, StackDriver logs, and speech logging. Exposed at the following levels: - Agent level.
+                          "enableInteractionLogging": True or False, # Enables DF Interaction logging.
+                          "enableStackdriverLogging": True or False, # Enables StackDriver logging.
+                        },
+                        "speechSettings": { # Define behaviors of speech to text detection. # Settings for speech to text detection. Exposed at the following levels: - Agent level - Flow level - Page level - Parameter level
+                          "endpointerSensitivity": 42, # Sensitivity of the speech model that detects the end of speech. Scale from 0 to 100.
+                          "models": { # Mapping from language to Speech-to-Text model. The mapped Speech-to-Text model will be selected for requests from its corresponding language. For more information, see [Speech models](https://cloud.google.com/dialogflow/cx/docs/concept/speech-models).
+                            "a_key": "A String",
                           },
+                          "noSpeechTimeout": "A String", # Timeout before detecting no speech.
+                          "useTimeoutBasedEndpointing": True or False, # Use timeout based endpointing, interpreting endpointer sensitivy as seconds of timeout value.
                         },
-                      ],
-                      "condition": "A String", # The condition to activate and select this case. Empty means the condition is always true. The condition is evaluated against form parameters or session parameters. See the [conditions reference](https://cloud.google.com/dialogflow/cx/docs/reference/condition).
-                    },
-                  ],
-                },
-              ],
-              "enableGenerativeFallback": True or False, # If the flag is true, the agent will utilize LLM to generate a text response. If LLM generation fails, the defined responses in the fulfillment will be respected. This flag is only useful for fulfillments associated with no-match event handlers.
-              "messages": [ # The list of rich message responses to present to the user.
-                { # 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.
-                  "channel": "A String", # The channel which the response is associated with. Clients can specify the channel via QueryParameters.channel, and only associated channel response will be returned.
-                  "conversationSuccess": { # 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. # Indicates that the conversation succeeded.
-                    "metadata": { # Custom metadata. Dialogflow doesn't impose any structure on this.
-                      "a_key": "", # Properties of the object.
-                    },
-                  },
-                  "endInteraction": { # 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. # Output only. A signal that indicates the interaction with the Dialogflow agent has ended. This message is generated by Dialogflow only when the conversation reaches `END_SESSION` page. It is not supposed to be defined by the user. It's guaranteed that there is at most one such message in each response.
-                  },
-                  "knowledgeInfoCard": { # Represents info card response. If the response contains generative knowledge prediction, Dialogflow will return a payload with Infobot Messenger compatible info card. Otherwise, the info card response is skipped. # Represents info card for knowledge answers, to be better rendered in Dialogflow Messenger.
-                  },
-                  "liveAgentHandoff": { # 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. # Hands off conversation to a human agent.
-                    "metadata": { # Custom metadata for your handoff procedure. Dialogflow doesn't impose any structure on this.
-                      "a_key": "", # Properties of the object.
-                    },
-                  },
-                  "mixedAudio": { # 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. # Output only. An audio response message composed of both the synthesized Dialogflow agent responses and responses defined via play_audio. This message is generated by Dialogflow only and not supposed to be defined by the user.
-                    "segments": [ # Segments this audio response is composed of.
-                      { # Represents one segment of audio.
-                        "allowPlaybackInterruption": True or False, # 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.
-                        "audio": "A String", # Raw audio synthesized from the Dialogflow agent's response using the output config specified in the request.
-                        "uri": "A String", # Client-specific URI that points to an audio clip accessible to the client. Dialogflow does not impose any validation on it.
                       },
-                    ],
-                  },
-                  "outputAudioText": { # A text or ssml response that is preferentially used for TTS output audio synthesis, as described in the comment on the ResponseMessage message. # A text or ssml response that is preferentially used for TTS output audio synthesis, as described in the comment on the ResponseMessage message.
-                    "allowPlaybackInterruption": True or False, # 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.
-                    "ssml": "A String", # The SSML text to be synthesized. For more information, see [SSML](/speech/text-to-speech/docs/ssml).
-                    "text": "A String", # The raw text to be synthesized.
-                  },
-                  "payload": { # Returns a response containing a custom, platform-specific payload.
-                    "a_key": "", # Properties of the object.
-                  },
-                  "playAudio": { # Specifies an audio clip to be played by the client as part of the response. # Signal that the client should play an audio clip hosted at a client-specific URI. Dialogflow uses this to construct mixed_audio. However, Dialogflow itself does not try to read or process the URI in any way.
-                    "allowPlaybackInterruption": True or False, # 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.
-                    "audioUri": "A String", # Required. URI of the audio clip. Dialogflow does not impose any validation on this value. It is specific to the client that reads it.
-                  },
-                  "telephonyTransferCall": { # Represents the signal that telles the client to transfer the phone call connected to the agent to a third-party endpoint. # A signal that the client should transfer the phone call connected to this agent to a third-party endpoint.
-                    "phoneNumber": "A String", # Transfer the call to a phone number in [E.164 format](https://en.wikipedia.org/wiki/E.164).
-                  },
-                  "text": { # The text response message. # Returns a text response.
-                    "allowPlaybackInterruption": True or False, # 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.
-                    "text": [ # Required. A collection of text responses.
-                      "A String",
-                    ],
-                  },
-                },
-              ],
-              "returnPartialResponses": True or False, # Whether Dialogflow should return currently queued fulfillment response messages in streaming APIs. If a webhook is specified, it happens before Dialogflow invokes webhook. Warning: 1) This flag only affects streaming API. Responses are still queued and returned once in non-streaming API. 2) The flag can be enabled in any fulfillment but only the first 3 partial responses will be returned. You may only want to apply it to fulfillments that have slow webhooks.
-              "setParameterActions": [ # Set parameter values before executing the webhook.
-                { # Setting a parameter value.
-                  "parameter": "A String", # Display name of the parameter.
-                  "value": "", # The new value of the parameter. A null value clears the parameter.
-                },
-              ],
-              "tag": "A String", # The value of this field will be populated in the WebhookRequest `fulfillmentInfo.tag` field by Dialogflow when the associated webhook is called. The tag is typically used by the webhook service to identify which fulfillment is being called, but it could be used for other purposes. This field is required if `webhook` is specified.
-              "webhook": "A String", # The webhook to call. Format: `projects//locations//agents//webhooks/`.
-            },
-          },
-          "multiLanguageSettings": { # Settings for multi-lingual agents. # Optional. Multi-lingual agent settings for this flow.
-            "enableMultiLanguageDetection": True or False, # Optional. Enable multi-language detection for this flow. This can be set only if agent level multi language setting is enabled.
-            "supportedResponseLanguageCodes": [ # Optional. Agent will respond in the detected language if the detected language code is in the supported resolved languages for this flow. This will be used only if multi-language training is enabled in the agent and multi-language detection is enabled in the flow. The supported languages must be a subset of the languages supported by the agent.
-              "A String",
-            ],
-          },
-          "name": "A String", # The unique identifier of the flow. Format: `projects//locations//agents//flows/`.
-          "nluSettings": { # Settings related to NLU. # NLU related settings of the flow.
-            "classificationThreshold": 3.14, # To filter out false positive results and still get variety in matched natural language inputs for your agent, you can tune the machine learning classification threshold. If the returned score value is less than the threshold value, then a no-match event will be triggered. The score values range from 0.0 (completely uncertain) to 1.0 (completely certain). If set to 0.0, the default of 0.3 is used.
-            "modelTrainingMode": "A String", # Indicates NLU model training mode.
-            "modelType": "A String", # Indicates the type of NLU model.
-          },
-          "transitionRouteGroups": [ # A flow's transition route group serve two purposes: * They are responsible for matching the user's first utterances in the flow. * They are inherited by every page's transition route groups. Transition route groups defined in the page have higher priority than those defined in the flow. Format:`projects//locations//agents//flows//transitionRouteGroups/` or `projects//locations//agents//transitionRouteGroups/` for agent-level groups.
-            "A String",
-          ],
-          "transitionRoutes": [ # A flow's transition routes serve two purposes: * They are responsible for matching the user's first utterances in the flow. * They are inherited by every page's transition routes and can support use cases such as the user saying "help" or "can I talk to a human?", which can be handled in a common way regardless of the current page. Transition routes defined in the page have higher priority than those defined in the flow. TransitionRoutes are evalauted in the following order: * TransitionRoutes with intent specified. * TransitionRoutes with only condition specified. TransitionRoutes with intent specified are inherited by pages in the flow.
-            { # A transition route specifies a intent that can be matched and/or a data condition that can be evaluated during a session. When a specified transition is matched, the following actions are taken in order: * If there is a `trigger_fulfillment` associated with the transition, it will be called. * If there is a `target_page` associated with the transition, the session will transition into the specified page. * If there is a `target_flow` associated with the transition, the session will transition into the specified flow.
-              "condition": "A String", # The condition to evaluate against form parameters or session parameters. See the [conditions reference](https://cloud.google.com/dialogflow/cx/docs/reference/condition). At least one of `intent` or `condition` must be specified. When both `intent` and `condition` are specified, the transition can only happen when both are fulfilled.
-              "description": "A String", # Optional. The description of the transition route. The maximum length is 500 characters.
-              "intent": "A String", # The unique identifier of an Intent. Format: `projects//locations//agents//intents/`. Indicates that the transition can only happen when the given intent is matched. At least one of `intent` or `condition` must be specified. When both `intent` and `condition` are specified, the transition can only happen when both are fulfilled.
-              "name": "A String", # Output only. The unique identifier of this transition route.
-              "targetFlow": "A String", # The target flow to transition to. Format: `projects//locations//agents//flows/`.
-              "targetPage": "A String", # The target page to transition to. Format: `projects//locations//agents//flows//pages/`.
-              "triggerFulfillment": { # A fulfillment can do one or more of the following actions at the same time: * Generate rich message responses. * Set parameter values. * Call the webhook. Fulfillments can be called at various stages in the Page or Form lifecycle. For example, when a DetectIntentRequest drives a session to enter a new page, the page's entry fulfillment can add a static response to the QueryResult in the returning DetectIntentResponse, call the webhook (for example, to load user data from a database), or both. # The fulfillment to call when the condition is satisfied. At least one of `trigger_fulfillment` and `target` must be specified. When both are defined, `trigger_fulfillment` is executed first.
-                "advancedSettings": { # Hierarchical advanced settings for agent/flow/page/fulfillment/parameter. Settings exposed at lower level overrides the settings exposed at higher level. Overriding occurs at the sub-setting level. For example, the playback_interruption_settings at fulfillment level only overrides the playback_interruption_settings at the agent level, leaving other settings at the agent level unchanged. DTMF settings does not override each other. DTMF settings set at different levels define DTMF detections running in parallel. Hierarchy: Agent->Flow->Page->Fulfillment/Parameter. # Hierarchical advanced settings for this fulfillment. The settings exposed at the lower level overrides the settings exposed at the higher level.
-                  "audioExportGcsDestination": { # Google Cloud Storage location for a Dialogflow operation that writes or exports objects (e.g. exported agent or transcripts) outside of Dialogflow. # If present, incoming audio is exported by Dialogflow to the configured Google Cloud Storage destination. Exposed at the following levels: - Agent level - Flow level
-                    "uri": "A String", # Required. The Google Cloud Storage URI for the exported objects. A URI is of the form: `gs://bucket/object-name-or-prefix` Whether a full object name, or just a prefix, its usage depends on the Dialogflow operation.
-                  },
-                  "dtmfSettings": { # Define behaviors for DTMF (dual tone multi frequency). # Settings for DTMF. Exposed at the following levels: - Agent level - Flow level - Page level - Parameter level.
-                    "enabled": True or False, # If true, incoming audio is processed for DTMF (dual tone multi frequency) events. For example, if the caller presses a button on their telephone keypad and DTMF processing is enabled, Dialogflow will detect the event (e.g. a "3" was pressed) in the incoming audio and pass the event to the bot to drive business logic (e.g. when 3 is pressed, return the account balance).
-                    "endpointingTimeoutDuration": "A String", # Endpoint timeout setting for matching dtmf input to regex.
-                    "finishDigit": "A String", # The digit that terminates a DTMF digit sequence.
-                    "interdigitTimeoutDuration": "A String", # Interdigit timeout setting for matching dtmf input to regex.
-                    "maxDigits": 42, # Max length of DTMF digits.
-                  },
-                  "loggingSettings": { # Define behaviors on logging. # Settings for logging. Settings for Dialogflow History, Contact Center messages, StackDriver logs, and speech logging. Exposed at the following levels: - Agent level.
-                    "enableInteractionLogging": True or False, # If true, DF Interaction logging is currently enabled.
-                    "enableStackdriverLogging": True or False, # If true, StackDriver logging is currently enabled.
-                  },
-                  "speechSettings": { # Define behaviors of speech to text detection. # Settings for speech to text detection. Exposed at the following levels: - Agent level - Flow level - Page level - Parameter level
-                    "endpointerSensitivity": 42, # Sensitivity of the speech model that detects the end of speech. Scale from 0 to 100.
-                    "models": { # Mapping from language to Speech-to-Text model. The mapped Speech-to-Text model will be selected for requests from its corresponding language. For more information, see [Speech models](https://cloud.google.com/dialogflow/cx/docs/concept/speech-models).
-                      "a_key": "A String",
-                    },
-                    "noSpeechTimeout": "A String", # Timeout before detecting no speech.
-                    "useTimeoutBasedEndpointing": True or False, # Use timeout based endpointing, interpreting endpointer sensitivy as seconds of timeout value.
-                  },
-                },
-                "conditionalCases": [ # Conditional cases for this fulfillment.
-                  { # A list of cascading if-else conditions. Cases are mutually exclusive. The first one with a matching condition is selected, all the rest ignored.
-                    "cases": [ # A list of cascading if-else conditions.
-                      { # Each case has a Boolean condition. When it is evaluated to be True, the corresponding messages will be selected and evaluated recursively.
-                        "caseContent": [ # A list of case content.
-                          { # The list of messages or conditional cases to activate for this case.
-                            "additionalCases": # Object with schema name: GoogleCloudDialogflowCxV3beta1FulfillmentConditionalCases # Additional cases to be evaluated.
-                            "message": { # 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. # Returned message.
-                              "channel": "A String", # The channel which the response is associated with. Clients can specify the channel via QueryParameters.channel, and only associated channel response will be returned.
-                              "conversationSuccess": { # 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. # Indicates that the conversation succeeded.
-                                "metadata": { # Custom metadata. Dialogflow doesn't impose any structure on this.
-                                  "a_key": "", # Properties of the object.
-                                },
-                              },
-                              "endInteraction": { # 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. # Output only. A signal that indicates the interaction with the Dialogflow agent has ended. This message is generated by Dialogflow only when the conversation reaches `END_SESSION` page. It is not supposed to be defined by the user. It's guaranteed that there is at most one such message in each response.
-                              },
-                              "knowledgeInfoCard": { # Represents info card response. If the response contains generative knowledge prediction, Dialogflow will return a payload with Infobot Messenger compatible info card. Otherwise, the info card response is skipped. # Represents info card for knowledge answers, to be better rendered in Dialogflow Messenger.
-                              },
-                              "liveAgentHandoff": { # 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. # Hands off conversation to a human agent.
-                                "metadata": { # Custom metadata for your handoff procedure. Dialogflow doesn't impose any structure on this.
-                                  "a_key": "", # Properties of the object.
-                                },
-                              },
-                              "mixedAudio": { # 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. # Output only. An audio response message composed of both the synthesized Dialogflow agent responses and responses defined via play_audio. This message is generated by Dialogflow only and not supposed to be defined by the user.
-                                "segments": [ # Segments this audio response is composed of.
-                                  { # Represents one segment of audio.
-                                    "allowPlaybackInterruption": True or False, # 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.
-                                    "audio": "A String", # Raw audio synthesized from the Dialogflow agent's response using the output config specified in the request.
-                                    "uri": "A String", # Client-specific URI that points to an audio clip accessible to the client. Dialogflow does not impose any validation on it.
+                      "conditionalCases": [ # Conditional cases for this fulfillment.
+                        { # A list of cascading if-else conditions. Cases are mutually exclusive. The first one with a matching condition is selected, all the rest ignored.
+                          "cases": [ # A list of cascading if-else conditions.
+                            { # Each case has a Boolean condition. When it is evaluated to be True, the corresponding messages will be selected and evaluated recursively.
+                              "caseContent": [ # A list of case content.
+                                { # The list of messages or conditional cases to activate for this case.
+                                  "additionalCases": # Object with schema name: GoogleCloudDialogflowCxV3beta1FulfillmentConditionalCases # Additional cases to be evaluated.
+                                  "message": { # 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. # Returned message.
+                                    "channel": "A String", # The channel which the response is associated with. Clients can specify the channel via QueryParameters.channel, and only associated channel response will be returned.
+                                    "conversationSuccess": { # 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. # Indicates that the conversation succeeded.
+                                      "metadata": { # Custom metadata. Dialogflow doesn't impose any structure on this.
+                                        "a_key": "", # Properties of the object.
+                                      },
+                                    },
+                                    "endInteraction": { # 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. # Output only. A signal that indicates the interaction with the Dialogflow agent has ended. This message is generated by Dialogflow only when the conversation reaches `END_SESSION` page. It is not supposed to be defined by the user. It's guaranteed that there is at most one such message in each response.
+                                    },
+                                    "knowledgeInfoCard": { # Represents info card response. If the response contains generative knowledge prediction, Dialogflow will return a payload with Infobot Messenger compatible info card. Otherwise, the info card response is skipped. # Represents info card for knowledge answers, to be better rendered in Dialogflow Messenger.
+                                    },
+                                    "liveAgentHandoff": { # 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. # Hands off conversation to a human agent.
+                                      "metadata": { # Custom metadata for your handoff procedure. Dialogflow doesn't impose any structure on this.
+                                        "a_key": "", # Properties of the object.
+                                      },
+                                    },
+                                    "mixedAudio": { # 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. # Output only. An audio response message composed of both the synthesized Dialogflow agent responses and responses defined via play_audio. This message is generated by Dialogflow only and not supposed to be defined by the user.
+                                      "segments": [ # Segments this audio response is composed of.
+                                        { # Represents one segment of audio.
+                                          "allowPlaybackInterruption": True or False, # 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.
+                                          "audio": "A String", # Raw audio synthesized from the Dialogflow agent's response using the output config specified in the request.
+                                          "uri": "A String", # Client-specific URI that points to an audio clip accessible to the client. Dialogflow does not impose any validation on it.
+                                        },
+                                      ],
+                                    },
+                                    "outputAudioText": { # A text or ssml response that is preferentially used for TTS output audio synthesis, as described in the comment on the ResponseMessage message. # A text or ssml response that is preferentially used for TTS output audio synthesis, as described in the comment on the ResponseMessage message.
+                                      "allowPlaybackInterruption": True or False, # 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.
+                                      "ssml": "A String", # The SSML text to be synthesized. For more information, see [SSML](/speech/text-to-speech/docs/ssml).
+                                      "text": "A String", # The raw text to be synthesized.
+                                    },
+                                    "payload": { # Returns a response containing a custom, platform-specific payload.
+                                      "a_key": "", # Properties of the object.
+                                    },
+                                    "playAudio": { # Specifies an audio clip to be played by the client as part of the response. # Signal that the client should play an audio clip hosted at a client-specific URI. Dialogflow uses this to construct mixed_audio. However, Dialogflow itself does not try to read or process the URI in any way.
+                                      "allowPlaybackInterruption": True or False, # 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.
+                                      "audioUri": "A String", # Required. URI of the audio clip. Dialogflow does not impose any validation on this value. It is specific to the client that reads it.
+                                    },
+                                    "telephonyTransferCall": { # Represents the signal that telles the client to transfer the phone call connected to the agent to a third-party endpoint. # A signal that the client should transfer the phone call connected to this agent to a third-party endpoint.
+                                      "phoneNumber": "A String", # Transfer the call to a phone number in [E.164 format](https://en.wikipedia.org/wiki/E.164).
+                                    },
+                                    "text": { # The text response message. # Returns a text response.
+                                      "allowPlaybackInterruption": True or False, # 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.
+                                      "text": [ # Required. A collection of text responses.
+                                        "A String",
+                                      ],
+                                    },
+                                    "toolCall": { # Represents a call of a specific tool's action with the specified inputs. # Returns the definition of a tool call that should be executed by the client.
+                                      "action": "A String", # Required. The name of the tool's action associated with this call.
+                                      "inputParameters": { # Optional. The action's input parameters.
+                                        "a_key": "", # Properties of the object.
+                                      },
+                                      "tool": "A String", # Required. The tool associated with this call. Format: `projects//locations//agents//tools/`.
+                                    },
                                   },
-                                ],
-                              },
-                              "outputAudioText": { # A text or ssml response that is preferentially used for TTS output audio synthesis, as described in the comment on the ResponseMessage message. # A text or ssml response that is preferentially used for TTS output audio synthesis, as described in the comment on the ResponseMessage message.
-                                "allowPlaybackInterruption": True or False, # 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.
-                                "ssml": "A String", # The SSML text to be synthesized. For more information, see [SSML](/speech/text-to-speech/docs/ssml).
-                                "text": "A String", # The raw text to be synthesized.
-                              },
-                              "payload": { # Returns a response containing a custom, platform-specific payload.
-                                "a_key": "", # Properties of the object.
-                              },
-                              "playAudio": { # Specifies an audio clip to be played by the client as part of the response. # Signal that the client should play an audio clip hosted at a client-specific URI. Dialogflow uses this to construct mixed_audio. However, Dialogflow itself does not try to read or process the URI in any way.
-                                "allowPlaybackInterruption": True or False, # 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.
-                                "audioUri": "A String", # Required. URI of the audio clip. Dialogflow does not impose any validation on this value. It is specific to the client that reads it.
-                              },
-                              "telephonyTransferCall": { # Represents the signal that telles the client to transfer the phone call connected to the agent to a third-party endpoint. # A signal that the client should transfer the phone call connected to this agent to a third-party endpoint.
-                                "phoneNumber": "A String", # Transfer the call to a phone number in [E.164 format](https://en.wikipedia.org/wiki/E.164).
-                              },
-                              "text": { # The text response message. # Returns a text response.
-                                "allowPlaybackInterruption": True or False, # 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.
-                                "text": [ # Required. A collection of text responses.
-                                  "A String",
-                                ],
-                              },
+                                },
+                              ],
+                              "condition": "A String", # The condition to activate and select this case. Empty means the condition is always true. The condition is evaluated against form parameters or session parameters. See the [conditions reference](https://cloud.google.com/dialogflow/cx/docs/reference/condition).
                             },
-                          },
-                        ],
-                        "condition": "A String", # The condition to activate and select this case. Empty means the condition is always true. The condition is evaluated against form parameters or session parameters. See the [conditions reference](https://cloud.google.com/dialogflow/cx/docs/reference/condition).
-                      },
-                    ],
-                  },
-                ],
-                "enableGenerativeFallback": True or False, # If the flag is true, the agent will utilize LLM to generate a text response. If LLM generation fails, the defined responses in the fulfillment will be respected. This flag is only useful for fulfillments associated with no-match event handlers.
-                "messages": [ # The list of rich message responses to present to the user.
-                  { # 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.
-                    "channel": "A String", # The channel which the response is associated with. Clients can specify the channel via QueryParameters.channel, and only associated channel response will be returned.
-                    "conversationSuccess": { # 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. # Indicates that the conversation succeeded.
-                      "metadata": { # Custom metadata. Dialogflow doesn't impose any structure on this.
-                        "a_key": "", # Properties of the object.
-                      },
-                    },
-                    "endInteraction": { # 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. # Output only. A signal that indicates the interaction with the Dialogflow agent has ended. This message is generated by Dialogflow only when the conversation reaches `END_SESSION` page. It is not supposed to be defined by the user. It's guaranteed that there is at most one such message in each response.
-                    },
-                    "knowledgeInfoCard": { # Represents info card response. If the response contains generative knowledge prediction, Dialogflow will return a payload with Infobot Messenger compatible info card. Otherwise, the info card response is skipped. # Represents info card for knowledge answers, to be better rendered in Dialogflow Messenger.
-                    },
-                    "liveAgentHandoff": { # 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. # Hands off conversation to a human agent.
-                      "metadata": { # Custom metadata for your handoff procedure. Dialogflow doesn't impose any structure on this.
-                        "a_key": "", # Properties of the object.
-                      },
-                    },
-                    "mixedAudio": { # 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. # Output only. An audio response message composed of both the synthesized Dialogflow agent responses and responses defined via play_audio. This message is generated by Dialogflow only and not supposed to be defined by the user.
-                      "segments": [ # Segments this audio response is composed of.
-                        { # Represents one segment of audio.
-                          "allowPlaybackInterruption": True or False, # 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.
-                          "audio": "A String", # Raw audio synthesized from the Dialogflow agent's response using the output config specified in the request.
-                          "uri": "A String", # Client-specific URI that points to an audio clip accessible to the client. Dialogflow does not impose any validation on it.
+                          ],
                         },
                       ],
-                    },
-                    "outputAudioText": { # A text or ssml response that is preferentially used for TTS output audio synthesis, as described in the comment on the ResponseMessage message. # A text or ssml response that is preferentially used for TTS output audio synthesis, as described in the comment on the ResponseMessage message.
-                      "allowPlaybackInterruption": True or False, # 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.
-                      "ssml": "A String", # The SSML text to be synthesized. For more information, see [SSML](/speech/text-to-speech/docs/ssml).
-                      "text": "A String", # The raw text to be synthesized.
-                    },
-                    "payload": { # Returns a response containing a custom, platform-specific payload.
-                      "a_key": "", # Properties of the object.
-                    },
-                    "playAudio": { # Specifies an audio clip to be played by the client as part of the response. # Signal that the client should play an audio clip hosted at a client-specific URI. Dialogflow uses this to construct mixed_audio. However, Dialogflow itself does not try to read or process the URI in any way.
-                      "allowPlaybackInterruption": True or False, # 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.
-                      "audioUri": "A String", # Required. URI of the audio clip. Dialogflow does not impose any validation on this value. It is specific to the client that reads it.
-                    },
-                    "telephonyTransferCall": { # Represents the signal that telles the client to transfer the phone call connected to the agent to a third-party endpoint. # A signal that the client should transfer the phone call connected to this agent to a third-party endpoint.
-                      "phoneNumber": "A String", # Transfer the call to a phone number in [E.164 format](https://en.wikipedia.org/wiki/E.164).
-                    },
-                    "text": { # The text response message. # Returns a text response.
-                      "allowPlaybackInterruption": True or False, # 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.
-                      "text": [ # Required. A collection of text responses.
-                        "A String",
-                      ],
-                    },
-                  },
-                ],
-                "returnPartialResponses": True or False, # Whether Dialogflow should return currently queued fulfillment response messages in streaming APIs. If a webhook is specified, it happens before Dialogflow invokes webhook. Warning: 1) This flag only affects streaming API. Responses are still queued and returned once in non-streaming API. 2) The flag can be enabled in any fulfillment but only the first 3 partial responses will be returned. You may only want to apply it to fulfillments that have slow webhooks.
-                "setParameterActions": [ # Set parameter values before executing the webhook.
-                  { # Setting a parameter value.
-                    "parameter": "A String", # Display name of the parameter.
-                    "value": "", # The new value of the parameter. A null value clears the parameter.
-                  },
-                ],
-                "tag": "A String", # The value of this field will be populated in the WebhookRequest `fulfillmentInfo.tag` field by Dialogflow when the associated webhook is called. The tag is typically used by the webhook service to identify which fulfillment is being called, but it could be used for other purposes. This field is required if `webhook` is specified.
-                "webhook": "A String", # The webhook to call. Format: `projects//locations//agents//webhooks/`.
-              },
-            },
-          ],
-        },
-      ],
-      "intents": [ # All the matched Intent in the conversation. Only `name` and `display_name` are filled in this message.
-        { # An intent represents a user's intent to interact with a conversational agent. You can provide information for the Dialogflow API to use to match user input to an intent by adding training phrases (i.e., examples of user input) to your intent.
-          "description": "A String", # Human readable description for better understanding an intent like its scope, content, result etc. Maximum character limit: 140 characters.
-          "displayName": "A String", # Required. The human-readable name of the intent, unique within the agent.
-          "isFallback": True or False, # Indicates whether this is a fallback intent. Currently only default fallback intent is allowed in the agent, which is added upon agent creation. Adding training phrases to fallback intent is useful in the case of requests that are mistakenly matched, since training phrases assigned to fallback intents act as negative examples that triggers no-match event.
-          "labels": { # The key/value metadata to label an intent. Labels can contain lowercase letters, digits and the symbols '-' and '_'. International characters are allowed, including letters from unicase alphabets. Keys must start with a letter. Keys and values can be no longer than 63 characters and no more than 128 bytes. Prefix "sys-" is reserved for Dialogflow defined labels. Currently allowed Dialogflow defined labels include: * sys-head * sys-contextual The above labels do not require value. "sys-head" means the intent is a head intent. "sys-contextual" means the intent is a contextual intent.
-            "a_key": "A String",
-          },
-          "name": "A String", # The unique identifier of the intent. Required for the Intents.UpdateIntent method. Intents.CreateIntent populates the name automatically. Format: `projects//locations//agents//intents/`.
-          "parameters": [ # The collection of parameters associated with the intent.
-            { # Represents an intent parameter.
-              "entityType": "A String", # Required. The entity type of the parameter. Format: `projects/-/locations/-/agents/-/entityTypes/` for system entity types (for example, `projects/-/locations/-/agents/-/entityTypes/sys.date`), or `projects//locations//agents//entityTypes/` for developer entity types.
-              "id": "A String", # Required. The unique identifier of the parameter. This field is used by training phrases to annotate their parts.
-              "isList": True or False, # Indicates whether the parameter represents a list of values.
-              "redact": True or False, # Indicates whether the parameter content should be redacted in log. If redaction is enabled, the parameter content will be replaced by parameter name during logging. Note: the parameter content is subject to redaction if either parameter level redaction or entity type level redaction is enabled.
-            },
-          ],
-          "priority": 42, # 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.
-          "trainingPhrases": [ # The collection of training phrases the agent is trained on to identify the intent.
-            { # Represents an example that the agent is trained on to identify the intent.
-              "id": "A String", # Output only. The unique identifier of the training phrase.
-              "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 `parameter_id` field is set.
-                { # Represents a part of a training phrase.
-                  "parameterId": "A String", # The parameter used to annotate this part of the training phrase. This field is required for annotated parts of the training phrase.
-                  "text": "A String", # Required. The text for this part.
-                },
-              ],
-              "repeatCount": 42, # Indicates how many times this example was added to the intent.
-            },
-          ],
-        },
-      ],
-      "interactions": [ # Interactions of the conversation. Only populated for `GetConversation` and empty for `ListConversations`.
-        { # Represents an interaction between an end user and a Dialogflow CX agent using V3 (Streaming)DetectIntent API, or an interaction between an end user and a Dialogflow CX agent using V2 (Streaming)AnalyzeContent API.
-          "createTime": "A String", # The time that the interaction was created.
-          "missingTransition": { # Information collected for DF CX agents in case NLU predicted an intent that was filtered out as being inactive which may indicate a missing transition and/or absent functionality. # Missing transition predicted for the interaction. This field is set only if the interaction match type was no-match.
-            "intentDisplayName": "A String", # Name of the intent that could have triggered.
-            "score": 3.14, # Score of the above intent. The higher it is the more likely a transition was missed on a given page.
-          },
-          "partialResponses": [ # The partial responses of the interaction. Empty if there is no partial response in the interaction. See the partial response documentation.
-            { # The message returned from the DetectIntent method.
-              "allowCancellation": True or False, # Indicates whether the partial response can be cancelled when a later response arrives. e.g. if the agent specified some music as partial response, it can be cancelled.
-              "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.response_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.
-              "outputAudioConfig": { # Instructs the speech synthesizer how to generate the output audio content. # The config used by the speech synthesizer to generate the output audio.
-                "audioEncoding": "A String", # Required. Audio encoding of the synthesized audio content.
-                "sampleRateHertz": 42, # Optional. 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).
-                "synthesizeSpeechConfig": { # Configuration of how speech should be synthesized. # Optional. Configuration of how speech should be synthesized. If not specified, Agent.text_to_speech_settings is applied.
-                  "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.
-                    "A String",
-                  ],
-                  "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.
-                  "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.
-                  "voice": { # Description of which voice to use for speech synthesis. # Optional. The desired voice of the synthesized audio.
-                    "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. For the list of available voices, please refer to [Supported voices and languages](https://cloud.google.com/text-to-speech/docs/voices).
-                    "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.
-                  },
-                  "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.
-                },
-              },
-              "queryResult": { # Represents the result of a conversational query. # The result of the conversational query.
-                "advancedSettings": { # Hierarchical advanced settings for agent/flow/page/fulfillment/parameter. Settings exposed at lower level overrides the settings exposed at higher level. Overriding occurs at the sub-setting level. For example, the playback_interruption_settings at fulfillment level only overrides the playback_interruption_settings at the agent level, leaving other settings at the agent level unchanged. DTMF settings does not override each other. DTMF settings set at different levels define DTMF detections running in parallel. Hierarchy: Agent->Flow->Page->Fulfillment/Parameter. # Returns the current advanced settings including IVR settings. Even though the operations configured by these settings are performed by Dialogflow, the client may need to perform special logic at the moment. For example, if Dialogflow exports audio to Google Cloud Storage, then the client may need to wait for the resulting object to appear in the bucket before proceeding.
-                  "audioExportGcsDestination": { # Google Cloud Storage location for a Dialogflow operation that writes or exports objects (e.g. exported agent or transcripts) outside of Dialogflow. # If present, incoming audio is exported by Dialogflow to the configured Google Cloud Storage destination. Exposed at the following levels: - Agent level - Flow level
-                    "uri": "A String", # Required. The Google Cloud Storage URI for the exported objects. A URI is of the form: `gs://bucket/object-name-or-prefix` Whether a full object name, or just a prefix, its usage depends on the Dialogflow operation.
-                  },
-                  "dtmfSettings": { # Define behaviors for DTMF (dual tone multi frequency). # Settings for DTMF. Exposed at the following levels: - Agent level - Flow level - Page level - Parameter level.
-                    "enabled": True or False, # If true, incoming audio is processed for DTMF (dual tone multi frequency) events. For example, if the caller presses a button on their telephone keypad and DTMF processing is enabled, Dialogflow will detect the event (e.g. a "3" was pressed) in the incoming audio and pass the event to the bot to drive business logic (e.g. when 3 is pressed, return the account balance).
-                    "endpointingTimeoutDuration": "A String", # Endpoint timeout setting for matching dtmf input to regex.
-                    "finishDigit": "A String", # The digit that terminates a DTMF digit sequence.
-                    "interdigitTimeoutDuration": "A String", # Interdigit timeout setting for matching dtmf input to regex.
-                    "maxDigits": 42, # Max length of DTMF digits.
-                  },
-                  "loggingSettings": { # Define behaviors on logging. # Settings for logging. Settings for Dialogflow History, Contact Center messages, StackDriver logs, and speech logging. Exposed at the following levels: - Agent level.
-                    "enableInteractionLogging": True or False, # If true, DF Interaction logging is currently enabled.
-                    "enableStackdriverLogging": True or False, # If true, StackDriver logging is currently enabled.
-                  },
-                  "speechSettings": { # Define behaviors of speech to text detection. # Settings for speech to text detection. Exposed at the following levels: - Agent level - Flow level - Page level - Parameter level
-                    "endpointerSensitivity": 42, # Sensitivity of the speech model that detects the end of speech. Scale from 0 to 100.
-                    "models": { # Mapping from language to Speech-to-Text model. The mapped Speech-to-Text model will be selected for requests from its corresponding language. For more information, see [Speech models](https://cloud.google.com/dialogflow/cx/docs/concept/speech-models).
-                      "a_key": "A String",
-                    },
-                    "noSpeechTimeout": "A String", # Timeout before detecting no speech.
-                    "useTimeoutBasedEndpointing": True or False, # Use timeout based endpointing, interpreting endpointer sensitivy as seconds of timeout value.
-                  },
-                },
-                "allowAnswerFeedback": True or False, # Indicates whether the Thumbs up/Thumbs down rating controls are need to be shown for the response in the Dialogflow Messenger widget.
-                "currentPage": { # A Dialogflow CX conversation (session) can be described and visualized as a state machine. The states of a CX session are represented by pages. For each flow, you define many pages, where your combined pages can handle a complete conversation on the topics the flow is designed for. At any given moment, exactly one page is the current page, the current page is considered active, and the flow associated with that page is considered active. Every flow has a special start page. When a flow initially becomes active, the start page page becomes the current page. For each conversational turn, the current page will either stay the same or transition to another page. You configure each page to collect information from the end-user that is relevant for the conversational state represented by the page. For more information, see the [Page guide](https://cloud.google.com/dialogflow/cx/docs/concept/page). # The current Page. Some, not all fields are filled in this message, including but not limited to `name` and `display_name`.
-                  "advancedSettings": { # Hierarchical advanced settings for agent/flow/page/fulfillment/parameter. Settings exposed at lower level overrides the settings exposed at higher level. Overriding occurs at the sub-setting level. For example, the playback_interruption_settings at fulfillment level only overrides the playback_interruption_settings at the agent level, leaving other settings at the agent level unchanged. DTMF settings does not override each other. DTMF settings set at different levels define DTMF detections running in parallel. Hierarchy: Agent->Flow->Page->Fulfillment/Parameter. # Hierarchical advanced settings for this page. The settings exposed at the lower level overrides the settings exposed at the higher level.
-                    "audioExportGcsDestination": { # Google Cloud Storage location for a Dialogflow operation that writes or exports objects (e.g. exported agent or transcripts) outside of Dialogflow. # If present, incoming audio is exported by Dialogflow to the configured Google Cloud Storage destination. Exposed at the following levels: - Agent level - Flow level
-                      "uri": "A String", # Required. The Google Cloud Storage URI for the exported objects. A URI is of the form: `gs://bucket/object-name-or-prefix` Whether a full object name, or just a prefix, its usage depends on the Dialogflow operation.
-                    },
-                    "dtmfSettings": { # Define behaviors for DTMF (dual tone multi frequency). # Settings for DTMF. Exposed at the following levels: - Agent level - Flow level - Page level - Parameter level.
-                      "enabled": True or False, # If true, incoming audio is processed for DTMF (dual tone multi frequency) events. For example, if the caller presses a button on their telephone keypad and DTMF processing is enabled, Dialogflow will detect the event (e.g. a "3" was pressed) in the incoming audio and pass the event to the bot to drive business logic (e.g. when 3 is pressed, return the account balance).
-                      "endpointingTimeoutDuration": "A String", # Endpoint timeout setting for matching dtmf input to regex.
-                      "finishDigit": "A String", # The digit that terminates a DTMF digit sequence.
-                      "interdigitTimeoutDuration": "A String", # Interdigit timeout setting for matching dtmf input to regex.
-                      "maxDigits": 42, # Max length of DTMF digits.
-                    },
-                    "loggingSettings": { # Define behaviors on logging. # Settings for logging. Settings for Dialogflow History, Contact Center messages, StackDriver logs, and speech logging. Exposed at the following levels: - Agent level.
-                      "enableInteractionLogging": True or False, # If true, DF Interaction logging is currently enabled.
-                      "enableStackdriverLogging": True or False, # If true, StackDriver logging is currently enabled.
-                    },
-                    "speechSettings": { # Define behaviors of speech to text detection. # Settings for speech to text detection. Exposed at the following levels: - Agent level - Flow level - Page level - Parameter level
-                      "endpointerSensitivity": 42, # Sensitivity of the speech model that detects the end of speech. Scale from 0 to 100.
-                      "models": { # Mapping from language to Speech-to-Text model. The mapped Speech-to-Text model will be selected for requests from its corresponding language. For more information, see [Speech models](https://cloud.google.com/dialogflow/cx/docs/concept/speech-models).
-                        "a_key": "A String",
-                      },
-                      "noSpeechTimeout": "A String", # Timeout before detecting no speech.
-                      "useTimeoutBasedEndpointing": True or False, # Use timeout based endpointing, interpreting endpointer sensitivy as seconds of timeout value.
-                    },
-                  },
-                  "description": "A String", # The description of the page. The maximum length is 500 characters.
-                  "displayName": "A String", # Required. The human-readable name of the page, unique within the flow.
-                  "entryFulfillment": { # A fulfillment can do one or more of the following actions at the same time: * Generate rich message responses. * Set parameter values. * Call the webhook. Fulfillments can be called at various stages in the Page or Form lifecycle. For example, when a DetectIntentRequest drives a session to enter a new page, the page's entry fulfillment can add a static response to the QueryResult in the returning DetectIntentResponse, call the webhook (for example, to load user data from a database), or both. # The fulfillment to call when the session is entering the page.
-                    "advancedSettings": { # Hierarchical advanced settings for agent/flow/page/fulfillment/parameter. Settings exposed at lower level overrides the settings exposed at higher level. Overriding occurs at the sub-setting level. For example, the playback_interruption_settings at fulfillment level only overrides the playback_interruption_settings at the agent level, leaving other settings at the agent level unchanged. DTMF settings does not override each other. DTMF settings set at different levels define DTMF detections running in parallel. Hierarchy: Agent->Flow->Page->Fulfillment/Parameter. # Hierarchical advanced settings for this fulfillment. The settings exposed at the lower level overrides the settings exposed at the higher level.
-                      "audioExportGcsDestination": { # Google Cloud Storage location for a Dialogflow operation that writes or exports objects (e.g. exported agent or transcripts) outside of Dialogflow. # If present, incoming audio is exported by Dialogflow to the configured Google Cloud Storage destination. Exposed at the following levels: - Agent level - Flow level
-                        "uri": "A String", # Required. The Google Cloud Storage URI for the exported objects. A URI is of the form: `gs://bucket/object-name-or-prefix` Whether a full object name, or just a prefix, its usage depends on the Dialogflow operation.
-                      },
-                      "dtmfSettings": { # Define behaviors for DTMF (dual tone multi frequency). # Settings for DTMF. Exposed at the following levels: - Agent level - Flow level - Page level - Parameter level.
-                        "enabled": True or False, # If true, incoming audio is processed for DTMF (dual tone multi frequency) events. For example, if the caller presses a button on their telephone keypad and DTMF processing is enabled, Dialogflow will detect the event (e.g. a "3" was pressed) in the incoming audio and pass the event to the bot to drive business logic (e.g. when 3 is pressed, return the account balance).
-                        "endpointingTimeoutDuration": "A String", # Endpoint timeout setting for matching dtmf input to regex.
-                        "finishDigit": "A String", # The digit that terminates a DTMF digit sequence.
-                        "interdigitTimeoutDuration": "A String", # Interdigit timeout setting for matching dtmf input to regex.
-                        "maxDigits": 42, # Max length of DTMF digits.
-                      },
-                      "loggingSettings": { # Define behaviors on logging. # Settings for logging. Settings for Dialogflow History, Contact Center messages, StackDriver logs, and speech logging. Exposed at the following levels: - Agent level.
-                        "enableInteractionLogging": True or False, # If true, DF Interaction logging is currently enabled.
-                        "enableStackdriverLogging": True or False, # If true, StackDriver logging is currently enabled.
-                      },
-                      "speechSettings": { # Define behaviors of speech to text detection. # Settings for speech to text detection. Exposed at the following levels: - Agent level - Flow level - Page level - Parameter level
-                        "endpointerSensitivity": 42, # Sensitivity of the speech model that detects the end of speech. Scale from 0 to 100.
-                        "models": { # Mapping from language to Speech-to-Text model. The mapped Speech-to-Text model will be selected for requests from its corresponding language. For more information, see [Speech models](https://cloud.google.com/dialogflow/cx/docs/concept/speech-models).
-                          "a_key": "A String",
-                        },
-                        "noSpeechTimeout": "A String", # Timeout before detecting no speech.
-                        "useTimeoutBasedEndpointing": True or False, # Use timeout based endpointing, interpreting endpointer sensitivy as seconds of timeout value.
-                      },
-                    },
-                    "conditionalCases": [ # Conditional cases for this fulfillment.
-                      { # A list of cascading if-else conditions. Cases are mutually exclusive. The first one with a matching condition is selected, all the rest ignored.
-                        "cases": [ # A list of cascading if-else conditions.
-                          { # Each case has a Boolean condition. When it is evaluated to be True, the corresponding messages will be selected and evaluated recursively.
-                            "caseContent": [ # A list of case content.
-                              { # The list of messages or conditional cases to activate for this case.
-                                "additionalCases": # Object with schema name: GoogleCloudDialogflowCxV3beta1FulfillmentConditionalCases # Additional cases to be evaluated.
-                                "message": { # 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. # Returned message.
-                                  "channel": "A String", # The channel which the response is associated with. Clients can specify the channel via QueryParameters.channel, and only associated channel response will be returned.
-                                  "conversationSuccess": { # 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. # Indicates that the conversation succeeded.
-                                    "metadata": { # Custom metadata. Dialogflow doesn't impose any structure on this.
-                                      "a_key": "", # Properties of the object.
-                                    },
-                                  },
-                                  "endInteraction": { # 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. # Output only. A signal that indicates the interaction with the Dialogflow agent has ended. This message is generated by Dialogflow only when the conversation reaches `END_SESSION` page. It is not supposed to be defined by the user. It's guaranteed that there is at most one such message in each response.
-                                  },
-                                  "knowledgeInfoCard": { # Represents info card response. If the response contains generative knowledge prediction, Dialogflow will return a payload with Infobot Messenger compatible info card. Otherwise, the info card response is skipped. # Represents info card for knowledge answers, to be better rendered in Dialogflow Messenger.
-                                  },
-                                  "liveAgentHandoff": { # 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. # Hands off conversation to a human agent.
-                                    "metadata": { # Custom metadata for your handoff procedure. Dialogflow doesn't impose any structure on this.
-                                      "a_key": "", # Properties of the object.
-                                    },
-                                  },
-                                  "mixedAudio": { # 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. # Output only. An audio response message composed of both the synthesized Dialogflow agent responses and responses defined via play_audio. This message is generated by Dialogflow only and not supposed to be defined by the user.
-                                    "segments": [ # Segments this audio response is composed of.
-                                      { # Represents one segment of audio.
-                                        "allowPlaybackInterruption": True or False, # 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.
-                                        "audio": "A String", # Raw audio synthesized from the Dialogflow agent's response using the output config specified in the request.
-                                        "uri": "A String", # Client-specific URI that points to an audio clip accessible to the client. Dialogflow does not impose any validation on it.
-                                      },
-                                    ],
-                                  },
-                                  "outputAudioText": { # A text or ssml response that is preferentially used for TTS output audio synthesis, as described in the comment on the ResponseMessage message. # A text or ssml response that is preferentially used for TTS output audio synthesis, as described in the comment on the ResponseMessage message.
-                                    "allowPlaybackInterruption": True or False, # 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.
-                                    "ssml": "A String", # The SSML text to be synthesized. For more information, see [SSML](/speech/text-to-speech/docs/ssml).
-                                    "text": "A String", # The raw text to be synthesized.
-                                  },
-                                  "payload": { # Returns a response containing a custom, platform-specific payload.
-                                    "a_key": "", # Properties of the object.
-                                  },
-                                  "playAudio": { # Specifies an audio clip to be played by the client as part of the response. # Signal that the client should play an audio clip hosted at a client-specific URI. Dialogflow uses this to construct mixed_audio. However, Dialogflow itself does not try to read or process the URI in any way.
-                                    "allowPlaybackInterruption": True or False, # 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.
-                                    "audioUri": "A String", # Required. URI of the audio clip. Dialogflow does not impose any validation on this value. It is specific to the client that reads it.
-                                  },
-                                  "telephonyTransferCall": { # Represents the signal that telles the client to transfer the phone call connected to the agent to a third-party endpoint. # A signal that the client should transfer the phone call connected to this agent to a third-party endpoint.
-                                    "phoneNumber": "A String", # Transfer the call to a phone number in [E.164 format](https://en.wikipedia.org/wiki/E.164).
-                                  },
-                                  "text": { # The text response message. # Returns a text response.
-                                    "allowPlaybackInterruption": True or False, # 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.
-                                    "text": [ # Required. A collection of text responses.
-                                      "A String",
-                                    ],
-                                  },
-                                },
+                      "enableGenerativeFallback": True or False, # If the flag is true, the agent will utilize LLM to generate a text response. If LLM generation fails, the defined responses in the fulfillment will be respected. This flag is only useful for fulfillments associated with no-match event handlers.
+                      "messages": [ # The list of rich message responses to present to the user.
+                        { # 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.
+                          "channel": "A String", # The channel which the response is associated with. Clients can specify the channel via QueryParameters.channel, and only associated channel response will be returned.
+                          "conversationSuccess": { # 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. # Indicates that the conversation succeeded.
+                            "metadata": { # Custom metadata. Dialogflow doesn't impose any structure on this.
+                              "a_key": "", # Properties of the object.
+                            },
+                          },
+                          "endInteraction": { # 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. # Output only. A signal that indicates the interaction with the Dialogflow agent has ended. This message is generated by Dialogflow only when the conversation reaches `END_SESSION` page. It is not supposed to be defined by the user. It's guaranteed that there is at most one such message in each response.
+                          },
+                          "knowledgeInfoCard": { # Represents info card response. If the response contains generative knowledge prediction, Dialogflow will return a payload with Infobot Messenger compatible info card. Otherwise, the info card response is skipped. # Represents info card for knowledge answers, to be better rendered in Dialogflow Messenger.
+                          },
+                          "liveAgentHandoff": { # 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. # Hands off conversation to a human agent.
+                            "metadata": { # Custom metadata for your handoff procedure. Dialogflow doesn't impose any structure on this.
+                              "a_key": "", # Properties of the object.
+                            },
+                          },
+                          "mixedAudio": { # 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. # Output only. An audio response message composed of both the synthesized Dialogflow agent responses and responses defined via play_audio. This message is generated by Dialogflow only and not supposed to be defined by the user.
+                            "segments": [ # Segments this audio response is composed of.
+                              { # Represents one segment of audio.
+                                "allowPlaybackInterruption": True or False, # 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.
+                                "audio": "A String", # Raw audio synthesized from the Dialogflow agent's response using the output config specified in the request.
+                                "uri": "A String", # Client-specific URI that points to an audio clip accessible to the client. Dialogflow does not impose any validation on it.
                               },
                             ],
-                            "condition": "A String", # The condition to activate and select this case. Empty means the condition is always true. The condition is evaluated against form parameters or session parameters. See the [conditions reference](https://cloud.google.com/dialogflow/cx/docs/reference/condition).
                           },
-                        ],
-                      },
-                    ],
-                    "enableGenerativeFallback": True or False, # If the flag is true, the agent will utilize LLM to generate a text response. If LLM generation fails, the defined responses in the fulfillment will be respected. This flag is only useful for fulfillments associated with no-match event handlers.
-                    "messages": [ # The list of rich message responses to present to the user.
-                      { # 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.
-                        "channel": "A String", # The channel which the response is associated with. Clients can specify the channel via QueryParameters.channel, and only associated channel response will be returned.
-                        "conversationSuccess": { # 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. # Indicates that the conversation succeeded.
-                          "metadata": { # Custom metadata. Dialogflow doesn't impose any structure on this.
+                          "outputAudioText": { # A text or ssml response that is preferentially used for TTS output audio synthesis, as described in the comment on the ResponseMessage message. # A text or ssml response that is preferentially used for TTS output audio synthesis, as described in the comment on the ResponseMessage message.
+                            "allowPlaybackInterruption": True or False, # 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.
+                            "ssml": "A String", # The SSML text to be synthesized. For more information, see [SSML](/speech/text-to-speech/docs/ssml).
+                            "text": "A String", # The raw text to be synthesized.
+                          },
+                          "payload": { # Returns a response containing a custom, platform-specific payload.
                             "a_key": "", # Properties of the object.
                           },
-                        },
-                        "endInteraction": { # 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. # Output only. A signal that indicates the interaction with the Dialogflow agent has ended. This message is generated by Dialogflow only when the conversation reaches `END_SESSION` page. It is not supposed to be defined by the user. It's guaranteed that there is at most one such message in each response.
-                        },
-                        "knowledgeInfoCard": { # Represents info card response. If the response contains generative knowledge prediction, Dialogflow will return a payload with Infobot Messenger compatible info card. Otherwise, the info card response is skipped. # Represents info card for knowledge answers, to be better rendered in Dialogflow Messenger.
-                        },
-                        "liveAgentHandoff": { # 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. # Hands off conversation to a human agent.
-                          "metadata": { # Custom metadata for your handoff procedure. Dialogflow doesn't impose any structure on this.
-                            "a_key": "", # Properties of the object.
-                          },
-                        },
-                        "mixedAudio": { # 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. # Output only. An audio response message composed of both the synthesized Dialogflow agent responses and responses defined via play_audio. This message is generated by Dialogflow only and not supposed to be defined by the user.
-                          "segments": [ # Segments this audio response is composed of.
-                            { # Represents one segment of audio.
-                              "allowPlaybackInterruption": True or False, # 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.
-                              "audio": "A String", # Raw audio synthesized from the Dialogflow agent's response using the output config specified in the request.
-                              "uri": "A String", # Client-specific URI that points to an audio clip accessible to the client. Dialogflow does not impose any validation on it.
-                            },
-                          ],
-                        },
-                        "outputAudioText": { # A text or ssml response that is preferentially used for TTS output audio synthesis, as described in the comment on the ResponseMessage message. # A text or ssml response that is preferentially used for TTS output audio synthesis, as described in the comment on the ResponseMessage message.
-                          "allowPlaybackInterruption": True or False, # 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.
-                          "ssml": "A String", # The SSML text to be synthesized. For more information, see [SSML](/speech/text-to-speech/docs/ssml).
-                          "text": "A String", # The raw text to be synthesized.
-                        },
-                        "payload": { # Returns a response containing a custom, platform-specific payload.
-                          "a_key": "", # Properties of the object.
-                        },
-                        "playAudio": { # Specifies an audio clip to be played by the client as part of the response. # Signal that the client should play an audio clip hosted at a client-specific URI. Dialogflow uses this to construct mixed_audio. However, Dialogflow itself does not try to read or process the URI in any way.
-                          "allowPlaybackInterruption": True or False, # 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.
-                          "audioUri": "A String", # Required. URI of the audio clip. Dialogflow does not impose any validation on this value. It is specific to the client that reads it.
-                        },
-                        "telephonyTransferCall": { # Represents the signal that telles the client to transfer the phone call connected to the agent to a third-party endpoint. # A signal that the client should transfer the phone call connected to this agent to a third-party endpoint.
-                          "phoneNumber": "A String", # Transfer the call to a phone number in [E.164 format](https://en.wikipedia.org/wiki/E.164).
-                        },
-                        "text": { # The text response message. # Returns a text response.
-                          "allowPlaybackInterruption": True or False, # 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.
-                          "text": [ # Required. A collection of text responses.
-                            "A String",
-                          ],
-                        },
-                      },
-                    ],
-                    "returnPartialResponses": True or False, # Whether Dialogflow should return currently queued fulfillment response messages in streaming APIs. If a webhook is specified, it happens before Dialogflow invokes webhook. Warning: 1) This flag only affects streaming API. Responses are still queued and returned once in non-streaming API. 2) The flag can be enabled in any fulfillment but only the first 3 partial responses will be returned. You may only want to apply it to fulfillments that have slow webhooks.
-                    "setParameterActions": [ # Set parameter values before executing the webhook.
-                      { # Setting a parameter value.
-                        "parameter": "A String", # Display name of the parameter.
-                        "value": "", # The new value of the parameter. A null value clears the parameter.
-                      },
-                    ],
-                    "tag": "A String", # The value of this field will be populated in the WebhookRequest `fulfillmentInfo.tag` field by Dialogflow when the associated webhook is called. The tag is typically used by the webhook service to identify which fulfillment is being called, but it could be used for other purposes. This field is required if `webhook` is specified.
-                    "webhook": "A String", # The webhook to call. Format: `projects//locations//agents//webhooks/`.
-                  },
-                  "eventHandlers": [ # Handlers associated with the page to handle events such as webhook errors, no match or no input.
-                    { # An event handler specifies an event that can be handled during a session. When the specified event happens, the following actions are taken in order: * If there is a `trigger_fulfillment` associated with the event, it will be called. * If there is a `target_page` associated with the event, the session will transition into the specified page. * If there is a `target_flow` associated with the event, the session will transition into the specified flow.
-                      "event": "A String", # Required. The name of the event to handle.
-                      "name": "A String", # Output only. The unique identifier of this event handler.
-                      "targetFlow": "A String", # The target flow to transition to. Format: `projects//locations//agents//flows/`.
-                      "targetPage": "A String", # The target page to transition to. Format: `projects//locations//agents//flows//pages/`.
-                      "triggerFulfillment": { # A fulfillment can do one or more of the following actions at the same time: * Generate rich message responses. * Set parameter values. * Call the webhook. Fulfillments can be called at various stages in the Page or Form lifecycle. For example, when a DetectIntentRequest drives a session to enter a new page, the page's entry fulfillment can add a static response to the QueryResult in the returning DetectIntentResponse, call the webhook (for example, to load user data from a database), or both. # The fulfillment to call when the event occurs. Handling webhook errors with a fulfillment enabled with webhook could cause infinite loop. It is invalid to specify such fulfillment for a handler handling webhooks.
-                        "advancedSettings": { # Hierarchical advanced settings for agent/flow/page/fulfillment/parameter. Settings exposed at lower level overrides the settings exposed at higher level. Overriding occurs at the sub-setting level. For example, the playback_interruption_settings at fulfillment level only overrides the playback_interruption_settings at the agent level, leaving other settings at the agent level unchanged. DTMF settings does not override each other. DTMF settings set at different levels define DTMF detections running in parallel. Hierarchy: Agent->Flow->Page->Fulfillment/Parameter. # Hierarchical advanced settings for this fulfillment. The settings exposed at the lower level overrides the settings exposed at the higher level.
-                          "audioExportGcsDestination": { # Google Cloud Storage location for a Dialogflow operation that writes or exports objects (e.g. exported agent or transcripts) outside of Dialogflow. # If present, incoming audio is exported by Dialogflow to the configured Google Cloud Storage destination. Exposed at the following levels: - Agent level - Flow level
-                            "uri": "A String", # Required. The Google Cloud Storage URI for the exported objects. A URI is of the form: `gs://bucket/object-name-or-prefix` Whether a full object name, or just a prefix, its usage depends on the Dialogflow operation.
+                          "playAudio": { # Specifies an audio clip to be played by the client as part of the response. # Signal that the client should play an audio clip hosted at a client-specific URI. Dialogflow uses this to construct mixed_audio. However, Dialogflow itself does not try to read or process the URI in any way.
+                            "allowPlaybackInterruption": True or False, # 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.
+                            "audioUri": "A String", # Required. URI of the audio clip. Dialogflow does not impose any validation on this value. It is specific to the client that reads it.
                           },
-                          "dtmfSettings": { # Define behaviors for DTMF (dual tone multi frequency). # Settings for DTMF. Exposed at the following levels: - Agent level - Flow level - Page level - Parameter level.
-                            "enabled": True or False, # If true, incoming audio is processed for DTMF (dual tone multi frequency) events. For example, if the caller presses a button on their telephone keypad and DTMF processing is enabled, Dialogflow will detect the event (e.g. a "3" was pressed) in the incoming audio and pass the event to the bot to drive business logic (e.g. when 3 is pressed, return the account balance).
-                            "endpointingTimeoutDuration": "A String", # Endpoint timeout setting for matching dtmf input to regex.
-                            "finishDigit": "A String", # The digit that terminates a DTMF digit sequence.
-                            "interdigitTimeoutDuration": "A String", # Interdigit timeout setting for matching dtmf input to regex.
-                            "maxDigits": 42, # Max length of DTMF digits.
+                          "telephonyTransferCall": { # Represents the signal that telles the client to transfer the phone call connected to the agent to a third-party endpoint. # A signal that the client should transfer the phone call connected to this agent to a third-party endpoint.
+                            "phoneNumber": "A String", # Transfer the call to a phone number in [E.164 format](https://en.wikipedia.org/wiki/E.164).
                           },
-                          "loggingSettings": { # Define behaviors on logging. # Settings for logging. Settings for Dialogflow History, Contact Center messages, StackDriver logs, and speech logging. Exposed at the following levels: - Agent level.
-                            "enableInteractionLogging": True or False, # If true, DF Interaction logging is currently enabled.
-                            "enableStackdriverLogging": True or False, # If true, StackDriver logging is currently enabled.
+                          "text": { # The text response message. # Returns a text response.
+                            "allowPlaybackInterruption": True or False, # 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.
+                            "text": [ # Required. A collection of text responses.
+                              "A String",
+                            ],
                           },
-                          "speechSettings": { # Define behaviors of speech to text detection. # Settings for speech to text detection. Exposed at the following levels: - Agent level - Flow level - Page level - Parameter level
-                            "endpointerSensitivity": 42, # Sensitivity of the speech model that detects the end of speech. Scale from 0 to 100.
-                            "models": { # Mapping from language to Speech-to-Text model. The mapped Speech-to-Text model will be selected for requests from its corresponding language. For more information, see [Speech models](https://cloud.google.com/dialogflow/cx/docs/concept/speech-models).
-                              "a_key": "A String",
+                          "toolCall": { # Represents a call of a specific tool's action with the specified inputs. # Returns the definition of a tool call that should be executed by the client.
+                            "action": "A String", # Required. The name of the tool's action associated with this call.
+                            "inputParameters": { # Optional. The action's input parameters.
+                              "a_key": "", # Properties of the object.
                             },
-                            "noSpeechTimeout": "A String", # Timeout before detecting no speech.
-                            "useTimeoutBasedEndpointing": True or False, # Use timeout based endpointing, interpreting endpointer sensitivy as seconds of timeout value.
+                            "tool": "A String", # Required. The tool associated with this call. Format: `projects//locations//agents//tools/`.
                           },
                         },
-                        "conditionalCases": [ # Conditional cases for this fulfillment.
-                          { # A list of cascading if-else conditions. Cases are mutually exclusive. The first one with a matching condition is selected, all the rest ignored.
-                            "cases": [ # A list of cascading if-else conditions.
-                              { # Each case has a Boolean condition. When it is evaluated to be True, the corresponding messages will be selected and evaluated recursively.
-                                "caseContent": [ # A list of case content.
-                                  { # The list of messages or conditional cases to activate for this case.
-                                    "additionalCases": # Object with schema name: GoogleCloudDialogflowCxV3beta1FulfillmentConditionalCases # Additional cases to be evaluated.
-                                    "message": { # 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. # Returned message.
-                                      "channel": "A String", # The channel which the response is associated with. Clients can specify the channel via QueryParameters.channel, and only associated channel response will be returned.
-                                      "conversationSuccess": { # 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. # Indicates that the conversation succeeded.
-                                        "metadata": { # Custom metadata. Dialogflow doesn't impose any structure on this.
-                                          "a_key": "", # Properties of the object.
+                      ],
+                      "returnPartialResponses": True or False, # Whether Dialogflow should return currently queued fulfillment response messages in streaming APIs. If a webhook is specified, it happens before Dialogflow invokes webhook. Warning: 1) This flag only affects streaming API. Responses are still queued and returned once in non-streaming API. 2) The flag can be enabled in any fulfillment but only the first 3 partial responses will be returned. You may only want to apply it to fulfillments that have slow webhooks.
+                      "setParameterActions": [ # Set parameter values before executing the webhook.
+                        { # Setting a parameter value.
+                          "parameter": "A String", # Display name of the parameter.
+                          "value": "", # The new value of the parameter. A null value clears the parameter.
+                        },
+                      ],
+                      "tag": "A String", # The value of this field will be populated in the WebhookRequest `fulfillmentInfo.tag` field by Dialogflow when the associated webhook is called. The tag is typically used by the webhook service to identify which fulfillment is being called, but it could be used for other purposes. This field is required if `webhook` is specified.
+                      "webhook": "A String", # The webhook to call. Format: `projects//locations//agents//webhooks/`.
+                    },
+                    "repromptEventHandlers": [ # The handlers for parameter-level events, used to provide reprompt for the parameter or transition to a different page/flow. The supported events are: * `sys.no-match-`, where N can be from 1 to 6 * `sys.no-match-default` * `sys.no-input-`, where N can be from 1 to 6 * `sys.no-input-default` * `sys.invalid-parameter` `initial_prompt_fulfillment` provides the first prompt for the parameter. If the user's response does not fill the parameter, a no-match/no-input event will be triggered, and the fulfillment associated with the `sys.no-match-1`/`sys.no-input-1` handler (if defined) will be called to provide a prompt. The `sys.no-match-2`/`sys.no-input-2` handler (if defined) will respond to the next no-match/no-input event, and so on. A `sys.no-match-default` or `sys.no-input-default` handler will be used to handle all following no-match/no-input events after all numbered no-match/no-input handlers for the parameter are consumed. A `sys.invalid-parameter` handler can be defined to handle the case where the parameter values have been `invalidated` by webhook. For example, if the user's response fill the parameter, however the parameter was invalidated by webhook, the fulfillment associated with the `sys.invalid-parameter` handler (if defined) will be called to provide a prompt. If the event handler for the corresponding event can't be found on the parameter, `initial_prompt_fulfillment` will be re-prompted.
+                      { # An event handler specifies an event that can be handled during a session. When the specified event happens, the following actions are taken in order: * If there is a `trigger_fulfillment` associated with the event, it will be called. * If there is a `target_page` associated with the event, the session will transition into the specified page. * If there is a `target_flow` associated with the event, the session will transition into the specified flow.
+                        "event": "A String", # Required. The name of the event to handle.
+                        "name": "A String", # Output only. The unique identifier of this event handler.
+                        "targetFlow": "A String", # The target flow to transition to. Format: `projects//locations//agents//flows/`.
+                        "targetPage": "A String", # The target page to transition to. Format: `projects//locations//agents//flows//pages/`.
+                        "triggerFulfillment": { # A fulfillment can do one or more of the following actions at the same time: * Generate rich message responses. * Set parameter values. * Call the webhook. Fulfillments can be called at various stages in the Page or Form lifecycle. For example, when a DetectIntentRequest drives a session to enter a new page, the page's entry fulfillment can add a static response to the QueryResult in the returning DetectIntentResponse, call the webhook (for example, to load user data from a database), or both. # The fulfillment to call when the event occurs. Handling webhook errors with a fulfillment enabled with webhook could cause infinite loop. It is invalid to specify such fulfillment for a handler handling webhooks.
+                          "advancedSettings": { # Hierarchical advanced settings for agent/flow/page/fulfillment/parameter. Settings exposed at lower level overrides the settings exposed at higher level. Overriding occurs at the sub-setting level. For example, the playback_interruption_settings at fulfillment level only overrides the playback_interruption_settings at the agent level, leaving other settings at the agent level unchanged. DTMF settings does not override each other. DTMF settings set at different levels define DTMF detections running in parallel. Hierarchy: Agent->Flow->Page->Fulfillment/Parameter. # Hierarchical advanced settings for this fulfillment. The settings exposed at the lower level overrides the settings exposed at the higher level.
+                            "audioExportGcsDestination": { # Google Cloud Storage location for a Dialogflow operation that writes or exports objects (e.g. exported agent or transcripts) outside of Dialogflow. # If present, incoming audio is exported by Dialogflow to the configured Google Cloud Storage destination. Exposed at the following levels: - Agent level - Flow level
+                              "uri": "A String", # Required. The Google Cloud Storage URI for the exported objects. A URI is of the form: `gs://bucket/object-name-or-prefix` Whether a full object name, or just a prefix, its usage depends on the Dialogflow operation.
+                            },
+                            "dtmfSettings": { # Define behaviors for DTMF (dual tone multi frequency). # Settings for DTMF. Exposed at the following levels: - Agent level - Flow level - Page level - Parameter level.
+                              "enabled": True or False, # If true, incoming audio is processed for DTMF (dual tone multi frequency) events. For example, if the caller presses a button on their telephone keypad and DTMF processing is enabled, Dialogflow will detect the event (e.g. a "3" was pressed) in the incoming audio and pass the event to the bot to drive business logic (e.g. when 3 is pressed, return the account balance).
+                              "endpointingTimeoutDuration": "A String", # Endpoint timeout setting for matching dtmf input to regex.
+                              "finishDigit": "A String", # The digit that terminates a DTMF digit sequence.
+                              "interdigitTimeoutDuration": "A String", # Interdigit timeout setting for matching dtmf input to regex.
+                              "maxDigits": 42, # Max length of DTMF digits.
+                            },
+                            "loggingSettings": { # Define behaviors on logging. # Settings for logging. Settings for Dialogflow History, Contact Center messages, StackDriver logs, and speech logging. Exposed at the following levels: - Agent level.
+                              "enableInteractionLogging": True or False, # Enables DF Interaction logging.
+                              "enableStackdriverLogging": True or False, # Enables StackDriver logging.
+                            },
+                            "speechSettings": { # Define behaviors of speech to text detection. # Settings for speech to text detection. Exposed at the following levels: - Agent level - Flow level - Page level - Parameter level
+                              "endpointerSensitivity": 42, # Sensitivity of the speech model that detects the end of speech. Scale from 0 to 100.
+                              "models": { # Mapping from language to Speech-to-Text model. The mapped Speech-to-Text model will be selected for requests from its corresponding language. For more information, see [Speech models](https://cloud.google.com/dialogflow/cx/docs/concept/speech-models).
+                                "a_key": "A String",
+                              },
+                              "noSpeechTimeout": "A String", # Timeout before detecting no speech.
+                              "useTimeoutBasedEndpointing": True or False, # Use timeout based endpointing, interpreting endpointer sensitivy as seconds of timeout value.
+                            },
+                          },
+                          "conditionalCases": [ # Conditional cases for this fulfillment.
+                            { # A list of cascading if-else conditions. Cases are mutually exclusive. The first one with a matching condition is selected, all the rest ignored.
+                              "cases": [ # A list of cascading if-else conditions.
+                                { # Each case has a Boolean condition. When it is evaluated to be True, the corresponding messages will be selected and evaluated recursively.
+                                  "caseContent": [ # A list of case content.
+                                    { # The list of messages or conditional cases to activate for this case.
+                                      "additionalCases": # Object with schema name: GoogleCloudDialogflowCxV3beta1FulfillmentConditionalCases # Additional cases to be evaluated.
+                                      "message": { # 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. # Returned message.
+                                        "channel": "A String", # The channel which the response is associated with. Clients can specify the channel via QueryParameters.channel, and only associated channel response will be returned.
+                                        "conversationSuccess": { # 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. # Indicates that the conversation succeeded.
+                                          "metadata": { # Custom metadata. Dialogflow doesn't impose any structure on this.
+                                            "a_key": "", # Properties of the object.
+                                          },
                                         },
-                                      },
-                                      "endInteraction": { # 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. # Output only. A signal that indicates the interaction with the Dialogflow agent has ended. This message is generated by Dialogflow only when the conversation reaches `END_SESSION` page. It is not supposed to be defined by the user. It's guaranteed that there is at most one such message in each response.
-                                      },
-                                      "knowledgeInfoCard": { # Represents info card response. If the response contains generative knowledge prediction, Dialogflow will return a payload with Infobot Messenger compatible info card. Otherwise, the info card response is skipped. # Represents info card for knowledge answers, to be better rendered in Dialogflow Messenger.
-                                      },
-                                      "liveAgentHandoff": { # 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. # Hands off conversation to a human agent.
-                                        "metadata": { # Custom metadata for your handoff procedure. Dialogflow doesn't impose any structure on this.
+                                        "endInteraction": { # 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. # Output only. A signal that indicates the interaction with the Dialogflow agent has ended. This message is generated by Dialogflow only when the conversation reaches `END_SESSION` page. It is not supposed to be defined by the user. It's guaranteed that there is at most one such message in each response.
+                                        },
+                                        "knowledgeInfoCard": { # Represents info card response. If the response contains generative knowledge prediction, Dialogflow will return a payload with Infobot Messenger compatible info card. Otherwise, the info card response is skipped. # Represents info card for knowledge answers, to be better rendered in Dialogflow Messenger.
+                                        },
+                                        "liveAgentHandoff": { # 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. # Hands off conversation to a human agent.
+                                          "metadata": { # Custom metadata for your handoff procedure. Dialogflow doesn't impose any structure on this.
+                                            "a_key": "", # Properties of the object.
+                                          },
+                                        },
+                                        "mixedAudio": { # 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. # Output only. An audio response message composed of both the synthesized Dialogflow agent responses and responses defined via play_audio. This message is generated by Dialogflow only and not supposed to be defined by the user.
+                                          "segments": [ # Segments this audio response is composed of.
+                                            { # Represents one segment of audio.
+                                              "allowPlaybackInterruption": True or False, # 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.
+                                              "audio": "A String", # Raw audio synthesized from the Dialogflow agent's response using the output config specified in the request.
+                                              "uri": "A String", # Client-specific URI that points to an audio clip accessible to the client. Dialogflow does not impose any validation on it.
+                                            },
+                                          ],
+                                        },
+                                        "outputAudioText": { # A text or ssml response that is preferentially used for TTS output audio synthesis, as described in the comment on the ResponseMessage message. # A text or ssml response that is preferentially used for TTS output audio synthesis, as described in the comment on the ResponseMessage message.
+                                          "allowPlaybackInterruption": True or False, # 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.
+                                          "ssml": "A String", # The SSML text to be synthesized. For more information, see [SSML](/speech/text-to-speech/docs/ssml).
+                                          "text": "A String", # The raw text to be synthesized.
+                                        },
+                                        "payload": { # Returns a response containing a custom, platform-specific payload.
                                           "a_key": "", # Properties of the object.
                                         },
-                                      },
-                                      "mixedAudio": { # 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. # Output only. An audio response message composed of both the synthesized Dialogflow agent responses and responses defined via play_audio. This message is generated by Dialogflow only and not supposed to be defined by the user.
-                                        "segments": [ # Segments this audio response is composed of.
-                                          { # Represents one segment of audio.
-                                            "allowPlaybackInterruption": True or False, # 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.
-                                            "audio": "A String", # Raw audio synthesized from the Dialogflow agent's response using the output config specified in the request.
-                                            "uri": "A String", # Client-specific URI that points to an audio clip accessible to the client. Dialogflow does not impose any validation on it.
+                                        "playAudio": { # Specifies an audio clip to be played by the client as part of the response. # Signal that the client should play an audio clip hosted at a client-specific URI. Dialogflow uses this to construct mixed_audio. However, Dialogflow itself does not try to read or process the URI in any way.
+                                          "allowPlaybackInterruption": True or False, # 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.
+                                          "audioUri": "A String", # Required. URI of the audio clip. Dialogflow does not impose any validation on this value. It is specific to the client that reads it.
+                                        },
+                                        "telephonyTransferCall": { # Represents the signal that telles the client to transfer the phone call connected to the agent to a third-party endpoint. # A signal that the client should transfer the phone call connected to this agent to a third-party endpoint.
+                                          "phoneNumber": "A String", # Transfer the call to a phone number in [E.164 format](https://en.wikipedia.org/wiki/E.164).
+                                        },
+                                        "text": { # The text response message. # Returns a text response.
+                                          "allowPlaybackInterruption": True or False, # 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.
+                                          "text": [ # Required. A collection of text responses.
+                                            "A String",
+                                          ],
+                                        },
+                                        "toolCall": { # Represents a call of a specific tool's action with the specified inputs. # Returns the definition of a tool call that should be executed by the client.
+                                          "action": "A String", # Required. The name of the tool's action associated with this call.
+                                          "inputParameters": { # Optional. The action's input parameters.
+                                            "a_key": "", # Properties of the object.
                                           },
-                                        ],
-                                      },
-                                      "outputAudioText": { # A text or ssml response that is preferentially used for TTS output audio synthesis, as described in the comment on the ResponseMessage message. # A text or ssml response that is preferentially used for TTS output audio synthesis, as described in the comment on the ResponseMessage message.
-                                        "allowPlaybackInterruption": True or False, # 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.
-                                        "ssml": "A String", # The SSML text to be synthesized. For more information, see [SSML](/speech/text-to-speech/docs/ssml).
-                                        "text": "A String", # The raw text to be synthesized.
-                                      },
-                                      "payload": { # Returns a response containing a custom, platform-specific payload.
-                                        "a_key": "", # Properties of the object.
-                                      },
-                                      "playAudio": { # Specifies an audio clip to be played by the client as part of the response. # Signal that the client should play an audio clip hosted at a client-specific URI. Dialogflow uses this to construct mixed_audio. However, Dialogflow itself does not try to read or process the URI in any way.
-                                        "allowPlaybackInterruption": True or False, # 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.
-                                        "audioUri": "A String", # Required. URI of the audio clip. Dialogflow does not impose any validation on this value. It is specific to the client that reads it.
-                                      },
-                                      "telephonyTransferCall": { # Represents the signal that telles the client to transfer the phone call connected to the agent to a third-party endpoint. # A signal that the client should transfer the phone call connected to this agent to a third-party endpoint.
-                                        "phoneNumber": "A String", # Transfer the call to a phone number in [E.164 format](https://en.wikipedia.org/wiki/E.164).
-                                      },
-                                      "text": { # The text response message. # Returns a text response.
-                                        "allowPlaybackInterruption": True or False, # 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.
-                                        "text": [ # Required. A collection of text responses.
-                                          "A String",
-                                        ],
+                                          "tool": "A String", # Required. The tool associated with this call. Format: `projects//locations//agents//tools/`.
+                                        },
                                       },
                                     },
-                                  },
-                                ],
-                                "condition": "A String", # The condition to activate and select this case. Empty means the condition is always true. The condition is evaluated against form parameters or session parameters. See the [conditions reference](https://cloud.google.com/dialogflow/cx/docs/reference/condition).
+                                  ],
+                                  "condition": "A String", # The condition to activate and select this case. Empty means the condition is always true. The condition is evaluated against form parameters or session parameters. See the [conditions reference](https://cloud.google.com/dialogflow/cx/docs/reference/condition).
+                                },
+                              ],
+                            },
+                          ],
+                          "enableGenerativeFallback": True or False, # If the flag is true, the agent will utilize LLM to generate a text response. If LLM generation fails, the defined responses in the fulfillment will be respected. This flag is only useful for fulfillments associated with no-match event handlers.
+                          "messages": [ # The list of rich message responses to present to the user.
+                            { # 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.
+                              "channel": "A String", # The channel which the response is associated with. Clients can specify the channel via QueryParameters.channel, and only associated channel response will be returned.
+                              "conversationSuccess": { # 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. # Indicates that the conversation succeeded.
+                                "metadata": { # Custom metadata. Dialogflow doesn't impose any structure on this.
+                                  "a_key": "", # Properties of the object.
+                                },
                               },
-                            ],
-                          },
-                        ],
-                        "enableGenerativeFallback": True or False, # If the flag is true, the agent will utilize LLM to generate a text response. If LLM generation fails, the defined responses in the fulfillment will be respected. This flag is only useful for fulfillments associated with no-match event handlers.
-                        "messages": [ # The list of rich message responses to present to the user.
-                          { # 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.
-                            "channel": "A String", # The channel which the response is associated with. Clients can specify the channel via QueryParameters.channel, and only associated channel response will be returned.
-                            "conversationSuccess": { # 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. # Indicates that the conversation succeeded.
-                              "metadata": { # Custom metadata. Dialogflow doesn't impose any structure on this.
-                                "a_key": "", # Properties of the object.
+                              "endInteraction": { # 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. # Output only. A signal that indicates the interaction with the Dialogflow agent has ended. This message is generated by Dialogflow only when the conversation reaches `END_SESSION` page. It is not supposed to be defined by the user. It's guaranteed that there is at most one such message in each response.
                               },
-                            },
-                            "endInteraction": { # 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. # Output only. A signal that indicates the interaction with the Dialogflow agent has ended. This message is generated by Dialogflow only when the conversation reaches `END_SESSION` page. It is not supposed to be defined by the user. It's guaranteed that there is at most one such message in each response.
-                            },
-                            "knowledgeInfoCard": { # Represents info card response. If the response contains generative knowledge prediction, Dialogflow will return a payload with Infobot Messenger compatible info card. Otherwise, the info card response is skipped. # Represents info card for knowledge answers, to be better rendered in Dialogflow Messenger.
-                            },
-                            "liveAgentHandoff": { # 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. # Hands off conversation to a human agent.
-                              "metadata": { # Custom metadata for your handoff procedure. Dialogflow doesn't impose any structure on this.
+                              "knowledgeInfoCard": { # Represents info card response. If the response contains generative knowledge prediction, Dialogflow will return a payload with Infobot Messenger compatible info card. Otherwise, the info card response is skipped. # Represents info card for knowledge answers, to be better rendered in Dialogflow Messenger.
+                              },
+                              "liveAgentHandoff": { # 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. # Hands off conversation to a human agent.
+                                "metadata": { # Custom metadata for your handoff procedure. Dialogflow doesn't impose any structure on this.
+                                  "a_key": "", # Properties of the object.
+                                },
+                              },
+                              "mixedAudio": { # 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. # Output only. An audio response message composed of both the synthesized Dialogflow agent responses and responses defined via play_audio. This message is generated by Dialogflow only and not supposed to be defined by the user.
+                                "segments": [ # Segments this audio response is composed of.
+                                  { # Represents one segment of audio.
+                                    "allowPlaybackInterruption": True or False, # 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.
+                                    "audio": "A String", # Raw audio synthesized from the Dialogflow agent's response using the output config specified in the request.
+                                    "uri": "A String", # Client-specific URI that points to an audio clip accessible to the client. Dialogflow does not impose any validation on it.
+                                  },
+                                ],
+                              },
+                              "outputAudioText": { # A text or ssml response that is preferentially used for TTS output audio synthesis, as described in the comment on the ResponseMessage message. # A text or ssml response that is preferentially used for TTS output audio synthesis, as described in the comment on the ResponseMessage message.
+                                "allowPlaybackInterruption": True or False, # 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.
+                                "ssml": "A String", # The SSML text to be synthesized. For more information, see [SSML](/speech/text-to-speech/docs/ssml).
+                                "text": "A String", # The raw text to be synthesized.
+                              },
+                              "payload": { # Returns a response containing a custom, platform-specific payload.
                                 "a_key": "", # Properties of the object.
                               },
-                            },
-                            "mixedAudio": { # 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. # Output only. An audio response message composed of both the synthesized Dialogflow agent responses and responses defined via play_audio. This message is generated by Dialogflow only and not supposed to be defined by the user.
-                              "segments": [ # Segments this audio response is composed of.
-                                { # Represents one segment of audio.
-                                  "allowPlaybackInterruption": True or False, # 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.
-                                  "audio": "A String", # Raw audio synthesized from the Dialogflow agent's response using the output config specified in the request.
-                                  "uri": "A String", # Client-specific URI that points to an audio clip accessible to the client. Dialogflow does not impose any validation on it.
+                              "playAudio": { # Specifies an audio clip to be played by the client as part of the response. # Signal that the client should play an audio clip hosted at a client-specific URI. Dialogflow uses this to construct mixed_audio. However, Dialogflow itself does not try to read or process the URI in any way.
+                                "allowPlaybackInterruption": True or False, # 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.
+                                "audioUri": "A String", # Required. URI of the audio clip. Dialogflow does not impose any validation on this value. It is specific to the client that reads it.
+                              },
+                              "telephonyTransferCall": { # Represents the signal that telles the client to transfer the phone call connected to the agent to a third-party endpoint. # A signal that the client should transfer the phone call connected to this agent to a third-party endpoint.
+                                "phoneNumber": "A String", # Transfer the call to a phone number in [E.164 format](https://en.wikipedia.org/wiki/E.164).
+                              },
+                              "text": { # The text response message. # Returns a text response.
+                                "allowPlaybackInterruption": True or False, # 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.
+                                "text": [ # Required. A collection of text responses.
+                                  "A String",
+                                ],
+                              },
+                              "toolCall": { # Represents a call of a specific tool's action with the specified inputs. # Returns the definition of a tool call that should be executed by the client.
+                                "action": "A String", # Required. The name of the tool's action associated with this call.
+                                "inputParameters": { # Optional. The action's input parameters.
+                                  "a_key": "", # Properties of the object.
                                 },
-                              ],
-                            },
-                            "outputAudioText": { # A text or ssml response that is preferentially used for TTS output audio synthesis, as described in the comment on the ResponseMessage message. # A text or ssml response that is preferentially used for TTS output audio synthesis, as described in the comment on the ResponseMessage message.
-                              "allowPlaybackInterruption": True or False, # 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.
-                              "ssml": "A String", # The SSML text to be synthesized. For more information, see [SSML](/speech/text-to-speech/docs/ssml).
-                              "text": "A String", # The raw text to be synthesized.
-                            },
-                            "payload": { # Returns a response containing a custom, platform-specific payload.
-                              "a_key": "", # Properties of the object.
-                            },
-                            "playAudio": { # Specifies an audio clip to be played by the client as part of the response. # Signal that the client should play an audio clip hosted at a client-specific URI. Dialogflow uses this to construct mixed_audio. However, Dialogflow itself does not try to read or process the URI in any way.
-                              "allowPlaybackInterruption": True or False, # 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.
-                              "audioUri": "A String", # Required. URI of the audio clip. Dialogflow does not impose any validation on this value. It is specific to the client that reads it.
-                            },
-                            "telephonyTransferCall": { # Represents the signal that telles the client to transfer the phone call connected to the agent to a third-party endpoint. # A signal that the client should transfer the phone call connected to this agent to a third-party endpoint.
-                              "phoneNumber": "A String", # Transfer the call to a phone number in [E.164 format](https://en.wikipedia.org/wiki/E.164).
+                                "tool": "A String", # Required. The tool associated with this call. Format: `projects//locations//agents//tools/`.
+                              },
                             },
-                            "text": { # The text response message. # Returns a text response.
-                              "allowPlaybackInterruption": True or False, # 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.
-                              "text": [ # Required. A collection of text responses.
-                                "A String",
-                              ],
+                          ],
+                          "returnPartialResponses": True or False, # Whether Dialogflow should return currently queued fulfillment response messages in streaming APIs. If a webhook is specified, it happens before Dialogflow invokes webhook. Warning: 1) This flag only affects streaming API. Responses are still queued and returned once in non-streaming API. 2) The flag can be enabled in any fulfillment but only the first 3 partial responses will be returned. You may only want to apply it to fulfillments that have slow webhooks.
+                          "setParameterActions": [ # Set parameter values before executing the webhook.
+                            { # Setting a parameter value.
+                              "parameter": "A String", # Display name of the parameter.
+                              "value": "", # The new value of the parameter. A null value clears the parameter.
                             },
-                          },
-                        ],
-                        "returnPartialResponses": True or False, # Whether Dialogflow should return currently queued fulfillment response messages in streaming APIs. If a webhook is specified, it happens before Dialogflow invokes webhook. Warning: 1) This flag only affects streaming API. Responses are still queued and returned once in non-streaming API. 2) The flag can be enabled in any fulfillment but only the first 3 partial responses will be returned. You may only want to apply it to fulfillments that have slow webhooks.
-                        "setParameterActions": [ # Set parameter values before executing the webhook.
-                          { # Setting a parameter value.
-                            "parameter": "A String", # Display name of the parameter.
-                            "value": "", # The new value of the parameter. A null value clears the parameter.
-                          },
-                        ],
-                        "tag": "A String", # The value of this field will be populated in the WebhookRequest `fulfillmentInfo.tag` field by Dialogflow when the associated webhook is called. The tag is typically used by the webhook service to identify which fulfillment is being called, but it could be used for other purposes. This field is required if `webhook` is specified.
-                        "webhook": "A String", # The webhook to call. Format: `projects//locations//agents//webhooks/`.
+                          ],
+                          "tag": "A String", # The value of this field will be populated in the WebhookRequest `fulfillmentInfo.tag` field by Dialogflow when the associated webhook is called. The tag is typically used by the webhook service to identify which fulfillment is being called, but it could be used for other purposes. This field is required if `webhook` is specified.
+                          "webhook": "A String", # The webhook to call. Format: `projects//locations//agents//webhooks/`.
+                        },
                       },
+                    ],
+                  },
+                  "isList": True or False, # Indicates whether the parameter represents a list of values.
+                  "redact": True or False, # Indicates whether the parameter content should be redacted in log. If redaction is enabled, the parameter content will be replaced by parameter name during logging. Note: the parameter content is subject to redaction if either parameter level redaction or entity type level redaction is enabled.
+                  "required": True or False, # 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.
+                },
+              ],
+            },
+            "knowledgeConnectorSettings": { # The Knowledge Connector settings for this page or flow. This includes information such as the attached Knowledge Bases, and the way to execute fulfillment. # Optional. Knowledge connector configuration.
+              "dataStoreConnections": [ # Optional. List of related data store connections.
+                { # A data store connection. It represents a data store in Discovery Engine and the type of the contents it contains.
+                  "dataStore": "A String", # The full name of the referenced data store. Formats: `projects/{project}/locations/{location}/collections/{collection}/dataStores/{data_store}` `projects/{project}/locations/{location}/dataStores/{data_store}`
+                  "dataStoreType": "A String", # The type of the connected data store.
+                },
+              ],
+              "enabled": True or False, # Whether Knowledge Connector is enabled or not.
+              "targetFlow": "A String", # The target flow to transition to. Format: `projects//locations//agents//flows/`.
+              "targetPage": "A String", # The target page to transition to. Format: `projects//locations//agents//flows//pages/`.
+              "triggerFulfillment": { # A fulfillment can do one or more of the following actions at the same time: * Generate rich message responses. * Set parameter values. * Call the webhook. Fulfillments can be called at various stages in the Page or Form lifecycle. For example, when a DetectIntentRequest drives a session to enter a new page, the page's entry fulfillment can add a static response to the QueryResult in the returning DetectIntentResponse, call the webhook (for example, to load user data from a database), or both. # The fulfillment to be triggered. When the answers from the Knowledge Connector are selected by Dialogflow, you can utitlize the request scoped parameter `$request.knowledge.answers` (contains up to the 5 highest confidence answers) and `$request.knowledge.questions` (contains the corresponding questions) to construct the fulfillment.
+                "advancedSettings": { # Hierarchical advanced settings for agent/flow/page/fulfillment/parameter. Settings exposed at lower level overrides the settings exposed at higher level. Overriding occurs at the sub-setting level. For example, the playback_interruption_settings at fulfillment level only overrides the playback_interruption_settings at the agent level, leaving other settings at the agent level unchanged. DTMF settings does not override each other. DTMF settings set at different levels define DTMF detections running in parallel. Hierarchy: Agent->Flow->Page->Fulfillment/Parameter. # Hierarchical advanced settings for this fulfillment. The settings exposed at the lower level overrides the settings exposed at the higher level.
+                  "audioExportGcsDestination": { # Google Cloud Storage location for a Dialogflow operation that writes or exports objects (e.g. exported agent or transcripts) outside of Dialogflow. # If present, incoming audio is exported by Dialogflow to the configured Google Cloud Storage destination. Exposed at the following levels: - Agent level - Flow level
+                    "uri": "A String", # Required. The Google Cloud Storage URI for the exported objects. A URI is of the form: `gs://bucket/object-name-or-prefix` Whether a full object name, or just a prefix, its usage depends on the Dialogflow operation.
+                  },
+                  "dtmfSettings": { # Define behaviors for DTMF (dual tone multi frequency). # Settings for DTMF. Exposed at the following levels: - Agent level - Flow level - Page level - Parameter level.
+                    "enabled": True or False, # If true, incoming audio is processed for DTMF (dual tone multi frequency) events. For example, if the caller presses a button on their telephone keypad and DTMF processing is enabled, Dialogflow will detect the event (e.g. a "3" was pressed) in the incoming audio and pass the event to the bot to drive business logic (e.g. when 3 is pressed, return the account balance).
+                    "endpointingTimeoutDuration": "A String", # Endpoint timeout setting for matching dtmf input to regex.
+                    "finishDigit": "A String", # The digit that terminates a DTMF digit sequence.
+                    "interdigitTimeoutDuration": "A String", # Interdigit timeout setting for matching dtmf input to regex.
+                    "maxDigits": 42, # Max length of DTMF digits.
+                  },
+                  "loggingSettings": { # Define behaviors on logging. # Settings for logging. Settings for Dialogflow History, Contact Center messages, StackDriver logs, and speech logging. Exposed at the following levels: - Agent level.
+                    "enableInteractionLogging": True or False, # Enables DF Interaction logging.
+                    "enableStackdriverLogging": True or False, # Enables StackDriver logging.
+                  },
+                  "speechSettings": { # Define behaviors of speech to text detection. # Settings for speech to text detection. Exposed at the following levels: - Agent level - Flow level - Page level - Parameter level
+                    "endpointerSensitivity": 42, # Sensitivity of the speech model that detects the end of speech. Scale from 0 to 100.
+                    "models": { # Mapping from language to Speech-to-Text model. The mapped Speech-to-Text model will be selected for requests from its corresponding language. For more information, see [Speech models](https://cloud.google.com/dialogflow/cx/docs/concept/speech-models).
+                      "a_key": "A String",
                     },
-                  ],
-                  "form": { # A form is a data model that groups related parameters that can be collected from the user. The process in which the agent prompts the user and collects parameter values from the user is called form filling. A form can be added to a page. When form filling is done, the filled parameters will be written to the session. # The form associated with the page, used for collecting parameters relevant to the page.
-                    "parameters": [ # Parameters to collect from the user.
-                      { # Represents a form parameter.
-                        "advancedSettings": { # Hierarchical advanced settings for agent/flow/page/fulfillment/parameter. Settings exposed at lower level overrides the settings exposed at higher level. Overriding occurs at the sub-setting level. For example, the playback_interruption_settings at fulfillment level only overrides the playback_interruption_settings at the agent level, leaving other settings at the agent level unchanged. DTMF settings does not override each other. DTMF settings set at different levels define DTMF detections running in parallel. Hierarchy: Agent->Flow->Page->Fulfillment/Parameter. # Hierarchical advanced settings for this parameter. The settings exposed at the lower level overrides the settings exposed at the higher level.
-                          "audioExportGcsDestination": { # Google Cloud Storage location for a Dialogflow operation that writes or exports objects (e.g. exported agent or transcripts) outside of Dialogflow. # If present, incoming audio is exported by Dialogflow to the configured Google Cloud Storage destination. Exposed at the following levels: - Agent level - Flow level
-                            "uri": "A String", # Required. The Google Cloud Storage URI for the exported objects. A URI is of the form: `gs://bucket/object-name-or-prefix` Whether a full object name, or just a prefix, its usage depends on the Dialogflow operation.
-                          },
-                          "dtmfSettings": { # Define behaviors for DTMF (dual tone multi frequency). # Settings for DTMF. Exposed at the following levels: - Agent level - Flow level - Page level - Parameter level.
-                            "enabled": True or False, # If true, incoming audio is processed for DTMF (dual tone multi frequency) events. For example, if the caller presses a button on their telephone keypad and DTMF processing is enabled, Dialogflow will detect the event (e.g. a "3" was pressed) in the incoming audio and pass the event to the bot to drive business logic (e.g. when 3 is pressed, return the account balance).
-                            "endpointingTimeoutDuration": "A String", # Endpoint timeout setting for matching dtmf input to regex.
-                            "finishDigit": "A String", # The digit that terminates a DTMF digit sequence.
-                            "interdigitTimeoutDuration": "A String", # Interdigit timeout setting for matching dtmf input to regex.
-                            "maxDigits": 42, # Max length of DTMF digits.
-                          },
-                          "loggingSettings": { # Define behaviors on logging. # Settings for logging. Settings for Dialogflow History, Contact Center messages, StackDriver logs, and speech logging. Exposed at the following levels: - Agent level.
-                            "enableInteractionLogging": True or False, # If true, DF Interaction logging is currently enabled.
-                            "enableStackdriverLogging": True or False, # If true, StackDriver logging is currently enabled.
-                          },
-                          "speechSettings": { # Define behaviors of speech to text detection. # Settings for speech to text detection. Exposed at the following levels: - Agent level - Flow level - Page level - Parameter level
-                            "endpointerSensitivity": 42, # Sensitivity of the speech model that detects the end of speech. Scale from 0 to 100.
-                            "models": { # Mapping from language to Speech-to-Text model. The mapped Speech-to-Text model will be selected for requests from its corresponding language. For more information, see [Speech models](https://cloud.google.com/dialogflow/cx/docs/concept/speech-models).
-                              "a_key": "A String",
-                            },
-                            "noSpeechTimeout": "A String", # Timeout before detecting no speech.
-                            "useTimeoutBasedEndpointing": True or False, # Use timeout based endpointing, interpreting endpointer sensitivy as seconds of timeout value.
-                          },
-                        },
-                        "defaultValue": "", # The default value of an optional parameter. If the parameter is required, the default value will be ignored.
-                        "displayName": "A String", # Required. The human-readable name of the parameter, unique within the form.
-                        "entityType": "A String", # Required. The entity type of the parameter. Format: `projects/-/locations/-/agents/-/entityTypes/` for system entity types (for example, `projects/-/locations/-/agents/-/entityTypes/sys.date`), or `projects//locations//agents//entityTypes/` for developer entity types.
-                        "fillBehavior": { # Configuration for how the filling of a parameter should be handled. # Required. Defines fill behavior for the parameter.
-                          "initialPromptFulfillment": { # A fulfillment can do one or more of the following actions at the same time: * Generate rich message responses. * Set parameter values. * Call the webhook. Fulfillments can be called at various stages in the Page or Form lifecycle. For example, when a DetectIntentRequest drives a session to enter a new page, the page's entry fulfillment can add a static response to the QueryResult in the returning DetectIntentResponse, call the webhook (for example, to load user data from a database), or both. # Required. The fulfillment to provide the initial prompt that the agent can present to the user in order to fill the parameter.
-                            "advancedSettings": { # Hierarchical advanced settings for agent/flow/page/fulfillment/parameter. Settings exposed at lower level overrides the settings exposed at higher level. Overriding occurs at the sub-setting level. For example, the playback_interruption_settings at fulfillment level only overrides the playback_interruption_settings at the agent level, leaving other settings at the agent level unchanged. DTMF settings does not override each other. DTMF settings set at different levels define DTMF detections running in parallel. Hierarchy: Agent->Flow->Page->Fulfillment/Parameter. # Hierarchical advanced settings for this fulfillment. The settings exposed at the lower level overrides the settings exposed at the higher level.
-                              "audioExportGcsDestination": { # Google Cloud Storage location for a Dialogflow operation that writes or exports objects (e.g. exported agent or transcripts) outside of Dialogflow. # If present, incoming audio is exported by Dialogflow to the configured Google Cloud Storage destination. Exposed at the following levels: - Agent level - Flow level
-                                "uri": "A String", # Required. The Google Cloud Storage URI for the exported objects. A URI is of the form: `gs://bucket/object-name-or-prefix` Whether a full object name, or just a prefix, its usage depends on the Dialogflow operation.
+                    "noSpeechTimeout": "A String", # Timeout before detecting no speech.
+                    "useTimeoutBasedEndpointing": True or False, # Use timeout based endpointing, interpreting endpointer sensitivy as seconds of timeout value.
+                  },
+                },
+                "conditionalCases": [ # Conditional cases for this fulfillment.
+                  { # A list of cascading if-else conditions. Cases are mutually exclusive. The first one with a matching condition is selected, all the rest ignored.
+                    "cases": [ # A list of cascading if-else conditions.
+                      { # Each case has a Boolean condition. When it is evaluated to be True, the corresponding messages will be selected and evaluated recursively.
+                        "caseContent": [ # A list of case content.
+                          { # The list of messages or conditional cases to activate for this case.
+                            "additionalCases": # Object with schema name: GoogleCloudDialogflowCxV3beta1FulfillmentConditionalCases # Additional cases to be evaluated.
+                            "message": { # 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. # Returned message.
+                              "channel": "A String", # The channel which the response is associated with. Clients can specify the channel via QueryParameters.channel, and only associated channel response will be returned.
+                              "conversationSuccess": { # 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. # Indicates that the conversation succeeded.
+                                "metadata": { # Custom metadata. Dialogflow doesn't impose any structure on this.
+                                  "a_key": "", # Properties of the object.
+                                },
                               },
-                              "dtmfSettings": { # Define behaviors for DTMF (dual tone multi frequency). # Settings for DTMF. Exposed at the following levels: - Agent level - Flow level - Page level - Parameter level.
-                                "enabled": True or False, # If true, incoming audio is processed for DTMF (dual tone multi frequency) events. For example, if the caller presses a button on their telephone keypad and DTMF processing is enabled, Dialogflow will detect the event (e.g. a "3" was pressed) in the incoming audio and pass the event to the bot to drive business logic (e.g. when 3 is pressed, return the account balance).
-                                "endpointingTimeoutDuration": "A String", # Endpoint timeout setting for matching dtmf input to regex.
-                                "finishDigit": "A String", # The digit that terminates a DTMF digit sequence.
-                                "interdigitTimeoutDuration": "A String", # Interdigit timeout setting for matching dtmf input to regex.
-                                "maxDigits": 42, # Max length of DTMF digits.
+                              "endInteraction": { # 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. # Output only. A signal that indicates the interaction with the Dialogflow agent has ended. This message is generated by Dialogflow only when the conversation reaches `END_SESSION` page. It is not supposed to be defined by the user. It's guaranteed that there is at most one such message in each response.
                               },
-                              "loggingSettings": { # Define behaviors on logging. # Settings for logging. Settings for Dialogflow History, Contact Center messages, StackDriver logs, and speech logging. Exposed at the following levels: - Agent level.
-                                "enableInteractionLogging": True or False, # If true, DF Interaction logging is currently enabled.
-                                "enableStackdriverLogging": True or False, # If true, StackDriver logging is currently enabled.
+                              "knowledgeInfoCard": { # Represents info card response. If the response contains generative knowledge prediction, Dialogflow will return a payload with Infobot Messenger compatible info card. Otherwise, the info card response is skipped. # Represents info card for knowledge answers, to be better rendered in Dialogflow Messenger.
                               },
-                              "speechSettings": { # Define behaviors of speech to text detection. # Settings for speech to text detection. Exposed at the following levels: - Agent level - Flow level - Page level - Parameter level
-                                "endpointerSensitivity": 42, # Sensitivity of the speech model that detects the end of speech. Scale from 0 to 100.
-                                "models": { # Mapping from language to Speech-to-Text model. The mapped Speech-to-Text model will be selected for requests from its corresponding language. For more information, see [Speech models](https://cloud.google.com/dialogflow/cx/docs/concept/speech-models).
-                                  "a_key": "A String",
+                              "liveAgentHandoff": { # 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. # Hands off conversation to a human agent.
+                                "metadata": { # Custom metadata for your handoff procedure. Dialogflow doesn't impose any structure on this.
+                                  "a_key": "", # Properties of the object.
                                 },
-                                "noSpeechTimeout": "A String", # Timeout before detecting no speech.
-                                "useTimeoutBasedEndpointing": True or False, # Use timeout based endpointing, interpreting endpointer sensitivy as seconds of timeout value.
+                              },
+                              "mixedAudio": { # 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. # Output only. An audio response message composed of both the synthesized Dialogflow agent responses and responses defined via play_audio. This message is generated by Dialogflow only and not supposed to be defined by the user.
+                                "segments": [ # Segments this audio response is composed of.
+                                  { # Represents one segment of audio.
+                                    "allowPlaybackInterruption": True or False, # 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.
+                                    "audio": "A String", # Raw audio synthesized from the Dialogflow agent's response using the output config specified in the request.
+                                    "uri": "A String", # Client-specific URI that points to an audio clip accessible to the client. Dialogflow does not impose any validation on it.
+                                  },
+                                ],
+                              },
+                              "outputAudioText": { # A text or ssml response that is preferentially used for TTS output audio synthesis, as described in the comment on the ResponseMessage message. # A text or ssml response that is preferentially used for TTS output audio synthesis, as described in the comment on the ResponseMessage message.
+                                "allowPlaybackInterruption": True or False, # 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.
+                                "ssml": "A String", # The SSML text to be synthesized. For more information, see [SSML](/speech/text-to-speech/docs/ssml).
+                                "text": "A String", # The raw text to be synthesized.
+                              },
+                              "payload": { # Returns a response containing a custom, platform-specific payload.
+                                "a_key": "", # Properties of the object.
+                              },
+                              "playAudio": { # Specifies an audio clip to be played by the client as part of the response. # Signal that the client should play an audio clip hosted at a client-specific URI. Dialogflow uses this to construct mixed_audio. However, Dialogflow itself does not try to read or process the URI in any way.
+                                "allowPlaybackInterruption": True or False, # 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.
+                                "audioUri": "A String", # Required. URI of the audio clip. Dialogflow does not impose any validation on this value. It is specific to the client that reads it.
+                              },
+                              "telephonyTransferCall": { # Represents the signal that telles the client to transfer the phone call connected to the agent to a third-party endpoint. # A signal that the client should transfer the phone call connected to this agent to a third-party endpoint.
+                                "phoneNumber": "A String", # Transfer the call to a phone number in [E.164 format](https://en.wikipedia.org/wiki/E.164).
+                              },
+                              "text": { # The text response message. # Returns a text response.
+                                "allowPlaybackInterruption": True or False, # 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.
+                                "text": [ # Required. A collection of text responses.
+                                  "A String",
+                                ],
+                              },
+                              "toolCall": { # Represents a call of a specific tool's action with the specified inputs. # Returns the definition of a tool call that should be executed by the client.
+                                "action": "A String", # Required. The name of the tool's action associated with this call.
+                                "inputParameters": { # Optional. The action's input parameters.
+                                  "a_key": "", # Properties of the object.
+                                },
+                                "tool": "A String", # Required. The tool associated with this call. Format: `projects//locations//agents//tools/`.
                               },
                             },
-                            "conditionalCases": [ # Conditional cases for this fulfillment.
-                              { # A list of cascading if-else conditions. Cases are mutually exclusive. The first one with a matching condition is selected, all the rest ignored.
-                                "cases": [ # A list of cascading if-else conditions.
-                                  { # Each case has a Boolean condition. When it is evaluated to be True, the corresponding messages will be selected and evaluated recursively.
-                                    "caseContent": [ # A list of case content.
-                                      { # The list of messages or conditional cases to activate for this case.
-                                        "additionalCases": # Object with schema name: GoogleCloudDialogflowCxV3beta1FulfillmentConditionalCases # Additional cases to be evaluated.
-                                        "message": { # 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. # Returned message.
-                                          "channel": "A String", # The channel which the response is associated with. Clients can specify the channel via QueryParameters.channel, and only associated channel response will be returned.
-                                          "conversationSuccess": { # 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. # Indicates that the conversation succeeded.
-                                            "metadata": { # Custom metadata. Dialogflow doesn't impose any structure on this.
-                                              "a_key": "", # Properties of the object.
-                                            },
-                                          },
-                                          "endInteraction": { # 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. # Output only. A signal that indicates the interaction with the Dialogflow agent has ended. This message is generated by Dialogflow only when the conversation reaches `END_SESSION` page. It is not supposed to be defined by the user. It's guaranteed that there is at most one such message in each response.
-                                          },
-                                          "knowledgeInfoCard": { # Represents info card response. If the response contains generative knowledge prediction, Dialogflow will return a payload with Infobot Messenger compatible info card. Otherwise, the info card response is skipped. # Represents info card for knowledge answers, to be better rendered in Dialogflow Messenger.
-                                          },
-                                          "liveAgentHandoff": { # 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. # Hands off conversation to a human agent.
-                                            "metadata": { # Custom metadata for your handoff procedure. Dialogflow doesn't impose any structure on this.
-                                              "a_key": "", # Properties of the object.
-                                            },
-                                          },
-                                          "mixedAudio": { # 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. # Output only. An audio response message composed of both the synthesized Dialogflow agent responses and responses defined via play_audio. This message is generated by Dialogflow only and not supposed to be defined by the user.
-                                            "segments": [ # Segments this audio response is composed of.
-                                              { # Represents one segment of audio.
-                                                "allowPlaybackInterruption": True or False, # 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.
-                                                "audio": "A String", # Raw audio synthesized from the Dialogflow agent's response using the output config specified in the request.
-                                                "uri": "A String", # Client-specific URI that points to an audio clip accessible to the client. Dialogflow does not impose any validation on it.
-                                              },
-                                            ],
-                                          },
-                                          "outputAudioText": { # A text or ssml response that is preferentially used for TTS output audio synthesis, as described in the comment on the ResponseMessage message. # A text or ssml response that is preferentially used for TTS output audio synthesis, as described in the comment on the ResponseMessage message.
-                                            "allowPlaybackInterruption": True or False, # 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.
-                                            "ssml": "A String", # The SSML text to be synthesized. For more information, see [SSML](/speech/text-to-speech/docs/ssml).
-                                            "text": "A String", # The raw text to be synthesized.
-                                          },
-                                          "payload": { # Returns a response containing a custom, platform-specific payload.
-                                            "a_key": "", # Properties of the object.
-                                          },
-                                          "playAudio": { # Specifies an audio clip to be played by the client as part of the response. # Signal that the client should play an audio clip hosted at a client-specific URI. Dialogflow uses this to construct mixed_audio. However, Dialogflow itself does not try to read or process the URI in any way.
-                                            "allowPlaybackInterruption": True or False, # 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.
-                                            "audioUri": "A String", # Required. URI of the audio clip. Dialogflow does not impose any validation on this value. It is specific to the client that reads it.
-                                          },
-                                          "telephonyTransferCall": { # Represents the signal that telles the client to transfer the phone call connected to the agent to a third-party endpoint. # A signal that the client should transfer the phone call connected to this agent to a third-party endpoint.
-                                            "phoneNumber": "A String", # Transfer the call to a phone number in [E.164 format](https://en.wikipedia.org/wiki/E.164).
-                                          },
-                                          "text": { # The text response message. # Returns a text response.
-                                            "allowPlaybackInterruption": True or False, # 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.
-                                            "text": [ # Required. A collection of text responses.
-                                              "A String",
-                                            ],
-                                          },
-                                        },
-                                      },
-                                    ],
-                                    "condition": "A String", # The condition to activate and select this case. Empty means the condition is always true. The condition is evaluated against form parameters or session parameters. See the [conditions reference](https://cloud.google.com/dialogflow/cx/docs/reference/condition).
-                                  },
-                                ],
-                              },
-                            ],
-                            "enableGenerativeFallback": True or False, # If the flag is true, the agent will utilize LLM to generate a text response. If LLM generation fails, the defined responses in the fulfillment will be respected. This flag is only useful for fulfillments associated with no-match event handlers.
-                            "messages": [ # The list of rich message responses to present to the user.
-                              { # 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.
+                          },
+                        ],
+                        "condition": "A String", # The condition to activate and select this case. Empty means the condition is always true. The condition is evaluated against form parameters or session parameters. See the [conditions reference](https://cloud.google.com/dialogflow/cx/docs/reference/condition).
+                      },
+                    ],
+                  },
+                ],
+                "enableGenerativeFallback": True or False, # If the flag is true, the agent will utilize LLM to generate a text response. If LLM generation fails, the defined responses in the fulfillment will be respected. This flag is only useful for fulfillments associated with no-match event handlers.
+                "messages": [ # The list of rich message responses to present to the user.
+                  { # 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.
+                    "channel": "A String", # The channel which the response is associated with. Clients can specify the channel via QueryParameters.channel, and only associated channel response will be returned.
+                    "conversationSuccess": { # 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. # Indicates that the conversation succeeded.
+                      "metadata": { # Custom metadata. Dialogflow doesn't impose any structure on this.
+                        "a_key": "", # Properties of the object.
+                      },
+                    },
+                    "endInteraction": { # 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. # Output only. A signal that indicates the interaction with the Dialogflow agent has ended. This message is generated by Dialogflow only when the conversation reaches `END_SESSION` page. It is not supposed to be defined by the user. It's guaranteed that there is at most one such message in each response.
+                    },
+                    "knowledgeInfoCard": { # Represents info card response. If the response contains generative knowledge prediction, Dialogflow will return a payload with Infobot Messenger compatible info card. Otherwise, the info card response is skipped. # Represents info card for knowledge answers, to be better rendered in Dialogflow Messenger.
+                    },
+                    "liveAgentHandoff": { # 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. # Hands off conversation to a human agent.
+                      "metadata": { # Custom metadata for your handoff procedure. Dialogflow doesn't impose any structure on this.
+                        "a_key": "", # Properties of the object.
+                      },
+                    },
+                    "mixedAudio": { # 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. # Output only. An audio response message composed of both the synthesized Dialogflow agent responses and responses defined via play_audio. This message is generated by Dialogflow only and not supposed to be defined by the user.
+                      "segments": [ # Segments this audio response is composed of.
+                        { # Represents one segment of audio.
+                          "allowPlaybackInterruption": True or False, # 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.
+                          "audio": "A String", # Raw audio synthesized from the Dialogflow agent's response using the output config specified in the request.
+                          "uri": "A String", # Client-specific URI that points to an audio clip accessible to the client. Dialogflow does not impose any validation on it.
+                        },
+                      ],
+                    },
+                    "outputAudioText": { # A text or ssml response that is preferentially used for TTS output audio synthesis, as described in the comment on the ResponseMessage message. # A text or ssml response that is preferentially used for TTS output audio synthesis, as described in the comment on the ResponseMessage message.
+                      "allowPlaybackInterruption": True or False, # 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.
+                      "ssml": "A String", # The SSML text to be synthesized. For more information, see [SSML](/speech/text-to-speech/docs/ssml).
+                      "text": "A String", # The raw text to be synthesized.
+                    },
+                    "payload": { # Returns a response containing a custom, platform-specific payload.
+                      "a_key": "", # Properties of the object.
+                    },
+                    "playAudio": { # Specifies an audio clip to be played by the client as part of the response. # Signal that the client should play an audio clip hosted at a client-specific URI. Dialogflow uses this to construct mixed_audio. However, Dialogflow itself does not try to read or process the URI in any way.
+                      "allowPlaybackInterruption": True or False, # 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.
+                      "audioUri": "A String", # Required. URI of the audio clip. Dialogflow does not impose any validation on this value. It is specific to the client that reads it.
+                    },
+                    "telephonyTransferCall": { # Represents the signal that telles the client to transfer the phone call connected to the agent to a third-party endpoint. # A signal that the client should transfer the phone call connected to this agent to a third-party endpoint.
+                      "phoneNumber": "A String", # Transfer the call to a phone number in [E.164 format](https://en.wikipedia.org/wiki/E.164).
+                    },
+                    "text": { # The text response message. # Returns a text response.
+                      "allowPlaybackInterruption": True or False, # 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.
+                      "text": [ # Required. A collection of text responses.
+                        "A String",
+                      ],
+                    },
+                    "toolCall": { # Represents a call of a specific tool's action with the specified inputs. # Returns the definition of a tool call that should be executed by the client.
+                      "action": "A String", # Required. The name of the tool's action associated with this call.
+                      "inputParameters": { # Optional. The action's input parameters.
+                        "a_key": "", # Properties of the object.
+                      },
+                      "tool": "A String", # Required. The tool associated with this call. Format: `projects//locations//agents//tools/`.
+                    },
+                  },
+                ],
+                "returnPartialResponses": True or False, # Whether Dialogflow should return currently queued fulfillment response messages in streaming APIs. If a webhook is specified, it happens before Dialogflow invokes webhook. Warning: 1) This flag only affects streaming API. Responses are still queued and returned once in non-streaming API. 2) The flag can be enabled in any fulfillment but only the first 3 partial responses will be returned. You may only want to apply it to fulfillments that have slow webhooks.
+                "setParameterActions": [ # Set parameter values before executing the webhook.
+                  { # Setting a parameter value.
+                    "parameter": "A String", # Display name of the parameter.
+                    "value": "", # The new value of the parameter. A null value clears the parameter.
+                  },
+                ],
+                "tag": "A String", # The value of this field will be populated in the WebhookRequest `fulfillmentInfo.tag` field by Dialogflow when the associated webhook is called. The tag is typically used by the webhook service to identify which fulfillment is being called, but it could be used for other purposes. This field is required if `webhook` is specified.
+                "webhook": "A String", # The webhook to call. Format: `projects//locations//agents//webhooks/`.
+              },
+            },
+            "name": "A String", # The unique identifier of the page. Required for the Pages.UpdatePage method. Pages.CreatePage populates the name automatically. Format: `projects//locations//agents//flows//pages/`.
+            "transitionRouteGroups": [ # Ordered list of `TransitionRouteGroups` added to the page. Transition route groups must be unique within a page. If the page links both flow-level transition route groups and agent-level transition route groups, the flow-level ones will have higher priority and will be put before the agent-level ones. * If multiple transition routes within a page scope refer to the same intent, then the precedence order is: page's transition route -> page's transition route group -> flow's transition routes. * If multiple transition route groups within a page contain the same intent, then the first group in the ordered list takes precedence. Format:`projects//locations//agents//flows//transitionRouteGroups/` or `projects//locations//agents//transitionRouteGroups/` for agent-level groups.
+              "A String",
+            ],
+            "transitionRoutes": [ # A list of transitions for the transition rules of this page. They route the conversation to another page in the same flow, or another flow. When we are in a certain page, the TransitionRoutes are evalauted in the following order: * TransitionRoutes defined in the page with intent specified. * TransitionRoutes defined in the transition route groups with intent specified. * TransitionRoutes defined in flow with intent specified. * TransitionRoutes defined in the transition route groups with intent specified. * TransitionRoutes defined in the page with only condition specified. * TransitionRoutes defined in the transition route groups with only condition specified.
+              { # A transition route specifies a intent that can be matched and/or a data condition that can be evaluated during a session. When a specified transition is matched, the following actions are taken in order: * If there is a `trigger_fulfillment` associated with the transition, it will be called. * If there is a `target_page` associated with the transition, the session will transition into the specified page. * If there is a `target_flow` associated with the transition, the session will transition into the specified flow.
+                "condition": "A String", # The condition to evaluate against form parameters or session parameters. See the [conditions reference](https://cloud.google.com/dialogflow/cx/docs/reference/condition). At least one of `intent` or `condition` must be specified. When both `intent` and `condition` are specified, the transition can only happen when both are fulfilled.
+                "description": "A String", # Optional. The description of the transition route. The maximum length is 500 characters.
+                "intent": "A String", # The unique identifier of an Intent. Format: `projects//locations//agents//intents/`. Indicates that the transition can only happen when the given intent is matched. At least one of `intent` or `condition` must be specified. When both `intent` and `condition` are specified, the transition can only happen when both are fulfilled.
+                "name": "A String", # Output only. The unique identifier of this transition route.
+                "targetFlow": "A String", # The target flow to transition to. Format: `projects//locations//agents//flows/`.
+                "targetPage": "A String", # The target page to transition to. Format: `projects//locations//agents//flows//pages/`.
+                "triggerFulfillment": { # A fulfillment can do one or more of the following actions at the same time: * Generate rich message responses. * Set parameter values. * Call the webhook. Fulfillments can be called at various stages in the Page or Form lifecycle. For example, when a DetectIntentRequest drives a session to enter a new page, the page's entry fulfillment can add a static response to the QueryResult in the returning DetectIntentResponse, call the webhook (for example, to load user data from a database), or both. # The fulfillment to call when the condition is satisfied. At least one of `trigger_fulfillment` and `target` must be specified. When both are defined, `trigger_fulfillment` is executed first.
+                  "advancedSettings": { # Hierarchical advanced settings for agent/flow/page/fulfillment/parameter. Settings exposed at lower level overrides the settings exposed at higher level. Overriding occurs at the sub-setting level. For example, the playback_interruption_settings at fulfillment level only overrides the playback_interruption_settings at the agent level, leaving other settings at the agent level unchanged. DTMF settings does not override each other. DTMF settings set at different levels define DTMF detections running in parallel. Hierarchy: Agent->Flow->Page->Fulfillment/Parameter. # Hierarchical advanced settings for this fulfillment. The settings exposed at the lower level overrides the settings exposed at the higher level.
+                    "audioExportGcsDestination": { # Google Cloud Storage location for a Dialogflow operation that writes or exports objects (e.g. exported agent or transcripts) outside of Dialogflow. # If present, incoming audio is exported by Dialogflow to the configured Google Cloud Storage destination. Exposed at the following levels: - Agent level - Flow level
+                      "uri": "A String", # Required. The Google Cloud Storage URI for the exported objects. A URI is of the form: `gs://bucket/object-name-or-prefix` Whether a full object name, or just a prefix, its usage depends on the Dialogflow operation.
+                    },
+                    "dtmfSettings": { # Define behaviors for DTMF (dual tone multi frequency). # Settings for DTMF. Exposed at the following levels: - Agent level - Flow level - Page level - Parameter level.
+                      "enabled": True or False, # If true, incoming audio is processed for DTMF (dual tone multi frequency) events. For example, if the caller presses a button on their telephone keypad and DTMF processing is enabled, Dialogflow will detect the event (e.g. a "3" was pressed) in the incoming audio and pass the event to the bot to drive business logic (e.g. when 3 is pressed, return the account balance).
+                      "endpointingTimeoutDuration": "A String", # Endpoint timeout setting for matching dtmf input to regex.
+                      "finishDigit": "A String", # The digit that terminates a DTMF digit sequence.
+                      "interdigitTimeoutDuration": "A String", # Interdigit timeout setting for matching dtmf input to regex.
+                      "maxDigits": 42, # Max length of DTMF digits.
+                    },
+                    "loggingSettings": { # Define behaviors on logging. # Settings for logging. Settings for Dialogflow History, Contact Center messages, StackDriver logs, and speech logging. Exposed at the following levels: - Agent level.
+                      "enableInteractionLogging": True or False, # Enables DF Interaction logging.
+                      "enableStackdriverLogging": True or False, # Enables StackDriver logging.
+                    },
+                    "speechSettings": { # Define behaviors of speech to text detection. # Settings for speech to text detection. Exposed at the following levels: - Agent level - Flow level - Page level - Parameter level
+                      "endpointerSensitivity": 42, # Sensitivity of the speech model that detects the end of speech. Scale from 0 to 100.
+                      "models": { # Mapping from language to Speech-to-Text model. The mapped Speech-to-Text model will be selected for requests from its corresponding language. For more information, see [Speech models](https://cloud.google.com/dialogflow/cx/docs/concept/speech-models).
+                        "a_key": "A String",
+                      },
+                      "noSpeechTimeout": "A String", # Timeout before detecting no speech.
+                      "useTimeoutBasedEndpointing": True or False, # Use timeout based endpointing, interpreting endpointer sensitivy as seconds of timeout value.
+                    },
+                  },
+                  "conditionalCases": [ # Conditional cases for this fulfillment.
+                    { # A list of cascading if-else conditions. Cases are mutually exclusive. The first one with a matching condition is selected, all the rest ignored.
+                      "cases": [ # A list of cascading if-else conditions.
+                        { # Each case has a Boolean condition. When it is evaluated to be True, the corresponding messages will be selected and evaluated recursively.
+                          "caseContent": [ # A list of case content.
+                            { # The list of messages or conditional cases to activate for this case.
+                              "additionalCases": # Object with schema name: GoogleCloudDialogflowCxV3beta1FulfillmentConditionalCases # Additional cases to be evaluated.
+                              "message": { # 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. # Returned message.
                                 "channel": "A String", # The channel which the response is associated with. Clients can specify the channel via QueryParameters.channel, and only associated channel response will be returned.
                                 "conversationSuccess": { # 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. # Indicates that the conversation succeeded.
                                   "metadata": { # Custom metadata. Dialogflow doesn't impose any structure on this.
@@ -5596,190 +4488,4371 @@ 

Method Details

"A String", ], }, - }, - ], - "returnPartialResponses": True or False, # Whether Dialogflow should return currently queued fulfillment response messages in streaming APIs. If a webhook is specified, it happens before Dialogflow invokes webhook. Warning: 1) This flag only affects streaming API. Responses are still queued and returned once in non-streaming API. 2) The flag can be enabled in any fulfillment but only the first 3 partial responses will be returned. You may only want to apply it to fulfillments that have slow webhooks. - "setParameterActions": [ # Set parameter values before executing the webhook. - { # Setting a parameter value. - "parameter": "A String", # Display name of the parameter. - "value": "", # The new value of the parameter. A null value clears the parameter. - }, - ], - "tag": "A String", # The value of this field will be populated in the WebhookRequest `fulfillmentInfo.tag` field by Dialogflow when the associated webhook is called. The tag is typically used by the webhook service to identify which fulfillment is being called, but it could be used for other purposes. This field is required if `webhook` is specified. - "webhook": "A String", # The webhook to call. Format: `projects//locations//agents//webhooks/`. - }, - "repromptEventHandlers": [ # The handlers for parameter-level events, used to provide reprompt for the parameter or transition to a different page/flow. The supported events are: * `sys.no-match-`, where N can be from 1 to 6 * `sys.no-match-default` * `sys.no-input-`, where N can be from 1 to 6 * `sys.no-input-default` * `sys.invalid-parameter` `initial_prompt_fulfillment` provides the first prompt for the parameter. If the user's response does not fill the parameter, a no-match/no-input event will be triggered, and the fulfillment associated with the `sys.no-match-1`/`sys.no-input-1` handler (if defined) will be called to provide a prompt. The `sys.no-match-2`/`sys.no-input-2` handler (if defined) will respond to the next no-match/no-input event, and so on. A `sys.no-match-default` or `sys.no-input-default` handler will be used to handle all following no-match/no-input events after all numbered no-match/no-input handlers for the parameter are consumed. A `sys.invalid-parameter` handler can be defined to handle the case where the parameter values have been `invalidated` by webhook. For example, if the user's response fill the parameter, however the parameter was invalidated by webhook, the fulfillment associated with the `sys.invalid-parameter` handler (if defined) will be called to provide a prompt. If the event handler for the corresponding event can't be found on the parameter, `initial_prompt_fulfillment` will be re-prompted. - { # An event handler specifies an event that can be handled during a session. When the specified event happens, the following actions are taken in order: * If there is a `trigger_fulfillment` associated with the event, it will be called. * If there is a `target_page` associated with the event, the session will transition into the specified page. * If there is a `target_flow` associated with the event, the session will transition into the specified flow. - "event": "A String", # Required. The name of the event to handle. - "name": "A String", # Output only. The unique identifier of this event handler. - "targetFlow": "A String", # The target flow to transition to. Format: `projects//locations//agents//flows/`. - "targetPage": "A String", # The target page to transition to. Format: `projects//locations//agents//flows//pages/`. - "triggerFulfillment": { # A fulfillment can do one or more of the following actions at the same time: * Generate rich message responses. * Set parameter values. * Call the webhook. Fulfillments can be called at various stages in the Page or Form lifecycle. For example, when a DetectIntentRequest drives a session to enter a new page, the page's entry fulfillment can add a static response to the QueryResult in the returning DetectIntentResponse, call the webhook (for example, to load user data from a database), or both. # The fulfillment to call when the event occurs. Handling webhook errors with a fulfillment enabled with webhook could cause infinite loop. It is invalid to specify such fulfillment for a handler handling webhooks. - "advancedSettings": { # Hierarchical advanced settings for agent/flow/page/fulfillment/parameter. Settings exposed at lower level overrides the settings exposed at higher level. Overriding occurs at the sub-setting level. For example, the playback_interruption_settings at fulfillment level only overrides the playback_interruption_settings at the agent level, leaving other settings at the agent level unchanged. DTMF settings does not override each other. DTMF settings set at different levels define DTMF detections running in parallel. Hierarchy: Agent->Flow->Page->Fulfillment/Parameter. # Hierarchical advanced settings for this fulfillment. The settings exposed at the lower level overrides the settings exposed at the higher level. - "audioExportGcsDestination": { # Google Cloud Storage location for a Dialogflow operation that writes or exports objects (e.g. exported agent or transcripts) outside of Dialogflow. # If present, incoming audio is exported by Dialogflow to the configured Google Cloud Storage destination. Exposed at the following levels: - Agent level - Flow level - "uri": "A String", # Required. The Google Cloud Storage URI for the exported objects. A URI is of the form: `gs://bucket/object-name-or-prefix` Whether a full object name, or just a prefix, its usage depends on the Dialogflow operation. - }, - "dtmfSettings": { # Define behaviors for DTMF (dual tone multi frequency). # Settings for DTMF. Exposed at the following levels: - Agent level - Flow level - Page level - Parameter level. - "enabled": True or False, # If true, incoming audio is processed for DTMF (dual tone multi frequency) events. For example, if the caller presses a button on their telephone keypad and DTMF processing is enabled, Dialogflow will detect the event (e.g. a "3" was pressed) in the incoming audio and pass the event to the bot to drive business logic (e.g. when 3 is pressed, return the account balance). - "endpointingTimeoutDuration": "A String", # Endpoint timeout setting for matching dtmf input to regex. - "finishDigit": "A String", # The digit that terminates a DTMF digit sequence. - "interdigitTimeoutDuration": "A String", # Interdigit timeout setting for matching dtmf input to regex. - "maxDigits": 42, # Max length of DTMF digits. - }, - "loggingSettings": { # Define behaviors on logging. # Settings for logging. Settings for Dialogflow History, Contact Center messages, StackDriver logs, and speech logging. Exposed at the following levels: - Agent level. - "enableInteractionLogging": True or False, # If true, DF Interaction logging is currently enabled. - "enableStackdriverLogging": True or False, # If true, StackDriver logging is currently enabled. - }, - "speechSettings": { # Define behaviors of speech to text detection. # Settings for speech to text detection. Exposed at the following levels: - Agent level - Flow level - Page level - Parameter level - "endpointerSensitivity": 42, # Sensitivity of the speech model that detects the end of speech. Scale from 0 to 100. - "models": { # Mapping from language to Speech-to-Text model. The mapped Speech-to-Text model will be selected for requests from its corresponding language. For more information, see [Speech models](https://cloud.google.com/dialogflow/cx/docs/concept/speech-models). - "a_key": "A String", - }, - "noSpeechTimeout": "A String", # Timeout before detecting no speech. - "useTimeoutBasedEndpointing": True or False, # Use timeout based endpointing, interpreting endpointer sensitivy as seconds of timeout value. + "toolCall": { # Represents a call of a specific tool's action with the specified inputs. # Returns the definition of a tool call that should be executed by the client. + "action": "A String", # Required. The name of the tool's action associated with this call. + "inputParameters": { # Optional. The action's input parameters. + "a_key": "", # Properties of the object. }, + "tool": "A String", # Required. The tool associated with this call. Format: `projects//locations//agents//tools/`. }, - "conditionalCases": [ # Conditional cases for this fulfillment. - { # A list of cascading if-else conditions. Cases are mutually exclusive. The first one with a matching condition is selected, all the rest ignored. - "cases": [ # A list of cascading if-else conditions. - { # Each case has a Boolean condition. When it is evaluated to be True, the corresponding messages will be selected and evaluated recursively. - "caseContent": [ # A list of case content. - { # The list of messages or conditional cases to activate for this case. - "additionalCases": # Object with schema name: GoogleCloudDialogflowCxV3beta1FulfillmentConditionalCases # Additional cases to be evaluated. - "message": { # 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. # Returned message. - "channel": "A String", # The channel which the response is associated with. Clients can specify the channel via QueryParameters.channel, and only associated channel response will be returned. - "conversationSuccess": { # 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. # Indicates that the conversation succeeded. - "metadata": { # Custom metadata. Dialogflow doesn't impose any structure on this. - "a_key": "", # Properties of the object. - }, - }, - "endInteraction": { # 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. # Output only. A signal that indicates the interaction with the Dialogflow agent has ended. This message is generated by Dialogflow only when the conversation reaches `END_SESSION` page. It is not supposed to be defined by the user. It's guaranteed that there is at most one such message in each response. - }, - "knowledgeInfoCard": { # Represents info card response. If the response contains generative knowledge prediction, Dialogflow will return a payload with Infobot Messenger compatible info card. Otherwise, the info card response is skipped. # Represents info card for knowledge answers, to be better rendered in Dialogflow Messenger. - }, - "liveAgentHandoff": { # 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. # Hands off conversation to a human agent. - "metadata": { # Custom metadata for your handoff procedure. Dialogflow doesn't impose any structure on this. - "a_key": "", # Properties of the object. - }, - }, - "mixedAudio": { # 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. # Output only. An audio response message composed of both the synthesized Dialogflow agent responses and responses defined via play_audio. This message is generated by Dialogflow only and not supposed to be defined by the user. - "segments": [ # Segments this audio response is composed of. - { # Represents one segment of audio. - "allowPlaybackInterruption": True or False, # 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. - "audio": "A String", # Raw audio synthesized from the Dialogflow agent's response using the output config specified in the request. - "uri": "A String", # Client-specific URI that points to an audio clip accessible to the client. Dialogflow does not impose any validation on it. - }, - ], - }, - "outputAudioText": { # A text or ssml response that is preferentially used for TTS output audio synthesis, as described in the comment on the ResponseMessage message. # A text or ssml response that is preferentially used for TTS output audio synthesis, as described in the comment on the ResponseMessage message. - "allowPlaybackInterruption": True or False, # 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. - "ssml": "A String", # The SSML text to be synthesized. For more information, see [SSML](/speech/text-to-speech/docs/ssml). - "text": "A String", # The raw text to be synthesized. - }, - "payload": { # Returns a response containing a custom, platform-specific payload. - "a_key": "", # Properties of the object. - }, - "playAudio": { # Specifies an audio clip to be played by the client as part of the response. # Signal that the client should play an audio clip hosted at a client-specific URI. Dialogflow uses this to construct mixed_audio. However, Dialogflow itself does not try to read or process the URI in any way. - "allowPlaybackInterruption": True or False, # 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. - "audioUri": "A String", # Required. URI of the audio clip. Dialogflow does not impose any validation on this value. It is specific to the client that reads it. - }, - "telephonyTransferCall": { # Represents the signal that telles the client to transfer the phone call connected to the agent to a third-party endpoint. # A signal that the client should transfer the phone call connected to this agent to a third-party endpoint. - "phoneNumber": "A String", # Transfer the call to a phone number in [E.164 format](https://en.wikipedia.org/wiki/E.164). - }, - "text": { # The text response message. # Returns a text response. - "allowPlaybackInterruption": True or False, # 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. - "text": [ # Required. A collection of text responses. - "A String", - ], - }, - }, - }, - ], - "condition": "A String", # The condition to activate and select this case. Empty means the condition is always true. The condition is evaluated against form parameters or session parameters. See the [conditions reference](https://cloud.google.com/dialogflow/cx/docs/reference/condition). - }, - ], - }, - ], - "enableGenerativeFallback": True or False, # If the flag is true, the agent will utilize LLM to generate a text response. If LLM generation fails, the defined responses in the fulfillment will be respected. This flag is only useful for fulfillments associated with no-match event handlers. - "messages": [ # The list of rich message responses to present to the user. - { # 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. - "channel": "A String", # The channel which the response is associated with. Clients can specify the channel via QueryParameters.channel, and only associated channel response will be returned. - "conversationSuccess": { # 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. # Indicates that the conversation succeeded. - "metadata": { # Custom metadata. Dialogflow doesn't impose any structure on this. - "a_key": "", # Properties of the object. - }, - }, - "endInteraction": { # 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. # Output only. A signal that indicates the interaction with the Dialogflow agent has ended. This message is generated by Dialogflow only when the conversation reaches `END_SESSION` page. It is not supposed to be defined by the user. It's guaranteed that there is at most one such message in each response. - }, - "knowledgeInfoCard": { # Represents info card response. If the response contains generative knowledge prediction, Dialogflow will return a payload with Infobot Messenger compatible info card. Otherwise, the info card response is skipped. # Represents info card for knowledge answers, to be better rendered in Dialogflow Messenger. - }, - "liveAgentHandoff": { # 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. # Hands off conversation to a human agent. - "metadata": { # Custom metadata for your handoff procedure. Dialogflow doesn't impose any structure on this. - "a_key": "", # Properties of the object. - }, - }, - "mixedAudio": { # 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. # Output only. An audio response message composed of both the synthesized Dialogflow agent responses and responses defined via play_audio. This message is generated by Dialogflow only and not supposed to be defined by the user. - "segments": [ # Segments this audio response is composed of. - { # Represents one segment of audio. - "allowPlaybackInterruption": True or False, # 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. - "audio": "A String", # Raw audio synthesized from the Dialogflow agent's response using the output config specified in the request. - "uri": "A String", # Client-specific URI that points to an audio clip accessible to the client. Dialogflow does not impose any validation on it. - }, - ], - }, - "outputAudioText": { # A text or ssml response that is preferentially used for TTS output audio synthesis, as described in the comment on the ResponseMessage message. # A text or ssml response that is preferentially used for TTS output audio synthesis, as described in the comment on the ResponseMessage message. - "allowPlaybackInterruption": True or False, # 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. - "ssml": "A String", # The SSML text to be synthesized. For more information, see [SSML](/speech/text-to-speech/docs/ssml). - "text": "A String", # The raw text to be synthesized. - }, - "payload": { # Returns a response containing a custom, platform-specific payload. - "a_key": "", # Properties of the object. - }, - "playAudio": { # Specifies an audio clip to be played by the client as part of the response. # Signal that the client should play an audio clip hosted at a client-specific URI. Dialogflow uses this to construct mixed_audio. However, Dialogflow itself does not try to read or process the URI in any way. - "allowPlaybackInterruption": True or False, # 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. - "audioUri": "A String", # Required. URI of the audio clip. Dialogflow does not impose any validation on this value. It is specific to the client that reads it. - }, - "telephonyTransferCall": { # Represents the signal that telles the client to transfer the phone call connected to the agent to a third-party endpoint. # A signal that the client should transfer the phone call connected to this agent to a third-party endpoint. - "phoneNumber": "A String", # Transfer the call to a phone number in [E.164 format](https://en.wikipedia.org/wiki/E.164). - }, - "text": { # The text response message. # Returns a text response. - "allowPlaybackInterruption": True or False, # 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. - "text": [ # Required. A collection of text responses. - "A String", - ], - }, - }, - ], - "returnPartialResponses": True or False, # Whether Dialogflow should return currently queued fulfillment response messages in streaming APIs. If a webhook is specified, it happens before Dialogflow invokes webhook. Warning: 1) This flag only affects streaming API. Responses are still queued and returned once in non-streaming API. 2) The flag can be enabled in any fulfillment but only the first 3 partial responses will be returned. You may only want to apply it to fulfillments that have slow webhooks. - "setParameterActions": [ # Set parameter values before executing the webhook. - { # Setting a parameter value. - "parameter": "A String", # Display name of the parameter. - "value": "", # The new value of the parameter. A null value clears the parameter. - }, - ], - "tag": "A String", # The value of this field will be populated in the WebhookRequest `fulfillmentInfo.tag` field by Dialogflow when the associated webhook is called. The tag is typically used by the webhook service to identify which fulfillment is being called, but it could be used for other purposes. This field is required if `webhook` is specified. - "webhook": "A String", # The webhook to call. Format: `projects//locations//agents//webhooks/`. }, }, ], + "condition": "A String", # The condition to activate and select this case. Empty means the condition is always true. The condition is evaluated against form parameters or session parameters. See the [conditions reference](https://cloud.google.com/dialogflow/cx/docs/reference/condition). + }, + ], + }, + ], + "enableGenerativeFallback": True or False, # If the flag is true, the agent will utilize LLM to generate a text response. If LLM generation fails, the defined responses in the fulfillment will be respected. This flag is only useful for fulfillments associated with no-match event handlers. + "messages": [ # The list of rich message responses to present to the user. + { # 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. + "channel": "A String", # The channel which the response is associated with. Clients can specify the channel via QueryParameters.channel, and only associated channel response will be returned. + "conversationSuccess": { # 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. # Indicates that the conversation succeeded. + "metadata": { # Custom metadata. Dialogflow doesn't impose any structure on this. + "a_key": "", # Properties of the object. }, - "isList": True or False, # Indicates whether the parameter represents a list of values. - "redact": True or False, # Indicates whether the parameter content should be redacted in log. If redaction is enabled, the parameter content will be replaced by parameter name during logging. Note: the parameter content is subject to redaction if either parameter level redaction or entity type level redaction is enabled. - "required": True or False, # 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. }, - ], + "endInteraction": { # 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. # Output only. A signal that indicates the interaction with the Dialogflow agent has ended. This message is generated by Dialogflow only when the conversation reaches `END_SESSION` page. It is not supposed to be defined by the user. It's guaranteed that there is at most one such message in each response. + }, + "knowledgeInfoCard": { # Represents info card response. If the response contains generative knowledge prediction, Dialogflow will return a payload with Infobot Messenger compatible info card. Otherwise, the info card response is skipped. # Represents info card for knowledge answers, to be better rendered in Dialogflow Messenger. + }, + "liveAgentHandoff": { # 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. # Hands off conversation to a human agent. + "metadata": { # Custom metadata for your handoff procedure. Dialogflow doesn't impose any structure on this. + "a_key": "", # Properties of the object. + }, + }, + "mixedAudio": { # 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. # Output only. An audio response message composed of both the synthesized Dialogflow agent responses and responses defined via play_audio. This message is generated by Dialogflow only and not supposed to be defined by the user. + "segments": [ # Segments this audio response is composed of. + { # Represents one segment of audio. + "allowPlaybackInterruption": True or False, # 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. + "audio": "A String", # Raw audio synthesized from the Dialogflow agent's response using the output config specified in the request. + "uri": "A String", # Client-specific URI that points to an audio clip accessible to the client. Dialogflow does not impose any validation on it. + }, + ], + }, + "outputAudioText": { # A text or ssml response that is preferentially used for TTS output audio synthesis, as described in the comment on the ResponseMessage message. # A text or ssml response that is preferentially used for TTS output audio synthesis, as described in the comment on the ResponseMessage message. + "allowPlaybackInterruption": True or False, # 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. + "ssml": "A String", # The SSML text to be synthesized. For more information, see [SSML](/speech/text-to-speech/docs/ssml). + "text": "A String", # The raw text to be synthesized. + }, + "payload": { # Returns a response containing a custom, platform-specific payload. + "a_key": "", # Properties of the object. + }, + "playAudio": { # Specifies an audio clip to be played by the client as part of the response. # Signal that the client should play an audio clip hosted at a client-specific URI. Dialogflow uses this to construct mixed_audio. However, Dialogflow itself does not try to read or process the URI in any way. + "allowPlaybackInterruption": True or False, # 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. + "audioUri": "A String", # Required. URI of the audio clip. Dialogflow does not impose any validation on this value. It is specific to the client that reads it. + }, + "telephonyTransferCall": { # Represents the signal that telles the client to transfer the phone call connected to the agent to a third-party endpoint. # A signal that the client should transfer the phone call connected to this agent to a third-party endpoint. + "phoneNumber": "A String", # Transfer the call to a phone number in [E.164 format](https://en.wikipedia.org/wiki/E.164). + }, + "text": { # The text response message. # Returns a text response. + "allowPlaybackInterruption": True or False, # 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. + "text": [ # Required. A collection of text responses. + "A String", + ], + }, + "toolCall": { # Represents a call of a specific tool's action with the specified inputs. # Returns the definition of a tool call that should be executed by the client. + "action": "A String", # Required. The name of the tool's action associated with this call. + "inputParameters": { # Optional. The action's input parameters. + "a_key": "", # Properties of the object. + }, + "tool": "A String", # Required. The tool associated with this call. Format: `projects//locations//agents//tools/`. + }, + }, + ], + "returnPartialResponses": True or False, # Whether Dialogflow should return currently queued fulfillment response messages in streaming APIs. If a webhook is specified, it happens before Dialogflow invokes webhook. Warning: 1) This flag only affects streaming API. Responses are still queued and returned once in non-streaming API. 2) The flag can be enabled in any fulfillment but only the first 3 partial responses will be returned. You may only want to apply it to fulfillments that have slow webhooks. + "setParameterActions": [ # Set parameter values before executing the webhook. + { # Setting a parameter value. + "parameter": "A String", # Display name of the parameter. + "value": "", # The new value of the parameter. A null value clears the parameter. + }, + ], + "tag": "A String", # The value of this field will be populated in the WebhookRequest `fulfillmentInfo.tag` field by Dialogflow when the associated webhook is called. The tag is typically used by the webhook service to identify which fulfillment is being called, but it could be used for other purposes. This field is required if `webhook` is specified. + "webhook": "A String", # The webhook to call. Format: `projects//locations//agents//webhooks/`. + }, + }, + ], + }, + "dataStoreConnectionSignals": { # Data store connection feature output signals. Might be only partially field if processing stop before the final answer. Reasons for this can be, but are not limited to: empty UCS search results, positive RAI check outcome, grounding failure, ... # Optional. Data store connection feature output signals. Filled only when data stores are involved in serving the query and DetectIntentRequest.populate data_store_connection_quality_signals is set to true in the request. + "answer": "A String", # Optional. The final compiled answer. + "answerGenerationModelCallSignals": { # Diagnostic info related to the answer generation model call. # Optional. Diagnostic info related to the answer generation model call. + "modelOutput": "A String", # Output of the generative model. + "renderedPrompt": "A String", # Prompt as sent to the model. + }, + "answerParts": [ # Optional. Answer parts with relevant citations. Concatenation of texts should add up the `answer` (not counting whitespaces). + { # Answer part with citation. + "supportingIndices": [ # Citations for this answer part. Indices of `search_snippets`. + 42, + ], + "text": "A String", # Substring of the answer. + }, + ], + "citedSnippets": [ # Optional. Snippets cited by the answer generation model from the most to least relevant. + { # Snippet cited by the answer generation model. + "searchSnippet": { # Search snippet details. # Details of the snippet. + "documentTitle": "A String", # Title of the enclosing document. + "documentUri": "A String", # Uri for the document. Present if specified for the document. + "text": "A String", # Text included in the prompt. + }, + "snippetIndex": 42, # Index of the snippet in `search_snippets` field. + }, + ], + "groundingSignals": { # Grounding signals. # Optional. Grounding signals. + "decision": "A String", # Represents the decision of the grounding check. + "score": "A String", # Grounding score bucket setting. + }, + "rewriterModelCallSignals": { # Diagnostic info related to the rewriter model call. # Optional. Diagnostic info related to the rewriter model call. + "modelOutput": "A String", # Output of the generative model. + "renderedPrompt": "A String", # Prompt as sent to the model. + }, + "rewrittenQuery": "A String", # Optional. Rewritten string query used for search. + "safetySignals": { # Safety check results. # Optional. Safety check result. + "bannedPhraseMatch": "A String", # Specifies banned phrase match subject. + "decision": "A String", # Safety decision. + "matchedBannedPhrase": "A String", # The matched banned phrase if there was a match. + }, + "searchSnippets": [ # Optional. Search snippets included in the answer generation prompt. + { # Search snippet details. + "documentTitle": "A String", # Title of the enclosing document. + "documentUri": "A String", # Uri for the document. Present if specified for the document. + "text": "A String", # Text included in the prompt. + }, + ], + }, + "diagnosticInfo": { # The free-form diagnostic info. For example, this field could contain webhook call latency. The fields of this data can change without notice, so you should not write code that depends on its structure. One of the fields is called "Alternative Matched Intents", which may aid with debugging. The following describes these intent results: - The list is empty if no intent was matched to end-user input. - Only intents that are referenced in the currently active flow are included. - The matched intent is included. - Other intents that could have matched end-user input, but did not match because they are referenced by intent routes that are out of [scope](https://cloud.google.com/dialogflow/cx/docs/concept/handler#scope), are included. - Other intents referenced by intent routes in scope that matched end-user input, but had a lower confidence score. + "a_key": "", # Properties of the object. + }, + "dtmf": { # Represents the input for dtmf event. # If a DTMF was provided as input, this field will contain a copy of the DtmfInput. + "digits": "A String", # The dtmf digits. + "finishDigit": "A String", # The finish digit (if any). + }, + "generativeInfo": { # Represents the information of a query if handled by generative agent resources. # The information of a query if handled by generative agent resources. + "actionTracingInfo": { # Example represents a sample execution of the playbook in the conversation. An example consists of a list of ordered actions performed by end user or Dialogflow agent according the playbook instructions to fulfill the task. # The actions performed by the generative playbook for the current agent response. + "actions": [ # Required. The ordered list of actions performed by the end user and the Dialogflow agent. + { # Action performed by end user or Dialogflow agent in the conversation. + "agentUtterance": { # AgentUtterance represents one message sent by the agent. # Optional. Action performed by the agent as a message. + "text": "A String", # Required. Message content in text. + }, + "flowInvocation": { # Stores metadata of the invocation of a CX flow. Next Id: 7 # Optional. Action performed on behalf of the agent by invoking a CX flow. + "flow": "A String", # Required. The unique identifier of the flow. Format: `projects//locations//agents/`. + "flowState": "A String", # Required. Flow invocation's output state. + "inputActionParameters": { # Optional. A list of input parameters for the flow. + "a_key": "", # Properties of the object. + }, + "outputActionParameters": { # Optional. A list of output parameters generated by the flow invocation. + "a_key": "", # Properties of the object. + }, + }, + "playbookInvocation": { # Stores metadata of the invocation of a child playbook. Next Id: 5 # Optional. Action performed on behalf of the agent by invoking a child playbook. + "playbook": "A String", # Required. The unique identifier of the playbook. Format: `projects//locations//agents//playbooks/`. + "playbookInput": { # Input of the playbook. # Optional. Input of the child playbook invocation. + "actionParameters": { # Optional. A list of input parameters for the action. + "a_key": "", # Properties of the object. + }, + "precedingConversationSummary": "A String", # Optional. Summary string of the preceding conversation for the child playbook invocation. + }, + "playbookOutput": { # Output of the playbook. # Optional. Output of the child playbook invocation. + "actionParameters": { # Optional. A Struct object of output parameters for the action. + "a_key": "", # Properties of the object. + }, + "executionSummary": "A String", # Optional. Summary string of the execution result of the child playbook. + }, + "playbookState": "A String", # Required. Playbook invocation's output state. + }, + "toolUse": { # Stores metadata of the invocation of an action supported by a tool. # Optional. Action performed on behalf of the agent by calling a plugin tool. + "action": "A String", # Optional. Name of the action to be called during the tool use. + "inputActionParameters": { # Optional. A list of input parameters for the action. + "a_key": "", # Properties of the object. + }, + "outputActionParameters": { # Optional. A list of output parameters generated by the action. + "a_key": "", # Properties of the object. + }, + "tool": "A String", # Required. The tool that should be used. Format: `projects//locations//agents//tools/`. + }, + "userUtterance": { # UserUtterance represents one message sent by the customer. # Optional. Agent obtained a message from the customer. + "text": "A String", # Required. Message content in text. + }, + }, + ], + "conversationState": "A String", # Required. Example's output state. + "createTime": "A String", # Output only. The timestamp of initial example creation. + "description": "A String", # Optional. The high level concise description of the example. The max number of characters is 200. + "displayName": "A String", # Required. The display name of the example. + "languageCode": "A String", # Optional. The language code of the example. If not specified, the agent's default language is used. Note: languages must be enabled in the agent before they can be used. + "name": "A String", # The unique identifier of the playbook example. Format: `projects//locations//agents//playbooks//examples/`. + "playbookInput": { # Input of the playbook. # Optional. The input to the playbook in the example. + "actionParameters": { # Optional. A list of input parameters for the action. + "a_key": "", # Properties of the object. + }, + "precedingConversationSummary": "A String", # Optional. Summary string of the preceding conversation for the child playbook invocation. + }, + "playbookOutput": { # Output of the playbook. # Optional. The output of the playbook in the example. + "actionParameters": { # Optional. A Struct object of output parameters for the action. + "a_key": "", # Properties of the object. + }, + "executionSummary": "A String", # Optional. Summary string of the execution result of the child playbook. + }, + "tokenCount": "A String", # Output only. Estimated number of tokes current example takes when sent to the LLM. + "updateTime": "A String", # Output only. Last time the example was updated. + }, + "currentPlaybooks": [ # The stack of playbooks that the conversation has currently entered, with the most recent one on the top. + "A String", + ], + }, + "intent": { # An intent represents a user's intent to interact with a conversational agent. You can provide information for the Dialogflow API to use to match user input to an intent by adding training phrases (i.e., examples of user input) to your intent. # The Intent that matched the conversational query. Some, not all fields are filled in this message, including but not limited to: `name` and `display_name`. This field is deprecated, please use QueryResult.match instead. + "description": "A String", # Human readable description for better understanding an intent like its scope, content, result etc. Maximum character limit: 140 characters. + "displayName": "A String", # Required. The human-readable name of the intent, unique within the agent. + "isFallback": True or False, # Indicates whether this is a fallback intent. Currently only default fallback intent is allowed in the agent, which is added upon agent creation. Adding training phrases to fallback intent is useful in the case of requests that are mistakenly matched, since training phrases assigned to fallback intents act as negative examples that triggers no-match event. + "labels": { # The key/value metadata to label an intent. Labels can contain lowercase letters, digits and the symbols '-' and '_'. International characters are allowed, including letters from unicase alphabets. Keys must start with a letter. Keys and values can be no longer than 63 characters and no more than 128 bytes. Prefix "sys-" is reserved for Dialogflow defined labels. Currently allowed Dialogflow defined labels include: * sys-head * sys-contextual The above labels do not require value. "sys-head" means the intent is a head intent. "sys-contextual" means the intent is a contextual intent. + "a_key": "A String", + }, + "name": "A String", # The unique identifier of the intent. Required for the Intents.UpdateIntent method. Intents.CreateIntent populates the name automatically. Format: `projects//locations//agents//intents/`. + "parameters": [ # The collection of parameters associated with the intent. + { # Represents an intent parameter. + "entityType": "A String", # Required. The entity type of the parameter. Format: `projects/-/locations/-/agents/-/entityTypes/` for system entity types (for example, `projects/-/locations/-/agents/-/entityTypes/sys.date`), or `projects//locations//agents//entityTypes/` for developer entity types. + "id": "A String", # Required. The unique identifier of the parameter. This field is used by training phrases to annotate their parts. + "isList": True or False, # Indicates whether the parameter represents a list of values. + "redact": True or False, # Indicates whether the parameter content should be redacted in log. If redaction is enabled, the parameter content will be replaced by parameter name during logging. Note: the parameter content is subject to redaction if either parameter level redaction or entity type level redaction is enabled. + }, + ], + "priority": 42, # 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. + "trainingPhrases": [ # The collection of training phrases the agent is trained on to identify the intent. + { # Represents an example that the agent is trained on to identify the intent. + "id": "A String", # Output only. The unique identifier of the training phrase. + "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 `parameter_id` field is set. + { # Represents a part of a training phrase. + "parameterId": "A String", # The parameter used to annotate this part of the training phrase. This field is required for annotated parts of the training phrase. + "text": "A String", # Required. The text for this part. + }, + ], + "repeatCount": 42, # Indicates how many times this example was added to the intent. + }, + ], + }, + "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. This field is deprecated, please use QueryResult.match instead. + "languageCode": "A String", # The language that was triggered during intent detection. See [Language Support](https://cloud.google.com/dialogflow/cx/docs/reference/language) for a list of the currently supported language codes. + "match": { # Represents one match result of MatchIntent. # Intent match result, could be an intent or an event. + "confidence": 3.14, # The confidence of this match. 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. + "event": "A String", # The event that matched the query. Filled for `EVENT`, `NO_MATCH` and `NO_INPUT` match types. + "intent": { # An intent represents a user's intent to interact with a conversational agent. You can provide information for the Dialogflow API to use to match user input to an intent by adding training phrases (i.e., examples of user input) to your intent. # The Intent that matched the query. Some, not all fields are filled in this message, including but not limited to: `name` and `display_name`. Only filled for `INTENT` match type. + "description": "A String", # Human readable description for better understanding an intent like its scope, content, result etc. Maximum character limit: 140 characters. + "displayName": "A String", # Required. The human-readable name of the intent, unique within the agent. + "isFallback": True or False, # Indicates whether this is a fallback intent. Currently only default fallback intent is allowed in the agent, which is added upon agent creation. Adding training phrases to fallback intent is useful in the case of requests that are mistakenly matched, since training phrases assigned to fallback intents act as negative examples that triggers no-match event. + "labels": { # The key/value metadata to label an intent. Labels can contain lowercase letters, digits and the symbols '-' and '_'. International characters are allowed, including letters from unicase alphabets. Keys must start with a letter. Keys and values can be no longer than 63 characters and no more than 128 bytes. Prefix "sys-" is reserved for Dialogflow defined labels. Currently allowed Dialogflow defined labels include: * sys-head * sys-contextual The above labels do not require value. "sys-head" means the intent is a head intent. "sys-contextual" means the intent is a contextual intent. + "a_key": "A String", + }, + "name": "A String", # The unique identifier of the intent. Required for the Intents.UpdateIntent method. Intents.CreateIntent populates the name automatically. Format: `projects//locations//agents//intents/`. + "parameters": [ # The collection of parameters associated with the intent. + { # Represents an intent parameter. + "entityType": "A String", # Required. The entity type of the parameter. Format: `projects/-/locations/-/agents/-/entityTypes/` for system entity types (for example, `projects/-/locations/-/agents/-/entityTypes/sys.date`), or `projects//locations//agents//entityTypes/` for developer entity types. + "id": "A String", # Required. The unique identifier of the parameter. This field is used by training phrases to annotate their parts. + "isList": True or False, # Indicates whether the parameter represents a list of values. + "redact": True or False, # Indicates whether the parameter content should be redacted in log. If redaction is enabled, the parameter content will be replaced by parameter name during logging. Note: the parameter content is subject to redaction if either parameter level redaction or entity type level redaction is enabled. + }, + ], + "priority": 42, # 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. + "trainingPhrases": [ # The collection of training phrases the agent is trained on to identify the intent. + { # Represents an example that the agent is trained on to identify the intent. + "id": "A String", # Output only. The unique identifier of the training phrase. + "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 `parameter_id` field is set. + { # Represents a part of a training phrase. + "parameterId": "A String", # The parameter used to annotate this part of the training phrase. This field is required for annotated parts of the training phrase. + "text": "A String", # Required. The text for this part. + }, + ], + "repeatCount": 42, # Indicates how many times this example was added to the intent. + }, + ], + }, + "matchType": "A String", # Type of this Match. + "parameters": { # The collection of parameters extracted from the query. 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 then use map, otherwise, depending on the parameter value type, it could be one of string, number, boolean, null, list or map. * MapValue value: If parameter's entity type is a composite entity then use map from composite entity property names to property values, otherwise, use parameter value. + "a_key": "", # Properties of the object. + }, + "resolvedInput": "A String", # Final text input which was matched during MatchIntent. This value can be different from original input sent in request because of spelling correction or other processing. + }, + "parameters": { # The collected session 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 then use map, otherwise, depending on the parameter value type, it could be one of string, number, boolean, null, list or map. * MapValue value: If parameter's entity type is a composite entity then use map from composite entity property names to property values, otherwise, use parameter value. + "a_key": "", # Properties of the object. + }, + "responseMessages": [ # The list of rich messages returned to the client. Responses vary from simple text messages to more sophisticated, structured payloads used to drive complex logic. + { # 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. + "channel": "A String", # The channel which the response is associated with. Clients can specify the channel via QueryParameters.channel, and only associated channel response will be returned. + "conversationSuccess": { # 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. # Indicates that the conversation succeeded. + "metadata": { # Custom metadata. Dialogflow doesn't impose any structure on this. + "a_key": "", # Properties of the object. + }, + }, + "endInteraction": { # 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. # Output only. A signal that indicates the interaction with the Dialogflow agent has ended. This message is generated by Dialogflow only when the conversation reaches `END_SESSION` page. It is not supposed to be defined by the user. It's guaranteed that there is at most one such message in each response. + }, + "knowledgeInfoCard": { # Represents info card response. If the response contains generative knowledge prediction, Dialogflow will return a payload with Infobot Messenger compatible info card. Otherwise, the info card response is skipped. # Represents info card for knowledge answers, to be better rendered in Dialogflow Messenger. + }, + "liveAgentHandoff": { # 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. # Hands off conversation to a human agent. + "metadata": { # Custom metadata for your handoff procedure. Dialogflow doesn't impose any structure on this. + "a_key": "", # Properties of the object. + }, + }, + "mixedAudio": { # 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. # Output only. An audio response message composed of both the synthesized Dialogflow agent responses and responses defined via play_audio. This message is generated by Dialogflow only and not supposed to be defined by the user. + "segments": [ # Segments this audio response is composed of. + { # Represents one segment of audio. + "allowPlaybackInterruption": True or False, # 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. + "audio": "A String", # Raw audio synthesized from the Dialogflow agent's response using the output config specified in the request. + "uri": "A String", # Client-specific URI that points to an audio clip accessible to the client. Dialogflow does not impose any validation on it. + }, + ], + }, + "outputAudioText": { # A text or ssml response that is preferentially used for TTS output audio synthesis, as described in the comment on the ResponseMessage message. # A text or ssml response that is preferentially used for TTS output audio synthesis, as described in the comment on the ResponseMessage message. + "allowPlaybackInterruption": True or False, # 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. + "ssml": "A String", # The SSML text to be synthesized. For more information, see [SSML](/speech/text-to-speech/docs/ssml). + "text": "A String", # The raw text to be synthesized. + }, + "payload": { # Returns a response containing a custom, platform-specific payload. + "a_key": "", # Properties of the object. + }, + "playAudio": { # Specifies an audio clip to be played by the client as part of the response. # Signal that the client should play an audio clip hosted at a client-specific URI. Dialogflow uses this to construct mixed_audio. However, Dialogflow itself does not try to read or process the URI in any way. + "allowPlaybackInterruption": True or False, # 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. + "audioUri": "A String", # Required. URI of the audio clip. Dialogflow does not impose any validation on this value. It is specific to the client that reads it. + }, + "telephonyTransferCall": { # Represents the signal that telles the client to transfer the phone call connected to the agent to a third-party endpoint. # A signal that the client should transfer the phone call connected to this agent to a third-party endpoint. + "phoneNumber": "A String", # Transfer the call to a phone number in [E.164 format](https://en.wikipedia.org/wiki/E.164). + }, + "text": { # The text response message. # Returns a text response. + "allowPlaybackInterruption": True or False, # 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. + "text": [ # Required. A collection of text responses. + "A String", + ], + }, + "toolCall": { # Represents a call of a specific tool's action with the specified inputs. # Returns the definition of a tool call that should be executed by the client. + "action": "A String", # Required. The name of the tool's action associated with this call. + "inputParameters": { # Optional. The action's input parameters. + "a_key": "", # Properties of the object. + }, + "tool": "A String", # Required. The tool associated with this call. Format: `projects//locations//agents//tools/`. + }, + }, + ], + "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. # The sentiment analyss result, which depends on `analyze_query_text_sentiment`, specified in the request. + "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). + "score": 3.14, # Sentiment score between -1.0 (negative sentiment) and 1.0 (positive sentiment). + }, + "text": "A String", # If natural language text was provided as input, this field will contain a copy of the text. + "transcript": "A String", # If natural language speech audio was provided as input, this field will contain the transcript for the audio. + "triggerEvent": "A String", # If an event was provided as input, this field will contain the name of the event. + "triggerIntent": "A String", # If an intent was provided as input, this field will contain a copy of the intent identifier. Format: `projects//locations//agents//intents/`. + "webhookDisplayNames": [ # The list of webhook display names in the order of call sequence. + "A String", + ], + "webhookIds": [ # The list of webhook ids in the order of call sequence. + "A String", + ], + "webhookLatencies": [ # The list of webhook latencies in the order of call sequence. + "A String", + ], + "webhookPayloads": [ # The list of webhook payload in WebhookResponse.payload, in the order of call sequence. If some webhook call fails or doesn't return any payload, an empty `Struct` would be used instead. + { + "a_key": "", # Properties of the object. + }, + ], + "webhookStatuses": [ # The list of webhook call status in the order of call sequence. + { # 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). + "code": 42, # The status code, which should be an enum value of google.rpc.Code. + "details": [ # A list of messages that carry the error details. There is a common set of message types for APIs to use. + { + "a_key": "", # Properties of the object. Contains field @type with type URL. + }, + ], + "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. + }, + ], + "webhookTags": [ # The list of webhook tags in the order of call sequence. + "A String", + ], + }, + "responseId": "A String", # Output only. The unique identifier of the response. It can be used to locate a response in the training example set or for reporting issues. + "responseType": "A String", # Response type. + }, + "responseUtterances": "A String", # The output text or the transcript of the output audio in the responses. If multiple output messages are returned, they will be concatenated into one. + }, + ], + "languageCode": "A String", # The language of the conversation, which is the language of the first request in the conversation. + "metrics": { # Represents metrics for the conversation. # Conversation metrics. + "averageMatchConfidence": 3.14, # The average confidence all of the Match in the conversation. Values range from 0.0 (completely uncertain) to 1.0 (completely certain). + "hasEndInteraction": True or False, # A signal that indicates the interaction with the Dialogflow agent has ended. If any response has the ResponseMessage.end_interaction signal, this is set to true. + "hasLiveAgentHandoff": True or False, # Hands off conversation to a human agent. If any response has the ResponseMessage.live_agent_handoffsignal, this is set to true. + "inputAudioDuration": "A String", # Duration of all the input's audio in the conversation. + "interactionCount": 42, # The number of interactions in the conversation. + "matchTypeCount": { # Count by Match.MatchType of the matches in the conversation. # Match type counts. + "directIntentCount": 42, # The number of matches with type Match.MatchType.DIRECT_INTENT. + "eventCount": 42, # The number of matches with type Match.MatchType.EVENT. + "intentCount": 42, # The number of matches with type Match.MatchType.INTENT. + "noInputCount": 42, # The number of matches with type Match.MatchType.NO_INPUT. + "noMatchCount": 42, # The number of matches with type Match.MatchType.NO_MATCH. + "parameterFillingCount": 42, # The number of matches with type Match.MatchType.PARAMETER_FILLING. + "unspecifiedCount": 42, # The number of matches with type Match.MatchType.MATCH_TYPE_UNSPECIFIED. + }, + "maxWebhookLatency": "A String", # Maximum latency of the Webhook calls in the conversation. + "outputAudioDuration": "A String", # Duration of all the output's audio in the conversation. + "queryInputCount": { # Count by types of QueryInput of the requests in the conversation. # Query input counts. + "audioCount": 42, # The number of AudioInput in the conversation. + "dtmfCount": 42, # The number of DtmfInput in the conversation. + "eventCount": 42, # The number of EventInput in the conversation. + "intentCount": 42, # The number of IntentInput in the conversation. + "textCount": 42, # The number of TextInput in the conversation. + }, + }, + "name": "A String", # Identifier. The identifier of the conversation. If conversation ID is reused, interactions happened later than 48 hours of the conversation's create time will be ignored. Format: `projects//locations//agents//conversations/` + "pages": [ # All the Page the conversation has went through. Only `name` and `display_name` are filled in this message. + { # A Dialogflow CX conversation (session) can be described and visualized as a state machine. The states of a CX session are represented by pages. For each flow, you define many pages, where your combined pages can handle a complete conversation on the topics the flow is designed for. At any given moment, exactly one page is the current page, the current page is considered active, and the flow associated with that page is considered active. Every flow has a special start page. When a flow initially becomes active, the start page page becomes the current page. For each conversational turn, the current page will either stay the same or transition to another page. You configure each page to collect information from the end-user that is relevant for the conversational state represented by the page. For more information, see the [Page guide](https://cloud.google.com/dialogflow/cx/docs/concept/page). + "advancedSettings": { # Hierarchical advanced settings for agent/flow/page/fulfillment/parameter. Settings exposed at lower level overrides the settings exposed at higher level. Overriding occurs at the sub-setting level. For example, the playback_interruption_settings at fulfillment level only overrides the playback_interruption_settings at the agent level, leaving other settings at the agent level unchanged. DTMF settings does not override each other. DTMF settings set at different levels define DTMF detections running in parallel. Hierarchy: Agent->Flow->Page->Fulfillment/Parameter. # Hierarchical advanced settings for this page. The settings exposed at the lower level overrides the settings exposed at the higher level. + "audioExportGcsDestination": { # Google Cloud Storage location for a Dialogflow operation that writes or exports objects (e.g. exported agent or transcripts) outside of Dialogflow. # If present, incoming audio is exported by Dialogflow to the configured Google Cloud Storage destination. Exposed at the following levels: - Agent level - Flow level + "uri": "A String", # Required. The Google Cloud Storage URI for the exported objects. A URI is of the form: `gs://bucket/object-name-or-prefix` Whether a full object name, or just a prefix, its usage depends on the Dialogflow operation. + }, + "dtmfSettings": { # Define behaviors for DTMF (dual tone multi frequency). # Settings for DTMF. Exposed at the following levels: - Agent level - Flow level - Page level - Parameter level. + "enabled": True or False, # If true, incoming audio is processed for DTMF (dual tone multi frequency) events. For example, if the caller presses a button on their telephone keypad and DTMF processing is enabled, Dialogflow will detect the event (e.g. a "3" was pressed) in the incoming audio and pass the event to the bot to drive business logic (e.g. when 3 is pressed, return the account balance). + "endpointingTimeoutDuration": "A String", # Endpoint timeout setting for matching dtmf input to regex. + "finishDigit": "A String", # The digit that terminates a DTMF digit sequence. + "interdigitTimeoutDuration": "A String", # Interdigit timeout setting for matching dtmf input to regex. + "maxDigits": 42, # Max length of DTMF digits. + }, + "loggingSettings": { # Define behaviors on logging. # Settings for logging. Settings for Dialogflow History, Contact Center messages, StackDriver logs, and speech logging. Exposed at the following levels: - Agent level. + "enableInteractionLogging": True or False, # Enables DF Interaction logging. + "enableStackdriverLogging": True or False, # Enables StackDriver logging. + }, + "speechSettings": { # Define behaviors of speech to text detection. # Settings for speech to text detection. Exposed at the following levels: - Agent level - Flow level - Page level - Parameter level + "endpointerSensitivity": 42, # Sensitivity of the speech model that detects the end of speech. Scale from 0 to 100. + "models": { # Mapping from language to Speech-to-Text model. The mapped Speech-to-Text model will be selected for requests from its corresponding language. For more information, see [Speech models](https://cloud.google.com/dialogflow/cx/docs/concept/speech-models). + "a_key": "A String", + }, + "noSpeechTimeout": "A String", # Timeout before detecting no speech. + "useTimeoutBasedEndpointing": True or False, # Use timeout based endpointing, interpreting endpointer sensitivy as seconds of timeout value. + }, + }, + "description": "A String", # The description of the page. The maximum length is 500 characters. + "displayName": "A String", # Required. The human-readable name of the page, unique within the flow. + "entryFulfillment": { # A fulfillment can do one or more of the following actions at the same time: * Generate rich message responses. * Set parameter values. * Call the webhook. Fulfillments can be called at various stages in the Page or Form lifecycle. For example, when a DetectIntentRequest drives a session to enter a new page, the page's entry fulfillment can add a static response to the QueryResult in the returning DetectIntentResponse, call the webhook (for example, to load user data from a database), or both. # The fulfillment to call when the session is entering the page. + "advancedSettings": { # Hierarchical advanced settings for agent/flow/page/fulfillment/parameter. Settings exposed at lower level overrides the settings exposed at higher level. Overriding occurs at the sub-setting level. For example, the playback_interruption_settings at fulfillment level only overrides the playback_interruption_settings at the agent level, leaving other settings at the agent level unchanged. DTMF settings does not override each other. DTMF settings set at different levels define DTMF detections running in parallel. Hierarchy: Agent->Flow->Page->Fulfillment/Parameter. # Hierarchical advanced settings for this fulfillment. The settings exposed at the lower level overrides the settings exposed at the higher level. + "audioExportGcsDestination": { # Google Cloud Storage location for a Dialogflow operation that writes or exports objects (e.g. exported agent or transcripts) outside of Dialogflow. # If present, incoming audio is exported by Dialogflow to the configured Google Cloud Storage destination. Exposed at the following levels: - Agent level - Flow level + "uri": "A String", # Required. The Google Cloud Storage URI for the exported objects. A URI is of the form: `gs://bucket/object-name-or-prefix` Whether a full object name, or just a prefix, its usage depends on the Dialogflow operation. + }, + "dtmfSettings": { # Define behaviors for DTMF (dual tone multi frequency). # Settings for DTMF. Exposed at the following levels: - Agent level - Flow level - Page level - Parameter level. + "enabled": True or False, # If true, incoming audio is processed for DTMF (dual tone multi frequency) events. For example, if the caller presses a button on their telephone keypad and DTMF processing is enabled, Dialogflow will detect the event (e.g. a "3" was pressed) in the incoming audio and pass the event to the bot to drive business logic (e.g. when 3 is pressed, return the account balance). + "endpointingTimeoutDuration": "A String", # Endpoint timeout setting for matching dtmf input to regex. + "finishDigit": "A String", # The digit that terminates a DTMF digit sequence. + "interdigitTimeoutDuration": "A String", # Interdigit timeout setting for matching dtmf input to regex. + "maxDigits": 42, # Max length of DTMF digits. + }, + "loggingSettings": { # Define behaviors on logging. # Settings for logging. Settings for Dialogflow History, Contact Center messages, StackDriver logs, and speech logging. Exposed at the following levels: - Agent level. + "enableInteractionLogging": True or False, # Enables DF Interaction logging. + "enableStackdriverLogging": True or False, # Enables StackDriver logging. + }, + "speechSettings": { # Define behaviors of speech to text detection. # Settings for speech to text detection. Exposed at the following levels: - Agent level - Flow level - Page level - Parameter level + "endpointerSensitivity": 42, # Sensitivity of the speech model that detects the end of speech. Scale from 0 to 100. + "models": { # Mapping from language to Speech-to-Text model. The mapped Speech-to-Text model will be selected for requests from its corresponding language. For more information, see [Speech models](https://cloud.google.com/dialogflow/cx/docs/concept/speech-models). + "a_key": "A String", + }, + "noSpeechTimeout": "A String", # Timeout before detecting no speech. + "useTimeoutBasedEndpointing": True or False, # Use timeout based endpointing, interpreting endpointer sensitivy as seconds of timeout value. + }, + }, + "conditionalCases": [ # Conditional cases for this fulfillment. + { # A list of cascading if-else conditions. Cases are mutually exclusive. The first one with a matching condition is selected, all the rest ignored. + "cases": [ # A list of cascading if-else conditions. + { # Each case has a Boolean condition. When it is evaluated to be True, the corresponding messages will be selected and evaluated recursively. + "caseContent": [ # A list of case content. + { # The list of messages or conditional cases to activate for this case. + "additionalCases": # Object with schema name: GoogleCloudDialogflowCxV3beta1FulfillmentConditionalCases # Additional cases to be evaluated. + "message": { # 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. # Returned message. + "channel": "A String", # The channel which the response is associated with. Clients can specify the channel via QueryParameters.channel, and only associated channel response will be returned. + "conversationSuccess": { # 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. # Indicates that the conversation succeeded. + "metadata": { # Custom metadata. Dialogflow doesn't impose any structure on this. + "a_key": "", # Properties of the object. + }, + }, + "endInteraction": { # 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. # Output only. A signal that indicates the interaction with the Dialogflow agent has ended. This message is generated by Dialogflow only when the conversation reaches `END_SESSION` page. It is not supposed to be defined by the user. It's guaranteed that there is at most one such message in each response. + }, + "knowledgeInfoCard": { # Represents info card response. If the response contains generative knowledge prediction, Dialogflow will return a payload with Infobot Messenger compatible info card. Otherwise, the info card response is skipped. # Represents info card for knowledge answers, to be better rendered in Dialogflow Messenger. + }, + "liveAgentHandoff": { # 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. # Hands off conversation to a human agent. + "metadata": { # Custom metadata for your handoff procedure. Dialogflow doesn't impose any structure on this. + "a_key": "", # Properties of the object. + }, + }, + "mixedAudio": { # 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. # Output only. An audio response message composed of both the synthesized Dialogflow agent responses and responses defined via play_audio. This message is generated by Dialogflow only and not supposed to be defined by the user. + "segments": [ # Segments this audio response is composed of. + { # Represents one segment of audio. + "allowPlaybackInterruption": True or False, # 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. + "audio": "A String", # Raw audio synthesized from the Dialogflow agent's response using the output config specified in the request. + "uri": "A String", # Client-specific URI that points to an audio clip accessible to the client. Dialogflow does not impose any validation on it. + }, + ], + }, + "outputAudioText": { # A text or ssml response that is preferentially used for TTS output audio synthesis, as described in the comment on the ResponseMessage message. # A text or ssml response that is preferentially used for TTS output audio synthesis, as described in the comment on the ResponseMessage message. + "allowPlaybackInterruption": True or False, # 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. + "ssml": "A String", # The SSML text to be synthesized. For more information, see [SSML](/speech/text-to-speech/docs/ssml). + "text": "A String", # The raw text to be synthesized. + }, + "payload": { # Returns a response containing a custom, platform-specific payload. + "a_key": "", # Properties of the object. + }, + "playAudio": { # Specifies an audio clip to be played by the client as part of the response. # Signal that the client should play an audio clip hosted at a client-specific URI. Dialogflow uses this to construct mixed_audio. However, Dialogflow itself does not try to read or process the URI in any way. + "allowPlaybackInterruption": True or False, # 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. + "audioUri": "A String", # Required. URI of the audio clip. Dialogflow does not impose any validation on this value. It is specific to the client that reads it. + }, + "telephonyTransferCall": { # Represents the signal that telles the client to transfer the phone call connected to the agent to a third-party endpoint. # A signal that the client should transfer the phone call connected to this agent to a third-party endpoint. + "phoneNumber": "A String", # Transfer the call to a phone number in [E.164 format](https://en.wikipedia.org/wiki/E.164). + }, + "text": { # The text response message. # Returns a text response. + "allowPlaybackInterruption": True or False, # 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. + "text": [ # Required. A collection of text responses. + "A String", + ], + }, + "toolCall": { # Represents a call of a specific tool's action with the specified inputs. # Returns the definition of a tool call that should be executed by the client. + "action": "A String", # Required. The name of the tool's action associated with this call. + "inputParameters": { # Optional. The action's input parameters. + "a_key": "", # Properties of the object. + }, + "tool": "A String", # Required. The tool associated with this call. Format: `projects//locations//agents//tools/`. + }, + }, + }, + ], + "condition": "A String", # The condition to activate and select this case. Empty means the condition is always true. The condition is evaluated against form parameters or session parameters. See the [conditions reference](https://cloud.google.com/dialogflow/cx/docs/reference/condition). + }, + ], + }, + ], + "enableGenerativeFallback": True or False, # If the flag is true, the agent will utilize LLM to generate a text response. If LLM generation fails, the defined responses in the fulfillment will be respected. This flag is only useful for fulfillments associated with no-match event handlers. + "messages": [ # The list of rich message responses to present to the user. + { # 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. + "channel": "A String", # The channel which the response is associated with. Clients can specify the channel via QueryParameters.channel, and only associated channel response will be returned. + "conversationSuccess": { # 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. # Indicates that the conversation succeeded. + "metadata": { # Custom metadata. Dialogflow doesn't impose any structure on this. + "a_key": "", # Properties of the object. + }, + }, + "endInteraction": { # 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. # Output only. A signal that indicates the interaction with the Dialogflow agent has ended. This message is generated by Dialogflow only when the conversation reaches `END_SESSION` page. It is not supposed to be defined by the user. It's guaranteed that there is at most one such message in each response. + }, + "knowledgeInfoCard": { # Represents info card response. If the response contains generative knowledge prediction, Dialogflow will return a payload with Infobot Messenger compatible info card. Otherwise, the info card response is skipped. # Represents info card for knowledge answers, to be better rendered in Dialogflow Messenger. + }, + "liveAgentHandoff": { # 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. # Hands off conversation to a human agent. + "metadata": { # Custom metadata for your handoff procedure. Dialogflow doesn't impose any structure on this. + "a_key": "", # Properties of the object. + }, + }, + "mixedAudio": { # 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. # Output only. An audio response message composed of both the synthesized Dialogflow agent responses and responses defined via play_audio. This message is generated by Dialogflow only and not supposed to be defined by the user. + "segments": [ # Segments this audio response is composed of. + { # Represents one segment of audio. + "allowPlaybackInterruption": True or False, # 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. + "audio": "A String", # Raw audio synthesized from the Dialogflow agent's response using the output config specified in the request. + "uri": "A String", # Client-specific URI that points to an audio clip accessible to the client. Dialogflow does not impose any validation on it. + }, + ], + }, + "outputAudioText": { # A text or ssml response that is preferentially used for TTS output audio synthesis, as described in the comment on the ResponseMessage message. # A text or ssml response that is preferentially used for TTS output audio synthesis, as described in the comment on the ResponseMessage message. + "allowPlaybackInterruption": True or False, # 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. + "ssml": "A String", # The SSML text to be synthesized. For more information, see [SSML](/speech/text-to-speech/docs/ssml). + "text": "A String", # The raw text to be synthesized. + }, + "payload": { # Returns a response containing a custom, platform-specific payload. + "a_key": "", # Properties of the object. + }, + "playAudio": { # Specifies an audio clip to be played by the client as part of the response. # Signal that the client should play an audio clip hosted at a client-specific URI. Dialogflow uses this to construct mixed_audio. However, Dialogflow itself does not try to read or process the URI in any way. + "allowPlaybackInterruption": True or False, # 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. + "audioUri": "A String", # Required. URI of the audio clip. Dialogflow does not impose any validation on this value. It is specific to the client that reads it. + }, + "telephonyTransferCall": { # Represents the signal that telles the client to transfer the phone call connected to the agent to a third-party endpoint. # A signal that the client should transfer the phone call connected to this agent to a third-party endpoint. + "phoneNumber": "A String", # Transfer the call to a phone number in [E.164 format](https://en.wikipedia.org/wiki/E.164). + }, + "text": { # The text response message. # Returns a text response. + "allowPlaybackInterruption": True or False, # 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. + "text": [ # Required. A collection of text responses. + "A String", + ], + }, + "toolCall": { # Represents a call of a specific tool's action with the specified inputs. # Returns the definition of a tool call that should be executed by the client. + "action": "A String", # Required. The name of the tool's action associated with this call. + "inputParameters": { # Optional. The action's input parameters. + "a_key": "", # Properties of the object. + }, + "tool": "A String", # Required. The tool associated with this call. Format: `projects//locations//agents//tools/`. + }, + }, + ], + "returnPartialResponses": True or False, # Whether Dialogflow should return currently queued fulfillment response messages in streaming APIs. If a webhook is specified, it happens before Dialogflow invokes webhook. Warning: 1) This flag only affects streaming API. Responses are still queued and returned once in non-streaming API. 2) The flag can be enabled in any fulfillment but only the first 3 partial responses will be returned. You may only want to apply it to fulfillments that have slow webhooks. + "setParameterActions": [ # Set parameter values before executing the webhook. + { # Setting a parameter value. + "parameter": "A String", # Display name of the parameter. + "value": "", # The new value of the parameter. A null value clears the parameter. + }, + ], + "tag": "A String", # The value of this field will be populated in the WebhookRequest `fulfillmentInfo.tag` field by Dialogflow when the associated webhook is called. The tag is typically used by the webhook service to identify which fulfillment is being called, but it could be used for other purposes. This field is required if `webhook` is specified. + "webhook": "A String", # The webhook to call. Format: `projects//locations//agents//webhooks/`. + }, + "eventHandlers": [ # Handlers associated with the page to handle events such as webhook errors, no match or no input. + { # An event handler specifies an event that can be handled during a session. When the specified event happens, the following actions are taken in order: * If there is a `trigger_fulfillment` associated with the event, it will be called. * If there is a `target_page` associated with the event, the session will transition into the specified page. * If there is a `target_flow` associated with the event, the session will transition into the specified flow. + "event": "A String", # Required. The name of the event to handle. + "name": "A String", # Output only. The unique identifier of this event handler. + "targetFlow": "A String", # The target flow to transition to. Format: `projects//locations//agents//flows/`. + "targetPage": "A String", # The target page to transition to. Format: `projects//locations//agents//flows//pages/`. + "triggerFulfillment": { # A fulfillment can do one or more of the following actions at the same time: * Generate rich message responses. * Set parameter values. * Call the webhook. Fulfillments can be called at various stages in the Page or Form lifecycle. For example, when a DetectIntentRequest drives a session to enter a new page, the page's entry fulfillment can add a static response to the QueryResult in the returning DetectIntentResponse, call the webhook (for example, to load user data from a database), or both. # The fulfillment to call when the event occurs. Handling webhook errors with a fulfillment enabled with webhook could cause infinite loop. It is invalid to specify such fulfillment for a handler handling webhooks. + "advancedSettings": { # Hierarchical advanced settings for agent/flow/page/fulfillment/parameter. Settings exposed at lower level overrides the settings exposed at higher level. Overriding occurs at the sub-setting level. For example, the playback_interruption_settings at fulfillment level only overrides the playback_interruption_settings at the agent level, leaving other settings at the agent level unchanged. DTMF settings does not override each other. DTMF settings set at different levels define DTMF detections running in parallel. Hierarchy: Agent->Flow->Page->Fulfillment/Parameter. # Hierarchical advanced settings for this fulfillment. The settings exposed at the lower level overrides the settings exposed at the higher level. + "audioExportGcsDestination": { # Google Cloud Storage location for a Dialogflow operation that writes or exports objects (e.g. exported agent or transcripts) outside of Dialogflow. # If present, incoming audio is exported by Dialogflow to the configured Google Cloud Storage destination. Exposed at the following levels: - Agent level - Flow level + "uri": "A String", # Required. The Google Cloud Storage URI for the exported objects. A URI is of the form: `gs://bucket/object-name-or-prefix` Whether a full object name, or just a prefix, its usage depends on the Dialogflow operation. + }, + "dtmfSettings": { # Define behaviors for DTMF (dual tone multi frequency). # Settings for DTMF. Exposed at the following levels: - Agent level - Flow level - Page level - Parameter level. + "enabled": True or False, # If true, incoming audio is processed for DTMF (dual tone multi frequency) events. For example, if the caller presses a button on their telephone keypad and DTMF processing is enabled, Dialogflow will detect the event (e.g. a "3" was pressed) in the incoming audio and pass the event to the bot to drive business logic (e.g. when 3 is pressed, return the account balance). + "endpointingTimeoutDuration": "A String", # Endpoint timeout setting for matching dtmf input to regex. + "finishDigit": "A String", # The digit that terminates a DTMF digit sequence. + "interdigitTimeoutDuration": "A String", # Interdigit timeout setting for matching dtmf input to regex. + "maxDigits": 42, # Max length of DTMF digits. + }, + "loggingSettings": { # Define behaviors on logging. # Settings for logging. Settings for Dialogflow History, Contact Center messages, StackDriver logs, and speech logging. Exposed at the following levels: - Agent level. + "enableInteractionLogging": True or False, # Enables DF Interaction logging. + "enableStackdriverLogging": True or False, # Enables StackDriver logging. + }, + "speechSettings": { # Define behaviors of speech to text detection. # Settings for speech to text detection. Exposed at the following levels: - Agent level - Flow level - Page level - Parameter level + "endpointerSensitivity": 42, # Sensitivity of the speech model that detects the end of speech. Scale from 0 to 100. + "models": { # Mapping from language to Speech-to-Text model. The mapped Speech-to-Text model will be selected for requests from its corresponding language. For more information, see [Speech models](https://cloud.google.com/dialogflow/cx/docs/concept/speech-models). + "a_key": "A String", + }, + "noSpeechTimeout": "A String", # Timeout before detecting no speech. + "useTimeoutBasedEndpointing": True or False, # Use timeout based endpointing, interpreting endpointer sensitivy as seconds of timeout value. + }, + }, + "conditionalCases": [ # Conditional cases for this fulfillment. + { # A list of cascading if-else conditions. Cases are mutually exclusive. The first one with a matching condition is selected, all the rest ignored. + "cases": [ # A list of cascading if-else conditions. + { # Each case has a Boolean condition. When it is evaluated to be True, the corresponding messages will be selected and evaluated recursively. + "caseContent": [ # A list of case content. + { # The list of messages or conditional cases to activate for this case. + "additionalCases": # Object with schema name: GoogleCloudDialogflowCxV3beta1FulfillmentConditionalCases # Additional cases to be evaluated. + "message": { # 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. # Returned message. + "channel": "A String", # The channel which the response is associated with. Clients can specify the channel via QueryParameters.channel, and only associated channel response will be returned. + "conversationSuccess": { # 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. # Indicates that the conversation succeeded. + "metadata": { # Custom metadata. Dialogflow doesn't impose any structure on this. + "a_key": "", # Properties of the object. + }, + }, + "endInteraction": { # 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. # Output only. A signal that indicates the interaction with the Dialogflow agent has ended. This message is generated by Dialogflow only when the conversation reaches `END_SESSION` page. It is not supposed to be defined by the user. It's guaranteed that there is at most one such message in each response. + }, + "knowledgeInfoCard": { # Represents info card response. If the response contains generative knowledge prediction, Dialogflow will return a payload with Infobot Messenger compatible info card. Otherwise, the info card response is skipped. # Represents info card for knowledge answers, to be better rendered in Dialogflow Messenger. + }, + "liveAgentHandoff": { # 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. # Hands off conversation to a human agent. + "metadata": { # Custom metadata for your handoff procedure. Dialogflow doesn't impose any structure on this. + "a_key": "", # Properties of the object. + }, + }, + "mixedAudio": { # 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. # Output only. An audio response message composed of both the synthesized Dialogflow agent responses and responses defined via play_audio. This message is generated by Dialogflow only and not supposed to be defined by the user. + "segments": [ # Segments this audio response is composed of. + { # Represents one segment of audio. + "allowPlaybackInterruption": True or False, # 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. + "audio": "A String", # Raw audio synthesized from the Dialogflow agent's response using the output config specified in the request. + "uri": "A String", # Client-specific URI that points to an audio clip accessible to the client. Dialogflow does not impose any validation on it. + }, + ], + }, + "outputAudioText": { # A text or ssml response that is preferentially used for TTS output audio synthesis, as described in the comment on the ResponseMessage message. # A text or ssml response that is preferentially used for TTS output audio synthesis, as described in the comment on the ResponseMessage message. + "allowPlaybackInterruption": True or False, # 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. + "ssml": "A String", # The SSML text to be synthesized. For more information, see [SSML](/speech/text-to-speech/docs/ssml). + "text": "A String", # The raw text to be synthesized. + }, + "payload": { # Returns a response containing a custom, platform-specific payload. + "a_key": "", # Properties of the object. + }, + "playAudio": { # Specifies an audio clip to be played by the client as part of the response. # Signal that the client should play an audio clip hosted at a client-specific URI. Dialogflow uses this to construct mixed_audio. However, Dialogflow itself does not try to read or process the URI in any way. + "allowPlaybackInterruption": True or False, # 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. + "audioUri": "A String", # Required. URI of the audio clip. Dialogflow does not impose any validation on this value. It is specific to the client that reads it. + }, + "telephonyTransferCall": { # Represents the signal that telles the client to transfer the phone call connected to the agent to a third-party endpoint. # A signal that the client should transfer the phone call connected to this agent to a third-party endpoint. + "phoneNumber": "A String", # Transfer the call to a phone number in [E.164 format](https://en.wikipedia.org/wiki/E.164). + }, + "text": { # The text response message. # Returns a text response. + "allowPlaybackInterruption": True or False, # 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. + "text": [ # Required. A collection of text responses. + "A String", + ], + }, + "toolCall": { # Represents a call of a specific tool's action with the specified inputs. # Returns the definition of a tool call that should be executed by the client. + "action": "A String", # Required. The name of the tool's action associated with this call. + "inputParameters": { # Optional. The action's input parameters. + "a_key": "", # Properties of the object. + }, + "tool": "A String", # Required. The tool associated with this call. Format: `projects//locations//agents//tools/`. + }, + }, + }, + ], + "condition": "A String", # The condition to activate and select this case. Empty means the condition is always true. The condition is evaluated against form parameters or session parameters. See the [conditions reference](https://cloud.google.com/dialogflow/cx/docs/reference/condition). + }, + ], + }, + ], + "enableGenerativeFallback": True or False, # If the flag is true, the agent will utilize LLM to generate a text response. If LLM generation fails, the defined responses in the fulfillment will be respected. This flag is only useful for fulfillments associated with no-match event handlers. + "messages": [ # The list of rich message responses to present to the user. + { # 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. + "channel": "A String", # The channel which the response is associated with. Clients can specify the channel via QueryParameters.channel, and only associated channel response will be returned. + "conversationSuccess": { # 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. # Indicates that the conversation succeeded. + "metadata": { # Custom metadata. Dialogflow doesn't impose any structure on this. + "a_key": "", # Properties of the object. + }, + }, + "endInteraction": { # 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. # Output only. A signal that indicates the interaction with the Dialogflow agent has ended. This message is generated by Dialogflow only when the conversation reaches `END_SESSION` page. It is not supposed to be defined by the user. It's guaranteed that there is at most one such message in each response. + }, + "knowledgeInfoCard": { # Represents info card response. If the response contains generative knowledge prediction, Dialogflow will return a payload with Infobot Messenger compatible info card. Otherwise, the info card response is skipped. # Represents info card for knowledge answers, to be better rendered in Dialogflow Messenger. + }, + "liveAgentHandoff": { # 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. # Hands off conversation to a human agent. + "metadata": { # Custom metadata for your handoff procedure. Dialogflow doesn't impose any structure on this. + "a_key": "", # Properties of the object. + }, + }, + "mixedAudio": { # 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. # Output only. An audio response message composed of both the synthesized Dialogflow agent responses and responses defined via play_audio. This message is generated by Dialogflow only and not supposed to be defined by the user. + "segments": [ # Segments this audio response is composed of. + { # Represents one segment of audio. + "allowPlaybackInterruption": True or False, # 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. + "audio": "A String", # Raw audio synthesized from the Dialogflow agent's response using the output config specified in the request. + "uri": "A String", # Client-specific URI that points to an audio clip accessible to the client. Dialogflow does not impose any validation on it. + }, + ], + }, + "outputAudioText": { # A text or ssml response that is preferentially used for TTS output audio synthesis, as described in the comment on the ResponseMessage message. # A text or ssml response that is preferentially used for TTS output audio synthesis, as described in the comment on the ResponseMessage message. + "allowPlaybackInterruption": True or False, # 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. + "ssml": "A String", # The SSML text to be synthesized. For more information, see [SSML](/speech/text-to-speech/docs/ssml). + "text": "A String", # The raw text to be synthesized. + }, + "payload": { # Returns a response containing a custom, platform-specific payload. + "a_key": "", # Properties of the object. + }, + "playAudio": { # Specifies an audio clip to be played by the client as part of the response. # Signal that the client should play an audio clip hosted at a client-specific URI. Dialogflow uses this to construct mixed_audio. However, Dialogflow itself does not try to read or process the URI in any way. + "allowPlaybackInterruption": True or False, # 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. + "audioUri": "A String", # Required. URI of the audio clip. Dialogflow does not impose any validation on this value. It is specific to the client that reads it. + }, + "telephonyTransferCall": { # Represents the signal that telles the client to transfer the phone call connected to the agent to a third-party endpoint. # A signal that the client should transfer the phone call connected to this agent to a third-party endpoint. + "phoneNumber": "A String", # Transfer the call to a phone number in [E.164 format](https://en.wikipedia.org/wiki/E.164). + }, + "text": { # The text response message. # Returns a text response. + "allowPlaybackInterruption": True or False, # 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. + "text": [ # Required. A collection of text responses. + "A String", + ], + }, + "toolCall": { # Represents a call of a specific tool's action with the specified inputs. # Returns the definition of a tool call that should be executed by the client. + "action": "A String", # Required. The name of the tool's action associated with this call. + "inputParameters": { # Optional. The action's input parameters. + "a_key": "", # Properties of the object. + }, + "tool": "A String", # Required. The tool associated with this call. Format: `projects//locations//agents//tools/`. + }, + }, + ], + "returnPartialResponses": True or False, # Whether Dialogflow should return currently queued fulfillment response messages in streaming APIs. If a webhook is specified, it happens before Dialogflow invokes webhook. Warning: 1) This flag only affects streaming API. Responses are still queued and returned once in non-streaming API. 2) The flag can be enabled in any fulfillment but only the first 3 partial responses will be returned. You may only want to apply it to fulfillments that have slow webhooks. + "setParameterActions": [ # Set parameter values before executing the webhook. + { # Setting a parameter value. + "parameter": "A String", # Display name of the parameter. + "value": "", # The new value of the parameter. A null value clears the parameter. + }, + ], + "tag": "A String", # The value of this field will be populated in the WebhookRequest `fulfillmentInfo.tag` field by Dialogflow when the associated webhook is called. The tag is typically used by the webhook service to identify which fulfillment is being called, but it could be used for other purposes. This field is required if `webhook` is specified. + "webhook": "A String", # The webhook to call. Format: `projects//locations//agents//webhooks/`. + }, + }, + ], + "form": { # A form is a data model that groups related parameters that can be collected from the user. The process in which the agent prompts the user and collects parameter values from the user is called form filling. A form can be added to a page. When form filling is done, the filled parameters will be written to the session. # The form associated with the page, used for collecting parameters relevant to the page. + "parameters": [ # Parameters to collect from the user. + { # Represents a form parameter. + "advancedSettings": { # Hierarchical advanced settings for agent/flow/page/fulfillment/parameter. Settings exposed at lower level overrides the settings exposed at higher level. Overriding occurs at the sub-setting level. For example, the playback_interruption_settings at fulfillment level only overrides the playback_interruption_settings at the agent level, leaving other settings at the agent level unchanged. DTMF settings does not override each other. DTMF settings set at different levels define DTMF detections running in parallel. Hierarchy: Agent->Flow->Page->Fulfillment/Parameter. # Hierarchical advanced settings for this parameter. The settings exposed at the lower level overrides the settings exposed at the higher level. + "audioExportGcsDestination": { # Google Cloud Storage location for a Dialogflow operation that writes or exports objects (e.g. exported agent or transcripts) outside of Dialogflow. # If present, incoming audio is exported by Dialogflow to the configured Google Cloud Storage destination. Exposed at the following levels: - Agent level - Flow level + "uri": "A String", # Required. The Google Cloud Storage URI for the exported objects. A URI is of the form: `gs://bucket/object-name-or-prefix` Whether a full object name, or just a prefix, its usage depends on the Dialogflow operation. + }, + "dtmfSettings": { # Define behaviors for DTMF (dual tone multi frequency). # Settings for DTMF. Exposed at the following levels: - Agent level - Flow level - Page level - Parameter level. + "enabled": True or False, # If true, incoming audio is processed for DTMF (dual tone multi frequency) events. For example, if the caller presses a button on their telephone keypad and DTMF processing is enabled, Dialogflow will detect the event (e.g. a "3" was pressed) in the incoming audio and pass the event to the bot to drive business logic (e.g. when 3 is pressed, return the account balance). + "endpointingTimeoutDuration": "A String", # Endpoint timeout setting for matching dtmf input to regex. + "finishDigit": "A String", # The digit that terminates a DTMF digit sequence. + "interdigitTimeoutDuration": "A String", # Interdigit timeout setting for matching dtmf input to regex. + "maxDigits": 42, # Max length of DTMF digits. + }, + "loggingSettings": { # Define behaviors on logging. # Settings for logging. Settings for Dialogflow History, Contact Center messages, StackDriver logs, and speech logging. Exposed at the following levels: - Agent level. + "enableInteractionLogging": True or False, # Enables DF Interaction logging. + "enableStackdriverLogging": True or False, # Enables StackDriver logging. + }, + "speechSettings": { # Define behaviors of speech to text detection. # Settings for speech to text detection. Exposed at the following levels: - Agent level - Flow level - Page level - Parameter level + "endpointerSensitivity": 42, # Sensitivity of the speech model that detects the end of speech. Scale from 0 to 100. + "models": { # Mapping from language to Speech-to-Text model. The mapped Speech-to-Text model will be selected for requests from its corresponding language. For more information, see [Speech models](https://cloud.google.com/dialogflow/cx/docs/concept/speech-models). + "a_key": "A String", + }, + "noSpeechTimeout": "A String", # Timeout before detecting no speech. + "useTimeoutBasedEndpointing": True or False, # Use timeout based endpointing, interpreting endpointer sensitivy as seconds of timeout value. + }, + }, + "defaultValue": "", # The default value of an optional parameter. If the parameter is required, the default value will be ignored. + "displayName": "A String", # Required. The human-readable name of the parameter, unique within the form. + "entityType": "A String", # Required. The entity type of the parameter. Format: `projects/-/locations/-/agents/-/entityTypes/` for system entity types (for example, `projects/-/locations/-/agents/-/entityTypes/sys.date`), or `projects//locations//agents//entityTypes/` for developer entity types. + "fillBehavior": { # Configuration for how the filling of a parameter should be handled. # Required. Defines fill behavior for the parameter. + "initialPromptFulfillment": { # A fulfillment can do one or more of the following actions at the same time: * Generate rich message responses. * Set parameter values. * Call the webhook. Fulfillments can be called at various stages in the Page or Form lifecycle. For example, when a DetectIntentRequest drives a session to enter a new page, the page's entry fulfillment can add a static response to the QueryResult in the returning DetectIntentResponse, call the webhook (for example, to load user data from a database), or both. # Required. The fulfillment to provide the initial prompt that the agent can present to the user in order to fill the parameter. + "advancedSettings": { # Hierarchical advanced settings for agent/flow/page/fulfillment/parameter. Settings exposed at lower level overrides the settings exposed at higher level. Overriding occurs at the sub-setting level. For example, the playback_interruption_settings at fulfillment level only overrides the playback_interruption_settings at the agent level, leaving other settings at the agent level unchanged. DTMF settings does not override each other. DTMF settings set at different levels define DTMF detections running in parallel. Hierarchy: Agent->Flow->Page->Fulfillment/Parameter. # Hierarchical advanced settings for this fulfillment. The settings exposed at the lower level overrides the settings exposed at the higher level. + "audioExportGcsDestination": { # Google Cloud Storage location for a Dialogflow operation that writes or exports objects (e.g. exported agent or transcripts) outside of Dialogflow. # If present, incoming audio is exported by Dialogflow to the configured Google Cloud Storage destination. Exposed at the following levels: - Agent level - Flow level + "uri": "A String", # Required. The Google Cloud Storage URI for the exported objects. A URI is of the form: `gs://bucket/object-name-or-prefix` Whether a full object name, or just a prefix, its usage depends on the Dialogflow operation. + }, + "dtmfSettings": { # Define behaviors for DTMF (dual tone multi frequency). # Settings for DTMF. Exposed at the following levels: - Agent level - Flow level - Page level - Parameter level. + "enabled": True or False, # If true, incoming audio is processed for DTMF (dual tone multi frequency) events. For example, if the caller presses a button on their telephone keypad and DTMF processing is enabled, Dialogflow will detect the event (e.g. a "3" was pressed) in the incoming audio and pass the event to the bot to drive business logic (e.g. when 3 is pressed, return the account balance). + "endpointingTimeoutDuration": "A String", # Endpoint timeout setting for matching dtmf input to regex. + "finishDigit": "A String", # The digit that terminates a DTMF digit sequence. + "interdigitTimeoutDuration": "A String", # Interdigit timeout setting for matching dtmf input to regex. + "maxDigits": 42, # Max length of DTMF digits. + }, + "loggingSettings": { # Define behaviors on logging. # Settings for logging. Settings for Dialogflow History, Contact Center messages, StackDriver logs, and speech logging. Exposed at the following levels: - Agent level. + "enableInteractionLogging": True or False, # Enables DF Interaction logging. + "enableStackdriverLogging": True or False, # Enables StackDriver logging. + }, + "speechSettings": { # Define behaviors of speech to text detection. # Settings for speech to text detection. Exposed at the following levels: - Agent level - Flow level - Page level - Parameter level + "endpointerSensitivity": 42, # Sensitivity of the speech model that detects the end of speech. Scale from 0 to 100. + "models": { # Mapping from language to Speech-to-Text model. The mapped Speech-to-Text model will be selected for requests from its corresponding language. For more information, see [Speech models](https://cloud.google.com/dialogflow/cx/docs/concept/speech-models). + "a_key": "A String", + }, + "noSpeechTimeout": "A String", # Timeout before detecting no speech. + "useTimeoutBasedEndpointing": True or False, # Use timeout based endpointing, interpreting endpointer sensitivy as seconds of timeout value. + }, + }, + "conditionalCases": [ # Conditional cases for this fulfillment. + { # A list of cascading if-else conditions. Cases are mutually exclusive. The first one with a matching condition is selected, all the rest ignored. + "cases": [ # A list of cascading if-else conditions. + { # Each case has a Boolean condition. When it is evaluated to be True, the corresponding messages will be selected and evaluated recursively. + "caseContent": [ # A list of case content. + { # The list of messages or conditional cases to activate for this case. + "additionalCases": # Object with schema name: GoogleCloudDialogflowCxV3beta1FulfillmentConditionalCases # Additional cases to be evaluated. + "message": { # 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. # Returned message. + "channel": "A String", # The channel which the response is associated with. Clients can specify the channel via QueryParameters.channel, and only associated channel response will be returned. + "conversationSuccess": { # 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. # Indicates that the conversation succeeded. + "metadata": { # Custom metadata. Dialogflow doesn't impose any structure on this. + "a_key": "", # Properties of the object. + }, + }, + "endInteraction": { # 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. # Output only. A signal that indicates the interaction with the Dialogflow agent has ended. This message is generated by Dialogflow only when the conversation reaches `END_SESSION` page. It is not supposed to be defined by the user. It's guaranteed that there is at most one such message in each response. + }, + "knowledgeInfoCard": { # Represents info card response. If the response contains generative knowledge prediction, Dialogflow will return a payload with Infobot Messenger compatible info card. Otherwise, the info card response is skipped. # Represents info card for knowledge answers, to be better rendered in Dialogflow Messenger. + }, + "liveAgentHandoff": { # 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. # Hands off conversation to a human agent. + "metadata": { # Custom metadata for your handoff procedure. Dialogflow doesn't impose any structure on this. + "a_key": "", # Properties of the object. + }, + }, + "mixedAudio": { # 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. # Output only. An audio response message composed of both the synthesized Dialogflow agent responses and responses defined via play_audio. This message is generated by Dialogflow only and not supposed to be defined by the user. + "segments": [ # Segments this audio response is composed of. + { # Represents one segment of audio. + "allowPlaybackInterruption": True or False, # 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. + "audio": "A String", # Raw audio synthesized from the Dialogflow agent's response using the output config specified in the request. + "uri": "A String", # Client-specific URI that points to an audio clip accessible to the client. Dialogflow does not impose any validation on it. + }, + ], + }, + "outputAudioText": { # A text or ssml response that is preferentially used for TTS output audio synthesis, as described in the comment on the ResponseMessage message. # A text or ssml response that is preferentially used for TTS output audio synthesis, as described in the comment on the ResponseMessage message. + "allowPlaybackInterruption": True or False, # 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. + "ssml": "A String", # The SSML text to be synthesized. For more information, see [SSML](/speech/text-to-speech/docs/ssml). + "text": "A String", # The raw text to be synthesized. + }, + "payload": { # Returns a response containing a custom, platform-specific payload. + "a_key": "", # Properties of the object. + }, + "playAudio": { # Specifies an audio clip to be played by the client as part of the response. # Signal that the client should play an audio clip hosted at a client-specific URI. Dialogflow uses this to construct mixed_audio. However, Dialogflow itself does not try to read or process the URI in any way. + "allowPlaybackInterruption": True or False, # 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. + "audioUri": "A String", # Required. URI of the audio clip. Dialogflow does not impose any validation on this value. It is specific to the client that reads it. + }, + "telephonyTransferCall": { # Represents the signal that telles the client to transfer the phone call connected to the agent to a third-party endpoint. # A signal that the client should transfer the phone call connected to this agent to a third-party endpoint. + "phoneNumber": "A String", # Transfer the call to a phone number in [E.164 format](https://en.wikipedia.org/wiki/E.164). + }, + "text": { # The text response message. # Returns a text response. + "allowPlaybackInterruption": True or False, # 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. + "text": [ # Required. A collection of text responses. + "A String", + ], + }, + "toolCall": { # Represents a call of a specific tool's action with the specified inputs. # Returns the definition of a tool call that should be executed by the client. + "action": "A String", # Required. The name of the tool's action associated with this call. + "inputParameters": { # Optional. The action's input parameters. + "a_key": "", # Properties of the object. + }, + "tool": "A String", # Required. The tool associated with this call. Format: `projects//locations//agents//tools/`. + }, + }, + }, + ], + "condition": "A String", # The condition to activate and select this case. Empty means the condition is always true. The condition is evaluated against form parameters or session parameters. See the [conditions reference](https://cloud.google.com/dialogflow/cx/docs/reference/condition). + }, + ], + }, + ], + "enableGenerativeFallback": True or False, # If the flag is true, the agent will utilize LLM to generate a text response. If LLM generation fails, the defined responses in the fulfillment will be respected. This flag is only useful for fulfillments associated with no-match event handlers. + "messages": [ # The list of rich message responses to present to the user. + { # 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. + "channel": "A String", # The channel which the response is associated with. Clients can specify the channel via QueryParameters.channel, and only associated channel response will be returned. + "conversationSuccess": { # 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. # Indicates that the conversation succeeded. + "metadata": { # Custom metadata. Dialogflow doesn't impose any structure on this. + "a_key": "", # Properties of the object. + }, + }, + "endInteraction": { # 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. # Output only. A signal that indicates the interaction with the Dialogflow agent has ended. This message is generated by Dialogflow only when the conversation reaches `END_SESSION` page. It is not supposed to be defined by the user. It's guaranteed that there is at most one such message in each response. + }, + "knowledgeInfoCard": { # Represents info card response. If the response contains generative knowledge prediction, Dialogflow will return a payload with Infobot Messenger compatible info card. Otherwise, the info card response is skipped. # Represents info card for knowledge answers, to be better rendered in Dialogflow Messenger. + }, + "liveAgentHandoff": { # 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. # Hands off conversation to a human agent. + "metadata": { # Custom metadata for your handoff procedure. Dialogflow doesn't impose any structure on this. + "a_key": "", # Properties of the object. + }, + }, + "mixedAudio": { # 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. # Output only. An audio response message composed of both the synthesized Dialogflow agent responses and responses defined via play_audio. This message is generated by Dialogflow only and not supposed to be defined by the user. + "segments": [ # Segments this audio response is composed of. + { # Represents one segment of audio. + "allowPlaybackInterruption": True or False, # 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. + "audio": "A String", # Raw audio synthesized from the Dialogflow agent's response using the output config specified in the request. + "uri": "A String", # Client-specific URI that points to an audio clip accessible to the client. Dialogflow does not impose any validation on it. + }, + ], + }, + "outputAudioText": { # A text or ssml response that is preferentially used for TTS output audio synthesis, as described in the comment on the ResponseMessage message. # A text or ssml response that is preferentially used for TTS output audio synthesis, as described in the comment on the ResponseMessage message. + "allowPlaybackInterruption": True or False, # 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. + "ssml": "A String", # The SSML text to be synthesized. For more information, see [SSML](/speech/text-to-speech/docs/ssml). + "text": "A String", # The raw text to be synthesized. + }, + "payload": { # Returns a response containing a custom, platform-specific payload. + "a_key": "", # Properties of the object. + }, + "playAudio": { # Specifies an audio clip to be played by the client as part of the response. # Signal that the client should play an audio clip hosted at a client-specific URI. Dialogflow uses this to construct mixed_audio. However, Dialogflow itself does not try to read or process the URI in any way. + "allowPlaybackInterruption": True or False, # 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. + "audioUri": "A String", # Required. URI of the audio clip. Dialogflow does not impose any validation on this value. It is specific to the client that reads it. + }, + "telephonyTransferCall": { # Represents the signal that telles the client to transfer the phone call connected to the agent to a third-party endpoint. # A signal that the client should transfer the phone call connected to this agent to a third-party endpoint. + "phoneNumber": "A String", # Transfer the call to a phone number in [E.164 format](https://en.wikipedia.org/wiki/E.164). + }, + "text": { # The text response message. # Returns a text response. + "allowPlaybackInterruption": True or False, # 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. + "text": [ # Required. A collection of text responses. + "A String", + ], + }, + "toolCall": { # Represents a call of a specific tool's action with the specified inputs. # Returns the definition of a tool call that should be executed by the client. + "action": "A String", # Required. The name of the tool's action associated with this call. + "inputParameters": { # Optional. The action's input parameters. + "a_key": "", # Properties of the object. + }, + "tool": "A String", # Required. The tool associated with this call. Format: `projects//locations//agents//tools/`. + }, + }, + ], + "returnPartialResponses": True or False, # Whether Dialogflow should return currently queued fulfillment response messages in streaming APIs. If a webhook is specified, it happens before Dialogflow invokes webhook. Warning: 1) This flag only affects streaming API. Responses are still queued and returned once in non-streaming API. 2) The flag can be enabled in any fulfillment but only the first 3 partial responses will be returned. You may only want to apply it to fulfillments that have slow webhooks. + "setParameterActions": [ # Set parameter values before executing the webhook. + { # Setting a parameter value. + "parameter": "A String", # Display name of the parameter. + "value": "", # The new value of the parameter. A null value clears the parameter. + }, + ], + "tag": "A String", # The value of this field will be populated in the WebhookRequest `fulfillmentInfo.tag` field by Dialogflow when the associated webhook is called. The tag is typically used by the webhook service to identify which fulfillment is being called, but it could be used for other purposes. This field is required if `webhook` is specified. + "webhook": "A String", # The webhook to call. Format: `projects//locations//agents//webhooks/`. + }, + "repromptEventHandlers": [ # The handlers for parameter-level events, used to provide reprompt for the parameter or transition to a different page/flow. The supported events are: * `sys.no-match-`, where N can be from 1 to 6 * `sys.no-match-default` * `sys.no-input-`, where N can be from 1 to 6 * `sys.no-input-default` * `sys.invalid-parameter` `initial_prompt_fulfillment` provides the first prompt for the parameter. If the user's response does not fill the parameter, a no-match/no-input event will be triggered, and the fulfillment associated with the `sys.no-match-1`/`sys.no-input-1` handler (if defined) will be called to provide a prompt. The `sys.no-match-2`/`sys.no-input-2` handler (if defined) will respond to the next no-match/no-input event, and so on. A `sys.no-match-default` or `sys.no-input-default` handler will be used to handle all following no-match/no-input events after all numbered no-match/no-input handlers for the parameter are consumed. A `sys.invalid-parameter` handler can be defined to handle the case where the parameter values have been `invalidated` by webhook. For example, if the user's response fill the parameter, however the parameter was invalidated by webhook, the fulfillment associated with the `sys.invalid-parameter` handler (if defined) will be called to provide a prompt. If the event handler for the corresponding event can't be found on the parameter, `initial_prompt_fulfillment` will be re-prompted. + { # An event handler specifies an event that can be handled during a session. When the specified event happens, the following actions are taken in order: * If there is a `trigger_fulfillment` associated with the event, it will be called. * If there is a `target_page` associated with the event, the session will transition into the specified page. * If there is a `target_flow` associated with the event, the session will transition into the specified flow. + "event": "A String", # Required. The name of the event to handle. + "name": "A String", # Output only. The unique identifier of this event handler. + "targetFlow": "A String", # The target flow to transition to. Format: `projects//locations//agents//flows/`. + "targetPage": "A String", # The target page to transition to. Format: `projects//locations//agents//flows//pages/`. + "triggerFulfillment": { # A fulfillment can do one or more of the following actions at the same time: * Generate rich message responses. * Set parameter values. * Call the webhook. Fulfillments can be called at various stages in the Page or Form lifecycle. For example, when a DetectIntentRequest drives a session to enter a new page, the page's entry fulfillment can add a static response to the QueryResult in the returning DetectIntentResponse, call the webhook (for example, to load user data from a database), or both. # The fulfillment to call when the event occurs. Handling webhook errors with a fulfillment enabled with webhook could cause infinite loop. It is invalid to specify such fulfillment for a handler handling webhooks. + "advancedSettings": { # Hierarchical advanced settings for agent/flow/page/fulfillment/parameter. Settings exposed at lower level overrides the settings exposed at higher level. Overriding occurs at the sub-setting level. For example, the playback_interruption_settings at fulfillment level only overrides the playback_interruption_settings at the agent level, leaving other settings at the agent level unchanged. DTMF settings does not override each other. DTMF settings set at different levels define DTMF detections running in parallel. Hierarchy: Agent->Flow->Page->Fulfillment/Parameter. # Hierarchical advanced settings for this fulfillment. The settings exposed at the lower level overrides the settings exposed at the higher level. + "audioExportGcsDestination": { # Google Cloud Storage location for a Dialogflow operation that writes or exports objects (e.g. exported agent or transcripts) outside of Dialogflow. # If present, incoming audio is exported by Dialogflow to the configured Google Cloud Storage destination. Exposed at the following levels: - Agent level - Flow level + "uri": "A String", # Required. The Google Cloud Storage URI for the exported objects. A URI is of the form: `gs://bucket/object-name-or-prefix` Whether a full object name, or just a prefix, its usage depends on the Dialogflow operation. + }, + "dtmfSettings": { # Define behaviors for DTMF (dual tone multi frequency). # Settings for DTMF. Exposed at the following levels: - Agent level - Flow level - Page level - Parameter level. + "enabled": True or False, # If true, incoming audio is processed for DTMF (dual tone multi frequency) events. For example, if the caller presses a button on their telephone keypad and DTMF processing is enabled, Dialogflow will detect the event (e.g. a "3" was pressed) in the incoming audio and pass the event to the bot to drive business logic (e.g. when 3 is pressed, return the account balance). + "endpointingTimeoutDuration": "A String", # Endpoint timeout setting for matching dtmf input to regex. + "finishDigit": "A String", # The digit that terminates a DTMF digit sequence. + "interdigitTimeoutDuration": "A String", # Interdigit timeout setting for matching dtmf input to regex. + "maxDigits": 42, # Max length of DTMF digits. + }, + "loggingSettings": { # Define behaviors on logging. # Settings for logging. Settings for Dialogflow History, Contact Center messages, StackDriver logs, and speech logging. Exposed at the following levels: - Agent level. + "enableInteractionLogging": True or False, # Enables DF Interaction logging. + "enableStackdriverLogging": True or False, # Enables StackDriver logging. + }, + "speechSettings": { # Define behaviors of speech to text detection. # Settings for speech to text detection. Exposed at the following levels: - Agent level - Flow level - Page level - Parameter level + "endpointerSensitivity": 42, # Sensitivity of the speech model that detects the end of speech. Scale from 0 to 100. + "models": { # Mapping from language to Speech-to-Text model. The mapped Speech-to-Text model will be selected for requests from its corresponding language. For more information, see [Speech models](https://cloud.google.com/dialogflow/cx/docs/concept/speech-models). + "a_key": "A String", + }, + "noSpeechTimeout": "A String", # Timeout before detecting no speech. + "useTimeoutBasedEndpointing": True or False, # Use timeout based endpointing, interpreting endpointer sensitivy as seconds of timeout value. + }, + }, + "conditionalCases": [ # Conditional cases for this fulfillment. + { # A list of cascading if-else conditions. Cases are mutually exclusive. The first one with a matching condition is selected, all the rest ignored. + "cases": [ # A list of cascading if-else conditions. + { # Each case has a Boolean condition. When it is evaluated to be True, the corresponding messages will be selected and evaluated recursively. + "caseContent": [ # A list of case content. + { # The list of messages or conditional cases to activate for this case. + "additionalCases": # Object with schema name: GoogleCloudDialogflowCxV3beta1FulfillmentConditionalCases # Additional cases to be evaluated. + "message": { # 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. # Returned message. + "channel": "A String", # The channel which the response is associated with. Clients can specify the channel via QueryParameters.channel, and only associated channel response will be returned. + "conversationSuccess": { # 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. # Indicates that the conversation succeeded. + "metadata": { # Custom metadata. Dialogflow doesn't impose any structure on this. + "a_key": "", # Properties of the object. + }, + }, + "endInteraction": { # 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. # Output only. A signal that indicates the interaction with the Dialogflow agent has ended. This message is generated by Dialogflow only when the conversation reaches `END_SESSION` page. It is not supposed to be defined by the user. It's guaranteed that there is at most one such message in each response. + }, + "knowledgeInfoCard": { # Represents info card response. If the response contains generative knowledge prediction, Dialogflow will return a payload with Infobot Messenger compatible info card. Otherwise, the info card response is skipped. # Represents info card for knowledge answers, to be better rendered in Dialogflow Messenger. + }, + "liveAgentHandoff": { # 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. # Hands off conversation to a human agent. + "metadata": { # Custom metadata for your handoff procedure. Dialogflow doesn't impose any structure on this. + "a_key": "", # Properties of the object. + }, + }, + "mixedAudio": { # 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. # Output only. An audio response message composed of both the synthesized Dialogflow agent responses and responses defined via play_audio. This message is generated by Dialogflow only and not supposed to be defined by the user. + "segments": [ # Segments this audio response is composed of. + { # Represents one segment of audio. + "allowPlaybackInterruption": True or False, # 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. + "audio": "A String", # Raw audio synthesized from the Dialogflow agent's response using the output config specified in the request. + "uri": "A String", # Client-specific URI that points to an audio clip accessible to the client. Dialogflow does not impose any validation on it. + }, + ], + }, + "outputAudioText": { # A text or ssml response that is preferentially used for TTS output audio synthesis, as described in the comment on the ResponseMessage message. # A text or ssml response that is preferentially used for TTS output audio synthesis, as described in the comment on the ResponseMessage message. + "allowPlaybackInterruption": True or False, # 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. + "ssml": "A String", # The SSML text to be synthesized. For more information, see [SSML](/speech/text-to-speech/docs/ssml). + "text": "A String", # The raw text to be synthesized. + }, + "payload": { # Returns a response containing a custom, platform-specific payload. + "a_key": "", # Properties of the object. + }, + "playAudio": { # Specifies an audio clip to be played by the client as part of the response. # Signal that the client should play an audio clip hosted at a client-specific URI. Dialogflow uses this to construct mixed_audio. However, Dialogflow itself does not try to read or process the URI in any way. + "allowPlaybackInterruption": True or False, # 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. + "audioUri": "A String", # Required. URI of the audio clip. Dialogflow does not impose any validation on this value. It is specific to the client that reads it. + }, + "telephonyTransferCall": { # Represents the signal that telles the client to transfer the phone call connected to the agent to a third-party endpoint. # A signal that the client should transfer the phone call connected to this agent to a third-party endpoint. + "phoneNumber": "A String", # Transfer the call to a phone number in [E.164 format](https://en.wikipedia.org/wiki/E.164). + }, + "text": { # The text response message. # Returns a text response. + "allowPlaybackInterruption": True or False, # 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. + "text": [ # Required. A collection of text responses. + "A String", + ], + }, + "toolCall": { # Represents a call of a specific tool's action with the specified inputs. # Returns the definition of a tool call that should be executed by the client. + "action": "A String", # Required. The name of the tool's action associated with this call. + "inputParameters": { # Optional. The action's input parameters. + "a_key": "", # Properties of the object. + }, + "tool": "A String", # Required. The tool associated with this call. Format: `projects//locations//agents//tools/`. + }, + }, + }, + ], + "condition": "A String", # The condition to activate and select this case. Empty means the condition is always true. The condition is evaluated against form parameters or session parameters. See the [conditions reference](https://cloud.google.com/dialogflow/cx/docs/reference/condition). + }, + ], + }, + ], + "enableGenerativeFallback": True or False, # If the flag is true, the agent will utilize LLM to generate a text response. If LLM generation fails, the defined responses in the fulfillment will be respected. This flag is only useful for fulfillments associated with no-match event handlers. + "messages": [ # The list of rich message responses to present to the user. + { # 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. + "channel": "A String", # The channel which the response is associated with. Clients can specify the channel via QueryParameters.channel, and only associated channel response will be returned. + "conversationSuccess": { # 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. # Indicates that the conversation succeeded. + "metadata": { # Custom metadata. Dialogflow doesn't impose any structure on this. + "a_key": "", # Properties of the object. + }, + }, + "endInteraction": { # 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. # Output only. A signal that indicates the interaction with the Dialogflow agent has ended. This message is generated by Dialogflow only when the conversation reaches `END_SESSION` page. It is not supposed to be defined by the user. It's guaranteed that there is at most one such message in each response. + }, + "knowledgeInfoCard": { # Represents info card response. If the response contains generative knowledge prediction, Dialogflow will return a payload with Infobot Messenger compatible info card. Otherwise, the info card response is skipped. # Represents info card for knowledge answers, to be better rendered in Dialogflow Messenger. + }, + "liveAgentHandoff": { # 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. # Hands off conversation to a human agent. + "metadata": { # Custom metadata for your handoff procedure. Dialogflow doesn't impose any structure on this. + "a_key": "", # Properties of the object. + }, + }, + "mixedAudio": { # 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. # Output only. An audio response message composed of both the synthesized Dialogflow agent responses and responses defined via play_audio. This message is generated by Dialogflow only and not supposed to be defined by the user. + "segments": [ # Segments this audio response is composed of. + { # Represents one segment of audio. + "allowPlaybackInterruption": True or False, # 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. + "audio": "A String", # Raw audio synthesized from the Dialogflow agent's response using the output config specified in the request. + "uri": "A String", # Client-specific URI that points to an audio clip accessible to the client. Dialogflow does not impose any validation on it. + }, + ], + }, + "outputAudioText": { # A text or ssml response that is preferentially used for TTS output audio synthesis, as described in the comment on the ResponseMessage message. # A text or ssml response that is preferentially used for TTS output audio synthesis, as described in the comment on the ResponseMessage message. + "allowPlaybackInterruption": True or False, # 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. + "ssml": "A String", # The SSML text to be synthesized. For more information, see [SSML](/speech/text-to-speech/docs/ssml). + "text": "A String", # The raw text to be synthesized. + }, + "payload": { # Returns a response containing a custom, platform-specific payload. + "a_key": "", # Properties of the object. + }, + "playAudio": { # Specifies an audio clip to be played by the client as part of the response. # Signal that the client should play an audio clip hosted at a client-specific URI. Dialogflow uses this to construct mixed_audio. However, Dialogflow itself does not try to read or process the URI in any way. + "allowPlaybackInterruption": True or False, # 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. + "audioUri": "A String", # Required. URI of the audio clip. Dialogflow does not impose any validation on this value. It is specific to the client that reads it. + }, + "telephonyTransferCall": { # Represents the signal that telles the client to transfer the phone call connected to the agent to a third-party endpoint. # A signal that the client should transfer the phone call connected to this agent to a third-party endpoint. + "phoneNumber": "A String", # Transfer the call to a phone number in [E.164 format](https://en.wikipedia.org/wiki/E.164). + }, + "text": { # The text response message. # Returns a text response. + "allowPlaybackInterruption": True or False, # 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. + "text": [ # Required. A collection of text responses. + "A String", + ], + }, + "toolCall": { # Represents a call of a specific tool's action with the specified inputs. # Returns the definition of a tool call that should be executed by the client. + "action": "A String", # Required. The name of the tool's action associated with this call. + "inputParameters": { # Optional. The action's input parameters. + "a_key": "", # Properties of the object. + }, + "tool": "A String", # Required. The tool associated with this call. Format: `projects//locations//agents//tools/`. + }, + }, + ], + "returnPartialResponses": True or False, # Whether Dialogflow should return currently queued fulfillment response messages in streaming APIs. If a webhook is specified, it happens before Dialogflow invokes webhook. Warning: 1) This flag only affects streaming API. Responses are still queued and returned once in non-streaming API. 2) The flag can be enabled in any fulfillment but only the first 3 partial responses will be returned. You may only want to apply it to fulfillments that have slow webhooks. + "setParameterActions": [ # Set parameter values before executing the webhook. + { # Setting a parameter value. + "parameter": "A String", # Display name of the parameter. + "value": "", # The new value of the parameter. A null value clears the parameter. + }, + ], + "tag": "A String", # The value of this field will be populated in the WebhookRequest `fulfillmentInfo.tag` field by Dialogflow when the associated webhook is called. The tag is typically used by the webhook service to identify which fulfillment is being called, but it could be used for other purposes. This field is required if `webhook` is specified. + "webhook": "A String", # The webhook to call. Format: `projects//locations//agents//webhooks/`. + }, + }, + ], + }, + "isList": True or False, # Indicates whether the parameter represents a list of values. + "redact": True or False, # Indicates whether the parameter content should be redacted in log. If redaction is enabled, the parameter content will be replaced by parameter name during logging. Note: the parameter content is subject to redaction if either parameter level redaction or entity type level redaction is enabled. + "required": True or False, # 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. + }, + ], + }, + "knowledgeConnectorSettings": { # The Knowledge Connector settings for this page or flow. This includes information such as the attached Knowledge Bases, and the way to execute fulfillment. # Optional. Knowledge connector configuration. + "dataStoreConnections": [ # Optional. List of related data store connections. + { # A data store connection. It represents a data store in Discovery Engine and the type of the contents it contains. + "dataStore": "A String", # The full name of the referenced data store. Formats: `projects/{project}/locations/{location}/collections/{collection}/dataStores/{data_store}` `projects/{project}/locations/{location}/dataStores/{data_store}` + "dataStoreType": "A String", # The type of the connected data store. + }, + ], + "enabled": True or False, # Whether Knowledge Connector is enabled or not. + "targetFlow": "A String", # The target flow to transition to. Format: `projects//locations//agents//flows/`. + "targetPage": "A String", # The target page to transition to. Format: `projects//locations//agents//flows//pages/`. + "triggerFulfillment": { # A fulfillment can do one or more of the following actions at the same time: * Generate rich message responses. * Set parameter values. * Call the webhook. Fulfillments can be called at various stages in the Page or Form lifecycle. For example, when a DetectIntentRequest drives a session to enter a new page, the page's entry fulfillment can add a static response to the QueryResult in the returning DetectIntentResponse, call the webhook (for example, to load user data from a database), or both. # The fulfillment to be triggered. When the answers from the Knowledge Connector are selected by Dialogflow, you can utitlize the request scoped parameter `$request.knowledge.answers` (contains up to the 5 highest confidence answers) and `$request.knowledge.questions` (contains the corresponding questions) to construct the fulfillment. + "advancedSettings": { # Hierarchical advanced settings for agent/flow/page/fulfillment/parameter. Settings exposed at lower level overrides the settings exposed at higher level. Overriding occurs at the sub-setting level. For example, the playback_interruption_settings at fulfillment level only overrides the playback_interruption_settings at the agent level, leaving other settings at the agent level unchanged. DTMF settings does not override each other. DTMF settings set at different levels define DTMF detections running in parallel. Hierarchy: Agent->Flow->Page->Fulfillment/Parameter. # Hierarchical advanced settings for this fulfillment. The settings exposed at the lower level overrides the settings exposed at the higher level. + "audioExportGcsDestination": { # Google Cloud Storage location for a Dialogflow operation that writes or exports objects (e.g. exported agent or transcripts) outside of Dialogflow. # If present, incoming audio is exported by Dialogflow to the configured Google Cloud Storage destination. Exposed at the following levels: - Agent level - Flow level + "uri": "A String", # Required. The Google Cloud Storage URI for the exported objects. A URI is of the form: `gs://bucket/object-name-or-prefix` Whether a full object name, or just a prefix, its usage depends on the Dialogflow operation. + }, + "dtmfSettings": { # Define behaviors for DTMF (dual tone multi frequency). # Settings for DTMF. Exposed at the following levels: - Agent level - Flow level - Page level - Parameter level. + "enabled": True or False, # If true, incoming audio is processed for DTMF (dual tone multi frequency) events. For example, if the caller presses a button on their telephone keypad and DTMF processing is enabled, Dialogflow will detect the event (e.g. a "3" was pressed) in the incoming audio and pass the event to the bot to drive business logic (e.g. when 3 is pressed, return the account balance). + "endpointingTimeoutDuration": "A String", # Endpoint timeout setting for matching dtmf input to regex. + "finishDigit": "A String", # The digit that terminates a DTMF digit sequence. + "interdigitTimeoutDuration": "A String", # Interdigit timeout setting for matching dtmf input to regex. + "maxDigits": 42, # Max length of DTMF digits. + }, + "loggingSettings": { # Define behaviors on logging. # Settings for logging. Settings for Dialogflow History, Contact Center messages, StackDriver logs, and speech logging. Exposed at the following levels: - Agent level. + "enableInteractionLogging": True or False, # Enables DF Interaction logging. + "enableStackdriverLogging": True or False, # Enables StackDriver logging. + }, + "speechSettings": { # Define behaviors of speech to text detection. # Settings for speech to text detection. Exposed at the following levels: - Agent level - Flow level - Page level - Parameter level + "endpointerSensitivity": 42, # Sensitivity of the speech model that detects the end of speech. Scale from 0 to 100. + "models": { # Mapping from language to Speech-to-Text model. The mapped Speech-to-Text model will be selected for requests from its corresponding language. For more information, see [Speech models](https://cloud.google.com/dialogflow/cx/docs/concept/speech-models). + "a_key": "A String", + }, + "noSpeechTimeout": "A String", # Timeout before detecting no speech. + "useTimeoutBasedEndpointing": True or False, # Use timeout based endpointing, interpreting endpointer sensitivy as seconds of timeout value. + }, + }, + "conditionalCases": [ # Conditional cases for this fulfillment. + { # A list of cascading if-else conditions. Cases are mutually exclusive. The first one with a matching condition is selected, all the rest ignored. + "cases": [ # A list of cascading if-else conditions. + { # Each case has a Boolean condition. When it is evaluated to be True, the corresponding messages will be selected and evaluated recursively. + "caseContent": [ # A list of case content. + { # The list of messages or conditional cases to activate for this case. + "additionalCases": # Object with schema name: GoogleCloudDialogflowCxV3beta1FulfillmentConditionalCases # Additional cases to be evaluated. + "message": { # 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. # Returned message. + "channel": "A String", # The channel which the response is associated with. Clients can specify the channel via QueryParameters.channel, and only associated channel response will be returned. + "conversationSuccess": { # 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. # Indicates that the conversation succeeded. + "metadata": { # Custom metadata. Dialogflow doesn't impose any structure on this. + "a_key": "", # Properties of the object. + }, + }, + "endInteraction": { # 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. # Output only. A signal that indicates the interaction with the Dialogflow agent has ended. This message is generated by Dialogflow only when the conversation reaches `END_SESSION` page. It is not supposed to be defined by the user. It's guaranteed that there is at most one such message in each response. + }, + "knowledgeInfoCard": { # Represents info card response. If the response contains generative knowledge prediction, Dialogflow will return a payload with Infobot Messenger compatible info card. Otherwise, the info card response is skipped. # Represents info card for knowledge answers, to be better rendered in Dialogflow Messenger. + }, + "liveAgentHandoff": { # 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. # Hands off conversation to a human agent. + "metadata": { # Custom metadata for your handoff procedure. Dialogflow doesn't impose any structure on this. + "a_key": "", # Properties of the object. + }, + }, + "mixedAudio": { # 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. # Output only. An audio response message composed of both the synthesized Dialogflow agent responses and responses defined via play_audio. This message is generated by Dialogflow only and not supposed to be defined by the user. + "segments": [ # Segments this audio response is composed of. + { # Represents one segment of audio. + "allowPlaybackInterruption": True or False, # 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. + "audio": "A String", # Raw audio synthesized from the Dialogflow agent's response using the output config specified in the request. + "uri": "A String", # Client-specific URI that points to an audio clip accessible to the client. Dialogflow does not impose any validation on it. + }, + ], + }, + "outputAudioText": { # A text or ssml response that is preferentially used for TTS output audio synthesis, as described in the comment on the ResponseMessage message. # A text or ssml response that is preferentially used for TTS output audio synthesis, as described in the comment on the ResponseMessage message. + "allowPlaybackInterruption": True or False, # 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. + "ssml": "A String", # The SSML text to be synthesized. For more information, see [SSML](/speech/text-to-speech/docs/ssml). + "text": "A String", # The raw text to be synthesized. + }, + "payload": { # Returns a response containing a custom, platform-specific payload. + "a_key": "", # Properties of the object. + }, + "playAudio": { # Specifies an audio clip to be played by the client as part of the response. # Signal that the client should play an audio clip hosted at a client-specific URI. Dialogflow uses this to construct mixed_audio. However, Dialogflow itself does not try to read or process the URI in any way. + "allowPlaybackInterruption": True or False, # 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. + "audioUri": "A String", # Required. URI of the audio clip. Dialogflow does not impose any validation on this value. It is specific to the client that reads it. + }, + "telephonyTransferCall": { # Represents the signal that telles the client to transfer the phone call connected to the agent to a third-party endpoint. # A signal that the client should transfer the phone call connected to this agent to a third-party endpoint. + "phoneNumber": "A String", # Transfer the call to a phone number in [E.164 format](https://en.wikipedia.org/wiki/E.164). + }, + "text": { # The text response message. # Returns a text response. + "allowPlaybackInterruption": True or False, # 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. + "text": [ # Required. A collection of text responses. + "A String", + ], + }, + "toolCall": { # Represents a call of a specific tool's action with the specified inputs. # Returns the definition of a tool call that should be executed by the client. + "action": "A String", # Required. The name of the tool's action associated with this call. + "inputParameters": { # Optional. The action's input parameters. + "a_key": "", # Properties of the object. + }, + "tool": "A String", # Required. The tool associated with this call. Format: `projects//locations//agents//tools/`. + }, + }, + }, + ], + "condition": "A String", # The condition to activate and select this case. Empty means the condition is always true. The condition is evaluated against form parameters or session parameters. See the [conditions reference](https://cloud.google.com/dialogflow/cx/docs/reference/condition). + }, + ], + }, + ], + "enableGenerativeFallback": True or False, # If the flag is true, the agent will utilize LLM to generate a text response. If LLM generation fails, the defined responses in the fulfillment will be respected. This flag is only useful for fulfillments associated with no-match event handlers. + "messages": [ # The list of rich message responses to present to the user. + { # 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. + "channel": "A String", # The channel which the response is associated with. Clients can specify the channel via QueryParameters.channel, and only associated channel response will be returned. + "conversationSuccess": { # 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. # Indicates that the conversation succeeded. + "metadata": { # Custom metadata. Dialogflow doesn't impose any structure on this. + "a_key": "", # Properties of the object. + }, + }, + "endInteraction": { # 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. # Output only. A signal that indicates the interaction with the Dialogflow agent has ended. This message is generated by Dialogflow only when the conversation reaches `END_SESSION` page. It is not supposed to be defined by the user. It's guaranteed that there is at most one such message in each response. + }, + "knowledgeInfoCard": { # Represents info card response. If the response contains generative knowledge prediction, Dialogflow will return a payload with Infobot Messenger compatible info card. Otherwise, the info card response is skipped. # Represents info card for knowledge answers, to be better rendered in Dialogflow Messenger. + }, + "liveAgentHandoff": { # 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. # Hands off conversation to a human agent. + "metadata": { # Custom metadata for your handoff procedure. Dialogflow doesn't impose any structure on this. + "a_key": "", # Properties of the object. + }, + }, + "mixedAudio": { # 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. # Output only. An audio response message composed of both the synthesized Dialogflow agent responses and responses defined via play_audio. This message is generated by Dialogflow only and not supposed to be defined by the user. + "segments": [ # Segments this audio response is composed of. + { # Represents one segment of audio. + "allowPlaybackInterruption": True or False, # 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. + "audio": "A String", # Raw audio synthesized from the Dialogflow agent's response using the output config specified in the request. + "uri": "A String", # Client-specific URI that points to an audio clip accessible to the client. Dialogflow does not impose any validation on it. + }, + ], + }, + "outputAudioText": { # A text or ssml response that is preferentially used for TTS output audio synthesis, as described in the comment on the ResponseMessage message. # A text or ssml response that is preferentially used for TTS output audio synthesis, as described in the comment on the ResponseMessage message. + "allowPlaybackInterruption": True or False, # 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. + "ssml": "A String", # The SSML text to be synthesized. For more information, see [SSML](/speech/text-to-speech/docs/ssml). + "text": "A String", # The raw text to be synthesized. + }, + "payload": { # Returns a response containing a custom, platform-specific payload. + "a_key": "", # Properties of the object. + }, + "playAudio": { # Specifies an audio clip to be played by the client as part of the response. # Signal that the client should play an audio clip hosted at a client-specific URI. Dialogflow uses this to construct mixed_audio. However, Dialogflow itself does not try to read or process the URI in any way. + "allowPlaybackInterruption": True or False, # 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. + "audioUri": "A String", # Required. URI of the audio clip. Dialogflow does not impose any validation on this value. It is specific to the client that reads it. + }, + "telephonyTransferCall": { # Represents the signal that telles the client to transfer the phone call connected to the agent to a third-party endpoint. # A signal that the client should transfer the phone call connected to this agent to a third-party endpoint. + "phoneNumber": "A String", # Transfer the call to a phone number in [E.164 format](https://en.wikipedia.org/wiki/E.164). + }, + "text": { # The text response message. # Returns a text response. + "allowPlaybackInterruption": True or False, # 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. + "text": [ # Required. A collection of text responses. + "A String", + ], + }, + "toolCall": { # Represents a call of a specific tool's action with the specified inputs. # Returns the definition of a tool call that should be executed by the client. + "action": "A String", # Required. The name of the tool's action associated with this call. + "inputParameters": { # Optional. The action's input parameters. + "a_key": "", # Properties of the object. + }, + "tool": "A String", # Required. The tool associated with this call. Format: `projects//locations//agents//tools/`. + }, + }, + ], + "returnPartialResponses": True or False, # Whether Dialogflow should return currently queued fulfillment response messages in streaming APIs. If a webhook is specified, it happens before Dialogflow invokes webhook. Warning: 1) This flag only affects streaming API. Responses are still queued and returned once in non-streaming API. 2) The flag can be enabled in any fulfillment but only the first 3 partial responses will be returned. You may only want to apply it to fulfillments that have slow webhooks. + "setParameterActions": [ # Set parameter values before executing the webhook. + { # Setting a parameter value. + "parameter": "A String", # Display name of the parameter. + "value": "", # The new value of the parameter. A null value clears the parameter. + }, + ], + "tag": "A String", # The value of this field will be populated in the WebhookRequest `fulfillmentInfo.tag` field by Dialogflow when the associated webhook is called. The tag is typically used by the webhook service to identify which fulfillment is being called, but it could be used for other purposes. This field is required if `webhook` is specified. + "webhook": "A String", # The webhook to call. Format: `projects//locations//agents//webhooks/`. + }, + }, + "name": "A String", # The unique identifier of the page. Required for the Pages.UpdatePage method. Pages.CreatePage populates the name automatically. Format: `projects//locations//agents//flows//pages/`. + "transitionRouteGroups": [ # Ordered list of `TransitionRouteGroups` added to the page. Transition route groups must be unique within a page. If the page links both flow-level transition route groups and agent-level transition route groups, the flow-level ones will have higher priority and will be put before the agent-level ones. * If multiple transition routes within a page scope refer to the same intent, then the precedence order is: page's transition route -> page's transition route group -> flow's transition routes. * If multiple transition route groups within a page contain the same intent, then the first group in the ordered list takes precedence. Format:`projects//locations//agents//flows//transitionRouteGroups/` or `projects//locations//agents//transitionRouteGroups/` for agent-level groups. + "A String", + ], + "transitionRoutes": [ # A list of transitions for the transition rules of this page. They route the conversation to another page in the same flow, or another flow. When we are in a certain page, the TransitionRoutes are evalauted in the following order: * TransitionRoutes defined in the page with intent specified. * TransitionRoutes defined in the transition route groups with intent specified. * TransitionRoutes defined in flow with intent specified. * TransitionRoutes defined in the transition route groups with intent specified. * TransitionRoutes defined in the page with only condition specified. * TransitionRoutes defined in the transition route groups with only condition specified. + { # A transition route specifies a intent that can be matched and/or a data condition that can be evaluated during a session. When a specified transition is matched, the following actions are taken in order: * If there is a `trigger_fulfillment` associated with the transition, it will be called. * If there is a `target_page` associated with the transition, the session will transition into the specified page. * If there is a `target_flow` associated with the transition, the session will transition into the specified flow. + "condition": "A String", # The condition to evaluate against form parameters or session parameters. See the [conditions reference](https://cloud.google.com/dialogflow/cx/docs/reference/condition). At least one of `intent` or `condition` must be specified. When both `intent` and `condition` are specified, the transition can only happen when both are fulfilled. + "description": "A String", # Optional. The description of the transition route. The maximum length is 500 characters. + "intent": "A String", # The unique identifier of an Intent. Format: `projects//locations//agents//intents/`. Indicates that the transition can only happen when the given intent is matched. At least one of `intent` or `condition` must be specified. When both `intent` and `condition` are specified, the transition can only happen when both are fulfilled. + "name": "A String", # Output only. The unique identifier of this transition route. + "targetFlow": "A String", # The target flow to transition to. Format: `projects//locations//agents//flows/`. + "targetPage": "A String", # The target page to transition to. Format: `projects//locations//agents//flows//pages/`. + "triggerFulfillment": { # A fulfillment can do one or more of the following actions at the same time: * Generate rich message responses. * Set parameter values. * Call the webhook. Fulfillments can be called at various stages in the Page or Form lifecycle. For example, when a DetectIntentRequest drives a session to enter a new page, the page's entry fulfillment can add a static response to the QueryResult in the returning DetectIntentResponse, call the webhook (for example, to load user data from a database), or both. # The fulfillment to call when the condition is satisfied. At least one of `trigger_fulfillment` and `target` must be specified. When both are defined, `trigger_fulfillment` is executed first. + "advancedSettings": { # Hierarchical advanced settings for agent/flow/page/fulfillment/parameter. Settings exposed at lower level overrides the settings exposed at higher level. Overriding occurs at the sub-setting level. For example, the playback_interruption_settings at fulfillment level only overrides the playback_interruption_settings at the agent level, leaving other settings at the agent level unchanged. DTMF settings does not override each other. DTMF settings set at different levels define DTMF detections running in parallel. Hierarchy: Agent->Flow->Page->Fulfillment/Parameter. # Hierarchical advanced settings for this fulfillment. The settings exposed at the lower level overrides the settings exposed at the higher level. + "audioExportGcsDestination": { # Google Cloud Storage location for a Dialogflow operation that writes or exports objects (e.g. exported agent or transcripts) outside of Dialogflow. # If present, incoming audio is exported by Dialogflow to the configured Google Cloud Storage destination. Exposed at the following levels: - Agent level - Flow level + "uri": "A String", # Required. The Google Cloud Storage URI for the exported objects. A URI is of the form: `gs://bucket/object-name-or-prefix` Whether a full object name, or just a prefix, its usage depends on the Dialogflow operation. + }, + "dtmfSettings": { # Define behaviors for DTMF (dual tone multi frequency). # Settings for DTMF. Exposed at the following levels: - Agent level - Flow level - Page level - Parameter level. + "enabled": True or False, # If true, incoming audio is processed for DTMF (dual tone multi frequency) events. For example, if the caller presses a button on their telephone keypad and DTMF processing is enabled, Dialogflow will detect the event (e.g. a "3" was pressed) in the incoming audio and pass the event to the bot to drive business logic (e.g. when 3 is pressed, return the account balance). + "endpointingTimeoutDuration": "A String", # Endpoint timeout setting for matching dtmf input to regex. + "finishDigit": "A String", # The digit that terminates a DTMF digit sequence. + "interdigitTimeoutDuration": "A String", # Interdigit timeout setting for matching dtmf input to regex. + "maxDigits": 42, # Max length of DTMF digits. + }, + "loggingSettings": { # Define behaviors on logging. # Settings for logging. Settings for Dialogflow History, Contact Center messages, StackDriver logs, and speech logging. Exposed at the following levels: - Agent level. + "enableInteractionLogging": True or False, # Enables DF Interaction logging. + "enableStackdriverLogging": True or False, # Enables StackDriver logging. + }, + "speechSettings": { # Define behaviors of speech to text detection. # Settings for speech to text detection. Exposed at the following levels: - Agent level - Flow level - Page level - Parameter level + "endpointerSensitivity": 42, # Sensitivity of the speech model that detects the end of speech. Scale from 0 to 100. + "models": { # Mapping from language to Speech-to-Text model. The mapped Speech-to-Text model will be selected for requests from its corresponding language. For more information, see [Speech models](https://cloud.google.com/dialogflow/cx/docs/concept/speech-models). + "a_key": "A String", + }, + "noSpeechTimeout": "A String", # Timeout before detecting no speech. + "useTimeoutBasedEndpointing": True or False, # Use timeout based endpointing, interpreting endpointer sensitivy as seconds of timeout value. + }, + }, + "conditionalCases": [ # Conditional cases for this fulfillment. + { # A list of cascading if-else conditions. Cases are mutually exclusive. The first one with a matching condition is selected, all the rest ignored. + "cases": [ # A list of cascading if-else conditions. + { # Each case has a Boolean condition. When it is evaluated to be True, the corresponding messages will be selected and evaluated recursively. + "caseContent": [ # A list of case content. + { # The list of messages or conditional cases to activate for this case. + "additionalCases": # Object with schema name: GoogleCloudDialogflowCxV3beta1FulfillmentConditionalCases # Additional cases to be evaluated. + "message": { # 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. # Returned message. + "channel": "A String", # The channel which the response is associated with. Clients can specify the channel via QueryParameters.channel, and only associated channel response will be returned. + "conversationSuccess": { # 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. # Indicates that the conversation succeeded. + "metadata": { # Custom metadata. Dialogflow doesn't impose any structure on this. + "a_key": "", # Properties of the object. + }, + }, + "endInteraction": { # 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. # Output only. A signal that indicates the interaction with the Dialogflow agent has ended. This message is generated by Dialogflow only when the conversation reaches `END_SESSION` page. It is not supposed to be defined by the user. It's guaranteed that there is at most one such message in each response. + }, + "knowledgeInfoCard": { # Represents info card response. If the response contains generative knowledge prediction, Dialogflow will return a payload with Infobot Messenger compatible info card. Otherwise, the info card response is skipped. # Represents info card for knowledge answers, to be better rendered in Dialogflow Messenger. + }, + "liveAgentHandoff": { # 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. # Hands off conversation to a human agent. + "metadata": { # Custom metadata for your handoff procedure. Dialogflow doesn't impose any structure on this. + "a_key": "", # Properties of the object. + }, + }, + "mixedAudio": { # 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. # Output only. An audio response message composed of both the synthesized Dialogflow agent responses and responses defined via play_audio. This message is generated by Dialogflow only and not supposed to be defined by the user. + "segments": [ # Segments this audio response is composed of. + { # Represents one segment of audio. + "allowPlaybackInterruption": True or False, # 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. + "audio": "A String", # Raw audio synthesized from the Dialogflow agent's response using the output config specified in the request. + "uri": "A String", # Client-specific URI that points to an audio clip accessible to the client. Dialogflow does not impose any validation on it. + }, + ], + }, + "outputAudioText": { # A text or ssml response that is preferentially used for TTS output audio synthesis, as described in the comment on the ResponseMessage message. # A text or ssml response that is preferentially used for TTS output audio synthesis, as described in the comment on the ResponseMessage message. + "allowPlaybackInterruption": True or False, # 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. + "ssml": "A String", # The SSML text to be synthesized. For more information, see [SSML](/speech/text-to-speech/docs/ssml). + "text": "A String", # The raw text to be synthesized. + }, + "payload": { # Returns a response containing a custom, platform-specific payload. + "a_key": "", # Properties of the object. + }, + "playAudio": { # Specifies an audio clip to be played by the client as part of the response. # Signal that the client should play an audio clip hosted at a client-specific URI. Dialogflow uses this to construct mixed_audio. However, Dialogflow itself does not try to read or process the URI in any way. + "allowPlaybackInterruption": True or False, # 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. + "audioUri": "A String", # Required. URI of the audio clip. Dialogflow does not impose any validation on this value. It is specific to the client that reads it. + }, + "telephonyTransferCall": { # Represents the signal that telles the client to transfer the phone call connected to the agent to a third-party endpoint. # A signal that the client should transfer the phone call connected to this agent to a third-party endpoint. + "phoneNumber": "A String", # Transfer the call to a phone number in [E.164 format](https://en.wikipedia.org/wiki/E.164). + }, + "text": { # The text response message. # Returns a text response. + "allowPlaybackInterruption": True or False, # 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. + "text": [ # Required. A collection of text responses. + "A String", + ], + }, + "toolCall": { # Represents a call of a specific tool's action with the specified inputs. # Returns the definition of a tool call that should be executed by the client. + "action": "A String", # Required. The name of the tool's action associated with this call. + "inputParameters": { # Optional. The action's input parameters. + "a_key": "", # Properties of the object. + }, + "tool": "A String", # Required. The tool associated with this call. Format: `projects//locations//agents//tools/`. + }, + }, + }, + ], + "condition": "A String", # The condition to activate and select this case. Empty means the condition is always true. The condition is evaluated against form parameters or session parameters. See the [conditions reference](https://cloud.google.com/dialogflow/cx/docs/reference/condition). + }, + ], + }, + ], + "enableGenerativeFallback": True or False, # If the flag is true, the agent will utilize LLM to generate a text response. If LLM generation fails, the defined responses in the fulfillment will be respected. This flag is only useful for fulfillments associated with no-match event handlers. + "messages": [ # The list of rich message responses to present to the user. + { # 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. + "channel": "A String", # The channel which the response is associated with. Clients can specify the channel via QueryParameters.channel, and only associated channel response will be returned. + "conversationSuccess": { # 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. # Indicates that the conversation succeeded. + "metadata": { # Custom metadata. Dialogflow doesn't impose any structure on this. + "a_key": "", # Properties of the object. + }, + }, + "endInteraction": { # 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. # Output only. A signal that indicates the interaction with the Dialogflow agent has ended. This message is generated by Dialogflow only when the conversation reaches `END_SESSION` page. It is not supposed to be defined by the user. It's guaranteed that there is at most one such message in each response. + }, + "knowledgeInfoCard": { # Represents info card response. If the response contains generative knowledge prediction, Dialogflow will return a payload with Infobot Messenger compatible info card. Otherwise, the info card response is skipped. # Represents info card for knowledge answers, to be better rendered in Dialogflow Messenger. + }, + "liveAgentHandoff": { # 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. # Hands off conversation to a human agent. + "metadata": { # Custom metadata for your handoff procedure. Dialogflow doesn't impose any structure on this. + "a_key": "", # Properties of the object. + }, + }, + "mixedAudio": { # 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. # Output only. An audio response message composed of both the synthesized Dialogflow agent responses and responses defined via play_audio. This message is generated by Dialogflow only and not supposed to be defined by the user. + "segments": [ # Segments this audio response is composed of. + { # Represents one segment of audio. + "allowPlaybackInterruption": True or False, # 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. + "audio": "A String", # Raw audio synthesized from the Dialogflow agent's response using the output config specified in the request. + "uri": "A String", # Client-specific URI that points to an audio clip accessible to the client. Dialogflow does not impose any validation on it. + }, + ], + }, + "outputAudioText": { # A text or ssml response that is preferentially used for TTS output audio synthesis, as described in the comment on the ResponseMessage message. # A text or ssml response that is preferentially used for TTS output audio synthesis, as described in the comment on the ResponseMessage message. + "allowPlaybackInterruption": True or False, # 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. + "ssml": "A String", # The SSML text to be synthesized. For more information, see [SSML](/speech/text-to-speech/docs/ssml). + "text": "A String", # The raw text to be synthesized. + }, + "payload": { # Returns a response containing a custom, platform-specific payload. + "a_key": "", # Properties of the object. + }, + "playAudio": { # Specifies an audio clip to be played by the client as part of the response. # Signal that the client should play an audio clip hosted at a client-specific URI. Dialogflow uses this to construct mixed_audio. However, Dialogflow itself does not try to read or process the URI in any way. + "allowPlaybackInterruption": True or False, # 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. + "audioUri": "A String", # Required. URI of the audio clip. Dialogflow does not impose any validation on this value. It is specific to the client that reads it. + }, + "telephonyTransferCall": { # Represents the signal that telles the client to transfer the phone call connected to the agent to a third-party endpoint. # A signal that the client should transfer the phone call connected to this agent to a third-party endpoint. + "phoneNumber": "A String", # Transfer the call to a phone number in [E.164 format](https://en.wikipedia.org/wiki/E.164). + }, + "text": { # The text response message. # Returns a text response. + "allowPlaybackInterruption": True or False, # 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. + "text": [ # Required. A collection of text responses. + "A String", + ], + }, + "toolCall": { # Represents a call of a specific tool's action with the specified inputs. # Returns the definition of a tool call that should be executed by the client. + "action": "A String", # Required. The name of the tool's action associated with this call. + "inputParameters": { # Optional. The action's input parameters. + "a_key": "", # Properties of the object. + }, + "tool": "A String", # Required. The tool associated with this call. Format: `projects//locations//agents//tools/`. + }, + }, + ], + "returnPartialResponses": True or False, # Whether Dialogflow should return currently queued fulfillment response messages in streaming APIs. If a webhook is specified, it happens before Dialogflow invokes webhook. Warning: 1) This flag only affects streaming API. Responses are still queued and returned once in non-streaming API. 2) The flag can be enabled in any fulfillment but only the first 3 partial responses will be returned. You may only want to apply it to fulfillments that have slow webhooks. + "setParameterActions": [ # Set parameter values before executing the webhook. + { # Setting a parameter value. + "parameter": "A String", # Display name of the parameter. + "value": "", # The new value of the parameter. A null value clears the parameter. + }, + ], + "tag": "A String", # The value of this field will be populated in the WebhookRequest `fulfillmentInfo.tag` field by Dialogflow when the associated webhook is called. The tag is typically used by the webhook service to identify which fulfillment is being called, but it could be used for other purposes. This field is required if `webhook` is specified. + "webhook": "A String", # The webhook to call. Format: `projects//locations//agents//webhooks/`. + }, + }, + ], + }, + ], + "startTime": "A String", # Start time of the conversation, which is the time of the first request of the conversation. + "type": "A String", # The type of the conversation. +}
+
+ +
+ list(parent, filter=None, pageSize=None, pageToken=None, x__xgafv=None) +
Returns the list of all conversations.
+
+Args:
+  parent: string, Required. The agent to list all conversations for. Format: `projects//locations//agents/`. (required)
+  filter: string, Optional. The filter string. Supports filter by create_time, metrics.has_end_interaction, metrics.has_live_agent_handoff, intents.display_name, pages.display_name and flows.display_name. Timestamps expect an RFC-3339 formatted string (e.g. 2012-04-21T11:30:00-04:00). UTC offsets are supported. Some examples: 1. By create time: create_time > "2022-04-21T11:30:00-04:00" 2. By intent display name: intents.display_name : "billing" 3. By end interaction signal: metrics.has_end_interaction = true
+  pageSize: integer, Optional. The maximum number of items to return in a single page. By default 100 and at most 1000.
+  pageToken: string, Optional. The next_page_token value returned from a previous list request.
+  x__xgafv: string, V1 error format.
+    Allowed values
+      1 - v1 error format
+      2 - v2 error format
+
+Returns:
+  An object of the form:
+
+    { # The response message for Conversations.ListConversations.
+  "conversations": [ # The list of conversations. There will be a maximum number of items returned based on the page_size field. The returned conversations will be sorted by start_time in descending order (newest conversation first).
+    { # Represents a conversation.
+      "duration": "A String", # Duration of the conversation.
+      "environment": { # Represents an environment for an agent. You can create multiple versions of your agent and publish them to separate environments. When you edit an agent, you are editing the draft agent. At any point, you can save the draft agent as an agent version, which is an immutable snapshot of your agent. When you save the draft agent, it is published to the default environment. When you create agent versions, you can publish them to custom environments. You can create a variety of custom environments for testing, development, production, etc. # Environment of the conversation. Only `name` and `display_name` are filled in this message.
+        "description": "A String", # The human-readable description of the environment. The maximum length is 500 characters. If exceeded, the request is rejected.
+        "displayName": "A String", # Required. The human-readable name of the environment (unique in an agent). Limit of 64 characters.
+        "name": "A String", # The name of the environment. Format: `projects//locations//agents//environments/`.
+        "testCasesConfig": { # The configuration for continuous tests. # The test cases config for continuous tests of this environment.
+          "enableContinuousRun": True or False, # Whether to run test cases in TestCasesConfig.test_cases periodically. Default false. If set to true, run once a day.
+          "enablePredeploymentRun": True or False, # Whether to run test cases in TestCasesConfig.test_cases before deploying a flow version to the environment. Default false.
+          "testCases": [ # A list of test case names to run. They should be under the same agent. Format of each test case name: `projects//locations/ /agents//testCases/`
+            "A String",
+          ],
+        },
+        "updateTime": "A String", # Output only. Update time of this environment.
+        "versionConfigs": [ # A list of configurations for flow versions. You should include version configs for all flows that are reachable from `Start Flow` in the agent. Otherwise, an error will be returned.
+          { # Configuration for the version.
+            "version": "A String", # Required. Format: projects//locations//agents//flows//versions/.
+          },
+        ],
+        "webhookConfig": { # Configuration for webhooks. # The webhook configuration for this environment.
+          "webhookOverrides": [ # The list of webhooks to override for the agent environment. The webhook must exist in the agent. You can override fields in `generic_web_service` and `service_directory`.
+            { # Webhooks host the developer's business logic. During a session, webhooks allow the developer to use the data extracted by Dialogflow's natural language processing to generate dynamic responses, validate collected data, or trigger actions on the backend.
+              "disabled": True or False, # Indicates whether the webhook is disabled.
+              "displayName": "A String", # Required. The human-readable name of the webhook, unique within the agent.
+              "genericWebService": { # Represents configuration for a generic web service. # Configuration for a generic web service.
+                "allowedCaCerts": [ # Optional. Specifies a list of allowed custom CA certificates (in DER format) for HTTPS verification. This overrides the default SSL trust store. If this is empty or unspecified, Dialogflow will use Google's default trust store to verify certificates. N.B. Make sure the HTTPS server certificates are signed with "subject alt name". For instance a certificate can be self-signed using the following command, ``` openssl x509 -req -days 200 -in example.com.csr \ -signkey example.com.key \ -out example.com.crt \ -extfile <(printf "\nsubjectAltName='DNS:www.example.com'") ```
+                  "A String",
+                ],
+                "httpMethod": "A String", # Optional. HTTP method for the flexible webhook calls. Standard webhook always uses POST.
+                "oauthConfig": { # Represents configuration of OAuth client credential flow for 3rd party API authentication. # Optional. The OAuth configuration of the webhook. If specified, Dialogflow will initiate the OAuth client credential flow to exchange an access token from the 3rd party platform and put it in the auth header.
+                  "clientId": "A String", # Required. The client ID provided by the 3rd party platform.
+                  "clientSecret": "A String", # Required. The client secret provided by the 3rd party platform.
+                  "scopes": [ # Optional. The OAuth scopes to grant.
+                    "A String",
+                  ],
+                  "tokenEndpoint": "A String", # Required. The token endpoint provided by the 3rd party platform to exchange an access token.
+                },
+                "parameterMapping": { # Optional. Maps the values extracted from specific fields of the flexible webhook response into session parameters. - Key: session parameter name - Value: field path in the webhook response
+                  "a_key": "A String",
+                },
+                "password": "A String", # The password for HTTP Basic authentication.
+                "requestBody": "A String", # Optional. Defines a custom JSON object as request body to send to flexible webhook.
+                "requestHeaders": { # The HTTP request headers to send together with webhook requests.
+                  "a_key": "A String",
+                },
+                "serviceAgentAuth": "A String", # Optional. Indicate the auth token type generated from the [Diglogflow service agent](https://cloud.google.com/iam/docs/service-agents#dialogflow-service-agent). The generated token is sent in the Authorization header.
+                "uri": "A String", # Required. The webhook URI for receiving POST requests. It must use https protocol.
+                "username": "A String", # The user name for HTTP Basic authentication.
+                "webhookType": "A String", # Optional. Type of the webhook.
+              },
+              "name": "A String", # The unique identifier of the webhook. Required for the Webhooks.UpdateWebhook method. Webhooks.CreateWebhook populates the name automatically. Format: `projects//locations//agents//webhooks/`.
+              "serviceDirectory": { # Represents configuration for a [Service Directory](https://cloud.google.com/service-directory) service. # Configuration for a [Service Directory](https://cloud.google.com/service-directory) service.
+                "genericWebService": { # Represents configuration for a generic web service. # Generic Service configuration of this webhook.
+                  "allowedCaCerts": [ # Optional. Specifies a list of allowed custom CA certificates (in DER format) for HTTPS verification. This overrides the default SSL trust store. If this is empty or unspecified, Dialogflow will use Google's default trust store to verify certificates. N.B. Make sure the HTTPS server certificates are signed with "subject alt name". For instance a certificate can be self-signed using the following command, ``` openssl x509 -req -days 200 -in example.com.csr \ -signkey example.com.key \ -out example.com.crt \ -extfile <(printf "\nsubjectAltName='DNS:www.example.com'") ```
+                    "A String",
+                  ],
+                  "httpMethod": "A String", # Optional. HTTP method for the flexible webhook calls. Standard webhook always uses POST.
+                  "oauthConfig": { # Represents configuration of OAuth client credential flow for 3rd party API authentication. # Optional. The OAuth configuration of the webhook. If specified, Dialogflow will initiate the OAuth client credential flow to exchange an access token from the 3rd party platform and put it in the auth header.
+                    "clientId": "A String", # Required. The client ID provided by the 3rd party platform.
+                    "clientSecret": "A String", # Required. The client secret provided by the 3rd party platform.
+                    "scopes": [ # Optional. The OAuth scopes to grant.
+                      "A String",
+                    ],
+                    "tokenEndpoint": "A String", # Required. The token endpoint provided by the 3rd party platform to exchange an access token.
+                  },
+                  "parameterMapping": { # Optional. Maps the values extracted from specific fields of the flexible webhook response into session parameters. - Key: session parameter name - Value: field path in the webhook response
+                    "a_key": "A String",
+                  },
+                  "password": "A String", # The password for HTTP Basic authentication.
+                  "requestBody": "A String", # Optional. Defines a custom JSON object as request body to send to flexible webhook.
+                  "requestHeaders": { # The HTTP request headers to send together with webhook requests.
+                    "a_key": "A String",
+                  },
+                  "serviceAgentAuth": "A String", # Optional. Indicate the auth token type generated from the [Diglogflow service agent](https://cloud.google.com/iam/docs/service-agents#dialogflow-service-agent). The generated token is sent in the Authorization header.
+                  "uri": "A String", # Required. The webhook URI for receiving POST requests. It must use https protocol.
+                  "username": "A String", # The user name for HTTP Basic authentication.
+                  "webhookType": "A String", # Optional. Type of the webhook.
+                },
+                "service": "A String", # Required. The name of [Service Directory](https://cloud.google.com/service-directory) service. Format: `projects//locations//namespaces//services/`. `Location ID` of the service directory must be the same as the location of the agent.
+              },
+              "timeout": "A String", # Webhook execution timeout. Execution is considered failed if Dialogflow doesn't receive a response from webhook at the end of the timeout period. Defaults to 5 seconds, maximum allowed timeout is 30 seconds.
+            },
+          ],
+        },
+      },
+      "flowVersions": { # Flow versions used in the conversation.
+        "a_key": "A String",
+      },
+      "flows": [ # All the Flow the conversation has went through. Only `name` and `display_name` are filled in this message.
+        { # Flows represents the conversation flows when you build your chatbot agent. A flow consists of many pages connected by the transition routes. Conversations always start with the built-in Start Flow (with an all-0 ID). Transition routes can direct the conversation session from the current flow (parent flow) to another flow (sub flow). When the sub flow is finished, Dialogflow will bring the session back to the parent flow, where the sub flow is started. Usually, when a transition route is followed by a matched intent, the intent will be "consumed". This means the intent won't activate more transition routes. However, when the followed transition route moves the conversation session into a different flow, the matched intent can be carried over and to be consumed in the target flow.
+          "advancedSettings": { # Hierarchical advanced settings for agent/flow/page/fulfillment/parameter. Settings exposed at lower level overrides the settings exposed at higher level. Overriding occurs at the sub-setting level. For example, the playback_interruption_settings at fulfillment level only overrides the playback_interruption_settings at the agent level, leaving other settings at the agent level unchanged. DTMF settings does not override each other. DTMF settings set at different levels define DTMF detections running in parallel. Hierarchy: Agent->Flow->Page->Fulfillment/Parameter. # Hierarchical advanced settings for this flow. The settings exposed at the lower level overrides the settings exposed at the higher level.
+            "audioExportGcsDestination": { # Google Cloud Storage location for a Dialogflow operation that writes or exports objects (e.g. exported agent or transcripts) outside of Dialogflow. # If present, incoming audio is exported by Dialogflow to the configured Google Cloud Storage destination. Exposed at the following levels: - Agent level - Flow level
+              "uri": "A String", # Required. The Google Cloud Storage URI for the exported objects. A URI is of the form: `gs://bucket/object-name-or-prefix` Whether a full object name, or just a prefix, its usage depends on the Dialogflow operation.
+            },
+            "dtmfSettings": { # Define behaviors for DTMF (dual tone multi frequency). # Settings for DTMF. Exposed at the following levels: - Agent level - Flow level - Page level - Parameter level.
+              "enabled": True or False, # If true, incoming audio is processed for DTMF (dual tone multi frequency) events. For example, if the caller presses a button on their telephone keypad and DTMF processing is enabled, Dialogflow will detect the event (e.g. a "3" was pressed) in the incoming audio and pass the event to the bot to drive business logic (e.g. when 3 is pressed, return the account balance).
+              "endpointingTimeoutDuration": "A String", # Endpoint timeout setting for matching dtmf input to regex.
+              "finishDigit": "A String", # The digit that terminates a DTMF digit sequence.
+              "interdigitTimeoutDuration": "A String", # Interdigit timeout setting for matching dtmf input to regex.
+              "maxDigits": 42, # Max length of DTMF digits.
+            },
+            "loggingSettings": { # Define behaviors on logging. # Settings for logging. Settings for Dialogflow History, Contact Center messages, StackDriver logs, and speech logging. Exposed at the following levels: - Agent level.
+              "enableInteractionLogging": True or False, # Enables DF Interaction logging.
+              "enableStackdriverLogging": True or False, # Enables StackDriver logging.
+            },
+            "speechSettings": { # Define behaviors of speech to text detection. # Settings for speech to text detection. Exposed at the following levels: - Agent level - Flow level - Page level - Parameter level
+              "endpointerSensitivity": 42, # Sensitivity of the speech model that detects the end of speech. Scale from 0 to 100.
+              "models": { # Mapping from language to Speech-to-Text model. The mapped Speech-to-Text model will be selected for requests from its corresponding language. For more information, see [Speech models](https://cloud.google.com/dialogflow/cx/docs/concept/speech-models).
+                "a_key": "A String",
+              },
+              "noSpeechTimeout": "A String", # Timeout before detecting no speech.
+              "useTimeoutBasedEndpointing": True or False, # Use timeout based endpointing, interpreting endpointer sensitivy as seconds of timeout value.
+            },
+          },
+          "description": "A String", # The description of the flow. The maximum length is 500 characters. If exceeded, the request is rejected.
+          "displayName": "A String", # Required. The human-readable name of the flow.
+          "eventHandlers": [ # A flow's event handlers serve two purposes: * They are responsible for handling events (e.g. no match, webhook errors) in the flow. * They are inherited by every page's event handlers, which can be used to handle common events regardless of the current page. Event handlers defined in the page have higher priority than those defined in the flow. Unlike transition_routes, these handlers are evaluated on a first-match basis. The first one that matches the event get executed, with the rest being ignored.
+            { # An event handler specifies an event that can be handled during a session. When the specified event happens, the following actions are taken in order: * If there is a `trigger_fulfillment` associated with the event, it will be called. * If there is a `target_page` associated with the event, the session will transition into the specified page. * If there is a `target_flow` associated with the event, the session will transition into the specified flow.
+              "event": "A String", # Required. The name of the event to handle.
+              "name": "A String", # Output only. The unique identifier of this event handler.
+              "targetFlow": "A String", # The target flow to transition to. Format: `projects//locations//agents//flows/`.
+              "targetPage": "A String", # The target page to transition to. Format: `projects//locations//agents//flows//pages/`.
+              "triggerFulfillment": { # A fulfillment can do one or more of the following actions at the same time: * Generate rich message responses. * Set parameter values. * Call the webhook. Fulfillments can be called at various stages in the Page or Form lifecycle. For example, when a DetectIntentRequest drives a session to enter a new page, the page's entry fulfillment can add a static response to the QueryResult in the returning DetectIntentResponse, call the webhook (for example, to load user data from a database), or both. # The fulfillment to call when the event occurs. Handling webhook errors with a fulfillment enabled with webhook could cause infinite loop. It is invalid to specify such fulfillment for a handler handling webhooks.
+                "advancedSettings": { # Hierarchical advanced settings for agent/flow/page/fulfillment/parameter. Settings exposed at lower level overrides the settings exposed at higher level. Overriding occurs at the sub-setting level. For example, the playback_interruption_settings at fulfillment level only overrides the playback_interruption_settings at the agent level, leaving other settings at the agent level unchanged. DTMF settings does not override each other. DTMF settings set at different levels define DTMF detections running in parallel. Hierarchy: Agent->Flow->Page->Fulfillment/Parameter. # Hierarchical advanced settings for this fulfillment. The settings exposed at the lower level overrides the settings exposed at the higher level.
+                  "audioExportGcsDestination": { # Google Cloud Storage location for a Dialogflow operation that writes or exports objects (e.g. exported agent or transcripts) outside of Dialogflow. # If present, incoming audio is exported by Dialogflow to the configured Google Cloud Storage destination. Exposed at the following levels: - Agent level - Flow level
+                    "uri": "A String", # Required. The Google Cloud Storage URI for the exported objects. A URI is of the form: `gs://bucket/object-name-or-prefix` Whether a full object name, or just a prefix, its usage depends on the Dialogflow operation.
+                  },
+                  "dtmfSettings": { # Define behaviors for DTMF (dual tone multi frequency). # Settings for DTMF. Exposed at the following levels: - Agent level - Flow level - Page level - Parameter level.
+                    "enabled": True or False, # If true, incoming audio is processed for DTMF (dual tone multi frequency) events. For example, if the caller presses a button on their telephone keypad and DTMF processing is enabled, Dialogflow will detect the event (e.g. a "3" was pressed) in the incoming audio and pass the event to the bot to drive business logic (e.g. when 3 is pressed, return the account balance).
+                    "endpointingTimeoutDuration": "A String", # Endpoint timeout setting for matching dtmf input to regex.
+                    "finishDigit": "A String", # The digit that terminates a DTMF digit sequence.
+                    "interdigitTimeoutDuration": "A String", # Interdigit timeout setting for matching dtmf input to regex.
+                    "maxDigits": 42, # Max length of DTMF digits.
+                  },
+                  "loggingSettings": { # Define behaviors on logging. # Settings for logging. Settings for Dialogflow History, Contact Center messages, StackDriver logs, and speech logging. Exposed at the following levels: - Agent level.
+                    "enableInteractionLogging": True or False, # Enables DF Interaction logging.
+                    "enableStackdriverLogging": True or False, # Enables StackDriver logging.
+                  },
+                  "speechSettings": { # Define behaviors of speech to text detection. # Settings for speech to text detection. Exposed at the following levels: - Agent level - Flow level - Page level - Parameter level
+                    "endpointerSensitivity": 42, # Sensitivity of the speech model that detects the end of speech. Scale from 0 to 100.
+                    "models": { # Mapping from language to Speech-to-Text model. The mapped Speech-to-Text model will be selected for requests from its corresponding language. For more information, see [Speech models](https://cloud.google.com/dialogflow/cx/docs/concept/speech-models).
+                      "a_key": "A String",
+                    },
+                    "noSpeechTimeout": "A String", # Timeout before detecting no speech.
+                    "useTimeoutBasedEndpointing": True or False, # Use timeout based endpointing, interpreting endpointer sensitivy as seconds of timeout value.
+                  },
+                },
+                "conditionalCases": [ # Conditional cases for this fulfillment.
+                  { # A list of cascading if-else conditions. Cases are mutually exclusive. The first one with a matching condition is selected, all the rest ignored.
+                    "cases": [ # A list of cascading if-else conditions.
+                      { # Each case has a Boolean condition. When it is evaluated to be True, the corresponding messages will be selected and evaluated recursively.
+                        "caseContent": [ # A list of case content.
+                          { # The list of messages or conditional cases to activate for this case.
+                            "additionalCases": # Object with schema name: GoogleCloudDialogflowCxV3beta1FulfillmentConditionalCases # Additional cases to be evaluated.
+                            "message": { # 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. # Returned message.
+                              "channel": "A String", # The channel which the response is associated with. Clients can specify the channel via QueryParameters.channel, and only associated channel response will be returned.
+                              "conversationSuccess": { # 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. # Indicates that the conversation succeeded.
+                                "metadata": { # Custom metadata. Dialogflow doesn't impose any structure on this.
+                                  "a_key": "", # Properties of the object.
+                                },
+                              },
+                              "endInteraction": { # 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. # Output only. A signal that indicates the interaction with the Dialogflow agent has ended. This message is generated by Dialogflow only when the conversation reaches `END_SESSION` page. It is not supposed to be defined by the user. It's guaranteed that there is at most one such message in each response.
+                              },
+                              "knowledgeInfoCard": { # Represents info card response. If the response contains generative knowledge prediction, Dialogflow will return a payload with Infobot Messenger compatible info card. Otherwise, the info card response is skipped. # Represents info card for knowledge answers, to be better rendered in Dialogflow Messenger.
+                              },
+                              "liveAgentHandoff": { # 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. # Hands off conversation to a human agent.
+                                "metadata": { # Custom metadata for your handoff procedure. Dialogflow doesn't impose any structure on this.
+                                  "a_key": "", # Properties of the object.
+                                },
+                              },
+                              "mixedAudio": { # 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. # Output only. An audio response message composed of both the synthesized Dialogflow agent responses and responses defined via play_audio. This message is generated by Dialogflow only and not supposed to be defined by the user.
+                                "segments": [ # Segments this audio response is composed of.
+                                  { # Represents one segment of audio.
+                                    "allowPlaybackInterruption": True or False, # 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.
+                                    "audio": "A String", # Raw audio synthesized from the Dialogflow agent's response using the output config specified in the request.
+                                    "uri": "A String", # Client-specific URI that points to an audio clip accessible to the client. Dialogflow does not impose any validation on it.
+                                  },
+                                ],
+                              },
+                              "outputAudioText": { # A text or ssml response that is preferentially used for TTS output audio synthesis, as described in the comment on the ResponseMessage message. # A text or ssml response that is preferentially used for TTS output audio synthesis, as described in the comment on the ResponseMessage message.
+                                "allowPlaybackInterruption": True or False, # 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.
+                                "ssml": "A String", # The SSML text to be synthesized. For more information, see [SSML](/speech/text-to-speech/docs/ssml).
+                                "text": "A String", # The raw text to be synthesized.
+                              },
+                              "payload": { # Returns a response containing a custom, platform-specific payload.
+                                "a_key": "", # Properties of the object.
+                              },
+                              "playAudio": { # Specifies an audio clip to be played by the client as part of the response. # Signal that the client should play an audio clip hosted at a client-specific URI. Dialogflow uses this to construct mixed_audio. However, Dialogflow itself does not try to read or process the URI in any way.
+                                "allowPlaybackInterruption": True or False, # 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.
+                                "audioUri": "A String", # Required. URI of the audio clip. Dialogflow does not impose any validation on this value. It is specific to the client that reads it.
+                              },
+                              "telephonyTransferCall": { # Represents the signal that telles the client to transfer the phone call connected to the agent to a third-party endpoint. # A signal that the client should transfer the phone call connected to this agent to a third-party endpoint.
+                                "phoneNumber": "A String", # Transfer the call to a phone number in [E.164 format](https://en.wikipedia.org/wiki/E.164).
+                              },
+                              "text": { # The text response message. # Returns a text response.
+                                "allowPlaybackInterruption": True or False, # 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.
+                                "text": [ # Required. A collection of text responses.
+                                  "A String",
+                                ],
+                              },
+                              "toolCall": { # Represents a call of a specific tool's action with the specified inputs. # Returns the definition of a tool call that should be executed by the client.
+                                "action": "A String", # Required. The name of the tool's action associated with this call.
+                                "inputParameters": { # Optional. The action's input parameters.
+                                  "a_key": "", # Properties of the object.
+                                },
+                                "tool": "A String", # Required. The tool associated with this call. Format: `projects//locations//agents//tools/`.
+                              },
+                            },
+                          },
+                        ],
+                        "condition": "A String", # The condition to activate and select this case. Empty means the condition is always true. The condition is evaluated against form parameters or session parameters. See the [conditions reference](https://cloud.google.com/dialogflow/cx/docs/reference/condition).
+                      },
+                    ],
+                  },
+                ],
+                "enableGenerativeFallback": True or False, # If the flag is true, the agent will utilize LLM to generate a text response. If LLM generation fails, the defined responses in the fulfillment will be respected. This flag is only useful for fulfillments associated with no-match event handlers.
+                "messages": [ # The list of rich message responses to present to the user.
+                  { # 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.
+                    "channel": "A String", # The channel which the response is associated with. Clients can specify the channel via QueryParameters.channel, and only associated channel response will be returned.
+                    "conversationSuccess": { # 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. # Indicates that the conversation succeeded.
+                      "metadata": { # Custom metadata. Dialogflow doesn't impose any structure on this.
+                        "a_key": "", # Properties of the object.
+                      },
+                    },
+                    "endInteraction": { # 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. # Output only. A signal that indicates the interaction with the Dialogflow agent has ended. This message is generated by Dialogflow only when the conversation reaches `END_SESSION` page. It is not supposed to be defined by the user. It's guaranteed that there is at most one such message in each response.
+                    },
+                    "knowledgeInfoCard": { # Represents info card response. If the response contains generative knowledge prediction, Dialogflow will return a payload with Infobot Messenger compatible info card. Otherwise, the info card response is skipped. # Represents info card for knowledge answers, to be better rendered in Dialogflow Messenger.
+                    },
+                    "liveAgentHandoff": { # 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. # Hands off conversation to a human agent.
+                      "metadata": { # Custom metadata for your handoff procedure. Dialogflow doesn't impose any structure on this.
+                        "a_key": "", # Properties of the object.
+                      },
+                    },
+                    "mixedAudio": { # 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. # Output only. An audio response message composed of both the synthesized Dialogflow agent responses and responses defined via play_audio. This message is generated by Dialogflow only and not supposed to be defined by the user.
+                      "segments": [ # Segments this audio response is composed of.
+                        { # Represents one segment of audio.
+                          "allowPlaybackInterruption": True or False, # 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.
+                          "audio": "A String", # Raw audio synthesized from the Dialogflow agent's response using the output config specified in the request.
+                          "uri": "A String", # Client-specific URI that points to an audio clip accessible to the client. Dialogflow does not impose any validation on it.
+                        },
+                      ],
+                    },
+                    "outputAudioText": { # A text or ssml response that is preferentially used for TTS output audio synthesis, as described in the comment on the ResponseMessage message. # A text or ssml response that is preferentially used for TTS output audio synthesis, as described in the comment on the ResponseMessage message.
+                      "allowPlaybackInterruption": True or False, # 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.
+                      "ssml": "A String", # The SSML text to be synthesized. For more information, see [SSML](/speech/text-to-speech/docs/ssml).
+                      "text": "A String", # The raw text to be synthesized.
+                    },
+                    "payload": { # Returns a response containing a custom, platform-specific payload.
+                      "a_key": "", # Properties of the object.
+                    },
+                    "playAudio": { # Specifies an audio clip to be played by the client as part of the response. # Signal that the client should play an audio clip hosted at a client-specific URI. Dialogflow uses this to construct mixed_audio. However, Dialogflow itself does not try to read or process the URI in any way.
+                      "allowPlaybackInterruption": True or False, # 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.
+                      "audioUri": "A String", # Required. URI of the audio clip. Dialogflow does not impose any validation on this value. It is specific to the client that reads it.
+                    },
+                    "telephonyTransferCall": { # Represents the signal that telles the client to transfer the phone call connected to the agent to a third-party endpoint. # A signal that the client should transfer the phone call connected to this agent to a third-party endpoint.
+                      "phoneNumber": "A String", # Transfer the call to a phone number in [E.164 format](https://en.wikipedia.org/wiki/E.164).
+                    },
+                    "text": { # The text response message. # Returns a text response.
+                      "allowPlaybackInterruption": True or False, # 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.
+                      "text": [ # Required. A collection of text responses.
+                        "A String",
+                      ],
+                    },
+                    "toolCall": { # Represents a call of a specific tool's action with the specified inputs. # Returns the definition of a tool call that should be executed by the client.
+                      "action": "A String", # Required. The name of the tool's action associated with this call.
+                      "inputParameters": { # Optional. The action's input parameters.
+                        "a_key": "", # Properties of the object.
+                      },
+                      "tool": "A String", # Required. The tool associated with this call. Format: `projects//locations//agents//tools/`.
+                    },
+                  },
+                ],
+                "returnPartialResponses": True or False, # Whether Dialogflow should return currently queued fulfillment response messages in streaming APIs. If a webhook is specified, it happens before Dialogflow invokes webhook. Warning: 1) This flag only affects streaming API. Responses are still queued and returned once in non-streaming API. 2) The flag can be enabled in any fulfillment but only the first 3 partial responses will be returned. You may only want to apply it to fulfillments that have slow webhooks.
+                "setParameterActions": [ # Set parameter values before executing the webhook.
+                  { # Setting a parameter value.
+                    "parameter": "A String", # Display name of the parameter.
+                    "value": "", # The new value of the parameter. A null value clears the parameter.
+                  },
+                ],
+                "tag": "A String", # The value of this field will be populated in the WebhookRequest `fulfillmentInfo.tag` field by Dialogflow when the associated webhook is called. The tag is typically used by the webhook service to identify which fulfillment is being called, but it could be used for other purposes. This field is required if `webhook` is specified.
+                "webhook": "A String", # The webhook to call. Format: `projects//locations//agents//webhooks/`.
+              },
+            },
+          ],
+          "knowledgeConnectorSettings": { # The Knowledge Connector settings for this page or flow. This includes information such as the attached Knowledge Bases, and the way to execute fulfillment. # Optional. Knowledge connector configuration.
+            "dataStoreConnections": [ # Optional. List of related data store connections.
+              { # A data store connection. It represents a data store in Discovery Engine and the type of the contents it contains.
+                "dataStore": "A String", # The full name of the referenced data store. Formats: `projects/{project}/locations/{location}/collections/{collection}/dataStores/{data_store}` `projects/{project}/locations/{location}/dataStores/{data_store}`
+                "dataStoreType": "A String", # The type of the connected data store.
+              },
+            ],
+            "enabled": True or False, # Whether Knowledge Connector is enabled or not.
+            "targetFlow": "A String", # The target flow to transition to. Format: `projects//locations//agents//flows/`.
+            "targetPage": "A String", # The target page to transition to. Format: `projects//locations//agents//flows//pages/`.
+            "triggerFulfillment": { # A fulfillment can do one or more of the following actions at the same time: * Generate rich message responses. * Set parameter values. * Call the webhook. Fulfillments can be called at various stages in the Page or Form lifecycle. For example, when a DetectIntentRequest drives a session to enter a new page, the page's entry fulfillment can add a static response to the QueryResult in the returning DetectIntentResponse, call the webhook (for example, to load user data from a database), or both. # The fulfillment to be triggered. When the answers from the Knowledge Connector are selected by Dialogflow, you can utitlize the request scoped parameter `$request.knowledge.answers` (contains up to the 5 highest confidence answers) and `$request.knowledge.questions` (contains the corresponding questions) to construct the fulfillment.
+              "advancedSettings": { # Hierarchical advanced settings for agent/flow/page/fulfillment/parameter. Settings exposed at lower level overrides the settings exposed at higher level. Overriding occurs at the sub-setting level. For example, the playback_interruption_settings at fulfillment level only overrides the playback_interruption_settings at the agent level, leaving other settings at the agent level unchanged. DTMF settings does not override each other. DTMF settings set at different levels define DTMF detections running in parallel. Hierarchy: Agent->Flow->Page->Fulfillment/Parameter. # Hierarchical advanced settings for this fulfillment. The settings exposed at the lower level overrides the settings exposed at the higher level.
+                "audioExportGcsDestination": { # Google Cloud Storage location for a Dialogflow operation that writes or exports objects (e.g. exported agent or transcripts) outside of Dialogflow. # If present, incoming audio is exported by Dialogflow to the configured Google Cloud Storage destination. Exposed at the following levels: - Agent level - Flow level
+                  "uri": "A String", # Required. The Google Cloud Storage URI for the exported objects. A URI is of the form: `gs://bucket/object-name-or-prefix` Whether a full object name, or just a prefix, its usage depends on the Dialogflow operation.
+                },
+                "dtmfSettings": { # Define behaviors for DTMF (dual tone multi frequency). # Settings for DTMF. Exposed at the following levels: - Agent level - Flow level - Page level - Parameter level.
+                  "enabled": True or False, # If true, incoming audio is processed for DTMF (dual tone multi frequency) events. For example, if the caller presses a button on their telephone keypad and DTMF processing is enabled, Dialogflow will detect the event (e.g. a "3" was pressed) in the incoming audio and pass the event to the bot to drive business logic (e.g. when 3 is pressed, return the account balance).
+                  "endpointingTimeoutDuration": "A String", # Endpoint timeout setting for matching dtmf input to regex.
+                  "finishDigit": "A String", # The digit that terminates a DTMF digit sequence.
+                  "interdigitTimeoutDuration": "A String", # Interdigit timeout setting for matching dtmf input to regex.
+                  "maxDigits": 42, # Max length of DTMF digits.
+                },
+                "loggingSettings": { # Define behaviors on logging. # Settings for logging. Settings for Dialogflow History, Contact Center messages, StackDriver logs, and speech logging. Exposed at the following levels: - Agent level.
+                  "enableInteractionLogging": True or False, # Enables DF Interaction logging.
+                  "enableStackdriverLogging": True or False, # Enables StackDriver logging.
+                },
+                "speechSettings": { # Define behaviors of speech to text detection. # Settings for speech to text detection. Exposed at the following levels: - Agent level - Flow level - Page level - Parameter level
+                  "endpointerSensitivity": 42, # Sensitivity of the speech model that detects the end of speech. Scale from 0 to 100.
+                  "models": { # Mapping from language to Speech-to-Text model. The mapped Speech-to-Text model will be selected for requests from its corresponding language. For more information, see [Speech models](https://cloud.google.com/dialogflow/cx/docs/concept/speech-models).
+                    "a_key": "A String",
+                  },
+                  "noSpeechTimeout": "A String", # Timeout before detecting no speech.
+                  "useTimeoutBasedEndpointing": True or False, # Use timeout based endpointing, interpreting endpointer sensitivy as seconds of timeout value.
+                },
+              },
+              "conditionalCases": [ # Conditional cases for this fulfillment.
+                { # A list of cascading if-else conditions. Cases are mutually exclusive. The first one with a matching condition is selected, all the rest ignored.
+                  "cases": [ # A list of cascading if-else conditions.
+                    { # Each case has a Boolean condition. When it is evaluated to be True, the corresponding messages will be selected and evaluated recursively.
+                      "caseContent": [ # A list of case content.
+                        { # The list of messages or conditional cases to activate for this case.
+                          "additionalCases": # Object with schema name: GoogleCloudDialogflowCxV3beta1FulfillmentConditionalCases # Additional cases to be evaluated.
+                          "message": { # 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. # Returned message.
+                            "channel": "A String", # The channel which the response is associated with. Clients can specify the channel via QueryParameters.channel, and only associated channel response will be returned.
+                            "conversationSuccess": { # 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. # Indicates that the conversation succeeded.
+                              "metadata": { # Custom metadata. Dialogflow doesn't impose any structure on this.
+                                "a_key": "", # Properties of the object.
+                              },
+                            },
+                            "endInteraction": { # 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. # Output only. A signal that indicates the interaction with the Dialogflow agent has ended. This message is generated by Dialogflow only when the conversation reaches `END_SESSION` page. It is not supposed to be defined by the user. It's guaranteed that there is at most one such message in each response.
+                            },
+                            "knowledgeInfoCard": { # Represents info card response. If the response contains generative knowledge prediction, Dialogflow will return a payload with Infobot Messenger compatible info card. Otherwise, the info card response is skipped. # Represents info card for knowledge answers, to be better rendered in Dialogflow Messenger.
+                            },
+                            "liveAgentHandoff": { # 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. # Hands off conversation to a human agent.
+                              "metadata": { # Custom metadata for your handoff procedure. Dialogflow doesn't impose any structure on this.
+                                "a_key": "", # Properties of the object.
+                              },
+                            },
+                            "mixedAudio": { # 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. # Output only. An audio response message composed of both the synthesized Dialogflow agent responses and responses defined via play_audio. This message is generated by Dialogflow only and not supposed to be defined by the user.
+                              "segments": [ # Segments this audio response is composed of.
+                                { # Represents one segment of audio.
+                                  "allowPlaybackInterruption": True or False, # 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.
+                                  "audio": "A String", # Raw audio synthesized from the Dialogflow agent's response using the output config specified in the request.
+                                  "uri": "A String", # Client-specific URI that points to an audio clip accessible to the client. Dialogflow does not impose any validation on it.
+                                },
+                              ],
+                            },
+                            "outputAudioText": { # A text or ssml response that is preferentially used for TTS output audio synthesis, as described in the comment on the ResponseMessage message. # A text or ssml response that is preferentially used for TTS output audio synthesis, as described in the comment on the ResponseMessage message.
+                              "allowPlaybackInterruption": True or False, # 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.
+                              "ssml": "A String", # The SSML text to be synthesized. For more information, see [SSML](/speech/text-to-speech/docs/ssml).
+                              "text": "A String", # The raw text to be synthesized.
+                            },
+                            "payload": { # Returns a response containing a custom, platform-specific payload.
+                              "a_key": "", # Properties of the object.
+                            },
+                            "playAudio": { # Specifies an audio clip to be played by the client as part of the response. # Signal that the client should play an audio clip hosted at a client-specific URI. Dialogflow uses this to construct mixed_audio. However, Dialogflow itself does not try to read or process the URI in any way.
+                              "allowPlaybackInterruption": True or False, # 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.
+                              "audioUri": "A String", # Required. URI of the audio clip. Dialogflow does not impose any validation on this value. It is specific to the client that reads it.
+                            },
+                            "telephonyTransferCall": { # Represents the signal that telles the client to transfer the phone call connected to the agent to a third-party endpoint. # A signal that the client should transfer the phone call connected to this agent to a third-party endpoint.
+                              "phoneNumber": "A String", # Transfer the call to a phone number in [E.164 format](https://en.wikipedia.org/wiki/E.164).
+                            },
+                            "text": { # The text response message. # Returns a text response.
+                              "allowPlaybackInterruption": True or False, # 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.
+                              "text": [ # Required. A collection of text responses.
+                                "A String",
+                              ],
+                            },
+                            "toolCall": { # Represents a call of a specific tool's action with the specified inputs. # Returns the definition of a tool call that should be executed by the client.
+                              "action": "A String", # Required. The name of the tool's action associated with this call.
+                              "inputParameters": { # Optional. The action's input parameters.
+                                "a_key": "", # Properties of the object.
+                              },
+                              "tool": "A String", # Required. The tool associated with this call. Format: `projects//locations//agents//tools/`.
+                            },
+                          },
+                        },
+                      ],
+                      "condition": "A String", # The condition to activate and select this case. Empty means the condition is always true. The condition is evaluated against form parameters or session parameters. See the [conditions reference](https://cloud.google.com/dialogflow/cx/docs/reference/condition).
+                    },
+                  ],
+                },
+              ],
+              "enableGenerativeFallback": True or False, # If the flag is true, the agent will utilize LLM to generate a text response. If LLM generation fails, the defined responses in the fulfillment will be respected. This flag is only useful for fulfillments associated with no-match event handlers.
+              "messages": [ # The list of rich message responses to present to the user.
+                { # 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.
+                  "channel": "A String", # The channel which the response is associated with. Clients can specify the channel via QueryParameters.channel, and only associated channel response will be returned.
+                  "conversationSuccess": { # 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. # Indicates that the conversation succeeded.
+                    "metadata": { # Custom metadata. Dialogflow doesn't impose any structure on this.
+                      "a_key": "", # Properties of the object.
+                    },
+                  },
+                  "endInteraction": { # 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. # Output only. A signal that indicates the interaction with the Dialogflow agent has ended. This message is generated by Dialogflow only when the conversation reaches `END_SESSION` page. It is not supposed to be defined by the user. It's guaranteed that there is at most one such message in each response.
+                  },
+                  "knowledgeInfoCard": { # Represents info card response. If the response contains generative knowledge prediction, Dialogflow will return a payload with Infobot Messenger compatible info card. Otherwise, the info card response is skipped. # Represents info card for knowledge answers, to be better rendered in Dialogflow Messenger.
+                  },
+                  "liveAgentHandoff": { # 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. # Hands off conversation to a human agent.
+                    "metadata": { # Custom metadata for your handoff procedure. Dialogflow doesn't impose any structure on this.
+                      "a_key": "", # Properties of the object.
+                    },
+                  },
+                  "mixedAudio": { # 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. # Output only. An audio response message composed of both the synthesized Dialogflow agent responses and responses defined via play_audio. This message is generated by Dialogflow only and not supposed to be defined by the user.
+                    "segments": [ # Segments this audio response is composed of.
+                      { # Represents one segment of audio.
+                        "allowPlaybackInterruption": True or False, # 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.
+                        "audio": "A String", # Raw audio synthesized from the Dialogflow agent's response using the output config specified in the request.
+                        "uri": "A String", # Client-specific URI that points to an audio clip accessible to the client. Dialogflow does not impose any validation on it.
+                      },
+                    ],
+                  },
+                  "outputAudioText": { # A text or ssml response that is preferentially used for TTS output audio synthesis, as described in the comment on the ResponseMessage message. # A text or ssml response that is preferentially used for TTS output audio synthesis, as described in the comment on the ResponseMessage message.
+                    "allowPlaybackInterruption": True or False, # 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.
+                    "ssml": "A String", # The SSML text to be synthesized. For more information, see [SSML](/speech/text-to-speech/docs/ssml).
+                    "text": "A String", # The raw text to be synthesized.
+                  },
+                  "payload": { # Returns a response containing a custom, platform-specific payload.
+                    "a_key": "", # Properties of the object.
+                  },
+                  "playAudio": { # Specifies an audio clip to be played by the client as part of the response. # Signal that the client should play an audio clip hosted at a client-specific URI. Dialogflow uses this to construct mixed_audio. However, Dialogflow itself does not try to read or process the URI in any way.
+                    "allowPlaybackInterruption": True or False, # 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.
+                    "audioUri": "A String", # Required. URI of the audio clip. Dialogflow does not impose any validation on this value. It is specific to the client that reads it.
+                  },
+                  "telephonyTransferCall": { # Represents the signal that telles the client to transfer the phone call connected to the agent to a third-party endpoint. # A signal that the client should transfer the phone call connected to this agent to a third-party endpoint.
+                    "phoneNumber": "A String", # Transfer the call to a phone number in [E.164 format](https://en.wikipedia.org/wiki/E.164).
+                  },
+                  "text": { # The text response message. # Returns a text response.
+                    "allowPlaybackInterruption": True or False, # 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.
+                    "text": [ # Required. A collection of text responses.
+                      "A String",
+                    ],
+                  },
+                  "toolCall": { # Represents a call of a specific tool's action with the specified inputs. # Returns the definition of a tool call that should be executed by the client.
+                    "action": "A String", # Required. The name of the tool's action associated with this call.
+                    "inputParameters": { # Optional. The action's input parameters.
+                      "a_key": "", # Properties of the object.
+                    },
+                    "tool": "A String", # Required. The tool associated with this call. Format: `projects//locations//agents//tools/`.
+                  },
+                },
+              ],
+              "returnPartialResponses": True or False, # Whether Dialogflow should return currently queued fulfillment response messages in streaming APIs. If a webhook is specified, it happens before Dialogflow invokes webhook. Warning: 1) This flag only affects streaming API. Responses are still queued and returned once in non-streaming API. 2) The flag can be enabled in any fulfillment but only the first 3 partial responses will be returned. You may only want to apply it to fulfillments that have slow webhooks.
+              "setParameterActions": [ # Set parameter values before executing the webhook.
+                { # Setting a parameter value.
+                  "parameter": "A String", # Display name of the parameter.
+                  "value": "", # The new value of the parameter. A null value clears the parameter.
+                },
+              ],
+              "tag": "A String", # The value of this field will be populated in the WebhookRequest `fulfillmentInfo.tag` field by Dialogflow when the associated webhook is called. The tag is typically used by the webhook service to identify which fulfillment is being called, but it could be used for other purposes. This field is required if `webhook` is specified.
+              "webhook": "A String", # The webhook to call. Format: `projects//locations//agents//webhooks/`.
+            },
+          },
+          "multiLanguageSettings": { # Settings for multi-lingual agents. # Optional. Multi-lingual agent settings for this flow.
+            "enableMultiLanguageDetection": True or False, # Optional. Enable multi-language detection for this flow. This can be set only if agent level multi language setting is enabled.
+            "supportedResponseLanguageCodes": [ # Optional. Agent will respond in the detected language if the detected language code is in the supported resolved languages for this flow. This will be used only if multi-language training is enabled in the agent and multi-language detection is enabled in the flow. The supported languages must be a subset of the languages supported by the agent.
+              "A String",
+            ],
+          },
+          "name": "A String", # The unique identifier of the flow. Format: `projects//locations//agents//flows/`.
+          "nluSettings": { # Settings related to NLU. # NLU related settings of the flow.
+            "classificationThreshold": 3.14, # To filter out false positive results and still get variety in matched natural language inputs for your agent, you can tune the machine learning classification threshold. If the returned score value is less than the threshold value, then a no-match event will be triggered. The score values range from 0.0 (completely uncertain) to 1.0 (completely certain). If set to 0.0, the default of 0.3 is used.
+            "modelTrainingMode": "A String", # Indicates NLU model training mode.
+            "modelType": "A String", # Indicates the type of NLU model.
+          },
+          "transitionRouteGroups": [ # A flow's transition route group serve two purposes: * They are responsible for matching the user's first utterances in the flow. * They are inherited by every page's transition route groups. Transition route groups defined in the page have higher priority than those defined in the flow. Format:`projects//locations//agents//flows//transitionRouteGroups/` or `projects//locations//agents//transitionRouteGroups/` for agent-level groups.
+            "A String",
+          ],
+          "transitionRoutes": [ # A flow's transition routes serve two purposes: * They are responsible for matching the user's first utterances in the flow. * They are inherited by every page's transition routes and can support use cases such as the user saying "help" or "can I talk to a human?", which can be handled in a common way regardless of the current page. Transition routes defined in the page have higher priority than those defined in the flow. TransitionRoutes are evalauted in the following order: * TransitionRoutes with intent specified. * TransitionRoutes with only condition specified. TransitionRoutes with intent specified are inherited by pages in the flow.
+            { # A transition route specifies a intent that can be matched and/or a data condition that can be evaluated during a session. When a specified transition is matched, the following actions are taken in order: * If there is a `trigger_fulfillment` associated with the transition, it will be called. * If there is a `target_page` associated with the transition, the session will transition into the specified page. * If there is a `target_flow` associated with the transition, the session will transition into the specified flow.
+              "condition": "A String", # The condition to evaluate against form parameters or session parameters. See the [conditions reference](https://cloud.google.com/dialogflow/cx/docs/reference/condition). At least one of `intent` or `condition` must be specified. When both `intent` and `condition` are specified, the transition can only happen when both are fulfilled.
+              "description": "A String", # Optional. The description of the transition route. The maximum length is 500 characters.
+              "intent": "A String", # The unique identifier of an Intent. Format: `projects//locations//agents//intents/`. Indicates that the transition can only happen when the given intent is matched. At least one of `intent` or `condition` must be specified. When both `intent` and `condition` are specified, the transition can only happen when both are fulfilled.
+              "name": "A String", # Output only. The unique identifier of this transition route.
+              "targetFlow": "A String", # The target flow to transition to. Format: `projects//locations//agents//flows/`.
+              "targetPage": "A String", # The target page to transition to. Format: `projects//locations//agents//flows//pages/`.
+              "triggerFulfillment": { # A fulfillment can do one or more of the following actions at the same time: * Generate rich message responses. * Set parameter values. * Call the webhook. Fulfillments can be called at various stages in the Page or Form lifecycle. For example, when a DetectIntentRequest drives a session to enter a new page, the page's entry fulfillment can add a static response to the QueryResult in the returning DetectIntentResponse, call the webhook (for example, to load user data from a database), or both. # The fulfillment to call when the condition is satisfied. At least one of `trigger_fulfillment` and `target` must be specified. When both are defined, `trigger_fulfillment` is executed first.
+                "advancedSettings": { # Hierarchical advanced settings for agent/flow/page/fulfillment/parameter. Settings exposed at lower level overrides the settings exposed at higher level. Overriding occurs at the sub-setting level. For example, the playback_interruption_settings at fulfillment level only overrides the playback_interruption_settings at the agent level, leaving other settings at the agent level unchanged. DTMF settings does not override each other. DTMF settings set at different levels define DTMF detections running in parallel. Hierarchy: Agent->Flow->Page->Fulfillment/Parameter. # Hierarchical advanced settings for this fulfillment. The settings exposed at the lower level overrides the settings exposed at the higher level.
+                  "audioExportGcsDestination": { # Google Cloud Storage location for a Dialogflow operation that writes or exports objects (e.g. exported agent or transcripts) outside of Dialogflow. # If present, incoming audio is exported by Dialogflow to the configured Google Cloud Storage destination. Exposed at the following levels: - Agent level - Flow level
+                    "uri": "A String", # Required. The Google Cloud Storage URI for the exported objects. A URI is of the form: `gs://bucket/object-name-or-prefix` Whether a full object name, or just a prefix, its usage depends on the Dialogflow operation.
+                  },
+                  "dtmfSettings": { # Define behaviors for DTMF (dual tone multi frequency). # Settings for DTMF. Exposed at the following levels: - Agent level - Flow level - Page level - Parameter level.
+                    "enabled": True or False, # If true, incoming audio is processed for DTMF (dual tone multi frequency) events. For example, if the caller presses a button on their telephone keypad and DTMF processing is enabled, Dialogflow will detect the event (e.g. a "3" was pressed) in the incoming audio and pass the event to the bot to drive business logic (e.g. when 3 is pressed, return the account balance).
+                    "endpointingTimeoutDuration": "A String", # Endpoint timeout setting for matching dtmf input to regex.
+                    "finishDigit": "A String", # The digit that terminates a DTMF digit sequence.
+                    "interdigitTimeoutDuration": "A String", # Interdigit timeout setting for matching dtmf input to regex.
+                    "maxDigits": 42, # Max length of DTMF digits.
+                  },
+                  "loggingSettings": { # Define behaviors on logging. # Settings for logging. Settings for Dialogflow History, Contact Center messages, StackDriver logs, and speech logging. Exposed at the following levels: - Agent level.
+                    "enableInteractionLogging": True or False, # Enables DF Interaction logging.
+                    "enableStackdriverLogging": True or False, # Enables StackDriver logging.
+                  },
+                  "speechSettings": { # Define behaviors of speech to text detection. # Settings for speech to text detection. Exposed at the following levels: - Agent level - Flow level - Page level - Parameter level
+                    "endpointerSensitivity": 42, # Sensitivity of the speech model that detects the end of speech. Scale from 0 to 100.
+                    "models": { # Mapping from language to Speech-to-Text model. The mapped Speech-to-Text model will be selected for requests from its corresponding language. For more information, see [Speech models](https://cloud.google.com/dialogflow/cx/docs/concept/speech-models).
+                      "a_key": "A String",
+                    },
+                    "noSpeechTimeout": "A String", # Timeout before detecting no speech.
+                    "useTimeoutBasedEndpointing": True or False, # Use timeout based endpointing, interpreting endpointer sensitivy as seconds of timeout value.
+                  },
+                },
+                "conditionalCases": [ # Conditional cases for this fulfillment.
+                  { # A list of cascading if-else conditions. Cases are mutually exclusive. The first one with a matching condition is selected, all the rest ignored.
+                    "cases": [ # A list of cascading if-else conditions.
+                      { # Each case has a Boolean condition. When it is evaluated to be True, the corresponding messages will be selected and evaluated recursively.
+                        "caseContent": [ # A list of case content.
+                          { # The list of messages or conditional cases to activate for this case.
+                            "additionalCases": # Object with schema name: GoogleCloudDialogflowCxV3beta1FulfillmentConditionalCases # Additional cases to be evaluated.
+                            "message": { # 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. # Returned message.
+                              "channel": "A String", # The channel which the response is associated with. Clients can specify the channel via QueryParameters.channel, and only associated channel response will be returned.
+                              "conversationSuccess": { # 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. # Indicates that the conversation succeeded.
+                                "metadata": { # Custom metadata. Dialogflow doesn't impose any structure on this.
+                                  "a_key": "", # Properties of the object.
+                                },
+                              },
+                              "endInteraction": { # 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. # Output only. A signal that indicates the interaction with the Dialogflow agent has ended. This message is generated by Dialogflow only when the conversation reaches `END_SESSION` page. It is not supposed to be defined by the user. It's guaranteed that there is at most one such message in each response.
+                              },
+                              "knowledgeInfoCard": { # Represents info card response. If the response contains generative knowledge prediction, Dialogflow will return a payload with Infobot Messenger compatible info card. Otherwise, the info card response is skipped. # Represents info card for knowledge answers, to be better rendered in Dialogflow Messenger.
+                              },
+                              "liveAgentHandoff": { # 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. # Hands off conversation to a human agent.
+                                "metadata": { # Custom metadata for your handoff procedure. Dialogflow doesn't impose any structure on this.
+                                  "a_key": "", # Properties of the object.
+                                },
+                              },
+                              "mixedAudio": { # 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. # Output only. An audio response message composed of both the synthesized Dialogflow agent responses and responses defined via play_audio. This message is generated by Dialogflow only and not supposed to be defined by the user.
+                                "segments": [ # Segments this audio response is composed of.
+                                  { # Represents one segment of audio.
+                                    "allowPlaybackInterruption": True or False, # 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.
+                                    "audio": "A String", # Raw audio synthesized from the Dialogflow agent's response using the output config specified in the request.
+                                    "uri": "A String", # Client-specific URI that points to an audio clip accessible to the client. Dialogflow does not impose any validation on it.
+                                  },
+                                ],
+                              },
+                              "outputAudioText": { # A text or ssml response that is preferentially used for TTS output audio synthesis, as described in the comment on the ResponseMessage message. # A text or ssml response that is preferentially used for TTS output audio synthesis, as described in the comment on the ResponseMessage message.
+                                "allowPlaybackInterruption": True or False, # 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.
+                                "ssml": "A String", # The SSML text to be synthesized. For more information, see [SSML](/speech/text-to-speech/docs/ssml).
+                                "text": "A String", # The raw text to be synthesized.
+                              },
+                              "payload": { # Returns a response containing a custom, platform-specific payload.
+                                "a_key": "", # Properties of the object.
+                              },
+                              "playAudio": { # Specifies an audio clip to be played by the client as part of the response. # Signal that the client should play an audio clip hosted at a client-specific URI. Dialogflow uses this to construct mixed_audio. However, Dialogflow itself does not try to read or process the URI in any way.
+                                "allowPlaybackInterruption": True or False, # 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.
+                                "audioUri": "A String", # Required. URI of the audio clip. Dialogflow does not impose any validation on this value. It is specific to the client that reads it.
+                              },
+                              "telephonyTransferCall": { # Represents the signal that telles the client to transfer the phone call connected to the agent to a third-party endpoint. # A signal that the client should transfer the phone call connected to this agent to a third-party endpoint.
+                                "phoneNumber": "A String", # Transfer the call to a phone number in [E.164 format](https://en.wikipedia.org/wiki/E.164).
+                              },
+                              "text": { # The text response message. # Returns a text response.
+                                "allowPlaybackInterruption": True or False, # 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.
+                                "text": [ # Required. A collection of text responses.
+                                  "A String",
+                                ],
+                              },
+                              "toolCall": { # Represents a call of a specific tool's action with the specified inputs. # Returns the definition of a tool call that should be executed by the client.
+                                "action": "A String", # Required. The name of the tool's action associated with this call.
+                                "inputParameters": { # Optional. The action's input parameters.
+                                  "a_key": "", # Properties of the object.
+                                },
+                                "tool": "A String", # Required. The tool associated with this call. Format: `projects//locations//agents//tools/`.
+                              },
+                            },
+                          },
+                        ],
+                        "condition": "A String", # The condition to activate and select this case. Empty means the condition is always true. The condition is evaluated against form parameters or session parameters. See the [conditions reference](https://cloud.google.com/dialogflow/cx/docs/reference/condition).
+                      },
+                    ],
+                  },
+                ],
+                "enableGenerativeFallback": True or False, # If the flag is true, the agent will utilize LLM to generate a text response. If LLM generation fails, the defined responses in the fulfillment will be respected. This flag is only useful for fulfillments associated with no-match event handlers.
+                "messages": [ # The list of rich message responses to present to the user.
+                  { # 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.
+                    "channel": "A String", # The channel which the response is associated with. Clients can specify the channel via QueryParameters.channel, and only associated channel response will be returned.
+                    "conversationSuccess": { # 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. # Indicates that the conversation succeeded.
+                      "metadata": { # Custom metadata. Dialogflow doesn't impose any structure on this.
+                        "a_key": "", # Properties of the object.
+                      },
+                    },
+                    "endInteraction": { # 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. # Output only. A signal that indicates the interaction with the Dialogflow agent has ended. This message is generated by Dialogflow only when the conversation reaches `END_SESSION` page. It is not supposed to be defined by the user. It's guaranteed that there is at most one such message in each response.
+                    },
+                    "knowledgeInfoCard": { # Represents info card response. If the response contains generative knowledge prediction, Dialogflow will return a payload with Infobot Messenger compatible info card. Otherwise, the info card response is skipped. # Represents info card for knowledge answers, to be better rendered in Dialogflow Messenger.
+                    },
+                    "liveAgentHandoff": { # 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. # Hands off conversation to a human agent.
+                      "metadata": { # Custom metadata for your handoff procedure. Dialogflow doesn't impose any structure on this.
+                        "a_key": "", # Properties of the object.
+                      },
+                    },
+                    "mixedAudio": { # 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. # Output only. An audio response message composed of both the synthesized Dialogflow agent responses and responses defined via play_audio. This message is generated by Dialogflow only and not supposed to be defined by the user.
+                      "segments": [ # Segments this audio response is composed of.
+                        { # Represents one segment of audio.
+                          "allowPlaybackInterruption": True or False, # 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.
+                          "audio": "A String", # Raw audio synthesized from the Dialogflow agent's response using the output config specified in the request.
+                          "uri": "A String", # Client-specific URI that points to an audio clip accessible to the client. Dialogflow does not impose any validation on it.
+                        },
+                      ],
+                    },
+                    "outputAudioText": { # A text or ssml response that is preferentially used for TTS output audio synthesis, as described in the comment on the ResponseMessage message. # A text or ssml response that is preferentially used for TTS output audio synthesis, as described in the comment on the ResponseMessage message.
+                      "allowPlaybackInterruption": True or False, # 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.
+                      "ssml": "A String", # The SSML text to be synthesized. For more information, see [SSML](/speech/text-to-speech/docs/ssml).
+                      "text": "A String", # The raw text to be synthesized.
+                    },
+                    "payload": { # Returns a response containing a custom, platform-specific payload.
+                      "a_key": "", # Properties of the object.
+                    },
+                    "playAudio": { # Specifies an audio clip to be played by the client as part of the response. # Signal that the client should play an audio clip hosted at a client-specific URI. Dialogflow uses this to construct mixed_audio. However, Dialogflow itself does not try to read or process the URI in any way.
+                      "allowPlaybackInterruption": True or False, # 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.
+                      "audioUri": "A String", # Required. URI of the audio clip. Dialogflow does not impose any validation on this value. It is specific to the client that reads it.
+                    },
+                    "telephonyTransferCall": { # Represents the signal that telles the client to transfer the phone call connected to the agent to a third-party endpoint. # A signal that the client should transfer the phone call connected to this agent to a third-party endpoint.
+                      "phoneNumber": "A String", # Transfer the call to a phone number in [E.164 format](https://en.wikipedia.org/wiki/E.164).
+                    },
+                    "text": { # The text response message. # Returns a text response.
+                      "allowPlaybackInterruption": True or False, # 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.
+                      "text": [ # Required. A collection of text responses.
+                        "A String",
+                      ],
+                    },
+                    "toolCall": { # Represents a call of a specific tool's action with the specified inputs. # Returns the definition of a tool call that should be executed by the client.
+                      "action": "A String", # Required. The name of the tool's action associated with this call.
+                      "inputParameters": { # Optional. The action's input parameters.
+                        "a_key": "", # Properties of the object.
+                      },
+                      "tool": "A String", # Required. The tool associated with this call. Format: `projects//locations//agents//tools/`.
+                    },
+                  },
+                ],
+                "returnPartialResponses": True or False, # Whether Dialogflow should return currently queued fulfillment response messages in streaming APIs. If a webhook is specified, it happens before Dialogflow invokes webhook. Warning: 1) This flag only affects streaming API. Responses are still queued and returned once in non-streaming API. 2) The flag can be enabled in any fulfillment but only the first 3 partial responses will be returned. You may only want to apply it to fulfillments that have slow webhooks.
+                "setParameterActions": [ # Set parameter values before executing the webhook.
+                  { # Setting a parameter value.
+                    "parameter": "A String", # Display name of the parameter.
+                    "value": "", # The new value of the parameter. A null value clears the parameter.
+                  },
+                ],
+                "tag": "A String", # The value of this field will be populated in the WebhookRequest `fulfillmentInfo.tag` field by Dialogflow when the associated webhook is called. The tag is typically used by the webhook service to identify which fulfillment is being called, but it could be used for other purposes. This field is required if `webhook` is specified.
+                "webhook": "A String", # The webhook to call. Format: `projects//locations//agents//webhooks/`.
+              },
+            },
+          ],
+        },
+      ],
+      "intents": [ # All the matched Intent in the conversation. Only `name` and `display_name` are filled in this message.
+        { # An intent represents a user's intent to interact with a conversational agent. You can provide information for the Dialogflow API to use to match user input to an intent by adding training phrases (i.e., examples of user input) to your intent.
+          "description": "A String", # Human readable description for better understanding an intent like its scope, content, result etc. Maximum character limit: 140 characters.
+          "displayName": "A String", # Required. The human-readable name of the intent, unique within the agent.
+          "isFallback": True or False, # Indicates whether this is a fallback intent. Currently only default fallback intent is allowed in the agent, which is added upon agent creation. Adding training phrases to fallback intent is useful in the case of requests that are mistakenly matched, since training phrases assigned to fallback intents act as negative examples that triggers no-match event.
+          "labels": { # The key/value metadata to label an intent. Labels can contain lowercase letters, digits and the symbols '-' and '_'. International characters are allowed, including letters from unicase alphabets. Keys must start with a letter. Keys and values can be no longer than 63 characters and no more than 128 bytes. Prefix "sys-" is reserved for Dialogflow defined labels. Currently allowed Dialogflow defined labels include: * sys-head * sys-contextual The above labels do not require value. "sys-head" means the intent is a head intent. "sys-contextual" means the intent is a contextual intent.
+            "a_key": "A String",
+          },
+          "name": "A String", # The unique identifier of the intent. Required for the Intents.UpdateIntent method. Intents.CreateIntent populates the name automatically. Format: `projects//locations//agents//intents/`.
+          "parameters": [ # The collection of parameters associated with the intent.
+            { # Represents an intent parameter.
+              "entityType": "A String", # Required. The entity type of the parameter. Format: `projects/-/locations/-/agents/-/entityTypes/` for system entity types (for example, `projects/-/locations/-/agents/-/entityTypes/sys.date`), or `projects//locations//agents//entityTypes/` for developer entity types.
+              "id": "A String", # Required. The unique identifier of the parameter. This field is used by training phrases to annotate their parts.
+              "isList": True or False, # Indicates whether the parameter represents a list of values.
+              "redact": True or False, # Indicates whether the parameter content should be redacted in log. If redaction is enabled, the parameter content will be replaced by parameter name during logging. Note: the parameter content is subject to redaction if either parameter level redaction or entity type level redaction is enabled.
+            },
+          ],
+          "priority": 42, # 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.
+          "trainingPhrases": [ # The collection of training phrases the agent is trained on to identify the intent.
+            { # Represents an example that the agent is trained on to identify the intent.
+              "id": "A String", # Output only. The unique identifier of the training phrase.
+              "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 `parameter_id` field is set.
+                { # Represents a part of a training phrase.
+                  "parameterId": "A String", # The parameter used to annotate this part of the training phrase. This field is required for annotated parts of the training phrase.
+                  "text": "A String", # Required. The text for this part.
+                },
+              ],
+              "repeatCount": 42, # Indicates how many times this example was added to the intent.
+            },
+          ],
+        },
+      ],
+      "interactions": [ # Interactions of the conversation. Only populated for `GetConversation` and empty for `ListConversations`.
+        { # Represents an interaction between an end user and a Dialogflow CX agent using V3 (Streaming)DetectIntent API, or an interaction between an end user and a Dialogflow CX agent using V2 (Streaming)AnalyzeContent API.
+          "createTime": "A String", # The time that the interaction was created.
+          "missingTransition": { # Information collected for DF CX agents in case NLU predicted an intent that was filtered out as being inactive which may indicate a missing transition and/or absent functionality. # Missing transition predicted for the interaction. This field is set only if the interaction match type was no-match.
+            "intentDisplayName": "A String", # Name of the intent that could have triggered.
+            "score": 3.14, # Score of the above intent. The higher it is the more likely a transition was missed on a given page.
+          },
+          "partialResponses": [ # The partial responses of the interaction. Empty if there is no partial response in the interaction. See the partial response documentation.
+            { # The message returned from the DetectIntent method.
+              "allowCancellation": True or False, # Indicates whether the partial response can be cancelled when a later response arrives. e.g. if the agent specified some music as partial response, it can be cancelled.
+              "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.response_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.
+              "outputAudioConfig": { # Instructs the speech synthesizer how to generate the output audio content. # The config used by the speech synthesizer to generate the output audio.
+                "audioEncoding": "A String", # Required. Audio encoding of the synthesized audio content.
+                "sampleRateHertz": 42, # Optional. 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).
+                "synthesizeSpeechConfig": { # Configuration of how speech should be synthesized. # Optional. Configuration of how speech should be synthesized. If not specified, Agent.text_to_speech_settings is applied.
+                  "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.
+                    "A String",
+                  ],
+                  "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.
+                  "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.
+                  "voice": { # Description of which voice to use for speech synthesis. # Optional. The desired voice of the synthesized audio.
+                    "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. For the list of available voices, please refer to [Supported voices and languages](https://cloud.google.com/text-to-speech/docs/voices).
+                    "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.
+                  },
+                  "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.
+                },
+              },
+              "queryResult": { # Represents the result of a conversational query. # The result of the conversational query.
+                "advancedSettings": { # Hierarchical advanced settings for agent/flow/page/fulfillment/parameter. Settings exposed at lower level overrides the settings exposed at higher level. Overriding occurs at the sub-setting level. For example, the playback_interruption_settings at fulfillment level only overrides the playback_interruption_settings at the agent level, leaving other settings at the agent level unchanged. DTMF settings does not override each other. DTMF settings set at different levels define DTMF detections running in parallel. Hierarchy: Agent->Flow->Page->Fulfillment/Parameter. # Returns the current advanced settings including IVR settings. Even though the operations configured by these settings are performed by Dialogflow, the client may need to perform special logic at the moment. For example, if Dialogflow exports audio to Google Cloud Storage, then the client may need to wait for the resulting object to appear in the bucket before proceeding.
+                  "audioExportGcsDestination": { # Google Cloud Storage location for a Dialogflow operation that writes or exports objects (e.g. exported agent or transcripts) outside of Dialogflow. # If present, incoming audio is exported by Dialogflow to the configured Google Cloud Storage destination. Exposed at the following levels: - Agent level - Flow level
+                    "uri": "A String", # Required. The Google Cloud Storage URI for the exported objects. A URI is of the form: `gs://bucket/object-name-or-prefix` Whether a full object name, or just a prefix, its usage depends on the Dialogflow operation.
+                  },
+                  "dtmfSettings": { # Define behaviors for DTMF (dual tone multi frequency). # Settings for DTMF. Exposed at the following levels: - Agent level - Flow level - Page level - Parameter level.
+                    "enabled": True or False, # If true, incoming audio is processed for DTMF (dual tone multi frequency) events. For example, if the caller presses a button on their telephone keypad and DTMF processing is enabled, Dialogflow will detect the event (e.g. a "3" was pressed) in the incoming audio and pass the event to the bot to drive business logic (e.g. when 3 is pressed, return the account balance).
+                    "endpointingTimeoutDuration": "A String", # Endpoint timeout setting for matching dtmf input to regex.
+                    "finishDigit": "A String", # The digit that terminates a DTMF digit sequence.
+                    "interdigitTimeoutDuration": "A String", # Interdigit timeout setting for matching dtmf input to regex.
+                    "maxDigits": 42, # Max length of DTMF digits.
+                  },
+                  "loggingSettings": { # Define behaviors on logging. # Settings for logging. Settings for Dialogflow History, Contact Center messages, StackDriver logs, and speech logging. Exposed at the following levels: - Agent level.
+                    "enableInteractionLogging": True or False, # Enables DF Interaction logging.
+                    "enableStackdriverLogging": True or False, # Enables StackDriver logging.
+                  },
+                  "speechSettings": { # Define behaviors of speech to text detection. # Settings for speech to text detection. Exposed at the following levels: - Agent level - Flow level - Page level - Parameter level
+                    "endpointerSensitivity": 42, # Sensitivity of the speech model that detects the end of speech. Scale from 0 to 100.
+                    "models": { # Mapping from language to Speech-to-Text model. The mapped Speech-to-Text model will be selected for requests from its corresponding language. For more information, see [Speech models](https://cloud.google.com/dialogflow/cx/docs/concept/speech-models).
+                      "a_key": "A String",
+                    },
+                    "noSpeechTimeout": "A String", # Timeout before detecting no speech.
+                    "useTimeoutBasedEndpointing": True or False, # Use timeout based endpointing, interpreting endpointer sensitivy as seconds of timeout value.
+                  },
+                },
+                "allowAnswerFeedback": True or False, # Indicates whether the Thumbs up/Thumbs down rating controls are need to be shown for the response in the Dialogflow Messenger widget.
+                "currentFlow": { # Flows represents the conversation flows when you build your chatbot agent. A flow consists of many pages connected by the transition routes. Conversations always start with the built-in Start Flow (with an all-0 ID). Transition routes can direct the conversation session from the current flow (parent flow) to another flow (sub flow). When the sub flow is finished, Dialogflow will bring the session back to the parent flow, where the sub flow is started. Usually, when a transition route is followed by a matched intent, the intent will be "consumed". This means the intent won't activate more transition routes. However, when the followed transition route moves the conversation session into a different flow, the matched intent can be carried over and to be consumed in the target flow. # The current Flow. Some, not all fields are filled in this message, including but not limited to `name` and `display_name`.
+                  "advancedSettings": { # Hierarchical advanced settings for agent/flow/page/fulfillment/parameter. Settings exposed at lower level overrides the settings exposed at higher level. Overriding occurs at the sub-setting level. For example, the playback_interruption_settings at fulfillment level only overrides the playback_interruption_settings at the agent level, leaving other settings at the agent level unchanged. DTMF settings does not override each other. DTMF settings set at different levels define DTMF detections running in parallel. Hierarchy: Agent->Flow->Page->Fulfillment/Parameter. # Hierarchical advanced settings for this flow. The settings exposed at the lower level overrides the settings exposed at the higher level.
+                    "audioExportGcsDestination": { # Google Cloud Storage location for a Dialogflow operation that writes or exports objects (e.g. exported agent or transcripts) outside of Dialogflow. # If present, incoming audio is exported by Dialogflow to the configured Google Cloud Storage destination. Exposed at the following levels: - Agent level - Flow level
+                      "uri": "A String", # Required. The Google Cloud Storage URI for the exported objects. A URI is of the form: `gs://bucket/object-name-or-prefix` Whether a full object name, or just a prefix, its usage depends on the Dialogflow operation.
+                    },
+                    "dtmfSettings": { # Define behaviors for DTMF (dual tone multi frequency). # Settings for DTMF. Exposed at the following levels: - Agent level - Flow level - Page level - Parameter level.
+                      "enabled": True or False, # If true, incoming audio is processed for DTMF (dual tone multi frequency) events. For example, if the caller presses a button on their telephone keypad and DTMF processing is enabled, Dialogflow will detect the event (e.g. a "3" was pressed) in the incoming audio and pass the event to the bot to drive business logic (e.g. when 3 is pressed, return the account balance).
+                      "endpointingTimeoutDuration": "A String", # Endpoint timeout setting for matching dtmf input to regex.
+                      "finishDigit": "A String", # The digit that terminates a DTMF digit sequence.
+                      "interdigitTimeoutDuration": "A String", # Interdigit timeout setting for matching dtmf input to regex.
+                      "maxDigits": 42, # Max length of DTMF digits.
+                    },
+                    "loggingSettings": { # Define behaviors on logging. # Settings for logging. Settings for Dialogflow History, Contact Center messages, StackDriver logs, and speech logging. Exposed at the following levels: - Agent level.
+                      "enableInteractionLogging": True or False, # Enables DF Interaction logging.
+                      "enableStackdriverLogging": True or False, # Enables StackDriver logging.
+                    },
+                    "speechSettings": { # Define behaviors of speech to text detection. # Settings for speech to text detection. Exposed at the following levels: - Agent level - Flow level - Page level - Parameter level
+                      "endpointerSensitivity": 42, # Sensitivity of the speech model that detects the end of speech. Scale from 0 to 100.
+                      "models": { # Mapping from language to Speech-to-Text model. The mapped Speech-to-Text model will be selected for requests from its corresponding language. For more information, see [Speech models](https://cloud.google.com/dialogflow/cx/docs/concept/speech-models).
+                        "a_key": "A String",
+                      },
+                      "noSpeechTimeout": "A String", # Timeout before detecting no speech.
+                      "useTimeoutBasedEndpointing": True or False, # Use timeout based endpointing, interpreting endpointer sensitivy as seconds of timeout value.
+                    },
+                  },
+                  "description": "A String", # The description of the flow. The maximum length is 500 characters. If exceeded, the request is rejected.
+                  "displayName": "A String", # Required. The human-readable name of the flow.
+                  "eventHandlers": [ # A flow's event handlers serve two purposes: * They are responsible for handling events (e.g. no match, webhook errors) in the flow. * They are inherited by every page's event handlers, which can be used to handle common events regardless of the current page. Event handlers defined in the page have higher priority than those defined in the flow. Unlike transition_routes, these handlers are evaluated on a first-match basis. The first one that matches the event get executed, with the rest being ignored.
+                    { # An event handler specifies an event that can be handled during a session. When the specified event happens, the following actions are taken in order: * If there is a `trigger_fulfillment` associated with the event, it will be called. * If there is a `target_page` associated with the event, the session will transition into the specified page. * If there is a `target_flow` associated with the event, the session will transition into the specified flow.
+                      "event": "A String", # Required. The name of the event to handle.
+                      "name": "A String", # Output only. The unique identifier of this event handler.
+                      "targetFlow": "A String", # The target flow to transition to. Format: `projects//locations//agents//flows/`.
+                      "targetPage": "A String", # The target page to transition to. Format: `projects//locations//agents//flows//pages/`.
+                      "triggerFulfillment": { # A fulfillment can do one or more of the following actions at the same time: * Generate rich message responses. * Set parameter values. * Call the webhook. Fulfillments can be called at various stages in the Page or Form lifecycle. For example, when a DetectIntentRequest drives a session to enter a new page, the page's entry fulfillment can add a static response to the QueryResult in the returning DetectIntentResponse, call the webhook (for example, to load user data from a database), or both. # The fulfillment to call when the event occurs. Handling webhook errors with a fulfillment enabled with webhook could cause infinite loop. It is invalid to specify such fulfillment for a handler handling webhooks.
+                        "advancedSettings": { # Hierarchical advanced settings for agent/flow/page/fulfillment/parameter. Settings exposed at lower level overrides the settings exposed at higher level. Overriding occurs at the sub-setting level. For example, the playback_interruption_settings at fulfillment level only overrides the playback_interruption_settings at the agent level, leaving other settings at the agent level unchanged. DTMF settings does not override each other. DTMF settings set at different levels define DTMF detections running in parallel. Hierarchy: Agent->Flow->Page->Fulfillment/Parameter. # Hierarchical advanced settings for this fulfillment. The settings exposed at the lower level overrides the settings exposed at the higher level.
+                          "audioExportGcsDestination": { # Google Cloud Storage location for a Dialogflow operation that writes or exports objects (e.g. exported agent or transcripts) outside of Dialogflow. # If present, incoming audio is exported by Dialogflow to the configured Google Cloud Storage destination. Exposed at the following levels: - Agent level - Flow level
+                            "uri": "A String", # Required. The Google Cloud Storage URI for the exported objects. A URI is of the form: `gs://bucket/object-name-or-prefix` Whether a full object name, or just a prefix, its usage depends on the Dialogflow operation.
+                          },
+                          "dtmfSettings": { # Define behaviors for DTMF (dual tone multi frequency). # Settings for DTMF. Exposed at the following levels: - Agent level - Flow level - Page level - Parameter level.
+                            "enabled": True or False, # If true, incoming audio is processed for DTMF (dual tone multi frequency) events. For example, if the caller presses a button on their telephone keypad and DTMF processing is enabled, Dialogflow will detect the event (e.g. a "3" was pressed) in the incoming audio and pass the event to the bot to drive business logic (e.g. when 3 is pressed, return the account balance).
+                            "endpointingTimeoutDuration": "A String", # Endpoint timeout setting for matching dtmf input to regex.
+                            "finishDigit": "A String", # The digit that terminates a DTMF digit sequence.
+                            "interdigitTimeoutDuration": "A String", # Interdigit timeout setting for matching dtmf input to regex.
+                            "maxDigits": 42, # Max length of DTMF digits.
+                          },
+                          "loggingSettings": { # Define behaviors on logging. # Settings for logging. Settings for Dialogflow History, Contact Center messages, StackDriver logs, and speech logging. Exposed at the following levels: - Agent level.
+                            "enableInteractionLogging": True or False, # Enables DF Interaction logging.
+                            "enableStackdriverLogging": True or False, # Enables StackDriver logging.
+                          },
+                          "speechSettings": { # Define behaviors of speech to text detection. # Settings for speech to text detection. Exposed at the following levels: - Agent level - Flow level - Page level - Parameter level
+                            "endpointerSensitivity": 42, # Sensitivity of the speech model that detects the end of speech. Scale from 0 to 100.
+                            "models": { # Mapping from language to Speech-to-Text model. The mapped Speech-to-Text model will be selected for requests from its corresponding language. For more information, see [Speech models](https://cloud.google.com/dialogflow/cx/docs/concept/speech-models).
+                              "a_key": "A String",
+                            },
+                            "noSpeechTimeout": "A String", # Timeout before detecting no speech.
+                            "useTimeoutBasedEndpointing": True or False, # Use timeout based endpointing, interpreting endpointer sensitivy as seconds of timeout value.
+                          },
+                        },
+                        "conditionalCases": [ # Conditional cases for this fulfillment.
+                          { # A list of cascading if-else conditions. Cases are mutually exclusive. The first one with a matching condition is selected, all the rest ignored.
+                            "cases": [ # A list of cascading if-else conditions.
+                              { # Each case has a Boolean condition. When it is evaluated to be True, the corresponding messages will be selected and evaluated recursively.
+                                "caseContent": [ # A list of case content.
+                                  { # The list of messages or conditional cases to activate for this case.
+                                    "additionalCases": # Object with schema name: GoogleCloudDialogflowCxV3beta1FulfillmentConditionalCases # Additional cases to be evaluated.
+                                    "message": { # 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. # Returned message.
+                                      "channel": "A String", # The channel which the response is associated with. Clients can specify the channel via QueryParameters.channel, and only associated channel response will be returned.
+                                      "conversationSuccess": { # 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. # Indicates that the conversation succeeded.
+                                        "metadata": { # Custom metadata. Dialogflow doesn't impose any structure on this.
+                                          "a_key": "", # Properties of the object.
+                                        },
+                                      },
+                                      "endInteraction": { # 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. # Output only. A signal that indicates the interaction with the Dialogflow agent has ended. This message is generated by Dialogflow only when the conversation reaches `END_SESSION` page. It is not supposed to be defined by the user. It's guaranteed that there is at most one such message in each response.
+                                      },
+                                      "knowledgeInfoCard": { # Represents info card response. If the response contains generative knowledge prediction, Dialogflow will return a payload with Infobot Messenger compatible info card. Otherwise, the info card response is skipped. # Represents info card for knowledge answers, to be better rendered in Dialogflow Messenger.
+                                      },
+                                      "liveAgentHandoff": { # 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. # Hands off conversation to a human agent.
+                                        "metadata": { # Custom metadata for your handoff procedure. Dialogflow doesn't impose any structure on this.
+                                          "a_key": "", # Properties of the object.
+                                        },
+                                      },
+                                      "mixedAudio": { # 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. # Output only. An audio response message composed of both the synthesized Dialogflow agent responses and responses defined via play_audio. This message is generated by Dialogflow only and not supposed to be defined by the user.
+                                        "segments": [ # Segments this audio response is composed of.
+                                          { # Represents one segment of audio.
+                                            "allowPlaybackInterruption": True or False, # 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.
+                                            "audio": "A String", # Raw audio synthesized from the Dialogflow agent's response using the output config specified in the request.
+                                            "uri": "A String", # Client-specific URI that points to an audio clip accessible to the client. Dialogflow does not impose any validation on it.
+                                          },
+                                        ],
+                                      },
+                                      "outputAudioText": { # A text or ssml response that is preferentially used for TTS output audio synthesis, as described in the comment on the ResponseMessage message. # A text or ssml response that is preferentially used for TTS output audio synthesis, as described in the comment on the ResponseMessage message.
+                                        "allowPlaybackInterruption": True or False, # 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.
+                                        "ssml": "A String", # The SSML text to be synthesized. For more information, see [SSML](/speech/text-to-speech/docs/ssml).
+                                        "text": "A String", # The raw text to be synthesized.
+                                      },
+                                      "payload": { # Returns a response containing a custom, platform-specific payload.
+                                        "a_key": "", # Properties of the object.
+                                      },
+                                      "playAudio": { # Specifies an audio clip to be played by the client as part of the response. # Signal that the client should play an audio clip hosted at a client-specific URI. Dialogflow uses this to construct mixed_audio. However, Dialogflow itself does not try to read or process the URI in any way.
+                                        "allowPlaybackInterruption": True or False, # 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.
+                                        "audioUri": "A String", # Required. URI of the audio clip. Dialogflow does not impose any validation on this value. It is specific to the client that reads it.
+                                      },
+                                      "telephonyTransferCall": { # Represents the signal that telles the client to transfer the phone call connected to the agent to a third-party endpoint. # A signal that the client should transfer the phone call connected to this agent to a third-party endpoint.
+                                        "phoneNumber": "A String", # Transfer the call to a phone number in [E.164 format](https://en.wikipedia.org/wiki/E.164).
+                                      },
+                                      "text": { # The text response message. # Returns a text response.
+                                        "allowPlaybackInterruption": True or False, # 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.
+                                        "text": [ # Required. A collection of text responses.
+                                          "A String",
+                                        ],
+                                      },
+                                      "toolCall": { # Represents a call of a specific tool's action with the specified inputs. # Returns the definition of a tool call that should be executed by the client.
+                                        "action": "A String", # Required. The name of the tool's action associated with this call.
+                                        "inputParameters": { # Optional. The action's input parameters.
+                                          "a_key": "", # Properties of the object.
+                                        },
+                                        "tool": "A String", # Required. The tool associated with this call. Format: `projects//locations//agents//tools/`.
+                                      },
+                                    },
+                                  },
+                                ],
+                                "condition": "A String", # The condition to activate and select this case. Empty means the condition is always true. The condition is evaluated against form parameters or session parameters. See the [conditions reference](https://cloud.google.com/dialogflow/cx/docs/reference/condition).
+                              },
+                            ],
+                          },
+                        ],
+                        "enableGenerativeFallback": True or False, # If the flag is true, the agent will utilize LLM to generate a text response. If LLM generation fails, the defined responses in the fulfillment will be respected. This flag is only useful for fulfillments associated with no-match event handlers.
+                        "messages": [ # The list of rich message responses to present to the user.
+                          { # 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.
+                            "channel": "A String", # The channel which the response is associated with. Clients can specify the channel via QueryParameters.channel, and only associated channel response will be returned.
+                            "conversationSuccess": { # 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. # Indicates that the conversation succeeded.
+                              "metadata": { # Custom metadata. Dialogflow doesn't impose any structure on this.
+                                "a_key": "", # Properties of the object.
+                              },
+                            },
+                            "endInteraction": { # 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. # Output only. A signal that indicates the interaction with the Dialogflow agent has ended. This message is generated by Dialogflow only when the conversation reaches `END_SESSION` page. It is not supposed to be defined by the user. It's guaranteed that there is at most one such message in each response.
+                            },
+                            "knowledgeInfoCard": { # Represents info card response. If the response contains generative knowledge prediction, Dialogflow will return a payload with Infobot Messenger compatible info card. Otherwise, the info card response is skipped. # Represents info card for knowledge answers, to be better rendered in Dialogflow Messenger.
+                            },
+                            "liveAgentHandoff": { # 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. # Hands off conversation to a human agent.
+                              "metadata": { # Custom metadata for your handoff procedure. Dialogflow doesn't impose any structure on this.
+                                "a_key": "", # Properties of the object.
+                              },
+                            },
+                            "mixedAudio": { # 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. # Output only. An audio response message composed of both the synthesized Dialogflow agent responses and responses defined via play_audio. This message is generated by Dialogflow only and not supposed to be defined by the user.
+                              "segments": [ # Segments this audio response is composed of.
+                                { # Represents one segment of audio.
+                                  "allowPlaybackInterruption": True or False, # 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.
+                                  "audio": "A String", # Raw audio synthesized from the Dialogflow agent's response using the output config specified in the request.
+                                  "uri": "A String", # Client-specific URI that points to an audio clip accessible to the client. Dialogflow does not impose any validation on it.
+                                },
+                              ],
+                            },
+                            "outputAudioText": { # A text or ssml response that is preferentially used for TTS output audio synthesis, as described in the comment on the ResponseMessage message. # A text or ssml response that is preferentially used for TTS output audio synthesis, as described in the comment on the ResponseMessage message.
+                              "allowPlaybackInterruption": True or False, # 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.
+                              "ssml": "A String", # The SSML text to be synthesized. For more information, see [SSML](/speech/text-to-speech/docs/ssml).
+                              "text": "A String", # The raw text to be synthesized.
+                            },
+                            "payload": { # Returns a response containing a custom, platform-specific payload.
+                              "a_key": "", # Properties of the object.
+                            },
+                            "playAudio": { # Specifies an audio clip to be played by the client as part of the response. # Signal that the client should play an audio clip hosted at a client-specific URI. Dialogflow uses this to construct mixed_audio. However, Dialogflow itself does not try to read or process the URI in any way.
+                              "allowPlaybackInterruption": True or False, # 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.
+                              "audioUri": "A String", # Required. URI of the audio clip. Dialogflow does not impose any validation on this value. It is specific to the client that reads it.
+                            },
+                            "telephonyTransferCall": { # Represents the signal that telles the client to transfer the phone call connected to the agent to a third-party endpoint. # A signal that the client should transfer the phone call connected to this agent to a third-party endpoint.
+                              "phoneNumber": "A String", # Transfer the call to a phone number in [E.164 format](https://en.wikipedia.org/wiki/E.164).
+                            },
+                            "text": { # The text response message. # Returns a text response.
+                              "allowPlaybackInterruption": True or False, # 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.
+                              "text": [ # Required. A collection of text responses.
+                                "A String",
+                              ],
+                            },
+                            "toolCall": { # Represents a call of a specific tool's action with the specified inputs. # Returns the definition of a tool call that should be executed by the client.
+                              "action": "A String", # Required. The name of the tool's action associated with this call.
+                              "inputParameters": { # Optional. The action's input parameters.
+                                "a_key": "", # Properties of the object.
+                              },
+                              "tool": "A String", # Required. The tool associated with this call. Format: `projects//locations//agents//tools/`.
+                            },
+                          },
+                        ],
+                        "returnPartialResponses": True or False, # Whether Dialogflow should return currently queued fulfillment response messages in streaming APIs. If a webhook is specified, it happens before Dialogflow invokes webhook. Warning: 1) This flag only affects streaming API. Responses are still queued and returned once in non-streaming API. 2) The flag can be enabled in any fulfillment but only the first 3 partial responses will be returned. You may only want to apply it to fulfillments that have slow webhooks.
+                        "setParameterActions": [ # Set parameter values before executing the webhook.
+                          { # Setting a parameter value.
+                            "parameter": "A String", # Display name of the parameter.
+                            "value": "", # The new value of the parameter. A null value clears the parameter.
+                          },
+                        ],
+                        "tag": "A String", # The value of this field will be populated in the WebhookRequest `fulfillmentInfo.tag` field by Dialogflow when the associated webhook is called. The tag is typically used by the webhook service to identify which fulfillment is being called, but it could be used for other purposes. This field is required if `webhook` is specified.
+                        "webhook": "A String", # The webhook to call. Format: `projects//locations//agents//webhooks/`.
+                      },
+                    },
+                  ],
+                  "knowledgeConnectorSettings": { # The Knowledge Connector settings for this page or flow. This includes information such as the attached Knowledge Bases, and the way to execute fulfillment. # Optional. Knowledge connector configuration.
+                    "dataStoreConnections": [ # Optional. List of related data store connections.
+                      { # A data store connection. It represents a data store in Discovery Engine and the type of the contents it contains.
+                        "dataStore": "A String", # The full name of the referenced data store. Formats: `projects/{project}/locations/{location}/collections/{collection}/dataStores/{data_store}` `projects/{project}/locations/{location}/dataStores/{data_store}`
+                        "dataStoreType": "A String", # The type of the connected data store.
+                      },
+                    ],
+                    "enabled": True or False, # Whether Knowledge Connector is enabled or not.
+                    "targetFlow": "A String", # The target flow to transition to. Format: `projects//locations//agents//flows/`.
+                    "targetPage": "A String", # The target page to transition to. Format: `projects//locations//agents//flows//pages/`.
+                    "triggerFulfillment": { # A fulfillment can do one or more of the following actions at the same time: * Generate rich message responses. * Set parameter values. * Call the webhook. Fulfillments can be called at various stages in the Page or Form lifecycle. For example, when a DetectIntentRequest drives a session to enter a new page, the page's entry fulfillment can add a static response to the QueryResult in the returning DetectIntentResponse, call the webhook (for example, to load user data from a database), or both. # The fulfillment to be triggered. When the answers from the Knowledge Connector are selected by Dialogflow, you can utitlize the request scoped parameter `$request.knowledge.answers` (contains up to the 5 highest confidence answers) and `$request.knowledge.questions` (contains the corresponding questions) to construct the fulfillment.
+                      "advancedSettings": { # Hierarchical advanced settings for agent/flow/page/fulfillment/parameter. Settings exposed at lower level overrides the settings exposed at higher level. Overriding occurs at the sub-setting level. For example, the playback_interruption_settings at fulfillment level only overrides the playback_interruption_settings at the agent level, leaving other settings at the agent level unchanged. DTMF settings does not override each other. DTMF settings set at different levels define DTMF detections running in parallel. Hierarchy: Agent->Flow->Page->Fulfillment/Parameter. # Hierarchical advanced settings for this fulfillment. The settings exposed at the lower level overrides the settings exposed at the higher level.
+                        "audioExportGcsDestination": { # Google Cloud Storage location for a Dialogflow operation that writes or exports objects (e.g. exported agent or transcripts) outside of Dialogflow. # If present, incoming audio is exported by Dialogflow to the configured Google Cloud Storage destination. Exposed at the following levels: - Agent level - Flow level
+                          "uri": "A String", # Required. The Google Cloud Storage URI for the exported objects. A URI is of the form: `gs://bucket/object-name-or-prefix` Whether a full object name, or just a prefix, its usage depends on the Dialogflow operation.
+                        },
+                        "dtmfSettings": { # Define behaviors for DTMF (dual tone multi frequency). # Settings for DTMF. Exposed at the following levels: - Agent level - Flow level - Page level - Parameter level.
+                          "enabled": True or False, # If true, incoming audio is processed for DTMF (dual tone multi frequency) events. For example, if the caller presses a button on their telephone keypad and DTMF processing is enabled, Dialogflow will detect the event (e.g. a "3" was pressed) in the incoming audio and pass the event to the bot to drive business logic (e.g. when 3 is pressed, return the account balance).
+                          "endpointingTimeoutDuration": "A String", # Endpoint timeout setting for matching dtmf input to regex.
+                          "finishDigit": "A String", # The digit that terminates a DTMF digit sequence.
+                          "interdigitTimeoutDuration": "A String", # Interdigit timeout setting for matching dtmf input to regex.
+                          "maxDigits": 42, # Max length of DTMF digits.
+                        },
+                        "loggingSettings": { # Define behaviors on logging. # Settings for logging. Settings for Dialogflow History, Contact Center messages, StackDriver logs, and speech logging. Exposed at the following levels: - Agent level.
+                          "enableInteractionLogging": True or False, # Enables DF Interaction logging.
+                          "enableStackdriverLogging": True or False, # Enables StackDriver logging.
+                        },
+                        "speechSettings": { # Define behaviors of speech to text detection. # Settings for speech to text detection. Exposed at the following levels: - Agent level - Flow level - Page level - Parameter level
+                          "endpointerSensitivity": 42, # Sensitivity of the speech model that detects the end of speech. Scale from 0 to 100.
+                          "models": { # Mapping from language to Speech-to-Text model. The mapped Speech-to-Text model will be selected for requests from its corresponding language. For more information, see [Speech models](https://cloud.google.com/dialogflow/cx/docs/concept/speech-models).
+                            "a_key": "A String",
+                          },
+                          "noSpeechTimeout": "A String", # Timeout before detecting no speech.
+                          "useTimeoutBasedEndpointing": True or False, # Use timeout based endpointing, interpreting endpointer sensitivy as seconds of timeout value.
+                        },
+                      },
+                      "conditionalCases": [ # Conditional cases for this fulfillment.
+                        { # A list of cascading if-else conditions. Cases are mutually exclusive. The first one with a matching condition is selected, all the rest ignored.
+                          "cases": [ # A list of cascading if-else conditions.
+                            { # Each case has a Boolean condition. When it is evaluated to be True, the corresponding messages will be selected and evaluated recursively.
+                              "caseContent": [ # A list of case content.
+                                { # The list of messages or conditional cases to activate for this case.
+                                  "additionalCases": # Object with schema name: GoogleCloudDialogflowCxV3beta1FulfillmentConditionalCases # Additional cases to be evaluated.
+                                  "message": { # 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. # Returned message.
+                                    "channel": "A String", # The channel which the response is associated with. Clients can specify the channel via QueryParameters.channel, and only associated channel response will be returned.
+                                    "conversationSuccess": { # 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. # Indicates that the conversation succeeded.
+                                      "metadata": { # Custom metadata. Dialogflow doesn't impose any structure on this.
+                                        "a_key": "", # Properties of the object.
+                                      },
+                                    },
+                                    "endInteraction": { # 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. # Output only. A signal that indicates the interaction with the Dialogflow agent has ended. This message is generated by Dialogflow only when the conversation reaches `END_SESSION` page. It is not supposed to be defined by the user. It's guaranteed that there is at most one such message in each response.
+                                    },
+                                    "knowledgeInfoCard": { # Represents info card response. If the response contains generative knowledge prediction, Dialogflow will return a payload with Infobot Messenger compatible info card. Otherwise, the info card response is skipped. # Represents info card for knowledge answers, to be better rendered in Dialogflow Messenger.
+                                    },
+                                    "liveAgentHandoff": { # 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. # Hands off conversation to a human agent.
+                                      "metadata": { # Custom metadata for your handoff procedure. Dialogflow doesn't impose any structure on this.
+                                        "a_key": "", # Properties of the object.
+                                      },
+                                    },
+                                    "mixedAudio": { # 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. # Output only. An audio response message composed of both the synthesized Dialogflow agent responses and responses defined via play_audio. This message is generated by Dialogflow only and not supposed to be defined by the user.
+                                      "segments": [ # Segments this audio response is composed of.
+                                        { # Represents one segment of audio.
+                                          "allowPlaybackInterruption": True or False, # 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.
+                                          "audio": "A String", # Raw audio synthesized from the Dialogflow agent's response using the output config specified in the request.
+                                          "uri": "A String", # Client-specific URI that points to an audio clip accessible to the client. Dialogflow does not impose any validation on it.
+                                        },
+                                      ],
+                                    },
+                                    "outputAudioText": { # A text or ssml response that is preferentially used for TTS output audio synthesis, as described in the comment on the ResponseMessage message. # A text or ssml response that is preferentially used for TTS output audio synthesis, as described in the comment on the ResponseMessage message.
+                                      "allowPlaybackInterruption": True or False, # 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.
+                                      "ssml": "A String", # The SSML text to be synthesized. For more information, see [SSML](/speech/text-to-speech/docs/ssml).
+                                      "text": "A String", # The raw text to be synthesized.
+                                    },
+                                    "payload": { # Returns a response containing a custom, platform-specific payload.
+                                      "a_key": "", # Properties of the object.
+                                    },
+                                    "playAudio": { # Specifies an audio clip to be played by the client as part of the response. # Signal that the client should play an audio clip hosted at a client-specific URI. Dialogflow uses this to construct mixed_audio. However, Dialogflow itself does not try to read or process the URI in any way.
+                                      "allowPlaybackInterruption": True or False, # 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.
+                                      "audioUri": "A String", # Required. URI of the audio clip. Dialogflow does not impose any validation on this value. It is specific to the client that reads it.
+                                    },
+                                    "telephonyTransferCall": { # Represents the signal that telles the client to transfer the phone call connected to the agent to a third-party endpoint. # A signal that the client should transfer the phone call connected to this agent to a third-party endpoint.
+                                      "phoneNumber": "A String", # Transfer the call to a phone number in [E.164 format](https://en.wikipedia.org/wiki/E.164).
+                                    },
+                                    "text": { # The text response message. # Returns a text response.
+                                      "allowPlaybackInterruption": True or False, # 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.
+                                      "text": [ # Required. A collection of text responses.
+                                        "A String",
+                                      ],
+                                    },
+                                    "toolCall": { # Represents a call of a specific tool's action with the specified inputs. # Returns the definition of a tool call that should be executed by the client.
+                                      "action": "A String", # Required. The name of the tool's action associated with this call.
+                                      "inputParameters": { # Optional. The action's input parameters.
+                                        "a_key": "", # Properties of the object.
+                                      },
+                                      "tool": "A String", # Required. The tool associated with this call. Format: `projects//locations//agents//tools/`.
+                                    },
+                                  },
+                                },
+                              ],
+                              "condition": "A String", # The condition to activate and select this case. Empty means the condition is always true. The condition is evaluated against form parameters or session parameters. See the [conditions reference](https://cloud.google.com/dialogflow/cx/docs/reference/condition).
+                            },
+                          ],
+                        },
+                      ],
+                      "enableGenerativeFallback": True or False, # If the flag is true, the agent will utilize LLM to generate a text response. If LLM generation fails, the defined responses in the fulfillment will be respected. This flag is only useful for fulfillments associated with no-match event handlers.
+                      "messages": [ # The list of rich message responses to present to the user.
+                        { # 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.
+                          "channel": "A String", # The channel which the response is associated with. Clients can specify the channel via QueryParameters.channel, and only associated channel response will be returned.
+                          "conversationSuccess": { # 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. # Indicates that the conversation succeeded.
+                            "metadata": { # Custom metadata. Dialogflow doesn't impose any structure on this.
+                              "a_key": "", # Properties of the object.
+                            },
+                          },
+                          "endInteraction": { # 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. # Output only. A signal that indicates the interaction with the Dialogflow agent has ended. This message is generated by Dialogflow only when the conversation reaches `END_SESSION` page. It is not supposed to be defined by the user. It's guaranteed that there is at most one such message in each response.
+                          },
+                          "knowledgeInfoCard": { # Represents info card response. If the response contains generative knowledge prediction, Dialogflow will return a payload with Infobot Messenger compatible info card. Otherwise, the info card response is skipped. # Represents info card for knowledge answers, to be better rendered in Dialogflow Messenger.
+                          },
+                          "liveAgentHandoff": { # 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. # Hands off conversation to a human agent.
+                            "metadata": { # Custom metadata for your handoff procedure. Dialogflow doesn't impose any structure on this.
+                              "a_key": "", # Properties of the object.
+                            },
+                          },
+                          "mixedAudio": { # 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. # Output only. An audio response message composed of both the synthesized Dialogflow agent responses and responses defined via play_audio. This message is generated by Dialogflow only and not supposed to be defined by the user.
+                            "segments": [ # Segments this audio response is composed of.
+                              { # Represents one segment of audio.
+                                "allowPlaybackInterruption": True or False, # 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.
+                                "audio": "A String", # Raw audio synthesized from the Dialogflow agent's response using the output config specified in the request.
+                                "uri": "A String", # Client-specific URI that points to an audio clip accessible to the client. Dialogflow does not impose any validation on it.
+                              },
+                            ],
+                          },
+                          "outputAudioText": { # A text or ssml response that is preferentially used for TTS output audio synthesis, as described in the comment on the ResponseMessage message. # A text or ssml response that is preferentially used for TTS output audio synthesis, as described in the comment on the ResponseMessage message.
+                            "allowPlaybackInterruption": True or False, # 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.
+                            "ssml": "A String", # The SSML text to be synthesized. For more information, see [SSML](/speech/text-to-speech/docs/ssml).
+                            "text": "A String", # The raw text to be synthesized.
+                          },
+                          "payload": { # Returns a response containing a custom, platform-specific payload.
+                            "a_key": "", # Properties of the object.
+                          },
+                          "playAudio": { # Specifies an audio clip to be played by the client as part of the response. # Signal that the client should play an audio clip hosted at a client-specific URI. Dialogflow uses this to construct mixed_audio. However, Dialogflow itself does not try to read or process the URI in any way.
+                            "allowPlaybackInterruption": True or False, # 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.
+                            "audioUri": "A String", # Required. URI of the audio clip. Dialogflow does not impose any validation on this value. It is specific to the client that reads it.
+                          },
+                          "telephonyTransferCall": { # Represents the signal that telles the client to transfer the phone call connected to the agent to a third-party endpoint. # A signal that the client should transfer the phone call connected to this agent to a third-party endpoint.
+                            "phoneNumber": "A String", # Transfer the call to a phone number in [E.164 format](https://en.wikipedia.org/wiki/E.164).
+                          },
+                          "text": { # The text response message. # Returns a text response.
+                            "allowPlaybackInterruption": True or False, # 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.
+                            "text": [ # Required. A collection of text responses.
+                              "A String",
+                            ],
+                          },
+                          "toolCall": { # Represents a call of a specific tool's action with the specified inputs. # Returns the definition of a tool call that should be executed by the client.
+                            "action": "A String", # Required. The name of the tool's action associated with this call.
+                            "inputParameters": { # Optional. The action's input parameters.
+                              "a_key": "", # Properties of the object.
+                            },
+                            "tool": "A String", # Required. The tool associated with this call. Format: `projects//locations//agents//tools/`.
+                          },
+                        },
+                      ],
+                      "returnPartialResponses": True or False, # Whether Dialogflow should return currently queued fulfillment response messages in streaming APIs. If a webhook is specified, it happens before Dialogflow invokes webhook. Warning: 1) This flag only affects streaming API. Responses are still queued and returned once in non-streaming API. 2) The flag can be enabled in any fulfillment but only the first 3 partial responses will be returned. You may only want to apply it to fulfillments that have slow webhooks.
+                      "setParameterActions": [ # Set parameter values before executing the webhook.
+                        { # Setting a parameter value.
+                          "parameter": "A String", # Display name of the parameter.
+                          "value": "", # The new value of the parameter. A null value clears the parameter.
+                        },
+                      ],
+                      "tag": "A String", # The value of this field will be populated in the WebhookRequest `fulfillmentInfo.tag` field by Dialogflow when the associated webhook is called. The tag is typically used by the webhook service to identify which fulfillment is being called, but it could be used for other purposes. This field is required if `webhook` is specified.
+                      "webhook": "A String", # The webhook to call. Format: `projects//locations//agents//webhooks/`.
+                    },
+                  },
+                  "multiLanguageSettings": { # Settings for multi-lingual agents. # Optional. Multi-lingual agent settings for this flow.
+                    "enableMultiLanguageDetection": True or False, # Optional. Enable multi-language detection for this flow. This can be set only if agent level multi language setting is enabled.
+                    "supportedResponseLanguageCodes": [ # Optional. Agent will respond in the detected language if the detected language code is in the supported resolved languages for this flow. This will be used only if multi-language training is enabled in the agent and multi-language detection is enabled in the flow. The supported languages must be a subset of the languages supported by the agent.
+                      "A String",
+                    ],
+                  },
+                  "name": "A String", # The unique identifier of the flow. Format: `projects//locations//agents//flows/`.
+                  "nluSettings": { # Settings related to NLU. # NLU related settings of the flow.
+                    "classificationThreshold": 3.14, # To filter out false positive results and still get variety in matched natural language inputs for your agent, you can tune the machine learning classification threshold. If the returned score value is less than the threshold value, then a no-match event will be triggered. The score values range from 0.0 (completely uncertain) to 1.0 (completely certain). If set to 0.0, the default of 0.3 is used.
+                    "modelTrainingMode": "A String", # Indicates NLU model training mode.
+                    "modelType": "A String", # Indicates the type of NLU model.
+                  },
+                  "transitionRouteGroups": [ # A flow's transition route group serve two purposes: * They are responsible for matching the user's first utterances in the flow. * They are inherited by every page's transition route groups. Transition route groups defined in the page have higher priority than those defined in the flow. Format:`projects//locations//agents//flows//transitionRouteGroups/` or `projects//locations//agents//transitionRouteGroups/` for agent-level groups.
+                    "A String",
+                  ],
+                  "transitionRoutes": [ # A flow's transition routes serve two purposes: * They are responsible for matching the user's first utterances in the flow. * They are inherited by every page's transition routes and can support use cases such as the user saying "help" or "can I talk to a human?", which can be handled in a common way regardless of the current page. Transition routes defined in the page have higher priority than those defined in the flow. TransitionRoutes are evalauted in the following order: * TransitionRoutes with intent specified. * TransitionRoutes with only condition specified. TransitionRoutes with intent specified are inherited by pages in the flow.
+                    { # A transition route specifies a intent that can be matched and/or a data condition that can be evaluated during a session. When a specified transition is matched, the following actions are taken in order: * If there is a `trigger_fulfillment` associated with the transition, it will be called. * If there is a `target_page` associated with the transition, the session will transition into the specified page. * If there is a `target_flow` associated with the transition, the session will transition into the specified flow.
+                      "condition": "A String", # The condition to evaluate against form parameters or session parameters. See the [conditions reference](https://cloud.google.com/dialogflow/cx/docs/reference/condition). At least one of `intent` or `condition` must be specified. When both `intent` and `condition` are specified, the transition can only happen when both are fulfilled.
+                      "description": "A String", # Optional. The description of the transition route. The maximum length is 500 characters.
+                      "intent": "A String", # The unique identifier of an Intent. Format: `projects//locations//agents//intents/`. Indicates that the transition can only happen when the given intent is matched. At least one of `intent` or `condition` must be specified. When both `intent` and `condition` are specified, the transition can only happen when both are fulfilled.
+                      "name": "A String", # Output only. The unique identifier of this transition route.
+                      "targetFlow": "A String", # The target flow to transition to. Format: `projects//locations//agents//flows/`.
+                      "targetPage": "A String", # The target page to transition to. Format: `projects//locations//agents//flows//pages/`.
+                      "triggerFulfillment": { # A fulfillment can do one or more of the following actions at the same time: * Generate rich message responses. * Set parameter values. * Call the webhook. Fulfillments can be called at various stages in the Page or Form lifecycle. For example, when a DetectIntentRequest drives a session to enter a new page, the page's entry fulfillment can add a static response to the QueryResult in the returning DetectIntentResponse, call the webhook (for example, to load user data from a database), or both. # The fulfillment to call when the condition is satisfied. At least one of `trigger_fulfillment` and `target` must be specified. When both are defined, `trigger_fulfillment` is executed first.
+                        "advancedSettings": { # Hierarchical advanced settings for agent/flow/page/fulfillment/parameter. Settings exposed at lower level overrides the settings exposed at higher level. Overriding occurs at the sub-setting level. For example, the playback_interruption_settings at fulfillment level only overrides the playback_interruption_settings at the agent level, leaving other settings at the agent level unchanged. DTMF settings does not override each other. DTMF settings set at different levels define DTMF detections running in parallel. Hierarchy: Agent->Flow->Page->Fulfillment/Parameter. # Hierarchical advanced settings for this fulfillment. The settings exposed at the lower level overrides the settings exposed at the higher level.
+                          "audioExportGcsDestination": { # Google Cloud Storage location for a Dialogflow operation that writes or exports objects (e.g. exported agent or transcripts) outside of Dialogflow. # If present, incoming audio is exported by Dialogflow to the configured Google Cloud Storage destination. Exposed at the following levels: - Agent level - Flow level
+                            "uri": "A String", # Required. The Google Cloud Storage URI for the exported objects. A URI is of the form: `gs://bucket/object-name-or-prefix` Whether a full object name, or just a prefix, its usage depends on the Dialogflow operation.
+                          },
+                          "dtmfSettings": { # Define behaviors for DTMF (dual tone multi frequency). # Settings for DTMF. Exposed at the following levels: - Agent level - Flow level - Page level - Parameter level.
+                            "enabled": True or False, # If true, incoming audio is processed for DTMF (dual tone multi frequency) events. For example, if the caller presses a button on their telephone keypad and DTMF processing is enabled, Dialogflow will detect the event (e.g. a "3" was pressed) in the incoming audio and pass the event to the bot to drive business logic (e.g. when 3 is pressed, return the account balance).
+                            "endpointingTimeoutDuration": "A String", # Endpoint timeout setting for matching dtmf input to regex.
+                            "finishDigit": "A String", # The digit that terminates a DTMF digit sequence.
+                            "interdigitTimeoutDuration": "A String", # Interdigit timeout setting for matching dtmf input to regex.
+                            "maxDigits": 42, # Max length of DTMF digits.
+                          },
+                          "loggingSettings": { # Define behaviors on logging. # Settings for logging. Settings for Dialogflow History, Contact Center messages, StackDriver logs, and speech logging. Exposed at the following levels: - Agent level.
+                            "enableInteractionLogging": True or False, # Enables DF Interaction logging.
+                            "enableStackdriverLogging": True or False, # Enables StackDriver logging.
+                          },
+                          "speechSettings": { # Define behaviors of speech to text detection. # Settings for speech to text detection. Exposed at the following levels: - Agent level - Flow level - Page level - Parameter level
+                            "endpointerSensitivity": 42, # Sensitivity of the speech model that detects the end of speech. Scale from 0 to 100.
+                            "models": { # Mapping from language to Speech-to-Text model. The mapped Speech-to-Text model will be selected for requests from its corresponding language. For more information, see [Speech models](https://cloud.google.com/dialogflow/cx/docs/concept/speech-models).
+                              "a_key": "A String",
+                            },
+                            "noSpeechTimeout": "A String", # Timeout before detecting no speech.
+                            "useTimeoutBasedEndpointing": True or False, # Use timeout based endpointing, interpreting endpointer sensitivy as seconds of timeout value.
+                          },
+                        },
+                        "conditionalCases": [ # Conditional cases for this fulfillment.
+                          { # A list of cascading if-else conditions. Cases are mutually exclusive. The first one with a matching condition is selected, all the rest ignored.
+                            "cases": [ # A list of cascading if-else conditions.
+                              { # Each case has a Boolean condition. When it is evaluated to be True, the corresponding messages will be selected and evaluated recursively.
+                                "caseContent": [ # A list of case content.
+                                  { # The list of messages or conditional cases to activate for this case.
+                                    "additionalCases": # Object with schema name: GoogleCloudDialogflowCxV3beta1FulfillmentConditionalCases # Additional cases to be evaluated.
+                                    "message": { # 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. # Returned message.
+                                      "channel": "A String", # The channel which the response is associated with. Clients can specify the channel via QueryParameters.channel, and only associated channel response will be returned.
+                                      "conversationSuccess": { # 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. # Indicates that the conversation succeeded.
+                                        "metadata": { # Custom metadata. Dialogflow doesn't impose any structure on this.
+                                          "a_key": "", # Properties of the object.
+                                        },
+                                      },
+                                      "endInteraction": { # 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. # Output only. A signal that indicates the interaction with the Dialogflow agent has ended. This message is generated by Dialogflow only when the conversation reaches `END_SESSION` page. It is not supposed to be defined by the user. It's guaranteed that there is at most one such message in each response.
+                                      },
+                                      "knowledgeInfoCard": { # Represents info card response. If the response contains generative knowledge prediction, Dialogflow will return a payload with Infobot Messenger compatible info card. Otherwise, the info card response is skipped. # Represents info card for knowledge answers, to be better rendered in Dialogflow Messenger.
+                                      },
+                                      "liveAgentHandoff": { # 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. # Hands off conversation to a human agent.
+                                        "metadata": { # Custom metadata for your handoff procedure. Dialogflow doesn't impose any structure on this.
+                                          "a_key": "", # Properties of the object.
+                                        },
+                                      },
+                                      "mixedAudio": { # 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. # Output only. An audio response message composed of both the synthesized Dialogflow agent responses and responses defined via play_audio. This message is generated by Dialogflow only and not supposed to be defined by the user.
+                                        "segments": [ # Segments this audio response is composed of.
+                                          { # Represents one segment of audio.
+                                            "allowPlaybackInterruption": True or False, # 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.
+                                            "audio": "A String", # Raw audio synthesized from the Dialogflow agent's response using the output config specified in the request.
+                                            "uri": "A String", # Client-specific URI that points to an audio clip accessible to the client. Dialogflow does not impose any validation on it.
+                                          },
+                                        ],
+                                      },
+                                      "outputAudioText": { # A text or ssml response that is preferentially used for TTS output audio synthesis, as described in the comment on the ResponseMessage message. # A text or ssml response that is preferentially used for TTS output audio synthesis, as described in the comment on the ResponseMessage message.
+                                        "allowPlaybackInterruption": True or False, # 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.
+                                        "ssml": "A String", # The SSML text to be synthesized. For more information, see [SSML](/speech/text-to-speech/docs/ssml).
+                                        "text": "A String", # The raw text to be synthesized.
+                                      },
+                                      "payload": { # Returns a response containing a custom, platform-specific payload.
+                                        "a_key": "", # Properties of the object.
+                                      },
+                                      "playAudio": { # Specifies an audio clip to be played by the client as part of the response. # Signal that the client should play an audio clip hosted at a client-specific URI. Dialogflow uses this to construct mixed_audio. However, Dialogflow itself does not try to read or process the URI in any way.
+                                        "allowPlaybackInterruption": True or False, # 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.
+                                        "audioUri": "A String", # Required. URI of the audio clip. Dialogflow does not impose any validation on this value. It is specific to the client that reads it.
+                                      },
+                                      "telephonyTransferCall": { # Represents the signal that telles the client to transfer the phone call connected to the agent to a third-party endpoint. # A signal that the client should transfer the phone call connected to this agent to a third-party endpoint.
+                                        "phoneNumber": "A String", # Transfer the call to a phone number in [E.164 format](https://en.wikipedia.org/wiki/E.164).
+                                      },
+                                      "text": { # The text response message. # Returns a text response.
+                                        "allowPlaybackInterruption": True or False, # 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.
+                                        "text": [ # Required. A collection of text responses.
+                                          "A String",
+                                        ],
+                                      },
+                                      "toolCall": { # Represents a call of a specific tool's action with the specified inputs. # Returns the definition of a tool call that should be executed by the client.
+                                        "action": "A String", # Required. The name of the tool's action associated with this call.
+                                        "inputParameters": { # Optional. The action's input parameters.
+                                          "a_key": "", # Properties of the object.
+                                        },
+                                        "tool": "A String", # Required. The tool associated with this call. Format: `projects//locations//agents//tools/`.
+                                      },
+                                    },
+                                  },
+                                ],
+                                "condition": "A String", # The condition to activate and select this case. Empty means the condition is always true. The condition is evaluated against form parameters or session parameters. See the [conditions reference](https://cloud.google.com/dialogflow/cx/docs/reference/condition).
+                              },
+                            ],
+                          },
+                        ],
+                        "enableGenerativeFallback": True or False, # If the flag is true, the agent will utilize LLM to generate a text response. If LLM generation fails, the defined responses in the fulfillment will be respected. This flag is only useful for fulfillments associated with no-match event handlers.
+                        "messages": [ # The list of rich message responses to present to the user.
+                          { # 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.
+                            "channel": "A String", # The channel which the response is associated with. Clients can specify the channel via QueryParameters.channel, and only associated channel response will be returned.
+                            "conversationSuccess": { # 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. # Indicates that the conversation succeeded.
+                              "metadata": { # Custom metadata. Dialogflow doesn't impose any structure on this.
+                                "a_key": "", # Properties of the object.
+                              },
+                            },
+                            "endInteraction": { # 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. # Output only. A signal that indicates the interaction with the Dialogflow agent has ended. This message is generated by Dialogflow only when the conversation reaches `END_SESSION` page. It is not supposed to be defined by the user. It's guaranteed that there is at most one such message in each response.
+                            },
+                            "knowledgeInfoCard": { # Represents info card response. If the response contains generative knowledge prediction, Dialogflow will return a payload with Infobot Messenger compatible info card. Otherwise, the info card response is skipped. # Represents info card for knowledge answers, to be better rendered in Dialogflow Messenger.
+                            },
+                            "liveAgentHandoff": { # 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. # Hands off conversation to a human agent.
+                              "metadata": { # Custom metadata for your handoff procedure. Dialogflow doesn't impose any structure on this.
+                                "a_key": "", # Properties of the object.
+                              },
+                            },
+                            "mixedAudio": { # 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. # Output only. An audio response message composed of both the synthesized Dialogflow agent responses and responses defined via play_audio. This message is generated by Dialogflow only and not supposed to be defined by the user.
+                              "segments": [ # Segments this audio response is composed of.
+                                { # Represents one segment of audio.
+                                  "allowPlaybackInterruption": True or False, # 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.
+                                  "audio": "A String", # Raw audio synthesized from the Dialogflow agent's response using the output config specified in the request.
+                                  "uri": "A String", # Client-specific URI that points to an audio clip accessible to the client. Dialogflow does not impose any validation on it.
+                                },
+                              ],
+                            },
+                            "outputAudioText": { # A text or ssml response that is preferentially used for TTS output audio synthesis, as described in the comment on the ResponseMessage message. # A text or ssml response that is preferentially used for TTS output audio synthesis, as described in the comment on the ResponseMessage message.
+                              "allowPlaybackInterruption": True or False, # 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.
+                              "ssml": "A String", # The SSML text to be synthesized. For more information, see [SSML](/speech/text-to-speech/docs/ssml).
+                              "text": "A String", # The raw text to be synthesized.
+                            },
+                            "payload": { # Returns a response containing a custom, platform-specific payload.
+                              "a_key": "", # Properties of the object.
+                            },
+                            "playAudio": { # Specifies an audio clip to be played by the client as part of the response. # Signal that the client should play an audio clip hosted at a client-specific URI. Dialogflow uses this to construct mixed_audio. However, Dialogflow itself does not try to read or process the URI in any way.
+                              "allowPlaybackInterruption": True or False, # 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.
+                              "audioUri": "A String", # Required. URI of the audio clip. Dialogflow does not impose any validation on this value. It is specific to the client that reads it.
+                            },
+                            "telephonyTransferCall": { # Represents the signal that telles the client to transfer the phone call connected to the agent to a third-party endpoint. # A signal that the client should transfer the phone call connected to this agent to a third-party endpoint.
+                              "phoneNumber": "A String", # Transfer the call to a phone number in [E.164 format](https://en.wikipedia.org/wiki/E.164).
+                            },
+                            "text": { # The text response message. # Returns a text response.
+                              "allowPlaybackInterruption": True or False, # 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.
+                              "text": [ # Required. A collection of text responses.
+                                "A String",
+                              ],
+                            },
+                            "toolCall": { # Represents a call of a specific tool's action with the specified inputs. # Returns the definition of a tool call that should be executed by the client.
+                              "action": "A String", # Required. The name of the tool's action associated with this call.
+                              "inputParameters": { # Optional. The action's input parameters.
+                                "a_key": "", # Properties of the object.
+                              },
+                              "tool": "A String", # Required. The tool associated with this call. Format: `projects//locations//agents//tools/`.
+                            },
+                          },
+                        ],
+                        "returnPartialResponses": True or False, # Whether Dialogflow should return currently queued fulfillment response messages in streaming APIs. If a webhook is specified, it happens before Dialogflow invokes webhook. Warning: 1) This flag only affects streaming API. Responses are still queued and returned once in non-streaming API. 2) The flag can be enabled in any fulfillment but only the first 3 partial responses will be returned. You may only want to apply it to fulfillments that have slow webhooks.
+                        "setParameterActions": [ # Set parameter values before executing the webhook.
+                          { # Setting a parameter value.
+                            "parameter": "A String", # Display name of the parameter.
+                            "value": "", # The new value of the parameter. A null value clears the parameter.
+                          },
+                        ],
+                        "tag": "A String", # The value of this field will be populated in the WebhookRequest `fulfillmentInfo.tag` field by Dialogflow when the associated webhook is called. The tag is typically used by the webhook service to identify which fulfillment is being called, but it could be used for other purposes. This field is required if `webhook` is specified.
+                        "webhook": "A String", # The webhook to call. Format: `projects//locations//agents//webhooks/`.
+                      },
+                    },
+                  ],
+                },
+                "currentPage": { # A Dialogflow CX conversation (session) can be described and visualized as a state machine. The states of a CX session are represented by pages. For each flow, you define many pages, where your combined pages can handle a complete conversation on the topics the flow is designed for. At any given moment, exactly one page is the current page, the current page is considered active, and the flow associated with that page is considered active. Every flow has a special start page. When a flow initially becomes active, the start page page becomes the current page. For each conversational turn, the current page will either stay the same or transition to another page. You configure each page to collect information from the end-user that is relevant for the conversational state represented by the page. For more information, see the [Page guide](https://cloud.google.com/dialogflow/cx/docs/concept/page). # The current Page. Some, not all fields are filled in this message, including but not limited to `name` and `display_name`.
+                  "advancedSettings": { # Hierarchical advanced settings for agent/flow/page/fulfillment/parameter. Settings exposed at lower level overrides the settings exposed at higher level. Overriding occurs at the sub-setting level. For example, the playback_interruption_settings at fulfillment level only overrides the playback_interruption_settings at the agent level, leaving other settings at the agent level unchanged. DTMF settings does not override each other. DTMF settings set at different levels define DTMF detections running in parallel. Hierarchy: Agent->Flow->Page->Fulfillment/Parameter. # Hierarchical advanced settings for this page. The settings exposed at the lower level overrides the settings exposed at the higher level.
+                    "audioExportGcsDestination": { # Google Cloud Storage location for a Dialogflow operation that writes or exports objects (e.g. exported agent or transcripts) outside of Dialogflow. # If present, incoming audio is exported by Dialogflow to the configured Google Cloud Storage destination. Exposed at the following levels: - Agent level - Flow level
+                      "uri": "A String", # Required. The Google Cloud Storage URI for the exported objects. A URI is of the form: `gs://bucket/object-name-or-prefix` Whether a full object name, or just a prefix, its usage depends on the Dialogflow operation.
+                    },
+                    "dtmfSettings": { # Define behaviors for DTMF (dual tone multi frequency). # Settings for DTMF. Exposed at the following levels: - Agent level - Flow level - Page level - Parameter level.
+                      "enabled": True or False, # If true, incoming audio is processed for DTMF (dual tone multi frequency) events. For example, if the caller presses a button on their telephone keypad and DTMF processing is enabled, Dialogflow will detect the event (e.g. a "3" was pressed) in the incoming audio and pass the event to the bot to drive business logic (e.g. when 3 is pressed, return the account balance).
+                      "endpointingTimeoutDuration": "A String", # Endpoint timeout setting for matching dtmf input to regex.
+                      "finishDigit": "A String", # The digit that terminates a DTMF digit sequence.
+                      "interdigitTimeoutDuration": "A String", # Interdigit timeout setting for matching dtmf input to regex.
+                      "maxDigits": 42, # Max length of DTMF digits.
+                    },
+                    "loggingSettings": { # Define behaviors on logging. # Settings for logging. Settings for Dialogflow History, Contact Center messages, StackDriver logs, and speech logging. Exposed at the following levels: - Agent level.
+                      "enableInteractionLogging": True or False, # Enables DF Interaction logging.
+                      "enableStackdriverLogging": True or False, # Enables StackDriver logging.
+                    },
+                    "speechSettings": { # Define behaviors of speech to text detection. # Settings for speech to text detection. Exposed at the following levels: - Agent level - Flow level - Page level - Parameter level
+                      "endpointerSensitivity": 42, # Sensitivity of the speech model that detects the end of speech. Scale from 0 to 100.
+                      "models": { # Mapping from language to Speech-to-Text model. The mapped Speech-to-Text model will be selected for requests from its corresponding language. For more information, see [Speech models](https://cloud.google.com/dialogflow/cx/docs/concept/speech-models).
+                        "a_key": "A String",
+                      },
+                      "noSpeechTimeout": "A String", # Timeout before detecting no speech.
+                      "useTimeoutBasedEndpointing": True or False, # Use timeout based endpointing, interpreting endpointer sensitivy as seconds of timeout value.
+                    },
+                  },
+                  "description": "A String", # The description of the page. The maximum length is 500 characters.
+                  "displayName": "A String", # Required. The human-readable name of the page, unique within the flow.
+                  "entryFulfillment": { # A fulfillment can do one or more of the following actions at the same time: * Generate rich message responses. * Set parameter values. * Call the webhook. Fulfillments can be called at various stages in the Page or Form lifecycle. For example, when a DetectIntentRequest drives a session to enter a new page, the page's entry fulfillment can add a static response to the QueryResult in the returning DetectIntentResponse, call the webhook (for example, to load user data from a database), or both. # The fulfillment to call when the session is entering the page.
+                    "advancedSettings": { # Hierarchical advanced settings for agent/flow/page/fulfillment/parameter. Settings exposed at lower level overrides the settings exposed at higher level. Overriding occurs at the sub-setting level. For example, the playback_interruption_settings at fulfillment level only overrides the playback_interruption_settings at the agent level, leaving other settings at the agent level unchanged. DTMF settings does not override each other. DTMF settings set at different levels define DTMF detections running in parallel. Hierarchy: Agent->Flow->Page->Fulfillment/Parameter. # Hierarchical advanced settings for this fulfillment. The settings exposed at the lower level overrides the settings exposed at the higher level.
+                      "audioExportGcsDestination": { # Google Cloud Storage location for a Dialogflow operation that writes or exports objects (e.g. exported agent or transcripts) outside of Dialogflow. # If present, incoming audio is exported by Dialogflow to the configured Google Cloud Storage destination. Exposed at the following levels: - Agent level - Flow level
+                        "uri": "A String", # Required. The Google Cloud Storage URI for the exported objects. A URI is of the form: `gs://bucket/object-name-or-prefix` Whether a full object name, or just a prefix, its usage depends on the Dialogflow operation.
+                      },
+                      "dtmfSettings": { # Define behaviors for DTMF (dual tone multi frequency). # Settings for DTMF. Exposed at the following levels: - Agent level - Flow level - Page level - Parameter level.
+                        "enabled": True or False, # If true, incoming audio is processed for DTMF (dual tone multi frequency) events. For example, if the caller presses a button on their telephone keypad and DTMF processing is enabled, Dialogflow will detect the event (e.g. a "3" was pressed) in the incoming audio and pass the event to the bot to drive business logic (e.g. when 3 is pressed, return the account balance).
+                        "endpointingTimeoutDuration": "A String", # Endpoint timeout setting for matching dtmf input to regex.
+                        "finishDigit": "A String", # The digit that terminates a DTMF digit sequence.
+                        "interdigitTimeoutDuration": "A String", # Interdigit timeout setting for matching dtmf input to regex.
+                        "maxDigits": 42, # Max length of DTMF digits.
+                      },
+                      "loggingSettings": { # Define behaviors on logging. # Settings for logging. Settings for Dialogflow History, Contact Center messages, StackDriver logs, and speech logging. Exposed at the following levels: - Agent level.
+                        "enableInteractionLogging": True or False, # Enables DF Interaction logging.
+                        "enableStackdriverLogging": True or False, # Enables StackDriver logging.
+                      },
+                      "speechSettings": { # Define behaviors of speech to text detection. # Settings for speech to text detection. Exposed at the following levels: - Agent level - Flow level - Page level - Parameter level
+                        "endpointerSensitivity": 42, # Sensitivity of the speech model that detects the end of speech. Scale from 0 to 100.
+                        "models": { # Mapping from language to Speech-to-Text model. The mapped Speech-to-Text model will be selected for requests from its corresponding language. For more information, see [Speech models](https://cloud.google.com/dialogflow/cx/docs/concept/speech-models).
+                          "a_key": "A String",
+                        },
+                        "noSpeechTimeout": "A String", # Timeout before detecting no speech.
+                        "useTimeoutBasedEndpointing": True or False, # Use timeout based endpointing, interpreting endpointer sensitivy as seconds of timeout value.
+                      },
+                    },
+                    "conditionalCases": [ # Conditional cases for this fulfillment.
+                      { # A list of cascading if-else conditions. Cases are mutually exclusive. The first one with a matching condition is selected, all the rest ignored.
+                        "cases": [ # A list of cascading if-else conditions.
+                          { # Each case has a Boolean condition. When it is evaluated to be True, the corresponding messages will be selected and evaluated recursively.
+                            "caseContent": [ # A list of case content.
+                              { # The list of messages or conditional cases to activate for this case.
+                                "additionalCases": # Object with schema name: GoogleCloudDialogflowCxV3beta1FulfillmentConditionalCases # Additional cases to be evaluated.
+                                "message": { # 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. # Returned message.
+                                  "channel": "A String", # The channel which the response is associated with. Clients can specify the channel via QueryParameters.channel, and only associated channel response will be returned.
+                                  "conversationSuccess": { # 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. # Indicates that the conversation succeeded.
+                                    "metadata": { # Custom metadata. Dialogflow doesn't impose any structure on this.
+                                      "a_key": "", # Properties of the object.
+                                    },
+                                  },
+                                  "endInteraction": { # 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. # Output only. A signal that indicates the interaction with the Dialogflow agent has ended. This message is generated by Dialogflow only when the conversation reaches `END_SESSION` page. It is not supposed to be defined by the user. It's guaranteed that there is at most one such message in each response.
+                                  },
+                                  "knowledgeInfoCard": { # Represents info card response. If the response contains generative knowledge prediction, Dialogflow will return a payload with Infobot Messenger compatible info card. Otherwise, the info card response is skipped. # Represents info card for knowledge answers, to be better rendered in Dialogflow Messenger.
+                                  },
+                                  "liveAgentHandoff": { # 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. # Hands off conversation to a human agent.
+                                    "metadata": { # Custom metadata for your handoff procedure. Dialogflow doesn't impose any structure on this.
+                                      "a_key": "", # Properties of the object.
+                                    },
+                                  },
+                                  "mixedAudio": { # 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. # Output only. An audio response message composed of both the synthesized Dialogflow agent responses and responses defined via play_audio. This message is generated by Dialogflow only and not supposed to be defined by the user.
+                                    "segments": [ # Segments this audio response is composed of.
+                                      { # Represents one segment of audio.
+                                        "allowPlaybackInterruption": True or False, # 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.
+                                        "audio": "A String", # Raw audio synthesized from the Dialogflow agent's response using the output config specified in the request.
+                                        "uri": "A String", # Client-specific URI that points to an audio clip accessible to the client. Dialogflow does not impose any validation on it.
+                                      },
+                                    ],
+                                  },
+                                  "outputAudioText": { # A text or ssml response that is preferentially used for TTS output audio synthesis, as described in the comment on the ResponseMessage message. # A text or ssml response that is preferentially used for TTS output audio synthesis, as described in the comment on the ResponseMessage message.
+                                    "allowPlaybackInterruption": True or False, # 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.
+                                    "ssml": "A String", # The SSML text to be synthesized. For more information, see [SSML](/speech/text-to-speech/docs/ssml).
+                                    "text": "A String", # The raw text to be synthesized.
+                                  },
+                                  "payload": { # Returns a response containing a custom, platform-specific payload.
+                                    "a_key": "", # Properties of the object.
+                                  },
+                                  "playAudio": { # Specifies an audio clip to be played by the client as part of the response. # Signal that the client should play an audio clip hosted at a client-specific URI. Dialogflow uses this to construct mixed_audio. However, Dialogflow itself does not try to read or process the URI in any way.
+                                    "allowPlaybackInterruption": True or False, # 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.
+                                    "audioUri": "A String", # Required. URI of the audio clip. Dialogflow does not impose any validation on this value. It is specific to the client that reads it.
+                                  },
+                                  "telephonyTransferCall": { # Represents the signal that telles the client to transfer the phone call connected to the agent to a third-party endpoint. # A signal that the client should transfer the phone call connected to this agent to a third-party endpoint.
+                                    "phoneNumber": "A String", # Transfer the call to a phone number in [E.164 format](https://en.wikipedia.org/wiki/E.164).
+                                  },
+                                  "text": { # The text response message. # Returns a text response.
+                                    "allowPlaybackInterruption": True or False, # 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.
+                                    "text": [ # Required. A collection of text responses.
+                                      "A String",
+                                    ],
+                                  },
+                                  "toolCall": { # Represents a call of a specific tool's action with the specified inputs. # Returns the definition of a tool call that should be executed by the client.
+                                    "action": "A String", # Required. The name of the tool's action associated with this call.
+                                    "inputParameters": { # Optional. The action's input parameters.
+                                      "a_key": "", # Properties of the object.
+                                    },
+                                    "tool": "A String", # Required. The tool associated with this call. Format: `projects//locations//agents//tools/`.
+                                  },
+                                },
+                              },
+                            ],
+                            "condition": "A String", # The condition to activate and select this case. Empty means the condition is always true. The condition is evaluated against form parameters or session parameters. See the [conditions reference](https://cloud.google.com/dialogflow/cx/docs/reference/condition).
+                          },
+                        ],
+                      },
+                    ],
+                    "enableGenerativeFallback": True or False, # If the flag is true, the agent will utilize LLM to generate a text response. If LLM generation fails, the defined responses in the fulfillment will be respected. This flag is only useful for fulfillments associated with no-match event handlers.
+                    "messages": [ # The list of rich message responses to present to the user.
+                      { # 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.
+                        "channel": "A String", # The channel which the response is associated with. Clients can specify the channel via QueryParameters.channel, and only associated channel response will be returned.
+                        "conversationSuccess": { # 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. # Indicates that the conversation succeeded.
+                          "metadata": { # Custom metadata. Dialogflow doesn't impose any structure on this.
+                            "a_key": "", # Properties of the object.
+                          },
+                        },
+                        "endInteraction": { # 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. # Output only. A signal that indicates the interaction with the Dialogflow agent has ended. This message is generated by Dialogflow only when the conversation reaches `END_SESSION` page. It is not supposed to be defined by the user. It's guaranteed that there is at most one such message in each response.
+                        },
+                        "knowledgeInfoCard": { # Represents info card response. If the response contains generative knowledge prediction, Dialogflow will return a payload with Infobot Messenger compatible info card. Otherwise, the info card response is skipped. # Represents info card for knowledge answers, to be better rendered in Dialogflow Messenger.
+                        },
+                        "liveAgentHandoff": { # 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. # Hands off conversation to a human agent.
+                          "metadata": { # Custom metadata for your handoff procedure. Dialogflow doesn't impose any structure on this.
+                            "a_key": "", # Properties of the object.
+                          },
+                        },
+                        "mixedAudio": { # 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. # Output only. An audio response message composed of both the synthesized Dialogflow agent responses and responses defined via play_audio. This message is generated by Dialogflow only and not supposed to be defined by the user.
+                          "segments": [ # Segments this audio response is composed of.
+                            { # Represents one segment of audio.
+                              "allowPlaybackInterruption": True or False, # 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.
+                              "audio": "A String", # Raw audio synthesized from the Dialogflow agent's response using the output config specified in the request.
+                              "uri": "A String", # Client-specific URI that points to an audio clip accessible to the client. Dialogflow does not impose any validation on it.
+                            },
+                          ],
+                        },
+                        "outputAudioText": { # A text or ssml response that is preferentially used for TTS output audio synthesis, as described in the comment on the ResponseMessage message. # A text or ssml response that is preferentially used for TTS output audio synthesis, as described in the comment on the ResponseMessage message.
+                          "allowPlaybackInterruption": True or False, # 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.
+                          "ssml": "A String", # The SSML text to be synthesized. For more information, see [SSML](/speech/text-to-speech/docs/ssml).
+                          "text": "A String", # The raw text to be synthesized.
+                        },
+                        "payload": { # Returns a response containing a custom, platform-specific payload.
+                          "a_key": "", # Properties of the object.
+                        },
+                        "playAudio": { # Specifies an audio clip to be played by the client as part of the response. # Signal that the client should play an audio clip hosted at a client-specific URI. Dialogflow uses this to construct mixed_audio. However, Dialogflow itself does not try to read or process the URI in any way.
+                          "allowPlaybackInterruption": True or False, # 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.
+                          "audioUri": "A String", # Required. URI of the audio clip. Dialogflow does not impose any validation on this value. It is specific to the client that reads it.
+                        },
+                        "telephonyTransferCall": { # Represents the signal that telles the client to transfer the phone call connected to the agent to a third-party endpoint. # A signal that the client should transfer the phone call connected to this agent to a third-party endpoint.
+                          "phoneNumber": "A String", # Transfer the call to a phone number in [E.164 format](https://en.wikipedia.org/wiki/E.164).
+                        },
+                        "text": { # The text response message. # Returns a text response.
+                          "allowPlaybackInterruption": True or False, # 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.
+                          "text": [ # Required. A collection of text responses.
+                            "A String",
+                          ],
+                        },
+                        "toolCall": { # Represents a call of a specific tool's action with the specified inputs. # Returns the definition of a tool call that should be executed by the client.
+                          "action": "A String", # Required. The name of the tool's action associated with this call.
+                          "inputParameters": { # Optional. The action's input parameters.
+                            "a_key": "", # Properties of the object.
+                          },
+                          "tool": "A String", # Required. The tool associated with this call. Format: `projects//locations//agents//tools/`.
+                        },
+                      },
+                    ],
+                    "returnPartialResponses": True or False, # Whether Dialogflow should return currently queued fulfillment response messages in streaming APIs. If a webhook is specified, it happens before Dialogflow invokes webhook. Warning: 1) This flag only affects streaming API. Responses are still queued and returned once in non-streaming API. 2) The flag can be enabled in any fulfillment but only the first 3 partial responses will be returned. You may only want to apply it to fulfillments that have slow webhooks.
+                    "setParameterActions": [ # Set parameter values before executing the webhook.
+                      { # Setting a parameter value.
+                        "parameter": "A String", # Display name of the parameter.
+                        "value": "", # The new value of the parameter. A null value clears the parameter.
+                      },
+                    ],
+                    "tag": "A String", # The value of this field will be populated in the WebhookRequest `fulfillmentInfo.tag` field by Dialogflow when the associated webhook is called. The tag is typically used by the webhook service to identify which fulfillment is being called, but it could be used for other purposes. This field is required if `webhook` is specified.
+                    "webhook": "A String", # The webhook to call. Format: `projects//locations//agents//webhooks/`.
+                  },
+                  "eventHandlers": [ # Handlers associated with the page to handle events such as webhook errors, no match or no input.
+                    { # An event handler specifies an event that can be handled during a session. When the specified event happens, the following actions are taken in order: * If there is a `trigger_fulfillment` associated with the event, it will be called. * If there is a `target_page` associated with the event, the session will transition into the specified page. * If there is a `target_flow` associated with the event, the session will transition into the specified flow.
+                      "event": "A String", # Required. The name of the event to handle.
+                      "name": "A String", # Output only. The unique identifier of this event handler.
+                      "targetFlow": "A String", # The target flow to transition to. Format: `projects//locations//agents//flows/`.
+                      "targetPage": "A String", # The target page to transition to. Format: `projects//locations//agents//flows//pages/`.
+                      "triggerFulfillment": { # A fulfillment can do one or more of the following actions at the same time: * Generate rich message responses. * Set parameter values. * Call the webhook. Fulfillments can be called at various stages in the Page or Form lifecycle. For example, when a DetectIntentRequest drives a session to enter a new page, the page's entry fulfillment can add a static response to the QueryResult in the returning DetectIntentResponse, call the webhook (for example, to load user data from a database), or both. # The fulfillment to call when the event occurs. Handling webhook errors with a fulfillment enabled with webhook could cause infinite loop. It is invalid to specify such fulfillment for a handler handling webhooks.
+                        "advancedSettings": { # Hierarchical advanced settings for agent/flow/page/fulfillment/parameter. Settings exposed at lower level overrides the settings exposed at higher level. Overriding occurs at the sub-setting level. For example, the playback_interruption_settings at fulfillment level only overrides the playback_interruption_settings at the agent level, leaving other settings at the agent level unchanged. DTMF settings does not override each other. DTMF settings set at different levels define DTMF detections running in parallel. Hierarchy: Agent->Flow->Page->Fulfillment/Parameter. # Hierarchical advanced settings for this fulfillment. The settings exposed at the lower level overrides the settings exposed at the higher level.
+                          "audioExportGcsDestination": { # Google Cloud Storage location for a Dialogflow operation that writes or exports objects (e.g. exported agent or transcripts) outside of Dialogflow. # If present, incoming audio is exported by Dialogflow to the configured Google Cloud Storage destination. Exposed at the following levels: - Agent level - Flow level
+                            "uri": "A String", # Required. The Google Cloud Storage URI for the exported objects. A URI is of the form: `gs://bucket/object-name-or-prefix` Whether a full object name, or just a prefix, its usage depends on the Dialogflow operation.
+                          },
+                          "dtmfSettings": { # Define behaviors for DTMF (dual tone multi frequency). # Settings for DTMF. Exposed at the following levels: - Agent level - Flow level - Page level - Parameter level.
+                            "enabled": True or False, # If true, incoming audio is processed for DTMF (dual tone multi frequency) events. For example, if the caller presses a button on their telephone keypad and DTMF processing is enabled, Dialogflow will detect the event (e.g. a "3" was pressed) in the incoming audio and pass the event to the bot to drive business logic (e.g. when 3 is pressed, return the account balance).
+                            "endpointingTimeoutDuration": "A String", # Endpoint timeout setting for matching dtmf input to regex.
+                            "finishDigit": "A String", # The digit that terminates a DTMF digit sequence.
+                            "interdigitTimeoutDuration": "A String", # Interdigit timeout setting for matching dtmf input to regex.
+                            "maxDigits": 42, # Max length of DTMF digits.
+                          },
+                          "loggingSettings": { # Define behaviors on logging. # Settings for logging. Settings for Dialogflow History, Contact Center messages, StackDriver logs, and speech logging. Exposed at the following levels: - Agent level.
+                            "enableInteractionLogging": True or False, # Enables DF Interaction logging.
+                            "enableStackdriverLogging": True or False, # Enables StackDriver logging.
+                          },
+                          "speechSettings": { # Define behaviors of speech to text detection. # Settings for speech to text detection. Exposed at the following levels: - Agent level - Flow level - Page level - Parameter level
+                            "endpointerSensitivity": 42, # Sensitivity of the speech model that detects the end of speech. Scale from 0 to 100.
+                            "models": { # Mapping from language to Speech-to-Text model. The mapped Speech-to-Text model will be selected for requests from its corresponding language. For more information, see [Speech models](https://cloud.google.com/dialogflow/cx/docs/concept/speech-models).
+                              "a_key": "A String",
+                            },
+                            "noSpeechTimeout": "A String", # Timeout before detecting no speech.
+                            "useTimeoutBasedEndpointing": True or False, # Use timeout based endpointing, interpreting endpointer sensitivy as seconds of timeout value.
+                          },
+                        },
+                        "conditionalCases": [ # Conditional cases for this fulfillment.
+                          { # A list of cascading if-else conditions. Cases are mutually exclusive. The first one with a matching condition is selected, all the rest ignored.
+                            "cases": [ # A list of cascading if-else conditions.
+                              { # Each case has a Boolean condition. When it is evaluated to be True, the corresponding messages will be selected and evaluated recursively.
+                                "caseContent": [ # A list of case content.
+                                  { # The list of messages or conditional cases to activate for this case.
+                                    "additionalCases": # Object with schema name: GoogleCloudDialogflowCxV3beta1FulfillmentConditionalCases # Additional cases to be evaluated.
+                                    "message": { # 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. # Returned message.
+                                      "channel": "A String", # The channel which the response is associated with. Clients can specify the channel via QueryParameters.channel, and only associated channel response will be returned.
+                                      "conversationSuccess": { # 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. # Indicates that the conversation succeeded.
+                                        "metadata": { # Custom metadata. Dialogflow doesn't impose any structure on this.
+                                          "a_key": "", # Properties of the object.
+                                        },
+                                      },
+                                      "endInteraction": { # 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. # Output only. A signal that indicates the interaction with the Dialogflow agent has ended. This message is generated by Dialogflow only when the conversation reaches `END_SESSION` page. It is not supposed to be defined by the user. It's guaranteed that there is at most one such message in each response.
+                                      },
+                                      "knowledgeInfoCard": { # Represents info card response. If the response contains generative knowledge prediction, Dialogflow will return a payload with Infobot Messenger compatible info card. Otherwise, the info card response is skipped. # Represents info card for knowledge answers, to be better rendered in Dialogflow Messenger.
+                                      },
+                                      "liveAgentHandoff": { # 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. # Hands off conversation to a human agent.
+                                        "metadata": { # Custom metadata for your handoff procedure. Dialogflow doesn't impose any structure on this.
+                                          "a_key": "", # Properties of the object.
+                                        },
+                                      },
+                                      "mixedAudio": { # 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. # Output only. An audio response message composed of both the synthesized Dialogflow agent responses and responses defined via play_audio. This message is generated by Dialogflow only and not supposed to be defined by the user.
+                                        "segments": [ # Segments this audio response is composed of.
+                                          { # Represents one segment of audio.
+                                            "allowPlaybackInterruption": True or False, # 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.
+                                            "audio": "A String", # Raw audio synthesized from the Dialogflow agent's response using the output config specified in the request.
+                                            "uri": "A String", # Client-specific URI that points to an audio clip accessible to the client. Dialogflow does not impose any validation on it.
+                                          },
+                                        ],
+                                      },
+                                      "outputAudioText": { # A text or ssml response that is preferentially used for TTS output audio synthesis, as described in the comment on the ResponseMessage message. # A text or ssml response that is preferentially used for TTS output audio synthesis, as described in the comment on the ResponseMessage message.
+                                        "allowPlaybackInterruption": True or False, # 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.
+                                        "ssml": "A String", # The SSML text to be synthesized. For more information, see [SSML](/speech/text-to-speech/docs/ssml).
+                                        "text": "A String", # The raw text to be synthesized.
+                                      },
+                                      "payload": { # Returns a response containing a custom, platform-specific payload.
+                                        "a_key": "", # Properties of the object.
+                                      },
+                                      "playAudio": { # Specifies an audio clip to be played by the client as part of the response. # Signal that the client should play an audio clip hosted at a client-specific URI. Dialogflow uses this to construct mixed_audio. However, Dialogflow itself does not try to read or process the URI in any way.
+                                        "allowPlaybackInterruption": True or False, # 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.
+                                        "audioUri": "A String", # Required. URI of the audio clip. Dialogflow does not impose any validation on this value. It is specific to the client that reads it.
+                                      },
+                                      "telephonyTransferCall": { # Represents the signal that telles the client to transfer the phone call connected to the agent to a third-party endpoint. # A signal that the client should transfer the phone call connected to this agent to a third-party endpoint.
+                                        "phoneNumber": "A String", # Transfer the call to a phone number in [E.164 format](https://en.wikipedia.org/wiki/E.164).
+                                      },
+                                      "text": { # The text response message. # Returns a text response.
+                                        "allowPlaybackInterruption": True or False, # 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.
+                                        "text": [ # Required. A collection of text responses.
+                                          "A String",
+                                        ],
+                                      },
+                                      "toolCall": { # Represents a call of a specific tool's action with the specified inputs. # Returns the definition of a tool call that should be executed by the client.
+                                        "action": "A String", # Required. The name of the tool's action associated with this call.
+                                        "inputParameters": { # Optional. The action's input parameters.
+                                          "a_key": "", # Properties of the object.
+                                        },
+                                        "tool": "A String", # Required. The tool associated with this call. Format: `projects//locations//agents//tools/`.
+                                      },
+                                    },
+                                  },
+                                ],
+                                "condition": "A String", # The condition to activate and select this case. Empty means the condition is always true. The condition is evaluated against form parameters or session parameters. See the [conditions reference](https://cloud.google.com/dialogflow/cx/docs/reference/condition).
+                              },
+                            ],
+                          },
+                        ],
+                        "enableGenerativeFallback": True or False, # If the flag is true, the agent will utilize LLM to generate a text response. If LLM generation fails, the defined responses in the fulfillment will be respected. This flag is only useful for fulfillments associated with no-match event handlers.
+                        "messages": [ # The list of rich message responses to present to the user.
+                          { # 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.
+                            "channel": "A String", # The channel which the response is associated with. Clients can specify the channel via QueryParameters.channel, and only associated channel response will be returned.
+                            "conversationSuccess": { # 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. # Indicates that the conversation succeeded.
+                              "metadata": { # Custom metadata. Dialogflow doesn't impose any structure on this.
+                                "a_key": "", # Properties of the object.
+                              },
+                            },
+                            "endInteraction": { # 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. # Output only. A signal that indicates the interaction with the Dialogflow agent has ended. This message is generated by Dialogflow only when the conversation reaches `END_SESSION` page. It is not supposed to be defined by the user. It's guaranteed that there is at most one such message in each response.
+                            },
+                            "knowledgeInfoCard": { # Represents info card response. If the response contains generative knowledge prediction, Dialogflow will return a payload with Infobot Messenger compatible info card. Otherwise, the info card response is skipped. # Represents info card for knowledge answers, to be better rendered in Dialogflow Messenger.
+                            },
+                            "liveAgentHandoff": { # 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. # Hands off conversation to a human agent.
+                              "metadata": { # Custom metadata for your handoff procedure. Dialogflow doesn't impose any structure on this.
+                                "a_key": "", # Properties of the object.
+                              },
+                            },
+                            "mixedAudio": { # 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. # Output only. An audio response message composed of both the synthesized Dialogflow agent responses and responses defined via play_audio. This message is generated by Dialogflow only and not supposed to be defined by the user.
+                              "segments": [ # Segments this audio response is composed of.
+                                { # Represents one segment of audio.
+                                  "allowPlaybackInterruption": True or False, # 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.
+                                  "audio": "A String", # Raw audio synthesized from the Dialogflow agent's response using the output config specified in the request.
+                                  "uri": "A String", # Client-specific URI that points to an audio clip accessible to the client. Dialogflow does not impose any validation on it.
+                                },
+                              ],
+                            },
+                            "outputAudioText": { # A text or ssml response that is preferentially used for TTS output audio synthesis, as described in the comment on the ResponseMessage message. # A text or ssml response that is preferentially used for TTS output audio synthesis, as described in the comment on the ResponseMessage message.
+                              "allowPlaybackInterruption": True or False, # 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.
+                              "ssml": "A String", # The SSML text to be synthesized. For more information, see [SSML](/speech/text-to-speech/docs/ssml).
+                              "text": "A String", # The raw text to be synthesized.
+                            },
+                            "payload": { # Returns a response containing a custom, platform-specific payload.
+                              "a_key": "", # Properties of the object.
+                            },
+                            "playAudio": { # Specifies an audio clip to be played by the client as part of the response. # Signal that the client should play an audio clip hosted at a client-specific URI. Dialogflow uses this to construct mixed_audio. However, Dialogflow itself does not try to read or process the URI in any way.
+                              "allowPlaybackInterruption": True or False, # 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.
+                              "audioUri": "A String", # Required. URI of the audio clip. Dialogflow does not impose any validation on this value. It is specific to the client that reads it.
+                            },
+                            "telephonyTransferCall": { # Represents the signal that telles the client to transfer the phone call connected to the agent to a third-party endpoint. # A signal that the client should transfer the phone call connected to this agent to a third-party endpoint.
+                              "phoneNumber": "A String", # Transfer the call to a phone number in [E.164 format](https://en.wikipedia.org/wiki/E.164).
+                            },
+                            "text": { # The text response message. # Returns a text response.
+                              "allowPlaybackInterruption": True or False, # 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.
+                              "text": [ # Required. A collection of text responses.
+                                "A String",
+                              ],
+                            },
+                            "toolCall": { # Represents a call of a specific tool's action with the specified inputs. # Returns the definition of a tool call that should be executed by the client.
+                              "action": "A String", # Required. The name of the tool's action associated with this call.
+                              "inputParameters": { # Optional. The action's input parameters.
+                                "a_key": "", # Properties of the object.
+                              },
+                              "tool": "A String", # Required. The tool associated with this call. Format: `projects//locations//agents//tools/`.
+                            },
+                          },
+                        ],
+                        "returnPartialResponses": True or False, # Whether Dialogflow should return currently queued fulfillment response messages in streaming APIs. If a webhook is specified, it happens before Dialogflow invokes webhook. Warning: 1) This flag only affects streaming API. Responses are still queued and returned once in non-streaming API. 2) The flag can be enabled in any fulfillment but only the first 3 partial responses will be returned. You may only want to apply it to fulfillments that have slow webhooks.
+                        "setParameterActions": [ # Set parameter values before executing the webhook.
+                          { # Setting a parameter value.
+                            "parameter": "A String", # Display name of the parameter.
+                            "value": "", # The new value of the parameter. A null value clears the parameter.
+                          },
+                        ],
+                        "tag": "A String", # The value of this field will be populated in the WebhookRequest `fulfillmentInfo.tag` field by Dialogflow when the associated webhook is called. The tag is typically used by the webhook service to identify which fulfillment is being called, but it could be used for other purposes. This field is required if `webhook` is specified.
+                        "webhook": "A String", # The webhook to call. Format: `projects//locations//agents//webhooks/`.
+                      },
+                    },
+                  ],
+                  "form": { # A form is a data model that groups related parameters that can be collected from the user. The process in which the agent prompts the user and collects parameter values from the user is called form filling. A form can be added to a page. When form filling is done, the filled parameters will be written to the session. # The form associated with the page, used for collecting parameters relevant to the page.
+                    "parameters": [ # Parameters to collect from the user.
+                      { # Represents a form parameter.
+                        "advancedSettings": { # Hierarchical advanced settings for agent/flow/page/fulfillment/parameter. Settings exposed at lower level overrides the settings exposed at higher level. Overriding occurs at the sub-setting level. For example, the playback_interruption_settings at fulfillment level only overrides the playback_interruption_settings at the agent level, leaving other settings at the agent level unchanged. DTMF settings does not override each other. DTMF settings set at different levels define DTMF detections running in parallel. Hierarchy: Agent->Flow->Page->Fulfillment/Parameter. # Hierarchical advanced settings for this parameter. The settings exposed at the lower level overrides the settings exposed at the higher level.
+                          "audioExportGcsDestination": { # Google Cloud Storage location for a Dialogflow operation that writes or exports objects (e.g. exported agent or transcripts) outside of Dialogflow. # If present, incoming audio is exported by Dialogflow to the configured Google Cloud Storage destination. Exposed at the following levels: - Agent level - Flow level
+                            "uri": "A String", # Required. The Google Cloud Storage URI for the exported objects. A URI is of the form: `gs://bucket/object-name-or-prefix` Whether a full object name, or just a prefix, its usage depends on the Dialogflow operation.
+                          },
+                          "dtmfSettings": { # Define behaviors for DTMF (dual tone multi frequency). # Settings for DTMF. Exposed at the following levels: - Agent level - Flow level - Page level - Parameter level.
+                            "enabled": True or False, # If true, incoming audio is processed for DTMF (dual tone multi frequency) events. For example, if the caller presses a button on their telephone keypad and DTMF processing is enabled, Dialogflow will detect the event (e.g. a "3" was pressed) in the incoming audio and pass the event to the bot to drive business logic (e.g. when 3 is pressed, return the account balance).
+                            "endpointingTimeoutDuration": "A String", # Endpoint timeout setting for matching dtmf input to regex.
+                            "finishDigit": "A String", # The digit that terminates a DTMF digit sequence.
+                            "interdigitTimeoutDuration": "A String", # Interdigit timeout setting for matching dtmf input to regex.
+                            "maxDigits": 42, # Max length of DTMF digits.
+                          },
+                          "loggingSettings": { # Define behaviors on logging. # Settings for logging. Settings for Dialogflow History, Contact Center messages, StackDriver logs, and speech logging. Exposed at the following levels: - Agent level.
+                            "enableInteractionLogging": True or False, # Enables DF Interaction logging.
+                            "enableStackdriverLogging": True or False, # Enables StackDriver logging.
+                          },
+                          "speechSettings": { # Define behaviors of speech to text detection. # Settings for speech to text detection. Exposed at the following levels: - Agent level - Flow level - Page level - Parameter level
+                            "endpointerSensitivity": 42, # Sensitivity of the speech model that detects the end of speech. Scale from 0 to 100.
+                            "models": { # Mapping from language to Speech-to-Text model. The mapped Speech-to-Text model will be selected for requests from its corresponding language. For more information, see [Speech models](https://cloud.google.com/dialogflow/cx/docs/concept/speech-models).
+                              "a_key": "A String",
+                            },
+                            "noSpeechTimeout": "A String", # Timeout before detecting no speech.
+                            "useTimeoutBasedEndpointing": True or False, # Use timeout based endpointing, interpreting endpointer sensitivy as seconds of timeout value.
+                          },
+                        },
+                        "defaultValue": "", # The default value of an optional parameter. If the parameter is required, the default value will be ignored.
+                        "displayName": "A String", # Required. The human-readable name of the parameter, unique within the form.
+                        "entityType": "A String", # Required. The entity type of the parameter. Format: `projects/-/locations/-/agents/-/entityTypes/` for system entity types (for example, `projects/-/locations/-/agents/-/entityTypes/sys.date`), or `projects//locations//agents//entityTypes/` for developer entity types.
+                        "fillBehavior": { # Configuration for how the filling of a parameter should be handled. # Required. Defines fill behavior for the parameter.
+                          "initialPromptFulfillment": { # A fulfillment can do one or more of the following actions at the same time: * Generate rich message responses. * Set parameter values. * Call the webhook. Fulfillments can be called at various stages in the Page or Form lifecycle. For example, when a DetectIntentRequest drives a session to enter a new page, the page's entry fulfillment can add a static response to the QueryResult in the returning DetectIntentResponse, call the webhook (for example, to load user data from a database), or both. # Required. The fulfillment to provide the initial prompt that the agent can present to the user in order to fill the parameter.
+                            "advancedSettings": { # Hierarchical advanced settings for agent/flow/page/fulfillment/parameter. Settings exposed at lower level overrides the settings exposed at higher level. Overriding occurs at the sub-setting level. For example, the playback_interruption_settings at fulfillment level only overrides the playback_interruption_settings at the agent level, leaving other settings at the agent level unchanged. DTMF settings does not override each other. DTMF settings set at different levels define DTMF detections running in parallel. Hierarchy: Agent->Flow->Page->Fulfillment/Parameter. # Hierarchical advanced settings for this fulfillment. The settings exposed at the lower level overrides the settings exposed at the higher level.
+                              "audioExportGcsDestination": { # Google Cloud Storage location for a Dialogflow operation that writes or exports objects (e.g. exported agent or transcripts) outside of Dialogflow. # If present, incoming audio is exported by Dialogflow to the configured Google Cloud Storage destination. Exposed at the following levels: - Agent level - Flow level
+                                "uri": "A String", # Required. The Google Cloud Storage URI for the exported objects. A URI is of the form: `gs://bucket/object-name-or-prefix` Whether a full object name, or just a prefix, its usage depends on the Dialogflow operation.
+                              },
+                              "dtmfSettings": { # Define behaviors for DTMF (dual tone multi frequency). # Settings for DTMF. Exposed at the following levels: - Agent level - Flow level - Page level - Parameter level.
+                                "enabled": True or False, # If true, incoming audio is processed for DTMF (dual tone multi frequency) events. For example, if the caller presses a button on their telephone keypad and DTMF processing is enabled, Dialogflow will detect the event (e.g. a "3" was pressed) in the incoming audio and pass the event to the bot to drive business logic (e.g. when 3 is pressed, return the account balance).
+                                "endpointingTimeoutDuration": "A String", # Endpoint timeout setting for matching dtmf input to regex.
+                                "finishDigit": "A String", # The digit that terminates a DTMF digit sequence.
+                                "interdigitTimeoutDuration": "A String", # Interdigit timeout setting for matching dtmf input to regex.
+                                "maxDigits": 42, # Max length of DTMF digits.
+                              },
+                              "loggingSettings": { # Define behaviors on logging. # Settings for logging. Settings for Dialogflow History, Contact Center messages, StackDriver logs, and speech logging. Exposed at the following levels: - Agent level.
+                                "enableInteractionLogging": True or False, # Enables DF Interaction logging.
+                                "enableStackdriverLogging": True or False, # Enables StackDriver logging.
+                              },
+                              "speechSettings": { # Define behaviors of speech to text detection. # Settings for speech to text detection. Exposed at the following levels: - Agent level - Flow level - Page level - Parameter level
+                                "endpointerSensitivity": 42, # Sensitivity of the speech model that detects the end of speech. Scale from 0 to 100.
+                                "models": { # Mapping from language to Speech-to-Text model. The mapped Speech-to-Text model will be selected for requests from its corresponding language. For more information, see [Speech models](https://cloud.google.com/dialogflow/cx/docs/concept/speech-models).
+                                  "a_key": "A String",
+                                },
+                                "noSpeechTimeout": "A String", # Timeout before detecting no speech.
+                                "useTimeoutBasedEndpointing": True or False, # Use timeout based endpointing, interpreting endpointer sensitivy as seconds of timeout value.
+                              },
+                            },
+                            "conditionalCases": [ # Conditional cases for this fulfillment.
+                              { # A list of cascading if-else conditions. Cases are mutually exclusive. The first one with a matching condition is selected, all the rest ignored.
+                                "cases": [ # A list of cascading if-else conditions.
+                                  { # Each case has a Boolean condition. When it is evaluated to be True, the corresponding messages will be selected and evaluated recursively.
+                                    "caseContent": [ # A list of case content.
+                                      { # The list of messages or conditional cases to activate for this case.
+                                        "additionalCases": # Object with schema name: GoogleCloudDialogflowCxV3beta1FulfillmentConditionalCases # Additional cases to be evaluated.
+                                        "message": { # 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. # Returned message.
+                                          "channel": "A String", # The channel which the response is associated with. Clients can specify the channel via QueryParameters.channel, and only associated channel response will be returned.
+                                          "conversationSuccess": { # 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. # Indicates that the conversation succeeded.
+                                            "metadata": { # Custom metadata. Dialogflow doesn't impose any structure on this.
+                                              "a_key": "", # Properties of the object.
+                                            },
+                                          },
+                                          "endInteraction": { # 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. # Output only. A signal that indicates the interaction with the Dialogflow agent has ended. This message is generated by Dialogflow only when the conversation reaches `END_SESSION` page. It is not supposed to be defined by the user. It's guaranteed that there is at most one such message in each response.
+                                          },
+                                          "knowledgeInfoCard": { # Represents info card response. If the response contains generative knowledge prediction, Dialogflow will return a payload with Infobot Messenger compatible info card. Otherwise, the info card response is skipped. # Represents info card for knowledge answers, to be better rendered in Dialogflow Messenger.
+                                          },
+                                          "liveAgentHandoff": { # 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. # Hands off conversation to a human agent.
+                                            "metadata": { # Custom metadata for your handoff procedure. Dialogflow doesn't impose any structure on this.
+                                              "a_key": "", # Properties of the object.
+                                            },
+                                          },
+                                          "mixedAudio": { # 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. # Output only. An audio response message composed of both the synthesized Dialogflow agent responses and responses defined via play_audio. This message is generated by Dialogflow only and not supposed to be defined by the user.
+                                            "segments": [ # Segments this audio response is composed of.
+                                              { # Represents one segment of audio.
+                                                "allowPlaybackInterruption": True or False, # 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.
+                                                "audio": "A String", # Raw audio synthesized from the Dialogflow agent's response using the output config specified in the request.
+                                                "uri": "A String", # Client-specific URI that points to an audio clip accessible to the client. Dialogflow does not impose any validation on it.
+                                              },
+                                            ],
+                                          },
+                                          "outputAudioText": { # A text or ssml response that is preferentially used for TTS output audio synthesis, as described in the comment on the ResponseMessage message. # A text or ssml response that is preferentially used for TTS output audio synthesis, as described in the comment on the ResponseMessage message.
+                                            "allowPlaybackInterruption": True or False, # 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.
+                                            "ssml": "A String", # The SSML text to be synthesized. For more information, see [SSML](/speech/text-to-speech/docs/ssml).
+                                            "text": "A String", # The raw text to be synthesized.
+                                          },
+                                          "payload": { # Returns a response containing a custom, platform-specific payload.
+                                            "a_key": "", # Properties of the object.
+                                          },
+                                          "playAudio": { # Specifies an audio clip to be played by the client as part of the response. # Signal that the client should play an audio clip hosted at a client-specific URI. Dialogflow uses this to construct mixed_audio. However, Dialogflow itself does not try to read or process the URI in any way.
+                                            "allowPlaybackInterruption": True or False, # 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.
+                                            "audioUri": "A String", # Required. URI of the audio clip. Dialogflow does not impose any validation on this value. It is specific to the client that reads it.
+                                          },
+                                          "telephonyTransferCall": { # Represents the signal that telles the client to transfer the phone call connected to the agent to a third-party endpoint. # A signal that the client should transfer the phone call connected to this agent to a third-party endpoint.
+                                            "phoneNumber": "A String", # Transfer the call to a phone number in [E.164 format](https://en.wikipedia.org/wiki/E.164).
+                                          },
+                                          "text": { # The text response message. # Returns a text response.
+                                            "allowPlaybackInterruption": True or False, # 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.
+                                            "text": [ # Required. A collection of text responses.
+                                              "A String",
+                                            ],
+                                          },
+                                          "toolCall": { # Represents a call of a specific tool's action with the specified inputs. # Returns the definition of a tool call that should be executed by the client.
+                                            "action": "A String", # Required. The name of the tool's action associated with this call.
+                                            "inputParameters": { # Optional. The action's input parameters.
+                                              "a_key": "", # Properties of the object.
+                                            },
+                                            "tool": "A String", # Required. The tool associated with this call. Format: `projects//locations//agents//tools/`.
+                                          },
+                                        },
+                                      },
+                                    ],
+                                    "condition": "A String", # The condition to activate and select this case. Empty means the condition is always true. The condition is evaluated against form parameters or session parameters. See the [conditions reference](https://cloud.google.com/dialogflow/cx/docs/reference/condition).
+                                  },
+                                ],
+                              },
+                            ],
+                            "enableGenerativeFallback": True or False, # If the flag is true, the agent will utilize LLM to generate a text response. If LLM generation fails, the defined responses in the fulfillment will be respected. This flag is only useful for fulfillments associated with no-match event handlers.
+                            "messages": [ # The list of rich message responses to present to the user.
+                              { # 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.
+                                "channel": "A String", # The channel which the response is associated with. Clients can specify the channel via QueryParameters.channel, and only associated channel response will be returned.
+                                "conversationSuccess": { # 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. # Indicates that the conversation succeeded.
+                                  "metadata": { # Custom metadata. Dialogflow doesn't impose any structure on this.
+                                    "a_key": "", # Properties of the object.
+                                  },
+                                },
+                                "endInteraction": { # 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. # Output only. A signal that indicates the interaction with the Dialogflow agent has ended. This message is generated by Dialogflow only when the conversation reaches `END_SESSION` page. It is not supposed to be defined by the user. It's guaranteed that there is at most one such message in each response.
+                                },
+                                "knowledgeInfoCard": { # Represents info card response. If the response contains generative knowledge prediction, Dialogflow will return a payload with Infobot Messenger compatible info card. Otherwise, the info card response is skipped. # Represents info card for knowledge answers, to be better rendered in Dialogflow Messenger.
+                                },
+                                "liveAgentHandoff": { # 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. # Hands off conversation to a human agent.
+                                  "metadata": { # Custom metadata for your handoff procedure. Dialogflow doesn't impose any structure on this.
+                                    "a_key": "", # Properties of the object.
+                                  },
+                                },
+                                "mixedAudio": { # 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. # Output only. An audio response message composed of both the synthesized Dialogflow agent responses and responses defined via play_audio. This message is generated by Dialogflow only and not supposed to be defined by the user.
+                                  "segments": [ # Segments this audio response is composed of.
+                                    { # Represents one segment of audio.
+                                      "allowPlaybackInterruption": True or False, # 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.
+                                      "audio": "A String", # Raw audio synthesized from the Dialogflow agent's response using the output config specified in the request.
+                                      "uri": "A String", # Client-specific URI that points to an audio clip accessible to the client. Dialogflow does not impose any validation on it.
+                                    },
+                                  ],
+                                },
+                                "outputAudioText": { # A text or ssml response that is preferentially used for TTS output audio synthesis, as described in the comment on the ResponseMessage message. # A text or ssml response that is preferentially used for TTS output audio synthesis, as described in the comment on the ResponseMessage message.
+                                  "allowPlaybackInterruption": True or False, # 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.
+                                  "ssml": "A String", # The SSML text to be synthesized. For more information, see [SSML](/speech/text-to-speech/docs/ssml).
+                                  "text": "A String", # The raw text to be synthesized.
+                                },
+                                "payload": { # Returns a response containing a custom, platform-specific payload.
+                                  "a_key": "", # Properties of the object.
+                                },
+                                "playAudio": { # Specifies an audio clip to be played by the client as part of the response. # Signal that the client should play an audio clip hosted at a client-specific URI. Dialogflow uses this to construct mixed_audio. However, Dialogflow itself does not try to read or process the URI in any way.
+                                  "allowPlaybackInterruption": True or False, # 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.
+                                  "audioUri": "A String", # Required. URI of the audio clip. Dialogflow does not impose any validation on this value. It is specific to the client that reads it.
+                                },
+                                "telephonyTransferCall": { # Represents the signal that telles the client to transfer the phone call connected to the agent to a third-party endpoint. # A signal that the client should transfer the phone call connected to this agent to a third-party endpoint.
+                                  "phoneNumber": "A String", # Transfer the call to a phone number in [E.164 format](https://en.wikipedia.org/wiki/E.164).
+                                },
+                                "text": { # The text response message. # Returns a text response.
+                                  "allowPlaybackInterruption": True or False, # 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.
+                                  "text": [ # Required. A collection of text responses.
+                                    "A String",
+                                  ],
+                                },
+                                "toolCall": { # Represents a call of a specific tool's action with the specified inputs. # Returns the definition of a tool call that should be executed by the client.
+                                  "action": "A String", # Required. The name of the tool's action associated with this call.
+                                  "inputParameters": { # Optional. The action's input parameters.
+                                    "a_key": "", # Properties of the object.
+                                  },
+                                  "tool": "A String", # Required. The tool associated with this call. Format: `projects//locations//agents//tools/`.
+                                },
+                              },
+                            ],
+                            "returnPartialResponses": True or False, # Whether Dialogflow should return currently queued fulfillment response messages in streaming APIs. If a webhook is specified, it happens before Dialogflow invokes webhook. Warning: 1) This flag only affects streaming API. Responses are still queued and returned once in non-streaming API. 2) The flag can be enabled in any fulfillment but only the first 3 partial responses will be returned. You may only want to apply it to fulfillments that have slow webhooks.
+                            "setParameterActions": [ # Set parameter values before executing the webhook.
+                              { # Setting a parameter value.
+                                "parameter": "A String", # Display name of the parameter.
+                                "value": "", # The new value of the parameter. A null value clears the parameter.
+                              },
+                            ],
+                            "tag": "A String", # The value of this field will be populated in the WebhookRequest `fulfillmentInfo.tag` field by Dialogflow when the associated webhook is called. The tag is typically used by the webhook service to identify which fulfillment is being called, but it could be used for other purposes. This field is required if `webhook` is specified.
+                            "webhook": "A String", # The webhook to call. Format: `projects//locations//agents//webhooks/`.
+                          },
+                          "repromptEventHandlers": [ # The handlers for parameter-level events, used to provide reprompt for the parameter or transition to a different page/flow. The supported events are: * `sys.no-match-`, where N can be from 1 to 6 * `sys.no-match-default` * `sys.no-input-`, where N can be from 1 to 6 * `sys.no-input-default` * `sys.invalid-parameter` `initial_prompt_fulfillment` provides the first prompt for the parameter. If the user's response does not fill the parameter, a no-match/no-input event will be triggered, and the fulfillment associated with the `sys.no-match-1`/`sys.no-input-1` handler (if defined) will be called to provide a prompt. The `sys.no-match-2`/`sys.no-input-2` handler (if defined) will respond to the next no-match/no-input event, and so on. A `sys.no-match-default` or `sys.no-input-default` handler will be used to handle all following no-match/no-input events after all numbered no-match/no-input handlers for the parameter are consumed. A `sys.invalid-parameter` handler can be defined to handle the case where the parameter values have been `invalidated` by webhook. For example, if the user's response fill the parameter, however the parameter was invalidated by webhook, the fulfillment associated with the `sys.invalid-parameter` handler (if defined) will be called to provide a prompt. If the event handler for the corresponding event can't be found on the parameter, `initial_prompt_fulfillment` will be re-prompted.
+                            { # An event handler specifies an event that can be handled during a session. When the specified event happens, the following actions are taken in order: * If there is a `trigger_fulfillment` associated with the event, it will be called. * If there is a `target_page` associated with the event, the session will transition into the specified page. * If there is a `target_flow` associated with the event, the session will transition into the specified flow.
+                              "event": "A String", # Required. The name of the event to handle.
+                              "name": "A String", # Output only. The unique identifier of this event handler.
+                              "targetFlow": "A String", # The target flow to transition to. Format: `projects//locations//agents//flows/`.
+                              "targetPage": "A String", # The target page to transition to. Format: `projects//locations//agents//flows//pages/`.
+                              "triggerFulfillment": { # A fulfillment can do one or more of the following actions at the same time: * Generate rich message responses. * Set parameter values. * Call the webhook. Fulfillments can be called at various stages in the Page or Form lifecycle. For example, when a DetectIntentRequest drives a session to enter a new page, the page's entry fulfillment can add a static response to the QueryResult in the returning DetectIntentResponse, call the webhook (for example, to load user data from a database), or both. # The fulfillment to call when the event occurs. Handling webhook errors with a fulfillment enabled with webhook could cause infinite loop. It is invalid to specify such fulfillment for a handler handling webhooks.
+                                "advancedSettings": { # Hierarchical advanced settings for agent/flow/page/fulfillment/parameter. Settings exposed at lower level overrides the settings exposed at higher level. Overriding occurs at the sub-setting level. For example, the playback_interruption_settings at fulfillment level only overrides the playback_interruption_settings at the agent level, leaving other settings at the agent level unchanged. DTMF settings does not override each other. DTMF settings set at different levels define DTMF detections running in parallel. Hierarchy: Agent->Flow->Page->Fulfillment/Parameter. # Hierarchical advanced settings for this fulfillment. The settings exposed at the lower level overrides the settings exposed at the higher level.
+                                  "audioExportGcsDestination": { # Google Cloud Storage location for a Dialogflow operation that writes or exports objects (e.g. exported agent or transcripts) outside of Dialogflow. # If present, incoming audio is exported by Dialogflow to the configured Google Cloud Storage destination. Exposed at the following levels: - Agent level - Flow level
+                                    "uri": "A String", # Required. The Google Cloud Storage URI for the exported objects. A URI is of the form: `gs://bucket/object-name-or-prefix` Whether a full object name, or just a prefix, its usage depends on the Dialogflow operation.
+                                  },
+                                  "dtmfSettings": { # Define behaviors for DTMF (dual tone multi frequency). # Settings for DTMF. Exposed at the following levels: - Agent level - Flow level - Page level - Parameter level.
+                                    "enabled": True or False, # If true, incoming audio is processed for DTMF (dual tone multi frequency) events. For example, if the caller presses a button on their telephone keypad and DTMF processing is enabled, Dialogflow will detect the event (e.g. a "3" was pressed) in the incoming audio and pass the event to the bot to drive business logic (e.g. when 3 is pressed, return the account balance).
+                                    "endpointingTimeoutDuration": "A String", # Endpoint timeout setting for matching dtmf input to regex.
+                                    "finishDigit": "A String", # The digit that terminates a DTMF digit sequence.
+                                    "interdigitTimeoutDuration": "A String", # Interdigit timeout setting for matching dtmf input to regex.
+                                    "maxDigits": 42, # Max length of DTMF digits.
+                                  },
+                                  "loggingSettings": { # Define behaviors on logging. # Settings for logging. Settings for Dialogflow History, Contact Center messages, StackDriver logs, and speech logging. Exposed at the following levels: - Agent level.
+                                    "enableInteractionLogging": True or False, # Enables DF Interaction logging.
+                                    "enableStackdriverLogging": True or False, # Enables StackDriver logging.
+                                  },
+                                  "speechSettings": { # Define behaviors of speech to text detection. # Settings for speech to text detection. Exposed at the following levels: - Agent level - Flow level - Page level - Parameter level
+                                    "endpointerSensitivity": 42, # Sensitivity of the speech model that detects the end of speech. Scale from 0 to 100.
+                                    "models": { # Mapping from language to Speech-to-Text model. The mapped Speech-to-Text model will be selected for requests from its corresponding language. For more information, see [Speech models](https://cloud.google.com/dialogflow/cx/docs/concept/speech-models).
+                                      "a_key": "A String",
+                                    },
+                                    "noSpeechTimeout": "A String", # Timeout before detecting no speech.
+                                    "useTimeoutBasedEndpointing": True or False, # Use timeout based endpointing, interpreting endpointer sensitivy as seconds of timeout value.
+                                  },
+                                },
+                                "conditionalCases": [ # Conditional cases for this fulfillment.
+                                  { # A list of cascading if-else conditions. Cases are mutually exclusive. The first one with a matching condition is selected, all the rest ignored.
+                                    "cases": [ # A list of cascading if-else conditions.
+                                      { # Each case has a Boolean condition. When it is evaluated to be True, the corresponding messages will be selected and evaluated recursively.
+                                        "caseContent": [ # A list of case content.
+                                          { # The list of messages or conditional cases to activate for this case.
+                                            "additionalCases": # Object with schema name: GoogleCloudDialogflowCxV3beta1FulfillmentConditionalCases # Additional cases to be evaluated.
+                                            "message": { # 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. # Returned message.
+                                              "channel": "A String", # The channel which the response is associated with. Clients can specify the channel via QueryParameters.channel, and only associated channel response will be returned.
+                                              "conversationSuccess": { # 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. # Indicates that the conversation succeeded.
+                                                "metadata": { # Custom metadata. Dialogflow doesn't impose any structure on this.
+                                                  "a_key": "", # Properties of the object.
+                                                },
+                                              },
+                                              "endInteraction": { # 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. # Output only. A signal that indicates the interaction with the Dialogflow agent has ended. This message is generated by Dialogflow only when the conversation reaches `END_SESSION` page. It is not supposed to be defined by the user. It's guaranteed that there is at most one such message in each response.
+                                              },
+                                              "knowledgeInfoCard": { # Represents info card response. If the response contains generative knowledge prediction, Dialogflow will return a payload with Infobot Messenger compatible info card. Otherwise, the info card response is skipped. # Represents info card for knowledge answers, to be better rendered in Dialogflow Messenger.
+                                              },
+                                              "liveAgentHandoff": { # 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. # Hands off conversation to a human agent.
+                                                "metadata": { # Custom metadata for your handoff procedure. Dialogflow doesn't impose any structure on this.
+                                                  "a_key": "", # Properties of the object.
+                                                },
+                                              },
+                                              "mixedAudio": { # 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. # Output only. An audio response message composed of both the synthesized Dialogflow agent responses and responses defined via play_audio. This message is generated by Dialogflow only and not supposed to be defined by the user.
+                                                "segments": [ # Segments this audio response is composed of.
+                                                  { # Represents one segment of audio.
+                                                    "allowPlaybackInterruption": True or False, # 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.
+                                                    "audio": "A String", # Raw audio synthesized from the Dialogflow agent's response using the output config specified in the request.
+                                                    "uri": "A String", # Client-specific URI that points to an audio clip accessible to the client. Dialogflow does not impose any validation on it.
+                                                  },
+                                                ],
+                                              },
+                                              "outputAudioText": { # A text or ssml response that is preferentially used for TTS output audio synthesis, as described in the comment on the ResponseMessage message. # A text or ssml response that is preferentially used for TTS output audio synthesis, as described in the comment on the ResponseMessage message.
+                                                "allowPlaybackInterruption": True or False, # 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.
+                                                "ssml": "A String", # The SSML text to be synthesized. For more information, see [SSML](/speech/text-to-speech/docs/ssml).
+                                                "text": "A String", # The raw text to be synthesized.
+                                              },
+                                              "payload": { # Returns a response containing a custom, platform-specific payload.
+                                                "a_key": "", # Properties of the object.
+                                              },
+                                              "playAudio": { # Specifies an audio clip to be played by the client as part of the response. # Signal that the client should play an audio clip hosted at a client-specific URI. Dialogflow uses this to construct mixed_audio. However, Dialogflow itself does not try to read or process the URI in any way.
+                                                "allowPlaybackInterruption": True or False, # 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.
+                                                "audioUri": "A String", # Required. URI of the audio clip. Dialogflow does not impose any validation on this value. It is specific to the client that reads it.
+                                              },
+                                              "telephonyTransferCall": { # Represents the signal that telles the client to transfer the phone call connected to the agent to a third-party endpoint. # A signal that the client should transfer the phone call connected to this agent to a third-party endpoint.
+                                                "phoneNumber": "A String", # Transfer the call to a phone number in [E.164 format](https://en.wikipedia.org/wiki/E.164).
+                                              },
+                                              "text": { # The text response message. # Returns a text response.
+                                                "allowPlaybackInterruption": True or False, # 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.
+                                                "text": [ # Required. A collection of text responses.
+                                                  "A String",
+                                                ],
+                                              },
+                                              "toolCall": { # Represents a call of a specific tool's action with the specified inputs. # Returns the definition of a tool call that should be executed by the client.
+                                                "action": "A String", # Required. The name of the tool's action associated with this call.
+                                                "inputParameters": { # Optional. The action's input parameters.
+                                                  "a_key": "", # Properties of the object.
+                                                },
+                                                "tool": "A String", # Required. The tool associated with this call. Format: `projects//locations//agents//tools/`.
+                                              },
+                                            },
+                                          },
+                                        ],
+                                        "condition": "A String", # The condition to activate and select this case. Empty means the condition is always true. The condition is evaluated against form parameters or session parameters. See the [conditions reference](https://cloud.google.com/dialogflow/cx/docs/reference/condition).
+                                      },
+                                    ],
+                                  },
+                                ],
+                                "enableGenerativeFallback": True or False, # If the flag is true, the agent will utilize LLM to generate a text response. If LLM generation fails, the defined responses in the fulfillment will be respected. This flag is only useful for fulfillments associated with no-match event handlers.
+                                "messages": [ # The list of rich message responses to present to the user.
+                                  { # 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.
+                                    "channel": "A String", # The channel which the response is associated with. Clients can specify the channel via QueryParameters.channel, and only associated channel response will be returned.
+                                    "conversationSuccess": { # 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. # Indicates that the conversation succeeded.
+                                      "metadata": { # Custom metadata. Dialogflow doesn't impose any structure on this.
+                                        "a_key": "", # Properties of the object.
+                                      },
+                                    },
+                                    "endInteraction": { # 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. # Output only. A signal that indicates the interaction with the Dialogflow agent has ended. This message is generated by Dialogflow only when the conversation reaches `END_SESSION` page. It is not supposed to be defined by the user. It's guaranteed that there is at most one such message in each response.
+                                    },
+                                    "knowledgeInfoCard": { # Represents info card response. If the response contains generative knowledge prediction, Dialogflow will return a payload with Infobot Messenger compatible info card. Otherwise, the info card response is skipped. # Represents info card for knowledge answers, to be better rendered in Dialogflow Messenger.
+                                    },
+                                    "liveAgentHandoff": { # 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. # Hands off conversation to a human agent.
+                                      "metadata": { # Custom metadata for your handoff procedure. Dialogflow doesn't impose any structure on this.
+                                        "a_key": "", # Properties of the object.
+                                      },
+                                    },
+                                    "mixedAudio": { # 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. # Output only. An audio response message composed of both the synthesized Dialogflow agent responses and responses defined via play_audio. This message is generated by Dialogflow only and not supposed to be defined by the user.
+                                      "segments": [ # Segments this audio response is composed of.
+                                        { # Represents one segment of audio.
+                                          "allowPlaybackInterruption": True or False, # 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.
+                                          "audio": "A String", # Raw audio synthesized from the Dialogflow agent's response using the output config specified in the request.
+                                          "uri": "A String", # Client-specific URI that points to an audio clip accessible to the client. Dialogflow does not impose any validation on it.
+                                        },
+                                      ],
+                                    },
+                                    "outputAudioText": { # A text or ssml response that is preferentially used for TTS output audio synthesis, as described in the comment on the ResponseMessage message. # A text or ssml response that is preferentially used for TTS output audio synthesis, as described in the comment on the ResponseMessage message.
+                                      "allowPlaybackInterruption": True or False, # 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.
+                                      "ssml": "A String", # The SSML text to be synthesized. For more information, see [SSML](/speech/text-to-speech/docs/ssml).
+                                      "text": "A String", # The raw text to be synthesized.
+                                    },
+                                    "payload": { # Returns a response containing a custom, platform-specific payload.
+                                      "a_key": "", # Properties of the object.
+                                    },
+                                    "playAudio": { # Specifies an audio clip to be played by the client as part of the response. # Signal that the client should play an audio clip hosted at a client-specific URI. Dialogflow uses this to construct mixed_audio. However, Dialogflow itself does not try to read or process the URI in any way.
+                                      "allowPlaybackInterruption": True or False, # 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.
+                                      "audioUri": "A String", # Required. URI of the audio clip. Dialogflow does not impose any validation on this value. It is specific to the client that reads it.
+                                    },
+                                    "telephonyTransferCall": { # Represents the signal that telles the client to transfer the phone call connected to the agent to a third-party endpoint. # A signal that the client should transfer the phone call connected to this agent to a third-party endpoint.
+                                      "phoneNumber": "A String", # Transfer the call to a phone number in [E.164 format](https://en.wikipedia.org/wiki/E.164).
+                                    },
+                                    "text": { # The text response message. # Returns a text response.
+                                      "allowPlaybackInterruption": True or False, # 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.
+                                      "text": [ # Required. A collection of text responses.
+                                        "A String",
+                                      ],
+                                    },
+                                    "toolCall": { # Represents a call of a specific tool's action with the specified inputs. # Returns the definition of a tool call that should be executed by the client.
+                                      "action": "A String", # Required. The name of the tool's action associated with this call.
+                                      "inputParameters": { # Optional. The action's input parameters.
+                                        "a_key": "", # Properties of the object.
+                                      },
+                                      "tool": "A String", # Required. The tool associated with this call. Format: `projects//locations//agents//tools/`.
+                                    },
+                                  },
+                                ],
+                                "returnPartialResponses": True or False, # Whether Dialogflow should return currently queued fulfillment response messages in streaming APIs. If a webhook is specified, it happens before Dialogflow invokes webhook. Warning: 1) This flag only affects streaming API. Responses are still queued and returned once in non-streaming API. 2) The flag can be enabled in any fulfillment but only the first 3 partial responses will be returned. You may only want to apply it to fulfillments that have slow webhooks.
+                                "setParameterActions": [ # Set parameter values before executing the webhook.
+                                  { # Setting a parameter value.
+                                    "parameter": "A String", # Display name of the parameter.
+                                    "value": "", # The new value of the parameter. A null value clears the parameter.
+                                  },
+                                ],
+                                "tag": "A String", # The value of this field will be populated in the WebhookRequest `fulfillmentInfo.tag` field by Dialogflow when the associated webhook is called. The tag is typically used by the webhook service to identify which fulfillment is being called, but it could be used for other purposes. This field is required if `webhook` is specified.
+                                "webhook": "A String", # The webhook to call. Format: `projects//locations//agents//webhooks/`.
+                              },
+                            },
+                          ],
+                        },
+                        "isList": True or False, # Indicates whether the parameter represents a list of values.
+                        "redact": True or False, # Indicates whether the parameter content should be redacted in log. If redaction is enabled, the parameter content will be replaced by parameter name during logging. Note: the parameter content is subject to redaction if either parameter level redaction or entity type level redaction is enabled.
+                        "required": True or False, # 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.
+                      },
+                    ],
+                  },
+                  "knowledgeConnectorSettings": { # The Knowledge Connector settings for this page or flow. This includes information such as the attached Knowledge Bases, and the way to execute fulfillment. # Optional. Knowledge connector configuration.
+                    "dataStoreConnections": [ # Optional. List of related data store connections.
+                      { # A data store connection. It represents a data store in Discovery Engine and the type of the contents it contains.
+                        "dataStore": "A String", # The full name of the referenced data store. Formats: `projects/{project}/locations/{location}/collections/{collection}/dataStores/{data_store}` `projects/{project}/locations/{location}/dataStores/{data_store}`
+                        "dataStoreType": "A String", # The type of the connected data store.
+                      },
+                    ],
+                    "enabled": True or False, # Whether Knowledge Connector is enabled or not.
+                    "targetFlow": "A String", # The target flow to transition to. Format: `projects//locations//agents//flows/`.
+                    "targetPage": "A String", # The target page to transition to. Format: `projects//locations//agents//flows//pages/`.
+                    "triggerFulfillment": { # A fulfillment can do one or more of the following actions at the same time: * Generate rich message responses. * Set parameter values. * Call the webhook. Fulfillments can be called at various stages in the Page or Form lifecycle. For example, when a DetectIntentRequest drives a session to enter a new page, the page's entry fulfillment can add a static response to the QueryResult in the returning DetectIntentResponse, call the webhook (for example, to load user data from a database), or both. # The fulfillment to be triggered. When the answers from the Knowledge Connector are selected by Dialogflow, you can utitlize the request scoped parameter `$request.knowledge.answers` (contains up to the 5 highest confidence answers) and `$request.knowledge.questions` (contains the corresponding questions) to construct the fulfillment.
+                      "advancedSettings": { # Hierarchical advanced settings for agent/flow/page/fulfillment/parameter. Settings exposed at lower level overrides the settings exposed at higher level. Overriding occurs at the sub-setting level. For example, the playback_interruption_settings at fulfillment level only overrides the playback_interruption_settings at the agent level, leaving other settings at the agent level unchanged. DTMF settings does not override each other. DTMF settings set at different levels define DTMF detections running in parallel. Hierarchy: Agent->Flow->Page->Fulfillment/Parameter. # Hierarchical advanced settings for this fulfillment. The settings exposed at the lower level overrides the settings exposed at the higher level.
+                        "audioExportGcsDestination": { # Google Cloud Storage location for a Dialogflow operation that writes or exports objects (e.g. exported agent or transcripts) outside of Dialogflow. # If present, incoming audio is exported by Dialogflow to the configured Google Cloud Storage destination. Exposed at the following levels: - Agent level - Flow level
+                          "uri": "A String", # Required. The Google Cloud Storage URI for the exported objects. A URI is of the form: `gs://bucket/object-name-or-prefix` Whether a full object name, or just a prefix, its usage depends on the Dialogflow operation.
+                        },
+                        "dtmfSettings": { # Define behaviors for DTMF (dual tone multi frequency). # Settings for DTMF. Exposed at the following levels: - Agent level - Flow level - Page level - Parameter level.
+                          "enabled": True or False, # If true, incoming audio is processed for DTMF (dual tone multi frequency) events. For example, if the caller presses a button on their telephone keypad and DTMF processing is enabled, Dialogflow will detect the event (e.g. a "3" was pressed) in the incoming audio and pass the event to the bot to drive business logic (e.g. when 3 is pressed, return the account balance).
+                          "endpointingTimeoutDuration": "A String", # Endpoint timeout setting for matching dtmf input to regex.
+                          "finishDigit": "A String", # The digit that terminates a DTMF digit sequence.
+                          "interdigitTimeoutDuration": "A String", # Interdigit timeout setting for matching dtmf input to regex.
+                          "maxDigits": 42, # Max length of DTMF digits.
+                        },
+                        "loggingSettings": { # Define behaviors on logging. # Settings for logging. Settings for Dialogflow History, Contact Center messages, StackDriver logs, and speech logging. Exposed at the following levels: - Agent level.
+                          "enableInteractionLogging": True or False, # Enables DF Interaction logging.
+                          "enableStackdriverLogging": True or False, # Enables StackDriver logging.
+                        },
+                        "speechSettings": { # Define behaviors of speech to text detection. # Settings for speech to text detection. Exposed at the following levels: - Agent level - Flow level - Page level - Parameter level
+                          "endpointerSensitivity": 42, # Sensitivity of the speech model that detects the end of speech. Scale from 0 to 100.
+                          "models": { # Mapping from language to Speech-to-Text model. The mapped Speech-to-Text model will be selected for requests from its corresponding language. For more information, see [Speech models](https://cloud.google.com/dialogflow/cx/docs/concept/speech-models).
+                            "a_key": "A String",
+                          },
+                          "noSpeechTimeout": "A String", # Timeout before detecting no speech.
+                          "useTimeoutBasedEndpointing": True or False, # Use timeout based endpointing, interpreting endpointer sensitivy as seconds of timeout value.
+                        },
+                      },
+                      "conditionalCases": [ # Conditional cases for this fulfillment.
+                        { # A list of cascading if-else conditions. Cases are mutually exclusive. The first one with a matching condition is selected, all the rest ignored.
+                          "cases": [ # A list of cascading if-else conditions.
+                            { # Each case has a Boolean condition. When it is evaluated to be True, the corresponding messages will be selected and evaluated recursively.
+                              "caseContent": [ # A list of case content.
+                                { # The list of messages or conditional cases to activate for this case.
+                                  "additionalCases": # Object with schema name: GoogleCloudDialogflowCxV3beta1FulfillmentConditionalCases # Additional cases to be evaluated.
+                                  "message": { # 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. # Returned message.
+                                    "channel": "A String", # The channel which the response is associated with. Clients can specify the channel via QueryParameters.channel, and only associated channel response will be returned.
+                                    "conversationSuccess": { # 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. # Indicates that the conversation succeeded.
+                                      "metadata": { # Custom metadata. Dialogflow doesn't impose any structure on this.
+                                        "a_key": "", # Properties of the object.
+                                      },
+                                    },
+                                    "endInteraction": { # 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. # Output only. A signal that indicates the interaction with the Dialogflow agent has ended. This message is generated by Dialogflow only when the conversation reaches `END_SESSION` page. It is not supposed to be defined by the user. It's guaranteed that there is at most one such message in each response.
+                                    },
+                                    "knowledgeInfoCard": { # Represents info card response. If the response contains generative knowledge prediction, Dialogflow will return a payload with Infobot Messenger compatible info card. Otherwise, the info card response is skipped. # Represents info card for knowledge answers, to be better rendered in Dialogflow Messenger.
+                                    },
+                                    "liveAgentHandoff": { # 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. # Hands off conversation to a human agent.
+                                      "metadata": { # Custom metadata for your handoff procedure. Dialogflow doesn't impose any structure on this.
+                                        "a_key": "", # Properties of the object.
+                                      },
+                                    },
+                                    "mixedAudio": { # 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. # Output only. An audio response message composed of both the synthesized Dialogflow agent responses and responses defined via play_audio. This message is generated by Dialogflow only and not supposed to be defined by the user.
+                                      "segments": [ # Segments this audio response is composed of.
+                                        { # Represents one segment of audio.
+                                          "allowPlaybackInterruption": True or False, # 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.
+                                          "audio": "A String", # Raw audio synthesized from the Dialogflow agent's response using the output config specified in the request.
+                                          "uri": "A String", # Client-specific URI that points to an audio clip accessible to the client. Dialogflow does not impose any validation on it.
+                                        },
+                                      ],
+                                    },
+                                    "outputAudioText": { # A text or ssml response that is preferentially used for TTS output audio synthesis, as described in the comment on the ResponseMessage message. # A text or ssml response that is preferentially used for TTS output audio synthesis, as described in the comment on the ResponseMessage message.
+                                      "allowPlaybackInterruption": True or False, # 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.
+                                      "ssml": "A String", # The SSML text to be synthesized. For more information, see [SSML](/speech/text-to-speech/docs/ssml).
+                                      "text": "A String", # The raw text to be synthesized.
+                                    },
+                                    "payload": { # Returns a response containing a custom, platform-specific payload.
+                                      "a_key": "", # Properties of the object.
+                                    },
+                                    "playAudio": { # Specifies an audio clip to be played by the client as part of the response. # Signal that the client should play an audio clip hosted at a client-specific URI. Dialogflow uses this to construct mixed_audio. However, Dialogflow itself does not try to read or process the URI in any way.
+                                      "allowPlaybackInterruption": True or False, # 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.
+                                      "audioUri": "A String", # Required. URI of the audio clip. Dialogflow does not impose any validation on this value. It is specific to the client that reads it.
+                                    },
+                                    "telephonyTransferCall": { # Represents the signal that telles the client to transfer the phone call connected to the agent to a third-party endpoint. # A signal that the client should transfer the phone call connected to this agent to a third-party endpoint.
+                                      "phoneNumber": "A String", # Transfer the call to a phone number in [E.164 format](https://en.wikipedia.org/wiki/E.164).
+                                    },
+                                    "text": { # The text response message. # Returns a text response.
+                                      "allowPlaybackInterruption": True or False, # 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.
+                                      "text": [ # Required. A collection of text responses.
+                                        "A String",
+                                      ],
+                                    },
+                                    "toolCall": { # Represents a call of a specific tool's action with the specified inputs. # Returns the definition of a tool call that should be executed by the client.
+                                      "action": "A String", # Required. The name of the tool's action associated with this call.
+                                      "inputParameters": { # Optional. The action's input parameters.
+                                        "a_key": "", # Properties of the object.
+                                      },
+                                      "tool": "A String", # Required. The tool associated with this call. Format: `projects//locations//agents//tools/`.
+                                    },
+                                  },
+                                },
+                              ],
+                              "condition": "A String", # The condition to activate and select this case. Empty means the condition is always true. The condition is evaluated against form parameters or session parameters. See the [conditions reference](https://cloud.google.com/dialogflow/cx/docs/reference/condition).
+                            },
+                          ],
+                        },
+                      ],
+                      "enableGenerativeFallback": True or False, # If the flag is true, the agent will utilize LLM to generate a text response. If LLM generation fails, the defined responses in the fulfillment will be respected. This flag is only useful for fulfillments associated with no-match event handlers.
+                      "messages": [ # The list of rich message responses to present to the user.
+                        { # 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.
+                          "channel": "A String", # The channel which the response is associated with. Clients can specify the channel via QueryParameters.channel, and only associated channel response will be returned.
+                          "conversationSuccess": { # 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. # Indicates that the conversation succeeded.
+                            "metadata": { # Custom metadata. Dialogflow doesn't impose any structure on this.
+                              "a_key": "", # Properties of the object.
+                            },
+                          },
+                          "endInteraction": { # 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. # Output only. A signal that indicates the interaction with the Dialogflow agent has ended. This message is generated by Dialogflow only when the conversation reaches `END_SESSION` page. It is not supposed to be defined by the user. It's guaranteed that there is at most one such message in each response.
+                          },
+                          "knowledgeInfoCard": { # Represents info card response. If the response contains generative knowledge prediction, Dialogflow will return a payload with Infobot Messenger compatible info card. Otherwise, the info card response is skipped. # Represents info card for knowledge answers, to be better rendered in Dialogflow Messenger.
+                          },
+                          "liveAgentHandoff": { # 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. # Hands off conversation to a human agent.
+                            "metadata": { # Custom metadata for your handoff procedure. Dialogflow doesn't impose any structure on this.
+                              "a_key": "", # Properties of the object.
+                            },
+                          },
+                          "mixedAudio": { # 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. # Output only. An audio response message composed of both the synthesized Dialogflow agent responses and responses defined via play_audio. This message is generated by Dialogflow only and not supposed to be defined by the user.
+                            "segments": [ # Segments this audio response is composed of.
+                              { # Represents one segment of audio.
+                                "allowPlaybackInterruption": True or False, # 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.
+                                "audio": "A String", # Raw audio synthesized from the Dialogflow agent's response using the output config specified in the request.
+                                "uri": "A String", # Client-specific URI that points to an audio clip accessible to the client. Dialogflow does not impose any validation on it.
+                              },
+                            ],
+                          },
+                          "outputAudioText": { # A text or ssml response that is preferentially used for TTS output audio synthesis, as described in the comment on the ResponseMessage message. # A text or ssml response that is preferentially used for TTS output audio synthesis, as described in the comment on the ResponseMessage message.
+                            "allowPlaybackInterruption": True or False, # 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.
+                            "ssml": "A String", # The SSML text to be synthesized. For more information, see [SSML](/speech/text-to-speech/docs/ssml).
+                            "text": "A String", # The raw text to be synthesized.
+                          },
+                          "payload": { # Returns a response containing a custom, platform-specific payload.
+                            "a_key": "", # Properties of the object.
+                          },
+                          "playAudio": { # Specifies an audio clip to be played by the client as part of the response. # Signal that the client should play an audio clip hosted at a client-specific URI. Dialogflow uses this to construct mixed_audio. However, Dialogflow itself does not try to read or process the URI in any way.
+                            "allowPlaybackInterruption": True or False, # 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.
+                            "audioUri": "A String", # Required. URI of the audio clip. Dialogflow does not impose any validation on this value. It is specific to the client that reads it.
+                          },
+                          "telephonyTransferCall": { # Represents the signal that telles the client to transfer the phone call connected to the agent to a third-party endpoint. # A signal that the client should transfer the phone call connected to this agent to a third-party endpoint.
+                            "phoneNumber": "A String", # Transfer the call to a phone number in [E.164 format](https://en.wikipedia.org/wiki/E.164).
+                          },
+                          "text": { # The text response message. # Returns a text response.
+                            "allowPlaybackInterruption": True or False, # 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.
+                            "text": [ # Required. A collection of text responses.
+                              "A String",
+                            ],
+                          },
+                          "toolCall": { # Represents a call of a specific tool's action with the specified inputs. # Returns the definition of a tool call that should be executed by the client.
+                            "action": "A String", # Required. The name of the tool's action associated with this call.
+                            "inputParameters": { # Optional. The action's input parameters.
+                              "a_key": "", # Properties of the object.
+                            },
+                            "tool": "A String", # Required. The tool associated with this call. Format: `projects//locations//agents//tools/`.
+                          },
+                        },
+                      ],
+                      "returnPartialResponses": True or False, # Whether Dialogflow should return currently queued fulfillment response messages in streaming APIs. If a webhook is specified, it happens before Dialogflow invokes webhook. Warning: 1) This flag only affects streaming API. Responses are still queued and returned once in non-streaming API. 2) The flag can be enabled in any fulfillment but only the first 3 partial responses will be returned. You may only want to apply it to fulfillments that have slow webhooks.
+                      "setParameterActions": [ # Set parameter values before executing the webhook.
+                        { # Setting a parameter value.
+                          "parameter": "A String", # Display name of the parameter.
+                          "value": "", # The new value of the parameter. A null value clears the parameter.
+                        },
+                      ],
+                      "tag": "A String", # The value of this field will be populated in the WebhookRequest `fulfillmentInfo.tag` field by Dialogflow when the associated webhook is called. The tag is typically used by the webhook service to identify which fulfillment is being called, but it could be used for other purposes. This field is required if `webhook` is specified.
+                      "webhook": "A String", # The webhook to call. Format: `projects//locations//agents//webhooks/`.
+                    },
+                  },
+                  "name": "A String", # The unique identifier of the page. Required for the Pages.UpdatePage method. Pages.CreatePage populates the name automatically. Format: `projects//locations//agents//flows//pages/`.
+                  "transitionRouteGroups": [ # Ordered list of `TransitionRouteGroups` added to the page. Transition route groups must be unique within a page. If the page links both flow-level transition route groups and agent-level transition route groups, the flow-level ones will have higher priority and will be put before the agent-level ones. * If multiple transition routes within a page scope refer to the same intent, then the precedence order is: page's transition route -> page's transition route group -> flow's transition routes. * If multiple transition route groups within a page contain the same intent, then the first group in the ordered list takes precedence. Format:`projects//locations//agents//flows//transitionRouteGroups/` or `projects//locations//agents//transitionRouteGroups/` for agent-level groups.
+                    "A String",
+                  ],
+                  "transitionRoutes": [ # A list of transitions for the transition rules of this page. They route the conversation to another page in the same flow, or another flow. When we are in a certain page, the TransitionRoutes are evalauted in the following order: * TransitionRoutes defined in the page with intent specified. * TransitionRoutes defined in the transition route groups with intent specified. * TransitionRoutes defined in flow with intent specified. * TransitionRoutes defined in the transition route groups with intent specified. * TransitionRoutes defined in the page with only condition specified. * TransitionRoutes defined in the transition route groups with only condition specified.
+                    { # A transition route specifies a intent that can be matched and/or a data condition that can be evaluated during a session. When a specified transition is matched, the following actions are taken in order: * If there is a `trigger_fulfillment` associated with the transition, it will be called. * If there is a `target_page` associated with the transition, the session will transition into the specified page. * If there is a `target_flow` associated with the transition, the session will transition into the specified flow.
+                      "condition": "A String", # The condition to evaluate against form parameters or session parameters. See the [conditions reference](https://cloud.google.com/dialogflow/cx/docs/reference/condition). At least one of `intent` or `condition` must be specified. When both `intent` and `condition` are specified, the transition can only happen when both are fulfilled.
+                      "description": "A String", # Optional. The description of the transition route. The maximum length is 500 characters.
+                      "intent": "A String", # The unique identifier of an Intent. Format: `projects//locations//agents//intents/`. Indicates that the transition can only happen when the given intent is matched. At least one of `intent` or `condition` must be specified. When both `intent` and `condition` are specified, the transition can only happen when both are fulfilled.
+                      "name": "A String", # Output only. The unique identifier of this transition route.
+                      "targetFlow": "A String", # The target flow to transition to. Format: `projects//locations//agents//flows/`.
+                      "targetPage": "A String", # The target page to transition to. Format: `projects//locations//agents//flows//pages/`.
+                      "triggerFulfillment": { # A fulfillment can do one or more of the following actions at the same time: * Generate rich message responses. * Set parameter values. * Call the webhook. Fulfillments can be called at various stages in the Page or Form lifecycle. For example, when a DetectIntentRequest drives a session to enter a new page, the page's entry fulfillment can add a static response to the QueryResult in the returning DetectIntentResponse, call the webhook (for example, to load user data from a database), or both. # The fulfillment to call when the condition is satisfied. At least one of `trigger_fulfillment` and `target` must be specified. When both are defined, `trigger_fulfillment` is executed first.
+                        "advancedSettings": { # Hierarchical advanced settings for agent/flow/page/fulfillment/parameter. Settings exposed at lower level overrides the settings exposed at higher level. Overriding occurs at the sub-setting level. For example, the playback_interruption_settings at fulfillment level only overrides the playback_interruption_settings at the agent level, leaving other settings at the agent level unchanged. DTMF settings does not override each other. DTMF settings set at different levels define DTMF detections running in parallel. Hierarchy: Agent->Flow->Page->Fulfillment/Parameter. # Hierarchical advanced settings for this fulfillment. The settings exposed at the lower level overrides the settings exposed at the higher level.
+                          "audioExportGcsDestination": { # Google Cloud Storage location for a Dialogflow operation that writes or exports objects (e.g. exported agent or transcripts) outside of Dialogflow. # If present, incoming audio is exported by Dialogflow to the configured Google Cloud Storage destination. Exposed at the following levels: - Agent level - Flow level
+                            "uri": "A String", # Required. The Google Cloud Storage URI for the exported objects. A URI is of the form: `gs://bucket/object-name-or-prefix` Whether a full object name, or just a prefix, its usage depends on the Dialogflow operation.
+                          },
+                          "dtmfSettings": { # Define behaviors for DTMF (dual tone multi frequency). # Settings for DTMF. Exposed at the following levels: - Agent level - Flow level - Page level - Parameter level.
+                            "enabled": True or False, # If true, incoming audio is processed for DTMF (dual tone multi frequency) events. For example, if the caller presses a button on their telephone keypad and DTMF processing is enabled, Dialogflow will detect the event (e.g. a "3" was pressed) in the incoming audio and pass the event to the bot to drive business logic (e.g. when 3 is pressed, return the account balance).
+                            "endpointingTimeoutDuration": "A String", # Endpoint timeout setting for matching dtmf input to regex.
+                            "finishDigit": "A String", # The digit that terminates a DTMF digit sequence.
+                            "interdigitTimeoutDuration": "A String", # Interdigit timeout setting for matching dtmf input to regex.
+                            "maxDigits": 42, # Max length of DTMF digits.
+                          },
+                          "loggingSettings": { # Define behaviors on logging. # Settings for logging. Settings for Dialogflow History, Contact Center messages, StackDriver logs, and speech logging. Exposed at the following levels: - Agent level.
+                            "enableInteractionLogging": True or False, # Enables DF Interaction logging.
+                            "enableStackdriverLogging": True or False, # Enables StackDriver logging.
+                          },
+                          "speechSettings": { # Define behaviors of speech to text detection. # Settings for speech to text detection. Exposed at the following levels: - Agent level - Flow level - Page level - Parameter level
+                            "endpointerSensitivity": 42, # Sensitivity of the speech model that detects the end of speech. Scale from 0 to 100.
+                            "models": { # Mapping from language to Speech-to-Text model. The mapped Speech-to-Text model will be selected for requests from its corresponding language. For more information, see [Speech models](https://cloud.google.com/dialogflow/cx/docs/concept/speech-models).
+                              "a_key": "A String",
+                            },
+                            "noSpeechTimeout": "A String", # Timeout before detecting no speech.
+                            "useTimeoutBasedEndpointing": True or False, # Use timeout based endpointing, interpreting endpointer sensitivy as seconds of timeout value.
+                          },
+                        },
+                        "conditionalCases": [ # Conditional cases for this fulfillment.
+                          { # A list of cascading if-else conditions. Cases are mutually exclusive. The first one with a matching condition is selected, all the rest ignored.
+                            "cases": [ # A list of cascading if-else conditions.
+                              { # Each case has a Boolean condition. When it is evaluated to be True, the corresponding messages will be selected and evaluated recursively.
+                                "caseContent": [ # A list of case content.
+                                  { # The list of messages or conditional cases to activate for this case.
+                                    "additionalCases": # Object with schema name: GoogleCloudDialogflowCxV3beta1FulfillmentConditionalCases # Additional cases to be evaluated.
+                                    "message": { # 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. # Returned message.
+                                      "channel": "A String", # The channel which the response is associated with. Clients can specify the channel via QueryParameters.channel, and only associated channel response will be returned.
+                                      "conversationSuccess": { # 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. # Indicates that the conversation succeeded.
+                                        "metadata": { # Custom metadata. Dialogflow doesn't impose any structure on this.
+                                          "a_key": "", # Properties of the object.
+                                        },
+                                      },
+                                      "endInteraction": { # 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. # Output only. A signal that indicates the interaction with the Dialogflow agent has ended. This message is generated by Dialogflow only when the conversation reaches `END_SESSION` page. It is not supposed to be defined by the user. It's guaranteed that there is at most one such message in each response.
+                                      },
+                                      "knowledgeInfoCard": { # Represents info card response. If the response contains generative knowledge prediction, Dialogflow will return a payload with Infobot Messenger compatible info card. Otherwise, the info card response is skipped. # Represents info card for knowledge answers, to be better rendered in Dialogflow Messenger.
+                                      },
+                                      "liveAgentHandoff": { # 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. # Hands off conversation to a human agent.
+                                        "metadata": { # Custom metadata for your handoff procedure. Dialogflow doesn't impose any structure on this.
+                                          "a_key": "", # Properties of the object.
+                                        },
+                                      },
+                                      "mixedAudio": { # 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. # Output only. An audio response message composed of both the synthesized Dialogflow agent responses and responses defined via play_audio. This message is generated by Dialogflow only and not supposed to be defined by the user.
+                                        "segments": [ # Segments this audio response is composed of.
+                                          { # Represents one segment of audio.
+                                            "allowPlaybackInterruption": True or False, # 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.
+                                            "audio": "A String", # Raw audio synthesized from the Dialogflow agent's response using the output config specified in the request.
+                                            "uri": "A String", # Client-specific URI that points to an audio clip accessible to the client. Dialogflow does not impose any validation on it.
+                                          },
+                                        ],
+                                      },
+                                      "outputAudioText": { # A text or ssml response that is preferentially used for TTS output audio synthesis, as described in the comment on the ResponseMessage message. # A text or ssml response that is preferentially used for TTS output audio synthesis, as described in the comment on the ResponseMessage message.
+                                        "allowPlaybackInterruption": True or False, # 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.
+                                        "ssml": "A String", # The SSML text to be synthesized. For more information, see [SSML](/speech/text-to-speech/docs/ssml).
+                                        "text": "A String", # The raw text to be synthesized.
+                                      },
+                                      "payload": { # Returns a response containing a custom, platform-specific payload.
+                                        "a_key": "", # Properties of the object.
+                                      },
+                                      "playAudio": { # Specifies an audio clip to be played by the client as part of the response. # Signal that the client should play an audio clip hosted at a client-specific URI. Dialogflow uses this to construct mixed_audio. However, Dialogflow itself does not try to read or process the URI in any way.
+                                        "allowPlaybackInterruption": True or False, # 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.
+                                        "audioUri": "A String", # Required. URI of the audio clip. Dialogflow does not impose any validation on this value. It is specific to the client that reads it.
+                                      },
+                                      "telephonyTransferCall": { # Represents the signal that telles the client to transfer the phone call connected to the agent to a third-party endpoint. # A signal that the client should transfer the phone call connected to this agent to a third-party endpoint.
+                                        "phoneNumber": "A String", # Transfer the call to a phone number in [E.164 format](https://en.wikipedia.org/wiki/E.164).
+                                      },
+                                      "text": { # The text response message. # Returns a text response.
+                                        "allowPlaybackInterruption": True or False, # 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.
+                                        "text": [ # Required. A collection of text responses.
+                                          "A String",
+                                        ],
+                                      },
+                                      "toolCall": { # Represents a call of a specific tool's action with the specified inputs. # Returns the definition of a tool call that should be executed by the client.
+                                        "action": "A String", # Required. The name of the tool's action associated with this call.
+                                        "inputParameters": { # Optional. The action's input parameters.
+                                          "a_key": "", # Properties of the object.
+                                        },
+                                        "tool": "A String", # Required. The tool associated with this call. Format: `projects//locations//agents//tools/`.
+                                      },
+                                    },
+                                  },
+                                ],
+                                "condition": "A String", # The condition to activate and select this case. Empty means the condition is always true. The condition is evaluated against form parameters or session parameters. See the [conditions reference](https://cloud.google.com/dialogflow/cx/docs/reference/condition).
+                              },
+                            ],
+                          },
+                        ],
+                        "enableGenerativeFallback": True or False, # If the flag is true, the agent will utilize LLM to generate a text response. If LLM generation fails, the defined responses in the fulfillment will be respected. This flag is only useful for fulfillments associated with no-match event handlers.
+                        "messages": [ # The list of rich message responses to present to the user.
+                          { # 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.
+                            "channel": "A String", # The channel which the response is associated with. Clients can specify the channel via QueryParameters.channel, and only associated channel response will be returned.
+                            "conversationSuccess": { # 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. # Indicates that the conversation succeeded.
+                              "metadata": { # Custom metadata. Dialogflow doesn't impose any structure on this.
+                                "a_key": "", # Properties of the object.
+                              },
+                            },
+                            "endInteraction": { # 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. # Output only. A signal that indicates the interaction with the Dialogflow agent has ended. This message is generated by Dialogflow only when the conversation reaches `END_SESSION` page. It is not supposed to be defined by the user. It's guaranteed that there is at most one such message in each response.
+                            },
+                            "knowledgeInfoCard": { # Represents info card response. If the response contains generative knowledge prediction, Dialogflow will return a payload with Infobot Messenger compatible info card. Otherwise, the info card response is skipped. # Represents info card for knowledge answers, to be better rendered in Dialogflow Messenger.
+                            },
+                            "liveAgentHandoff": { # 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. # Hands off conversation to a human agent.
+                              "metadata": { # Custom metadata for your handoff procedure. Dialogflow doesn't impose any structure on this.
+                                "a_key": "", # Properties of the object.
+                              },
+                            },
+                            "mixedAudio": { # 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. # Output only. An audio response message composed of both the synthesized Dialogflow agent responses and responses defined via play_audio. This message is generated by Dialogflow only and not supposed to be defined by the user.
+                              "segments": [ # Segments this audio response is composed of.
+                                { # Represents one segment of audio.
+                                  "allowPlaybackInterruption": True or False, # 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.
+                                  "audio": "A String", # Raw audio synthesized from the Dialogflow agent's response using the output config specified in the request.
+                                  "uri": "A String", # Client-specific URI that points to an audio clip accessible to the client. Dialogflow does not impose any validation on it.
+                                },
+                              ],
+                            },
+                            "outputAudioText": { # A text or ssml response that is preferentially used for TTS output audio synthesis, as described in the comment on the ResponseMessage message. # A text or ssml response that is preferentially used for TTS output audio synthesis, as described in the comment on the ResponseMessage message.
+                              "allowPlaybackInterruption": True or False, # 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.
+                              "ssml": "A String", # The SSML text to be synthesized. For more information, see [SSML](/speech/text-to-speech/docs/ssml).
+                              "text": "A String", # The raw text to be synthesized.
+                            },
+                            "payload": { # Returns a response containing a custom, platform-specific payload.
+                              "a_key": "", # Properties of the object.
+                            },
+                            "playAudio": { # Specifies an audio clip to be played by the client as part of the response. # Signal that the client should play an audio clip hosted at a client-specific URI. Dialogflow uses this to construct mixed_audio. However, Dialogflow itself does not try to read or process the URI in any way.
+                              "allowPlaybackInterruption": True or False, # 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.
+                              "audioUri": "A String", # Required. URI of the audio clip. Dialogflow does not impose any validation on this value. It is specific to the client that reads it.
+                            },
+                            "telephonyTransferCall": { # Represents the signal that telles the client to transfer the phone call connected to the agent to a third-party endpoint. # A signal that the client should transfer the phone call connected to this agent to a third-party endpoint.
+                              "phoneNumber": "A String", # Transfer the call to a phone number in [E.164 format](https://en.wikipedia.org/wiki/E.164).
+                            },
+                            "text": { # The text response message. # Returns a text response.
+                              "allowPlaybackInterruption": True or False, # 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.
+                              "text": [ # Required. A collection of text responses.
+                                "A String",
+                              ],
+                            },
+                            "toolCall": { # Represents a call of a specific tool's action with the specified inputs. # Returns the definition of a tool call that should be executed by the client.
+                              "action": "A String", # Required. The name of the tool's action associated with this call.
+                              "inputParameters": { # Optional. The action's input parameters.
+                                "a_key": "", # Properties of the object.
+                              },
+                              "tool": "A String", # Required. The tool associated with this call. Format: `projects//locations//agents//tools/`.
+                            },
+                          },
+                        ],
+                        "returnPartialResponses": True or False, # Whether Dialogflow should return currently queued fulfillment response messages in streaming APIs. If a webhook is specified, it happens before Dialogflow invokes webhook. Warning: 1) This flag only affects streaming API. Responses are still queued and returned once in non-streaming API. 2) The flag can be enabled in any fulfillment but only the first 3 partial responses will be returned. You may only want to apply it to fulfillments that have slow webhooks.
+                        "setParameterActions": [ # Set parameter values before executing the webhook.
+                          { # Setting a parameter value.
+                            "parameter": "A String", # Display name of the parameter.
+                            "value": "", # The new value of the parameter. A null value clears the parameter.
+                          },
+                        ],
+                        "tag": "A String", # The value of this field will be populated in the WebhookRequest `fulfillmentInfo.tag` field by Dialogflow when the associated webhook is called. The tag is typically used by the webhook service to identify which fulfillment is being called, but it could be used for other purposes. This field is required if `webhook` is specified.
+                        "webhook": "A String", # The webhook to call. Format: `projects//locations//agents//webhooks/`.
+                      },
+                    },
+                  ],
+                },
+                "dataStoreConnectionSignals": { # Data store connection feature output signals. Might be only partially field if processing stop before the final answer. Reasons for this can be, but are not limited to: empty UCS search results, positive RAI check outcome, grounding failure, ... # Optional. Data store connection feature output signals. Filled only when data stores are involved in serving the query and DetectIntentRequest.populate data_store_connection_quality_signals is set to true in the request.
+                  "answer": "A String", # Optional. The final compiled answer.
+                  "answerGenerationModelCallSignals": { # Diagnostic info related to the answer generation model call. # Optional. Diagnostic info related to the answer generation model call.
+                    "modelOutput": "A String", # Output of the generative model.
+                    "renderedPrompt": "A String", # Prompt as sent to the model.
+                  },
+                  "answerParts": [ # Optional. Answer parts with relevant citations. Concatenation of texts should add up the `answer` (not counting whitespaces).
+                    { # Answer part with citation.
+                      "supportingIndices": [ # Citations for this answer part. Indices of `search_snippets`.
+                        42,
+                      ],
+                      "text": "A String", # Substring of the answer.
+                    },
+                  ],
+                  "citedSnippets": [ # Optional. Snippets cited by the answer generation model from the most to least relevant.
+                    { # Snippet cited by the answer generation model.
+                      "searchSnippet": { # Search snippet details. # Details of the snippet.
+                        "documentTitle": "A String", # Title of the enclosing document.
+                        "documentUri": "A String", # Uri for the document. Present if specified for the document.
+                        "text": "A String", # Text included in the prompt.
+                      },
+                      "snippetIndex": 42, # Index of the snippet in `search_snippets` field.
+                    },
+                  ],
+                  "groundingSignals": { # Grounding signals. # Optional. Grounding signals.
+                    "decision": "A String", # Represents the decision of the grounding check.
+                    "score": "A String", # Grounding score bucket setting.
+                  },
+                  "rewriterModelCallSignals": { # Diagnostic info related to the rewriter model call. # Optional. Diagnostic info related to the rewriter model call.
+                    "modelOutput": "A String", # Output of the generative model.
+                    "renderedPrompt": "A String", # Prompt as sent to the model.
+                  },
+                  "rewrittenQuery": "A String", # Optional. Rewritten string query used for search.
+                  "safetySignals": { # Safety check results. # Optional. Safety check result.
+                    "bannedPhraseMatch": "A String", # Specifies banned phrase match subject.
+                    "decision": "A String", # Safety decision.
+                    "matchedBannedPhrase": "A String", # The matched banned phrase if there was a match.
+                  },
+                  "searchSnippets": [ # Optional. Search snippets included in the answer generation prompt.
+                    { # Search snippet details.
+                      "documentTitle": "A String", # Title of the enclosing document.
+                      "documentUri": "A String", # Uri for the document. Present if specified for the document.
+                      "text": "A String", # Text included in the prompt.
+                    },
+                  ],
+                },
+                "diagnosticInfo": { # The free-form diagnostic info. For example, this field could contain webhook call latency. The fields of this data can change without notice, so you should not write code that depends on its structure. One of the fields is called "Alternative Matched Intents", which may aid with debugging. The following describes these intent results: - The list is empty if no intent was matched to end-user input. - Only intents that are referenced in the currently active flow are included. - The matched intent is included. - Other intents that could have matched end-user input, but did not match because they are referenced by intent routes that are out of [scope](https://cloud.google.com/dialogflow/cx/docs/concept/handler#scope), are included. - Other intents referenced by intent routes in scope that matched end-user input, but had a lower confidence score.
+                  "a_key": "", # Properties of the object.
+                },
+                "dtmf": { # Represents the input for dtmf event. # If a DTMF was provided as input, this field will contain a copy of the DtmfInput.
+                  "digits": "A String", # The dtmf digits.
+                  "finishDigit": "A String", # The finish digit (if any).
+                },
+                "generativeInfo": { # Represents the information of a query if handled by generative agent resources. # The information of a query if handled by generative agent resources.
+                  "actionTracingInfo": { # Example represents a sample execution of the playbook in the conversation. An example consists of a list of ordered actions performed by end user or Dialogflow agent according the playbook instructions to fulfill the task. # The actions performed by the generative playbook for the current agent response.
+                    "actions": [ # Required. The ordered list of actions performed by the end user and the Dialogflow agent.
+                      { # Action performed by end user or Dialogflow agent in the conversation.
+                        "agentUtterance": { # AgentUtterance represents one message sent by the agent. # Optional. Action performed by the agent as a message.
+                          "text": "A String", # Required. Message content in text.
+                        },
+                        "flowInvocation": { # Stores metadata of the invocation of a CX flow. Next Id: 7 # Optional. Action performed on behalf of the agent by invoking a CX flow.
+                          "flow": "A String", # Required. The unique identifier of the flow. Format: `projects//locations//agents/`.
+                          "flowState": "A String", # Required. Flow invocation's output state.
+                          "inputActionParameters": { # Optional. A list of input parameters for the flow.
+                            "a_key": "", # Properties of the object.
+                          },
+                          "outputActionParameters": { # Optional. A list of output parameters generated by the flow invocation.
+                            "a_key": "", # Properties of the object.
+                          },
+                        },
+                        "playbookInvocation": { # Stores metadata of the invocation of a child playbook. Next Id: 5 # Optional. Action performed on behalf of the agent by invoking a child playbook.
+                          "playbook": "A String", # Required. The unique identifier of the playbook. Format: `projects//locations//agents//playbooks/`.
+                          "playbookInput": { # Input of the playbook. # Optional. Input of the child playbook invocation.
+                            "actionParameters": { # Optional. A list of input parameters for the action.
+                              "a_key": "", # Properties of the object.
+                            },
+                            "precedingConversationSummary": "A String", # Optional. Summary string of the preceding conversation for the child playbook invocation.
+                          },
+                          "playbookOutput": { # Output of the playbook. # Optional. Output of the child playbook invocation.
+                            "actionParameters": { # Optional. A Struct object of output parameters for the action.
+                              "a_key": "", # Properties of the object.
+                            },
+                            "executionSummary": "A String", # Optional. Summary string of the execution result of the child playbook.
+                          },
+                          "playbookState": "A String", # Required. Playbook invocation's output state.
+                        },
+                        "toolUse": { # Stores metadata of the invocation of an action supported by a tool. # Optional. Action performed on behalf of the agent by calling a plugin tool.
+                          "action": "A String", # Optional. Name of the action to be called during the tool use.
+                          "inputActionParameters": { # Optional. A list of input parameters for the action.
+                            "a_key": "", # Properties of the object.
+                          },
+                          "outputActionParameters": { # Optional. A list of output parameters generated by the action.
+                            "a_key": "", # Properties of the object.
+                          },
+                          "tool": "A String", # Required. The tool that should be used. Format: `projects//locations//agents//tools/`.
+                        },
+                        "userUtterance": { # UserUtterance represents one message sent by the customer. # Optional. Agent obtained a message from the customer.
+                          "text": "A String", # Required. Message content in text.
+                        },
+                      },
+                    ],
+                    "conversationState": "A String", # Required. Example's output state.
+                    "createTime": "A String", # Output only. The timestamp of initial example creation.
+                    "description": "A String", # Optional. The high level concise description of the example. The max number of characters is 200.
+                    "displayName": "A String", # Required. The display name of the example.
+                    "languageCode": "A String", # Optional. The language code of the example. If not specified, the agent's default language is used. Note: languages must be enabled in the agent before they can be used.
+                    "name": "A String", # The unique identifier of the playbook example. Format: `projects//locations//agents//playbooks//examples/`.
+                    "playbookInput": { # Input of the playbook. # Optional. The input to the playbook in the example.
+                      "actionParameters": { # Optional. A list of input parameters for the action.
+                        "a_key": "", # Properties of the object.
+                      },
+                      "precedingConversationSummary": "A String", # Optional. Summary string of the preceding conversation for the child playbook invocation.
+                    },
+                    "playbookOutput": { # Output of the playbook. # Optional. The output of the playbook in the example.
+                      "actionParameters": { # Optional. A Struct object of output parameters for the action.
+                        "a_key": "", # Properties of the object.
+                      },
+                      "executionSummary": "A String", # Optional. Summary string of the execution result of the child playbook.
+                    },
+                    "tokenCount": "A String", # Output only. Estimated number of tokes current example takes when sent to the LLM.
+                    "updateTime": "A String", # Output only. Last time the example was updated.
+                  },
+                  "currentPlaybooks": [ # The stack of playbooks that the conversation has currently entered, with the most recent one on the top.
+                    "A String",
+                  ],
+                },
+                "intent": { # An intent represents a user's intent to interact with a conversational agent. You can provide information for the Dialogflow API to use to match user input to an intent by adding training phrases (i.e., examples of user input) to your intent. # The Intent that matched the conversational query. Some, not all fields are filled in this message, including but not limited to: `name` and `display_name`. This field is deprecated, please use QueryResult.match instead.
+                  "description": "A String", # Human readable description for better understanding an intent like its scope, content, result etc. Maximum character limit: 140 characters.
+                  "displayName": "A String", # Required. The human-readable name of the intent, unique within the agent.
+                  "isFallback": True or False, # Indicates whether this is a fallback intent. Currently only default fallback intent is allowed in the agent, which is added upon agent creation. Adding training phrases to fallback intent is useful in the case of requests that are mistakenly matched, since training phrases assigned to fallback intents act as negative examples that triggers no-match event.
+                  "labels": { # The key/value metadata to label an intent. Labels can contain lowercase letters, digits and the symbols '-' and '_'. International characters are allowed, including letters from unicase alphabets. Keys must start with a letter. Keys and values can be no longer than 63 characters and no more than 128 bytes. Prefix "sys-" is reserved for Dialogflow defined labels. Currently allowed Dialogflow defined labels include: * sys-head * sys-contextual The above labels do not require value. "sys-head" means the intent is a head intent. "sys-contextual" means the intent is a contextual intent.
+                    "a_key": "A String",
+                  },
+                  "name": "A String", # The unique identifier of the intent. Required for the Intents.UpdateIntent method. Intents.CreateIntent populates the name automatically. Format: `projects//locations//agents//intents/`.
+                  "parameters": [ # The collection of parameters associated with the intent.
+                    { # Represents an intent parameter.
+                      "entityType": "A String", # Required. The entity type of the parameter. Format: `projects/-/locations/-/agents/-/entityTypes/` for system entity types (for example, `projects/-/locations/-/agents/-/entityTypes/sys.date`), or `projects//locations//agents//entityTypes/` for developer entity types.
+                      "id": "A String", # Required. The unique identifier of the parameter. This field is used by training phrases to annotate their parts.
+                      "isList": True or False, # Indicates whether the parameter represents a list of values.
+                      "redact": True or False, # Indicates whether the parameter content should be redacted in log. If redaction is enabled, the parameter content will be replaced by parameter name during logging. Note: the parameter content is subject to redaction if either parameter level redaction or entity type level redaction is enabled.
+                    },
+                  ],
+                  "priority": 42, # 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.
+                  "trainingPhrases": [ # The collection of training phrases the agent is trained on to identify the intent.
+                    { # Represents an example that the agent is trained on to identify the intent.
+                      "id": "A String", # Output only. The unique identifier of the training phrase.
+                      "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 `parameter_id` field is set.
+                        { # Represents a part of a training phrase.
+                          "parameterId": "A String", # The parameter used to annotate this part of the training phrase. This field is required for annotated parts of the training phrase.
+                          "text": "A String", # Required. The text for this part.
+                        },
+                      ],
+                      "repeatCount": 42, # Indicates how many times this example was added to the intent.
+                    },
+                  ],
+                },
+                "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. This field is deprecated, please use QueryResult.match instead.
+                "languageCode": "A String", # The language that was triggered during intent detection. See [Language Support](https://cloud.google.com/dialogflow/cx/docs/reference/language) for a list of the currently supported language codes.
+                "match": { # Represents one match result of MatchIntent. # Intent match result, could be an intent or an event.
+                  "confidence": 3.14, # The confidence of this match. 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.
+                  "event": "A String", # The event that matched the query. Filled for `EVENT`, `NO_MATCH` and `NO_INPUT` match types.
+                  "intent": { # An intent represents a user's intent to interact with a conversational agent. You can provide information for the Dialogflow API to use to match user input to an intent by adding training phrases (i.e., examples of user input) to your intent. # The Intent that matched the query. Some, not all fields are filled in this message, including but not limited to: `name` and `display_name`. Only filled for `INTENT` match type.
+                    "description": "A String", # Human readable description for better understanding an intent like its scope, content, result etc. Maximum character limit: 140 characters.
+                    "displayName": "A String", # Required. The human-readable name of the intent, unique within the agent.
+                    "isFallback": True or False, # Indicates whether this is a fallback intent. Currently only default fallback intent is allowed in the agent, which is added upon agent creation. Adding training phrases to fallback intent is useful in the case of requests that are mistakenly matched, since training phrases assigned to fallback intents act as negative examples that triggers no-match event.
+                    "labels": { # The key/value metadata to label an intent. Labels can contain lowercase letters, digits and the symbols '-' and '_'. International characters are allowed, including letters from unicase alphabets. Keys must start with a letter. Keys and values can be no longer than 63 characters and no more than 128 bytes. Prefix "sys-" is reserved for Dialogflow defined labels. Currently allowed Dialogflow defined labels include: * sys-head * sys-contextual The above labels do not require value. "sys-head" means the intent is a head intent. "sys-contextual" means the intent is a contextual intent.
+                      "a_key": "A String",
+                    },
+                    "name": "A String", # The unique identifier of the intent. Required for the Intents.UpdateIntent method. Intents.CreateIntent populates the name automatically. Format: `projects//locations//agents//intents/`.
+                    "parameters": [ # The collection of parameters associated with the intent.
+                      { # Represents an intent parameter.
+                        "entityType": "A String", # Required. The entity type of the parameter. Format: `projects/-/locations/-/agents/-/entityTypes/` for system entity types (for example, `projects/-/locations/-/agents/-/entityTypes/sys.date`), or `projects//locations//agents//entityTypes/` for developer entity types.
+                        "id": "A String", # Required. The unique identifier of the parameter. This field is used by training phrases to annotate their parts.
+                        "isList": True or False, # Indicates whether the parameter represents a list of values.
+                        "redact": True or False, # Indicates whether the parameter content should be redacted in log. If redaction is enabled, the parameter content will be replaced by parameter name during logging. Note: the parameter content is subject to redaction if either parameter level redaction or entity type level redaction is enabled.
+                      },
+                    ],
+                    "priority": 42, # 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.
+                    "trainingPhrases": [ # The collection of training phrases the agent is trained on to identify the intent.
+                      { # Represents an example that the agent is trained on to identify the intent.
+                        "id": "A String", # Output only. The unique identifier of the training phrase.
+                        "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 `parameter_id` field is set.
+                          { # Represents a part of a training phrase.
+                            "parameterId": "A String", # The parameter used to annotate this part of the training phrase. This field is required for annotated parts of the training phrase.
+                            "text": "A String", # Required. The text for this part.
+                          },
+                        ],
+                        "repeatCount": 42, # Indicates how many times this example was added to the intent.
+                      },
+                    ],
+                  },
+                  "matchType": "A String", # Type of this Match.
+                  "parameters": { # The collection of parameters extracted from the query. 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 then use map, otherwise, depending on the parameter value type, it could be one of string, number, boolean, null, list or map. * MapValue value: If parameter's entity type is a composite entity then use map from composite entity property names to property values, otherwise, use parameter value.
+                    "a_key": "", # Properties of the object.
+                  },
+                  "resolvedInput": "A String", # Final text input which was matched during MatchIntent. This value can be different from original input sent in request because of spelling correction or other processing.
+                },
+                "parameters": { # The collected session 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 then use map, otherwise, depending on the parameter value type, it could be one of string, number, boolean, null, list or map. * MapValue value: If parameter's entity type is a composite entity then use map from composite entity property names to property values, otherwise, use parameter value.
+                  "a_key": "", # Properties of the object.
+                },
+                "responseMessages": [ # The list of rich messages returned to the client. Responses vary from simple text messages to more sophisticated, structured payloads used to drive complex logic.
+                  { # 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.
+                    "channel": "A String", # The channel which the response is associated with. Clients can specify the channel via QueryParameters.channel, and only associated channel response will be returned.
+                    "conversationSuccess": { # 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. # Indicates that the conversation succeeded.
+                      "metadata": { # Custom metadata. Dialogflow doesn't impose any structure on this.
+                        "a_key": "", # Properties of the object.
+                      },
+                    },
+                    "endInteraction": { # 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. # Output only. A signal that indicates the interaction with the Dialogflow agent has ended. This message is generated by Dialogflow only when the conversation reaches `END_SESSION` page. It is not supposed to be defined by the user. It's guaranteed that there is at most one such message in each response.
+                    },
+                    "knowledgeInfoCard": { # Represents info card response. If the response contains generative knowledge prediction, Dialogflow will return a payload with Infobot Messenger compatible info card. Otherwise, the info card response is skipped. # Represents info card for knowledge answers, to be better rendered in Dialogflow Messenger.
+                    },
+                    "liveAgentHandoff": { # 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. # Hands off conversation to a human agent.
+                      "metadata": { # Custom metadata for your handoff procedure. Dialogflow doesn't impose any structure on this.
+                        "a_key": "", # Properties of the object.
+                      },
+                    },
+                    "mixedAudio": { # 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. # Output only. An audio response message composed of both the synthesized Dialogflow agent responses and responses defined via play_audio. This message is generated by Dialogflow only and not supposed to be defined by the user.
+                      "segments": [ # Segments this audio response is composed of.
+                        { # Represents one segment of audio.
+                          "allowPlaybackInterruption": True or False, # 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.
+                          "audio": "A String", # Raw audio synthesized from the Dialogflow agent's response using the output config specified in the request.
+                          "uri": "A String", # Client-specific URI that points to an audio clip accessible to the client. Dialogflow does not impose any validation on it.
+                        },
+                      ],
+                    },
+                    "outputAudioText": { # A text or ssml response that is preferentially used for TTS output audio synthesis, as described in the comment on the ResponseMessage message. # A text or ssml response that is preferentially used for TTS output audio synthesis, as described in the comment on the ResponseMessage message.
+                      "allowPlaybackInterruption": True or False, # 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.
+                      "ssml": "A String", # The SSML text to be synthesized. For more information, see [SSML](/speech/text-to-speech/docs/ssml).
+                      "text": "A String", # The raw text to be synthesized.
+                    },
+                    "payload": { # Returns a response containing a custom, platform-specific payload.
+                      "a_key": "", # Properties of the object.
+                    },
+                    "playAudio": { # Specifies an audio clip to be played by the client as part of the response. # Signal that the client should play an audio clip hosted at a client-specific URI. Dialogflow uses this to construct mixed_audio. However, Dialogflow itself does not try to read or process the URI in any way.
+                      "allowPlaybackInterruption": True or False, # 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.
+                      "audioUri": "A String", # Required. URI of the audio clip. Dialogflow does not impose any validation on this value. It is specific to the client that reads it.
+                    },
+                    "telephonyTransferCall": { # Represents the signal that telles the client to transfer the phone call connected to the agent to a third-party endpoint. # A signal that the client should transfer the phone call connected to this agent to a third-party endpoint.
+                      "phoneNumber": "A String", # Transfer the call to a phone number in [E.164 format](https://en.wikipedia.org/wiki/E.164).
+                    },
+                    "text": { # The text response message. # Returns a text response.
+                      "allowPlaybackInterruption": True or False, # 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.
+                      "text": [ # Required. A collection of text responses.
+                        "A String",
+                      ],
+                    },
+                    "toolCall": { # Represents a call of a specific tool's action with the specified inputs. # Returns the definition of a tool call that should be executed by the client.
+                      "action": "A String", # Required. The name of the tool's action associated with this call.
+                      "inputParameters": { # Optional. The action's input parameters.
+                        "a_key": "", # Properties of the object.
+                      },
+                      "tool": "A String", # Required. The tool associated with this call. Format: `projects//locations//agents//tools/`.
+                    },
+                  },
+                ],
+                "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. # The sentiment analyss result, which depends on `analyze_query_text_sentiment`, specified in the request.
+                  "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).
+                  "score": 3.14, # Sentiment score between -1.0 (negative sentiment) and 1.0 (positive sentiment).
+                },
+                "text": "A String", # If natural language text was provided as input, this field will contain a copy of the text.
+                "transcript": "A String", # If natural language speech audio was provided as input, this field will contain the transcript for the audio.
+                "triggerEvent": "A String", # If an event was provided as input, this field will contain the name of the event.
+                "triggerIntent": "A String", # If an intent was provided as input, this field will contain a copy of the intent identifier. Format: `projects//locations//agents//intents/`.
+                "webhookDisplayNames": [ # The list of webhook display names in the order of call sequence.
+                  "A String",
+                ],
+                "webhookIds": [ # The list of webhook ids in the order of call sequence.
+                  "A String",
+                ],
+                "webhookLatencies": [ # The list of webhook latencies in the order of call sequence.
+                  "A String",
+                ],
+                "webhookPayloads": [ # The list of webhook payload in WebhookResponse.payload, in the order of call sequence. If some webhook call fails or doesn't return any payload, an empty `Struct` would be used instead.
+                  {
+                    "a_key": "", # Properties of the object.
+                  },
+                ],
+                "webhookStatuses": [ # The list of webhook call status in the order of call sequence.
+                  { # 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).
+                    "code": 42, # The status code, which should be an enum value of google.rpc.Code.
+                    "details": [ # A list of messages that carry the error details. There is a common set of message types for APIs to use.
+                      {
+                        "a_key": "", # Properties of the object. Contains field @type with type URL.
+                      },
+                    ],
+                    "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.
+                  },
+                ],
+                "webhookTags": [ # The list of webhook tags in the order of call sequence.
+                  "A String",
+                ],
+              },
+              "responseId": "A String", # Output only. The unique identifier of the response. It can be used to locate a response in the training example set or for reporting issues.
+              "responseType": "A String", # Response type.
+            },
+          ],
+          "request": { # The request to detect user's intent. # The request of the interaction.
+            "outputAudioConfig": { # Instructs the speech synthesizer how to generate the output audio content. # Instructs the speech synthesizer how to generate the output audio.
+              "audioEncoding": "A String", # Required. Audio encoding of the synthesized audio content.
+              "sampleRateHertz": 42, # Optional. 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).
+              "synthesizeSpeechConfig": { # Configuration of how speech should be synthesized. # Optional. Configuration of how speech should be synthesized. If not specified, Agent.text_to_speech_settings is applied.
+                "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.
+                  "A String",
+                ],
+                "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.
+                "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.
+                "voice": { # Description of which voice to use for speech synthesis. # Optional. The desired voice of the synthesized audio.
+                  "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. For the list of available voices, please refer to [Supported voices and languages](https://cloud.google.com/text-to-speech/docs/voices).
+                  "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.
+                },
+                "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.
+              },
+            },
+            "queryInput": { # Represents the query input. It can contain one of: 1. A conversational query in the form of text. 2. An intent query that specifies which intent to trigger. 3. Natural language speech audio to be processed. 4. An event to be triggered. 5. DTMF digits to invoke an intent and fill in parameter value. 6. The results of a tool executed by the client. # Required. The input specification.
+              "audio": { # Represents the natural speech audio to be processed. # The natural language speech audio to be processed.
+                "audio": "A String", # The natural language speech audio to be processed. A single request can contain up to 2 minutes of speech audio data. The transcribed text cannot contain more than 256 bytes. For non-streaming audio detect intent, both `config` and `audio` must be provided. For streaming audio detect intent, `config` must be provided in the first request and `audio` must be provided in all following requests.
+                "config": { # Instructs the speech recognizer on how to process the audio content. # Required. Instructs the speech recognizer how to process the speech audio.
+                  "audioEncoding": "A String", # Required. Audio encoding of the audio content to process.
+                  "bargeInConfig": { # Configuration of the barge-in behavior. Barge-in instructs the API to return a detected utterance at a proper time while the client is playing back the response audio from a previous request. When the client sees the utterance, it should stop the playback and immediately get ready for receiving the responses for the current request. The barge-in handling requires the client to start streaming audio input as soon as it starts playing back the audio from the previous response. The playback is modeled into two phases: * No barge-in phase: which goes first and during which speech detection should not be carried out. * Barge-in phase: which follows the no barge-in phase and during which the API starts speech detection and may inform the client that an utterance has been detected. Note that no-speech event is not expected in this phase. The client provides this configuration in terms of the durations of those two phases. The durations are measured in terms of the audio length from the the start of the input audio. No-speech event is a response with END_OF_UTTERANCE without any transcript following up. # Configuration of barge-in behavior during the streaming of input audio.
+                    "noBargeInDuration": "A String", # Duration that is not eligible for barge-in at the beginning of the input audio.
+                    "totalDuration": "A String", # Total duration for the playback at the beginning of the input audio.
+                  },
+                  "enableWordInfo": True or False, # Optional. If `true`, Dialogflow returns SpeechWordInfo in StreamingRecognitionResult with information about the recognized speech words, e.g. start and end time offsets. If false or unspecified, Speech doesn't return any word-level information.
+                  "model": "A String", # Optional. Which Speech model to select for the given request. For more information, see [Speech models](https://cloud.google.com/dialogflow/cx/docs/concept/speech-models).
+                  "modelVariant": "A String", # Optional. Which variant of the Speech model to use.
+                  "optOutConformerModelMigration": True or False, # If `true`, the request will opt out for STT conformer model migration. This field will be deprecated once force migration takes place in June 2024. Please refer to [Dialogflow CX Speech model migration](https://cloud.google.com/dialogflow/cx/docs/concept/speech-model-migration).
+                  "phraseHints": [ # Optional. A list of strings containing words and phrases that the speech recognizer should recognize with higher likelihood. See [the Cloud Speech documentation](https://cloud.google.com/speech-to-text/docs/basics#phrase-hints) for more details.
+                    "A String",
+                  ],
+                  "sampleRateHertz": 42, # Sample rate (in Hertz) of the audio content sent in the query. Refer to [Cloud Speech API documentation](https://cloud.google.com/speech-to-text/docs/basics) for more details.
+                  "singleUtterance": True or False, # Optional. If `false` (default), recognition does not cease until the client closes the stream. If `true`, the recognizer will detect a single spoken utterance in input audio. Recognition ceases when it detects the audio's voice has stopped or paused. In this case, once a detected intent is received, the client should close the stream and start a new request with a new stream as needed. Note: This setting is relevant only for streaming methods.
+                },
+              },
+              "dtmf": { # Represents the input for dtmf event. # The DTMF event to be handled.
+                "digits": "A String", # The dtmf digits.
+                "finishDigit": "A String", # The finish digit (if any).
+              },
+              "event": { # Represents the event to trigger. # The event to be triggered.
+                "event": "A String", # Name of the event.
+              },
+              "intent": { # Represents the intent to trigger programmatically rather than as a result of natural language processing. # The intent to be triggered.
+                "intent": "A String", # Required. The unique identifier of the intent. Format: `projects//locations//agents//intents/`.
+              },
+              "languageCode": "A String", # Required. The language of the input. See [Language Support](https://cloud.google.com/dialogflow/cx/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.
+              "text": { # Represents the natural language text to be processed. # The natural language text to be processed.
+                "text": "A String", # Required. The UTF-8 encoded natural language text to be processed.
+              },
+              "toolCallResult": { # The result of calling a tool's action that has been executed by the client. # The results of a tool executed by the client.
+                "action": "A String", # Required. The name of the tool's action associated with this call.
+                "error": { # An error produced by the tool call. # The tool call's error.
+                  "message": "A String", # Optional. The error message of the function.
+                },
+                "outputParameters": { # The tool call's output parameters.
+                  "a_key": "", # Properties of the object.
+                },
+                "tool": "A String", # Required. The tool associated with this call. Format: `projects//locations//agents//tools/`.
+              },
+            },
+            "queryParams": { # Represents the parameters of a conversational query. # The parameters of this query.
+              "analyzeQueryTextSentiment": True or False, # Configures whether sentiment analysis should be performed. If not provided, sentiment analysis is not performed.
+              "channel": "A String", # The channel which this query is for. If specified, only the ResponseMessage associated with the channel will be returned. If no ResponseMessage is associated with the channel, it falls back to the ResponseMessage with unspecified channel. If unspecified, the ResponseMessage with unspecified channel will be returned.
+              "currentPage": "A String", # The unique identifier of the page to override the current page in the session. Format: `projects//locations//agents//flows//pages/`. If `current_page` is specified, the previous state of the session will be ignored by Dialogflow, including the previous page and the previous session parameters. In most cases, current_page and parameters should be configured together to direct a session to a specific state.
+              "currentPlaybook": "A String", # Optional. Start the session with the specified playbook. You can only specify the playbook at the beginning of the session. Otherwise, an error will be thrown. Format: `projects//locations//agents//playbooks/`.
+              "disableWebhook": True or False, # Whether to disable webhook calls for this request.
+              "endUserMetadata": { # Optional. Information about the end-user to improve the relevance and accuracy of generative answers. This will be interpreted and used by a language model, so, for good results, the data should be self-descriptive, and in a simple structure. Example: ```json { "subscription plan": "Business Premium Plus", "devices owned": [ {"model": "Google Pixel 7"}, {"model": "Google Pixel Tablet"} ] } ```
+                "a_key": "", # Properties of the object.
+              },
+              "flowVersions": [ # A list of flow versions to override for the request. Format: `projects//locations//agents//flows//versions/`. If version 1 of flow X is included in this list, the traffic of flow X will go through version 1 regardless of the version configuration in the environment. Each flow can have at most one version specified in this list.
+                "A String",
+              ],
+              "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.
+                "latitude": 3.14, # The latitude in degrees. It must be in the range [-90.0, +90.0].
+                "longitude": 3.14, # The longitude in degrees. It must be in the range [-180.0, +180.0].
+              },
+              "llmModelSettings": { # Settings for LLM models. # Optional. Use the specified LLM model settings for processing the request.
+                "model": "A String", # The selected LLM model.
+                "promptText": "A String", # The custom prompt to use.
+              },
+              "parameters": { # Additional parameters to be put into session parameters. To remove a parameter from the session, clients should explicitly set the parameter value to null. You can reference the session parameters in the agent with the following format: $session.params.parameter-id. 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 then use map, otherwise, depending on the parameter value type, it could be one of string, number, boolean, null, list or map. * MapValue value: If parameter's entity type is a composite entity then use map from composite entity property names to property values, otherwise, use parameter value.
+                "a_key": "", # Properties of the object.
+              },
+              "payload": { # This field can be used to pass custom data into the webhook associated with the agent. Arbitrary JSON objects are supported. Some integrations that query a Dialogflow agent may provide additional information in the payload. In particular, for the Dialogflow Phone Gateway integration, this field has the form: ``` { "telephony": { "caller_id": "+18558363987" } } ```
+                "a_key": "", # Properties of the object.
+              },
+              "populateDataStoreConnectionSignals": True or False, # Optional. If set to true and data stores are involved in serving the request then DetectIntentResponse.query_result.data_store_connection_signals will be filled with data that can help evaluations.
+              "searchConfig": { # Search configuration for UCS search queries. # Optional. Search configuration for UCS search queries.
+                "boostSpecs": [ # Optional. Boosting configuration for the datastores.
+                  { # Boost specifications for data stores.
+                    "dataStores": [ # Optional. Data Stores where the boosting configuration is applied. The full names of the referenced data stores. Formats: `projects/{project}/locations/{location}/collections/{collection}/dataStores/{data_store}` `projects/{project}/locations/{location}/dataStores/{data_store}
+                      "A String",
+                    ],
+                    "spec": [ # Optional. A list of boosting specifications.
+                      { # Boost specification to boost certain documents. A copy of google.cloud.discoveryengine.v1main.BoostSpec, field documentation is available at https://cloud.google.com/generative-ai-app-builder/docs/reference/rest/v1alpha/BoostSpec
+                        "conditionBoostSpecs": [ # Optional. Condition boost specifications. If a document matches multiple conditions in the specifictions, boost scores from these specifications are all applied and combined in a non-linear way. Maximum number of specifications is 20.
+                          { # Boost applies to documents which match a condition.
+                            "boost": 3.14, # Optional. Strength of the condition boost, which should be in [-1, 1]. Negative boost means demotion. Default is 0.0. Setting to 1.0 gives the document a big promotion. However, it does not necessarily mean that the boosted document will be the top result at all times, nor that other documents will be excluded. Results could still be shown even when none of them matches the condition. And results that are significantly more relevant to the search query can still trump your heavily favored but irrelevant documents. Setting to -1.0 gives the document a big demotion. However, results that are deeply relevant might still be shown. The document will have an upstream battle to get a fairly high ranking, but it is not blocked out completely. Setting to 0.0 means no boost applied. The boosting condition is ignored.
+                            "condition": "A String", # Optional. An expression which specifies a boost condition. The syntax and supported fields are the same as a filter expression. Examples: * To boost documents with document ID "doc_1" or "doc_2", and color "Red" or "Blue": * (id: ANY("doc_1", "doc_2")) AND (color: ANY("Red","Blue"))
+                          },
+                        ],
+                      },
+                    ],
+                  },
+                ],
+                "filterSpecs": [ # Optional. Filter configuration for the datastores.
+                  { # Filter specifications for data stores.
+                    "dataStores": [ # Optional. Data Stores where the boosting configuration is applied. The full names of the referenced data stores. Formats: `projects/{project}/locations/{location}/collections/{collection}/dataStores/{data_store}` `projects/{project}/locations/{location}/dataStores/{data_store}
+                      "A String",
+                    ],
+                    "filter": "A String", # Optional. The filter expression to be applied. Expression syntax is documented at https://cloud.google.com/generative-ai-app-builder/docs/filter-search-metadata#filter-expression-syntax
+                  },
+                ],
+              },
+              "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.
+                { # Session entity types are referred to as **User** entity types and are entities that are built for an individual user such as favorites, preferences, playlists, and so on. You can redefine a session entity type at the session level to extend or replace a custom entity type at the user session level (we refer to the entity types defined at the agent level as "custom entity types"). Note: session entity types apply to all queries, regardless of the language. For more information about entity types, see the [Dialogflow documentation](https://cloud.google.com/dialogflow/docs/entities-overview).
+                  "entities": [ # Required. The collection of entities to override or supplement the custom entity type.
+                    { # An **entity entry** for an associated entity type.
+                      "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`.
+                        "A String",
+                      ],
+                      "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 canonical 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).
+                    },
+                  ],
+                  "entityOverrideMode": "A String", # Required. Indicates whether the additional data should override or supplement the custom entity type definition.
+                  "name": "A String", # Required. The unique identifier of the session entity type. Format: `projects//locations//agents//sessions//entityTypes/` or `projects//locations//agents//environments//sessions//entityTypes/`. If `Environment ID` is not specified, we assume default 'draft' environment.
+                },
+              ],
+              "sessionTtl": "A String", # Optional. Configure lifetime of the Dialogflow session. By default, a Dialogflow session remains active and its data is stored for 30 minutes after the last request is sent for the session. This value should be no longer than 1 day.
+              "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 the agent is used.
+              "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 Dialogflow web console. The headers defined within this field will overwrite the headers configured through 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.
+                "a_key": "A String",
+              },
+            },
+            "session": "A String", # Required. The name of the session this query is sent to. Format: `projects//locations//agents//sessions/` or `projects//locations//agents//environments//sessions/`. If `Environment ID` is not specified, we assume default 'draft' environment. It's up to the API caller to choose an appropriate `Session ID`. It can be a random number or some type of session identifiers (preferably hashed). The length of the `Session ID` must not exceed 36 characters. For more information, see the [sessions guide](https://cloud.google.com/dialogflow/cx/docs/concept/session). Note: Always use agent versions for production traffic. See [Versions and environments](https://cloud.google.com/dialogflow/cx/docs/concept/version).
+          },
+          "requestUtterances": "A String", # The input text or the transcript of the input audio in the request.
+          "response": { # The message returned from the DetectIntent method. # The final response of the interaction.
+            "allowCancellation": True or False, # Indicates whether the partial response can be cancelled when a later response arrives. e.g. if the agent specified some music as partial response, it can be cancelled.
+            "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.response_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.
+            "outputAudioConfig": { # Instructs the speech synthesizer how to generate the output audio content. # The config used by the speech synthesizer to generate the output audio.
+              "audioEncoding": "A String", # Required. Audio encoding of the synthesized audio content.
+              "sampleRateHertz": 42, # Optional. 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).
+              "synthesizeSpeechConfig": { # Configuration of how speech should be synthesized. # Optional. Configuration of how speech should be synthesized. If not specified, Agent.text_to_speech_settings is applied.
+                "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.
+                  "A String",
+                ],
+                "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.
+                "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.
+                "voice": { # Description of which voice to use for speech synthesis. # Optional. The desired voice of the synthesized audio.
+                  "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. For the list of available voices, please refer to [Supported voices and languages](https://cloud.google.com/text-to-speech/docs/voices).
+                  "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.
+                },
+                "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.
+              },
+            },
+            "queryResult": { # Represents the result of a conversational query. # The result of the conversational query.
+              "advancedSettings": { # Hierarchical advanced settings for agent/flow/page/fulfillment/parameter. Settings exposed at lower level overrides the settings exposed at higher level. Overriding occurs at the sub-setting level. For example, the playback_interruption_settings at fulfillment level only overrides the playback_interruption_settings at the agent level, leaving other settings at the agent level unchanged. DTMF settings does not override each other. DTMF settings set at different levels define DTMF detections running in parallel. Hierarchy: Agent->Flow->Page->Fulfillment/Parameter. # Returns the current advanced settings including IVR settings. Even though the operations configured by these settings are performed by Dialogflow, the client may need to perform special logic at the moment. For example, if Dialogflow exports audio to Google Cloud Storage, then the client may need to wait for the resulting object to appear in the bucket before proceeding.
+                "audioExportGcsDestination": { # Google Cloud Storage location for a Dialogflow operation that writes or exports objects (e.g. exported agent or transcripts) outside of Dialogflow. # If present, incoming audio is exported by Dialogflow to the configured Google Cloud Storage destination. Exposed at the following levels: - Agent level - Flow level
+                  "uri": "A String", # Required. The Google Cloud Storage URI for the exported objects. A URI is of the form: `gs://bucket/object-name-or-prefix` Whether a full object name, or just a prefix, its usage depends on the Dialogflow operation.
+                },
+                "dtmfSettings": { # Define behaviors for DTMF (dual tone multi frequency). # Settings for DTMF. Exposed at the following levels: - Agent level - Flow level - Page level - Parameter level.
+                  "enabled": True or False, # If true, incoming audio is processed for DTMF (dual tone multi frequency) events. For example, if the caller presses a button on their telephone keypad and DTMF processing is enabled, Dialogflow will detect the event (e.g. a "3" was pressed) in the incoming audio and pass the event to the bot to drive business logic (e.g. when 3 is pressed, return the account balance).
+                  "endpointingTimeoutDuration": "A String", # Endpoint timeout setting for matching dtmf input to regex.
+                  "finishDigit": "A String", # The digit that terminates a DTMF digit sequence.
+                  "interdigitTimeoutDuration": "A String", # Interdigit timeout setting for matching dtmf input to regex.
+                  "maxDigits": 42, # Max length of DTMF digits.
+                },
+                "loggingSettings": { # Define behaviors on logging. # Settings for logging. Settings for Dialogflow History, Contact Center messages, StackDriver logs, and speech logging. Exposed at the following levels: - Agent level.
+                  "enableInteractionLogging": True or False, # Enables DF Interaction logging.
+                  "enableStackdriverLogging": True or False, # Enables StackDriver logging.
+                },
+                "speechSettings": { # Define behaviors of speech to text detection. # Settings for speech to text detection. Exposed at the following levels: - Agent level - Flow level - Page level - Parameter level
+                  "endpointerSensitivity": 42, # Sensitivity of the speech model that detects the end of speech. Scale from 0 to 100.
+                  "models": { # Mapping from language to Speech-to-Text model. The mapped Speech-to-Text model will be selected for requests from its corresponding language. For more information, see [Speech models](https://cloud.google.com/dialogflow/cx/docs/concept/speech-models).
+                    "a_key": "A String",
                   },
-                  "knowledgeConnectorSettings": { # The Knowledge Connector settings for this page or flow. This includes information such as the attached Knowledge Bases, and the way to execute fulfillment. # Optional. Knowledge connector configuration.
-                    "dataStoreConnections": [ # Optional. List of related data store connections.
-                      { # A data store connection. It represents a data store in Discovery Engine and the type of the contents it contains.
-                        "dataStore": "A String", # The full name of the referenced data store. Formats: `projects/{project}/locations/{location}/collections/{collection}/dataStores/{data_store}` `projects/{project}/locations/{location}/dataStores/{data_store}`
-                        "dataStoreType": "A String", # The type of the connected data store.
-                      },
-                    ],
-                    "enabled": True or False, # Whether Knowledge Connector is enabled or not.
+                  "noSpeechTimeout": "A String", # Timeout before detecting no speech.
+                  "useTimeoutBasedEndpointing": True or False, # Use timeout based endpointing, interpreting endpointer sensitivy as seconds of timeout value.
+                },
+              },
+              "allowAnswerFeedback": True or False, # Indicates whether the Thumbs up/Thumbs down rating controls are need to be shown for the response in the Dialogflow Messenger widget.
+              "currentFlow": { # Flows represents the conversation flows when you build your chatbot agent. A flow consists of many pages connected by the transition routes. Conversations always start with the built-in Start Flow (with an all-0 ID). Transition routes can direct the conversation session from the current flow (parent flow) to another flow (sub flow). When the sub flow is finished, Dialogflow will bring the session back to the parent flow, where the sub flow is started. Usually, when a transition route is followed by a matched intent, the intent will be "consumed". This means the intent won't activate more transition routes. However, when the followed transition route moves the conversation session into a different flow, the matched intent can be carried over and to be consumed in the target flow. # The current Flow. Some, not all fields are filled in this message, including but not limited to `name` and `display_name`.
+                "advancedSettings": { # Hierarchical advanced settings for agent/flow/page/fulfillment/parameter. Settings exposed at lower level overrides the settings exposed at higher level. Overriding occurs at the sub-setting level. For example, the playback_interruption_settings at fulfillment level only overrides the playback_interruption_settings at the agent level, leaving other settings at the agent level unchanged. DTMF settings does not override each other. DTMF settings set at different levels define DTMF detections running in parallel. Hierarchy: Agent->Flow->Page->Fulfillment/Parameter. # Hierarchical advanced settings for this flow. The settings exposed at the lower level overrides the settings exposed at the higher level.
+                  "audioExportGcsDestination": { # Google Cloud Storage location for a Dialogflow operation that writes or exports objects (e.g. exported agent or transcripts) outside of Dialogflow. # If present, incoming audio is exported by Dialogflow to the configured Google Cloud Storage destination. Exposed at the following levels: - Agent level - Flow level
+                    "uri": "A String", # Required. The Google Cloud Storage URI for the exported objects. A URI is of the form: `gs://bucket/object-name-or-prefix` Whether a full object name, or just a prefix, its usage depends on the Dialogflow operation.
+                  },
+                  "dtmfSettings": { # Define behaviors for DTMF (dual tone multi frequency). # Settings for DTMF. Exposed at the following levels: - Agent level - Flow level - Page level - Parameter level.
+                    "enabled": True or False, # If true, incoming audio is processed for DTMF (dual tone multi frequency) events. For example, if the caller presses a button on their telephone keypad and DTMF processing is enabled, Dialogflow will detect the event (e.g. a "3" was pressed) in the incoming audio and pass the event to the bot to drive business logic (e.g. when 3 is pressed, return the account balance).
+                    "endpointingTimeoutDuration": "A String", # Endpoint timeout setting for matching dtmf input to regex.
+                    "finishDigit": "A String", # The digit that terminates a DTMF digit sequence.
+                    "interdigitTimeoutDuration": "A String", # Interdigit timeout setting for matching dtmf input to regex.
+                    "maxDigits": 42, # Max length of DTMF digits.
+                  },
+                  "loggingSettings": { # Define behaviors on logging. # Settings for logging. Settings for Dialogflow History, Contact Center messages, StackDriver logs, and speech logging. Exposed at the following levels: - Agent level.
+                    "enableInteractionLogging": True or False, # Enables DF Interaction logging.
+                    "enableStackdriverLogging": True or False, # Enables StackDriver logging.
+                  },
+                  "speechSettings": { # Define behaviors of speech to text detection. # Settings for speech to text detection. Exposed at the following levels: - Agent level - Flow level - Page level - Parameter level
+                    "endpointerSensitivity": 42, # Sensitivity of the speech model that detects the end of speech. Scale from 0 to 100.
+                    "models": { # Mapping from language to Speech-to-Text model. The mapped Speech-to-Text model will be selected for requests from its corresponding language. For more information, see [Speech models](https://cloud.google.com/dialogflow/cx/docs/concept/speech-models).
+                      "a_key": "A String",
+                    },
+                    "noSpeechTimeout": "A String", # Timeout before detecting no speech.
+                    "useTimeoutBasedEndpointing": True or False, # Use timeout based endpointing, interpreting endpointer sensitivy as seconds of timeout value.
+                  },
+                },
+                "description": "A String", # The description of the flow. The maximum length is 500 characters. If exceeded, the request is rejected.
+                "displayName": "A String", # Required. The human-readable name of the flow.
+                "eventHandlers": [ # A flow's event handlers serve two purposes: * They are responsible for handling events (e.g. no match, webhook errors) in the flow. * They are inherited by every page's event handlers, which can be used to handle common events regardless of the current page. Event handlers defined in the page have higher priority than those defined in the flow. Unlike transition_routes, these handlers are evaluated on a first-match basis. The first one that matches the event get executed, with the rest being ignored.
+                  { # An event handler specifies an event that can be handled during a session. When the specified event happens, the following actions are taken in order: * If there is a `trigger_fulfillment` associated with the event, it will be called. * If there is a `target_page` associated with the event, the session will transition into the specified page. * If there is a `target_flow` associated with the event, the session will transition into the specified flow.
+                    "event": "A String", # Required. The name of the event to handle.
+                    "name": "A String", # Output only. The unique identifier of this event handler.
                     "targetFlow": "A String", # The target flow to transition to. Format: `projects//locations//agents//flows/`.
                     "targetPage": "A String", # The target page to transition to. Format: `projects//locations//agents//flows//pages/`.
-                    "triggerFulfillment": { # A fulfillment can do one or more of the following actions at the same time: * Generate rich message responses. * Set parameter values. * Call the webhook. Fulfillments can be called at various stages in the Page or Form lifecycle. For example, when a DetectIntentRequest drives a session to enter a new page, the page's entry fulfillment can add a static response to the QueryResult in the returning DetectIntentResponse, call the webhook (for example, to load user data from a database), or both. # The fulfillment to be triggered. When the answers from the Knowledge Connector are selected by Dialogflow, you can utitlize the request scoped parameter `$request.knowledge.answers` (contains up to the 5 highest confidence answers) and `$request.knowledge.questions` (contains the corresponding questions) to construct the fulfillment.
+                    "triggerFulfillment": { # A fulfillment can do one or more of the following actions at the same time: * Generate rich message responses. * Set parameter values. * Call the webhook. Fulfillments can be called at various stages in the Page or Form lifecycle. For example, when a DetectIntentRequest drives a session to enter a new page, the page's entry fulfillment can add a static response to the QueryResult in the returning DetectIntentResponse, call the webhook (for example, to load user data from a database), or both. # The fulfillment to call when the event occurs. Handling webhook errors with a fulfillment enabled with webhook could cause infinite loop. It is invalid to specify such fulfillment for a handler handling webhooks.
                       "advancedSettings": { # Hierarchical advanced settings for agent/flow/page/fulfillment/parameter. Settings exposed at lower level overrides the settings exposed at higher level. Overriding occurs at the sub-setting level. For example, the playback_interruption_settings at fulfillment level only overrides the playback_interruption_settings at the agent level, leaving other settings at the agent level unchanged. DTMF settings does not override each other. DTMF settings set at different levels define DTMF detections running in parallel. Hierarchy: Agent->Flow->Page->Fulfillment/Parameter. # Hierarchical advanced settings for this fulfillment. The settings exposed at the lower level overrides the settings exposed at the higher level.
                         "audioExportGcsDestination": { # Google Cloud Storage location for a Dialogflow operation that writes or exports objects (e.g. exported agent or transcripts) outside of Dialogflow. # If present, incoming audio is exported by Dialogflow to the configured Google Cloud Storage destination. Exposed at the following levels: - Agent level - Flow level
                           "uri": "A String", # Required. The Google Cloud Storage URI for the exported objects. A URI is of the form: `gs://bucket/object-name-or-prefix` Whether a full object name, or just a prefix, its usage depends on the Dialogflow operation.
@@ -5792,8 +8865,8 @@ 

Method Details

"maxDigits": 42, # Max length of DTMF digits. }, "loggingSettings": { # Define behaviors on logging. # Settings for logging. Settings for Dialogflow History, Contact Center messages, StackDriver logs, and speech logging. Exposed at the following levels: - Agent level. - "enableInteractionLogging": True or False, # If true, DF Interaction logging is currently enabled. - "enableStackdriverLogging": True or False, # If true, StackDriver logging is currently enabled. + "enableInteractionLogging": True or False, # Enables DF Interaction logging. + "enableStackdriverLogging": True or False, # Enables StackDriver logging. }, "speechSettings": { # Define behaviors of speech to text detection. # Settings for speech to text detection. Exposed at the following levels: - Agent level - Flow level - Page level - Parameter level "endpointerSensitivity": 42, # Sensitivity of the speech model that detects the end of speech. Scale from 0 to 100. @@ -5857,6 +8930,13 @@

Method Details

"A String", ], }, + "toolCall": { # Represents a call of a specific tool's action with the specified inputs. # Returns the definition of a tool call that should be executed by the client. + "action": "A String", # Required. The name of the tool's action associated with this call. + "inputParameters": { # Optional. The action's input parameters. + "a_key": "", # Properties of the object. + }, + "tool": "A String", # Required. The tool associated with this call. Format: `projects//locations//agents//tools/`. + }, }, }, ], @@ -5913,566 +8993,384 @@

Method Details

"A String", ], }, + "toolCall": { # Represents a call of a specific tool's action with the specified inputs. # Returns the definition of a tool call that should be executed by the client. + "action": "A String", # Required. The name of the tool's action associated with this call. + "inputParameters": { # Optional. The action's input parameters. + "a_key": "", # Properties of the object. + }, + "tool": "A String", # Required. The tool associated with this call. Format: `projects//locations//agents//tools/`. + }, }, ], "returnPartialResponses": True or False, # Whether Dialogflow should return currently queued fulfillment response messages in streaming APIs. If a webhook is specified, it happens before Dialogflow invokes webhook. Warning: 1) This flag only affects streaming API. Responses are still queued and returned once in non-streaming API. 2) The flag can be enabled in any fulfillment but only the first 3 partial responses will be returned. You may only want to apply it to fulfillments that have slow webhooks. "setParameterActions": [ # Set parameter values before executing the webhook. - { # Setting a parameter value. - "parameter": "A String", # Display name of the parameter. - "value": "", # The new value of the parameter. A null value clears the parameter. - }, - ], - "tag": "A String", # The value of this field will be populated in the WebhookRequest `fulfillmentInfo.tag` field by Dialogflow when the associated webhook is called. The tag is typically used by the webhook service to identify which fulfillment is being called, but it could be used for other purposes. This field is required if `webhook` is specified. - "webhook": "A String", # The webhook to call. Format: `projects//locations//agents//webhooks/`. - }, - }, - "name": "A String", # The unique identifier of the page. Required for the Pages.UpdatePage method. Pages.CreatePage populates the name automatically. Format: `projects//locations//agents//flows//pages/`. - "transitionRouteGroups": [ # Ordered list of `TransitionRouteGroups` added to the page. Transition route groups must be unique within a page. If the page links both flow-level transition route groups and agent-level transition route groups, the flow-level ones will have higher priority and will be put before the agent-level ones. * If multiple transition routes within a page scope refer to the same intent, then the precedence order is: page's transition route -> page's transition route group -> flow's transition routes. * If multiple transition route groups within a page contain the same intent, then the first group in the ordered list takes precedence. Format:`projects//locations//agents//flows//transitionRouteGroups/` or `projects//locations//agents//transitionRouteGroups/` for agent-level groups. - "A String", - ], - "transitionRoutes": [ # A list of transitions for the transition rules of this page. They route the conversation to another page in the same flow, or another flow. When we are in a certain page, the TransitionRoutes are evalauted in the following order: * TransitionRoutes defined in the page with intent specified. * TransitionRoutes defined in the transition route groups with intent specified. * TransitionRoutes defined in flow with intent specified. * TransitionRoutes defined in the transition route groups with intent specified. * TransitionRoutes defined in the page with only condition specified. * TransitionRoutes defined in the transition route groups with only condition specified. - { # A transition route specifies a intent that can be matched and/or a data condition that can be evaluated during a session. When a specified transition is matched, the following actions are taken in order: * If there is a `trigger_fulfillment` associated with the transition, it will be called. * If there is a `target_page` associated with the transition, the session will transition into the specified page. * If there is a `target_flow` associated with the transition, the session will transition into the specified flow. - "condition": "A String", # The condition to evaluate against form parameters or session parameters. See the [conditions reference](https://cloud.google.com/dialogflow/cx/docs/reference/condition). At least one of `intent` or `condition` must be specified. When both `intent` and `condition` are specified, the transition can only happen when both are fulfilled. - "description": "A String", # Optional. The description of the transition route. The maximum length is 500 characters. - "intent": "A String", # The unique identifier of an Intent. Format: `projects//locations//agents//intents/`. Indicates that the transition can only happen when the given intent is matched. At least one of `intent` or `condition` must be specified. When both `intent` and `condition` are specified, the transition can only happen when both are fulfilled. - "name": "A String", # Output only. The unique identifier of this transition route. - "targetFlow": "A String", # The target flow to transition to. Format: `projects//locations//agents//flows/`. - "targetPage": "A String", # The target page to transition to. Format: `projects//locations//agents//flows//pages/`. - "triggerFulfillment": { # A fulfillment can do one or more of the following actions at the same time: * Generate rich message responses. * Set parameter values. * Call the webhook. Fulfillments can be called at various stages in the Page or Form lifecycle. For example, when a DetectIntentRequest drives a session to enter a new page, the page's entry fulfillment can add a static response to the QueryResult in the returning DetectIntentResponse, call the webhook (for example, to load user data from a database), or both. # The fulfillment to call when the condition is satisfied. At least one of `trigger_fulfillment` and `target` must be specified. When both are defined, `trigger_fulfillment` is executed first. - "advancedSettings": { # Hierarchical advanced settings for agent/flow/page/fulfillment/parameter. Settings exposed at lower level overrides the settings exposed at higher level. Overriding occurs at the sub-setting level. For example, the playback_interruption_settings at fulfillment level only overrides the playback_interruption_settings at the agent level, leaving other settings at the agent level unchanged. DTMF settings does not override each other. DTMF settings set at different levels define DTMF detections running in parallel. Hierarchy: Agent->Flow->Page->Fulfillment/Parameter. # Hierarchical advanced settings for this fulfillment. The settings exposed at the lower level overrides the settings exposed at the higher level. - "audioExportGcsDestination": { # Google Cloud Storage location for a Dialogflow operation that writes or exports objects (e.g. exported agent or transcripts) outside of Dialogflow. # If present, incoming audio is exported by Dialogflow to the configured Google Cloud Storage destination. Exposed at the following levels: - Agent level - Flow level - "uri": "A String", # Required. The Google Cloud Storage URI for the exported objects. A URI is of the form: `gs://bucket/object-name-or-prefix` Whether a full object name, or just a prefix, its usage depends on the Dialogflow operation. - }, - "dtmfSettings": { # Define behaviors for DTMF (dual tone multi frequency). # Settings for DTMF. Exposed at the following levels: - Agent level - Flow level - Page level - Parameter level. - "enabled": True or False, # If true, incoming audio is processed for DTMF (dual tone multi frequency) events. For example, if the caller presses a button on their telephone keypad and DTMF processing is enabled, Dialogflow will detect the event (e.g. a "3" was pressed) in the incoming audio and pass the event to the bot to drive business logic (e.g. when 3 is pressed, return the account balance). - "endpointingTimeoutDuration": "A String", # Endpoint timeout setting for matching dtmf input to regex. - "finishDigit": "A String", # The digit that terminates a DTMF digit sequence. - "interdigitTimeoutDuration": "A String", # Interdigit timeout setting for matching dtmf input to regex. - "maxDigits": 42, # Max length of DTMF digits. - }, - "loggingSettings": { # Define behaviors on logging. # Settings for logging. Settings for Dialogflow History, Contact Center messages, StackDriver logs, and speech logging. Exposed at the following levels: - Agent level. - "enableInteractionLogging": True or False, # If true, DF Interaction logging is currently enabled. - "enableStackdriverLogging": True or False, # If true, StackDriver logging is currently enabled. - }, - "speechSettings": { # Define behaviors of speech to text detection. # Settings for speech to text detection. Exposed at the following levels: - Agent level - Flow level - Page level - Parameter level - "endpointerSensitivity": 42, # Sensitivity of the speech model that detects the end of speech. Scale from 0 to 100. - "models": { # Mapping from language to Speech-to-Text model. The mapped Speech-to-Text model will be selected for requests from its corresponding language. For more information, see [Speech models](https://cloud.google.com/dialogflow/cx/docs/concept/speech-models). - "a_key": "A String", - }, - "noSpeechTimeout": "A String", # Timeout before detecting no speech. - "useTimeoutBasedEndpointing": True or False, # Use timeout based endpointing, interpreting endpointer sensitivy as seconds of timeout value. - }, - }, - "conditionalCases": [ # Conditional cases for this fulfillment. - { # A list of cascading if-else conditions. Cases are mutually exclusive. The first one with a matching condition is selected, all the rest ignored. - "cases": [ # A list of cascading if-else conditions. - { # Each case has a Boolean condition. When it is evaluated to be True, the corresponding messages will be selected and evaluated recursively. - "caseContent": [ # A list of case content. - { # The list of messages or conditional cases to activate for this case. - "additionalCases": # Object with schema name: GoogleCloudDialogflowCxV3beta1FulfillmentConditionalCases # Additional cases to be evaluated. - "message": { # 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. # Returned message. - "channel": "A String", # The channel which the response is associated with. Clients can specify the channel via QueryParameters.channel, and only associated channel response will be returned. - "conversationSuccess": { # 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. # Indicates that the conversation succeeded. - "metadata": { # Custom metadata. Dialogflow doesn't impose any structure on this. - "a_key": "", # Properties of the object. - }, - }, - "endInteraction": { # 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. # Output only. A signal that indicates the interaction with the Dialogflow agent has ended. This message is generated by Dialogflow only when the conversation reaches `END_SESSION` page. It is not supposed to be defined by the user. It's guaranteed that there is at most one such message in each response. - }, - "knowledgeInfoCard": { # Represents info card response. If the response contains generative knowledge prediction, Dialogflow will return a payload with Infobot Messenger compatible info card. Otherwise, the info card response is skipped. # Represents info card for knowledge answers, to be better rendered in Dialogflow Messenger. - }, - "liveAgentHandoff": { # 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. # Hands off conversation to a human agent. - "metadata": { # Custom metadata for your handoff procedure. Dialogflow doesn't impose any structure on this. - "a_key": "", # Properties of the object. - }, - }, - "mixedAudio": { # 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. # Output only. An audio response message composed of both the synthesized Dialogflow agent responses and responses defined via play_audio. This message is generated by Dialogflow only and not supposed to be defined by the user. - "segments": [ # Segments this audio response is composed of. - { # Represents one segment of audio. - "allowPlaybackInterruption": True or False, # 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. - "audio": "A String", # Raw audio synthesized from the Dialogflow agent's response using the output config specified in the request. - "uri": "A String", # Client-specific URI that points to an audio clip accessible to the client. Dialogflow does not impose any validation on it. - }, - ], - }, - "outputAudioText": { # A text or ssml response that is preferentially used for TTS output audio synthesis, as described in the comment on the ResponseMessage message. # A text or ssml response that is preferentially used for TTS output audio synthesis, as described in the comment on the ResponseMessage message. - "allowPlaybackInterruption": True or False, # 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. - "ssml": "A String", # The SSML text to be synthesized. For more information, see [SSML](/speech/text-to-speech/docs/ssml). - "text": "A String", # The raw text to be synthesized. - }, - "payload": { # Returns a response containing a custom, platform-specific payload. - "a_key": "", # Properties of the object. - }, - "playAudio": { # Specifies an audio clip to be played by the client as part of the response. # Signal that the client should play an audio clip hosted at a client-specific URI. Dialogflow uses this to construct mixed_audio. However, Dialogflow itself does not try to read or process the URI in any way. - "allowPlaybackInterruption": True or False, # 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. - "audioUri": "A String", # Required. URI of the audio clip. Dialogflow does not impose any validation on this value. It is specific to the client that reads it. - }, - "telephonyTransferCall": { # Represents the signal that telles the client to transfer the phone call connected to the agent to a third-party endpoint. # A signal that the client should transfer the phone call connected to this agent to a third-party endpoint. - "phoneNumber": "A String", # Transfer the call to a phone number in [E.164 format](https://en.wikipedia.org/wiki/E.164). - }, - "text": { # The text response message. # Returns a text response. - "allowPlaybackInterruption": True or False, # 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. - "text": [ # Required. A collection of text responses. - "A String", - ], - }, - }, - }, - ], - "condition": "A String", # The condition to activate and select this case. Empty means the condition is always true. The condition is evaluated against form parameters or session parameters. See the [conditions reference](https://cloud.google.com/dialogflow/cx/docs/reference/condition). - }, - ], - }, - ], - "enableGenerativeFallback": True or False, # If the flag is true, the agent will utilize LLM to generate a text response. If LLM generation fails, the defined responses in the fulfillment will be respected. This flag is only useful for fulfillments associated with no-match event handlers. - "messages": [ # The list of rich message responses to present to the user. - { # 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. - "channel": "A String", # The channel which the response is associated with. Clients can specify the channel via QueryParameters.channel, and only associated channel response will be returned. - "conversationSuccess": { # 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. # Indicates that the conversation succeeded. - "metadata": { # Custom metadata. Dialogflow doesn't impose any structure on this. - "a_key": "", # Properties of the object. - }, - }, - "endInteraction": { # 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. # Output only. A signal that indicates the interaction with the Dialogflow agent has ended. This message is generated by Dialogflow only when the conversation reaches `END_SESSION` page. It is not supposed to be defined by the user. It's guaranteed that there is at most one such message in each response. - }, - "knowledgeInfoCard": { # Represents info card response. If the response contains generative knowledge prediction, Dialogflow will return a payload with Infobot Messenger compatible info card. Otherwise, the info card response is skipped. # Represents info card for knowledge answers, to be better rendered in Dialogflow Messenger. - }, - "liveAgentHandoff": { # 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. # Hands off conversation to a human agent. - "metadata": { # Custom metadata for your handoff procedure. Dialogflow doesn't impose any structure on this. - "a_key": "", # Properties of the object. - }, - }, - "mixedAudio": { # 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. # Output only. An audio response message composed of both the synthesized Dialogflow agent responses and responses defined via play_audio. This message is generated by Dialogflow only and not supposed to be defined by the user. - "segments": [ # Segments this audio response is composed of. - { # Represents one segment of audio. - "allowPlaybackInterruption": True or False, # 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. - "audio": "A String", # Raw audio synthesized from the Dialogflow agent's response using the output config specified in the request. - "uri": "A String", # Client-specific URI that points to an audio clip accessible to the client. Dialogflow does not impose any validation on it. - }, - ], - }, - "outputAudioText": { # A text or ssml response that is preferentially used for TTS output audio synthesis, as described in the comment on the ResponseMessage message. # A text or ssml response that is preferentially used for TTS output audio synthesis, as described in the comment on the ResponseMessage message. - "allowPlaybackInterruption": True or False, # 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. - "ssml": "A String", # The SSML text to be synthesized. For more information, see [SSML](/speech/text-to-speech/docs/ssml). - "text": "A String", # The raw text to be synthesized. - }, - "payload": { # Returns a response containing a custom, platform-specific payload. - "a_key": "", # Properties of the object. - }, - "playAudio": { # Specifies an audio clip to be played by the client as part of the response. # Signal that the client should play an audio clip hosted at a client-specific URI. Dialogflow uses this to construct mixed_audio. However, Dialogflow itself does not try to read or process the URI in any way. - "allowPlaybackInterruption": True or False, # 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. - "audioUri": "A String", # Required. URI of the audio clip. Dialogflow does not impose any validation on this value. It is specific to the client that reads it. - }, - "telephonyTransferCall": { # Represents the signal that telles the client to transfer the phone call connected to the agent to a third-party endpoint. # A signal that the client should transfer the phone call connected to this agent to a third-party endpoint. - "phoneNumber": "A String", # Transfer the call to a phone number in [E.164 format](https://en.wikipedia.org/wiki/E.164). - }, - "text": { # The text response message. # Returns a text response. - "allowPlaybackInterruption": True or False, # 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. - "text": [ # Required. A collection of text responses. - "A String", - ], - }, - }, - ], - "returnPartialResponses": True or False, # Whether Dialogflow should return currently queued fulfillment response messages in streaming APIs. If a webhook is specified, it happens before Dialogflow invokes webhook. Warning: 1) This flag only affects streaming API. Responses are still queued and returned once in non-streaming API. 2) The flag can be enabled in any fulfillment but only the first 3 partial responses will be returned. You may only want to apply it to fulfillments that have slow webhooks. - "setParameterActions": [ # Set parameter values before executing the webhook. - { # Setting a parameter value. - "parameter": "A String", # Display name of the parameter. - "value": "", # The new value of the parameter. A null value clears the parameter. - }, - ], - "tag": "A String", # The value of this field will be populated in the WebhookRequest `fulfillmentInfo.tag` field by Dialogflow when the associated webhook is called. The tag is typically used by the webhook service to identify which fulfillment is being called, but it could be used for other purposes. This field is required if `webhook` is specified. - "webhook": "A String", # The webhook to call. Format: `projects//locations//agents//webhooks/`. - }, - }, - ], - }, - "dataStoreConnectionSignals": { # Data store connection feature output signals. Might be only partially field if processing stop before the final answer. Reasons for this can be, but are not limited to: empty UCS search results, positive RAI check outcome, grounding failure, ... # Optional. Data store connection feature output signals. Filled only when data stores are involved in serving the query and DetectIntentRequest.populate data_store_connection_quality_signals is set to true in the request. - "answer": "A String", # Optional. The final compiled answer. - "answerGenerationModelCallSignals": { # Diagnostic info related to the answer generation model call. # Optional. Diagnostic info related to the answer generation model call. - "modelOutput": "A String", # Output of the generative model. - "renderedPrompt": "A String", # Prompt as sent to the model. - }, - "answerParts": [ # Optional. Answer parts with relevant citations. Concatenation of texts should add up the `answer` (not counting whitespaces). - { # Answer part with citation. - "supportingIndices": [ # Citations for this answer part. Indices of `search_snippets`. - 42, + { # Setting a parameter value. + "parameter": "A String", # Display name of the parameter. + "value": "", # The new value of the parameter. A null value clears the parameter. + }, ], - "text": "A String", # Substring of the answer. - }, - ], - "citedSnippets": [ # Optional. Snippets cited by the answer generation model from the most to least relevant. - { # Snippet cited by the answer generation model. - "searchSnippet": { # Search snippet details. # Details of the snippet. - "documentTitle": "A String", # Title of the enclosing document. - "documentUri": "A String", # Uri for the document. Present if specified for the document. - "text": "A String", # Text included in the prompt. - }, - "snippetIndex": 42, # Index of the snippet in `search_snippets` field. - }, - ], - "groundingSignals": { # Grounding signals. # Optional. Grounding signals. - "decision": "A String", # Represents the decision of the grounding check. - "score": "A String", # Grounding score bucket setting. - }, - "rewriterModelCallSignals": { # Diagnostic info related to the rewriter model call. # Optional. Diagnostic info related to the rewriter model call. - "modelOutput": "A String", # Output of the generative model. - "renderedPrompt": "A String", # Prompt as sent to the model. - }, - "rewrittenQuery": "A String", # Optional. Rewritten string query used for search. - "safetySignals": { # Safety check results. # Optional. Safety check result. - "bannedPhraseMatch": "A String", # Specifies banned phrase match subject. - "decision": "A String", # Safety decision. - "matchedBannedPhrase": "A String", # The matched banned phrase if there was a match. - }, - "searchSnippets": [ # Optional. Search snippets included in the answer generation prompt. - { # Search snippet details. - "documentTitle": "A String", # Title of the enclosing document. - "documentUri": "A String", # Uri for the document. Present if specified for the document. - "text": "A String", # Text included in the prompt. + "tag": "A String", # The value of this field will be populated in the WebhookRequest `fulfillmentInfo.tag` field by Dialogflow when the associated webhook is called. The tag is typically used by the webhook service to identify which fulfillment is being called, but it could be used for other purposes. This field is required if `webhook` is specified. + "webhook": "A String", # The webhook to call. Format: `projects//locations//agents//webhooks/`. }, - ], - }, - "diagnosticInfo": { # The free-form diagnostic info. For example, this field could contain webhook call latency. The fields of this data can change without notice, so you should not write code that depends on its structure. One of the fields is called "Alternative Matched Intents", which may aid with debugging. The following describes these intent results: - The list is empty if no intent was matched to end-user input. - Only intents that are referenced in the currently active flow are included. - The matched intent is included. - Other intents that could have matched end-user input, but did not match because they are referenced by intent routes that are out of [scope](https://cloud.google.com/dialogflow/cx/docs/concept/handler#scope), are included. - Other intents referenced by intent routes in scope that matched end-user input, but had a lower confidence score. - "a_key": "", # Properties of the object. - }, - "dtmf": { # Represents the input for dtmf event. # If a DTMF was provided as input, this field will contain a copy of the DtmfInput. - "digits": "A String", # The dtmf digits. - "finishDigit": "A String", # The finish digit (if any). - }, - "intent": { # An intent represents a user's intent to interact with a conversational agent. You can provide information for the Dialogflow API to use to match user input to an intent by adding training phrases (i.e., examples of user input) to your intent. # The Intent that matched the conversational query. Some, not all fields are filled in this message, including but not limited to: `name` and `display_name`. This field is deprecated, please use QueryResult.match instead. - "description": "A String", # Human readable description for better understanding an intent like its scope, content, result etc. Maximum character limit: 140 characters. - "displayName": "A String", # Required. The human-readable name of the intent, unique within the agent. - "isFallback": True or False, # Indicates whether this is a fallback intent. Currently only default fallback intent is allowed in the agent, which is added upon agent creation. Adding training phrases to fallback intent is useful in the case of requests that are mistakenly matched, since training phrases assigned to fallback intents act as negative examples that triggers no-match event. - "labels": { # The key/value metadata to label an intent. Labels can contain lowercase letters, digits and the symbols '-' and '_'. International characters are allowed, including letters from unicase alphabets. Keys must start with a letter. Keys and values can be no longer than 63 characters and no more than 128 bytes. Prefix "sys-" is reserved for Dialogflow defined labels. Currently allowed Dialogflow defined labels include: * sys-head * sys-contextual The above labels do not require value. "sys-head" means the intent is a head intent. "sys-contextual" means the intent is a contextual intent. - "a_key": "A String", }, - "name": "A String", # The unique identifier of the intent. Required for the Intents.UpdateIntent method. Intents.CreateIntent populates the name automatically. Format: `projects//locations//agents//intents/`. - "parameters": [ # The collection of parameters associated with the intent. - { # Represents an intent parameter. - "entityType": "A String", # Required. The entity type of the parameter. Format: `projects/-/locations/-/agents/-/entityTypes/` for system entity types (for example, `projects/-/locations/-/agents/-/entityTypes/sys.date`), or `projects//locations//agents//entityTypes/` for developer entity types. - "id": "A String", # Required. The unique identifier of the parameter. This field is used by training phrases to annotate their parts. - "isList": True or False, # Indicates whether the parameter represents a list of values. - "redact": True or False, # Indicates whether the parameter content should be redacted in log. If redaction is enabled, the parameter content will be replaced by parameter name during logging. Note: the parameter content is subject to redaction if either parameter level redaction or entity type level redaction is enabled. + ], + "knowledgeConnectorSettings": { # The Knowledge Connector settings for this page or flow. This includes information such as the attached Knowledge Bases, and the way to execute fulfillment. # Optional. Knowledge connector configuration. + "dataStoreConnections": [ # Optional. List of related data store connections. + { # A data store connection. It represents a data store in Discovery Engine and the type of the contents it contains. + "dataStore": "A String", # The full name of the referenced data store. Formats: `projects/{project}/locations/{location}/collections/{collection}/dataStores/{data_store}` `projects/{project}/locations/{location}/dataStores/{data_store}` + "dataStoreType": "A String", # The type of the connected data store. }, ], - "priority": 42, # 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. - "trainingPhrases": [ # The collection of training phrases the agent is trained on to identify the intent. - { # Represents an example that the agent is trained on to identify the intent. - "id": "A String", # Output only. The unique identifier of the training phrase. - "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 `parameter_id` field is set. - { # Represents a part of a training phrase. - "parameterId": "A String", # The parameter used to annotate this part of the training phrase. This field is required for annotated parts of the training phrase. - "text": "A String", # Required. The text for this part. + "enabled": True or False, # Whether Knowledge Connector is enabled or not. + "targetFlow": "A String", # The target flow to transition to. Format: `projects//locations//agents//flows/`. + "targetPage": "A String", # The target page to transition to. Format: `projects//locations//agents//flows//pages/`. + "triggerFulfillment": { # A fulfillment can do one or more of the following actions at the same time: * Generate rich message responses. * Set parameter values. * Call the webhook. Fulfillments can be called at various stages in the Page or Form lifecycle. For example, when a DetectIntentRequest drives a session to enter a new page, the page's entry fulfillment can add a static response to the QueryResult in the returning DetectIntentResponse, call the webhook (for example, to load user data from a database), or both. # The fulfillment to be triggered. When the answers from the Knowledge Connector are selected by Dialogflow, you can utitlize the request scoped parameter `$request.knowledge.answers` (contains up to the 5 highest confidence answers) and `$request.knowledge.questions` (contains the corresponding questions) to construct the fulfillment. + "advancedSettings": { # Hierarchical advanced settings for agent/flow/page/fulfillment/parameter. Settings exposed at lower level overrides the settings exposed at higher level. Overriding occurs at the sub-setting level. For example, the playback_interruption_settings at fulfillment level only overrides the playback_interruption_settings at the agent level, leaving other settings at the agent level unchanged. DTMF settings does not override each other. DTMF settings set at different levels define DTMF detections running in parallel. Hierarchy: Agent->Flow->Page->Fulfillment/Parameter. # Hierarchical advanced settings for this fulfillment. The settings exposed at the lower level overrides the settings exposed at the higher level. + "audioExportGcsDestination": { # Google Cloud Storage location for a Dialogflow operation that writes or exports objects (e.g. exported agent or transcripts) outside of Dialogflow. # If present, incoming audio is exported by Dialogflow to the configured Google Cloud Storage destination. Exposed at the following levels: - Agent level - Flow level + "uri": "A String", # Required. The Google Cloud Storage URI for the exported objects. A URI is of the form: `gs://bucket/object-name-or-prefix` Whether a full object name, or just a prefix, its usage depends on the Dialogflow operation. + }, + "dtmfSettings": { # Define behaviors for DTMF (dual tone multi frequency). # Settings for DTMF. Exposed at the following levels: - Agent level - Flow level - Page level - Parameter level. + "enabled": True or False, # If true, incoming audio is processed for DTMF (dual tone multi frequency) events. For example, if the caller presses a button on their telephone keypad and DTMF processing is enabled, Dialogflow will detect the event (e.g. a "3" was pressed) in the incoming audio and pass the event to the bot to drive business logic (e.g. when 3 is pressed, return the account balance). + "endpointingTimeoutDuration": "A String", # Endpoint timeout setting for matching dtmf input to regex. + "finishDigit": "A String", # The digit that terminates a DTMF digit sequence. + "interdigitTimeoutDuration": "A String", # Interdigit timeout setting for matching dtmf input to regex. + "maxDigits": 42, # Max length of DTMF digits. + }, + "loggingSettings": { # Define behaviors on logging. # Settings for logging. Settings for Dialogflow History, Contact Center messages, StackDriver logs, and speech logging. Exposed at the following levels: - Agent level. + "enableInteractionLogging": True or False, # Enables DF Interaction logging. + "enableStackdriverLogging": True or False, # Enables StackDriver logging. + }, + "speechSettings": { # Define behaviors of speech to text detection. # Settings for speech to text detection. Exposed at the following levels: - Agent level - Flow level - Page level - Parameter level + "endpointerSensitivity": 42, # Sensitivity of the speech model that detects the end of speech. Scale from 0 to 100. + "models": { # Mapping from language to Speech-to-Text model. The mapped Speech-to-Text model will be selected for requests from its corresponding language. For more information, see [Speech models](https://cloud.google.com/dialogflow/cx/docs/concept/speech-models). + "a_key": "A String", }, - ], - "repeatCount": 42, # Indicates how many times this example was added to the intent. - }, - ], - }, - "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. This field is deprecated, please use QueryResult.match instead. - "languageCode": "A String", # The language that was triggered during intent detection. See [Language Support](https://cloud.google.com/dialogflow/cx/docs/reference/language) for a list of the currently supported language codes. - "match": { # Represents one match result of MatchIntent. # Intent match result, could be an intent or an event. - "confidence": 3.14, # The confidence of this match. 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. - "event": "A String", # The event that matched the query. Filled for `EVENT`, `NO_MATCH` and `NO_INPUT` match types. - "intent": { # An intent represents a user's intent to interact with a conversational agent. You can provide information for the Dialogflow API to use to match user input to an intent by adding training phrases (i.e., examples of user input) to your intent. # The Intent that matched the query. Some, not all fields are filled in this message, including but not limited to: `name` and `display_name`. Only filled for `INTENT` match type. - "description": "A String", # Human readable description for better understanding an intent like its scope, content, result etc. Maximum character limit: 140 characters. - "displayName": "A String", # Required. The human-readable name of the intent, unique within the agent. - "isFallback": True or False, # Indicates whether this is a fallback intent. Currently only default fallback intent is allowed in the agent, which is added upon agent creation. Adding training phrases to fallback intent is useful in the case of requests that are mistakenly matched, since training phrases assigned to fallback intents act as negative examples that triggers no-match event. - "labels": { # The key/value metadata to label an intent. Labels can contain lowercase letters, digits and the symbols '-' and '_'. International characters are allowed, including letters from unicase alphabets. Keys must start with a letter. Keys and values can be no longer than 63 characters and no more than 128 bytes. Prefix "sys-" is reserved for Dialogflow defined labels. Currently allowed Dialogflow defined labels include: * sys-head * sys-contextual The above labels do not require value. "sys-head" means the intent is a head intent. "sys-contextual" means the intent is a contextual intent. - "a_key": "A String", - }, - "name": "A String", # The unique identifier of the intent. Required for the Intents.UpdateIntent method. Intents.CreateIntent populates the name automatically. Format: `projects//locations//agents//intents/`. - "parameters": [ # The collection of parameters associated with the intent. - { # Represents an intent parameter. - "entityType": "A String", # Required. The entity type of the parameter. Format: `projects/-/locations/-/agents/-/entityTypes/` for system entity types (for example, `projects/-/locations/-/agents/-/entityTypes/sys.date`), or `projects//locations//agents//entityTypes/` for developer entity types. - "id": "A String", # Required. The unique identifier of the parameter. This field is used by training phrases to annotate their parts. - "isList": True or False, # Indicates whether the parameter represents a list of values. - "redact": True or False, # Indicates whether the parameter content should be redacted in log. If redaction is enabled, the parameter content will be replaced by parameter name during logging. Note: the parameter content is subject to redaction if either parameter level redaction or entity type level redaction is enabled. + "noSpeechTimeout": "A String", # Timeout before detecting no speech. + "useTimeoutBasedEndpointing": True or False, # Use timeout based endpointing, interpreting endpointer sensitivy as seconds of timeout value. }, - ], - "priority": 42, # 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. - "trainingPhrases": [ # The collection of training phrases the agent is trained on to identify the intent. - { # Represents an example that the agent is trained on to identify the intent. - "id": "A String", # Output only. The unique identifier of the training phrase. - "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 `parameter_id` field is set. - { # Represents a part of a training phrase. - "parameterId": "A String", # The parameter used to annotate this part of the training phrase. This field is required for annotated parts of the training phrase. - "text": "A String", # Required. The text for this part. + }, + "conditionalCases": [ # Conditional cases for this fulfillment. + { # A list of cascading if-else conditions. Cases are mutually exclusive. The first one with a matching condition is selected, all the rest ignored. + "cases": [ # A list of cascading if-else conditions. + { # Each case has a Boolean condition. When it is evaluated to be True, the corresponding messages will be selected and evaluated recursively. + "caseContent": [ # A list of case content. + { # The list of messages or conditional cases to activate for this case. + "additionalCases": # Object with schema name: GoogleCloudDialogflowCxV3beta1FulfillmentConditionalCases # Additional cases to be evaluated. + "message": { # 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. # Returned message. + "channel": "A String", # The channel which the response is associated with. Clients can specify the channel via QueryParameters.channel, and only associated channel response will be returned. + "conversationSuccess": { # 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. # Indicates that the conversation succeeded. + "metadata": { # Custom metadata. Dialogflow doesn't impose any structure on this. + "a_key": "", # Properties of the object. + }, + }, + "endInteraction": { # 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. # Output only. A signal that indicates the interaction with the Dialogflow agent has ended. This message is generated by Dialogflow only when the conversation reaches `END_SESSION` page. It is not supposed to be defined by the user. It's guaranteed that there is at most one such message in each response. + }, + "knowledgeInfoCard": { # Represents info card response. If the response contains generative knowledge prediction, Dialogflow will return a payload with Infobot Messenger compatible info card. Otherwise, the info card response is skipped. # Represents info card for knowledge answers, to be better rendered in Dialogflow Messenger. + }, + "liveAgentHandoff": { # 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. # Hands off conversation to a human agent. + "metadata": { # Custom metadata for your handoff procedure. Dialogflow doesn't impose any structure on this. + "a_key": "", # Properties of the object. + }, + }, + "mixedAudio": { # 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. # Output only. An audio response message composed of both the synthesized Dialogflow agent responses and responses defined via play_audio. This message is generated by Dialogflow only and not supposed to be defined by the user. + "segments": [ # Segments this audio response is composed of. + { # Represents one segment of audio. + "allowPlaybackInterruption": True or False, # 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. + "audio": "A String", # Raw audio synthesized from the Dialogflow agent's response using the output config specified in the request. + "uri": "A String", # Client-specific URI that points to an audio clip accessible to the client. Dialogflow does not impose any validation on it. + }, + ], + }, + "outputAudioText": { # A text or ssml response that is preferentially used for TTS output audio synthesis, as described in the comment on the ResponseMessage message. # A text or ssml response that is preferentially used for TTS output audio synthesis, as described in the comment on the ResponseMessage message. + "allowPlaybackInterruption": True or False, # 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. + "ssml": "A String", # The SSML text to be synthesized. For more information, see [SSML](/speech/text-to-speech/docs/ssml). + "text": "A String", # The raw text to be synthesized. + }, + "payload": { # Returns a response containing a custom, platform-specific payload. + "a_key": "", # Properties of the object. + }, + "playAudio": { # Specifies an audio clip to be played by the client as part of the response. # Signal that the client should play an audio clip hosted at a client-specific URI. Dialogflow uses this to construct mixed_audio. However, Dialogflow itself does not try to read or process the URI in any way. + "allowPlaybackInterruption": True or False, # 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. + "audioUri": "A String", # Required. URI of the audio clip. Dialogflow does not impose any validation on this value. It is specific to the client that reads it. + }, + "telephonyTransferCall": { # Represents the signal that telles the client to transfer the phone call connected to the agent to a third-party endpoint. # A signal that the client should transfer the phone call connected to this agent to a third-party endpoint. + "phoneNumber": "A String", # Transfer the call to a phone number in [E.164 format](https://en.wikipedia.org/wiki/E.164). + }, + "text": { # The text response message. # Returns a text response. + "allowPlaybackInterruption": True or False, # 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. + "text": [ # Required. A collection of text responses. + "A String", + ], + }, + "toolCall": { # Represents a call of a specific tool's action with the specified inputs. # Returns the definition of a tool call that should be executed by the client. + "action": "A String", # Required. The name of the tool's action associated with this call. + "inputParameters": { # Optional. The action's input parameters. + "a_key": "", # Properties of the object. + }, + "tool": "A String", # Required. The tool associated with this call. Format: `projects//locations//agents//tools/`. + }, + }, + }, + ], + "condition": "A String", # The condition to activate and select this case. Empty means the condition is always true. The condition is evaluated against form parameters or session parameters. See the [conditions reference](https://cloud.google.com/dialogflow/cx/docs/reference/condition). }, ], - "repeatCount": 42, # Indicates how many times this example was added to the intent. }, ], - }, - "matchType": "A String", # Type of this Match. - "parameters": { # The collection of parameters extracted from the query. 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 then use map, otherwise, depending on the parameter value type, it could be one of string, number, boolean, null, list or map. * MapValue value: If parameter's entity type is a composite entity then use map from composite entity property names to property values, otherwise, use parameter value. - "a_key": "", # Properties of the object. - }, - "resolvedInput": "A String", # Final text input which was matched during MatchIntent. This value can be different from original input sent in request because of spelling correction or other processing. - }, - "parameters": { # The collected session 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 then use map, otherwise, depending on the parameter value type, it could be one of string, number, boolean, null, list or map. * MapValue value: If parameter's entity type is a composite entity then use map from composite entity property names to property values, otherwise, use parameter value. - "a_key": "", # Properties of the object. - }, - "responseMessages": [ # The list of rich messages returned to the client. Responses vary from simple text messages to more sophisticated, structured payloads used to drive complex logic. - { # 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. - "channel": "A String", # The channel which the response is associated with. Clients can specify the channel via QueryParameters.channel, and only associated channel response will be returned. - "conversationSuccess": { # 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. # Indicates that the conversation succeeded. - "metadata": { # Custom metadata. Dialogflow doesn't impose any structure on this. - "a_key": "", # Properties of the object. - }, - }, - "endInteraction": { # 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. # Output only. A signal that indicates the interaction with the Dialogflow agent has ended. This message is generated by Dialogflow only when the conversation reaches `END_SESSION` page. It is not supposed to be defined by the user. It's guaranteed that there is at most one such message in each response. - }, - "knowledgeInfoCard": { # Represents info card response. If the response contains generative knowledge prediction, Dialogflow will return a payload with Infobot Messenger compatible info card. Otherwise, the info card response is skipped. # Represents info card for knowledge answers, to be better rendered in Dialogflow Messenger. - }, - "liveAgentHandoff": { # 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. # Hands off conversation to a human agent. - "metadata": { # Custom metadata for your handoff procedure. Dialogflow doesn't impose any structure on this. - "a_key": "", # Properties of the object. - }, - }, - "mixedAudio": { # 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. # Output only. An audio response message composed of both the synthesized Dialogflow agent responses and responses defined via play_audio. This message is generated by Dialogflow only and not supposed to be defined by the user. - "segments": [ # Segments this audio response is composed of. - { # Represents one segment of audio. - "allowPlaybackInterruption": True or False, # 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. - "audio": "A String", # Raw audio synthesized from the Dialogflow agent's response using the output config specified in the request. - "uri": "A String", # Client-specific URI that points to an audio clip accessible to the client. Dialogflow does not impose any validation on it. + "enableGenerativeFallback": True or False, # If the flag is true, the agent will utilize LLM to generate a text response. If LLM generation fails, the defined responses in the fulfillment will be respected. This flag is only useful for fulfillments associated with no-match event handlers. + "messages": [ # The list of rich message responses to present to the user. + { # 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. + "channel": "A String", # The channel which the response is associated with. Clients can specify the channel via QueryParameters.channel, and only associated channel response will be returned. + "conversationSuccess": { # 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. # Indicates that the conversation succeeded. + "metadata": { # Custom metadata. Dialogflow doesn't impose any structure on this. + "a_key": "", # Properties of the object. + }, + }, + "endInteraction": { # 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. # Output only. A signal that indicates the interaction with the Dialogflow agent has ended. This message is generated by Dialogflow only when the conversation reaches `END_SESSION` page. It is not supposed to be defined by the user. It's guaranteed that there is at most one such message in each response. + }, + "knowledgeInfoCard": { # Represents info card response. If the response contains generative knowledge prediction, Dialogflow will return a payload with Infobot Messenger compatible info card. Otherwise, the info card response is skipped. # Represents info card for knowledge answers, to be better rendered in Dialogflow Messenger. + }, + "liveAgentHandoff": { # 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. # Hands off conversation to a human agent. + "metadata": { # Custom metadata for your handoff procedure. Dialogflow doesn't impose any structure on this. + "a_key": "", # Properties of the object. + }, + }, + "mixedAudio": { # 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. # Output only. An audio response message composed of both the synthesized Dialogflow agent responses and responses defined via play_audio. This message is generated by Dialogflow only and not supposed to be defined by the user. + "segments": [ # Segments this audio response is composed of. + { # Represents one segment of audio. + "allowPlaybackInterruption": True or False, # 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. + "audio": "A String", # Raw audio synthesized from the Dialogflow agent's response using the output config specified in the request. + "uri": "A String", # Client-specific URI that points to an audio clip accessible to the client. Dialogflow does not impose any validation on it. + }, + ], + }, + "outputAudioText": { # A text or ssml response that is preferentially used for TTS output audio synthesis, as described in the comment on the ResponseMessage message. # A text or ssml response that is preferentially used for TTS output audio synthesis, as described in the comment on the ResponseMessage message. + "allowPlaybackInterruption": True or False, # 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. + "ssml": "A String", # The SSML text to be synthesized. For more information, see [SSML](/speech/text-to-speech/docs/ssml). + "text": "A String", # The raw text to be synthesized. + }, + "payload": { # Returns a response containing a custom, platform-specific payload. + "a_key": "", # Properties of the object. + }, + "playAudio": { # Specifies an audio clip to be played by the client as part of the response. # Signal that the client should play an audio clip hosted at a client-specific URI. Dialogflow uses this to construct mixed_audio. However, Dialogflow itself does not try to read or process the URI in any way. + "allowPlaybackInterruption": True or False, # 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. + "audioUri": "A String", # Required. URI of the audio clip. Dialogflow does not impose any validation on this value. It is specific to the client that reads it. + }, + "telephonyTransferCall": { # Represents the signal that telles the client to transfer the phone call connected to the agent to a third-party endpoint. # A signal that the client should transfer the phone call connected to this agent to a third-party endpoint. + "phoneNumber": "A String", # Transfer the call to a phone number in [E.164 format](https://en.wikipedia.org/wiki/E.164). + }, + "text": { # The text response message. # Returns a text response. + "allowPlaybackInterruption": True or False, # 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. + "text": [ # Required. A collection of text responses. + "A String", + ], + }, + "toolCall": { # Represents a call of a specific tool's action with the specified inputs. # Returns the definition of a tool call that should be executed by the client. + "action": "A String", # Required. The name of the tool's action associated with this call. + "inputParameters": { # Optional. The action's input parameters. + "a_key": "", # Properties of the object. + }, + "tool": "A String", # Required. The tool associated with this call. Format: `projects//locations//agents//tools/`. }, - ], - }, - "outputAudioText": { # A text or ssml response that is preferentially used for TTS output audio synthesis, as described in the comment on the ResponseMessage message. # A text or ssml response that is preferentially used for TTS output audio synthesis, as described in the comment on the ResponseMessage message. - "allowPlaybackInterruption": True or False, # 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. - "ssml": "A String", # The SSML text to be synthesized. For more information, see [SSML](/speech/text-to-speech/docs/ssml). - "text": "A String", # The raw text to be synthesized. - }, - "payload": { # Returns a response containing a custom, platform-specific payload. - "a_key": "", # Properties of the object. - }, - "playAudio": { # Specifies an audio clip to be played by the client as part of the response. # Signal that the client should play an audio clip hosted at a client-specific URI. Dialogflow uses this to construct mixed_audio. However, Dialogflow itself does not try to read or process the URI in any way. - "allowPlaybackInterruption": True or False, # 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. - "audioUri": "A String", # Required. URI of the audio clip. Dialogflow does not impose any validation on this value. It is specific to the client that reads it. - }, - "telephonyTransferCall": { # Represents the signal that telles the client to transfer the phone call connected to the agent to a third-party endpoint. # A signal that the client should transfer the phone call connected to this agent to a third-party endpoint. - "phoneNumber": "A String", # Transfer the call to a phone number in [E.164 format](https://en.wikipedia.org/wiki/E.164). - }, - "text": { # The text response message. # Returns a text response. - "allowPlaybackInterruption": True or False, # 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. - "text": [ # Required. A collection of text responses. - "A String", - ], - }, - }, - ], - "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. # The sentiment analyss result, which depends on `analyze_query_text_sentiment`, specified in the request. - "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). - "score": 3.14, # Sentiment score between -1.0 (negative sentiment) and 1.0 (positive sentiment). - }, - "text": "A String", # If natural language text was provided as input, this field will contain a copy of the text. - "transcript": "A String", # If natural language speech audio was provided as input, this field will contain the transcript for the audio. - "triggerEvent": "A String", # If an event was provided as input, this field will contain the name of the event. - "triggerIntent": "A String", # If an intent was provided as input, this field will contain a copy of the intent identifier. Format: `projects//locations//agents//intents/`. - "webhookDisplayNames": [ # The list of webhook display names in the order of call sequence. - "A String", - ], - "webhookIds": [ # The list of webhook ids in the order of call sequence. - "A String", - ], - "webhookLatencies": [ # The list of webhook latencies in the order of call sequence. - "A String", - ], - "webhookPayloads": [ # The list of webhook payload in WebhookResponse.payload, in the order of call sequence. If some webhook call fails or doesn't return any payload, an empty `Struct` would be used instead. - { - "a_key": "", # Properties of the object. - }, - ], - "webhookStatuses": [ # The list of webhook call status in the order of call sequence. - { # 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). - "code": 42, # The status code, which should be an enum value of google.rpc.Code. - "details": [ # A list of messages that carry the error details. There is a common set of message types for APIs to use. - { - "a_key": "", # Properties of the object. Contains field @type with type URL. }, ], - "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. + "returnPartialResponses": True or False, # Whether Dialogflow should return currently queued fulfillment response messages in streaming APIs. If a webhook is specified, it happens before Dialogflow invokes webhook. Warning: 1) This flag only affects streaming API. Responses are still queued and returned once in non-streaming API. 2) The flag can be enabled in any fulfillment but only the first 3 partial responses will be returned. You may only want to apply it to fulfillments that have slow webhooks. + "setParameterActions": [ # Set parameter values before executing the webhook. + { # Setting a parameter value. + "parameter": "A String", # Display name of the parameter. + "value": "", # The new value of the parameter. A null value clears the parameter. + }, + ], + "tag": "A String", # The value of this field will be populated in the WebhookRequest `fulfillmentInfo.tag` field by Dialogflow when the associated webhook is called. The tag is typically used by the webhook service to identify which fulfillment is being called, but it could be used for other purposes. This field is required if `webhook` is specified. + "webhook": "A String", # The webhook to call. Format: `projects//locations//agents//webhooks/`. }, - ], - "webhookTags": [ # The list of webhook tags in the order of call sequence. - "A String", - ], - }, - "responseId": "A String", # Output only. The unique identifier of the response. It can be used to locate a response in the training example set or for reporting issues. - "responseType": "A String", # Response type. - }, - ], - "request": { # The request to detect user's intent. # The request of the interaction. - "outputAudioConfig": { # Instructs the speech synthesizer how to generate the output audio content. # Instructs the speech synthesizer how to generate the output audio. - "audioEncoding": "A String", # Required. Audio encoding of the synthesized audio content. - "sampleRateHertz": 42, # Optional. 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). - "synthesizeSpeechConfig": { # Configuration of how speech should be synthesized. # Optional. Configuration of how speech should be synthesized. If not specified, Agent.text_to_speech_settings is applied. - "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. - "A String", - ], - "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. - "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. - "voice": { # Description of which voice to use for speech synthesis. # Optional. The desired voice of the synthesized audio. - "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. For the list of available voices, please refer to [Supported voices and languages](https://cloud.google.com/text-to-speech/docs/voices). - "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. }, - "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. - }, - }, - "queryInput": { # Represents the query input. It can contain one of: 1. A conversational query in the form of text. 2. An intent query that specifies which intent to trigger. 3. Natural language speech audio to be processed. 4. An event to be triggered. 5. DTMF digits to invoke an intent and fill in parameter value. 6. The results of a tool executed by the client. # Required. The input specification. - "audio": { # Represents the natural speech audio to be processed. # The natural language speech audio to be processed. - "audio": "A String", # The natural language speech audio to be processed. A single request can contain up to 2 minutes of speech audio data. The transcribed text cannot contain more than 256 bytes. For non-streaming audio detect intent, both `config` and `audio` must be provided. For streaming audio detect intent, `config` must be provided in the first request and `audio` must be provided in all following requests. - "config": { # Instructs the speech recognizer on how to process the audio content. # Required. Instructs the speech recognizer how to process the speech audio. - "audioEncoding": "A String", # Required. Audio encoding of the audio content to process. - "bargeInConfig": { # Configuration of the barge-in behavior. Barge-in instructs the API to return a detected utterance at a proper time while the client is playing back the response audio from a previous request. When the client sees the utterance, it should stop the playback and immediately get ready for receiving the responses for the current request. The barge-in handling requires the client to start streaming audio input as soon as it starts playing back the audio from the previous response. The playback is modeled into two phases: * No barge-in phase: which goes first and during which speech detection should not be carried out. * Barge-in phase: which follows the no barge-in phase and during which the API starts speech detection and may inform the client that an utterance has been detected. Note that no-speech event is not expected in this phase. The client provides this configuration in terms of the durations of those two phases. The durations are measured in terms of the audio length from the the start of the input audio. No-speech event is a response with END_OF_UTTERANCE without any transcript following up. # Configuration of barge-in behavior during the streaming of input audio. - "noBargeInDuration": "A String", # Duration that is not eligible for barge-in at the beginning of the input audio. - "totalDuration": "A String", # Total duration for the playback at the beginning of the input audio. - }, - "enableWordInfo": True or False, # Optional. If `true`, Dialogflow returns SpeechWordInfo in StreamingRecognitionResult with information about the recognized speech words, e.g. start and end time offsets. If false or unspecified, Speech doesn't return any word-level information. - "model": "A String", # Optional. Which Speech model to select for the given request. For more information, see [Speech models](https://cloud.google.com/dialogflow/cx/docs/concept/speech-models). - "modelVariant": "A String", # Optional. Which variant of the Speech model to use. - "optOutConformerModelMigration": True or False, # If `true`, the request will opt out for STT conformer model migration. This field will be deprecated once force migration takes place in June 2024. Please refer to [Dialogflow CX Speech model migration](https://cloud.google.com/dialogflow/cx/docs/concept/speech-model-migration). - "phraseHints": [ # Optional. A list of strings containing words and phrases that the speech recognizer should recognize with higher likelihood. See [the Cloud Speech documentation](https://cloud.google.com/speech-to-text/docs/basics#phrase-hints) for more details. + "multiLanguageSettings": { # Settings for multi-lingual agents. # Optional. Multi-lingual agent settings for this flow. + "enableMultiLanguageDetection": True or False, # Optional. Enable multi-language detection for this flow. This can be set only if agent level multi language setting is enabled. + "supportedResponseLanguageCodes": [ # Optional. Agent will respond in the detected language if the detected language code is in the supported resolved languages for this flow. This will be used only if multi-language training is enabled in the agent and multi-language detection is enabled in the flow. The supported languages must be a subset of the languages supported by the agent. "A String", ], - "sampleRateHertz": 42, # Sample rate (in Hertz) of the audio content sent in the query. Refer to [Cloud Speech API documentation](https://cloud.google.com/speech-to-text/docs/basics) for more details. - "singleUtterance": True or False, # Optional. If `false` (default), recognition does not cease until the client closes the stream. If `true`, the recognizer will detect a single spoken utterance in input audio. Recognition ceases when it detects the audio's voice has stopped or paused. In this case, once a detected intent is received, the client should close the stream and start a new request with a new stream as needed. Note: This setting is relevant only for streaming methods. }, - }, - "dtmf": { # Represents the input for dtmf event. # The DTMF event to be handled. - "digits": "A String", # The dtmf digits. - "finishDigit": "A String", # The finish digit (if any). - }, - "event": { # Represents the event to trigger. # The event to be triggered. - "event": "A String", # Name of the event. - }, - "intent": { # Represents the intent to trigger programmatically rather than as a result of natural language processing. # The intent to be triggered. - "intent": "A String", # Required. The unique identifier of the intent. Format: `projects//locations//agents//intents/`. - }, - "languageCode": "A String", # Required. The language of the input. See [Language Support](https://cloud.google.com/dialogflow/cx/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. - "text": { # Represents the natural language text to be processed. # The natural language text to be processed. - "text": "A String", # Required. The UTF-8 encoded natural language text to be processed. - }, - }, - "queryParams": { # Represents the parameters of a conversational query. # The parameters of this query. - "analyzeQueryTextSentiment": True or False, # Configures whether sentiment analysis should be performed. If not provided, sentiment analysis is not performed. - "channel": "A String", # The channel which this query is for. If specified, only the ResponseMessage associated with the channel will be returned. If no ResponseMessage is associated with the channel, it falls back to the ResponseMessage with unspecified channel. If unspecified, the ResponseMessage with unspecified channel will be returned. - "currentPage": "A String", # The unique identifier of the page to override the current page in the session. Format: `projects//locations//agents//flows//pages/`. If `current_page` is specified, the previous state of the session will be ignored by Dialogflow, including the previous page and the previous session parameters. In most cases, current_page and parameters should be configured together to direct a session to a specific state. - "disableWebhook": True or False, # Whether to disable webhook calls for this request. - "endUserMetadata": { # Optional. Information about the end-user to improve the relevance and accuracy of generative answers. This will be interpreted and used by a language model, so, for good results, the data should be self-descriptive, and in a simple structure. Example: ```json { "subscription plan": "Business Premium Plus", "devices owned": [ {"model": "Google Pixel 7"}, {"model": "Google Pixel Tablet"} ] } ``` - "a_key": "", # Properties of the object. - }, - "flowVersions": [ # A list of flow versions to override for the request. Format: `projects//locations//agents//flows//versions/`. If version 1 of flow X is included in this list, the traffic of flow X will go through version 1 regardless of the version configuration in the environment. Each flow can have at most one version specified in this list. - "A String", - ], - "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. - "latitude": 3.14, # The latitude in degrees. It must be in the range [-90.0, +90.0]. - "longitude": 3.14, # The longitude in degrees. It must be in the range [-180.0, +180.0]. - }, - "parameters": { # Additional parameters to be put into session parameters. To remove a parameter from the session, clients should explicitly set the parameter value to null. You can reference the session parameters in the agent with the following format: $session.params.parameter-id. 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 then use map, otherwise, depending on the parameter value type, it could be one of string, number, boolean, null, list or map. * MapValue value: If parameter's entity type is a composite entity then use map from composite entity property names to property values, otherwise, use parameter value. - "a_key": "", # Properties of the object. - }, - "payload": { # This field can be used to pass custom data into the webhook associated with the agent. Arbitrary JSON objects are supported. Some integrations that query a Dialogflow agent may provide additional information in the payload. In particular, for the Dialogflow Phone Gateway integration, this field has the form: ``` { "telephony": { "caller_id": "+18558363987" } } ``` - "a_key": "", # Properties of the object. - }, - "populateDataStoreConnectionSignals": True or False, # Optional. If set to true and data stores are involved in serving the request then DetectIntentResponse.query_result.data_store_connection_signals will be filled with data that can help evaluations. - "searchConfig": { # Search configuration for UCS search queries. # Optional. Search configuration for UCS search queries. - "boostSpecs": [ # Optional. Boosting configuration for the datastores. - { # Boost specifications for data stores. - "dataStores": [ # Optional. Data Stores where the boosting configuration is applied. The full names of the referenced data stores. Formats: `projects/{project}/locations/{location}/collections/{collection}/dataStores/{data_store}` `projects/{project}/locations/{location}/dataStores/{data_store} - "A String", - ], - "spec": [ # Optional. A list of boosting specifications. - { # Boost specification to boost certain documents. A copy of google.cloud.discoveryengine.v1main.BoostSpec, field documentation is available at https://cloud.google.com/generative-ai-app-builder/docs/reference/rest/v1alpha/BoostSpec - "conditionBoostSpecs": [ # Optional. Condition boost specifications. If a document matches multiple conditions in the specifictions, boost scores from these specifications are all applied and combined in a non-linear way. Maximum number of specifications is 20. - { # Boost applies to documents which match a condition. - "boost": 3.14, # Optional. Strength of the condition boost, which should be in [-1, 1]. Negative boost means demotion. Default is 0.0. Setting to 1.0 gives the document a big promotion. However, it does not necessarily mean that the boosted document will be the top result at all times, nor that other documents will be excluded. Results could still be shown even when none of them matches the condition. And results that are significantly more relevant to the search query can still trump your heavily favored but irrelevant documents. Setting to -1.0 gives the document a big demotion. However, results that are deeply relevant might still be shown. The document will have an upstream battle to get a fairly high ranking, but it is not blocked out completely. Setting to 0.0 means no boost applied. The boosting condition is ignored. - "condition": "A String", # Optional. An expression which specifies a boost condition. The syntax and supported fields are the same as a filter expression. Examples: * To boost documents with document ID "doc_1" or "doc_2", and color "Red" or "Blue": * (id: ANY("doc_1", "doc_2")) AND (color: ANY("Red","Blue")) + "name": "A String", # The unique identifier of the flow. Format: `projects//locations//agents//flows/`. + "nluSettings": { # Settings related to NLU. # NLU related settings of the flow. + "classificationThreshold": 3.14, # To filter out false positive results and still get variety in matched natural language inputs for your agent, you can tune the machine learning classification threshold. If the returned score value is less than the threshold value, then a no-match event will be triggered. The score values range from 0.0 (completely uncertain) to 1.0 (completely certain). If set to 0.0, the default of 0.3 is used. + "modelTrainingMode": "A String", # Indicates NLU model training mode. + "modelType": "A String", # Indicates the type of NLU model. + }, + "transitionRouteGroups": [ # A flow's transition route group serve two purposes: * They are responsible for matching the user's first utterances in the flow. * They are inherited by every page's transition route groups. Transition route groups defined in the page have higher priority than those defined in the flow. Format:`projects//locations//agents//flows//transitionRouteGroups/` or `projects//locations//agents//transitionRouteGroups/` for agent-level groups. + "A String", + ], + "transitionRoutes": [ # A flow's transition routes serve two purposes: * They are responsible for matching the user's first utterances in the flow. * They are inherited by every page's transition routes and can support use cases such as the user saying "help" or "can I talk to a human?", which can be handled in a common way regardless of the current page. Transition routes defined in the page have higher priority than those defined in the flow. TransitionRoutes are evalauted in the following order: * TransitionRoutes with intent specified. * TransitionRoutes with only condition specified. TransitionRoutes with intent specified are inherited by pages in the flow. + { # A transition route specifies a intent that can be matched and/or a data condition that can be evaluated during a session. When a specified transition is matched, the following actions are taken in order: * If there is a `trigger_fulfillment` associated with the transition, it will be called. * If there is a `target_page` associated with the transition, the session will transition into the specified page. * If there is a `target_flow` associated with the transition, the session will transition into the specified flow. + "condition": "A String", # The condition to evaluate against form parameters or session parameters. See the [conditions reference](https://cloud.google.com/dialogflow/cx/docs/reference/condition). At least one of `intent` or `condition` must be specified. When both `intent` and `condition` are specified, the transition can only happen when both are fulfilled. + "description": "A String", # Optional. The description of the transition route. The maximum length is 500 characters. + "intent": "A String", # The unique identifier of an Intent. Format: `projects//locations//agents//intents/`. Indicates that the transition can only happen when the given intent is matched. At least one of `intent` or `condition` must be specified. When both `intent` and `condition` are specified, the transition can only happen when both are fulfilled. + "name": "A String", # Output only. The unique identifier of this transition route. + "targetFlow": "A String", # The target flow to transition to. Format: `projects//locations//agents//flows/`. + "targetPage": "A String", # The target page to transition to. Format: `projects//locations//agents//flows//pages/`. + "triggerFulfillment": { # A fulfillment can do one or more of the following actions at the same time: * Generate rich message responses. * Set parameter values. * Call the webhook. Fulfillments can be called at various stages in the Page or Form lifecycle. For example, when a DetectIntentRequest drives a session to enter a new page, the page's entry fulfillment can add a static response to the QueryResult in the returning DetectIntentResponse, call the webhook (for example, to load user data from a database), or both. # The fulfillment to call when the condition is satisfied. At least one of `trigger_fulfillment` and `target` must be specified. When both are defined, `trigger_fulfillment` is executed first. + "advancedSettings": { # Hierarchical advanced settings for agent/flow/page/fulfillment/parameter. Settings exposed at lower level overrides the settings exposed at higher level. Overriding occurs at the sub-setting level. For example, the playback_interruption_settings at fulfillment level only overrides the playback_interruption_settings at the agent level, leaving other settings at the agent level unchanged. DTMF settings does not override each other. DTMF settings set at different levels define DTMF detections running in parallel. Hierarchy: Agent->Flow->Page->Fulfillment/Parameter. # Hierarchical advanced settings for this fulfillment. The settings exposed at the lower level overrides the settings exposed at the higher level. + "audioExportGcsDestination": { # Google Cloud Storage location for a Dialogflow operation that writes or exports objects (e.g. exported agent or transcripts) outside of Dialogflow. # If present, incoming audio is exported by Dialogflow to the configured Google Cloud Storage destination. Exposed at the following levels: - Agent level - Flow level + "uri": "A String", # Required. The Google Cloud Storage URI for the exported objects. A URI is of the form: `gs://bucket/object-name-or-prefix` Whether a full object name, or just a prefix, its usage depends on the Dialogflow operation. + }, + "dtmfSettings": { # Define behaviors for DTMF (dual tone multi frequency). # Settings for DTMF. Exposed at the following levels: - Agent level - Flow level - Page level - Parameter level. + "enabled": True or False, # If true, incoming audio is processed for DTMF (dual tone multi frequency) events. For example, if the caller presses a button on their telephone keypad and DTMF processing is enabled, Dialogflow will detect the event (e.g. a "3" was pressed) in the incoming audio and pass the event to the bot to drive business logic (e.g. when 3 is pressed, return the account balance). + "endpointingTimeoutDuration": "A String", # Endpoint timeout setting for matching dtmf input to regex. + "finishDigit": "A String", # The digit that terminates a DTMF digit sequence. + "interdigitTimeoutDuration": "A String", # Interdigit timeout setting for matching dtmf input to regex. + "maxDigits": 42, # Max length of DTMF digits. + }, + "loggingSettings": { # Define behaviors on logging. # Settings for logging. Settings for Dialogflow History, Contact Center messages, StackDriver logs, and speech logging. Exposed at the following levels: - Agent level. + "enableInteractionLogging": True or False, # Enables DF Interaction logging. + "enableStackdriverLogging": True or False, # Enables StackDriver logging. + }, + "speechSettings": { # Define behaviors of speech to text detection. # Settings for speech to text detection. Exposed at the following levels: - Agent level - Flow level - Page level - Parameter level + "endpointerSensitivity": 42, # Sensitivity of the speech model that detects the end of speech. Scale from 0 to 100. + "models": { # Mapping from language to Speech-to-Text model. The mapped Speech-to-Text model will be selected for requests from its corresponding language. For more information, see [Speech models](https://cloud.google.com/dialogflow/cx/docs/concept/speech-models). + "a_key": "A String", + }, + "noSpeechTimeout": "A String", # Timeout before detecting no speech. + "useTimeoutBasedEndpointing": True or False, # Use timeout based endpointing, interpreting endpointer sensitivy as seconds of timeout value. + }, + }, + "conditionalCases": [ # Conditional cases for this fulfillment. + { # A list of cascading if-else conditions. Cases are mutually exclusive. The first one with a matching condition is selected, all the rest ignored. + "cases": [ # A list of cascading if-else conditions. + { # Each case has a Boolean condition. When it is evaluated to be True, the corresponding messages will be selected and evaluated recursively. + "caseContent": [ # A list of case content. + { # The list of messages or conditional cases to activate for this case. + "additionalCases": # Object with schema name: GoogleCloudDialogflowCxV3beta1FulfillmentConditionalCases # Additional cases to be evaluated. + "message": { # 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. # Returned message. + "channel": "A String", # The channel which the response is associated with. Clients can specify the channel via QueryParameters.channel, and only associated channel response will be returned. + "conversationSuccess": { # 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. # Indicates that the conversation succeeded. + "metadata": { # Custom metadata. Dialogflow doesn't impose any structure on this. + "a_key": "", # Properties of the object. + }, + }, + "endInteraction": { # 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. # Output only. A signal that indicates the interaction with the Dialogflow agent has ended. This message is generated by Dialogflow only when the conversation reaches `END_SESSION` page. It is not supposed to be defined by the user. It's guaranteed that there is at most one such message in each response. + }, + "knowledgeInfoCard": { # Represents info card response. If the response contains generative knowledge prediction, Dialogflow will return a payload with Infobot Messenger compatible info card. Otherwise, the info card response is skipped. # Represents info card for knowledge answers, to be better rendered in Dialogflow Messenger. + }, + "liveAgentHandoff": { # 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. # Hands off conversation to a human agent. + "metadata": { # Custom metadata for your handoff procedure. Dialogflow doesn't impose any structure on this. + "a_key": "", # Properties of the object. + }, + }, + "mixedAudio": { # 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. # Output only. An audio response message composed of both the synthesized Dialogflow agent responses and responses defined via play_audio. This message is generated by Dialogflow only and not supposed to be defined by the user. + "segments": [ # Segments this audio response is composed of. + { # Represents one segment of audio. + "allowPlaybackInterruption": True or False, # 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. + "audio": "A String", # Raw audio synthesized from the Dialogflow agent's response using the output config specified in the request. + "uri": "A String", # Client-specific URI that points to an audio clip accessible to the client. Dialogflow does not impose any validation on it. + }, + ], + }, + "outputAudioText": { # A text or ssml response that is preferentially used for TTS output audio synthesis, as described in the comment on the ResponseMessage message. # A text or ssml response that is preferentially used for TTS output audio synthesis, as described in the comment on the ResponseMessage message. + "allowPlaybackInterruption": True or False, # 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. + "ssml": "A String", # The SSML text to be synthesized. For more information, see [SSML](/speech/text-to-speech/docs/ssml). + "text": "A String", # The raw text to be synthesized. + }, + "payload": { # Returns a response containing a custom, platform-specific payload. + "a_key": "", # Properties of the object. + }, + "playAudio": { # Specifies an audio clip to be played by the client as part of the response. # Signal that the client should play an audio clip hosted at a client-specific URI. Dialogflow uses this to construct mixed_audio. However, Dialogflow itself does not try to read or process the URI in any way. + "allowPlaybackInterruption": True or False, # 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. + "audioUri": "A String", # Required. URI of the audio clip. Dialogflow does not impose any validation on this value. It is specific to the client that reads it. + }, + "telephonyTransferCall": { # Represents the signal that telles the client to transfer the phone call connected to the agent to a third-party endpoint. # A signal that the client should transfer the phone call connected to this agent to a third-party endpoint. + "phoneNumber": "A String", # Transfer the call to a phone number in [E.164 format](https://en.wikipedia.org/wiki/E.164). + }, + "text": { # The text response message. # Returns a text response. + "allowPlaybackInterruption": True or False, # 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. + "text": [ # Required. A collection of text responses. + "A String", + ], + }, + "toolCall": { # Represents a call of a specific tool's action with the specified inputs. # Returns the definition of a tool call that should be executed by the client. + "action": "A String", # Required. The name of the tool's action associated with this call. + "inputParameters": { # Optional. The action's input parameters. + "a_key": "", # Properties of the object. + }, + "tool": "A String", # Required. The tool associated with this call. Format: `projects//locations//agents//tools/`. + }, + }, + }, + ], + "condition": "A String", # The condition to activate and select this case. Empty means the condition is always true. The condition is evaluated against form parameters or session parameters. See the [conditions reference](https://cloud.google.com/dialogflow/cx/docs/reference/condition). + }, + ], + }, + ], + "enableGenerativeFallback": True or False, # If the flag is true, the agent will utilize LLM to generate a text response. If LLM generation fails, the defined responses in the fulfillment will be respected. This flag is only useful for fulfillments associated with no-match event handlers. + "messages": [ # The list of rich message responses to present to the user. + { # 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. + "channel": "A String", # The channel which the response is associated with. Clients can specify the channel via QueryParameters.channel, and only associated channel response will be returned. + "conversationSuccess": { # 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. # Indicates that the conversation succeeded. + "metadata": { # Custom metadata. Dialogflow doesn't impose any structure on this. + "a_key": "", # Properties of the object. + }, }, - ], - }, - ], - }, - ], - "filterSpecs": [ # Optional. Filter configuration for the datastores. - { # Filter specifications for data stores. - "dataStores": [ # Optional. Data Stores where the boosting configuration is applied. The full names of the referenced data stores. Formats: `projects/{project}/locations/{location}/collections/{collection}/dataStores/{data_store}` `projects/{project}/locations/{location}/dataStores/{data_store} - "A String", - ], - "filter": "A String", # Optional. The filter expression to be applied. Expression syntax is documented at https://cloud.google.com/generative-ai-app-builder/docs/filter-search-metadata#filter-expression-syntax - }, - ], - }, - "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. - { # Session entity types are referred to as **User** entity types and are entities that are built for an individual user such as favorites, preferences, playlists, and so on. You can redefine a session entity type at the session level to extend or replace a custom entity type at the user session level (we refer to the entity types defined at the agent level as "custom entity types"). Note: session entity types apply to all queries, regardless of the language. For more information about entity types, see the [Dialogflow documentation](https://cloud.google.com/dialogflow/docs/entities-overview). - "entities": [ # Required. The collection of entities to override or supplement the custom entity type. - { # An **entity entry** for an associated entity type. - "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`. - "A String", + "endInteraction": { # 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. # Output only. A signal that indicates the interaction with the Dialogflow agent has ended. This message is generated by Dialogflow only when the conversation reaches `END_SESSION` page. It is not supposed to be defined by the user. It's guaranteed that there is at most one such message in each response. + }, + "knowledgeInfoCard": { # Represents info card response. If the response contains generative knowledge prediction, Dialogflow will return a payload with Infobot Messenger compatible info card. Otherwise, the info card response is skipped. # Represents info card for knowledge answers, to be better rendered in Dialogflow Messenger. + }, + "liveAgentHandoff": { # 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. # Hands off conversation to a human agent. + "metadata": { # Custom metadata for your handoff procedure. Dialogflow doesn't impose any structure on this. + "a_key": "", # Properties of the object. + }, + }, + "mixedAudio": { # 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. # Output only. An audio response message composed of both the synthesized Dialogflow agent responses and responses defined via play_audio. This message is generated by Dialogflow only and not supposed to be defined by the user. + "segments": [ # Segments this audio response is composed of. + { # Represents one segment of audio. + "allowPlaybackInterruption": True or False, # 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. + "audio": "A String", # Raw audio synthesized from the Dialogflow agent's response using the output config specified in the request. + "uri": "A String", # Client-specific URI that points to an audio clip accessible to the client. Dialogflow does not impose any validation on it. + }, + ], + }, + "outputAudioText": { # A text or ssml response that is preferentially used for TTS output audio synthesis, as described in the comment on the ResponseMessage message. # A text or ssml response that is preferentially used for TTS output audio synthesis, as described in the comment on the ResponseMessage message. + "allowPlaybackInterruption": True or False, # 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. + "ssml": "A String", # The SSML text to be synthesized. For more information, see [SSML](/speech/text-to-speech/docs/ssml). + "text": "A String", # The raw text to be synthesized. + }, + "payload": { # Returns a response containing a custom, platform-specific payload. + "a_key": "", # Properties of the object. + }, + "playAudio": { # Specifies an audio clip to be played by the client as part of the response. # Signal that the client should play an audio clip hosted at a client-specific URI. Dialogflow uses this to construct mixed_audio. However, Dialogflow itself does not try to read or process the URI in any way. + "allowPlaybackInterruption": True or False, # 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. + "audioUri": "A String", # Required. URI of the audio clip. Dialogflow does not impose any validation on this value. It is specific to the client that reads it. + }, + "telephonyTransferCall": { # Represents the signal that telles the client to transfer the phone call connected to the agent to a third-party endpoint. # A signal that the client should transfer the phone call connected to this agent to a third-party endpoint. + "phoneNumber": "A String", # Transfer the call to a phone number in [E.164 format](https://en.wikipedia.org/wiki/E.164). + }, + "text": { # The text response message. # Returns a text response. + "allowPlaybackInterruption": True or False, # 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. + "text": [ # Required. A collection of text responses. + "A String", + ], + }, + "toolCall": { # Represents a call of a specific tool's action with the specified inputs. # Returns the definition of a tool call that should be executed by the client. + "action": "A String", # Required. The name of the tool's action associated with this call. + "inputParameters": { # Optional. The action's input parameters. + "a_key": "", # Properties of the object. + }, + "tool": "A String", # Required. The tool associated with this call. Format: `projects//locations//agents//tools/`. + }, + }, ], - "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 canonical 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). + "returnPartialResponses": True or False, # Whether Dialogflow should return currently queued fulfillment response messages in streaming APIs. If a webhook is specified, it happens before Dialogflow invokes webhook. Warning: 1) This flag only affects streaming API. Responses are still queued and returned once in non-streaming API. 2) The flag can be enabled in any fulfillment but only the first 3 partial responses will be returned. You may only want to apply it to fulfillments that have slow webhooks. + "setParameterActions": [ # Set parameter values before executing the webhook. + { # Setting a parameter value. + "parameter": "A String", # Display name of the parameter. + "value": "", # The new value of the parameter. A null value clears the parameter. + }, + ], + "tag": "A String", # The value of this field will be populated in the WebhookRequest `fulfillmentInfo.tag` field by Dialogflow when the associated webhook is called. The tag is typically used by the webhook service to identify which fulfillment is being called, but it could be used for other purposes. This field is required if `webhook` is specified. + "webhook": "A String", # The webhook to call. Format: `projects//locations//agents//webhooks/`. }, - ], - "entityOverrideMode": "A String", # Required. Indicates whether the additional data should override or supplement the custom entity type definition. - "name": "A String", # Required. The unique identifier of the session entity type. Format: `projects//locations//agents//sessions//entityTypes/` or `projects//locations//agents//environments//sessions//entityTypes/`. If `Environment ID` is not specified, we assume default 'draft' environment. - }, - ], - "sessionTtl": "A String", # Optional. Configure lifetime of the Dialogflow session. By default, a Dialogflow session remains active and its data is stored for 30 minutes after the last request is sent for the session. This value should be no longer than 1 day. - "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 the agent is used. - "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 Dialogflow web console. The headers defined within this field will overwrite the headers configured through 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. - "a_key": "A String", - }, - }, - "session": "A String", # Required. The name of the session this query is sent to. Format: `projects//locations//agents//sessions/` or `projects//locations//agents//environments//sessions/`. If `Environment ID` is not specified, we assume default 'draft' environment. It's up to the API caller to choose an appropriate `Session ID`. It can be a random number or some type of session identifiers (preferably hashed). The length of the `Session ID` must not exceed 36 characters. For more information, see the [sessions guide](https://cloud.google.com/dialogflow/cx/docs/concept/session). Note: Always use agent versions for production traffic. See [Versions and environments](https://cloud.google.com/dialogflow/cx/docs/concept/version). - }, - "requestUtterances": "A String", # The input text or the transcript of the input audio in the request. - "response": { # The message returned from the DetectIntent method. # The final response of the interaction. - "allowCancellation": True or False, # Indicates whether the partial response can be cancelled when a later response arrives. e.g. if the agent specified some music as partial response, it can be cancelled. - "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.response_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. - "outputAudioConfig": { # Instructs the speech synthesizer how to generate the output audio content. # The config used by the speech synthesizer to generate the output audio. - "audioEncoding": "A String", # Required. Audio encoding of the synthesized audio content. - "sampleRateHertz": 42, # Optional. 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). - "synthesizeSpeechConfig": { # Configuration of how speech should be synthesized. # Optional. Configuration of how speech should be synthesized. If not specified, Agent.text_to_speech_settings is applied. - "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. - "A String", - ], - "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. - "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. - "voice": { # Description of which voice to use for speech synthesis. # Optional. The desired voice of the synthesized audio. - "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. For the list of available voices, please refer to [Supported voices and languages](https://cloud.google.com/text-to-speech/docs/voices). - "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. - }, - "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. - }, - }, - "queryResult": { # Represents the result of a conversational query. # The result of the conversational query. - "advancedSettings": { # Hierarchical advanced settings for agent/flow/page/fulfillment/parameter. Settings exposed at lower level overrides the settings exposed at higher level. Overriding occurs at the sub-setting level. For example, the playback_interruption_settings at fulfillment level only overrides the playback_interruption_settings at the agent level, leaving other settings at the agent level unchanged. DTMF settings does not override each other. DTMF settings set at different levels define DTMF detections running in parallel. Hierarchy: Agent->Flow->Page->Fulfillment/Parameter. # Returns the current advanced settings including IVR settings. Even though the operations configured by these settings are performed by Dialogflow, the client may need to perform special logic at the moment. For example, if Dialogflow exports audio to Google Cloud Storage, then the client may need to wait for the resulting object to appear in the bucket before proceeding. - "audioExportGcsDestination": { # Google Cloud Storage location for a Dialogflow operation that writes or exports objects (e.g. exported agent or transcripts) outside of Dialogflow. # If present, incoming audio is exported by Dialogflow to the configured Google Cloud Storage destination. Exposed at the following levels: - Agent level - Flow level - "uri": "A String", # Required. The Google Cloud Storage URI for the exported objects. A URI is of the form: `gs://bucket/object-name-or-prefix` Whether a full object name, or just a prefix, its usage depends on the Dialogflow operation. - }, - "dtmfSettings": { # Define behaviors for DTMF (dual tone multi frequency). # Settings for DTMF. Exposed at the following levels: - Agent level - Flow level - Page level - Parameter level. - "enabled": True or False, # If true, incoming audio is processed for DTMF (dual tone multi frequency) events. For example, if the caller presses a button on their telephone keypad and DTMF processing is enabled, Dialogflow will detect the event (e.g. a "3" was pressed) in the incoming audio and pass the event to the bot to drive business logic (e.g. when 3 is pressed, return the account balance). - "endpointingTimeoutDuration": "A String", # Endpoint timeout setting for matching dtmf input to regex. - "finishDigit": "A String", # The digit that terminates a DTMF digit sequence. - "interdigitTimeoutDuration": "A String", # Interdigit timeout setting for matching dtmf input to regex. - "maxDigits": 42, # Max length of DTMF digits. - }, - "loggingSettings": { # Define behaviors on logging. # Settings for logging. Settings for Dialogflow History, Contact Center messages, StackDriver logs, and speech logging. Exposed at the following levels: - Agent level. - "enableInteractionLogging": True or False, # If true, DF Interaction logging is currently enabled. - "enableStackdriverLogging": True or False, # If true, StackDriver logging is currently enabled. - }, - "speechSettings": { # Define behaviors of speech to text detection. # Settings for speech to text detection. Exposed at the following levels: - Agent level - Flow level - Page level - Parameter level - "endpointerSensitivity": 42, # Sensitivity of the speech model that detects the end of speech. Scale from 0 to 100. - "models": { # Mapping from language to Speech-to-Text model. The mapped Speech-to-Text model will be selected for requests from its corresponding language. For more information, see [Speech models](https://cloud.google.com/dialogflow/cx/docs/concept/speech-models). - "a_key": "A String", }, - "noSpeechTimeout": "A String", # Timeout before detecting no speech. - "useTimeoutBasedEndpointing": True or False, # Use timeout based endpointing, interpreting endpointer sensitivy as seconds of timeout value. - }, + ], }, - "allowAnswerFeedback": True or False, # Indicates whether the Thumbs up/Thumbs down rating controls are need to be shown for the response in the Dialogflow Messenger widget. "currentPage": { # A Dialogflow CX conversation (session) can be described and visualized as a state machine. The states of a CX session are represented by pages. For each flow, you define many pages, where your combined pages can handle a complete conversation on the topics the flow is designed for. At any given moment, exactly one page is the current page, the current page is considered active, and the flow associated with that page is considered active. Every flow has a special start page. When a flow initially becomes active, the start page page becomes the current page. For each conversational turn, the current page will either stay the same or transition to another page. You configure each page to collect information from the end-user that is relevant for the conversational state represented by the page. For more information, see the [Page guide](https://cloud.google.com/dialogflow/cx/docs/concept/page). # The current Page. Some, not all fields are filled in this message, including but not limited to `name` and `display_name`. "advancedSettings": { # Hierarchical advanced settings for agent/flow/page/fulfillment/parameter. Settings exposed at lower level overrides the settings exposed at higher level. Overriding occurs at the sub-setting level. For example, the playback_interruption_settings at fulfillment level only overrides the playback_interruption_settings at the agent level, leaving other settings at the agent level unchanged. DTMF settings does not override each other. DTMF settings set at different levels define DTMF detections running in parallel. Hierarchy: Agent->Flow->Page->Fulfillment/Parameter. # Hierarchical advanced settings for this page. The settings exposed at the lower level overrides the settings exposed at the higher level. "audioExportGcsDestination": { # Google Cloud Storage location for a Dialogflow operation that writes or exports objects (e.g. exported agent or transcripts) outside of Dialogflow. # If present, incoming audio is exported by Dialogflow to the configured Google Cloud Storage destination. Exposed at the following levels: - Agent level - Flow level @@ -6486,8 +9384,8 @@

Method Details

"maxDigits": 42, # Max length of DTMF digits. }, "loggingSettings": { # Define behaviors on logging. # Settings for logging. Settings for Dialogflow History, Contact Center messages, StackDriver logs, and speech logging. Exposed at the following levels: - Agent level. - "enableInteractionLogging": True or False, # If true, DF Interaction logging is currently enabled. - "enableStackdriverLogging": True or False, # If true, StackDriver logging is currently enabled. + "enableInteractionLogging": True or False, # Enables DF Interaction logging. + "enableStackdriverLogging": True or False, # Enables StackDriver logging. }, "speechSettings": { # Define behaviors of speech to text detection. # Settings for speech to text detection. Exposed at the following levels: - Agent level - Flow level - Page level - Parameter level "endpointerSensitivity": 42, # Sensitivity of the speech model that detects the end of speech. Scale from 0 to 100. @@ -6513,8 +9411,8 @@

Method Details

"maxDigits": 42, # Max length of DTMF digits. }, "loggingSettings": { # Define behaviors on logging. # Settings for logging. Settings for Dialogflow History, Contact Center messages, StackDriver logs, and speech logging. Exposed at the following levels: - Agent level. - "enableInteractionLogging": True or False, # If true, DF Interaction logging is currently enabled. - "enableStackdriverLogging": True or False, # If true, StackDriver logging is currently enabled. + "enableInteractionLogging": True or False, # Enables DF Interaction logging. + "enableStackdriverLogging": True or False, # Enables StackDriver logging. }, "speechSettings": { # Define behaviors of speech to text detection. # Settings for speech to text detection. Exposed at the following levels: - Agent level - Flow level - Page level - Parameter level "endpointerSensitivity": 42, # Sensitivity of the speech model that detects the end of speech. Scale from 0 to 100. @@ -6578,6 +9476,13 @@

Method Details

"A String", ], }, + "toolCall": { # Represents a call of a specific tool's action with the specified inputs. # Returns the definition of a tool call that should be executed by the client. + "action": "A String", # Required. The name of the tool's action associated with this call. + "inputParameters": { # Optional. The action's input parameters. + "a_key": "", # Properties of the object. + }, + "tool": "A String", # Required. The tool associated with this call. Format: `projects//locations//agents//tools/`. + }, }, }, ], @@ -6634,6 +9539,13 @@

Method Details

"A String", ], }, + "toolCall": { # Represents a call of a specific tool's action with the specified inputs. # Returns the definition of a tool call that should be executed by the client. + "action": "A String", # Required. The name of the tool's action associated with this call. + "inputParameters": { # Optional. The action's input parameters. + "a_key": "", # Properties of the object. + }, + "tool": "A String", # Required. The tool associated with this call. Format: `projects//locations//agents//tools/`. + }, }, ], "returnPartialResponses": True or False, # Whether Dialogflow should return currently queued fulfillment response messages in streaming APIs. If a webhook is specified, it happens before Dialogflow invokes webhook. Warning: 1) This flag only affects streaming API. Responses are still queued and returned once in non-streaming API. 2) The flag can be enabled in any fulfillment but only the first 3 partial responses will be returned. You may only want to apply it to fulfillments that have slow webhooks. @@ -6665,8 +9577,8 @@

Method Details

"maxDigits": 42, # Max length of DTMF digits. }, "loggingSettings": { # Define behaviors on logging. # Settings for logging. Settings for Dialogflow History, Contact Center messages, StackDriver logs, and speech logging. Exposed at the following levels: - Agent level. - "enableInteractionLogging": True or False, # If true, DF Interaction logging is currently enabled. - "enableStackdriverLogging": True or False, # If true, StackDriver logging is currently enabled. + "enableInteractionLogging": True or False, # Enables DF Interaction logging. + "enableStackdriverLogging": True or False, # Enables StackDriver logging. }, "speechSettings": { # Define behaviors of speech to text detection. # Settings for speech to text detection. Exposed at the following levels: - Agent level - Flow level - Page level - Parameter level "endpointerSensitivity": 42, # Sensitivity of the speech model that detects the end of speech. Scale from 0 to 100. @@ -6730,6 +9642,13 @@

Method Details

"A String", ], }, + "toolCall": { # Represents a call of a specific tool's action with the specified inputs. # Returns the definition of a tool call that should be executed by the client. + "action": "A String", # Required. The name of the tool's action associated with this call. + "inputParameters": { # Optional. The action's input parameters. + "a_key": "", # Properties of the object. + }, + "tool": "A String", # Required. The tool associated with this call. Format: `projects//locations//agents//tools/`. + }, }, }, ], @@ -6786,6 +9705,13 @@

Method Details

"A String", ], }, + "toolCall": { # Represents a call of a specific tool's action with the specified inputs. # Returns the definition of a tool call that should be executed by the client. + "action": "A String", # Required. The name of the tool's action associated with this call. + "inputParameters": { # Optional. The action's input parameters. + "a_key": "", # Properties of the object. + }, + "tool": "A String", # Required. The tool associated with this call. Format: `projects//locations//agents//tools/`. + }, }, ], "returnPartialResponses": True or False, # Whether Dialogflow should return currently queued fulfillment response messages in streaming APIs. If a webhook is specified, it happens before Dialogflow invokes webhook. Warning: 1) This flag only affects streaming API. Responses are still queued and returned once in non-streaming API. 2) The flag can be enabled in any fulfillment but only the first 3 partial responses will be returned. You may only want to apply it to fulfillments that have slow webhooks. @@ -6815,8 +9741,8 @@

Method Details

"maxDigits": 42, # Max length of DTMF digits. }, "loggingSettings": { # Define behaviors on logging. # Settings for logging. Settings for Dialogflow History, Contact Center messages, StackDriver logs, and speech logging. Exposed at the following levels: - Agent level. - "enableInteractionLogging": True or False, # If true, DF Interaction logging is currently enabled. - "enableStackdriverLogging": True or False, # If true, StackDriver logging is currently enabled. + "enableInteractionLogging": True or False, # Enables DF Interaction logging. + "enableStackdriverLogging": True or False, # Enables StackDriver logging. }, "speechSettings": { # Define behaviors of speech to text detection. # Settings for speech to text detection. Exposed at the following levels: - Agent level - Flow level - Page level - Parameter level "endpointerSensitivity": 42, # Sensitivity of the speech model that detects the end of speech. Scale from 0 to 100. @@ -6844,8 +9770,8 @@

Method Details

"maxDigits": 42, # Max length of DTMF digits. }, "loggingSettings": { # Define behaviors on logging. # Settings for logging. Settings for Dialogflow History, Contact Center messages, StackDriver logs, and speech logging. Exposed at the following levels: - Agent level. - "enableInteractionLogging": True or False, # If true, DF Interaction logging is currently enabled. - "enableStackdriverLogging": True or False, # If true, StackDriver logging is currently enabled. + "enableInteractionLogging": True or False, # Enables DF Interaction logging. + "enableStackdriverLogging": True or False, # Enables StackDriver logging. }, "speechSettings": { # Define behaviors of speech to text detection. # Settings for speech to text detection. Exposed at the following levels: - Agent level - Flow level - Page level - Parameter level "endpointerSensitivity": 42, # Sensitivity of the speech model that detects the end of speech. Scale from 0 to 100. @@ -6909,6 +9835,13 @@

Method Details

"A String", ], }, + "toolCall": { # Represents a call of a specific tool's action with the specified inputs. # Returns the definition of a tool call that should be executed by the client. + "action": "A String", # Required. The name of the tool's action associated with this call. + "inputParameters": { # Optional. The action's input parameters. + "a_key": "", # Properties of the object. + }, + "tool": "A String", # Required. The tool associated with this call. Format: `projects//locations//agents//tools/`. + }, }, }, ], @@ -6965,6 +9898,13 @@

Method Details

"A String", ], }, + "toolCall": { # Represents a call of a specific tool's action with the specified inputs. # Returns the definition of a tool call that should be executed by the client. + "action": "A String", # Required. The name of the tool's action associated with this call. + "inputParameters": { # Optional. The action's input parameters. + "a_key": "", # Properties of the object. + }, + "tool": "A String", # Required. The tool associated with this call. Format: `projects//locations//agents//tools/`. + }, }, ], "returnPartialResponses": True or False, # Whether Dialogflow should return currently queued fulfillment response messages in streaming APIs. If a webhook is specified, it happens before Dialogflow invokes webhook. Warning: 1) This flag only affects streaming API. Responses are still queued and returned once in non-streaming API. 2) The flag can be enabled in any fulfillment but only the first 3 partial responses will be returned. You may only want to apply it to fulfillments that have slow webhooks. @@ -6996,8 +9936,8 @@

Method Details

"maxDigits": 42, # Max length of DTMF digits. }, "loggingSettings": { # Define behaviors on logging. # Settings for logging. Settings for Dialogflow History, Contact Center messages, StackDriver logs, and speech logging. Exposed at the following levels: - Agent level. - "enableInteractionLogging": True or False, # If true, DF Interaction logging is currently enabled. - "enableStackdriverLogging": True or False, # If true, StackDriver logging is currently enabled. + "enableInteractionLogging": True or False, # Enables DF Interaction logging. + "enableStackdriverLogging": True or False, # Enables StackDriver logging. }, "speechSettings": { # Define behaviors of speech to text detection. # Settings for speech to text detection. Exposed at the following levels: - Agent level - Flow level - Page level - Parameter level "endpointerSensitivity": 42, # Sensitivity of the speech model that detects the end of speech. Scale from 0 to 100. @@ -7061,6 +10001,13 @@

Method Details

"A String", ], }, + "toolCall": { # Represents a call of a specific tool's action with the specified inputs. # Returns the definition of a tool call that should be executed by the client. + "action": "A String", # Required. The name of the tool's action associated with this call. + "inputParameters": { # Optional. The action's input parameters. + "a_key": "", # Properties of the object. + }, + "tool": "A String", # Required. The tool associated with this call. Format: `projects//locations//agents//tools/`. + }, }, }, ], @@ -7117,6 +10064,13 @@

Method Details

"A String", ], }, + "toolCall": { # Represents a call of a specific tool's action with the specified inputs. # Returns the definition of a tool call that should be executed by the client. + "action": "A String", # Required. The name of the tool's action associated with this call. + "inputParameters": { # Optional. The action's input parameters. + "a_key": "", # Properties of the object. + }, + "tool": "A String", # Required. The tool associated with this call. Format: `projects//locations//agents//tools/`. + }, }, ], "returnPartialResponses": True or False, # Whether Dialogflow should return currently queued fulfillment response messages in streaming APIs. If a webhook is specified, it happens before Dialogflow invokes webhook. Warning: 1) This flag only affects streaming API. Responses are still queued and returned once in non-streaming API. 2) The flag can be enabled in any fulfillment but only the first 3 partial responses will be returned. You may only want to apply it to fulfillments that have slow webhooks. @@ -7161,8 +10115,8 @@

Method Details

"maxDigits": 42, # Max length of DTMF digits. }, "loggingSettings": { # Define behaviors on logging. # Settings for logging. Settings for Dialogflow History, Contact Center messages, StackDriver logs, and speech logging. Exposed at the following levels: - Agent level. - "enableInteractionLogging": True or False, # If true, DF Interaction logging is currently enabled. - "enableStackdriverLogging": True or False, # If true, StackDriver logging is currently enabled. + "enableInteractionLogging": True or False, # Enables DF Interaction logging. + "enableStackdriverLogging": True or False, # Enables StackDriver logging. }, "speechSettings": { # Define behaviors of speech to text detection. # Settings for speech to text detection. Exposed at the following levels: - Agent level - Flow level - Page level - Parameter level "endpointerSensitivity": 42, # Sensitivity of the speech model that detects the end of speech. Scale from 0 to 100. @@ -7226,6 +10180,13 @@

Method Details

"A String", ], }, + "toolCall": { # Represents a call of a specific tool's action with the specified inputs. # Returns the definition of a tool call that should be executed by the client. + "action": "A String", # Required. The name of the tool's action associated with this call. + "inputParameters": { # Optional. The action's input parameters. + "a_key": "", # Properties of the object. + }, + "tool": "A String", # Required. The tool associated with this call. Format: `projects//locations//agents//tools/`. + }, }, }, ], @@ -7282,6 +10243,13 @@

Method Details

"A String", ], }, + "toolCall": { # Represents a call of a specific tool's action with the specified inputs. # Returns the definition of a tool call that should be executed by the client. + "action": "A String", # Required. The name of the tool's action associated with this call. + "inputParameters": { # Optional. The action's input parameters. + "a_key": "", # Properties of the object. + }, + "tool": "A String", # Required. The tool associated with this call. Format: `projects//locations//agents//tools/`. + }, }, ], "returnPartialResponses": True or False, # Whether Dialogflow should return currently queued fulfillment response messages in streaming APIs. If a webhook is specified, it happens before Dialogflow invokes webhook. Warning: 1) This flag only affects streaming API. Responses are still queued and returned once in non-streaming API. 2) The flag can be enabled in any fulfillment but only the first 3 partial responses will be returned. You may only want to apply it to fulfillments that have slow webhooks. @@ -7320,8 +10288,8 @@

Method Details

"maxDigits": 42, # Max length of DTMF digits. }, "loggingSettings": { # Define behaviors on logging. # Settings for logging. Settings for Dialogflow History, Contact Center messages, StackDriver logs, and speech logging. Exposed at the following levels: - Agent level. - "enableInteractionLogging": True or False, # If true, DF Interaction logging is currently enabled. - "enableStackdriverLogging": True or False, # If true, StackDriver logging is currently enabled. + "enableInteractionLogging": True or False, # Enables DF Interaction logging. + "enableStackdriverLogging": True or False, # Enables StackDriver logging. }, "speechSettings": { # Define behaviors of speech to text detection. # Settings for speech to text detection. Exposed at the following levels: - Agent level - Flow level - Page level - Parameter level "endpointerSensitivity": 42, # Sensitivity of the speech model that detects the end of speech. Scale from 0 to 100. @@ -7385,6 +10353,13 @@

Method Details

"A String", ], }, + "toolCall": { # Represents a call of a specific tool's action with the specified inputs. # Returns the definition of a tool call that should be executed by the client. + "action": "A String", # Required. The name of the tool's action associated with this call. + "inputParameters": { # Optional. The action's input parameters. + "a_key": "", # Properties of the object. + }, + "tool": "A String", # Required. The tool associated with this call. Format: `projects//locations//agents//tools/`. + }, }, }, ], @@ -7441,6 +10416,13 @@

Method Details

"A String", ], }, + "toolCall": { # Represents a call of a specific tool's action with the specified inputs. # Returns the definition of a tool call that should be executed by the client. + "action": "A String", # Required. The name of the tool's action associated with this call. + "inputParameters": { # Optional. The action's input parameters. + "a_key": "", # Properties of the object. + }, + "tool": "A String", # Required. The tool associated with this call. Format: `projects//locations//agents//tools/`. + }, }, ], "returnPartialResponses": True or False, # Whether Dialogflow should return currently queued fulfillment response messages in streaming APIs. If a webhook is specified, it happens before Dialogflow invokes webhook. Warning: 1) This flag only affects streaming API. Responses are still queued and returned once in non-streaming API. 2) The flag can be enabled in any fulfillment but only the first 3 partial responses will be returned. You may only want to apply it to fulfillments that have slow webhooks. @@ -7509,6 +10491,79 @@

Method Details

"digits": "A String", # The dtmf digits. "finishDigit": "A String", # The finish digit (if any). }, + "generativeInfo": { # Represents the information of a query if handled by generative agent resources. # The information of a query if handled by generative agent resources. + "actionTracingInfo": { # Example represents a sample execution of the playbook in the conversation. An example consists of a list of ordered actions performed by end user or Dialogflow agent according the playbook instructions to fulfill the task. # The actions performed by the generative playbook for the current agent response. + "actions": [ # Required. The ordered list of actions performed by the end user and the Dialogflow agent. + { # Action performed by end user or Dialogflow agent in the conversation. + "agentUtterance": { # AgentUtterance represents one message sent by the agent. # Optional. Action performed by the agent as a message. + "text": "A String", # Required. Message content in text. + }, + "flowInvocation": { # Stores metadata of the invocation of a CX flow. Next Id: 7 # Optional. Action performed on behalf of the agent by invoking a CX flow. + "flow": "A String", # Required. The unique identifier of the flow. Format: `projects//locations//agents/`. + "flowState": "A String", # Required. Flow invocation's output state. + "inputActionParameters": { # Optional. A list of input parameters for the flow. + "a_key": "", # Properties of the object. + }, + "outputActionParameters": { # Optional. A list of output parameters generated by the flow invocation. + "a_key": "", # Properties of the object. + }, + }, + "playbookInvocation": { # Stores metadata of the invocation of a child playbook. Next Id: 5 # Optional. Action performed on behalf of the agent by invoking a child playbook. + "playbook": "A String", # Required. The unique identifier of the playbook. Format: `projects//locations//agents//playbooks/`. + "playbookInput": { # Input of the playbook. # Optional. Input of the child playbook invocation. + "actionParameters": { # Optional. A list of input parameters for the action. + "a_key": "", # Properties of the object. + }, + "precedingConversationSummary": "A String", # Optional. Summary string of the preceding conversation for the child playbook invocation. + }, + "playbookOutput": { # Output of the playbook. # Optional. Output of the child playbook invocation. + "actionParameters": { # Optional. A Struct object of output parameters for the action. + "a_key": "", # Properties of the object. + }, + "executionSummary": "A String", # Optional. Summary string of the execution result of the child playbook. + }, + "playbookState": "A String", # Required. Playbook invocation's output state. + }, + "toolUse": { # Stores metadata of the invocation of an action supported by a tool. # Optional. Action performed on behalf of the agent by calling a plugin tool. + "action": "A String", # Optional. Name of the action to be called during the tool use. + "inputActionParameters": { # Optional. A list of input parameters for the action. + "a_key": "", # Properties of the object. + }, + "outputActionParameters": { # Optional. A list of output parameters generated by the action. + "a_key": "", # Properties of the object. + }, + "tool": "A String", # Required. The tool that should be used. Format: `projects//locations//agents//tools/`. + }, + "userUtterance": { # UserUtterance represents one message sent by the customer. # Optional. Agent obtained a message from the customer. + "text": "A String", # Required. Message content in text. + }, + }, + ], + "conversationState": "A String", # Required. Example's output state. + "createTime": "A String", # Output only. The timestamp of initial example creation. + "description": "A String", # Optional. The high level concise description of the example. The max number of characters is 200. + "displayName": "A String", # Required. The display name of the example. + "languageCode": "A String", # Optional. The language code of the example. If not specified, the agent's default language is used. Note: languages must be enabled in the agent before they can be used. + "name": "A String", # The unique identifier of the playbook example. Format: `projects//locations//agents//playbooks//examples/`. + "playbookInput": { # Input of the playbook. # Optional. The input to the playbook in the example. + "actionParameters": { # Optional. A list of input parameters for the action. + "a_key": "", # Properties of the object. + }, + "precedingConversationSummary": "A String", # Optional. Summary string of the preceding conversation for the child playbook invocation. + }, + "playbookOutput": { # Output of the playbook. # Optional. The output of the playbook in the example. + "actionParameters": { # Optional. A Struct object of output parameters for the action. + "a_key": "", # Properties of the object. + }, + "executionSummary": "A String", # Optional. Summary string of the execution result of the child playbook. + }, + "tokenCount": "A String", # Output only. Estimated number of tokes current example takes when sent to the LLM. + "updateTime": "A String", # Output only. Last time the example was updated. + }, + "currentPlaybooks": [ # The stack of playbooks that the conversation has currently entered, with the most recent one on the top. + "A String", + ], + }, "intent": { # An intent represents a user's intent to interact with a conversational agent. You can provide information for the Dialogflow API to use to match user input to an intent by adding training phrases (i.e., examples of user input) to your intent. # The Intent that matched the conversational query. Some, not all fields are filled in this message, including but not limited to: `name` and `display_name`. This field is deprecated, please use QueryResult.match instead. "description": "A String", # Human readable description for better understanding an intent like its scope, content, result etc. Maximum character limit: 140 characters. "displayName": "A String", # Required. The human-readable name of the intent, unique within the agent. @@ -7630,6 +10685,13 @@

Method Details

"A String", ], }, + "toolCall": { # Represents a call of a specific tool's action with the specified inputs. # Returns the definition of a tool call that should be executed by the client. + "action": "A String", # Required. The name of the tool's action associated with this call. + "inputParameters": { # Optional. The action's input parameters. + "a_key": "", # Properties of the object. + }, + "tool": "A String", # Required. The tool associated with this call. Format: `projects//locations//agents//tools/`. + }, }, ], "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. # The sentiment analyss result, which depends on `analyze_query_text_sentiment`, specified in the request. @@ -7716,8 +10778,8 @@

Method Details

"maxDigits": 42, # Max length of DTMF digits. }, "loggingSettings": { # Define behaviors on logging. # Settings for logging. Settings for Dialogflow History, Contact Center messages, StackDriver logs, and speech logging. Exposed at the following levels: - Agent level. - "enableInteractionLogging": True or False, # If true, DF Interaction logging is currently enabled. - "enableStackdriverLogging": True or False, # If true, StackDriver logging is currently enabled. + "enableInteractionLogging": True or False, # Enables DF Interaction logging. + "enableStackdriverLogging": True or False, # Enables StackDriver logging. }, "speechSettings": { # Define behaviors of speech to text detection. # Settings for speech to text detection. Exposed at the following levels: - Agent level - Flow level - Page level - Parameter level "endpointerSensitivity": 42, # Sensitivity of the speech model that detects the end of speech. Scale from 0 to 100. @@ -7743,8 +10805,8 @@

Method Details

"maxDigits": 42, # Max length of DTMF digits. }, "loggingSettings": { # Define behaviors on logging. # Settings for logging. Settings for Dialogflow History, Contact Center messages, StackDriver logs, and speech logging. Exposed at the following levels: - Agent level. - "enableInteractionLogging": True or False, # If true, DF Interaction logging is currently enabled. - "enableStackdriverLogging": True or False, # If true, StackDriver logging is currently enabled. + "enableInteractionLogging": True or False, # Enables DF Interaction logging. + "enableStackdriverLogging": True or False, # Enables StackDriver logging. }, "speechSettings": { # Define behaviors of speech to text detection. # Settings for speech to text detection. Exposed at the following levels: - Agent level - Flow level - Page level - Parameter level "endpointerSensitivity": 42, # Sensitivity of the speech model that detects the end of speech. Scale from 0 to 100. @@ -7808,6 +10870,13 @@

Method Details

"A String", ], }, + "toolCall": { # Represents a call of a specific tool's action with the specified inputs. # Returns the definition of a tool call that should be executed by the client. + "action": "A String", # Required. The name of the tool's action associated with this call. + "inputParameters": { # Optional. The action's input parameters. + "a_key": "", # Properties of the object. + }, + "tool": "A String", # Required. The tool associated with this call. Format: `projects//locations//agents//tools/`. + }, }, }, ], @@ -7864,6 +10933,13 @@

Method Details

"A String", ], }, + "toolCall": { # Represents a call of a specific tool's action with the specified inputs. # Returns the definition of a tool call that should be executed by the client. + "action": "A String", # Required. The name of the tool's action associated with this call. + "inputParameters": { # Optional. The action's input parameters. + "a_key": "", # Properties of the object. + }, + "tool": "A String", # Required. The tool associated with this call. Format: `projects//locations//agents//tools/`. + }, }, ], "returnPartialResponses": True or False, # Whether Dialogflow should return currently queued fulfillment response messages in streaming APIs. If a webhook is specified, it happens before Dialogflow invokes webhook. Warning: 1) This flag only affects streaming API. Responses are still queued and returned once in non-streaming API. 2) The flag can be enabled in any fulfillment but only the first 3 partial responses will be returned. You may only want to apply it to fulfillments that have slow webhooks. @@ -7895,8 +10971,8 @@

Method Details

"maxDigits": 42, # Max length of DTMF digits. }, "loggingSettings": { # Define behaviors on logging. # Settings for logging. Settings for Dialogflow History, Contact Center messages, StackDriver logs, and speech logging. Exposed at the following levels: - Agent level. - "enableInteractionLogging": True or False, # If true, DF Interaction logging is currently enabled. - "enableStackdriverLogging": True or False, # If true, StackDriver logging is currently enabled. + "enableInteractionLogging": True or False, # Enables DF Interaction logging. + "enableStackdriverLogging": True or False, # Enables StackDriver logging. }, "speechSettings": { # Define behaviors of speech to text detection. # Settings for speech to text detection. Exposed at the following levels: - Agent level - Flow level - Page level - Parameter level "endpointerSensitivity": 42, # Sensitivity of the speech model that detects the end of speech. Scale from 0 to 100. @@ -7960,6 +11036,13 @@

Method Details

"A String", ], }, + "toolCall": { # Represents a call of a specific tool's action with the specified inputs. # Returns the definition of a tool call that should be executed by the client. + "action": "A String", # Required. The name of the tool's action associated with this call. + "inputParameters": { # Optional. The action's input parameters. + "a_key": "", # Properties of the object. + }, + "tool": "A String", # Required. The tool associated with this call. Format: `projects//locations//agents//tools/`. + }, }, }, ], @@ -8016,6 +11099,13 @@

Method Details

"A String", ], }, + "toolCall": { # Represents a call of a specific tool's action with the specified inputs. # Returns the definition of a tool call that should be executed by the client. + "action": "A String", # Required. The name of the tool's action associated with this call. + "inputParameters": { # Optional. The action's input parameters. + "a_key": "", # Properties of the object. + }, + "tool": "A String", # Required. The tool associated with this call. Format: `projects//locations//agents//tools/`. + }, }, ], "returnPartialResponses": True or False, # Whether Dialogflow should return currently queued fulfillment response messages in streaming APIs. If a webhook is specified, it happens before Dialogflow invokes webhook. Warning: 1) This flag only affects streaming API. Responses are still queued and returned once in non-streaming API. 2) The flag can be enabled in any fulfillment but only the first 3 partial responses will be returned. You may only want to apply it to fulfillments that have slow webhooks. @@ -8045,8 +11135,8 @@

Method Details

"maxDigits": 42, # Max length of DTMF digits. }, "loggingSettings": { # Define behaviors on logging. # Settings for logging. Settings for Dialogflow History, Contact Center messages, StackDriver logs, and speech logging. Exposed at the following levels: - Agent level. - "enableInteractionLogging": True or False, # If true, DF Interaction logging is currently enabled. - "enableStackdriverLogging": True or False, # If true, StackDriver logging is currently enabled. + "enableInteractionLogging": True or False, # Enables DF Interaction logging. + "enableStackdriverLogging": True or False, # Enables StackDriver logging. }, "speechSettings": { # Define behaviors of speech to text detection. # Settings for speech to text detection. Exposed at the following levels: - Agent level - Flow level - Page level - Parameter level "endpointerSensitivity": 42, # Sensitivity of the speech model that detects the end of speech. Scale from 0 to 100. @@ -8074,8 +11164,8 @@

Method Details

"maxDigits": 42, # Max length of DTMF digits. }, "loggingSettings": { # Define behaviors on logging. # Settings for logging. Settings for Dialogflow History, Contact Center messages, StackDriver logs, and speech logging. Exposed at the following levels: - Agent level. - "enableInteractionLogging": True or False, # If true, DF Interaction logging is currently enabled. - "enableStackdriverLogging": True or False, # If true, StackDriver logging is currently enabled. + "enableInteractionLogging": True or False, # Enables DF Interaction logging. + "enableStackdriverLogging": True or False, # Enables StackDriver logging. }, "speechSettings": { # Define behaviors of speech to text detection. # Settings for speech to text detection. Exposed at the following levels: - Agent level - Flow level - Page level - Parameter level "endpointerSensitivity": 42, # Sensitivity of the speech model that detects the end of speech. Scale from 0 to 100. @@ -8139,6 +11229,13 @@

Method Details

"A String", ], }, + "toolCall": { # Represents a call of a specific tool's action with the specified inputs. # Returns the definition of a tool call that should be executed by the client. + "action": "A String", # Required. The name of the tool's action associated with this call. + "inputParameters": { # Optional. The action's input parameters. + "a_key": "", # Properties of the object. + }, + "tool": "A String", # Required. The tool associated with this call. Format: `projects//locations//agents//tools/`. + }, }, }, ], @@ -8195,6 +11292,13 @@

Method Details

"A String", ], }, + "toolCall": { # Represents a call of a specific tool's action with the specified inputs. # Returns the definition of a tool call that should be executed by the client. + "action": "A String", # Required. The name of the tool's action associated with this call. + "inputParameters": { # Optional. The action's input parameters. + "a_key": "", # Properties of the object. + }, + "tool": "A String", # Required. The tool associated with this call. Format: `projects//locations//agents//tools/`. + }, }, ], "returnPartialResponses": True or False, # Whether Dialogflow should return currently queued fulfillment response messages in streaming APIs. If a webhook is specified, it happens before Dialogflow invokes webhook. Warning: 1) This flag only affects streaming API. Responses are still queued and returned once in non-streaming API. 2) The flag can be enabled in any fulfillment but only the first 3 partial responses will be returned. You may only want to apply it to fulfillments that have slow webhooks. @@ -8226,8 +11330,8 @@

Method Details

"maxDigits": 42, # Max length of DTMF digits. }, "loggingSettings": { # Define behaviors on logging. # Settings for logging. Settings for Dialogflow History, Contact Center messages, StackDriver logs, and speech logging. Exposed at the following levels: - Agent level. - "enableInteractionLogging": True or False, # If true, DF Interaction logging is currently enabled. - "enableStackdriverLogging": True or False, # If true, StackDriver logging is currently enabled. + "enableInteractionLogging": True or False, # Enables DF Interaction logging. + "enableStackdriverLogging": True or False, # Enables StackDriver logging. }, "speechSettings": { # Define behaviors of speech to text detection. # Settings for speech to text detection. Exposed at the following levels: - Agent level - Flow level - Page level - Parameter level "endpointerSensitivity": 42, # Sensitivity of the speech model that detects the end of speech. Scale from 0 to 100. @@ -8291,6 +11395,13 @@

Method Details

"A String", ], }, + "toolCall": { # Represents a call of a specific tool's action with the specified inputs. # Returns the definition of a tool call that should be executed by the client. + "action": "A String", # Required. The name of the tool's action associated with this call. + "inputParameters": { # Optional. The action's input parameters. + "a_key": "", # Properties of the object. + }, + "tool": "A String", # Required. The tool associated with this call. Format: `projects//locations//agents//tools/`. + }, }, }, ], @@ -8347,6 +11458,13 @@

Method Details

"A String", ], }, + "toolCall": { # Represents a call of a specific tool's action with the specified inputs. # Returns the definition of a tool call that should be executed by the client. + "action": "A String", # Required. The name of the tool's action associated with this call. + "inputParameters": { # Optional. The action's input parameters. + "a_key": "", # Properties of the object. + }, + "tool": "A String", # Required. The tool associated with this call. Format: `projects//locations//agents//tools/`. + }, }, ], "returnPartialResponses": True or False, # Whether Dialogflow should return currently queued fulfillment response messages in streaming APIs. If a webhook is specified, it happens before Dialogflow invokes webhook. Warning: 1) This flag only affects streaming API. Responses are still queued and returned once in non-streaming API. 2) The flag can be enabled in any fulfillment but only the first 3 partial responses will be returned. You may only want to apply it to fulfillments that have slow webhooks. @@ -8391,8 +11509,8 @@

Method Details

"maxDigits": 42, # Max length of DTMF digits. }, "loggingSettings": { # Define behaviors on logging. # Settings for logging. Settings for Dialogflow History, Contact Center messages, StackDriver logs, and speech logging. Exposed at the following levels: - Agent level. - "enableInteractionLogging": True or False, # If true, DF Interaction logging is currently enabled. - "enableStackdriverLogging": True or False, # If true, StackDriver logging is currently enabled. + "enableInteractionLogging": True or False, # Enables DF Interaction logging. + "enableStackdriverLogging": True or False, # Enables StackDriver logging. }, "speechSettings": { # Define behaviors of speech to text detection. # Settings for speech to text detection. Exposed at the following levels: - Agent level - Flow level - Page level - Parameter level "endpointerSensitivity": 42, # Sensitivity of the speech model that detects the end of speech. Scale from 0 to 100. @@ -8456,6 +11574,13 @@

Method Details

"A String", ], }, + "toolCall": { # Represents a call of a specific tool's action with the specified inputs. # Returns the definition of a tool call that should be executed by the client. + "action": "A String", # Required. The name of the tool's action associated with this call. + "inputParameters": { # Optional. The action's input parameters. + "a_key": "", # Properties of the object. + }, + "tool": "A String", # Required. The tool associated with this call. Format: `projects//locations//agents//tools/`. + }, }, }, ], @@ -8512,6 +11637,13 @@

Method Details

"A String", ], }, + "toolCall": { # Represents a call of a specific tool's action with the specified inputs. # Returns the definition of a tool call that should be executed by the client. + "action": "A String", # Required. The name of the tool's action associated with this call. + "inputParameters": { # Optional. The action's input parameters. + "a_key": "", # Properties of the object. + }, + "tool": "A String", # Required. The tool associated with this call. Format: `projects//locations//agents//tools/`. + }, }, ], "returnPartialResponses": True or False, # Whether Dialogflow should return currently queued fulfillment response messages in streaming APIs. If a webhook is specified, it happens before Dialogflow invokes webhook. Warning: 1) This flag only affects streaming API. Responses are still queued and returned once in non-streaming API. 2) The flag can be enabled in any fulfillment but only the first 3 partial responses will be returned. You may only want to apply it to fulfillments that have slow webhooks. @@ -8550,8 +11682,8 @@

Method Details

"maxDigits": 42, # Max length of DTMF digits. }, "loggingSettings": { # Define behaviors on logging. # Settings for logging. Settings for Dialogflow History, Contact Center messages, StackDriver logs, and speech logging. Exposed at the following levels: - Agent level. - "enableInteractionLogging": True or False, # If true, DF Interaction logging is currently enabled. - "enableStackdriverLogging": True or False, # If true, StackDriver logging is currently enabled. + "enableInteractionLogging": True or False, # Enables DF Interaction logging. + "enableStackdriverLogging": True or False, # Enables StackDriver logging. }, "speechSettings": { # Define behaviors of speech to text detection. # Settings for speech to text detection. Exposed at the following levels: - Agent level - Flow level - Page level - Parameter level "endpointerSensitivity": 42, # Sensitivity of the speech model that detects the end of speech. Scale from 0 to 100. @@ -8615,6 +11747,13 @@

Method Details

"A String", ], }, + "toolCall": { # Represents a call of a specific tool's action with the specified inputs. # Returns the definition of a tool call that should be executed by the client. + "action": "A String", # Required. The name of the tool's action associated with this call. + "inputParameters": { # Optional. The action's input parameters. + "a_key": "", # Properties of the object. + }, + "tool": "A String", # Required. The tool associated with this call. Format: `projects//locations//agents//tools/`. + }, }, }, ], @@ -8671,6 +11810,13 @@

Method Details

"A String", ], }, + "toolCall": { # Represents a call of a specific tool's action with the specified inputs. # Returns the definition of a tool call that should be executed by the client. + "action": "A String", # Required. The name of the tool's action associated with this call. + "inputParameters": { # Optional. The action's input parameters. + "a_key": "", # Properties of the object. + }, + "tool": "A String", # Required. The tool associated with this call. Format: `projects//locations//agents//tools/`. + }, }, ], "returnPartialResponses": True or False, # Whether Dialogflow should return currently queued fulfillment response messages in streaming APIs. If a webhook is specified, it happens before Dialogflow invokes webhook. Warning: 1) This flag only affects streaming API. Responses are still queued and returned once in non-streaming API. 2) The flag can be enabled in any fulfillment but only the first 3 partial responses will be returned. You may only want to apply it to fulfillments that have slow webhooks. diff --git a/docs/dyn/dialogflow_v3beta1.projects.locations.agents.environments.sessions.html b/docs/dyn/dialogflow_v3beta1.projects.locations.agents.environments.sessions.html index 221c4f7445d..ee31241b7de 100644 --- a/docs/dyn/dialogflow_v3beta1.projects.locations.agents.environments.sessions.html +++ b/docs/dyn/dialogflow_v3beta1.projects.locations.agents.environments.sessions.html @@ -160,11 +160,22 @@

Method Details

"text": { # Represents the natural language text to be processed. # The natural language text to be processed. "text": "A String", # Required. The UTF-8 encoded natural language text to be processed. }, + "toolCallResult": { # The result of calling a tool's action that has been executed by the client. # The results of a tool executed by the client. + "action": "A String", # Required. The name of the tool's action associated with this call. + "error": { # An error produced by the tool call. # The tool call's error. + "message": "A String", # Optional. The error message of the function. + }, + "outputParameters": { # The tool call's output parameters. + "a_key": "", # Properties of the object. + }, + "tool": "A String", # Required. The tool associated with this call. Format: `projects//locations//agents//tools/`. + }, }, "queryParams": { # Represents the parameters of a conversational query. # The parameters of this query. "analyzeQueryTextSentiment": True or False, # Configures whether sentiment analysis should be performed. If not provided, sentiment analysis is not performed. "channel": "A String", # The channel which this query is for. If specified, only the ResponseMessage associated with the channel will be returned. If no ResponseMessage is associated with the channel, it falls back to the ResponseMessage with unspecified channel. If unspecified, the ResponseMessage with unspecified channel will be returned. "currentPage": "A String", # The unique identifier of the page to override the current page in the session. Format: `projects//locations//agents//flows//pages/`. If `current_page` is specified, the previous state of the session will be ignored by Dialogflow, including the previous page and the previous session parameters. In most cases, current_page and parameters should be configured together to direct a session to a specific state. + "currentPlaybook": "A String", # Optional. Start the session with the specified playbook. You can only specify the playbook at the beginning of the session. Otherwise, an error will be thrown. Format: `projects//locations//agents//playbooks/`. "disableWebhook": True or False, # Whether to disable webhook calls for this request. "endUserMetadata": { # Optional. Information about the end-user to improve the relevance and accuracy of generative answers. This will be interpreted and used by a language model, so, for good results, the data should be self-descriptive, and in a simple structure. Example: ```json { "subscription plan": "Business Premium Plus", "devices owned": [ {"model": "Google Pixel 7"}, {"model": "Google Pixel Tablet"} ] } ``` "a_key": "", # Properties of the object. @@ -176,6 +187,10 @@

Method Details

"latitude": 3.14, # The latitude in degrees. It must be in the range [-90.0, +90.0]. "longitude": 3.14, # The longitude in degrees. It must be in the range [-180.0, +180.0]. }, + "llmModelSettings": { # Settings for LLM models. # Optional. Use the specified LLM model settings for processing the request. + "model": "A String", # The selected LLM model. + "promptText": "A String", # The custom prompt to use. + }, "parameters": { # Additional parameters to be put into session parameters. To remove a parameter from the session, clients should explicitly set the parameter value to null. You can reference the session parameters in the agent with the following format: $session.params.parameter-id. 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 then use map, otherwise, depending on the parameter value type, it could be one of string, number, boolean, null, list or map. * MapValue value: If parameter's entity type is a composite entity then use map from composite entity property names to property values, otherwise, use parameter value. "a_key": "", # Properties of the object. }, @@ -273,8 +288,8 @@

Method Details

"maxDigits": 42, # Max length of DTMF digits. }, "loggingSettings": { # Define behaviors on logging. # Settings for logging. Settings for Dialogflow History, Contact Center messages, StackDriver logs, and speech logging. Exposed at the following levels: - Agent level. - "enableInteractionLogging": True or False, # If true, DF Interaction logging is currently enabled. - "enableStackdriverLogging": True or False, # If true, StackDriver logging is currently enabled. + "enableInteractionLogging": True or False, # Enables DF Interaction logging. + "enableStackdriverLogging": True or False, # Enables StackDriver logging. }, "speechSettings": { # Define behaviors of speech to text detection. # Settings for speech to text detection. Exposed at the following levels: - Agent level - Flow level - Page level - Parameter level "endpointerSensitivity": 42, # Sensitivity of the speech model that detects the end of speech. Scale from 0 to 100. @@ -286,8 +301,8 @@

Method Details

}, }, "allowAnswerFeedback": True or False, # Indicates whether the Thumbs up/Thumbs down rating controls are need to be shown for the response in the Dialogflow Messenger widget. - "currentPage": { # A Dialogflow CX conversation (session) can be described and visualized as a state machine. The states of a CX session are represented by pages. For each flow, you define many pages, where your combined pages can handle a complete conversation on the topics the flow is designed for. At any given moment, exactly one page is the current page, the current page is considered active, and the flow associated with that page is considered active. Every flow has a special start page. When a flow initially becomes active, the start page page becomes the current page. For each conversational turn, the current page will either stay the same or transition to another page. You configure each page to collect information from the end-user that is relevant for the conversational state represented by the page. For more information, see the [Page guide](https://cloud.google.com/dialogflow/cx/docs/concept/page). # The current Page. Some, not all fields are filled in this message, including but not limited to `name` and `display_name`. - "advancedSettings": { # Hierarchical advanced settings for agent/flow/page/fulfillment/parameter. Settings exposed at lower level overrides the settings exposed at higher level. Overriding occurs at the sub-setting level. For example, the playback_interruption_settings at fulfillment level only overrides the playback_interruption_settings at the agent level, leaving other settings at the agent level unchanged. DTMF settings does not override each other. DTMF settings set at different levels define DTMF detections running in parallel. Hierarchy: Agent->Flow->Page->Fulfillment/Parameter. # Hierarchical advanced settings for this page. The settings exposed at the lower level overrides the settings exposed at the higher level. + "currentFlow": { # Flows represents the conversation flows when you build your chatbot agent. A flow consists of many pages connected by the transition routes. Conversations always start with the built-in Start Flow (with an all-0 ID). Transition routes can direct the conversation session from the current flow (parent flow) to another flow (sub flow). When the sub flow is finished, Dialogflow will bring the session back to the parent flow, where the sub flow is started. Usually, when a transition route is followed by a matched intent, the intent will be "consumed". This means the intent won't activate more transition routes. However, when the followed transition route moves the conversation session into a different flow, the matched intent can be carried over and to be consumed in the target flow. # The current Flow. Some, not all fields are filled in this message, including but not limited to `name` and `display_name`. + "advancedSettings": { # Hierarchical advanced settings for agent/flow/page/fulfillment/parameter. Settings exposed at lower level overrides the settings exposed at higher level. Overriding occurs at the sub-setting level. For example, the playback_interruption_settings at fulfillment level only overrides the playback_interruption_settings at the agent level, leaving other settings at the agent level unchanged. DTMF settings does not override each other. DTMF settings set at different levels define DTMF detections running in parallel. Hierarchy: Agent->Flow->Page->Fulfillment/Parameter. # Hierarchical advanced settings for this flow. The settings exposed at the lower level overrides the settings exposed at the higher level. "audioExportGcsDestination": { # Google Cloud Storage location for a Dialogflow operation that writes or exports objects (e.g. exported agent or transcripts) outside of Dialogflow. # If present, incoming audio is exported by Dialogflow to the configured Google Cloud Storage destination. Exposed at the following levels: - Agent level - Flow level "uri": "A String", # Required. The Google Cloud Storage URI for the exported objects. A URI is of the form: `gs://bucket/object-name-or-prefix` Whether a full object name, or just a prefix, its usage depends on the Dialogflow operation. }, @@ -299,8 +314,8 @@

Method Details

"maxDigits": 42, # Max length of DTMF digits. }, "loggingSettings": { # Define behaviors on logging. # Settings for logging. Settings for Dialogflow History, Contact Center messages, StackDriver logs, and speech logging. Exposed at the following levels: - Agent level. - "enableInteractionLogging": True or False, # If true, DF Interaction logging is currently enabled. - "enableStackdriverLogging": True or False, # If true, StackDriver logging is currently enabled. + "enableInteractionLogging": True or False, # Enables DF Interaction logging. + "enableStackdriverLogging": True or False, # Enables StackDriver logging. }, "speechSettings": { # Define behaviors of speech to text detection. # Settings for speech to text detection. Exposed at the following levels: - Agent level - Flow level - Page level - Parameter level "endpointerSensitivity": 42, # Sensitivity of the speech model that detects the end of speech. Scale from 0 to 100. @@ -311,155 +326,9 @@

Method Details

"useTimeoutBasedEndpointing": True or False, # Use timeout based endpointing, interpreting endpointer sensitivy as seconds of timeout value. }, }, - "description": "A String", # The description of the page. The maximum length is 500 characters. - "displayName": "A String", # Required. The human-readable name of the page, unique within the flow. - "entryFulfillment": { # A fulfillment can do one or more of the following actions at the same time: * Generate rich message responses. * Set parameter values. * Call the webhook. Fulfillments can be called at various stages in the Page or Form lifecycle. For example, when a DetectIntentRequest drives a session to enter a new page, the page's entry fulfillment can add a static response to the QueryResult in the returning DetectIntentResponse, call the webhook (for example, to load user data from a database), or both. # The fulfillment to call when the session is entering the page. - "advancedSettings": { # Hierarchical advanced settings for agent/flow/page/fulfillment/parameter. Settings exposed at lower level overrides the settings exposed at higher level. Overriding occurs at the sub-setting level. For example, the playback_interruption_settings at fulfillment level only overrides the playback_interruption_settings at the agent level, leaving other settings at the agent level unchanged. DTMF settings does not override each other. DTMF settings set at different levels define DTMF detections running in parallel. Hierarchy: Agent->Flow->Page->Fulfillment/Parameter. # Hierarchical advanced settings for this fulfillment. The settings exposed at the lower level overrides the settings exposed at the higher level. - "audioExportGcsDestination": { # Google Cloud Storage location for a Dialogflow operation that writes or exports objects (e.g. exported agent or transcripts) outside of Dialogflow. # If present, incoming audio is exported by Dialogflow to the configured Google Cloud Storage destination. Exposed at the following levels: - Agent level - Flow level - "uri": "A String", # Required. The Google Cloud Storage URI for the exported objects. A URI is of the form: `gs://bucket/object-name-or-prefix` Whether a full object name, or just a prefix, its usage depends on the Dialogflow operation. - }, - "dtmfSettings": { # Define behaviors for DTMF (dual tone multi frequency). # Settings for DTMF. Exposed at the following levels: - Agent level - Flow level - Page level - Parameter level. - "enabled": True or False, # If true, incoming audio is processed for DTMF (dual tone multi frequency) events. For example, if the caller presses a button on their telephone keypad and DTMF processing is enabled, Dialogflow will detect the event (e.g. a "3" was pressed) in the incoming audio and pass the event to the bot to drive business logic (e.g. when 3 is pressed, return the account balance). - "endpointingTimeoutDuration": "A String", # Endpoint timeout setting for matching dtmf input to regex. - "finishDigit": "A String", # The digit that terminates a DTMF digit sequence. - "interdigitTimeoutDuration": "A String", # Interdigit timeout setting for matching dtmf input to regex. - "maxDigits": 42, # Max length of DTMF digits. - }, - "loggingSettings": { # Define behaviors on logging. # Settings for logging. Settings for Dialogflow History, Contact Center messages, StackDriver logs, and speech logging. Exposed at the following levels: - Agent level. - "enableInteractionLogging": True or False, # If true, DF Interaction logging is currently enabled. - "enableStackdriverLogging": True or False, # If true, StackDriver logging is currently enabled. - }, - "speechSettings": { # Define behaviors of speech to text detection. # Settings for speech to text detection. Exposed at the following levels: - Agent level - Flow level - Page level - Parameter level - "endpointerSensitivity": 42, # Sensitivity of the speech model that detects the end of speech. Scale from 0 to 100. - "models": { # Mapping from language to Speech-to-Text model. The mapped Speech-to-Text model will be selected for requests from its corresponding language. For more information, see [Speech models](https://cloud.google.com/dialogflow/cx/docs/concept/speech-models). - "a_key": "A String", - }, - "noSpeechTimeout": "A String", # Timeout before detecting no speech. - "useTimeoutBasedEndpointing": True or False, # Use timeout based endpointing, interpreting endpointer sensitivy as seconds of timeout value. - }, - }, - "conditionalCases": [ # Conditional cases for this fulfillment. - { # A list of cascading if-else conditions. Cases are mutually exclusive. The first one with a matching condition is selected, all the rest ignored. - "cases": [ # A list of cascading if-else conditions. - { # Each case has a Boolean condition. When it is evaluated to be True, the corresponding messages will be selected and evaluated recursively. - "caseContent": [ # A list of case content. - { # The list of messages or conditional cases to activate for this case. - "additionalCases": # Object with schema name: GoogleCloudDialogflowCxV3beta1FulfillmentConditionalCases # Additional cases to be evaluated. - "message": { # 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. # Returned message. - "channel": "A String", # The channel which the response is associated with. Clients can specify the channel via QueryParameters.channel, and only associated channel response will be returned. - "conversationSuccess": { # 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. # Indicates that the conversation succeeded. - "metadata": { # Custom metadata. Dialogflow doesn't impose any structure on this. - "a_key": "", # Properties of the object. - }, - }, - "endInteraction": { # 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. # Output only. A signal that indicates the interaction with the Dialogflow agent has ended. This message is generated by Dialogflow only when the conversation reaches `END_SESSION` page. It is not supposed to be defined by the user. It's guaranteed that there is at most one such message in each response. - }, - "knowledgeInfoCard": { # Represents info card response. If the response contains generative knowledge prediction, Dialogflow will return a payload with Infobot Messenger compatible info card. Otherwise, the info card response is skipped. # Represents info card for knowledge answers, to be better rendered in Dialogflow Messenger. - }, - "liveAgentHandoff": { # 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. # Hands off conversation to a human agent. - "metadata": { # Custom metadata for your handoff procedure. Dialogflow doesn't impose any structure on this. - "a_key": "", # Properties of the object. - }, - }, - "mixedAudio": { # 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. # Output only. An audio response message composed of both the synthesized Dialogflow agent responses and responses defined via play_audio. This message is generated by Dialogflow only and not supposed to be defined by the user. - "segments": [ # Segments this audio response is composed of. - { # Represents one segment of audio. - "allowPlaybackInterruption": True or False, # 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. - "audio": "A String", # Raw audio synthesized from the Dialogflow agent's response using the output config specified in the request. - "uri": "A String", # Client-specific URI that points to an audio clip accessible to the client. Dialogflow does not impose any validation on it. - }, - ], - }, - "outputAudioText": { # A text or ssml response that is preferentially used for TTS output audio synthesis, as described in the comment on the ResponseMessage message. # A text or ssml response that is preferentially used for TTS output audio synthesis, as described in the comment on the ResponseMessage message. - "allowPlaybackInterruption": True or False, # 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. - "ssml": "A String", # The SSML text to be synthesized. For more information, see [SSML](/speech/text-to-speech/docs/ssml). - "text": "A String", # The raw text to be synthesized. - }, - "payload": { # Returns a response containing a custom, platform-specific payload. - "a_key": "", # Properties of the object. - }, - "playAudio": { # Specifies an audio clip to be played by the client as part of the response. # Signal that the client should play an audio clip hosted at a client-specific URI. Dialogflow uses this to construct mixed_audio. However, Dialogflow itself does not try to read or process the URI in any way. - "allowPlaybackInterruption": True or False, # 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. - "audioUri": "A String", # Required. URI of the audio clip. Dialogflow does not impose any validation on this value. It is specific to the client that reads it. - }, - "telephonyTransferCall": { # Represents the signal that telles the client to transfer the phone call connected to the agent to a third-party endpoint. # A signal that the client should transfer the phone call connected to this agent to a third-party endpoint. - "phoneNumber": "A String", # Transfer the call to a phone number in [E.164 format](https://en.wikipedia.org/wiki/E.164). - }, - "text": { # The text response message. # Returns a text response. - "allowPlaybackInterruption": True or False, # 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. - "text": [ # Required. A collection of text responses. - "A String", - ], - }, - }, - }, - ], - "condition": "A String", # The condition to activate and select this case. Empty means the condition is always true. The condition is evaluated against form parameters or session parameters. See the [conditions reference](https://cloud.google.com/dialogflow/cx/docs/reference/condition). - }, - ], - }, - ], - "enableGenerativeFallback": True or False, # If the flag is true, the agent will utilize LLM to generate a text response. If LLM generation fails, the defined responses in the fulfillment will be respected. This flag is only useful for fulfillments associated with no-match event handlers. - "messages": [ # The list of rich message responses to present to the user. - { # 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. - "channel": "A String", # The channel which the response is associated with. Clients can specify the channel via QueryParameters.channel, and only associated channel response will be returned. - "conversationSuccess": { # 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. # Indicates that the conversation succeeded. - "metadata": { # Custom metadata. Dialogflow doesn't impose any structure on this. - "a_key": "", # Properties of the object. - }, - }, - "endInteraction": { # 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. # Output only. A signal that indicates the interaction with the Dialogflow agent has ended. This message is generated by Dialogflow only when the conversation reaches `END_SESSION` page. It is not supposed to be defined by the user. It's guaranteed that there is at most one such message in each response. - }, - "knowledgeInfoCard": { # Represents info card response. If the response contains generative knowledge prediction, Dialogflow will return a payload with Infobot Messenger compatible info card. Otherwise, the info card response is skipped. # Represents info card for knowledge answers, to be better rendered in Dialogflow Messenger. - }, - "liveAgentHandoff": { # 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. # Hands off conversation to a human agent. - "metadata": { # Custom metadata for your handoff procedure. Dialogflow doesn't impose any structure on this. - "a_key": "", # Properties of the object. - }, - }, - "mixedAudio": { # 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. # Output only. An audio response message composed of both the synthesized Dialogflow agent responses and responses defined via play_audio. This message is generated by Dialogflow only and not supposed to be defined by the user. - "segments": [ # Segments this audio response is composed of. - { # Represents one segment of audio. - "allowPlaybackInterruption": True or False, # 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. - "audio": "A String", # Raw audio synthesized from the Dialogflow agent's response using the output config specified in the request. - "uri": "A String", # Client-specific URI that points to an audio clip accessible to the client. Dialogflow does not impose any validation on it. - }, - ], - }, - "outputAudioText": { # A text or ssml response that is preferentially used for TTS output audio synthesis, as described in the comment on the ResponseMessage message. # A text or ssml response that is preferentially used for TTS output audio synthesis, as described in the comment on the ResponseMessage message. - "allowPlaybackInterruption": True or False, # 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. - "ssml": "A String", # The SSML text to be synthesized. For more information, see [SSML](/speech/text-to-speech/docs/ssml). - "text": "A String", # The raw text to be synthesized. - }, - "payload": { # Returns a response containing a custom, platform-specific payload. - "a_key": "", # Properties of the object. - }, - "playAudio": { # Specifies an audio clip to be played by the client as part of the response. # Signal that the client should play an audio clip hosted at a client-specific URI. Dialogflow uses this to construct mixed_audio. However, Dialogflow itself does not try to read or process the URI in any way. - "allowPlaybackInterruption": True or False, # 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. - "audioUri": "A String", # Required. URI of the audio clip. Dialogflow does not impose any validation on this value. It is specific to the client that reads it. - }, - "telephonyTransferCall": { # Represents the signal that telles the client to transfer the phone call connected to the agent to a third-party endpoint. # A signal that the client should transfer the phone call connected to this agent to a third-party endpoint. - "phoneNumber": "A String", # Transfer the call to a phone number in [E.164 format](https://en.wikipedia.org/wiki/E.164). - }, - "text": { # The text response message. # Returns a text response. - "allowPlaybackInterruption": True or False, # 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. - "text": [ # Required. A collection of text responses. - "A String", - ], - }, - }, - ], - "returnPartialResponses": True or False, # Whether Dialogflow should return currently queued fulfillment response messages in streaming APIs. If a webhook is specified, it happens before Dialogflow invokes webhook. Warning: 1) This flag only affects streaming API. Responses are still queued and returned once in non-streaming API. 2) The flag can be enabled in any fulfillment but only the first 3 partial responses will be returned. You may only want to apply it to fulfillments that have slow webhooks. - "setParameterActions": [ # Set parameter values before executing the webhook. - { # Setting a parameter value. - "parameter": "A String", # Display name of the parameter. - "value": "", # The new value of the parameter. A null value clears the parameter. - }, - ], - "tag": "A String", # The value of this field will be populated in the WebhookRequest `fulfillmentInfo.tag` field by Dialogflow when the associated webhook is called. The tag is typically used by the webhook service to identify which fulfillment is being called, but it could be used for other purposes. This field is required if `webhook` is specified. - "webhook": "A String", # The webhook to call. Format: `projects//locations//agents//webhooks/`. - }, - "eventHandlers": [ # Handlers associated with the page to handle events such as webhook errors, no match or no input. + "description": "A String", # The description of the flow. The maximum length is 500 characters. If exceeded, the request is rejected. + "displayName": "A String", # Required. The human-readable name of the flow. + "eventHandlers": [ # A flow's event handlers serve two purposes: * They are responsible for handling events (e.g. no match, webhook errors) in the flow. * They are inherited by every page's event handlers, which can be used to handle common events regardless of the current page. Event handlers defined in the page have higher priority than those defined in the flow. Unlike transition_routes, these handlers are evaluated on a first-match basis. The first one that matches the event get executed, with the rest being ignored. { # An event handler specifies an event that can be handled during a session. When the specified event happens, the following actions are taken in order: * If there is a `trigger_fulfillment` associated with the event, it will be called. * If there is a `target_page` associated with the event, the session will transition into the specified page. * If there is a `target_flow` associated with the event, the session will transition into the specified flow. "event": "A String", # Required. The name of the event to handle. "name": "A String", # Output only. The unique identifier of this event handler. @@ -478,8 +347,8 @@

Method Details

"maxDigits": 42, # Max length of DTMF digits. }, "loggingSettings": { # Define behaviors on logging. # Settings for logging. Settings for Dialogflow History, Contact Center messages, StackDriver logs, and speech logging. Exposed at the following levels: - Agent level. - "enableInteractionLogging": True or False, # If true, DF Interaction logging is currently enabled. - "enableStackdriverLogging": True or False, # If true, StackDriver logging is currently enabled. + "enableInteractionLogging": True or False, # Enables DF Interaction logging. + "enableStackdriverLogging": True or False, # Enables StackDriver logging. }, "speechSettings": { # Define behaviors of speech to text detection. # Settings for speech to text detection. Exposed at the following levels: - Agent level - Flow level - Page level - Parameter level "endpointerSensitivity": 42, # Sensitivity of the speech model that detects the end of speech. Scale from 0 to 100. @@ -543,6 +412,13 @@

Method Details

"A String", ], }, + "toolCall": { # Represents a call of a specific tool's action with the specified inputs. # Returns the definition of a tool call that should be executed by the client. + "action": "A String", # Required. The name of the tool's action associated with this call. + "inputParameters": { # Optional. The action's input parameters. + "a_key": "", # Properties of the object. + }, + "tool": "A String", # Required. The tool associated with this call. Format: `projects//locations//agents//tools/`. + }, }, }, ], @@ -599,6 +475,13 @@

Method Details

"A String", ], }, + "toolCall": { # Represents a call of a specific tool's action with the specified inputs. # Returns the definition of a tool call that should be executed by the client. + "action": "A String", # Required. The name of the tool's action associated with this call. + "inputParameters": { # Optional. The action's input parameters. + "a_key": "", # Properties of the object. + }, + "tool": "A String", # Required. The tool associated with this call. Format: `projects//locations//agents//tools/`. + }, }, ], "returnPartialResponses": True or False, # Whether Dialogflow should return currently queued fulfillment response messages in streaming APIs. If a webhook is specified, it happens before Dialogflow invokes webhook. Warning: 1) This flag only affects streaming API. Responses are still queued and returned once in non-streaming API. 2) The flag can be enabled in any fulfillment but only the first 3 partial responses will be returned. You may only want to apply it to fulfillments that have slow webhooks. @@ -613,278 +496,49 @@

Method Details

}, }, ], - "form": { # A form is a data model that groups related parameters that can be collected from the user. The process in which the agent prompts the user and collects parameter values from the user is called form filling. A form can be added to a page. When form filling is done, the filled parameters will be written to the session. # The form associated with the page, used for collecting parameters relevant to the page. - "parameters": [ # Parameters to collect from the user. - { # Represents a form parameter. - "advancedSettings": { # Hierarchical advanced settings for agent/flow/page/fulfillment/parameter. Settings exposed at lower level overrides the settings exposed at higher level. Overriding occurs at the sub-setting level. For example, the playback_interruption_settings at fulfillment level only overrides the playback_interruption_settings at the agent level, leaving other settings at the agent level unchanged. DTMF settings does not override each other. DTMF settings set at different levels define DTMF detections running in parallel. Hierarchy: Agent->Flow->Page->Fulfillment/Parameter. # Hierarchical advanced settings for this parameter. The settings exposed at the lower level overrides the settings exposed at the higher level. - "audioExportGcsDestination": { # Google Cloud Storage location for a Dialogflow operation that writes or exports objects (e.g. exported agent or transcripts) outside of Dialogflow. # If present, incoming audio is exported by Dialogflow to the configured Google Cloud Storage destination. Exposed at the following levels: - Agent level - Flow level - "uri": "A String", # Required. The Google Cloud Storage URI for the exported objects. A URI is of the form: `gs://bucket/object-name-or-prefix` Whether a full object name, or just a prefix, its usage depends on the Dialogflow operation. - }, - "dtmfSettings": { # Define behaviors for DTMF (dual tone multi frequency). # Settings for DTMF. Exposed at the following levels: - Agent level - Flow level - Page level - Parameter level. - "enabled": True or False, # If true, incoming audio is processed for DTMF (dual tone multi frequency) events. For example, if the caller presses a button on their telephone keypad and DTMF processing is enabled, Dialogflow will detect the event (e.g. a "3" was pressed) in the incoming audio and pass the event to the bot to drive business logic (e.g. when 3 is pressed, return the account balance). - "endpointingTimeoutDuration": "A String", # Endpoint timeout setting for matching dtmf input to regex. - "finishDigit": "A String", # The digit that terminates a DTMF digit sequence. - "interdigitTimeoutDuration": "A String", # Interdigit timeout setting for matching dtmf input to regex. - "maxDigits": 42, # Max length of DTMF digits. - }, - "loggingSettings": { # Define behaviors on logging. # Settings for logging. Settings for Dialogflow History, Contact Center messages, StackDriver logs, and speech logging. Exposed at the following levels: - Agent level. - "enableInteractionLogging": True or False, # If true, DF Interaction logging is currently enabled. - "enableStackdriverLogging": True or False, # If true, StackDriver logging is currently enabled. - }, - "speechSettings": { # Define behaviors of speech to text detection. # Settings for speech to text detection. Exposed at the following levels: - Agent level - Flow level - Page level - Parameter level - "endpointerSensitivity": 42, # Sensitivity of the speech model that detects the end of speech. Scale from 0 to 100. - "models": { # Mapping from language to Speech-to-Text model. The mapped Speech-to-Text model will be selected for requests from its corresponding language. For more information, see [Speech models](https://cloud.google.com/dialogflow/cx/docs/concept/speech-models). - "a_key": "A String", - }, - "noSpeechTimeout": "A String", # Timeout before detecting no speech. - "useTimeoutBasedEndpointing": True or False, # Use timeout based endpointing, interpreting endpointer sensitivy as seconds of timeout value. + "knowledgeConnectorSettings": { # The Knowledge Connector settings for this page or flow. This includes information such as the attached Knowledge Bases, and the way to execute fulfillment. # Optional. Knowledge connector configuration. + "dataStoreConnections": [ # Optional. List of related data store connections. + { # A data store connection. It represents a data store in Discovery Engine and the type of the contents it contains. + "dataStore": "A String", # The full name of the referenced data store. Formats: `projects/{project}/locations/{location}/collections/{collection}/dataStores/{data_store}` `projects/{project}/locations/{location}/dataStores/{data_store}` + "dataStoreType": "A String", # The type of the connected data store. + }, + ], + "enabled": True or False, # Whether Knowledge Connector is enabled or not. + "targetFlow": "A String", # The target flow to transition to. Format: `projects//locations//agents//flows/`. + "targetPage": "A String", # The target page to transition to. Format: `projects//locations//agents//flows//pages/`. + "triggerFulfillment": { # A fulfillment can do one or more of the following actions at the same time: * Generate rich message responses. * Set parameter values. * Call the webhook. Fulfillments can be called at various stages in the Page or Form lifecycle. For example, when a DetectIntentRequest drives a session to enter a new page, the page's entry fulfillment can add a static response to the QueryResult in the returning DetectIntentResponse, call the webhook (for example, to load user data from a database), or both. # The fulfillment to be triggered. When the answers from the Knowledge Connector are selected by Dialogflow, you can utitlize the request scoped parameter `$request.knowledge.answers` (contains up to the 5 highest confidence answers) and `$request.knowledge.questions` (contains the corresponding questions) to construct the fulfillment. + "advancedSettings": { # Hierarchical advanced settings for agent/flow/page/fulfillment/parameter. Settings exposed at lower level overrides the settings exposed at higher level. Overriding occurs at the sub-setting level. For example, the playback_interruption_settings at fulfillment level only overrides the playback_interruption_settings at the agent level, leaving other settings at the agent level unchanged. DTMF settings does not override each other. DTMF settings set at different levels define DTMF detections running in parallel. Hierarchy: Agent->Flow->Page->Fulfillment/Parameter. # Hierarchical advanced settings for this fulfillment. The settings exposed at the lower level overrides the settings exposed at the higher level. + "audioExportGcsDestination": { # Google Cloud Storage location for a Dialogflow operation that writes or exports objects (e.g. exported agent or transcripts) outside of Dialogflow. # If present, incoming audio is exported by Dialogflow to the configured Google Cloud Storage destination. Exposed at the following levels: - Agent level - Flow level + "uri": "A String", # Required. The Google Cloud Storage URI for the exported objects. A URI is of the form: `gs://bucket/object-name-or-prefix` Whether a full object name, or just a prefix, its usage depends on the Dialogflow operation. + }, + "dtmfSettings": { # Define behaviors for DTMF (dual tone multi frequency). # Settings for DTMF. Exposed at the following levels: - Agent level - Flow level - Page level - Parameter level. + "enabled": True or False, # If true, incoming audio is processed for DTMF (dual tone multi frequency) events. For example, if the caller presses a button on their telephone keypad and DTMF processing is enabled, Dialogflow will detect the event (e.g. a "3" was pressed) in the incoming audio and pass the event to the bot to drive business logic (e.g. when 3 is pressed, return the account balance). + "endpointingTimeoutDuration": "A String", # Endpoint timeout setting for matching dtmf input to regex. + "finishDigit": "A String", # The digit that terminates a DTMF digit sequence. + "interdigitTimeoutDuration": "A String", # Interdigit timeout setting for matching dtmf input to regex. + "maxDigits": 42, # Max length of DTMF digits. + }, + "loggingSettings": { # Define behaviors on logging. # Settings for logging. Settings for Dialogflow History, Contact Center messages, StackDriver logs, and speech logging. Exposed at the following levels: - Agent level. + "enableInteractionLogging": True or False, # Enables DF Interaction logging. + "enableStackdriverLogging": True or False, # Enables StackDriver logging. + }, + "speechSettings": { # Define behaviors of speech to text detection. # Settings for speech to text detection. Exposed at the following levels: - Agent level - Flow level - Page level - Parameter level + "endpointerSensitivity": 42, # Sensitivity of the speech model that detects the end of speech. Scale from 0 to 100. + "models": { # Mapping from language to Speech-to-Text model. The mapped Speech-to-Text model will be selected for requests from its corresponding language. For more information, see [Speech models](https://cloud.google.com/dialogflow/cx/docs/concept/speech-models). + "a_key": "A String", }, + "noSpeechTimeout": "A String", # Timeout before detecting no speech. + "useTimeoutBasedEndpointing": True or False, # Use timeout based endpointing, interpreting endpointer sensitivy as seconds of timeout value. }, - "defaultValue": "", # The default value of an optional parameter. If the parameter is required, the default value will be ignored. - "displayName": "A String", # Required. The human-readable name of the parameter, unique within the form. - "entityType": "A String", # Required. The entity type of the parameter. Format: `projects/-/locations/-/agents/-/entityTypes/` for system entity types (for example, `projects/-/locations/-/agents/-/entityTypes/sys.date`), or `projects//locations//agents//entityTypes/` for developer entity types. - "fillBehavior": { # Configuration for how the filling of a parameter should be handled. # Required. Defines fill behavior for the parameter. - "initialPromptFulfillment": { # A fulfillment can do one or more of the following actions at the same time: * Generate rich message responses. * Set parameter values. * Call the webhook. Fulfillments can be called at various stages in the Page or Form lifecycle. For example, when a DetectIntentRequest drives a session to enter a new page, the page's entry fulfillment can add a static response to the QueryResult in the returning DetectIntentResponse, call the webhook (for example, to load user data from a database), or both. # Required. The fulfillment to provide the initial prompt that the agent can present to the user in order to fill the parameter. - "advancedSettings": { # Hierarchical advanced settings for agent/flow/page/fulfillment/parameter. Settings exposed at lower level overrides the settings exposed at higher level. Overriding occurs at the sub-setting level. For example, the playback_interruption_settings at fulfillment level only overrides the playback_interruption_settings at the agent level, leaving other settings at the agent level unchanged. DTMF settings does not override each other. DTMF settings set at different levels define DTMF detections running in parallel. Hierarchy: Agent->Flow->Page->Fulfillment/Parameter. # Hierarchical advanced settings for this fulfillment. The settings exposed at the lower level overrides the settings exposed at the higher level. - "audioExportGcsDestination": { # Google Cloud Storage location for a Dialogflow operation that writes or exports objects (e.g. exported agent or transcripts) outside of Dialogflow. # If present, incoming audio is exported by Dialogflow to the configured Google Cloud Storage destination. Exposed at the following levels: - Agent level - Flow level - "uri": "A String", # Required. The Google Cloud Storage URI for the exported objects. A URI is of the form: `gs://bucket/object-name-or-prefix` Whether a full object name, or just a prefix, its usage depends on the Dialogflow operation. - }, - "dtmfSettings": { # Define behaviors for DTMF (dual tone multi frequency). # Settings for DTMF. Exposed at the following levels: - Agent level - Flow level - Page level - Parameter level. - "enabled": True or False, # If true, incoming audio is processed for DTMF (dual tone multi frequency) events. For example, if the caller presses a button on their telephone keypad and DTMF processing is enabled, Dialogflow will detect the event (e.g. a "3" was pressed) in the incoming audio and pass the event to the bot to drive business logic (e.g. when 3 is pressed, return the account balance). - "endpointingTimeoutDuration": "A String", # Endpoint timeout setting for matching dtmf input to regex. - "finishDigit": "A String", # The digit that terminates a DTMF digit sequence. - "interdigitTimeoutDuration": "A String", # Interdigit timeout setting for matching dtmf input to regex. - "maxDigits": 42, # Max length of DTMF digits. - }, - "loggingSettings": { # Define behaviors on logging. # Settings for logging. Settings for Dialogflow History, Contact Center messages, StackDriver logs, and speech logging. Exposed at the following levels: - Agent level. - "enableInteractionLogging": True or False, # If true, DF Interaction logging is currently enabled. - "enableStackdriverLogging": True or False, # If true, StackDriver logging is currently enabled. - }, - "speechSettings": { # Define behaviors of speech to text detection. # Settings for speech to text detection. Exposed at the following levels: - Agent level - Flow level - Page level - Parameter level - "endpointerSensitivity": 42, # Sensitivity of the speech model that detects the end of speech. Scale from 0 to 100. - "models": { # Mapping from language to Speech-to-Text model. The mapped Speech-to-Text model will be selected for requests from its corresponding language. For more information, see [Speech models](https://cloud.google.com/dialogflow/cx/docs/concept/speech-models). - "a_key": "A String", - }, - "noSpeechTimeout": "A String", # Timeout before detecting no speech. - "useTimeoutBasedEndpointing": True or False, # Use timeout based endpointing, interpreting endpointer sensitivy as seconds of timeout value. - }, - }, - "conditionalCases": [ # Conditional cases for this fulfillment. - { # A list of cascading if-else conditions. Cases are mutually exclusive. The first one with a matching condition is selected, all the rest ignored. - "cases": [ # A list of cascading if-else conditions. - { # Each case has a Boolean condition. When it is evaluated to be True, the corresponding messages will be selected and evaluated recursively. - "caseContent": [ # A list of case content. - { # The list of messages or conditional cases to activate for this case. - "additionalCases": # Object with schema name: GoogleCloudDialogflowCxV3beta1FulfillmentConditionalCases # Additional cases to be evaluated. - "message": { # 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. # Returned message. - "channel": "A String", # The channel which the response is associated with. Clients can specify the channel via QueryParameters.channel, and only associated channel response will be returned. - "conversationSuccess": { # 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. # Indicates that the conversation succeeded. - "metadata": { # Custom metadata. Dialogflow doesn't impose any structure on this. - "a_key": "", # Properties of the object. - }, - }, - "endInteraction": { # 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. # Output only. A signal that indicates the interaction with the Dialogflow agent has ended. This message is generated by Dialogflow only when the conversation reaches `END_SESSION` page. It is not supposed to be defined by the user. It's guaranteed that there is at most one such message in each response. - }, - "knowledgeInfoCard": { # Represents info card response. If the response contains generative knowledge prediction, Dialogflow will return a payload with Infobot Messenger compatible info card. Otherwise, the info card response is skipped. # Represents info card for knowledge answers, to be better rendered in Dialogflow Messenger. - }, - "liveAgentHandoff": { # 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. # Hands off conversation to a human agent. - "metadata": { # Custom metadata for your handoff procedure. Dialogflow doesn't impose any structure on this. - "a_key": "", # Properties of the object. - }, - }, - "mixedAudio": { # 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. # Output only. An audio response message composed of both the synthesized Dialogflow agent responses and responses defined via play_audio. This message is generated by Dialogflow only and not supposed to be defined by the user. - "segments": [ # Segments this audio response is composed of. - { # Represents one segment of audio. - "allowPlaybackInterruption": True or False, # 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. - "audio": "A String", # Raw audio synthesized from the Dialogflow agent's response using the output config specified in the request. - "uri": "A String", # Client-specific URI that points to an audio clip accessible to the client. Dialogflow does not impose any validation on it. - }, - ], - }, - "outputAudioText": { # A text or ssml response that is preferentially used for TTS output audio synthesis, as described in the comment on the ResponseMessage message. # A text or ssml response that is preferentially used for TTS output audio synthesis, as described in the comment on the ResponseMessage message. - "allowPlaybackInterruption": True or False, # 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. - "ssml": "A String", # The SSML text to be synthesized. For more information, see [SSML](/speech/text-to-speech/docs/ssml). - "text": "A String", # The raw text to be synthesized. - }, - "payload": { # Returns a response containing a custom, platform-specific payload. - "a_key": "", # Properties of the object. - }, - "playAudio": { # Specifies an audio clip to be played by the client as part of the response. # Signal that the client should play an audio clip hosted at a client-specific URI. Dialogflow uses this to construct mixed_audio. However, Dialogflow itself does not try to read or process the URI in any way. - "allowPlaybackInterruption": True or False, # 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. - "audioUri": "A String", # Required. URI of the audio clip. Dialogflow does not impose any validation on this value. It is specific to the client that reads it. - }, - "telephonyTransferCall": { # Represents the signal that telles the client to transfer the phone call connected to the agent to a third-party endpoint. # A signal that the client should transfer the phone call connected to this agent to a third-party endpoint. - "phoneNumber": "A String", # Transfer the call to a phone number in [E.164 format](https://en.wikipedia.org/wiki/E.164). - }, - "text": { # The text response message. # Returns a text response. - "allowPlaybackInterruption": True or False, # 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. - "text": [ # Required. A collection of text responses. - "A String", - ], - }, - }, - }, - ], - "condition": "A String", # The condition to activate and select this case. Empty means the condition is always true. The condition is evaluated against form parameters or session parameters. See the [conditions reference](https://cloud.google.com/dialogflow/cx/docs/reference/condition). - }, - ], - }, - ], - "enableGenerativeFallback": True or False, # If the flag is true, the agent will utilize LLM to generate a text response. If LLM generation fails, the defined responses in the fulfillment will be respected. This flag is only useful for fulfillments associated with no-match event handlers. - "messages": [ # The list of rich message responses to present to the user. - { # 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. - "channel": "A String", # The channel which the response is associated with. Clients can specify the channel via QueryParameters.channel, and only associated channel response will be returned. - "conversationSuccess": { # 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. # Indicates that the conversation succeeded. - "metadata": { # Custom metadata. Dialogflow doesn't impose any structure on this. - "a_key": "", # Properties of the object. - }, - }, - "endInteraction": { # 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. # Output only. A signal that indicates the interaction with the Dialogflow agent has ended. This message is generated by Dialogflow only when the conversation reaches `END_SESSION` page. It is not supposed to be defined by the user. It's guaranteed that there is at most one such message in each response. - }, - "knowledgeInfoCard": { # Represents info card response. If the response contains generative knowledge prediction, Dialogflow will return a payload with Infobot Messenger compatible info card. Otherwise, the info card response is skipped. # Represents info card for knowledge answers, to be better rendered in Dialogflow Messenger. - }, - "liveAgentHandoff": { # 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. # Hands off conversation to a human agent. - "metadata": { # Custom metadata for your handoff procedure. Dialogflow doesn't impose any structure on this. - "a_key": "", # Properties of the object. - }, - }, - "mixedAudio": { # 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. # Output only. An audio response message composed of both the synthesized Dialogflow agent responses and responses defined via play_audio. This message is generated by Dialogflow only and not supposed to be defined by the user. - "segments": [ # Segments this audio response is composed of. - { # Represents one segment of audio. - "allowPlaybackInterruption": True or False, # 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. - "audio": "A String", # Raw audio synthesized from the Dialogflow agent's response using the output config specified in the request. - "uri": "A String", # Client-specific URI that points to an audio clip accessible to the client. Dialogflow does not impose any validation on it. - }, - ], - }, - "outputAudioText": { # A text or ssml response that is preferentially used for TTS output audio synthesis, as described in the comment on the ResponseMessage message. # A text or ssml response that is preferentially used for TTS output audio synthesis, as described in the comment on the ResponseMessage message. - "allowPlaybackInterruption": True or False, # 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. - "ssml": "A String", # The SSML text to be synthesized. For more information, see [SSML](/speech/text-to-speech/docs/ssml). - "text": "A String", # The raw text to be synthesized. - }, - "payload": { # Returns a response containing a custom, platform-specific payload. - "a_key": "", # Properties of the object. - }, - "playAudio": { # Specifies an audio clip to be played by the client as part of the response. # Signal that the client should play an audio clip hosted at a client-specific URI. Dialogflow uses this to construct mixed_audio. However, Dialogflow itself does not try to read or process the URI in any way. - "allowPlaybackInterruption": True or False, # 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. - "audioUri": "A String", # Required. URI of the audio clip. Dialogflow does not impose any validation on this value. It is specific to the client that reads it. - }, - "telephonyTransferCall": { # Represents the signal that telles the client to transfer the phone call connected to the agent to a third-party endpoint. # A signal that the client should transfer the phone call connected to this agent to a third-party endpoint. - "phoneNumber": "A String", # Transfer the call to a phone number in [E.164 format](https://en.wikipedia.org/wiki/E.164). - }, - "text": { # The text response message. # Returns a text response. - "allowPlaybackInterruption": True or False, # 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. - "text": [ # Required. A collection of text responses. - "A String", - ], - }, - }, - ], - "returnPartialResponses": True or False, # Whether Dialogflow should return currently queued fulfillment response messages in streaming APIs. If a webhook is specified, it happens before Dialogflow invokes webhook. Warning: 1) This flag only affects streaming API. Responses are still queued and returned once in non-streaming API. 2) The flag can be enabled in any fulfillment but only the first 3 partial responses will be returned. You may only want to apply it to fulfillments that have slow webhooks. - "setParameterActions": [ # Set parameter values before executing the webhook. - { # Setting a parameter value. - "parameter": "A String", # Display name of the parameter. - "value": "", # The new value of the parameter. A null value clears the parameter. - }, - ], - "tag": "A String", # The value of this field will be populated in the WebhookRequest `fulfillmentInfo.tag` field by Dialogflow when the associated webhook is called. The tag is typically used by the webhook service to identify which fulfillment is being called, but it could be used for other purposes. This field is required if `webhook` is specified. - "webhook": "A String", # The webhook to call. Format: `projects//locations//agents//webhooks/`. - }, - "repromptEventHandlers": [ # The handlers for parameter-level events, used to provide reprompt for the parameter or transition to a different page/flow. The supported events are: * `sys.no-match-`, where N can be from 1 to 6 * `sys.no-match-default` * `sys.no-input-`, where N can be from 1 to 6 * `sys.no-input-default` * `sys.invalid-parameter` `initial_prompt_fulfillment` provides the first prompt for the parameter. If the user's response does not fill the parameter, a no-match/no-input event will be triggered, and the fulfillment associated with the `sys.no-match-1`/`sys.no-input-1` handler (if defined) will be called to provide a prompt. The `sys.no-match-2`/`sys.no-input-2` handler (if defined) will respond to the next no-match/no-input event, and so on. A `sys.no-match-default` or `sys.no-input-default` handler will be used to handle all following no-match/no-input events after all numbered no-match/no-input handlers for the parameter are consumed. A `sys.invalid-parameter` handler can be defined to handle the case where the parameter values have been `invalidated` by webhook. For example, if the user's response fill the parameter, however the parameter was invalidated by webhook, the fulfillment associated with the `sys.invalid-parameter` handler (if defined) will be called to provide a prompt. If the event handler for the corresponding event can't be found on the parameter, `initial_prompt_fulfillment` will be re-prompted. - { # An event handler specifies an event that can be handled during a session. When the specified event happens, the following actions are taken in order: * If there is a `trigger_fulfillment` associated with the event, it will be called. * If there is a `target_page` associated with the event, the session will transition into the specified page. * If there is a `target_flow` associated with the event, the session will transition into the specified flow. - "event": "A String", # Required. The name of the event to handle. - "name": "A String", # Output only. The unique identifier of this event handler. - "targetFlow": "A String", # The target flow to transition to. Format: `projects//locations//agents//flows/`. - "targetPage": "A String", # The target page to transition to. Format: `projects//locations//agents//flows//pages/`. - "triggerFulfillment": { # A fulfillment can do one or more of the following actions at the same time: * Generate rich message responses. * Set parameter values. * Call the webhook. Fulfillments can be called at various stages in the Page or Form lifecycle. For example, when a DetectIntentRequest drives a session to enter a new page, the page's entry fulfillment can add a static response to the QueryResult in the returning DetectIntentResponse, call the webhook (for example, to load user data from a database), or both. # The fulfillment to call when the event occurs. Handling webhook errors with a fulfillment enabled with webhook could cause infinite loop. It is invalid to specify such fulfillment for a handler handling webhooks. - "advancedSettings": { # Hierarchical advanced settings for agent/flow/page/fulfillment/parameter. Settings exposed at lower level overrides the settings exposed at higher level. Overriding occurs at the sub-setting level. For example, the playback_interruption_settings at fulfillment level only overrides the playback_interruption_settings at the agent level, leaving other settings at the agent level unchanged. DTMF settings does not override each other. DTMF settings set at different levels define DTMF detections running in parallel. Hierarchy: Agent->Flow->Page->Fulfillment/Parameter. # Hierarchical advanced settings for this fulfillment. The settings exposed at the lower level overrides the settings exposed at the higher level. - "audioExportGcsDestination": { # Google Cloud Storage location for a Dialogflow operation that writes or exports objects (e.g. exported agent or transcripts) outside of Dialogflow. # If present, incoming audio is exported by Dialogflow to the configured Google Cloud Storage destination. Exposed at the following levels: - Agent level - Flow level - "uri": "A String", # Required. The Google Cloud Storage URI for the exported objects. A URI is of the form: `gs://bucket/object-name-or-prefix` Whether a full object name, or just a prefix, its usage depends on the Dialogflow operation. - }, - "dtmfSettings": { # Define behaviors for DTMF (dual tone multi frequency). # Settings for DTMF. Exposed at the following levels: - Agent level - Flow level - Page level - Parameter level. - "enabled": True or False, # If true, incoming audio is processed for DTMF (dual tone multi frequency) events. For example, if the caller presses a button on their telephone keypad and DTMF processing is enabled, Dialogflow will detect the event (e.g. a "3" was pressed) in the incoming audio and pass the event to the bot to drive business logic (e.g. when 3 is pressed, return the account balance). - "endpointingTimeoutDuration": "A String", # Endpoint timeout setting for matching dtmf input to regex. - "finishDigit": "A String", # The digit that terminates a DTMF digit sequence. - "interdigitTimeoutDuration": "A String", # Interdigit timeout setting for matching dtmf input to regex. - "maxDigits": 42, # Max length of DTMF digits. - }, - "loggingSettings": { # Define behaviors on logging. # Settings for logging. Settings for Dialogflow History, Contact Center messages, StackDriver logs, and speech logging. Exposed at the following levels: - Agent level. - "enableInteractionLogging": True or False, # If true, DF Interaction logging is currently enabled. - "enableStackdriverLogging": True or False, # If true, StackDriver logging is currently enabled. - }, - "speechSettings": { # Define behaviors of speech to text detection. # Settings for speech to text detection. Exposed at the following levels: - Agent level - Flow level - Page level - Parameter level - "endpointerSensitivity": 42, # Sensitivity of the speech model that detects the end of speech. Scale from 0 to 100. - "models": { # Mapping from language to Speech-to-Text model. The mapped Speech-to-Text model will be selected for requests from its corresponding language. For more information, see [Speech models](https://cloud.google.com/dialogflow/cx/docs/concept/speech-models). - "a_key": "A String", - }, - "noSpeechTimeout": "A String", # Timeout before detecting no speech. - "useTimeoutBasedEndpointing": True or False, # Use timeout based endpointing, interpreting endpointer sensitivy as seconds of timeout value. - }, - }, - "conditionalCases": [ # Conditional cases for this fulfillment. - { # A list of cascading if-else conditions. Cases are mutually exclusive. The first one with a matching condition is selected, all the rest ignored. - "cases": [ # A list of cascading if-else conditions. - { # Each case has a Boolean condition. When it is evaluated to be True, the corresponding messages will be selected and evaluated recursively. - "caseContent": [ # A list of case content. - { # The list of messages or conditional cases to activate for this case. - "additionalCases": # Object with schema name: GoogleCloudDialogflowCxV3beta1FulfillmentConditionalCases # Additional cases to be evaluated. - "message": { # 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. # Returned message. - "channel": "A String", # The channel which the response is associated with. Clients can specify the channel via QueryParameters.channel, and only associated channel response will be returned. - "conversationSuccess": { # 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. # Indicates that the conversation succeeded. - "metadata": { # Custom metadata. Dialogflow doesn't impose any structure on this. - "a_key": "", # Properties of the object. - }, - }, - "endInteraction": { # 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. # Output only. A signal that indicates the interaction with the Dialogflow agent has ended. This message is generated by Dialogflow only when the conversation reaches `END_SESSION` page. It is not supposed to be defined by the user. It's guaranteed that there is at most one such message in each response. - }, - "knowledgeInfoCard": { # Represents info card response. If the response contains generative knowledge prediction, Dialogflow will return a payload with Infobot Messenger compatible info card. Otherwise, the info card response is skipped. # Represents info card for knowledge answers, to be better rendered in Dialogflow Messenger. - }, - "liveAgentHandoff": { # 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. # Hands off conversation to a human agent. - "metadata": { # Custom metadata for your handoff procedure. Dialogflow doesn't impose any structure on this. - "a_key": "", # Properties of the object. - }, - }, - "mixedAudio": { # 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. # Output only. An audio response message composed of both the synthesized Dialogflow agent responses and responses defined via play_audio. This message is generated by Dialogflow only and not supposed to be defined by the user. - "segments": [ # Segments this audio response is composed of. - { # Represents one segment of audio. - "allowPlaybackInterruption": True or False, # 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. - "audio": "A String", # Raw audio synthesized from the Dialogflow agent's response using the output config specified in the request. - "uri": "A String", # Client-specific URI that points to an audio clip accessible to the client. Dialogflow does not impose any validation on it. - }, - ], - }, - "outputAudioText": { # A text or ssml response that is preferentially used for TTS output audio synthesis, as described in the comment on the ResponseMessage message. # A text or ssml response that is preferentially used for TTS output audio synthesis, as described in the comment on the ResponseMessage message. - "allowPlaybackInterruption": True or False, # 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. - "ssml": "A String", # The SSML text to be synthesized. For more information, see [SSML](/speech/text-to-speech/docs/ssml). - "text": "A String", # The raw text to be synthesized. - }, - "payload": { # Returns a response containing a custom, platform-specific payload. - "a_key": "", # Properties of the object. - }, - "playAudio": { # Specifies an audio clip to be played by the client as part of the response. # Signal that the client should play an audio clip hosted at a client-specific URI. Dialogflow uses this to construct mixed_audio. However, Dialogflow itself does not try to read or process the URI in any way. - "allowPlaybackInterruption": True or False, # 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. - "audioUri": "A String", # Required. URI of the audio clip. Dialogflow does not impose any validation on this value. It is specific to the client that reads it. - }, - "telephonyTransferCall": { # Represents the signal that telles the client to transfer the phone call connected to the agent to a third-party endpoint. # A signal that the client should transfer the phone call connected to this agent to a third-party endpoint. - "phoneNumber": "A String", # Transfer the call to a phone number in [E.164 format](https://en.wikipedia.org/wiki/E.164). - }, - "text": { # The text response message. # Returns a text response. - "allowPlaybackInterruption": True or False, # 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. - "text": [ # Required. A collection of text responses. - "A String", - ], - }, - }, - }, - ], - "condition": "A String", # The condition to activate and select this case. Empty means the condition is always true. The condition is evaluated against form parameters or session parameters. See the [conditions reference](https://cloud.google.com/dialogflow/cx/docs/reference/condition). - }, - ], - }, - ], - "enableGenerativeFallback": True or False, # If the flag is true, the agent will utilize LLM to generate a text response. If LLM generation fails, the defined responses in the fulfillment will be respected. This flag is only useful for fulfillments associated with no-match event handlers. - "messages": [ # The list of rich message responses to present to the user. - { # 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. + }, + "conditionalCases": [ # Conditional cases for this fulfillment. + { # A list of cascading if-else conditions. Cases are mutually exclusive. The first one with a matching condition is selected, all the rest ignored. + "cases": [ # A list of cascading if-else conditions. + { # Each case has a Boolean condition. When it is evaluated to be True, the corresponding messages will be selected and evaluated recursively. + "caseContent": [ # A list of case content. + { # The list of messages or conditional cases to activate for this case. + "additionalCases": # Object with schema name: GoogleCloudDialogflowCxV3beta1FulfillmentConditionalCases # Additional cases to be evaluated. + "message": { # 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. # Returned message. "channel": "A String", # The channel which the response is associated with. Clients can specify the channel via QueryParameters.channel, and only associated channel response will be returned. "conversationSuccess": { # 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. # Indicates that the conversation succeeded. "metadata": { # Custom metadata. Dialogflow doesn't impose any structure on this. @@ -930,119 +584,17 @@

Method Details

"A String", ], }, + "toolCall": { # Represents a call of a specific tool's action with the specified inputs. # Returns the definition of a tool call that should be executed by the client. + "action": "A String", # Required. The name of the tool's action associated with this call. + "inputParameters": { # Optional. The action's input parameters. + "a_key": "", # Properties of the object. + }, + "tool": "A String", # Required. The tool associated with this call. Format: `projects//locations//agents//tools/`. + }, }, - ], - "returnPartialResponses": True or False, # Whether Dialogflow should return currently queued fulfillment response messages in streaming APIs. If a webhook is specified, it happens before Dialogflow invokes webhook. Warning: 1) This flag only affects streaming API. Responses are still queued and returned once in non-streaming API. 2) The flag can be enabled in any fulfillment but only the first 3 partial responses will be returned. You may only want to apply it to fulfillments that have slow webhooks. - "setParameterActions": [ # Set parameter values before executing the webhook. - { # Setting a parameter value. - "parameter": "A String", # Display name of the parameter. - "value": "", # The new value of the parameter. A null value clears the parameter. - }, - ], - "tag": "A String", # The value of this field will be populated in the WebhookRequest `fulfillmentInfo.tag` field by Dialogflow when the associated webhook is called. The tag is typically used by the webhook service to identify which fulfillment is being called, but it could be used for other purposes. This field is required if `webhook` is specified. - "webhook": "A String", # The webhook to call. Format: `projects//locations//agents//webhooks/`. - }, - }, - ], - }, - "isList": True or False, # Indicates whether the parameter represents a list of values. - "redact": True or False, # Indicates whether the parameter content should be redacted in log. If redaction is enabled, the parameter content will be replaced by parameter name during logging. Note: the parameter content is subject to redaction if either parameter level redaction or entity type level redaction is enabled. - "required": True or False, # 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. - }, - ], - }, - "knowledgeConnectorSettings": { # The Knowledge Connector settings for this page or flow. This includes information such as the attached Knowledge Bases, and the way to execute fulfillment. # Optional. Knowledge connector configuration. - "dataStoreConnections": [ # Optional. List of related data store connections. - { # A data store connection. It represents a data store in Discovery Engine and the type of the contents it contains. - "dataStore": "A String", # The full name of the referenced data store. Formats: `projects/{project}/locations/{location}/collections/{collection}/dataStores/{data_store}` `projects/{project}/locations/{location}/dataStores/{data_store}` - "dataStoreType": "A String", # The type of the connected data store. - }, - ], - "enabled": True or False, # Whether Knowledge Connector is enabled or not. - "targetFlow": "A String", # The target flow to transition to. Format: `projects//locations//agents//flows/`. - "targetPage": "A String", # The target page to transition to. Format: `projects//locations//agents//flows//pages/`. - "triggerFulfillment": { # A fulfillment can do one or more of the following actions at the same time: * Generate rich message responses. * Set parameter values. * Call the webhook. Fulfillments can be called at various stages in the Page or Form lifecycle. For example, when a DetectIntentRequest drives a session to enter a new page, the page's entry fulfillment can add a static response to the QueryResult in the returning DetectIntentResponse, call the webhook (for example, to load user data from a database), or both. # The fulfillment to be triggered. When the answers from the Knowledge Connector are selected by Dialogflow, you can utitlize the request scoped parameter `$request.knowledge.answers` (contains up to the 5 highest confidence answers) and `$request.knowledge.questions` (contains the corresponding questions) to construct the fulfillment. - "advancedSettings": { # Hierarchical advanced settings for agent/flow/page/fulfillment/parameter. Settings exposed at lower level overrides the settings exposed at higher level. Overriding occurs at the sub-setting level. For example, the playback_interruption_settings at fulfillment level only overrides the playback_interruption_settings at the agent level, leaving other settings at the agent level unchanged. DTMF settings does not override each other. DTMF settings set at different levels define DTMF detections running in parallel. Hierarchy: Agent->Flow->Page->Fulfillment/Parameter. # Hierarchical advanced settings for this fulfillment. The settings exposed at the lower level overrides the settings exposed at the higher level. - "audioExportGcsDestination": { # Google Cloud Storage location for a Dialogflow operation that writes or exports objects (e.g. exported agent or transcripts) outside of Dialogflow. # If present, incoming audio is exported by Dialogflow to the configured Google Cloud Storage destination. Exposed at the following levels: - Agent level - Flow level - "uri": "A String", # Required. The Google Cloud Storage URI for the exported objects. A URI is of the form: `gs://bucket/object-name-or-prefix` Whether a full object name, or just a prefix, its usage depends on the Dialogflow operation. - }, - "dtmfSettings": { # Define behaviors for DTMF (dual tone multi frequency). # Settings for DTMF. Exposed at the following levels: - Agent level - Flow level - Page level - Parameter level. - "enabled": True or False, # If true, incoming audio is processed for DTMF (dual tone multi frequency) events. For example, if the caller presses a button on their telephone keypad and DTMF processing is enabled, Dialogflow will detect the event (e.g. a "3" was pressed) in the incoming audio and pass the event to the bot to drive business logic (e.g. when 3 is pressed, return the account balance). - "endpointingTimeoutDuration": "A String", # Endpoint timeout setting for matching dtmf input to regex. - "finishDigit": "A String", # The digit that terminates a DTMF digit sequence. - "interdigitTimeoutDuration": "A String", # Interdigit timeout setting for matching dtmf input to regex. - "maxDigits": 42, # Max length of DTMF digits. - }, - "loggingSettings": { # Define behaviors on logging. # Settings for logging. Settings for Dialogflow History, Contact Center messages, StackDriver logs, and speech logging. Exposed at the following levels: - Agent level. - "enableInteractionLogging": True or False, # If true, DF Interaction logging is currently enabled. - "enableStackdriverLogging": True or False, # If true, StackDriver logging is currently enabled. - }, - "speechSettings": { # Define behaviors of speech to text detection. # Settings for speech to text detection. Exposed at the following levels: - Agent level - Flow level - Page level - Parameter level - "endpointerSensitivity": 42, # Sensitivity of the speech model that detects the end of speech. Scale from 0 to 100. - "models": { # Mapping from language to Speech-to-Text model. The mapped Speech-to-Text model will be selected for requests from its corresponding language. For more information, see [Speech models](https://cloud.google.com/dialogflow/cx/docs/concept/speech-models). - "a_key": "A String", - }, - "noSpeechTimeout": "A String", # Timeout before detecting no speech. - "useTimeoutBasedEndpointing": True or False, # Use timeout based endpointing, interpreting endpointer sensitivy as seconds of timeout value. - }, - }, - "conditionalCases": [ # Conditional cases for this fulfillment. - { # A list of cascading if-else conditions. Cases are mutually exclusive. The first one with a matching condition is selected, all the rest ignored. - "cases": [ # A list of cascading if-else conditions. - { # Each case has a Boolean condition. When it is evaluated to be True, the corresponding messages will be selected and evaluated recursively. - "caseContent": [ # A list of case content. - { # The list of messages or conditional cases to activate for this case. - "additionalCases": # Object with schema name: GoogleCloudDialogflowCxV3beta1FulfillmentConditionalCases # Additional cases to be evaluated. - "message": { # 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. # Returned message. - "channel": "A String", # The channel which the response is associated with. Clients can specify the channel via QueryParameters.channel, and only associated channel response will be returned. - "conversationSuccess": { # 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. # Indicates that the conversation succeeded. - "metadata": { # Custom metadata. Dialogflow doesn't impose any structure on this. - "a_key": "", # Properties of the object. - }, - }, - "endInteraction": { # 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. # Output only. A signal that indicates the interaction with the Dialogflow agent has ended. This message is generated by Dialogflow only when the conversation reaches `END_SESSION` page. It is not supposed to be defined by the user. It's guaranteed that there is at most one such message in each response. - }, - "knowledgeInfoCard": { # Represents info card response. If the response contains generative knowledge prediction, Dialogflow will return a payload with Infobot Messenger compatible info card. Otherwise, the info card response is skipped. # Represents info card for knowledge answers, to be better rendered in Dialogflow Messenger. - }, - "liveAgentHandoff": { # 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. # Hands off conversation to a human agent. - "metadata": { # Custom metadata for your handoff procedure. Dialogflow doesn't impose any structure on this. - "a_key": "", # Properties of the object. - }, - }, - "mixedAudio": { # 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. # Output only. An audio response message composed of both the synthesized Dialogflow agent responses and responses defined via play_audio. This message is generated by Dialogflow only and not supposed to be defined by the user. - "segments": [ # Segments this audio response is composed of. - { # Represents one segment of audio. - "allowPlaybackInterruption": True or False, # 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. - "audio": "A String", # Raw audio synthesized from the Dialogflow agent's response using the output config specified in the request. - "uri": "A String", # Client-specific URI that points to an audio clip accessible to the client. Dialogflow does not impose any validation on it. - }, - ], - }, - "outputAudioText": { # A text or ssml response that is preferentially used for TTS output audio synthesis, as described in the comment on the ResponseMessage message. # A text or ssml response that is preferentially used for TTS output audio synthesis, as described in the comment on the ResponseMessage message. - "allowPlaybackInterruption": True or False, # 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. - "ssml": "A String", # The SSML text to be synthesized. For more information, see [SSML](/speech/text-to-speech/docs/ssml). - "text": "A String", # The raw text to be synthesized. - }, - "payload": { # Returns a response containing a custom, platform-specific payload. - "a_key": "", # Properties of the object. - }, - "playAudio": { # Specifies an audio clip to be played by the client as part of the response. # Signal that the client should play an audio clip hosted at a client-specific URI. Dialogflow uses this to construct mixed_audio. However, Dialogflow itself does not try to read or process the URI in any way. - "allowPlaybackInterruption": True or False, # 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. - "audioUri": "A String", # Required. URI of the audio clip. Dialogflow does not impose any validation on this value. It is specific to the client that reads it. - }, - "telephonyTransferCall": { # Represents the signal that telles the client to transfer the phone call connected to the agent to a third-party endpoint. # A signal that the client should transfer the phone call connected to this agent to a third-party endpoint. - "phoneNumber": "A String", # Transfer the call to a phone number in [E.164 format](https://en.wikipedia.org/wiki/E.164). - }, - "text": { # The text response message. # Returns a text response. - "allowPlaybackInterruption": True or False, # 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. - "text": [ # Required. A collection of text responses. - "A String", - ], - }, - }, - }, - ], - "condition": "A String", # The condition to activate and select this case. Empty means the condition is always true. The condition is evaluated against form parameters or session parameters. See the [conditions reference](https://cloud.google.com/dialogflow/cx/docs/reference/condition). + }, + ], + "condition": "A String", # The condition to activate and select this case. Empty means the condition is always true. The condition is evaluated against form parameters or session parameters. See the [conditions reference](https://cloud.google.com/dialogflow/cx/docs/reference/condition). }, ], }, @@ -1095,6 +647,13 @@

Method Details

"A String", ], }, + "toolCall": { # Represents a call of a specific tool's action with the specified inputs. # Returns the definition of a tool call that should be executed by the client. + "action": "A String", # Required. The name of the tool's action associated with this call. + "inputParameters": { # Optional. The action's input parameters. + "a_key": "", # Properties of the object. + }, + "tool": "A String", # Required. The tool associated with this call. Format: `projects//locations//agents//tools/`. + }, }, ], "returnPartialResponses": True or False, # Whether Dialogflow should return currently queued fulfillment response messages in streaming APIs. If a webhook is specified, it happens before Dialogflow invokes webhook. Warning: 1) This flag only affects streaming API. Responses are still queued and returned once in non-streaming API. 2) The flag can be enabled in any fulfillment but only the first 3 partial responses will be returned. You may only want to apply it to fulfillments that have slow webhooks. @@ -1108,11 +667,22 @@

Method Details

"webhook": "A String", # The webhook to call. Format: `projects//locations//agents//webhooks/`. }, }, - "name": "A String", # The unique identifier of the page. Required for the Pages.UpdatePage method. Pages.CreatePage populates the name automatically. Format: `projects//locations//agents//flows//pages/`. - "transitionRouteGroups": [ # Ordered list of `TransitionRouteGroups` added to the page. Transition route groups must be unique within a page. If the page links both flow-level transition route groups and agent-level transition route groups, the flow-level ones will have higher priority and will be put before the agent-level ones. * If multiple transition routes within a page scope refer to the same intent, then the precedence order is: page's transition route -> page's transition route group -> flow's transition routes. * If multiple transition route groups within a page contain the same intent, then the first group in the ordered list takes precedence. Format:`projects//locations//agents//flows//transitionRouteGroups/` or `projects//locations//agents//transitionRouteGroups/` for agent-level groups. + "multiLanguageSettings": { # Settings for multi-lingual agents. # Optional. Multi-lingual agent settings for this flow. + "enableMultiLanguageDetection": True or False, # Optional. Enable multi-language detection for this flow. This can be set only if agent level multi language setting is enabled. + "supportedResponseLanguageCodes": [ # Optional. Agent will respond in the detected language if the detected language code is in the supported resolved languages for this flow. This will be used only if multi-language training is enabled in the agent and multi-language detection is enabled in the flow. The supported languages must be a subset of the languages supported by the agent. + "A String", + ], + }, + "name": "A String", # The unique identifier of the flow. Format: `projects//locations//agents//flows/`. + "nluSettings": { # Settings related to NLU. # NLU related settings of the flow. + "classificationThreshold": 3.14, # To filter out false positive results and still get variety in matched natural language inputs for your agent, you can tune the machine learning classification threshold. If the returned score value is less than the threshold value, then a no-match event will be triggered. The score values range from 0.0 (completely uncertain) to 1.0 (completely certain). If set to 0.0, the default of 0.3 is used. + "modelTrainingMode": "A String", # Indicates NLU model training mode. + "modelType": "A String", # Indicates the type of NLU model. + }, + "transitionRouteGroups": [ # A flow's transition route group serve two purposes: * They are responsible for matching the user's first utterances in the flow. * They are inherited by every page's transition route groups. Transition route groups defined in the page have higher priority than those defined in the flow. Format:`projects//locations//agents//flows//transitionRouteGroups/` or `projects//locations//agents//transitionRouteGroups/` for agent-level groups. "A String", ], - "transitionRoutes": [ # A list of transitions for the transition rules of this page. They route the conversation to another page in the same flow, or another flow. When we are in a certain page, the TransitionRoutes are evalauted in the following order: * TransitionRoutes defined in the page with intent specified. * TransitionRoutes defined in the transition route groups with intent specified. * TransitionRoutes defined in flow with intent specified. * TransitionRoutes defined in the transition route groups with intent specified. * TransitionRoutes defined in the page with only condition specified. * TransitionRoutes defined in the transition route groups with only condition specified. + "transitionRoutes": [ # A flow's transition routes serve two purposes: * They are responsible for matching the user's first utterances in the flow. * They are inherited by every page's transition routes and can support use cases such as the user saying "help" or "can I talk to a human?", which can be handled in a common way regardless of the current page. Transition routes defined in the page have higher priority than those defined in the flow. TransitionRoutes are evalauted in the following order: * TransitionRoutes with intent specified. * TransitionRoutes with only condition specified. TransitionRoutes with intent specified are inherited by pages in the flow. { # A transition route specifies a intent that can be matched and/or a data condition that can be evaluated during a session. When a specified transition is matched, the following actions are taken in order: * If there is a `trigger_fulfillment` associated with the transition, it will be called. * If there is a `target_page` associated with the transition, the session will transition into the specified page. * If there is a `target_flow` associated with the transition, the session will transition into the specified flow. "condition": "A String", # The condition to evaluate against form parameters or session parameters. See the [conditions reference](https://cloud.google.com/dialogflow/cx/docs/reference/condition). At least one of `intent` or `condition` must be specified. When both `intent` and `condition` are specified, the transition can only happen when both are fulfilled. "description": "A String", # Optional. The description of the transition route. The maximum length is 500 characters. @@ -1133,8 +703,8 @@

Method Details

"maxDigits": 42, # Max length of DTMF digits. }, "loggingSettings": { # Define behaviors on logging. # Settings for logging. Settings for Dialogflow History, Contact Center messages, StackDriver logs, and speech logging. Exposed at the following levels: - Agent level. - "enableInteractionLogging": True or False, # If true, DF Interaction logging is currently enabled. - "enableStackdriverLogging": True or False, # If true, StackDriver logging is currently enabled. + "enableInteractionLogging": True or False, # Enables DF Interaction logging. + "enableStackdriverLogging": True or False, # Enables StackDriver logging. }, "speechSettings": { # Define behaviors of speech to text detection. # Settings for speech to text detection. Exposed at the following levels: - Agent level - Flow level - Page level - Parameter level "endpointerSensitivity": 42, # Sensitivity of the speech model that detects the end of speech. Scale from 0 to 100. @@ -1198,6 +768,13 @@

Method Details

"A String", ], }, + "toolCall": { # Represents a call of a specific tool's action with the specified inputs. # Returns the definition of a tool call that should be executed by the client. + "action": "A String", # Required. The name of the tool's action associated with this call. + "inputParameters": { # Optional. The action's input parameters. + "a_key": "", # Properties of the object. + }, + "tool": "A String", # Required. The tool associated with this call. Format: `projects//locations//agents//tools/`. + }, }, }, ], @@ -1254,6 +831,13 @@

Method Details

"A String", ], }, + "toolCall": { # Represents a call of a specific tool's action with the specified inputs. # Returns the definition of a tool call that should be executed by the client. + "action": "A String", # Required. The name of the tool's action associated with this call. + "inputParameters": { # Optional. The action's input parameters. + "a_key": "", # Properties of the object. + }, + "tool": "A String", # Required. The tool associated with this call. Format: `projects//locations//agents//tools/`. + }, }, ], "returnPartialResponses": True or False, # Whether Dialogflow should return currently queued fulfillment response messages in streaming APIs. If a webhook is specified, it happens before Dialogflow invokes webhook. Warning: 1) This flag only affects streaming API. Responses are still queued and returned once in non-streaming API. 2) The flag can be enabled in any fulfillment but only the first 3 partial responses will be returned. You may only want to apply it to fulfillments that have slow webhooks. @@ -1269,450 +853,2164 @@

Method Details

}, ], }, - "dataStoreConnectionSignals": { # Data store connection feature output signals. Might be only partially field if processing stop before the final answer. Reasons for this can be, but are not limited to: empty UCS search results, positive RAI check outcome, grounding failure, ... # Optional. Data store connection feature output signals. Filled only when data stores are involved in serving the query and DetectIntentRequest.populate data_store_connection_quality_signals is set to true in the request. - "answer": "A String", # Optional. The final compiled answer. - "answerGenerationModelCallSignals": { # Diagnostic info related to the answer generation model call. # Optional. Diagnostic info related to the answer generation model call. - "modelOutput": "A String", # Output of the generative model. - "renderedPrompt": "A String", # Prompt as sent to the model. - }, - "answerParts": [ # Optional. Answer parts with relevant citations. Concatenation of texts should add up the `answer` (not counting whitespaces). - { # Answer part with citation. - "supportingIndices": [ # Citations for this answer part. Indices of `search_snippets`. - 42, - ], - "text": "A String", # Substring of the answer. - }, - ], - "citedSnippets": [ # Optional. Snippets cited by the answer generation model from the most to least relevant. - { # Snippet cited by the answer generation model. - "searchSnippet": { # Search snippet details. # Details of the snippet. - "documentTitle": "A String", # Title of the enclosing document. - "documentUri": "A String", # Uri for the document. Present if specified for the document. - "text": "A String", # Text included in the prompt. - }, - "snippetIndex": 42, # Index of the snippet in `search_snippets` field. - }, - ], - "groundingSignals": { # Grounding signals. # Optional. Grounding signals. - "decision": "A String", # Represents the decision of the grounding check. - "score": "A String", # Grounding score bucket setting. - }, - "rewriterModelCallSignals": { # Diagnostic info related to the rewriter model call. # Optional. Diagnostic info related to the rewriter model call. - "modelOutput": "A String", # Output of the generative model. - "renderedPrompt": "A String", # Prompt as sent to the model. - }, - "rewrittenQuery": "A String", # Optional. Rewritten string query used for search. - "safetySignals": { # Safety check results. # Optional. Safety check result. - "bannedPhraseMatch": "A String", # Specifies banned phrase match subject. - "decision": "A String", # Safety decision. - "matchedBannedPhrase": "A String", # The matched banned phrase if there was a match. - }, - "searchSnippets": [ # Optional. Search snippets included in the answer generation prompt. - { # Search snippet details. - "documentTitle": "A String", # Title of the enclosing document. - "documentUri": "A String", # Uri for the document. Present if specified for the document. - "text": "A String", # Text included in the prompt. + "currentPage": { # A Dialogflow CX conversation (session) can be described and visualized as a state machine. The states of a CX session are represented by pages. For each flow, you define many pages, where your combined pages can handle a complete conversation on the topics the flow is designed for. At any given moment, exactly one page is the current page, the current page is considered active, and the flow associated with that page is considered active. Every flow has a special start page. When a flow initially becomes active, the start page page becomes the current page. For each conversational turn, the current page will either stay the same or transition to another page. You configure each page to collect information from the end-user that is relevant for the conversational state represented by the page. For more information, see the [Page guide](https://cloud.google.com/dialogflow/cx/docs/concept/page). # The current Page. Some, not all fields are filled in this message, including but not limited to `name` and `display_name`. + "advancedSettings": { # Hierarchical advanced settings for agent/flow/page/fulfillment/parameter. Settings exposed at lower level overrides the settings exposed at higher level. Overriding occurs at the sub-setting level. For example, the playback_interruption_settings at fulfillment level only overrides the playback_interruption_settings at the agent level, leaving other settings at the agent level unchanged. DTMF settings does not override each other. DTMF settings set at different levels define DTMF detections running in parallel. Hierarchy: Agent->Flow->Page->Fulfillment/Parameter. # Hierarchical advanced settings for this page. The settings exposed at the lower level overrides the settings exposed at the higher level. + "audioExportGcsDestination": { # Google Cloud Storage location for a Dialogflow operation that writes or exports objects (e.g. exported agent or transcripts) outside of Dialogflow. # If present, incoming audio is exported by Dialogflow to the configured Google Cloud Storage destination. Exposed at the following levels: - Agent level - Flow level + "uri": "A String", # Required. The Google Cloud Storage URI for the exported objects. A URI is of the form: `gs://bucket/object-name-or-prefix` Whether a full object name, or just a prefix, its usage depends on the Dialogflow operation. }, - ], - }, - "diagnosticInfo": { # The free-form diagnostic info. For example, this field could contain webhook call latency. The fields of this data can change without notice, so you should not write code that depends on its structure. One of the fields is called "Alternative Matched Intents", which may aid with debugging. The following describes these intent results: - The list is empty if no intent was matched to end-user input. - Only intents that are referenced in the currently active flow are included. - The matched intent is included. - Other intents that could have matched end-user input, but did not match because they are referenced by intent routes that are out of [scope](https://cloud.google.com/dialogflow/cx/docs/concept/handler#scope), are included. - Other intents referenced by intent routes in scope that matched end-user input, but had a lower confidence score. - "a_key": "", # Properties of the object. - }, - "dtmf": { # Represents the input for dtmf event. # If a DTMF was provided as input, this field will contain a copy of the DtmfInput. - "digits": "A String", # The dtmf digits. - "finishDigit": "A String", # The finish digit (if any). - }, - "intent": { # An intent represents a user's intent to interact with a conversational agent. You can provide information for the Dialogflow API to use to match user input to an intent by adding training phrases (i.e., examples of user input) to your intent. # The Intent that matched the conversational query. Some, not all fields are filled in this message, including but not limited to: `name` and `display_name`. This field is deprecated, please use QueryResult.match instead. - "description": "A String", # Human readable description for better understanding an intent like its scope, content, result etc. Maximum character limit: 140 characters. - "displayName": "A String", # Required. The human-readable name of the intent, unique within the agent. - "isFallback": True or False, # Indicates whether this is a fallback intent. Currently only default fallback intent is allowed in the agent, which is added upon agent creation. Adding training phrases to fallback intent is useful in the case of requests that are mistakenly matched, since training phrases assigned to fallback intents act as negative examples that triggers no-match event. - "labels": { # The key/value metadata to label an intent. Labels can contain lowercase letters, digits and the symbols '-' and '_'. International characters are allowed, including letters from unicase alphabets. Keys must start with a letter. Keys and values can be no longer than 63 characters and no more than 128 bytes. Prefix "sys-" is reserved for Dialogflow defined labels. Currently allowed Dialogflow defined labels include: * sys-head * sys-contextual The above labels do not require value. "sys-head" means the intent is a head intent. "sys-contextual" means the intent is a contextual intent. - "a_key": "A String", - }, - "name": "A String", # The unique identifier of the intent. Required for the Intents.UpdateIntent method. Intents.CreateIntent populates the name automatically. Format: `projects//locations//agents//intents/`. - "parameters": [ # The collection of parameters associated with the intent. - { # Represents an intent parameter. - "entityType": "A String", # Required. The entity type of the parameter. Format: `projects/-/locations/-/agents/-/entityTypes/` for system entity types (for example, `projects/-/locations/-/agents/-/entityTypes/sys.date`), or `projects//locations//agents//entityTypes/` for developer entity types. - "id": "A String", # Required. The unique identifier of the parameter. This field is used by training phrases to annotate their parts. - "isList": True or False, # Indicates whether the parameter represents a list of values. - "redact": True or False, # Indicates whether the parameter content should be redacted in log. If redaction is enabled, the parameter content will be replaced by parameter name during logging. Note: the parameter content is subject to redaction if either parameter level redaction or entity type level redaction is enabled. + "dtmfSettings": { # Define behaviors for DTMF (dual tone multi frequency). # Settings for DTMF. Exposed at the following levels: - Agent level - Flow level - Page level - Parameter level. + "enabled": True or False, # If true, incoming audio is processed for DTMF (dual tone multi frequency) events. For example, if the caller presses a button on their telephone keypad and DTMF processing is enabled, Dialogflow will detect the event (e.g. a "3" was pressed) in the incoming audio and pass the event to the bot to drive business logic (e.g. when 3 is pressed, return the account balance). + "endpointingTimeoutDuration": "A String", # Endpoint timeout setting for matching dtmf input to regex. + "finishDigit": "A String", # The digit that terminates a DTMF digit sequence. + "interdigitTimeoutDuration": "A String", # Interdigit timeout setting for matching dtmf input to regex. + "maxDigits": 42, # Max length of DTMF digits. }, - ], - "priority": 42, # 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. - "trainingPhrases": [ # The collection of training phrases the agent is trained on to identify the intent. - { # Represents an example that the agent is trained on to identify the intent. - "id": "A String", # Output only. The unique identifier of the training phrase. - "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 `parameter_id` field is set. - { # Represents a part of a training phrase. - "parameterId": "A String", # The parameter used to annotate this part of the training phrase. This field is required for annotated parts of the training phrase. - "text": "A String", # Required. The text for this part. - }, - ], - "repeatCount": 42, # Indicates how many times this example was added to the intent. + "loggingSettings": { # Define behaviors on logging. # Settings for logging. Settings for Dialogflow History, Contact Center messages, StackDriver logs, and speech logging. Exposed at the following levels: - Agent level. + "enableInteractionLogging": True or False, # Enables DF Interaction logging. + "enableStackdriverLogging": True or False, # Enables StackDriver logging. }, - ], - }, - "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. This field is deprecated, please use QueryResult.match instead. - "languageCode": "A String", # The language that was triggered during intent detection. See [Language Support](https://cloud.google.com/dialogflow/cx/docs/reference/language) for a list of the currently supported language codes. - "match": { # Represents one match result of MatchIntent. # Intent match result, could be an intent or an event. - "confidence": 3.14, # The confidence of this match. 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. - "event": "A String", # The event that matched the query. Filled for `EVENT`, `NO_MATCH` and `NO_INPUT` match types. - "intent": { # An intent represents a user's intent to interact with a conversational agent. You can provide information for the Dialogflow API to use to match user input to an intent by adding training phrases (i.e., examples of user input) to your intent. # The Intent that matched the query. Some, not all fields are filled in this message, including but not limited to: `name` and `display_name`. Only filled for `INTENT` match type. - "description": "A String", # Human readable description for better understanding an intent like its scope, content, result etc. Maximum character limit: 140 characters. - "displayName": "A String", # Required. The human-readable name of the intent, unique within the agent. - "isFallback": True or False, # Indicates whether this is a fallback intent. Currently only default fallback intent is allowed in the agent, which is added upon agent creation. Adding training phrases to fallback intent is useful in the case of requests that are mistakenly matched, since training phrases assigned to fallback intents act as negative examples that triggers no-match event. - "labels": { # The key/value metadata to label an intent. Labels can contain lowercase letters, digits and the symbols '-' and '_'. International characters are allowed, including letters from unicase alphabets. Keys must start with a letter. Keys and values can be no longer than 63 characters and no more than 128 bytes. Prefix "sys-" is reserved for Dialogflow defined labels. Currently allowed Dialogflow defined labels include: * sys-head * sys-contextual The above labels do not require value. "sys-head" means the intent is a head intent. "sys-contextual" means the intent is a contextual intent. - "a_key": "A String", + "speechSettings": { # Define behaviors of speech to text detection. # Settings for speech to text detection. Exposed at the following levels: - Agent level - Flow level - Page level - Parameter level + "endpointerSensitivity": 42, # Sensitivity of the speech model that detects the end of speech. Scale from 0 to 100. + "models": { # Mapping from language to Speech-to-Text model. The mapped Speech-to-Text model will be selected for requests from its corresponding language. For more information, see [Speech models](https://cloud.google.com/dialogflow/cx/docs/concept/speech-models). + "a_key": "A String", + }, + "noSpeechTimeout": "A String", # Timeout before detecting no speech. + "useTimeoutBasedEndpointing": True or False, # Use timeout based endpointing, interpreting endpointer sensitivy as seconds of timeout value. }, - "name": "A String", # The unique identifier of the intent. Required for the Intents.UpdateIntent method. Intents.CreateIntent populates the name automatically. Format: `projects//locations//agents//intents/`. - "parameters": [ # The collection of parameters associated with the intent. - { # Represents an intent parameter. - "entityType": "A String", # Required. The entity type of the parameter. Format: `projects/-/locations/-/agents/-/entityTypes/` for system entity types (for example, `projects/-/locations/-/agents/-/entityTypes/sys.date`), or `projects//locations//agents//entityTypes/` for developer entity types. - "id": "A String", # Required. The unique identifier of the parameter. This field is used by training phrases to annotate their parts. - "isList": True or False, # Indicates whether the parameter represents a list of values. - "redact": True or False, # Indicates whether the parameter content should be redacted in log. If redaction is enabled, the parameter content will be replaced by parameter name during logging. Note: the parameter content is subject to redaction if either parameter level redaction or entity type level redaction is enabled. + }, + "description": "A String", # The description of the page. The maximum length is 500 characters. + "displayName": "A String", # Required. The human-readable name of the page, unique within the flow. + "entryFulfillment": { # A fulfillment can do one or more of the following actions at the same time: * Generate rich message responses. * Set parameter values. * Call the webhook. Fulfillments can be called at various stages in the Page or Form lifecycle. For example, when a DetectIntentRequest drives a session to enter a new page, the page's entry fulfillment can add a static response to the QueryResult in the returning DetectIntentResponse, call the webhook (for example, to load user data from a database), or both. # The fulfillment to call when the session is entering the page. + "advancedSettings": { # Hierarchical advanced settings for agent/flow/page/fulfillment/parameter. Settings exposed at lower level overrides the settings exposed at higher level. Overriding occurs at the sub-setting level. For example, the playback_interruption_settings at fulfillment level only overrides the playback_interruption_settings at the agent level, leaving other settings at the agent level unchanged. DTMF settings does not override each other. DTMF settings set at different levels define DTMF detections running in parallel. Hierarchy: Agent->Flow->Page->Fulfillment/Parameter. # Hierarchical advanced settings for this fulfillment. The settings exposed at the lower level overrides the settings exposed at the higher level. + "audioExportGcsDestination": { # Google Cloud Storage location for a Dialogflow operation that writes or exports objects (e.g. exported agent or transcripts) outside of Dialogflow. # If present, incoming audio is exported by Dialogflow to the configured Google Cloud Storage destination. Exposed at the following levels: - Agent level - Flow level + "uri": "A String", # Required. The Google Cloud Storage URI for the exported objects. A URI is of the form: `gs://bucket/object-name-or-prefix` Whether a full object name, or just a prefix, its usage depends on the Dialogflow operation. }, - ], - "priority": 42, # 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. - "trainingPhrases": [ # The collection of training phrases the agent is trained on to identify the intent. - { # Represents an example that the agent is trained on to identify the intent. - "id": "A String", # Output only. The unique identifier of the training phrase. - "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 `parameter_id` field is set. - { # Represents a part of a training phrase. - "parameterId": "A String", # The parameter used to annotate this part of the training phrase. This field is required for annotated parts of the training phrase. - "text": "A String", # Required. The text for this part. - }, - ], - "repeatCount": 42, # Indicates how many times this example was added to the intent. + "dtmfSettings": { # Define behaviors for DTMF (dual tone multi frequency). # Settings for DTMF. Exposed at the following levels: - Agent level - Flow level - Page level - Parameter level. + "enabled": True or False, # If true, incoming audio is processed for DTMF (dual tone multi frequency) events. For example, if the caller presses a button on their telephone keypad and DTMF processing is enabled, Dialogflow will detect the event (e.g. a "3" was pressed) in the incoming audio and pass the event to the bot to drive business logic (e.g. when 3 is pressed, return the account balance). + "endpointingTimeoutDuration": "A String", # Endpoint timeout setting for matching dtmf input to regex. + "finishDigit": "A String", # The digit that terminates a DTMF digit sequence. + "interdigitTimeoutDuration": "A String", # Interdigit timeout setting for matching dtmf input to regex. + "maxDigits": 42, # Max length of DTMF digits. }, - ], - }, - "matchType": "A String", # Type of this Match. - "parameters": { # The collection of parameters extracted from the query. 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 then use map, otherwise, depending on the parameter value type, it could be one of string, number, boolean, null, list or map. * MapValue value: If parameter's entity type is a composite entity then use map from composite entity property names to property values, otherwise, use parameter value. - "a_key": "", # Properties of the object. - }, - "resolvedInput": "A String", # Final text input which was matched during MatchIntent. This value can be different from original input sent in request because of spelling correction or other processing. - }, - "parameters": { # The collected session 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 then use map, otherwise, depending on the parameter value type, it could be one of string, number, boolean, null, list or map. * MapValue value: If parameter's entity type is a composite entity then use map from composite entity property names to property values, otherwise, use parameter value. - "a_key": "", # Properties of the object. - }, - "responseMessages": [ # The list of rich messages returned to the client. Responses vary from simple text messages to more sophisticated, structured payloads used to drive complex logic. - { # 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. - "channel": "A String", # The channel which the response is associated with. Clients can specify the channel via QueryParameters.channel, and only associated channel response will be returned. - "conversationSuccess": { # 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. # Indicates that the conversation succeeded. - "metadata": { # Custom metadata. Dialogflow doesn't impose any structure on this. - "a_key": "", # Properties of the object. + "loggingSettings": { # Define behaviors on logging. # Settings for logging. Settings for Dialogflow History, Contact Center messages, StackDriver logs, and speech logging. Exposed at the following levels: - Agent level. + "enableInteractionLogging": True or False, # Enables DF Interaction logging. + "enableStackdriverLogging": True or False, # Enables StackDriver logging. + }, + "speechSettings": { # Define behaviors of speech to text detection. # Settings for speech to text detection. Exposed at the following levels: - Agent level - Flow level - Page level - Parameter level + "endpointerSensitivity": 42, # Sensitivity of the speech model that detects the end of speech. Scale from 0 to 100. + "models": { # Mapping from language to Speech-to-Text model. The mapped Speech-to-Text model will be selected for requests from its corresponding language. For more information, see [Speech models](https://cloud.google.com/dialogflow/cx/docs/concept/speech-models). + "a_key": "A String", + }, + "noSpeechTimeout": "A String", # Timeout before detecting no speech. + "useTimeoutBasedEndpointing": True or False, # Use timeout based endpointing, interpreting endpointer sensitivy as seconds of timeout value. }, }, - "endInteraction": { # 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. # Output only. A signal that indicates the interaction with the Dialogflow agent has ended. This message is generated by Dialogflow only when the conversation reaches `END_SESSION` page. It is not supposed to be defined by the user. It's guaranteed that there is at most one such message in each response. - }, - "knowledgeInfoCard": { # Represents info card response. If the response contains generative knowledge prediction, Dialogflow will return a payload with Infobot Messenger compatible info card. Otherwise, the info card response is skipped. # Represents info card for knowledge answers, to be better rendered in Dialogflow Messenger. - }, - "liveAgentHandoff": { # 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. # Hands off conversation to a human agent. - "metadata": { # Custom metadata for your handoff procedure. Dialogflow doesn't impose any structure on this. + "conditionalCases": [ # Conditional cases for this fulfillment. + { # A list of cascading if-else conditions. Cases are mutually exclusive. The first one with a matching condition is selected, all the rest ignored. + "cases": [ # A list of cascading if-else conditions. + { # Each case has a Boolean condition. When it is evaluated to be True, the corresponding messages will be selected and evaluated recursively. + "caseContent": [ # A list of case content. + { # The list of messages or conditional cases to activate for this case. + "additionalCases": # Object with schema name: GoogleCloudDialogflowCxV3beta1FulfillmentConditionalCases # Additional cases to be evaluated. + "message": { # 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. # Returned message. + "channel": "A String", # The channel which the response is associated with. Clients can specify the channel via QueryParameters.channel, and only associated channel response will be returned. + "conversationSuccess": { # 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. # Indicates that the conversation succeeded. + "metadata": { # Custom metadata. Dialogflow doesn't impose any structure on this. + "a_key": "", # Properties of the object. + }, + }, + "endInteraction": { # 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. # Output only. A signal that indicates the interaction with the Dialogflow agent has ended. This message is generated by Dialogflow only when the conversation reaches `END_SESSION` page. It is not supposed to be defined by the user. It's guaranteed that there is at most one such message in each response. + }, + "knowledgeInfoCard": { # Represents info card response. If the response contains generative knowledge prediction, Dialogflow will return a payload with Infobot Messenger compatible info card. Otherwise, the info card response is skipped. # Represents info card for knowledge answers, to be better rendered in Dialogflow Messenger. + }, + "liveAgentHandoff": { # 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. # Hands off conversation to a human agent. + "metadata": { # Custom metadata for your handoff procedure. Dialogflow doesn't impose any structure on this. + "a_key": "", # Properties of the object. + }, + }, + "mixedAudio": { # 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. # Output only. An audio response message composed of both the synthesized Dialogflow agent responses and responses defined via play_audio. This message is generated by Dialogflow only and not supposed to be defined by the user. + "segments": [ # Segments this audio response is composed of. + { # Represents one segment of audio. + "allowPlaybackInterruption": True or False, # 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. + "audio": "A String", # Raw audio synthesized from the Dialogflow agent's response using the output config specified in the request. + "uri": "A String", # Client-specific URI that points to an audio clip accessible to the client. Dialogflow does not impose any validation on it. + }, + ], + }, + "outputAudioText": { # A text or ssml response that is preferentially used for TTS output audio synthesis, as described in the comment on the ResponseMessage message. # A text or ssml response that is preferentially used for TTS output audio synthesis, as described in the comment on the ResponseMessage message. + "allowPlaybackInterruption": True or False, # 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. + "ssml": "A String", # The SSML text to be synthesized. For more information, see [SSML](/speech/text-to-speech/docs/ssml). + "text": "A String", # The raw text to be synthesized. + }, + "payload": { # Returns a response containing a custom, platform-specific payload. + "a_key": "", # Properties of the object. + }, + "playAudio": { # Specifies an audio clip to be played by the client as part of the response. # Signal that the client should play an audio clip hosted at a client-specific URI. Dialogflow uses this to construct mixed_audio. However, Dialogflow itself does not try to read or process the URI in any way. + "allowPlaybackInterruption": True or False, # 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. + "audioUri": "A String", # Required. URI of the audio clip. Dialogflow does not impose any validation on this value. It is specific to the client that reads it. + }, + "telephonyTransferCall": { # Represents the signal that telles the client to transfer the phone call connected to the agent to a third-party endpoint. # A signal that the client should transfer the phone call connected to this agent to a third-party endpoint. + "phoneNumber": "A String", # Transfer the call to a phone number in [E.164 format](https://en.wikipedia.org/wiki/E.164). + }, + "text": { # The text response message. # Returns a text response. + "allowPlaybackInterruption": True or False, # 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. + "text": [ # Required. A collection of text responses. + "A String", + ], + }, + "toolCall": { # Represents a call of a specific tool's action with the specified inputs. # Returns the definition of a tool call that should be executed by the client. + "action": "A String", # Required. The name of the tool's action associated with this call. + "inputParameters": { # Optional. The action's input parameters. + "a_key": "", # Properties of the object. + }, + "tool": "A String", # Required. The tool associated with this call. Format: `projects//locations//agents//tools/`. + }, + }, + }, + ], + "condition": "A String", # The condition to activate and select this case. Empty means the condition is always true. The condition is evaluated against form parameters or session parameters. See the [conditions reference](https://cloud.google.com/dialogflow/cx/docs/reference/condition). + }, + ], + }, + ], + "enableGenerativeFallback": True or False, # If the flag is true, the agent will utilize LLM to generate a text response. If LLM generation fails, the defined responses in the fulfillment will be respected. This flag is only useful for fulfillments associated with no-match event handlers. + "messages": [ # The list of rich message responses to present to the user. + { # 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. + "channel": "A String", # The channel which the response is associated with. Clients can specify the channel via QueryParameters.channel, and only associated channel response will be returned. + "conversationSuccess": { # 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. # Indicates that the conversation succeeded. + "metadata": { # Custom metadata. Dialogflow doesn't impose any structure on this. + "a_key": "", # Properties of the object. + }, + }, + "endInteraction": { # 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. # Output only. A signal that indicates the interaction with the Dialogflow agent has ended. This message is generated by Dialogflow only when the conversation reaches `END_SESSION` page. It is not supposed to be defined by the user. It's guaranteed that there is at most one such message in each response. + }, + "knowledgeInfoCard": { # Represents info card response. If the response contains generative knowledge prediction, Dialogflow will return a payload with Infobot Messenger compatible info card. Otherwise, the info card response is skipped. # Represents info card for knowledge answers, to be better rendered in Dialogflow Messenger. + }, + "liveAgentHandoff": { # 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. # Hands off conversation to a human agent. + "metadata": { # Custom metadata for your handoff procedure. Dialogflow doesn't impose any structure on this. + "a_key": "", # Properties of the object. + }, + }, + "mixedAudio": { # 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. # Output only. An audio response message composed of both the synthesized Dialogflow agent responses and responses defined via play_audio. This message is generated by Dialogflow only and not supposed to be defined by the user. + "segments": [ # Segments this audio response is composed of. + { # Represents one segment of audio. + "allowPlaybackInterruption": True or False, # 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. + "audio": "A String", # Raw audio synthesized from the Dialogflow agent's response using the output config specified in the request. + "uri": "A String", # Client-specific URI that points to an audio clip accessible to the client. Dialogflow does not impose any validation on it. + }, + ], + }, + "outputAudioText": { # A text or ssml response that is preferentially used for TTS output audio synthesis, as described in the comment on the ResponseMessage message. # A text or ssml response that is preferentially used for TTS output audio synthesis, as described in the comment on the ResponseMessage message. + "allowPlaybackInterruption": True or False, # 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. + "ssml": "A String", # The SSML text to be synthesized. For more information, see [SSML](/speech/text-to-speech/docs/ssml). + "text": "A String", # The raw text to be synthesized. + }, + "payload": { # Returns a response containing a custom, platform-specific payload. + "a_key": "", # Properties of the object. + }, + "playAudio": { # Specifies an audio clip to be played by the client as part of the response. # Signal that the client should play an audio clip hosted at a client-specific URI. Dialogflow uses this to construct mixed_audio. However, Dialogflow itself does not try to read or process the URI in any way. + "allowPlaybackInterruption": True or False, # 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. + "audioUri": "A String", # Required. URI of the audio clip. Dialogflow does not impose any validation on this value. It is specific to the client that reads it. + }, + "telephonyTransferCall": { # Represents the signal that telles the client to transfer the phone call connected to the agent to a third-party endpoint. # A signal that the client should transfer the phone call connected to this agent to a third-party endpoint. + "phoneNumber": "A String", # Transfer the call to a phone number in [E.164 format](https://en.wikipedia.org/wiki/E.164). + }, + "text": { # The text response message. # Returns a text response. + "allowPlaybackInterruption": True or False, # 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. + "text": [ # Required. A collection of text responses. + "A String", + ], + }, + "toolCall": { # Represents a call of a specific tool's action with the specified inputs. # Returns the definition of a tool call that should be executed by the client. + "action": "A String", # Required. The name of the tool's action associated with this call. + "inputParameters": { # Optional. The action's input parameters. + "a_key": "", # Properties of the object. + }, + "tool": "A String", # Required. The tool associated with this call. Format: `projects//locations//agents//tools/`. + }, + }, + ], + "returnPartialResponses": True or False, # Whether Dialogflow should return currently queued fulfillment response messages in streaming APIs. If a webhook is specified, it happens before Dialogflow invokes webhook. Warning: 1) This flag only affects streaming API. Responses are still queued and returned once in non-streaming API. 2) The flag can be enabled in any fulfillment but only the first 3 partial responses will be returned. You may only want to apply it to fulfillments that have slow webhooks. + "setParameterActions": [ # Set parameter values before executing the webhook. + { # Setting a parameter value. + "parameter": "A String", # Display name of the parameter. + "value": "", # The new value of the parameter. A null value clears the parameter. + }, + ], + "tag": "A String", # The value of this field will be populated in the WebhookRequest `fulfillmentInfo.tag` field by Dialogflow when the associated webhook is called. The tag is typically used by the webhook service to identify which fulfillment is being called, but it could be used for other purposes. This field is required if `webhook` is specified. + "webhook": "A String", # The webhook to call. Format: `projects//locations//agents//webhooks/`. + }, + "eventHandlers": [ # Handlers associated with the page to handle events such as webhook errors, no match or no input. + { # An event handler specifies an event that can be handled during a session. When the specified event happens, the following actions are taken in order: * If there is a `trigger_fulfillment` associated with the event, it will be called. * If there is a `target_page` associated with the event, the session will transition into the specified page. * If there is a `target_flow` associated with the event, the session will transition into the specified flow. + "event": "A String", # Required. The name of the event to handle. + "name": "A String", # Output only. The unique identifier of this event handler. + "targetFlow": "A String", # The target flow to transition to. Format: `projects//locations//agents//flows/`. + "targetPage": "A String", # The target page to transition to. Format: `projects//locations//agents//flows//pages/`. + "triggerFulfillment": { # A fulfillment can do one or more of the following actions at the same time: * Generate rich message responses. * Set parameter values. * Call the webhook. Fulfillments can be called at various stages in the Page or Form lifecycle. For example, when a DetectIntentRequest drives a session to enter a new page, the page's entry fulfillment can add a static response to the QueryResult in the returning DetectIntentResponse, call the webhook (for example, to load user data from a database), or both. # The fulfillment to call when the event occurs. Handling webhook errors with a fulfillment enabled with webhook could cause infinite loop. It is invalid to specify such fulfillment for a handler handling webhooks. + "advancedSettings": { # Hierarchical advanced settings for agent/flow/page/fulfillment/parameter. Settings exposed at lower level overrides the settings exposed at higher level. Overriding occurs at the sub-setting level. For example, the playback_interruption_settings at fulfillment level only overrides the playback_interruption_settings at the agent level, leaving other settings at the agent level unchanged. DTMF settings does not override each other. DTMF settings set at different levels define DTMF detections running in parallel. Hierarchy: Agent->Flow->Page->Fulfillment/Parameter. # Hierarchical advanced settings for this fulfillment. The settings exposed at the lower level overrides the settings exposed at the higher level. + "audioExportGcsDestination": { # Google Cloud Storage location for a Dialogflow operation that writes or exports objects (e.g. exported agent or transcripts) outside of Dialogflow. # If present, incoming audio is exported by Dialogflow to the configured Google Cloud Storage destination. Exposed at the following levels: - Agent level - Flow level + "uri": "A String", # Required. The Google Cloud Storage URI for the exported objects. A URI is of the form: `gs://bucket/object-name-or-prefix` Whether a full object name, or just a prefix, its usage depends on the Dialogflow operation. + }, + "dtmfSettings": { # Define behaviors for DTMF (dual tone multi frequency). # Settings for DTMF. Exposed at the following levels: - Agent level - Flow level - Page level - Parameter level. + "enabled": True or False, # If true, incoming audio is processed for DTMF (dual tone multi frequency) events. For example, if the caller presses a button on their telephone keypad and DTMF processing is enabled, Dialogflow will detect the event (e.g. a "3" was pressed) in the incoming audio and pass the event to the bot to drive business logic (e.g. when 3 is pressed, return the account balance). + "endpointingTimeoutDuration": "A String", # Endpoint timeout setting for matching dtmf input to regex. + "finishDigit": "A String", # The digit that terminates a DTMF digit sequence. + "interdigitTimeoutDuration": "A String", # Interdigit timeout setting for matching dtmf input to regex. + "maxDigits": 42, # Max length of DTMF digits. + }, + "loggingSettings": { # Define behaviors on logging. # Settings for logging. Settings for Dialogflow History, Contact Center messages, StackDriver logs, and speech logging. Exposed at the following levels: - Agent level. + "enableInteractionLogging": True or False, # Enables DF Interaction logging. + "enableStackdriverLogging": True or False, # Enables StackDriver logging. + }, + "speechSettings": { # Define behaviors of speech to text detection. # Settings for speech to text detection. Exposed at the following levels: - Agent level - Flow level - Page level - Parameter level + "endpointerSensitivity": 42, # Sensitivity of the speech model that detects the end of speech. Scale from 0 to 100. + "models": { # Mapping from language to Speech-to-Text model. The mapped Speech-to-Text model will be selected for requests from its corresponding language. For more information, see [Speech models](https://cloud.google.com/dialogflow/cx/docs/concept/speech-models). + "a_key": "A String", + }, + "noSpeechTimeout": "A String", # Timeout before detecting no speech. + "useTimeoutBasedEndpointing": True or False, # Use timeout based endpointing, interpreting endpointer sensitivy as seconds of timeout value. + }, + }, + "conditionalCases": [ # Conditional cases for this fulfillment. + { # A list of cascading if-else conditions. Cases are mutually exclusive. The first one with a matching condition is selected, all the rest ignored. + "cases": [ # A list of cascading if-else conditions. + { # Each case has a Boolean condition. When it is evaluated to be True, the corresponding messages will be selected and evaluated recursively. + "caseContent": [ # A list of case content. + { # The list of messages or conditional cases to activate for this case. + "additionalCases": # Object with schema name: GoogleCloudDialogflowCxV3beta1FulfillmentConditionalCases # Additional cases to be evaluated. + "message": { # 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. # Returned message. + "channel": "A String", # The channel which the response is associated with. Clients can specify the channel via QueryParameters.channel, and only associated channel response will be returned. + "conversationSuccess": { # 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. # Indicates that the conversation succeeded. + "metadata": { # Custom metadata. Dialogflow doesn't impose any structure on this. + "a_key": "", # Properties of the object. + }, + }, + "endInteraction": { # 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. # Output only. A signal that indicates the interaction with the Dialogflow agent has ended. This message is generated by Dialogflow only when the conversation reaches `END_SESSION` page. It is not supposed to be defined by the user. It's guaranteed that there is at most one such message in each response. + }, + "knowledgeInfoCard": { # Represents info card response. If the response contains generative knowledge prediction, Dialogflow will return a payload with Infobot Messenger compatible info card. Otherwise, the info card response is skipped. # Represents info card for knowledge answers, to be better rendered in Dialogflow Messenger. + }, + "liveAgentHandoff": { # 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. # Hands off conversation to a human agent. + "metadata": { # Custom metadata for your handoff procedure. Dialogflow doesn't impose any structure on this. + "a_key": "", # Properties of the object. + }, + }, + "mixedAudio": { # 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. # Output only. An audio response message composed of both the synthesized Dialogflow agent responses and responses defined via play_audio. This message is generated by Dialogflow only and not supposed to be defined by the user. + "segments": [ # Segments this audio response is composed of. + { # Represents one segment of audio. + "allowPlaybackInterruption": True or False, # 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. + "audio": "A String", # Raw audio synthesized from the Dialogflow agent's response using the output config specified in the request. + "uri": "A String", # Client-specific URI that points to an audio clip accessible to the client. Dialogflow does not impose any validation on it. + }, + ], + }, + "outputAudioText": { # A text or ssml response that is preferentially used for TTS output audio synthesis, as described in the comment on the ResponseMessage message. # A text or ssml response that is preferentially used for TTS output audio synthesis, as described in the comment on the ResponseMessage message. + "allowPlaybackInterruption": True or False, # 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. + "ssml": "A String", # The SSML text to be synthesized. For more information, see [SSML](/speech/text-to-speech/docs/ssml). + "text": "A String", # The raw text to be synthesized. + }, + "payload": { # Returns a response containing a custom, platform-specific payload. + "a_key": "", # Properties of the object. + }, + "playAudio": { # Specifies an audio clip to be played by the client as part of the response. # Signal that the client should play an audio clip hosted at a client-specific URI. Dialogflow uses this to construct mixed_audio. However, Dialogflow itself does not try to read or process the URI in any way. + "allowPlaybackInterruption": True or False, # 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. + "audioUri": "A String", # Required. URI of the audio clip. Dialogflow does not impose any validation on this value. It is specific to the client that reads it. + }, + "telephonyTransferCall": { # Represents the signal that telles the client to transfer the phone call connected to the agent to a third-party endpoint. # A signal that the client should transfer the phone call connected to this agent to a third-party endpoint. + "phoneNumber": "A String", # Transfer the call to a phone number in [E.164 format](https://en.wikipedia.org/wiki/E.164). + }, + "text": { # The text response message. # Returns a text response. + "allowPlaybackInterruption": True or False, # 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. + "text": [ # Required. A collection of text responses. + "A String", + ], + }, + "toolCall": { # Represents a call of a specific tool's action with the specified inputs. # Returns the definition of a tool call that should be executed by the client. + "action": "A String", # Required. The name of the tool's action associated with this call. + "inputParameters": { # Optional. The action's input parameters. + "a_key": "", # Properties of the object. + }, + "tool": "A String", # Required. The tool associated with this call. Format: `projects//locations//agents//tools/`. + }, + }, + }, + ], + "condition": "A String", # The condition to activate and select this case. Empty means the condition is always true. The condition is evaluated against form parameters or session parameters. See the [conditions reference](https://cloud.google.com/dialogflow/cx/docs/reference/condition). + }, + ], + }, + ], + "enableGenerativeFallback": True or False, # If the flag is true, the agent will utilize LLM to generate a text response. If LLM generation fails, the defined responses in the fulfillment will be respected. This flag is only useful for fulfillments associated with no-match event handlers. + "messages": [ # The list of rich message responses to present to the user. + { # 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. + "channel": "A String", # The channel which the response is associated with. Clients can specify the channel via QueryParameters.channel, and only associated channel response will be returned. + "conversationSuccess": { # 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. # Indicates that the conversation succeeded. + "metadata": { # Custom metadata. Dialogflow doesn't impose any structure on this. + "a_key": "", # Properties of the object. + }, + }, + "endInteraction": { # 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. # Output only. A signal that indicates the interaction with the Dialogflow agent has ended. This message is generated by Dialogflow only when the conversation reaches `END_SESSION` page. It is not supposed to be defined by the user. It's guaranteed that there is at most one such message in each response. + }, + "knowledgeInfoCard": { # Represents info card response. If the response contains generative knowledge prediction, Dialogflow will return a payload with Infobot Messenger compatible info card. Otherwise, the info card response is skipped. # Represents info card for knowledge answers, to be better rendered in Dialogflow Messenger. + }, + "liveAgentHandoff": { # 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. # Hands off conversation to a human agent. + "metadata": { # Custom metadata for your handoff procedure. Dialogflow doesn't impose any structure on this. + "a_key": "", # Properties of the object. + }, + }, + "mixedAudio": { # 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. # Output only. An audio response message composed of both the synthesized Dialogflow agent responses and responses defined via play_audio. This message is generated by Dialogflow only and not supposed to be defined by the user. + "segments": [ # Segments this audio response is composed of. + { # Represents one segment of audio. + "allowPlaybackInterruption": True or False, # 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. + "audio": "A String", # Raw audio synthesized from the Dialogflow agent's response using the output config specified in the request. + "uri": "A String", # Client-specific URI that points to an audio clip accessible to the client. Dialogflow does not impose any validation on it. + }, + ], + }, + "outputAudioText": { # A text or ssml response that is preferentially used for TTS output audio synthesis, as described in the comment on the ResponseMessage message. # A text or ssml response that is preferentially used for TTS output audio synthesis, as described in the comment on the ResponseMessage message. + "allowPlaybackInterruption": True or False, # 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. + "ssml": "A String", # The SSML text to be synthesized. For more information, see [SSML](/speech/text-to-speech/docs/ssml). + "text": "A String", # The raw text to be synthesized. + }, + "payload": { # Returns a response containing a custom, platform-specific payload. + "a_key": "", # Properties of the object. + }, + "playAudio": { # Specifies an audio clip to be played by the client as part of the response. # Signal that the client should play an audio clip hosted at a client-specific URI. Dialogflow uses this to construct mixed_audio. However, Dialogflow itself does not try to read or process the URI in any way. + "allowPlaybackInterruption": True or False, # 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. + "audioUri": "A String", # Required. URI of the audio clip. Dialogflow does not impose any validation on this value. It is specific to the client that reads it. + }, + "telephonyTransferCall": { # Represents the signal that telles the client to transfer the phone call connected to the agent to a third-party endpoint. # A signal that the client should transfer the phone call connected to this agent to a third-party endpoint. + "phoneNumber": "A String", # Transfer the call to a phone number in [E.164 format](https://en.wikipedia.org/wiki/E.164). + }, + "text": { # The text response message. # Returns a text response. + "allowPlaybackInterruption": True or False, # 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. + "text": [ # Required. A collection of text responses. + "A String", + ], + }, + "toolCall": { # Represents a call of a specific tool's action with the specified inputs. # Returns the definition of a tool call that should be executed by the client. + "action": "A String", # Required. The name of the tool's action associated with this call. + "inputParameters": { # Optional. The action's input parameters. + "a_key": "", # Properties of the object. + }, + "tool": "A String", # Required. The tool associated with this call. Format: `projects//locations//agents//tools/`. + }, + }, + ], + "returnPartialResponses": True or False, # Whether Dialogflow should return currently queued fulfillment response messages in streaming APIs. If a webhook is specified, it happens before Dialogflow invokes webhook. Warning: 1) This flag only affects streaming API. Responses are still queued and returned once in non-streaming API. 2) The flag can be enabled in any fulfillment but only the first 3 partial responses will be returned. You may only want to apply it to fulfillments that have slow webhooks. + "setParameterActions": [ # Set parameter values before executing the webhook. + { # Setting a parameter value. + "parameter": "A String", # Display name of the parameter. + "value": "", # The new value of the parameter. A null value clears the parameter. + }, + ], + "tag": "A String", # The value of this field will be populated in the WebhookRequest `fulfillmentInfo.tag` field by Dialogflow when the associated webhook is called. The tag is typically used by the webhook service to identify which fulfillment is being called, but it could be used for other purposes. This field is required if `webhook` is specified. + "webhook": "A String", # The webhook to call. Format: `projects//locations//agents//webhooks/`. + }, + }, + ], + "form": { # A form is a data model that groups related parameters that can be collected from the user. The process in which the agent prompts the user and collects parameter values from the user is called form filling. A form can be added to a page. When form filling is done, the filled parameters will be written to the session. # The form associated with the page, used for collecting parameters relevant to the page. + "parameters": [ # Parameters to collect from the user. + { # Represents a form parameter. + "advancedSettings": { # Hierarchical advanced settings for agent/flow/page/fulfillment/parameter. Settings exposed at lower level overrides the settings exposed at higher level. Overriding occurs at the sub-setting level. For example, the playback_interruption_settings at fulfillment level only overrides the playback_interruption_settings at the agent level, leaving other settings at the agent level unchanged. DTMF settings does not override each other. DTMF settings set at different levels define DTMF detections running in parallel. Hierarchy: Agent->Flow->Page->Fulfillment/Parameter. # Hierarchical advanced settings for this parameter. The settings exposed at the lower level overrides the settings exposed at the higher level. + "audioExportGcsDestination": { # Google Cloud Storage location for a Dialogflow operation that writes or exports objects (e.g. exported agent or transcripts) outside of Dialogflow. # If present, incoming audio is exported by Dialogflow to the configured Google Cloud Storage destination. Exposed at the following levels: - Agent level - Flow level + "uri": "A String", # Required. The Google Cloud Storage URI for the exported objects. A URI is of the form: `gs://bucket/object-name-or-prefix` Whether a full object name, or just a prefix, its usage depends on the Dialogflow operation. + }, + "dtmfSettings": { # Define behaviors for DTMF (dual tone multi frequency). # Settings for DTMF. Exposed at the following levels: - Agent level - Flow level - Page level - Parameter level. + "enabled": True or False, # If true, incoming audio is processed for DTMF (dual tone multi frequency) events. For example, if the caller presses a button on their telephone keypad and DTMF processing is enabled, Dialogflow will detect the event (e.g. a "3" was pressed) in the incoming audio and pass the event to the bot to drive business logic (e.g. when 3 is pressed, return the account balance). + "endpointingTimeoutDuration": "A String", # Endpoint timeout setting for matching dtmf input to regex. + "finishDigit": "A String", # The digit that terminates a DTMF digit sequence. + "interdigitTimeoutDuration": "A String", # Interdigit timeout setting for matching dtmf input to regex. + "maxDigits": 42, # Max length of DTMF digits. + }, + "loggingSettings": { # Define behaviors on logging. # Settings for logging. Settings for Dialogflow History, Contact Center messages, StackDriver logs, and speech logging. Exposed at the following levels: - Agent level. + "enableInteractionLogging": True or False, # Enables DF Interaction logging. + "enableStackdriverLogging": True or False, # Enables StackDriver logging. + }, + "speechSettings": { # Define behaviors of speech to text detection. # Settings for speech to text detection. Exposed at the following levels: - Agent level - Flow level - Page level - Parameter level + "endpointerSensitivity": 42, # Sensitivity of the speech model that detects the end of speech. Scale from 0 to 100. + "models": { # Mapping from language to Speech-to-Text model. The mapped Speech-to-Text model will be selected for requests from its corresponding language. For more information, see [Speech models](https://cloud.google.com/dialogflow/cx/docs/concept/speech-models). + "a_key": "A String", + }, + "noSpeechTimeout": "A String", # Timeout before detecting no speech. + "useTimeoutBasedEndpointing": True or False, # Use timeout based endpointing, interpreting endpointer sensitivy as seconds of timeout value. + }, + }, + "defaultValue": "", # The default value of an optional parameter. If the parameter is required, the default value will be ignored. + "displayName": "A String", # Required. The human-readable name of the parameter, unique within the form. + "entityType": "A String", # Required. The entity type of the parameter. Format: `projects/-/locations/-/agents/-/entityTypes/` for system entity types (for example, `projects/-/locations/-/agents/-/entityTypes/sys.date`), or `projects//locations//agents//entityTypes/` for developer entity types. + "fillBehavior": { # Configuration for how the filling of a parameter should be handled. # Required. Defines fill behavior for the parameter. + "initialPromptFulfillment": { # A fulfillment can do one or more of the following actions at the same time: * Generate rich message responses. * Set parameter values. * Call the webhook. Fulfillments can be called at various stages in the Page or Form lifecycle. For example, when a DetectIntentRequest drives a session to enter a new page, the page's entry fulfillment can add a static response to the QueryResult in the returning DetectIntentResponse, call the webhook (for example, to load user data from a database), or both. # Required. The fulfillment to provide the initial prompt that the agent can present to the user in order to fill the parameter. + "advancedSettings": { # Hierarchical advanced settings for agent/flow/page/fulfillment/parameter. Settings exposed at lower level overrides the settings exposed at higher level. Overriding occurs at the sub-setting level. For example, the playback_interruption_settings at fulfillment level only overrides the playback_interruption_settings at the agent level, leaving other settings at the agent level unchanged. DTMF settings does not override each other. DTMF settings set at different levels define DTMF detections running in parallel. Hierarchy: Agent->Flow->Page->Fulfillment/Parameter. # Hierarchical advanced settings for this fulfillment. The settings exposed at the lower level overrides the settings exposed at the higher level. + "audioExportGcsDestination": { # Google Cloud Storage location for a Dialogflow operation that writes or exports objects (e.g. exported agent or transcripts) outside of Dialogflow. # If present, incoming audio is exported by Dialogflow to the configured Google Cloud Storage destination. Exposed at the following levels: - Agent level - Flow level + "uri": "A String", # Required. The Google Cloud Storage URI for the exported objects. A URI is of the form: `gs://bucket/object-name-or-prefix` Whether a full object name, or just a prefix, its usage depends on the Dialogflow operation. + }, + "dtmfSettings": { # Define behaviors for DTMF (dual tone multi frequency). # Settings for DTMF. Exposed at the following levels: - Agent level - Flow level - Page level - Parameter level. + "enabled": True or False, # If true, incoming audio is processed for DTMF (dual tone multi frequency) events. For example, if the caller presses a button on their telephone keypad and DTMF processing is enabled, Dialogflow will detect the event (e.g. a "3" was pressed) in the incoming audio and pass the event to the bot to drive business logic (e.g. when 3 is pressed, return the account balance). + "endpointingTimeoutDuration": "A String", # Endpoint timeout setting for matching dtmf input to regex. + "finishDigit": "A String", # The digit that terminates a DTMF digit sequence. + "interdigitTimeoutDuration": "A String", # Interdigit timeout setting for matching dtmf input to regex. + "maxDigits": 42, # Max length of DTMF digits. + }, + "loggingSettings": { # Define behaviors on logging. # Settings for logging. Settings for Dialogflow History, Contact Center messages, StackDriver logs, and speech logging. Exposed at the following levels: - Agent level. + "enableInteractionLogging": True or False, # Enables DF Interaction logging. + "enableStackdriverLogging": True or False, # Enables StackDriver logging. + }, + "speechSettings": { # Define behaviors of speech to text detection. # Settings for speech to text detection. Exposed at the following levels: - Agent level - Flow level - Page level - Parameter level + "endpointerSensitivity": 42, # Sensitivity of the speech model that detects the end of speech. Scale from 0 to 100. + "models": { # Mapping from language to Speech-to-Text model. The mapped Speech-to-Text model will be selected for requests from its corresponding language. For more information, see [Speech models](https://cloud.google.com/dialogflow/cx/docs/concept/speech-models). + "a_key": "A String", + }, + "noSpeechTimeout": "A String", # Timeout before detecting no speech. + "useTimeoutBasedEndpointing": True or False, # Use timeout based endpointing, interpreting endpointer sensitivy as seconds of timeout value. + }, + }, + "conditionalCases": [ # Conditional cases for this fulfillment. + { # A list of cascading if-else conditions. Cases are mutually exclusive. The first one with a matching condition is selected, all the rest ignored. + "cases": [ # A list of cascading if-else conditions. + { # Each case has a Boolean condition. When it is evaluated to be True, the corresponding messages will be selected and evaluated recursively. + "caseContent": [ # A list of case content. + { # The list of messages or conditional cases to activate for this case. + "additionalCases": # Object with schema name: GoogleCloudDialogflowCxV3beta1FulfillmentConditionalCases # Additional cases to be evaluated. + "message": { # 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. # Returned message. + "channel": "A String", # The channel which the response is associated with. Clients can specify the channel via QueryParameters.channel, and only associated channel response will be returned. + "conversationSuccess": { # 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. # Indicates that the conversation succeeded. + "metadata": { # Custom metadata. Dialogflow doesn't impose any structure on this. + "a_key": "", # Properties of the object. + }, + }, + "endInteraction": { # 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. # Output only. A signal that indicates the interaction with the Dialogflow agent has ended. This message is generated by Dialogflow only when the conversation reaches `END_SESSION` page. It is not supposed to be defined by the user. It's guaranteed that there is at most one such message in each response. + }, + "knowledgeInfoCard": { # Represents info card response. If the response contains generative knowledge prediction, Dialogflow will return a payload with Infobot Messenger compatible info card. Otherwise, the info card response is skipped. # Represents info card for knowledge answers, to be better rendered in Dialogflow Messenger. + }, + "liveAgentHandoff": { # 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. # Hands off conversation to a human agent. + "metadata": { # Custom metadata for your handoff procedure. Dialogflow doesn't impose any structure on this. + "a_key": "", # Properties of the object. + }, + }, + "mixedAudio": { # 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. # Output only. An audio response message composed of both the synthesized Dialogflow agent responses and responses defined via play_audio. This message is generated by Dialogflow only and not supposed to be defined by the user. + "segments": [ # Segments this audio response is composed of. + { # Represents one segment of audio. + "allowPlaybackInterruption": True or False, # 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. + "audio": "A String", # Raw audio synthesized from the Dialogflow agent's response using the output config specified in the request. + "uri": "A String", # Client-specific URI that points to an audio clip accessible to the client. Dialogflow does not impose any validation on it. + }, + ], + }, + "outputAudioText": { # A text or ssml response that is preferentially used for TTS output audio synthesis, as described in the comment on the ResponseMessage message. # A text or ssml response that is preferentially used for TTS output audio synthesis, as described in the comment on the ResponseMessage message. + "allowPlaybackInterruption": True or False, # 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. + "ssml": "A String", # The SSML text to be synthesized. For more information, see [SSML](/speech/text-to-speech/docs/ssml). + "text": "A String", # The raw text to be synthesized. + }, + "payload": { # Returns a response containing a custom, platform-specific payload. + "a_key": "", # Properties of the object. + }, + "playAudio": { # Specifies an audio clip to be played by the client as part of the response. # Signal that the client should play an audio clip hosted at a client-specific URI. Dialogflow uses this to construct mixed_audio. However, Dialogflow itself does not try to read or process the URI in any way. + "allowPlaybackInterruption": True or False, # 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. + "audioUri": "A String", # Required. URI of the audio clip. Dialogflow does not impose any validation on this value. It is specific to the client that reads it. + }, + "telephonyTransferCall": { # Represents the signal that telles the client to transfer the phone call connected to the agent to a third-party endpoint. # A signal that the client should transfer the phone call connected to this agent to a third-party endpoint. + "phoneNumber": "A String", # Transfer the call to a phone number in [E.164 format](https://en.wikipedia.org/wiki/E.164). + }, + "text": { # The text response message. # Returns a text response. + "allowPlaybackInterruption": True or False, # 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. + "text": [ # Required. A collection of text responses. + "A String", + ], + }, + "toolCall": { # Represents a call of a specific tool's action with the specified inputs. # Returns the definition of a tool call that should be executed by the client. + "action": "A String", # Required. The name of the tool's action associated with this call. + "inputParameters": { # Optional. The action's input parameters. + "a_key": "", # Properties of the object. + }, + "tool": "A String", # Required. The tool associated with this call. Format: `projects//locations//agents//tools/`. + }, + }, + }, + ], + "condition": "A String", # The condition to activate and select this case. Empty means the condition is always true. The condition is evaluated against form parameters or session parameters. See the [conditions reference](https://cloud.google.com/dialogflow/cx/docs/reference/condition). + }, + ], + }, + ], + "enableGenerativeFallback": True or False, # If the flag is true, the agent will utilize LLM to generate a text response. If LLM generation fails, the defined responses in the fulfillment will be respected. This flag is only useful for fulfillments associated with no-match event handlers. + "messages": [ # The list of rich message responses to present to the user. + { # 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. + "channel": "A String", # The channel which the response is associated with. Clients can specify the channel via QueryParameters.channel, and only associated channel response will be returned. + "conversationSuccess": { # 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. # Indicates that the conversation succeeded. + "metadata": { # Custom metadata. Dialogflow doesn't impose any structure on this. + "a_key": "", # Properties of the object. + }, + }, + "endInteraction": { # 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. # Output only. A signal that indicates the interaction with the Dialogflow agent has ended. This message is generated by Dialogflow only when the conversation reaches `END_SESSION` page. It is not supposed to be defined by the user. It's guaranteed that there is at most one such message in each response. + }, + "knowledgeInfoCard": { # Represents info card response. If the response contains generative knowledge prediction, Dialogflow will return a payload with Infobot Messenger compatible info card. Otherwise, the info card response is skipped. # Represents info card for knowledge answers, to be better rendered in Dialogflow Messenger. + }, + "liveAgentHandoff": { # 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. # Hands off conversation to a human agent. + "metadata": { # Custom metadata for your handoff procedure. Dialogflow doesn't impose any structure on this. + "a_key": "", # Properties of the object. + }, + }, + "mixedAudio": { # 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. # Output only. An audio response message composed of both the synthesized Dialogflow agent responses and responses defined via play_audio. This message is generated by Dialogflow only and not supposed to be defined by the user. + "segments": [ # Segments this audio response is composed of. + { # Represents one segment of audio. + "allowPlaybackInterruption": True or False, # 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. + "audio": "A String", # Raw audio synthesized from the Dialogflow agent's response using the output config specified in the request. + "uri": "A String", # Client-specific URI that points to an audio clip accessible to the client. Dialogflow does not impose any validation on it. + }, + ], + }, + "outputAudioText": { # A text or ssml response that is preferentially used for TTS output audio synthesis, as described in the comment on the ResponseMessage message. # A text or ssml response that is preferentially used for TTS output audio synthesis, as described in the comment on the ResponseMessage message. + "allowPlaybackInterruption": True or False, # 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. + "ssml": "A String", # The SSML text to be synthesized. For more information, see [SSML](/speech/text-to-speech/docs/ssml). + "text": "A String", # The raw text to be synthesized. + }, + "payload": { # Returns a response containing a custom, platform-specific payload. + "a_key": "", # Properties of the object. + }, + "playAudio": { # Specifies an audio clip to be played by the client as part of the response. # Signal that the client should play an audio clip hosted at a client-specific URI. Dialogflow uses this to construct mixed_audio. However, Dialogflow itself does not try to read or process the URI in any way. + "allowPlaybackInterruption": True or False, # 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. + "audioUri": "A String", # Required. URI of the audio clip. Dialogflow does not impose any validation on this value. It is specific to the client that reads it. + }, + "telephonyTransferCall": { # Represents the signal that telles the client to transfer the phone call connected to the agent to a third-party endpoint. # A signal that the client should transfer the phone call connected to this agent to a third-party endpoint. + "phoneNumber": "A String", # Transfer the call to a phone number in [E.164 format](https://en.wikipedia.org/wiki/E.164). + }, + "text": { # The text response message. # Returns a text response. + "allowPlaybackInterruption": True or False, # 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. + "text": [ # Required. A collection of text responses. + "A String", + ], + }, + "toolCall": { # Represents a call of a specific tool's action with the specified inputs. # Returns the definition of a tool call that should be executed by the client. + "action": "A String", # Required. The name of the tool's action associated with this call. + "inputParameters": { # Optional. The action's input parameters. + "a_key": "", # Properties of the object. + }, + "tool": "A String", # Required. The tool associated with this call. Format: `projects//locations//agents//tools/`. + }, + }, + ], + "returnPartialResponses": True or False, # Whether Dialogflow should return currently queued fulfillment response messages in streaming APIs. If a webhook is specified, it happens before Dialogflow invokes webhook. Warning: 1) This flag only affects streaming API. Responses are still queued and returned once in non-streaming API. 2) The flag can be enabled in any fulfillment but only the first 3 partial responses will be returned. You may only want to apply it to fulfillments that have slow webhooks. + "setParameterActions": [ # Set parameter values before executing the webhook. + { # Setting a parameter value. + "parameter": "A String", # Display name of the parameter. + "value": "", # The new value of the parameter. A null value clears the parameter. + }, + ], + "tag": "A String", # The value of this field will be populated in the WebhookRequest `fulfillmentInfo.tag` field by Dialogflow when the associated webhook is called. The tag is typically used by the webhook service to identify which fulfillment is being called, but it could be used for other purposes. This field is required if `webhook` is specified. + "webhook": "A String", # The webhook to call. Format: `projects//locations//agents//webhooks/`. + }, + "repromptEventHandlers": [ # The handlers for parameter-level events, used to provide reprompt for the parameter or transition to a different page/flow. The supported events are: * `sys.no-match-`, where N can be from 1 to 6 * `sys.no-match-default` * `sys.no-input-`, where N can be from 1 to 6 * `sys.no-input-default` * `sys.invalid-parameter` `initial_prompt_fulfillment` provides the first prompt for the parameter. If the user's response does not fill the parameter, a no-match/no-input event will be triggered, and the fulfillment associated with the `sys.no-match-1`/`sys.no-input-1` handler (if defined) will be called to provide a prompt. The `sys.no-match-2`/`sys.no-input-2` handler (if defined) will respond to the next no-match/no-input event, and so on. A `sys.no-match-default` or `sys.no-input-default` handler will be used to handle all following no-match/no-input events after all numbered no-match/no-input handlers for the parameter are consumed. A `sys.invalid-parameter` handler can be defined to handle the case where the parameter values have been `invalidated` by webhook. For example, if the user's response fill the parameter, however the parameter was invalidated by webhook, the fulfillment associated with the `sys.invalid-parameter` handler (if defined) will be called to provide a prompt. If the event handler for the corresponding event can't be found on the parameter, `initial_prompt_fulfillment` will be re-prompted. + { # An event handler specifies an event that can be handled during a session. When the specified event happens, the following actions are taken in order: * If there is a `trigger_fulfillment` associated with the event, it will be called. * If there is a `target_page` associated with the event, the session will transition into the specified page. * If there is a `target_flow` associated with the event, the session will transition into the specified flow. + "event": "A String", # Required. The name of the event to handle. + "name": "A String", # Output only. The unique identifier of this event handler. + "targetFlow": "A String", # The target flow to transition to. Format: `projects//locations//agents//flows/`. + "targetPage": "A String", # The target page to transition to. Format: `projects//locations//agents//flows//pages/`. + "triggerFulfillment": { # A fulfillment can do one or more of the following actions at the same time: * Generate rich message responses. * Set parameter values. * Call the webhook. Fulfillments can be called at various stages in the Page or Form lifecycle. For example, when a DetectIntentRequest drives a session to enter a new page, the page's entry fulfillment can add a static response to the QueryResult in the returning DetectIntentResponse, call the webhook (for example, to load user data from a database), or both. # The fulfillment to call when the event occurs. Handling webhook errors with a fulfillment enabled with webhook could cause infinite loop. It is invalid to specify such fulfillment for a handler handling webhooks. + "advancedSettings": { # Hierarchical advanced settings for agent/flow/page/fulfillment/parameter. Settings exposed at lower level overrides the settings exposed at higher level. Overriding occurs at the sub-setting level. For example, the playback_interruption_settings at fulfillment level only overrides the playback_interruption_settings at the agent level, leaving other settings at the agent level unchanged. DTMF settings does not override each other. DTMF settings set at different levels define DTMF detections running in parallel. Hierarchy: Agent->Flow->Page->Fulfillment/Parameter. # Hierarchical advanced settings for this fulfillment. The settings exposed at the lower level overrides the settings exposed at the higher level. + "audioExportGcsDestination": { # Google Cloud Storage location for a Dialogflow operation that writes or exports objects (e.g. exported agent or transcripts) outside of Dialogflow. # If present, incoming audio is exported by Dialogflow to the configured Google Cloud Storage destination. Exposed at the following levels: - Agent level - Flow level + "uri": "A String", # Required. The Google Cloud Storage URI for the exported objects. A URI is of the form: `gs://bucket/object-name-or-prefix` Whether a full object name, or just a prefix, its usage depends on the Dialogflow operation. + }, + "dtmfSettings": { # Define behaviors for DTMF (dual tone multi frequency). # Settings for DTMF. Exposed at the following levels: - Agent level - Flow level - Page level - Parameter level. + "enabled": True or False, # If true, incoming audio is processed for DTMF (dual tone multi frequency) events. For example, if the caller presses a button on their telephone keypad and DTMF processing is enabled, Dialogflow will detect the event (e.g. a "3" was pressed) in the incoming audio and pass the event to the bot to drive business logic (e.g. when 3 is pressed, return the account balance). + "endpointingTimeoutDuration": "A String", # Endpoint timeout setting for matching dtmf input to regex. + "finishDigit": "A String", # The digit that terminates a DTMF digit sequence. + "interdigitTimeoutDuration": "A String", # Interdigit timeout setting for matching dtmf input to regex. + "maxDigits": 42, # Max length of DTMF digits. + }, + "loggingSettings": { # Define behaviors on logging. # Settings for logging. Settings for Dialogflow History, Contact Center messages, StackDriver logs, and speech logging. Exposed at the following levels: - Agent level. + "enableInteractionLogging": True or False, # Enables DF Interaction logging. + "enableStackdriverLogging": True or False, # Enables StackDriver logging. + }, + "speechSettings": { # Define behaviors of speech to text detection. # Settings for speech to text detection. Exposed at the following levels: - Agent level - Flow level - Page level - Parameter level + "endpointerSensitivity": 42, # Sensitivity of the speech model that detects the end of speech. Scale from 0 to 100. + "models": { # Mapping from language to Speech-to-Text model. The mapped Speech-to-Text model will be selected for requests from its corresponding language. For more information, see [Speech models](https://cloud.google.com/dialogflow/cx/docs/concept/speech-models). + "a_key": "A String", + }, + "noSpeechTimeout": "A String", # Timeout before detecting no speech. + "useTimeoutBasedEndpointing": True or False, # Use timeout based endpointing, interpreting endpointer sensitivy as seconds of timeout value. + }, + }, + "conditionalCases": [ # Conditional cases for this fulfillment. + { # A list of cascading if-else conditions. Cases are mutually exclusive. The first one with a matching condition is selected, all the rest ignored. + "cases": [ # A list of cascading if-else conditions. + { # Each case has a Boolean condition. When it is evaluated to be True, the corresponding messages will be selected and evaluated recursively. + "caseContent": [ # A list of case content. + { # The list of messages or conditional cases to activate for this case. + "additionalCases": # Object with schema name: GoogleCloudDialogflowCxV3beta1FulfillmentConditionalCases # Additional cases to be evaluated. + "message": { # 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. # Returned message. + "channel": "A String", # The channel which the response is associated with. Clients can specify the channel via QueryParameters.channel, and only associated channel response will be returned. + "conversationSuccess": { # 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. # Indicates that the conversation succeeded. + "metadata": { # Custom metadata. Dialogflow doesn't impose any structure on this. + "a_key": "", # Properties of the object. + }, + }, + "endInteraction": { # 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. # Output only. A signal that indicates the interaction with the Dialogflow agent has ended. This message is generated by Dialogflow only when the conversation reaches `END_SESSION` page. It is not supposed to be defined by the user. It's guaranteed that there is at most one such message in each response. + }, + "knowledgeInfoCard": { # Represents info card response. If the response contains generative knowledge prediction, Dialogflow will return a payload with Infobot Messenger compatible info card. Otherwise, the info card response is skipped. # Represents info card for knowledge answers, to be better rendered in Dialogflow Messenger. + }, + "liveAgentHandoff": { # 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. # Hands off conversation to a human agent. + "metadata": { # Custom metadata for your handoff procedure. Dialogflow doesn't impose any structure on this. + "a_key": "", # Properties of the object. + }, + }, + "mixedAudio": { # 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. # Output only. An audio response message composed of both the synthesized Dialogflow agent responses and responses defined via play_audio. This message is generated by Dialogflow only and not supposed to be defined by the user. + "segments": [ # Segments this audio response is composed of. + { # Represents one segment of audio. + "allowPlaybackInterruption": True or False, # 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. + "audio": "A String", # Raw audio synthesized from the Dialogflow agent's response using the output config specified in the request. + "uri": "A String", # Client-specific URI that points to an audio clip accessible to the client. Dialogflow does not impose any validation on it. + }, + ], + }, + "outputAudioText": { # A text or ssml response that is preferentially used for TTS output audio synthesis, as described in the comment on the ResponseMessage message. # A text or ssml response that is preferentially used for TTS output audio synthesis, as described in the comment on the ResponseMessage message. + "allowPlaybackInterruption": True or False, # 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. + "ssml": "A String", # The SSML text to be synthesized. For more information, see [SSML](/speech/text-to-speech/docs/ssml). + "text": "A String", # The raw text to be synthesized. + }, + "payload": { # Returns a response containing a custom, platform-specific payload. + "a_key": "", # Properties of the object. + }, + "playAudio": { # Specifies an audio clip to be played by the client as part of the response. # Signal that the client should play an audio clip hosted at a client-specific URI. Dialogflow uses this to construct mixed_audio. However, Dialogflow itself does not try to read or process the URI in any way. + "allowPlaybackInterruption": True or False, # 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. + "audioUri": "A String", # Required. URI of the audio clip. Dialogflow does not impose any validation on this value. It is specific to the client that reads it. + }, + "telephonyTransferCall": { # Represents the signal that telles the client to transfer the phone call connected to the agent to a third-party endpoint. # A signal that the client should transfer the phone call connected to this agent to a third-party endpoint. + "phoneNumber": "A String", # Transfer the call to a phone number in [E.164 format](https://en.wikipedia.org/wiki/E.164). + }, + "text": { # The text response message. # Returns a text response. + "allowPlaybackInterruption": True or False, # 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. + "text": [ # Required. A collection of text responses. + "A String", + ], + }, + "toolCall": { # Represents a call of a specific tool's action with the specified inputs. # Returns the definition of a tool call that should be executed by the client. + "action": "A String", # Required. The name of the tool's action associated with this call. + "inputParameters": { # Optional. The action's input parameters. + "a_key": "", # Properties of the object. + }, + "tool": "A String", # Required. The tool associated with this call. Format: `projects//locations//agents//tools/`. + }, + }, + }, + ], + "condition": "A String", # The condition to activate and select this case. Empty means the condition is always true. The condition is evaluated against form parameters or session parameters. See the [conditions reference](https://cloud.google.com/dialogflow/cx/docs/reference/condition). + }, + ], + }, + ], + "enableGenerativeFallback": True or False, # If the flag is true, the agent will utilize LLM to generate a text response. If LLM generation fails, the defined responses in the fulfillment will be respected. This flag is only useful for fulfillments associated with no-match event handlers. + "messages": [ # The list of rich message responses to present to the user. + { # 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. + "channel": "A String", # The channel which the response is associated with. Clients can specify the channel via QueryParameters.channel, and only associated channel response will be returned. + "conversationSuccess": { # 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. # Indicates that the conversation succeeded. + "metadata": { # Custom metadata. Dialogflow doesn't impose any structure on this. + "a_key": "", # Properties of the object. + }, + }, + "endInteraction": { # 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. # Output only. A signal that indicates the interaction with the Dialogflow agent has ended. This message is generated by Dialogflow only when the conversation reaches `END_SESSION` page. It is not supposed to be defined by the user. It's guaranteed that there is at most one such message in each response. + }, + "knowledgeInfoCard": { # Represents info card response. If the response contains generative knowledge prediction, Dialogflow will return a payload with Infobot Messenger compatible info card. Otherwise, the info card response is skipped. # Represents info card for knowledge answers, to be better rendered in Dialogflow Messenger. + }, + "liveAgentHandoff": { # 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. # Hands off conversation to a human agent. + "metadata": { # Custom metadata for your handoff procedure. Dialogflow doesn't impose any structure on this. + "a_key": "", # Properties of the object. + }, + }, + "mixedAudio": { # 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. # Output only. An audio response message composed of both the synthesized Dialogflow agent responses and responses defined via play_audio. This message is generated by Dialogflow only and not supposed to be defined by the user. + "segments": [ # Segments this audio response is composed of. + { # Represents one segment of audio. + "allowPlaybackInterruption": True or False, # 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. + "audio": "A String", # Raw audio synthesized from the Dialogflow agent's response using the output config specified in the request. + "uri": "A String", # Client-specific URI that points to an audio clip accessible to the client. Dialogflow does not impose any validation on it. + }, + ], + }, + "outputAudioText": { # A text or ssml response that is preferentially used for TTS output audio synthesis, as described in the comment on the ResponseMessage message. # A text or ssml response that is preferentially used for TTS output audio synthesis, as described in the comment on the ResponseMessage message. + "allowPlaybackInterruption": True or False, # 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. + "ssml": "A String", # The SSML text to be synthesized. For more information, see [SSML](/speech/text-to-speech/docs/ssml). + "text": "A String", # The raw text to be synthesized. + }, + "payload": { # Returns a response containing a custom, platform-specific payload. + "a_key": "", # Properties of the object. + }, + "playAudio": { # Specifies an audio clip to be played by the client as part of the response. # Signal that the client should play an audio clip hosted at a client-specific URI. Dialogflow uses this to construct mixed_audio. However, Dialogflow itself does not try to read or process the URI in any way. + "allowPlaybackInterruption": True or False, # 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. + "audioUri": "A String", # Required. URI of the audio clip. Dialogflow does not impose any validation on this value. It is specific to the client that reads it. + }, + "telephonyTransferCall": { # Represents the signal that telles the client to transfer the phone call connected to the agent to a third-party endpoint. # A signal that the client should transfer the phone call connected to this agent to a third-party endpoint. + "phoneNumber": "A String", # Transfer the call to a phone number in [E.164 format](https://en.wikipedia.org/wiki/E.164). + }, + "text": { # The text response message. # Returns a text response. + "allowPlaybackInterruption": True or False, # 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. + "text": [ # Required. A collection of text responses. + "A String", + ], + }, + "toolCall": { # Represents a call of a specific tool's action with the specified inputs. # Returns the definition of a tool call that should be executed by the client. + "action": "A String", # Required. The name of the tool's action associated with this call. + "inputParameters": { # Optional. The action's input parameters. + "a_key": "", # Properties of the object. + }, + "tool": "A String", # Required. The tool associated with this call. Format: `projects//locations//agents//tools/`. + }, + }, + ], + "returnPartialResponses": True or False, # Whether Dialogflow should return currently queued fulfillment response messages in streaming APIs. If a webhook is specified, it happens before Dialogflow invokes webhook. Warning: 1) This flag only affects streaming API. Responses are still queued and returned once in non-streaming API. 2) The flag can be enabled in any fulfillment but only the first 3 partial responses will be returned. You may only want to apply it to fulfillments that have slow webhooks. + "setParameterActions": [ # Set parameter values before executing the webhook. + { # Setting a parameter value. + "parameter": "A String", # Display name of the parameter. + "value": "", # The new value of the parameter. A null value clears the parameter. + }, + ], + "tag": "A String", # The value of this field will be populated in the WebhookRequest `fulfillmentInfo.tag` field by Dialogflow when the associated webhook is called. The tag is typically used by the webhook service to identify which fulfillment is being called, but it could be used for other purposes. This field is required if `webhook` is specified. + "webhook": "A String", # The webhook to call. Format: `projects//locations//agents//webhooks/`. + }, + }, + ], + }, + "isList": True or False, # Indicates whether the parameter represents a list of values. + "redact": True or False, # Indicates whether the parameter content should be redacted in log. If redaction is enabled, the parameter content will be replaced by parameter name during logging. Note: the parameter content is subject to redaction if either parameter level redaction or entity type level redaction is enabled. + "required": True or False, # 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. + }, + ], + }, + "knowledgeConnectorSettings": { # The Knowledge Connector settings for this page or flow. This includes information such as the attached Knowledge Bases, and the way to execute fulfillment. # Optional. Knowledge connector configuration. + "dataStoreConnections": [ # Optional. List of related data store connections. + { # A data store connection. It represents a data store in Discovery Engine and the type of the contents it contains. + "dataStore": "A String", # The full name of the referenced data store. Formats: `projects/{project}/locations/{location}/collections/{collection}/dataStores/{data_store}` `projects/{project}/locations/{location}/dataStores/{data_store}` + "dataStoreType": "A String", # The type of the connected data store. + }, + ], + "enabled": True or False, # Whether Knowledge Connector is enabled or not. + "targetFlow": "A String", # The target flow to transition to. Format: `projects//locations//agents//flows/`. + "targetPage": "A String", # The target page to transition to. Format: `projects//locations//agents//flows//pages/`. + "triggerFulfillment": { # A fulfillment can do one or more of the following actions at the same time: * Generate rich message responses. * Set parameter values. * Call the webhook. Fulfillments can be called at various stages in the Page or Form lifecycle. For example, when a DetectIntentRequest drives a session to enter a new page, the page's entry fulfillment can add a static response to the QueryResult in the returning DetectIntentResponse, call the webhook (for example, to load user data from a database), or both. # The fulfillment to be triggered. When the answers from the Knowledge Connector are selected by Dialogflow, you can utitlize the request scoped parameter `$request.knowledge.answers` (contains up to the 5 highest confidence answers) and `$request.knowledge.questions` (contains the corresponding questions) to construct the fulfillment. + "advancedSettings": { # Hierarchical advanced settings for agent/flow/page/fulfillment/parameter. Settings exposed at lower level overrides the settings exposed at higher level. Overriding occurs at the sub-setting level. For example, the playback_interruption_settings at fulfillment level only overrides the playback_interruption_settings at the agent level, leaving other settings at the agent level unchanged. DTMF settings does not override each other. DTMF settings set at different levels define DTMF detections running in parallel. Hierarchy: Agent->Flow->Page->Fulfillment/Parameter. # Hierarchical advanced settings for this fulfillment. The settings exposed at the lower level overrides the settings exposed at the higher level. + "audioExportGcsDestination": { # Google Cloud Storage location for a Dialogflow operation that writes or exports objects (e.g. exported agent or transcripts) outside of Dialogflow. # If present, incoming audio is exported by Dialogflow to the configured Google Cloud Storage destination. Exposed at the following levels: - Agent level - Flow level + "uri": "A String", # Required. The Google Cloud Storage URI for the exported objects. A URI is of the form: `gs://bucket/object-name-or-prefix` Whether a full object name, or just a prefix, its usage depends on the Dialogflow operation. + }, + "dtmfSettings": { # Define behaviors for DTMF (dual tone multi frequency). # Settings for DTMF. Exposed at the following levels: - Agent level - Flow level - Page level - Parameter level. + "enabled": True or False, # If true, incoming audio is processed for DTMF (dual tone multi frequency) events. For example, if the caller presses a button on their telephone keypad and DTMF processing is enabled, Dialogflow will detect the event (e.g. a "3" was pressed) in the incoming audio and pass the event to the bot to drive business logic (e.g. when 3 is pressed, return the account balance). + "endpointingTimeoutDuration": "A String", # Endpoint timeout setting for matching dtmf input to regex. + "finishDigit": "A String", # The digit that terminates a DTMF digit sequence. + "interdigitTimeoutDuration": "A String", # Interdigit timeout setting for matching dtmf input to regex. + "maxDigits": 42, # Max length of DTMF digits. + }, + "loggingSettings": { # Define behaviors on logging. # Settings for logging. Settings for Dialogflow History, Contact Center messages, StackDriver logs, and speech logging. Exposed at the following levels: - Agent level. + "enableInteractionLogging": True or False, # Enables DF Interaction logging. + "enableStackdriverLogging": True or False, # Enables StackDriver logging. + }, + "speechSettings": { # Define behaviors of speech to text detection. # Settings for speech to text detection. Exposed at the following levels: - Agent level - Flow level - Page level - Parameter level + "endpointerSensitivity": 42, # Sensitivity of the speech model that detects the end of speech. Scale from 0 to 100. + "models": { # Mapping from language to Speech-to-Text model. The mapped Speech-to-Text model will be selected for requests from its corresponding language. For more information, see [Speech models](https://cloud.google.com/dialogflow/cx/docs/concept/speech-models). + "a_key": "A String", + }, + "noSpeechTimeout": "A String", # Timeout before detecting no speech. + "useTimeoutBasedEndpointing": True or False, # Use timeout based endpointing, interpreting endpointer sensitivy as seconds of timeout value. + }, + }, + "conditionalCases": [ # Conditional cases for this fulfillment. + { # A list of cascading if-else conditions. Cases are mutually exclusive. The first one with a matching condition is selected, all the rest ignored. + "cases": [ # A list of cascading if-else conditions. + { # Each case has a Boolean condition. When it is evaluated to be True, the corresponding messages will be selected and evaluated recursively. + "caseContent": [ # A list of case content. + { # The list of messages or conditional cases to activate for this case. + "additionalCases": # Object with schema name: GoogleCloudDialogflowCxV3beta1FulfillmentConditionalCases # Additional cases to be evaluated. + "message": { # 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. # Returned message. + "channel": "A String", # The channel which the response is associated with. Clients can specify the channel via QueryParameters.channel, and only associated channel response will be returned. + "conversationSuccess": { # 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. # Indicates that the conversation succeeded. + "metadata": { # Custom metadata. Dialogflow doesn't impose any structure on this. + "a_key": "", # Properties of the object. + }, + }, + "endInteraction": { # 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. # Output only. A signal that indicates the interaction with the Dialogflow agent has ended. This message is generated by Dialogflow only when the conversation reaches `END_SESSION` page. It is not supposed to be defined by the user. It's guaranteed that there is at most one such message in each response. + }, + "knowledgeInfoCard": { # Represents info card response. If the response contains generative knowledge prediction, Dialogflow will return a payload with Infobot Messenger compatible info card. Otherwise, the info card response is skipped. # Represents info card for knowledge answers, to be better rendered in Dialogflow Messenger. + }, + "liveAgentHandoff": { # 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. # Hands off conversation to a human agent. + "metadata": { # Custom metadata for your handoff procedure. Dialogflow doesn't impose any structure on this. + "a_key": "", # Properties of the object. + }, + }, + "mixedAudio": { # 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. # Output only. An audio response message composed of both the synthesized Dialogflow agent responses and responses defined via play_audio. This message is generated by Dialogflow only and not supposed to be defined by the user. + "segments": [ # Segments this audio response is composed of. + { # Represents one segment of audio. + "allowPlaybackInterruption": True or False, # 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. + "audio": "A String", # Raw audio synthesized from the Dialogflow agent's response using the output config specified in the request. + "uri": "A String", # Client-specific URI that points to an audio clip accessible to the client. Dialogflow does not impose any validation on it. + }, + ], + }, + "outputAudioText": { # A text or ssml response that is preferentially used for TTS output audio synthesis, as described in the comment on the ResponseMessage message. # A text or ssml response that is preferentially used for TTS output audio synthesis, as described in the comment on the ResponseMessage message. + "allowPlaybackInterruption": True or False, # 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. + "ssml": "A String", # The SSML text to be synthesized. For more information, see [SSML](/speech/text-to-speech/docs/ssml). + "text": "A String", # The raw text to be synthesized. + }, + "payload": { # Returns a response containing a custom, platform-specific payload. + "a_key": "", # Properties of the object. + }, + "playAudio": { # Specifies an audio clip to be played by the client as part of the response. # Signal that the client should play an audio clip hosted at a client-specific URI. Dialogflow uses this to construct mixed_audio. However, Dialogflow itself does not try to read or process the URI in any way. + "allowPlaybackInterruption": True or False, # 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. + "audioUri": "A String", # Required. URI of the audio clip. Dialogflow does not impose any validation on this value. It is specific to the client that reads it. + }, + "telephonyTransferCall": { # Represents the signal that telles the client to transfer the phone call connected to the agent to a third-party endpoint. # A signal that the client should transfer the phone call connected to this agent to a third-party endpoint. + "phoneNumber": "A String", # Transfer the call to a phone number in [E.164 format](https://en.wikipedia.org/wiki/E.164). + }, + "text": { # The text response message. # Returns a text response. + "allowPlaybackInterruption": True or False, # 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. + "text": [ # Required. A collection of text responses. + "A String", + ], + }, + "toolCall": { # Represents a call of a specific tool's action with the specified inputs. # Returns the definition of a tool call that should be executed by the client. + "action": "A String", # Required. The name of the tool's action associated with this call. + "inputParameters": { # Optional. The action's input parameters. + "a_key": "", # Properties of the object. + }, + "tool": "A String", # Required. The tool associated with this call. Format: `projects//locations//agents//tools/`. + }, + }, + }, + ], + "condition": "A String", # The condition to activate and select this case. Empty means the condition is always true. The condition is evaluated against form parameters or session parameters. See the [conditions reference](https://cloud.google.com/dialogflow/cx/docs/reference/condition). + }, + ], + }, + ], + "enableGenerativeFallback": True or False, # If the flag is true, the agent will utilize LLM to generate a text response. If LLM generation fails, the defined responses in the fulfillment will be respected. This flag is only useful for fulfillments associated with no-match event handlers. + "messages": [ # The list of rich message responses to present to the user. + { # 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. + "channel": "A String", # The channel which the response is associated with. Clients can specify the channel via QueryParameters.channel, and only associated channel response will be returned. + "conversationSuccess": { # 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. # Indicates that the conversation succeeded. + "metadata": { # Custom metadata. Dialogflow doesn't impose any structure on this. + "a_key": "", # Properties of the object. + }, + }, + "endInteraction": { # 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. # Output only. A signal that indicates the interaction with the Dialogflow agent has ended. This message is generated by Dialogflow only when the conversation reaches `END_SESSION` page. It is not supposed to be defined by the user. It's guaranteed that there is at most one such message in each response. + }, + "knowledgeInfoCard": { # Represents info card response. If the response contains generative knowledge prediction, Dialogflow will return a payload with Infobot Messenger compatible info card. Otherwise, the info card response is skipped. # Represents info card for knowledge answers, to be better rendered in Dialogflow Messenger. + }, + "liveAgentHandoff": { # 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. # Hands off conversation to a human agent. + "metadata": { # Custom metadata for your handoff procedure. Dialogflow doesn't impose any structure on this. + "a_key": "", # Properties of the object. + }, + }, + "mixedAudio": { # 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. # Output only. An audio response message composed of both the synthesized Dialogflow agent responses and responses defined via play_audio. This message is generated by Dialogflow only and not supposed to be defined by the user. + "segments": [ # Segments this audio response is composed of. + { # Represents one segment of audio. + "allowPlaybackInterruption": True or False, # 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. + "audio": "A String", # Raw audio synthesized from the Dialogflow agent's response using the output config specified in the request. + "uri": "A String", # Client-specific URI that points to an audio clip accessible to the client. Dialogflow does not impose any validation on it. + }, + ], + }, + "outputAudioText": { # A text or ssml response that is preferentially used for TTS output audio synthesis, as described in the comment on the ResponseMessage message. # A text or ssml response that is preferentially used for TTS output audio synthesis, as described in the comment on the ResponseMessage message. + "allowPlaybackInterruption": True or False, # 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. + "ssml": "A String", # The SSML text to be synthesized. For more information, see [SSML](/speech/text-to-speech/docs/ssml). + "text": "A String", # The raw text to be synthesized. + }, + "payload": { # Returns a response containing a custom, platform-specific payload. + "a_key": "", # Properties of the object. + }, + "playAudio": { # Specifies an audio clip to be played by the client as part of the response. # Signal that the client should play an audio clip hosted at a client-specific URI. Dialogflow uses this to construct mixed_audio. However, Dialogflow itself does not try to read or process the URI in any way. + "allowPlaybackInterruption": True or False, # 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. + "audioUri": "A String", # Required. URI of the audio clip. Dialogflow does not impose any validation on this value. It is specific to the client that reads it. + }, + "telephonyTransferCall": { # Represents the signal that telles the client to transfer the phone call connected to the agent to a third-party endpoint. # A signal that the client should transfer the phone call connected to this agent to a third-party endpoint. + "phoneNumber": "A String", # Transfer the call to a phone number in [E.164 format](https://en.wikipedia.org/wiki/E.164). + }, + "text": { # The text response message. # Returns a text response. + "allowPlaybackInterruption": True or False, # 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. + "text": [ # Required. A collection of text responses. + "A String", + ], + }, + "toolCall": { # Represents a call of a specific tool's action with the specified inputs. # Returns the definition of a tool call that should be executed by the client. + "action": "A String", # Required. The name of the tool's action associated with this call. + "inputParameters": { # Optional. The action's input parameters. + "a_key": "", # Properties of the object. + }, + "tool": "A String", # Required. The tool associated with this call. Format: `projects//locations//agents//tools/`. + }, + }, + ], + "returnPartialResponses": True or False, # Whether Dialogflow should return currently queued fulfillment response messages in streaming APIs. If a webhook is specified, it happens before Dialogflow invokes webhook. Warning: 1) This flag only affects streaming API. Responses are still queued and returned once in non-streaming API. 2) The flag can be enabled in any fulfillment but only the first 3 partial responses will be returned. You may only want to apply it to fulfillments that have slow webhooks. + "setParameterActions": [ # Set parameter values before executing the webhook. + { # Setting a parameter value. + "parameter": "A String", # Display name of the parameter. + "value": "", # The new value of the parameter. A null value clears the parameter. + }, + ], + "tag": "A String", # The value of this field will be populated in the WebhookRequest `fulfillmentInfo.tag` field by Dialogflow when the associated webhook is called. The tag is typically used by the webhook service to identify which fulfillment is being called, but it could be used for other purposes. This field is required if `webhook` is specified. + "webhook": "A String", # The webhook to call. Format: `projects//locations//agents//webhooks/`. + }, + }, + "name": "A String", # The unique identifier of the page. Required for the Pages.UpdatePage method. Pages.CreatePage populates the name automatically. Format: `projects//locations//agents//flows//pages/`. + "transitionRouteGroups": [ # Ordered list of `TransitionRouteGroups` added to the page. Transition route groups must be unique within a page. If the page links both flow-level transition route groups and agent-level transition route groups, the flow-level ones will have higher priority and will be put before the agent-level ones. * If multiple transition routes within a page scope refer to the same intent, then the precedence order is: page's transition route -> page's transition route group -> flow's transition routes. * If multiple transition route groups within a page contain the same intent, then the first group in the ordered list takes precedence. Format:`projects//locations//agents//flows//transitionRouteGroups/` or `projects//locations//agents//transitionRouteGroups/` for agent-level groups. + "A String", + ], + "transitionRoutes": [ # A list of transitions for the transition rules of this page. They route the conversation to another page in the same flow, or another flow. When we are in a certain page, the TransitionRoutes are evalauted in the following order: * TransitionRoutes defined in the page with intent specified. * TransitionRoutes defined in the transition route groups with intent specified. * TransitionRoutes defined in flow with intent specified. * TransitionRoutes defined in the transition route groups with intent specified. * TransitionRoutes defined in the page with only condition specified. * TransitionRoutes defined in the transition route groups with only condition specified. + { # A transition route specifies a intent that can be matched and/or a data condition that can be evaluated during a session. When a specified transition is matched, the following actions are taken in order: * If there is a `trigger_fulfillment` associated with the transition, it will be called. * If there is a `target_page` associated with the transition, the session will transition into the specified page. * If there is a `target_flow` associated with the transition, the session will transition into the specified flow. + "condition": "A String", # The condition to evaluate against form parameters or session parameters. See the [conditions reference](https://cloud.google.com/dialogflow/cx/docs/reference/condition). At least one of `intent` or `condition` must be specified. When both `intent` and `condition` are specified, the transition can only happen when both are fulfilled. + "description": "A String", # Optional. The description of the transition route. The maximum length is 500 characters. + "intent": "A String", # The unique identifier of an Intent. Format: `projects//locations//agents//intents/`. Indicates that the transition can only happen when the given intent is matched. At least one of `intent` or `condition` must be specified. When both `intent` and `condition` are specified, the transition can only happen when both are fulfilled. + "name": "A String", # Output only. The unique identifier of this transition route. + "targetFlow": "A String", # The target flow to transition to. Format: `projects//locations//agents//flows/`. + "targetPage": "A String", # The target page to transition to. Format: `projects//locations//agents//flows//pages/`. + "triggerFulfillment": { # A fulfillment can do one or more of the following actions at the same time: * Generate rich message responses. * Set parameter values. * Call the webhook. Fulfillments can be called at various stages in the Page or Form lifecycle. For example, when a DetectIntentRequest drives a session to enter a new page, the page's entry fulfillment can add a static response to the QueryResult in the returning DetectIntentResponse, call the webhook (for example, to load user data from a database), or both. # The fulfillment to call when the condition is satisfied. At least one of `trigger_fulfillment` and `target` must be specified. When both are defined, `trigger_fulfillment` is executed first. + "advancedSettings": { # Hierarchical advanced settings for agent/flow/page/fulfillment/parameter. Settings exposed at lower level overrides the settings exposed at higher level. Overriding occurs at the sub-setting level. For example, the playback_interruption_settings at fulfillment level only overrides the playback_interruption_settings at the agent level, leaving other settings at the agent level unchanged. DTMF settings does not override each other. DTMF settings set at different levels define DTMF detections running in parallel. Hierarchy: Agent->Flow->Page->Fulfillment/Parameter. # Hierarchical advanced settings for this fulfillment. The settings exposed at the lower level overrides the settings exposed at the higher level. + "audioExportGcsDestination": { # Google Cloud Storage location for a Dialogflow operation that writes or exports objects (e.g. exported agent or transcripts) outside of Dialogflow. # If present, incoming audio is exported by Dialogflow to the configured Google Cloud Storage destination. Exposed at the following levels: - Agent level - Flow level + "uri": "A String", # Required. The Google Cloud Storage URI for the exported objects. A URI is of the form: `gs://bucket/object-name-or-prefix` Whether a full object name, or just a prefix, its usage depends on the Dialogflow operation. + }, + "dtmfSettings": { # Define behaviors for DTMF (dual tone multi frequency). # Settings for DTMF. Exposed at the following levels: - Agent level - Flow level - Page level - Parameter level. + "enabled": True or False, # If true, incoming audio is processed for DTMF (dual tone multi frequency) events. For example, if the caller presses a button on their telephone keypad and DTMF processing is enabled, Dialogflow will detect the event (e.g. a "3" was pressed) in the incoming audio and pass the event to the bot to drive business logic (e.g. when 3 is pressed, return the account balance). + "endpointingTimeoutDuration": "A String", # Endpoint timeout setting for matching dtmf input to regex. + "finishDigit": "A String", # The digit that terminates a DTMF digit sequence. + "interdigitTimeoutDuration": "A String", # Interdigit timeout setting for matching dtmf input to regex. + "maxDigits": 42, # Max length of DTMF digits. + }, + "loggingSettings": { # Define behaviors on logging. # Settings for logging. Settings for Dialogflow History, Contact Center messages, StackDriver logs, and speech logging. Exposed at the following levels: - Agent level. + "enableInteractionLogging": True or False, # Enables DF Interaction logging. + "enableStackdriverLogging": True or False, # Enables StackDriver logging. + }, + "speechSettings": { # Define behaviors of speech to text detection. # Settings for speech to text detection. Exposed at the following levels: - Agent level - Flow level - Page level - Parameter level + "endpointerSensitivity": 42, # Sensitivity of the speech model that detects the end of speech. Scale from 0 to 100. + "models": { # Mapping from language to Speech-to-Text model. The mapped Speech-to-Text model will be selected for requests from its corresponding language. For more information, see [Speech models](https://cloud.google.com/dialogflow/cx/docs/concept/speech-models). + "a_key": "A String", + }, + "noSpeechTimeout": "A String", # Timeout before detecting no speech. + "useTimeoutBasedEndpointing": True or False, # Use timeout based endpointing, interpreting endpointer sensitivy as seconds of timeout value. + }, + }, + "conditionalCases": [ # Conditional cases for this fulfillment. + { # A list of cascading if-else conditions. Cases are mutually exclusive. The first one with a matching condition is selected, all the rest ignored. + "cases": [ # A list of cascading if-else conditions. + { # Each case has a Boolean condition. When it is evaluated to be True, the corresponding messages will be selected and evaluated recursively. + "caseContent": [ # A list of case content. + { # The list of messages or conditional cases to activate for this case. + "additionalCases": # Object with schema name: GoogleCloudDialogflowCxV3beta1FulfillmentConditionalCases # Additional cases to be evaluated. + "message": { # 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. # Returned message. + "channel": "A String", # The channel which the response is associated with. Clients can specify the channel via QueryParameters.channel, and only associated channel response will be returned. + "conversationSuccess": { # 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. # Indicates that the conversation succeeded. + "metadata": { # Custom metadata. Dialogflow doesn't impose any structure on this. + "a_key": "", # Properties of the object. + }, + }, + "endInteraction": { # 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. # Output only. A signal that indicates the interaction with the Dialogflow agent has ended. This message is generated by Dialogflow only when the conversation reaches `END_SESSION` page. It is not supposed to be defined by the user. It's guaranteed that there is at most one such message in each response. + }, + "knowledgeInfoCard": { # Represents info card response. If the response contains generative knowledge prediction, Dialogflow will return a payload with Infobot Messenger compatible info card. Otherwise, the info card response is skipped. # Represents info card for knowledge answers, to be better rendered in Dialogflow Messenger. + }, + "liveAgentHandoff": { # 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. # Hands off conversation to a human agent. + "metadata": { # Custom metadata for your handoff procedure. Dialogflow doesn't impose any structure on this. + "a_key": "", # Properties of the object. + }, + }, + "mixedAudio": { # 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. # Output only. An audio response message composed of both the synthesized Dialogflow agent responses and responses defined via play_audio. This message is generated by Dialogflow only and not supposed to be defined by the user. + "segments": [ # Segments this audio response is composed of. + { # Represents one segment of audio. + "allowPlaybackInterruption": True or False, # 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. + "audio": "A String", # Raw audio synthesized from the Dialogflow agent's response using the output config specified in the request. + "uri": "A String", # Client-specific URI that points to an audio clip accessible to the client. Dialogflow does not impose any validation on it. + }, + ], + }, + "outputAudioText": { # A text or ssml response that is preferentially used for TTS output audio synthesis, as described in the comment on the ResponseMessage message. # A text or ssml response that is preferentially used for TTS output audio synthesis, as described in the comment on the ResponseMessage message. + "allowPlaybackInterruption": True or False, # 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. + "ssml": "A String", # The SSML text to be synthesized. For more information, see [SSML](/speech/text-to-speech/docs/ssml). + "text": "A String", # The raw text to be synthesized. + }, + "payload": { # Returns a response containing a custom, platform-specific payload. + "a_key": "", # Properties of the object. + }, + "playAudio": { # Specifies an audio clip to be played by the client as part of the response. # Signal that the client should play an audio clip hosted at a client-specific URI. Dialogflow uses this to construct mixed_audio. However, Dialogflow itself does not try to read or process the URI in any way. + "allowPlaybackInterruption": True or False, # 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. + "audioUri": "A String", # Required. URI of the audio clip. Dialogflow does not impose any validation on this value. It is specific to the client that reads it. + }, + "telephonyTransferCall": { # Represents the signal that telles the client to transfer the phone call connected to the agent to a third-party endpoint. # A signal that the client should transfer the phone call connected to this agent to a third-party endpoint. + "phoneNumber": "A String", # Transfer the call to a phone number in [E.164 format](https://en.wikipedia.org/wiki/E.164). + }, + "text": { # The text response message. # Returns a text response. + "allowPlaybackInterruption": True or False, # 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. + "text": [ # Required. A collection of text responses. + "A String", + ], + }, + "toolCall": { # Represents a call of a specific tool's action with the specified inputs. # Returns the definition of a tool call that should be executed by the client. + "action": "A String", # Required. The name of the tool's action associated with this call. + "inputParameters": { # Optional. The action's input parameters. + "a_key": "", # Properties of the object. + }, + "tool": "A String", # Required. The tool associated with this call. Format: `projects//locations//agents//tools/`. + }, + }, + }, + ], + "condition": "A String", # The condition to activate and select this case. Empty means the condition is always true. The condition is evaluated against form parameters or session parameters. See the [conditions reference](https://cloud.google.com/dialogflow/cx/docs/reference/condition). + }, + ], + }, + ], + "enableGenerativeFallback": True or False, # If the flag is true, the agent will utilize LLM to generate a text response. If LLM generation fails, the defined responses in the fulfillment will be respected. This flag is only useful for fulfillments associated with no-match event handlers. + "messages": [ # The list of rich message responses to present to the user. + { # 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. + "channel": "A String", # The channel which the response is associated with. Clients can specify the channel via QueryParameters.channel, and only associated channel response will be returned. + "conversationSuccess": { # 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. # Indicates that the conversation succeeded. + "metadata": { # Custom metadata. Dialogflow doesn't impose any structure on this. + "a_key": "", # Properties of the object. + }, + }, + "endInteraction": { # 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. # Output only. A signal that indicates the interaction with the Dialogflow agent has ended. This message is generated by Dialogflow only when the conversation reaches `END_SESSION` page. It is not supposed to be defined by the user. It's guaranteed that there is at most one such message in each response. + }, + "knowledgeInfoCard": { # Represents info card response. If the response contains generative knowledge prediction, Dialogflow will return a payload with Infobot Messenger compatible info card. Otherwise, the info card response is skipped. # Represents info card for knowledge answers, to be better rendered in Dialogflow Messenger. + }, + "liveAgentHandoff": { # 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. # Hands off conversation to a human agent. + "metadata": { # Custom metadata for your handoff procedure. Dialogflow doesn't impose any structure on this. + "a_key": "", # Properties of the object. + }, + }, + "mixedAudio": { # 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. # Output only. An audio response message composed of both the synthesized Dialogflow agent responses and responses defined via play_audio. This message is generated by Dialogflow only and not supposed to be defined by the user. + "segments": [ # Segments this audio response is composed of. + { # Represents one segment of audio. + "allowPlaybackInterruption": True or False, # 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. + "audio": "A String", # Raw audio synthesized from the Dialogflow agent's response using the output config specified in the request. + "uri": "A String", # Client-specific URI that points to an audio clip accessible to the client. Dialogflow does not impose any validation on it. + }, + ], + }, + "outputAudioText": { # A text or ssml response that is preferentially used for TTS output audio synthesis, as described in the comment on the ResponseMessage message. # A text or ssml response that is preferentially used for TTS output audio synthesis, as described in the comment on the ResponseMessage message. + "allowPlaybackInterruption": True or False, # 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. + "ssml": "A String", # The SSML text to be synthesized. For more information, see [SSML](/speech/text-to-speech/docs/ssml). + "text": "A String", # The raw text to be synthesized. + }, + "payload": { # Returns a response containing a custom, platform-specific payload. + "a_key": "", # Properties of the object. + }, + "playAudio": { # Specifies an audio clip to be played by the client as part of the response. # Signal that the client should play an audio clip hosted at a client-specific URI. Dialogflow uses this to construct mixed_audio. However, Dialogflow itself does not try to read or process the URI in any way. + "allowPlaybackInterruption": True or False, # 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. + "audioUri": "A String", # Required. URI of the audio clip. Dialogflow does not impose any validation on this value. It is specific to the client that reads it. + }, + "telephonyTransferCall": { # Represents the signal that telles the client to transfer the phone call connected to the agent to a third-party endpoint. # A signal that the client should transfer the phone call connected to this agent to a third-party endpoint. + "phoneNumber": "A String", # Transfer the call to a phone number in [E.164 format](https://en.wikipedia.org/wiki/E.164). + }, + "text": { # The text response message. # Returns a text response. + "allowPlaybackInterruption": True or False, # 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. + "text": [ # Required. A collection of text responses. + "A String", + ], + }, + "toolCall": { # Represents a call of a specific tool's action with the specified inputs. # Returns the definition of a tool call that should be executed by the client. + "action": "A String", # Required. The name of the tool's action associated with this call. + "inputParameters": { # Optional. The action's input parameters. + "a_key": "", # Properties of the object. + }, + "tool": "A String", # Required. The tool associated with this call. Format: `projects//locations//agents//tools/`. + }, + }, + ], + "returnPartialResponses": True or False, # Whether Dialogflow should return currently queued fulfillment response messages in streaming APIs. If a webhook is specified, it happens before Dialogflow invokes webhook. Warning: 1) This flag only affects streaming API. Responses are still queued and returned once in non-streaming API. 2) The flag can be enabled in any fulfillment but only the first 3 partial responses will be returned. You may only want to apply it to fulfillments that have slow webhooks. + "setParameterActions": [ # Set parameter values before executing the webhook. + { # Setting a parameter value. + "parameter": "A String", # Display name of the parameter. + "value": "", # The new value of the parameter. A null value clears the parameter. + }, + ], + "tag": "A String", # The value of this field will be populated in the WebhookRequest `fulfillmentInfo.tag` field by Dialogflow when the associated webhook is called. The tag is typically used by the webhook service to identify which fulfillment is being called, but it could be used for other purposes. This field is required if `webhook` is specified. + "webhook": "A String", # The webhook to call. Format: `projects//locations//agents//webhooks/`. + }, + }, + ], + }, + "dataStoreConnectionSignals": { # Data store connection feature output signals. Might be only partially field if processing stop before the final answer. Reasons for this can be, but are not limited to: empty UCS search results, positive RAI check outcome, grounding failure, ... # Optional. Data store connection feature output signals. Filled only when data stores are involved in serving the query and DetectIntentRequest.populate data_store_connection_quality_signals is set to true in the request. + "answer": "A String", # Optional. The final compiled answer. + "answerGenerationModelCallSignals": { # Diagnostic info related to the answer generation model call. # Optional. Diagnostic info related to the answer generation model call. + "modelOutput": "A String", # Output of the generative model. + "renderedPrompt": "A String", # Prompt as sent to the model. + }, + "answerParts": [ # Optional. Answer parts with relevant citations. Concatenation of texts should add up the `answer` (not counting whitespaces). + { # Answer part with citation. + "supportingIndices": [ # Citations for this answer part. Indices of `search_snippets`. + 42, + ], + "text": "A String", # Substring of the answer. + }, + ], + "citedSnippets": [ # Optional. Snippets cited by the answer generation model from the most to least relevant. + { # Snippet cited by the answer generation model. + "searchSnippet": { # Search snippet details. # Details of the snippet. + "documentTitle": "A String", # Title of the enclosing document. + "documentUri": "A String", # Uri for the document. Present if specified for the document. + "text": "A String", # Text included in the prompt. + }, + "snippetIndex": 42, # Index of the snippet in `search_snippets` field. + }, + ], + "groundingSignals": { # Grounding signals. # Optional. Grounding signals. + "decision": "A String", # Represents the decision of the grounding check. + "score": "A String", # Grounding score bucket setting. + }, + "rewriterModelCallSignals": { # Diagnostic info related to the rewriter model call. # Optional. Diagnostic info related to the rewriter model call. + "modelOutput": "A String", # Output of the generative model. + "renderedPrompt": "A String", # Prompt as sent to the model. + }, + "rewrittenQuery": "A String", # Optional. Rewritten string query used for search. + "safetySignals": { # Safety check results. # Optional. Safety check result. + "bannedPhraseMatch": "A String", # Specifies banned phrase match subject. + "decision": "A String", # Safety decision. + "matchedBannedPhrase": "A String", # The matched banned phrase if there was a match. + }, + "searchSnippets": [ # Optional. Search snippets included in the answer generation prompt. + { # Search snippet details. + "documentTitle": "A String", # Title of the enclosing document. + "documentUri": "A String", # Uri for the document. Present if specified for the document. + "text": "A String", # Text included in the prompt. + }, + ], + }, + "diagnosticInfo": { # The free-form diagnostic info. For example, this field could contain webhook call latency. The fields of this data can change without notice, so you should not write code that depends on its structure. One of the fields is called "Alternative Matched Intents", which may aid with debugging. The following describes these intent results: - The list is empty if no intent was matched to end-user input. - Only intents that are referenced in the currently active flow are included. - The matched intent is included. - Other intents that could have matched end-user input, but did not match because they are referenced by intent routes that are out of [scope](https://cloud.google.com/dialogflow/cx/docs/concept/handler#scope), are included. - Other intents referenced by intent routes in scope that matched end-user input, but had a lower confidence score. + "a_key": "", # Properties of the object. + }, + "dtmf": { # Represents the input for dtmf event. # If a DTMF was provided as input, this field will contain a copy of the DtmfInput. + "digits": "A String", # The dtmf digits. + "finishDigit": "A String", # The finish digit (if any). + }, + "generativeInfo": { # Represents the information of a query if handled by generative agent resources. # The information of a query if handled by generative agent resources. + "actionTracingInfo": { # Example represents a sample execution of the playbook in the conversation. An example consists of a list of ordered actions performed by end user or Dialogflow agent according the playbook instructions to fulfill the task. # The actions performed by the generative playbook for the current agent response. + "actions": [ # Required. The ordered list of actions performed by the end user and the Dialogflow agent. + { # Action performed by end user or Dialogflow agent in the conversation. + "agentUtterance": { # AgentUtterance represents one message sent by the agent. # Optional. Action performed by the agent as a message. + "text": "A String", # Required. Message content in text. + }, + "flowInvocation": { # Stores metadata of the invocation of a CX flow. Next Id: 7 # Optional. Action performed on behalf of the agent by invoking a CX flow. + "flow": "A String", # Required. The unique identifier of the flow. Format: `projects//locations//agents/`. + "flowState": "A String", # Required. Flow invocation's output state. + "inputActionParameters": { # Optional. A list of input parameters for the flow. + "a_key": "", # Properties of the object. + }, + "outputActionParameters": { # Optional. A list of output parameters generated by the flow invocation. + "a_key": "", # Properties of the object. + }, + }, + "playbookInvocation": { # Stores metadata of the invocation of a child playbook. Next Id: 5 # Optional. Action performed on behalf of the agent by invoking a child playbook. + "playbook": "A String", # Required. The unique identifier of the playbook. Format: `projects//locations//agents//playbooks/`. + "playbookInput": { # Input of the playbook. # Optional. Input of the child playbook invocation. + "actionParameters": { # Optional. A list of input parameters for the action. + "a_key": "", # Properties of the object. + }, + "precedingConversationSummary": "A String", # Optional. Summary string of the preceding conversation for the child playbook invocation. + }, + "playbookOutput": { # Output of the playbook. # Optional. Output of the child playbook invocation. + "actionParameters": { # Optional. A Struct object of output parameters for the action. + "a_key": "", # Properties of the object. + }, + "executionSummary": "A String", # Optional. Summary string of the execution result of the child playbook. + }, + "playbookState": "A String", # Required. Playbook invocation's output state. + }, + "toolUse": { # Stores metadata of the invocation of an action supported by a tool. # Optional. Action performed on behalf of the agent by calling a plugin tool. + "action": "A String", # Optional. Name of the action to be called during the tool use. + "inputActionParameters": { # Optional. A list of input parameters for the action. + "a_key": "", # Properties of the object. + }, + "outputActionParameters": { # Optional. A list of output parameters generated by the action. + "a_key": "", # Properties of the object. + }, + "tool": "A String", # Required. The tool that should be used. Format: `projects//locations//agents//tools/`. + }, + "userUtterance": { # UserUtterance represents one message sent by the customer. # Optional. Agent obtained a message from the customer. + "text": "A String", # Required. Message content in text. + }, + }, + ], + "conversationState": "A String", # Required. Example's output state. + "createTime": "A String", # Output only. The timestamp of initial example creation. + "description": "A String", # Optional. The high level concise description of the example. The max number of characters is 200. + "displayName": "A String", # Required. The display name of the example. + "languageCode": "A String", # Optional. The language code of the example. If not specified, the agent's default language is used. Note: languages must be enabled in the agent before they can be used. + "name": "A String", # The unique identifier of the playbook example. Format: `projects//locations//agents//playbooks//examples/`. + "playbookInput": { # Input of the playbook. # Optional. The input to the playbook in the example. + "actionParameters": { # Optional. A list of input parameters for the action. + "a_key": "", # Properties of the object. + }, + "precedingConversationSummary": "A String", # Optional. Summary string of the preceding conversation for the child playbook invocation. + }, + "playbookOutput": { # Output of the playbook. # Optional. The output of the playbook in the example. + "actionParameters": { # Optional. A Struct object of output parameters for the action. + "a_key": "", # Properties of the object. + }, + "executionSummary": "A String", # Optional. Summary string of the execution result of the child playbook. + }, + "tokenCount": "A String", # Output only. Estimated number of tokes current example takes when sent to the LLM. + "updateTime": "A String", # Output only. Last time the example was updated. + }, + "currentPlaybooks": [ # The stack of playbooks that the conversation has currently entered, with the most recent one on the top. + "A String", + ], + }, + "intent": { # An intent represents a user's intent to interact with a conversational agent. You can provide information for the Dialogflow API to use to match user input to an intent by adding training phrases (i.e., examples of user input) to your intent. # The Intent that matched the conversational query. Some, not all fields are filled in this message, including but not limited to: `name` and `display_name`. This field is deprecated, please use QueryResult.match instead. + "description": "A String", # Human readable description for better understanding an intent like its scope, content, result etc. Maximum character limit: 140 characters. + "displayName": "A String", # Required. The human-readable name of the intent, unique within the agent. + "isFallback": True or False, # Indicates whether this is a fallback intent. Currently only default fallback intent is allowed in the agent, which is added upon agent creation. Adding training phrases to fallback intent is useful in the case of requests that are mistakenly matched, since training phrases assigned to fallback intents act as negative examples that triggers no-match event. + "labels": { # The key/value metadata to label an intent. Labels can contain lowercase letters, digits and the symbols '-' and '_'. International characters are allowed, including letters from unicase alphabets. Keys must start with a letter. Keys and values can be no longer than 63 characters and no more than 128 bytes. Prefix "sys-" is reserved for Dialogflow defined labels. Currently allowed Dialogflow defined labels include: * sys-head * sys-contextual The above labels do not require value. "sys-head" means the intent is a head intent. "sys-contextual" means the intent is a contextual intent. + "a_key": "A String", + }, + "name": "A String", # The unique identifier of the intent. Required for the Intents.UpdateIntent method. Intents.CreateIntent populates the name automatically. Format: `projects//locations//agents//intents/`. + "parameters": [ # The collection of parameters associated with the intent. + { # Represents an intent parameter. + "entityType": "A String", # Required. The entity type of the parameter. Format: `projects/-/locations/-/agents/-/entityTypes/` for system entity types (for example, `projects/-/locations/-/agents/-/entityTypes/sys.date`), or `projects//locations//agents//entityTypes/` for developer entity types. + "id": "A String", # Required. The unique identifier of the parameter. This field is used by training phrases to annotate their parts. + "isList": True or False, # Indicates whether the parameter represents a list of values. + "redact": True or False, # Indicates whether the parameter content should be redacted in log. If redaction is enabled, the parameter content will be replaced by parameter name during logging. Note: the parameter content is subject to redaction if either parameter level redaction or entity type level redaction is enabled. + }, + ], + "priority": 42, # 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. + "trainingPhrases": [ # The collection of training phrases the agent is trained on to identify the intent. + { # Represents an example that the agent is trained on to identify the intent. + "id": "A String", # Output only. The unique identifier of the training phrase. + "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 `parameter_id` field is set. + { # Represents a part of a training phrase. + "parameterId": "A String", # The parameter used to annotate this part of the training phrase. This field is required for annotated parts of the training phrase. + "text": "A String", # Required. The text for this part. + }, + ], + "repeatCount": 42, # Indicates how many times this example was added to the intent. + }, + ], + }, + "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. This field is deprecated, please use QueryResult.match instead. + "languageCode": "A String", # The language that was triggered during intent detection. See [Language Support](https://cloud.google.com/dialogflow/cx/docs/reference/language) for a list of the currently supported language codes. + "match": { # Represents one match result of MatchIntent. # Intent match result, could be an intent or an event. + "confidence": 3.14, # The confidence of this match. 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. + "event": "A String", # The event that matched the query. Filled for `EVENT`, `NO_MATCH` and `NO_INPUT` match types. + "intent": { # An intent represents a user's intent to interact with a conversational agent. You can provide information for the Dialogflow API to use to match user input to an intent by adding training phrases (i.e., examples of user input) to your intent. # The Intent that matched the query. Some, not all fields are filled in this message, including but not limited to: `name` and `display_name`. Only filled for `INTENT` match type. + "description": "A String", # Human readable description for better understanding an intent like its scope, content, result etc. Maximum character limit: 140 characters. + "displayName": "A String", # Required. The human-readable name of the intent, unique within the agent. + "isFallback": True or False, # Indicates whether this is a fallback intent. Currently only default fallback intent is allowed in the agent, which is added upon agent creation. Adding training phrases to fallback intent is useful in the case of requests that are mistakenly matched, since training phrases assigned to fallback intents act as negative examples that triggers no-match event. + "labels": { # The key/value metadata to label an intent. Labels can contain lowercase letters, digits and the symbols '-' and '_'. International characters are allowed, including letters from unicase alphabets. Keys must start with a letter. Keys and values can be no longer than 63 characters and no more than 128 bytes. Prefix "sys-" is reserved for Dialogflow defined labels. Currently allowed Dialogflow defined labels include: * sys-head * sys-contextual The above labels do not require value. "sys-head" means the intent is a head intent. "sys-contextual" means the intent is a contextual intent. + "a_key": "A String", + }, + "name": "A String", # The unique identifier of the intent. Required for the Intents.UpdateIntent method. Intents.CreateIntent populates the name automatically. Format: `projects//locations//agents//intents/`. + "parameters": [ # The collection of parameters associated with the intent. + { # Represents an intent parameter. + "entityType": "A String", # Required. The entity type of the parameter. Format: `projects/-/locations/-/agents/-/entityTypes/` for system entity types (for example, `projects/-/locations/-/agents/-/entityTypes/sys.date`), or `projects//locations//agents//entityTypes/` for developer entity types. + "id": "A String", # Required. The unique identifier of the parameter. This field is used by training phrases to annotate their parts. + "isList": True or False, # Indicates whether the parameter represents a list of values. + "redact": True or False, # Indicates whether the parameter content should be redacted in log. If redaction is enabled, the parameter content will be replaced by parameter name during logging. Note: the parameter content is subject to redaction if either parameter level redaction or entity type level redaction is enabled. + }, + ], + "priority": 42, # 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. + "trainingPhrases": [ # The collection of training phrases the agent is trained on to identify the intent. + { # Represents an example that the agent is trained on to identify the intent. + "id": "A String", # Output only. The unique identifier of the training phrase. + "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 `parameter_id` field is set. + { # Represents a part of a training phrase. + "parameterId": "A String", # The parameter used to annotate this part of the training phrase. This field is required for annotated parts of the training phrase. + "text": "A String", # Required. The text for this part. + }, + ], + "repeatCount": 42, # Indicates how many times this example was added to the intent. + }, + ], + }, + "matchType": "A String", # Type of this Match. + "parameters": { # The collection of parameters extracted from the query. 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 then use map, otherwise, depending on the parameter value type, it could be one of string, number, boolean, null, list or map. * MapValue value: If parameter's entity type is a composite entity then use map from composite entity property names to property values, otherwise, use parameter value. + "a_key": "", # Properties of the object. + }, + "resolvedInput": "A String", # Final text input which was matched during MatchIntent. This value can be different from original input sent in request because of spelling correction or other processing. + }, + "parameters": { # The collected session 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 then use map, otherwise, depending on the parameter value type, it could be one of string, number, boolean, null, list or map. * MapValue value: If parameter's entity type is a composite entity then use map from composite entity property names to property values, otherwise, use parameter value. + "a_key": "", # Properties of the object. + }, + "responseMessages": [ # The list of rich messages returned to the client. Responses vary from simple text messages to more sophisticated, structured payloads used to drive complex logic. + { # 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. + "channel": "A String", # The channel which the response is associated with. Clients can specify the channel via QueryParameters.channel, and only associated channel response will be returned. + "conversationSuccess": { # 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. # Indicates that the conversation succeeded. + "metadata": { # Custom metadata. Dialogflow doesn't impose any structure on this. + "a_key": "", # Properties of the object. + }, + }, + "endInteraction": { # 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. # Output only. A signal that indicates the interaction with the Dialogflow agent has ended. This message is generated by Dialogflow only when the conversation reaches `END_SESSION` page. It is not supposed to be defined by the user. It's guaranteed that there is at most one such message in each response. + }, + "knowledgeInfoCard": { # Represents info card response. If the response contains generative knowledge prediction, Dialogflow will return a payload with Infobot Messenger compatible info card. Otherwise, the info card response is skipped. # Represents info card for knowledge answers, to be better rendered in Dialogflow Messenger. + }, + "liveAgentHandoff": { # 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. # Hands off conversation to a human agent. + "metadata": { # Custom metadata for your handoff procedure. Dialogflow doesn't impose any structure on this. + "a_key": "", # Properties of the object. + }, + }, + "mixedAudio": { # 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. # Output only. An audio response message composed of both the synthesized Dialogflow agent responses and responses defined via play_audio. This message is generated by Dialogflow only and not supposed to be defined by the user. + "segments": [ # Segments this audio response is composed of. + { # Represents one segment of audio. + "allowPlaybackInterruption": True or False, # 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. + "audio": "A String", # Raw audio synthesized from the Dialogflow agent's response using the output config specified in the request. + "uri": "A String", # Client-specific URI that points to an audio clip accessible to the client. Dialogflow does not impose any validation on it. + }, + ], + }, + "outputAudioText": { # A text or ssml response that is preferentially used for TTS output audio synthesis, as described in the comment on the ResponseMessage message. # A text or ssml response that is preferentially used for TTS output audio synthesis, as described in the comment on the ResponseMessage message. + "allowPlaybackInterruption": True or False, # 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. + "ssml": "A String", # The SSML text to be synthesized. For more information, see [SSML](/speech/text-to-speech/docs/ssml). + "text": "A String", # The raw text to be synthesized. + }, + "payload": { # Returns a response containing a custom, platform-specific payload. + "a_key": "", # Properties of the object. + }, + "playAudio": { # Specifies an audio clip to be played by the client as part of the response. # Signal that the client should play an audio clip hosted at a client-specific URI. Dialogflow uses this to construct mixed_audio. However, Dialogflow itself does not try to read or process the URI in any way. + "allowPlaybackInterruption": True or False, # 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. + "audioUri": "A String", # Required. URI of the audio clip. Dialogflow does not impose any validation on this value. It is specific to the client that reads it. + }, + "telephonyTransferCall": { # Represents the signal that telles the client to transfer the phone call connected to the agent to a third-party endpoint. # A signal that the client should transfer the phone call connected to this agent to a third-party endpoint. + "phoneNumber": "A String", # Transfer the call to a phone number in [E.164 format](https://en.wikipedia.org/wiki/E.164). + }, + "text": { # The text response message. # Returns a text response. + "allowPlaybackInterruption": True or False, # 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. + "text": [ # Required. A collection of text responses. + "A String", + ], + }, + "toolCall": { # Represents a call of a specific tool's action with the specified inputs. # Returns the definition of a tool call that should be executed by the client. + "action": "A String", # Required. The name of the tool's action associated with this call. + "inputParameters": { # Optional. The action's input parameters. "a_key": "", # Properties of the object. }, + "tool": "A String", # Required. The tool associated with this call. Format: `projects//locations//agents//tools/`. + }, + }, + ], + "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. # The sentiment analyss result, which depends on `analyze_query_text_sentiment`, specified in the request. + "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). + "score": 3.14, # Sentiment score between -1.0 (negative sentiment) and 1.0 (positive sentiment). + }, + "text": "A String", # If natural language text was provided as input, this field will contain a copy of the text. + "transcript": "A String", # If natural language speech audio was provided as input, this field will contain the transcript for the audio. + "triggerEvent": "A String", # If an event was provided as input, this field will contain the name of the event. + "triggerIntent": "A String", # If an intent was provided as input, this field will contain a copy of the intent identifier. Format: `projects//locations//agents//intents/`. + "webhookDisplayNames": [ # The list of webhook display names in the order of call sequence. + "A String", + ], + "webhookIds": [ # The list of webhook ids in the order of call sequence. + "A String", + ], + "webhookLatencies": [ # The list of webhook latencies in the order of call sequence. + "A String", + ], + "webhookPayloads": [ # The list of webhook payload in WebhookResponse.payload, in the order of call sequence. If some webhook call fails or doesn't return any payload, an empty `Struct` would be used instead. + { + "a_key": "", # Properties of the object. + }, + ], + "webhookStatuses": [ # The list of webhook call status in the order of call sequence. + { # 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). + "code": 42, # The status code, which should be an enum value of google.rpc.Code. + "details": [ # A list of messages that carry the error details. There is a common set of message types for APIs to use. + { + "a_key": "", # Properties of the object. Contains field @type with type URL. + }, + ], + "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. + }, + ], + "webhookTags": [ # The list of webhook tags in the order of call sequence. + "A String", + ], + }, + "responseId": "A String", # Output only. The unique identifier of the response. It can be used to locate a response in the training example set or for reporting issues. + "responseType": "A String", # Response type. +}
+
+ +
+ fulfillIntent(session, body=None, x__xgafv=None) +
Fulfills a matched intent returned by MatchIntent. Must be called after MatchIntent, with input from MatchIntentResponse. Otherwise, the behavior is undefined.
+
+Args:
+  session: string, Required. The name of the session this query is sent to. Format: `projects//locations//agents//sessions/` or `projects//locations//agents//environments//sessions/`. If `Environment ID` is not specified, we assume default 'draft' environment. It's up to the API caller to choose an appropriate `Session ID`. It can be a random number or some type of session identifiers (preferably hashed). The length of the `Session ID` must not exceed 36 characters. For more information, see the [sessions guide](https://cloud.google.com/dialogflow/cx/docs/concept/session). (required)
+  body: object, The request body.
+    The object takes the form of:
+
+{ # Request of FulfillIntent
+  "match": { # Represents one match result of MatchIntent. # The matched intent/event to fulfill.
+    "confidence": 3.14, # The confidence of this match. 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.
+    "event": "A String", # The event that matched the query. Filled for `EVENT`, `NO_MATCH` and `NO_INPUT` match types.
+    "intent": { # An intent represents a user's intent to interact with a conversational agent. You can provide information for the Dialogflow API to use to match user input to an intent by adding training phrases (i.e., examples of user input) to your intent. # The Intent that matched the query. Some, not all fields are filled in this message, including but not limited to: `name` and `display_name`. Only filled for `INTENT` match type.
+      "description": "A String", # Human readable description for better understanding an intent like its scope, content, result etc. Maximum character limit: 140 characters.
+      "displayName": "A String", # Required. The human-readable name of the intent, unique within the agent.
+      "isFallback": True or False, # Indicates whether this is a fallback intent. Currently only default fallback intent is allowed in the agent, which is added upon agent creation. Adding training phrases to fallback intent is useful in the case of requests that are mistakenly matched, since training phrases assigned to fallback intents act as negative examples that triggers no-match event.
+      "labels": { # The key/value metadata to label an intent. Labels can contain lowercase letters, digits and the symbols '-' and '_'. International characters are allowed, including letters from unicase alphabets. Keys must start with a letter. Keys and values can be no longer than 63 characters and no more than 128 bytes. Prefix "sys-" is reserved for Dialogflow defined labels. Currently allowed Dialogflow defined labels include: * sys-head * sys-contextual The above labels do not require value. "sys-head" means the intent is a head intent. "sys-contextual" means the intent is a contextual intent.
+        "a_key": "A String",
+      },
+      "name": "A String", # The unique identifier of the intent. Required for the Intents.UpdateIntent method. Intents.CreateIntent populates the name automatically. Format: `projects//locations//agents//intents/`.
+      "parameters": [ # The collection of parameters associated with the intent.
+        { # Represents an intent parameter.
+          "entityType": "A String", # Required. The entity type of the parameter. Format: `projects/-/locations/-/agents/-/entityTypes/` for system entity types (for example, `projects/-/locations/-/agents/-/entityTypes/sys.date`), or `projects//locations//agents//entityTypes/` for developer entity types.
+          "id": "A String", # Required. The unique identifier of the parameter. This field is used by training phrases to annotate their parts.
+          "isList": True or False, # Indicates whether the parameter represents a list of values.
+          "redact": True or False, # Indicates whether the parameter content should be redacted in log. If redaction is enabled, the parameter content will be replaced by parameter name during logging. Note: the parameter content is subject to redaction if either parameter level redaction or entity type level redaction is enabled.
+        },
+      ],
+      "priority": 42, # 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.
+      "trainingPhrases": [ # The collection of training phrases the agent is trained on to identify the intent.
+        { # Represents an example that the agent is trained on to identify the intent.
+          "id": "A String", # Output only. The unique identifier of the training phrase.
+          "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 `parameter_id` field is set.
+            { # Represents a part of a training phrase.
+              "parameterId": "A String", # The parameter used to annotate this part of the training phrase. This field is required for annotated parts of the training phrase.
+              "text": "A String", # Required. The text for this part.
+            },
+          ],
+          "repeatCount": 42, # Indicates how many times this example was added to the intent.
+        },
+      ],
+    },
+    "matchType": "A String", # Type of this Match.
+    "parameters": { # The collection of parameters extracted from the query. 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 then use map, otherwise, depending on the parameter value type, it could be one of string, number, boolean, null, list or map. * MapValue value: If parameter's entity type is a composite entity then use map from composite entity property names to property values, otherwise, use parameter value.
+      "a_key": "", # Properties of the object.
+    },
+    "resolvedInput": "A String", # Final text input which was matched during MatchIntent. This value can be different from original input sent in request because of spelling correction or other processing.
+  },
+  "matchIntentRequest": { # Request of MatchIntent. # Must be same as the corresponding MatchIntent request, otherwise the behavior is undefined.
+    "persistParameterChanges": True or False, # Persist session parameter changes from `query_params`.
+    "queryInput": { # Represents the query input. It can contain one of: 1. A conversational query in the form of text. 2. An intent query that specifies which intent to trigger. 3. Natural language speech audio to be processed. 4. An event to be triggered. 5. DTMF digits to invoke an intent and fill in parameter value. 6. The results of a tool executed by the client. # Required. The input specification.
+      "audio": { # Represents the natural speech audio to be processed. # The natural language speech audio to be processed.
+        "audio": "A String", # The natural language speech audio to be processed. A single request can contain up to 2 minutes of speech audio data. The transcribed text cannot contain more than 256 bytes. For non-streaming audio detect intent, both `config` and `audio` must be provided. For streaming audio detect intent, `config` must be provided in the first request and `audio` must be provided in all following requests.
+        "config": { # Instructs the speech recognizer on how to process the audio content. # Required. Instructs the speech recognizer how to process the speech audio.
+          "audioEncoding": "A String", # Required. Audio encoding of the audio content to process.
+          "bargeInConfig": { # Configuration of the barge-in behavior. Barge-in instructs the API to return a detected utterance at a proper time while the client is playing back the response audio from a previous request. When the client sees the utterance, it should stop the playback and immediately get ready for receiving the responses for the current request. The barge-in handling requires the client to start streaming audio input as soon as it starts playing back the audio from the previous response. The playback is modeled into two phases: * No barge-in phase: which goes first and during which speech detection should not be carried out. * Barge-in phase: which follows the no barge-in phase and during which the API starts speech detection and may inform the client that an utterance has been detected. Note that no-speech event is not expected in this phase. The client provides this configuration in terms of the durations of those two phases. The durations are measured in terms of the audio length from the the start of the input audio. No-speech event is a response with END_OF_UTTERANCE without any transcript following up. # Configuration of barge-in behavior during the streaming of input audio.
+            "noBargeInDuration": "A String", # Duration that is not eligible for barge-in at the beginning of the input audio.
+            "totalDuration": "A String", # Total duration for the playback at the beginning of the input audio.
+          },
+          "enableWordInfo": True or False, # Optional. If `true`, Dialogflow returns SpeechWordInfo in StreamingRecognitionResult with information about the recognized speech words, e.g. start and end time offsets. If false or unspecified, Speech doesn't return any word-level information.
+          "model": "A String", # Optional. Which Speech model to select for the given request. For more information, see [Speech models](https://cloud.google.com/dialogflow/cx/docs/concept/speech-models).
+          "modelVariant": "A String", # Optional. Which variant of the Speech model to use.
+          "optOutConformerModelMigration": True or False, # If `true`, the request will opt out for STT conformer model migration. This field will be deprecated once force migration takes place in June 2024. Please refer to [Dialogflow CX Speech model migration](https://cloud.google.com/dialogflow/cx/docs/concept/speech-model-migration).
+          "phraseHints": [ # Optional. A list of strings containing words and phrases that the speech recognizer should recognize with higher likelihood. See [the Cloud Speech documentation](https://cloud.google.com/speech-to-text/docs/basics#phrase-hints) for more details.
+            "A String",
+          ],
+          "sampleRateHertz": 42, # Sample rate (in Hertz) of the audio content sent in the query. Refer to [Cloud Speech API documentation](https://cloud.google.com/speech-to-text/docs/basics) for more details.
+          "singleUtterance": True or False, # Optional. If `false` (default), recognition does not cease until the client closes the stream. If `true`, the recognizer will detect a single spoken utterance in input audio. Recognition ceases when it detects the audio's voice has stopped or paused. In this case, once a detected intent is received, the client should close the stream and start a new request with a new stream as needed. Note: This setting is relevant only for streaming methods.
+        },
+      },
+      "dtmf": { # Represents the input for dtmf event. # The DTMF event to be handled.
+        "digits": "A String", # The dtmf digits.
+        "finishDigit": "A String", # The finish digit (if any).
+      },
+      "event": { # Represents the event to trigger. # The event to be triggered.
+        "event": "A String", # Name of the event.
+      },
+      "intent": { # Represents the intent to trigger programmatically rather than as a result of natural language processing. # The intent to be triggered.
+        "intent": "A String", # Required. The unique identifier of the intent. Format: `projects//locations//agents//intents/`.
+      },
+      "languageCode": "A String", # Required. The language of the input. See [Language Support](https://cloud.google.com/dialogflow/cx/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.
+      "text": { # Represents the natural language text to be processed. # The natural language text to be processed.
+        "text": "A String", # Required. The UTF-8 encoded natural language text to be processed.
+      },
+      "toolCallResult": { # The result of calling a tool's action that has been executed by the client. # The results of a tool executed by the client.
+        "action": "A String", # Required. The name of the tool's action associated with this call.
+        "error": { # An error produced by the tool call. # The tool call's error.
+          "message": "A String", # Optional. The error message of the function.
+        },
+        "outputParameters": { # The tool call's output parameters.
+          "a_key": "", # Properties of the object.
+        },
+        "tool": "A String", # Required. The tool associated with this call. Format: `projects//locations//agents//tools/`.
+      },
+    },
+    "queryParams": { # Represents the parameters of a conversational query. # The parameters of this query.
+      "analyzeQueryTextSentiment": True or False, # Configures whether sentiment analysis should be performed. If not provided, sentiment analysis is not performed.
+      "channel": "A String", # The channel which this query is for. If specified, only the ResponseMessage associated with the channel will be returned. If no ResponseMessage is associated with the channel, it falls back to the ResponseMessage with unspecified channel. If unspecified, the ResponseMessage with unspecified channel will be returned.
+      "currentPage": "A String", # The unique identifier of the page to override the current page in the session. Format: `projects//locations//agents//flows//pages/`. If `current_page` is specified, the previous state of the session will be ignored by Dialogflow, including the previous page and the previous session parameters. In most cases, current_page and parameters should be configured together to direct a session to a specific state.
+      "currentPlaybook": "A String", # Optional. Start the session with the specified playbook. You can only specify the playbook at the beginning of the session. Otherwise, an error will be thrown. Format: `projects//locations//agents//playbooks/`.
+      "disableWebhook": True or False, # Whether to disable webhook calls for this request.
+      "endUserMetadata": { # Optional. Information about the end-user to improve the relevance and accuracy of generative answers. This will be interpreted and used by a language model, so, for good results, the data should be self-descriptive, and in a simple structure. Example: ```json { "subscription plan": "Business Premium Plus", "devices owned": [ {"model": "Google Pixel 7"}, {"model": "Google Pixel Tablet"} ] } ```
+        "a_key": "", # Properties of the object.
+      },
+      "flowVersions": [ # A list of flow versions to override for the request. Format: `projects//locations//agents//flows//versions/`. If version 1 of flow X is included in this list, the traffic of flow X will go through version 1 regardless of the version configuration in the environment. Each flow can have at most one version specified in this list.
+        "A String",
+      ],
+      "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.
+        "latitude": 3.14, # The latitude in degrees. It must be in the range [-90.0, +90.0].
+        "longitude": 3.14, # The longitude in degrees. It must be in the range [-180.0, +180.0].
+      },
+      "llmModelSettings": { # Settings for LLM models. # Optional. Use the specified LLM model settings for processing the request.
+        "model": "A String", # The selected LLM model.
+        "promptText": "A String", # The custom prompt to use.
+      },
+      "parameters": { # Additional parameters to be put into session parameters. To remove a parameter from the session, clients should explicitly set the parameter value to null. You can reference the session parameters in the agent with the following format: $session.params.parameter-id. 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 then use map, otherwise, depending on the parameter value type, it could be one of string, number, boolean, null, list or map. * MapValue value: If parameter's entity type is a composite entity then use map from composite entity property names to property values, otherwise, use parameter value.
+        "a_key": "", # Properties of the object.
+      },
+      "payload": { # This field can be used to pass custom data into the webhook associated with the agent. Arbitrary JSON objects are supported. Some integrations that query a Dialogflow agent may provide additional information in the payload. In particular, for the Dialogflow Phone Gateway integration, this field has the form: ``` { "telephony": { "caller_id": "+18558363987" } } ```
+        "a_key": "", # Properties of the object.
+      },
+      "populateDataStoreConnectionSignals": True or False, # Optional. If set to true and data stores are involved in serving the request then DetectIntentResponse.query_result.data_store_connection_signals will be filled with data that can help evaluations.
+      "searchConfig": { # Search configuration for UCS search queries. # Optional. Search configuration for UCS search queries.
+        "boostSpecs": [ # Optional. Boosting configuration for the datastores.
+          { # Boost specifications for data stores.
+            "dataStores": [ # Optional. Data Stores where the boosting configuration is applied. The full names of the referenced data stores. Formats: `projects/{project}/locations/{location}/collections/{collection}/dataStores/{data_store}` `projects/{project}/locations/{location}/dataStores/{data_store}
+              "A String",
+            ],
+            "spec": [ # Optional. A list of boosting specifications.
+              { # Boost specification to boost certain documents. A copy of google.cloud.discoveryengine.v1main.BoostSpec, field documentation is available at https://cloud.google.com/generative-ai-app-builder/docs/reference/rest/v1alpha/BoostSpec
+                "conditionBoostSpecs": [ # Optional. Condition boost specifications. If a document matches multiple conditions in the specifictions, boost scores from these specifications are all applied and combined in a non-linear way. Maximum number of specifications is 20.
+                  { # Boost applies to documents which match a condition.
+                    "boost": 3.14, # Optional. Strength of the condition boost, which should be in [-1, 1]. Negative boost means demotion. Default is 0.0. Setting to 1.0 gives the document a big promotion. However, it does not necessarily mean that the boosted document will be the top result at all times, nor that other documents will be excluded. Results could still be shown even when none of them matches the condition. And results that are significantly more relevant to the search query can still trump your heavily favored but irrelevant documents. Setting to -1.0 gives the document a big demotion. However, results that are deeply relevant might still be shown. The document will have an upstream battle to get a fairly high ranking, but it is not blocked out completely. Setting to 0.0 means no boost applied. The boosting condition is ignored.
+                    "condition": "A String", # Optional. An expression which specifies a boost condition. The syntax and supported fields are the same as a filter expression. Examples: * To boost documents with document ID "doc_1" or "doc_2", and color "Red" or "Blue": * (id: ANY("doc_1", "doc_2")) AND (color: ANY("Red","Blue"))
+                  },
+                ],
+              },
+            ],
+          },
+        ],
+        "filterSpecs": [ # Optional. Filter configuration for the datastores.
+          { # Filter specifications for data stores.
+            "dataStores": [ # Optional. Data Stores where the boosting configuration is applied. The full names of the referenced data stores. Formats: `projects/{project}/locations/{location}/collections/{collection}/dataStores/{data_store}` `projects/{project}/locations/{location}/dataStores/{data_store}
+              "A String",
+            ],
+            "filter": "A String", # Optional. The filter expression to be applied. Expression syntax is documented at https://cloud.google.com/generative-ai-app-builder/docs/filter-search-metadata#filter-expression-syntax
+          },
+        ],
+      },
+      "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.
+        { # Session entity types are referred to as **User** entity types and are entities that are built for an individual user such as favorites, preferences, playlists, and so on. You can redefine a session entity type at the session level to extend or replace a custom entity type at the user session level (we refer to the entity types defined at the agent level as "custom entity types"). Note: session entity types apply to all queries, regardless of the language. For more information about entity types, see the [Dialogflow documentation](https://cloud.google.com/dialogflow/docs/entities-overview).
+          "entities": [ # Required. The collection of entities to override or supplement the custom entity type.
+            { # An **entity entry** for an associated entity type.
+              "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`.
+                "A String",
+              ],
+              "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 canonical 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).
+            },
+          ],
+          "entityOverrideMode": "A String", # Required. Indicates whether the additional data should override or supplement the custom entity type definition.
+          "name": "A String", # Required. The unique identifier of the session entity type. Format: `projects//locations//agents//sessions//entityTypes/` or `projects//locations//agents//environments//sessions//entityTypes/`. If `Environment ID` is not specified, we assume default 'draft' environment.
+        },
+      ],
+      "sessionTtl": "A String", # Optional. Configure lifetime of the Dialogflow session. By default, a Dialogflow session remains active and its data is stored for 30 minutes after the last request is sent for the session. This value should be no longer than 1 day.
+      "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 the agent is used.
+      "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 Dialogflow web console. The headers defined within this field will overwrite the headers configured through 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.
+        "a_key": "A String",
+      },
+    },
+  },
+  "outputAudioConfig": { # Instructs the speech synthesizer how to generate the output audio content. # Instructs the speech synthesizer how to generate output audio.
+    "audioEncoding": "A String", # Required. Audio encoding of the synthesized audio content.
+    "sampleRateHertz": 42, # Optional. 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).
+    "synthesizeSpeechConfig": { # Configuration of how speech should be synthesized. # Optional. Configuration of how speech should be synthesized. If not specified, Agent.text_to_speech_settings is applied.
+      "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.
+        "A String",
+      ],
+      "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.
+      "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.
+      "voice": { # Description of which voice to use for speech synthesis. # Optional. The desired voice of the synthesized audio.
+        "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. For the list of available voices, please refer to [Supported voices and languages](https://cloud.google.com/text-to-speech/docs/voices).
+        "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.
+      },
+      "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.
+    },
+  },
+}
+
+  x__xgafv: string, V1 error format.
+    Allowed values
+      1 - v1 error format
+      2 - v2 error format
+
+Returns:
+  An object of the form:
+
+    { # Response of FulfillIntent
+  "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.response_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.
+  "outputAudioConfig": { # Instructs the speech synthesizer how to generate the output audio content. # The config used by the speech synthesizer to generate the output audio.
+    "audioEncoding": "A String", # Required. Audio encoding of the synthesized audio content.
+    "sampleRateHertz": 42, # Optional. 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).
+    "synthesizeSpeechConfig": { # Configuration of how speech should be synthesized. # Optional. Configuration of how speech should be synthesized. If not specified, Agent.text_to_speech_settings is applied.
+      "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.
+        "A String",
+      ],
+      "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.
+      "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.
+      "voice": { # Description of which voice to use for speech synthesis. # Optional. The desired voice of the synthesized audio.
+        "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. For the list of available voices, please refer to [Supported voices and languages](https://cloud.google.com/text-to-speech/docs/voices).
+        "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.
+      },
+      "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.
+    },
+  },
+  "queryResult": { # Represents the result of a conversational query. # The result of the conversational query.
+    "advancedSettings": { # Hierarchical advanced settings for agent/flow/page/fulfillment/parameter. Settings exposed at lower level overrides the settings exposed at higher level. Overriding occurs at the sub-setting level. For example, the playback_interruption_settings at fulfillment level only overrides the playback_interruption_settings at the agent level, leaving other settings at the agent level unchanged. DTMF settings does not override each other. DTMF settings set at different levels define DTMF detections running in parallel. Hierarchy: Agent->Flow->Page->Fulfillment/Parameter. # Returns the current advanced settings including IVR settings. Even though the operations configured by these settings are performed by Dialogflow, the client may need to perform special logic at the moment. For example, if Dialogflow exports audio to Google Cloud Storage, then the client may need to wait for the resulting object to appear in the bucket before proceeding.
+      "audioExportGcsDestination": { # Google Cloud Storage location for a Dialogflow operation that writes or exports objects (e.g. exported agent or transcripts) outside of Dialogflow. # If present, incoming audio is exported by Dialogflow to the configured Google Cloud Storage destination. Exposed at the following levels: - Agent level - Flow level
+        "uri": "A String", # Required. The Google Cloud Storage URI for the exported objects. A URI is of the form: `gs://bucket/object-name-or-prefix` Whether a full object name, or just a prefix, its usage depends on the Dialogflow operation.
+      },
+      "dtmfSettings": { # Define behaviors for DTMF (dual tone multi frequency). # Settings for DTMF. Exposed at the following levels: - Agent level - Flow level - Page level - Parameter level.
+        "enabled": True or False, # If true, incoming audio is processed for DTMF (dual tone multi frequency) events. For example, if the caller presses a button on their telephone keypad and DTMF processing is enabled, Dialogflow will detect the event (e.g. a "3" was pressed) in the incoming audio and pass the event to the bot to drive business logic (e.g. when 3 is pressed, return the account balance).
+        "endpointingTimeoutDuration": "A String", # Endpoint timeout setting for matching dtmf input to regex.
+        "finishDigit": "A String", # The digit that terminates a DTMF digit sequence.
+        "interdigitTimeoutDuration": "A String", # Interdigit timeout setting for matching dtmf input to regex.
+        "maxDigits": 42, # Max length of DTMF digits.
+      },
+      "loggingSettings": { # Define behaviors on logging. # Settings for logging. Settings for Dialogflow History, Contact Center messages, StackDriver logs, and speech logging. Exposed at the following levels: - Agent level.
+        "enableInteractionLogging": True or False, # Enables DF Interaction logging.
+        "enableStackdriverLogging": True or False, # Enables StackDriver logging.
+      },
+      "speechSettings": { # Define behaviors of speech to text detection. # Settings for speech to text detection. Exposed at the following levels: - Agent level - Flow level - Page level - Parameter level
+        "endpointerSensitivity": 42, # Sensitivity of the speech model that detects the end of speech. Scale from 0 to 100.
+        "models": { # Mapping from language to Speech-to-Text model. The mapped Speech-to-Text model will be selected for requests from its corresponding language. For more information, see [Speech models](https://cloud.google.com/dialogflow/cx/docs/concept/speech-models).
+          "a_key": "A String",
+        },
+        "noSpeechTimeout": "A String", # Timeout before detecting no speech.
+        "useTimeoutBasedEndpointing": True or False, # Use timeout based endpointing, interpreting endpointer sensitivy as seconds of timeout value.
+      },
+    },
+    "allowAnswerFeedback": True or False, # Indicates whether the Thumbs up/Thumbs down rating controls are need to be shown for the response in the Dialogflow Messenger widget.
+    "currentFlow": { # Flows represents the conversation flows when you build your chatbot agent. A flow consists of many pages connected by the transition routes. Conversations always start with the built-in Start Flow (with an all-0 ID). Transition routes can direct the conversation session from the current flow (parent flow) to another flow (sub flow). When the sub flow is finished, Dialogflow will bring the session back to the parent flow, where the sub flow is started. Usually, when a transition route is followed by a matched intent, the intent will be "consumed". This means the intent won't activate more transition routes. However, when the followed transition route moves the conversation session into a different flow, the matched intent can be carried over and to be consumed in the target flow. # The current Flow. Some, not all fields are filled in this message, including but not limited to `name` and `display_name`.
+      "advancedSettings": { # Hierarchical advanced settings for agent/flow/page/fulfillment/parameter. Settings exposed at lower level overrides the settings exposed at higher level. Overriding occurs at the sub-setting level. For example, the playback_interruption_settings at fulfillment level only overrides the playback_interruption_settings at the agent level, leaving other settings at the agent level unchanged. DTMF settings does not override each other. DTMF settings set at different levels define DTMF detections running in parallel. Hierarchy: Agent->Flow->Page->Fulfillment/Parameter. # Hierarchical advanced settings for this flow. The settings exposed at the lower level overrides the settings exposed at the higher level.
+        "audioExportGcsDestination": { # Google Cloud Storage location for a Dialogflow operation that writes or exports objects (e.g. exported agent or transcripts) outside of Dialogflow. # If present, incoming audio is exported by Dialogflow to the configured Google Cloud Storage destination. Exposed at the following levels: - Agent level - Flow level
+          "uri": "A String", # Required. The Google Cloud Storage URI for the exported objects. A URI is of the form: `gs://bucket/object-name-or-prefix` Whether a full object name, or just a prefix, its usage depends on the Dialogflow operation.
+        },
+        "dtmfSettings": { # Define behaviors for DTMF (dual tone multi frequency). # Settings for DTMF. Exposed at the following levels: - Agent level - Flow level - Page level - Parameter level.
+          "enabled": True or False, # If true, incoming audio is processed for DTMF (dual tone multi frequency) events. For example, if the caller presses a button on their telephone keypad and DTMF processing is enabled, Dialogflow will detect the event (e.g. a "3" was pressed) in the incoming audio and pass the event to the bot to drive business logic (e.g. when 3 is pressed, return the account balance).
+          "endpointingTimeoutDuration": "A String", # Endpoint timeout setting for matching dtmf input to regex.
+          "finishDigit": "A String", # The digit that terminates a DTMF digit sequence.
+          "interdigitTimeoutDuration": "A String", # Interdigit timeout setting for matching dtmf input to regex.
+          "maxDigits": 42, # Max length of DTMF digits.
+        },
+        "loggingSettings": { # Define behaviors on logging. # Settings for logging. Settings for Dialogflow History, Contact Center messages, StackDriver logs, and speech logging. Exposed at the following levels: - Agent level.
+          "enableInteractionLogging": True or False, # Enables DF Interaction logging.
+          "enableStackdriverLogging": True or False, # Enables StackDriver logging.
+        },
+        "speechSettings": { # Define behaviors of speech to text detection. # Settings for speech to text detection. Exposed at the following levels: - Agent level - Flow level - Page level - Parameter level
+          "endpointerSensitivity": 42, # Sensitivity of the speech model that detects the end of speech. Scale from 0 to 100.
+          "models": { # Mapping from language to Speech-to-Text model. The mapped Speech-to-Text model will be selected for requests from its corresponding language. For more information, see [Speech models](https://cloud.google.com/dialogflow/cx/docs/concept/speech-models).
+            "a_key": "A String",
+          },
+          "noSpeechTimeout": "A String", # Timeout before detecting no speech.
+          "useTimeoutBasedEndpointing": True or False, # Use timeout based endpointing, interpreting endpointer sensitivy as seconds of timeout value.
+        },
+      },
+      "description": "A String", # The description of the flow. The maximum length is 500 characters. If exceeded, the request is rejected.
+      "displayName": "A String", # Required. The human-readable name of the flow.
+      "eventHandlers": [ # A flow's event handlers serve two purposes: * They are responsible for handling events (e.g. no match, webhook errors) in the flow. * They are inherited by every page's event handlers, which can be used to handle common events regardless of the current page. Event handlers defined in the page have higher priority than those defined in the flow. Unlike transition_routes, these handlers are evaluated on a first-match basis. The first one that matches the event get executed, with the rest being ignored.
+        { # An event handler specifies an event that can be handled during a session. When the specified event happens, the following actions are taken in order: * If there is a `trigger_fulfillment` associated with the event, it will be called. * If there is a `target_page` associated with the event, the session will transition into the specified page. * If there is a `target_flow` associated with the event, the session will transition into the specified flow.
+          "event": "A String", # Required. The name of the event to handle.
+          "name": "A String", # Output only. The unique identifier of this event handler.
+          "targetFlow": "A String", # The target flow to transition to. Format: `projects//locations//agents//flows/`.
+          "targetPage": "A String", # The target page to transition to. Format: `projects//locations//agents//flows//pages/`.
+          "triggerFulfillment": { # A fulfillment can do one or more of the following actions at the same time: * Generate rich message responses. * Set parameter values. * Call the webhook. Fulfillments can be called at various stages in the Page or Form lifecycle. For example, when a DetectIntentRequest drives a session to enter a new page, the page's entry fulfillment can add a static response to the QueryResult in the returning DetectIntentResponse, call the webhook (for example, to load user data from a database), or both. # The fulfillment to call when the event occurs. Handling webhook errors with a fulfillment enabled with webhook could cause infinite loop. It is invalid to specify such fulfillment for a handler handling webhooks.
+            "advancedSettings": { # Hierarchical advanced settings for agent/flow/page/fulfillment/parameter. Settings exposed at lower level overrides the settings exposed at higher level. Overriding occurs at the sub-setting level. For example, the playback_interruption_settings at fulfillment level only overrides the playback_interruption_settings at the agent level, leaving other settings at the agent level unchanged. DTMF settings does not override each other. DTMF settings set at different levels define DTMF detections running in parallel. Hierarchy: Agent->Flow->Page->Fulfillment/Parameter. # Hierarchical advanced settings for this fulfillment. The settings exposed at the lower level overrides the settings exposed at the higher level.
+              "audioExportGcsDestination": { # Google Cloud Storage location for a Dialogflow operation that writes or exports objects (e.g. exported agent or transcripts) outside of Dialogflow. # If present, incoming audio is exported by Dialogflow to the configured Google Cloud Storage destination. Exposed at the following levels: - Agent level - Flow level
+                "uri": "A String", # Required. The Google Cloud Storage URI for the exported objects. A URI is of the form: `gs://bucket/object-name-or-prefix` Whether a full object name, or just a prefix, its usage depends on the Dialogflow operation.
+              },
+              "dtmfSettings": { # Define behaviors for DTMF (dual tone multi frequency). # Settings for DTMF. Exposed at the following levels: - Agent level - Flow level - Page level - Parameter level.
+                "enabled": True or False, # If true, incoming audio is processed for DTMF (dual tone multi frequency) events. For example, if the caller presses a button on their telephone keypad and DTMF processing is enabled, Dialogflow will detect the event (e.g. a "3" was pressed) in the incoming audio and pass the event to the bot to drive business logic (e.g. when 3 is pressed, return the account balance).
+                "endpointingTimeoutDuration": "A String", # Endpoint timeout setting for matching dtmf input to regex.
+                "finishDigit": "A String", # The digit that terminates a DTMF digit sequence.
+                "interdigitTimeoutDuration": "A String", # Interdigit timeout setting for matching dtmf input to regex.
+                "maxDigits": 42, # Max length of DTMF digits.
+              },
+              "loggingSettings": { # Define behaviors on logging. # Settings for logging. Settings for Dialogflow History, Contact Center messages, StackDriver logs, and speech logging. Exposed at the following levels: - Agent level.
+                "enableInteractionLogging": True or False, # Enables DF Interaction logging.
+                "enableStackdriverLogging": True or False, # Enables StackDriver logging.
+              },
+              "speechSettings": { # Define behaviors of speech to text detection. # Settings for speech to text detection. Exposed at the following levels: - Agent level - Flow level - Page level - Parameter level
+                "endpointerSensitivity": 42, # Sensitivity of the speech model that detects the end of speech. Scale from 0 to 100.
+                "models": { # Mapping from language to Speech-to-Text model. The mapped Speech-to-Text model will be selected for requests from its corresponding language. For more information, see [Speech models](https://cloud.google.com/dialogflow/cx/docs/concept/speech-models).
+                  "a_key": "A String",
+                },
+                "noSpeechTimeout": "A String", # Timeout before detecting no speech.
+                "useTimeoutBasedEndpointing": True or False, # Use timeout based endpointing, interpreting endpointer sensitivy as seconds of timeout value.
+              },
+            },
+            "conditionalCases": [ # Conditional cases for this fulfillment.
+              { # A list of cascading if-else conditions. Cases are mutually exclusive. The first one with a matching condition is selected, all the rest ignored.
+                "cases": [ # A list of cascading if-else conditions.
+                  { # Each case has a Boolean condition. When it is evaluated to be True, the corresponding messages will be selected and evaluated recursively.
+                    "caseContent": [ # A list of case content.
+                      { # The list of messages or conditional cases to activate for this case.
+                        "additionalCases": # Object with schema name: GoogleCloudDialogflowCxV3beta1FulfillmentConditionalCases # Additional cases to be evaluated.
+                        "message": { # 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. # Returned message.
+                          "channel": "A String", # The channel which the response is associated with. Clients can specify the channel via QueryParameters.channel, and only associated channel response will be returned.
+                          "conversationSuccess": { # 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. # Indicates that the conversation succeeded.
+                            "metadata": { # Custom metadata. Dialogflow doesn't impose any structure on this.
+                              "a_key": "", # Properties of the object.
+                            },
+                          },
+                          "endInteraction": { # 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. # Output only. A signal that indicates the interaction with the Dialogflow agent has ended. This message is generated by Dialogflow only when the conversation reaches `END_SESSION` page. It is not supposed to be defined by the user. It's guaranteed that there is at most one such message in each response.
+                          },
+                          "knowledgeInfoCard": { # Represents info card response. If the response contains generative knowledge prediction, Dialogflow will return a payload with Infobot Messenger compatible info card. Otherwise, the info card response is skipped. # Represents info card for knowledge answers, to be better rendered in Dialogflow Messenger.
+                          },
+                          "liveAgentHandoff": { # 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. # Hands off conversation to a human agent.
+                            "metadata": { # Custom metadata for your handoff procedure. Dialogflow doesn't impose any structure on this.
+                              "a_key": "", # Properties of the object.
+                            },
+                          },
+                          "mixedAudio": { # 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. # Output only. An audio response message composed of both the synthesized Dialogflow agent responses and responses defined via play_audio. This message is generated by Dialogflow only and not supposed to be defined by the user.
+                            "segments": [ # Segments this audio response is composed of.
+                              { # Represents one segment of audio.
+                                "allowPlaybackInterruption": True or False, # 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.
+                                "audio": "A String", # Raw audio synthesized from the Dialogflow agent's response using the output config specified in the request.
+                                "uri": "A String", # Client-specific URI that points to an audio clip accessible to the client. Dialogflow does not impose any validation on it.
+                              },
+                            ],
+                          },
+                          "outputAudioText": { # A text or ssml response that is preferentially used for TTS output audio synthesis, as described in the comment on the ResponseMessage message. # A text or ssml response that is preferentially used for TTS output audio synthesis, as described in the comment on the ResponseMessage message.
+                            "allowPlaybackInterruption": True or False, # 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.
+                            "ssml": "A String", # The SSML text to be synthesized. For more information, see [SSML](/speech/text-to-speech/docs/ssml).
+                            "text": "A String", # The raw text to be synthesized.
+                          },
+                          "payload": { # Returns a response containing a custom, platform-specific payload.
+                            "a_key": "", # Properties of the object.
+                          },
+                          "playAudio": { # Specifies an audio clip to be played by the client as part of the response. # Signal that the client should play an audio clip hosted at a client-specific URI. Dialogflow uses this to construct mixed_audio. However, Dialogflow itself does not try to read or process the URI in any way.
+                            "allowPlaybackInterruption": True or False, # 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.
+                            "audioUri": "A String", # Required. URI of the audio clip. Dialogflow does not impose any validation on this value. It is specific to the client that reads it.
+                          },
+                          "telephonyTransferCall": { # Represents the signal that telles the client to transfer the phone call connected to the agent to a third-party endpoint. # A signal that the client should transfer the phone call connected to this agent to a third-party endpoint.
+                            "phoneNumber": "A String", # Transfer the call to a phone number in [E.164 format](https://en.wikipedia.org/wiki/E.164).
+                          },
+                          "text": { # The text response message. # Returns a text response.
+                            "allowPlaybackInterruption": True or False, # 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.
+                            "text": [ # Required. A collection of text responses.
+                              "A String",
+                            ],
+                          },
+                          "toolCall": { # Represents a call of a specific tool's action with the specified inputs. # Returns the definition of a tool call that should be executed by the client.
+                            "action": "A String", # Required. The name of the tool's action associated with this call.
+                            "inputParameters": { # Optional. The action's input parameters.
+                              "a_key": "", # Properties of the object.
+                            },
+                            "tool": "A String", # Required. The tool associated with this call. Format: `projects//locations//agents//tools/`.
+                          },
+                        },
+                      },
+                    ],
+                    "condition": "A String", # The condition to activate and select this case. Empty means the condition is always true. The condition is evaluated against form parameters or session parameters. See the [conditions reference](https://cloud.google.com/dialogflow/cx/docs/reference/condition).
+                  },
+                ],
+              },
+            ],
+            "enableGenerativeFallback": True or False, # If the flag is true, the agent will utilize LLM to generate a text response. If LLM generation fails, the defined responses in the fulfillment will be respected. This flag is only useful for fulfillments associated with no-match event handlers.
+            "messages": [ # The list of rich message responses to present to the user.
+              { # 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.
+                "channel": "A String", # The channel which the response is associated with. Clients can specify the channel via QueryParameters.channel, and only associated channel response will be returned.
+                "conversationSuccess": { # 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. # Indicates that the conversation succeeded.
+                  "metadata": { # Custom metadata. Dialogflow doesn't impose any structure on this.
+                    "a_key": "", # Properties of the object.
+                  },
+                },
+                "endInteraction": { # 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. # Output only. A signal that indicates the interaction with the Dialogflow agent has ended. This message is generated by Dialogflow only when the conversation reaches `END_SESSION` page. It is not supposed to be defined by the user. It's guaranteed that there is at most one such message in each response.
+                },
+                "knowledgeInfoCard": { # Represents info card response. If the response contains generative knowledge prediction, Dialogflow will return a payload with Infobot Messenger compatible info card. Otherwise, the info card response is skipped. # Represents info card for knowledge answers, to be better rendered in Dialogflow Messenger.
+                },
+                "liveAgentHandoff": { # 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. # Hands off conversation to a human agent.
+                  "metadata": { # Custom metadata for your handoff procedure. Dialogflow doesn't impose any structure on this.
+                    "a_key": "", # Properties of the object.
+                  },
+                },
+                "mixedAudio": { # 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. # Output only. An audio response message composed of both the synthesized Dialogflow agent responses and responses defined via play_audio. This message is generated by Dialogflow only and not supposed to be defined by the user.
+                  "segments": [ # Segments this audio response is composed of.
+                    { # Represents one segment of audio.
+                      "allowPlaybackInterruption": True or False, # 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.
+                      "audio": "A String", # Raw audio synthesized from the Dialogflow agent's response using the output config specified in the request.
+                      "uri": "A String", # Client-specific URI that points to an audio clip accessible to the client. Dialogflow does not impose any validation on it.
+                    },
+                  ],
+                },
+                "outputAudioText": { # A text or ssml response that is preferentially used for TTS output audio synthesis, as described in the comment on the ResponseMessage message. # A text or ssml response that is preferentially used for TTS output audio synthesis, as described in the comment on the ResponseMessage message.
+                  "allowPlaybackInterruption": True or False, # 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.
+                  "ssml": "A String", # The SSML text to be synthesized. For more information, see [SSML](/speech/text-to-speech/docs/ssml).
+                  "text": "A String", # The raw text to be synthesized.
+                },
+                "payload": { # Returns a response containing a custom, platform-specific payload.
+                  "a_key": "", # Properties of the object.
+                },
+                "playAudio": { # Specifies an audio clip to be played by the client as part of the response. # Signal that the client should play an audio clip hosted at a client-specific URI. Dialogflow uses this to construct mixed_audio. However, Dialogflow itself does not try to read or process the URI in any way.
+                  "allowPlaybackInterruption": True or False, # 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.
+                  "audioUri": "A String", # Required. URI of the audio clip. Dialogflow does not impose any validation on this value. It is specific to the client that reads it.
+                },
+                "telephonyTransferCall": { # Represents the signal that telles the client to transfer the phone call connected to the agent to a third-party endpoint. # A signal that the client should transfer the phone call connected to this agent to a third-party endpoint.
+                  "phoneNumber": "A String", # Transfer the call to a phone number in [E.164 format](https://en.wikipedia.org/wiki/E.164).
+                },
+                "text": { # The text response message. # Returns a text response.
+                  "allowPlaybackInterruption": True or False, # 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.
+                  "text": [ # Required. A collection of text responses.
+                    "A String",
+                  ],
+                },
+                "toolCall": { # Represents a call of a specific tool's action with the specified inputs. # Returns the definition of a tool call that should be executed by the client.
+                  "action": "A String", # Required. The name of the tool's action associated with this call.
+                  "inputParameters": { # Optional. The action's input parameters.
+                    "a_key": "", # Properties of the object.
+                  },
+                  "tool": "A String", # Required. The tool associated with this call. Format: `projects//locations//agents//tools/`.
+                },
+              },
+            ],
+            "returnPartialResponses": True or False, # Whether Dialogflow should return currently queued fulfillment response messages in streaming APIs. If a webhook is specified, it happens before Dialogflow invokes webhook. Warning: 1) This flag only affects streaming API. Responses are still queued and returned once in non-streaming API. 2) The flag can be enabled in any fulfillment but only the first 3 partial responses will be returned. You may only want to apply it to fulfillments that have slow webhooks.
+            "setParameterActions": [ # Set parameter values before executing the webhook.
+              { # Setting a parameter value.
+                "parameter": "A String", # Display name of the parameter.
+                "value": "", # The new value of the parameter. A null value clears the parameter.
+              },
+            ],
+            "tag": "A String", # The value of this field will be populated in the WebhookRequest `fulfillmentInfo.tag` field by Dialogflow when the associated webhook is called. The tag is typically used by the webhook service to identify which fulfillment is being called, but it could be used for other purposes. This field is required if `webhook` is specified.
+            "webhook": "A String", # The webhook to call. Format: `projects//locations//agents//webhooks/`.
+          },
         },
-        "mixedAudio": { # 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. # Output only. An audio response message composed of both the synthesized Dialogflow agent responses and responses defined via play_audio. This message is generated by Dialogflow only and not supposed to be defined by the user.
-          "segments": [ # Segments this audio response is composed of.
-            { # Represents one segment of audio.
-              "allowPlaybackInterruption": True or False, # 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.
-              "audio": "A String", # Raw audio synthesized from the Dialogflow agent's response using the output config specified in the request.
-              "uri": "A String", # Client-specific URI that points to an audio clip accessible to the client. Dialogflow does not impose any validation on it.
+      ],
+      "knowledgeConnectorSettings": { # The Knowledge Connector settings for this page or flow. This includes information such as the attached Knowledge Bases, and the way to execute fulfillment. # Optional. Knowledge connector configuration.
+        "dataStoreConnections": [ # Optional. List of related data store connections.
+          { # A data store connection. It represents a data store in Discovery Engine and the type of the contents it contains.
+            "dataStore": "A String", # The full name of the referenced data store. Formats: `projects/{project}/locations/{location}/collections/{collection}/dataStores/{data_store}` `projects/{project}/locations/{location}/dataStores/{data_store}`
+            "dataStoreType": "A String", # The type of the connected data store.
+          },
+        ],
+        "enabled": True or False, # Whether Knowledge Connector is enabled or not.
+        "targetFlow": "A String", # The target flow to transition to. Format: `projects//locations//agents//flows/`.
+        "targetPage": "A String", # The target page to transition to. Format: `projects//locations//agents//flows//pages/`.
+        "triggerFulfillment": { # A fulfillment can do one or more of the following actions at the same time: * Generate rich message responses. * Set parameter values. * Call the webhook. Fulfillments can be called at various stages in the Page or Form lifecycle. For example, when a DetectIntentRequest drives a session to enter a new page, the page's entry fulfillment can add a static response to the QueryResult in the returning DetectIntentResponse, call the webhook (for example, to load user data from a database), or both. # The fulfillment to be triggered. When the answers from the Knowledge Connector are selected by Dialogflow, you can utitlize the request scoped parameter `$request.knowledge.answers` (contains up to the 5 highest confidence answers) and `$request.knowledge.questions` (contains the corresponding questions) to construct the fulfillment.
+          "advancedSettings": { # Hierarchical advanced settings for agent/flow/page/fulfillment/parameter. Settings exposed at lower level overrides the settings exposed at higher level. Overriding occurs at the sub-setting level. For example, the playback_interruption_settings at fulfillment level only overrides the playback_interruption_settings at the agent level, leaving other settings at the agent level unchanged. DTMF settings does not override each other. DTMF settings set at different levels define DTMF detections running in parallel. Hierarchy: Agent->Flow->Page->Fulfillment/Parameter. # Hierarchical advanced settings for this fulfillment. The settings exposed at the lower level overrides the settings exposed at the higher level.
+            "audioExportGcsDestination": { # Google Cloud Storage location for a Dialogflow operation that writes or exports objects (e.g. exported agent or transcripts) outside of Dialogflow. # If present, incoming audio is exported by Dialogflow to the configured Google Cloud Storage destination. Exposed at the following levels: - Agent level - Flow level
+              "uri": "A String", # Required. The Google Cloud Storage URI for the exported objects. A URI is of the form: `gs://bucket/object-name-or-prefix` Whether a full object name, or just a prefix, its usage depends on the Dialogflow operation.
+            },
+            "dtmfSettings": { # Define behaviors for DTMF (dual tone multi frequency). # Settings for DTMF. Exposed at the following levels: - Agent level - Flow level - Page level - Parameter level.
+              "enabled": True or False, # If true, incoming audio is processed for DTMF (dual tone multi frequency) events. For example, if the caller presses a button on their telephone keypad and DTMF processing is enabled, Dialogflow will detect the event (e.g. a "3" was pressed) in the incoming audio and pass the event to the bot to drive business logic (e.g. when 3 is pressed, return the account balance).
+              "endpointingTimeoutDuration": "A String", # Endpoint timeout setting for matching dtmf input to regex.
+              "finishDigit": "A String", # The digit that terminates a DTMF digit sequence.
+              "interdigitTimeoutDuration": "A String", # Interdigit timeout setting for matching dtmf input to regex.
+              "maxDigits": 42, # Max length of DTMF digits.
+            },
+            "loggingSettings": { # Define behaviors on logging. # Settings for logging. Settings for Dialogflow History, Contact Center messages, StackDriver logs, and speech logging. Exposed at the following levels: - Agent level.
+              "enableInteractionLogging": True or False, # Enables DF Interaction logging.
+              "enableStackdriverLogging": True or False, # Enables StackDriver logging.
+            },
+            "speechSettings": { # Define behaviors of speech to text detection. # Settings for speech to text detection. Exposed at the following levels: - Agent level - Flow level - Page level - Parameter level
+              "endpointerSensitivity": 42, # Sensitivity of the speech model that detects the end of speech. Scale from 0 to 100.
+              "models": { # Mapping from language to Speech-to-Text model. The mapped Speech-to-Text model will be selected for requests from its corresponding language. For more information, see [Speech models](https://cloud.google.com/dialogflow/cx/docs/concept/speech-models).
+                "a_key": "A String",
+              },
+              "noSpeechTimeout": "A String", # Timeout before detecting no speech.
+              "useTimeoutBasedEndpointing": True or False, # Use timeout based endpointing, interpreting endpointer sensitivy as seconds of timeout value.
+            },
+          },
+          "conditionalCases": [ # Conditional cases for this fulfillment.
+            { # A list of cascading if-else conditions. Cases are mutually exclusive. The first one with a matching condition is selected, all the rest ignored.
+              "cases": [ # A list of cascading if-else conditions.
+                { # Each case has a Boolean condition. When it is evaluated to be True, the corresponding messages will be selected and evaluated recursively.
+                  "caseContent": [ # A list of case content.
+                    { # The list of messages or conditional cases to activate for this case.
+                      "additionalCases": # Object with schema name: GoogleCloudDialogflowCxV3beta1FulfillmentConditionalCases # Additional cases to be evaluated.
+                      "message": { # 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. # Returned message.
+                        "channel": "A String", # The channel which the response is associated with. Clients can specify the channel via QueryParameters.channel, and only associated channel response will be returned.
+                        "conversationSuccess": { # 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. # Indicates that the conversation succeeded.
+                          "metadata": { # Custom metadata. Dialogflow doesn't impose any structure on this.
+                            "a_key": "", # Properties of the object.
+                          },
+                        },
+                        "endInteraction": { # 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. # Output only. A signal that indicates the interaction with the Dialogflow agent has ended. This message is generated by Dialogflow only when the conversation reaches `END_SESSION` page. It is not supposed to be defined by the user. It's guaranteed that there is at most one such message in each response.
+                        },
+                        "knowledgeInfoCard": { # Represents info card response. If the response contains generative knowledge prediction, Dialogflow will return a payload with Infobot Messenger compatible info card. Otherwise, the info card response is skipped. # Represents info card for knowledge answers, to be better rendered in Dialogflow Messenger.
+                        },
+                        "liveAgentHandoff": { # 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. # Hands off conversation to a human agent.
+                          "metadata": { # Custom metadata for your handoff procedure. Dialogflow doesn't impose any structure on this.
+                            "a_key": "", # Properties of the object.
+                          },
+                        },
+                        "mixedAudio": { # 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. # Output only. An audio response message composed of both the synthesized Dialogflow agent responses and responses defined via play_audio. This message is generated by Dialogflow only and not supposed to be defined by the user.
+                          "segments": [ # Segments this audio response is composed of.
+                            { # Represents one segment of audio.
+                              "allowPlaybackInterruption": True or False, # 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.
+                              "audio": "A String", # Raw audio synthesized from the Dialogflow agent's response using the output config specified in the request.
+                              "uri": "A String", # Client-specific URI that points to an audio clip accessible to the client. Dialogflow does not impose any validation on it.
+                            },
+                          ],
+                        },
+                        "outputAudioText": { # A text or ssml response that is preferentially used for TTS output audio synthesis, as described in the comment on the ResponseMessage message. # A text or ssml response that is preferentially used for TTS output audio synthesis, as described in the comment on the ResponseMessage message.
+                          "allowPlaybackInterruption": True or False, # 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.
+                          "ssml": "A String", # The SSML text to be synthesized. For more information, see [SSML](/speech/text-to-speech/docs/ssml).
+                          "text": "A String", # The raw text to be synthesized.
+                        },
+                        "payload": { # Returns a response containing a custom, platform-specific payload.
+                          "a_key": "", # Properties of the object.
+                        },
+                        "playAudio": { # Specifies an audio clip to be played by the client as part of the response. # Signal that the client should play an audio clip hosted at a client-specific URI. Dialogflow uses this to construct mixed_audio. However, Dialogflow itself does not try to read or process the URI in any way.
+                          "allowPlaybackInterruption": True or False, # 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.
+                          "audioUri": "A String", # Required. URI of the audio clip. Dialogflow does not impose any validation on this value. It is specific to the client that reads it.
+                        },
+                        "telephonyTransferCall": { # Represents the signal that telles the client to transfer the phone call connected to the agent to a third-party endpoint. # A signal that the client should transfer the phone call connected to this agent to a third-party endpoint.
+                          "phoneNumber": "A String", # Transfer the call to a phone number in [E.164 format](https://en.wikipedia.org/wiki/E.164).
+                        },
+                        "text": { # The text response message. # Returns a text response.
+                          "allowPlaybackInterruption": True or False, # 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.
+                          "text": [ # Required. A collection of text responses.
+                            "A String",
+                          ],
+                        },
+                        "toolCall": { # Represents a call of a specific tool's action with the specified inputs. # Returns the definition of a tool call that should be executed by the client.
+                          "action": "A String", # Required. The name of the tool's action associated with this call.
+                          "inputParameters": { # Optional. The action's input parameters.
+                            "a_key": "", # Properties of the object.
+                          },
+                          "tool": "A String", # Required. The tool associated with this call. Format: `projects//locations//agents//tools/`.
+                        },
+                      },
+                    },
+                  ],
+                  "condition": "A String", # The condition to activate and select this case. Empty means the condition is always true. The condition is evaluated against form parameters or session parameters. See the [conditions reference](https://cloud.google.com/dialogflow/cx/docs/reference/condition).
+                },
+              ],
+            },
+          ],
+          "enableGenerativeFallback": True or False, # If the flag is true, the agent will utilize LLM to generate a text response. If LLM generation fails, the defined responses in the fulfillment will be respected. This flag is only useful for fulfillments associated with no-match event handlers.
+          "messages": [ # The list of rich message responses to present to the user.
+            { # 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.
+              "channel": "A String", # The channel which the response is associated with. Clients can specify the channel via QueryParameters.channel, and only associated channel response will be returned.
+              "conversationSuccess": { # 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. # Indicates that the conversation succeeded.
+                "metadata": { # Custom metadata. Dialogflow doesn't impose any structure on this.
+                  "a_key": "", # Properties of the object.
+                },
+              },
+              "endInteraction": { # 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. # Output only. A signal that indicates the interaction with the Dialogflow agent has ended. This message is generated by Dialogflow only when the conversation reaches `END_SESSION` page. It is not supposed to be defined by the user. It's guaranteed that there is at most one such message in each response.
+              },
+              "knowledgeInfoCard": { # Represents info card response. If the response contains generative knowledge prediction, Dialogflow will return a payload with Infobot Messenger compatible info card. Otherwise, the info card response is skipped. # Represents info card for knowledge answers, to be better rendered in Dialogflow Messenger.
+              },
+              "liveAgentHandoff": { # 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. # Hands off conversation to a human agent.
+                "metadata": { # Custom metadata for your handoff procedure. Dialogflow doesn't impose any structure on this.
+                  "a_key": "", # Properties of the object.
+                },
+              },
+              "mixedAudio": { # 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. # Output only. An audio response message composed of both the synthesized Dialogflow agent responses and responses defined via play_audio. This message is generated by Dialogflow only and not supposed to be defined by the user.
+                "segments": [ # Segments this audio response is composed of.
+                  { # Represents one segment of audio.
+                    "allowPlaybackInterruption": True or False, # 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.
+                    "audio": "A String", # Raw audio synthesized from the Dialogflow agent's response using the output config specified in the request.
+                    "uri": "A String", # Client-specific URI that points to an audio clip accessible to the client. Dialogflow does not impose any validation on it.
+                  },
+                ],
+              },
+              "outputAudioText": { # A text or ssml response that is preferentially used for TTS output audio synthesis, as described in the comment on the ResponseMessage message. # A text or ssml response that is preferentially used for TTS output audio synthesis, as described in the comment on the ResponseMessage message.
+                "allowPlaybackInterruption": True or False, # 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.
+                "ssml": "A String", # The SSML text to be synthesized. For more information, see [SSML](/speech/text-to-speech/docs/ssml).
+                "text": "A String", # The raw text to be synthesized.
+              },
+              "payload": { # Returns a response containing a custom, platform-specific payload.
+                "a_key": "", # Properties of the object.
+              },
+              "playAudio": { # Specifies an audio clip to be played by the client as part of the response. # Signal that the client should play an audio clip hosted at a client-specific URI. Dialogflow uses this to construct mixed_audio. However, Dialogflow itself does not try to read or process the URI in any way.
+                "allowPlaybackInterruption": True or False, # 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.
+                "audioUri": "A String", # Required. URI of the audio clip. Dialogflow does not impose any validation on this value. It is specific to the client that reads it.
+              },
+              "telephonyTransferCall": { # Represents the signal that telles the client to transfer the phone call connected to the agent to a third-party endpoint. # A signal that the client should transfer the phone call connected to this agent to a third-party endpoint.
+                "phoneNumber": "A String", # Transfer the call to a phone number in [E.164 format](https://en.wikipedia.org/wiki/E.164).
+              },
+              "text": { # The text response message. # Returns a text response.
+                "allowPlaybackInterruption": True or False, # 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.
+                "text": [ # Required. A collection of text responses.
+                  "A String",
+                ],
+              },
+              "toolCall": { # Represents a call of a specific tool's action with the specified inputs. # Returns the definition of a tool call that should be executed by the client.
+                "action": "A String", # Required. The name of the tool's action associated with this call.
+                "inputParameters": { # Optional. The action's input parameters.
+                  "a_key": "", # Properties of the object.
+                },
+                "tool": "A String", # Required. The tool associated with this call. Format: `projects//locations//agents//tools/`.
+              },
             },
           ],
-        },
-        "outputAudioText": { # A text or ssml response that is preferentially used for TTS output audio synthesis, as described in the comment on the ResponseMessage message. # A text or ssml response that is preferentially used for TTS output audio synthesis, as described in the comment on the ResponseMessage message.
-          "allowPlaybackInterruption": True or False, # 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.
-          "ssml": "A String", # The SSML text to be synthesized. For more information, see [SSML](/speech/text-to-speech/docs/ssml).
-          "text": "A String", # The raw text to be synthesized.
-        },
-        "payload": { # Returns a response containing a custom, platform-specific payload.
-          "a_key": "", # Properties of the object.
-        },
-        "playAudio": { # Specifies an audio clip to be played by the client as part of the response. # Signal that the client should play an audio clip hosted at a client-specific URI. Dialogflow uses this to construct mixed_audio. However, Dialogflow itself does not try to read or process the URI in any way.
-          "allowPlaybackInterruption": True or False, # 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.
-          "audioUri": "A String", # Required. URI of the audio clip. Dialogflow does not impose any validation on this value. It is specific to the client that reads it.
-        },
-        "telephonyTransferCall": { # Represents the signal that telles the client to transfer the phone call connected to the agent to a third-party endpoint. # A signal that the client should transfer the phone call connected to this agent to a third-party endpoint.
-          "phoneNumber": "A String", # Transfer the call to a phone number in [E.164 format](https://en.wikipedia.org/wiki/E.164).
-        },
-        "text": { # The text response message. # Returns a text response.
-          "allowPlaybackInterruption": True or False, # 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.
-          "text": [ # Required. A collection of text responses.
-            "A String",
-          ],
-        },
-      },
-    ],
-    "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. # The sentiment analyss result, which depends on `analyze_query_text_sentiment`, specified in the request.
-      "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).
-      "score": 3.14, # Sentiment score between -1.0 (negative sentiment) and 1.0 (positive sentiment).
-    },
-    "text": "A String", # If natural language text was provided as input, this field will contain a copy of the text.
-    "transcript": "A String", # If natural language speech audio was provided as input, this field will contain the transcript for the audio.
-    "triggerEvent": "A String", # If an event was provided as input, this field will contain the name of the event.
-    "triggerIntent": "A String", # If an intent was provided as input, this field will contain a copy of the intent identifier. Format: `projects//locations//agents//intents/`.
-    "webhookDisplayNames": [ # The list of webhook display names in the order of call sequence.
-      "A String",
-    ],
-    "webhookIds": [ # The list of webhook ids in the order of call sequence.
-      "A String",
-    ],
-    "webhookLatencies": [ # The list of webhook latencies in the order of call sequence.
-      "A String",
-    ],
-    "webhookPayloads": [ # The list of webhook payload in WebhookResponse.payload, in the order of call sequence. If some webhook call fails or doesn't return any payload, an empty `Struct` would be used instead.
-      {
-        "a_key": "", # Properties of the object.
-      },
-    ],
-    "webhookStatuses": [ # The list of webhook call status in the order of call sequence.
-      { # 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).
-        "code": 42, # The status code, which should be an enum value of google.rpc.Code.
-        "details": [ # A list of messages that carry the error details. There is a common set of message types for APIs to use.
-          {
-            "a_key": "", # Properties of the object. Contains field @type with type URL.
-          },
-        ],
-        "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.
-      },
-    ],
-    "webhookTags": [ # The list of webhook tags in the order of call sequence.
-      "A String",
-    ],
-  },
-  "responseId": "A String", # Output only. The unique identifier of the response. It can be used to locate a response in the training example set or for reporting issues.
-  "responseType": "A String", # Response type.
-}
-
- -
- fulfillIntent(session, body=None, x__xgafv=None) -
Fulfills a matched intent returned by MatchIntent. Must be called after MatchIntent, with input from MatchIntentResponse. Otherwise, the behavior is undefined.
-
-Args:
-  session: string, Required. The name of the session this query is sent to. Format: `projects//locations//agents//sessions/` or `projects//locations//agents//environments//sessions/`. If `Environment ID` is not specified, we assume default 'draft' environment. It's up to the API caller to choose an appropriate `Session ID`. It can be a random number or some type of session identifiers (preferably hashed). The length of the `Session ID` must not exceed 36 characters. For more information, see the [sessions guide](https://cloud.google.com/dialogflow/cx/docs/concept/session). (required)
-  body: object, The request body.
-    The object takes the form of:
-
-{ # Request of FulfillIntent
-  "match": { # Represents one match result of MatchIntent. # The matched intent/event to fulfill.
-    "confidence": 3.14, # The confidence of this match. 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.
-    "event": "A String", # The event that matched the query. Filled for `EVENT`, `NO_MATCH` and `NO_INPUT` match types.
-    "intent": { # An intent represents a user's intent to interact with a conversational agent. You can provide information for the Dialogflow API to use to match user input to an intent by adding training phrases (i.e., examples of user input) to your intent. # The Intent that matched the query. Some, not all fields are filled in this message, including but not limited to: `name` and `display_name`. Only filled for `INTENT` match type.
-      "description": "A String", # Human readable description for better understanding an intent like its scope, content, result etc. Maximum character limit: 140 characters.
-      "displayName": "A String", # Required. The human-readable name of the intent, unique within the agent.
-      "isFallback": True or False, # Indicates whether this is a fallback intent. Currently only default fallback intent is allowed in the agent, which is added upon agent creation. Adding training phrases to fallback intent is useful in the case of requests that are mistakenly matched, since training phrases assigned to fallback intents act as negative examples that triggers no-match event.
-      "labels": { # The key/value metadata to label an intent. Labels can contain lowercase letters, digits and the symbols '-' and '_'. International characters are allowed, including letters from unicase alphabets. Keys must start with a letter. Keys and values can be no longer than 63 characters and no more than 128 bytes. Prefix "sys-" is reserved for Dialogflow defined labels. Currently allowed Dialogflow defined labels include: * sys-head * sys-contextual The above labels do not require value. "sys-head" means the intent is a head intent. "sys-contextual" means the intent is a contextual intent.
-        "a_key": "A String",
-      },
-      "name": "A String", # The unique identifier of the intent. Required for the Intents.UpdateIntent method. Intents.CreateIntent populates the name automatically. Format: `projects//locations//agents//intents/`.
-      "parameters": [ # The collection of parameters associated with the intent.
-        { # Represents an intent parameter.
-          "entityType": "A String", # Required. The entity type of the parameter. Format: `projects/-/locations/-/agents/-/entityTypes/` for system entity types (for example, `projects/-/locations/-/agents/-/entityTypes/sys.date`), or `projects//locations//agents//entityTypes/` for developer entity types.
-          "id": "A String", # Required. The unique identifier of the parameter. This field is used by training phrases to annotate their parts.
-          "isList": True or False, # Indicates whether the parameter represents a list of values.
-          "redact": True or False, # Indicates whether the parameter content should be redacted in log. If redaction is enabled, the parameter content will be replaced by parameter name during logging. Note: the parameter content is subject to redaction if either parameter level redaction or entity type level redaction is enabled.
-        },
-      ],
-      "priority": 42, # 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.
-      "trainingPhrases": [ # The collection of training phrases the agent is trained on to identify the intent.
-        { # Represents an example that the agent is trained on to identify the intent.
-          "id": "A String", # Output only. The unique identifier of the training phrase.
-          "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 `parameter_id` field is set.
-            { # Represents a part of a training phrase.
-              "parameterId": "A String", # The parameter used to annotate this part of the training phrase. This field is required for annotated parts of the training phrase.
-              "text": "A String", # Required. The text for this part.
+          "returnPartialResponses": True or False, # Whether Dialogflow should return currently queued fulfillment response messages in streaming APIs. If a webhook is specified, it happens before Dialogflow invokes webhook. Warning: 1) This flag only affects streaming API. Responses are still queued and returned once in non-streaming API. 2) The flag can be enabled in any fulfillment but only the first 3 partial responses will be returned. You may only want to apply it to fulfillments that have slow webhooks.
+          "setParameterActions": [ # Set parameter values before executing the webhook.
+            { # Setting a parameter value.
+              "parameter": "A String", # Display name of the parameter.
+              "value": "", # The new value of the parameter. A null value clears the parameter.
             },
           ],
-          "repeatCount": 42, # Indicates how many times this example was added to the intent.
-        },
-      ],
-    },
-    "matchType": "A String", # Type of this Match.
-    "parameters": { # The collection of parameters extracted from the query. 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 then use map, otherwise, depending on the parameter value type, it could be one of string, number, boolean, null, list or map. * MapValue value: If parameter's entity type is a composite entity then use map from composite entity property names to property values, otherwise, use parameter value.
-      "a_key": "", # Properties of the object.
-    },
-    "resolvedInput": "A String", # Final text input which was matched during MatchIntent. This value can be different from original input sent in request because of spelling correction or other processing.
-  },
-  "matchIntentRequest": { # Request of MatchIntent. # Must be same as the corresponding MatchIntent request, otherwise the behavior is undefined.
-    "persistParameterChanges": True or False, # Persist session parameter changes from `query_params`.
-    "queryInput": { # Represents the query input. It can contain one of: 1. A conversational query in the form of text. 2. An intent query that specifies which intent to trigger. 3. Natural language speech audio to be processed. 4. An event to be triggered. 5. DTMF digits to invoke an intent and fill in parameter value. 6. The results of a tool executed by the client. # Required. The input specification.
-      "audio": { # Represents the natural speech audio to be processed. # The natural language speech audio to be processed.
-        "audio": "A String", # The natural language speech audio to be processed. A single request can contain up to 2 minutes of speech audio data. The transcribed text cannot contain more than 256 bytes. For non-streaming audio detect intent, both `config` and `audio` must be provided. For streaming audio detect intent, `config` must be provided in the first request and `audio` must be provided in all following requests.
-        "config": { # Instructs the speech recognizer on how to process the audio content. # Required. Instructs the speech recognizer how to process the speech audio.
-          "audioEncoding": "A String", # Required. Audio encoding of the audio content to process.
-          "bargeInConfig": { # Configuration of the barge-in behavior. Barge-in instructs the API to return a detected utterance at a proper time while the client is playing back the response audio from a previous request. When the client sees the utterance, it should stop the playback and immediately get ready for receiving the responses for the current request. The barge-in handling requires the client to start streaming audio input as soon as it starts playing back the audio from the previous response. The playback is modeled into two phases: * No barge-in phase: which goes first and during which speech detection should not be carried out. * Barge-in phase: which follows the no barge-in phase and during which the API starts speech detection and may inform the client that an utterance has been detected. Note that no-speech event is not expected in this phase. The client provides this configuration in terms of the durations of those two phases. The durations are measured in terms of the audio length from the the start of the input audio. No-speech event is a response with END_OF_UTTERANCE without any transcript following up. # Configuration of barge-in behavior during the streaming of input audio.
-            "noBargeInDuration": "A String", # Duration that is not eligible for barge-in at the beginning of the input audio.
-            "totalDuration": "A String", # Total duration for the playback at the beginning of the input audio.
-          },
-          "enableWordInfo": True or False, # Optional. If `true`, Dialogflow returns SpeechWordInfo in StreamingRecognitionResult with information about the recognized speech words, e.g. start and end time offsets. If false or unspecified, Speech doesn't return any word-level information.
-          "model": "A String", # Optional. Which Speech model to select for the given request. For more information, see [Speech models](https://cloud.google.com/dialogflow/cx/docs/concept/speech-models).
-          "modelVariant": "A String", # Optional. Which variant of the Speech model to use.
-          "optOutConformerModelMigration": True or False, # If `true`, the request will opt out for STT conformer model migration. This field will be deprecated once force migration takes place in June 2024. Please refer to [Dialogflow CX Speech model migration](https://cloud.google.com/dialogflow/cx/docs/concept/speech-model-migration).
-          "phraseHints": [ # Optional. A list of strings containing words and phrases that the speech recognizer should recognize with higher likelihood. See [the Cloud Speech documentation](https://cloud.google.com/speech-to-text/docs/basics#phrase-hints) for more details.
-            "A String",
-          ],
-          "sampleRateHertz": 42, # Sample rate (in Hertz) of the audio content sent in the query. Refer to [Cloud Speech API documentation](https://cloud.google.com/speech-to-text/docs/basics) for more details.
-          "singleUtterance": True or False, # Optional. If `false` (default), recognition does not cease until the client closes the stream. If `true`, the recognizer will detect a single spoken utterance in input audio. Recognition ceases when it detects the audio's voice has stopped or paused. In this case, once a detected intent is received, the client should close the stream and start a new request with a new stream as needed. Note: This setting is relevant only for streaming methods.
+          "tag": "A String", # The value of this field will be populated in the WebhookRequest `fulfillmentInfo.tag` field by Dialogflow when the associated webhook is called. The tag is typically used by the webhook service to identify which fulfillment is being called, but it could be used for other purposes. This field is required if `webhook` is specified.
+          "webhook": "A String", # The webhook to call. Format: `projects//locations//agents//webhooks/`.
         },
       },
-      "dtmf": { # Represents the input for dtmf event. # The DTMF event to be handled.
-        "digits": "A String", # The dtmf digits.
-        "finishDigit": "A String", # The finish digit (if any).
-      },
-      "event": { # Represents the event to trigger. # The event to be triggered.
-        "event": "A String", # Name of the event.
-      },
-      "intent": { # Represents the intent to trigger programmatically rather than as a result of natural language processing. # The intent to be triggered.
-        "intent": "A String", # Required. The unique identifier of the intent. Format: `projects//locations//agents//intents/`.
-      },
-      "languageCode": "A String", # Required. The language of the input. See [Language Support](https://cloud.google.com/dialogflow/cx/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.
-      "text": { # Represents the natural language text to be processed. # The natural language text to be processed.
-        "text": "A String", # Required. The UTF-8 encoded natural language text to be processed.
+      "multiLanguageSettings": { # Settings for multi-lingual agents. # Optional. Multi-lingual agent settings for this flow.
+        "enableMultiLanguageDetection": True or False, # Optional. Enable multi-language detection for this flow. This can be set only if agent level multi language setting is enabled.
+        "supportedResponseLanguageCodes": [ # Optional. Agent will respond in the detected language if the detected language code is in the supported resolved languages for this flow. This will be used only if multi-language training is enabled in the agent and multi-language detection is enabled in the flow. The supported languages must be a subset of the languages supported by the agent.
+          "A String",
+        ],
       },
-    },
-    "queryParams": { # Represents the parameters of a conversational query. # The parameters of this query.
-      "analyzeQueryTextSentiment": True or False, # Configures whether sentiment analysis should be performed. If not provided, sentiment analysis is not performed.
-      "channel": "A String", # The channel which this query is for. If specified, only the ResponseMessage associated with the channel will be returned. If no ResponseMessage is associated with the channel, it falls back to the ResponseMessage with unspecified channel. If unspecified, the ResponseMessage with unspecified channel will be returned.
-      "currentPage": "A String", # The unique identifier of the page to override the current page in the session. Format: `projects//locations//agents//flows//pages/`. If `current_page` is specified, the previous state of the session will be ignored by Dialogflow, including the previous page and the previous session parameters. In most cases, current_page and parameters should be configured together to direct a session to a specific state.
-      "disableWebhook": True or False, # Whether to disable webhook calls for this request.
-      "endUserMetadata": { # Optional. Information about the end-user to improve the relevance and accuracy of generative answers. This will be interpreted and used by a language model, so, for good results, the data should be self-descriptive, and in a simple structure. Example: ```json { "subscription plan": "Business Premium Plus", "devices owned": [ {"model": "Google Pixel 7"}, {"model": "Google Pixel Tablet"} ] } ```
-        "a_key": "", # Properties of the object.
+      "name": "A String", # The unique identifier of the flow. Format: `projects//locations//agents//flows/`.
+      "nluSettings": { # Settings related to NLU. # NLU related settings of the flow.
+        "classificationThreshold": 3.14, # To filter out false positive results and still get variety in matched natural language inputs for your agent, you can tune the machine learning classification threshold. If the returned score value is less than the threshold value, then a no-match event will be triggered. The score values range from 0.0 (completely uncertain) to 1.0 (completely certain). If set to 0.0, the default of 0.3 is used.
+        "modelTrainingMode": "A String", # Indicates NLU model training mode.
+        "modelType": "A String", # Indicates the type of NLU model.
       },
-      "flowVersions": [ # A list of flow versions to override for the request. Format: `projects//locations//agents//flows//versions/`. If version 1 of flow X is included in this list, the traffic of flow X will go through version 1 regardless of the version configuration in the environment. Each flow can have at most one version specified in this list.
+      "transitionRouteGroups": [ # A flow's transition route group serve two purposes: * They are responsible for matching the user's first utterances in the flow. * They are inherited by every page's transition route groups. Transition route groups defined in the page have higher priority than those defined in the flow. Format:`projects//locations//agents//flows//transitionRouteGroups/` or `projects//locations//agents//transitionRouteGroups/` for agent-level groups.
         "A String",
       ],
-      "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.
-        "latitude": 3.14, # The latitude in degrees. It must be in the range [-90.0, +90.0].
-        "longitude": 3.14, # The longitude in degrees. It must be in the range [-180.0, +180.0].
-      },
-      "parameters": { # Additional parameters to be put into session parameters. To remove a parameter from the session, clients should explicitly set the parameter value to null. You can reference the session parameters in the agent with the following format: $session.params.parameter-id. 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 then use map, otherwise, depending on the parameter value type, it could be one of string, number, boolean, null, list or map. * MapValue value: If parameter's entity type is a composite entity then use map from composite entity property names to property values, otherwise, use parameter value.
-        "a_key": "", # Properties of the object.
-      },
-      "payload": { # This field can be used to pass custom data into the webhook associated with the agent. Arbitrary JSON objects are supported. Some integrations that query a Dialogflow agent may provide additional information in the payload. In particular, for the Dialogflow Phone Gateway integration, this field has the form: ``` { "telephony": { "caller_id": "+18558363987" } } ```
-        "a_key": "", # Properties of the object.
-      },
-      "populateDataStoreConnectionSignals": True or False, # Optional. If set to true and data stores are involved in serving the request then DetectIntentResponse.query_result.data_store_connection_signals will be filled with data that can help evaluations.
-      "searchConfig": { # Search configuration for UCS search queries. # Optional. Search configuration for UCS search queries.
-        "boostSpecs": [ # Optional. Boosting configuration for the datastores.
-          { # Boost specifications for data stores.
-            "dataStores": [ # Optional. Data Stores where the boosting configuration is applied. The full names of the referenced data stores. Formats: `projects/{project}/locations/{location}/collections/{collection}/dataStores/{data_store}` `projects/{project}/locations/{location}/dataStores/{data_store}
-              "A String",
-            ],
-            "spec": [ # Optional. A list of boosting specifications.
-              { # Boost specification to boost certain documents. A copy of google.cloud.discoveryengine.v1main.BoostSpec, field documentation is available at https://cloud.google.com/generative-ai-app-builder/docs/reference/rest/v1alpha/BoostSpec
-                "conditionBoostSpecs": [ # Optional. Condition boost specifications. If a document matches multiple conditions in the specifictions, boost scores from these specifications are all applied and combined in a non-linear way. Maximum number of specifications is 20.
-                  { # Boost applies to documents which match a condition.
-                    "boost": 3.14, # Optional. Strength of the condition boost, which should be in [-1, 1]. Negative boost means demotion. Default is 0.0. Setting to 1.0 gives the document a big promotion. However, it does not necessarily mean that the boosted document will be the top result at all times, nor that other documents will be excluded. Results could still be shown even when none of them matches the condition. And results that are significantly more relevant to the search query can still trump your heavily favored but irrelevant documents. Setting to -1.0 gives the document a big demotion. However, results that are deeply relevant might still be shown. The document will have an upstream battle to get a fairly high ranking, but it is not blocked out completely. Setting to 0.0 means no boost applied. The boosting condition is ignored.
-                    "condition": "A String", # Optional. An expression which specifies a boost condition. The syntax and supported fields are the same as a filter expression. Examples: * To boost documents with document ID "doc_1" or "doc_2", and color "Red" or "Blue": * (id: ANY("doc_1", "doc_2")) AND (color: ANY("Red","Blue"))
+      "transitionRoutes": [ # A flow's transition routes serve two purposes: * They are responsible for matching the user's first utterances in the flow. * They are inherited by every page's transition routes and can support use cases such as the user saying "help" or "can I talk to a human?", which can be handled in a common way regardless of the current page. Transition routes defined in the page have higher priority than those defined in the flow. TransitionRoutes are evalauted in the following order: * TransitionRoutes with intent specified. * TransitionRoutes with only condition specified. TransitionRoutes with intent specified are inherited by pages in the flow.
+        { # A transition route specifies a intent that can be matched and/or a data condition that can be evaluated during a session. When a specified transition is matched, the following actions are taken in order: * If there is a `trigger_fulfillment` associated with the transition, it will be called. * If there is a `target_page` associated with the transition, the session will transition into the specified page. * If there is a `target_flow` associated with the transition, the session will transition into the specified flow.
+          "condition": "A String", # The condition to evaluate against form parameters or session parameters. See the [conditions reference](https://cloud.google.com/dialogflow/cx/docs/reference/condition). At least one of `intent` or `condition` must be specified. When both `intent` and `condition` are specified, the transition can only happen when both are fulfilled.
+          "description": "A String", # Optional. The description of the transition route. The maximum length is 500 characters.
+          "intent": "A String", # The unique identifier of an Intent. Format: `projects//locations//agents//intents/`. Indicates that the transition can only happen when the given intent is matched. At least one of `intent` or `condition` must be specified. When both `intent` and `condition` are specified, the transition can only happen when both are fulfilled.
+          "name": "A String", # Output only. The unique identifier of this transition route.
+          "targetFlow": "A String", # The target flow to transition to. Format: `projects//locations//agents//flows/`.
+          "targetPage": "A String", # The target page to transition to. Format: `projects//locations//agents//flows//pages/`.
+          "triggerFulfillment": { # A fulfillment can do one or more of the following actions at the same time: * Generate rich message responses. * Set parameter values. * Call the webhook. Fulfillments can be called at various stages in the Page or Form lifecycle. For example, when a DetectIntentRequest drives a session to enter a new page, the page's entry fulfillment can add a static response to the QueryResult in the returning DetectIntentResponse, call the webhook (for example, to load user data from a database), or both. # The fulfillment to call when the condition is satisfied. At least one of `trigger_fulfillment` and `target` must be specified. When both are defined, `trigger_fulfillment` is executed first.
+            "advancedSettings": { # Hierarchical advanced settings for agent/flow/page/fulfillment/parameter. Settings exposed at lower level overrides the settings exposed at higher level. Overriding occurs at the sub-setting level. For example, the playback_interruption_settings at fulfillment level only overrides the playback_interruption_settings at the agent level, leaving other settings at the agent level unchanged. DTMF settings does not override each other. DTMF settings set at different levels define DTMF detections running in parallel. Hierarchy: Agent->Flow->Page->Fulfillment/Parameter. # Hierarchical advanced settings for this fulfillment. The settings exposed at the lower level overrides the settings exposed at the higher level.
+              "audioExportGcsDestination": { # Google Cloud Storage location for a Dialogflow operation that writes or exports objects (e.g. exported agent or transcripts) outside of Dialogflow. # If present, incoming audio is exported by Dialogflow to the configured Google Cloud Storage destination. Exposed at the following levels: - Agent level - Flow level
+                "uri": "A String", # Required. The Google Cloud Storage URI for the exported objects. A URI is of the form: `gs://bucket/object-name-or-prefix` Whether a full object name, or just a prefix, its usage depends on the Dialogflow operation.
+              },
+              "dtmfSettings": { # Define behaviors for DTMF (dual tone multi frequency). # Settings for DTMF. Exposed at the following levels: - Agent level - Flow level - Page level - Parameter level.
+                "enabled": True or False, # If true, incoming audio is processed for DTMF (dual tone multi frequency) events. For example, if the caller presses a button on their telephone keypad and DTMF processing is enabled, Dialogflow will detect the event (e.g. a "3" was pressed) in the incoming audio and pass the event to the bot to drive business logic (e.g. when 3 is pressed, return the account balance).
+                "endpointingTimeoutDuration": "A String", # Endpoint timeout setting for matching dtmf input to regex.
+                "finishDigit": "A String", # The digit that terminates a DTMF digit sequence.
+                "interdigitTimeoutDuration": "A String", # Interdigit timeout setting for matching dtmf input to regex.
+                "maxDigits": 42, # Max length of DTMF digits.
+              },
+              "loggingSettings": { # Define behaviors on logging. # Settings for logging. Settings for Dialogflow History, Contact Center messages, StackDriver logs, and speech logging. Exposed at the following levels: - Agent level.
+                "enableInteractionLogging": True or False, # Enables DF Interaction logging.
+                "enableStackdriverLogging": True or False, # Enables StackDriver logging.
+              },
+              "speechSettings": { # Define behaviors of speech to text detection. # Settings for speech to text detection. Exposed at the following levels: - Agent level - Flow level - Page level - Parameter level
+                "endpointerSensitivity": 42, # Sensitivity of the speech model that detects the end of speech. Scale from 0 to 100.
+                "models": { # Mapping from language to Speech-to-Text model. The mapped Speech-to-Text model will be selected for requests from its corresponding language. For more information, see [Speech models](https://cloud.google.com/dialogflow/cx/docs/concept/speech-models).
+                  "a_key": "A String",
+                },
+                "noSpeechTimeout": "A String", # Timeout before detecting no speech.
+                "useTimeoutBasedEndpointing": True or False, # Use timeout based endpointing, interpreting endpointer sensitivy as seconds of timeout value.
+              },
+            },
+            "conditionalCases": [ # Conditional cases for this fulfillment.
+              { # A list of cascading if-else conditions. Cases are mutually exclusive. The first one with a matching condition is selected, all the rest ignored.
+                "cases": [ # A list of cascading if-else conditions.
+                  { # Each case has a Boolean condition. When it is evaluated to be True, the corresponding messages will be selected and evaluated recursively.
+                    "caseContent": [ # A list of case content.
+                      { # The list of messages or conditional cases to activate for this case.
+                        "additionalCases": # Object with schema name: GoogleCloudDialogflowCxV3beta1FulfillmentConditionalCases # Additional cases to be evaluated.
+                        "message": { # 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. # Returned message.
+                          "channel": "A String", # The channel which the response is associated with. Clients can specify the channel via QueryParameters.channel, and only associated channel response will be returned.
+                          "conversationSuccess": { # 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. # Indicates that the conversation succeeded.
+                            "metadata": { # Custom metadata. Dialogflow doesn't impose any structure on this.
+                              "a_key": "", # Properties of the object.
+                            },
+                          },
+                          "endInteraction": { # 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. # Output only. A signal that indicates the interaction with the Dialogflow agent has ended. This message is generated by Dialogflow only when the conversation reaches `END_SESSION` page. It is not supposed to be defined by the user. It's guaranteed that there is at most one such message in each response.
+                          },
+                          "knowledgeInfoCard": { # Represents info card response. If the response contains generative knowledge prediction, Dialogflow will return a payload with Infobot Messenger compatible info card. Otherwise, the info card response is skipped. # Represents info card for knowledge answers, to be better rendered in Dialogflow Messenger.
+                          },
+                          "liveAgentHandoff": { # 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. # Hands off conversation to a human agent.
+                            "metadata": { # Custom metadata for your handoff procedure. Dialogflow doesn't impose any structure on this.
+                              "a_key": "", # Properties of the object.
+                            },
+                          },
+                          "mixedAudio": { # 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. # Output only. An audio response message composed of both the synthesized Dialogflow agent responses and responses defined via play_audio. This message is generated by Dialogflow only and not supposed to be defined by the user.
+                            "segments": [ # Segments this audio response is composed of.
+                              { # Represents one segment of audio.
+                                "allowPlaybackInterruption": True or False, # 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.
+                                "audio": "A String", # Raw audio synthesized from the Dialogflow agent's response using the output config specified in the request.
+                                "uri": "A String", # Client-specific URI that points to an audio clip accessible to the client. Dialogflow does not impose any validation on it.
+                              },
+                            ],
+                          },
+                          "outputAudioText": { # A text or ssml response that is preferentially used for TTS output audio synthesis, as described in the comment on the ResponseMessage message. # A text or ssml response that is preferentially used for TTS output audio synthesis, as described in the comment on the ResponseMessage message.
+                            "allowPlaybackInterruption": True or False, # 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.
+                            "ssml": "A String", # The SSML text to be synthesized. For more information, see [SSML](/speech/text-to-speech/docs/ssml).
+                            "text": "A String", # The raw text to be synthesized.
+                          },
+                          "payload": { # Returns a response containing a custom, platform-specific payload.
+                            "a_key": "", # Properties of the object.
+                          },
+                          "playAudio": { # Specifies an audio clip to be played by the client as part of the response. # Signal that the client should play an audio clip hosted at a client-specific URI. Dialogflow uses this to construct mixed_audio. However, Dialogflow itself does not try to read or process the URI in any way.
+                            "allowPlaybackInterruption": True or False, # 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.
+                            "audioUri": "A String", # Required. URI of the audio clip. Dialogflow does not impose any validation on this value. It is specific to the client that reads it.
+                          },
+                          "telephonyTransferCall": { # Represents the signal that telles the client to transfer the phone call connected to the agent to a third-party endpoint. # A signal that the client should transfer the phone call connected to this agent to a third-party endpoint.
+                            "phoneNumber": "A String", # Transfer the call to a phone number in [E.164 format](https://en.wikipedia.org/wiki/E.164).
+                          },
+                          "text": { # The text response message. # Returns a text response.
+                            "allowPlaybackInterruption": True or False, # 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.
+                            "text": [ # Required. A collection of text responses.
+                              "A String",
+                            ],
+                          },
+                          "toolCall": { # Represents a call of a specific tool's action with the specified inputs. # Returns the definition of a tool call that should be executed by the client.
+                            "action": "A String", # Required. The name of the tool's action associated with this call.
+                            "inputParameters": { # Optional. The action's input parameters.
+                              "a_key": "", # Properties of the object.
+                            },
+                            "tool": "A String", # Required. The tool associated with this call. Format: `projects//locations//agents//tools/`.
+                          },
+                        },
+                      },
+                    ],
+                    "condition": "A String", # The condition to activate and select this case. Empty means the condition is always true. The condition is evaluated against form parameters or session parameters. See the [conditions reference](https://cloud.google.com/dialogflow/cx/docs/reference/condition).
                   },
                 ],
               },
             ],
-          },
-        ],
-        "filterSpecs": [ # Optional. Filter configuration for the datastores.
-          { # Filter specifications for data stores.
-            "dataStores": [ # Optional. Data Stores where the boosting configuration is applied. The full names of the referenced data stores. Formats: `projects/{project}/locations/{location}/collections/{collection}/dataStores/{data_store}` `projects/{project}/locations/{location}/dataStores/{data_store}
-              "A String",
+            "enableGenerativeFallback": True or False, # If the flag is true, the agent will utilize LLM to generate a text response. If LLM generation fails, the defined responses in the fulfillment will be respected. This flag is only useful for fulfillments associated with no-match event handlers.
+            "messages": [ # The list of rich message responses to present to the user.
+              { # 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.
+                "channel": "A String", # The channel which the response is associated with. Clients can specify the channel via QueryParameters.channel, and only associated channel response will be returned.
+                "conversationSuccess": { # 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. # Indicates that the conversation succeeded.
+                  "metadata": { # Custom metadata. Dialogflow doesn't impose any structure on this.
+                    "a_key": "", # Properties of the object.
+                  },
+                },
+                "endInteraction": { # 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. # Output only. A signal that indicates the interaction with the Dialogflow agent has ended. This message is generated by Dialogflow only when the conversation reaches `END_SESSION` page. It is not supposed to be defined by the user. It's guaranteed that there is at most one such message in each response.
+                },
+                "knowledgeInfoCard": { # Represents info card response. If the response contains generative knowledge prediction, Dialogflow will return a payload with Infobot Messenger compatible info card. Otherwise, the info card response is skipped. # Represents info card for knowledge answers, to be better rendered in Dialogflow Messenger.
+                },
+                "liveAgentHandoff": { # 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. # Hands off conversation to a human agent.
+                  "metadata": { # Custom metadata for your handoff procedure. Dialogflow doesn't impose any structure on this.
+                    "a_key": "", # Properties of the object.
+                  },
+                },
+                "mixedAudio": { # 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. # Output only. An audio response message composed of both the synthesized Dialogflow agent responses and responses defined via play_audio. This message is generated by Dialogflow only and not supposed to be defined by the user.
+                  "segments": [ # Segments this audio response is composed of.
+                    { # Represents one segment of audio.
+                      "allowPlaybackInterruption": True or False, # 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.
+                      "audio": "A String", # Raw audio synthesized from the Dialogflow agent's response using the output config specified in the request.
+                      "uri": "A String", # Client-specific URI that points to an audio clip accessible to the client. Dialogflow does not impose any validation on it.
+                    },
+                  ],
+                },
+                "outputAudioText": { # A text or ssml response that is preferentially used for TTS output audio synthesis, as described in the comment on the ResponseMessage message. # A text or ssml response that is preferentially used for TTS output audio synthesis, as described in the comment on the ResponseMessage message.
+                  "allowPlaybackInterruption": True or False, # 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.
+                  "ssml": "A String", # The SSML text to be synthesized. For more information, see [SSML](/speech/text-to-speech/docs/ssml).
+                  "text": "A String", # The raw text to be synthesized.
+                },
+                "payload": { # Returns a response containing a custom, platform-specific payload.
+                  "a_key": "", # Properties of the object.
+                },
+                "playAudio": { # Specifies an audio clip to be played by the client as part of the response. # Signal that the client should play an audio clip hosted at a client-specific URI. Dialogflow uses this to construct mixed_audio. However, Dialogflow itself does not try to read or process the URI in any way.
+                  "allowPlaybackInterruption": True or False, # 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.
+                  "audioUri": "A String", # Required. URI of the audio clip. Dialogflow does not impose any validation on this value. It is specific to the client that reads it.
+                },
+                "telephonyTransferCall": { # Represents the signal that telles the client to transfer the phone call connected to the agent to a third-party endpoint. # A signal that the client should transfer the phone call connected to this agent to a third-party endpoint.
+                  "phoneNumber": "A String", # Transfer the call to a phone number in [E.164 format](https://en.wikipedia.org/wiki/E.164).
+                },
+                "text": { # The text response message. # Returns a text response.
+                  "allowPlaybackInterruption": True or False, # 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.
+                  "text": [ # Required. A collection of text responses.
+                    "A String",
+                  ],
+                },
+                "toolCall": { # Represents a call of a specific tool's action with the specified inputs. # Returns the definition of a tool call that should be executed by the client.
+                  "action": "A String", # Required. The name of the tool's action associated with this call.
+                  "inputParameters": { # Optional. The action's input parameters.
+                    "a_key": "", # Properties of the object.
+                  },
+                  "tool": "A String", # Required. The tool associated with this call. Format: `projects//locations//agents//tools/`.
+                },
+              },
             ],
-            "filter": "A String", # Optional. The filter expression to be applied. Expression syntax is documented at https://cloud.google.com/generative-ai-app-builder/docs/filter-search-metadata#filter-expression-syntax
+            "returnPartialResponses": True or False, # Whether Dialogflow should return currently queued fulfillment response messages in streaming APIs. If a webhook is specified, it happens before Dialogflow invokes webhook. Warning: 1) This flag only affects streaming API. Responses are still queued and returned once in non-streaming API. 2) The flag can be enabled in any fulfillment but only the first 3 partial responses will be returned. You may only want to apply it to fulfillments that have slow webhooks.
+            "setParameterActions": [ # Set parameter values before executing the webhook.
+              { # Setting a parameter value.
+                "parameter": "A String", # Display name of the parameter.
+                "value": "", # The new value of the parameter. A null value clears the parameter.
+              },
+            ],
+            "tag": "A String", # The value of this field will be populated in the WebhookRequest `fulfillmentInfo.tag` field by Dialogflow when the associated webhook is called. The tag is typically used by the webhook service to identify which fulfillment is being called, but it could be used for other purposes. This field is required if `webhook` is specified.
+            "webhook": "A String", # The webhook to call. Format: `projects//locations//agents//webhooks/`.
           },
-        ],
-      },
-      "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.
-        { # Session entity types are referred to as **User** entity types and are entities that are built for an individual user such as favorites, preferences, playlists, and so on. You can redefine a session entity type at the session level to extend or replace a custom entity type at the user session level (we refer to the entity types defined at the agent level as "custom entity types"). Note: session entity types apply to all queries, regardless of the language. For more information about entity types, see the [Dialogflow documentation](https://cloud.google.com/dialogflow/docs/entities-overview).
-          "entities": [ # Required. The collection of entities to override or supplement the custom entity type.
-            { # An **entity entry** for an associated entity type.
-              "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`.
-                "A String",
-              ],
-              "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 canonical 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).
-            },
-          ],
-          "entityOverrideMode": "A String", # Required. Indicates whether the additional data should override or supplement the custom entity type definition.
-          "name": "A String", # Required. The unique identifier of the session entity type. Format: `projects//locations//agents//sessions//entityTypes/` or `projects//locations//agents//environments//sessions//entityTypes/`. If `Environment ID` is not specified, we assume default 'draft' environment.
         },
       ],
-      "sessionTtl": "A String", # Optional. Configure lifetime of the Dialogflow session. By default, a Dialogflow session remains active and its data is stored for 30 minutes after the last request is sent for the session. This value should be no longer than 1 day.
-      "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 the agent is used.
-      "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 Dialogflow web console. The headers defined within this field will overwrite the headers configured through 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.
-        "a_key": "A String",
-      },
-    },
-  },
-  "outputAudioConfig": { # Instructs the speech synthesizer how to generate the output audio content. # Instructs the speech synthesizer how to generate output audio.
-    "audioEncoding": "A String", # Required. Audio encoding of the synthesized audio content.
-    "sampleRateHertz": 42, # Optional. 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).
-    "synthesizeSpeechConfig": { # Configuration of how speech should be synthesized. # Optional. Configuration of how speech should be synthesized. If not specified, Agent.text_to_speech_settings is applied.
-      "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.
-        "A String",
-      ],
-      "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.
-      "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.
-      "voice": { # Description of which voice to use for speech synthesis. # Optional. The desired voice of the synthesized audio.
-        "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. For the list of available voices, please refer to [Supported voices and languages](https://cloud.google.com/text-to-speech/docs/voices).
-        "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.
-      },
-      "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.
-    },
-  },
-}
-
-  x__xgafv: string, V1 error format.
-    Allowed values
-      1 - v1 error format
-      2 - v2 error format
-
-Returns:
-  An object of the form:
-
-    { # Response of FulfillIntent
-  "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.response_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.
-  "outputAudioConfig": { # Instructs the speech synthesizer how to generate the output audio content. # The config used by the speech synthesizer to generate the output audio.
-    "audioEncoding": "A String", # Required. Audio encoding of the synthesized audio content.
-    "sampleRateHertz": 42, # Optional. 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).
-    "synthesizeSpeechConfig": { # Configuration of how speech should be synthesized. # Optional. Configuration of how speech should be synthesized. If not specified, Agent.text_to_speech_settings is applied.
-      "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.
-        "A String",
-      ],
-      "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.
-      "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.
-      "voice": { # Description of which voice to use for speech synthesis. # Optional. The desired voice of the synthesized audio.
-        "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. For the list of available voices, please refer to [Supported voices and languages](https://cloud.google.com/text-to-speech/docs/voices).
-        "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.
-      },
-      "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.
-    },
-  },
-  "queryResult": { # Represents the result of a conversational query. # The result of the conversational query.
-    "advancedSettings": { # Hierarchical advanced settings for agent/flow/page/fulfillment/parameter. Settings exposed at lower level overrides the settings exposed at higher level. Overriding occurs at the sub-setting level. For example, the playback_interruption_settings at fulfillment level only overrides the playback_interruption_settings at the agent level, leaving other settings at the agent level unchanged. DTMF settings does not override each other. DTMF settings set at different levels define DTMF detections running in parallel. Hierarchy: Agent->Flow->Page->Fulfillment/Parameter. # Returns the current advanced settings including IVR settings. Even though the operations configured by these settings are performed by Dialogflow, the client may need to perform special logic at the moment. For example, if Dialogflow exports audio to Google Cloud Storage, then the client may need to wait for the resulting object to appear in the bucket before proceeding.
-      "audioExportGcsDestination": { # Google Cloud Storage location for a Dialogflow operation that writes or exports objects (e.g. exported agent or transcripts) outside of Dialogflow. # If present, incoming audio is exported by Dialogflow to the configured Google Cloud Storage destination. Exposed at the following levels: - Agent level - Flow level
-        "uri": "A String", # Required. The Google Cloud Storage URI for the exported objects. A URI is of the form: `gs://bucket/object-name-or-prefix` Whether a full object name, or just a prefix, its usage depends on the Dialogflow operation.
-      },
-      "dtmfSettings": { # Define behaviors for DTMF (dual tone multi frequency). # Settings for DTMF. Exposed at the following levels: - Agent level - Flow level - Page level - Parameter level.
-        "enabled": True or False, # If true, incoming audio is processed for DTMF (dual tone multi frequency) events. For example, if the caller presses a button on their telephone keypad and DTMF processing is enabled, Dialogflow will detect the event (e.g. a "3" was pressed) in the incoming audio and pass the event to the bot to drive business logic (e.g. when 3 is pressed, return the account balance).
-        "endpointingTimeoutDuration": "A String", # Endpoint timeout setting for matching dtmf input to regex.
-        "finishDigit": "A String", # The digit that terminates a DTMF digit sequence.
-        "interdigitTimeoutDuration": "A String", # Interdigit timeout setting for matching dtmf input to regex.
-        "maxDigits": 42, # Max length of DTMF digits.
-      },
-      "loggingSettings": { # Define behaviors on logging. # Settings for logging. Settings for Dialogflow History, Contact Center messages, StackDriver logs, and speech logging. Exposed at the following levels: - Agent level.
-        "enableInteractionLogging": True or False, # If true, DF Interaction logging is currently enabled.
-        "enableStackdriverLogging": True or False, # If true, StackDriver logging is currently enabled.
-      },
-      "speechSettings": { # Define behaviors of speech to text detection. # Settings for speech to text detection. Exposed at the following levels: - Agent level - Flow level - Page level - Parameter level
-        "endpointerSensitivity": 42, # Sensitivity of the speech model that detects the end of speech. Scale from 0 to 100.
-        "models": { # Mapping from language to Speech-to-Text model. The mapped Speech-to-Text model will be selected for requests from its corresponding language. For more information, see [Speech models](https://cloud.google.com/dialogflow/cx/docs/concept/speech-models).
-          "a_key": "A String",
-        },
-        "noSpeechTimeout": "A String", # Timeout before detecting no speech.
-        "useTimeoutBasedEndpointing": True or False, # Use timeout based endpointing, interpreting endpointer sensitivy as seconds of timeout value.
-      },
     },
-    "allowAnswerFeedback": True or False, # Indicates whether the Thumbs up/Thumbs down rating controls are need to be shown for the response in the Dialogflow Messenger widget.
     "currentPage": { # A Dialogflow CX conversation (session) can be described and visualized as a state machine. The states of a CX session are represented by pages. For each flow, you define many pages, where your combined pages can handle a complete conversation on the topics the flow is designed for. At any given moment, exactly one page is the current page, the current page is considered active, and the flow associated with that page is considered active. Every flow has a special start page. When a flow initially becomes active, the start page page becomes the current page. For each conversational turn, the current page will either stay the same or transition to another page. You configure each page to collect information from the end-user that is relevant for the conversational state represented by the page. For more information, see the [Page guide](https://cloud.google.com/dialogflow/cx/docs/concept/page). # The current Page. Some, not all fields are filled in this message, including but not limited to `name` and `display_name`.
       "advancedSettings": { # Hierarchical advanced settings for agent/flow/page/fulfillment/parameter. Settings exposed at lower level overrides the settings exposed at higher level. Overriding occurs at the sub-setting level. For example, the playback_interruption_settings at fulfillment level only overrides the playback_interruption_settings at the agent level, leaving other settings at the agent level unchanged. DTMF settings does not override each other. DTMF settings set at different levels define DTMF detections running in parallel. Hierarchy: Agent->Flow->Page->Fulfillment/Parameter. # Hierarchical advanced settings for this page. The settings exposed at the lower level overrides the settings exposed at the higher level.
         "audioExportGcsDestination": { # Google Cloud Storage location for a Dialogflow operation that writes or exports objects (e.g. exported agent or transcripts) outside of Dialogflow. # If present, incoming audio is exported by Dialogflow to the configured Google Cloud Storage destination. Exposed at the following levels: - Agent level - Flow level
@@ -1726,8 +3024,8 @@ 

Method Details

"maxDigits": 42, # Max length of DTMF digits. }, "loggingSettings": { # Define behaviors on logging. # Settings for logging. Settings for Dialogflow History, Contact Center messages, StackDriver logs, and speech logging. Exposed at the following levels: - Agent level. - "enableInteractionLogging": True or False, # If true, DF Interaction logging is currently enabled. - "enableStackdriverLogging": True or False, # If true, StackDriver logging is currently enabled. + "enableInteractionLogging": True or False, # Enables DF Interaction logging. + "enableStackdriverLogging": True or False, # Enables StackDriver logging. }, "speechSettings": { # Define behaviors of speech to text detection. # Settings for speech to text detection. Exposed at the following levels: - Agent level - Flow level - Page level - Parameter level "endpointerSensitivity": 42, # Sensitivity of the speech model that detects the end of speech. Scale from 0 to 100. @@ -1753,8 +3051,8 @@

Method Details

"maxDigits": 42, # Max length of DTMF digits. }, "loggingSettings": { # Define behaviors on logging. # Settings for logging. Settings for Dialogflow History, Contact Center messages, StackDriver logs, and speech logging. Exposed at the following levels: - Agent level. - "enableInteractionLogging": True or False, # If true, DF Interaction logging is currently enabled. - "enableStackdriverLogging": True or False, # If true, StackDriver logging is currently enabled. + "enableInteractionLogging": True or False, # Enables DF Interaction logging. + "enableStackdriverLogging": True or False, # Enables StackDriver logging. }, "speechSettings": { # Define behaviors of speech to text detection. # Settings for speech to text detection. Exposed at the following levels: - Agent level - Flow level - Page level - Parameter level "endpointerSensitivity": 42, # Sensitivity of the speech model that detects the end of speech. Scale from 0 to 100. @@ -1818,6 +3116,13 @@

Method Details

"A String", ], }, + "toolCall": { # Represents a call of a specific tool's action with the specified inputs. # Returns the definition of a tool call that should be executed by the client. + "action": "A String", # Required. The name of the tool's action associated with this call. + "inputParameters": { # Optional. The action's input parameters. + "a_key": "", # Properties of the object. + }, + "tool": "A String", # Required. The tool associated with this call. Format: `projects//locations//agents//tools/`. + }, }, }, ], @@ -1874,6 +3179,13 @@

Method Details

"A String", ], }, + "toolCall": { # Represents a call of a specific tool's action with the specified inputs. # Returns the definition of a tool call that should be executed by the client. + "action": "A String", # Required. The name of the tool's action associated with this call. + "inputParameters": { # Optional. The action's input parameters. + "a_key": "", # Properties of the object. + }, + "tool": "A String", # Required. The tool associated with this call. Format: `projects//locations//agents//tools/`. + }, }, ], "returnPartialResponses": True or False, # Whether Dialogflow should return currently queued fulfillment response messages in streaming APIs. If a webhook is specified, it happens before Dialogflow invokes webhook. Warning: 1) This flag only affects streaming API. Responses are still queued and returned once in non-streaming API. 2) The flag can be enabled in any fulfillment but only the first 3 partial responses will be returned. You may only want to apply it to fulfillments that have slow webhooks. @@ -1905,8 +3217,8 @@

Method Details

"maxDigits": 42, # Max length of DTMF digits. }, "loggingSettings": { # Define behaviors on logging. # Settings for logging. Settings for Dialogflow History, Contact Center messages, StackDriver logs, and speech logging. Exposed at the following levels: - Agent level. - "enableInteractionLogging": True or False, # If true, DF Interaction logging is currently enabled. - "enableStackdriverLogging": True or False, # If true, StackDriver logging is currently enabled. + "enableInteractionLogging": True or False, # Enables DF Interaction logging. + "enableStackdriverLogging": True or False, # Enables StackDriver logging. }, "speechSettings": { # Define behaviors of speech to text detection. # Settings for speech to text detection. Exposed at the following levels: - Agent level - Flow level - Page level - Parameter level "endpointerSensitivity": 42, # Sensitivity of the speech model that detects the end of speech. Scale from 0 to 100. @@ -1970,6 +3282,13 @@

Method Details

"A String", ], }, + "toolCall": { # Represents a call of a specific tool's action with the specified inputs. # Returns the definition of a tool call that should be executed by the client. + "action": "A String", # Required. The name of the tool's action associated with this call. + "inputParameters": { # Optional. The action's input parameters. + "a_key": "", # Properties of the object. + }, + "tool": "A String", # Required. The tool associated with this call. Format: `projects//locations//agents//tools/`. + }, }, }, ], @@ -2026,6 +3345,13 @@

Method Details

"A String", ], }, + "toolCall": { # Represents a call of a specific tool's action with the specified inputs. # Returns the definition of a tool call that should be executed by the client. + "action": "A String", # Required. The name of the tool's action associated with this call. + "inputParameters": { # Optional. The action's input parameters. + "a_key": "", # Properties of the object. + }, + "tool": "A String", # Required. The tool associated with this call. Format: `projects//locations//agents//tools/`. + }, }, ], "returnPartialResponses": True or False, # Whether Dialogflow should return currently queued fulfillment response messages in streaming APIs. If a webhook is specified, it happens before Dialogflow invokes webhook. Warning: 1) This flag only affects streaming API. Responses are still queued and returned once in non-streaming API. 2) The flag can be enabled in any fulfillment but only the first 3 partial responses will be returned. You may only want to apply it to fulfillments that have slow webhooks. @@ -2055,8 +3381,8 @@

Method Details

"maxDigits": 42, # Max length of DTMF digits. }, "loggingSettings": { # Define behaviors on logging. # Settings for logging. Settings for Dialogflow History, Contact Center messages, StackDriver logs, and speech logging. Exposed at the following levels: - Agent level. - "enableInteractionLogging": True or False, # If true, DF Interaction logging is currently enabled. - "enableStackdriverLogging": True or False, # If true, StackDriver logging is currently enabled. + "enableInteractionLogging": True or False, # Enables DF Interaction logging. + "enableStackdriverLogging": True or False, # Enables StackDriver logging. }, "speechSettings": { # Define behaviors of speech to text detection. # Settings for speech to text detection. Exposed at the following levels: - Agent level - Flow level - Page level - Parameter level "endpointerSensitivity": 42, # Sensitivity of the speech model that detects the end of speech. Scale from 0 to 100. @@ -2084,8 +3410,8 @@

Method Details

"maxDigits": 42, # Max length of DTMF digits. }, "loggingSettings": { # Define behaviors on logging. # Settings for logging. Settings for Dialogflow History, Contact Center messages, StackDriver logs, and speech logging. Exposed at the following levels: - Agent level. - "enableInteractionLogging": True or False, # If true, DF Interaction logging is currently enabled. - "enableStackdriverLogging": True or False, # If true, StackDriver logging is currently enabled. + "enableInteractionLogging": True or False, # Enables DF Interaction logging. + "enableStackdriverLogging": True or False, # Enables StackDriver logging. }, "speechSettings": { # Define behaviors of speech to text detection. # Settings for speech to text detection. Exposed at the following levels: - Agent level - Flow level - Page level - Parameter level "endpointerSensitivity": 42, # Sensitivity of the speech model that detects the end of speech. Scale from 0 to 100. @@ -2149,6 +3475,13 @@

Method Details

"A String", ], }, + "toolCall": { # Represents a call of a specific tool's action with the specified inputs. # Returns the definition of a tool call that should be executed by the client. + "action": "A String", # Required. The name of the tool's action associated with this call. + "inputParameters": { # Optional. The action's input parameters. + "a_key": "", # Properties of the object. + }, + "tool": "A String", # Required. The tool associated with this call. Format: `projects//locations//agents//tools/`. + }, }, }, ], @@ -2205,6 +3538,13 @@

Method Details

"A String", ], }, + "toolCall": { # Represents a call of a specific tool's action with the specified inputs. # Returns the definition of a tool call that should be executed by the client. + "action": "A String", # Required. The name of the tool's action associated with this call. + "inputParameters": { # Optional. The action's input parameters. + "a_key": "", # Properties of the object. + }, + "tool": "A String", # Required. The tool associated with this call. Format: `projects//locations//agents//tools/`. + }, }, ], "returnPartialResponses": True or False, # Whether Dialogflow should return currently queued fulfillment response messages in streaming APIs. If a webhook is specified, it happens before Dialogflow invokes webhook. Warning: 1) This flag only affects streaming API. Responses are still queued and returned once in non-streaming API. 2) The flag can be enabled in any fulfillment but only the first 3 partial responses will be returned. You may only want to apply it to fulfillments that have slow webhooks. @@ -2236,8 +3576,8 @@

Method Details

"maxDigits": 42, # Max length of DTMF digits. }, "loggingSettings": { # Define behaviors on logging. # Settings for logging. Settings for Dialogflow History, Contact Center messages, StackDriver logs, and speech logging. Exposed at the following levels: - Agent level. - "enableInteractionLogging": True or False, # If true, DF Interaction logging is currently enabled. - "enableStackdriverLogging": True or False, # If true, StackDriver logging is currently enabled. + "enableInteractionLogging": True or False, # Enables DF Interaction logging. + "enableStackdriverLogging": True or False, # Enables StackDriver logging. }, "speechSettings": { # Define behaviors of speech to text detection. # Settings for speech to text detection. Exposed at the following levels: - Agent level - Flow level - Page level - Parameter level "endpointerSensitivity": 42, # Sensitivity of the speech model that detects the end of speech. Scale from 0 to 100. @@ -2301,6 +3641,13 @@

Method Details

"A String", ], }, + "toolCall": { # Represents a call of a specific tool's action with the specified inputs. # Returns the definition of a tool call that should be executed by the client. + "action": "A String", # Required. The name of the tool's action associated with this call. + "inputParameters": { # Optional. The action's input parameters. + "a_key": "", # Properties of the object. + }, + "tool": "A String", # Required. The tool associated with this call. Format: `projects//locations//agents//tools/`. + }, }, }, ], @@ -2357,6 +3704,13 @@

Method Details

"A String", ], }, + "toolCall": { # Represents a call of a specific tool's action with the specified inputs. # Returns the definition of a tool call that should be executed by the client. + "action": "A String", # Required. The name of the tool's action associated with this call. + "inputParameters": { # Optional. The action's input parameters. + "a_key": "", # Properties of the object. + }, + "tool": "A String", # Required. The tool associated with this call. Format: `projects//locations//agents//tools/`. + }, }, ], "returnPartialResponses": True or False, # Whether Dialogflow should return currently queued fulfillment response messages in streaming APIs. If a webhook is specified, it happens before Dialogflow invokes webhook. Warning: 1) This flag only affects streaming API. Responses are still queued and returned once in non-streaming API. 2) The flag can be enabled in any fulfillment but only the first 3 partial responses will be returned. You may only want to apply it to fulfillments that have slow webhooks. @@ -2401,8 +3755,8 @@

Method Details

"maxDigits": 42, # Max length of DTMF digits. }, "loggingSettings": { # Define behaviors on logging. # Settings for logging. Settings for Dialogflow History, Contact Center messages, StackDriver logs, and speech logging. Exposed at the following levels: - Agent level. - "enableInteractionLogging": True or False, # If true, DF Interaction logging is currently enabled. - "enableStackdriverLogging": True or False, # If true, StackDriver logging is currently enabled. + "enableInteractionLogging": True or False, # Enables DF Interaction logging. + "enableStackdriverLogging": True or False, # Enables StackDriver logging. }, "speechSettings": { # Define behaviors of speech to text detection. # Settings for speech to text detection. Exposed at the following levels: - Agent level - Flow level - Page level - Parameter level "endpointerSensitivity": 42, # Sensitivity of the speech model that detects the end of speech. Scale from 0 to 100. @@ -2466,6 +3820,13 @@

Method Details

"A String", ], }, + "toolCall": { # Represents a call of a specific tool's action with the specified inputs. # Returns the definition of a tool call that should be executed by the client. + "action": "A String", # Required. The name of the tool's action associated with this call. + "inputParameters": { # Optional. The action's input parameters. + "a_key": "", # Properties of the object. + }, + "tool": "A String", # Required. The tool associated with this call. Format: `projects//locations//agents//tools/`. + }, }, }, ], @@ -2522,6 +3883,13 @@

Method Details

"A String", ], }, + "toolCall": { # Represents a call of a specific tool's action with the specified inputs. # Returns the definition of a tool call that should be executed by the client. + "action": "A String", # Required. The name of the tool's action associated with this call. + "inputParameters": { # Optional. The action's input parameters. + "a_key": "", # Properties of the object. + }, + "tool": "A String", # Required. The tool associated with this call. Format: `projects//locations//agents//tools/`. + }, }, ], "returnPartialResponses": True or False, # Whether Dialogflow should return currently queued fulfillment response messages in streaming APIs. If a webhook is specified, it happens before Dialogflow invokes webhook. Warning: 1) This flag only affects streaming API. Responses are still queued and returned once in non-streaming API. 2) The flag can be enabled in any fulfillment but only the first 3 partial responses will be returned. You may only want to apply it to fulfillments that have slow webhooks. @@ -2560,8 +3928,8 @@

Method Details

"maxDigits": 42, # Max length of DTMF digits. }, "loggingSettings": { # Define behaviors on logging. # Settings for logging. Settings for Dialogflow History, Contact Center messages, StackDriver logs, and speech logging. Exposed at the following levels: - Agent level. - "enableInteractionLogging": True or False, # If true, DF Interaction logging is currently enabled. - "enableStackdriverLogging": True or False, # If true, StackDriver logging is currently enabled. + "enableInteractionLogging": True or False, # Enables DF Interaction logging. + "enableStackdriverLogging": True or False, # Enables StackDriver logging. }, "speechSettings": { # Define behaviors of speech to text detection. # Settings for speech to text detection. Exposed at the following levels: - Agent level - Flow level - Page level - Parameter level "endpointerSensitivity": 42, # Sensitivity of the speech model that detects the end of speech. Scale from 0 to 100. @@ -2625,6 +3993,13 @@

Method Details

"A String", ], }, + "toolCall": { # Represents a call of a specific tool's action with the specified inputs. # Returns the definition of a tool call that should be executed by the client. + "action": "A String", # Required. The name of the tool's action associated with this call. + "inputParameters": { # Optional. The action's input parameters. + "a_key": "", # Properties of the object. + }, + "tool": "A String", # Required. The tool associated with this call. Format: `projects//locations//agents//tools/`. + }, }, }, ], @@ -2681,6 +4056,13 @@

Method Details

"A String", ], }, + "toolCall": { # Represents a call of a specific tool's action with the specified inputs. # Returns the definition of a tool call that should be executed by the client. + "action": "A String", # Required. The name of the tool's action associated with this call. + "inputParameters": { # Optional. The action's input parameters. + "a_key": "", # Properties of the object. + }, + "tool": "A String", # Required. The tool associated with this call. Format: `projects//locations//agents//tools/`. + }, }, ], "returnPartialResponses": True or False, # Whether Dialogflow should return currently queued fulfillment response messages in streaming APIs. If a webhook is specified, it happens before Dialogflow invokes webhook. Warning: 1) This flag only affects streaming API. Responses are still queued and returned once in non-streaming API. 2) The flag can be enabled in any fulfillment but only the first 3 partial responses will be returned. You may only want to apply it to fulfillments that have slow webhooks. @@ -2742,13 +4124,86 @@

Method Details

}, ], }, - "diagnosticInfo": { # The free-form diagnostic info. For example, this field could contain webhook call latency. The fields of this data can change without notice, so you should not write code that depends on its structure. One of the fields is called "Alternative Matched Intents", which may aid with debugging. The following describes these intent results: - The list is empty if no intent was matched to end-user input. - Only intents that are referenced in the currently active flow are included. - The matched intent is included. - Other intents that could have matched end-user input, but did not match because they are referenced by intent routes that are out of [scope](https://cloud.google.com/dialogflow/cx/docs/concept/handler#scope), are included. - Other intents referenced by intent routes in scope that matched end-user input, but had a lower confidence score. - "a_key": "", # Properties of the object. - }, - "dtmf": { # Represents the input for dtmf event. # If a DTMF was provided as input, this field will contain a copy of the DtmfInput. - "digits": "A String", # The dtmf digits. - "finishDigit": "A String", # The finish digit (if any). - }, + "diagnosticInfo": { # The free-form diagnostic info. For example, this field could contain webhook call latency. The fields of this data can change without notice, so you should not write code that depends on its structure. One of the fields is called "Alternative Matched Intents", which may aid with debugging. The following describes these intent results: - The list is empty if no intent was matched to end-user input. - Only intents that are referenced in the currently active flow are included. - The matched intent is included. - Other intents that could have matched end-user input, but did not match because they are referenced by intent routes that are out of [scope](https://cloud.google.com/dialogflow/cx/docs/concept/handler#scope), are included. - Other intents referenced by intent routes in scope that matched end-user input, but had a lower confidence score. + "a_key": "", # Properties of the object. + }, + "dtmf": { # Represents the input for dtmf event. # If a DTMF was provided as input, this field will contain a copy of the DtmfInput. + "digits": "A String", # The dtmf digits. + "finishDigit": "A String", # The finish digit (if any). + }, + "generativeInfo": { # Represents the information of a query if handled by generative agent resources. # The information of a query if handled by generative agent resources. + "actionTracingInfo": { # Example represents a sample execution of the playbook in the conversation. An example consists of a list of ordered actions performed by end user or Dialogflow agent according the playbook instructions to fulfill the task. # The actions performed by the generative playbook for the current agent response. + "actions": [ # Required. The ordered list of actions performed by the end user and the Dialogflow agent. + { # Action performed by end user or Dialogflow agent in the conversation. + "agentUtterance": { # AgentUtterance represents one message sent by the agent. # Optional. Action performed by the agent as a message. + "text": "A String", # Required. Message content in text. + }, + "flowInvocation": { # Stores metadata of the invocation of a CX flow. Next Id: 7 # Optional. Action performed on behalf of the agent by invoking a CX flow. + "flow": "A String", # Required. The unique identifier of the flow. Format: `projects//locations//agents/`. + "flowState": "A String", # Required. Flow invocation's output state. + "inputActionParameters": { # Optional. A list of input parameters for the flow. + "a_key": "", # Properties of the object. + }, + "outputActionParameters": { # Optional. A list of output parameters generated by the flow invocation. + "a_key": "", # Properties of the object. + }, + }, + "playbookInvocation": { # Stores metadata of the invocation of a child playbook. Next Id: 5 # Optional. Action performed on behalf of the agent by invoking a child playbook. + "playbook": "A String", # Required. The unique identifier of the playbook. Format: `projects//locations//agents//playbooks/`. + "playbookInput": { # Input of the playbook. # Optional. Input of the child playbook invocation. + "actionParameters": { # Optional. A list of input parameters for the action. + "a_key": "", # Properties of the object. + }, + "precedingConversationSummary": "A String", # Optional. Summary string of the preceding conversation for the child playbook invocation. + }, + "playbookOutput": { # Output of the playbook. # Optional. Output of the child playbook invocation. + "actionParameters": { # Optional. A Struct object of output parameters for the action. + "a_key": "", # Properties of the object. + }, + "executionSummary": "A String", # Optional. Summary string of the execution result of the child playbook. + }, + "playbookState": "A String", # Required. Playbook invocation's output state. + }, + "toolUse": { # Stores metadata of the invocation of an action supported by a tool. # Optional. Action performed on behalf of the agent by calling a plugin tool. + "action": "A String", # Optional. Name of the action to be called during the tool use. + "inputActionParameters": { # Optional. A list of input parameters for the action. + "a_key": "", # Properties of the object. + }, + "outputActionParameters": { # Optional. A list of output parameters generated by the action. + "a_key": "", # Properties of the object. + }, + "tool": "A String", # Required. The tool that should be used. Format: `projects//locations//agents//tools/`. + }, + "userUtterance": { # UserUtterance represents one message sent by the customer. # Optional. Agent obtained a message from the customer. + "text": "A String", # Required. Message content in text. + }, + }, + ], + "conversationState": "A String", # Required. Example's output state. + "createTime": "A String", # Output only. The timestamp of initial example creation. + "description": "A String", # Optional. The high level concise description of the example. The max number of characters is 200. + "displayName": "A String", # Required. The display name of the example. + "languageCode": "A String", # Optional. The language code of the example. If not specified, the agent's default language is used. Note: languages must be enabled in the agent before they can be used. + "name": "A String", # The unique identifier of the playbook example. Format: `projects//locations//agents//playbooks//examples/`. + "playbookInput": { # Input of the playbook. # Optional. The input to the playbook in the example. + "actionParameters": { # Optional. A list of input parameters for the action. + "a_key": "", # Properties of the object. + }, + "precedingConversationSummary": "A String", # Optional. Summary string of the preceding conversation for the child playbook invocation. + }, + "playbookOutput": { # Output of the playbook. # Optional. The output of the playbook in the example. + "actionParameters": { # Optional. A Struct object of output parameters for the action. + "a_key": "", # Properties of the object. + }, + "executionSummary": "A String", # Optional. Summary string of the execution result of the child playbook. + }, + "tokenCount": "A String", # Output only. Estimated number of tokes current example takes when sent to the LLM. + "updateTime": "A String", # Output only. Last time the example was updated. + }, + "currentPlaybooks": [ # The stack of playbooks that the conversation has currently entered, with the most recent one on the top. + "A String", + ], + }, "intent": { # An intent represents a user's intent to interact with a conversational agent. You can provide information for the Dialogflow API to use to match user input to an intent by adding training phrases (i.e., examples of user input) to your intent. # The Intent that matched the conversational query. Some, not all fields are filled in this message, including but not limited to: `name` and `display_name`. This field is deprecated, please use QueryResult.match instead. "description": "A String", # Human readable description for better understanding an intent like its scope, content, result etc. Maximum character limit: 140 characters. "displayName": "A String", # Required. The human-readable name of the intent, unique within the agent. @@ -2870,6 +4325,13 @@

Method Details

"A String", ], }, + "toolCall": { # Represents a call of a specific tool's action with the specified inputs. # Returns the definition of a tool call that should be executed by the client. + "action": "A String", # Required. The name of the tool's action associated with this call. + "inputParameters": { # Optional. The action's input parameters. + "a_key": "", # Properties of the object. + }, + "tool": "A String", # Required. The tool associated with this call. Format: `projects//locations//agents//tools/`. + }, }, ], "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. # The sentiment analyss result, which depends on `analyze_query_text_sentiment`, specified in the request. @@ -2958,11 +4420,22 @@

Method Details

"text": { # Represents the natural language text to be processed. # The natural language text to be processed. "text": "A String", # Required. The UTF-8 encoded natural language text to be processed. }, + "toolCallResult": { # The result of calling a tool's action that has been executed by the client. # The results of a tool executed by the client. + "action": "A String", # Required. The name of the tool's action associated with this call. + "error": { # An error produced by the tool call. # The tool call's error. + "message": "A String", # Optional. The error message of the function. + }, + "outputParameters": { # The tool call's output parameters. + "a_key": "", # Properties of the object. + }, + "tool": "A String", # Required. The tool associated with this call. Format: `projects//locations//agents//tools/`. + }, }, "queryParams": { # Represents the parameters of a conversational query. # The parameters of this query. "analyzeQueryTextSentiment": True or False, # Configures whether sentiment analysis should be performed. If not provided, sentiment analysis is not performed. "channel": "A String", # The channel which this query is for. If specified, only the ResponseMessage associated with the channel will be returned. If no ResponseMessage is associated with the channel, it falls back to the ResponseMessage with unspecified channel. If unspecified, the ResponseMessage with unspecified channel will be returned. "currentPage": "A String", # The unique identifier of the page to override the current page in the session. Format: `projects//locations//agents//flows//pages/`. If `current_page` is specified, the previous state of the session will be ignored by Dialogflow, including the previous page and the previous session parameters. In most cases, current_page and parameters should be configured together to direct a session to a specific state. + "currentPlaybook": "A String", # Optional. Start the session with the specified playbook. You can only specify the playbook at the beginning of the session. Otherwise, an error will be thrown. Format: `projects//locations//agents//playbooks/`. "disableWebhook": True or False, # Whether to disable webhook calls for this request. "endUserMetadata": { # Optional. Information about the end-user to improve the relevance and accuracy of generative answers. This will be interpreted and used by a language model, so, for good results, the data should be self-descriptive, and in a simple structure. Example: ```json { "subscription plan": "Business Premium Plus", "devices owned": [ {"model": "Google Pixel 7"}, {"model": "Google Pixel Tablet"} ] } ``` "a_key": "", # Properties of the object. @@ -2974,6 +4447,10 @@

Method Details

"latitude": 3.14, # The latitude in degrees. It must be in the range [-90.0, +90.0]. "longitude": 3.14, # The longitude in degrees. It must be in the range [-180.0, +180.0]. }, + "llmModelSettings": { # Settings for LLM models. # Optional. Use the specified LLM model settings for processing the request. + "model": "A String", # The selected LLM model. + "promptText": "A String", # The custom prompt to use. + }, "parameters": { # Additional parameters to be put into session parameters. To remove a parameter from the session, clients should explicitly set the parameter value to null. You can reference the session parameters in the agent with the following format: $session.params.parameter-id. 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 then use map, otherwise, depending on the parameter value type, it could be one of string, number, boolean, null, list or map. * MapValue value: If parameter's entity type is a composite entity then use map from composite entity property names to property values, otherwise, use parameter value. "a_key": "", # Properties of the object. }, @@ -3052,8 +4529,8 @@

Method Details

"maxDigits": 42, # Max length of DTMF digits. }, "loggingSettings": { # Define behaviors on logging. # Settings for logging. Settings for Dialogflow History, Contact Center messages, StackDriver logs, and speech logging. Exposed at the following levels: - Agent level. - "enableInteractionLogging": True or False, # If true, DF Interaction logging is currently enabled. - "enableStackdriverLogging": True or False, # If true, StackDriver logging is currently enabled. + "enableInteractionLogging": True or False, # Enables DF Interaction logging. + "enableStackdriverLogging": True or False, # Enables StackDriver logging. }, "speechSettings": { # Define behaviors of speech to text detection. # Settings for speech to text detection. Exposed at the following levels: - Agent level - Flow level - Page level - Parameter level "endpointerSensitivity": 42, # Sensitivity of the speech model that detects the end of speech. Scale from 0 to 100. @@ -3079,8 +4556,8 @@

Method Details

"maxDigits": 42, # Max length of DTMF digits. }, "loggingSettings": { # Define behaviors on logging. # Settings for logging. Settings for Dialogflow History, Contact Center messages, StackDriver logs, and speech logging. Exposed at the following levels: - Agent level. - "enableInteractionLogging": True or False, # If true, DF Interaction logging is currently enabled. - "enableStackdriverLogging": True or False, # If true, StackDriver logging is currently enabled. + "enableInteractionLogging": True or False, # Enables DF Interaction logging. + "enableStackdriverLogging": True or False, # Enables StackDriver logging. }, "speechSettings": { # Define behaviors of speech to text detection. # Settings for speech to text detection. Exposed at the following levels: - Agent level - Flow level - Page level - Parameter level "endpointerSensitivity": 42, # Sensitivity of the speech model that detects the end of speech. Scale from 0 to 100. @@ -3144,6 +4621,13 @@

Method Details

"A String", ], }, + "toolCall": { # Represents a call of a specific tool's action with the specified inputs. # Returns the definition of a tool call that should be executed by the client. + "action": "A String", # Required. The name of the tool's action associated with this call. + "inputParameters": { # Optional. The action's input parameters. + "a_key": "", # Properties of the object. + }, + "tool": "A String", # Required. The tool associated with this call. Format: `projects//locations//agents//tools/`. + }, }, }, ], @@ -3200,6 +4684,13 @@

Method Details

"A String", ], }, + "toolCall": { # Represents a call of a specific tool's action with the specified inputs. # Returns the definition of a tool call that should be executed by the client. + "action": "A String", # Required. The name of the tool's action associated with this call. + "inputParameters": { # Optional. The action's input parameters. + "a_key": "", # Properties of the object. + }, + "tool": "A String", # Required. The tool associated with this call. Format: `projects//locations//agents//tools/`. + }, }, ], "returnPartialResponses": True or False, # Whether Dialogflow should return currently queued fulfillment response messages in streaming APIs. If a webhook is specified, it happens before Dialogflow invokes webhook. Warning: 1) This flag only affects streaming API. Responses are still queued and returned once in non-streaming API. 2) The flag can be enabled in any fulfillment but only the first 3 partial responses will be returned. You may only want to apply it to fulfillments that have slow webhooks. @@ -3231,8 +4722,8 @@

Method Details

"maxDigits": 42, # Max length of DTMF digits. }, "loggingSettings": { # Define behaviors on logging. # Settings for logging. Settings for Dialogflow History, Contact Center messages, StackDriver logs, and speech logging. Exposed at the following levels: - Agent level. - "enableInteractionLogging": True or False, # If true, DF Interaction logging is currently enabled. - "enableStackdriverLogging": True or False, # If true, StackDriver logging is currently enabled. + "enableInteractionLogging": True or False, # Enables DF Interaction logging. + "enableStackdriverLogging": True or False, # Enables StackDriver logging. }, "speechSettings": { # Define behaviors of speech to text detection. # Settings for speech to text detection. Exposed at the following levels: - Agent level - Flow level - Page level - Parameter level "endpointerSensitivity": 42, # Sensitivity of the speech model that detects the end of speech. Scale from 0 to 100. @@ -3296,6 +4787,13 @@

Method Details

"A String", ], }, + "toolCall": { # Represents a call of a specific tool's action with the specified inputs. # Returns the definition of a tool call that should be executed by the client. + "action": "A String", # Required. The name of the tool's action associated with this call. + "inputParameters": { # Optional. The action's input parameters. + "a_key": "", # Properties of the object. + }, + "tool": "A String", # Required. The tool associated with this call. Format: `projects//locations//agents//tools/`. + }, }, }, ], @@ -3352,6 +4850,13 @@

Method Details

"A String", ], }, + "toolCall": { # Represents a call of a specific tool's action with the specified inputs. # Returns the definition of a tool call that should be executed by the client. + "action": "A String", # Required. The name of the tool's action associated with this call. + "inputParameters": { # Optional. The action's input parameters. + "a_key": "", # Properties of the object. + }, + "tool": "A String", # Required. The tool associated with this call. Format: `projects//locations//agents//tools/`. + }, }, ], "returnPartialResponses": True or False, # Whether Dialogflow should return currently queued fulfillment response messages in streaming APIs. If a webhook is specified, it happens before Dialogflow invokes webhook. Warning: 1) This flag only affects streaming API. Responses are still queued and returned once in non-streaming API. 2) The flag can be enabled in any fulfillment but only the first 3 partial responses will be returned. You may only want to apply it to fulfillments that have slow webhooks. @@ -3381,8 +4886,8 @@

Method Details

"maxDigits": 42, # Max length of DTMF digits. }, "loggingSettings": { # Define behaviors on logging. # Settings for logging. Settings for Dialogflow History, Contact Center messages, StackDriver logs, and speech logging. Exposed at the following levels: - Agent level. - "enableInteractionLogging": True or False, # If true, DF Interaction logging is currently enabled. - "enableStackdriverLogging": True or False, # If true, StackDriver logging is currently enabled. + "enableInteractionLogging": True or False, # Enables DF Interaction logging. + "enableStackdriverLogging": True or False, # Enables StackDriver logging. }, "speechSettings": { # Define behaviors of speech to text detection. # Settings for speech to text detection. Exposed at the following levels: - Agent level - Flow level - Page level - Parameter level "endpointerSensitivity": 42, # Sensitivity of the speech model that detects the end of speech. Scale from 0 to 100. @@ -3410,8 +4915,8 @@

Method Details

"maxDigits": 42, # Max length of DTMF digits. }, "loggingSettings": { # Define behaviors on logging. # Settings for logging. Settings for Dialogflow History, Contact Center messages, StackDriver logs, and speech logging. Exposed at the following levels: - Agent level. - "enableInteractionLogging": True or False, # If true, DF Interaction logging is currently enabled. - "enableStackdriverLogging": True or False, # If true, StackDriver logging is currently enabled. + "enableInteractionLogging": True or False, # Enables DF Interaction logging. + "enableStackdriverLogging": True or False, # Enables StackDriver logging. }, "speechSettings": { # Define behaviors of speech to text detection. # Settings for speech to text detection. Exposed at the following levels: - Agent level - Flow level - Page level - Parameter level "endpointerSensitivity": 42, # Sensitivity of the speech model that detects the end of speech. Scale from 0 to 100. @@ -3475,6 +4980,13 @@

Method Details

"A String", ], }, + "toolCall": { # Represents a call of a specific tool's action with the specified inputs. # Returns the definition of a tool call that should be executed by the client. + "action": "A String", # Required. The name of the tool's action associated with this call. + "inputParameters": { # Optional. The action's input parameters. + "a_key": "", # Properties of the object. + }, + "tool": "A String", # Required. The tool associated with this call. Format: `projects//locations//agents//tools/`. + }, }, }, ], @@ -3531,6 +5043,13 @@

Method Details

"A String", ], }, + "toolCall": { # Represents a call of a specific tool's action with the specified inputs. # Returns the definition of a tool call that should be executed by the client. + "action": "A String", # Required. The name of the tool's action associated with this call. + "inputParameters": { # Optional. The action's input parameters. + "a_key": "", # Properties of the object. + }, + "tool": "A String", # Required. The tool associated with this call. Format: `projects//locations//agents//tools/`. + }, }, ], "returnPartialResponses": True or False, # Whether Dialogflow should return currently queued fulfillment response messages in streaming APIs. If a webhook is specified, it happens before Dialogflow invokes webhook. Warning: 1) This flag only affects streaming API. Responses are still queued and returned once in non-streaming API. 2) The flag can be enabled in any fulfillment but only the first 3 partial responses will be returned. You may only want to apply it to fulfillments that have slow webhooks. @@ -3562,8 +5081,8 @@

Method Details

"maxDigits": 42, # Max length of DTMF digits. }, "loggingSettings": { # Define behaviors on logging. # Settings for logging. Settings for Dialogflow History, Contact Center messages, StackDriver logs, and speech logging. Exposed at the following levels: - Agent level. - "enableInteractionLogging": True or False, # If true, DF Interaction logging is currently enabled. - "enableStackdriverLogging": True or False, # If true, StackDriver logging is currently enabled. + "enableInteractionLogging": True or False, # Enables DF Interaction logging. + "enableStackdriverLogging": True or False, # Enables StackDriver logging. }, "speechSettings": { # Define behaviors of speech to text detection. # Settings for speech to text detection. Exposed at the following levels: - Agent level - Flow level - Page level - Parameter level "endpointerSensitivity": 42, # Sensitivity of the speech model that detects the end of speech. Scale from 0 to 100. @@ -3627,253 +5146,898 @@

Method Details

"A String", ], }, + "toolCall": { # Represents a call of a specific tool's action with the specified inputs. # Returns the definition of a tool call that should be executed by the client. + "action": "A String", # Required. The name of the tool's action associated with this call. + "inputParameters": { # Optional. The action's input parameters. + "a_key": "", # Properties of the object. + }, + "tool": "A String", # Required. The tool associated with this call. Format: `projects//locations//agents//tools/`. + }, }, }, ], - "condition": "A String", # The condition to activate and select this case. Empty means the condition is always true. The condition is evaluated against form parameters or session parameters. See the [conditions reference](https://cloud.google.com/dialogflow/cx/docs/reference/condition). + "condition": "A String", # The condition to activate and select this case. Empty means the condition is always true. The condition is evaluated against form parameters or session parameters. See the [conditions reference](https://cloud.google.com/dialogflow/cx/docs/reference/condition). + }, + ], + }, + ], + "enableGenerativeFallback": True or False, # If the flag is true, the agent will utilize LLM to generate a text response. If LLM generation fails, the defined responses in the fulfillment will be respected. This flag is only useful for fulfillments associated with no-match event handlers. + "messages": [ # The list of rich message responses to present to the user. + { # 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. + "channel": "A String", # The channel which the response is associated with. Clients can specify the channel via QueryParameters.channel, and only associated channel response will be returned. + "conversationSuccess": { # 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. # Indicates that the conversation succeeded. + "metadata": { # Custom metadata. Dialogflow doesn't impose any structure on this. + "a_key": "", # Properties of the object. + }, + }, + "endInteraction": { # 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. # Output only. A signal that indicates the interaction with the Dialogflow agent has ended. This message is generated by Dialogflow only when the conversation reaches `END_SESSION` page. It is not supposed to be defined by the user. It's guaranteed that there is at most one such message in each response. + }, + "knowledgeInfoCard": { # Represents info card response. If the response contains generative knowledge prediction, Dialogflow will return a payload with Infobot Messenger compatible info card. Otherwise, the info card response is skipped. # Represents info card for knowledge answers, to be better rendered in Dialogflow Messenger. + }, + "liveAgentHandoff": { # 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. # Hands off conversation to a human agent. + "metadata": { # Custom metadata for your handoff procedure. Dialogflow doesn't impose any structure on this. + "a_key": "", # Properties of the object. + }, + }, + "mixedAudio": { # 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. # Output only. An audio response message composed of both the synthesized Dialogflow agent responses and responses defined via play_audio. This message is generated by Dialogflow only and not supposed to be defined by the user. + "segments": [ # Segments this audio response is composed of. + { # Represents one segment of audio. + "allowPlaybackInterruption": True or False, # 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. + "audio": "A String", # Raw audio synthesized from the Dialogflow agent's response using the output config specified in the request. + "uri": "A String", # Client-specific URI that points to an audio clip accessible to the client. Dialogflow does not impose any validation on it. + }, + ], + }, + "outputAudioText": { # A text or ssml response that is preferentially used for TTS output audio synthesis, as described in the comment on the ResponseMessage message. # A text or ssml response that is preferentially used for TTS output audio synthesis, as described in the comment on the ResponseMessage message. + "allowPlaybackInterruption": True or False, # 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. + "ssml": "A String", # The SSML text to be synthesized. For more information, see [SSML](/speech/text-to-speech/docs/ssml). + "text": "A String", # The raw text to be synthesized. + }, + "payload": { # Returns a response containing a custom, platform-specific payload. + "a_key": "", # Properties of the object. + }, + "playAudio": { # Specifies an audio clip to be played by the client as part of the response. # Signal that the client should play an audio clip hosted at a client-specific URI. Dialogflow uses this to construct mixed_audio. However, Dialogflow itself does not try to read or process the URI in any way. + "allowPlaybackInterruption": True or False, # 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. + "audioUri": "A String", # Required. URI of the audio clip. Dialogflow does not impose any validation on this value. It is specific to the client that reads it. + }, + "telephonyTransferCall": { # Represents the signal that telles the client to transfer the phone call connected to the agent to a third-party endpoint. # A signal that the client should transfer the phone call connected to this agent to a third-party endpoint. + "phoneNumber": "A String", # Transfer the call to a phone number in [E.164 format](https://en.wikipedia.org/wiki/E.164). + }, + "text": { # The text response message. # Returns a text response. + "allowPlaybackInterruption": True or False, # 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. + "text": [ # Required. A collection of text responses. + "A String", + ], + }, + "toolCall": { # Represents a call of a specific tool's action with the specified inputs. # Returns the definition of a tool call that should be executed by the client. + "action": "A String", # Required. The name of the tool's action associated with this call. + "inputParameters": { # Optional. The action's input parameters. + "a_key": "", # Properties of the object. + }, + "tool": "A String", # Required. The tool associated with this call. Format: `projects//locations//agents//tools/`. + }, + }, + ], + "returnPartialResponses": True or False, # Whether Dialogflow should return currently queued fulfillment response messages in streaming APIs. If a webhook is specified, it happens before Dialogflow invokes webhook. Warning: 1) This flag only affects streaming API. Responses are still queued and returned once in non-streaming API. 2) The flag can be enabled in any fulfillment but only the first 3 partial responses will be returned. You may only want to apply it to fulfillments that have slow webhooks. + "setParameterActions": [ # Set parameter values before executing the webhook. + { # Setting a parameter value. + "parameter": "A String", # Display name of the parameter. + "value": "", # The new value of the parameter. A null value clears the parameter. + }, + ], + "tag": "A String", # The value of this field will be populated in the WebhookRequest `fulfillmentInfo.tag` field by Dialogflow when the associated webhook is called. The tag is typically used by the webhook service to identify which fulfillment is being called, but it could be used for other purposes. This field is required if `webhook` is specified. + "webhook": "A String", # The webhook to call. Format: `projects//locations//agents//webhooks/`. + }, + }, + ], + }, + "isList": True or False, # Indicates whether the parameter represents a list of values. + "redact": True or False, # Indicates whether the parameter content should be redacted in log. If redaction is enabled, the parameter content will be replaced by parameter name during logging. Note: the parameter content is subject to redaction if either parameter level redaction or entity type level redaction is enabled. + "required": True or False, # 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. + }, + ], + }, + "knowledgeConnectorSettings": { # The Knowledge Connector settings for this page or flow. This includes information such as the attached Knowledge Bases, and the way to execute fulfillment. # Optional. Knowledge connector configuration. + "dataStoreConnections": [ # Optional. List of related data store connections. + { # A data store connection. It represents a data store in Discovery Engine and the type of the contents it contains. + "dataStore": "A String", # The full name of the referenced data store. Formats: `projects/{project}/locations/{location}/collections/{collection}/dataStores/{data_store}` `projects/{project}/locations/{location}/dataStores/{data_store}` + "dataStoreType": "A String", # The type of the connected data store. + }, + ], + "enabled": True or False, # Whether Knowledge Connector is enabled or not. + "targetFlow": "A String", # The target flow to transition to. Format: `projects//locations//agents//flows/`. + "targetPage": "A String", # The target page to transition to. Format: `projects//locations//agents//flows//pages/`. + "triggerFulfillment": { # A fulfillment can do one or more of the following actions at the same time: * Generate rich message responses. * Set parameter values. * Call the webhook. Fulfillments can be called at various stages in the Page or Form lifecycle. For example, when a DetectIntentRequest drives a session to enter a new page, the page's entry fulfillment can add a static response to the QueryResult in the returning DetectIntentResponse, call the webhook (for example, to load user data from a database), or both. # The fulfillment to be triggered. When the answers from the Knowledge Connector are selected by Dialogflow, you can utitlize the request scoped parameter `$request.knowledge.answers` (contains up to the 5 highest confidence answers) and `$request.knowledge.questions` (contains the corresponding questions) to construct the fulfillment. + "advancedSettings": { # Hierarchical advanced settings for agent/flow/page/fulfillment/parameter. Settings exposed at lower level overrides the settings exposed at higher level. Overriding occurs at the sub-setting level. For example, the playback_interruption_settings at fulfillment level only overrides the playback_interruption_settings at the agent level, leaving other settings at the agent level unchanged. DTMF settings does not override each other. DTMF settings set at different levels define DTMF detections running in parallel. Hierarchy: Agent->Flow->Page->Fulfillment/Parameter. # Hierarchical advanced settings for this fulfillment. The settings exposed at the lower level overrides the settings exposed at the higher level. + "audioExportGcsDestination": { # Google Cloud Storage location for a Dialogflow operation that writes or exports objects (e.g. exported agent or transcripts) outside of Dialogflow. # If present, incoming audio is exported by Dialogflow to the configured Google Cloud Storage destination. Exposed at the following levels: - Agent level - Flow level + "uri": "A String", # Required. The Google Cloud Storage URI for the exported objects. A URI is of the form: `gs://bucket/object-name-or-prefix` Whether a full object name, or just a prefix, its usage depends on the Dialogflow operation. + }, + "dtmfSettings": { # Define behaviors for DTMF (dual tone multi frequency). # Settings for DTMF. Exposed at the following levels: - Agent level - Flow level - Page level - Parameter level. + "enabled": True or False, # If true, incoming audio is processed for DTMF (dual tone multi frequency) events. For example, if the caller presses a button on their telephone keypad and DTMF processing is enabled, Dialogflow will detect the event (e.g. a "3" was pressed) in the incoming audio and pass the event to the bot to drive business logic (e.g. when 3 is pressed, return the account balance). + "endpointingTimeoutDuration": "A String", # Endpoint timeout setting for matching dtmf input to regex. + "finishDigit": "A String", # The digit that terminates a DTMF digit sequence. + "interdigitTimeoutDuration": "A String", # Interdigit timeout setting for matching dtmf input to regex. + "maxDigits": 42, # Max length of DTMF digits. + }, + "loggingSettings": { # Define behaviors on logging. # Settings for logging. Settings for Dialogflow History, Contact Center messages, StackDriver logs, and speech logging. Exposed at the following levels: - Agent level. + "enableInteractionLogging": True or False, # Enables DF Interaction logging. + "enableStackdriverLogging": True or False, # Enables StackDriver logging. + }, + "speechSettings": { # Define behaviors of speech to text detection. # Settings for speech to text detection. Exposed at the following levels: - Agent level - Flow level - Page level - Parameter level + "endpointerSensitivity": 42, # Sensitivity of the speech model that detects the end of speech. Scale from 0 to 100. + "models": { # Mapping from language to Speech-to-Text model. The mapped Speech-to-Text model will be selected for requests from its corresponding language. For more information, see [Speech models](https://cloud.google.com/dialogflow/cx/docs/concept/speech-models). + "a_key": "A String", + }, + "noSpeechTimeout": "A String", # Timeout before detecting no speech. + "useTimeoutBasedEndpointing": True or False, # Use timeout based endpointing, interpreting endpointer sensitivy as seconds of timeout value. + }, + }, + "conditionalCases": [ # Conditional cases for this fulfillment. + { # A list of cascading if-else conditions. Cases are mutually exclusive. The first one with a matching condition is selected, all the rest ignored. + "cases": [ # A list of cascading if-else conditions. + { # Each case has a Boolean condition. When it is evaluated to be True, the corresponding messages will be selected and evaluated recursively. + "caseContent": [ # A list of case content. + { # The list of messages or conditional cases to activate for this case. + "additionalCases": # Object with schema name: GoogleCloudDialogflowCxV3beta1FulfillmentConditionalCases # Additional cases to be evaluated. + "message": { # 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. # Returned message. + "channel": "A String", # The channel which the response is associated with. Clients can specify the channel via QueryParameters.channel, and only associated channel response will be returned. + "conversationSuccess": { # 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. # Indicates that the conversation succeeded. + "metadata": { # Custom metadata. Dialogflow doesn't impose any structure on this. + "a_key": "", # Properties of the object. + }, + }, + "endInteraction": { # 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. # Output only. A signal that indicates the interaction with the Dialogflow agent has ended. This message is generated by Dialogflow only when the conversation reaches `END_SESSION` page. It is not supposed to be defined by the user. It's guaranteed that there is at most one such message in each response. + }, + "knowledgeInfoCard": { # Represents info card response. If the response contains generative knowledge prediction, Dialogflow will return a payload with Infobot Messenger compatible info card. Otherwise, the info card response is skipped. # Represents info card for knowledge answers, to be better rendered in Dialogflow Messenger. + }, + "liveAgentHandoff": { # 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. # Hands off conversation to a human agent. + "metadata": { # Custom metadata for your handoff procedure. Dialogflow doesn't impose any structure on this. + "a_key": "", # Properties of the object. + }, + }, + "mixedAudio": { # 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. # Output only. An audio response message composed of both the synthesized Dialogflow agent responses and responses defined via play_audio. This message is generated by Dialogflow only and not supposed to be defined by the user. + "segments": [ # Segments this audio response is composed of. + { # Represents one segment of audio. + "allowPlaybackInterruption": True or False, # 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. + "audio": "A String", # Raw audio synthesized from the Dialogflow agent's response using the output config specified in the request. + "uri": "A String", # Client-specific URI that points to an audio clip accessible to the client. Dialogflow does not impose any validation on it. + }, + ], + }, + "outputAudioText": { # A text or ssml response that is preferentially used for TTS output audio synthesis, as described in the comment on the ResponseMessage message. # A text or ssml response that is preferentially used for TTS output audio synthesis, as described in the comment on the ResponseMessage message. + "allowPlaybackInterruption": True or False, # 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. + "ssml": "A String", # The SSML text to be synthesized. For more information, see [SSML](/speech/text-to-speech/docs/ssml). + "text": "A String", # The raw text to be synthesized. + }, + "payload": { # Returns a response containing a custom, platform-specific payload. + "a_key": "", # Properties of the object. + }, + "playAudio": { # Specifies an audio clip to be played by the client as part of the response. # Signal that the client should play an audio clip hosted at a client-specific URI. Dialogflow uses this to construct mixed_audio. However, Dialogflow itself does not try to read or process the URI in any way. + "allowPlaybackInterruption": True or False, # 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. + "audioUri": "A String", # Required. URI of the audio clip. Dialogflow does not impose any validation on this value. It is specific to the client that reads it. + }, + "telephonyTransferCall": { # Represents the signal that telles the client to transfer the phone call connected to the agent to a third-party endpoint. # A signal that the client should transfer the phone call connected to this agent to a third-party endpoint. + "phoneNumber": "A String", # Transfer the call to a phone number in [E.164 format](https://en.wikipedia.org/wiki/E.164). + }, + "text": { # The text response message. # Returns a text response. + "allowPlaybackInterruption": True or False, # 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. + "text": [ # Required. A collection of text responses. + "A String", + ], + }, + "toolCall": { # Represents a call of a specific tool's action with the specified inputs. # Returns the definition of a tool call that should be executed by the client. + "action": "A String", # Required. The name of the tool's action associated with this call. + "inputParameters": { # Optional. The action's input parameters. + "a_key": "", # Properties of the object. + }, + "tool": "A String", # Required. The tool associated with this call. Format: `projects//locations//agents//tools/`. + }, + }, + }, + ], + "condition": "A String", # The condition to activate and select this case. Empty means the condition is always true. The condition is evaluated against form parameters or session parameters. See the [conditions reference](https://cloud.google.com/dialogflow/cx/docs/reference/condition). + }, + ], + }, + ], + "enableGenerativeFallback": True or False, # If the flag is true, the agent will utilize LLM to generate a text response. If LLM generation fails, the defined responses in the fulfillment will be respected. This flag is only useful for fulfillments associated with no-match event handlers. + "messages": [ # The list of rich message responses to present to the user. + { # 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. + "channel": "A String", # The channel which the response is associated with. Clients can specify the channel via QueryParameters.channel, and only associated channel response will be returned. + "conversationSuccess": { # 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. # Indicates that the conversation succeeded. + "metadata": { # Custom metadata. Dialogflow doesn't impose any structure on this. + "a_key": "", # Properties of the object. + }, + }, + "endInteraction": { # 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. # Output only. A signal that indicates the interaction with the Dialogflow agent has ended. This message is generated by Dialogflow only when the conversation reaches `END_SESSION` page. It is not supposed to be defined by the user. It's guaranteed that there is at most one such message in each response. + }, + "knowledgeInfoCard": { # Represents info card response. If the response contains generative knowledge prediction, Dialogflow will return a payload with Infobot Messenger compatible info card. Otherwise, the info card response is skipped. # Represents info card for knowledge answers, to be better rendered in Dialogflow Messenger. + }, + "liveAgentHandoff": { # 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. # Hands off conversation to a human agent. + "metadata": { # Custom metadata for your handoff procedure. Dialogflow doesn't impose any structure on this. + "a_key": "", # Properties of the object. + }, + }, + "mixedAudio": { # 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. # Output only. An audio response message composed of both the synthesized Dialogflow agent responses and responses defined via play_audio. This message is generated by Dialogflow only and not supposed to be defined by the user. + "segments": [ # Segments this audio response is composed of. + { # Represents one segment of audio. + "allowPlaybackInterruption": True or False, # 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. + "audio": "A String", # Raw audio synthesized from the Dialogflow agent's response using the output config specified in the request. + "uri": "A String", # Client-specific URI that points to an audio clip accessible to the client. Dialogflow does not impose any validation on it. + }, + ], + }, + "outputAudioText": { # A text or ssml response that is preferentially used for TTS output audio synthesis, as described in the comment on the ResponseMessage message. # A text or ssml response that is preferentially used for TTS output audio synthesis, as described in the comment on the ResponseMessage message. + "allowPlaybackInterruption": True or False, # 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. + "ssml": "A String", # The SSML text to be synthesized. For more information, see [SSML](/speech/text-to-speech/docs/ssml). + "text": "A String", # The raw text to be synthesized. + }, + "payload": { # Returns a response containing a custom, platform-specific payload. + "a_key": "", # Properties of the object. + }, + "playAudio": { # Specifies an audio clip to be played by the client as part of the response. # Signal that the client should play an audio clip hosted at a client-specific URI. Dialogflow uses this to construct mixed_audio. However, Dialogflow itself does not try to read or process the URI in any way. + "allowPlaybackInterruption": True or False, # 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. + "audioUri": "A String", # Required. URI of the audio clip. Dialogflow does not impose any validation on this value. It is specific to the client that reads it. + }, + "telephonyTransferCall": { # Represents the signal that telles the client to transfer the phone call connected to the agent to a third-party endpoint. # A signal that the client should transfer the phone call connected to this agent to a third-party endpoint. + "phoneNumber": "A String", # Transfer the call to a phone number in [E.164 format](https://en.wikipedia.org/wiki/E.164). + }, + "text": { # The text response message. # Returns a text response. + "allowPlaybackInterruption": True or False, # 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. + "text": [ # Required. A collection of text responses. + "A String", + ], + }, + "toolCall": { # Represents a call of a specific tool's action with the specified inputs. # Returns the definition of a tool call that should be executed by the client. + "action": "A String", # Required. The name of the tool's action associated with this call. + "inputParameters": { # Optional. The action's input parameters. + "a_key": "", # Properties of the object. + }, + "tool": "A String", # Required. The tool associated with this call. Format: `projects//locations//agents//tools/`. + }, + }, + ], + "returnPartialResponses": True or False, # Whether Dialogflow should return currently queued fulfillment response messages in streaming APIs. If a webhook is specified, it happens before Dialogflow invokes webhook. Warning: 1) This flag only affects streaming API. Responses are still queued and returned once in non-streaming API. 2) The flag can be enabled in any fulfillment but only the first 3 partial responses will be returned. You may only want to apply it to fulfillments that have slow webhooks. + "setParameterActions": [ # Set parameter values before executing the webhook. + { # Setting a parameter value. + "parameter": "A String", # Display name of the parameter. + "value": "", # The new value of the parameter. A null value clears the parameter. + }, + ], + "tag": "A String", # The value of this field will be populated in the WebhookRequest `fulfillmentInfo.tag` field by Dialogflow when the associated webhook is called. The tag is typically used by the webhook service to identify which fulfillment is being called, but it could be used for other purposes. This field is required if `webhook` is specified. + "webhook": "A String", # The webhook to call. Format: `projects//locations//agents//webhooks/`. + }, + }, + "name": "A String", # The unique identifier of the page. Required for the Pages.UpdatePage method. Pages.CreatePage populates the name automatically. Format: `projects//locations//agents//flows//pages/`. + "transitionRouteGroups": [ # Ordered list of `TransitionRouteGroups` added to the page. Transition route groups must be unique within a page. If the page links both flow-level transition route groups and agent-level transition route groups, the flow-level ones will have higher priority and will be put before the agent-level ones. * If multiple transition routes within a page scope refer to the same intent, then the precedence order is: page's transition route -> page's transition route group -> flow's transition routes. * If multiple transition route groups within a page contain the same intent, then the first group in the ordered list takes precedence. Format:`projects//locations//agents//flows//transitionRouteGroups/` or `projects//locations//agents//transitionRouteGroups/` for agent-level groups. + "A String", + ], + "transitionRoutes": [ # A list of transitions for the transition rules of this page. They route the conversation to another page in the same flow, or another flow. When we are in a certain page, the TransitionRoutes are evalauted in the following order: * TransitionRoutes defined in the page with intent specified. * TransitionRoutes defined in the transition route groups with intent specified. * TransitionRoutes defined in flow with intent specified. * TransitionRoutes defined in the transition route groups with intent specified. * TransitionRoutes defined in the page with only condition specified. * TransitionRoutes defined in the transition route groups with only condition specified. + { # A transition route specifies a intent that can be matched and/or a data condition that can be evaluated during a session. When a specified transition is matched, the following actions are taken in order: * If there is a `trigger_fulfillment` associated with the transition, it will be called. * If there is a `target_page` associated with the transition, the session will transition into the specified page. * If there is a `target_flow` associated with the transition, the session will transition into the specified flow. + "condition": "A String", # The condition to evaluate against form parameters or session parameters. See the [conditions reference](https://cloud.google.com/dialogflow/cx/docs/reference/condition). At least one of `intent` or `condition` must be specified. When both `intent` and `condition` are specified, the transition can only happen when both are fulfilled. + "description": "A String", # Optional. The description of the transition route. The maximum length is 500 characters. + "intent": "A String", # The unique identifier of an Intent. Format: `projects//locations//agents//intents/`. Indicates that the transition can only happen when the given intent is matched. At least one of `intent` or `condition` must be specified. When both `intent` and `condition` are specified, the transition can only happen when both are fulfilled. + "name": "A String", # Output only. The unique identifier of this transition route. + "targetFlow": "A String", # The target flow to transition to. Format: `projects//locations//agents//flows/`. + "targetPage": "A String", # The target page to transition to. Format: `projects//locations//agents//flows//pages/`. + "triggerFulfillment": { # A fulfillment can do one or more of the following actions at the same time: * Generate rich message responses. * Set parameter values. * Call the webhook. Fulfillments can be called at various stages in the Page or Form lifecycle. For example, when a DetectIntentRequest drives a session to enter a new page, the page's entry fulfillment can add a static response to the QueryResult in the returning DetectIntentResponse, call the webhook (for example, to load user data from a database), or both. # The fulfillment to call when the condition is satisfied. At least one of `trigger_fulfillment` and `target` must be specified. When both are defined, `trigger_fulfillment` is executed first. + "advancedSettings": { # Hierarchical advanced settings for agent/flow/page/fulfillment/parameter. Settings exposed at lower level overrides the settings exposed at higher level. Overriding occurs at the sub-setting level. For example, the playback_interruption_settings at fulfillment level only overrides the playback_interruption_settings at the agent level, leaving other settings at the agent level unchanged. DTMF settings does not override each other. DTMF settings set at different levels define DTMF detections running in parallel. Hierarchy: Agent->Flow->Page->Fulfillment/Parameter. # Hierarchical advanced settings for this fulfillment. The settings exposed at the lower level overrides the settings exposed at the higher level. + "audioExportGcsDestination": { # Google Cloud Storage location for a Dialogflow operation that writes or exports objects (e.g. exported agent or transcripts) outside of Dialogflow. # If present, incoming audio is exported by Dialogflow to the configured Google Cloud Storage destination. Exposed at the following levels: - Agent level - Flow level + "uri": "A String", # Required. The Google Cloud Storage URI for the exported objects. A URI is of the form: `gs://bucket/object-name-or-prefix` Whether a full object name, or just a prefix, its usage depends on the Dialogflow operation. + }, + "dtmfSettings": { # Define behaviors for DTMF (dual tone multi frequency). # Settings for DTMF. Exposed at the following levels: - Agent level - Flow level - Page level - Parameter level. + "enabled": True or False, # If true, incoming audio is processed for DTMF (dual tone multi frequency) events. For example, if the caller presses a button on their telephone keypad and DTMF processing is enabled, Dialogflow will detect the event (e.g. a "3" was pressed) in the incoming audio and pass the event to the bot to drive business logic (e.g. when 3 is pressed, return the account balance). + "endpointingTimeoutDuration": "A String", # Endpoint timeout setting for matching dtmf input to regex. + "finishDigit": "A String", # The digit that terminates a DTMF digit sequence. + "interdigitTimeoutDuration": "A String", # Interdigit timeout setting for matching dtmf input to regex. + "maxDigits": 42, # Max length of DTMF digits. + }, + "loggingSettings": { # Define behaviors on logging. # Settings for logging. Settings for Dialogflow History, Contact Center messages, StackDriver logs, and speech logging. Exposed at the following levels: - Agent level. + "enableInteractionLogging": True or False, # Enables DF Interaction logging. + "enableStackdriverLogging": True or False, # Enables StackDriver logging. + }, + "speechSettings": { # Define behaviors of speech to text detection. # Settings for speech to text detection. Exposed at the following levels: - Agent level - Flow level - Page level - Parameter level + "endpointerSensitivity": 42, # Sensitivity of the speech model that detects the end of speech. Scale from 0 to 100. + "models": { # Mapping from language to Speech-to-Text model. The mapped Speech-to-Text model will be selected for requests from its corresponding language. For more information, see [Speech models](https://cloud.google.com/dialogflow/cx/docs/concept/speech-models). + "a_key": "A String", + }, + "noSpeechTimeout": "A String", # Timeout before detecting no speech. + "useTimeoutBasedEndpointing": True or False, # Use timeout based endpointing, interpreting endpointer sensitivy as seconds of timeout value. + }, + }, + "conditionalCases": [ # Conditional cases for this fulfillment. + { # A list of cascading if-else conditions. Cases are mutually exclusive. The first one with a matching condition is selected, all the rest ignored. + "cases": [ # A list of cascading if-else conditions. + { # Each case has a Boolean condition. When it is evaluated to be True, the corresponding messages will be selected and evaluated recursively. + "caseContent": [ # A list of case content. + { # The list of messages or conditional cases to activate for this case. + "additionalCases": # Object with schema name: GoogleCloudDialogflowCxV3beta1FulfillmentConditionalCases # Additional cases to be evaluated. + "message": { # 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. # Returned message. + "channel": "A String", # The channel which the response is associated with. Clients can specify the channel via QueryParameters.channel, and only associated channel response will be returned. + "conversationSuccess": { # 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. # Indicates that the conversation succeeded. + "metadata": { # Custom metadata. Dialogflow doesn't impose any structure on this. + "a_key": "", # Properties of the object. + }, + }, + "endInteraction": { # 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. # Output only. A signal that indicates the interaction with the Dialogflow agent has ended. This message is generated by Dialogflow only when the conversation reaches `END_SESSION` page. It is not supposed to be defined by the user. It's guaranteed that there is at most one such message in each response. + }, + "knowledgeInfoCard": { # Represents info card response. If the response contains generative knowledge prediction, Dialogflow will return a payload with Infobot Messenger compatible info card. Otherwise, the info card response is skipped. # Represents info card for knowledge answers, to be better rendered in Dialogflow Messenger. + }, + "liveAgentHandoff": { # 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. # Hands off conversation to a human agent. + "metadata": { # Custom metadata for your handoff procedure. Dialogflow doesn't impose any structure on this. + "a_key": "", # Properties of the object. + }, + }, + "mixedAudio": { # 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. # Output only. An audio response message composed of both the synthesized Dialogflow agent responses and responses defined via play_audio. This message is generated by Dialogflow only and not supposed to be defined by the user. + "segments": [ # Segments this audio response is composed of. + { # Represents one segment of audio. + "allowPlaybackInterruption": True or False, # 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. + "audio": "A String", # Raw audio synthesized from the Dialogflow agent's response using the output config specified in the request. + "uri": "A String", # Client-specific URI that points to an audio clip accessible to the client. Dialogflow does not impose any validation on it. + }, + ], }, - ], - }, - ], - "enableGenerativeFallback": True or False, # If the flag is true, the agent will utilize LLM to generate a text response. If LLM generation fails, the defined responses in the fulfillment will be respected. This flag is only useful for fulfillments associated with no-match event handlers. - "messages": [ # The list of rich message responses to present to the user. - { # 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. - "channel": "A String", # The channel which the response is associated with. Clients can specify the channel via QueryParameters.channel, and only associated channel response will be returned. - "conversationSuccess": { # 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. # Indicates that the conversation succeeded. - "metadata": { # Custom metadata. Dialogflow doesn't impose any structure on this. - "a_key": "", # Properties of the object. + "outputAudioText": { # A text or ssml response that is preferentially used for TTS output audio synthesis, as described in the comment on the ResponseMessage message. # A text or ssml response that is preferentially used for TTS output audio synthesis, as described in the comment on the ResponseMessage message. + "allowPlaybackInterruption": True or False, # 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. + "ssml": "A String", # The SSML text to be synthesized. For more information, see [SSML](/speech/text-to-speech/docs/ssml). + "text": "A String", # The raw text to be synthesized. }, - }, - "endInteraction": { # 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. # Output only. A signal that indicates the interaction with the Dialogflow agent has ended. This message is generated by Dialogflow only when the conversation reaches `END_SESSION` page. It is not supposed to be defined by the user. It's guaranteed that there is at most one such message in each response. - }, - "knowledgeInfoCard": { # Represents info card response. If the response contains generative knowledge prediction, Dialogflow will return a payload with Infobot Messenger compatible info card. Otherwise, the info card response is skipped. # Represents info card for knowledge answers, to be better rendered in Dialogflow Messenger. - }, - "liveAgentHandoff": { # 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. # Hands off conversation to a human agent. - "metadata": { # Custom metadata for your handoff procedure. Dialogflow doesn't impose any structure on this. + "payload": { # Returns a response containing a custom, platform-specific payload. "a_key": "", # Properties of the object. }, - }, - "mixedAudio": { # 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. # Output only. An audio response message composed of both the synthesized Dialogflow agent responses and responses defined via play_audio. This message is generated by Dialogflow only and not supposed to be defined by the user. - "segments": [ # Segments this audio response is composed of. - { # Represents one segment of audio. - "allowPlaybackInterruption": True or False, # 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. - "audio": "A String", # Raw audio synthesized from the Dialogflow agent's response using the output config specified in the request. - "uri": "A String", # Client-specific URI that points to an audio clip accessible to the client. Dialogflow does not impose any validation on it. + "playAudio": { # Specifies an audio clip to be played by the client as part of the response. # Signal that the client should play an audio clip hosted at a client-specific URI. Dialogflow uses this to construct mixed_audio. However, Dialogflow itself does not try to read or process the URI in any way. + "allowPlaybackInterruption": True or False, # 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. + "audioUri": "A String", # Required. URI of the audio clip. Dialogflow does not impose any validation on this value. It is specific to the client that reads it. + }, + "telephonyTransferCall": { # Represents the signal that telles the client to transfer the phone call connected to the agent to a third-party endpoint. # A signal that the client should transfer the phone call connected to this agent to a third-party endpoint. + "phoneNumber": "A String", # Transfer the call to a phone number in [E.164 format](https://en.wikipedia.org/wiki/E.164). + }, + "text": { # The text response message. # Returns a text response. + "allowPlaybackInterruption": True or False, # 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. + "text": [ # Required. A collection of text responses. + "A String", + ], + }, + "toolCall": { # Represents a call of a specific tool's action with the specified inputs. # Returns the definition of a tool call that should be executed by the client. + "action": "A String", # Required. The name of the tool's action associated with this call. + "inputParameters": { # Optional. The action's input parameters. + "a_key": "", # Properties of the object. }, - ], - }, - "outputAudioText": { # A text or ssml response that is preferentially used for TTS output audio synthesis, as described in the comment on the ResponseMessage message. # A text or ssml response that is preferentially used for TTS output audio synthesis, as described in the comment on the ResponseMessage message. - "allowPlaybackInterruption": True or False, # 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. - "ssml": "A String", # The SSML text to be synthesized. For more information, see [SSML](/speech/text-to-speech/docs/ssml). - "text": "A String", # The raw text to be synthesized. - }, - "payload": { # Returns a response containing a custom, platform-specific payload. - "a_key": "", # Properties of the object. - }, - "playAudio": { # Specifies an audio clip to be played by the client as part of the response. # Signal that the client should play an audio clip hosted at a client-specific URI. Dialogflow uses this to construct mixed_audio. However, Dialogflow itself does not try to read or process the URI in any way. - "allowPlaybackInterruption": True or False, # 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. - "audioUri": "A String", # Required. URI of the audio clip. Dialogflow does not impose any validation on this value. It is specific to the client that reads it. - }, - "telephonyTransferCall": { # Represents the signal that telles the client to transfer the phone call connected to the agent to a third-party endpoint. # A signal that the client should transfer the phone call connected to this agent to a third-party endpoint. - "phoneNumber": "A String", # Transfer the call to a phone number in [E.164 format](https://en.wikipedia.org/wiki/E.164). - }, - "text": { # The text response message. # Returns a text response. - "allowPlaybackInterruption": True or False, # 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. - "text": [ # Required. A collection of text responses. - "A String", - ], + "tool": "A String", # Required. The tool associated with this call. Format: `projects//locations//agents//tools/`. + }, }, }, ], - "returnPartialResponses": True or False, # Whether Dialogflow should return currently queued fulfillment response messages in streaming APIs. If a webhook is specified, it happens before Dialogflow invokes webhook. Warning: 1) This flag only affects streaming API. Responses are still queued and returned once in non-streaming API. 2) The flag can be enabled in any fulfillment but only the first 3 partial responses will be returned. You may only want to apply it to fulfillments that have slow webhooks. - "setParameterActions": [ # Set parameter values before executing the webhook. - { # Setting a parameter value. - "parameter": "A String", # Display name of the parameter. - "value": "", # The new value of the parameter. A null value clears the parameter. - }, - ], - "tag": "A String", # The value of this field will be populated in the WebhookRequest `fulfillmentInfo.tag` field by Dialogflow when the associated webhook is called. The tag is typically used by the webhook service to identify which fulfillment is being called, but it could be used for other purposes. This field is required if `webhook` is specified. - "webhook": "A String", # The webhook to call. Format: `projects//locations//agents//webhooks/`. + "condition": "A String", # The condition to activate and select this case. Empty means the condition is always true. The condition is evaluated against form parameters or session parameters. See the [conditions reference](https://cloud.google.com/dialogflow/cx/docs/reference/condition). + }, + ], + }, + ], + "enableGenerativeFallback": True or False, # If the flag is true, the agent will utilize LLM to generate a text response. If LLM generation fails, the defined responses in the fulfillment will be respected. This flag is only useful for fulfillments associated with no-match event handlers. + "messages": [ # The list of rich message responses to present to the user. + { # 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. + "channel": "A String", # The channel which the response is associated with. Clients can specify the channel via QueryParameters.channel, and only associated channel response will be returned. + "conversationSuccess": { # 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. # Indicates that the conversation succeeded. + "metadata": { # Custom metadata. Dialogflow doesn't impose any structure on this. + "a_key": "", # Properties of the object. + }, + }, + "endInteraction": { # 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. # Output only. A signal that indicates the interaction with the Dialogflow agent has ended. This message is generated by Dialogflow only when the conversation reaches `END_SESSION` page. It is not supposed to be defined by the user. It's guaranteed that there is at most one such message in each response. + }, + "knowledgeInfoCard": { # Represents info card response. If the response contains generative knowledge prediction, Dialogflow will return a payload with Infobot Messenger compatible info card. Otherwise, the info card response is skipped. # Represents info card for knowledge answers, to be better rendered in Dialogflow Messenger. + }, + "liveAgentHandoff": { # 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. # Hands off conversation to a human agent. + "metadata": { # Custom metadata for your handoff procedure. Dialogflow doesn't impose any structure on this. + "a_key": "", # Properties of the object. + }, + }, + "mixedAudio": { # 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. # Output only. An audio response message composed of both the synthesized Dialogflow agent responses and responses defined via play_audio. This message is generated by Dialogflow only and not supposed to be defined by the user. + "segments": [ # Segments this audio response is composed of. + { # Represents one segment of audio. + "allowPlaybackInterruption": True or False, # 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. + "audio": "A String", # Raw audio synthesized from the Dialogflow agent's response using the output config specified in the request. + "uri": "A String", # Client-specific URI that points to an audio clip accessible to the client. Dialogflow does not impose any validation on it. + }, + ], + }, + "outputAudioText": { # A text or ssml response that is preferentially used for TTS output audio synthesis, as described in the comment on the ResponseMessage message. # A text or ssml response that is preferentially used for TTS output audio synthesis, as described in the comment on the ResponseMessage message. + "allowPlaybackInterruption": True or False, # 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. + "ssml": "A String", # The SSML text to be synthesized. For more information, see [SSML](/speech/text-to-speech/docs/ssml). + "text": "A String", # The raw text to be synthesized. + }, + "payload": { # Returns a response containing a custom, platform-specific payload. + "a_key": "", # Properties of the object. + }, + "playAudio": { # Specifies an audio clip to be played by the client as part of the response. # Signal that the client should play an audio clip hosted at a client-specific URI. Dialogflow uses this to construct mixed_audio. However, Dialogflow itself does not try to read or process the URI in any way. + "allowPlaybackInterruption": True or False, # 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. + "audioUri": "A String", # Required. URI of the audio clip. Dialogflow does not impose any validation on this value. It is specific to the client that reads it. + }, + "telephonyTransferCall": { # Represents the signal that telles the client to transfer the phone call connected to the agent to a third-party endpoint. # A signal that the client should transfer the phone call connected to this agent to a third-party endpoint. + "phoneNumber": "A String", # Transfer the call to a phone number in [E.164 format](https://en.wikipedia.org/wiki/E.164). + }, + "text": { # The text response message. # Returns a text response. + "allowPlaybackInterruption": True or False, # 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. + "text": [ # Required. A collection of text responses. + "A String", + ], + }, + "toolCall": { # Represents a call of a specific tool's action with the specified inputs. # Returns the definition of a tool call that should be executed by the client. + "action": "A String", # Required. The name of the tool's action associated with this call. + "inputParameters": { # Optional. The action's input parameters. + "a_key": "", # Properties of the object. }, + "tool": "A String", # Required. The tool associated with this call. Format: `projects//locations//agents//tools/`. + }, + }, + ], + "returnPartialResponses": True or False, # Whether Dialogflow should return currently queued fulfillment response messages in streaming APIs. If a webhook is specified, it happens before Dialogflow invokes webhook. Warning: 1) This flag only affects streaming API. Responses are still queued and returned once in non-streaming API. 2) The flag can be enabled in any fulfillment but only the first 3 partial responses will be returned. You may only want to apply it to fulfillments that have slow webhooks. + "setParameterActions": [ # Set parameter values before executing the webhook. + { # Setting a parameter value. + "parameter": "A String", # Display name of the parameter. + "value": "", # The new value of the parameter. A null value clears the parameter. + }, + ], + "tag": "A String", # The value of this field will be populated in the WebhookRequest `fulfillmentInfo.tag` field by Dialogflow when the associated webhook is called. The tag is typically used by the webhook service to identify which fulfillment is being called, but it could be used for other purposes. This field is required if `webhook` is specified. + "webhook": "A String", # The webhook to call. Format: `projects//locations//agents//webhooks/`. + }, + }, + ], + }, + "matches": [ # Match results, if more than one, ordered descendingly by the confidence we have that the particular intent matches the query. + { # Represents one match result of MatchIntent. + "confidence": 3.14, # The confidence of this match. 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. + "event": "A String", # The event that matched the query. Filled for `EVENT`, `NO_MATCH` and `NO_INPUT` match types. + "intent": { # An intent represents a user's intent to interact with a conversational agent. You can provide information for the Dialogflow API to use to match user input to an intent by adding training phrases (i.e., examples of user input) to your intent. # The Intent that matched the query. Some, not all fields are filled in this message, including but not limited to: `name` and `display_name`. Only filled for `INTENT` match type. + "description": "A String", # Human readable description for better understanding an intent like its scope, content, result etc. Maximum character limit: 140 characters. + "displayName": "A String", # Required. The human-readable name of the intent, unique within the agent. + "isFallback": True or False, # Indicates whether this is a fallback intent. Currently only default fallback intent is allowed in the agent, which is added upon agent creation. Adding training phrases to fallback intent is useful in the case of requests that are mistakenly matched, since training phrases assigned to fallback intents act as negative examples that triggers no-match event. + "labels": { # The key/value metadata to label an intent. Labels can contain lowercase letters, digits and the symbols '-' and '_'. International characters are allowed, including letters from unicase alphabets. Keys must start with a letter. Keys and values can be no longer than 63 characters and no more than 128 bytes. Prefix "sys-" is reserved for Dialogflow defined labels. Currently allowed Dialogflow defined labels include: * sys-head * sys-contextual The above labels do not require value. "sys-head" means the intent is a head intent. "sys-contextual" means the intent is a contextual intent. + "a_key": "A String", + }, + "name": "A String", # The unique identifier of the intent. Required for the Intents.UpdateIntent method. Intents.CreateIntent populates the name automatically. Format: `projects//locations//agents//intents/`. + "parameters": [ # The collection of parameters associated with the intent. + { # Represents an intent parameter. + "entityType": "A String", # Required. The entity type of the parameter. Format: `projects/-/locations/-/agents/-/entityTypes/` for system entity types (for example, `projects/-/locations/-/agents/-/entityTypes/sys.date`), or `projects//locations//agents//entityTypes/` for developer entity types. + "id": "A String", # Required. The unique identifier of the parameter. This field is used by training phrases to annotate their parts. + "isList": True or False, # Indicates whether the parameter represents a list of values. + "redact": True or False, # Indicates whether the parameter content should be redacted in log. If redaction is enabled, the parameter content will be replaced by parameter name during logging. Note: the parameter content is subject to redaction if either parameter level redaction or entity type level redaction is enabled. + }, + ], + "priority": 42, # 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. + "trainingPhrases": [ # The collection of training phrases the agent is trained on to identify the intent. + { # Represents an example that the agent is trained on to identify the intent. + "id": "A String", # Output only. The unique identifier of the training phrase. + "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 `parameter_id` field is set. + { # Represents a part of a training phrase. + "parameterId": "A String", # The parameter used to annotate this part of the training phrase. This field is required for annotated parts of the training phrase. + "text": "A String", # Required. The text for this part. }, ], + "repeatCount": 42, # Indicates how many times this example was added to the intent. }, - "isList": True or False, # Indicates whether the parameter represents a list of values. - "redact": True or False, # Indicates whether the parameter content should be redacted in log. If redaction is enabled, the parameter content will be replaced by parameter name during logging. Note: the parameter content is subject to redaction if either parameter level redaction or entity type level redaction is enabled. - "required": True or False, # 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. - }, + ], + }, + "matchType": "A String", # Type of this Match. + "parameters": { # The collection of parameters extracted from the query. 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 then use map, otherwise, depending on the parameter value type, it could be one of string, number, boolean, null, list or map. * MapValue value: If parameter's entity type is a composite entity then use map from composite entity property names to property values, otherwise, use parameter value. + "a_key": "", # Properties of the object. + }, + "resolvedInput": "A String", # Final text input which was matched during MatchIntent. This value can be different from original input sent in request because of spelling correction or other processing. + }, + ], + "text": "A String", # If natural language text was provided as input, this field will contain a copy of the text. + "transcript": "A String", # If natural language speech audio was provided as input, this field will contain the transcript for the audio. + "triggerEvent": "A String", # If an event was provided as input, this field will contain a copy of the event name. + "triggerIntent": "A String", # If an intent was provided as input, this field will contain a copy of the intent identifier. Format: `projects//locations//agents//intents/`. +}
+
+ +
+ serverStreamingDetectIntent(session, body=None, x__xgafv=None) +
Processes a natural language query and returns structured, actionable data as a result through server-side streaming. Server-side streaming allows Dialogflow to send [partial responses](https://cloud.google.com/dialogflow/cx/docs/concept/fulfillment#partial-response) earlier in a single request.
+
+Args:
+  session: string, Required. The name of the session this query is sent to. Format: `projects//locations//agents//sessions/` or `projects//locations//agents//environments//sessions/`. If `Environment ID` is not specified, we assume default 'draft' environment. It's up to the API caller to choose an appropriate `Session ID`. It can be a random number or some type of session identifiers (preferably hashed). The length of the `Session ID` must not exceed 36 characters. For more information, see the [sessions guide](https://cloud.google.com/dialogflow/cx/docs/concept/session). Note: Always use agent versions for production traffic. See [Versions and environments](https://cloud.google.com/dialogflow/cx/docs/concept/version). (required)
+  body: object, The request body.
+    The object takes the form of:
+
+{ # The request to detect user's intent.
+  "outputAudioConfig": { # Instructs the speech synthesizer how to generate the output audio content. # Instructs the speech synthesizer how to generate the output audio.
+    "audioEncoding": "A String", # Required. Audio encoding of the synthesized audio content.
+    "sampleRateHertz": 42, # Optional. 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).
+    "synthesizeSpeechConfig": { # Configuration of how speech should be synthesized. # Optional. Configuration of how speech should be synthesized. If not specified, Agent.text_to_speech_settings is applied.
+      "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.
+        "A String",
       ],
+      "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.
+      "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.
+      "voice": { # Description of which voice to use for speech synthesis. # Optional. The desired voice of the synthesized audio.
+        "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. For the list of available voices, please refer to [Supported voices and languages](https://cloud.google.com/text-to-speech/docs/voices).
+        "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.
+      },
+      "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.
     },
-    "knowledgeConnectorSettings": { # The Knowledge Connector settings for this page or flow. This includes information such as the attached Knowledge Bases, and the way to execute fulfillment. # Optional. Knowledge connector configuration.
-      "dataStoreConnections": [ # Optional. List of related data store connections.
-        { # A data store connection. It represents a data store in Discovery Engine and the type of the contents it contains.
-          "dataStore": "A String", # The full name of the referenced data store. Formats: `projects/{project}/locations/{location}/collections/{collection}/dataStores/{data_store}` `projects/{project}/locations/{location}/dataStores/{data_store}`
-          "dataStoreType": "A String", # The type of the connected data store.
+  },
+  "queryInput": { # Represents the query input. It can contain one of: 1. A conversational query in the form of text. 2. An intent query that specifies which intent to trigger. 3. Natural language speech audio to be processed. 4. An event to be triggered. 5. DTMF digits to invoke an intent and fill in parameter value. 6. The results of a tool executed by the client. # Required. The input specification.
+    "audio": { # Represents the natural speech audio to be processed. # The natural language speech audio to be processed.
+      "audio": "A String", # The natural language speech audio to be processed. A single request can contain up to 2 minutes of speech audio data. The transcribed text cannot contain more than 256 bytes. For non-streaming audio detect intent, both `config` and `audio` must be provided. For streaming audio detect intent, `config` must be provided in the first request and `audio` must be provided in all following requests.
+      "config": { # Instructs the speech recognizer on how to process the audio content. # Required. Instructs the speech recognizer how to process the speech audio.
+        "audioEncoding": "A String", # Required. Audio encoding of the audio content to process.
+        "bargeInConfig": { # Configuration of the barge-in behavior. Barge-in instructs the API to return a detected utterance at a proper time while the client is playing back the response audio from a previous request. When the client sees the utterance, it should stop the playback and immediately get ready for receiving the responses for the current request. The barge-in handling requires the client to start streaming audio input as soon as it starts playing back the audio from the previous response. The playback is modeled into two phases: * No barge-in phase: which goes first and during which speech detection should not be carried out. * Barge-in phase: which follows the no barge-in phase and during which the API starts speech detection and may inform the client that an utterance has been detected. Note that no-speech event is not expected in this phase. The client provides this configuration in terms of the durations of those two phases. The durations are measured in terms of the audio length from the the start of the input audio. No-speech event is a response with END_OF_UTTERANCE without any transcript following up. # Configuration of barge-in behavior during the streaming of input audio.
+          "noBargeInDuration": "A String", # Duration that is not eligible for barge-in at the beginning of the input audio.
+          "totalDuration": "A String", # Total duration for the playback at the beginning of the input audio.
+        },
+        "enableWordInfo": True or False, # Optional. If `true`, Dialogflow returns SpeechWordInfo in StreamingRecognitionResult with information about the recognized speech words, e.g. start and end time offsets. If false or unspecified, Speech doesn't return any word-level information.
+        "model": "A String", # Optional. Which Speech model to select for the given request. For more information, see [Speech models](https://cloud.google.com/dialogflow/cx/docs/concept/speech-models).
+        "modelVariant": "A String", # Optional. Which variant of the Speech model to use.
+        "optOutConformerModelMigration": True or False, # If `true`, the request will opt out for STT conformer model migration. This field will be deprecated once force migration takes place in June 2024. Please refer to [Dialogflow CX Speech model migration](https://cloud.google.com/dialogflow/cx/docs/concept/speech-model-migration).
+        "phraseHints": [ # Optional. A list of strings containing words and phrases that the speech recognizer should recognize with higher likelihood. See [the Cloud Speech documentation](https://cloud.google.com/speech-to-text/docs/basics#phrase-hints) for more details.
+          "A String",
+        ],
+        "sampleRateHertz": 42, # Sample rate (in Hertz) of the audio content sent in the query. Refer to [Cloud Speech API documentation](https://cloud.google.com/speech-to-text/docs/basics) for more details.
+        "singleUtterance": True or False, # Optional. If `false` (default), recognition does not cease until the client closes the stream. If `true`, the recognizer will detect a single spoken utterance in input audio. Recognition ceases when it detects the audio's voice has stopped or paused. In this case, once a detected intent is received, the client should close the stream and start a new request with a new stream as needed. Note: This setting is relevant only for streaming methods.
+      },
+    },
+    "dtmf": { # Represents the input for dtmf event. # The DTMF event to be handled.
+      "digits": "A String", # The dtmf digits.
+      "finishDigit": "A String", # The finish digit (if any).
+    },
+    "event": { # Represents the event to trigger. # The event to be triggered.
+      "event": "A String", # Name of the event.
+    },
+    "intent": { # Represents the intent to trigger programmatically rather than as a result of natural language processing. # The intent to be triggered.
+      "intent": "A String", # Required. The unique identifier of the intent. Format: `projects//locations//agents//intents/`.
+    },
+    "languageCode": "A String", # Required. The language of the input. See [Language Support](https://cloud.google.com/dialogflow/cx/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.
+    "text": { # Represents the natural language text to be processed. # The natural language text to be processed.
+      "text": "A String", # Required. The UTF-8 encoded natural language text to be processed.
+    },
+    "toolCallResult": { # The result of calling a tool's action that has been executed by the client. # The results of a tool executed by the client.
+      "action": "A String", # Required. The name of the tool's action associated with this call.
+      "error": { # An error produced by the tool call. # The tool call's error.
+        "message": "A String", # Optional. The error message of the function.
+      },
+      "outputParameters": { # The tool call's output parameters.
+        "a_key": "", # Properties of the object.
+      },
+      "tool": "A String", # Required. The tool associated with this call. Format: `projects//locations//agents//tools/`.
+    },
+  },
+  "queryParams": { # Represents the parameters of a conversational query. # The parameters of this query.
+    "analyzeQueryTextSentiment": True or False, # Configures whether sentiment analysis should be performed. If not provided, sentiment analysis is not performed.
+    "channel": "A String", # The channel which this query is for. If specified, only the ResponseMessage associated with the channel will be returned. If no ResponseMessage is associated with the channel, it falls back to the ResponseMessage with unspecified channel. If unspecified, the ResponseMessage with unspecified channel will be returned.
+    "currentPage": "A String", # The unique identifier of the page to override the current page in the session. Format: `projects//locations//agents//flows//pages/`. If `current_page` is specified, the previous state of the session will be ignored by Dialogflow, including the previous page and the previous session parameters. In most cases, current_page and parameters should be configured together to direct a session to a specific state.
+    "currentPlaybook": "A String", # Optional. Start the session with the specified playbook. You can only specify the playbook at the beginning of the session. Otherwise, an error will be thrown. Format: `projects//locations//agents//playbooks/`.
+    "disableWebhook": True or False, # Whether to disable webhook calls for this request.
+    "endUserMetadata": { # Optional. Information about the end-user to improve the relevance and accuracy of generative answers. This will be interpreted and used by a language model, so, for good results, the data should be self-descriptive, and in a simple structure. Example: ```json { "subscription plan": "Business Premium Plus", "devices owned": [ {"model": "Google Pixel 7"}, {"model": "Google Pixel Tablet"} ] } ```
+      "a_key": "", # Properties of the object.
+    },
+    "flowVersions": [ # A list of flow versions to override for the request. Format: `projects//locations//agents//flows//versions/`. If version 1 of flow X is included in this list, the traffic of flow X will go through version 1 regardless of the version configuration in the environment. Each flow can have at most one version specified in this list.
+      "A String",
+    ],
+    "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.
+      "latitude": 3.14, # The latitude in degrees. It must be in the range [-90.0, +90.0].
+      "longitude": 3.14, # The longitude in degrees. It must be in the range [-180.0, +180.0].
+    },
+    "llmModelSettings": { # Settings for LLM models. # Optional. Use the specified LLM model settings for processing the request.
+      "model": "A String", # The selected LLM model.
+      "promptText": "A String", # The custom prompt to use.
+    },
+    "parameters": { # Additional parameters to be put into session parameters. To remove a parameter from the session, clients should explicitly set the parameter value to null. You can reference the session parameters in the agent with the following format: $session.params.parameter-id. 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 then use map, otherwise, depending on the parameter value type, it could be one of string, number, boolean, null, list or map. * MapValue value: If parameter's entity type is a composite entity then use map from composite entity property names to property values, otherwise, use parameter value.
+      "a_key": "", # Properties of the object.
+    },
+    "payload": { # This field can be used to pass custom data into the webhook associated with the agent. Arbitrary JSON objects are supported. Some integrations that query a Dialogflow agent may provide additional information in the payload. In particular, for the Dialogflow Phone Gateway integration, this field has the form: ``` { "telephony": { "caller_id": "+18558363987" } } ```
+      "a_key": "", # Properties of the object.
+    },
+    "populateDataStoreConnectionSignals": True or False, # Optional. If set to true and data stores are involved in serving the request then DetectIntentResponse.query_result.data_store_connection_signals will be filled with data that can help evaluations.
+    "searchConfig": { # Search configuration for UCS search queries. # Optional. Search configuration for UCS search queries.
+      "boostSpecs": [ # Optional. Boosting configuration for the datastores.
+        { # Boost specifications for data stores.
+          "dataStores": [ # Optional. Data Stores where the boosting configuration is applied. The full names of the referenced data stores. Formats: `projects/{project}/locations/{location}/collections/{collection}/dataStores/{data_store}` `projects/{project}/locations/{location}/dataStores/{data_store}
+            "A String",
+          ],
+          "spec": [ # Optional. A list of boosting specifications.
+            { # Boost specification to boost certain documents. A copy of google.cloud.discoveryengine.v1main.BoostSpec, field documentation is available at https://cloud.google.com/generative-ai-app-builder/docs/reference/rest/v1alpha/BoostSpec
+              "conditionBoostSpecs": [ # Optional. Condition boost specifications. If a document matches multiple conditions in the specifictions, boost scores from these specifications are all applied and combined in a non-linear way. Maximum number of specifications is 20.
+                { # Boost applies to documents which match a condition.
+                  "boost": 3.14, # Optional. Strength of the condition boost, which should be in [-1, 1]. Negative boost means demotion. Default is 0.0. Setting to 1.0 gives the document a big promotion. However, it does not necessarily mean that the boosted document will be the top result at all times, nor that other documents will be excluded. Results could still be shown even when none of them matches the condition. And results that are significantly more relevant to the search query can still trump your heavily favored but irrelevant documents. Setting to -1.0 gives the document a big demotion. However, results that are deeply relevant might still be shown. The document will have an upstream battle to get a fairly high ranking, but it is not blocked out completely. Setting to 0.0 means no boost applied. The boosting condition is ignored.
+                  "condition": "A String", # Optional. An expression which specifies a boost condition. The syntax and supported fields are the same as a filter expression. Examples: * To boost documents with document ID "doc_1" or "doc_2", and color "Red" or "Blue": * (id: ANY("doc_1", "doc_2")) AND (color: ANY("Red","Blue"))
+                },
+              ],
+            },
+          ],
         },
       ],
-      "enabled": True or False, # Whether Knowledge Connector is enabled or not.
-      "targetFlow": "A String", # The target flow to transition to. Format: `projects//locations//agents//flows/`.
-      "targetPage": "A String", # The target page to transition to. Format: `projects//locations//agents//flows//pages/`.
-      "triggerFulfillment": { # A fulfillment can do one or more of the following actions at the same time: * Generate rich message responses. * Set parameter values. * Call the webhook. Fulfillments can be called at various stages in the Page or Form lifecycle. For example, when a DetectIntentRequest drives a session to enter a new page, the page's entry fulfillment can add a static response to the QueryResult in the returning DetectIntentResponse, call the webhook (for example, to load user data from a database), or both. # The fulfillment to be triggered. When the answers from the Knowledge Connector are selected by Dialogflow, you can utitlize the request scoped parameter `$request.knowledge.answers` (contains up to the 5 highest confidence answers) and `$request.knowledge.questions` (contains the corresponding questions) to construct the fulfillment.
-        "advancedSettings": { # Hierarchical advanced settings for agent/flow/page/fulfillment/parameter. Settings exposed at lower level overrides the settings exposed at higher level. Overriding occurs at the sub-setting level. For example, the playback_interruption_settings at fulfillment level only overrides the playback_interruption_settings at the agent level, leaving other settings at the agent level unchanged. DTMF settings does not override each other. DTMF settings set at different levels define DTMF detections running in parallel. Hierarchy: Agent->Flow->Page->Fulfillment/Parameter. # Hierarchical advanced settings for this fulfillment. The settings exposed at the lower level overrides the settings exposed at the higher level.
-          "audioExportGcsDestination": { # Google Cloud Storage location for a Dialogflow operation that writes or exports objects (e.g. exported agent or transcripts) outside of Dialogflow. # If present, incoming audio is exported by Dialogflow to the configured Google Cloud Storage destination. Exposed at the following levels: - Agent level - Flow level
-            "uri": "A String", # Required. The Google Cloud Storage URI for the exported objects. A URI is of the form: `gs://bucket/object-name-or-prefix` Whether a full object name, or just a prefix, its usage depends on the Dialogflow operation.
-          },
-          "dtmfSettings": { # Define behaviors for DTMF (dual tone multi frequency). # Settings for DTMF. Exposed at the following levels: - Agent level - Flow level - Page level - Parameter level.
-            "enabled": True or False, # If true, incoming audio is processed for DTMF (dual tone multi frequency) events. For example, if the caller presses a button on their telephone keypad and DTMF processing is enabled, Dialogflow will detect the event (e.g. a "3" was pressed) in the incoming audio and pass the event to the bot to drive business logic (e.g. when 3 is pressed, return the account balance).
-            "endpointingTimeoutDuration": "A String", # Endpoint timeout setting for matching dtmf input to regex.
-            "finishDigit": "A String", # The digit that terminates a DTMF digit sequence.
-            "interdigitTimeoutDuration": "A String", # Interdigit timeout setting for matching dtmf input to regex.
-            "maxDigits": 42, # Max length of DTMF digits.
-          },
-          "loggingSettings": { # Define behaviors on logging. # Settings for logging. Settings for Dialogflow History, Contact Center messages, StackDriver logs, and speech logging. Exposed at the following levels: - Agent level.
-            "enableInteractionLogging": True or False, # If true, DF Interaction logging is currently enabled.
-            "enableStackdriverLogging": True or False, # If true, StackDriver logging is currently enabled.
+      "filterSpecs": [ # Optional. Filter configuration for the datastores.
+        { # Filter specifications for data stores.
+          "dataStores": [ # Optional. Data Stores where the boosting configuration is applied. The full names of the referenced data stores. Formats: `projects/{project}/locations/{location}/collections/{collection}/dataStores/{data_store}` `projects/{project}/locations/{location}/dataStores/{data_store}
+            "A String",
+          ],
+          "filter": "A String", # Optional. The filter expression to be applied. Expression syntax is documented at https://cloud.google.com/generative-ai-app-builder/docs/filter-search-metadata#filter-expression-syntax
+        },
+      ],
+    },
+    "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.
+      { # Session entity types are referred to as **User** entity types and are entities that are built for an individual user such as favorites, preferences, playlists, and so on. You can redefine a session entity type at the session level to extend or replace a custom entity type at the user session level (we refer to the entity types defined at the agent level as "custom entity types"). Note: session entity types apply to all queries, regardless of the language. For more information about entity types, see the [Dialogflow documentation](https://cloud.google.com/dialogflow/docs/entities-overview).
+        "entities": [ # Required. The collection of entities to override or supplement the custom entity type.
+          { # An **entity entry** for an associated entity type.
+            "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`.
+              "A String",
+            ],
+            "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 canonical 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).
           },
-          "speechSettings": { # Define behaviors of speech to text detection. # Settings for speech to text detection. Exposed at the following levels: - Agent level - Flow level - Page level - Parameter level
-            "endpointerSensitivity": 42, # Sensitivity of the speech model that detects the end of speech. Scale from 0 to 100.
-            "models": { # Mapping from language to Speech-to-Text model. The mapped Speech-to-Text model will be selected for requests from its corresponding language. For more information, see [Speech models](https://cloud.google.com/dialogflow/cx/docs/concept/speech-models).
-              "a_key": "A String",
-            },
-            "noSpeechTimeout": "A String", # Timeout before detecting no speech.
-            "useTimeoutBasedEndpointing": True or False, # Use timeout based endpointing, interpreting endpointer sensitivy as seconds of timeout value.
+        ],
+        "entityOverrideMode": "A String", # Required. Indicates whether the additional data should override or supplement the custom entity type definition.
+        "name": "A String", # Required. The unique identifier of the session entity type. Format: `projects//locations//agents//sessions//entityTypes/` or `projects//locations//agents//environments//sessions//entityTypes/`. If `Environment ID` is not specified, we assume default 'draft' environment.
+      },
+    ],
+    "sessionTtl": "A String", # Optional. Configure lifetime of the Dialogflow session. By default, a Dialogflow session remains active and its data is stored for 30 minutes after the last request is sent for the session. This value should be no longer than 1 day.
+    "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 the agent is used.
+    "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 Dialogflow web console. The headers defined within this field will overwrite the headers configured through 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.
+      "a_key": "A String",
+    },
+  },
+  "session": "A String", # Required. The name of the session this query is sent to. Format: `projects//locations//agents//sessions/` or `projects//locations//agents//environments//sessions/`. If `Environment ID` is not specified, we assume default 'draft' environment. It's up to the API caller to choose an appropriate `Session ID`. It can be a random number or some type of session identifiers (preferably hashed). The length of the `Session ID` must not exceed 36 characters. For more information, see the [sessions guide](https://cloud.google.com/dialogflow/cx/docs/concept/session). Note: Always use agent versions for production traffic. See [Versions and environments](https://cloud.google.com/dialogflow/cx/docs/concept/version).
+}
+
+  x__xgafv: string, V1 error format.
+    Allowed values
+      1 - v1 error format
+      2 - v2 error format
+
+Returns:
+  An object of the form:
+
+    { # The message returned from the DetectIntent method.
+  "allowCancellation": True or False, # Indicates whether the partial response can be cancelled when a later response arrives. e.g. if the agent specified some music as partial response, it can be cancelled.
+  "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.response_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.
+  "outputAudioConfig": { # Instructs the speech synthesizer how to generate the output audio content. # The config used by the speech synthesizer to generate the output audio.
+    "audioEncoding": "A String", # Required. Audio encoding of the synthesized audio content.
+    "sampleRateHertz": 42, # Optional. 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).
+    "synthesizeSpeechConfig": { # Configuration of how speech should be synthesized. # Optional. Configuration of how speech should be synthesized. If not specified, Agent.text_to_speech_settings is applied.
+      "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.
+        "A String",
+      ],
+      "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.
+      "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.
+      "voice": { # Description of which voice to use for speech synthesis. # Optional. The desired voice of the synthesized audio.
+        "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. For the list of available voices, please refer to [Supported voices and languages](https://cloud.google.com/text-to-speech/docs/voices).
+        "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.
+      },
+      "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.
+    },
+  },
+  "queryResult": { # Represents the result of a conversational query. # The result of the conversational query.
+    "advancedSettings": { # Hierarchical advanced settings for agent/flow/page/fulfillment/parameter. Settings exposed at lower level overrides the settings exposed at higher level. Overriding occurs at the sub-setting level. For example, the playback_interruption_settings at fulfillment level only overrides the playback_interruption_settings at the agent level, leaving other settings at the agent level unchanged. DTMF settings does not override each other. DTMF settings set at different levels define DTMF detections running in parallel. Hierarchy: Agent->Flow->Page->Fulfillment/Parameter. # Returns the current advanced settings including IVR settings. Even though the operations configured by these settings are performed by Dialogflow, the client may need to perform special logic at the moment. For example, if Dialogflow exports audio to Google Cloud Storage, then the client may need to wait for the resulting object to appear in the bucket before proceeding.
+      "audioExportGcsDestination": { # Google Cloud Storage location for a Dialogflow operation that writes or exports objects (e.g. exported agent or transcripts) outside of Dialogflow. # If present, incoming audio is exported by Dialogflow to the configured Google Cloud Storage destination. Exposed at the following levels: - Agent level - Flow level
+        "uri": "A String", # Required. The Google Cloud Storage URI for the exported objects. A URI is of the form: `gs://bucket/object-name-or-prefix` Whether a full object name, or just a prefix, its usage depends on the Dialogflow operation.
+      },
+      "dtmfSettings": { # Define behaviors for DTMF (dual tone multi frequency). # Settings for DTMF. Exposed at the following levels: - Agent level - Flow level - Page level - Parameter level.
+        "enabled": True or False, # If true, incoming audio is processed for DTMF (dual tone multi frequency) events. For example, if the caller presses a button on their telephone keypad and DTMF processing is enabled, Dialogflow will detect the event (e.g. a "3" was pressed) in the incoming audio and pass the event to the bot to drive business logic (e.g. when 3 is pressed, return the account balance).
+        "endpointingTimeoutDuration": "A String", # Endpoint timeout setting for matching dtmf input to regex.
+        "finishDigit": "A String", # The digit that terminates a DTMF digit sequence.
+        "interdigitTimeoutDuration": "A String", # Interdigit timeout setting for matching dtmf input to regex.
+        "maxDigits": 42, # Max length of DTMF digits.
+      },
+      "loggingSettings": { # Define behaviors on logging. # Settings for logging. Settings for Dialogflow History, Contact Center messages, StackDriver logs, and speech logging. Exposed at the following levels: - Agent level.
+        "enableInteractionLogging": True or False, # Enables DF Interaction logging.
+        "enableStackdriverLogging": True or False, # Enables StackDriver logging.
+      },
+      "speechSettings": { # Define behaviors of speech to text detection. # Settings for speech to text detection. Exposed at the following levels: - Agent level - Flow level - Page level - Parameter level
+        "endpointerSensitivity": 42, # Sensitivity of the speech model that detects the end of speech. Scale from 0 to 100.
+        "models": { # Mapping from language to Speech-to-Text model. The mapped Speech-to-Text model will be selected for requests from its corresponding language. For more information, see [Speech models](https://cloud.google.com/dialogflow/cx/docs/concept/speech-models).
+          "a_key": "A String",
+        },
+        "noSpeechTimeout": "A String", # Timeout before detecting no speech.
+        "useTimeoutBasedEndpointing": True or False, # Use timeout based endpointing, interpreting endpointer sensitivy as seconds of timeout value.
+      },
+    },
+    "allowAnswerFeedback": True or False, # Indicates whether the Thumbs up/Thumbs down rating controls are need to be shown for the response in the Dialogflow Messenger widget.
+    "currentFlow": { # Flows represents the conversation flows when you build your chatbot agent. A flow consists of many pages connected by the transition routes. Conversations always start with the built-in Start Flow (with an all-0 ID). Transition routes can direct the conversation session from the current flow (parent flow) to another flow (sub flow). When the sub flow is finished, Dialogflow will bring the session back to the parent flow, where the sub flow is started. Usually, when a transition route is followed by a matched intent, the intent will be "consumed". This means the intent won't activate more transition routes. However, when the followed transition route moves the conversation session into a different flow, the matched intent can be carried over and to be consumed in the target flow. # The current Flow. Some, not all fields are filled in this message, including but not limited to `name` and `display_name`.
+      "advancedSettings": { # Hierarchical advanced settings for agent/flow/page/fulfillment/parameter. Settings exposed at lower level overrides the settings exposed at higher level. Overriding occurs at the sub-setting level. For example, the playback_interruption_settings at fulfillment level only overrides the playback_interruption_settings at the agent level, leaving other settings at the agent level unchanged. DTMF settings does not override each other. DTMF settings set at different levels define DTMF detections running in parallel. Hierarchy: Agent->Flow->Page->Fulfillment/Parameter. # Hierarchical advanced settings for this flow. The settings exposed at the lower level overrides the settings exposed at the higher level.
+        "audioExportGcsDestination": { # Google Cloud Storage location for a Dialogflow operation that writes or exports objects (e.g. exported agent or transcripts) outside of Dialogflow. # If present, incoming audio is exported by Dialogflow to the configured Google Cloud Storage destination. Exposed at the following levels: - Agent level - Flow level
+          "uri": "A String", # Required. The Google Cloud Storage URI for the exported objects. A URI is of the form: `gs://bucket/object-name-or-prefix` Whether a full object name, or just a prefix, its usage depends on the Dialogflow operation.
+        },
+        "dtmfSettings": { # Define behaviors for DTMF (dual tone multi frequency). # Settings for DTMF. Exposed at the following levels: - Agent level - Flow level - Page level - Parameter level.
+          "enabled": True or False, # If true, incoming audio is processed for DTMF (dual tone multi frequency) events. For example, if the caller presses a button on their telephone keypad and DTMF processing is enabled, Dialogflow will detect the event (e.g. a "3" was pressed) in the incoming audio and pass the event to the bot to drive business logic (e.g. when 3 is pressed, return the account balance).
+          "endpointingTimeoutDuration": "A String", # Endpoint timeout setting for matching dtmf input to regex.
+          "finishDigit": "A String", # The digit that terminates a DTMF digit sequence.
+          "interdigitTimeoutDuration": "A String", # Interdigit timeout setting for matching dtmf input to regex.
+          "maxDigits": 42, # Max length of DTMF digits.
+        },
+        "loggingSettings": { # Define behaviors on logging. # Settings for logging. Settings for Dialogflow History, Contact Center messages, StackDriver logs, and speech logging. Exposed at the following levels: - Agent level.
+          "enableInteractionLogging": True or False, # Enables DF Interaction logging.
+          "enableStackdriverLogging": True or False, # Enables StackDriver logging.
+        },
+        "speechSettings": { # Define behaviors of speech to text detection. # Settings for speech to text detection. Exposed at the following levels: - Agent level - Flow level - Page level - Parameter level
+          "endpointerSensitivity": 42, # Sensitivity of the speech model that detects the end of speech. Scale from 0 to 100.
+          "models": { # Mapping from language to Speech-to-Text model. The mapped Speech-to-Text model will be selected for requests from its corresponding language. For more information, see [Speech models](https://cloud.google.com/dialogflow/cx/docs/concept/speech-models).
+            "a_key": "A String",
           },
+          "noSpeechTimeout": "A String", # Timeout before detecting no speech.
+          "useTimeoutBasedEndpointing": True or False, # Use timeout based endpointing, interpreting endpointer sensitivy as seconds of timeout value.
         },
-        "conditionalCases": [ # Conditional cases for this fulfillment.
-          { # A list of cascading if-else conditions. Cases are mutually exclusive. The first one with a matching condition is selected, all the rest ignored.
-            "cases": [ # A list of cascading if-else conditions.
-              { # Each case has a Boolean condition. When it is evaluated to be True, the corresponding messages will be selected and evaluated recursively.
-                "caseContent": [ # A list of case content.
-                  { # The list of messages or conditional cases to activate for this case.
-                    "additionalCases": # Object with schema name: GoogleCloudDialogflowCxV3beta1FulfillmentConditionalCases # Additional cases to be evaluated.
-                    "message": { # 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. # Returned message.
-                      "channel": "A String", # The channel which the response is associated with. Clients can specify the channel via QueryParameters.channel, and only associated channel response will be returned.
-                      "conversationSuccess": { # 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. # Indicates that the conversation succeeded.
-                        "metadata": { # Custom metadata. Dialogflow doesn't impose any structure on this.
-                          "a_key": "", # Properties of the object.
-                        },
-                      },
-                      "endInteraction": { # 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. # Output only. A signal that indicates the interaction with the Dialogflow agent has ended. This message is generated by Dialogflow only when the conversation reaches `END_SESSION` page. It is not supposed to be defined by the user. It's guaranteed that there is at most one such message in each response.
-                      },
-                      "knowledgeInfoCard": { # Represents info card response. If the response contains generative knowledge prediction, Dialogflow will return a payload with Infobot Messenger compatible info card. Otherwise, the info card response is skipped. # Represents info card for knowledge answers, to be better rendered in Dialogflow Messenger.
-                      },
-                      "liveAgentHandoff": { # 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. # Hands off conversation to a human agent.
-                        "metadata": { # Custom metadata for your handoff procedure. Dialogflow doesn't impose any structure on this.
-                          "a_key": "", # Properties of the object.
-                        },
-                      },
-                      "mixedAudio": { # 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. # Output only. An audio response message composed of both the synthesized Dialogflow agent responses and responses defined via play_audio. This message is generated by Dialogflow only and not supposed to be defined by the user.
-                        "segments": [ # Segments this audio response is composed of.
-                          { # Represents one segment of audio.
-                            "allowPlaybackInterruption": True or False, # 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.
-                            "audio": "A String", # Raw audio synthesized from the Dialogflow agent's response using the output config specified in the request.
-                            "uri": "A String", # Client-specific URI that points to an audio clip accessible to the client. Dialogflow does not impose any validation on it.
+      },
+      "description": "A String", # The description of the flow. The maximum length is 500 characters. If exceeded, the request is rejected.
+      "displayName": "A String", # Required. The human-readable name of the flow.
+      "eventHandlers": [ # A flow's event handlers serve two purposes: * They are responsible for handling events (e.g. no match, webhook errors) in the flow. * They are inherited by every page's event handlers, which can be used to handle common events regardless of the current page. Event handlers defined in the page have higher priority than those defined in the flow. Unlike transition_routes, these handlers are evaluated on a first-match basis. The first one that matches the event get executed, with the rest being ignored.
+        { # An event handler specifies an event that can be handled during a session. When the specified event happens, the following actions are taken in order: * If there is a `trigger_fulfillment` associated with the event, it will be called. * If there is a `target_page` associated with the event, the session will transition into the specified page. * If there is a `target_flow` associated with the event, the session will transition into the specified flow.
+          "event": "A String", # Required. The name of the event to handle.
+          "name": "A String", # Output only. The unique identifier of this event handler.
+          "targetFlow": "A String", # The target flow to transition to. Format: `projects//locations//agents//flows/`.
+          "targetPage": "A String", # The target page to transition to. Format: `projects//locations//agents//flows//pages/`.
+          "triggerFulfillment": { # A fulfillment can do one or more of the following actions at the same time: * Generate rich message responses. * Set parameter values. * Call the webhook. Fulfillments can be called at various stages in the Page or Form lifecycle. For example, when a DetectIntentRequest drives a session to enter a new page, the page's entry fulfillment can add a static response to the QueryResult in the returning DetectIntentResponse, call the webhook (for example, to load user data from a database), or both. # The fulfillment to call when the event occurs. Handling webhook errors with a fulfillment enabled with webhook could cause infinite loop. It is invalid to specify such fulfillment for a handler handling webhooks.
+            "advancedSettings": { # Hierarchical advanced settings for agent/flow/page/fulfillment/parameter. Settings exposed at lower level overrides the settings exposed at higher level. Overriding occurs at the sub-setting level. For example, the playback_interruption_settings at fulfillment level only overrides the playback_interruption_settings at the agent level, leaving other settings at the agent level unchanged. DTMF settings does not override each other. DTMF settings set at different levels define DTMF detections running in parallel. Hierarchy: Agent->Flow->Page->Fulfillment/Parameter. # Hierarchical advanced settings for this fulfillment. The settings exposed at the lower level overrides the settings exposed at the higher level.
+              "audioExportGcsDestination": { # Google Cloud Storage location for a Dialogflow operation that writes or exports objects (e.g. exported agent or transcripts) outside of Dialogflow. # If present, incoming audio is exported by Dialogflow to the configured Google Cloud Storage destination. Exposed at the following levels: - Agent level - Flow level
+                "uri": "A String", # Required. The Google Cloud Storage URI for the exported objects. A URI is of the form: `gs://bucket/object-name-or-prefix` Whether a full object name, or just a prefix, its usage depends on the Dialogflow operation.
+              },
+              "dtmfSettings": { # Define behaviors for DTMF (dual tone multi frequency). # Settings for DTMF. Exposed at the following levels: - Agent level - Flow level - Page level - Parameter level.
+                "enabled": True or False, # If true, incoming audio is processed for DTMF (dual tone multi frequency) events. For example, if the caller presses a button on their telephone keypad and DTMF processing is enabled, Dialogflow will detect the event (e.g. a "3" was pressed) in the incoming audio and pass the event to the bot to drive business logic (e.g. when 3 is pressed, return the account balance).
+                "endpointingTimeoutDuration": "A String", # Endpoint timeout setting for matching dtmf input to regex.
+                "finishDigit": "A String", # The digit that terminates a DTMF digit sequence.
+                "interdigitTimeoutDuration": "A String", # Interdigit timeout setting for matching dtmf input to regex.
+                "maxDigits": 42, # Max length of DTMF digits.
+              },
+              "loggingSettings": { # Define behaviors on logging. # Settings for logging. Settings for Dialogflow History, Contact Center messages, StackDriver logs, and speech logging. Exposed at the following levels: - Agent level.
+                "enableInteractionLogging": True or False, # Enables DF Interaction logging.
+                "enableStackdriverLogging": True or False, # Enables StackDriver logging.
+              },
+              "speechSettings": { # Define behaviors of speech to text detection. # Settings for speech to text detection. Exposed at the following levels: - Agent level - Flow level - Page level - Parameter level
+                "endpointerSensitivity": 42, # Sensitivity of the speech model that detects the end of speech. Scale from 0 to 100.
+                "models": { # Mapping from language to Speech-to-Text model. The mapped Speech-to-Text model will be selected for requests from its corresponding language. For more information, see [Speech models](https://cloud.google.com/dialogflow/cx/docs/concept/speech-models).
+                  "a_key": "A String",
+                },
+                "noSpeechTimeout": "A String", # Timeout before detecting no speech.
+                "useTimeoutBasedEndpointing": True or False, # Use timeout based endpointing, interpreting endpointer sensitivy as seconds of timeout value.
+              },
+            },
+            "conditionalCases": [ # Conditional cases for this fulfillment.
+              { # A list of cascading if-else conditions. Cases are mutually exclusive. The first one with a matching condition is selected, all the rest ignored.
+                "cases": [ # A list of cascading if-else conditions.
+                  { # Each case has a Boolean condition. When it is evaluated to be True, the corresponding messages will be selected and evaluated recursively.
+                    "caseContent": [ # A list of case content.
+                      { # The list of messages or conditional cases to activate for this case.
+                        "additionalCases": # Object with schema name: GoogleCloudDialogflowCxV3beta1FulfillmentConditionalCases # Additional cases to be evaluated.
+                        "message": { # 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. # Returned message.
+                          "channel": "A String", # The channel which the response is associated with. Clients can specify the channel via QueryParameters.channel, and only associated channel response will be returned.
+                          "conversationSuccess": { # 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. # Indicates that the conversation succeeded.
+                            "metadata": { # Custom metadata. Dialogflow doesn't impose any structure on this.
+                              "a_key": "", # Properties of the object.
+                            },
                           },
-                        ],
-                      },
-                      "outputAudioText": { # A text or ssml response that is preferentially used for TTS output audio synthesis, as described in the comment on the ResponseMessage message. # A text or ssml response that is preferentially used for TTS output audio synthesis, as described in the comment on the ResponseMessage message.
-                        "allowPlaybackInterruption": True or False, # 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.
-                        "ssml": "A String", # The SSML text to be synthesized. For more information, see [SSML](/speech/text-to-speech/docs/ssml).
-                        "text": "A String", # The raw text to be synthesized.
-                      },
-                      "payload": { # Returns a response containing a custom, platform-specific payload.
-                        "a_key": "", # Properties of the object.
-                      },
-                      "playAudio": { # Specifies an audio clip to be played by the client as part of the response. # Signal that the client should play an audio clip hosted at a client-specific URI. Dialogflow uses this to construct mixed_audio. However, Dialogflow itself does not try to read or process the URI in any way.
-                        "allowPlaybackInterruption": True or False, # 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.
-                        "audioUri": "A String", # Required. URI of the audio clip. Dialogflow does not impose any validation on this value. It is specific to the client that reads it.
-                      },
-                      "telephonyTransferCall": { # Represents the signal that telles the client to transfer the phone call connected to the agent to a third-party endpoint. # A signal that the client should transfer the phone call connected to this agent to a third-party endpoint.
-                        "phoneNumber": "A String", # Transfer the call to a phone number in [E.164 format](https://en.wikipedia.org/wiki/E.164).
-                      },
-                      "text": { # The text response message. # Returns a text response.
-                        "allowPlaybackInterruption": True or False, # 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.
-                        "text": [ # Required. A collection of text responses.
-                          "A String",
-                        ],
+                          "endInteraction": { # 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. # Output only. A signal that indicates the interaction with the Dialogflow agent has ended. This message is generated by Dialogflow only when the conversation reaches `END_SESSION` page. It is not supposed to be defined by the user. It's guaranteed that there is at most one such message in each response.
+                          },
+                          "knowledgeInfoCard": { # Represents info card response. If the response contains generative knowledge prediction, Dialogflow will return a payload with Infobot Messenger compatible info card. Otherwise, the info card response is skipped. # Represents info card for knowledge answers, to be better rendered in Dialogflow Messenger.
+                          },
+                          "liveAgentHandoff": { # 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. # Hands off conversation to a human agent.
+                            "metadata": { # Custom metadata for your handoff procedure. Dialogflow doesn't impose any structure on this.
+                              "a_key": "", # Properties of the object.
+                            },
+                          },
+                          "mixedAudio": { # 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. # Output only. An audio response message composed of both the synthesized Dialogflow agent responses and responses defined via play_audio. This message is generated by Dialogflow only and not supposed to be defined by the user.
+                            "segments": [ # Segments this audio response is composed of.
+                              { # Represents one segment of audio.
+                                "allowPlaybackInterruption": True or False, # 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.
+                                "audio": "A String", # Raw audio synthesized from the Dialogflow agent's response using the output config specified in the request.
+                                "uri": "A String", # Client-specific URI that points to an audio clip accessible to the client. Dialogflow does not impose any validation on it.
+                              },
+                            ],
+                          },
+                          "outputAudioText": { # A text or ssml response that is preferentially used for TTS output audio synthesis, as described in the comment on the ResponseMessage message. # A text or ssml response that is preferentially used for TTS output audio synthesis, as described in the comment on the ResponseMessage message.
+                            "allowPlaybackInterruption": True or False, # 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.
+                            "ssml": "A String", # The SSML text to be synthesized. For more information, see [SSML](/speech/text-to-speech/docs/ssml).
+                            "text": "A String", # The raw text to be synthesized.
+                          },
+                          "payload": { # Returns a response containing a custom, platform-specific payload.
+                            "a_key": "", # Properties of the object.
+                          },
+                          "playAudio": { # Specifies an audio clip to be played by the client as part of the response. # Signal that the client should play an audio clip hosted at a client-specific URI. Dialogflow uses this to construct mixed_audio. However, Dialogflow itself does not try to read or process the URI in any way.
+                            "allowPlaybackInterruption": True or False, # 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.
+                            "audioUri": "A String", # Required. URI of the audio clip. Dialogflow does not impose any validation on this value. It is specific to the client that reads it.
+                          },
+                          "telephonyTransferCall": { # Represents the signal that telles the client to transfer the phone call connected to the agent to a third-party endpoint. # A signal that the client should transfer the phone call connected to this agent to a third-party endpoint.
+                            "phoneNumber": "A String", # Transfer the call to a phone number in [E.164 format](https://en.wikipedia.org/wiki/E.164).
+                          },
+                          "text": { # The text response message. # Returns a text response.
+                            "allowPlaybackInterruption": True or False, # 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.
+                            "text": [ # Required. A collection of text responses.
+                              "A String",
+                            ],
+                          },
+                          "toolCall": { # Represents a call of a specific tool's action with the specified inputs. # Returns the definition of a tool call that should be executed by the client.
+                            "action": "A String", # Required. The name of the tool's action associated with this call.
+                            "inputParameters": { # Optional. The action's input parameters.
+                              "a_key": "", # Properties of the object.
+                            },
+                            "tool": "A String", # Required. The tool associated with this call. Format: `projects//locations//agents//tools/`.
+                          },
+                        },
                       },
-                    },
+                    ],
+                    "condition": "A String", # The condition to activate and select this case. Empty means the condition is always true. The condition is evaluated against form parameters or session parameters. See the [conditions reference](https://cloud.google.com/dialogflow/cx/docs/reference/condition).
                   },
                 ],
-                "condition": "A String", # The condition to activate and select this case. Empty means the condition is always true. The condition is evaluated against form parameters or session parameters. See the [conditions reference](https://cloud.google.com/dialogflow/cx/docs/reference/condition).
               },
             ],
-          },
-        ],
-        "enableGenerativeFallback": True or False, # If the flag is true, the agent will utilize LLM to generate a text response. If LLM generation fails, the defined responses in the fulfillment will be respected. This flag is only useful for fulfillments associated with no-match event handlers.
-        "messages": [ # The list of rich message responses to present to the user.
-          { # 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.
-            "channel": "A String", # The channel which the response is associated with. Clients can specify the channel via QueryParameters.channel, and only associated channel response will be returned.
-            "conversationSuccess": { # 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. # Indicates that the conversation succeeded.
-              "metadata": { # Custom metadata. Dialogflow doesn't impose any structure on this.
-                "a_key": "", # Properties of the object.
+            "enableGenerativeFallback": True or False, # If the flag is true, the agent will utilize LLM to generate a text response. If LLM generation fails, the defined responses in the fulfillment will be respected. This flag is only useful for fulfillments associated with no-match event handlers.
+            "messages": [ # The list of rich message responses to present to the user.
+              { # 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.
+                "channel": "A String", # The channel which the response is associated with. Clients can specify the channel via QueryParameters.channel, and only associated channel response will be returned.
+                "conversationSuccess": { # 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. # Indicates that the conversation succeeded.
+                  "metadata": { # Custom metadata. Dialogflow doesn't impose any structure on this.
+                    "a_key": "", # Properties of the object.
+                  },
+                },
+                "endInteraction": { # 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. # Output only. A signal that indicates the interaction with the Dialogflow agent has ended. This message is generated by Dialogflow only when the conversation reaches `END_SESSION` page. It is not supposed to be defined by the user. It's guaranteed that there is at most one such message in each response.
+                },
+                "knowledgeInfoCard": { # Represents info card response. If the response contains generative knowledge prediction, Dialogflow will return a payload with Infobot Messenger compatible info card. Otherwise, the info card response is skipped. # Represents info card for knowledge answers, to be better rendered in Dialogflow Messenger.
+                },
+                "liveAgentHandoff": { # 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. # Hands off conversation to a human agent.
+                  "metadata": { # Custom metadata for your handoff procedure. Dialogflow doesn't impose any structure on this.
+                    "a_key": "", # Properties of the object.
+                  },
+                },
+                "mixedAudio": { # 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. # Output only. An audio response message composed of both the synthesized Dialogflow agent responses and responses defined via play_audio. This message is generated by Dialogflow only and not supposed to be defined by the user.
+                  "segments": [ # Segments this audio response is composed of.
+                    { # Represents one segment of audio.
+                      "allowPlaybackInterruption": True or False, # 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.
+                      "audio": "A String", # Raw audio synthesized from the Dialogflow agent's response using the output config specified in the request.
+                      "uri": "A String", # Client-specific URI that points to an audio clip accessible to the client. Dialogflow does not impose any validation on it.
+                    },
+                  ],
+                },
+                "outputAudioText": { # A text or ssml response that is preferentially used for TTS output audio synthesis, as described in the comment on the ResponseMessage message. # A text or ssml response that is preferentially used for TTS output audio synthesis, as described in the comment on the ResponseMessage message.
+                  "allowPlaybackInterruption": True or False, # 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.
+                  "ssml": "A String", # The SSML text to be synthesized. For more information, see [SSML](/speech/text-to-speech/docs/ssml).
+                  "text": "A String", # The raw text to be synthesized.
+                },
+                "payload": { # Returns a response containing a custom, platform-specific payload.
+                  "a_key": "", # Properties of the object.
+                },
+                "playAudio": { # Specifies an audio clip to be played by the client as part of the response. # Signal that the client should play an audio clip hosted at a client-specific URI. Dialogflow uses this to construct mixed_audio. However, Dialogflow itself does not try to read or process the URI in any way.
+                  "allowPlaybackInterruption": True or False, # 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.
+                  "audioUri": "A String", # Required. URI of the audio clip. Dialogflow does not impose any validation on this value. It is specific to the client that reads it.
+                },
+                "telephonyTransferCall": { # Represents the signal that telles the client to transfer the phone call connected to the agent to a third-party endpoint. # A signal that the client should transfer the phone call connected to this agent to a third-party endpoint.
+                  "phoneNumber": "A String", # Transfer the call to a phone number in [E.164 format](https://en.wikipedia.org/wiki/E.164).
+                },
+                "text": { # The text response message. # Returns a text response.
+                  "allowPlaybackInterruption": True or False, # 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.
+                  "text": [ # Required. A collection of text responses.
+                    "A String",
+                  ],
+                },
+                "toolCall": { # Represents a call of a specific tool's action with the specified inputs. # Returns the definition of a tool call that should be executed by the client.
+                  "action": "A String", # Required. The name of the tool's action associated with this call.
+                  "inputParameters": { # Optional. The action's input parameters.
+                    "a_key": "", # Properties of the object.
+                  },
+                  "tool": "A String", # Required. The tool associated with this call. Format: `projects//locations//agents//tools/`.
+                },
               },
-            },
-            "endInteraction": { # 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. # Output only. A signal that indicates the interaction with the Dialogflow agent has ended. This message is generated by Dialogflow only when the conversation reaches `END_SESSION` page. It is not supposed to be defined by the user. It's guaranteed that there is at most one such message in each response.
-            },
-            "knowledgeInfoCard": { # Represents info card response. If the response contains generative knowledge prediction, Dialogflow will return a payload with Infobot Messenger compatible info card. Otherwise, the info card response is skipped. # Represents info card for knowledge answers, to be better rendered in Dialogflow Messenger.
-            },
-            "liveAgentHandoff": { # 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. # Hands off conversation to a human agent.
-              "metadata": { # Custom metadata for your handoff procedure. Dialogflow doesn't impose any structure on this.
-                "a_key": "", # Properties of the object.
+            ],
+            "returnPartialResponses": True or False, # Whether Dialogflow should return currently queued fulfillment response messages in streaming APIs. If a webhook is specified, it happens before Dialogflow invokes webhook. Warning: 1) This flag only affects streaming API. Responses are still queued and returned once in non-streaming API. 2) The flag can be enabled in any fulfillment but only the first 3 partial responses will be returned. You may only want to apply it to fulfillments that have slow webhooks.
+            "setParameterActions": [ # Set parameter values before executing the webhook.
+              { # Setting a parameter value.
+                "parameter": "A String", # Display name of the parameter.
+                "value": "", # The new value of the parameter. A null value clears the parameter.
               },
-            },
-            "mixedAudio": { # 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. # Output only. An audio response message composed of both the synthesized Dialogflow agent responses and responses defined via play_audio. This message is generated by Dialogflow only and not supposed to be defined by the user.
-              "segments": [ # Segments this audio response is composed of.
-                { # Represents one segment of audio.
-                  "allowPlaybackInterruption": True or False, # 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.
-                  "audio": "A String", # Raw audio synthesized from the Dialogflow agent's response using the output config specified in the request.
-                  "uri": "A String", # Client-specific URI that points to an audio clip accessible to the client. Dialogflow does not impose any validation on it.
-                },
-              ],
-            },
-            "outputAudioText": { # A text or ssml response that is preferentially used for TTS output audio synthesis, as described in the comment on the ResponseMessage message. # A text or ssml response that is preferentially used for TTS output audio synthesis, as described in the comment on the ResponseMessage message.
-              "allowPlaybackInterruption": True or False, # 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.
-              "ssml": "A String", # The SSML text to be synthesized. For more information, see [SSML](/speech/text-to-speech/docs/ssml).
-              "text": "A String", # The raw text to be synthesized.
-            },
-            "payload": { # Returns a response containing a custom, platform-specific payload.
-              "a_key": "", # Properties of the object.
-            },
-            "playAudio": { # Specifies an audio clip to be played by the client as part of the response. # Signal that the client should play an audio clip hosted at a client-specific URI. Dialogflow uses this to construct mixed_audio. However, Dialogflow itself does not try to read or process the URI in any way.
-              "allowPlaybackInterruption": True or False, # 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.
-              "audioUri": "A String", # Required. URI of the audio clip. Dialogflow does not impose any validation on this value. It is specific to the client that reads it.
-            },
-            "telephonyTransferCall": { # Represents the signal that telles the client to transfer the phone call connected to the agent to a third-party endpoint. # A signal that the client should transfer the phone call connected to this agent to a third-party endpoint.
-              "phoneNumber": "A String", # Transfer the call to a phone number in [E.164 format](https://en.wikipedia.org/wiki/E.164).
-            },
-            "text": { # The text response message. # Returns a text response.
-              "allowPlaybackInterruption": True or False, # 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.
-              "text": [ # Required. A collection of text responses.
-                "A String",
-              ],
-            },
-          },
-        ],
-        "returnPartialResponses": True or False, # Whether Dialogflow should return currently queued fulfillment response messages in streaming APIs. If a webhook is specified, it happens before Dialogflow invokes webhook. Warning: 1) This flag only affects streaming API. Responses are still queued and returned once in non-streaming API. 2) The flag can be enabled in any fulfillment but only the first 3 partial responses will be returned. You may only want to apply it to fulfillments that have slow webhooks.
-        "setParameterActions": [ # Set parameter values before executing the webhook.
-          { # Setting a parameter value.
-            "parameter": "A String", # Display name of the parameter.
-            "value": "", # The new value of the parameter. A null value clears the parameter.
+            ],
+            "tag": "A String", # The value of this field will be populated in the WebhookRequest `fulfillmentInfo.tag` field by Dialogflow when the associated webhook is called. The tag is typically used by the webhook service to identify which fulfillment is being called, but it could be used for other purposes. This field is required if `webhook` is specified.
+            "webhook": "A String", # The webhook to call. Format: `projects//locations//agents//webhooks/`.
+          },
+        },
+      ],
+      "knowledgeConnectorSettings": { # The Knowledge Connector settings for this page or flow. This includes information such as the attached Knowledge Bases, and the way to execute fulfillment. # Optional. Knowledge connector configuration.
+        "dataStoreConnections": [ # Optional. List of related data store connections.
+          { # A data store connection. It represents a data store in Discovery Engine and the type of the contents it contains.
+            "dataStore": "A String", # The full name of the referenced data store. Formats: `projects/{project}/locations/{location}/collections/{collection}/dataStores/{data_store}` `projects/{project}/locations/{location}/dataStores/{data_store}`
+            "dataStoreType": "A String", # The type of the connected data store.
           },
         ],
-        "tag": "A String", # The value of this field will be populated in the WebhookRequest `fulfillmentInfo.tag` field by Dialogflow when the associated webhook is called. The tag is typically used by the webhook service to identify which fulfillment is being called, but it could be used for other purposes. This field is required if `webhook` is specified.
-        "webhook": "A String", # The webhook to call. Format: `projects//locations//agents//webhooks/`.
-      },
-    },
-    "name": "A String", # The unique identifier of the page. Required for the Pages.UpdatePage method. Pages.CreatePage populates the name automatically. Format: `projects//locations//agents//flows//pages/`.
-    "transitionRouteGroups": [ # Ordered list of `TransitionRouteGroups` added to the page. Transition route groups must be unique within a page. If the page links both flow-level transition route groups and agent-level transition route groups, the flow-level ones will have higher priority and will be put before the agent-level ones. * If multiple transition routes within a page scope refer to the same intent, then the precedence order is: page's transition route -> page's transition route group -> flow's transition routes. * If multiple transition route groups within a page contain the same intent, then the first group in the ordered list takes precedence. Format:`projects//locations//agents//flows//transitionRouteGroups/` or `projects//locations//agents//transitionRouteGroups/` for agent-level groups.
-      "A String",
-    ],
-    "transitionRoutes": [ # A list of transitions for the transition rules of this page. They route the conversation to another page in the same flow, or another flow. When we are in a certain page, the TransitionRoutes are evalauted in the following order: * TransitionRoutes defined in the page with intent specified. * TransitionRoutes defined in the transition route groups with intent specified. * TransitionRoutes defined in flow with intent specified. * TransitionRoutes defined in the transition route groups with intent specified. * TransitionRoutes defined in the page with only condition specified. * TransitionRoutes defined in the transition route groups with only condition specified.
-      { # A transition route specifies a intent that can be matched and/or a data condition that can be evaluated during a session. When a specified transition is matched, the following actions are taken in order: * If there is a `trigger_fulfillment` associated with the transition, it will be called. * If there is a `target_page` associated with the transition, the session will transition into the specified page. * If there is a `target_flow` associated with the transition, the session will transition into the specified flow.
-        "condition": "A String", # The condition to evaluate against form parameters or session parameters. See the [conditions reference](https://cloud.google.com/dialogflow/cx/docs/reference/condition). At least one of `intent` or `condition` must be specified. When both `intent` and `condition` are specified, the transition can only happen when both are fulfilled.
-        "description": "A String", # Optional. The description of the transition route. The maximum length is 500 characters.
-        "intent": "A String", # The unique identifier of an Intent. Format: `projects//locations//agents//intents/`. Indicates that the transition can only happen when the given intent is matched. At least one of `intent` or `condition` must be specified. When both `intent` and `condition` are specified, the transition can only happen when both are fulfilled.
-        "name": "A String", # Output only. The unique identifier of this transition route.
+        "enabled": True or False, # Whether Knowledge Connector is enabled or not.
         "targetFlow": "A String", # The target flow to transition to. Format: `projects//locations//agents//flows/`.
         "targetPage": "A String", # The target page to transition to. Format: `projects//locations//agents//flows//pages/`.
-        "triggerFulfillment": { # A fulfillment can do one or more of the following actions at the same time: * Generate rich message responses. * Set parameter values. * Call the webhook. Fulfillments can be called at various stages in the Page or Form lifecycle. For example, when a DetectIntentRequest drives a session to enter a new page, the page's entry fulfillment can add a static response to the QueryResult in the returning DetectIntentResponse, call the webhook (for example, to load user data from a database), or both. # The fulfillment to call when the condition is satisfied. At least one of `trigger_fulfillment` and `target` must be specified. When both are defined, `trigger_fulfillment` is executed first.
+        "triggerFulfillment": { # A fulfillment can do one or more of the following actions at the same time: * Generate rich message responses. * Set parameter values. * Call the webhook. Fulfillments can be called at various stages in the Page or Form lifecycle. For example, when a DetectIntentRequest drives a session to enter a new page, the page's entry fulfillment can add a static response to the QueryResult in the returning DetectIntentResponse, call the webhook (for example, to load user data from a database), or both. # The fulfillment to be triggered. When the answers from the Knowledge Connector are selected by Dialogflow, you can utitlize the request scoped parameter `$request.knowledge.answers` (contains up to the 5 highest confidence answers) and `$request.knowledge.questions` (contains the corresponding questions) to construct the fulfillment.
           "advancedSettings": { # Hierarchical advanced settings for agent/flow/page/fulfillment/parameter. Settings exposed at lower level overrides the settings exposed at higher level. Overriding occurs at the sub-setting level. For example, the playback_interruption_settings at fulfillment level only overrides the playback_interruption_settings at the agent level, leaving other settings at the agent level unchanged. DTMF settings does not override each other. DTMF settings set at different levels define DTMF detections running in parallel. Hierarchy: Agent->Flow->Page->Fulfillment/Parameter. # Hierarchical advanced settings for this fulfillment. The settings exposed at the lower level overrides the settings exposed at the higher level.
             "audioExportGcsDestination": { # Google Cloud Storage location for a Dialogflow operation that writes or exports objects (e.g. exported agent or transcripts) outside of Dialogflow. # If present, incoming audio is exported by Dialogflow to the configured Google Cloud Storage destination. Exposed at the following levels: - Agent level - Flow level
               "uri": "A String", # Required. The Google Cloud Storage URI for the exported objects. A URI is of the form: `gs://bucket/object-name-or-prefix` Whether a full object name, or just a prefix, its usage depends on the Dialogflow operation.
@@ -3886,8 +6050,8 @@ 

Method Details

"maxDigits": 42, # Max length of DTMF digits. }, "loggingSettings": { # Define behaviors on logging. # Settings for logging. Settings for Dialogflow History, Contact Center messages, StackDriver logs, and speech logging. Exposed at the following levels: - Agent level. - "enableInteractionLogging": True or False, # If true, DF Interaction logging is currently enabled. - "enableStackdriverLogging": True or False, # If true, StackDriver logging is currently enabled. + "enableInteractionLogging": True or False, # Enables DF Interaction logging. + "enableStackdriverLogging": True or False, # Enables StackDriver logging. }, "speechSettings": { # Define behaviors of speech to text detection. # Settings for speech to text detection. Exposed at the following levels: - Agent level - Flow level - Page level - Parameter level "endpointerSensitivity": 42, # Sensitivity of the speech model that detects the end of speech. Scale from 0 to 100. @@ -3951,6 +6115,13 @@

Method Details

"A String", ], }, + "toolCall": { # Represents a call of a specific tool's action with the specified inputs. # Returns the definition of a tool call that should be executed by the client. + "action": "A String", # Required. The name of the tool's action associated with this call. + "inputParameters": { # Optional. The action's input parameters. + "a_key": "", # Properties of the object. + }, + "tool": "A String", # Required. The tool associated with this call. Format: `projects//locations//agents//tools/`. + }, }, }, ], @@ -4007,255 +6178,212 @@

Method Details

"A String", ], }, - }, - ], - "returnPartialResponses": True or False, # Whether Dialogflow should return currently queued fulfillment response messages in streaming APIs. If a webhook is specified, it happens before Dialogflow invokes webhook. Warning: 1) This flag only affects streaming API. Responses are still queued and returned once in non-streaming API. 2) The flag can be enabled in any fulfillment but only the first 3 partial responses will be returned. You may only want to apply it to fulfillments that have slow webhooks. - "setParameterActions": [ # Set parameter values before executing the webhook. - { # Setting a parameter value. - "parameter": "A String", # Display name of the parameter. - "value": "", # The new value of the parameter. A null value clears the parameter. - }, - ], - "tag": "A String", # The value of this field will be populated in the WebhookRequest `fulfillmentInfo.tag` field by Dialogflow when the associated webhook is called. The tag is typically used by the webhook service to identify which fulfillment is being called, but it could be used for other purposes. This field is required if `webhook` is specified. - "webhook": "A String", # The webhook to call. Format: `projects//locations//agents//webhooks/`. - }, - }, - ], - }, - "matches": [ # Match results, if more than one, ordered descendingly by the confidence we have that the particular intent matches the query. - { # Represents one match result of MatchIntent. - "confidence": 3.14, # The confidence of this match. 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. - "event": "A String", # The event that matched the query. Filled for `EVENT`, `NO_MATCH` and `NO_INPUT` match types. - "intent": { # An intent represents a user's intent to interact with a conversational agent. You can provide information for the Dialogflow API to use to match user input to an intent by adding training phrases (i.e., examples of user input) to your intent. # The Intent that matched the query. Some, not all fields are filled in this message, including but not limited to: `name` and `display_name`. Only filled for `INTENT` match type. - "description": "A String", # Human readable description for better understanding an intent like its scope, content, result etc. Maximum character limit: 140 characters. - "displayName": "A String", # Required. The human-readable name of the intent, unique within the agent. - "isFallback": True or False, # Indicates whether this is a fallback intent. Currently only default fallback intent is allowed in the agent, which is added upon agent creation. Adding training phrases to fallback intent is useful in the case of requests that are mistakenly matched, since training phrases assigned to fallback intents act as negative examples that triggers no-match event. - "labels": { # The key/value metadata to label an intent. Labels can contain lowercase letters, digits and the symbols '-' and '_'. International characters are allowed, including letters from unicase alphabets. Keys must start with a letter. Keys and values can be no longer than 63 characters and no more than 128 bytes. Prefix "sys-" is reserved for Dialogflow defined labels. Currently allowed Dialogflow defined labels include: * sys-head * sys-contextual The above labels do not require value. "sys-head" means the intent is a head intent. "sys-contextual" means the intent is a contextual intent. - "a_key": "A String", - }, - "name": "A String", # The unique identifier of the intent. Required for the Intents.UpdateIntent method. Intents.CreateIntent populates the name automatically. Format: `projects//locations//agents//intents/`. - "parameters": [ # The collection of parameters associated with the intent. - { # Represents an intent parameter. - "entityType": "A String", # Required. The entity type of the parameter. Format: `projects/-/locations/-/agents/-/entityTypes/` for system entity types (for example, `projects/-/locations/-/agents/-/entityTypes/sys.date`), or `projects//locations//agents//entityTypes/` for developer entity types. - "id": "A String", # Required. The unique identifier of the parameter. This field is used by training phrases to annotate their parts. - "isList": True or False, # Indicates whether the parameter represents a list of values. - "redact": True or False, # Indicates whether the parameter content should be redacted in log. If redaction is enabled, the parameter content will be replaced by parameter name during logging. Note: the parameter content is subject to redaction if either parameter level redaction or entity type level redaction is enabled. - }, - ], - "priority": 42, # 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. - "trainingPhrases": [ # The collection of training phrases the agent is trained on to identify the intent. - { # Represents an example that the agent is trained on to identify the intent. - "id": "A String", # Output only. The unique identifier of the training phrase. - "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 `parameter_id` field is set. - { # Represents a part of a training phrase. - "parameterId": "A String", # The parameter used to annotate this part of the training phrase. This field is required for annotated parts of the training phrase. - "text": "A String", # Required. The text for this part. - }, - ], - "repeatCount": 42, # Indicates how many times this example was added to the intent. - }, - ], - }, - "matchType": "A String", # Type of this Match. - "parameters": { # The collection of parameters extracted from the query. 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 then use map, otherwise, depending on the parameter value type, it could be one of string, number, boolean, null, list or map. * MapValue value: If parameter's entity type is a composite entity then use map from composite entity property names to property values, otherwise, use parameter value. - "a_key": "", # Properties of the object. - }, - "resolvedInput": "A String", # Final text input which was matched during MatchIntent. This value can be different from original input sent in request because of spelling correction or other processing. - }, - ], - "text": "A String", # If natural language text was provided as input, this field will contain a copy of the text. - "transcript": "A String", # If natural language speech audio was provided as input, this field will contain the transcript for the audio. - "triggerEvent": "A String", # If an event was provided as input, this field will contain a copy of the event name. - "triggerIntent": "A String", # If an intent was provided as input, this field will contain a copy of the intent identifier. Format: `projects//locations//agents//intents/`. -}
-
- -
- serverStreamingDetectIntent(session, body=None, x__xgafv=None) -
Processes a natural language query and returns structured, actionable data as a result through server-side streaming. Server-side streaming allows Dialogflow to send [partial responses](https://cloud.google.com/dialogflow/cx/docs/concept/fulfillment#partial-response) earlier in a single request.
-
-Args:
-  session: string, Required. The name of the session this query is sent to. Format: `projects//locations//agents//sessions/` or `projects//locations//agents//environments//sessions/`. If `Environment ID` is not specified, we assume default 'draft' environment. It's up to the API caller to choose an appropriate `Session ID`. It can be a random number or some type of session identifiers (preferably hashed). The length of the `Session ID` must not exceed 36 characters. For more information, see the [sessions guide](https://cloud.google.com/dialogflow/cx/docs/concept/session). Note: Always use agent versions for production traffic. See [Versions and environments](https://cloud.google.com/dialogflow/cx/docs/concept/version). (required)
-  body: object, The request body.
-    The object takes the form of:
-
-{ # The request to detect user's intent.
-  "outputAudioConfig": { # Instructs the speech synthesizer how to generate the output audio content. # Instructs the speech synthesizer how to generate the output audio.
-    "audioEncoding": "A String", # Required. Audio encoding of the synthesized audio content.
-    "sampleRateHertz": 42, # Optional. 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).
-    "synthesizeSpeechConfig": { # Configuration of how speech should be synthesized. # Optional. Configuration of how speech should be synthesized. If not specified, Agent.text_to_speech_settings is applied.
-      "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.
-        "A String",
-      ],
-      "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.
-      "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.
-      "voice": { # Description of which voice to use for speech synthesis. # Optional. The desired voice of the synthesized audio.
-        "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. For the list of available voices, please refer to [Supported voices and languages](https://cloud.google.com/text-to-speech/docs/voices).
-        "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.
-      },
-      "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.
-    },
-  },
-  "queryInput": { # Represents the query input. It can contain one of: 1. A conversational query in the form of text. 2. An intent query that specifies which intent to trigger. 3. Natural language speech audio to be processed. 4. An event to be triggered. 5. DTMF digits to invoke an intent and fill in parameter value. 6. The results of a tool executed by the client. # Required. The input specification.
-    "audio": { # Represents the natural speech audio to be processed. # The natural language speech audio to be processed.
-      "audio": "A String", # The natural language speech audio to be processed. A single request can contain up to 2 minutes of speech audio data. The transcribed text cannot contain more than 256 bytes. For non-streaming audio detect intent, both `config` and `audio` must be provided. For streaming audio detect intent, `config` must be provided in the first request and `audio` must be provided in all following requests.
-      "config": { # Instructs the speech recognizer on how to process the audio content. # Required. Instructs the speech recognizer how to process the speech audio.
-        "audioEncoding": "A String", # Required. Audio encoding of the audio content to process.
-        "bargeInConfig": { # Configuration of the barge-in behavior. Barge-in instructs the API to return a detected utterance at a proper time while the client is playing back the response audio from a previous request. When the client sees the utterance, it should stop the playback and immediately get ready for receiving the responses for the current request. The barge-in handling requires the client to start streaming audio input as soon as it starts playing back the audio from the previous response. The playback is modeled into two phases: * No barge-in phase: which goes first and during which speech detection should not be carried out. * Barge-in phase: which follows the no barge-in phase and during which the API starts speech detection and may inform the client that an utterance has been detected. Note that no-speech event is not expected in this phase. The client provides this configuration in terms of the durations of those two phases. The durations are measured in terms of the audio length from the the start of the input audio. No-speech event is a response with END_OF_UTTERANCE without any transcript following up. # Configuration of barge-in behavior during the streaming of input audio.
-          "noBargeInDuration": "A String", # Duration that is not eligible for barge-in at the beginning of the input audio.
-          "totalDuration": "A String", # Total duration for the playback at the beginning of the input audio.
-        },
-        "enableWordInfo": True or False, # Optional. If `true`, Dialogflow returns SpeechWordInfo in StreamingRecognitionResult with information about the recognized speech words, e.g. start and end time offsets. If false or unspecified, Speech doesn't return any word-level information.
-        "model": "A String", # Optional. Which Speech model to select for the given request. For more information, see [Speech models](https://cloud.google.com/dialogflow/cx/docs/concept/speech-models).
-        "modelVariant": "A String", # Optional. Which variant of the Speech model to use.
-        "optOutConformerModelMigration": True or False, # If `true`, the request will opt out for STT conformer model migration. This field will be deprecated once force migration takes place in June 2024. Please refer to [Dialogflow CX Speech model migration](https://cloud.google.com/dialogflow/cx/docs/concept/speech-model-migration).
-        "phraseHints": [ # Optional. A list of strings containing words and phrases that the speech recognizer should recognize with higher likelihood. See [the Cloud Speech documentation](https://cloud.google.com/speech-to-text/docs/basics#phrase-hints) for more details.
-          "A String",
-        ],
-        "sampleRateHertz": 42, # Sample rate (in Hertz) of the audio content sent in the query. Refer to [Cloud Speech API documentation](https://cloud.google.com/speech-to-text/docs/basics) for more details.
-        "singleUtterance": True or False, # Optional. If `false` (default), recognition does not cease until the client closes the stream. If `true`, the recognizer will detect a single spoken utterance in input audio. Recognition ceases when it detects the audio's voice has stopped or paused. In this case, once a detected intent is received, the client should close the stream and start a new request with a new stream as needed. Note: This setting is relevant only for streaming methods.
-      },
-    },
-    "dtmf": { # Represents the input for dtmf event. # The DTMF event to be handled.
-      "digits": "A String", # The dtmf digits.
-      "finishDigit": "A String", # The finish digit (if any).
-    },
-    "event": { # Represents the event to trigger. # The event to be triggered.
-      "event": "A String", # Name of the event.
-    },
-    "intent": { # Represents the intent to trigger programmatically rather than as a result of natural language processing. # The intent to be triggered.
-      "intent": "A String", # Required. The unique identifier of the intent. Format: `projects//locations//agents//intents/`.
-    },
-    "languageCode": "A String", # Required. The language of the input. See [Language Support](https://cloud.google.com/dialogflow/cx/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.
-    "text": { # Represents the natural language text to be processed. # The natural language text to be processed.
-      "text": "A String", # Required. The UTF-8 encoded natural language text to be processed.
-    },
-  },
-  "queryParams": { # Represents the parameters of a conversational query. # The parameters of this query.
-    "analyzeQueryTextSentiment": True or False, # Configures whether sentiment analysis should be performed. If not provided, sentiment analysis is not performed.
-    "channel": "A String", # The channel which this query is for. If specified, only the ResponseMessage associated with the channel will be returned. If no ResponseMessage is associated with the channel, it falls back to the ResponseMessage with unspecified channel. If unspecified, the ResponseMessage with unspecified channel will be returned.
-    "currentPage": "A String", # The unique identifier of the page to override the current page in the session. Format: `projects//locations//agents//flows//pages/`. If `current_page` is specified, the previous state of the session will be ignored by Dialogflow, including the previous page and the previous session parameters. In most cases, current_page and parameters should be configured together to direct a session to a specific state.
-    "disableWebhook": True or False, # Whether to disable webhook calls for this request.
-    "endUserMetadata": { # Optional. Information about the end-user to improve the relevance and accuracy of generative answers. This will be interpreted and used by a language model, so, for good results, the data should be self-descriptive, and in a simple structure. Example: ```json { "subscription plan": "Business Premium Plus", "devices owned": [ {"model": "Google Pixel 7"}, {"model": "Google Pixel Tablet"} ] } ```
-      "a_key": "", # Properties of the object.
-    },
-    "flowVersions": [ # A list of flow versions to override for the request. Format: `projects//locations//agents//flows//versions/`. If version 1 of flow X is included in this list, the traffic of flow X will go through version 1 regardless of the version configuration in the environment. Each flow can have at most one version specified in this list.
-      "A String",
-    ],
-    "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.
-      "latitude": 3.14, # The latitude in degrees. It must be in the range [-90.0, +90.0].
-      "longitude": 3.14, # The longitude in degrees. It must be in the range [-180.0, +180.0].
-    },
-    "parameters": { # Additional parameters to be put into session parameters. To remove a parameter from the session, clients should explicitly set the parameter value to null. You can reference the session parameters in the agent with the following format: $session.params.parameter-id. 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 then use map, otherwise, depending on the parameter value type, it could be one of string, number, boolean, null, list or map. * MapValue value: If parameter's entity type is a composite entity then use map from composite entity property names to property values, otherwise, use parameter value.
-      "a_key": "", # Properties of the object.
-    },
-    "payload": { # This field can be used to pass custom data into the webhook associated with the agent. Arbitrary JSON objects are supported. Some integrations that query a Dialogflow agent may provide additional information in the payload. In particular, for the Dialogflow Phone Gateway integration, this field has the form: ``` { "telephony": { "caller_id": "+18558363987" } } ```
-      "a_key": "", # Properties of the object.
-    },
-    "populateDataStoreConnectionSignals": True or False, # Optional. If set to true and data stores are involved in serving the request then DetectIntentResponse.query_result.data_store_connection_signals will be filled with data that can help evaluations.
-    "searchConfig": { # Search configuration for UCS search queries. # Optional. Search configuration for UCS search queries.
-      "boostSpecs": [ # Optional. Boosting configuration for the datastores.
-        { # Boost specifications for data stores.
-          "dataStores": [ # Optional. Data Stores where the boosting configuration is applied. The full names of the referenced data stores. Formats: `projects/{project}/locations/{location}/collections/{collection}/dataStores/{data_store}` `projects/{project}/locations/{location}/dataStores/{data_store}
-            "A String",
-          ],
-          "spec": [ # Optional. A list of boosting specifications.
-            { # Boost specification to boost certain documents. A copy of google.cloud.discoveryengine.v1main.BoostSpec, field documentation is available at https://cloud.google.com/generative-ai-app-builder/docs/reference/rest/v1alpha/BoostSpec
-              "conditionBoostSpecs": [ # Optional. Condition boost specifications. If a document matches multiple conditions in the specifictions, boost scores from these specifications are all applied and combined in a non-linear way. Maximum number of specifications is 20.
-                { # Boost applies to documents which match a condition.
-                  "boost": 3.14, # Optional. Strength of the condition boost, which should be in [-1, 1]. Negative boost means demotion. Default is 0.0. Setting to 1.0 gives the document a big promotion. However, it does not necessarily mean that the boosted document will be the top result at all times, nor that other documents will be excluded. Results could still be shown even when none of them matches the condition. And results that are significantly more relevant to the search query can still trump your heavily favored but irrelevant documents. Setting to -1.0 gives the document a big demotion. However, results that are deeply relevant might still be shown. The document will have an upstream battle to get a fairly high ranking, but it is not blocked out completely. Setting to 0.0 means no boost applied. The boosting condition is ignored.
-                  "condition": "A String", # Optional. An expression which specifies a boost condition. The syntax and supported fields are the same as a filter expression. Examples: * To boost documents with document ID "doc_1" or "doc_2", and color "Red" or "Blue": * (id: ANY("doc_1", "doc_2")) AND (color: ANY("Red","Blue"))
+              "toolCall": { # Represents a call of a specific tool's action with the specified inputs. # Returns the definition of a tool call that should be executed by the client.
+                "action": "A String", # Required. The name of the tool's action associated with this call.
+                "inputParameters": { # Optional. The action's input parameters.
+                  "a_key": "", # Properties of the object.
                 },
-              ],
+                "tool": "A String", # Required. The tool associated with this call. Format: `projects//locations//agents//tools/`.
+              },
             },
           ],
-        },
-      ],
-      "filterSpecs": [ # Optional. Filter configuration for the datastores.
-        { # Filter specifications for data stores.
-          "dataStores": [ # Optional. Data Stores where the boosting configuration is applied. The full names of the referenced data stores. Formats: `projects/{project}/locations/{location}/collections/{collection}/dataStores/{data_store}` `projects/{project}/locations/{location}/dataStores/{data_store}
-            "A String",
-          ],
-          "filter": "A String", # Optional. The filter expression to be applied. Expression syntax is documented at https://cloud.google.com/generative-ai-app-builder/docs/filter-search-metadata#filter-expression-syntax
-        },
-      ],
-    },
-    "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.
-      { # Session entity types are referred to as **User** entity types and are entities that are built for an individual user such as favorites, preferences, playlists, and so on. You can redefine a session entity type at the session level to extend or replace a custom entity type at the user session level (we refer to the entity types defined at the agent level as "custom entity types"). Note: session entity types apply to all queries, regardless of the language. For more information about entity types, see the [Dialogflow documentation](https://cloud.google.com/dialogflow/docs/entities-overview).
-        "entities": [ # Required. The collection of entities to override or supplement the custom entity type.
-          { # An **entity entry** for an associated entity type.
-            "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`.
-              "A String",
-            ],
-            "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 canonical 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).
-          },
-        ],
-        "entityOverrideMode": "A String", # Required. Indicates whether the additional data should override or supplement the custom entity type definition.
-        "name": "A String", # Required. The unique identifier of the session entity type. Format: `projects//locations//agents//sessions//entityTypes/` or `projects//locations//agents//environments//sessions//entityTypes/`. If `Environment ID` is not specified, we assume default 'draft' environment.
-      },
-    ],
-    "sessionTtl": "A String", # Optional. Configure lifetime of the Dialogflow session. By default, a Dialogflow session remains active and its data is stored for 30 minutes after the last request is sent for the session. This value should be no longer than 1 day.
-    "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 the agent is used.
-    "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 Dialogflow web console. The headers defined within this field will overwrite the headers configured through 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.
-      "a_key": "A String",
-    },
-  },
-  "session": "A String", # Required. The name of the session this query is sent to. Format: `projects//locations//agents//sessions/` or `projects//locations//agents//environments//sessions/`. If `Environment ID` is not specified, we assume default 'draft' environment. It's up to the API caller to choose an appropriate `Session ID`. It can be a random number or some type of session identifiers (preferably hashed). The length of the `Session ID` must not exceed 36 characters. For more information, see the [sessions guide](https://cloud.google.com/dialogflow/cx/docs/concept/session). Note: Always use agent versions for production traffic. See [Versions and environments](https://cloud.google.com/dialogflow/cx/docs/concept/version).
-}
-
-  x__xgafv: string, V1 error format.
-    Allowed values
-      1 - v1 error format
-      2 - v2 error format
-
-Returns:
-  An object of the form:
-
-    { # The message returned from the DetectIntent method.
-  "allowCancellation": True or False, # Indicates whether the partial response can be cancelled when a later response arrives. e.g. if the agent specified some music as partial response, it can be cancelled.
-  "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.response_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.
-  "outputAudioConfig": { # Instructs the speech synthesizer how to generate the output audio content. # The config used by the speech synthesizer to generate the output audio.
-    "audioEncoding": "A String", # Required. Audio encoding of the synthesized audio content.
-    "sampleRateHertz": 42, # Optional. 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).
-    "synthesizeSpeechConfig": { # Configuration of how speech should be synthesized. # Optional. Configuration of how speech should be synthesized. If not specified, Agent.text_to_speech_settings is applied.
-      "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.
-        "A String",
-      ],
-      "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.
-      "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.
-      "voice": { # Description of which voice to use for speech synthesis. # Optional. The desired voice of the synthesized audio.
-        "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. For the list of available voices, please refer to [Supported voices and languages](https://cloud.google.com/text-to-speech/docs/voices).
-        "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.
-      },
-      "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.
-    },
-  },
-  "queryResult": { # Represents the result of a conversational query. # The result of the conversational query.
-    "advancedSettings": { # Hierarchical advanced settings for agent/flow/page/fulfillment/parameter. Settings exposed at lower level overrides the settings exposed at higher level. Overriding occurs at the sub-setting level. For example, the playback_interruption_settings at fulfillment level only overrides the playback_interruption_settings at the agent level, leaving other settings at the agent level unchanged. DTMF settings does not override each other. DTMF settings set at different levels define DTMF detections running in parallel. Hierarchy: Agent->Flow->Page->Fulfillment/Parameter. # Returns the current advanced settings including IVR settings. Even though the operations configured by these settings are performed by Dialogflow, the client may need to perform special logic at the moment. For example, if Dialogflow exports audio to Google Cloud Storage, then the client may need to wait for the resulting object to appear in the bucket before proceeding.
-      "audioExportGcsDestination": { # Google Cloud Storage location for a Dialogflow operation that writes or exports objects (e.g. exported agent or transcripts) outside of Dialogflow. # If present, incoming audio is exported by Dialogflow to the configured Google Cloud Storage destination. Exposed at the following levels: - Agent level - Flow level
-        "uri": "A String", # Required. The Google Cloud Storage URI for the exported objects. A URI is of the form: `gs://bucket/object-name-or-prefix` Whether a full object name, or just a prefix, its usage depends on the Dialogflow operation.
+          "returnPartialResponses": True or False, # Whether Dialogflow should return currently queued fulfillment response messages in streaming APIs. If a webhook is specified, it happens before Dialogflow invokes webhook. Warning: 1) This flag only affects streaming API. Responses are still queued and returned once in non-streaming API. 2) The flag can be enabled in any fulfillment but only the first 3 partial responses will be returned. You may only want to apply it to fulfillments that have slow webhooks.
+          "setParameterActions": [ # Set parameter values before executing the webhook.
+            { # Setting a parameter value.
+              "parameter": "A String", # Display name of the parameter.
+              "value": "", # The new value of the parameter. A null value clears the parameter.
+            },
+          ],
+          "tag": "A String", # The value of this field will be populated in the WebhookRequest `fulfillmentInfo.tag` field by Dialogflow when the associated webhook is called. The tag is typically used by the webhook service to identify which fulfillment is being called, but it could be used for other purposes. This field is required if `webhook` is specified.
+          "webhook": "A String", # The webhook to call. Format: `projects//locations//agents//webhooks/`.
+        },
       },
-      "dtmfSettings": { # Define behaviors for DTMF (dual tone multi frequency). # Settings for DTMF. Exposed at the following levels: - Agent level - Flow level - Page level - Parameter level.
-        "enabled": True or False, # If true, incoming audio is processed for DTMF (dual tone multi frequency) events. For example, if the caller presses a button on their telephone keypad and DTMF processing is enabled, Dialogflow will detect the event (e.g. a "3" was pressed) in the incoming audio and pass the event to the bot to drive business logic (e.g. when 3 is pressed, return the account balance).
-        "endpointingTimeoutDuration": "A String", # Endpoint timeout setting for matching dtmf input to regex.
-        "finishDigit": "A String", # The digit that terminates a DTMF digit sequence.
-        "interdigitTimeoutDuration": "A String", # Interdigit timeout setting for matching dtmf input to regex.
-        "maxDigits": 42, # Max length of DTMF digits.
+      "multiLanguageSettings": { # Settings for multi-lingual agents. # Optional. Multi-lingual agent settings for this flow.
+        "enableMultiLanguageDetection": True or False, # Optional. Enable multi-language detection for this flow. This can be set only if agent level multi language setting is enabled.
+        "supportedResponseLanguageCodes": [ # Optional. Agent will respond in the detected language if the detected language code is in the supported resolved languages for this flow. This will be used only if multi-language training is enabled in the agent and multi-language detection is enabled in the flow. The supported languages must be a subset of the languages supported by the agent.
+          "A String",
+        ],
       },
-      "loggingSettings": { # Define behaviors on logging. # Settings for logging. Settings for Dialogflow History, Contact Center messages, StackDriver logs, and speech logging. Exposed at the following levels: - Agent level.
-        "enableInteractionLogging": True or False, # If true, DF Interaction logging is currently enabled.
-        "enableStackdriverLogging": True or False, # If true, StackDriver logging is currently enabled.
+      "name": "A String", # The unique identifier of the flow. Format: `projects//locations//agents//flows/`.
+      "nluSettings": { # Settings related to NLU. # NLU related settings of the flow.
+        "classificationThreshold": 3.14, # To filter out false positive results and still get variety in matched natural language inputs for your agent, you can tune the machine learning classification threshold. If the returned score value is less than the threshold value, then a no-match event will be triggered. The score values range from 0.0 (completely uncertain) to 1.0 (completely certain). If set to 0.0, the default of 0.3 is used.
+        "modelTrainingMode": "A String", # Indicates NLU model training mode.
+        "modelType": "A String", # Indicates the type of NLU model.
       },
-      "speechSettings": { # Define behaviors of speech to text detection. # Settings for speech to text detection. Exposed at the following levels: - Agent level - Flow level - Page level - Parameter level
-        "endpointerSensitivity": 42, # Sensitivity of the speech model that detects the end of speech. Scale from 0 to 100.
-        "models": { # Mapping from language to Speech-to-Text model. The mapped Speech-to-Text model will be selected for requests from its corresponding language. For more information, see [Speech models](https://cloud.google.com/dialogflow/cx/docs/concept/speech-models).
-          "a_key": "A String",
+      "transitionRouteGroups": [ # A flow's transition route group serve two purposes: * They are responsible for matching the user's first utterances in the flow. * They are inherited by every page's transition route groups. Transition route groups defined in the page have higher priority than those defined in the flow. Format:`projects//locations//agents//flows//transitionRouteGroups/` or `projects//locations//agents//transitionRouteGroups/` for agent-level groups.
+        "A String",
+      ],
+      "transitionRoutes": [ # A flow's transition routes serve two purposes: * They are responsible for matching the user's first utterances in the flow. * They are inherited by every page's transition routes and can support use cases such as the user saying "help" or "can I talk to a human?", which can be handled in a common way regardless of the current page. Transition routes defined in the page have higher priority than those defined in the flow. TransitionRoutes are evalauted in the following order: * TransitionRoutes with intent specified. * TransitionRoutes with only condition specified. TransitionRoutes with intent specified are inherited by pages in the flow.
+        { # A transition route specifies a intent that can be matched and/or a data condition that can be evaluated during a session. When a specified transition is matched, the following actions are taken in order: * If there is a `trigger_fulfillment` associated with the transition, it will be called. * If there is a `target_page` associated with the transition, the session will transition into the specified page. * If there is a `target_flow` associated with the transition, the session will transition into the specified flow.
+          "condition": "A String", # The condition to evaluate against form parameters or session parameters. See the [conditions reference](https://cloud.google.com/dialogflow/cx/docs/reference/condition). At least one of `intent` or `condition` must be specified. When both `intent` and `condition` are specified, the transition can only happen when both are fulfilled.
+          "description": "A String", # Optional. The description of the transition route. The maximum length is 500 characters.
+          "intent": "A String", # The unique identifier of an Intent. Format: `projects//locations//agents//intents/`. Indicates that the transition can only happen when the given intent is matched. At least one of `intent` or `condition` must be specified. When both `intent` and `condition` are specified, the transition can only happen when both are fulfilled.
+          "name": "A String", # Output only. The unique identifier of this transition route.
+          "targetFlow": "A String", # The target flow to transition to. Format: `projects//locations//agents//flows/`.
+          "targetPage": "A String", # The target page to transition to. Format: `projects//locations//agents//flows//pages/`.
+          "triggerFulfillment": { # A fulfillment can do one or more of the following actions at the same time: * Generate rich message responses. * Set parameter values. * Call the webhook. Fulfillments can be called at various stages in the Page or Form lifecycle. For example, when a DetectIntentRequest drives a session to enter a new page, the page's entry fulfillment can add a static response to the QueryResult in the returning DetectIntentResponse, call the webhook (for example, to load user data from a database), or both. # The fulfillment to call when the condition is satisfied. At least one of `trigger_fulfillment` and `target` must be specified. When both are defined, `trigger_fulfillment` is executed first.
+            "advancedSettings": { # Hierarchical advanced settings for agent/flow/page/fulfillment/parameter. Settings exposed at lower level overrides the settings exposed at higher level. Overriding occurs at the sub-setting level. For example, the playback_interruption_settings at fulfillment level only overrides the playback_interruption_settings at the agent level, leaving other settings at the agent level unchanged. DTMF settings does not override each other. DTMF settings set at different levels define DTMF detections running in parallel. Hierarchy: Agent->Flow->Page->Fulfillment/Parameter. # Hierarchical advanced settings for this fulfillment. The settings exposed at the lower level overrides the settings exposed at the higher level.
+              "audioExportGcsDestination": { # Google Cloud Storage location for a Dialogflow operation that writes or exports objects (e.g. exported agent or transcripts) outside of Dialogflow. # If present, incoming audio is exported by Dialogflow to the configured Google Cloud Storage destination. Exposed at the following levels: - Agent level - Flow level
+                "uri": "A String", # Required. The Google Cloud Storage URI for the exported objects. A URI is of the form: `gs://bucket/object-name-or-prefix` Whether a full object name, or just a prefix, its usage depends on the Dialogflow operation.
+              },
+              "dtmfSettings": { # Define behaviors for DTMF (dual tone multi frequency). # Settings for DTMF. Exposed at the following levels: - Agent level - Flow level - Page level - Parameter level.
+                "enabled": True or False, # If true, incoming audio is processed for DTMF (dual tone multi frequency) events. For example, if the caller presses a button on their telephone keypad and DTMF processing is enabled, Dialogflow will detect the event (e.g. a "3" was pressed) in the incoming audio and pass the event to the bot to drive business logic (e.g. when 3 is pressed, return the account balance).
+                "endpointingTimeoutDuration": "A String", # Endpoint timeout setting for matching dtmf input to regex.
+                "finishDigit": "A String", # The digit that terminates a DTMF digit sequence.
+                "interdigitTimeoutDuration": "A String", # Interdigit timeout setting for matching dtmf input to regex.
+                "maxDigits": 42, # Max length of DTMF digits.
+              },
+              "loggingSettings": { # Define behaviors on logging. # Settings for logging. Settings for Dialogflow History, Contact Center messages, StackDriver logs, and speech logging. Exposed at the following levels: - Agent level.
+                "enableInteractionLogging": True or False, # Enables DF Interaction logging.
+                "enableStackdriverLogging": True or False, # Enables StackDriver logging.
+              },
+              "speechSettings": { # Define behaviors of speech to text detection. # Settings for speech to text detection. Exposed at the following levels: - Agent level - Flow level - Page level - Parameter level
+                "endpointerSensitivity": 42, # Sensitivity of the speech model that detects the end of speech. Scale from 0 to 100.
+                "models": { # Mapping from language to Speech-to-Text model. The mapped Speech-to-Text model will be selected for requests from its corresponding language. For more information, see [Speech models](https://cloud.google.com/dialogflow/cx/docs/concept/speech-models).
+                  "a_key": "A String",
+                },
+                "noSpeechTimeout": "A String", # Timeout before detecting no speech.
+                "useTimeoutBasedEndpointing": True or False, # Use timeout based endpointing, interpreting endpointer sensitivy as seconds of timeout value.
+              },
+            },
+            "conditionalCases": [ # Conditional cases for this fulfillment.
+              { # A list of cascading if-else conditions. Cases are mutually exclusive. The first one with a matching condition is selected, all the rest ignored.
+                "cases": [ # A list of cascading if-else conditions.
+                  { # Each case has a Boolean condition. When it is evaluated to be True, the corresponding messages will be selected and evaluated recursively.
+                    "caseContent": [ # A list of case content.
+                      { # The list of messages or conditional cases to activate for this case.
+                        "additionalCases": # Object with schema name: GoogleCloudDialogflowCxV3beta1FulfillmentConditionalCases # Additional cases to be evaluated.
+                        "message": { # 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. # Returned message.
+                          "channel": "A String", # The channel which the response is associated with. Clients can specify the channel via QueryParameters.channel, and only associated channel response will be returned.
+                          "conversationSuccess": { # 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. # Indicates that the conversation succeeded.
+                            "metadata": { # Custom metadata. Dialogflow doesn't impose any structure on this.
+                              "a_key": "", # Properties of the object.
+                            },
+                          },
+                          "endInteraction": { # 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. # Output only. A signal that indicates the interaction with the Dialogflow agent has ended. This message is generated by Dialogflow only when the conversation reaches `END_SESSION` page. It is not supposed to be defined by the user. It's guaranteed that there is at most one such message in each response.
+                          },
+                          "knowledgeInfoCard": { # Represents info card response. If the response contains generative knowledge prediction, Dialogflow will return a payload with Infobot Messenger compatible info card. Otherwise, the info card response is skipped. # Represents info card for knowledge answers, to be better rendered in Dialogflow Messenger.
+                          },
+                          "liveAgentHandoff": { # 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. # Hands off conversation to a human agent.
+                            "metadata": { # Custom metadata for your handoff procedure. Dialogflow doesn't impose any structure on this.
+                              "a_key": "", # Properties of the object.
+                            },
+                          },
+                          "mixedAudio": { # 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. # Output only. An audio response message composed of both the synthesized Dialogflow agent responses and responses defined via play_audio. This message is generated by Dialogflow only and not supposed to be defined by the user.
+                            "segments": [ # Segments this audio response is composed of.
+                              { # Represents one segment of audio.
+                                "allowPlaybackInterruption": True or False, # 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.
+                                "audio": "A String", # Raw audio synthesized from the Dialogflow agent's response using the output config specified in the request.
+                                "uri": "A String", # Client-specific URI that points to an audio clip accessible to the client. Dialogflow does not impose any validation on it.
+                              },
+                            ],
+                          },
+                          "outputAudioText": { # A text or ssml response that is preferentially used for TTS output audio synthesis, as described in the comment on the ResponseMessage message. # A text or ssml response that is preferentially used for TTS output audio synthesis, as described in the comment on the ResponseMessage message.
+                            "allowPlaybackInterruption": True or False, # 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.
+                            "ssml": "A String", # The SSML text to be synthesized. For more information, see [SSML](/speech/text-to-speech/docs/ssml).
+                            "text": "A String", # The raw text to be synthesized.
+                          },
+                          "payload": { # Returns a response containing a custom, platform-specific payload.
+                            "a_key": "", # Properties of the object.
+                          },
+                          "playAudio": { # Specifies an audio clip to be played by the client as part of the response. # Signal that the client should play an audio clip hosted at a client-specific URI. Dialogflow uses this to construct mixed_audio. However, Dialogflow itself does not try to read or process the URI in any way.
+                            "allowPlaybackInterruption": True or False, # 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.
+                            "audioUri": "A String", # Required. URI of the audio clip. Dialogflow does not impose any validation on this value. It is specific to the client that reads it.
+                          },
+                          "telephonyTransferCall": { # Represents the signal that telles the client to transfer the phone call connected to the agent to a third-party endpoint. # A signal that the client should transfer the phone call connected to this agent to a third-party endpoint.
+                            "phoneNumber": "A String", # Transfer the call to a phone number in [E.164 format](https://en.wikipedia.org/wiki/E.164).
+                          },
+                          "text": { # The text response message. # Returns a text response.
+                            "allowPlaybackInterruption": True or False, # 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.
+                            "text": [ # Required. A collection of text responses.
+                              "A String",
+                            ],
+                          },
+                          "toolCall": { # Represents a call of a specific tool's action with the specified inputs. # Returns the definition of a tool call that should be executed by the client.
+                            "action": "A String", # Required. The name of the tool's action associated with this call.
+                            "inputParameters": { # Optional. The action's input parameters.
+                              "a_key": "", # Properties of the object.
+                            },
+                            "tool": "A String", # Required. The tool associated with this call. Format: `projects//locations//agents//tools/`.
+                          },
+                        },
+                      },
+                    ],
+                    "condition": "A String", # The condition to activate and select this case. Empty means the condition is always true. The condition is evaluated against form parameters or session parameters. See the [conditions reference](https://cloud.google.com/dialogflow/cx/docs/reference/condition).
+                  },
+                ],
+              },
+            ],
+            "enableGenerativeFallback": True or False, # If the flag is true, the agent will utilize LLM to generate a text response. If LLM generation fails, the defined responses in the fulfillment will be respected. This flag is only useful for fulfillments associated with no-match event handlers.
+            "messages": [ # The list of rich message responses to present to the user.
+              { # 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.
+                "channel": "A String", # The channel which the response is associated with. Clients can specify the channel via QueryParameters.channel, and only associated channel response will be returned.
+                "conversationSuccess": { # 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. # Indicates that the conversation succeeded.
+                  "metadata": { # Custom metadata. Dialogflow doesn't impose any structure on this.
+                    "a_key": "", # Properties of the object.
+                  },
+                },
+                "endInteraction": { # 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. # Output only. A signal that indicates the interaction with the Dialogflow agent has ended. This message is generated by Dialogflow only when the conversation reaches `END_SESSION` page. It is not supposed to be defined by the user. It's guaranteed that there is at most one such message in each response.
+                },
+                "knowledgeInfoCard": { # Represents info card response. If the response contains generative knowledge prediction, Dialogflow will return a payload with Infobot Messenger compatible info card. Otherwise, the info card response is skipped. # Represents info card for knowledge answers, to be better rendered in Dialogflow Messenger.
+                },
+                "liveAgentHandoff": { # 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. # Hands off conversation to a human agent.
+                  "metadata": { # Custom metadata for your handoff procedure. Dialogflow doesn't impose any structure on this.
+                    "a_key": "", # Properties of the object.
+                  },
+                },
+                "mixedAudio": { # 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. # Output only. An audio response message composed of both the synthesized Dialogflow agent responses and responses defined via play_audio. This message is generated by Dialogflow only and not supposed to be defined by the user.
+                  "segments": [ # Segments this audio response is composed of.
+                    { # Represents one segment of audio.
+                      "allowPlaybackInterruption": True or False, # 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.
+                      "audio": "A String", # Raw audio synthesized from the Dialogflow agent's response using the output config specified in the request.
+                      "uri": "A String", # Client-specific URI that points to an audio clip accessible to the client. Dialogflow does not impose any validation on it.
+                    },
+                  ],
+                },
+                "outputAudioText": { # A text or ssml response that is preferentially used for TTS output audio synthesis, as described in the comment on the ResponseMessage message. # A text or ssml response that is preferentially used for TTS output audio synthesis, as described in the comment on the ResponseMessage message.
+                  "allowPlaybackInterruption": True or False, # 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.
+                  "ssml": "A String", # The SSML text to be synthesized. For more information, see [SSML](/speech/text-to-speech/docs/ssml).
+                  "text": "A String", # The raw text to be synthesized.
+                },
+                "payload": { # Returns a response containing a custom, platform-specific payload.
+                  "a_key": "", # Properties of the object.
+                },
+                "playAudio": { # Specifies an audio clip to be played by the client as part of the response. # Signal that the client should play an audio clip hosted at a client-specific URI. Dialogflow uses this to construct mixed_audio. However, Dialogflow itself does not try to read or process the URI in any way.
+                  "allowPlaybackInterruption": True or False, # 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.
+                  "audioUri": "A String", # Required. URI of the audio clip. Dialogflow does not impose any validation on this value. It is specific to the client that reads it.
+                },
+                "telephonyTransferCall": { # Represents the signal that telles the client to transfer the phone call connected to the agent to a third-party endpoint. # A signal that the client should transfer the phone call connected to this agent to a third-party endpoint.
+                  "phoneNumber": "A String", # Transfer the call to a phone number in [E.164 format](https://en.wikipedia.org/wiki/E.164).
+                },
+                "text": { # The text response message. # Returns a text response.
+                  "allowPlaybackInterruption": True or False, # 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.
+                  "text": [ # Required. A collection of text responses.
+                    "A String",
+                  ],
+                },
+                "toolCall": { # Represents a call of a specific tool's action with the specified inputs. # Returns the definition of a tool call that should be executed by the client.
+                  "action": "A String", # Required. The name of the tool's action associated with this call.
+                  "inputParameters": { # Optional. The action's input parameters.
+                    "a_key": "", # Properties of the object.
+                  },
+                  "tool": "A String", # Required. The tool associated with this call. Format: `projects//locations//agents//tools/`.
+                },
+              },
+            ],
+            "returnPartialResponses": True or False, # Whether Dialogflow should return currently queued fulfillment response messages in streaming APIs. If a webhook is specified, it happens before Dialogflow invokes webhook. Warning: 1) This flag only affects streaming API. Responses are still queued and returned once in non-streaming API. 2) The flag can be enabled in any fulfillment but only the first 3 partial responses will be returned. You may only want to apply it to fulfillments that have slow webhooks.
+            "setParameterActions": [ # Set parameter values before executing the webhook.
+              { # Setting a parameter value.
+                "parameter": "A String", # Display name of the parameter.
+                "value": "", # The new value of the parameter. A null value clears the parameter.
+              },
+            ],
+            "tag": "A String", # The value of this field will be populated in the WebhookRequest `fulfillmentInfo.tag` field by Dialogflow when the associated webhook is called. The tag is typically used by the webhook service to identify which fulfillment is being called, but it could be used for other purposes. This field is required if `webhook` is specified.
+            "webhook": "A String", # The webhook to call. Format: `projects//locations//agents//webhooks/`.
+          },
         },
-        "noSpeechTimeout": "A String", # Timeout before detecting no speech.
-        "useTimeoutBasedEndpointing": True or False, # Use timeout based endpointing, interpreting endpointer sensitivy as seconds of timeout value.
-      },
+      ],
     },
-    "allowAnswerFeedback": True or False, # Indicates whether the Thumbs up/Thumbs down rating controls are need to be shown for the response in the Dialogflow Messenger widget.
     "currentPage": { # A Dialogflow CX conversation (session) can be described and visualized as a state machine. The states of a CX session are represented by pages. For each flow, you define many pages, where your combined pages can handle a complete conversation on the topics the flow is designed for. At any given moment, exactly one page is the current page, the current page is considered active, and the flow associated with that page is considered active. Every flow has a special start page. When a flow initially becomes active, the start page page becomes the current page. For each conversational turn, the current page will either stay the same or transition to another page. You configure each page to collect information from the end-user that is relevant for the conversational state represented by the page. For more information, see the [Page guide](https://cloud.google.com/dialogflow/cx/docs/concept/page). # The current Page. Some, not all fields are filled in this message, including but not limited to `name` and `display_name`.
       "advancedSettings": { # Hierarchical advanced settings for agent/flow/page/fulfillment/parameter. Settings exposed at lower level overrides the settings exposed at higher level. Overriding occurs at the sub-setting level. For example, the playback_interruption_settings at fulfillment level only overrides the playback_interruption_settings at the agent level, leaving other settings at the agent level unchanged. DTMF settings does not override each other. DTMF settings set at different levels define DTMF detections running in parallel. Hierarchy: Agent->Flow->Page->Fulfillment/Parameter. # Hierarchical advanced settings for this page. The settings exposed at the lower level overrides the settings exposed at the higher level.
         "audioExportGcsDestination": { # Google Cloud Storage location for a Dialogflow operation that writes or exports objects (e.g. exported agent or transcripts) outside of Dialogflow. # If present, incoming audio is exported by Dialogflow to the configured Google Cloud Storage destination. Exposed at the following levels: - Agent level - Flow level
@@ -4269,8 +6397,8 @@ 

Method Details

"maxDigits": 42, # Max length of DTMF digits. }, "loggingSettings": { # Define behaviors on logging. # Settings for logging. Settings for Dialogflow History, Contact Center messages, StackDriver logs, and speech logging. Exposed at the following levels: - Agent level. - "enableInteractionLogging": True or False, # If true, DF Interaction logging is currently enabled. - "enableStackdriverLogging": True or False, # If true, StackDriver logging is currently enabled. + "enableInteractionLogging": True or False, # Enables DF Interaction logging. + "enableStackdriverLogging": True or False, # Enables StackDriver logging. }, "speechSettings": { # Define behaviors of speech to text detection. # Settings for speech to text detection. Exposed at the following levels: - Agent level - Flow level - Page level - Parameter level "endpointerSensitivity": 42, # Sensitivity of the speech model that detects the end of speech. Scale from 0 to 100. @@ -4296,8 +6424,8 @@

Method Details

"maxDigits": 42, # Max length of DTMF digits. }, "loggingSettings": { # Define behaviors on logging. # Settings for logging. Settings for Dialogflow History, Contact Center messages, StackDriver logs, and speech logging. Exposed at the following levels: - Agent level. - "enableInteractionLogging": True or False, # If true, DF Interaction logging is currently enabled. - "enableStackdriverLogging": True or False, # If true, StackDriver logging is currently enabled. + "enableInteractionLogging": True or False, # Enables DF Interaction logging. + "enableStackdriverLogging": True or False, # Enables StackDriver logging. }, "speechSettings": { # Define behaviors of speech to text detection. # Settings for speech to text detection. Exposed at the following levels: - Agent level - Flow level - Page level - Parameter level "endpointerSensitivity": 42, # Sensitivity of the speech model that detects the end of speech. Scale from 0 to 100. @@ -4361,6 +6489,13 @@

Method Details

"A String", ], }, + "toolCall": { # Represents a call of a specific tool's action with the specified inputs. # Returns the definition of a tool call that should be executed by the client. + "action": "A String", # Required. The name of the tool's action associated with this call. + "inputParameters": { # Optional. The action's input parameters. + "a_key": "", # Properties of the object. + }, + "tool": "A String", # Required. The tool associated with this call. Format: `projects//locations//agents//tools/`. + }, }, }, ], @@ -4417,6 +6552,13 @@

Method Details

"A String", ], }, + "toolCall": { # Represents a call of a specific tool's action with the specified inputs. # Returns the definition of a tool call that should be executed by the client. + "action": "A String", # Required. The name of the tool's action associated with this call. + "inputParameters": { # Optional. The action's input parameters. + "a_key": "", # Properties of the object. + }, + "tool": "A String", # Required. The tool associated with this call. Format: `projects//locations//agents//tools/`. + }, }, ], "returnPartialResponses": True or False, # Whether Dialogflow should return currently queued fulfillment response messages in streaming APIs. If a webhook is specified, it happens before Dialogflow invokes webhook. Warning: 1) This flag only affects streaming API. Responses are still queued and returned once in non-streaming API. 2) The flag can be enabled in any fulfillment but only the first 3 partial responses will be returned. You may only want to apply it to fulfillments that have slow webhooks. @@ -4448,8 +6590,8 @@

Method Details

"maxDigits": 42, # Max length of DTMF digits. }, "loggingSettings": { # Define behaviors on logging. # Settings for logging. Settings for Dialogflow History, Contact Center messages, StackDriver logs, and speech logging. Exposed at the following levels: - Agent level. - "enableInteractionLogging": True or False, # If true, DF Interaction logging is currently enabled. - "enableStackdriverLogging": True or False, # If true, StackDriver logging is currently enabled. + "enableInteractionLogging": True or False, # Enables DF Interaction logging. + "enableStackdriverLogging": True or False, # Enables StackDriver logging. }, "speechSettings": { # Define behaviors of speech to text detection. # Settings for speech to text detection. Exposed at the following levels: - Agent level - Flow level - Page level - Parameter level "endpointerSensitivity": 42, # Sensitivity of the speech model that detects the end of speech. Scale from 0 to 100. @@ -4513,6 +6655,13 @@

Method Details

"A String", ], }, + "toolCall": { # Represents a call of a specific tool's action with the specified inputs. # Returns the definition of a tool call that should be executed by the client. + "action": "A String", # Required. The name of the tool's action associated with this call. + "inputParameters": { # Optional. The action's input parameters. + "a_key": "", # Properties of the object. + }, + "tool": "A String", # Required. The tool associated with this call. Format: `projects//locations//agents//tools/`. + }, }, }, ], @@ -4569,6 +6718,13 @@

Method Details

"A String", ], }, + "toolCall": { # Represents a call of a specific tool's action with the specified inputs. # Returns the definition of a tool call that should be executed by the client. + "action": "A String", # Required. The name of the tool's action associated with this call. + "inputParameters": { # Optional. The action's input parameters. + "a_key": "", # Properties of the object. + }, + "tool": "A String", # Required. The tool associated with this call. Format: `projects//locations//agents//tools/`. + }, }, ], "returnPartialResponses": True or False, # Whether Dialogflow should return currently queued fulfillment response messages in streaming APIs. If a webhook is specified, it happens before Dialogflow invokes webhook. Warning: 1) This flag only affects streaming API. Responses are still queued and returned once in non-streaming API. 2) The flag can be enabled in any fulfillment but only the first 3 partial responses will be returned. You may only want to apply it to fulfillments that have slow webhooks. @@ -4598,8 +6754,8 @@

Method Details

"maxDigits": 42, # Max length of DTMF digits. }, "loggingSettings": { # Define behaviors on logging. # Settings for logging. Settings for Dialogflow History, Contact Center messages, StackDriver logs, and speech logging. Exposed at the following levels: - Agent level. - "enableInteractionLogging": True or False, # If true, DF Interaction logging is currently enabled. - "enableStackdriverLogging": True or False, # If true, StackDriver logging is currently enabled. + "enableInteractionLogging": True or False, # Enables DF Interaction logging. + "enableStackdriverLogging": True or False, # Enables StackDriver logging. }, "speechSettings": { # Define behaviors of speech to text detection. # Settings for speech to text detection. Exposed at the following levels: - Agent level - Flow level - Page level - Parameter level "endpointerSensitivity": 42, # Sensitivity of the speech model that detects the end of speech. Scale from 0 to 100. @@ -4627,8 +6783,8 @@

Method Details

"maxDigits": 42, # Max length of DTMF digits. }, "loggingSettings": { # Define behaviors on logging. # Settings for logging. Settings for Dialogflow History, Contact Center messages, StackDriver logs, and speech logging. Exposed at the following levels: - Agent level. - "enableInteractionLogging": True or False, # If true, DF Interaction logging is currently enabled. - "enableStackdriverLogging": True or False, # If true, StackDriver logging is currently enabled. + "enableInteractionLogging": True or False, # Enables DF Interaction logging. + "enableStackdriverLogging": True or False, # Enables StackDriver logging. }, "speechSettings": { # Define behaviors of speech to text detection. # Settings for speech to text detection. Exposed at the following levels: - Agent level - Flow level - Page level - Parameter level "endpointerSensitivity": 42, # Sensitivity of the speech model that detects the end of speech. Scale from 0 to 100. @@ -4692,6 +6848,13 @@

Method Details

"A String", ], }, + "toolCall": { # Represents a call of a specific tool's action with the specified inputs. # Returns the definition of a tool call that should be executed by the client. + "action": "A String", # Required. The name of the tool's action associated with this call. + "inputParameters": { # Optional. The action's input parameters. + "a_key": "", # Properties of the object. + }, + "tool": "A String", # Required. The tool associated with this call. Format: `projects//locations//agents//tools/`. + }, }, }, ], @@ -4748,6 +6911,13 @@

Method Details

"A String", ], }, + "toolCall": { # Represents a call of a specific tool's action with the specified inputs. # Returns the definition of a tool call that should be executed by the client. + "action": "A String", # Required. The name of the tool's action associated with this call. + "inputParameters": { # Optional. The action's input parameters. + "a_key": "", # Properties of the object. + }, + "tool": "A String", # Required. The tool associated with this call. Format: `projects//locations//agents//tools/`. + }, }, ], "returnPartialResponses": True or False, # Whether Dialogflow should return currently queued fulfillment response messages in streaming APIs. If a webhook is specified, it happens before Dialogflow invokes webhook. Warning: 1) This flag only affects streaming API. Responses are still queued and returned once in non-streaming API. 2) The flag can be enabled in any fulfillment but only the first 3 partial responses will be returned. You may only want to apply it to fulfillments that have slow webhooks. @@ -4779,8 +6949,8 @@

Method Details

"maxDigits": 42, # Max length of DTMF digits. }, "loggingSettings": { # Define behaviors on logging. # Settings for logging. Settings for Dialogflow History, Contact Center messages, StackDriver logs, and speech logging. Exposed at the following levels: - Agent level. - "enableInteractionLogging": True or False, # If true, DF Interaction logging is currently enabled. - "enableStackdriverLogging": True or False, # If true, StackDriver logging is currently enabled. + "enableInteractionLogging": True or False, # Enables DF Interaction logging. + "enableStackdriverLogging": True or False, # Enables StackDriver logging. }, "speechSettings": { # Define behaviors of speech to text detection. # Settings for speech to text detection. Exposed at the following levels: - Agent level - Flow level - Page level - Parameter level "endpointerSensitivity": 42, # Sensitivity of the speech model that detects the end of speech. Scale from 0 to 100. @@ -4844,6 +7014,13 @@

Method Details

"A String", ], }, + "toolCall": { # Represents a call of a specific tool's action with the specified inputs. # Returns the definition of a tool call that should be executed by the client. + "action": "A String", # Required. The name of the tool's action associated with this call. + "inputParameters": { # Optional. The action's input parameters. + "a_key": "", # Properties of the object. + }, + "tool": "A String", # Required. The tool associated with this call. Format: `projects//locations//agents//tools/`. + }, }, }, ], @@ -4900,6 +7077,13 @@

Method Details

"A String", ], }, + "toolCall": { # Represents a call of a specific tool's action with the specified inputs. # Returns the definition of a tool call that should be executed by the client. + "action": "A String", # Required. The name of the tool's action associated with this call. + "inputParameters": { # Optional. The action's input parameters. + "a_key": "", # Properties of the object. + }, + "tool": "A String", # Required. The tool associated with this call. Format: `projects//locations//agents//tools/`. + }, }, ], "returnPartialResponses": True or False, # Whether Dialogflow should return currently queued fulfillment response messages in streaming APIs. If a webhook is specified, it happens before Dialogflow invokes webhook. Warning: 1) This flag only affects streaming API. Responses are still queued and returned once in non-streaming API. 2) The flag can be enabled in any fulfillment but only the first 3 partial responses will be returned. You may only want to apply it to fulfillments that have slow webhooks. @@ -4944,8 +7128,8 @@

Method Details

"maxDigits": 42, # Max length of DTMF digits. }, "loggingSettings": { # Define behaviors on logging. # Settings for logging. Settings for Dialogflow History, Contact Center messages, StackDriver logs, and speech logging. Exposed at the following levels: - Agent level. - "enableInteractionLogging": True or False, # If true, DF Interaction logging is currently enabled. - "enableStackdriverLogging": True or False, # If true, StackDriver logging is currently enabled. + "enableInteractionLogging": True or False, # Enables DF Interaction logging. + "enableStackdriverLogging": True or False, # Enables StackDriver logging. }, "speechSettings": { # Define behaviors of speech to text detection. # Settings for speech to text detection. Exposed at the following levels: - Agent level - Flow level - Page level - Parameter level "endpointerSensitivity": 42, # Sensitivity of the speech model that detects the end of speech. Scale from 0 to 100. @@ -5009,6 +7193,13 @@

Method Details

"A String", ], }, + "toolCall": { # Represents a call of a specific tool's action with the specified inputs. # Returns the definition of a tool call that should be executed by the client. + "action": "A String", # Required. The name of the tool's action associated with this call. + "inputParameters": { # Optional. The action's input parameters. + "a_key": "", # Properties of the object. + }, + "tool": "A String", # Required. The tool associated with this call. Format: `projects//locations//agents//tools/`. + }, }, }, ], @@ -5065,6 +7256,13 @@

Method Details

"A String", ], }, + "toolCall": { # Represents a call of a specific tool's action with the specified inputs. # Returns the definition of a tool call that should be executed by the client. + "action": "A String", # Required. The name of the tool's action associated with this call. + "inputParameters": { # Optional. The action's input parameters. + "a_key": "", # Properties of the object. + }, + "tool": "A String", # Required. The tool associated with this call. Format: `projects//locations//agents//tools/`. + }, }, ], "returnPartialResponses": True or False, # Whether Dialogflow should return currently queued fulfillment response messages in streaming APIs. If a webhook is specified, it happens before Dialogflow invokes webhook. Warning: 1) This flag only affects streaming API. Responses are still queued and returned once in non-streaming API. 2) The flag can be enabled in any fulfillment but only the first 3 partial responses will be returned. You may only want to apply it to fulfillments that have slow webhooks. @@ -5103,8 +7301,8 @@

Method Details

"maxDigits": 42, # Max length of DTMF digits. }, "loggingSettings": { # Define behaviors on logging. # Settings for logging. Settings for Dialogflow History, Contact Center messages, StackDriver logs, and speech logging. Exposed at the following levels: - Agent level. - "enableInteractionLogging": True or False, # If true, DF Interaction logging is currently enabled. - "enableStackdriverLogging": True or False, # If true, StackDriver logging is currently enabled. + "enableInteractionLogging": True or False, # Enables DF Interaction logging. + "enableStackdriverLogging": True or False, # Enables StackDriver logging. }, "speechSettings": { # Define behaviors of speech to text detection. # Settings for speech to text detection. Exposed at the following levels: - Agent level - Flow level - Page level - Parameter level "endpointerSensitivity": 42, # Sensitivity of the speech model that detects the end of speech. Scale from 0 to 100. @@ -5168,6 +7366,13 @@

Method Details

"A String", ], }, + "toolCall": { # Represents a call of a specific tool's action with the specified inputs. # Returns the definition of a tool call that should be executed by the client. + "action": "A String", # Required. The name of the tool's action associated with this call. + "inputParameters": { # Optional. The action's input parameters. + "a_key": "", # Properties of the object. + }, + "tool": "A String", # Required. The tool associated with this call. Format: `projects//locations//agents//tools/`. + }, }, }, ], @@ -5224,6 +7429,13 @@

Method Details

"A String", ], }, + "toolCall": { # Represents a call of a specific tool's action with the specified inputs. # Returns the definition of a tool call that should be executed by the client. + "action": "A String", # Required. The name of the tool's action associated with this call. + "inputParameters": { # Optional. The action's input parameters. + "a_key": "", # Properties of the object. + }, + "tool": "A String", # Required. The tool associated with this call. Format: `projects//locations//agents//tools/`. + }, }, ], "returnPartialResponses": True or False, # Whether Dialogflow should return currently queued fulfillment response messages in streaming APIs. If a webhook is specified, it happens before Dialogflow invokes webhook. Warning: 1) This flag only affects streaming API. Responses are still queued and returned once in non-streaming API. 2) The flag can be enabled in any fulfillment but only the first 3 partial responses will be returned. You may only want to apply it to fulfillments that have slow webhooks. @@ -5292,6 +7504,79 @@

Method Details

"digits": "A String", # The dtmf digits. "finishDigit": "A String", # The finish digit (if any). }, + "generativeInfo": { # Represents the information of a query if handled by generative agent resources. # The information of a query if handled by generative agent resources. + "actionTracingInfo": { # Example represents a sample execution of the playbook in the conversation. An example consists of a list of ordered actions performed by end user or Dialogflow agent according the playbook instructions to fulfill the task. # The actions performed by the generative playbook for the current agent response. + "actions": [ # Required. The ordered list of actions performed by the end user and the Dialogflow agent. + { # Action performed by end user or Dialogflow agent in the conversation. + "agentUtterance": { # AgentUtterance represents one message sent by the agent. # Optional. Action performed by the agent as a message. + "text": "A String", # Required. Message content in text. + }, + "flowInvocation": { # Stores metadata of the invocation of a CX flow. Next Id: 7 # Optional. Action performed on behalf of the agent by invoking a CX flow. + "flow": "A String", # Required. The unique identifier of the flow. Format: `projects//locations//agents/`. + "flowState": "A String", # Required. Flow invocation's output state. + "inputActionParameters": { # Optional. A list of input parameters for the flow. + "a_key": "", # Properties of the object. + }, + "outputActionParameters": { # Optional. A list of output parameters generated by the flow invocation. + "a_key": "", # Properties of the object. + }, + }, + "playbookInvocation": { # Stores metadata of the invocation of a child playbook. Next Id: 5 # Optional. Action performed on behalf of the agent by invoking a child playbook. + "playbook": "A String", # Required. The unique identifier of the playbook. Format: `projects//locations//agents//playbooks/`. + "playbookInput": { # Input of the playbook. # Optional. Input of the child playbook invocation. + "actionParameters": { # Optional. A list of input parameters for the action. + "a_key": "", # Properties of the object. + }, + "precedingConversationSummary": "A String", # Optional. Summary string of the preceding conversation for the child playbook invocation. + }, + "playbookOutput": { # Output of the playbook. # Optional. Output of the child playbook invocation. + "actionParameters": { # Optional. A Struct object of output parameters for the action. + "a_key": "", # Properties of the object. + }, + "executionSummary": "A String", # Optional. Summary string of the execution result of the child playbook. + }, + "playbookState": "A String", # Required. Playbook invocation's output state. + }, + "toolUse": { # Stores metadata of the invocation of an action supported by a tool. # Optional. Action performed on behalf of the agent by calling a plugin tool. + "action": "A String", # Optional. Name of the action to be called during the tool use. + "inputActionParameters": { # Optional. A list of input parameters for the action. + "a_key": "", # Properties of the object. + }, + "outputActionParameters": { # Optional. A list of output parameters generated by the action. + "a_key": "", # Properties of the object. + }, + "tool": "A String", # Required. The tool that should be used. Format: `projects//locations//agents//tools/`. + }, + "userUtterance": { # UserUtterance represents one message sent by the customer. # Optional. Agent obtained a message from the customer. + "text": "A String", # Required. Message content in text. + }, + }, + ], + "conversationState": "A String", # Required. Example's output state. + "createTime": "A String", # Output only. The timestamp of initial example creation. + "description": "A String", # Optional. The high level concise description of the example. The max number of characters is 200. + "displayName": "A String", # Required. The display name of the example. + "languageCode": "A String", # Optional. The language code of the example. If not specified, the agent's default language is used. Note: languages must be enabled in the agent before they can be used. + "name": "A String", # The unique identifier of the playbook example. Format: `projects//locations//agents//playbooks//examples/`. + "playbookInput": { # Input of the playbook. # Optional. The input to the playbook in the example. + "actionParameters": { # Optional. A list of input parameters for the action. + "a_key": "", # Properties of the object. + }, + "precedingConversationSummary": "A String", # Optional. Summary string of the preceding conversation for the child playbook invocation. + }, + "playbookOutput": { # Output of the playbook. # Optional. The output of the playbook in the example. + "actionParameters": { # Optional. A Struct object of output parameters for the action. + "a_key": "", # Properties of the object. + }, + "executionSummary": "A String", # Optional. Summary string of the execution result of the child playbook. + }, + "tokenCount": "A String", # Output only. Estimated number of tokes current example takes when sent to the LLM. + "updateTime": "A String", # Output only. Last time the example was updated. + }, + "currentPlaybooks": [ # The stack of playbooks that the conversation has currently entered, with the most recent one on the top. + "A String", + ], + }, "intent": { # An intent represents a user's intent to interact with a conversational agent. You can provide information for the Dialogflow API to use to match user input to an intent by adding training phrases (i.e., examples of user input) to your intent. # The Intent that matched the conversational query. Some, not all fields are filled in this message, including but not limited to: `name` and `display_name`. This field is deprecated, please use QueryResult.match instead. "description": "A String", # Human readable description for better understanding an intent like its scope, content, result etc. Maximum character limit: 140 characters. "displayName": "A String", # Required. The human-readable name of the intent, unique within the agent. @@ -5413,6 +7698,13 @@

Method Details

"A String", ], }, + "toolCall": { # Represents a call of a specific tool's action with the specified inputs. # Returns the definition of a tool call that should be executed by the client. + "action": "A String", # Required. The name of the tool's action associated with this call. + "inputParameters": { # Optional. The action's input parameters. + "a_key": "", # Properties of the object. + }, + "tool": "A String", # Required. The tool associated with this call. Format: `projects//locations//agents//tools/`. + }, }, ], "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. # The sentiment analyss result, which depends on `analyze_query_text_sentiment`, specified in the request. diff --git a/docs/dyn/dialogflow_v3beta1.projects.locations.agents.flows.html b/docs/dyn/dialogflow_v3beta1.projects.locations.agents.flows.html index 232fd2fc274..9b57f9f76c4 100644 --- a/docs/dyn/dialogflow_v3beta1.projects.locations.agents.flows.html +++ b/docs/dyn/dialogflow_v3beta1.projects.locations.agents.flows.html @@ -153,8 +153,8 @@

Method Details

"maxDigits": 42, # Max length of DTMF digits. }, "loggingSettings": { # Define behaviors on logging. # Settings for logging. Settings for Dialogflow History, Contact Center messages, StackDriver logs, and speech logging. Exposed at the following levels: - Agent level. - "enableInteractionLogging": True or False, # If true, DF Interaction logging is currently enabled. - "enableStackdriverLogging": True or False, # If true, StackDriver logging is currently enabled. + "enableInteractionLogging": True or False, # Enables DF Interaction logging. + "enableStackdriverLogging": True or False, # Enables StackDriver logging. }, "speechSettings": { # Define behaviors of speech to text detection. # Settings for speech to text detection. Exposed at the following levels: - Agent level - Flow level - Page level - Parameter level "endpointerSensitivity": 42, # Sensitivity of the speech model that detects the end of speech. Scale from 0 to 100. @@ -186,8 +186,8 @@

Method Details

"maxDigits": 42, # Max length of DTMF digits. }, "loggingSettings": { # Define behaviors on logging. # Settings for logging. Settings for Dialogflow History, Contact Center messages, StackDriver logs, and speech logging. Exposed at the following levels: - Agent level. - "enableInteractionLogging": True or False, # If true, DF Interaction logging is currently enabled. - "enableStackdriverLogging": True or False, # If true, StackDriver logging is currently enabled. + "enableInteractionLogging": True or False, # Enables DF Interaction logging. + "enableStackdriverLogging": True or False, # Enables StackDriver logging. }, "speechSettings": { # Define behaviors of speech to text detection. # Settings for speech to text detection. Exposed at the following levels: - Agent level - Flow level - Page level - Parameter level "endpointerSensitivity": 42, # Sensitivity of the speech model that detects the end of speech. Scale from 0 to 100. @@ -251,6 +251,13 @@

Method Details

"A String", ], }, + "toolCall": { # Represents a call of a specific tool's action with the specified inputs. # Returns the definition of a tool call that should be executed by the client. + "action": "A String", # Required. The name of the tool's action associated with this call. + "inputParameters": { # Optional. The action's input parameters. + "a_key": "", # Properties of the object. + }, + "tool": "A String", # Required. The tool associated with this call. Format: `projects//locations//agents//tools/`. + }, }, }, ], @@ -307,6 +314,13 @@

Method Details

"A String", ], }, + "toolCall": { # Represents a call of a specific tool's action with the specified inputs. # Returns the definition of a tool call that should be executed by the client. + "action": "A String", # Required. The name of the tool's action associated with this call. + "inputParameters": { # Optional. The action's input parameters. + "a_key": "", # Properties of the object. + }, + "tool": "A String", # Required. The tool associated with this call. Format: `projects//locations//agents//tools/`. + }, }, ], "returnPartialResponses": True or False, # Whether Dialogflow should return currently queued fulfillment response messages in streaming APIs. If a webhook is specified, it happens before Dialogflow invokes webhook. Warning: 1) This flag only affects streaming API. Responses are still queued and returned once in non-streaming API. 2) The flag can be enabled in any fulfillment but only the first 3 partial responses will be returned. You may only want to apply it to fulfillments that have slow webhooks. @@ -344,8 +358,8 @@

Method Details

"maxDigits": 42, # Max length of DTMF digits. }, "loggingSettings": { # Define behaviors on logging. # Settings for logging. Settings for Dialogflow History, Contact Center messages, StackDriver logs, and speech logging. Exposed at the following levels: - Agent level. - "enableInteractionLogging": True or False, # If true, DF Interaction logging is currently enabled. - "enableStackdriverLogging": True or False, # If true, StackDriver logging is currently enabled. + "enableInteractionLogging": True or False, # Enables DF Interaction logging. + "enableStackdriverLogging": True or False, # Enables StackDriver logging. }, "speechSettings": { # Define behaviors of speech to text detection. # Settings for speech to text detection. Exposed at the following levels: - Agent level - Flow level - Page level - Parameter level "endpointerSensitivity": 42, # Sensitivity of the speech model that detects the end of speech. Scale from 0 to 100. @@ -409,6 +423,13 @@

Method Details

"A String", ], }, + "toolCall": { # Represents a call of a specific tool's action with the specified inputs. # Returns the definition of a tool call that should be executed by the client. + "action": "A String", # Required. The name of the tool's action associated with this call. + "inputParameters": { # Optional. The action's input parameters. + "a_key": "", # Properties of the object. + }, + "tool": "A String", # Required. The tool associated with this call. Format: `projects//locations//agents//tools/`. + }, }, }, ], @@ -465,6 +486,13 @@

Method Details

"A String", ], }, + "toolCall": { # Represents a call of a specific tool's action with the specified inputs. # Returns the definition of a tool call that should be executed by the client. + "action": "A String", # Required. The name of the tool's action associated with this call. + "inputParameters": { # Optional. The action's input parameters. + "a_key": "", # Properties of the object. + }, + "tool": "A String", # Required. The tool associated with this call. Format: `projects//locations//agents//tools/`. + }, }, ], "returnPartialResponses": True or False, # Whether Dialogflow should return currently queued fulfillment response messages in streaming APIs. If a webhook is specified, it happens before Dialogflow invokes webhook. Warning: 1) This flag only affects streaming API. Responses are still queued and returned once in non-streaming API. 2) The flag can be enabled in any fulfillment but only the first 3 partial responses will be returned. You may only want to apply it to fulfillments that have slow webhooks. @@ -514,8 +542,8 @@

Method Details

"maxDigits": 42, # Max length of DTMF digits. }, "loggingSettings": { # Define behaviors on logging. # Settings for logging. Settings for Dialogflow History, Contact Center messages, StackDriver logs, and speech logging. Exposed at the following levels: - Agent level. - "enableInteractionLogging": True or False, # If true, DF Interaction logging is currently enabled. - "enableStackdriverLogging": True or False, # If true, StackDriver logging is currently enabled. + "enableInteractionLogging": True or False, # Enables DF Interaction logging. + "enableStackdriverLogging": True or False, # Enables StackDriver logging. }, "speechSettings": { # Define behaviors of speech to text detection. # Settings for speech to text detection. Exposed at the following levels: - Agent level - Flow level - Page level - Parameter level "endpointerSensitivity": 42, # Sensitivity of the speech model that detects the end of speech. Scale from 0 to 100. @@ -579,6 +607,13 @@

Method Details

"A String", ], }, + "toolCall": { # Represents a call of a specific tool's action with the specified inputs. # Returns the definition of a tool call that should be executed by the client. + "action": "A String", # Required. The name of the tool's action associated with this call. + "inputParameters": { # Optional. The action's input parameters. + "a_key": "", # Properties of the object. + }, + "tool": "A String", # Required. The tool associated with this call. Format: `projects//locations//agents//tools/`. + }, }, }, ], @@ -635,6 +670,13 @@

Method Details

"A String", ], }, + "toolCall": { # Represents a call of a specific tool's action with the specified inputs. # Returns the definition of a tool call that should be executed by the client. + "action": "A String", # Required. The name of the tool's action associated with this call. + "inputParameters": { # Optional. The action's input parameters. + "a_key": "", # Properties of the object. + }, + "tool": "A String", # Required. The tool associated with this call. Format: `projects//locations//agents//tools/`. + }, }, ], "returnPartialResponses": True or False, # Whether Dialogflow should return currently queued fulfillment response messages in streaming APIs. If a webhook is specified, it happens before Dialogflow invokes webhook. Warning: 1) This flag only affects streaming API. Responses are still queued and returned once in non-streaming API. 2) The flag can be enabled in any fulfillment but only the first 3 partial responses will be returned. You may only want to apply it to fulfillments that have slow webhooks. @@ -673,8 +715,8 @@

Method Details

"maxDigits": 42, # Max length of DTMF digits. }, "loggingSettings": { # Define behaviors on logging. # Settings for logging. Settings for Dialogflow History, Contact Center messages, StackDriver logs, and speech logging. Exposed at the following levels: - Agent level. - "enableInteractionLogging": True or False, # If true, DF Interaction logging is currently enabled. - "enableStackdriverLogging": True or False, # If true, StackDriver logging is currently enabled. + "enableInteractionLogging": True or False, # Enables DF Interaction logging. + "enableStackdriverLogging": True or False, # Enables StackDriver logging. }, "speechSettings": { # Define behaviors of speech to text detection. # Settings for speech to text detection. Exposed at the following levels: - Agent level - Flow level - Page level - Parameter level "endpointerSensitivity": 42, # Sensitivity of the speech model that detects the end of speech. Scale from 0 to 100. @@ -706,8 +748,8 @@

Method Details

"maxDigits": 42, # Max length of DTMF digits. }, "loggingSettings": { # Define behaviors on logging. # Settings for logging. Settings for Dialogflow History, Contact Center messages, StackDriver logs, and speech logging. Exposed at the following levels: - Agent level. - "enableInteractionLogging": True or False, # If true, DF Interaction logging is currently enabled. - "enableStackdriverLogging": True or False, # If true, StackDriver logging is currently enabled. + "enableInteractionLogging": True or False, # Enables DF Interaction logging. + "enableStackdriverLogging": True or False, # Enables StackDriver logging. }, "speechSettings": { # Define behaviors of speech to text detection. # Settings for speech to text detection. Exposed at the following levels: - Agent level - Flow level - Page level - Parameter level "endpointerSensitivity": 42, # Sensitivity of the speech model that detects the end of speech. Scale from 0 to 100. @@ -771,6 +813,13 @@

Method Details

"A String", ], }, + "toolCall": { # Represents a call of a specific tool's action with the specified inputs. # Returns the definition of a tool call that should be executed by the client. + "action": "A String", # Required. The name of the tool's action associated with this call. + "inputParameters": { # Optional. The action's input parameters. + "a_key": "", # Properties of the object. + }, + "tool": "A String", # Required. The tool associated with this call. Format: `projects//locations//agents//tools/`. + }, }, }, ], @@ -827,6 +876,13 @@

Method Details

"A String", ], }, + "toolCall": { # Represents a call of a specific tool's action with the specified inputs. # Returns the definition of a tool call that should be executed by the client. + "action": "A String", # Required. The name of the tool's action associated with this call. + "inputParameters": { # Optional. The action's input parameters. + "a_key": "", # Properties of the object. + }, + "tool": "A String", # Required. The tool associated with this call. Format: `projects//locations//agents//tools/`. + }, }, ], "returnPartialResponses": True or False, # Whether Dialogflow should return currently queued fulfillment response messages in streaming APIs. If a webhook is specified, it happens before Dialogflow invokes webhook. Warning: 1) This flag only affects streaming API. Responses are still queued and returned once in non-streaming API. 2) The flag can be enabled in any fulfillment but only the first 3 partial responses will be returned. You may only want to apply it to fulfillments that have slow webhooks. @@ -864,8 +920,8 @@

Method Details

"maxDigits": 42, # Max length of DTMF digits. }, "loggingSettings": { # Define behaviors on logging. # Settings for logging. Settings for Dialogflow History, Contact Center messages, StackDriver logs, and speech logging. Exposed at the following levels: - Agent level. - "enableInteractionLogging": True or False, # If true, DF Interaction logging is currently enabled. - "enableStackdriverLogging": True or False, # If true, StackDriver logging is currently enabled. + "enableInteractionLogging": True or False, # Enables DF Interaction logging. + "enableStackdriverLogging": True or False, # Enables StackDriver logging. }, "speechSettings": { # Define behaviors of speech to text detection. # Settings for speech to text detection. Exposed at the following levels: - Agent level - Flow level - Page level - Parameter level "endpointerSensitivity": 42, # Sensitivity of the speech model that detects the end of speech. Scale from 0 to 100. @@ -929,6 +985,13 @@

Method Details

"A String", ], }, + "toolCall": { # Represents a call of a specific tool's action with the specified inputs. # Returns the definition of a tool call that should be executed by the client. + "action": "A String", # Required. The name of the tool's action associated with this call. + "inputParameters": { # Optional. The action's input parameters. + "a_key": "", # Properties of the object. + }, + "tool": "A String", # Required. The tool associated with this call. Format: `projects//locations//agents//tools/`. + }, }, }, ], @@ -985,6 +1048,13 @@

Method Details

"A String", ], }, + "toolCall": { # Represents a call of a specific tool's action with the specified inputs. # Returns the definition of a tool call that should be executed by the client. + "action": "A String", # Required. The name of the tool's action associated with this call. + "inputParameters": { # Optional. The action's input parameters. + "a_key": "", # Properties of the object. + }, + "tool": "A String", # Required. The tool associated with this call. Format: `projects//locations//agents//tools/`. + }, }, ], "returnPartialResponses": True or False, # Whether Dialogflow should return currently queued fulfillment response messages in streaming APIs. If a webhook is specified, it happens before Dialogflow invokes webhook. Warning: 1) This flag only affects streaming API. Responses are still queued and returned once in non-streaming API. 2) The flag can be enabled in any fulfillment but only the first 3 partial responses will be returned. You may only want to apply it to fulfillments that have slow webhooks. @@ -1034,8 +1104,8 @@

Method Details

"maxDigits": 42, # Max length of DTMF digits. }, "loggingSettings": { # Define behaviors on logging. # Settings for logging. Settings for Dialogflow History, Contact Center messages, StackDriver logs, and speech logging. Exposed at the following levels: - Agent level. - "enableInteractionLogging": True or False, # If true, DF Interaction logging is currently enabled. - "enableStackdriverLogging": True or False, # If true, StackDriver logging is currently enabled. + "enableInteractionLogging": True or False, # Enables DF Interaction logging. + "enableStackdriverLogging": True or False, # Enables StackDriver logging. }, "speechSettings": { # Define behaviors of speech to text detection. # Settings for speech to text detection. Exposed at the following levels: - Agent level - Flow level - Page level - Parameter level "endpointerSensitivity": 42, # Sensitivity of the speech model that detects the end of speech. Scale from 0 to 100. @@ -1099,6 +1169,13 @@

Method Details

"A String", ], }, + "toolCall": { # Represents a call of a specific tool's action with the specified inputs. # Returns the definition of a tool call that should be executed by the client. + "action": "A String", # Required. The name of the tool's action associated with this call. + "inputParameters": { # Optional. The action's input parameters. + "a_key": "", # Properties of the object. + }, + "tool": "A String", # Required. The tool associated with this call. Format: `projects//locations//agents//tools/`. + }, }, }, ], @@ -1155,6 +1232,13 @@

Method Details

"A String", ], }, + "toolCall": { # Represents a call of a specific tool's action with the specified inputs. # Returns the definition of a tool call that should be executed by the client. + "action": "A String", # Required. The name of the tool's action associated with this call. + "inputParameters": { # Optional. The action's input parameters. + "a_key": "", # Properties of the object. + }, + "tool": "A String", # Required. The tool associated with this call. Format: `projects//locations//agents//tools/`. + }, }, ], "returnPartialResponses": True or False, # Whether Dialogflow should return currently queued fulfillment response messages in streaming APIs. If a webhook is specified, it happens before Dialogflow invokes webhook. Warning: 1) This flag only affects streaming API. Responses are still queued and returned once in non-streaming API. 2) The flag can be enabled in any fulfillment but only the first 3 partial responses will be returned. You may only want to apply it to fulfillments that have slow webhooks. @@ -1262,8 +1346,8 @@

Method Details

"maxDigits": 42, # Max length of DTMF digits. }, "loggingSettings": { # Define behaviors on logging. # Settings for logging. Settings for Dialogflow History, Contact Center messages, StackDriver logs, and speech logging. Exposed at the following levels: - Agent level. - "enableInteractionLogging": True or False, # If true, DF Interaction logging is currently enabled. - "enableStackdriverLogging": True or False, # If true, StackDriver logging is currently enabled. + "enableInteractionLogging": True or False, # Enables DF Interaction logging. + "enableStackdriverLogging": True or False, # Enables StackDriver logging. }, "speechSettings": { # Define behaviors of speech to text detection. # Settings for speech to text detection. Exposed at the following levels: - Agent level - Flow level - Page level - Parameter level "endpointerSensitivity": 42, # Sensitivity of the speech model that detects the end of speech. Scale from 0 to 100. @@ -1295,8 +1379,8 @@

Method Details

"maxDigits": 42, # Max length of DTMF digits. }, "loggingSettings": { # Define behaviors on logging. # Settings for logging. Settings for Dialogflow History, Contact Center messages, StackDriver logs, and speech logging. Exposed at the following levels: - Agent level. - "enableInteractionLogging": True or False, # If true, DF Interaction logging is currently enabled. - "enableStackdriverLogging": True or False, # If true, StackDriver logging is currently enabled. + "enableInteractionLogging": True or False, # Enables DF Interaction logging. + "enableStackdriverLogging": True or False, # Enables StackDriver logging. }, "speechSettings": { # Define behaviors of speech to text detection. # Settings for speech to text detection. Exposed at the following levels: - Agent level - Flow level - Page level - Parameter level "endpointerSensitivity": 42, # Sensitivity of the speech model that detects the end of speech. Scale from 0 to 100. @@ -1360,6 +1444,13 @@

Method Details

"A String", ], }, + "toolCall": { # Represents a call of a specific tool's action with the specified inputs. # Returns the definition of a tool call that should be executed by the client. + "action": "A String", # Required. The name of the tool's action associated with this call. + "inputParameters": { # Optional. The action's input parameters. + "a_key": "", # Properties of the object. + }, + "tool": "A String", # Required. The tool associated with this call. Format: `projects//locations//agents//tools/`. + }, }, }, ], @@ -1416,6 +1507,13 @@

Method Details

"A String", ], }, + "toolCall": { # Represents a call of a specific tool's action with the specified inputs. # Returns the definition of a tool call that should be executed by the client. + "action": "A String", # Required. The name of the tool's action associated with this call. + "inputParameters": { # Optional. The action's input parameters. + "a_key": "", # Properties of the object. + }, + "tool": "A String", # Required. The tool associated with this call. Format: `projects//locations//agents//tools/`. + }, }, ], "returnPartialResponses": True or False, # Whether Dialogflow should return currently queued fulfillment response messages in streaming APIs. If a webhook is specified, it happens before Dialogflow invokes webhook. Warning: 1) This flag only affects streaming API. Responses are still queued and returned once in non-streaming API. 2) The flag can be enabled in any fulfillment but only the first 3 partial responses will be returned. You may only want to apply it to fulfillments that have slow webhooks. @@ -1453,8 +1551,8 @@

Method Details

"maxDigits": 42, # Max length of DTMF digits. }, "loggingSettings": { # Define behaviors on logging. # Settings for logging. Settings for Dialogflow History, Contact Center messages, StackDriver logs, and speech logging. Exposed at the following levels: - Agent level. - "enableInteractionLogging": True or False, # If true, DF Interaction logging is currently enabled. - "enableStackdriverLogging": True or False, # If true, StackDriver logging is currently enabled. + "enableInteractionLogging": True or False, # Enables DF Interaction logging. + "enableStackdriverLogging": True or False, # Enables StackDriver logging. }, "speechSettings": { # Define behaviors of speech to text detection. # Settings for speech to text detection. Exposed at the following levels: - Agent level - Flow level - Page level - Parameter level "endpointerSensitivity": 42, # Sensitivity of the speech model that detects the end of speech. Scale from 0 to 100. @@ -1518,6 +1616,13 @@

Method Details

"A String", ], }, + "toolCall": { # Represents a call of a specific tool's action with the specified inputs. # Returns the definition of a tool call that should be executed by the client. + "action": "A String", # Required. The name of the tool's action associated with this call. + "inputParameters": { # Optional. The action's input parameters. + "a_key": "", # Properties of the object. + }, + "tool": "A String", # Required. The tool associated with this call. Format: `projects//locations//agents//tools/`. + }, }, }, ], @@ -1574,6 +1679,13 @@

Method Details

"A String", ], }, + "toolCall": { # Represents a call of a specific tool's action with the specified inputs. # Returns the definition of a tool call that should be executed by the client. + "action": "A String", # Required. The name of the tool's action associated with this call. + "inputParameters": { # Optional. The action's input parameters. + "a_key": "", # Properties of the object. + }, + "tool": "A String", # Required. The tool associated with this call. Format: `projects//locations//agents//tools/`. + }, }, ], "returnPartialResponses": True or False, # Whether Dialogflow should return currently queued fulfillment response messages in streaming APIs. If a webhook is specified, it happens before Dialogflow invokes webhook. Warning: 1) This flag only affects streaming API. Responses are still queued and returned once in non-streaming API. 2) The flag can be enabled in any fulfillment but only the first 3 partial responses will be returned. You may only want to apply it to fulfillments that have slow webhooks. @@ -1623,8 +1735,8 @@

Method Details

"maxDigits": 42, # Max length of DTMF digits. }, "loggingSettings": { # Define behaviors on logging. # Settings for logging. Settings for Dialogflow History, Contact Center messages, StackDriver logs, and speech logging. Exposed at the following levels: - Agent level. - "enableInteractionLogging": True or False, # If true, DF Interaction logging is currently enabled. - "enableStackdriverLogging": True or False, # If true, StackDriver logging is currently enabled. + "enableInteractionLogging": True or False, # Enables DF Interaction logging. + "enableStackdriverLogging": True or False, # Enables StackDriver logging. }, "speechSettings": { # Define behaviors of speech to text detection. # Settings for speech to text detection. Exposed at the following levels: - Agent level - Flow level - Page level - Parameter level "endpointerSensitivity": 42, # Sensitivity of the speech model that detects the end of speech. Scale from 0 to 100. @@ -1688,6 +1800,13 @@

Method Details

"A String", ], }, + "toolCall": { # Represents a call of a specific tool's action with the specified inputs. # Returns the definition of a tool call that should be executed by the client. + "action": "A String", # Required. The name of the tool's action associated with this call. + "inputParameters": { # Optional. The action's input parameters. + "a_key": "", # Properties of the object. + }, + "tool": "A String", # Required. The tool associated with this call. Format: `projects//locations//agents//tools/`. + }, }, }, ], @@ -1744,6 +1863,13 @@

Method Details

"A String", ], }, + "toolCall": { # Represents a call of a specific tool's action with the specified inputs. # Returns the definition of a tool call that should be executed by the client. + "action": "A String", # Required. The name of the tool's action associated with this call. + "inputParameters": { # Optional. The action's input parameters. + "a_key": "", # Properties of the object. + }, + "tool": "A String", # Required. The tool associated with this call. Format: `projects//locations//agents//tools/`. + }, }, ], "returnPartialResponses": True or False, # Whether Dialogflow should return currently queued fulfillment response messages in streaming APIs. If a webhook is specified, it happens before Dialogflow invokes webhook. Warning: 1) This flag only affects streaming API. Responses are still queued and returned once in non-streaming API. 2) The flag can be enabled in any fulfillment but only the first 3 partial responses will be returned. You may only want to apply it to fulfillments that have slow webhooks. @@ -1877,8 +2003,8 @@

Method Details

"maxDigits": 42, # Max length of DTMF digits. }, "loggingSettings": { # Define behaviors on logging. # Settings for logging. Settings for Dialogflow History, Contact Center messages, StackDriver logs, and speech logging. Exposed at the following levels: - Agent level. - "enableInteractionLogging": True or False, # If true, DF Interaction logging is currently enabled. - "enableStackdriverLogging": True or False, # If true, StackDriver logging is currently enabled. + "enableInteractionLogging": True or False, # Enables DF Interaction logging. + "enableStackdriverLogging": True or False, # Enables StackDriver logging. }, "speechSettings": { # Define behaviors of speech to text detection. # Settings for speech to text detection. Exposed at the following levels: - Agent level - Flow level - Page level - Parameter level "endpointerSensitivity": 42, # Sensitivity of the speech model that detects the end of speech. Scale from 0 to 100. @@ -1910,8 +2036,8 @@

Method Details

"maxDigits": 42, # Max length of DTMF digits. }, "loggingSettings": { # Define behaviors on logging. # Settings for logging. Settings for Dialogflow History, Contact Center messages, StackDriver logs, and speech logging. Exposed at the following levels: - Agent level. - "enableInteractionLogging": True or False, # If true, DF Interaction logging is currently enabled. - "enableStackdriverLogging": True or False, # If true, StackDriver logging is currently enabled. + "enableInteractionLogging": True or False, # Enables DF Interaction logging. + "enableStackdriverLogging": True or False, # Enables StackDriver logging. }, "speechSettings": { # Define behaviors of speech to text detection. # Settings for speech to text detection. Exposed at the following levels: - Agent level - Flow level - Page level - Parameter level "endpointerSensitivity": 42, # Sensitivity of the speech model that detects the end of speech. Scale from 0 to 100. @@ -1975,6 +2101,13 @@

Method Details

"A String", ], }, + "toolCall": { # Represents a call of a specific tool's action with the specified inputs. # Returns the definition of a tool call that should be executed by the client. + "action": "A String", # Required. The name of the tool's action associated with this call. + "inputParameters": { # Optional. The action's input parameters. + "a_key": "", # Properties of the object. + }, + "tool": "A String", # Required. The tool associated with this call. Format: `projects//locations//agents//tools/`. + }, }, }, ], @@ -2031,6 +2164,13 @@

Method Details

"A String", ], }, + "toolCall": { # Represents a call of a specific tool's action with the specified inputs. # Returns the definition of a tool call that should be executed by the client. + "action": "A String", # Required. The name of the tool's action associated with this call. + "inputParameters": { # Optional. The action's input parameters. + "a_key": "", # Properties of the object. + }, + "tool": "A String", # Required. The tool associated with this call. Format: `projects//locations//agents//tools/`. + }, }, ], "returnPartialResponses": True or False, # Whether Dialogflow should return currently queued fulfillment response messages in streaming APIs. If a webhook is specified, it happens before Dialogflow invokes webhook. Warning: 1) This flag only affects streaming API. Responses are still queued and returned once in non-streaming API. 2) The flag can be enabled in any fulfillment but only the first 3 partial responses will be returned. You may only want to apply it to fulfillments that have slow webhooks. @@ -2068,8 +2208,8 @@

Method Details

"maxDigits": 42, # Max length of DTMF digits. }, "loggingSettings": { # Define behaviors on logging. # Settings for logging. Settings for Dialogflow History, Contact Center messages, StackDriver logs, and speech logging. Exposed at the following levels: - Agent level. - "enableInteractionLogging": True or False, # If true, DF Interaction logging is currently enabled. - "enableStackdriverLogging": True or False, # If true, StackDriver logging is currently enabled. + "enableInteractionLogging": True or False, # Enables DF Interaction logging. + "enableStackdriverLogging": True or False, # Enables StackDriver logging. }, "speechSettings": { # Define behaviors of speech to text detection. # Settings for speech to text detection. Exposed at the following levels: - Agent level - Flow level - Page level - Parameter level "endpointerSensitivity": 42, # Sensitivity of the speech model that detects the end of speech. Scale from 0 to 100. @@ -2133,6 +2273,13 @@

Method Details

"A String", ], }, + "toolCall": { # Represents a call of a specific tool's action with the specified inputs. # Returns the definition of a tool call that should be executed by the client. + "action": "A String", # Required. The name of the tool's action associated with this call. + "inputParameters": { # Optional. The action's input parameters. + "a_key": "", # Properties of the object. + }, + "tool": "A String", # Required. The tool associated with this call. Format: `projects//locations//agents//tools/`. + }, }, }, ], @@ -2189,6 +2336,13 @@

Method Details

"A String", ], }, + "toolCall": { # Represents a call of a specific tool's action with the specified inputs. # Returns the definition of a tool call that should be executed by the client. + "action": "A String", # Required. The name of the tool's action associated with this call. + "inputParameters": { # Optional. The action's input parameters. + "a_key": "", # Properties of the object. + }, + "tool": "A String", # Required. The tool associated with this call. Format: `projects//locations//agents//tools/`. + }, }, ], "returnPartialResponses": True or False, # Whether Dialogflow should return currently queued fulfillment response messages in streaming APIs. If a webhook is specified, it happens before Dialogflow invokes webhook. Warning: 1) This flag only affects streaming API. Responses are still queued and returned once in non-streaming API. 2) The flag can be enabled in any fulfillment but only the first 3 partial responses will be returned. You may only want to apply it to fulfillments that have slow webhooks. @@ -2238,8 +2392,8 @@

Method Details

"maxDigits": 42, # Max length of DTMF digits. }, "loggingSettings": { # Define behaviors on logging. # Settings for logging. Settings for Dialogflow History, Contact Center messages, StackDriver logs, and speech logging. Exposed at the following levels: - Agent level. - "enableInteractionLogging": True or False, # If true, DF Interaction logging is currently enabled. - "enableStackdriverLogging": True or False, # If true, StackDriver logging is currently enabled. + "enableInteractionLogging": True or False, # Enables DF Interaction logging. + "enableStackdriverLogging": True or False, # Enables StackDriver logging. }, "speechSettings": { # Define behaviors of speech to text detection. # Settings for speech to text detection. Exposed at the following levels: - Agent level - Flow level - Page level - Parameter level "endpointerSensitivity": 42, # Sensitivity of the speech model that detects the end of speech. Scale from 0 to 100. @@ -2303,6 +2457,13 @@

Method Details

"A String", ], }, + "toolCall": { # Represents a call of a specific tool's action with the specified inputs. # Returns the definition of a tool call that should be executed by the client. + "action": "A String", # Required. The name of the tool's action associated with this call. + "inputParameters": { # Optional. The action's input parameters. + "a_key": "", # Properties of the object. + }, + "tool": "A String", # Required. The tool associated with this call. Format: `projects//locations//agents//tools/`. + }, }, }, ], @@ -2359,6 +2520,13 @@

Method Details

"A String", ], }, + "toolCall": { # Represents a call of a specific tool's action with the specified inputs. # Returns the definition of a tool call that should be executed by the client. + "action": "A String", # Required. The name of the tool's action associated with this call. + "inputParameters": { # Optional. The action's input parameters. + "a_key": "", # Properties of the object. + }, + "tool": "A String", # Required. The tool associated with this call. Format: `projects//locations//agents//tools/`. + }, }, ], "returnPartialResponses": True or False, # Whether Dialogflow should return currently queued fulfillment response messages in streaming APIs. If a webhook is specified, it happens before Dialogflow invokes webhook. Warning: 1) This flag only affects streaming API. Responses are still queued and returned once in non-streaming API. 2) The flag can be enabled in any fulfillment but only the first 3 partial responses will be returned. You may only want to apply it to fulfillments that have slow webhooks. @@ -2415,8 +2583,8 @@

Method Details

"maxDigits": 42, # Max length of DTMF digits. }, "loggingSettings": { # Define behaviors on logging. # Settings for logging. Settings for Dialogflow History, Contact Center messages, StackDriver logs, and speech logging. Exposed at the following levels: - Agent level. - "enableInteractionLogging": True or False, # If true, DF Interaction logging is currently enabled. - "enableStackdriverLogging": True or False, # If true, StackDriver logging is currently enabled. + "enableInteractionLogging": True or False, # Enables DF Interaction logging. + "enableStackdriverLogging": True or False, # Enables StackDriver logging. }, "speechSettings": { # Define behaviors of speech to text detection. # Settings for speech to text detection. Exposed at the following levels: - Agent level - Flow level - Page level - Parameter level "endpointerSensitivity": 42, # Sensitivity of the speech model that detects the end of speech. Scale from 0 to 100. @@ -2448,8 +2616,8 @@

Method Details

"maxDigits": 42, # Max length of DTMF digits. }, "loggingSettings": { # Define behaviors on logging. # Settings for logging. Settings for Dialogflow History, Contact Center messages, StackDriver logs, and speech logging. Exposed at the following levels: - Agent level. - "enableInteractionLogging": True or False, # If true, DF Interaction logging is currently enabled. - "enableStackdriverLogging": True or False, # If true, StackDriver logging is currently enabled. + "enableInteractionLogging": True or False, # Enables DF Interaction logging. + "enableStackdriverLogging": True or False, # Enables StackDriver logging. }, "speechSettings": { # Define behaviors of speech to text detection. # Settings for speech to text detection. Exposed at the following levels: - Agent level - Flow level - Page level - Parameter level "endpointerSensitivity": 42, # Sensitivity of the speech model that detects the end of speech. Scale from 0 to 100. @@ -2513,6 +2681,13 @@

Method Details

"A String", ], }, + "toolCall": { # Represents a call of a specific tool's action with the specified inputs. # Returns the definition of a tool call that should be executed by the client. + "action": "A String", # Required. The name of the tool's action associated with this call. + "inputParameters": { # Optional. The action's input parameters. + "a_key": "", # Properties of the object. + }, + "tool": "A String", # Required. The tool associated with this call. Format: `projects//locations//agents//tools/`. + }, }, }, ], @@ -2569,6 +2744,13 @@

Method Details

"A String", ], }, + "toolCall": { # Represents a call of a specific tool's action with the specified inputs. # Returns the definition of a tool call that should be executed by the client. + "action": "A String", # Required. The name of the tool's action associated with this call. + "inputParameters": { # Optional. The action's input parameters. + "a_key": "", # Properties of the object. + }, + "tool": "A String", # Required. The tool associated with this call. Format: `projects//locations//agents//tools/`. + }, }, ], "returnPartialResponses": True or False, # Whether Dialogflow should return currently queued fulfillment response messages in streaming APIs. If a webhook is specified, it happens before Dialogflow invokes webhook. Warning: 1) This flag only affects streaming API. Responses are still queued and returned once in non-streaming API. 2) The flag can be enabled in any fulfillment but only the first 3 partial responses will be returned. You may only want to apply it to fulfillments that have slow webhooks. @@ -2606,8 +2788,8 @@

Method Details

"maxDigits": 42, # Max length of DTMF digits. }, "loggingSettings": { # Define behaviors on logging. # Settings for logging. Settings for Dialogflow History, Contact Center messages, StackDriver logs, and speech logging. Exposed at the following levels: - Agent level. - "enableInteractionLogging": True or False, # If true, DF Interaction logging is currently enabled. - "enableStackdriverLogging": True or False, # If true, StackDriver logging is currently enabled. + "enableInteractionLogging": True or False, # Enables DF Interaction logging. + "enableStackdriverLogging": True or False, # Enables StackDriver logging. }, "speechSettings": { # Define behaviors of speech to text detection. # Settings for speech to text detection. Exposed at the following levels: - Agent level - Flow level - Page level - Parameter level "endpointerSensitivity": 42, # Sensitivity of the speech model that detects the end of speech. Scale from 0 to 100. @@ -2671,6 +2853,13 @@

Method Details

"A String", ], }, + "toolCall": { # Represents a call of a specific tool's action with the specified inputs. # Returns the definition of a tool call that should be executed by the client. + "action": "A String", # Required. The name of the tool's action associated with this call. + "inputParameters": { # Optional. The action's input parameters. + "a_key": "", # Properties of the object. + }, + "tool": "A String", # Required. The tool associated with this call. Format: `projects//locations//agents//tools/`. + }, }, }, ], @@ -2727,6 +2916,13 @@

Method Details

"A String", ], }, + "toolCall": { # Represents a call of a specific tool's action with the specified inputs. # Returns the definition of a tool call that should be executed by the client. + "action": "A String", # Required. The name of the tool's action associated with this call. + "inputParameters": { # Optional. The action's input parameters. + "a_key": "", # Properties of the object. + }, + "tool": "A String", # Required. The tool associated with this call. Format: `projects//locations//agents//tools/`. + }, }, ], "returnPartialResponses": True or False, # Whether Dialogflow should return currently queued fulfillment response messages in streaming APIs. If a webhook is specified, it happens before Dialogflow invokes webhook. Warning: 1) This flag only affects streaming API. Responses are still queued and returned once in non-streaming API. 2) The flag can be enabled in any fulfillment but only the first 3 partial responses will be returned. You may only want to apply it to fulfillments that have slow webhooks. @@ -2776,8 +2972,8 @@

Method Details

"maxDigits": 42, # Max length of DTMF digits. }, "loggingSettings": { # Define behaviors on logging. # Settings for logging. Settings for Dialogflow History, Contact Center messages, StackDriver logs, and speech logging. Exposed at the following levels: - Agent level. - "enableInteractionLogging": True or False, # If true, DF Interaction logging is currently enabled. - "enableStackdriverLogging": True or False, # If true, StackDriver logging is currently enabled. + "enableInteractionLogging": True or False, # Enables DF Interaction logging. + "enableStackdriverLogging": True or False, # Enables StackDriver logging. }, "speechSettings": { # Define behaviors of speech to text detection. # Settings for speech to text detection. Exposed at the following levels: - Agent level - Flow level - Page level - Parameter level "endpointerSensitivity": 42, # Sensitivity of the speech model that detects the end of speech. Scale from 0 to 100. @@ -2841,6 +3037,13 @@

Method Details

"A String", ], }, + "toolCall": { # Represents a call of a specific tool's action with the specified inputs. # Returns the definition of a tool call that should be executed by the client. + "action": "A String", # Required. The name of the tool's action associated with this call. + "inputParameters": { # Optional. The action's input parameters. + "a_key": "", # Properties of the object. + }, + "tool": "A String", # Required. The tool associated with this call. Format: `projects//locations//agents//tools/`. + }, }, }, ], @@ -2897,6 +3100,13 @@

Method Details

"A String", ], }, + "toolCall": { # Represents a call of a specific tool's action with the specified inputs. # Returns the definition of a tool call that should be executed by the client. + "action": "A String", # Required. The name of the tool's action associated with this call. + "inputParameters": { # Optional. The action's input parameters. + "a_key": "", # Properties of the object. + }, + "tool": "A String", # Required. The tool associated with this call. Format: `projects//locations//agents//tools/`. + }, }, ], "returnPartialResponses": True or False, # Whether Dialogflow should return currently queued fulfillment response messages in streaming APIs. If a webhook is specified, it happens before Dialogflow invokes webhook. Warning: 1) This flag only affects streaming API. Responses are still queued and returned once in non-streaming API. 2) The flag can be enabled in any fulfillment but only the first 3 partial responses will be returned. You may only want to apply it to fulfillments that have slow webhooks. @@ -2936,8 +3146,8 @@

Method Details

"maxDigits": 42, # Max length of DTMF digits. }, "loggingSettings": { # Define behaviors on logging. # Settings for logging. Settings for Dialogflow History, Contact Center messages, StackDriver logs, and speech logging. Exposed at the following levels: - Agent level. - "enableInteractionLogging": True or False, # If true, DF Interaction logging is currently enabled. - "enableStackdriverLogging": True or False, # If true, StackDriver logging is currently enabled. + "enableInteractionLogging": True or False, # Enables DF Interaction logging. + "enableStackdriverLogging": True or False, # Enables StackDriver logging. }, "speechSettings": { # Define behaviors of speech to text detection. # Settings for speech to text detection. Exposed at the following levels: - Agent level - Flow level - Page level - Parameter level "endpointerSensitivity": 42, # Sensitivity of the speech model that detects the end of speech. Scale from 0 to 100. @@ -2969,8 +3179,8 @@

Method Details

"maxDigits": 42, # Max length of DTMF digits. }, "loggingSettings": { # Define behaviors on logging. # Settings for logging. Settings for Dialogflow History, Contact Center messages, StackDriver logs, and speech logging. Exposed at the following levels: - Agent level. - "enableInteractionLogging": True or False, # If true, DF Interaction logging is currently enabled. - "enableStackdriverLogging": True or False, # If true, StackDriver logging is currently enabled. + "enableInteractionLogging": True or False, # Enables DF Interaction logging. + "enableStackdriverLogging": True or False, # Enables StackDriver logging. }, "speechSettings": { # Define behaviors of speech to text detection. # Settings for speech to text detection. Exposed at the following levels: - Agent level - Flow level - Page level - Parameter level "endpointerSensitivity": 42, # Sensitivity of the speech model that detects the end of speech. Scale from 0 to 100. @@ -3034,6 +3244,13 @@

Method Details

"A String", ], }, + "toolCall": { # Represents a call of a specific tool's action with the specified inputs. # Returns the definition of a tool call that should be executed by the client. + "action": "A String", # Required. The name of the tool's action associated with this call. + "inputParameters": { # Optional. The action's input parameters. + "a_key": "", # Properties of the object. + }, + "tool": "A String", # Required. The tool associated with this call. Format: `projects//locations//agents//tools/`. + }, }, }, ], @@ -3090,6 +3307,13 @@

Method Details

"A String", ], }, + "toolCall": { # Represents a call of a specific tool's action with the specified inputs. # Returns the definition of a tool call that should be executed by the client. + "action": "A String", # Required. The name of the tool's action associated with this call. + "inputParameters": { # Optional. The action's input parameters. + "a_key": "", # Properties of the object. + }, + "tool": "A String", # Required. The tool associated with this call. Format: `projects//locations//agents//tools/`. + }, }, ], "returnPartialResponses": True or False, # Whether Dialogflow should return currently queued fulfillment response messages in streaming APIs. If a webhook is specified, it happens before Dialogflow invokes webhook. Warning: 1) This flag only affects streaming API. Responses are still queued and returned once in non-streaming API. 2) The flag can be enabled in any fulfillment but only the first 3 partial responses will be returned. You may only want to apply it to fulfillments that have slow webhooks. @@ -3127,8 +3351,8 @@

Method Details

"maxDigits": 42, # Max length of DTMF digits. }, "loggingSettings": { # Define behaviors on logging. # Settings for logging. Settings for Dialogflow History, Contact Center messages, StackDriver logs, and speech logging. Exposed at the following levels: - Agent level. - "enableInteractionLogging": True or False, # If true, DF Interaction logging is currently enabled. - "enableStackdriverLogging": True or False, # If true, StackDriver logging is currently enabled. + "enableInteractionLogging": True or False, # Enables DF Interaction logging. + "enableStackdriverLogging": True or False, # Enables StackDriver logging. }, "speechSettings": { # Define behaviors of speech to text detection. # Settings for speech to text detection. Exposed at the following levels: - Agent level - Flow level - Page level - Parameter level "endpointerSensitivity": 42, # Sensitivity of the speech model that detects the end of speech. Scale from 0 to 100. @@ -3192,6 +3416,13 @@

Method Details

"A String", ], }, + "toolCall": { # Represents a call of a specific tool's action with the specified inputs. # Returns the definition of a tool call that should be executed by the client. + "action": "A String", # Required. The name of the tool's action associated with this call. + "inputParameters": { # Optional. The action's input parameters. + "a_key": "", # Properties of the object. + }, + "tool": "A String", # Required. The tool associated with this call. Format: `projects//locations//agents//tools/`. + }, }, }, ], @@ -3248,6 +3479,13 @@

Method Details

"A String", ], }, + "toolCall": { # Represents a call of a specific tool's action with the specified inputs. # Returns the definition of a tool call that should be executed by the client. + "action": "A String", # Required. The name of the tool's action associated with this call. + "inputParameters": { # Optional. The action's input parameters. + "a_key": "", # Properties of the object. + }, + "tool": "A String", # Required. The tool associated with this call. Format: `projects//locations//agents//tools/`. + }, }, ], "returnPartialResponses": True or False, # Whether Dialogflow should return currently queued fulfillment response messages in streaming APIs. If a webhook is specified, it happens before Dialogflow invokes webhook. Warning: 1) This flag only affects streaming API. Responses are still queued and returned once in non-streaming API. 2) The flag can be enabled in any fulfillment but only the first 3 partial responses will be returned. You may only want to apply it to fulfillments that have slow webhooks. @@ -3297,8 +3535,8 @@

Method Details

"maxDigits": 42, # Max length of DTMF digits. }, "loggingSettings": { # Define behaviors on logging. # Settings for logging. Settings for Dialogflow History, Contact Center messages, StackDriver logs, and speech logging. Exposed at the following levels: - Agent level. - "enableInteractionLogging": True or False, # If true, DF Interaction logging is currently enabled. - "enableStackdriverLogging": True or False, # If true, StackDriver logging is currently enabled. + "enableInteractionLogging": True or False, # Enables DF Interaction logging. + "enableStackdriverLogging": True or False, # Enables StackDriver logging. }, "speechSettings": { # Define behaviors of speech to text detection. # Settings for speech to text detection. Exposed at the following levels: - Agent level - Flow level - Page level - Parameter level "endpointerSensitivity": 42, # Sensitivity of the speech model that detects the end of speech. Scale from 0 to 100. @@ -3362,6 +3600,13 @@

Method Details

"A String", ], }, + "toolCall": { # Represents a call of a specific tool's action with the specified inputs. # Returns the definition of a tool call that should be executed by the client. + "action": "A String", # Required. The name of the tool's action associated with this call. + "inputParameters": { # Optional. The action's input parameters. + "a_key": "", # Properties of the object. + }, + "tool": "A String", # Required. The tool associated with this call. Format: `projects//locations//agents//tools/`. + }, }, }, ], @@ -3418,6 +3663,13 @@

Method Details

"A String", ], }, + "toolCall": { # Represents a call of a specific tool's action with the specified inputs. # Returns the definition of a tool call that should be executed by the client. + "action": "A String", # Required. The name of the tool's action associated with this call. + "inputParameters": { # Optional. The action's input parameters. + "a_key": "", # Properties of the object. + }, + "tool": "A String", # Required. The tool associated with this call. Format: `projects//locations//agents//tools/`. + }, }, ], "returnPartialResponses": True or False, # Whether Dialogflow should return currently queued fulfillment response messages in streaming APIs. If a webhook is specified, it happens before Dialogflow invokes webhook. Warning: 1) This flag only affects streaming API. Responses are still queued and returned once in non-streaming API. 2) The flag can be enabled in any fulfillment but only the first 3 partial responses will be returned. You may only want to apply it to fulfillments that have slow webhooks. diff --git a/docs/dyn/dialogflow_v3beta1.projects.locations.agents.flows.pages.html b/docs/dyn/dialogflow_v3beta1.projects.locations.agents.flows.pages.html index eb7d9cea6cc..bc450131c72 100644 --- a/docs/dyn/dialogflow_v3beta1.projects.locations.agents.flows.pages.html +++ b/docs/dyn/dialogflow_v3beta1.projects.locations.agents.flows.pages.html @@ -123,8 +123,8 @@

Method Details

"maxDigits": 42, # Max length of DTMF digits. }, "loggingSettings": { # Define behaviors on logging. # Settings for logging. Settings for Dialogflow History, Contact Center messages, StackDriver logs, and speech logging. Exposed at the following levels: - Agent level. - "enableInteractionLogging": True or False, # If true, DF Interaction logging is currently enabled. - "enableStackdriverLogging": True or False, # If true, StackDriver logging is currently enabled. + "enableInteractionLogging": True or False, # Enables DF Interaction logging. + "enableStackdriverLogging": True or False, # Enables StackDriver logging. }, "speechSettings": { # Define behaviors of speech to text detection. # Settings for speech to text detection. Exposed at the following levels: - Agent level - Flow level - Page level - Parameter level "endpointerSensitivity": 42, # Sensitivity of the speech model that detects the end of speech. Scale from 0 to 100. @@ -150,8 +150,8 @@

Method Details

"maxDigits": 42, # Max length of DTMF digits. }, "loggingSettings": { # Define behaviors on logging. # Settings for logging. Settings for Dialogflow History, Contact Center messages, StackDriver logs, and speech logging. Exposed at the following levels: - Agent level. - "enableInteractionLogging": True or False, # If true, DF Interaction logging is currently enabled. - "enableStackdriverLogging": True or False, # If true, StackDriver logging is currently enabled. + "enableInteractionLogging": True or False, # Enables DF Interaction logging. + "enableStackdriverLogging": True or False, # Enables StackDriver logging. }, "speechSettings": { # Define behaviors of speech to text detection. # Settings for speech to text detection. Exposed at the following levels: - Agent level - Flow level - Page level - Parameter level "endpointerSensitivity": 42, # Sensitivity of the speech model that detects the end of speech. Scale from 0 to 100. @@ -215,6 +215,13 @@

Method Details

"A String", ], }, + "toolCall": { # Represents a call of a specific tool's action with the specified inputs. # Returns the definition of a tool call that should be executed by the client. + "action": "A String", # Required. The name of the tool's action associated with this call. + "inputParameters": { # Optional. The action's input parameters. + "a_key": "", # Properties of the object. + }, + "tool": "A String", # Required. The tool associated with this call. Format: `projects//locations//agents//tools/`. + }, }, }, ], @@ -271,6 +278,13 @@

Method Details

"A String", ], }, + "toolCall": { # Represents a call of a specific tool's action with the specified inputs. # Returns the definition of a tool call that should be executed by the client. + "action": "A String", # Required. The name of the tool's action associated with this call. + "inputParameters": { # Optional. The action's input parameters. + "a_key": "", # Properties of the object. + }, + "tool": "A String", # Required. The tool associated with this call. Format: `projects//locations//agents//tools/`. + }, }, ], "returnPartialResponses": True or False, # Whether Dialogflow should return currently queued fulfillment response messages in streaming APIs. If a webhook is specified, it happens before Dialogflow invokes webhook. Warning: 1) This flag only affects streaming API. Responses are still queued and returned once in non-streaming API. 2) The flag can be enabled in any fulfillment but only the first 3 partial responses will be returned. You may only want to apply it to fulfillments that have slow webhooks. @@ -302,8 +316,8 @@

Method Details

"maxDigits": 42, # Max length of DTMF digits. }, "loggingSettings": { # Define behaviors on logging. # Settings for logging. Settings for Dialogflow History, Contact Center messages, StackDriver logs, and speech logging. Exposed at the following levels: - Agent level. - "enableInteractionLogging": True or False, # If true, DF Interaction logging is currently enabled. - "enableStackdriverLogging": True or False, # If true, StackDriver logging is currently enabled. + "enableInteractionLogging": True or False, # Enables DF Interaction logging. + "enableStackdriverLogging": True or False, # Enables StackDriver logging. }, "speechSettings": { # Define behaviors of speech to text detection. # Settings for speech to text detection. Exposed at the following levels: - Agent level - Flow level - Page level - Parameter level "endpointerSensitivity": 42, # Sensitivity of the speech model that detects the end of speech. Scale from 0 to 100. @@ -367,6 +381,13 @@

Method Details

"A String", ], }, + "toolCall": { # Represents a call of a specific tool's action with the specified inputs. # Returns the definition of a tool call that should be executed by the client. + "action": "A String", # Required. The name of the tool's action associated with this call. + "inputParameters": { # Optional. The action's input parameters. + "a_key": "", # Properties of the object. + }, + "tool": "A String", # Required. The tool associated with this call. Format: `projects//locations//agents//tools/`. + }, }, }, ], @@ -423,6 +444,13 @@

Method Details

"A String", ], }, + "toolCall": { # Represents a call of a specific tool's action with the specified inputs. # Returns the definition of a tool call that should be executed by the client. + "action": "A String", # Required. The name of the tool's action associated with this call. + "inputParameters": { # Optional. The action's input parameters. + "a_key": "", # Properties of the object. + }, + "tool": "A String", # Required. The tool associated with this call. Format: `projects//locations//agents//tools/`. + }, }, ], "returnPartialResponses": True or False, # Whether Dialogflow should return currently queued fulfillment response messages in streaming APIs. If a webhook is specified, it happens before Dialogflow invokes webhook. Warning: 1) This flag only affects streaming API. Responses are still queued and returned once in non-streaming API. 2) The flag can be enabled in any fulfillment but only the first 3 partial responses will be returned. You may only want to apply it to fulfillments that have slow webhooks. @@ -452,8 +480,8 @@

Method Details

"maxDigits": 42, # Max length of DTMF digits. }, "loggingSettings": { # Define behaviors on logging. # Settings for logging. Settings for Dialogflow History, Contact Center messages, StackDriver logs, and speech logging. Exposed at the following levels: - Agent level. - "enableInteractionLogging": True or False, # If true, DF Interaction logging is currently enabled. - "enableStackdriverLogging": True or False, # If true, StackDriver logging is currently enabled. + "enableInteractionLogging": True or False, # Enables DF Interaction logging. + "enableStackdriverLogging": True or False, # Enables StackDriver logging. }, "speechSettings": { # Define behaviors of speech to text detection. # Settings for speech to text detection. Exposed at the following levels: - Agent level - Flow level - Page level - Parameter level "endpointerSensitivity": 42, # Sensitivity of the speech model that detects the end of speech. Scale from 0 to 100. @@ -481,8 +509,8 @@

Method Details

"maxDigits": 42, # Max length of DTMF digits. }, "loggingSettings": { # Define behaviors on logging. # Settings for logging. Settings for Dialogflow History, Contact Center messages, StackDriver logs, and speech logging. Exposed at the following levels: - Agent level. - "enableInteractionLogging": True or False, # If true, DF Interaction logging is currently enabled. - "enableStackdriverLogging": True or False, # If true, StackDriver logging is currently enabled. + "enableInteractionLogging": True or False, # Enables DF Interaction logging. + "enableStackdriverLogging": True or False, # Enables StackDriver logging. }, "speechSettings": { # Define behaviors of speech to text detection. # Settings for speech to text detection. Exposed at the following levels: - Agent level - Flow level - Page level - Parameter level "endpointerSensitivity": 42, # Sensitivity of the speech model that detects the end of speech. Scale from 0 to 100. @@ -546,6 +574,13 @@

Method Details

"A String", ], }, + "toolCall": { # Represents a call of a specific tool's action with the specified inputs. # Returns the definition of a tool call that should be executed by the client. + "action": "A String", # Required. The name of the tool's action associated with this call. + "inputParameters": { # Optional. The action's input parameters. + "a_key": "", # Properties of the object. + }, + "tool": "A String", # Required. The tool associated with this call. Format: `projects//locations//agents//tools/`. + }, }, }, ], @@ -602,6 +637,13 @@

Method Details

"A String", ], }, + "toolCall": { # Represents a call of a specific tool's action with the specified inputs. # Returns the definition of a tool call that should be executed by the client. + "action": "A String", # Required. The name of the tool's action associated with this call. + "inputParameters": { # Optional. The action's input parameters. + "a_key": "", # Properties of the object. + }, + "tool": "A String", # Required. The tool associated with this call. Format: `projects//locations//agents//tools/`. + }, }, ], "returnPartialResponses": True or False, # Whether Dialogflow should return currently queued fulfillment response messages in streaming APIs. If a webhook is specified, it happens before Dialogflow invokes webhook. Warning: 1) This flag only affects streaming API. Responses are still queued and returned once in non-streaming API. 2) The flag can be enabled in any fulfillment but only the first 3 partial responses will be returned. You may only want to apply it to fulfillments that have slow webhooks. @@ -633,8 +675,8 @@

Method Details

"maxDigits": 42, # Max length of DTMF digits. }, "loggingSettings": { # Define behaviors on logging. # Settings for logging. Settings for Dialogflow History, Contact Center messages, StackDriver logs, and speech logging. Exposed at the following levels: - Agent level. - "enableInteractionLogging": True or False, # If true, DF Interaction logging is currently enabled. - "enableStackdriverLogging": True or False, # If true, StackDriver logging is currently enabled. + "enableInteractionLogging": True or False, # Enables DF Interaction logging. + "enableStackdriverLogging": True or False, # Enables StackDriver logging. }, "speechSettings": { # Define behaviors of speech to text detection. # Settings for speech to text detection. Exposed at the following levels: - Agent level - Flow level - Page level - Parameter level "endpointerSensitivity": 42, # Sensitivity of the speech model that detects the end of speech. Scale from 0 to 100. @@ -698,6 +740,13 @@

Method Details

"A String", ], }, + "toolCall": { # Represents a call of a specific tool's action with the specified inputs. # Returns the definition of a tool call that should be executed by the client. + "action": "A String", # Required. The name of the tool's action associated with this call. + "inputParameters": { # Optional. The action's input parameters. + "a_key": "", # Properties of the object. + }, + "tool": "A String", # Required. The tool associated with this call. Format: `projects//locations//agents//tools/`. + }, }, }, ], @@ -754,6 +803,13 @@

Method Details

"A String", ], }, + "toolCall": { # Represents a call of a specific tool's action with the specified inputs. # Returns the definition of a tool call that should be executed by the client. + "action": "A String", # Required. The name of the tool's action associated with this call. + "inputParameters": { # Optional. The action's input parameters. + "a_key": "", # Properties of the object. + }, + "tool": "A String", # Required. The tool associated with this call. Format: `projects//locations//agents//tools/`. + }, }, ], "returnPartialResponses": True or False, # Whether Dialogflow should return currently queued fulfillment response messages in streaming APIs. If a webhook is specified, it happens before Dialogflow invokes webhook. Warning: 1) This flag only affects streaming API. Responses are still queued and returned once in non-streaming API. 2) The flag can be enabled in any fulfillment but only the first 3 partial responses will be returned. You may only want to apply it to fulfillments that have slow webhooks. @@ -798,8 +854,8 @@

Method Details

"maxDigits": 42, # Max length of DTMF digits. }, "loggingSettings": { # Define behaviors on logging. # Settings for logging. Settings for Dialogflow History, Contact Center messages, StackDriver logs, and speech logging. Exposed at the following levels: - Agent level. - "enableInteractionLogging": True or False, # If true, DF Interaction logging is currently enabled. - "enableStackdriverLogging": True or False, # If true, StackDriver logging is currently enabled. + "enableInteractionLogging": True or False, # Enables DF Interaction logging. + "enableStackdriverLogging": True or False, # Enables StackDriver logging. }, "speechSettings": { # Define behaviors of speech to text detection. # Settings for speech to text detection. Exposed at the following levels: - Agent level - Flow level - Page level - Parameter level "endpointerSensitivity": 42, # Sensitivity of the speech model that detects the end of speech. Scale from 0 to 100. @@ -863,6 +919,13 @@

Method Details

"A String", ], }, + "toolCall": { # Represents a call of a specific tool's action with the specified inputs. # Returns the definition of a tool call that should be executed by the client. + "action": "A String", # Required. The name of the tool's action associated with this call. + "inputParameters": { # Optional. The action's input parameters. + "a_key": "", # Properties of the object. + }, + "tool": "A String", # Required. The tool associated with this call. Format: `projects//locations//agents//tools/`. + }, }, }, ], @@ -919,6 +982,13 @@

Method Details

"A String", ], }, + "toolCall": { # Represents a call of a specific tool's action with the specified inputs. # Returns the definition of a tool call that should be executed by the client. + "action": "A String", # Required. The name of the tool's action associated with this call. + "inputParameters": { # Optional. The action's input parameters. + "a_key": "", # Properties of the object. + }, + "tool": "A String", # Required. The tool associated with this call. Format: `projects//locations//agents//tools/`. + }, }, ], "returnPartialResponses": True or False, # Whether Dialogflow should return currently queued fulfillment response messages in streaming APIs. If a webhook is specified, it happens before Dialogflow invokes webhook. Warning: 1) This flag only affects streaming API. Responses are still queued and returned once in non-streaming API. 2) The flag can be enabled in any fulfillment but only the first 3 partial responses will be returned. You may only want to apply it to fulfillments that have slow webhooks. @@ -957,8 +1027,8 @@

Method Details

"maxDigits": 42, # Max length of DTMF digits. }, "loggingSettings": { # Define behaviors on logging. # Settings for logging. Settings for Dialogflow History, Contact Center messages, StackDriver logs, and speech logging. Exposed at the following levels: - Agent level. - "enableInteractionLogging": True or False, # If true, DF Interaction logging is currently enabled. - "enableStackdriverLogging": True or False, # If true, StackDriver logging is currently enabled. + "enableInteractionLogging": True or False, # Enables DF Interaction logging. + "enableStackdriverLogging": True or False, # Enables StackDriver logging. }, "speechSettings": { # Define behaviors of speech to text detection. # Settings for speech to text detection. Exposed at the following levels: - Agent level - Flow level - Page level - Parameter level "endpointerSensitivity": 42, # Sensitivity of the speech model that detects the end of speech. Scale from 0 to 100. @@ -1022,6 +1092,13 @@

Method Details

"A String", ], }, + "toolCall": { # Represents a call of a specific tool's action with the specified inputs. # Returns the definition of a tool call that should be executed by the client. + "action": "A String", # Required. The name of the tool's action associated with this call. + "inputParameters": { # Optional. The action's input parameters. + "a_key": "", # Properties of the object. + }, + "tool": "A String", # Required. The tool associated with this call. Format: `projects//locations//agents//tools/`. + }, }, }, ], @@ -1078,6 +1155,13 @@

Method Details

"A String", ], }, + "toolCall": { # Represents a call of a specific tool's action with the specified inputs. # Returns the definition of a tool call that should be executed by the client. + "action": "A String", # Required. The name of the tool's action associated with this call. + "inputParameters": { # Optional. The action's input parameters. + "a_key": "", # Properties of the object. + }, + "tool": "A String", # Required. The tool associated with this call. Format: `projects//locations//agents//tools/`. + }, }, ], "returnPartialResponses": True or False, # Whether Dialogflow should return currently queued fulfillment response messages in streaming APIs. If a webhook is specified, it happens before Dialogflow invokes webhook. Warning: 1) This flag only affects streaming API. Responses are still queued and returned once in non-streaming API. 2) The flag can be enabled in any fulfillment but only the first 3 partial responses will be returned. You may only want to apply it to fulfillments that have slow webhooks. @@ -1116,8 +1200,8 @@

Method Details

"maxDigits": 42, # Max length of DTMF digits. }, "loggingSettings": { # Define behaviors on logging. # Settings for logging. Settings for Dialogflow History, Contact Center messages, StackDriver logs, and speech logging. Exposed at the following levels: - Agent level. - "enableInteractionLogging": True or False, # If true, DF Interaction logging is currently enabled. - "enableStackdriverLogging": True or False, # If true, StackDriver logging is currently enabled. + "enableInteractionLogging": True or False, # Enables DF Interaction logging. + "enableStackdriverLogging": True or False, # Enables StackDriver logging. }, "speechSettings": { # Define behaviors of speech to text detection. # Settings for speech to text detection. Exposed at the following levels: - Agent level - Flow level - Page level - Parameter level "endpointerSensitivity": 42, # Sensitivity of the speech model that detects the end of speech. Scale from 0 to 100. @@ -1143,8 +1227,8 @@

Method Details

"maxDigits": 42, # Max length of DTMF digits. }, "loggingSettings": { # Define behaviors on logging. # Settings for logging. Settings for Dialogflow History, Contact Center messages, StackDriver logs, and speech logging. Exposed at the following levels: - Agent level. - "enableInteractionLogging": True or False, # If true, DF Interaction logging is currently enabled. - "enableStackdriverLogging": True or False, # If true, StackDriver logging is currently enabled. + "enableInteractionLogging": True or False, # Enables DF Interaction logging. + "enableStackdriverLogging": True or False, # Enables StackDriver logging. }, "speechSettings": { # Define behaviors of speech to text detection. # Settings for speech to text detection. Exposed at the following levels: - Agent level - Flow level - Page level - Parameter level "endpointerSensitivity": 42, # Sensitivity of the speech model that detects the end of speech. Scale from 0 to 100. @@ -1208,6 +1292,13 @@

Method Details

"A String", ], }, + "toolCall": { # Represents a call of a specific tool's action with the specified inputs. # Returns the definition of a tool call that should be executed by the client. + "action": "A String", # Required. The name of the tool's action associated with this call. + "inputParameters": { # Optional. The action's input parameters. + "a_key": "", # Properties of the object. + }, + "tool": "A String", # Required. The tool associated with this call. Format: `projects//locations//agents//tools/`. + }, }, }, ], @@ -1264,6 +1355,13 @@

Method Details

"A String", ], }, + "toolCall": { # Represents a call of a specific tool's action with the specified inputs. # Returns the definition of a tool call that should be executed by the client. + "action": "A String", # Required. The name of the tool's action associated with this call. + "inputParameters": { # Optional. The action's input parameters. + "a_key": "", # Properties of the object. + }, + "tool": "A String", # Required. The tool associated with this call. Format: `projects//locations//agents//tools/`. + }, }, ], "returnPartialResponses": True or False, # Whether Dialogflow should return currently queued fulfillment response messages in streaming APIs. If a webhook is specified, it happens before Dialogflow invokes webhook. Warning: 1) This flag only affects streaming API. Responses are still queued and returned once in non-streaming API. 2) The flag can be enabled in any fulfillment but only the first 3 partial responses will be returned. You may only want to apply it to fulfillments that have slow webhooks. @@ -1295,8 +1393,8 @@

Method Details

"maxDigits": 42, # Max length of DTMF digits. }, "loggingSettings": { # Define behaviors on logging. # Settings for logging. Settings for Dialogflow History, Contact Center messages, StackDriver logs, and speech logging. Exposed at the following levels: - Agent level. - "enableInteractionLogging": True or False, # If true, DF Interaction logging is currently enabled. - "enableStackdriverLogging": True or False, # If true, StackDriver logging is currently enabled. + "enableInteractionLogging": True or False, # Enables DF Interaction logging. + "enableStackdriverLogging": True or False, # Enables StackDriver logging. }, "speechSettings": { # Define behaviors of speech to text detection. # Settings for speech to text detection. Exposed at the following levels: - Agent level - Flow level - Page level - Parameter level "endpointerSensitivity": 42, # Sensitivity of the speech model that detects the end of speech. Scale from 0 to 100. @@ -1360,6 +1458,13 @@

Method Details

"A String", ], }, + "toolCall": { # Represents a call of a specific tool's action with the specified inputs. # Returns the definition of a tool call that should be executed by the client. + "action": "A String", # Required. The name of the tool's action associated with this call. + "inputParameters": { # Optional. The action's input parameters. + "a_key": "", # Properties of the object. + }, + "tool": "A String", # Required. The tool associated with this call. Format: `projects//locations//agents//tools/`. + }, }, }, ], @@ -1416,6 +1521,13 @@

Method Details

"A String", ], }, + "toolCall": { # Represents a call of a specific tool's action with the specified inputs. # Returns the definition of a tool call that should be executed by the client. + "action": "A String", # Required. The name of the tool's action associated with this call. + "inputParameters": { # Optional. The action's input parameters. + "a_key": "", # Properties of the object. + }, + "tool": "A String", # Required. The tool associated with this call. Format: `projects//locations//agents//tools/`. + }, }, ], "returnPartialResponses": True or False, # Whether Dialogflow should return currently queued fulfillment response messages in streaming APIs. If a webhook is specified, it happens before Dialogflow invokes webhook. Warning: 1) This flag only affects streaming API. Responses are still queued and returned once in non-streaming API. 2) The flag can be enabled in any fulfillment but only the first 3 partial responses will be returned. You may only want to apply it to fulfillments that have slow webhooks. @@ -1445,8 +1557,8 @@

Method Details

"maxDigits": 42, # Max length of DTMF digits. }, "loggingSettings": { # Define behaviors on logging. # Settings for logging. Settings for Dialogflow History, Contact Center messages, StackDriver logs, and speech logging. Exposed at the following levels: - Agent level. - "enableInteractionLogging": True or False, # If true, DF Interaction logging is currently enabled. - "enableStackdriverLogging": True or False, # If true, StackDriver logging is currently enabled. + "enableInteractionLogging": True or False, # Enables DF Interaction logging. + "enableStackdriverLogging": True or False, # Enables StackDriver logging. }, "speechSettings": { # Define behaviors of speech to text detection. # Settings for speech to text detection. Exposed at the following levels: - Agent level - Flow level - Page level - Parameter level "endpointerSensitivity": 42, # Sensitivity of the speech model that detects the end of speech. Scale from 0 to 100. @@ -1474,8 +1586,8 @@

Method Details

"maxDigits": 42, # Max length of DTMF digits. }, "loggingSettings": { # Define behaviors on logging. # Settings for logging. Settings for Dialogflow History, Contact Center messages, StackDriver logs, and speech logging. Exposed at the following levels: - Agent level. - "enableInteractionLogging": True or False, # If true, DF Interaction logging is currently enabled. - "enableStackdriverLogging": True or False, # If true, StackDriver logging is currently enabled. + "enableInteractionLogging": True or False, # Enables DF Interaction logging. + "enableStackdriverLogging": True or False, # Enables StackDriver logging. }, "speechSettings": { # Define behaviors of speech to text detection. # Settings for speech to text detection. Exposed at the following levels: - Agent level - Flow level - Page level - Parameter level "endpointerSensitivity": 42, # Sensitivity of the speech model that detects the end of speech. Scale from 0 to 100. @@ -1539,6 +1651,13 @@

Method Details

"A String", ], }, + "toolCall": { # Represents a call of a specific tool's action with the specified inputs. # Returns the definition of a tool call that should be executed by the client. + "action": "A String", # Required. The name of the tool's action associated with this call. + "inputParameters": { # Optional. The action's input parameters. + "a_key": "", # Properties of the object. + }, + "tool": "A String", # Required. The tool associated with this call. Format: `projects//locations//agents//tools/`. + }, }, }, ], @@ -1595,6 +1714,13 @@

Method Details

"A String", ], }, + "toolCall": { # Represents a call of a specific tool's action with the specified inputs. # Returns the definition of a tool call that should be executed by the client. + "action": "A String", # Required. The name of the tool's action associated with this call. + "inputParameters": { # Optional. The action's input parameters. + "a_key": "", # Properties of the object. + }, + "tool": "A String", # Required. The tool associated with this call. Format: `projects//locations//agents//tools/`. + }, }, ], "returnPartialResponses": True or False, # Whether Dialogflow should return currently queued fulfillment response messages in streaming APIs. If a webhook is specified, it happens before Dialogflow invokes webhook. Warning: 1) This flag only affects streaming API. Responses are still queued and returned once in non-streaming API. 2) The flag can be enabled in any fulfillment but only the first 3 partial responses will be returned. You may only want to apply it to fulfillments that have slow webhooks. @@ -1626,8 +1752,8 @@

Method Details

"maxDigits": 42, # Max length of DTMF digits. }, "loggingSettings": { # Define behaviors on logging. # Settings for logging. Settings for Dialogflow History, Contact Center messages, StackDriver logs, and speech logging. Exposed at the following levels: - Agent level. - "enableInteractionLogging": True or False, # If true, DF Interaction logging is currently enabled. - "enableStackdriverLogging": True or False, # If true, StackDriver logging is currently enabled. + "enableInteractionLogging": True or False, # Enables DF Interaction logging. + "enableStackdriverLogging": True or False, # Enables StackDriver logging. }, "speechSettings": { # Define behaviors of speech to text detection. # Settings for speech to text detection. Exposed at the following levels: - Agent level - Flow level - Page level - Parameter level "endpointerSensitivity": 42, # Sensitivity of the speech model that detects the end of speech. Scale from 0 to 100. @@ -1691,6 +1817,13 @@

Method Details

"A String", ], }, + "toolCall": { # Represents a call of a specific tool's action with the specified inputs. # Returns the definition of a tool call that should be executed by the client. + "action": "A String", # Required. The name of the tool's action associated with this call. + "inputParameters": { # Optional. The action's input parameters. + "a_key": "", # Properties of the object. + }, + "tool": "A String", # Required. The tool associated with this call. Format: `projects//locations//agents//tools/`. + }, }, }, ], @@ -1747,6 +1880,13 @@

Method Details

"A String", ], }, + "toolCall": { # Represents a call of a specific tool's action with the specified inputs. # Returns the definition of a tool call that should be executed by the client. + "action": "A String", # Required. The name of the tool's action associated with this call. + "inputParameters": { # Optional. The action's input parameters. + "a_key": "", # Properties of the object. + }, + "tool": "A String", # Required. The tool associated with this call. Format: `projects//locations//agents//tools/`. + }, }, ], "returnPartialResponses": True or False, # Whether Dialogflow should return currently queued fulfillment response messages in streaming APIs. If a webhook is specified, it happens before Dialogflow invokes webhook. Warning: 1) This flag only affects streaming API. Responses are still queued and returned once in non-streaming API. 2) The flag can be enabled in any fulfillment but only the first 3 partial responses will be returned. You may only want to apply it to fulfillments that have slow webhooks. @@ -1791,8 +1931,8 @@

Method Details

"maxDigits": 42, # Max length of DTMF digits. }, "loggingSettings": { # Define behaviors on logging. # Settings for logging. Settings for Dialogflow History, Contact Center messages, StackDriver logs, and speech logging. Exposed at the following levels: - Agent level. - "enableInteractionLogging": True or False, # If true, DF Interaction logging is currently enabled. - "enableStackdriverLogging": True or False, # If true, StackDriver logging is currently enabled. + "enableInteractionLogging": True or False, # Enables DF Interaction logging. + "enableStackdriverLogging": True or False, # Enables StackDriver logging. }, "speechSettings": { # Define behaviors of speech to text detection. # Settings for speech to text detection. Exposed at the following levels: - Agent level - Flow level - Page level - Parameter level "endpointerSensitivity": 42, # Sensitivity of the speech model that detects the end of speech. Scale from 0 to 100. @@ -1856,6 +1996,13 @@

Method Details

"A String", ], }, + "toolCall": { # Represents a call of a specific tool's action with the specified inputs. # Returns the definition of a tool call that should be executed by the client. + "action": "A String", # Required. The name of the tool's action associated with this call. + "inputParameters": { # Optional. The action's input parameters. + "a_key": "", # Properties of the object. + }, + "tool": "A String", # Required. The tool associated with this call. Format: `projects//locations//agents//tools/`. + }, }, }, ], @@ -1912,6 +2059,13 @@

Method Details

"A String", ], }, + "toolCall": { # Represents a call of a specific tool's action with the specified inputs. # Returns the definition of a tool call that should be executed by the client. + "action": "A String", # Required. The name of the tool's action associated with this call. + "inputParameters": { # Optional. The action's input parameters. + "a_key": "", # Properties of the object. + }, + "tool": "A String", # Required. The tool associated with this call. Format: `projects//locations//agents//tools/`. + }, }, ], "returnPartialResponses": True or False, # Whether Dialogflow should return currently queued fulfillment response messages in streaming APIs. If a webhook is specified, it happens before Dialogflow invokes webhook. Warning: 1) This flag only affects streaming API. Responses are still queued and returned once in non-streaming API. 2) The flag can be enabled in any fulfillment but only the first 3 partial responses will be returned. You may only want to apply it to fulfillments that have slow webhooks. @@ -1950,8 +2104,8 @@

Method Details

"maxDigits": 42, # Max length of DTMF digits. }, "loggingSettings": { # Define behaviors on logging. # Settings for logging. Settings for Dialogflow History, Contact Center messages, StackDriver logs, and speech logging. Exposed at the following levels: - Agent level. - "enableInteractionLogging": True or False, # If true, DF Interaction logging is currently enabled. - "enableStackdriverLogging": True or False, # If true, StackDriver logging is currently enabled. + "enableInteractionLogging": True or False, # Enables DF Interaction logging. + "enableStackdriverLogging": True or False, # Enables StackDriver logging. }, "speechSettings": { # Define behaviors of speech to text detection. # Settings for speech to text detection. Exposed at the following levels: - Agent level - Flow level - Page level - Parameter level "endpointerSensitivity": 42, # Sensitivity of the speech model that detects the end of speech. Scale from 0 to 100. @@ -2015,6 +2169,13 @@

Method Details

"A String", ], }, + "toolCall": { # Represents a call of a specific tool's action with the specified inputs. # Returns the definition of a tool call that should be executed by the client. + "action": "A String", # Required. The name of the tool's action associated with this call. + "inputParameters": { # Optional. The action's input parameters. + "a_key": "", # Properties of the object. + }, + "tool": "A String", # Required. The tool associated with this call. Format: `projects//locations//agents//tools/`. + }, }, }, ], @@ -2071,6 +2232,13 @@

Method Details

"A String", ], }, + "toolCall": { # Represents a call of a specific tool's action with the specified inputs. # Returns the definition of a tool call that should be executed by the client. + "action": "A String", # Required. The name of the tool's action associated with this call. + "inputParameters": { # Optional. The action's input parameters. + "a_key": "", # Properties of the object. + }, + "tool": "A String", # Required. The tool associated with this call. Format: `projects//locations//agents//tools/`. + }, }, ], "returnPartialResponses": True or False, # Whether Dialogflow should return currently queued fulfillment response messages in streaming APIs. If a webhook is specified, it happens before Dialogflow invokes webhook. Warning: 1) This flag only affects streaming API. Responses are still queued and returned once in non-streaming API. 2) The flag can be enabled in any fulfillment but only the first 3 partial responses will be returned. You may only want to apply it to fulfillments that have slow webhooks. @@ -2135,8 +2303,8 @@

Method Details

"maxDigits": 42, # Max length of DTMF digits. }, "loggingSettings": { # Define behaviors on logging. # Settings for logging. Settings for Dialogflow History, Contact Center messages, StackDriver logs, and speech logging. Exposed at the following levels: - Agent level. - "enableInteractionLogging": True or False, # If true, DF Interaction logging is currently enabled. - "enableStackdriverLogging": True or False, # If true, StackDriver logging is currently enabled. + "enableInteractionLogging": True or False, # Enables DF Interaction logging. + "enableStackdriverLogging": True or False, # Enables StackDriver logging. }, "speechSettings": { # Define behaviors of speech to text detection. # Settings for speech to text detection. Exposed at the following levels: - Agent level - Flow level - Page level - Parameter level "endpointerSensitivity": 42, # Sensitivity of the speech model that detects the end of speech. Scale from 0 to 100. @@ -2162,8 +2330,8 @@

Method Details

"maxDigits": 42, # Max length of DTMF digits. }, "loggingSettings": { # Define behaviors on logging. # Settings for logging. Settings for Dialogflow History, Contact Center messages, StackDriver logs, and speech logging. Exposed at the following levels: - Agent level. - "enableInteractionLogging": True or False, # If true, DF Interaction logging is currently enabled. - "enableStackdriverLogging": True or False, # If true, StackDriver logging is currently enabled. + "enableInteractionLogging": True or False, # Enables DF Interaction logging. + "enableStackdriverLogging": True or False, # Enables StackDriver logging. }, "speechSettings": { # Define behaviors of speech to text detection. # Settings for speech to text detection. Exposed at the following levels: - Agent level - Flow level - Page level - Parameter level "endpointerSensitivity": 42, # Sensitivity of the speech model that detects the end of speech. Scale from 0 to 100. @@ -2227,6 +2395,13 @@

Method Details

"A String", ], }, + "toolCall": { # Represents a call of a specific tool's action with the specified inputs. # Returns the definition of a tool call that should be executed by the client. + "action": "A String", # Required. The name of the tool's action associated with this call. + "inputParameters": { # Optional. The action's input parameters. + "a_key": "", # Properties of the object. + }, + "tool": "A String", # Required. The tool associated with this call. Format: `projects//locations//agents//tools/`. + }, }, }, ], @@ -2283,6 +2458,13 @@

Method Details

"A String", ], }, + "toolCall": { # Represents a call of a specific tool's action with the specified inputs. # Returns the definition of a tool call that should be executed by the client. + "action": "A String", # Required. The name of the tool's action associated with this call. + "inputParameters": { # Optional. The action's input parameters. + "a_key": "", # Properties of the object. + }, + "tool": "A String", # Required. The tool associated with this call. Format: `projects//locations//agents//tools/`. + }, }, ], "returnPartialResponses": True or False, # Whether Dialogflow should return currently queued fulfillment response messages in streaming APIs. If a webhook is specified, it happens before Dialogflow invokes webhook. Warning: 1) This flag only affects streaming API. Responses are still queued and returned once in non-streaming API. 2) The flag can be enabled in any fulfillment but only the first 3 partial responses will be returned. You may only want to apply it to fulfillments that have slow webhooks. @@ -2314,8 +2496,8 @@

Method Details

"maxDigits": 42, # Max length of DTMF digits. }, "loggingSettings": { # Define behaviors on logging. # Settings for logging. Settings for Dialogflow History, Contact Center messages, StackDriver logs, and speech logging. Exposed at the following levels: - Agent level. - "enableInteractionLogging": True or False, # If true, DF Interaction logging is currently enabled. - "enableStackdriverLogging": True or False, # If true, StackDriver logging is currently enabled. + "enableInteractionLogging": True or False, # Enables DF Interaction logging. + "enableStackdriverLogging": True or False, # Enables StackDriver logging. }, "speechSettings": { # Define behaviors of speech to text detection. # Settings for speech to text detection. Exposed at the following levels: - Agent level - Flow level - Page level - Parameter level "endpointerSensitivity": 42, # Sensitivity of the speech model that detects the end of speech. Scale from 0 to 100. @@ -2379,6 +2561,13 @@

Method Details

"A String", ], }, + "toolCall": { # Represents a call of a specific tool's action with the specified inputs. # Returns the definition of a tool call that should be executed by the client. + "action": "A String", # Required. The name of the tool's action associated with this call. + "inputParameters": { # Optional. The action's input parameters. + "a_key": "", # Properties of the object. + }, + "tool": "A String", # Required. The tool associated with this call. Format: `projects//locations//agents//tools/`. + }, }, }, ], @@ -2435,6 +2624,13 @@

Method Details

"A String", ], }, + "toolCall": { # Represents a call of a specific tool's action with the specified inputs. # Returns the definition of a tool call that should be executed by the client. + "action": "A String", # Required. The name of the tool's action associated with this call. + "inputParameters": { # Optional. The action's input parameters. + "a_key": "", # Properties of the object. + }, + "tool": "A String", # Required. The tool associated with this call. Format: `projects//locations//agents//tools/`. + }, }, ], "returnPartialResponses": True or False, # Whether Dialogflow should return currently queued fulfillment response messages in streaming APIs. If a webhook is specified, it happens before Dialogflow invokes webhook. Warning: 1) This flag only affects streaming API. Responses are still queued and returned once in non-streaming API. 2) The flag can be enabled in any fulfillment but only the first 3 partial responses will be returned. You may only want to apply it to fulfillments that have slow webhooks. @@ -2464,8 +2660,8 @@

Method Details

"maxDigits": 42, # Max length of DTMF digits. }, "loggingSettings": { # Define behaviors on logging. # Settings for logging. Settings for Dialogflow History, Contact Center messages, StackDriver logs, and speech logging. Exposed at the following levels: - Agent level. - "enableInteractionLogging": True or False, # If true, DF Interaction logging is currently enabled. - "enableStackdriverLogging": True or False, # If true, StackDriver logging is currently enabled. + "enableInteractionLogging": True or False, # Enables DF Interaction logging. + "enableStackdriverLogging": True or False, # Enables StackDriver logging. }, "speechSettings": { # Define behaviors of speech to text detection. # Settings for speech to text detection. Exposed at the following levels: - Agent level - Flow level - Page level - Parameter level "endpointerSensitivity": 42, # Sensitivity of the speech model that detects the end of speech. Scale from 0 to 100. @@ -2493,8 +2689,8 @@

Method Details

"maxDigits": 42, # Max length of DTMF digits. }, "loggingSettings": { # Define behaviors on logging. # Settings for logging. Settings for Dialogflow History, Contact Center messages, StackDriver logs, and speech logging. Exposed at the following levels: - Agent level. - "enableInteractionLogging": True or False, # If true, DF Interaction logging is currently enabled. - "enableStackdriverLogging": True or False, # If true, StackDriver logging is currently enabled. + "enableInteractionLogging": True or False, # Enables DF Interaction logging. + "enableStackdriverLogging": True or False, # Enables StackDriver logging. }, "speechSettings": { # Define behaviors of speech to text detection. # Settings for speech to text detection. Exposed at the following levels: - Agent level - Flow level - Page level - Parameter level "endpointerSensitivity": 42, # Sensitivity of the speech model that detects the end of speech. Scale from 0 to 100. @@ -2558,6 +2754,13 @@

Method Details

"A String", ], }, + "toolCall": { # Represents a call of a specific tool's action with the specified inputs. # Returns the definition of a tool call that should be executed by the client. + "action": "A String", # Required. The name of the tool's action associated with this call. + "inputParameters": { # Optional. The action's input parameters. + "a_key": "", # Properties of the object. + }, + "tool": "A String", # Required. The tool associated with this call. Format: `projects//locations//agents//tools/`. + }, }, }, ], @@ -2614,6 +2817,13 @@

Method Details

"A String", ], }, + "toolCall": { # Represents a call of a specific tool's action with the specified inputs. # Returns the definition of a tool call that should be executed by the client. + "action": "A String", # Required. The name of the tool's action associated with this call. + "inputParameters": { # Optional. The action's input parameters. + "a_key": "", # Properties of the object. + }, + "tool": "A String", # Required. The tool associated with this call. Format: `projects//locations//agents//tools/`. + }, }, ], "returnPartialResponses": True or False, # Whether Dialogflow should return currently queued fulfillment response messages in streaming APIs. If a webhook is specified, it happens before Dialogflow invokes webhook. Warning: 1) This flag only affects streaming API. Responses are still queued and returned once in non-streaming API. 2) The flag can be enabled in any fulfillment but only the first 3 partial responses will be returned. You may only want to apply it to fulfillments that have slow webhooks. @@ -2645,8 +2855,8 @@

Method Details

"maxDigits": 42, # Max length of DTMF digits. }, "loggingSettings": { # Define behaviors on logging. # Settings for logging. Settings for Dialogflow History, Contact Center messages, StackDriver logs, and speech logging. Exposed at the following levels: - Agent level. - "enableInteractionLogging": True or False, # If true, DF Interaction logging is currently enabled. - "enableStackdriverLogging": True or False, # If true, StackDriver logging is currently enabled. + "enableInteractionLogging": True or False, # Enables DF Interaction logging. + "enableStackdriverLogging": True or False, # Enables StackDriver logging. }, "speechSettings": { # Define behaviors of speech to text detection. # Settings for speech to text detection. Exposed at the following levels: - Agent level - Flow level - Page level - Parameter level "endpointerSensitivity": 42, # Sensitivity of the speech model that detects the end of speech. Scale from 0 to 100. @@ -2710,6 +2920,13 @@

Method Details

"A String", ], }, + "toolCall": { # Represents a call of a specific tool's action with the specified inputs. # Returns the definition of a tool call that should be executed by the client. + "action": "A String", # Required. The name of the tool's action associated with this call. + "inputParameters": { # Optional. The action's input parameters. + "a_key": "", # Properties of the object. + }, + "tool": "A String", # Required. The tool associated with this call. Format: `projects//locations//agents//tools/`. + }, }, }, ], @@ -2766,6 +2983,13 @@

Method Details

"A String", ], }, + "toolCall": { # Represents a call of a specific tool's action with the specified inputs. # Returns the definition of a tool call that should be executed by the client. + "action": "A String", # Required. The name of the tool's action associated with this call. + "inputParameters": { # Optional. The action's input parameters. + "a_key": "", # Properties of the object. + }, + "tool": "A String", # Required. The tool associated with this call. Format: `projects//locations//agents//tools/`. + }, }, ], "returnPartialResponses": True or False, # Whether Dialogflow should return currently queued fulfillment response messages in streaming APIs. If a webhook is specified, it happens before Dialogflow invokes webhook. Warning: 1) This flag only affects streaming API. Responses are still queued and returned once in non-streaming API. 2) The flag can be enabled in any fulfillment but only the first 3 partial responses will be returned. You may only want to apply it to fulfillments that have slow webhooks. @@ -2810,8 +3034,8 @@

Method Details

"maxDigits": 42, # Max length of DTMF digits. }, "loggingSettings": { # Define behaviors on logging. # Settings for logging. Settings for Dialogflow History, Contact Center messages, StackDriver logs, and speech logging. Exposed at the following levels: - Agent level. - "enableInteractionLogging": True or False, # If true, DF Interaction logging is currently enabled. - "enableStackdriverLogging": True or False, # If true, StackDriver logging is currently enabled. + "enableInteractionLogging": True or False, # Enables DF Interaction logging. + "enableStackdriverLogging": True or False, # Enables StackDriver logging. }, "speechSettings": { # Define behaviors of speech to text detection. # Settings for speech to text detection. Exposed at the following levels: - Agent level - Flow level - Page level - Parameter level "endpointerSensitivity": 42, # Sensitivity of the speech model that detects the end of speech. Scale from 0 to 100. @@ -2875,6 +3099,13 @@

Method Details

"A String", ], }, + "toolCall": { # Represents a call of a specific tool's action with the specified inputs. # Returns the definition of a tool call that should be executed by the client. + "action": "A String", # Required. The name of the tool's action associated with this call. + "inputParameters": { # Optional. The action's input parameters. + "a_key": "", # Properties of the object. + }, + "tool": "A String", # Required. The tool associated with this call. Format: `projects//locations//agents//tools/`. + }, }, }, ], @@ -2931,6 +3162,13 @@

Method Details

"A String", ], }, + "toolCall": { # Represents a call of a specific tool's action with the specified inputs. # Returns the definition of a tool call that should be executed by the client. + "action": "A String", # Required. The name of the tool's action associated with this call. + "inputParameters": { # Optional. The action's input parameters. + "a_key": "", # Properties of the object. + }, + "tool": "A String", # Required. The tool associated with this call. Format: `projects//locations//agents//tools/`. + }, }, ], "returnPartialResponses": True or False, # Whether Dialogflow should return currently queued fulfillment response messages in streaming APIs. If a webhook is specified, it happens before Dialogflow invokes webhook. Warning: 1) This flag only affects streaming API. Responses are still queued and returned once in non-streaming API. 2) The flag can be enabled in any fulfillment but only the first 3 partial responses will be returned. You may only want to apply it to fulfillments that have slow webhooks. @@ -2969,8 +3207,8 @@

Method Details

"maxDigits": 42, # Max length of DTMF digits. }, "loggingSettings": { # Define behaviors on logging. # Settings for logging. Settings for Dialogflow History, Contact Center messages, StackDriver logs, and speech logging. Exposed at the following levels: - Agent level. - "enableInteractionLogging": True or False, # If true, DF Interaction logging is currently enabled. - "enableStackdriverLogging": True or False, # If true, StackDriver logging is currently enabled. + "enableInteractionLogging": True or False, # Enables DF Interaction logging. + "enableStackdriverLogging": True or False, # Enables StackDriver logging. }, "speechSettings": { # Define behaviors of speech to text detection. # Settings for speech to text detection. Exposed at the following levels: - Agent level - Flow level - Page level - Parameter level "endpointerSensitivity": 42, # Sensitivity of the speech model that detects the end of speech. Scale from 0 to 100. @@ -3034,6 +3272,13 @@

Method Details

"A String", ], }, + "toolCall": { # Represents a call of a specific tool's action with the specified inputs. # Returns the definition of a tool call that should be executed by the client. + "action": "A String", # Required. The name of the tool's action associated with this call. + "inputParameters": { # Optional. The action's input parameters. + "a_key": "", # Properties of the object. + }, + "tool": "A String", # Required. The tool associated with this call. Format: `projects//locations//agents//tools/`. + }, }, }, ], @@ -3090,6 +3335,13 @@

Method Details

"A String", ], }, + "toolCall": { # Represents a call of a specific tool's action with the specified inputs. # Returns the definition of a tool call that should be executed by the client. + "action": "A String", # Required. The name of the tool's action associated with this call. + "inputParameters": { # Optional. The action's input parameters. + "a_key": "", # Properties of the object. + }, + "tool": "A String", # Required. The tool associated with this call. Format: `projects//locations//agents//tools/`. + }, }, ], "returnPartialResponses": True or False, # Whether Dialogflow should return currently queued fulfillment response messages in streaming APIs. If a webhook is specified, it happens before Dialogflow invokes webhook. Warning: 1) This flag only affects streaming API. Responses are still queued and returned once in non-streaming API. 2) The flag can be enabled in any fulfillment but only the first 3 partial responses will be returned. You may only want to apply it to fulfillments that have slow webhooks. @@ -3140,8 +3392,8 @@

Method Details

"maxDigits": 42, # Max length of DTMF digits. }, "loggingSettings": { # Define behaviors on logging. # Settings for logging. Settings for Dialogflow History, Contact Center messages, StackDriver logs, and speech logging. Exposed at the following levels: - Agent level. - "enableInteractionLogging": True or False, # If true, DF Interaction logging is currently enabled. - "enableStackdriverLogging": True or False, # If true, StackDriver logging is currently enabled. + "enableInteractionLogging": True or False, # Enables DF Interaction logging. + "enableStackdriverLogging": True or False, # Enables StackDriver logging. }, "speechSettings": { # Define behaviors of speech to text detection. # Settings for speech to text detection. Exposed at the following levels: - Agent level - Flow level - Page level - Parameter level "endpointerSensitivity": 42, # Sensitivity of the speech model that detects the end of speech. Scale from 0 to 100. @@ -3167,8 +3419,8 @@

Method Details

"maxDigits": 42, # Max length of DTMF digits. }, "loggingSettings": { # Define behaviors on logging. # Settings for logging. Settings for Dialogflow History, Contact Center messages, StackDriver logs, and speech logging. Exposed at the following levels: - Agent level. - "enableInteractionLogging": True or False, # If true, DF Interaction logging is currently enabled. - "enableStackdriverLogging": True or False, # If true, StackDriver logging is currently enabled. + "enableInteractionLogging": True or False, # Enables DF Interaction logging. + "enableStackdriverLogging": True or False, # Enables StackDriver logging. }, "speechSettings": { # Define behaviors of speech to text detection. # Settings for speech to text detection. Exposed at the following levels: - Agent level - Flow level - Page level - Parameter level "endpointerSensitivity": 42, # Sensitivity of the speech model that detects the end of speech. Scale from 0 to 100. @@ -3232,6 +3484,13 @@

Method Details

"A String", ], }, + "toolCall": { # Represents a call of a specific tool's action with the specified inputs. # Returns the definition of a tool call that should be executed by the client. + "action": "A String", # Required. The name of the tool's action associated with this call. + "inputParameters": { # Optional. The action's input parameters. + "a_key": "", # Properties of the object. + }, + "tool": "A String", # Required. The tool associated with this call. Format: `projects//locations//agents//tools/`. + }, }, }, ], @@ -3288,6 +3547,13 @@

Method Details

"A String", ], }, + "toolCall": { # Represents a call of a specific tool's action with the specified inputs. # Returns the definition of a tool call that should be executed by the client. + "action": "A String", # Required. The name of the tool's action associated with this call. + "inputParameters": { # Optional. The action's input parameters. + "a_key": "", # Properties of the object. + }, + "tool": "A String", # Required. The tool associated with this call. Format: `projects//locations//agents//tools/`. + }, }, ], "returnPartialResponses": True or False, # Whether Dialogflow should return currently queued fulfillment response messages in streaming APIs. If a webhook is specified, it happens before Dialogflow invokes webhook. Warning: 1) This flag only affects streaming API. Responses are still queued and returned once in non-streaming API. 2) The flag can be enabled in any fulfillment but only the first 3 partial responses will be returned. You may only want to apply it to fulfillments that have slow webhooks. @@ -3319,8 +3585,8 @@

Method Details

"maxDigits": 42, # Max length of DTMF digits. }, "loggingSettings": { # Define behaviors on logging. # Settings for logging. Settings for Dialogflow History, Contact Center messages, StackDriver logs, and speech logging. Exposed at the following levels: - Agent level. - "enableInteractionLogging": True or False, # If true, DF Interaction logging is currently enabled. - "enableStackdriverLogging": True or False, # If true, StackDriver logging is currently enabled. + "enableInteractionLogging": True or False, # Enables DF Interaction logging. + "enableStackdriverLogging": True or False, # Enables StackDriver logging. }, "speechSettings": { # Define behaviors of speech to text detection. # Settings for speech to text detection. Exposed at the following levels: - Agent level - Flow level - Page level - Parameter level "endpointerSensitivity": 42, # Sensitivity of the speech model that detects the end of speech. Scale from 0 to 100. @@ -3384,6 +3650,13 @@

Method Details

"A String", ], }, + "toolCall": { # Represents a call of a specific tool's action with the specified inputs. # Returns the definition of a tool call that should be executed by the client. + "action": "A String", # Required. The name of the tool's action associated with this call. + "inputParameters": { # Optional. The action's input parameters. + "a_key": "", # Properties of the object. + }, + "tool": "A String", # Required. The tool associated with this call. Format: `projects//locations//agents//tools/`. + }, }, }, ], @@ -3440,6 +3713,13 @@

Method Details

"A String", ], }, + "toolCall": { # Represents a call of a specific tool's action with the specified inputs. # Returns the definition of a tool call that should be executed by the client. + "action": "A String", # Required. The name of the tool's action associated with this call. + "inputParameters": { # Optional. The action's input parameters. + "a_key": "", # Properties of the object. + }, + "tool": "A String", # Required. The tool associated with this call. Format: `projects//locations//agents//tools/`. + }, }, ], "returnPartialResponses": True or False, # Whether Dialogflow should return currently queued fulfillment response messages in streaming APIs. If a webhook is specified, it happens before Dialogflow invokes webhook. Warning: 1) This flag only affects streaming API. Responses are still queued and returned once in non-streaming API. 2) The flag can be enabled in any fulfillment but only the first 3 partial responses will be returned. You may only want to apply it to fulfillments that have slow webhooks. @@ -3469,8 +3749,8 @@

Method Details

"maxDigits": 42, # Max length of DTMF digits. }, "loggingSettings": { # Define behaviors on logging. # Settings for logging. Settings for Dialogflow History, Contact Center messages, StackDriver logs, and speech logging. Exposed at the following levels: - Agent level. - "enableInteractionLogging": True or False, # If true, DF Interaction logging is currently enabled. - "enableStackdriverLogging": True or False, # If true, StackDriver logging is currently enabled. + "enableInteractionLogging": True or False, # Enables DF Interaction logging. + "enableStackdriverLogging": True or False, # Enables StackDriver logging. }, "speechSettings": { # Define behaviors of speech to text detection. # Settings for speech to text detection. Exposed at the following levels: - Agent level - Flow level - Page level - Parameter level "endpointerSensitivity": 42, # Sensitivity of the speech model that detects the end of speech. Scale from 0 to 100. @@ -3498,8 +3778,8 @@

Method Details

"maxDigits": 42, # Max length of DTMF digits. }, "loggingSettings": { # Define behaviors on logging. # Settings for logging. Settings for Dialogflow History, Contact Center messages, StackDriver logs, and speech logging. Exposed at the following levels: - Agent level. - "enableInteractionLogging": True or False, # If true, DF Interaction logging is currently enabled. - "enableStackdriverLogging": True or False, # If true, StackDriver logging is currently enabled. + "enableInteractionLogging": True or False, # Enables DF Interaction logging. + "enableStackdriverLogging": True or False, # Enables StackDriver logging. }, "speechSettings": { # Define behaviors of speech to text detection. # Settings for speech to text detection. Exposed at the following levels: - Agent level - Flow level - Page level - Parameter level "endpointerSensitivity": 42, # Sensitivity of the speech model that detects the end of speech. Scale from 0 to 100. @@ -3563,6 +3843,13 @@

Method Details

"A String", ], }, + "toolCall": { # Represents a call of a specific tool's action with the specified inputs. # Returns the definition of a tool call that should be executed by the client. + "action": "A String", # Required. The name of the tool's action associated with this call. + "inputParameters": { # Optional. The action's input parameters. + "a_key": "", # Properties of the object. + }, + "tool": "A String", # Required. The tool associated with this call. Format: `projects//locations//agents//tools/`. + }, }, }, ], @@ -3619,6 +3906,13 @@

Method Details

"A String", ], }, + "toolCall": { # Represents a call of a specific tool's action with the specified inputs. # Returns the definition of a tool call that should be executed by the client. + "action": "A String", # Required. The name of the tool's action associated with this call. + "inputParameters": { # Optional. The action's input parameters. + "a_key": "", # Properties of the object. + }, + "tool": "A String", # Required. The tool associated with this call. Format: `projects//locations//agents//tools/`. + }, }, ], "returnPartialResponses": True or False, # Whether Dialogflow should return currently queued fulfillment response messages in streaming APIs. If a webhook is specified, it happens before Dialogflow invokes webhook. Warning: 1) This flag only affects streaming API. Responses are still queued and returned once in non-streaming API. 2) The flag can be enabled in any fulfillment but only the first 3 partial responses will be returned. You may only want to apply it to fulfillments that have slow webhooks. @@ -3650,8 +3944,8 @@

Method Details

"maxDigits": 42, # Max length of DTMF digits. }, "loggingSettings": { # Define behaviors on logging. # Settings for logging. Settings for Dialogflow History, Contact Center messages, StackDriver logs, and speech logging. Exposed at the following levels: - Agent level. - "enableInteractionLogging": True or False, # If true, DF Interaction logging is currently enabled. - "enableStackdriverLogging": True or False, # If true, StackDriver logging is currently enabled. + "enableInteractionLogging": True or False, # Enables DF Interaction logging. + "enableStackdriverLogging": True or False, # Enables StackDriver logging. }, "speechSettings": { # Define behaviors of speech to text detection. # Settings for speech to text detection. Exposed at the following levels: - Agent level - Flow level - Page level - Parameter level "endpointerSensitivity": 42, # Sensitivity of the speech model that detects the end of speech. Scale from 0 to 100. @@ -3715,6 +4009,13 @@

Method Details

"A String", ], }, + "toolCall": { # Represents a call of a specific tool's action with the specified inputs. # Returns the definition of a tool call that should be executed by the client. + "action": "A String", # Required. The name of the tool's action associated with this call. + "inputParameters": { # Optional. The action's input parameters. + "a_key": "", # Properties of the object. + }, + "tool": "A String", # Required. The tool associated with this call. Format: `projects//locations//agents//tools/`. + }, }, }, ], @@ -3771,6 +4072,13 @@

Method Details

"A String", ], }, + "toolCall": { # Represents a call of a specific tool's action with the specified inputs. # Returns the definition of a tool call that should be executed by the client. + "action": "A String", # Required. The name of the tool's action associated with this call. + "inputParameters": { # Optional. The action's input parameters. + "a_key": "", # Properties of the object. + }, + "tool": "A String", # Required. The tool associated with this call. Format: `projects//locations//agents//tools/`. + }, }, ], "returnPartialResponses": True or False, # Whether Dialogflow should return currently queued fulfillment response messages in streaming APIs. If a webhook is specified, it happens before Dialogflow invokes webhook. Warning: 1) This flag only affects streaming API. Responses are still queued and returned once in non-streaming API. 2) The flag can be enabled in any fulfillment but only the first 3 partial responses will be returned. You may only want to apply it to fulfillments that have slow webhooks. @@ -3815,8 +4123,8 @@

Method Details

"maxDigits": 42, # Max length of DTMF digits. }, "loggingSettings": { # Define behaviors on logging. # Settings for logging. Settings for Dialogflow History, Contact Center messages, StackDriver logs, and speech logging. Exposed at the following levels: - Agent level. - "enableInteractionLogging": True or False, # If true, DF Interaction logging is currently enabled. - "enableStackdriverLogging": True or False, # If true, StackDriver logging is currently enabled. + "enableInteractionLogging": True or False, # Enables DF Interaction logging. + "enableStackdriverLogging": True or False, # Enables StackDriver logging. }, "speechSettings": { # Define behaviors of speech to text detection. # Settings for speech to text detection. Exposed at the following levels: - Agent level - Flow level - Page level - Parameter level "endpointerSensitivity": 42, # Sensitivity of the speech model that detects the end of speech. Scale from 0 to 100. @@ -3880,6 +4188,13 @@

Method Details

"A String", ], }, + "toolCall": { # Represents a call of a specific tool's action with the specified inputs. # Returns the definition of a tool call that should be executed by the client. + "action": "A String", # Required. The name of the tool's action associated with this call. + "inputParameters": { # Optional. The action's input parameters. + "a_key": "", # Properties of the object. + }, + "tool": "A String", # Required. The tool associated with this call. Format: `projects//locations//agents//tools/`. + }, }, }, ], @@ -3936,6 +4251,13 @@

Method Details

"A String", ], }, + "toolCall": { # Represents a call of a specific tool's action with the specified inputs. # Returns the definition of a tool call that should be executed by the client. + "action": "A String", # Required. The name of the tool's action associated with this call. + "inputParameters": { # Optional. The action's input parameters. + "a_key": "", # Properties of the object. + }, + "tool": "A String", # Required. The tool associated with this call. Format: `projects//locations//agents//tools/`. + }, }, ], "returnPartialResponses": True or False, # Whether Dialogflow should return currently queued fulfillment response messages in streaming APIs. If a webhook is specified, it happens before Dialogflow invokes webhook. Warning: 1) This flag only affects streaming API. Responses are still queued and returned once in non-streaming API. 2) The flag can be enabled in any fulfillment but only the first 3 partial responses will be returned. You may only want to apply it to fulfillments that have slow webhooks. @@ -3974,8 +4296,8 @@

Method Details

"maxDigits": 42, # Max length of DTMF digits. }, "loggingSettings": { # Define behaviors on logging. # Settings for logging. Settings for Dialogflow History, Contact Center messages, StackDriver logs, and speech logging. Exposed at the following levels: - Agent level. - "enableInteractionLogging": True or False, # If true, DF Interaction logging is currently enabled. - "enableStackdriverLogging": True or False, # If true, StackDriver logging is currently enabled. + "enableInteractionLogging": True or False, # Enables DF Interaction logging. + "enableStackdriverLogging": True or False, # Enables StackDriver logging. }, "speechSettings": { # Define behaviors of speech to text detection. # Settings for speech to text detection. Exposed at the following levels: - Agent level - Flow level - Page level - Parameter level "endpointerSensitivity": 42, # Sensitivity of the speech model that detects the end of speech. Scale from 0 to 100. @@ -4039,6 +4361,13 @@

Method Details

"A String", ], }, + "toolCall": { # Represents a call of a specific tool's action with the specified inputs. # Returns the definition of a tool call that should be executed by the client. + "action": "A String", # Required. The name of the tool's action associated with this call. + "inputParameters": { # Optional. The action's input parameters. + "a_key": "", # Properties of the object. + }, + "tool": "A String", # Required. The tool associated with this call. Format: `projects//locations//agents//tools/`. + }, }, }, ], @@ -4095,6 +4424,13 @@

Method Details

"A String", ], }, + "toolCall": { # Represents a call of a specific tool's action with the specified inputs. # Returns the definition of a tool call that should be executed by the client. + "action": "A String", # Required. The name of the tool's action associated with this call. + "inputParameters": { # Optional. The action's input parameters. + "a_key": "", # Properties of the object. + }, + "tool": "A String", # Required. The tool associated with this call. Format: `projects//locations//agents//tools/`. + }, }, ], "returnPartialResponses": True or False, # Whether Dialogflow should return currently queued fulfillment response messages in streaming APIs. If a webhook is specified, it happens before Dialogflow invokes webhook. Warning: 1) This flag only affects streaming API. Responses are still queued and returned once in non-streaming API. 2) The flag can be enabled in any fulfillment but only the first 3 partial responses will be returned. You may only want to apply it to fulfillments that have slow webhooks. @@ -4150,8 +4486,8 @@

Method Details

"maxDigits": 42, # Max length of DTMF digits. }, "loggingSettings": { # Define behaviors on logging. # Settings for logging. Settings for Dialogflow History, Contact Center messages, StackDriver logs, and speech logging. Exposed at the following levels: - Agent level. - "enableInteractionLogging": True or False, # If true, DF Interaction logging is currently enabled. - "enableStackdriverLogging": True or False, # If true, StackDriver logging is currently enabled. + "enableInteractionLogging": True or False, # Enables DF Interaction logging. + "enableStackdriverLogging": True or False, # Enables StackDriver logging. }, "speechSettings": { # Define behaviors of speech to text detection. # Settings for speech to text detection. Exposed at the following levels: - Agent level - Flow level - Page level - Parameter level "endpointerSensitivity": 42, # Sensitivity of the speech model that detects the end of speech. Scale from 0 to 100. @@ -4177,8 +4513,8 @@

Method Details

"maxDigits": 42, # Max length of DTMF digits. }, "loggingSettings": { # Define behaviors on logging. # Settings for logging. Settings for Dialogflow History, Contact Center messages, StackDriver logs, and speech logging. Exposed at the following levels: - Agent level. - "enableInteractionLogging": True or False, # If true, DF Interaction logging is currently enabled. - "enableStackdriverLogging": True or False, # If true, StackDriver logging is currently enabled. + "enableInteractionLogging": True or False, # Enables DF Interaction logging. + "enableStackdriverLogging": True or False, # Enables StackDriver logging. }, "speechSettings": { # Define behaviors of speech to text detection. # Settings for speech to text detection. Exposed at the following levels: - Agent level - Flow level - Page level - Parameter level "endpointerSensitivity": 42, # Sensitivity of the speech model that detects the end of speech. Scale from 0 to 100. @@ -4242,6 +4578,13 @@

Method Details

"A String", ], }, + "toolCall": { # Represents a call of a specific tool's action with the specified inputs. # Returns the definition of a tool call that should be executed by the client. + "action": "A String", # Required. The name of the tool's action associated with this call. + "inputParameters": { # Optional. The action's input parameters. + "a_key": "", # Properties of the object. + }, + "tool": "A String", # Required. The tool associated with this call. Format: `projects//locations//agents//tools/`. + }, }, }, ], @@ -4298,6 +4641,13 @@

Method Details

"A String", ], }, + "toolCall": { # Represents a call of a specific tool's action with the specified inputs. # Returns the definition of a tool call that should be executed by the client. + "action": "A String", # Required. The name of the tool's action associated with this call. + "inputParameters": { # Optional. The action's input parameters. + "a_key": "", # Properties of the object. + }, + "tool": "A String", # Required. The tool associated with this call. Format: `projects//locations//agents//tools/`. + }, }, ], "returnPartialResponses": True or False, # Whether Dialogflow should return currently queued fulfillment response messages in streaming APIs. If a webhook is specified, it happens before Dialogflow invokes webhook. Warning: 1) This flag only affects streaming API. Responses are still queued and returned once in non-streaming API. 2) The flag can be enabled in any fulfillment but only the first 3 partial responses will be returned. You may only want to apply it to fulfillments that have slow webhooks. @@ -4329,8 +4679,8 @@

Method Details

"maxDigits": 42, # Max length of DTMF digits. }, "loggingSettings": { # Define behaviors on logging. # Settings for logging. Settings for Dialogflow History, Contact Center messages, StackDriver logs, and speech logging. Exposed at the following levels: - Agent level. - "enableInteractionLogging": True or False, # If true, DF Interaction logging is currently enabled. - "enableStackdriverLogging": True or False, # If true, StackDriver logging is currently enabled. + "enableInteractionLogging": True or False, # Enables DF Interaction logging. + "enableStackdriverLogging": True or False, # Enables StackDriver logging. }, "speechSettings": { # Define behaviors of speech to text detection. # Settings for speech to text detection. Exposed at the following levels: - Agent level - Flow level - Page level - Parameter level "endpointerSensitivity": 42, # Sensitivity of the speech model that detects the end of speech. Scale from 0 to 100. @@ -4394,6 +4744,13 @@

Method Details

"A String", ], }, + "toolCall": { # Represents a call of a specific tool's action with the specified inputs. # Returns the definition of a tool call that should be executed by the client. + "action": "A String", # Required. The name of the tool's action associated with this call. + "inputParameters": { # Optional. The action's input parameters. + "a_key": "", # Properties of the object. + }, + "tool": "A String", # Required. The tool associated with this call. Format: `projects//locations//agents//tools/`. + }, }, }, ], @@ -4450,6 +4807,13 @@

Method Details

"A String", ], }, + "toolCall": { # Represents a call of a specific tool's action with the specified inputs. # Returns the definition of a tool call that should be executed by the client. + "action": "A String", # Required. The name of the tool's action associated with this call. + "inputParameters": { # Optional. The action's input parameters. + "a_key": "", # Properties of the object. + }, + "tool": "A String", # Required. The tool associated with this call. Format: `projects//locations//agents//tools/`. + }, }, ], "returnPartialResponses": True or False, # Whether Dialogflow should return currently queued fulfillment response messages in streaming APIs. If a webhook is specified, it happens before Dialogflow invokes webhook. Warning: 1) This flag only affects streaming API. Responses are still queued and returned once in non-streaming API. 2) The flag can be enabled in any fulfillment but only the first 3 partial responses will be returned. You may only want to apply it to fulfillments that have slow webhooks. @@ -4479,8 +4843,8 @@

Method Details

"maxDigits": 42, # Max length of DTMF digits. }, "loggingSettings": { # Define behaviors on logging. # Settings for logging. Settings for Dialogflow History, Contact Center messages, StackDriver logs, and speech logging. Exposed at the following levels: - Agent level. - "enableInteractionLogging": True or False, # If true, DF Interaction logging is currently enabled. - "enableStackdriverLogging": True or False, # If true, StackDriver logging is currently enabled. + "enableInteractionLogging": True or False, # Enables DF Interaction logging. + "enableStackdriverLogging": True or False, # Enables StackDriver logging. }, "speechSettings": { # Define behaviors of speech to text detection. # Settings for speech to text detection. Exposed at the following levels: - Agent level - Flow level - Page level - Parameter level "endpointerSensitivity": 42, # Sensitivity of the speech model that detects the end of speech. Scale from 0 to 100. @@ -4508,8 +4872,8 @@

Method Details

"maxDigits": 42, # Max length of DTMF digits. }, "loggingSettings": { # Define behaviors on logging. # Settings for logging. Settings for Dialogflow History, Contact Center messages, StackDriver logs, and speech logging. Exposed at the following levels: - Agent level. - "enableInteractionLogging": True or False, # If true, DF Interaction logging is currently enabled. - "enableStackdriverLogging": True or False, # If true, StackDriver logging is currently enabled. + "enableInteractionLogging": True or False, # Enables DF Interaction logging. + "enableStackdriverLogging": True or False, # Enables StackDriver logging. }, "speechSettings": { # Define behaviors of speech to text detection. # Settings for speech to text detection. Exposed at the following levels: - Agent level - Flow level - Page level - Parameter level "endpointerSensitivity": 42, # Sensitivity of the speech model that detects the end of speech. Scale from 0 to 100. @@ -4573,6 +4937,13 @@

Method Details

"A String", ], }, + "toolCall": { # Represents a call of a specific tool's action with the specified inputs. # Returns the definition of a tool call that should be executed by the client. + "action": "A String", # Required. The name of the tool's action associated with this call. + "inputParameters": { # Optional. The action's input parameters. + "a_key": "", # Properties of the object. + }, + "tool": "A String", # Required. The tool associated with this call. Format: `projects//locations//agents//tools/`. + }, }, }, ], @@ -4629,6 +5000,13 @@

Method Details

"A String", ], }, + "toolCall": { # Represents a call of a specific tool's action with the specified inputs. # Returns the definition of a tool call that should be executed by the client. + "action": "A String", # Required. The name of the tool's action associated with this call. + "inputParameters": { # Optional. The action's input parameters. + "a_key": "", # Properties of the object. + }, + "tool": "A String", # Required. The tool associated with this call. Format: `projects//locations//agents//tools/`. + }, }, ], "returnPartialResponses": True or False, # Whether Dialogflow should return currently queued fulfillment response messages in streaming APIs. If a webhook is specified, it happens before Dialogflow invokes webhook. Warning: 1) This flag only affects streaming API. Responses are still queued and returned once in non-streaming API. 2) The flag can be enabled in any fulfillment but only the first 3 partial responses will be returned. You may only want to apply it to fulfillments that have slow webhooks. @@ -4660,8 +5038,8 @@

Method Details

"maxDigits": 42, # Max length of DTMF digits. }, "loggingSettings": { # Define behaviors on logging. # Settings for logging. Settings for Dialogflow History, Contact Center messages, StackDriver logs, and speech logging. Exposed at the following levels: - Agent level. - "enableInteractionLogging": True or False, # If true, DF Interaction logging is currently enabled. - "enableStackdriverLogging": True or False, # If true, StackDriver logging is currently enabled. + "enableInteractionLogging": True or False, # Enables DF Interaction logging. + "enableStackdriverLogging": True or False, # Enables StackDriver logging. }, "speechSettings": { # Define behaviors of speech to text detection. # Settings for speech to text detection. Exposed at the following levels: - Agent level - Flow level - Page level - Parameter level "endpointerSensitivity": 42, # Sensitivity of the speech model that detects the end of speech. Scale from 0 to 100. @@ -4725,6 +5103,13 @@

Method Details

"A String", ], }, + "toolCall": { # Represents a call of a specific tool's action with the specified inputs. # Returns the definition of a tool call that should be executed by the client. + "action": "A String", # Required. The name of the tool's action associated with this call. + "inputParameters": { # Optional. The action's input parameters. + "a_key": "", # Properties of the object. + }, + "tool": "A String", # Required. The tool associated with this call. Format: `projects//locations//agents//tools/`. + }, }, }, ], @@ -4781,6 +5166,13 @@

Method Details

"A String", ], }, + "toolCall": { # Represents a call of a specific tool's action with the specified inputs. # Returns the definition of a tool call that should be executed by the client. + "action": "A String", # Required. The name of the tool's action associated with this call. + "inputParameters": { # Optional. The action's input parameters. + "a_key": "", # Properties of the object. + }, + "tool": "A String", # Required. The tool associated with this call. Format: `projects//locations//agents//tools/`. + }, }, ], "returnPartialResponses": True or False, # Whether Dialogflow should return currently queued fulfillment response messages in streaming APIs. If a webhook is specified, it happens before Dialogflow invokes webhook. Warning: 1) This flag only affects streaming API. Responses are still queued and returned once in non-streaming API. 2) The flag can be enabled in any fulfillment but only the first 3 partial responses will be returned. You may only want to apply it to fulfillments that have slow webhooks. @@ -4825,8 +5217,8 @@

Method Details

"maxDigits": 42, # Max length of DTMF digits. }, "loggingSettings": { # Define behaviors on logging. # Settings for logging. Settings for Dialogflow History, Contact Center messages, StackDriver logs, and speech logging. Exposed at the following levels: - Agent level. - "enableInteractionLogging": True or False, # If true, DF Interaction logging is currently enabled. - "enableStackdriverLogging": True or False, # If true, StackDriver logging is currently enabled. + "enableInteractionLogging": True or False, # Enables DF Interaction logging. + "enableStackdriverLogging": True or False, # Enables StackDriver logging. }, "speechSettings": { # Define behaviors of speech to text detection. # Settings for speech to text detection. Exposed at the following levels: - Agent level - Flow level - Page level - Parameter level "endpointerSensitivity": 42, # Sensitivity of the speech model that detects the end of speech. Scale from 0 to 100. @@ -4890,6 +5282,13 @@

Method Details

"A String", ], }, + "toolCall": { # Represents a call of a specific tool's action with the specified inputs. # Returns the definition of a tool call that should be executed by the client. + "action": "A String", # Required. The name of the tool's action associated with this call. + "inputParameters": { # Optional. The action's input parameters. + "a_key": "", # Properties of the object. + }, + "tool": "A String", # Required. The tool associated with this call. Format: `projects//locations//agents//tools/`. + }, }, }, ], @@ -4946,6 +5345,13 @@

Method Details

"A String", ], }, + "toolCall": { # Represents a call of a specific tool's action with the specified inputs. # Returns the definition of a tool call that should be executed by the client. + "action": "A String", # Required. The name of the tool's action associated with this call. + "inputParameters": { # Optional. The action's input parameters. + "a_key": "", # Properties of the object. + }, + "tool": "A String", # Required. The tool associated with this call. Format: `projects//locations//agents//tools/`. + }, }, ], "returnPartialResponses": True or False, # Whether Dialogflow should return currently queued fulfillment response messages in streaming APIs. If a webhook is specified, it happens before Dialogflow invokes webhook. Warning: 1) This flag only affects streaming API. Responses are still queued and returned once in non-streaming API. 2) The flag can be enabled in any fulfillment but only the first 3 partial responses will be returned. You may only want to apply it to fulfillments that have slow webhooks. @@ -4984,8 +5390,8 @@

Method Details

"maxDigits": 42, # Max length of DTMF digits. }, "loggingSettings": { # Define behaviors on logging. # Settings for logging. Settings for Dialogflow History, Contact Center messages, StackDriver logs, and speech logging. Exposed at the following levels: - Agent level. - "enableInteractionLogging": True or False, # If true, DF Interaction logging is currently enabled. - "enableStackdriverLogging": True or False, # If true, StackDriver logging is currently enabled. + "enableInteractionLogging": True or False, # Enables DF Interaction logging. + "enableStackdriverLogging": True or False, # Enables StackDriver logging. }, "speechSettings": { # Define behaviors of speech to text detection. # Settings for speech to text detection. Exposed at the following levels: - Agent level - Flow level - Page level - Parameter level "endpointerSensitivity": 42, # Sensitivity of the speech model that detects the end of speech. Scale from 0 to 100. @@ -5049,6 +5455,13 @@

Method Details

"A String", ], }, + "toolCall": { # Represents a call of a specific tool's action with the specified inputs. # Returns the definition of a tool call that should be executed by the client. + "action": "A String", # Required. The name of the tool's action associated with this call. + "inputParameters": { # Optional. The action's input parameters. + "a_key": "", # Properties of the object. + }, + "tool": "A String", # Required. The tool associated with this call. Format: `projects//locations//agents//tools/`. + }, }, }, ], @@ -5105,6 +5518,13 @@

Method Details

"A String", ], }, + "toolCall": { # Represents a call of a specific tool's action with the specified inputs. # Returns the definition of a tool call that should be executed by the client. + "action": "A String", # Required. The name of the tool's action associated with this call. + "inputParameters": { # Optional. The action's input parameters. + "a_key": "", # Properties of the object. + }, + "tool": "A String", # Required. The tool associated with this call. Format: `projects//locations//agents//tools/`. + }, }, ], "returnPartialResponses": True or False, # Whether Dialogflow should return currently queued fulfillment response messages in streaming APIs. If a webhook is specified, it happens before Dialogflow invokes webhook. Warning: 1) This flag only affects streaming API. Responses are still queued and returned once in non-streaming API. 2) The flag can be enabled in any fulfillment but only the first 3 partial responses will be returned. You may only want to apply it to fulfillments that have slow webhooks. @@ -5144,8 +5564,8 @@

Method Details

"maxDigits": 42, # Max length of DTMF digits. }, "loggingSettings": { # Define behaviors on logging. # Settings for logging. Settings for Dialogflow History, Contact Center messages, StackDriver logs, and speech logging. Exposed at the following levels: - Agent level. - "enableInteractionLogging": True or False, # If true, DF Interaction logging is currently enabled. - "enableStackdriverLogging": True or False, # If true, StackDriver logging is currently enabled. + "enableInteractionLogging": True or False, # Enables DF Interaction logging. + "enableStackdriverLogging": True or False, # Enables StackDriver logging. }, "speechSettings": { # Define behaviors of speech to text detection. # Settings for speech to text detection. Exposed at the following levels: - Agent level - Flow level - Page level - Parameter level "endpointerSensitivity": 42, # Sensitivity of the speech model that detects the end of speech. Scale from 0 to 100. @@ -5171,8 +5591,8 @@

Method Details

"maxDigits": 42, # Max length of DTMF digits. }, "loggingSettings": { # Define behaviors on logging. # Settings for logging. Settings for Dialogflow History, Contact Center messages, StackDriver logs, and speech logging. Exposed at the following levels: - Agent level. - "enableInteractionLogging": True or False, # If true, DF Interaction logging is currently enabled. - "enableStackdriverLogging": True or False, # If true, StackDriver logging is currently enabled. + "enableInteractionLogging": True or False, # Enables DF Interaction logging. + "enableStackdriverLogging": True or False, # Enables StackDriver logging. }, "speechSettings": { # Define behaviors of speech to text detection. # Settings for speech to text detection. Exposed at the following levels: - Agent level - Flow level - Page level - Parameter level "endpointerSensitivity": 42, # Sensitivity of the speech model that detects the end of speech. Scale from 0 to 100. @@ -5236,6 +5656,13 @@

Method Details

"A String", ], }, + "toolCall": { # Represents a call of a specific tool's action with the specified inputs. # Returns the definition of a tool call that should be executed by the client. + "action": "A String", # Required. The name of the tool's action associated with this call. + "inputParameters": { # Optional. The action's input parameters. + "a_key": "", # Properties of the object. + }, + "tool": "A String", # Required. The tool associated with this call. Format: `projects//locations//agents//tools/`. + }, }, }, ], @@ -5292,6 +5719,13 @@

Method Details

"A String", ], }, + "toolCall": { # Represents a call of a specific tool's action with the specified inputs. # Returns the definition of a tool call that should be executed by the client. + "action": "A String", # Required. The name of the tool's action associated with this call. + "inputParameters": { # Optional. The action's input parameters. + "a_key": "", # Properties of the object. + }, + "tool": "A String", # Required. The tool associated with this call. Format: `projects//locations//agents//tools/`. + }, }, ], "returnPartialResponses": True or False, # Whether Dialogflow should return currently queued fulfillment response messages in streaming APIs. If a webhook is specified, it happens before Dialogflow invokes webhook. Warning: 1) This flag only affects streaming API. Responses are still queued and returned once in non-streaming API. 2) The flag can be enabled in any fulfillment but only the first 3 partial responses will be returned. You may only want to apply it to fulfillments that have slow webhooks. @@ -5323,8 +5757,8 @@

Method Details

"maxDigits": 42, # Max length of DTMF digits. }, "loggingSettings": { # Define behaviors on logging. # Settings for logging. Settings for Dialogflow History, Contact Center messages, StackDriver logs, and speech logging. Exposed at the following levels: - Agent level. - "enableInteractionLogging": True or False, # If true, DF Interaction logging is currently enabled. - "enableStackdriverLogging": True or False, # If true, StackDriver logging is currently enabled. + "enableInteractionLogging": True or False, # Enables DF Interaction logging. + "enableStackdriverLogging": True or False, # Enables StackDriver logging. }, "speechSettings": { # Define behaviors of speech to text detection. # Settings for speech to text detection. Exposed at the following levels: - Agent level - Flow level - Page level - Parameter level "endpointerSensitivity": 42, # Sensitivity of the speech model that detects the end of speech. Scale from 0 to 100. @@ -5388,6 +5822,13 @@

Method Details

"A String", ], }, + "toolCall": { # Represents a call of a specific tool's action with the specified inputs. # Returns the definition of a tool call that should be executed by the client. + "action": "A String", # Required. The name of the tool's action associated with this call. + "inputParameters": { # Optional. The action's input parameters. + "a_key": "", # Properties of the object. + }, + "tool": "A String", # Required. The tool associated with this call. Format: `projects//locations//agents//tools/`. + }, }, }, ], @@ -5444,6 +5885,13 @@

Method Details

"A String", ], }, + "toolCall": { # Represents a call of a specific tool's action with the specified inputs. # Returns the definition of a tool call that should be executed by the client. + "action": "A String", # Required. The name of the tool's action associated with this call. + "inputParameters": { # Optional. The action's input parameters. + "a_key": "", # Properties of the object. + }, + "tool": "A String", # Required. The tool associated with this call. Format: `projects//locations//agents//tools/`. + }, }, ], "returnPartialResponses": True or False, # Whether Dialogflow should return currently queued fulfillment response messages in streaming APIs. If a webhook is specified, it happens before Dialogflow invokes webhook. Warning: 1) This flag only affects streaming API. Responses are still queued and returned once in non-streaming API. 2) The flag can be enabled in any fulfillment but only the first 3 partial responses will be returned. You may only want to apply it to fulfillments that have slow webhooks. @@ -5473,8 +5921,8 @@

Method Details

"maxDigits": 42, # Max length of DTMF digits. }, "loggingSettings": { # Define behaviors on logging. # Settings for logging. Settings for Dialogflow History, Contact Center messages, StackDriver logs, and speech logging. Exposed at the following levels: - Agent level. - "enableInteractionLogging": True or False, # If true, DF Interaction logging is currently enabled. - "enableStackdriverLogging": True or False, # If true, StackDriver logging is currently enabled. + "enableInteractionLogging": True or False, # Enables DF Interaction logging. + "enableStackdriverLogging": True or False, # Enables StackDriver logging. }, "speechSettings": { # Define behaviors of speech to text detection. # Settings for speech to text detection. Exposed at the following levels: - Agent level - Flow level - Page level - Parameter level "endpointerSensitivity": 42, # Sensitivity of the speech model that detects the end of speech. Scale from 0 to 100. @@ -5502,8 +5950,8 @@

Method Details

"maxDigits": 42, # Max length of DTMF digits. }, "loggingSettings": { # Define behaviors on logging. # Settings for logging. Settings for Dialogflow History, Contact Center messages, StackDriver logs, and speech logging. Exposed at the following levels: - Agent level. - "enableInteractionLogging": True or False, # If true, DF Interaction logging is currently enabled. - "enableStackdriverLogging": True or False, # If true, StackDriver logging is currently enabled. + "enableInteractionLogging": True or False, # Enables DF Interaction logging. + "enableStackdriverLogging": True or False, # Enables StackDriver logging. }, "speechSettings": { # Define behaviors of speech to text detection. # Settings for speech to text detection. Exposed at the following levels: - Agent level - Flow level - Page level - Parameter level "endpointerSensitivity": 42, # Sensitivity of the speech model that detects the end of speech. Scale from 0 to 100. @@ -5567,6 +6015,13 @@

Method Details

"A String", ], }, + "toolCall": { # Represents a call of a specific tool's action with the specified inputs. # Returns the definition of a tool call that should be executed by the client. + "action": "A String", # Required. The name of the tool's action associated with this call. + "inputParameters": { # Optional. The action's input parameters. + "a_key": "", # Properties of the object. + }, + "tool": "A String", # Required. The tool associated with this call. Format: `projects//locations//agents//tools/`. + }, }, }, ], @@ -5623,6 +6078,13 @@

Method Details

"A String", ], }, + "toolCall": { # Represents a call of a specific tool's action with the specified inputs. # Returns the definition of a tool call that should be executed by the client. + "action": "A String", # Required. The name of the tool's action associated with this call. + "inputParameters": { # Optional. The action's input parameters. + "a_key": "", # Properties of the object. + }, + "tool": "A String", # Required. The tool associated with this call. Format: `projects//locations//agents//tools/`. + }, }, ], "returnPartialResponses": True or False, # Whether Dialogflow should return currently queued fulfillment response messages in streaming APIs. If a webhook is specified, it happens before Dialogflow invokes webhook. Warning: 1) This flag only affects streaming API. Responses are still queued and returned once in non-streaming API. 2) The flag can be enabled in any fulfillment but only the first 3 partial responses will be returned. You may only want to apply it to fulfillments that have slow webhooks. @@ -5654,8 +6116,8 @@

Method Details

"maxDigits": 42, # Max length of DTMF digits. }, "loggingSettings": { # Define behaviors on logging. # Settings for logging. Settings for Dialogflow History, Contact Center messages, StackDriver logs, and speech logging. Exposed at the following levels: - Agent level. - "enableInteractionLogging": True or False, # If true, DF Interaction logging is currently enabled. - "enableStackdriverLogging": True or False, # If true, StackDriver logging is currently enabled. + "enableInteractionLogging": True or False, # Enables DF Interaction logging. + "enableStackdriverLogging": True or False, # Enables StackDriver logging. }, "speechSettings": { # Define behaviors of speech to text detection. # Settings for speech to text detection. Exposed at the following levels: - Agent level - Flow level - Page level - Parameter level "endpointerSensitivity": 42, # Sensitivity of the speech model that detects the end of speech. Scale from 0 to 100. @@ -5719,6 +6181,13 @@

Method Details

"A String", ], }, + "toolCall": { # Represents a call of a specific tool's action with the specified inputs. # Returns the definition of a tool call that should be executed by the client. + "action": "A String", # Required. The name of the tool's action associated with this call. + "inputParameters": { # Optional. The action's input parameters. + "a_key": "", # Properties of the object. + }, + "tool": "A String", # Required. The tool associated with this call. Format: `projects//locations//agents//tools/`. + }, }, }, ], @@ -5775,6 +6244,13 @@

Method Details

"A String", ], }, + "toolCall": { # Represents a call of a specific tool's action with the specified inputs. # Returns the definition of a tool call that should be executed by the client. + "action": "A String", # Required. The name of the tool's action associated with this call. + "inputParameters": { # Optional. The action's input parameters. + "a_key": "", # Properties of the object. + }, + "tool": "A String", # Required. The tool associated with this call. Format: `projects//locations//agents//tools/`. + }, }, ], "returnPartialResponses": True or False, # Whether Dialogflow should return currently queued fulfillment response messages in streaming APIs. If a webhook is specified, it happens before Dialogflow invokes webhook. Warning: 1) This flag only affects streaming API. Responses are still queued and returned once in non-streaming API. 2) The flag can be enabled in any fulfillment but only the first 3 partial responses will be returned. You may only want to apply it to fulfillments that have slow webhooks. @@ -5819,8 +6295,8 @@

Method Details

"maxDigits": 42, # Max length of DTMF digits. }, "loggingSettings": { # Define behaviors on logging. # Settings for logging. Settings for Dialogflow History, Contact Center messages, StackDriver logs, and speech logging. Exposed at the following levels: - Agent level. - "enableInteractionLogging": True or False, # If true, DF Interaction logging is currently enabled. - "enableStackdriverLogging": True or False, # If true, StackDriver logging is currently enabled. + "enableInteractionLogging": True or False, # Enables DF Interaction logging. + "enableStackdriverLogging": True or False, # Enables StackDriver logging. }, "speechSettings": { # Define behaviors of speech to text detection. # Settings for speech to text detection. Exposed at the following levels: - Agent level - Flow level - Page level - Parameter level "endpointerSensitivity": 42, # Sensitivity of the speech model that detects the end of speech. Scale from 0 to 100. @@ -5884,6 +6360,13 @@

Method Details

"A String", ], }, + "toolCall": { # Represents a call of a specific tool's action with the specified inputs. # Returns the definition of a tool call that should be executed by the client. + "action": "A String", # Required. The name of the tool's action associated with this call. + "inputParameters": { # Optional. The action's input parameters. + "a_key": "", # Properties of the object. + }, + "tool": "A String", # Required. The tool associated with this call. Format: `projects//locations//agents//tools/`. + }, }, }, ], @@ -5940,6 +6423,13 @@

Method Details

"A String", ], }, + "toolCall": { # Represents a call of a specific tool's action with the specified inputs. # Returns the definition of a tool call that should be executed by the client. + "action": "A String", # Required. The name of the tool's action associated with this call. + "inputParameters": { # Optional. The action's input parameters. + "a_key": "", # Properties of the object. + }, + "tool": "A String", # Required. The tool associated with this call. Format: `projects//locations//agents//tools/`. + }, }, ], "returnPartialResponses": True or False, # Whether Dialogflow should return currently queued fulfillment response messages in streaming APIs. If a webhook is specified, it happens before Dialogflow invokes webhook. Warning: 1) This flag only affects streaming API. Responses are still queued and returned once in non-streaming API. 2) The flag can be enabled in any fulfillment but only the first 3 partial responses will be returned. You may only want to apply it to fulfillments that have slow webhooks. @@ -5978,8 +6468,8 @@

Method Details

"maxDigits": 42, # Max length of DTMF digits. }, "loggingSettings": { # Define behaviors on logging. # Settings for logging. Settings for Dialogflow History, Contact Center messages, StackDriver logs, and speech logging. Exposed at the following levels: - Agent level. - "enableInteractionLogging": True or False, # If true, DF Interaction logging is currently enabled. - "enableStackdriverLogging": True or False, # If true, StackDriver logging is currently enabled. + "enableInteractionLogging": True or False, # Enables DF Interaction logging. + "enableStackdriverLogging": True or False, # Enables StackDriver logging. }, "speechSettings": { # Define behaviors of speech to text detection. # Settings for speech to text detection. Exposed at the following levels: - Agent level - Flow level - Page level - Parameter level "endpointerSensitivity": 42, # Sensitivity of the speech model that detects the end of speech. Scale from 0 to 100. @@ -6043,6 +6533,13 @@

Method Details

"A String", ], }, + "toolCall": { # Represents a call of a specific tool's action with the specified inputs. # Returns the definition of a tool call that should be executed by the client. + "action": "A String", # Required. The name of the tool's action associated with this call. + "inputParameters": { # Optional. The action's input parameters. + "a_key": "", # Properties of the object. + }, + "tool": "A String", # Required. The tool associated with this call. Format: `projects//locations//agents//tools/`. + }, }, }, ], @@ -6099,6 +6596,13 @@

Method Details

"A String", ], }, + "toolCall": { # Represents a call of a specific tool's action with the specified inputs. # Returns the definition of a tool call that should be executed by the client. + "action": "A String", # Required. The name of the tool's action associated with this call. + "inputParameters": { # Optional. The action's input parameters. + "a_key": "", # Properties of the object. + }, + "tool": "A String", # Required. The tool associated with this call. Format: `projects//locations//agents//tools/`. + }, }, ], "returnPartialResponses": True or False, # Whether Dialogflow should return currently queued fulfillment response messages in streaming APIs. If a webhook is specified, it happens before Dialogflow invokes webhook. Warning: 1) This flag only affects streaming API. Responses are still queued and returned once in non-streaming API. 2) The flag can be enabled in any fulfillment but only the first 3 partial responses will be returned. You may only want to apply it to fulfillments that have slow webhooks. diff --git a/docs/dyn/dialogflow_v3beta1.projects.locations.agents.flows.transitionRouteGroups.html b/docs/dyn/dialogflow_v3beta1.projects.locations.agents.flows.transitionRouteGroups.html index 5b80cb1a2cf..863245bfa34 100644 --- a/docs/dyn/dialogflow_v3beta1.projects.locations.agents.flows.transitionRouteGroups.html +++ b/docs/dyn/dialogflow_v3beta1.projects.locations.agents.flows.transitionRouteGroups.html @@ -134,8 +134,8 @@

Method Details

"maxDigits": 42, # Max length of DTMF digits. }, "loggingSettings": { # Define behaviors on logging. # Settings for logging. Settings for Dialogflow History, Contact Center messages, StackDriver logs, and speech logging. Exposed at the following levels: - Agent level. - "enableInteractionLogging": True or False, # If true, DF Interaction logging is currently enabled. - "enableStackdriverLogging": True or False, # If true, StackDriver logging is currently enabled. + "enableInteractionLogging": True or False, # Enables DF Interaction logging. + "enableStackdriverLogging": True or False, # Enables StackDriver logging. }, "speechSettings": { # Define behaviors of speech to text detection. # Settings for speech to text detection. Exposed at the following levels: - Agent level - Flow level - Page level - Parameter level "endpointerSensitivity": 42, # Sensitivity of the speech model that detects the end of speech. Scale from 0 to 100. @@ -199,6 +199,13 @@

Method Details

"A String", ], }, + "toolCall": { # Represents a call of a specific tool's action with the specified inputs. # Returns the definition of a tool call that should be executed by the client. + "action": "A String", # Required. The name of the tool's action associated with this call. + "inputParameters": { # Optional. The action's input parameters. + "a_key": "", # Properties of the object. + }, + "tool": "A String", # Required. The tool associated with this call. Format: `projects//locations//agents//tools/`. + }, }, }, ], @@ -255,6 +262,13 @@

Method Details

"A String", ], }, + "toolCall": { # Represents a call of a specific tool's action with the specified inputs. # Returns the definition of a tool call that should be executed by the client. + "action": "A String", # Required. The name of the tool's action associated with this call. + "inputParameters": { # Optional. The action's input parameters. + "a_key": "", # Properties of the object. + }, + "tool": "A String", # Required. The tool associated with this call. Format: `projects//locations//agents//tools/`. + }, }, ], "returnPartialResponses": True or False, # Whether Dialogflow should return currently queued fulfillment response messages in streaming APIs. If a webhook is specified, it happens before Dialogflow invokes webhook. Warning: 1) This flag only affects streaming API. Responses are still queued and returned once in non-streaming API. 2) The flag can be enabled in any fulfillment but only the first 3 partial responses will be returned. You may only want to apply it to fulfillments that have slow webhooks. @@ -304,8 +318,8 @@

Method Details

"maxDigits": 42, # Max length of DTMF digits. }, "loggingSettings": { # Define behaviors on logging. # Settings for logging. Settings for Dialogflow History, Contact Center messages, StackDriver logs, and speech logging. Exposed at the following levels: - Agent level. - "enableInteractionLogging": True or False, # If true, DF Interaction logging is currently enabled. - "enableStackdriverLogging": True or False, # If true, StackDriver logging is currently enabled. + "enableInteractionLogging": True or False, # Enables DF Interaction logging. + "enableStackdriverLogging": True or False, # Enables StackDriver logging. }, "speechSettings": { # Define behaviors of speech to text detection. # Settings for speech to text detection. Exposed at the following levels: - Agent level - Flow level - Page level - Parameter level "endpointerSensitivity": 42, # Sensitivity of the speech model that detects the end of speech. Scale from 0 to 100. @@ -369,6 +383,13 @@

Method Details

"A String", ], }, + "toolCall": { # Represents a call of a specific tool's action with the specified inputs. # Returns the definition of a tool call that should be executed by the client. + "action": "A String", # Required. The name of the tool's action associated with this call. + "inputParameters": { # Optional. The action's input parameters. + "a_key": "", # Properties of the object. + }, + "tool": "A String", # Required. The tool associated with this call. Format: `projects//locations//agents//tools/`. + }, }, }, ], @@ -425,6 +446,13 @@

Method Details

"A String", ], }, + "toolCall": { # Represents a call of a specific tool's action with the specified inputs. # Returns the definition of a tool call that should be executed by the client. + "action": "A String", # Required. The name of the tool's action associated with this call. + "inputParameters": { # Optional. The action's input parameters. + "a_key": "", # Properties of the object. + }, + "tool": "A String", # Required. The tool associated with this call. Format: `projects//locations//agents//tools/`. + }, }, ], "returnPartialResponses": True or False, # Whether Dialogflow should return currently queued fulfillment response messages in streaming APIs. If a webhook is specified, it happens before Dialogflow invokes webhook. Warning: 1) This flag only affects streaming API. Responses are still queued and returned once in non-streaming API. 2) The flag can be enabled in any fulfillment but only the first 3 partial responses will be returned. You may only want to apply it to fulfillments that have slow webhooks. @@ -500,8 +528,8 @@

Method Details

"maxDigits": 42, # Max length of DTMF digits. }, "loggingSettings": { # Define behaviors on logging. # Settings for logging. Settings for Dialogflow History, Contact Center messages, StackDriver logs, and speech logging. Exposed at the following levels: - Agent level. - "enableInteractionLogging": True or False, # If true, DF Interaction logging is currently enabled. - "enableStackdriverLogging": True or False, # If true, StackDriver logging is currently enabled. + "enableInteractionLogging": True or False, # Enables DF Interaction logging. + "enableStackdriverLogging": True or False, # Enables StackDriver logging. }, "speechSettings": { # Define behaviors of speech to text detection. # Settings for speech to text detection. Exposed at the following levels: - Agent level - Flow level - Page level - Parameter level "endpointerSensitivity": 42, # Sensitivity of the speech model that detects the end of speech. Scale from 0 to 100. @@ -565,6 +593,13 @@

Method Details

"A String", ], }, + "toolCall": { # Represents a call of a specific tool's action with the specified inputs. # Returns the definition of a tool call that should be executed by the client. + "action": "A String", # Required. The name of the tool's action associated with this call. + "inputParameters": { # Optional. The action's input parameters. + "a_key": "", # Properties of the object. + }, + "tool": "A String", # Required. The tool associated with this call. Format: `projects//locations//agents//tools/`. + }, }, }, ], @@ -621,6 +656,13 @@

Method Details

"A String", ], }, + "toolCall": { # Represents a call of a specific tool's action with the specified inputs. # Returns the definition of a tool call that should be executed by the client. + "action": "A String", # Required. The name of the tool's action associated with this call. + "inputParameters": { # Optional. The action's input parameters. + "a_key": "", # Properties of the object. + }, + "tool": "A String", # Required. The tool associated with this call. Format: `projects//locations//agents//tools/`. + }, }, ], "returnPartialResponses": True or False, # Whether Dialogflow should return currently queued fulfillment response messages in streaming APIs. If a webhook is specified, it happens before Dialogflow invokes webhook. Warning: 1) This flag only affects streaming API. Responses are still queued and returned once in non-streaming API. 2) The flag can be enabled in any fulfillment but only the first 3 partial responses will be returned. You may only want to apply it to fulfillments that have slow webhooks. @@ -682,8 +724,8 @@

Method Details

"maxDigits": 42, # Max length of DTMF digits. }, "loggingSettings": { # Define behaviors on logging. # Settings for logging. Settings for Dialogflow History, Contact Center messages, StackDriver logs, and speech logging. Exposed at the following levels: - Agent level. - "enableInteractionLogging": True or False, # If true, DF Interaction logging is currently enabled. - "enableStackdriverLogging": True or False, # If true, StackDriver logging is currently enabled. + "enableInteractionLogging": True or False, # Enables DF Interaction logging. + "enableStackdriverLogging": True or False, # Enables StackDriver logging. }, "speechSettings": { # Define behaviors of speech to text detection. # Settings for speech to text detection. Exposed at the following levels: - Agent level - Flow level - Page level - Parameter level "endpointerSensitivity": 42, # Sensitivity of the speech model that detects the end of speech. Scale from 0 to 100. @@ -747,6 +789,13 @@

Method Details

"A String", ], }, + "toolCall": { # Represents a call of a specific tool's action with the specified inputs. # Returns the definition of a tool call that should be executed by the client. + "action": "A String", # Required. The name of the tool's action associated with this call. + "inputParameters": { # Optional. The action's input parameters. + "a_key": "", # Properties of the object. + }, + "tool": "A String", # Required. The tool associated with this call. Format: `projects//locations//agents//tools/`. + }, }, }, ], @@ -803,6 +852,13 @@

Method Details

"A String", ], }, + "toolCall": { # Represents a call of a specific tool's action with the specified inputs. # Returns the definition of a tool call that should be executed by the client. + "action": "A String", # Required. The name of the tool's action associated with this call. + "inputParameters": { # Optional. The action's input parameters. + "a_key": "", # Properties of the object. + }, + "tool": "A String", # Required. The tool associated with this call. Format: `projects//locations//agents//tools/`. + }, }, ], "returnPartialResponses": True or False, # Whether Dialogflow should return currently queued fulfillment response messages in streaming APIs. If a webhook is specified, it happens before Dialogflow invokes webhook. Warning: 1) This flag only affects streaming API. Responses are still queued and returned once in non-streaming API. 2) The flag can be enabled in any fulfillment but only the first 3 partial responses will be returned. You may only want to apply it to fulfillments that have slow webhooks. @@ -869,8 +925,8 @@

Method Details

"maxDigits": 42, # Max length of DTMF digits. }, "loggingSettings": { # Define behaviors on logging. # Settings for logging. Settings for Dialogflow History, Contact Center messages, StackDriver logs, and speech logging. Exposed at the following levels: - Agent level. - "enableInteractionLogging": True or False, # If true, DF Interaction logging is currently enabled. - "enableStackdriverLogging": True or False, # If true, StackDriver logging is currently enabled. + "enableInteractionLogging": True or False, # Enables DF Interaction logging. + "enableStackdriverLogging": True or False, # Enables StackDriver logging. }, "speechSettings": { # Define behaviors of speech to text detection. # Settings for speech to text detection. Exposed at the following levels: - Agent level - Flow level - Page level - Parameter level "endpointerSensitivity": 42, # Sensitivity of the speech model that detects the end of speech. Scale from 0 to 100. @@ -934,6 +990,13 @@

Method Details

"A String", ], }, + "toolCall": { # Represents a call of a specific tool's action with the specified inputs. # Returns the definition of a tool call that should be executed by the client. + "action": "A String", # Required. The name of the tool's action associated with this call. + "inputParameters": { # Optional. The action's input parameters. + "a_key": "", # Properties of the object. + }, + "tool": "A String", # Required. The tool associated with this call. Format: `projects//locations//agents//tools/`. + }, }, }, ], @@ -990,6 +1053,13 @@

Method Details

"A String", ], }, + "toolCall": { # Represents a call of a specific tool's action with the specified inputs. # Returns the definition of a tool call that should be executed by the client. + "action": "A String", # Required. The name of the tool's action associated with this call. + "inputParameters": { # Optional. The action's input parameters. + "a_key": "", # Properties of the object. + }, + "tool": "A String", # Required. The tool associated with this call. Format: `projects//locations//agents//tools/`. + }, }, ], "returnPartialResponses": True or False, # Whether Dialogflow should return currently queued fulfillment response messages in streaming APIs. If a webhook is specified, it happens before Dialogflow invokes webhook. Warning: 1) This flag only affects streaming API. Responses are still queued and returned once in non-streaming API. 2) The flag can be enabled in any fulfillment but only the first 3 partial responses will be returned. You may only want to apply it to fulfillments that have slow webhooks. @@ -1040,8 +1110,8 @@

Method Details

"maxDigits": 42, # Max length of DTMF digits. }, "loggingSettings": { # Define behaviors on logging. # Settings for logging. Settings for Dialogflow History, Contact Center messages, StackDriver logs, and speech logging. Exposed at the following levels: - Agent level. - "enableInteractionLogging": True or False, # If true, DF Interaction logging is currently enabled. - "enableStackdriverLogging": True or False, # If true, StackDriver logging is currently enabled. + "enableInteractionLogging": True or False, # Enables DF Interaction logging. + "enableStackdriverLogging": True or False, # Enables StackDriver logging. }, "speechSettings": { # Define behaviors of speech to text detection. # Settings for speech to text detection. Exposed at the following levels: - Agent level - Flow level - Page level - Parameter level "endpointerSensitivity": 42, # Sensitivity of the speech model that detects the end of speech. Scale from 0 to 100. @@ -1105,6 +1175,13 @@

Method Details

"A String", ], }, + "toolCall": { # Represents a call of a specific tool's action with the specified inputs. # Returns the definition of a tool call that should be executed by the client. + "action": "A String", # Required. The name of the tool's action associated with this call. + "inputParameters": { # Optional. The action's input parameters. + "a_key": "", # Properties of the object. + }, + "tool": "A String", # Required. The tool associated with this call. Format: `projects//locations//agents//tools/`. + }, }, }, ], @@ -1161,6 +1238,13 @@

Method Details

"A String", ], }, + "toolCall": { # Represents a call of a specific tool's action with the specified inputs. # Returns the definition of a tool call that should be executed by the client. + "action": "A String", # Required. The name of the tool's action associated with this call. + "inputParameters": { # Optional. The action's input parameters. + "a_key": "", # Properties of the object. + }, + "tool": "A String", # Required. The tool associated with this call. Format: `projects//locations//agents//tools/`. + }, }, ], "returnPartialResponses": True or False, # Whether Dialogflow should return currently queued fulfillment response messages in streaming APIs. If a webhook is specified, it happens before Dialogflow invokes webhook. Warning: 1) This flag only affects streaming API. Responses are still queued and returned once in non-streaming API. 2) The flag can be enabled in any fulfillment but only the first 3 partial responses will be returned. You may only want to apply it to fulfillments that have slow webhooks. diff --git a/docs/dyn/dialogflow_v3beta1.projects.locations.agents.generators.html b/docs/dyn/dialogflow_v3beta1.projects.locations.agents.generators.html index 30dc0841d23..42b1b5864bb 100644 --- a/docs/dyn/dialogflow_v3beta1.projects.locations.agents.generators.html +++ b/docs/dyn/dialogflow_v3beta1.projects.locations.agents.generators.html @@ -112,6 +112,10 @@

Method Details

{ # Generators contain prompt to be sent to the LLM model to generate text. The prompt can contain parameters which will be resolved before calling the model. It can optionally contain banned phrases to ensure the model responses are safe. "displayName": "A String", # Required. The human-readable name of the generator, unique within the agent. The prompt contains pre-defined parameters such as $conversation, $last-user-utterance, etc. populated by Dialogflow. It can also contain custom placeholders which will be resolved during fulfillment. + "llmModelSettings": { # Settings for LLM models. # The LLM model settings. + "model": "A String", # The selected LLM model. + "promptText": "A String", # The custom prompt to use. + }, "name": "A String", # The unique identifier of the generator. Must be set for the Generators.UpdateGenerator method. Generators.CreateGenerate populates the name automatically. Format: `projects//locations//agents//generators/`. "placeholders": [ # Optional. List of custom placeholders in the prompt text. { # Represents a custom placeholder in the prompt text. @@ -135,6 +139,10 @@

Method Details

{ # Generators contain prompt to be sent to the LLM model to generate text. The prompt can contain parameters which will be resolved before calling the model. It can optionally contain banned phrases to ensure the model responses are safe. "displayName": "A String", # Required. The human-readable name of the generator, unique within the agent. The prompt contains pre-defined parameters such as $conversation, $last-user-utterance, etc. populated by Dialogflow. It can also contain custom placeholders which will be resolved during fulfillment. + "llmModelSettings": { # Settings for LLM models. # The LLM model settings. + "model": "A String", # The selected LLM model. + "promptText": "A String", # The custom prompt to use. + }, "name": "A String", # The unique identifier of the generator. Must be set for the Generators.UpdateGenerator method. Generators.CreateGenerate populates the name automatically. Format: `projects//locations//agents//generators/`. "placeholders": [ # Optional. List of custom placeholders in the prompt text. { # Represents a custom placeholder in the prompt text. @@ -184,6 +192,10 @@

Method Details

{ # Generators contain prompt to be sent to the LLM model to generate text. The prompt can contain parameters which will be resolved before calling the model. It can optionally contain banned phrases to ensure the model responses are safe. "displayName": "A String", # Required. The human-readable name of the generator, unique within the agent. The prompt contains pre-defined parameters such as $conversation, $last-user-utterance, etc. populated by Dialogflow. It can also contain custom placeholders which will be resolved during fulfillment. + "llmModelSettings": { # Settings for LLM models. # The LLM model settings. + "model": "A String", # The selected LLM model. + "promptText": "A String", # The custom prompt to use. + }, "name": "A String", # The unique identifier of the generator. Must be set for the Generators.UpdateGenerator method. Generators.CreateGenerate populates the name automatically. Format: `projects//locations//agents//generators/`. "placeholders": [ # Optional. List of custom placeholders in the prompt text. { # Represents a custom placeholder in the prompt text. @@ -218,6 +230,10 @@

Method Details

"generators": [ # The list of generators. There will be a maximum number of items returned based on the page_size field in the request. { # Generators contain prompt to be sent to the LLM model to generate text. The prompt can contain parameters which will be resolved before calling the model. It can optionally contain banned phrases to ensure the model responses are safe. "displayName": "A String", # Required. The human-readable name of the generator, unique within the agent. The prompt contains pre-defined parameters such as $conversation, $last-user-utterance, etc. populated by Dialogflow. It can also contain custom placeholders which will be resolved during fulfillment. + "llmModelSettings": { # Settings for LLM models. # The LLM model settings. + "model": "A String", # The selected LLM model. + "promptText": "A String", # The custom prompt to use. + }, "name": "A String", # The unique identifier of the generator. Must be set for the Generators.UpdateGenerator method. Generators.CreateGenerate populates the name automatically. Format: `projects//locations//agents//generators/`. "placeholders": [ # Optional. List of custom placeholders in the prompt text. { # Represents a custom placeholder in the prompt text. @@ -259,6 +275,10 @@

Method Details

{ # Generators contain prompt to be sent to the LLM model to generate text. The prompt can contain parameters which will be resolved before calling the model. It can optionally contain banned phrases to ensure the model responses are safe. "displayName": "A String", # Required. The human-readable name of the generator, unique within the agent. The prompt contains pre-defined parameters such as $conversation, $last-user-utterance, etc. populated by Dialogflow. It can also contain custom placeholders which will be resolved during fulfillment. + "llmModelSettings": { # Settings for LLM models. # The LLM model settings. + "model": "A String", # The selected LLM model. + "promptText": "A String", # The custom prompt to use. + }, "name": "A String", # The unique identifier of the generator. Must be set for the Generators.UpdateGenerator method. Generators.CreateGenerate populates the name automatically. Format: `projects//locations//agents//generators/`. "placeholders": [ # Optional. List of custom placeholders in the prompt text. { # Represents a custom placeholder in the prompt text. @@ -283,6 +303,10 @@

Method Details

{ # Generators contain prompt to be sent to the LLM model to generate text. The prompt can contain parameters which will be resolved before calling the model. It can optionally contain banned phrases to ensure the model responses are safe. "displayName": "A String", # Required. The human-readable name of the generator, unique within the agent. The prompt contains pre-defined parameters such as $conversation, $last-user-utterance, etc. populated by Dialogflow. It can also contain custom placeholders which will be resolved during fulfillment. + "llmModelSettings": { # Settings for LLM models. # The LLM model settings. + "model": "A String", # The selected LLM model. + "promptText": "A String", # The custom prompt to use. + }, "name": "A String", # The unique identifier of the generator. Must be set for the Generators.UpdateGenerator method. Generators.CreateGenerate populates the name automatically. Format: `projects//locations//agents//generators/`. "placeholders": [ # Optional. List of custom placeholders in the prompt text. { # Represents a custom placeholder in the prompt text. diff --git a/docs/dyn/dialogflow_v3beta1.projects.locations.agents.html b/docs/dyn/dialogflow_v3beta1.projects.locations.agents.html index a9dbc43da0c..48ab29c382e 100644 --- a/docs/dyn/dialogflow_v3beta1.projects.locations.agents.html +++ b/docs/dyn/dialogflow_v3beta1.projects.locations.agents.html @@ -109,6 +109,11 @@

Instance Methods

Returns the intents Resource.

+

+ playbooks() +

+

Returns the playbooks Resource.

+

sessions()

@@ -119,6 +124,11 @@

Instance Methods

Returns the testCases Resource.

+

+ tools() +

+

Returns the tools Resource.

+

transitionRouteGroups()

@@ -196,8 +206,8 @@

Method Details

"maxDigits": 42, # Max length of DTMF digits. }, "loggingSettings": { # Define behaviors on logging. # Settings for logging. Settings for Dialogflow History, Contact Center messages, StackDriver logs, and speech logging. Exposed at the following levels: - Agent level. - "enableInteractionLogging": True or False, # If true, DF Interaction logging is currently enabled. - "enableStackdriverLogging": True or False, # If true, StackDriver logging is currently enabled. + "enableInteractionLogging": True or False, # Enables DF Interaction logging. + "enableStackdriverLogging": True or False, # Enables StackDriver logging. }, "speechSettings": { # Define behaviors of speech to text detection. # Settings for speech to text detection. Exposed at the following levels: - Agent level - Flow level - Page level - Parameter level "endpointerSensitivity": 42, # Sensitivity of the speech model that detects the end of speech. Scale from 0 to 100. @@ -243,7 +253,8 @@

Method Details

"speechToTextSettings": { # Settings related to speech recognition. # Speech recognition related settings. "enableSpeechAdaptation": True or False, # Whether to use speech adaptation for speech recognition. }, - "startFlow": "A String", # Immutable. Name of the start flow in this agent. A start flow will be automatically created when the agent is created, and can only be deleted by deleting the agent. Format: `projects//locations//agents//flows/`. + "startFlow": "A String", # Name of the start flow in this agent. A start flow will be automatically created when the agent is created, and can only be deleted by deleting the agent. Format: `projects//locations//agents//flows/`. Currently only the default start flow with id "00000000-0000-0000-0000-000000000000" is allowed. + "startPlaybook": "A String", # Name of the start playbook in this agent. A start playbook will be automatically created when the agent is created, and can only be deleted by deleting the agent. Format: `projects//locations//agents//playbooks/`. Currently only the default playbook with id "00000000-0000-0000-0000-000000000000" is allowed. "supportedLanguageCodes": [ # The list of all languages supported by the agent (except for the `default_language_code`). "A String", ], @@ -287,8 +298,8 @@

Method Details

"maxDigits": 42, # Max length of DTMF digits. }, "loggingSettings": { # Define behaviors on logging. # Settings for logging. Settings for Dialogflow History, Contact Center messages, StackDriver logs, and speech logging. Exposed at the following levels: - Agent level. - "enableInteractionLogging": True or False, # If true, DF Interaction logging is currently enabled. - "enableStackdriverLogging": True or False, # If true, StackDriver logging is currently enabled. + "enableInteractionLogging": True or False, # Enables DF Interaction logging. + "enableStackdriverLogging": True or False, # Enables StackDriver logging. }, "speechSettings": { # Define behaviors of speech to text detection. # Settings for speech to text detection. Exposed at the following levels: - Agent level - Flow level - Page level - Parameter level "endpointerSensitivity": 42, # Sensitivity of the speech model that detects the end of speech. Scale from 0 to 100. @@ -334,7 +345,8 @@

Method Details

"speechToTextSettings": { # Settings related to speech recognition. # Speech recognition related settings. "enableSpeechAdaptation": True or False, # Whether to use speech adaptation for speech recognition. }, - "startFlow": "A String", # Immutable. Name of the start flow in this agent. A start flow will be automatically created when the agent is created, and can only be deleted by deleting the agent. Format: `projects//locations//agents//flows/`. + "startFlow": "A String", # Name of the start flow in this agent. A start flow will be automatically created when the agent is created, and can only be deleted by deleting the agent. Format: `projects//locations//agents//flows/`. Currently only the default start flow with id "00000000-0000-0000-0000-000000000000" is allowed. + "startPlaybook": "A String", # Name of the start playbook in this agent. A start playbook will be automatically created when the agent is created, and can only be deleted by deleting the agent. Format: `projects//locations//agents//playbooks/`. Currently only the default playbook with id "00000000-0000-0000-0000-000000000000" is allowed. "supportedLanguageCodes": [ # The list of all languages supported by the agent (except for the `default_language_code`). "A String", ], @@ -452,8 +464,8 @@

Method Details

"maxDigits": 42, # Max length of DTMF digits. }, "loggingSettings": { # Define behaviors on logging. # Settings for logging. Settings for Dialogflow History, Contact Center messages, StackDriver logs, and speech logging. Exposed at the following levels: - Agent level. - "enableInteractionLogging": True or False, # If true, DF Interaction logging is currently enabled. - "enableStackdriverLogging": True or False, # If true, StackDriver logging is currently enabled. + "enableInteractionLogging": True or False, # Enables DF Interaction logging. + "enableStackdriverLogging": True or False, # Enables StackDriver logging. }, "speechSettings": { # Define behaviors of speech to text detection. # Settings for speech to text detection. Exposed at the following levels: - Agent level - Flow level - Page level - Parameter level "endpointerSensitivity": 42, # Sensitivity of the speech model that detects the end of speech. Scale from 0 to 100. @@ -499,7 +511,8 @@

Method Details

"speechToTextSettings": { # Settings related to speech recognition. # Speech recognition related settings. "enableSpeechAdaptation": True or False, # Whether to use speech adaptation for speech recognition. }, - "startFlow": "A String", # Immutable. Name of the start flow in this agent. A start flow will be automatically created when the agent is created, and can only be deleted by deleting the agent. Format: `projects//locations//agents//flows/`. + "startFlow": "A String", # Name of the start flow in this agent. A start flow will be automatically created when the agent is created, and can only be deleted by deleting the agent. Format: `projects//locations//agents//flows/`. Currently only the default start flow with id "00000000-0000-0000-0000-000000000000" is allowed. + "startPlaybook": "A String", # Name of the start playbook in this agent. A start playbook will be automatically created when the agent is created, and can only be deleted by deleting the agent. Format: `projects//locations//agents//playbooks/`. Currently only the default playbook with id "00000000-0000-0000-0000-000000000000" is allowed. "supportedLanguageCodes": [ # The list of all languages supported by the agent (except for the `default_language_code`). "A String", ], @@ -566,6 +579,10 @@

Method Details

"disableDataStoreFallback": True or False, # Whether to disable fallback to Data Store search results (in case the LLM couldn't pick a proper answer). Per default the feature is enabled. }, "languageCode": "A String", # Language for this settings. + "llmModelSettings": { # Settings for LLM models. # LLM model settings. + "model": "A String", # The selected LLM model. + "promptText": "A String", # The custom prompt to use. + }, "name": "A String", # Format: `projects//locations//agents//generativeSettings`. }
@@ -643,8 +660,8 @@

Method Details

"maxDigits": 42, # Max length of DTMF digits. }, "loggingSettings": { # Define behaviors on logging. # Settings for logging. Settings for Dialogflow History, Contact Center messages, StackDriver logs, and speech logging. Exposed at the following levels: - Agent level. - "enableInteractionLogging": True or False, # If true, DF Interaction logging is currently enabled. - "enableStackdriverLogging": True or False, # If true, StackDriver logging is currently enabled. + "enableInteractionLogging": True or False, # Enables DF Interaction logging. + "enableStackdriverLogging": True or False, # Enables StackDriver logging. }, "speechSettings": { # Define behaviors of speech to text detection. # Settings for speech to text detection. Exposed at the following levels: - Agent level - Flow level - Page level - Parameter level "endpointerSensitivity": 42, # Sensitivity of the speech model that detects the end of speech. Scale from 0 to 100. @@ -690,7 +707,8 @@

Method Details

"speechToTextSettings": { # Settings related to speech recognition. # Speech recognition related settings. "enableSpeechAdaptation": True or False, # Whether to use speech adaptation for speech recognition. }, - "startFlow": "A String", # Immutable. Name of the start flow in this agent. A start flow will be automatically created when the agent is created, and can only be deleted by deleting the agent. Format: `projects//locations//agents//flows/`. + "startFlow": "A String", # Name of the start flow in this agent. A start flow will be automatically created when the agent is created, and can only be deleted by deleting the agent. Format: `projects//locations//agents//flows/`. Currently only the default start flow with id "00000000-0000-0000-0000-000000000000" is allowed. + "startPlaybook": "A String", # Name of the start playbook in this agent. A start playbook will be automatically created when the agent is created, and can only be deleted by deleting the agent. Format: `projects//locations//agents//playbooks/`. Currently only the default playbook with id "00000000-0000-0000-0000-000000000000" is allowed. "supportedLanguageCodes": [ # The list of all languages supported by the agent (except for the `default_language_code`). "A String", ], @@ -753,8 +771,8 @@

Method Details

"maxDigits": 42, # Max length of DTMF digits. }, "loggingSettings": { # Define behaviors on logging. # Settings for logging. Settings for Dialogflow History, Contact Center messages, StackDriver logs, and speech logging. Exposed at the following levels: - Agent level. - "enableInteractionLogging": True or False, # If true, DF Interaction logging is currently enabled. - "enableStackdriverLogging": True or False, # If true, StackDriver logging is currently enabled. + "enableInteractionLogging": True or False, # Enables DF Interaction logging. + "enableStackdriverLogging": True or False, # Enables StackDriver logging. }, "speechSettings": { # Define behaviors of speech to text detection. # Settings for speech to text detection. Exposed at the following levels: - Agent level - Flow level - Page level - Parameter level "endpointerSensitivity": 42, # Sensitivity of the speech model that detects the end of speech. Scale from 0 to 100. @@ -800,7 +818,8 @@

Method Details

"speechToTextSettings": { # Settings related to speech recognition. # Speech recognition related settings. "enableSpeechAdaptation": True or False, # Whether to use speech adaptation for speech recognition. }, - "startFlow": "A String", # Immutable. Name of the start flow in this agent. A start flow will be automatically created when the agent is created, and can only be deleted by deleting the agent. Format: `projects//locations//agents//flows/`. + "startFlow": "A String", # Name of the start flow in this agent. A start flow will be automatically created when the agent is created, and can only be deleted by deleting the agent. Format: `projects//locations//agents//flows/`. Currently only the default start flow with id "00000000-0000-0000-0000-000000000000" is allowed. + "startPlaybook": "A String", # Name of the start playbook in this agent. A start playbook will be automatically created when the agent is created, and can only be deleted by deleting the agent. Format: `projects//locations//agents//playbooks/`. Currently only the default playbook with id "00000000-0000-0000-0000-000000000000" is allowed. "supportedLanguageCodes": [ # The list of all languages supported by the agent (except for the `default_language_code`). "A String", ], @@ -845,8 +864,8 @@

Method Details

"maxDigits": 42, # Max length of DTMF digits. }, "loggingSettings": { # Define behaviors on logging. # Settings for logging. Settings for Dialogflow History, Contact Center messages, StackDriver logs, and speech logging. Exposed at the following levels: - Agent level. - "enableInteractionLogging": True or False, # If true, DF Interaction logging is currently enabled. - "enableStackdriverLogging": True or False, # If true, StackDriver logging is currently enabled. + "enableInteractionLogging": True or False, # Enables DF Interaction logging. + "enableStackdriverLogging": True or False, # Enables StackDriver logging. }, "speechSettings": { # Define behaviors of speech to text detection. # Settings for speech to text detection. Exposed at the following levels: - Agent level - Flow level - Page level - Parameter level "endpointerSensitivity": 42, # Sensitivity of the speech model that detects the end of speech. Scale from 0 to 100. @@ -892,7 +911,8 @@

Method Details

"speechToTextSettings": { # Settings related to speech recognition. # Speech recognition related settings. "enableSpeechAdaptation": True or False, # Whether to use speech adaptation for speech recognition. }, - "startFlow": "A String", # Immutable. Name of the start flow in this agent. A start flow will be automatically created when the agent is created, and can only be deleted by deleting the agent. Format: `projects//locations//agents//flows/`. + "startFlow": "A String", # Name of the start flow in this agent. A start flow will be automatically created when the agent is created, and can only be deleted by deleting the agent. Format: `projects//locations//agents//flows/`. Currently only the default start flow with id "00000000-0000-0000-0000-000000000000" is allowed. + "startPlaybook": "A String", # Name of the start playbook in this agent. A start playbook will be automatically created when the agent is created, and can only be deleted by deleting the agent. Format: `projects//locations//agents//playbooks/`. Currently only the default playbook with id "00000000-0000-0000-0000-000000000000" is allowed. "supportedLanguageCodes": [ # The list of all languages supported by the agent (except for the `default_language_code`). "A String", ], @@ -1000,6 +1020,10 @@

Method Details

"disableDataStoreFallback": True or False, # Whether to disable fallback to Data Store search results (in case the LLM couldn't pick a proper answer). Per default the feature is enabled. }, "languageCode": "A String", # Language for this settings. + "llmModelSettings": { # Settings for LLM models. # LLM model settings. + "model": "A String", # The selected LLM model. + "promptText": "A String", # The custom prompt to use. + }, "name": "A String", # Format: `projects//locations//agents//generativeSettings`. } @@ -1040,6 +1064,10 @@

Method Details

"disableDataStoreFallback": True or False, # Whether to disable fallback to Data Store search results (in case the LLM couldn't pick a proper answer). Per default the feature is enabled. }, "languageCode": "A String", # Language for this settings. + "llmModelSettings": { # Settings for LLM models. # LLM model settings. + "model": "A String", # The selected LLM model. + "promptText": "A String", # The custom prompt to use. + }, "name": "A String", # Format: `projects//locations//agents//generativeSettings`. }
diff --git a/docs/dyn/dialogflow_v3beta1.projects.locations.agents.playbooks.examples.html b/docs/dyn/dialogflow_v3beta1.projects.locations.agents.playbooks.examples.html new file mode 100644 index 00000000000..ac8ba0721d2 --- /dev/null +++ b/docs/dyn/dialogflow_v3beta1.projects.locations.agents.playbooks.examples.html @@ -0,0 +1,625 @@ + + + +

Dialogflow API . projects . locations . agents . playbooks . examples

+

Instance Methods

+

+ close()

+

Close httplib2 connections.

+

+ create(parent, body=None, x__xgafv=None)

+

Creates an example in the specified playbook.

+

+ delete(name, x__xgafv=None)

+

Deletes the specified example.

+

+ get(name, x__xgafv=None)

+

Retrieves the specified example.

+

+ list(parent, languageCode=None, pageSize=None, pageToken=None, x__xgafv=None)

+

Returns a list of examples in the specified playbook.

+

+ list_next()

+

Retrieves the next page of results.

+

+ patch(name, body=None, updateMask=None, x__xgafv=None)

+

Update the specified example.

+

Method Details

+
+ close() +
Close httplib2 connections.
+
+ +
+ create(parent, body=None, x__xgafv=None) +
Creates an example in the specified playbook.
+
+Args:
+  parent: string, Required. The playbook to create an example for. Format: `projects//locations//agents//playbooks/`. (required)
+  body: object, The request body.
+    The object takes the form of:
+
+{ # Example represents a sample execution of the playbook in the conversation. An example consists of a list of ordered actions performed by end user or Dialogflow agent according the playbook instructions to fulfill the task.
+  "actions": [ # Required. The ordered list of actions performed by the end user and the Dialogflow agent.
+    { # Action performed by end user or Dialogflow agent in the conversation.
+      "agentUtterance": { # AgentUtterance represents one message sent by the agent. # Optional. Action performed by the agent as a message.
+        "text": "A String", # Required. Message content in text.
+      },
+      "flowInvocation": { # Stores metadata of the invocation of a CX flow. Next Id: 7 # Optional. Action performed on behalf of the agent by invoking a CX flow.
+        "flow": "A String", # Required. The unique identifier of the flow. Format: `projects//locations//agents/`.
+        "flowState": "A String", # Required. Flow invocation's output state.
+        "inputActionParameters": { # Optional. A list of input parameters for the flow.
+          "a_key": "", # Properties of the object.
+        },
+        "outputActionParameters": { # Optional. A list of output parameters generated by the flow invocation.
+          "a_key": "", # Properties of the object.
+        },
+      },
+      "playbookInvocation": { # Stores metadata of the invocation of a child playbook. Next Id: 5 # Optional. Action performed on behalf of the agent by invoking a child playbook.
+        "playbook": "A String", # Required. The unique identifier of the playbook. Format: `projects//locations//agents//playbooks/`.
+        "playbookInput": { # Input of the playbook. # Optional. Input of the child playbook invocation.
+          "actionParameters": { # Optional. A list of input parameters for the action.
+            "a_key": "", # Properties of the object.
+          },
+          "precedingConversationSummary": "A String", # Optional. Summary string of the preceding conversation for the child playbook invocation.
+        },
+        "playbookOutput": { # Output of the playbook. # Optional. Output of the child playbook invocation.
+          "actionParameters": { # Optional. A Struct object of output parameters for the action.
+            "a_key": "", # Properties of the object.
+          },
+          "executionSummary": "A String", # Optional. Summary string of the execution result of the child playbook.
+        },
+        "playbookState": "A String", # Required. Playbook invocation's output state.
+      },
+      "toolUse": { # Stores metadata of the invocation of an action supported by a tool. # Optional. Action performed on behalf of the agent by calling a plugin tool.
+        "action": "A String", # Optional. Name of the action to be called during the tool use.
+        "inputActionParameters": { # Optional. A list of input parameters for the action.
+          "a_key": "", # Properties of the object.
+        },
+        "outputActionParameters": { # Optional. A list of output parameters generated by the action.
+          "a_key": "", # Properties of the object.
+        },
+        "tool": "A String", # Required. The tool that should be used. Format: `projects//locations//agents//tools/`.
+      },
+      "userUtterance": { # UserUtterance represents one message sent by the customer. # Optional. Agent obtained a message from the customer.
+        "text": "A String", # Required. Message content in text.
+      },
+    },
+  ],
+  "conversationState": "A String", # Required. Example's output state.
+  "createTime": "A String", # Output only. The timestamp of initial example creation.
+  "description": "A String", # Optional. The high level concise description of the example. The max number of characters is 200.
+  "displayName": "A String", # Required. The display name of the example.
+  "languageCode": "A String", # Optional. The language code of the example. If not specified, the agent's default language is used. Note: languages must be enabled in the agent before they can be used.
+  "name": "A String", # The unique identifier of the playbook example. Format: `projects//locations//agents//playbooks//examples/`.
+  "playbookInput": { # Input of the playbook. # Optional. The input to the playbook in the example.
+    "actionParameters": { # Optional. A list of input parameters for the action.
+      "a_key": "", # Properties of the object.
+    },
+    "precedingConversationSummary": "A String", # Optional. Summary string of the preceding conversation for the child playbook invocation.
+  },
+  "playbookOutput": { # Output of the playbook. # Optional. The output of the playbook in the example.
+    "actionParameters": { # Optional. A Struct object of output parameters for the action.
+      "a_key": "", # Properties of the object.
+    },
+    "executionSummary": "A String", # Optional. Summary string of the execution result of the child playbook.
+  },
+  "tokenCount": "A String", # Output only. Estimated number of tokes current example takes when sent to the LLM.
+  "updateTime": "A String", # Output only. Last time the example was updated.
+}
+
+  x__xgafv: string, V1 error format.
+    Allowed values
+      1 - v1 error format
+      2 - v2 error format
+
+Returns:
+  An object of the form:
+
+    { # Example represents a sample execution of the playbook in the conversation. An example consists of a list of ordered actions performed by end user or Dialogflow agent according the playbook instructions to fulfill the task.
+  "actions": [ # Required. The ordered list of actions performed by the end user and the Dialogflow agent.
+    { # Action performed by end user or Dialogflow agent in the conversation.
+      "agentUtterance": { # AgentUtterance represents one message sent by the agent. # Optional. Action performed by the agent as a message.
+        "text": "A String", # Required. Message content in text.
+      },
+      "flowInvocation": { # Stores metadata of the invocation of a CX flow. Next Id: 7 # Optional. Action performed on behalf of the agent by invoking a CX flow.
+        "flow": "A String", # Required. The unique identifier of the flow. Format: `projects//locations//agents/`.
+        "flowState": "A String", # Required. Flow invocation's output state.
+        "inputActionParameters": { # Optional. A list of input parameters for the flow.
+          "a_key": "", # Properties of the object.
+        },
+        "outputActionParameters": { # Optional. A list of output parameters generated by the flow invocation.
+          "a_key": "", # Properties of the object.
+        },
+      },
+      "playbookInvocation": { # Stores metadata of the invocation of a child playbook. Next Id: 5 # Optional. Action performed on behalf of the agent by invoking a child playbook.
+        "playbook": "A String", # Required. The unique identifier of the playbook. Format: `projects//locations//agents//playbooks/`.
+        "playbookInput": { # Input of the playbook. # Optional. Input of the child playbook invocation.
+          "actionParameters": { # Optional. A list of input parameters for the action.
+            "a_key": "", # Properties of the object.
+          },
+          "precedingConversationSummary": "A String", # Optional. Summary string of the preceding conversation for the child playbook invocation.
+        },
+        "playbookOutput": { # Output of the playbook. # Optional. Output of the child playbook invocation.
+          "actionParameters": { # Optional. A Struct object of output parameters for the action.
+            "a_key": "", # Properties of the object.
+          },
+          "executionSummary": "A String", # Optional. Summary string of the execution result of the child playbook.
+        },
+        "playbookState": "A String", # Required. Playbook invocation's output state.
+      },
+      "toolUse": { # Stores metadata of the invocation of an action supported by a tool. # Optional. Action performed on behalf of the agent by calling a plugin tool.
+        "action": "A String", # Optional. Name of the action to be called during the tool use.
+        "inputActionParameters": { # Optional. A list of input parameters for the action.
+          "a_key": "", # Properties of the object.
+        },
+        "outputActionParameters": { # Optional. A list of output parameters generated by the action.
+          "a_key": "", # Properties of the object.
+        },
+        "tool": "A String", # Required. The tool that should be used. Format: `projects//locations//agents//tools/`.
+      },
+      "userUtterance": { # UserUtterance represents one message sent by the customer. # Optional. Agent obtained a message from the customer.
+        "text": "A String", # Required. Message content in text.
+      },
+    },
+  ],
+  "conversationState": "A String", # Required. Example's output state.
+  "createTime": "A String", # Output only. The timestamp of initial example creation.
+  "description": "A String", # Optional. The high level concise description of the example. The max number of characters is 200.
+  "displayName": "A String", # Required. The display name of the example.
+  "languageCode": "A String", # Optional. The language code of the example. If not specified, the agent's default language is used. Note: languages must be enabled in the agent before they can be used.
+  "name": "A String", # The unique identifier of the playbook example. Format: `projects//locations//agents//playbooks//examples/`.
+  "playbookInput": { # Input of the playbook. # Optional. The input to the playbook in the example.
+    "actionParameters": { # Optional. A list of input parameters for the action.
+      "a_key": "", # Properties of the object.
+    },
+    "precedingConversationSummary": "A String", # Optional. Summary string of the preceding conversation for the child playbook invocation.
+  },
+  "playbookOutput": { # Output of the playbook. # Optional. The output of the playbook in the example.
+    "actionParameters": { # Optional. A Struct object of output parameters for the action.
+      "a_key": "", # Properties of the object.
+    },
+    "executionSummary": "A String", # Optional. Summary string of the execution result of the child playbook.
+  },
+  "tokenCount": "A String", # Output only. Estimated number of tokes current example takes when sent to the LLM.
+  "updateTime": "A String", # Output only. Last time the example was updated.
+}
+
+ +
+ delete(name, x__xgafv=None) +
Deletes the specified example.
+
+Args:
+  name: string, Required. The name of the example to delete. Format: `projects//locations//agents//playbooks//examples/`. (required)
+  x__xgafv: string, V1 error format.
+    Allowed values
+      1 - v1 error format
+      2 - v2 error format
+
+Returns:
+  An object of the form:
+
+    { # A generic empty message that you can re-use to avoid defining duplicated empty messages in your APIs. A typical example is to use it as the request or the response type of an API method. For instance: service Foo { rpc Bar(google.protobuf.Empty) returns (google.protobuf.Empty); }
+}
+
+ +
+ get(name, x__xgafv=None) +
Retrieves the specified example.
+
+Args:
+  name: string, Required. The name of the example. Format: `projects//locations//agents//playbooks//examples/`. (required)
+  x__xgafv: string, V1 error format.
+    Allowed values
+      1 - v1 error format
+      2 - v2 error format
+
+Returns:
+  An object of the form:
+
+    { # Example represents a sample execution of the playbook in the conversation. An example consists of a list of ordered actions performed by end user or Dialogflow agent according the playbook instructions to fulfill the task.
+  "actions": [ # Required. The ordered list of actions performed by the end user and the Dialogflow agent.
+    { # Action performed by end user or Dialogflow agent in the conversation.
+      "agentUtterance": { # AgentUtterance represents one message sent by the agent. # Optional. Action performed by the agent as a message.
+        "text": "A String", # Required. Message content in text.
+      },
+      "flowInvocation": { # Stores metadata of the invocation of a CX flow. Next Id: 7 # Optional. Action performed on behalf of the agent by invoking a CX flow.
+        "flow": "A String", # Required. The unique identifier of the flow. Format: `projects//locations//agents/`.
+        "flowState": "A String", # Required. Flow invocation's output state.
+        "inputActionParameters": { # Optional. A list of input parameters for the flow.
+          "a_key": "", # Properties of the object.
+        },
+        "outputActionParameters": { # Optional. A list of output parameters generated by the flow invocation.
+          "a_key": "", # Properties of the object.
+        },
+      },
+      "playbookInvocation": { # Stores metadata of the invocation of a child playbook. Next Id: 5 # Optional. Action performed on behalf of the agent by invoking a child playbook.
+        "playbook": "A String", # Required. The unique identifier of the playbook. Format: `projects//locations//agents//playbooks/`.
+        "playbookInput": { # Input of the playbook. # Optional. Input of the child playbook invocation.
+          "actionParameters": { # Optional. A list of input parameters for the action.
+            "a_key": "", # Properties of the object.
+          },
+          "precedingConversationSummary": "A String", # Optional. Summary string of the preceding conversation for the child playbook invocation.
+        },
+        "playbookOutput": { # Output of the playbook. # Optional. Output of the child playbook invocation.
+          "actionParameters": { # Optional. A Struct object of output parameters for the action.
+            "a_key": "", # Properties of the object.
+          },
+          "executionSummary": "A String", # Optional. Summary string of the execution result of the child playbook.
+        },
+        "playbookState": "A String", # Required. Playbook invocation's output state.
+      },
+      "toolUse": { # Stores metadata of the invocation of an action supported by a tool. # Optional. Action performed on behalf of the agent by calling a plugin tool.
+        "action": "A String", # Optional. Name of the action to be called during the tool use.
+        "inputActionParameters": { # Optional. A list of input parameters for the action.
+          "a_key": "", # Properties of the object.
+        },
+        "outputActionParameters": { # Optional. A list of output parameters generated by the action.
+          "a_key": "", # Properties of the object.
+        },
+        "tool": "A String", # Required. The tool that should be used. Format: `projects//locations//agents//tools/`.
+      },
+      "userUtterance": { # UserUtterance represents one message sent by the customer. # Optional. Agent obtained a message from the customer.
+        "text": "A String", # Required. Message content in text.
+      },
+    },
+  ],
+  "conversationState": "A String", # Required. Example's output state.
+  "createTime": "A String", # Output only. The timestamp of initial example creation.
+  "description": "A String", # Optional. The high level concise description of the example. The max number of characters is 200.
+  "displayName": "A String", # Required. The display name of the example.
+  "languageCode": "A String", # Optional. The language code of the example. If not specified, the agent's default language is used. Note: languages must be enabled in the agent before they can be used.
+  "name": "A String", # The unique identifier of the playbook example. Format: `projects//locations//agents//playbooks//examples/`.
+  "playbookInput": { # Input of the playbook. # Optional. The input to the playbook in the example.
+    "actionParameters": { # Optional. A list of input parameters for the action.
+      "a_key": "", # Properties of the object.
+    },
+    "precedingConversationSummary": "A String", # Optional. Summary string of the preceding conversation for the child playbook invocation.
+  },
+  "playbookOutput": { # Output of the playbook. # Optional. The output of the playbook in the example.
+    "actionParameters": { # Optional. A Struct object of output parameters for the action.
+      "a_key": "", # Properties of the object.
+    },
+    "executionSummary": "A String", # Optional. Summary string of the execution result of the child playbook.
+  },
+  "tokenCount": "A String", # Output only. Estimated number of tokes current example takes when sent to the LLM.
+  "updateTime": "A String", # Output only. Last time the example was updated.
+}
+
+ +
+ list(parent, languageCode=None, pageSize=None, pageToken=None, x__xgafv=None) +
Returns a list of examples in the specified playbook.
+
+Args:
+  parent: string, Required. The playbook to list the examples from. Format: `projects//locations//agents//playbooks/`. (required)
+  languageCode: string, Optional. The language to list examples for. If not specified, the agent's default language is used. Note: languages must be enabled in the agent before they can be used.
+  pageSize: integer, Optional. The maximum number of items to return in a single page. By default 100 and at most 1000.
+  pageToken: string, Optional. The next_page_token value returned from a previous list request.
+  x__xgafv: string, V1 error format.
+    Allowed values
+      1 - v1 error format
+      2 - v2 error format
+
+Returns:
+  An object of the form:
+
+    { # The response message for Examples.ListExamples.
+  "examples": [ # The list of examples. There will be a maximum number of items returned based on the page_size field in the request.
+    { # Example represents a sample execution of the playbook in the conversation. An example consists of a list of ordered actions performed by end user or Dialogflow agent according the playbook instructions to fulfill the task.
+      "actions": [ # Required. The ordered list of actions performed by the end user and the Dialogflow agent.
+        { # Action performed by end user or Dialogflow agent in the conversation.
+          "agentUtterance": { # AgentUtterance represents one message sent by the agent. # Optional. Action performed by the agent as a message.
+            "text": "A String", # Required. Message content in text.
+          },
+          "flowInvocation": { # Stores metadata of the invocation of a CX flow. Next Id: 7 # Optional. Action performed on behalf of the agent by invoking a CX flow.
+            "flow": "A String", # Required. The unique identifier of the flow. Format: `projects//locations//agents/`.
+            "flowState": "A String", # Required. Flow invocation's output state.
+            "inputActionParameters": { # Optional. A list of input parameters for the flow.
+              "a_key": "", # Properties of the object.
+            },
+            "outputActionParameters": { # Optional. A list of output parameters generated by the flow invocation.
+              "a_key": "", # Properties of the object.
+            },
+          },
+          "playbookInvocation": { # Stores metadata of the invocation of a child playbook. Next Id: 5 # Optional. Action performed on behalf of the agent by invoking a child playbook.
+            "playbook": "A String", # Required. The unique identifier of the playbook. Format: `projects//locations//agents//playbooks/`.
+            "playbookInput": { # Input of the playbook. # Optional. Input of the child playbook invocation.
+              "actionParameters": { # Optional. A list of input parameters for the action.
+                "a_key": "", # Properties of the object.
+              },
+              "precedingConversationSummary": "A String", # Optional. Summary string of the preceding conversation for the child playbook invocation.
+            },
+            "playbookOutput": { # Output of the playbook. # Optional. Output of the child playbook invocation.
+              "actionParameters": { # Optional. A Struct object of output parameters for the action.
+                "a_key": "", # Properties of the object.
+              },
+              "executionSummary": "A String", # Optional. Summary string of the execution result of the child playbook.
+            },
+            "playbookState": "A String", # Required. Playbook invocation's output state.
+          },
+          "toolUse": { # Stores metadata of the invocation of an action supported by a tool. # Optional. Action performed on behalf of the agent by calling a plugin tool.
+            "action": "A String", # Optional. Name of the action to be called during the tool use.
+            "inputActionParameters": { # Optional. A list of input parameters for the action.
+              "a_key": "", # Properties of the object.
+            },
+            "outputActionParameters": { # Optional. A list of output parameters generated by the action.
+              "a_key": "", # Properties of the object.
+            },
+            "tool": "A String", # Required. The tool that should be used. Format: `projects//locations//agents//tools/`.
+          },
+          "userUtterance": { # UserUtterance represents one message sent by the customer. # Optional. Agent obtained a message from the customer.
+            "text": "A String", # Required. Message content in text.
+          },
+        },
+      ],
+      "conversationState": "A String", # Required. Example's output state.
+      "createTime": "A String", # Output only. The timestamp of initial example creation.
+      "description": "A String", # Optional. The high level concise description of the example. The max number of characters is 200.
+      "displayName": "A String", # Required. The display name of the example.
+      "languageCode": "A String", # Optional. The language code of the example. If not specified, the agent's default language is used. Note: languages must be enabled in the agent before they can be used.
+      "name": "A String", # The unique identifier of the playbook example. Format: `projects//locations//agents//playbooks//examples/`.
+      "playbookInput": { # Input of the playbook. # Optional. The input to the playbook in the example.
+        "actionParameters": { # Optional. A list of input parameters for the action.
+          "a_key": "", # Properties of the object.
+        },
+        "precedingConversationSummary": "A String", # Optional. Summary string of the preceding conversation for the child playbook invocation.
+      },
+      "playbookOutput": { # Output of the playbook. # Optional. The output of the playbook in the example.
+        "actionParameters": { # Optional. A Struct object of output parameters for the action.
+          "a_key": "", # Properties of the object.
+        },
+        "executionSummary": "A String", # Optional. Summary string of the execution result of the child playbook.
+      },
+      "tokenCount": "A String", # Output only. Estimated number of tokes current example takes when sent to the LLM.
+      "updateTime": "A String", # Output only. Last time the example was updated.
+    },
+  ],
+  "nextPageToken": "A String", # Token to retrieve the next page of results, or empty if there are no more results in the list.
+}
+
+ +
+ list_next() +
Retrieves the next page of results.
+
+        Args:
+          previous_request: The request for the previous page. (required)
+          previous_response: The response from the request for the previous page. (required)
+
+        Returns:
+          A request object that you can call 'execute()' on to request the next
+          page. Returns None if there are no more items in the collection.
+        
+
+ +
+ patch(name, body=None, updateMask=None, x__xgafv=None) +
Update the specified example.
+
+Args:
+  name: string, The unique identifier of the playbook example. Format: `projects//locations//agents//playbooks//examples/`. (required)
+  body: object, The request body.
+    The object takes the form of:
+
+{ # Example represents a sample execution of the playbook in the conversation. An example consists of a list of ordered actions performed by end user or Dialogflow agent according the playbook instructions to fulfill the task.
+  "actions": [ # Required. The ordered list of actions performed by the end user and the Dialogflow agent.
+    { # Action performed by end user or Dialogflow agent in the conversation.
+      "agentUtterance": { # AgentUtterance represents one message sent by the agent. # Optional. Action performed by the agent as a message.
+        "text": "A String", # Required. Message content in text.
+      },
+      "flowInvocation": { # Stores metadata of the invocation of a CX flow. Next Id: 7 # Optional. Action performed on behalf of the agent by invoking a CX flow.
+        "flow": "A String", # Required. The unique identifier of the flow. Format: `projects//locations//agents/`.
+        "flowState": "A String", # Required. Flow invocation's output state.
+        "inputActionParameters": { # Optional. A list of input parameters for the flow.
+          "a_key": "", # Properties of the object.
+        },
+        "outputActionParameters": { # Optional. A list of output parameters generated by the flow invocation.
+          "a_key": "", # Properties of the object.
+        },
+      },
+      "playbookInvocation": { # Stores metadata of the invocation of a child playbook. Next Id: 5 # Optional. Action performed on behalf of the agent by invoking a child playbook.
+        "playbook": "A String", # Required. The unique identifier of the playbook. Format: `projects//locations//agents//playbooks/`.
+        "playbookInput": { # Input of the playbook. # Optional. Input of the child playbook invocation.
+          "actionParameters": { # Optional. A list of input parameters for the action.
+            "a_key": "", # Properties of the object.
+          },
+          "precedingConversationSummary": "A String", # Optional. Summary string of the preceding conversation for the child playbook invocation.
+        },
+        "playbookOutput": { # Output of the playbook. # Optional. Output of the child playbook invocation.
+          "actionParameters": { # Optional. A Struct object of output parameters for the action.
+            "a_key": "", # Properties of the object.
+          },
+          "executionSummary": "A String", # Optional. Summary string of the execution result of the child playbook.
+        },
+        "playbookState": "A String", # Required. Playbook invocation's output state.
+      },
+      "toolUse": { # Stores metadata of the invocation of an action supported by a tool. # Optional. Action performed on behalf of the agent by calling a plugin tool.
+        "action": "A String", # Optional. Name of the action to be called during the tool use.
+        "inputActionParameters": { # Optional. A list of input parameters for the action.
+          "a_key": "", # Properties of the object.
+        },
+        "outputActionParameters": { # Optional. A list of output parameters generated by the action.
+          "a_key": "", # Properties of the object.
+        },
+        "tool": "A String", # Required. The tool that should be used. Format: `projects//locations//agents//tools/`.
+      },
+      "userUtterance": { # UserUtterance represents one message sent by the customer. # Optional. Agent obtained a message from the customer.
+        "text": "A String", # Required. Message content in text.
+      },
+    },
+  ],
+  "conversationState": "A String", # Required. Example's output state.
+  "createTime": "A String", # Output only. The timestamp of initial example creation.
+  "description": "A String", # Optional. The high level concise description of the example. The max number of characters is 200.
+  "displayName": "A String", # Required. The display name of the example.
+  "languageCode": "A String", # Optional. The language code of the example. If not specified, the agent's default language is used. Note: languages must be enabled in the agent before they can be used.
+  "name": "A String", # The unique identifier of the playbook example. Format: `projects//locations//agents//playbooks//examples/`.
+  "playbookInput": { # Input of the playbook. # Optional. The input to the playbook in the example.
+    "actionParameters": { # Optional. A list of input parameters for the action.
+      "a_key": "", # Properties of the object.
+    },
+    "precedingConversationSummary": "A String", # Optional. Summary string of the preceding conversation for the child playbook invocation.
+  },
+  "playbookOutput": { # Output of the playbook. # Optional. The output of the playbook in the example.
+    "actionParameters": { # Optional. A Struct object of output parameters for the action.
+      "a_key": "", # Properties of the object.
+    },
+    "executionSummary": "A String", # Optional. Summary string of the execution result of the child playbook.
+  },
+  "tokenCount": "A String", # Output only. Estimated number of tokes current example takes when sent to the LLM.
+  "updateTime": "A String", # Output only. Last time the example was updated.
+}
+
+  updateMask: string, Optional. The mask to control which fields get updated. If the mask is not present, all fields will be updated.
+  x__xgafv: string, V1 error format.
+    Allowed values
+      1 - v1 error format
+      2 - v2 error format
+
+Returns:
+  An object of the form:
+
+    { # Example represents a sample execution of the playbook in the conversation. An example consists of a list of ordered actions performed by end user or Dialogflow agent according the playbook instructions to fulfill the task.
+  "actions": [ # Required. The ordered list of actions performed by the end user and the Dialogflow agent.
+    { # Action performed by end user or Dialogflow agent in the conversation.
+      "agentUtterance": { # AgentUtterance represents one message sent by the agent. # Optional. Action performed by the agent as a message.
+        "text": "A String", # Required. Message content in text.
+      },
+      "flowInvocation": { # Stores metadata of the invocation of a CX flow. Next Id: 7 # Optional. Action performed on behalf of the agent by invoking a CX flow.
+        "flow": "A String", # Required. The unique identifier of the flow. Format: `projects//locations//agents/`.
+        "flowState": "A String", # Required. Flow invocation's output state.
+        "inputActionParameters": { # Optional. A list of input parameters for the flow.
+          "a_key": "", # Properties of the object.
+        },
+        "outputActionParameters": { # Optional. A list of output parameters generated by the flow invocation.
+          "a_key": "", # Properties of the object.
+        },
+      },
+      "playbookInvocation": { # Stores metadata of the invocation of a child playbook. Next Id: 5 # Optional. Action performed on behalf of the agent by invoking a child playbook.
+        "playbook": "A String", # Required. The unique identifier of the playbook. Format: `projects//locations//agents//playbooks/`.
+        "playbookInput": { # Input of the playbook. # Optional. Input of the child playbook invocation.
+          "actionParameters": { # Optional. A list of input parameters for the action.
+            "a_key": "", # Properties of the object.
+          },
+          "precedingConversationSummary": "A String", # Optional. Summary string of the preceding conversation for the child playbook invocation.
+        },
+        "playbookOutput": { # Output of the playbook. # Optional. Output of the child playbook invocation.
+          "actionParameters": { # Optional. A Struct object of output parameters for the action.
+            "a_key": "", # Properties of the object.
+          },
+          "executionSummary": "A String", # Optional. Summary string of the execution result of the child playbook.
+        },
+        "playbookState": "A String", # Required. Playbook invocation's output state.
+      },
+      "toolUse": { # Stores metadata of the invocation of an action supported by a tool. # Optional. Action performed on behalf of the agent by calling a plugin tool.
+        "action": "A String", # Optional. Name of the action to be called during the tool use.
+        "inputActionParameters": { # Optional. A list of input parameters for the action.
+          "a_key": "", # Properties of the object.
+        },
+        "outputActionParameters": { # Optional. A list of output parameters generated by the action.
+          "a_key": "", # Properties of the object.
+        },
+        "tool": "A String", # Required. The tool that should be used. Format: `projects//locations//agents//tools/`.
+      },
+      "userUtterance": { # UserUtterance represents one message sent by the customer. # Optional. Agent obtained a message from the customer.
+        "text": "A String", # Required. Message content in text.
+      },
+    },
+  ],
+  "conversationState": "A String", # Required. Example's output state.
+  "createTime": "A String", # Output only. The timestamp of initial example creation.
+  "description": "A String", # Optional. The high level concise description of the example. The max number of characters is 200.
+  "displayName": "A String", # Required. The display name of the example.
+  "languageCode": "A String", # Optional. The language code of the example. If not specified, the agent's default language is used. Note: languages must be enabled in the agent before they can be used.
+  "name": "A String", # The unique identifier of the playbook example. Format: `projects//locations//agents//playbooks//examples/`.
+  "playbookInput": { # Input of the playbook. # Optional. The input to the playbook in the example.
+    "actionParameters": { # Optional. A list of input parameters for the action.
+      "a_key": "", # Properties of the object.
+    },
+    "precedingConversationSummary": "A String", # Optional. Summary string of the preceding conversation for the child playbook invocation.
+  },
+  "playbookOutput": { # Output of the playbook. # Optional. The output of the playbook in the example.
+    "actionParameters": { # Optional. A Struct object of output parameters for the action.
+      "a_key": "", # Properties of the object.
+    },
+    "executionSummary": "A String", # Optional. Summary string of the execution result of the child playbook.
+  },
+  "tokenCount": "A String", # Output only. Estimated number of tokes current example takes when sent to the LLM.
+  "updateTime": "A String", # Output only. Last time the example was updated.
+}
+
+ + \ No newline at end of file diff --git a/docs/dyn/dialogflow_v3beta1.projects.locations.agents.playbooks.html b/docs/dyn/dialogflow_v3beta1.projects.locations.agents.playbooks.html new file mode 100644 index 00000000000..c0dbccb94bd --- /dev/null +++ b/docs/dyn/dialogflow_v3beta1.projects.locations.agents.playbooks.html @@ -0,0 +1,496 @@ + + + +

Dialogflow API . projects . locations . agents . playbooks

+

Instance Methods

+

+ examples() +

+

Returns the examples Resource.

+ +

+ versions() +

+

Returns the versions Resource.

+ +

+ close()

+

Close httplib2 connections.

+

+ create(parent, body=None, x__xgafv=None)

+

Creates a playbook in a specified agent.

+

+ delete(name, x__xgafv=None)

+

Deletes a specified playbook.

+

+ get(name, x__xgafv=None)

+

Retrieves the specified Playbook.

+

+ list(parent, pageSize=None, pageToken=None, x__xgafv=None)

+

Returns a list of playbooks in the specified agent.

+

+ list_next()

+

Retrieves the next page of results.

+

+ patch(name, body=None, updateMask=None, x__xgafv=None)

+

Updates the specified Playbook.

+

Method Details

+
+ close() +
Close httplib2 connections.
+
+ +
+ create(parent, body=None, x__xgafv=None) +
Creates a playbook in a specified agent.
+
+Args:
+  parent: string, Required. The agent to create a playbook for. Format: `projects//locations//agents/`. (required)
+  body: object, The request body.
+    The object takes the form of:
+
+{ # Playbook is the basic building block to instruct the LLM how to execute a certain task. A playbook consists of a goal to accomplish, an optional list of step by step instructions (the step instruction may refers to name of the custom or default plugin tools to use) to perform the task, a list of contextual input data to be passed in at the beginning of the invoked, and a list of output parameters to store the playbook result.
+  "createTime": "A String", # Output only. The timestamp of initial playbook creation.
+  "displayName": "A String", # Required. The human-readable name of the playbook, unique within an agent.
+  "goal": "A String", # Required. High level description of the goal the playbook intend to accomplish.
+  "inputParameterDefinitions": [ # Optional. Defined structured input parameters for this playbook.
+    { # Defines the properties of a parameter. Used to define parameters used in the agent and the input / output parameters for each fulfillment.
+      "description": "A String", # Human-readable description of the parameter. Limited to 300 characters.
+      "name": "A String", # Required. Name of parameter.
+      "type": "A String", # Required. Type of parameter.
+    },
+  ],
+  "instruction": { # Message of the Instruction of the playbook. # Instruction to accomplish target goal.
+    "steps": [ # Ordered list of step by step execution instructions to accomplish target goal.
+      { # Message of single step execution.
+        "steps": [ # Sub-processing needed to execute the current step.
+          # Object with schema name: GoogleCloudDialogflowCxV3beta1PlaybookStep
+        ],
+        "text": "A String", # Step instruction in text format.
+      },
+    ],
+  },
+  "llmModelSettings": { # Settings for LLM models. # Optional. Llm model settings for the playbook.
+    "model": "A String", # The selected LLM model.
+    "promptText": "A String", # The custom prompt to use.
+  },
+  "name": "A String", # The unique identifier of the playbook. Format: `projects//locations//agents//playbooks/`.
+  "outputParameterDefinitions": [ # Optional. Defined structured output parameters for this playbook.
+    { # Defines the properties of a parameter. Used to define parameters used in the agent and the input / output parameters for each fulfillment.
+      "description": "A String", # Human-readable description of the parameter. Limited to 300 characters.
+      "name": "A String", # Required. Name of parameter.
+      "type": "A String", # Required. Type of parameter.
+    },
+  ],
+  "referencedFlows": [ # Output only. The resource name of flows referenced by the current playbook in the instructions.
+    "A String",
+  ],
+  "referencedPlaybooks": [ # Output only. The resource name of other playbooks referenced by the current playbook in the instructions.
+    "A String",
+  ],
+  "referencedTools": [ # Optional. The resource name of tools referenced by the current playbook in the instructions. If not provided explicitly, they are will be implied using the tool being referenced in goal and steps.
+    "A String",
+  ],
+  "tokenCount": "A String", # Output only. Estimated number of tokes current playbook takes when sent to the LLM.
+  "updateTime": "A String", # Output only. Last time the playbook version was updated.
+}
+
+  x__xgafv: string, V1 error format.
+    Allowed values
+      1 - v1 error format
+      2 - v2 error format
+
+Returns:
+  An object of the form:
+
+    { # Playbook is the basic building block to instruct the LLM how to execute a certain task. A playbook consists of a goal to accomplish, an optional list of step by step instructions (the step instruction may refers to name of the custom or default plugin tools to use) to perform the task, a list of contextual input data to be passed in at the beginning of the invoked, and a list of output parameters to store the playbook result.
+  "createTime": "A String", # Output only. The timestamp of initial playbook creation.
+  "displayName": "A String", # Required. The human-readable name of the playbook, unique within an agent.
+  "goal": "A String", # Required. High level description of the goal the playbook intend to accomplish.
+  "inputParameterDefinitions": [ # Optional. Defined structured input parameters for this playbook.
+    { # Defines the properties of a parameter. Used to define parameters used in the agent and the input / output parameters for each fulfillment.
+      "description": "A String", # Human-readable description of the parameter. Limited to 300 characters.
+      "name": "A String", # Required. Name of parameter.
+      "type": "A String", # Required. Type of parameter.
+    },
+  ],
+  "instruction": { # Message of the Instruction of the playbook. # Instruction to accomplish target goal.
+    "steps": [ # Ordered list of step by step execution instructions to accomplish target goal.
+      { # Message of single step execution.
+        "steps": [ # Sub-processing needed to execute the current step.
+          # Object with schema name: GoogleCloudDialogflowCxV3beta1PlaybookStep
+        ],
+        "text": "A String", # Step instruction in text format.
+      },
+    ],
+  },
+  "llmModelSettings": { # Settings for LLM models. # Optional. Llm model settings for the playbook.
+    "model": "A String", # The selected LLM model.
+    "promptText": "A String", # The custom prompt to use.
+  },
+  "name": "A String", # The unique identifier of the playbook. Format: `projects//locations//agents//playbooks/`.
+  "outputParameterDefinitions": [ # Optional. Defined structured output parameters for this playbook.
+    { # Defines the properties of a parameter. Used to define parameters used in the agent and the input / output parameters for each fulfillment.
+      "description": "A String", # Human-readable description of the parameter. Limited to 300 characters.
+      "name": "A String", # Required. Name of parameter.
+      "type": "A String", # Required. Type of parameter.
+    },
+  ],
+  "referencedFlows": [ # Output only. The resource name of flows referenced by the current playbook in the instructions.
+    "A String",
+  ],
+  "referencedPlaybooks": [ # Output only. The resource name of other playbooks referenced by the current playbook in the instructions.
+    "A String",
+  ],
+  "referencedTools": [ # Optional. The resource name of tools referenced by the current playbook in the instructions. If not provided explicitly, they are will be implied using the tool being referenced in goal and steps.
+    "A String",
+  ],
+  "tokenCount": "A String", # Output only. Estimated number of tokes current playbook takes when sent to the LLM.
+  "updateTime": "A String", # Output only. Last time the playbook version was updated.
+}
+
+ +
+ delete(name, x__xgafv=None) +
Deletes a specified playbook.
+
+Args:
+  name: string, Required. The name of the playbook to delete. Format: `projects//locations//agents//playbooks/`. (required)
+  x__xgafv: string, V1 error format.
+    Allowed values
+      1 - v1 error format
+      2 - v2 error format
+
+Returns:
+  An object of the form:
+
+    { # A generic empty message that you can re-use to avoid defining duplicated empty messages in your APIs. A typical example is to use it as the request or the response type of an API method. For instance: service Foo { rpc Bar(google.protobuf.Empty) returns (google.protobuf.Empty); }
+}
+
+ +
+ get(name, x__xgafv=None) +
Retrieves the specified Playbook.
+
+Args:
+  name: string, Required. The name of the playbook. Format: `projects//locations//agents//playbooks/`. (required)
+  x__xgafv: string, V1 error format.
+    Allowed values
+      1 - v1 error format
+      2 - v2 error format
+
+Returns:
+  An object of the form:
+
+    { # Playbook is the basic building block to instruct the LLM how to execute a certain task. A playbook consists of a goal to accomplish, an optional list of step by step instructions (the step instruction may refers to name of the custom or default plugin tools to use) to perform the task, a list of contextual input data to be passed in at the beginning of the invoked, and a list of output parameters to store the playbook result.
+  "createTime": "A String", # Output only. The timestamp of initial playbook creation.
+  "displayName": "A String", # Required. The human-readable name of the playbook, unique within an agent.
+  "goal": "A String", # Required. High level description of the goal the playbook intend to accomplish.
+  "inputParameterDefinitions": [ # Optional. Defined structured input parameters for this playbook.
+    { # Defines the properties of a parameter. Used to define parameters used in the agent and the input / output parameters for each fulfillment.
+      "description": "A String", # Human-readable description of the parameter. Limited to 300 characters.
+      "name": "A String", # Required. Name of parameter.
+      "type": "A String", # Required. Type of parameter.
+    },
+  ],
+  "instruction": { # Message of the Instruction of the playbook. # Instruction to accomplish target goal.
+    "steps": [ # Ordered list of step by step execution instructions to accomplish target goal.
+      { # Message of single step execution.
+        "steps": [ # Sub-processing needed to execute the current step.
+          # Object with schema name: GoogleCloudDialogflowCxV3beta1PlaybookStep
+        ],
+        "text": "A String", # Step instruction in text format.
+      },
+    ],
+  },
+  "llmModelSettings": { # Settings for LLM models. # Optional. Llm model settings for the playbook.
+    "model": "A String", # The selected LLM model.
+    "promptText": "A String", # The custom prompt to use.
+  },
+  "name": "A String", # The unique identifier of the playbook. Format: `projects//locations//agents//playbooks/`.
+  "outputParameterDefinitions": [ # Optional. Defined structured output parameters for this playbook.
+    { # Defines the properties of a parameter. Used to define parameters used in the agent and the input / output parameters for each fulfillment.
+      "description": "A String", # Human-readable description of the parameter. Limited to 300 characters.
+      "name": "A String", # Required. Name of parameter.
+      "type": "A String", # Required. Type of parameter.
+    },
+  ],
+  "referencedFlows": [ # Output only. The resource name of flows referenced by the current playbook in the instructions.
+    "A String",
+  ],
+  "referencedPlaybooks": [ # Output only. The resource name of other playbooks referenced by the current playbook in the instructions.
+    "A String",
+  ],
+  "referencedTools": [ # Optional. The resource name of tools referenced by the current playbook in the instructions. If not provided explicitly, they are will be implied using the tool being referenced in goal and steps.
+    "A String",
+  ],
+  "tokenCount": "A String", # Output only. Estimated number of tokes current playbook takes when sent to the LLM.
+  "updateTime": "A String", # Output only. Last time the playbook version was updated.
+}
+
+ +
+ list(parent, pageSize=None, pageToken=None, x__xgafv=None) +
Returns a list of playbooks in the specified agent.
+
+Args:
+  parent: string, Required. The agent to list playbooks from. Format: `projects//locations//agents/`. (required)
+  pageSize: integer, The maximum number of items to return in a single page. By default 100 and at most 1000.
+  pageToken: string, The next_page_token value returned from a previous list request.
+  x__xgafv: string, V1 error format.
+    Allowed values
+      1 - v1 error format
+      2 - v2 error format
+
+Returns:
+  An object of the form:
+
+    { # The response message for Playbooks.ListPlaybooks.
+  "nextPageToken": "A String", # Token to retrieve the next page of results, or empty if there are no more results in the list.
+  "playbooks": [ # The list of playbooks. There will be a maximum number of items returned based on the page_size field in the request.
+    { # Playbook is the basic building block to instruct the LLM how to execute a certain task. A playbook consists of a goal to accomplish, an optional list of step by step instructions (the step instruction may refers to name of the custom or default plugin tools to use) to perform the task, a list of contextual input data to be passed in at the beginning of the invoked, and a list of output parameters to store the playbook result.
+      "createTime": "A String", # Output only. The timestamp of initial playbook creation.
+      "displayName": "A String", # Required. The human-readable name of the playbook, unique within an agent.
+      "goal": "A String", # Required. High level description of the goal the playbook intend to accomplish.
+      "inputParameterDefinitions": [ # Optional. Defined structured input parameters for this playbook.
+        { # Defines the properties of a parameter. Used to define parameters used in the agent and the input / output parameters for each fulfillment.
+          "description": "A String", # Human-readable description of the parameter. Limited to 300 characters.
+          "name": "A String", # Required. Name of parameter.
+          "type": "A String", # Required. Type of parameter.
+        },
+      ],
+      "instruction": { # Message of the Instruction of the playbook. # Instruction to accomplish target goal.
+        "steps": [ # Ordered list of step by step execution instructions to accomplish target goal.
+          { # Message of single step execution.
+            "steps": [ # Sub-processing needed to execute the current step.
+              # Object with schema name: GoogleCloudDialogflowCxV3beta1PlaybookStep
+            ],
+            "text": "A String", # Step instruction in text format.
+          },
+        ],
+      },
+      "llmModelSettings": { # Settings for LLM models. # Optional. Llm model settings for the playbook.
+        "model": "A String", # The selected LLM model.
+        "promptText": "A String", # The custom prompt to use.
+      },
+      "name": "A String", # The unique identifier of the playbook. Format: `projects//locations//agents//playbooks/`.
+      "outputParameterDefinitions": [ # Optional. Defined structured output parameters for this playbook.
+        { # Defines the properties of a parameter. Used to define parameters used in the agent and the input / output parameters for each fulfillment.
+          "description": "A String", # Human-readable description of the parameter. Limited to 300 characters.
+          "name": "A String", # Required. Name of parameter.
+          "type": "A String", # Required. Type of parameter.
+        },
+      ],
+      "referencedFlows": [ # Output only. The resource name of flows referenced by the current playbook in the instructions.
+        "A String",
+      ],
+      "referencedPlaybooks": [ # Output only. The resource name of other playbooks referenced by the current playbook in the instructions.
+        "A String",
+      ],
+      "referencedTools": [ # Optional. The resource name of tools referenced by the current playbook in the instructions. If not provided explicitly, they are will be implied using the tool being referenced in goal and steps.
+        "A String",
+      ],
+      "tokenCount": "A String", # Output only. Estimated number of tokes current playbook takes when sent to the LLM.
+      "updateTime": "A String", # Output only. Last time the playbook version was updated.
+    },
+  ],
+}
+
+ +
+ list_next() +
Retrieves the next page of results.
+
+        Args:
+          previous_request: The request for the previous page. (required)
+          previous_response: The response from the request for the previous page. (required)
+
+        Returns:
+          A request object that you can call 'execute()' on to request the next
+          page. Returns None if there are no more items in the collection.
+        
+
+ +
+ patch(name, body=None, updateMask=None, x__xgafv=None) +
Updates the specified Playbook.
+
+Args:
+  name: string, The unique identifier of the playbook. Format: `projects//locations//agents//playbooks/`. (required)
+  body: object, The request body.
+    The object takes the form of:
+
+{ # Playbook is the basic building block to instruct the LLM how to execute a certain task. A playbook consists of a goal to accomplish, an optional list of step by step instructions (the step instruction may refers to name of the custom or default plugin tools to use) to perform the task, a list of contextual input data to be passed in at the beginning of the invoked, and a list of output parameters to store the playbook result.
+  "createTime": "A String", # Output only. The timestamp of initial playbook creation.
+  "displayName": "A String", # Required. The human-readable name of the playbook, unique within an agent.
+  "goal": "A String", # Required. High level description of the goal the playbook intend to accomplish.
+  "inputParameterDefinitions": [ # Optional. Defined structured input parameters for this playbook.
+    { # Defines the properties of a parameter. Used to define parameters used in the agent and the input / output parameters for each fulfillment.
+      "description": "A String", # Human-readable description of the parameter. Limited to 300 characters.
+      "name": "A String", # Required. Name of parameter.
+      "type": "A String", # Required. Type of parameter.
+    },
+  ],
+  "instruction": { # Message of the Instruction of the playbook. # Instruction to accomplish target goal.
+    "steps": [ # Ordered list of step by step execution instructions to accomplish target goal.
+      { # Message of single step execution.
+        "steps": [ # Sub-processing needed to execute the current step.
+          # Object with schema name: GoogleCloudDialogflowCxV3beta1PlaybookStep
+        ],
+        "text": "A String", # Step instruction in text format.
+      },
+    ],
+  },
+  "llmModelSettings": { # Settings for LLM models. # Optional. Llm model settings for the playbook.
+    "model": "A String", # The selected LLM model.
+    "promptText": "A String", # The custom prompt to use.
+  },
+  "name": "A String", # The unique identifier of the playbook. Format: `projects//locations//agents//playbooks/`.
+  "outputParameterDefinitions": [ # Optional. Defined structured output parameters for this playbook.
+    { # Defines the properties of a parameter. Used to define parameters used in the agent and the input / output parameters for each fulfillment.
+      "description": "A String", # Human-readable description of the parameter. Limited to 300 characters.
+      "name": "A String", # Required. Name of parameter.
+      "type": "A String", # Required. Type of parameter.
+    },
+  ],
+  "referencedFlows": [ # Output only. The resource name of flows referenced by the current playbook in the instructions.
+    "A String",
+  ],
+  "referencedPlaybooks": [ # Output only. The resource name of other playbooks referenced by the current playbook in the instructions.
+    "A String",
+  ],
+  "referencedTools": [ # Optional. The resource name of tools referenced by the current playbook in the instructions. If not provided explicitly, they are will be implied using the tool being referenced in goal and steps.
+    "A String",
+  ],
+  "tokenCount": "A String", # Output only. Estimated number of tokes current playbook takes when sent to the LLM.
+  "updateTime": "A String", # Output only. Last time the playbook version was updated.
+}
+
+  updateMask: string, The mask to control which fields get updated. If the mask is not present, all fields will be updated.
+  x__xgafv: string, V1 error format.
+    Allowed values
+      1 - v1 error format
+      2 - v2 error format
+
+Returns:
+  An object of the form:
+
+    { # Playbook is the basic building block to instruct the LLM how to execute a certain task. A playbook consists of a goal to accomplish, an optional list of step by step instructions (the step instruction may refers to name of the custom or default plugin tools to use) to perform the task, a list of contextual input data to be passed in at the beginning of the invoked, and a list of output parameters to store the playbook result.
+  "createTime": "A String", # Output only. The timestamp of initial playbook creation.
+  "displayName": "A String", # Required. The human-readable name of the playbook, unique within an agent.
+  "goal": "A String", # Required. High level description of the goal the playbook intend to accomplish.
+  "inputParameterDefinitions": [ # Optional. Defined structured input parameters for this playbook.
+    { # Defines the properties of a parameter. Used to define parameters used in the agent and the input / output parameters for each fulfillment.
+      "description": "A String", # Human-readable description of the parameter. Limited to 300 characters.
+      "name": "A String", # Required. Name of parameter.
+      "type": "A String", # Required. Type of parameter.
+    },
+  ],
+  "instruction": { # Message of the Instruction of the playbook. # Instruction to accomplish target goal.
+    "steps": [ # Ordered list of step by step execution instructions to accomplish target goal.
+      { # Message of single step execution.
+        "steps": [ # Sub-processing needed to execute the current step.
+          # Object with schema name: GoogleCloudDialogflowCxV3beta1PlaybookStep
+        ],
+        "text": "A String", # Step instruction in text format.
+      },
+    ],
+  },
+  "llmModelSettings": { # Settings for LLM models. # Optional. Llm model settings for the playbook.
+    "model": "A String", # The selected LLM model.
+    "promptText": "A String", # The custom prompt to use.
+  },
+  "name": "A String", # The unique identifier of the playbook. Format: `projects//locations//agents//playbooks/`.
+  "outputParameterDefinitions": [ # Optional. Defined structured output parameters for this playbook.
+    { # Defines the properties of a parameter. Used to define parameters used in the agent and the input / output parameters for each fulfillment.
+      "description": "A String", # Human-readable description of the parameter. Limited to 300 characters.
+      "name": "A String", # Required. Name of parameter.
+      "type": "A String", # Required. Type of parameter.
+    },
+  ],
+  "referencedFlows": [ # Output only. The resource name of flows referenced by the current playbook in the instructions.
+    "A String",
+  ],
+  "referencedPlaybooks": [ # Output only. The resource name of other playbooks referenced by the current playbook in the instructions.
+    "A String",
+  ],
+  "referencedTools": [ # Optional. The resource name of tools referenced by the current playbook in the instructions. If not provided explicitly, they are will be implied using the tool being referenced in goal and steps.
+    "A String",
+  ],
+  "tokenCount": "A String", # Output only. Estimated number of tokes current playbook takes when sent to the LLM.
+  "updateTime": "A String", # Output only. Last time the playbook version was updated.
+}
+
+ + \ No newline at end of file diff --git a/docs/dyn/dialogflow_v3beta1.projects.locations.agents.playbooks.versions.html b/docs/dyn/dialogflow_v3beta1.projects.locations.agents.playbooks.versions.html new file mode 100644 index 00000000000..2683182d28c --- /dev/null +++ b/docs/dyn/dialogflow_v3beta1.projects.locations.agents.playbooks.versions.html @@ -0,0 +1,672 @@ + + + +

Dialogflow API . projects . locations . agents . playbooks . versions

+

Instance Methods

+

+ close()

+

Close httplib2 connections.

+

+ create(parent, body=None, x__xgafv=None)

+

Creates a version for the specified Playbook.

+

+ delete(name, x__xgafv=None)

+

Deletes the specified version of the Playbook.

+

+ get(name, x__xgafv=None)

+

Retrieves the specified version of the Playbook.

+

+ list(parent, pageSize=None, pageToken=None, x__xgafv=None)

+

Lists versions for the specified Playbook.

+

+ list_next()

+

Retrieves the next page of results.

+

Method Details

+
+ close() +
Close httplib2 connections.
+
+ +
+ create(parent, body=None, x__xgafv=None) +
Creates a version for the specified Playbook.
+
+Args:
+  parent: string, Required. The playbook to create a version for. Format: `projects//locations//agents//playbooks/`. (required)
+  body: object, The request body.
+    The object takes the form of:
+
+{ # Playbook version is a snapshot of the playbook at certain timestamp.
+  "description": "A String", # Optional. The description of the playbook version.
+  "examples": [ # Output only. Snapshot of the examples belonging to the playbook when the playbook version is created.
+    { # Example represents a sample execution of the playbook in the conversation. An example consists of a list of ordered actions performed by end user or Dialogflow agent according the playbook instructions to fulfill the task.
+      "actions": [ # Required. The ordered list of actions performed by the end user and the Dialogflow agent.
+        { # Action performed by end user or Dialogflow agent in the conversation.
+          "agentUtterance": { # AgentUtterance represents one message sent by the agent. # Optional. Action performed by the agent as a message.
+            "text": "A String", # Required. Message content in text.
+          },
+          "flowInvocation": { # Stores metadata of the invocation of a CX flow. Next Id: 7 # Optional. Action performed on behalf of the agent by invoking a CX flow.
+            "flow": "A String", # Required. The unique identifier of the flow. Format: `projects//locations//agents/`.
+            "flowState": "A String", # Required. Flow invocation's output state.
+            "inputActionParameters": { # Optional. A list of input parameters for the flow.
+              "a_key": "", # Properties of the object.
+            },
+            "outputActionParameters": { # Optional. A list of output parameters generated by the flow invocation.
+              "a_key": "", # Properties of the object.
+            },
+          },
+          "playbookInvocation": { # Stores metadata of the invocation of a child playbook. Next Id: 5 # Optional. Action performed on behalf of the agent by invoking a child playbook.
+            "playbook": "A String", # Required. The unique identifier of the playbook. Format: `projects//locations//agents//playbooks/`.
+            "playbookInput": { # Input of the playbook. # Optional. Input of the child playbook invocation.
+              "actionParameters": { # Optional. A list of input parameters for the action.
+                "a_key": "", # Properties of the object.
+              },
+              "precedingConversationSummary": "A String", # Optional. Summary string of the preceding conversation for the child playbook invocation.
+            },
+            "playbookOutput": { # Output of the playbook. # Optional. Output of the child playbook invocation.
+              "actionParameters": { # Optional. A Struct object of output parameters for the action.
+                "a_key": "", # Properties of the object.
+              },
+              "executionSummary": "A String", # Optional. Summary string of the execution result of the child playbook.
+            },
+            "playbookState": "A String", # Required. Playbook invocation's output state.
+          },
+          "toolUse": { # Stores metadata of the invocation of an action supported by a tool. # Optional. Action performed on behalf of the agent by calling a plugin tool.
+            "action": "A String", # Optional. Name of the action to be called during the tool use.
+            "inputActionParameters": { # Optional. A list of input parameters for the action.
+              "a_key": "", # Properties of the object.
+            },
+            "outputActionParameters": { # Optional. A list of output parameters generated by the action.
+              "a_key": "", # Properties of the object.
+            },
+            "tool": "A String", # Required. The tool that should be used. Format: `projects//locations//agents//tools/`.
+          },
+          "userUtterance": { # UserUtterance represents one message sent by the customer. # Optional. Agent obtained a message from the customer.
+            "text": "A String", # Required. Message content in text.
+          },
+        },
+      ],
+      "conversationState": "A String", # Required. Example's output state.
+      "createTime": "A String", # Output only. The timestamp of initial example creation.
+      "description": "A String", # Optional. The high level concise description of the example. The max number of characters is 200.
+      "displayName": "A String", # Required. The display name of the example.
+      "languageCode": "A String", # Optional. The language code of the example. If not specified, the agent's default language is used. Note: languages must be enabled in the agent before they can be used.
+      "name": "A String", # The unique identifier of the playbook example. Format: `projects//locations//agents//playbooks//examples/`.
+      "playbookInput": { # Input of the playbook. # Optional. The input to the playbook in the example.
+        "actionParameters": { # Optional. A list of input parameters for the action.
+          "a_key": "", # Properties of the object.
+        },
+        "precedingConversationSummary": "A String", # Optional. Summary string of the preceding conversation for the child playbook invocation.
+      },
+      "playbookOutput": { # Output of the playbook. # Optional. The output of the playbook in the example.
+        "actionParameters": { # Optional. A Struct object of output parameters for the action.
+          "a_key": "", # Properties of the object.
+        },
+        "executionSummary": "A String", # Optional. Summary string of the execution result of the child playbook.
+      },
+      "tokenCount": "A String", # Output only. Estimated number of tokes current example takes when sent to the LLM.
+      "updateTime": "A String", # Output only. Last time the example was updated.
+    },
+  ],
+  "name": "A String", # The unique identifier of the playbook version. Format: `projects//locations//agents//playbooks//versions/`.
+  "playbook": { # Playbook is the basic building block to instruct the LLM how to execute a certain task. A playbook consists of a goal to accomplish, an optional list of step by step instructions (the step instruction may refers to name of the custom or default plugin tools to use) to perform the task, a list of contextual input data to be passed in at the beginning of the invoked, and a list of output parameters to store the playbook result. # Output only. Snapshot of the playbook when the playbook version is created.
+    "createTime": "A String", # Output only. The timestamp of initial playbook creation.
+    "displayName": "A String", # Required. The human-readable name of the playbook, unique within an agent.
+    "goal": "A String", # Required. High level description of the goal the playbook intend to accomplish.
+    "inputParameterDefinitions": [ # Optional. Defined structured input parameters for this playbook.
+      { # Defines the properties of a parameter. Used to define parameters used in the agent and the input / output parameters for each fulfillment.
+        "description": "A String", # Human-readable description of the parameter. Limited to 300 characters.
+        "name": "A String", # Required. Name of parameter.
+        "type": "A String", # Required. Type of parameter.
+      },
+    ],
+    "instruction": { # Message of the Instruction of the playbook. # Instruction to accomplish target goal.
+      "steps": [ # Ordered list of step by step execution instructions to accomplish target goal.
+        { # Message of single step execution.
+          "steps": [ # Sub-processing needed to execute the current step.
+            # Object with schema name: GoogleCloudDialogflowCxV3beta1PlaybookStep
+          ],
+          "text": "A String", # Step instruction in text format.
+        },
+      ],
+    },
+    "llmModelSettings": { # Settings for LLM models. # Optional. Llm model settings for the playbook.
+      "model": "A String", # The selected LLM model.
+      "promptText": "A String", # The custom prompt to use.
+    },
+    "name": "A String", # The unique identifier of the playbook. Format: `projects//locations//agents//playbooks/`.
+    "outputParameterDefinitions": [ # Optional. Defined structured output parameters for this playbook.
+      { # Defines the properties of a parameter. Used to define parameters used in the agent and the input / output parameters for each fulfillment.
+        "description": "A String", # Human-readable description of the parameter. Limited to 300 characters.
+        "name": "A String", # Required. Name of parameter.
+        "type": "A String", # Required. Type of parameter.
+      },
+    ],
+    "referencedFlows": [ # Output only. The resource name of flows referenced by the current playbook in the instructions.
+      "A String",
+    ],
+    "referencedPlaybooks": [ # Output only. The resource name of other playbooks referenced by the current playbook in the instructions.
+      "A String",
+    ],
+    "referencedTools": [ # Optional. The resource name of tools referenced by the current playbook in the instructions. If not provided explicitly, they are will be implied using the tool being referenced in goal and steps.
+      "A String",
+    ],
+    "tokenCount": "A String", # Output only. Estimated number of tokes current playbook takes when sent to the LLM.
+    "updateTime": "A String", # Output only. Last time the playbook version was updated.
+  },
+  "updateTime": "A String", # Output only. Last time the playbook version was created or modified.
+}
+
+  x__xgafv: string, V1 error format.
+    Allowed values
+      1 - v1 error format
+      2 - v2 error format
+
+Returns:
+  An object of the form:
+
+    { # Playbook version is a snapshot of the playbook at certain timestamp.
+  "description": "A String", # Optional. The description of the playbook version.
+  "examples": [ # Output only. Snapshot of the examples belonging to the playbook when the playbook version is created.
+    { # Example represents a sample execution of the playbook in the conversation. An example consists of a list of ordered actions performed by end user or Dialogflow agent according the playbook instructions to fulfill the task.
+      "actions": [ # Required. The ordered list of actions performed by the end user and the Dialogflow agent.
+        { # Action performed by end user or Dialogflow agent in the conversation.
+          "agentUtterance": { # AgentUtterance represents one message sent by the agent. # Optional. Action performed by the agent as a message.
+            "text": "A String", # Required. Message content in text.
+          },
+          "flowInvocation": { # Stores metadata of the invocation of a CX flow. Next Id: 7 # Optional. Action performed on behalf of the agent by invoking a CX flow.
+            "flow": "A String", # Required. The unique identifier of the flow. Format: `projects//locations//agents/`.
+            "flowState": "A String", # Required. Flow invocation's output state.
+            "inputActionParameters": { # Optional. A list of input parameters for the flow.
+              "a_key": "", # Properties of the object.
+            },
+            "outputActionParameters": { # Optional. A list of output parameters generated by the flow invocation.
+              "a_key": "", # Properties of the object.
+            },
+          },
+          "playbookInvocation": { # Stores metadata of the invocation of a child playbook. Next Id: 5 # Optional. Action performed on behalf of the agent by invoking a child playbook.
+            "playbook": "A String", # Required. The unique identifier of the playbook. Format: `projects//locations//agents//playbooks/`.
+            "playbookInput": { # Input of the playbook. # Optional. Input of the child playbook invocation.
+              "actionParameters": { # Optional. A list of input parameters for the action.
+                "a_key": "", # Properties of the object.
+              },
+              "precedingConversationSummary": "A String", # Optional. Summary string of the preceding conversation for the child playbook invocation.
+            },
+            "playbookOutput": { # Output of the playbook. # Optional. Output of the child playbook invocation.
+              "actionParameters": { # Optional. A Struct object of output parameters for the action.
+                "a_key": "", # Properties of the object.
+              },
+              "executionSummary": "A String", # Optional. Summary string of the execution result of the child playbook.
+            },
+            "playbookState": "A String", # Required. Playbook invocation's output state.
+          },
+          "toolUse": { # Stores metadata of the invocation of an action supported by a tool. # Optional. Action performed on behalf of the agent by calling a plugin tool.
+            "action": "A String", # Optional. Name of the action to be called during the tool use.
+            "inputActionParameters": { # Optional. A list of input parameters for the action.
+              "a_key": "", # Properties of the object.
+            },
+            "outputActionParameters": { # Optional. A list of output parameters generated by the action.
+              "a_key": "", # Properties of the object.
+            },
+            "tool": "A String", # Required. The tool that should be used. Format: `projects//locations//agents//tools/`.
+          },
+          "userUtterance": { # UserUtterance represents one message sent by the customer. # Optional. Agent obtained a message from the customer.
+            "text": "A String", # Required. Message content in text.
+          },
+        },
+      ],
+      "conversationState": "A String", # Required. Example's output state.
+      "createTime": "A String", # Output only. The timestamp of initial example creation.
+      "description": "A String", # Optional. The high level concise description of the example. The max number of characters is 200.
+      "displayName": "A String", # Required. The display name of the example.
+      "languageCode": "A String", # Optional. The language code of the example. If not specified, the agent's default language is used. Note: languages must be enabled in the agent before they can be used.
+      "name": "A String", # The unique identifier of the playbook example. Format: `projects//locations//agents//playbooks//examples/`.
+      "playbookInput": { # Input of the playbook. # Optional. The input to the playbook in the example.
+        "actionParameters": { # Optional. A list of input parameters for the action.
+          "a_key": "", # Properties of the object.
+        },
+        "precedingConversationSummary": "A String", # Optional. Summary string of the preceding conversation for the child playbook invocation.
+      },
+      "playbookOutput": { # Output of the playbook. # Optional. The output of the playbook in the example.
+        "actionParameters": { # Optional. A Struct object of output parameters for the action.
+          "a_key": "", # Properties of the object.
+        },
+        "executionSummary": "A String", # Optional. Summary string of the execution result of the child playbook.
+      },
+      "tokenCount": "A String", # Output only. Estimated number of tokes current example takes when sent to the LLM.
+      "updateTime": "A String", # Output only. Last time the example was updated.
+    },
+  ],
+  "name": "A String", # The unique identifier of the playbook version. Format: `projects//locations//agents//playbooks//versions/`.
+  "playbook": { # Playbook is the basic building block to instruct the LLM how to execute a certain task. A playbook consists of a goal to accomplish, an optional list of step by step instructions (the step instruction may refers to name of the custom or default plugin tools to use) to perform the task, a list of contextual input data to be passed in at the beginning of the invoked, and a list of output parameters to store the playbook result. # Output only. Snapshot of the playbook when the playbook version is created.
+    "createTime": "A String", # Output only. The timestamp of initial playbook creation.
+    "displayName": "A String", # Required. The human-readable name of the playbook, unique within an agent.
+    "goal": "A String", # Required. High level description of the goal the playbook intend to accomplish.
+    "inputParameterDefinitions": [ # Optional. Defined structured input parameters for this playbook.
+      { # Defines the properties of a parameter. Used to define parameters used in the agent and the input / output parameters for each fulfillment.
+        "description": "A String", # Human-readable description of the parameter. Limited to 300 characters.
+        "name": "A String", # Required. Name of parameter.
+        "type": "A String", # Required. Type of parameter.
+      },
+    ],
+    "instruction": { # Message of the Instruction of the playbook. # Instruction to accomplish target goal.
+      "steps": [ # Ordered list of step by step execution instructions to accomplish target goal.
+        { # Message of single step execution.
+          "steps": [ # Sub-processing needed to execute the current step.
+            # Object with schema name: GoogleCloudDialogflowCxV3beta1PlaybookStep
+          ],
+          "text": "A String", # Step instruction in text format.
+        },
+      ],
+    },
+    "llmModelSettings": { # Settings for LLM models. # Optional. Llm model settings for the playbook.
+      "model": "A String", # The selected LLM model.
+      "promptText": "A String", # The custom prompt to use.
+    },
+    "name": "A String", # The unique identifier of the playbook. Format: `projects//locations//agents//playbooks/`.
+    "outputParameterDefinitions": [ # Optional. Defined structured output parameters for this playbook.
+      { # Defines the properties of a parameter. Used to define parameters used in the agent and the input / output parameters for each fulfillment.
+        "description": "A String", # Human-readable description of the parameter. Limited to 300 characters.
+        "name": "A String", # Required. Name of parameter.
+        "type": "A String", # Required. Type of parameter.
+      },
+    ],
+    "referencedFlows": [ # Output only. The resource name of flows referenced by the current playbook in the instructions.
+      "A String",
+    ],
+    "referencedPlaybooks": [ # Output only. The resource name of other playbooks referenced by the current playbook in the instructions.
+      "A String",
+    ],
+    "referencedTools": [ # Optional. The resource name of tools referenced by the current playbook in the instructions. If not provided explicitly, they are will be implied using the tool being referenced in goal and steps.
+      "A String",
+    ],
+    "tokenCount": "A String", # Output only. Estimated number of tokes current playbook takes when sent to the LLM.
+    "updateTime": "A String", # Output only. Last time the playbook version was updated.
+  },
+  "updateTime": "A String", # Output only. Last time the playbook version was created or modified.
+}
+
+ +
+ delete(name, x__xgafv=None) +
Deletes the specified version of the Playbook.
+
+Args:
+  name: string, Required. The name of the playbook version to delete. Format: `projects//locations//agents//playbooks//versions/`. (required)
+  x__xgafv: string, V1 error format.
+    Allowed values
+      1 - v1 error format
+      2 - v2 error format
+
+Returns:
+  An object of the form:
+
+    { # A generic empty message that you can re-use to avoid defining duplicated empty messages in your APIs. A typical example is to use it as the request or the response type of an API method. For instance: service Foo { rpc Bar(google.protobuf.Empty) returns (google.protobuf.Empty); }
+}
+
+ +
+ get(name, x__xgafv=None) +
Retrieves the specified version of the Playbook.
+
+Args:
+  name: string, Required. The name of the playbook version. Format: `projects//locations//agents//playbooks//versions/`. (required)
+  x__xgafv: string, V1 error format.
+    Allowed values
+      1 - v1 error format
+      2 - v2 error format
+
+Returns:
+  An object of the form:
+
+    { # Playbook version is a snapshot of the playbook at certain timestamp.
+  "description": "A String", # Optional. The description of the playbook version.
+  "examples": [ # Output only. Snapshot of the examples belonging to the playbook when the playbook version is created.
+    { # Example represents a sample execution of the playbook in the conversation. An example consists of a list of ordered actions performed by end user or Dialogflow agent according the playbook instructions to fulfill the task.
+      "actions": [ # Required. The ordered list of actions performed by the end user and the Dialogflow agent.
+        { # Action performed by end user or Dialogflow agent in the conversation.
+          "agentUtterance": { # AgentUtterance represents one message sent by the agent. # Optional. Action performed by the agent as a message.
+            "text": "A String", # Required. Message content in text.
+          },
+          "flowInvocation": { # Stores metadata of the invocation of a CX flow. Next Id: 7 # Optional. Action performed on behalf of the agent by invoking a CX flow.
+            "flow": "A String", # Required. The unique identifier of the flow. Format: `projects//locations//agents/`.
+            "flowState": "A String", # Required. Flow invocation's output state.
+            "inputActionParameters": { # Optional. A list of input parameters for the flow.
+              "a_key": "", # Properties of the object.
+            },
+            "outputActionParameters": { # Optional. A list of output parameters generated by the flow invocation.
+              "a_key": "", # Properties of the object.
+            },
+          },
+          "playbookInvocation": { # Stores metadata of the invocation of a child playbook. Next Id: 5 # Optional. Action performed on behalf of the agent by invoking a child playbook.
+            "playbook": "A String", # Required. The unique identifier of the playbook. Format: `projects//locations//agents//playbooks/`.
+            "playbookInput": { # Input of the playbook. # Optional. Input of the child playbook invocation.
+              "actionParameters": { # Optional. A list of input parameters for the action.
+                "a_key": "", # Properties of the object.
+              },
+              "precedingConversationSummary": "A String", # Optional. Summary string of the preceding conversation for the child playbook invocation.
+            },
+            "playbookOutput": { # Output of the playbook. # Optional. Output of the child playbook invocation.
+              "actionParameters": { # Optional. A Struct object of output parameters for the action.
+                "a_key": "", # Properties of the object.
+              },
+              "executionSummary": "A String", # Optional. Summary string of the execution result of the child playbook.
+            },
+            "playbookState": "A String", # Required. Playbook invocation's output state.
+          },
+          "toolUse": { # Stores metadata of the invocation of an action supported by a tool. # Optional. Action performed on behalf of the agent by calling a plugin tool.
+            "action": "A String", # Optional. Name of the action to be called during the tool use.
+            "inputActionParameters": { # Optional. A list of input parameters for the action.
+              "a_key": "", # Properties of the object.
+            },
+            "outputActionParameters": { # Optional. A list of output parameters generated by the action.
+              "a_key": "", # Properties of the object.
+            },
+            "tool": "A String", # Required. The tool that should be used. Format: `projects//locations//agents//tools/`.
+          },
+          "userUtterance": { # UserUtterance represents one message sent by the customer. # Optional. Agent obtained a message from the customer.
+            "text": "A String", # Required. Message content in text.
+          },
+        },
+      ],
+      "conversationState": "A String", # Required. Example's output state.
+      "createTime": "A String", # Output only. The timestamp of initial example creation.
+      "description": "A String", # Optional. The high level concise description of the example. The max number of characters is 200.
+      "displayName": "A String", # Required. The display name of the example.
+      "languageCode": "A String", # Optional. The language code of the example. If not specified, the agent's default language is used. Note: languages must be enabled in the agent before they can be used.
+      "name": "A String", # The unique identifier of the playbook example. Format: `projects//locations//agents//playbooks//examples/`.
+      "playbookInput": { # Input of the playbook. # Optional. The input to the playbook in the example.
+        "actionParameters": { # Optional. A list of input parameters for the action.
+          "a_key": "", # Properties of the object.
+        },
+        "precedingConversationSummary": "A String", # Optional. Summary string of the preceding conversation for the child playbook invocation.
+      },
+      "playbookOutput": { # Output of the playbook. # Optional. The output of the playbook in the example.
+        "actionParameters": { # Optional. A Struct object of output parameters for the action.
+          "a_key": "", # Properties of the object.
+        },
+        "executionSummary": "A String", # Optional. Summary string of the execution result of the child playbook.
+      },
+      "tokenCount": "A String", # Output only. Estimated number of tokes current example takes when sent to the LLM.
+      "updateTime": "A String", # Output only. Last time the example was updated.
+    },
+  ],
+  "name": "A String", # The unique identifier of the playbook version. Format: `projects//locations//agents//playbooks//versions/`.
+  "playbook": { # Playbook is the basic building block to instruct the LLM how to execute a certain task. A playbook consists of a goal to accomplish, an optional list of step by step instructions (the step instruction may refers to name of the custom or default plugin tools to use) to perform the task, a list of contextual input data to be passed in at the beginning of the invoked, and a list of output parameters to store the playbook result. # Output only. Snapshot of the playbook when the playbook version is created.
+    "createTime": "A String", # Output only. The timestamp of initial playbook creation.
+    "displayName": "A String", # Required. The human-readable name of the playbook, unique within an agent.
+    "goal": "A String", # Required. High level description of the goal the playbook intend to accomplish.
+    "inputParameterDefinitions": [ # Optional. Defined structured input parameters for this playbook.
+      { # Defines the properties of a parameter. Used to define parameters used in the agent and the input / output parameters for each fulfillment.
+        "description": "A String", # Human-readable description of the parameter. Limited to 300 characters.
+        "name": "A String", # Required. Name of parameter.
+        "type": "A String", # Required. Type of parameter.
+      },
+    ],
+    "instruction": { # Message of the Instruction of the playbook. # Instruction to accomplish target goal.
+      "steps": [ # Ordered list of step by step execution instructions to accomplish target goal.
+        { # Message of single step execution.
+          "steps": [ # Sub-processing needed to execute the current step.
+            # Object with schema name: GoogleCloudDialogflowCxV3beta1PlaybookStep
+          ],
+          "text": "A String", # Step instruction in text format.
+        },
+      ],
+    },
+    "llmModelSettings": { # Settings for LLM models. # Optional. Llm model settings for the playbook.
+      "model": "A String", # The selected LLM model.
+      "promptText": "A String", # The custom prompt to use.
+    },
+    "name": "A String", # The unique identifier of the playbook. Format: `projects//locations//agents//playbooks/`.
+    "outputParameterDefinitions": [ # Optional. Defined structured output parameters for this playbook.
+      { # Defines the properties of a parameter. Used to define parameters used in the agent and the input / output parameters for each fulfillment.
+        "description": "A String", # Human-readable description of the parameter. Limited to 300 characters.
+        "name": "A String", # Required. Name of parameter.
+        "type": "A String", # Required. Type of parameter.
+      },
+    ],
+    "referencedFlows": [ # Output only. The resource name of flows referenced by the current playbook in the instructions.
+      "A String",
+    ],
+    "referencedPlaybooks": [ # Output only. The resource name of other playbooks referenced by the current playbook in the instructions.
+      "A String",
+    ],
+    "referencedTools": [ # Optional. The resource name of tools referenced by the current playbook in the instructions. If not provided explicitly, they are will be implied using the tool being referenced in goal and steps.
+      "A String",
+    ],
+    "tokenCount": "A String", # Output only. Estimated number of tokes current playbook takes when sent to the LLM.
+    "updateTime": "A String", # Output only. Last time the playbook version was updated.
+  },
+  "updateTime": "A String", # Output only. Last time the playbook version was created or modified.
+}
+
+ +
+ list(parent, pageSize=None, pageToken=None, x__xgafv=None) +
Lists versions for the specified Playbook.
+
+Args:
+  parent: string, Required. The playbook to list versions for. Format: `projects//locations//agents//playbooks/`. (required)
+  pageSize: integer, Optional. The maximum number of items to return in a single page. By default 100 and at most 1000.
+  pageToken: string, Optional. The next_page_token value returned from a previous list request.
+  x__xgafv: string, V1 error format.
+    Allowed values
+      1 - v1 error format
+      2 - v2 error format
+
+Returns:
+  An object of the form:
+
+    { # The response message for Playbooks.ListPlaybookVersions.
+  "nextPageToken": "A String", # Token to retrieve the next page of results, or empty if there are no more results in the list.
+  "playbookVersions": [ # The list of playbook version. There will be a maximum number of items returned based on the page_size field in the request.
+    { # Playbook version is a snapshot of the playbook at certain timestamp.
+      "description": "A String", # Optional. The description of the playbook version.
+      "examples": [ # Output only. Snapshot of the examples belonging to the playbook when the playbook version is created.
+        { # Example represents a sample execution of the playbook in the conversation. An example consists of a list of ordered actions performed by end user or Dialogflow agent according the playbook instructions to fulfill the task.
+          "actions": [ # Required. The ordered list of actions performed by the end user and the Dialogflow agent.
+            { # Action performed by end user or Dialogflow agent in the conversation.
+              "agentUtterance": { # AgentUtterance represents one message sent by the agent. # Optional. Action performed by the agent as a message.
+                "text": "A String", # Required. Message content in text.
+              },
+              "flowInvocation": { # Stores metadata of the invocation of a CX flow. Next Id: 7 # Optional. Action performed on behalf of the agent by invoking a CX flow.
+                "flow": "A String", # Required. The unique identifier of the flow. Format: `projects//locations//agents/`.
+                "flowState": "A String", # Required. Flow invocation's output state.
+                "inputActionParameters": { # Optional. A list of input parameters for the flow.
+                  "a_key": "", # Properties of the object.
+                },
+                "outputActionParameters": { # Optional. A list of output parameters generated by the flow invocation.
+                  "a_key": "", # Properties of the object.
+                },
+              },
+              "playbookInvocation": { # Stores metadata of the invocation of a child playbook. Next Id: 5 # Optional. Action performed on behalf of the agent by invoking a child playbook.
+                "playbook": "A String", # Required. The unique identifier of the playbook. Format: `projects//locations//agents//playbooks/`.
+                "playbookInput": { # Input of the playbook. # Optional. Input of the child playbook invocation.
+                  "actionParameters": { # Optional. A list of input parameters for the action.
+                    "a_key": "", # Properties of the object.
+                  },
+                  "precedingConversationSummary": "A String", # Optional. Summary string of the preceding conversation for the child playbook invocation.
+                },
+                "playbookOutput": { # Output of the playbook. # Optional. Output of the child playbook invocation.
+                  "actionParameters": { # Optional. A Struct object of output parameters for the action.
+                    "a_key": "", # Properties of the object.
+                  },
+                  "executionSummary": "A String", # Optional. Summary string of the execution result of the child playbook.
+                },
+                "playbookState": "A String", # Required. Playbook invocation's output state.
+              },
+              "toolUse": { # Stores metadata of the invocation of an action supported by a tool. # Optional. Action performed on behalf of the agent by calling a plugin tool.
+                "action": "A String", # Optional. Name of the action to be called during the tool use.
+                "inputActionParameters": { # Optional. A list of input parameters for the action.
+                  "a_key": "", # Properties of the object.
+                },
+                "outputActionParameters": { # Optional. A list of output parameters generated by the action.
+                  "a_key": "", # Properties of the object.
+                },
+                "tool": "A String", # Required. The tool that should be used. Format: `projects//locations//agents//tools/`.
+              },
+              "userUtterance": { # UserUtterance represents one message sent by the customer. # Optional. Agent obtained a message from the customer.
+                "text": "A String", # Required. Message content in text.
+              },
+            },
+          ],
+          "conversationState": "A String", # Required. Example's output state.
+          "createTime": "A String", # Output only. The timestamp of initial example creation.
+          "description": "A String", # Optional. The high level concise description of the example. The max number of characters is 200.
+          "displayName": "A String", # Required. The display name of the example.
+          "languageCode": "A String", # Optional. The language code of the example. If not specified, the agent's default language is used. Note: languages must be enabled in the agent before they can be used.
+          "name": "A String", # The unique identifier of the playbook example. Format: `projects//locations//agents//playbooks//examples/`.
+          "playbookInput": { # Input of the playbook. # Optional. The input to the playbook in the example.
+            "actionParameters": { # Optional. A list of input parameters for the action.
+              "a_key": "", # Properties of the object.
+            },
+            "precedingConversationSummary": "A String", # Optional. Summary string of the preceding conversation for the child playbook invocation.
+          },
+          "playbookOutput": { # Output of the playbook. # Optional. The output of the playbook in the example.
+            "actionParameters": { # Optional. A Struct object of output parameters for the action.
+              "a_key": "", # Properties of the object.
+            },
+            "executionSummary": "A String", # Optional. Summary string of the execution result of the child playbook.
+          },
+          "tokenCount": "A String", # Output only. Estimated number of tokes current example takes when sent to the LLM.
+          "updateTime": "A String", # Output only. Last time the example was updated.
+        },
+      ],
+      "name": "A String", # The unique identifier of the playbook version. Format: `projects//locations//agents//playbooks//versions/`.
+      "playbook": { # Playbook is the basic building block to instruct the LLM how to execute a certain task. A playbook consists of a goal to accomplish, an optional list of step by step instructions (the step instruction may refers to name of the custom or default plugin tools to use) to perform the task, a list of contextual input data to be passed in at the beginning of the invoked, and a list of output parameters to store the playbook result. # Output only. Snapshot of the playbook when the playbook version is created.
+        "createTime": "A String", # Output only. The timestamp of initial playbook creation.
+        "displayName": "A String", # Required. The human-readable name of the playbook, unique within an agent.
+        "goal": "A String", # Required. High level description of the goal the playbook intend to accomplish.
+        "inputParameterDefinitions": [ # Optional. Defined structured input parameters for this playbook.
+          { # Defines the properties of a parameter. Used to define parameters used in the agent and the input / output parameters for each fulfillment.
+            "description": "A String", # Human-readable description of the parameter. Limited to 300 characters.
+            "name": "A String", # Required. Name of parameter.
+            "type": "A String", # Required. Type of parameter.
+          },
+        ],
+        "instruction": { # Message of the Instruction of the playbook. # Instruction to accomplish target goal.
+          "steps": [ # Ordered list of step by step execution instructions to accomplish target goal.
+            { # Message of single step execution.
+              "steps": [ # Sub-processing needed to execute the current step.
+                # Object with schema name: GoogleCloudDialogflowCxV3beta1PlaybookStep
+              ],
+              "text": "A String", # Step instruction in text format.
+            },
+          ],
+        },
+        "llmModelSettings": { # Settings for LLM models. # Optional. Llm model settings for the playbook.
+          "model": "A String", # The selected LLM model.
+          "promptText": "A String", # The custom prompt to use.
+        },
+        "name": "A String", # The unique identifier of the playbook. Format: `projects//locations//agents//playbooks/`.
+        "outputParameterDefinitions": [ # Optional. Defined structured output parameters for this playbook.
+          { # Defines the properties of a parameter. Used to define parameters used in the agent and the input / output parameters for each fulfillment.
+            "description": "A String", # Human-readable description of the parameter. Limited to 300 characters.
+            "name": "A String", # Required. Name of parameter.
+            "type": "A String", # Required. Type of parameter.
+          },
+        ],
+        "referencedFlows": [ # Output only. The resource name of flows referenced by the current playbook in the instructions.
+          "A String",
+        ],
+        "referencedPlaybooks": [ # Output only. The resource name of other playbooks referenced by the current playbook in the instructions.
+          "A String",
+        ],
+        "referencedTools": [ # Optional. The resource name of tools referenced by the current playbook in the instructions. If not provided explicitly, they are will be implied using the tool being referenced in goal and steps.
+          "A String",
+        ],
+        "tokenCount": "A String", # Output only. Estimated number of tokes current playbook takes when sent to the LLM.
+        "updateTime": "A String", # Output only. Last time the playbook version was updated.
+      },
+      "updateTime": "A String", # Output only. Last time the playbook version was created or modified.
+    },
+  ],
+}
+
+ +
+ list_next() +
Retrieves the next page of results.
+
+        Args:
+          previous_request: The request for the previous page. (required)
+          previous_response: The response from the request for the previous page. (required)
+
+        Returns:
+          A request object that you can call 'execute()' on to request the next
+          page. Returns None if there are no more items in the collection.
+        
+
+ + \ No newline at end of file diff --git a/docs/dyn/dialogflow_v3beta1.projects.locations.agents.sessions.html b/docs/dyn/dialogflow_v3beta1.projects.locations.agents.sessions.html index cdc94988258..5a50b5e8863 100644 --- a/docs/dyn/dialogflow_v3beta1.projects.locations.agents.sessions.html +++ b/docs/dyn/dialogflow_v3beta1.projects.locations.agents.sessions.html @@ -163,11 +163,22 @@

Method Details

"text": { # Represents the natural language text to be processed. # The natural language text to be processed. "text": "A String", # Required. The UTF-8 encoded natural language text to be processed. }, + "toolCallResult": { # The result of calling a tool's action that has been executed by the client. # The results of a tool executed by the client. + "action": "A String", # Required. The name of the tool's action associated with this call. + "error": { # An error produced by the tool call. # The tool call's error. + "message": "A String", # Optional. The error message of the function. + }, + "outputParameters": { # The tool call's output parameters. + "a_key": "", # Properties of the object. + }, + "tool": "A String", # Required. The tool associated with this call. Format: `projects//locations//agents//tools/`. + }, }, "queryParams": { # Represents the parameters of a conversational query. # The parameters of this query. "analyzeQueryTextSentiment": True or False, # Configures whether sentiment analysis should be performed. If not provided, sentiment analysis is not performed. "channel": "A String", # The channel which this query is for. If specified, only the ResponseMessage associated with the channel will be returned. If no ResponseMessage is associated with the channel, it falls back to the ResponseMessage with unspecified channel. If unspecified, the ResponseMessage with unspecified channel will be returned. "currentPage": "A String", # The unique identifier of the page to override the current page in the session. Format: `projects//locations//agents//flows//pages/`. If `current_page` is specified, the previous state of the session will be ignored by Dialogflow, including the previous page and the previous session parameters. In most cases, current_page and parameters should be configured together to direct a session to a specific state. + "currentPlaybook": "A String", # Optional. Start the session with the specified playbook. You can only specify the playbook at the beginning of the session. Otherwise, an error will be thrown. Format: `projects//locations//agents//playbooks/`. "disableWebhook": True or False, # Whether to disable webhook calls for this request. "endUserMetadata": { # Optional. Information about the end-user to improve the relevance and accuracy of generative answers. This will be interpreted and used by a language model, so, for good results, the data should be self-descriptive, and in a simple structure. Example: ```json { "subscription plan": "Business Premium Plus", "devices owned": [ {"model": "Google Pixel 7"}, {"model": "Google Pixel Tablet"} ] } ``` "a_key": "", # Properties of the object. @@ -179,6 +190,10 @@

Method Details

"latitude": 3.14, # The latitude in degrees. It must be in the range [-90.0, +90.0]. "longitude": 3.14, # The longitude in degrees. It must be in the range [-180.0, +180.0]. }, + "llmModelSettings": { # Settings for LLM models. # Optional. Use the specified LLM model settings for processing the request. + "model": "A String", # The selected LLM model. + "promptText": "A String", # The custom prompt to use. + }, "parameters": { # Additional parameters to be put into session parameters. To remove a parameter from the session, clients should explicitly set the parameter value to null. You can reference the session parameters in the agent with the following format: $session.params.parameter-id. 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 then use map, otherwise, depending on the parameter value type, it could be one of string, number, boolean, null, list or map. * MapValue value: If parameter's entity type is a composite entity then use map from composite entity property names to property values, otherwise, use parameter value. "a_key": "", # Properties of the object. }, @@ -276,8 +291,8 @@

Method Details

"maxDigits": 42, # Max length of DTMF digits. }, "loggingSettings": { # Define behaviors on logging. # Settings for logging. Settings for Dialogflow History, Contact Center messages, StackDriver logs, and speech logging. Exposed at the following levels: - Agent level. - "enableInteractionLogging": True or False, # If true, DF Interaction logging is currently enabled. - "enableStackdriverLogging": True or False, # If true, StackDriver logging is currently enabled. + "enableInteractionLogging": True or False, # Enables DF Interaction logging. + "enableStackdriverLogging": True or False, # Enables StackDriver logging. }, "speechSettings": { # Define behaviors of speech to text detection. # Settings for speech to text detection. Exposed at the following levels: - Agent level - Flow level - Page level - Parameter level "endpointerSensitivity": 42, # Sensitivity of the speech model that detects the end of speech. Scale from 0 to 100. @@ -289,8 +304,8 @@

Method Details

}, }, "allowAnswerFeedback": True or False, # Indicates whether the Thumbs up/Thumbs down rating controls are need to be shown for the response in the Dialogflow Messenger widget. - "currentPage": { # A Dialogflow CX conversation (session) can be described and visualized as a state machine. The states of a CX session are represented by pages. For each flow, you define many pages, where your combined pages can handle a complete conversation on the topics the flow is designed for. At any given moment, exactly one page is the current page, the current page is considered active, and the flow associated with that page is considered active. Every flow has a special start page. When a flow initially becomes active, the start page page becomes the current page. For each conversational turn, the current page will either stay the same or transition to another page. You configure each page to collect information from the end-user that is relevant for the conversational state represented by the page. For more information, see the [Page guide](https://cloud.google.com/dialogflow/cx/docs/concept/page). # The current Page. Some, not all fields are filled in this message, including but not limited to `name` and `display_name`. - "advancedSettings": { # Hierarchical advanced settings for agent/flow/page/fulfillment/parameter. Settings exposed at lower level overrides the settings exposed at higher level. Overriding occurs at the sub-setting level. For example, the playback_interruption_settings at fulfillment level only overrides the playback_interruption_settings at the agent level, leaving other settings at the agent level unchanged. DTMF settings does not override each other. DTMF settings set at different levels define DTMF detections running in parallel. Hierarchy: Agent->Flow->Page->Fulfillment/Parameter. # Hierarchical advanced settings for this page. The settings exposed at the lower level overrides the settings exposed at the higher level. + "currentFlow": { # Flows represents the conversation flows when you build your chatbot agent. A flow consists of many pages connected by the transition routes. Conversations always start with the built-in Start Flow (with an all-0 ID). Transition routes can direct the conversation session from the current flow (parent flow) to another flow (sub flow). When the sub flow is finished, Dialogflow will bring the session back to the parent flow, where the sub flow is started. Usually, when a transition route is followed by a matched intent, the intent will be "consumed". This means the intent won't activate more transition routes. However, when the followed transition route moves the conversation session into a different flow, the matched intent can be carried over and to be consumed in the target flow. # The current Flow. Some, not all fields are filled in this message, including but not limited to `name` and `display_name`. + "advancedSettings": { # Hierarchical advanced settings for agent/flow/page/fulfillment/parameter. Settings exposed at lower level overrides the settings exposed at higher level. Overriding occurs at the sub-setting level. For example, the playback_interruption_settings at fulfillment level only overrides the playback_interruption_settings at the agent level, leaving other settings at the agent level unchanged. DTMF settings does not override each other. DTMF settings set at different levels define DTMF detections running in parallel. Hierarchy: Agent->Flow->Page->Fulfillment/Parameter. # Hierarchical advanced settings for this flow. The settings exposed at the lower level overrides the settings exposed at the higher level. "audioExportGcsDestination": { # Google Cloud Storage location for a Dialogflow operation that writes or exports objects (e.g. exported agent or transcripts) outside of Dialogflow. # If present, incoming audio is exported by Dialogflow to the configured Google Cloud Storage destination. Exposed at the following levels: - Agent level - Flow level "uri": "A String", # Required. The Google Cloud Storage URI for the exported objects. A URI is of the form: `gs://bucket/object-name-or-prefix` Whether a full object name, or just a prefix, its usage depends on the Dialogflow operation. }, @@ -302,8 +317,8 @@

Method Details

"maxDigits": 42, # Max length of DTMF digits. }, "loggingSettings": { # Define behaviors on logging. # Settings for logging. Settings for Dialogflow History, Contact Center messages, StackDriver logs, and speech logging. Exposed at the following levels: - Agent level. - "enableInteractionLogging": True or False, # If true, DF Interaction logging is currently enabled. - "enableStackdriverLogging": True or False, # If true, StackDriver logging is currently enabled. + "enableInteractionLogging": True or False, # Enables DF Interaction logging. + "enableStackdriverLogging": True or False, # Enables StackDriver logging. }, "speechSettings": { # Define behaviors of speech to text detection. # Settings for speech to text detection. Exposed at the following levels: - Agent level - Flow level - Page level - Parameter level "endpointerSensitivity": 42, # Sensitivity of the speech model that detects the end of speech. Scale from 0 to 100. @@ -314,155 +329,9 @@

Method Details

"useTimeoutBasedEndpointing": True or False, # Use timeout based endpointing, interpreting endpointer sensitivy as seconds of timeout value. }, }, - "description": "A String", # The description of the page. The maximum length is 500 characters. - "displayName": "A String", # Required. The human-readable name of the page, unique within the flow. - "entryFulfillment": { # A fulfillment can do one or more of the following actions at the same time: * Generate rich message responses. * Set parameter values. * Call the webhook. Fulfillments can be called at various stages in the Page or Form lifecycle. For example, when a DetectIntentRequest drives a session to enter a new page, the page's entry fulfillment can add a static response to the QueryResult in the returning DetectIntentResponse, call the webhook (for example, to load user data from a database), or both. # The fulfillment to call when the session is entering the page. - "advancedSettings": { # Hierarchical advanced settings for agent/flow/page/fulfillment/parameter. Settings exposed at lower level overrides the settings exposed at higher level. Overriding occurs at the sub-setting level. For example, the playback_interruption_settings at fulfillment level only overrides the playback_interruption_settings at the agent level, leaving other settings at the agent level unchanged. DTMF settings does not override each other. DTMF settings set at different levels define DTMF detections running in parallel. Hierarchy: Agent->Flow->Page->Fulfillment/Parameter. # Hierarchical advanced settings for this fulfillment. The settings exposed at the lower level overrides the settings exposed at the higher level. - "audioExportGcsDestination": { # Google Cloud Storage location for a Dialogflow operation that writes or exports objects (e.g. exported agent or transcripts) outside of Dialogflow. # If present, incoming audio is exported by Dialogflow to the configured Google Cloud Storage destination. Exposed at the following levels: - Agent level - Flow level - "uri": "A String", # Required. The Google Cloud Storage URI for the exported objects. A URI is of the form: `gs://bucket/object-name-or-prefix` Whether a full object name, or just a prefix, its usage depends on the Dialogflow operation. - }, - "dtmfSettings": { # Define behaviors for DTMF (dual tone multi frequency). # Settings for DTMF. Exposed at the following levels: - Agent level - Flow level - Page level - Parameter level. - "enabled": True or False, # If true, incoming audio is processed for DTMF (dual tone multi frequency) events. For example, if the caller presses a button on their telephone keypad and DTMF processing is enabled, Dialogflow will detect the event (e.g. a "3" was pressed) in the incoming audio and pass the event to the bot to drive business logic (e.g. when 3 is pressed, return the account balance). - "endpointingTimeoutDuration": "A String", # Endpoint timeout setting for matching dtmf input to regex. - "finishDigit": "A String", # The digit that terminates a DTMF digit sequence. - "interdigitTimeoutDuration": "A String", # Interdigit timeout setting for matching dtmf input to regex. - "maxDigits": 42, # Max length of DTMF digits. - }, - "loggingSettings": { # Define behaviors on logging. # Settings for logging. Settings for Dialogflow History, Contact Center messages, StackDriver logs, and speech logging. Exposed at the following levels: - Agent level. - "enableInteractionLogging": True or False, # If true, DF Interaction logging is currently enabled. - "enableStackdriverLogging": True or False, # If true, StackDriver logging is currently enabled. - }, - "speechSettings": { # Define behaviors of speech to text detection. # Settings for speech to text detection. Exposed at the following levels: - Agent level - Flow level - Page level - Parameter level - "endpointerSensitivity": 42, # Sensitivity of the speech model that detects the end of speech. Scale from 0 to 100. - "models": { # Mapping from language to Speech-to-Text model. The mapped Speech-to-Text model will be selected for requests from its corresponding language. For more information, see [Speech models](https://cloud.google.com/dialogflow/cx/docs/concept/speech-models). - "a_key": "A String", - }, - "noSpeechTimeout": "A String", # Timeout before detecting no speech. - "useTimeoutBasedEndpointing": True or False, # Use timeout based endpointing, interpreting endpointer sensitivy as seconds of timeout value. - }, - }, - "conditionalCases": [ # Conditional cases for this fulfillment. - { # A list of cascading if-else conditions. Cases are mutually exclusive. The first one with a matching condition is selected, all the rest ignored. - "cases": [ # A list of cascading if-else conditions. - { # Each case has a Boolean condition. When it is evaluated to be True, the corresponding messages will be selected and evaluated recursively. - "caseContent": [ # A list of case content. - { # The list of messages or conditional cases to activate for this case. - "additionalCases": # Object with schema name: GoogleCloudDialogflowCxV3beta1FulfillmentConditionalCases # Additional cases to be evaluated. - "message": { # 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. # Returned message. - "channel": "A String", # The channel which the response is associated with. Clients can specify the channel via QueryParameters.channel, and only associated channel response will be returned. - "conversationSuccess": { # 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. # Indicates that the conversation succeeded. - "metadata": { # Custom metadata. Dialogflow doesn't impose any structure on this. - "a_key": "", # Properties of the object. - }, - }, - "endInteraction": { # 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. # Output only. A signal that indicates the interaction with the Dialogflow agent has ended. This message is generated by Dialogflow only when the conversation reaches `END_SESSION` page. It is not supposed to be defined by the user. It's guaranteed that there is at most one such message in each response. - }, - "knowledgeInfoCard": { # Represents info card response. If the response contains generative knowledge prediction, Dialogflow will return a payload with Infobot Messenger compatible info card. Otherwise, the info card response is skipped. # Represents info card for knowledge answers, to be better rendered in Dialogflow Messenger. - }, - "liveAgentHandoff": { # 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. # Hands off conversation to a human agent. - "metadata": { # Custom metadata for your handoff procedure. Dialogflow doesn't impose any structure on this. - "a_key": "", # Properties of the object. - }, - }, - "mixedAudio": { # 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. # Output only. An audio response message composed of both the synthesized Dialogflow agent responses and responses defined via play_audio. This message is generated by Dialogflow only and not supposed to be defined by the user. - "segments": [ # Segments this audio response is composed of. - { # Represents one segment of audio. - "allowPlaybackInterruption": True or False, # 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. - "audio": "A String", # Raw audio synthesized from the Dialogflow agent's response using the output config specified in the request. - "uri": "A String", # Client-specific URI that points to an audio clip accessible to the client. Dialogflow does not impose any validation on it. - }, - ], - }, - "outputAudioText": { # A text or ssml response that is preferentially used for TTS output audio synthesis, as described in the comment on the ResponseMessage message. # A text or ssml response that is preferentially used for TTS output audio synthesis, as described in the comment on the ResponseMessage message. - "allowPlaybackInterruption": True or False, # 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. - "ssml": "A String", # The SSML text to be synthesized. For more information, see [SSML](/speech/text-to-speech/docs/ssml). - "text": "A String", # The raw text to be synthesized. - }, - "payload": { # Returns a response containing a custom, platform-specific payload. - "a_key": "", # Properties of the object. - }, - "playAudio": { # Specifies an audio clip to be played by the client as part of the response. # Signal that the client should play an audio clip hosted at a client-specific URI. Dialogflow uses this to construct mixed_audio. However, Dialogflow itself does not try to read or process the URI in any way. - "allowPlaybackInterruption": True or False, # 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. - "audioUri": "A String", # Required. URI of the audio clip. Dialogflow does not impose any validation on this value. It is specific to the client that reads it. - }, - "telephonyTransferCall": { # Represents the signal that telles the client to transfer the phone call connected to the agent to a third-party endpoint. # A signal that the client should transfer the phone call connected to this agent to a third-party endpoint. - "phoneNumber": "A String", # Transfer the call to a phone number in [E.164 format](https://en.wikipedia.org/wiki/E.164). - }, - "text": { # The text response message. # Returns a text response. - "allowPlaybackInterruption": True or False, # 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. - "text": [ # Required. A collection of text responses. - "A String", - ], - }, - }, - }, - ], - "condition": "A String", # The condition to activate and select this case. Empty means the condition is always true. The condition is evaluated against form parameters or session parameters. See the [conditions reference](https://cloud.google.com/dialogflow/cx/docs/reference/condition). - }, - ], - }, - ], - "enableGenerativeFallback": True or False, # If the flag is true, the agent will utilize LLM to generate a text response. If LLM generation fails, the defined responses in the fulfillment will be respected. This flag is only useful for fulfillments associated with no-match event handlers. - "messages": [ # The list of rich message responses to present to the user. - { # 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. - "channel": "A String", # The channel which the response is associated with. Clients can specify the channel via QueryParameters.channel, and only associated channel response will be returned. - "conversationSuccess": { # 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. # Indicates that the conversation succeeded. - "metadata": { # Custom metadata. Dialogflow doesn't impose any structure on this. - "a_key": "", # Properties of the object. - }, - }, - "endInteraction": { # 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. # Output only. A signal that indicates the interaction with the Dialogflow agent has ended. This message is generated by Dialogflow only when the conversation reaches `END_SESSION` page. It is not supposed to be defined by the user. It's guaranteed that there is at most one such message in each response. - }, - "knowledgeInfoCard": { # Represents info card response. If the response contains generative knowledge prediction, Dialogflow will return a payload with Infobot Messenger compatible info card. Otherwise, the info card response is skipped. # Represents info card for knowledge answers, to be better rendered in Dialogflow Messenger. - }, - "liveAgentHandoff": { # 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. # Hands off conversation to a human agent. - "metadata": { # Custom metadata for your handoff procedure. Dialogflow doesn't impose any structure on this. - "a_key": "", # Properties of the object. - }, - }, - "mixedAudio": { # 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. # Output only. An audio response message composed of both the synthesized Dialogflow agent responses and responses defined via play_audio. This message is generated by Dialogflow only and not supposed to be defined by the user. - "segments": [ # Segments this audio response is composed of. - { # Represents one segment of audio. - "allowPlaybackInterruption": True or False, # 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. - "audio": "A String", # Raw audio synthesized from the Dialogflow agent's response using the output config specified in the request. - "uri": "A String", # Client-specific URI that points to an audio clip accessible to the client. Dialogflow does not impose any validation on it. - }, - ], - }, - "outputAudioText": { # A text or ssml response that is preferentially used for TTS output audio synthesis, as described in the comment on the ResponseMessage message. # A text or ssml response that is preferentially used for TTS output audio synthesis, as described in the comment on the ResponseMessage message. - "allowPlaybackInterruption": True or False, # 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. - "ssml": "A String", # The SSML text to be synthesized. For more information, see [SSML](/speech/text-to-speech/docs/ssml). - "text": "A String", # The raw text to be synthesized. - }, - "payload": { # Returns a response containing a custom, platform-specific payload. - "a_key": "", # Properties of the object. - }, - "playAudio": { # Specifies an audio clip to be played by the client as part of the response. # Signal that the client should play an audio clip hosted at a client-specific URI. Dialogflow uses this to construct mixed_audio. However, Dialogflow itself does not try to read or process the URI in any way. - "allowPlaybackInterruption": True or False, # 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. - "audioUri": "A String", # Required. URI of the audio clip. Dialogflow does not impose any validation on this value. It is specific to the client that reads it. - }, - "telephonyTransferCall": { # Represents the signal that telles the client to transfer the phone call connected to the agent to a third-party endpoint. # A signal that the client should transfer the phone call connected to this agent to a third-party endpoint. - "phoneNumber": "A String", # Transfer the call to a phone number in [E.164 format](https://en.wikipedia.org/wiki/E.164). - }, - "text": { # The text response message. # Returns a text response. - "allowPlaybackInterruption": True or False, # 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. - "text": [ # Required. A collection of text responses. - "A String", - ], - }, - }, - ], - "returnPartialResponses": True or False, # Whether Dialogflow should return currently queued fulfillment response messages in streaming APIs. If a webhook is specified, it happens before Dialogflow invokes webhook. Warning: 1) This flag only affects streaming API. Responses are still queued and returned once in non-streaming API. 2) The flag can be enabled in any fulfillment but only the first 3 partial responses will be returned. You may only want to apply it to fulfillments that have slow webhooks. - "setParameterActions": [ # Set parameter values before executing the webhook. - { # Setting a parameter value. - "parameter": "A String", # Display name of the parameter. - "value": "", # The new value of the parameter. A null value clears the parameter. - }, - ], - "tag": "A String", # The value of this field will be populated in the WebhookRequest `fulfillmentInfo.tag` field by Dialogflow when the associated webhook is called. The tag is typically used by the webhook service to identify which fulfillment is being called, but it could be used for other purposes. This field is required if `webhook` is specified. - "webhook": "A String", # The webhook to call. Format: `projects//locations//agents//webhooks/`. - }, - "eventHandlers": [ # Handlers associated with the page to handle events such as webhook errors, no match or no input. + "description": "A String", # The description of the flow. The maximum length is 500 characters. If exceeded, the request is rejected. + "displayName": "A String", # Required. The human-readable name of the flow. + "eventHandlers": [ # A flow's event handlers serve two purposes: * They are responsible for handling events (e.g. no match, webhook errors) in the flow. * They are inherited by every page's event handlers, which can be used to handle common events regardless of the current page. Event handlers defined in the page have higher priority than those defined in the flow. Unlike transition_routes, these handlers are evaluated on a first-match basis. The first one that matches the event get executed, with the rest being ignored. { # An event handler specifies an event that can be handled during a session. When the specified event happens, the following actions are taken in order: * If there is a `trigger_fulfillment` associated with the event, it will be called. * If there is a `target_page` associated with the event, the session will transition into the specified page. * If there is a `target_flow` associated with the event, the session will transition into the specified flow. "event": "A String", # Required. The name of the event to handle. "name": "A String", # Output only. The unique identifier of this event handler. @@ -481,8 +350,8 @@

Method Details

"maxDigits": 42, # Max length of DTMF digits. }, "loggingSettings": { # Define behaviors on logging. # Settings for logging. Settings for Dialogflow History, Contact Center messages, StackDriver logs, and speech logging. Exposed at the following levels: - Agent level. - "enableInteractionLogging": True or False, # If true, DF Interaction logging is currently enabled. - "enableStackdriverLogging": True or False, # If true, StackDriver logging is currently enabled. + "enableInteractionLogging": True or False, # Enables DF Interaction logging. + "enableStackdriverLogging": True or False, # Enables StackDriver logging. }, "speechSettings": { # Define behaviors of speech to text detection. # Settings for speech to text detection. Exposed at the following levels: - Agent level - Flow level - Page level - Parameter level "endpointerSensitivity": 42, # Sensitivity of the speech model that detects the end of speech. Scale from 0 to 100. @@ -546,6 +415,13 @@

Method Details

"A String", ], }, + "toolCall": { # Represents a call of a specific tool's action with the specified inputs. # Returns the definition of a tool call that should be executed by the client. + "action": "A String", # Required. The name of the tool's action associated with this call. + "inputParameters": { # Optional. The action's input parameters. + "a_key": "", # Properties of the object. + }, + "tool": "A String", # Required. The tool associated with this call. Format: `projects//locations//agents//tools/`. + }, }, }, ], @@ -602,6 +478,13 @@

Method Details

"A String", ], }, + "toolCall": { # Represents a call of a specific tool's action with the specified inputs. # Returns the definition of a tool call that should be executed by the client. + "action": "A String", # Required. The name of the tool's action associated with this call. + "inputParameters": { # Optional. The action's input parameters. + "a_key": "", # Properties of the object. + }, + "tool": "A String", # Required. The tool associated with this call. Format: `projects//locations//agents//tools/`. + }, }, ], "returnPartialResponses": True or False, # Whether Dialogflow should return currently queued fulfillment response messages in streaming APIs. If a webhook is specified, it happens before Dialogflow invokes webhook. Warning: 1) This flag only affects streaming API. Responses are still queued and returned once in non-streaming API. 2) The flag can be enabled in any fulfillment but only the first 3 partial responses will be returned. You may only want to apply it to fulfillments that have slow webhooks. @@ -616,278 +499,49 @@

Method Details

}, }, ], - "form": { # A form is a data model that groups related parameters that can be collected from the user. The process in which the agent prompts the user and collects parameter values from the user is called form filling. A form can be added to a page. When form filling is done, the filled parameters will be written to the session. # The form associated with the page, used for collecting parameters relevant to the page. - "parameters": [ # Parameters to collect from the user. - { # Represents a form parameter. - "advancedSettings": { # Hierarchical advanced settings for agent/flow/page/fulfillment/parameter. Settings exposed at lower level overrides the settings exposed at higher level. Overriding occurs at the sub-setting level. For example, the playback_interruption_settings at fulfillment level only overrides the playback_interruption_settings at the agent level, leaving other settings at the agent level unchanged. DTMF settings does not override each other. DTMF settings set at different levels define DTMF detections running in parallel. Hierarchy: Agent->Flow->Page->Fulfillment/Parameter. # Hierarchical advanced settings for this parameter. The settings exposed at the lower level overrides the settings exposed at the higher level. - "audioExportGcsDestination": { # Google Cloud Storage location for a Dialogflow operation that writes or exports objects (e.g. exported agent or transcripts) outside of Dialogflow. # If present, incoming audio is exported by Dialogflow to the configured Google Cloud Storage destination. Exposed at the following levels: - Agent level - Flow level - "uri": "A String", # Required. The Google Cloud Storage URI for the exported objects. A URI is of the form: `gs://bucket/object-name-or-prefix` Whether a full object name, or just a prefix, its usage depends on the Dialogflow operation. - }, - "dtmfSettings": { # Define behaviors for DTMF (dual tone multi frequency). # Settings for DTMF. Exposed at the following levels: - Agent level - Flow level - Page level - Parameter level. - "enabled": True or False, # If true, incoming audio is processed for DTMF (dual tone multi frequency) events. For example, if the caller presses a button on their telephone keypad and DTMF processing is enabled, Dialogflow will detect the event (e.g. a "3" was pressed) in the incoming audio and pass the event to the bot to drive business logic (e.g. when 3 is pressed, return the account balance). - "endpointingTimeoutDuration": "A String", # Endpoint timeout setting for matching dtmf input to regex. - "finishDigit": "A String", # The digit that terminates a DTMF digit sequence. - "interdigitTimeoutDuration": "A String", # Interdigit timeout setting for matching dtmf input to regex. - "maxDigits": 42, # Max length of DTMF digits. - }, - "loggingSettings": { # Define behaviors on logging. # Settings for logging. Settings for Dialogflow History, Contact Center messages, StackDriver logs, and speech logging. Exposed at the following levels: - Agent level. - "enableInteractionLogging": True or False, # If true, DF Interaction logging is currently enabled. - "enableStackdriverLogging": True or False, # If true, StackDriver logging is currently enabled. - }, - "speechSettings": { # Define behaviors of speech to text detection. # Settings for speech to text detection. Exposed at the following levels: - Agent level - Flow level - Page level - Parameter level - "endpointerSensitivity": 42, # Sensitivity of the speech model that detects the end of speech. Scale from 0 to 100. - "models": { # Mapping from language to Speech-to-Text model. The mapped Speech-to-Text model will be selected for requests from its corresponding language. For more information, see [Speech models](https://cloud.google.com/dialogflow/cx/docs/concept/speech-models). - "a_key": "A String", - }, - "noSpeechTimeout": "A String", # Timeout before detecting no speech. - "useTimeoutBasedEndpointing": True or False, # Use timeout based endpointing, interpreting endpointer sensitivy as seconds of timeout value. + "knowledgeConnectorSettings": { # The Knowledge Connector settings for this page or flow. This includes information such as the attached Knowledge Bases, and the way to execute fulfillment. # Optional. Knowledge connector configuration. + "dataStoreConnections": [ # Optional. List of related data store connections. + { # A data store connection. It represents a data store in Discovery Engine and the type of the contents it contains. + "dataStore": "A String", # The full name of the referenced data store. Formats: `projects/{project}/locations/{location}/collections/{collection}/dataStores/{data_store}` `projects/{project}/locations/{location}/dataStores/{data_store}` + "dataStoreType": "A String", # The type of the connected data store. + }, + ], + "enabled": True or False, # Whether Knowledge Connector is enabled or not. + "targetFlow": "A String", # The target flow to transition to. Format: `projects//locations//agents//flows/`. + "targetPage": "A String", # The target page to transition to. Format: `projects//locations//agents//flows//pages/`. + "triggerFulfillment": { # A fulfillment can do one or more of the following actions at the same time: * Generate rich message responses. * Set parameter values. * Call the webhook. Fulfillments can be called at various stages in the Page or Form lifecycle. For example, when a DetectIntentRequest drives a session to enter a new page, the page's entry fulfillment can add a static response to the QueryResult in the returning DetectIntentResponse, call the webhook (for example, to load user data from a database), or both. # The fulfillment to be triggered. When the answers from the Knowledge Connector are selected by Dialogflow, you can utitlize the request scoped parameter `$request.knowledge.answers` (contains up to the 5 highest confidence answers) and `$request.knowledge.questions` (contains the corresponding questions) to construct the fulfillment. + "advancedSettings": { # Hierarchical advanced settings for agent/flow/page/fulfillment/parameter. Settings exposed at lower level overrides the settings exposed at higher level. Overriding occurs at the sub-setting level. For example, the playback_interruption_settings at fulfillment level only overrides the playback_interruption_settings at the agent level, leaving other settings at the agent level unchanged. DTMF settings does not override each other. DTMF settings set at different levels define DTMF detections running in parallel. Hierarchy: Agent->Flow->Page->Fulfillment/Parameter. # Hierarchical advanced settings for this fulfillment. The settings exposed at the lower level overrides the settings exposed at the higher level. + "audioExportGcsDestination": { # Google Cloud Storage location for a Dialogflow operation that writes or exports objects (e.g. exported agent or transcripts) outside of Dialogflow. # If present, incoming audio is exported by Dialogflow to the configured Google Cloud Storage destination. Exposed at the following levels: - Agent level - Flow level + "uri": "A String", # Required. The Google Cloud Storage URI for the exported objects. A URI is of the form: `gs://bucket/object-name-or-prefix` Whether a full object name, or just a prefix, its usage depends on the Dialogflow operation. + }, + "dtmfSettings": { # Define behaviors for DTMF (dual tone multi frequency). # Settings for DTMF. Exposed at the following levels: - Agent level - Flow level - Page level - Parameter level. + "enabled": True or False, # If true, incoming audio is processed for DTMF (dual tone multi frequency) events. For example, if the caller presses a button on their telephone keypad and DTMF processing is enabled, Dialogflow will detect the event (e.g. a "3" was pressed) in the incoming audio and pass the event to the bot to drive business logic (e.g. when 3 is pressed, return the account balance). + "endpointingTimeoutDuration": "A String", # Endpoint timeout setting for matching dtmf input to regex. + "finishDigit": "A String", # The digit that terminates a DTMF digit sequence. + "interdigitTimeoutDuration": "A String", # Interdigit timeout setting for matching dtmf input to regex. + "maxDigits": 42, # Max length of DTMF digits. + }, + "loggingSettings": { # Define behaviors on logging. # Settings for logging. Settings for Dialogflow History, Contact Center messages, StackDriver logs, and speech logging. Exposed at the following levels: - Agent level. + "enableInteractionLogging": True or False, # Enables DF Interaction logging. + "enableStackdriverLogging": True or False, # Enables StackDriver logging. + }, + "speechSettings": { # Define behaviors of speech to text detection. # Settings for speech to text detection. Exposed at the following levels: - Agent level - Flow level - Page level - Parameter level + "endpointerSensitivity": 42, # Sensitivity of the speech model that detects the end of speech. Scale from 0 to 100. + "models": { # Mapping from language to Speech-to-Text model. The mapped Speech-to-Text model will be selected for requests from its corresponding language. For more information, see [Speech models](https://cloud.google.com/dialogflow/cx/docs/concept/speech-models). + "a_key": "A String", }, + "noSpeechTimeout": "A String", # Timeout before detecting no speech. + "useTimeoutBasedEndpointing": True or False, # Use timeout based endpointing, interpreting endpointer sensitivy as seconds of timeout value. }, - "defaultValue": "", # The default value of an optional parameter. If the parameter is required, the default value will be ignored. - "displayName": "A String", # Required. The human-readable name of the parameter, unique within the form. - "entityType": "A String", # Required. The entity type of the parameter. Format: `projects/-/locations/-/agents/-/entityTypes/` for system entity types (for example, `projects/-/locations/-/agents/-/entityTypes/sys.date`), or `projects//locations//agents//entityTypes/` for developer entity types. - "fillBehavior": { # Configuration for how the filling of a parameter should be handled. # Required. Defines fill behavior for the parameter. - "initialPromptFulfillment": { # A fulfillment can do one or more of the following actions at the same time: * Generate rich message responses. * Set parameter values. * Call the webhook. Fulfillments can be called at various stages in the Page or Form lifecycle. For example, when a DetectIntentRequest drives a session to enter a new page, the page's entry fulfillment can add a static response to the QueryResult in the returning DetectIntentResponse, call the webhook (for example, to load user data from a database), or both. # Required. The fulfillment to provide the initial prompt that the agent can present to the user in order to fill the parameter. - "advancedSettings": { # Hierarchical advanced settings for agent/flow/page/fulfillment/parameter. Settings exposed at lower level overrides the settings exposed at higher level. Overriding occurs at the sub-setting level. For example, the playback_interruption_settings at fulfillment level only overrides the playback_interruption_settings at the agent level, leaving other settings at the agent level unchanged. DTMF settings does not override each other. DTMF settings set at different levels define DTMF detections running in parallel. Hierarchy: Agent->Flow->Page->Fulfillment/Parameter. # Hierarchical advanced settings for this fulfillment. The settings exposed at the lower level overrides the settings exposed at the higher level. - "audioExportGcsDestination": { # Google Cloud Storage location for a Dialogflow operation that writes or exports objects (e.g. exported agent or transcripts) outside of Dialogflow. # If present, incoming audio is exported by Dialogflow to the configured Google Cloud Storage destination. Exposed at the following levels: - Agent level - Flow level - "uri": "A String", # Required. The Google Cloud Storage URI for the exported objects. A URI is of the form: `gs://bucket/object-name-or-prefix` Whether a full object name, or just a prefix, its usage depends on the Dialogflow operation. - }, - "dtmfSettings": { # Define behaviors for DTMF (dual tone multi frequency). # Settings for DTMF. Exposed at the following levels: - Agent level - Flow level - Page level - Parameter level. - "enabled": True or False, # If true, incoming audio is processed for DTMF (dual tone multi frequency) events. For example, if the caller presses a button on their telephone keypad and DTMF processing is enabled, Dialogflow will detect the event (e.g. a "3" was pressed) in the incoming audio and pass the event to the bot to drive business logic (e.g. when 3 is pressed, return the account balance). - "endpointingTimeoutDuration": "A String", # Endpoint timeout setting for matching dtmf input to regex. - "finishDigit": "A String", # The digit that terminates a DTMF digit sequence. - "interdigitTimeoutDuration": "A String", # Interdigit timeout setting for matching dtmf input to regex. - "maxDigits": 42, # Max length of DTMF digits. - }, - "loggingSettings": { # Define behaviors on logging. # Settings for logging. Settings for Dialogflow History, Contact Center messages, StackDriver logs, and speech logging. Exposed at the following levels: - Agent level. - "enableInteractionLogging": True or False, # If true, DF Interaction logging is currently enabled. - "enableStackdriverLogging": True or False, # If true, StackDriver logging is currently enabled. - }, - "speechSettings": { # Define behaviors of speech to text detection. # Settings for speech to text detection. Exposed at the following levels: - Agent level - Flow level - Page level - Parameter level - "endpointerSensitivity": 42, # Sensitivity of the speech model that detects the end of speech. Scale from 0 to 100. - "models": { # Mapping from language to Speech-to-Text model. The mapped Speech-to-Text model will be selected for requests from its corresponding language. For more information, see [Speech models](https://cloud.google.com/dialogflow/cx/docs/concept/speech-models). - "a_key": "A String", - }, - "noSpeechTimeout": "A String", # Timeout before detecting no speech. - "useTimeoutBasedEndpointing": True or False, # Use timeout based endpointing, interpreting endpointer sensitivy as seconds of timeout value. - }, - }, - "conditionalCases": [ # Conditional cases for this fulfillment. - { # A list of cascading if-else conditions. Cases are mutually exclusive. The first one with a matching condition is selected, all the rest ignored. - "cases": [ # A list of cascading if-else conditions. - { # Each case has a Boolean condition. When it is evaluated to be True, the corresponding messages will be selected and evaluated recursively. - "caseContent": [ # A list of case content. - { # The list of messages or conditional cases to activate for this case. - "additionalCases": # Object with schema name: GoogleCloudDialogflowCxV3beta1FulfillmentConditionalCases # Additional cases to be evaluated. - "message": { # 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. # Returned message. - "channel": "A String", # The channel which the response is associated with. Clients can specify the channel via QueryParameters.channel, and only associated channel response will be returned. - "conversationSuccess": { # 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. # Indicates that the conversation succeeded. - "metadata": { # Custom metadata. Dialogflow doesn't impose any structure on this. - "a_key": "", # Properties of the object. - }, - }, - "endInteraction": { # 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. # Output only. A signal that indicates the interaction with the Dialogflow agent has ended. This message is generated by Dialogflow only when the conversation reaches `END_SESSION` page. It is not supposed to be defined by the user. It's guaranteed that there is at most one such message in each response. - }, - "knowledgeInfoCard": { # Represents info card response. If the response contains generative knowledge prediction, Dialogflow will return a payload with Infobot Messenger compatible info card. Otherwise, the info card response is skipped. # Represents info card for knowledge answers, to be better rendered in Dialogflow Messenger. - }, - "liveAgentHandoff": { # 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. # Hands off conversation to a human agent. - "metadata": { # Custom metadata for your handoff procedure. Dialogflow doesn't impose any structure on this. - "a_key": "", # Properties of the object. - }, - }, - "mixedAudio": { # 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. # Output only. An audio response message composed of both the synthesized Dialogflow agent responses and responses defined via play_audio. This message is generated by Dialogflow only and not supposed to be defined by the user. - "segments": [ # Segments this audio response is composed of. - { # Represents one segment of audio. - "allowPlaybackInterruption": True or False, # 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. - "audio": "A String", # Raw audio synthesized from the Dialogflow agent's response using the output config specified in the request. - "uri": "A String", # Client-specific URI that points to an audio clip accessible to the client. Dialogflow does not impose any validation on it. - }, - ], - }, - "outputAudioText": { # A text or ssml response that is preferentially used for TTS output audio synthesis, as described in the comment on the ResponseMessage message. # A text or ssml response that is preferentially used for TTS output audio synthesis, as described in the comment on the ResponseMessage message. - "allowPlaybackInterruption": True or False, # 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. - "ssml": "A String", # The SSML text to be synthesized. For more information, see [SSML](/speech/text-to-speech/docs/ssml). - "text": "A String", # The raw text to be synthesized. - }, - "payload": { # Returns a response containing a custom, platform-specific payload. - "a_key": "", # Properties of the object. - }, - "playAudio": { # Specifies an audio clip to be played by the client as part of the response. # Signal that the client should play an audio clip hosted at a client-specific URI. Dialogflow uses this to construct mixed_audio. However, Dialogflow itself does not try to read or process the URI in any way. - "allowPlaybackInterruption": True or False, # 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. - "audioUri": "A String", # Required. URI of the audio clip. Dialogflow does not impose any validation on this value. It is specific to the client that reads it. - }, - "telephonyTransferCall": { # Represents the signal that telles the client to transfer the phone call connected to the agent to a third-party endpoint. # A signal that the client should transfer the phone call connected to this agent to a third-party endpoint. - "phoneNumber": "A String", # Transfer the call to a phone number in [E.164 format](https://en.wikipedia.org/wiki/E.164). - }, - "text": { # The text response message. # Returns a text response. - "allowPlaybackInterruption": True or False, # 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. - "text": [ # Required. A collection of text responses. - "A String", - ], - }, - }, - }, - ], - "condition": "A String", # The condition to activate and select this case. Empty means the condition is always true. The condition is evaluated against form parameters or session parameters. See the [conditions reference](https://cloud.google.com/dialogflow/cx/docs/reference/condition). - }, - ], - }, - ], - "enableGenerativeFallback": True or False, # If the flag is true, the agent will utilize LLM to generate a text response. If LLM generation fails, the defined responses in the fulfillment will be respected. This flag is only useful for fulfillments associated with no-match event handlers. - "messages": [ # The list of rich message responses to present to the user. - { # 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. - "channel": "A String", # The channel which the response is associated with. Clients can specify the channel via QueryParameters.channel, and only associated channel response will be returned. - "conversationSuccess": { # 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. # Indicates that the conversation succeeded. - "metadata": { # Custom metadata. Dialogflow doesn't impose any structure on this. - "a_key": "", # Properties of the object. - }, - }, - "endInteraction": { # 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. # Output only. A signal that indicates the interaction with the Dialogflow agent has ended. This message is generated by Dialogflow only when the conversation reaches `END_SESSION` page. It is not supposed to be defined by the user. It's guaranteed that there is at most one such message in each response. - }, - "knowledgeInfoCard": { # Represents info card response. If the response contains generative knowledge prediction, Dialogflow will return a payload with Infobot Messenger compatible info card. Otherwise, the info card response is skipped. # Represents info card for knowledge answers, to be better rendered in Dialogflow Messenger. - }, - "liveAgentHandoff": { # 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. # Hands off conversation to a human agent. - "metadata": { # Custom metadata for your handoff procedure. Dialogflow doesn't impose any structure on this. - "a_key": "", # Properties of the object. - }, - }, - "mixedAudio": { # 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. # Output only. An audio response message composed of both the synthesized Dialogflow agent responses and responses defined via play_audio. This message is generated by Dialogflow only and not supposed to be defined by the user. - "segments": [ # Segments this audio response is composed of. - { # Represents one segment of audio. - "allowPlaybackInterruption": True or False, # 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. - "audio": "A String", # Raw audio synthesized from the Dialogflow agent's response using the output config specified in the request. - "uri": "A String", # Client-specific URI that points to an audio clip accessible to the client. Dialogflow does not impose any validation on it. - }, - ], - }, - "outputAudioText": { # A text or ssml response that is preferentially used for TTS output audio synthesis, as described in the comment on the ResponseMessage message. # A text or ssml response that is preferentially used for TTS output audio synthesis, as described in the comment on the ResponseMessage message. - "allowPlaybackInterruption": True or False, # 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. - "ssml": "A String", # The SSML text to be synthesized. For more information, see [SSML](/speech/text-to-speech/docs/ssml). - "text": "A String", # The raw text to be synthesized. - }, - "payload": { # Returns a response containing a custom, platform-specific payload. - "a_key": "", # Properties of the object. - }, - "playAudio": { # Specifies an audio clip to be played by the client as part of the response. # Signal that the client should play an audio clip hosted at a client-specific URI. Dialogflow uses this to construct mixed_audio. However, Dialogflow itself does not try to read or process the URI in any way. - "allowPlaybackInterruption": True or False, # 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. - "audioUri": "A String", # Required. URI of the audio clip. Dialogflow does not impose any validation on this value. It is specific to the client that reads it. - }, - "telephonyTransferCall": { # Represents the signal that telles the client to transfer the phone call connected to the agent to a third-party endpoint. # A signal that the client should transfer the phone call connected to this agent to a third-party endpoint. - "phoneNumber": "A String", # Transfer the call to a phone number in [E.164 format](https://en.wikipedia.org/wiki/E.164). - }, - "text": { # The text response message. # Returns a text response. - "allowPlaybackInterruption": True or False, # 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. - "text": [ # Required. A collection of text responses. - "A String", - ], - }, - }, - ], - "returnPartialResponses": True or False, # Whether Dialogflow should return currently queued fulfillment response messages in streaming APIs. If a webhook is specified, it happens before Dialogflow invokes webhook. Warning: 1) This flag only affects streaming API. Responses are still queued and returned once in non-streaming API. 2) The flag can be enabled in any fulfillment but only the first 3 partial responses will be returned. You may only want to apply it to fulfillments that have slow webhooks. - "setParameterActions": [ # Set parameter values before executing the webhook. - { # Setting a parameter value. - "parameter": "A String", # Display name of the parameter. - "value": "", # The new value of the parameter. A null value clears the parameter. - }, - ], - "tag": "A String", # The value of this field will be populated in the WebhookRequest `fulfillmentInfo.tag` field by Dialogflow when the associated webhook is called. The tag is typically used by the webhook service to identify which fulfillment is being called, but it could be used for other purposes. This field is required if `webhook` is specified. - "webhook": "A String", # The webhook to call. Format: `projects//locations//agents//webhooks/`. - }, - "repromptEventHandlers": [ # The handlers for parameter-level events, used to provide reprompt for the parameter or transition to a different page/flow. The supported events are: * `sys.no-match-`, where N can be from 1 to 6 * `sys.no-match-default` * `sys.no-input-`, where N can be from 1 to 6 * `sys.no-input-default` * `sys.invalid-parameter` `initial_prompt_fulfillment` provides the first prompt for the parameter. If the user's response does not fill the parameter, a no-match/no-input event will be triggered, and the fulfillment associated with the `sys.no-match-1`/`sys.no-input-1` handler (if defined) will be called to provide a prompt. The `sys.no-match-2`/`sys.no-input-2` handler (if defined) will respond to the next no-match/no-input event, and so on. A `sys.no-match-default` or `sys.no-input-default` handler will be used to handle all following no-match/no-input events after all numbered no-match/no-input handlers for the parameter are consumed. A `sys.invalid-parameter` handler can be defined to handle the case where the parameter values have been `invalidated` by webhook. For example, if the user's response fill the parameter, however the parameter was invalidated by webhook, the fulfillment associated with the `sys.invalid-parameter` handler (if defined) will be called to provide a prompt. If the event handler for the corresponding event can't be found on the parameter, `initial_prompt_fulfillment` will be re-prompted. - { # An event handler specifies an event that can be handled during a session. When the specified event happens, the following actions are taken in order: * If there is a `trigger_fulfillment` associated with the event, it will be called. * If there is a `target_page` associated with the event, the session will transition into the specified page. * If there is a `target_flow` associated with the event, the session will transition into the specified flow. - "event": "A String", # Required. The name of the event to handle. - "name": "A String", # Output only. The unique identifier of this event handler. - "targetFlow": "A String", # The target flow to transition to. Format: `projects//locations//agents//flows/`. - "targetPage": "A String", # The target page to transition to. Format: `projects//locations//agents//flows//pages/`. - "triggerFulfillment": { # A fulfillment can do one or more of the following actions at the same time: * Generate rich message responses. * Set parameter values. * Call the webhook. Fulfillments can be called at various stages in the Page or Form lifecycle. For example, when a DetectIntentRequest drives a session to enter a new page, the page's entry fulfillment can add a static response to the QueryResult in the returning DetectIntentResponse, call the webhook (for example, to load user data from a database), or both. # The fulfillment to call when the event occurs. Handling webhook errors with a fulfillment enabled with webhook could cause infinite loop. It is invalid to specify such fulfillment for a handler handling webhooks. - "advancedSettings": { # Hierarchical advanced settings for agent/flow/page/fulfillment/parameter. Settings exposed at lower level overrides the settings exposed at higher level. Overriding occurs at the sub-setting level. For example, the playback_interruption_settings at fulfillment level only overrides the playback_interruption_settings at the agent level, leaving other settings at the agent level unchanged. DTMF settings does not override each other. DTMF settings set at different levels define DTMF detections running in parallel. Hierarchy: Agent->Flow->Page->Fulfillment/Parameter. # Hierarchical advanced settings for this fulfillment. The settings exposed at the lower level overrides the settings exposed at the higher level. - "audioExportGcsDestination": { # Google Cloud Storage location for a Dialogflow operation that writes or exports objects (e.g. exported agent or transcripts) outside of Dialogflow. # If present, incoming audio is exported by Dialogflow to the configured Google Cloud Storage destination. Exposed at the following levels: - Agent level - Flow level - "uri": "A String", # Required. The Google Cloud Storage URI for the exported objects. A URI is of the form: `gs://bucket/object-name-or-prefix` Whether a full object name, or just a prefix, its usage depends on the Dialogflow operation. - }, - "dtmfSettings": { # Define behaviors for DTMF (dual tone multi frequency). # Settings for DTMF. Exposed at the following levels: - Agent level - Flow level - Page level - Parameter level. - "enabled": True or False, # If true, incoming audio is processed for DTMF (dual tone multi frequency) events. For example, if the caller presses a button on their telephone keypad and DTMF processing is enabled, Dialogflow will detect the event (e.g. a "3" was pressed) in the incoming audio and pass the event to the bot to drive business logic (e.g. when 3 is pressed, return the account balance). - "endpointingTimeoutDuration": "A String", # Endpoint timeout setting for matching dtmf input to regex. - "finishDigit": "A String", # The digit that terminates a DTMF digit sequence. - "interdigitTimeoutDuration": "A String", # Interdigit timeout setting for matching dtmf input to regex. - "maxDigits": 42, # Max length of DTMF digits. - }, - "loggingSettings": { # Define behaviors on logging. # Settings for logging. Settings for Dialogflow History, Contact Center messages, StackDriver logs, and speech logging. Exposed at the following levels: - Agent level. - "enableInteractionLogging": True or False, # If true, DF Interaction logging is currently enabled. - "enableStackdriverLogging": True or False, # If true, StackDriver logging is currently enabled. - }, - "speechSettings": { # Define behaviors of speech to text detection. # Settings for speech to text detection. Exposed at the following levels: - Agent level - Flow level - Page level - Parameter level - "endpointerSensitivity": 42, # Sensitivity of the speech model that detects the end of speech. Scale from 0 to 100. - "models": { # Mapping from language to Speech-to-Text model. The mapped Speech-to-Text model will be selected for requests from its corresponding language. For more information, see [Speech models](https://cloud.google.com/dialogflow/cx/docs/concept/speech-models). - "a_key": "A String", - }, - "noSpeechTimeout": "A String", # Timeout before detecting no speech. - "useTimeoutBasedEndpointing": True or False, # Use timeout based endpointing, interpreting endpointer sensitivy as seconds of timeout value. - }, - }, - "conditionalCases": [ # Conditional cases for this fulfillment. - { # A list of cascading if-else conditions. Cases are mutually exclusive. The first one with a matching condition is selected, all the rest ignored. - "cases": [ # A list of cascading if-else conditions. - { # Each case has a Boolean condition. When it is evaluated to be True, the corresponding messages will be selected and evaluated recursively. - "caseContent": [ # A list of case content. - { # The list of messages or conditional cases to activate for this case. - "additionalCases": # Object with schema name: GoogleCloudDialogflowCxV3beta1FulfillmentConditionalCases # Additional cases to be evaluated. - "message": { # 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. # Returned message. - "channel": "A String", # The channel which the response is associated with. Clients can specify the channel via QueryParameters.channel, and only associated channel response will be returned. - "conversationSuccess": { # 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. # Indicates that the conversation succeeded. - "metadata": { # Custom metadata. Dialogflow doesn't impose any structure on this. - "a_key": "", # Properties of the object. - }, - }, - "endInteraction": { # 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. # Output only. A signal that indicates the interaction with the Dialogflow agent has ended. This message is generated by Dialogflow only when the conversation reaches `END_SESSION` page. It is not supposed to be defined by the user. It's guaranteed that there is at most one such message in each response. - }, - "knowledgeInfoCard": { # Represents info card response. If the response contains generative knowledge prediction, Dialogflow will return a payload with Infobot Messenger compatible info card. Otherwise, the info card response is skipped. # Represents info card for knowledge answers, to be better rendered in Dialogflow Messenger. - }, - "liveAgentHandoff": { # 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. # Hands off conversation to a human agent. - "metadata": { # Custom metadata for your handoff procedure. Dialogflow doesn't impose any structure on this. - "a_key": "", # Properties of the object. - }, - }, - "mixedAudio": { # 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. # Output only. An audio response message composed of both the synthesized Dialogflow agent responses and responses defined via play_audio. This message is generated by Dialogflow only and not supposed to be defined by the user. - "segments": [ # Segments this audio response is composed of. - { # Represents one segment of audio. - "allowPlaybackInterruption": True or False, # 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. - "audio": "A String", # Raw audio synthesized from the Dialogflow agent's response using the output config specified in the request. - "uri": "A String", # Client-specific URI that points to an audio clip accessible to the client. Dialogflow does not impose any validation on it. - }, - ], - }, - "outputAudioText": { # A text or ssml response that is preferentially used for TTS output audio synthesis, as described in the comment on the ResponseMessage message. # A text or ssml response that is preferentially used for TTS output audio synthesis, as described in the comment on the ResponseMessage message. - "allowPlaybackInterruption": True or False, # 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. - "ssml": "A String", # The SSML text to be synthesized. For more information, see [SSML](/speech/text-to-speech/docs/ssml). - "text": "A String", # The raw text to be synthesized. - }, - "payload": { # Returns a response containing a custom, platform-specific payload. - "a_key": "", # Properties of the object. - }, - "playAudio": { # Specifies an audio clip to be played by the client as part of the response. # Signal that the client should play an audio clip hosted at a client-specific URI. Dialogflow uses this to construct mixed_audio. However, Dialogflow itself does not try to read or process the URI in any way. - "allowPlaybackInterruption": True or False, # 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. - "audioUri": "A String", # Required. URI of the audio clip. Dialogflow does not impose any validation on this value. It is specific to the client that reads it. - }, - "telephonyTransferCall": { # Represents the signal that telles the client to transfer the phone call connected to the agent to a third-party endpoint. # A signal that the client should transfer the phone call connected to this agent to a third-party endpoint. - "phoneNumber": "A String", # Transfer the call to a phone number in [E.164 format](https://en.wikipedia.org/wiki/E.164). - }, - "text": { # The text response message. # Returns a text response. - "allowPlaybackInterruption": True or False, # 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. - "text": [ # Required. A collection of text responses. - "A String", - ], - }, - }, - }, - ], - "condition": "A String", # The condition to activate and select this case. Empty means the condition is always true. The condition is evaluated against form parameters or session parameters. See the [conditions reference](https://cloud.google.com/dialogflow/cx/docs/reference/condition). - }, - ], - }, - ], - "enableGenerativeFallback": True or False, # If the flag is true, the agent will utilize LLM to generate a text response. If LLM generation fails, the defined responses in the fulfillment will be respected. This flag is only useful for fulfillments associated with no-match event handlers. - "messages": [ # The list of rich message responses to present to the user. - { # 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. + }, + "conditionalCases": [ # Conditional cases for this fulfillment. + { # A list of cascading if-else conditions. Cases are mutually exclusive. The first one with a matching condition is selected, all the rest ignored. + "cases": [ # A list of cascading if-else conditions. + { # Each case has a Boolean condition. When it is evaluated to be True, the corresponding messages will be selected and evaluated recursively. + "caseContent": [ # A list of case content. + { # The list of messages or conditional cases to activate for this case. + "additionalCases": # Object with schema name: GoogleCloudDialogflowCxV3beta1FulfillmentConditionalCases # Additional cases to be evaluated. + "message": { # 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. # Returned message. "channel": "A String", # The channel which the response is associated with. Clients can specify the channel via QueryParameters.channel, and only associated channel response will be returned. "conversationSuccess": { # 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. # Indicates that the conversation succeeded. "metadata": { # Custom metadata. Dialogflow doesn't impose any structure on this. @@ -933,119 +587,17 @@

Method Details

"A String", ], }, + "toolCall": { # Represents a call of a specific tool's action with the specified inputs. # Returns the definition of a tool call that should be executed by the client. + "action": "A String", # Required. The name of the tool's action associated with this call. + "inputParameters": { # Optional. The action's input parameters. + "a_key": "", # Properties of the object. + }, + "tool": "A String", # Required. The tool associated with this call. Format: `projects//locations//agents//tools/`. + }, }, - ], - "returnPartialResponses": True or False, # Whether Dialogflow should return currently queued fulfillment response messages in streaming APIs. If a webhook is specified, it happens before Dialogflow invokes webhook. Warning: 1) This flag only affects streaming API. Responses are still queued and returned once in non-streaming API. 2) The flag can be enabled in any fulfillment but only the first 3 partial responses will be returned. You may only want to apply it to fulfillments that have slow webhooks. - "setParameterActions": [ # Set parameter values before executing the webhook. - { # Setting a parameter value. - "parameter": "A String", # Display name of the parameter. - "value": "", # The new value of the parameter. A null value clears the parameter. - }, - ], - "tag": "A String", # The value of this field will be populated in the WebhookRequest `fulfillmentInfo.tag` field by Dialogflow when the associated webhook is called. The tag is typically used by the webhook service to identify which fulfillment is being called, but it could be used for other purposes. This field is required if `webhook` is specified. - "webhook": "A String", # The webhook to call. Format: `projects//locations//agents//webhooks/`. - }, - }, - ], - }, - "isList": True or False, # Indicates whether the parameter represents a list of values. - "redact": True or False, # Indicates whether the parameter content should be redacted in log. If redaction is enabled, the parameter content will be replaced by parameter name during logging. Note: the parameter content is subject to redaction if either parameter level redaction or entity type level redaction is enabled. - "required": True or False, # 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. - }, - ], - }, - "knowledgeConnectorSettings": { # The Knowledge Connector settings for this page or flow. This includes information such as the attached Knowledge Bases, and the way to execute fulfillment. # Optional. Knowledge connector configuration. - "dataStoreConnections": [ # Optional. List of related data store connections. - { # A data store connection. It represents a data store in Discovery Engine and the type of the contents it contains. - "dataStore": "A String", # The full name of the referenced data store. Formats: `projects/{project}/locations/{location}/collections/{collection}/dataStores/{data_store}` `projects/{project}/locations/{location}/dataStores/{data_store}` - "dataStoreType": "A String", # The type of the connected data store. - }, - ], - "enabled": True or False, # Whether Knowledge Connector is enabled or not. - "targetFlow": "A String", # The target flow to transition to. Format: `projects//locations//agents//flows/`. - "targetPage": "A String", # The target page to transition to. Format: `projects//locations//agents//flows//pages/`. - "triggerFulfillment": { # A fulfillment can do one or more of the following actions at the same time: * Generate rich message responses. * Set parameter values. * Call the webhook. Fulfillments can be called at various stages in the Page or Form lifecycle. For example, when a DetectIntentRequest drives a session to enter a new page, the page's entry fulfillment can add a static response to the QueryResult in the returning DetectIntentResponse, call the webhook (for example, to load user data from a database), or both. # The fulfillment to be triggered. When the answers from the Knowledge Connector are selected by Dialogflow, you can utitlize the request scoped parameter `$request.knowledge.answers` (contains up to the 5 highest confidence answers) and `$request.knowledge.questions` (contains the corresponding questions) to construct the fulfillment. - "advancedSettings": { # Hierarchical advanced settings for agent/flow/page/fulfillment/parameter. Settings exposed at lower level overrides the settings exposed at higher level. Overriding occurs at the sub-setting level. For example, the playback_interruption_settings at fulfillment level only overrides the playback_interruption_settings at the agent level, leaving other settings at the agent level unchanged. DTMF settings does not override each other. DTMF settings set at different levels define DTMF detections running in parallel. Hierarchy: Agent->Flow->Page->Fulfillment/Parameter. # Hierarchical advanced settings for this fulfillment. The settings exposed at the lower level overrides the settings exposed at the higher level. - "audioExportGcsDestination": { # Google Cloud Storage location for a Dialogflow operation that writes or exports objects (e.g. exported agent or transcripts) outside of Dialogflow. # If present, incoming audio is exported by Dialogflow to the configured Google Cloud Storage destination. Exposed at the following levels: - Agent level - Flow level - "uri": "A String", # Required. The Google Cloud Storage URI for the exported objects. A URI is of the form: `gs://bucket/object-name-or-prefix` Whether a full object name, or just a prefix, its usage depends on the Dialogflow operation. - }, - "dtmfSettings": { # Define behaviors for DTMF (dual tone multi frequency). # Settings for DTMF. Exposed at the following levels: - Agent level - Flow level - Page level - Parameter level. - "enabled": True or False, # If true, incoming audio is processed for DTMF (dual tone multi frequency) events. For example, if the caller presses a button on their telephone keypad and DTMF processing is enabled, Dialogflow will detect the event (e.g. a "3" was pressed) in the incoming audio and pass the event to the bot to drive business logic (e.g. when 3 is pressed, return the account balance). - "endpointingTimeoutDuration": "A String", # Endpoint timeout setting for matching dtmf input to regex. - "finishDigit": "A String", # The digit that terminates a DTMF digit sequence. - "interdigitTimeoutDuration": "A String", # Interdigit timeout setting for matching dtmf input to regex. - "maxDigits": 42, # Max length of DTMF digits. - }, - "loggingSettings": { # Define behaviors on logging. # Settings for logging. Settings for Dialogflow History, Contact Center messages, StackDriver logs, and speech logging. Exposed at the following levels: - Agent level. - "enableInteractionLogging": True or False, # If true, DF Interaction logging is currently enabled. - "enableStackdriverLogging": True or False, # If true, StackDriver logging is currently enabled. - }, - "speechSettings": { # Define behaviors of speech to text detection. # Settings for speech to text detection. Exposed at the following levels: - Agent level - Flow level - Page level - Parameter level - "endpointerSensitivity": 42, # Sensitivity of the speech model that detects the end of speech. Scale from 0 to 100. - "models": { # Mapping from language to Speech-to-Text model. The mapped Speech-to-Text model will be selected for requests from its corresponding language. For more information, see [Speech models](https://cloud.google.com/dialogflow/cx/docs/concept/speech-models). - "a_key": "A String", - }, - "noSpeechTimeout": "A String", # Timeout before detecting no speech. - "useTimeoutBasedEndpointing": True or False, # Use timeout based endpointing, interpreting endpointer sensitivy as seconds of timeout value. - }, - }, - "conditionalCases": [ # Conditional cases for this fulfillment. - { # A list of cascading if-else conditions. Cases are mutually exclusive. The first one with a matching condition is selected, all the rest ignored. - "cases": [ # A list of cascading if-else conditions. - { # Each case has a Boolean condition. When it is evaluated to be True, the corresponding messages will be selected and evaluated recursively. - "caseContent": [ # A list of case content. - { # The list of messages or conditional cases to activate for this case. - "additionalCases": # Object with schema name: GoogleCloudDialogflowCxV3beta1FulfillmentConditionalCases # Additional cases to be evaluated. - "message": { # 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. # Returned message. - "channel": "A String", # The channel which the response is associated with. Clients can specify the channel via QueryParameters.channel, and only associated channel response will be returned. - "conversationSuccess": { # 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. # Indicates that the conversation succeeded. - "metadata": { # Custom metadata. Dialogflow doesn't impose any structure on this. - "a_key": "", # Properties of the object. - }, - }, - "endInteraction": { # 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. # Output only. A signal that indicates the interaction with the Dialogflow agent has ended. This message is generated by Dialogflow only when the conversation reaches `END_SESSION` page. It is not supposed to be defined by the user. It's guaranteed that there is at most one such message in each response. - }, - "knowledgeInfoCard": { # Represents info card response. If the response contains generative knowledge prediction, Dialogflow will return a payload with Infobot Messenger compatible info card. Otherwise, the info card response is skipped. # Represents info card for knowledge answers, to be better rendered in Dialogflow Messenger. - }, - "liveAgentHandoff": { # 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. # Hands off conversation to a human agent. - "metadata": { # Custom metadata for your handoff procedure. Dialogflow doesn't impose any structure on this. - "a_key": "", # Properties of the object. - }, - }, - "mixedAudio": { # 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. # Output only. An audio response message composed of both the synthesized Dialogflow agent responses and responses defined via play_audio. This message is generated by Dialogflow only and not supposed to be defined by the user. - "segments": [ # Segments this audio response is composed of. - { # Represents one segment of audio. - "allowPlaybackInterruption": True or False, # 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. - "audio": "A String", # Raw audio synthesized from the Dialogflow agent's response using the output config specified in the request. - "uri": "A String", # Client-specific URI that points to an audio clip accessible to the client. Dialogflow does not impose any validation on it. - }, - ], - }, - "outputAudioText": { # A text or ssml response that is preferentially used for TTS output audio synthesis, as described in the comment on the ResponseMessage message. # A text or ssml response that is preferentially used for TTS output audio synthesis, as described in the comment on the ResponseMessage message. - "allowPlaybackInterruption": True or False, # 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. - "ssml": "A String", # The SSML text to be synthesized. For more information, see [SSML](/speech/text-to-speech/docs/ssml). - "text": "A String", # The raw text to be synthesized. - }, - "payload": { # Returns a response containing a custom, platform-specific payload. - "a_key": "", # Properties of the object. - }, - "playAudio": { # Specifies an audio clip to be played by the client as part of the response. # Signal that the client should play an audio clip hosted at a client-specific URI. Dialogflow uses this to construct mixed_audio. However, Dialogflow itself does not try to read or process the URI in any way. - "allowPlaybackInterruption": True or False, # 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. - "audioUri": "A String", # Required. URI of the audio clip. Dialogflow does not impose any validation on this value. It is specific to the client that reads it. - }, - "telephonyTransferCall": { # Represents the signal that telles the client to transfer the phone call connected to the agent to a third-party endpoint. # A signal that the client should transfer the phone call connected to this agent to a third-party endpoint. - "phoneNumber": "A String", # Transfer the call to a phone number in [E.164 format](https://en.wikipedia.org/wiki/E.164). - }, - "text": { # The text response message. # Returns a text response. - "allowPlaybackInterruption": True or False, # 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. - "text": [ # Required. A collection of text responses. - "A String", - ], - }, - }, - }, - ], - "condition": "A String", # The condition to activate and select this case. Empty means the condition is always true. The condition is evaluated against form parameters or session parameters. See the [conditions reference](https://cloud.google.com/dialogflow/cx/docs/reference/condition). + }, + ], + "condition": "A String", # The condition to activate and select this case. Empty means the condition is always true. The condition is evaluated against form parameters or session parameters. See the [conditions reference](https://cloud.google.com/dialogflow/cx/docs/reference/condition). }, ], }, @@ -1098,6 +650,13 @@

Method Details

"A String", ], }, + "toolCall": { # Represents a call of a specific tool's action with the specified inputs. # Returns the definition of a tool call that should be executed by the client. + "action": "A String", # Required. The name of the tool's action associated with this call. + "inputParameters": { # Optional. The action's input parameters. + "a_key": "", # Properties of the object. + }, + "tool": "A String", # Required. The tool associated with this call. Format: `projects//locations//agents//tools/`. + }, }, ], "returnPartialResponses": True or False, # Whether Dialogflow should return currently queued fulfillment response messages in streaming APIs. If a webhook is specified, it happens before Dialogflow invokes webhook. Warning: 1) This flag only affects streaming API. Responses are still queued and returned once in non-streaming API. 2) The flag can be enabled in any fulfillment but only the first 3 partial responses will be returned. You may only want to apply it to fulfillments that have slow webhooks. @@ -1111,11 +670,22 @@

Method Details

"webhook": "A String", # The webhook to call. Format: `projects//locations//agents//webhooks/`. }, }, - "name": "A String", # The unique identifier of the page. Required for the Pages.UpdatePage method. Pages.CreatePage populates the name automatically. Format: `projects//locations//agents//flows//pages/`. - "transitionRouteGroups": [ # Ordered list of `TransitionRouteGroups` added to the page. Transition route groups must be unique within a page. If the page links both flow-level transition route groups and agent-level transition route groups, the flow-level ones will have higher priority and will be put before the agent-level ones. * If multiple transition routes within a page scope refer to the same intent, then the precedence order is: page's transition route -> page's transition route group -> flow's transition routes. * If multiple transition route groups within a page contain the same intent, then the first group in the ordered list takes precedence. Format:`projects//locations//agents//flows//transitionRouteGroups/` or `projects//locations//agents//transitionRouteGroups/` for agent-level groups. + "multiLanguageSettings": { # Settings for multi-lingual agents. # Optional. Multi-lingual agent settings for this flow. + "enableMultiLanguageDetection": True or False, # Optional. Enable multi-language detection for this flow. This can be set only if agent level multi language setting is enabled. + "supportedResponseLanguageCodes": [ # Optional. Agent will respond in the detected language if the detected language code is in the supported resolved languages for this flow. This will be used only if multi-language training is enabled in the agent and multi-language detection is enabled in the flow. The supported languages must be a subset of the languages supported by the agent. + "A String", + ], + }, + "name": "A String", # The unique identifier of the flow. Format: `projects//locations//agents//flows/`. + "nluSettings": { # Settings related to NLU. # NLU related settings of the flow. + "classificationThreshold": 3.14, # To filter out false positive results and still get variety in matched natural language inputs for your agent, you can tune the machine learning classification threshold. If the returned score value is less than the threshold value, then a no-match event will be triggered. The score values range from 0.0 (completely uncertain) to 1.0 (completely certain). If set to 0.0, the default of 0.3 is used. + "modelTrainingMode": "A String", # Indicates NLU model training mode. + "modelType": "A String", # Indicates the type of NLU model. + }, + "transitionRouteGroups": [ # A flow's transition route group serve two purposes: * They are responsible for matching the user's first utterances in the flow. * They are inherited by every page's transition route groups. Transition route groups defined in the page have higher priority than those defined in the flow. Format:`projects//locations//agents//flows//transitionRouteGroups/` or `projects//locations//agents//transitionRouteGroups/` for agent-level groups. "A String", ], - "transitionRoutes": [ # A list of transitions for the transition rules of this page. They route the conversation to another page in the same flow, or another flow. When we are in a certain page, the TransitionRoutes are evalauted in the following order: * TransitionRoutes defined in the page with intent specified. * TransitionRoutes defined in the transition route groups with intent specified. * TransitionRoutes defined in flow with intent specified. * TransitionRoutes defined in the transition route groups with intent specified. * TransitionRoutes defined in the page with only condition specified. * TransitionRoutes defined in the transition route groups with only condition specified. + "transitionRoutes": [ # A flow's transition routes serve two purposes: * They are responsible for matching the user's first utterances in the flow. * They are inherited by every page's transition routes and can support use cases such as the user saying "help" or "can I talk to a human?", which can be handled in a common way regardless of the current page. Transition routes defined in the page have higher priority than those defined in the flow. TransitionRoutes are evalauted in the following order: * TransitionRoutes with intent specified. * TransitionRoutes with only condition specified. TransitionRoutes with intent specified are inherited by pages in the flow. { # A transition route specifies a intent that can be matched and/or a data condition that can be evaluated during a session. When a specified transition is matched, the following actions are taken in order: * If there is a `trigger_fulfillment` associated with the transition, it will be called. * If there is a `target_page` associated with the transition, the session will transition into the specified page. * If there is a `target_flow` associated with the transition, the session will transition into the specified flow. "condition": "A String", # The condition to evaluate against form parameters or session parameters. See the [conditions reference](https://cloud.google.com/dialogflow/cx/docs/reference/condition). At least one of `intent` or `condition` must be specified. When both `intent` and `condition` are specified, the transition can only happen when both are fulfilled. "description": "A String", # Optional. The description of the transition route. The maximum length is 500 characters. @@ -1136,8 +706,8 @@

Method Details

"maxDigits": 42, # Max length of DTMF digits. }, "loggingSettings": { # Define behaviors on logging. # Settings for logging. Settings for Dialogflow History, Contact Center messages, StackDriver logs, and speech logging. Exposed at the following levels: - Agent level. - "enableInteractionLogging": True or False, # If true, DF Interaction logging is currently enabled. - "enableStackdriverLogging": True or False, # If true, StackDriver logging is currently enabled. + "enableInteractionLogging": True or False, # Enables DF Interaction logging. + "enableStackdriverLogging": True or False, # Enables StackDriver logging. }, "speechSettings": { # Define behaviors of speech to text detection. # Settings for speech to text detection. Exposed at the following levels: - Agent level - Flow level - Page level - Parameter level "endpointerSensitivity": 42, # Sensitivity of the speech model that detects the end of speech. Scale from 0 to 100. @@ -1201,6 +771,13 @@

Method Details

"A String", ], }, + "toolCall": { # Represents a call of a specific tool's action with the specified inputs. # Returns the definition of a tool call that should be executed by the client. + "action": "A String", # Required. The name of the tool's action associated with this call. + "inputParameters": { # Optional. The action's input parameters. + "a_key": "", # Properties of the object. + }, + "tool": "A String", # Required. The tool associated with this call. Format: `projects//locations//agents//tools/`. + }, }, }, ], @@ -1257,6 +834,13 @@

Method Details

"A String", ], }, + "toolCall": { # Represents a call of a specific tool's action with the specified inputs. # Returns the definition of a tool call that should be executed by the client. + "action": "A String", # Required. The name of the tool's action associated with this call. + "inputParameters": { # Optional. The action's input parameters. + "a_key": "", # Properties of the object. + }, + "tool": "A String", # Required. The tool associated with this call. Format: `projects//locations//agents//tools/`. + }, }, ], "returnPartialResponses": True or False, # Whether Dialogflow should return currently queued fulfillment response messages in streaming APIs. If a webhook is specified, it happens before Dialogflow invokes webhook. Warning: 1) This flag only affects streaming API. Responses are still queued and returned once in non-streaming API. 2) The flag can be enabled in any fulfillment but only the first 3 partial responses will be returned. You may only want to apply it to fulfillments that have slow webhooks. @@ -1272,450 +856,2164 @@

Method Details

}, ], }, - "dataStoreConnectionSignals": { # Data store connection feature output signals. Might be only partially field if processing stop before the final answer. Reasons for this can be, but are not limited to: empty UCS search results, positive RAI check outcome, grounding failure, ... # Optional. Data store connection feature output signals. Filled only when data stores are involved in serving the query and DetectIntentRequest.populate data_store_connection_quality_signals is set to true in the request. - "answer": "A String", # Optional. The final compiled answer. - "answerGenerationModelCallSignals": { # Diagnostic info related to the answer generation model call. # Optional. Diagnostic info related to the answer generation model call. - "modelOutput": "A String", # Output of the generative model. - "renderedPrompt": "A String", # Prompt as sent to the model. - }, - "answerParts": [ # Optional. Answer parts with relevant citations. Concatenation of texts should add up the `answer` (not counting whitespaces). - { # Answer part with citation. - "supportingIndices": [ # Citations for this answer part. Indices of `search_snippets`. - 42, - ], - "text": "A String", # Substring of the answer. - }, - ], - "citedSnippets": [ # Optional. Snippets cited by the answer generation model from the most to least relevant. - { # Snippet cited by the answer generation model. - "searchSnippet": { # Search snippet details. # Details of the snippet. - "documentTitle": "A String", # Title of the enclosing document. - "documentUri": "A String", # Uri for the document. Present if specified for the document. - "text": "A String", # Text included in the prompt. - }, - "snippetIndex": 42, # Index of the snippet in `search_snippets` field. - }, - ], - "groundingSignals": { # Grounding signals. # Optional. Grounding signals. - "decision": "A String", # Represents the decision of the grounding check. - "score": "A String", # Grounding score bucket setting. - }, - "rewriterModelCallSignals": { # Diagnostic info related to the rewriter model call. # Optional. Diagnostic info related to the rewriter model call. - "modelOutput": "A String", # Output of the generative model. - "renderedPrompt": "A String", # Prompt as sent to the model. - }, - "rewrittenQuery": "A String", # Optional. Rewritten string query used for search. - "safetySignals": { # Safety check results. # Optional. Safety check result. - "bannedPhraseMatch": "A String", # Specifies banned phrase match subject. - "decision": "A String", # Safety decision. - "matchedBannedPhrase": "A String", # The matched banned phrase if there was a match. - }, - "searchSnippets": [ # Optional. Search snippets included in the answer generation prompt. - { # Search snippet details. - "documentTitle": "A String", # Title of the enclosing document. - "documentUri": "A String", # Uri for the document. Present if specified for the document. - "text": "A String", # Text included in the prompt. + "currentPage": { # A Dialogflow CX conversation (session) can be described and visualized as a state machine. The states of a CX session are represented by pages. For each flow, you define many pages, where your combined pages can handle a complete conversation on the topics the flow is designed for. At any given moment, exactly one page is the current page, the current page is considered active, and the flow associated with that page is considered active. Every flow has a special start page. When a flow initially becomes active, the start page page becomes the current page. For each conversational turn, the current page will either stay the same or transition to another page. You configure each page to collect information from the end-user that is relevant for the conversational state represented by the page. For more information, see the [Page guide](https://cloud.google.com/dialogflow/cx/docs/concept/page). # The current Page. Some, not all fields are filled in this message, including but not limited to `name` and `display_name`. + "advancedSettings": { # Hierarchical advanced settings for agent/flow/page/fulfillment/parameter. Settings exposed at lower level overrides the settings exposed at higher level. Overriding occurs at the sub-setting level. For example, the playback_interruption_settings at fulfillment level only overrides the playback_interruption_settings at the agent level, leaving other settings at the agent level unchanged. DTMF settings does not override each other. DTMF settings set at different levels define DTMF detections running in parallel. Hierarchy: Agent->Flow->Page->Fulfillment/Parameter. # Hierarchical advanced settings for this page. The settings exposed at the lower level overrides the settings exposed at the higher level. + "audioExportGcsDestination": { # Google Cloud Storage location for a Dialogflow operation that writes or exports objects (e.g. exported agent or transcripts) outside of Dialogflow. # If present, incoming audio is exported by Dialogflow to the configured Google Cloud Storage destination. Exposed at the following levels: - Agent level - Flow level + "uri": "A String", # Required. The Google Cloud Storage URI for the exported objects. A URI is of the form: `gs://bucket/object-name-or-prefix` Whether a full object name, or just a prefix, its usage depends on the Dialogflow operation. }, - ], - }, - "diagnosticInfo": { # The free-form diagnostic info. For example, this field could contain webhook call latency. The fields of this data can change without notice, so you should not write code that depends on its structure. One of the fields is called "Alternative Matched Intents", which may aid with debugging. The following describes these intent results: - The list is empty if no intent was matched to end-user input. - Only intents that are referenced in the currently active flow are included. - The matched intent is included. - Other intents that could have matched end-user input, but did not match because they are referenced by intent routes that are out of [scope](https://cloud.google.com/dialogflow/cx/docs/concept/handler#scope), are included. - Other intents referenced by intent routes in scope that matched end-user input, but had a lower confidence score. - "a_key": "", # Properties of the object. - }, - "dtmf": { # Represents the input for dtmf event. # If a DTMF was provided as input, this field will contain a copy of the DtmfInput. - "digits": "A String", # The dtmf digits. - "finishDigit": "A String", # The finish digit (if any). - }, - "intent": { # An intent represents a user's intent to interact with a conversational agent. You can provide information for the Dialogflow API to use to match user input to an intent by adding training phrases (i.e., examples of user input) to your intent. # The Intent that matched the conversational query. Some, not all fields are filled in this message, including but not limited to: `name` and `display_name`. This field is deprecated, please use QueryResult.match instead. - "description": "A String", # Human readable description for better understanding an intent like its scope, content, result etc. Maximum character limit: 140 characters. - "displayName": "A String", # Required. The human-readable name of the intent, unique within the agent. - "isFallback": True or False, # Indicates whether this is a fallback intent. Currently only default fallback intent is allowed in the agent, which is added upon agent creation. Adding training phrases to fallback intent is useful in the case of requests that are mistakenly matched, since training phrases assigned to fallback intents act as negative examples that triggers no-match event. - "labels": { # The key/value metadata to label an intent. Labels can contain lowercase letters, digits and the symbols '-' and '_'. International characters are allowed, including letters from unicase alphabets. Keys must start with a letter. Keys and values can be no longer than 63 characters and no more than 128 bytes. Prefix "sys-" is reserved for Dialogflow defined labels. Currently allowed Dialogflow defined labels include: * sys-head * sys-contextual The above labels do not require value. "sys-head" means the intent is a head intent. "sys-contextual" means the intent is a contextual intent. - "a_key": "A String", - }, - "name": "A String", # The unique identifier of the intent. Required for the Intents.UpdateIntent method. Intents.CreateIntent populates the name automatically. Format: `projects//locations//agents//intents/`. - "parameters": [ # The collection of parameters associated with the intent. - { # Represents an intent parameter. - "entityType": "A String", # Required. The entity type of the parameter. Format: `projects/-/locations/-/agents/-/entityTypes/` for system entity types (for example, `projects/-/locations/-/agents/-/entityTypes/sys.date`), or `projects//locations//agents//entityTypes/` for developer entity types. - "id": "A String", # Required. The unique identifier of the parameter. This field is used by training phrases to annotate their parts. - "isList": True or False, # Indicates whether the parameter represents a list of values. - "redact": True or False, # Indicates whether the parameter content should be redacted in log. If redaction is enabled, the parameter content will be replaced by parameter name during logging. Note: the parameter content is subject to redaction if either parameter level redaction or entity type level redaction is enabled. + "dtmfSettings": { # Define behaviors for DTMF (dual tone multi frequency). # Settings for DTMF. Exposed at the following levels: - Agent level - Flow level - Page level - Parameter level. + "enabled": True or False, # If true, incoming audio is processed for DTMF (dual tone multi frequency) events. For example, if the caller presses a button on their telephone keypad and DTMF processing is enabled, Dialogflow will detect the event (e.g. a "3" was pressed) in the incoming audio and pass the event to the bot to drive business logic (e.g. when 3 is pressed, return the account balance). + "endpointingTimeoutDuration": "A String", # Endpoint timeout setting for matching dtmf input to regex. + "finishDigit": "A String", # The digit that terminates a DTMF digit sequence. + "interdigitTimeoutDuration": "A String", # Interdigit timeout setting for matching dtmf input to regex. + "maxDigits": 42, # Max length of DTMF digits. }, - ], - "priority": 42, # 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. - "trainingPhrases": [ # The collection of training phrases the agent is trained on to identify the intent. - { # Represents an example that the agent is trained on to identify the intent. - "id": "A String", # Output only. The unique identifier of the training phrase. - "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 `parameter_id` field is set. - { # Represents a part of a training phrase. - "parameterId": "A String", # The parameter used to annotate this part of the training phrase. This field is required for annotated parts of the training phrase. - "text": "A String", # Required. The text for this part. - }, - ], - "repeatCount": 42, # Indicates how many times this example was added to the intent. + "loggingSettings": { # Define behaviors on logging. # Settings for logging. Settings for Dialogflow History, Contact Center messages, StackDriver logs, and speech logging. Exposed at the following levels: - Agent level. + "enableInteractionLogging": True or False, # Enables DF Interaction logging. + "enableStackdriverLogging": True or False, # Enables StackDriver logging. }, - ], - }, - "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. This field is deprecated, please use QueryResult.match instead. - "languageCode": "A String", # The language that was triggered during intent detection. See [Language Support](https://cloud.google.com/dialogflow/cx/docs/reference/language) for a list of the currently supported language codes. - "match": { # Represents one match result of MatchIntent. # Intent match result, could be an intent or an event. - "confidence": 3.14, # The confidence of this match. 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. - "event": "A String", # The event that matched the query. Filled for `EVENT`, `NO_MATCH` and `NO_INPUT` match types. - "intent": { # An intent represents a user's intent to interact with a conversational agent. You can provide information for the Dialogflow API to use to match user input to an intent by adding training phrases (i.e., examples of user input) to your intent. # The Intent that matched the query. Some, not all fields are filled in this message, including but not limited to: `name` and `display_name`. Only filled for `INTENT` match type. - "description": "A String", # Human readable description for better understanding an intent like its scope, content, result etc. Maximum character limit: 140 characters. - "displayName": "A String", # Required. The human-readable name of the intent, unique within the agent. - "isFallback": True or False, # Indicates whether this is a fallback intent. Currently only default fallback intent is allowed in the agent, which is added upon agent creation. Adding training phrases to fallback intent is useful in the case of requests that are mistakenly matched, since training phrases assigned to fallback intents act as negative examples that triggers no-match event. - "labels": { # The key/value metadata to label an intent. Labels can contain lowercase letters, digits and the symbols '-' and '_'. International characters are allowed, including letters from unicase alphabets. Keys must start with a letter. Keys and values can be no longer than 63 characters and no more than 128 bytes. Prefix "sys-" is reserved for Dialogflow defined labels. Currently allowed Dialogflow defined labels include: * sys-head * sys-contextual The above labels do not require value. "sys-head" means the intent is a head intent. "sys-contextual" means the intent is a contextual intent. - "a_key": "A String", + "speechSettings": { # Define behaviors of speech to text detection. # Settings for speech to text detection. Exposed at the following levels: - Agent level - Flow level - Page level - Parameter level + "endpointerSensitivity": 42, # Sensitivity of the speech model that detects the end of speech. Scale from 0 to 100. + "models": { # Mapping from language to Speech-to-Text model. The mapped Speech-to-Text model will be selected for requests from its corresponding language. For more information, see [Speech models](https://cloud.google.com/dialogflow/cx/docs/concept/speech-models). + "a_key": "A String", + }, + "noSpeechTimeout": "A String", # Timeout before detecting no speech. + "useTimeoutBasedEndpointing": True or False, # Use timeout based endpointing, interpreting endpointer sensitivy as seconds of timeout value. }, - "name": "A String", # The unique identifier of the intent. Required for the Intents.UpdateIntent method. Intents.CreateIntent populates the name automatically. Format: `projects//locations//agents//intents/`. - "parameters": [ # The collection of parameters associated with the intent. - { # Represents an intent parameter. - "entityType": "A String", # Required. The entity type of the parameter. Format: `projects/-/locations/-/agents/-/entityTypes/` for system entity types (for example, `projects/-/locations/-/agents/-/entityTypes/sys.date`), or `projects//locations//agents//entityTypes/` for developer entity types. - "id": "A String", # Required. The unique identifier of the parameter. This field is used by training phrases to annotate their parts. - "isList": True or False, # Indicates whether the parameter represents a list of values. - "redact": True or False, # Indicates whether the parameter content should be redacted in log. If redaction is enabled, the parameter content will be replaced by parameter name during logging. Note: the parameter content is subject to redaction if either parameter level redaction or entity type level redaction is enabled. + }, + "description": "A String", # The description of the page. The maximum length is 500 characters. + "displayName": "A String", # Required. The human-readable name of the page, unique within the flow. + "entryFulfillment": { # A fulfillment can do one or more of the following actions at the same time: * Generate rich message responses. * Set parameter values. * Call the webhook. Fulfillments can be called at various stages in the Page or Form lifecycle. For example, when a DetectIntentRequest drives a session to enter a new page, the page's entry fulfillment can add a static response to the QueryResult in the returning DetectIntentResponse, call the webhook (for example, to load user data from a database), or both. # The fulfillment to call when the session is entering the page. + "advancedSettings": { # Hierarchical advanced settings for agent/flow/page/fulfillment/parameter. Settings exposed at lower level overrides the settings exposed at higher level. Overriding occurs at the sub-setting level. For example, the playback_interruption_settings at fulfillment level only overrides the playback_interruption_settings at the agent level, leaving other settings at the agent level unchanged. DTMF settings does not override each other. DTMF settings set at different levels define DTMF detections running in parallel. Hierarchy: Agent->Flow->Page->Fulfillment/Parameter. # Hierarchical advanced settings for this fulfillment. The settings exposed at the lower level overrides the settings exposed at the higher level. + "audioExportGcsDestination": { # Google Cloud Storage location for a Dialogflow operation that writes or exports objects (e.g. exported agent or transcripts) outside of Dialogflow. # If present, incoming audio is exported by Dialogflow to the configured Google Cloud Storage destination. Exposed at the following levels: - Agent level - Flow level + "uri": "A String", # Required. The Google Cloud Storage URI for the exported objects. A URI is of the form: `gs://bucket/object-name-or-prefix` Whether a full object name, or just a prefix, its usage depends on the Dialogflow operation. }, - ], - "priority": 42, # 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. - "trainingPhrases": [ # The collection of training phrases the agent is trained on to identify the intent. - { # Represents an example that the agent is trained on to identify the intent. - "id": "A String", # Output only. The unique identifier of the training phrase. - "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 `parameter_id` field is set. - { # Represents a part of a training phrase. - "parameterId": "A String", # The parameter used to annotate this part of the training phrase. This field is required for annotated parts of the training phrase. - "text": "A String", # Required. The text for this part. - }, - ], - "repeatCount": 42, # Indicates how many times this example was added to the intent. + "dtmfSettings": { # Define behaviors for DTMF (dual tone multi frequency). # Settings for DTMF. Exposed at the following levels: - Agent level - Flow level - Page level - Parameter level. + "enabled": True or False, # If true, incoming audio is processed for DTMF (dual tone multi frequency) events. For example, if the caller presses a button on their telephone keypad and DTMF processing is enabled, Dialogflow will detect the event (e.g. a "3" was pressed) in the incoming audio and pass the event to the bot to drive business logic (e.g. when 3 is pressed, return the account balance). + "endpointingTimeoutDuration": "A String", # Endpoint timeout setting for matching dtmf input to regex. + "finishDigit": "A String", # The digit that terminates a DTMF digit sequence. + "interdigitTimeoutDuration": "A String", # Interdigit timeout setting for matching dtmf input to regex. + "maxDigits": 42, # Max length of DTMF digits. }, - ], - }, - "matchType": "A String", # Type of this Match. - "parameters": { # The collection of parameters extracted from the query. 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 then use map, otherwise, depending on the parameter value type, it could be one of string, number, boolean, null, list or map. * MapValue value: If parameter's entity type is a composite entity then use map from composite entity property names to property values, otherwise, use parameter value. - "a_key": "", # Properties of the object. - }, - "resolvedInput": "A String", # Final text input which was matched during MatchIntent. This value can be different from original input sent in request because of spelling correction or other processing. - }, - "parameters": { # The collected session 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 then use map, otherwise, depending on the parameter value type, it could be one of string, number, boolean, null, list or map. * MapValue value: If parameter's entity type is a composite entity then use map from composite entity property names to property values, otherwise, use parameter value. - "a_key": "", # Properties of the object. - }, - "responseMessages": [ # The list of rich messages returned to the client. Responses vary from simple text messages to more sophisticated, structured payloads used to drive complex logic. - { # 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. - "channel": "A String", # The channel which the response is associated with. Clients can specify the channel via QueryParameters.channel, and only associated channel response will be returned. - "conversationSuccess": { # 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. # Indicates that the conversation succeeded. - "metadata": { # Custom metadata. Dialogflow doesn't impose any structure on this. - "a_key": "", # Properties of the object. + "loggingSettings": { # Define behaviors on logging. # Settings for logging. Settings for Dialogflow History, Contact Center messages, StackDriver logs, and speech logging. Exposed at the following levels: - Agent level. + "enableInteractionLogging": True or False, # Enables DF Interaction logging. + "enableStackdriverLogging": True or False, # Enables StackDriver logging. + }, + "speechSettings": { # Define behaviors of speech to text detection. # Settings for speech to text detection. Exposed at the following levels: - Agent level - Flow level - Page level - Parameter level + "endpointerSensitivity": 42, # Sensitivity of the speech model that detects the end of speech. Scale from 0 to 100. + "models": { # Mapping from language to Speech-to-Text model. The mapped Speech-to-Text model will be selected for requests from its corresponding language. For more information, see [Speech models](https://cloud.google.com/dialogflow/cx/docs/concept/speech-models). + "a_key": "A String", + }, + "noSpeechTimeout": "A String", # Timeout before detecting no speech. + "useTimeoutBasedEndpointing": True or False, # Use timeout based endpointing, interpreting endpointer sensitivy as seconds of timeout value. }, }, - "endInteraction": { # 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. # Output only. A signal that indicates the interaction with the Dialogflow agent has ended. This message is generated by Dialogflow only when the conversation reaches `END_SESSION` page. It is not supposed to be defined by the user. It's guaranteed that there is at most one such message in each response. - }, - "knowledgeInfoCard": { # Represents info card response. If the response contains generative knowledge prediction, Dialogflow will return a payload with Infobot Messenger compatible info card. Otherwise, the info card response is skipped. # Represents info card for knowledge answers, to be better rendered in Dialogflow Messenger. - }, - "liveAgentHandoff": { # 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. # Hands off conversation to a human agent. - "metadata": { # Custom metadata for your handoff procedure. Dialogflow doesn't impose any structure on this. + "conditionalCases": [ # Conditional cases for this fulfillment. + { # A list of cascading if-else conditions. Cases are mutually exclusive. The first one with a matching condition is selected, all the rest ignored. + "cases": [ # A list of cascading if-else conditions. + { # Each case has a Boolean condition. When it is evaluated to be True, the corresponding messages will be selected and evaluated recursively. + "caseContent": [ # A list of case content. + { # The list of messages or conditional cases to activate for this case. + "additionalCases": # Object with schema name: GoogleCloudDialogflowCxV3beta1FulfillmentConditionalCases # Additional cases to be evaluated. + "message": { # 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. # Returned message. + "channel": "A String", # The channel which the response is associated with. Clients can specify the channel via QueryParameters.channel, and only associated channel response will be returned. + "conversationSuccess": { # 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. # Indicates that the conversation succeeded. + "metadata": { # Custom metadata. Dialogflow doesn't impose any structure on this. + "a_key": "", # Properties of the object. + }, + }, + "endInteraction": { # 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. # Output only. A signal that indicates the interaction with the Dialogflow agent has ended. This message is generated by Dialogflow only when the conversation reaches `END_SESSION` page. It is not supposed to be defined by the user. It's guaranteed that there is at most one such message in each response. + }, + "knowledgeInfoCard": { # Represents info card response. If the response contains generative knowledge prediction, Dialogflow will return a payload with Infobot Messenger compatible info card. Otherwise, the info card response is skipped. # Represents info card for knowledge answers, to be better rendered in Dialogflow Messenger. + }, + "liveAgentHandoff": { # 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. # Hands off conversation to a human agent. + "metadata": { # Custom metadata for your handoff procedure. Dialogflow doesn't impose any structure on this. + "a_key": "", # Properties of the object. + }, + }, + "mixedAudio": { # 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. # Output only. An audio response message composed of both the synthesized Dialogflow agent responses and responses defined via play_audio. This message is generated by Dialogflow only and not supposed to be defined by the user. + "segments": [ # Segments this audio response is composed of. + { # Represents one segment of audio. + "allowPlaybackInterruption": True or False, # 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. + "audio": "A String", # Raw audio synthesized from the Dialogflow agent's response using the output config specified in the request. + "uri": "A String", # Client-specific URI that points to an audio clip accessible to the client. Dialogflow does not impose any validation on it. + }, + ], + }, + "outputAudioText": { # A text or ssml response that is preferentially used for TTS output audio synthesis, as described in the comment on the ResponseMessage message. # A text or ssml response that is preferentially used for TTS output audio synthesis, as described in the comment on the ResponseMessage message. + "allowPlaybackInterruption": True or False, # 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. + "ssml": "A String", # The SSML text to be synthesized. For more information, see [SSML](/speech/text-to-speech/docs/ssml). + "text": "A String", # The raw text to be synthesized. + }, + "payload": { # Returns a response containing a custom, platform-specific payload. + "a_key": "", # Properties of the object. + }, + "playAudio": { # Specifies an audio clip to be played by the client as part of the response. # Signal that the client should play an audio clip hosted at a client-specific URI. Dialogflow uses this to construct mixed_audio. However, Dialogflow itself does not try to read or process the URI in any way. + "allowPlaybackInterruption": True or False, # 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. + "audioUri": "A String", # Required. URI of the audio clip. Dialogflow does not impose any validation on this value. It is specific to the client that reads it. + }, + "telephonyTransferCall": { # Represents the signal that telles the client to transfer the phone call connected to the agent to a third-party endpoint. # A signal that the client should transfer the phone call connected to this agent to a third-party endpoint. + "phoneNumber": "A String", # Transfer the call to a phone number in [E.164 format](https://en.wikipedia.org/wiki/E.164). + }, + "text": { # The text response message. # Returns a text response. + "allowPlaybackInterruption": True or False, # 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. + "text": [ # Required. A collection of text responses. + "A String", + ], + }, + "toolCall": { # Represents a call of a specific tool's action with the specified inputs. # Returns the definition of a tool call that should be executed by the client. + "action": "A String", # Required. The name of the tool's action associated with this call. + "inputParameters": { # Optional. The action's input parameters. + "a_key": "", # Properties of the object. + }, + "tool": "A String", # Required. The tool associated with this call. Format: `projects//locations//agents//tools/`. + }, + }, + }, + ], + "condition": "A String", # The condition to activate and select this case. Empty means the condition is always true. The condition is evaluated against form parameters or session parameters. See the [conditions reference](https://cloud.google.com/dialogflow/cx/docs/reference/condition). + }, + ], + }, + ], + "enableGenerativeFallback": True or False, # If the flag is true, the agent will utilize LLM to generate a text response. If LLM generation fails, the defined responses in the fulfillment will be respected. This flag is only useful for fulfillments associated with no-match event handlers. + "messages": [ # The list of rich message responses to present to the user. + { # 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. + "channel": "A String", # The channel which the response is associated with. Clients can specify the channel via QueryParameters.channel, and only associated channel response will be returned. + "conversationSuccess": { # 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. # Indicates that the conversation succeeded. + "metadata": { # Custom metadata. Dialogflow doesn't impose any structure on this. + "a_key": "", # Properties of the object. + }, + }, + "endInteraction": { # 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. # Output only. A signal that indicates the interaction with the Dialogflow agent has ended. This message is generated by Dialogflow only when the conversation reaches `END_SESSION` page. It is not supposed to be defined by the user. It's guaranteed that there is at most one such message in each response. + }, + "knowledgeInfoCard": { # Represents info card response. If the response contains generative knowledge prediction, Dialogflow will return a payload with Infobot Messenger compatible info card. Otherwise, the info card response is skipped. # Represents info card for knowledge answers, to be better rendered in Dialogflow Messenger. + }, + "liveAgentHandoff": { # 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. # Hands off conversation to a human agent. + "metadata": { # Custom metadata for your handoff procedure. Dialogflow doesn't impose any structure on this. + "a_key": "", # Properties of the object. + }, + }, + "mixedAudio": { # 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. # Output only. An audio response message composed of both the synthesized Dialogflow agent responses and responses defined via play_audio. This message is generated by Dialogflow only and not supposed to be defined by the user. + "segments": [ # Segments this audio response is composed of. + { # Represents one segment of audio. + "allowPlaybackInterruption": True or False, # 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. + "audio": "A String", # Raw audio synthesized from the Dialogflow agent's response using the output config specified in the request. + "uri": "A String", # Client-specific URI that points to an audio clip accessible to the client. Dialogflow does not impose any validation on it. + }, + ], + }, + "outputAudioText": { # A text or ssml response that is preferentially used for TTS output audio synthesis, as described in the comment on the ResponseMessage message. # A text or ssml response that is preferentially used for TTS output audio synthesis, as described in the comment on the ResponseMessage message. + "allowPlaybackInterruption": True or False, # 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. + "ssml": "A String", # The SSML text to be synthesized. For more information, see [SSML](/speech/text-to-speech/docs/ssml). + "text": "A String", # The raw text to be synthesized. + }, + "payload": { # Returns a response containing a custom, platform-specific payload. + "a_key": "", # Properties of the object. + }, + "playAudio": { # Specifies an audio clip to be played by the client as part of the response. # Signal that the client should play an audio clip hosted at a client-specific URI. Dialogflow uses this to construct mixed_audio. However, Dialogflow itself does not try to read or process the URI in any way. + "allowPlaybackInterruption": True or False, # 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. + "audioUri": "A String", # Required. URI of the audio clip. Dialogflow does not impose any validation on this value. It is specific to the client that reads it. + }, + "telephonyTransferCall": { # Represents the signal that telles the client to transfer the phone call connected to the agent to a third-party endpoint. # A signal that the client should transfer the phone call connected to this agent to a third-party endpoint. + "phoneNumber": "A String", # Transfer the call to a phone number in [E.164 format](https://en.wikipedia.org/wiki/E.164). + }, + "text": { # The text response message. # Returns a text response. + "allowPlaybackInterruption": True or False, # 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. + "text": [ # Required. A collection of text responses. + "A String", + ], + }, + "toolCall": { # Represents a call of a specific tool's action with the specified inputs. # Returns the definition of a tool call that should be executed by the client. + "action": "A String", # Required. The name of the tool's action associated with this call. + "inputParameters": { # Optional. The action's input parameters. + "a_key": "", # Properties of the object. + }, + "tool": "A String", # Required. The tool associated with this call. Format: `projects//locations//agents//tools/`. + }, + }, + ], + "returnPartialResponses": True or False, # Whether Dialogflow should return currently queued fulfillment response messages in streaming APIs. If a webhook is specified, it happens before Dialogflow invokes webhook. Warning: 1) This flag only affects streaming API. Responses are still queued and returned once in non-streaming API. 2) The flag can be enabled in any fulfillment but only the first 3 partial responses will be returned. You may only want to apply it to fulfillments that have slow webhooks. + "setParameterActions": [ # Set parameter values before executing the webhook. + { # Setting a parameter value. + "parameter": "A String", # Display name of the parameter. + "value": "", # The new value of the parameter. A null value clears the parameter. + }, + ], + "tag": "A String", # The value of this field will be populated in the WebhookRequest `fulfillmentInfo.tag` field by Dialogflow when the associated webhook is called. The tag is typically used by the webhook service to identify which fulfillment is being called, but it could be used for other purposes. This field is required if `webhook` is specified. + "webhook": "A String", # The webhook to call. Format: `projects//locations//agents//webhooks/`. + }, + "eventHandlers": [ # Handlers associated with the page to handle events such as webhook errors, no match or no input. + { # An event handler specifies an event that can be handled during a session. When the specified event happens, the following actions are taken in order: * If there is a `trigger_fulfillment` associated with the event, it will be called. * If there is a `target_page` associated with the event, the session will transition into the specified page. * If there is a `target_flow` associated with the event, the session will transition into the specified flow. + "event": "A String", # Required. The name of the event to handle. + "name": "A String", # Output only. The unique identifier of this event handler. + "targetFlow": "A String", # The target flow to transition to. Format: `projects//locations//agents//flows/`. + "targetPage": "A String", # The target page to transition to. Format: `projects//locations//agents//flows//pages/`. + "triggerFulfillment": { # A fulfillment can do one or more of the following actions at the same time: * Generate rich message responses. * Set parameter values. * Call the webhook. Fulfillments can be called at various stages in the Page or Form lifecycle. For example, when a DetectIntentRequest drives a session to enter a new page, the page's entry fulfillment can add a static response to the QueryResult in the returning DetectIntentResponse, call the webhook (for example, to load user data from a database), or both. # The fulfillment to call when the event occurs. Handling webhook errors with a fulfillment enabled with webhook could cause infinite loop. It is invalid to specify such fulfillment for a handler handling webhooks. + "advancedSettings": { # Hierarchical advanced settings for agent/flow/page/fulfillment/parameter. Settings exposed at lower level overrides the settings exposed at higher level. Overriding occurs at the sub-setting level. For example, the playback_interruption_settings at fulfillment level only overrides the playback_interruption_settings at the agent level, leaving other settings at the agent level unchanged. DTMF settings does not override each other. DTMF settings set at different levels define DTMF detections running in parallel. Hierarchy: Agent->Flow->Page->Fulfillment/Parameter. # Hierarchical advanced settings for this fulfillment. The settings exposed at the lower level overrides the settings exposed at the higher level. + "audioExportGcsDestination": { # Google Cloud Storage location for a Dialogflow operation that writes or exports objects (e.g. exported agent or transcripts) outside of Dialogflow. # If present, incoming audio is exported by Dialogflow to the configured Google Cloud Storage destination. Exposed at the following levels: - Agent level - Flow level + "uri": "A String", # Required. The Google Cloud Storage URI for the exported objects. A URI is of the form: `gs://bucket/object-name-or-prefix` Whether a full object name, or just a prefix, its usage depends on the Dialogflow operation. + }, + "dtmfSettings": { # Define behaviors for DTMF (dual tone multi frequency). # Settings for DTMF. Exposed at the following levels: - Agent level - Flow level - Page level - Parameter level. + "enabled": True or False, # If true, incoming audio is processed for DTMF (dual tone multi frequency) events. For example, if the caller presses a button on their telephone keypad and DTMF processing is enabled, Dialogflow will detect the event (e.g. a "3" was pressed) in the incoming audio and pass the event to the bot to drive business logic (e.g. when 3 is pressed, return the account balance). + "endpointingTimeoutDuration": "A String", # Endpoint timeout setting for matching dtmf input to regex. + "finishDigit": "A String", # The digit that terminates a DTMF digit sequence. + "interdigitTimeoutDuration": "A String", # Interdigit timeout setting for matching dtmf input to regex. + "maxDigits": 42, # Max length of DTMF digits. + }, + "loggingSettings": { # Define behaviors on logging. # Settings for logging. Settings for Dialogflow History, Contact Center messages, StackDriver logs, and speech logging. Exposed at the following levels: - Agent level. + "enableInteractionLogging": True or False, # Enables DF Interaction logging. + "enableStackdriverLogging": True or False, # Enables StackDriver logging. + }, + "speechSettings": { # Define behaviors of speech to text detection. # Settings for speech to text detection. Exposed at the following levels: - Agent level - Flow level - Page level - Parameter level + "endpointerSensitivity": 42, # Sensitivity of the speech model that detects the end of speech. Scale from 0 to 100. + "models": { # Mapping from language to Speech-to-Text model. The mapped Speech-to-Text model will be selected for requests from its corresponding language. For more information, see [Speech models](https://cloud.google.com/dialogflow/cx/docs/concept/speech-models). + "a_key": "A String", + }, + "noSpeechTimeout": "A String", # Timeout before detecting no speech. + "useTimeoutBasedEndpointing": True or False, # Use timeout based endpointing, interpreting endpointer sensitivy as seconds of timeout value. + }, + }, + "conditionalCases": [ # Conditional cases for this fulfillment. + { # A list of cascading if-else conditions. Cases are mutually exclusive. The first one with a matching condition is selected, all the rest ignored. + "cases": [ # A list of cascading if-else conditions. + { # Each case has a Boolean condition. When it is evaluated to be True, the corresponding messages will be selected and evaluated recursively. + "caseContent": [ # A list of case content. + { # The list of messages or conditional cases to activate for this case. + "additionalCases": # Object with schema name: GoogleCloudDialogflowCxV3beta1FulfillmentConditionalCases # Additional cases to be evaluated. + "message": { # 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. # Returned message. + "channel": "A String", # The channel which the response is associated with. Clients can specify the channel via QueryParameters.channel, and only associated channel response will be returned. + "conversationSuccess": { # 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. # Indicates that the conversation succeeded. + "metadata": { # Custom metadata. Dialogflow doesn't impose any structure on this. + "a_key": "", # Properties of the object. + }, + }, + "endInteraction": { # 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. # Output only. A signal that indicates the interaction with the Dialogflow agent has ended. This message is generated by Dialogflow only when the conversation reaches `END_SESSION` page. It is not supposed to be defined by the user. It's guaranteed that there is at most one such message in each response. + }, + "knowledgeInfoCard": { # Represents info card response. If the response contains generative knowledge prediction, Dialogflow will return a payload with Infobot Messenger compatible info card. Otherwise, the info card response is skipped. # Represents info card for knowledge answers, to be better rendered in Dialogflow Messenger. + }, + "liveAgentHandoff": { # 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. # Hands off conversation to a human agent. + "metadata": { # Custom metadata for your handoff procedure. Dialogflow doesn't impose any structure on this. + "a_key": "", # Properties of the object. + }, + }, + "mixedAudio": { # 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. # Output only. An audio response message composed of both the synthesized Dialogflow agent responses and responses defined via play_audio. This message is generated by Dialogflow only and not supposed to be defined by the user. + "segments": [ # Segments this audio response is composed of. + { # Represents one segment of audio. + "allowPlaybackInterruption": True or False, # 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. + "audio": "A String", # Raw audio synthesized from the Dialogflow agent's response using the output config specified in the request. + "uri": "A String", # Client-specific URI that points to an audio clip accessible to the client. Dialogflow does not impose any validation on it. + }, + ], + }, + "outputAudioText": { # A text or ssml response that is preferentially used for TTS output audio synthesis, as described in the comment on the ResponseMessage message. # A text or ssml response that is preferentially used for TTS output audio synthesis, as described in the comment on the ResponseMessage message. + "allowPlaybackInterruption": True or False, # 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. + "ssml": "A String", # The SSML text to be synthesized. For more information, see [SSML](/speech/text-to-speech/docs/ssml). + "text": "A String", # The raw text to be synthesized. + }, + "payload": { # Returns a response containing a custom, platform-specific payload. + "a_key": "", # Properties of the object. + }, + "playAudio": { # Specifies an audio clip to be played by the client as part of the response. # Signal that the client should play an audio clip hosted at a client-specific URI. Dialogflow uses this to construct mixed_audio. However, Dialogflow itself does not try to read or process the URI in any way. + "allowPlaybackInterruption": True or False, # 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. + "audioUri": "A String", # Required. URI of the audio clip. Dialogflow does not impose any validation on this value. It is specific to the client that reads it. + }, + "telephonyTransferCall": { # Represents the signal that telles the client to transfer the phone call connected to the agent to a third-party endpoint. # A signal that the client should transfer the phone call connected to this agent to a third-party endpoint. + "phoneNumber": "A String", # Transfer the call to a phone number in [E.164 format](https://en.wikipedia.org/wiki/E.164). + }, + "text": { # The text response message. # Returns a text response. + "allowPlaybackInterruption": True or False, # 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. + "text": [ # Required. A collection of text responses. + "A String", + ], + }, + "toolCall": { # Represents a call of a specific tool's action with the specified inputs. # Returns the definition of a tool call that should be executed by the client. + "action": "A String", # Required. The name of the tool's action associated with this call. + "inputParameters": { # Optional. The action's input parameters. + "a_key": "", # Properties of the object. + }, + "tool": "A String", # Required. The tool associated with this call. Format: `projects//locations//agents//tools/`. + }, + }, + }, + ], + "condition": "A String", # The condition to activate and select this case. Empty means the condition is always true. The condition is evaluated against form parameters or session parameters. See the [conditions reference](https://cloud.google.com/dialogflow/cx/docs/reference/condition). + }, + ], + }, + ], + "enableGenerativeFallback": True or False, # If the flag is true, the agent will utilize LLM to generate a text response. If LLM generation fails, the defined responses in the fulfillment will be respected. This flag is only useful for fulfillments associated with no-match event handlers. + "messages": [ # The list of rich message responses to present to the user. + { # 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. + "channel": "A String", # The channel which the response is associated with. Clients can specify the channel via QueryParameters.channel, and only associated channel response will be returned. + "conversationSuccess": { # 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. # Indicates that the conversation succeeded. + "metadata": { # Custom metadata. Dialogflow doesn't impose any structure on this. + "a_key": "", # Properties of the object. + }, + }, + "endInteraction": { # 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. # Output only. A signal that indicates the interaction with the Dialogflow agent has ended. This message is generated by Dialogflow only when the conversation reaches `END_SESSION` page. It is not supposed to be defined by the user. It's guaranteed that there is at most one such message in each response. + }, + "knowledgeInfoCard": { # Represents info card response. If the response contains generative knowledge prediction, Dialogflow will return a payload with Infobot Messenger compatible info card. Otherwise, the info card response is skipped. # Represents info card for knowledge answers, to be better rendered in Dialogflow Messenger. + }, + "liveAgentHandoff": { # 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. # Hands off conversation to a human agent. + "metadata": { # Custom metadata for your handoff procedure. Dialogflow doesn't impose any structure on this. + "a_key": "", # Properties of the object. + }, + }, + "mixedAudio": { # 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. # Output only. An audio response message composed of both the synthesized Dialogflow agent responses and responses defined via play_audio. This message is generated by Dialogflow only and not supposed to be defined by the user. + "segments": [ # Segments this audio response is composed of. + { # Represents one segment of audio. + "allowPlaybackInterruption": True or False, # 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. + "audio": "A String", # Raw audio synthesized from the Dialogflow agent's response using the output config specified in the request. + "uri": "A String", # Client-specific URI that points to an audio clip accessible to the client. Dialogflow does not impose any validation on it. + }, + ], + }, + "outputAudioText": { # A text or ssml response that is preferentially used for TTS output audio synthesis, as described in the comment on the ResponseMessage message. # A text or ssml response that is preferentially used for TTS output audio synthesis, as described in the comment on the ResponseMessage message. + "allowPlaybackInterruption": True or False, # 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. + "ssml": "A String", # The SSML text to be synthesized. For more information, see [SSML](/speech/text-to-speech/docs/ssml). + "text": "A String", # The raw text to be synthesized. + }, + "payload": { # Returns a response containing a custom, platform-specific payload. + "a_key": "", # Properties of the object. + }, + "playAudio": { # Specifies an audio clip to be played by the client as part of the response. # Signal that the client should play an audio clip hosted at a client-specific URI. Dialogflow uses this to construct mixed_audio. However, Dialogflow itself does not try to read or process the URI in any way. + "allowPlaybackInterruption": True or False, # 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. + "audioUri": "A String", # Required. URI of the audio clip. Dialogflow does not impose any validation on this value. It is specific to the client that reads it. + }, + "telephonyTransferCall": { # Represents the signal that telles the client to transfer the phone call connected to the agent to a third-party endpoint. # A signal that the client should transfer the phone call connected to this agent to a third-party endpoint. + "phoneNumber": "A String", # Transfer the call to a phone number in [E.164 format](https://en.wikipedia.org/wiki/E.164). + }, + "text": { # The text response message. # Returns a text response. + "allowPlaybackInterruption": True or False, # 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. + "text": [ # Required. A collection of text responses. + "A String", + ], + }, + "toolCall": { # Represents a call of a specific tool's action with the specified inputs. # Returns the definition of a tool call that should be executed by the client. + "action": "A String", # Required. The name of the tool's action associated with this call. + "inputParameters": { # Optional. The action's input parameters. + "a_key": "", # Properties of the object. + }, + "tool": "A String", # Required. The tool associated with this call. Format: `projects//locations//agents//tools/`. + }, + }, + ], + "returnPartialResponses": True or False, # Whether Dialogflow should return currently queued fulfillment response messages in streaming APIs. If a webhook is specified, it happens before Dialogflow invokes webhook. Warning: 1) This flag only affects streaming API. Responses are still queued and returned once in non-streaming API. 2) The flag can be enabled in any fulfillment but only the first 3 partial responses will be returned. You may only want to apply it to fulfillments that have slow webhooks. + "setParameterActions": [ # Set parameter values before executing the webhook. + { # Setting a parameter value. + "parameter": "A String", # Display name of the parameter. + "value": "", # The new value of the parameter. A null value clears the parameter. + }, + ], + "tag": "A String", # The value of this field will be populated in the WebhookRequest `fulfillmentInfo.tag` field by Dialogflow when the associated webhook is called. The tag is typically used by the webhook service to identify which fulfillment is being called, but it could be used for other purposes. This field is required if `webhook` is specified. + "webhook": "A String", # The webhook to call. Format: `projects//locations//agents//webhooks/`. + }, + }, + ], + "form": { # A form is a data model that groups related parameters that can be collected from the user. The process in which the agent prompts the user and collects parameter values from the user is called form filling. A form can be added to a page. When form filling is done, the filled parameters will be written to the session. # The form associated with the page, used for collecting parameters relevant to the page. + "parameters": [ # Parameters to collect from the user. + { # Represents a form parameter. + "advancedSettings": { # Hierarchical advanced settings for agent/flow/page/fulfillment/parameter. Settings exposed at lower level overrides the settings exposed at higher level. Overriding occurs at the sub-setting level. For example, the playback_interruption_settings at fulfillment level only overrides the playback_interruption_settings at the agent level, leaving other settings at the agent level unchanged. DTMF settings does not override each other. DTMF settings set at different levels define DTMF detections running in parallel. Hierarchy: Agent->Flow->Page->Fulfillment/Parameter. # Hierarchical advanced settings for this parameter. The settings exposed at the lower level overrides the settings exposed at the higher level. + "audioExportGcsDestination": { # Google Cloud Storage location for a Dialogflow operation that writes or exports objects (e.g. exported agent or transcripts) outside of Dialogflow. # If present, incoming audio is exported by Dialogflow to the configured Google Cloud Storage destination. Exposed at the following levels: - Agent level - Flow level + "uri": "A String", # Required. The Google Cloud Storage URI for the exported objects. A URI is of the form: `gs://bucket/object-name-or-prefix` Whether a full object name, or just a prefix, its usage depends on the Dialogflow operation. + }, + "dtmfSettings": { # Define behaviors for DTMF (dual tone multi frequency). # Settings for DTMF. Exposed at the following levels: - Agent level - Flow level - Page level - Parameter level. + "enabled": True or False, # If true, incoming audio is processed for DTMF (dual tone multi frequency) events. For example, if the caller presses a button on their telephone keypad and DTMF processing is enabled, Dialogflow will detect the event (e.g. a "3" was pressed) in the incoming audio and pass the event to the bot to drive business logic (e.g. when 3 is pressed, return the account balance). + "endpointingTimeoutDuration": "A String", # Endpoint timeout setting for matching dtmf input to regex. + "finishDigit": "A String", # The digit that terminates a DTMF digit sequence. + "interdigitTimeoutDuration": "A String", # Interdigit timeout setting for matching dtmf input to regex. + "maxDigits": 42, # Max length of DTMF digits. + }, + "loggingSettings": { # Define behaviors on logging. # Settings for logging. Settings for Dialogflow History, Contact Center messages, StackDriver logs, and speech logging. Exposed at the following levels: - Agent level. + "enableInteractionLogging": True or False, # Enables DF Interaction logging. + "enableStackdriverLogging": True or False, # Enables StackDriver logging. + }, + "speechSettings": { # Define behaviors of speech to text detection. # Settings for speech to text detection. Exposed at the following levels: - Agent level - Flow level - Page level - Parameter level + "endpointerSensitivity": 42, # Sensitivity of the speech model that detects the end of speech. Scale from 0 to 100. + "models": { # Mapping from language to Speech-to-Text model. The mapped Speech-to-Text model will be selected for requests from its corresponding language. For more information, see [Speech models](https://cloud.google.com/dialogflow/cx/docs/concept/speech-models). + "a_key": "A String", + }, + "noSpeechTimeout": "A String", # Timeout before detecting no speech. + "useTimeoutBasedEndpointing": True or False, # Use timeout based endpointing, interpreting endpointer sensitivy as seconds of timeout value. + }, + }, + "defaultValue": "", # The default value of an optional parameter. If the parameter is required, the default value will be ignored. + "displayName": "A String", # Required. The human-readable name of the parameter, unique within the form. + "entityType": "A String", # Required. The entity type of the parameter. Format: `projects/-/locations/-/agents/-/entityTypes/` for system entity types (for example, `projects/-/locations/-/agents/-/entityTypes/sys.date`), or `projects//locations//agents//entityTypes/` for developer entity types. + "fillBehavior": { # Configuration for how the filling of a parameter should be handled. # Required. Defines fill behavior for the parameter. + "initialPromptFulfillment": { # A fulfillment can do one or more of the following actions at the same time: * Generate rich message responses. * Set parameter values. * Call the webhook. Fulfillments can be called at various stages in the Page or Form lifecycle. For example, when a DetectIntentRequest drives a session to enter a new page, the page's entry fulfillment can add a static response to the QueryResult in the returning DetectIntentResponse, call the webhook (for example, to load user data from a database), or both. # Required. The fulfillment to provide the initial prompt that the agent can present to the user in order to fill the parameter. + "advancedSettings": { # Hierarchical advanced settings for agent/flow/page/fulfillment/parameter. Settings exposed at lower level overrides the settings exposed at higher level. Overriding occurs at the sub-setting level. For example, the playback_interruption_settings at fulfillment level only overrides the playback_interruption_settings at the agent level, leaving other settings at the agent level unchanged. DTMF settings does not override each other. DTMF settings set at different levels define DTMF detections running in parallel. Hierarchy: Agent->Flow->Page->Fulfillment/Parameter. # Hierarchical advanced settings for this fulfillment. The settings exposed at the lower level overrides the settings exposed at the higher level. + "audioExportGcsDestination": { # Google Cloud Storage location for a Dialogflow operation that writes or exports objects (e.g. exported agent or transcripts) outside of Dialogflow. # If present, incoming audio is exported by Dialogflow to the configured Google Cloud Storage destination. Exposed at the following levels: - Agent level - Flow level + "uri": "A String", # Required. The Google Cloud Storage URI for the exported objects. A URI is of the form: `gs://bucket/object-name-or-prefix` Whether a full object name, or just a prefix, its usage depends on the Dialogflow operation. + }, + "dtmfSettings": { # Define behaviors for DTMF (dual tone multi frequency). # Settings for DTMF. Exposed at the following levels: - Agent level - Flow level - Page level - Parameter level. + "enabled": True or False, # If true, incoming audio is processed for DTMF (dual tone multi frequency) events. For example, if the caller presses a button on their telephone keypad and DTMF processing is enabled, Dialogflow will detect the event (e.g. a "3" was pressed) in the incoming audio and pass the event to the bot to drive business logic (e.g. when 3 is pressed, return the account balance). + "endpointingTimeoutDuration": "A String", # Endpoint timeout setting for matching dtmf input to regex. + "finishDigit": "A String", # The digit that terminates a DTMF digit sequence. + "interdigitTimeoutDuration": "A String", # Interdigit timeout setting for matching dtmf input to regex. + "maxDigits": 42, # Max length of DTMF digits. + }, + "loggingSettings": { # Define behaviors on logging. # Settings for logging. Settings for Dialogflow History, Contact Center messages, StackDriver logs, and speech logging. Exposed at the following levels: - Agent level. + "enableInteractionLogging": True or False, # Enables DF Interaction logging. + "enableStackdriverLogging": True or False, # Enables StackDriver logging. + }, + "speechSettings": { # Define behaviors of speech to text detection. # Settings for speech to text detection. Exposed at the following levels: - Agent level - Flow level - Page level - Parameter level + "endpointerSensitivity": 42, # Sensitivity of the speech model that detects the end of speech. Scale from 0 to 100. + "models": { # Mapping from language to Speech-to-Text model. The mapped Speech-to-Text model will be selected for requests from its corresponding language. For more information, see [Speech models](https://cloud.google.com/dialogflow/cx/docs/concept/speech-models). + "a_key": "A String", + }, + "noSpeechTimeout": "A String", # Timeout before detecting no speech. + "useTimeoutBasedEndpointing": True or False, # Use timeout based endpointing, interpreting endpointer sensitivy as seconds of timeout value. + }, + }, + "conditionalCases": [ # Conditional cases for this fulfillment. + { # A list of cascading if-else conditions. Cases are mutually exclusive. The first one with a matching condition is selected, all the rest ignored. + "cases": [ # A list of cascading if-else conditions. + { # Each case has a Boolean condition. When it is evaluated to be True, the corresponding messages will be selected and evaluated recursively. + "caseContent": [ # A list of case content. + { # The list of messages or conditional cases to activate for this case. + "additionalCases": # Object with schema name: GoogleCloudDialogflowCxV3beta1FulfillmentConditionalCases # Additional cases to be evaluated. + "message": { # 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. # Returned message. + "channel": "A String", # The channel which the response is associated with. Clients can specify the channel via QueryParameters.channel, and only associated channel response will be returned. + "conversationSuccess": { # 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. # Indicates that the conversation succeeded. + "metadata": { # Custom metadata. Dialogflow doesn't impose any structure on this. + "a_key": "", # Properties of the object. + }, + }, + "endInteraction": { # 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. # Output only. A signal that indicates the interaction with the Dialogflow agent has ended. This message is generated by Dialogflow only when the conversation reaches `END_SESSION` page. It is not supposed to be defined by the user. It's guaranteed that there is at most one such message in each response. + }, + "knowledgeInfoCard": { # Represents info card response. If the response contains generative knowledge prediction, Dialogflow will return a payload with Infobot Messenger compatible info card. Otherwise, the info card response is skipped. # Represents info card for knowledge answers, to be better rendered in Dialogflow Messenger. + }, + "liveAgentHandoff": { # 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. # Hands off conversation to a human agent. + "metadata": { # Custom metadata for your handoff procedure. Dialogflow doesn't impose any structure on this. + "a_key": "", # Properties of the object. + }, + }, + "mixedAudio": { # 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. # Output only. An audio response message composed of both the synthesized Dialogflow agent responses and responses defined via play_audio. This message is generated by Dialogflow only and not supposed to be defined by the user. + "segments": [ # Segments this audio response is composed of. + { # Represents one segment of audio. + "allowPlaybackInterruption": True or False, # 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. + "audio": "A String", # Raw audio synthesized from the Dialogflow agent's response using the output config specified in the request. + "uri": "A String", # Client-specific URI that points to an audio clip accessible to the client. Dialogflow does not impose any validation on it. + }, + ], + }, + "outputAudioText": { # A text or ssml response that is preferentially used for TTS output audio synthesis, as described in the comment on the ResponseMessage message. # A text or ssml response that is preferentially used for TTS output audio synthesis, as described in the comment on the ResponseMessage message. + "allowPlaybackInterruption": True or False, # 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. + "ssml": "A String", # The SSML text to be synthesized. For more information, see [SSML](/speech/text-to-speech/docs/ssml). + "text": "A String", # The raw text to be synthesized. + }, + "payload": { # Returns a response containing a custom, platform-specific payload. + "a_key": "", # Properties of the object. + }, + "playAudio": { # Specifies an audio clip to be played by the client as part of the response. # Signal that the client should play an audio clip hosted at a client-specific URI. Dialogflow uses this to construct mixed_audio. However, Dialogflow itself does not try to read or process the URI in any way. + "allowPlaybackInterruption": True or False, # 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. + "audioUri": "A String", # Required. URI of the audio clip. Dialogflow does not impose any validation on this value. It is specific to the client that reads it. + }, + "telephonyTransferCall": { # Represents the signal that telles the client to transfer the phone call connected to the agent to a third-party endpoint. # A signal that the client should transfer the phone call connected to this agent to a third-party endpoint. + "phoneNumber": "A String", # Transfer the call to a phone number in [E.164 format](https://en.wikipedia.org/wiki/E.164). + }, + "text": { # The text response message. # Returns a text response. + "allowPlaybackInterruption": True or False, # 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. + "text": [ # Required. A collection of text responses. + "A String", + ], + }, + "toolCall": { # Represents a call of a specific tool's action with the specified inputs. # Returns the definition of a tool call that should be executed by the client. + "action": "A String", # Required. The name of the tool's action associated with this call. + "inputParameters": { # Optional. The action's input parameters. + "a_key": "", # Properties of the object. + }, + "tool": "A String", # Required. The tool associated with this call. Format: `projects//locations//agents//tools/`. + }, + }, + }, + ], + "condition": "A String", # The condition to activate and select this case. Empty means the condition is always true. The condition is evaluated against form parameters or session parameters. See the [conditions reference](https://cloud.google.com/dialogflow/cx/docs/reference/condition). + }, + ], + }, + ], + "enableGenerativeFallback": True or False, # If the flag is true, the agent will utilize LLM to generate a text response. If LLM generation fails, the defined responses in the fulfillment will be respected. This flag is only useful for fulfillments associated with no-match event handlers. + "messages": [ # The list of rich message responses to present to the user. + { # 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. + "channel": "A String", # The channel which the response is associated with. Clients can specify the channel via QueryParameters.channel, and only associated channel response will be returned. + "conversationSuccess": { # 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. # Indicates that the conversation succeeded. + "metadata": { # Custom metadata. Dialogflow doesn't impose any structure on this. + "a_key": "", # Properties of the object. + }, + }, + "endInteraction": { # 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. # Output only. A signal that indicates the interaction with the Dialogflow agent has ended. This message is generated by Dialogflow only when the conversation reaches `END_SESSION` page. It is not supposed to be defined by the user. It's guaranteed that there is at most one such message in each response. + }, + "knowledgeInfoCard": { # Represents info card response. If the response contains generative knowledge prediction, Dialogflow will return a payload with Infobot Messenger compatible info card. Otherwise, the info card response is skipped. # Represents info card for knowledge answers, to be better rendered in Dialogflow Messenger. + }, + "liveAgentHandoff": { # 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. # Hands off conversation to a human agent. + "metadata": { # Custom metadata for your handoff procedure. Dialogflow doesn't impose any structure on this. + "a_key": "", # Properties of the object. + }, + }, + "mixedAudio": { # 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. # Output only. An audio response message composed of both the synthesized Dialogflow agent responses and responses defined via play_audio. This message is generated by Dialogflow only and not supposed to be defined by the user. + "segments": [ # Segments this audio response is composed of. + { # Represents one segment of audio. + "allowPlaybackInterruption": True or False, # 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. + "audio": "A String", # Raw audio synthesized from the Dialogflow agent's response using the output config specified in the request. + "uri": "A String", # Client-specific URI that points to an audio clip accessible to the client. Dialogflow does not impose any validation on it. + }, + ], + }, + "outputAudioText": { # A text or ssml response that is preferentially used for TTS output audio synthesis, as described in the comment on the ResponseMessage message. # A text or ssml response that is preferentially used for TTS output audio synthesis, as described in the comment on the ResponseMessage message. + "allowPlaybackInterruption": True or False, # 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. + "ssml": "A String", # The SSML text to be synthesized. For more information, see [SSML](/speech/text-to-speech/docs/ssml). + "text": "A String", # The raw text to be synthesized. + }, + "payload": { # Returns a response containing a custom, platform-specific payload. + "a_key": "", # Properties of the object. + }, + "playAudio": { # Specifies an audio clip to be played by the client as part of the response. # Signal that the client should play an audio clip hosted at a client-specific URI. Dialogflow uses this to construct mixed_audio. However, Dialogflow itself does not try to read or process the URI in any way. + "allowPlaybackInterruption": True or False, # 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. + "audioUri": "A String", # Required. URI of the audio clip. Dialogflow does not impose any validation on this value. It is specific to the client that reads it. + }, + "telephonyTransferCall": { # Represents the signal that telles the client to transfer the phone call connected to the agent to a third-party endpoint. # A signal that the client should transfer the phone call connected to this agent to a third-party endpoint. + "phoneNumber": "A String", # Transfer the call to a phone number in [E.164 format](https://en.wikipedia.org/wiki/E.164). + }, + "text": { # The text response message. # Returns a text response. + "allowPlaybackInterruption": True or False, # 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. + "text": [ # Required. A collection of text responses. + "A String", + ], + }, + "toolCall": { # Represents a call of a specific tool's action with the specified inputs. # Returns the definition of a tool call that should be executed by the client. + "action": "A String", # Required. The name of the tool's action associated with this call. + "inputParameters": { # Optional. The action's input parameters. + "a_key": "", # Properties of the object. + }, + "tool": "A String", # Required. The tool associated with this call. Format: `projects//locations//agents//tools/`. + }, + }, + ], + "returnPartialResponses": True or False, # Whether Dialogflow should return currently queued fulfillment response messages in streaming APIs. If a webhook is specified, it happens before Dialogflow invokes webhook. Warning: 1) This flag only affects streaming API. Responses are still queued and returned once in non-streaming API. 2) The flag can be enabled in any fulfillment but only the first 3 partial responses will be returned. You may only want to apply it to fulfillments that have slow webhooks. + "setParameterActions": [ # Set parameter values before executing the webhook. + { # Setting a parameter value. + "parameter": "A String", # Display name of the parameter. + "value": "", # The new value of the parameter. A null value clears the parameter. + }, + ], + "tag": "A String", # The value of this field will be populated in the WebhookRequest `fulfillmentInfo.tag` field by Dialogflow when the associated webhook is called. The tag is typically used by the webhook service to identify which fulfillment is being called, but it could be used for other purposes. This field is required if `webhook` is specified. + "webhook": "A String", # The webhook to call. Format: `projects//locations//agents//webhooks/`. + }, + "repromptEventHandlers": [ # The handlers for parameter-level events, used to provide reprompt for the parameter or transition to a different page/flow. The supported events are: * `sys.no-match-`, where N can be from 1 to 6 * `sys.no-match-default` * `sys.no-input-`, where N can be from 1 to 6 * `sys.no-input-default` * `sys.invalid-parameter` `initial_prompt_fulfillment` provides the first prompt for the parameter. If the user's response does not fill the parameter, a no-match/no-input event will be triggered, and the fulfillment associated with the `sys.no-match-1`/`sys.no-input-1` handler (if defined) will be called to provide a prompt. The `sys.no-match-2`/`sys.no-input-2` handler (if defined) will respond to the next no-match/no-input event, and so on. A `sys.no-match-default` or `sys.no-input-default` handler will be used to handle all following no-match/no-input events after all numbered no-match/no-input handlers for the parameter are consumed. A `sys.invalid-parameter` handler can be defined to handle the case where the parameter values have been `invalidated` by webhook. For example, if the user's response fill the parameter, however the parameter was invalidated by webhook, the fulfillment associated with the `sys.invalid-parameter` handler (if defined) will be called to provide a prompt. If the event handler for the corresponding event can't be found on the parameter, `initial_prompt_fulfillment` will be re-prompted. + { # An event handler specifies an event that can be handled during a session. When the specified event happens, the following actions are taken in order: * If there is a `trigger_fulfillment` associated with the event, it will be called. * If there is a `target_page` associated with the event, the session will transition into the specified page. * If there is a `target_flow` associated with the event, the session will transition into the specified flow. + "event": "A String", # Required. The name of the event to handle. + "name": "A String", # Output only. The unique identifier of this event handler. + "targetFlow": "A String", # The target flow to transition to. Format: `projects//locations//agents//flows/`. + "targetPage": "A String", # The target page to transition to. Format: `projects//locations//agents//flows//pages/`. + "triggerFulfillment": { # A fulfillment can do one or more of the following actions at the same time: * Generate rich message responses. * Set parameter values. * Call the webhook. Fulfillments can be called at various stages in the Page or Form lifecycle. For example, when a DetectIntentRequest drives a session to enter a new page, the page's entry fulfillment can add a static response to the QueryResult in the returning DetectIntentResponse, call the webhook (for example, to load user data from a database), or both. # The fulfillment to call when the event occurs. Handling webhook errors with a fulfillment enabled with webhook could cause infinite loop. It is invalid to specify such fulfillment for a handler handling webhooks. + "advancedSettings": { # Hierarchical advanced settings for agent/flow/page/fulfillment/parameter. Settings exposed at lower level overrides the settings exposed at higher level. Overriding occurs at the sub-setting level. For example, the playback_interruption_settings at fulfillment level only overrides the playback_interruption_settings at the agent level, leaving other settings at the agent level unchanged. DTMF settings does not override each other. DTMF settings set at different levels define DTMF detections running in parallel. Hierarchy: Agent->Flow->Page->Fulfillment/Parameter. # Hierarchical advanced settings for this fulfillment. The settings exposed at the lower level overrides the settings exposed at the higher level. + "audioExportGcsDestination": { # Google Cloud Storage location for a Dialogflow operation that writes or exports objects (e.g. exported agent or transcripts) outside of Dialogflow. # If present, incoming audio is exported by Dialogflow to the configured Google Cloud Storage destination. Exposed at the following levels: - Agent level - Flow level + "uri": "A String", # Required. The Google Cloud Storage URI for the exported objects. A URI is of the form: `gs://bucket/object-name-or-prefix` Whether a full object name, or just a prefix, its usage depends on the Dialogflow operation. + }, + "dtmfSettings": { # Define behaviors for DTMF (dual tone multi frequency). # Settings for DTMF. Exposed at the following levels: - Agent level - Flow level - Page level - Parameter level. + "enabled": True or False, # If true, incoming audio is processed for DTMF (dual tone multi frequency) events. For example, if the caller presses a button on their telephone keypad and DTMF processing is enabled, Dialogflow will detect the event (e.g. a "3" was pressed) in the incoming audio and pass the event to the bot to drive business logic (e.g. when 3 is pressed, return the account balance). + "endpointingTimeoutDuration": "A String", # Endpoint timeout setting for matching dtmf input to regex. + "finishDigit": "A String", # The digit that terminates a DTMF digit sequence. + "interdigitTimeoutDuration": "A String", # Interdigit timeout setting for matching dtmf input to regex. + "maxDigits": 42, # Max length of DTMF digits. + }, + "loggingSettings": { # Define behaviors on logging. # Settings for logging. Settings for Dialogflow History, Contact Center messages, StackDriver logs, and speech logging. Exposed at the following levels: - Agent level. + "enableInteractionLogging": True or False, # Enables DF Interaction logging. + "enableStackdriverLogging": True or False, # Enables StackDriver logging. + }, + "speechSettings": { # Define behaviors of speech to text detection. # Settings for speech to text detection. Exposed at the following levels: - Agent level - Flow level - Page level - Parameter level + "endpointerSensitivity": 42, # Sensitivity of the speech model that detects the end of speech. Scale from 0 to 100. + "models": { # Mapping from language to Speech-to-Text model. The mapped Speech-to-Text model will be selected for requests from its corresponding language. For more information, see [Speech models](https://cloud.google.com/dialogflow/cx/docs/concept/speech-models). + "a_key": "A String", + }, + "noSpeechTimeout": "A String", # Timeout before detecting no speech. + "useTimeoutBasedEndpointing": True or False, # Use timeout based endpointing, interpreting endpointer sensitivy as seconds of timeout value. + }, + }, + "conditionalCases": [ # Conditional cases for this fulfillment. + { # A list of cascading if-else conditions. Cases are mutually exclusive. The first one with a matching condition is selected, all the rest ignored. + "cases": [ # A list of cascading if-else conditions. + { # Each case has a Boolean condition. When it is evaluated to be True, the corresponding messages will be selected and evaluated recursively. + "caseContent": [ # A list of case content. + { # The list of messages or conditional cases to activate for this case. + "additionalCases": # Object with schema name: GoogleCloudDialogflowCxV3beta1FulfillmentConditionalCases # Additional cases to be evaluated. + "message": { # 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. # Returned message. + "channel": "A String", # The channel which the response is associated with. Clients can specify the channel via QueryParameters.channel, and only associated channel response will be returned. + "conversationSuccess": { # 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. # Indicates that the conversation succeeded. + "metadata": { # Custom metadata. Dialogflow doesn't impose any structure on this. + "a_key": "", # Properties of the object. + }, + }, + "endInteraction": { # 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. # Output only. A signal that indicates the interaction with the Dialogflow agent has ended. This message is generated by Dialogflow only when the conversation reaches `END_SESSION` page. It is not supposed to be defined by the user. It's guaranteed that there is at most one such message in each response. + }, + "knowledgeInfoCard": { # Represents info card response. If the response contains generative knowledge prediction, Dialogflow will return a payload with Infobot Messenger compatible info card. Otherwise, the info card response is skipped. # Represents info card for knowledge answers, to be better rendered in Dialogflow Messenger. + }, + "liveAgentHandoff": { # 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. # Hands off conversation to a human agent. + "metadata": { # Custom metadata for your handoff procedure. Dialogflow doesn't impose any structure on this. + "a_key": "", # Properties of the object. + }, + }, + "mixedAudio": { # 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. # Output only. An audio response message composed of both the synthesized Dialogflow agent responses and responses defined via play_audio. This message is generated by Dialogflow only and not supposed to be defined by the user. + "segments": [ # Segments this audio response is composed of. + { # Represents one segment of audio. + "allowPlaybackInterruption": True or False, # 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. + "audio": "A String", # Raw audio synthesized from the Dialogflow agent's response using the output config specified in the request. + "uri": "A String", # Client-specific URI that points to an audio clip accessible to the client. Dialogflow does not impose any validation on it. + }, + ], + }, + "outputAudioText": { # A text or ssml response that is preferentially used for TTS output audio synthesis, as described in the comment on the ResponseMessage message. # A text or ssml response that is preferentially used for TTS output audio synthesis, as described in the comment on the ResponseMessage message. + "allowPlaybackInterruption": True or False, # 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. + "ssml": "A String", # The SSML text to be synthesized. For more information, see [SSML](/speech/text-to-speech/docs/ssml). + "text": "A String", # The raw text to be synthesized. + }, + "payload": { # Returns a response containing a custom, platform-specific payload. + "a_key": "", # Properties of the object. + }, + "playAudio": { # Specifies an audio clip to be played by the client as part of the response. # Signal that the client should play an audio clip hosted at a client-specific URI. Dialogflow uses this to construct mixed_audio. However, Dialogflow itself does not try to read or process the URI in any way. + "allowPlaybackInterruption": True or False, # 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. + "audioUri": "A String", # Required. URI of the audio clip. Dialogflow does not impose any validation on this value. It is specific to the client that reads it. + }, + "telephonyTransferCall": { # Represents the signal that telles the client to transfer the phone call connected to the agent to a third-party endpoint. # A signal that the client should transfer the phone call connected to this agent to a third-party endpoint. + "phoneNumber": "A String", # Transfer the call to a phone number in [E.164 format](https://en.wikipedia.org/wiki/E.164). + }, + "text": { # The text response message. # Returns a text response. + "allowPlaybackInterruption": True or False, # 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. + "text": [ # Required. A collection of text responses. + "A String", + ], + }, + "toolCall": { # Represents a call of a specific tool's action with the specified inputs. # Returns the definition of a tool call that should be executed by the client. + "action": "A String", # Required. The name of the tool's action associated with this call. + "inputParameters": { # Optional. The action's input parameters. + "a_key": "", # Properties of the object. + }, + "tool": "A String", # Required. The tool associated with this call. Format: `projects//locations//agents//tools/`. + }, + }, + }, + ], + "condition": "A String", # The condition to activate and select this case. Empty means the condition is always true. The condition is evaluated against form parameters or session parameters. See the [conditions reference](https://cloud.google.com/dialogflow/cx/docs/reference/condition). + }, + ], + }, + ], + "enableGenerativeFallback": True or False, # If the flag is true, the agent will utilize LLM to generate a text response. If LLM generation fails, the defined responses in the fulfillment will be respected. This flag is only useful for fulfillments associated with no-match event handlers. + "messages": [ # The list of rich message responses to present to the user. + { # 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. + "channel": "A String", # The channel which the response is associated with. Clients can specify the channel via QueryParameters.channel, and only associated channel response will be returned. + "conversationSuccess": { # 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. # Indicates that the conversation succeeded. + "metadata": { # Custom metadata. Dialogflow doesn't impose any structure on this. + "a_key": "", # Properties of the object. + }, + }, + "endInteraction": { # 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. # Output only. A signal that indicates the interaction with the Dialogflow agent has ended. This message is generated by Dialogflow only when the conversation reaches `END_SESSION` page. It is not supposed to be defined by the user. It's guaranteed that there is at most one such message in each response. + }, + "knowledgeInfoCard": { # Represents info card response. If the response contains generative knowledge prediction, Dialogflow will return a payload with Infobot Messenger compatible info card. Otherwise, the info card response is skipped. # Represents info card for knowledge answers, to be better rendered in Dialogflow Messenger. + }, + "liveAgentHandoff": { # 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. # Hands off conversation to a human agent. + "metadata": { # Custom metadata for your handoff procedure. Dialogflow doesn't impose any structure on this. + "a_key": "", # Properties of the object. + }, + }, + "mixedAudio": { # 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. # Output only. An audio response message composed of both the synthesized Dialogflow agent responses and responses defined via play_audio. This message is generated by Dialogflow only and not supposed to be defined by the user. + "segments": [ # Segments this audio response is composed of. + { # Represents one segment of audio. + "allowPlaybackInterruption": True or False, # 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. + "audio": "A String", # Raw audio synthesized from the Dialogflow agent's response using the output config specified in the request. + "uri": "A String", # Client-specific URI that points to an audio clip accessible to the client. Dialogflow does not impose any validation on it. + }, + ], + }, + "outputAudioText": { # A text or ssml response that is preferentially used for TTS output audio synthesis, as described in the comment on the ResponseMessage message. # A text or ssml response that is preferentially used for TTS output audio synthesis, as described in the comment on the ResponseMessage message. + "allowPlaybackInterruption": True or False, # 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. + "ssml": "A String", # The SSML text to be synthesized. For more information, see [SSML](/speech/text-to-speech/docs/ssml). + "text": "A String", # The raw text to be synthesized. + }, + "payload": { # Returns a response containing a custom, platform-specific payload. + "a_key": "", # Properties of the object. + }, + "playAudio": { # Specifies an audio clip to be played by the client as part of the response. # Signal that the client should play an audio clip hosted at a client-specific URI. Dialogflow uses this to construct mixed_audio. However, Dialogflow itself does not try to read or process the URI in any way. + "allowPlaybackInterruption": True or False, # 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. + "audioUri": "A String", # Required. URI of the audio clip. Dialogflow does not impose any validation on this value. It is specific to the client that reads it. + }, + "telephonyTransferCall": { # Represents the signal that telles the client to transfer the phone call connected to the agent to a third-party endpoint. # A signal that the client should transfer the phone call connected to this agent to a third-party endpoint. + "phoneNumber": "A String", # Transfer the call to a phone number in [E.164 format](https://en.wikipedia.org/wiki/E.164). + }, + "text": { # The text response message. # Returns a text response. + "allowPlaybackInterruption": True or False, # 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. + "text": [ # Required. A collection of text responses. + "A String", + ], + }, + "toolCall": { # Represents a call of a specific tool's action with the specified inputs. # Returns the definition of a tool call that should be executed by the client. + "action": "A String", # Required. The name of the tool's action associated with this call. + "inputParameters": { # Optional. The action's input parameters. + "a_key": "", # Properties of the object. + }, + "tool": "A String", # Required. The tool associated with this call. Format: `projects//locations//agents//tools/`. + }, + }, + ], + "returnPartialResponses": True or False, # Whether Dialogflow should return currently queued fulfillment response messages in streaming APIs. If a webhook is specified, it happens before Dialogflow invokes webhook. Warning: 1) This flag only affects streaming API. Responses are still queued and returned once in non-streaming API. 2) The flag can be enabled in any fulfillment but only the first 3 partial responses will be returned. You may only want to apply it to fulfillments that have slow webhooks. + "setParameterActions": [ # Set parameter values before executing the webhook. + { # Setting a parameter value. + "parameter": "A String", # Display name of the parameter. + "value": "", # The new value of the parameter. A null value clears the parameter. + }, + ], + "tag": "A String", # The value of this field will be populated in the WebhookRequest `fulfillmentInfo.tag` field by Dialogflow when the associated webhook is called. The tag is typically used by the webhook service to identify which fulfillment is being called, but it could be used for other purposes. This field is required if `webhook` is specified. + "webhook": "A String", # The webhook to call. Format: `projects//locations//agents//webhooks/`. + }, + }, + ], + }, + "isList": True or False, # Indicates whether the parameter represents a list of values. + "redact": True or False, # Indicates whether the parameter content should be redacted in log. If redaction is enabled, the parameter content will be replaced by parameter name during logging. Note: the parameter content is subject to redaction if either parameter level redaction or entity type level redaction is enabled. + "required": True or False, # 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. + }, + ], + }, + "knowledgeConnectorSettings": { # The Knowledge Connector settings for this page or flow. This includes information such as the attached Knowledge Bases, and the way to execute fulfillment. # Optional. Knowledge connector configuration. + "dataStoreConnections": [ # Optional. List of related data store connections. + { # A data store connection. It represents a data store in Discovery Engine and the type of the contents it contains. + "dataStore": "A String", # The full name of the referenced data store. Formats: `projects/{project}/locations/{location}/collections/{collection}/dataStores/{data_store}` `projects/{project}/locations/{location}/dataStores/{data_store}` + "dataStoreType": "A String", # The type of the connected data store. + }, + ], + "enabled": True or False, # Whether Knowledge Connector is enabled or not. + "targetFlow": "A String", # The target flow to transition to. Format: `projects//locations//agents//flows/`. + "targetPage": "A String", # The target page to transition to. Format: `projects//locations//agents//flows//pages/`. + "triggerFulfillment": { # A fulfillment can do one or more of the following actions at the same time: * Generate rich message responses. * Set parameter values. * Call the webhook. Fulfillments can be called at various stages in the Page or Form lifecycle. For example, when a DetectIntentRequest drives a session to enter a new page, the page's entry fulfillment can add a static response to the QueryResult in the returning DetectIntentResponse, call the webhook (for example, to load user data from a database), or both. # The fulfillment to be triggered. When the answers from the Knowledge Connector are selected by Dialogflow, you can utitlize the request scoped parameter `$request.knowledge.answers` (contains up to the 5 highest confidence answers) and `$request.knowledge.questions` (contains the corresponding questions) to construct the fulfillment. + "advancedSettings": { # Hierarchical advanced settings for agent/flow/page/fulfillment/parameter. Settings exposed at lower level overrides the settings exposed at higher level. Overriding occurs at the sub-setting level. For example, the playback_interruption_settings at fulfillment level only overrides the playback_interruption_settings at the agent level, leaving other settings at the agent level unchanged. DTMF settings does not override each other. DTMF settings set at different levels define DTMF detections running in parallel. Hierarchy: Agent->Flow->Page->Fulfillment/Parameter. # Hierarchical advanced settings for this fulfillment. The settings exposed at the lower level overrides the settings exposed at the higher level. + "audioExportGcsDestination": { # Google Cloud Storage location for a Dialogflow operation that writes or exports objects (e.g. exported agent or transcripts) outside of Dialogflow. # If present, incoming audio is exported by Dialogflow to the configured Google Cloud Storage destination. Exposed at the following levels: - Agent level - Flow level + "uri": "A String", # Required. The Google Cloud Storage URI for the exported objects. A URI is of the form: `gs://bucket/object-name-or-prefix` Whether a full object name, or just a prefix, its usage depends on the Dialogflow operation. + }, + "dtmfSettings": { # Define behaviors for DTMF (dual tone multi frequency). # Settings for DTMF. Exposed at the following levels: - Agent level - Flow level - Page level - Parameter level. + "enabled": True or False, # If true, incoming audio is processed for DTMF (dual tone multi frequency) events. For example, if the caller presses a button on their telephone keypad and DTMF processing is enabled, Dialogflow will detect the event (e.g. a "3" was pressed) in the incoming audio and pass the event to the bot to drive business logic (e.g. when 3 is pressed, return the account balance). + "endpointingTimeoutDuration": "A String", # Endpoint timeout setting for matching dtmf input to regex. + "finishDigit": "A String", # The digit that terminates a DTMF digit sequence. + "interdigitTimeoutDuration": "A String", # Interdigit timeout setting for matching dtmf input to regex. + "maxDigits": 42, # Max length of DTMF digits. + }, + "loggingSettings": { # Define behaviors on logging. # Settings for logging. Settings for Dialogflow History, Contact Center messages, StackDriver logs, and speech logging. Exposed at the following levels: - Agent level. + "enableInteractionLogging": True or False, # Enables DF Interaction logging. + "enableStackdriverLogging": True or False, # Enables StackDriver logging. + }, + "speechSettings": { # Define behaviors of speech to text detection. # Settings for speech to text detection. Exposed at the following levels: - Agent level - Flow level - Page level - Parameter level + "endpointerSensitivity": 42, # Sensitivity of the speech model that detects the end of speech. Scale from 0 to 100. + "models": { # Mapping from language to Speech-to-Text model. The mapped Speech-to-Text model will be selected for requests from its corresponding language. For more information, see [Speech models](https://cloud.google.com/dialogflow/cx/docs/concept/speech-models). + "a_key": "A String", + }, + "noSpeechTimeout": "A String", # Timeout before detecting no speech. + "useTimeoutBasedEndpointing": True or False, # Use timeout based endpointing, interpreting endpointer sensitivy as seconds of timeout value. + }, + }, + "conditionalCases": [ # Conditional cases for this fulfillment. + { # A list of cascading if-else conditions. Cases are mutually exclusive. The first one with a matching condition is selected, all the rest ignored. + "cases": [ # A list of cascading if-else conditions. + { # Each case has a Boolean condition. When it is evaluated to be True, the corresponding messages will be selected and evaluated recursively. + "caseContent": [ # A list of case content. + { # The list of messages or conditional cases to activate for this case. + "additionalCases": # Object with schema name: GoogleCloudDialogflowCxV3beta1FulfillmentConditionalCases # Additional cases to be evaluated. + "message": { # 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. # Returned message. + "channel": "A String", # The channel which the response is associated with. Clients can specify the channel via QueryParameters.channel, and only associated channel response will be returned. + "conversationSuccess": { # 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. # Indicates that the conversation succeeded. + "metadata": { # Custom metadata. Dialogflow doesn't impose any structure on this. + "a_key": "", # Properties of the object. + }, + }, + "endInteraction": { # 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. # Output only. A signal that indicates the interaction with the Dialogflow agent has ended. This message is generated by Dialogflow only when the conversation reaches `END_SESSION` page. It is not supposed to be defined by the user. It's guaranteed that there is at most one such message in each response. + }, + "knowledgeInfoCard": { # Represents info card response. If the response contains generative knowledge prediction, Dialogflow will return a payload with Infobot Messenger compatible info card. Otherwise, the info card response is skipped. # Represents info card for knowledge answers, to be better rendered in Dialogflow Messenger. + }, + "liveAgentHandoff": { # 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. # Hands off conversation to a human agent. + "metadata": { # Custom metadata for your handoff procedure. Dialogflow doesn't impose any structure on this. + "a_key": "", # Properties of the object. + }, + }, + "mixedAudio": { # 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. # Output only. An audio response message composed of both the synthesized Dialogflow agent responses and responses defined via play_audio. This message is generated by Dialogflow only and not supposed to be defined by the user. + "segments": [ # Segments this audio response is composed of. + { # Represents one segment of audio. + "allowPlaybackInterruption": True or False, # 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. + "audio": "A String", # Raw audio synthesized from the Dialogflow agent's response using the output config specified in the request. + "uri": "A String", # Client-specific URI that points to an audio clip accessible to the client. Dialogflow does not impose any validation on it. + }, + ], + }, + "outputAudioText": { # A text or ssml response that is preferentially used for TTS output audio synthesis, as described in the comment on the ResponseMessage message. # A text or ssml response that is preferentially used for TTS output audio synthesis, as described in the comment on the ResponseMessage message. + "allowPlaybackInterruption": True or False, # 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. + "ssml": "A String", # The SSML text to be synthesized. For more information, see [SSML](/speech/text-to-speech/docs/ssml). + "text": "A String", # The raw text to be synthesized. + }, + "payload": { # Returns a response containing a custom, platform-specific payload. + "a_key": "", # Properties of the object. + }, + "playAudio": { # Specifies an audio clip to be played by the client as part of the response. # Signal that the client should play an audio clip hosted at a client-specific URI. Dialogflow uses this to construct mixed_audio. However, Dialogflow itself does not try to read or process the URI in any way. + "allowPlaybackInterruption": True or False, # 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. + "audioUri": "A String", # Required. URI of the audio clip. Dialogflow does not impose any validation on this value. It is specific to the client that reads it. + }, + "telephonyTransferCall": { # Represents the signal that telles the client to transfer the phone call connected to the agent to a third-party endpoint. # A signal that the client should transfer the phone call connected to this agent to a third-party endpoint. + "phoneNumber": "A String", # Transfer the call to a phone number in [E.164 format](https://en.wikipedia.org/wiki/E.164). + }, + "text": { # The text response message. # Returns a text response. + "allowPlaybackInterruption": True or False, # 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. + "text": [ # Required. A collection of text responses. + "A String", + ], + }, + "toolCall": { # Represents a call of a specific tool's action with the specified inputs. # Returns the definition of a tool call that should be executed by the client. + "action": "A String", # Required. The name of the tool's action associated with this call. + "inputParameters": { # Optional. The action's input parameters. + "a_key": "", # Properties of the object. + }, + "tool": "A String", # Required. The tool associated with this call. Format: `projects//locations//agents//tools/`. + }, + }, + }, + ], + "condition": "A String", # The condition to activate and select this case. Empty means the condition is always true. The condition is evaluated against form parameters or session parameters. See the [conditions reference](https://cloud.google.com/dialogflow/cx/docs/reference/condition). + }, + ], + }, + ], + "enableGenerativeFallback": True or False, # If the flag is true, the agent will utilize LLM to generate a text response. If LLM generation fails, the defined responses in the fulfillment will be respected. This flag is only useful for fulfillments associated with no-match event handlers. + "messages": [ # The list of rich message responses to present to the user. + { # 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. + "channel": "A String", # The channel which the response is associated with. Clients can specify the channel via QueryParameters.channel, and only associated channel response will be returned. + "conversationSuccess": { # 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. # Indicates that the conversation succeeded. + "metadata": { # Custom metadata. Dialogflow doesn't impose any structure on this. + "a_key": "", # Properties of the object. + }, + }, + "endInteraction": { # 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. # Output only. A signal that indicates the interaction with the Dialogflow agent has ended. This message is generated by Dialogflow only when the conversation reaches `END_SESSION` page. It is not supposed to be defined by the user. It's guaranteed that there is at most one such message in each response. + }, + "knowledgeInfoCard": { # Represents info card response. If the response contains generative knowledge prediction, Dialogflow will return a payload with Infobot Messenger compatible info card. Otherwise, the info card response is skipped. # Represents info card for knowledge answers, to be better rendered in Dialogflow Messenger. + }, + "liveAgentHandoff": { # 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. # Hands off conversation to a human agent. + "metadata": { # Custom metadata for your handoff procedure. Dialogflow doesn't impose any structure on this. + "a_key": "", # Properties of the object. + }, + }, + "mixedAudio": { # 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. # Output only. An audio response message composed of both the synthesized Dialogflow agent responses and responses defined via play_audio. This message is generated by Dialogflow only and not supposed to be defined by the user. + "segments": [ # Segments this audio response is composed of. + { # Represents one segment of audio. + "allowPlaybackInterruption": True or False, # 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. + "audio": "A String", # Raw audio synthesized from the Dialogflow agent's response using the output config specified in the request. + "uri": "A String", # Client-specific URI that points to an audio clip accessible to the client. Dialogflow does not impose any validation on it. + }, + ], + }, + "outputAudioText": { # A text or ssml response that is preferentially used for TTS output audio synthesis, as described in the comment on the ResponseMessage message. # A text or ssml response that is preferentially used for TTS output audio synthesis, as described in the comment on the ResponseMessage message. + "allowPlaybackInterruption": True or False, # 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. + "ssml": "A String", # The SSML text to be synthesized. For more information, see [SSML](/speech/text-to-speech/docs/ssml). + "text": "A String", # The raw text to be synthesized. + }, + "payload": { # Returns a response containing a custom, platform-specific payload. + "a_key": "", # Properties of the object. + }, + "playAudio": { # Specifies an audio clip to be played by the client as part of the response. # Signal that the client should play an audio clip hosted at a client-specific URI. Dialogflow uses this to construct mixed_audio. However, Dialogflow itself does not try to read or process the URI in any way. + "allowPlaybackInterruption": True or False, # 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. + "audioUri": "A String", # Required. URI of the audio clip. Dialogflow does not impose any validation on this value. It is specific to the client that reads it. + }, + "telephonyTransferCall": { # Represents the signal that telles the client to transfer the phone call connected to the agent to a third-party endpoint. # A signal that the client should transfer the phone call connected to this agent to a third-party endpoint. + "phoneNumber": "A String", # Transfer the call to a phone number in [E.164 format](https://en.wikipedia.org/wiki/E.164). + }, + "text": { # The text response message. # Returns a text response. + "allowPlaybackInterruption": True or False, # 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. + "text": [ # Required. A collection of text responses. + "A String", + ], + }, + "toolCall": { # Represents a call of a specific tool's action with the specified inputs. # Returns the definition of a tool call that should be executed by the client. + "action": "A String", # Required. The name of the tool's action associated with this call. + "inputParameters": { # Optional. The action's input parameters. + "a_key": "", # Properties of the object. + }, + "tool": "A String", # Required. The tool associated with this call. Format: `projects//locations//agents//tools/`. + }, + }, + ], + "returnPartialResponses": True or False, # Whether Dialogflow should return currently queued fulfillment response messages in streaming APIs. If a webhook is specified, it happens before Dialogflow invokes webhook. Warning: 1) This flag only affects streaming API. Responses are still queued and returned once in non-streaming API. 2) The flag can be enabled in any fulfillment but only the first 3 partial responses will be returned. You may only want to apply it to fulfillments that have slow webhooks. + "setParameterActions": [ # Set parameter values before executing the webhook. + { # Setting a parameter value. + "parameter": "A String", # Display name of the parameter. + "value": "", # The new value of the parameter. A null value clears the parameter. + }, + ], + "tag": "A String", # The value of this field will be populated in the WebhookRequest `fulfillmentInfo.tag` field by Dialogflow when the associated webhook is called. The tag is typically used by the webhook service to identify which fulfillment is being called, but it could be used for other purposes. This field is required if `webhook` is specified. + "webhook": "A String", # The webhook to call. Format: `projects//locations//agents//webhooks/`. + }, + }, + "name": "A String", # The unique identifier of the page. Required for the Pages.UpdatePage method. Pages.CreatePage populates the name automatically. Format: `projects//locations//agents//flows//pages/`. + "transitionRouteGroups": [ # Ordered list of `TransitionRouteGroups` added to the page. Transition route groups must be unique within a page. If the page links both flow-level transition route groups and agent-level transition route groups, the flow-level ones will have higher priority and will be put before the agent-level ones. * If multiple transition routes within a page scope refer to the same intent, then the precedence order is: page's transition route -> page's transition route group -> flow's transition routes. * If multiple transition route groups within a page contain the same intent, then the first group in the ordered list takes precedence. Format:`projects//locations//agents//flows//transitionRouteGroups/` or `projects//locations//agents//transitionRouteGroups/` for agent-level groups. + "A String", + ], + "transitionRoutes": [ # A list of transitions for the transition rules of this page. They route the conversation to another page in the same flow, or another flow. When we are in a certain page, the TransitionRoutes are evalauted in the following order: * TransitionRoutes defined in the page with intent specified. * TransitionRoutes defined in the transition route groups with intent specified. * TransitionRoutes defined in flow with intent specified. * TransitionRoutes defined in the transition route groups with intent specified. * TransitionRoutes defined in the page with only condition specified. * TransitionRoutes defined in the transition route groups with only condition specified. + { # A transition route specifies a intent that can be matched and/or a data condition that can be evaluated during a session. When a specified transition is matched, the following actions are taken in order: * If there is a `trigger_fulfillment` associated with the transition, it will be called. * If there is a `target_page` associated with the transition, the session will transition into the specified page. * If there is a `target_flow` associated with the transition, the session will transition into the specified flow. + "condition": "A String", # The condition to evaluate against form parameters or session parameters. See the [conditions reference](https://cloud.google.com/dialogflow/cx/docs/reference/condition). At least one of `intent` or `condition` must be specified. When both `intent` and `condition` are specified, the transition can only happen when both are fulfilled. + "description": "A String", # Optional. The description of the transition route. The maximum length is 500 characters. + "intent": "A String", # The unique identifier of an Intent. Format: `projects//locations//agents//intents/`. Indicates that the transition can only happen when the given intent is matched. At least one of `intent` or `condition` must be specified. When both `intent` and `condition` are specified, the transition can only happen when both are fulfilled. + "name": "A String", # Output only. The unique identifier of this transition route. + "targetFlow": "A String", # The target flow to transition to. Format: `projects//locations//agents//flows/`. + "targetPage": "A String", # The target page to transition to. Format: `projects//locations//agents//flows//pages/`. + "triggerFulfillment": { # A fulfillment can do one or more of the following actions at the same time: * Generate rich message responses. * Set parameter values. * Call the webhook. Fulfillments can be called at various stages in the Page or Form lifecycle. For example, when a DetectIntentRequest drives a session to enter a new page, the page's entry fulfillment can add a static response to the QueryResult in the returning DetectIntentResponse, call the webhook (for example, to load user data from a database), or both. # The fulfillment to call when the condition is satisfied. At least one of `trigger_fulfillment` and `target` must be specified. When both are defined, `trigger_fulfillment` is executed first. + "advancedSettings": { # Hierarchical advanced settings for agent/flow/page/fulfillment/parameter. Settings exposed at lower level overrides the settings exposed at higher level. Overriding occurs at the sub-setting level. For example, the playback_interruption_settings at fulfillment level only overrides the playback_interruption_settings at the agent level, leaving other settings at the agent level unchanged. DTMF settings does not override each other. DTMF settings set at different levels define DTMF detections running in parallel. Hierarchy: Agent->Flow->Page->Fulfillment/Parameter. # Hierarchical advanced settings for this fulfillment. The settings exposed at the lower level overrides the settings exposed at the higher level. + "audioExportGcsDestination": { # Google Cloud Storage location for a Dialogflow operation that writes or exports objects (e.g. exported agent or transcripts) outside of Dialogflow. # If present, incoming audio is exported by Dialogflow to the configured Google Cloud Storage destination. Exposed at the following levels: - Agent level - Flow level + "uri": "A String", # Required. The Google Cloud Storage URI for the exported objects. A URI is of the form: `gs://bucket/object-name-or-prefix` Whether a full object name, or just a prefix, its usage depends on the Dialogflow operation. + }, + "dtmfSettings": { # Define behaviors for DTMF (dual tone multi frequency). # Settings for DTMF. Exposed at the following levels: - Agent level - Flow level - Page level - Parameter level. + "enabled": True or False, # If true, incoming audio is processed for DTMF (dual tone multi frequency) events. For example, if the caller presses a button on their telephone keypad and DTMF processing is enabled, Dialogflow will detect the event (e.g. a "3" was pressed) in the incoming audio and pass the event to the bot to drive business logic (e.g. when 3 is pressed, return the account balance). + "endpointingTimeoutDuration": "A String", # Endpoint timeout setting for matching dtmf input to regex. + "finishDigit": "A String", # The digit that terminates a DTMF digit sequence. + "interdigitTimeoutDuration": "A String", # Interdigit timeout setting for matching dtmf input to regex. + "maxDigits": 42, # Max length of DTMF digits. + }, + "loggingSettings": { # Define behaviors on logging. # Settings for logging. Settings for Dialogflow History, Contact Center messages, StackDriver logs, and speech logging. Exposed at the following levels: - Agent level. + "enableInteractionLogging": True or False, # Enables DF Interaction logging. + "enableStackdriverLogging": True or False, # Enables StackDriver logging. + }, + "speechSettings": { # Define behaviors of speech to text detection. # Settings for speech to text detection. Exposed at the following levels: - Agent level - Flow level - Page level - Parameter level + "endpointerSensitivity": 42, # Sensitivity of the speech model that detects the end of speech. Scale from 0 to 100. + "models": { # Mapping from language to Speech-to-Text model. The mapped Speech-to-Text model will be selected for requests from its corresponding language. For more information, see [Speech models](https://cloud.google.com/dialogflow/cx/docs/concept/speech-models). + "a_key": "A String", + }, + "noSpeechTimeout": "A String", # Timeout before detecting no speech. + "useTimeoutBasedEndpointing": True or False, # Use timeout based endpointing, interpreting endpointer sensitivy as seconds of timeout value. + }, + }, + "conditionalCases": [ # Conditional cases for this fulfillment. + { # A list of cascading if-else conditions. Cases are mutually exclusive. The first one with a matching condition is selected, all the rest ignored. + "cases": [ # A list of cascading if-else conditions. + { # Each case has a Boolean condition. When it is evaluated to be True, the corresponding messages will be selected and evaluated recursively. + "caseContent": [ # A list of case content. + { # The list of messages or conditional cases to activate for this case. + "additionalCases": # Object with schema name: GoogleCloudDialogflowCxV3beta1FulfillmentConditionalCases # Additional cases to be evaluated. + "message": { # 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. # Returned message. + "channel": "A String", # The channel which the response is associated with. Clients can specify the channel via QueryParameters.channel, and only associated channel response will be returned. + "conversationSuccess": { # 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. # Indicates that the conversation succeeded. + "metadata": { # Custom metadata. Dialogflow doesn't impose any structure on this. + "a_key": "", # Properties of the object. + }, + }, + "endInteraction": { # 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. # Output only. A signal that indicates the interaction with the Dialogflow agent has ended. This message is generated by Dialogflow only when the conversation reaches `END_SESSION` page. It is not supposed to be defined by the user. It's guaranteed that there is at most one such message in each response. + }, + "knowledgeInfoCard": { # Represents info card response. If the response contains generative knowledge prediction, Dialogflow will return a payload with Infobot Messenger compatible info card. Otherwise, the info card response is skipped. # Represents info card for knowledge answers, to be better rendered in Dialogflow Messenger. + }, + "liveAgentHandoff": { # 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. # Hands off conversation to a human agent. + "metadata": { # Custom metadata for your handoff procedure. Dialogflow doesn't impose any structure on this. + "a_key": "", # Properties of the object. + }, + }, + "mixedAudio": { # 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. # Output only. An audio response message composed of both the synthesized Dialogflow agent responses and responses defined via play_audio. This message is generated by Dialogflow only and not supposed to be defined by the user. + "segments": [ # Segments this audio response is composed of. + { # Represents one segment of audio. + "allowPlaybackInterruption": True or False, # 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. + "audio": "A String", # Raw audio synthesized from the Dialogflow agent's response using the output config specified in the request. + "uri": "A String", # Client-specific URI that points to an audio clip accessible to the client. Dialogflow does not impose any validation on it. + }, + ], + }, + "outputAudioText": { # A text or ssml response that is preferentially used for TTS output audio synthesis, as described in the comment on the ResponseMessage message. # A text or ssml response that is preferentially used for TTS output audio synthesis, as described in the comment on the ResponseMessage message. + "allowPlaybackInterruption": True or False, # 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. + "ssml": "A String", # The SSML text to be synthesized. For more information, see [SSML](/speech/text-to-speech/docs/ssml). + "text": "A String", # The raw text to be synthesized. + }, + "payload": { # Returns a response containing a custom, platform-specific payload. + "a_key": "", # Properties of the object. + }, + "playAudio": { # Specifies an audio clip to be played by the client as part of the response. # Signal that the client should play an audio clip hosted at a client-specific URI. Dialogflow uses this to construct mixed_audio. However, Dialogflow itself does not try to read or process the URI in any way. + "allowPlaybackInterruption": True or False, # 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. + "audioUri": "A String", # Required. URI of the audio clip. Dialogflow does not impose any validation on this value. It is specific to the client that reads it. + }, + "telephonyTransferCall": { # Represents the signal that telles the client to transfer the phone call connected to the agent to a third-party endpoint. # A signal that the client should transfer the phone call connected to this agent to a third-party endpoint. + "phoneNumber": "A String", # Transfer the call to a phone number in [E.164 format](https://en.wikipedia.org/wiki/E.164). + }, + "text": { # The text response message. # Returns a text response. + "allowPlaybackInterruption": True or False, # 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. + "text": [ # Required. A collection of text responses. + "A String", + ], + }, + "toolCall": { # Represents a call of a specific tool's action with the specified inputs. # Returns the definition of a tool call that should be executed by the client. + "action": "A String", # Required. The name of the tool's action associated with this call. + "inputParameters": { # Optional. The action's input parameters. + "a_key": "", # Properties of the object. + }, + "tool": "A String", # Required. The tool associated with this call. Format: `projects//locations//agents//tools/`. + }, + }, + }, + ], + "condition": "A String", # The condition to activate and select this case. Empty means the condition is always true. The condition is evaluated against form parameters or session parameters. See the [conditions reference](https://cloud.google.com/dialogflow/cx/docs/reference/condition). + }, + ], + }, + ], + "enableGenerativeFallback": True or False, # If the flag is true, the agent will utilize LLM to generate a text response. If LLM generation fails, the defined responses in the fulfillment will be respected. This flag is only useful for fulfillments associated with no-match event handlers. + "messages": [ # The list of rich message responses to present to the user. + { # 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. + "channel": "A String", # The channel which the response is associated with. Clients can specify the channel via QueryParameters.channel, and only associated channel response will be returned. + "conversationSuccess": { # 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. # Indicates that the conversation succeeded. + "metadata": { # Custom metadata. Dialogflow doesn't impose any structure on this. + "a_key": "", # Properties of the object. + }, + }, + "endInteraction": { # 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. # Output only. A signal that indicates the interaction with the Dialogflow agent has ended. This message is generated by Dialogflow only when the conversation reaches `END_SESSION` page. It is not supposed to be defined by the user. It's guaranteed that there is at most one such message in each response. + }, + "knowledgeInfoCard": { # Represents info card response. If the response contains generative knowledge prediction, Dialogflow will return a payload with Infobot Messenger compatible info card. Otherwise, the info card response is skipped. # Represents info card for knowledge answers, to be better rendered in Dialogflow Messenger. + }, + "liveAgentHandoff": { # 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. # Hands off conversation to a human agent. + "metadata": { # Custom metadata for your handoff procedure. Dialogflow doesn't impose any structure on this. + "a_key": "", # Properties of the object. + }, + }, + "mixedAudio": { # 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. # Output only. An audio response message composed of both the synthesized Dialogflow agent responses and responses defined via play_audio. This message is generated by Dialogflow only and not supposed to be defined by the user. + "segments": [ # Segments this audio response is composed of. + { # Represents one segment of audio. + "allowPlaybackInterruption": True or False, # 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. + "audio": "A String", # Raw audio synthesized from the Dialogflow agent's response using the output config specified in the request. + "uri": "A String", # Client-specific URI that points to an audio clip accessible to the client. Dialogflow does not impose any validation on it. + }, + ], + }, + "outputAudioText": { # A text or ssml response that is preferentially used for TTS output audio synthesis, as described in the comment on the ResponseMessage message. # A text or ssml response that is preferentially used for TTS output audio synthesis, as described in the comment on the ResponseMessage message. + "allowPlaybackInterruption": True or False, # 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. + "ssml": "A String", # The SSML text to be synthesized. For more information, see [SSML](/speech/text-to-speech/docs/ssml). + "text": "A String", # The raw text to be synthesized. + }, + "payload": { # Returns a response containing a custom, platform-specific payload. + "a_key": "", # Properties of the object. + }, + "playAudio": { # Specifies an audio clip to be played by the client as part of the response. # Signal that the client should play an audio clip hosted at a client-specific URI. Dialogflow uses this to construct mixed_audio. However, Dialogflow itself does not try to read or process the URI in any way. + "allowPlaybackInterruption": True or False, # 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. + "audioUri": "A String", # Required. URI of the audio clip. Dialogflow does not impose any validation on this value. It is specific to the client that reads it. + }, + "telephonyTransferCall": { # Represents the signal that telles the client to transfer the phone call connected to the agent to a third-party endpoint. # A signal that the client should transfer the phone call connected to this agent to a third-party endpoint. + "phoneNumber": "A String", # Transfer the call to a phone number in [E.164 format](https://en.wikipedia.org/wiki/E.164). + }, + "text": { # The text response message. # Returns a text response. + "allowPlaybackInterruption": True or False, # 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. + "text": [ # Required. A collection of text responses. + "A String", + ], + }, + "toolCall": { # Represents a call of a specific tool's action with the specified inputs. # Returns the definition of a tool call that should be executed by the client. + "action": "A String", # Required. The name of the tool's action associated with this call. + "inputParameters": { # Optional. The action's input parameters. + "a_key": "", # Properties of the object. + }, + "tool": "A String", # Required. The tool associated with this call. Format: `projects//locations//agents//tools/`. + }, + }, + ], + "returnPartialResponses": True or False, # Whether Dialogflow should return currently queued fulfillment response messages in streaming APIs. If a webhook is specified, it happens before Dialogflow invokes webhook. Warning: 1) This flag only affects streaming API. Responses are still queued and returned once in non-streaming API. 2) The flag can be enabled in any fulfillment but only the first 3 partial responses will be returned. You may only want to apply it to fulfillments that have slow webhooks. + "setParameterActions": [ # Set parameter values before executing the webhook. + { # Setting a parameter value. + "parameter": "A String", # Display name of the parameter. + "value": "", # The new value of the parameter. A null value clears the parameter. + }, + ], + "tag": "A String", # The value of this field will be populated in the WebhookRequest `fulfillmentInfo.tag` field by Dialogflow when the associated webhook is called. The tag is typically used by the webhook service to identify which fulfillment is being called, but it could be used for other purposes. This field is required if `webhook` is specified. + "webhook": "A String", # The webhook to call. Format: `projects//locations//agents//webhooks/`. + }, + }, + ], + }, + "dataStoreConnectionSignals": { # Data store connection feature output signals. Might be only partially field if processing stop before the final answer. Reasons for this can be, but are not limited to: empty UCS search results, positive RAI check outcome, grounding failure, ... # Optional. Data store connection feature output signals. Filled only when data stores are involved in serving the query and DetectIntentRequest.populate data_store_connection_quality_signals is set to true in the request. + "answer": "A String", # Optional. The final compiled answer. + "answerGenerationModelCallSignals": { # Diagnostic info related to the answer generation model call. # Optional. Diagnostic info related to the answer generation model call. + "modelOutput": "A String", # Output of the generative model. + "renderedPrompt": "A String", # Prompt as sent to the model. + }, + "answerParts": [ # Optional. Answer parts with relevant citations. Concatenation of texts should add up the `answer` (not counting whitespaces). + { # Answer part with citation. + "supportingIndices": [ # Citations for this answer part. Indices of `search_snippets`. + 42, + ], + "text": "A String", # Substring of the answer. + }, + ], + "citedSnippets": [ # Optional. Snippets cited by the answer generation model from the most to least relevant. + { # Snippet cited by the answer generation model. + "searchSnippet": { # Search snippet details. # Details of the snippet. + "documentTitle": "A String", # Title of the enclosing document. + "documentUri": "A String", # Uri for the document. Present if specified for the document. + "text": "A String", # Text included in the prompt. + }, + "snippetIndex": 42, # Index of the snippet in `search_snippets` field. + }, + ], + "groundingSignals": { # Grounding signals. # Optional. Grounding signals. + "decision": "A String", # Represents the decision of the grounding check. + "score": "A String", # Grounding score bucket setting. + }, + "rewriterModelCallSignals": { # Diagnostic info related to the rewriter model call. # Optional. Diagnostic info related to the rewriter model call. + "modelOutput": "A String", # Output of the generative model. + "renderedPrompt": "A String", # Prompt as sent to the model. + }, + "rewrittenQuery": "A String", # Optional. Rewritten string query used for search. + "safetySignals": { # Safety check results. # Optional. Safety check result. + "bannedPhraseMatch": "A String", # Specifies banned phrase match subject. + "decision": "A String", # Safety decision. + "matchedBannedPhrase": "A String", # The matched banned phrase if there was a match. + }, + "searchSnippets": [ # Optional. Search snippets included in the answer generation prompt. + { # Search snippet details. + "documentTitle": "A String", # Title of the enclosing document. + "documentUri": "A String", # Uri for the document. Present if specified for the document. + "text": "A String", # Text included in the prompt. + }, + ], + }, + "diagnosticInfo": { # The free-form diagnostic info. For example, this field could contain webhook call latency. The fields of this data can change without notice, so you should not write code that depends on its structure. One of the fields is called "Alternative Matched Intents", which may aid with debugging. The following describes these intent results: - The list is empty if no intent was matched to end-user input. - Only intents that are referenced in the currently active flow are included. - The matched intent is included. - Other intents that could have matched end-user input, but did not match because they are referenced by intent routes that are out of [scope](https://cloud.google.com/dialogflow/cx/docs/concept/handler#scope), are included. - Other intents referenced by intent routes in scope that matched end-user input, but had a lower confidence score. + "a_key": "", # Properties of the object. + }, + "dtmf": { # Represents the input for dtmf event. # If a DTMF was provided as input, this field will contain a copy of the DtmfInput. + "digits": "A String", # The dtmf digits. + "finishDigit": "A String", # The finish digit (if any). + }, + "generativeInfo": { # Represents the information of a query if handled by generative agent resources. # The information of a query if handled by generative agent resources. + "actionTracingInfo": { # Example represents a sample execution of the playbook in the conversation. An example consists of a list of ordered actions performed by end user or Dialogflow agent according the playbook instructions to fulfill the task. # The actions performed by the generative playbook for the current agent response. + "actions": [ # Required. The ordered list of actions performed by the end user and the Dialogflow agent. + { # Action performed by end user or Dialogflow agent in the conversation. + "agentUtterance": { # AgentUtterance represents one message sent by the agent. # Optional. Action performed by the agent as a message. + "text": "A String", # Required. Message content in text. + }, + "flowInvocation": { # Stores metadata of the invocation of a CX flow. Next Id: 7 # Optional. Action performed on behalf of the agent by invoking a CX flow. + "flow": "A String", # Required. The unique identifier of the flow. Format: `projects//locations//agents/`. + "flowState": "A String", # Required. Flow invocation's output state. + "inputActionParameters": { # Optional. A list of input parameters for the flow. + "a_key": "", # Properties of the object. + }, + "outputActionParameters": { # Optional. A list of output parameters generated by the flow invocation. + "a_key": "", # Properties of the object. + }, + }, + "playbookInvocation": { # Stores metadata of the invocation of a child playbook. Next Id: 5 # Optional. Action performed on behalf of the agent by invoking a child playbook. + "playbook": "A String", # Required. The unique identifier of the playbook. Format: `projects//locations//agents//playbooks/`. + "playbookInput": { # Input of the playbook. # Optional. Input of the child playbook invocation. + "actionParameters": { # Optional. A list of input parameters for the action. + "a_key": "", # Properties of the object. + }, + "precedingConversationSummary": "A String", # Optional. Summary string of the preceding conversation for the child playbook invocation. + }, + "playbookOutput": { # Output of the playbook. # Optional. Output of the child playbook invocation. + "actionParameters": { # Optional. A Struct object of output parameters for the action. + "a_key": "", # Properties of the object. + }, + "executionSummary": "A String", # Optional. Summary string of the execution result of the child playbook. + }, + "playbookState": "A String", # Required. Playbook invocation's output state. + }, + "toolUse": { # Stores metadata of the invocation of an action supported by a tool. # Optional. Action performed on behalf of the agent by calling a plugin tool. + "action": "A String", # Optional. Name of the action to be called during the tool use. + "inputActionParameters": { # Optional. A list of input parameters for the action. + "a_key": "", # Properties of the object. + }, + "outputActionParameters": { # Optional. A list of output parameters generated by the action. + "a_key": "", # Properties of the object. + }, + "tool": "A String", # Required. The tool that should be used. Format: `projects//locations//agents//tools/`. + }, + "userUtterance": { # UserUtterance represents one message sent by the customer. # Optional. Agent obtained a message from the customer. + "text": "A String", # Required. Message content in text. + }, + }, + ], + "conversationState": "A String", # Required. Example's output state. + "createTime": "A String", # Output only. The timestamp of initial example creation. + "description": "A String", # Optional. The high level concise description of the example. The max number of characters is 200. + "displayName": "A String", # Required. The display name of the example. + "languageCode": "A String", # Optional. The language code of the example. If not specified, the agent's default language is used. Note: languages must be enabled in the agent before they can be used. + "name": "A String", # The unique identifier of the playbook example. Format: `projects//locations//agents//playbooks//examples/`. + "playbookInput": { # Input of the playbook. # Optional. The input to the playbook in the example. + "actionParameters": { # Optional. A list of input parameters for the action. + "a_key": "", # Properties of the object. + }, + "precedingConversationSummary": "A String", # Optional. Summary string of the preceding conversation for the child playbook invocation. + }, + "playbookOutput": { # Output of the playbook. # Optional. The output of the playbook in the example. + "actionParameters": { # Optional. A Struct object of output parameters for the action. + "a_key": "", # Properties of the object. + }, + "executionSummary": "A String", # Optional. Summary string of the execution result of the child playbook. + }, + "tokenCount": "A String", # Output only. Estimated number of tokes current example takes when sent to the LLM. + "updateTime": "A String", # Output only. Last time the example was updated. + }, + "currentPlaybooks": [ # The stack of playbooks that the conversation has currently entered, with the most recent one on the top. + "A String", + ], + }, + "intent": { # An intent represents a user's intent to interact with a conversational agent. You can provide information for the Dialogflow API to use to match user input to an intent by adding training phrases (i.e., examples of user input) to your intent. # The Intent that matched the conversational query. Some, not all fields are filled in this message, including but not limited to: `name` and `display_name`. This field is deprecated, please use QueryResult.match instead. + "description": "A String", # Human readable description for better understanding an intent like its scope, content, result etc. Maximum character limit: 140 characters. + "displayName": "A String", # Required. The human-readable name of the intent, unique within the agent. + "isFallback": True or False, # Indicates whether this is a fallback intent. Currently only default fallback intent is allowed in the agent, which is added upon agent creation. Adding training phrases to fallback intent is useful in the case of requests that are mistakenly matched, since training phrases assigned to fallback intents act as negative examples that triggers no-match event. + "labels": { # The key/value metadata to label an intent. Labels can contain lowercase letters, digits and the symbols '-' and '_'. International characters are allowed, including letters from unicase alphabets. Keys must start with a letter. Keys and values can be no longer than 63 characters and no more than 128 bytes. Prefix "sys-" is reserved for Dialogflow defined labels. Currently allowed Dialogflow defined labels include: * sys-head * sys-contextual The above labels do not require value. "sys-head" means the intent is a head intent. "sys-contextual" means the intent is a contextual intent. + "a_key": "A String", + }, + "name": "A String", # The unique identifier of the intent. Required for the Intents.UpdateIntent method. Intents.CreateIntent populates the name automatically. Format: `projects//locations//agents//intents/`. + "parameters": [ # The collection of parameters associated with the intent. + { # Represents an intent parameter. + "entityType": "A String", # Required. The entity type of the parameter. Format: `projects/-/locations/-/agents/-/entityTypes/` for system entity types (for example, `projects/-/locations/-/agents/-/entityTypes/sys.date`), or `projects//locations//agents//entityTypes/` for developer entity types. + "id": "A String", # Required. The unique identifier of the parameter. This field is used by training phrases to annotate their parts. + "isList": True or False, # Indicates whether the parameter represents a list of values. + "redact": True or False, # Indicates whether the parameter content should be redacted in log. If redaction is enabled, the parameter content will be replaced by parameter name during logging. Note: the parameter content is subject to redaction if either parameter level redaction or entity type level redaction is enabled. + }, + ], + "priority": 42, # 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. + "trainingPhrases": [ # The collection of training phrases the agent is trained on to identify the intent. + { # Represents an example that the agent is trained on to identify the intent. + "id": "A String", # Output only. The unique identifier of the training phrase. + "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 `parameter_id` field is set. + { # Represents a part of a training phrase. + "parameterId": "A String", # The parameter used to annotate this part of the training phrase. This field is required for annotated parts of the training phrase. + "text": "A String", # Required. The text for this part. + }, + ], + "repeatCount": 42, # Indicates how many times this example was added to the intent. + }, + ], + }, + "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. This field is deprecated, please use QueryResult.match instead. + "languageCode": "A String", # The language that was triggered during intent detection. See [Language Support](https://cloud.google.com/dialogflow/cx/docs/reference/language) for a list of the currently supported language codes. + "match": { # Represents one match result of MatchIntent. # Intent match result, could be an intent or an event. + "confidence": 3.14, # The confidence of this match. 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. + "event": "A String", # The event that matched the query. Filled for `EVENT`, `NO_MATCH` and `NO_INPUT` match types. + "intent": { # An intent represents a user's intent to interact with a conversational agent. You can provide information for the Dialogflow API to use to match user input to an intent by adding training phrases (i.e., examples of user input) to your intent. # The Intent that matched the query. Some, not all fields are filled in this message, including but not limited to: `name` and `display_name`. Only filled for `INTENT` match type. + "description": "A String", # Human readable description for better understanding an intent like its scope, content, result etc. Maximum character limit: 140 characters. + "displayName": "A String", # Required. The human-readable name of the intent, unique within the agent. + "isFallback": True or False, # Indicates whether this is a fallback intent. Currently only default fallback intent is allowed in the agent, which is added upon agent creation. Adding training phrases to fallback intent is useful in the case of requests that are mistakenly matched, since training phrases assigned to fallback intents act as negative examples that triggers no-match event. + "labels": { # The key/value metadata to label an intent. Labels can contain lowercase letters, digits and the symbols '-' and '_'. International characters are allowed, including letters from unicase alphabets. Keys must start with a letter. Keys and values can be no longer than 63 characters and no more than 128 bytes. Prefix "sys-" is reserved for Dialogflow defined labels. Currently allowed Dialogflow defined labels include: * sys-head * sys-contextual The above labels do not require value. "sys-head" means the intent is a head intent. "sys-contextual" means the intent is a contextual intent. + "a_key": "A String", + }, + "name": "A String", # The unique identifier of the intent. Required for the Intents.UpdateIntent method. Intents.CreateIntent populates the name automatically. Format: `projects//locations//agents//intents/`. + "parameters": [ # The collection of parameters associated with the intent. + { # Represents an intent parameter. + "entityType": "A String", # Required. The entity type of the parameter. Format: `projects/-/locations/-/agents/-/entityTypes/` for system entity types (for example, `projects/-/locations/-/agents/-/entityTypes/sys.date`), or `projects//locations//agents//entityTypes/` for developer entity types. + "id": "A String", # Required. The unique identifier of the parameter. This field is used by training phrases to annotate their parts. + "isList": True or False, # Indicates whether the parameter represents a list of values. + "redact": True or False, # Indicates whether the parameter content should be redacted in log. If redaction is enabled, the parameter content will be replaced by parameter name during logging. Note: the parameter content is subject to redaction if either parameter level redaction or entity type level redaction is enabled. + }, + ], + "priority": 42, # 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. + "trainingPhrases": [ # The collection of training phrases the agent is trained on to identify the intent. + { # Represents an example that the agent is trained on to identify the intent. + "id": "A String", # Output only. The unique identifier of the training phrase. + "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 `parameter_id` field is set. + { # Represents a part of a training phrase. + "parameterId": "A String", # The parameter used to annotate this part of the training phrase. This field is required for annotated parts of the training phrase. + "text": "A String", # Required. The text for this part. + }, + ], + "repeatCount": 42, # Indicates how many times this example was added to the intent. + }, + ], + }, + "matchType": "A String", # Type of this Match. + "parameters": { # The collection of parameters extracted from the query. 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 then use map, otherwise, depending on the parameter value type, it could be one of string, number, boolean, null, list or map. * MapValue value: If parameter's entity type is a composite entity then use map from composite entity property names to property values, otherwise, use parameter value. + "a_key": "", # Properties of the object. + }, + "resolvedInput": "A String", # Final text input which was matched during MatchIntent. This value can be different from original input sent in request because of spelling correction or other processing. + }, + "parameters": { # The collected session 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 then use map, otherwise, depending on the parameter value type, it could be one of string, number, boolean, null, list or map. * MapValue value: If parameter's entity type is a composite entity then use map from composite entity property names to property values, otherwise, use parameter value. + "a_key": "", # Properties of the object. + }, + "responseMessages": [ # The list of rich messages returned to the client. Responses vary from simple text messages to more sophisticated, structured payloads used to drive complex logic. + { # 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. + "channel": "A String", # The channel which the response is associated with. Clients can specify the channel via QueryParameters.channel, and only associated channel response will be returned. + "conversationSuccess": { # 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. # Indicates that the conversation succeeded. + "metadata": { # Custom metadata. Dialogflow doesn't impose any structure on this. + "a_key": "", # Properties of the object. + }, + }, + "endInteraction": { # 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. # Output only. A signal that indicates the interaction with the Dialogflow agent has ended. This message is generated by Dialogflow only when the conversation reaches `END_SESSION` page. It is not supposed to be defined by the user. It's guaranteed that there is at most one such message in each response. + }, + "knowledgeInfoCard": { # Represents info card response. If the response contains generative knowledge prediction, Dialogflow will return a payload with Infobot Messenger compatible info card. Otherwise, the info card response is skipped. # Represents info card for knowledge answers, to be better rendered in Dialogflow Messenger. + }, + "liveAgentHandoff": { # 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. # Hands off conversation to a human agent. + "metadata": { # Custom metadata for your handoff procedure. Dialogflow doesn't impose any structure on this. + "a_key": "", # Properties of the object. + }, + }, + "mixedAudio": { # 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. # Output only. An audio response message composed of both the synthesized Dialogflow agent responses and responses defined via play_audio. This message is generated by Dialogflow only and not supposed to be defined by the user. + "segments": [ # Segments this audio response is composed of. + { # Represents one segment of audio. + "allowPlaybackInterruption": True or False, # 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. + "audio": "A String", # Raw audio synthesized from the Dialogflow agent's response using the output config specified in the request. + "uri": "A String", # Client-specific URI that points to an audio clip accessible to the client. Dialogflow does not impose any validation on it. + }, + ], + }, + "outputAudioText": { # A text or ssml response that is preferentially used for TTS output audio synthesis, as described in the comment on the ResponseMessage message. # A text or ssml response that is preferentially used for TTS output audio synthesis, as described in the comment on the ResponseMessage message. + "allowPlaybackInterruption": True or False, # 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. + "ssml": "A String", # The SSML text to be synthesized. For more information, see [SSML](/speech/text-to-speech/docs/ssml). + "text": "A String", # The raw text to be synthesized. + }, + "payload": { # Returns a response containing a custom, platform-specific payload. + "a_key": "", # Properties of the object. + }, + "playAudio": { # Specifies an audio clip to be played by the client as part of the response. # Signal that the client should play an audio clip hosted at a client-specific URI. Dialogflow uses this to construct mixed_audio. However, Dialogflow itself does not try to read or process the URI in any way. + "allowPlaybackInterruption": True or False, # 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. + "audioUri": "A String", # Required. URI of the audio clip. Dialogflow does not impose any validation on this value. It is specific to the client that reads it. + }, + "telephonyTransferCall": { # Represents the signal that telles the client to transfer the phone call connected to the agent to a third-party endpoint. # A signal that the client should transfer the phone call connected to this agent to a third-party endpoint. + "phoneNumber": "A String", # Transfer the call to a phone number in [E.164 format](https://en.wikipedia.org/wiki/E.164). + }, + "text": { # The text response message. # Returns a text response. + "allowPlaybackInterruption": True or False, # 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. + "text": [ # Required. A collection of text responses. + "A String", + ], + }, + "toolCall": { # Represents a call of a specific tool's action with the specified inputs. # Returns the definition of a tool call that should be executed by the client. + "action": "A String", # Required. The name of the tool's action associated with this call. + "inputParameters": { # Optional. The action's input parameters. "a_key": "", # Properties of the object. }, + "tool": "A String", # Required. The tool associated with this call. Format: `projects//locations//agents//tools/`. + }, + }, + ], + "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. # The sentiment analyss result, which depends on `analyze_query_text_sentiment`, specified in the request. + "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). + "score": 3.14, # Sentiment score between -1.0 (negative sentiment) and 1.0 (positive sentiment). + }, + "text": "A String", # If natural language text was provided as input, this field will contain a copy of the text. + "transcript": "A String", # If natural language speech audio was provided as input, this field will contain the transcript for the audio. + "triggerEvent": "A String", # If an event was provided as input, this field will contain the name of the event. + "triggerIntent": "A String", # If an intent was provided as input, this field will contain a copy of the intent identifier. Format: `projects//locations//agents//intents/`. + "webhookDisplayNames": [ # The list of webhook display names in the order of call sequence. + "A String", + ], + "webhookIds": [ # The list of webhook ids in the order of call sequence. + "A String", + ], + "webhookLatencies": [ # The list of webhook latencies in the order of call sequence. + "A String", + ], + "webhookPayloads": [ # The list of webhook payload in WebhookResponse.payload, in the order of call sequence. If some webhook call fails or doesn't return any payload, an empty `Struct` would be used instead. + { + "a_key": "", # Properties of the object. + }, + ], + "webhookStatuses": [ # The list of webhook call status in the order of call sequence. + { # 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). + "code": 42, # The status code, which should be an enum value of google.rpc.Code. + "details": [ # A list of messages that carry the error details. There is a common set of message types for APIs to use. + { + "a_key": "", # Properties of the object. Contains field @type with type URL. + }, + ], + "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. + }, + ], + "webhookTags": [ # The list of webhook tags in the order of call sequence. + "A String", + ], + }, + "responseId": "A String", # Output only. The unique identifier of the response. It can be used to locate a response in the training example set or for reporting issues. + "responseType": "A String", # Response type. +}
+
+ +
+ fulfillIntent(session, body=None, x__xgafv=None) +
Fulfills a matched intent returned by MatchIntent. Must be called after MatchIntent, with input from MatchIntentResponse. Otherwise, the behavior is undefined.
+
+Args:
+  session: string, Required. The name of the session this query is sent to. Format: `projects//locations//agents//sessions/` or `projects//locations//agents//environments//sessions/`. If `Environment ID` is not specified, we assume default 'draft' environment. It's up to the API caller to choose an appropriate `Session ID`. It can be a random number or some type of session identifiers (preferably hashed). The length of the `Session ID` must not exceed 36 characters. For more information, see the [sessions guide](https://cloud.google.com/dialogflow/cx/docs/concept/session). (required)
+  body: object, The request body.
+    The object takes the form of:
+
+{ # Request of FulfillIntent
+  "match": { # Represents one match result of MatchIntent. # The matched intent/event to fulfill.
+    "confidence": 3.14, # The confidence of this match. 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.
+    "event": "A String", # The event that matched the query. Filled for `EVENT`, `NO_MATCH` and `NO_INPUT` match types.
+    "intent": { # An intent represents a user's intent to interact with a conversational agent. You can provide information for the Dialogflow API to use to match user input to an intent by adding training phrases (i.e., examples of user input) to your intent. # The Intent that matched the query. Some, not all fields are filled in this message, including but not limited to: `name` and `display_name`. Only filled for `INTENT` match type.
+      "description": "A String", # Human readable description for better understanding an intent like its scope, content, result etc. Maximum character limit: 140 characters.
+      "displayName": "A String", # Required. The human-readable name of the intent, unique within the agent.
+      "isFallback": True or False, # Indicates whether this is a fallback intent. Currently only default fallback intent is allowed in the agent, which is added upon agent creation. Adding training phrases to fallback intent is useful in the case of requests that are mistakenly matched, since training phrases assigned to fallback intents act as negative examples that triggers no-match event.
+      "labels": { # The key/value metadata to label an intent. Labels can contain lowercase letters, digits and the symbols '-' and '_'. International characters are allowed, including letters from unicase alphabets. Keys must start with a letter. Keys and values can be no longer than 63 characters and no more than 128 bytes. Prefix "sys-" is reserved for Dialogflow defined labels. Currently allowed Dialogflow defined labels include: * sys-head * sys-contextual The above labels do not require value. "sys-head" means the intent is a head intent. "sys-contextual" means the intent is a contextual intent.
+        "a_key": "A String",
+      },
+      "name": "A String", # The unique identifier of the intent. Required for the Intents.UpdateIntent method. Intents.CreateIntent populates the name automatically. Format: `projects//locations//agents//intents/`.
+      "parameters": [ # The collection of parameters associated with the intent.
+        { # Represents an intent parameter.
+          "entityType": "A String", # Required. The entity type of the parameter. Format: `projects/-/locations/-/agents/-/entityTypes/` for system entity types (for example, `projects/-/locations/-/agents/-/entityTypes/sys.date`), or `projects//locations//agents//entityTypes/` for developer entity types.
+          "id": "A String", # Required. The unique identifier of the parameter. This field is used by training phrases to annotate their parts.
+          "isList": True or False, # Indicates whether the parameter represents a list of values.
+          "redact": True or False, # Indicates whether the parameter content should be redacted in log. If redaction is enabled, the parameter content will be replaced by parameter name during logging. Note: the parameter content is subject to redaction if either parameter level redaction or entity type level redaction is enabled.
+        },
+      ],
+      "priority": 42, # 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.
+      "trainingPhrases": [ # The collection of training phrases the agent is trained on to identify the intent.
+        { # Represents an example that the agent is trained on to identify the intent.
+          "id": "A String", # Output only. The unique identifier of the training phrase.
+          "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 `parameter_id` field is set.
+            { # Represents a part of a training phrase.
+              "parameterId": "A String", # The parameter used to annotate this part of the training phrase. This field is required for annotated parts of the training phrase.
+              "text": "A String", # Required. The text for this part.
+            },
+          ],
+          "repeatCount": 42, # Indicates how many times this example was added to the intent.
+        },
+      ],
+    },
+    "matchType": "A String", # Type of this Match.
+    "parameters": { # The collection of parameters extracted from the query. 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 then use map, otherwise, depending on the parameter value type, it could be one of string, number, boolean, null, list or map. * MapValue value: If parameter's entity type is a composite entity then use map from composite entity property names to property values, otherwise, use parameter value.
+      "a_key": "", # Properties of the object.
+    },
+    "resolvedInput": "A String", # Final text input which was matched during MatchIntent. This value can be different from original input sent in request because of spelling correction or other processing.
+  },
+  "matchIntentRequest": { # Request of MatchIntent. # Must be same as the corresponding MatchIntent request, otherwise the behavior is undefined.
+    "persistParameterChanges": True or False, # Persist session parameter changes from `query_params`.
+    "queryInput": { # Represents the query input. It can contain one of: 1. A conversational query in the form of text. 2. An intent query that specifies which intent to trigger. 3. Natural language speech audio to be processed. 4. An event to be triggered. 5. DTMF digits to invoke an intent and fill in parameter value. 6. The results of a tool executed by the client. # Required. The input specification.
+      "audio": { # Represents the natural speech audio to be processed. # The natural language speech audio to be processed.
+        "audio": "A String", # The natural language speech audio to be processed. A single request can contain up to 2 minutes of speech audio data. The transcribed text cannot contain more than 256 bytes. For non-streaming audio detect intent, both `config` and `audio` must be provided. For streaming audio detect intent, `config` must be provided in the first request and `audio` must be provided in all following requests.
+        "config": { # Instructs the speech recognizer on how to process the audio content. # Required. Instructs the speech recognizer how to process the speech audio.
+          "audioEncoding": "A String", # Required. Audio encoding of the audio content to process.
+          "bargeInConfig": { # Configuration of the barge-in behavior. Barge-in instructs the API to return a detected utterance at a proper time while the client is playing back the response audio from a previous request. When the client sees the utterance, it should stop the playback and immediately get ready for receiving the responses for the current request. The barge-in handling requires the client to start streaming audio input as soon as it starts playing back the audio from the previous response. The playback is modeled into two phases: * No barge-in phase: which goes first and during which speech detection should not be carried out. * Barge-in phase: which follows the no barge-in phase and during which the API starts speech detection and may inform the client that an utterance has been detected. Note that no-speech event is not expected in this phase. The client provides this configuration in terms of the durations of those two phases. The durations are measured in terms of the audio length from the the start of the input audio. No-speech event is a response with END_OF_UTTERANCE without any transcript following up. # Configuration of barge-in behavior during the streaming of input audio.
+            "noBargeInDuration": "A String", # Duration that is not eligible for barge-in at the beginning of the input audio.
+            "totalDuration": "A String", # Total duration for the playback at the beginning of the input audio.
+          },
+          "enableWordInfo": True or False, # Optional. If `true`, Dialogflow returns SpeechWordInfo in StreamingRecognitionResult with information about the recognized speech words, e.g. start and end time offsets. If false or unspecified, Speech doesn't return any word-level information.
+          "model": "A String", # Optional. Which Speech model to select for the given request. For more information, see [Speech models](https://cloud.google.com/dialogflow/cx/docs/concept/speech-models).
+          "modelVariant": "A String", # Optional. Which variant of the Speech model to use.
+          "optOutConformerModelMigration": True or False, # If `true`, the request will opt out for STT conformer model migration. This field will be deprecated once force migration takes place in June 2024. Please refer to [Dialogflow CX Speech model migration](https://cloud.google.com/dialogflow/cx/docs/concept/speech-model-migration).
+          "phraseHints": [ # Optional. A list of strings containing words and phrases that the speech recognizer should recognize with higher likelihood. See [the Cloud Speech documentation](https://cloud.google.com/speech-to-text/docs/basics#phrase-hints) for more details.
+            "A String",
+          ],
+          "sampleRateHertz": 42, # Sample rate (in Hertz) of the audio content sent in the query. Refer to [Cloud Speech API documentation](https://cloud.google.com/speech-to-text/docs/basics) for more details.
+          "singleUtterance": True or False, # Optional. If `false` (default), recognition does not cease until the client closes the stream. If `true`, the recognizer will detect a single spoken utterance in input audio. Recognition ceases when it detects the audio's voice has stopped or paused. In this case, once a detected intent is received, the client should close the stream and start a new request with a new stream as needed. Note: This setting is relevant only for streaming methods.
+        },
+      },
+      "dtmf": { # Represents the input for dtmf event. # The DTMF event to be handled.
+        "digits": "A String", # The dtmf digits.
+        "finishDigit": "A String", # The finish digit (if any).
+      },
+      "event": { # Represents the event to trigger. # The event to be triggered.
+        "event": "A String", # Name of the event.
+      },
+      "intent": { # Represents the intent to trigger programmatically rather than as a result of natural language processing. # The intent to be triggered.
+        "intent": "A String", # Required. The unique identifier of the intent. Format: `projects//locations//agents//intents/`.
+      },
+      "languageCode": "A String", # Required. The language of the input. See [Language Support](https://cloud.google.com/dialogflow/cx/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.
+      "text": { # Represents the natural language text to be processed. # The natural language text to be processed.
+        "text": "A String", # Required. The UTF-8 encoded natural language text to be processed.
+      },
+      "toolCallResult": { # The result of calling a tool's action that has been executed by the client. # The results of a tool executed by the client.
+        "action": "A String", # Required. The name of the tool's action associated with this call.
+        "error": { # An error produced by the tool call. # The tool call's error.
+          "message": "A String", # Optional. The error message of the function.
+        },
+        "outputParameters": { # The tool call's output parameters.
+          "a_key": "", # Properties of the object.
+        },
+        "tool": "A String", # Required. The tool associated with this call. Format: `projects//locations//agents//tools/`.
+      },
+    },
+    "queryParams": { # Represents the parameters of a conversational query. # The parameters of this query.
+      "analyzeQueryTextSentiment": True or False, # Configures whether sentiment analysis should be performed. If not provided, sentiment analysis is not performed.
+      "channel": "A String", # The channel which this query is for. If specified, only the ResponseMessage associated with the channel will be returned. If no ResponseMessage is associated with the channel, it falls back to the ResponseMessage with unspecified channel. If unspecified, the ResponseMessage with unspecified channel will be returned.
+      "currentPage": "A String", # The unique identifier of the page to override the current page in the session. Format: `projects//locations//agents//flows//pages/`. If `current_page` is specified, the previous state of the session will be ignored by Dialogflow, including the previous page and the previous session parameters. In most cases, current_page and parameters should be configured together to direct a session to a specific state.
+      "currentPlaybook": "A String", # Optional. Start the session with the specified playbook. You can only specify the playbook at the beginning of the session. Otherwise, an error will be thrown. Format: `projects//locations//agents//playbooks/`.
+      "disableWebhook": True or False, # Whether to disable webhook calls for this request.
+      "endUserMetadata": { # Optional. Information about the end-user to improve the relevance and accuracy of generative answers. This will be interpreted and used by a language model, so, for good results, the data should be self-descriptive, and in a simple structure. Example: ```json { "subscription plan": "Business Premium Plus", "devices owned": [ {"model": "Google Pixel 7"}, {"model": "Google Pixel Tablet"} ] } ```
+        "a_key": "", # Properties of the object.
+      },
+      "flowVersions": [ # A list of flow versions to override for the request. Format: `projects//locations//agents//flows//versions/`. If version 1 of flow X is included in this list, the traffic of flow X will go through version 1 regardless of the version configuration in the environment. Each flow can have at most one version specified in this list.
+        "A String",
+      ],
+      "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.
+        "latitude": 3.14, # The latitude in degrees. It must be in the range [-90.0, +90.0].
+        "longitude": 3.14, # The longitude in degrees. It must be in the range [-180.0, +180.0].
+      },
+      "llmModelSettings": { # Settings for LLM models. # Optional. Use the specified LLM model settings for processing the request.
+        "model": "A String", # The selected LLM model.
+        "promptText": "A String", # The custom prompt to use.
+      },
+      "parameters": { # Additional parameters to be put into session parameters. To remove a parameter from the session, clients should explicitly set the parameter value to null. You can reference the session parameters in the agent with the following format: $session.params.parameter-id. 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 then use map, otherwise, depending on the parameter value type, it could be one of string, number, boolean, null, list or map. * MapValue value: If parameter's entity type is a composite entity then use map from composite entity property names to property values, otherwise, use parameter value.
+        "a_key": "", # Properties of the object.
+      },
+      "payload": { # This field can be used to pass custom data into the webhook associated with the agent. Arbitrary JSON objects are supported. Some integrations that query a Dialogflow agent may provide additional information in the payload. In particular, for the Dialogflow Phone Gateway integration, this field has the form: ``` { "telephony": { "caller_id": "+18558363987" } } ```
+        "a_key": "", # Properties of the object.
+      },
+      "populateDataStoreConnectionSignals": True or False, # Optional. If set to true and data stores are involved in serving the request then DetectIntentResponse.query_result.data_store_connection_signals will be filled with data that can help evaluations.
+      "searchConfig": { # Search configuration for UCS search queries. # Optional. Search configuration for UCS search queries.
+        "boostSpecs": [ # Optional. Boosting configuration for the datastores.
+          { # Boost specifications for data stores.
+            "dataStores": [ # Optional. Data Stores where the boosting configuration is applied. The full names of the referenced data stores. Formats: `projects/{project}/locations/{location}/collections/{collection}/dataStores/{data_store}` `projects/{project}/locations/{location}/dataStores/{data_store}
+              "A String",
+            ],
+            "spec": [ # Optional. A list of boosting specifications.
+              { # Boost specification to boost certain documents. A copy of google.cloud.discoveryengine.v1main.BoostSpec, field documentation is available at https://cloud.google.com/generative-ai-app-builder/docs/reference/rest/v1alpha/BoostSpec
+                "conditionBoostSpecs": [ # Optional. Condition boost specifications. If a document matches multiple conditions in the specifictions, boost scores from these specifications are all applied and combined in a non-linear way. Maximum number of specifications is 20.
+                  { # Boost applies to documents which match a condition.
+                    "boost": 3.14, # Optional. Strength of the condition boost, which should be in [-1, 1]. Negative boost means demotion. Default is 0.0. Setting to 1.0 gives the document a big promotion. However, it does not necessarily mean that the boosted document will be the top result at all times, nor that other documents will be excluded. Results could still be shown even when none of them matches the condition. And results that are significantly more relevant to the search query can still trump your heavily favored but irrelevant documents. Setting to -1.0 gives the document a big demotion. However, results that are deeply relevant might still be shown. The document will have an upstream battle to get a fairly high ranking, but it is not blocked out completely. Setting to 0.0 means no boost applied. The boosting condition is ignored.
+                    "condition": "A String", # Optional. An expression which specifies a boost condition. The syntax and supported fields are the same as a filter expression. Examples: * To boost documents with document ID "doc_1" or "doc_2", and color "Red" or "Blue": * (id: ANY("doc_1", "doc_2")) AND (color: ANY("Red","Blue"))
+                  },
+                ],
+              },
+            ],
+          },
+        ],
+        "filterSpecs": [ # Optional. Filter configuration for the datastores.
+          { # Filter specifications for data stores.
+            "dataStores": [ # Optional. Data Stores where the boosting configuration is applied. The full names of the referenced data stores. Formats: `projects/{project}/locations/{location}/collections/{collection}/dataStores/{data_store}` `projects/{project}/locations/{location}/dataStores/{data_store}
+              "A String",
+            ],
+            "filter": "A String", # Optional. The filter expression to be applied. Expression syntax is documented at https://cloud.google.com/generative-ai-app-builder/docs/filter-search-metadata#filter-expression-syntax
+          },
+        ],
+      },
+      "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.
+        { # Session entity types are referred to as **User** entity types and are entities that are built for an individual user such as favorites, preferences, playlists, and so on. You can redefine a session entity type at the session level to extend or replace a custom entity type at the user session level (we refer to the entity types defined at the agent level as "custom entity types"). Note: session entity types apply to all queries, regardless of the language. For more information about entity types, see the [Dialogflow documentation](https://cloud.google.com/dialogflow/docs/entities-overview).
+          "entities": [ # Required. The collection of entities to override or supplement the custom entity type.
+            { # An **entity entry** for an associated entity type.
+              "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`.
+                "A String",
+              ],
+              "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 canonical 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).
+            },
+          ],
+          "entityOverrideMode": "A String", # Required. Indicates whether the additional data should override or supplement the custom entity type definition.
+          "name": "A String", # Required. The unique identifier of the session entity type. Format: `projects//locations//agents//sessions//entityTypes/` or `projects//locations//agents//environments//sessions//entityTypes/`. If `Environment ID` is not specified, we assume default 'draft' environment.
+        },
+      ],
+      "sessionTtl": "A String", # Optional. Configure lifetime of the Dialogflow session. By default, a Dialogflow session remains active and its data is stored for 30 minutes after the last request is sent for the session. This value should be no longer than 1 day.
+      "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 the agent is used.
+      "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 Dialogflow web console. The headers defined within this field will overwrite the headers configured through 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.
+        "a_key": "A String",
+      },
+    },
+  },
+  "outputAudioConfig": { # Instructs the speech synthesizer how to generate the output audio content. # Instructs the speech synthesizer how to generate output audio.
+    "audioEncoding": "A String", # Required. Audio encoding of the synthesized audio content.
+    "sampleRateHertz": 42, # Optional. 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).
+    "synthesizeSpeechConfig": { # Configuration of how speech should be synthesized. # Optional. Configuration of how speech should be synthesized. If not specified, Agent.text_to_speech_settings is applied.
+      "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.
+        "A String",
+      ],
+      "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.
+      "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.
+      "voice": { # Description of which voice to use for speech synthesis. # Optional. The desired voice of the synthesized audio.
+        "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. For the list of available voices, please refer to [Supported voices and languages](https://cloud.google.com/text-to-speech/docs/voices).
+        "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.
+      },
+      "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.
+    },
+  },
+}
+
+  x__xgafv: string, V1 error format.
+    Allowed values
+      1 - v1 error format
+      2 - v2 error format
+
+Returns:
+  An object of the form:
+
+    { # Response of FulfillIntent
+  "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.response_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.
+  "outputAudioConfig": { # Instructs the speech synthesizer how to generate the output audio content. # The config used by the speech synthesizer to generate the output audio.
+    "audioEncoding": "A String", # Required. Audio encoding of the synthesized audio content.
+    "sampleRateHertz": 42, # Optional. 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).
+    "synthesizeSpeechConfig": { # Configuration of how speech should be synthesized. # Optional. Configuration of how speech should be synthesized. If not specified, Agent.text_to_speech_settings is applied.
+      "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.
+        "A String",
+      ],
+      "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.
+      "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.
+      "voice": { # Description of which voice to use for speech synthesis. # Optional. The desired voice of the synthesized audio.
+        "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. For the list of available voices, please refer to [Supported voices and languages](https://cloud.google.com/text-to-speech/docs/voices).
+        "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.
+      },
+      "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.
+    },
+  },
+  "queryResult": { # Represents the result of a conversational query. # The result of the conversational query.
+    "advancedSettings": { # Hierarchical advanced settings for agent/flow/page/fulfillment/parameter. Settings exposed at lower level overrides the settings exposed at higher level. Overriding occurs at the sub-setting level. For example, the playback_interruption_settings at fulfillment level only overrides the playback_interruption_settings at the agent level, leaving other settings at the agent level unchanged. DTMF settings does not override each other. DTMF settings set at different levels define DTMF detections running in parallel. Hierarchy: Agent->Flow->Page->Fulfillment/Parameter. # Returns the current advanced settings including IVR settings. Even though the operations configured by these settings are performed by Dialogflow, the client may need to perform special logic at the moment. For example, if Dialogflow exports audio to Google Cloud Storage, then the client may need to wait for the resulting object to appear in the bucket before proceeding.
+      "audioExportGcsDestination": { # Google Cloud Storage location for a Dialogflow operation that writes or exports objects (e.g. exported agent or transcripts) outside of Dialogflow. # If present, incoming audio is exported by Dialogflow to the configured Google Cloud Storage destination. Exposed at the following levels: - Agent level - Flow level
+        "uri": "A String", # Required. The Google Cloud Storage URI for the exported objects. A URI is of the form: `gs://bucket/object-name-or-prefix` Whether a full object name, or just a prefix, its usage depends on the Dialogflow operation.
+      },
+      "dtmfSettings": { # Define behaviors for DTMF (dual tone multi frequency). # Settings for DTMF. Exposed at the following levels: - Agent level - Flow level - Page level - Parameter level.
+        "enabled": True or False, # If true, incoming audio is processed for DTMF (dual tone multi frequency) events. For example, if the caller presses a button on their telephone keypad and DTMF processing is enabled, Dialogflow will detect the event (e.g. a "3" was pressed) in the incoming audio and pass the event to the bot to drive business logic (e.g. when 3 is pressed, return the account balance).
+        "endpointingTimeoutDuration": "A String", # Endpoint timeout setting for matching dtmf input to regex.
+        "finishDigit": "A String", # The digit that terminates a DTMF digit sequence.
+        "interdigitTimeoutDuration": "A String", # Interdigit timeout setting for matching dtmf input to regex.
+        "maxDigits": 42, # Max length of DTMF digits.
+      },
+      "loggingSettings": { # Define behaviors on logging. # Settings for logging. Settings for Dialogflow History, Contact Center messages, StackDriver logs, and speech logging. Exposed at the following levels: - Agent level.
+        "enableInteractionLogging": True or False, # Enables DF Interaction logging.
+        "enableStackdriverLogging": True or False, # Enables StackDriver logging.
+      },
+      "speechSettings": { # Define behaviors of speech to text detection. # Settings for speech to text detection. Exposed at the following levels: - Agent level - Flow level - Page level - Parameter level
+        "endpointerSensitivity": 42, # Sensitivity of the speech model that detects the end of speech. Scale from 0 to 100.
+        "models": { # Mapping from language to Speech-to-Text model. The mapped Speech-to-Text model will be selected for requests from its corresponding language. For more information, see [Speech models](https://cloud.google.com/dialogflow/cx/docs/concept/speech-models).
+          "a_key": "A String",
+        },
+        "noSpeechTimeout": "A String", # Timeout before detecting no speech.
+        "useTimeoutBasedEndpointing": True or False, # Use timeout based endpointing, interpreting endpointer sensitivy as seconds of timeout value.
+      },
+    },
+    "allowAnswerFeedback": True or False, # Indicates whether the Thumbs up/Thumbs down rating controls are need to be shown for the response in the Dialogflow Messenger widget.
+    "currentFlow": { # Flows represents the conversation flows when you build your chatbot agent. A flow consists of many pages connected by the transition routes. Conversations always start with the built-in Start Flow (with an all-0 ID). Transition routes can direct the conversation session from the current flow (parent flow) to another flow (sub flow). When the sub flow is finished, Dialogflow will bring the session back to the parent flow, where the sub flow is started. Usually, when a transition route is followed by a matched intent, the intent will be "consumed". This means the intent won't activate more transition routes. However, when the followed transition route moves the conversation session into a different flow, the matched intent can be carried over and to be consumed in the target flow. # The current Flow. Some, not all fields are filled in this message, including but not limited to `name` and `display_name`.
+      "advancedSettings": { # Hierarchical advanced settings for agent/flow/page/fulfillment/parameter. Settings exposed at lower level overrides the settings exposed at higher level. Overriding occurs at the sub-setting level. For example, the playback_interruption_settings at fulfillment level only overrides the playback_interruption_settings at the agent level, leaving other settings at the agent level unchanged. DTMF settings does not override each other. DTMF settings set at different levels define DTMF detections running in parallel. Hierarchy: Agent->Flow->Page->Fulfillment/Parameter. # Hierarchical advanced settings for this flow. The settings exposed at the lower level overrides the settings exposed at the higher level.
+        "audioExportGcsDestination": { # Google Cloud Storage location for a Dialogflow operation that writes or exports objects (e.g. exported agent or transcripts) outside of Dialogflow. # If present, incoming audio is exported by Dialogflow to the configured Google Cloud Storage destination. Exposed at the following levels: - Agent level - Flow level
+          "uri": "A String", # Required. The Google Cloud Storage URI for the exported objects. A URI is of the form: `gs://bucket/object-name-or-prefix` Whether a full object name, or just a prefix, its usage depends on the Dialogflow operation.
+        },
+        "dtmfSettings": { # Define behaviors for DTMF (dual tone multi frequency). # Settings for DTMF. Exposed at the following levels: - Agent level - Flow level - Page level - Parameter level.
+          "enabled": True or False, # If true, incoming audio is processed for DTMF (dual tone multi frequency) events. For example, if the caller presses a button on their telephone keypad and DTMF processing is enabled, Dialogflow will detect the event (e.g. a "3" was pressed) in the incoming audio and pass the event to the bot to drive business logic (e.g. when 3 is pressed, return the account balance).
+          "endpointingTimeoutDuration": "A String", # Endpoint timeout setting for matching dtmf input to regex.
+          "finishDigit": "A String", # The digit that terminates a DTMF digit sequence.
+          "interdigitTimeoutDuration": "A String", # Interdigit timeout setting for matching dtmf input to regex.
+          "maxDigits": 42, # Max length of DTMF digits.
+        },
+        "loggingSettings": { # Define behaviors on logging. # Settings for logging. Settings for Dialogflow History, Contact Center messages, StackDriver logs, and speech logging. Exposed at the following levels: - Agent level.
+          "enableInteractionLogging": True or False, # Enables DF Interaction logging.
+          "enableStackdriverLogging": True or False, # Enables StackDriver logging.
+        },
+        "speechSettings": { # Define behaviors of speech to text detection. # Settings for speech to text detection. Exposed at the following levels: - Agent level - Flow level - Page level - Parameter level
+          "endpointerSensitivity": 42, # Sensitivity of the speech model that detects the end of speech. Scale from 0 to 100.
+          "models": { # Mapping from language to Speech-to-Text model. The mapped Speech-to-Text model will be selected for requests from its corresponding language. For more information, see [Speech models](https://cloud.google.com/dialogflow/cx/docs/concept/speech-models).
+            "a_key": "A String",
+          },
+          "noSpeechTimeout": "A String", # Timeout before detecting no speech.
+          "useTimeoutBasedEndpointing": True or False, # Use timeout based endpointing, interpreting endpointer sensitivy as seconds of timeout value.
+        },
+      },
+      "description": "A String", # The description of the flow. The maximum length is 500 characters. If exceeded, the request is rejected.
+      "displayName": "A String", # Required. The human-readable name of the flow.
+      "eventHandlers": [ # A flow's event handlers serve two purposes: * They are responsible for handling events (e.g. no match, webhook errors) in the flow. * They are inherited by every page's event handlers, which can be used to handle common events regardless of the current page. Event handlers defined in the page have higher priority than those defined in the flow. Unlike transition_routes, these handlers are evaluated on a first-match basis. The first one that matches the event get executed, with the rest being ignored.
+        { # An event handler specifies an event that can be handled during a session. When the specified event happens, the following actions are taken in order: * If there is a `trigger_fulfillment` associated with the event, it will be called. * If there is a `target_page` associated with the event, the session will transition into the specified page. * If there is a `target_flow` associated with the event, the session will transition into the specified flow.
+          "event": "A String", # Required. The name of the event to handle.
+          "name": "A String", # Output only. The unique identifier of this event handler.
+          "targetFlow": "A String", # The target flow to transition to. Format: `projects//locations//agents//flows/`.
+          "targetPage": "A String", # The target page to transition to. Format: `projects//locations//agents//flows//pages/`.
+          "triggerFulfillment": { # A fulfillment can do one or more of the following actions at the same time: * Generate rich message responses. * Set parameter values. * Call the webhook. Fulfillments can be called at various stages in the Page or Form lifecycle. For example, when a DetectIntentRequest drives a session to enter a new page, the page's entry fulfillment can add a static response to the QueryResult in the returning DetectIntentResponse, call the webhook (for example, to load user data from a database), or both. # The fulfillment to call when the event occurs. Handling webhook errors with a fulfillment enabled with webhook could cause infinite loop. It is invalid to specify such fulfillment for a handler handling webhooks.
+            "advancedSettings": { # Hierarchical advanced settings for agent/flow/page/fulfillment/parameter. Settings exposed at lower level overrides the settings exposed at higher level. Overriding occurs at the sub-setting level. For example, the playback_interruption_settings at fulfillment level only overrides the playback_interruption_settings at the agent level, leaving other settings at the agent level unchanged. DTMF settings does not override each other. DTMF settings set at different levels define DTMF detections running in parallel. Hierarchy: Agent->Flow->Page->Fulfillment/Parameter. # Hierarchical advanced settings for this fulfillment. The settings exposed at the lower level overrides the settings exposed at the higher level.
+              "audioExportGcsDestination": { # Google Cloud Storage location for a Dialogflow operation that writes or exports objects (e.g. exported agent or transcripts) outside of Dialogflow. # If present, incoming audio is exported by Dialogflow to the configured Google Cloud Storage destination. Exposed at the following levels: - Agent level - Flow level
+                "uri": "A String", # Required. The Google Cloud Storage URI for the exported objects. A URI is of the form: `gs://bucket/object-name-or-prefix` Whether a full object name, or just a prefix, its usage depends on the Dialogflow operation.
+              },
+              "dtmfSettings": { # Define behaviors for DTMF (dual tone multi frequency). # Settings for DTMF. Exposed at the following levels: - Agent level - Flow level - Page level - Parameter level.
+                "enabled": True or False, # If true, incoming audio is processed for DTMF (dual tone multi frequency) events. For example, if the caller presses a button on their telephone keypad and DTMF processing is enabled, Dialogflow will detect the event (e.g. a "3" was pressed) in the incoming audio and pass the event to the bot to drive business logic (e.g. when 3 is pressed, return the account balance).
+                "endpointingTimeoutDuration": "A String", # Endpoint timeout setting for matching dtmf input to regex.
+                "finishDigit": "A String", # The digit that terminates a DTMF digit sequence.
+                "interdigitTimeoutDuration": "A String", # Interdigit timeout setting for matching dtmf input to regex.
+                "maxDigits": 42, # Max length of DTMF digits.
+              },
+              "loggingSettings": { # Define behaviors on logging. # Settings for logging. Settings for Dialogflow History, Contact Center messages, StackDriver logs, and speech logging. Exposed at the following levels: - Agent level.
+                "enableInteractionLogging": True or False, # Enables DF Interaction logging.
+                "enableStackdriverLogging": True or False, # Enables StackDriver logging.
+              },
+              "speechSettings": { # Define behaviors of speech to text detection. # Settings for speech to text detection. Exposed at the following levels: - Agent level - Flow level - Page level - Parameter level
+                "endpointerSensitivity": 42, # Sensitivity of the speech model that detects the end of speech. Scale from 0 to 100.
+                "models": { # Mapping from language to Speech-to-Text model. The mapped Speech-to-Text model will be selected for requests from its corresponding language. For more information, see [Speech models](https://cloud.google.com/dialogflow/cx/docs/concept/speech-models).
+                  "a_key": "A String",
+                },
+                "noSpeechTimeout": "A String", # Timeout before detecting no speech.
+                "useTimeoutBasedEndpointing": True or False, # Use timeout based endpointing, interpreting endpointer sensitivy as seconds of timeout value.
+              },
+            },
+            "conditionalCases": [ # Conditional cases for this fulfillment.
+              { # A list of cascading if-else conditions. Cases are mutually exclusive. The first one with a matching condition is selected, all the rest ignored.
+                "cases": [ # A list of cascading if-else conditions.
+                  { # Each case has a Boolean condition. When it is evaluated to be True, the corresponding messages will be selected and evaluated recursively.
+                    "caseContent": [ # A list of case content.
+                      { # The list of messages or conditional cases to activate for this case.
+                        "additionalCases": # Object with schema name: GoogleCloudDialogflowCxV3beta1FulfillmentConditionalCases # Additional cases to be evaluated.
+                        "message": { # 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. # Returned message.
+                          "channel": "A String", # The channel which the response is associated with. Clients can specify the channel via QueryParameters.channel, and only associated channel response will be returned.
+                          "conversationSuccess": { # 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. # Indicates that the conversation succeeded.
+                            "metadata": { # Custom metadata. Dialogflow doesn't impose any structure on this.
+                              "a_key": "", # Properties of the object.
+                            },
+                          },
+                          "endInteraction": { # 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. # Output only. A signal that indicates the interaction with the Dialogflow agent has ended. This message is generated by Dialogflow only when the conversation reaches `END_SESSION` page. It is not supposed to be defined by the user. It's guaranteed that there is at most one such message in each response.
+                          },
+                          "knowledgeInfoCard": { # Represents info card response. If the response contains generative knowledge prediction, Dialogflow will return a payload with Infobot Messenger compatible info card. Otherwise, the info card response is skipped. # Represents info card for knowledge answers, to be better rendered in Dialogflow Messenger.
+                          },
+                          "liveAgentHandoff": { # 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. # Hands off conversation to a human agent.
+                            "metadata": { # Custom metadata for your handoff procedure. Dialogflow doesn't impose any structure on this.
+                              "a_key": "", # Properties of the object.
+                            },
+                          },
+                          "mixedAudio": { # 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. # Output only. An audio response message composed of both the synthesized Dialogflow agent responses and responses defined via play_audio. This message is generated by Dialogflow only and not supposed to be defined by the user.
+                            "segments": [ # Segments this audio response is composed of.
+                              { # Represents one segment of audio.
+                                "allowPlaybackInterruption": True or False, # 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.
+                                "audio": "A String", # Raw audio synthesized from the Dialogflow agent's response using the output config specified in the request.
+                                "uri": "A String", # Client-specific URI that points to an audio clip accessible to the client. Dialogflow does not impose any validation on it.
+                              },
+                            ],
+                          },
+                          "outputAudioText": { # A text or ssml response that is preferentially used for TTS output audio synthesis, as described in the comment on the ResponseMessage message. # A text or ssml response that is preferentially used for TTS output audio synthesis, as described in the comment on the ResponseMessage message.
+                            "allowPlaybackInterruption": True or False, # 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.
+                            "ssml": "A String", # The SSML text to be synthesized. For more information, see [SSML](/speech/text-to-speech/docs/ssml).
+                            "text": "A String", # The raw text to be synthesized.
+                          },
+                          "payload": { # Returns a response containing a custom, platform-specific payload.
+                            "a_key": "", # Properties of the object.
+                          },
+                          "playAudio": { # Specifies an audio clip to be played by the client as part of the response. # Signal that the client should play an audio clip hosted at a client-specific URI. Dialogflow uses this to construct mixed_audio. However, Dialogflow itself does not try to read or process the URI in any way.
+                            "allowPlaybackInterruption": True or False, # 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.
+                            "audioUri": "A String", # Required. URI of the audio clip. Dialogflow does not impose any validation on this value. It is specific to the client that reads it.
+                          },
+                          "telephonyTransferCall": { # Represents the signal that telles the client to transfer the phone call connected to the agent to a third-party endpoint. # A signal that the client should transfer the phone call connected to this agent to a third-party endpoint.
+                            "phoneNumber": "A String", # Transfer the call to a phone number in [E.164 format](https://en.wikipedia.org/wiki/E.164).
+                          },
+                          "text": { # The text response message. # Returns a text response.
+                            "allowPlaybackInterruption": True or False, # 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.
+                            "text": [ # Required. A collection of text responses.
+                              "A String",
+                            ],
+                          },
+                          "toolCall": { # Represents a call of a specific tool's action with the specified inputs. # Returns the definition of a tool call that should be executed by the client.
+                            "action": "A String", # Required. The name of the tool's action associated with this call.
+                            "inputParameters": { # Optional. The action's input parameters.
+                              "a_key": "", # Properties of the object.
+                            },
+                            "tool": "A String", # Required. The tool associated with this call. Format: `projects//locations//agents//tools/`.
+                          },
+                        },
+                      },
+                    ],
+                    "condition": "A String", # The condition to activate and select this case. Empty means the condition is always true. The condition is evaluated against form parameters or session parameters. See the [conditions reference](https://cloud.google.com/dialogflow/cx/docs/reference/condition).
+                  },
+                ],
+              },
+            ],
+            "enableGenerativeFallback": True or False, # If the flag is true, the agent will utilize LLM to generate a text response. If LLM generation fails, the defined responses in the fulfillment will be respected. This flag is only useful for fulfillments associated with no-match event handlers.
+            "messages": [ # The list of rich message responses to present to the user.
+              { # 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.
+                "channel": "A String", # The channel which the response is associated with. Clients can specify the channel via QueryParameters.channel, and only associated channel response will be returned.
+                "conversationSuccess": { # 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. # Indicates that the conversation succeeded.
+                  "metadata": { # Custom metadata. Dialogflow doesn't impose any structure on this.
+                    "a_key": "", # Properties of the object.
+                  },
+                },
+                "endInteraction": { # 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. # Output only. A signal that indicates the interaction with the Dialogflow agent has ended. This message is generated by Dialogflow only when the conversation reaches `END_SESSION` page. It is not supposed to be defined by the user. It's guaranteed that there is at most one such message in each response.
+                },
+                "knowledgeInfoCard": { # Represents info card response. If the response contains generative knowledge prediction, Dialogflow will return a payload with Infobot Messenger compatible info card. Otherwise, the info card response is skipped. # Represents info card for knowledge answers, to be better rendered in Dialogflow Messenger.
+                },
+                "liveAgentHandoff": { # 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. # Hands off conversation to a human agent.
+                  "metadata": { # Custom metadata for your handoff procedure. Dialogflow doesn't impose any structure on this.
+                    "a_key": "", # Properties of the object.
+                  },
+                },
+                "mixedAudio": { # 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. # Output only. An audio response message composed of both the synthesized Dialogflow agent responses and responses defined via play_audio. This message is generated by Dialogflow only and not supposed to be defined by the user.
+                  "segments": [ # Segments this audio response is composed of.
+                    { # Represents one segment of audio.
+                      "allowPlaybackInterruption": True or False, # 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.
+                      "audio": "A String", # Raw audio synthesized from the Dialogflow agent's response using the output config specified in the request.
+                      "uri": "A String", # Client-specific URI that points to an audio clip accessible to the client. Dialogflow does not impose any validation on it.
+                    },
+                  ],
+                },
+                "outputAudioText": { # A text or ssml response that is preferentially used for TTS output audio synthesis, as described in the comment on the ResponseMessage message. # A text or ssml response that is preferentially used for TTS output audio synthesis, as described in the comment on the ResponseMessage message.
+                  "allowPlaybackInterruption": True or False, # 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.
+                  "ssml": "A String", # The SSML text to be synthesized. For more information, see [SSML](/speech/text-to-speech/docs/ssml).
+                  "text": "A String", # The raw text to be synthesized.
+                },
+                "payload": { # Returns a response containing a custom, platform-specific payload.
+                  "a_key": "", # Properties of the object.
+                },
+                "playAudio": { # Specifies an audio clip to be played by the client as part of the response. # Signal that the client should play an audio clip hosted at a client-specific URI. Dialogflow uses this to construct mixed_audio. However, Dialogflow itself does not try to read or process the URI in any way.
+                  "allowPlaybackInterruption": True or False, # 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.
+                  "audioUri": "A String", # Required. URI of the audio clip. Dialogflow does not impose any validation on this value. It is specific to the client that reads it.
+                },
+                "telephonyTransferCall": { # Represents the signal that telles the client to transfer the phone call connected to the agent to a third-party endpoint. # A signal that the client should transfer the phone call connected to this agent to a third-party endpoint.
+                  "phoneNumber": "A String", # Transfer the call to a phone number in [E.164 format](https://en.wikipedia.org/wiki/E.164).
+                },
+                "text": { # The text response message. # Returns a text response.
+                  "allowPlaybackInterruption": True or False, # 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.
+                  "text": [ # Required. A collection of text responses.
+                    "A String",
+                  ],
+                },
+                "toolCall": { # Represents a call of a specific tool's action with the specified inputs. # Returns the definition of a tool call that should be executed by the client.
+                  "action": "A String", # Required. The name of the tool's action associated with this call.
+                  "inputParameters": { # Optional. The action's input parameters.
+                    "a_key": "", # Properties of the object.
+                  },
+                  "tool": "A String", # Required. The tool associated with this call. Format: `projects//locations//agents//tools/`.
+                },
+              },
+            ],
+            "returnPartialResponses": True or False, # Whether Dialogflow should return currently queued fulfillment response messages in streaming APIs. If a webhook is specified, it happens before Dialogflow invokes webhook. Warning: 1) This flag only affects streaming API. Responses are still queued and returned once in non-streaming API. 2) The flag can be enabled in any fulfillment but only the first 3 partial responses will be returned. You may only want to apply it to fulfillments that have slow webhooks.
+            "setParameterActions": [ # Set parameter values before executing the webhook.
+              { # Setting a parameter value.
+                "parameter": "A String", # Display name of the parameter.
+                "value": "", # The new value of the parameter. A null value clears the parameter.
+              },
+            ],
+            "tag": "A String", # The value of this field will be populated in the WebhookRequest `fulfillmentInfo.tag` field by Dialogflow when the associated webhook is called. The tag is typically used by the webhook service to identify which fulfillment is being called, but it could be used for other purposes. This field is required if `webhook` is specified.
+            "webhook": "A String", # The webhook to call. Format: `projects//locations//agents//webhooks/`.
+          },
         },
-        "mixedAudio": { # 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. # Output only. An audio response message composed of both the synthesized Dialogflow agent responses and responses defined via play_audio. This message is generated by Dialogflow only and not supposed to be defined by the user.
-          "segments": [ # Segments this audio response is composed of.
-            { # Represents one segment of audio.
-              "allowPlaybackInterruption": True or False, # 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.
-              "audio": "A String", # Raw audio synthesized from the Dialogflow agent's response using the output config specified in the request.
-              "uri": "A String", # Client-specific URI that points to an audio clip accessible to the client. Dialogflow does not impose any validation on it.
+      ],
+      "knowledgeConnectorSettings": { # The Knowledge Connector settings for this page or flow. This includes information such as the attached Knowledge Bases, and the way to execute fulfillment. # Optional. Knowledge connector configuration.
+        "dataStoreConnections": [ # Optional. List of related data store connections.
+          { # A data store connection. It represents a data store in Discovery Engine and the type of the contents it contains.
+            "dataStore": "A String", # The full name of the referenced data store. Formats: `projects/{project}/locations/{location}/collections/{collection}/dataStores/{data_store}` `projects/{project}/locations/{location}/dataStores/{data_store}`
+            "dataStoreType": "A String", # The type of the connected data store.
+          },
+        ],
+        "enabled": True or False, # Whether Knowledge Connector is enabled or not.
+        "targetFlow": "A String", # The target flow to transition to. Format: `projects//locations//agents//flows/`.
+        "targetPage": "A String", # The target page to transition to. Format: `projects//locations//agents//flows//pages/`.
+        "triggerFulfillment": { # A fulfillment can do one or more of the following actions at the same time: * Generate rich message responses. * Set parameter values. * Call the webhook. Fulfillments can be called at various stages in the Page or Form lifecycle. For example, when a DetectIntentRequest drives a session to enter a new page, the page's entry fulfillment can add a static response to the QueryResult in the returning DetectIntentResponse, call the webhook (for example, to load user data from a database), or both. # The fulfillment to be triggered. When the answers from the Knowledge Connector are selected by Dialogflow, you can utitlize the request scoped parameter `$request.knowledge.answers` (contains up to the 5 highest confidence answers) and `$request.knowledge.questions` (contains the corresponding questions) to construct the fulfillment.
+          "advancedSettings": { # Hierarchical advanced settings for agent/flow/page/fulfillment/parameter. Settings exposed at lower level overrides the settings exposed at higher level. Overriding occurs at the sub-setting level. For example, the playback_interruption_settings at fulfillment level only overrides the playback_interruption_settings at the agent level, leaving other settings at the agent level unchanged. DTMF settings does not override each other. DTMF settings set at different levels define DTMF detections running in parallel. Hierarchy: Agent->Flow->Page->Fulfillment/Parameter. # Hierarchical advanced settings for this fulfillment. The settings exposed at the lower level overrides the settings exposed at the higher level.
+            "audioExportGcsDestination": { # Google Cloud Storage location for a Dialogflow operation that writes or exports objects (e.g. exported agent or transcripts) outside of Dialogflow. # If present, incoming audio is exported by Dialogflow to the configured Google Cloud Storage destination. Exposed at the following levels: - Agent level - Flow level
+              "uri": "A String", # Required. The Google Cloud Storage URI for the exported objects. A URI is of the form: `gs://bucket/object-name-or-prefix` Whether a full object name, or just a prefix, its usage depends on the Dialogflow operation.
+            },
+            "dtmfSettings": { # Define behaviors for DTMF (dual tone multi frequency). # Settings for DTMF. Exposed at the following levels: - Agent level - Flow level - Page level - Parameter level.
+              "enabled": True or False, # If true, incoming audio is processed for DTMF (dual tone multi frequency) events. For example, if the caller presses a button on their telephone keypad and DTMF processing is enabled, Dialogflow will detect the event (e.g. a "3" was pressed) in the incoming audio and pass the event to the bot to drive business logic (e.g. when 3 is pressed, return the account balance).
+              "endpointingTimeoutDuration": "A String", # Endpoint timeout setting for matching dtmf input to regex.
+              "finishDigit": "A String", # The digit that terminates a DTMF digit sequence.
+              "interdigitTimeoutDuration": "A String", # Interdigit timeout setting for matching dtmf input to regex.
+              "maxDigits": 42, # Max length of DTMF digits.
+            },
+            "loggingSettings": { # Define behaviors on logging. # Settings for logging. Settings for Dialogflow History, Contact Center messages, StackDriver logs, and speech logging. Exposed at the following levels: - Agent level.
+              "enableInteractionLogging": True or False, # Enables DF Interaction logging.
+              "enableStackdriverLogging": True or False, # Enables StackDriver logging.
+            },
+            "speechSettings": { # Define behaviors of speech to text detection. # Settings for speech to text detection. Exposed at the following levels: - Agent level - Flow level - Page level - Parameter level
+              "endpointerSensitivity": 42, # Sensitivity of the speech model that detects the end of speech. Scale from 0 to 100.
+              "models": { # Mapping from language to Speech-to-Text model. The mapped Speech-to-Text model will be selected for requests from its corresponding language. For more information, see [Speech models](https://cloud.google.com/dialogflow/cx/docs/concept/speech-models).
+                "a_key": "A String",
+              },
+              "noSpeechTimeout": "A String", # Timeout before detecting no speech.
+              "useTimeoutBasedEndpointing": True or False, # Use timeout based endpointing, interpreting endpointer sensitivy as seconds of timeout value.
+            },
+          },
+          "conditionalCases": [ # Conditional cases for this fulfillment.
+            { # A list of cascading if-else conditions. Cases are mutually exclusive. The first one with a matching condition is selected, all the rest ignored.
+              "cases": [ # A list of cascading if-else conditions.
+                { # Each case has a Boolean condition. When it is evaluated to be True, the corresponding messages will be selected and evaluated recursively.
+                  "caseContent": [ # A list of case content.
+                    { # The list of messages or conditional cases to activate for this case.
+                      "additionalCases": # Object with schema name: GoogleCloudDialogflowCxV3beta1FulfillmentConditionalCases # Additional cases to be evaluated.
+                      "message": { # 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. # Returned message.
+                        "channel": "A String", # The channel which the response is associated with. Clients can specify the channel via QueryParameters.channel, and only associated channel response will be returned.
+                        "conversationSuccess": { # 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. # Indicates that the conversation succeeded.
+                          "metadata": { # Custom metadata. Dialogflow doesn't impose any structure on this.
+                            "a_key": "", # Properties of the object.
+                          },
+                        },
+                        "endInteraction": { # 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. # Output only. A signal that indicates the interaction with the Dialogflow agent has ended. This message is generated by Dialogflow only when the conversation reaches `END_SESSION` page. It is not supposed to be defined by the user. It's guaranteed that there is at most one such message in each response.
+                        },
+                        "knowledgeInfoCard": { # Represents info card response. If the response contains generative knowledge prediction, Dialogflow will return a payload with Infobot Messenger compatible info card. Otherwise, the info card response is skipped. # Represents info card for knowledge answers, to be better rendered in Dialogflow Messenger.
+                        },
+                        "liveAgentHandoff": { # 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. # Hands off conversation to a human agent.
+                          "metadata": { # Custom metadata for your handoff procedure. Dialogflow doesn't impose any structure on this.
+                            "a_key": "", # Properties of the object.
+                          },
+                        },
+                        "mixedAudio": { # 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. # Output only. An audio response message composed of both the synthesized Dialogflow agent responses and responses defined via play_audio. This message is generated by Dialogflow only and not supposed to be defined by the user.
+                          "segments": [ # Segments this audio response is composed of.
+                            { # Represents one segment of audio.
+                              "allowPlaybackInterruption": True or False, # 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.
+                              "audio": "A String", # Raw audio synthesized from the Dialogflow agent's response using the output config specified in the request.
+                              "uri": "A String", # Client-specific URI that points to an audio clip accessible to the client. Dialogflow does not impose any validation on it.
+                            },
+                          ],
+                        },
+                        "outputAudioText": { # A text or ssml response that is preferentially used for TTS output audio synthesis, as described in the comment on the ResponseMessage message. # A text or ssml response that is preferentially used for TTS output audio synthesis, as described in the comment on the ResponseMessage message.
+                          "allowPlaybackInterruption": True or False, # 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.
+                          "ssml": "A String", # The SSML text to be synthesized. For more information, see [SSML](/speech/text-to-speech/docs/ssml).
+                          "text": "A String", # The raw text to be synthesized.
+                        },
+                        "payload": { # Returns a response containing a custom, platform-specific payload.
+                          "a_key": "", # Properties of the object.
+                        },
+                        "playAudio": { # Specifies an audio clip to be played by the client as part of the response. # Signal that the client should play an audio clip hosted at a client-specific URI. Dialogflow uses this to construct mixed_audio. However, Dialogflow itself does not try to read or process the URI in any way.
+                          "allowPlaybackInterruption": True or False, # 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.
+                          "audioUri": "A String", # Required. URI of the audio clip. Dialogflow does not impose any validation on this value. It is specific to the client that reads it.
+                        },
+                        "telephonyTransferCall": { # Represents the signal that telles the client to transfer the phone call connected to the agent to a third-party endpoint. # A signal that the client should transfer the phone call connected to this agent to a third-party endpoint.
+                          "phoneNumber": "A String", # Transfer the call to a phone number in [E.164 format](https://en.wikipedia.org/wiki/E.164).
+                        },
+                        "text": { # The text response message. # Returns a text response.
+                          "allowPlaybackInterruption": True or False, # 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.
+                          "text": [ # Required. A collection of text responses.
+                            "A String",
+                          ],
+                        },
+                        "toolCall": { # Represents a call of a specific tool's action with the specified inputs. # Returns the definition of a tool call that should be executed by the client.
+                          "action": "A String", # Required. The name of the tool's action associated with this call.
+                          "inputParameters": { # Optional. The action's input parameters.
+                            "a_key": "", # Properties of the object.
+                          },
+                          "tool": "A String", # Required. The tool associated with this call. Format: `projects//locations//agents//tools/`.
+                        },
+                      },
+                    },
+                  ],
+                  "condition": "A String", # The condition to activate and select this case. Empty means the condition is always true. The condition is evaluated against form parameters or session parameters. See the [conditions reference](https://cloud.google.com/dialogflow/cx/docs/reference/condition).
+                },
+              ],
+            },
+          ],
+          "enableGenerativeFallback": True or False, # If the flag is true, the agent will utilize LLM to generate a text response. If LLM generation fails, the defined responses in the fulfillment will be respected. This flag is only useful for fulfillments associated with no-match event handlers.
+          "messages": [ # The list of rich message responses to present to the user.
+            { # 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.
+              "channel": "A String", # The channel which the response is associated with. Clients can specify the channel via QueryParameters.channel, and only associated channel response will be returned.
+              "conversationSuccess": { # 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. # Indicates that the conversation succeeded.
+                "metadata": { # Custom metadata. Dialogflow doesn't impose any structure on this.
+                  "a_key": "", # Properties of the object.
+                },
+              },
+              "endInteraction": { # 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. # Output only. A signal that indicates the interaction with the Dialogflow agent has ended. This message is generated by Dialogflow only when the conversation reaches `END_SESSION` page. It is not supposed to be defined by the user. It's guaranteed that there is at most one such message in each response.
+              },
+              "knowledgeInfoCard": { # Represents info card response. If the response contains generative knowledge prediction, Dialogflow will return a payload with Infobot Messenger compatible info card. Otherwise, the info card response is skipped. # Represents info card for knowledge answers, to be better rendered in Dialogflow Messenger.
+              },
+              "liveAgentHandoff": { # 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. # Hands off conversation to a human agent.
+                "metadata": { # Custom metadata for your handoff procedure. Dialogflow doesn't impose any structure on this.
+                  "a_key": "", # Properties of the object.
+                },
+              },
+              "mixedAudio": { # 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. # Output only. An audio response message composed of both the synthesized Dialogflow agent responses and responses defined via play_audio. This message is generated by Dialogflow only and not supposed to be defined by the user.
+                "segments": [ # Segments this audio response is composed of.
+                  { # Represents one segment of audio.
+                    "allowPlaybackInterruption": True or False, # 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.
+                    "audio": "A String", # Raw audio synthesized from the Dialogflow agent's response using the output config specified in the request.
+                    "uri": "A String", # Client-specific URI that points to an audio clip accessible to the client. Dialogflow does not impose any validation on it.
+                  },
+                ],
+              },
+              "outputAudioText": { # A text or ssml response that is preferentially used for TTS output audio synthesis, as described in the comment on the ResponseMessage message. # A text or ssml response that is preferentially used for TTS output audio synthesis, as described in the comment on the ResponseMessage message.
+                "allowPlaybackInterruption": True or False, # 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.
+                "ssml": "A String", # The SSML text to be synthesized. For more information, see [SSML](/speech/text-to-speech/docs/ssml).
+                "text": "A String", # The raw text to be synthesized.
+              },
+              "payload": { # Returns a response containing a custom, platform-specific payload.
+                "a_key": "", # Properties of the object.
+              },
+              "playAudio": { # Specifies an audio clip to be played by the client as part of the response. # Signal that the client should play an audio clip hosted at a client-specific URI. Dialogflow uses this to construct mixed_audio. However, Dialogflow itself does not try to read or process the URI in any way.
+                "allowPlaybackInterruption": True or False, # 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.
+                "audioUri": "A String", # Required. URI of the audio clip. Dialogflow does not impose any validation on this value. It is specific to the client that reads it.
+              },
+              "telephonyTransferCall": { # Represents the signal that telles the client to transfer the phone call connected to the agent to a third-party endpoint. # A signal that the client should transfer the phone call connected to this agent to a third-party endpoint.
+                "phoneNumber": "A String", # Transfer the call to a phone number in [E.164 format](https://en.wikipedia.org/wiki/E.164).
+              },
+              "text": { # The text response message. # Returns a text response.
+                "allowPlaybackInterruption": True or False, # 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.
+                "text": [ # Required. A collection of text responses.
+                  "A String",
+                ],
+              },
+              "toolCall": { # Represents a call of a specific tool's action with the specified inputs. # Returns the definition of a tool call that should be executed by the client.
+                "action": "A String", # Required. The name of the tool's action associated with this call.
+                "inputParameters": { # Optional. The action's input parameters.
+                  "a_key": "", # Properties of the object.
+                },
+                "tool": "A String", # Required. The tool associated with this call. Format: `projects//locations//agents//tools/`.
+              },
             },
           ],
-        },
-        "outputAudioText": { # A text or ssml response that is preferentially used for TTS output audio synthesis, as described in the comment on the ResponseMessage message. # A text or ssml response that is preferentially used for TTS output audio synthesis, as described in the comment on the ResponseMessage message.
-          "allowPlaybackInterruption": True or False, # 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.
-          "ssml": "A String", # The SSML text to be synthesized. For more information, see [SSML](/speech/text-to-speech/docs/ssml).
-          "text": "A String", # The raw text to be synthesized.
-        },
-        "payload": { # Returns a response containing a custom, platform-specific payload.
-          "a_key": "", # Properties of the object.
-        },
-        "playAudio": { # Specifies an audio clip to be played by the client as part of the response. # Signal that the client should play an audio clip hosted at a client-specific URI. Dialogflow uses this to construct mixed_audio. However, Dialogflow itself does not try to read or process the URI in any way.
-          "allowPlaybackInterruption": True or False, # 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.
-          "audioUri": "A String", # Required. URI of the audio clip. Dialogflow does not impose any validation on this value. It is specific to the client that reads it.
-        },
-        "telephonyTransferCall": { # Represents the signal that telles the client to transfer the phone call connected to the agent to a third-party endpoint. # A signal that the client should transfer the phone call connected to this agent to a third-party endpoint.
-          "phoneNumber": "A String", # Transfer the call to a phone number in [E.164 format](https://en.wikipedia.org/wiki/E.164).
-        },
-        "text": { # The text response message. # Returns a text response.
-          "allowPlaybackInterruption": True or False, # 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.
-          "text": [ # Required. A collection of text responses.
-            "A String",
-          ],
-        },
-      },
-    ],
-    "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. # The sentiment analyss result, which depends on `analyze_query_text_sentiment`, specified in the request.
-      "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).
-      "score": 3.14, # Sentiment score between -1.0 (negative sentiment) and 1.0 (positive sentiment).
-    },
-    "text": "A String", # If natural language text was provided as input, this field will contain a copy of the text.
-    "transcript": "A String", # If natural language speech audio was provided as input, this field will contain the transcript for the audio.
-    "triggerEvent": "A String", # If an event was provided as input, this field will contain the name of the event.
-    "triggerIntent": "A String", # If an intent was provided as input, this field will contain a copy of the intent identifier. Format: `projects//locations//agents//intents/`.
-    "webhookDisplayNames": [ # The list of webhook display names in the order of call sequence.
-      "A String",
-    ],
-    "webhookIds": [ # The list of webhook ids in the order of call sequence.
-      "A String",
-    ],
-    "webhookLatencies": [ # The list of webhook latencies in the order of call sequence.
-      "A String",
-    ],
-    "webhookPayloads": [ # The list of webhook payload in WebhookResponse.payload, in the order of call sequence. If some webhook call fails or doesn't return any payload, an empty `Struct` would be used instead.
-      {
-        "a_key": "", # Properties of the object.
-      },
-    ],
-    "webhookStatuses": [ # The list of webhook call status in the order of call sequence.
-      { # 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).
-        "code": 42, # The status code, which should be an enum value of google.rpc.Code.
-        "details": [ # A list of messages that carry the error details. There is a common set of message types for APIs to use.
-          {
-            "a_key": "", # Properties of the object. Contains field @type with type URL.
-          },
-        ],
-        "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.
-      },
-    ],
-    "webhookTags": [ # The list of webhook tags in the order of call sequence.
-      "A String",
-    ],
-  },
-  "responseId": "A String", # Output only. The unique identifier of the response. It can be used to locate a response in the training example set or for reporting issues.
-  "responseType": "A String", # Response type.
-}
-
- -
- fulfillIntent(session, body=None, x__xgafv=None) -
Fulfills a matched intent returned by MatchIntent. Must be called after MatchIntent, with input from MatchIntentResponse. Otherwise, the behavior is undefined.
-
-Args:
-  session: string, Required. The name of the session this query is sent to. Format: `projects//locations//agents//sessions/` or `projects//locations//agents//environments//sessions/`. If `Environment ID` is not specified, we assume default 'draft' environment. It's up to the API caller to choose an appropriate `Session ID`. It can be a random number or some type of session identifiers (preferably hashed). The length of the `Session ID` must not exceed 36 characters. For more information, see the [sessions guide](https://cloud.google.com/dialogflow/cx/docs/concept/session). (required)
-  body: object, The request body.
-    The object takes the form of:
-
-{ # Request of FulfillIntent
-  "match": { # Represents one match result of MatchIntent. # The matched intent/event to fulfill.
-    "confidence": 3.14, # The confidence of this match. 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.
-    "event": "A String", # The event that matched the query. Filled for `EVENT`, `NO_MATCH` and `NO_INPUT` match types.
-    "intent": { # An intent represents a user's intent to interact with a conversational agent. You can provide information for the Dialogflow API to use to match user input to an intent by adding training phrases (i.e., examples of user input) to your intent. # The Intent that matched the query. Some, not all fields are filled in this message, including but not limited to: `name` and `display_name`. Only filled for `INTENT` match type.
-      "description": "A String", # Human readable description for better understanding an intent like its scope, content, result etc. Maximum character limit: 140 characters.
-      "displayName": "A String", # Required. The human-readable name of the intent, unique within the agent.
-      "isFallback": True or False, # Indicates whether this is a fallback intent. Currently only default fallback intent is allowed in the agent, which is added upon agent creation. Adding training phrases to fallback intent is useful in the case of requests that are mistakenly matched, since training phrases assigned to fallback intents act as negative examples that triggers no-match event.
-      "labels": { # The key/value metadata to label an intent. Labels can contain lowercase letters, digits and the symbols '-' and '_'. International characters are allowed, including letters from unicase alphabets. Keys must start with a letter. Keys and values can be no longer than 63 characters and no more than 128 bytes. Prefix "sys-" is reserved for Dialogflow defined labels. Currently allowed Dialogflow defined labels include: * sys-head * sys-contextual The above labels do not require value. "sys-head" means the intent is a head intent. "sys-contextual" means the intent is a contextual intent.
-        "a_key": "A String",
-      },
-      "name": "A String", # The unique identifier of the intent. Required for the Intents.UpdateIntent method. Intents.CreateIntent populates the name automatically. Format: `projects//locations//agents//intents/`.
-      "parameters": [ # The collection of parameters associated with the intent.
-        { # Represents an intent parameter.
-          "entityType": "A String", # Required. The entity type of the parameter. Format: `projects/-/locations/-/agents/-/entityTypes/` for system entity types (for example, `projects/-/locations/-/agents/-/entityTypes/sys.date`), or `projects//locations//agents//entityTypes/` for developer entity types.
-          "id": "A String", # Required. The unique identifier of the parameter. This field is used by training phrases to annotate their parts.
-          "isList": True or False, # Indicates whether the parameter represents a list of values.
-          "redact": True or False, # Indicates whether the parameter content should be redacted in log. If redaction is enabled, the parameter content will be replaced by parameter name during logging. Note: the parameter content is subject to redaction if either parameter level redaction or entity type level redaction is enabled.
-        },
-      ],
-      "priority": 42, # 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.
-      "trainingPhrases": [ # The collection of training phrases the agent is trained on to identify the intent.
-        { # Represents an example that the agent is trained on to identify the intent.
-          "id": "A String", # Output only. The unique identifier of the training phrase.
-          "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 `parameter_id` field is set.
-            { # Represents a part of a training phrase.
-              "parameterId": "A String", # The parameter used to annotate this part of the training phrase. This field is required for annotated parts of the training phrase.
-              "text": "A String", # Required. The text for this part.
+          "returnPartialResponses": True or False, # Whether Dialogflow should return currently queued fulfillment response messages in streaming APIs. If a webhook is specified, it happens before Dialogflow invokes webhook. Warning: 1) This flag only affects streaming API. Responses are still queued and returned once in non-streaming API. 2) The flag can be enabled in any fulfillment but only the first 3 partial responses will be returned. You may only want to apply it to fulfillments that have slow webhooks.
+          "setParameterActions": [ # Set parameter values before executing the webhook.
+            { # Setting a parameter value.
+              "parameter": "A String", # Display name of the parameter.
+              "value": "", # The new value of the parameter. A null value clears the parameter.
             },
           ],
-          "repeatCount": 42, # Indicates how many times this example was added to the intent.
-        },
-      ],
-    },
-    "matchType": "A String", # Type of this Match.
-    "parameters": { # The collection of parameters extracted from the query. 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 then use map, otherwise, depending on the parameter value type, it could be one of string, number, boolean, null, list or map. * MapValue value: If parameter's entity type is a composite entity then use map from composite entity property names to property values, otherwise, use parameter value.
-      "a_key": "", # Properties of the object.
-    },
-    "resolvedInput": "A String", # Final text input which was matched during MatchIntent. This value can be different from original input sent in request because of spelling correction or other processing.
-  },
-  "matchIntentRequest": { # Request of MatchIntent. # Must be same as the corresponding MatchIntent request, otherwise the behavior is undefined.
-    "persistParameterChanges": True or False, # Persist session parameter changes from `query_params`.
-    "queryInput": { # Represents the query input. It can contain one of: 1. A conversational query in the form of text. 2. An intent query that specifies which intent to trigger. 3. Natural language speech audio to be processed. 4. An event to be triggered. 5. DTMF digits to invoke an intent and fill in parameter value. 6. The results of a tool executed by the client. # Required. The input specification.
-      "audio": { # Represents the natural speech audio to be processed. # The natural language speech audio to be processed.
-        "audio": "A String", # The natural language speech audio to be processed. A single request can contain up to 2 minutes of speech audio data. The transcribed text cannot contain more than 256 bytes. For non-streaming audio detect intent, both `config` and `audio` must be provided. For streaming audio detect intent, `config` must be provided in the first request and `audio` must be provided in all following requests.
-        "config": { # Instructs the speech recognizer on how to process the audio content. # Required. Instructs the speech recognizer how to process the speech audio.
-          "audioEncoding": "A String", # Required. Audio encoding of the audio content to process.
-          "bargeInConfig": { # Configuration of the barge-in behavior. Barge-in instructs the API to return a detected utterance at a proper time while the client is playing back the response audio from a previous request. When the client sees the utterance, it should stop the playback and immediately get ready for receiving the responses for the current request. The barge-in handling requires the client to start streaming audio input as soon as it starts playing back the audio from the previous response. The playback is modeled into two phases: * No barge-in phase: which goes first and during which speech detection should not be carried out. * Barge-in phase: which follows the no barge-in phase and during which the API starts speech detection and may inform the client that an utterance has been detected. Note that no-speech event is not expected in this phase. The client provides this configuration in terms of the durations of those two phases. The durations are measured in terms of the audio length from the the start of the input audio. No-speech event is a response with END_OF_UTTERANCE without any transcript following up. # Configuration of barge-in behavior during the streaming of input audio.
-            "noBargeInDuration": "A String", # Duration that is not eligible for barge-in at the beginning of the input audio.
-            "totalDuration": "A String", # Total duration for the playback at the beginning of the input audio.
-          },
-          "enableWordInfo": True or False, # Optional. If `true`, Dialogflow returns SpeechWordInfo in StreamingRecognitionResult with information about the recognized speech words, e.g. start and end time offsets. If false or unspecified, Speech doesn't return any word-level information.
-          "model": "A String", # Optional. Which Speech model to select for the given request. For more information, see [Speech models](https://cloud.google.com/dialogflow/cx/docs/concept/speech-models).
-          "modelVariant": "A String", # Optional. Which variant of the Speech model to use.
-          "optOutConformerModelMigration": True or False, # If `true`, the request will opt out for STT conformer model migration. This field will be deprecated once force migration takes place in June 2024. Please refer to [Dialogflow CX Speech model migration](https://cloud.google.com/dialogflow/cx/docs/concept/speech-model-migration).
-          "phraseHints": [ # Optional. A list of strings containing words and phrases that the speech recognizer should recognize with higher likelihood. See [the Cloud Speech documentation](https://cloud.google.com/speech-to-text/docs/basics#phrase-hints) for more details.
-            "A String",
-          ],
-          "sampleRateHertz": 42, # Sample rate (in Hertz) of the audio content sent in the query. Refer to [Cloud Speech API documentation](https://cloud.google.com/speech-to-text/docs/basics) for more details.
-          "singleUtterance": True or False, # Optional. If `false` (default), recognition does not cease until the client closes the stream. If `true`, the recognizer will detect a single spoken utterance in input audio. Recognition ceases when it detects the audio's voice has stopped or paused. In this case, once a detected intent is received, the client should close the stream and start a new request with a new stream as needed. Note: This setting is relevant only for streaming methods.
+          "tag": "A String", # The value of this field will be populated in the WebhookRequest `fulfillmentInfo.tag` field by Dialogflow when the associated webhook is called. The tag is typically used by the webhook service to identify which fulfillment is being called, but it could be used for other purposes. This field is required if `webhook` is specified.
+          "webhook": "A String", # The webhook to call. Format: `projects//locations//agents//webhooks/`.
         },
       },
-      "dtmf": { # Represents the input for dtmf event. # The DTMF event to be handled.
-        "digits": "A String", # The dtmf digits.
-        "finishDigit": "A String", # The finish digit (if any).
-      },
-      "event": { # Represents the event to trigger. # The event to be triggered.
-        "event": "A String", # Name of the event.
-      },
-      "intent": { # Represents the intent to trigger programmatically rather than as a result of natural language processing. # The intent to be triggered.
-        "intent": "A String", # Required. The unique identifier of the intent. Format: `projects//locations//agents//intents/`.
-      },
-      "languageCode": "A String", # Required. The language of the input. See [Language Support](https://cloud.google.com/dialogflow/cx/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.
-      "text": { # Represents the natural language text to be processed. # The natural language text to be processed.
-        "text": "A String", # Required. The UTF-8 encoded natural language text to be processed.
+      "multiLanguageSettings": { # Settings for multi-lingual agents. # Optional. Multi-lingual agent settings for this flow.
+        "enableMultiLanguageDetection": True or False, # Optional. Enable multi-language detection for this flow. This can be set only if agent level multi language setting is enabled.
+        "supportedResponseLanguageCodes": [ # Optional. Agent will respond in the detected language if the detected language code is in the supported resolved languages for this flow. This will be used only if multi-language training is enabled in the agent and multi-language detection is enabled in the flow. The supported languages must be a subset of the languages supported by the agent.
+          "A String",
+        ],
       },
-    },
-    "queryParams": { # Represents the parameters of a conversational query. # The parameters of this query.
-      "analyzeQueryTextSentiment": True or False, # Configures whether sentiment analysis should be performed. If not provided, sentiment analysis is not performed.
-      "channel": "A String", # The channel which this query is for. If specified, only the ResponseMessage associated with the channel will be returned. If no ResponseMessage is associated with the channel, it falls back to the ResponseMessage with unspecified channel. If unspecified, the ResponseMessage with unspecified channel will be returned.
-      "currentPage": "A String", # The unique identifier of the page to override the current page in the session. Format: `projects//locations//agents//flows//pages/`. If `current_page` is specified, the previous state of the session will be ignored by Dialogflow, including the previous page and the previous session parameters. In most cases, current_page and parameters should be configured together to direct a session to a specific state.
-      "disableWebhook": True or False, # Whether to disable webhook calls for this request.
-      "endUserMetadata": { # Optional. Information about the end-user to improve the relevance and accuracy of generative answers. This will be interpreted and used by a language model, so, for good results, the data should be self-descriptive, and in a simple structure. Example: ```json { "subscription plan": "Business Premium Plus", "devices owned": [ {"model": "Google Pixel 7"}, {"model": "Google Pixel Tablet"} ] } ```
-        "a_key": "", # Properties of the object.
+      "name": "A String", # The unique identifier of the flow. Format: `projects//locations//agents//flows/`.
+      "nluSettings": { # Settings related to NLU. # NLU related settings of the flow.
+        "classificationThreshold": 3.14, # To filter out false positive results and still get variety in matched natural language inputs for your agent, you can tune the machine learning classification threshold. If the returned score value is less than the threshold value, then a no-match event will be triggered. The score values range from 0.0 (completely uncertain) to 1.0 (completely certain). If set to 0.0, the default of 0.3 is used.
+        "modelTrainingMode": "A String", # Indicates NLU model training mode.
+        "modelType": "A String", # Indicates the type of NLU model.
       },
-      "flowVersions": [ # A list of flow versions to override for the request. Format: `projects//locations//agents//flows//versions/`. If version 1 of flow X is included in this list, the traffic of flow X will go through version 1 regardless of the version configuration in the environment. Each flow can have at most one version specified in this list.
+      "transitionRouteGroups": [ # A flow's transition route group serve two purposes: * They are responsible for matching the user's first utterances in the flow. * They are inherited by every page's transition route groups. Transition route groups defined in the page have higher priority than those defined in the flow. Format:`projects//locations//agents//flows//transitionRouteGroups/` or `projects//locations//agents//transitionRouteGroups/` for agent-level groups.
         "A String",
       ],
-      "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.
-        "latitude": 3.14, # The latitude in degrees. It must be in the range [-90.0, +90.0].
-        "longitude": 3.14, # The longitude in degrees. It must be in the range [-180.0, +180.0].
-      },
-      "parameters": { # Additional parameters to be put into session parameters. To remove a parameter from the session, clients should explicitly set the parameter value to null. You can reference the session parameters in the agent with the following format: $session.params.parameter-id. 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 then use map, otherwise, depending on the parameter value type, it could be one of string, number, boolean, null, list or map. * MapValue value: If parameter's entity type is a composite entity then use map from composite entity property names to property values, otherwise, use parameter value.
-        "a_key": "", # Properties of the object.
-      },
-      "payload": { # This field can be used to pass custom data into the webhook associated with the agent. Arbitrary JSON objects are supported. Some integrations that query a Dialogflow agent may provide additional information in the payload. In particular, for the Dialogflow Phone Gateway integration, this field has the form: ``` { "telephony": { "caller_id": "+18558363987" } } ```
-        "a_key": "", # Properties of the object.
-      },
-      "populateDataStoreConnectionSignals": True or False, # Optional. If set to true and data stores are involved in serving the request then DetectIntentResponse.query_result.data_store_connection_signals will be filled with data that can help evaluations.
-      "searchConfig": { # Search configuration for UCS search queries. # Optional. Search configuration for UCS search queries.
-        "boostSpecs": [ # Optional. Boosting configuration for the datastores.
-          { # Boost specifications for data stores.
-            "dataStores": [ # Optional. Data Stores where the boosting configuration is applied. The full names of the referenced data stores. Formats: `projects/{project}/locations/{location}/collections/{collection}/dataStores/{data_store}` `projects/{project}/locations/{location}/dataStores/{data_store}
-              "A String",
-            ],
-            "spec": [ # Optional. A list of boosting specifications.
-              { # Boost specification to boost certain documents. A copy of google.cloud.discoveryengine.v1main.BoostSpec, field documentation is available at https://cloud.google.com/generative-ai-app-builder/docs/reference/rest/v1alpha/BoostSpec
-                "conditionBoostSpecs": [ # Optional. Condition boost specifications. If a document matches multiple conditions in the specifictions, boost scores from these specifications are all applied and combined in a non-linear way. Maximum number of specifications is 20.
-                  { # Boost applies to documents which match a condition.
-                    "boost": 3.14, # Optional. Strength of the condition boost, which should be in [-1, 1]. Negative boost means demotion. Default is 0.0. Setting to 1.0 gives the document a big promotion. However, it does not necessarily mean that the boosted document will be the top result at all times, nor that other documents will be excluded. Results could still be shown even when none of them matches the condition. And results that are significantly more relevant to the search query can still trump your heavily favored but irrelevant documents. Setting to -1.0 gives the document a big demotion. However, results that are deeply relevant might still be shown. The document will have an upstream battle to get a fairly high ranking, but it is not blocked out completely. Setting to 0.0 means no boost applied. The boosting condition is ignored.
-                    "condition": "A String", # Optional. An expression which specifies a boost condition. The syntax and supported fields are the same as a filter expression. Examples: * To boost documents with document ID "doc_1" or "doc_2", and color "Red" or "Blue": * (id: ANY("doc_1", "doc_2")) AND (color: ANY("Red","Blue"))
+      "transitionRoutes": [ # A flow's transition routes serve two purposes: * They are responsible for matching the user's first utterances in the flow. * They are inherited by every page's transition routes and can support use cases such as the user saying "help" or "can I talk to a human?", which can be handled in a common way regardless of the current page. Transition routes defined in the page have higher priority than those defined in the flow. TransitionRoutes are evalauted in the following order: * TransitionRoutes with intent specified. * TransitionRoutes with only condition specified. TransitionRoutes with intent specified are inherited by pages in the flow.
+        { # A transition route specifies a intent that can be matched and/or a data condition that can be evaluated during a session. When a specified transition is matched, the following actions are taken in order: * If there is a `trigger_fulfillment` associated with the transition, it will be called. * If there is a `target_page` associated with the transition, the session will transition into the specified page. * If there is a `target_flow` associated with the transition, the session will transition into the specified flow.
+          "condition": "A String", # The condition to evaluate against form parameters or session parameters. See the [conditions reference](https://cloud.google.com/dialogflow/cx/docs/reference/condition). At least one of `intent` or `condition` must be specified. When both `intent` and `condition` are specified, the transition can only happen when both are fulfilled.
+          "description": "A String", # Optional. The description of the transition route. The maximum length is 500 characters.
+          "intent": "A String", # The unique identifier of an Intent. Format: `projects//locations//agents//intents/`. Indicates that the transition can only happen when the given intent is matched. At least one of `intent` or `condition` must be specified. When both `intent` and `condition` are specified, the transition can only happen when both are fulfilled.
+          "name": "A String", # Output only. The unique identifier of this transition route.
+          "targetFlow": "A String", # The target flow to transition to. Format: `projects//locations//agents//flows/`.
+          "targetPage": "A String", # The target page to transition to. Format: `projects//locations//agents//flows//pages/`.
+          "triggerFulfillment": { # A fulfillment can do one or more of the following actions at the same time: * Generate rich message responses. * Set parameter values. * Call the webhook. Fulfillments can be called at various stages in the Page or Form lifecycle. For example, when a DetectIntentRequest drives a session to enter a new page, the page's entry fulfillment can add a static response to the QueryResult in the returning DetectIntentResponse, call the webhook (for example, to load user data from a database), or both. # The fulfillment to call when the condition is satisfied. At least one of `trigger_fulfillment` and `target` must be specified. When both are defined, `trigger_fulfillment` is executed first.
+            "advancedSettings": { # Hierarchical advanced settings for agent/flow/page/fulfillment/parameter. Settings exposed at lower level overrides the settings exposed at higher level. Overriding occurs at the sub-setting level. For example, the playback_interruption_settings at fulfillment level only overrides the playback_interruption_settings at the agent level, leaving other settings at the agent level unchanged. DTMF settings does not override each other. DTMF settings set at different levels define DTMF detections running in parallel. Hierarchy: Agent->Flow->Page->Fulfillment/Parameter. # Hierarchical advanced settings for this fulfillment. The settings exposed at the lower level overrides the settings exposed at the higher level.
+              "audioExportGcsDestination": { # Google Cloud Storage location for a Dialogflow operation that writes or exports objects (e.g. exported agent or transcripts) outside of Dialogflow. # If present, incoming audio is exported by Dialogflow to the configured Google Cloud Storage destination. Exposed at the following levels: - Agent level - Flow level
+                "uri": "A String", # Required. The Google Cloud Storage URI for the exported objects. A URI is of the form: `gs://bucket/object-name-or-prefix` Whether a full object name, or just a prefix, its usage depends on the Dialogflow operation.
+              },
+              "dtmfSettings": { # Define behaviors for DTMF (dual tone multi frequency). # Settings for DTMF. Exposed at the following levels: - Agent level - Flow level - Page level - Parameter level.
+                "enabled": True or False, # If true, incoming audio is processed for DTMF (dual tone multi frequency) events. For example, if the caller presses a button on their telephone keypad and DTMF processing is enabled, Dialogflow will detect the event (e.g. a "3" was pressed) in the incoming audio and pass the event to the bot to drive business logic (e.g. when 3 is pressed, return the account balance).
+                "endpointingTimeoutDuration": "A String", # Endpoint timeout setting for matching dtmf input to regex.
+                "finishDigit": "A String", # The digit that terminates a DTMF digit sequence.
+                "interdigitTimeoutDuration": "A String", # Interdigit timeout setting for matching dtmf input to regex.
+                "maxDigits": 42, # Max length of DTMF digits.
+              },
+              "loggingSettings": { # Define behaviors on logging. # Settings for logging. Settings for Dialogflow History, Contact Center messages, StackDriver logs, and speech logging. Exposed at the following levels: - Agent level.
+                "enableInteractionLogging": True or False, # Enables DF Interaction logging.
+                "enableStackdriverLogging": True or False, # Enables StackDriver logging.
+              },
+              "speechSettings": { # Define behaviors of speech to text detection. # Settings for speech to text detection. Exposed at the following levels: - Agent level - Flow level - Page level - Parameter level
+                "endpointerSensitivity": 42, # Sensitivity of the speech model that detects the end of speech. Scale from 0 to 100.
+                "models": { # Mapping from language to Speech-to-Text model. The mapped Speech-to-Text model will be selected for requests from its corresponding language. For more information, see [Speech models](https://cloud.google.com/dialogflow/cx/docs/concept/speech-models).
+                  "a_key": "A String",
+                },
+                "noSpeechTimeout": "A String", # Timeout before detecting no speech.
+                "useTimeoutBasedEndpointing": True or False, # Use timeout based endpointing, interpreting endpointer sensitivy as seconds of timeout value.
+              },
+            },
+            "conditionalCases": [ # Conditional cases for this fulfillment.
+              { # A list of cascading if-else conditions. Cases are mutually exclusive. The first one with a matching condition is selected, all the rest ignored.
+                "cases": [ # A list of cascading if-else conditions.
+                  { # Each case has a Boolean condition. When it is evaluated to be True, the corresponding messages will be selected and evaluated recursively.
+                    "caseContent": [ # A list of case content.
+                      { # The list of messages or conditional cases to activate for this case.
+                        "additionalCases": # Object with schema name: GoogleCloudDialogflowCxV3beta1FulfillmentConditionalCases # Additional cases to be evaluated.
+                        "message": { # 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. # Returned message.
+                          "channel": "A String", # The channel which the response is associated with. Clients can specify the channel via QueryParameters.channel, and only associated channel response will be returned.
+                          "conversationSuccess": { # 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. # Indicates that the conversation succeeded.
+                            "metadata": { # Custom metadata. Dialogflow doesn't impose any structure on this.
+                              "a_key": "", # Properties of the object.
+                            },
+                          },
+                          "endInteraction": { # 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. # Output only. A signal that indicates the interaction with the Dialogflow agent has ended. This message is generated by Dialogflow only when the conversation reaches `END_SESSION` page. It is not supposed to be defined by the user. It's guaranteed that there is at most one such message in each response.
+                          },
+                          "knowledgeInfoCard": { # Represents info card response. If the response contains generative knowledge prediction, Dialogflow will return a payload with Infobot Messenger compatible info card. Otherwise, the info card response is skipped. # Represents info card for knowledge answers, to be better rendered in Dialogflow Messenger.
+                          },
+                          "liveAgentHandoff": { # 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. # Hands off conversation to a human agent.
+                            "metadata": { # Custom metadata for your handoff procedure. Dialogflow doesn't impose any structure on this.
+                              "a_key": "", # Properties of the object.
+                            },
+                          },
+                          "mixedAudio": { # 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. # Output only. An audio response message composed of both the synthesized Dialogflow agent responses and responses defined via play_audio. This message is generated by Dialogflow only and not supposed to be defined by the user.
+                            "segments": [ # Segments this audio response is composed of.
+                              { # Represents one segment of audio.
+                                "allowPlaybackInterruption": True or False, # 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.
+                                "audio": "A String", # Raw audio synthesized from the Dialogflow agent's response using the output config specified in the request.
+                                "uri": "A String", # Client-specific URI that points to an audio clip accessible to the client. Dialogflow does not impose any validation on it.
+                              },
+                            ],
+                          },
+                          "outputAudioText": { # A text or ssml response that is preferentially used for TTS output audio synthesis, as described in the comment on the ResponseMessage message. # A text or ssml response that is preferentially used for TTS output audio synthesis, as described in the comment on the ResponseMessage message.
+                            "allowPlaybackInterruption": True or False, # 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.
+                            "ssml": "A String", # The SSML text to be synthesized. For more information, see [SSML](/speech/text-to-speech/docs/ssml).
+                            "text": "A String", # The raw text to be synthesized.
+                          },
+                          "payload": { # Returns a response containing a custom, platform-specific payload.
+                            "a_key": "", # Properties of the object.
+                          },
+                          "playAudio": { # Specifies an audio clip to be played by the client as part of the response. # Signal that the client should play an audio clip hosted at a client-specific URI. Dialogflow uses this to construct mixed_audio. However, Dialogflow itself does not try to read or process the URI in any way.
+                            "allowPlaybackInterruption": True or False, # 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.
+                            "audioUri": "A String", # Required. URI of the audio clip. Dialogflow does not impose any validation on this value. It is specific to the client that reads it.
+                          },
+                          "telephonyTransferCall": { # Represents the signal that telles the client to transfer the phone call connected to the agent to a third-party endpoint. # A signal that the client should transfer the phone call connected to this agent to a third-party endpoint.
+                            "phoneNumber": "A String", # Transfer the call to a phone number in [E.164 format](https://en.wikipedia.org/wiki/E.164).
+                          },
+                          "text": { # The text response message. # Returns a text response.
+                            "allowPlaybackInterruption": True or False, # 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.
+                            "text": [ # Required. A collection of text responses.
+                              "A String",
+                            ],
+                          },
+                          "toolCall": { # Represents a call of a specific tool's action with the specified inputs. # Returns the definition of a tool call that should be executed by the client.
+                            "action": "A String", # Required. The name of the tool's action associated with this call.
+                            "inputParameters": { # Optional. The action's input parameters.
+                              "a_key": "", # Properties of the object.
+                            },
+                            "tool": "A String", # Required. The tool associated with this call. Format: `projects//locations//agents//tools/`.
+                          },
+                        },
+                      },
+                    ],
+                    "condition": "A String", # The condition to activate and select this case. Empty means the condition is always true. The condition is evaluated against form parameters or session parameters. See the [conditions reference](https://cloud.google.com/dialogflow/cx/docs/reference/condition).
                   },
                 ],
               },
             ],
-          },
-        ],
-        "filterSpecs": [ # Optional. Filter configuration for the datastores.
-          { # Filter specifications for data stores.
-            "dataStores": [ # Optional. Data Stores where the boosting configuration is applied. The full names of the referenced data stores. Formats: `projects/{project}/locations/{location}/collections/{collection}/dataStores/{data_store}` `projects/{project}/locations/{location}/dataStores/{data_store}
-              "A String",
+            "enableGenerativeFallback": True or False, # If the flag is true, the agent will utilize LLM to generate a text response. If LLM generation fails, the defined responses in the fulfillment will be respected. This flag is only useful for fulfillments associated with no-match event handlers.
+            "messages": [ # The list of rich message responses to present to the user.
+              { # 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.
+                "channel": "A String", # The channel which the response is associated with. Clients can specify the channel via QueryParameters.channel, and only associated channel response will be returned.
+                "conversationSuccess": { # 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. # Indicates that the conversation succeeded.
+                  "metadata": { # Custom metadata. Dialogflow doesn't impose any structure on this.
+                    "a_key": "", # Properties of the object.
+                  },
+                },
+                "endInteraction": { # 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. # Output only. A signal that indicates the interaction with the Dialogflow agent has ended. This message is generated by Dialogflow only when the conversation reaches `END_SESSION` page. It is not supposed to be defined by the user. It's guaranteed that there is at most one such message in each response.
+                },
+                "knowledgeInfoCard": { # Represents info card response. If the response contains generative knowledge prediction, Dialogflow will return a payload with Infobot Messenger compatible info card. Otherwise, the info card response is skipped. # Represents info card for knowledge answers, to be better rendered in Dialogflow Messenger.
+                },
+                "liveAgentHandoff": { # 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. # Hands off conversation to a human agent.
+                  "metadata": { # Custom metadata for your handoff procedure. Dialogflow doesn't impose any structure on this.
+                    "a_key": "", # Properties of the object.
+                  },
+                },
+                "mixedAudio": { # 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. # Output only. An audio response message composed of both the synthesized Dialogflow agent responses and responses defined via play_audio. This message is generated by Dialogflow only and not supposed to be defined by the user.
+                  "segments": [ # Segments this audio response is composed of.
+                    { # Represents one segment of audio.
+                      "allowPlaybackInterruption": True or False, # 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.
+                      "audio": "A String", # Raw audio synthesized from the Dialogflow agent's response using the output config specified in the request.
+                      "uri": "A String", # Client-specific URI that points to an audio clip accessible to the client. Dialogflow does not impose any validation on it.
+                    },
+                  ],
+                },
+                "outputAudioText": { # A text or ssml response that is preferentially used for TTS output audio synthesis, as described in the comment on the ResponseMessage message. # A text or ssml response that is preferentially used for TTS output audio synthesis, as described in the comment on the ResponseMessage message.
+                  "allowPlaybackInterruption": True or False, # 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.
+                  "ssml": "A String", # The SSML text to be synthesized. For more information, see [SSML](/speech/text-to-speech/docs/ssml).
+                  "text": "A String", # The raw text to be synthesized.
+                },
+                "payload": { # Returns a response containing a custom, platform-specific payload.
+                  "a_key": "", # Properties of the object.
+                },
+                "playAudio": { # Specifies an audio clip to be played by the client as part of the response. # Signal that the client should play an audio clip hosted at a client-specific URI. Dialogflow uses this to construct mixed_audio. However, Dialogflow itself does not try to read or process the URI in any way.
+                  "allowPlaybackInterruption": True or False, # 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.
+                  "audioUri": "A String", # Required. URI of the audio clip. Dialogflow does not impose any validation on this value. It is specific to the client that reads it.
+                },
+                "telephonyTransferCall": { # Represents the signal that telles the client to transfer the phone call connected to the agent to a third-party endpoint. # A signal that the client should transfer the phone call connected to this agent to a third-party endpoint.
+                  "phoneNumber": "A String", # Transfer the call to a phone number in [E.164 format](https://en.wikipedia.org/wiki/E.164).
+                },
+                "text": { # The text response message. # Returns a text response.
+                  "allowPlaybackInterruption": True or False, # 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.
+                  "text": [ # Required. A collection of text responses.
+                    "A String",
+                  ],
+                },
+                "toolCall": { # Represents a call of a specific tool's action with the specified inputs. # Returns the definition of a tool call that should be executed by the client.
+                  "action": "A String", # Required. The name of the tool's action associated with this call.
+                  "inputParameters": { # Optional. The action's input parameters.
+                    "a_key": "", # Properties of the object.
+                  },
+                  "tool": "A String", # Required. The tool associated with this call. Format: `projects//locations//agents//tools/`.
+                },
+              },
             ],
-            "filter": "A String", # Optional. The filter expression to be applied. Expression syntax is documented at https://cloud.google.com/generative-ai-app-builder/docs/filter-search-metadata#filter-expression-syntax
+            "returnPartialResponses": True or False, # Whether Dialogflow should return currently queued fulfillment response messages in streaming APIs. If a webhook is specified, it happens before Dialogflow invokes webhook. Warning: 1) This flag only affects streaming API. Responses are still queued and returned once in non-streaming API. 2) The flag can be enabled in any fulfillment but only the first 3 partial responses will be returned. You may only want to apply it to fulfillments that have slow webhooks.
+            "setParameterActions": [ # Set parameter values before executing the webhook.
+              { # Setting a parameter value.
+                "parameter": "A String", # Display name of the parameter.
+                "value": "", # The new value of the parameter. A null value clears the parameter.
+              },
+            ],
+            "tag": "A String", # The value of this field will be populated in the WebhookRequest `fulfillmentInfo.tag` field by Dialogflow when the associated webhook is called. The tag is typically used by the webhook service to identify which fulfillment is being called, but it could be used for other purposes. This field is required if `webhook` is specified.
+            "webhook": "A String", # The webhook to call. Format: `projects//locations//agents//webhooks/`.
           },
-        ],
-      },
-      "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.
-        { # Session entity types are referred to as **User** entity types and are entities that are built for an individual user such as favorites, preferences, playlists, and so on. You can redefine a session entity type at the session level to extend or replace a custom entity type at the user session level (we refer to the entity types defined at the agent level as "custom entity types"). Note: session entity types apply to all queries, regardless of the language. For more information about entity types, see the [Dialogflow documentation](https://cloud.google.com/dialogflow/docs/entities-overview).
-          "entities": [ # Required. The collection of entities to override or supplement the custom entity type.
-            { # An **entity entry** for an associated entity type.
-              "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`.
-                "A String",
-              ],
-              "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 canonical 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).
-            },
-          ],
-          "entityOverrideMode": "A String", # Required. Indicates whether the additional data should override or supplement the custom entity type definition.
-          "name": "A String", # Required. The unique identifier of the session entity type. Format: `projects//locations//agents//sessions//entityTypes/` or `projects//locations//agents//environments//sessions//entityTypes/`. If `Environment ID` is not specified, we assume default 'draft' environment.
         },
       ],
-      "sessionTtl": "A String", # Optional. Configure lifetime of the Dialogflow session. By default, a Dialogflow session remains active and its data is stored for 30 minutes after the last request is sent for the session. This value should be no longer than 1 day.
-      "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 the agent is used.
-      "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 Dialogflow web console. The headers defined within this field will overwrite the headers configured through 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.
-        "a_key": "A String",
-      },
-    },
-  },
-  "outputAudioConfig": { # Instructs the speech synthesizer how to generate the output audio content. # Instructs the speech synthesizer how to generate output audio.
-    "audioEncoding": "A String", # Required. Audio encoding of the synthesized audio content.
-    "sampleRateHertz": 42, # Optional. 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).
-    "synthesizeSpeechConfig": { # Configuration of how speech should be synthesized. # Optional. Configuration of how speech should be synthesized. If not specified, Agent.text_to_speech_settings is applied.
-      "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.
-        "A String",
-      ],
-      "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.
-      "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.
-      "voice": { # Description of which voice to use for speech synthesis. # Optional. The desired voice of the synthesized audio.
-        "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. For the list of available voices, please refer to [Supported voices and languages](https://cloud.google.com/text-to-speech/docs/voices).
-        "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.
-      },
-      "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.
-    },
-  },
-}
-
-  x__xgafv: string, V1 error format.
-    Allowed values
-      1 - v1 error format
-      2 - v2 error format
-
-Returns:
-  An object of the form:
-
-    { # Response of FulfillIntent
-  "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.response_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.
-  "outputAudioConfig": { # Instructs the speech synthesizer how to generate the output audio content. # The config used by the speech synthesizer to generate the output audio.
-    "audioEncoding": "A String", # Required. Audio encoding of the synthesized audio content.
-    "sampleRateHertz": 42, # Optional. 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).
-    "synthesizeSpeechConfig": { # Configuration of how speech should be synthesized. # Optional. Configuration of how speech should be synthesized. If not specified, Agent.text_to_speech_settings is applied.
-      "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.
-        "A String",
-      ],
-      "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.
-      "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.
-      "voice": { # Description of which voice to use for speech synthesis. # Optional. The desired voice of the synthesized audio.
-        "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. For the list of available voices, please refer to [Supported voices and languages](https://cloud.google.com/text-to-speech/docs/voices).
-        "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.
-      },
-      "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.
-    },
-  },
-  "queryResult": { # Represents the result of a conversational query. # The result of the conversational query.
-    "advancedSettings": { # Hierarchical advanced settings for agent/flow/page/fulfillment/parameter. Settings exposed at lower level overrides the settings exposed at higher level. Overriding occurs at the sub-setting level. For example, the playback_interruption_settings at fulfillment level only overrides the playback_interruption_settings at the agent level, leaving other settings at the agent level unchanged. DTMF settings does not override each other. DTMF settings set at different levels define DTMF detections running in parallel. Hierarchy: Agent->Flow->Page->Fulfillment/Parameter. # Returns the current advanced settings including IVR settings. Even though the operations configured by these settings are performed by Dialogflow, the client may need to perform special logic at the moment. For example, if Dialogflow exports audio to Google Cloud Storage, then the client may need to wait for the resulting object to appear in the bucket before proceeding.
-      "audioExportGcsDestination": { # Google Cloud Storage location for a Dialogflow operation that writes or exports objects (e.g. exported agent or transcripts) outside of Dialogflow. # If present, incoming audio is exported by Dialogflow to the configured Google Cloud Storage destination. Exposed at the following levels: - Agent level - Flow level
-        "uri": "A String", # Required. The Google Cloud Storage URI for the exported objects. A URI is of the form: `gs://bucket/object-name-or-prefix` Whether a full object name, or just a prefix, its usage depends on the Dialogflow operation.
-      },
-      "dtmfSettings": { # Define behaviors for DTMF (dual tone multi frequency). # Settings for DTMF. Exposed at the following levels: - Agent level - Flow level - Page level - Parameter level.
-        "enabled": True or False, # If true, incoming audio is processed for DTMF (dual tone multi frequency) events. For example, if the caller presses a button on their telephone keypad and DTMF processing is enabled, Dialogflow will detect the event (e.g. a "3" was pressed) in the incoming audio and pass the event to the bot to drive business logic (e.g. when 3 is pressed, return the account balance).
-        "endpointingTimeoutDuration": "A String", # Endpoint timeout setting for matching dtmf input to regex.
-        "finishDigit": "A String", # The digit that terminates a DTMF digit sequence.
-        "interdigitTimeoutDuration": "A String", # Interdigit timeout setting for matching dtmf input to regex.
-        "maxDigits": 42, # Max length of DTMF digits.
-      },
-      "loggingSettings": { # Define behaviors on logging. # Settings for logging. Settings for Dialogflow History, Contact Center messages, StackDriver logs, and speech logging. Exposed at the following levels: - Agent level.
-        "enableInteractionLogging": True or False, # If true, DF Interaction logging is currently enabled.
-        "enableStackdriverLogging": True or False, # If true, StackDriver logging is currently enabled.
-      },
-      "speechSettings": { # Define behaviors of speech to text detection. # Settings for speech to text detection. Exposed at the following levels: - Agent level - Flow level - Page level - Parameter level
-        "endpointerSensitivity": 42, # Sensitivity of the speech model that detects the end of speech. Scale from 0 to 100.
-        "models": { # Mapping from language to Speech-to-Text model. The mapped Speech-to-Text model will be selected for requests from its corresponding language. For more information, see [Speech models](https://cloud.google.com/dialogflow/cx/docs/concept/speech-models).
-          "a_key": "A String",
-        },
-        "noSpeechTimeout": "A String", # Timeout before detecting no speech.
-        "useTimeoutBasedEndpointing": True or False, # Use timeout based endpointing, interpreting endpointer sensitivy as seconds of timeout value.
-      },
     },
-    "allowAnswerFeedback": True or False, # Indicates whether the Thumbs up/Thumbs down rating controls are need to be shown for the response in the Dialogflow Messenger widget.
     "currentPage": { # A Dialogflow CX conversation (session) can be described and visualized as a state machine. The states of a CX session are represented by pages. For each flow, you define many pages, where your combined pages can handle a complete conversation on the topics the flow is designed for. At any given moment, exactly one page is the current page, the current page is considered active, and the flow associated with that page is considered active. Every flow has a special start page. When a flow initially becomes active, the start page page becomes the current page. For each conversational turn, the current page will either stay the same or transition to another page. You configure each page to collect information from the end-user that is relevant for the conversational state represented by the page. For more information, see the [Page guide](https://cloud.google.com/dialogflow/cx/docs/concept/page). # The current Page. Some, not all fields are filled in this message, including but not limited to `name` and `display_name`.
       "advancedSettings": { # Hierarchical advanced settings for agent/flow/page/fulfillment/parameter. Settings exposed at lower level overrides the settings exposed at higher level. Overriding occurs at the sub-setting level. For example, the playback_interruption_settings at fulfillment level only overrides the playback_interruption_settings at the agent level, leaving other settings at the agent level unchanged. DTMF settings does not override each other. DTMF settings set at different levels define DTMF detections running in parallel. Hierarchy: Agent->Flow->Page->Fulfillment/Parameter. # Hierarchical advanced settings for this page. The settings exposed at the lower level overrides the settings exposed at the higher level.
         "audioExportGcsDestination": { # Google Cloud Storage location for a Dialogflow operation that writes or exports objects (e.g. exported agent or transcripts) outside of Dialogflow. # If present, incoming audio is exported by Dialogflow to the configured Google Cloud Storage destination. Exposed at the following levels: - Agent level - Flow level
@@ -1729,8 +3027,8 @@ 

Method Details

"maxDigits": 42, # Max length of DTMF digits. }, "loggingSettings": { # Define behaviors on logging. # Settings for logging. Settings for Dialogflow History, Contact Center messages, StackDriver logs, and speech logging. Exposed at the following levels: - Agent level. - "enableInteractionLogging": True or False, # If true, DF Interaction logging is currently enabled. - "enableStackdriverLogging": True or False, # If true, StackDriver logging is currently enabled. + "enableInteractionLogging": True or False, # Enables DF Interaction logging. + "enableStackdriverLogging": True or False, # Enables StackDriver logging. }, "speechSettings": { # Define behaviors of speech to text detection. # Settings for speech to text detection. Exposed at the following levels: - Agent level - Flow level - Page level - Parameter level "endpointerSensitivity": 42, # Sensitivity of the speech model that detects the end of speech. Scale from 0 to 100. @@ -1756,8 +3054,8 @@

Method Details

"maxDigits": 42, # Max length of DTMF digits. }, "loggingSettings": { # Define behaviors on logging. # Settings for logging. Settings for Dialogflow History, Contact Center messages, StackDriver logs, and speech logging. Exposed at the following levels: - Agent level. - "enableInteractionLogging": True or False, # If true, DF Interaction logging is currently enabled. - "enableStackdriverLogging": True or False, # If true, StackDriver logging is currently enabled. + "enableInteractionLogging": True or False, # Enables DF Interaction logging. + "enableStackdriverLogging": True or False, # Enables StackDriver logging. }, "speechSettings": { # Define behaviors of speech to text detection. # Settings for speech to text detection. Exposed at the following levels: - Agent level - Flow level - Page level - Parameter level "endpointerSensitivity": 42, # Sensitivity of the speech model that detects the end of speech. Scale from 0 to 100. @@ -1821,6 +3119,13 @@

Method Details

"A String", ], }, + "toolCall": { # Represents a call of a specific tool's action with the specified inputs. # Returns the definition of a tool call that should be executed by the client. + "action": "A String", # Required. The name of the tool's action associated with this call. + "inputParameters": { # Optional. The action's input parameters. + "a_key": "", # Properties of the object. + }, + "tool": "A String", # Required. The tool associated with this call. Format: `projects//locations//agents//tools/`. + }, }, }, ], @@ -1877,6 +3182,13 @@

Method Details

"A String", ], }, + "toolCall": { # Represents a call of a specific tool's action with the specified inputs. # Returns the definition of a tool call that should be executed by the client. + "action": "A String", # Required. The name of the tool's action associated with this call. + "inputParameters": { # Optional. The action's input parameters. + "a_key": "", # Properties of the object. + }, + "tool": "A String", # Required. The tool associated with this call. Format: `projects//locations//agents//tools/`. + }, }, ], "returnPartialResponses": True or False, # Whether Dialogflow should return currently queued fulfillment response messages in streaming APIs. If a webhook is specified, it happens before Dialogflow invokes webhook. Warning: 1) This flag only affects streaming API. Responses are still queued and returned once in non-streaming API. 2) The flag can be enabled in any fulfillment but only the first 3 partial responses will be returned. You may only want to apply it to fulfillments that have slow webhooks. @@ -1908,8 +3220,8 @@

Method Details

"maxDigits": 42, # Max length of DTMF digits. }, "loggingSettings": { # Define behaviors on logging. # Settings for logging. Settings for Dialogflow History, Contact Center messages, StackDriver logs, and speech logging. Exposed at the following levels: - Agent level. - "enableInteractionLogging": True or False, # If true, DF Interaction logging is currently enabled. - "enableStackdriverLogging": True or False, # If true, StackDriver logging is currently enabled. + "enableInteractionLogging": True or False, # Enables DF Interaction logging. + "enableStackdriverLogging": True or False, # Enables StackDriver logging. }, "speechSettings": { # Define behaviors of speech to text detection. # Settings for speech to text detection. Exposed at the following levels: - Agent level - Flow level - Page level - Parameter level "endpointerSensitivity": 42, # Sensitivity of the speech model that detects the end of speech. Scale from 0 to 100. @@ -1973,6 +3285,13 @@

Method Details

"A String", ], }, + "toolCall": { # Represents a call of a specific tool's action with the specified inputs. # Returns the definition of a tool call that should be executed by the client. + "action": "A String", # Required. The name of the tool's action associated with this call. + "inputParameters": { # Optional. The action's input parameters. + "a_key": "", # Properties of the object. + }, + "tool": "A String", # Required. The tool associated with this call. Format: `projects//locations//agents//tools/`. + }, }, }, ], @@ -2029,6 +3348,13 @@

Method Details

"A String", ], }, + "toolCall": { # Represents a call of a specific tool's action with the specified inputs. # Returns the definition of a tool call that should be executed by the client. + "action": "A String", # Required. The name of the tool's action associated with this call. + "inputParameters": { # Optional. The action's input parameters. + "a_key": "", # Properties of the object. + }, + "tool": "A String", # Required. The tool associated with this call. Format: `projects//locations//agents//tools/`. + }, }, ], "returnPartialResponses": True or False, # Whether Dialogflow should return currently queued fulfillment response messages in streaming APIs. If a webhook is specified, it happens before Dialogflow invokes webhook. Warning: 1) This flag only affects streaming API. Responses are still queued and returned once in non-streaming API. 2) The flag can be enabled in any fulfillment but only the first 3 partial responses will be returned. You may only want to apply it to fulfillments that have slow webhooks. @@ -2058,8 +3384,8 @@

Method Details

"maxDigits": 42, # Max length of DTMF digits. }, "loggingSettings": { # Define behaviors on logging. # Settings for logging. Settings for Dialogflow History, Contact Center messages, StackDriver logs, and speech logging. Exposed at the following levels: - Agent level. - "enableInteractionLogging": True or False, # If true, DF Interaction logging is currently enabled. - "enableStackdriverLogging": True or False, # If true, StackDriver logging is currently enabled. + "enableInteractionLogging": True or False, # Enables DF Interaction logging. + "enableStackdriverLogging": True or False, # Enables StackDriver logging. }, "speechSettings": { # Define behaviors of speech to text detection. # Settings for speech to text detection. Exposed at the following levels: - Agent level - Flow level - Page level - Parameter level "endpointerSensitivity": 42, # Sensitivity of the speech model that detects the end of speech. Scale from 0 to 100. @@ -2087,8 +3413,8 @@

Method Details

"maxDigits": 42, # Max length of DTMF digits. }, "loggingSettings": { # Define behaviors on logging. # Settings for logging. Settings for Dialogflow History, Contact Center messages, StackDriver logs, and speech logging. Exposed at the following levels: - Agent level. - "enableInteractionLogging": True or False, # If true, DF Interaction logging is currently enabled. - "enableStackdriverLogging": True or False, # If true, StackDriver logging is currently enabled. + "enableInteractionLogging": True or False, # Enables DF Interaction logging. + "enableStackdriverLogging": True or False, # Enables StackDriver logging. }, "speechSettings": { # Define behaviors of speech to text detection. # Settings for speech to text detection. Exposed at the following levels: - Agent level - Flow level - Page level - Parameter level "endpointerSensitivity": 42, # Sensitivity of the speech model that detects the end of speech. Scale from 0 to 100. @@ -2152,6 +3478,13 @@

Method Details

"A String", ], }, + "toolCall": { # Represents a call of a specific tool's action with the specified inputs. # Returns the definition of a tool call that should be executed by the client. + "action": "A String", # Required. The name of the tool's action associated with this call. + "inputParameters": { # Optional. The action's input parameters. + "a_key": "", # Properties of the object. + }, + "tool": "A String", # Required. The tool associated with this call. Format: `projects//locations//agents//tools/`. + }, }, }, ], @@ -2208,6 +3541,13 @@

Method Details

"A String", ], }, + "toolCall": { # Represents a call of a specific tool's action with the specified inputs. # Returns the definition of a tool call that should be executed by the client. + "action": "A String", # Required. The name of the tool's action associated with this call. + "inputParameters": { # Optional. The action's input parameters. + "a_key": "", # Properties of the object. + }, + "tool": "A String", # Required. The tool associated with this call. Format: `projects//locations//agents//tools/`. + }, }, ], "returnPartialResponses": True or False, # Whether Dialogflow should return currently queued fulfillment response messages in streaming APIs. If a webhook is specified, it happens before Dialogflow invokes webhook. Warning: 1) This flag only affects streaming API. Responses are still queued and returned once in non-streaming API. 2) The flag can be enabled in any fulfillment but only the first 3 partial responses will be returned. You may only want to apply it to fulfillments that have slow webhooks. @@ -2239,8 +3579,8 @@

Method Details

"maxDigits": 42, # Max length of DTMF digits. }, "loggingSettings": { # Define behaviors on logging. # Settings for logging. Settings for Dialogflow History, Contact Center messages, StackDriver logs, and speech logging. Exposed at the following levels: - Agent level. - "enableInteractionLogging": True or False, # If true, DF Interaction logging is currently enabled. - "enableStackdriverLogging": True or False, # If true, StackDriver logging is currently enabled. + "enableInteractionLogging": True or False, # Enables DF Interaction logging. + "enableStackdriverLogging": True or False, # Enables StackDriver logging. }, "speechSettings": { # Define behaviors of speech to text detection. # Settings for speech to text detection. Exposed at the following levels: - Agent level - Flow level - Page level - Parameter level "endpointerSensitivity": 42, # Sensitivity of the speech model that detects the end of speech. Scale from 0 to 100. @@ -2304,6 +3644,13 @@

Method Details

"A String", ], }, + "toolCall": { # Represents a call of a specific tool's action with the specified inputs. # Returns the definition of a tool call that should be executed by the client. + "action": "A String", # Required. The name of the tool's action associated with this call. + "inputParameters": { # Optional. The action's input parameters. + "a_key": "", # Properties of the object. + }, + "tool": "A String", # Required. The tool associated with this call. Format: `projects//locations//agents//tools/`. + }, }, }, ], @@ -2360,6 +3707,13 @@

Method Details

"A String", ], }, + "toolCall": { # Represents a call of a specific tool's action with the specified inputs. # Returns the definition of a tool call that should be executed by the client. + "action": "A String", # Required. The name of the tool's action associated with this call. + "inputParameters": { # Optional. The action's input parameters. + "a_key": "", # Properties of the object. + }, + "tool": "A String", # Required. The tool associated with this call. Format: `projects//locations//agents//tools/`. + }, }, ], "returnPartialResponses": True or False, # Whether Dialogflow should return currently queued fulfillment response messages in streaming APIs. If a webhook is specified, it happens before Dialogflow invokes webhook. Warning: 1) This flag only affects streaming API. Responses are still queued and returned once in non-streaming API. 2) The flag can be enabled in any fulfillment but only the first 3 partial responses will be returned. You may only want to apply it to fulfillments that have slow webhooks. @@ -2404,8 +3758,8 @@

Method Details

"maxDigits": 42, # Max length of DTMF digits. }, "loggingSettings": { # Define behaviors on logging. # Settings for logging. Settings for Dialogflow History, Contact Center messages, StackDriver logs, and speech logging. Exposed at the following levels: - Agent level. - "enableInteractionLogging": True or False, # If true, DF Interaction logging is currently enabled. - "enableStackdriverLogging": True or False, # If true, StackDriver logging is currently enabled. + "enableInteractionLogging": True or False, # Enables DF Interaction logging. + "enableStackdriverLogging": True or False, # Enables StackDriver logging. }, "speechSettings": { # Define behaviors of speech to text detection. # Settings for speech to text detection. Exposed at the following levels: - Agent level - Flow level - Page level - Parameter level "endpointerSensitivity": 42, # Sensitivity of the speech model that detects the end of speech. Scale from 0 to 100. @@ -2469,6 +3823,13 @@

Method Details

"A String", ], }, + "toolCall": { # Represents a call of a specific tool's action with the specified inputs. # Returns the definition of a tool call that should be executed by the client. + "action": "A String", # Required. The name of the tool's action associated with this call. + "inputParameters": { # Optional. The action's input parameters. + "a_key": "", # Properties of the object. + }, + "tool": "A String", # Required. The tool associated with this call. Format: `projects//locations//agents//tools/`. + }, }, }, ], @@ -2525,6 +3886,13 @@

Method Details

"A String", ], }, + "toolCall": { # Represents a call of a specific tool's action with the specified inputs. # Returns the definition of a tool call that should be executed by the client. + "action": "A String", # Required. The name of the tool's action associated with this call. + "inputParameters": { # Optional. The action's input parameters. + "a_key": "", # Properties of the object. + }, + "tool": "A String", # Required. The tool associated with this call. Format: `projects//locations//agents//tools/`. + }, }, ], "returnPartialResponses": True or False, # Whether Dialogflow should return currently queued fulfillment response messages in streaming APIs. If a webhook is specified, it happens before Dialogflow invokes webhook. Warning: 1) This flag only affects streaming API. Responses are still queued and returned once in non-streaming API. 2) The flag can be enabled in any fulfillment but only the first 3 partial responses will be returned. You may only want to apply it to fulfillments that have slow webhooks. @@ -2563,8 +3931,8 @@

Method Details

"maxDigits": 42, # Max length of DTMF digits. }, "loggingSettings": { # Define behaviors on logging. # Settings for logging. Settings for Dialogflow History, Contact Center messages, StackDriver logs, and speech logging. Exposed at the following levels: - Agent level. - "enableInteractionLogging": True or False, # If true, DF Interaction logging is currently enabled. - "enableStackdriverLogging": True or False, # If true, StackDriver logging is currently enabled. + "enableInteractionLogging": True or False, # Enables DF Interaction logging. + "enableStackdriverLogging": True or False, # Enables StackDriver logging. }, "speechSettings": { # Define behaviors of speech to text detection. # Settings for speech to text detection. Exposed at the following levels: - Agent level - Flow level - Page level - Parameter level "endpointerSensitivity": 42, # Sensitivity of the speech model that detects the end of speech. Scale from 0 to 100. @@ -2628,6 +3996,13 @@

Method Details

"A String", ], }, + "toolCall": { # Represents a call of a specific tool's action with the specified inputs. # Returns the definition of a tool call that should be executed by the client. + "action": "A String", # Required. The name of the tool's action associated with this call. + "inputParameters": { # Optional. The action's input parameters. + "a_key": "", # Properties of the object. + }, + "tool": "A String", # Required. The tool associated with this call. Format: `projects//locations//agents//tools/`. + }, }, }, ], @@ -2684,6 +4059,13 @@

Method Details

"A String", ], }, + "toolCall": { # Represents a call of a specific tool's action with the specified inputs. # Returns the definition of a tool call that should be executed by the client. + "action": "A String", # Required. The name of the tool's action associated with this call. + "inputParameters": { # Optional. The action's input parameters. + "a_key": "", # Properties of the object. + }, + "tool": "A String", # Required. The tool associated with this call. Format: `projects//locations//agents//tools/`. + }, }, ], "returnPartialResponses": True or False, # Whether Dialogflow should return currently queued fulfillment response messages in streaming APIs. If a webhook is specified, it happens before Dialogflow invokes webhook. Warning: 1) This flag only affects streaming API. Responses are still queued and returned once in non-streaming API. 2) The flag can be enabled in any fulfillment but only the first 3 partial responses will be returned. You may only want to apply it to fulfillments that have slow webhooks. @@ -2745,13 +4127,86 @@

Method Details

}, ], }, - "diagnosticInfo": { # The free-form diagnostic info. For example, this field could contain webhook call latency. The fields of this data can change without notice, so you should not write code that depends on its structure. One of the fields is called "Alternative Matched Intents", which may aid with debugging. The following describes these intent results: - The list is empty if no intent was matched to end-user input. - Only intents that are referenced in the currently active flow are included. - The matched intent is included. - Other intents that could have matched end-user input, but did not match because they are referenced by intent routes that are out of [scope](https://cloud.google.com/dialogflow/cx/docs/concept/handler#scope), are included. - Other intents referenced by intent routes in scope that matched end-user input, but had a lower confidence score. - "a_key": "", # Properties of the object. - }, - "dtmf": { # Represents the input for dtmf event. # If a DTMF was provided as input, this field will contain a copy of the DtmfInput. - "digits": "A String", # The dtmf digits. - "finishDigit": "A String", # The finish digit (if any). - }, + "diagnosticInfo": { # The free-form diagnostic info. For example, this field could contain webhook call latency. The fields of this data can change without notice, so you should not write code that depends on its structure. One of the fields is called "Alternative Matched Intents", which may aid with debugging. The following describes these intent results: - The list is empty if no intent was matched to end-user input. - Only intents that are referenced in the currently active flow are included. - The matched intent is included. - Other intents that could have matched end-user input, but did not match because they are referenced by intent routes that are out of [scope](https://cloud.google.com/dialogflow/cx/docs/concept/handler#scope), are included. - Other intents referenced by intent routes in scope that matched end-user input, but had a lower confidence score. + "a_key": "", # Properties of the object. + }, + "dtmf": { # Represents the input for dtmf event. # If a DTMF was provided as input, this field will contain a copy of the DtmfInput. + "digits": "A String", # The dtmf digits. + "finishDigit": "A String", # The finish digit (if any). + }, + "generativeInfo": { # Represents the information of a query if handled by generative agent resources. # The information of a query if handled by generative agent resources. + "actionTracingInfo": { # Example represents a sample execution of the playbook in the conversation. An example consists of a list of ordered actions performed by end user or Dialogflow agent according the playbook instructions to fulfill the task. # The actions performed by the generative playbook for the current agent response. + "actions": [ # Required. The ordered list of actions performed by the end user and the Dialogflow agent. + { # Action performed by end user or Dialogflow agent in the conversation. + "agentUtterance": { # AgentUtterance represents one message sent by the agent. # Optional. Action performed by the agent as a message. + "text": "A String", # Required. Message content in text. + }, + "flowInvocation": { # Stores metadata of the invocation of a CX flow. Next Id: 7 # Optional. Action performed on behalf of the agent by invoking a CX flow. + "flow": "A String", # Required. The unique identifier of the flow. Format: `projects//locations//agents/`. + "flowState": "A String", # Required. Flow invocation's output state. + "inputActionParameters": { # Optional. A list of input parameters for the flow. + "a_key": "", # Properties of the object. + }, + "outputActionParameters": { # Optional. A list of output parameters generated by the flow invocation. + "a_key": "", # Properties of the object. + }, + }, + "playbookInvocation": { # Stores metadata of the invocation of a child playbook. Next Id: 5 # Optional. Action performed on behalf of the agent by invoking a child playbook. + "playbook": "A String", # Required. The unique identifier of the playbook. Format: `projects//locations//agents//playbooks/`. + "playbookInput": { # Input of the playbook. # Optional. Input of the child playbook invocation. + "actionParameters": { # Optional. A list of input parameters for the action. + "a_key": "", # Properties of the object. + }, + "precedingConversationSummary": "A String", # Optional. Summary string of the preceding conversation for the child playbook invocation. + }, + "playbookOutput": { # Output of the playbook. # Optional. Output of the child playbook invocation. + "actionParameters": { # Optional. A Struct object of output parameters for the action. + "a_key": "", # Properties of the object. + }, + "executionSummary": "A String", # Optional. Summary string of the execution result of the child playbook. + }, + "playbookState": "A String", # Required. Playbook invocation's output state. + }, + "toolUse": { # Stores metadata of the invocation of an action supported by a tool. # Optional. Action performed on behalf of the agent by calling a plugin tool. + "action": "A String", # Optional. Name of the action to be called during the tool use. + "inputActionParameters": { # Optional. A list of input parameters for the action. + "a_key": "", # Properties of the object. + }, + "outputActionParameters": { # Optional. A list of output parameters generated by the action. + "a_key": "", # Properties of the object. + }, + "tool": "A String", # Required. The tool that should be used. Format: `projects//locations//agents//tools/`. + }, + "userUtterance": { # UserUtterance represents one message sent by the customer. # Optional. Agent obtained a message from the customer. + "text": "A String", # Required. Message content in text. + }, + }, + ], + "conversationState": "A String", # Required. Example's output state. + "createTime": "A String", # Output only. The timestamp of initial example creation. + "description": "A String", # Optional. The high level concise description of the example. The max number of characters is 200. + "displayName": "A String", # Required. The display name of the example. + "languageCode": "A String", # Optional. The language code of the example. If not specified, the agent's default language is used. Note: languages must be enabled in the agent before they can be used. + "name": "A String", # The unique identifier of the playbook example. Format: `projects//locations//agents//playbooks//examples/`. + "playbookInput": { # Input of the playbook. # Optional. The input to the playbook in the example. + "actionParameters": { # Optional. A list of input parameters for the action. + "a_key": "", # Properties of the object. + }, + "precedingConversationSummary": "A String", # Optional. Summary string of the preceding conversation for the child playbook invocation. + }, + "playbookOutput": { # Output of the playbook. # Optional. The output of the playbook in the example. + "actionParameters": { # Optional. A Struct object of output parameters for the action. + "a_key": "", # Properties of the object. + }, + "executionSummary": "A String", # Optional. Summary string of the execution result of the child playbook. + }, + "tokenCount": "A String", # Output only. Estimated number of tokes current example takes when sent to the LLM. + "updateTime": "A String", # Output only. Last time the example was updated. + }, + "currentPlaybooks": [ # The stack of playbooks that the conversation has currently entered, with the most recent one on the top. + "A String", + ], + }, "intent": { # An intent represents a user's intent to interact with a conversational agent. You can provide information for the Dialogflow API to use to match user input to an intent by adding training phrases (i.e., examples of user input) to your intent. # The Intent that matched the conversational query. Some, not all fields are filled in this message, including but not limited to: `name` and `display_name`. This field is deprecated, please use QueryResult.match instead. "description": "A String", # Human readable description for better understanding an intent like its scope, content, result etc. Maximum character limit: 140 characters. "displayName": "A String", # Required. The human-readable name of the intent, unique within the agent. @@ -2873,6 +4328,13 @@

Method Details

"A String", ], }, + "toolCall": { # Represents a call of a specific tool's action with the specified inputs. # Returns the definition of a tool call that should be executed by the client. + "action": "A String", # Required. The name of the tool's action associated with this call. + "inputParameters": { # Optional. The action's input parameters. + "a_key": "", # Properties of the object. + }, + "tool": "A String", # Required. The tool associated with this call. Format: `projects//locations//agents//tools/`. + }, }, ], "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. # The sentiment analyss result, which depends on `analyze_query_text_sentiment`, specified in the request. @@ -2961,11 +4423,22 @@

Method Details

"text": { # Represents the natural language text to be processed. # The natural language text to be processed. "text": "A String", # Required. The UTF-8 encoded natural language text to be processed. }, + "toolCallResult": { # The result of calling a tool's action that has been executed by the client. # The results of a tool executed by the client. + "action": "A String", # Required. The name of the tool's action associated with this call. + "error": { # An error produced by the tool call. # The tool call's error. + "message": "A String", # Optional. The error message of the function. + }, + "outputParameters": { # The tool call's output parameters. + "a_key": "", # Properties of the object. + }, + "tool": "A String", # Required. The tool associated with this call. Format: `projects//locations//agents//tools/`. + }, }, "queryParams": { # Represents the parameters of a conversational query. # The parameters of this query. "analyzeQueryTextSentiment": True or False, # Configures whether sentiment analysis should be performed. If not provided, sentiment analysis is not performed. "channel": "A String", # The channel which this query is for. If specified, only the ResponseMessage associated with the channel will be returned. If no ResponseMessage is associated with the channel, it falls back to the ResponseMessage with unspecified channel. If unspecified, the ResponseMessage with unspecified channel will be returned. "currentPage": "A String", # The unique identifier of the page to override the current page in the session. Format: `projects//locations//agents//flows//pages/`. If `current_page` is specified, the previous state of the session will be ignored by Dialogflow, including the previous page and the previous session parameters. In most cases, current_page and parameters should be configured together to direct a session to a specific state. + "currentPlaybook": "A String", # Optional. Start the session with the specified playbook. You can only specify the playbook at the beginning of the session. Otherwise, an error will be thrown. Format: `projects//locations//agents//playbooks/`. "disableWebhook": True or False, # Whether to disable webhook calls for this request. "endUserMetadata": { # Optional. Information about the end-user to improve the relevance and accuracy of generative answers. This will be interpreted and used by a language model, so, for good results, the data should be self-descriptive, and in a simple structure. Example: ```json { "subscription plan": "Business Premium Plus", "devices owned": [ {"model": "Google Pixel 7"}, {"model": "Google Pixel Tablet"} ] } ``` "a_key": "", # Properties of the object. @@ -2977,6 +4450,10 @@

Method Details

"latitude": 3.14, # The latitude in degrees. It must be in the range [-90.0, +90.0]. "longitude": 3.14, # The longitude in degrees. It must be in the range [-180.0, +180.0]. }, + "llmModelSettings": { # Settings for LLM models. # Optional. Use the specified LLM model settings for processing the request. + "model": "A String", # The selected LLM model. + "promptText": "A String", # The custom prompt to use. + }, "parameters": { # Additional parameters to be put into session parameters. To remove a parameter from the session, clients should explicitly set the parameter value to null. You can reference the session parameters in the agent with the following format: $session.params.parameter-id. 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 then use map, otherwise, depending on the parameter value type, it could be one of string, number, boolean, null, list or map. * MapValue value: If parameter's entity type is a composite entity then use map from composite entity property names to property values, otherwise, use parameter value. "a_key": "", # Properties of the object. }, @@ -3055,8 +4532,8 @@

Method Details

"maxDigits": 42, # Max length of DTMF digits. }, "loggingSettings": { # Define behaviors on logging. # Settings for logging. Settings for Dialogflow History, Contact Center messages, StackDriver logs, and speech logging. Exposed at the following levels: - Agent level. - "enableInteractionLogging": True or False, # If true, DF Interaction logging is currently enabled. - "enableStackdriverLogging": True or False, # If true, StackDriver logging is currently enabled. + "enableInteractionLogging": True or False, # Enables DF Interaction logging. + "enableStackdriverLogging": True or False, # Enables StackDriver logging. }, "speechSettings": { # Define behaviors of speech to text detection. # Settings for speech to text detection. Exposed at the following levels: - Agent level - Flow level - Page level - Parameter level "endpointerSensitivity": 42, # Sensitivity of the speech model that detects the end of speech. Scale from 0 to 100. @@ -3082,8 +4559,8 @@

Method Details

"maxDigits": 42, # Max length of DTMF digits. }, "loggingSettings": { # Define behaviors on logging. # Settings for logging. Settings for Dialogflow History, Contact Center messages, StackDriver logs, and speech logging. Exposed at the following levels: - Agent level. - "enableInteractionLogging": True or False, # If true, DF Interaction logging is currently enabled. - "enableStackdriverLogging": True or False, # If true, StackDriver logging is currently enabled. + "enableInteractionLogging": True or False, # Enables DF Interaction logging. + "enableStackdriverLogging": True or False, # Enables StackDriver logging. }, "speechSettings": { # Define behaviors of speech to text detection. # Settings for speech to text detection. Exposed at the following levels: - Agent level - Flow level - Page level - Parameter level "endpointerSensitivity": 42, # Sensitivity of the speech model that detects the end of speech. Scale from 0 to 100. @@ -3147,6 +4624,13 @@

Method Details

"A String", ], }, + "toolCall": { # Represents a call of a specific tool's action with the specified inputs. # Returns the definition of a tool call that should be executed by the client. + "action": "A String", # Required. The name of the tool's action associated with this call. + "inputParameters": { # Optional. The action's input parameters. + "a_key": "", # Properties of the object. + }, + "tool": "A String", # Required. The tool associated with this call. Format: `projects//locations//agents//tools/`. + }, }, }, ], @@ -3203,6 +4687,13 @@

Method Details

"A String", ], }, + "toolCall": { # Represents a call of a specific tool's action with the specified inputs. # Returns the definition of a tool call that should be executed by the client. + "action": "A String", # Required. The name of the tool's action associated with this call. + "inputParameters": { # Optional. The action's input parameters. + "a_key": "", # Properties of the object. + }, + "tool": "A String", # Required. The tool associated with this call. Format: `projects//locations//agents//tools/`. + }, }, ], "returnPartialResponses": True or False, # Whether Dialogflow should return currently queued fulfillment response messages in streaming APIs. If a webhook is specified, it happens before Dialogflow invokes webhook. Warning: 1) This flag only affects streaming API. Responses are still queued and returned once in non-streaming API. 2) The flag can be enabled in any fulfillment but only the first 3 partial responses will be returned. You may only want to apply it to fulfillments that have slow webhooks. @@ -3234,8 +4725,8 @@

Method Details

"maxDigits": 42, # Max length of DTMF digits. }, "loggingSettings": { # Define behaviors on logging. # Settings for logging. Settings for Dialogflow History, Contact Center messages, StackDriver logs, and speech logging. Exposed at the following levels: - Agent level. - "enableInteractionLogging": True or False, # If true, DF Interaction logging is currently enabled. - "enableStackdriverLogging": True or False, # If true, StackDriver logging is currently enabled. + "enableInteractionLogging": True or False, # Enables DF Interaction logging. + "enableStackdriverLogging": True or False, # Enables StackDriver logging. }, "speechSettings": { # Define behaviors of speech to text detection. # Settings for speech to text detection. Exposed at the following levels: - Agent level - Flow level - Page level - Parameter level "endpointerSensitivity": 42, # Sensitivity of the speech model that detects the end of speech. Scale from 0 to 100. @@ -3299,6 +4790,13 @@

Method Details

"A String", ], }, + "toolCall": { # Represents a call of a specific tool's action with the specified inputs. # Returns the definition of a tool call that should be executed by the client. + "action": "A String", # Required. The name of the tool's action associated with this call. + "inputParameters": { # Optional. The action's input parameters. + "a_key": "", # Properties of the object. + }, + "tool": "A String", # Required. The tool associated with this call. Format: `projects//locations//agents//tools/`. + }, }, }, ], @@ -3355,6 +4853,13 @@

Method Details

"A String", ], }, + "toolCall": { # Represents a call of a specific tool's action with the specified inputs. # Returns the definition of a tool call that should be executed by the client. + "action": "A String", # Required. The name of the tool's action associated with this call. + "inputParameters": { # Optional. The action's input parameters. + "a_key": "", # Properties of the object. + }, + "tool": "A String", # Required. The tool associated with this call. Format: `projects//locations//agents//tools/`. + }, }, ], "returnPartialResponses": True or False, # Whether Dialogflow should return currently queued fulfillment response messages in streaming APIs. If a webhook is specified, it happens before Dialogflow invokes webhook. Warning: 1) This flag only affects streaming API. Responses are still queued and returned once in non-streaming API. 2) The flag can be enabled in any fulfillment but only the first 3 partial responses will be returned. You may only want to apply it to fulfillments that have slow webhooks. @@ -3384,8 +4889,8 @@

Method Details

"maxDigits": 42, # Max length of DTMF digits. }, "loggingSettings": { # Define behaviors on logging. # Settings for logging. Settings for Dialogflow History, Contact Center messages, StackDriver logs, and speech logging. Exposed at the following levels: - Agent level. - "enableInteractionLogging": True or False, # If true, DF Interaction logging is currently enabled. - "enableStackdriverLogging": True or False, # If true, StackDriver logging is currently enabled. + "enableInteractionLogging": True or False, # Enables DF Interaction logging. + "enableStackdriverLogging": True or False, # Enables StackDriver logging. }, "speechSettings": { # Define behaviors of speech to text detection. # Settings for speech to text detection. Exposed at the following levels: - Agent level - Flow level - Page level - Parameter level "endpointerSensitivity": 42, # Sensitivity of the speech model that detects the end of speech. Scale from 0 to 100. @@ -3413,8 +4918,8 @@

Method Details

"maxDigits": 42, # Max length of DTMF digits. }, "loggingSettings": { # Define behaviors on logging. # Settings for logging. Settings for Dialogflow History, Contact Center messages, StackDriver logs, and speech logging. Exposed at the following levels: - Agent level. - "enableInteractionLogging": True or False, # If true, DF Interaction logging is currently enabled. - "enableStackdriverLogging": True or False, # If true, StackDriver logging is currently enabled. + "enableInteractionLogging": True or False, # Enables DF Interaction logging. + "enableStackdriverLogging": True or False, # Enables StackDriver logging. }, "speechSettings": { # Define behaviors of speech to text detection. # Settings for speech to text detection. Exposed at the following levels: - Agent level - Flow level - Page level - Parameter level "endpointerSensitivity": 42, # Sensitivity of the speech model that detects the end of speech. Scale from 0 to 100. @@ -3478,6 +4983,13 @@

Method Details

"A String", ], }, + "toolCall": { # Represents a call of a specific tool's action with the specified inputs. # Returns the definition of a tool call that should be executed by the client. + "action": "A String", # Required. The name of the tool's action associated with this call. + "inputParameters": { # Optional. The action's input parameters. + "a_key": "", # Properties of the object. + }, + "tool": "A String", # Required. The tool associated with this call. Format: `projects//locations//agents//tools/`. + }, }, }, ], @@ -3534,6 +5046,13 @@

Method Details

"A String", ], }, + "toolCall": { # Represents a call of a specific tool's action with the specified inputs. # Returns the definition of a tool call that should be executed by the client. + "action": "A String", # Required. The name of the tool's action associated with this call. + "inputParameters": { # Optional. The action's input parameters. + "a_key": "", # Properties of the object. + }, + "tool": "A String", # Required. The tool associated with this call. Format: `projects//locations//agents//tools/`. + }, }, ], "returnPartialResponses": True or False, # Whether Dialogflow should return currently queued fulfillment response messages in streaming APIs. If a webhook is specified, it happens before Dialogflow invokes webhook. Warning: 1) This flag only affects streaming API. Responses are still queued and returned once in non-streaming API. 2) The flag can be enabled in any fulfillment but only the first 3 partial responses will be returned. You may only want to apply it to fulfillments that have slow webhooks. @@ -3565,8 +5084,8 @@

Method Details

"maxDigits": 42, # Max length of DTMF digits. }, "loggingSettings": { # Define behaviors on logging. # Settings for logging. Settings for Dialogflow History, Contact Center messages, StackDriver logs, and speech logging. Exposed at the following levels: - Agent level. - "enableInteractionLogging": True or False, # If true, DF Interaction logging is currently enabled. - "enableStackdriverLogging": True or False, # If true, StackDriver logging is currently enabled. + "enableInteractionLogging": True or False, # Enables DF Interaction logging. + "enableStackdriverLogging": True or False, # Enables StackDriver logging. }, "speechSettings": { # Define behaviors of speech to text detection. # Settings for speech to text detection. Exposed at the following levels: - Agent level - Flow level - Page level - Parameter level "endpointerSensitivity": 42, # Sensitivity of the speech model that detects the end of speech. Scale from 0 to 100. @@ -3630,253 +5149,898 @@

Method Details

"A String", ], }, + "toolCall": { # Represents a call of a specific tool's action with the specified inputs. # Returns the definition of a tool call that should be executed by the client. + "action": "A String", # Required. The name of the tool's action associated with this call. + "inputParameters": { # Optional. The action's input parameters. + "a_key": "", # Properties of the object. + }, + "tool": "A String", # Required. The tool associated with this call. Format: `projects//locations//agents//tools/`. + }, }, }, ], - "condition": "A String", # The condition to activate and select this case. Empty means the condition is always true. The condition is evaluated against form parameters or session parameters. See the [conditions reference](https://cloud.google.com/dialogflow/cx/docs/reference/condition). + "condition": "A String", # The condition to activate and select this case. Empty means the condition is always true. The condition is evaluated against form parameters or session parameters. See the [conditions reference](https://cloud.google.com/dialogflow/cx/docs/reference/condition). + }, + ], + }, + ], + "enableGenerativeFallback": True or False, # If the flag is true, the agent will utilize LLM to generate a text response. If LLM generation fails, the defined responses in the fulfillment will be respected. This flag is only useful for fulfillments associated with no-match event handlers. + "messages": [ # The list of rich message responses to present to the user. + { # 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. + "channel": "A String", # The channel which the response is associated with. Clients can specify the channel via QueryParameters.channel, and only associated channel response will be returned. + "conversationSuccess": { # 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. # Indicates that the conversation succeeded. + "metadata": { # Custom metadata. Dialogflow doesn't impose any structure on this. + "a_key": "", # Properties of the object. + }, + }, + "endInteraction": { # 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. # Output only. A signal that indicates the interaction with the Dialogflow agent has ended. This message is generated by Dialogflow only when the conversation reaches `END_SESSION` page. It is not supposed to be defined by the user. It's guaranteed that there is at most one such message in each response. + }, + "knowledgeInfoCard": { # Represents info card response. If the response contains generative knowledge prediction, Dialogflow will return a payload with Infobot Messenger compatible info card. Otherwise, the info card response is skipped. # Represents info card for knowledge answers, to be better rendered in Dialogflow Messenger. + }, + "liveAgentHandoff": { # 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. # Hands off conversation to a human agent. + "metadata": { # Custom metadata for your handoff procedure. Dialogflow doesn't impose any structure on this. + "a_key": "", # Properties of the object. + }, + }, + "mixedAudio": { # 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. # Output only. An audio response message composed of both the synthesized Dialogflow agent responses and responses defined via play_audio. This message is generated by Dialogflow only and not supposed to be defined by the user. + "segments": [ # Segments this audio response is composed of. + { # Represents one segment of audio. + "allowPlaybackInterruption": True or False, # 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. + "audio": "A String", # Raw audio synthesized from the Dialogflow agent's response using the output config specified in the request. + "uri": "A String", # Client-specific URI that points to an audio clip accessible to the client. Dialogflow does not impose any validation on it. + }, + ], + }, + "outputAudioText": { # A text or ssml response that is preferentially used for TTS output audio synthesis, as described in the comment on the ResponseMessage message. # A text or ssml response that is preferentially used for TTS output audio synthesis, as described in the comment on the ResponseMessage message. + "allowPlaybackInterruption": True or False, # 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. + "ssml": "A String", # The SSML text to be synthesized. For more information, see [SSML](/speech/text-to-speech/docs/ssml). + "text": "A String", # The raw text to be synthesized. + }, + "payload": { # Returns a response containing a custom, platform-specific payload. + "a_key": "", # Properties of the object. + }, + "playAudio": { # Specifies an audio clip to be played by the client as part of the response. # Signal that the client should play an audio clip hosted at a client-specific URI. Dialogflow uses this to construct mixed_audio. However, Dialogflow itself does not try to read or process the URI in any way. + "allowPlaybackInterruption": True or False, # 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. + "audioUri": "A String", # Required. URI of the audio clip. Dialogflow does not impose any validation on this value. It is specific to the client that reads it. + }, + "telephonyTransferCall": { # Represents the signal that telles the client to transfer the phone call connected to the agent to a third-party endpoint. # A signal that the client should transfer the phone call connected to this agent to a third-party endpoint. + "phoneNumber": "A String", # Transfer the call to a phone number in [E.164 format](https://en.wikipedia.org/wiki/E.164). + }, + "text": { # The text response message. # Returns a text response. + "allowPlaybackInterruption": True or False, # 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. + "text": [ # Required. A collection of text responses. + "A String", + ], + }, + "toolCall": { # Represents a call of a specific tool's action with the specified inputs. # Returns the definition of a tool call that should be executed by the client. + "action": "A String", # Required. The name of the tool's action associated with this call. + "inputParameters": { # Optional. The action's input parameters. + "a_key": "", # Properties of the object. + }, + "tool": "A String", # Required. The tool associated with this call. Format: `projects//locations//agents//tools/`. + }, + }, + ], + "returnPartialResponses": True or False, # Whether Dialogflow should return currently queued fulfillment response messages in streaming APIs. If a webhook is specified, it happens before Dialogflow invokes webhook. Warning: 1) This flag only affects streaming API. Responses are still queued and returned once in non-streaming API. 2) The flag can be enabled in any fulfillment but only the first 3 partial responses will be returned. You may only want to apply it to fulfillments that have slow webhooks. + "setParameterActions": [ # Set parameter values before executing the webhook. + { # Setting a parameter value. + "parameter": "A String", # Display name of the parameter. + "value": "", # The new value of the parameter. A null value clears the parameter. + }, + ], + "tag": "A String", # The value of this field will be populated in the WebhookRequest `fulfillmentInfo.tag` field by Dialogflow when the associated webhook is called. The tag is typically used by the webhook service to identify which fulfillment is being called, but it could be used for other purposes. This field is required if `webhook` is specified. + "webhook": "A String", # The webhook to call. Format: `projects//locations//agents//webhooks/`. + }, + }, + ], + }, + "isList": True or False, # Indicates whether the parameter represents a list of values. + "redact": True or False, # Indicates whether the parameter content should be redacted in log. If redaction is enabled, the parameter content will be replaced by parameter name during logging. Note: the parameter content is subject to redaction if either parameter level redaction or entity type level redaction is enabled. + "required": True or False, # 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. + }, + ], + }, + "knowledgeConnectorSettings": { # The Knowledge Connector settings for this page or flow. This includes information such as the attached Knowledge Bases, and the way to execute fulfillment. # Optional. Knowledge connector configuration. + "dataStoreConnections": [ # Optional. List of related data store connections. + { # A data store connection. It represents a data store in Discovery Engine and the type of the contents it contains. + "dataStore": "A String", # The full name of the referenced data store. Formats: `projects/{project}/locations/{location}/collections/{collection}/dataStores/{data_store}` `projects/{project}/locations/{location}/dataStores/{data_store}` + "dataStoreType": "A String", # The type of the connected data store. + }, + ], + "enabled": True or False, # Whether Knowledge Connector is enabled or not. + "targetFlow": "A String", # The target flow to transition to. Format: `projects//locations//agents//flows/`. + "targetPage": "A String", # The target page to transition to. Format: `projects//locations//agents//flows//pages/`. + "triggerFulfillment": { # A fulfillment can do one or more of the following actions at the same time: * Generate rich message responses. * Set parameter values. * Call the webhook. Fulfillments can be called at various stages in the Page or Form lifecycle. For example, when a DetectIntentRequest drives a session to enter a new page, the page's entry fulfillment can add a static response to the QueryResult in the returning DetectIntentResponse, call the webhook (for example, to load user data from a database), or both. # The fulfillment to be triggered. When the answers from the Knowledge Connector are selected by Dialogflow, you can utitlize the request scoped parameter `$request.knowledge.answers` (contains up to the 5 highest confidence answers) and `$request.knowledge.questions` (contains the corresponding questions) to construct the fulfillment. + "advancedSettings": { # Hierarchical advanced settings for agent/flow/page/fulfillment/parameter. Settings exposed at lower level overrides the settings exposed at higher level. Overriding occurs at the sub-setting level. For example, the playback_interruption_settings at fulfillment level only overrides the playback_interruption_settings at the agent level, leaving other settings at the agent level unchanged. DTMF settings does not override each other. DTMF settings set at different levels define DTMF detections running in parallel. Hierarchy: Agent->Flow->Page->Fulfillment/Parameter. # Hierarchical advanced settings for this fulfillment. The settings exposed at the lower level overrides the settings exposed at the higher level. + "audioExportGcsDestination": { # Google Cloud Storage location for a Dialogflow operation that writes or exports objects (e.g. exported agent or transcripts) outside of Dialogflow. # If present, incoming audio is exported by Dialogflow to the configured Google Cloud Storage destination. Exposed at the following levels: - Agent level - Flow level + "uri": "A String", # Required. The Google Cloud Storage URI for the exported objects. A URI is of the form: `gs://bucket/object-name-or-prefix` Whether a full object name, or just a prefix, its usage depends on the Dialogflow operation. + }, + "dtmfSettings": { # Define behaviors for DTMF (dual tone multi frequency). # Settings for DTMF. Exposed at the following levels: - Agent level - Flow level - Page level - Parameter level. + "enabled": True or False, # If true, incoming audio is processed for DTMF (dual tone multi frequency) events. For example, if the caller presses a button on their telephone keypad and DTMF processing is enabled, Dialogflow will detect the event (e.g. a "3" was pressed) in the incoming audio and pass the event to the bot to drive business logic (e.g. when 3 is pressed, return the account balance). + "endpointingTimeoutDuration": "A String", # Endpoint timeout setting for matching dtmf input to regex. + "finishDigit": "A String", # The digit that terminates a DTMF digit sequence. + "interdigitTimeoutDuration": "A String", # Interdigit timeout setting for matching dtmf input to regex. + "maxDigits": 42, # Max length of DTMF digits. + }, + "loggingSettings": { # Define behaviors on logging. # Settings for logging. Settings for Dialogflow History, Contact Center messages, StackDriver logs, and speech logging. Exposed at the following levels: - Agent level. + "enableInteractionLogging": True or False, # Enables DF Interaction logging. + "enableStackdriverLogging": True or False, # Enables StackDriver logging. + }, + "speechSettings": { # Define behaviors of speech to text detection. # Settings for speech to text detection. Exposed at the following levels: - Agent level - Flow level - Page level - Parameter level + "endpointerSensitivity": 42, # Sensitivity of the speech model that detects the end of speech. Scale from 0 to 100. + "models": { # Mapping from language to Speech-to-Text model. The mapped Speech-to-Text model will be selected for requests from its corresponding language. For more information, see [Speech models](https://cloud.google.com/dialogflow/cx/docs/concept/speech-models). + "a_key": "A String", + }, + "noSpeechTimeout": "A String", # Timeout before detecting no speech. + "useTimeoutBasedEndpointing": True or False, # Use timeout based endpointing, interpreting endpointer sensitivy as seconds of timeout value. + }, + }, + "conditionalCases": [ # Conditional cases for this fulfillment. + { # A list of cascading if-else conditions. Cases are mutually exclusive. The first one with a matching condition is selected, all the rest ignored. + "cases": [ # A list of cascading if-else conditions. + { # Each case has a Boolean condition. When it is evaluated to be True, the corresponding messages will be selected and evaluated recursively. + "caseContent": [ # A list of case content. + { # The list of messages or conditional cases to activate for this case. + "additionalCases": # Object with schema name: GoogleCloudDialogflowCxV3beta1FulfillmentConditionalCases # Additional cases to be evaluated. + "message": { # 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. # Returned message. + "channel": "A String", # The channel which the response is associated with. Clients can specify the channel via QueryParameters.channel, and only associated channel response will be returned. + "conversationSuccess": { # 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. # Indicates that the conversation succeeded. + "metadata": { # Custom metadata. Dialogflow doesn't impose any structure on this. + "a_key": "", # Properties of the object. + }, + }, + "endInteraction": { # 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. # Output only. A signal that indicates the interaction with the Dialogflow agent has ended. This message is generated by Dialogflow only when the conversation reaches `END_SESSION` page. It is not supposed to be defined by the user. It's guaranteed that there is at most one such message in each response. + }, + "knowledgeInfoCard": { # Represents info card response. If the response contains generative knowledge prediction, Dialogflow will return a payload with Infobot Messenger compatible info card. Otherwise, the info card response is skipped. # Represents info card for knowledge answers, to be better rendered in Dialogflow Messenger. + }, + "liveAgentHandoff": { # 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. # Hands off conversation to a human agent. + "metadata": { # Custom metadata for your handoff procedure. Dialogflow doesn't impose any structure on this. + "a_key": "", # Properties of the object. + }, + }, + "mixedAudio": { # 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. # Output only. An audio response message composed of both the synthesized Dialogflow agent responses and responses defined via play_audio. This message is generated by Dialogflow only and not supposed to be defined by the user. + "segments": [ # Segments this audio response is composed of. + { # Represents one segment of audio. + "allowPlaybackInterruption": True or False, # 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. + "audio": "A String", # Raw audio synthesized from the Dialogflow agent's response using the output config specified in the request. + "uri": "A String", # Client-specific URI that points to an audio clip accessible to the client. Dialogflow does not impose any validation on it. + }, + ], + }, + "outputAudioText": { # A text or ssml response that is preferentially used for TTS output audio synthesis, as described in the comment on the ResponseMessage message. # A text or ssml response that is preferentially used for TTS output audio synthesis, as described in the comment on the ResponseMessage message. + "allowPlaybackInterruption": True or False, # 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. + "ssml": "A String", # The SSML text to be synthesized. For more information, see [SSML](/speech/text-to-speech/docs/ssml). + "text": "A String", # The raw text to be synthesized. + }, + "payload": { # Returns a response containing a custom, platform-specific payload. + "a_key": "", # Properties of the object. + }, + "playAudio": { # Specifies an audio clip to be played by the client as part of the response. # Signal that the client should play an audio clip hosted at a client-specific URI. Dialogflow uses this to construct mixed_audio. However, Dialogflow itself does not try to read or process the URI in any way. + "allowPlaybackInterruption": True or False, # 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. + "audioUri": "A String", # Required. URI of the audio clip. Dialogflow does not impose any validation on this value. It is specific to the client that reads it. + }, + "telephonyTransferCall": { # Represents the signal that telles the client to transfer the phone call connected to the agent to a third-party endpoint. # A signal that the client should transfer the phone call connected to this agent to a third-party endpoint. + "phoneNumber": "A String", # Transfer the call to a phone number in [E.164 format](https://en.wikipedia.org/wiki/E.164). + }, + "text": { # The text response message. # Returns a text response. + "allowPlaybackInterruption": True or False, # 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. + "text": [ # Required. A collection of text responses. + "A String", + ], + }, + "toolCall": { # Represents a call of a specific tool's action with the specified inputs. # Returns the definition of a tool call that should be executed by the client. + "action": "A String", # Required. The name of the tool's action associated with this call. + "inputParameters": { # Optional. The action's input parameters. + "a_key": "", # Properties of the object. + }, + "tool": "A String", # Required. The tool associated with this call. Format: `projects//locations//agents//tools/`. + }, + }, + }, + ], + "condition": "A String", # The condition to activate and select this case. Empty means the condition is always true. The condition is evaluated against form parameters or session parameters. See the [conditions reference](https://cloud.google.com/dialogflow/cx/docs/reference/condition). + }, + ], + }, + ], + "enableGenerativeFallback": True or False, # If the flag is true, the agent will utilize LLM to generate a text response. If LLM generation fails, the defined responses in the fulfillment will be respected. This flag is only useful for fulfillments associated with no-match event handlers. + "messages": [ # The list of rich message responses to present to the user. + { # 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. + "channel": "A String", # The channel which the response is associated with. Clients can specify the channel via QueryParameters.channel, and only associated channel response will be returned. + "conversationSuccess": { # 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. # Indicates that the conversation succeeded. + "metadata": { # Custom metadata. Dialogflow doesn't impose any structure on this. + "a_key": "", # Properties of the object. + }, + }, + "endInteraction": { # 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. # Output only. A signal that indicates the interaction with the Dialogflow agent has ended. This message is generated by Dialogflow only when the conversation reaches `END_SESSION` page. It is not supposed to be defined by the user. It's guaranteed that there is at most one such message in each response. + }, + "knowledgeInfoCard": { # Represents info card response. If the response contains generative knowledge prediction, Dialogflow will return a payload with Infobot Messenger compatible info card. Otherwise, the info card response is skipped. # Represents info card for knowledge answers, to be better rendered in Dialogflow Messenger. + }, + "liveAgentHandoff": { # 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. # Hands off conversation to a human agent. + "metadata": { # Custom metadata for your handoff procedure. Dialogflow doesn't impose any structure on this. + "a_key": "", # Properties of the object. + }, + }, + "mixedAudio": { # 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. # Output only. An audio response message composed of both the synthesized Dialogflow agent responses and responses defined via play_audio. This message is generated by Dialogflow only and not supposed to be defined by the user. + "segments": [ # Segments this audio response is composed of. + { # Represents one segment of audio. + "allowPlaybackInterruption": True or False, # 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. + "audio": "A String", # Raw audio synthesized from the Dialogflow agent's response using the output config specified in the request. + "uri": "A String", # Client-specific URI that points to an audio clip accessible to the client. Dialogflow does not impose any validation on it. + }, + ], + }, + "outputAudioText": { # A text or ssml response that is preferentially used for TTS output audio synthesis, as described in the comment on the ResponseMessage message. # A text or ssml response that is preferentially used for TTS output audio synthesis, as described in the comment on the ResponseMessage message. + "allowPlaybackInterruption": True or False, # 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. + "ssml": "A String", # The SSML text to be synthesized. For more information, see [SSML](/speech/text-to-speech/docs/ssml). + "text": "A String", # The raw text to be synthesized. + }, + "payload": { # Returns a response containing a custom, platform-specific payload. + "a_key": "", # Properties of the object. + }, + "playAudio": { # Specifies an audio clip to be played by the client as part of the response. # Signal that the client should play an audio clip hosted at a client-specific URI. Dialogflow uses this to construct mixed_audio. However, Dialogflow itself does not try to read or process the URI in any way. + "allowPlaybackInterruption": True or False, # 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. + "audioUri": "A String", # Required. URI of the audio clip. Dialogflow does not impose any validation on this value. It is specific to the client that reads it. + }, + "telephonyTransferCall": { # Represents the signal that telles the client to transfer the phone call connected to the agent to a third-party endpoint. # A signal that the client should transfer the phone call connected to this agent to a third-party endpoint. + "phoneNumber": "A String", # Transfer the call to a phone number in [E.164 format](https://en.wikipedia.org/wiki/E.164). + }, + "text": { # The text response message. # Returns a text response. + "allowPlaybackInterruption": True or False, # 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. + "text": [ # Required. A collection of text responses. + "A String", + ], + }, + "toolCall": { # Represents a call of a specific tool's action with the specified inputs. # Returns the definition of a tool call that should be executed by the client. + "action": "A String", # Required. The name of the tool's action associated with this call. + "inputParameters": { # Optional. The action's input parameters. + "a_key": "", # Properties of the object. + }, + "tool": "A String", # Required. The tool associated with this call. Format: `projects//locations//agents//tools/`. + }, + }, + ], + "returnPartialResponses": True or False, # Whether Dialogflow should return currently queued fulfillment response messages in streaming APIs. If a webhook is specified, it happens before Dialogflow invokes webhook. Warning: 1) This flag only affects streaming API. Responses are still queued and returned once in non-streaming API. 2) The flag can be enabled in any fulfillment but only the first 3 partial responses will be returned. You may only want to apply it to fulfillments that have slow webhooks. + "setParameterActions": [ # Set parameter values before executing the webhook. + { # Setting a parameter value. + "parameter": "A String", # Display name of the parameter. + "value": "", # The new value of the parameter. A null value clears the parameter. + }, + ], + "tag": "A String", # The value of this field will be populated in the WebhookRequest `fulfillmentInfo.tag` field by Dialogflow when the associated webhook is called. The tag is typically used by the webhook service to identify which fulfillment is being called, but it could be used for other purposes. This field is required if `webhook` is specified. + "webhook": "A String", # The webhook to call. Format: `projects//locations//agents//webhooks/`. + }, + }, + "name": "A String", # The unique identifier of the page. Required for the Pages.UpdatePage method. Pages.CreatePage populates the name automatically. Format: `projects//locations//agents//flows//pages/`. + "transitionRouteGroups": [ # Ordered list of `TransitionRouteGroups` added to the page. Transition route groups must be unique within a page. If the page links both flow-level transition route groups and agent-level transition route groups, the flow-level ones will have higher priority and will be put before the agent-level ones. * If multiple transition routes within a page scope refer to the same intent, then the precedence order is: page's transition route -> page's transition route group -> flow's transition routes. * If multiple transition route groups within a page contain the same intent, then the first group in the ordered list takes precedence. Format:`projects//locations//agents//flows//transitionRouteGroups/` or `projects//locations//agents//transitionRouteGroups/` for agent-level groups. + "A String", + ], + "transitionRoutes": [ # A list of transitions for the transition rules of this page. They route the conversation to another page in the same flow, or another flow. When we are in a certain page, the TransitionRoutes are evalauted in the following order: * TransitionRoutes defined in the page with intent specified. * TransitionRoutes defined in the transition route groups with intent specified. * TransitionRoutes defined in flow with intent specified. * TransitionRoutes defined in the transition route groups with intent specified. * TransitionRoutes defined in the page with only condition specified. * TransitionRoutes defined in the transition route groups with only condition specified. + { # A transition route specifies a intent that can be matched and/or a data condition that can be evaluated during a session. When a specified transition is matched, the following actions are taken in order: * If there is a `trigger_fulfillment` associated with the transition, it will be called. * If there is a `target_page` associated with the transition, the session will transition into the specified page. * If there is a `target_flow` associated with the transition, the session will transition into the specified flow. + "condition": "A String", # The condition to evaluate against form parameters or session parameters. See the [conditions reference](https://cloud.google.com/dialogflow/cx/docs/reference/condition). At least one of `intent` or `condition` must be specified. When both `intent` and `condition` are specified, the transition can only happen when both are fulfilled. + "description": "A String", # Optional. The description of the transition route. The maximum length is 500 characters. + "intent": "A String", # The unique identifier of an Intent. Format: `projects//locations//agents//intents/`. Indicates that the transition can only happen when the given intent is matched. At least one of `intent` or `condition` must be specified. When both `intent` and `condition` are specified, the transition can only happen when both are fulfilled. + "name": "A String", # Output only. The unique identifier of this transition route. + "targetFlow": "A String", # The target flow to transition to. Format: `projects//locations//agents//flows/`. + "targetPage": "A String", # The target page to transition to. Format: `projects//locations//agents//flows//pages/`. + "triggerFulfillment": { # A fulfillment can do one or more of the following actions at the same time: * Generate rich message responses. * Set parameter values. * Call the webhook. Fulfillments can be called at various stages in the Page or Form lifecycle. For example, when a DetectIntentRequest drives a session to enter a new page, the page's entry fulfillment can add a static response to the QueryResult in the returning DetectIntentResponse, call the webhook (for example, to load user data from a database), or both. # The fulfillment to call when the condition is satisfied. At least one of `trigger_fulfillment` and `target` must be specified. When both are defined, `trigger_fulfillment` is executed first. + "advancedSettings": { # Hierarchical advanced settings for agent/flow/page/fulfillment/parameter. Settings exposed at lower level overrides the settings exposed at higher level. Overriding occurs at the sub-setting level. For example, the playback_interruption_settings at fulfillment level only overrides the playback_interruption_settings at the agent level, leaving other settings at the agent level unchanged. DTMF settings does not override each other. DTMF settings set at different levels define DTMF detections running in parallel. Hierarchy: Agent->Flow->Page->Fulfillment/Parameter. # Hierarchical advanced settings for this fulfillment. The settings exposed at the lower level overrides the settings exposed at the higher level. + "audioExportGcsDestination": { # Google Cloud Storage location for a Dialogflow operation that writes or exports objects (e.g. exported agent or transcripts) outside of Dialogflow. # If present, incoming audio is exported by Dialogflow to the configured Google Cloud Storage destination. Exposed at the following levels: - Agent level - Flow level + "uri": "A String", # Required. The Google Cloud Storage URI for the exported objects. A URI is of the form: `gs://bucket/object-name-or-prefix` Whether a full object name, or just a prefix, its usage depends on the Dialogflow operation. + }, + "dtmfSettings": { # Define behaviors for DTMF (dual tone multi frequency). # Settings for DTMF. Exposed at the following levels: - Agent level - Flow level - Page level - Parameter level. + "enabled": True or False, # If true, incoming audio is processed for DTMF (dual tone multi frequency) events. For example, if the caller presses a button on their telephone keypad and DTMF processing is enabled, Dialogflow will detect the event (e.g. a "3" was pressed) in the incoming audio and pass the event to the bot to drive business logic (e.g. when 3 is pressed, return the account balance). + "endpointingTimeoutDuration": "A String", # Endpoint timeout setting for matching dtmf input to regex. + "finishDigit": "A String", # The digit that terminates a DTMF digit sequence. + "interdigitTimeoutDuration": "A String", # Interdigit timeout setting for matching dtmf input to regex. + "maxDigits": 42, # Max length of DTMF digits. + }, + "loggingSettings": { # Define behaviors on logging. # Settings for logging. Settings for Dialogflow History, Contact Center messages, StackDriver logs, and speech logging. Exposed at the following levels: - Agent level. + "enableInteractionLogging": True or False, # Enables DF Interaction logging. + "enableStackdriverLogging": True or False, # Enables StackDriver logging. + }, + "speechSettings": { # Define behaviors of speech to text detection. # Settings for speech to text detection. Exposed at the following levels: - Agent level - Flow level - Page level - Parameter level + "endpointerSensitivity": 42, # Sensitivity of the speech model that detects the end of speech. Scale from 0 to 100. + "models": { # Mapping from language to Speech-to-Text model. The mapped Speech-to-Text model will be selected for requests from its corresponding language. For more information, see [Speech models](https://cloud.google.com/dialogflow/cx/docs/concept/speech-models). + "a_key": "A String", + }, + "noSpeechTimeout": "A String", # Timeout before detecting no speech. + "useTimeoutBasedEndpointing": True or False, # Use timeout based endpointing, interpreting endpointer sensitivy as seconds of timeout value. + }, + }, + "conditionalCases": [ # Conditional cases for this fulfillment. + { # A list of cascading if-else conditions. Cases are mutually exclusive. The first one with a matching condition is selected, all the rest ignored. + "cases": [ # A list of cascading if-else conditions. + { # Each case has a Boolean condition. When it is evaluated to be True, the corresponding messages will be selected and evaluated recursively. + "caseContent": [ # A list of case content. + { # The list of messages or conditional cases to activate for this case. + "additionalCases": # Object with schema name: GoogleCloudDialogflowCxV3beta1FulfillmentConditionalCases # Additional cases to be evaluated. + "message": { # 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. # Returned message. + "channel": "A String", # The channel which the response is associated with. Clients can specify the channel via QueryParameters.channel, and only associated channel response will be returned. + "conversationSuccess": { # 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. # Indicates that the conversation succeeded. + "metadata": { # Custom metadata. Dialogflow doesn't impose any structure on this. + "a_key": "", # Properties of the object. + }, + }, + "endInteraction": { # 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. # Output only. A signal that indicates the interaction with the Dialogflow agent has ended. This message is generated by Dialogflow only when the conversation reaches `END_SESSION` page. It is not supposed to be defined by the user. It's guaranteed that there is at most one such message in each response. + }, + "knowledgeInfoCard": { # Represents info card response. If the response contains generative knowledge prediction, Dialogflow will return a payload with Infobot Messenger compatible info card. Otherwise, the info card response is skipped. # Represents info card for knowledge answers, to be better rendered in Dialogflow Messenger. + }, + "liveAgentHandoff": { # 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. # Hands off conversation to a human agent. + "metadata": { # Custom metadata for your handoff procedure. Dialogflow doesn't impose any structure on this. + "a_key": "", # Properties of the object. + }, + }, + "mixedAudio": { # 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. # Output only. An audio response message composed of both the synthesized Dialogflow agent responses and responses defined via play_audio. This message is generated by Dialogflow only and not supposed to be defined by the user. + "segments": [ # Segments this audio response is composed of. + { # Represents one segment of audio. + "allowPlaybackInterruption": True or False, # 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. + "audio": "A String", # Raw audio synthesized from the Dialogflow agent's response using the output config specified in the request. + "uri": "A String", # Client-specific URI that points to an audio clip accessible to the client. Dialogflow does not impose any validation on it. + }, + ], }, - ], - }, - ], - "enableGenerativeFallback": True or False, # If the flag is true, the agent will utilize LLM to generate a text response. If LLM generation fails, the defined responses in the fulfillment will be respected. This flag is only useful for fulfillments associated with no-match event handlers. - "messages": [ # The list of rich message responses to present to the user. - { # 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. - "channel": "A String", # The channel which the response is associated with. Clients can specify the channel via QueryParameters.channel, and only associated channel response will be returned. - "conversationSuccess": { # 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. # Indicates that the conversation succeeded. - "metadata": { # Custom metadata. Dialogflow doesn't impose any structure on this. - "a_key": "", # Properties of the object. + "outputAudioText": { # A text or ssml response that is preferentially used for TTS output audio synthesis, as described in the comment on the ResponseMessage message. # A text or ssml response that is preferentially used for TTS output audio synthesis, as described in the comment on the ResponseMessage message. + "allowPlaybackInterruption": True or False, # 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. + "ssml": "A String", # The SSML text to be synthesized. For more information, see [SSML](/speech/text-to-speech/docs/ssml). + "text": "A String", # The raw text to be synthesized. }, - }, - "endInteraction": { # 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. # Output only. A signal that indicates the interaction with the Dialogflow agent has ended. This message is generated by Dialogflow only when the conversation reaches `END_SESSION` page. It is not supposed to be defined by the user. It's guaranteed that there is at most one such message in each response. - }, - "knowledgeInfoCard": { # Represents info card response. If the response contains generative knowledge prediction, Dialogflow will return a payload with Infobot Messenger compatible info card. Otherwise, the info card response is skipped. # Represents info card for knowledge answers, to be better rendered in Dialogflow Messenger. - }, - "liveAgentHandoff": { # 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. # Hands off conversation to a human agent. - "metadata": { # Custom metadata for your handoff procedure. Dialogflow doesn't impose any structure on this. + "payload": { # Returns a response containing a custom, platform-specific payload. "a_key": "", # Properties of the object. }, - }, - "mixedAudio": { # 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. # Output only. An audio response message composed of both the synthesized Dialogflow agent responses and responses defined via play_audio. This message is generated by Dialogflow only and not supposed to be defined by the user. - "segments": [ # Segments this audio response is composed of. - { # Represents one segment of audio. - "allowPlaybackInterruption": True or False, # 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. - "audio": "A String", # Raw audio synthesized from the Dialogflow agent's response using the output config specified in the request. - "uri": "A String", # Client-specific URI that points to an audio clip accessible to the client. Dialogflow does not impose any validation on it. + "playAudio": { # Specifies an audio clip to be played by the client as part of the response. # Signal that the client should play an audio clip hosted at a client-specific URI. Dialogflow uses this to construct mixed_audio. However, Dialogflow itself does not try to read or process the URI in any way. + "allowPlaybackInterruption": True or False, # 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. + "audioUri": "A String", # Required. URI of the audio clip. Dialogflow does not impose any validation on this value. It is specific to the client that reads it. + }, + "telephonyTransferCall": { # Represents the signal that telles the client to transfer the phone call connected to the agent to a third-party endpoint. # A signal that the client should transfer the phone call connected to this agent to a third-party endpoint. + "phoneNumber": "A String", # Transfer the call to a phone number in [E.164 format](https://en.wikipedia.org/wiki/E.164). + }, + "text": { # The text response message. # Returns a text response. + "allowPlaybackInterruption": True or False, # 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. + "text": [ # Required. A collection of text responses. + "A String", + ], + }, + "toolCall": { # Represents a call of a specific tool's action with the specified inputs. # Returns the definition of a tool call that should be executed by the client. + "action": "A String", # Required. The name of the tool's action associated with this call. + "inputParameters": { # Optional. The action's input parameters. + "a_key": "", # Properties of the object. }, - ], - }, - "outputAudioText": { # A text or ssml response that is preferentially used for TTS output audio synthesis, as described in the comment on the ResponseMessage message. # A text or ssml response that is preferentially used for TTS output audio synthesis, as described in the comment on the ResponseMessage message. - "allowPlaybackInterruption": True or False, # 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. - "ssml": "A String", # The SSML text to be synthesized. For more information, see [SSML](/speech/text-to-speech/docs/ssml). - "text": "A String", # The raw text to be synthesized. - }, - "payload": { # Returns a response containing a custom, platform-specific payload. - "a_key": "", # Properties of the object. - }, - "playAudio": { # Specifies an audio clip to be played by the client as part of the response. # Signal that the client should play an audio clip hosted at a client-specific URI. Dialogflow uses this to construct mixed_audio. However, Dialogflow itself does not try to read or process the URI in any way. - "allowPlaybackInterruption": True or False, # 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. - "audioUri": "A String", # Required. URI of the audio clip. Dialogflow does not impose any validation on this value. It is specific to the client that reads it. - }, - "telephonyTransferCall": { # Represents the signal that telles the client to transfer the phone call connected to the agent to a third-party endpoint. # A signal that the client should transfer the phone call connected to this agent to a third-party endpoint. - "phoneNumber": "A String", # Transfer the call to a phone number in [E.164 format](https://en.wikipedia.org/wiki/E.164). - }, - "text": { # The text response message. # Returns a text response. - "allowPlaybackInterruption": True or False, # 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. - "text": [ # Required. A collection of text responses. - "A String", - ], + "tool": "A String", # Required. The tool associated with this call. Format: `projects//locations//agents//tools/`. + }, }, }, ], - "returnPartialResponses": True or False, # Whether Dialogflow should return currently queued fulfillment response messages in streaming APIs. If a webhook is specified, it happens before Dialogflow invokes webhook. Warning: 1) This flag only affects streaming API. Responses are still queued and returned once in non-streaming API. 2) The flag can be enabled in any fulfillment but only the first 3 partial responses will be returned. You may only want to apply it to fulfillments that have slow webhooks. - "setParameterActions": [ # Set parameter values before executing the webhook. - { # Setting a parameter value. - "parameter": "A String", # Display name of the parameter. - "value": "", # The new value of the parameter. A null value clears the parameter. - }, - ], - "tag": "A String", # The value of this field will be populated in the WebhookRequest `fulfillmentInfo.tag` field by Dialogflow when the associated webhook is called. The tag is typically used by the webhook service to identify which fulfillment is being called, but it could be used for other purposes. This field is required if `webhook` is specified. - "webhook": "A String", # The webhook to call. Format: `projects//locations//agents//webhooks/`. + "condition": "A String", # The condition to activate and select this case. Empty means the condition is always true. The condition is evaluated against form parameters or session parameters. See the [conditions reference](https://cloud.google.com/dialogflow/cx/docs/reference/condition). + }, + ], + }, + ], + "enableGenerativeFallback": True or False, # If the flag is true, the agent will utilize LLM to generate a text response. If LLM generation fails, the defined responses in the fulfillment will be respected. This flag is only useful for fulfillments associated with no-match event handlers. + "messages": [ # The list of rich message responses to present to the user. + { # 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. + "channel": "A String", # The channel which the response is associated with. Clients can specify the channel via QueryParameters.channel, and only associated channel response will be returned. + "conversationSuccess": { # 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. # Indicates that the conversation succeeded. + "metadata": { # Custom metadata. Dialogflow doesn't impose any structure on this. + "a_key": "", # Properties of the object. + }, + }, + "endInteraction": { # 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. # Output only. A signal that indicates the interaction with the Dialogflow agent has ended. This message is generated by Dialogflow only when the conversation reaches `END_SESSION` page. It is not supposed to be defined by the user. It's guaranteed that there is at most one such message in each response. + }, + "knowledgeInfoCard": { # Represents info card response. If the response contains generative knowledge prediction, Dialogflow will return a payload with Infobot Messenger compatible info card. Otherwise, the info card response is skipped. # Represents info card for knowledge answers, to be better rendered in Dialogflow Messenger. + }, + "liveAgentHandoff": { # 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. # Hands off conversation to a human agent. + "metadata": { # Custom metadata for your handoff procedure. Dialogflow doesn't impose any structure on this. + "a_key": "", # Properties of the object. + }, + }, + "mixedAudio": { # 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. # Output only. An audio response message composed of both the synthesized Dialogflow agent responses and responses defined via play_audio. This message is generated by Dialogflow only and not supposed to be defined by the user. + "segments": [ # Segments this audio response is composed of. + { # Represents one segment of audio. + "allowPlaybackInterruption": True or False, # 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. + "audio": "A String", # Raw audio synthesized from the Dialogflow agent's response using the output config specified in the request. + "uri": "A String", # Client-specific URI that points to an audio clip accessible to the client. Dialogflow does not impose any validation on it. + }, + ], + }, + "outputAudioText": { # A text or ssml response that is preferentially used for TTS output audio synthesis, as described in the comment on the ResponseMessage message. # A text or ssml response that is preferentially used for TTS output audio synthesis, as described in the comment on the ResponseMessage message. + "allowPlaybackInterruption": True or False, # 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. + "ssml": "A String", # The SSML text to be synthesized. For more information, see [SSML](/speech/text-to-speech/docs/ssml). + "text": "A String", # The raw text to be synthesized. + }, + "payload": { # Returns a response containing a custom, platform-specific payload. + "a_key": "", # Properties of the object. + }, + "playAudio": { # Specifies an audio clip to be played by the client as part of the response. # Signal that the client should play an audio clip hosted at a client-specific URI. Dialogflow uses this to construct mixed_audio. However, Dialogflow itself does not try to read or process the URI in any way. + "allowPlaybackInterruption": True or False, # 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. + "audioUri": "A String", # Required. URI of the audio clip. Dialogflow does not impose any validation on this value. It is specific to the client that reads it. + }, + "telephonyTransferCall": { # Represents the signal that telles the client to transfer the phone call connected to the agent to a third-party endpoint. # A signal that the client should transfer the phone call connected to this agent to a third-party endpoint. + "phoneNumber": "A String", # Transfer the call to a phone number in [E.164 format](https://en.wikipedia.org/wiki/E.164). + }, + "text": { # The text response message. # Returns a text response. + "allowPlaybackInterruption": True or False, # 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. + "text": [ # Required. A collection of text responses. + "A String", + ], + }, + "toolCall": { # Represents a call of a specific tool's action with the specified inputs. # Returns the definition of a tool call that should be executed by the client. + "action": "A String", # Required. The name of the tool's action associated with this call. + "inputParameters": { # Optional. The action's input parameters. + "a_key": "", # Properties of the object. }, + "tool": "A String", # Required. The tool associated with this call. Format: `projects//locations//agents//tools/`. + }, + }, + ], + "returnPartialResponses": True or False, # Whether Dialogflow should return currently queued fulfillment response messages in streaming APIs. If a webhook is specified, it happens before Dialogflow invokes webhook. Warning: 1) This flag only affects streaming API. Responses are still queued and returned once in non-streaming API. 2) The flag can be enabled in any fulfillment but only the first 3 partial responses will be returned. You may only want to apply it to fulfillments that have slow webhooks. + "setParameterActions": [ # Set parameter values before executing the webhook. + { # Setting a parameter value. + "parameter": "A String", # Display name of the parameter. + "value": "", # The new value of the parameter. A null value clears the parameter. + }, + ], + "tag": "A String", # The value of this field will be populated in the WebhookRequest `fulfillmentInfo.tag` field by Dialogflow when the associated webhook is called. The tag is typically used by the webhook service to identify which fulfillment is being called, but it could be used for other purposes. This field is required if `webhook` is specified. + "webhook": "A String", # The webhook to call. Format: `projects//locations//agents//webhooks/`. + }, + }, + ], + }, + "matches": [ # Match results, if more than one, ordered descendingly by the confidence we have that the particular intent matches the query. + { # Represents one match result of MatchIntent. + "confidence": 3.14, # The confidence of this match. 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. + "event": "A String", # The event that matched the query. Filled for `EVENT`, `NO_MATCH` and `NO_INPUT` match types. + "intent": { # An intent represents a user's intent to interact with a conversational agent. You can provide information for the Dialogflow API to use to match user input to an intent by adding training phrases (i.e., examples of user input) to your intent. # The Intent that matched the query. Some, not all fields are filled in this message, including but not limited to: `name` and `display_name`. Only filled for `INTENT` match type. + "description": "A String", # Human readable description for better understanding an intent like its scope, content, result etc. Maximum character limit: 140 characters. + "displayName": "A String", # Required. The human-readable name of the intent, unique within the agent. + "isFallback": True or False, # Indicates whether this is a fallback intent. Currently only default fallback intent is allowed in the agent, which is added upon agent creation. Adding training phrases to fallback intent is useful in the case of requests that are mistakenly matched, since training phrases assigned to fallback intents act as negative examples that triggers no-match event. + "labels": { # The key/value metadata to label an intent. Labels can contain lowercase letters, digits and the symbols '-' and '_'. International characters are allowed, including letters from unicase alphabets. Keys must start with a letter. Keys and values can be no longer than 63 characters and no more than 128 bytes. Prefix "sys-" is reserved for Dialogflow defined labels. Currently allowed Dialogflow defined labels include: * sys-head * sys-contextual The above labels do not require value. "sys-head" means the intent is a head intent. "sys-contextual" means the intent is a contextual intent. + "a_key": "A String", + }, + "name": "A String", # The unique identifier of the intent. Required for the Intents.UpdateIntent method. Intents.CreateIntent populates the name automatically. Format: `projects//locations//agents//intents/`. + "parameters": [ # The collection of parameters associated with the intent. + { # Represents an intent parameter. + "entityType": "A String", # Required. The entity type of the parameter. Format: `projects/-/locations/-/agents/-/entityTypes/` for system entity types (for example, `projects/-/locations/-/agents/-/entityTypes/sys.date`), or `projects//locations//agents//entityTypes/` for developer entity types. + "id": "A String", # Required. The unique identifier of the parameter. This field is used by training phrases to annotate their parts. + "isList": True or False, # Indicates whether the parameter represents a list of values. + "redact": True or False, # Indicates whether the parameter content should be redacted in log. If redaction is enabled, the parameter content will be replaced by parameter name during logging. Note: the parameter content is subject to redaction if either parameter level redaction or entity type level redaction is enabled. + }, + ], + "priority": 42, # 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. + "trainingPhrases": [ # The collection of training phrases the agent is trained on to identify the intent. + { # Represents an example that the agent is trained on to identify the intent. + "id": "A String", # Output only. The unique identifier of the training phrase. + "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 `parameter_id` field is set. + { # Represents a part of a training phrase. + "parameterId": "A String", # The parameter used to annotate this part of the training phrase. This field is required for annotated parts of the training phrase. + "text": "A String", # Required. The text for this part. }, ], + "repeatCount": 42, # Indicates how many times this example was added to the intent. }, - "isList": True or False, # Indicates whether the parameter represents a list of values. - "redact": True or False, # Indicates whether the parameter content should be redacted in log. If redaction is enabled, the parameter content will be replaced by parameter name during logging. Note: the parameter content is subject to redaction if either parameter level redaction or entity type level redaction is enabled. - "required": True or False, # 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. - }, + ], + }, + "matchType": "A String", # Type of this Match. + "parameters": { # The collection of parameters extracted from the query. 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 then use map, otherwise, depending on the parameter value type, it could be one of string, number, boolean, null, list or map. * MapValue value: If parameter's entity type is a composite entity then use map from composite entity property names to property values, otherwise, use parameter value. + "a_key": "", # Properties of the object. + }, + "resolvedInput": "A String", # Final text input which was matched during MatchIntent. This value can be different from original input sent in request because of spelling correction or other processing. + }, + ], + "text": "A String", # If natural language text was provided as input, this field will contain a copy of the text. + "transcript": "A String", # If natural language speech audio was provided as input, this field will contain the transcript for the audio. + "triggerEvent": "A String", # If an event was provided as input, this field will contain a copy of the event name. + "triggerIntent": "A String", # If an intent was provided as input, this field will contain a copy of the intent identifier. Format: `projects//locations//agents//intents/`. +}
+
+ +
+ serverStreamingDetectIntent(session, body=None, x__xgafv=None) +
Processes a natural language query and returns structured, actionable data as a result through server-side streaming. Server-side streaming allows Dialogflow to send [partial responses](https://cloud.google.com/dialogflow/cx/docs/concept/fulfillment#partial-response) earlier in a single request.
+
+Args:
+  session: string, Required. The name of the session this query is sent to. Format: `projects//locations//agents//sessions/` or `projects//locations//agents//environments//sessions/`. If `Environment ID` is not specified, we assume default 'draft' environment. It's up to the API caller to choose an appropriate `Session ID`. It can be a random number or some type of session identifiers (preferably hashed). The length of the `Session ID` must not exceed 36 characters. For more information, see the [sessions guide](https://cloud.google.com/dialogflow/cx/docs/concept/session). Note: Always use agent versions for production traffic. See [Versions and environments](https://cloud.google.com/dialogflow/cx/docs/concept/version). (required)
+  body: object, The request body.
+    The object takes the form of:
+
+{ # The request to detect user's intent.
+  "outputAudioConfig": { # Instructs the speech synthesizer how to generate the output audio content. # Instructs the speech synthesizer how to generate the output audio.
+    "audioEncoding": "A String", # Required. Audio encoding of the synthesized audio content.
+    "sampleRateHertz": 42, # Optional. 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).
+    "synthesizeSpeechConfig": { # Configuration of how speech should be synthesized. # Optional. Configuration of how speech should be synthesized. If not specified, Agent.text_to_speech_settings is applied.
+      "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.
+        "A String",
       ],
+      "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.
+      "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.
+      "voice": { # Description of which voice to use for speech synthesis. # Optional. The desired voice of the synthesized audio.
+        "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. For the list of available voices, please refer to [Supported voices and languages](https://cloud.google.com/text-to-speech/docs/voices).
+        "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.
+      },
+      "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.
     },
-    "knowledgeConnectorSettings": { # The Knowledge Connector settings for this page or flow. This includes information such as the attached Knowledge Bases, and the way to execute fulfillment. # Optional. Knowledge connector configuration.
-      "dataStoreConnections": [ # Optional. List of related data store connections.
-        { # A data store connection. It represents a data store in Discovery Engine and the type of the contents it contains.
-          "dataStore": "A String", # The full name of the referenced data store. Formats: `projects/{project}/locations/{location}/collections/{collection}/dataStores/{data_store}` `projects/{project}/locations/{location}/dataStores/{data_store}`
-          "dataStoreType": "A String", # The type of the connected data store.
+  },
+  "queryInput": { # Represents the query input. It can contain one of: 1. A conversational query in the form of text. 2. An intent query that specifies which intent to trigger. 3. Natural language speech audio to be processed. 4. An event to be triggered. 5. DTMF digits to invoke an intent and fill in parameter value. 6. The results of a tool executed by the client. # Required. The input specification.
+    "audio": { # Represents the natural speech audio to be processed. # The natural language speech audio to be processed.
+      "audio": "A String", # The natural language speech audio to be processed. A single request can contain up to 2 minutes of speech audio data. The transcribed text cannot contain more than 256 bytes. For non-streaming audio detect intent, both `config` and `audio` must be provided. For streaming audio detect intent, `config` must be provided in the first request and `audio` must be provided in all following requests.
+      "config": { # Instructs the speech recognizer on how to process the audio content. # Required. Instructs the speech recognizer how to process the speech audio.
+        "audioEncoding": "A String", # Required. Audio encoding of the audio content to process.
+        "bargeInConfig": { # Configuration of the barge-in behavior. Barge-in instructs the API to return a detected utterance at a proper time while the client is playing back the response audio from a previous request. When the client sees the utterance, it should stop the playback and immediately get ready for receiving the responses for the current request. The barge-in handling requires the client to start streaming audio input as soon as it starts playing back the audio from the previous response. The playback is modeled into two phases: * No barge-in phase: which goes first and during which speech detection should not be carried out. * Barge-in phase: which follows the no barge-in phase and during which the API starts speech detection and may inform the client that an utterance has been detected. Note that no-speech event is not expected in this phase. The client provides this configuration in terms of the durations of those two phases. The durations are measured in terms of the audio length from the the start of the input audio. No-speech event is a response with END_OF_UTTERANCE without any transcript following up. # Configuration of barge-in behavior during the streaming of input audio.
+          "noBargeInDuration": "A String", # Duration that is not eligible for barge-in at the beginning of the input audio.
+          "totalDuration": "A String", # Total duration for the playback at the beginning of the input audio.
+        },
+        "enableWordInfo": True or False, # Optional. If `true`, Dialogflow returns SpeechWordInfo in StreamingRecognitionResult with information about the recognized speech words, e.g. start and end time offsets. If false or unspecified, Speech doesn't return any word-level information.
+        "model": "A String", # Optional. Which Speech model to select for the given request. For more information, see [Speech models](https://cloud.google.com/dialogflow/cx/docs/concept/speech-models).
+        "modelVariant": "A String", # Optional. Which variant of the Speech model to use.
+        "optOutConformerModelMigration": True or False, # If `true`, the request will opt out for STT conformer model migration. This field will be deprecated once force migration takes place in June 2024. Please refer to [Dialogflow CX Speech model migration](https://cloud.google.com/dialogflow/cx/docs/concept/speech-model-migration).
+        "phraseHints": [ # Optional. A list of strings containing words and phrases that the speech recognizer should recognize with higher likelihood. See [the Cloud Speech documentation](https://cloud.google.com/speech-to-text/docs/basics#phrase-hints) for more details.
+          "A String",
+        ],
+        "sampleRateHertz": 42, # Sample rate (in Hertz) of the audio content sent in the query. Refer to [Cloud Speech API documentation](https://cloud.google.com/speech-to-text/docs/basics) for more details.
+        "singleUtterance": True or False, # Optional. If `false` (default), recognition does not cease until the client closes the stream. If `true`, the recognizer will detect a single spoken utterance in input audio. Recognition ceases when it detects the audio's voice has stopped or paused. In this case, once a detected intent is received, the client should close the stream and start a new request with a new stream as needed. Note: This setting is relevant only for streaming methods.
+      },
+    },
+    "dtmf": { # Represents the input for dtmf event. # The DTMF event to be handled.
+      "digits": "A String", # The dtmf digits.
+      "finishDigit": "A String", # The finish digit (if any).
+    },
+    "event": { # Represents the event to trigger. # The event to be triggered.
+      "event": "A String", # Name of the event.
+    },
+    "intent": { # Represents the intent to trigger programmatically rather than as a result of natural language processing. # The intent to be triggered.
+      "intent": "A String", # Required. The unique identifier of the intent. Format: `projects//locations//agents//intents/`.
+    },
+    "languageCode": "A String", # Required. The language of the input. See [Language Support](https://cloud.google.com/dialogflow/cx/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.
+    "text": { # Represents the natural language text to be processed. # The natural language text to be processed.
+      "text": "A String", # Required. The UTF-8 encoded natural language text to be processed.
+    },
+    "toolCallResult": { # The result of calling a tool's action that has been executed by the client. # The results of a tool executed by the client.
+      "action": "A String", # Required. The name of the tool's action associated with this call.
+      "error": { # An error produced by the tool call. # The tool call's error.
+        "message": "A String", # Optional. The error message of the function.
+      },
+      "outputParameters": { # The tool call's output parameters.
+        "a_key": "", # Properties of the object.
+      },
+      "tool": "A String", # Required. The tool associated with this call. Format: `projects//locations//agents//tools/`.
+    },
+  },
+  "queryParams": { # Represents the parameters of a conversational query. # The parameters of this query.
+    "analyzeQueryTextSentiment": True or False, # Configures whether sentiment analysis should be performed. If not provided, sentiment analysis is not performed.
+    "channel": "A String", # The channel which this query is for. If specified, only the ResponseMessage associated with the channel will be returned. If no ResponseMessage is associated with the channel, it falls back to the ResponseMessage with unspecified channel. If unspecified, the ResponseMessage with unspecified channel will be returned.
+    "currentPage": "A String", # The unique identifier of the page to override the current page in the session. Format: `projects//locations//agents//flows//pages/`. If `current_page` is specified, the previous state of the session will be ignored by Dialogflow, including the previous page and the previous session parameters. In most cases, current_page and parameters should be configured together to direct a session to a specific state.
+    "currentPlaybook": "A String", # Optional. Start the session with the specified playbook. You can only specify the playbook at the beginning of the session. Otherwise, an error will be thrown. Format: `projects//locations//agents//playbooks/`.
+    "disableWebhook": True or False, # Whether to disable webhook calls for this request.
+    "endUserMetadata": { # Optional. Information about the end-user to improve the relevance and accuracy of generative answers. This will be interpreted and used by a language model, so, for good results, the data should be self-descriptive, and in a simple structure. Example: ```json { "subscription plan": "Business Premium Plus", "devices owned": [ {"model": "Google Pixel 7"}, {"model": "Google Pixel Tablet"} ] } ```
+      "a_key": "", # Properties of the object.
+    },
+    "flowVersions": [ # A list of flow versions to override for the request. Format: `projects//locations//agents//flows//versions/`. If version 1 of flow X is included in this list, the traffic of flow X will go through version 1 regardless of the version configuration in the environment. Each flow can have at most one version specified in this list.
+      "A String",
+    ],
+    "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.
+      "latitude": 3.14, # The latitude in degrees. It must be in the range [-90.0, +90.0].
+      "longitude": 3.14, # The longitude in degrees. It must be in the range [-180.0, +180.0].
+    },
+    "llmModelSettings": { # Settings for LLM models. # Optional. Use the specified LLM model settings for processing the request.
+      "model": "A String", # The selected LLM model.
+      "promptText": "A String", # The custom prompt to use.
+    },
+    "parameters": { # Additional parameters to be put into session parameters. To remove a parameter from the session, clients should explicitly set the parameter value to null. You can reference the session parameters in the agent with the following format: $session.params.parameter-id. 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 then use map, otherwise, depending on the parameter value type, it could be one of string, number, boolean, null, list or map. * MapValue value: If parameter's entity type is a composite entity then use map from composite entity property names to property values, otherwise, use parameter value.
+      "a_key": "", # Properties of the object.
+    },
+    "payload": { # This field can be used to pass custom data into the webhook associated with the agent. Arbitrary JSON objects are supported. Some integrations that query a Dialogflow agent may provide additional information in the payload. In particular, for the Dialogflow Phone Gateway integration, this field has the form: ``` { "telephony": { "caller_id": "+18558363987" } } ```
+      "a_key": "", # Properties of the object.
+    },
+    "populateDataStoreConnectionSignals": True or False, # Optional. If set to true and data stores are involved in serving the request then DetectIntentResponse.query_result.data_store_connection_signals will be filled with data that can help evaluations.
+    "searchConfig": { # Search configuration for UCS search queries. # Optional. Search configuration for UCS search queries.
+      "boostSpecs": [ # Optional. Boosting configuration for the datastores.
+        { # Boost specifications for data stores.
+          "dataStores": [ # Optional. Data Stores where the boosting configuration is applied. The full names of the referenced data stores. Formats: `projects/{project}/locations/{location}/collections/{collection}/dataStores/{data_store}` `projects/{project}/locations/{location}/dataStores/{data_store}
+            "A String",
+          ],
+          "spec": [ # Optional. A list of boosting specifications.
+            { # Boost specification to boost certain documents. A copy of google.cloud.discoveryengine.v1main.BoostSpec, field documentation is available at https://cloud.google.com/generative-ai-app-builder/docs/reference/rest/v1alpha/BoostSpec
+              "conditionBoostSpecs": [ # Optional. Condition boost specifications. If a document matches multiple conditions in the specifictions, boost scores from these specifications are all applied and combined in a non-linear way. Maximum number of specifications is 20.
+                { # Boost applies to documents which match a condition.
+                  "boost": 3.14, # Optional. Strength of the condition boost, which should be in [-1, 1]. Negative boost means demotion. Default is 0.0. Setting to 1.0 gives the document a big promotion. However, it does not necessarily mean that the boosted document will be the top result at all times, nor that other documents will be excluded. Results could still be shown even when none of them matches the condition. And results that are significantly more relevant to the search query can still trump your heavily favored but irrelevant documents. Setting to -1.0 gives the document a big demotion. However, results that are deeply relevant might still be shown. The document will have an upstream battle to get a fairly high ranking, but it is not blocked out completely. Setting to 0.0 means no boost applied. The boosting condition is ignored.
+                  "condition": "A String", # Optional. An expression which specifies a boost condition. The syntax and supported fields are the same as a filter expression. Examples: * To boost documents with document ID "doc_1" or "doc_2", and color "Red" or "Blue": * (id: ANY("doc_1", "doc_2")) AND (color: ANY("Red","Blue"))
+                },
+              ],
+            },
+          ],
         },
       ],
-      "enabled": True or False, # Whether Knowledge Connector is enabled or not.
-      "targetFlow": "A String", # The target flow to transition to. Format: `projects//locations//agents//flows/`.
-      "targetPage": "A String", # The target page to transition to. Format: `projects//locations//agents//flows//pages/`.
-      "triggerFulfillment": { # A fulfillment can do one or more of the following actions at the same time: * Generate rich message responses. * Set parameter values. * Call the webhook. Fulfillments can be called at various stages in the Page or Form lifecycle. For example, when a DetectIntentRequest drives a session to enter a new page, the page's entry fulfillment can add a static response to the QueryResult in the returning DetectIntentResponse, call the webhook (for example, to load user data from a database), or both. # The fulfillment to be triggered. When the answers from the Knowledge Connector are selected by Dialogflow, you can utitlize the request scoped parameter `$request.knowledge.answers` (contains up to the 5 highest confidence answers) and `$request.knowledge.questions` (contains the corresponding questions) to construct the fulfillment.
-        "advancedSettings": { # Hierarchical advanced settings for agent/flow/page/fulfillment/parameter. Settings exposed at lower level overrides the settings exposed at higher level. Overriding occurs at the sub-setting level. For example, the playback_interruption_settings at fulfillment level only overrides the playback_interruption_settings at the agent level, leaving other settings at the agent level unchanged. DTMF settings does not override each other. DTMF settings set at different levels define DTMF detections running in parallel. Hierarchy: Agent->Flow->Page->Fulfillment/Parameter. # Hierarchical advanced settings for this fulfillment. The settings exposed at the lower level overrides the settings exposed at the higher level.
-          "audioExportGcsDestination": { # Google Cloud Storage location for a Dialogflow operation that writes or exports objects (e.g. exported agent or transcripts) outside of Dialogflow. # If present, incoming audio is exported by Dialogflow to the configured Google Cloud Storage destination. Exposed at the following levels: - Agent level - Flow level
-            "uri": "A String", # Required. The Google Cloud Storage URI for the exported objects. A URI is of the form: `gs://bucket/object-name-or-prefix` Whether a full object name, or just a prefix, its usage depends on the Dialogflow operation.
-          },
-          "dtmfSettings": { # Define behaviors for DTMF (dual tone multi frequency). # Settings for DTMF. Exposed at the following levels: - Agent level - Flow level - Page level - Parameter level.
-            "enabled": True or False, # If true, incoming audio is processed for DTMF (dual tone multi frequency) events. For example, if the caller presses a button on their telephone keypad and DTMF processing is enabled, Dialogflow will detect the event (e.g. a "3" was pressed) in the incoming audio and pass the event to the bot to drive business logic (e.g. when 3 is pressed, return the account balance).
-            "endpointingTimeoutDuration": "A String", # Endpoint timeout setting for matching dtmf input to regex.
-            "finishDigit": "A String", # The digit that terminates a DTMF digit sequence.
-            "interdigitTimeoutDuration": "A String", # Interdigit timeout setting for matching dtmf input to regex.
-            "maxDigits": 42, # Max length of DTMF digits.
-          },
-          "loggingSettings": { # Define behaviors on logging. # Settings for logging. Settings for Dialogflow History, Contact Center messages, StackDriver logs, and speech logging. Exposed at the following levels: - Agent level.
-            "enableInteractionLogging": True or False, # If true, DF Interaction logging is currently enabled.
-            "enableStackdriverLogging": True or False, # If true, StackDriver logging is currently enabled.
+      "filterSpecs": [ # Optional. Filter configuration for the datastores.
+        { # Filter specifications for data stores.
+          "dataStores": [ # Optional. Data Stores where the boosting configuration is applied. The full names of the referenced data stores. Formats: `projects/{project}/locations/{location}/collections/{collection}/dataStores/{data_store}` `projects/{project}/locations/{location}/dataStores/{data_store}
+            "A String",
+          ],
+          "filter": "A String", # Optional. The filter expression to be applied. Expression syntax is documented at https://cloud.google.com/generative-ai-app-builder/docs/filter-search-metadata#filter-expression-syntax
+        },
+      ],
+    },
+    "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.
+      { # Session entity types are referred to as **User** entity types and are entities that are built for an individual user such as favorites, preferences, playlists, and so on. You can redefine a session entity type at the session level to extend or replace a custom entity type at the user session level (we refer to the entity types defined at the agent level as "custom entity types"). Note: session entity types apply to all queries, regardless of the language. For more information about entity types, see the [Dialogflow documentation](https://cloud.google.com/dialogflow/docs/entities-overview).
+        "entities": [ # Required. The collection of entities to override or supplement the custom entity type.
+          { # An **entity entry** for an associated entity type.
+            "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`.
+              "A String",
+            ],
+            "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 canonical 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).
           },
-          "speechSettings": { # Define behaviors of speech to text detection. # Settings for speech to text detection. Exposed at the following levels: - Agent level - Flow level - Page level - Parameter level
-            "endpointerSensitivity": 42, # Sensitivity of the speech model that detects the end of speech. Scale from 0 to 100.
-            "models": { # Mapping from language to Speech-to-Text model. The mapped Speech-to-Text model will be selected for requests from its corresponding language. For more information, see [Speech models](https://cloud.google.com/dialogflow/cx/docs/concept/speech-models).
-              "a_key": "A String",
-            },
-            "noSpeechTimeout": "A String", # Timeout before detecting no speech.
-            "useTimeoutBasedEndpointing": True or False, # Use timeout based endpointing, interpreting endpointer sensitivy as seconds of timeout value.
+        ],
+        "entityOverrideMode": "A String", # Required. Indicates whether the additional data should override or supplement the custom entity type definition.
+        "name": "A String", # Required. The unique identifier of the session entity type. Format: `projects//locations//agents//sessions//entityTypes/` or `projects//locations//agents//environments//sessions//entityTypes/`. If `Environment ID` is not specified, we assume default 'draft' environment.
+      },
+    ],
+    "sessionTtl": "A String", # Optional. Configure lifetime of the Dialogflow session. By default, a Dialogflow session remains active and its data is stored for 30 minutes after the last request is sent for the session. This value should be no longer than 1 day.
+    "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 the agent is used.
+    "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 Dialogflow web console. The headers defined within this field will overwrite the headers configured through 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.
+      "a_key": "A String",
+    },
+  },
+  "session": "A String", # Required. The name of the session this query is sent to. Format: `projects//locations//agents//sessions/` or `projects//locations//agents//environments//sessions/`. If `Environment ID` is not specified, we assume default 'draft' environment. It's up to the API caller to choose an appropriate `Session ID`. It can be a random number or some type of session identifiers (preferably hashed). The length of the `Session ID` must not exceed 36 characters. For more information, see the [sessions guide](https://cloud.google.com/dialogflow/cx/docs/concept/session). Note: Always use agent versions for production traffic. See [Versions and environments](https://cloud.google.com/dialogflow/cx/docs/concept/version).
+}
+
+  x__xgafv: string, V1 error format.
+    Allowed values
+      1 - v1 error format
+      2 - v2 error format
+
+Returns:
+  An object of the form:
+
+    { # The message returned from the DetectIntent method.
+  "allowCancellation": True or False, # Indicates whether the partial response can be cancelled when a later response arrives. e.g. if the agent specified some music as partial response, it can be cancelled.
+  "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.response_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.
+  "outputAudioConfig": { # Instructs the speech synthesizer how to generate the output audio content. # The config used by the speech synthesizer to generate the output audio.
+    "audioEncoding": "A String", # Required. Audio encoding of the synthesized audio content.
+    "sampleRateHertz": 42, # Optional. 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).
+    "synthesizeSpeechConfig": { # Configuration of how speech should be synthesized. # Optional. Configuration of how speech should be synthesized. If not specified, Agent.text_to_speech_settings is applied.
+      "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.
+        "A String",
+      ],
+      "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.
+      "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.
+      "voice": { # Description of which voice to use for speech synthesis. # Optional. The desired voice of the synthesized audio.
+        "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. For the list of available voices, please refer to [Supported voices and languages](https://cloud.google.com/text-to-speech/docs/voices).
+        "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.
+      },
+      "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.
+    },
+  },
+  "queryResult": { # Represents the result of a conversational query. # The result of the conversational query.
+    "advancedSettings": { # Hierarchical advanced settings for agent/flow/page/fulfillment/parameter. Settings exposed at lower level overrides the settings exposed at higher level. Overriding occurs at the sub-setting level. For example, the playback_interruption_settings at fulfillment level only overrides the playback_interruption_settings at the agent level, leaving other settings at the agent level unchanged. DTMF settings does not override each other. DTMF settings set at different levels define DTMF detections running in parallel. Hierarchy: Agent->Flow->Page->Fulfillment/Parameter. # Returns the current advanced settings including IVR settings. Even though the operations configured by these settings are performed by Dialogflow, the client may need to perform special logic at the moment. For example, if Dialogflow exports audio to Google Cloud Storage, then the client may need to wait for the resulting object to appear in the bucket before proceeding.
+      "audioExportGcsDestination": { # Google Cloud Storage location for a Dialogflow operation that writes or exports objects (e.g. exported agent or transcripts) outside of Dialogflow. # If present, incoming audio is exported by Dialogflow to the configured Google Cloud Storage destination. Exposed at the following levels: - Agent level - Flow level
+        "uri": "A String", # Required. The Google Cloud Storage URI for the exported objects. A URI is of the form: `gs://bucket/object-name-or-prefix` Whether a full object name, or just a prefix, its usage depends on the Dialogflow operation.
+      },
+      "dtmfSettings": { # Define behaviors for DTMF (dual tone multi frequency). # Settings for DTMF. Exposed at the following levels: - Agent level - Flow level - Page level - Parameter level.
+        "enabled": True or False, # If true, incoming audio is processed for DTMF (dual tone multi frequency) events. For example, if the caller presses a button on their telephone keypad and DTMF processing is enabled, Dialogflow will detect the event (e.g. a "3" was pressed) in the incoming audio and pass the event to the bot to drive business logic (e.g. when 3 is pressed, return the account balance).
+        "endpointingTimeoutDuration": "A String", # Endpoint timeout setting for matching dtmf input to regex.
+        "finishDigit": "A String", # The digit that terminates a DTMF digit sequence.
+        "interdigitTimeoutDuration": "A String", # Interdigit timeout setting for matching dtmf input to regex.
+        "maxDigits": 42, # Max length of DTMF digits.
+      },
+      "loggingSettings": { # Define behaviors on logging. # Settings for logging. Settings for Dialogflow History, Contact Center messages, StackDriver logs, and speech logging. Exposed at the following levels: - Agent level.
+        "enableInteractionLogging": True or False, # Enables DF Interaction logging.
+        "enableStackdriverLogging": True or False, # Enables StackDriver logging.
+      },
+      "speechSettings": { # Define behaviors of speech to text detection. # Settings for speech to text detection. Exposed at the following levels: - Agent level - Flow level - Page level - Parameter level
+        "endpointerSensitivity": 42, # Sensitivity of the speech model that detects the end of speech. Scale from 0 to 100.
+        "models": { # Mapping from language to Speech-to-Text model. The mapped Speech-to-Text model will be selected for requests from its corresponding language. For more information, see [Speech models](https://cloud.google.com/dialogflow/cx/docs/concept/speech-models).
+          "a_key": "A String",
+        },
+        "noSpeechTimeout": "A String", # Timeout before detecting no speech.
+        "useTimeoutBasedEndpointing": True or False, # Use timeout based endpointing, interpreting endpointer sensitivy as seconds of timeout value.
+      },
+    },
+    "allowAnswerFeedback": True or False, # Indicates whether the Thumbs up/Thumbs down rating controls are need to be shown for the response in the Dialogflow Messenger widget.
+    "currentFlow": { # Flows represents the conversation flows when you build your chatbot agent. A flow consists of many pages connected by the transition routes. Conversations always start with the built-in Start Flow (with an all-0 ID). Transition routes can direct the conversation session from the current flow (parent flow) to another flow (sub flow). When the sub flow is finished, Dialogflow will bring the session back to the parent flow, where the sub flow is started. Usually, when a transition route is followed by a matched intent, the intent will be "consumed". This means the intent won't activate more transition routes. However, when the followed transition route moves the conversation session into a different flow, the matched intent can be carried over and to be consumed in the target flow. # The current Flow. Some, not all fields are filled in this message, including but not limited to `name` and `display_name`.
+      "advancedSettings": { # Hierarchical advanced settings for agent/flow/page/fulfillment/parameter. Settings exposed at lower level overrides the settings exposed at higher level. Overriding occurs at the sub-setting level. For example, the playback_interruption_settings at fulfillment level only overrides the playback_interruption_settings at the agent level, leaving other settings at the agent level unchanged. DTMF settings does not override each other. DTMF settings set at different levels define DTMF detections running in parallel. Hierarchy: Agent->Flow->Page->Fulfillment/Parameter. # Hierarchical advanced settings for this flow. The settings exposed at the lower level overrides the settings exposed at the higher level.
+        "audioExportGcsDestination": { # Google Cloud Storage location for a Dialogflow operation that writes or exports objects (e.g. exported agent or transcripts) outside of Dialogflow. # If present, incoming audio is exported by Dialogflow to the configured Google Cloud Storage destination. Exposed at the following levels: - Agent level - Flow level
+          "uri": "A String", # Required. The Google Cloud Storage URI for the exported objects. A URI is of the form: `gs://bucket/object-name-or-prefix` Whether a full object name, or just a prefix, its usage depends on the Dialogflow operation.
+        },
+        "dtmfSettings": { # Define behaviors for DTMF (dual tone multi frequency). # Settings for DTMF. Exposed at the following levels: - Agent level - Flow level - Page level - Parameter level.
+          "enabled": True or False, # If true, incoming audio is processed for DTMF (dual tone multi frequency) events. For example, if the caller presses a button on their telephone keypad and DTMF processing is enabled, Dialogflow will detect the event (e.g. a "3" was pressed) in the incoming audio and pass the event to the bot to drive business logic (e.g. when 3 is pressed, return the account balance).
+          "endpointingTimeoutDuration": "A String", # Endpoint timeout setting for matching dtmf input to regex.
+          "finishDigit": "A String", # The digit that terminates a DTMF digit sequence.
+          "interdigitTimeoutDuration": "A String", # Interdigit timeout setting for matching dtmf input to regex.
+          "maxDigits": 42, # Max length of DTMF digits.
+        },
+        "loggingSettings": { # Define behaviors on logging. # Settings for logging. Settings for Dialogflow History, Contact Center messages, StackDriver logs, and speech logging. Exposed at the following levels: - Agent level.
+          "enableInteractionLogging": True or False, # Enables DF Interaction logging.
+          "enableStackdriverLogging": True or False, # Enables StackDriver logging.
+        },
+        "speechSettings": { # Define behaviors of speech to text detection. # Settings for speech to text detection. Exposed at the following levels: - Agent level - Flow level - Page level - Parameter level
+          "endpointerSensitivity": 42, # Sensitivity of the speech model that detects the end of speech. Scale from 0 to 100.
+          "models": { # Mapping from language to Speech-to-Text model. The mapped Speech-to-Text model will be selected for requests from its corresponding language. For more information, see [Speech models](https://cloud.google.com/dialogflow/cx/docs/concept/speech-models).
+            "a_key": "A String",
           },
+          "noSpeechTimeout": "A String", # Timeout before detecting no speech.
+          "useTimeoutBasedEndpointing": True or False, # Use timeout based endpointing, interpreting endpointer sensitivy as seconds of timeout value.
         },
-        "conditionalCases": [ # Conditional cases for this fulfillment.
-          { # A list of cascading if-else conditions. Cases are mutually exclusive. The first one with a matching condition is selected, all the rest ignored.
-            "cases": [ # A list of cascading if-else conditions.
-              { # Each case has a Boolean condition. When it is evaluated to be True, the corresponding messages will be selected and evaluated recursively.
-                "caseContent": [ # A list of case content.
-                  { # The list of messages or conditional cases to activate for this case.
-                    "additionalCases": # Object with schema name: GoogleCloudDialogflowCxV3beta1FulfillmentConditionalCases # Additional cases to be evaluated.
-                    "message": { # 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. # Returned message.
-                      "channel": "A String", # The channel which the response is associated with. Clients can specify the channel via QueryParameters.channel, and only associated channel response will be returned.
-                      "conversationSuccess": { # 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. # Indicates that the conversation succeeded.
-                        "metadata": { # Custom metadata. Dialogflow doesn't impose any structure on this.
-                          "a_key": "", # Properties of the object.
-                        },
-                      },
-                      "endInteraction": { # 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. # Output only. A signal that indicates the interaction with the Dialogflow agent has ended. This message is generated by Dialogflow only when the conversation reaches `END_SESSION` page. It is not supposed to be defined by the user. It's guaranteed that there is at most one such message in each response.
-                      },
-                      "knowledgeInfoCard": { # Represents info card response. If the response contains generative knowledge prediction, Dialogflow will return a payload with Infobot Messenger compatible info card. Otherwise, the info card response is skipped. # Represents info card for knowledge answers, to be better rendered in Dialogflow Messenger.
-                      },
-                      "liveAgentHandoff": { # 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. # Hands off conversation to a human agent.
-                        "metadata": { # Custom metadata for your handoff procedure. Dialogflow doesn't impose any structure on this.
-                          "a_key": "", # Properties of the object.
-                        },
-                      },
-                      "mixedAudio": { # 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. # Output only. An audio response message composed of both the synthesized Dialogflow agent responses and responses defined via play_audio. This message is generated by Dialogflow only and not supposed to be defined by the user.
-                        "segments": [ # Segments this audio response is composed of.
-                          { # Represents one segment of audio.
-                            "allowPlaybackInterruption": True or False, # 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.
-                            "audio": "A String", # Raw audio synthesized from the Dialogflow agent's response using the output config specified in the request.
-                            "uri": "A String", # Client-specific URI that points to an audio clip accessible to the client. Dialogflow does not impose any validation on it.
+      },
+      "description": "A String", # The description of the flow. The maximum length is 500 characters. If exceeded, the request is rejected.
+      "displayName": "A String", # Required. The human-readable name of the flow.
+      "eventHandlers": [ # A flow's event handlers serve two purposes: * They are responsible for handling events (e.g. no match, webhook errors) in the flow. * They are inherited by every page's event handlers, which can be used to handle common events regardless of the current page. Event handlers defined in the page have higher priority than those defined in the flow. Unlike transition_routes, these handlers are evaluated on a first-match basis. The first one that matches the event get executed, with the rest being ignored.
+        { # An event handler specifies an event that can be handled during a session. When the specified event happens, the following actions are taken in order: * If there is a `trigger_fulfillment` associated with the event, it will be called. * If there is a `target_page` associated with the event, the session will transition into the specified page. * If there is a `target_flow` associated with the event, the session will transition into the specified flow.
+          "event": "A String", # Required. The name of the event to handle.
+          "name": "A String", # Output only. The unique identifier of this event handler.
+          "targetFlow": "A String", # The target flow to transition to. Format: `projects//locations//agents//flows/`.
+          "targetPage": "A String", # The target page to transition to. Format: `projects//locations//agents//flows//pages/`.
+          "triggerFulfillment": { # A fulfillment can do one or more of the following actions at the same time: * Generate rich message responses. * Set parameter values. * Call the webhook. Fulfillments can be called at various stages in the Page or Form lifecycle. For example, when a DetectIntentRequest drives a session to enter a new page, the page's entry fulfillment can add a static response to the QueryResult in the returning DetectIntentResponse, call the webhook (for example, to load user data from a database), or both. # The fulfillment to call when the event occurs. Handling webhook errors with a fulfillment enabled with webhook could cause infinite loop. It is invalid to specify such fulfillment for a handler handling webhooks.
+            "advancedSettings": { # Hierarchical advanced settings for agent/flow/page/fulfillment/parameter. Settings exposed at lower level overrides the settings exposed at higher level. Overriding occurs at the sub-setting level. For example, the playback_interruption_settings at fulfillment level only overrides the playback_interruption_settings at the agent level, leaving other settings at the agent level unchanged. DTMF settings does not override each other. DTMF settings set at different levels define DTMF detections running in parallel. Hierarchy: Agent->Flow->Page->Fulfillment/Parameter. # Hierarchical advanced settings for this fulfillment. The settings exposed at the lower level overrides the settings exposed at the higher level.
+              "audioExportGcsDestination": { # Google Cloud Storage location for a Dialogflow operation that writes or exports objects (e.g. exported agent or transcripts) outside of Dialogflow. # If present, incoming audio is exported by Dialogflow to the configured Google Cloud Storage destination. Exposed at the following levels: - Agent level - Flow level
+                "uri": "A String", # Required. The Google Cloud Storage URI for the exported objects. A URI is of the form: `gs://bucket/object-name-or-prefix` Whether a full object name, or just a prefix, its usage depends on the Dialogflow operation.
+              },
+              "dtmfSettings": { # Define behaviors for DTMF (dual tone multi frequency). # Settings for DTMF. Exposed at the following levels: - Agent level - Flow level - Page level - Parameter level.
+                "enabled": True or False, # If true, incoming audio is processed for DTMF (dual tone multi frequency) events. For example, if the caller presses a button on their telephone keypad and DTMF processing is enabled, Dialogflow will detect the event (e.g. a "3" was pressed) in the incoming audio and pass the event to the bot to drive business logic (e.g. when 3 is pressed, return the account balance).
+                "endpointingTimeoutDuration": "A String", # Endpoint timeout setting for matching dtmf input to regex.
+                "finishDigit": "A String", # The digit that terminates a DTMF digit sequence.
+                "interdigitTimeoutDuration": "A String", # Interdigit timeout setting for matching dtmf input to regex.
+                "maxDigits": 42, # Max length of DTMF digits.
+              },
+              "loggingSettings": { # Define behaviors on logging. # Settings for logging. Settings for Dialogflow History, Contact Center messages, StackDriver logs, and speech logging. Exposed at the following levels: - Agent level.
+                "enableInteractionLogging": True or False, # Enables DF Interaction logging.
+                "enableStackdriverLogging": True or False, # Enables StackDriver logging.
+              },
+              "speechSettings": { # Define behaviors of speech to text detection. # Settings for speech to text detection. Exposed at the following levels: - Agent level - Flow level - Page level - Parameter level
+                "endpointerSensitivity": 42, # Sensitivity of the speech model that detects the end of speech. Scale from 0 to 100.
+                "models": { # Mapping from language to Speech-to-Text model. The mapped Speech-to-Text model will be selected for requests from its corresponding language. For more information, see [Speech models](https://cloud.google.com/dialogflow/cx/docs/concept/speech-models).
+                  "a_key": "A String",
+                },
+                "noSpeechTimeout": "A String", # Timeout before detecting no speech.
+                "useTimeoutBasedEndpointing": True or False, # Use timeout based endpointing, interpreting endpointer sensitivy as seconds of timeout value.
+              },
+            },
+            "conditionalCases": [ # Conditional cases for this fulfillment.
+              { # A list of cascading if-else conditions. Cases are mutually exclusive. The first one with a matching condition is selected, all the rest ignored.
+                "cases": [ # A list of cascading if-else conditions.
+                  { # Each case has a Boolean condition. When it is evaluated to be True, the corresponding messages will be selected and evaluated recursively.
+                    "caseContent": [ # A list of case content.
+                      { # The list of messages or conditional cases to activate for this case.
+                        "additionalCases": # Object with schema name: GoogleCloudDialogflowCxV3beta1FulfillmentConditionalCases # Additional cases to be evaluated.
+                        "message": { # 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. # Returned message.
+                          "channel": "A String", # The channel which the response is associated with. Clients can specify the channel via QueryParameters.channel, and only associated channel response will be returned.
+                          "conversationSuccess": { # 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. # Indicates that the conversation succeeded.
+                            "metadata": { # Custom metadata. Dialogflow doesn't impose any structure on this.
+                              "a_key": "", # Properties of the object.
+                            },
                           },
-                        ],
-                      },
-                      "outputAudioText": { # A text or ssml response that is preferentially used for TTS output audio synthesis, as described in the comment on the ResponseMessage message. # A text or ssml response that is preferentially used for TTS output audio synthesis, as described in the comment on the ResponseMessage message.
-                        "allowPlaybackInterruption": True or False, # 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.
-                        "ssml": "A String", # The SSML text to be synthesized. For more information, see [SSML](/speech/text-to-speech/docs/ssml).
-                        "text": "A String", # The raw text to be synthesized.
-                      },
-                      "payload": { # Returns a response containing a custom, platform-specific payload.
-                        "a_key": "", # Properties of the object.
-                      },
-                      "playAudio": { # Specifies an audio clip to be played by the client as part of the response. # Signal that the client should play an audio clip hosted at a client-specific URI. Dialogflow uses this to construct mixed_audio. However, Dialogflow itself does not try to read or process the URI in any way.
-                        "allowPlaybackInterruption": True or False, # 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.
-                        "audioUri": "A String", # Required. URI of the audio clip. Dialogflow does not impose any validation on this value. It is specific to the client that reads it.
-                      },
-                      "telephonyTransferCall": { # Represents the signal that telles the client to transfer the phone call connected to the agent to a third-party endpoint. # A signal that the client should transfer the phone call connected to this agent to a third-party endpoint.
-                        "phoneNumber": "A String", # Transfer the call to a phone number in [E.164 format](https://en.wikipedia.org/wiki/E.164).
-                      },
-                      "text": { # The text response message. # Returns a text response.
-                        "allowPlaybackInterruption": True or False, # 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.
-                        "text": [ # Required. A collection of text responses.
-                          "A String",
-                        ],
+                          "endInteraction": { # 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. # Output only. A signal that indicates the interaction with the Dialogflow agent has ended. This message is generated by Dialogflow only when the conversation reaches `END_SESSION` page. It is not supposed to be defined by the user. It's guaranteed that there is at most one such message in each response.
+                          },
+                          "knowledgeInfoCard": { # Represents info card response. If the response contains generative knowledge prediction, Dialogflow will return a payload with Infobot Messenger compatible info card. Otherwise, the info card response is skipped. # Represents info card for knowledge answers, to be better rendered in Dialogflow Messenger.
+                          },
+                          "liveAgentHandoff": { # 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. # Hands off conversation to a human agent.
+                            "metadata": { # Custom metadata for your handoff procedure. Dialogflow doesn't impose any structure on this.
+                              "a_key": "", # Properties of the object.
+                            },
+                          },
+                          "mixedAudio": { # 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. # Output only. An audio response message composed of both the synthesized Dialogflow agent responses and responses defined via play_audio. This message is generated by Dialogflow only and not supposed to be defined by the user.
+                            "segments": [ # Segments this audio response is composed of.
+                              { # Represents one segment of audio.
+                                "allowPlaybackInterruption": True or False, # 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.
+                                "audio": "A String", # Raw audio synthesized from the Dialogflow agent's response using the output config specified in the request.
+                                "uri": "A String", # Client-specific URI that points to an audio clip accessible to the client. Dialogflow does not impose any validation on it.
+                              },
+                            ],
+                          },
+                          "outputAudioText": { # A text or ssml response that is preferentially used for TTS output audio synthesis, as described in the comment on the ResponseMessage message. # A text or ssml response that is preferentially used for TTS output audio synthesis, as described in the comment on the ResponseMessage message.
+                            "allowPlaybackInterruption": True or False, # 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.
+                            "ssml": "A String", # The SSML text to be synthesized. For more information, see [SSML](/speech/text-to-speech/docs/ssml).
+                            "text": "A String", # The raw text to be synthesized.
+                          },
+                          "payload": { # Returns a response containing a custom, platform-specific payload.
+                            "a_key": "", # Properties of the object.
+                          },
+                          "playAudio": { # Specifies an audio clip to be played by the client as part of the response. # Signal that the client should play an audio clip hosted at a client-specific URI. Dialogflow uses this to construct mixed_audio. However, Dialogflow itself does not try to read or process the URI in any way.
+                            "allowPlaybackInterruption": True or False, # 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.
+                            "audioUri": "A String", # Required. URI of the audio clip. Dialogflow does not impose any validation on this value. It is specific to the client that reads it.
+                          },
+                          "telephonyTransferCall": { # Represents the signal that telles the client to transfer the phone call connected to the agent to a third-party endpoint. # A signal that the client should transfer the phone call connected to this agent to a third-party endpoint.
+                            "phoneNumber": "A String", # Transfer the call to a phone number in [E.164 format](https://en.wikipedia.org/wiki/E.164).
+                          },
+                          "text": { # The text response message. # Returns a text response.
+                            "allowPlaybackInterruption": True or False, # 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.
+                            "text": [ # Required. A collection of text responses.
+                              "A String",
+                            ],
+                          },
+                          "toolCall": { # Represents a call of a specific tool's action with the specified inputs. # Returns the definition of a tool call that should be executed by the client.
+                            "action": "A String", # Required. The name of the tool's action associated with this call.
+                            "inputParameters": { # Optional. The action's input parameters.
+                              "a_key": "", # Properties of the object.
+                            },
+                            "tool": "A String", # Required. The tool associated with this call. Format: `projects//locations//agents//tools/`.
+                          },
+                        },
                       },
-                    },
+                    ],
+                    "condition": "A String", # The condition to activate and select this case. Empty means the condition is always true. The condition is evaluated against form parameters or session parameters. See the [conditions reference](https://cloud.google.com/dialogflow/cx/docs/reference/condition).
                   },
                 ],
-                "condition": "A String", # The condition to activate and select this case. Empty means the condition is always true. The condition is evaluated against form parameters or session parameters. See the [conditions reference](https://cloud.google.com/dialogflow/cx/docs/reference/condition).
               },
             ],
-          },
-        ],
-        "enableGenerativeFallback": True or False, # If the flag is true, the agent will utilize LLM to generate a text response. If LLM generation fails, the defined responses in the fulfillment will be respected. This flag is only useful for fulfillments associated with no-match event handlers.
-        "messages": [ # The list of rich message responses to present to the user.
-          { # 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.
-            "channel": "A String", # The channel which the response is associated with. Clients can specify the channel via QueryParameters.channel, and only associated channel response will be returned.
-            "conversationSuccess": { # 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. # Indicates that the conversation succeeded.
-              "metadata": { # Custom metadata. Dialogflow doesn't impose any structure on this.
-                "a_key": "", # Properties of the object.
+            "enableGenerativeFallback": True or False, # If the flag is true, the agent will utilize LLM to generate a text response. If LLM generation fails, the defined responses in the fulfillment will be respected. This flag is only useful for fulfillments associated with no-match event handlers.
+            "messages": [ # The list of rich message responses to present to the user.
+              { # 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.
+                "channel": "A String", # The channel which the response is associated with. Clients can specify the channel via QueryParameters.channel, and only associated channel response will be returned.
+                "conversationSuccess": { # 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. # Indicates that the conversation succeeded.
+                  "metadata": { # Custom metadata. Dialogflow doesn't impose any structure on this.
+                    "a_key": "", # Properties of the object.
+                  },
+                },
+                "endInteraction": { # 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. # Output only. A signal that indicates the interaction with the Dialogflow agent has ended. This message is generated by Dialogflow only when the conversation reaches `END_SESSION` page. It is not supposed to be defined by the user. It's guaranteed that there is at most one such message in each response.
+                },
+                "knowledgeInfoCard": { # Represents info card response. If the response contains generative knowledge prediction, Dialogflow will return a payload with Infobot Messenger compatible info card. Otherwise, the info card response is skipped. # Represents info card for knowledge answers, to be better rendered in Dialogflow Messenger.
+                },
+                "liveAgentHandoff": { # 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. # Hands off conversation to a human agent.
+                  "metadata": { # Custom metadata for your handoff procedure. Dialogflow doesn't impose any structure on this.
+                    "a_key": "", # Properties of the object.
+                  },
+                },
+                "mixedAudio": { # 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. # Output only. An audio response message composed of both the synthesized Dialogflow agent responses and responses defined via play_audio. This message is generated by Dialogflow only and not supposed to be defined by the user.
+                  "segments": [ # Segments this audio response is composed of.
+                    { # Represents one segment of audio.
+                      "allowPlaybackInterruption": True or False, # 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.
+                      "audio": "A String", # Raw audio synthesized from the Dialogflow agent's response using the output config specified in the request.
+                      "uri": "A String", # Client-specific URI that points to an audio clip accessible to the client. Dialogflow does not impose any validation on it.
+                    },
+                  ],
+                },
+                "outputAudioText": { # A text or ssml response that is preferentially used for TTS output audio synthesis, as described in the comment on the ResponseMessage message. # A text or ssml response that is preferentially used for TTS output audio synthesis, as described in the comment on the ResponseMessage message.
+                  "allowPlaybackInterruption": True or False, # 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.
+                  "ssml": "A String", # The SSML text to be synthesized. For more information, see [SSML](/speech/text-to-speech/docs/ssml).
+                  "text": "A String", # The raw text to be synthesized.
+                },
+                "payload": { # Returns a response containing a custom, platform-specific payload.
+                  "a_key": "", # Properties of the object.
+                },
+                "playAudio": { # Specifies an audio clip to be played by the client as part of the response. # Signal that the client should play an audio clip hosted at a client-specific URI. Dialogflow uses this to construct mixed_audio. However, Dialogflow itself does not try to read or process the URI in any way.
+                  "allowPlaybackInterruption": True or False, # 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.
+                  "audioUri": "A String", # Required. URI of the audio clip. Dialogflow does not impose any validation on this value. It is specific to the client that reads it.
+                },
+                "telephonyTransferCall": { # Represents the signal that telles the client to transfer the phone call connected to the agent to a third-party endpoint. # A signal that the client should transfer the phone call connected to this agent to a third-party endpoint.
+                  "phoneNumber": "A String", # Transfer the call to a phone number in [E.164 format](https://en.wikipedia.org/wiki/E.164).
+                },
+                "text": { # The text response message. # Returns a text response.
+                  "allowPlaybackInterruption": True or False, # 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.
+                  "text": [ # Required. A collection of text responses.
+                    "A String",
+                  ],
+                },
+                "toolCall": { # Represents a call of a specific tool's action with the specified inputs. # Returns the definition of a tool call that should be executed by the client.
+                  "action": "A String", # Required. The name of the tool's action associated with this call.
+                  "inputParameters": { # Optional. The action's input parameters.
+                    "a_key": "", # Properties of the object.
+                  },
+                  "tool": "A String", # Required. The tool associated with this call. Format: `projects//locations//agents//tools/`.
+                },
               },
-            },
-            "endInteraction": { # 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. # Output only. A signal that indicates the interaction with the Dialogflow agent has ended. This message is generated by Dialogflow only when the conversation reaches `END_SESSION` page. It is not supposed to be defined by the user. It's guaranteed that there is at most one such message in each response.
-            },
-            "knowledgeInfoCard": { # Represents info card response. If the response contains generative knowledge prediction, Dialogflow will return a payload with Infobot Messenger compatible info card. Otherwise, the info card response is skipped. # Represents info card for knowledge answers, to be better rendered in Dialogflow Messenger.
-            },
-            "liveAgentHandoff": { # 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. # Hands off conversation to a human agent.
-              "metadata": { # Custom metadata for your handoff procedure. Dialogflow doesn't impose any structure on this.
-                "a_key": "", # Properties of the object.
+            ],
+            "returnPartialResponses": True or False, # Whether Dialogflow should return currently queued fulfillment response messages in streaming APIs. If a webhook is specified, it happens before Dialogflow invokes webhook. Warning: 1) This flag only affects streaming API. Responses are still queued and returned once in non-streaming API. 2) The flag can be enabled in any fulfillment but only the first 3 partial responses will be returned. You may only want to apply it to fulfillments that have slow webhooks.
+            "setParameterActions": [ # Set parameter values before executing the webhook.
+              { # Setting a parameter value.
+                "parameter": "A String", # Display name of the parameter.
+                "value": "", # The new value of the parameter. A null value clears the parameter.
               },
-            },
-            "mixedAudio": { # 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. # Output only. An audio response message composed of both the synthesized Dialogflow agent responses and responses defined via play_audio. This message is generated by Dialogflow only and not supposed to be defined by the user.
-              "segments": [ # Segments this audio response is composed of.
-                { # Represents one segment of audio.
-                  "allowPlaybackInterruption": True or False, # 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.
-                  "audio": "A String", # Raw audio synthesized from the Dialogflow agent's response using the output config specified in the request.
-                  "uri": "A String", # Client-specific URI that points to an audio clip accessible to the client. Dialogflow does not impose any validation on it.
-                },
-              ],
-            },
-            "outputAudioText": { # A text or ssml response that is preferentially used for TTS output audio synthesis, as described in the comment on the ResponseMessage message. # A text or ssml response that is preferentially used for TTS output audio synthesis, as described in the comment on the ResponseMessage message.
-              "allowPlaybackInterruption": True or False, # 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.
-              "ssml": "A String", # The SSML text to be synthesized. For more information, see [SSML](/speech/text-to-speech/docs/ssml).
-              "text": "A String", # The raw text to be synthesized.
-            },
-            "payload": { # Returns a response containing a custom, platform-specific payload.
-              "a_key": "", # Properties of the object.
-            },
-            "playAudio": { # Specifies an audio clip to be played by the client as part of the response. # Signal that the client should play an audio clip hosted at a client-specific URI. Dialogflow uses this to construct mixed_audio. However, Dialogflow itself does not try to read or process the URI in any way.
-              "allowPlaybackInterruption": True or False, # 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.
-              "audioUri": "A String", # Required. URI of the audio clip. Dialogflow does not impose any validation on this value. It is specific to the client that reads it.
-            },
-            "telephonyTransferCall": { # Represents the signal that telles the client to transfer the phone call connected to the agent to a third-party endpoint. # A signal that the client should transfer the phone call connected to this agent to a third-party endpoint.
-              "phoneNumber": "A String", # Transfer the call to a phone number in [E.164 format](https://en.wikipedia.org/wiki/E.164).
-            },
-            "text": { # The text response message. # Returns a text response.
-              "allowPlaybackInterruption": True or False, # 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.
-              "text": [ # Required. A collection of text responses.
-                "A String",
-              ],
-            },
-          },
-        ],
-        "returnPartialResponses": True or False, # Whether Dialogflow should return currently queued fulfillment response messages in streaming APIs. If a webhook is specified, it happens before Dialogflow invokes webhook. Warning: 1) This flag only affects streaming API. Responses are still queued and returned once in non-streaming API. 2) The flag can be enabled in any fulfillment but only the first 3 partial responses will be returned. You may only want to apply it to fulfillments that have slow webhooks.
-        "setParameterActions": [ # Set parameter values before executing the webhook.
-          { # Setting a parameter value.
-            "parameter": "A String", # Display name of the parameter.
-            "value": "", # The new value of the parameter. A null value clears the parameter.
+            ],
+            "tag": "A String", # The value of this field will be populated in the WebhookRequest `fulfillmentInfo.tag` field by Dialogflow when the associated webhook is called. The tag is typically used by the webhook service to identify which fulfillment is being called, but it could be used for other purposes. This field is required if `webhook` is specified.
+            "webhook": "A String", # The webhook to call. Format: `projects//locations//agents//webhooks/`.
+          },
+        },
+      ],
+      "knowledgeConnectorSettings": { # The Knowledge Connector settings for this page or flow. This includes information such as the attached Knowledge Bases, and the way to execute fulfillment. # Optional. Knowledge connector configuration.
+        "dataStoreConnections": [ # Optional. List of related data store connections.
+          { # A data store connection. It represents a data store in Discovery Engine and the type of the contents it contains.
+            "dataStore": "A String", # The full name of the referenced data store. Formats: `projects/{project}/locations/{location}/collections/{collection}/dataStores/{data_store}` `projects/{project}/locations/{location}/dataStores/{data_store}`
+            "dataStoreType": "A String", # The type of the connected data store.
           },
         ],
-        "tag": "A String", # The value of this field will be populated in the WebhookRequest `fulfillmentInfo.tag` field by Dialogflow when the associated webhook is called. The tag is typically used by the webhook service to identify which fulfillment is being called, but it could be used for other purposes. This field is required if `webhook` is specified.
-        "webhook": "A String", # The webhook to call. Format: `projects//locations//agents//webhooks/`.
-      },
-    },
-    "name": "A String", # The unique identifier of the page. Required for the Pages.UpdatePage method. Pages.CreatePage populates the name automatically. Format: `projects//locations//agents//flows//pages/`.
-    "transitionRouteGroups": [ # Ordered list of `TransitionRouteGroups` added to the page. Transition route groups must be unique within a page. If the page links both flow-level transition route groups and agent-level transition route groups, the flow-level ones will have higher priority and will be put before the agent-level ones. * If multiple transition routes within a page scope refer to the same intent, then the precedence order is: page's transition route -> page's transition route group -> flow's transition routes. * If multiple transition route groups within a page contain the same intent, then the first group in the ordered list takes precedence. Format:`projects//locations//agents//flows//transitionRouteGroups/` or `projects//locations//agents//transitionRouteGroups/` for agent-level groups.
-      "A String",
-    ],
-    "transitionRoutes": [ # A list of transitions for the transition rules of this page. They route the conversation to another page in the same flow, or another flow. When we are in a certain page, the TransitionRoutes are evalauted in the following order: * TransitionRoutes defined in the page with intent specified. * TransitionRoutes defined in the transition route groups with intent specified. * TransitionRoutes defined in flow with intent specified. * TransitionRoutes defined in the transition route groups with intent specified. * TransitionRoutes defined in the page with only condition specified. * TransitionRoutes defined in the transition route groups with only condition specified.
-      { # A transition route specifies a intent that can be matched and/or a data condition that can be evaluated during a session. When a specified transition is matched, the following actions are taken in order: * If there is a `trigger_fulfillment` associated with the transition, it will be called. * If there is a `target_page` associated with the transition, the session will transition into the specified page. * If there is a `target_flow` associated with the transition, the session will transition into the specified flow.
-        "condition": "A String", # The condition to evaluate against form parameters or session parameters. See the [conditions reference](https://cloud.google.com/dialogflow/cx/docs/reference/condition). At least one of `intent` or `condition` must be specified. When both `intent` and `condition` are specified, the transition can only happen when both are fulfilled.
-        "description": "A String", # Optional. The description of the transition route. The maximum length is 500 characters.
-        "intent": "A String", # The unique identifier of an Intent. Format: `projects//locations//agents//intents/`. Indicates that the transition can only happen when the given intent is matched. At least one of `intent` or `condition` must be specified. When both `intent` and `condition` are specified, the transition can only happen when both are fulfilled.
-        "name": "A String", # Output only. The unique identifier of this transition route.
+        "enabled": True or False, # Whether Knowledge Connector is enabled or not.
         "targetFlow": "A String", # The target flow to transition to. Format: `projects//locations//agents//flows/`.
         "targetPage": "A String", # The target page to transition to. Format: `projects//locations//agents//flows//pages/`.
-        "triggerFulfillment": { # A fulfillment can do one or more of the following actions at the same time: * Generate rich message responses. * Set parameter values. * Call the webhook. Fulfillments can be called at various stages in the Page or Form lifecycle. For example, when a DetectIntentRequest drives a session to enter a new page, the page's entry fulfillment can add a static response to the QueryResult in the returning DetectIntentResponse, call the webhook (for example, to load user data from a database), or both. # The fulfillment to call when the condition is satisfied. At least one of `trigger_fulfillment` and `target` must be specified. When both are defined, `trigger_fulfillment` is executed first.
+        "triggerFulfillment": { # A fulfillment can do one or more of the following actions at the same time: * Generate rich message responses. * Set parameter values. * Call the webhook. Fulfillments can be called at various stages in the Page or Form lifecycle. For example, when a DetectIntentRequest drives a session to enter a new page, the page's entry fulfillment can add a static response to the QueryResult in the returning DetectIntentResponse, call the webhook (for example, to load user data from a database), or both. # The fulfillment to be triggered. When the answers from the Knowledge Connector are selected by Dialogflow, you can utitlize the request scoped parameter `$request.knowledge.answers` (contains up to the 5 highest confidence answers) and `$request.knowledge.questions` (contains the corresponding questions) to construct the fulfillment.
           "advancedSettings": { # Hierarchical advanced settings for agent/flow/page/fulfillment/parameter. Settings exposed at lower level overrides the settings exposed at higher level. Overriding occurs at the sub-setting level. For example, the playback_interruption_settings at fulfillment level only overrides the playback_interruption_settings at the agent level, leaving other settings at the agent level unchanged. DTMF settings does not override each other. DTMF settings set at different levels define DTMF detections running in parallel. Hierarchy: Agent->Flow->Page->Fulfillment/Parameter. # Hierarchical advanced settings for this fulfillment. The settings exposed at the lower level overrides the settings exposed at the higher level.
             "audioExportGcsDestination": { # Google Cloud Storage location for a Dialogflow operation that writes or exports objects (e.g. exported agent or transcripts) outside of Dialogflow. # If present, incoming audio is exported by Dialogflow to the configured Google Cloud Storage destination. Exposed at the following levels: - Agent level - Flow level
               "uri": "A String", # Required. The Google Cloud Storage URI for the exported objects. A URI is of the form: `gs://bucket/object-name-or-prefix` Whether a full object name, or just a prefix, its usage depends on the Dialogflow operation.
@@ -3889,8 +6053,8 @@ 

Method Details

"maxDigits": 42, # Max length of DTMF digits. }, "loggingSettings": { # Define behaviors on logging. # Settings for logging. Settings for Dialogflow History, Contact Center messages, StackDriver logs, and speech logging. Exposed at the following levels: - Agent level. - "enableInteractionLogging": True or False, # If true, DF Interaction logging is currently enabled. - "enableStackdriverLogging": True or False, # If true, StackDriver logging is currently enabled. + "enableInteractionLogging": True or False, # Enables DF Interaction logging. + "enableStackdriverLogging": True or False, # Enables StackDriver logging. }, "speechSettings": { # Define behaviors of speech to text detection. # Settings for speech to text detection. Exposed at the following levels: - Agent level - Flow level - Page level - Parameter level "endpointerSensitivity": 42, # Sensitivity of the speech model that detects the end of speech. Scale from 0 to 100. @@ -3954,6 +6118,13 @@

Method Details

"A String", ], }, + "toolCall": { # Represents a call of a specific tool's action with the specified inputs. # Returns the definition of a tool call that should be executed by the client. + "action": "A String", # Required. The name of the tool's action associated with this call. + "inputParameters": { # Optional. The action's input parameters. + "a_key": "", # Properties of the object. + }, + "tool": "A String", # Required. The tool associated with this call. Format: `projects//locations//agents//tools/`. + }, }, }, ], @@ -4010,255 +6181,212 @@

Method Details

"A String", ], }, - }, - ], - "returnPartialResponses": True or False, # Whether Dialogflow should return currently queued fulfillment response messages in streaming APIs. If a webhook is specified, it happens before Dialogflow invokes webhook. Warning: 1) This flag only affects streaming API. Responses are still queued and returned once in non-streaming API. 2) The flag can be enabled in any fulfillment but only the first 3 partial responses will be returned. You may only want to apply it to fulfillments that have slow webhooks. - "setParameterActions": [ # Set parameter values before executing the webhook. - { # Setting a parameter value. - "parameter": "A String", # Display name of the parameter. - "value": "", # The new value of the parameter. A null value clears the parameter. - }, - ], - "tag": "A String", # The value of this field will be populated in the WebhookRequest `fulfillmentInfo.tag` field by Dialogflow when the associated webhook is called. The tag is typically used by the webhook service to identify which fulfillment is being called, but it could be used for other purposes. This field is required if `webhook` is specified. - "webhook": "A String", # The webhook to call. Format: `projects//locations//agents//webhooks/`. - }, - }, - ], - }, - "matches": [ # Match results, if more than one, ordered descendingly by the confidence we have that the particular intent matches the query. - { # Represents one match result of MatchIntent. - "confidence": 3.14, # The confidence of this match. 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. - "event": "A String", # The event that matched the query. Filled for `EVENT`, `NO_MATCH` and `NO_INPUT` match types. - "intent": { # An intent represents a user's intent to interact with a conversational agent. You can provide information for the Dialogflow API to use to match user input to an intent by adding training phrases (i.e., examples of user input) to your intent. # The Intent that matched the query. Some, not all fields are filled in this message, including but not limited to: `name` and `display_name`. Only filled for `INTENT` match type. - "description": "A String", # Human readable description for better understanding an intent like its scope, content, result etc. Maximum character limit: 140 characters. - "displayName": "A String", # Required. The human-readable name of the intent, unique within the agent. - "isFallback": True or False, # Indicates whether this is a fallback intent. Currently only default fallback intent is allowed in the agent, which is added upon agent creation. Adding training phrases to fallback intent is useful in the case of requests that are mistakenly matched, since training phrases assigned to fallback intents act as negative examples that triggers no-match event. - "labels": { # The key/value metadata to label an intent. Labels can contain lowercase letters, digits and the symbols '-' and '_'. International characters are allowed, including letters from unicase alphabets. Keys must start with a letter. Keys and values can be no longer than 63 characters and no more than 128 bytes. Prefix "sys-" is reserved for Dialogflow defined labels. Currently allowed Dialogflow defined labels include: * sys-head * sys-contextual The above labels do not require value. "sys-head" means the intent is a head intent. "sys-contextual" means the intent is a contextual intent. - "a_key": "A String", - }, - "name": "A String", # The unique identifier of the intent. Required for the Intents.UpdateIntent method. Intents.CreateIntent populates the name automatically. Format: `projects//locations//agents//intents/`. - "parameters": [ # The collection of parameters associated with the intent. - { # Represents an intent parameter. - "entityType": "A String", # Required. The entity type of the parameter. Format: `projects/-/locations/-/agents/-/entityTypes/` for system entity types (for example, `projects/-/locations/-/agents/-/entityTypes/sys.date`), or `projects//locations//agents//entityTypes/` for developer entity types. - "id": "A String", # Required. The unique identifier of the parameter. This field is used by training phrases to annotate their parts. - "isList": True or False, # Indicates whether the parameter represents a list of values. - "redact": True or False, # Indicates whether the parameter content should be redacted in log. If redaction is enabled, the parameter content will be replaced by parameter name during logging. Note: the parameter content is subject to redaction if either parameter level redaction or entity type level redaction is enabled. - }, - ], - "priority": 42, # 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. - "trainingPhrases": [ # The collection of training phrases the agent is trained on to identify the intent. - { # Represents an example that the agent is trained on to identify the intent. - "id": "A String", # Output only. The unique identifier of the training phrase. - "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 `parameter_id` field is set. - { # Represents a part of a training phrase. - "parameterId": "A String", # The parameter used to annotate this part of the training phrase. This field is required for annotated parts of the training phrase. - "text": "A String", # Required. The text for this part. - }, - ], - "repeatCount": 42, # Indicates how many times this example was added to the intent. - }, - ], - }, - "matchType": "A String", # Type of this Match. - "parameters": { # The collection of parameters extracted from the query. 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 then use map, otherwise, depending on the parameter value type, it could be one of string, number, boolean, null, list or map. * MapValue value: If parameter's entity type is a composite entity then use map from composite entity property names to property values, otherwise, use parameter value. - "a_key": "", # Properties of the object. - }, - "resolvedInput": "A String", # Final text input which was matched during MatchIntent. This value can be different from original input sent in request because of spelling correction or other processing. - }, - ], - "text": "A String", # If natural language text was provided as input, this field will contain a copy of the text. - "transcript": "A String", # If natural language speech audio was provided as input, this field will contain the transcript for the audio. - "triggerEvent": "A String", # If an event was provided as input, this field will contain a copy of the event name. - "triggerIntent": "A String", # If an intent was provided as input, this field will contain a copy of the intent identifier. Format: `projects//locations//agents//intents/`. -}
-
- -
- serverStreamingDetectIntent(session, body=None, x__xgafv=None) -
Processes a natural language query and returns structured, actionable data as a result through server-side streaming. Server-side streaming allows Dialogflow to send [partial responses](https://cloud.google.com/dialogflow/cx/docs/concept/fulfillment#partial-response) earlier in a single request.
-
-Args:
-  session: string, Required. The name of the session this query is sent to. Format: `projects//locations//agents//sessions/` or `projects//locations//agents//environments//sessions/`. If `Environment ID` is not specified, we assume default 'draft' environment. It's up to the API caller to choose an appropriate `Session ID`. It can be a random number or some type of session identifiers (preferably hashed). The length of the `Session ID` must not exceed 36 characters. For more information, see the [sessions guide](https://cloud.google.com/dialogflow/cx/docs/concept/session). Note: Always use agent versions for production traffic. See [Versions and environments](https://cloud.google.com/dialogflow/cx/docs/concept/version). (required)
-  body: object, The request body.
-    The object takes the form of:
-
-{ # The request to detect user's intent.
-  "outputAudioConfig": { # Instructs the speech synthesizer how to generate the output audio content. # Instructs the speech synthesizer how to generate the output audio.
-    "audioEncoding": "A String", # Required. Audio encoding of the synthesized audio content.
-    "sampleRateHertz": 42, # Optional. 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).
-    "synthesizeSpeechConfig": { # Configuration of how speech should be synthesized. # Optional. Configuration of how speech should be synthesized. If not specified, Agent.text_to_speech_settings is applied.
-      "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.
-        "A String",
-      ],
-      "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.
-      "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.
-      "voice": { # Description of which voice to use for speech synthesis. # Optional. The desired voice of the synthesized audio.
-        "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. For the list of available voices, please refer to [Supported voices and languages](https://cloud.google.com/text-to-speech/docs/voices).
-        "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.
-      },
-      "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.
-    },
-  },
-  "queryInput": { # Represents the query input. It can contain one of: 1. A conversational query in the form of text. 2. An intent query that specifies which intent to trigger. 3. Natural language speech audio to be processed. 4. An event to be triggered. 5. DTMF digits to invoke an intent and fill in parameter value. 6. The results of a tool executed by the client. # Required. The input specification.
-    "audio": { # Represents the natural speech audio to be processed. # The natural language speech audio to be processed.
-      "audio": "A String", # The natural language speech audio to be processed. A single request can contain up to 2 minutes of speech audio data. The transcribed text cannot contain more than 256 bytes. For non-streaming audio detect intent, both `config` and `audio` must be provided. For streaming audio detect intent, `config` must be provided in the first request and `audio` must be provided in all following requests.
-      "config": { # Instructs the speech recognizer on how to process the audio content. # Required. Instructs the speech recognizer how to process the speech audio.
-        "audioEncoding": "A String", # Required. Audio encoding of the audio content to process.
-        "bargeInConfig": { # Configuration of the barge-in behavior. Barge-in instructs the API to return a detected utterance at a proper time while the client is playing back the response audio from a previous request. When the client sees the utterance, it should stop the playback and immediately get ready for receiving the responses for the current request. The barge-in handling requires the client to start streaming audio input as soon as it starts playing back the audio from the previous response. The playback is modeled into two phases: * No barge-in phase: which goes first and during which speech detection should not be carried out. * Barge-in phase: which follows the no barge-in phase and during which the API starts speech detection and may inform the client that an utterance has been detected. Note that no-speech event is not expected in this phase. The client provides this configuration in terms of the durations of those two phases. The durations are measured in terms of the audio length from the the start of the input audio. No-speech event is a response with END_OF_UTTERANCE without any transcript following up. # Configuration of barge-in behavior during the streaming of input audio.
-          "noBargeInDuration": "A String", # Duration that is not eligible for barge-in at the beginning of the input audio.
-          "totalDuration": "A String", # Total duration for the playback at the beginning of the input audio.
-        },
-        "enableWordInfo": True or False, # Optional. If `true`, Dialogflow returns SpeechWordInfo in StreamingRecognitionResult with information about the recognized speech words, e.g. start and end time offsets. If false or unspecified, Speech doesn't return any word-level information.
-        "model": "A String", # Optional. Which Speech model to select for the given request. For more information, see [Speech models](https://cloud.google.com/dialogflow/cx/docs/concept/speech-models).
-        "modelVariant": "A String", # Optional. Which variant of the Speech model to use.
-        "optOutConformerModelMigration": True or False, # If `true`, the request will opt out for STT conformer model migration. This field will be deprecated once force migration takes place in June 2024. Please refer to [Dialogflow CX Speech model migration](https://cloud.google.com/dialogflow/cx/docs/concept/speech-model-migration).
-        "phraseHints": [ # Optional. A list of strings containing words and phrases that the speech recognizer should recognize with higher likelihood. See [the Cloud Speech documentation](https://cloud.google.com/speech-to-text/docs/basics#phrase-hints) for more details.
-          "A String",
-        ],
-        "sampleRateHertz": 42, # Sample rate (in Hertz) of the audio content sent in the query. Refer to [Cloud Speech API documentation](https://cloud.google.com/speech-to-text/docs/basics) for more details.
-        "singleUtterance": True or False, # Optional. If `false` (default), recognition does not cease until the client closes the stream. If `true`, the recognizer will detect a single spoken utterance in input audio. Recognition ceases when it detects the audio's voice has stopped or paused. In this case, once a detected intent is received, the client should close the stream and start a new request with a new stream as needed. Note: This setting is relevant only for streaming methods.
-      },
-    },
-    "dtmf": { # Represents the input for dtmf event. # The DTMF event to be handled.
-      "digits": "A String", # The dtmf digits.
-      "finishDigit": "A String", # The finish digit (if any).
-    },
-    "event": { # Represents the event to trigger. # The event to be triggered.
-      "event": "A String", # Name of the event.
-    },
-    "intent": { # Represents the intent to trigger programmatically rather than as a result of natural language processing. # The intent to be triggered.
-      "intent": "A String", # Required. The unique identifier of the intent. Format: `projects//locations//agents//intents/`.
-    },
-    "languageCode": "A String", # Required. The language of the input. See [Language Support](https://cloud.google.com/dialogflow/cx/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.
-    "text": { # Represents the natural language text to be processed. # The natural language text to be processed.
-      "text": "A String", # Required. The UTF-8 encoded natural language text to be processed.
-    },
-  },
-  "queryParams": { # Represents the parameters of a conversational query. # The parameters of this query.
-    "analyzeQueryTextSentiment": True or False, # Configures whether sentiment analysis should be performed. If not provided, sentiment analysis is not performed.
-    "channel": "A String", # The channel which this query is for. If specified, only the ResponseMessage associated with the channel will be returned. If no ResponseMessage is associated with the channel, it falls back to the ResponseMessage with unspecified channel. If unspecified, the ResponseMessage with unspecified channel will be returned.
-    "currentPage": "A String", # The unique identifier of the page to override the current page in the session. Format: `projects//locations//agents//flows//pages/`. If `current_page` is specified, the previous state of the session will be ignored by Dialogflow, including the previous page and the previous session parameters. In most cases, current_page and parameters should be configured together to direct a session to a specific state.
-    "disableWebhook": True or False, # Whether to disable webhook calls for this request.
-    "endUserMetadata": { # Optional. Information about the end-user to improve the relevance and accuracy of generative answers. This will be interpreted and used by a language model, so, for good results, the data should be self-descriptive, and in a simple structure. Example: ```json { "subscription plan": "Business Premium Plus", "devices owned": [ {"model": "Google Pixel 7"}, {"model": "Google Pixel Tablet"} ] } ```
-      "a_key": "", # Properties of the object.
-    },
-    "flowVersions": [ # A list of flow versions to override for the request. Format: `projects//locations//agents//flows//versions/`. If version 1 of flow X is included in this list, the traffic of flow X will go through version 1 regardless of the version configuration in the environment. Each flow can have at most one version specified in this list.
-      "A String",
-    ],
-    "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.
-      "latitude": 3.14, # The latitude in degrees. It must be in the range [-90.0, +90.0].
-      "longitude": 3.14, # The longitude in degrees. It must be in the range [-180.0, +180.0].
-    },
-    "parameters": { # Additional parameters to be put into session parameters. To remove a parameter from the session, clients should explicitly set the parameter value to null. You can reference the session parameters in the agent with the following format: $session.params.parameter-id. 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 then use map, otherwise, depending on the parameter value type, it could be one of string, number, boolean, null, list or map. * MapValue value: If parameter's entity type is a composite entity then use map from composite entity property names to property values, otherwise, use parameter value.
-      "a_key": "", # Properties of the object.
-    },
-    "payload": { # This field can be used to pass custom data into the webhook associated with the agent. Arbitrary JSON objects are supported. Some integrations that query a Dialogflow agent may provide additional information in the payload. In particular, for the Dialogflow Phone Gateway integration, this field has the form: ``` { "telephony": { "caller_id": "+18558363987" } } ```
-      "a_key": "", # Properties of the object.
-    },
-    "populateDataStoreConnectionSignals": True or False, # Optional. If set to true and data stores are involved in serving the request then DetectIntentResponse.query_result.data_store_connection_signals will be filled with data that can help evaluations.
-    "searchConfig": { # Search configuration for UCS search queries. # Optional. Search configuration for UCS search queries.
-      "boostSpecs": [ # Optional. Boosting configuration for the datastores.
-        { # Boost specifications for data stores.
-          "dataStores": [ # Optional. Data Stores where the boosting configuration is applied. The full names of the referenced data stores. Formats: `projects/{project}/locations/{location}/collections/{collection}/dataStores/{data_store}` `projects/{project}/locations/{location}/dataStores/{data_store}
-            "A String",
-          ],
-          "spec": [ # Optional. A list of boosting specifications.
-            { # Boost specification to boost certain documents. A copy of google.cloud.discoveryengine.v1main.BoostSpec, field documentation is available at https://cloud.google.com/generative-ai-app-builder/docs/reference/rest/v1alpha/BoostSpec
-              "conditionBoostSpecs": [ # Optional. Condition boost specifications. If a document matches multiple conditions in the specifictions, boost scores from these specifications are all applied and combined in a non-linear way. Maximum number of specifications is 20.
-                { # Boost applies to documents which match a condition.
-                  "boost": 3.14, # Optional. Strength of the condition boost, which should be in [-1, 1]. Negative boost means demotion. Default is 0.0. Setting to 1.0 gives the document a big promotion. However, it does not necessarily mean that the boosted document will be the top result at all times, nor that other documents will be excluded. Results could still be shown even when none of them matches the condition. And results that are significantly more relevant to the search query can still trump your heavily favored but irrelevant documents. Setting to -1.0 gives the document a big demotion. However, results that are deeply relevant might still be shown. The document will have an upstream battle to get a fairly high ranking, but it is not blocked out completely. Setting to 0.0 means no boost applied. The boosting condition is ignored.
-                  "condition": "A String", # Optional. An expression which specifies a boost condition. The syntax and supported fields are the same as a filter expression. Examples: * To boost documents with document ID "doc_1" or "doc_2", and color "Red" or "Blue": * (id: ANY("doc_1", "doc_2")) AND (color: ANY("Red","Blue"))
+              "toolCall": { # Represents a call of a specific tool's action with the specified inputs. # Returns the definition of a tool call that should be executed by the client.
+                "action": "A String", # Required. The name of the tool's action associated with this call.
+                "inputParameters": { # Optional. The action's input parameters.
+                  "a_key": "", # Properties of the object.
                 },
-              ],
+                "tool": "A String", # Required. The tool associated with this call. Format: `projects//locations//agents//tools/`.
+              },
             },
           ],
-        },
-      ],
-      "filterSpecs": [ # Optional. Filter configuration for the datastores.
-        { # Filter specifications for data stores.
-          "dataStores": [ # Optional. Data Stores where the boosting configuration is applied. The full names of the referenced data stores. Formats: `projects/{project}/locations/{location}/collections/{collection}/dataStores/{data_store}` `projects/{project}/locations/{location}/dataStores/{data_store}
-            "A String",
-          ],
-          "filter": "A String", # Optional. The filter expression to be applied. Expression syntax is documented at https://cloud.google.com/generative-ai-app-builder/docs/filter-search-metadata#filter-expression-syntax
-        },
-      ],
-    },
-    "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.
-      { # Session entity types are referred to as **User** entity types and are entities that are built for an individual user such as favorites, preferences, playlists, and so on. You can redefine a session entity type at the session level to extend or replace a custom entity type at the user session level (we refer to the entity types defined at the agent level as "custom entity types"). Note: session entity types apply to all queries, regardless of the language. For more information about entity types, see the [Dialogflow documentation](https://cloud.google.com/dialogflow/docs/entities-overview).
-        "entities": [ # Required. The collection of entities to override or supplement the custom entity type.
-          { # An **entity entry** for an associated entity type.
-            "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`.
-              "A String",
-            ],
-            "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 canonical 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).
-          },
-        ],
-        "entityOverrideMode": "A String", # Required. Indicates whether the additional data should override or supplement the custom entity type definition.
-        "name": "A String", # Required. The unique identifier of the session entity type. Format: `projects//locations//agents//sessions//entityTypes/` or `projects//locations//agents//environments//sessions//entityTypes/`. If `Environment ID` is not specified, we assume default 'draft' environment.
-      },
-    ],
-    "sessionTtl": "A String", # Optional. Configure lifetime of the Dialogflow session. By default, a Dialogflow session remains active and its data is stored for 30 minutes after the last request is sent for the session. This value should be no longer than 1 day.
-    "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 the agent is used.
-    "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 Dialogflow web console. The headers defined within this field will overwrite the headers configured through 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.
-      "a_key": "A String",
-    },
-  },
-  "session": "A String", # Required. The name of the session this query is sent to. Format: `projects//locations//agents//sessions/` or `projects//locations//agents//environments//sessions/`. If `Environment ID` is not specified, we assume default 'draft' environment. It's up to the API caller to choose an appropriate `Session ID`. It can be a random number or some type of session identifiers (preferably hashed). The length of the `Session ID` must not exceed 36 characters. For more information, see the [sessions guide](https://cloud.google.com/dialogflow/cx/docs/concept/session). Note: Always use agent versions for production traffic. See [Versions and environments](https://cloud.google.com/dialogflow/cx/docs/concept/version).
-}
-
-  x__xgafv: string, V1 error format.
-    Allowed values
-      1 - v1 error format
-      2 - v2 error format
-
-Returns:
-  An object of the form:
-
-    { # The message returned from the DetectIntent method.
-  "allowCancellation": True or False, # Indicates whether the partial response can be cancelled when a later response arrives. e.g. if the agent specified some music as partial response, it can be cancelled.
-  "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.response_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.
-  "outputAudioConfig": { # Instructs the speech synthesizer how to generate the output audio content. # The config used by the speech synthesizer to generate the output audio.
-    "audioEncoding": "A String", # Required. Audio encoding of the synthesized audio content.
-    "sampleRateHertz": 42, # Optional. 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).
-    "synthesizeSpeechConfig": { # Configuration of how speech should be synthesized. # Optional. Configuration of how speech should be synthesized. If not specified, Agent.text_to_speech_settings is applied.
-      "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.
-        "A String",
-      ],
-      "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.
-      "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.
-      "voice": { # Description of which voice to use for speech synthesis. # Optional. The desired voice of the synthesized audio.
-        "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. For the list of available voices, please refer to [Supported voices and languages](https://cloud.google.com/text-to-speech/docs/voices).
-        "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.
-      },
-      "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.
-    },
-  },
-  "queryResult": { # Represents the result of a conversational query. # The result of the conversational query.
-    "advancedSettings": { # Hierarchical advanced settings for agent/flow/page/fulfillment/parameter. Settings exposed at lower level overrides the settings exposed at higher level. Overriding occurs at the sub-setting level. For example, the playback_interruption_settings at fulfillment level only overrides the playback_interruption_settings at the agent level, leaving other settings at the agent level unchanged. DTMF settings does not override each other. DTMF settings set at different levels define DTMF detections running in parallel. Hierarchy: Agent->Flow->Page->Fulfillment/Parameter. # Returns the current advanced settings including IVR settings. Even though the operations configured by these settings are performed by Dialogflow, the client may need to perform special logic at the moment. For example, if Dialogflow exports audio to Google Cloud Storage, then the client may need to wait for the resulting object to appear in the bucket before proceeding.
-      "audioExportGcsDestination": { # Google Cloud Storage location for a Dialogflow operation that writes or exports objects (e.g. exported agent or transcripts) outside of Dialogflow. # If present, incoming audio is exported by Dialogflow to the configured Google Cloud Storage destination. Exposed at the following levels: - Agent level - Flow level
-        "uri": "A String", # Required. The Google Cloud Storage URI for the exported objects. A URI is of the form: `gs://bucket/object-name-or-prefix` Whether a full object name, or just a prefix, its usage depends on the Dialogflow operation.
+          "returnPartialResponses": True or False, # Whether Dialogflow should return currently queued fulfillment response messages in streaming APIs. If a webhook is specified, it happens before Dialogflow invokes webhook. Warning: 1) This flag only affects streaming API. Responses are still queued and returned once in non-streaming API. 2) The flag can be enabled in any fulfillment but only the first 3 partial responses will be returned. You may only want to apply it to fulfillments that have slow webhooks.
+          "setParameterActions": [ # Set parameter values before executing the webhook.
+            { # Setting a parameter value.
+              "parameter": "A String", # Display name of the parameter.
+              "value": "", # The new value of the parameter. A null value clears the parameter.
+            },
+          ],
+          "tag": "A String", # The value of this field will be populated in the WebhookRequest `fulfillmentInfo.tag` field by Dialogflow when the associated webhook is called. The tag is typically used by the webhook service to identify which fulfillment is being called, but it could be used for other purposes. This field is required if `webhook` is specified.
+          "webhook": "A String", # The webhook to call. Format: `projects//locations//agents//webhooks/`.
+        },
       },
-      "dtmfSettings": { # Define behaviors for DTMF (dual tone multi frequency). # Settings for DTMF. Exposed at the following levels: - Agent level - Flow level - Page level - Parameter level.
-        "enabled": True or False, # If true, incoming audio is processed for DTMF (dual tone multi frequency) events. For example, if the caller presses a button on their telephone keypad and DTMF processing is enabled, Dialogflow will detect the event (e.g. a "3" was pressed) in the incoming audio and pass the event to the bot to drive business logic (e.g. when 3 is pressed, return the account balance).
-        "endpointingTimeoutDuration": "A String", # Endpoint timeout setting for matching dtmf input to regex.
-        "finishDigit": "A String", # The digit that terminates a DTMF digit sequence.
-        "interdigitTimeoutDuration": "A String", # Interdigit timeout setting for matching dtmf input to regex.
-        "maxDigits": 42, # Max length of DTMF digits.
+      "multiLanguageSettings": { # Settings for multi-lingual agents. # Optional. Multi-lingual agent settings for this flow.
+        "enableMultiLanguageDetection": True or False, # Optional. Enable multi-language detection for this flow. This can be set only if agent level multi language setting is enabled.
+        "supportedResponseLanguageCodes": [ # Optional. Agent will respond in the detected language if the detected language code is in the supported resolved languages for this flow. This will be used only if multi-language training is enabled in the agent and multi-language detection is enabled in the flow. The supported languages must be a subset of the languages supported by the agent.
+          "A String",
+        ],
       },
-      "loggingSettings": { # Define behaviors on logging. # Settings for logging. Settings for Dialogflow History, Contact Center messages, StackDriver logs, and speech logging. Exposed at the following levels: - Agent level.
-        "enableInteractionLogging": True or False, # If true, DF Interaction logging is currently enabled.
-        "enableStackdriverLogging": True or False, # If true, StackDriver logging is currently enabled.
+      "name": "A String", # The unique identifier of the flow. Format: `projects//locations//agents//flows/`.
+      "nluSettings": { # Settings related to NLU. # NLU related settings of the flow.
+        "classificationThreshold": 3.14, # To filter out false positive results and still get variety in matched natural language inputs for your agent, you can tune the machine learning classification threshold. If the returned score value is less than the threshold value, then a no-match event will be triggered. The score values range from 0.0 (completely uncertain) to 1.0 (completely certain). If set to 0.0, the default of 0.3 is used.
+        "modelTrainingMode": "A String", # Indicates NLU model training mode.
+        "modelType": "A String", # Indicates the type of NLU model.
       },
-      "speechSettings": { # Define behaviors of speech to text detection. # Settings for speech to text detection. Exposed at the following levels: - Agent level - Flow level - Page level - Parameter level
-        "endpointerSensitivity": 42, # Sensitivity of the speech model that detects the end of speech. Scale from 0 to 100.
-        "models": { # Mapping from language to Speech-to-Text model. The mapped Speech-to-Text model will be selected for requests from its corresponding language. For more information, see [Speech models](https://cloud.google.com/dialogflow/cx/docs/concept/speech-models).
-          "a_key": "A String",
+      "transitionRouteGroups": [ # A flow's transition route group serve two purposes: * They are responsible for matching the user's first utterances in the flow. * They are inherited by every page's transition route groups. Transition route groups defined in the page have higher priority than those defined in the flow. Format:`projects//locations//agents//flows//transitionRouteGroups/` or `projects//locations//agents//transitionRouteGroups/` for agent-level groups.
+        "A String",
+      ],
+      "transitionRoutes": [ # A flow's transition routes serve two purposes: * They are responsible for matching the user's first utterances in the flow. * They are inherited by every page's transition routes and can support use cases such as the user saying "help" or "can I talk to a human?", which can be handled in a common way regardless of the current page. Transition routes defined in the page have higher priority than those defined in the flow. TransitionRoutes are evalauted in the following order: * TransitionRoutes with intent specified. * TransitionRoutes with only condition specified. TransitionRoutes with intent specified are inherited by pages in the flow.
+        { # A transition route specifies a intent that can be matched and/or a data condition that can be evaluated during a session. When a specified transition is matched, the following actions are taken in order: * If there is a `trigger_fulfillment` associated with the transition, it will be called. * If there is a `target_page` associated with the transition, the session will transition into the specified page. * If there is a `target_flow` associated with the transition, the session will transition into the specified flow.
+          "condition": "A String", # The condition to evaluate against form parameters or session parameters. See the [conditions reference](https://cloud.google.com/dialogflow/cx/docs/reference/condition). At least one of `intent` or `condition` must be specified. When both `intent` and `condition` are specified, the transition can only happen when both are fulfilled.
+          "description": "A String", # Optional. The description of the transition route. The maximum length is 500 characters.
+          "intent": "A String", # The unique identifier of an Intent. Format: `projects//locations//agents//intents/`. Indicates that the transition can only happen when the given intent is matched. At least one of `intent` or `condition` must be specified. When both `intent` and `condition` are specified, the transition can only happen when both are fulfilled.
+          "name": "A String", # Output only. The unique identifier of this transition route.
+          "targetFlow": "A String", # The target flow to transition to. Format: `projects//locations//agents//flows/`.
+          "targetPage": "A String", # The target page to transition to. Format: `projects//locations//agents//flows//pages/`.
+          "triggerFulfillment": { # A fulfillment can do one or more of the following actions at the same time: * Generate rich message responses. * Set parameter values. * Call the webhook. Fulfillments can be called at various stages in the Page or Form lifecycle. For example, when a DetectIntentRequest drives a session to enter a new page, the page's entry fulfillment can add a static response to the QueryResult in the returning DetectIntentResponse, call the webhook (for example, to load user data from a database), or both. # The fulfillment to call when the condition is satisfied. At least one of `trigger_fulfillment` and `target` must be specified. When both are defined, `trigger_fulfillment` is executed first.
+            "advancedSettings": { # Hierarchical advanced settings for agent/flow/page/fulfillment/parameter. Settings exposed at lower level overrides the settings exposed at higher level. Overriding occurs at the sub-setting level. For example, the playback_interruption_settings at fulfillment level only overrides the playback_interruption_settings at the agent level, leaving other settings at the agent level unchanged. DTMF settings does not override each other. DTMF settings set at different levels define DTMF detections running in parallel. Hierarchy: Agent->Flow->Page->Fulfillment/Parameter. # Hierarchical advanced settings for this fulfillment. The settings exposed at the lower level overrides the settings exposed at the higher level.
+              "audioExportGcsDestination": { # Google Cloud Storage location for a Dialogflow operation that writes or exports objects (e.g. exported agent or transcripts) outside of Dialogflow. # If present, incoming audio is exported by Dialogflow to the configured Google Cloud Storage destination. Exposed at the following levels: - Agent level - Flow level
+                "uri": "A String", # Required. The Google Cloud Storage URI for the exported objects. A URI is of the form: `gs://bucket/object-name-or-prefix` Whether a full object name, or just a prefix, its usage depends on the Dialogflow operation.
+              },
+              "dtmfSettings": { # Define behaviors for DTMF (dual tone multi frequency). # Settings for DTMF. Exposed at the following levels: - Agent level - Flow level - Page level - Parameter level.
+                "enabled": True or False, # If true, incoming audio is processed for DTMF (dual tone multi frequency) events. For example, if the caller presses a button on their telephone keypad and DTMF processing is enabled, Dialogflow will detect the event (e.g. a "3" was pressed) in the incoming audio and pass the event to the bot to drive business logic (e.g. when 3 is pressed, return the account balance).
+                "endpointingTimeoutDuration": "A String", # Endpoint timeout setting for matching dtmf input to regex.
+                "finishDigit": "A String", # The digit that terminates a DTMF digit sequence.
+                "interdigitTimeoutDuration": "A String", # Interdigit timeout setting for matching dtmf input to regex.
+                "maxDigits": 42, # Max length of DTMF digits.
+              },
+              "loggingSettings": { # Define behaviors on logging. # Settings for logging. Settings for Dialogflow History, Contact Center messages, StackDriver logs, and speech logging. Exposed at the following levels: - Agent level.
+                "enableInteractionLogging": True or False, # Enables DF Interaction logging.
+                "enableStackdriverLogging": True or False, # Enables StackDriver logging.
+              },
+              "speechSettings": { # Define behaviors of speech to text detection. # Settings for speech to text detection. Exposed at the following levels: - Agent level - Flow level - Page level - Parameter level
+                "endpointerSensitivity": 42, # Sensitivity of the speech model that detects the end of speech. Scale from 0 to 100.
+                "models": { # Mapping from language to Speech-to-Text model. The mapped Speech-to-Text model will be selected for requests from its corresponding language. For more information, see [Speech models](https://cloud.google.com/dialogflow/cx/docs/concept/speech-models).
+                  "a_key": "A String",
+                },
+                "noSpeechTimeout": "A String", # Timeout before detecting no speech.
+                "useTimeoutBasedEndpointing": True or False, # Use timeout based endpointing, interpreting endpointer sensitivy as seconds of timeout value.
+              },
+            },
+            "conditionalCases": [ # Conditional cases for this fulfillment.
+              { # A list of cascading if-else conditions. Cases are mutually exclusive. The first one with a matching condition is selected, all the rest ignored.
+                "cases": [ # A list of cascading if-else conditions.
+                  { # Each case has a Boolean condition. When it is evaluated to be True, the corresponding messages will be selected and evaluated recursively.
+                    "caseContent": [ # A list of case content.
+                      { # The list of messages or conditional cases to activate for this case.
+                        "additionalCases": # Object with schema name: GoogleCloudDialogflowCxV3beta1FulfillmentConditionalCases # Additional cases to be evaluated.
+                        "message": { # 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. # Returned message.
+                          "channel": "A String", # The channel which the response is associated with. Clients can specify the channel via QueryParameters.channel, and only associated channel response will be returned.
+                          "conversationSuccess": { # 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. # Indicates that the conversation succeeded.
+                            "metadata": { # Custom metadata. Dialogflow doesn't impose any structure on this.
+                              "a_key": "", # Properties of the object.
+                            },
+                          },
+                          "endInteraction": { # 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. # Output only. A signal that indicates the interaction with the Dialogflow agent has ended. This message is generated by Dialogflow only when the conversation reaches `END_SESSION` page. It is not supposed to be defined by the user. It's guaranteed that there is at most one such message in each response.
+                          },
+                          "knowledgeInfoCard": { # Represents info card response. If the response contains generative knowledge prediction, Dialogflow will return a payload with Infobot Messenger compatible info card. Otherwise, the info card response is skipped. # Represents info card for knowledge answers, to be better rendered in Dialogflow Messenger.
+                          },
+                          "liveAgentHandoff": { # 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. # Hands off conversation to a human agent.
+                            "metadata": { # Custom metadata for your handoff procedure. Dialogflow doesn't impose any structure on this.
+                              "a_key": "", # Properties of the object.
+                            },
+                          },
+                          "mixedAudio": { # 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. # Output only. An audio response message composed of both the synthesized Dialogflow agent responses and responses defined via play_audio. This message is generated by Dialogflow only and not supposed to be defined by the user.
+                            "segments": [ # Segments this audio response is composed of.
+                              { # Represents one segment of audio.
+                                "allowPlaybackInterruption": True or False, # 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.
+                                "audio": "A String", # Raw audio synthesized from the Dialogflow agent's response using the output config specified in the request.
+                                "uri": "A String", # Client-specific URI that points to an audio clip accessible to the client. Dialogflow does not impose any validation on it.
+                              },
+                            ],
+                          },
+                          "outputAudioText": { # A text or ssml response that is preferentially used for TTS output audio synthesis, as described in the comment on the ResponseMessage message. # A text or ssml response that is preferentially used for TTS output audio synthesis, as described in the comment on the ResponseMessage message.
+                            "allowPlaybackInterruption": True or False, # 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.
+                            "ssml": "A String", # The SSML text to be synthesized. For more information, see [SSML](/speech/text-to-speech/docs/ssml).
+                            "text": "A String", # The raw text to be synthesized.
+                          },
+                          "payload": { # Returns a response containing a custom, platform-specific payload.
+                            "a_key": "", # Properties of the object.
+                          },
+                          "playAudio": { # Specifies an audio clip to be played by the client as part of the response. # Signal that the client should play an audio clip hosted at a client-specific URI. Dialogflow uses this to construct mixed_audio. However, Dialogflow itself does not try to read or process the URI in any way.
+                            "allowPlaybackInterruption": True or False, # 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.
+                            "audioUri": "A String", # Required. URI of the audio clip. Dialogflow does not impose any validation on this value. It is specific to the client that reads it.
+                          },
+                          "telephonyTransferCall": { # Represents the signal that telles the client to transfer the phone call connected to the agent to a third-party endpoint. # A signal that the client should transfer the phone call connected to this agent to a third-party endpoint.
+                            "phoneNumber": "A String", # Transfer the call to a phone number in [E.164 format](https://en.wikipedia.org/wiki/E.164).
+                          },
+                          "text": { # The text response message. # Returns a text response.
+                            "allowPlaybackInterruption": True or False, # 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.
+                            "text": [ # Required. A collection of text responses.
+                              "A String",
+                            ],
+                          },
+                          "toolCall": { # Represents a call of a specific tool's action with the specified inputs. # Returns the definition of a tool call that should be executed by the client.
+                            "action": "A String", # Required. The name of the tool's action associated with this call.
+                            "inputParameters": { # Optional. The action's input parameters.
+                              "a_key": "", # Properties of the object.
+                            },
+                            "tool": "A String", # Required. The tool associated with this call. Format: `projects//locations//agents//tools/`.
+                          },
+                        },
+                      },
+                    ],
+                    "condition": "A String", # The condition to activate and select this case. Empty means the condition is always true. The condition is evaluated against form parameters or session parameters. See the [conditions reference](https://cloud.google.com/dialogflow/cx/docs/reference/condition).
+                  },
+                ],
+              },
+            ],
+            "enableGenerativeFallback": True or False, # If the flag is true, the agent will utilize LLM to generate a text response. If LLM generation fails, the defined responses in the fulfillment will be respected. This flag is only useful for fulfillments associated with no-match event handlers.
+            "messages": [ # The list of rich message responses to present to the user.
+              { # 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.
+                "channel": "A String", # The channel which the response is associated with. Clients can specify the channel via QueryParameters.channel, and only associated channel response will be returned.
+                "conversationSuccess": { # 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. # Indicates that the conversation succeeded.
+                  "metadata": { # Custom metadata. Dialogflow doesn't impose any structure on this.
+                    "a_key": "", # Properties of the object.
+                  },
+                },
+                "endInteraction": { # 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. # Output only. A signal that indicates the interaction with the Dialogflow agent has ended. This message is generated by Dialogflow only when the conversation reaches `END_SESSION` page. It is not supposed to be defined by the user. It's guaranteed that there is at most one such message in each response.
+                },
+                "knowledgeInfoCard": { # Represents info card response. If the response contains generative knowledge prediction, Dialogflow will return a payload with Infobot Messenger compatible info card. Otherwise, the info card response is skipped. # Represents info card for knowledge answers, to be better rendered in Dialogflow Messenger.
+                },
+                "liveAgentHandoff": { # 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. # Hands off conversation to a human agent.
+                  "metadata": { # Custom metadata for your handoff procedure. Dialogflow doesn't impose any structure on this.
+                    "a_key": "", # Properties of the object.
+                  },
+                },
+                "mixedAudio": { # 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. # Output only. An audio response message composed of both the synthesized Dialogflow agent responses and responses defined via play_audio. This message is generated by Dialogflow only and not supposed to be defined by the user.
+                  "segments": [ # Segments this audio response is composed of.
+                    { # Represents one segment of audio.
+                      "allowPlaybackInterruption": True or False, # 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.
+                      "audio": "A String", # Raw audio synthesized from the Dialogflow agent's response using the output config specified in the request.
+                      "uri": "A String", # Client-specific URI that points to an audio clip accessible to the client. Dialogflow does not impose any validation on it.
+                    },
+                  ],
+                },
+                "outputAudioText": { # A text or ssml response that is preferentially used for TTS output audio synthesis, as described in the comment on the ResponseMessage message. # A text or ssml response that is preferentially used for TTS output audio synthesis, as described in the comment on the ResponseMessage message.
+                  "allowPlaybackInterruption": True or False, # 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.
+                  "ssml": "A String", # The SSML text to be synthesized. For more information, see [SSML](/speech/text-to-speech/docs/ssml).
+                  "text": "A String", # The raw text to be synthesized.
+                },
+                "payload": { # Returns a response containing a custom, platform-specific payload.
+                  "a_key": "", # Properties of the object.
+                },
+                "playAudio": { # Specifies an audio clip to be played by the client as part of the response. # Signal that the client should play an audio clip hosted at a client-specific URI. Dialogflow uses this to construct mixed_audio. However, Dialogflow itself does not try to read or process the URI in any way.
+                  "allowPlaybackInterruption": True or False, # 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.
+                  "audioUri": "A String", # Required. URI of the audio clip. Dialogflow does not impose any validation on this value. It is specific to the client that reads it.
+                },
+                "telephonyTransferCall": { # Represents the signal that telles the client to transfer the phone call connected to the agent to a third-party endpoint. # A signal that the client should transfer the phone call connected to this agent to a third-party endpoint.
+                  "phoneNumber": "A String", # Transfer the call to a phone number in [E.164 format](https://en.wikipedia.org/wiki/E.164).
+                },
+                "text": { # The text response message. # Returns a text response.
+                  "allowPlaybackInterruption": True or False, # 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.
+                  "text": [ # Required. A collection of text responses.
+                    "A String",
+                  ],
+                },
+                "toolCall": { # Represents a call of a specific tool's action with the specified inputs. # Returns the definition of a tool call that should be executed by the client.
+                  "action": "A String", # Required. The name of the tool's action associated with this call.
+                  "inputParameters": { # Optional. The action's input parameters.
+                    "a_key": "", # Properties of the object.
+                  },
+                  "tool": "A String", # Required. The tool associated with this call. Format: `projects//locations//agents//tools/`.
+                },
+              },
+            ],
+            "returnPartialResponses": True or False, # Whether Dialogflow should return currently queued fulfillment response messages in streaming APIs. If a webhook is specified, it happens before Dialogflow invokes webhook. Warning: 1) This flag only affects streaming API. Responses are still queued and returned once in non-streaming API. 2) The flag can be enabled in any fulfillment but only the first 3 partial responses will be returned. You may only want to apply it to fulfillments that have slow webhooks.
+            "setParameterActions": [ # Set parameter values before executing the webhook.
+              { # Setting a parameter value.
+                "parameter": "A String", # Display name of the parameter.
+                "value": "", # The new value of the parameter. A null value clears the parameter.
+              },
+            ],
+            "tag": "A String", # The value of this field will be populated in the WebhookRequest `fulfillmentInfo.tag` field by Dialogflow when the associated webhook is called. The tag is typically used by the webhook service to identify which fulfillment is being called, but it could be used for other purposes. This field is required if `webhook` is specified.
+            "webhook": "A String", # The webhook to call. Format: `projects//locations//agents//webhooks/`.
+          },
         },
-        "noSpeechTimeout": "A String", # Timeout before detecting no speech.
-        "useTimeoutBasedEndpointing": True or False, # Use timeout based endpointing, interpreting endpointer sensitivy as seconds of timeout value.
-      },
+      ],
     },
-    "allowAnswerFeedback": True or False, # Indicates whether the Thumbs up/Thumbs down rating controls are need to be shown for the response in the Dialogflow Messenger widget.
     "currentPage": { # A Dialogflow CX conversation (session) can be described and visualized as a state machine. The states of a CX session are represented by pages. For each flow, you define many pages, where your combined pages can handle a complete conversation on the topics the flow is designed for. At any given moment, exactly one page is the current page, the current page is considered active, and the flow associated with that page is considered active. Every flow has a special start page. When a flow initially becomes active, the start page page becomes the current page. For each conversational turn, the current page will either stay the same or transition to another page. You configure each page to collect information from the end-user that is relevant for the conversational state represented by the page. For more information, see the [Page guide](https://cloud.google.com/dialogflow/cx/docs/concept/page). # The current Page. Some, not all fields are filled in this message, including but not limited to `name` and `display_name`.
       "advancedSettings": { # Hierarchical advanced settings for agent/flow/page/fulfillment/parameter. Settings exposed at lower level overrides the settings exposed at higher level. Overriding occurs at the sub-setting level. For example, the playback_interruption_settings at fulfillment level only overrides the playback_interruption_settings at the agent level, leaving other settings at the agent level unchanged. DTMF settings does not override each other. DTMF settings set at different levels define DTMF detections running in parallel. Hierarchy: Agent->Flow->Page->Fulfillment/Parameter. # Hierarchical advanced settings for this page. The settings exposed at the lower level overrides the settings exposed at the higher level.
         "audioExportGcsDestination": { # Google Cloud Storage location for a Dialogflow operation that writes or exports objects (e.g. exported agent or transcripts) outside of Dialogflow. # If present, incoming audio is exported by Dialogflow to the configured Google Cloud Storage destination. Exposed at the following levels: - Agent level - Flow level
@@ -4272,8 +6400,8 @@ 

Method Details

"maxDigits": 42, # Max length of DTMF digits. }, "loggingSettings": { # Define behaviors on logging. # Settings for logging. Settings for Dialogflow History, Contact Center messages, StackDriver logs, and speech logging. Exposed at the following levels: - Agent level. - "enableInteractionLogging": True or False, # If true, DF Interaction logging is currently enabled. - "enableStackdriverLogging": True or False, # If true, StackDriver logging is currently enabled. + "enableInteractionLogging": True or False, # Enables DF Interaction logging. + "enableStackdriverLogging": True or False, # Enables StackDriver logging. }, "speechSettings": { # Define behaviors of speech to text detection. # Settings for speech to text detection. Exposed at the following levels: - Agent level - Flow level - Page level - Parameter level "endpointerSensitivity": 42, # Sensitivity of the speech model that detects the end of speech. Scale from 0 to 100. @@ -4299,8 +6427,8 @@

Method Details

"maxDigits": 42, # Max length of DTMF digits. }, "loggingSettings": { # Define behaviors on logging. # Settings for logging. Settings for Dialogflow History, Contact Center messages, StackDriver logs, and speech logging. Exposed at the following levels: - Agent level. - "enableInteractionLogging": True or False, # If true, DF Interaction logging is currently enabled. - "enableStackdriverLogging": True or False, # If true, StackDriver logging is currently enabled. + "enableInteractionLogging": True or False, # Enables DF Interaction logging. + "enableStackdriverLogging": True or False, # Enables StackDriver logging. }, "speechSettings": { # Define behaviors of speech to text detection. # Settings for speech to text detection. Exposed at the following levels: - Agent level - Flow level - Page level - Parameter level "endpointerSensitivity": 42, # Sensitivity of the speech model that detects the end of speech. Scale from 0 to 100. @@ -4364,6 +6492,13 @@

Method Details

"A String", ], }, + "toolCall": { # Represents a call of a specific tool's action with the specified inputs. # Returns the definition of a tool call that should be executed by the client. + "action": "A String", # Required. The name of the tool's action associated with this call. + "inputParameters": { # Optional. The action's input parameters. + "a_key": "", # Properties of the object. + }, + "tool": "A String", # Required. The tool associated with this call. Format: `projects//locations//agents//tools/`. + }, }, }, ], @@ -4420,6 +6555,13 @@

Method Details

"A String", ], }, + "toolCall": { # Represents a call of a specific tool's action with the specified inputs. # Returns the definition of a tool call that should be executed by the client. + "action": "A String", # Required. The name of the tool's action associated with this call. + "inputParameters": { # Optional. The action's input parameters. + "a_key": "", # Properties of the object. + }, + "tool": "A String", # Required. The tool associated with this call. Format: `projects//locations//agents//tools/`. + }, }, ], "returnPartialResponses": True or False, # Whether Dialogflow should return currently queued fulfillment response messages in streaming APIs. If a webhook is specified, it happens before Dialogflow invokes webhook. Warning: 1) This flag only affects streaming API. Responses are still queued and returned once in non-streaming API. 2) The flag can be enabled in any fulfillment but only the first 3 partial responses will be returned. You may only want to apply it to fulfillments that have slow webhooks. @@ -4451,8 +6593,8 @@

Method Details

"maxDigits": 42, # Max length of DTMF digits. }, "loggingSettings": { # Define behaviors on logging. # Settings for logging. Settings for Dialogflow History, Contact Center messages, StackDriver logs, and speech logging. Exposed at the following levels: - Agent level. - "enableInteractionLogging": True or False, # If true, DF Interaction logging is currently enabled. - "enableStackdriverLogging": True or False, # If true, StackDriver logging is currently enabled. + "enableInteractionLogging": True or False, # Enables DF Interaction logging. + "enableStackdriverLogging": True or False, # Enables StackDriver logging. }, "speechSettings": { # Define behaviors of speech to text detection. # Settings for speech to text detection. Exposed at the following levels: - Agent level - Flow level - Page level - Parameter level "endpointerSensitivity": 42, # Sensitivity of the speech model that detects the end of speech. Scale from 0 to 100. @@ -4516,6 +6658,13 @@

Method Details

"A String", ], }, + "toolCall": { # Represents a call of a specific tool's action with the specified inputs. # Returns the definition of a tool call that should be executed by the client. + "action": "A String", # Required. The name of the tool's action associated with this call. + "inputParameters": { # Optional. The action's input parameters. + "a_key": "", # Properties of the object. + }, + "tool": "A String", # Required. The tool associated with this call. Format: `projects//locations//agents//tools/`. + }, }, }, ], @@ -4572,6 +6721,13 @@

Method Details

"A String", ], }, + "toolCall": { # Represents a call of a specific tool's action with the specified inputs. # Returns the definition of a tool call that should be executed by the client. + "action": "A String", # Required. The name of the tool's action associated with this call. + "inputParameters": { # Optional. The action's input parameters. + "a_key": "", # Properties of the object. + }, + "tool": "A String", # Required. The tool associated with this call. Format: `projects//locations//agents//tools/`. + }, }, ], "returnPartialResponses": True or False, # Whether Dialogflow should return currently queued fulfillment response messages in streaming APIs. If a webhook is specified, it happens before Dialogflow invokes webhook. Warning: 1) This flag only affects streaming API. Responses are still queued and returned once in non-streaming API. 2) The flag can be enabled in any fulfillment but only the first 3 partial responses will be returned. You may only want to apply it to fulfillments that have slow webhooks. @@ -4601,8 +6757,8 @@

Method Details

"maxDigits": 42, # Max length of DTMF digits. }, "loggingSettings": { # Define behaviors on logging. # Settings for logging. Settings for Dialogflow History, Contact Center messages, StackDriver logs, and speech logging. Exposed at the following levels: - Agent level. - "enableInteractionLogging": True or False, # If true, DF Interaction logging is currently enabled. - "enableStackdriverLogging": True or False, # If true, StackDriver logging is currently enabled. + "enableInteractionLogging": True or False, # Enables DF Interaction logging. + "enableStackdriverLogging": True or False, # Enables StackDriver logging. }, "speechSettings": { # Define behaviors of speech to text detection. # Settings for speech to text detection. Exposed at the following levels: - Agent level - Flow level - Page level - Parameter level "endpointerSensitivity": 42, # Sensitivity of the speech model that detects the end of speech. Scale from 0 to 100. @@ -4630,8 +6786,8 @@

Method Details

"maxDigits": 42, # Max length of DTMF digits. }, "loggingSettings": { # Define behaviors on logging. # Settings for logging. Settings for Dialogflow History, Contact Center messages, StackDriver logs, and speech logging. Exposed at the following levels: - Agent level. - "enableInteractionLogging": True or False, # If true, DF Interaction logging is currently enabled. - "enableStackdriverLogging": True or False, # If true, StackDriver logging is currently enabled. + "enableInteractionLogging": True or False, # Enables DF Interaction logging. + "enableStackdriverLogging": True or False, # Enables StackDriver logging. }, "speechSettings": { # Define behaviors of speech to text detection. # Settings for speech to text detection. Exposed at the following levels: - Agent level - Flow level - Page level - Parameter level "endpointerSensitivity": 42, # Sensitivity of the speech model that detects the end of speech. Scale from 0 to 100. @@ -4695,6 +6851,13 @@

Method Details

"A String", ], }, + "toolCall": { # Represents a call of a specific tool's action with the specified inputs. # Returns the definition of a tool call that should be executed by the client. + "action": "A String", # Required. The name of the tool's action associated with this call. + "inputParameters": { # Optional. The action's input parameters. + "a_key": "", # Properties of the object. + }, + "tool": "A String", # Required. The tool associated with this call. Format: `projects//locations//agents//tools/`. + }, }, }, ], @@ -4751,6 +6914,13 @@

Method Details

"A String", ], }, + "toolCall": { # Represents a call of a specific tool's action with the specified inputs. # Returns the definition of a tool call that should be executed by the client. + "action": "A String", # Required. The name of the tool's action associated with this call. + "inputParameters": { # Optional. The action's input parameters. + "a_key": "", # Properties of the object. + }, + "tool": "A String", # Required. The tool associated with this call. Format: `projects//locations//agents//tools/`. + }, }, ], "returnPartialResponses": True or False, # Whether Dialogflow should return currently queued fulfillment response messages in streaming APIs. If a webhook is specified, it happens before Dialogflow invokes webhook. Warning: 1) This flag only affects streaming API. Responses are still queued and returned once in non-streaming API. 2) The flag can be enabled in any fulfillment but only the first 3 partial responses will be returned. You may only want to apply it to fulfillments that have slow webhooks. @@ -4782,8 +6952,8 @@

Method Details

"maxDigits": 42, # Max length of DTMF digits. }, "loggingSettings": { # Define behaviors on logging. # Settings for logging. Settings for Dialogflow History, Contact Center messages, StackDriver logs, and speech logging. Exposed at the following levels: - Agent level. - "enableInteractionLogging": True or False, # If true, DF Interaction logging is currently enabled. - "enableStackdriverLogging": True or False, # If true, StackDriver logging is currently enabled. + "enableInteractionLogging": True or False, # Enables DF Interaction logging. + "enableStackdriverLogging": True or False, # Enables StackDriver logging. }, "speechSettings": { # Define behaviors of speech to text detection. # Settings for speech to text detection. Exposed at the following levels: - Agent level - Flow level - Page level - Parameter level "endpointerSensitivity": 42, # Sensitivity of the speech model that detects the end of speech. Scale from 0 to 100. @@ -4847,6 +7017,13 @@

Method Details

"A String", ], }, + "toolCall": { # Represents a call of a specific tool's action with the specified inputs. # Returns the definition of a tool call that should be executed by the client. + "action": "A String", # Required. The name of the tool's action associated with this call. + "inputParameters": { # Optional. The action's input parameters. + "a_key": "", # Properties of the object. + }, + "tool": "A String", # Required. The tool associated with this call. Format: `projects//locations//agents//tools/`. + }, }, }, ], @@ -4903,6 +7080,13 @@

Method Details

"A String", ], }, + "toolCall": { # Represents a call of a specific tool's action with the specified inputs. # Returns the definition of a tool call that should be executed by the client. + "action": "A String", # Required. The name of the tool's action associated with this call. + "inputParameters": { # Optional. The action's input parameters. + "a_key": "", # Properties of the object. + }, + "tool": "A String", # Required. The tool associated with this call. Format: `projects//locations//agents//tools/`. + }, }, ], "returnPartialResponses": True or False, # Whether Dialogflow should return currently queued fulfillment response messages in streaming APIs. If a webhook is specified, it happens before Dialogflow invokes webhook. Warning: 1) This flag only affects streaming API. Responses are still queued and returned once in non-streaming API. 2) The flag can be enabled in any fulfillment but only the first 3 partial responses will be returned. You may only want to apply it to fulfillments that have slow webhooks. @@ -4947,8 +7131,8 @@

Method Details

"maxDigits": 42, # Max length of DTMF digits. }, "loggingSettings": { # Define behaviors on logging. # Settings for logging. Settings for Dialogflow History, Contact Center messages, StackDriver logs, and speech logging. Exposed at the following levels: - Agent level. - "enableInteractionLogging": True or False, # If true, DF Interaction logging is currently enabled. - "enableStackdriverLogging": True or False, # If true, StackDriver logging is currently enabled. + "enableInteractionLogging": True or False, # Enables DF Interaction logging. + "enableStackdriverLogging": True or False, # Enables StackDriver logging. }, "speechSettings": { # Define behaviors of speech to text detection. # Settings for speech to text detection. Exposed at the following levels: - Agent level - Flow level - Page level - Parameter level "endpointerSensitivity": 42, # Sensitivity of the speech model that detects the end of speech. Scale from 0 to 100. @@ -5012,6 +7196,13 @@

Method Details

"A String", ], }, + "toolCall": { # Represents a call of a specific tool's action with the specified inputs. # Returns the definition of a tool call that should be executed by the client. + "action": "A String", # Required. The name of the tool's action associated with this call. + "inputParameters": { # Optional. The action's input parameters. + "a_key": "", # Properties of the object. + }, + "tool": "A String", # Required. The tool associated with this call. Format: `projects//locations//agents//tools/`. + }, }, }, ], @@ -5068,6 +7259,13 @@

Method Details

"A String", ], }, + "toolCall": { # Represents a call of a specific tool's action with the specified inputs. # Returns the definition of a tool call that should be executed by the client. + "action": "A String", # Required. The name of the tool's action associated with this call. + "inputParameters": { # Optional. The action's input parameters. + "a_key": "", # Properties of the object. + }, + "tool": "A String", # Required. The tool associated with this call. Format: `projects//locations//agents//tools/`. + }, }, ], "returnPartialResponses": True or False, # Whether Dialogflow should return currently queued fulfillment response messages in streaming APIs. If a webhook is specified, it happens before Dialogflow invokes webhook. Warning: 1) This flag only affects streaming API. Responses are still queued and returned once in non-streaming API. 2) The flag can be enabled in any fulfillment but only the first 3 partial responses will be returned. You may only want to apply it to fulfillments that have slow webhooks. @@ -5106,8 +7304,8 @@

Method Details

"maxDigits": 42, # Max length of DTMF digits. }, "loggingSettings": { # Define behaviors on logging. # Settings for logging. Settings for Dialogflow History, Contact Center messages, StackDriver logs, and speech logging. Exposed at the following levels: - Agent level. - "enableInteractionLogging": True or False, # If true, DF Interaction logging is currently enabled. - "enableStackdriverLogging": True or False, # If true, StackDriver logging is currently enabled. + "enableInteractionLogging": True or False, # Enables DF Interaction logging. + "enableStackdriverLogging": True or False, # Enables StackDriver logging. }, "speechSettings": { # Define behaviors of speech to text detection. # Settings for speech to text detection. Exposed at the following levels: - Agent level - Flow level - Page level - Parameter level "endpointerSensitivity": 42, # Sensitivity of the speech model that detects the end of speech. Scale from 0 to 100. @@ -5171,6 +7369,13 @@

Method Details

"A String", ], }, + "toolCall": { # Represents a call of a specific tool's action with the specified inputs. # Returns the definition of a tool call that should be executed by the client. + "action": "A String", # Required. The name of the tool's action associated with this call. + "inputParameters": { # Optional. The action's input parameters. + "a_key": "", # Properties of the object. + }, + "tool": "A String", # Required. The tool associated with this call. Format: `projects//locations//agents//tools/`. + }, }, }, ], @@ -5227,6 +7432,13 @@

Method Details

"A String", ], }, + "toolCall": { # Represents a call of a specific tool's action with the specified inputs. # Returns the definition of a tool call that should be executed by the client. + "action": "A String", # Required. The name of the tool's action associated with this call. + "inputParameters": { # Optional. The action's input parameters. + "a_key": "", # Properties of the object. + }, + "tool": "A String", # Required. The tool associated with this call. Format: `projects//locations//agents//tools/`. + }, }, ], "returnPartialResponses": True or False, # Whether Dialogflow should return currently queued fulfillment response messages in streaming APIs. If a webhook is specified, it happens before Dialogflow invokes webhook. Warning: 1) This flag only affects streaming API. Responses are still queued and returned once in non-streaming API. 2) The flag can be enabled in any fulfillment but only the first 3 partial responses will be returned. You may only want to apply it to fulfillments that have slow webhooks. @@ -5295,6 +7507,79 @@

Method Details

"digits": "A String", # The dtmf digits. "finishDigit": "A String", # The finish digit (if any). }, + "generativeInfo": { # Represents the information of a query if handled by generative agent resources. # The information of a query if handled by generative agent resources. + "actionTracingInfo": { # Example represents a sample execution of the playbook in the conversation. An example consists of a list of ordered actions performed by end user or Dialogflow agent according the playbook instructions to fulfill the task. # The actions performed by the generative playbook for the current agent response. + "actions": [ # Required. The ordered list of actions performed by the end user and the Dialogflow agent. + { # Action performed by end user or Dialogflow agent in the conversation. + "agentUtterance": { # AgentUtterance represents one message sent by the agent. # Optional. Action performed by the agent as a message. + "text": "A String", # Required. Message content in text. + }, + "flowInvocation": { # Stores metadata of the invocation of a CX flow. Next Id: 7 # Optional. Action performed on behalf of the agent by invoking a CX flow. + "flow": "A String", # Required. The unique identifier of the flow. Format: `projects//locations//agents/`. + "flowState": "A String", # Required. Flow invocation's output state. + "inputActionParameters": { # Optional. A list of input parameters for the flow. + "a_key": "", # Properties of the object. + }, + "outputActionParameters": { # Optional. A list of output parameters generated by the flow invocation. + "a_key": "", # Properties of the object. + }, + }, + "playbookInvocation": { # Stores metadata of the invocation of a child playbook. Next Id: 5 # Optional. Action performed on behalf of the agent by invoking a child playbook. + "playbook": "A String", # Required. The unique identifier of the playbook. Format: `projects//locations//agents//playbooks/`. + "playbookInput": { # Input of the playbook. # Optional. Input of the child playbook invocation. + "actionParameters": { # Optional. A list of input parameters for the action. + "a_key": "", # Properties of the object. + }, + "precedingConversationSummary": "A String", # Optional. Summary string of the preceding conversation for the child playbook invocation. + }, + "playbookOutput": { # Output of the playbook. # Optional. Output of the child playbook invocation. + "actionParameters": { # Optional. A Struct object of output parameters for the action. + "a_key": "", # Properties of the object. + }, + "executionSummary": "A String", # Optional. Summary string of the execution result of the child playbook. + }, + "playbookState": "A String", # Required. Playbook invocation's output state. + }, + "toolUse": { # Stores metadata of the invocation of an action supported by a tool. # Optional. Action performed on behalf of the agent by calling a plugin tool. + "action": "A String", # Optional. Name of the action to be called during the tool use. + "inputActionParameters": { # Optional. A list of input parameters for the action. + "a_key": "", # Properties of the object. + }, + "outputActionParameters": { # Optional. A list of output parameters generated by the action. + "a_key": "", # Properties of the object. + }, + "tool": "A String", # Required. The tool that should be used. Format: `projects//locations//agents//tools/`. + }, + "userUtterance": { # UserUtterance represents one message sent by the customer. # Optional. Agent obtained a message from the customer. + "text": "A String", # Required. Message content in text. + }, + }, + ], + "conversationState": "A String", # Required. Example's output state. + "createTime": "A String", # Output only. The timestamp of initial example creation. + "description": "A String", # Optional. The high level concise description of the example. The max number of characters is 200. + "displayName": "A String", # Required. The display name of the example. + "languageCode": "A String", # Optional. The language code of the example. If not specified, the agent's default language is used. Note: languages must be enabled in the agent before they can be used. + "name": "A String", # The unique identifier of the playbook example. Format: `projects//locations//agents//playbooks//examples/`. + "playbookInput": { # Input of the playbook. # Optional. The input to the playbook in the example. + "actionParameters": { # Optional. A list of input parameters for the action. + "a_key": "", # Properties of the object. + }, + "precedingConversationSummary": "A String", # Optional. Summary string of the preceding conversation for the child playbook invocation. + }, + "playbookOutput": { # Output of the playbook. # Optional. The output of the playbook in the example. + "actionParameters": { # Optional. A Struct object of output parameters for the action. + "a_key": "", # Properties of the object. + }, + "executionSummary": "A String", # Optional. Summary string of the execution result of the child playbook. + }, + "tokenCount": "A String", # Output only. Estimated number of tokes current example takes when sent to the LLM. + "updateTime": "A String", # Output only. Last time the example was updated. + }, + "currentPlaybooks": [ # The stack of playbooks that the conversation has currently entered, with the most recent one on the top. + "A String", + ], + }, "intent": { # An intent represents a user's intent to interact with a conversational agent. You can provide information for the Dialogflow API to use to match user input to an intent by adding training phrases (i.e., examples of user input) to your intent. # The Intent that matched the conversational query. Some, not all fields are filled in this message, including but not limited to: `name` and `display_name`. This field is deprecated, please use QueryResult.match instead. "description": "A String", # Human readable description for better understanding an intent like its scope, content, result etc. Maximum character limit: 140 characters. "displayName": "A String", # Required. The human-readable name of the intent, unique within the agent. @@ -5416,6 +7701,13 @@

Method Details

"A String", ], }, + "toolCall": { # Represents a call of a specific tool's action with the specified inputs. # Returns the definition of a tool call that should be executed by the client. + "action": "A String", # Required. The name of the tool's action associated with this call. + "inputParameters": { # Optional. The action's input parameters. + "a_key": "", # Properties of the object. + }, + "tool": "A String", # Required. The tool associated with this call. Format: `projects//locations//agents//tools/`. + }, }, ], "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. # The sentiment analyss result, which depends on `analyze_query_text_sentiment`, specified in the request. diff --git a/docs/dyn/dialogflow_v3beta1.projects.locations.agents.testCases.html b/docs/dyn/dialogflow_v3beta1.projects.locations.agents.testCases.html index 2876174c8a5..6441e5e8850 100644 --- a/docs/dyn/dialogflow_v3beta1.projects.locations.agents.testCases.html +++ b/docs/dyn/dialogflow_v3beta1.projects.locations.agents.testCases.html @@ -248,8 +248,8 @@

Method Details

"maxDigits": 42, # Max length of DTMF digits. }, "loggingSettings": { # Define behaviors on logging. # Settings for logging. Settings for Dialogflow History, Contact Center messages, StackDriver logs, and speech logging. Exposed at the following levels: - Agent level. - "enableInteractionLogging": True or False, # If true, DF Interaction logging is currently enabled. - "enableStackdriverLogging": True or False, # If true, StackDriver logging is currently enabled. + "enableInteractionLogging": True or False, # Enables DF Interaction logging. + "enableStackdriverLogging": True or False, # Enables StackDriver logging. }, "speechSettings": { # Define behaviors of speech to text detection. # Settings for speech to text detection. Exposed at the following levels: - Agent level - Flow level - Page level - Parameter level "endpointerSensitivity": 42, # Sensitivity of the speech model that detects the end of speech. Scale from 0 to 100. @@ -313,6 +313,13 @@

Method Details

"A String", ], }, + "toolCall": { # Represents a call of a specific tool's action with the specified inputs. # Returns the definition of a tool call that should be executed by the client. + "action": "A String", # Required. The name of the tool's action associated with this call. + "inputParameters": { # Optional. The action's input parameters. + "a_key": "", # Properties of the object. + }, + "tool": "A String", # Required. The tool associated with this call. Format: `projects//locations//agents//tools/`. + }, }, }, ], @@ -369,6 +376,13 @@

Method Details

"A String", ], }, + "toolCall": { # Represents a call of a specific tool's action with the specified inputs. # Returns the definition of a tool call that should be executed by the client. + "action": "A String", # Required. The name of the tool's action associated with this call. + "inputParameters": { # Optional. The action's input parameters. + "a_key": "", # Properties of the object. + }, + "tool": "A String", # Required. The tool associated with this call. Format: `projects//locations//agents//tools/`. + }, }, ], "returnPartialResponses": True or False, # Whether Dialogflow should return currently queued fulfillment response messages in streaming APIs. If a webhook is specified, it happens before Dialogflow invokes webhook. Warning: 1) This flag only affects streaming API. Responses are still queued and returned once in non-streaming API. 2) The flag can be enabled in any fulfillment but only the first 3 partial responses will be returned. You may only want to apply it to fulfillments that have slow webhooks. @@ -407,8 +421,8 @@

Method Details

"maxDigits": 42, # Max length of DTMF digits. }, "loggingSettings": { # Define behaviors on logging. # Settings for logging. Settings for Dialogflow History, Contact Center messages, StackDriver logs, and speech logging. Exposed at the following levels: - Agent level. - "enableInteractionLogging": True or False, # If true, DF Interaction logging is currently enabled. - "enableStackdriverLogging": True or False, # If true, StackDriver logging is currently enabled. + "enableInteractionLogging": True or False, # Enables DF Interaction logging. + "enableStackdriverLogging": True or False, # Enables StackDriver logging. }, "speechSettings": { # Define behaviors of speech to text detection. # Settings for speech to text detection. Exposed at the following levels: - Agent level - Flow level - Page level - Parameter level "endpointerSensitivity": 42, # Sensitivity of the speech model that detects the end of speech. Scale from 0 to 100. @@ -472,6 +486,13 @@

Method Details

"A String", ], }, + "toolCall": { # Represents a call of a specific tool's action with the specified inputs. # Returns the definition of a tool call that should be executed by the client. + "action": "A String", # Required. The name of the tool's action associated with this call. + "inputParameters": { # Optional. The action's input parameters. + "a_key": "", # Properties of the object. + }, + "tool": "A String", # Required. The tool associated with this call. Format: `projects//locations//agents//tools/`. + }, }, }, ], @@ -528,6 +549,13 @@

Method Details

"A String", ], }, + "toolCall": { # Represents a call of a specific tool's action with the specified inputs. # Returns the definition of a tool call that should be executed by the client. + "action": "A String", # Required. The name of the tool's action associated with this call. + "inputParameters": { # Optional. The action's input parameters. + "a_key": "", # Properties of the object. + }, + "tool": "A String", # Required. The tool associated with this call. Format: `projects//locations//agents//tools/`. + }, }, ], "returnPartialResponses": True or False, # Whether Dialogflow should return currently queued fulfillment response messages in streaming APIs. If a webhook is specified, it happens before Dialogflow invokes webhook. Warning: 1) This flag only affects streaming API. Responses are still queued and returned once in non-streaming API. 2) The flag can be enabled in any fulfillment but only the first 3 partial responses will be returned. You may only want to apply it to fulfillments that have slow webhooks. @@ -569,8 +597,8 @@

Method Details

"maxDigits": 42, # Max length of DTMF digits. }, "loggingSettings": { # Define behaviors on logging. # Settings for logging. Settings for Dialogflow History, Contact Center messages, StackDriver logs, and speech logging. Exposed at the following levels: - Agent level. - "enableInteractionLogging": True or False, # If true, DF Interaction logging is currently enabled. - "enableStackdriverLogging": True or False, # If true, StackDriver logging is currently enabled. + "enableInteractionLogging": True or False, # Enables DF Interaction logging. + "enableStackdriverLogging": True or False, # Enables StackDriver logging. }, "speechSettings": { # Define behaviors of speech to text detection. # Settings for speech to text detection. Exposed at the following levels: - Agent level - Flow level - Page level - Parameter level "endpointerSensitivity": 42, # Sensitivity of the speech model that detects the end of speech. Scale from 0 to 100. @@ -634,6 +662,13 @@

Method Details

"A String", ], }, + "toolCall": { # Represents a call of a specific tool's action with the specified inputs. # Returns the definition of a tool call that should be executed by the client. + "action": "A String", # Required. The name of the tool's action associated with this call. + "inputParameters": { # Optional. The action's input parameters. + "a_key": "", # Properties of the object. + }, + "tool": "A String", # Required. The tool associated with this call. Format: `projects//locations//agents//tools/`. + }, }, }, ], @@ -690,6 +725,13 @@

Method Details

"A String", ], }, + "toolCall": { # Represents a call of a specific tool's action with the specified inputs. # Returns the definition of a tool call that should be executed by the client. + "action": "A String", # Required. The name of the tool's action associated with this call. + "inputParameters": { # Optional. The action's input parameters. + "a_key": "", # Properties of the object. + }, + "tool": "A String", # Required. The tool associated with this call. Format: `projects//locations//agents//tools/`. + }, }, ], "returnPartialResponses": True or False, # Whether Dialogflow should return currently queued fulfillment response messages in streaming APIs. If a webhook is specified, it happens before Dialogflow invokes webhook. Warning: 1) This flag only affects streaming API. Responses are still queued and returned once in non-streaming API. 2) The flag can be enabled in any fulfillment but only the first 3 partial responses will be returned. You may only want to apply it to fulfillments that have slow webhooks. @@ -718,8 +760,8 @@

Method Details

"maxDigits": 42, # Max length of DTMF digits. }, "loggingSettings": { # Define behaviors on logging. # Settings for logging. Settings for Dialogflow History, Contact Center messages, StackDriver logs, and speech logging. Exposed at the following levels: - Agent level. - "enableInteractionLogging": True or False, # If true, DF Interaction logging is currently enabled. - "enableStackdriverLogging": True or False, # If true, StackDriver logging is currently enabled. + "enableInteractionLogging": True or False, # Enables DF Interaction logging. + "enableStackdriverLogging": True or False, # Enables StackDriver logging. }, "speechSettings": { # Define behaviors of speech to text detection. # Settings for speech to text detection. Exposed at the following levels: - Agent level - Flow level - Page level - Parameter level "endpointerSensitivity": 42, # Sensitivity of the speech model that detects the end of speech. Scale from 0 to 100. @@ -751,8 +793,8 @@

Method Details

"maxDigits": 42, # Max length of DTMF digits. }, "loggingSettings": { # Define behaviors on logging. # Settings for logging. Settings for Dialogflow History, Contact Center messages, StackDriver logs, and speech logging. Exposed at the following levels: - Agent level. - "enableInteractionLogging": True or False, # If true, DF Interaction logging is currently enabled. - "enableStackdriverLogging": True or False, # If true, StackDriver logging is currently enabled. + "enableInteractionLogging": True or False, # Enables DF Interaction logging. + "enableStackdriverLogging": True or False, # Enables StackDriver logging. }, "speechSettings": { # Define behaviors of speech to text detection. # Settings for speech to text detection. Exposed at the following levels: - Agent level - Flow level - Page level - Parameter level "endpointerSensitivity": 42, # Sensitivity of the speech model that detects the end of speech. Scale from 0 to 100. @@ -816,6 +858,13 @@

Method Details

"A String", ], }, + "toolCall": { # Represents a call of a specific tool's action with the specified inputs. # Returns the definition of a tool call that should be executed by the client. + "action": "A String", # Required. The name of the tool's action associated with this call. + "inputParameters": { # Optional. The action's input parameters. + "a_key": "", # Properties of the object. + }, + "tool": "A String", # Required. The tool associated with this call. Format: `projects//locations//agents//tools/`. + }, }, }, ], @@ -872,6 +921,13 @@

Method Details

"A String", ], }, + "toolCall": { # Represents a call of a specific tool's action with the specified inputs. # Returns the definition of a tool call that should be executed by the client. + "action": "A String", # Required. The name of the tool's action associated with this call. + "inputParameters": { # Optional. The action's input parameters. + "a_key": "", # Properties of the object. + }, + "tool": "A String", # Required. The tool associated with this call. Format: `projects//locations//agents//tools/`. + }, }, ], "returnPartialResponses": True or False, # Whether Dialogflow should return currently queued fulfillment response messages in streaming APIs. If a webhook is specified, it happens before Dialogflow invokes webhook. Warning: 1) This flag only affects streaming API. Responses are still queued and returned once in non-streaming API. 2) The flag can be enabled in any fulfillment but only the first 3 partial responses will be returned. You may only want to apply it to fulfillments that have slow webhooks. @@ -909,8 +965,8 @@

Method Details

"maxDigits": 42, # Max length of DTMF digits. }, "loggingSettings": { # Define behaviors on logging. # Settings for logging. Settings for Dialogflow History, Contact Center messages, StackDriver logs, and speech logging. Exposed at the following levels: - Agent level. - "enableInteractionLogging": True or False, # If true, DF Interaction logging is currently enabled. - "enableStackdriverLogging": True or False, # If true, StackDriver logging is currently enabled. + "enableInteractionLogging": True or False, # Enables DF Interaction logging. + "enableStackdriverLogging": True or False, # Enables StackDriver logging. }, "speechSettings": { # Define behaviors of speech to text detection. # Settings for speech to text detection. Exposed at the following levels: - Agent level - Flow level - Page level - Parameter level "endpointerSensitivity": 42, # Sensitivity of the speech model that detects the end of speech. Scale from 0 to 100. @@ -974,6 +1030,13 @@

Method Details

"A String", ], }, + "toolCall": { # Represents a call of a specific tool's action with the specified inputs. # Returns the definition of a tool call that should be executed by the client. + "action": "A String", # Required. The name of the tool's action associated with this call. + "inputParameters": { # Optional. The action's input parameters. + "a_key": "", # Properties of the object. + }, + "tool": "A String", # Required. The tool associated with this call. Format: `projects//locations//agents//tools/`. + }, }, }, ], @@ -1030,6 +1093,13 @@

Method Details

"A String", ], }, + "toolCall": { # Represents a call of a specific tool's action with the specified inputs. # Returns the definition of a tool call that should be executed by the client. + "action": "A String", # Required. The name of the tool's action associated with this call. + "inputParameters": { # Optional. The action's input parameters. + "a_key": "", # Properties of the object. + }, + "tool": "A String", # Required. The tool associated with this call. Format: `projects//locations//agents//tools/`. + }, }, ], "returnPartialResponses": True or False, # Whether Dialogflow should return currently queued fulfillment response messages in streaming APIs. If a webhook is specified, it happens before Dialogflow invokes webhook. Warning: 1) This flag only affects streaming API. Responses are still queued and returned once in non-streaming API. 2) The flag can be enabled in any fulfillment but only the first 3 partial responses will be returned. You may only want to apply it to fulfillments that have slow webhooks. @@ -1079,8 +1149,8 @@

Method Details

"maxDigits": 42, # Max length of DTMF digits. }, "loggingSettings": { # Define behaviors on logging. # Settings for logging. Settings for Dialogflow History, Contact Center messages, StackDriver logs, and speech logging. Exposed at the following levels: - Agent level. - "enableInteractionLogging": True or False, # If true, DF Interaction logging is currently enabled. - "enableStackdriverLogging": True or False, # If true, StackDriver logging is currently enabled. + "enableInteractionLogging": True or False, # Enables DF Interaction logging. + "enableStackdriverLogging": True or False, # Enables StackDriver logging. }, "speechSettings": { # Define behaviors of speech to text detection. # Settings for speech to text detection. Exposed at the following levels: - Agent level - Flow level - Page level - Parameter level "endpointerSensitivity": 42, # Sensitivity of the speech model that detects the end of speech. Scale from 0 to 100. @@ -1144,6 +1214,13 @@

Method Details

"A String", ], }, + "toolCall": { # Represents a call of a specific tool's action with the specified inputs. # Returns the definition of a tool call that should be executed by the client. + "action": "A String", # Required. The name of the tool's action associated with this call. + "inputParameters": { # Optional. The action's input parameters. + "a_key": "", # Properties of the object. + }, + "tool": "A String", # Required. The tool associated with this call. Format: `projects//locations//agents//tools/`. + }, }, }, ], @@ -1200,6 +1277,13 @@

Method Details

"A String", ], }, + "toolCall": { # Represents a call of a specific tool's action with the specified inputs. # Returns the definition of a tool call that should be executed by the client. + "action": "A String", # Required. The name of the tool's action associated with this call. + "inputParameters": { # Optional. The action's input parameters. + "a_key": "", # Properties of the object. + }, + "tool": "A String", # Required. The tool associated with this call. Format: `projects//locations//agents//tools/`. + }, }, ], "returnPartialResponses": True or False, # Whether Dialogflow should return currently queued fulfillment response messages in streaming APIs. If a webhook is specified, it happens before Dialogflow invokes webhook. Warning: 1) This flag only affects streaming API. Responses are still queued and returned once in non-streaming API. 2) The flag can be enabled in any fulfillment but only the first 3 partial responses will be returned. You may only want to apply it to fulfillments that have slow webhooks. @@ -1228,8 +1312,8 @@

Method Details

"maxDigits": 42, # Max length of DTMF digits. }, "loggingSettings": { # Define behaviors on logging. # Settings for logging. Settings for Dialogflow History, Contact Center messages, StackDriver logs, and speech logging. Exposed at the following levels: - Agent level. - "enableInteractionLogging": True or False, # If true, DF Interaction logging is currently enabled. - "enableStackdriverLogging": True or False, # If true, StackDriver logging is currently enabled. + "enableInteractionLogging": True or False, # Enables DF Interaction logging. + "enableStackdriverLogging": True or False, # Enables StackDriver logging. }, "speechSettings": { # Define behaviors of speech to text detection. # Settings for speech to text detection. Exposed at the following levels: - Agent level - Flow level - Page level - Parameter level "endpointerSensitivity": 42, # Sensitivity of the speech model that detects the end of speech. Scale from 0 to 100. @@ -1255,8 +1339,8 @@

Method Details

"maxDigits": 42, # Max length of DTMF digits. }, "loggingSettings": { # Define behaviors on logging. # Settings for logging. Settings for Dialogflow History, Contact Center messages, StackDriver logs, and speech logging. Exposed at the following levels: - Agent level. - "enableInteractionLogging": True or False, # If true, DF Interaction logging is currently enabled. - "enableStackdriverLogging": True or False, # If true, StackDriver logging is currently enabled. + "enableInteractionLogging": True or False, # Enables DF Interaction logging. + "enableStackdriverLogging": True or False, # Enables StackDriver logging. }, "speechSettings": { # Define behaviors of speech to text detection. # Settings for speech to text detection. Exposed at the following levels: - Agent level - Flow level - Page level - Parameter level "endpointerSensitivity": 42, # Sensitivity of the speech model that detects the end of speech. Scale from 0 to 100. @@ -1320,6 +1404,13 @@

Method Details

"A String", ], }, + "toolCall": { # Represents a call of a specific tool's action with the specified inputs. # Returns the definition of a tool call that should be executed by the client. + "action": "A String", # Required. The name of the tool's action associated with this call. + "inputParameters": { # Optional. The action's input parameters. + "a_key": "", # Properties of the object. + }, + "tool": "A String", # Required. The tool associated with this call. Format: `projects//locations//agents//tools/`. + }, }, }, ], @@ -1376,6 +1467,13 @@

Method Details

"A String", ], }, + "toolCall": { # Represents a call of a specific tool's action with the specified inputs. # Returns the definition of a tool call that should be executed by the client. + "action": "A String", # Required. The name of the tool's action associated with this call. + "inputParameters": { # Optional. The action's input parameters. + "a_key": "", # Properties of the object. + }, + "tool": "A String", # Required. The tool associated with this call. Format: `projects//locations//agents//tools/`. + }, }, ], "returnPartialResponses": True or False, # Whether Dialogflow should return currently queued fulfillment response messages in streaming APIs. If a webhook is specified, it happens before Dialogflow invokes webhook. Warning: 1) This flag only affects streaming API. Responses are still queued and returned once in non-streaming API. 2) The flag can be enabled in any fulfillment but only the first 3 partial responses will be returned. You may only want to apply it to fulfillments that have slow webhooks. @@ -1407,8 +1505,8 @@

Method Details

"maxDigits": 42, # Max length of DTMF digits. }, "loggingSettings": { # Define behaviors on logging. # Settings for logging. Settings for Dialogflow History, Contact Center messages, StackDriver logs, and speech logging. Exposed at the following levels: - Agent level. - "enableInteractionLogging": True or False, # If true, DF Interaction logging is currently enabled. - "enableStackdriverLogging": True or False, # If true, StackDriver logging is currently enabled. + "enableInteractionLogging": True or False, # Enables DF Interaction logging. + "enableStackdriverLogging": True or False, # Enables StackDriver logging. }, "speechSettings": { # Define behaviors of speech to text detection. # Settings for speech to text detection. Exposed at the following levels: - Agent level - Flow level - Page level - Parameter level "endpointerSensitivity": 42, # Sensitivity of the speech model that detects the end of speech. Scale from 0 to 100. @@ -1472,6 +1570,13 @@

Method Details

"A String", ], }, + "toolCall": { # Represents a call of a specific tool's action with the specified inputs. # Returns the definition of a tool call that should be executed by the client. + "action": "A String", # Required. The name of the tool's action associated with this call. + "inputParameters": { # Optional. The action's input parameters. + "a_key": "", # Properties of the object. + }, + "tool": "A String", # Required. The tool associated with this call. Format: `projects//locations//agents//tools/`. + }, }, }, ], @@ -1528,6 +1633,13 @@

Method Details

"A String", ], }, + "toolCall": { # Represents a call of a specific tool's action with the specified inputs. # Returns the definition of a tool call that should be executed by the client. + "action": "A String", # Required. The name of the tool's action associated with this call. + "inputParameters": { # Optional. The action's input parameters. + "a_key": "", # Properties of the object. + }, + "tool": "A String", # Required. The tool associated with this call. Format: `projects//locations//agents//tools/`. + }, }, ], "returnPartialResponses": True or False, # Whether Dialogflow should return currently queued fulfillment response messages in streaming APIs. If a webhook is specified, it happens before Dialogflow invokes webhook. Warning: 1) This flag only affects streaming API. Responses are still queued and returned once in non-streaming API. 2) The flag can be enabled in any fulfillment but only the first 3 partial responses will be returned. You may only want to apply it to fulfillments that have slow webhooks. @@ -1557,8 +1669,8 @@

Method Details

"maxDigits": 42, # Max length of DTMF digits. }, "loggingSettings": { # Define behaviors on logging. # Settings for logging. Settings for Dialogflow History, Contact Center messages, StackDriver logs, and speech logging. Exposed at the following levels: - Agent level. - "enableInteractionLogging": True or False, # If true, DF Interaction logging is currently enabled. - "enableStackdriverLogging": True or False, # If true, StackDriver logging is currently enabled. + "enableInteractionLogging": True or False, # Enables DF Interaction logging. + "enableStackdriverLogging": True or False, # Enables StackDriver logging. }, "speechSettings": { # Define behaviors of speech to text detection. # Settings for speech to text detection. Exposed at the following levels: - Agent level - Flow level - Page level - Parameter level "endpointerSensitivity": 42, # Sensitivity of the speech model that detects the end of speech. Scale from 0 to 100. @@ -1586,8 +1698,8 @@

Method Details

"maxDigits": 42, # Max length of DTMF digits. }, "loggingSettings": { # Define behaviors on logging. # Settings for logging. Settings for Dialogflow History, Contact Center messages, StackDriver logs, and speech logging. Exposed at the following levels: - Agent level. - "enableInteractionLogging": True or False, # If true, DF Interaction logging is currently enabled. - "enableStackdriverLogging": True or False, # If true, StackDriver logging is currently enabled. + "enableInteractionLogging": True or False, # Enables DF Interaction logging. + "enableStackdriverLogging": True or False, # Enables StackDriver logging. }, "speechSettings": { # Define behaviors of speech to text detection. # Settings for speech to text detection. Exposed at the following levels: - Agent level - Flow level - Page level - Parameter level "endpointerSensitivity": 42, # Sensitivity of the speech model that detects the end of speech. Scale from 0 to 100. @@ -1651,6 +1763,13 @@

Method Details

"A String", ], }, + "toolCall": { # Represents a call of a specific tool's action with the specified inputs. # Returns the definition of a tool call that should be executed by the client. + "action": "A String", # Required. The name of the tool's action associated with this call. + "inputParameters": { # Optional. The action's input parameters. + "a_key": "", # Properties of the object. + }, + "tool": "A String", # Required. The tool associated with this call. Format: `projects//locations//agents//tools/`. + }, }, }, ], @@ -1707,6 +1826,13 @@

Method Details

"A String", ], }, + "toolCall": { # Represents a call of a specific tool's action with the specified inputs. # Returns the definition of a tool call that should be executed by the client. + "action": "A String", # Required. The name of the tool's action associated with this call. + "inputParameters": { # Optional. The action's input parameters. + "a_key": "", # Properties of the object. + }, + "tool": "A String", # Required. The tool associated with this call. Format: `projects//locations//agents//tools/`. + }, }, ], "returnPartialResponses": True or False, # Whether Dialogflow should return currently queued fulfillment response messages in streaming APIs. If a webhook is specified, it happens before Dialogflow invokes webhook. Warning: 1) This flag only affects streaming API. Responses are still queued and returned once in non-streaming API. 2) The flag can be enabled in any fulfillment but only the first 3 partial responses will be returned. You may only want to apply it to fulfillments that have slow webhooks. @@ -1738,8 +1864,8 @@

Method Details

"maxDigits": 42, # Max length of DTMF digits. }, "loggingSettings": { # Define behaviors on logging. # Settings for logging. Settings for Dialogflow History, Contact Center messages, StackDriver logs, and speech logging. Exposed at the following levels: - Agent level. - "enableInteractionLogging": True or False, # If true, DF Interaction logging is currently enabled. - "enableStackdriverLogging": True or False, # If true, StackDriver logging is currently enabled. + "enableInteractionLogging": True or False, # Enables DF Interaction logging. + "enableStackdriverLogging": True or False, # Enables StackDriver logging. }, "speechSettings": { # Define behaviors of speech to text detection. # Settings for speech to text detection. Exposed at the following levels: - Agent level - Flow level - Page level - Parameter level "endpointerSensitivity": 42, # Sensitivity of the speech model that detects the end of speech. Scale from 0 to 100. @@ -1803,6 +1929,13 @@

Method Details

"A String", ], }, + "toolCall": { # Represents a call of a specific tool's action with the specified inputs. # Returns the definition of a tool call that should be executed by the client. + "action": "A String", # Required. The name of the tool's action associated with this call. + "inputParameters": { # Optional. The action's input parameters. + "a_key": "", # Properties of the object. + }, + "tool": "A String", # Required. The tool associated with this call. Format: `projects//locations//agents//tools/`. + }, }, }, ], @@ -1859,6 +1992,13 @@

Method Details

"A String", ], }, + "toolCall": { # Represents a call of a specific tool's action with the specified inputs. # Returns the definition of a tool call that should be executed by the client. + "action": "A String", # Required. The name of the tool's action associated with this call. + "inputParameters": { # Optional. The action's input parameters. + "a_key": "", # Properties of the object. + }, + "tool": "A String", # Required. The tool associated with this call. Format: `projects//locations//agents//tools/`. + }, }, ], "returnPartialResponses": True or False, # Whether Dialogflow should return currently queued fulfillment response messages in streaming APIs. If a webhook is specified, it happens before Dialogflow invokes webhook. Warning: 1) This flag only affects streaming API. Responses are still queued and returned once in non-streaming API. 2) The flag can be enabled in any fulfillment but only the first 3 partial responses will be returned. You may only want to apply it to fulfillments that have slow webhooks. @@ -1903,8 +2043,8 @@

Method Details

"maxDigits": 42, # Max length of DTMF digits. }, "loggingSettings": { # Define behaviors on logging. # Settings for logging. Settings for Dialogflow History, Contact Center messages, StackDriver logs, and speech logging. Exposed at the following levels: - Agent level. - "enableInteractionLogging": True or False, # If true, DF Interaction logging is currently enabled. - "enableStackdriverLogging": True or False, # If true, StackDriver logging is currently enabled. + "enableInteractionLogging": True or False, # Enables DF Interaction logging. + "enableStackdriverLogging": True or False, # Enables StackDriver logging. }, "speechSettings": { # Define behaviors of speech to text detection. # Settings for speech to text detection. Exposed at the following levels: - Agent level - Flow level - Page level - Parameter level "endpointerSensitivity": 42, # Sensitivity of the speech model that detects the end of speech. Scale from 0 to 100. @@ -1968,6 +2108,13 @@

Method Details

"A String", ], }, + "toolCall": { # Represents a call of a specific tool's action with the specified inputs. # Returns the definition of a tool call that should be executed by the client. + "action": "A String", # Required. The name of the tool's action associated with this call. + "inputParameters": { # Optional. The action's input parameters. + "a_key": "", # Properties of the object. + }, + "tool": "A String", # Required. The tool associated with this call. Format: `projects//locations//agents//tools/`. + }, }, }, ], @@ -2024,6 +2171,13 @@

Method Details

"A String", ], }, + "toolCall": { # Represents a call of a specific tool's action with the specified inputs. # Returns the definition of a tool call that should be executed by the client. + "action": "A String", # Required. The name of the tool's action associated with this call. + "inputParameters": { # Optional. The action's input parameters. + "a_key": "", # Properties of the object. + }, + "tool": "A String", # Required. The tool associated with this call. Format: `projects//locations//agents//tools/`. + }, }, ], "returnPartialResponses": True or False, # Whether Dialogflow should return currently queued fulfillment response messages in streaming APIs. If a webhook is specified, it happens before Dialogflow invokes webhook. Warning: 1) This flag only affects streaming API. Responses are still queued and returned once in non-streaming API. 2) The flag can be enabled in any fulfillment but only the first 3 partial responses will be returned. You may only want to apply it to fulfillments that have slow webhooks. @@ -2062,8 +2216,8 @@

Method Details

"maxDigits": 42, # Max length of DTMF digits. }, "loggingSettings": { # Define behaviors on logging. # Settings for logging. Settings for Dialogflow History, Contact Center messages, StackDriver logs, and speech logging. Exposed at the following levels: - Agent level. - "enableInteractionLogging": True or False, # If true, DF Interaction logging is currently enabled. - "enableStackdriverLogging": True or False, # If true, StackDriver logging is currently enabled. + "enableInteractionLogging": True or False, # Enables DF Interaction logging. + "enableStackdriverLogging": True or False, # Enables StackDriver logging. }, "speechSettings": { # Define behaviors of speech to text detection. # Settings for speech to text detection. Exposed at the following levels: - Agent level - Flow level - Page level - Parameter level "endpointerSensitivity": 42, # Sensitivity of the speech model that detects the end of speech. Scale from 0 to 100. @@ -2127,6 +2281,13 @@

Method Details

"A String", ], }, + "toolCall": { # Represents a call of a specific tool's action with the specified inputs. # Returns the definition of a tool call that should be executed by the client. + "action": "A String", # Required. The name of the tool's action associated with this call. + "inputParameters": { # Optional. The action's input parameters. + "a_key": "", # Properties of the object. + }, + "tool": "A String", # Required. The tool associated with this call. Format: `projects//locations//agents//tools/`. + }, }, }, ], @@ -2183,6 +2344,13 @@

Method Details

"A String", ], }, + "toolCall": { # Represents a call of a specific tool's action with the specified inputs. # Returns the definition of a tool call that should be executed by the client. + "action": "A String", # Required. The name of the tool's action associated with this call. + "inputParameters": { # Optional. The action's input parameters. + "a_key": "", # Properties of the object. + }, + "tool": "A String", # Required. The tool associated with this call. Format: `projects//locations//agents//tools/`. + }, }, ], "returnPartialResponses": True or False, # Whether Dialogflow should return currently queued fulfillment response messages in streaming APIs. If a webhook is specified, it happens before Dialogflow invokes webhook. Warning: 1) This flag only affects streaming API. Responses are still queued and returned once in non-streaming API. 2) The flag can be enabled in any fulfillment but only the first 3 partial responses will be returned. You may only want to apply it to fulfillments that have slow webhooks. @@ -2213,8 +2381,8 @@

Method Details

"maxDigits": 42, # Max length of DTMF digits. }, "loggingSettings": { # Define behaviors on logging. # Settings for logging. Settings for Dialogflow History, Contact Center messages, StackDriver logs, and speech logging. Exposed at the following levels: - Agent level. - "enableInteractionLogging": True or False, # If true, DF Interaction logging is currently enabled. - "enableStackdriverLogging": True or False, # If true, StackDriver logging is currently enabled. + "enableInteractionLogging": True or False, # Enables DF Interaction logging. + "enableStackdriverLogging": True or False, # Enables StackDriver logging. }, "speechSettings": { # Define behaviors of speech to text detection. # Settings for speech to text detection. Exposed at the following levels: - Agent level - Flow level - Page level - Parameter level "endpointerSensitivity": 42, # Sensitivity of the speech model that detects the end of speech. Scale from 0 to 100. @@ -2246,8 +2414,8 @@

Method Details

"maxDigits": 42, # Max length of DTMF digits. }, "loggingSettings": { # Define behaviors on logging. # Settings for logging. Settings for Dialogflow History, Contact Center messages, StackDriver logs, and speech logging. Exposed at the following levels: - Agent level. - "enableInteractionLogging": True or False, # If true, DF Interaction logging is currently enabled. - "enableStackdriverLogging": True or False, # If true, StackDriver logging is currently enabled. + "enableInteractionLogging": True or False, # Enables DF Interaction logging. + "enableStackdriverLogging": True or False, # Enables StackDriver logging. }, "speechSettings": { # Define behaviors of speech to text detection. # Settings for speech to text detection. Exposed at the following levels: - Agent level - Flow level - Page level - Parameter level "endpointerSensitivity": 42, # Sensitivity of the speech model that detects the end of speech. Scale from 0 to 100. @@ -2311,6 +2479,13 @@

Method Details

"A String", ], }, + "toolCall": { # Represents a call of a specific tool's action with the specified inputs. # Returns the definition of a tool call that should be executed by the client. + "action": "A String", # Required. The name of the tool's action associated with this call. + "inputParameters": { # Optional. The action's input parameters. + "a_key": "", # Properties of the object. + }, + "tool": "A String", # Required. The tool associated with this call. Format: `projects//locations//agents//tools/`. + }, }, }, ], @@ -2367,6 +2542,13 @@

Method Details

"A String", ], }, + "toolCall": { # Represents a call of a specific tool's action with the specified inputs. # Returns the definition of a tool call that should be executed by the client. + "action": "A String", # Required. The name of the tool's action associated with this call. + "inputParameters": { # Optional. The action's input parameters. + "a_key": "", # Properties of the object. + }, + "tool": "A String", # Required. The tool associated with this call. Format: `projects//locations//agents//tools/`. + }, }, ], "returnPartialResponses": True or False, # Whether Dialogflow should return currently queued fulfillment response messages in streaming APIs. If a webhook is specified, it happens before Dialogflow invokes webhook. Warning: 1) This flag only affects streaming API. Responses are still queued and returned once in non-streaming API. 2) The flag can be enabled in any fulfillment but only the first 3 partial responses will be returned. You may only want to apply it to fulfillments that have slow webhooks. @@ -2404,8 +2586,8 @@

Method Details

"maxDigits": 42, # Max length of DTMF digits. }, "loggingSettings": { # Define behaviors on logging. # Settings for logging. Settings for Dialogflow History, Contact Center messages, StackDriver logs, and speech logging. Exposed at the following levels: - Agent level. - "enableInteractionLogging": True or False, # If true, DF Interaction logging is currently enabled. - "enableStackdriverLogging": True or False, # If true, StackDriver logging is currently enabled. + "enableInteractionLogging": True or False, # Enables DF Interaction logging. + "enableStackdriverLogging": True or False, # Enables StackDriver logging. }, "speechSettings": { # Define behaviors of speech to text detection. # Settings for speech to text detection. Exposed at the following levels: - Agent level - Flow level - Page level - Parameter level "endpointerSensitivity": 42, # Sensitivity of the speech model that detects the end of speech. Scale from 0 to 100. @@ -2469,6 +2651,13 @@

Method Details

"A String", ], }, + "toolCall": { # Represents a call of a specific tool's action with the specified inputs. # Returns the definition of a tool call that should be executed by the client. + "action": "A String", # Required. The name of the tool's action associated with this call. + "inputParameters": { # Optional. The action's input parameters. + "a_key": "", # Properties of the object. + }, + "tool": "A String", # Required. The tool associated with this call. Format: `projects//locations//agents//tools/`. + }, }, }, ], @@ -2525,6 +2714,13 @@

Method Details

"A String", ], }, + "toolCall": { # Represents a call of a specific tool's action with the specified inputs. # Returns the definition of a tool call that should be executed by the client. + "action": "A String", # Required. The name of the tool's action associated with this call. + "inputParameters": { # Optional. The action's input parameters. + "a_key": "", # Properties of the object. + }, + "tool": "A String", # Required. The tool associated with this call. Format: `projects//locations//agents//tools/`. + }, }, ], "returnPartialResponses": True or False, # Whether Dialogflow should return currently queued fulfillment response messages in streaming APIs. If a webhook is specified, it happens before Dialogflow invokes webhook. Warning: 1) This flag only affects streaming API. Responses are still queued and returned once in non-streaming API. 2) The flag can be enabled in any fulfillment but only the first 3 partial responses will be returned. You may only want to apply it to fulfillments that have slow webhooks. @@ -2574,8 +2770,8 @@

Method Details

"maxDigits": 42, # Max length of DTMF digits. }, "loggingSettings": { # Define behaviors on logging. # Settings for logging. Settings for Dialogflow History, Contact Center messages, StackDriver logs, and speech logging. Exposed at the following levels: - Agent level. - "enableInteractionLogging": True or False, # If true, DF Interaction logging is currently enabled. - "enableStackdriverLogging": True or False, # If true, StackDriver logging is currently enabled. + "enableInteractionLogging": True or False, # Enables DF Interaction logging. + "enableStackdriverLogging": True or False, # Enables StackDriver logging. }, "speechSettings": { # Define behaviors of speech to text detection. # Settings for speech to text detection. Exposed at the following levels: - Agent level - Flow level - Page level - Parameter level "endpointerSensitivity": 42, # Sensitivity of the speech model that detects the end of speech. Scale from 0 to 100. @@ -2639,6 +2835,13 @@

Method Details

"A String", ], }, + "toolCall": { # Represents a call of a specific tool's action with the specified inputs. # Returns the definition of a tool call that should be executed by the client. + "action": "A String", # Required. The name of the tool's action associated with this call. + "inputParameters": { # Optional. The action's input parameters. + "a_key": "", # Properties of the object. + }, + "tool": "A String", # Required. The tool associated with this call. Format: `projects//locations//agents//tools/`. + }, }, }, ], @@ -2695,6 +2898,13 @@

Method Details

"A String", ], }, + "toolCall": { # Represents a call of a specific tool's action with the specified inputs. # Returns the definition of a tool call that should be executed by the client. + "action": "A String", # Required. The name of the tool's action associated with this call. + "inputParameters": { # Optional. The action's input parameters. + "a_key": "", # Properties of the object. + }, + "tool": "A String", # Required. The tool associated with this call. Format: `projects//locations//agents//tools/`. + }, }, ], "returnPartialResponses": True or False, # Whether Dialogflow should return currently queued fulfillment response messages in streaming APIs. If a webhook is specified, it happens before Dialogflow invokes webhook. Warning: 1) This flag only affects streaming API. Responses are still queued and returned once in non-streaming API. 2) The flag can be enabled in any fulfillment but only the first 3 partial responses will be returned. You may only want to apply it to fulfillments that have slow webhooks. @@ -2723,8 +2933,8 @@

Method Details

"maxDigits": 42, # Max length of DTMF digits. }, "loggingSettings": { # Define behaviors on logging. # Settings for logging. Settings for Dialogflow History, Contact Center messages, StackDriver logs, and speech logging. Exposed at the following levels: - Agent level. - "enableInteractionLogging": True or False, # If true, DF Interaction logging is currently enabled. - "enableStackdriverLogging": True or False, # If true, StackDriver logging is currently enabled. + "enableInteractionLogging": True or False, # Enables DF Interaction logging. + "enableStackdriverLogging": True or False, # Enables StackDriver logging. }, "speechSettings": { # Define behaviors of speech to text detection. # Settings for speech to text detection. Exposed at the following levels: - Agent level - Flow level - Page level - Parameter level "endpointerSensitivity": 42, # Sensitivity of the speech model that detects the end of speech. Scale from 0 to 100. @@ -2750,8 +2960,8 @@

Method Details

"maxDigits": 42, # Max length of DTMF digits. }, "loggingSettings": { # Define behaviors on logging. # Settings for logging. Settings for Dialogflow History, Contact Center messages, StackDriver logs, and speech logging. Exposed at the following levels: - Agent level. - "enableInteractionLogging": True or False, # If true, DF Interaction logging is currently enabled. - "enableStackdriverLogging": True or False, # If true, StackDriver logging is currently enabled. + "enableInteractionLogging": True or False, # Enables DF Interaction logging. + "enableStackdriverLogging": True or False, # Enables StackDriver logging. }, "speechSettings": { # Define behaviors of speech to text detection. # Settings for speech to text detection. Exposed at the following levels: - Agent level - Flow level - Page level - Parameter level "endpointerSensitivity": 42, # Sensitivity of the speech model that detects the end of speech. Scale from 0 to 100. @@ -2815,6 +3025,13 @@

Method Details

"A String", ], }, + "toolCall": { # Represents a call of a specific tool's action with the specified inputs. # Returns the definition of a tool call that should be executed by the client. + "action": "A String", # Required. The name of the tool's action associated with this call. + "inputParameters": { # Optional. The action's input parameters. + "a_key": "", # Properties of the object. + }, + "tool": "A String", # Required. The tool associated with this call. Format: `projects//locations//agents//tools/`. + }, }, }, ], @@ -2871,6 +3088,13 @@

Method Details

"A String", ], }, + "toolCall": { # Represents a call of a specific tool's action with the specified inputs. # Returns the definition of a tool call that should be executed by the client. + "action": "A String", # Required. The name of the tool's action associated with this call. + "inputParameters": { # Optional. The action's input parameters. + "a_key": "", # Properties of the object. + }, + "tool": "A String", # Required. The tool associated with this call. Format: `projects//locations//agents//tools/`. + }, }, ], "returnPartialResponses": True or False, # Whether Dialogflow should return currently queued fulfillment response messages in streaming APIs. If a webhook is specified, it happens before Dialogflow invokes webhook. Warning: 1) This flag only affects streaming API. Responses are still queued and returned once in non-streaming API. 2) The flag can be enabled in any fulfillment but only the first 3 partial responses will be returned. You may only want to apply it to fulfillments that have slow webhooks. @@ -2902,8 +3126,8 @@

Method Details

"maxDigits": 42, # Max length of DTMF digits. }, "loggingSettings": { # Define behaviors on logging. # Settings for logging. Settings for Dialogflow History, Contact Center messages, StackDriver logs, and speech logging. Exposed at the following levels: - Agent level. - "enableInteractionLogging": True or False, # If true, DF Interaction logging is currently enabled. - "enableStackdriverLogging": True or False, # If true, StackDriver logging is currently enabled. + "enableInteractionLogging": True or False, # Enables DF Interaction logging. + "enableStackdriverLogging": True or False, # Enables StackDriver logging. }, "speechSettings": { # Define behaviors of speech to text detection. # Settings for speech to text detection. Exposed at the following levels: - Agent level - Flow level - Page level - Parameter level "endpointerSensitivity": 42, # Sensitivity of the speech model that detects the end of speech. Scale from 0 to 100. @@ -2967,6 +3191,13 @@

Method Details

"A String", ], }, + "toolCall": { # Represents a call of a specific tool's action with the specified inputs. # Returns the definition of a tool call that should be executed by the client. + "action": "A String", # Required. The name of the tool's action associated with this call. + "inputParameters": { # Optional. The action's input parameters. + "a_key": "", # Properties of the object. + }, + "tool": "A String", # Required. The tool associated with this call. Format: `projects//locations//agents//tools/`. + }, }, }, ], @@ -3023,6 +3254,13 @@

Method Details

"A String", ], }, + "toolCall": { # Represents a call of a specific tool's action with the specified inputs. # Returns the definition of a tool call that should be executed by the client. + "action": "A String", # Required. The name of the tool's action associated with this call. + "inputParameters": { # Optional. The action's input parameters. + "a_key": "", # Properties of the object. + }, + "tool": "A String", # Required. The tool associated with this call. Format: `projects//locations//agents//tools/`. + }, }, ], "returnPartialResponses": True or False, # Whether Dialogflow should return currently queued fulfillment response messages in streaming APIs. If a webhook is specified, it happens before Dialogflow invokes webhook. Warning: 1) This flag only affects streaming API. Responses are still queued and returned once in non-streaming API. 2) The flag can be enabled in any fulfillment but only the first 3 partial responses will be returned. You may only want to apply it to fulfillments that have slow webhooks. @@ -3052,8 +3290,8 @@

Method Details

"maxDigits": 42, # Max length of DTMF digits. }, "loggingSettings": { # Define behaviors on logging. # Settings for logging. Settings for Dialogflow History, Contact Center messages, StackDriver logs, and speech logging. Exposed at the following levels: - Agent level. - "enableInteractionLogging": True or False, # If true, DF Interaction logging is currently enabled. - "enableStackdriverLogging": True or False, # If true, StackDriver logging is currently enabled. + "enableInteractionLogging": True or False, # Enables DF Interaction logging. + "enableStackdriverLogging": True or False, # Enables StackDriver logging. }, "speechSettings": { # Define behaviors of speech to text detection. # Settings for speech to text detection. Exposed at the following levels: - Agent level - Flow level - Page level - Parameter level "endpointerSensitivity": 42, # Sensitivity of the speech model that detects the end of speech. Scale from 0 to 100. @@ -3081,8 +3319,8 @@

Method Details

"maxDigits": 42, # Max length of DTMF digits. }, "loggingSettings": { # Define behaviors on logging. # Settings for logging. Settings for Dialogflow History, Contact Center messages, StackDriver logs, and speech logging. Exposed at the following levels: - Agent level. - "enableInteractionLogging": True or False, # If true, DF Interaction logging is currently enabled. - "enableStackdriverLogging": True or False, # If true, StackDriver logging is currently enabled. + "enableInteractionLogging": True or False, # Enables DF Interaction logging. + "enableStackdriverLogging": True or False, # Enables StackDriver logging. }, "speechSettings": { # Define behaviors of speech to text detection. # Settings for speech to text detection. Exposed at the following levels: - Agent level - Flow level - Page level - Parameter level "endpointerSensitivity": 42, # Sensitivity of the speech model that detects the end of speech. Scale from 0 to 100. @@ -3146,6 +3384,13 @@

Method Details

"A String", ], }, + "toolCall": { # Represents a call of a specific tool's action with the specified inputs. # Returns the definition of a tool call that should be executed by the client. + "action": "A String", # Required. The name of the tool's action associated with this call. + "inputParameters": { # Optional. The action's input parameters. + "a_key": "", # Properties of the object. + }, + "tool": "A String", # Required. The tool associated with this call. Format: `projects//locations//agents//tools/`. + }, }, }, ], @@ -3202,6 +3447,13 @@

Method Details

"A String", ], }, + "toolCall": { # Represents a call of a specific tool's action with the specified inputs. # Returns the definition of a tool call that should be executed by the client. + "action": "A String", # Required. The name of the tool's action associated with this call. + "inputParameters": { # Optional. The action's input parameters. + "a_key": "", # Properties of the object. + }, + "tool": "A String", # Required. The tool associated with this call. Format: `projects//locations//agents//tools/`. + }, }, ], "returnPartialResponses": True or False, # Whether Dialogflow should return currently queued fulfillment response messages in streaming APIs. If a webhook is specified, it happens before Dialogflow invokes webhook. Warning: 1) This flag only affects streaming API. Responses are still queued and returned once in non-streaming API. 2) The flag can be enabled in any fulfillment but only the first 3 partial responses will be returned. You may only want to apply it to fulfillments that have slow webhooks. @@ -3233,8 +3485,8 @@

Method Details

"maxDigits": 42, # Max length of DTMF digits. }, "loggingSettings": { # Define behaviors on logging. # Settings for logging. Settings for Dialogflow History, Contact Center messages, StackDriver logs, and speech logging. Exposed at the following levels: - Agent level. - "enableInteractionLogging": True or False, # If true, DF Interaction logging is currently enabled. - "enableStackdriverLogging": True or False, # If true, StackDriver logging is currently enabled. + "enableInteractionLogging": True or False, # Enables DF Interaction logging. + "enableStackdriverLogging": True or False, # Enables StackDriver logging. }, "speechSettings": { # Define behaviors of speech to text detection. # Settings for speech to text detection. Exposed at the following levels: - Agent level - Flow level - Page level - Parameter level "endpointerSensitivity": 42, # Sensitivity of the speech model that detects the end of speech. Scale from 0 to 100. @@ -3298,6 +3550,13 @@

Method Details

"A String", ], }, + "toolCall": { # Represents a call of a specific tool's action with the specified inputs. # Returns the definition of a tool call that should be executed by the client. + "action": "A String", # Required. The name of the tool's action associated with this call. + "inputParameters": { # Optional. The action's input parameters. + "a_key": "", # Properties of the object. + }, + "tool": "A String", # Required. The tool associated with this call. Format: `projects//locations//agents//tools/`. + }, }, }, ], @@ -3354,6 +3613,13 @@

Method Details

"A String", ], }, + "toolCall": { # Represents a call of a specific tool's action with the specified inputs. # Returns the definition of a tool call that should be executed by the client. + "action": "A String", # Required. The name of the tool's action associated with this call. + "inputParameters": { # Optional. The action's input parameters. + "a_key": "", # Properties of the object. + }, + "tool": "A String", # Required. The tool associated with this call. Format: `projects//locations//agents//tools/`. + }, }, ], "returnPartialResponses": True or False, # Whether Dialogflow should return currently queued fulfillment response messages in streaming APIs. If a webhook is specified, it happens before Dialogflow invokes webhook. Warning: 1) This flag only affects streaming API. Responses are still queued and returned once in non-streaming API. 2) The flag can be enabled in any fulfillment but only the first 3 partial responses will be returned. You may only want to apply it to fulfillments that have slow webhooks. @@ -3398,8 +3664,8 @@

Method Details

"maxDigits": 42, # Max length of DTMF digits. }, "loggingSettings": { # Define behaviors on logging. # Settings for logging. Settings for Dialogflow History, Contact Center messages, StackDriver logs, and speech logging. Exposed at the following levels: - Agent level. - "enableInteractionLogging": True or False, # If true, DF Interaction logging is currently enabled. - "enableStackdriverLogging": True or False, # If true, StackDriver logging is currently enabled. + "enableInteractionLogging": True or False, # Enables DF Interaction logging. + "enableStackdriverLogging": True or False, # Enables StackDriver logging. }, "speechSettings": { # Define behaviors of speech to text detection. # Settings for speech to text detection. Exposed at the following levels: - Agent level - Flow level - Page level - Parameter level "endpointerSensitivity": 42, # Sensitivity of the speech model that detects the end of speech. Scale from 0 to 100. @@ -3463,6 +3729,13 @@

Method Details

"A String", ], }, + "toolCall": { # Represents a call of a specific tool's action with the specified inputs. # Returns the definition of a tool call that should be executed by the client. + "action": "A String", # Required. The name of the tool's action associated with this call. + "inputParameters": { # Optional. The action's input parameters. + "a_key": "", # Properties of the object. + }, + "tool": "A String", # Required. The tool associated with this call. Format: `projects//locations//agents//tools/`. + }, }, }, ], @@ -3519,6 +3792,13 @@

Method Details

"A String", ], }, + "toolCall": { # Represents a call of a specific tool's action with the specified inputs. # Returns the definition of a tool call that should be executed by the client. + "action": "A String", # Required. The name of the tool's action associated with this call. + "inputParameters": { # Optional. The action's input parameters. + "a_key": "", # Properties of the object. + }, + "tool": "A String", # Required. The tool associated with this call. Format: `projects//locations//agents//tools/`. + }, }, ], "returnPartialResponses": True or False, # Whether Dialogflow should return currently queued fulfillment response messages in streaming APIs. If a webhook is specified, it happens before Dialogflow invokes webhook. Warning: 1) This flag only affects streaming API. Responses are still queued and returned once in non-streaming API. 2) The flag can be enabled in any fulfillment but only the first 3 partial responses will be returned. You may only want to apply it to fulfillments that have slow webhooks. @@ -3557,8 +3837,8 @@

Method Details

"maxDigits": 42, # Max length of DTMF digits. }, "loggingSettings": { # Define behaviors on logging. # Settings for logging. Settings for Dialogflow History, Contact Center messages, StackDriver logs, and speech logging. Exposed at the following levels: - Agent level. - "enableInteractionLogging": True or False, # If true, DF Interaction logging is currently enabled. - "enableStackdriverLogging": True or False, # If true, StackDriver logging is currently enabled. + "enableInteractionLogging": True or False, # Enables DF Interaction logging. + "enableStackdriverLogging": True or False, # Enables StackDriver logging. }, "speechSettings": { # Define behaviors of speech to text detection. # Settings for speech to text detection. Exposed at the following levels: - Agent level - Flow level - Page level - Parameter level "endpointerSensitivity": 42, # Sensitivity of the speech model that detects the end of speech. Scale from 0 to 100. @@ -3622,6 +3902,13 @@

Method Details

"A String", ], }, + "toolCall": { # Represents a call of a specific tool's action with the specified inputs. # Returns the definition of a tool call that should be executed by the client. + "action": "A String", # Required. The name of the tool's action associated with this call. + "inputParameters": { # Optional. The action's input parameters. + "a_key": "", # Properties of the object. + }, + "tool": "A String", # Required. The tool associated with this call. Format: `projects//locations//agents//tools/`. + }, }, }, ], @@ -3678,6 +3965,13 @@

Method Details

"A String", ], }, + "toolCall": { # Represents a call of a specific tool's action with the specified inputs. # Returns the definition of a tool call that should be executed by the client. + "action": "A String", # Required. The name of the tool's action associated with this call. + "inputParameters": { # Optional. The action's input parameters. + "a_key": "", # Properties of the object. + }, + "tool": "A String", # Required. The tool associated with this call. Format: `projects//locations//agents//tools/`. + }, }, ], "returnPartialResponses": True or False, # Whether Dialogflow should return currently queued fulfillment response messages in streaming APIs. If a webhook is specified, it happens before Dialogflow invokes webhook. Warning: 1) This flag only affects streaming API. Responses are still queued and returned once in non-streaming API. 2) The flag can be enabled in any fulfillment but only the first 3 partial responses will be returned. You may only want to apply it to fulfillments that have slow webhooks. @@ -3714,8 +4008,8 @@

Method Details

"maxDigits": 42, # Max length of DTMF digits. }, "loggingSettings": { # Define behaviors on logging. # Settings for logging. Settings for Dialogflow History, Contact Center messages, StackDriver logs, and speech logging. Exposed at the following levels: - Agent level. - "enableInteractionLogging": True or False, # If true, DF Interaction logging is currently enabled. - "enableStackdriverLogging": True or False, # If true, StackDriver logging is currently enabled. + "enableInteractionLogging": True or False, # Enables DF Interaction logging. + "enableStackdriverLogging": True or False, # Enables StackDriver logging. }, "speechSettings": { # Define behaviors of speech to text detection. # Settings for speech to text detection. Exposed at the following levels: - Agent level - Flow level - Page level - Parameter level "endpointerSensitivity": 42, # Sensitivity of the speech model that detects the end of speech. Scale from 0 to 100. @@ -3779,6 +4073,13 @@

Method Details

"A String", ], }, + "toolCall": { # Represents a call of a specific tool's action with the specified inputs. # Returns the definition of a tool call that should be executed by the client. + "action": "A String", # Required. The name of the tool's action associated with this call. + "inputParameters": { # Optional. The action's input parameters. + "a_key": "", # Properties of the object. + }, + "tool": "A String", # Required. The tool associated with this call. Format: `projects//locations//agents//tools/`. + }, }, }, ], @@ -3835,6 +4136,13 @@

Method Details

"A String", ], }, + "toolCall": { # Represents a call of a specific tool's action with the specified inputs. # Returns the definition of a tool call that should be executed by the client. + "action": "A String", # Required. The name of the tool's action associated with this call. + "inputParameters": { # Optional. The action's input parameters. + "a_key": "", # Properties of the object. + }, + "tool": "A String", # Required. The tool associated with this call. Format: `projects//locations//agents//tools/`. + }, }, ], "returnPartialResponses": True or False, # Whether Dialogflow should return currently queued fulfillment response messages in streaming APIs. If a webhook is specified, it happens before Dialogflow invokes webhook. Warning: 1) This flag only affects streaming API. Responses are still queued and returned once in non-streaming API. 2) The flag can be enabled in any fulfillment but only the first 3 partial responses will be returned. You may only want to apply it to fulfillments that have slow webhooks. @@ -3913,6 +4221,16 @@

Method Details

"text": { # Represents the natural language text to be processed. # The natural language text to be processed. "text": "A String", # Required. The UTF-8 encoded natural language text to be processed. }, + "toolCallResult": { # The result of calling a tool's action that has been executed by the client. # The results of a tool executed by the client. + "action": "A String", # Required. The name of the tool's action associated with this call. + "error": { # An error produced by the tool call. # The tool call's error. + "message": "A String", # Optional. The error message of the function. + }, + "outputParameters": { # The tool call's output parameters. + "a_key": "", # Properties of the object. + }, + "tool": "A String", # Required. The tool associated with this call. Format: `projects//locations//agents//tools/`. + }, }, "isWebhookEnabled": True or False, # If webhooks should be allowed to trigger in response to the user utterance. Often if parameters are injected, webhooks should not be enabled. }, @@ -3930,8 +4248,8 @@

Method Details

"maxDigits": 42, # Max length of DTMF digits. }, "loggingSettings": { # Define behaviors on logging. # Settings for logging. Settings for Dialogflow History, Contact Center messages, StackDriver logs, and speech logging. Exposed at the following levels: - Agent level. - "enableInteractionLogging": True or False, # If true, DF Interaction logging is currently enabled. - "enableStackdriverLogging": True or False, # If true, StackDriver logging is currently enabled. + "enableInteractionLogging": True or False, # Enables DF Interaction logging. + "enableStackdriverLogging": True or False, # Enables StackDriver logging. }, "speechSettings": { # Define behaviors of speech to text detection. # Settings for speech to text detection. Exposed at the following levels: - Agent level - Flow level - Page level - Parameter level "endpointerSensitivity": 42, # Sensitivity of the speech model that detects the end of speech. Scale from 0 to 100. @@ -3957,8 +4275,8 @@

Method Details

"maxDigits": 42, # Max length of DTMF digits. }, "loggingSettings": { # Define behaviors on logging. # Settings for logging. Settings for Dialogflow History, Contact Center messages, StackDriver logs, and speech logging. Exposed at the following levels: - Agent level. - "enableInteractionLogging": True or False, # If true, DF Interaction logging is currently enabled. - "enableStackdriverLogging": True or False, # If true, StackDriver logging is currently enabled. + "enableInteractionLogging": True or False, # Enables DF Interaction logging. + "enableStackdriverLogging": True or False, # Enables StackDriver logging. }, "speechSettings": { # Define behaviors of speech to text detection. # Settings for speech to text detection. Exposed at the following levels: - Agent level - Flow level - Page level - Parameter level "endpointerSensitivity": 42, # Sensitivity of the speech model that detects the end of speech. Scale from 0 to 100. @@ -4022,6 +4340,13 @@

Method Details

"A String", ], }, + "toolCall": { # Represents a call of a specific tool's action with the specified inputs. # Returns the definition of a tool call that should be executed by the client. + "action": "A String", # Required. The name of the tool's action associated with this call. + "inputParameters": { # Optional. The action's input parameters. + "a_key": "", # Properties of the object. + }, + "tool": "A String", # Required. The tool associated with this call. Format: `projects//locations//agents//tools/`. + }, }, }, ], @@ -4078,6 +4403,13 @@

Method Details

"A String", ], }, + "toolCall": { # Represents a call of a specific tool's action with the specified inputs. # Returns the definition of a tool call that should be executed by the client. + "action": "A String", # Required. The name of the tool's action associated with this call. + "inputParameters": { # Optional. The action's input parameters. + "a_key": "", # Properties of the object. + }, + "tool": "A String", # Required. The tool associated with this call. Format: `projects//locations//agents//tools/`. + }, }, ], "returnPartialResponses": True or False, # Whether Dialogflow should return currently queued fulfillment response messages in streaming APIs. If a webhook is specified, it happens before Dialogflow invokes webhook. Warning: 1) This flag only affects streaming API. Responses are still queued and returned once in non-streaming API. 2) The flag can be enabled in any fulfillment but only the first 3 partial responses will be returned. You may only want to apply it to fulfillments that have slow webhooks. @@ -4109,8 +4441,8 @@

Method Details

"maxDigits": 42, # Max length of DTMF digits. }, "loggingSettings": { # Define behaviors on logging. # Settings for logging. Settings for Dialogflow History, Contact Center messages, StackDriver logs, and speech logging. Exposed at the following levels: - Agent level. - "enableInteractionLogging": True or False, # If true, DF Interaction logging is currently enabled. - "enableStackdriverLogging": True or False, # If true, StackDriver logging is currently enabled. + "enableInteractionLogging": True or False, # Enables DF Interaction logging. + "enableStackdriverLogging": True or False, # Enables StackDriver logging. }, "speechSettings": { # Define behaviors of speech to text detection. # Settings for speech to text detection. Exposed at the following levels: - Agent level - Flow level - Page level - Parameter level "endpointerSensitivity": 42, # Sensitivity of the speech model that detects the end of speech. Scale from 0 to 100. @@ -4174,6 +4506,13 @@

Method Details

"A String", ], }, + "toolCall": { # Represents a call of a specific tool's action with the specified inputs. # Returns the definition of a tool call that should be executed by the client. + "action": "A String", # Required. The name of the tool's action associated with this call. + "inputParameters": { # Optional. The action's input parameters. + "a_key": "", # Properties of the object. + }, + "tool": "A String", # Required. The tool associated with this call. Format: `projects//locations//agents//tools/`. + }, }, }, ], @@ -4230,6 +4569,13 @@

Method Details

"A String", ], }, + "toolCall": { # Represents a call of a specific tool's action with the specified inputs. # Returns the definition of a tool call that should be executed by the client. + "action": "A String", # Required. The name of the tool's action associated with this call. + "inputParameters": { # Optional. The action's input parameters. + "a_key": "", # Properties of the object. + }, + "tool": "A String", # Required. The tool associated with this call. Format: `projects//locations//agents//tools/`. + }, }, ], "returnPartialResponses": True or False, # Whether Dialogflow should return currently queued fulfillment response messages in streaming APIs. If a webhook is specified, it happens before Dialogflow invokes webhook. Warning: 1) This flag only affects streaming API. Responses are still queued and returned once in non-streaming API. 2) The flag can be enabled in any fulfillment but only the first 3 partial responses will be returned. You may only want to apply it to fulfillments that have slow webhooks. @@ -4259,8 +4605,8 @@

Method Details

"maxDigits": 42, # Max length of DTMF digits. }, "loggingSettings": { # Define behaviors on logging. # Settings for logging. Settings for Dialogflow History, Contact Center messages, StackDriver logs, and speech logging. Exposed at the following levels: - Agent level. - "enableInteractionLogging": True or False, # If true, DF Interaction logging is currently enabled. - "enableStackdriverLogging": True or False, # If true, StackDriver logging is currently enabled. + "enableInteractionLogging": True or False, # Enables DF Interaction logging. + "enableStackdriverLogging": True or False, # Enables StackDriver logging. }, "speechSettings": { # Define behaviors of speech to text detection. # Settings for speech to text detection. Exposed at the following levels: - Agent level - Flow level - Page level - Parameter level "endpointerSensitivity": 42, # Sensitivity of the speech model that detects the end of speech. Scale from 0 to 100. @@ -4288,8 +4634,8 @@

Method Details

"maxDigits": 42, # Max length of DTMF digits. }, "loggingSettings": { # Define behaviors on logging. # Settings for logging. Settings for Dialogflow History, Contact Center messages, StackDriver logs, and speech logging. Exposed at the following levels: - Agent level. - "enableInteractionLogging": True or False, # If true, DF Interaction logging is currently enabled. - "enableStackdriverLogging": True or False, # If true, StackDriver logging is currently enabled. + "enableInteractionLogging": True or False, # Enables DF Interaction logging. + "enableStackdriverLogging": True or False, # Enables StackDriver logging. }, "speechSettings": { # Define behaviors of speech to text detection. # Settings for speech to text detection. Exposed at the following levels: - Agent level - Flow level - Page level - Parameter level "endpointerSensitivity": 42, # Sensitivity of the speech model that detects the end of speech. Scale from 0 to 100. @@ -4353,6 +4699,13 @@

Method Details

"A String", ], }, + "toolCall": { # Represents a call of a specific tool's action with the specified inputs. # Returns the definition of a tool call that should be executed by the client. + "action": "A String", # Required. The name of the tool's action associated with this call. + "inputParameters": { # Optional. The action's input parameters. + "a_key": "", # Properties of the object. + }, + "tool": "A String", # Required. The tool associated with this call. Format: `projects//locations//agents//tools/`. + }, }, }, ], @@ -4409,6 +4762,13 @@

Method Details

"A String", ], }, + "toolCall": { # Represents a call of a specific tool's action with the specified inputs. # Returns the definition of a tool call that should be executed by the client. + "action": "A String", # Required. The name of the tool's action associated with this call. + "inputParameters": { # Optional. The action's input parameters. + "a_key": "", # Properties of the object. + }, + "tool": "A String", # Required. The tool associated with this call. Format: `projects//locations//agents//tools/`. + }, }, ], "returnPartialResponses": True or False, # Whether Dialogflow should return currently queued fulfillment response messages in streaming APIs. If a webhook is specified, it happens before Dialogflow invokes webhook. Warning: 1) This flag only affects streaming API. Responses are still queued and returned once in non-streaming API. 2) The flag can be enabled in any fulfillment but only the first 3 partial responses will be returned. You may only want to apply it to fulfillments that have slow webhooks. @@ -4440,8 +4800,8 @@

Method Details

"maxDigits": 42, # Max length of DTMF digits. }, "loggingSettings": { # Define behaviors on logging. # Settings for logging. Settings for Dialogflow History, Contact Center messages, StackDriver logs, and speech logging. Exposed at the following levels: - Agent level. - "enableInteractionLogging": True or False, # If true, DF Interaction logging is currently enabled. - "enableStackdriverLogging": True or False, # If true, StackDriver logging is currently enabled. + "enableInteractionLogging": True or False, # Enables DF Interaction logging. + "enableStackdriverLogging": True or False, # Enables StackDriver logging. }, "speechSettings": { # Define behaviors of speech to text detection. # Settings for speech to text detection. Exposed at the following levels: - Agent level - Flow level - Page level - Parameter level "endpointerSensitivity": 42, # Sensitivity of the speech model that detects the end of speech. Scale from 0 to 100. @@ -4505,6 +4865,13 @@

Method Details

"A String", ], }, + "toolCall": { # Represents a call of a specific tool's action with the specified inputs. # Returns the definition of a tool call that should be executed by the client. + "action": "A String", # Required. The name of the tool's action associated with this call. + "inputParameters": { # Optional. The action's input parameters. + "a_key": "", # Properties of the object. + }, + "tool": "A String", # Required. The tool associated with this call. Format: `projects//locations//agents//tools/`. + }, }, }, ], @@ -4561,6 +4928,13 @@

Method Details

"A String", ], }, + "toolCall": { # Represents a call of a specific tool's action with the specified inputs. # Returns the definition of a tool call that should be executed by the client. + "action": "A String", # Required. The name of the tool's action associated with this call. + "inputParameters": { # Optional. The action's input parameters. + "a_key": "", # Properties of the object. + }, + "tool": "A String", # Required. The tool associated with this call. Format: `projects//locations//agents//tools/`. + }, }, ], "returnPartialResponses": True or False, # Whether Dialogflow should return currently queued fulfillment response messages in streaming APIs. If a webhook is specified, it happens before Dialogflow invokes webhook. Warning: 1) This flag only affects streaming API. Responses are still queued and returned once in non-streaming API. 2) The flag can be enabled in any fulfillment but only the first 3 partial responses will be returned. You may only want to apply it to fulfillments that have slow webhooks. @@ -4605,8 +4979,8 @@

Method Details

"maxDigits": 42, # Max length of DTMF digits. }, "loggingSettings": { # Define behaviors on logging. # Settings for logging. Settings for Dialogflow History, Contact Center messages, StackDriver logs, and speech logging. Exposed at the following levels: - Agent level. - "enableInteractionLogging": True or False, # If true, DF Interaction logging is currently enabled. - "enableStackdriverLogging": True or False, # If true, StackDriver logging is currently enabled. + "enableInteractionLogging": True or False, # Enables DF Interaction logging. + "enableStackdriverLogging": True or False, # Enables StackDriver logging. }, "speechSettings": { # Define behaviors of speech to text detection. # Settings for speech to text detection. Exposed at the following levels: - Agent level - Flow level - Page level - Parameter level "endpointerSensitivity": 42, # Sensitivity of the speech model that detects the end of speech. Scale from 0 to 100. @@ -4670,6 +5044,13 @@

Method Details

"A String", ], }, + "toolCall": { # Represents a call of a specific tool's action with the specified inputs. # Returns the definition of a tool call that should be executed by the client. + "action": "A String", # Required. The name of the tool's action associated with this call. + "inputParameters": { # Optional. The action's input parameters. + "a_key": "", # Properties of the object. + }, + "tool": "A String", # Required. The tool associated with this call. Format: `projects//locations//agents//tools/`. + }, }, }, ], @@ -4726,6 +5107,13 @@

Method Details

"A String", ], }, + "toolCall": { # Represents a call of a specific tool's action with the specified inputs. # Returns the definition of a tool call that should be executed by the client. + "action": "A String", # Required. The name of the tool's action associated with this call. + "inputParameters": { # Optional. The action's input parameters. + "a_key": "", # Properties of the object. + }, + "tool": "A String", # Required. The tool associated with this call. Format: `projects//locations//agents//tools/`. + }, }, ], "returnPartialResponses": True or False, # Whether Dialogflow should return currently queued fulfillment response messages in streaming APIs. If a webhook is specified, it happens before Dialogflow invokes webhook. Warning: 1) This flag only affects streaming API. Responses are still queued and returned once in non-streaming API. 2) The flag can be enabled in any fulfillment but only the first 3 partial responses will be returned. You may only want to apply it to fulfillments that have slow webhooks. @@ -4764,8 +5152,8 @@

Method Details

"maxDigits": 42, # Max length of DTMF digits. }, "loggingSettings": { # Define behaviors on logging. # Settings for logging. Settings for Dialogflow History, Contact Center messages, StackDriver logs, and speech logging. Exposed at the following levels: - Agent level. - "enableInteractionLogging": True or False, # If true, DF Interaction logging is currently enabled. - "enableStackdriverLogging": True or False, # If true, StackDriver logging is currently enabled. + "enableInteractionLogging": True or False, # Enables DF Interaction logging. + "enableStackdriverLogging": True or False, # Enables StackDriver logging. }, "speechSettings": { # Define behaviors of speech to text detection. # Settings for speech to text detection. Exposed at the following levels: - Agent level - Flow level - Page level - Parameter level "endpointerSensitivity": 42, # Sensitivity of the speech model that detects the end of speech. Scale from 0 to 100. @@ -4829,6 +5217,13 @@

Method Details

"A String", ], }, + "toolCall": { # Represents a call of a specific tool's action with the specified inputs. # Returns the definition of a tool call that should be executed by the client. + "action": "A String", # Required. The name of the tool's action associated with this call. + "inputParameters": { # Optional. The action's input parameters. + "a_key": "", # Properties of the object. + }, + "tool": "A String", # Required. The tool associated with this call. Format: `projects//locations//agents//tools/`. + }, }, }, ], @@ -4885,6 +5280,13 @@

Method Details

"A String", ], }, + "toolCall": { # Represents a call of a specific tool's action with the specified inputs. # Returns the definition of a tool call that should be executed by the client. + "action": "A String", # Required. The name of the tool's action associated with this call. + "inputParameters": { # Optional. The action's input parameters. + "a_key": "", # Properties of the object. + }, + "tool": "A String", # Required. The tool associated with this call. Format: `projects//locations//agents//tools/`. + }, }, ], "returnPartialResponses": True or False, # Whether Dialogflow should return currently queued fulfillment response messages in streaming APIs. If a webhook is specified, it happens before Dialogflow invokes webhook. Warning: 1) This flag only affects streaming API. Responses are still queued and returned once in non-streaming API. 2) The flag can be enabled in any fulfillment but only the first 3 partial responses will be returned. You may only want to apply it to fulfillments that have slow webhooks. @@ -5013,6 +5415,16 @@

Method Details

"text": { # Represents the natural language text to be processed. # The natural language text to be processed. "text": "A String", # Required. The UTF-8 encoded natural language text to be processed. }, + "toolCallResult": { # The result of calling a tool's action that has been executed by the client. # The results of a tool executed by the client. + "action": "A String", # Required. The name of the tool's action associated with this call. + "error": { # An error produced by the tool call. # The tool call's error. + "message": "A String", # Optional. The error message of the function. + }, + "outputParameters": { # The tool call's output parameters. + "a_key": "", # Properties of the object. + }, + "tool": "A String", # Required. The tool associated with this call. Format: `projects//locations//agents//tools/`. + }, }, "isWebhookEnabled": True or False, # If webhooks should be allowed to trigger in response to the user utterance. Often if parameters are injected, webhooks should not be enabled. }, @@ -5030,8 +5442,8 @@

Method Details

"maxDigits": 42, # Max length of DTMF digits. }, "loggingSettings": { # Define behaviors on logging. # Settings for logging. Settings for Dialogflow History, Contact Center messages, StackDriver logs, and speech logging. Exposed at the following levels: - Agent level. - "enableInteractionLogging": True or False, # If true, DF Interaction logging is currently enabled. - "enableStackdriverLogging": True or False, # If true, StackDriver logging is currently enabled. + "enableInteractionLogging": True or False, # Enables DF Interaction logging. + "enableStackdriverLogging": True or False, # Enables StackDriver logging. }, "speechSettings": { # Define behaviors of speech to text detection. # Settings for speech to text detection. Exposed at the following levels: - Agent level - Flow level - Page level - Parameter level "endpointerSensitivity": 42, # Sensitivity of the speech model that detects the end of speech. Scale from 0 to 100. @@ -5057,8 +5469,8 @@

Method Details

"maxDigits": 42, # Max length of DTMF digits. }, "loggingSettings": { # Define behaviors on logging. # Settings for logging. Settings for Dialogflow History, Contact Center messages, StackDriver logs, and speech logging. Exposed at the following levels: - Agent level. - "enableInteractionLogging": True or False, # If true, DF Interaction logging is currently enabled. - "enableStackdriverLogging": True or False, # If true, StackDriver logging is currently enabled. + "enableInteractionLogging": True or False, # Enables DF Interaction logging. + "enableStackdriverLogging": True or False, # Enables StackDriver logging. }, "speechSettings": { # Define behaviors of speech to text detection. # Settings for speech to text detection. Exposed at the following levels: - Agent level - Flow level - Page level - Parameter level "endpointerSensitivity": 42, # Sensitivity of the speech model that detects the end of speech. Scale from 0 to 100. @@ -5122,6 +5534,13 @@

Method Details

"A String", ], }, + "toolCall": { # Represents a call of a specific tool's action with the specified inputs. # Returns the definition of a tool call that should be executed by the client. + "action": "A String", # Required. The name of the tool's action associated with this call. + "inputParameters": { # Optional. The action's input parameters. + "a_key": "", # Properties of the object. + }, + "tool": "A String", # Required. The tool associated with this call. Format: `projects//locations//agents//tools/`. + }, }, }, ], @@ -5178,6 +5597,13 @@

Method Details

"A String", ], }, + "toolCall": { # Represents a call of a specific tool's action with the specified inputs. # Returns the definition of a tool call that should be executed by the client. + "action": "A String", # Required. The name of the tool's action associated with this call. + "inputParameters": { # Optional. The action's input parameters. + "a_key": "", # Properties of the object. + }, + "tool": "A String", # Required. The tool associated with this call. Format: `projects//locations//agents//tools/`. + }, }, ], "returnPartialResponses": True or False, # Whether Dialogflow should return currently queued fulfillment response messages in streaming APIs. If a webhook is specified, it happens before Dialogflow invokes webhook. Warning: 1) This flag only affects streaming API. Responses are still queued and returned once in non-streaming API. 2) The flag can be enabled in any fulfillment but only the first 3 partial responses will be returned. You may only want to apply it to fulfillments that have slow webhooks. @@ -5209,8 +5635,8 @@

Method Details

"maxDigits": 42, # Max length of DTMF digits. }, "loggingSettings": { # Define behaviors on logging. # Settings for logging. Settings for Dialogflow History, Contact Center messages, StackDriver logs, and speech logging. Exposed at the following levels: - Agent level. - "enableInteractionLogging": True or False, # If true, DF Interaction logging is currently enabled. - "enableStackdriverLogging": True or False, # If true, StackDriver logging is currently enabled. + "enableInteractionLogging": True or False, # Enables DF Interaction logging. + "enableStackdriverLogging": True or False, # Enables StackDriver logging. }, "speechSettings": { # Define behaviors of speech to text detection. # Settings for speech to text detection. Exposed at the following levels: - Agent level - Flow level - Page level - Parameter level "endpointerSensitivity": 42, # Sensitivity of the speech model that detects the end of speech. Scale from 0 to 100. @@ -5274,6 +5700,13 @@

Method Details

"A String", ], }, + "toolCall": { # Represents a call of a specific tool's action with the specified inputs. # Returns the definition of a tool call that should be executed by the client. + "action": "A String", # Required. The name of the tool's action associated with this call. + "inputParameters": { # Optional. The action's input parameters. + "a_key": "", # Properties of the object. + }, + "tool": "A String", # Required. The tool associated with this call. Format: `projects//locations//agents//tools/`. + }, }, }, ], @@ -5330,6 +5763,13 @@

Method Details

"A String", ], }, + "toolCall": { # Represents a call of a specific tool's action with the specified inputs. # Returns the definition of a tool call that should be executed by the client. + "action": "A String", # Required. The name of the tool's action associated with this call. + "inputParameters": { # Optional. The action's input parameters. + "a_key": "", # Properties of the object. + }, + "tool": "A String", # Required. The tool associated with this call. Format: `projects//locations//agents//tools/`. + }, }, ], "returnPartialResponses": True or False, # Whether Dialogflow should return currently queued fulfillment response messages in streaming APIs. If a webhook is specified, it happens before Dialogflow invokes webhook. Warning: 1) This flag only affects streaming API. Responses are still queued and returned once in non-streaming API. 2) The flag can be enabled in any fulfillment but only the first 3 partial responses will be returned. You may only want to apply it to fulfillments that have slow webhooks. @@ -5359,8 +5799,8 @@

Method Details

"maxDigits": 42, # Max length of DTMF digits. }, "loggingSettings": { # Define behaviors on logging. # Settings for logging. Settings for Dialogflow History, Contact Center messages, StackDriver logs, and speech logging. Exposed at the following levels: - Agent level. - "enableInteractionLogging": True or False, # If true, DF Interaction logging is currently enabled. - "enableStackdriverLogging": True or False, # If true, StackDriver logging is currently enabled. + "enableInteractionLogging": True or False, # Enables DF Interaction logging. + "enableStackdriverLogging": True or False, # Enables StackDriver logging. }, "speechSettings": { # Define behaviors of speech to text detection. # Settings for speech to text detection. Exposed at the following levels: - Agent level - Flow level - Page level - Parameter level "endpointerSensitivity": 42, # Sensitivity of the speech model that detects the end of speech. Scale from 0 to 100. @@ -5388,8 +5828,8 @@

Method Details

"maxDigits": 42, # Max length of DTMF digits. }, "loggingSettings": { # Define behaviors on logging. # Settings for logging. Settings for Dialogflow History, Contact Center messages, StackDriver logs, and speech logging. Exposed at the following levels: - Agent level. - "enableInteractionLogging": True or False, # If true, DF Interaction logging is currently enabled. - "enableStackdriverLogging": True or False, # If true, StackDriver logging is currently enabled. + "enableInteractionLogging": True or False, # Enables DF Interaction logging. + "enableStackdriverLogging": True or False, # Enables StackDriver logging. }, "speechSettings": { # Define behaviors of speech to text detection. # Settings for speech to text detection. Exposed at the following levels: - Agent level - Flow level - Page level - Parameter level "endpointerSensitivity": 42, # Sensitivity of the speech model that detects the end of speech. Scale from 0 to 100. @@ -5453,6 +5893,13 @@

Method Details

"A String", ], }, + "toolCall": { # Represents a call of a specific tool's action with the specified inputs. # Returns the definition of a tool call that should be executed by the client. + "action": "A String", # Required. The name of the tool's action associated with this call. + "inputParameters": { # Optional. The action's input parameters. + "a_key": "", # Properties of the object. + }, + "tool": "A String", # Required. The tool associated with this call. Format: `projects//locations//agents//tools/`. + }, }, }, ], @@ -5509,6 +5956,13 @@

Method Details

"A String", ], }, + "toolCall": { # Represents a call of a specific tool's action with the specified inputs. # Returns the definition of a tool call that should be executed by the client. + "action": "A String", # Required. The name of the tool's action associated with this call. + "inputParameters": { # Optional. The action's input parameters. + "a_key": "", # Properties of the object. + }, + "tool": "A String", # Required. The tool associated with this call. Format: `projects//locations//agents//tools/`. + }, }, ], "returnPartialResponses": True or False, # Whether Dialogflow should return currently queued fulfillment response messages in streaming APIs. If a webhook is specified, it happens before Dialogflow invokes webhook. Warning: 1) This flag only affects streaming API. Responses are still queued and returned once in non-streaming API. 2) The flag can be enabled in any fulfillment but only the first 3 partial responses will be returned. You may only want to apply it to fulfillments that have slow webhooks. @@ -5540,8 +5994,8 @@

Method Details

"maxDigits": 42, # Max length of DTMF digits. }, "loggingSettings": { # Define behaviors on logging. # Settings for logging. Settings for Dialogflow History, Contact Center messages, StackDriver logs, and speech logging. Exposed at the following levels: - Agent level. - "enableInteractionLogging": True or False, # If true, DF Interaction logging is currently enabled. - "enableStackdriverLogging": True or False, # If true, StackDriver logging is currently enabled. + "enableInteractionLogging": True or False, # Enables DF Interaction logging. + "enableStackdriverLogging": True or False, # Enables StackDriver logging. }, "speechSettings": { # Define behaviors of speech to text detection. # Settings for speech to text detection. Exposed at the following levels: - Agent level - Flow level - Page level - Parameter level "endpointerSensitivity": 42, # Sensitivity of the speech model that detects the end of speech. Scale from 0 to 100. @@ -5605,6 +6059,13 @@

Method Details

"A String", ], }, + "toolCall": { # Represents a call of a specific tool's action with the specified inputs. # Returns the definition of a tool call that should be executed by the client. + "action": "A String", # Required. The name of the tool's action associated with this call. + "inputParameters": { # Optional. The action's input parameters. + "a_key": "", # Properties of the object. + }, + "tool": "A String", # Required. The tool associated with this call. Format: `projects//locations//agents//tools/`. + }, }, }, ], @@ -5661,6 +6122,13 @@

Method Details

"A String", ], }, + "toolCall": { # Represents a call of a specific tool's action with the specified inputs. # Returns the definition of a tool call that should be executed by the client. + "action": "A String", # Required. The name of the tool's action associated with this call. + "inputParameters": { # Optional. The action's input parameters. + "a_key": "", # Properties of the object. + }, + "tool": "A String", # Required. The tool associated with this call. Format: `projects//locations//agents//tools/`. + }, }, ], "returnPartialResponses": True or False, # Whether Dialogflow should return currently queued fulfillment response messages in streaming APIs. If a webhook is specified, it happens before Dialogflow invokes webhook. Warning: 1) This flag only affects streaming API. Responses are still queued and returned once in non-streaming API. 2) The flag can be enabled in any fulfillment but only the first 3 partial responses will be returned. You may only want to apply it to fulfillments that have slow webhooks. @@ -5705,8 +6173,8 @@

Method Details

"maxDigits": 42, # Max length of DTMF digits. }, "loggingSettings": { # Define behaviors on logging. # Settings for logging. Settings for Dialogflow History, Contact Center messages, StackDriver logs, and speech logging. Exposed at the following levels: - Agent level. - "enableInteractionLogging": True or False, # If true, DF Interaction logging is currently enabled. - "enableStackdriverLogging": True or False, # If true, StackDriver logging is currently enabled. + "enableInteractionLogging": True or False, # Enables DF Interaction logging. + "enableStackdriverLogging": True or False, # Enables StackDriver logging. }, "speechSettings": { # Define behaviors of speech to text detection. # Settings for speech to text detection. Exposed at the following levels: - Agent level - Flow level - Page level - Parameter level "endpointerSensitivity": 42, # Sensitivity of the speech model that detects the end of speech. Scale from 0 to 100. @@ -5770,6 +6238,13 @@

Method Details

"A String", ], }, + "toolCall": { # Represents a call of a specific tool's action with the specified inputs. # Returns the definition of a tool call that should be executed by the client. + "action": "A String", # Required. The name of the tool's action associated with this call. + "inputParameters": { # Optional. The action's input parameters. + "a_key": "", # Properties of the object. + }, + "tool": "A String", # Required. The tool associated with this call. Format: `projects//locations//agents//tools/`. + }, }, }, ], @@ -5826,6 +6301,13 @@

Method Details

"A String", ], }, + "toolCall": { # Represents a call of a specific tool's action with the specified inputs. # Returns the definition of a tool call that should be executed by the client. + "action": "A String", # Required. The name of the tool's action associated with this call. + "inputParameters": { # Optional. The action's input parameters. + "a_key": "", # Properties of the object. + }, + "tool": "A String", # Required. The tool associated with this call. Format: `projects//locations//agents//tools/`. + }, }, ], "returnPartialResponses": True or False, # Whether Dialogflow should return currently queued fulfillment response messages in streaming APIs. If a webhook is specified, it happens before Dialogflow invokes webhook. Warning: 1) This flag only affects streaming API. Responses are still queued and returned once in non-streaming API. 2) The flag can be enabled in any fulfillment but only the first 3 partial responses will be returned. You may only want to apply it to fulfillments that have slow webhooks. @@ -5864,8 +6346,8 @@

Method Details

"maxDigits": 42, # Max length of DTMF digits. }, "loggingSettings": { # Define behaviors on logging. # Settings for logging. Settings for Dialogflow History, Contact Center messages, StackDriver logs, and speech logging. Exposed at the following levels: - Agent level. - "enableInteractionLogging": True or False, # If true, DF Interaction logging is currently enabled. - "enableStackdriverLogging": True or False, # If true, StackDriver logging is currently enabled. + "enableInteractionLogging": True or False, # Enables DF Interaction logging. + "enableStackdriverLogging": True or False, # Enables StackDriver logging. }, "speechSettings": { # Define behaviors of speech to text detection. # Settings for speech to text detection. Exposed at the following levels: - Agent level - Flow level - Page level - Parameter level "endpointerSensitivity": 42, # Sensitivity of the speech model that detects the end of speech. Scale from 0 to 100. @@ -5929,6 +6411,13 @@

Method Details

"A String", ], }, + "toolCall": { # Represents a call of a specific tool's action with the specified inputs. # Returns the definition of a tool call that should be executed by the client. + "action": "A String", # Required. The name of the tool's action associated with this call. + "inputParameters": { # Optional. The action's input parameters. + "a_key": "", # Properties of the object. + }, + "tool": "A String", # Required. The tool associated with this call. Format: `projects//locations//agents//tools/`. + }, }, }, ], @@ -5985,6 +6474,13 @@

Method Details

"A String", ], }, + "toolCall": { # Represents a call of a specific tool's action with the specified inputs. # Returns the definition of a tool call that should be executed by the client. + "action": "A String", # Required. The name of the tool's action associated with this call. + "inputParameters": { # Optional. The action's input parameters. + "a_key": "", # Properties of the object. + }, + "tool": "A String", # Required. The tool associated with this call. Format: `projects//locations//agents//tools/`. + }, }, ], "returnPartialResponses": True or False, # Whether Dialogflow should return currently queued fulfillment response messages in streaming APIs. If a webhook is specified, it happens before Dialogflow invokes webhook. Warning: 1) This flag only affects streaming API. Responses are still queued and returned once in non-streaming API. 2) The flag can be enabled in any fulfillment but only the first 3 partial responses will be returned. You may only want to apply it to fulfillments that have slow webhooks. @@ -6124,6 +6620,16 @@

Method Details

"text": { # Represents the natural language text to be processed. # The natural language text to be processed. "text": "A String", # Required. The UTF-8 encoded natural language text to be processed. }, + "toolCallResult": { # The result of calling a tool's action that has been executed by the client. # The results of a tool executed by the client. + "action": "A String", # Required. The name of the tool's action associated with this call. + "error": { # An error produced by the tool call. # The tool call's error. + "message": "A String", # Optional. The error message of the function. + }, + "outputParameters": { # The tool call's output parameters. + "a_key": "", # Properties of the object. + }, + "tool": "A String", # Required. The tool associated with this call. Format: `projects//locations//agents//tools/`. + }, }, "isWebhookEnabled": True or False, # If webhooks should be allowed to trigger in response to the user utterance. Often if parameters are injected, webhooks should not be enabled. }, @@ -6141,8 +6647,8 @@

Method Details

"maxDigits": 42, # Max length of DTMF digits. }, "loggingSettings": { # Define behaviors on logging. # Settings for logging. Settings for Dialogflow History, Contact Center messages, StackDriver logs, and speech logging. Exposed at the following levels: - Agent level. - "enableInteractionLogging": True or False, # If true, DF Interaction logging is currently enabled. - "enableStackdriverLogging": True or False, # If true, StackDriver logging is currently enabled. + "enableInteractionLogging": True or False, # Enables DF Interaction logging. + "enableStackdriverLogging": True or False, # Enables StackDriver logging. }, "speechSettings": { # Define behaviors of speech to text detection. # Settings for speech to text detection. Exposed at the following levels: - Agent level - Flow level - Page level - Parameter level "endpointerSensitivity": 42, # Sensitivity of the speech model that detects the end of speech. Scale from 0 to 100. @@ -6168,8 +6674,8 @@

Method Details

"maxDigits": 42, # Max length of DTMF digits. }, "loggingSettings": { # Define behaviors on logging. # Settings for logging. Settings for Dialogflow History, Contact Center messages, StackDriver logs, and speech logging. Exposed at the following levels: - Agent level. - "enableInteractionLogging": True or False, # If true, DF Interaction logging is currently enabled. - "enableStackdriverLogging": True or False, # If true, StackDriver logging is currently enabled. + "enableInteractionLogging": True or False, # Enables DF Interaction logging. + "enableStackdriverLogging": True or False, # Enables StackDriver logging. }, "speechSettings": { # Define behaviors of speech to text detection. # Settings for speech to text detection. Exposed at the following levels: - Agent level - Flow level - Page level - Parameter level "endpointerSensitivity": 42, # Sensitivity of the speech model that detects the end of speech. Scale from 0 to 100. @@ -6233,6 +6739,13 @@

Method Details

"A String", ], }, + "toolCall": { # Represents a call of a specific tool's action with the specified inputs. # Returns the definition of a tool call that should be executed by the client. + "action": "A String", # Required. The name of the tool's action associated with this call. + "inputParameters": { # Optional. The action's input parameters. + "a_key": "", # Properties of the object. + }, + "tool": "A String", # Required. The tool associated with this call. Format: `projects//locations//agents//tools/`. + }, }, }, ], @@ -6289,6 +6802,13 @@

Method Details

"A String", ], }, + "toolCall": { # Represents a call of a specific tool's action with the specified inputs. # Returns the definition of a tool call that should be executed by the client. + "action": "A String", # Required. The name of the tool's action associated with this call. + "inputParameters": { # Optional. The action's input parameters. + "a_key": "", # Properties of the object. + }, + "tool": "A String", # Required. The tool associated with this call. Format: `projects//locations//agents//tools/`. + }, }, ], "returnPartialResponses": True or False, # Whether Dialogflow should return currently queued fulfillment response messages in streaming APIs. If a webhook is specified, it happens before Dialogflow invokes webhook. Warning: 1) This flag only affects streaming API. Responses are still queued and returned once in non-streaming API. 2) The flag can be enabled in any fulfillment but only the first 3 partial responses will be returned. You may only want to apply it to fulfillments that have slow webhooks. @@ -6320,8 +6840,8 @@

Method Details

"maxDigits": 42, # Max length of DTMF digits. }, "loggingSettings": { # Define behaviors on logging. # Settings for logging. Settings for Dialogflow History, Contact Center messages, StackDriver logs, and speech logging. Exposed at the following levels: - Agent level. - "enableInteractionLogging": True or False, # If true, DF Interaction logging is currently enabled. - "enableStackdriverLogging": True or False, # If true, StackDriver logging is currently enabled. + "enableInteractionLogging": True or False, # Enables DF Interaction logging. + "enableStackdriverLogging": True or False, # Enables StackDriver logging. }, "speechSettings": { # Define behaviors of speech to text detection. # Settings for speech to text detection. Exposed at the following levels: - Agent level - Flow level - Page level - Parameter level "endpointerSensitivity": 42, # Sensitivity of the speech model that detects the end of speech. Scale from 0 to 100. @@ -6385,6 +6905,13 @@

Method Details

"A String", ], }, + "toolCall": { # Represents a call of a specific tool's action with the specified inputs. # Returns the definition of a tool call that should be executed by the client. + "action": "A String", # Required. The name of the tool's action associated with this call. + "inputParameters": { # Optional. The action's input parameters. + "a_key": "", # Properties of the object. + }, + "tool": "A String", # Required. The tool associated with this call. Format: `projects//locations//agents//tools/`. + }, }, }, ], @@ -6441,6 +6968,13 @@

Method Details

"A String", ], }, + "toolCall": { # Represents a call of a specific tool's action with the specified inputs. # Returns the definition of a tool call that should be executed by the client. + "action": "A String", # Required. The name of the tool's action associated with this call. + "inputParameters": { # Optional. The action's input parameters. + "a_key": "", # Properties of the object. + }, + "tool": "A String", # Required. The tool associated with this call. Format: `projects//locations//agents//tools/`. + }, }, ], "returnPartialResponses": True or False, # Whether Dialogflow should return currently queued fulfillment response messages in streaming APIs. If a webhook is specified, it happens before Dialogflow invokes webhook. Warning: 1) This flag only affects streaming API. Responses are still queued and returned once in non-streaming API. 2) The flag can be enabled in any fulfillment but only the first 3 partial responses will be returned. You may only want to apply it to fulfillments that have slow webhooks. @@ -6470,8 +7004,8 @@

Method Details

"maxDigits": 42, # Max length of DTMF digits. }, "loggingSettings": { # Define behaviors on logging. # Settings for logging. Settings for Dialogflow History, Contact Center messages, StackDriver logs, and speech logging. Exposed at the following levels: - Agent level. - "enableInteractionLogging": True or False, # If true, DF Interaction logging is currently enabled. - "enableStackdriverLogging": True or False, # If true, StackDriver logging is currently enabled. + "enableInteractionLogging": True or False, # Enables DF Interaction logging. + "enableStackdriverLogging": True or False, # Enables StackDriver logging. }, "speechSettings": { # Define behaviors of speech to text detection. # Settings for speech to text detection. Exposed at the following levels: - Agent level - Flow level - Page level - Parameter level "endpointerSensitivity": 42, # Sensitivity of the speech model that detects the end of speech. Scale from 0 to 100. @@ -6499,8 +7033,8 @@

Method Details

"maxDigits": 42, # Max length of DTMF digits. }, "loggingSettings": { # Define behaviors on logging. # Settings for logging. Settings for Dialogflow History, Contact Center messages, StackDriver logs, and speech logging. Exposed at the following levels: - Agent level. - "enableInteractionLogging": True or False, # If true, DF Interaction logging is currently enabled. - "enableStackdriverLogging": True or False, # If true, StackDriver logging is currently enabled. + "enableInteractionLogging": True or False, # Enables DF Interaction logging. + "enableStackdriverLogging": True or False, # Enables StackDriver logging. }, "speechSettings": { # Define behaviors of speech to text detection. # Settings for speech to text detection. Exposed at the following levels: - Agent level - Flow level - Page level - Parameter level "endpointerSensitivity": 42, # Sensitivity of the speech model that detects the end of speech. Scale from 0 to 100. @@ -6564,6 +7098,13 @@

Method Details

"A String", ], }, + "toolCall": { # Represents a call of a specific tool's action with the specified inputs. # Returns the definition of a tool call that should be executed by the client. + "action": "A String", # Required. The name of the tool's action associated with this call. + "inputParameters": { # Optional. The action's input parameters. + "a_key": "", # Properties of the object. + }, + "tool": "A String", # Required. The tool associated with this call. Format: `projects//locations//agents//tools/`. + }, }, }, ], @@ -6620,6 +7161,13 @@

Method Details

"A String", ], }, + "toolCall": { # Represents a call of a specific tool's action with the specified inputs. # Returns the definition of a tool call that should be executed by the client. + "action": "A String", # Required. The name of the tool's action associated with this call. + "inputParameters": { # Optional. The action's input parameters. + "a_key": "", # Properties of the object. + }, + "tool": "A String", # Required. The tool associated with this call. Format: `projects//locations//agents//tools/`. + }, }, ], "returnPartialResponses": True or False, # Whether Dialogflow should return currently queued fulfillment response messages in streaming APIs. If a webhook is specified, it happens before Dialogflow invokes webhook. Warning: 1) This flag only affects streaming API. Responses are still queued and returned once in non-streaming API. 2) The flag can be enabled in any fulfillment but only the first 3 partial responses will be returned. You may only want to apply it to fulfillments that have slow webhooks. @@ -6651,8 +7199,8 @@

Method Details

"maxDigits": 42, # Max length of DTMF digits. }, "loggingSettings": { # Define behaviors on logging. # Settings for logging. Settings for Dialogflow History, Contact Center messages, StackDriver logs, and speech logging. Exposed at the following levels: - Agent level. - "enableInteractionLogging": True or False, # If true, DF Interaction logging is currently enabled. - "enableStackdriverLogging": True or False, # If true, StackDriver logging is currently enabled. + "enableInteractionLogging": True or False, # Enables DF Interaction logging. + "enableStackdriverLogging": True or False, # Enables StackDriver logging. }, "speechSettings": { # Define behaviors of speech to text detection. # Settings for speech to text detection. Exposed at the following levels: - Agent level - Flow level - Page level - Parameter level "endpointerSensitivity": 42, # Sensitivity of the speech model that detects the end of speech. Scale from 0 to 100. @@ -6716,6 +7264,13 @@

Method Details

"A String", ], }, + "toolCall": { # Represents a call of a specific tool's action with the specified inputs. # Returns the definition of a tool call that should be executed by the client. + "action": "A String", # Required. The name of the tool's action associated with this call. + "inputParameters": { # Optional. The action's input parameters. + "a_key": "", # Properties of the object. + }, + "tool": "A String", # Required. The tool associated with this call. Format: `projects//locations//agents//tools/`. + }, }, }, ], @@ -6772,6 +7327,13 @@

Method Details

"A String", ], }, + "toolCall": { # Represents a call of a specific tool's action with the specified inputs. # Returns the definition of a tool call that should be executed by the client. + "action": "A String", # Required. The name of the tool's action associated with this call. + "inputParameters": { # Optional. The action's input parameters. + "a_key": "", # Properties of the object. + }, + "tool": "A String", # Required. The tool associated with this call. Format: `projects//locations//agents//tools/`. + }, }, ], "returnPartialResponses": True or False, # Whether Dialogflow should return currently queued fulfillment response messages in streaming APIs. If a webhook is specified, it happens before Dialogflow invokes webhook. Warning: 1) This flag only affects streaming API. Responses are still queued and returned once in non-streaming API. 2) The flag can be enabled in any fulfillment but only the first 3 partial responses will be returned. You may only want to apply it to fulfillments that have slow webhooks. @@ -6816,8 +7378,8 @@

Method Details

"maxDigits": 42, # Max length of DTMF digits. }, "loggingSettings": { # Define behaviors on logging. # Settings for logging. Settings for Dialogflow History, Contact Center messages, StackDriver logs, and speech logging. Exposed at the following levels: - Agent level. - "enableInteractionLogging": True or False, # If true, DF Interaction logging is currently enabled. - "enableStackdriverLogging": True or False, # If true, StackDriver logging is currently enabled. + "enableInteractionLogging": True or False, # Enables DF Interaction logging. + "enableStackdriverLogging": True or False, # Enables StackDriver logging. }, "speechSettings": { # Define behaviors of speech to text detection. # Settings for speech to text detection. Exposed at the following levels: - Agent level - Flow level - Page level - Parameter level "endpointerSensitivity": 42, # Sensitivity of the speech model that detects the end of speech. Scale from 0 to 100. @@ -6881,6 +7443,13 @@

Method Details

"A String", ], }, + "toolCall": { # Represents a call of a specific tool's action with the specified inputs. # Returns the definition of a tool call that should be executed by the client. + "action": "A String", # Required. The name of the tool's action associated with this call. + "inputParameters": { # Optional. The action's input parameters. + "a_key": "", # Properties of the object. + }, + "tool": "A String", # Required. The tool associated with this call. Format: `projects//locations//agents//tools/`. + }, }, }, ], @@ -6937,6 +7506,13 @@

Method Details

"A String", ], }, + "toolCall": { # Represents a call of a specific tool's action with the specified inputs. # Returns the definition of a tool call that should be executed by the client. + "action": "A String", # Required. The name of the tool's action associated with this call. + "inputParameters": { # Optional. The action's input parameters. + "a_key": "", # Properties of the object. + }, + "tool": "A String", # Required. The tool associated with this call. Format: `projects//locations//agents//tools/`. + }, }, ], "returnPartialResponses": True or False, # Whether Dialogflow should return currently queued fulfillment response messages in streaming APIs. If a webhook is specified, it happens before Dialogflow invokes webhook. Warning: 1) This flag only affects streaming API. Responses are still queued and returned once in non-streaming API. 2) The flag can be enabled in any fulfillment but only the first 3 partial responses will be returned. You may only want to apply it to fulfillments that have slow webhooks. @@ -6975,8 +7551,8 @@

Method Details

"maxDigits": 42, # Max length of DTMF digits. }, "loggingSettings": { # Define behaviors on logging. # Settings for logging. Settings for Dialogflow History, Contact Center messages, StackDriver logs, and speech logging. Exposed at the following levels: - Agent level. - "enableInteractionLogging": True or False, # If true, DF Interaction logging is currently enabled. - "enableStackdriverLogging": True or False, # If true, StackDriver logging is currently enabled. + "enableInteractionLogging": True or False, # Enables DF Interaction logging. + "enableStackdriverLogging": True or False, # Enables StackDriver logging. }, "speechSettings": { # Define behaviors of speech to text detection. # Settings for speech to text detection. Exposed at the following levels: - Agent level - Flow level - Page level - Parameter level "endpointerSensitivity": 42, # Sensitivity of the speech model that detects the end of speech. Scale from 0 to 100. @@ -7040,6 +7616,13 @@

Method Details

"A String", ], }, + "toolCall": { # Represents a call of a specific tool's action with the specified inputs. # Returns the definition of a tool call that should be executed by the client. + "action": "A String", # Required. The name of the tool's action associated with this call. + "inputParameters": { # Optional. The action's input parameters. + "a_key": "", # Properties of the object. + }, + "tool": "A String", # Required. The tool associated with this call. Format: `projects//locations//agents//tools/`. + }, }, }, ], @@ -7096,6 +7679,13 @@

Method Details

"A String", ], }, + "toolCall": { # Represents a call of a specific tool's action with the specified inputs. # Returns the definition of a tool call that should be executed by the client. + "action": "A String", # Required. The name of the tool's action associated with this call. + "inputParameters": { # Optional. The action's input parameters. + "a_key": "", # Properties of the object. + }, + "tool": "A String", # Required. The tool associated with this call. Format: `projects//locations//agents//tools/`. + }, }, ], "returnPartialResponses": True or False, # Whether Dialogflow should return currently queued fulfillment response messages in streaming APIs. If a webhook is specified, it happens before Dialogflow invokes webhook. Warning: 1) This flag only affects streaming API. Responses are still queued and returned once in non-streaming API. 2) The flag can be enabled in any fulfillment but only the first 3 partial responses will be returned. You may only want to apply it to fulfillments that have slow webhooks. @@ -7224,6 +7814,16 @@

Method Details

"text": { # Represents the natural language text to be processed. # The natural language text to be processed. "text": "A String", # Required. The UTF-8 encoded natural language text to be processed. }, + "toolCallResult": { # The result of calling a tool's action that has been executed by the client. # The results of a tool executed by the client. + "action": "A String", # Required. The name of the tool's action associated with this call. + "error": { # An error produced by the tool call. # The tool call's error. + "message": "A String", # Optional. The error message of the function. + }, + "outputParameters": { # The tool call's output parameters. + "a_key": "", # Properties of the object. + }, + "tool": "A String", # Required. The tool associated with this call. Format: `projects//locations//agents//tools/`. + }, }, "isWebhookEnabled": True or False, # If webhooks should be allowed to trigger in response to the user utterance. Often if parameters are injected, webhooks should not be enabled. }, @@ -7241,8 +7841,8 @@

Method Details

"maxDigits": 42, # Max length of DTMF digits. }, "loggingSettings": { # Define behaviors on logging. # Settings for logging. Settings for Dialogflow History, Contact Center messages, StackDriver logs, and speech logging. Exposed at the following levels: - Agent level. - "enableInteractionLogging": True or False, # If true, DF Interaction logging is currently enabled. - "enableStackdriverLogging": True or False, # If true, StackDriver logging is currently enabled. + "enableInteractionLogging": True or False, # Enables DF Interaction logging. + "enableStackdriverLogging": True or False, # Enables StackDriver logging. }, "speechSettings": { # Define behaviors of speech to text detection. # Settings for speech to text detection. Exposed at the following levels: - Agent level - Flow level - Page level - Parameter level "endpointerSensitivity": 42, # Sensitivity of the speech model that detects the end of speech. Scale from 0 to 100. @@ -7268,8 +7868,8 @@

Method Details

"maxDigits": 42, # Max length of DTMF digits. }, "loggingSettings": { # Define behaviors on logging. # Settings for logging. Settings for Dialogflow History, Contact Center messages, StackDriver logs, and speech logging. Exposed at the following levels: - Agent level. - "enableInteractionLogging": True or False, # If true, DF Interaction logging is currently enabled. - "enableStackdriverLogging": True or False, # If true, StackDriver logging is currently enabled. + "enableInteractionLogging": True or False, # Enables DF Interaction logging. + "enableStackdriverLogging": True or False, # Enables StackDriver logging. }, "speechSettings": { # Define behaviors of speech to text detection. # Settings for speech to text detection. Exposed at the following levels: - Agent level - Flow level - Page level - Parameter level "endpointerSensitivity": 42, # Sensitivity of the speech model that detects the end of speech. Scale from 0 to 100. @@ -7333,6 +7933,13 @@

Method Details

"A String", ], }, + "toolCall": { # Represents a call of a specific tool's action with the specified inputs. # Returns the definition of a tool call that should be executed by the client. + "action": "A String", # Required. The name of the tool's action associated with this call. + "inputParameters": { # Optional. The action's input parameters. + "a_key": "", # Properties of the object. + }, + "tool": "A String", # Required. The tool associated with this call. Format: `projects//locations//agents//tools/`. + }, }, }, ], @@ -7389,6 +7996,13 @@

Method Details

"A String", ], }, + "toolCall": { # Represents a call of a specific tool's action with the specified inputs. # Returns the definition of a tool call that should be executed by the client. + "action": "A String", # Required. The name of the tool's action associated with this call. + "inputParameters": { # Optional. The action's input parameters. + "a_key": "", # Properties of the object. + }, + "tool": "A String", # Required. The tool associated with this call. Format: `projects//locations//agents//tools/`. + }, }, ], "returnPartialResponses": True or False, # Whether Dialogflow should return currently queued fulfillment response messages in streaming APIs. If a webhook is specified, it happens before Dialogflow invokes webhook. Warning: 1) This flag only affects streaming API. Responses are still queued and returned once in non-streaming API. 2) The flag can be enabled in any fulfillment but only the first 3 partial responses will be returned. You may only want to apply it to fulfillments that have slow webhooks. @@ -7420,8 +8034,8 @@

Method Details

"maxDigits": 42, # Max length of DTMF digits. }, "loggingSettings": { # Define behaviors on logging. # Settings for logging. Settings for Dialogflow History, Contact Center messages, StackDriver logs, and speech logging. Exposed at the following levels: - Agent level. - "enableInteractionLogging": True or False, # If true, DF Interaction logging is currently enabled. - "enableStackdriverLogging": True or False, # If true, StackDriver logging is currently enabled. + "enableInteractionLogging": True or False, # Enables DF Interaction logging. + "enableStackdriverLogging": True or False, # Enables StackDriver logging. }, "speechSettings": { # Define behaviors of speech to text detection. # Settings for speech to text detection. Exposed at the following levels: - Agent level - Flow level - Page level - Parameter level "endpointerSensitivity": 42, # Sensitivity of the speech model that detects the end of speech. Scale from 0 to 100. @@ -7485,6 +8099,13 @@

Method Details

"A String", ], }, + "toolCall": { # Represents a call of a specific tool's action with the specified inputs. # Returns the definition of a tool call that should be executed by the client. + "action": "A String", # Required. The name of the tool's action associated with this call. + "inputParameters": { # Optional. The action's input parameters. + "a_key": "", # Properties of the object. + }, + "tool": "A String", # Required. The tool associated with this call. Format: `projects//locations//agents//tools/`. + }, }, }, ], @@ -7541,6 +8162,13 @@

Method Details

"A String", ], }, + "toolCall": { # Represents a call of a specific tool's action with the specified inputs. # Returns the definition of a tool call that should be executed by the client. + "action": "A String", # Required. The name of the tool's action associated with this call. + "inputParameters": { # Optional. The action's input parameters. + "a_key": "", # Properties of the object. + }, + "tool": "A String", # Required. The tool associated with this call. Format: `projects//locations//agents//tools/`. + }, }, ], "returnPartialResponses": True or False, # Whether Dialogflow should return currently queued fulfillment response messages in streaming APIs. If a webhook is specified, it happens before Dialogflow invokes webhook. Warning: 1) This flag only affects streaming API. Responses are still queued and returned once in non-streaming API. 2) The flag can be enabled in any fulfillment but only the first 3 partial responses will be returned. You may only want to apply it to fulfillments that have slow webhooks. @@ -7570,8 +8198,8 @@

Method Details

"maxDigits": 42, # Max length of DTMF digits. }, "loggingSettings": { # Define behaviors on logging. # Settings for logging. Settings for Dialogflow History, Contact Center messages, StackDriver logs, and speech logging. Exposed at the following levels: - Agent level. - "enableInteractionLogging": True or False, # If true, DF Interaction logging is currently enabled. - "enableStackdriverLogging": True or False, # If true, StackDriver logging is currently enabled. + "enableInteractionLogging": True or False, # Enables DF Interaction logging. + "enableStackdriverLogging": True or False, # Enables StackDriver logging. }, "speechSettings": { # Define behaviors of speech to text detection. # Settings for speech to text detection. Exposed at the following levels: - Agent level - Flow level - Page level - Parameter level "endpointerSensitivity": 42, # Sensitivity of the speech model that detects the end of speech. Scale from 0 to 100. @@ -7599,8 +8227,8 @@

Method Details

"maxDigits": 42, # Max length of DTMF digits. }, "loggingSettings": { # Define behaviors on logging. # Settings for logging. Settings for Dialogflow History, Contact Center messages, StackDriver logs, and speech logging. Exposed at the following levels: - Agent level. - "enableInteractionLogging": True or False, # If true, DF Interaction logging is currently enabled. - "enableStackdriverLogging": True or False, # If true, StackDriver logging is currently enabled. + "enableInteractionLogging": True or False, # Enables DF Interaction logging. + "enableStackdriverLogging": True or False, # Enables StackDriver logging. }, "speechSettings": { # Define behaviors of speech to text detection. # Settings for speech to text detection. Exposed at the following levels: - Agent level - Flow level - Page level - Parameter level "endpointerSensitivity": 42, # Sensitivity of the speech model that detects the end of speech. Scale from 0 to 100. @@ -7664,6 +8292,13 @@

Method Details

"A String", ], }, + "toolCall": { # Represents a call of a specific tool's action with the specified inputs. # Returns the definition of a tool call that should be executed by the client. + "action": "A String", # Required. The name of the tool's action associated with this call. + "inputParameters": { # Optional. The action's input parameters. + "a_key": "", # Properties of the object. + }, + "tool": "A String", # Required. The tool associated with this call. Format: `projects//locations//agents//tools/`. + }, }, }, ], @@ -7720,6 +8355,13 @@

Method Details

"A String", ], }, + "toolCall": { # Represents a call of a specific tool's action with the specified inputs. # Returns the definition of a tool call that should be executed by the client. + "action": "A String", # Required. The name of the tool's action associated with this call. + "inputParameters": { # Optional. The action's input parameters. + "a_key": "", # Properties of the object. + }, + "tool": "A String", # Required. The tool associated with this call. Format: `projects//locations//agents//tools/`. + }, }, ], "returnPartialResponses": True or False, # Whether Dialogflow should return currently queued fulfillment response messages in streaming APIs. If a webhook is specified, it happens before Dialogflow invokes webhook. Warning: 1) This flag only affects streaming API. Responses are still queued and returned once in non-streaming API. 2) The flag can be enabled in any fulfillment but only the first 3 partial responses will be returned. You may only want to apply it to fulfillments that have slow webhooks. @@ -7751,8 +8393,8 @@

Method Details

"maxDigits": 42, # Max length of DTMF digits. }, "loggingSettings": { # Define behaviors on logging. # Settings for logging. Settings for Dialogflow History, Contact Center messages, StackDriver logs, and speech logging. Exposed at the following levels: - Agent level. - "enableInteractionLogging": True or False, # If true, DF Interaction logging is currently enabled. - "enableStackdriverLogging": True or False, # If true, StackDriver logging is currently enabled. + "enableInteractionLogging": True or False, # Enables DF Interaction logging. + "enableStackdriverLogging": True or False, # Enables StackDriver logging. }, "speechSettings": { # Define behaviors of speech to text detection. # Settings for speech to text detection. Exposed at the following levels: - Agent level - Flow level - Page level - Parameter level "endpointerSensitivity": 42, # Sensitivity of the speech model that detects the end of speech. Scale from 0 to 100. @@ -7816,6 +8458,13 @@

Method Details

"A String", ], }, + "toolCall": { # Represents a call of a specific tool's action with the specified inputs. # Returns the definition of a tool call that should be executed by the client. + "action": "A String", # Required. The name of the tool's action associated with this call. + "inputParameters": { # Optional. The action's input parameters. + "a_key": "", # Properties of the object. + }, + "tool": "A String", # Required. The tool associated with this call. Format: `projects//locations//agents//tools/`. + }, }, }, ], @@ -7872,6 +8521,13 @@

Method Details

"A String", ], }, + "toolCall": { # Represents a call of a specific tool's action with the specified inputs. # Returns the definition of a tool call that should be executed by the client. + "action": "A String", # Required. The name of the tool's action associated with this call. + "inputParameters": { # Optional. The action's input parameters. + "a_key": "", # Properties of the object. + }, + "tool": "A String", # Required. The tool associated with this call. Format: `projects//locations//agents//tools/`. + }, }, ], "returnPartialResponses": True or False, # Whether Dialogflow should return currently queued fulfillment response messages in streaming APIs. If a webhook is specified, it happens before Dialogflow invokes webhook. Warning: 1) This flag only affects streaming API. Responses are still queued and returned once in non-streaming API. 2) The flag can be enabled in any fulfillment but only the first 3 partial responses will be returned. You may only want to apply it to fulfillments that have slow webhooks. @@ -7916,8 +8572,8 @@

Method Details

"maxDigits": 42, # Max length of DTMF digits. }, "loggingSettings": { # Define behaviors on logging. # Settings for logging. Settings for Dialogflow History, Contact Center messages, StackDriver logs, and speech logging. Exposed at the following levels: - Agent level. - "enableInteractionLogging": True or False, # If true, DF Interaction logging is currently enabled. - "enableStackdriverLogging": True or False, # If true, StackDriver logging is currently enabled. + "enableInteractionLogging": True or False, # Enables DF Interaction logging. + "enableStackdriverLogging": True or False, # Enables StackDriver logging. }, "speechSettings": { # Define behaviors of speech to text detection. # Settings for speech to text detection. Exposed at the following levels: - Agent level - Flow level - Page level - Parameter level "endpointerSensitivity": 42, # Sensitivity of the speech model that detects the end of speech. Scale from 0 to 100. @@ -7981,6 +8637,13 @@

Method Details

"A String", ], }, + "toolCall": { # Represents a call of a specific tool's action with the specified inputs. # Returns the definition of a tool call that should be executed by the client. + "action": "A String", # Required. The name of the tool's action associated with this call. + "inputParameters": { # Optional. The action's input parameters. + "a_key": "", # Properties of the object. + }, + "tool": "A String", # Required. The tool associated with this call. Format: `projects//locations//agents//tools/`. + }, }, }, ], @@ -8037,6 +8700,13 @@

Method Details

"A String", ], }, + "toolCall": { # Represents a call of a specific tool's action with the specified inputs. # Returns the definition of a tool call that should be executed by the client. + "action": "A String", # Required. The name of the tool's action associated with this call. + "inputParameters": { # Optional. The action's input parameters. + "a_key": "", # Properties of the object. + }, + "tool": "A String", # Required. The tool associated with this call. Format: `projects//locations//agents//tools/`. + }, }, ], "returnPartialResponses": True or False, # Whether Dialogflow should return currently queued fulfillment response messages in streaming APIs. If a webhook is specified, it happens before Dialogflow invokes webhook. Warning: 1) This flag only affects streaming API. Responses are still queued and returned once in non-streaming API. 2) The flag can be enabled in any fulfillment but only the first 3 partial responses will be returned. You may only want to apply it to fulfillments that have slow webhooks. @@ -8075,8 +8745,8 @@

Method Details

"maxDigits": 42, # Max length of DTMF digits. }, "loggingSettings": { # Define behaviors on logging. # Settings for logging. Settings for Dialogflow History, Contact Center messages, StackDriver logs, and speech logging. Exposed at the following levels: - Agent level. - "enableInteractionLogging": True or False, # If true, DF Interaction logging is currently enabled. - "enableStackdriverLogging": True or False, # If true, StackDriver logging is currently enabled. + "enableInteractionLogging": True or False, # Enables DF Interaction logging. + "enableStackdriverLogging": True or False, # Enables StackDriver logging. }, "speechSettings": { # Define behaviors of speech to text detection. # Settings for speech to text detection. Exposed at the following levels: - Agent level - Flow level - Page level - Parameter level "endpointerSensitivity": 42, # Sensitivity of the speech model that detects the end of speech. Scale from 0 to 100. @@ -8140,6 +8810,13 @@

Method Details

"A String", ], }, + "toolCall": { # Represents a call of a specific tool's action with the specified inputs. # Returns the definition of a tool call that should be executed by the client. + "action": "A String", # Required. The name of the tool's action associated with this call. + "inputParameters": { # Optional. The action's input parameters. + "a_key": "", # Properties of the object. + }, + "tool": "A String", # Required. The tool associated with this call. Format: `projects//locations//agents//tools/`. + }, }, }, ], @@ -8196,6 +8873,13 @@

Method Details

"A String", ], }, + "toolCall": { # Represents a call of a specific tool's action with the specified inputs. # Returns the definition of a tool call that should be executed by the client. + "action": "A String", # Required. The name of the tool's action associated with this call. + "inputParameters": { # Optional. The action's input parameters. + "a_key": "", # Properties of the object. + }, + "tool": "A String", # Required. The tool associated with this call. Format: `projects//locations//agents//tools/`. + }, }, ], "returnPartialResponses": True or False, # Whether Dialogflow should return currently queued fulfillment response messages in streaming APIs. If a webhook is specified, it happens before Dialogflow invokes webhook. Warning: 1) This flag only affects streaming API. Responses are still queued and returned once in non-streaming API. 2) The flag can be enabled in any fulfillment but only the first 3 partial responses will be returned. You may only want to apply it to fulfillments that have slow webhooks. @@ -8386,6 +9070,16 @@

Method Details

"text": { # Represents the natural language text to be processed. # The natural language text to be processed. "text": "A String", # Required. The UTF-8 encoded natural language text to be processed. }, + "toolCallResult": { # The result of calling a tool's action that has been executed by the client. # The results of a tool executed by the client. + "action": "A String", # Required. The name of the tool's action associated with this call. + "error": { # An error produced by the tool call. # The tool call's error. + "message": "A String", # Optional. The error message of the function. + }, + "outputParameters": { # The tool call's output parameters. + "a_key": "", # Properties of the object. + }, + "tool": "A String", # Required. The tool associated with this call. Format: `projects//locations//agents//tools/`. + }, }, "isWebhookEnabled": True or False, # If webhooks should be allowed to trigger in response to the user utterance. Often if parameters are injected, webhooks should not be enabled. }, @@ -8403,8 +9097,8 @@

Method Details

"maxDigits": 42, # Max length of DTMF digits. }, "loggingSettings": { # Define behaviors on logging. # Settings for logging. Settings for Dialogflow History, Contact Center messages, StackDriver logs, and speech logging. Exposed at the following levels: - Agent level. - "enableInteractionLogging": True or False, # If true, DF Interaction logging is currently enabled. - "enableStackdriverLogging": True or False, # If true, StackDriver logging is currently enabled. + "enableInteractionLogging": True or False, # Enables DF Interaction logging. + "enableStackdriverLogging": True or False, # Enables StackDriver logging. }, "speechSettings": { # Define behaviors of speech to text detection. # Settings for speech to text detection. Exposed at the following levels: - Agent level - Flow level - Page level - Parameter level "endpointerSensitivity": 42, # Sensitivity of the speech model that detects the end of speech. Scale from 0 to 100. @@ -8430,8 +9124,8 @@

Method Details

"maxDigits": 42, # Max length of DTMF digits. }, "loggingSettings": { # Define behaviors on logging. # Settings for logging. Settings for Dialogflow History, Contact Center messages, StackDriver logs, and speech logging. Exposed at the following levels: - Agent level. - "enableInteractionLogging": True or False, # If true, DF Interaction logging is currently enabled. - "enableStackdriverLogging": True or False, # If true, StackDriver logging is currently enabled. + "enableInteractionLogging": True or False, # Enables DF Interaction logging. + "enableStackdriverLogging": True or False, # Enables StackDriver logging. }, "speechSettings": { # Define behaviors of speech to text detection. # Settings for speech to text detection. Exposed at the following levels: - Agent level - Flow level - Page level - Parameter level "endpointerSensitivity": 42, # Sensitivity of the speech model that detects the end of speech. Scale from 0 to 100. @@ -8495,6 +9189,13 @@

Method Details

"A String", ], }, + "toolCall": { # Represents a call of a specific tool's action with the specified inputs. # Returns the definition of a tool call that should be executed by the client. + "action": "A String", # Required. The name of the tool's action associated with this call. + "inputParameters": { # Optional. The action's input parameters. + "a_key": "", # Properties of the object. + }, + "tool": "A String", # Required. The tool associated with this call. Format: `projects//locations//agents//tools/`. + }, }, }, ], @@ -8551,6 +9252,13 @@

Method Details

"A String", ], }, + "toolCall": { # Represents a call of a specific tool's action with the specified inputs. # Returns the definition of a tool call that should be executed by the client. + "action": "A String", # Required. The name of the tool's action associated with this call. + "inputParameters": { # Optional. The action's input parameters. + "a_key": "", # Properties of the object. + }, + "tool": "A String", # Required. The tool associated with this call. Format: `projects//locations//agents//tools/`. + }, }, ], "returnPartialResponses": True or False, # Whether Dialogflow should return currently queued fulfillment response messages in streaming APIs. If a webhook is specified, it happens before Dialogflow invokes webhook. Warning: 1) This flag only affects streaming API. Responses are still queued and returned once in non-streaming API. 2) The flag can be enabled in any fulfillment but only the first 3 partial responses will be returned. You may only want to apply it to fulfillments that have slow webhooks. @@ -8582,8 +9290,8 @@

Method Details

"maxDigits": 42, # Max length of DTMF digits. }, "loggingSettings": { # Define behaviors on logging. # Settings for logging. Settings for Dialogflow History, Contact Center messages, StackDriver logs, and speech logging. Exposed at the following levels: - Agent level. - "enableInteractionLogging": True or False, # If true, DF Interaction logging is currently enabled. - "enableStackdriverLogging": True or False, # If true, StackDriver logging is currently enabled. + "enableInteractionLogging": True or False, # Enables DF Interaction logging. + "enableStackdriverLogging": True or False, # Enables StackDriver logging. }, "speechSettings": { # Define behaviors of speech to text detection. # Settings for speech to text detection. Exposed at the following levels: - Agent level - Flow level - Page level - Parameter level "endpointerSensitivity": 42, # Sensitivity of the speech model that detects the end of speech. Scale from 0 to 100. @@ -8647,6 +9355,13 @@

Method Details

"A String", ], }, + "toolCall": { # Represents a call of a specific tool's action with the specified inputs. # Returns the definition of a tool call that should be executed by the client. + "action": "A String", # Required. The name of the tool's action associated with this call. + "inputParameters": { # Optional. The action's input parameters. + "a_key": "", # Properties of the object. + }, + "tool": "A String", # Required. The tool associated with this call. Format: `projects//locations//agents//tools/`. + }, }, }, ], @@ -8703,6 +9418,13 @@

Method Details

"A String", ], }, + "toolCall": { # Represents a call of a specific tool's action with the specified inputs. # Returns the definition of a tool call that should be executed by the client. + "action": "A String", # Required. The name of the tool's action associated with this call. + "inputParameters": { # Optional. The action's input parameters. + "a_key": "", # Properties of the object. + }, + "tool": "A String", # Required. The tool associated with this call. Format: `projects//locations//agents//tools/`. + }, }, ], "returnPartialResponses": True or False, # Whether Dialogflow should return currently queued fulfillment response messages in streaming APIs. If a webhook is specified, it happens before Dialogflow invokes webhook. Warning: 1) This flag only affects streaming API. Responses are still queued and returned once in non-streaming API. 2) The flag can be enabled in any fulfillment but only the first 3 partial responses will be returned. You may only want to apply it to fulfillments that have slow webhooks. @@ -8732,8 +9454,8 @@

Method Details

"maxDigits": 42, # Max length of DTMF digits. }, "loggingSettings": { # Define behaviors on logging. # Settings for logging. Settings for Dialogflow History, Contact Center messages, StackDriver logs, and speech logging. Exposed at the following levels: - Agent level. - "enableInteractionLogging": True or False, # If true, DF Interaction logging is currently enabled. - "enableStackdriverLogging": True or False, # If true, StackDriver logging is currently enabled. + "enableInteractionLogging": True or False, # Enables DF Interaction logging. + "enableStackdriverLogging": True or False, # Enables StackDriver logging. }, "speechSettings": { # Define behaviors of speech to text detection. # Settings for speech to text detection. Exposed at the following levels: - Agent level - Flow level - Page level - Parameter level "endpointerSensitivity": 42, # Sensitivity of the speech model that detects the end of speech. Scale from 0 to 100. @@ -8761,8 +9483,8 @@

Method Details

"maxDigits": 42, # Max length of DTMF digits. }, "loggingSettings": { # Define behaviors on logging. # Settings for logging. Settings for Dialogflow History, Contact Center messages, StackDriver logs, and speech logging. Exposed at the following levels: - Agent level. - "enableInteractionLogging": True or False, # If true, DF Interaction logging is currently enabled. - "enableStackdriverLogging": True or False, # If true, StackDriver logging is currently enabled. + "enableInteractionLogging": True or False, # Enables DF Interaction logging. + "enableStackdriverLogging": True or False, # Enables StackDriver logging. }, "speechSettings": { # Define behaviors of speech to text detection. # Settings for speech to text detection. Exposed at the following levels: - Agent level - Flow level - Page level - Parameter level "endpointerSensitivity": 42, # Sensitivity of the speech model that detects the end of speech. Scale from 0 to 100. @@ -8826,6 +9548,13 @@

Method Details

"A String", ], }, + "toolCall": { # Represents a call of a specific tool's action with the specified inputs. # Returns the definition of a tool call that should be executed by the client. + "action": "A String", # Required. The name of the tool's action associated with this call. + "inputParameters": { # Optional. The action's input parameters. + "a_key": "", # Properties of the object. + }, + "tool": "A String", # Required. The tool associated with this call. Format: `projects//locations//agents//tools/`. + }, }, }, ], @@ -8882,6 +9611,13 @@

Method Details

"A String", ], }, + "toolCall": { # Represents a call of a specific tool's action with the specified inputs. # Returns the definition of a tool call that should be executed by the client. + "action": "A String", # Required. The name of the tool's action associated with this call. + "inputParameters": { # Optional. The action's input parameters. + "a_key": "", # Properties of the object. + }, + "tool": "A String", # Required. The tool associated with this call. Format: `projects//locations//agents//tools/`. + }, }, ], "returnPartialResponses": True or False, # Whether Dialogflow should return currently queued fulfillment response messages in streaming APIs. If a webhook is specified, it happens before Dialogflow invokes webhook. Warning: 1) This flag only affects streaming API. Responses are still queued and returned once in non-streaming API. 2) The flag can be enabled in any fulfillment but only the first 3 partial responses will be returned. You may only want to apply it to fulfillments that have slow webhooks. @@ -8913,8 +9649,8 @@

Method Details

"maxDigits": 42, # Max length of DTMF digits. }, "loggingSettings": { # Define behaviors on logging. # Settings for logging. Settings for Dialogflow History, Contact Center messages, StackDriver logs, and speech logging. Exposed at the following levels: - Agent level. - "enableInteractionLogging": True or False, # If true, DF Interaction logging is currently enabled. - "enableStackdriverLogging": True or False, # If true, StackDriver logging is currently enabled. + "enableInteractionLogging": True or False, # Enables DF Interaction logging. + "enableStackdriverLogging": True or False, # Enables StackDriver logging. }, "speechSettings": { # Define behaviors of speech to text detection. # Settings for speech to text detection. Exposed at the following levels: - Agent level - Flow level - Page level - Parameter level "endpointerSensitivity": 42, # Sensitivity of the speech model that detects the end of speech. Scale from 0 to 100. @@ -8978,6 +9714,13 @@

Method Details

"A String", ], }, + "toolCall": { # Represents a call of a specific tool's action with the specified inputs. # Returns the definition of a tool call that should be executed by the client. + "action": "A String", # Required. The name of the tool's action associated with this call. + "inputParameters": { # Optional. The action's input parameters. + "a_key": "", # Properties of the object. + }, + "tool": "A String", # Required. The tool associated with this call. Format: `projects//locations//agents//tools/`. + }, }, }, ], @@ -9034,6 +9777,13 @@

Method Details

"A String", ], }, + "toolCall": { # Represents a call of a specific tool's action with the specified inputs. # Returns the definition of a tool call that should be executed by the client. + "action": "A String", # Required. The name of the tool's action associated with this call. + "inputParameters": { # Optional. The action's input parameters. + "a_key": "", # Properties of the object. + }, + "tool": "A String", # Required. The tool associated with this call. Format: `projects//locations//agents//tools/`. + }, }, ], "returnPartialResponses": True or False, # Whether Dialogflow should return currently queued fulfillment response messages in streaming APIs. If a webhook is specified, it happens before Dialogflow invokes webhook. Warning: 1) This flag only affects streaming API. Responses are still queued and returned once in non-streaming API. 2) The flag can be enabled in any fulfillment but only the first 3 partial responses will be returned. You may only want to apply it to fulfillments that have slow webhooks. @@ -9078,8 +9828,8 @@

Method Details

"maxDigits": 42, # Max length of DTMF digits. }, "loggingSettings": { # Define behaviors on logging. # Settings for logging. Settings for Dialogflow History, Contact Center messages, StackDriver logs, and speech logging. Exposed at the following levels: - Agent level. - "enableInteractionLogging": True or False, # If true, DF Interaction logging is currently enabled. - "enableStackdriverLogging": True or False, # If true, StackDriver logging is currently enabled. + "enableInteractionLogging": True or False, # Enables DF Interaction logging. + "enableStackdriverLogging": True or False, # Enables StackDriver logging. }, "speechSettings": { # Define behaviors of speech to text detection. # Settings for speech to text detection. Exposed at the following levels: - Agent level - Flow level - Page level - Parameter level "endpointerSensitivity": 42, # Sensitivity of the speech model that detects the end of speech. Scale from 0 to 100. @@ -9143,6 +9893,13 @@

Method Details

"A String", ], }, + "toolCall": { # Represents a call of a specific tool's action with the specified inputs. # Returns the definition of a tool call that should be executed by the client. + "action": "A String", # Required. The name of the tool's action associated with this call. + "inputParameters": { # Optional. The action's input parameters. + "a_key": "", # Properties of the object. + }, + "tool": "A String", # Required. The tool associated with this call. Format: `projects//locations//agents//tools/`. + }, }, }, ], @@ -9199,6 +9956,13 @@

Method Details

"A String", ], }, + "toolCall": { # Represents a call of a specific tool's action with the specified inputs. # Returns the definition of a tool call that should be executed by the client. + "action": "A String", # Required. The name of the tool's action associated with this call. + "inputParameters": { # Optional. The action's input parameters. + "a_key": "", # Properties of the object. + }, + "tool": "A String", # Required. The tool associated with this call. Format: `projects//locations//agents//tools/`. + }, }, ], "returnPartialResponses": True or False, # Whether Dialogflow should return currently queued fulfillment response messages in streaming APIs. If a webhook is specified, it happens before Dialogflow invokes webhook. Warning: 1) This flag only affects streaming API. Responses are still queued and returned once in non-streaming API. 2) The flag can be enabled in any fulfillment but only the first 3 partial responses will be returned. You may only want to apply it to fulfillments that have slow webhooks. @@ -9237,8 +10001,8 @@

Method Details

"maxDigits": 42, # Max length of DTMF digits. }, "loggingSettings": { # Define behaviors on logging. # Settings for logging. Settings for Dialogflow History, Contact Center messages, StackDriver logs, and speech logging. Exposed at the following levels: - Agent level. - "enableInteractionLogging": True or False, # If true, DF Interaction logging is currently enabled. - "enableStackdriverLogging": True or False, # If true, StackDriver logging is currently enabled. + "enableInteractionLogging": True or False, # Enables DF Interaction logging. + "enableStackdriverLogging": True or False, # Enables StackDriver logging. }, "speechSettings": { # Define behaviors of speech to text detection. # Settings for speech to text detection. Exposed at the following levels: - Agent level - Flow level - Page level - Parameter level "endpointerSensitivity": 42, # Sensitivity of the speech model that detects the end of speech. Scale from 0 to 100. @@ -9302,6 +10066,13 @@

Method Details

"A String", ], }, + "toolCall": { # Represents a call of a specific tool's action with the specified inputs. # Returns the definition of a tool call that should be executed by the client. + "action": "A String", # Required. The name of the tool's action associated with this call. + "inputParameters": { # Optional. The action's input parameters. + "a_key": "", # Properties of the object. + }, + "tool": "A String", # Required. The tool associated with this call. Format: `projects//locations//agents//tools/`. + }, }, }, ], @@ -9358,6 +10129,13 @@

Method Details

"A String", ], }, + "toolCall": { # Represents a call of a specific tool's action with the specified inputs. # Returns the definition of a tool call that should be executed by the client. + "action": "A String", # Required. The name of the tool's action associated with this call. + "inputParameters": { # Optional. The action's input parameters. + "a_key": "", # Properties of the object. + }, + "tool": "A String", # Required. The tool associated with this call. Format: `projects//locations//agents//tools/`. + }, }, ], "returnPartialResponses": True or False, # Whether Dialogflow should return currently queued fulfillment response messages in streaming APIs. If a webhook is specified, it happens before Dialogflow invokes webhook. Warning: 1) This flag only affects streaming API. Responses are still queued and returned once in non-streaming API. 2) The flag can be enabled in any fulfillment but only the first 3 partial responses will be returned. You may only want to apply it to fulfillments that have slow webhooks. @@ -9486,6 +10264,16 @@

Method Details

"text": { # Represents the natural language text to be processed. # The natural language text to be processed. "text": "A String", # Required. The UTF-8 encoded natural language text to be processed. }, + "toolCallResult": { # The result of calling a tool's action that has been executed by the client. # The results of a tool executed by the client. + "action": "A String", # Required. The name of the tool's action associated with this call. + "error": { # An error produced by the tool call. # The tool call's error. + "message": "A String", # Optional. The error message of the function. + }, + "outputParameters": { # The tool call's output parameters. + "a_key": "", # Properties of the object. + }, + "tool": "A String", # Required. The tool associated with this call. Format: `projects//locations//agents//tools/`. + }, }, "isWebhookEnabled": True or False, # If webhooks should be allowed to trigger in response to the user utterance. Often if parameters are injected, webhooks should not be enabled. }, @@ -9503,8 +10291,8 @@

Method Details

"maxDigits": 42, # Max length of DTMF digits. }, "loggingSettings": { # Define behaviors on logging. # Settings for logging. Settings for Dialogflow History, Contact Center messages, StackDriver logs, and speech logging. Exposed at the following levels: - Agent level. - "enableInteractionLogging": True or False, # If true, DF Interaction logging is currently enabled. - "enableStackdriverLogging": True or False, # If true, StackDriver logging is currently enabled. + "enableInteractionLogging": True or False, # Enables DF Interaction logging. + "enableStackdriverLogging": True or False, # Enables StackDriver logging. }, "speechSettings": { # Define behaviors of speech to text detection. # Settings for speech to text detection. Exposed at the following levels: - Agent level - Flow level - Page level - Parameter level "endpointerSensitivity": 42, # Sensitivity of the speech model that detects the end of speech. Scale from 0 to 100. @@ -9530,8 +10318,8 @@

Method Details

"maxDigits": 42, # Max length of DTMF digits. }, "loggingSettings": { # Define behaviors on logging. # Settings for logging. Settings for Dialogflow History, Contact Center messages, StackDriver logs, and speech logging. Exposed at the following levels: - Agent level. - "enableInteractionLogging": True or False, # If true, DF Interaction logging is currently enabled. - "enableStackdriverLogging": True or False, # If true, StackDriver logging is currently enabled. + "enableInteractionLogging": True or False, # Enables DF Interaction logging. + "enableStackdriverLogging": True or False, # Enables StackDriver logging. }, "speechSettings": { # Define behaviors of speech to text detection. # Settings for speech to text detection. Exposed at the following levels: - Agent level - Flow level - Page level - Parameter level "endpointerSensitivity": 42, # Sensitivity of the speech model that detects the end of speech. Scale from 0 to 100. @@ -9595,6 +10383,13 @@

Method Details

"A String", ], }, + "toolCall": { # Represents a call of a specific tool's action with the specified inputs. # Returns the definition of a tool call that should be executed by the client. + "action": "A String", # Required. The name of the tool's action associated with this call. + "inputParameters": { # Optional. The action's input parameters. + "a_key": "", # Properties of the object. + }, + "tool": "A String", # Required. The tool associated with this call. Format: `projects//locations//agents//tools/`. + }, }, }, ], @@ -9651,6 +10446,13 @@

Method Details

"A String", ], }, + "toolCall": { # Represents a call of a specific tool's action with the specified inputs. # Returns the definition of a tool call that should be executed by the client. + "action": "A String", # Required. The name of the tool's action associated with this call. + "inputParameters": { # Optional. The action's input parameters. + "a_key": "", # Properties of the object. + }, + "tool": "A String", # Required. The tool associated with this call. Format: `projects//locations//agents//tools/`. + }, }, ], "returnPartialResponses": True or False, # Whether Dialogflow should return currently queued fulfillment response messages in streaming APIs. If a webhook is specified, it happens before Dialogflow invokes webhook. Warning: 1) This flag only affects streaming API. Responses are still queued and returned once in non-streaming API. 2) The flag can be enabled in any fulfillment but only the first 3 partial responses will be returned. You may only want to apply it to fulfillments that have slow webhooks. @@ -9682,8 +10484,8 @@

Method Details

"maxDigits": 42, # Max length of DTMF digits. }, "loggingSettings": { # Define behaviors on logging. # Settings for logging. Settings for Dialogflow History, Contact Center messages, StackDriver logs, and speech logging. Exposed at the following levels: - Agent level. - "enableInteractionLogging": True or False, # If true, DF Interaction logging is currently enabled. - "enableStackdriverLogging": True or False, # If true, StackDriver logging is currently enabled. + "enableInteractionLogging": True or False, # Enables DF Interaction logging. + "enableStackdriverLogging": True or False, # Enables StackDriver logging. }, "speechSettings": { # Define behaviors of speech to text detection. # Settings for speech to text detection. Exposed at the following levels: - Agent level - Flow level - Page level - Parameter level "endpointerSensitivity": 42, # Sensitivity of the speech model that detects the end of speech. Scale from 0 to 100. @@ -9747,6 +10549,13 @@

Method Details

"A String", ], }, + "toolCall": { # Represents a call of a specific tool's action with the specified inputs. # Returns the definition of a tool call that should be executed by the client. + "action": "A String", # Required. The name of the tool's action associated with this call. + "inputParameters": { # Optional. The action's input parameters. + "a_key": "", # Properties of the object. + }, + "tool": "A String", # Required. The tool associated with this call. Format: `projects//locations//agents//tools/`. + }, }, }, ], @@ -9803,6 +10612,13 @@

Method Details

"A String", ], }, + "toolCall": { # Represents a call of a specific tool's action with the specified inputs. # Returns the definition of a tool call that should be executed by the client. + "action": "A String", # Required. The name of the tool's action associated with this call. + "inputParameters": { # Optional. The action's input parameters. + "a_key": "", # Properties of the object. + }, + "tool": "A String", # Required. The tool associated with this call. Format: `projects//locations//agents//tools/`. + }, }, ], "returnPartialResponses": True or False, # Whether Dialogflow should return currently queued fulfillment response messages in streaming APIs. If a webhook is specified, it happens before Dialogflow invokes webhook. Warning: 1) This flag only affects streaming API. Responses are still queued and returned once in non-streaming API. 2) The flag can be enabled in any fulfillment but only the first 3 partial responses will be returned. You may only want to apply it to fulfillments that have slow webhooks. @@ -9832,8 +10648,8 @@

Method Details

"maxDigits": 42, # Max length of DTMF digits. }, "loggingSettings": { # Define behaviors on logging. # Settings for logging. Settings for Dialogflow History, Contact Center messages, StackDriver logs, and speech logging. Exposed at the following levels: - Agent level. - "enableInteractionLogging": True or False, # If true, DF Interaction logging is currently enabled. - "enableStackdriverLogging": True or False, # If true, StackDriver logging is currently enabled. + "enableInteractionLogging": True or False, # Enables DF Interaction logging. + "enableStackdriverLogging": True or False, # Enables StackDriver logging. }, "speechSettings": { # Define behaviors of speech to text detection. # Settings for speech to text detection. Exposed at the following levels: - Agent level - Flow level - Page level - Parameter level "endpointerSensitivity": 42, # Sensitivity of the speech model that detects the end of speech. Scale from 0 to 100. @@ -9861,8 +10677,8 @@

Method Details

"maxDigits": 42, # Max length of DTMF digits. }, "loggingSettings": { # Define behaviors on logging. # Settings for logging. Settings for Dialogflow History, Contact Center messages, StackDriver logs, and speech logging. Exposed at the following levels: - Agent level. - "enableInteractionLogging": True or False, # If true, DF Interaction logging is currently enabled. - "enableStackdriverLogging": True or False, # If true, StackDriver logging is currently enabled. + "enableInteractionLogging": True or False, # Enables DF Interaction logging. + "enableStackdriverLogging": True or False, # Enables StackDriver logging. }, "speechSettings": { # Define behaviors of speech to text detection. # Settings for speech to text detection. Exposed at the following levels: - Agent level - Flow level - Page level - Parameter level "endpointerSensitivity": 42, # Sensitivity of the speech model that detects the end of speech. Scale from 0 to 100. @@ -9926,6 +10742,13 @@

Method Details

"A String", ], }, + "toolCall": { # Represents a call of a specific tool's action with the specified inputs. # Returns the definition of a tool call that should be executed by the client. + "action": "A String", # Required. The name of the tool's action associated with this call. + "inputParameters": { # Optional. The action's input parameters. + "a_key": "", # Properties of the object. + }, + "tool": "A String", # Required. The tool associated with this call. Format: `projects//locations//agents//tools/`. + }, }, }, ], @@ -9982,6 +10805,13 @@

Method Details

"A String", ], }, + "toolCall": { # Represents a call of a specific tool's action with the specified inputs. # Returns the definition of a tool call that should be executed by the client. + "action": "A String", # Required. The name of the tool's action associated with this call. + "inputParameters": { # Optional. The action's input parameters. + "a_key": "", # Properties of the object. + }, + "tool": "A String", # Required. The tool associated with this call. Format: `projects//locations//agents//tools/`. + }, }, ], "returnPartialResponses": True or False, # Whether Dialogflow should return currently queued fulfillment response messages in streaming APIs. If a webhook is specified, it happens before Dialogflow invokes webhook. Warning: 1) This flag only affects streaming API. Responses are still queued and returned once in non-streaming API. 2) The flag can be enabled in any fulfillment but only the first 3 partial responses will be returned. You may only want to apply it to fulfillments that have slow webhooks. @@ -10013,8 +10843,8 @@

Method Details

"maxDigits": 42, # Max length of DTMF digits. }, "loggingSettings": { # Define behaviors on logging. # Settings for logging. Settings for Dialogflow History, Contact Center messages, StackDriver logs, and speech logging. Exposed at the following levels: - Agent level. - "enableInteractionLogging": True or False, # If true, DF Interaction logging is currently enabled. - "enableStackdriverLogging": True or False, # If true, StackDriver logging is currently enabled. + "enableInteractionLogging": True or False, # Enables DF Interaction logging. + "enableStackdriverLogging": True or False, # Enables StackDriver logging. }, "speechSettings": { # Define behaviors of speech to text detection. # Settings for speech to text detection. Exposed at the following levels: - Agent level - Flow level - Page level - Parameter level "endpointerSensitivity": 42, # Sensitivity of the speech model that detects the end of speech. Scale from 0 to 100. @@ -10078,6 +10908,13 @@

Method Details

"A String", ], }, + "toolCall": { # Represents a call of a specific tool's action with the specified inputs. # Returns the definition of a tool call that should be executed by the client. + "action": "A String", # Required. The name of the tool's action associated with this call. + "inputParameters": { # Optional. The action's input parameters. + "a_key": "", # Properties of the object. + }, + "tool": "A String", # Required. The tool associated with this call. Format: `projects//locations//agents//tools/`. + }, }, }, ], @@ -10134,6 +10971,13 @@

Method Details

"A String", ], }, + "toolCall": { # Represents a call of a specific tool's action with the specified inputs. # Returns the definition of a tool call that should be executed by the client. + "action": "A String", # Required. The name of the tool's action associated with this call. + "inputParameters": { # Optional. The action's input parameters. + "a_key": "", # Properties of the object. + }, + "tool": "A String", # Required. The tool associated with this call. Format: `projects//locations//agents//tools/`. + }, }, ], "returnPartialResponses": True or False, # Whether Dialogflow should return currently queued fulfillment response messages in streaming APIs. If a webhook is specified, it happens before Dialogflow invokes webhook. Warning: 1) This flag only affects streaming API. Responses are still queued and returned once in non-streaming API. 2) The flag can be enabled in any fulfillment but only the first 3 partial responses will be returned. You may only want to apply it to fulfillments that have slow webhooks. @@ -10178,8 +11022,8 @@

Method Details

"maxDigits": 42, # Max length of DTMF digits. }, "loggingSettings": { # Define behaviors on logging. # Settings for logging. Settings for Dialogflow History, Contact Center messages, StackDriver logs, and speech logging. Exposed at the following levels: - Agent level. - "enableInteractionLogging": True or False, # If true, DF Interaction logging is currently enabled. - "enableStackdriverLogging": True or False, # If true, StackDriver logging is currently enabled. + "enableInteractionLogging": True or False, # Enables DF Interaction logging. + "enableStackdriverLogging": True or False, # Enables StackDriver logging. }, "speechSettings": { # Define behaviors of speech to text detection. # Settings for speech to text detection. Exposed at the following levels: - Agent level - Flow level - Page level - Parameter level "endpointerSensitivity": 42, # Sensitivity of the speech model that detects the end of speech. Scale from 0 to 100. @@ -10243,6 +11087,13 @@

Method Details

"A String", ], }, + "toolCall": { # Represents a call of a specific tool's action with the specified inputs. # Returns the definition of a tool call that should be executed by the client. + "action": "A String", # Required. The name of the tool's action associated with this call. + "inputParameters": { # Optional. The action's input parameters. + "a_key": "", # Properties of the object. + }, + "tool": "A String", # Required. The tool associated with this call. Format: `projects//locations//agents//tools/`. + }, }, }, ], @@ -10299,6 +11150,13 @@

Method Details

"A String", ], }, + "toolCall": { # Represents a call of a specific tool's action with the specified inputs. # Returns the definition of a tool call that should be executed by the client. + "action": "A String", # Required. The name of the tool's action associated with this call. + "inputParameters": { # Optional. The action's input parameters. + "a_key": "", # Properties of the object. + }, + "tool": "A String", # Required. The tool associated with this call. Format: `projects//locations//agents//tools/`. + }, }, ], "returnPartialResponses": True or False, # Whether Dialogflow should return currently queued fulfillment response messages in streaming APIs. If a webhook is specified, it happens before Dialogflow invokes webhook. Warning: 1) This flag only affects streaming API. Responses are still queued and returned once in non-streaming API. 2) The flag can be enabled in any fulfillment but only the first 3 partial responses will be returned. You may only want to apply it to fulfillments that have slow webhooks. @@ -10337,8 +11195,8 @@

Method Details

"maxDigits": 42, # Max length of DTMF digits. }, "loggingSettings": { # Define behaviors on logging. # Settings for logging. Settings for Dialogflow History, Contact Center messages, StackDriver logs, and speech logging. Exposed at the following levels: - Agent level. - "enableInteractionLogging": True or False, # If true, DF Interaction logging is currently enabled. - "enableStackdriverLogging": True or False, # If true, StackDriver logging is currently enabled. + "enableInteractionLogging": True or False, # Enables DF Interaction logging. + "enableStackdriverLogging": True or False, # Enables StackDriver logging. }, "speechSettings": { # Define behaviors of speech to text detection. # Settings for speech to text detection. Exposed at the following levels: - Agent level - Flow level - Page level - Parameter level "endpointerSensitivity": 42, # Sensitivity of the speech model that detects the end of speech. Scale from 0 to 100. @@ -10402,6 +11260,13 @@

Method Details

"A String", ], }, + "toolCall": { # Represents a call of a specific tool's action with the specified inputs. # Returns the definition of a tool call that should be executed by the client. + "action": "A String", # Required. The name of the tool's action associated with this call. + "inputParameters": { # Optional. The action's input parameters. + "a_key": "", # Properties of the object. + }, + "tool": "A String", # Required. The tool associated with this call. Format: `projects//locations//agents//tools/`. + }, }, }, ], @@ -10458,6 +11323,13 @@

Method Details

"A String", ], }, + "toolCall": { # Represents a call of a specific tool's action with the specified inputs. # Returns the definition of a tool call that should be executed by the client. + "action": "A String", # Required. The name of the tool's action associated with this call. + "inputParameters": { # Optional. The action's input parameters. + "a_key": "", # Properties of the object. + }, + "tool": "A String", # Required. The tool associated with this call. Format: `projects//locations//agents//tools/`. + }, }, ], "returnPartialResponses": True or False, # Whether Dialogflow should return currently queued fulfillment response messages in streaming APIs. If a webhook is specified, it happens before Dialogflow invokes webhook. Warning: 1) This flag only affects streaming API. Responses are still queued and returned once in non-streaming API. 2) The flag can be enabled in any fulfillment but only the first 3 partial responses will be returned. You may only want to apply it to fulfillments that have slow webhooks. @@ -10657,6 +11529,16 @@

Method Details

"text": { # Represents the natural language text to be processed. # The natural language text to be processed. "text": "A String", # Required. The UTF-8 encoded natural language text to be processed. }, + "toolCallResult": { # The result of calling a tool's action that has been executed by the client. # The results of a tool executed by the client. + "action": "A String", # Required. The name of the tool's action associated with this call. + "error": { # An error produced by the tool call. # The tool call's error. + "message": "A String", # Optional. The error message of the function. + }, + "outputParameters": { # The tool call's output parameters. + "a_key": "", # Properties of the object. + }, + "tool": "A String", # Required. The tool associated with this call. Format: `projects//locations//agents//tools/`. + }, }, "isWebhookEnabled": True or False, # If webhooks should be allowed to trigger in response to the user utterance. Often if parameters are injected, webhooks should not be enabled. }, @@ -10674,8 +11556,8 @@

Method Details

"maxDigits": 42, # Max length of DTMF digits. }, "loggingSettings": { # Define behaviors on logging. # Settings for logging. Settings for Dialogflow History, Contact Center messages, StackDriver logs, and speech logging. Exposed at the following levels: - Agent level. - "enableInteractionLogging": True or False, # If true, DF Interaction logging is currently enabled. - "enableStackdriverLogging": True or False, # If true, StackDriver logging is currently enabled. + "enableInteractionLogging": True or False, # Enables DF Interaction logging. + "enableStackdriverLogging": True or False, # Enables StackDriver logging. }, "speechSettings": { # Define behaviors of speech to text detection. # Settings for speech to text detection. Exposed at the following levels: - Agent level - Flow level - Page level - Parameter level "endpointerSensitivity": 42, # Sensitivity of the speech model that detects the end of speech. Scale from 0 to 100. @@ -10701,8 +11583,8 @@

Method Details

"maxDigits": 42, # Max length of DTMF digits. }, "loggingSettings": { # Define behaviors on logging. # Settings for logging. Settings for Dialogflow History, Contact Center messages, StackDriver logs, and speech logging. Exposed at the following levels: - Agent level. - "enableInteractionLogging": True or False, # If true, DF Interaction logging is currently enabled. - "enableStackdriverLogging": True or False, # If true, StackDriver logging is currently enabled. + "enableInteractionLogging": True or False, # Enables DF Interaction logging. + "enableStackdriverLogging": True or False, # Enables StackDriver logging. }, "speechSettings": { # Define behaviors of speech to text detection. # Settings for speech to text detection. Exposed at the following levels: - Agent level - Flow level - Page level - Parameter level "endpointerSensitivity": 42, # Sensitivity of the speech model that detects the end of speech. Scale from 0 to 100. @@ -10766,6 +11648,13 @@

Method Details

"A String", ], }, + "toolCall": { # Represents a call of a specific tool's action with the specified inputs. # Returns the definition of a tool call that should be executed by the client. + "action": "A String", # Required. The name of the tool's action associated with this call. + "inputParameters": { # Optional. The action's input parameters. + "a_key": "", # Properties of the object. + }, + "tool": "A String", # Required. The tool associated with this call. Format: `projects//locations//agents//tools/`. + }, }, }, ], @@ -10822,6 +11711,13 @@

Method Details

"A String", ], }, + "toolCall": { # Represents a call of a specific tool's action with the specified inputs. # Returns the definition of a tool call that should be executed by the client. + "action": "A String", # Required. The name of the tool's action associated with this call. + "inputParameters": { # Optional. The action's input parameters. + "a_key": "", # Properties of the object. + }, + "tool": "A String", # Required. The tool associated with this call. Format: `projects//locations//agents//tools/`. + }, }, ], "returnPartialResponses": True or False, # Whether Dialogflow should return currently queued fulfillment response messages in streaming APIs. If a webhook is specified, it happens before Dialogflow invokes webhook. Warning: 1) This flag only affects streaming API. Responses are still queued and returned once in non-streaming API. 2) The flag can be enabled in any fulfillment but only the first 3 partial responses will be returned. You may only want to apply it to fulfillments that have slow webhooks. @@ -10853,8 +11749,8 @@

Method Details

"maxDigits": 42, # Max length of DTMF digits. }, "loggingSettings": { # Define behaviors on logging. # Settings for logging. Settings for Dialogflow History, Contact Center messages, StackDriver logs, and speech logging. Exposed at the following levels: - Agent level. - "enableInteractionLogging": True or False, # If true, DF Interaction logging is currently enabled. - "enableStackdriverLogging": True or False, # If true, StackDriver logging is currently enabled. + "enableInteractionLogging": True or False, # Enables DF Interaction logging. + "enableStackdriverLogging": True or False, # Enables StackDriver logging. }, "speechSettings": { # Define behaviors of speech to text detection. # Settings for speech to text detection. Exposed at the following levels: - Agent level - Flow level - Page level - Parameter level "endpointerSensitivity": 42, # Sensitivity of the speech model that detects the end of speech. Scale from 0 to 100. @@ -10918,6 +11814,13 @@

Method Details

"A String", ], }, + "toolCall": { # Represents a call of a specific tool's action with the specified inputs. # Returns the definition of a tool call that should be executed by the client. + "action": "A String", # Required. The name of the tool's action associated with this call. + "inputParameters": { # Optional. The action's input parameters. + "a_key": "", # Properties of the object. + }, + "tool": "A String", # Required. The tool associated with this call. Format: `projects//locations//agents//tools/`. + }, }, }, ], @@ -10974,6 +11877,13 @@

Method Details

"A String", ], }, + "toolCall": { # Represents a call of a specific tool's action with the specified inputs. # Returns the definition of a tool call that should be executed by the client. + "action": "A String", # Required. The name of the tool's action associated with this call. + "inputParameters": { # Optional. The action's input parameters. + "a_key": "", # Properties of the object. + }, + "tool": "A String", # Required. The tool associated with this call. Format: `projects//locations//agents//tools/`. + }, }, ], "returnPartialResponses": True or False, # Whether Dialogflow should return currently queued fulfillment response messages in streaming APIs. If a webhook is specified, it happens before Dialogflow invokes webhook. Warning: 1) This flag only affects streaming API. Responses are still queued and returned once in non-streaming API. 2) The flag can be enabled in any fulfillment but only the first 3 partial responses will be returned. You may only want to apply it to fulfillments that have slow webhooks. @@ -11003,8 +11913,8 @@

Method Details

"maxDigits": 42, # Max length of DTMF digits. }, "loggingSettings": { # Define behaviors on logging. # Settings for logging. Settings for Dialogflow History, Contact Center messages, StackDriver logs, and speech logging. Exposed at the following levels: - Agent level. - "enableInteractionLogging": True or False, # If true, DF Interaction logging is currently enabled. - "enableStackdriverLogging": True or False, # If true, StackDriver logging is currently enabled. + "enableInteractionLogging": True or False, # Enables DF Interaction logging. + "enableStackdriverLogging": True or False, # Enables StackDriver logging. }, "speechSettings": { # Define behaviors of speech to text detection. # Settings for speech to text detection. Exposed at the following levels: - Agent level - Flow level - Page level - Parameter level "endpointerSensitivity": 42, # Sensitivity of the speech model that detects the end of speech. Scale from 0 to 100. @@ -11032,8 +11942,8 @@

Method Details

"maxDigits": 42, # Max length of DTMF digits. }, "loggingSettings": { # Define behaviors on logging. # Settings for logging. Settings for Dialogflow History, Contact Center messages, StackDriver logs, and speech logging. Exposed at the following levels: - Agent level. - "enableInteractionLogging": True or False, # If true, DF Interaction logging is currently enabled. - "enableStackdriverLogging": True or False, # If true, StackDriver logging is currently enabled. + "enableInteractionLogging": True or False, # Enables DF Interaction logging. + "enableStackdriverLogging": True or False, # Enables StackDriver logging. }, "speechSettings": { # Define behaviors of speech to text detection. # Settings for speech to text detection. Exposed at the following levels: - Agent level - Flow level - Page level - Parameter level "endpointerSensitivity": 42, # Sensitivity of the speech model that detects the end of speech. Scale from 0 to 100. @@ -11097,6 +12007,13 @@

Method Details

"A String", ], }, + "toolCall": { # Represents a call of a specific tool's action with the specified inputs. # Returns the definition of a tool call that should be executed by the client. + "action": "A String", # Required. The name of the tool's action associated with this call. + "inputParameters": { # Optional. The action's input parameters. + "a_key": "", # Properties of the object. + }, + "tool": "A String", # Required. The tool associated with this call. Format: `projects//locations//agents//tools/`. + }, }, }, ], @@ -11153,6 +12070,13 @@

Method Details

"A String", ], }, + "toolCall": { # Represents a call of a specific tool's action with the specified inputs. # Returns the definition of a tool call that should be executed by the client. + "action": "A String", # Required. The name of the tool's action associated with this call. + "inputParameters": { # Optional. The action's input parameters. + "a_key": "", # Properties of the object. + }, + "tool": "A String", # Required. The tool associated with this call. Format: `projects//locations//agents//tools/`. + }, }, ], "returnPartialResponses": True or False, # Whether Dialogflow should return currently queued fulfillment response messages in streaming APIs. If a webhook is specified, it happens before Dialogflow invokes webhook. Warning: 1) This flag only affects streaming API. Responses are still queued and returned once in non-streaming API. 2) The flag can be enabled in any fulfillment but only the first 3 partial responses will be returned. You may only want to apply it to fulfillments that have slow webhooks. @@ -11184,8 +12108,8 @@

Method Details

"maxDigits": 42, # Max length of DTMF digits. }, "loggingSettings": { # Define behaviors on logging. # Settings for logging. Settings for Dialogflow History, Contact Center messages, StackDriver logs, and speech logging. Exposed at the following levels: - Agent level. - "enableInteractionLogging": True or False, # If true, DF Interaction logging is currently enabled. - "enableStackdriverLogging": True or False, # If true, StackDriver logging is currently enabled. + "enableInteractionLogging": True or False, # Enables DF Interaction logging. + "enableStackdriverLogging": True or False, # Enables StackDriver logging. }, "speechSettings": { # Define behaviors of speech to text detection. # Settings for speech to text detection. Exposed at the following levels: - Agent level - Flow level - Page level - Parameter level "endpointerSensitivity": 42, # Sensitivity of the speech model that detects the end of speech. Scale from 0 to 100. @@ -11249,6 +12173,13 @@

Method Details

"A String", ], }, + "toolCall": { # Represents a call of a specific tool's action with the specified inputs. # Returns the definition of a tool call that should be executed by the client. + "action": "A String", # Required. The name of the tool's action associated with this call. + "inputParameters": { # Optional. The action's input parameters. + "a_key": "", # Properties of the object. + }, + "tool": "A String", # Required. The tool associated with this call. Format: `projects//locations//agents//tools/`. + }, }, }, ], @@ -11305,6 +12236,13 @@

Method Details

"A String", ], }, + "toolCall": { # Represents a call of a specific tool's action with the specified inputs. # Returns the definition of a tool call that should be executed by the client. + "action": "A String", # Required. The name of the tool's action associated with this call. + "inputParameters": { # Optional. The action's input parameters. + "a_key": "", # Properties of the object. + }, + "tool": "A String", # Required. The tool associated with this call. Format: `projects//locations//agents//tools/`. + }, }, ], "returnPartialResponses": True or False, # Whether Dialogflow should return currently queued fulfillment response messages in streaming APIs. If a webhook is specified, it happens before Dialogflow invokes webhook. Warning: 1) This flag only affects streaming API. Responses are still queued and returned once in non-streaming API. 2) The flag can be enabled in any fulfillment but only the first 3 partial responses will be returned. You may only want to apply it to fulfillments that have slow webhooks. @@ -11349,8 +12287,8 @@

Method Details

"maxDigits": 42, # Max length of DTMF digits. }, "loggingSettings": { # Define behaviors on logging. # Settings for logging. Settings for Dialogflow History, Contact Center messages, StackDriver logs, and speech logging. Exposed at the following levels: - Agent level. - "enableInteractionLogging": True or False, # If true, DF Interaction logging is currently enabled. - "enableStackdriverLogging": True or False, # If true, StackDriver logging is currently enabled. + "enableInteractionLogging": True or False, # Enables DF Interaction logging. + "enableStackdriverLogging": True or False, # Enables StackDriver logging. }, "speechSettings": { # Define behaviors of speech to text detection. # Settings for speech to text detection. Exposed at the following levels: - Agent level - Flow level - Page level - Parameter level "endpointerSensitivity": 42, # Sensitivity of the speech model that detects the end of speech. Scale from 0 to 100. @@ -11414,6 +12352,13 @@

Method Details

"A String", ], }, + "toolCall": { # Represents a call of a specific tool's action with the specified inputs. # Returns the definition of a tool call that should be executed by the client. + "action": "A String", # Required. The name of the tool's action associated with this call. + "inputParameters": { # Optional. The action's input parameters. + "a_key": "", # Properties of the object. + }, + "tool": "A String", # Required. The tool associated with this call. Format: `projects//locations//agents//tools/`. + }, }, }, ], @@ -11470,6 +12415,13 @@

Method Details

"A String", ], }, + "toolCall": { # Represents a call of a specific tool's action with the specified inputs. # Returns the definition of a tool call that should be executed by the client. + "action": "A String", # Required. The name of the tool's action associated with this call. + "inputParameters": { # Optional. The action's input parameters. + "a_key": "", # Properties of the object. + }, + "tool": "A String", # Required. The tool associated with this call. Format: `projects//locations//agents//tools/`. + }, }, ], "returnPartialResponses": True or False, # Whether Dialogflow should return currently queued fulfillment response messages in streaming APIs. If a webhook is specified, it happens before Dialogflow invokes webhook. Warning: 1) This flag only affects streaming API. Responses are still queued and returned once in non-streaming API. 2) The flag can be enabled in any fulfillment but only the first 3 partial responses will be returned. You may only want to apply it to fulfillments that have slow webhooks. @@ -11508,8 +12460,8 @@

Method Details

"maxDigits": 42, # Max length of DTMF digits. }, "loggingSettings": { # Define behaviors on logging. # Settings for logging. Settings for Dialogflow History, Contact Center messages, StackDriver logs, and speech logging. Exposed at the following levels: - Agent level. - "enableInteractionLogging": True or False, # If true, DF Interaction logging is currently enabled. - "enableStackdriverLogging": True or False, # If true, StackDriver logging is currently enabled. + "enableInteractionLogging": True or False, # Enables DF Interaction logging. + "enableStackdriverLogging": True or False, # Enables StackDriver logging. }, "speechSettings": { # Define behaviors of speech to text detection. # Settings for speech to text detection. Exposed at the following levels: - Agent level - Flow level - Page level - Parameter level "endpointerSensitivity": 42, # Sensitivity of the speech model that detects the end of speech. Scale from 0 to 100. @@ -11573,6 +12525,13 @@

Method Details

"A String", ], }, + "toolCall": { # Represents a call of a specific tool's action with the specified inputs. # Returns the definition of a tool call that should be executed by the client. + "action": "A String", # Required. The name of the tool's action associated with this call. + "inputParameters": { # Optional. The action's input parameters. + "a_key": "", # Properties of the object. + }, + "tool": "A String", # Required. The tool associated with this call. Format: `projects//locations//agents//tools/`. + }, }, }, ], @@ -11629,6 +12588,13 @@

Method Details

"A String", ], }, + "toolCall": { # Represents a call of a specific tool's action with the specified inputs. # Returns the definition of a tool call that should be executed by the client. + "action": "A String", # Required. The name of the tool's action associated with this call. + "inputParameters": { # Optional. The action's input parameters. + "a_key": "", # Properties of the object. + }, + "tool": "A String", # Required. The tool associated with this call. Format: `projects//locations//agents//tools/`. + }, }, ], "returnPartialResponses": True or False, # Whether Dialogflow should return currently queued fulfillment response messages in streaming APIs. If a webhook is specified, it happens before Dialogflow invokes webhook. Warning: 1) This flag only affects streaming API. Responses are still queued and returned once in non-streaming API. 2) The flag can be enabled in any fulfillment but only the first 3 partial responses will be returned. You may only want to apply it to fulfillments that have slow webhooks. @@ -11757,6 +12723,16 @@

Method Details

"text": { # Represents the natural language text to be processed. # The natural language text to be processed. "text": "A String", # Required. The UTF-8 encoded natural language text to be processed. }, + "toolCallResult": { # The result of calling a tool's action that has been executed by the client. # The results of a tool executed by the client. + "action": "A String", # Required. The name of the tool's action associated with this call. + "error": { # An error produced by the tool call. # The tool call's error. + "message": "A String", # Optional. The error message of the function. + }, + "outputParameters": { # The tool call's output parameters. + "a_key": "", # Properties of the object. + }, + "tool": "A String", # Required. The tool associated with this call. Format: `projects//locations//agents//tools/`. + }, }, "isWebhookEnabled": True or False, # If webhooks should be allowed to trigger in response to the user utterance. Often if parameters are injected, webhooks should not be enabled. }, @@ -11774,8 +12750,8 @@

Method Details

"maxDigits": 42, # Max length of DTMF digits. }, "loggingSettings": { # Define behaviors on logging. # Settings for logging. Settings for Dialogflow History, Contact Center messages, StackDriver logs, and speech logging. Exposed at the following levels: - Agent level. - "enableInteractionLogging": True or False, # If true, DF Interaction logging is currently enabled. - "enableStackdriverLogging": True or False, # If true, StackDriver logging is currently enabled. + "enableInteractionLogging": True or False, # Enables DF Interaction logging. + "enableStackdriverLogging": True or False, # Enables StackDriver logging. }, "speechSettings": { # Define behaviors of speech to text detection. # Settings for speech to text detection. Exposed at the following levels: - Agent level - Flow level - Page level - Parameter level "endpointerSensitivity": 42, # Sensitivity of the speech model that detects the end of speech. Scale from 0 to 100. @@ -11801,8 +12777,8 @@

Method Details

"maxDigits": 42, # Max length of DTMF digits. }, "loggingSettings": { # Define behaviors on logging. # Settings for logging. Settings for Dialogflow History, Contact Center messages, StackDriver logs, and speech logging. Exposed at the following levels: - Agent level. - "enableInteractionLogging": True or False, # If true, DF Interaction logging is currently enabled. - "enableStackdriverLogging": True or False, # If true, StackDriver logging is currently enabled. + "enableInteractionLogging": True or False, # Enables DF Interaction logging. + "enableStackdriverLogging": True or False, # Enables StackDriver logging. }, "speechSettings": { # Define behaviors of speech to text detection. # Settings for speech to text detection. Exposed at the following levels: - Agent level - Flow level - Page level - Parameter level "endpointerSensitivity": 42, # Sensitivity of the speech model that detects the end of speech. Scale from 0 to 100. @@ -11866,6 +12842,13 @@

Method Details

"A String", ], }, + "toolCall": { # Represents a call of a specific tool's action with the specified inputs. # Returns the definition of a tool call that should be executed by the client. + "action": "A String", # Required. The name of the tool's action associated with this call. + "inputParameters": { # Optional. The action's input parameters. + "a_key": "", # Properties of the object. + }, + "tool": "A String", # Required. The tool associated with this call. Format: `projects//locations//agents//tools/`. + }, }, }, ], @@ -11922,6 +12905,13 @@

Method Details

"A String", ], }, + "toolCall": { # Represents a call of a specific tool's action with the specified inputs. # Returns the definition of a tool call that should be executed by the client. + "action": "A String", # Required. The name of the tool's action associated with this call. + "inputParameters": { # Optional. The action's input parameters. + "a_key": "", # Properties of the object. + }, + "tool": "A String", # Required. The tool associated with this call. Format: `projects//locations//agents//tools/`. + }, }, ], "returnPartialResponses": True or False, # Whether Dialogflow should return currently queued fulfillment response messages in streaming APIs. If a webhook is specified, it happens before Dialogflow invokes webhook. Warning: 1) This flag only affects streaming API. Responses are still queued and returned once in non-streaming API. 2) The flag can be enabled in any fulfillment but only the first 3 partial responses will be returned. You may only want to apply it to fulfillments that have slow webhooks. @@ -11953,8 +12943,8 @@

Method Details

"maxDigits": 42, # Max length of DTMF digits. }, "loggingSettings": { # Define behaviors on logging. # Settings for logging. Settings for Dialogflow History, Contact Center messages, StackDriver logs, and speech logging. Exposed at the following levels: - Agent level. - "enableInteractionLogging": True or False, # If true, DF Interaction logging is currently enabled. - "enableStackdriverLogging": True or False, # If true, StackDriver logging is currently enabled. + "enableInteractionLogging": True or False, # Enables DF Interaction logging. + "enableStackdriverLogging": True or False, # Enables StackDriver logging. }, "speechSettings": { # Define behaviors of speech to text detection. # Settings for speech to text detection. Exposed at the following levels: - Agent level - Flow level - Page level - Parameter level "endpointerSensitivity": 42, # Sensitivity of the speech model that detects the end of speech. Scale from 0 to 100. @@ -12018,6 +13008,13 @@

Method Details

"A String", ], }, + "toolCall": { # Represents a call of a specific tool's action with the specified inputs. # Returns the definition of a tool call that should be executed by the client. + "action": "A String", # Required. The name of the tool's action associated with this call. + "inputParameters": { # Optional. The action's input parameters. + "a_key": "", # Properties of the object. + }, + "tool": "A String", # Required. The tool associated with this call. Format: `projects//locations//agents//tools/`. + }, }, }, ], @@ -12074,6 +13071,13 @@

Method Details

"A String", ], }, + "toolCall": { # Represents a call of a specific tool's action with the specified inputs. # Returns the definition of a tool call that should be executed by the client. + "action": "A String", # Required. The name of the tool's action associated with this call. + "inputParameters": { # Optional. The action's input parameters. + "a_key": "", # Properties of the object. + }, + "tool": "A String", # Required. The tool associated with this call. Format: `projects//locations//agents//tools/`. + }, }, ], "returnPartialResponses": True or False, # Whether Dialogflow should return currently queued fulfillment response messages in streaming APIs. If a webhook is specified, it happens before Dialogflow invokes webhook. Warning: 1) This flag only affects streaming API. Responses are still queued and returned once in non-streaming API. 2) The flag can be enabled in any fulfillment but only the first 3 partial responses will be returned. You may only want to apply it to fulfillments that have slow webhooks. @@ -12103,8 +13107,8 @@

Method Details

"maxDigits": 42, # Max length of DTMF digits. }, "loggingSettings": { # Define behaviors on logging. # Settings for logging. Settings for Dialogflow History, Contact Center messages, StackDriver logs, and speech logging. Exposed at the following levels: - Agent level. - "enableInteractionLogging": True or False, # If true, DF Interaction logging is currently enabled. - "enableStackdriverLogging": True or False, # If true, StackDriver logging is currently enabled. + "enableInteractionLogging": True or False, # Enables DF Interaction logging. + "enableStackdriverLogging": True or False, # Enables StackDriver logging. }, "speechSettings": { # Define behaviors of speech to text detection. # Settings for speech to text detection. Exposed at the following levels: - Agent level - Flow level - Page level - Parameter level "endpointerSensitivity": 42, # Sensitivity of the speech model that detects the end of speech. Scale from 0 to 100. @@ -12132,8 +13136,8 @@

Method Details

"maxDigits": 42, # Max length of DTMF digits. }, "loggingSettings": { # Define behaviors on logging. # Settings for logging. Settings for Dialogflow History, Contact Center messages, StackDriver logs, and speech logging. Exposed at the following levels: - Agent level. - "enableInteractionLogging": True or False, # If true, DF Interaction logging is currently enabled. - "enableStackdriverLogging": True or False, # If true, StackDriver logging is currently enabled. + "enableInteractionLogging": True or False, # Enables DF Interaction logging. + "enableStackdriverLogging": True or False, # Enables StackDriver logging. }, "speechSettings": { # Define behaviors of speech to text detection. # Settings for speech to text detection. Exposed at the following levels: - Agent level - Flow level - Page level - Parameter level "endpointerSensitivity": 42, # Sensitivity of the speech model that detects the end of speech. Scale from 0 to 100. @@ -12197,6 +13201,13 @@

Method Details

"A String", ], }, + "toolCall": { # Represents a call of a specific tool's action with the specified inputs. # Returns the definition of a tool call that should be executed by the client. + "action": "A String", # Required. The name of the tool's action associated with this call. + "inputParameters": { # Optional. The action's input parameters. + "a_key": "", # Properties of the object. + }, + "tool": "A String", # Required. The tool associated with this call. Format: `projects//locations//agents//tools/`. + }, }, }, ], @@ -12253,6 +13264,13 @@

Method Details

"A String", ], }, + "toolCall": { # Represents a call of a specific tool's action with the specified inputs. # Returns the definition of a tool call that should be executed by the client. + "action": "A String", # Required. The name of the tool's action associated with this call. + "inputParameters": { # Optional. The action's input parameters. + "a_key": "", # Properties of the object. + }, + "tool": "A String", # Required. The tool associated with this call. Format: `projects//locations//agents//tools/`. + }, }, ], "returnPartialResponses": True or False, # Whether Dialogflow should return currently queued fulfillment response messages in streaming APIs. If a webhook is specified, it happens before Dialogflow invokes webhook. Warning: 1) This flag only affects streaming API. Responses are still queued and returned once in non-streaming API. 2) The flag can be enabled in any fulfillment but only the first 3 partial responses will be returned. You may only want to apply it to fulfillments that have slow webhooks. @@ -12284,8 +13302,8 @@

Method Details

"maxDigits": 42, # Max length of DTMF digits. }, "loggingSettings": { # Define behaviors on logging. # Settings for logging. Settings for Dialogflow History, Contact Center messages, StackDriver logs, and speech logging. Exposed at the following levels: - Agent level. - "enableInteractionLogging": True or False, # If true, DF Interaction logging is currently enabled. - "enableStackdriverLogging": True or False, # If true, StackDriver logging is currently enabled. + "enableInteractionLogging": True or False, # Enables DF Interaction logging. + "enableStackdriverLogging": True or False, # Enables StackDriver logging. }, "speechSettings": { # Define behaviors of speech to text detection. # Settings for speech to text detection. Exposed at the following levels: - Agent level - Flow level - Page level - Parameter level "endpointerSensitivity": 42, # Sensitivity of the speech model that detects the end of speech. Scale from 0 to 100. @@ -12349,6 +13367,13 @@

Method Details

"A String", ], }, + "toolCall": { # Represents a call of a specific tool's action with the specified inputs. # Returns the definition of a tool call that should be executed by the client. + "action": "A String", # Required. The name of the tool's action associated with this call. + "inputParameters": { # Optional. The action's input parameters. + "a_key": "", # Properties of the object. + }, + "tool": "A String", # Required. The tool associated with this call. Format: `projects//locations//agents//tools/`. + }, }, }, ], @@ -12405,6 +13430,13 @@

Method Details

"A String", ], }, + "toolCall": { # Represents a call of a specific tool's action with the specified inputs. # Returns the definition of a tool call that should be executed by the client. + "action": "A String", # Required. The name of the tool's action associated with this call. + "inputParameters": { # Optional. The action's input parameters. + "a_key": "", # Properties of the object. + }, + "tool": "A String", # Required. The tool associated with this call. Format: `projects//locations//agents//tools/`. + }, }, ], "returnPartialResponses": True or False, # Whether Dialogflow should return currently queued fulfillment response messages in streaming APIs. If a webhook is specified, it happens before Dialogflow invokes webhook. Warning: 1) This flag only affects streaming API. Responses are still queued and returned once in non-streaming API. 2) The flag can be enabled in any fulfillment but only the first 3 partial responses will be returned. You may only want to apply it to fulfillments that have slow webhooks. @@ -12449,8 +13481,8 @@

Method Details

"maxDigits": 42, # Max length of DTMF digits. }, "loggingSettings": { # Define behaviors on logging. # Settings for logging. Settings for Dialogflow History, Contact Center messages, StackDriver logs, and speech logging. Exposed at the following levels: - Agent level. - "enableInteractionLogging": True or False, # If true, DF Interaction logging is currently enabled. - "enableStackdriverLogging": True or False, # If true, StackDriver logging is currently enabled. + "enableInteractionLogging": True or False, # Enables DF Interaction logging. + "enableStackdriverLogging": True or False, # Enables StackDriver logging. }, "speechSettings": { # Define behaviors of speech to text detection. # Settings for speech to text detection. Exposed at the following levels: - Agent level - Flow level - Page level - Parameter level "endpointerSensitivity": 42, # Sensitivity of the speech model that detects the end of speech. Scale from 0 to 100. @@ -12514,6 +13546,13 @@

Method Details

"A String", ], }, + "toolCall": { # Represents a call of a specific tool's action with the specified inputs. # Returns the definition of a tool call that should be executed by the client. + "action": "A String", # Required. The name of the tool's action associated with this call. + "inputParameters": { # Optional. The action's input parameters. + "a_key": "", # Properties of the object. + }, + "tool": "A String", # Required. The tool associated with this call. Format: `projects//locations//agents//tools/`. + }, }, }, ], @@ -12570,6 +13609,13 @@

Method Details

"A String", ], }, + "toolCall": { # Represents a call of a specific tool's action with the specified inputs. # Returns the definition of a tool call that should be executed by the client. + "action": "A String", # Required. The name of the tool's action associated with this call. + "inputParameters": { # Optional. The action's input parameters. + "a_key": "", # Properties of the object. + }, + "tool": "A String", # Required. The tool associated with this call. Format: `projects//locations//agents//tools/`. + }, }, ], "returnPartialResponses": True or False, # Whether Dialogflow should return currently queued fulfillment response messages in streaming APIs. If a webhook is specified, it happens before Dialogflow invokes webhook. Warning: 1) This flag only affects streaming API. Responses are still queued and returned once in non-streaming API. 2) The flag can be enabled in any fulfillment but only the first 3 partial responses will be returned. You may only want to apply it to fulfillments that have slow webhooks. @@ -12608,8 +13654,8 @@

Method Details

"maxDigits": 42, # Max length of DTMF digits. }, "loggingSettings": { # Define behaviors on logging. # Settings for logging. Settings for Dialogflow History, Contact Center messages, StackDriver logs, and speech logging. Exposed at the following levels: - Agent level. - "enableInteractionLogging": True or False, # If true, DF Interaction logging is currently enabled. - "enableStackdriverLogging": True or False, # If true, StackDriver logging is currently enabled. + "enableInteractionLogging": True or False, # Enables DF Interaction logging. + "enableStackdriverLogging": True or False, # Enables StackDriver logging. }, "speechSettings": { # Define behaviors of speech to text detection. # Settings for speech to text detection. Exposed at the following levels: - Agent level - Flow level - Page level - Parameter level "endpointerSensitivity": 42, # Sensitivity of the speech model that detects the end of speech. Scale from 0 to 100. @@ -12673,6 +13719,13 @@

Method Details

"A String", ], }, + "toolCall": { # Represents a call of a specific tool's action with the specified inputs. # Returns the definition of a tool call that should be executed by the client. + "action": "A String", # Required. The name of the tool's action associated with this call. + "inputParameters": { # Optional. The action's input parameters. + "a_key": "", # Properties of the object. + }, + "tool": "A String", # Required. The tool associated with this call. Format: `projects//locations//agents//tools/`. + }, }, }, ], @@ -12729,6 +13782,13 @@

Method Details

"A String", ], }, + "toolCall": { # Represents a call of a specific tool's action with the specified inputs. # Returns the definition of a tool call that should be executed by the client. + "action": "A String", # Required. The name of the tool's action associated with this call. + "inputParameters": { # Optional. The action's input parameters. + "a_key": "", # Properties of the object. + }, + "tool": "A String", # Required. The tool associated with this call. Format: `projects//locations//agents//tools/`. + }, }, ], "returnPartialResponses": True or False, # Whether Dialogflow should return currently queued fulfillment response messages in streaming APIs. If a webhook is specified, it happens before Dialogflow invokes webhook. Warning: 1) This flag only affects streaming API. Responses are still queued and returned once in non-streaming API. 2) The flag can be enabled in any fulfillment but only the first 3 partial responses will be returned. You may only want to apply it to fulfillments that have slow webhooks. @@ -12886,6 +13946,16 @@

Method Details

"text": { # Represents the natural language text to be processed. # The natural language text to be processed. "text": "A String", # Required. The UTF-8 encoded natural language text to be processed. }, + "toolCallResult": { # The result of calling a tool's action that has been executed by the client. # The results of a tool executed by the client. + "action": "A String", # Required. The name of the tool's action associated with this call. + "error": { # An error produced by the tool call. # The tool call's error. + "message": "A String", # Optional. The error message of the function. + }, + "outputParameters": { # The tool call's output parameters. + "a_key": "", # Properties of the object. + }, + "tool": "A String", # Required. The tool associated with this call. Format: `projects//locations//agents//tools/`. + }, }, "isWebhookEnabled": True or False, # If webhooks should be allowed to trigger in response to the user utterance. Often if parameters are injected, webhooks should not be enabled. }, @@ -12903,8 +13973,8 @@

Method Details

"maxDigits": 42, # Max length of DTMF digits. }, "loggingSettings": { # Define behaviors on logging. # Settings for logging. Settings for Dialogflow History, Contact Center messages, StackDriver logs, and speech logging. Exposed at the following levels: - Agent level. - "enableInteractionLogging": True or False, # If true, DF Interaction logging is currently enabled. - "enableStackdriverLogging": True or False, # If true, StackDriver logging is currently enabled. + "enableInteractionLogging": True or False, # Enables DF Interaction logging. + "enableStackdriverLogging": True or False, # Enables StackDriver logging. }, "speechSettings": { # Define behaviors of speech to text detection. # Settings for speech to text detection. Exposed at the following levels: - Agent level - Flow level - Page level - Parameter level "endpointerSensitivity": 42, # Sensitivity of the speech model that detects the end of speech. Scale from 0 to 100. @@ -12930,8 +14000,8 @@

Method Details

"maxDigits": 42, # Max length of DTMF digits. }, "loggingSettings": { # Define behaviors on logging. # Settings for logging. Settings for Dialogflow History, Contact Center messages, StackDriver logs, and speech logging. Exposed at the following levels: - Agent level. - "enableInteractionLogging": True or False, # If true, DF Interaction logging is currently enabled. - "enableStackdriverLogging": True or False, # If true, StackDriver logging is currently enabled. + "enableInteractionLogging": True or False, # Enables DF Interaction logging. + "enableStackdriverLogging": True or False, # Enables StackDriver logging. }, "speechSettings": { # Define behaviors of speech to text detection. # Settings for speech to text detection. Exposed at the following levels: - Agent level - Flow level - Page level - Parameter level "endpointerSensitivity": 42, # Sensitivity of the speech model that detects the end of speech. Scale from 0 to 100. @@ -12995,6 +14065,13 @@

Method Details

"A String", ], }, + "toolCall": { # Represents a call of a specific tool's action with the specified inputs. # Returns the definition of a tool call that should be executed by the client. + "action": "A String", # Required. The name of the tool's action associated with this call. + "inputParameters": { # Optional. The action's input parameters. + "a_key": "", # Properties of the object. + }, + "tool": "A String", # Required. The tool associated with this call. Format: `projects//locations//agents//tools/`. + }, }, }, ], @@ -13051,6 +14128,13 @@

Method Details

"A String", ], }, + "toolCall": { # Represents a call of a specific tool's action with the specified inputs. # Returns the definition of a tool call that should be executed by the client. + "action": "A String", # Required. The name of the tool's action associated with this call. + "inputParameters": { # Optional. The action's input parameters. + "a_key": "", # Properties of the object. + }, + "tool": "A String", # Required. The tool associated with this call. Format: `projects//locations//agents//tools/`. + }, }, ], "returnPartialResponses": True or False, # Whether Dialogflow should return currently queued fulfillment response messages in streaming APIs. If a webhook is specified, it happens before Dialogflow invokes webhook. Warning: 1) This flag only affects streaming API. Responses are still queued and returned once in non-streaming API. 2) The flag can be enabled in any fulfillment but only the first 3 partial responses will be returned. You may only want to apply it to fulfillments that have slow webhooks. @@ -13082,8 +14166,8 @@

Method Details

"maxDigits": 42, # Max length of DTMF digits. }, "loggingSettings": { # Define behaviors on logging. # Settings for logging. Settings for Dialogflow History, Contact Center messages, StackDriver logs, and speech logging. Exposed at the following levels: - Agent level. - "enableInteractionLogging": True or False, # If true, DF Interaction logging is currently enabled. - "enableStackdriverLogging": True or False, # If true, StackDriver logging is currently enabled. + "enableInteractionLogging": True or False, # Enables DF Interaction logging. + "enableStackdriverLogging": True or False, # Enables StackDriver logging. }, "speechSettings": { # Define behaviors of speech to text detection. # Settings for speech to text detection. Exposed at the following levels: - Agent level - Flow level - Page level - Parameter level "endpointerSensitivity": 42, # Sensitivity of the speech model that detects the end of speech. Scale from 0 to 100. @@ -13147,6 +14231,13 @@

Method Details

"A String", ], }, + "toolCall": { # Represents a call of a specific tool's action with the specified inputs. # Returns the definition of a tool call that should be executed by the client. + "action": "A String", # Required. The name of the tool's action associated with this call. + "inputParameters": { # Optional. The action's input parameters. + "a_key": "", # Properties of the object. + }, + "tool": "A String", # Required. The tool associated with this call. Format: `projects//locations//agents//tools/`. + }, }, }, ], @@ -13203,6 +14294,13 @@

Method Details

"A String", ], }, + "toolCall": { # Represents a call of a specific tool's action with the specified inputs. # Returns the definition of a tool call that should be executed by the client. + "action": "A String", # Required. The name of the tool's action associated with this call. + "inputParameters": { # Optional. The action's input parameters. + "a_key": "", # Properties of the object. + }, + "tool": "A String", # Required. The tool associated with this call. Format: `projects//locations//agents//tools/`. + }, }, ], "returnPartialResponses": True or False, # Whether Dialogflow should return currently queued fulfillment response messages in streaming APIs. If a webhook is specified, it happens before Dialogflow invokes webhook. Warning: 1) This flag only affects streaming API. Responses are still queued and returned once in non-streaming API. 2) The flag can be enabled in any fulfillment but only the first 3 partial responses will be returned. You may only want to apply it to fulfillments that have slow webhooks. @@ -13232,8 +14330,8 @@

Method Details

"maxDigits": 42, # Max length of DTMF digits. }, "loggingSettings": { # Define behaviors on logging. # Settings for logging. Settings for Dialogflow History, Contact Center messages, StackDriver logs, and speech logging. Exposed at the following levels: - Agent level. - "enableInteractionLogging": True or False, # If true, DF Interaction logging is currently enabled. - "enableStackdriverLogging": True or False, # If true, StackDriver logging is currently enabled. + "enableInteractionLogging": True or False, # Enables DF Interaction logging. + "enableStackdriverLogging": True or False, # Enables StackDriver logging. }, "speechSettings": { # Define behaviors of speech to text detection. # Settings for speech to text detection. Exposed at the following levels: - Agent level - Flow level - Page level - Parameter level "endpointerSensitivity": 42, # Sensitivity of the speech model that detects the end of speech. Scale from 0 to 100. @@ -13261,8 +14359,8 @@

Method Details

"maxDigits": 42, # Max length of DTMF digits. }, "loggingSettings": { # Define behaviors on logging. # Settings for logging. Settings for Dialogflow History, Contact Center messages, StackDriver logs, and speech logging. Exposed at the following levels: - Agent level. - "enableInteractionLogging": True or False, # If true, DF Interaction logging is currently enabled. - "enableStackdriverLogging": True or False, # If true, StackDriver logging is currently enabled. + "enableInteractionLogging": True or False, # Enables DF Interaction logging. + "enableStackdriverLogging": True or False, # Enables StackDriver logging. }, "speechSettings": { # Define behaviors of speech to text detection. # Settings for speech to text detection. Exposed at the following levels: - Agent level - Flow level - Page level - Parameter level "endpointerSensitivity": 42, # Sensitivity of the speech model that detects the end of speech. Scale from 0 to 100. @@ -13326,6 +14424,13 @@

Method Details

"A String", ], }, + "toolCall": { # Represents a call of a specific tool's action with the specified inputs. # Returns the definition of a tool call that should be executed by the client. + "action": "A String", # Required. The name of the tool's action associated with this call. + "inputParameters": { # Optional. The action's input parameters. + "a_key": "", # Properties of the object. + }, + "tool": "A String", # Required. The tool associated with this call. Format: `projects//locations//agents//tools/`. + }, }, }, ], @@ -13382,6 +14487,13 @@

Method Details

"A String", ], }, + "toolCall": { # Represents a call of a specific tool's action with the specified inputs. # Returns the definition of a tool call that should be executed by the client. + "action": "A String", # Required. The name of the tool's action associated with this call. + "inputParameters": { # Optional. The action's input parameters. + "a_key": "", # Properties of the object. + }, + "tool": "A String", # Required. The tool associated with this call. Format: `projects//locations//agents//tools/`. + }, }, ], "returnPartialResponses": True or False, # Whether Dialogflow should return currently queued fulfillment response messages in streaming APIs. If a webhook is specified, it happens before Dialogflow invokes webhook. Warning: 1) This flag only affects streaming API. Responses are still queued and returned once in non-streaming API. 2) The flag can be enabled in any fulfillment but only the first 3 partial responses will be returned. You may only want to apply it to fulfillments that have slow webhooks. @@ -13413,8 +14525,8 @@

Method Details

"maxDigits": 42, # Max length of DTMF digits. }, "loggingSettings": { # Define behaviors on logging. # Settings for logging. Settings for Dialogflow History, Contact Center messages, StackDriver logs, and speech logging. Exposed at the following levels: - Agent level. - "enableInteractionLogging": True or False, # If true, DF Interaction logging is currently enabled. - "enableStackdriverLogging": True or False, # If true, StackDriver logging is currently enabled. + "enableInteractionLogging": True or False, # Enables DF Interaction logging. + "enableStackdriverLogging": True or False, # Enables StackDriver logging. }, "speechSettings": { # Define behaviors of speech to text detection. # Settings for speech to text detection. Exposed at the following levels: - Agent level - Flow level - Page level - Parameter level "endpointerSensitivity": 42, # Sensitivity of the speech model that detects the end of speech. Scale from 0 to 100. @@ -13478,6 +14590,13 @@

Method Details

"A String", ], }, + "toolCall": { # Represents a call of a specific tool's action with the specified inputs. # Returns the definition of a tool call that should be executed by the client. + "action": "A String", # Required. The name of the tool's action associated with this call. + "inputParameters": { # Optional. The action's input parameters. + "a_key": "", # Properties of the object. + }, + "tool": "A String", # Required. The tool associated with this call. Format: `projects//locations//agents//tools/`. + }, }, }, ], @@ -13534,6 +14653,13 @@

Method Details

"A String", ], }, + "toolCall": { # Represents a call of a specific tool's action with the specified inputs. # Returns the definition of a tool call that should be executed by the client. + "action": "A String", # Required. The name of the tool's action associated with this call. + "inputParameters": { # Optional. The action's input parameters. + "a_key": "", # Properties of the object. + }, + "tool": "A String", # Required. The tool associated with this call. Format: `projects//locations//agents//tools/`. + }, }, ], "returnPartialResponses": True or False, # Whether Dialogflow should return currently queued fulfillment response messages in streaming APIs. If a webhook is specified, it happens before Dialogflow invokes webhook. Warning: 1) This flag only affects streaming API. Responses are still queued and returned once in non-streaming API. 2) The flag can be enabled in any fulfillment but only the first 3 partial responses will be returned. You may only want to apply it to fulfillments that have slow webhooks. @@ -13578,8 +14704,8 @@

Method Details

"maxDigits": 42, # Max length of DTMF digits. }, "loggingSettings": { # Define behaviors on logging. # Settings for logging. Settings for Dialogflow History, Contact Center messages, StackDriver logs, and speech logging. Exposed at the following levels: - Agent level. - "enableInteractionLogging": True or False, # If true, DF Interaction logging is currently enabled. - "enableStackdriverLogging": True or False, # If true, StackDriver logging is currently enabled. + "enableInteractionLogging": True or False, # Enables DF Interaction logging. + "enableStackdriverLogging": True or False, # Enables StackDriver logging. }, "speechSettings": { # Define behaviors of speech to text detection. # Settings for speech to text detection. Exposed at the following levels: - Agent level - Flow level - Page level - Parameter level "endpointerSensitivity": 42, # Sensitivity of the speech model that detects the end of speech. Scale from 0 to 100. @@ -13643,6 +14769,13 @@

Method Details

"A String", ], }, + "toolCall": { # Represents a call of a specific tool's action with the specified inputs. # Returns the definition of a tool call that should be executed by the client. + "action": "A String", # Required. The name of the tool's action associated with this call. + "inputParameters": { # Optional. The action's input parameters. + "a_key": "", # Properties of the object. + }, + "tool": "A String", # Required. The tool associated with this call. Format: `projects//locations//agents//tools/`. + }, }, }, ], @@ -13699,6 +14832,13 @@

Method Details

"A String", ], }, + "toolCall": { # Represents a call of a specific tool's action with the specified inputs. # Returns the definition of a tool call that should be executed by the client. + "action": "A String", # Required. The name of the tool's action associated with this call. + "inputParameters": { # Optional. The action's input parameters. + "a_key": "", # Properties of the object. + }, + "tool": "A String", # Required. The tool associated with this call. Format: `projects//locations//agents//tools/`. + }, }, ], "returnPartialResponses": True or False, # Whether Dialogflow should return currently queued fulfillment response messages in streaming APIs. If a webhook is specified, it happens before Dialogflow invokes webhook. Warning: 1) This flag only affects streaming API. Responses are still queued and returned once in non-streaming API. 2) The flag can be enabled in any fulfillment but only the first 3 partial responses will be returned. You may only want to apply it to fulfillments that have slow webhooks. @@ -13737,8 +14877,8 @@

Method Details

"maxDigits": 42, # Max length of DTMF digits. }, "loggingSettings": { # Define behaviors on logging. # Settings for logging. Settings for Dialogflow History, Contact Center messages, StackDriver logs, and speech logging. Exposed at the following levels: - Agent level. - "enableInteractionLogging": True or False, # If true, DF Interaction logging is currently enabled. - "enableStackdriverLogging": True or False, # If true, StackDriver logging is currently enabled. + "enableInteractionLogging": True or False, # Enables DF Interaction logging. + "enableStackdriverLogging": True or False, # Enables StackDriver logging. }, "speechSettings": { # Define behaviors of speech to text detection. # Settings for speech to text detection. Exposed at the following levels: - Agent level - Flow level - Page level - Parameter level "endpointerSensitivity": 42, # Sensitivity of the speech model that detects the end of speech. Scale from 0 to 100. @@ -13802,6 +14942,13 @@

Method Details

"A String", ], }, + "toolCall": { # Represents a call of a specific tool's action with the specified inputs. # Returns the definition of a tool call that should be executed by the client. + "action": "A String", # Required. The name of the tool's action associated with this call. + "inputParameters": { # Optional. The action's input parameters. + "a_key": "", # Properties of the object. + }, + "tool": "A String", # Required. The tool associated with this call. Format: `projects//locations//agents//tools/`. + }, }, }, ], @@ -13858,6 +15005,13 @@

Method Details

"A String", ], }, + "toolCall": { # Represents a call of a specific tool's action with the specified inputs. # Returns the definition of a tool call that should be executed by the client. + "action": "A String", # Required. The name of the tool's action associated with this call. + "inputParameters": { # Optional. The action's input parameters. + "a_key": "", # Properties of the object. + }, + "tool": "A String", # Required. The tool associated with this call. Format: `projects//locations//agents//tools/`. + }, }, ], "returnPartialResponses": True or False, # Whether Dialogflow should return currently queued fulfillment response messages in streaming APIs. If a webhook is specified, it happens before Dialogflow invokes webhook. Warning: 1) This flag only affects streaming API. Responses are still queued and returned once in non-streaming API. 2) The flag can be enabled in any fulfillment but only the first 3 partial responses will be returned. You may only want to apply it to fulfillments that have slow webhooks. @@ -13986,6 +15140,16 @@

Method Details

"text": { # Represents the natural language text to be processed. # The natural language text to be processed. "text": "A String", # Required. The UTF-8 encoded natural language text to be processed. }, + "toolCallResult": { # The result of calling a tool's action that has been executed by the client. # The results of a tool executed by the client. + "action": "A String", # Required. The name of the tool's action associated with this call. + "error": { # An error produced by the tool call. # The tool call's error. + "message": "A String", # Optional. The error message of the function. + }, + "outputParameters": { # The tool call's output parameters. + "a_key": "", # Properties of the object. + }, + "tool": "A String", # Required. The tool associated with this call. Format: `projects//locations//agents//tools/`. + }, }, "isWebhookEnabled": True or False, # If webhooks should be allowed to trigger in response to the user utterance. Often if parameters are injected, webhooks should not be enabled. }, @@ -14003,8 +15167,8 @@

Method Details

"maxDigits": 42, # Max length of DTMF digits. }, "loggingSettings": { # Define behaviors on logging. # Settings for logging. Settings for Dialogflow History, Contact Center messages, StackDriver logs, and speech logging. Exposed at the following levels: - Agent level. - "enableInteractionLogging": True or False, # If true, DF Interaction logging is currently enabled. - "enableStackdriverLogging": True or False, # If true, StackDriver logging is currently enabled. + "enableInteractionLogging": True or False, # Enables DF Interaction logging. + "enableStackdriverLogging": True or False, # Enables StackDriver logging. }, "speechSettings": { # Define behaviors of speech to text detection. # Settings for speech to text detection. Exposed at the following levels: - Agent level - Flow level - Page level - Parameter level "endpointerSensitivity": 42, # Sensitivity of the speech model that detects the end of speech. Scale from 0 to 100. @@ -14030,8 +15194,8 @@

Method Details

"maxDigits": 42, # Max length of DTMF digits. }, "loggingSettings": { # Define behaviors on logging. # Settings for logging. Settings for Dialogflow History, Contact Center messages, StackDriver logs, and speech logging. Exposed at the following levels: - Agent level. - "enableInteractionLogging": True or False, # If true, DF Interaction logging is currently enabled. - "enableStackdriverLogging": True or False, # If true, StackDriver logging is currently enabled. + "enableInteractionLogging": True or False, # Enables DF Interaction logging. + "enableStackdriverLogging": True or False, # Enables StackDriver logging. }, "speechSettings": { # Define behaviors of speech to text detection. # Settings for speech to text detection. Exposed at the following levels: - Agent level - Flow level - Page level - Parameter level "endpointerSensitivity": 42, # Sensitivity of the speech model that detects the end of speech. Scale from 0 to 100. @@ -14095,6 +15259,13 @@

Method Details

"A String", ], }, + "toolCall": { # Represents a call of a specific tool's action with the specified inputs. # Returns the definition of a tool call that should be executed by the client. + "action": "A String", # Required. The name of the tool's action associated with this call. + "inputParameters": { # Optional. The action's input parameters. + "a_key": "", # Properties of the object. + }, + "tool": "A String", # Required. The tool associated with this call. Format: `projects//locations//agents//tools/`. + }, }, }, ], @@ -14151,6 +15322,13 @@

Method Details

"A String", ], }, + "toolCall": { # Represents a call of a specific tool's action with the specified inputs. # Returns the definition of a tool call that should be executed by the client. + "action": "A String", # Required. The name of the tool's action associated with this call. + "inputParameters": { # Optional. The action's input parameters. + "a_key": "", # Properties of the object. + }, + "tool": "A String", # Required. The tool associated with this call. Format: `projects//locations//agents//tools/`. + }, }, ], "returnPartialResponses": True or False, # Whether Dialogflow should return currently queued fulfillment response messages in streaming APIs. If a webhook is specified, it happens before Dialogflow invokes webhook. Warning: 1) This flag only affects streaming API. Responses are still queued and returned once in non-streaming API. 2) The flag can be enabled in any fulfillment but only the first 3 partial responses will be returned. You may only want to apply it to fulfillments that have slow webhooks. @@ -14182,8 +15360,8 @@

Method Details

"maxDigits": 42, # Max length of DTMF digits. }, "loggingSettings": { # Define behaviors on logging. # Settings for logging. Settings for Dialogflow History, Contact Center messages, StackDriver logs, and speech logging. Exposed at the following levels: - Agent level. - "enableInteractionLogging": True or False, # If true, DF Interaction logging is currently enabled. - "enableStackdriverLogging": True or False, # If true, StackDriver logging is currently enabled. + "enableInteractionLogging": True or False, # Enables DF Interaction logging. + "enableStackdriverLogging": True or False, # Enables StackDriver logging. }, "speechSettings": { # Define behaviors of speech to text detection. # Settings for speech to text detection. Exposed at the following levels: - Agent level - Flow level - Page level - Parameter level "endpointerSensitivity": 42, # Sensitivity of the speech model that detects the end of speech. Scale from 0 to 100. @@ -14247,6 +15425,13 @@

Method Details

"A String", ], }, + "toolCall": { # Represents a call of a specific tool's action with the specified inputs. # Returns the definition of a tool call that should be executed by the client. + "action": "A String", # Required. The name of the tool's action associated with this call. + "inputParameters": { # Optional. The action's input parameters. + "a_key": "", # Properties of the object. + }, + "tool": "A String", # Required. The tool associated with this call. Format: `projects//locations//agents//tools/`. + }, }, }, ], @@ -14303,6 +15488,13 @@

Method Details

"A String", ], }, + "toolCall": { # Represents a call of a specific tool's action with the specified inputs. # Returns the definition of a tool call that should be executed by the client. + "action": "A String", # Required. The name of the tool's action associated with this call. + "inputParameters": { # Optional. The action's input parameters. + "a_key": "", # Properties of the object. + }, + "tool": "A String", # Required. The tool associated with this call. Format: `projects//locations//agents//tools/`. + }, }, ], "returnPartialResponses": True or False, # Whether Dialogflow should return currently queued fulfillment response messages in streaming APIs. If a webhook is specified, it happens before Dialogflow invokes webhook. Warning: 1) This flag only affects streaming API. Responses are still queued and returned once in non-streaming API. 2) The flag can be enabled in any fulfillment but only the first 3 partial responses will be returned. You may only want to apply it to fulfillments that have slow webhooks. @@ -14332,8 +15524,8 @@

Method Details

"maxDigits": 42, # Max length of DTMF digits. }, "loggingSettings": { # Define behaviors on logging. # Settings for logging. Settings for Dialogflow History, Contact Center messages, StackDriver logs, and speech logging. Exposed at the following levels: - Agent level. - "enableInteractionLogging": True or False, # If true, DF Interaction logging is currently enabled. - "enableStackdriverLogging": True or False, # If true, StackDriver logging is currently enabled. + "enableInteractionLogging": True or False, # Enables DF Interaction logging. + "enableStackdriverLogging": True or False, # Enables StackDriver logging. }, "speechSettings": { # Define behaviors of speech to text detection. # Settings for speech to text detection. Exposed at the following levels: - Agent level - Flow level - Page level - Parameter level "endpointerSensitivity": 42, # Sensitivity of the speech model that detects the end of speech. Scale from 0 to 100. @@ -14361,8 +15553,8 @@

Method Details

"maxDigits": 42, # Max length of DTMF digits. }, "loggingSettings": { # Define behaviors on logging. # Settings for logging. Settings for Dialogflow History, Contact Center messages, StackDriver logs, and speech logging. Exposed at the following levels: - Agent level. - "enableInteractionLogging": True or False, # If true, DF Interaction logging is currently enabled. - "enableStackdriverLogging": True or False, # If true, StackDriver logging is currently enabled. + "enableInteractionLogging": True or False, # Enables DF Interaction logging. + "enableStackdriverLogging": True or False, # Enables StackDriver logging. }, "speechSettings": { # Define behaviors of speech to text detection. # Settings for speech to text detection. Exposed at the following levels: - Agent level - Flow level - Page level - Parameter level "endpointerSensitivity": 42, # Sensitivity of the speech model that detects the end of speech. Scale from 0 to 100. @@ -14426,6 +15618,13 @@

Method Details

"A String", ], }, + "toolCall": { # Represents a call of a specific tool's action with the specified inputs. # Returns the definition of a tool call that should be executed by the client. + "action": "A String", # Required. The name of the tool's action associated with this call. + "inputParameters": { # Optional. The action's input parameters. + "a_key": "", # Properties of the object. + }, + "tool": "A String", # Required. The tool associated with this call. Format: `projects//locations//agents//tools/`. + }, }, }, ], @@ -14482,6 +15681,13 @@

Method Details

"A String", ], }, + "toolCall": { # Represents a call of a specific tool's action with the specified inputs. # Returns the definition of a tool call that should be executed by the client. + "action": "A String", # Required. The name of the tool's action associated with this call. + "inputParameters": { # Optional. The action's input parameters. + "a_key": "", # Properties of the object. + }, + "tool": "A String", # Required. The tool associated with this call. Format: `projects//locations//agents//tools/`. + }, }, ], "returnPartialResponses": True or False, # Whether Dialogflow should return currently queued fulfillment response messages in streaming APIs. If a webhook is specified, it happens before Dialogflow invokes webhook. Warning: 1) This flag only affects streaming API. Responses are still queued and returned once in non-streaming API. 2) The flag can be enabled in any fulfillment but only the first 3 partial responses will be returned. You may only want to apply it to fulfillments that have slow webhooks. @@ -14513,8 +15719,8 @@

Method Details

"maxDigits": 42, # Max length of DTMF digits. }, "loggingSettings": { # Define behaviors on logging. # Settings for logging. Settings for Dialogflow History, Contact Center messages, StackDriver logs, and speech logging. Exposed at the following levels: - Agent level. - "enableInteractionLogging": True or False, # If true, DF Interaction logging is currently enabled. - "enableStackdriverLogging": True or False, # If true, StackDriver logging is currently enabled. + "enableInteractionLogging": True or False, # Enables DF Interaction logging. + "enableStackdriverLogging": True or False, # Enables StackDriver logging. }, "speechSettings": { # Define behaviors of speech to text detection. # Settings for speech to text detection. Exposed at the following levels: - Agent level - Flow level - Page level - Parameter level "endpointerSensitivity": 42, # Sensitivity of the speech model that detects the end of speech. Scale from 0 to 100. @@ -14578,6 +15784,13 @@

Method Details

"A String", ], }, + "toolCall": { # Represents a call of a specific tool's action with the specified inputs. # Returns the definition of a tool call that should be executed by the client. + "action": "A String", # Required. The name of the tool's action associated with this call. + "inputParameters": { # Optional. The action's input parameters. + "a_key": "", # Properties of the object. + }, + "tool": "A String", # Required. The tool associated with this call. Format: `projects//locations//agents//tools/`. + }, }, }, ], @@ -14634,6 +15847,13 @@

Method Details

"A String", ], }, + "toolCall": { # Represents a call of a specific tool's action with the specified inputs. # Returns the definition of a tool call that should be executed by the client. + "action": "A String", # Required. The name of the tool's action associated with this call. + "inputParameters": { # Optional. The action's input parameters. + "a_key": "", # Properties of the object. + }, + "tool": "A String", # Required. The tool associated with this call. Format: `projects//locations//agents//tools/`. + }, }, ], "returnPartialResponses": True or False, # Whether Dialogflow should return currently queued fulfillment response messages in streaming APIs. If a webhook is specified, it happens before Dialogflow invokes webhook. Warning: 1) This flag only affects streaming API. Responses are still queued and returned once in non-streaming API. 2) The flag can be enabled in any fulfillment but only the first 3 partial responses will be returned. You may only want to apply it to fulfillments that have slow webhooks. @@ -14678,8 +15898,8 @@

Method Details

"maxDigits": 42, # Max length of DTMF digits. }, "loggingSettings": { # Define behaviors on logging. # Settings for logging. Settings for Dialogflow History, Contact Center messages, StackDriver logs, and speech logging. Exposed at the following levels: - Agent level. - "enableInteractionLogging": True or False, # If true, DF Interaction logging is currently enabled. - "enableStackdriverLogging": True or False, # If true, StackDriver logging is currently enabled. + "enableInteractionLogging": True or False, # Enables DF Interaction logging. + "enableStackdriverLogging": True or False, # Enables StackDriver logging. }, "speechSettings": { # Define behaviors of speech to text detection. # Settings for speech to text detection. Exposed at the following levels: - Agent level - Flow level - Page level - Parameter level "endpointerSensitivity": 42, # Sensitivity of the speech model that detects the end of speech. Scale from 0 to 100. @@ -14743,6 +15963,13 @@

Method Details

"A String", ], }, + "toolCall": { # Represents a call of a specific tool's action with the specified inputs. # Returns the definition of a tool call that should be executed by the client. + "action": "A String", # Required. The name of the tool's action associated with this call. + "inputParameters": { # Optional. The action's input parameters. + "a_key": "", # Properties of the object. + }, + "tool": "A String", # Required. The tool associated with this call. Format: `projects//locations//agents//tools/`. + }, }, }, ], @@ -14799,6 +16026,13 @@

Method Details

"A String", ], }, + "toolCall": { # Represents a call of a specific tool's action with the specified inputs. # Returns the definition of a tool call that should be executed by the client. + "action": "A String", # Required. The name of the tool's action associated with this call. + "inputParameters": { # Optional. The action's input parameters. + "a_key": "", # Properties of the object. + }, + "tool": "A String", # Required. The tool associated with this call. Format: `projects//locations//agents//tools/`. + }, }, ], "returnPartialResponses": True or False, # Whether Dialogflow should return currently queued fulfillment response messages in streaming APIs. If a webhook is specified, it happens before Dialogflow invokes webhook. Warning: 1) This flag only affects streaming API. Responses are still queued and returned once in non-streaming API. 2) The flag can be enabled in any fulfillment but only the first 3 partial responses will be returned. You may only want to apply it to fulfillments that have slow webhooks. @@ -14837,8 +16071,8 @@

Method Details

"maxDigits": 42, # Max length of DTMF digits. }, "loggingSettings": { # Define behaviors on logging. # Settings for logging. Settings for Dialogflow History, Contact Center messages, StackDriver logs, and speech logging. Exposed at the following levels: - Agent level. - "enableInteractionLogging": True or False, # If true, DF Interaction logging is currently enabled. - "enableStackdriverLogging": True or False, # If true, StackDriver logging is currently enabled. + "enableInteractionLogging": True or False, # Enables DF Interaction logging. + "enableStackdriverLogging": True or False, # Enables StackDriver logging. }, "speechSettings": { # Define behaviors of speech to text detection. # Settings for speech to text detection. Exposed at the following levels: - Agent level - Flow level - Page level - Parameter level "endpointerSensitivity": 42, # Sensitivity of the speech model that detects the end of speech. Scale from 0 to 100. @@ -14902,6 +16136,13 @@

Method Details

"A String", ], }, + "toolCall": { # Represents a call of a specific tool's action with the specified inputs. # Returns the definition of a tool call that should be executed by the client. + "action": "A String", # Required. The name of the tool's action associated with this call. + "inputParameters": { # Optional. The action's input parameters. + "a_key": "", # Properties of the object. + }, + "tool": "A String", # Required. The tool associated with this call. Format: `projects//locations//agents//tools/`. + }, }, }, ], @@ -14958,6 +16199,13 @@

Method Details

"A String", ], }, + "toolCall": { # Represents a call of a specific tool's action with the specified inputs. # Returns the definition of a tool call that should be executed by the client. + "action": "A String", # Required. The name of the tool's action associated with this call. + "inputParameters": { # Optional. The action's input parameters. + "a_key": "", # Properties of the object. + }, + "tool": "A String", # Required. The tool associated with this call. Format: `projects//locations//agents//tools/`. + }, }, ], "returnPartialResponses": True or False, # Whether Dialogflow should return currently queued fulfillment response messages in streaming APIs. If a webhook is specified, it happens before Dialogflow invokes webhook. Warning: 1) This flag only affects streaming API. Responses are still queued and returned once in non-streaming API. 2) The flag can be enabled in any fulfillment but only the first 3 partial responses will be returned. You may only want to apply it to fulfillments that have slow webhooks. @@ -15098,6 +16346,16 @@

Method Details

"text": { # Represents the natural language text to be processed. # The natural language text to be processed. "text": "A String", # Required. The UTF-8 encoded natural language text to be processed. }, + "toolCallResult": { # The result of calling a tool's action that has been executed by the client. # The results of a tool executed by the client. + "action": "A String", # Required. The name of the tool's action associated with this call. + "error": { # An error produced by the tool call. # The tool call's error. + "message": "A String", # Optional. The error message of the function. + }, + "outputParameters": { # The tool call's output parameters. + "a_key": "", # Properties of the object. + }, + "tool": "A String", # Required. The tool associated with this call. Format: `projects//locations//agents//tools/`. + }, }, "isWebhookEnabled": True or False, # If webhooks should be allowed to trigger in response to the user utterance. Often if parameters are injected, webhooks should not be enabled. }, @@ -15115,8 +16373,8 @@

Method Details

"maxDigits": 42, # Max length of DTMF digits. }, "loggingSettings": { # Define behaviors on logging. # Settings for logging. Settings for Dialogflow History, Contact Center messages, StackDriver logs, and speech logging. Exposed at the following levels: - Agent level. - "enableInteractionLogging": True or False, # If true, DF Interaction logging is currently enabled. - "enableStackdriverLogging": True or False, # If true, StackDriver logging is currently enabled. + "enableInteractionLogging": True or False, # Enables DF Interaction logging. + "enableStackdriverLogging": True or False, # Enables StackDriver logging. }, "speechSettings": { # Define behaviors of speech to text detection. # Settings for speech to text detection. Exposed at the following levels: - Agent level - Flow level - Page level - Parameter level "endpointerSensitivity": 42, # Sensitivity of the speech model that detects the end of speech. Scale from 0 to 100. @@ -15142,8 +16400,8 @@

Method Details

"maxDigits": 42, # Max length of DTMF digits. }, "loggingSettings": { # Define behaviors on logging. # Settings for logging. Settings for Dialogflow History, Contact Center messages, StackDriver logs, and speech logging. Exposed at the following levels: - Agent level. - "enableInteractionLogging": True or False, # If true, DF Interaction logging is currently enabled. - "enableStackdriverLogging": True or False, # If true, StackDriver logging is currently enabled. + "enableInteractionLogging": True or False, # Enables DF Interaction logging. + "enableStackdriverLogging": True or False, # Enables StackDriver logging. }, "speechSettings": { # Define behaviors of speech to text detection. # Settings for speech to text detection. Exposed at the following levels: - Agent level - Flow level - Page level - Parameter level "endpointerSensitivity": 42, # Sensitivity of the speech model that detects the end of speech. Scale from 0 to 100. @@ -15207,6 +16465,13 @@

Method Details

"A String", ], }, + "toolCall": { # Represents a call of a specific tool's action with the specified inputs. # Returns the definition of a tool call that should be executed by the client. + "action": "A String", # Required. The name of the tool's action associated with this call. + "inputParameters": { # Optional. The action's input parameters. + "a_key": "", # Properties of the object. + }, + "tool": "A String", # Required. The tool associated with this call. Format: `projects//locations//agents//tools/`. + }, }, }, ], @@ -15263,6 +16528,13 @@

Method Details

"A String", ], }, + "toolCall": { # Represents a call of a specific tool's action with the specified inputs. # Returns the definition of a tool call that should be executed by the client. + "action": "A String", # Required. The name of the tool's action associated with this call. + "inputParameters": { # Optional. The action's input parameters. + "a_key": "", # Properties of the object. + }, + "tool": "A String", # Required. The tool associated with this call. Format: `projects//locations//agents//tools/`. + }, }, ], "returnPartialResponses": True or False, # Whether Dialogflow should return currently queued fulfillment response messages in streaming APIs. If a webhook is specified, it happens before Dialogflow invokes webhook. Warning: 1) This flag only affects streaming API. Responses are still queued and returned once in non-streaming API. 2) The flag can be enabled in any fulfillment but only the first 3 partial responses will be returned. You may only want to apply it to fulfillments that have slow webhooks. @@ -15294,8 +16566,8 @@

Method Details

"maxDigits": 42, # Max length of DTMF digits. }, "loggingSettings": { # Define behaviors on logging. # Settings for logging. Settings for Dialogflow History, Contact Center messages, StackDriver logs, and speech logging. Exposed at the following levels: - Agent level. - "enableInteractionLogging": True or False, # If true, DF Interaction logging is currently enabled. - "enableStackdriverLogging": True or False, # If true, StackDriver logging is currently enabled. + "enableInteractionLogging": True or False, # Enables DF Interaction logging. + "enableStackdriverLogging": True or False, # Enables StackDriver logging. }, "speechSettings": { # Define behaviors of speech to text detection. # Settings for speech to text detection. Exposed at the following levels: - Agent level - Flow level - Page level - Parameter level "endpointerSensitivity": 42, # Sensitivity of the speech model that detects the end of speech. Scale from 0 to 100. @@ -15359,6 +16631,13 @@

Method Details

"A String", ], }, + "toolCall": { # Represents a call of a specific tool's action with the specified inputs. # Returns the definition of a tool call that should be executed by the client. + "action": "A String", # Required. The name of the tool's action associated with this call. + "inputParameters": { # Optional. The action's input parameters. + "a_key": "", # Properties of the object. + }, + "tool": "A String", # Required. The tool associated with this call. Format: `projects//locations//agents//tools/`. + }, }, }, ], @@ -15415,6 +16694,13 @@

Method Details

"A String", ], }, + "toolCall": { # Represents a call of a specific tool's action with the specified inputs. # Returns the definition of a tool call that should be executed by the client. + "action": "A String", # Required. The name of the tool's action associated with this call. + "inputParameters": { # Optional. The action's input parameters. + "a_key": "", # Properties of the object. + }, + "tool": "A String", # Required. The tool associated with this call. Format: `projects//locations//agents//tools/`. + }, }, ], "returnPartialResponses": True or False, # Whether Dialogflow should return currently queued fulfillment response messages in streaming APIs. If a webhook is specified, it happens before Dialogflow invokes webhook. Warning: 1) This flag only affects streaming API. Responses are still queued and returned once in non-streaming API. 2) The flag can be enabled in any fulfillment but only the first 3 partial responses will be returned. You may only want to apply it to fulfillments that have slow webhooks. @@ -15444,8 +16730,8 @@

Method Details

"maxDigits": 42, # Max length of DTMF digits. }, "loggingSettings": { # Define behaviors on logging. # Settings for logging. Settings for Dialogflow History, Contact Center messages, StackDriver logs, and speech logging. Exposed at the following levels: - Agent level. - "enableInteractionLogging": True or False, # If true, DF Interaction logging is currently enabled. - "enableStackdriverLogging": True or False, # If true, StackDriver logging is currently enabled. + "enableInteractionLogging": True or False, # Enables DF Interaction logging. + "enableStackdriverLogging": True or False, # Enables StackDriver logging. }, "speechSettings": { # Define behaviors of speech to text detection. # Settings for speech to text detection. Exposed at the following levels: - Agent level - Flow level - Page level - Parameter level "endpointerSensitivity": 42, # Sensitivity of the speech model that detects the end of speech. Scale from 0 to 100. @@ -15473,8 +16759,8 @@

Method Details

"maxDigits": 42, # Max length of DTMF digits. }, "loggingSettings": { # Define behaviors on logging. # Settings for logging. Settings for Dialogflow History, Contact Center messages, StackDriver logs, and speech logging. Exposed at the following levels: - Agent level. - "enableInteractionLogging": True or False, # If true, DF Interaction logging is currently enabled. - "enableStackdriverLogging": True or False, # If true, StackDriver logging is currently enabled. + "enableInteractionLogging": True or False, # Enables DF Interaction logging. + "enableStackdriverLogging": True or False, # Enables StackDriver logging. }, "speechSettings": { # Define behaviors of speech to text detection. # Settings for speech to text detection. Exposed at the following levels: - Agent level - Flow level - Page level - Parameter level "endpointerSensitivity": 42, # Sensitivity of the speech model that detects the end of speech. Scale from 0 to 100. @@ -15538,6 +16824,13 @@

Method Details

"A String", ], }, + "toolCall": { # Represents a call of a specific tool's action with the specified inputs. # Returns the definition of a tool call that should be executed by the client. + "action": "A String", # Required. The name of the tool's action associated with this call. + "inputParameters": { # Optional. The action's input parameters. + "a_key": "", # Properties of the object. + }, + "tool": "A String", # Required. The tool associated with this call. Format: `projects//locations//agents//tools/`. + }, }, }, ], @@ -15594,6 +16887,13 @@

Method Details

"A String", ], }, + "toolCall": { # Represents a call of a specific tool's action with the specified inputs. # Returns the definition of a tool call that should be executed by the client. + "action": "A String", # Required. The name of the tool's action associated with this call. + "inputParameters": { # Optional. The action's input parameters. + "a_key": "", # Properties of the object. + }, + "tool": "A String", # Required. The tool associated with this call. Format: `projects//locations//agents//tools/`. + }, }, ], "returnPartialResponses": True or False, # Whether Dialogflow should return currently queued fulfillment response messages in streaming APIs. If a webhook is specified, it happens before Dialogflow invokes webhook. Warning: 1) This flag only affects streaming API. Responses are still queued and returned once in non-streaming API. 2) The flag can be enabled in any fulfillment but only the first 3 partial responses will be returned. You may only want to apply it to fulfillments that have slow webhooks. @@ -15625,8 +16925,8 @@

Method Details

"maxDigits": 42, # Max length of DTMF digits. }, "loggingSettings": { # Define behaviors on logging. # Settings for logging. Settings for Dialogflow History, Contact Center messages, StackDriver logs, and speech logging. Exposed at the following levels: - Agent level. - "enableInteractionLogging": True or False, # If true, DF Interaction logging is currently enabled. - "enableStackdriverLogging": True or False, # If true, StackDriver logging is currently enabled. + "enableInteractionLogging": True or False, # Enables DF Interaction logging. + "enableStackdriverLogging": True or False, # Enables StackDriver logging. }, "speechSettings": { # Define behaviors of speech to text detection. # Settings for speech to text detection. Exposed at the following levels: - Agent level - Flow level - Page level - Parameter level "endpointerSensitivity": 42, # Sensitivity of the speech model that detects the end of speech. Scale from 0 to 100. @@ -15690,6 +16990,13 @@

Method Details

"A String", ], }, + "toolCall": { # Represents a call of a specific tool's action with the specified inputs. # Returns the definition of a tool call that should be executed by the client. + "action": "A String", # Required. The name of the tool's action associated with this call. + "inputParameters": { # Optional. The action's input parameters. + "a_key": "", # Properties of the object. + }, + "tool": "A String", # Required. The tool associated with this call. Format: `projects//locations//agents//tools/`. + }, }, }, ], @@ -15746,6 +17053,13 @@

Method Details

"A String", ], }, + "toolCall": { # Represents a call of a specific tool's action with the specified inputs. # Returns the definition of a tool call that should be executed by the client. + "action": "A String", # Required. The name of the tool's action associated with this call. + "inputParameters": { # Optional. The action's input parameters. + "a_key": "", # Properties of the object. + }, + "tool": "A String", # Required. The tool associated with this call. Format: `projects//locations//agents//tools/`. + }, }, ], "returnPartialResponses": True or False, # Whether Dialogflow should return currently queued fulfillment response messages in streaming APIs. If a webhook is specified, it happens before Dialogflow invokes webhook. Warning: 1) This flag only affects streaming API. Responses are still queued and returned once in non-streaming API. 2) The flag can be enabled in any fulfillment but only the first 3 partial responses will be returned. You may only want to apply it to fulfillments that have slow webhooks. @@ -15790,8 +17104,8 @@

Method Details

"maxDigits": 42, # Max length of DTMF digits. }, "loggingSettings": { # Define behaviors on logging. # Settings for logging. Settings for Dialogflow History, Contact Center messages, StackDriver logs, and speech logging. Exposed at the following levels: - Agent level. - "enableInteractionLogging": True or False, # If true, DF Interaction logging is currently enabled. - "enableStackdriverLogging": True or False, # If true, StackDriver logging is currently enabled. + "enableInteractionLogging": True or False, # Enables DF Interaction logging. + "enableStackdriverLogging": True or False, # Enables StackDriver logging. }, "speechSettings": { # Define behaviors of speech to text detection. # Settings for speech to text detection. Exposed at the following levels: - Agent level - Flow level - Page level - Parameter level "endpointerSensitivity": 42, # Sensitivity of the speech model that detects the end of speech. Scale from 0 to 100. @@ -15855,6 +17169,13 @@

Method Details

"A String", ], }, + "toolCall": { # Represents a call of a specific tool's action with the specified inputs. # Returns the definition of a tool call that should be executed by the client. + "action": "A String", # Required. The name of the tool's action associated with this call. + "inputParameters": { # Optional. The action's input parameters. + "a_key": "", # Properties of the object. + }, + "tool": "A String", # Required. The tool associated with this call. Format: `projects//locations//agents//tools/`. + }, }, }, ], @@ -15911,6 +17232,13 @@

Method Details

"A String", ], }, + "toolCall": { # Represents a call of a specific tool's action with the specified inputs. # Returns the definition of a tool call that should be executed by the client. + "action": "A String", # Required. The name of the tool's action associated with this call. + "inputParameters": { # Optional. The action's input parameters. + "a_key": "", # Properties of the object. + }, + "tool": "A String", # Required. The tool associated with this call. Format: `projects//locations//agents//tools/`. + }, }, ], "returnPartialResponses": True or False, # Whether Dialogflow should return currently queued fulfillment response messages in streaming APIs. If a webhook is specified, it happens before Dialogflow invokes webhook. Warning: 1) This flag only affects streaming API. Responses are still queued and returned once in non-streaming API. 2) The flag can be enabled in any fulfillment but only the first 3 partial responses will be returned. You may only want to apply it to fulfillments that have slow webhooks. @@ -15949,8 +17277,8 @@

Method Details

"maxDigits": 42, # Max length of DTMF digits. }, "loggingSettings": { # Define behaviors on logging. # Settings for logging. Settings for Dialogflow History, Contact Center messages, StackDriver logs, and speech logging. Exposed at the following levels: - Agent level. - "enableInteractionLogging": True or False, # If true, DF Interaction logging is currently enabled. - "enableStackdriverLogging": True or False, # If true, StackDriver logging is currently enabled. + "enableInteractionLogging": True or False, # Enables DF Interaction logging. + "enableStackdriverLogging": True or False, # Enables StackDriver logging. }, "speechSettings": { # Define behaviors of speech to text detection. # Settings for speech to text detection. Exposed at the following levels: - Agent level - Flow level - Page level - Parameter level "endpointerSensitivity": 42, # Sensitivity of the speech model that detects the end of speech. Scale from 0 to 100. @@ -16014,6 +17342,13 @@

Method Details

"A String", ], }, + "toolCall": { # Represents a call of a specific tool's action with the specified inputs. # Returns the definition of a tool call that should be executed by the client. + "action": "A String", # Required. The name of the tool's action associated with this call. + "inputParameters": { # Optional. The action's input parameters. + "a_key": "", # Properties of the object. + }, + "tool": "A String", # Required. The tool associated with this call. Format: `projects//locations//agents//tools/`. + }, }, }, ], @@ -16070,6 +17405,13 @@

Method Details

"A String", ], }, + "toolCall": { # Represents a call of a specific tool's action with the specified inputs. # Returns the definition of a tool call that should be executed by the client. + "action": "A String", # Required. The name of the tool's action associated with this call. + "inputParameters": { # Optional. The action's input parameters. + "a_key": "", # Properties of the object. + }, + "tool": "A String", # Required. The tool associated with this call. Format: `projects//locations//agents//tools/`. + }, }, ], "returnPartialResponses": True or False, # Whether Dialogflow should return currently queued fulfillment response messages in streaming APIs. If a webhook is specified, it happens before Dialogflow invokes webhook. Warning: 1) This flag only affects streaming API. Responses are still queued and returned once in non-streaming API. 2) The flag can be enabled in any fulfillment but only the first 3 partial responses will be returned. You may only want to apply it to fulfillments that have slow webhooks. @@ -16198,6 +17540,16 @@

Method Details

"text": { # Represents the natural language text to be processed. # The natural language text to be processed. "text": "A String", # Required. The UTF-8 encoded natural language text to be processed. }, + "toolCallResult": { # The result of calling a tool's action that has been executed by the client. # The results of a tool executed by the client. + "action": "A String", # Required. The name of the tool's action associated with this call. + "error": { # An error produced by the tool call. # The tool call's error. + "message": "A String", # Optional. The error message of the function. + }, + "outputParameters": { # The tool call's output parameters. + "a_key": "", # Properties of the object. + }, + "tool": "A String", # Required. The tool associated with this call. Format: `projects//locations//agents//tools/`. + }, }, "isWebhookEnabled": True or False, # If webhooks should be allowed to trigger in response to the user utterance. Often if parameters are injected, webhooks should not be enabled. }, @@ -16215,8 +17567,8 @@

Method Details

"maxDigits": 42, # Max length of DTMF digits. }, "loggingSettings": { # Define behaviors on logging. # Settings for logging. Settings for Dialogflow History, Contact Center messages, StackDriver logs, and speech logging. Exposed at the following levels: - Agent level. - "enableInteractionLogging": True or False, # If true, DF Interaction logging is currently enabled. - "enableStackdriverLogging": True or False, # If true, StackDriver logging is currently enabled. + "enableInteractionLogging": True or False, # Enables DF Interaction logging. + "enableStackdriverLogging": True or False, # Enables StackDriver logging. }, "speechSettings": { # Define behaviors of speech to text detection. # Settings for speech to text detection. Exposed at the following levels: - Agent level - Flow level - Page level - Parameter level "endpointerSensitivity": 42, # Sensitivity of the speech model that detects the end of speech. Scale from 0 to 100. @@ -16242,8 +17594,8 @@

Method Details

"maxDigits": 42, # Max length of DTMF digits. }, "loggingSettings": { # Define behaviors on logging. # Settings for logging. Settings for Dialogflow History, Contact Center messages, StackDriver logs, and speech logging. Exposed at the following levels: - Agent level. - "enableInteractionLogging": True or False, # If true, DF Interaction logging is currently enabled. - "enableStackdriverLogging": True or False, # If true, StackDriver logging is currently enabled. + "enableInteractionLogging": True or False, # Enables DF Interaction logging. + "enableStackdriverLogging": True or False, # Enables StackDriver logging. }, "speechSettings": { # Define behaviors of speech to text detection. # Settings for speech to text detection. Exposed at the following levels: - Agent level - Flow level - Page level - Parameter level "endpointerSensitivity": 42, # Sensitivity of the speech model that detects the end of speech. Scale from 0 to 100. @@ -16307,6 +17659,13 @@

Method Details

"A String", ], }, + "toolCall": { # Represents a call of a specific tool's action with the specified inputs. # Returns the definition of a tool call that should be executed by the client. + "action": "A String", # Required. The name of the tool's action associated with this call. + "inputParameters": { # Optional. The action's input parameters. + "a_key": "", # Properties of the object. + }, + "tool": "A String", # Required. The tool associated with this call. Format: `projects//locations//agents//tools/`. + }, }, }, ], @@ -16363,6 +17722,13 @@

Method Details

"A String", ], }, + "toolCall": { # Represents a call of a specific tool's action with the specified inputs. # Returns the definition of a tool call that should be executed by the client. + "action": "A String", # Required. The name of the tool's action associated with this call. + "inputParameters": { # Optional. The action's input parameters. + "a_key": "", # Properties of the object. + }, + "tool": "A String", # Required. The tool associated with this call. Format: `projects//locations//agents//tools/`. + }, }, ], "returnPartialResponses": True or False, # Whether Dialogflow should return currently queued fulfillment response messages in streaming APIs. If a webhook is specified, it happens before Dialogflow invokes webhook. Warning: 1) This flag only affects streaming API. Responses are still queued and returned once in non-streaming API. 2) The flag can be enabled in any fulfillment but only the first 3 partial responses will be returned. You may only want to apply it to fulfillments that have slow webhooks. @@ -16394,8 +17760,8 @@

Method Details

"maxDigits": 42, # Max length of DTMF digits. }, "loggingSettings": { # Define behaviors on logging. # Settings for logging. Settings for Dialogflow History, Contact Center messages, StackDriver logs, and speech logging. Exposed at the following levels: - Agent level. - "enableInteractionLogging": True or False, # If true, DF Interaction logging is currently enabled. - "enableStackdriverLogging": True or False, # If true, StackDriver logging is currently enabled. + "enableInteractionLogging": True or False, # Enables DF Interaction logging. + "enableStackdriverLogging": True or False, # Enables StackDriver logging. }, "speechSettings": { # Define behaviors of speech to text detection. # Settings for speech to text detection. Exposed at the following levels: - Agent level - Flow level - Page level - Parameter level "endpointerSensitivity": 42, # Sensitivity of the speech model that detects the end of speech. Scale from 0 to 100. @@ -16459,6 +17825,13 @@

Method Details

"A String", ], }, + "toolCall": { # Represents a call of a specific tool's action with the specified inputs. # Returns the definition of a tool call that should be executed by the client. + "action": "A String", # Required. The name of the tool's action associated with this call. + "inputParameters": { # Optional. The action's input parameters. + "a_key": "", # Properties of the object. + }, + "tool": "A String", # Required. The tool associated with this call. Format: `projects//locations//agents//tools/`. + }, }, }, ], @@ -16515,6 +17888,13 @@

Method Details

"A String", ], }, + "toolCall": { # Represents a call of a specific tool's action with the specified inputs. # Returns the definition of a tool call that should be executed by the client. + "action": "A String", # Required. The name of the tool's action associated with this call. + "inputParameters": { # Optional. The action's input parameters. + "a_key": "", # Properties of the object. + }, + "tool": "A String", # Required. The tool associated with this call. Format: `projects//locations//agents//tools/`. + }, }, ], "returnPartialResponses": True or False, # Whether Dialogflow should return currently queued fulfillment response messages in streaming APIs. If a webhook is specified, it happens before Dialogflow invokes webhook. Warning: 1) This flag only affects streaming API. Responses are still queued and returned once in non-streaming API. 2) The flag can be enabled in any fulfillment but only the first 3 partial responses will be returned. You may only want to apply it to fulfillments that have slow webhooks. @@ -16544,8 +17924,8 @@

Method Details

"maxDigits": 42, # Max length of DTMF digits. }, "loggingSettings": { # Define behaviors on logging. # Settings for logging. Settings for Dialogflow History, Contact Center messages, StackDriver logs, and speech logging. Exposed at the following levels: - Agent level. - "enableInteractionLogging": True or False, # If true, DF Interaction logging is currently enabled. - "enableStackdriverLogging": True or False, # If true, StackDriver logging is currently enabled. + "enableInteractionLogging": True or False, # Enables DF Interaction logging. + "enableStackdriverLogging": True or False, # Enables StackDriver logging. }, "speechSettings": { # Define behaviors of speech to text detection. # Settings for speech to text detection. Exposed at the following levels: - Agent level - Flow level - Page level - Parameter level "endpointerSensitivity": 42, # Sensitivity of the speech model that detects the end of speech. Scale from 0 to 100. @@ -16573,8 +17953,8 @@

Method Details

"maxDigits": 42, # Max length of DTMF digits. }, "loggingSettings": { # Define behaviors on logging. # Settings for logging. Settings for Dialogflow History, Contact Center messages, StackDriver logs, and speech logging. Exposed at the following levels: - Agent level. - "enableInteractionLogging": True or False, # If true, DF Interaction logging is currently enabled. - "enableStackdriverLogging": True or False, # If true, StackDriver logging is currently enabled. + "enableInteractionLogging": True or False, # Enables DF Interaction logging. + "enableStackdriverLogging": True or False, # Enables StackDriver logging. }, "speechSettings": { # Define behaviors of speech to text detection. # Settings for speech to text detection. Exposed at the following levels: - Agent level - Flow level - Page level - Parameter level "endpointerSensitivity": 42, # Sensitivity of the speech model that detects the end of speech. Scale from 0 to 100. @@ -16638,6 +18018,13 @@

Method Details

"A String", ], }, + "toolCall": { # Represents a call of a specific tool's action with the specified inputs. # Returns the definition of a tool call that should be executed by the client. + "action": "A String", # Required. The name of the tool's action associated with this call. + "inputParameters": { # Optional. The action's input parameters. + "a_key": "", # Properties of the object. + }, + "tool": "A String", # Required. The tool associated with this call. Format: `projects//locations//agents//tools/`. + }, }, }, ], @@ -16694,6 +18081,13 @@

Method Details

"A String", ], }, + "toolCall": { # Represents a call of a specific tool's action with the specified inputs. # Returns the definition of a tool call that should be executed by the client. + "action": "A String", # Required. The name of the tool's action associated with this call. + "inputParameters": { # Optional. The action's input parameters. + "a_key": "", # Properties of the object. + }, + "tool": "A String", # Required. The tool associated with this call. Format: `projects//locations//agents//tools/`. + }, }, ], "returnPartialResponses": True or False, # Whether Dialogflow should return currently queued fulfillment response messages in streaming APIs. If a webhook is specified, it happens before Dialogflow invokes webhook. Warning: 1) This flag only affects streaming API. Responses are still queued and returned once in non-streaming API. 2) The flag can be enabled in any fulfillment but only the first 3 partial responses will be returned. You may only want to apply it to fulfillments that have slow webhooks. @@ -16725,8 +18119,8 @@

Method Details

"maxDigits": 42, # Max length of DTMF digits. }, "loggingSettings": { # Define behaviors on logging. # Settings for logging. Settings for Dialogflow History, Contact Center messages, StackDriver logs, and speech logging. Exposed at the following levels: - Agent level. - "enableInteractionLogging": True or False, # If true, DF Interaction logging is currently enabled. - "enableStackdriverLogging": True or False, # If true, StackDriver logging is currently enabled. + "enableInteractionLogging": True or False, # Enables DF Interaction logging. + "enableStackdriverLogging": True or False, # Enables StackDriver logging. }, "speechSettings": { # Define behaviors of speech to text detection. # Settings for speech to text detection. Exposed at the following levels: - Agent level - Flow level - Page level - Parameter level "endpointerSensitivity": 42, # Sensitivity of the speech model that detects the end of speech. Scale from 0 to 100. @@ -16790,6 +18184,13 @@

Method Details

"A String", ], }, + "toolCall": { # Represents a call of a specific tool's action with the specified inputs. # Returns the definition of a tool call that should be executed by the client. + "action": "A String", # Required. The name of the tool's action associated with this call. + "inputParameters": { # Optional. The action's input parameters. + "a_key": "", # Properties of the object. + }, + "tool": "A String", # Required. The tool associated with this call. Format: `projects//locations//agents//tools/`. + }, }, }, ], @@ -16846,6 +18247,13 @@

Method Details

"A String", ], }, + "toolCall": { # Represents a call of a specific tool's action with the specified inputs. # Returns the definition of a tool call that should be executed by the client. + "action": "A String", # Required. The name of the tool's action associated with this call. + "inputParameters": { # Optional. The action's input parameters. + "a_key": "", # Properties of the object. + }, + "tool": "A String", # Required. The tool associated with this call. Format: `projects//locations//agents//tools/`. + }, }, ], "returnPartialResponses": True or False, # Whether Dialogflow should return currently queued fulfillment response messages in streaming APIs. If a webhook is specified, it happens before Dialogflow invokes webhook. Warning: 1) This flag only affects streaming API. Responses are still queued and returned once in non-streaming API. 2) The flag can be enabled in any fulfillment but only the first 3 partial responses will be returned. You may only want to apply it to fulfillments that have slow webhooks. @@ -16890,8 +18298,8 @@

Method Details

"maxDigits": 42, # Max length of DTMF digits. }, "loggingSettings": { # Define behaviors on logging. # Settings for logging. Settings for Dialogflow History, Contact Center messages, StackDriver logs, and speech logging. Exposed at the following levels: - Agent level. - "enableInteractionLogging": True or False, # If true, DF Interaction logging is currently enabled. - "enableStackdriverLogging": True or False, # If true, StackDriver logging is currently enabled. + "enableInteractionLogging": True or False, # Enables DF Interaction logging. + "enableStackdriverLogging": True or False, # Enables StackDriver logging. }, "speechSettings": { # Define behaviors of speech to text detection. # Settings for speech to text detection. Exposed at the following levels: - Agent level - Flow level - Page level - Parameter level "endpointerSensitivity": 42, # Sensitivity of the speech model that detects the end of speech. Scale from 0 to 100. @@ -16955,6 +18363,13 @@

Method Details

"A String", ], }, + "toolCall": { # Represents a call of a specific tool's action with the specified inputs. # Returns the definition of a tool call that should be executed by the client. + "action": "A String", # Required. The name of the tool's action associated with this call. + "inputParameters": { # Optional. The action's input parameters. + "a_key": "", # Properties of the object. + }, + "tool": "A String", # Required. The tool associated with this call. Format: `projects//locations//agents//tools/`. + }, }, }, ], @@ -17011,6 +18426,13 @@

Method Details

"A String", ], }, + "toolCall": { # Represents a call of a specific tool's action with the specified inputs. # Returns the definition of a tool call that should be executed by the client. + "action": "A String", # Required. The name of the tool's action associated with this call. + "inputParameters": { # Optional. The action's input parameters. + "a_key": "", # Properties of the object. + }, + "tool": "A String", # Required. The tool associated with this call. Format: `projects//locations//agents//tools/`. + }, }, ], "returnPartialResponses": True or False, # Whether Dialogflow should return currently queued fulfillment response messages in streaming APIs. If a webhook is specified, it happens before Dialogflow invokes webhook. Warning: 1) This flag only affects streaming API. Responses are still queued and returned once in non-streaming API. 2) The flag can be enabled in any fulfillment but only the first 3 partial responses will be returned. You may only want to apply it to fulfillments that have slow webhooks. @@ -17049,8 +18471,8 @@

Method Details

"maxDigits": 42, # Max length of DTMF digits. }, "loggingSettings": { # Define behaviors on logging. # Settings for logging. Settings for Dialogflow History, Contact Center messages, StackDriver logs, and speech logging. Exposed at the following levels: - Agent level. - "enableInteractionLogging": True or False, # If true, DF Interaction logging is currently enabled. - "enableStackdriverLogging": True or False, # If true, StackDriver logging is currently enabled. + "enableInteractionLogging": True or False, # Enables DF Interaction logging. + "enableStackdriverLogging": True or False, # Enables StackDriver logging. }, "speechSettings": { # Define behaviors of speech to text detection. # Settings for speech to text detection. Exposed at the following levels: - Agent level - Flow level - Page level - Parameter level "endpointerSensitivity": 42, # Sensitivity of the speech model that detects the end of speech. Scale from 0 to 100. @@ -17114,6 +18536,13 @@

Method Details

"A String", ], }, + "toolCall": { # Represents a call of a specific tool's action with the specified inputs. # Returns the definition of a tool call that should be executed by the client. + "action": "A String", # Required. The name of the tool's action associated with this call. + "inputParameters": { # Optional. The action's input parameters. + "a_key": "", # Properties of the object. + }, + "tool": "A String", # Required. The tool associated with this call. Format: `projects//locations//agents//tools/`. + }, }, }, ], @@ -17170,6 +18599,13 @@

Method Details

"A String", ], }, + "toolCall": { # Represents a call of a specific tool's action with the specified inputs. # Returns the definition of a tool call that should be executed by the client. + "action": "A String", # Required. The name of the tool's action associated with this call. + "inputParameters": { # Optional. The action's input parameters. + "a_key": "", # Properties of the object. + }, + "tool": "A String", # Required. The tool associated with this call. Format: `projects//locations//agents//tools/`. + }, }, ], "returnPartialResponses": True or False, # Whether Dialogflow should return currently queued fulfillment response messages in streaming APIs. If a webhook is specified, it happens before Dialogflow invokes webhook. Warning: 1) This flag only affects streaming API. Responses are still queued and returned once in non-streaming API. 2) The flag can be enabled in any fulfillment but only the first 3 partial responses will be returned. You may only want to apply it to fulfillments that have slow webhooks. diff --git a/docs/dyn/dialogflow_v3beta1.projects.locations.agents.testCases.results.html b/docs/dyn/dialogflow_v3beta1.projects.locations.agents.testCases.results.html index 11551ae564f..29ee57e02b2 100644 --- a/docs/dyn/dialogflow_v3beta1.projects.locations.agents.testCases.results.html +++ b/docs/dyn/dialogflow_v3beta1.projects.locations.agents.testCases.results.html @@ -148,6 +148,16 @@

Method Details

"text": { # Represents the natural language text to be processed. # The natural language text to be processed. "text": "A String", # Required. The UTF-8 encoded natural language text to be processed. }, + "toolCallResult": { # The result of calling a tool's action that has been executed by the client. # The results of a tool executed by the client. + "action": "A String", # Required. The name of the tool's action associated with this call. + "error": { # An error produced by the tool call. # The tool call's error. + "message": "A String", # Optional. The error message of the function. + }, + "outputParameters": { # The tool call's output parameters. + "a_key": "", # Properties of the object. + }, + "tool": "A String", # Required. The tool associated with this call. Format: `projects//locations//agents//tools/`. + }, }, "isWebhookEnabled": True or False, # If webhooks should be allowed to trigger in response to the user utterance. Often if parameters are injected, webhooks should not be enabled. }, @@ -165,8 +175,8 @@

Method Details

"maxDigits": 42, # Max length of DTMF digits. }, "loggingSettings": { # Define behaviors on logging. # Settings for logging. Settings for Dialogflow History, Contact Center messages, StackDriver logs, and speech logging. Exposed at the following levels: - Agent level. - "enableInteractionLogging": True or False, # If true, DF Interaction logging is currently enabled. - "enableStackdriverLogging": True or False, # If true, StackDriver logging is currently enabled. + "enableInteractionLogging": True or False, # Enables DF Interaction logging. + "enableStackdriverLogging": True or False, # Enables StackDriver logging. }, "speechSettings": { # Define behaviors of speech to text detection. # Settings for speech to text detection. Exposed at the following levels: - Agent level - Flow level - Page level - Parameter level "endpointerSensitivity": 42, # Sensitivity of the speech model that detects the end of speech. Scale from 0 to 100. @@ -192,8 +202,8 @@

Method Details

"maxDigits": 42, # Max length of DTMF digits. }, "loggingSettings": { # Define behaviors on logging. # Settings for logging. Settings for Dialogflow History, Contact Center messages, StackDriver logs, and speech logging. Exposed at the following levels: - Agent level. - "enableInteractionLogging": True or False, # If true, DF Interaction logging is currently enabled. - "enableStackdriverLogging": True or False, # If true, StackDriver logging is currently enabled. + "enableInteractionLogging": True or False, # Enables DF Interaction logging. + "enableStackdriverLogging": True or False, # Enables StackDriver logging. }, "speechSettings": { # Define behaviors of speech to text detection. # Settings for speech to text detection. Exposed at the following levels: - Agent level - Flow level - Page level - Parameter level "endpointerSensitivity": 42, # Sensitivity of the speech model that detects the end of speech. Scale from 0 to 100. @@ -257,6 +267,13 @@

Method Details

"A String", ], }, + "toolCall": { # Represents a call of a specific tool's action with the specified inputs. # Returns the definition of a tool call that should be executed by the client. + "action": "A String", # Required. The name of the tool's action associated with this call. + "inputParameters": { # Optional. The action's input parameters. + "a_key": "", # Properties of the object. + }, + "tool": "A String", # Required. The tool associated with this call. Format: `projects//locations//agents//tools/`. + }, }, }, ], @@ -313,6 +330,13 @@

Method Details

"A String", ], }, + "toolCall": { # Represents a call of a specific tool's action with the specified inputs. # Returns the definition of a tool call that should be executed by the client. + "action": "A String", # Required. The name of the tool's action associated with this call. + "inputParameters": { # Optional. The action's input parameters. + "a_key": "", # Properties of the object. + }, + "tool": "A String", # Required. The tool associated with this call. Format: `projects//locations//agents//tools/`. + }, }, ], "returnPartialResponses": True or False, # Whether Dialogflow should return currently queued fulfillment response messages in streaming APIs. If a webhook is specified, it happens before Dialogflow invokes webhook. Warning: 1) This flag only affects streaming API. Responses are still queued and returned once in non-streaming API. 2) The flag can be enabled in any fulfillment but only the first 3 partial responses will be returned. You may only want to apply it to fulfillments that have slow webhooks. @@ -344,8 +368,8 @@

Method Details

"maxDigits": 42, # Max length of DTMF digits. }, "loggingSettings": { # Define behaviors on logging. # Settings for logging. Settings for Dialogflow History, Contact Center messages, StackDriver logs, and speech logging. Exposed at the following levels: - Agent level. - "enableInteractionLogging": True or False, # If true, DF Interaction logging is currently enabled. - "enableStackdriverLogging": True or False, # If true, StackDriver logging is currently enabled. + "enableInteractionLogging": True or False, # Enables DF Interaction logging. + "enableStackdriverLogging": True or False, # Enables StackDriver logging. }, "speechSettings": { # Define behaviors of speech to text detection. # Settings for speech to text detection. Exposed at the following levels: - Agent level - Flow level - Page level - Parameter level "endpointerSensitivity": 42, # Sensitivity of the speech model that detects the end of speech. Scale from 0 to 100. @@ -409,6 +433,13 @@

Method Details

"A String", ], }, + "toolCall": { # Represents a call of a specific tool's action with the specified inputs. # Returns the definition of a tool call that should be executed by the client. + "action": "A String", # Required. The name of the tool's action associated with this call. + "inputParameters": { # Optional. The action's input parameters. + "a_key": "", # Properties of the object. + }, + "tool": "A String", # Required. The tool associated with this call. Format: `projects//locations//agents//tools/`. + }, }, }, ], @@ -465,6 +496,13 @@

Method Details

"A String", ], }, + "toolCall": { # Represents a call of a specific tool's action with the specified inputs. # Returns the definition of a tool call that should be executed by the client. + "action": "A String", # Required. The name of the tool's action associated with this call. + "inputParameters": { # Optional. The action's input parameters. + "a_key": "", # Properties of the object. + }, + "tool": "A String", # Required. The tool associated with this call. Format: `projects//locations//agents//tools/`. + }, }, ], "returnPartialResponses": True or False, # Whether Dialogflow should return currently queued fulfillment response messages in streaming APIs. If a webhook is specified, it happens before Dialogflow invokes webhook. Warning: 1) This flag only affects streaming API. Responses are still queued and returned once in non-streaming API. 2) The flag can be enabled in any fulfillment but only the first 3 partial responses will be returned. You may only want to apply it to fulfillments that have slow webhooks. @@ -494,8 +532,8 @@

Method Details

"maxDigits": 42, # Max length of DTMF digits. }, "loggingSettings": { # Define behaviors on logging. # Settings for logging. Settings for Dialogflow History, Contact Center messages, StackDriver logs, and speech logging. Exposed at the following levels: - Agent level. - "enableInteractionLogging": True or False, # If true, DF Interaction logging is currently enabled. - "enableStackdriverLogging": True or False, # If true, StackDriver logging is currently enabled. + "enableInteractionLogging": True or False, # Enables DF Interaction logging. + "enableStackdriverLogging": True or False, # Enables StackDriver logging. }, "speechSettings": { # Define behaviors of speech to text detection. # Settings for speech to text detection. Exposed at the following levels: - Agent level - Flow level - Page level - Parameter level "endpointerSensitivity": 42, # Sensitivity of the speech model that detects the end of speech. Scale from 0 to 100. @@ -523,8 +561,8 @@

Method Details

"maxDigits": 42, # Max length of DTMF digits. }, "loggingSettings": { # Define behaviors on logging. # Settings for logging. Settings for Dialogflow History, Contact Center messages, StackDriver logs, and speech logging. Exposed at the following levels: - Agent level. - "enableInteractionLogging": True or False, # If true, DF Interaction logging is currently enabled. - "enableStackdriverLogging": True or False, # If true, StackDriver logging is currently enabled. + "enableInteractionLogging": True or False, # Enables DF Interaction logging. + "enableStackdriverLogging": True or False, # Enables StackDriver logging. }, "speechSettings": { # Define behaviors of speech to text detection. # Settings for speech to text detection. Exposed at the following levels: - Agent level - Flow level - Page level - Parameter level "endpointerSensitivity": 42, # Sensitivity of the speech model that detects the end of speech. Scale from 0 to 100. @@ -588,6 +626,13 @@

Method Details

"A String", ], }, + "toolCall": { # Represents a call of a specific tool's action with the specified inputs. # Returns the definition of a tool call that should be executed by the client. + "action": "A String", # Required. The name of the tool's action associated with this call. + "inputParameters": { # Optional. The action's input parameters. + "a_key": "", # Properties of the object. + }, + "tool": "A String", # Required. The tool associated with this call. Format: `projects//locations//agents//tools/`. + }, }, }, ], @@ -644,6 +689,13 @@

Method Details

"A String", ], }, + "toolCall": { # Represents a call of a specific tool's action with the specified inputs. # Returns the definition of a tool call that should be executed by the client. + "action": "A String", # Required. The name of the tool's action associated with this call. + "inputParameters": { # Optional. The action's input parameters. + "a_key": "", # Properties of the object. + }, + "tool": "A String", # Required. The tool associated with this call. Format: `projects//locations//agents//tools/`. + }, }, ], "returnPartialResponses": True or False, # Whether Dialogflow should return currently queued fulfillment response messages in streaming APIs. If a webhook is specified, it happens before Dialogflow invokes webhook. Warning: 1) This flag only affects streaming API. Responses are still queued and returned once in non-streaming API. 2) The flag can be enabled in any fulfillment but only the first 3 partial responses will be returned. You may only want to apply it to fulfillments that have slow webhooks. @@ -675,8 +727,8 @@

Method Details

"maxDigits": 42, # Max length of DTMF digits. }, "loggingSettings": { # Define behaviors on logging. # Settings for logging. Settings for Dialogflow History, Contact Center messages, StackDriver logs, and speech logging. Exposed at the following levels: - Agent level. - "enableInteractionLogging": True or False, # If true, DF Interaction logging is currently enabled. - "enableStackdriverLogging": True or False, # If true, StackDriver logging is currently enabled. + "enableInteractionLogging": True or False, # Enables DF Interaction logging. + "enableStackdriverLogging": True or False, # Enables StackDriver logging. }, "speechSettings": { # Define behaviors of speech to text detection. # Settings for speech to text detection. Exposed at the following levels: - Agent level - Flow level - Page level - Parameter level "endpointerSensitivity": 42, # Sensitivity of the speech model that detects the end of speech. Scale from 0 to 100. @@ -740,6 +792,13 @@

Method Details

"A String", ], }, + "toolCall": { # Represents a call of a specific tool's action with the specified inputs. # Returns the definition of a tool call that should be executed by the client. + "action": "A String", # Required. The name of the tool's action associated with this call. + "inputParameters": { # Optional. The action's input parameters. + "a_key": "", # Properties of the object. + }, + "tool": "A String", # Required. The tool associated with this call. Format: `projects//locations//agents//tools/`. + }, }, }, ], @@ -796,6 +855,13 @@

Method Details

"A String", ], }, + "toolCall": { # Represents a call of a specific tool's action with the specified inputs. # Returns the definition of a tool call that should be executed by the client. + "action": "A String", # Required. The name of the tool's action associated with this call. + "inputParameters": { # Optional. The action's input parameters. + "a_key": "", # Properties of the object. + }, + "tool": "A String", # Required. The tool associated with this call. Format: `projects//locations//agents//tools/`. + }, }, ], "returnPartialResponses": True or False, # Whether Dialogflow should return currently queued fulfillment response messages in streaming APIs. If a webhook is specified, it happens before Dialogflow invokes webhook. Warning: 1) This flag only affects streaming API. Responses are still queued and returned once in non-streaming API. 2) The flag can be enabled in any fulfillment but only the first 3 partial responses will be returned. You may only want to apply it to fulfillments that have slow webhooks. @@ -840,8 +906,8 @@

Method Details

"maxDigits": 42, # Max length of DTMF digits. }, "loggingSettings": { # Define behaviors on logging. # Settings for logging. Settings for Dialogflow History, Contact Center messages, StackDriver logs, and speech logging. Exposed at the following levels: - Agent level. - "enableInteractionLogging": True or False, # If true, DF Interaction logging is currently enabled. - "enableStackdriverLogging": True or False, # If true, StackDriver logging is currently enabled. + "enableInteractionLogging": True or False, # Enables DF Interaction logging. + "enableStackdriverLogging": True or False, # Enables StackDriver logging. }, "speechSettings": { # Define behaviors of speech to text detection. # Settings for speech to text detection. Exposed at the following levels: - Agent level - Flow level - Page level - Parameter level "endpointerSensitivity": 42, # Sensitivity of the speech model that detects the end of speech. Scale from 0 to 100. @@ -905,6 +971,13 @@

Method Details

"A String", ], }, + "toolCall": { # Represents a call of a specific tool's action with the specified inputs. # Returns the definition of a tool call that should be executed by the client. + "action": "A String", # Required. The name of the tool's action associated with this call. + "inputParameters": { # Optional. The action's input parameters. + "a_key": "", # Properties of the object. + }, + "tool": "A String", # Required. The tool associated with this call. Format: `projects//locations//agents//tools/`. + }, }, }, ], @@ -961,6 +1034,13 @@

Method Details

"A String", ], }, + "toolCall": { # Represents a call of a specific tool's action with the specified inputs. # Returns the definition of a tool call that should be executed by the client. + "action": "A String", # Required. The name of the tool's action associated with this call. + "inputParameters": { # Optional. The action's input parameters. + "a_key": "", # Properties of the object. + }, + "tool": "A String", # Required. The tool associated with this call. Format: `projects//locations//agents//tools/`. + }, }, ], "returnPartialResponses": True or False, # Whether Dialogflow should return currently queued fulfillment response messages in streaming APIs. If a webhook is specified, it happens before Dialogflow invokes webhook. Warning: 1) This flag only affects streaming API. Responses are still queued and returned once in non-streaming API. 2) The flag can be enabled in any fulfillment but only the first 3 partial responses will be returned. You may only want to apply it to fulfillments that have slow webhooks. @@ -999,8 +1079,8 @@

Method Details

"maxDigits": 42, # Max length of DTMF digits. }, "loggingSettings": { # Define behaviors on logging. # Settings for logging. Settings for Dialogflow History, Contact Center messages, StackDriver logs, and speech logging. Exposed at the following levels: - Agent level. - "enableInteractionLogging": True or False, # If true, DF Interaction logging is currently enabled. - "enableStackdriverLogging": True or False, # If true, StackDriver logging is currently enabled. + "enableInteractionLogging": True or False, # Enables DF Interaction logging. + "enableStackdriverLogging": True or False, # Enables StackDriver logging. }, "speechSettings": { # Define behaviors of speech to text detection. # Settings for speech to text detection. Exposed at the following levels: - Agent level - Flow level - Page level - Parameter level "endpointerSensitivity": 42, # Sensitivity of the speech model that detects the end of speech. Scale from 0 to 100. @@ -1064,6 +1144,13 @@

Method Details

"A String", ], }, + "toolCall": { # Represents a call of a specific tool's action with the specified inputs. # Returns the definition of a tool call that should be executed by the client. + "action": "A String", # Required. The name of the tool's action associated with this call. + "inputParameters": { # Optional. The action's input parameters. + "a_key": "", # Properties of the object. + }, + "tool": "A String", # Required. The tool associated with this call. Format: `projects//locations//agents//tools/`. + }, }, }, ], @@ -1120,6 +1207,13 @@

Method Details

"A String", ], }, + "toolCall": { # Represents a call of a specific tool's action with the specified inputs. # Returns the definition of a tool call that should be executed by the client. + "action": "A String", # Required. The name of the tool's action associated with this call. + "inputParameters": { # Optional. The action's input parameters. + "a_key": "", # Properties of the object. + }, + "tool": "A String", # Required. The tool associated with this call. Format: `projects//locations//agents//tools/`. + }, }, ], "returnPartialResponses": True or False, # Whether Dialogflow should return currently queued fulfillment response messages in streaming APIs. If a webhook is specified, it happens before Dialogflow invokes webhook. Warning: 1) This flag only affects streaming API. Responses are still queued and returned once in non-streaming API. 2) The flag can be enabled in any fulfillment but only the first 3 partial responses will be returned. You may only want to apply it to fulfillments that have slow webhooks. @@ -1266,6 +1360,16 @@

Method Details

"text": { # Represents the natural language text to be processed. # The natural language text to be processed. "text": "A String", # Required. The UTF-8 encoded natural language text to be processed. }, + "toolCallResult": { # The result of calling a tool's action that has been executed by the client. # The results of a tool executed by the client. + "action": "A String", # Required. The name of the tool's action associated with this call. + "error": { # An error produced by the tool call. # The tool call's error. + "message": "A String", # Optional. The error message of the function. + }, + "outputParameters": { # The tool call's output parameters. + "a_key": "", # Properties of the object. + }, + "tool": "A String", # Required. The tool associated with this call. Format: `projects//locations//agents//tools/`. + }, }, "isWebhookEnabled": True or False, # If webhooks should be allowed to trigger in response to the user utterance. Often if parameters are injected, webhooks should not be enabled. }, @@ -1283,8 +1387,8 @@

Method Details

"maxDigits": 42, # Max length of DTMF digits. }, "loggingSettings": { # Define behaviors on logging. # Settings for logging. Settings for Dialogflow History, Contact Center messages, StackDriver logs, and speech logging. Exposed at the following levels: - Agent level. - "enableInteractionLogging": True or False, # If true, DF Interaction logging is currently enabled. - "enableStackdriverLogging": True or False, # If true, StackDriver logging is currently enabled. + "enableInteractionLogging": True or False, # Enables DF Interaction logging. + "enableStackdriverLogging": True or False, # Enables StackDriver logging. }, "speechSettings": { # Define behaviors of speech to text detection. # Settings for speech to text detection. Exposed at the following levels: - Agent level - Flow level - Page level - Parameter level "endpointerSensitivity": 42, # Sensitivity of the speech model that detects the end of speech. Scale from 0 to 100. @@ -1310,8 +1414,8 @@

Method Details

"maxDigits": 42, # Max length of DTMF digits. }, "loggingSettings": { # Define behaviors on logging. # Settings for logging. Settings for Dialogflow History, Contact Center messages, StackDriver logs, and speech logging. Exposed at the following levels: - Agent level. - "enableInteractionLogging": True or False, # If true, DF Interaction logging is currently enabled. - "enableStackdriverLogging": True or False, # If true, StackDriver logging is currently enabled. + "enableInteractionLogging": True or False, # Enables DF Interaction logging. + "enableStackdriverLogging": True or False, # Enables StackDriver logging. }, "speechSettings": { # Define behaviors of speech to text detection. # Settings for speech to text detection. Exposed at the following levels: - Agent level - Flow level - Page level - Parameter level "endpointerSensitivity": 42, # Sensitivity of the speech model that detects the end of speech. Scale from 0 to 100. @@ -1375,6 +1479,13 @@

Method Details

"A String", ], }, + "toolCall": { # Represents a call of a specific tool's action with the specified inputs. # Returns the definition of a tool call that should be executed by the client. + "action": "A String", # Required. The name of the tool's action associated with this call. + "inputParameters": { # Optional. The action's input parameters. + "a_key": "", # Properties of the object. + }, + "tool": "A String", # Required. The tool associated with this call. Format: `projects//locations//agents//tools/`. + }, }, }, ], @@ -1431,6 +1542,13 @@

Method Details

"A String", ], }, + "toolCall": { # Represents a call of a specific tool's action with the specified inputs. # Returns the definition of a tool call that should be executed by the client. + "action": "A String", # Required. The name of the tool's action associated with this call. + "inputParameters": { # Optional. The action's input parameters. + "a_key": "", # Properties of the object. + }, + "tool": "A String", # Required. The tool associated with this call. Format: `projects//locations//agents//tools/`. + }, }, ], "returnPartialResponses": True or False, # Whether Dialogflow should return currently queued fulfillment response messages in streaming APIs. If a webhook is specified, it happens before Dialogflow invokes webhook. Warning: 1) This flag only affects streaming API. Responses are still queued and returned once in non-streaming API. 2) The flag can be enabled in any fulfillment but only the first 3 partial responses will be returned. You may only want to apply it to fulfillments that have slow webhooks. @@ -1462,8 +1580,8 @@

Method Details

"maxDigits": 42, # Max length of DTMF digits. }, "loggingSettings": { # Define behaviors on logging. # Settings for logging. Settings for Dialogflow History, Contact Center messages, StackDriver logs, and speech logging. Exposed at the following levels: - Agent level. - "enableInteractionLogging": True or False, # If true, DF Interaction logging is currently enabled. - "enableStackdriverLogging": True or False, # If true, StackDriver logging is currently enabled. + "enableInteractionLogging": True or False, # Enables DF Interaction logging. + "enableStackdriverLogging": True or False, # Enables StackDriver logging. }, "speechSettings": { # Define behaviors of speech to text detection. # Settings for speech to text detection. Exposed at the following levels: - Agent level - Flow level - Page level - Parameter level "endpointerSensitivity": 42, # Sensitivity of the speech model that detects the end of speech. Scale from 0 to 100. @@ -1527,6 +1645,13 @@

Method Details

"A String", ], }, + "toolCall": { # Represents a call of a specific tool's action with the specified inputs. # Returns the definition of a tool call that should be executed by the client. + "action": "A String", # Required. The name of the tool's action associated with this call. + "inputParameters": { # Optional. The action's input parameters. + "a_key": "", # Properties of the object. + }, + "tool": "A String", # Required. The tool associated with this call. Format: `projects//locations//agents//tools/`. + }, }, }, ], @@ -1583,6 +1708,13 @@

Method Details

"A String", ], }, + "toolCall": { # Represents a call of a specific tool's action with the specified inputs. # Returns the definition of a tool call that should be executed by the client. + "action": "A String", # Required. The name of the tool's action associated with this call. + "inputParameters": { # Optional. The action's input parameters. + "a_key": "", # Properties of the object. + }, + "tool": "A String", # Required. The tool associated with this call. Format: `projects//locations//agents//tools/`. + }, }, ], "returnPartialResponses": True or False, # Whether Dialogflow should return currently queued fulfillment response messages in streaming APIs. If a webhook is specified, it happens before Dialogflow invokes webhook. Warning: 1) This flag only affects streaming API. Responses are still queued and returned once in non-streaming API. 2) The flag can be enabled in any fulfillment but only the first 3 partial responses will be returned. You may only want to apply it to fulfillments that have slow webhooks. @@ -1612,8 +1744,8 @@

Method Details

"maxDigits": 42, # Max length of DTMF digits. }, "loggingSettings": { # Define behaviors on logging. # Settings for logging. Settings for Dialogflow History, Contact Center messages, StackDriver logs, and speech logging. Exposed at the following levels: - Agent level. - "enableInteractionLogging": True or False, # If true, DF Interaction logging is currently enabled. - "enableStackdriverLogging": True or False, # If true, StackDriver logging is currently enabled. + "enableInteractionLogging": True or False, # Enables DF Interaction logging. + "enableStackdriverLogging": True or False, # Enables StackDriver logging. }, "speechSettings": { # Define behaviors of speech to text detection. # Settings for speech to text detection. Exposed at the following levels: - Agent level - Flow level - Page level - Parameter level "endpointerSensitivity": 42, # Sensitivity of the speech model that detects the end of speech. Scale from 0 to 100. @@ -1641,8 +1773,8 @@

Method Details

"maxDigits": 42, # Max length of DTMF digits. }, "loggingSettings": { # Define behaviors on logging. # Settings for logging. Settings for Dialogflow History, Contact Center messages, StackDriver logs, and speech logging. Exposed at the following levels: - Agent level. - "enableInteractionLogging": True or False, # If true, DF Interaction logging is currently enabled. - "enableStackdriverLogging": True or False, # If true, StackDriver logging is currently enabled. + "enableInteractionLogging": True or False, # Enables DF Interaction logging. + "enableStackdriverLogging": True or False, # Enables StackDriver logging. }, "speechSettings": { # Define behaviors of speech to text detection. # Settings for speech to text detection. Exposed at the following levels: - Agent level - Flow level - Page level - Parameter level "endpointerSensitivity": 42, # Sensitivity of the speech model that detects the end of speech. Scale from 0 to 100. @@ -1706,6 +1838,13 @@

Method Details

"A String", ], }, + "toolCall": { # Represents a call of a specific tool's action with the specified inputs. # Returns the definition of a tool call that should be executed by the client. + "action": "A String", # Required. The name of the tool's action associated with this call. + "inputParameters": { # Optional. The action's input parameters. + "a_key": "", # Properties of the object. + }, + "tool": "A String", # Required. The tool associated with this call. Format: `projects//locations//agents//tools/`. + }, }, }, ], @@ -1762,6 +1901,13 @@

Method Details

"A String", ], }, + "toolCall": { # Represents a call of a specific tool's action with the specified inputs. # Returns the definition of a tool call that should be executed by the client. + "action": "A String", # Required. The name of the tool's action associated with this call. + "inputParameters": { # Optional. The action's input parameters. + "a_key": "", # Properties of the object. + }, + "tool": "A String", # Required. The tool associated with this call. Format: `projects//locations//agents//tools/`. + }, }, ], "returnPartialResponses": True or False, # Whether Dialogflow should return currently queued fulfillment response messages in streaming APIs. If a webhook is specified, it happens before Dialogflow invokes webhook. Warning: 1) This flag only affects streaming API. Responses are still queued and returned once in non-streaming API. 2) The flag can be enabled in any fulfillment but only the first 3 partial responses will be returned. You may only want to apply it to fulfillments that have slow webhooks. @@ -1793,8 +1939,8 @@

Method Details

"maxDigits": 42, # Max length of DTMF digits. }, "loggingSettings": { # Define behaviors on logging. # Settings for logging. Settings for Dialogflow History, Contact Center messages, StackDriver logs, and speech logging. Exposed at the following levels: - Agent level. - "enableInteractionLogging": True or False, # If true, DF Interaction logging is currently enabled. - "enableStackdriverLogging": True or False, # If true, StackDriver logging is currently enabled. + "enableInteractionLogging": True or False, # Enables DF Interaction logging. + "enableStackdriverLogging": True or False, # Enables StackDriver logging. }, "speechSettings": { # Define behaviors of speech to text detection. # Settings for speech to text detection. Exposed at the following levels: - Agent level - Flow level - Page level - Parameter level "endpointerSensitivity": 42, # Sensitivity of the speech model that detects the end of speech. Scale from 0 to 100. @@ -1858,6 +2004,13 @@

Method Details

"A String", ], }, + "toolCall": { # Represents a call of a specific tool's action with the specified inputs. # Returns the definition of a tool call that should be executed by the client. + "action": "A String", # Required. The name of the tool's action associated with this call. + "inputParameters": { # Optional. The action's input parameters. + "a_key": "", # Properties of the object. + }, + "tool": "A String", # Required. The tool associated with this call. Format: `projects//locations//agents//tools/`. + }, }, }, ], @@ -1914,6 +2067,13 @@

Method Details

"A String", ], }, + "toolCall": { # Represents a call of a specific tool's action with the specified inputs. # Returns the definition of a tool call that should be executed by the client. + "action": "A String", # Required. The name of the tool's action associated with this call. + "inputParameters": { # Optional. The action's input parameters. + "a_key": "", # Properties of the object. + }, + "tool": "A String", # Required. The tool associated with this call. Format: `projects//locations//agents//tools/`. + }, }, ], "returnPartialResponses": True or False, # Whether Dialogflow should return currently queued fulfillment response messages in streaming APIs. If a webhook is specified, it happens before Dialogflow invokes webhook. Warning: 1) This flag only affects streaming API. Responses are still queued and returned once in non-streaming API. 2) The flag can be enabled in any fulfillment but only the first 3 partial responses will be returned. You may only want to apply it to fulfillments that have slow webhooks. @@ -1958,8 +2118,8 @@

Method Details

"maxDigits": 42, # Max length of DTMF digits. }, "loggingSettings": { # Define behaviors on logging. # Settings for logging. Settings for Dialogflow History, Contact Center messages, StackDriver logs, and speech logging. Exposed at the following levels: - Agent level. - "enableInteractionLogging": True or False, # If true, DF Interaction logging is currently enabled. - "enableStackdriverLogging": True or False, # If true, StackDriver logging is currently enabled. + "enableInteractionLogging": True or False, # Enables DF Interaction logging. + "enableStackdriverLogging": True or False, # Enables StackDriver logging. }, "speechSettings": { # Define behaviors of speech to text detection. # Settings for speech to text detection. Exposed at the following levels: - Agent level - Flow level - Page level - Parameter level "endpointerSensitivity": 42, # Sensitivity of the speech model that detects the end of speech. Scale from 0 to 100. @@ -2023,6 +2183,13 @@

Method Details

"A String", ], }, + "toolCall": { # Represents a call of a specific tool's action with the specified inputs. # Returns the definition of a tool call that should be executed by the client. + "action": "A String", # Required. The name of the tool's action associated with this call. + "inputParameters": { # Optional. The action's input parameters. + "a_key": "", # Properties of the object. + }, + "tool": "A String", # Required. The tool associated with this call. Format: `projects//locations//agents//tools/`. + }, }, }, ], @@ -2079,6 +2246,13 @@

Method Details

"A String", ], }, + "toolCall": { # Represents a call of a specific tool's action with the specified inputs. # Returns the definition of a tool call that should be executed by the client. + "action": "A String", # Required. The name of the tool's action associated with this call. + "inputParameters": { # Optional. The action's input parameters. + "a_key": "", # Properties of the object. + }, + "tool": "A String", # Required. The tool associated with this call. Format: `projects//locations//agents//tools/`. + }, }, ], "returnPartialResponses": True or False, # Whether Dialogflow should return currently queued fulfillment response messages in streaming APIs. If a webhook is specified, it happens before Dialogflow invokes webhook. Warning: 1) This flag only affects streaming API. Responses are still queued and returned once in non-streaming API. 2) The flag can be enabled in any fulfillment but only the first 3 partial responses will be returned. You may only want to apply it to fulfillments that have slow webhooks. @@ -2117,8 +2291,8 @@

Method Details

"maxDigits": 42, # Max length of DTMF digits. }, "loggingSettings": { # Define behaviors on logging. # Settings for logging. Settings for Dialogflow History, Contact Center messages, StackDriver logs, and speech logging. Exposed at the following levels: - Agent level. - "enableInteractionLogging": True or False, # If true, DF Interaction logging is currently enabled. - "enableStackdriverLogging": True or False, # If true, StackDriver logging is currently enabled. + "enableInteractionLogging": True or False, # Enables DF Interaction logging. + "enableStackdriverLogging": True or False, # Enables StackDriver logging. }, "speechSettings": { # Define behaviors of speech to text detection. # Settings for speech to text detection. Exposed at the following levels: - Agent level - Flow level - Page level - Parameter level "endpointerSensitivity": 42, # Sensitivity of the speech model that detects the end of speech. Scale from 0 to 100. @@ -2182,6 +2356,13 @@

Method Details

"A String", ], }, + "toolCall": { # Represents a call of a specific tool's action with the specified inputs. # Returns the definition of a tool call that should be executed by the client. + "action": "A String", # Required. The name of the tool's action associated with this call. + "inputParameters": { # Optional. The action's input parameters. + "a_key": "", # Properties of the object. + }, + "tool": "A String", # Required. The tool associated with this call. Format: `projects//locations//agents//tools/`. + }, }, }, ], @@ -2238,6 +2419,13 @@

Method Details

"A String", ], }, + "toolCall": { # Represents a call of a specific tool's action with the specified inputs. # Returns the definition of a tool call that should be executed by the client. + "action": "A String", # Required. The name of the tool's action associated with this call. + "inputParameters": { # Optional. The action's input parameters. + "a_key": "", # Properties of the object. + }, + "tool": "A String", # Required. The tool associated with this call. Format: `projects//locations//agents//tools/`. + }, }, ], "returnPartialResponses": True or False, # Whether Dialogflow should return currently queued fulfillment response messages in streaming APIs. If a webhook is specified, it happens before Dialogflow invokes webhook. Warning: 1) This flag only affects streaming API. Responses are still queued and returned once in non-streaming API. 2) The flag can be enabled in any fulfillment but only the first 3 partial responses will be returned. You may only want to apply it to fulfillments that have slow webhooks. diff --git a/docs/dyn/dialogflow_v3beta1.projects.locations.agents.tools.html b/docs/dyn/dialogflow_v3beta1.projects.locations.agents.tools.html new file mode 100644 index 00000000000..e91c56c8369 --- /dev/null +++ b/docs/dyn/dialogflow_v3beta1.projects.locations.agents.tools.html @@ -0,0 +1,585 @@ + + + +

Dialogflow API . projects . locations . agents . tools

+

Instance Methods

+

+ close()

+

Close httplib2 connections.

+

+ create(parent, body=None, x__xgafv=None)

+

Creates a Tool in the specified agent.

+

+ delete(name, force=None, x__xgafv=None)

+

Deletes a specified Tool.

+

+ export(parent, body=None, x__xgafv=None)

+

Exports the selected tools.

+

+ get(name, x__xgafv=None)

+

Retrieves the specified Tool.

+

+ list(parent, pageSize=None, pageToken=None, x__xgafv=None)

+

Returns a list of Tools in the specified agent.

+

+ list_next()

+

Retrieves the next page of results.

+

+ patch(name, body=None, updateMask=None, x__xgafv=None)

+

Update the specified Tool.

+

Method Details

+
+ close() +
Close httplib2 connections.
+
+ +
+ create(parent, body=None, x__xgafv=None) +
Creates a Tool in the specified agent.
+
+Args:
+  parent: string, Required. The agent to create a Tool for. Format: `projects//locations//agents/`. (required)
+  body: object, The request body.
+    The object takes the form of:
+
+{ # A tool provides a list of actions which are available to the Playbook to attain its goal. A Tool consists of a description of the tool's usage and a specification of the tool which contains the schema and authentication information.
+  "dataStoreSpec": { # A DataStoreTool is a way to provide specifications needed to search a list of data stores. # Data store search tool specification.
+    "dataStoreConnections": [ # Required. List of data stores to search.
+      { # A data store connection. It represents a data store in Discovery Engine and the type of the contents it contains.
+        "dataStore": "A String", # The full name of the referenced data store. Formats: `projects/{project}/locations/{location}/collections/{collection}/dataStores/{data_store}` `projects/{project}/locations/{location}/dataStores/{data_store}`
+        "dataStoreType": "A String", # The type of the connected data store.
+      },
+    ],
+    "fallbackPrompt": { # A FallbackPrompt is a way to provide specifications for the Data Store fallback prompt when generating responses. # Required. Fallback prompt configurations to use.
+    },
+  },
+  "description": "A String", # Required. High level description of the Tool and its usage.
+  "displayName": "A String", # Required. The human-readable name of the Tool, unique within an agent.
+  "extensionSpec": { # An ExtensionTool is a way to use Vertex Extensions as a tool. # Vertex extension tool specification.
+    "name": "A String", # Required. The full name of the referenced vertex extension. Formats: `projects/{project}/locations/{location}/extensions/{extension}`
+  },
+  "functionSpec": { # A Function tool describes the functions to be invoked on the client side. # Client side executed function specification.
+    "inputSchema": { # Optional. The JSON schema is encapsulated in a google.protobuf.Struct to describe the input of the function. This input is a JSON object that contains the function's parameters as properties of the object.
+      "a_key": "", # Properties of the object.
+    },
+    "outputSchema": { # Optional. The JSON schema is encapsulated in a google.protobuf.Struct to describe the output of the function. This output is a JSON object that contains the function's parameters as properties of the object.
+      "a_key": "", # Properties of the object.
+    },
+  },
+  "name": "A String", # The unique identifier of the Tool. Format: `projects//locations//agents//tools/`.
+  "openApiSpec": { # An OpenAPI tool is a way to provide the Tool specifications in the Open API schema format. # OpenAPI specification of the Tool.
+    "authentication": { # Authentication information required for API calls # Optional. Authentication information required by the API.
+      "apiKeyConfig": { # Config for authentication with API key. # Config for API key auth.
+        "apiKey": "A String", # Required. The API key.
+        "keyName": "A String", # Required. The parameter name or the header name of the API key. E.g., If the API request is "https://example.com/act?X-Api-Key=", "X-Api-Key" would be the parameter name.
+        "requestLocation": "A String", # Required. Key location in the request.
+      },
+      "oauthConfig": { # Config for authentication with OAuth. # Config for OAuth.
+        "clientId": "A String", # Required. The client ID from the OAuth provider.
+        "clientSecret": "A String", # Required. The client secret from the OAuth provider.
+        "oauthGrantType": "A String", # Required. OAuth grant types.
+        "tokenEndpoint": "A String", # Required. The token endpoint in the OAuth provider to exchange for an access token.
+      },
+      "serviceAgentAuthConfig": { # Config for auth using [Diglogflow service agent](https://cloud.google.com/iam/docs/service-agents#dialogflow-service-agent). # Config for [Diglogflow service agent](https://cloud.google.com/iam/docs/service-agents#dialogflow-service-agent) auth.
+      },
+    },
+    "textSchema": "A String", # Required. The OpenAPI schema specified as a text.
+    "tlsConfig": { # The TLS configuration. # Optional. TLS configuration for the HTTPS verification.
+      "caCerts": [ # Required. Specifies a list of allowed custom CA certificates for HTTPS verification.
+        { # The CA certificate.
+          "cert": "A String", # Required. The allowed custom CA certificates (in DER format) for HTTPS verification. This overrides the default SSL trust store. If this is empty or unspecified, Dialogflow will use Google's default trust store to verify certificates. N.B. Make sure the HTTPS server certificates are signed with "subject alt name". For instance a certificate can be self-signed using the following command, openssl x509 -req -days 200 -in example.com.csr \ -signkey example.com.key \ -out example.com.crt \ -extfile <(printf "\nsubjectAltName='DNS:www.example.com'")
+          "displayName": "A String", # Required. The name of the allowed custom CA certificates. This can be used to disambiguate the custom CA certificates.
+        },
+      ],
+    },
+  },
+  "toolType": "A String", # Output only. The tool type.
+}
+
+  x__xgafv: string, V1 error format.
+    Allowed values
+      1 - v1 error format
+      2 - v2 error format
+
+Returns:
+  An object of the form:
+
+    { # A tool provides a list of actions which are available to the Playbook to attain its goal. A Tool consists of a description of the tool's usage and a specification of the tool which contains the schema and authentication information.
+  "dataStoreSpec": { # A DataStoreTool is a way to provide specifications needed to search a list of data stores. # Data store search tool specification.
+    "dataStoreConnections": [ # Required. List of data stores to search.
+      { # A data store connection. It represents a data store in Discovery Engine and the type of the contents it contains.
+        "dataStore": "A String", # The full name of the referenced data store. Formats: `projects/{project}/locations/{location}/collections/{collection}/dataStores/{data_store}` `projects/{project}/locations/{location}/dataStores/{data_store}`
+        "dataStoreType": "A String", # The type of the connected data store.
+      },
+    ],
+    "fallbackPrompt": { # A FallbackPrompt is a way to provide specifications for the Data Store fallback prompt when generating responses. # Required. Fallback prompt configurations to use.
+    },
+  },
+  "description": "A String", # Required. High level description of the Tool and its usage.
+  "displayName": "A String", # Required. The human-readable name of the Tool, unique within an agent.
+  "extensionSpec": { # An ExtensionTool is a way to use Vertex Extensions as a tool. # Vertex extension tool specification.
+    "name": "A String", # Required. The full name of the referenced vertex extension. Formats: `projects/{project}/locations/{location}/extensions/{extension}`
+  },
+  "functionSpec": { # A Function tool describes the functions to be invoked on the client side. # Client side executed function specification.
+    "inputSchema": { # Optional. The JSON schema is encapsulated in a google.protobuf.Struct to describe the input of the function. This input is a JSON object that contains the function's parameters as properties of the object.
+      "a_key": "", # Properties of the object.
+    },
+    "outputSchema": { # Optional. The JSON schema is encapsulated in a google.protobuf.Struct to describe the output of the function. This output is a JSON object that contains the function's parameters as properties of the object.
+      "a_key": "", # Properties of the object.
+    },
+  },
+  "name": "A String", # The unique identifier of the Tool. Format: `projects//locations//agents//tools/`.
+  "openApiSpec": { # An OpenAPI tool is a way to provide the Tool specifications in the Open API schema format. # OpenAPI specification of the Tool.
+    "authentication": { # Authentication information required for API calls # Optional. Authentication information required by the API.
+      "apiKeyConfig": { # Config for authentication with API key. # Config for API key auth.
+        "apiKey": "A String", # Required. The API key.
+        "keyName": "A String", # Required. The parameter name or the header name of the API key. E.g., If the API request is "https://example.com/act?X-Api-Key=", "X-Api-Key" would be the parameter name.
+        "requestLocation": "A String", # Required. Key location in the request.
+      },
+      "oauthConfig": { # Config for authentication with OAuth. # Config for OAuth.
+        "clientId": "A String", # Required. The client ID from the OAuth provider.
+        "clientSecret": "A String", # Required. The client secret from the OAuth provider.
+        "oauthGrantType": "A String", # Required. OAuth grant types.
+        "tokenEndpoint": "A String", # Required. The token endpoint in the OAuth provider to exchange for an access token.
+      },
+      "serviceAgentAuthConfig": { # Config for auth using [Diglogflow service agent](https://cloud.google.com/iam/docs/service-agents#dialogflow-service-agent). # Config for [Diglogflow service agent](https://cloud.google.com/iam/docs/service-agents#dialogflow-service-agent) auth.
+      },
+    },
+    "textSchema": "A String", # Required. The OpenAPI schema specified as a text.
+    "tlsConfig": { # The TLS configuration. # Optional. TLS configuration for the HTTPS verification.
+      "caCerts": [ # Required. Specifies a list of allowed custom CA certificates for HTTPS verification.
+        { # The CA certificate.
+          "cert": "A String", # Required. The allowed custom CA certificates (in DER format) for HTTPS verification. This overrides the default SSL trust store. If this is empty or unspecified, Dialogflow will use Google's default trust store to verify certificates. N.B. Make sure the HTTPS server certificates are signed with "subject alt name". For instance a certificate can be self-signed using the following command, openssl x509 -req -days 200 -in example.com.csr \ -signkey example.com.key \ -out example.com.crt \ -extfile <(printf "\nsubjectAltName='DNS:www.example.com'")
+          "displayName": "A String", # Required. The name of the allowed custom CA certificates. This can be used to disambiguate the custom CA certificates.
+        },
+      ],
+    },
+  },
+  "toolType": "A String", # Output only. The tool type.
+}
+
+ +
+ delete(name, force=None, x__xgafv=None) +
Deletes a specified Tool.
+
+Args:
+  name: string, Required. The name of the Tool to be deleted. Format: `projects//locations//agents//tools/`. (required)
+  force: boolean, This field has no effect for Tools not being used. For Tools that are used: * If `force` is set to false, an error will be returned with message indicating the referenced resources. * If `force` is set to true, Dialogflow will remove the tool, as well as any references to the tool.
+  x__xgafv: string, V1 error format.
+    Allowed values
+      1 - v1 error format
+      2 - v2 error format
+
+Returns:
+  An object of the form:
+
+    { # A generic empty message that you can re-use to avoid defining duplicated empty messages in your APIs. A typical example is to use it as the request or the response type of an API method. For instance: service Foo { rpc Bar(google.protobuf.Empty) returns (google.protobuf.Empty); }
+}
+
+ +
+ export(parent, body=None, x__xgafv=None) +
Exports the selected tools.
+
+Args:
+  parent: string, Required. The agent to export tools from. Format: `projects//locations//agents/`. (required)
+  body: object, The request body.
+    The object takes the form of:
+
+{ # The request message for Tools.ExportTools.
+  "dataFormat": "A String", # Optional. The data format of the exported tools. If not specified, `BLOB` is assumed.
+  "tools": [ # Required. The name of the tools to export. Format: `projects//locations//agents//tools/`.
+    "A String",
+  ],
+  "toolsContentInline": True or False, # Optional. The option to return the serialized tools inline.
+  "toolsUri": "A String", # Optional. The [Google Cloud Storage](https://cloud.google.com/storage/docs/) URI to export the tools to. The format of this URI must be `gs:///`. Dialogflow performs a write operation for the Cloud Storage object on the caller's behalf, so your request authentication must have write permissions for the object. For more information, see [Dialogflow access control](https://cloud.google.com/dialogflow/cx/docs/concept/access-control#storage).
+}
+
+  x__xgafv: string, V1 error format.
+    Allowed values
+      1 - v1 error format
+      2 - v2 error format
+
+Returns:
+  An object of the form:
+
+    { # This resource represents a long-running operation that is the result of a network API call.
+  "done": True or False, # If the value is `false`, it means the operation is still in progress. If `true`, the operation is completed, and either `error` or `response` is available.
+  "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). # The error result of the operation in case of failure or cancellation.
+    "code": 42, # The status code, which should be an enum value of google.rpc.Code.
+    "details": [ # A list of messages that carry the error details. There is a common set of message types for APIs to use.
+      {
+        "a_key": "", # Properties of the object. Contains field @type with type URL.
+      },
+    ],
+    "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.
+  },
+  "metadata": { # Service-specific metadata associated with the operation. It typically contains progress information and common metadata such as create time. Some services might not provide such metadata. Any method that returns a long-running operation should document the metadata type, if any.
+    "a_key": "", # Properties of the object. Contains field @type with type URL.
+  },
+  "name": "A String", # The server-assigned name, which is only unique within the same service that originally returns it. If you use the default HTTP mapping, the `name` should be a resource name ending with `operations/{unique_id}`.
+  "response": { # The normal, successful response of the operation. If the original method returns no data on success, such as `Delete`, the response is `google.protobuf.Empty`. If the original method is standard `Get`/`Create`/`Update`, the response should be the resource. For other methods, the response should have the type `XxxResponse`, where `Xxx` is the original method name. For example, if the original method name is `TakeSnapshot()`, the inferred response type is `TakeSnapshotResponse`.
+    "a_key": "", # Properties of the object. Contains field @type with type URL.
+  },
+}
+
+ +
+ get(name, x__xgafv=None) +
Retrieves the specified Tool.
+
+Args:
+  name: string, Required. The name of the Tool. Format: `projects//locations//agents//tools/`. (required)
+  x__xgafv: string, V1 error format.
+    Allowed values
+      1 - v1 error format
+      2 - v2 error format
+
+Returns:
+  An object of the form:
+
+    { # A tool provides a list of actions which are available to the Playbook to attain its goal. A Tool consists of a description of the tool's usage and a specification of the tool which contains the schema and authentication information.
+  "dataStoreSpec": { # A DataStoreTool is a way to provide specifications needed to search a list of data stores. # Data store search tool specification.
+    "dataStoreConnections": [ # Required. List of data stores to search.
+      { # A data store connection. It represents a data store in Discovery Engine and the type of the contents it contains.
+        "dataStore": "A String", # The full name of the referenced data store. Formats: `projects/{project}/locations/{location}/collections/{collection}/dataStores/{data_store}` `projects/{project}/locations/{location}/dataStores/{data_store}`
+        "dataStoreType": "A String", # The type of the connected data store.
+      },
+    ],
+    "fallbackPrompt": { # A FallbackPrompt is a way to provide specifications for the Data Store fallback prompt when generating responses. # Required. Fallback prompt configurations to use.
+    },
+  },
+  "description": "A String", # Required. High level description of the Tool and its usage.
+  "displayName": "A String", # Required. The human-readable name of the Tool, unique within an agent.
+  "extensionSpec": { # An ExtensionTool is a way to use Vertex Extensions as a tool. # Vertex extension tool specification.
+    "name": "A String", # Required. The full name of the referenced vertex extension. Formats: `projects/{project}/locations/{location}/extensions/{extension}`
+  },
+  "functionSpec": { # A Function tool describes the functions to be invoked on the client side. # Client side executed function specification.
+    "inputSchema": { # Optional. The JSON schema is encapsulated in a google.protobuf.Struct to describe the input of the function. This input is a JSON object that contains the function's parameters as properties of the object.
+      "a_key": "", # Properties of the object.
+    },
+    "outputSchema": { # Optional. The JSON schema is encapsulated in a google.protobuf.Struct to describe the output of the function. This output is a JSON object that contains the function's parameters as properties of the object.
+      "a_key": "", # Properties of the object.
+    },
+  },
+  "name": "A String", # The unique identifier of the Tool. Format: `projects//locations//agents//tools/`.
+  "openApiSpec": { # An OpenAPI tool is a way to provide the Tool specifications in the Open API schema format. # OpenAPI specification of the Tool.
+    "authentication": { # Authentication information required for API calls # Optional. Authentication information required by the API.
+      "apiKeyConfig": { # Config for authentication with API key. # Config for API key auth.
+        "apiKey": "A String", # Required. The API key.
+        "keyName": "A String", # Required. The parameter name or the header name of the API key. E.g., If the API request is "https://example.com/act?X-Api-Key=", "X-Api-Key" would be the parameter name.
+        "requestLocation": "A String", # Required. Key location in the request.
+      },
+      "oauthConfig": { # Config for authentication with OAuth. # Config for OAuth.
+        "clientId": "A String", # Required. The client ID from the OAuth provider.
+        "clientSecret": "A String", # Required. The client secret from the OAuth provider.
+        "oauthGrantType": "A String", # Required. OAuth grant types.
+        "tokenEndpoint": "A String", # Required. The token endpoint in the OAuth provider to exchange for an access token.
+      },
+      "serviceAgentAuthConfig": { # Config for auth using [Diglogflow service agent](https://cloud.google.com/iam/docs/service-agents#dialogflow-service-agent). # Config for [Diglogflow service agent](https://cloud.google.com/iam/docs/service-agents#dialogflow-service-agent) auth.
+      },
+    },
+    "textSchema": "A String", # Required. The OpenAPI schema specified as a text.
+    "tlsConfig": { # The TLS configuration. # Optional. TLS configuration for the HTTPS verification.
+      "caCerts": [ # Required. Specifies a list of allowed custom CA certificates for HTTPS verification.
+        { # The CA certificate.
+          "cert": "A String", # Required. The allowed custom CA certificates (in DER format) for HTTPS verification. This overrides the default SSL trust store. If this is empty or unspecified, Dialogflow will use Google's default trust store to verify certificates. N.B. Make sure the HTTPS server certificates are signed with "subject alt name". For instance a certificate can be self-signed using the following command, openssl x509 -req -days 200 -in example.com.csr \ -signkey example.com.key \ -out example.com.crt \ -extfile <(printf "\nsubjectAltName='DNS:www.example.com'")
+          "displayName": "A String", # Required. The name of the allowed custom CA certificates. This can be used to disambiguate the custom CA certificates.
+        },
+      ],
+    },
+  },
+  "toolType": "A String", # Output only. The tool type.
+}
+
+ +
+ list(parent, pageSize=None, pageToken=None, x__xgafv=None) +
Returns a list of Tools in the specified agent.
+
+Args:
+  parent: string, Required. The agent to list the Tools from. Format: `projects//locations//agents/`. (required)
+  pageSize: integer, The maximum number of items to return in a single page. By default 100 and at most 1000.
+  pageToken: string, The next_page_token value returned from a previous list request.
+  x__xgafv: string, V1 error format.
+    Allowed values
+      1 - v1 error format
+      2 - v2 error format
+
+Returns:
+  An object of the form:
+
+    { # The response message for Tools.ListTools.
+  "nextPageToken": "A String", # Token to retrieve the next page of results, or empty if there are no more results in the list.
+  "tools": [ # The list of Tools. There will be a maximum number of items returned based on the page_size field in the request.
+    { # A tool provides a list of actions which are available to the Playbook to attain its goal. A Tool consists of a description of the tool's usage and a specification of the tool which contains the schema and authentication information.
+      "dataStoreSpec": { # A DataStoreTool is a way to provide specifications needed to search a list of data stores. # Data store search tool specification.
+        "dataStoreConnections": [ # Required. List of data stores to search.
+          { # A data store connection. It represents a data store in Discovery Engine and the type of the contents it contains.
+            "dataStore": "A String", # The full name of the referenced data store. Formats: `projects/{project}/locations/{location}/collections/{collection}/dataStores/{data_store}` `projects/{project}/locations/{location}/dataStores/{data_store}`
+            "dataStoreType": "A String", # The type of the connected data store.
+          },
+        ],
+        "fallbackPrompt": { # A FallbackPrompt is a way to provide specifications for the Data Store fallback prompt when generating responses. # Required. Fallback prompt configurations to use.
+        },
+      },
+      "description": "A String", # Required. High level description of the Tool and its usage.
+      "displayName": "A String", # Required. The human-readable name of the Tool, unique within an agent.
+      "extensionSpec": { # An ExtensionTool is a way to use Vertex Extensions as a tool. # Vertex extension tool specification.
+        "name": "A String", # Required. The full name of the referenced vertex extension. Formats: `projects/{project}/locations/{location}/extensions/{extension}`
+      },
+      "functionSpec": { # A Function tool describes the functions to be invoked on the client side. # Client side executed function specification.
+        "inputSchema": { # Optional. The JSON schema is encapsulated in a google.protobuf.Struct to describe the input of the function. This input is a JSON object that contains the function's parameters as properties of the object.
+          "a_key": "", # Properties of the object.
+        },
+        "outputSchema": { # Optional. The JSON schema is encapsulated in a google.protobuf.Struct to describe the output of the function. This output is a JSON object that contains the function's parameters as properties of the object.
+          "a_key": "", # Properties of the object.
+        },
+      },
+      "name": "A String", # The unique identifier of the Tool. Format: `projects//locations//agents//tools/`.
+      "openApiSpec": { # An OpenAPI tool is a way to provide the Tool specifications in the Open API schema format. # OpenAPI specification of the Tool.
+        "authentication": { # Authentication information required for API calls # Optional. Authentication information required by the API.
+          "apiKeyConfig": { # Config for authentication with API key. # Config for API key auth.
+            "apiKey": "A String", # Required. The API key.
+            "keyName": "A String", # Required. The parameter name or the header name of the API key. E.g., If the API request is "https://example.com/act?X-Api-Key=", "X-Api-Key" would be the parameter name.
+            "requestLocation": "A String", # Required. Key location in the request.
+          },
+          "oauthConfig": { # Config for authentication with OAuth. # Config for OAuth.
+            "clientId": "A String", # Required. The client ID from the OAuth provider.
+            "clientSecret": "A String", # Required. The client secret from the OAuth provider.
+            "oauthGrantType": "A String", # Required. OAuth grant types.
+            "tokenEndpoint": "A String", # Required. The token endpoint in the OAuth provider to exchange for an access token.
+          },
+          "serviceAgentAuthConfig": { # Config for auth using [Diglogflow service agent](https://cloud.google.com/iam/docs/service-agents#dialogflow-service-agent). # Config for [Diglogflow service agent](https://cloud.google.com/iam/docs/service-agents#dialogflow-service-agent) auth.
+          },
+        },
+        "textSchema": "A String", # Required. The OpenAPI schema specified as a text.
+        "tlsConfig": { # The TLS configuration. # Optional. TLS configuration for the HTTPS verification.
+          "caCerts": [ # Required. Specifies a list of allowed custom CA certificates for HTTPS verification.
+            { # The CA certificate.
+              "cert": "A String", # Required. The allowed custom CA certificates (in DER format) for HTTPS verification. This overrides the default SSL trust store. If this is empty or unspecified, Dialogflow will use Google's default trust store to verify certificates. N.B. Make sure the HTTPS server certificates are signed with "subject alt name". For instance a certificate can be self-signed using the following command, openssl x509 -req -days 200 -in example.com.csr \ -signkey example.com.key \ -out example.com.crt \ -extfile <(printf "\nsubjectAltName='DNS:www.example.com'")
+              "displayName": "A String", # Required. The name of the allowed custom CA certificates. This can be used to disambiguate the custom CA certificates.
+            },
+          ],
+        },
+      },
+      "toolType": "A String", # Output only. The tool type.
+    },
+  ],
+}
+
+ +
+ list_next() +
Retrieves the next page of results.
+
+        Args:
+          previous_request: The request for the previous page. (required)
+          previous_response: The response from the request for the previous page. (required)
+
+        Returns:
+          A request object that you can call 'execute()' on to request the next
+          page. Returns None if there are no more items in the collection.
+        
+
+ +
+ patch(name, body=None, updateMask=None, x__xgafv=None) +
Update the specified Tool.
+
+Args:
+  name: string, The unique identifier of the Tool. Format: `projects//locations//agents//tools/`. (required)
+  body: object, The request body.
+    The object takes the form of:
+
+{ # A tool provides a list of actions which are available to the Playbook to attain its goal. A Tool consists of a description of the tool's usage and a specification of the tool which contains the schema and authentication information.
+  "dataStoreSpec": { # A DataStoreTool is a way to provide specifications needed to search a list of data stores. # Data store search tool specification.
+    "dataStoreConnections": [ # Required. List of data stores to search.
+      { # A data store connection. It represents a data store in Discovery Engine and the type of the contents it contains.
+        "dataStore": "A String", # The full name of the referenced data store. Formats: `projects/{project}/locations/{location}/collections/{collection}/dataStores/{data_store}` `projects/{project}/locations/{location}/dataStores/{data_store}`
+        "dataStoreType": "A String", # The type of the connected data store.
+      },
+    ],
+    "fallbackPrompt": { # A FallbackPrompt is a way to provide specifications for the Data Store fallback prompt when generating responses. # Required. Fallback prompt configurations to use.
+    },
+  },
+  "description": "A String", # Required. High level description of the Tool and its usage.
+  "displayName": "A String", # Required. The human-readable name of the Tool, unique within an agent.
+  "extensionSpec": { # An ExtensionTool is a way to use Vertex Extensions as a tool. # Vertex extension tool specification.
+    "name": "A String", # Required. The full name of the referenced vertex extension. Formats: `projects/{project}/locations/{location}/extensions/{extension}`
+  },
+  "functionSpec": { # A Function tool describes the functions to be invoked on the client side. # Client side executed function specification.
+    "inputSchema": { # Optional. The JSON schema is encapsulated in a google.protobuf.Struct to describe the input of the function. This input is a JSON object that contains the function's parameters as properties of the object.
+      "a_key": "", # Properties of the object.
+    },
+    "outputSchema": { # Optional. The JSON schema is encapsulated in a google.protobuf.Struct to describe the output of the function. This output is a JSON object that contains the function's parameters as properties of the object.
+      "a_key": "", # Properties of the object.
+    },
+  },
+  "name": "A String", # The unique identifier of the Tool. Format: `projects//locations//agents//tools/`.
+  "openApiSpec": { # An OpenAPI tool is a way to provide the Tool specifications in the Open API schema format. # OpenAPI specification of the Tool.
+    "authentication": { # Authentication information required for API calls # Optional. Authentication information required by the API.
+      "apiKeyConfig": { # Config for authentication with API key. # Config for API key auth.
+        "apiKey": "A String", # Required. The API key.
+        "keyName": "A String", # Required. The parameter name or the header name of the API key. E.g., If the API request is "https://example.com/act?X-Api-Key=", "X-Api-Key" would be the parameter name.
+        "requestLocation": "A String", # Required. Key location in the request.
+      },
+      "oauthConfig": { # Config for authentication with OAuth. # Config for OAuth.
+        "clientId": "A String", # Required. The client ID from the OAuth provider.
+        "clientSecret": "A String", # Required. The client secret from the OAuth provider.
+        "oauthGrantType": "A String", # Required. OAuth grant types.
+        "tokenEndpoint": "A String", # Required. The token endpoint in the OAuth provider to exchange for an access token.
+      },
+      "serviceAgentAuthConfig": { # Config for auth using [Diglogflow service agent](https://cloud.google.com/iam/docs/service-agents#dialogflow-service-agent). # Config for [Diglogflow service agent](https://cloud.google.com/iam/docs/service-agents#dialogflow-service-agent) auth.
+      },
+    },
+    "textSchema": "A String", # Required. The OpenAPI schema specified as a text.
+    "tlsConfig": { # The TLS configuration. # Optional. TLS configuration for the HTTPS verification.
+      "caCerts": [ # Required. Specifies a list of allowed custom CA certificates for HTTPS verification.
+        { # The CA certificate.
+          "cert": "A String", # Required. The allowed custom CA certificates (in DER format) for HTTPS verification. This overrides the default SSL trust store. If this is empty or unspecified, Dialogflow will use Google's default trust store to verify certificates. N.B. Make sure the HTTPS server certificates are signed with "subject alt name". For instance a certificate can be self-signed using the following command, openssl x509 -req -days 200 -in example.com.csr \ -signkey example.com.key \ -out example.com.crt \ -extfile <(printf "\nsubjectAltName='DNS:www.example.com'")
+          "displayName": "A String", # Required. The name of the allowed custom CA certificates. This can be used to disambiguate the custom CA certificates.
+        },
+      ],
+    },
+  },
+  "toolType": "A String", # Output only. The tool type.
+}
+
+  updateMask: string, The mask to control which fields get updated. If the mask is not present, all fields will be updated.
+  x__xgafv: string, V1 error format.
+    Allowed values
+      1 - v1 error format
+      2 - v2 error format
+
+Returns:
+  An object of the form:
+
+    { # A tool provides a list of actions which are available to the Playbook to attain its goal. A Tool consists of a description of the tool's usage and a specification of the tool which contains the schema and authentication information.
+  "dataStoreSpec": { # A DataStoreTool is a way to provide specifications needed to search a list of data stores. # Data store search tool specification.
+    "dataStoreConnections": [ # Required. List of data stores to search.
+      { # A data store connection. It represents a data store in Discovery Engine and the type of the contents it contains.
+        "dataStore": "A String", # The full name of the referenced data store. Formats: `projects/{project}/locations/{location}/collections/{collection}/dataStores/{data_store}` `projects/{project}/locations/{location}/dataStores/{data_store}`
+        "dataStoreType": "A String", # The type of the connected data store.
+      },
+    ],
+    "fallbackPrompt": { # A FallbackPrompt is a way to provide specifications for the Data Store fallback prompt when generating responses. # Required. Fallback prompt configurations to use.
+    },
+  },
+  "description": "A String", # Required. High level description of the Tool and its usage.
+  "displayName": "A String", # Required. The human-readable name of the Tool, unique within an agent.
+  "extensionSpec": { # An ExtensionTool is a way to use Vertex Extensions as a tool. # Vertex extension tool specification.
+    "name": "A String", # Required. The full name of the referenced vertex extension. Formats: `projects/{project}/locations/{location}/extensions/{extension}`
+  },
+  "functionSpec": { # A Function tool describes the functions to be invoked on the client side. # Client side executed function specification.
+    "inputSchema": { # Optional. The JSON schema is encapsulated in a google.protobuf.Struct to describe the input of the function. This input is a JSON object that contains the function's parameters as properties of the object.
+      "a_key": "", # Properties of the object.
+    },
+    "outputSchema": { # Optional. The JSON schema is encapsulated in a google.protobuf.Struct to describe the output of the function. This output is a JSON object that contains the function's parameters as properties of the object.
+      "a_key": "", # Properties of the object.
+    },
+  },
+  "name": "A String", # The unique identifier of the Tool. Format: `projects//locations//agents//tools/`.
+  "openApiSpec": { # An OpenAPI tool is a way to provide the Tool specifications in the Open API schema format. # OpenAPI specification of the Tool.
+    "authentication": { # Authentication information required for API calls # Optional. Authentication information required by the API.
+      "apiKeyConfig": { # Config for authentication with API key. # Config for API key auth.
+        "apiKey": "A String", # Required. The API key.
+        "keyName": "A String", # Required. The parameter name or the header name of the API key. E.g., If the API request is "https://example.com/act?X-Api-Key=", "X-Api-Key" would be the parameter name.
+        "requestLocation": "A String", # Required. Key location in the request.
+      },
+      "oauthConfig": { # Config for authentication with OAuth. # Config for OAuth.
+        "clientId": "A String", # Required. The client ID from the OAuth provider.
+        "clientSecret": "A String", # Required. The client secret from the OAuth provider.
+        "oauthGrantType": "A String", # Required. OAuth grant types.
+        "tokenEndpoint": "A String", # Required. The token endpoint in the OAuth provider to exchange for an access token.
+      },
+      "serviceAgentAuthConfig": { # Config for auth using [Diglogflow service agent](https://cloud.google.com/iam/docs/service-agents#dialogflow-service-agent). # Config for [Diglogflow service agent](https://cloud.google.com/iam/docs/service-agents#dialogflow-service-agent) auth.
+      },
+    },
+    "textSchema": "A String", # Required. The OpenAPI schema specified as a text.
+    "tlsConfig": { # The TLS configuration. # Optional. TLS configuration for the HTTPS verification.
+      "caCerts": [ # Required. Specifies a list of allowed custom CA certificates for HTTPS verification.
+        { # The CA certificate.
+          "cert": "A String", # Required. The allowed custom CA certificates (in DER format) for HTTPS verification. This overrides the default SSL trust store. If this is empty or unspecified, Dialogflow will use Google's default trust store to verify certificates. N.B. Make sure the HTTPS server certificates are signed with "subject alt name". For instance a certificate can be self-signed using the following command, openssl x509 -req -days 200 -in example.com.csr \ -signkey example.com.key \ -out example.com.crt \ -extfile <(printf "\nsubjectAltName='DNS:www.example.com'")
+          "displayName": "A String", # Required. The name of the allowed custom CA certificates. This can be used to disambiguate the custom CA certificates.
+        },
+      ],
+    },
+  },
+  "toolType": "A String", # Output only. The tool type.
+}
+
+ + \ No newline at end of file diff --git a/docs/dyn/dialogflow_v3beta1.projects.locations.agents.transitionRouteGroups.html b/docs/dyn/dialogflow_v3beta1.projects.locations.agents.transitionRouteGroups.html index 79d1e0c3434..55291d62bde 100644 --- a/docs/dyn/dialogflow_v3beta1.projects.locations.agents.transitionRouteGroups.html +++ b/docs/dyn/dialogflow_v3beta1.projects.locations.agents.transitionRouteGroups.html @@ -134,8 +134,8 @@

Method Details

"maxDigits": 42, # Max length of DTMF digits. }, "loggingSettings": { # Define behaviors on logging. # Settings for logging. Settings for Dialogflow History, Contact Center messages, StackDriver logs, and speech logging. Exposed at the following levels: - Agent level. - "enableInteractionLogging": True or False, # If true, DF Interaction logging is currently enabled. - "enableStackdriverLogging": True or False, # If true, StackDriver logging is currently enabled. + "enableInteractionLogging": True or False, # Enables DF Interaction logging. + "enableStackdriverLogging": True or False, # Enables StackDriver logging. }, "speechSettings": { # Define behaviors of speech to text detection. # Settings for speech to text detection. Exposed at the following levels: - Agent level - Flow level - Page level - Parameter level "endpointerSensitivity": 42, # Sensitivity of the speech model that detects the end of speech. Scale from 0 to 100. @@ -199,6 +199,13 @@

Method Details

"A String", ], }, + "toolCall": { # Represents a call of a specific tool's action with the specified inputs. # Returns the definition of a tool call that should be executed by the client. + "action": "A String", # Required. The name of the tool's action associated with this call. + "inputParameters": { # Optional. The action's input parameters. + "a_key": "", # Properties of the object. + }, + "tool": "A String", # Required. The tool associated with this call. Format: `projects//locations//agents//tools/`. + }, }, }, ], @@ -255,6 +262,13 @@

Method Details

"A String", ], }, + "toolCall": { # Represents a call of a specific tool's action with the specified inputs. # Returns the definition of a tool call that should be executed by the client. + "action": "A String", # Required. The name of the tool's action associated with this call. + "inputParameters": { # Optional. The action's input parameters. + "a_key": "", # Properties of the object. + }, + "tool": "A String", # Required. The tool associated with this call. Format: `projects//locations//agents//tools/`. + }, }, ], "returnPartialResponses": True or False, # Whether Dialogflow should return currently queued fulfillment response messages in streaming APIs. If a webhook is specified, it happens before Dialogflow invokes webhook. Warning: 1) This flag only affects streaming API. Responses are still queued and returned once in non-streaming API. 2) The flag can be enabled in any fulfillment but only the first 3 partial responses will be returned. You may only want to apply it to fulfillments that have slow webhooks. @@ -304,8 +318,8 @@

Method Details

"maxDigits": 42, # Max length of DTMF digits. }, "loggingSettings": { # Define behaviors on logging. # Settings for logging. Settings for Dialogflow History, Contact Center messages, StackDriver logs, and speech logging. Exposed at the following levels: - Agent level. - "enableInteractionLogging": True or False, # If true, DF Interaction logging is currently enabled. - "enableStackdriverLogging": True or False, # If true, StackDriver logging is currently enabled. + "enableInteractionLogging": True or False, # Enables DF Interaction logging. + "enableStackdriverLogging": True or False, # Enables StackDriver logging. }, "speechSettings": { # Define behaviors of speech to text detection. # Settings for speech to text detection. Exposed at the following levels: - Agent level - Flow level - Page level - Parameter level "endpointerSensitivity": 42, # Sensitivity of the speech model that detects the end of speech. Scale from 0 to 100. @@ -369,6 +383,13 @@

Method Details

"A String", ], }, + "toolCall": { # Represents a call of a specific tool's action with the specified inputs. # Returns the definition of a tool call that should be executed by the client. + "action": "A String", # Required. The name of the tool's action associated with this call. + "inputParameters": { # Optional. The action's input parameters. + "a_key": "", # Properties of the object. + }, + "tool": "A String", # Required. The tool associated with this call. Format: `projects//locations//agents//tools/`. + }, }, }, ], @@ -425,6 +446,13 @@

Method Details

"A String", ], }, + "toolCall": { # Represents a call of a specific tool's action with the specified inputs. # Returns the definition of a tool call that should be executed by the client. + "action": "A String", # Required. The name of the tool's action associated with this call. + "inputParameters": { # Optional. The action's input parameters. + "a_key": "", # Properties of the object. + }, + "tool": "A String", # Required. The tool associated with this call. Format: `projects//locations//agents//tools/`. + }, }, ], "returnPartialResponses": True or False, # Whether Dialogflow should return currently queued fulfillment response messages in streaming APIs. If a webhook is specified, it happens before Dialogflow invokes webhook. Warning: 1) This flag only affects streaming API. Responses are still queued and returned once in non-streaming API. 2) The flag can be enabled in any fulfillment but only the first 3 partial responses will be returned. You may only want to apply it to fulfillments that have slow webhooks. @@ -500,8 +528,8 @@

Method Details

"maxDigits": 42, # Max length of DTMF digits. }, "loggingSettings": { # Define behaviors on logging. # Settings for logging. Settings for Dialogflow History, Contact Center messages, StackDriver logs, and speech logging. Exposed at the following levels: - Agent level. - "enableInteractionLogging": True or False, # If true, DF Interaction logging is currently enabled. - "enableStackdriverLogging": True or False, # If true, StackDriver logging is currently enabled. + "enableInteractionLogging": True or False, # Enables DF Interaction logging. + "enableStackdriverLogging": True or False, # Enables StackDriver logging. }, "speechSettings": { # Define behaviors of speech to text detection. # Settings for speech to text detection. Exposed at the following levels: - Agent level - Flow level - Page level - Parameter level "endpointerSensitivity": 42, # Sensitivity of the speech model that detects the end of speech. Scale from 0 to 100. @@ -565,6 +593,13 @@

Method Details

"A String", ], }, + "toolCall": { # Represents a call of a specific tool's action with the specified inputs. # Returns the definition of a tool call that should be executed by the client. + "action": "A String", # Required. The name of the tool's action associated with this call. + "inputParameters": { # Optional. The action's input parameters. + "a_key": "", # Properties of the object. + }, + "tool": "A String", # Required. The tool associated with this call. Format: `projects//locations//agents//tools/`. + }, }, }, ], @@ -621,6 +656,13 @@

Method Details

"A String", ], }, + "toolCall": { # Represents a call of a specific tool's action with the specified inputs. # Returns the definition of a tool call that should be executed by the client. + "action": "A String", # Required. The name of the tool's action associated with this call. + "inputParameters": { # Optional. The action's input parameters. + "a_key": "", # Properties of the object. + }, + "tool": "A String", # Required. The tool associated with this call. Format: `projects//locations//agents//tools/`. + }, }, ], "returnPartialResponses": True or False, # Whether Dialogflow should return currently queued fulfillment response messages in streaming APIs. If a webhook is specified, it happens before Dialogflow invokes webhook. Warning: 1) This flag only affects streaming API. Responses are still queued and returned once in non-streaming API. 2) The flag can be enabled in any fulfillment but only the first 3 partial responses will be returned. You may only want to apply it to fulfillments that have slow webhooks. @@ -682,8 +724,8 @@

Method Details

"maxDigits": 42, # Max length of DTMF digits. }, "loggingSettings": { # Define behaviors on logging. # Settings for logging. Settings for Dialogflow History, Contact Center messages, StackDriver logs, and speech logging. Exposed at the following levels: - Agent level. - "enableInteractionLogging": True or False, # If true, DF Interaction logging is currently enabled. - "enableStackdriverLogging": True or False, # If true, StackDriver logging is currently enabled. + "enableInteractionLogging": True or False, # Enables DF Interaction logging. + "enableStackdriverLogging": True or False, # Enables StackDriver logging. }, "speechSettings": { # Define behaviors of speech to text detection. # Settings for speech to text detection. Exposed at the following levels: - Agent level - Flow level - Page level - Parameter level "endpointerSensitivity": 42, # Sensitivity of the speech model that detects the end of speech. Scale from 0 to 100. @@ -747,6 +789,13 @@

Method Details

"A String", ], }, + "toolCall": { # Represents a call of a specific tool's action with the specified inputs. # Returns the definition of a tool call that should be executed by the client. + "action": "A String", # Required. The name of the tool's action associated with this call. + "inputParameters": { # Optional. The action's input parameters. + "a_key": "", # Properties of the object. + }, + "tool": "A String", # Required. The tool associated with this call. Format: `projects//locations//agents//tools/`. + }, }, }, ], @@ -803,6 +852,13 @@

Method Details

"A String", ], }, + "toolCall": { # Represents a call of a specific tool's action with the specified inputs. # Returns the definition of a tool call that should be executed by the client. + "action": "A String", # Required. The name of the tool's action associated with this call. + "inputParameters": { # Optional. The action's input parameters. + "a_key": "", # Properties of the object. + }, + "tool": "A String", # Required. The tool associated with this call. Format: `projects//locations//agents//tools/`. + }, }, ], "returnPartialResponses": True or False, # Whether Dialogflow should return currently queued fulfillment response messages in streaming APIs. If a webhook is specified, it happens before Dialogflow invokes webhook. Warning: 1) This flag only affects streaming API. Responses are still queued and returned once in non-streaming API. 2) The flag can be enabled in any fulfillment but only the first 3 partial responses will be returned. You may only want to apply it to fulfillments that have slow webhooks. @@ -869,8 +925,8 @@

Method Details

"maxDigits": 42, # Max length of DTMF digits. }, "loggingSettings": { # Define behaviors on logging. # Settings for logging. Settings for Dialogflow History, Contact Center messages, StackDriver logs, and speech logging. Exposed at the following levels: - Agent level. - "enableInteractionLogging": True or False, # If true, DF Interaction logging is currently enabled. - "enableStackdriverLogging": True or False, # If true, StackDriver logging is currently enabled. + "enableInteractionLogging": True or False, # Enables DF Interaction logging. + "enableStackdriverLogging": True or False, # Enables StackDriver logging. }, "speechSettings": { # Define behaviors of speech to text detection. # Settings for speech to text detection. Exposed at the following levels: - Agent level - Flow level - Page level - Parameter level "endpointerSensitivity": 42, # Sensitivity of the speech model that detects the end of speech. Scale from 0 to 100. @@ -934,6 +990,13 @@

Method Details

"A String", ], }, + "toolCall": { # Represents a call of a specific tool's action with the specified inputs. # Returns the definition of a tool call that should be executed by the client. + "action": "A String", # Required. The name of the tool's action associated with this call. + "inputParameters": { # Optional. The action's input parameters. + "a_key": "", # Properties of the object. + }, + "tool": "A String", # Required. The tool associated with this call. Format: `projects//locations//agents//tools/`. + }, }, }, ], @@ -990,6 +1053,13 @@

Method Details

"A String", ], }, + "toolCall": { # Represents a call of a specific tool's action with the specified inputs. # Returns the definition of a tool call that should be executed by the client. + "action": "A String", # Required. The name of the tool's action associated with this call. + "inputParameters": { # Optional. The action's input parameters. + "a_key": "", # Properties of the object. + }, + "tool": "A String", # Required. The tool associated with this call. Format: `projects//locations//agents//tools/`. + }, }, ], "returnPartialResponses": True or False, # Whether Dialogflow should return currently queued fulfillment response messages in streaming APIs. If a webhook is specified, it happens before Dialogflow invokes webhook. Warning: 1) This flag only affects streaming API. Responses are still queued and returned once in non-streaming API. 2) The flag can be enabled in any fulfillment but only the first 3 partial responses will be returned. You may only want to apply it to fulfillments that have slow webhooks. @@ -1040,8 +1110,8 @@

Method Details

"maxDigits": 42, # Max length of DTMF digits. }, "loggingSettings": { # Define behaviors on logging. # Settings for logging. Settings for Dialogflow History, Contact Center messages, StackDriver logs, and speech logging. Exposed at the following levels: - Agent level. - "enableInteractionLogging": True or False, # If true, DF Interaction logging is currently enabled. - "enableStackdriverLogging": True or False, # If true, StackDriver logging is currently enabled. + "enableInteractionLogging": True or False, # Enables DF Interaction logging. + "enableStackdriverLogging": True or False, # Enables StackDriver logging. }, "speechSettings": { # Define behaviors of speech to text detection. # Settings for speech to text detection. Exposed at the following levels: - Agent level - Flow level - Page level - Parameter level "endpointerSensitivity": 42, # Sensitivity of the speech model that detects the end of speech. Scale from 0 to 100. @@ -1105,6 +1175,13 @@

Method Details

"A String", ], }, + "toolCall": { # Represents a call of a specific tool's action with the specified inputs. # Returns the definition of a tool call that should be executed by the client. + "action": "A String", # Required. The name of the tool's action associated with this call. + "inputParameters": { # Optional. The action's input parameters. + "a_key": "", # Properties of the object. + }, + "tool": "A String", # Required. The tool associated with this call. Format: `projects//locations//agents//tools/`. + }, }, }, ], @@ -1161,6 +1238,13 @@

Method Details

"A String", ], }, + "toolCall": { # Represents a call of a specific tool's action with the specified inputs. # Returns the definition of a tool call that should be executed by the client. + "action": "A String", # Required. The name of the tool's action associated with this call. + "inputParameters": { # Optional. The action's input parameters. + "a_key": "", # Properties of the object. + }, + "tool": "A String", # Required. The tool associated with this call. Format: `projects//locations//agents//tools/`. + }, }, ], "returnPartialResponses": True or False, # Whether Dialogflow should return currently queued fulfillment response messages in streaming APIs. If a webhook is specified, it happens before Dialogflow invokes webhook. Warning: 1) This flag only affects streaming API. Responses are still queued and returned once in non-streaming API. 2) The flag can be enabled in any fulfillment but only the first 3 partial responses will be returned. You may only want to apply it to fulfillments that have slow webhooks. diff --git a/docs/dyn/discoveryengine_v1.projects.locations.collections.dataStores.branches.documents.html b/docs/dyn/discoveryengine_v1.projects.locations.collections.dataStores.branches.documents.html index 93240617008..c5d7e934b69 100644 --- a/docs/dyn/discoveryengine_v1.projects.locations.collections.dataStores.branches.documents.html +++ b/docs/dyn/discoveryengine_v1.projects.locations.collections.dataStores.branches.documents.html @@ -229,6 +229,14 @@

Method Details

The object takes the form of: { # Request message for Import methods. + "alloyDbSource": { # AlloyDB source import data from. # AlloyDB input source. + "clusterId": "A String", # Required. The AlloyDB cluster to copy the data from with a length limit of 256 characters. + "databaseId": "A String", # Required. The AlloyDB database to copy the data from with a length limit of 256 characters. + "gcsStagingDir": "A String", # Intermediate Cloud Storage directory used for the import with a length limit of 2,000 characters. Can be specified if one wants to have the AlloyDB export to a specific Cloud Storage directory. Ensure that the AlloyDB service account has the necessary Cloud Storage Admin permissions to access the specified Cloud Storage directory. + "locationId": "A String", # Required. The AlloyDB location to copy the data from with a length limit of 256 characters. + "projectId": "A String", # The project ID that the AlloyDB source is in with a length limit of 128 characters. If not specified, inherits the project ID from the parent request. + "tableId": "A String", # Required. The AlloyDB table to copy the data from with a length limit of 256 characters. + }, "autoGenerateIds": True or False, # Whether to automatically generate IDs for the documents if absent. If set to `true`, Document.ids are automatically generated based on the hash of the payload, where IDs may not be consistent during multiple imports. In which case ReconciliationMode.FULL is highly recommended to avoid duplicate contents. If unset or set to `false`, Document.ids have to be specified using id_field, otherwise, documents without IDs fail to be imported. Supported data sources: * GcsSource. GcsSource.data_schema must be `custom` or `csv`. Otherwise, an INVALID_ARGUMENT error is thrown. * BigQuerySource. BigQuerySource.data_schema must be `custom` or `csv`. Otherwise, an INVALID_ARGUMENT error is thrown. * SpannerSource. * CloudSqlSource. * FirestoreSource. * BigtableSource. "bigquerySource": { # BigQuery source import data from. # BigQuery input source. "dataSchema": "A String", # The schema to use when parsing the data from the source. Supported values for user event imports: * `user_event` (default): One UserEvent per row. Supported values for document imports: * `document` (default): One Document format per row. Each document must have a valid Document.id and one of Document.json_data or Document.struct_data. * `custom`: One custom data per row in arbitrary format that conforms to the defined Schema of the data store. This can only be used by the GENERIC Data Store vertical. diff --git a/docs/dyn/discoveryengine_v1.projects.locations.collections.dataStores.controls.html b/docs/dyn/discoveryengine_v1.projects.locations.collections.dataStores.controls.html index f59b3a42e4a..068d81d115f 100644 --- a/docs/dyn/discoveryengine_v1.projects.locations.collections.dataStores.controls.html +++ b/docs/dyn/discoveryengine_v1.projects.locations.collections.dataStores.controls.html @@ -106,7 +106,7 @@

Method Details

Creates a Control. By default 1000 controls are allowed for a data store. A request can be submitted to adjust this limit. If the Control to create already exists, an ALREADY_EXISTS error is returned.
 
 Args:
-  parent: string, Required. Full resource name of parent data store. Format: `projects/{project_number}/locations/{location_id}/collections/{collection_id}/dataStores/{data_store_id}` (required)
+  parent: string, Required. Full resource name of parent data store. Format: `projects/{project_number}/locations/{location_id}/collections/{collection_id}/dataStores/{data_store_id}` or `projects/{project_number}/locations/{location_id}/collections/{collection_id}/engines/{engine_id}`. (required)
   body: object, The request body.
     The object takes the form of:
 
@@ -293,7 +293,7 @@ 

Method Details

Lists all Controls by their parent DataStore.
 
 Args:
-  parent: string, Required. The data store resource name. Format: `projects/{project_number}/locations/{location_id}/collections/{collection_id}/dataStores/{data_store_id}` (required)
+  parent: string, Required. The data store resource name. Format: `projects/{project_number}/locations/{location_id}/collections/{collection_id}/dataStores/{data_store_id}` or `projects/{project_number}/locations/{location_id}/collections/{collection_id}/engines/{engine_id}`. (required)
   filter: string, Optional. A filter to apply on the list results. Supported features: * List all the products under the parent branch if filter is unset. Currently this field is unsupported.
   pageSize: integer, Optional. Maximum number of results to return. If unspecified, defaults to 50. Max allowed value is 1000.
   pageToken: string, Optional. A page token, received from a previous `ListControls` call. Provide this to retrieve the subsequent page.
diff --git a/docs/dyn/discoveryengine_v1.projects.locations.collections.dataStores.conversations.html b/docs/dyn/discoveryengine_v1.projects.locations.collections.dataStores.conversations.html
index 8d397e1f314..56232404207 100644
--- a/docs/dyn/discoveryengine_v1.projects.locations.collections.dataStores.conversations.html
+++ b/docs/dyn/discoveryengine_v1.projects.locations.collections.dataStores.conversations.html
@@ -341,6 +341,34 @@ 

Method Details

}, "searchResults": [ # Search Results. { # Represents the search results. + "chunk": { # Chunk captures all raw metadata information of items to be recommended or searched in the chunk mode. # The chunk data in the search response if the SearchRequest.ContentSearchSpec.search_result_mode is set to CHUNKS. + "chunkMetadata": { # Metadata of the current chunk. This field is only populated on SearchService.Search API. # Output only. Metadata of the current chunk. + "nextChunks": [ # The next chunks of the current chunk. The number is controlled by SearchRequest.ContentSearchSpec.ChunkSpec.num_next_chunks. This field is only populated on SearchService.Search API. + # Object with schema name: GoogleCloudDiscoveryengineV1Chunk + ], + "previousChunks": [ # The previous chunks of the current chunk. The number is controlled by SearchRequest.ContentSearchSpec.ChunkSpec.num_previous_chunks. This field is only populated on SearchService.Search API. + # Object with schema name: GoogleCloudDiscoveryengineV1Chunk + ], + }, + "content": "A String", # Content is a string from a document (parsed content). + "derivedStructData": { # Output only. This field is OUTPUT_ONLY. It contains derived data that are not in the original input document. + "a_key": "", # Properties of the object. + }, + "documentMetadata": { # Document metadata contains the information of the document of the current chunk. # Metadata of the document from the current chunk. + "structData": { # Data representation. The structured JSON data for the document. It should conform to the registered Schema or an `INVALID_ARGUMENT` error is thrown. + "a_key": "", # Properties of the object. + }, + "title": "A String", # Title of the document. + "uri": "A String", # Uri of the document. + }, + "id": "A String", # Unique chunk ID of the current chunk. + "name": "A String", # The full resource name of the chunk. Format: `projects/{project}/locations/{location}/collections/{collection}/dataStores/{data_store}/branches/{branch}/documents/{document_id}/chunks/{chunk_id}`. This field must be a UTF-8 encoded string with a length limit of 1024 characters. + "pageSpan": { # Page span of the chunk. # Page span of the chunk. + "pageEnd": 42, # The end page of the chunk. + "pageStart": 42, # The start page of the chunk. + }, + "relevanceScore": 3.14, # Output only. Represents the relevance score based on similarity. Higher score indicates higher chunk relevance. The score is in range [-1.0, 1.0]. Only populated on SearchService.SearchResponse. + }, "document": { # Document captures all raw metadata information of items to be recommended or searched. # The document data snippet in the search response. Only fields that are marked as `retrievable` are populated. "content": { # Unstructured data linked to this document. # The unstructured data linked to this document. Content must be set if this document is under a `CONTENT_REQUIRED` data store. "mimeType": "A String", # The MIME type of the content. Supported types: * `application/pdf` (PDF, only native PDFs are supported for now) * `text/html` (HTML) * `application/vnd.openxmlformats-officedocument.wordprocessingml.document` (DOCX) * `application/vnd.openxmlformats-officedocument.presentationml.presentation` (PPTX) * `text/plain` (TXT) See https://www.iana.org/assignments/media-types/media-types.xhtml. diff --git a/docs/dyn/discoveryengine_v1.projects.locations.collections.dataStores.html b/docs/dyn/discoveryengine_v1.projects.locations.collections.dataStores.html index 10c48ae910d..476855e73c3 100644 --- a/docs/dyn/discoveryengine_v1.projects.locations.collections.dataStores.html +++ b/docs/dyn/discoveryengine_v1.projects.locations.collections.dataStores.html @@ -208,9 +208,17 @@

Method Details

"defaultSchemaId": "A String", # Output only. The id of the default Schema asscociated to this data store. "displayName": "A String", # Required. The data store display name. This field must be a UTF-8 encoded string with a length limit of 128 characters. Otherwise, an INVALID_ARGUMENT error is returned. "documentProcessingConfig": { # A singleton resource of DataStore. It's empty when DataStore is created, which defaults to digital parser. The first call to DataStoreService.UpdateDocumentProcessingConfig method will initialize the config. # Configuration for Document understanding and enrichment. + "chunkingConfig": { # Configuration for chunking config. # Whether chunking mode is enabled. + "layoutBasedChunkingConfig": { # Configuration for the layout based chunking. # Configuration for the layout based chunking. + "chunkSize": 42, # The token size limit for each chunk. Supported values: 100-500 (inclusive). Default value: 500. + "includeAncestorHeadings": True or False, # Whether to include appending different levels of headings to chunks from the middle of the document to prevent context loss. Default value: False. + }, + }, "defaultParsingConfig": { # Related configurations applied to a specific type of document parser. # Configurations for default Document parser. If not specified, we will configure it as default DigitalParsingConfig, and the default parsing config will be applied to all file types for Document parsing. "digitalParsingConfig": { # The digital parsing configurations for documents. # Configurations applied to digital parser. }, + "layoutParsingConfig": { # The layout parsing configurations for documents. # Configurations applied to layout parser. + }, "ocrParsingConfig": { # The OCR parsing configurations for documents. # Configurations applied to OCR parser. Currently it only applies to PDFs. "enhancedDocumentElements": [ # [DEPRECATED] This field is deprecated. To use the additional enhanced document elements processing, please switch to `layout_parsing_config`. "A String", @@ -223,6 +231,8 @@

Method Details

"a_key": { # Related configurations applied to a specific type of document parser. "digitalParsingConfig": { # The digital parsing configurations for documents. # Configurations applied to digital parser. }, + "layoutParsingConfig": { # The layout parsing configurations for documents. # Configurations applied to layout parser. + }, "ocrParsingConfig": { # The OCR parsing configurations for documents. # Configurations applied to OCR parser. Currently it only applies to PDFs. "enhancedDocumentElements": [ # [DEPRECATED] This field is deprecated. To use the additional enhanced document elements processing, please switch to `layout_parsing_config`. "A String", @@ -332,9 +342,17 @@

Method Details

"defaultSchemaId": "A String", # Output only. The id of the default Schema asscociated to this data store. "displayName": "A String", # Required. The data store display name. This field must be a UTF-8 encoded string with a length limit of 128 characters. Otherwise, an INVALID_ARGUMENT error is returned. "documentProcessingConfig": { # A singleton resource of DataStore. It's empty when DataStore is created, which defaults to digital parser. The first call to DataStoreService.UpdateDocumentProcessingConfig method will initialize the config. # Configuration for Document understanding and enrichment. + "chunkingConfig": { # Configuration for chunking config. # Whether chunking mode is enabled. + "layoutBasedChunkingConfig": { # Configuration for the layout based chunking. # Configuration for the layout based chunking. + "chunkSize": 42, # The token size limit for each chunk. Supported values: 100-500 (inclusive). Default value: 500. + "includeAncestorHeadings": True or False, # Whether to include appending different levels of headings to chunks from the middle of the document to prevent context loss. Default value: False. + }, + }, "defaultParsingConfig": { # Related configurations applied to a specific type of document parser. # Configurations for default Document parser. If not specified, we will configure it as default DigitalParsingConfig, and the default parsing config will be applied to all file types for Document parsing. "digitalParsingConfig": { # The digital parsing configurations for documents. # Configurations applied to digital parser. }, + "layoutParsingConfig": { # The layout parsing configurations for documents. # Configurations applied to layout parser. + }, "ocrParsingConfig": { # The OCR parsing configurations for documents. # Configurations applied to OCR parser. Currently it only applies to PDFs. "enhancedDocumentElements": [ # [DEPRECATED] This field is deprecated. To use the additional enhanced document elements processing, please switch to `layout_parsing_config`. "A String", @@ -347,6 +365,8 @@

Method Details

"a_key": { # Related configurations applied to a specific type of document parser. "digitalParsingConfig": { # The digital parsing configurations for documents. # Configurations applied to digital parser. }, + "layoutParsingConfig": { # The layout parsing configurations for documents. # Configurations applied to layout parser. + }, "ocrParsingConfig": { # The OCR parsing configurations for documents. # Configurations applied to OCR parser. Currently it only applies to PDFs. "enhancedDocumentElements": [ # [DEPRECATED] This field is deprecated. To use the additional enhanced document elements processing, please switch to `layout_parsing_config`. "A String", @@ -415,9 +435,17 @@

Method Details

"defaultSchemaId": "A String", # Output only. The id of the default Schema asscociated to this data store. "displayName": "A String", # Required. The data store display name. This field must be a UTF-8 encoded string with a length limit of 128 characters. Otherwise, an INVALID_ARGUMENT error is returned. "documentProcessingConfig": { # A singleton resource of DataStore. It's empty when DataStore is created, which defaults to digital parser. The first call to DataStoreService.UpdateDocumentProcessingConfig method will initialize the config. # Configuration for Document understanding and enrichment. + "chunkingConfig": { # Configuration for chunking config. # Whether chunking mode is enabled. + "layoutBasedChunkingConfig": { # Configuration for the layout based chunking. # Configuration for the layout based chunking. + "chunkSize": 42, # The token size limit for each chunk. Supported values: 100-500 (inclusive). Default value: 500. + "includeAncestorHeadings": True or False, # Whether to include appending different levels of headings to chunks from the middle of the document to prevent context loss. Default value: False. + }, + }, "defaultParsingConfig": { # Related configurations applied to a specific type of document parser. # Configurations for default Document parser. If not specified, we will configure it as default DigitalParsingConfig, and the default parsing config will be applied to all file types for Document parsing. "digitalParsingConfig": { # The digital parsing configurations for documents. # Configurations applied to digital parser. }, + "layoutParsingConfig": { # The layout parsing configurations for documents. # Configurations applied to layout parser. + }, "ocrParsingConfig": { # The OCR parsing configurations for documents. # Configurations applied to OCR parser. Currently it only applies to PDFs. "enhancedDocumentElements": [ # [DEPRECATED] This field is deprecated. To use the additional enhanced document elements processing, please switch to `layout_parsing_config`. "A String", @@ -430,6 +458,8 @@

Method Details

"a_key": { # Related configurations applied to a specific type of document parser. "digitalParsingConfig": { # The digital parsing configurations for documents. # Configurations applied to digital parser. }, + "layoutParsingConfig": { # The layout parsing configurations for documents. # Configurations applied to layout parser. + }, "ocrParsingConfig": { # The OCR parsing configurations for documents. # Configurations applied to OCR parser. Currently it only applies to PDFs. "enhancedDocumentElements": [ # [DEPRECATED] This field is deprecated. To use the additional enhanced document elements processing, please switch to `layout_parsing_config`. "A String", @@ -486,9 +516,17 @@

Method Details

"defaultSchemaId": "A String", # Output only. The id of the default Schema asscociated to this data store. "displayName": "A String", # Required. The data store display name. This field must be a UTF-8 encoded string with a length limit of 128 characters. Otherwise, an INVALID_ARGUMENT error is returned. "documentProcessingConfig": { # A singleton resource of DataStore. It's empty when DataStore is created, which defaults to digital parser. The first call to DataStoreService.UpdateDocumentProcessingConfig method will initialize the config. # Configuration for Document understanding and enrichment. + "chunkingConfig": { # Configuration for chunking config. # Whether chunking mode is enabled. + "layoutBasedChunkingConfig": { # Configuration for the layout based chunking. # Configuration for the layout based chunking. + "chunkSize": 42, # The token size limit for each chunk. Supported values: 100-500 (inclusive). Default value: 500. + "includeAncestorHeadings": True or False, # Whether to include appending different levels of headings to chunks from the middle of the document to prevent context loss. Default value: False. + }, + }, "defaultParsingConfig": { # Related configurations applied to a specific type of document parser. # Configurations for default Document parser. If not specified, we will configure it as default DigitalParsingConfig, and the default parsing config will be applied to all file types for Document parsing. "digitalParsingConfig": { # The digital parsing configurations for documents. # Configurations applied to digital parser. }, + "layoutParsingConfig": { # The layout parsing configurations for documents. # Configurations applied to layout parser. + }, "ocrParsingConfig": { # The OCR parsing configurations for documents. # Configurations applied to OCR parser. Currently it only applies to PDFs. "enhancedDocumentElements": [ # [DEPRECATED] This field is deprecated. To use the additional enhanced document elements processing, please switch to `layout_parsing_config`. "A String", @@ -501,6 +539,8 @@

Method Details

"a_key": { # Related configurations applied to a specific type of document parser. "digitalParsingConfig": { # The digital parsing configurations for documents. # Configurations applied to digital parser. }, + "layoutParsingConfig": { # The layout parsing configurations for documents. # Configurations applied to layout parser. + }, "ocrParsingConfig": { # The OCR parsing configurations for documents. # Configurations applied to OCR parser. Currently it only applies to PDFs. "enhancedDocumentElements": [ # [DEPRECATED] This field is deprecated. To use the additional enhanced document elements processing, please switch to `layout_parsing_config`. "A String", @@ -539,9 +579,17 @@

Method Details

"defaultSchemaId": "A String", # Output only. The id of the default Schema asscociated to this data store. "displayName": "A String", # Required. The data store display name. This field must be a UTF-8 encoded string with a length limit of 128 characters. Otherwise, an INVALID_ARGUMENT error is returned. "documentProcessingConfig": { # A singleton resource of DataStore. It's empty when DataStore is created, which defaults to digital parser. The first call to DataStoreService.UpdateDocumentProcessingConfig method will initialize the config. # Configuration for Document understanding and enrichment. + "chunkingConfig": { # Configuration for chunking config. # Whether chunking mode is enabled. + "layoutBasedChunkingConfig": { # Configuration for the layout based chunking. # Configuration for the layout based chunking. + "chunkSize": 42, # The token size limit for each chunk. Supported values: 100-500 (inclusive). Default value: 500. + "includeAncestorHeadings": True or False, # Whether to include appending different levels of headings to chunks from the middle of the document to prevent context loss. Default value: False. + }, + }, "defaultParsingConfig": { # Related configurations applied to a specific type of document parser. # Configurations for default Document parser. If not specified, we will configure it as default DigitalParsingConfig, and the default parsing config will be applied to all file types for Document parsing. "digitalParsingConfig": { # The digital parsing configurations for documents. # Configurations applied to digital parser. }, + "layoutParsingConfig": { # The layout parsing configurations for documents. # Configurations applied to layout parser. + }, "ocrParsingConfig": { # The OCR parsing configurations for documents. # Configurations applied to OCR parser. Currently it only applies to PDFs. "enhancedDocumentElements": [ # [DEPRECATED] This field is deprecated. To use the additional enhanced document elements processing, please switch to `layout_parsing_config`. "A String", @@ -554,6 +602,8 @@

Method Details

"a_key": { # Related configurations applied to a specific type of document parser. "digitalParsingConfig": { # The digital parsing configurations for documents. # Configurations applied to digital parser. }, + "layoutParsingConfig": { # The layout parsing configurations for documents. # Configurations applied to layout parser. + }, "ocrParsingConfig": { # The OCR parsing configurations for documents. # Configurations applied to OCR parser. Currently it only applies to PDFs. "enhancedDocumentElements": [ # [DEPRECATED] This field is deprecated. To use the additional enhanced document elements processing, please switch to `layout_parsing_config`. "A String", diff --git a/docs/dyn/discoveryengine_v1.projects.locations.collections.dataStores.servingConfigs.html b/docs/dyn/discoveryengine_v1.projects.locations.collections.dataStores.servingConfigs.html index 5b151769ed0..aca98c8a1a8 100644 --- a/docs/dyn/discoveryengine_v1.projects.locations.collections.dataStores.servingConfigs.html +++ b/docs/dyn/discoveryengine_v1.projects.locations.collections.dataStores.servingConfigs.html @@ -152,6 +152,7 @@

Method Details

"filter": "A String", # The filter syntax consists of an expression language for constructing a predicate from one or more fields of the documents being filtered. Filter expression is case-sensitive. This will be used to filter search results which may affect the Answer response. If this field is unrecognizable, an `INVALID_ARGUMENT` is returned. Filtering in Vertex AI Search is done by mapping the LHS filter key to a key property defined in the Vertex AI Search backend -- this mapping is defined by the customer in their schema. For example a media customers might have a field 'name' in their schema. In this case the filter would look like this: filter --> name:'ANY("king kong")' For more information about filtering including syntax and filter operators, see [Filter](https://cloud.google.com/generative-ai-app-builder/docs/filter-search-metadata) "maxReturnResults": 42, # Number of search results to return. The default value is 10. "orderBy": "A String", # The order in which documents are returned. Documents can be ordered by a field in an Document object. Leave it unset if ordered by relevance. `order_by` expression is case-sensitive. For more information on ordering, see [Ordering](https://cloud.google.com/retail/docs/filter-and-order#order) If this field is unrecognizable, an `INVALID_ARGUMENT` is returned. + "searchResultMode": "A String", # Specifies the search result mode. If unspecified, the search result mode is based on DataStore.DocumentProcessingConfig.chunking_config: * If DataStore.DocumentProcessingConfig.chunking_config is specified, it defaults to `CHUNKS`. * Otherwise, it defaults to `DOCUMENTS`. See [parse and chunk documents](https://cloud.google.com/generative-ai-app-builder/docs/parse-chunk-documents) }, "searchResultList": { # Search result list. # Search result list. "searchResults": [ # Search results. @@ -188,6 +189,9 @@

Method Details

}, }, "session": "A String", # The session resource name. Not required. When session field is not set, the API is in sessionless mode. We support auto session mode: users can use the wildcard symbol `-` as session ID. A new ID will be automatically generated and assigned. + "userLabels": { # The user labels applied to a resource must meet the following requirements: * Each resource can have multiple labels, up to a maximum of 64. * Each label must be a key-value pair. * Keys have a minimum length of 1 character and a maximum length of 63 characters and cannot be empty. Values can be empty and have a maximum length of 63 characters. * Keys and values can contain only lowercase letters, numeric characters, underscores, and dashes. All characters must use UTF-8 encoding, and international characters are allowed. * The key portion of a label must be unique. However, you can use the same key with multiple resources. * Keys must start with a lowercase letter or international character. See [Google Cloud Document](https://cloud.google.com/resource-manager/docs/creating-managing-labels#requirements) for more details. + "a_key": "A String", + }, "userPseudoId": "A String", # A unique identifier for tracking visitors. For example, this could be implemented with an HTTP cookie, which should be able to uniquely identify a visitor on a single device. This unique identifier should not change if the visitor logs in or out of the website. This field should NOT have a fixed value such as `unknown_visitor`. The field must be a UTF-8 encoded string with a length limit of 128 characters. Otherwise, an `INVALID_ARGUMENT` error is returned. } @@ -486,6 +490,10 @@

Method Details

"branch": "A String", # The branch resource name, such as `projects/*/locations/global/collections/default_collection/dataStores/default_data_store/branches/0`. Use `default_branch` as the branch ID or leave this field empty, to search documents under the default branch. "canonicalFilter": "A String", # The default filter that is applied when a user performs a search without checking any filters on the search page. The filter applied to every search request when quality improvement such as query expansion is needed. In the case a query does not have a sufficient amount of results this filter will be used to determine whether or not to enable the query expansion flow. The original filter will still be used for the query expanded search. This field is strongly recommended to achieve high search quality. For more information about filter syntax, see SearchRequest.filter. "contentSearchSpec": { # A specification for configuring the behavior of content search. # A specification for configuring the behavior of content search. + "chunkSpec": { # Specifies the chunk spec to be returned from the search response. Only available if the SearchRequest.ContentSearchSpec.search_result_mode is set to CHUNKS # Specifies the chunk spec to be returned from the search response. Only available if the SearchRequest.ContentSearchSpec.search_result_mode is set to CHUNKS + "numNextChunks": 42, # The number of next chunks to be returned of the current chunk. The maximum allowed value is 3. If not specified, no next chunks will be returned. + "numPreviousChunks": 42, # The number of previous chunks to be returned of the current chunk. The maximum allowed value is 3. If not specified, no previous chunks will be returned. + }, "extractiveContentSpec": { # A specification for configuring the extractive content in a search response. # If there is no extractive_content_spec provided, there will be no extractive answer in the search response. "maxExtractiveAnswerCount": 42, # The maximum number of extractive answers returned in each search result. An extractive answer is a verbatim answer extracted from the original document, which provides a precise and contextually relevant answer to the search query. If the number of matching answers is less than the `max_extractive_answer_count`, return all of the answers. Otherwise, return the `max_extractive_answer_count`. At most five answers are returned for each SearchResult. "maxExtractiveSegmentCount": 42, # The max number of extractive segments returned in each search result. Only applied if the DataStore is set to DataStore.ContentConfig.CONTENT_REQUIRED or DataStore.solution_types is SOLUTION_TYPE_CHAT. An extractive segment is a text segment extracted from the original document that is relevant to the search query, and, in general, more verbose than an extractive answer. The segment could then be used as input for LLMs to generate summaries and answers. If the number of matching segments is less than `max_extractive_segment_count`, return all of the segments. Otherwise, return the `max_extractive_segment_count`. @@ -493,6 +501,7 @@

Method Details

"numPreviousSegments": 42, # Specifies whether to also include the adjacent from each selected segments. Return at most `num_previous_segments` segments before each selected segments. "returnExtractiveSegmentScore": True or False, # Specifies whether to return the confidence score from the extractive segments in each search result. This feature is available only for new or allowlisted data stores. To allowlist your data store, contact your Customer Engineer. The default value is `false`. }, + "searchResultMode": "A String", # Specifies the search result mode. If unspecified, the search result mode is based on DataStore.DocumentProcessingConfig.chunking_config: * If DataStore.DocumentProcessingConfig.chunking_config is specified, it defaults to `CHUNKS`. * Otherwise, it defaults to `DOCUMENTS`. "snippetSpec": { # A specification for configuring snippets in a search response. # If `snippetSpec` is not specified, snippets are not included in the search response. "maxSnippetCount": 42, # [DEPRECATED] This field is deprecated. To control snippet return, use `return_snippet` field. For backwards compatibility, we will return snippet if max_snippet_count > 0. "referenceOnly": True or False, # [DEPRECATED] This field is deprecated and will have no affect on the snippet. @@ -616,6 +625,34 @@

Method Details

"redirectUri": "A String", # The URI of a customer-defined redirect page. If redirect action is triggered, no search is performed, and only redirect_uri and attribution_token are set in the response. "results": [ # A list of matched documents. The order represents the ranking. { # Represents the search results. + "chunk": { # Chunk captures all raw metadata information of items to be recommended or searched in the chunk mode. # The chunk data in the search response if the SearchRequest.ContentSearchSpec.search_result_mode is set to CHUNKS. + "chunkMetadata": { # Metadata of the current chunk. This field is only populated on SearchService.Search API. # Output only. Metadata of the current chunk. + "nextChunks": [ # The next chunks of the current chunk. The number is controlled by SearchRequest.ContentSearchSpec.ChunkSpec.num_next_chunks. This field is only populated on SearchService.Search API. + # Object with schema name: GoogleCloudDiscoveryengineV1Chunk + ], + "previousChunks": [ # The previous chunks of the current chunk. The number is controlled by SearchRequest.ContentSearchSpec.ChunkSpec.num_previous_chunks. This field is only populated on SearchService.Search API. + # Object with schema name: GoogleCloudDiscoveryengineV1Chunk + ], + }, + "content": "A String", # Content is a string from a document (parsed content). + "derivedStructData": { # Output only. This field is OUTPUT_ONLY. It contains derived data that are not in the original input document. + "a_key": "", # Properties of the object. + }, + "documentMetadata": { # Document metadata contains the information of the document of the current chunk. # Metadata of the document from the current chunk. + "structData": { # Data representation. The structured JSON data for the document. It should conform to the registered Schema or an `INVALID_ARGUMENT` error is thrown. + "a_key": "", # Properties of the object. + }, + "title": "A String", # Title of the document. + "uri": "A String", # Uri of the document. + }, + "id": "A String", # Unique chunk ID of the current chunk. + "name": "A String", # The full resource name of the chunk. Format: `projects/{project}/locations/{location}/collections/{collection}/dataStores/{data_store}/branches/{branch}/documents/{document_id}/chunks/{chunk_id}`. This field must be a UTF-8 encoded string with a length limit of 1024 characters. + "pageSpan": { # Page span of the chunk. # Page span of the chunk. + "pageEnd": 42, # The end page of the chunk. + "pageStart": 42, # The start page of the chunk. + }, + "relevanceScore": 3.14, # Output only. Represents the relevance score based on similarity. Higher score indicates higher chunk relevance. The score is in range [-1.0, 1.0]. Only populated on SearchService.SearchResponse. + }, "document": { # Document captures all raw metadata information of items to be recommended or searched. # The document data snippet in the search response. Only fields that are marked as `retrievable` are populated. "content": { # Unstructured data linked to this document. # The unstructured data linked to this document. Content must be set if this document is under a `CONTENT_REQUIRED` data store. "mimeType": "A String", # The MIME type of the content. Supported types: * `application/pdf` (PDF, only native PDFs are supported for now) * `text/html` (HTML) * `application/vnd.openxmlformats-officedocument.wordprocessingml.document` (DOCX) * `application/vnd.openxmlformats-officedocument.presentationml.presentation` (PPTX) * `text/plain` (TXT) See https://www.iana.org/assignments/media-types/media-types.xhtml. diff --git a/docs/dyn/discoveryengine_v1.projects.locations.collections.engines.controls.html b/docs/dyn/discoveryengine_v1.projects.locations.collections.engines.controls.html index 4c1aa00df23..780468424dd 100644 --- a/docs/dyn/discoveryengine_v1.projects.locations.collections.engines.controls.html +++ b/docs/dyn/discoveryengine_v1.projects.locations.collections.engines.controls.html @@ -106,7 +106,7 @@

Method Details

Creates a Control. By default 1000 controls are allowed for a data store. A request can be submitted to adjust this limit. If the Control to create already exists, an ALREADY_EXISTS error is returned.
 
 Args:
-  parent: string, Required. Full resource name of parent data store. Format: `projects/{project_number}/locations/{location_id}/collections/{collection_id}/dataStores/{data_store_id}` (required)
+  parent: string, Required. Full resource name of parent data store. Format: `projects/{project_number}/locations/{location_id}/collections/{collection_id}/dataStores/{data_store_id}` or `projects/{project_number}/locations/{location_id}/collections/{collection_id}/engines/{engine_id}`. (required)
   body: object, The request body.
     The object takes the form of:
 
@@ -293,7 +293,7 @@ 

Method Details

Lists all Controls by their parent DataStore.
 
 Args:
-  parent: string, Required. The data store resource name. Format: `projects/{project_number}/locations/{location_id}/collections/{collection_id}/dataStores/{data_store_id}` (required)
+  parent: string, Required. The data store resource name. Format: `projects/{project_number}/locations/{location_id}/collections/{collection_id}/dataStores/{data_store_id}` or `projects/{project_number}/locations/{location_id}/collections/{collection_id}/engines/{engine_id}`. (required)
   filter: string, Optional. A filter to apply on the list results. Supported features: * List all the products under the parent branch if filter is unset. Currently this field is unsupported.
   pageSize: integer, Optional. Maximum number of results to return. If unspecified, defaults to 50. Max allowed value is 1000.
   pageToken: string, Optional. A page token, received from a previous `ListControls` call. Provide this to retrieve the subsequent page.
diff --git a/docs/dyn/discoveryengine_v1.projects.locations.collections.engines.conversations.html b/docs/dyn/discoveryengine_v1.projects.locations.collections.engines.conversations.html
index 9aeca320d29..f91e460bfa7 100644
--- a/docs/dyn/discoveryengine_v1.projects.locations.collections.engines.conversations.html
+++ b/docs/dyn/discoveryengine_v1.projects.locations.collections.engines.conversations.html
@@ -341,6 +341,34 @@ 

Method Details

}, "searchResults": [ # Search Results. { # Represents the search results. + "chunk": { # Chunk captures all raw metadata information of items to be recommended or searched in the chunk mode. # The chunk data in the search response if the SearchRequest.ContentSearchSpec.search_result_mode is set to CHUNKS. + "chunkMetadata": { # Metadata of the current chunk. This field is only populated on SearchService.Search API. # Output only. Metadata of the current chunk. + "nextChunks": [ # The next chunks of the current chunk. The number is controlled by SearchRequest.ContentSearchSpec.ChunkSpec.num_next_chunks. This field is only populated on SearchService.Search API. + # Object with schema name: GoogleCloudDiscoveryengineV1Chunk + ], + "previousChunks": [ # The previous chunks of the current chunk. The number is controlled by SearchRequest.ContentSearchSpec.ChunkSpec.num_previous_chunks. This field is only populated on SearchService.Search API. + # Object with schema name: GoogleCloudDiscoveryengineV1Chunk + ], + }, + "content": "A String", # Content is a string from a document (parsed content). + "derivedStructData": { # Output only. This field is OUTPUT_ONLY. It contains derived data that are not in the original input document. + "a_key": "", # Properties of the object. + }, + "documentMetadata": { # Document metadata contains the information of the document of the current chunk. # Metadata of the document from the current chunk. + "structData": { # Data representation. The structured JSON data for the document. It should conform to the registered Schema or an `INVALID_ARGUMENT` error is thrown. + "a_key": "", # Properties of the object. + }, + "title": "A String", # Title of the document. + "uri": "A String", # Uri of the document. + }, + "id": "A String", # Unique chunk ID of the current chunk. + "name": "A String", # The full resource name of the chunk. Format: `projects/{project}/locations/{location}/collections/{collection}/dataStores/{data_store}/branches/{branch}/documents/{document_id}/chunks/{chunk_id}`. This field must be a UTF-8 encoded string with a length limit of 1024 characters. + "pageSpan": { # Page span of the chunk. # Page span of the chunk. + "pageEnd": 42, # The end page of the chunk. + "pageStart": 42, # The start page of the chunk. + }, + "relevanceScore": 3.14, # Output only. Represents the relevance score based on similarity. Higher score indicates higher chunk relevance. The score is in range [-1.0, 1.0]. Only populated on SearchService.SearchResponse. + }, "document": { # Document captures all raw metadata information of items to be recommended or searched. # The document data snippet in the search response. Only fields that are marked as `retrievable` are populated. "content": { # Unstructured data linked to this document. # The unstructured data linked to this document. Content must be set if this document is under a `CONTENT_REQUIRED` data store. "mimeType": "A String", # The MIME type of the content. Supported types: * `application/pdf` (PDF, only native PDFs are supported for now) * `text/html` (HTML) * `application/vnd.openxmlformats-officedocument.wordprocessingml.document` (DOCX) * `application/vnd.openxmlformats-officedocument.presentationml.presentation` (PPTX) * `text/plain` (TXT) See https://www.iana.org/assignments/media-types/media-types.xhtml. diff --git a/docs/dyn/discoveryengine_v1.projects.locations.collections.engines.servingConfigs.html b/docs/dyn/discoveryengine_v1.projects.locations.collections.engines.servingConfigs.html index 955f5a2c848..c86f23d9526 100644 --- a/docs/dyn/discoveryengine_v1.projects.locations.collections.engines.servingConfigs.html +++ b/docs/dyn/discoveryengine_v1.projects.locations.collections.engines.servingConfigs.html @@ -152,6 +152,7 @@

Method Details

"filter": "A String", # The filter syntax consists of an expression language for constructing a predicate from one or more fields of the documents being filtered. Filter expression is case-sensitive. This will be used to filter search results which may affect the Answer response. If this field is unrecognizable, an `INVALID_ARGUMENT` is returned. Filtering in Vertex AI Search is done by mapping the LHS filter key to a key property defined in the Vertex AI Search backend -- this mapping is defined by the customer in their schema. For example a media customers might have a field 'name' in their schema. In this case the filter would look like this: filter --> name:'ANY("king kong")' For more information about filtering including syntax and filter operators, see [Filter](https://cloud.google.com/generative-ai-app-builder/docs/filter-search-metadata) "maxReturnResults": 42, # Number of search results to return. The default value is 10. "orderBy": "A String", # The order in which documents are returned. Documents can be ordered by a field in an Document object. Leave it unset if ordered by relevance. `order_by` expression is case-sensitive. For more information on ordering, see [Ordering](https://cloud.google.com/retail/docs/filter-and-order#order) If this field is unrecognizable, an `INVALID_ARGUMENT` is returned. + "searchResultMode": "A String", # Specifies the search result mode. If unspecified, the search result mode is based on DataStore.DocumentProcessingConfig.chunking_config: * If DataStore.DocumentProcessingConfig.chunking_config is specified, it defaults to `CHUNKS`. * Otherwise, it defaults to `DOCUMENTS`. See [parse and chunk documents](https://cloud.google.com/generative-ai-app-builder/docs/parse-chunk-documents) }, "searchResultList": { # Search result list. # Search result list. "searchResults": [ # Search results. @@ -188,6 +189,9 @@

Method Details

}, }, "session": "A String", # The session resource name. Not required. When session field is not set, the API is in sessionless mode. We support auto session mode: users can use the wildcard symbol `-` as session ID. A new ID will be automatically generated and assigned. + "userLabels": { # The user labels applied to a resource must meet the following requirements: * Each resource can have multiple labels, up to a maximum of 64. * Each label must be a key-value pair. * Keys have a minimum length of 1 character and a maximum length of 63 characters and cannot be empty. Values can be empty and have a maximum length of 63 characters. * Keys and values can contain only lowercase letters, numeric characters, underscores, and dashes. All characters must use UTF-8 encoding, and international characters are allowed. * The key portion of a label must be unique. However, you can use the same key with multiple resources. * Keys must start with a lowercase letter or international character. See [Google Cloud Document](https://cloud.google.com/resource-manager/docs/creating-managing-labels#requirements) for more details. + "a_key": "A String", + }, "userPseudoId": "A String", # A unique identifier for tracking visitors. For example, this could be implemented with an HTTP cookie, which should be able to uniquely identify a visitor on a single device. This unique identifier should not change if the visitor logs in or out of the website. This field should NOT have a fixed value such as `unknown_visitor`. The field must be a UTF-8 encoded string with a length limit of 128 characters. Otherwise, an `INVALID_ARGUMENT` error is returned. } @@ -486,6 +490,10 @@

Method Details

"branch": "A String", # The branch resource name, such as `projects/*/locations/global/collections/default_collection/dataStores/default_data_store/branches/0`. Use `default_branch` as the branch ID or leave this field empty, to search documents under the default branch. "canonicalFilter": "A String", # The default filter that is applied when a user performs a search without checking any filters on the search page. The filter applied to every search request when quality improvement such as query expansion is needed. In the case a query does not have a sufficient amount of results this filter will be used to determine whether or not to enable the query expansion flow. The original filter will still be used for the query expanded search. This field is strongly recommended to achieve high search quality. For more information about filter syntax, see SearchRequest.filter. "contentSearchSpec": { # A specification for configuring the behavior of content search. # A specification for configuring the behavior of content search. + "chunkSpec": { # Specifies the chunk spec to be returned from the search response. Only available if the SearchRequest.ContentSearchSpec.search_result_mode is set to CHUNKS # Specifies the chunk spec to be returned from the search response. Only available if the SearchRequest.ContentSearchSpec.search_result_mode is set to CHUNKS + "numNextChunks": 42, # The number of next chunks to be returned of the current chunk. The maximum allowed value is 3. If not specified, no next chunks will be returned. + "numPreviousChunks": 42, # The number of previous chunks to be returned of the current chunk. The maximum allowed value is 3. If not specified, no previous chunks will be returned. + }, "extractiveContentSpec": { # A specification for configuring the extractive content in a search response. # If there is no extractive_content_spec provided, there will be no extractive answer in the search response. "maxExtractiveAnswerCount": 42, # The maximum number of extractive answers returned in each search result. An extractive answer is a verbatim answer extracted from the original document, which provides a precise and contextually relevant answer to the search query. If the number of matching answers is less than the `max_extractive_answer_count`, return all of the answers. Otherwise, return the `max_extractive_answer_count`. At most five answers are returned for each SearchResult. "maxExtractiveSegmentCount": 42, # The max number of extractive segments returned in each search result. Only applied if the DataStore is set to DataStore.ContentConfig.CONTENT_REQUIRED or DataStore.solution_types is SOLUTION_TYPE_CHAT. An extractive segment is a text segment extracted from the original document that is relevant to the search query, and, in general, more verbose than an extractive answer. The segment could then be used as input for LLMs to generate summaries and answers. If the number of matching segments is less than `max_extractive_segment_count`, return all of the segments. Otherwise, return the `max_extractive_segment_count`. @@ -493,6 +501,7 @@

Method Details

"numPreviousSegments": 42, # Specifies whether to also include the adjacent from each selected segments. Return at most `num_previous_segments` segments before each selected segments. "returnExtractiveSegmentScore": True or False, # Specifies whether to return the confidence score from the extractive segments in each search result. This feature is available only for new or allowlisted data stores. To allowlist your data store, contact your Customer Engineer. The default value is `false`. }, + "searchResultMode": "A String", # Specifies the search result mode. If unspecified, the search result mode is based on DataStore.DocumentProcessingConfig.chunking_config: * If DataStore.DocumentProcessingConfig.chunking_config is specified, it defaults to `CHUNKS`. * Otherwise, it defaults to `DOCUMENTS`. "snippetSpec": { # A specification for configuring snippets in a search response. # If `snippetSpec` is not specified, snippets are not included in the search response. "maxSnippetCount": 42, # [DEPRECATED] This field is deprecated. To control snippet return, use `return_snippet` field. For backwards compatibility, we will return snippet if max_snippet_count > 0. "referenceOnly": True or False, # [DEPRECATED] This field is deprecated and will have no affect on the snippet. @@ -616,6 +625,34 @@

Method Details

"redirectUri": "A String", # The URI of a customer-defined redirect page. If redirect action is triggered, no search is performed, and only redirect_uri and attribution_token are set in the response. "results": [ # A list of matched documents. The order represents the ranking. { # Represents the search results. + "chunk": { # Chunk captures all raw metadata information of items to be recommended or searched in the chunk mode. # The chunk data in the search response if the SearchRequest.ContentSearchSpec.search_result_mode is set to CHUNKS. + "chunkMetadata": { # Metadata of the current chunk. This field is only populated on SearchService.Search API. # Output only. Metadata of the current chunk. + "nextChunks": [ # The next chunks of the current chunk. The number is controlled by SearchRequest.ContentSearchSpec.ChunkSpec.num_next_chunks. This field is only populated on SearchService.Search API. + # Object with schema name: GoogleCloudDiscoveryengineV1Chunk + ], + "previousChunks": [ # The previous chunks of the current chunk. The number is controlled by SearchRequest.ContentSearchSpec.ChunkSpec.num_previous_chunks. This field is only populated on SearchService.Search API. + # Object with schema name: GoogleCloudDiscoveryengineV1Chunk + ], + }, + "content": "A String", # Content is a string from a document (parsed content). + "derivedStructData": { # Output only. This field is OUTPUT_ONLY. It contains derived data that are not in the original input document. + "a_key": "", # Properties of the object. + }, + "documentMetadata": { # Document metadata contains the information of the document of the current chunk. # Metadata of the document from the current chunk. + "structData": { # Data representation. The structured JSON data for the document. It should conform to the registered Schema or an `INVALID_ARGUMENT` error is thrown. + "a_key": "", # Properties of the object. + }, + "title": "A String", # Title of the document. + "uri": "A String", # Uri of the document. + }, + "id": "A String", # Unique chunk ID of the current chunk. + "name": "A String", # The full resource name of the chunk. Format: `projects/{project}/locations/{location}/collections/{collection}/dataStores/{data_store}/branches/{branch}/documents/{document_id}/chunks/{chunk_id}`. This field must be a UTF-8 encoded string with a length limit of 1024 characters. + "pageSpan": { # Page span of the chunk. # Page span of the chunk. + "pageEnd": 42, # The end page of the chunk. + "pageStart": 42, # The start page of the chunk. + }, + "relevanceScore": 3.14, # Output only. Represents the relevance score based on similarity. Higher score indicates higher chunk relevance. The score is in range [-1.0, 1.0]. Only populated on SearchService.SearchResponse. + }, "document": { # Document captures all raw metadata information of items to be recommended or searched. # The document data snippet in the search response. Only fields that are marked as `retrievable` are populated. "content": { # Unstructured data linked to this document. # The unstructured data linked to this document. Content must be set if this document is under a `CONTENT_REQUIRED` data store. "mimeType": "A String", # The MIME type of the content. Supported types: * `application/pdf` (PDF, only native PDFs are supported for now) * `text/html` (HTML) * `application/vnd.openxmlformats-officedocument.wordprocessingml.document` (DOCX) * `application/vnd.openxmlformats-officedocument.presentationml.presentation` (PPTX) * `text/plain` (TXT) See https://www.iana.org/assignments/media-types/media-types.xhtml. diff --git a/docs/dyn/discoveryengine_v1.projects.locations.dataStores.branches.documents.html b/docs/dyn/discoveryengine_v1.projects.locations.dataStores.branches.documents.html index 32019f190d4..16d029e1acf 100644 --- a/docs/dyn/discoveryengine_v1.projects.locations.dataStores.branches.documents.html +++ b/docs/dyn/discoveryengine_v1.projects.locations.dataStores.branches.documents.html @@ -229,6 +229,14 @@

Method Details

The object takes the form of: { # Request message for Import methods. + "alloyDbSource": { # AlloyDB source import data from. # AlloyDB input source. + "clusterId": "A String", # Required. The AlloyDB cluster to copy the data from with a length limit of 256 characters. + "databaseId": "A String", # Required. The AlloyDB database to copy the data from with a length limit of 256 characters. + "gcsStagingDir": "A String", # Intermediate Cloud Storage directory used for the import with a length limit of 2,000 characters. Can be specified if one wants to have the AlloyDB export to a specific Cloud Storage directory. Ensure that the AlloyDB service account has the necessary Cloud Storage Admin permissions to access the specified Cloud Storage directory. + "locationId": "A String", # Required. The AlloyDB location to copy the data from with a length limit of 256 characters. + "projectId": "A String", # The project ID that the AlloyDB source is in with a length limit of 128 characters. If not specified, inherits the project ID from the parent request. + "tableId": "A String", # Required. The AlloyDB table to copy the data from with a length limit of 256 characters. + }, "autoGenerateIds": True or False, # Whether to automatically generate IDs for the documents if absent. If set to `true`, Document.ids are automatically generated based on the hash of the payload, where IDs may not be consistent during multiple imports. In which case ReconciliationMode.FULL is highly recommended to avoid duplicate contents. If unset or set to `false`, Document.ids have to be specified using id_field, otherwise, documents without IDs fail to be imported. Supported data sources: * GcsSource. GcsSource.data_schema must be `custom` or `csv`. Otherwise, an INVALID_ARGUMENT error is thrown. * BigQuerySource. BigQuerySource.data_schema must be `custom` or `csv`. Otherwise, an INVALID_ARGUMENT error is thrown. * SpannerSource. * CloudSqlSource. * FirestoreSource. * BigtableSource. "bigquerySource": { # BigQuery source import data from. # BigQuery input source. "dataSchema": "A String", # The schema to use when parsing the data from the source. Supported values for user event imports: * `user_event` (default): One UserEvent per row. Supported values for document imports: * `document` (default): One Document format per row. Each document must have a valid Document.id and one of Document.json_data or Document.struct_data. * `custom`: One custom data per row in arbitrary format that conforms to the defined Schema of the data store. This can only be used by the GENERIC Data Store vertical. diff --git a/docs/dyn/discoveryengine_v1.projects.locations.dataStores.controls.html b/docs/dyn/discoveryengine_v1.projects.locations.dataStores.controls.html index 6d7cd08683e..21c632ef75f 100644 --- a/docs/dyn/discoveryengine_v1.projects.locations.dataStores.controls.html +++ b/docs/dyn/discoveryengine_v1.projects.locations.dataStores.controls.html @@ -106,7 +106,7 @@

Method Details

Creates a Control. By default 1000 controls are allowed for a data store. A request can be submitted to adjust this limit. If the Control to create already exists, an ALREADY_EXISTS error is returned.
 
 Args:
-  parent: string, Required. Full resource name of parent data store. Format: `projects/{project_number}/locations/{location_id}/collections/{collection_id}/dataStores/{data_store_id}` (required)
+  parent: string, Required. Full resource name of parent data store. Format: `projects/{project_number}/locations/{location_id}/collections/{collection_id}/dataStores/{data_store_id}` or `projects/{project_number}/locations/{location_id}/collections/{collection_id}/engines/{engine_id}`. (required)
   body: object, The request body.
     The object takes the form of:
 
@@ -293,7 +293,7 @@ 

Method Details

Lists all Controls by their parent DataStore.
 
 Args:
-  parent: string, Required. The data store resource name. Format: `projects/{project_number}/locations/{location_id}/collections/{collection_id}/dataStores/{data_store_id}` (required)
+  parent: string, Required. The data store resource name. Format: `projects/{project_number}/locations/{location_id}/collections/{collection_id}/dataStores/{data_store_id}` or `projects/{project_number}/locations/{location_id}/collections/{collection_id}/engines/{engine_id}`. (required)
   filter: string, Optional. A filter to apply on the list results. Supported features: * List all the products under the parent branch if filter is unset. Currently this field is unsupported.
   pageSize: integer, Optional. Maximum number of results to return. If unspecified, defaults to 50. Max allowed value is 1000.
   pageToken: string, Optional. A page token, received from a previous `ListControls` call. Provide this to retrieve the subsequent page.
diff --git a/docs/dyn/discoveryengine_v1.projects.locations.dataStores.conversations.html b/docs/dyn/discoveryengine_v1.projects.locations.dataStores.conversations.html
index 18c81b0db39..4ea86c76171 100644
--- a/docs/dyn/discoveryengine_v1.projects.locations.dataStores.conversations.html
+++ b/docs/dyn/discoveryengine_v1.projects.locations.dataStores.conversations.html
@@ -341,6 +341,34 @@ 

Method Details

}, "searchResults": [ # Search Results. { # Represents the search results. + "chunk": { # Chunk captures all raw metadata information of items to be recommended or searched in the chunk mode. # The chunk data in the search response if the SearchRequest.ContentSearchSpec.search_result_mode is set to CHUNKS. + "chunkMetadata": { # Metadata of the current chunk. This field is only populated on SearchService.Search API. # Output only. Metadata of the current chunk. + "nextChunks": [ # The next chunks of the current chunk. The number is controlled by SearchRequest.ContentSearchSpec.ChunkSpec.num_next_chunks. This field is only populated on SearchService.Search API. + # Object with schema name: GoogleCloudDiscoveryengineV1Chunk + ], + "previousChunks": [ # The previous chunks of the current chunk. The number is controlled by SearchRequest.ContentSearchSpec.ChunkSpec.num_previous_chunks. This field is only populated on SearchService.Search API. + # Object with schema name: GoogleCloudDiscoveryengineV1Chunk + ], + }, + "content": "A String", # Content is a string from a document (parsed content). + "derivedStructData": { # Output only. This field is OUTPUT_ONLY. It contains derived data that are not in the original input document. + "a_key": "", # Properties of the object. + }, + "documentMetadata": { # Document metadata contains the information of the document of the current chunk. # Metadata of the document from the current chunk. + "structData": { # Data representation. The structured JSON data for the document. It should conform to the registered Schema or an `INVALID_ARGUMENT` error is thrown. + "a_key": "", # Properties of the object. + }, + "title": "A String", # Title of the document. + "uri": "A String", # Uri of the document. + }, + "id": "A String", # Unique chunk ID of the current chunk. + "name": "A String", # The full resource name of the chunk. Format: `projects/{project}/locations/{location}/collections/{collection}/dataStores/{data_store}/branches/{branch}/documents/{document_id}/chunks/{chunk_id}`. This field must be a UTF-8 encoded string with a length limit of 1024 characters. + "pageSpan": { # Page span of the chunk. # Page span of the chunk. + "pageEnd": 42, # The end page of the chunk. + "pageStart": 42, # The start page of the chunk. + }, + "relevanceScore": 3.14, # Output only. Represents the relevance score based on similarity. Higher score indicates higher chunk relevance. The score is in range [-1.0, 1.0]. Only populated on SearchService.SearchResponse. + }, "document": { # Document captures all raw metadata information of items to be recommended or searched. # The document data snippet in the search response. Only fields that are marked as `retrievable` are populated. "content": { # Unstructured data linked to this document. # The unstructured data linked to this document. Content must be set if this document is under a `CONTENT_REQUIRED` data store. "mimeType": "A String", # The MIME type of the content. Supported types: * `application/pdf` (PDF, only native PDFs are supported for now) * `text/html` (HTML) * `application/vnd.openxmlformats-officedocument.wordprocessingml.document` (DOCX) * `application/vnd.openxmlformats-officedocument.presentationml.presentation` (PPTX) * `text/plain` (TXT) See https://www.iana.org/assignments/media-types/media-types.xhtml. diff --git a/docs/dyn/discoveryengine_v1.projects.locations.dataStores.html b/docs/dyn/discoveryengine_v1.projects.locations.dataStores.html index bd408210aac..c2bb3eebc09 100644 --- a/docs/dyn/discoveryengine_v1.projects.locations.dataStores.html +++ b/docs/dyn/discoveryengine_v1.projects.locations.dataStores.html @@ -208,9 +208,17 @@

Method Details

"defaultSchemaId": "A String", # Output only. The id of the default Schema asscociated to this data store. "displayName": "A String", # Required. The data store display name. This field must be a UTF-8 encoded string with a length limit of 128 characters. Otherwise, an INVALID_ARGUMENT error is returned. "documentProcessingConfig": { # A singleton resource of DataStore. It's empty when DataStore is created, which defaults to digital parser. The first call to DataStoreService.UpdateDocumentProcessingConfig method will initialize the config. # Configuration for Document understanding and enrichment. + "chunkingConfig": { # Configuration for chunking config. # Whether chunking mode is enabled. + "layoutBasedChunkingConfig": { # Configuration for the layout based chunking. # Configuration for the layout based chunking. + "chunkSize": 42, # The token size limit for each chunk. Supported values: 100-500 (inclusive). Default value: 500. + "includeAncestorHeadings": True or False, # Whether to include appending different levels of headings to chunks from the middle of the document to prevent context loss. Default value: False. + }, + }, "defaultParsingConfig": { # Related configurations applied to a specific type of document parser. # Configurations for default Document parser. If not specified, we will configure it as default DigitalParsingConfig, and the default parsing config will be applied to all file types for Document parsing. "digitalParsingConfig": { # The digital parsing configurations for documents. # Configurations applied to digital parser. }, + "layoutParsingConfig": { # The layout parsing configurations for documents. # Configurations applied to layout parser. + }, "ocrParsingConfig": { # The OCR parsing configurations for documents. # Configurations applied to OCR parser. Currently it only applies to PDFs. "enhancedDocumentElements": [ # [DEPRECATED] This field is deprecated. To use the additional enhanced document elements processing, please switch to `layout_parsing_config`. "A String", @@ -223,6 +231,8 @@

Method Details

"a_key": { # Related configurations applied to a specific type of document parser. "digitalParsingConfig": { # The digital parsing configurations for documents. # Configurations applied to digital parser. }, + "layoutParsingConfig": { # The layout parsing configurations for documents. # Configurations applied to layout parser. + }, "ocrParsingConfig": { # The OCR parsing configurations for documents. # Configurations applied to OCR parser. Currently it only applies to PDFs. "enhancedDocumentElements": [ # [DEPRECATED] This field is deprecated. To use the additional enhanced document elements processing, please switch to `layout_parsing_config`. "A String", @@ -332,9 +342,17 @@

Method Details

"defaultSchemaId": "A String", # Output only. The id of the default Schema asscociated to this data store. "displayName": "A String", # Required. The data store display name. This field must be a UTF-8 encoded string with a length limit of 128 characters. Otherwise, an INVALID_ARGUMENT error is returned. "documentProcessingConfig": { # A singleton resource of DataStore. It's empty when DataStore is created, which defaults to digital parser. The first call to DataStoreService.UpdateDocumentProcessingConfig method will initialize the config. # Configuration for Document understanding and enrichment. + "chunkingConfig": { # Configuration for chunking config. # Whether chunking mode is enabled. + "layoutBasedChunkingConfig": { # Configuration for the layout based chunking. # Configuration for the layout based chunking. + "chunkSize": 42, # The token size limit for each chunk. Supported values: 100-500 (inclusive). Default value: 500. + "includeAncestorHeadings": True or False, # Whether to include appending different levels of headings to chunks from the middle of the document to prevent context loss. Default value: False. + }, + }, "defaultParsingConfig": { # Related configurations applied to a specific type of document parser. # Configurations for default Document parser. If not specified, we will configure it as default DigitalParsingConfig, and the default parsing config will be applied to all file types for Document parsing. "digitalParsingConfig": { # The digital parsing configurations for documents. # Configurations applied to digital parser. }, + "layoutParsingConfig": { # The layout parsing configurations for documents. # Configurations applied to layout parser. + }, "ocrParsingConfig": { # The OCR parsing configurations for documents. # Configurations applied to OCR parser. Currently it only applies to PDFs. "enhancedDocumentElements": [ # [DEPRECATED] This field is deprecated. To use the additional enhanced document elements processing, please switch to `layout_parsing_config`. "A String", @@ -347,6 +365,8 @@

Method Details

"a_key": { # Related configurations applied to a specific type of document parser. "digitalParsingConfig": { # The digital parsing configurations for documents. # Configurations applied to digital parser. }, + "layoutParsingConfig": { # The layout parsing configurations for documents. # Configurations applied to layout parser. + }, "ocrParsingConfig": { # The OCR parsing configurations for documents. # Configurations applied to OCR parser. Currently it only applies to PDFs. "enhancedDocumentElements": [ # [DEPRECATED] This field is deprecated. To use the additional enhanced document elements processing, please switch to `layout_parsing_config`. "A String", @@ -415,9 +435,17 @@

Method Details

"defaultSchemaId": "A String", # Output only. The id of the default Schema asscociated to this data store. "displayName": "A String", # Required. The data store display name. This field must be a UTF-8 encoded string with a length limit of 128 characters. Otherwise, an INVALID_ARGUMENT error is returned. "documentProcessingConfig": { # A singleton resource of DataStore. It's empty when DataStore is created, which defaults to digital parser. The first call to DataStoreService.UpdateDocumentProcessingConfig method will initialize the config. # Configuration for Document understanding and enrichment. + "chunkingConfig": { # Configuration for chunking config. # Whether chunking mode is enabled. + "layoutBasedChunkingConfig": { # Configuration for the layout based chunking. # Configuration for the layout based chunking. + "chunkSize": 42, # The token size limit for each chunk. Supported values: 100-500 (inclusive). Default value: 500. + "includeAncestorHeadings": True or False, # Whether to include appending different levels of headings to chunks from the middle of the document to prevent context loss. Default value: False. + }, + }, "defaultParsingConfig": { # Related configurations applied to a specific type of document parser. # Configurations for default Document parser. If not specified, we will configure it as default DigitalParsingConfig, and the default parsing config will be applied to all file types for Document parsing. "digitalParsingConfig": { # The digital parsing configurations for documents. # Configurations applied to digital parser. }, + "layoutParsingConfig": { # The layout parsing configurations for documents. # Configurations applied to layout parser. + }, "ocrParsingConfig": { # The OCR parsing configurations for documents. # Configurations applied to OCR parser. Currently it only applies to PDFs. "enhancedDocumentElements": [ # [DEPRECATED] This field is deprecated. To use the additional enhanced document elements processing, please switch to `layout_parsing_config`. "A String", @@ -430,6 +458,8 @@

Method Details

"a_key": { # Related configurations applied to a specific type of document parser. "digitalParsingConfig": { # The digital parsing configurations for documents. # Configurations applied to digital parser. }, + "layoutParsingConfig": { # The layout parsing configurations for documents. # Configurations applied to layout parser. + }, "ocrParsingConfig": { # The OCR parsing configurations for documents. # Configurations applied to OCR parser. Currently it only applies to PDFs. "enhancedDocumentElements": [ # [DEPRECATED] This field is deprecated. To use the additional enhanced document elements processing, please switch to `layout_parsing_config`. "A String", @@ -486,9 +516,17 @@

Method Details

"defaultSchemaId": "A String", # Output only. The id of the default Schema asscociated to this data store. "displayName": "A String", # Required. The data store display name. This field must be a UTF-8 encoded string with a length limit of 128 characters. Otherwise, an INVALID_ARGUMENT error is returned. "documentProcessingConfig": { # A singleton resource of DataStore. It's empty when DataStore is created, which defaults to digital parser. The first call to DataStoreService.UpdateDocumentProcessingConfig method will initialize the config. # Configuration for Document understanding and enrichment. + "chunkingConfig": { # Configuration for chunking config. # Whether chunking mode is enabled. + "layoutBasedChunkingConfig": { # Configuration for the layout based chunking. # Configuration for the layout based chunking. + "chunkSize": 42, # The token size limit for each chunk. Supported values: 100-500 (inclusive). Default value: 500. + "includeAncestorHeadings": True or False, # Whether to include appending different levels of headings to chunks from the middle of the document to prevent context loss. Default value: False. + }, + }, "defaultParsingConfig": { # Related configurations applied to a specific type of document parser. # Configurations for default Document parser. If not specified, we will configure it as default DigitalParsingConfig, and the default parsing config will be applied to all file types for Document parsing. "digitalParsingConfig": { # The digital parsing configurations for documents. # Configurations applied to digital parser. }, + "layoutParsingConfig": { # The layout parsing configurations for documents. # Configurations applied to layout parser. + }, "ocrParsingConfig": { # The OCR parsing configurations for documents. # Configurations applied to OCR parser. Currently it only applies to PDFs. "enhancedDocumentElements": [ # [DEPRECATED] This field is deprecated. To use the additional enhanced document elements processing, please switch to `layout_parsing_config`. "A String", @@ -501,6 +539,8 @@

Method Details

"a_key": { # Related configurations applied to a specific type of document parser. "digitalParsingConfig": { # The digital parsing configurations for documents. # Configurations applied to digital parser. }, + "layoutParsingConfig": { # The layout parsing configurations for documents. # Configurations applied to layout parser. + }, "ocrParsingConfig": { # The OCR parsing configurations for documents. # Configurations applied to OCR parser. Currently it only applies to PDFs. "enhancedDocumentElements": [ # [DEPRECATED] This field is deprecated. To use the additional enhanced document elements processing, please switch to `layout_parsing_config`. "A String", @@ -539,9 +579,17 @@

Method Details

"defaultSchemaId": "A String", # Output only. The id of the default Schema asscociated to this data store. "displayName": "A String", # Required. The data store display name. This field must be a UTF-8 encoded string with a length limit of 128 characters. Otherwise, an INVALID_ARGUMENT error is returned. "documentProcessingConfig": { # A singleton resource of DataStore. It's empty when DataStore is created, which defaults to digital parser. The first call to DataStoreService.UpdateDocumentProcessingConfig method will initialize the config. # Configuration for Document understanding and enrichment. + "chunkingConfig": { # Configuration for chunking config. # Whether chunking mode is enabled. + "layoutBasedChunkingConfig": { # Configuration for the layout based chunking. # Configuration for the layout based chunking. + "chunkSize": 42, # The token size limit for each chunk. Supported values: 100-500 (inclusive). Default value: 500. + "includeAncestorHeadings": True or False, # Whether to include appending different levels of headings to chunks from the middle of the document to prevent context loss. Default value: False. + }, + }, "defaultParsingConfig": { # Related configurations applied to a specific type of document parser. # Configurations for default Document parser. If not specified, we will configure it as default DigitalParsingConfig, and the default parsing config will be applied to all file types for Document parsing. "digitalParsingConfig": { # The digital parsing configurations for documents. # Configurations applied to digital parser. }, + "layoutParsingConfig": { # The layout parsing configurations for documents. # Configurations applied to layout parser. + }, "ocrParsingConfig": { # The OCR parsing configurations for documents. # Configurations applied to OCR parser. Currently it only applies to PDFs. "enhancedDocumentElements": [ # [DEPRECATED] This field is deprecated. To use the additional enhanced document elements processing, please switch to `layout_parsing_config`. "A String", @@ -554,6 +602,8 @@

Method Details

"a_key": { # Related configurations applied to a specific type of document parser. "digitalParsingConfig": { # The digital parsing configurations for documents. # Configurations applied to digital parser. }, + "layoutParsingConfig": { # The layout parsing configurations for documents. # Configurations applied to layout parser. + }, "ocrParsingConfig": { # The OCR parsing configurations for documents. # Configurations applied to OCR parser. Currently it only applies to PDFs. "enhancedDocumentElements": [ # [DEPRECATED] This field is deprecated. To use the additional enhanced document elements processing, please switch to `layout_parsing_config`. "A String", diff --git a/docs/dyn/discoveryengine_v1.projects.locations.dataStores.servingConfigs.html b/docs/dyn/discoveryengine_v1.projects.locations.dataStores.servingConfigs.html index 77ba51ae482..7d339ac90d5 100644 --- a/docs/dyn/discoveryengine_v1.projects.locations.dataStores.servingConfigs.html +++ b/docs/dyn/discoveryengine_v1.projects.locations.dataStores.servingConfigs.html @@ -152,6 +152,7 @@

Method Details

"filter": "A String", # The filter syntax consists of an expression language for constructing a predicate from one or more fields of the documents being filtered. Filter expression is case-sensitive. This will be used to filter search results which may affect the Answer response. If this field is unrecognizable, an `INVALID_ARGUMENT` is returned. Filtering in Vertex AI Search is done by mapping the LHS filter key to a key property defined in the Vertex AI Search backend -- this mapping is defined by the customer in their schema. For example a media customers might have a field 'name' in their schema. In this case the filter would look like this: filter --> name:'ANY("king kong")' For more information about filtering including syntax and filter operators, see [Filter](https://cloud.google.com/generative-ai-app-builder/docs/filter-search-metadata) "maxReturnResults": 42, # Number of search results to return. The default value is 10. "orderBy": "A String", # The order in which documents are returned. Documents can be ordered by a field in an Document object. Leave it unset if ordered by relevance. `order_by` expression is case-sensitive. For more information on ordering, see [Ordering](https://cloud.google.com/retail/docs/filter-and-order#order) If this field is unrecognizable, an `INVALID_ARGUMENT` is returned. + "searchResultMode": "A String", # Specifies the search result mode. If unspecified, the search result mode is based on DataStore.DocumentProcessingConfig.chunking_config: * If DataStore.DocumentProcessingConfig.chunking_config is specified, it defaults to `CHUNKS`. * Otherwise, it defaults to `DOCUMENTS`. See [parse and chunk documents](https://cloud.google.com/generative-ai-app-builder/docs/parse-chunk-documents) }, "searchResultList": { # Search result list. # Search result list. "searchResults": [ # Search results. @@ -188,6 +189,9 @@

Method Details

}, }, "session": "A String", # The session resource name. Not required. When session field is not set, the API is in sessionless mode. We support auto session mode: users can use the wildcard symbol `-` as session ID. A new ID will be automatically generated and assigned. + "userLabels": { # The user labels applied to a resource must meet the following requirements: * Each resource can have multiple labels, up to a maximum of 64. * Each label must be a key-value pair. * Keys have a minimum length of 1 character and a maximum length of 63 characters and cannot be empty. Values can be empty and have a maximum length of 63 characters. * Keys and values can contain only lowercase letters, numeric characters, underscores, and dashes. All characters must use UTF-8 encoding, and international characters are allowed. * The key portion of a label must be unique. However, you can use the same key with multiple resources. * Keys must start with a lowercase letter or international character. See [Google Cloud Document](https://cloud.google.com/resource-manager/docs/creating-managing-labels#requirements) for more details. + "a_key": "A String", + }, "userPseudoId": "A String", # A unique identifier for tracking visitors. For example, this could be implemented with an HTTP cookie, which should be able to uniquely identify a visitor on a single device. This unique identifier should not change if the visitor logs in or out of the website. This field should NOT have a fixed value such as `unknown_visitor`. The field must be a UTF-8 encoded string with a length limit of 128 characters. Otherwise, an `INVALID_ARGUMENT` error is returned. } @@ -486,6 +490,10 @@

Method Details

"branch": "A String", # The branch resource name, such as `projects/*/locations/global/collections/default_collection/dataStores/default_data_store/branches/0`. Use `default_branch` as the branch ID or leave this field empty, to search documents under the default branch. "canonicalFilter": "A String", # The default filter that is applied when a user performs a search without checking any filters on the search page. The filter applied to every search request when quality improvement such as query expansion is needed. In the case a query does not have a sufficient amount of results this filter will be used to determine whether or not to enable the query expansion flow. The original filter will still be used for the query expanded search. This field is strongly recommended to achieve high search quality. For more information about filter syntax, see SearchRequest.filter. "contentSearchSpec": { # A specification for configuring the behavior of content search. # A specification for configuring the behavior of content search. + "chunkSpec": { # Specifies the chunk spec to be returned from the search response. Only available if the SearchRequest.ContentSearchSpec.search_result_mode is set to CHUNKS # Specifies the chunk spec to be returned from the search response. Only available if the SearchRequest.ContentSearchSpec.search_result_mode is set to CHUNKS + "numNextChunks": 42, # The number of next chunks to be returned of the current chunk. The maximum allowed value is 3. If not specified, no next chunks will be returned. + "numPreviousChunks": 42, # The number of previous chunks to be returned of the current chunk. The maximum allowed value is 3. If not specified, no previous chunks will be returned. + }, "extractiveContentSpec": { # A specification for configuring the extractive content in a search response. # If there is no extractive_content_spec provided, there will be no extractive answer in the search response. "maxExtractiveAnswerCount": 42, # The maximum number of extractive answers returned in each search result. An extractive answer is a verbatim answer extracted from the original document, which provides a precise and contextually relevant answer to the search query. If the number of matching answers is less than the `max_extractive_answer_count`, return all of the answers. Otherwise, return the `max_extractive_answer_count`. At most five answers are returned for each SearchResult. "maxExtractiveSegmentCount": 42, # The max number of extractive segments returned in each search result. Only applied if the DataStore is set to DataStore.ContentConfig.CONTENT_REQUIRED or DataStore.solution_types is SOLUTION_TYPE_CHAT. An extractive segment is a text segment extracted from the original document that is relevant to the search query, and, in general, more verbose than an extractive answer. The segment could then be used as input for LLMs to generate summaries and answers. If the number of matching segments is less than `max_extractive_segment_count`, return all of the segments. Otherwise, return the `max_extractive_segment_count`. @@ -493,6 +501,7 @@

Method Details

"numPreviousSegments": 42, # Specifies whether to also include the adjacent from each selected segments. Return at most `num_previous_segments` segments before each selected segments. "returnExtractiveSegmentScore": True or False, # Specifies whether to return the confidence score from the extractive segments in each search result. This feature is available only for new or allowlisted data stores. To allowlist your data store, contact your Customer Engineer. The default value is `false`. }, + "searchResultMode": "A String", # Specifies the search result mode. If unspecified, the search result mode is based on DataStore.DocumentProcessingConfig.chunking_config: * If DataStore.DocumentProcessingConfig.chunking_config is specified, it defaults to `CHUNKS`. * Otherwise, it defaults to `DOCUMENTS`. "snippetSpec": { # A specification for configuring snippets in a search response. # If `snippetSpec` is not specified, snippets are not included in the search response. "maxSnippetCount": 42, # [DEPRECATED] This field is deprecated. To control snippet return, use `return_snippet` field. For backwards compatibility, we will return snippet if max_snippet_count > 0. "referenceOnly": True or False, # [DEPRECATED] This field is deprecated and will have no affect on the snippet. @@ -616,6 +625,34 @@

Method Details

"redirectUri": "A String", # The URI of a customer-defined redirect page. If redirect action is triggered, no search is performed, and only redirect_uri and attribution_token are set in the response. "results": [ # A list of matched documents. The order represents the ranking. { # Represents the search results. + "chunk": { # Chunk captures all raw metadata information of items to be recommended or searched in the chunk mode. # The chunk data in the search response if the SearchRequest.ContentSearchSpec.search_result_mode is set to CHUNKS. + "chunkMetadata": { # Metadata of the current chunk. This field is only populated on SearchService.Search API. # Output only. Metadata of the current chunk. + "nextChunks": [ # The next chunks of the current chunk. The number is controlled by SearchRequest.ContentSearchSpec.ChunkSpec.num_next_chunks. This field is only populated on SearchService.Search API. + # Object with schema name: GoogleCloudDiscoveryengineV1Chunk + ], + "previousChunks": [ # The previous chunks of the current chunk. The number is controlled by SearchRequest.ContentSearchSpec.ChunkSpec.num_previous_chunks. This field is only populated on SearchService.Search API. + # Object with schema name: GoogleCloudDiscoveryengineV1Chunk + ], + }, + "content": "A String", # Content is a string from a document (parsed content). + "derivedStructData": { # Output only. This field is OUTPUT_ONLY. It contains derived data that are not in the original input document. + "a_key": "", # Properties of the object. + }, + "documentMetadata": { # Document metadata contains the information of the document of the current chunk. # Metadata of the document from the current chunk. + "structData": { # Data representation. The structured JSON data for the document. It should conform to the registered Schema or an `INVALID_ARGUMENT` error is thrown. + "a_key": "", # Properties of the object. + }, + "title": "A String", # Title of the document. + "uri": "A String", # Uri of the document. + }, + "id": "A String", # Unique chunk ID of the current chunk. + "name": "A String", # The full resource name of the chunk. Format: `projects/{project}/locations/{location}/collections/{collection}/dataStores/{data_store}/branches/{branch}/documents/{document_id}/chunks/{chunk_id}`. This field must be a UTF-8 encoded string with a length limit of 1024 characters. + "pageSpan": { # Page span of the chunk. # Page span of the chunk. + "pageEnd": 42, # The end page of the chunk. + "pageStart": 42, # The start page of the chunk. + }, + "relevanceScore": 3.14, # Output only. Represents the relevance score based on similarity. Higher score indicates higher chunk relevance. The score is in range [-1.0, 1.0]. Only populated on SearchService.SearchResponse. + }, "document": { # Document captures all raw metadata information of items to be recommended or searched. # The document data snippet in the search response. Only fields that are marked as `retrievable` are populated. "content": { # Unstructured data linked to this document. # The unstructured data linked to this document. Content must be set if this document is under a `CONTENT_REQUIRED` data store. "mimeType": "A String", # The MIME type of the content. Supported types: * `application/pdf` (PDF, only native PDFs are supported for now) * `text/html` (HTML) * `application/vnd.openxmlformats-officedocument.wordprocessingml.document` (DOCX) * `application/vnd.openxmlformats-officedocument.presentationml.presentation` (PPTX) * `text/plain` (TXT) See https://www.iana.org/assignments/media-types/media-types.xhtml. diff --git a/docs/dyn/discoveryengine_v1.projects.locations.userEvents.html b/docs/dyn/discoveryengine_v1.projects.locations.userEvents.html index 36084ab3dc4..18e3964ed10 100644 --- a/docs/dyn/discoveryengine_v1.projects.locations.userEvents.html +++ b/docs/dyn/discoveryengine_v1.projects.locations.userEvents.html @@ -77,6 +77,9 @@

Instance Methods

close()

Close httplib2 connections.

+

+ collect(parent, ets=None, uri=None, userEvent=None, x__xgafv=None)

+

Writes a single user event from the browser. This uses a GET request to due to browser restriction of POST-ing to a third-party domain. This method is used only by the Discovery Engine API JavaScript pixel and Google Tag Manager. Users should not call this method directly.

write(parent, body=None, writeAsync=None, x__xgafv=None)

Writes a single user event.

@@ -86,6 +89,34 @@

Method Details

Close httplib2 connections.
+
+ collect(parent, ets=None, uri=None, userEvent=None, x__xgafv=None) +
Writes a single user event from the browser. This uses a GET request to due to browser restriction of POST-ing to a third-party domain. This method is used only by the Discovery Engine API JavaScript pixel and Google Tag Manager. Users should not call this method directly.
+
+Args:
+  parent: string, Required. The parent DataStore resource name, such as `projects/{project}/locations/{location}/collections/{collection}/dataStores/{data_store}`. (required)
+  ets: string, The event timestamp in milliseconds. This prevents browser caching of otherwise identical get requests. The name is abbreviated to reduce the payload bytes.
+  uri: string, The URL including cgi-parameters but excluding the hash fragment with a length limit of 5,000 characters. This is often more useful than the referer URL, because many browsers only send the domain for third-party requests.
+  userEvent: string, Required. URL encoded UserEvent proto with a length limit of 2,000,000 characters.
+  x__xgafv: string, V1 error format.
+    Allowed values
+      1 - v1 error format
+      2 - v2 error format
+
+Returns:
+  An object of the form:
+
+    { # Message that represents an arbitrary HTTP body. It should only be used for payload formats that can't be represented as JSON, such as raw binary or an HTML page. This message can be used both in streaming and non-streaming API methods in the request as well as the response. It can be used as a top-level request field, which is convenient if one wants to extract parameters from either the URL or HTTP template into the request fields and also want access to the raw HTTP body. Example: message GetResourceRequest { // A unique request id. string request_id = 1; // The raw HTTP body is bound to this field. google.api.HttpBody http_body = 2; } service ResourceService { rpc GetResource(GetResourceRequest) returns (google.api.HttpBody); rpc UpdateResource(google.api.HttpBody) returns (google.protobuf.Empty); } Example with streaming methods: service CaldavService { rpc GetCalendar(stream google.api.HttpBody) returns (stream google.api.HttpBody); rpc UpdateCalendar(stream google.api.HttpBody) returns (stream google.api.HttpBody); } Use of this type only changes how the request and response bodies are handled, all other features will continue to work unchanged.
+  "contentType": "A String", # The HTTP Content-Type header value specifying the content type of the body.
+  "data": "A String", # The HTTP request/response body as raw binary.
+  "extensions": [ # Application specific response metadata. Must be set in the first response for streaming APIs.
+    {
+      "a_key": "", # Properties of the object. Contains field @type with type URL.
+    },
+  ],
+}
+
+
write(parent, body=None, writeAsync=None, x__xgafv=None)
Writes a single user event.
diff --git a/docs/dyn/discoveryengine_v1alpha.projects.locations.collections.dataStores.branches.documents.html b/docs/dyn/discoveryengine_v1alpha.projects.locations.collections.dataStores.branches.documents.html
index 8e87fc7b27a..051f582624d 100644
--- a/docs/dyn/discoveryengine_v1alpha.projects.locations.collections.dataStores.branches.documents.html
+++ b/docs/dyn/discoveryengine_v1alpha.projects.locations.collections.dataStores.branches.documents.html
@@ -303,6 +303,14 @@ 

Method Details

The object takes the form of: { # Request message for Import methods. + "alloyDbSource": { # AlloyDB source import data from. # AlloyDB input source. + "clusterId": "A String", # Required. The AlloyDB cluster to copy the data from with a length limit of 256 characters. + "databaseId": "A String", # Required. The AlloyDB database to copy the data from with a length limit of 256 characters. + "gcsStagingDir": "A String", # Intermediate Cloud Storage directory used for the import with a length limit of 2,000 characters. Can be specified if one wants to have the AlloyDB export to a specific Cloud Storage directory. Ensure that the AlloyDB service account has the necessary Cloud Storage Admin permissions to access the specified Cloud Storage directory. + "locationId": "A String", # Required. The AlloyDB location to copy the data from with a length limit of 256 characters. + "projectId": "A String", # The project ID that the AlloyDB source is in with a length limit of 128 characters. If not specified, inherits the project ID from the parent request. + "tableId": "A String", # Required. The AlloyDB table to copy the data from with a length limit of 256 characters. + }, "autoGenerateIds": True or False, # Whether to automatically generate IDs for the documents if absent. If set to `true`, Document.ids are automatically generated based on the hash of the payload, where IDs may not be consistent during multiple imports. In which case ReconciliationMode.FULL is highly recommended to avoid duplicate contents. If unset or set to `false`, Document.ids have to be specified using id_field, otherwise, documents without IDs fail to be imported. Supported data sources: * GcsSource. GcsSource.data_schema must be `custom` or `csv`. Otherwise, an INVALID_ARGUMENT error is thrown. * BigQuerySource. BigQuerySource.data_schema must be `custom` or `csv`. Otherwise, an INVALID_ARGUMENT error is thrown. * SpannerSource. * CloudSqlSource. * FirestoreSource. * BigtableSource. "bigquerySource": { # BigQuery source import data from. # BigQuery input source. "dataSchema": "A String", # The schema to use when parsing the data from the source. Supported values for user event imports: * `user_event` (default): One UserEvent per row. Supported values for document imports: * `document` (default): One Document format per row. Each document must have a valid Document.id and one of Document.json_data or Document.struct_data. * `custom`: One custom data per row in arbitrary format that conforms to the defined Schema of the data store. This can only be used by the GENERIC Data Store vertical. diff --git a/docs/dyn/discoveryengine_v1alpha.projects.locations.collections.dataStores.controls.html b/docs/dyn/discoveryengine_v1alpha.projects.locations.collections.dataStores.controls.html index be6b18e1f39..3f7d396dcc8 100644 --- a/docs/dyn/discoveryengine_v1alpha.projects.locations.collections.dataStores.controls.html +++ b/docs/dyn/discoveryengine_v1alpha.projects.locations.collections.dataStores.controls.html @@ -106,7 +106,7 @@

Method Details

Creates a Control. By default 1000 controls are allowed for a data store. A request can be submitted to adjust this limit. If the Control to create already exists, an ALREADY_EXISTS error is returned.
 
 Args:
-  parent: string, Required. Full resource name of parent data store. Format: `projects/{project_number}/locations/{location_id}/collections/{collection_id}/dataStores/{data_store_id}` (required)
+  parent: string, Required. Full resource name of parent data store. Format: `projects/{project_number}/locations/{location_id}/collections/{collection_id}/dataStores/{data_store_id}` or `projects/{project_number}/locations/{location_id}/collections/{collection_id}/engines/{engine_id}`. (required)
   body: object, The request body.
     The object takes the form of:
 
@@ -293,7 +293,7 @@ 

Method Details

Lists all Controls by their parent DataStore.
 
 Args:
-  parent: string, Required. The data store resource name. Format: `projects/{project_number}/locations/{location_id}/collections/{collection_id}/dataStores/{data_store_id}` (required)
+  parent: string, Required. The data store resource name. Format: `projects/{project_number}/locations/{location_id}/collections/{collection_id}/dataStores/{data_store_id}` or `projects/{project_number}/locations/{location_id}/collections/{collection_id}/engines/{engine_id}`. (required)
   filter: string, Optional. A filter to apply on the list results. Supported features: * List all the products under the parent branch if filter is unset. Currently this field is unsupported.
   pageSize: integer, Optional. Maximum number of results to return. If unspecified, defaults to 50. Max allowed value is 1000.
   pageToken: string, Optional. A page token, received from a previous `ListControls` call. Provide this to retrieve the subsequent page.
diff --git a/docs/dyn/discoveryengine_v1alpha.projects.locations.collections.dataStores.servingConfigs.html b/docs/dyn/discoveryengine_v1alpha.projects.locations.collections.dataStores.servingConfigs.html
index 7ab0cd7e71f..ace68ffba51 100644
--- a/docs/dyn/discoveryengine_v1alpha.projects.locations.collections.dataStores.servingConfigs.html
+++ b/docs/dyn/discoveryengine_v1alpha.projects.locations.collections.dataStores.servingConfigs.html
@@ -216,6 +216,9 @@ 

Method Details

}, }, "session": "A String", # The session resource name. Not required. When session field is not set, the API is in sessionless mode. We support auto session mode: users can use the wildcard symbol `-` as session ID. A new ID will be automatically generated and assigned. + "userLabels": { # The user labels applied to a resource must meet the following requirements: * Each resource can have multiple labels, up to a maximum of 64. * Each label must be a key-value pair. * Keys have a minimum length of 1 character and a maximum length of 63 characters and cannot be empty. Values can be empty and have a maximum length of 63 characters. * Keys and values can contain only lowercase letters, numeric characters, underscores, and dashes. All characters must use UTF-8 encoding, and international characters are allowed. * The key portion of a label must be unique. However, you can use the same key with multiple resources. * Keys must start with a lowercase letter or international character. See [Google Cloud Document](https://cloud.google.com/resource-manager/docs/creating-managing-labels#requirements) for more details. + "a_key": "A String", + }, "userPseudoId": "A String", # A unique identifier for tracking visitors. For example, this could be implemented with an HTTP cookie, which should be able to uniquely identify a visitor on a single device. This unique identifier should not change if the visitor logs in or out of the website. This field should NOT have a fixed value such as `unknown_visitor`. The field must be a UTF-8 encoded string with a length limit of 128 characters. Otherwise, an `INVALID_ARGUMENT` error is returned. } @@ -399,7 +402,7 @@

Method Details

"numPreviousSegments": 42, # Specifies whether to also include the adjacent from each selected segments. Return at most `num_previous_segments` segments before each selected segments. "returnExtractiveSegmentScore": True or False, # Specifies whether to return the confidence score from the extractive segments in each search result. This feature is available only for new or allowlisted data stores. To allowlist your data store, contact your Customer Engineer. The default value is `false`. }, - "searchResultMode": "A String", # Specifies the search result mode. If unspecified, the search result mode defaults to `DOCUMENTS`. + "searchResultMode": "A String", # Specifies the search result mode. If unspecified, the search result mode is based on DataStore.DocumentProcessingConfig.chunking_config: * If DataStore.DocumentProcessingConfig.chunking_config is specified, it defaults to `CHUNKS`. * Otherwise, it defaults to `DOCUMENTS`. "snippetSpec": { # A specification for configuring snippets in a search response. # If `snippetSpec` is not specified, snippets are not included in the search response. "maxSnippetCount": 42, # [DEPRECATED] This field is deprecated. To control snippet return, use `return_snippet` field. For backwards compatibility, we will return snippet if max_snippet_count > 0. "referenceOnly": True or False, # [DEPRECATED] This field is deprecated and will have no affect on the snippet. @@ -506,7 +509,7 @@

Method Details

"numPreviousSegments": 42, # Specifies whether to also include the adjacent from each selected segments. Return at most `num_previous_segments` segments before each selected segments. "returnExtractiveSegmentScore": True or False, # Specifies whether to return the confidence score from the extractive segments in each search result. This feature is available only for new or allowlisted data stores. To allowlist your data store, contact your Customer Engineer. The default value is `false`. }, - "searchResultMode": "A String", # Specifies the search result mode. If unspecified, the search result mode defaults to `DOCUMENTS`. + "searchResultMode": "A String", # Specifies the search result mode. If unspecified, the search result mode is based on DataStore.DocumentProcessingConfig.chunking_config: * If DataStore.DocumentProcessingConfig.chunking_config is specified, it defaults to `CHUNKS`. * Otherwise, it defaults to `DOCUMENTS`. "snippetSpec": { # A specification for configuring snippets in a search response. # If `snippetSpec` is not specified, snippets are not included in the search response. "maxSnippetCount": 42, # [DEPRECATED] This field is deprecated. To control snippet return, use `return_snippet` field. For backwards compatibility, we will return snippet if max_snippet_count > 0. "referenceOnly": True or False, # [DEPRECATED] This field is deprecated and will have no affect on the snippet. @@ -619,7 +622,7 @@

Method Details

"numPreviousSegments": 42, # Specifies whether to also include the adjacent from each selected segments. Return at most `num_previous_segments` segments before each selected segments. "returnExtractiveSegmentScore": True or False, # Specifies whether to return the confidence score from the extractive segments in each search result. This feature is available only for new or allowlisted data stores. To allowlist your data store, contact your Customer Engineer. The default value is `false`. }, - "searchResultMode": "A String", # Specifies the search result mode. If unspecified, the search result mode defaults to `DOCUMENTS`. + "searchResultMode": "A String", # Specifies the search result mode. If unspecified, the search result mode is based on DataStore.DocumentProcessingConfig.chunking_config: * If DataStore.DocumentProcessingConfig.chunking_config is specified, it defaults to `CHUNKS`. * Otherwise, it defaults to `DOCUMENTS`. "snippetSpec": { # A specification for configuring snippets in a search response. # If `snippetSpec` is not specified, snippets are not included in the search response. "maxSnippetCount": 42, # [DEPRECATED] This field is deprecated. To control snippet return, use `return_snippet` field. For backwards compatibility, we will return snippet if max_snippet_count > 0. "referenceOnly": True or False, # [DEPRECATED] This field is deprecated and will have no affect on the snippet. @@ -715,7 +718,7 @@

Method Details

"numPreviousSegments": 42, # Specifies whether to also include the adjacent from each selected segments. Return at most `num_previous_segments` segments before each selected segments. "returnExtractiveSegmentScore": True or False, # Specifies whether to return the confidence score from the extractive segments in each search result. This feature is available only for new or allowlisted data stores. To allowlist your data store, contact your Customer Engineer. The default value is `false`. }, - "searchResultMode": "A String", # Specifies the search result mode. If unspecified, the search result mode defaults to `DOCUMENTS`. + "searchResultMode": "A String", # Specifies the search result mode. If unspecified, the search result mode is based on DataStore.DocumentProcessingConfig.chunking_config: * If DataStore.DocumentProcessingConfig.chunking_config is specified, it defaults to `CHUNKS`. * Otherwise, it defaults to `DOCUMENTS`. "snippetSpec": { # A specification for configuring snippets in a search response. # If `snippetSpec` is not specified, snippets are not included in the search response. "maxSnippetCount": 42, # [DEPRECATED] This field is deprecated. To control snippet return, use `return_snippet` field. For backwards compatibility, we will return snippet if max_snippet_count > 0. "referenceOnly": True or False, # [DEPRECATED] This field is deprecated and will have no affect on the snippet. @@ -966,7 +969,7 @@

Method Details

"numPreviousSegments": 42, # Specifies whether to also include the adjacent from each selected segments. Return at most `num_previous_segments` segments before each selected segments. "returnExtractiveSegmentScore": True or False, # Specifies whether to return the confidence score from the extractive segments in each search result. This feature is available only for new or allowlisted data stores. To allowlist your data store, contact your Customer Engineer. The default value is `false`. }, - "searchResultMode": "A String", # Specifies the search result mode. If unspecified, the search result mode defaults to `DOCUMENTS`. + "searchResultMode": "A String", # Specifies the search result mode. If unspecified, the search result mode is based on DataStore.DocumentProcessingConfig.chunking_config: * If DataStore.DocumentProcessingConfig.chunking_config is specified, it defaults to `CHUNKS`. * Otherwise, it defaults to `DOCUMENTS`. "snippetSpec": { # A specification for configuring snippets in a search response. # If `snippetSpec` is not specified, snippets are not included in the search response. "maxSnippetCount": 42, # [DEPRECATED] This field is deprecated. To control snippet return, use `return_snippet` field. For backwards compatibility, we will return snippet if max_snippet_count > 0. "referenceOnly": True or False, # [DEPRECATED] This field is deprecated and will have no affect on the snippet. diff --git a/docs/dyn/discoveryengine_v1alpha.projects.locations.collections.engines.controls.html b/docs/dyn/discoveryengine_v1alpha.projects.locations.collections.engines.controls.html index 29fb81a6436..be2f33aaaff 100644 --- a/docs/dyn/discoveryengine_v1alpha.projects.locations.collections.engines.controls.html +++ b/docs/dyn/discoveryengine_v1alpha.projects.locations.collections.engines.controls.html @@ -106,7 +106,7 @@

Method Details

Creates a Control. By default 1000 controls are allowed for a data store. A request can be submitted to adjust this limit. If the Control to create already exists, an ALREADY_EXISTS error is returned.
 
 Args:
-  parent: string, Required. Full resource name of parent data store. Format: `projects/{project_number}/locations/{location_id}/collections/{collection_id}/dataStores/{data_store_id}` (required)
+  parent: string, Required. Full resource name of parent data store. Format: `projects/{project_number}/locations/{location_id}/collections/{collection_id}/dataStores/{data_store_id}` or `projects/{project_number}/locations/{location_id}/collections/{collection_id}/engines/{engine_id}`. (required)
   body: object, The request body.
     The object takes the form of:
 
@@ -293,7 +293,7 @@ 

Method Details

Lists all Controls by their parent DataStore.
 
 Args:
-  parent: string, Required. The data store resource name. Format: `projects/{project_number}/locations/{location_id}/collections/{collection_id}/dataStores/{data_store_id}` (required)
+  parent: string, Required. The data store resource name. Format: `projects/{project_number}/locations/{location_id}/collections/{collection_id}/dataStores/{data_store_id}` or `projects/{project_number}/locations/{location_id}/collections/{collection_id}/engines/{engine_id}`. (required)
   filter: string, Optional. A filter to apply on the list results. Supported features: * List all the products under the parent branch if filter is unset. Currently this field is unsupported.
   pageSize: integer, Optional. Maximum number of results to return. If unspecified, defaults to 50. Max allowed value is 1000.
   pageToken: string, Optional. A page token, received from a previous `ListControls` call. Provide this to retrieve the subsequent page.
diff --git a/docs/dyn/discoveryengine_v1alpha.projects.locations.collections.engines.servingConfigs.html b/docs/dyn/discoveryengine_v1alpha.projects.locations.collections.engines.servingConfigs.html
index 2a47462ccd9..b84eebb09d1 100644
--- a/docs/dyn/discoveryengine_v1alpha.projects.locations.collections.engines.servingConfigs.html
+++ b/docs/dyn/discoveryengine_v1alpha.projects.locations.collections.engines.servingConfigs.html
@@ -216,6 +216,9 @@ 

Method Details

}, }, "session": "A String", # The session resource name. Not required. When session field is not set, the API is in sessionless mode. We support auto session mode: users can use the wildcard symbol `-` as session ID. A new ID will be automatically generated and assigned. + "userLabels": { # The user labels applied to a resource must meet the following requirements: * Each resource can have multiple labels, up to a maximum of 64. * Each label must be a key-value pair. * Keys have a minimum length of 1 character and a maximum length of 63 characters and cannot be empty. Values can be empty and have a maximum length of 63 characters. * Keys and values can contain only lowercase letters, numeric characters, underscores, and dashes. All characters must use UTF-8 encoding, and international characters are allowed. * The key portion of a label must be unique. However, you can use the same key with multiple resources. * Keys must start with a lowercase letter or international character. See [Google Cloud Document](https://cloud.google.com/resource-manager/docs/creating-managing-labels#requirements) for more details. + "a_key": "A String", + }, "userPseudoId": "A String", # A unique identifier for tracking visitors. For example, this could be implemented with an HTTP cookie, which should be able to uniquely identify a visitor on a single device. This unique identifier should not change if the visitor logs in or out of the website. This field should NOT have a fixed value such as `unknown_visitor`. The field must be a UTF-8 encoded string with a length limit of 128 characters. Otherwise, an `INVALID_ARGUMENT` error is returned. } @@ -399,7 +402,7 @@

Method Details

"numPreviousSegments": 42, # Specifies whether to also include the adjacent from each selected segments. Return at most `num_previous_segments` segments before each selected segments. "returnExtractiveSegmentScore": True or False, # Specifies whether to return the confidence score from the extractive segments in each search result. This feature is available only for new or allowlisted data stores. To allowlist your data store, contact your Customer Engineer. The default value is `false`. }, - "searchResultMode": "A String", # Specifies the search result mode. If unspecified, the search result mode defaults to `DOCUMENTS`. + "searchResultMode": "A String", # Specifies the search result mode. If unspecified, the search result mode is based on DataStore.DocumentProcessingConfig.chunking_config: * If DataStore.DocumentProcessingConfig.chunking_config is specified, it defaults to `CHUNKS`. * Otherwise, it defaults to `DOCUMENTS`. "snippetSpec": { # A specification for configuring snippets in a search response. # If `snippetSpec` is not specified, snippets are not included in the search response. "maxSnippetCount": 42, # [DEPRECATED] This field is deprecated. To control snippet return, use `return_snippet` field. For backwards compatibility, we will return snippet if max_snippet_count > 0. "referenceOnly": True or False, # [DEPRECATED] This field is deprecated and will have no affect on the snippet. @@ -506,7 +509,7 @@

Method Details

"numPreviousSegments": 42, # Specifies whether to also include the adjacent from each selected segments. Return at most `num_previous_segments` segments before each selected segments. "returnExtractiveSegmentScore": True or False, # Specifies whether to return the confidence score from the extractive segments in each search result. This feature is available only for new or allowlisted data stores. To allowlist your data store, contact your Customer Engineer. The default value is `false`. }, - "searchResultMode": "A String", # Specifies the search result mode. If unspecified, the search result mode defaults to `DOCUMENTS`. + "searchResultMode": "A String", # Specifies the search result mode. If unspecified, the search result mode is based on DataStore.DocumentProcessingConfig.chunking_config: * If DataStore.DocumentProcessingConfig.chunking_config is specified, it defaults to `CHUNKS`. * Otherwise, it defaults to `DOCUMENTS`. "snippetSpec": { # A specification for configuring snippets in a search response. # If `snippetSpec` is not specified, snippets are not included in the search response. "maxSnippetCount": 42, # [DEPRECATED] This field is deprecated. To control snippet return, use `return_snippet` field. For backwards compatibility, we will return snippet if max_snippet_count > 0. "referenceOnly": True or False, # [DEPRECATED] This field is deprecated and will have no affect on the snippet. @@ -619,7 +622,7 @@

Method Details

"numPreviousSegments": 42, # Specifies whether to also include the adjacent from each selected segments. Return at most `num_previous_segments` segments before each selected segments. "returnExtractiveSegmentScore": True or False, # Specifies whether to return the confidence score from the extractive segments in each search result. This feature is available only for new or allowlisted data stores. To allowlist your data store, contact your Customer Engineer. The default value is `false`. }, - "searchResultMode": "A String", # Specifies the search result mode. If unspecified, the search result mode defaults to `DOCUMENTS`. + "searchResultMode": "A String", # Specifies the search result mode. If unspecified, the search result mode is based on DataStore.DocumentProcessingConfig.chunking_config: * If DataStore.DocumentProcessingConfig.chunking_config is specified, it defaults to `CHUNKS`. * Otherwise, it defaults to `DOCUMENTS`. "snippetSpec": { # A specification for configuring snippets in a search response. # If `snippetSpec` is not specified, snippets are not included in the search response. "maxSnippetCount": 42, # [DEPRECATED] This field is deprecated. To control snippet return, use `return_snippet` field. For backwards compatibility, we will return snippet if max_snippet_count > 0. "referenceOnly": True or False, # [DEPRECATED] This field is deprecated and will have no affect on the snippet. @@ -715,7 +718,7 @@

Method Details

"numPreviousSegments": 42, # Specifies whether to also include the adjacent from each selected segments. Return at most `num_previous_segments` segments before each selected segments. "returnExtractiveSegmentScore": True or False, # Specifies whether to return the confidence score from the extractive segments in each search result. This feature is available only for new or allowlisted data stores. To allowlist your data store, contact your Customer Engineer. The default value is `false`. }, - "searchResultMode": "A String", # Specifies the search result mode. If unspecified, the search result mode defaults to `DOCUMENTS`. + "searchResultMode": "A String", # Specifies the search result mode. If unspecified, the search result mode is based on DataStore.DocumentProcessingConfig.chunking_config: * If DataStore.DocumentProcessingConfig.chunking_config is specified, it defaults to `CHUNKS`. * Otherwise, it defaults to `DOCUMENTS`. "snippetSpec": { # A specification for configuring snippets in a search response. # If `snippetSpec` is not specified, snippets are not included in the search response. "maxSnippetCount": 42, # [DEPRECATED] This field is deprecated. To control snippet return, use `return_snippet` field. For backwards compatibility, we will return snippet if max_snippet_count > 0. "referenceOnly": True or False, # [DEPRECATED] This field is deprecated and will have no affect on the snippet. @@ -966,7 +969,7 @@

Method Details

"numPreviousSegments": 42, # Specifies whether to also include the adjacent from each selected segments. Return at most `num_previous_segments` segments before each selected segments. "returnExtractiveSegmentScore": True or False, # Specifies whether to return the confidence score from the extractive segments in each search result. This feature is available only for new or allowlisted data stores. To allowlist your data store, contact your Customer Engineer. The default value is `false`. }, - "searchResultMode": "A String", # Specifies the search result mode. If unspecified, the search result mode defaults to `DOCUMENTS`. + "searchResultMode": "A String", # Specifies the search result mode. If unspecified, the search result mode is based on DataStore.DocumentProcessingConfig.chunking_config: * If DataStore.DocumentProcessingConfig.chunking_config is specified, it defaults to `CHUNKS`. * Otherwise, it defaults to `DOCUMENTS`. "snippetSpec": { # A specification for configuring snippets in a search response. # If `snippetSpec` is not specified, snippets are not included in the search response. "maxSnippetCount": 42, # [DEPRECATED] This field is deprecated. To control snippet return, use `return_snippet` field. For backwards compatibility, we will return snippet if max_snippet_count > 0. "referenceOnly": True or False, # [DEPRECATED] This field is deprecated and will have no affect on the snippet. diff --git a/docs/dyn/discoveryengine_v1alpha.projects.locations.dataStores.branches.documents.html b/docs/dyn/discoveryengine_v1alpha.projects.locations.dataStores.branches.documents.html index d8e4a7c8f1a..dbd1a3e0611 100644 --- a/docs/dyn/discoveryengine_v1alpha.projects.locations.dataStores.branches.documents.html +++ b/docs/dyn/discoveryengine_v1alpha.projects.locations.dataStores.branches.documents.html @@ -303,6 +303,14 @@

Method Details

The object takes the form of: { # Request message for Import methods. + "alloyDbSource": { # AlloyDB source import data from. # AlloyDB input source. + "clusterId": "A String", # Required. The AlloyDB cluster to copy the data from with a length limit of 256 characters. + "databaseId": "A String", # Required. The AlloyDB database to copy the data from with a length limit of 256 characters. + "gcsStagingDir": "A String", # Intermediate Cloud Storage directory used for the import with a length limit of 2,000 characters. Can be specified if one wants to have the AlloyDB export to a specific Cloud Storage directory. Ensure that the AlloyDB service account has the necessary Cloud Storage Admin permissions to access the specified Cloud Storage directory. + "locationId": "A String", # Required. The AlloyDB location to copy the data from with a length limit of 256 characters. + "projectId": "A String", # The project ID that the AlloyDB source is in with a length limit of 128 characters. If not specified, inherits the project ID from the parent request. + "tableId": "A String", # Required. The AlloyDB table to copy the data from with a length limit of 256 characters. + }, "autoGenerateIds": True or False, # Whether to automatically generate IDs for the documents if absent. If set to `true`, Document.ids are automatically generated based on the hash of the payload, where IDs may not be consistent during multiple imports. In which case ReconciliationMode.FULL is highly recommended to avoid duplicate contents. If unset or set to `false`, Document.ids have to be specified using id_field, otherwise, documents without IDs fail to be imported. Supported data sources: * GcsSource. GcsSource.data_schema must be `custom` or `csv`. Otherwise, an INVALID_ARGUMENT error is thrown. * BigQuerySource. BigQuerySource.data_schema must be `custom` or `csv`. Otherwise, an INVALID_ARGUMENT error is thrown. * SpannerSource. * CloudSqlSource. * FirestoreSource. * BigtableSource. "bigquerySource": { # BigQuery source import data from. # BigQuery input source. "dataSchema": "A String", # The schema to use when parsing the data from the source. Supported values for user event imports: * `user_event` (default): One UserEvent per row. Supported values for document imports: * `document` (default): One Document format per row. Each document must have a valid Document.id and one of Document.json_data or Document.struct_data. * `custom`: One custom data per row in arbitrary format that conforms to the defined Schema of the data store. This can only be used by the GENERIC Data Store vertical. diff --git a/docs/dyn/discoveryengine_v1alpha.projects.locations.dataStores.controls.html b/docs/dyn/discoveryengine_v1alpha.projects.locations.dataStores.controls.html index a86e1e8d402..9869f6245e4 100644 --- a/docs/dyn/discoveryengine_v1alpha.projects.locations.dataStores.controls.html +++ b/docs/dyn/discoveryengine_v1alpha.projects.locations.dataStores.controls.html @@ -106,7 +106,7 @@

Method Details

Creates a Control. By default 1000 controls are allowed for a data store. A request can be submitted to adjust this limit. If the Control to create already exists, an ALREADY_EXISTS error is returned.
 
 Args:
-  parent: string, Required. Full resource name of parent data store. Format: `projects/{project_number}/locations/{location_id}/collections/{collection_id}/dataStores/{data_store_id}` (required)
+  parent: string, Required. Full resource name of parent data store. Format: `projects/{project_number}/locations/{location_id}/collections/{collection_id}/dataStores/{data_store_id}` or `projects/{project_number}/locations/{location_id}/collections/{collection_id}/engines/{engine_id}`. (required)
   body: object, The request body.
     The object takes the form of:
 
@@ -293,7 +293,7 @@ 

Method Details

Lists all Controls by their parent DataStore.
 
 Args:
-  parent: string, Required. The data store resource name. Format: `projects/{project_number}/locations/{location_id}/collections/{collection_id}/dataStores/{data_store_id}` (required)
+  parent: string, Required. The data store resource name. Format: `projects/{project_number}/locations/{location_id}/collections/{collection_id}/dataStores/{data_store_id}` or `projects/{project_number}/locations/{location_id}/collections/{collection_id}/engines/{engine_id}`. (required)
   filter: string, Optional. A filter to apply on the list results. Supported features: * List all the products under the parent branch if filter is unset. Currently this field is unsupported.
   pageSize: integer, Optional. Maximum number of results to return. If unspecified, defaults to 50. Max allowed value is 1000.
   pageToken: string, Optional. A page token, received from a previous `ListControls` call. Provide this to retrieve the subsequent page.
diff --git a/docs/dyn/discoveryengine_v1alpha.projects.locations.dataStores.servingConfigs.html b/docs/dyn/discoveryengine_v1alpha.projects.locations.dataStores.servingConfigs.html
index 114b5beff32..b7dadea9b77 100644
--- a/docs/dyn/discoveryengine_v1alpha.projects.locations.dataStores.servingConfigs.html
+++ b/docs/dyn/discoveryengine_v1alpha.projects.locations.dataStores.servingConfigs.html
@@ -216,6 +216,9 @@ 

Method Details

}, }, "session": "A String", # The session resource name. Not required. When session field is not set, the API is in sessionless mode. We support auto session mode: users can use the wildcard symbol `-` as session ID. A new ID will be automatically generated and assigned. + "userLabels": { # The user labels applied to a resource must meet the following requirements: * Each resource can have multiple labels, up to a maximum of 64. * Each label must be a key-value pair. * Keys have a minimum length of 1 character and a maximum length of 63 characters and cannot be empty. Values can be empty and have a maximum length of 63 characters. * Keys and values can contain only lowercase letters, numeric characters, underscores, and dashes. All characters must use UTF-8 encoding, and international characters are allowed. * The key portion of a label must be unique. However, you can use the same key with multiple resources. * Keys must start with a lowercase letter or international character. See [Google Cloud Document](https://cloud.google.com/resource-manager/docs/creating-managing-labels#requirements) for more details. + "a_key": "A String", + }, "userPseudoId": "A String", # A unique identifier for tracking visitors. For example, this could be implemented with an HTTP cookie, which should be able to uniquely identify a visitor on a single device. This unique identifier should not change if the visitor logs in or out of the website. This field should NOT have a fixed value such as `unknown_visitor`. The field must be a UTF-8 encoded string with a length limit of 128 characters. Otherwise, an `INVALID_ARGUMENT` error is returned. } @@ -399,7 +402,7 @@

Method Details

"numPreviousSegments": 42, # Specifies whether to also include the adjacent from each selected segments. Return at most `num_previous_segments` segments before each selected segments. "returnExtractiveSegmentScore": True or False, # Specifies whether to return the confidence score from the extractive segments in each search result. This feature is available only for new or allowlisted data stores. To allowlist your data store, contact your Customer Engineer. The default value is `false`. }, - "searchResultMode": "A String", # Specifies the search result mode. If unspecified, the search result mode defaults to `DOCUMENTS`. + "searchResultMode": "A String", # Specifies the search result mode. If unspecified, the search result mode is based on DataStore.DocumentProcessingConfig.chunking_config: * If DataStore.DocumentProcessingConfig.chunking_config is specified, it defaults to `CHUNKS`. * Otherwise, it defaults to `DOCUMENTS`. "snippetSpec": { # A specification for configuring snippets in a search response. # If `snippetSpec` is not specified, snippets are not included in the search response. "maxSnippetCount": 42, # [DEPRECATED] This field is deprecated. To control snippet return, use `return_snippet` field. For backwards compatibility, we will return snippet if max_snippet_count > 0. "referenceOnly": True or False, # [DEPRECATED] This field is deprecated and will have no affect on the snippet. @@ -506,7 +509,7 @@

Method Details

"numPreviousSegments": 42, # Specifies whether to also include the adjacent from each selected segments. Return at most `num_previous_segments` segments before each selected segments. "returnExtractiveSegmentScore": True or False, # Specifies whether to return the confidence score from the extractive segments in each search result. This feature is available only for new or allowlisted data stores. To allowlist your data store, contact your Customer Engineer. The default value is `false`. }, - "searchResultMode": "A String", # Specifies the search result mode. If unspecified, the search result mode defaults to `DOCUMENTS`. + "searchResultMode": "A String", # Specifies the search result mode. If unspecified, the search result mode is based on DataStore.DocumentProcessingConfig.chunking_config: * If DataStore.DocumentProcessingConfig.chunking_config is specified, it defaults to `CHUNKS`. * Otherwise, it defaults to `DOCUMENTS`. "snippetSpec": { # A specification for configuring snippets in a search response. # If `snippetSpec` is not specified, snippets are not included in the search response. "maxSnippetCount": 42, # [DEPRECATED] This field is deprecated. To control snippet return, use `return_snippet` field. For backwards compatibility, we will return snippet if max_snippet_count > 0. "referenceOnly": True or False, # [DEPRECATED] This field is deprecated and will have no affect on the snippet. @@ -619,7 +622,7 @@

Method Details

"numPreviousSegments": 42, # Specifies whether to also include the adjacent from each selected segments. Return at most `num_previous_segments` segments before each selected segments. "returnExtractiveSegmentScore": True or False, # Specifies whether to return the confidence score from the extractive segments in each search result. This feature is available only for new or allowlisted data stores. To allowlist your data store, contact your Customer Engineer. The default value is `false`. }, - "searchResultMode": "A String", # Specifies the search result mode. If unspecified, the search result mode defaults to `DOCUMENTS`. + "searchResultMode": "A String", # Specifies the search result mode. If unspecified, the search result mode is based on DataStore.DocumentProcessingConfig.chunking_config: * If DataStore.DocumentProcessingConfig.chunking_config is specified, it defaults to `CHUNKS`. * Otherwise, it defaults to `DOCUMENTS`. "snippetSpec": { # A specification for configuring snippets in a search response. # If `snippetSpec` is not specified, snippets are not included in the search response. "maxSnippetCount": 42, # [DEPRECATED] This field is deprecated. To control snippet return, use `return_snippet` field. For backwards compatibility, we will return snippet if max_snippet_count > 0. "referenceOnly": True or False, # [DEPRECATED] This field is deprecated and will have no affect on the snippet. @@ -715,7 +718,7 @@

Method Details

"numPreviousSegments": 42, # Specifies whether to also include the adjacent from each selected segments. Return at most `num_previous_segments` segments before each selected segments. "returnExtractiveSegmentScore": True or False, # Specifies whether to return the confidence score from the extractive segments in each search result. This feature is available only for new or allowlisted data stores. To allowlist your data store, contact your Customer Engineer. The default value is `false`. }, - "searchResultMode": "A String", # Specifies the search result mode. If unspecified, the search result mode defaults to `DOCUMENTS`. + "searchResultMode": "A String", # Specifies the search result mode. If unspecified, the search result mode is based on DataStore.DocumentProcessingConfig.chunking_config: * If DataStore.DocumentProcessingConfig.chunking_config is specified, it defaults to `CHUNKS`. * Otherwise, it defaults to `DOCUMENTS`. "snippetSpec": { # A specification for configuring snippets in a search response. # If `snippetSpec` is not specified, snippets are not included in the search response. "maxSnippetCount": 42, # [DEPRECATED] This field is deprecated. To control snippet return, use `return_snippet` field. For backwards compatibility, we will return snippet if max_snippet_count > 0. "referenceOnly": True or False, # [DEPRECATED] This field is deprecated and will have no affect on the snippet. @@ -966,7 +969,7 @@

Method Details

"numPreviousSegments": 42, # Specifies whether to also include the adjacent from each selected segments. Return at most `num_previous_segments` segments before each selected segments. "returnExtractiveSegmentScore": True or False, # Specifies whether to return the confidence score from the extractive segments in each search result. This feature is available only for new or allowlisted data stores. To allowlist your data store, contact your Customer Engineer. The default value is `false`. }, - "searchResultMode": "A String", # Specifies the search result mode. If unspecified, the search result mode defaults to `DOCUMENTS`. + "searchResultMode": "A String", # Specifies the search result mode. If unspecified, the search result mode is based on DataStore.DocumentProcessingConfig.chunking_config: * If DataStore.DocumentProcessingConfig.chunking_config is specified, it defaults to `CHUNKS`. * Otherwise, it defaults to `DOCUMENTS`. "snippetSpec": { # A specification for configuring snippets in a search response. # If `snippetSpec` is not specified, snippets are not included in the search response. "maxSnippetCount": 42, # [DEPRECATED] This field is deprecated. To control snippet return, use `return_snippet` field. For backwards compatibility, we will return snippet if max_snippet_count > 0. "referenceOnly": True or False, # [DEPRECATED] This field is deprecated and will have no affect on the snippet. diff --git a/docs/dyn/discoveryengine_v1alpha.projects.locations.html b/docs/dyn/discoveryengine_v1alpha.projects.locations.html index 2d583aa8813..7631051a91a 100644 --- a/docs/dyn/discoveryengine_v1alpha.projects.locations.html +++ b/docs/dyn/discoveryengine_v1alpha.projects.locations.html @@ -104,6 +104,11 @@

Instance Methods

Returns the rankingConfigs Resource.

+

+ requirements() +

+

Returns the requirements Resource.

+

sampleQuerySets()

diff --git a/docs/dyn/discoveryengine_v1alpha.projects.locations.requirements.html b/docs/dyn/discoveryengine_v1alpha.projects.locations.requirements.html new file mode 100644 index 00000000000..4b8689f1062 --- /dev/null +++ b/docs/dyn/discoveryengine_v1alpha.projects.locations.requirements.html @@ -0,0 +1,219 @@ + + + +

Discovery Engine API . projects . locations . requirements

+

Instance Methods

+

+ checkRequirement(location, body=None, x__xgafv=None)

+

Check a particular requirement.

+

+ close()

+

Close httplib2 connections.

+

Method Details

+
+ checkRequirement(location, body=None, x__xgafv=None) +
Check a particular requirement.
+
+Args:
+  location: string, Required. Full resource name of the location. Format `projects/{project_number_or_id}/locations/{location}` (required)
+  body: object, The request body.
+    The object takes the form of:
+
+{ # Request for CheckRequirement method.
+  "requirementType": "A String", # A Requirement.type specifying the requirement to check.
+  "resources": [ # The resources to be checked for this requirement.
+    { # An object representing a resource that can be used for monitoring, logging, billing, or other purposes. Examples include virtual machine instances, databases, and storage devices such as disks. The `type` field identifies a MonitoredResourceDescriptor object that describes the resource's schema. Information in the `labels` field identifies the actual resource and its attributes according to the schema. For example, a particular Compute Engine VM instance could be represented by the following object, because the MonitoredResourceDescriptor for `"gce_instance"` has labels `"project_id"`, `"instance_id"` and `"zone"`: { "type": "gce_instance", "labels": { "project_id": "my-project", "instance_id": "12345678901234", "zone": "us-central1-a" }}
+      "labels": { # Required. Values for all of the labels listed in the associated monitored resource descriptor. For example, Compute Engine VM instances use the labels `"project_id"`, `"instance_id"`, and `"zone"`.
+        "a_key": "A String",
+      },
+      "type": "A String", # Required. The monitored resource type. This field must match the `type` field of a MonitoredResourceDescriptor object. For example, the type of a Compute Engine VM instance is `gce_instance`. Some descriptors include the service name in the type; for example, the type of a Datastream stream is `datastream.googleapis.com/Stream`.
+    },
+  ],
+}
+
+  x__xgafv: string, V1 error format.
+    Allowed values
+      1 - v1 error format
+      2 - v2 error format
+
+Returns:
+  An object of the form:
+
+    { # Response for CheckRequirement method.
+  "metricResults": [ # Metric results.
+    { # Metric result. The metric are in the requirement_condition.
+      "metricType": "A String", # Type identifier of the metric corresponding to this query result.
+      "name": "A String", # This metric query name is mapping to variables in the requirement_condition.
+      "timestamp": "A String", # Time corresponding to when this metric value was calculated.
+      "unit": "A String", # The unit in which this metric is reported. Follows [The Unified Code for Units of Measure](https://unitsofmeasure.org/ucum.html) standard.
+      "value": { # A single strongly-typed value. # Value of the metric query.
+        "boolValue": True or False, # A Boolean value: `true` or `false`.
+        "distributionValue": { # `Distribution` contains summary statistics for a population of values. It optionally contains a histogram representing the distribution of those values across a set of buckets. The summary statistics are the count, mean, sum of the squared deviation from the mean, the minimum, and the maximum of the set of population of values. The histogram is based on a sequence of buckets and gives a count of values that fall into each bucket. The boundaries of the buckets are given either explicitly or by formulas for buckets of fixed or exponentially increasing widths. Although it is not forbidden, it is generally a bad idea to include non-finite values (infinities or NaNs) in the population of values, as this will render the `mean` and `sum_of_squared_deviation` fields meaningless. # A distribution value.
+          "bucketCounts": [ # The number of values in each bucket of the histogram, as described in `bucket_options`. If the distribution does not have a histogram, then omit this field. If there is a histogram, then the sum of the values in `bucket_counts` must equal the value in the `count` field of the distribution. If present, `bucket_counts` should contain N values, where N is the number of buckets specified in `bucket_options`. If you supply fewer than N values, the remaining values are assumed to be 0. The order of the values in `bucket_counts` follows the bucket numbering schemes described for the three bucket types. The first value must be the count for the underflow bucket (number 0). The next N-2 values are the counts for the finite buckets (number 1 through N-2). The N'th value in `bucket_counts` is the count for the overflow bucket (number N-1).
+            "A String",
+          ],
+          "bucketOptions": { # `BucketOptions` describes the bucket boundaries used to create a histogram for the distribution. The buckets can be in a linear sequence, an exponential sequence, or each bucket can be specified explicitly. `BucketOptions` does not include the number of values in each bucket. A bucket has an inclusive lower bound and exclusive upper bound for the values that are counted for that bucket. The upper bound of a bucket must be strictly greater than the lower bound. The sequence of N buckets for a distribution consists of an underflow bucket (number 0), zero or more finite buckets (number 1 through N - 2) and an overflow bucket (number N - 1). The buckets are contiguous: the lower bound of bucket i (i > 0) is the same as the upper bound of bucket i - 1. The buckets span the whole range of finite values: lower bound of the underflow bucket is -infinity and the upper bound of the overflow bucket is +infinity. The finite buckets are so-called because both bounds are finite. # Defines the histogram bucket boundaries. If the distribution does not contain a histogram, then omit this field.
+            "explicitBuckets": { # Specifies a set of buckets with arbitrary widths. There are `size(bounds) + 1` (= N) buckets. Bucket `i` has the following boundaries: Upper bound (0 <= i < N-1): bounds[i] Lower bound (1 <= i < N); bounds[i - 1] The `bounds` field must contain at least one element. If `bounds` has only one element, then there are no finite buckets, and that single element is the common boundary of the overflow and underflow buckets. # The explicit buckets.
+              "bounds": [ # The values must be monotonically increasing.
+                3.14,
+              ],
+            },
+            "exponentialBuckets": { # Specifies an exponential sequence of buckets that have a width that is proportional to the value of the lower bound. Each bucket represents a constant relative uncertainty on a specific value in the bucket. There are `num_finite_buckets + 2` (= N) buckets. Bucket `i` has the following boundaries: Upper bound (0 <= i < N-1): scale * (growth_factor ^ i). Lower bound (1 <= i < N): scale * (growth_factor ^ (i - 1)). # The exponential buckets.
+              "growthFactor": 3.14, # Must be greater than 1.
+              "numFiniteBuckets": 42, # Must be greater than 0.
+              "scale": 3.14, # Must be greater than 0.
+            },
+            "linearBuckets": { # Specifies a linear sequence of buckets that all have the same width (except overflow and underflow). Each bucket represents a constant absolute uncertainty on the specific value in the bucket. There are `num_finite_buckets + 2` (= N) buckets. Bucket `i` has the following boundaries: Upper bound (0 <= i < N-1): offset + (width * i). Lower bound (1 <= i < N): offset + (width * (i - 1)). # The linear bucket.
+              "numFiniteBuckets": 42, # Must be greater than 0.
+              "offset": 3.14, # Lower bound of the first bucket.
+              "width": 3.14, # Must be greater than 0.
+            },
+          },
+          "count": "A String", # The number of values in the population. Must be non-negative. This value must equal the sum of the values in `bucket_counts` if a histogram is provided.
+          "exemplars": [ # Must be in increasing order of `value` field.
+            { # Exemplars are example points that may be used to annotate aggregated distribution values. They are metadata that gives information about a particular value added to a Distribution bucket, such as a trace ID that was active when a value was added. They may contain further information, such as a example values and timestamps, origin, etc.
+              "attachments": [ # Contextual information about the example value. Examples are: Trace: type.googleapis.com/google.monitoring.v3.SpanContext Literal string: type.googleapis.com/google.protobuf.StringValue Labels dropped during aggregation: type.googleapis.com/google.monitoring.v3.DroppedLabels There may be only a single attachment of any given message type in a single exemplar, and this is enforced by the system.
+                {
+                  "a_key": "", # Properties of the object. Contains field @type with type URL.
+                },
+              ],
+              "timestamp": "A String", # The observation (sampling) time of the above value.
+              "value": 3.14, # Value of the exemplar point. This value determines to which bucket the exemplar belongs.
+            },
+          ],
+          "mean": 3.14, # The arithmetic mean of the values in the population. If `count` is zero then this field must be zero.
+          "range": { # The range of the population values. # If specified, contains the range of the population values. The field must not be present if the `count` is zero.
+            "max": 3.14, # The maximum of the population values.
+            "min": 3.14, # The minimum of the population values.
+          },
+          "sumOfSquaredDeviation": 3.14, # The sum of squared deviations from the mean of the values in the population. For values x_i this is: Sum[i=1..n]((x_i - mean)^2) Knuth, "The Art of Computer Programming", Vol. 2, page 232, 3rd edition describes Welford's method for accumulating this sum in one pass. If `count` is zero then this field must be zero.
+        },
+        "doubleValue": 3.14, # A 64-bit double-precision floating-point number. Its magnitude is approximately ±10±300 and it has 16 significant digits of precision.
+        "int64Value": "A String", # A 64-bit integer. Its range is approximately ±9.2x1018.
+        "stringValue": "A String", # A variable-length string value.
+      },
+    },
+  ],
+  "oldestMetricTimestamp": "A String", # Timestamp of the oldest calculated metric (i.e. the most stale metric). Indicates that the `requirement_result` may not accurately reflect any Event and Product Catalog updates performed after this time.
+  "requirement": { # A data requirement. # Requirement definition.
+    "condition": { # Represents a textual expression in the Common Expression Language (CEL) syntax. CEL is a C-like expression language. The syntax and semantics of CEL are documented at https://github.com/google/cel-spec. Example (Comparison): title: "Summary size limit" description: "Determines if a summary is less than 100 chars" expression: "document.summary.size() < 100" Example (Equality): title: "Requestor is owner" description: "Determines if requestor is the document owner" expression: "document.owner == request.auth.claims.email" Example (Logic): title: "Public documents" description: "Determine whether the document should be publicly visible" expression: "document.type != 'private' && document.type != 'internal'" Example (Data Manipulation): title: "Notification string" description: "Create a notification string with a timestamp." expression: "'New message received at ' + string(document.create_time)" The exact variables and functions that may be referenced within an expression are determined by the service that evaluates it. See the service documentation for additional information. # The condition for evaluating the requirement result. Variables in the expression should be provided by `metrics_bindings` or `threshold_bindings`. Where `metrics_bindings` are used for computed metrics and `threshold_bindings` are used to define thresholds for corresponding `metric_bindings`.
+      "description": "A String", # Optional. Description of the expression. This is a longer text which describes the expression, e.g. when hovered over it in a UI.
+      "expression": "A String", # Textual representation of an expression in Common Expression Language syntax.
+      "location": "A String", # Optional. String indicating the location of the expression for error reporting, e.g. a file name and a position in the file.
+      "title": "A String", # Optional. Title for the expression, i.e. a short string describing its purpose. This can be used e.g. in UIs which allow to enter the expression.
+    },
+    "description": "A String", # The description of the requirement.
+    "displayName": "A String", # The name of the requirement.
+    "metricBindings": [ # A list of the metric bindings to be used in `condition`.
+      { # Specifies a metrics query and bind its result to a variable which will be used in the `condition`.
+        "category": "A String", # The category of the metric's target resource. Example: "Events"
+        "description": "A String", # Human readable description of the corresponding metric filter.
+        "metricFilter": "A String", # The filter string used for metrics query. Example: "metric.type = \"discoveryengine.googleapis.com/events/day_count\" AND " "metric.conditions.time_range = \"NINETY_DAYS\""
+        "resourceType": "A String", # The resource being monitored for the metric.
+        "variableId": "A String", # The variable id to be referenced in `condition`.
+      },
+    ],
+    "thresholdBindings": [ # A list of threshold bindings to be used in `condition`.
+      { # Specifies a multi-level threshold to apply to apply to a `metric_bindings` in the `condition` CEL expression.
+        "blockingThreshold": 3.14, # Threshold to trigger a blocking failure. If not met, the requirement will evaluate as a `FAILURE`.
+        "description": "A String", # Human readable description of the corresponding threshold and sub-requirement.
+        "variableId": "A String", # The variable id to be referenced in `condition`. Must be unique across all `metric_bindings` and `threshold_bindings`.
+        "warningThreshold": 3.14, # Threshold to trigger a warning. If not met, the requirement will evaluate as a `WARNING`.
+      },
+    ],
+    "type": "A String", # The requirement type, used as an identifier. Must be unique. The type should prefix with service name to avoid possible collision. It's encoraged to use natural hierarchical grouping for similar requirements. Examples: * `library.googleapis.com/books/min_available_books` * `discoveryengine.googleapis.com/media_rec/recommended_for_you/conversion_rate`
+    "violationSamplesBindings": [ # A list of the metric bindings to be used in `condition`.
+      { # Specifies a samples query and bind its result to a variable which will be used in the `condition`.
+        "description": "A String", # Description of this sample binding. Used by the UI to render user friendly descriptions for each requirement condition. Should be less than 128 characters long.
+        "sampleFilter": "A String", # The filter string used for samples query. Example: "sample.type = \"retail.googleapis.com/user_event\" AND " "sample.labels.event_type = \"PURCHASE\" "
+        "variableId": "A String", # The variable id to be referenced in `condition`.
+      },
+    ],
+  },
+  "requirementCondition": { # Represents a textual expression in the Common Expression Language (CEL) syntax. CEL is a C-like expression language. The syntax and semantics of CEL are documented at https://github.com/google/cel-spec. Example (Comparison): title: "Summary size limit" description: "Determines if a summary is less than 100 chars" expression: "document.summary.size() < 100" Example (Equality): title: "Requestor is owner" description: "Determines if requestor is the document owner" expression: "document.owner == request.auth.claims.email" Example (Logic): title: "Public documents" description: "Determine whether the document should be publicly visible" expression: "document.type != 'private' && document.type != 'internal'" Example (Data Manipulation): title: "Notification string" description: "Create a notification string with a timestamp." expression: "'New message received at ' + string(document.create_time)" The exact variables and functions that may be referenced within an expression are determined by the service that evaluates it. See the service documentation for additional information. # The condition for evaluating the requirement result.
+    "description": "A String", # Optional. Description of the expression. This is a longer text which describes the expression, e.g. when hovered over it in a UI.
+    "expression": "A String", # Textual representation of an expression in Common Expression Language syntax.
+    "location": "A String", # Optional. String indicating the location of the expression for error reporting, e.g. a file name and a position in the file.
+    "title": "A String", # Optional. Title for the expression, i.e. a short string describing its purpose. This can be used e.g. in UIs which allow to enter the expression.
+  },
+  "requirementResult": "A String", # Requirement result, e.g. pass or fail.
+}
+
+ +
+ close() +
Close httplib2 connections.
+
+ + \ No newline at end of file diff --git a/docs/dyn/discoveryengine_v1alpha.projects.locations.userEvents.html b/docs/dyn/discoveryengine_v1alpha.projects.locations.userEvents.html index 894ce6ca5e7..8bc16b8fe4d 100644 --- a/docs/dyn/discoveryengine_v1alpha.projects.locations.userEvents.html +++ b/docs/dyn/discoveryengine_v1alpha.projects.locations.userEvents.html @@ -77,6 +77,9 @@

Instance Methods

close()

Close httplib2 connections.

+

+ collect(parent, ets=None, uri=None, userEvent=None, x__xgafv=None)

+

Writes a single user event from the browser. This uses a GET request to due to browser restriction of POST-ing to a third-party domain. This method is used only by the Discovery Engine API JavaScript pixel and Google Tag Manager. Users should not call this method directly.

write(parent, body=None, writeAsync=None, x__xgafv=None)

Writes a single user event.

@@ -86,6 +89,34 @@

Method Details

Close httplib2 connections.
+
+ collect(parent, ets=None, uri=None, userEvent=None, x__xgafv=None) +
Writes a single user event from the browser. This uses a GET request to due to browser restriction of POST-ing to a third-party domain. This method is used only by the Discovery Engine API JavaScript pixel and Google Tag Manager. Users should not call this method directly.
+
+Args:
+  parent: string, Required. The parent DataStore resource name, such as `projects/{project}/locations/{location}/collections/{collection}/dataStores/{data_store}`. (required)
+  ets: string, The event timestamp in milliseconds. This prevents browser caching of otherwise identical get requests. The name is abbreviated to reduce the payload bytes.
+  uri: string, The URL including cgi-parameters but excluding the hash fragment with a length limit of 5,000 characters. This is often more useful than the referer URL, because many browsers only send the domain for third-party requests.
+  userEvent: string, Required. URL encoded UserEvent proto with a length limit of 2,000,000 characters.
+  x__xgafv: string, V1 error format.
+    Allowed values
+      1 - v1 error format
+      2 - v2 error format
+
+Returns:
+  An object of the form:
+
+    { # Message that represents an arbitrary HTTP body. It should only be used for payload formats that can't be represented as JSON, such as raw binary or an HTML page. This message can be used both in streaming and non-streaming API methods in the request as well as the response. It can be used as a top-level request field, which is convenient if one wants to extract parameters from either the URL or HTTP template into the request fields and also want access to the raw HTTP body. Example: message GetResourceRequest { // A unique request id. string request_id = 1; // The raw HTTP body is bound to this field. google.api.HttpBody http_body = 2; } service ResourceService { rpc GetResource(GetResourceRequest) returns (google.api.HttpBody); rpc UpdateResource(google.api.HttpBody) returns (google.protobuf.Empty); } Example with streaming methods: service CaldavService { rpc GetCalendar(stream google.api.HttpBody) returns (stream google.api.HttpBody); rpc UpdateCalendar(stream google.api.HttpBody) returns (stream google.api.HttpBody); } Use of this type only changes how the request and response bodies are handled, all other features will continue to work unchanged.
+  "contentType": "A String", # The HTTP Content-Type header value specifying the content type of the body.
+  "data": "A String", # The HTTP request/response body as raw binary.
+  "extensions": [ # Application specific response metadata. Must be set in the first response for streaming APIs.
+    {
+      "a_key": "", # Properties of the object. Contains field @type with type URL.
+    },
+  ],
+}
+
+
write(parent, body=None, writeAsync=None, x__xgafv=None)
Writes a single user event.
diff --git a/docs/dyn/discoveryengine_v1beta.projects.locations.collections.dataStores.branches.documents.html b/docs/dyn/discoveryengine_v1beta.projects.locations.collections.dataStores.branches.documents.html
index d20866348c1..af29aadb06a 100644
--- a/docs/dyn/discoveryengine_v1beta.projects.locations.collections.dataStores.branches.documents.html
+++ b/docs/dyn/discoveryengine_v1beta.projects.locations.collections.dataStores.branches.documents.html
@@ -229,6 +229,14 @@ 

Method Details

The object takes the form of: { # Request message for Import methods. + "alloyDbSource": { # AlloyDB source import data from. # AlloyDB input source. + "clusterId": "A String", # Required. The AlloyDB cluster to copy the data from with a length limit of 256 characters. + "databaseId": "A String", # Required. The AlloyDB database to copy the data from with a length limit of 256 characters. + "gcsStagingDir": "A String", # Intermediate Cloud Storage directory used for the import with a length limit of 2,000 characters. Can be specified if one wants to have the AlloyDB export to a specific Cloud Storage directory. Ensure that the AlloyDB service account has the necessary Cloud Storage Admin permissions to access the specified Cloud Storage directory. + "locationId": "A String", # Required. The AlloyDB location to copy the data from with a length limit of 256 characters. + "projectId": "A String", # The project ID that the AlloyDB source is in with a length limit of 128 characters. If not specified, inherits the project ID from the parent request. + "tableId": "A String", # Required. The AlloyDB table to copy the data from with a length limit of 256 characters. + }, "autoGenerateIds": True or False, # Whether to automatically generate IDs for the documents if absent. If set to `true`, Document.ids are automatically generated based on the hash of the payload, where IDs may not be consistent during multiple imports. In which case ReconciliationMode.FULL is highly recommended to avoid duplicate contents. If unset or set to `false`, Document.ids have to be specified using id_field, otherwise, documents without IDs fail to be imported. Supported data sources: * GcsSource. GcsSource.data_schema must be `custom` or `csv`. Otherwise, an INVALID_ARGUMENT error is thrown. * BigQuerySource. BigQuerySource.data_schema must be `custom` or `csv`. Otherwise, an INVALID_ARGUMENT error is thrown. * SpannerSource. * CloudSqlSource. * FirestoreSource. * BigtableSource. "bigquerySource": { # BigQuery source import data from. # BigQuery input source. "dataSchema": "A String", # The schema to use when parsing the data from the source. Supported values for user event imports: * `user_event` (default): One UserEvent per row. Supported values for document imports: * `document` (default): One Document format per row. Each document must have a valid Document.id and one of Document.json_data or Document.struct_data. * `custom`: One custom data per row in arbitrary format that conforms to the defined Schema of the data store. This can only be used by the GENERIC Data Store vertical. diff --git a/docs/dyn/discoveryengine_v1beta.projects.locations.collections.dataStores.controls.html b/docs/dyn/discoveryengine_v1beta.projects.locations.collections.dataStores.controls.html index 10bd5326b59..a5b6008bf54 100644 --- a/docs/dyn/discoveryengine_v1beta.projects.locations.collections.dataStores.controls.html +++ b/docs/dyn/discoveryengine_v1beta.projects.locations.collections.dataStores.controls.html @@ -106,7 +106,7 @@

Method Details

Creates a Control. By default 1000 controls are allowed for a data store. A request can be submitted to adjust this limit. If the Control to create already exists, an ALREADY_EXISTS error is returned.
 
 Args:
-  parent: string, Required. Full resource name of parent data store. Format: `projects/{project_number}/locations/{location_id}/collections/{collection_id}/dataStores/{data_store_id}` (required)
+  parent: string, Required. Full resource name of parent data store. Format: `projects/{project_number}/locations/{location_id}/collections/{collection_id}/dataStores/{data_store_id}` or `projects/{project_number}/locations/{location_id}/collections/{collection_id}/engines/{engine_id}`. (required)
   body: object, The request body.
     The object takes the form of:
 
@@ -293,7 +293,7 @@ 

Method Details

Lists all Controls by their parent DataStore.
 
 Args:
-  parent: string, Required. The data store resource name. Format: `projects/{project_number}/locations/{location_id}/collections/{collection_id}/dataStores/{data_store_id}` (required)
+  parent: string, Required. The data store resource name. Format: `projects/{project_number}/locations/{location_id}/collections/{collection_id}/dataStores/{data_store_id}` or `projects/{project_number}/locations/{location_id}/collections/{collection_id}/engines/{engine_id}`. (required)
   filter: string, Optional. A filter to apply on the list results. Supported features: * List all the products under the parent branch if filter is unset. Currently this field is unsupported.
   pageSize: integer, Optional. Maximum number of results to return. If unspecified, defaults to 50. Max allowed value is 1000.
   pageToken: string, Optional. A page token, received from a previous `ListControls` call. Provide this to retrieve the subsequent page.
diff --git a/docs/dyn/discoveryengine_v1beta.projects.locations.collections.dataStores.conversations.html b/docs/dyn/discoveryengine_v1beta.projects.locations.collections.dataStores.conversations.html
index a66e8d39434..387fd1f1fb8 100644
--- a/docs/dyn/discoveryengine_v1beta.projects.locations.collections.dataStores.conversations.html
+++ b/docs/dyn/discoveryengine_v1beta.projects.locations.collections.dataStores.conversations.html
@@ -382,6 +382,34 @@ 

Method Details

}, "searchResults": [ # Search Results. { # Represents the search results. + "chunk": { # Chunk captures all raw metadata information of items to be recommended or searched in the chunk mode. # The chunk data in the search response if the SearchRequest.ContentSearchSpec.search_result_mode is set to CHUNKS. + "chunkMetadata": { # Metadata of the current chunk. This field is only populated on SearchService.Search API. # Output only. Metadata of the current chunk. + "nextChunks": [ # The next chunks of the current chunk. The number is controlled by SearchRequest.ContentSearchSpec.ChunkSpec.num_next_chunks. This field is only populated on SearchService.Search API. + # Object with schema name: GoogleCloudDiscoveryengineV1betaChunk + ], + "previousChunks": [ # The previous chunks of the current chunk. The number is controlled by SearchRequest.ContentSearchSpec.ChunkSpec.num_previous_chunks. This field is only populated on SearchService.Search API. + # Object with schema name: GoogleCloudDiscoveryengineV1betaChunk + ], + }, + "content": "A String", # Content is a string from a document (parsed content). + "derivedStructData": { # Output only. This field is OUTPUT_ONLY. It contains derived data that are not in the original input document. + "a_key": "", # Properties of the object. + }, + "documentMetadata": { # Document metadata contains the information of the document of the current chunk. # Metadata of the document from the current chunk. + "structData": { # Data representation. The structured JSON data for the document. It should conform to the registered Schema or an `INVALID_ARGUMENT` error is thrown. + "a_key": "", # Properties of the object. + }, + "title": "A String", # Title of the document. + "uri": "A String", # Uri of the document. + }, + "id": "A String", # Unique chunk ID of the current chunk. + "name": "A String", # The full resource name of the chunk. Format: `projects/{project}/locations/{location}/collections/{collection}/dataStores/{data_store}/branches/{branch}/documents/{document_id}/chunks/{chunk_id}`. This field must be a UTF-8 encoded string with a length limit of 1024 characters. + "pageSpan": { # Page span of the chunk. # Page span of the chunk. + "pageEnd": 42, # The end page of the chunk. + "pageStart": 42, # The start page of the chunk. + }, + "relevanceScore": 3.14, # Output only. Represents the relevance score based on similarity. Higher score indicates higher chunk relevance. The score is in range [-1.0, 1.0]. Only populated on SearchService.SearchResponse. + }, "document": { # Document captures all raw metadata information of items to be recommended or searched. # The document data snippet in the search response. Only fields that are marked as `retrievable` are populated. "content": { # Unstructured data linked to this document. # The unstructured data linked to this document. Content must be set if this document is under a `CONTENT_REQUIRED` data store. "mimeType": "A String", # The MIME type of the content. Supported types: * `application/pdf` (PDF, only native PDFs are supported for now) * `text/html` (HTML) * `application/vnd.openxmlformats-officedocument.wordprocessingml.document` (DOCX) * `application/vnd.openxmlformats-officedocument.presentationml.presentation` (PPTX) * `text/plain` (TXT) See https://www.iana.org/assignments/media-types/media-types.xhtml. diff --git a/docs/dyn/discoveryengine_v1beta.projects.locations.collections.dataStores.html b/docs/dyn/discoveryengine_v1beta.projects.locations.collections.dataStores.html index edb6f3f3f1e..8ffd05f510a 100644 --- a/docs/dyn/discoveryengine_v1beta.projects.locations.collections.dataStores.html +++ b/docs/dyn/discoveryengine_v1beta.projects.locations.collections.dataStores.html @@ -216,9 +216,17 @@

Method Details

"defaultSchemaId": "A String", # Output only. The id of the default Schema asscociated to this data store. "displayName": "A String", # Required. The data store display name. This field must be a UTF-8 encoded string with a length limit of 128 characters. Otherwise, an INVALID_ARGUMENT error is returned. "documentProcessingConfig": { # A singleton resource of DataStore. It's empty when DataStore is created, which defaults to digital parser. The first call to DataStoreService.UpdateDocumentProcessingConfig method will initialize the config. # Configuration for Document understanding and enrichment. + "chunkingConfig": { # Configuration for chunking config. # Whether chunking mode is enabled. + "layoutBasedChunkingConfig": { # Configuration for the layout based chunking. # Configuration for the layout based chunking. + "chunkSize": 42, # The token size limit for each chunk. Supported values: 100-500 (inclusive). Default value: 500. + "includeAncestorHeadings": True or False, # Whether to include appending different levels of headings to chunks from the middle of the document to prevent context loss. Default value: False. + }, + }, "defaultParsingConfig": { # Related configurations applied to a specific type of document parser. # Configurations for default Document parser. If not specified, we will configure it as default DigitalParsingConfig, and the default parsing config will be applied to all file types for Document parsing. "digitalParsingConfig": { # The digital parsing configurations for documents. # Configurations applied to digital parser. }, + "layoutParsingConfig": { # The layout parsing configurations for documents. # Configurations applied to layout parser. + }, "ocrParsingConfig": { # The OCR parsing configurations for documents. # Configurations applied to OCR parser. Currently it only applies to PDFs. "enhancedDocumentElements": [ # [DEPRECATED] This field is deprecated. To use the additional enhanced document elements processing, please switch to `layout_parsing_config`. "A String", @@ -231,6 +239,8 @@

Method Details

"a_key": { # Related configurations applied to a specific type of document parser. "digitalParsingConfig": { # The digital parsing configurations for documents. # Configurations applied to digital parser. }, + "layoutParsingConfig": { # The layout parsing configurations for documents. # Configurations applied to layout parser. + }, "ocrParsingConfig": { # The OCR parsing configurations for documents. # Configurations applied to OCR parser. Currently it only applies to PDFs. "enhancedDocumentElements": [ # [DEPRECATED] This field is deprecated. To use the additional enhanced document elements processing, please switch to `layout_parsing_config`. "A String", @@ -340,9 +350,17 @@

Method Details

"defaultSchemaId": "A String", # Output only. The id of the default Schema asscociated to this data store. "displayName": "A String", # Required. The data store display name. This field must be a UTF-8 encoded string with a length limit of 128 characters. Otherwise, an INVALID_ARGUMENT error is returned. "documentProcessingConfig": { # A singleton resource of DataStore. It's empty when DataStore is created, which defaults to digital parser. The first call to DataStoreService.UpdateDocumentProcessingConfig method will initialize the config. # Configuration for Document understanding and enrichment. + "chunkingConfig": { # Configuration for chunking config. # Whether chunking mode is enabled. + "layoutBasedChunkingConfig": { # Configuration for the layout based chunking. # Configuration for the layout based chunking. + "chunkSize": 42, # The token size limit for each chunk. Supported values: 100-500 (inclusive). Default value: 500. + "includeAncestorHeadings": True or False, # Whether to include appending different levels of headings to chunks from the middle of the document to prevent context loss. Default value: False. + }, + }, "defaultParsingConfig": { # Related configurations applied to a specific type of document parser. # Configurations for default Document parser. If not specified, we will configure it as default DigitalParsingConfig, and the default parsing config will be applied to all file types for Document parsing. "digitalParsingConfig": { # The digital parsing configurations for documents. # Configurations applied to digital parser. }, + "layoutParsingConfig": { # The layout parsing configurations for documents. # Configurations applied to layout parser. + }, "ocrParsingConfig": { # The OCR parsing configurations for documents. # Configurations applied to OCR parser. Currently it only applies to PDFs. "enhancedDocumentElements": [ # [DEPRECATED] This field is deprecated. To use the additional enhanced document elements processing, please switch to `layout_parsing_config`. "A String", @@ -355,6 +373,8 @@

Method Details

"a_key": { # Related configurations applied to a specific type of document parser. "digitalParsingConfig": { # The digital parsing configurations for documents. # Configurations applied to digital parser. }, + "layoutParsingConfig": { # The layout parsing configurations for documents. # Configurations applied to layout parser. + }, "ocrParsingConfig": { # The OCR parsing configurations for documents. # Configurations applied to OCR parser. Currently it only applies to PDFs. "enhancedDocumentElements": [ # [DEPRECATED] This field is deprecated. To use the additional enhanced document elements processing, please switch to `layout_parsing_config`. "A String", @@ -423,9 +443,17 @@

Method Details

"defaultSchemaId": "A String", # Output only. The id of the default Schema asscociated to this data store. "displayName": "A String", # Required. The data store display name. This field must be a UTF-8 encoded string with a length limit of 128 characters. Otherwise, an INVALID_ARGUMENT error is returned. "documentProcessingConfig": { # A singleton resource of DataStore. It's empty when DataStore is created, which defaults to digital parser. The first call to DataStoreService.UpdateDocumentProcessingConfig method will initialize the config. # Configuration for Document understanding and enrichment. + "chunkingConfig": { # Configuration for chunking config. # Whether chunking mode is enabled. + "layoutBasedChunkingConfig": { # Configuration for the layout based chunking. # Configuration for the layout based chunking. + "chunkSize": 42, # The token size limit for each chunk. Supported values: 100-500 (inclusive). Default value: 500. + "includeAncestorHeadings": True or False, # Whether to include appending different levels of headings to chunks from the middle of the document to prevent context loss. Default value: False. + }, + }, "defaultParsingConfig": { # Related configurations applied to a specific type of document parser. # Configurations for default Document parser. If not specified, we will configure it as default DigitalParsingConfig, and the default parsing config will be applied to all file types for Document parsing. "digitalParsingConfig": { # The digital parsing configurations for documents. # Configurations applied to digital parser. }, + "layoutParsingConfig": { # The layout parsing configurations for documents. # Configurations applied to layout parser. + }, "ocrParsingConfig": { # The OCR parsing configurations for documents. # Configurations applied to OCR parser. Currently it only applies to PDFs. "enhancedDocumentElements": [ # [DEPRECATED] This field is deprecated. To use the additional enhanced document elements processing, please switch to `layout_parsing_config`. "A String", @@ -438,6 +466,8 @@

Method Details

"a_key": { # Related configurations applied to a specific type of document parser. "digitalParsingConfig": { # The digital parsing configurations for documents. # Configurations applied to digital parser. }, + "layoutParsingConfig": { # The layout parsing configurations for documents. # Configurations applied to layout parser. + }, "ocrParsingConfig": { # The OCR parsing configurations for documents. # Configurations applied to OCR parser. Currently it only applies to PDFs. "enhancedDocumentElements": [ # [DEPRECATED] This field is deprecated. To use the additional enhanced document elements processing, please switch to `layout_parsing_config`. "A String", @@ -494,9 +524,17 @@

Method Details

"defaultSchemaId": "A String", # Output only. The id of the default Schema asscociated to this data store. "displayName": "A String", # Required. The data store display name. This field must be a UTF-8 encoded string with a length limit of 128 characters. Otherwise, an INVALID_ARGUMENT error is returned. "documentProcessingConfig": { # A singleton resource of DataStore. It's empty when DataStore is created, which defaults to digital parser. The first call to DataStoreService.UpdateDocumentProcessingConfig method will initialize the config. # Configuration for Document understanding and enrichment. + "chunkingConfig": { # Configuration for chunking config. # Whether chunking mode is enabled. + "layoutBasedChunkingConfig": { # Configuration for the layout based chunking. # Configuration for the layout based chunking. + "chunkSize": 42, # The token size limit for each chunk. Supported values: 100-500 (inclusive). Default value: 500. + "includeAncestorHeadings": True or False, # Whether to include appending different levels of headings to chunks from the middle of the document to prevent context loss. Default value: False. + }, + }, "defaultParsingConfig": { # Related configurations applied to a specific type of document parser. # Configurations for default Document parser. If not specified, we will configure it as default DigitalParsingConfig, and the default parsing config will be applied to all file types for Document parsing. "digitalParsingConfig": { # The digital parsing configurations for documents. # Configurations applied to digital parser. }, + "layoutParsingConfig": { # The layout parsing configurations for documents. # Configurations applied to layout parser. + }, "ocrParsingConfig": { # The OCR parsing configurations for documents. # Configurations applied to OCR parser. Currently it only applies to PDFs. "enhancedDocumentElements": [ # [DEPRECATED] This field is deprecated. To use the additional enhanced document elements processing, please switch to `layout_parsing_config`. "A String", @@ -509,6 +547,8 @@

Method Details

"a_key": { # Related configurations applied to a specific type of document parser. "digitalParsingConfig": { # The digital parsing configurations for documents. # Configurations applied to digital parser. }, + "layoutParsingConfig": { # The layout parsing configurations for documents. # Configurations applied to layout parser. + }, "ocrParsingConfig": { # The OCR parsing configurations for documents. # Configurations applied to OCR parser. Currently it only applies to PDFs. "enhancedDocumentElements": [ # [DEPRECATED] This field is deprecated. To use the additional enhanced document elements processing, please switch to `layout_parsing_config`. "A String", @@ -547,9 +587,17 @@

Method Details

"defaultSchemaId": "A String", # Output only. The id of the default Schema asscociated to this data store. "displayName": "A String", # Required. The data store display name. This field must be a UTF-8 encoded string with a length limit of 128 characters. Otherwise, an INVALID_ARGUMENT error is returned. "documentProcessingConfig": { # A singleton resource of DataStore. It's empty when DataStore is created, which defaults to digital parser. The first call to DataStoreService.UpdateDocumentProcessingConfig method will initialize the config. # Configuration for Document understanding and enrichment. + "chunkingConfig": { # Configuration for chunking config. # Whether chunking mode is enabled. + "layoutBasedChunkingConfig": { # Configuration for the layout based chunking. # Configuration for the layout based chunking. + "chunkSize": 42, # The token size limit for each chunk. Supported values: 100-500 (inclusive). Default value: 500. + "includeAncestorHeadings": True or False, # Whether to include appending different levels of headings to chunks from the middle of the document to prevent context loss. Default value: False. + }, + }, "defaultParsingConfig": { # Related configurations applied to a specific type of document parser. # Configurations for default Document parser. If not specified, we will configure it as default DigitalParsingConfig, and the default parsing config will be applied to all file types for Document parsing. "digitalParsingConfig": { # The digital parsing configurations for documents. # Configurations applied to digital parser. }, + "layoutParsingConfig": { # The layout parsing configurations for documents. # Configurations applied to layout parser. + }, "ocrParsingConfig": { # The OCR parsing configurations for documents. # Configurations applied to OCR parser. Currently it only applies to PDFs. "enhancedDocumentElements": [ # [DEPRECATED] This field is deprecated. To use the additional enhanced document elements processing, please switch to `layout_parsing_config`. "A String", @@ -562,6 +610,8 @@

Method Details

"a_key": { # Related configurations applied to a specific type of document parser. "digitalParsingConfig": { # The digital parsing configurations for documents. # Configurations applied to digital parser. }, + "layoutParsingConfig": { # The layout parsing configurations for documents. # Configurations applied to layout parser. + }, "ocrParsingConfig": { # The OCR parsing configurations for documents. # Configurations applied to OCR parser. Currently it only applies to PDFs. "enhancedDocumentElements": [ # [DEPRECATED] This field is deprecated. To use the additional enhanced document elements processing, please switch to `layout_parsing_config`. "A String", diff --git a/docs/dyn/discoveryengine_v1beta.projects.locations.collections.dataStores.servingConfigs.html b/docs/dyn/discoveryengine_v1beta.projects.locations.collections.dataStores.servingConfigs.html index ef90311e505..7ac6af5b710 100644 --- a/docs/dyn/discoveryengine_v1beta.projects.locations.collections.dataStores.servingConfigs.html +++ b/docs/dyn/discoveryengine_v1beta.projects.locations.collections.dataStores.servingConfigs.html @@ -176,6 +176,7 @@

Method Details

"filter": "A String", # The filter syntax consists of an expression language for constructing a predicate from one or more fields of the documents being filtered. Filter expression is case-sensitive. This will be used to filter search results which may affect the Answer response. If this field is unrecognizable, an `INVALID_ARGUMENT` is returned. Filtering in Vertex AI Search is done by mapping the LHS filter key to a key property defined in the Vertex AI Search backend -- this mapping is defined by the customer in their schema. For example a media customers might have a field 'name' in their schema. In this case the filter would look like this: filter --> name:'ANY("king kong")' For more information about filtering including syntax and filter operators, see [Filter](https://cloud.google.com/generative-ai-app-builder/docs/filter-search-metadata) "maxReturnResults": 42, # Number of search results to return. The default value is 10. "orderBy": "A String", # The order in which documents are returned. Documents can be ordered by a field in an Document object. Leave it unset if ordered by relevance. `order_by` expression is case-sensitive. For more information on ordering, see [Ordering](https://cloud.google.com/retail/docs/filter-and-order#order) If this field is unrecognizable, an `INVALID_ARGUMENT` is returned. + "searchResultMode": "A String", # Specifies the search result mode. If unspecified, the search result mode is based on DataStore.DocumentProcessingConfig.chunking_config: * If DataStore.DocumentProcessingConfig.chunking_config is specified, it defaults to `CHUNKS`. * Otherwise, it defaults to `DOCUMENTS`. See [parse and chunk documents](https://cloud.google.com/generative-ai-app-builder/docs/parse-chunk-documents) }, "searchResultList": { # Search result list. # Search result list. "searchResults": [ # Search results. @@ -212,6 +213,9 @@

Method Details

}, }, "session": "A String", # The session resource name. Not required. When session field is not set, the API is in sessionless mode. We support auto session mode: users can use the wildcard symbol `-` as session ID. A new ID will be automatically generated and assigned. + "userLabels": { # The user labels applied to a resource must meet the following requirements: * Each resource can have multiple labels, up to a maximum of 64. * Each label must be a key-value pair. * Keys have a minimum length of 1 character and a maximum length of 63 characters and cannot be empty. Values can be empty and have a maximum length of 63 characters. * Keys and values can contain only lowercase letters, numeric characters, underscores, and dashes. All characters must use UTF-8 encoding, and international characters are allowed. * The key portion of a label must be unique. However, you can use the same key with multiple resources. * Keys must start with a lowercase letter or international character. See [Google Cloud Document](https://cloud.google.com/resource-manager/docs/creating-managing-labels#requirements) for more details. + "a_key": "A String", + }, "userPseudoId": "A String", # A unique identifier for tracking visitors. For example, this could be implemented with an HTTP cookie, which should be able to uniquely identify a visitor on a single device. This unique identifier should not change if the visitor logs in or out of the website. This field should NOT have a fixed value such as `unknown_visitor`. The field must be a UTF-8 encoded string with a length limit of 128 characters. Otherwise, an `INVALID_ARGUMENT` error is returned. } @@ -381,6 +385,10 @@

Method Details

], "genericConfig": { # Specifies the configurations needed for Generic Discovery.Currently we support: * `content_search_spec`: configuration for generic content search. # The GenericConfig of the serving configuration. "contentSearchSpec": { # A specification for configuring the behavior of content search. # Specifies the expected behavior of content search. Only valid for content-search enabled data store. + "chunkSpec": { # Specifies the chunk spec to be returned from the search response. Only available if the SearchRequest.ContentSearchSpec.search_result_mode is set to CHUNKS # Specifies the chunk spec to be returned from the search response. Only available if the SearchRequest.ContentSearchSpec.search_result_mode is set to CHUNKS + "numNextChunks": 42, # The number of next chunks to be returned of the current chunk. The maximum allowed value is 3. If not specified, no next chunks will be returned. + "numPreviousChunks": 42, # The number of previous chunks to be returned of the current chunk. The maximum allowed value is 3. If not specified, no previous chunks will be returned. + }, "extractiveContentSpec": { # A specification for configuring the extractive content in a search response. # If there is no extractive_content_spec provided, there will be no extractive answer in the search response. "maxExtractiveAnswerCount": 42, # The maximum number of extractive answers returned in each search result. An extractive answer is a verbatim answer extracted from the original document, which provides a precise and contextually relevant answer to the search query. If the number of matching answers is less than the `max_extractive_answer_count`, return all of the answers. Otherwise, return the `max_extractive_answer_count`. At most five answers are returned for each SearchResult. "maxExtractiveSegmentCount": 42, # The max number of extractive segments returned in each search result. Only applied if the DataStore is set to DataStore.ContentConfig.CONTENT_REQUIRED or DataStore.solution_types is SOLUTION_TYPE_CHAT. An extractive segment is a text segment extracted from the original document that is relevant to the search query, and, in general, more verbose than an extractive answer. The segment could then be used as input for LLMs to generate summaries and answers. If the number of matching segments is less than `max_extractive_segment_count`, return all of the segments. Otherwise, return the `max_extractive_segment_count`. @@ -388,6 +396,7 @@

Method Details

"numPreviousSegments": 42, # Specifies whether to also include the adjacent from each selected segments. Return at most `num_previous_segments` segments before each selected segments. "returnExtractiveSegmentScore": True or False, # Specifies whether to return the confidence score from the extractive segments in each search result. This feature is available only for new or allowlisted data stores. To allowlist your data store, contact your Customer Engineer. The default value is `false`. }, + "searchResultMode": "A String", # Specifies the search result mode. If unspecified, the search result mode is based on DataStore.DocumentProcessingConfig.chunking_config: * If DataStore.DocumentProcessingConfig.chunking_config is specified, it defaults to `CHUNKS`. * Otherwise, it defaults to `DOCUMENTS`. "snippetSpec": { # A specification for configuring snippets in a search response. # If `snippetSpec` is not specified, snippets are not included in the search response. "maxSnippetCount": 42, # [DEPRECATED] This field is deprecated. To control snippet return, use `return_snippet` field. For backwards compatibility, we will return snippet if max_snippet_count > 0. "referenceOnly": True or False, # [DEPRECATED] This field is deprecated and will have no affect on the snippet. @@ -475,6 +484,10 @@

Method Details

], "genericConfig": { # Specifies the configurations needed for Generic Discovery.Currently we support: * `content_search_spec`: configuration for generic content search. # The GenericConfig of the serving configuration. "contentSearchSpec": { # A specification for configuring the behavior of content search. # Specifies the expected behavior of content search. Only valid for content-search enabled data store. + "chunkSpec": { # Specifies the chunk spec to be returned from the search response. Only available if the SearchRequest.ContentSearchSpec.search_result_mode is set to CHUNKS # Specifies the chunk spec to be returned from the search response. Only available if the SearchRequest.ContentSearchSpec.search_result_mode is set to CHUNKS + "numNextChunks": 42, # The number of next chunks to be returned of the current chunk. The maximum allowed value is 3. If not specified, no next chunks will be returned. + "numPreviousChunks": 42, # The number of previous chunks to be returned of the current chunk. The maximum allowed value is 3. If not specified, no previous chunks will be returned. + }, "extractiveContentSpec": { # A specification for configuring the extractive content in a search response. # If there is no extractive_content_spec provided, there will be no extractive answer in the search response. "maxExtractiveAnswerCount": 42, # The maximum number of extractive answers returned in each search result. An extractive answer is a verbatim answer extracted from the original document, which provides a precise and contextually relevant answer to the search query. If the number of matching answers is less than the `max_extractive_answer_count`, return all of the answers. Otherwise, return the `max_extractive_answer_count`. At most five answers are returned for each SearchResult. "maxExtractiveSegmentCount": 42, # The max number of extractive segments returned in each search result. Only applied if the DataStore is set to DataStore.ContentConfig.CONTENT_REQUIRED or DataStore.solution_types is SOLUTION_TYPE_CHAT. An extractive segment is a text segment extracted from the original document that is relevant to the search query, and, in general, more verbose than an extractive answer. The segment could then be used as input for LLMs to generate summaries and answers. If the number of matching segments is less than `max_extractive_segment_count`, return all of the segments. Otherwise, return the `max_extractive_segment_count`. @@ -482,6 +495,7 @@

Method Details

"numPreviousSegments": 42, # Specifies whether to also include the adjacent from each selected segments. Return at most `num_previous_segments` segments before each selected segments. "returnExtractiveSegmentScore": True or False, # Specifies whether to return the confidence score from the extractive segments in each search result. This feature is available only for new or allowlisted data stores. To allowlist your data store, contact your Customer Engineer. The default value is `false`. }, + "searchResultMode": "A String", # Specifies the search result mode. If unspecified, the search result mode is based on DataStore.DocumentProcessingConfig.chunking_config: * If DataStore.DocumentProcessingConfig.chunking_config is specified, it defaults to `CHUNKS`. * Otherwise, it defaults to `DOCUMENTS`. "snippetSpec": { # A specification for configuring snippets in a search response. # If `snippetSpec` is not specified, snippets are not included in the search response. "maxSnippetCount": 42, # [DEPRECATED] This field is deprecated. To control snippet return, use `return_snippet` field. For backwards compatibility, we will return snippet if max_snippet_count > 0. "referenceOnly": True or False, # [DEPRECATED] This field is deprecated and will have no affect on the snippet. @@ -575,6 +589,10 @@

Method Details

], "genericConfig": { # Specifies the configurations needed for Generic Discovery.Currently we support: * `content_search_spec`: configuration for generic content search. # The GenericConfig of the serving configuration. "contentSearchSpec": { # A specification for configuring the behavior of content search. # Specifies the expected behavior of content search. Only valid for content-search enabled data store. + "chunkSpec": { # Specifies the chunk spec to be returned from the search response. Only available if the SearchRequest.ContentSearchSpec.search_result_mode is set to CHUNKS # Specifies the chunk spec to be returned from the search response. Only available if the SearchRequest.ContentSearchSpec.search_result_mode is set to CHUNKS + "numNextChunks": 42, # The number of next chunks to be returned of the current chunk. The maximum allowed value is 3. If not specified, no next chunks will be returned. + "numPreviousChunks": 42, # The number of previous chunks to be returned of the current chunk. The maximum allowed value is 3. If not specified, no previous chunks will be returned. + }, "extractiveContentSpec": { # A specification for configuring the extractive content in a search response. # If there is no extractive_content_spec provided, there will be no extractive answer in the search response. "maxExtractiveAnswerCount": 42, # The maximum number of extractive answers returned in each search result. An extractive answer is a verbatim answer extracted from the original document, which provides a precise and contextually relevant answer to the search query. If the number of matching answers is less than the `max_extractive_answer_count`, return all of the answers. Otherwise, return the `max_extractive_answer_count`. At most five answers are returned for each SearchResult. "maxExtractiveSegmentCount": 42, # The max number of extractive segments returned in each search result. Only applied if the DataStore is set to DataStore.ContentConfig.CONTENT_REQUIRED or DataStore.solution_types is SOLUTION_TYPE_CHAT. An extractive segment is a text segment extracted from the original document that is relevant to the search query, and, in general, more verbose than an extractive answer. The segment could then be used as input for LLMs to generate summaries and answers. If the number of matching segments is less than `max_extractive_segment_count`, return all of the segments. Otherwise, return the `max_extractive_segment_count`. @@ -582,6 +600,7 @@

Method Details

"numPreviousSegments": 42, # Specifies whether to also include the adjacent from each selected segments. Return at most `num_previous_segments` segments before each selected segments. "returnExtractiveSegmentScore": True or False, # Specifies whether to return the confidence score from the extractive segments in each search result. This feature is available only for new or allowlisted data stores. To allowlist your data store, contact your Customer Engineer. The default value is `false`. }, + "searchResultMode": "A String", # Specifies the search result mode. If unspecified, the search result mode is based on DataStore.DocumentProcessingConfig.chunking_config: * If DataStore.DocumentProcessingConfig.chunking_config is specified, it defaults to `CHUNKS`. * Otherwise, it defaults to `DOCUMENTS`. "snippetSpec": { # A specification for configuring snippets in a search response. # If `snippetSpec` is not specified, snippets are not included in the search response. "maxSnippetCount": 42, # [DEPRECATED] This field is deprecated. To control snippet return, use `return_snippet` field. For backwards compatibility, we will return snippet if max_snippet_count > 0. "referenceOnly": True or False, # [DEPRECATED] This field is deprecated and will have no affect on the snippet. @@ -658,6 +677,10 @@

Method Details

], "genericConfig": { # Specifies the configurations needed for Generic Discovery.Currently we support: * `content_search_spec`: configuration for generic content search. # The GenericConfig of the serving configuration. "contentSearchSpec": { # A specification for configuring the behavior of content search. # Specifies the expected behavior of content search. Only valid for content-search enabled data store. + "chunkSpec": { # Specifies the chunk spec to be returned from the search response. Only available if the SearchRequest.ContentSearchSpec.search_result_mode is set to CHUNKS # Specifies the chunk spec to be returned from the search response. Only available if the SearchRequest.ContentSearchSpec.search_result_mode is set to CHUNKS + "numNextChunks": 42, # The number of next chunks to be returned of the current chunk. The maximum allowed value is 3. If not specified, no next chunks will be returned. + "numPreviousChunks": 42, # The number of previous chunks to be returned of the current chunk. The maximum allowed value is 3. If not specified, no previous chunks will be returned. + }, "extractiveContentSpec": { # A specification for configuring the extractive content in a search response. # If there is no extractive_content_spec provided, there will be no extractive answer in the search response. "maxExtractiveAnswerCount": 42, # The maximum number of extractive answers returned in each search result. An extractive answer is a verbatim answer extracted from the original document, which provides a precise and contextually relevant answer to the search query. If the number of matching answers is less than the `max_extractive_answer_count`, return all of the answers. Otherwise, return the `max_extractive_answer_count`. At most five answers are returned for each SearchResult. "maxExtractiveSegmentCount": 42, # The max number of extractive segments returned in each search result. Only applied if the DataStore is set to DataStore.ContentConfig.CONTENT_REQUIRED or DataStore.solution_types is SOLUTION_TYPE_CHAT. An extractive segment is a text segment extracted from the original document that is relevant to the search query, and, in general, more verbose than an extractive answer. The segment could then be used as input for LLMs to generate summaries and answers. If the number of matching segments is less than `max_extractive_segment_count`, return all of the segments. Otherwise, return the `max_extractive_segment_count`. @@ -665,6 +688,7 @@

Method Details

"numPreviousSegments": 42, # Specifies whether to also include the adjacent from each selected segments. Return at most `num_previous_segments` segments before each selected segments. "returnExtractiveSegmentScore": True or False, # Specifies whether to return the confidence score from the extractive segments in each search result. This feature is available only for new or allowlisted data stores. To allowlist your data store, contact your Customer Engineer. The default value is `false`. }, + "searchResultMode": "A String", # Specifies the search result mode. If unspecified, the search result mode is based on DataStore.DocumentProcessingConfig.chunking_config: * If DataStore.DocumentProcessingConfig.chunking_config is specified, it defaults to `CHUNKS`. * Otherwise, it defaults to `DOCUMENTS`. "snippetSpec": { # A specification for configuring snippets in a search response. # If `snippetSpec` is not specified, snippets are not included in the search response. "maxSnippetCount": 42, # [DEPRECATED] This field is deprecated. To control snippet return, use `return_snippet` field. For backwards compatibility, we will return snippet if max_snippet_count > 0. "referenceOnly": True or False, # [DEPRECATED] This field is deprecated and will have no affect on the snippet. @@ -887,6 +911,10 @@

Method Details

"branch": "A String", # The branch resource name, such as `projects/*/locations/global/collections/default_collection/dataStores/default_data_store/branches/0`. Use `default_branch` as the branch ID or leave this field empty, to search documents under the default branch. "canonicalFilter": "A String", # The default filter that is applied when a user performs a search without checking any filters on the search page. The filter applied to every search request when quality improvement such as query expansion is needed. In the case a query does not have a sufficient amount of results this filter will be used to determine whether or not to enable the query expansion flow. The original filter will still be used for the query expanded search. This field is strongly recommended to achieve high search quality. For more information about filter syntax, see SearchRequest.filter. "contentSearchSpec": { # A specification for configuring the behavior of content search. # A specification for configuring the behavior of content search. + "chunkSpec": { # Specifies the chunk spec to be returned from the search response. Only available if the SearchRequest.ContentSearchSpec.search_result_mode is set to CHUNKS # Specifies the chunk spec to be returned from the search response. Only available if the SearchRequest.ContentSearchSpec.search_result_mode is set to CHUNKS + "numNextChunks": 42, # The number of next chunks to be returned of the current chunk. The maximum allowed value is 3. If not specified, no next chunks will be returned. + "numPreviousChunks": 42, # The number of previous chunks to be returned of the current chunk. The maximum allowed value is 3. If not specified, no previous chunks will be returned. + }, "extractiveContentSpec": { # A specification for configuring the extractive content in a search response. # If there is no extractive_content_spec provided, there will be no extractive answer in the search response. "maxExtractiveAnswerCount": 42, # The maximum number of extractive answers returned in each search result. An extractive answer is a verbatim answer extracted from the original document, which provides a precise and contextually relevant answer to the search query. If the number of matching answers is less than the `max_extractive_answer_count`, return all of the answers. Otherwise, return the `max_extractive_answer_count`. At most five answers are returned for each SearchResult. "maxExtractiveSegmentCount": 42, # The max number of extractive segments returned in each search result. Only applied if the DataStore is set to DataStore.ContentConfig.CONTENT_REQUIRED or DataStore.solution_types is SOLUTION_TYPE_CHAT. An extractive segment is a text segment extracted from the original document that is relevant to the search query, and, in general, more verbose than an extractive answer. The segment could then be used as input for LLMs to generate summaries and answers. If the number of matching segments is less than `max_extractive_segment_count`, return all of the segments. Otherwise, return the `max_extractive_segment_count`. @@ -894,6 +922,7 @@

Method Details

"numPreviousSegments": 42, # Specifies whether to also include the adjacent from each selected segments. Return at most `num_previous_segments` segments before each selected segments. "returnExtractiveSegmentScore": True or False, # Specifies whether to return the confidence score from the extractive segments in each search result. This feature is available only for new or allowlisted data stores. To allowlist your data store, contact your Customer Engineer. The default value is `false`. }, + "searchResultMode": "A String", # Specifies the search result mode. If unspecified, the search result mode is based on DataStore.DocumentProcessingConfig.chunking_config: * If DataStore.DocumentProcessingConfig.chunking_config is specified, it defaults to `CHUNKS`. * Otherwise, it defaults to `DOCUMENTS`. "snippetSpec": { # A specification for configuring snippets in a search response. # If `snippetSpec` is not specified, snippets are not included in the search response. "maxSnippetCount": 42, # [DEPRECATED] This field is deprecated. To control snippet return, use `return_snippet` field. For backwards compatibility, we will return snippet if max_snippet_count > 0. "referenceOnly": True or False, # [DEPRECATED] This field is deprecated and will have no affect on the snippet. @@ -1048,6 +1077,34 @@

Method Details

"redirectUri": "A String", # The URI of a customer-defined redirect page. If redirect action is triggered, no search is performed, and only redirect_uri and attribution_token are set in the response. "results": [ # A list of matched documents. The order represents the ranking. { # Represents the search results. + "chunk": { # Chunk captures all raw metadata information of items to be recommended or searched in the chunk mode. # The chunk data in the search response if the SearchRequest.ContentSearchSpec.search_result_mode is set to CHUNKS. + "chunkMetadata": { # Metadata of the current chunk. This field is only populated on SearchService.Search API. # Output only. Metadata of the current chunk. + "nextChunks": [ # The next chunks of the current chunk. The number is controlled by SearchRequest.ContentSearchSpec.ChunkSpec.num_next_chunks. This field is only populated on SearchService.Search API. + # Object with schema name: GoogleCloudDiscoveryengineV1betaChunk + ], + "previousChunks": [ # The previous chunks of the current chunk. The number is controlled by SearchRequest.ContentSearchSpec.ChunkSpec.num_previous_chunks. This field is only populated on SearchService.Search API. + # Object with schema name: GoogleCloudDiscoveryengineV1betaChunk + ], + }, + "content": "A String", # Content is a string from a document (parsed content). + "derivedStructData": { # Output only. This field is OUTPUT_ONLY. It contains derived data that are not in the original input document. + "a_key": "", # Properties of the object. + }, + "documentMetadata": { # Document metadata contains the information of the document of the current chunk. # Metadata of the document from the current chunk. + "structData": { # Data representation. The structured JSON data for the document. It should conform to the registered Schema or an `INVALID_ARGUMENT` error is thrown. + "a_key": "", # Properties of the object. + }, + "title": "A String", # Title of the document. + "uri": "A String", # Uri of the document. + }, + "id": "A String", # Unique chunk ID of the current chunk. + "name": "A String", # The full resource name of the chunk. Format: `projects/{project}/locations/{location}/collections/{collection}/dataStores/{data_store}/branches/{branch}/documents/{document_id}/chunks/{chunk_id}`. This field must be a UTF-8 encoded string with a length limit of 1024 characters. + "pageSpan": { # Page span of the chunk. # Page span of the chunk. + "pageEnd": 42, # The end page of the chunk. + "pageStart": 42, # The start page of the chunk. + }, + "relevanceScore": 3.14, # Output only. Represents the relevance score based on similarity. Higher score indicates higher chunk relevance. The score is in range [-1.0, 1.0]. Only populated on SearchService.SearchResponse. + }, "document": { # Document captures all raw metadata information of items to be recommended or searched. # The document data snippet in the search response. Only fields that are marked as `retrievable` are populated. "content": { # Unstructured data linked to this document. # The unstructured data linked to this document. Content must be set if this document is under a `CONTENT_REQUIRED` data store. "mimeType": "A String", # The MIME type of the content. Supported types: * `application/pdf` (PDF, only native PDFs are supported for now) * `text/html` (HTML) * `application/vnd.openxmlformats-officedocument.wordprocessingml.document` (DOCX) * `application/vnd.openxmlformats-officedocument.presentationml.presentation` (PPTX) * `text/plain` (TXT) See https://www.iana.org/assignments/media-types/media-types.xhtml. diff --git a/docs/dyn/discoveryengine_v1beta.projects.locations.collections.engines.controls.html b/docs/dyn/discoveryengine_v1beta.projects.locations.collections.engines.controls.html index 8ed7fa4fb27..8fc0064d00c 100644 --- a/docs/dyn/discoveryengine_v1beta.projects.locations.collections.engines.controls.html +++ b/docs/dyn/discoveryengine_v1beta.projects.locations.collections.engines.controls.html @@ -106,7 +106,7 @@

Method Details

Creates a Control. By default 1000 controls are allowed for a data store. A request can be submitted to adjust this limit. If the Control to create already exists, an ALREADY_EXISTS error is returned.
 
 Args:
-  parent: string, Required. Full resource name of parent data store. Format: `projects/{project_number}/locations/{location_id}/collections/{collection_id}/dataStores/{data_store_id}` (required)
+  parent: string, Required. Full resource name of parent data store. Format: `projects/{project_number}/locations/{location_id}/collections/{collection_id}/dataStores/{data_store_id}` or `projects/{project_number}/locations/{location_id}/collections/{collection_id}/engines/{engine_id}`. (required)
   body: object, The request body.
     The object takes the form of:
 
@@ -293,7 +293,7 @@ 

Method Details

Lists all Controls by their parent DataStore.
 
 Args:
-  parent: string, Required. The data store resource name. Format: `projects/{project_number}/locations/{location_id}/collections/{collection_id}/dataStores/{data_store_id}` (required)
+  parent: string, Required. The data store resource name. Format: `projects/{project_number}/locations/{location_id}/collections/{collection_id}/dataStores/{data_store_id}` or `projects/{project_number}/locations/{location_id}/collections/{collection_id}/engines/{engine_id}`. (required)
   filter: string, Optional. A filter to apply on the list results. Supported features: * List all the products under the parent branch if filter is unset. Currently this field is unsupported.
   pageSize: integer, Optional. Maximum number of results to return. If unspecified, defaults to 50. Max allowed value is 1000.
   pageToken: string, Optional. A page token, received from a previous `ListControls` call. Provide this to retrieve the subsequent page.
diff --git a/docs/dyn/discoveryengine_v1beta.projects.locations.collections.engines.conversations.html b/docs/dyn/discoveryengine_v1beta.projects.locations.collections.engines.conversations.html
index c798c975824..ba2cd7a1210 100644
--- a/docs/dyn/discoveryengine_v1beta.projects.locations.collections.engines.conversations.html
+++ b/docs/dyn/discoveryengine_v1beta.projects.locations.collections.engines.conversations.html
@@ -382,6 +382,34 @@ 

Method Details

}, "searchResults": [ # Search Results. { # Represents the search results. + "chunk": { # Chunk captures all raw metadata information of items to be recommended or searched in the chunk mode. # The chunk data in the search response if the SearchRequest.ContentSearchSpec.search_result_mode is set to CHUNKS. + "chunkMetadata": { # Metadata of the current chunk. This field is only populated on SearchService.Search API. # Output only. Metadata of the current chunk. + "nextChunks": [ # The next chunks of the current chunk. The number is controlled by SearchRequest.ContentSearchSpec.ChunkSpec.num_next_chunks. This field is only populated on SearchService.Search API. + # Object with schema name: GoogleCloudDiscoveryengineV1betaChunk + ], + "previousChunks": [ # The previous chunks of the current chunk. The number is controlled by SearchRequest.ContentSearchSpec.ChunkSpec.num_previous_chunks. This field is only populated on SearchService.Search API. + # Object with schema name: GoogleCloudDiscoveryengineV1betaChunk + ], + }, + "content": "A String", # Content is a string from a document (parsed content). + "derivedStructData": { # Output only. This field is OUTPUT_ONLY. It contains derived data that are not in the original input document. + "a_key": "", # Properties of the object. + }, + "documentMetadata": { # Document metadata contains the information of the document of the current chunk. # Metadata of the document from the current chunk. + "structData": { # Data representation. The structured JSON data for the document. It should conform to the registered Schema or an `INVALID_ARGUMENT` error is thrown. + "a_key": "", # Properties of the object. + }, + "title": "A String", # Title of the document. + "uri": "A String", # Uri of the document. + }, + "id": "A String", # Unique chunk ID of the current chunk. + "name": "A String", # The full resource name of the chunk. Format: `projects/{project}/locations/{location}/collections/{collection}/dataStores/{data_store}/branches/{branch}/documents/{document_id}/chunks/{chunk_id}`. This field must be a UTF-8 encoded string with a length limit of 1024 characters. + "pageSpan": { # Page span of the chunk. # Page span of the chunk. + "pageEnd": 42, # The end page of the chunk. + "pageStart": 42, # The start page of the chunk. + }, + "relevanceScore": 3.14, # Output only. Represents the relevance score based on similarity. Higher score indicates higher chunk relevance. The score is in range [-1.0, 1.0]. Only populated on SearchService.SearchResponse. + }, "document": { # Document captures all raw metadata information of items to be recommended or searched. # The document data snippet in the search response. Only fields that are marked as `retrievable` are populated. "content": { # Unstructured data linked to this document. # The unstructured data linked to this document. Content must be set if this document is under a `CONTENT_REQUIRED` data store. "mimeType": "A String", # The MIME type of the content. Supported types: * `application/pdf` (PDF, only native PDFs are supported for now) * `text/html` (HTML) * `application/vnd.openxmlformats-officedocument.wordprocessingml.document` (DOCX) * `application/vnd.openxmlformats-officedocument.presentationml.presentation` (PPTX) * `text/plain` (TXT) See https://www.iana.org/assignments/media-types/media-types.xhtml. diff --git a/docs/dyn/discoveryengine_v1beta.projects.locations.collections.engines.servingConfigs.html b/docs/dyn/discoveryengine_v1beta.projects.locations.collections.engines.servingConfigs.html index ccae63b427e..dc77d775c4d 100644 --- a/docs/dyn/discoveryengine_v1beta.projects.locations.collections.engines.servingConfigs.html +++ b/docs/dyn/discoveryengine_v1beta.projects.locations.collections.engines.servingConfigs.html @@ -176,6 +176,7 @@

Method Details

"filter": "A String", # The filter syntax consists of an expression language for constructing a predicate from one or more fields of the documents being filtered. Filter expression is case-sensitive. This will be used to filter search results which may affect the Answer response. If this field is unrecognizable, an `INVALID_ARGUMENT` is returned. Filtering in Vertex AI Search is done by mapping the LHS filter key to a key property defined in the Vertex AI Search backend -- this mapping is defined by the customer in their schema. For example a media customers might have a field 'name' in their schema. In this case the filter would look like this: filter --> name:'ANY("king kong")' For more information about filtering including syntax and filter operators, see [Filter](https://cloud.google.com/generative-ai-app-builder/docs/filter-search-metadata) "maxReturnResults": 42, # Number of search results to return. The default value is 10. "orderBy": "A String", # The order in which documents are returned. Documents can be ordered by a field in an Document object. Leave it unset if ordered by relevance. `order_by` expression is case-sensitive. For more information on ordering, see [Ordering](https://cloud.google.com/retail/docs/filter-and-order#order) If this field is unrecognizable, an `INVALID_ARGUMENT` is returned. + "searchResultMode": "A String", # Specifies the search result mode. If unspecified, the search result mode is based on DataStore.DocumentProcessingConfig.chunking_config: * If DataStore.DocumentProcessingConfig.chunking_config is specified, it defaults to `CHUNKS`. * Otherwise, it defaults to `DOCUMENTS`. See [parse and chunk documents](https://cloud.google.com/generative-ai-app-builder/docs/parse-chunk-documents) }, "searchResultList": { # Search result list. # Search result list. "searchResults": [ # Search results. @@ -212,6 +213,9 @@

Method Details

}, }, "session": "A String", # The session resource name. Not required. When session field is not set, the API is in sessionless mode. We support auto session mode: users can use the wildcard symbol `-` as session ID. A new ID will be automatically generated and assigned. + "userLabels": { # The user labels applied to a resource must meet the following requirements: * Each resource can have multiple labels, up to a maximum of 64. * Each label must be a key-value pair. * Keys have a minimum length of 1 character and a maximum length of 63 characters and cannot be empty. Values can be empty and have a maximum length of 63 characters. * Keys and values can contain only lowercase letters, numeric characters, underscores, and dashes. All characters must use UTF-8 encoding, and international characters are allowed. * The key portion of a label must be unique. However, you can use the same key with multiple resources. * Keys must start with a lowercase letter or international character. See [Google Cloud Document](https://cloud.google.com/resource-manager/docs/creating-managing-labels#requirements) for more details. + "a_key": "A String", + }, "userPseudoId": "A String", # A unique identifier for tracking visitors. For example, this could be implemented with an HTTP cookie, which should be able to uniquely identify a visitor on a single device. This unique identifier should not change if the visitor logs in or out of the website. This field should NOT have a fixed value such as `unknown_visitor`. The field must be a UTF-8 encoded string with a length limit of 128 characters. Otherwise, an `INVALID_ARGUMENT` error is returned. } @@ -381,6 +385,10 @@

Method Details

], "genericConfig": { # Specifies the configurations needed for Generic Discovery.Currently we support: * `content_search_spec`: configuration for generic content search. # The GenericConfig of the serving configuration. "contentSearchSpec": { # A specification for configuring the behavior of content search. # Specifies the expected behavior of content search. Only valid for content-search enabled data store. + "chunkSpec": { # Specifies the chunk spec to be returned from the search response. Only available if the SearchRequest.ContentSearchSpec.search_result_mode is set to CHUNKS # Specifies the chunk spec to be returned from the search response. Only available if the SearchRequest.ContentSearchSpec.search_result_mode is set to CHUNKS + "numNextChunks": 42, # The number of next chunks to be returned of the current chunk. The maximum allowed value is 3. If not specified, no next chunks will be returned. + "numPreviousChunks": 42, # The number of previous chunks to be returned of the current chunk. The maximum allowed value is 3. If not specified, no previous chunks will be returned. + }, "extractiveContentSpec": { # A specification for configuring the extractive content in a search response. # If there is no extractive_content_spec provided, there will be no extractive answer in the search response. "maxExtractiveAnswerCount": 42, # The maximum number of extractive answers returned in each search result. An extractive answer is a verbatim answer extracted from the original document, which provides a precise and contextually relevant answer to the search query. If the number of matching answers is less than the `max_extractive_answer_count`, return all of the answers. Otherwise, return the `max_extractive_answer_count`. At most five answers are returned for each SearchResult. "maxExtractiveSegmentCount": 42, # The max number of extractive segments returned in each search result. Only applied if the DataStore is set to DataStore.ContentConfig.CONTENT_REQUIRED or DataStore.solution_types is SOLUTION_TYPE_CHAT. An extractive segment is a text segment extracted from the original document that is relevant to the search query, and, in general, more verbose than an extractive answer. The segment could then be used as input for LLMs to generate summaries and answers. If the number of matching segments is less than `max_extractive_segment_count`, return all of the segments. Otherwise, return the `max_extractive_segment_count`. @@ -388,6 +396,7 @@

Method Details

"numPreviousSegments": 42, # Specifies whether to also include the adjacent from each selected segments. Return at most `num_previous_segments` segments before each selected segments. "returnExtractiveSegmentScore": True or False, # Specifies whether to return the confidence score from the extractive segments in each search result. This feature is available only for new or allowlisted data stores. To allowlist your data store, contact your Customer Engineer. The default value is `false`. }, + "searchResultMode": "A String", # Specifies the search result mode. If unspecified, the search result mode is based on DataStore.DocumentProcessingConfig.chunking_config: * If DataStore.DocumentProcessingConfig.chunking_config is specified, it defaults to `CHUNKS`. * Otherwise, it defaults to `DOCUMENTS`. "snippetSpec": { # A specification for configuring snippets in a search response. # If `snippetSpec` is not specified, snippets are not included in the search response. "maxSnippetCount": 42, # [DEPRECATED] This field is deprecated. To control snippet return, use `return_snippet` field. For backwards compatibility, we will return snippet if max_snippet_count > 0. "referenceOnly": True or False, # [DEPRECATED] This field is deprecated and will have no affect on the snippet. @@ -475,6 +484,10 @@

Method Details

], "genericConfig": { # Specifies the configurations needed for Generic Discovery.Currently we support: * `content_search_spec`: configuration for generic content search. # The GenericConfig of the serving configuration. "contentSearchSpec": { # A specification for configuring the behavior of content search. # Specifies the expected behavior of content search. Only valid for content-search enabled data store. + "chunkSpec": { # Specifies the chunk spec to be returned from the search response. Only available if the SearchRequest.ContentSearchSpec.search_result_mode is set to CHUNKS # Specifies the chunk spec to be returned from the search response. Only available if the SearchRequest.ContentSearchSpec.search_result_mode is set to CHUNKS + "numNextChunks": 42, # The number of next chunks to be returned of the current chunk. The maximum allowed value is 3. If not specified, no next chunks will be returned. + "numPreviousChunks": 42, # The number of previous chunks to be returned of the current chunk. The maximum allowed value is 3. If not specified, no previous chunks will be returned. + }, "extractiveContentSpec": { # A specification for configuring the extractive content in a search response. # If there is no extractive_content_spec provided, there will be no extractive answer in the search response. "maxExtractiveAnswerCount": 42, # The maximum number of extractive answers returned in each search result. An extractive answer is a verbatim answer extracted from the original document, which provides a precise and contextually relevant answer to the search query. If the number of matching answers is less than the `max_extractive_answer_count`, return all of the answers. Otherwise, return the `max_extractive_answer_count`. At most five answers are returned for each SearchResult. "maxExtractiveSegmentCount": 42, # The max number of extractive segments returned in each search result. Only applied if the DataStore is set to DataStore.ContentConfig.CONTENT_REQUIRED or DataStore.solution_types is SOLUTION_TYPE_CHAT. An extractive segment is a text segment extracted from the original document that is relevant to the search query, and, in general, more verbose than an extractive answer. The segment could then be used as input for LLMs to generate summaries and answers. If the number of matching segments is less than `max_extractive_segment_count`, return all of the segments. Otherwise, return the `max_extractive_segment_count`. @@ -482,6 +495,7 @@

Method Details

"numPreviousSegments": 42, # Specifies whether to also include the adjacent from each selected segments. Return at most `num_previous_segments` segments before each selected segments. "returnExtractiveSegmentScore": True or False, # Specifies whether to return the confidence score from the extractive segments in each search result. This feature is available only for new or allowlisted data stores. To allowlist your data store, contact your Customer Engineer. The default value is `false`. }, + "searchResultMode": "A String", # Specifies the search result mode. If unspecified, the search result mode is based on DataStore.DocumentProcessingConfig.chunking_config: * If DataStore.DocumentProcessingConfig.chunking_config is specified, it defaults to `CHUNKS`. * Otherwise, it defaults to `DOCUMENTS`. "snippetSpec": { # A specification for configuring snippets in a search response. # If `snippetSpec` is not specified, snippets are not included in the search response. "maxSnippetCount": 42, # [DEPRECATED] This field is deprecated. To control snippet return, use `return_snippet` field. For backwards compatibility, we will return snippet if max_snippet_count > 0. "referenceOnly": True or False, # [DEPRECATED] This field is deprecated and will have no affect on the snippet. @@ -575,6 +589,10 @@

Method Details

], "genericConfig": { # Specifies the configurations needed for Generic Discovery.Currently we support: * `content_search_spec`: configuration for generic content search. # The GenericConfig of the serving configuration. "contentSearchSpec": { # A specification for configuring the behavior of content search. # Specifies the expected behavior of content search. Only valid for content-search enabled data store. + "chunkSpec": { # Specifies the chunk spec to be returned from the search response. Only available if the SearchRequest.ContentSearchSpec.search_result_mode is set to CHUNKS # Specifies the chunk spec to be returned from the search response. Only available if the SearchRequest.ContentSearchSpec.search_result_mode is set to CHUNKS + "numNextChunks": 42, # The number of next chunks to be returned of the current chunk. The maximum allowed value is 3. If not specified, no next chunks will be returned. + "numPreviousChunks": 42, # The number of previous chunks to be returned of the current chunk. The maximum allowed value is 3. If not specified, no previous chunks will be returned. + }, "extractiveContentSpec": { # A specification for configuring the extractive content in a search response. # If there is no extractive_content_spec provided, there will be no extractive answer in the search response. "maxExtractiveAnswerCount": 42, # The maximum number of extractive answers returned in each search result. An extractive answer is a verbatim answer extracted from the original document, which provides a precise and contextually relevant answer to the search query. If the number of matching answers is less than the `max_extractive_answer_count`, return all of the answers. Otherwise, return the `max_extractive_answer_count`. At most five answers are returned for each SearchResult. "maxExtractiveSegmentCount": 42, # The max number of extractive segments returned in each search result. Only applied if the DataStore is set to DataStore.ContentConfig.CONTENT_REQUIRED or DataStore.solution_types is SOLUTION_TYPE_CHAT. An extractive segment is a text segment extracted from the original document that is relevant to the search query, and, in general, more verbose than an extractive answer. The segment could then be used as input for LLMs to generate summaries and answers. If the number of matching segments is less than `max_extractive_segment_count`, return all of the segments. Otherwise, return the `max_extractive_segment_count`. @@ -582,6 +600,7 @@

Method Details

"numPreviousSegments": 42, # Specifies whether to also include the adjacent from each selected segments. Return at most `num_previous_segments` segments before each selected segments. "returnExtractiveSegmentScore": True or False, # Specifies whether to return the confidence score from the extractive segments in each search result. This feature is available only for new or allowlisted data stores. To allowlist your data store, contact your Customer Engineer. The default value is `false`. }, + "searchResultMode": "A String", # Specifies the search result mode. If unspecified, the search result mode is based on DataStore.DocumentProcessingConfig.chunking_config: * If DataStore.DocumentProcessingConfig.chunking_config is specified, it defaults to `CHUNKS`. * Otherwise, it defaults to `DOCUMENTS`. "snippetSpec": { # A specification for configuring snippets in a search response. # If `snippetSpec` is not specified, snippets are not included in the search response. "maxSnippetCount": 42, # [DEPRECATED] This field is deprecated. To control snippet return, use `return_snippet` field. For backwards compatibility, we will return snippet if max_snippet_count > 0. "referenceOnly": True or False, # [DEPRECATED] This field is deprecated and will have no affect on the snippet. @@ -658,6 +677,10 @@

Method Details

], "genericConfig": { # Specifies the configurations needed for Generic Discovery.Currently we support: * `content_search_spec`: configuration for generic content search. # The GenericConfig of the serving configuration. "contentSearchSpec": { # A specification for configuring the behavior of content search. # Specifies the expected behavior of content search. Only valid for content-search enabled data store. + "chunkSpec": { # Specifies the chunk spec to be returned from the search response. Only available if the SearchRequest.ContentSearchSpec.search_result_mode is set to CHUNKS # Specifies the chunk spec to be returned from the search response. Only available if the SearchRequest.ContentSearchSpec.search_result_mode is set to CHUNKS + "numNextChunks": 42, # The number of next chunks to be returned of the current chunk. The maximum allowed value is 3. If not specified, no next chunks will be returned. + "numPreviousChunks": 42, # The number of previous chunks to be returned of the current chunk. The maximum allowed value is 3. If not specified, no previous chunks will be returned. + }, "extractiveContentSpec": { # A specification for configuring the extractive content in a search response. # If there is no extractive_content_spec provided, there will be no extractive answer in the search response. "maxExtractiveAnswerCount": 42, # The maximum number of extractive answers returned in each search result. An extractive answer is a verbatim answer extracted from the original document, which provides a precise and contextually relevant answer to the search query. If the number of matching answers is less than the `max_extractive_answer_count`, return all of the answers. Otherwise, return the `max_extractive_answer_count`. At most five answers are returned for each SearchResult. "maxExtractiveSegmentCount": 42, # The max number of extractive segments returned in each search result. Only applied if the DataStore is set to DataStore.ContentConfig.CONTENT_REQUIRED or DataStore.solution_types is SOLUTION_TYPE_CHAT. An extractive segment is a text segment extracted from the original document that is relevant to the search query, and, in general, more verbose than an extractive answer. The segment could then be used as input for LLMs to generate summaries and answers. If the number of matching segments is less than `max_extractive_segment_count`, return all of the segments. Otherwise, return the `max_extractive_segment_count`. @@ -665,6 +688,7 @@

Method Details

"numPreviousSegments": 42, # Specifies whether to also include the adjacent from each selected segments. Return at most `num_previous_segments` segments before each selected segments. "returnExtractiveSegmentScore": True or False, # Specifies whether to return the confidence score from the extractive segments in each search result. This feature is available only for new or allowlisted data stores. To allowlist your data store, contact your Customer Engineer. The default value is `false`. }, + "searchResultMode": "A String", # Specifies the search result mode. If unspecified, the search result mode is based on DataStore.DocumentProcessingConfig.chunking_config: * If DataStore.DocumentProcessingConfig.chunking_config is specified, it defaults to `CHUNKS`. * Otherwise, it defaults to `DOCUMENTS`. "snippetSpec": { # A specification for configuring snippets in a search response. # If `snippetSpec` is not specified, snippets are not included in the search response. "maxSnippetCount": 42, # [DEPRECATED] This field is deprecated. To control snippet return, use `return_snippet` field. For backwards compatibility, we will return snippet if max_snippet_count > 0. "referenceOnly": True or False, # [DEPRECATED] This field is deprecated and will have no affect on the snippet. @@ -887,6 +911,10 @@

Method Details

"branch": "A String", # The branch resource name, such as `projects/*/locations/global/collections/default_collection/dataStores/default_data_store/branches/0`. Use `default_branch` as the branch ID or leave this field empty, to search documents under the default branch. "canonicalFilter": "A String", # The default filter that is applied when a user performs a search without checking any filters on the search page. The filter applied to every search request when quality improvement such as query expansion is needed. In the case a query does not have a sufficient amount of results this filter will be used to determine whether or not to enable the query expansion flow. The original filter will still be used for the query expanded search. This field is strongly recommended to achieve high search quality. For more information about filter syntax, see SearchRequest.filter. "contentSearchSpec": { # A specification for configuring the behavior of content search. # A specification for configuring the behavior of content search. + "chunkSpec": { # Specifies the chunk spec to be returned from the search response. Only available if the SearchRequest.ContentSearchSpec.search_result_mode is set to CHUNKS # Specifies the chunk spec to be returned from the search response. Only available if the SearchRequest.ContentSearchSpec.search_result_mode is set to CHUNKS + "numNextChunks": 42, # The number of next chunks to be returned of the current chunk. The maximum allowed value is 3. If not specified, no next chunks will be returned. + "numPreviousChunks": 42, # The number of previous chunks to be returned of the current chunk. The maximum allowed value is 3. If not specified, no previous chunks will be returned. + }, "extractiveContentSpec": { # A specification for configuring the extractive content in a search response. # If there is no extractive_content_spec provided, there will be no extractive answer in the search response. "maxExtractiveAnswerCount": 42, # The maximum number of extractive answers returned in each search result. An extractive answer is a verbatim answer extracted from the original document, which provides a precise and contextually relevant answer to the search query. If the number of matching answers is less than the `max_extractive_answer_count`, return all of the answers. Otherwise, return the `max_extractive_answer_count`. At most five answers are returned for each SearchResult. "maxExtractiveSegmentCount": 42, # The max number of extractive segments returned in each search result. Only applied if the DataStore is set to DataStore.ContentConfig.CONTENT_REQUIRED or DataStore.solution_types is SOLUTION_TYPE_CHAT. An extractive segment is a text segment extracted from the original document that is relevant to the search query, and, in general, more verbose than an extractive answer. The segment could then be used as input for LLMs to generate summaries and answers. If the number of matching segments is less than `max_extractive_segment_count`, return all of the segments. Otherwise, return the `max_extractive_segment_count`. @@ -894,6 +922,7 @@

Method Details

"numPreviousSegments": 42, # Specifies whether to also include the adjacent from each selected segments. Return at most `num_previous_segments` segments before each selected segments. "returnExtractiveSegmentScore": True or False, # Specifies whether to return the confidence score from the extractive segments in each search result. This feature is available only for new or allowlisted data stores. To allowlist your data store, contact your Customer Engineer. The default value is `false`. }, + "searchResultMode": "A String", # Specifies the search result mode. If unspecified, the search result mode is based on DataStore.DocumentProcessingConfig.chunking_config: * If DataStore.DocumentProcessingConfig.chunking_config is specified, it defaults to `CHUNKS`. * Otherwise, it defaults to `DOCUMENTS`. "snippetSpec": { # A specification for configuring snippets in a search response. # If `snippetSpec` is not specified, snippets are not included in the search response. "maxSnippetCount": 42, # [DEPRECATED] This field is deprecated. To control snippet return, use `return_snippet` field. For backwards compatibility, we will return snippet if max_snippet_count > 0. "referenceOnly": True or False, # [DEPRECATED] This field is deprecated and will have no affect on the snippet. @@ -1048,6 +1077,34 @@

Method Details

"redirectUri": "A String", # The URI of a customer-defined redirect page. If redirect action is triggered, no search is performed, and only redirect_uri and attribution_token are set in the response. "results": [ # A list of matched documents. The order represents the ranking. { # Represents the search results. + "chunk": { # Chunk captures all raw metadata information of items to be recommended or searched in the chunk mode. # The chunk data in the search response if the SearchRequest.ContentSearchSpec.search_result_mode is set to CHUNKS. + "chunkMetadata": { # Metadata of the current chunk. This field is only populated on SearchService.Search API. # Output only. Metadata of the current chunk. + "nextChunks": [ # The next chunks of the current chunk. The number is controlled by SearchRequest.ContentSearchSpec.ChunkSpec.num_next_chunks. This field is only populated on SearchService.Search API. + # Object with schema name: GoogleCloudDiscoveryengineV1betaChunk + ], + "previousChunks": [ # The previous chunks of the current chunk. The number is controlled by SearchRequest.ContentSearchSpec.ChunkSpec.num_previous_chunks. This field is only populated on SearchService.Search API. + # Object with schema name: GoogleCloudDiscoveryengineV1betaChunk + ], + }, + "content": "A String", # Content is a string from a document (parsed content). + "derivedStructData": { # Output only. This field is OUTPUT_ONLY. It contains derived data that are not in the original input document. + "a_key": "", # Properties of the object. + }, + "documentMetadata": { # Document metadata contains the information of the document of the current chunk. # Metadata of the document from the current chunk. + "structData": { # Data representation. The structured JSON data for the document. It should conform to the registered Schema or an `INVALID_ARGUMENT` error is thrown. + "a_key": "", # Properties of the object. + }, + "title": "A String", # Title of the document. + "uri": "A String", # Uri of the document. + }, + "id": "A String", # Unique chunk ID of the current chunk. + "name": "A String", # The full resource name of the chunk. Format: `projects/{project}/locations/{location}/collections/{collection}/dataStores/{data_store}/branches/{branch}/documents/{document_id}/chunks/{chunk_id}`. This field must be a UTF-8 encoded string with a length limit of 1024 characters. + "pageSpan": { # Page span of the chunk. # Page span of the chunk. + "pageEnd": 42, # The end page of the chunk. + "pageStart": 42, # The start page of the chunk. + }, + "relevanceScore": 3.14, # Output only. Represents the relevance score based on similarity. Higher score indicates higher chunk relevance. The score is in range [-1.0, 1.0]. Only populated on SearchService.SearchResponse. + }, "document": { # Document captures all raw metadata information of items to be recommended or searched. # The document data snippet in the search response. Only fields that are marked as `retrievable` are populated. "content": { # Unstructured data linked to this document. # The unstructured data linked to this document. Content must be set if this document is under a `CONTENT_REQUIRED` data store. "mimeType": "A String", # The MIME type of the content. Supported types: * `application/pdf` (PDF, only native PDFs are supported for now) * `text/html` (HTML) * `application/vnd.openxmlformats-officedocument.wordprocessingml.document` (DOCX) * `application/vnd.openxmlformats-officedocument.presentationml.presentation` (PPTX) * `text/plain` (TXT) See https://www.iana.org/assignments/media-types/media-types.xhtml. diff --git a/docs/dyn/discoveryengine_v1beta.projects.locations.dataStores.branches.documents.html b/docs/dyn/discoveryengine_v1beta.projects.locations.dataStores.branches.documents.html index c294dbecb44..dee1da8aee1 100644 --- a/docs/dyn/discoveryengine_v1beta.projects.locations.dataStores.branches.documents.html +++ b/docs/dyn/discoveryengine_v1beta.projects.locations.dataStores.branches.documents.html @@ -229,6 +229,14 @@

Method Details

The object takes the form of: { # Request message for Import methods. + "alloyDbSource": { # AlloyDB source import data from. # AlloyDB input source. + "clusterId": "A String", # Required. The AlloyDB cluster to copy the data from with a length limit of 256 characters. + "databaseId": "A String", # Required. The AlloyDB database to copy the data from with a length limit of 256 characters. + "gcsStagingDir": "A String", # Intermediate Cloud Storage directory used for the import with a length limit of 2,000 characters. Can be specified if one wants to have the AlloyDB export to a specific Cloud Storage directory. Ensure that the AlloyDB service account has the necessary Cloud Storage Admin permissions to access the specified Cloud Storage directory. + "locationId": "A String", # Required. The AlloyDB location to copy the data from with a length limit of 256 characters. + "projectId": "A String", # The project ID that the AlloyDB source is in with a length limit of 128 characters. If not specified, inherits the project ID from the parent request. + "tableId": "A String", # Required. The AlloyDB table to copy the data from with a length limit of 256 characters. + }, "autoGenerateIds": True or False, # Whether to automatically generate IDs for the documents if absent. If set to `true`, Document.ids are automatically generated based on the hash of the payload, where IDs may not be consistent during multiple imports. In which case ReconciliationMode.FULL is highly recommended to avoid duplicate contents. If unset or set to `false`, Document.ids have to be specified using id_field, otherwise, documents without IDs fail to be imported. Supported data sources: * GcsSource. GcsSource.data_schema must be `custom` or `csv`. Otherwise, an INVALID_ARGUMENT error is thrown. * BigQuerySource. BigQuerySource.data_schema must be `custom` or `csv`. Otherwise, an INVALID_ARGUMENT error is thrown. * SpannerSource. * CloudSqlSource. * FirestoreSource. * BigtableSource. "bigquerySource": { # BigQuery source import data from. # BigQuery input source. "dataSchema": "A String", # The schema to use when parsing the data from the source. Supported values for user event imports: * `user_event` (default): One UserEvent per row. Supported values for document imports: * `document` (default): One Document format per row. Each document must have a valid Document.id and one of Document.json_data or Document.struct_data. * `custom`: One custom data per row in arbitrary format that conforms to the defined Schema of the data store. This can only be used by the GENERIC Data Store vertical. diff --git a/docs/dyn/discoveryengine_v1beta.projects.locations.dataStores.controls.html b/docs/dyn/discoveryengine_v1beta.projects.locations.dataStores.controls.html index f3ccc09fd10..370c8a9c8af 100644 --- a/docs/dyn/discoveryengine_v1beta.projects.locations.dataStores.controls.html +++ b/docs/dyn/discoveryengine_v1beta.projects.locations.dataStores.controls.html @@ -106,7 +106,7 @@

Method Details

Creates a Control. By default 1000 controls are allowed for a data store. A request can be submitted to adjust this limit. If the Control to create already exists, an ALREADY_EXISTS error is returned.
 
 Args:
-  parent: string, Required. Full resource name of parent data store. Format: `projects/{project_number}/locations/{location_id}/collections/{collection_id}/dataStores/{data_store_id}` (required)
+  parent: string, Required. Full resource name of parent data store. Format: `projects/{project_number}/locations/{location_id}/collections/{collection_id}/dataStores/{data_store_id}` or `projects/{project_number}/locations/{location_id}/collections/{collection_id}/engines/{engine_id}`. (required)
   body: object, The request body.
     The object takes the form of:
 
@@ -293,7 +293,7 @@ 

Method Details

Lists all Controls by their parent DataStore.
 
 Args:
-  parent: string, Required. The data store resource name. Format: `projects/{project_number}/locations/{location_id}/collections/{collection_id}/dataStores/{data_store_id}` (required)
+  parent: string, Required. The data store resource name. Format: `projects/{project_number}/locations/{location_id}/collections/{collection_id}/dataStores/{data_store_id}` or `projects/{project_number}/locations/{location_id}/collections/{collection_id}/engines/{engine_id}`. (required)
   filter: string, Optional. A filter to apply on the list results. Supported features: * List all the products under the parent branch if filter is unset. Currently this field is unsupported.
   pageSize: integer, Optional. Maximum number of results to return. If unspecified, defaults to 50. Max allowed value is 1000.
   pageToken: string, Optional. A page token, received from a previous `ListControls` call. Provide this to retrieve the subsequent page.
diff --git a/docs/dyn/discoveryengine_v1beta.projects.locations.dataStores.conversations.html b/docs/dyn/discoveryengine_v1beta.projects.locations.dataStores.conversations.html
index 2ded6e3f376..4683134eb75 100644
--- a/docs/dyn/discoveryengine_v1beta.projects.locations.dataStores.conversations.html
+++ b/docs/dyn/discoveryengine_v1beta.projects.locations.dataStores.conversations.html
@@ -382,6 +382,34 @@ 

Method Details

}, "searchResults": [ # Search Results. { # Represents the search results. + "chunk": { # Chunk captures all raw metadata information of items to be recommended or searched in the chunk mode. # The chunk data in the search response if the SearchRequest.ContentSearchSpec.search_result_mode is set to CHUNKS. + "chunkMetadata": { # Metadata of the current chunk. This field is only populated on SearchService.Search API. # Output only. Metadata of the current chunk. + "nextChunks": [ # The next chunks of the current chunk. The number is controlled by SearchRequest.ContentSearchSpec.ChunkSpec.num_next_chunks. This field is only populated on SearchService.Search API. + # Object with schema name: GoogleCloudDiscoveryengineV1betaChunk + ], + "previousChunks": [ # The previous chunks of the current chunk. The number is controlled by SearchRequest.ContentSearchSpec.ChunkSpec.num_previous_chunks. This field is only populated on SearchService.Search API. + # Object with schema name: GoogleCloudDiscoveryengineV1betaChunk + ], + }, + "content": "A String", # Content is a string from a document (parsed content). + "derivedStructData": { # Output only. This field is OUTPUT_ONLY. It contains derived data that are not in the original input document. + "a_key": "", # Properties of the object. + }, + "documentMetadata": { # Document metadata contains the information of the document of the current chunk. # Metadata of the document from the current chunk. + "structData": { # Data representation. The structured JSON data for the document. It should conform to the registered Schema or an `INVALID_ARGUMENT` error is thrown. + "a_key": "", # Properties of the object. + }, + "title": "A String", # Title of the document. + "uri": "A String", # Uri of the document. + }, + "id": "A String", # Unique chunk ID of the current chunk. + "name": "A String", # The full resource name of the chunk. Format: `projects/{project}/locations/{location}/collections/{collection}/dataStores/{data_store}/branches/{branch}/documents/{document_id}/chunks/{chunk_id}`. This field must be a UTF-8 encoded string with a length limit of 1024 characters. + "pageSpan": { # Page span of the chunk. # Page span of the chunk. + "pageEnd": 42, # The end page of the chunk. + "pageStart": 42, # The start page of the chunk. + }, + "relevanceScore": 3.14, # Output only. Represents the relevance score based on similarity. Higher score indicates higher chunk relevance. The score is in range [-1.0, 1.0]. Only populated on SearchService.SearchResponse. + }, "document": { # Document captures all raw metadata information of items to be recommended or searched. # The document data snippet in the search response. Only fields that are marked as `retrievable` are populated. "content": { # Unstructured data linked to this document. # The unstructured data linked to this document. Content must be set if this document is under a `CONTENT_REQUIRED` data store. "mimeType": "A String", # The MIME type of the content. Supported types: * `application/pdf` (PDF, only native PDFs are supported for now) * `text/html` (HTML) * `application/vnd.openxmlformats-officedocument.wordprocessingml.document` (DOCX) * `application/vnd.openxmlformats-officedocument.presentationml.presentation` (PPTX) * `text/plain` (TXT) See https://www.iana.org/assignments/media-types/media-types.xhtml. diff --git a/docs/dyn/discoveryengine_v1beta.projects.locations.dataStores.html b/docs/dyn/discoveryengine_v1beta.projects.locations.dataStores.html index 46ad7b62416..c5367dfb249 100644 --- a/docs/dyn/discoveryengine_v1beta.projects.locations.dataStores.html +++ b/docs/dyn/discoveryengine_v1beta.projects.locations.dataStores.html @@ -208,9 +208,17 @@

Method Details

"defaultSchemaId": "A String", # Output only. The id of the default Schema asscociated to this data store. "displayName": "A String", # Required. The data store display name. This field must be a UTF-8 encoded string with a length limit of 128 characters. Otherwise, an INVALID_ARGUMENT error is returned. "documentProcessingConfig": { # A singleton resource of DataStore. It's empty when DataStore is created, which defaults to digital parser. The first call to DataStoreService.UpdateDocumentProcessingConfig method will initialize the config. # Configuration for Document understanding and enrichment. + "chunkingConfig": { # Configuration for chunking config. # Whether chunking mode is enabled. + "layoutBasedChunkingConfig": { # Configuration for the layout based chunking. # Configuration for the layout based chunking. + "chunkSize": 42, # The token size limit for each chunk. Supported values: 100-500 (inclusive). Default value: 500. + "includeAncestorHeadings": True or False, # Whether to include appending different levels of headings to chunks from the middle of the document to prevent context loss. Default value: False. + }, + }, "defaultParsingConfig": { # Related configurations applied to a specific type of document parser. # Configurations for default Document parser. If not specified, we will configure it as default DigitalParsingConfig, and the default parsing config will be applied to all file types for Document parsing. "digitalParsingConfig": { # The digital parsing configurations for documents. # Configurations applied to digital parser. }, + "layoutParsingConfig": { # The layout parsing configurations for documents. # Configurations applied to layout parser. + }, "ocrParsingConfig": { # The OCR parsing configurations for documents. # Configurations applied to OCR parser. Currently it only applies to PDFs. "enhancedDocumentElements": [ # [DEPRECATED] This field is deprecated. To use the additional enhanced document elements processing, please switch to `layout_parsing_config`. "A String", @@ -223,6 +231,8 @@

Method Details

"a_key": { # Related configurations applied to a specific type of document parser. "digitalParsingConfig": { # The digital parsing configurations for documents. # Configurations applied to digital parser. }, + "layoutParsingConfig": { # The layout parsing configurations for documents. # Configurations applied to layout parser. + }, "ocrParsingConfig": { # The OCR parsing configurations for documents. # Configurations applied to OCR parser. Currently it only applies to PDFs. "enhancedDocumentElements": [ # [DEPRECATED] This field is deprecated. To use the additional enhanced document elements processing, please switch to `layout_parsing_config`. "A String", @@ -332,9 +342,17 @@

Method Details

"defaultSchemaId": "A String", # Output only. The id of the default Schema asscociated to this data store. "displayName": "A String", # Required. The data store display name. This field must be a UTF-8 encoded string with a length limit of 128 characters. Otherwise, an INVALID_ARGUMENT error is returned. "documentProcessingConfig": { # A singleton resource of DataStore. It's empty when DataStore is created, which defaults to digital parser. The first call to DataStoreService.UpdateDocumentProcessingConfig method will initialize the config. # Configuration for Document understanding and enrichment. + "chunkingConfig": { # Configuration for chunking config. # Whether chunking mode is enabled. + "layoutBasedChunkingConfig": { # Configuration for the layout based chunking. # Configuration for the layout based chunking. + "chunkSize": 42, # The token size limit for each chunk. Supported values: 100-500 (inclusive). Default value: 500. + "includeAncestorHeadings": True or False, # Whether to include appending different levels of headings to chunks from the middle of the document to prevent context loss. Default value: False. + }, + }, "defaultParsingConfig": { # Related configurations applied to a specific type of document parser. # Configurations for default Document parser. If not specified, we will configure it as default DigitalParsingConfig, and the default parsing config will be applied to all file types for Document parsing. "digitalParsingConfig": { # The digital parsing configurations for documents. # Configurations applied to digital parser. }, + "layoutParsingConfig": { # The layout parsing configurations for documents. # Configurations applied to layout parser. + }, "ocrParsingConfig": { # The OCR parsing configurations for documents. # Configurations applied to OCR parser. Currently it only applies to PDFs. "enhancedDocumentElements": [ # [DEPRECATED] This field is deprecated. To use the additional enhanced document elements processing, please switch to `layout_parsing_config`. "A String", @@ -347,6 +365,8 @@

Method Details

"a_key": { # Related configurations applied to a specific type of document parser. "digitalParsingConfig": { # The digital parsing configurations for documents. # Configurations applied to digital parser. }, + "layoutParsingConfig": { # The layout parsing configurations for documents. # Configurations applied to layout parser. + }, "ocrParsingConfig": { # The OCR parsing configurations for documents. # Configurations applied to OCR parser. Currently it only applies to PDFs. "enhancedDocumentElements": [ # [DEPRECATED] This field is deprecated. To use the additional enhanced document elements processing, please switch to `layout_parsing_config`. "A String", @@ -415,9 +435,17 @@

Method Details

"defaultSchemaId": "A String", # Output only. The id of the default Schema asscociated to this data store. "displayName": "A String", # Required. The data store display name. This field must be a UTF-8 encoded string with a length limit of 128 characters. Otherwise, an INVALID_ARGUMENT error is returned. "documentProcessingConfig": { # A singleton resource of DataStore. It's empty when DataStore is created, which defaults to digital parser. The first call to DataStoreService.UpdateDocumentProcessingConfig method will initialize the config. # Configuration for Document understanding and enrichment. + "chunkingConfig": { # Configuration for chunking config. # Whether chunking mode is enabled. + "layoutBasedChunkingConfig": { # Configuration for the layout based chunking. # Configuration for the layout based chunking. + "chunkSize": 42, # The token size limit for each chunk. Supported values: 100-500 (inclusive). Default value: 500. + "includeAncestorHeadings": True or False, # Whether to include appending different levels of headings to chunks from the middle of the document to prevent context loss. Default value: False. + }, + }, "defaultParsingConfig": { # Related configurations applied to a specific type of document parser. # Configurations for default Document parser. If not specified, we will configure it as default DigitalParsingConfig, and the default parsing config will be applied to all file types for Document parsing. "digitalParsingConfig": { # The digital parsing configurations for documents. # Configurations applied to digital parser. }, + "layoutParsingConfig": { # The layout parsing configurations for documents. # Configurations applied to layout parser. + }, "ocrParsingConfig": { # The OCR parsing configurations for documents. # Configurations applied to OCR parser. Currently it only applies to PDFs. "enhancedDocumentElements": [ # [DEPRECATED] This field is deprecated. To use the additional enhanced document elements processing, please switch to `layout_parsing_config`. "A String", @@ -430,6 +458,8 @@

Method Details

"a_key": { # Related configurations applied to a specific type of document parser. "digitalParsingConfig": { # The digital parsing configurations for documents. # Configurations applied to digital parser. }, + "layoutParsingConfig": { # The layout parsing configurations for documents. # Configurations applied to layout parser. + }, "ocrParsingConfig": { # The OCR parsing configurations for documents. # Configurations applied to OCR parser. Currently it only applies to PDFs. "enhancedDocumentElements": [ # [DEPRECATED] This field is deprecated. To use the additional enhanced document elements processing, please switch to `layout_parsing_config`. "A String", @@ -486,9 +516,17 @@

Method Details

"defaultSchemaId": "A String", # Output only. The id of the default Schema asscociated to this data store. "displayName": "A String", # Required. The data store display name. This field must be a UTF-8 encoded string with a length limit of 128 characters. Otherwise, an INVALID_ARGUMENT error is returned. "documentProcessingConfig": { # A singleton resource of DataStore. It's empty when DataStore is created, which defaults to digital parser. The first call to DataStoreService.UpdateDocumentProcessingConfig method will initialize the config. # Configuration for Document understanding and enrichment. + "chunkingConfig": { # Configuration for chunking config. # Whether chunking mode is enabled. + "layoutBasedChunkingConfig": { # Configuration for the layout based chunking. # Configuration for the layout based chunking. + "chunkSize": 42, # The token size limit for each chunk. Supported values: 100-500 (inclusive). Default value: 500. + "includeAncestorHeadings": True or False, # Whether to include appending different levels of headings to chunks from the middle of the document to prevent context loss. Default value: False. + }, + }, "defaultParsingConfig": { # Related configurations applied to a specific type of document parser. # Configurations for default Document parser. If not specified, we will configure it as default DigitalParsingConfig, and the default parsing config will be applied to all file types for Document parsing. "digitalParsingConfig": { # The digital parsing configurations for documents. # Configurations applied to digital parser. }, + "layoutParsingConfig": { # The layout parsing configurations for documents. # Configurations applied to layout parser. + }, "ocrParsingConfig": { # The OCR parsing configurations for documents. # Configurations applied to OCR parser. Currently it only applies to PDFs. "enhancedDocumentElements": [ # [DEPRECATED] This field is deprecated. To use the additional enhanced document elements processing, please switch to `layout_parsing_config`. "A String", @@ -501,6 +539,8 @@

Method Details

"a_key": { # Related configurations applied to a specific type of document parser. "digitalParsingConfig": { # The digital parsing configurations for documents. # Configurations applied to digital parser. }, + "layoutParsingConfig": { # The layout parsing configurations for documents. # Configurations applied to layout parser. + }, "ocrParsingConfig": { # The OCR parsing configurations for documents. # Configurations applied to OCR parser. Currently it only applies to PDFs. "enhancedDocumentElements": [ # [DEPRECATED] This field is deprecated. To use the additional enhanced document elements processing, please switch to `layout_parsing_config`. "A String", @@ -539,9 +579,17 @@

Method Details

"defaultSchemaId": "A String", # Output only. The id of the default Schema asscociated to this data store. "displayName": "A String", # Required. The data store display name. This field must be a UTF-8 encoded string with a length limit of 128 characters. Otherwise, an INVALID_ARGUMENT error is returned. "documentProcessingConfig": { # A singleton resource of DataStore. It's empty when DataStore is created, which defaults to digital parser. The first call to DataStoreService.UpdateDocumentProcessingConfig method will initialize the config. # Configuration for Document understanding and enrichment. + "chunkingConfig": { # Configuration for chunking config. # Whether chunking mode is enabled. + "layoutBasedChunkingConfig": { # Configuration for the layout based chunking. # Configuration for the layout based chunking. + "chunkSize": 42, # The token size limit for each chunk. Supported values: 100-500 (inclusive). Default value: 500. + "includeAncestorHeadings": True or False, # Whether to include appending different levels of headings to chunks from the middle of the document to prevent context loss. Default value: False. + }, + }, "defaultParsingConfig": { # Related configurations applied to a specific type of document parser. # Configurations for default Document parser. If not specified, we will configure it as default DigitalParsingConfig, and the default parsing config will be applied to all file types for Document parsing. "digitalParsingConfig": { # The digital parsing configurations for documents. # Configurations applied to digital parser. }, + "layoutParsingConfig": { # The layout parsing configurations for documents. # Configurations applied to layout parser. + }, "ocrParsingConfig": { # The OCR parsing configurations for documents. # Configurations applied to OCR parser. Currently it only applies to PDFs. "enhancedDocumentElements": [ # [DEPRECATED] This field is deprecated. To use the additional enhanced document elements processing, please switch to `layout_parsing_config`. "A String", @@ -554,6 +602,8 @@

Method Details

"a_key": { # Related configurations applied to a specific type of document parser. "digitalParsingConfig": { # The digital parsing configurations for documents. # Configurations applied to digital parser. }, + "layoutParsingConfig": { # The layout parsing configurations for documents. # Configurations applied to layout parser. + }, "ocrParsingConfig": { # The OCR parsing configurations for documents. # Configurations applied to OCR parser. Currently it only applies to PDFs. "enhancedDocumentElements": [ # [DEPRECATED] This field is deprecated. To use the additional enhanced document elements processing, please switch to `layout_parsing_config`. "A String", diff --git a/docs/dyn/discoveryengine_v1beta.projects.locations.dataStores.servingConfigs.html b/docs/dyn/discoveryengine_v1beta.projects.locations.dataStores.servingConfigs.html index b8d7f5de439..c100c9b54f4 100644 --- a/docs/dyn/discoveryengine_v1beta.projects.locations.dataStores.servingConfigs.html +++ b/docs/dyn/discoveryengine_v1beta.projects.locations.dataStores.servingConfigs.html @@ -176,6 +176,7 @@

Method Details

"filter": "A String", # The filter syntax consists of an expression language for constructing a predicate from one or more fields of the documents being filtered. Filter expression is case-sensitive. This will be used to filter search results which may affect the Answer response. If this field is unrecognizable, an `INVALID_ARGUMENT` is returned. Filtering in Vertex AI Search is done by mapping the LHS filter key to a key property defined in the Vertex AI Search backend -- this mapping is defined by the customer in their schema. For example a media customers might have a field 'name' in their schema. In this case the filter would look like this: filter --> name:'ANY("king kong")' For more information about filtering including syntax and filter operators, see [Filter](https://cloud.google.com/generative-ai-app-builder/docs/filter-search-metadata) "maxReturnResults": 42, # Number of search results to return. The default value is 10. "orderBy": "A String", # The order in which documents are returned. Documents can be ordered by a field in an Document object. Leave it unset if ordered by relevance. `order_by` expression is case-sensitive. For more information on ordering, see [Ordering](https://cloud.google.com/retail/docs/filter-and-order#order) If this field is unrecognizable, an `INVALID_ARGUMENT` is returned. + "searchResultMode": "A String", # Specifies the search result mode. If unspecified, the search result mode is based on DataStore.DocumentProcessingConfig.chunking_config: * If DataStore.DocumentProcessingConfig.chunking_config is specified, it defaults to `CHUNKS`. * Otherwise, it defaults to `DOCUMENTS`. See [parse and chunk documents](https://cloud.google.com/generative-ai-app-builder/docs/parse-chunk-documents) }, "searchResultList": { # Search result list. # Search result list. "searchResults": [ # Search results. @@ -212,6 +213,9 @@

Method Details

}, }, "session": "A String", # The session resource name. Not required. When session field is not set, the API is in sessionless mode. We support auto session mode: users can use the wildcard symbol `-` as session ID. A new ID will be automatically generated and assigned. + "userLabels": { # The user labels applied to a resource must meet the following requirements: * Each resource can have multiple labels, up to a maximum of 64. * Each label must be a key-value pair. * Keys have a minimum length of 1 character and a maximum length of 63 characters and cannot be empty. Values can be empty and have a maximum length of 63 characters. * Keys and values can contain only lowercase letters, numeric characters, underscores, and dashes. All characters must use UTF-8 encoding, and international characters are allowed. * The key portion of a label must be unique. However, you can use the same key with multiple resources. * Keys must start with a lowercase letter or international character. See [Google Cloud Document](https://cloud.google.com/resource-manager/docs/creating-managing-labels#requirements) for more details. + "a_key": "A String", + }, "userPseudoId": "A String", # A unique identifier for tracking visitors. For example, this could be implemented with an HTTP cookie, which should be able to uniquely identify a visitor on a single device. This unique identifier should not change if the visitor logs in or out of the website. This field should NOT have a fixed value such as `unknown_visitor`. The field must be a UTF-8 encoded string with a length limit of 128 characters. Otherwise, an `INVALID_ARGUMENT` error is returned. } @@ -381,6 +385,10 @@

Method Details

], "genericConfig": { # Specifies the configurations needed for Generic Discovery.Currently we support: * `content_search_spec`: configuration for generic content search. # The GenericConfig of the serving configuration. "contentSearchSpec": { # A specification for configuring the behavior of content search. # Specifies the expected behavior of content search. Only valid for content-search enabled data store. + "chunkSpec": { # Specifies the chunk spec to be returned from the search response. Only available if the SearchRequest.ContentSearchSpec.search_result_mode is set to CHUNKS # Specifies the chunk spec to be returned from the search response. Only available if the SearchRequest.ContentSearchSpec.search_result_mode is set to CHUNKS + "numNextChunks": 42, # The number of next chunks to be returned of the current chunk. The maximum allowed value is 3. If not specified, no next chunks will be returned. + "numPreviousChunks": 42, # The number of previous chunks to be returned of the current chunk. The maximum allowed value is 3. If not specified, no previous chunks will be returned. + }, "extractiveContentSpec": { # A specification for configuring the extractive content in a search response. # If there is no extractive_content_spec provided, there will be no extractive answer in the search response. "maxExtractiveAnswerCount": 42, # The maximum number of extractive answers returned in each search result. An extractive answer is a verbatim answer extracted from the original document, which provides a precise and contextually relevant answer to the search query. If the number of matching answers is less than the `max_extractive_answer_count`, return all of the answers. Otherwise, return the `max_extractive_answer_count`. At most five answers are returned for each SearchResult. "maxExtractiveSegmentCount": 42, # The max number of extractive segments returned in each search result. Only applied if the DataStore is set to DataStore.ContentConfig.CONTENT_REQUIRED or DataStore.solution_types is SOLUTION_TYPE_CHAT. An extractive segment is a text segment extracted from the original document that is relevant to the search query, and, in general, more verbose than an extractive answer. The segment could then be used as input for LLMs to generate summaries and answers. If the number of matching segments is less than `max_extractive_segment_count`, return all of the segments. Otherwise, return the `max_extractive_segment_count`. @@ -388,6 +396,7 @@

Method Details

"numPreviousSegments": 42, # Specifies whether to also include the adjacent from each selected segments. Return at most `num_previous_segments` segments before each selected segments. "returnExtractiveSegmentScore": True or False, # Specifies whether to return the confidence score from the extractive segments in each search result. This feature is available only for new or allowlisted data stores. To allowlist your data store, contact your Customer Engineer. The default value is `false`. }, + "searchResultMode": "A String", # Specifies the search result mode. If unspecified, the search result mode is based on DataStore.DocumentProcessingConfig.chunking_config: * If DataStore.DocumentProcessingConfig.chunking_config is specified, it defaults to `CHUNKS`. * Otherwise, it defaults to `DOCUMENTS`. "snippetSpec": { # A specification for configuring snippets in a search response. # If `snippetSpec` is not specified, snippets are not included in the search response. "maxSnippetCount": 42, # [DEPRECATED] This field is deprecated. To control snippet return, use `return_snippet` field. For backwards compatibility, we will return snippet if max_snippet_count > 0. "referenceOnly": True or False, # [DEPRECATED] This field is deprecated and will have no affect on the snippet. @@ -475,6 +484,10 @@

Method Details

], "genericConfig": { # Specifies the configurations needed for Generic Discovery.Currently we support: * `content_search_spec`: configuration for generic content search. # The GenericConfig of the serving configuration. "contentSearchSpec": { # A specification for configuring the behavior of content search. # Specifies the expected behavior of content search. Only valid for content-search enabled data store. + "chunkSpec": { # Specifies the chunk spec to be returned from the search response. Only available if the SearchRequest.ContentSearchSpec.search_result_mode is set to CHUNKS # Specifies the chunk spec to be returned from the search response. Only available if the SearchRequest.ContentSearchSpec.search_result_mode is set to CHUNKS + "numNextChunks": 42, # The number of next chunks to be returned of the current chunk. The maximum allowed value is 3. If not specified, no next chunks will be returned. + "numPreviousChunks": 42, # The number of previous chunks to be returned of the current chunk. The maximum allowed value is 3. If not specified, no previous chunks will be returned. + }, "extractiveContentSpec": { # A specification for configuring the extractive content in a search response. # If there is no extractive_content_spec provided, there will be no extractive answer in the search response. "maxExtractiveAnswerCount": 42, # The maximum number of extractive answers returned in each search result. An extractive answer is a verbatim answer extracted from the original document, which provides a precise and contextually relevant answer to the search query. If the number of matching answers is less than the `max_extractive_answer_count`, return all of the answers. Otherwise, return the `max_extractive_answer_count`. At most five answers are returned for each SearchResult. "maxExtractiveSegmentCount": 42, # The max number of extractive segments returned in each search result. Only applied if the DataStore is set to DataStore.ContentConfig.CONTENT_REQUIRED or DataStore.solution_types is SOLUTION_TYPE_CHAT. An extractive segment is a text segment extracted from the original document that is relevant to the search query, and, in general, more verbose than an extractive answer. The segment could then be used as input for LLMs to generate summaries and answers. If the number of matching segments is less than `max_extractive_segment_count`, return all of the segments. Otherwise, return the `max_extractive_segment_count`. @@ -482,6 +495,7 @@

Method Details

"numPreviousSegments": 42, # Specifies whether to also include the adjacent from each selected segments. Return at most `num_previous_segments` segments before each selected segments. "returnExtractiveSegmentScore": True or False, # Specifies whether to return the confidence score from the extractive segments in each search result. This feature is available only for new or allowlisted data stores. To allowlist your data store, contact your Customer Engineer. The default value is `false`. }, + "searchResultMode": "A String", # Specifies the search result mode. If unspecified, the search result mode is based on DataStore.DocumentProcessingConfig.chunking_config: * If DataStore.DocumentProcessingConfig.chunking_config is specified, it defaults to `CHUNKS`. * Otherwise, it defaults to `DOCUMENTS`. "snippetSpec": { # A specification for configuring snippets in a search response. # If `snippetSpec` is not specified, snippets are not included in the search response. "maxSnippetCount": 42, # [DEPRECATED] This field is deprecated. To control snippet return, use `return_snippet` field. For backwards compatibility, we will return snippet if max_snippet_count > 0. "referenceOnly": True or False, # [DEPRECATED] This field is deprecated and will have no affect on the snippet. @@ -575,6 +589,10 @@

Method Details

], "genericConfig": { # Specifies the configurations needed for Generic Discovery.Currently we support: * `content_search_spec`: configuration for generic content search. # The GenericConfig of the serving configuration. "contentSearchSpec": { # A specification for configuring the behavior of content search. # Specifies the expected behavior of content search. Only valid for content-search enabled data store. + "chunkSpec": { # Specifies the chunk spec to be returned from the search response. Only available if the SearchRequest.ContentSearchSpec.search_result_mode is set to CHUNKS # Specifies the chunk spec to be returned from the search response. Only available if the SearchRequest.ContentSearchSpec.search_result_mode is set to CHUNKS + "numNextChunks": 42, # The number of next chunks to be returned of the current chunk. The maximum allowed value is 3. If not specified, no next chunks will be returned. + "numPreviousChunks": 42, # The number of previous chunks to be returned of the current chunk. The maximum allowed value is 3. If not specified, no previous chunks will be returned. + }, "extractiveContentSpec": { # A specification for configuring the extractive content in a search response. # If there is no extractive_content_spec provided, there will be no extractive answer in the search response. "maxExtractiveAnswerCount": 42, # The maximum number of extractive answers returned in each search result. An extractive answer is a verbatim answer extracted from the original document, which provides a precise and contextually relevant answer to the search query. If the number of matching answers is less than the `max_extractive_answer_count`, return all of the answers. Otherwise, return the `max_extractive_answer_count`. At most five answers are returned for each SearchResult. "maxExtractiveSegmentCount": 42, # The max number of extractive segments returned in each search result. Only applied if the DataStore is set to DataStore.ContentConfig.CONTENT_REQUIRED or DataStore.solution_types is SOLUTION_TYPE_CHAT. An extractive segment is a text segment extracted from the original document that is relevant to the search query, and, in general, more verbose than an extractive answer. The segment could then be used as input for LLMs to generate summaries and answers. If the number of matching segments is less than `max_extractive_segment_count`, return all of the segments. Otherwise, return the `max_extractive_segment_count`. @@ -582,6 +600,7 @@

Method Details

"numPreviousSegments": 42, # Specifies whether to also include the adjacent from each selected segments. Return at most `num_previous_segments` segments before each selected segments. "returnExtractiveSegmentScore": True or False, # Specifies whether to return the confidence score from the extractive segments in each search result. This feature is available only for new or allowlisted data stores. To allowlist your data store, contact your Customer Engineer. The default value is `false`. }, + "searchResultMode": "A String", # Specifies the search result mode. If unspecified, the search result mode is based on DataStore.DocumentProcessingConfig.chunking_config: * If DataStore.DocumentProcessingConfig.chunking_config is specified, it defaults to `CHUNKS`. * Otherwise, it defaults to `DOCUMENTS`. "snippetSpec": { # A specification for configuring snippets in a search response. # If `snippetSpec` is not specified, snippets are not included in the search response. "maxSnippetCount": 42, # [DEPRECATED] This field is deprecated. To control snippet return, use `return_snippet` field. For backwards compatibility, we will return snippet if max_snippet_count > 0. "referenceOnly": True or False, # [DEPRECATED] This field is deprecated and will have no affect on the snippet. @@ -658,6 +677,10 @@

Method Details

], "genericConfig": { # Specifies the configurations needed for Generic Discovery.Currently we support: * `content_search_spec`: configuration for generic content search. # The GenericConfig of the serving configuration. "contentSearchSpec": { # A specification for configuring the behavior of content search. # Specifies the expected behavior of content search. Only valid for content-search enabled data store. + "chunkSpec": { # Specifies the chunk spec to be returned from the search response. Only available if the SearchRequest.ContentSearchSpec.search_result_mode is set to CHUNKS # Specifies the chunk spec to be returned from the search response. Only available if the SearchRequest.ContentSearchSpec.search_result_mode is set to CHUNKS + "numNextChunks": 42, # The number of next chunks to be returned of the current chunk. The maximum allowed value is 3. If not specified, no next chunks will be returned. + "numPreviousChunks": 42, # The number of previous chunks to be returned of the current chunk. The maximum allowed value is 3. If not specified, no previous chunks will be returned. + }, "extractiveContentSpec": { # A specification for configuring the extractive content in a search response. # If there is no extractive_content_spec provided, there will be no extractive answer in the search response. "maxExtractiveAnswerCount": 42, # The maximum number of extractive answers returned in each search result. An extractive answer is a verbatim answer extracted from the original document, which provides a precise and contextually relevant answer to the search query. If the number of matching answers is less than the `max_extractive_answer_count`, return all of the answers. Otherwise, return the `max_extractive_answer_count`. At most five answers are returned for each SearchResult. "maxExtractiveSegmentCount": 42, # The max number of extractive segments returned in each search result. Only applied if the DataStore is set to DataStore.ContentConfig.CONTENT_REQUIRED or DataStore.solution_types is SOLUTION_TYPE_CHAT. An extractive segment is a text segment extracted from the original document that is relevant to the search query, and, in general, more verbose than an extractive answer. The segment could then be used as input for LLMs to generate summaries and answers. If the number of matching segments is less than `max_extractive_segment_count`, return all of the segments. Otherwise, return the `max_extractive_segment_count`. @@ -665,6 +688,7 @@

Method Details

"numPreviousSegments": 42, # Specifies whether to also include the adjacent from each selected segments. Return at most `num_previous_segments` segments before each selected segments. "returnExtractiveSegmentScore": True or False, # Specifies whether to return the confidence score from the extractive segments in each search result. This feature is available only for new or allowlisted data stores. To allowlist your data store, contact your Customer Engineer. The default value is `false`. }, + "searchResultMode": "A String", # Specifies the search result mode. If unspecified, the search result mode is based on DataStore.DocumentProcessingConfig.chunking_config: * If DataStore.DocumentProcessingConfig.chunking_config is specified, it defaults to `CHUNKS`. * Otherwise, it defaults to `DOCUMENTS`. "snippetSpec": { # A specification for configuring snippets in a search response. # If `snippetSpec` is not specified, snippets are not included in the search response. "maxSnippetCount": 42, # [DEPRECATED] This field is deprecated. To control snippet return, use `return_snippet` field. For backwards compatibility, we will return snippet if max_snippet_count > 0. "referenceOnly": True or False, # [DEPRECATED] This field is deprecated and will have no affect on the snippet. @@ -887,6 +911,10 @@

Method Details

"branch": "A String", # The branch resource name, such as `projects/*/locations/global/collections/default_collection/dataStores/default_data_store/branches/0`. Use `default_branch` as the branch ID or leave this field empty, to search documents under the default branch. "canonicalFilter": "A String", # The default filter that is applied when a user performs a search without checking any filters on the search page. The filter applied to every search request when quality improvement such as query expansion is needed. In the case a query does not have a sufficient amount of results this filter will be used to determine whether or not to enable the query expansion flow. The original filter will still be used for the query expanded search. This field is strongly recommended to achieve high search quality. For more information about filter syntax, see SearchRequest.filter. "contentSearchSpec": { # A specification for configuring the behavior of content search. # A specification for configuring the behavior of content search. + "chunkSpec": { # Specifies the chunk spec to be returned from the search response. Only available if the SearchRequest.ContentSearchSpec.search_result_mode is set to CHUNKS # Specifies the chunk spec to be returned from the search response. Only available if the SearchRequest.ContentSearchSpec.search_result_mode is set to CHUNKS + "numNextChunks": 42, # The number of next chunks to be returned of the current chunk. The maximum allowed value is 3. If not specified, no next chunks will be returned. + "numPreviousChunks": 42, # The number of previous chunks to be returned of the current chunk. The maximum allowed value is 3. If not specified, no previous chunks will be returned. + }, "extractiveContentSpec": { # A specification for configuring the extractive content in a search response. # If there is no extractive_content_spec provided, there will be no extractive answer in the search response. "maxExtractiveAnswerCount": 42, # The maximum number of extractive answers returned in each search result. An extractive answer is a verbatim answer extracted from the original document, which provides a precise and contextually relevant answer to the search query. If the number of matching answers is less than the `max_extractive_answer_count`, return all of the answers. Otherwise, return the `max_extractive_answer_count`. At most five answers are returned for each SearchResult. "maxExtractiveSegmentCount": 42, # The max number of extractive segments returned in each search result. Only applied if the DataStore is set to DataStore.ContentConfig.CONTENT_REQUIRED or DataStore.solution_types is SOLUTION_TYPE_CHAT. An extractive segment is a text segment extracted from the original document that is relevant to the search query, and, in general, more verbose than an extractive answer. The segment could then be used as input for LLMs to generate summaries and answers. If the number of matching segments is less than `max_extractive_segment_count`, return all of the segments. Otherwise, return the `max_extractive_segment_count`. @@ -894,6 +922,7 @@

Method Details

"numPreviousSegments": 42, # Specifies whether to also include the adjacent from each selected segments. Return at most `num_previous_segments` segments before each selected segments. "returnExtractiveSegmentScore": True or False, # Specifies whether to return the confidence score from the extractive segments in each search result. This feature is available only for new or allowlisted data stores. To allowlist your data store, contact your Customer Engineer. The default value is `false`. }, + "searchResultMode": "A String", # Specifies the search result mode. If unspecified, the search result mode is based on DataStore.DocumentProcessingConfig.chunking_config: * If DataStore.DocumentProcessingConfig.chunking_config is specified, it defaults to `CHUNKS`. * Otherwise, it defaults to `DOCUMENTS`. "snippetSpec": { # A specification for configuring snippets in a search response. # If `snippetSpec` is not specified, snippets are not included in the search response. "maxSnippetCount": 42, # [DEPRECATED] This field is deprecated. To control snippet return, use `return_snippet` field. For backwards compatibility, we will return snippet if max_snippet_count > 0. "referenceOnly": True or False, # [DEPRECATED] This field is deprecated and will have no affect on the snippet. @@ -1048,6 +1077,34 @@

Method Details

"redirectUri": "A String", # The URI of a customer-defined redirect page. If redirect action is triggered, no search is performed, and only redirect_uri and attribution_token are set in the response. "results": [ # A list of matched documents. The order represents the ranking. { # Represents the search results. + "chunk": { # Chunk captures all raw metadata information of items to be recommended or searched in the chunk mode. # The chunk data in the search response if the SearchRequest.ContentSearchSpec.search_result_mode is set to CHUNKS. + "chunkMetadata": { # Metadata of the current chunk. This field is only populated on SearchService.Search API. # Output only. Metadata of the current chunk. + "nextChunks": [ # The next chunks of the current chunk. The number is controlled by SearchRequest.ContentSearchSpec.ChunkSpec.num_next_chunks. This field is only populated on SearchService.Search API. + # Object with schema name: GoogleCloudDiscoveryengineV1betaChunk + ], + "previousChunks": [ # The previous chunks of the current chunk. The number is controlled by SearchRequest.ContentSearchSpec.ChunkSpec.num_previous_chunks. This field is only populated on SearchService.Search API. + # Object with schema name: GoogleCloudDiscoveryengineV1betaChunk + ], + }, + "content": "A String", # Content is a string from a document (parsed content). + "derivedStructData": { # Output only. This field is OUTPUT_ONLY. It contains derived data that are not in the original input document. + "a_key": "", # Properties of the object. + }, + "documentMetadata": { # Document metadata contains the information of the document of the current chunk. # Metadata of the document from the current chunk. + "structData": { # Data representation. The structured JSON data for the document. It should conform to the registered Schema or an `INVALID_ARGUMENT` error is thrown. + "a_key": "", # Properties of the object. + }, + "title": "A String", # Title of the document. + "uri": "A String", # Uri of the document. + }, + "id": "A String", # Unique chunk ID of the current chunk. + "name": "A String", # The full resource name of the chunk. Format: `projects/{project}/locations/{location}/collections/{collection}/dataStores/{data_store}/branches/{branch}/documents/{document_id}/chunks/{chunk_id}`. This field must be a UTF-8 encoded string with a length limit of 1024 characters. + "pageSpan": { # Page span of the chunk. # Page span of the chunk. + "pageEnd": 42, # The end page of the chunk. + "pageStart": 42, # The start page of the chunk. + }, + "relevanceScore": 3.14, # Output only. Represents the relevance score based on similarity. Higher score indicates higher chunk relevance. The score is in range [-1.0, 1.0]. Only populated on SearchService.SearchResponse. + }, "document": { # Document captures all raw metadata information of items to be recommended or searched. # The document data snippet in the search response. Only fields that are marked as `retrievable` are populated. "content": { # Unstructured data linked to this document. # The unstructured data linked to this document. Content must be set if this document is under a `CONTENT_REQUIRED` data store. "mimeType": "A String", # The MIME type of the content. Supported types: * `application/pdf` (PDF, only native PDFs are supported for now) * `text/html` (HTML) * `application/vnd.openxmlformats-officedocument.wordprocessingml.document` (DOCX) * `application/vnd.openxmlformats-officedocument.presentationml.presentation` (PPTX) * `text/plain` (TXT) See https://www.iana.org/assignments/media-types/media-types.xhtml. diff --git a/docs/dyn/discoveryengine_v1beta.projects.locations.userEvents.html b/docs/dyn/discoveryengine_v1beta.projects.locations.userEvents.html index 67ae804cb1e..85f21d438d9 100644 --- a/docs/dyn/discoveryengine_v1beta.projects.locations.userEvents.html +++ b/docs/dyn/discoveryengine_v1beta.projects.locations.userEvents.html @@ -77,6 +77,9 @@

Instance Methods

close()

Close httplib2 connections.

+

+ collect(parent, ets=None, uri=None, userEvent=None, x__xgafv=None)

+

Writes a single user event from the browser. This uses a GET request to due to browser restriction of POST-ing to a third-party domain. This method is used only by the Discovery Engine API JavaScript pixel and Google Tag Manager. Users should not call this method directly.

write(parent, body=None, writeAsync=None, x__xgafv=None)

Writes a single user event.

@@ -86,6 +89,34 @@

Method Details

Close httplib2 connections.
+
+ collect(parent, ets=None, uri=None, userEvent=None, x__xgafv=None) +
Writes a single user event from the browser. This uses a GET request to due to browser restriction of POST-ing to a third-party domain. This method is used only by the Discovery Engine API JavaScript pixel and Google Tag Manager. Users should not call this method directly.
+
+Args:
+  parent: string, Required. The parent DataStore resource name, such as `projects/{project}/locations/{location}/collections/{collection}/dataStores/{data_store}`. (required)
+  ets: string, The event timestamp in milliseconds. This prevents browser caching of otherwise identical get requests. The name is abbreviated to reduce the payload bytes.
+  uri: string, The URL including cgi-parameters but excluding the hash fragment with a length limit of 5,000 characters. This is often more useful than the referer URL, because many browsers only send the domain for third-party requests.
+  userEvent: string, Required. URL encoded UserEvent proto with a length limit of 2,000,000 characters.
+  x__xgafv: string, V1 error format.
+    Allowed values
+      1 - v1 error format
+      2 - v2 error format
+
+Returns:
+  An object of the form:
+
+    { # Message that represents an arbitrary HTTP body. It should only be used for payload formats that can't be represented as JSON, such as raw binary or an HTML page. This message can be used both in streaming and non-streaming API methods in the request as well as the response. It can be used as a top-level request field, which is convenient if one wants to extract parameters from either the URL or HTTP template into the request fields and also want access to the raw HTTP body. Example: message GetResourceRequest { // A unique request id. string request_id = 1; // The raw HTTP body is bound to this field. google.api.HttpBody http_body = 2; } service ResourceService { rpc GetResource(GetResourceRequest) returns (google.api.HttpBody); rpc UpdateResource(google.api.HttpBody) returns (google.protobuf.Empty); } Example with streaming methods: service CaldavService { rpc GetCalendar(stream google.api.HttpBody) returns (stream google.api.HttpBody); rpc UpdateCalendar(stream google.api.HttpBody) returns (stream google.api.HttpBody); } Use of this type only changes how the request and response bodies are handled, all other features will continue to work unchanged.
+  "contentType": "A String", # The HTTP Content-Type header value specifying the content type of the body.
+  "data": "A String", # The HTTP request/response body as raw binary.
+  "extensions": [ # Application specific response metadata. Must be set in the first response for streaming APIs.
+    {
+      "a_key": "", # Properties of the object. Contains field @type with type URL.
+    },
+  ],
+}
+
+
write(parent, body=None, writeAsync=None, x__xgafv=None)
Writes a single user event.
diff --git a/docs/dyn/dns_v1.changes.html b/docs/dyn/dns_v1.changes.html
index fcd356c05ad..74fe65c912d 100644
--- a/docs/dyn/dns_v1.changes.html
+++ b/docs/dyn/dns_v1.changes.html
@@ -105,24 +105,24 @@ 

Method Details

body: object, The request body. The object takes the form of: -{ # A Change represents a set of ResourceRecordSet additions and deletions applied atomically to a ManagedZone. ResourceRecordSets within a ManagedZone are modified by creating a new Change element in the Changes collection. In turn the Changes collection also records the past modifications to the ResourceRecordSets in a ManagedZone. The current state of the ManagedZone is the sum effect of applying all Change elements in the Changes collection in sequence. +{ # A Change represents a set of `ResourceRecordSet` additions and deletions applied atomically to a ManagedZone. ResourceRecordSets within a ManagedZone are modified by creating a new Change element in the Changes collection. In turn the Changes collection also records the past modifications to the `ResourceRecordSets` in a `ManagedZone`. The current state of the `ManagedZone` is the sum effect of applying all `Change` elements in the `Changes` collection in sequence. "additions": [ # Which ResourceRecordSets to add? { # A unit of data that is returned by the DNS servers. "kind": "dns#resourceRecordSet", "name": "A String", # For example, www.example.com. - "routingPolicy": { # A RRSetRoutingPolicy represents ResourceRecordSet data that is returned dynamically with the response varying based on configured properties such as geolocation or by weighted random selection. # Configures dynamic query responses based on either the geo location of the querying user or a weighted round robin based routing policy. A valid ResourceRecordSet contains only rrdata (for static resolution) or a routing_policy (for dynamic resolution). - "geo": { # Configures a RRSetRoutingPolicy that routes based on the geo location of the querying user. + "routingPolicy": { # A RRSetRoutingPolicy represents ResourceRecordSet data that is returned dynamically with the response varying based on configured properties such as geolocation or by weighted random selection. # Configures dynamic query responses based on either the geo location of the querying user or a weighted round robin based routing policy. A valid `ResourceRecordSet` contains only `rrdata` (for static resolution) or a `routing_policy` (for dynamic resolution). + "geo": { # Configures a `RRSetRoutingPolicy` that routes based on the geo location of the querying user. "enableFencing": True or False, # Without fencing, if health check fails for all configured items in the current geo bucket, we failover to the next nearest geo bucket. With fencing, if health checking is enabled, as long as some targets in the current geo bucket are healthy, we return only the healthy targets. However, if all targets are unhealthy, we don't failover to the next nearest bucket; instead, we return all the items in the current bucket even when all targets are unhealthy. "items": [ # The primary geo routing configuration. If there are multiple items with the same location, an error is returned instead. { # ResourceRecordSet data for one geo location. - "healthCheckedTargets": { # HealthCheckTargets describes endpoints to health-check when responding to Routing Policy queries. Only the healthy endpoints will be included in the response. Only one of internal_load_balancer and external_endpoints should be set. # For A and AAAA types only. Endpoints to return in the query result only if they are healthy. These can be specified along with rrdata within this item. + "healthCheckedTargets": { # HealthCheckTargets describes endpoints to health-check when responding to Routing Policy queries. Only the healthy endpoints will be included in the response. # For A and AAAA types only. Endpoints to return in the query result only if they are healthy. These can be specified along with `rrdata` within this item. "internalLoadBalancers": [ # Configuration for internal load balancers to be health checked. { # The configuration for an individual load balancer to health check. "ipAddress": "A String", # The frontend IP address of the load balancer to health check. "ipProtocol": "A String", # The protocol of the load balancer to health check. "kind": "dns#rRSetRoutingPolicyLoadBalancerTarget", "loadBalancerType": "A String", # The type of load balancer specified by this target. This value must match the configuration of the load balancer located at the LoadBalancerTarget's IP address, port, and region. Use the following: - *regionalL4ilb*: for a regional internal passthrough Network Load Balancer. - *regionalL7ilb*: for a regional internal Application Load Balancer. - *globalL7ilb*: for a global internal Application Load Balancer. - "networkUrl": "A String", # The fully qualified URL of the network that the load balancer is attached to. This should be formatted like https://www.googleapis.com/compute/v1/projects/{project}/global/networks/{network} . + "networkUrl": "A String", # The fully qualified URL of the network that the load balancer is attached to. This should be formatted like `https://www.googleapis.com/compute/v1/projects/{project}/global/networks/{network}`. "port": "A String", # The configured port of the load balancer. "project": "A String", # The project ID in which the load balancer is located. "region": "A String", # The region in which the load balancer is located. @@ -134,7 +134,7 @@

Method Details

"rrdatas": [ "A String", ], - "signatureRrdatas": [ # DNSSEC generated signatures for all the rrdata within this item. If health checked targets are provided for DNSSEC enabled zones, there's a restriction of 1 IP address per item. + "signatureRrdatas": [ # DNSSEC generated signatures for all the `rrdata` within this item. If health checked targets are provided for DNSSEC enabled zones, there's a restriction of 1 IP address per item. "A String", ], }, @@ -143,18 +143,18 @@

Method Details

}, "kind": "dns#rRSetRoutingPolicy", "primaryBackup": { # Configures a RRSetRoutingPolicy such that all queries are responded with the primary_targets if they are healthy. And if all of them are unhealthy, then we fallback to a geo localized policy. - "backupGeoTargets": { # Configures a RRSetRoutingPolicy that routes based on the geo location of the querying user. # Backup targets provide a regional failover policy for the otherwise global primary targets. If serving state is set to BACKUP, this policy essentially becomes a geo routing policy. + "backupGeoTargets": { # Configures a `RRSetRoutingPolicy` that routes based on the geo location of the querying user. # Backup targets provide a regional failover policy for the otherwise global primary targets. If serving state is set to `BACKUP`, this policy essentially becomes a geo routing policy. "enableFencing": True or False, # Without fencing, if health check fails for all configured items in the current geo bucket, we failover to the next nearest geo bucket. With fencing, if health checking is enabled, as long as some targets in the current geo bucket are healthy, we return only the healthy targets. However, if all targets are unhealthy, we don't failover to the next nearest bucket; instead, we return all the items in the current bucket even when all targets are unhealthy. "items": [ # The primary geo routing configuration. If there are multiple items with the same location, an error is returned instead. { # ResourceRecordSet data for one geo location. - "healthCheckedTargets": { # HealthCheckTargets describes endpoints to health-check when responding to Routing Policy queries. Only the healthy endpoints will be included in the response. Only one of internal_load_balancer and external_endpoints should be set. # For A and AAAA types only. Endpoints to return in the query result only if they are healthy. These can be specified along with rrdata within this item. + "healthCheckedTargets": { # HealthCheckTargets describes endpoints to health-check when responding to Routing Policy queries. Only the healthy endpoints will be included in the response. # For A and AAAA types only. Endpoints to return in the query result only if they are healthy. These can be specified along with `rrdata` within this item. "internalLoadBalancers": [ # Configuration for internal load balancers to be health checked. { # The configuration for an individual load balancer to health check. "ipAddress": "A String", # The frontend IP address of the load balancer to health check. "ipProtocol": "A String", # The protocol of the load balancer to health check. "kind": "dns#rRSetRoutingPolicyLoadBalancerTarget", "loadBalancerType": "A String", # The type of load balancer specified by this target. This value must match the configuration of the load balancer located at the LoadBalancerTarget's IP address, port, and region. Use the following: - *regionalL4ilb*: for a regional internal passthrough Network Load Balancer. - *regionalL7ilb*: for a regional internal Application Load Balancer. - *globalL7ilb*: for a global internal Application Load Balancer. - "networkUrl": "A String", # The fully qualified URL of the network that the load balancer is attached to. This should be formatted like https://www.googleapis.com/compute/v1/projects/{project}/global/networks/{network} . + "networkUrl": "A String", # The fully qualified URL of the network that the load balancer is attached to. This should be formatted like `https://www.googleapis.com/compute/v1/projects/{project}/global/networks/{network}`. "port": "A String", # The configured port of the load balancer. "project": "A String", # The project ID in which the load balancer is located. "region": "A String", # The region in which the load balancer is located. @@ -166,7 +166,7 @@

Method Details

"rrdatas": [ "A String", ], - "signatureRrdatas": [ # DNSSEC generated signatures for all the rrdata within this item. If health checked targets are provided for DNSSEC enabled zones, there's a restriction of 1 IP address per item. + "signatureRrdatas": [ # DNSSEC generated signatures for all the `rrdata` within this item. If health checked targets are provided for DNSSEC enabled zones, there's a restriction of 1 IP address per item. "A String", ], }, @@ -174,33 +174,33 @@

Method Details

"kind": "dns#rRSetRoutingPolicyGeoPolicy", }, "kind": "dns#rRSetRoutingPolicyPrimaryBackupPolicy", - "primaryTargets": { # HealthCheckTargets describes endpoints to health-check when responding to Routing Policy queries. Only the healthy endpoints will be included in the response. Only one of internal_load_balancer and external_endpoints should be set. # Endpoints that are health checked before making the routing decision. Unhealthy endpoints are omitted from the results. If all endpoints are unhealthy, we serve a response based on the backup_geo_targets. + "primaryTargets": { # HealthCheckTargets describes endpoints to health-check when responding to Routing Policy queries. Only the healthy endpoints will be included in the response. # Endpoints that are health checked before making the routing decision. Unhealthy endpoints are omitted from the results. If all endpoints are unhealthy, we serve a response based on the `backup_geo_targets`. "internalLoadBalancers": [ # Configuration for internal load balancers to be health checked. { # The configuration for an individual load balancer to health check. "ipAddress": "A String", # The frontend IP address of the load balancer to health check. "ipProtocol": "A String", # The protocol of the load balancer to health check. "kind": "dns#rRSetRoutingPolicyLoadBalancerTarget", "loadBalancerType": "A String", # The type of load balancer specified by this target. This value must match the configuration of the load balancer located at the LoadBalancerTarget's IP address, port, and region. Use the following: - *regionalL4ilb*: for a regional internal passthrough Network Load Balancer. - *regionalL7ilb*: for a regional internal Application Load Balancer. - *globalL7ilb*: for a global internal Application Load Balancer. - "networkUrl": "A String", # The fully qualified URL of the network that the load balancer is attached to. This should be formatted like https://www.googleapis.com/compute/v1/projects/{project}/global/networks/{network} . + "networkUrl": "A String", # The fully qualified URL of the network that the load balancer is attached to. This should be formatted like `https://www.googleapis.com/compute/v1/projects/{project}/global/networks/{network}`. "port": "A String", # The configured port of the load balancer. "project": "A String", # The project ID in which the load balancer is located. "region": "A String", # The region in which the load balancer is located. }, ], }, - "trickleTraffic": 3.14, # When serving state is PRIMARY, this field provides the option of sending a small percentage of the traffic to the backup targets. + "trickleTraffic": 3.14, # When serving state is `PRIMARY`, this field provides the option of sending a small percentage of the traffic to the backup targets. }, "wrr": { # Configures a RRSetRoutingPolicy that routes in a weighted round robin fashion. "items": [ { # A routing block which contains the routing information for one WRR item. - "healthCheckedTargets": { # HealthCheckTargets describes endpoints to health-check when responding to Routing Policy queries. Only the healthy endpoints will be included in the response. Only one of internal_load_balancer and external_endpoints should be set. # Endpoints that are health checked before making the routing decision. The unhealthy endpoints are omitted from the result. If all endpoints within a bucket are unhealthy, we choose a different bucket (sampled with respect to its weight) for responding. If DNSSEC is enabled for this zone, only one of rrdata or health_checked_targets can be set. + "healthCheckedTargets": { # HealthCheckTargets describes endpoints to health-check when responding to Routing Policy queries. Only the healthy endpoints will be included in the response. # Endpoints that are health checked before making the routing decision. The unhealthy endpoints are omitted from the result. If all endpoints within a bucket are unhealthy, we choose a different bucket (sampled with respect to its weight) for responding. If DNSSEC is enabled for this zone, only one of `rrdata` or `health_checked_targets` can be set. "internalLoadBalancers": [ # Configuration for internal load balancers to be health checked. { # The configuration for an individual load balancer to health check. "ipAddress": "A String", # The frontend IP address of the load balancer to health check. "ipProtocol": "A String", # The protocol of the load balancer to health check. "kind": "dns#rRSetRoutingPolicyLoadBalancerTarget", "loadBalancerType": "A String", # The type of load balancer specified by this target. This value must match the configuration of the load balancer located at the LoadBalancerTarget's IP address, port, and region. Use the following: - *regionalL4ilb*: for a regional internal passthrough Network Load Balancer. - *regionalL7ilb*: for a regional internal Application Load Balancer. - *globalL7ilb*: for a global internal Application Load Balancer. - "networkUrl": "A String", # The fully qualified URL of the network that the load balancer is attached to. This should be formatted like https://www.googleapis.com/compute/v1/projects/{project}/global/networks/{network} . + "networkUrl": "A String", # The fully qualified URL of the network that the load balancer is attached to. This should be formatted like `https://www.googleapis.com/compute/v1/projects/{project}/global/networks/{network}`. "port": "A String", # The configured port of the load balancer. "project": "A String", # The project ID in which the load balancer is located. "region": "A String", # The region in which the load balancer is located. @@ -211,10 +211,10 @@

Method Details

"rrdatas": [ "A String", ], - "signatureRrdatas": [ # DNSSEC generated signatures for all the rrdata within this item. Note that if health checked targets are provided for DNSSEC enabled zones, there's a restriction of 1 IP address per item. + "signatureRrdatas": [ # DNSSEC generated signatures for all the `rrdata` within this item. Note that if health checked targets are provided for DNSSEC enabled zones, there's a restriction of 1 IP address per item. "A String", ], - "weight": 3.14, # The weight corresponding to this WrrPolicyItem object. When multiple WrrPolicyItem objects are configured, the probability of returning an WrrPolicyItem object's data is proportional to its weight relative to the sum of weights configured for all items. This weight must be non-negative. + "weight": 3.14, # The weight corresponding to this `WrrPolicyItem` object. When multiple `WrrPolicyItem` objects are configured, the probability of returning an `WrrPolicyItem` object's data is proportional to its weight relative to the sum of weights configured for all items. This weight must be non-negative. }, ], "kind": "dns#rRSetRoutingPolicyWrrPolicy", @@ -226,7 +226,7 @@

Method Details

"signatureRrdatas": [ # As defined in RFC 4034 (section 3.2). "A String", ], - "ttl": 42, # Number of seconds that this ResourceRecordSet can be cached by resolvers. + "ttl": 42, # Number of seconds that this `ResourceRecordSet` can be cached by resolvers. "type": "A String", # The identifier of a supported record type. See the list of Supported DNS record types. }, ], @@ -234,19 +234,19 @@

Method Details

{ # A unit of data that is returned by the DNS servers. "kind": "dns#resourceRecordSet", "name": "A String", # For example, www.example.com. - "routingPolicy": { # A RRSetRoutingPolicy represents ResourceRecordSet data that is returned dynamically with the response varying based on configured properties such as geolocation or by weighted random selection. # Configures dynamic query responses based on either the geo location of the querying user or a weighted round robin based routing policy. A valid ResourceRecordSet contains only rrdata (for static resolution) or a routing_policy (for dynamic resolution). - "geo": { # Configures a RRSetRoutingPolicy that routes based on the geo location of the querying user. + "routingPolicy": { # A RRSetRoutingPolicy represents ResourceRecordSet data that is returned dynamically with the response varying based on configured properties such as geolocation or by weighted random selection. # Configures dynamic query responses based on either the geo location of the querying user or a weighted round robin based routing policy. A valid `ResourceRecordSet` contains only `rrdata` (for static resolution) or a `routing_policy` (for dynamic resolution). + "geo": { # Configures a `RRSetRoutingPolicy` that routes based on the geo location of the querying user. "enableFencing": True or False, # Without fencing, if health check fails for all configured items in the current geo bucket, we failover to the next nearest geo bucket. With fencing, if health checking is enabled, as long as some targets in the current geo bucket are healthy, we return only the healthy targets. However, if all targets are unhealthy, we don't failover to the next nearest bucket; instead, we return all the items in the current bucket even when all targets are unhealthy. "items": [ # The primary geo routing configuration. If there are multiple items with the same location, an error is returned instead. { # ResourceRecordSet data for one geo location. - "healthCheckedTargets": { # HealthCheckTargets describes endpoints to health-check when responding to Routing Policy queries. Only the healthy endpoints will be included in the response. Only one of internal_load_balancer and external_endpoints should be set. # For A and AAAA types only. Endpoints to return in the query result only if they are healthy. These can be specified along with rrdata within this item. + "healthCheckedTargets": { # HealthCheckTargets describes endpoints to health-check when responding to Routing Policy queries. Only the healthy endpoints will be included in the response. # For A and AAAA types only. Endpoints to return in the query result only if they are healthy. These can be specified along with `rrdata` within this item. "internalLoadBalancers": [ # Configuration for internal load balancers to be health checked. { # The configuration for an individual load balancer to health check. "ipAddress": "A String", # The frontend IP address of the load balancer to health check. "ipProtocol": "A String", # The protocol of the load balancer to health check. "kind": "dns#rRSetRoutingPolicyLoadBalancerTarget", "loadBalancerType": "A String", # The type of load balancer specified by this target. This value must match the configuration of the load balancer located at the LoadBalancerTarget's IP address, port, and region. Use the following: - *regionalL4ilb*: for a regional internal passthrough Network Load Balancer. - *regionalL7ilb*: for a regional internal Application Load Balancer. - *globalL7ilb*: for a global internal Application Load Balancer. - "networkUrl": "A String", # The fully qualified URL of the network that the load balancer is attached to. This should be formatted like https://www.googleapis.com/compute/v1/projects/{project}/global/networks/{network} . + "networkUrl": "A String", # The fully qualified URL of the network that the load balancer is attached to. This should be formatted like `https://www.googleapis.com/compute/v1/projects/{project}/global/networks/{network}`. "port": "A String", # The configured port of the load balancer. "project": "A String", # The project ID in which the load balancer is located. "region": "A String", # The region in which the load balancer is located. @@ -258,7 +258,7 @@

Method Details

"rrdatas": [ "A String", ], - "signatureRrdatas": [ # DNSSEC generated signatures for all the rrdata within this item. If health checked targets are provided for DNSSEC enabled zones, there's a restriction of 1 IP address per item. + "signatureRrdatas": [ # DNSSEC generated signatures for all the `rrdata` within this item. If health checked targets are provided for DNSSEC enabled zones, there's a restriction of 1 IP address per item. "A String", ], }, @@ -267,18 +267,18 @@

Method Details

}, "kind": "dns#rRSetRoutingPolicy", "primaryBackup": { # Configures a RRSetRoutingPolicy such that all queries are responded with the primary_targets if they are healthy. And if all of them are unhealthy, then we fallback to a geo localized policy. - "backupGeoTargets": { # Configures a RRSetRoutingPolicy that routes based on the geo location of the querying user. # Backup targets provide a regional failover policy for the otherwise global primary targets. If serving state is set to BACKUP, this policy essentially becomes a geo routing policy. + "backupGeoTargets": { # Configures a `RRSetRoutingPolicy` that routes based on the geo location of the querying user. # Backup targets provide a regional failover policy for the otherwise global primary targets. If serving state is set to `BACKUP`, this policy essentially becomes a geo routing policy. "enableFencing": True or False, # Without fencing, if health check fails for all configured items in the current geo bucket, we failover to the next nearest geo bucket. With fencing, if health checking is enabled, as long as some targets in the current geo bucket are healthy, we return only the healthy targets. However, if all targets are unhealthy, we don't failover to the next nearest bucket; instead, we return all the items in the current bucket even when all targets are unhealthy. "items": [ # The primary geo routing configuration. If there are multiple items with the same location, an error is returned instead. { # ResourceRecordSet data for one geo location. - "healthCheckedTargets": { # HealthCheckTargets describes endpoints to health-check when responding to Routing Policy queries. Only the healthy endpoints will be included in the response. Only one of internal_load_balancer and external_endpoints should be set. # For A and AAAA types only. Endpoints to return in the query result only if they are healthy. These can be specified along with rrdata within this item. + "healthCheckedTargets": { # HealthCheckTargets describes endpoints to health-check when responding to Routing Policy queries. Only the healthy endpoints will be included in the response. # For A and AAAA types only. Endpoints to return in the query result only if they are healthy. These can be specified along with `rrdata` within this item. "internalLoadBalancers": [ # Configuration for internal load balancers to be health checked. { # The configuration for an individual load balancer to health check. "ipAddress": "A String", # The frontend IP address of the load balancer to health check. "ipProtocol": "A String", # The protocol of the load balancer to health check. "kind": "dns#rRSetRoutingPolicyLoadBalancerTarget", "loadBalancerType": "A String", # The type of load balancer specified by this target. This value must match the configuration of the load balancer located at the LoadBalancerTarget's IP address, port, and region. Use the following: - *regionalL4ilb*: for a regional internal passthrough Network Load Balancer. - *regionalL7ilb*: for a regional internal Application Load Balancer. - *globalL7ilb*: for a global internal Application Load Balancer. - "networkUrl": "A String", # The fully qualified URL of the network that the load balancer is attached to. This should be formatted like https://www.googleapis.com/compute/v1/projects/{project}/global/networks/{network} . + "networkUrl": "A String", # The fully qualified URL of the network that the load balancer is attached to. This should be formatted like `https://www.googleapis.com/compute/v1/projects/{project}/global/networks/{network}`. "port": "A String", # The configured port of the load balancer. "project": "A String", # The project ID in which the load balancer is located. "region": "A String", # The region in which the load balancer is located. @@ -290,7 +290,7 @@

Method Details

"rrdatas": [ "A String", ], - "signatureRrdatas": [ # DNSSEC generated signatures for all the rrdata within this item. If health checked targets are provided for DNSSEC enabled zones, there's a restriction of 1 IP address per item. + "signatureRrdatas": [ # DNSSEC generated signatures for all the `rrdata` within this item. If health checked targets are provided for DNSSEC enabled zones, there's a restriction of 1 IP address per item. "A String", ], }, @@ -298,33 +298,33 @@

Method Details

"kind": "dns#rRSetRoutingPolicyGeoPolicy", }, "kind": "dns#rRSetRoutingPolicyPrimaryBackupPolicy", - "primaryTargets": { # HealthCheckTargets describes endpoints to health-check when responding to Routing Policy queries. Only the healthy endpoints will be included in the response. Only one of internal_load_balancer and external_endpoints should be set. # Endpoints that are health checked before making the routing decision. Unhealthy endpoints are omitted from the results. If all endpoints are unhealthy, we serve a response based on the backup_geo_targets. + "primaryTargets": { # HealthCheckTargets describes endpoints to health-check when responding to Routing Policy queries. Only the healthy endpoints will be included in the response. # Endpoints that are health checked before making the routing decision. Unhealthy endpoints are omitted from the results. If all endpoints are unhealthy, we serve a response based on the `backup_geo_targets`. "internalLoadBalancers": [ # Configuration for internal load balancers to be health checked. { # The configuration for an individual load balancer to health check. "ipAddress": "A String", # The frontend IP address of the load balancer to health check. "ipProtocol": "A String", # The protocol of the load balancer to health check. "kind": "dns#rRSetRoutingPolicyLoadBalancerTarget", "loadBalancerType": "A String", # The type of load balancer specified by this target. This value must match the configuration of the load balancer located at the LoadBalancerTarget's IP address, port, and region. Use the following: - *regionalL4ilb*: for a regional internal passthrough Network Load Balancer. - *regionalL7ilb*: for a regional internal Application Load Balancer. - *globalL7ilb*: for a global internal Application Load Balancer. - "networkUrl": "A String", # The fully qualified URL of the network that the load balancer is attached to. This should be formatted like https://www.googleapis.com/compute/v1/projects/{project}/global/networks/{network} . + "networkUrl": "A String", # The fully qualified URL of the network that the load balancer is attached to. This should be formatted like `https://www.googleapis.com/compute/v1/projects/{project}/global/networks/{network}`. "port": "A String", # The configured port of the load balancer. "project": "A String", # The project ID in which the load balancer is located. "region": "A String", # The region in which the load balancer is located. }, ], }, - "trickleTraffic": 3.14, # When serving state is PRIMARY, this field provides the option of sending a small percentage of the traffic to the backup targets. + "trickleTraffic": 3.14, # When serving state is `PRIMARY`, this field provides the option of sending a small percentage of the traffic to the backup targets. }, "wrr": { # Configures a RRSetRoutingPolicy that routes in a weighted round robin fashion. "items": [ { # A routing block which contains the routing information for one WRR item. - "healthCheckedTargets": { # HealthCheckTargets describes endpoints to health-check when responding to Routing Policy queries. Only the healthy endpoints will be included in the response. Only one of internal_load_balancer and external_endpoints should be set. # Endpoints that are health checked before making the routing decision. The unhealthy endpoints are omitted from the result. If all endpoints within a bucket are unhealthy, we choose a different bucket (sampled with respect to its weight) for responding. If DNSSEC is enabled for this zone, only one of rrdata or health_checked_targets can be set. + "healthCheckedTargets": { # HealthCheckTargets describes endpoints to health-check when responding to Routing Policy queries. Only the healthy endpoints will be included in the response. # Endpoints that are health checked before making the routing decision. The unhealthy endpoints are omitted from the result. If all endpoints within a bucket are unhealthy, we choose a different bucket (sampled with respect to its weight) for responding. If DNSSEC is enabled for this zone, only one of `rrdata` or `health_checked_targets` can be set. "internalLoadBalancers": [ # Configuration for internal load balancers to be health checked. { # The configuration for an individual load balancer to health check. "ipAddress": "A String", # The frontend IP address of the load balancer to health check. "ipProtocol": "A String", # The protocol of the load balancer to health check. "kind": "dns#rRSetRoutingPolicyLoadBalancerTarget", "loadBalancerType": "A String", # The type of load balancer specified by this target. This value must match the configuration of the load balancer located at the LoadBalancerTarget's IP address, port, and region. Use the following: - *regionalL4ilb*: for a regional internal passthrough Network Load Balancer. - *regionalL7ilb*: for a regional internal Application Load Balancer. - *globalL7ilb*: for a global internal Application Load Balancer. - "networkUrl": "A String", # The fully qualified URL of the network that the load balancer is attached to. This should be formatted like https://www.googleapis.com/compute/v1/projects/{project}/global/networks/{network} . + "networkUrl": "A String", # The fully qualified URL of the network that the load balancer is attached to. This should be formatted like `https://www.googleapis.com/compute/v1/projects/{project}/global/networks/{network}`. "port": "A String", # The configured port of the load balancer. "project": "A String", # The project ID in which the load balancer is located. "region": "A String", # The region in which the load balancer is located. @@ -335,10 +335,10 @@

Method Details

"rrdatas": [ "A String", ], - "signatureRrdatas": [ # DNSSEC generated signatures for all the rrdata within this item. Note that if health checked targets are provided for DNSSEC enabled zones, there's a restriction of 1 IP address per item. + "signatureRrdatas": [ # DNSSEC generated signatures for all the `rrdata` within this item. Note that if health checked targets are provided for DNSSEC enabled zones, there's a restriction of 1 IP address per item. "A String", ], - "weight": 3.14, # The weight corresponding to this WrrPolicyItem object. When multiple WrrPolicyItem objects are configured, the probability of returning an WrrPolicyItem object's data is proportional to its weight relative to the sum of weights configured for all items. This weight must be non-negative. + "weight": 3.14, # The weight corresponding to this `WrrPolicyItem` object. When multiple `WrrPolicyItem` objects are configured, the probability of returning an `WrrPolicyItem` object's data is proportional to its weight relative to the sum of weights configured for all items. This weight must be non-negative. }, ], "kind": "dns#rRSetRoutingPolicyWrrPolicy", @@ -350,7 +350,7 @@

Method Details

"signatureRrdatas": [ # As defined in RFC 4034 (section 3.2). "A String", ], - "ttl": 42, # Number of seconds that this ResourceRecordSet can be cached by resolvers. + "ttl": 42, # Number of seconds that this `ResourceRecordSet` can be cached by resolvers. "type": "A String", # The identifier of a supported record type. See the list of Supported DNS record types. }, ], @@ -370,24 +370,24 @@

Method Details

Returns: An object of the form: - { # A Change represents a set of ResourceRecordSet additions and deletions applied atomically to a ManagedZone. ResourceRecordSets within a ManagedZone are modified by creating a new Change element in the Changes collection. In turn the Changes collection also records the past modifications to the ResourceRecordSets in a ManagedZone. The current state of the ManagedZone is the sum effect of applying all Change elements in the Changes collection in sequence. + { # A Change represents a set of `ResourceRecordSet` additions and deletions applied atomically to a ManagedZone. ResourceRecordSets within a ManagedZone are modified by creating a new Change element in the Changes collection. In turn the Changes collection also records the past modifications to the `ResourceRecordSets` in a `ManagedZone`. The current state of the `ManagedZone` is the sum effect of applying all `Change` elements in the `Changes` collection in sequence. "additions": [ # Which ResourceRecordSets to add? { # A unit of data that is returned by the DNS servers. "kind": "dns#resourceRecordSet", "name": "A String", # For example, www.example.com. - "routingPolicy": { # A RRSetRoutingPolicy represents ResourceRecordSet data that is returned dynamically with the response varying based on configured properties such as geolocation or by weighted random selection. # Configures dynamic query responses based on either the geo location of the querying user or a weighted round robin based routing policy. A valid ResourceRecordSet contains only rrdata (for static resolution) or a routing_policy (for dynamic resolution). - "geo": { # Configures a RRSetRoutingPolicy that routes based on the geo location of the querying user. + "routingPolicy": { # A RRSetRoutingPolicy represents ResourceRecordSet data that is returned dynamically with the response varying based on configured properties such as geolocation or by weighted random selection. # Configures dynamic query responses based on either the geo location of the querying user or a weighted round robin based routing policy. A valid `ResourceRecordSet` contains only `rrdata` (for static resolution) or a `routing_policy` (for dynamic resolution). + "geo": { # Configures a `RRSetRoutingPolicy` that routes based on the geo location of the querying user. "enableFencing": True or False, # Without fencing, if health check fails for all configured items in the current geo bucket, we failover to the next nearest geo bucket. With fencing, if health checking is enabled, as long as some targets in the current geo bucket are healthy, we return only the healthy targets. However, if all targets are unhealthy, we don't failover to the next nearest bucket; instead, we return all the items in the current bucket even when all targets are unhealthy. "items": [ # The primary geo routing configuration. If there are multiple items with the same location, an error is returned instead. { # ResourceRecordSet data for one geo location. - "healthCheckedTargets": { # HealthCheckTargets describes endpoints to health-check when responding to Routing Policy queries. Only the healthy endpoints will be included in the response. Only one of internal_load_balancer and external_endpoints should be set. # For A and AAAA types only. Endpoints to return in the query result only if they are healthy. These can be specified along with rrdata within this item. + "healthCheckedTargets": { # HealthCheckTargets describes endpoints to health-check when responding to Routing Policy queries. Only the healthy endpoints will be included in the response. # For A and AAAA types only. Endpoints to return in the query result only if they are healthy. These can be specified along with `rrdata` within this item. "internalLoadBalancers": [ # Configuration for internal load balancers to be health checked. { # The configuration for an individual load balancer to health check. "ipAddress": "A String", # The frontend IP address of the load balancer to health check. "ipProtocol": "A String", # The protocol of the load balancer to health check. "kind": "dns#rRSetRoutingPolicyLoadBalancerTarget", "loadBalancerType": "A String", # The type of load balancer specified by this target. This value must match the configuration of the load balancer located at the LoadBalancerTarget's IP address, port, and region. Use the following: - *regionalL4ilb*: for a regional internal passthrough Network Load Balancer. - *regionalL7ilb*: for a regional internal Application Load Balancer. - *globalL7ilb*: for a global internal Application Load Balancer. - "networkUrl": "A String", # The fully qualified URL of the network that the load balancer is attached to. This should be formatted like https://www.googleapis.com/compute/v1/projects/{project}/global/networks/{network} . + "networkUrl": "A String", # The fully qualified URL of the network that the load balancer is attached to. This should be formatted like `https://www.googleapis.com/compute/v1/projects/{project}/global/networks/{network}`. "port": "A String", # The configured port of the load balancer. "project": "A String", # The project ID in which the load balancer is located. "region": "A String", # The region in which the load balancer is located. @@ -399,7 +399,7 @@

Method Details

"rrdatas": [ "A String", ], - "signatureRrdatas": [ # DNSSEC generated signatures for all the rrdata within this item. If health checked targets are provided for DNSSEC enabled zones, there's a restriction of 1 IP address per item. + "signatureRrdatas": [ # DNSSEC generated signatures for all the `rrdata` within this item. If health checked targets are provided for DNSSEC enabled zones, there's a restriction of 1 IP address per item. "A String", ], }, @@ -408,18 +408,18 @@

Method Details

}, "kind": "dns#rRSetRoutingPolicy", "primaryBackup": { # Configures a RRSetRoutingPolicy such that all queries are responded with the primary_targets if they are healthy. And if all of them are unhealthy, then we fallback to a geo localized policy. - "backupGeoTargets": { # Configures a RRSetRoutingPolicy that routes based on the geo location of the querying user. # Backup targets provide a regional failover policy for the otherwise global primary targets. If serving state is set to BACKUP, this policy essentially becomes a geo routing policy. + "backupGeoTargets": { # Configures a `RRSetRoutingPolicy` that routes based on the geo location of the querying user. # Backup targets provide a regional failover policy for the otherwise global primary targets. If serving state is set to `BACKUP`, this policy essentially becomes a geo routing policy. "enableFencing": True or False, # Without fencing, if health check fails for all configured items in the current geo bucket, we failover to the next nearest geo bucket. With fencing, if health checking is enabled, as long as some targets in the current geo bucket are healthy, we return only the healthy targets. However, if all targets are unhealthy, we don't failover to the next nearest bucket; instead, we return all the items in the current bucket even when all targets are unhealthy. "items": [ # The primary geo routing configuration. If there are multiple items with the same location, an error is returned instead. { # ResourceRecordSet data for one geo location. - "healthCheckedTargets": { # HealthCheckTargets describes endpoints to health-check when responding to Routing Policy queries. Only the healthy endpoints will be included in the response. Only one of internal_load_balancer and external_endpoints should be set. # For A and AAAA types only. Endpoints to return in the query result only if they are healthy. These can be specified along with rrdata within this item. + "healthCheckedTargets": { # HealthCheckTargets describes endpoints to health-check when responding to Routing Policy queries. Only the healthy endpoints will be included in the response. # For A and AAAA types only. Endpoints to return in the query result only if they are healthy. These can be specified along with `rrdata` within this item. "internalLoadBalancers": [ # Configuration for internal load balancers to be health checked. { # The configuration for an individual load balancer to health check. "ipAddress": "A String", # The frontend IP address of the load balancer to health check. "ipProtocol": "A String", # The protocol of the load balancer to health check. "kind": "dns#rRSetRoutingPolicyLoadBalancerTarget", "loadBalancerType": "A String", # The type of load balancer specified by this target. This value must match the configuration of the load balancer located at the LoadBalancerTarget's IP address, port, and region. Use the following: - *regionalL4ilb*: for a regional internal passthrough Network Load Balancer. - *regionalL7ilb*: for a regional internal Application Load Balancer. - *globalL7ilb*: for a global internal Application Load Balancer. - "networkUrl": "A String", # The fully qualified URL of the network that the load balancer is attached to. This should be formatted like https://www.googleapis.com/compute/v1/projects/{project}/global/networks/{network} . + "networkUrl": "A String", # The fully qualified URL of the network that the load balancer is attached to. This should be formatted like `https://www.googleapis.com/compute/v1/projects/{project}/global/networks/{network}`. "port": "A String", # The configured port of the load balancer. "project": "A String", # The project ID in which the load balancer is located. "region": "A String", # The region in which the load balancer is located. @@ -431,7 +431,7 @@

Method Details

"rrdatas": [ "A String", ], - "signatureRrdatas": [ # DNSSEC generated signatures for all the rrdata within this item. If health checked targets are provided for DNSSEC enabled zones, there's a restriction of 1 IP address per item. + "signatureRrdatas": [ # DNSSEC generated signatures for all the `rrdata` within this item. If health checked targets are provided for DNSSEC enabled zones, there's a restriction of 1 IP address per item. "A String", ], }, @@ -439,33 +439,33 @@

Method Details

"kind": "dns#rRSetRoutingPolicyGeoPolicy", }, "kind": "dns#rRSetRoutingPolicyPrimaryBackupPolicy", - "primaryTargets": { # HealthCheckTargets describes endpoints to health-check when responding to Routing Policy queries. Only the healthy endpoints will be included in the response. Only one of internal_load_balancer and external_endpoints should be set. # Endpoints that are health checked before making the routing decision. Unhealthy endpoints are omitted from the results. If all endpoints are unhealthy, we serve a response based on the backup_geo_targets. + "primaryTargets": { # HealthCheckTargets describes endpoints to health-check when responding to Routing Policy queries. Only the healthy endpoints will be included in the response. # Endpoints that are health checked before making the routing decision. Unhealthy endpoints are omitted from the results. If all endpoints are unhealthy, we serve a response based on the `backup_geo_targets`. "internalLoadBalancers": [ # Configuration for internal load balancers to be health checked. { # The configuration for an individual load balancer to health check. "ipAddress": "A String", # The frontend IP address of the load balancer to health check. "ipProtocol": "A String", # The protocol of the load balancer to health check. "kind": "dns#rRSetRoutingPolicyLoadBalancerTarget", "loadBalancerType": "A String", # The type of load balancer specified by this target. This value must match the configuration of the load balancer located at the LoadBalancerTarget's IP address, port, and region. Use the following: - *regionalL4ilb*: for a regional internal passthrough Network Load Balancer. - *regionalL7ilb*: for a regional internal Application Load Balancer. - *globalL7ilb*: for a global internal Application Load Balancer. - "networkUrl": "A String", # The fully qualified URL of the network that the load balancer is attached to. This should be formatted like https://www.googleapis.com/compute/v1/projects/{project}/global/networks/{network} . + "networkUrl": "A String", # The fully qualified URL of the network that the load balancer is attached to. This should be formatted like `https://www.googleapis.com/compute/v1/projects/{project}/global/networks/{network}`. "port": "A String", # The configured port of the load balancer. "project": "A String", # The project ID in which the load balancer is located. "region": "A String", # The region in which the load balancer is located. }, ], }, - "trickleTraffic": 3.14, # When serving state is PRIMARY, this field provides the option of sending a small percentage of the traffic to the backup targets. + "trickleTraffic": 3.14, # When serving state is `PRIMARY`, this field provides the option of sending a small percentage of the traffic to the backup targets. }, "wrr": { # Configures a RRSetRoutingPolicy that routes in a weighted round robin fashion. "items": [ { # A routing block which contains the routing information for one WRR item. - "healthCheckedTargets": { # HealthCheckTargets describes endpoints to health-check when responding to Routing Policy queries. Only the healthy endpoints will be included in the response. Only one of internal_load_balancer and external_endpoints should be set. # Endpoints that are health checked before making the routing decision. The unhealthy endpoints are omitted from the result. If all endpoints within a bucket are unhealthy, we choose a different bucket (sampled with respect to its weight) for responding. If DNSSEC is enabled for this zone, only one of rrdata or health_checked_targets can be set. + "healthCheckedTargets": { # HealthCheckTargets describes endpoints to health-check when responding to Routing Policy queries. Only the healthy endpoints will be included in the response. # Endpoints that are health checked before making the routing decision. The unhealthy endpoints are omitted from the result. If all endpoints within a bucket are unhealthy, we choose a different bucket (sampled with respect to its weight) for responding. If DNSSEC is enabled for this zone, only one of `rrdata` or `health_checked_targets` can be set. "internalLoadBalancers": [ # Configuration for internal load balancers to be health checked. { # The configuration for an individual load balancer to health check. "ipAddress": "A String", # The frontend IP address of the load balancer to health check. "ipProtocol": "A String", # The protocol of the load balancer to health check. "kind": "dns#rRSetRoutingPolicyLoadBalancerTarget", "loadBalancerType": "A String", # The type of load balancer specified by this target. This value must match the configuration of the load balancer located at the LoadBalancerTarget's IP address, port, and region. Use the following: - *regionalL4ilb*: for a regional internal passthrough Network Load Balancer. - *regionalL7ilb*: for a regional internal Application Load Balancer. - *globalL7ilb*: for a global internal Application Load Balancer. - "networkUrl": "A String", # The fully qualified URL of the network that the load balancer is attached to. This should be formatted like https://www.googleapis.com/compute/v1/projects/{project}/global/networks/{network} . + "networkUrl": "A String", # The fully qualified URL of the network that the load balancer is attached to. This should be formatted like `https://www.googleapis.com/compute/v1/projects/{project}/global/networks/{network}`. "port": "A String", # The configured port of the load balancer. "project": "A String", # The project ID in which the load balancer is located. "region": "A String", # The region in which the load balancer is located. @@ -476,10 +476,10 @@

Method Details

"rrdatas": [ "A String", ], - "signatureRrdatas": [ # DNSSEC generated signatures for all the rrdata within this item. Note that if health checked targets are provided for DNSSEC enabled zones, there's a restriction of 1 IP address per item. + "signatureRrdatas": [ # DNSSEC generated signatures for all the `rrdata` within this item. Note that if health checked targets are provided for DNSSEC enabled zones, there's a restriction of 1 IP address per item. "A String", ], - "weight": 3.14, # The weight corresponding to this WrrPolicyItem object. When multiple WrrPolicyItem objects are configured, the probability of returning an WrrPolicyItem object's data is proportional to its weight relative to the sum of weights configured for all items. This weight must be non-negative. + "weight": 3.14, # The weight corresponding to this `WrrPolicyItem` object. When multiple `WrrPolicyItem` objects are configured, the probability of returning an `WrrPolicyItem` object's data is proportional to its weight relative to the sum of weights configured for all items. This weight must be non-negative. }, ], "kind": "dns#rRSetRoutingPolicyWrrPolicy", @@ -491,7 +491,7 @@

Method Details

"signatureRrdatas": [ # As defined in RFC 4034 (section 3.2). "A String", ], - "ttl": 42, # Number of seconds that this ResourceRecordSet can be cached by resolvers. + "ttl": 42, # Number of seconds that this `ResourceRecordSet` can be cached by resolvers. "type": "A String", # The identifier of a supported record type. See the list of Supported DNS record types. }, ], @@ -499,19 +499,19 @@

Method Details

{ # A unit of data that is returned by the DNS servers. "kind": "dns#resourceRecordSet", "name": "A String", # For example, www.example.com. - "routingPolicy": { # A RRSetRoutingPolicy represents ResourceRecordSet data that is returned dynamically with the response varying based on configured properties such as geolocation or by weighted random selection. # Configures dynamic query responses based on either the geo location of the querying user or a weighted round robin based routing policy. A valid ResourceRecordSet contains only rrdata (for static resolution) or a routing_policy (for dynamic resolution). - "geo": { # Configures a RRSetRoutingPolicy that routes based on the geo location of the querying user. + "routingPolicy": { # A RRSetRoutingPolicy represents ResourceRecordSet data that is returned dynamically with the response varying based on configured properties such as geolocation or by weighted random selection. # Configures dynamic query responses based on either the geo location of the querying user or a weighted round robin based routing policy. A valid `ResourceRecordSet` contains only `rrdata` (for static resolution) or a `routing_policy` (for dynamic resolution). + "geo": { # Configures a `RRSetRoutingPolicy` that routes based on the geo location of the querying user. "enableFencing": True or False, # Without fencing, if health check fails for all configured items in the current geo bucket, we failover to the next nearest geo bucket. With fencing, if health checking is enabled, as long as some targets in the current geo bucket are healthy, we return only the healthy targets. However, if all targets are unhealthy, we don't failover to the next nearest bucket; instead, we return all the items in the current bucket even when all targets are unhealthy. "items": [ # The primary geo routing configuration. If there are multiple items with the same location, an error is returned instead. { # ResourceRecordSet data for one geo location. - "healthCheckedTargets": { # HealthCheckTargets describes endpoints to health-check when responding to Routing Policy queries. Only the healthy endpoints will be included in the response. Only one of internal_load_balancer and external_endpoints should be set. # For A and AAAA types only. Endpoints to return in the query result only if they are healthy. These can be specified along with rrdata within this item. + "healthCheckedTargets": { # HealthCheckTargets describes endpoints to health-check when responding to Routing Policy queries. Only the healthy endpoints will be included in the response. # For A and AAAA types only. Endpoints to return in the query result only if they are healthy. These can be specified along with `rrdata` within this item. "internalLoadBalancers": [ # Configuration for internal load balancers to be health checked. { # The configuration for an individual load balancer to health check. "ipAddress": "A String", # The frontend IP address of the load balancer to health check. "ipProtocol": "A String", # The protocol of the load balancer to health check. "kind": "dns#rRSetRoutingPolicyLoadBalancerTarget", "loadBalancerType": "A String", # The type of load balancer specified by this target. This value must match the configuration of the load balancer located at the LoadBalancerTarget's IP address, port, and region. Use the following: - *regionalL4ilb*: for a regional internal passthrough Network Load Balancer. - *regionalL7ilb*: for a regional internal Application Load Balancer. - *globalL7ilb*: for a global internal Application Load Balancer. - "networkUrl": "A String", # The fully qualified URL of the network that the load balancer is attached to. This should be formatted like https://www.googleapis.com/compute/v1/projects/{project}/global/networks/{network} . + "networkUrl": "A String", # The fully qualified URL of the network that the load balancer is attached to. This should be formatted like `https://www.googleapis.com/compute/v1/projects/{project}/global/networks/{network}`. "port": "A String", # The configured port of the load balancer. "project": "A String", # The project ID in which the load balancer is located. "region": "A String", # The region in which the load balancer is located. @@ -523,7 +523,7 @@

Method Details

"rrdatas": [ "A String", ], - "signatureRrdatas": [ # DNSSEC generated signatures for all the rrdata within this item. If health checked targets are provided for DNSSEC enabled zones, there's a restriction of 1 IP address per item. + "signatureRrdatas": [ # DNSSEC generated signatures for all the `rrdata` within this item. If health checked targets are provided for DNSSEC enabled zones, there's a restriction of 1 IP address per item. "A String", ], }, @@ -532,18 +532,18 @@

Method Details

}, "kind": "dns#rRSetRoutingPolicy", "primaryBackup": { # Configures a RRSetRoutingPolicy such that all queries are responded with the primary_targets if they are healthy. And if all of them are unhealthy, then we fallback to a geo localized policy. - "backupGeoTargets": { # Configures a RRSetRoutingPolicy that routes based on the geo location of the querying user. # Backup targets provide a regional failover policy for the otherwise global primary targets. If serving state is set to BACKUP, this policy essentially becomes a geo routing policy. + "backupGeoTargets": { # Configures a `RRSetRoutingPolicy` that routes based on the geo location of the querying user. # Backup targets provide a regional failover policy for the otherwise global primary targets. If serving state is set to `BACKUP`, this policy essentially becomes a geo routing policy. "enableFencing": True or False, # Without fencing, if health check fails for all configured items in the current geo bucket, we failover to the next nearest geo bucket. With fencing, if health checking is enabled, as long as some targets in the current geo bucket are healthy, we return only the healthy targets. However, if all targets are unhealthy, we don't failover to the next nearest bucket; instead, we return all the items in the current bucket even when all targets are unhealthy. "items": [ # The primary geo routing configuration. If there are multiple items with the same location, an error is returned instead. { # ResourceRecordSet data for one geo location. - "healthCheckedTargets": { # HealthCheckTargets describes endpoints to health-check when responding to Routing Policy queries. Only the healthy endpoints will be included in the response. Only one of internal_load_balancer and external_endpoints should be set. # For A and AAAA types only. Endpoints to return in the query result only if they are healthy. These can be specified along with rrdata within this item. + "healthCheckedTargets": { # HealthCheckTargets describes endpoints to health-check when responding to Routing Policy queries. Only the healthy endpoints will be included in the response. # For A and AAAA types only. Endpoints to return in the query result only if they are healthy. These can be specified along with `rrdata` within this item. "internalLoadBalancers": [ # Configuration for internal load balancers to be health checked. { # The configuration for an individual load balancer to health check. "ipAddress": "A String", # The frontend IP address of the load balancer to health check. "ipProtocol": "A String", # The protocol of the load balancer to health check. "kind": "dns#rRSetRoutingPolicyLoadBalancerTarget", "loadBalancerType": "A String", # The type of load balancer specified by this target. This value must match the configuration of the load balancer located at the LoadBalancerTarget's IP address, port, and region. Use the following: - *regionalL4ilb*: for a regional internal passthrough Network Load Balancer. - *regionalL7ilb*: for a regional internal Application Load Balancer. - *globalL7ilb*: for a global internal Application Load Balancer. - "networkUrl": "A String", # The fully qualified URL of the network that the load balancer is attached to. This should be formatted like https://www.googleapis.com/compute/v1/projects/{project}/global/networks/{network} . + "networkUrl": "A String", # The fully qualified URL of the network that the load balancer is attached to. This should be formatted like `https://www.googleapis.com/compute/v1/projects/{project}/global/networks/{network}`. "port": "A String", # The configured port of the load balancer. "project": "A String", # The project ID in which the load balancer is located. "region": "A String", # The region in which the load balancer is located. @@ -555,7 +555,7 @@

Method Details

"rrdatas": [ "A String", ], - "signatureRrdatas": [ # DNSSEC generated signatures for all the rrdata within this item. If health checked targets are provided for DNSSEC enabled zones, there's a restriction of 1 IP address per item. + "signatureRrdatas": [ # DNSSEC generated signatures for all the `rrdata` within this item. If health checked targets are provided for DNSSEC enabled zones, there's a restriction of 1 IP address per item. "A String", ], }, @@ -563,33 +563,33 @@

Method Details

"kind": "dns#rRSetRoutingPolicyGeoPolicy", }, "kind": "dns#rRSetRoutingPolicyPrimaryBackupPolicy", - "primaryTargets": { # HealthCheckTargets describes endpoints to health-check when responding to Routing Policy queries. Only the healthy endpoints will be included in the response. Only one of internal_load_balancer and external_endpoints should be set. # Endpoints that are health checked before making the routing decision. Unhealthy endpoints are omitted from the results. If all endpoints are unhealthy, we serve a response based on the backup_geo_targets. + "primaryTargets": { # HealthCheckTargets describes endpoints to health-check when responding to Routing Policy queries. Only the healthy endpoints will be included in the response. # Endpoints that are health checked before making the routing decision. Unhealthy endpoints are omitted from the results. If all endpoints are unhealthy, we serve a response based on the `backup_geo_targets`. "internalLoadBalancers": [ # Configuration for internal load balancers to be health checked. { # The configuration for an individual load balancer to health check. "ipAddress": "A String", # The frontend IP address of the load balancer to health check. "ipProtocol": "A String", # The protocol of the load balancer to health check. "kind": "dns#rRSetRoutingPolicyLoadBalancerTarget", "loadBalancerType": "A String", # The type of load balancer specified by this target. This value must match the configuration of the load balancer located at the LoadBalancerTarget's IP address, port, and region. Use the following: - *regionalL4ilb*: for a regional internal passthrough Network Load Balancer. - *regionalL7ilb*: for a regional internal Application Load Balancer. - *globalL7ilb*: for a global internal Application Load Balancer. - "networkUrl": "A String", # The fully qualified URL of the network that the load balancer is attached to. This should be formatted like https://www.googleapis.com/compute/v1/projects/{project}/global/networks/{network} . + "networkUrl": "A String", # The fully qualified URL of the network that the load balancer is attached to. This should be formatted like `https://www.googleapis.com/compute/v1/projects/{project}/global/networks/{network}`. "port": "A String", # The configured port of the load balancer. "project": "A String", # The project ID in which the load balancer is located. "region": "A String", # The region in which the load balancer is located. }, ], }, - "trickleTraffic": 3.14, # When serving state is PRIMARY, this field provides the option of sending a small percentage of the traffic to the backup targets. + "trickleTraffic": 3.14, # When serving state is `PRIMARY`, this field provides the option of sending a small percentage of the traffic to the backup targets. }, "wrr": { # Configures a RRSetRoutingPolicy that routes in a weighted round robin fashion. "items": [ { # A routing block which contains the routing information for one WRR item. - "healthCheckedTargets": { # HealthCheckTargets describes endpoints to health-check when responding to Routing Policy queries. Only the healthy endpoints will be included in the response. Only one of internal_load_balancer and external_endpoints should be set. # Endpoints that are health checked before making the routing decision. The unhealthy endpoints are omitted from the result. If all endpoints within a bucket are unhealthy, we choose a different bucket (sampled with respect to its weight) for responding. If DNSSEC is enabled for this zone, only one of rrdata or health_checked_targets can be set. + "healthCheckedTargets": { # HealthCheckTargets describes endpoints to health-check when responding to Routing Policy queries. Only the healthy endpoints will be included in the response. # Endpoints that are health checked before making the routing decision. The unhealthy endpoints are omitted from the result. If all endpoints within a bucket are unhealthy, we choose a different bucket (sampled with respect to its weight) for responding. If DNSSEC is enabled for this zone, only one of `rrdata` or `health_checked_targets` can be set. "internalLoadBalancers": [ # Configuration for internal load balancers to be health checked. { # The configuration for an individual load balancer to health check. "ipAddress": "A String", # The frontend IP address of the load balancer to health check. "ipProtocol": "A String", # The protocol of the load balancer to health check. "kind": "dns#rRSetRoutingPolicyLoadBalancerTarget", "loadBalancerType": "A String", # The type of load balancer specified by this target. This value must match the configuration of the load balancer located at the LoadBalancerTarget's IP address, port, and region. Use the following: - *regionalL4ilb*: for a regional internal passthrough Network Load Balancer. - *regionalL7ilb*: for a regional internal Application Load Balancer. - *globalL7ilb*: for a global internal Application Load Balancer. - "networkUrl": "A String", # The fully qualified URL of the network that the load balancer is attached to. This should be formatted like https://www.googleapis.com/compute/v1/projects/{project}/global/networks/{network} . + "networkUrl": "A String", # The fully qualified URL of the network that the load balancer is attached to. This should be formatted like `https://www.googleapis.com/compute/v1/projects/{project}/global/networks/{network}`. "port": "A String", # The configured port of the load balancer. "project": "A String", # The project ID in which the load balancer is located. "region": "A String", # The region in which the load balancer is located. @@ -600,10 +600,10 @@

Method Details

"rrdatas": [ "A String", ], - "signatureRrdatas": [ # DNSSEC generated signatures for all the rrdata within this item. Note that if health checked targets are provided for DNSSEC enabled zones, there's a restriction of 1 IP address per item. + "signatureRrdatas": [ # DNSSEC generated signatures for all the `rrdata` within this item. Note that if health checked targets are provided for DNSSEC enabled zones, there's a restriction of 1 IP address per item. "A String", ], - "weight": 3.14, # The weight corresponding to this WrrPolicyItem object. When multiple WrrPolicyItem objects are configured, the probability of returning an WrrPolicyItem object's data is proportional to its weight relative to the sum of weights configured for all items. This weight must be non-negative. + "weight": 3.14, # The weight corresponding to this `WrrPolicyItem` object. When multiple `WrrPolicyItem` objects are configured, the probability of returning an `WrrPolicyItem` object's data is proportional to its weight relative to the sum of weights configured for all items. This weight must be non-negative. }, ], "kind": "dns#rRSetRoutingPolicyWrrPolicy", @@ -615,7 +615,7 @@

Method Details

"signatureRrdatas": [ # As defined in RFC 4034 (section 3.2). "A String", ], - "ttl": 42, # Number of seconds that this ResourceRecordSet can be cached by resolvers. + "ttl": 42, # Number of seconds that this `ResourceRecordSet` can be cached by resolvers. "type": "A String", # The identifier of a supported record type. See the list of Supported DNS record types. }, ], @@ -644,24 +644,24 @@

Method Details

Returns: An object of the form: - { # A Change represents a set of ResourceRecordSet additions and deletions applied atomically to a ManagedZone. ResourceRecordSets within a ManagedZone are modified by creating a new Change element in the Changes collection. In turn the Changes collection also records the past modifications to the ResourceRecordSets in a ManagedZone. The current state of the ManagedZone is the sum effect of applying all Change elements in the Changes collection in sequence. + { # A Change represents a set of `ResourceRecordSet` additions and deletions applied atomically to a ManagedZone. ResourceRecordSets within a ManagedZone are modified by creating a new Change element in the Changes collection. In turn the Changes collection also records the past modifications to the `ResourceRecordSets` in a `ManagedZone`. The current state of the `ManagedZone` is the sum effect of applying all `Change` elements in the `Changes` collection in sequence. "additions": [ # Which ResourceRecordSets to add? { # A unit of data that is returned by the DNS servers. "kind": "dns#resourceRecordSet", "name": "A String", # For example, www.example.com. - "routingPolicy": { # A RRSetRoutingPolicy represents ResourceRecordSet data that is returned dynamically with the response varying based on configured properties such as geolocation or by weighted random selection. # Configures dynamic query responses based on either the geo location of the querying user or a weighted round robin based routing policy. A valid ResourceRecordSet contains only rrdata (for static resolution) or a routing_policy (for dynamic resolution). - "geo": { # Configures a RRSetRoutingPolicy that routes based on the geo location of the querying user. + "routingPolicy": { # A RRSetRoutingPolicy represents ResourceRecordSet data that is returned dynamically with the response varying based on configured properties such as geolocation or by weighted random selection. # Configures dynamic query responses based on either the geo location of the querying user or a weighted round robin based routing policy. A valid `ResourceRecordSet` contains only `rrdata` (for static resolution) or a `routing_policy` (for dynamic resolution). + "geo": { # Configures a `RRSetRoutingPolicy` that routes based on the geo location of the querying user. "enableFencing": True or False, # Without fencing, if health check fails for all configured items in the current geo bucket, we failover to the next nearest geo bucket. With fencing, if health checking is enabled, as long as some targets in the current geo bucket are healthy, we return only the healthy targets. However, if all targets are unhealthy, we don't failover to the next nearest bucket; instead, we return all the items in the current bucket even when all targets are unhealthy. "items": [ # The primary geo routing configuration. If there are multiple items with the same location, an error is returned instead. { # ResourceRecordSet data for one geo location. - "healthCheckedTargets": { # HealthCheckTargets describes endpoints to health-check when responding to Routing Policy queries. Only the healthy endpoints will be included in the response. Only one of internal_load_balancer and external_endpoints should be set. # For A and AAAA types only. Endpoints to return in the query result only if they are healthy. These can be specified along with rrdata within this item. + "healthCheckedTargets": { # HealthCheckTargets describes endpoints to health-check when responding to Routing Policy queries. Only the healthy endpoints will be included in the response. # For A and AAAA types only. Endpoints to return in the query result only if they are healthy. These can be specified along with `rrdata` within this item. "internalLoadBalancers": [ # Configuration for internal load balancers to be health checked. { # The configuration for an individual load balancer to health check. "ipAddress": "A String", # The frontend IP address of the load balancer to health check. "ipProtocol": "A String", # The protocol of the load balancer to health check. "kind": "dns#rRSetRoutingPolicyLoadBalancerTarget", "loadBalancerType": "A String", # The type of load balancer specified by this target. This value must match the configuration of the load balancer located at the LoadBalancerTarget's IP address, port, and region. Use the following: - *regionalL4ilb*: for a regional internal passthrough Network Load Balancer. - *regionalL7ilb*: for a regional internal Application Load Balancer. - *globalL7ilb*: for a global internal Application Load Balancer. - "networkUrl": "A String", # The fully qualified URL of the network that the load balancer is attached to. This should be formatted like https://www.googleapis.com/compute/v1/projects/{project}/global/networks/{network} . + "networkUrl": "A String", # The fully qualified URL of the network that the load balancer is attached to. This should be formatted like `https://www.googleapis.com/compute/v1/projects/{project}/global/networks/{network}`. "port": "A String", # The configured port of the load balancer. "project": "A String", # The project ID in which the load balancer is located. "region": "A String", # The region in which the load balancer is located. @@ -673,7 +673,7 @@

Method Details

"rrdatas": [ "A String", ], - "signatureRrdatas": [ # DNSSEC generated signatures for all the rrdata within this item. If health checked targets are provided for DNSSEC enabled zones, there's a restriction of 1 IP address per item. + "signatureRrdatas": [ # DNSSEC generated signatures for all the `rrdata` within this item. If health checked targets are provided for DNSSEC enabled zones, there's a restriction of 1 IP address per item. "A String", ], }, @@ -682,18 +682,18 @@

Method Details

}, "kind": "dns#rRSetRoutingPolicy", "primaryBackup": { # Configures a RRSetRoutingPolicy such that all queries are responded with the primary_targets if they are healthy. And if all of them are unhealthy, then we fallback to a geo localized policy. - "backupGeoTargets": { # Configures a RRSetRoutingPolicy that routes based on the geo location of the querying user. # Backup targets provide a regional failover policy for the otherwise global primary targets. If serving state is set to BACKUP, this policy essentially becomes a geo routing policy. + "backupGeoTargets": { # Configures a `RRSetRoutingPolicy` that routes based on the geo location of the querying user. # Backup targets provide a regional failover policy for the otherwise global primary targets. If serving state is set to `BACKUP`, this policy essentially becomes a geo routing policy. "enableFencing": True or False, # Without fencing, if health check fails for all configured items in the current geo bucket, we failover to the next nearest geo bucket. With fencing, if health checking is enabled, as long as some targets in the current geo bucket are healthy, we return only the healthy targets. However, if all targets are unhealthy, we don't failover to the next nearest bucket; instead, we return all the items in the current bucket even when all targets are unhealthy. "items": [ # The primary geo routing configuration. If there are multiple items with the same location, an error is returned instead. { # ResourceRecordSet data for one geo location. - "healthCheckedTargets": { # HealthCheckTargets describes endpoints to health-check when responding to Routing Policy queries. Only the healthy endpoints will be included in the response. Only one of internal_load_balancer and external_endpoints should be set. # For A and AAAA types only. Endpoints to return in the query result only if they are healthy. These can be specified along with rrdata within this item. + "healthCheckedTargets": { # HealthCheckTargets describes endpoints to health-check when responding to Routing Policy queries. Only the healthy endpoints will be included in the response. # For A and AAAA types only. Endpoints to return in the query result only if they are healthy. These can be specified along with `rrdata` within this item. "internalLoadBalancers": [ # Configuration for internal load balancers to be health checked. { # The configuration for an individual load balancer to health check. "ipAddress": "A String", # The frontend IP address of the load balancer to health check. "ipProtocol": "A String", # The protocol of the load balancer to health check. "kind": "dns#rRSetRoutingPolicyLoadBalancerTarget", "loadBalancerType": "A String", # The type of load balancer specified by this target. This value must match the configuration of the load balancer located at the LoadBalancerTarget's IP address, port, and region. Use the following: - *regionalL4ilb*: for a regional internal passthrough Network Load Balancer. - *regionalL7ilb*: for a regional internal Application Load Balancer. - *globalL7ilb*: for a global internal Application Load Balancer. - "networkUrl": "A String", # The fully qualified URL of the network that the load balancer is attached to. This should be formatted like https://www.googleapis.com/compute/v1/projects/{project}/global/networks/{network} . + "networkUrl": "A String", # The fully qualified URL of the network that the load balancer is attached to. This should be formatted like `https://www.googleapis.com/compute/v1/projects/{project}/global/networks/{network}`. "port": "A String", # The configured port of the load balancer. "project": "A String", # The project ID in which the load balancer is located. "region": "A String", # The region in which the load balancer is located. @@ -705,7 +705,7 @@

Method Details

"rrdatas": [ "A String", ], - "signatureRrdatas": [ # DNSSEC generated signatures for all the rrdata within this item. If health checked targets are provided for DNSSEC enabled zones, there's a restriction of 1 IP address per item. + "signatureRrdatas": [ # DNSSEC generated signatures for all the `rrdata` within this item. If health checked targets are provided for DNSSEC enabled zones, there's a restriction of 1 IP address per item. "A String", ], }, @@ -713,33 +713,33 @@

Method Details

"kind": "dns#rRSetRoutingPolicyGeoPolicy", }, "kind": "dns#rRSetRoutingPolicyPrimaryBackupPolicy", - "primaryTargets": { # HealthCheckTargets describes endpoints to health-check when responding to Routing Policy queries. Only the healthy endpoints will be included in the response. Only one of internal_load_balancer and external_endpoints should be set. # Endpoints that are health checked before making the routing decision. Unhealthy endpoints are omitted from the results. If all endpoints are unhealthy, we serve a response based on the backup_geo_targets. + "primaryTargets": { # HealthCheckTargets describes endpoints to health-check when responding to Routing Policy queries. Only the healthy endpoints will be included in the response. # Endpoints that are health checked before making the routing decision. Unhealthy endpoints are omitted from the results. If all endpoints are unhealthy, we serve a response based on the `backup_geo_targets`. "internalLoadBalancers": [ # Configuration for internal load balancers to be health checked. { # The configuration for an individual load balancer to health check. "ipAddress": "A String", # The frontend IP address of the load balancer to health check. "ipProtocol": "A String", # The protocol of the load balancer to health check. "kind": "dns#rRSetRoutingPolicyLoadBalancerTarget", "loadBalancerType": "A String", # The type of load balancer specified by this target. This value must match the configuration of the load balancer located at the LoadBalancerTarget's IP address, port, and region. Use the following: - *regionalL4ilb*: for a regional internal passthrough Network Load Balancer. - *regionalL7ilb*: for a regional internal Application Load Balancer. - *globalL7ilb*: for a global internal Application Load Balancer. - "networkUrl": "A String", # The fully qualified URL of the network that the load balancer is attached to. This should be formatted like https://www.googleapis.com/compute/v1/projects/{project}/global/networks/{network} . + "networkUrl": "A String", # The fully qualified URL of the network that the load balancer is attached to. This should be formatted like `https://www.googleapis.com/compute/v1/projects/{project}/global/networks/{network}`. "port": "A String", # The configured port of the load balancer. "project": "A String", # The project ID in which the load balancer is located. "region": "A String", # The region in which the load balancer is located. }, ], }, - "trickleTraffic": 3.14, # When serving state is PRIMARY, this field provides the option of sending a small percentage of the traffic to the backup targets. + "trickleTraffic": 3.14, # When serving state is `PRIMARY`, this field provides the option of sending a small percentage of the traffic to the backup targets. }, "wrr": { # Configures a RRSetRoutingPolicy that routes in a weighted round robin fashion. "items": [ { # A routing block which contains the routing information for one WRR item. - "healthCheckedTargets": { # HealthCheckTargets describes endpoints to health-check when responding to Routing Policy queries. Only the healthy endpoints will be included in the response. Only one of internal_load_balancer and external_endpoints should be set. # Endpoints that are health checked before making the routing decision. The unhealthy endpoints are omitted from the result. If all endpoints within a bucket are unhealthy, we choose a different bucket (sampled with respect to its weight) for responding. If DNSSEC is enabled for this zone, only one of rrdata or health_checked_targets can be set. + "healthCheckedTargets": { # HealthCheckTargets describes endpoints to health-check when responding to Routing Policy queries. Only the healthy endpoints will be included in the response. # Endpoints that are health checked before making the routing decision. The unhealthy endpoints are omitted from the result. If all endpoints within a bucket are unhealthy, we choose a different bucket (sampled with respect to its weight) for responding. If DNSSEC is enabled for this zone, only one of `rrdata` or `health_checked_targets` can be set. "internalLoadBalancers": [ # Configuration for internal load balancers to be health checked. { # The configuration for an individual load balancer to health check. "ipAddress": "A String", # The frontend IP address of the load balancer to health check. "ipProtocol": "A String", # The protocol of the load balancer to health check. "kind": "dns#rRSetRoutingPolicyLoadBalancerTarget", "loadBalancerType": "A String", # The type of load balancer specified by this target. This value must match the configuration of the load balancer located at the LoadBalancerTarget's IP address, port, and region. Use the following: - *regionalL4ilb*: for a regional internal passthrough Network Load Balancer. - *regionalL7ilb*: for a regional internal Application Load Balancer. - *globalL7ilb*: for a global internal Application Load Balancer. - "networkUrl": "A String", # The fully qualified URL of the network that the load balancer is attached to. This should be formatted like https://www.googleapis.com/compute/v1/projects/{project}/global/networks/{network} . + "networkUrl": "A String", # The fully qualified URL of the network that the load balancer is attached to. This should be formatted like `https://www.googleapis.com/compute/v1/projects/{project}/global/networks/{network}`. "port": "A String", # The configured port of the load balancer. "project": "A String", # The project ID in which the load balancer is located. "region": "A String", # The region in which the load balancer is located. @@ -750,10 +750,10 @@

Method Details

"rrdatas": [ "A String", ], - "signatureRrdatas": [ # DNSSEC generated signatures for all the rrdata within this item. Note that if health checked targets are provided for DNSSEC enabled zones, there's a restriction of 1 IP address per item. + "signatureRrdatas": [ # DNSSEC generated signatures for all the `rrdata` within this item. Note that if health checked targets are provided for DNSSEC enabled zones, there's a restriction of 1 IP address per item. "A String", ], - "weight": 3.14, # The weight corresponding to this WrrPolicyItem object. When multiple WrrPolicyItem objects are configured, the probability of returning an WrrPolicyItem object's data is proportional to its weight relative to the sum of weights configured for all items. This weight must be non-negative. + "weight": 3.14, # The weight corresponding to this `WrrPolicyItem` object. When multiple `WrrPolicyItem` objects are configured, the probability of returning an `WrrPolicyItem` object's data is proportional to its weight relative to the sum of weights configured for all items. This weight must be non-negative. }, ], "kind": "dns#rRSetRoutingPolicyWrrPolicy", @@ -765,7 +765,7 @@

Method Details

"signatureRrdatas": [ # As defined in RFC 4034 (section 3.2). "A String", ], - "ttl": 42, # Number of seconds that this ResourceRecordSet can be cached by resolvers. + "ttl": 42, # Number of seconds that this `ResourceRecordSet` can be cached by resolvers. "type": "A String", # The identifier of a supported record type. See the list of Supported DNS record types. }, ], @@ -773,19 +773,19 @@

Method Details

{ # A unit of data that is returned by the DNS servers. "kind": "dns#resourceRecordSet", "name": "A String", # For example, www.example.com. - "routingPolicy": { # A RRSetRoutingPolicy represents ResourceRecordSet data that is returned dynamically with the response varying based on configured properties such as geolocation or by weighted random selection. # Configures dynamic query responses based on either the geo location of the querying user or a weighted round robin based routing policy. A valid ResourceRecordSet contains only rrdata (for static resolution) or a routing_policy (for dynamic resolution). - "geo": { # Configures a RRSetRoutingPolicy that routes based on the geo location of the querying user. + "routingPolicy": { # A RRSetRoutingPolicy represents ResourceRecordSet data that is returned dynamically with the response varying based on configured properties such as geolocation or by weighted random selection. # Configures dynamic query responses based on either the geo location of the querying user or a weighted round robin based routing policy. A valid `ResourceRecordSet` contains only `rrdata` (for static resolution) or a `routing_policy` (for dynamic resolution). + "geo": { # Configures a `RRSetRoutingPolicy` that routes based on the geo location of the querying user. "enableFencing": True or False, # Without fencing, if health check fails for all configured items in the current geo bucket, we failover to the next nearest geo bucket. With fencing, if health checking is enabled, as long as some targets in the current geo bucket are healthy, we return only the healthy targets. However, if all targets are unhealthy, we don't failover to the next nearest bucket; instead, we return all the items in the current bucket even when all targets are unhealthy. "items": [ # The primary geo routing configuration. If there are multiple items with the same location, an error is returned instead. { # ResourceRecordSet data for one geo location. - "healthCheckedTargets": { # HealthCheckTargets describes endpoints to health-check when responding to Routing Policy queries. Only the healthy endpoints will be included in the response. Only one of internal_load_balancer and external_endpoints should be set. # For A and AAAA types only. Endpoints to return in the query result only if they are healthy. These can be specified along with rrdata within this item. + "healthCheckedTargets": { # HealthCheckTargets describes endpoints to health-check when responding to Routing Policy queries. Only the healthy endpoints will be included in the response. # For A and AAAA types only. Endpoints to return in the query result only if they are healthy. These can be specified along with `rrdata` within this item. "internalLoadBalancers": [ # Configuration for internal load balancers to be health checked. { # The configuration for an individual load balancer to health check. "ipAddress": "A String", # The frontend IP address of the load balancer to health check. "ipProtocol": "A String", # The protocol of the load balancer to health check. "kind": "dns#rRSetRoutingPolicyLoadBalancerTarget", "loadBalancerType": "A String", # The type of load balancer specified by this target. This value must match the configuration of the load balancer located at the LoadBalancerTarget's IP address, port, and region. Use the following: - *regionalL4ilb*: for a regional internal passthrough Network Load Balancer. - *regionalL7ilb*: for a regional internal Application Load Balancer. - *globalL7ilb*: for a global internal Application Load Balancer. - "networkUrl": "A String", # The fully qualified URL of the network that the load balancer is attached to. This should be formatted like https://www.googleapis.com/compute/v1/projects/{project}/global/networks/{network} . + "networkUrl": "A String", # The fully qualified URL of the network that the load balancer is attached to. This should be formatted like `https://www.googleapis.com/compute/v1/projects/{project}/global/networks/{network}`. "port": "A String", # The configured port of the load balancer. "project": "A String", # The project ID in which the load balancer is located. "region": "A String", # The region in which the load balancer is located. @@ -797,7 +797,7 @@

Method Details

"rrdatas": [ "A String", ], - "signatureRrdatas": [ # DNSSEC generated signatures for all the rrdata within this item. If health checked targets are provided for DNSSEC enabled zones, there's a restriction of 1 IP address per item. + "signatureRrdatas": [ # DNSSEC generated signatures for all the `rrdata` within this item. If health checked targets are provided for DNSSEC enabled zones, there's a restriction of 1 IP address per item. "A String", ], }, @@ -806,18 +806,18 @@

Method Details

}, "kind": "dns#rRSetRoutingPolicy", "primaryBackup": { # Configures a RRSetRoutingPolicy such that all queries are responded with the primary_targets if they are healthy. And if all of them are unhealthy, then we fallback to a geo localized policy. - "backupGeoTargets": { # Configures a RRSetRoutingPolicy that routes based on the geo location of the querying user. # Backup targets provide a regional failover policy for the otherwise global primary targets. If serving state is set to BACKUP, this policy essentially becomes a geo routing policy. + "backupGeoTargets": { # Configures a `RRSetRoutingPolicy` that routes based on the geo location of the querying user. # Backup targets provide a regional failover policy for the otherwise global primary targets. If serving state is set to `BACKUP`, this policy essentially becomes a geo routing policy. "enableFencing": True or False, # Without fencing, if health check fails for all configured items in the current geo bucket, we failover to the next nearest geo bucket. With fencing, if health checking is enabled, as long as some targets in the current geo bucket are healthy, we return only the healthy targets. However, if all targets are unhealthy, we don't failover to the next nearest bucket; instead, we return all the items in the current bucket even when all targets are unhealthy. "items": [ # The primary geo routing configuration. If there are multiple items with the same location, an error is returned instead. { # ResourceRecordSet data for one geo location. - "healthCheckedTargets": { # HealthCheckTargets describes endpoints to health-check when responding to Routing Policy queries. Only the healthy endpoints will be included in the response. Only one of internal_load_balancer and external_endpoints should be set. # For A and AAAA types only. Endpoints to return in the query result only if they are healthy. These can be specified along with rrdata within this item. + "healthCheckedTargets": { # HealthCheckTargets describes endpoints to health-check when responding to Routing Policy queries. Only the healthy endpoints will be included in the response. # For A and AAAA types only. Endpoints to return in the query result only if they are healthy. These can be specified along with `rrdata` within this item. "internalLoadBalancers": [ # Configuration for internal load balancers to be health checked. { # The configuration for an individual load balancer to health check. "ipAddress": "A String", # The frontend IP address of the load balancer to health check. "ipProtocol": "A String", # The protocol of the load balancer to health check. "kind": "dns#rRSetRoutingPolicyLoadBalancerTarget", "loadBalancerType": "A String", # The type of load balancer specified by this target. This value must match the configuration of the load balancer located at the LoadBalancerTarget's IP address, port, and region. Use the following: - *regionalL4ilb*: for a regional internal passthrough Network Load Balancer. - *regionalL7ilb*: for a regional internal Application Load Balancer. - *globalL7ilb*: for a global internal Application Load Balancer. - "networkUrl": "A String", # The fully qualified URL of the network that the load balancer is attached to. This should be formatted like https://www.googleapis.com/compute/v1/projects/{project}/global/networks/{network} . + "networkUrl": "A String", # The fully qualified URL of the network that the load balancer is attached to. This should be formatted like `https://www.googleapis.com/compute/v1/projects/{project}/global/networks/{network}`. "port": "A String", # The configured port of the load balancer. "project": "A String", # The project ID in which the load balancer is located. "region": "A String", # The region in which the load balancer is located. @@ -829,7 +829,7 @@

Method Details

"rrdatas": [ "A String", ], - "signatureRrdatas": [ # DNSSEC generated signatures for all the rrdata within this item. If health checked targets are provided for DNSSEC enabled zones, there's a restriction of 1 IP address per item. + "signatureRrdatas": [ # DNSSEC generated signatures for all the `rrdata` within this item. If health checked targets are provided for DNSSEC enabled zones, there's a restriction of 1 IP address per item. "A String", ], }, @@ -837,33 +837,33 @@

Method Details

"kind": "dns#rRSetRoutingPolicyGeoPolicy", }, "kind": "dns#rRSetRoutingPolicyPrimaryBackupPolicy", - "primaryTargets": { # HealthCheckTargets describes endpoints to health-check when responding to Routing Policy queries. Only the healthy endpoints will be included in the response. Only one of internal_load_balancer and external_endpoints should be set. # Endpoints that are health checked before making the routing decision. Unhealthy endpoints are omitted from the results. If all endpoints are unhealthy, we serve a response based on the backup_geo_targets. + "primaryTargets": { # HealthCheckTargets describes endpoints to health-check when responding to Routing Policy queries. Only the healthy endpoints will be included in the response. # Endpoints that are health checked before making the routing decision. Unhealthy endpoints are omitted from the results. If all endpoints are unhealthy, we serve a response based on the `backup_geo_targets`. "internalLoadBalancers": [ # Configuration for internal load balancers to be health checked. { # The configuration for an individual load balancer to health check. "ipAddress": "A String", # The frontend IP address of the load balancer to health check. "ipProtocol": "A String", # The protocol of the load balancer to health check. "kind": "dns#rRSetRoutingPolicyLoadBalancerTarget", "loadBalancerType": "A String", # The type of load balancer specified by this target. This value must match the configuration of the load balancer located at the LoadBalancerTarget's IP address, port, and region. Use the following: - *regionalL4ilb*: for a regional internal passthrough Network Load Balancer. - *regionalL7ilb*: for a regional internal Application Load Balancer. - *globalL7ilb*: for a global internal Application Load Balancer. - "networkUrl": "A String", # The fully qualified URL of the network that the load balancer is attached to. This should be formatted like https://www.googleapis.com/compute/v1/projects/{project}/global/networks/{network} . + "networkUrl": "A String", # The fully qualified URL of the network that the load balancer is attached to. This should be formatted like `https://www.googleapis.com/compute/v1/projects/{project}/global/networks/{network}`. "port": "A String", # The configured port of the load balancer. "project": "A String", # The project ID in which the load balancer is located. "region": "A String", # The region in which the load balancer is located. }, ], }, - "trickleTraffic": 3.14, # When serving state is PRIMARY, this field provides the option of sending a small percentage of the traffic to the backup targets. + "trickleTraffic": 3.14, # When serving state is `PRIMARY`, this field provides the option of sending a small percentage of the traffic to the backup targets. }, "wrr": { # Configures a RRSetRoutingPolicy that routes in a weighted round robin fashion. "items": [ { # A routing block which contains the routing information for one WRR item. - "healthCheckedTargets": { # HealthCheckTargets describes endpoints to health-check when responding to Routing Policy queries. Only the healthy endpoints will be included in the response. Only one of internal_load_balancer and external_endpoints should be set. # Endpoints that are health checked before making the routing decision. The unhealthy endpoints are omitted from the result. If all endpoints within a bucket are unhealthy, we choose a different bucket (sampled with respect to its weight) for responding. If DNSSEC is enabled for this zone, only one of rrdata or health_checked_targets can be set. + "healthCheckedTargets": { # HealthCheckTargets describes endpoints to health-check when responding to Routing Policy queries. Only the healthy endpoints will be included in the response. # Endpoints that are health checked before making the routing decision. The unhealthy endpoints are omitted from the result. If all endpoints within a bucket are unhealthy, we choose a different bucket (sampled with respect to its weight) for responding. If DNSSEC is enabled for this zone, only one of `rrdata` or `health_checked_targets` can be set. "internalLoadBalancers": [ # Configuration for internal load balancers to be health checked. { # The configuration for an individual load balancer to health check. "ipAddress": "A String", # The frontend IP address of the load balancer to health check. "ipProtocol": "A String", # The protocol of the load balancer to health check. "kind": "dns#rRSetRoutingPolicyLoadBalancerTarget", "loadBalancerType": "A String", # The type of load balancer specified by this target. This value must match the configuration of the load balancer located at the LoadBalancerTarget's IP address, port, and region. Use the following: - *regionalL4ilb*: for a regional internal passthrough Network Load Balancer. - *regionalL7ilb*: for a regional internal Application Load Balancer. - *globalL7ilb*: for a global internal Application Load Balancer. - "networkUrl": "A String", # The fully qualified URL of the network that the load balancer is attached to. This should be formatted like https://www.googleapis.com/compute/v1/projects/{project}/global/networks/{network} . + "networkUrl": "A String", # The fully qualified URL of the network that the load balancer is attached to. This should be formatted like `https://www.googleapis.com/compute/v1/projects/{project}/global/networks/{network}`. "port": "A String", # The configured port of the load balancer. "project": "A String", # The project ID in which the load balancer is located. "region": "A String", # The region in which the load balancer is located. @@ -874,10 +874,10 @@

Method Details

"rrdatas": [ "A String", ], - "signatureRrdatas": [ # DNSSEC generated signatures for all the rrdata within this item. Note that if health checked targets are provided for DNSSEC enabled zones, there's a restriction of 1 IP address per item. + "signatureRrdatas": [ # DNSSEC generated signatures for all the `rrdata` within this item. Note that if health checked targets are provided for DNSSEC enabled zones, there's a restriction of 1 IP address per item. "A String", ], - "weight": 3.14, # The weight corresponding to this WrrPolicyItem object. When multiple WrrPolicyItem objects are configured, the probability of returning an WrrPolicyItem object's data is proportional to its weight relative to the sum of weights configured for all items. This weight must be non-negative. + "weight": 3.14, # The weight corresponding to this `WrrPolicyItem` object. When multiple `WrrPolicyItem` objects are configured, the probability of returning an `WrrPolicyItem` object's data is proportional to its weight relative to the sum of weights configured for all items. This weight must be non-negative. }, ], "kind": "dns#rRSetRoutingPolicyWrrPolicy", @@ -889,7 +889,7 @@

Method Details

"signatureRrdatas": [ # As defined in RFC 4034 (section 3.2). "A String", ], - "ttl": 42, # Number of seconds that this ResourceRecordSet can be cached by resolvers. + "ttl": 42, # Number of seconds that this `ResourceRecordSet` can be cached by resolvers. "type": "A String", # The identifier of a supported record type. See the list of Supported DNS record types. }, ], @@ -924,24 +924,24 @@

Method Details

{ # The response to a request to enumerate Changes to a ResourceRecordSets collection. "changes": [ # The requested changes. - { # A Change represents a set of ResourceRecordSet additions and deletions applied atomically to a ManagedZone. ResourceRecordSets within a ManagedZone are modified by creating a new Change element in the Changes collection. In turn the Changes collection also records the past modifications to the ResourceRecordSets in a ManagedZone. The current state of the ManagedZone is the sum effect of applying all Change elements in the Changes collection in sequence. + { # A Change represents a set of `ResourceRecordSet` additions and deletions applied atomically to a ManagedZone. ResourceRecordSets within a ManagedZone are modified by creating a new Change element in the Changes collection. In turn the Changes collection also records the past modifications to the `ResourceRecordSets` in a `ManagedZone`. The current state of the `ManagedZone` is the sum effect of applying all `Change` elements in the `Changes` collection in sequence. "additions": [ # Which ResourceRecordSets to add? { # A unit of data that is returned by the DNS servers. "kind": "dns#resourceRecordSet", "name": "A String", # For example, www.example.com. - "routingPolicy": { # A RRSetRoutingPolicy represents ResourceRecordSet data that is returned dynamically with the response varying based on configured properties such as geolocation or by weighted random selection. # Configures dynamic query responses based on either the geo location of the querying user or a weighted round robin based routing policy. A valid ResourceRecordSet contains only rrdata (for static resolution) or a routing_policy (for dynamic resolution). - "geo": { # Configures a RRSetRoutingPolicy that routes based on the geo location of the querying user. + "routingPolicy": { # A RRSetRoutingPolicy represents ResourceRecordSet data that is returned dynamically with the response varying based on configured properties such as geolocation or by weighted random selection. # Configures dynamic query responses based on either the geo location of the querying user or a weighted round robin based routing policy. A valid `ResourceRecordSet` contains only `rrdata` (for static resolution) or a `routing_policy` (for dynamic resolution). + "geo": { # Configures a `RRSetRoutingPolicy` that routes based on the geo location of the querying user. "enableFencing": True or False, # Without fencing, if health check fails for all configured items in the current geo bucket, we failover to the next nearest geo bucket. With fencing, if health checking is enabled, as long as some targets in the current geo bucket are healthy, we return only the healthy targets. However, if all targets are unhealthy, we don't failover to the next nearest bucket; instead, we return all the items in the current bucket even when all targets are unhealthy. "items": [ # The primary geo routing configuration. If there are multiple items with the same location, an error is returned instead. { # ResourceRecordSet data for one geo location. - "healthCheckedTargets": { # HealthCheckTargets describes endpoints to health-check when responding to Routing Policy queries. Only the healthy endpoints will be included in the response. Only one of internal_load_balancer and external_endpoints should be set. # For A and AAAA types only. Endpoints to return in the query result only if they are healthy. These can be specified along with rrdata within this item. + "healthCheckedTargets": { # HealthCheckTargets describes endpoints to health-check when responding to Routing Policy queries. Only the healthy endpoints will be included in the response. # For A and AAAA types only. Endpoints to return in the query result only if they are healthy. These can be specified along with `rrdata` within this item. "internalLoadBalancers": [ # Configuration for internal load balancers to be health checked. { # The configuration for an individual load balancer to health check. "ipAddress": "A String", # The frontend IP address of the load balancer to health check. "ipProtocol": "A String", # The protocol of the load balancer to health check. "kind": "dns#rRSetRoutingPolicyLoadBalancerTarget", "loadBalancerType": "A String", # The type of load balancer specified by this target. This value must match the configuration of the load balancer located at the LoadBalancerTarget's IP address, port, and region. Use the following: - *regionalL4ilb*: for a regional internal passthrough Network Load Balancer. - *regionalL7ilb*: for a regional internal Application Load Balancer. - *globalL7ilb*: for a global internal Application Load Balancer. - "networkUrl": "A String", # The fully qualified URL of the network that the load balancer is attached to. This should be formatted like https://www.googleapis.com/compute/v1/projects/{project}/global/networks/{network} . + "networkUrl": "A String", # The fully qualified URL of the network that the load balancer is attached to. This should be formatted like `https://www.googleapis.com/compute/v1/projects/{project}/global/networks/{network}`. "port": "A String", # The configured port of the load balancer. "project": "A String", # The project ID in which the load balancer is located. "region": "A String", # The region in which the load balancer is located. @@ -953,7 +953,7 @@

Method Details

"rrdatas": [ "A String", ], - "signatureRrdatas": [ # DNSSEC generated signatures for all the rrdata within this item. If health checked targets are provided for DNSSEC enabled zones, there's a restriction of 1 IP address per item. + "signatureRrdatas": [ # DNSSEC generated signatures for all the `rrdata` within this item. If health checked targets are provided for DNSSEC enabled zones, there's a restriction of 1 IP address per item. "A String", ], }, @@ -962,18 +962,18 @@

Method Details

}, "kind": "dns#rRSetRoutingPolicy", "primaryBackup": { # Configures a RRSetRoutingPolicy such that all queries are responded with the primary_targets if they are healthy. And if all of them are unhealthy, then we fallback to a geo localized policy. - "backupGeoTargets": { # Configures a RRSetRoutingPolicy that routes based on the geo location of the querying user. # Backup targets provide a regional failover policy for the otherwise global primary targets. If serving state is set to BACKUP, this policy essentially becomes a geo routing policy. + "backupGeoTargets": { # Configures a `RRSetRoutingPolicy` that routes based on the geo location of the querying user. # Backup targets provide a regional failover policy for the otherwise global primary targets. If serving state is set to `BACKUP`, this policy essentially becomes a geo routing policy. "enableFencing": True or False, # Without fencing, if health check fails for all configured items in the current geo bucket, we failover to the next nearest geo bucket. With fencing, if health checking is enabled, as long as some targets in the current geo bucket are healthy, we return only the healthy targets. However, if all targets are unhealthy, we don't failover to the next nearest bucket; instead, we return all the items in the current bucket even when all targets are unhealthy. "items": [ # The primary geo routing configuration. If there are multiple items with the same location, an error is returned instead. { # ResourceRecordSet data for one geo location. - "healthCheckedTargets": { # HealthCheckTargets describes endpoints to health-check when responding to Routing Policy queries. Only the healthy endpoints will be included in the response. Only one of internal_load_balancer and external_endpoints should be set. # For A and AAAA types only. Endpoints to return in the query result only if they are healthy. These can be specified along with rrdata within this item. + "healthCheckedTargets": { # HealthCheckTargets describes endpoints to health-check when responding to Routing Policy queries. Only the healthy endpoints will be included in the response. # For A and AAAA types only. Endpoints to return in the query result only if they are healthy. These can be specified along with `rrdata` within this item. "internalLoadBalancers": [ # Configuration for internal load balancers to be health checked. { # The configuration for an individual load balancer to health check. "ipAddress": "A String", # The frontend IP address of the load balancer to health check. "ipProtocol": "A String", # The protocol of the load balancer to health check. "kind": "dns#rRSetRoutingPolicyLoadBalancerTarget", "loadBalancerType": "A String", # The type of load balancer specified by this target. This value must match the configuration of the load balancer located at the LoadBalancerTarget's IP address, port, and region. Use the following: - *regionalL4ilb*: for a regional internal passthrough Network Load Balancer. - *regionalL7ilb*: for a regional internal Application Load Balancer. - *globalL7ilb*: for a global internal Application Load Balancer. - "networkUrl": "A String", # The fully qualified URL of the network that the load balancer is attached to. This should be formatted like https://www.googleapis.com/compute/v1/projects/{project}/global/networks/{network} . + "networkUrl": "A String", # The fully qualified URL of the network that the load balancer is attached to. This should be formatted like `https://www.googleapis.com/compute/v1/projects/{project}/global/networks/{network}`. "port": "A String", # The configured port of the load balancer. "project": "A String", # The project ID in which the load balancer is located. "region": "A String", # The region in which the load balancer is located. @@ -985,7 +985,7 @@

Method Details

"rrdatas": [ "A String", ], - "signatureRrdatas": [ # DNSSEC generated signatures for all the rrdata within this item. If health checked targets are provided for DNSSEC enabled zones, there's a restriction of 1 IP address per item. + "signatureRrdatas": [ # DNSSEC generated signatures for all the `rrdata` within this item. If health checked targets are provided for DNSSEC enabled zones, there's a restriction of 1 IP address per item. "A String", ], }, @@ -993,33 +993,33 @@

Method Details

"kind": "dns#rRSetRoutingPolicyGeoPolicy", }, "kind": "dns#rRSetRoutingPolicyPrimaryBackupPolicy", - "primaryTargets": { # HealthCheckTargets describes endpoints to health-check when responding to Routing Policy queries. Only the healthy endpoints will be included in the response. Only one of internal_load_balancer and external_endpoints should be set. # Endpoints that are health checked before making the routing decision. Unhealthy endpoints are omitted from the results. If all endpoints are unhealthy, we serve a response based on the backup_geo_targets. + "primaryTargets": { # HealthCheckTargets describes endpoints to health-check when responding to Routing Policy queries. Only the healthy endpoints will be included in the response. # Endpoints that are health checked before making the routing decision. Unhealthy endpoints are omitted from the results. If all endpoints are unhealthy, we serve a response based on the `backup_geo_targets`. "internalLoadBalancers": [ # Configuration for internal load balancers to be health checked. { # The configuration for an individual load balancer to health check. "ipAddress": "A String", # The frontend IP address of the load balancer to health check. "ipProtocol": "A String", # The protocol of the load balancer to health check. "kind": "dns#rRSetRoutingPolicyLoadBalancerTarget", "loadBalancerType": "A String", # The type of load balancer specified by this target. This value must match the configuration of the load balancer located at the LoadBalancerTarget's IP address, port, and region. Use the following: - *regionalL4ilb*: for a regional internal passthrough Network Load Balancer. - *regionalL7ilb*: for a regional internal Application Load Balancer. - *globalL7ilb*: for a global internal Application Load Balancer. - "networkUrl": "A String", # The fully qualified URL of the network that the load balancer is attached to. This should be formatted like https://www.googleapis.com/compute/v1/projects/{project}/global/networks/{network} . + "networkUrl": "A String", # The fully qualified URL of the network that the load balancer is attached to. This should be formatted like `https://www.googleapis.com/compute/v1/projects/{project}/global/networks/{network}`. "port": "A String", # The configured port of the load balancer. "project": "A String", # The project ID in which the load balancer is located. "region": "A String", # The region in which the load balancer is located. }, ], }, - "trickleTraffic": 3.14, # When serving state is PRIMARY, this field provides the option of sending a small percentage of the traffic to the backup targets. + "trickleTraffic": 3.14, # When serving state is `PRIMARY`, this field provides the option of sending a small percentage of the traffic to the backup targets. }, "wrr": { # Configures a RRSetRoutingPolicy that routes in a weighted round robin fashion. "items": [ { # A routing block which contains the routing information for one WRR item. - "healthCheckedTargets": { # HealthCheckTargets describes endpoints to health-check when responding to Routing Policy queries. Only the healthy endpoints will be included in the response. Only one of internal_load_balancer and external_endpoints should be set. # Endpoints that are health checked before making the routing decision. The unhealthy endpoints are omitted from the result. If all endpoints within a bucket are unhealthy, we choose a different bucket (sampled with respect to its weight) for responding. If DNSSEC is enabled for this zone, only one of rrdata or health_checked_targets can be set. + "healthCheckedTargets": { # HealthCheckTargets describes endpoints to health-check when responding to Routing Policy queries. Only the healthy endpoints will be included in the response. # Endpoints that are health checked before making the routing decision. The unhealthy endpoints are omitted from the result. If all endpoints within a bucket are unhealthy, we choose a different bucket (sampled with respect to its weight) for responding. If DNSSEC is enabled for this zone, only one of `rrdata` or `health_checked_targets` can be set. "internalLoadBalancers": [ # Configuration for internal load balancers to be health checked. { # The configuration for an individual load balancer to health check. "ipAddress": "A String", # The frontend IP address of the load balancer to health check. "ipProtocol": "A String", # The protocol of the load balancer to health check. "kind": "dns#rRSetRoutingPolicyLoadBalancerTarget", "loadBalancerType": "A String", # The type of load balancer specified by this target. This value must match the configuration of the load balancer located at the LoadBalancerTarget's IP address, port, and region. Use the following: - *regionalL4ilb*: for a regional internal passthrough Network Load Balancer. - *regionalL7ilb*: for a regional internal Application Load Balancer. - *globalL7ilb*: for a global internal Application Load Balancer. - "networkUrl": "A String", # The fully qualified URL of the network that the load balancer is attached to. This should be formatted like https://www.googleapis.com/compute/v1/projects/{project}/global/networks/{network} . + "networkUrl": "A String", # The fully qualified URL of the network that the load balancer is attached to. This should be formatted like `https://www.googleapis.com/compute/v1/projects/{project}/global/networks/{network}`. "port": "A String", # The configured port of the load balancer. "project": "A String", # The project ID in which the load balancer is located. "region": "A String", # The region in which the load balancer is located. @@ -1030,10 +1030,10 @@

Method Details

"rrdatas": [ "A String", ], - "signatureRrdatas": [ # DNSSEC generated signatures for all the rrdata within this item. Note that if health checked targets are provided for DNSSEC enabled zones, there's a restriction of 1 IP address per item. + "signatureRrdatas": [ # DNSSEC generated signatures for all the `rrdata` within this item. Note that if health checked targets are provided for DNSSEC enabled zones, there's a restriction of 1 IP address per item. "A String", ], - "weight": 3.14, # The weight corresponding to this WrrPolicyItem object. When multiple WrrPolicyItem objects are configured, the probability of returning an WrrPolicyItem object's data is proportional to its weight relative to the sum of weights configured for all items. This weight must be non-negative. + "weight": 3.14, # The weight corresponding to this `WrrPolicyItem` object. When multiple `WrrPolicyItem` objects are configured, the probability of returning an `WrrPolicyItem` object's data is proportional to its weight relative to the sum of weights configured for all items. This weight must be non-negative. }, ], "kind": "dns#rRSetRoutingPolicyWrrPolicy", @@ -1045,7 +1045,7 @@

Method Details

"signatureRrdatas": [ # As defined in RFC 4034 (section 3.2). "A String", ], - "ttl": 42, # Number of seconds that this ResourceRecordSet can be cached by resolvers. + "ttl": 42, # Number of seconds that this `ResourceRecordSet` can be cached by resolvers. "type": "A String", # The identifier of a supported record type. See the list of Supported DNS record types. }, ], @@ -1053,19 +1053,19 @@

Method Details

{ # A unit of data that is returned by the DNS servers. "kind": "dns#resourceRecordSet", "name": "A String", # For example, www.example.com. - "routingPolicy": { # A RRSetRoutingPolicy represents ResourceRecordSet data that is returned dynamically with the response varying based on configured properties such as geolocation or by weighted random selection. # Configures dynamic query responses based on either the geo location of the querying user or a weighted round robin based routing policy. A valid ResourceRecordSet contains only rrdata (for static resolution) or a routing_policy (for dynamic resolution). - "geo": { # Configures a RRSetRoutingPolicy that routes based on the geo location of the querying user. + "routingPolicy": { # A RRSetRoutingPolicy represents ResourceRecordSet data that is returned dynamically with the response varying based on configured properties such as geolocation or by weighted random selection. # Configures dynamic query responses based on either the geo location of the querying user or a weighted round robin based routing policy. A valid `ResourceRecordSet` contains only `rrdata` (for static resolution) or a `routing_policy` (for dynamic resolution). + "geo": { # Configures a `RRSetRoutingPolicy` that routes based on the geo location of the querying user. "enableFencing": True or False, # Without fencing, if health check fails for all configured items in the current geo bucket, we failover to the next nearest geo bucket. With fencing, if health checking is enabled, as long as some targets in the current geo bucket are healthy, we return only the healthy targets. However, if all targets are unhealthy, we don't failover to the next nearest bucket; instead, we return all the items in the current bucket even when all targets are unhealthy. "items": [ # The primary geo routing configuration. If there are multiple items with the same location, an error is returned instead. { # ResourceRecordSet data for one geo location. - "healthCheckedTargets": { # HealthCheckTargets describes endpoints to health-check when responding to Routing Policy queries. Only the healthy endpoints will be included in the response. Only one of internal_load_balancer and external_endpoints should be set. # For A and AAAA types only. Endpoints to return in the query result only if they are healthy. These can be specified along with rrdata within this item. + "healthCheckedTargets": { # HealthCheckTargets describes endpoints to health-check when responding to Routing Policy queries. Only the healthy endpoints will be included in the response. # For A and AAAA types only. Endpoints to return in the query result only if they are healthy. These can be specified along with `rrdata` within this item. "internalLoadBalancers": [ # Configuration for internal load balancers to be health checked. { # The configuration for an individual load balancer to health check. "ipAddress": "A String", # The frontend IP address of the load balancer to health check. "ipProtocol": "A String", # The protocol of the load balancer to health check. "kind": "dns#rRSetRoutingPolicyLoadBalancerTarget", "loadBalancerType": "A String", # The type of load balancer specified by this target. This value must match the configuration of the load balancer located at the LoadBalancerTarget's IP address, port, and region. Use the following: - *regionalL4ilb*: for a regional internal passthrough Network Load Balancer. - *regionalL7ilb*: for a regional internal Application Load Balancer. - *globalL7ilb*: for a global internal Application Load Balancer. - "networkUrl": "A String", # The fully qualified URL of the network that the load balancer is attached to. This should be formatted like https://www.googleapis.com/compute/v1/projects/{project}/global/networks/{network} . + "networkUrl": "A String", # The fully qualified URL of the network that the load balancer is attached to. This should be formatted like `https://www.googleapis.com/compute/v1/projects/{project}/global/networks/{network}`. "port": "A String", # The configured port of the load balancer. "project": "A String", # The project ID in which the load balancer is located. "region": "A String", # The region in which the load balancer is located. @@ -1077,7 +1077,7 @@

Method Details

"rrdatas": [ "A String", ], - "signatureRrdatas": [ # DNSSEC generated signatures for all the rrdata within this item. If health checked targets are provided for DNSSEC enabled zones, there's a restriction of 1 IP address per item. + "signatureRrdatas": [ # DNSSEC generated signatures for all the `rrdata` within this item. If health checked targets are provided for DNSSEC enabled zones, there's a restriction of 1 IP address per item. "A String", ], }, @@ -1086,18 +1086,18 @@

Method Details

}, "kind": "dns#rRSetRoutingPolicy", "primaryBackup": { # Configures a RRSetRoutingPolicy such that all queries are responded with the primary_targets if they are healthy. And if all of them are unhealthy, then we fallback to a geo localized policy. - "backupGeoTargets": { # Configures a RRSetRoutingPolicy that routes based on the geo location of the querying user. # Backup targets provide a regional failover policy for the otherwise global primary targets. If serving state is set to BACKUP, this policy essentially becomes a geo routing policy. + "backupGeoTargets": { # Configures a `RRSetRoutingPolicy` that routes based on the geo location of the querying user. # Backup targets provide a regional failover policy for the otherwise global primary targets. If serving state is set to `BACKUP`, this policy essentially becomes a geo routing policy. "enableFencing": True or False, # Without fencing, if health check fails for all configured items in the current geo bucket, we failover to the next nearest geo bucket. With fencing, if health checking is enabled, as long as some targets in the current geo bucket are healthy, we return only the healthy targets. However, if all targets are unhealthy, we don't failover to the next nearest bucket; instead, we return all the items in the current bucket even when all targets are unhealthy. "items": [ # The primary geo routing configuration. If there are multiple items with the same location, an error is returned instead. { # ResourceRecordSet data for one geo location. - "healthCheckedTargets": { # HealthCheckTargets describes endpoints to health-check when responding to Routing Policy queries. Only the healthy endpoints will be included in the response. Only one of internal_load_balancer and external_endpoints should be set. # For A and AAAA types only. Endpoints to return in the query result only if they are healthy. These can be specified along with rrdata within this item. + "healthCheckedTargets": { # HealthCheckTargets describes endpoints to health-check when responding to Routing Policy queries. Only the healthy endpoints will be included in the response. # For A and AAAA types only. Endpoints to return in the query result only if they are healthy. These can be specified along with `rrdata` within this item. "internalLoadBalancers": [ # Configuration for internal load balancers to be health checked. { # The configuration for an individual load balancer to health check. "ipAddress": "A String", # The frontend IP address of the load balancer to health check. "ipProtocol": "A String", # The protocol of the load balancer to health check. "kind": "dns#rRSetRoutingPolicyLoadBalancerTarget", "loadBalancerType": "A String", # The type of load balancer specified by this target. This value must match the configuration of the load balancer located at the LoadBalancerTarget's IP address, port, and region. Use the following: - *regionalL4ilb*: for a regional internal passthrough Network Load Balancer. - *regionalL7ilb*: for a regional internal Application Load Balancer. - *globalL7ilb*: for a global internal Application Load Balancer. - "networkUrl": "A String", # The fully qualified URL of the network that the load balancer is attached to. This should be formatted like https://www.googleapis.com/compute/v1/projects/{project}/global/networks/{network} . + "networkUrl": "A String", # The fully qualified URL of the network that the load balancer is attached to. This should be formatted like `https://www.googleapis.com/compute/v1/projects/{project}/global/networks/{network}`. "port": "A String", # The configured port of the load balancer. "project": "A String", # The project ID in which the load balancer is located. "region": "A String", # The region in which the load balancer is located. @@ -1109,7 +1109,7 @@

Method Details

"rrdatas": [ "A String", ], - "signatureRrdatas": [ # DNSSEC generated signatures for all the rrdata within this item. If health checked targets are provided for DNSSEC enabled zones, there's a restriction of 1 IP address per item. + "signatureRrdatas": [ # DNSSEC generated signatures for all the `rrdata` within this item. If health checked targets are provided for DNSSEC enabled zones, there's a restriction of 1 IP address per item. "A String", ], }, @@ -1117,33 +1117,33 @@

Method Details

"kind": "dns#rRSetRoutingPolicyGeoPolicy", }, "kind": "dns#rRSetRoutingPolicyPrimaryBackupPolicy", - "primaryTargets": { # HealthCheckTargets describes endpoints to health-check when responding to Routing Policy queries. Only the healthy endpoints will be included in the response. Only one of internal_load_balancer and external_endpoints should be set. # Endpoints that are health checked before making the routing decision. Unhealthy endpoints are omitted from the results. If all endpoints are unhealthy, we serve a response based on the backup_geo_targets. + "primaryTargets": { # HealthCheckTargets describes endpoints to health-check when responding to Routing Policy queries. Only the healthy endpoints will be included in the response. # Endpoints that are health checked before making the routing decision. Unhealthy endpoints are omitted from the results. If all endpoints are unhealthy, we serve a response based on the `backup_geo_targets`. "internalLoadBalancers": [ # Configuration for internal load balancers to be health checked. { # The configuration for an individual load balancer to health check. "ipAddress": "A String", # The frontend IP address of the load balancer to health check. "ipProtocol": "A String", # The protocol of the load balancer to health check. "kind": "dns#rRSetRoutingPolicyLoadBalancerTarget", "loadBalancerType": "A String", # The type of load balancer specified by this target. This value must match the configuration of the load balancer located at the LoadBalancerTarget's IP address, port, and region. Use the following: - *regionalL4ilb*: for a regional internal passthrough Network Load Balancer. - *regionalL7ilb*: for a regional internal Application Load Balancer. - *globalL7ilb*: for a global internal Application Load Balancer. - "networkUrl": "A String", # The fully qualified URL of the network that the load balancer is attached to. This should be formatted like https://www.googleapis.com/compute/v1/projects/{project}/global/networks/{network} . + "networkUrl": "A String", # The fully qualified URL of the network that the load balancer is attached to. This should be formatted like `https://www.googleapis.com/compute/v1/projects/{project}/global/networks/{network}`. "port": "A String", # The configured port of the load balancer. "project": "A String", # The project ID in which the load balancer is located. "region": "A String", # The region in which the load balancer is located. }, ], }, - "trickleTraffic": 3.14, # When serving state is PRIMARY, this field provides the option of sending a small percentage of the traffic to the backup targets. + "trickleTraffic": 3.14, # When serving state is `PRIMARY`, this field provides the option of sending a small percentage of the traffic to the backup targets. }, "wrr": { # Configures a RRSetRoutingPolicy that routes in a weighted round robin fashion. "items": [ { # A routing block which contains the routing information for one WRR item. - "healthCheckedTargets": { # HealthCheckTargets describes endpoints to health-check when responding to Routing Policy queries. Only the healthy endpoints will be included in the response. Only one of internal_load_balancer and external_endpoints should be set. # Endpoints that are health checked before making the routing decision. The unhealthy endpoints are omitted from the result. If all endpoints within a bucket are unhealthy, we choose a different bucket (sampled with respect to its weight) for responding. If DNSSEC is enabled for this zone, only one of rrdata or health_checked_targets can be set. + "healthCheckedTargets": { # HealthCheckTargets describes endpoints to health-check when responding to Routing Policy queries. Only the healthy endpoints will be included in the response. # Endpoints that are health checked before making the routing decision. The unhealthy endpoints are omitted from the result. If all endpoints within a bucket are unhealthy, we choose a different bucket (sampled with respect to its weight) for responding. If DNSSEC is enabled for this zone, only one of `rrdata` or `health_checked_targets` can be set. "internalLoadBalancers": [ # Configuration for internal load balancers to be health checked. { # The configuration for an individual load balancer to health check. "ipAddress": "A String", # The frontend IP address of the load balancer to health check. "ipProtocol": "A String", # The protocol of the load balancer to health check. "kind": "dns#rRSetRoutingPolicyLoadBalancerTarget", "loadBalancerType": "A String", # The type of load balancer specified by this target. This value must match the configuration of the load balancer located at the LoadBalancerTarget's IP address, port, and region. Use the following: - *regionalL4ilb*: for a regional internal passthrough Network Load Balancer. - *regionalL7ilb*: for a regional internal Application Load Balancer. - *globalL7ilb*: for a global internal Application Load Balancer. - "networkUrl": "A String", # The fully qualified URL of the network that the load balancer is attached to. This should be formatted like https://www.googleapis.com/compute/v1/projects/{project}/global/networks/{network} . + "networkUrl": "A String", # The fully qualified URL of the network that the load balancer is attached to. This should be formatted like `https://www.googleapis.com/compute/v1/projects/{project}/global/networks/{network}`. "port": "A String", # The configured port of the load balancer. "project": "A String", # The project ID in which the load balancer is located. "region": "A String", # The region in which the load balancer is located. @@ -1154,10 +1154,10 @@

Method Details

"rrdatas": [ "A String", ], - "signatureRrdatas": [ # DNSSEC generated signatures for all the rrdata within this item. Note that if health checked targets are provided for DNSSEC enabled zones, there's a restriction of 1 IP address per item. + "signatureRrdatas": [ # DNSSEC generated signatures for all the `rrdata` within this item. Note that if health checked targets are provided for DNSSEC enabled zones, there's a restriction of 1 IP address per item. "A String", ], - "weight": 3.14, # The weight corresponding to this WrrPolicyItem object. When multiple WrrPolicyItem objects are configured, the probability of returning an WrrPolicyItem object's data is proportional to its weight relative to the sum of weights configured for all items. This weight must be non-negative. + "weight": 3.14, # The weight corresponding to this `WrrPolicyItem` object. When multiple `WrrPolicyItem` objects are configured, the probability of returning an `WrrPolicyItem` object's data is proportional to its weight relative to the sum of weights configured for all items. This weight must be non-negative. }, ], "kind": "dns#rRSetRoutingPolicyWrrPolicy", @@ -1169,7 +1169,7 @@

Method Details

"signatureRrdatas": [ # As defined in RFC 4034 (section 3.2). "A String", ], - "ttl": 42, # Number of seconds that this ResourceRecordSet can be cached by resolvers. + "ttl": 42, # Number of seconds that this `ResourceRecordSet` can be cached by resolvers. "type": "A String", # The identifier of a supported record type. See the list of Supported DNS record types. }, ], @@ -1180,11 +1180,8 @@

Method Details

"status": "A String", # Status of the operation (output only). A status of "done" means that the request to update the authoritative servers has been sent, but the servers might not be updated yet. }, ], - "header": { # Elements common to every response. - "operationId": "A String", # For mutating operation requests that completed successfully. This is the client_operation_id if the client specified it, otherwise it is generated by the server (output only). - }, "kind": "dns#changesListResponse", # Type of resource. - "nextPageToken": "A String", # The presence of this field indicates that there exist more results following your last page of results in pagination order. To fetch them, make another list request using this value as your pagination token. This lets you retrieve the complete contents of even very large collections one page at a time. However, if the contents of the collection change between the first and last paginated list request, the set of all elements returned are an inconsistent view of the collection. You cannot retrieve a "snapshot" of collections larger than the maximum page size. + "nextPageToken": "A String", # This field indicates that more results are available beyond the last page displayed. To fetch the results, make another list request and use this value as your page token. This lets you retrieve the complete contents of a very large collection one page at a time. However, if the contents of the collection change between the first and last paginated list request, the set of all elements returned are an inconsistent view of the collection. You can't retrieve a consistent snapshot of a collection larger than the maximum page size. }
diff --git a/docs/dyn/dns_v1.dnsKeys.html b/docs/dyn/dns_v1.dnsKeys.html index 275d1d0cba3..b8130c6eb1b 100644 --- a/docs/dyn/dns_v1.dnsKeys.html +++ b/docs/dyn/dns_v1.dnsKeys.html @@ -169,11 +169,8 @@

Method Details

"type": "A String", # One of "KEY_SIGNING" or "ZONE_SIGNING". Keys of type KEY_SIGNING have the Secure Entry Point flag set and, when active, are used to sign only resource record sets of type DNSKEY. Otherwise, the Secure Entry Point flag is cleared, and this key is used to sign only resource record sets of other types. Immutable after creation time. }, ], - "header": { # Elements common to every response. - "operationId": "A String", # For mutating operation requests that completed successfully. This is the client_operation_id if the client specified it, otherwise it is generated by the server (output only). - }, "kind": "dns#dnsKeysListResponse", # Type of resource. - "nextPageToken": "A String", # The presence of this field indicates that there exist more results following your last page of results in pagination order. To fetch them, make another list request using this value as your pagination token. In this way you can retrieve the complete contents of even very large collections one page at a time. However, if the contents of the collection change between the first and last paginated list request, the set of all elements returned are an inconsistent view of the collection. There is no way to retrieve a "snapshot" of collections larger than the maximum page size. + "nextPageToken": "A String", # This field indicates that more results are available beyond the last page displayed. To fetch the results, make another list request and use this value as your page token. This lets you retrieve the complete contents of a very large collection one page at a time. However, if the contents of the collection change between the first and last paginated list request, the set of all elements returned are an inconsistent view of the collection. You can't retrieve a consistent snapshot of a collection larger than the maximum page size. }
diff --git a/docs/dyn/dns_v1.managedZoneOperations.html b/docs/dyn/dns_v1.managedZoneOperations.html index 7cbae57f84a..e8b482f3316 100644 --- a/docs/dyn/dns_v1.managedZoneOperations.html +++ b/docs/dyn/dns_v1.managedZoneOperations.html @@ -202,7 +202,7 @@

Method Details

"targetNetwork": { # The network with which to peer. "deactivateTime": "A String", # The time at which the zone was deactivated, in RFC 3339 date-time format. An empty string indicates that the peering connection is active. The producer network can deactivate a zone. The zone is automatically deactivated if the producer network that the zone targeted is deleted. Output only. "kind": "dns#managedZonePeeringConfigTargetNetwork", - "networkUrl": "A String", # The fully qualified URL of the VPC network to forward queries to. This should be formatted like https://www.googleapis.com/compute/v1/projects/{project}/global/networks/{network} + "networkUrl": "A String", # The fully qualified URL of the VPC network to forward queries to. This should be formatted like `https://www.googleapis.com/compute/v1/projects/{project}/global/networks/{network}` }, }, "privateVisibilityConfig": { # For privately visible zones, the set of Virtual Private Cloud resources that the zone is visible from. @@ -216,7 +216,7 @@

Method Details

"networks": [ # The list of VPC networks that can see this zone. { "kind": "dns#managedZonePrivateVisibilityConfigNetwork", - "networkUrl": "A String", # The fully qualified URL of the VPC network to bind to. Format this URL like https://www.googleapis.com/compute/v1/projects/{project}/global/networks/{network} + "networkUrl": "A String", # The fully qualified URL of the VPC network to bind to. Format this URL like `https://www.googleapis.com/compute/v1/projects/{project}/global/networks/{network}` }, ], }, @@ -228,7 +228,7 @@

Method Details

"namespace": { # Contains information about the namespace associated with the zone. "deletionTime": "A String", # The time that the namespace backing this zone was deleted; an empty string if it still exists. This is in RFC3339 text format. Output only. "kind": "dns#managedZoneServiceDirectoryConfigNamespace", - "namespaceUrl": "A String", # The fully qualified URL of the namespace associated with the zone. Format must be https://servicedirectory.googleapis.com/v1/projects/{project}/locations/{location}/namespaces/{namespace} + "namespaceUrl": "A String", # The fully qualified URL of the namespace associated with the zone. Format must be `https://servicedirectory.googleapis.com/v1/projects/{project}/locations/{location}/namespaces/{namespace}` }, }, "visibility": "A String", # The zone's visibility: public zones are exposed to the Internet, while private zones are visible only to Virtual Private Cloud resources. @@ -280,7 +280,7 @@

Method Details

"targetNetwork": { # The network with which to peer. "deactivateTime": "A String", # The time at which the zone was deactivated, in RFC 3339 date-time format. An empty string indicates that the peering connection is active. The producer network can deactivate a zone. The zone is automatically deactivated if the producer network that the zone targeted is deleted. Output only. "kind": "dns#managedZonePeeringConfigTargetNetwork", - "networkUrl": "A String", # The fully qualified URL of the VPC network to forward queries to. This should be formatted like https://www.googleapis.com/compute/v1/projects/{project}/global/networks/{network} + "networkUrl": "A String", # The fully qualified URL of the VPC network to forward queries to. This should be formatted like `https://www.googleapis.com/compute/v1/projects/{project}/global/networks/{network}` }, }, "privateVisibilityConfig": { # For privately visible zones, the set of Virtual Private Cloud resources that the zone is visible from. @@ -294,7 +294,7 @@

Method Details

"networks": [ # The list of VPC networks that can see this zone. { "kind": "dns#managedZonePrivateVisibilityConfigNetwork", - "networkUrl": "A String", # The fully qualified URL of the VPC network to bind to. Format this URL like https://www.googleapis.com/compute/v1/projects/{project}/global/networks/{network} + "networkUrl": "A String", # The fully qualified URL of the VPC network to bind to. Format this URL like `https://www.googleapis.com/compute/v1/projects/{project}/global/networks/{network}` }, ], }, @@ -306,7 +306,7 @@

Method Details

"namespace": { # Contains information about the namespace associated with the zone. "deletionTime": "A String", # The time that the namespace backing this zone was deleted; an empty string if it still exists. This is in RFC3339 text format. Output only. "kind": "dns#managedZoneServiceDirectoryConfigNamespace", - "namespaceUrl": "A String", # The fully qualified URL of the namespace associated with the zone. Format must be https://servicedirectory.googleapis.com/v1/projects/{project}/locations/{location}/namespaces/{namespace} + "namespaceUrl": "A String", # The fully qualified URL of the namespace associated with the zone. Format must be `https://servicedirectory.googleapis.com/v1/projects/{project}/locations/{location}/namespaces/{namespace}` }, }, "visibility": "A String", # The zone's visibility: public zones are exposed to the Internet, while private zones are visible only to Virtual Private Cloud resources. @@ -337,11 +337,8 @@

Method Details

An object of the form: { - "header": { # Elements common to every response. - "operationId": "A String", # For mutating operation requests that completed successfully. This is the client_operation_id if the client specified it, otherwise it is generated by the server (output only). - }, "kind": "dns#managedZoneOperationsListResponse", # Type of resource. - "nextPageToken": "A String", # The presence of this field indicates that there exist more results following your last page of results in pagination order. To fetch them, make another list request using this value as your page token. This lets you retrieve the complete contents of even very large collections one page at a time. However, if the contents of the collection change between the first and last paginated list request, the set of all elements returned are an inconsistent view of the collection. You cannot retrieve a consistent snapshot of a collection larger than the maximum page size. + "nextPageToken": "A String", # This field indicates that more results are available beyond the last page displayed. To fetch the results, make another list request and use this value as your page token. This lets you retrieve the complete contents of a very large collection one page at a time. However, if the contents of the collection change between the first and last paginated list request, the set of all elements returned are an inconsistent view of the collection. You can't retrieve a consistent snapshot of a collection larger than the maximum page size. "operations": [ # The operation resources. { # An operation represents a successful mutation performed on a Cloud DNS resource. Operations provide: - An audit log of server resource mutations. - A way to recover/retry API calls in the case where the response is never received by the caller. Use the caller specified client_operation_id. "dnsKeyContext": { # Only populated if the operation targeted a DnsKey (output only). @@ -436,7 +433,7 @@

Method Details

"targetNetwork": { # The network with which to peer. "deactivateTime": "A String", # The time at which the zone was deactivated, in RFC 3339 date-time format. An empty string indicates that the peering connection is active. The producer network can deactivate a zone. The zone is automatically deactivated if the producer network that the zone targeted is deleted. Output only. "kind": "dns#managedZonePeeringConfigTargetNetwork", - "networkUrl": "A String", # The fully qualified URL of the VPC network to forward queries to. This should be formatted like https://www.googleapis.com/compute/v1/projects/{project}/global/networks/{network} + "networkUrl": "A String", # The fully qualified URL of the VPC network to forward queries to. This should be formatted like `https://www.googleapis.com/compute/v1/projects/{project}/global/networks/{network}` }, }, "privateVisibilityConfig": { # For privately visible zones, the set of Virtual Private Cloud resources that the zone is visible from. @@ -450,7 +447,7 @@

Method Details

"networks": [ # The list of VPC networks that can see this zone. { "kind": "dns#managedZonePrivateVisibilityConfigNetwork", - "networkUrl": "A String", # The fully qualified URL of the VPC network to bind to. Format this URL like https://www.googleapis.com/compute/v1/projects/{project}/global/networks/{network} + "networkUrl": "A String", # The fully qualified URL of the VPC network to bind to. Format this URL like `https://www.googleapis.com/compute/v1/projects/{project}/global/networks/{network}` }, ], }, @@ -462,7 +459,7 @@

Method Details

"namespace": { # Contains information about the namespace associated with the zone. "deletionTime": "A String", # The time that the namespace backing this zone was deleted; an empty string if it still exists. This is in RFC3339 text format. Output only. "kind": "dns#managedZoneServiceDirectoryConfigNamespace", - "namespaceUrl": "A String", # The fully qualified URL of the namespace associated with the zone. Format must be https://servicedirectory.googleapis.com/v1/projects/{project}/locations/{location}/namespaces/{namespace} + "namespaceUrl": "A String", # The fully qualified URL of the namespace associated with the zone. Format must be `https://servicedirectory.googleapis.com/v1/projects/{project}/locations/{location}/namespaces/{namespace}` }, }, "visibility": "A String", # The zone's visibility: public zones are exposed to the Internet, while private zones are visible only to Virtual Private Cloud resources. @@ -514,7 +511,7 @@

Method Details

"targetNetwork": { # The network with which to peer. "deactivateTime": "A String", # The time at which the zone was deactivated, in RFC 3339 date-time format. An empty string indicates that the peering connection is active. The producer network can deactivate a zone. The zone is automatically deactivated if the producer network that the zone targeted is deleted. Output only. "kind": "dns#managedZonePeeringConfigTargetNetwork", - "networkUrl": "A String", # The fully qualified URL of the VPC network to forward queries to. This should be formatted like https://www.googleapis.com/compute/v1/projects/{project}/global/networks/{network} + "networkUrl": "A String", # The fully qualified URL of the VPC network to forward queries to. This should be formatted like `https://www.googleapis.com/compute/v1/projects/{project}/global/networks/{network}` }, }, "privateVisibilityConfig": { # For privately visible zones, the set of Virtual Private Cloud resources that the zone is visible from. @@ -528,7 +525,7 @@

Method Details

"networks": [ # The list of VPC networks that can see this zone. { "kind": "dns#managedZonePrivateVisibilityConfigNetwork", - "networkUrl": "A String", # The fully qualified URL of the VPC network to bind to. Format this URL like https://www.googleapis.com/compute/v1/projects/{project}/global/networks/{network} + "networkUrl": "A String", # The fully qualified URL of the VPC network to bind to. Format this URL like `https://www.googleapis.com/compute/v1/projects/{project}/global/networks/{network}` }, ], }, @@ -540,7 +537,7 @@

Method Details

"namespace": { # Contains information about the namespace associated with the zone. "deletionTime": "A String", # The time that the namespace backing this zone was deleted; an empty string if it still exists. This is in RFC3339 text format. Output only. "kind": "dns#managedZoneServiceDirectoryConfigNamespace", - "namespaceUrl": "A String", # The fully qualified URL of the namespace associated with the zone. Format must be https://servicedirectory.googleapis.com/v1/projects/{project}/locations/{location}/namespaces/{namespace} + "namespaceUrl": "A String", # The fully qualified URL of the namespace associated with the zone. Format must be `https://servicedirectory.googleapis.com/v1/projects/{project}/locations/{location}/namespaces/{namespace}` }, }, "visibility": "A String", # The zone's visibility: public zones are exposed to the Internet, while private zones are visible only to Virtual Private Cloud resources. diff --git a/docs/dyn/dns_v1.managedZones.html b/docs/dyn/dns_v1.managedZones.html index 63fcf48b561..6a055f34467 100644 --- a/docs/dyn/dns_v1.managedZones.html +++ b/docs/dyn/dns_v1.managedZones.html @@ -169,7 +169,7 @@

Method Details

"targetNetwork": { # The network with which to peer. "deactivateTime": "A String", # The time at which the zone was deactivated, in RFC 3339 date-time format. An empty string indicates that the peering connection is active. The producer network can deactivate a zone. The zone is automatically deactivated if the producer network that the zone targeted is deleted. Output only. "kind": "dns#managedZonePeeringConfigTargetNetwork", - "networkUrl": "A String", # The fully qualified URL of the VPC network to forward queries to. This should be formatted like https://www.googleapis.com/compute/v1/projects/{project}/global/networks/{network} + "networkUrl": "A String", # The fully qualified URL of the VPC network to forward queries to. This should be formatted like `https://www.googleapis.com/compute/v1/projects/{project}/global/networks/{network}` }, }, "privateVisibilityConfig": { # For privately visible zones, the set of Virtual Private Cloud resources that the zone is visible from. @@ -183,7 +183,7 @@

Method Details

"networks": [ # The list of VPC networks that can see this zone. { "kind": "dns#managedZonePrivateVisibilityConfigNetwork", - "networkUrl": "A String", # The fully qualified URL of the VPC network to bind to. Format this URL like https://www.googleapis.com/compute/v1/projects/{project}/global/networks/{network} + "networkUrl": "A String", # The fully qualified URL of the VPC network to bind to. Format this URL like `https://www.googleapis.com/compute/v1/projects/{project}/global/networks/{network}` }, ], }, @@ -195,7 +195,7 @@

Method Details

"namespace": { # Contains information about the namespace associated with the zone. "deletionTime": "A String", # The time that the namespace backing this zone was deleted; an empty string if it still exists. This is in RFC3339 text format. Output only. "kind": "dns#managedZoneServiceDirectoryConfigNamespace", - "namespaceUrl": "A String", # The fully qualified URL of the namespace associated with the zone. Format must be https://servicedirectory.googleapis.com/v1/projects/{project}/locations/{location}/namespaces/{namespace} + "namespaceUrl": "A String", # The fully qualified URL of the namespace associated with the zone. Format must be `https://servicedirectory.googleapis.com/v1/projects/{project}/locations/{location}/namespaces/{namespace}` }, }, "visibility": "A String", # The zone's visibility: public zones are exposed to the Internet, while private zones are visible only to Virtual Private Cloud resources. @@ -257,7 +257,7 @@

Method Details

"targetNetwork": { # The network with which to peer. "deactivateTime": "A String", # The time at which the zone was deactivated, in RFC 3339 date-time format. An empty string indicates that the peering connection is active. The producer network can deactivate a zone. The zone is automatically deactivated if the producer network that the zone targeted is deleted. Output only. "kind": "dns#managedZonePeeringConfigTargetNetwork", - "networkUrl": "A String", # The fully qualified URL of the VPC network to forward queries to. This should be formatted like https://www.googleapis.com/compute/v1/projects/{project}/global/networks/{network} + "networkUrl": "A String", # The fully qualified URL of the VPC network to forward queries to. This should be formatted like `https://www.googleapis.com/compute/v1/projects/{project}/global/networks/{network}` }, }, "privateVisibilityConfig": { # For privately visible zones, the set of Virtual Private Cloud resources that the zone is visible from. @@ -271,7 +271,7 @@

Method Details

"networks": [ # The list of VPC networks that can see this zone. { "kind": "dns#managedZonePrivateVisibilityConfigNetwork", - "networkUrl": "A String", # The fully qualified URL of the VPC network to bind to. Format this URL like https://www.googleapis.com/compute/v1/projects/{project}/global/networks/{network} + "networkUrl": "A String", # The fully qualified URL of the VPC network to bind to. Format this URL like `https://www.googleapis.com/compute/v1/projects/{project}/global/networks/{network}` }, ], }, @@ -283,7 +283,7 @@

Method Details

"namespace": { # Contains information about the namespace associated with the zone. "deletionTime": "A String", # The time that the namespace backing this zone was deleted; an empty string if it still exists. This is in RFC3339 text format. Output only. "kind": "dns#managedZoneServiceDirectoryConfigNamespace", - "namespaceUrl": "A String", # The fully qualified URL of the namespace associated with the zone. Format must be https://servicedirectory.googleapis.com/v1/projects/{project}/locations/{location}/namespaces/{namespace} + "namespaceUrl": "A String", # The fully qualified URL of the namespace associated with the zone. Format must be `https://servicedirectory.googleapis.com/v1/projects/{project}/locations/{location}/namespaces/{namespace}` }, }, "visibility": "A String", # The zone's visibility: public zones are exposed to the Internet, while private zones are visible only to Virtual Private Cloud resources. @@ -368,7 +368,7 @@

Method Details

"targetNetwork": { # The network with which to peer. "deactivateTime": "A String", # The time at which the zone was deactivated, in RFC 3339 date-time format. An empty string indicates that the peering connection is active. The producer network can deactivate a zone. The zone is automatically deactivated if the producer network that the zone targeted is deleted. Output only. "kind": "dns#managedZonePeeringConfigTargetNetwork", - "networkUrl": "A String", # The fully qualified URL of the VPC network to forward queries to. This should be formatted like https://www.googleapis.com/compute/v1/projects/{project}/global/networks/{network} + "networkUrl": "A String", # The fully qualified URL of the VPC network to forward queries to. This should be formatted like `https://www.googleapis.com/compute/v1/projects/{project}/global/networks/{network}` }, }, "privateVisibilityConfig": { # For privately visible zones, the set of Virtual Private Cloud resources that the zone is visible from. @@ -382,7 +382,7 @@

Method Details

"networks": [ # The list of VPC networks that can see this zone. { "kind": "dns#managedZonePrivateVisibilityConfigNetwork", - "networkUrl": "A String", # The fully qualified URL of the VPC network to bind to. Format this URL like https://www.googleapis.com/compute/v1/projects/{project}/global/networks/{network} + "networkUrl": "A String", # The fully qualified URL of the VPC network to bind to. Format this URL like `https://www.googleapis.com/compute/v1/projects/{project}/global/networks/{network}` }, ], }, @@ -394,7 +394,7 @@

Method Details

"namespace": { # Contains information about the namespace associated with the zone. "deletionTime": "A String", # The time that the namespace backing this zone was deleted; an empty string if it still exists. This is in RFC3339 text format. Output only. "kind": "dns#managedZoneServiceDirectoryConfigNamespace", - "namespaceUrl": "A String", # The fully qualified URL of the namespace associated with the zone. Format must be https://servicedirectory.googleapis.com/v1/projects/{project}/locations/{location}/namespaces/{namespace} + "namespaceUrl": "A String", # The fully qualified URL of the namespace associated with the zone. Format must be `https://servicedirectory.googleapis.com/v1/projects/{project}/locations/{location}/namespaces/{namespace}` }, }, "visibility": "A String", # The zone's visibility: public zones are exposed to the Internet, while private zones are visible only to Virtual Private Cloud resources. @@ -475,9 +475,6 @@

Method Details

An object of the form: { - "header": { # Elements common to every response. - "operationId": "A String", # For mutating operation requests that completed successfully. This is the client_operation_id if the client specified it, otherwise it is generated by the server (output only). - }, "kind": "dns#managedZonesListResponse", # Type of resource. "managedZones": [ # The managed zone resources. { # A zone is a subtree of the DNS namespace under one administrative responsibility. A ManagedZone is a resource that represents a DNS zone hosted by the Cloud DNS service. @@ -527,7 +524,7 @@

Method Details

"targetNetwork": { # The network with which to peer. "deactivateTime": "A String", # The time at which the zone was deactivated, in RFC 3339 date-time format. An empty string indicates that the peering connection is active. The producer network can deactivate a zone. The zone is automatically deactivated if the producer network that the zone targeted is deleted. Output only. "kind": "dns#managedZonePeeringConfigTargetNetwork", - "networkUrl": "A String", # The fully qualified URL of the VPC network to forward queries to. This should be formatted like https://www.googleapis.com/compute/v1/projects/{project}/global/networks/{network} + "networkUrl": "A String", # The fully qualified URL of the VPC network to forward queries to. This should be formatted like `https://www.googleapis.com/compute/v1/projects/{project}/global/networks/{network}` }, }, "privateVisibilityConfig": { # For privately visible zones, the set of Virtual Private Cloud resources that the zone is visible from. @@ -541,7 +538,7 @@

Method Details

"networks": [ # The list of VPC networks that can see this zone. { "kind": "dns#managedZonePrivateVisibilityConfigNetwork", - "networkUrl": "A String", # The fully qualified URL of the VPC network to bind to. Format this URL like https://www.googleapis.com/compute/v1/projects/{project}/global/networks/{network} + "networkUrl": "A String", # The fully qualified URL of the VPC network to bind to. Format this URL like `https://www.googleapis.com/compute/v1/projects/{project}/global/networks/{network}` }, ], }, @@ -553,13 +550,13 @@

Method Details

"namespace": { # Contains information about the namespace associated with the zone. "deletionTime": "A String", # The time that the namespace backing this zone was deleted; an empty string if it still exists. This is in RFC3339 text format. Output only. "kind": "dns#managedZoneServiceDirectoryConfigNamespace", - "namespaceUrl": "A String", # The fully qualified URL of the namespace associated with the zone. Format must be https://servicedirectory.googleapis.com/v1/projects/{project}/locations/{location}/namespaces/{namespace} + "namespaceUrl": "A String", # The fully qualified URL of the namespace associated with the zone. Format must be `https://servicedirectory.googleapis.com/v1/projects/{project}/locations/{location}/namespaces/{namespace}` }, }, "visibility": "A String", # The zone's visibility: public zones are exposed to the Internet, while private zones are visible only to Virtual Private Cloud resources. }, ], - "nextPageToken": "A String", # The presence of this field indicates that there exist more results following your last page of results in pagination order. To fetch them, make another list request using this value as your page token. This lets you the complete contents of even very large collections one page at a time. However, if the contents of the collection change between the first and last paginated list request, the set of all elements returned are an inconsistent view of the collection. You cannot retrieve a consistent snapshot of a collection larger than the maximum page size. + "nextPageToken": "A String", # This field indicates that more results are available beyond the last page displayed. To fetch the results, make another list request and use this value as your page token. This lets you retrieve the complete contents of a very large collection one page at a time. However, if the contents of the collection change between the first and last paginated list request, the set of all elements returned are an inconsistent view of the collection. You can't retrieve a consistent snapshot of a collection larger than the maximum page size. }
@@ -634,7 +631,7 @@

Method Details

"targetNetwork": { # The network with which to peer. "deactivateTime": "A String", # The time at which the zone was deactivated, in RFC 3339 date-time format. An empty string indicates that the peering connection is active. The producer network can deactivate a zone. The zone is automatically deactivated if the producer network that the zone targeted is deleted. Output only. "kind": "dns#managedZonePeeringConfigTargetNetwork", - "networkUrl": "A String", # The fully qualified URL of the VPC network to forward queries to. This should be formatted like https://www.googleapis.com/compute/v1/projects/{project}/global/networks/{network} + "networkUrl": "A String", # The fully qualified URL of the VPC network to forward queries to. This should be formatted like `https://www.googleapis.com/compute/v1/projects/{project}/global/networks/{network}` }, }, "privateVisibilityConfig": { # For privately visible zones, the set of Virtual Private Cloud resources that the zone is visible from. @@ -648,7 +645,7 @@

Method Details

"networks": [ # The list of VPC networks that can see this zone. { "kind": "dns#managedZonePrivateVisibilityConfigNetwork", - "networkUrl": "A String", # The fully qualified URL of the VPC network to bind to. Format this URL like https://www.googleapis.com/compute/v1/projects/{project}/global/networks/{network} + "networkUrl": "A String", # The fully qualified URL of the VPC network to bind to. Format this URL like `https://www.googleapis.com/compute/v1/projects/{project}/global/networks/{network}` }, ], }, @@ -660,7 +657,7 @@

Method Details

"namespace": { # Contains information about the namespace associated with the zone. "deletionTime": "A String", # The time that the namespace backing this zone was deleted; an empty string if it still exists. This is in RFC3339 text format. Output only. "kind": "dns#managedZoneServiceDirectoryConfigNamespace", - "namespaceUrl": "A String", # The fully qualified URL of the namespace associated with the zone. Format must be https://servicedirectory.googleapis.com/v1/projects/{project}/locations/{location}/namespaces/{namespace} + "namespaceUrl": "A String", # The fully qualified URL of the namespace associated with the zone. Format must be `https://servicedirectory.googleapis.com/v1/projects/{project}/locations/{location}/namespaces/{namespace}` }, }, "visibility": "A String", # The zone's visibility: public zones are exposed to the Internet, while private zones are visible only to Virtual Private Cloud resources. @@ -768,7 +765,7 @@

Method Details

"targetNetwork": { # The network with which to peer. "deactivateTime": "A String", # The time at which the zone was deactivated, in RFC 3339 date-time format. An empty string indicates that the peering connection is active. The producer network can deactivate a zone. The zone is automatically deactivated if the producer network that the zone targeted is deleted. Output only. "kind": "dns#managedZonePeeringConfigTargetNetwork", - "networkUrl": "A String", # The fully qualified URL of the VPC network to forward queries to. This should be formatted like https://www.googleapis.com/compute/v1/projects/{project}/global/networks/{network} + "networkUrl": "A String", # The fully qualified URL of the VPC network to forward queries to. This should be formatted like `https://www.googleapis.com/compute/v1/projects/{project}/global/networks/{network}` }, }, "privateVisibilityConfig": { # For privately visible zones, the set of Virtual Private Cloud resources that the zone is visible from. @@ -782,7 +779,7 @@

Method Details

"networks": [ # The list of VPC networks that can see this zone. { "kind": "dns#managedZonePrivateVisibilityConfigNetwork", - "networkUrl": "A String", # The fully qualified URL of the VPC network to bind to. Format this URL like https://www.googleapis.com/compute/v1/projects/{project}/global/networks/{network} + "networkUrl": "A String", # The fully qualified URL of the VPC network to bind to. Format this URL like `https://www.googleapis.com/compute/v1/projects/{project}/global/networks/{network}` }, ], }, @@ -794,7 +791,7 @@

Method Details

"namespace": { # Contains information about the namespace associated with the zone. "deletionTime": "A String", # The time that the namespace backing this zone was deleted; an empty string if it still exists. This is in RFC3339 text format. Output only. "kind": "dns#managedZoneServiceDirectoryConfigNamespace", - "namespaceUrl": "A String", # The fully qualified URL of the namespace associated with the zone. Format must be https://servicedirectory.googleapis.com/v1/projects/{project}/locations/{location}/namespaces/{namespace} + "namespaceUrl": "A String", # The fully qualified URL of the namespace associated with the zone. Format must be `https://servicedirectory.googleapis.com/v1/projects/{project}/locations/{location}/namespaces/{namespace}` }, }, "visibility": "A String", # The zone's visibility: public zones are exposed to the Internet, while private zones are visible only to Virtual Private Cloud resources. @@ -846,7 +843,7 @@

Method Details

"targetNetwork": { # The network with which to peer. "deactivateTime": "A String", # The time at which the zone was deactivated, in RFC 3339 date-time format. An empty string indicates that the peering connection is active. The producer network can deactivate a zone. The zone is automatically deactivated if the producer network that the zone targeted is deleted. Output only. "kind": "dns#managedZonePeeringConfigTargetNetwork", - "networkUrl": "A String", # The fully qualified URL of the VPC network to forward queries to. This should be formatted like https://www.googleapis.com/compute/v1/projects/{project}/global/networks/{network} + "networkUrl": "A String", # The fully qualified URL of the VPC network to forward queries to. This should be formatted like `https://www.googleapis.com/compute/v1/projects/{project}/global/networks/{network}` }, }, "privateVisibilityConfig": { # For privately visible zones, the set of Virtual Private Cloud resources that the zone is visible from. @@ -860,7 +857,7 @@

Method Details

"networks": [ # The list of VPC networks that can see this zone. { "kind": "dns#managedZonePrivateVisibilityConfigNetwork", - "networkUrl": "A String", # The fully qualified URL of the VPC network to bind to. Format this URL like https://www.googleapis.com/compute/v1/projects/{project}/global/networks/{network} + "networkUrl": "A String", # The fully qualified URL of the VPC network to bind to. Format this URL like `https://www.googleapis.com/compute/v1/projects/{project}/global/networks/{network}` }, ], }, @@ -872,7 +869,7 @@

Method Details

"namespace": { # Contains information about the namespace associated with the zone. "deletionTime": "A String", # The time that the namespace backing this zone was deleted; an empty string if it still exists. This is in RFC3339 text format. Output only. "kind": "dns#managedZoneServiceDirectoryConfigNamespace", - "namespaceUrl": "A String", # The fully qualified URL of the namespace associated with the zone. Format must be https://servicedirectory.googleapis.com/v1/projects/{project}/locations/{location}/namespaces/{namespace} + "namespaceUrl": "A String", # The fully qualified URL of the namespace associated with the zone. Format must be `https://servicedirectory.googleapis.com/v1/projects/{project}/locations/{location}/namespaces/{namespace}` }, }, "visibility": "A String", # The zone's visibility: public zones are exposed to the Internet, while private zones are visible only to Virtual Private Cloud resources. @@ -1053,7 +1050,7 @@

Method Details

"targetNetwork": { # The network with which to peer. "deactivateTime": "A String", # The time at which the zone was deactivated, in RFC 3339 date-time format. An empty string indicates that the peering connection is active. The producer network can deactivate a zone. The zone is automatically deactivated if the producer network that the zone targeted is deleted. Output only. "kind": "dns#managedZonePeeringConfigTargetNetwork", - "networkUrl": "A String", # The fully qualified URL of the VPC network to forward queries to. This should be formatted like https://www.googleapis.com/compute/v1/projects/{project}/global/networks/{network} + "networkUrl": "A String", # The fully qualified URL of the VPC network to forward queries to. This should be formatted like `https://www.googleapis.com/compute/v1/projects/{project}/global/networks/{network}` }, }, "privateVisibilityConfig": { # For privately visible zones, the set of Virtual Private Cloud resources that the zone is visible from. @@ -1067,7 +1064,7 @@

Method Details

"networks": [ # The list of VPC networks that can see this zone. { "kind": "dns#managedZonePrivateVisibilityConfigNetwork", - "networkUrl": "A String", # The fully qualified URL of the VPC network to bind to. Format this URL like https://www.googleapis.com/compute/v1/projects/{project}/global/networks/{network} + "networkUrl": "A String", # The fully qualified URL of the VPC network to bind to. Format this URL like `https://www.googleapis.com/compute/v1/projects/{project}/global/networks/{network}` }, ], }, @@ -1079,7 +1076,7 @@

Method Details

"namespace": { # Contains information about the namespace associated with the zone. "deletionTime": "A String", # The time that the namespace backing this zone was deleted; an empty string if it still exists. This is in RFC3339 text format. Output only. "kind": "dns#managedZoneServiceDirectoryConfigNamespace", - "namespaceUrl": "A String", # The fully qualified URL of the namespace associated with the zone. Format must be https://servicedirectory.googleapis.com/v1/projects/{project}/locations/{location}/namespaces/{namespace} + "namespaceUrl": "A String", # The fully qualified URL of the namespace associated with the zone. Format must be `https://servicedirectory.googleapis.com/v1/projects/{project}/locations/{location}/namespaces/{namespace}` }, }, "visibility": "A String", # The zone's visibility: public zones are exposed to the Internet, while private zones are visible only to Virtual Private Cloud resources. @@ -1187,7 +1184,7 @@

Method Details

"targetNetwork": { # The network with which to peer. "deactivateTime": "A String", # The time at which the zone was deactivated, in RFC 3339 date-time format. An empty string indicates that the peering connection is active. The producer network can deactivate a zone. The zone is automatically deactivated if the producer network that the zone targeted is deleted. Output only. "kind": "dns#managedZonePeeringConfigTargetNetwork", - "networkUrl": "A String", # The fully qualified URL of the VPC network to forward queries to. This should be formatted like https://www.googleapis.com/compute/v1/projects/{project}/global/networks/{network} + "networkUrl": "A String", # The fully qualified URL of the VPC network to forward queries to. This should be formatted like `https://www.googleapis.com/compute/v1/projects/{project}/global/networks/{network}` }, }, "privateVisibilityConfig": { # For privately visible zones, the set of Virtual Private Cloud resources that the zone is visible from. @@ -1201,7 +1198,7 @@

Method Details

"networks": [ # The list of VPC networks that can see this zone. { "kind": "dns#managedZonePrivateVisibilityConfigNetwork", - "networkUrl": "A String", # The fully qualified URL of the VPC network to bind to. Format this URL like https://www.googleapis.com/compute/v1/projects/{project}/global/networks/{network} + "networkUrl": "A String", # The fully qualified URL of the VPC network to bind to. Format this URL like `https://www.googleapis.com/compute/v1/projects/{project}/global/networks/{network}` }, ], }, @@ -1213,7 +1210,7 @@

Method Details

"namespace": { # Contains information about the namespace associated with the zone. "deletionTime": "A String", # The time that the namespace backing this zone was deleted; an empty string if it still exists. This is in RFC3339 text format. Output only. "kind": "dns#managedZoneServiceDirectoryConfigNamespace", - "namespaceUrl": "A String", # The fully qualified URL of the namespace associated with the zone. Format must be https://servicedirectory.googleapis.com/v1/projects/{project}/locations/{location}/namespaces/{namespace} + "namespaceUrl": "A String", # The fully qualified URL of the namespace associated with the zone. Format must be `https://servicedirectory.googleapis.com/v1/projects/{project}/locations/{location}/namespaces/{namespace}` }, }, "visibility": "A String", # The zone's visibility: public zones are exposed to the Internet, while private zones are visible only to Virtual Private Cloud resources. @@ -1265,7 +1262,7 @@

Method Details

"targetNetwork": { # The network with which to peer. "deactivateTime": "A String", # The time at which the zone was deactivated, in RFC 3339 date-time format. An empty string indicates that the peering connection is active. The producer network can deactivate a zone. The zone is automatically deactivated if the producer network that the zone targeted is deleted. Output only. "kind": "dns#managedZonePeeringConfigTargetNetwork", - "networkUrl": "A String", # The fully qualified URL of the VPC network to forward queries to. This should be formatted like https://www.googleapis.com/compute/v1/projects/{project}/global/networks/{network} + "networkUrl": "A String", # The fully qualified URL of the VPC network to forward queries to. This should be formatted like `https://www.googleapis.com/compute/v1/projects/{project}/global/networks/{network}` }, }, "privateVisibilityConfig": { # For privately visible zones, the set of Virtual Private Cloud resources that the zone is visible from. @@ -1279,7 +1276,7 @@

Method Details

"networks": [ # The list of VPC networks that can see this zone. { "kind": "dns#managedZonePrivateVisibilityConfigNetwork", - "networkUrl": "A String", # The fully qualified URL of the VPC network to bind to. Format this URL like https://www.googleapis.com/compute/v1/projects/{project}/global/networks/{network} + "networkUrl": "A String", # The fully qualified URL of the VPC network to bind to. Format this URL like `https://www.googleapis.com/compute/v1/projects/{project}/global/networks/{network}` }, ], }, @@ -1291,7 +1288,7 @@

Method Details

"namespace": { # Contains information about the namespace associated with the zone. "deletionTime": "A String", # The time that the namespace backing this zone was deleted; an empty string if it still exists. This is in RFC3339 text format. Output only. "kind": "dns#managedZoneServiceDirectoryConfigNamespace", - "namespaceUrl": "A String", # The fully qualified URL of the namespace associated with the zone. Format must be https://servicedirectory.googleapis.com/v1/projects/{project}/locations/{location}/namespaces/{namespace} + "namespaceUrl": "A String", # The fully qualified URL of the namespace associated with the zone. Format must be `https://servicedirectory.googleapis.com/v1/projects/{project}/locations/{location}/namespaces/{namespace}` }, }, "visibility": "A String", # The zone's visibility: public zones are exposed to the Internet, while private zones are visible only to Virtual Private Cloud resources. diff --git a/docs/dyn/dns_v1.policies.html b/docs/dyn/dns_v1.policies.html index 8ecdeb25474..8699eff0e3f 100644 --- a/docs/dyn/dns_v1.policies.html +++ b/docs/dyn/dns_v1.policies.html @@ -250,11 +250,8 @@

Method Details

An object of the form: { - "header": { # Elements common to every response. - "operationId": "A String", # For mutating operation requests that completed successfully. This is the client_operation_id if the client specified it, otherwise it is generated by the server (output only). - }, "kind": "dns#policiesListResponse", # Type of resource. - "nextPageToken": "A String", # The presence of this field indicates that there exist more results following your last page of results in pagination order. To fetch them, make another list request using this value as your page token. This lets you the complete contents of even very large collections one page at a time. However, if the contents of the collection change between the first and last paginated list request, the set of all elements returned are an inconsistent view of the collection. You cannot retrieve a consistent snapshot of a collection larger than the maximum page size. + "nextPageToken": "A String", # This field indicates that more results are available beyond the last page displayed. To fetch the results, make another list request and use this value as your page token. This lets you retrieve the complete contents of a very large collection one page at a time. However, if the contents of the collection change between the first and last paginated list request, the set of all elements returned are an inconsistent view of the collection. You can't retrieve a consistent snapshot of a collection larger than the maximum page size. "policies": [ # The policy resources. { # A policy is a collection of DNS rules applied to one or more Virtual Private Cloud resources. "alternativeNameServerConfig": { # Sets an alternative name server for the associated networks. When specified, all DNS queries are forwarded to a name server that you choose. Names such as .internal are not available when an alternative name server is specified. @@ -345,9 +342,6 @@

Method Details

An object of the form: { - "header": { # Elements common to every response. - "operationId": "A String", # For mutating operation requests that completed successfully. This is the client_operation_id if the client specified it, otherwise it is generated by the server (output only). - }, "policy": { # A policy is a collection of DNS rules applied to one or more Virtual Private Cloud resources. "alternativeNameServerConfig": { # Sets an alternative name server for the associated networks. When specified, all DNS queries are forwarded to a name server that you choose. Names such as .internal are not available when an alternative name server is specified. "kind": "dns#policyAlternativeNameServerConfig", @@ -422,9 +416,6 @@

Method Details

An object of the form: { - "header": { # Elements common to every response. - "operationId": "A String", # For mutating operation requests that completed successfully. This is the client_operation_id if the client specified it, otherwise it is generated by the server (output only). - }, "policy": { # A policy is a collection of DNS rules applied to one or more Virtual Private Cloud resources. "alternativeNameServerConfig": { # Sets an alternative name server for the associated networks. When specified, all DNS queries are forwarded to a name server that you choose. Names such as .internal are not available when an alternative name server is specified. "kind": "dns#policyAlternativeNameServerConfig", diff --git a/docs/dyn/dns_v1.projects.html b/docs/dyn/dns_v1.projects.html index 311ce39939f..dd07c28002b 100644 --- a/docs/dyn/dns_v1.projects.html +++ b/docs/dyn/dns_v1.projects.html @@ -101,7 +101,7 @@

Method Details

Returns: An object of the form: - { # A project resource. The project is a top level container for resources including Cloud DNS ManagedZones. Projects can be created only in the APIs console. Next tag: 7. + { # A project resource. The project is a top level container for resources including Cloud DNS ManagedZones. Projects can be created only in the APIs console. "id": "A String", # User assigned unique identifier for the resource (output only). "kind": "dns#project", "number": "A String", # Unique numeric identifier for the resource; defined by the server (output only). diff --git a/docs/dyn/dns_v1.resourceRecordSets.html b/docs/dyn/dns_v1.resourceRecordSets.html index b894d4f703d..8aa0d870550 100644 --- a/docs/dyn/dns_v1.resourceRecordSets.html +++ b/docs/dyn/dns_v1.resourceRecordSets.html @@ -114,19 +114,19 @@

Method Details

{ # A unit of data that is returned by the DNS servers. "kind": "dns#resourceRecordSet", "name": "A String", # For example, www.example.com. - "routingPolicy": { # A RRSetRoutingPolicy represents ResourceRecordSet data that is returned dynamically with the response varying based on configured properties such as geolocation or by weighted random selection. # Configures dynamic query responses based on either the geo location of the querying user or a weighted round robin based routing policy. A valid ResourceRecordSet contains only rrdata (for static resolution) or a routing_policy (for dynamic resolution). - "geo": { # Configures a RRSetRoutingPolicy that routes based on the geo location of the querying user. + "routingPolicy": { # A RRSetRoutingPolicy represents ResourceRecordSet data that is returned dynamically with the response varying based on configured properties such as geolocation or by weighted random selection. # Configures dynamic query responses based on either the geo location of the querying user or a weighted round robin based routing policy. A valid `ResourceRecordSet` contains only `rrdata` (for static resolution) or a `routing_policy` (for dynamic resolution). + "geo": { # Configures a `RRSetRoutingPolicy` that routes based on the geo location of the querying user. "enableFencing": True or False, # Without fencing, if health check fails for all configured items in the current geo bucket, we failover to the next nearest geo bucket. With fencing, if health checking is enabled, as long as some targets in the current geo bucket are healthy, we return only the healthy targets. However, if all targets are unhealthy, we don't failover to the next nearest bucket; instead, we return all the items in the current bucket even when all targets are unhealthy. "items": [ # The primary geo routing configuration. If there are multiple items with the same location, an error is returned instead. { # ResourceRecordSet data for one geo location. - "healthCheckedTargets": { # HealthCheckTargets describes endpoints to health-check when responding to Routing Policy queries. Only the healthy endpoints will be included in the response. Only one of internal_load_balancer and external_endpoints should be set. # For A and AAAA types only. Endpoints to return in the query result only if they are healthy. These can be specified along with rrdata within this item. + "healthCheckedTargets": { # HealthCheckTargets describes endpoints to health-check when responding to Routing Policy queries. Only the healthy endpoints will be included in the response. # For A and AAAA types only. Endpoints to return in the query result only if they are healthy. These can be specified along with `rrdata` within this item. "internalLoadBalancers": [ # Configuration for internal load balancers to be health checked. { # The configuration for an individual load balancer to health check. "ipAddress": "A String", # The frontend IP address of the load balancer to health check. "ipProtocol": "A String", # The protocol of the load balancer to health check. "kind": "dns#rRSetRoutingPolicyLoadBalancerTarget", "loadBalancerType": "A String", # The type of load balancer specified by this target. This value must match the configuration of the load balancer located at the LoadBalancerTarget's IP address, port, and region. Use the following: - *regionalL4ilb*: for a regional internal passthrough Network Load Balancer. - *regionalL7ilb*: for a regional internal Application Load Balancer. - *globalL7ilb*: for a global internal Application Load Balancer. - "networkUrl": "A String", # The fully qualified URL of the network that the load balancer is attached to. This should be formatted like https://www.googleapis.com/compute/v1/projects/{project}/global/networks/{network} . + "networkUrl": "A String", # The fully qualified URL of the network that the load balancer is attached to. This should be formatted like `https://www.googleapis.com/compute/v1/projects/{project}/global/networks/{network}`. "port": "A String", # The configured port of the load balancer. "project": "A String", # The project ID in which the load balancer is located. "region": "A String", # The region in which the load balancer is located. @@ -138,7 +138,7 @@

Method Details

"rrdatas": [ "A String", ], - "signatureRrdatas": [ # DNSSEC generated signatures for all the rrdata within this item. If health checked targets are provided for DNSSEC enabled zones, there's a restriction of 1 IP address per item. + "signatureRrdatas": [ # DNSSEC generated signatures for all the `rrdata` within this item. If health checked targets are provided for DNSSEC enabled zones, there's a restriction of 1 IP address per item. "A String", ], }, @@ -147,18 +147,18 @@

Method Details

}, "kind": "dns#rRSetRoutingPolicy", "primaryBackup": { # Configures a RRSetRoutingPolicy such that all queries are responded with the primary_targets if they are healthy. And if all of them are unhealthy, then we fallback to a geo localized policy. - "backupGeoTargets": { # Configures a RRSetRoutingPolicy that routes based on the geo location of the querying user. # Backup targets provide a regional failover policy for the otherwise global primary targets. If serving state is set to BACKUP, this policy essentially becomes a geo routing policy. + "backupGeoTargets": { # Configures a `RRSetRoutingPolicy` that routes based on the geo location of the querying user. # Backup targets provide a regional failover policy for the otherwise global primary targets. If serving state is set to `BACKUP`, this policy essentially becomes a geo routing policy. "enableFencing": True or False, # Without fencing, if health check fails for all configured items in the current geo bucket, we failover to the next nearest geo bucket. With fencing, if health checking is enabled, as long as some targets in the current geo bucket are healthy, we return only the healthy targets. However, if all targets are unhealthy, we don't failover to the next nearest bucket; instead, we return all the items in the current bucket even when all targets are unhealthy. "items": [ # The primary geo routing configuration. If there are multiple items with the same location, an error is returned instead. { # ResourceRecordSet data for one geo location. - "healthCheckedTargets": { # HealthCheckTargets describes endpoints to health-check when responding to Routing Policy queries. Only the healthy endpoints will be included in the response. Only one of internal_load_balancer and external_endpoints should be set. # For A and AAAA types only. Endpoints to return in the query result only if they are healthy. These can be specified along with rrdata within this item. + "healthCheckedTargets": { # HealthCheckTargets describes endpoints to health-check when responding to Routing Policy queries. Only the healthy endpoints will be included in the response. # For A and AAAA types only. Endpoints to return in the query result only if they are healthy. These can be specified along with `rrdata` within this item. "internalLoadBalancers": [ # Configuration for internal load balancers to be health checked. { # The configuration for an individual load balancer to health check. "ipAddress": "A String", # The frontend IP address of the load balancer to health check. "ipProtocol": "A String", # The protocol of the load balancer to health check. "kind": "dns#rRSetRoutingPolicyLoadBalancerTarget", "loadBalancerType": "A String", # The type of load balancer specified by this target. This value must match the configuration of the load balancer located at the LoadBalancerTarget's IP address, port, and region. Use the following: - *regionalL4ilb*: for a regional internal passthrough Network Load Balancer. - *regionalL7ilb*: for a regional internal Application Load Balancer. - *globalL7ilb*: for a global internal Application Load Balancer. - "networkUrl": "A String", # The fully qualified URL of the network that the load balancer is attached to. This should be formatted like https://www.googleapis.com/compute/v1/projects/{project}/global/networks/{network} . + "networkUrl": "A String", # The fully qualified URL of the network that the load balancer is attached to. This should be formatted like `https://www.googleapis.com/compute/v1/projects/{project}/global/networks/{network}`. "port": "A String", # The configured port of the load balancer. "project": "A String", # The project ID in which the load balancer is located. "region": "A String", # The region in which the load balancer is located. @@ -170,7 +170,7 @@

Method Details

"rrdatas": [ "A String", ], - "signatureRrdatas": [ # DNSSEC generated signatures for all the rrdata within this item. If health checked targets are provided for DNSSEC enabled zones, there's a restriction of 1 IP address per item. + "signatureRrdatas": [ # DNSSEC generated signatures for all the `rrdata` within this item. If health checked targets are provided for DNSSEC enabled zones, there's a restriction of 1 IP address per item. "A String", ], }, @@ -178,33 +178,33 @@

Method Details

"kind": "dns#rRSetRoutingPolicyGeoPolicy", }, "kind": "dns#rRSetRoutingPolicyPrimaryBackupPolicy", - "primaryTargets": { # HealthCheckTargets describes endpoints to health-check when responding to Routing Policy queries. Only the healthy endpoints will be included in the response. Only one of internal_load_balancer and external_endpoints should be set. # Endpoints that are health checked before making the routing decision. Unhealthy endpoints are omitted from the results. If all endpoints are unhealthy, we serve a response based on the backup_geo_targets. + "primaryTargets": { # HealthCheckTargets describes endpoints to health-check when responding to Routing Policy queries. Only the healthy endpoints will be included in the response. # Endpoints that are health checked before making the routing decision. Unhealthy endpoints are omitted from the results. If all endpoints are unhealthy, we serve a response based on the `backup_geo_targets`. "internalLoadBalancers": [ # Configuration for internal load balancers to be health checked. { # The configuration for an individual load balancer to health check. "ipAddress": "A String", # The frontend IP address of the load balancer to health check. "ipProtocol": "A String", # The protocol of the load balancer to health check. "kind": "dns#rRSetRoutingPolicyLoadBalancerTarget", "loadBalancerType": "A String", # The type of load balancer specified by this target. This value must match the configuration of the load balancer located at the LoadBalancerTarget's IP address, port, and region. Use the following: - *regionalL4ilb*: for a regional internal passthrough Network Load Balancer. - *regionalL7ilb*: for a regional internal Application Load Balancer. - *globalL7ilb*: for a global internal Application Load Balancer. - "networkUrl": "A String", # The fully qualified URL of the network that the load balancer is attached to. This should be formatted like https://www.googleapis.com/compute/v1/projects/{project}/global/networks/{network} . + "networkUrl": "A String", # The fully qualified URL of the network that the load balancer is attached to. This should be formatted like `https://www.googleapis.com/compute/v1/projects/{project}/global/networks/{network}`. "port": "A String", # The configured port of the load balancer. "project": "A String", # The project ID in which the load balancer is located. "region": "A String", # The region in which the load balancer is located. }, ], }, - "trickleTraffic": 3.14, # When serving state is PRIMARY, this field provides the option of sending a small percentage of the traffic to the backup targets. + "trickleTraffic": 3.14, # When serving state is `PRIMARY`, this field provides the option of sending a small percentage of the traffic to the backup targets. }, "wrr": { # Configures a RRSetRoutingPolicy that routes in a weighted round robin fashion. "items": [ { # A routing block which contains the routing information for one WRR item. - "healthCheckedTargets": { # HealthCheckTargets describes endpoints to health-check when responding to Routing Policy queries. Only the healthy endpoints will be included in the response. Only one of internal_load_balancer and external_endpoints should be set. # Endpoints that are health checked before making the routing decision. The unhealthy endpoints are omitted from the result. If all endpoints within a bucket are unhealthy, we choose a different bucket (sampled with respect to its weight) for responding. If DNSSEC is enabled for this zone, only one of rrdata or health_checked_targets can be set. + "healthCheckedTargets": { # HealthCheckTargets describes endpoints to health-check when responding to Routing Policy queries. Only the healthy endpoints will be included in the response. # Endpoints that are health checked before making the routing decision. The unhealthy endpoints are omitted from the result. If all endpoints within a bucket are unhealthy, we choose a different bucket (sampled with respect to its weight) for responding. If DNSSEC is enabled for this zone, only one of `rrdata` or `health_checked_targets` can be set. "internalLoadBalancers": [ # Configuration for internal load balancers to be health checked. { # The configuration for an individual load balancer to health check. "ipAddress": "A String", # The frontend IP address of the load balancer to health check. "ipProtocol": "A String", # The protocol of the load balancer to health check. "kind": "dns#rRSetRoutingPolicyLoadBalancerTarget", "loadBalancerType": "A String", # The type of load balancer specified by this target. This value must match the configuration of the load balancer located at the LoadBalancerTarget's IP address, port, and region. Use the following: - *regionalL4ilb*: for a regional internal passthrough Network Load Balancer. - *regionalL7ilb*: for a regional internal Application Load Balancer. - *globalL7ilb*: for a global internal Application Load Balancer. - "networkUrl": "A String", # The fully qualified URL of the network that the load balancer is attached to. This should be formatted like https://www.googleapis.com/compute/v1/projects/{project}/global/networks/{network} . + "networkUrl": "A String", # The fully qualified URL of the network that the load balancer is attached to. This should be formatted like `https://www.googleapis.com/compute/v1/projects/{project}/global/networks/{network}`. "port": "A String", # The configured port of the load balancer. "project": "A String", # The project ID in which the load balancer is located. "region": "A String", # The region in which the load balancer is located. @@ -215,10 +215,10 @@

Method Details

"rrdatas": [ "A String", ], - "signatureRrdatas": [ # DNSSEC generated signatures for all the rrdata within this item. Note that if health checked targets are provided for DNSSEC enabled zones, there's a restriction of 1 IP address per item. + "signatureRrdatas": [ # DNSSEC generated signatures for all the `rrdata` within this item. Note that if health checked targets are provided for DNSSEC enabled zones, there's a restriction of 1 IP address per item. "A String", ], - "weight": 3.14, # The weight corresponding to this WrrPolicyItem object. When multiple WrrPolicyItem objects are configured, the probability of returning an WrrPolicyItem object's data is proportional to its weight relative to the sum of weights configured for all items. This weight must be non-negative. + "weight": 3.14, # The weight corresponding to this `WrrPolicyItem` object. When multiple `WrrPolicyItem` objects are configured, the probability of returning an `WrrPolicyItem` object's data is proportional to its weight relative to the sum of weights configured for all items. This weight must be non-negative. }, ], "kind": "dns#rRSetRoutingPolicyWrrPolicy", @@ -230,7 +230,7 @@

Method Details

"signatureRrdatas": [ # As defined in RFC 4034 (section 3.2). "A String", ], - "ttl": 42, # Number of seconds that this ResourceRecordSet can be cached by resolvers. + "ttl": 42, # Number of seconds that this `ResourceRecordSet` can be cached by resolvers. "type": "A String", # The identifier of a supported record type. See the list of Supported DNS record types. } @@ -246,19 +246,19 @@

Method Details

{ # A unit of data that is returned by the DNS servers. "kind": "dns#resourceRecordSet", "name": "A String", # For example, www.example.com. - "routingPolicy": { # A RRSetRoutingPolicy represents ResourceRecordSet data that is returned dynamically with the response varying based on configured properties such as geolocation or by weighted random selection. # Configures dynamic query responses based on either the geo location of the querying user or a weighted round robin based routing policy. A valid ResourceRecordSet contains only rrdata (for static resolution) or a routing_policy (for dynamic resolution). - "geo": { # Configures a RRSetRoutingPolicy that routes based on the geo location of the querying user. + "routingPolicy": { # A RRSetRoutingPolicy represents ResourceRecordSet data that is returned dynamically with the response varying based on configured properties such as geolocation or by weighted random selection. # Configures dynamic query responses based on either the geo location of the querying user or a weighted round robin based routing policy. A valid `ResourceRecordSet` contains only `rrdata` (for static resolution) or a `routing_policy` (for dynamic resolution). + "geo": { # Configures a `RRSetRoutingPolicy` that routes based on the geo location of the querying user. "enableFencing": True or False, # Without fencing, if health check fails for all configured items in the current geo bucket, we failover to the next nearest geo bucket. With fencing, if health checking is enabled, as long as some targets in the current geo bucket are healthy, we return only the healthy targets. However, if all targets are unhealthy, we don't failover to the next nearest bucket; instead, we return all the items in the current bucket even when all targets are unhealthy. "items": [ # The primary geo routing configuration. If there are multiple items with the same location, an error is returned instead. { # ResourceRecordSet data for one geo location. - "healthCheckedTargets": { # HealthCheckTargets describes endpoints to health-check when responding to Routing Policy queries. Only the healthy endpoints will be included in the response. Only one of internal_load_balancer and external_endpoints should be set. # For A and AAAA types only. Endpoints to return in the query result only if they are healthy. These can be specified along with rrdata within this item. + "healthCheckedTargets": { # HealthCheckTargets describes endpoints to health-check when responding to Routing Policy queries. Only the healthy endpoints will be included in the response. # For A and AAAA types only. Endpoints to return in the query result only if they are healthy. These can be specified along with `rrdata` within this item. "internalLoadBalancers": [ # Configuration for internal load balancers to be health checked. { # The configuration for an individual load balancer to health check. "ipAddress": "A String", # The frontend IP address of the load balancer to health check. "ipProtocol": "A String", # The protocol of the load balancer to health check. "kind": "dns#rRSetRoutingPolicyLoadBalancerTarget", "loadBalancerType": "A String", # The type of load balancer specified by this target. This value must match the configuration of the load balancer located at the LoadBalancerTarget's IP address, port, and region. Use the following: - *regionalL4ilb*: for a regional internal passthrough Network Load Balancer. - *regionalL7ilb*: for a regional internal Application Load Balancer. - *globalL7ilb*: for a global internal Application Load Balancer. - "networkUrl": "A String", # The fully qualified URL of the network that the load balancer is attached to. This should be formatted like https://www.googleapis.com/compute/v1/projects/{project}/global/networks/{network} . + "networkUrl": "A String", # The fully qualified URL of the network that the load balancer is attached to. This should be formatted like `https://www.googleapis.com/compute/v1/projects/{project}/global/networks/{network}`. "port": "A String", # The configured port of the load balancer. "project": "A String", # The project ID in which the load balancer is located. "region": "A String", # The region in which the load balancer is located. @@ -270,7 +270,7 @@

Method Details

"rrdatas": [ "A String", ], - "signatureRrdatas": [ # DNSSEC generated signatures for all the rrdata within this item. If health checked targets are provided for DNSSEC enabled zones, there's a restriction of 1 IP address per item. + "signatureRrdatas": [ # DNSSEC generated signatures for all the `rrdata` within this item. If health checked targets are provided for DNSSEC enabled zones, there's a restriction of 1 IP address per item. "A String", ], }, @@ -279,18 +279,18 @@

Method Details

}, "kind": "dns#rRSetRoutingPolicy", "primaryBackup": { # Configures a RRSetRoutingPolicy such that all queries are responded with the primary_targets if they are healthy. And if all of them are unhealthy, then we fallback to a geo localized policy. - "backupGeoTargets": { # Configures a RRSetRoutingPolicy that routes based on the geo location of the querying user. # Backup targets provide a regional failover policy for the otherwise global primary targets. If serving state is set to BACKUP, this policy essentially becomes a geo routing policy. + "backupGeoTargets": { # Configures a `RRSetRoutingPolicy` that routes based on the geo location of the querying user. # Backup targets provide a regional failover policy for the otherwise global primary targets. If serving state is set to `BACKUP`, this policy essentially becomes a geo routing policy. "enableFencing": True or False, # Without fencing, if health check fails for all configured items in the current geo bucket, we failover to the next nearest geo bucket. With fencing, if health checking is enabled, as long as some targets in the current geo bucket are healthy, we return only the healthy targets. However, if all targets are unhealthy, we don't failover to the next nearest bucket; instead, we return all the items in the current bucket even when all targets are unhealthy. "items": [ # The primary geo routing configuration. If there are multiple items with the same location, an error is returned instead. { # ResourceRecordSet data for one geo location. - "healthCheckedTargets": { # HealthCheckTargets describes endpoints to health-check when responding to Routing Policy queries. Only the healthy endpoints will be included in the response. Only one of internal_load_balancer and external_endpoints should be set. # For A and AAAA types only. Endpoints to return in the query result only if they are healthy. These can be specified along with rrdata within this item. + "healthCheckedTargets": { # HealthCheckTargets describes endpoints to health-check when responding to Routing Policy queries. Only the healthy endpoints will be included in the response. # For A and AAAA types only. Endpoints to return in the query result only if they are healthy. These can be specified along with `rrdata` within this item. "internalLoadBalancers": [ # Configuration for internal load balancers to be health checked. { # The configuration for an individual load balancer to health check. "ipAddress": "A String", # The frontend IP address of the load balancer to health check. "ipProtocol": "A String", # The protocol of the load balancer to health check. "kind": "dns#rRSetRoutingPolicyLoadBalancerTarget", "loadBalancerType": "A String", # The type of load balancer specified by this target. This value must match the configuration of the load balancer located at the LoadBalancerTarget's IP address, port, and region. Use the following: - *regionalL4ilb*: for a regional internal passthrough Network Load Balancer. - *regionalL7ilb*: for a regional internal Application Load Balancer. - *globalL7ilb*: for a global internal Application Load Balancer. - "networkUrl": "A String", # The fully qualified URL of the network that the load balancer is attached to. This should be formatted like https://www.googleapis.com/compute/v1/projects/{project}/global/networks/{network} . + "networkUrl": "A String", # The fully qualified URL of the network that the load balancer is attached to. This should be formatted like `https://www.googleapis.com/compute/v1/projects/{project}/global/networks/{network}`. "port": "A String", # The configured port of the load balancer. "project": "A String", # The project ID in which the load balancer is located. "region": "A String", # The region in which the load balancer is located. @@ -302,7 +302,7 @@

Method Details

"rrdatas": [ "A String", ], - "signatureRrdatas": [ # DNSSEC generated signatures for all the rrdata within this item. If health checked targets are provided for DNSSEC enabled zones, there's a restriction of 1 IP address per item. + "signatureRrdatas": [ # DNSSEC generated signatures for all the `rrdata` within this item. If health checked targets are provided for DNSSEC enabled zones, there's a restriction of 1 IP address per item. "A String", ], }, @@ -310,33 +310,33 @@

Method Details

"kind": "dns#rRSetRoutingPolicyGeoPolicy", }, "kind": "dns#rRSetRoutingPolicyPrimaryBackupPolicy", - "primaryTargets": { # HealthCheckTargets describes endpoints to health-check when responding to Routing Policy queries. Only the healthy endpoints will be included in the response. Only one of internal_load_balancer and external_endpoints should be set. # Endpoints that are health checked before making the routing decision. Unhealthy endpoints are omitted from the results. If all endpoints are unhealthy, we serve a response based on the backup_geo_targets. + "primaryTargets": { # HealthCheckTargets describes endpoints to health-check when responding to Routing Policy queries. Only the healthy endpoints will be included in the response. # Endpoints that are health checked before making the routing decision. Unhealthy endpoints are omitted from the results. If all endpoints are unhealthy, we serve a response based on the `backup_geo_targets`. "internalLoadBalancers": [ # Configuration for internal load balancers to be health checked. { # The configuration for an individual load balancer to health check. "ipAddress": "A String", # The frontend IP address of the load balancer to health check. "ipProtocol": "A String", # The protocol of the load balancer to health check. "kind": "dns#rRSetRoutingPolicyLoadBalancerTarget", "loadBalancerType": "A String", # The type of load balancer specified by this target. This value must match the configuration of the load balancer located at the LoadBalancerTarget's IP address, port, and region. Use the following: - *regionalL4ilb*: for a regional internal passthrough Network Load Balancer. - *regionalL7ilb*: for a regional internal Application Load Balancer. - *globalL7ilb*: for a global internal Application Load Balancer. - "networkUrl": "A String", # The fully qualified URL of the network that the load balancer is attached to. This should be formatted like https://www.googleapis.com/compute/v1/projects/{project}/global/networks/{network} . + "networkUrl": "A String", # The fully qualified URL of the network that the load balancer is attached to. This should be formatted like `https://www.googleapis.com/compute/v1/projects/{project}/global/networks/{network}`. "port": "A String", # The configured port of the load balancer. "project": "A String", # The project ID in which the load balancer is located. "region": "A String", # The region in which the load balancer is located. }, ], }, - "trickleTraffic": 3.14, # When serving state is PRIMARY, this field provides the option of sending a small percentage of the traffic to the backup targets. + "trickleTraffic": 3.14, # When serving state is `PRIMARY`, this field provides the option of sending a small percentage of the traffic to the backup targets. }, "wrr": { # Configures a RRSetRoutingPolicy that routes in a weighted round robin fashion. "items": [ { # A routing block which contains the routing information for one WRR item. - "healthCheckedTargets": { # HealthCheckTargets describes endpoints to health-check when responding to Routing Policy queries. Only the healthy endpoints will be included in the response. Only one of internal_load_balancer and external_endpoints should be set. # Endpoints that are health checked before making the routing decision. The unhealthy endpoints are omitted from the result. If all endpoints within a bucket are unhealthy, we choose a different bucket (sampled with respect to its weight) for responding. If DNSSEC is enabled for this zone, only one of rrdata or health_checked_targets can be set. + "healthCheckedTargets": { # HealthCheckTargets describes endpoints to health-check when responding to Routing Policy queries. Only the healthy endpoints will be included in the response. # Endpoints that are health checked before making the routing decision. The unhealthy endpoints are omitted from the result. If all endpoints within a bucket are unhealthy, we choose a different bucket (sampled with respect to its weight) for responding. If DNSSEC is enabled for this zone, only one of `rrdata` or `health_checked_targets` can be set. "internalLoadBalancers": [ # Configuration for internal load balancers to be health checked. { # The configuration for an individual load balancer to health check. "ipAddress": "A String", # The frontend IP address of the load balancer to health check. "ipProtocol": "A String", # The protocol of the load balancer to health check. "kind": "dns#rRSetRoutingPolicyLoadBalancerTarget", "loadBalancerType": "A String", # The type of load balancer specified by this target. This value must match the configuration of the load balancer located at the LoadBalancerTarget's IP address, port, and region. Use the following: - *regionalL4ilb*: for a regional internal passthrough Network Load Balancer. - *regionalL7ilb*: for a regional internal Application Load Balancer. - *globalL7ilb*: for a global internal Application Load Balancer. - "networkUrl": "A String", # The fully qualified URL of the network that the load balancer is attached to. This should be formatted like https://www.googleapis.com/compute/v1/projects/{project}/global/networks/{network} . + "networkUrl": "A String", # The fully qualified URL of the network that the load balancer is attached to. This should be formatted like `https://www.googleapis.com/compute/v1/projects/{project}/global/networks/{network}`. "port": "A String", # The configured port of the load balancer. "project": "A String", # The project ID in which the load balancer is located. "region": "A String", # The region in which the load balancer is located. @@ -347,10 +347,10 @@

Method Details

"rrdatas": [ "A String", ], - "signatureRrdatas": [ # DNSSEC generated signatures for all the rrdata within this item. Note that if health checked targets are provided for DNSSEC enabled zones, there's a restriction of 1 IP address per item. + "signatureRrdatas": [ # DNSSEC generated signatures for all the `rrdata` within this item. Note that if health checked targets are provided for DNSSEC enabled zones, there's a restriction of 1 IP address per item. "A String", ], - "weight": 3.14, # The weight corresponding to this WrrPolicyItem object. When multiple WrrPolicyItem objects are configured, the probability of returning an WrrPolicyItem object's data is proportional to its weight relative to the sum of weights configured for all items. This weight must be non-negative. + "weight": 3.14, # The weight corresponding to this `WrrPolicyItem` object. When multiple `WrrPolicyItem` objects are configured, the probability of returning an `WrrPolicyItem` object's data is proportional to its weight relative to the sum of weights configured for all items. This weight must be non-negative. }, ], "kind": "dns#rRSetRoutingPolicyWrrPolicy", @@ -362,7 +362,7 @@

Method Details

"signatureRrdatas": [ # As defined in RFC 4034 (section 3.2). "A String", ], - "ttl": 42, # Number of seconds that this ResourceRecordSet can be cached by resolvers. + "ttl": 42, # Number of seconds that this `ResourceRecordSet` can be cached by resolvers. "type": "A String", # The identifier of a supported record type. See the list of Supported DNS record types. }
@@ -410,19 +410,19 @@

Method Details

{ # A unit of data that is returned by the DNS servers. "kind": "dns#resourceRecordSet", "name": "A String", # For example, www.example.com. - "routingPolicy": { # A RRSetRoutingPolicy represents ResourceRecordSet data that is returned dynamically with the response varying based on configured properties such as geolocation or by weighted random selection. # Configures dynamic query responses based on either the geo location of the querying user or a weighted round robin based routing policy. A valid ResourceRecordSet contains only rrdata (for static resolution) or a routing_policy (for dynamic resolution). - "geo": { # Configures a RRSetRoutingPolicy that routes based on the geo location of the querying user. + "routingPolicy": { # A RRSetRoutingPolicy represents ResourceRecordSet data that is returned dynamically with the response varying based on configured properties such as geolocation or by weighted random selection. # Configures dynamic query responses based on either the geo location of the querying user or a weighted round robin based routing policy. A valid `ResourceRecordSet` contains only `rrdata` (for static resolution) or a `routing_policy` (for dynamic resolution). + "geo": { # Configures a `RRSetRoutingPolicy` that routes based on the geo location of the querying user. "enableFencing": True or False, # Without fencing, if health check fails for all configured items in the current geo bucket, we failover to the next nearest geo bucket. With fencing, if health checking is enabled, as long as some targets in the current geo bucket are healthy, we return only the healthy targets. However, if all targets are unhealthy, we don't failover to the next nearest bucket; instead, we return all the items in the current bucket even when all targets are unhealthy. "items": [ # The primary geo routing configuration. If there are multiple items with the same location, an error is returned instead. { # ResourceRecordSet data for one geo location. - "healthCheckedTargets": { # HealthCheckTargets describes endpoints to health-check when responding to Routing Policy queries. Only the healthy endpoints will be included in the response. Only one of internal_load_balancer and external_endpoints should be set. # For A and AAAA types only. Endpoints to return in the query result only if they are healthy. These can be specified along with rrdata within this item. + "healthCheckedTargets": { # HealthCheckTargets describes endpoints to health-check when responding to Routing Policy queries. Only the healthy endpoints will be included in the response. # For A and AAAA types only. Endpoints to return in the query result only if they are healthy. These can be specified along with `rrdata` within this item. "internalLoadBalancers": [ # Configuration for internal load balancers to be health checked. { # The configuration for an individual load balancer to health check. "ipAddress": "A String", # The frontend IP address of the load balancer to health check. "ipProtocol": "A String", # The protocol of the load balancer to health check. "kind": "dns#rRSetRoutingPolicyLoadBalancerTarget", "loadBalancerType": "A String", # The type of load balancer specified by this target. This value must match the configuration of the load balancer located at the LoadBalancerTarget's IP address, port, and region. Use the following: - *regionalL4ilb*: for a regional internal passthrough Network Load Balancer. - *regionalL7ilb*: for a regional internal Application Load Balancer. - *globalL7ilb*: for a global internal Application Load Balancer. - "networkUrl": "A String", # The fully qualified URL of the network that the load balancer is attached to. This should be formatted like https://www.googleapis.com/compute/v1/projects/{project}/global/networks/{network} . + "networkUrl": "A String", # The fully qualified URL of the network that the load balancer is attached to. This should be formatted like `https://www.googleapis.com/compute/v1/projects/{project}/global/networks/{network}`. "port": "A String", # The configured port of the load balancer. "project": "A String", # The project ID in which the load balancer is located. "region": "A String", # The region in which the load balancer is located. @@ -434,7 +434,7 @@

Method Details

"rrdatas": [ "A String", ], - "signatureRrdatas": [ # DNSSEC generated signatures for all the rrdata within this item. If health checked targets are provided for DNSSEC enabled zones, there's a restriction of 1 IP address per item. + "signatureRrdatas": [ # DNSSEC generated signatures for all the `rrdata` within this item. If health checked targets are provided for DNSSEC enabled zones, there's a restriction of 1 IP address per item. "A String", ], }, @@ -443,18 +443,18 @@

Method Details

}, "kind": "dns#rRSetRoutingPolicy", "primaryBackup": { # Configures a RRSetRoutingPolicy such that all queries are responded with the primary_targets if they are healthy. And if all of them are unhealthy, then we fallback to a geo localized policy. - "backupGeoTargets": { # Configures a RRSetRoutingPolicy that routes based on the geo location of the querying user. # Backup targets provide a regional failover policy for the otherwise global primary targets. If serving state is set to BACKUP, this policy essentially becomes a geo routing policy. + "backupGeoTargets": { # Configures a `RRSetRoutingPolicy` that routes based on the geo location of the querying user. # Backup targets provide a regional failover policy for the otherwise global primary targets. If serving state is set to `BACKUP`, this policy essentially becomes a geo routing policy. "enableFencing": True or False, # Without fencing, if health check fails for all configured items in the current geo bucket, we failover to the next nearest geo bucket. With fencing, if health checking is enabled, as long as some targets in the current geo bucket are healthy, we return only the healthy targets. However, if all targets are unhealthy, we don't failover to the next nearest bucket; instead, we return all the items in the current bucket even when all targets are unhealthy. "items": [ # The primary geo routing configuration. If there are multiple items with the same location, an error is returned instead. { # ResourceRecordSet data for one geo location. - "healthCheckedTargets": { # HealthCheckTargets describes endpoints to health-check when responding to Routing Policy queries. Only the healthy endpoints will be included in the response. Only one of internal_load_balancer and external_endpoints should be set. # For A and AAAA types only. Endpoints to return in the query result only if they are healthy. These can be specified along with rrdata within this item. + "healthCheckedTargets": { # HealthCheckTargets describes endpoints to health-check when responding to Routing Policy queries. Only the healthy endpoints will be included in the response. # For A and AAAA types only. Endpoints to return in the query result only if they are healthy. These can be specified along with `rrdata` within this item. "internalLoadBalancers": [ # Configuration for internal load balancers to be health checked. { # The configuration for an individual load balancer to health check. "ipAddress": "A String", # The frontend IP address of the load balancer to health check. "ipProtocol": "A String", # The protocol of the load balancer to health check. "kind": "dns#rRSetRoutingPolicyLoadBalancerTarget", "loadBalancerType": "A String", # The type of load balancer specified by this target. This value must match the configuration of the load balancer located at the LoadBalancerTarget's IP address, port, and region. Use the following: - *regionalL4ilb*: for a regional internal passthrough Network Load Balancer. - *regionalL7ilb*: for a regional internal Application Load Balancer. - *globalL7ilb*: for a global internal Application Load Balancer. - "networkUrl": "A String", # The fully qualified URL of the network that the load balancer is attached to. This should be formatted like https://www.googleapis.com/compute/v1/projects/{project}/global/networks/{network} . + "networkUrl": "A String", # The fully qualified URL of the network that the load balancer is attached to. This should be formatted like `https://www.googleapis.com/compute/v1/projects/{project}/global/networks/{network}`. "port": "A String", # The configured port of the load balancer. "project": "A String", # The project ID in which the load balancer is located. "region": "A String", # The region in which the load balancer is located. @@ -466,7 +466,7 @@

Method Details

"rrdatas": [ "A String", ], - "signatureRrdatas": [ # DNSSEC generated signatures for all the rrdata within this item. If health checked targets are provided for DNSSEC enabled zones, there's a restriction of 1 IP address per item. + "signatureRrdatas": [ # DNSSEC generated signatures for all the `rrdata` within this item. If health checked targets are provided for DNSSEC enabled zones, there's a restriction of 1 IP address per item. "A String", ], }, @@ -474,33 +474,33 @@

Method Details

"kind": "dns#rRSetRoutingPolicyGeoPolicy", }, "kind": "dns#rRSetRoutingPolicyPrimaryBackupPolicy", - "primaryTargets": { # HealthCheckTargets describes endpoints to health-check when responding to Routing Policy queries. Only the healthy endpoints will be included in the response. Only one of internal_load_balancer and external_endpoints should be set. # Endpoints that are health checked before making the routing decision. Unhealthy endpoints are omitted from the results. If all endpoints are unhealthy, we serve a response based on the backup_geo_targets. + "primaryTargets": { # HealthCheckTargets describes endpoints to health-check when responding to Routing Policy queries. Only the healthy endpoints will be included in the response. # Endpoints that are health checked before making the routing decision. Unhealthy endpoints are omitted from the results. If all endpoints are unhealthy, we serve a response based on the `backup_geo_targets`. "internalLoadBalancers": [ # Configuration for internal load balancers to be health checked. { # The configuration for an individual load balancer to health check. "ipAddress": "A String", # The frontend IP address of the load balancer to health check. "ipProtocol": "A String", # The protocol of the load balancer to health check. "kind": "dns#rRSetRoutingPolicyLoadBalancerTarget", "loadBalancerType": "A String", # The type of load balancer specified by this target. This value must match the configuration of the load balancer located at the LoadBalancerTarget's IP address, port, and region. Use the following: - *regionalL4ilb*: for a regional internal passthrough Network Load Balancer. - *regionalL7ilb*: for a regional internal Application Load Balancer. - *globalL7ilb*: for a global internal Application Load Balancer. - "networkUrl": "A String", # The fully qualified URL of the network that the load balancer is attached to. This should be formatted like https://www.googleapis.com/compute/v1/projects/{project}/global/networks/{network} . + "networkUrl": "A String", # The fully qualified URL of the network that the load balancer is attached to. This should be formatted like `https://www.googleapis.com/compute/v1/projects/{project}/global/networks/{network}`. "port": "A String", # The configured port of the load balancer. "project": "A String", # The project ID in which the load balancer is located. "region": "A String", # The region in which the load balancer is located. }, ], }, - "trickleTraffic": 3.14, # When serving state is PRIMARY, this field provides the option of sending a small percentage of the traffic to the backup targets. + "trickleTraffic": 3.14, # When serving state is `PRIMARY`, this field provides the option of sending a small percentage of the traffic to the backup targets. }, "wrr": { # Configures a RRSetRoutingPolicy that routes in a weighted round robin fashion. "items": [ { # A routing block which contains the routing information for one WRR item. - "healthCheckedTargets": { # HealthCheckTargets describes endpoints to health-check when responding to Routing Policy queries. Only the healthy endpoints will be included in the response. Only one of internal_load_balancer and external_endpoints should be set. # Endpoints that are health checked before making the routing decision. The unhealthy endpoints are omitted from the result. If all endpoints within a bucket are unhealthy, we choose a different bucket (sampled with respect to its weight) for responding. If DNSSEC is enabled for this zone, only one of rrdata or health_checked_targets can be set. + "healthCheckedTargets": { # HealthCheckTargets describes endpoints to health-check when responding to Routing Policy queries. Only the healthy endpoints will be included in the response. # Endpoints that are health checked before making the routing decision. The unhealthy endpoints are omitted from the result. If all endpoints within a bucket are unhealthy, we choose a different bucket (sampled with respect to its weight) for responding. If DNSSEC is enabled for this zone, only one of `rrdata` or `health_checked_targets` can be set. "internalLoadBalancers": [ # Configuration for internal load balancers to be health checked. { # The configuration for an individual load balancer to health check. "ipAddress": "A String", # The frontend IP address of the load balancer to health check. "ipProtocol": "A String", # The protocol of the load balancer to health check. "kind": "dns#rRSetRoutingPolicyLoadBalancerTarget", "loadBalancerType": "A String", # The type of load balancer specified by this target. This value must match the configuration of the load balancer located at the LoadBalancerTarget's IP address, port, and region. Use the following: - *regionalL4ilb*: for a regional internal passthrough Network Load Balancer. - *regionalL7ilb*: for a regional internal Application Load Balancer. - *globalL7ilb*: for a global internal Application Load Balancer. - "networkUrl": "A String", # The fully qualified URL of the network that the load balancer is attached to. This should be formatted like https://www.googleapis.com/compute/v1/projects/{project}/global/networks/{network} . + "networkUrl": "A String", # The fully qualified URL of the network that the load balancer is attached to. This should be formatted like `https://www.googleapis.com/compute/v1/projects/{project}/global/networks/{network}`. "port": "A String", # The configured port of the load balancer. "project": "A String", # The project ID in which the load balancer is located. "region": "A String", # The region in which the load balancer is located. @@ -511,10 +511,10 @@

Method Details

"rrdatas": [ "A String", ], - "signatureRrdatas": [ # DNSSEC generated signatures for all the rrdata within this item. Note that if health checked targets are provided for DNSSEC enabled zones, there's a restriction of 1 IP address per item. + "signatureRrdatas": [ # DNSSEC generated signatures for all the `rrdata` within this item. Note that if health checked targets are provided for DNSSEC enabled zones, there's a restriction of 1 IP address per item. "A String", ], - "weight": 3.14, # The weight corresponding to this WrrPolicyItem object. When multiple WrrPolicyItem objects are configured, the probability of returning an WrrPolicyItem object's data is proportional to its weight relative to the sum of weights configured for all items. This weight must be non-negative. + "weight": 3.14, # The weight corresponding to this `WrrPolicyItem` object. When multiple `WrrPolicyItem` objects are configured, the probability of returning an `WrrPolicyItem` object's data is proportional to its weight relative to the sum of weights configured for all items. This weight must be non-negative. }, ], "kind": "dns#rRSetRoutingPolicyWrrPolicy", @@ -526,7 +526,7 @@

Method Details

"signatureRrdatas": [ # As defined in RFC 4034 (section 3.2). "A String", ], - "ttl": 42, # Number of seconds that this ResourceRecordSet can be cached by resolvers. + "ttl": 42, # Number of seconds that this `ResourceRecordSet` can be cached by resolvers. "type": "A String", # The identifier of a supported record type. See the list of Supported DNS record types. } @@ -551,28 +551,25 @@

Method Details

An object of the form: { - "header": { # Elements common to every response. - "operationId": "A String", # For mutating operation requests that completed successfully. This is the client_operation_id if the client specified it, otherwise it is generated by the server (output only). - }, "kind": "dns#resourceRecordSetsListResponse", # Type of resource. - "nextPageToken": "A String", # The presence of this field indicates that there exist more results following your last page of results in pagination order. To fetch them, make another list request using this value as your pagination token. This lets you retrieve the complete contents of even larger collections, one page at a time. However, if the collection changes between paginated list requests, the set of elements returned is an inconsistent view of the collection. You cannot retrieve a consistent snapshot of a collection larger than the maximum page size. + "nextPageToken": "A String", # This field indicates that more results are available beyond the last page displayed. To fetch the results, make another list request and use this value as your page token. This lets you retrieve the complete contents of a very large collection one page at a time. However, if the contents of the collection change between the first and last paginated list request, the set of all elements returned are an inconsistent view of the collection. You can't retrieve a consistent snapshot of a collection larger than the maximum page size. "rrsets": [ # The resource record set resources. { # A unit of data that is returned by the DNS servers. "kind": "dns#resourceRecordSet", "name": "A String", # For example, www.example.com. - "routingPolicy": { # A RRSetRoutingPolicy represents ResourceRecordSet data that is returned dynamically with the response varying based on configured properties such as geolocation or by weighted random selection. # Configures dynamic query responses based on either the geo location of the querying user or a weighted round robin based routing policy. A valid ResourceRecordSet contains only rrdata (for static resolution) or a routing_policy (for dynamic resolution). - "geo": { # Configures a RRSetRoutingPolicy that routes based on the geo location of the querying user. + "routingPolicy": { # A RRSetRoutingPolicy represents ResourceRecordSet data that is returned dynamically with the response varying based on configured properties such as geolocation or by weighted random selection. # Configures dynamic query responses based on either the geo location of the querying user or a weighted round robin based routing policy. A valid `ResourceRecordSet` contains only `rrdata` (for static resolution) or a `routing_policy` (for dynamic resolution). + "geo": { # Configures a `RRSetRoutingPolicy` that routes based on the geo location of the querying user. "enableFencing": True or False, # Without fencing, if health check fails for all configured items in the current geo bucket, we failover to the next nearest geo bucket. With fencing, if health checking is enabled, as long as some targets in the current geo bucket are healthy, we return only the healthy targets. However, if all targets are unhealthy, we don't failover to the next nearest bucket; instead, we return all the items in the current bucket even when all targets are unhealthy. "items": [ # The primary geo routing configuration. If there are multiple items with the same location, an error is returned instead. { # ResourceRecordSet data for one geo location. - "healthCheckedTargets": { # HealthCheckTargets describes endpoints to health-check when responding to Routing Policy queries. Only the healthy endpoints will be included in the response. Only one of internal_load_balancer and external_endpoints should be set. # For A and AAAA types only. Endpoints to return in the query result only if they are healthy. These can be specified along with rrdata within this item. + "healthCheckedTargets": { # HealthCheckTargets describes endpoints to health-check when responding to Routing Policy queries. Only the healthy endpoints will be included in the response. # For A and AAAA types only. Endpoints to return in the query result only if they are healthy. These can be specified along with `rrdata` within this item. "internalLoadBalancers": [ # Configuration for internal load balancers to be health checked. { # The configuration for an individual load balancer to health check. "ipAddress": "A String", # The frontend IP address of the load balancer to health check. "ipProtocol": "A String", # The protocol of the load balancer to health check. "kind": "dns#rRSetRoutingPolicyLoadBalancerTarget", "loadBalancerType": "A String", # The type of load balancer specified by this target. This value must match the configuration of the load balancer located at the LoadBalancerTarget's IP address, port, and region. Use the following: - *regionalL4ilb*: for a regional internal passthrough Network Load Balancer. - *regionalL7ilb*: for a regional internal Application Load Balancer. - *globalL7ilb*: for a global internal Application Load Balancer. - "networkUrl": "A String", # The fully qualified URL of the network that the load balancer is attached to. This should be formatted like https://www.googleapis.com/compute/v1/projects/{project}/global/networks/{network} . + "networkUrl": "A String", # The fully qualified URL of the network that the load balancer is attached to. This should be formatted like `https://www.googleapis.com/compute/v1/projects/{project}/global/networks/{network}`. "port": "A String", # The configured port of the load balancer. "project": "A String", # The project ID in which the load balancer is located. "region": "A String", # The region in which the load balancer is located. @@ -584,7 +581,7 @@

Method Details

"rrdatas": [ "A String", ], - "signatureRrdatas": [ # DNSSEC generated signatures for all the rrdata within this item. If health checked targets are provided for DNSSEC enabled zones, there's a restriction of 1 IP address per item. + "signatureRrdatas": [ # DNSSEC generated signatures for all the `rrdata` within this item. If health checked targets are provided for DNSSEC enabled zones, there's a restriction of 1 IP address per item. "A String", ], }, @@ -593,18 +590,18 @@

Method Details

}, "kind": "dns#rRSetRoutingPolicy", "primaryBackup": { # Configures a RRSetRoutingPolicy such that all queries are responded with the primary_targets if they are healthy. And if all of them are unhealthy, then we fallback to a geo localized policy. - "backupGeoTargets": { # Configures a RRSetRoutingPolicy that routes based on the geo location of the querying user. # Backup targets provide a regional failover policy for the otherwise global primary targets. If serving state is set to BACKUP, this policy essentially becomes a geo routing policy. + "backupGeoTargets": { # Configures a `RRSetRoutingPolicy` that routes based on the geo location of the querying user. # Backup targets provide a regional failover policy for the otherwise global primary targets. If serving state is set to `BACKUP`, this policy essentially becomes a geo routing policy. "enableFencing": True or False, # Without fencing, if health check fails for all configured items in the current geo bucket, we failover to the next nearest geo bucket. With fencing, if health checking is enabled, as long as some targets in the current geo bucket are healthy, we return only the healthy targets. However, if all targets are unhealthy, we don't failover to the next nearest bucket; instead, we return all the items in the current bucket even when all targets are unhealthy. "items": [ # The primary geo routing configuration. If there are multiple items with the same location, an error is returned instead. { # ResourceRecordSet data for one geo location. - "healthCheckedTargets": { # HealthCheckTargets describes endpoints to health-check when responding to Routing Policy queries. Only the healthy endpoints will be included in the response. Only one of internal_load_balancer and external_endpoints should be set. # For A and AAAA types only. Endpoints to return in the query result only if they are healthy. These can be specified along with rrdata within this item. + "healthCheckedTargets": { # HealthCheckTargets describes endpoints to health-check when responding to Routing Policy queries. Only the healthy endpoints will be included in the response. # For A and AAAA types only. Endpoints to return in the query result only if they are healthy. These can be specified along with `rrdata` within this item. "internalLoadBalancers": [ # Configuration for internal load balancers to be health checked. { # The configuration for an individual load balancer to health check. "ipAddress": "A String", # The frontend IP address of the load balancer to health check. "ipProtocol": "A String", # The protocol of the load balancer to health check. "kind": "dns#rRSetRoutingPolicyLoadBalancerTarget", "loadBalancerType": "A String", # The type of load balancer specified by this target. This value must match the configuration of the load balancer located at the LoadBalancerTarget's IP address, port, and region. Use the following: - *regionalL4ilb*: for a regional internal passthrough Network Load Balancer. - *regionalL7ilb*: for a regional internal Application Load Balancer. - *globalL7ilb*: for a global internal Application Load Balancer. - "networkUrl": "A String", # The fully qualified URL of the network that the load balancer is attached to. This should be formatted like https://www.googleapis.com/compute/v1/projects/{project}/global/networks/{network} . + "networkUrl": "A String", # The fully qualified URL of the network that the load balancer is attached to. This should be formatted like `https://www.googleapis.com/compute/v1/projects/{project}/global/networks/{network}`. "port": "A String", # The configured port of the load balancer. "project": "A String", # The project ID in which the load balancer is located. "region": "A String", # The region in which the load balancer is located. @@ -616,7 +613,7 @@

Method Details

"rrdatas": [ "A String", ], - "signatureRrdatas": [ # DNSSEC generated signatures for all the rrdata within this item. If health checked targets are provided for DNSSEC enabled zones, there's a restriction of 1 IP address per item. + "signatureRrdatas": [ # DNSSEC generated signatures for all the `rrdata` within this item. If health checked targets are provided for DNSSEC enabled zones, there's a restriction of 1 IP address per item. "A String", ], }, @@ -624,33 +621,33 @@

Method Details

"kind": "dns#rRSetRoutingPolicyGeoPolicy", }, "kind": "dns#rRSetRoutingPolicyPrimaryBackupPolicy", - "primaryTargets": { # HealthCheckTargets describes endpoints to health-check when responding to Routing Policy queries. Only the healthy endpoints will be included in the response. Only one of internal_load_balancer and external_endpoints should be set. # Endpoints that are health checked before making the routing decision. Unhealthy endpoints are omitted from the results. If all endpoints are unhealthy, we serve a response based on the backup_geo_targets. + "primaryTargets": { # HealthCheckTargets describes endpoints to health-check when responding to Routing Policy queries. Only the healthy endpoints will be included in the response. # Endpoints that are health checked before making the routing decision. Unhealthy endpoints are omitted from the results. If all endpoints are unhealthy, we serve a response based on the `backup_geo_targets`. "internalLoadBalancers": [ # Configuration for internal load balancers to be health checked. { # The configuration for an individual load balancer to health check. "ipAddress": "A String", # The frontend IP address of the load balancer to health check. "ipProtocol": "A String", # The protocol of the load balancer to health check. "kind": "dns#rRSetRoutingPolicyLoadBalancerTarget", "loadBalancerType": "A String", # The type of load balancer specified by this target. This value must match the configuration of the load balancer located at the LoadBalancerTarget's IP address, port, and region. Use the following: - *regionalL4ilb*: for a regional internal passthrough Network Load Balancer. - *regionalL7ilb*: for a regional internal Application Load Balancer. - *globalL7ilb*: for a global internal Application Load Balancer. - "networkUrl": "A String", # The fully qualified URL of the network that the load balancer is attached to. This should be formatted like https://www.googleapis.com/compute/v1/projects/{project}/global/networks/{network} . + "networkUrl": "A String", # The fully qualified URL of the network that the load balancer is attached to. This should be formatted like `https://www.googleapis.com/compute/v1/projects/{project}/global/networks/{network}`. "port": "A String", # The configured port of the load balancer. "project": "A String", # The project ID in which the load balancer is located. "region": "A String", # The region in which the load balancer is located. }, ], }, - "trickleTraffic": 3.14, # When serving state is PRIMARY, this field provides the option of sending a small percentage of the traffic to the backup targets. + "trickleTraffic": 3.14, # When serving state is `PRIMARY`, this field provides the option of sending a small percentage of the traffic to the backup targets. }, "wrr": { # Configures a RRSetRoutingPolicy that routes in a weighted round robin fashion. "items": [ { # A routing block which contains the routing information for one WRR item. - "healthCheckedTargets": { # HealthCheckTargets describes endpoints to health-check when responding to Routing Policy queries. Only the healthy endpoints will be included in the response. Only one of internal_load_balancer and external_endpoints should be set. # Endpoints that are health checked before making the routing decision. The unhealthy endpoints are omitted from the result. If all endpoints within a bucket are unhealthy, we choose a different bucket (sampled with respect to its weight) for responding. If DNSSEC is enabled for this zone, only one of rrdata or health_checked_targets can be set. + "healthCheckedTargets": { # HealthCheckTargets describes endpoints to health-check when responding to Routing Policy queries. Only the healthy endpoints will be included in the response. # Endpoints that are health checked before making the routing decision. The unhealthy endpoints are omitted from the result. If all endpoints within a bucket are unhealthy, we choose a different bucket (sampled with respect to its weight) for responding. If DNSSEC is enabled for this zone, only one of `rrdata` or `health_checked_targets` can be set. "internalLoadBalancers": [ # Configuration for internal load balancers to be health checked. { # The configuration for an individual load balancer to health check. "ipAddress": "A String", # The frontend IP address of the load balancer to health check. "ipProtocol": "A String", # The protocol of the load balancer to health check. "kind": "dns#rRSetRoutingPolicyLoadBalancerTarget", "loadBalancerType": "A String", # The type of load balancer specified by this target. This value must match the configuration of the load balancer located at the LoadBalancerTarget's IP address, port, and region. Use the following: - *regionalL4ilb*: for a regional internal passthrough Network Load Balancer. - *regionalL7ilb*: for a regional internal Application Load Balancer. - *globalL7ilb*: for a global internal Application Load Balancer. - "networkUrl": "A String", # The fully qualified URL of the network that the load balancer is attached to. This should be formatted like https://www.googleapis.com/compute/v1/projects/{project}/global/networks/{network} . + "networkUrl": "A String", # The fully qualified URL of the network that the load balancer is attached to. This should be formatted like `https://www.googleapis.com/compute/v1/projects/{project}/global/networks/{network}`. "port": "A String", # The configured port of the load balancer. "project": "A String", # The project ID in which the load balancer is located. "region": "A String", # The region in which the load balancer is located. @@ -661,10 +658,10 @@

Method Details

"rrdatas": [ "A String", ], - "signatureRrdatas": [ # DNSSEC generated signatures for all the rrdata within this item. Note that if health checked targets are provided for DNSSEC enabled zones, there's a restriction of 1 IP address per item. + "signatureRrdatas": [ # DNSSEC generated signatures for all the `rrdata` within this item. Note that if health checked targets are provided for DNSSEC enabled zones, there's a restriction of 1 IP address per item. "A String", ], - "weight": 3.14, # The weight corresponding to this WrrPolicyItem object. When multiple WrrPolicyItem objects are configured, the probability of returning an WrrPolicyItem object's data is proportional to its weight relative to the sum of weights configured for all items. This weight must be non-negative. + "weight": 3.14, # The weight corresponding to this `WrrPolicyItem` object. When multiple `WrrPolicyItem` objects are configured, the probability of returning an `WrrPolicyItem` object's data is proportional to its weight relative to the sum of weights configured for all items. This weight must be non-negative. }, ], "kind": "dns#rRSetRoutingPolicyWrrPolicy", @@ -676,7 +673,7 @@

Method Details

"signatureRrdatas": [ # As defined in RFC 4034 (section 3.2). "A String", ], - "ttl": 42, # Number of seconds that this ResourceRecordSet can be cached by resolvers. + "ttl": 42, # Number of seconds that this `ResourceRecordSet` can be cached by resolvers. "type": "A String", # The identifier of a supported record type. See the list of Supported DNS record types. }, ], @@ -712,19 +709,19 @@

Method Details

{ # A unit of data that is returned by the DNS servers. "kind": "dns#resourceRecordSet", "name": "A String", # For example, www.example.com. - "routingPolicy": { # A RRSetRoutingPolicy represents ResourceRecordSet data that is returned dynamically with the response varying based on configured properties such as geolocation or by weighted random selection. # Configures dynamic query responses based on either the geo location of the querying user or a weighted round robin based routing policy. A valid ResourceRecordSet contains only rrdata (for static resolution) or a routing_policy (for dynamic resolution). - "geo": { # Configures a RRSetRoutingPolicy that routes based on the geo location of the querying user. + "routingPolicy": { # A RRSetRoutingPolicy represents ResourceRecordSet data that is returned dynamically with the response varying based on configured properties such as geolocation or by weighted random selection. # Configures dynamic query responses based on either the geo location of the querying user or a weighted round robin based routing policy. A valid `ResourceRecordSet` contains only `rrdata` (for static resolution) or a `routing_policy` (for dynamic resolution). + "geo": { # Configures a `RRSetRoutingPolicy` that routes based on the geo location of the querying user. "enableFencing": True or False, # Without fencing, if health check fails for all configured items in the current geo bucket, we failover to the next nearest geo bucket. With fencing, if health checking is enabled, as long as some targets in the current geo bucket are healthy, we return only the healthy targets. However, if all targets are unhealthy, we don't failover to the next nearest bucket; instead, we return all the items in the current bucket even when all targets are unhealthy. "items": [ # The primary geo routing configuration. If there are multiple items with the same location, an error is returned instead. { # ResourceRecordSet data for one geo location. - "healthCheckedTargets": { # HealthCheckTargets describes endpoints to health-check when responding to Routing Policy queries. Only the healthy endpoints will be included in the response. Only one of internal_load_balancer and external_endpoints should be set. # For A and AAAA types only. Endpoints to return in the query result only if they are healthy. These can be specified along with rrdata within this item. + "healthCheckedTargets": { # HealthCheckTargets describes endpoints to health-check when responding to Routing Policy queries. Only the healthy endpoints will be included in the response. # For A and AAAA types only. Endpoints to return in the query result only if they are healthy. These can be specified along with `rrdata` within this item. "internalLoadBalancers": [ # Configuration for internal load balancers to be health checked. { # The configuration for an individual load balancer to health check. "ipAddress": "A String", # The frontend IP address of the load balancer to health check. "ipProtocol": "A String", # The protocol of the load balancer to health check. "kind": "dns#rRSetRoutingPolicyLoadBalancerTarget", "loadBalancerType": "A String", # The type of load balancer specified by this target. This value must match the configuration of the load balancer located at the LoadBalancerTarget's IP address, port, and region. Use the following: - *regionalL4ilb*: for a regional internal passthrough Network Load Balancer. - *regionalL7ilb*: for a regional internal Application Load Balancer. - *globalL7ilb*: for a global internal Application Load Balancer. - "networkUrl": "A String", # The fully qualified URL of the network that the load balancer is attached to. This should be formatted like https://www.googleapis.com/compute/v1/projects/{project}/global/networks/{network} . + "networkUrl": "A String", # The fully qualified URL of the network that the load balancer is attached to. This should be formatted like `https://www.googleapis.com/compute/v1/projects/{project}/global/networks/{network}`. "port": "A String", # The configured port of the load balancer. "project": "A String", # The project ID in which the load balancer is located. "region": "A String", # The region in which the load balancer is located. @@ -736,7 +733,7 @@

Method Details

"rrdatas": [ "A String", ], - "signatureRrdatas": [ # DNSSEC generated signatures for all the rrdata within this item. If health checked targets are provided for DNSSEC enabled zones, there's a restriction of 1 IP address per item. + "signatureRrdatas": [ # DNSSEC generated signatures for all the `rrdata` within this item. If health checked targets are provided for DNSSEC enabled zones, there's a restriction of 1 IP address per item. "A String", ], }, @@ -745,18 +742,18 @@

Method Details

}, "kind": "dns#rRSetRoutingPolicy", "primaryBackup": { # Configures a RRSetRoutingPolicy such that all queries are responded with the primary_targets if they are healthy. And if all of them are unhealthy, then we fallback to a geo localized policy. - "backupGeoTargets": { # Configures a RRSetRoutingPolicy that routes based on the geo location of the querying user. # Backup targets provide a regional failover policy for the otherwise global primary targets. If serving state is set to BACKUP, this policy essentially becomes a geo routing policy. + "backupGeoTargets": { # Configures a `RRSetRoutingPolicy` that routes based on the geo location of the querying user. # Backup targets provide a regional failover policy for the otherwise global primary targets. If serving state is set to `BACKUP`, this policy essentially becomes a geo routing policy. "enableFencing": True or False, # Without fencing, if health check fails for all configured items in the current geo bucket, we failover to the next nearest geo bucket. With fencing, if health checking is enabled, as long as some targets in the current geo bucket are healthy, we return only the healthy targets. However, if all targets are unhealthy, we don't failover to the next nearest bucket; instead, we return all the items in the current bucket even when all targets are unhealthy. "items": [ # The primary geo routing configuration. If there are multiple items with the same location, an error is returned instead. { # ResourceRecordSet data for one geo location. - "healthCheckedTargets": { # HealthCheckTargets describes endpoints to health-check when responding to Routing Policy queries. Only the healthy endpoints will be included in the response. Only one of internal_load_balancer and external_endpoints should be set. # For A and AAAA types only. Endpoints to return in the query result only if they are healthy. These can be specified along with rrdata within this item. + "healthCheckedTargets": { # HealthCheckTargets describes endpoints to health-check when responding to Routing Policy queries. Only the healthy endpoints will be included in the response. # For A and AAAA types only. Endpoints to return in the query result only if they are healthy. These can be specified along with `rrdata` within this item. "internalLoadBalancers": [ # Configuration for internal load balancers to be health checked. { # The configuration for an individual load balancer to health check. "ipAddress": "A String", # The frontend IP address of the load balancer to health check. "ipProtocol": "A String", # The protocol of the load balancer to health check. "kind": "dns#rRSetRoutingPolicyLoadBalancerTarget", "loadBalancerType": "A String", # The type of load balancer specified by this target. This value must match the configuration of the load balancer located at the LoadBalancerTarget's IP address, port, and region. Use the following: - *regionalL4ilb*: for a regional internal passthrough Network Load Balancer. - *regionalL7ilb*: for a regional internal Application Load Balancer. - *globalL7ilb*: for a global internal Application Load Balancer. - "networkUrl": "A String", # The fully qualified URL of the network that the load balancer is attached to. This should be formatted like https://www.googleapis.com/compute/v1/projects/{project}/global/networks/{network} . + "networkUrl": "A String", # The fully qualified URL of the network that the load balancer is attached to. This should be formatted like `https://www.googleapis.com/compute/v1/projects/{project}/global/networks/{network}`. "port": "A String", # The configured port of the load balancer. "project": "A String", # The project ID in which the load balancer is located. "region": "A String", # The region in which the load balancer is located. @@ -768,7 +765,7 @@

Method Details

"rrdatas": [ "A String", ], - "signatureRrdatas": [ # DNSSEC generated signatures for all the rrdata within this item. If health checked targets are provided for DNSSEC enabled zones, there's a restriction of 1 IP address per item. + "signatureRrdatas": [ # DNSSEC generated signatures for all the `rrdata` within this item. If health checked targets are provided for DNSSEC enabled zones, there's a restriction of 1 IP address per item. "A String", ], }, @@ -776,33 +773,33 @@

Method Details

"kind": "dns#rRSetRoutingPolicyGeoPolicy", }, "kind": "dns#rRSetRoutingPolicyPrimaryBackupPolicy", - "primaryTargets": { # HealthCheckTargets describes endpoints to health-check when responding to Routing Policy queries. Only the healthy endpoints will be included in the response. Only one of internal_load_balancer and external_endpoints should be set. # Endpoints that are health checked before making the routing decision. Unhealthy endpoints are omitted from the results. If all endpoints are unhealthy, we serve a response based on the backup_geo_targets. + "primaryTargets": { # HealthCheckTargets describes endpoints to health-check when responding to Routing Policy queries. Only the healthy endpoints will be included in the response. # Endpoints that are health checked before making the routing decision. Unhealthy endpoints are omitted from the results. If all endpoints are unhealthy, we serve a response based on the `backup_geo_targets`. "internalLoadBalancers": [ # Configuration for internal load balancers to be health checked. { # The configuration for an individual load balancer to health check. "ipAddress": "A String", # The frontend IP address of the load balancer to health check. "ipProtocol": "A String", # The protocol of the load balancer to health check. "kind": "dns#rRSetRoutingPolicyLoadBalancerTarget", "loadBalancerType": "A String", # The type of load balancer specified by this target. This value must match the configuration of the load balancer located at the LoadBalancerTarget's IP address, port, and region. Use the following: - *regionalL4ilb*: for a regional internal passthrough Network Load Balancer. - *regionalL7ilb*: for a regional internal Application Load Balancer. - *globalL7ilb*: for a global internal Application Load Balancer. - "networkUrl": "A String", # The fully qualified URL of the network that the load balancer is attached to. This should be formatted like https://www.googleapis.com/compute/v1/projects/{project}/global/networks/{network} . + "networkUrl": "A String", # The fully qualified URL of the network that the load balancer is attached to. This should be formatted like `https://www.googleapis.com/compute/v1/projects/{project}/global/networks/{network}`. "port": "A String", # The configured port of the load balancer. "project": "A String", # The project ID in which the load balancer is located. "region": "A String", # The region in which the load balancer is located. }, ], }, - "trickleTraffic": 3.14, # When serving state is PRIMARY, this field provides the option of sending a small percentage of the traffic to the backup targets. + "trickleTraffic": 3.14, # When serving state is `PRIMARY`, this field provides the option of sending a small percentage of the traffic to the backup targets. }, "wrr": { # Configures a RRSetRoutingPolicy that routes in a weighted round robin fashion. "items": [ { # A routing block which contains the routing information for one WRR item. - "healthCheckedTargets": { # HealthCheckTargets describes endpoints to health-check when responding to Routing Policy queries. Only the healthy endpoints will be included in the response. Only one of internal_load_balancer and external_endpoints should be set. # Endpoints that are health checked before making the routing decision. The unhealthy endpoints are omitted from the result. If all endpoints within a bucket are unhealthy, we choose a different bucket (sampled with respect to its weight) for responding. If DNSSEC is enabled for this zone, only one of rrdata or health_checked_targets can be set. + "healthCheckedTargets": { # HealthCheckTargets describes endpoints to health-check when responding to Routing Policy queries. Only the healthy endpoints will be included in the response. # Endpoints that are health checked before making the routing decision. The unhealthy endpoints are omitted from the result. If all endpoints within a bucket are unhealthy, we choose a different bucket (sampled with respect to its weight) for responding. If DNSSEC is enabled for this zone, only one of `rrdata` or `health_checked_targets` can be set. "internalLoadBalancers": [ # Configuration for internal load balancers to be health checked. { # The configuration for an individual load balancer to health check. "ipAddress": "A String", # The frontend IP address of the load balancer to health check. "ipProtocol": "A String", # The protocol of the load balancer to health check. "kind": "dns#rRSetRoutingPolicyLoadBalancerTarget", "loadBalancerType": "A String", # The type of load balancer specified by this target. This value must match the configuration of the load balancer located at the LoadBalancerTarget's IP address, port, and region. Use the following: - *regionalL4ilb*: for a regional internal passthrough Network Load Balancer. - *regionalL7ilb*: for a regional internal Application Load Balancer. - *globalL7ilb*: for a global internal Application Load Balancer. - "networkUrl": "A String", # The fully qualified URL of the network that the load balancer is attached to. This should be formatted like https://www.googleapis.com/compute/v1/projects/{project}/global/networks/{network} . + "networkUrl": "A String", # The fully qualified URL of the network that the load balancer is attached to. This should be formatted like `https://www.googleapis.com/compute/v1/projects/{project}/global/networks/{network}`. "port": "A String", # The configured port of the load balancer. "project": "A String", # The project ID in which the load balancer is located. "region": "A String", # The region in which the load balancer is located. @@ -813,10 +810,10 @@

Method Details

"rrdatas": [ "A String", ], - "signatureRrdatas": [ # DNSSEC generated signatures for all the rrdata within this item. Note that if health checked targets are provided for DNSSEC enabled zones, there's a restriction of 1 IP address per item. + "signatureRrdatas": [ # DNSSEC generated signatures for all the `rrdata` within this item. Note that if health checked targets are provided for DNSSEC enabled zones, there's a restriction of 1 IP address per item. "A String", ], - "weight": 3.14, # The weight corresponding to this WrrPolicyItem object. When multiple WrrPolicyItem objects are configured, the probability of returning an WrrPolicyItem object's data is proportional to its weight relative to the sum of weights configured for all items. This weight must be non-negative. + "weight": 3.14, # The weight corresponding to this `WrrPolicyItem` object. When multiple `WrrPolicyItem` objects are configured, the probability of returning an `WrrPolicyItem` object's data is proportional to its weight relative to the sum of weights configured for all items. This weight must be non-negative. }, ], "kind": "dns#rRSetRoutingPolicyWrrPolicy", @@ -828,7 +825,7 @@

Method Details

"signatureRrdatas": [ # As defined in RFC 4034 (section 3.2). "A String", ], - "ttl": 42, # Number of seconds that this ResourceRecordSet can be cached by resolvers. + "ttl": 42, # Number of seconds that this `ResourceRecordSet` can be cached by resolvers. "type": "A String", # The identifier of a supported record type. See the list of Supported DNS record types. } @@ -844,19 +841,19 @@

Method Details

{ # A unit of data that is returned by the DNS servers. "kind": "dns#resourceRecordSet", "name": "A String", # For example, www.example.com. - "routingPolicy": { # A RRSetRoutingPolicy represents ResourceRecordSet data that is returned dynamically with the response varying based on configured properties such as geolocation or by weighted random selection. # Configures dynamic query responses based on either the geo location of the querying user or a weighted round robin based routing policy. A valid ResourceRecordSet contains only rrdata (for static resolution) or a routing_policy (for dynamic resolution). - "geo": { # Configures a RRSetRoutingPolicy that routes based on the geo location of the querying user. + "routingPolicy": { # A RRSetRoutingPolicy represents ResourceRecordSet data that is returned dynamically with the response varying based on configured properties such as geolocation or by weighted random selection. # Configures dynamic query responses based on either the geo location of the querying user or a weighted round robin based routing policy. A valid `ResourceRecordSet` contains only `rrdata` (for static resolution) or a `routing_policy` (for dynamic resolution). + "geo": { # Configures a `RRSetRoutingPolicy` that routes based on the geo location of the querying user. "enableFencing": True or False, # Without fencing, if health check fails for all configured items in the current geo bucket, we failover to the next nearest geo bucket. With fencing, if health checking is enabled, as long as some targets in the current geo bucket are healthy, we return only the healthy targets. However, if all targets are unhealthy, we don't failover to the next nearest bucket; instead, we return all the items in the current bucket even when all targets are unhealthy. "items": [ # The primary geo routing configuration. If there are multiple items with the same location, an error is returned instead. { # ResourceRecordSet data for one geo location. - "healthCheckedTargets": { # HealthCheckTargets describes endpoints to health-check when responding to Routing Policy queries. Only the healthy endpoints will be included in the response. Only one of internal_load_balancer and external_endpoints should be set. # For A and AAAA types only. Endpoints to return in the query result only if they are healthy. These can be specified along with rrdata within this item. + "healthCheckedTargets": { # HealthCheckTargets describes endpoints to health-check when responding to Routing Policy queries. Only the healthy endpoints will be included in the response. # For A and AAAA types only. Endpoints to return in the query result only if they are healthy. These can be specified along with `rrdata` within this item. "internalLoadBalancers": [ # Configuration for internal load balancers to be health checked. { # The configuration for an individual load balancer to health check. "ipAddress": "A String", # The frontend IP address of the load balancer to health check. "ipProtocol": "A String", # The protocol of the load balancer to health check. "kind": "dns#rRSetRoutingPolicyLoadBalancerTarget", "loadBalancerType": "A String", # The type of load balancer specified by this target. This value must match the configuration of the load balancer located at the LoadBalancerTarget's IP address, port, and region. Use the following: - *regionalL4ilb*: for a regional internal passthrough Network Load Balancer. - *regionalL7ilb*: for a regional internal Application Load Balancer. - *globalL7ilb*: for a global internal Application Load Balancer. - "networkUrl": "A String", # The fully qualified URL of the network that the load balancer is attached to. This should be formatted like https://www.googleapis.com/compute/v1/projects/{project}/global/networks/{network} . + "networkUrl": "A String", # The fully qualified URL of the network that the load balancer is attached to. This should be formatted like `https://www.googleapis.com/compute/v1/projects/{project}/global/networks/{network}`. "port": "A String", # The configured port of the load balancer. "project": "A String", # The project ID in which the load balancer is located. "region": "A String", # The region in which the load balancer is located. @@ -868,7 +865,7 @@

Method Details

"rrdatas": [ "A String", ], - "signatureRrdatas": [ # DNSSEC generated signatures for all the rrdata within this item. If health checked targets are provided for DNSSEC enabled zones, there's a restriction of 1 IP address per item. + "signatureRrdatas": [ # DNSSEC generated signatures for all the `rrdata` within this item. If health checked targets are provided for DNSSEC enabled zones, there's a restriction of 1 IP address per item. "A String", ], }, @@ -877,18 +874,18 @@

Method Details

}, "kind": "dns#rRSetRoutingPolicy", "primaryBackup": { # Configures a RRSetRoutingPolicy such that all queries are responded with the primary_targets if they are healthy. And if all of them are unhealthy, then we fallback to a geo localized policy. - "backupGeoTargets": { # Configures a RRSetRoutingPolicy that routes based on the geo location of the querying user. # Backup targets provide a regional failover policy for the otherwise global primary targets. If serving state is set to BACKUP, this policy essentially becomes a geo routing policy. + "backupGeoTargets": { # Configures a `RRSetRoutingPolicy` that routes based on the geo location of the querying user. # Backup targets provide a regional failover policy for the otherwise global primary targets. If serving state is set to `BACKUP`, this policy essentially becomes a geo routing policy. "enableFencing": True or False, # Without fencing, if health check fails for all configured items in the current geo bucket, we failover to the next nearest geo bucket. With fencing, if health checking is enabled, as long as some targets in the current geo bucket are healthy, we return only the healthy targets. However, if all targets are unhealthy, we don't failover to the next nearest bucket; instead, we return all the items in the current bucket even when all targets are unhealthy. "items": [ # The primary geo routing configuration. If there are multiple items with the same location, an error is returned instead. { # ResourceRecordSet data for one geo location. - "healthCheckedTargets": { # HealthCheckTargets describes endpoints to health-check when responding to Routing Policy queries. Only the healthy endpoints will be included in the response. Only one of internal_load_balancer and external_endpoints should be set. # For A and AAAA types only. Endpoints to return in the query result only if they are healthy. These can be specified along with rrdata within this item. + "healthCheckedTargets": { # HealthCheckTargets describes endpoints to health-check when responding to Routing Policy queries. Only the healthy endpoints will be included in the response. # For A and AAAA types only. Endpoints to return in the query result only if they are healthy. These can be specified along with `rrdata` within this item. "internalLoadBalancers": [ # Configuration for internal load balancers to be health checked. { # The configuration for an individual load balancer to health check. "ipAddress": "A String", # The frontend IP address of the load balancer to health check. "ipProtocol": "A String", # The protocol of the load balancer to health check. "kind": "dns#rRSetRoutingPolicyLoadBalancerTarget", "loadBalancerType": "A String", # The type of load balancer specified by this target. This value must match the configuration of the load balancer located at the LoadBalancerTarget's IP address, port, and region. Use the following: - *regionalL4ilb*: for a regional internal passthrough Network Load Balancer. - *regionalL7ilb*: for a regional internal Application Load Balancer. - *globalL7ilb*: for a global internal Application Load Balancer. - "networkUrl": "A String", # The fully qualified URL of the network that the load balancer is attached to. This should be formatted like https://www.googleapis.com/compute/v1/projects/{project}/global/networks/{network} . + "networkUrl": "A String", # The fully qualified URL of the network that the load balancer is attached to. This should be formatted like `https://www.googleapis.com/compute/v1/projects/{project}/global/networks/{network}`. "port": "A String", # The configured port of the load balancer. "project": "A String", # The project ID in which the load balancer is located. "region": "A String", # The region in which the load balancer is located. @@ -900,7 +897,7 @@

Method Details

"rrdatas": [ "A String", ], - "signatureRrdatas": [ # DNSSEC generated signatures for all the rrdata within this item. If health checked targets are provided for DNSSEC enabled zones, there's a restriction of 1 IP address per item. + "signatureRrdatas": [ # DNSSEC generated signatures for all the `rrdata` within this item. If health checked targets are provided for DNSSEC enabled zones, there's a restriction of 1 IP address per item. "A String", ], }, @@ -908,33 +905,33 @@

Method Details

"kind": "dns#rRSetRoutingPolicyGeoPolicy", }, "kind": "dns#rRSetRoutingPolicyPrimaryBackupPolicy", - "primaryTargets": { # HealthCheckTargets describes endpoints to health-check when responding to Routing Policy queries. Only the healthy endpoints will be included in the response. Only one of internal_load_balancer and external_endpoints should be set. # Endpoints that are health checked before making the routing decision. Unhealthy endpoints are omitted from the results. If all endpoints are unhealthy, we serve a response based on the backup_geo_targets. + "primaryTargets": { # HealthCheckTargets describes endpoints to health-check when responding to Routing Policy queries. Only the healthy endpoints will be included in the response. # Endpoints that are health checked before making the routing decision. Unhealthy endpoints are omitted from the results. If all endpoints are unhealthy, we serve a response based on the `backup_geo_targets`. "internalLoadBalancers": [ # Configuration for internal load balancers to be health checked. { # The configuration for an individual load balancer to health check. "ipAddress": "A String", # The frontend IP address of the load balancer to health check. "ipProtocol": "A String", # The protocol of the load balancer to health check. "kind": "dns#rRSetRoutingPolicyLoadBalancerTarget", "loadBalancerType": "A String", # The type of load balancer specified by this target. This value must match the configuration of the load balancer located at the LoadBalancerTarget's IP address, port, and region. Use the following: - *regionalL4ilb*: for a regional internal passthrough Network Load Balancer. - *regionalL7ilb*: for a regional internal Application Load Balancer. - *globalL7ilb*: for a global internal Application Load Balancer. - "networkUrl": "A String", # The fully qualified URL of the network that the load balancer is attached to. This should be formatted like https://www.googleapis.com/compute/v1/projects/{project}/global/networks/{network} . + "networkUrl": "A String", # The fully qualified URL of the network that the load balancer is attached to. This should be formatted like `https://www.googleapis.com/compute/v1/projects/{project}/global/networks/{network}`. "port": "A String", # The configured port of the load balancer. "project": "A String", # The project ID in which the load balancer is located. "region": "A String", # The region in which the load balancer is located. }, ], }, - "trickleTraffic": 3.14, # When serving state is PRIMARY, this field provides the option of sending a small percentage of the traffic to the backup targets. + "trickleTraffic": 3.14, # When serving state is `PRIMARY`, this field provides the option of sending a small percentage of the traffic to the backup targets. }, "wrr": { # Configures a RRSetRoutingPolicy that routes in a weighted round robin fashion. "items": [ { # A routing block which contains the routing information for one WRR item. - "healthCheckedTargets": { # HealthCheckTargets describes endpoints to health-check when responding to Routing Policy queries. Only the healthy endpoints will be included in the response. Only one of internal_load_balancer and external_endpoints should be set. # Endpoints that are health checked before making the routing decision. The unhealthy endpoints are omitted from the result. If all endpoints within a bucket are unhealthy, we choose a different bucket (sampled with respect to its weight) for responding. If DNSSEC is enabled for this zone, only one of rrdata or health_checked_targets can be set. + "healthCheckedTargets": { # HealthCheckTargets describes endpoints to health-check when responding to Routing Policy queries. Only the healthy endpoints will be included in the response. # Endpoints that are health checked before making the routing decision. The unhealthy endpoints are omitted from the result. If all endpoints within a bucket are unhealthy, we choose a different bucket (sampled with respect to its weight) for responding. If DNSSEC is enabled for this zone, only one of `rrdata` or `health_checked_targets` can be set. "internalLoadBalancers": [ # Configuration for internal load balancers to be health checked. { # The configuration for an individual load balancer to health check. "ipAddress": "A String", # The frontend IP address of the load balancer to health check. "ipProtocol": "A String", # The protocol of the load balancer to health check. "kind": "dns#rRSetRoutingPolicyLoadBalancerTarget", "loadBalancerType": "A String", # The type of load balancer specified by this target. This value must match the configuration of the load balancer located at the LoadBalancerTarget's IP address, port, and region. Use the following: - *regionalL4ilb*: for a regional internal passthrough Network Load Balancer. - *regionalL7ilb*: for a regional internal Application Load Balancer. - *globalL7ilb*: for a global internal Application Load Balancer. - "networkUrl": "A String", # The fully qualified URL of the network that the load balancer is attached to. This should be formatted like https://www.googleapis.com/compute/v1/projects/{project}/global/networks/{network} . + "networkUrl": "A String", # The fully qualified URL of the network that the load balancer is attached to. This should be formatted like `https://www.googleapis.com/compute/v1/projects/{project}/global/networks/{network}`. "port": "A String", # The configured port of the load balancer. "project": "A String", # The project ID in which the load balancer is located. "region": "A String", # The region in which the load balancer is located. @@ -945,10 +942,10 @@

Method Details

"rrdatas": [ "A String", ], - "signatureRrdatas": [ # DNSSEC generated signatures for all the rrdata within this item. Note that if health checked targets are provided for DNSSEC enabled zones, there's a restriction of 1 IP address per item. + "signatureRrdatas": [ # DNSSEC generated signatures for all the `rrdata` within this item. Note that if health checked targets are provided for DNSSEC enabled zones, there's a restriction of 1 IP address per item. "A String", ], - "weight": 3.14, # The weight corresponding to this WrrPolicyItem object. When multiple WrrPolicyItem objects are configured, the probability of returning an WrrPolicyItem object's data is proportional to its weight relative to the sum of weights configured for all items. This weight must be non-negative. + "weight": 3.14, # The weight corresponding to this `WrrPolicyItem` object. When multiple `WrrPolicyItem` objects are configured, the probability of returning an `WrrPolicyItem` object's data is proportional to its weight relative to the sum of weights configured for all items. This weight must be non-negative. }, ], "kind": "dns#rRSetRoutingPolicyWrrPolicy", @@ -960,7 +957,7 @@

Method Details

"signatureRrdatas": [ # As defined in RFC 4034 (section 3.2). "A String", ], - "ttl": 42, # Number of seconds that this ResourceRecordSet can be cached by resolvers. + "ttl": 42, # Number of seconds that this `ResourceRecordSet` can be cached by resolvers. "type": "A String", # The identifier of a supported record type. See the list of Supported DNS record types. } diff --git a/docs/dyn/dns_v1.responsePolicies.html b/docs/dyn/dns_v1.responsePolicies.html index 5c77e6f7c98..1571c19b441 100644 --- a/docs/dyn/dns_v1.responsePolicies.html +++ b/docs/dyn/dns_v1.responsePolicies.html @@ -129,7 +129,7 @@

Method Details

"networks": [ # List of network names specifying networks to which this policy is applied. { "kind": "dns#responsePolicyNetwork", - "networkUrl": "A String", # The fully qualified URL of the VPC network to bind to. This should be formatted like https://www.googleapis.com/compute/v1/projects/{project}/global/networks/{network} + "networkUrl": "A String", # The fully qualified URL of the VPC network to bind to. This should be formatted like `https://www.googleapis.com/compute/v1/projects/{project}/global/networks/{network}` }, ], "responsePolicyName": "A String", # User assigned name for this Response Policy. @@ -160,7 +160,7 @@

Method Details

"networks": [ # List of network names specifying networks to which this policy is applied. { "kind": "dns#responsePolicyNetwork", - "networkUrl": "A String", # The fully qualified URL of the VPC network to bind to. This should be formatted like https://www.googleapis.com/compute/v1/projects/{project}/global/networks/{network} + "networkUrl": "A String", # The fully qualified URL of the VPC network to bind to. This should be formatted like `https://www.googleapis.com/compute/v1/projects/{project}/global/networks/{network}` }, ], "responsePolicyName": "A String", # User assigned name for this Response Policy. @@ -214,7 +214,7 @@

Method Details

"networks": [ # List of network names specifying networks to which this policy is applied. { "kind": "dns#responsePolicyNetwork", - "networkUrl": "A String", # The fully qualified URL of the VPC network to bind to. This should be formatted like https://www.googleapis.com/compute/v1/projects/{project}/global/networks/{network} + "networkUrl": "A String", # The fully qualified URL of the VPC network to bind to. This should be formatted like `https://www.googleapis.com/compute/v1/projects/{project}/global/networks/{network}` }, ], "responsePolicyName": "A String", # User assigned name for this Response Policy. @@ -238,10 +238,7 @@

Method Details

An object of the form: { - "header": { # Elements common to every response. - "operationId": "A String", # For mutating operation requests that completed successfully. This is the client_operation_id if the client specified it, otherwise it is generated by the server (output only). - }, - "nextPageToken": "A String", # The presence of this field indicates that more results exist following your last page of results in pagination order. To fetch them, make another list request by using this value as your page token. This lets you view the complete contents of even very large collections one page at a time. However, if the contents of the collection change between the first and last paginated list request, the set of all elements returned are an inconsistent view of the collection. You cannot retrieve a consistent snapshot of a collection larger than the maximum page size. + "nextPageToken": "A String", # This field indicates that more results are available beyond the last page displayed. To fetch the results, make another list request and use this value as your page token. This lets you retrieve the complete contents of a very large collection one page at a time. However, if the contents of the collection change between the first and last paginated list request, the set of all elements returned are an inconsistent view of the collection. You can't retrieve a consistent snapshot of a collection larger than the maximum page size. "responsePolicies": [ # The Response Policy resources. { # A Response Policy is a collection of selectors that apply to queries made against one or more Virtual Private Cloud networks. "description": "A String", # User-provided description for this Response Policy. @@ -259,7 +256,7 @@

Method Details

"networks": [ # List of network names specifying networks to which this policy is applied. { "kind": "dns#responsePolicyNetwork", - "networkUrl": "A String", # The fully qualified URL of the VPC network to bind to. This should be formatted like https://www.googleapis.com/compute/v1/projects/{project}/global/networks/{network} + "networkUrl": "A String", # The fully qualified URL of the VPC network to bind to. This should be formatted like `https://www.googleapis.com/compute/v1/projects/{project}/global/networks/{network}` }, ], "responsePolicyName": "A String", # User assigned name for this Response Policy. @@ -308,7 +305,7 @@

Method Details

"networks": [ # List of network names specifying networks to which this policy is applied. { "kind": "dns#responsePolicyNetwork", - "networkUrl": "A String", # The fully qualified URL of the VPC network to bind to. This should be formatted like https://www.googleapis.com/compute/v1/projects/{project}/global/networks/{network} + "networkUrl": "A String", # The fully qualified URL of the VPC network to bind to. This should be formatted like `https://www.googleapis.com/compute/v1/projects/{project}/global/networks/{network}` }, ], "responsePolicyName": "A String", # User assigned name for this Response Policy. @@ -324,9 +321,6 @@

Method Details

An object of the form: { - "header": { # Elements common to every response. - "operationId": "A String", # For mutating operation requests that completed successfully. This is the client_operation_id if the client specified it, otherwise it is generated by the server (output only). - }, "responsePolicy": { # A Response Policy is a collection of selectors that apply to queries made against one or more Virtual Private Cloud networks. "description": "A String", # User-provided description for this Response Policy. "gkeClusters": [ # The list of Google Kubernetes Engine clusters to which this response policy is applied. @@ -343,7 +337,7 @@

Method Details

"networks": [ # List of network names specifying networks to which this policy is applied. { "kind": "dns#responsePolicyNetwork", - "networkUrl": "A String", # The fully qualified URL of the VPC network to bind to. This should be formatted like https://www.googleapis.com/compute/v1/projects/{project}/global/networks/{network} + "networkUrl": "A String", # The fully qualified URL of the VPC network to bind to. This should be formatted like `https://www.googleapis.com/compute/v1/projects/{project}/global/networks/{network}` }, ], "responsePolicyName": "A String", # User assigned name for this Response Policy. @@ -377,7 +371,7 @@

Method Details

"networks": [ # List of network names specifying networks to which this policy is applied. { "kind": "dns#responsePolicyNetwork", - "networkUrl": "A String", # The fully qualified URL of the VPC network to bind to. This should be formatted like https://www.googleapis.com/compute/v1/projects/{project}/global/networks/{network} + "networkUrl": "A String", # The fully qualified URL of the VPC network to bind to. This should be formatted like `https://www.googleapis.com/compute/v1/projects/{project}/global/networks/{network}` }, ], "responsePolicyName": "A String", # User assigned name for this Response Policy. @@ -393,9 +387,6 @@

Method Details

An object of the form: { - "header": { # Elements common to every response. - "operationId": "A String", # For mutating operation requests that completed successfully. This is the client_operation_id if the client specified it, otherwise it is generated by the server (output only). - }, "responsePolicy": { # A Response Policy is a collection of selectors that apply to queries made against one or more Virtual Private Cloud networks. "description": "A String", # User-provided description for this Response Policy. "gkeClusters": [ # The list of Google Kubernetes Engine clusters to which this response policy is applied. @@ -412,7 +403,7 @@

Method Details

"networks": [ # List of network names specifying networks to which this policy is applied. { "kind": "dns#responsePolicyNetwork", - "networkUrl": "A String", # The fully qualified URL of the VPC network to bind to. This should be formatted like https://www.googleapis.com/compute/v1/projects/{project}/global/networks/{network} + "networkUrl": "A String", # The fully qualified URL of the VPC network to bind to. This should be formatted like `https://www.googleapis.com/compute/v1/projects/{project}/global/networks/{network}` }, ], "responsePolicyName": "A String", # User assigned name for this Response Policy. diff --git a/docs/dyn/dns_v1.responsePolicyRules.html b/docs/dyn/dns_v1.responsePolicyRules.html index 6f7c3cf263b..8e08db0f5a9 100644 --- a/docs/dyn/dns_v1.responsePolicyRules.html +++ b/docs/dyn/dns_v1.responsePolicyRules.html @@ -123,19 +123,19 @@

Method Details

{ # A unit of data that is returned by the DNS servers. "kind": "dns#resourceRecordSet", "name": "A String", # For example, www.example.com. - "routingPolicy": { # A RRSetRoutingPolicy represents ResourceRecordSet data that is returned dynamically with the response varying based on configured properties such as geolocation or by weighted random selection. # Configures dynamic query responses based on either the geo location of the querying user or a weighted round robin based routing policy. A valid ResourceRecordSet contains only rrdata (for static resolution) or a routing_policy (for dynamic resolution). - "geo": { # Configures a RRSetRoutingPolicy that routes based on the geo location of the querying user. + "routingPolicy": { # A RRSetRoutingPolicy represents ResourceRecordSet data that is returned dynamically with the response varying based on configured properties such as geolocation or by weighted random selection. # Configures dynamic query responses based on either the geo location of the querying user or a weighted round robin based routing policy. A valid `ResourceRecordSet` contains only `rrdata` (for static resolution) or a `routing_policy` (for dynamic resolution). + "geo": { # Configures a `RRSetRoutingPolicy` that routes based on the geo location of the querying user. "enableFencing": True or False, # Without fencing, if health check fails for all configured items in the current geo bucket, we failover to the next nearest geo bucket. With fencing, if health checking is enabled, as long as some targets in the current geo bucket are healthy, we return only the healthy targets. However, if all targets are unhealthy, we don't failover to the next nearest bucket; instead, we return all the items in the current bucket even when all targets are unhealthy. "items": [ # The primary geo routing configuration. If there are multiple items with the same location, an error is returned instead. { # ResourceRecordSet data for one geo location. - "healthCheckedTargets": { # HealthCheckTargets describes endpoints to health-check when responding to Routing Policy queries. Only the healthy endpoints will be included in the response. Only one of internal_load_balancer and external_endpoints should be set. # For A and AAAA types only. Endpoints to return in the query result only if they are healthy. These can be specified along with rrdata within this item. + "healthCheckedTargets": { # HealthCheckTargets describes endpoints to health-check when responding to Routing Policy queries. Only the healthy endpoints will be included in the response. # For A and AAAA types only. Endpoints to return in the query result only if they are healthy. These can be specified along with `rrdata` within this item. "internalLoadBalancers": [ # Configuration for internal load balancers to be health checked. { # The configuration for an individual load balancer to health check. "ipAddress": "A String", # The frontend IP address of the load balancer to health check. "ipProtocol": "A String", # The protocol of the load balancer to health check. "kind": "dns#rRSetRoutingPolicyLoadBalancerTarget", "loadBalancerType": "A String", # The type of load balancer specified by this target. This value must match the configuration of the load balancer located at the LoadBalancerTarget's IP address, port, and region. Use the following: - *regionalL4ilb*: for a regional internal passthrough Network Load Balancer. - *regionalL7ilb*: for a regional internal Application Load Balancer. - *globalL7ilb*: for a global internal Application Load Balancer. - "networkUrl": "A String", # The fully qualified URL of the network that the load balancer is attached to. This should be formatted like https://www.googleapis.com/compute/v1/projects/{project}/global/networks/{network} . + "networkUrl": "A String", # The fully qualified URL of the network that the load balancer is attached to. This should be formatted like `https://www.googleapis.com/compute/v1/projects/{project}/global/networks/{network}`. "port": "A String", # The configured port of the load balancer. "project": "A String", # The project ID in which the load balancer is located. "region": "A String", # The region in which the load balancer is located. @@ -147,7 +147,7 @@

Method Details

"rrdatas": [ "A String", ], - "signatureRrdatas": [ # DNSSEC generated signatures for all the rrdata within this item. If health checked targets are provided for DNSSEC enabled zones, there's a restriction of 1 IP address per item. + "signatureRrdatas": [ # DNSSEC generated signatures for all the `rrdata` within this item. If health checked targets are provided for DNSSEC enabled zones, there's a restriction of 1 IP address per item. "A String", ], }, @@ -156,18 +156,18 @@

Method Details

}, "kind": "dns#rRSetRoutingPolicy", "primaryBackup": { # Configures a RRSetRoutingPolicy such that all queries are responded with the primary_targets if they are healthy. And if all of them are unhealthy, then we fallback to a geo localized policy. - "backupGeoTargets": { # Configures a RRSetRoutingPolicy that routes based on the geo location of the querying user. # Backup targets provide a regional failover policy for the otherwise global primary targets. If serving state is set to BACKUP, this policy essentially becomes a geo routing policy. + "backupGeoTargets": { # Configures a `RRSetRoutingPolicy` that routes based on the geo location of the querying user. # Backup targets provide a regional failover policy for the otherwise global primary targets. If serving state is set to `BACKUP`, this policy essentially becomes a geo routing policy. "enableFencing": True or False, # Without fencing, if health check fails for all configured items in the current geo bucket, we failover to the next nearest geo bucket. With fencing, if health checking is enabled, as long as some targets in the current geo bucket are healthy, we return only the healthy targets. However, if all targets are unhealthy, we don't failover to the next nearest bucket; instead, we return all the items in the current bucket even when all targets are unhealthy. "items": [ # The primary geo routing configuration. If there are multiple items with the same location, an error is returned instead. { # ResourceRecordSet data for one geo location. - "healthCheckedTargets": { # HealthCheckTargets describes endpoints to health-check when responding to Routing Policy queries. Only the healthy endpoints will be included in the response. Only one of internal_load_balancer and external_endpoints should be set. # For A and AAAA types only. Endpoints to return in the query result only if they are healthy. These can be specified along with rrdata within this item. + "healthCheckedTargets": { # HealthCheckTargets describes endpoints to health-check when responding to Routing Policy queries. Only the healthy endpoints will be included in the response. # For A and AAAA types only. Endpoints to return in the query result only if they are healthy. These can be specified along with `rrdata` within this item. "internalLoadBalancers": [ # Configuration for internal load balancers to be health checked. { # The configuration for an individual load balancer to health check. "ipAddress": "A String", # The frontend IP address of the load balancer to health check. "ipProtocol": "A String", # The protocol of the load balancer to health check. "kind": "dns#rRSetRoutingPolicyLoadBalancerTarget", "loadBalancerType": "A String", # The type of load balancer specified by this target. This value must match the configuration of the load balancer located at the LoadBalancerTarget's IP address, port, and region. Use the following: - *regionalL4ilb*: for a regional internal passthrough Network Load Balancer. - *regionalL7ilb*: for a regional internal Application Load Balancer. - *globalL7ilb*: for a global internal Application Load Balancer. - "networkUrl": "A String", # The fully qualified URL of the network that the load balancer is attached to. This should be formatted like https://www.googleapis.com/compute/v1/projects/{project}/global/networks/{network} . + "networkUrl": "A String", # The fully qualified URL of the network that the load balancer is attached to. This should be formatted like `https://www.googleapis.com/compute/v1/projects/{project}/global/networks/{network}`. "port": "A String", # The configured port of the load balancer. "project": "A String", # The project ID in which the load balancer is located. "region": "A String", # The region in which the load balancer is located. @@ -179,7 +179,7 @@

Method Details

"rrdatas": [ "A String", ], - "signatureRrdatas": [ # DNSSEC generated signatures for all the rrdata within this item. If health checked targets are provided for DNSSEC enabled zones, there's a restriction of 1 IP address per item. + "signatureRrdatas": [ # DNSSEC generated signatures for all the `rrdata` within this item. If health checked targets are provided for DNSSEC enabled zones, there's a restriction of 1 IP address per item. "A String", ], }, @@ -187,33 +187,33 @@

Method Details

"kind": "dns#rRSetRoutingPolicyGeoPolicy", }, "kind": "dns#rRSetRoutingPolicyPrimaryBackupPolicy", - "primaryTargets": { # HealthCheckTargets describes endpoints to health-check when responding to Routing Policy queries. Only the healthy endpoints will be included in the response. Only one of internal_load_balancer and external_endpoints should be set. # Endpoints that are health checked before making the routing decision. Unhealthy endpoints are omitted from the results. If all endpoints are unhealthy, we serve a response based on the backup_geo_targets. + "primaryTargets": { # HealthCheckTargets describes endpoints to health-check when responding to Routing Policy queries. Only the healthy endpoints will be included in the response. # Endpoints that are health checked before making the routing decision. Unhealthy endpoints are omitted from the results. If all endpoints are unhealthy, we serve a response based on the `backup_geo_targets`. "internalLoadBalancers": [ # Configuration for internal load balancers to be health checked. { # The configuration for an individual load balancer to health check. "ipAddress": "A String", # The frontend IP address of the load balancer to health check. "ipProtocol": "A String", # The protocol of the load balancer to health check. "kind": "dns#rRSetRoutingPolicyLoadBalancerTarget", "loadBalancerType": "A String", # The type of load balancer specified by this target. This value must match the configuration of the load balancer located at the LoadBalancerTarget's IP address, port, and region. Use the following: - *regionalL4ilb*: for a regional internal passthrough Network Load Balancer. - *regionalL7ilb*: for a regional internal Application Load Balancer. - *globalL7ilb*: for a global internal Application Load Balancer. - "networkUrl": "A String", # The fully qualified URL of the network that the load balancer is attached to. This should be formatted like https://www.googleapis.com/compute/v1/projects/{project}/global/networks/{network} . + "networkUrl": "A String", # The fully qualified URL of the network that the load balancer is attached to. This should be formatted like `https://www.googleapis.com/compute/v1/projects/{project}/global/networks/{network}`. "port": "A String", # The configured port of the load balancer. "project": "A String", # The project ID in which the load balancer is located. "region": "A String", # The region in which the load balancer is located. }, ], }, - "trickleTraffic": 3.14, # When serving state is PRIMARY, this field provides the option of sending a small percentage of the traffic to the backup targets. + "trickleTraffic": 3.14, # When serving state is `PRIMARY`, this field provides the option of sending a small percentage of the traffic to the backup targets. }, "wrr": { # Configures a RRSetRoutingPolicy that routes in a weighted round robin fashion. "items": [ { # A routing block which contains the routing information for one WRR item. - "healthCheckedTargets": { # HealthCheckTargets describes endpoints to health-check when responding to Routing Policy queries. Only the healthy endpoints will be included in the response. Only one of internal_load_balancer and external_endpoints should be set. # Endpoints that are health checked before making the routing decision. The unhealthy endpoints are omitted from the result. If all endpoints within a bucket are unhealthy, we choose a different bucket (sampled with respect to its weight) for responding. If DNSSEC is enabled for this zone, only one of rrdata or health_checked_targets can be set. + "healthCheckedTargets": { # HealthCheckTargets describes endpoints to health-check when responding to Routing Policy queries. Only the healthy endpoints will be included in the response. # Endpoints that are health checked before making the routing decision. The unhealthy endpoints are omitted from the result. If all endpoints within a bucket are unhealthy, we choose a different bucket (sampled with respect to its weight) for responding. If DNSSEC is enabled for this zone, only one of `rrdata` or `health_checked_targets` can be set. "internalLoadBalancers": [ # Configuration for internal load balancers to be health checked. { # The configuration for an individual load balancer to health check. "ipAddress": "A String", # The frontend IP address of the load balancer to health check. "ipProtocol": "A String", # The protocol of the load balancer to health check. "kind": "dns#rRSetRoutingPolicyLoadBalancerTarget", "loadBalancerType": "A String", # The type of load balancer specified by this target. This value must match the configuration of the load balancer located at the LoadBalancerTarget's IP address, port, and region. Use the following: - *regionalL4ilb*: for a regional internal passthrough Network Load Balancer. - *regionalL7ilb*: for a regional internal Application Load Balancer. - *globalL7ilb*: for a global internal Application Load Balancer. - "networkUrl": "A String", # The fully qualified URL of the network that the load balancer is attached to. This should be formatted like https://www.googleapis.com/compute/v1/projects/{project}/global/networks/{network} . + "networkUrl": "A String", # The fully qualified URL of the network that the load balancer is attached to. This should be formatted like `https://www.googleapis.com/compute/v1/projects/{project}/global/networks/{network}`. "port": "A String", # The configured port of the load balancer. "project": "A String", # The project ID in which the load balancer is located. "region": "A String", # The region in which the load balancer is located. @@ -224,10 +224,10 @@

Method Details

"rrdatas": [ "A String", ], - "signatureRrdatas": [ # DNSSEC generated signatures for all the rrdata within this item. Note that if health checked targets are provided for DNSSEC enabled zones, there's a restriction of 1 IP address per item. + "signatureRrdatas": [ # DNSSEC generated signatures for all the `rrdata` within this item. Note that if health checked targets are provided for DNSSEC enabled zones, there's a restriction of 1 IP address per item. "A String", ], - "weight": 3.14, # The weight corresponding to this WrrPolicyItem object. When multiple WrrPolicyItem objects are configured, the probability of returning an WrrPolicyItem object's data is proportional to its weight relative to the sum of weights configured for all items. This weight must be non-negative. + "weight": 3.14, # The weight corresponding to this `WrrPolicyItem` object. When multiple `WrrPolicyItem` objects are configured, the probability of returning an `WrrPolicyItem` object's data is proportional to its weight relative to the sum of weights configured for all items. This weight must be non-negative. }, ], "kind": "dns#rRSetRoutingPolicyWrrPolicy", @@ -239,7 +239,7 @@

Method Details

"signatureRrdatas": [ # As defined in RFC 4034 (section 3.2). "A String", ], - "ttl": 42, # Number of seconds that this ResourceRecordSet can be cached by resolvers. + "ttl": 42, # Number of seconds that this `ResourceRecordSet` can be cached by resolvers. "type": "A String", # The identifier of a supported record type. See the list of Supported DNS record types. }, ], @@ -265,19 +265,19 @@

Method Details

{ # A unit of data that is returned by the DNS servers. "kind": "dns#resourceRecordSet", "name": "A String", # For example, www.example.com. - "routingPolicy": { # A RRSetRoutingPolicy represents ResourceRecordSet data that is returned dynamically with the response varying based on configured properties such as geolocation or by weighted random selection. # Configures dynamic query responses based on either the geo location of the querying user or a weighted round robin based routing policy. A valid ResourceRecordSet contains only rrdata (for static resolution) or a routing_policy (for dynamic resolution). - "geo": { # Configures a RRSetRoutingPolicy that routes based on the geo location of the querying user. + "routingPolicy": { # A RRSetRoutingPolicy represents ResourceRecordSet data that is returned dynamically with the response varying based on configured properties such as geolocation or by weighted random selection. # Configures dynamic query responses based on either the geo location of the querying user or a weighted round robin based routing policy. A valid `ResourceRecordSet` contains only `rrdata` (for static resolution) or a `routing_policy` (for dynamic resolution). + "geo": { # Configures a `RRSetRoutingPolicy` that routes based on the geo location of the querying user. "enableFencing": True or False, # Without fencing, if health check fails for all configured items in the current geo bucket, we failover to the next nearest geo bucket. With fencing, if health checking is enabled, as long as some targets in the current geo bucket are healthy, we return only the healthy targets. However, if all targets are unhealthy, we don't failover to the next nearest bucket; instead, we return all the items in the current bucket even when all targets are unhealthy. "items": [ # The primary geo routing configuration. If there are multiple items with the same location, an error is returned instead. { # ResourceRecordSet data for one geo location. - "healthCheckedTargets": { # HealthCheckTargets describes endpoints to health-check when responding to Routing Policy queries. Only the healthy endpoints will be included in the response. Only one of internal_load_balancer and external_endpoints should be set. # For A and AAAA types only. Endpoints to return in the query result only if they are healthy. These can be specified along with rrdata within this item. + "healthCheckedTargets": { # HealthCheckTargets describes endpoints to health-check when responding to Routing Policy queries. Only the healthy endpoints will be included in the response. # For A and AAAA types only. Endpoints to return in the query result only if they are healthy. These can be specified along with `rrdata` within this item. "internalLoadBalancers": [ # Configuration for internal load balancers to be health checked. { # The configuration for an individual load balancer to health check. "ipAddress": "A String", # The frontend IP address of the load balancer to health check. "ipProtocol": "A String", # The protocol of the load balancer to health check. "kind": "dns#rRSetRoutingPolicyLoadBalancerTarget", "loadBalancerType": "A String", # The type of load balancer specified by this target. This value must match the configuration of the load balancer located at the LoadBalancerTarget's IP address, port, and region. Use the following: - *regionalL4ilb*: for a regional internal passthrough Network Load Balancer. - *regionalL7ilb*: for a regional internal Application Load Balancer. - *globalL7ilb*: for a global internal Application Load Balancer. - "networkUrl": "A String", # The fully qualified URL of the network that the load balancer is attached to. This should be formatted like https://www.googleapis.com/compute/v1/projects/{project}/global/networks/{network} . + "networkUrl": "A String", # The fully qualified URL of the network that the load balancer is attached to. This should be formatted like `https://www.googleapis.com/compute/v1/projects/{project}/global/networks/{network}`. "port": "A String", # The configured port of the load balancer. "project": "A String", # The project ID in which the load balancer is located. "region": "A String", # The region in which the load balancer is located. @@ -289,7 +289,7 @@

Method Details

"rrdatas": [ "A String", ], - "signatureRrdatas": [ # DNSSEC generated signatures for all the rrdata within this item. If health checked targets are provided for DNSSEC enabled zones, there's a restriction of 1 IP address per item. + "signatureRrdatas": [ # DNSSEC generated signatures for all the `rrdata` within this item. If health checked targets are provided for DNSSEC enabled zones, there's a restriction of 1 IP address per item. "A String", ], }, @@ -298,18 +298,18 @@

Method Details

}, "kind": "dns#rRSetRoutingPolicy", "primaryBackup": { # Configures a RRSetRoutingPolicy such that all queries are responded with the primary_targets if they are healthy. And if all of them are unhealthy, then we fallback to a geo localized policy. - "backupGeoTargets": { # Configures a RRSetRoutingPolicy that routes based on the geo location of the querying user. # Backup targets provide a regional failover policy for the otherwise global primary targets. If serving state is set to BACKUP, this policy essentially becomes a geo routing policy. + "backupGeoTargets": { # Configures a `RRSetRoutingPolicy` that routes based on the geo location of the querying user. # Backup targets provide a regional failover policy for the otherwise global primary targets. If serving state is set to `BACKUP`, this policy essentially becomes a geo routing policy. "enableFencing": True or False, # Without fencing, if health check fails for all configured items in the current geo bucket, we failover to the next nearest geo bucket. With fencing, if health checking is enabled, as long as some targets in the current geo bucket are healthy, we return only the healthy targets. However, if all targets are unhealthy, we don't failover to the next nearest bucket; instead, we return all the items in the current bucket even when all targets are unhealthy. "items": [ # The primary geo routing configuration. If there are multiple items with the same location, an error is returned instead. { # ResourceRecordSet data for one geo location. - "healthCheckedTargets": { # HealthCheckTargets describes endpoints to health-check when responding to Routing Policy queries. Only the healthy endpoints will be included in the response. Only one of internal_load_balancer and external_endpoints should be set. # For A and AAAA types only. Endpoints to return in the query result only if they are healthy. These can be specified along with rrdata within this item. + "healthCheckedTargets": { # HealthCheckTargets describes endpoints to health-check when responding to Routing Policy queries. Only the healthy endpoints will be included in the response. # For A and AAAA types only. Endpoints to return in the query result only if they are healthy. These can be specified along with `rrdata` within this item. "internalLoadBalancers": [ # Configuration for internal load balancers to be health checked. { # The configuration for an individual load balancer to health check. "ipAddress": "A String", # The frontend IP address of the load balancer to health check. "ipProtocol": "A String", # The protocol of the load balancer to health check. "kind": "dns#rRSetRoutingPolicyLoadBalancerTarget", "loadBalancerType": "A String", # The type of load balancer specified by this target. This value must match the configuration of the load balancer located at the LoadBalancerTarget's IP address, port, and region. Use the following: - *regionalL4ilb*: for a regional internal passthrough Network Load Balancer. - *regionalL7ilb*: for a regional internal Application Load Balancer. - *globalL7ilb*: for a global internal Application Load Balancer. - "networkUrl": "A String", # The fully qualified URL of the network that the load balancer is attached to. This should be formatted like https://www.googleapis.com/compute/v1/projects/{project}/global/networks/{network} . + "networkUrl": "A String", # The fully qualified URL of the network that the load balancer is attached to. This should be formatted like `https://www.googleapis.com/compute/v1/projects/{project}/global/networks/{network}`. "port": "A String", # The configured port of the load balancer. "project": "A String", # The project ID in which the load balancer is located. "region": "A String", # The region in which the load balancer is located. @@ -321,7 +321,7 @@

Method Details

"rrdatas": [ "A String", ], - "signatureRrdatas": [ # DNSSEC generated signatures for all the rrdata within this item. If health checked targets are provided for DNSSEC enabled zones, there's a restriction of 1 IP address per item. + "signatureRrdatas": [ # DNSSEC generated signatures for all the `rrdata` within this item. If health checked targets are provided for DNSSEC enabled zones, there's a restriction of 1 IP address per item. "A String", ], }, @@ -329,33 +329,33 @@

Method Details

"kind": "dns#rRSetRoutingPolicyGeoPolicy", }, "kind": "dns#rRSetRoutingPolicyPrimaryBackupPolicy", - "primaryTargets": { # HealthCheckTargets describes endpoints to health-check when responding to Routing Policy queries. Only the healthy endpoints will be included in the response. Only one of internal_load_balancer and external_endpoints should be set. # Endpoints that are health checked before making the routing decision. Unhealthy endpoints are omitted from the results. If all endpoints are unhealthy, we serve a response based on the backup_geo_targets. + "primaryTargets": { # HealthCheckTargets describes endpoints to health-check when responding to Routing Policy queries. Only the healthy endpoints will be included in the response. # Endpoints that are health checked before making the routing decision. Unhealthy endpoints are omitted from the results. If all endpoints are unhealthy, we serve a response based on the `backup_geo_targets`. "internalLoadBalancers": [ # Configuration for internal load balancers to be health checked. { # The configuration for an individual load balancer to health check. "ipAddress": "A String", # The frontend IP address of the load balancer to health check. "ipProtocol": "A String", # The protocol of the load balancer to health check. "kind": "dns#rRSetRoutingPolicyLoadBalancerTarget", "loadBalancerType": "A String", # The type of load balancer specified by this target. This value must match the configuration of the load balancer located at the LoadBalancerTarget's IP address, port, and region. Use the following: - *regionalL4ilb*: for a regional internal passthrough Network Load Balancer. - *regionalL7ilb*: for a regional internal Application Load Balancer. - *globalL7ilb*: for a global internal Application Load Balancer. - "networkUrl": "A String", # The fully qualified URL of the network that the load balancer is attached to. This should be formatted like https://www.googleapis.com/compute/v1/projects/{project}/global/networks/{network} . + "networkUrl": "A String", # The fully qualified URL of the network that the load balancer is attached to. This should be formatted like `https://www.googleapis.com/compute/v1/projects/{project}/global/networks/{network}`. "port": "A String", # The configured port of the load balancer. "project": "A String", # The project ID in which the load balancer is located. "region": "A String", # The region in which the load balancer is located. }, ], }, - "trickleTraffic": 3.14, # When serving state is PRIMARY, this field provides the option of sending a small percentage of the traffic to the backup targets. + "trickleTraffic": 3.14, # When serving state is `PRIMARY`, this field provides the option of sending a small percentage of the traffic to the backup targets. }, "wrr": { # Configures a RRSetRoutingPolicy that routes in a weighted round robin fashion. "items": [ { # A routing block which contains the routing information for one WRR item. - "healthCheckedTargets": { # HealthCheckTargets describes endpoints to health-check when responding to Routing Policy queries. Only the healthy endpoints will be included in the response. Only one of internal_load_balancer and external_endpoints should be set. # Endpoints that are health checked before making the routing decision. The unhealthy endpoints are omitted from the result. If all endpoints within a bucket are unhealthy, we choose a different bucket (sampled with respect to its weight) for responding. If DNSSEC is enabled for this zone, only one of rrdata or health_checked_targets can be set. + "healthCheckedTargets": { # HealthCheckTargets describes endpoints to health-check when responding to Routing Policy queries. Only the healthy endpoints will be included in the response. # Endpoints that are health checked before making the routing decision. The unhealthy endpoints are omitted from the result. If all endpoints within a bucket are unhealthy, we choose a different bucket (sampled with respect to its weight) for responding. If DNSSEC is enabled for this zone, only one of `rrdata` or `health_checked_targets` can be set. "internalLoadBalancers": [ # Configuration for internal load balancers to be health checked. { # The configuration for an individual load balancer to health check. "ipAddress": "A String", # The frontend IP address of the load balancer to health check. "ipProtocol": "A String", # The protocol of the load balancer to health check. "kind": "dns#rRSetRoutingPolicyLoadBalancerTarget", "loadBalancerType": "A String", # The type of load balancer specified by this target. This value must match the configuration of the load balancer located at the LoadBalancerTarget's IP address, port, and region. Use the following: - *regionalL4ilb*: for a regional internal passthrough Network Load Balancer. - *regionalL7ilb*: for a regional internal Application Load Balancer. - *globalL7ilb*: for a global internal Application Load Balancer. - "networkUrl": "A String", # The fully qualified URL of the network that the load balancer is attached to. This should be formatted like https://www.googleapis.com/compute/v1/projects/{project}/global/networks/{network} . + "networkUrl": "A String", # The fully qualified URL of the network that the load balancer is attached to. This should be formatted like `https://www.googleapis.com/compute/v1/projects/{project}/global/networks/{network}`. "port": "A String", # The configured port of the load balancer. "project": "A String", # The project ID in which the load balancer is located. "region": "A String", # The region in which the load balancer is located. @@ -366,10 +366,10 @@

Method Details

"rrdatas": [ "A String", ], - "signatureRrdatas": [ # DNSSEC generated signatures for all the rrdata within this item. Note that if health checked targets are provided for DNSSEC enabled zones, there's a restriction of 1 IP address per item. + "signatureRrdatas": [ # DNSSEC generated signatures for all the `rrdata` within this item. Note that if health checked targets are provided for DNSSEC enabled zones, there's a restriction of 1 IP address per item. "A String", ], - "weight": 3.14, # The weight corresponding to this WrrPolicyItem object. When multiple WrrPolicyItem objects are configured, the probability of returning an WrrPolicyItem object's data is proportional to its weight relative to the sum of weights configured for all items. This weight must be non-negative. + "weight": 3.14, # The weight corresponding to this `WrrPolicyItem` object. When multiple `WrrPolicyItem` objects are configured, the probability of returning an `WrrPolicyItem` object's data is proportional to its weight relative to the sum of weights configured for all items. This weight must be non-negative. }, ], "kind": "dns#rRSetRoutingPolicyWrrPolicy", @@ -381,7 +381,7 @@

Method Details

"signatureRrdatas": [ # As defined in RFC 4034 (section 3.2). "A String", ], - "ttl": 42, # Number of seconds that this ResourceRecordSet can be cached by resolvers. + "ttl": 42, # Number of seconds that this `ResourceRecordSet` can be cached by resolvers. "type": "A String", # The identifier of a supported record type. See the list of Supported DNS record types. }, ], @@ -432,19 +432,19 @@

Method Details

{ # A unit of data that is returned by the DNS servers. "kind": "dns#resourceRecordSet", "name": "A String", # For example, www.example.com. - "routingPolicy": { # A RRSetRoutingPolicy represents ResourceRecordSet data that is returned dynamically with the response varying based on configured properties such as geolocation or by weighted random selection. # Configures dynamic query responses based on either the geo location of the querying user or a weighted round robin based routing policy. A valid ResourceRecordSet contains only rrdata (for static resolution) or a routing_policy (for dynamic resolution). - "geo": { # Configures a RRSetRoutingPolicy that routes based on the geo location of the querying user. + "routingPolicy": { # A RRSetRoutingPolicy represents ResourceRecordSet data that is returned dynamically with the response varying based on configured properties such as geolocation or by weighted random selection. # Configures dynamic query responses based on either the geo location of the querying user or a weighted round robin based routing policy. A valid `ResourceRecordSet` contains only `rrdata` (for static resolution) or a `routing_policy` (for dynamic resolution). + "geo": { # Configures a `RRSetRoutingPolicy` that routes based on the geo location of the querying user. "enableFencing": True or False, # Without fencing, if health check fails for all configured items in the current geo bucket, we failover to the next nearest geo bucket. With fencing, if health checking is enabled, as long as some targets in the current geo bucket are healthy, we return only the healthy targets. However, if all targets are unhealthy, we don't failover to the next nearest bucket; instead, we return all the items in the current bucket even when all targets are unhealthy. "items": [ # The primary geo routing configuration. If there are multiple items with the same location, an error is returned instead. { # ResourceRecordSet data for one geo location. - "healthCheckedTargets": { # HealthCheckTargets describes endpoints to health-check when responding to Routing Policy queries. Only the healthy endpoints will be included in the response. Only one of internal_load_balancer and external_endpoints should be set. # For A and AAAA types only. Endpoints to return in the query result only if they are healthy. These can be specified along with rrdata within this item. + "healthCheckedTargets": { # HealthCheckTargets describes endpoints to health-check when responding to Routing Policy queries. Only the healthy endpoints will be included in the response. # For A and AAAA types only. Endpoints to return in the query result only if they are healthy. These can be specified along with `rrdata` within this item. "internalLoadBalancers": [ # Configuration for internal load balancers to be health checked. { # The configuration for an individual load balancer to health check. "ipAddress": "A String", # The frontend IP address of the load balancer to health check. "ipProtocol": "A String", # The protocol of the load balancer to health check. "kind": "dns#rRSetRoutingPolicyLoadBalancerTarget", "loadBalancerType": "A String", # The type of load balancer specified by this target. This value must match the configuration of the load balancer located at the LoadBalancerTarget's IP address, port, and region. Use the following: - *regionalL4ilb*: for a regional internal passthrough Network Load Balancer. - *regionalL7ilb*: for a regional internal Application Load Balancer. - *globalL7ilb*: for a global internal Application Load Balancer. - "networkUrl": "A String", # The fully qualified URL of the network that the load balancer is attached to. This should be formatted like https://www.googleapis.com/compute/v1/projects/{project}/global/networks/{network} . + "networkUrl": "A String", # The fully qualified URL of the network that the load balancer is attached to. This should be formatted like `https://www.googleapis.com/compute/v1/projects/{project}/global/networks/{network}`. "port": "A String", # The configured port of the load balancer. "project": "A String", # The project ID in which the load balancer is located. "region": "A String", # The region in which the load balancer is located. @@ -456,7 +456,7 @@

Method Details

"rrdatas": [ "A String", ], - "signatureRrdatas": [ # DNSSEC generated signatures for all the rrdata within this item. If health checked targets are provided for DNSSEC enabled zones, there's a restriction of 1 IP address per item. + "signatureRrdatas": [ # DNSSEC generated signatures for all the `rrdata` within this item. If health checked targets are provided for DNSSEC enabled zones, there's a restriction of 1 IP address per item. "A String", ], }, @@ -465,18 +465,18 @@

Method Details

}, "kind": "dns#rRSetRoutingPolicy", "primaryBackup": { # Configures a RRSetRoutingPolicy such that all queries are responded with the primary_targets if they are healthy. And if all of them are unhealthy, then we fallback to a geo localized policy. - "backupGeoTargets": { # Configures a RRSetRoutingPolicy that routes based on the geo location of the querying user. # Backup targets provide a regional failover policy for the otherwise global primary targets. If serving state is set to BACKUP, this policy essentially becomes a geo routing policy. + "backupGeoTargets": { # Configures a `RRSetRoutingPolicy` that routes based on the geo location of the querying user. # Backup targets provide a regional failover policy for the otherwise global primary targets. If serving state is set to `BACKUP`, this policy essentially becomes a geo routing policy. "enableFencing": True or False, # Without fencing, if health check fails for all configured items in the current geo bucket, we failover to the next nearest geo bucket. With fencing, if health checking is enabled, as long as some targets in the current geo bucket are healthy, we return only the healthy targets. However, if all targets are unhealthy, we don't failover to the next nearest bucket; instead, we return all the items in the current bucket even when all targets are unhealthy. "items": [ # The primary geo routing configuration. If there are multiple items with the same location, an error is returned instead. { # ResourceRecordSet data for one geo location. - "healthCheckedTargets": { # HealthCheckTargets describes endpoints to health-check when responding to Routing Policy queries. Only the healthy endpoints will be included in the response. Only one of internal_load_balancer and external_endpoints should be set. # For A and AAAA types only. Endpoints to return in the query result only if they are healthy. These can be specified along with rrdata within this item. + "healthCheckedTargets": { # HealthCheckTargets describes endpoints to health-check when responding to Routing Policy queries. Only the healthy endpoints will be included in the response. # For A and AAAA types only. Endpoints to return in the query result only if they are healthy. These can be specified along with `rrdata` within this item. "internalLoadBalancers": [ # Configuration for internal load balancers to be health checked. { # The configuration for an individual load balancer to health check. "ipAddress": "A String", # The frontend IP address of the load balancer to health check. "ipProtocol": "A String", # The protocol of the load balancer to health check. "kind": "dns#rRSetRoutingPolicyLoadBalancerTarget", "loadBalancerType": "A String", # The type of load balancer specified by this target. This value must match the configuration of the load balancer located at the LoadBalancerTarget's IP address, port, and region. Use the following: - *regionalL4ilb*: for a regional internal passthrough Network Load Balancer. - *regionalL7ilb*: for a regional internal Application Load Balancer. - *globalL7ilb*: for a global internal Application Load Balancer. - "networkUrl": "A String", # The fully qualified URL of the network that the load balancer is attached to. This should be formatted like https://www.googleapis.com/compute/v1/projects/{project}/global/networks/{network} . + "networkUrl": "A String", # The fully qualified URL of the network that the load balancer is attached to. This should be formatted like `https://www.googleapis.com/compute/v1/projects/{project}/global/networks/{network}`. "port": "A String", # The configured port of the load balancer. "project": "A String", # The project ID in which the load balancer is located. "region": "A String", # The region in which the load balancer is located. @@ -488,7 +488,7 @@

Method Details

"rrdatas": [ "A String", ], - "signatureRrdatas": [ # DNSSEC generated signatures for all the rrdata within this item. If health checked targets are provided for DNSSEC enabled zones, there's a restriction of 1 IP address per item. + "signatureRrdatas": [ # DNSSEC generated signatures for all the `rrdata` within this item. If health checked targets are provided for DNSSEC enabled zones, there's a restriction of 1 IP address per item. "A String", ], }, @@ -496,33 +496,33 @@

Method Details

"kind": "dns#rRSetRoutingPolicyGeoPolicy", }, "kind": "dns#rRSetRoutingPolicyPrimaryBackupPolicy", - "primaryTargets": { # HealthCheckTargets describes endpoints to health-check when responding to Routing Policy queries. Only the healthy endpoints will be included in the response. Only one of internal_load_balancer and external_endpoints should be set. # Endpoints that are health checked before making the routing decision. Unhealthy endpoints are omitted from the results. If all endpoints are unhealthy, we serve a response based on the backup_geo_targets. + "primaryTargets": { # HealthCheckTargets describes endpoints to health-check when responding to Routing Policy queries. Only the healthy endpoints will be included in the response. # Endpoints that are health checked before making the routing decision. Unhealthy endpoints are omitted from the results. If all endpoints are unhealthy, we serve a response based on the `backup_geo_targets`. "internalLoadBalancers": [ # Configuration for internal load balancers to be health checked. { # The configuration for an individual load balancer to health check. "ipAddress": "A String", # The frontend IP address of the load balancer to health check. "ipProtocol": "A String", # The protocol of the load balancer to health check. "kind": "dns#rRSetRoutingPolicyLoadBalancerTarget", "loadBalancerType": "A String", # The type of load balancer specified by this target. This value must match the configuration of the load balancer located at the LoadBalancerTarget's IP address, port, and region. Use the following: - *regionalL4ilb*: for a regional internal passthrough Network Load Balancer. - *regionalL7ilb*: for a regional internal Application Load Balancer. - *globalL7ilb*: for a global internal Application Load Balancer. - "networkUrl": "A String", # The fully qualified URL of the network that the load balancer is attached to. This should be formatted like https://www.googleapis.com/compute/v1/projects/{project}/global/networks/{network} . + "networkUrl": "A String", # The fully qualified URL of the network that the load balancer is attached to. This should be formatted like `https://www.googleapis.com/compute/v1/projects/{project}/global/networks/{network}`. "port": "A String", # The configured port of the load balancer. "project": "A String", # The project ID in which the load balancer is located. "region": "A String", # The region in which the load balancer is located. }, ], }, - "trickleTraffic": 3.14, # When serving state is PRIMARY, this field provides the option of sending a small percentage of the traffic to the backup targets. + "trickleTraffic": 3.14, # When serving state is `PRIMARY`, this field provides the option of sending a small percentage of the traffic to the backup targets. }, "wrr": { # Configures a RRSetRoutingPolicy that routes in a weighted round robin fashion. "items": [ { # A routing block which contains the routing information for one WRR item. - "healthCheckedTargets": { # HealthCheckTargets describes endpoints to health-check when responding to Routing Policy queries. Only the healthy endpoints will be included in the response. Only one of internal_load_balancer and external_endpoints should be set. # Endpoints that are health checked before making the routing decision. The unhealthy endpoints are omitted from the result. If all endpoints within a bucket are unhealthy, we choose a different bucket (sampled with respect to its weight) for responding. If DNSSEC is enabled for this zone, only one of rrdata or health_checked_targets can be set. + "healthCheckedTargets": { # HealthCheckTargets describes endpoints to health-check when responding to Routing Policy queries. Only the healthy endpoints will be included in the response. # Endpoints that are health checked before making the routing decision. The unhealthy endpoints are omitted from the result. If all endpoints within a bucket are unhealthy, we choose a different bucket (sampled with respect to its weight) for responding. If DNSSEC is enabled for this zone, only one of `rrdata` or `health_checked_targets` can be set. "internalLoadBalancers": [ # Configuration for internal load balancers to be health checked. { # The configuration for an individual load balancer to health check. "ipAddress": "A String", # The frontend IP address of the load balancer to health check. "ipProtocol": "A String", # The protocol of the load balancer to health check. "kind": "dns#rRSetRoutingPolicyLoadBalancerTarget", "loadBalancerType": "A String", # The type of load balancer specified by this target. This value must match the configuration of the load balancer located at the LoadBalancerTarget's IP address, port, and region. Use the following: - *regionalL4ilb*: for a regional internal passthrough Network Load Balancer. - *regionalL7ilb*: for a regional internal Application Load Balancer. - *globalL7ilb*: for a global internal Application Load Balancer. - "networkUrl": "A String", # The fully qualified URL of the network that the load balancer is attached to. This should be formatted like https://www.googleapis.com/compute/v1/projects/{project}/global/networks/{network} . + "networkUrl": "A String", # The fully qualified URL of the network that the load balancer is attached to. This should be formatted like `https://www.googleapis.com/compute/v1/projects/{project}/global/networks/{network}`. "port": "A String", # The configured port of the load balancer. "project": "A String", # The project ID in which the load balancer is located. "region": "A String", # The region in which the load balancer is located. @@ -533,10 +533,10 @@

Method Details

"rrdatas": [ "A String", ], - "signatureRrdatas": [ # DNSSEC generated signatures for all the rrdata within this item. Note that if health checked targets are provided for DNSSEC enabled zones, there's a restriction of 1 IP address per item. + "signatureRrdatas": [ # DNSSEC generated signatures for all the `rrdata` within this item. Note that if health checked targets are provided for DNSSEC enabled zones, there's a restriction of 1 IP address per item. "A String", ], - "weight": 3.14, # The weight corresponding to this WrrPolicyItem object. When multiple WrrPolicyItem objects are configured, the probability of returning an WrrPolicyItem object's data is proportional to its weight relative to the sum of weights configured for all items. This weight must be non-negative. + "weight": 3.14, # The weight corresponding to this `WrrPolicyItem` object. When multiple `WrrPolicyItem` objects are configured, the probability of returning an `WrrPolicyItem` object's data is proportional to its weight relative to the sum of weights configured for all items. This weight must be non-negative. }, ], "kind": "dns#rRSetRoutingPolicyWrrPolicy", @@ -548,7 +548,7 @@

Method Details

"signatureRrdatas": [ # As defined in RFC 4034 (section 3.2). "A String", ], - "ttl": 42, # Number of seconds that this ResourceRecordSet can be cached by resolvers. + "ttl": 42, # Number of seconds that this `ResourceRecordSet` can be cached by resolvers. "type": "A String", # The identifier of a supported record type. See the list of Supported DNS record types. }, ], @@ -575,10 +575,7 @@

Method Details

An object of the form: { - "header": { # Elements common to every response. - "operationId": "A String", # For mutating operation requests that completed successfully. This is the client_operation_id if the client specified it, otherwise it is generated by the server (output only). - }, - "nextPageToken": "A String", # The presence of this field indicates that there exist more results following your last page of results in pagination order. To fetch them, make another list request using this value as your page token. This lets you the complete contents of even very large collections one page at a time. However, if the contents of the collection change between the first and last paginated list request, the set of all elements returned are an inconsistent view of the collection. You cannot retrieve a consistent snapshot of a collection larger than the maximum page size. + "nextPageToken": "A String", # This field indicates that more results are available beyond the last page displayed. To fetch the results, make another list request and use this value as your page token. This lets you retrieve the complete contents of a very large collection one page at a time. However, if the contents of the collection change between the first and last paginated list request, the set of all elements returned are an inconsistent view of the collection. You can't retrieve a consistent snapshot of a collection larger than the maximum page size. "responsePolicyRules": [ # The Response Policy Rule resources. { # A Response Policy Rule is a selector that applies its behavior to queries that match the selector. Selectors are DNS names, which may be wildcards or exact matches. Each DNS query subject to a Response Policy matches at most one ResponsePolicyRule, as identified by the dns_name field with the longest matching suffix. "behavior": "A String", # Answer this query with a behavior rather than DNS data. @@ -589,19 +586,19 @@

Method Details

{ # A unit of data that is returned by the DNS servers. "kind": "dns#resourceRecordSet", "name": "A String", # For example, www.example.com. - "routingPolicy": { # A RRSetRoutingPolicy represents ResourceRecordSet data that is returned dynamically with the response varying based on configured properties such as geolocation or by weighted random selection. # Configures dynamic query responses based on either the geo location of the querying user or a weighted round robin based routing policy. A valid ResourceRecordSet contains only rrdata (for static resolution) or a routing_policy (for dynamic resolution). - "geo": { # Configures a RRSetRoutingPolicy that routes based on the geo location of the querying user. + "routingPolicy": { # A RRSetRoutingPolicy represents ResourceRecordSet data that is returned dynamically with the response varying based on configured properties such as geolocation or by weighted random selection. # Configures dynamic query responses based on either the geo location of the querying user or a weighted round robin based routing policy. A valid `ResourceRecordSet` contains only `rrdata` (for static resolution) or a `routing_policy` (for dynamic resolution). + "geo": { # Configures a `RRSetRoutingPolicy` that routes based on the geo location of the querying user. "enableFencing": True or False, # Without fencing, if health check fails for all configured items in the current geo bucket, we failover to the next nearest geo bucket. With fencing, if health checking is enabled, as long as some targets in the current geo bucket are healthy, we return only the healthy targets. However, if all targets are unhealthy, we don't failover to the next nearest bucket; instead, we return all the items in the current bucket even when all targets are unhealthy. "items": [ # The primary geo routing configuration. If there are multiple items with the same location, an error is returned instead. { # ResourceRecordSet data for one geo location. - "healthCheckedTargets": { # HealthCheckTargets describes endpoints to health-check when responding to Routing Policy queries. Only the healthy endpoints will be included in the response. Only one of internal_load_balancer and external_endpoints should be set. # For A and AAAA types only. Endpoints to return in the query result only if they are healthy. These can be specified along with rrdata within this item. + "healthCheckedTargets": { # HealthCheckTargets describes endpoints to health-check when responding to Routing Policy queries. Only the healthy endpoints will be included in the response. # For A and AAAA types only. Endpoints to return in the query result only if they are healthy. These can be specified along with `rrdata` within this item. "internalLoadBalancers": [ # Configuration for internal load balancers to be health checked. { # The configuration for an individual load balancer to health check. "ipAddress": "A String", # The frontend IP address of the load balancer to health check. "ipProtocol": "A String", # The protocol of the load balancer to health check. "kind": "dns#rRSetRoutingPolicyLoadBalancerTarget", "loadBalancerType": "A String", # The type of load balancer specified by this target. This value must match the configuration of the load balancer located at the LoadBalancerTarget's IP address, port, and region. Use the following: - *regionalL4ilb*: for a regional internal passthrough Network Load Balancer. - *regionalL7ilb*: for a regional internal Application Load Balancer. - *globalL7ilb*: for a global internal Application Load Balancer. - "networkUrl": "A String", # The fully qualified URL of the network that the load balancer is attached to. This should be formatted like https://www.googleapis.com/compute/v1/projects/{project}/global/networks/{network} . + "networkUrl": "A String", # The fully qualified URL of the network that the load balancer is attached to. This should be formatted like `https://www.googleapis.com/compute/v1/projects/{project}/global/networks/{network}`. "port": "A String", # The configured port of the load balancer. "project": "A String", # The project ID in which the load balancer is located. "region": "A String", # The region in which the load balancer is located. @@ -613,7 +610,7 @@

Method Details

"rrdatas": [ "A String", ], - "signatureRrdatas": [ # DNSSEC generated signatures for all the rrdata within this item. If health checked targets are provided for DNSSEC enabled zones, there's a restriction of 1 IP address per item. + "signatureRrdatas": [ # DNSSEC generated signatures for all the `rrdata` within this item. If health checked targets are provided for DNSSEC enabled zones, there's a restriction of 1 IP address per item. "A String", ], }, @@ -622,18 +619,18 @@

Method Details

}, "kind": "dns#rRSetRoutingPolicy", "primaryBackup": { # Configures a RRSetRoutingPolicy such that all queries are responded with the primary_targets if they are healthy. And if all of them are unhealthy, then we fallback to a geo localized policy. - "backupGeoTargets": { # Configures a RRSetRoutingPolicy that routes based on the geo location of the querying user. # Backup targets provide a regional failover policy for the otherwise global primary targets. If serving state is set to BACKUP, this policy essentially becomes a geo routing policy. + "backupGeoTargets": { # Configures a `RRSetRoutingPolicy` that routes based on the geo location of the querying user. # Backup targets provide a regional failover policy for the otherwise global primary targets. If serving state is set to `BACKUP`, this policy essentially becomes a geo routing policy. "enableFencing": True or False, # Without fencing, if health check fails for all configured items in the current geo bucket, we failover to the next nearest geo bucket. With fencing, if health checking is enabled, as long as some targets in the current geo bucket are healthy, we return only the healthy targets. However, if all targets are unhealthy, we don't failover to the next nearest bucket; instead, we return all the items in the current bucket even when all targets are unhealthy. "items": [ # The primary geo routing configuration. If there are multiple items with the same location, an error is returned instead. { # ResourceRecordSet data for one geo location. - "healthCheckedTargets": { # HealthCheckTargets describes endpoints to health-check when responding to Routing Policy queries. Only the healthy endpoints will be included in the response. Only one of internal_load_balancer and external_endpoints should be set. # For A and AAAA types only. Endpoints to return in the query result only if they are healthy. These can be specified along with rrdata within this item. + "healthCheckedTargets": { # HealthCheckTargets describes endpoints to health-check when responding to Routing Policy queries. Only the healthy endpoints will be included in the response. # For A and AAAA types only. Endpoints to return in the query result only if they are healthy. These can be specified along with `rrdata` within this item. "internalLoadBalancers": [ # Configuration for internal load balancers to be health checked. { # The configuration for an individual load balancer to health check. "ipAddress": "A String", # The frontend IP address of the load balancer to health check. "ipProtocol": "A String", # The protocol of the load balancer to health check. "kind": "dns#rRSetRoutingPolicyLoadBalancerTarget", "loadBalancerType": "A String", # The type of load balancer specified by this target. This value must match the configuration of the load balancer located at the LoadBalancerTarget's IP address, port, and region. Use the following: - *regionalL4ilb*: for a regional internal passthrough Network Load Balancer. - *regionalL7ilb*: for a regional internal Application Load Balancer. - *globalL7ilb*: for a global internal Application Load Balancer. - "networkUrl": "A String", # The fully qualified URL of the network that the load balancer is attached to. This should be formatted like https://www.googleapis.com/compute/v1/projects/{project}/global/networks/{network} . + "networkUrl": "A String", # The fully qualified URL of the network that the load balancer is attached to. This should be formatted like `https://www.googleapis.com/compute/v1/projects/{project}/global/networks/{network}`. "port": "A String", # The configured port of the load balancer. "project": "A String", # The project ID in which the load balancer is located. "region": "A String", # The region in which the load balancer is located. @@ -645,7 +642,7 @@

Method Details

"rrdatas": [ "A String", ], - "signatureRrdatas": [ # DNSSEC generated signatures for all the rrdata within this item. If health checked targets are provided for DNSSEC enabled zones, there's a restriction of 1 IP address per item. + "signatureRrdatas": [ # DNSSEC generated signatures for all the `rrdata` within this item. If health checked targets are provided for DNSSEC enabled zones, there's a restriction of 1 IP address per item. "A String", ], }, @@ -653,33 +650,33 @@

Method Details

"kind": "dns#rRSetRoutingPolicyGeoPolicy", }, "kind": "dns#rRSetRoutingPolicyPrimaryBackupPolicy", - "primaryTargets": { # HealthCheckTargets describes endpoints to health-check when responding to Routing Policy queries. Only the healthy endpoints will be included in the response. Only one of internal_load_balancer and external_endpoints should be set. # Endpoints that are health checked before making the routing decision. Unhealthy endpoints are omitted from the results. If all endpoints are unhealthy, we serve a response based on the backup_geo_targets. + "primaryTargets": { # HealthCheckTargets describes endpoints to health-check when responding to Routing Policy queries. Only the healthy endpoints will be included in the response. # Endpoints that are health checked before making the routing decision. Unhealthy endpoints are omitted from the results. If all endpoints are unhealthy, we serve a response based on the `backup_geo_targets`. "internalLoadBalancers": [ # Configuration for internal load balancers to be health checked. { # The configuration for an individual load balancer to health check. "ipAddress": "A String", # The frontend IP address of the load balancer to health check. "ipProtocol": "A String", # The protocol of the load balancer to health check. "kind": "dns#rRSetRoutingPolicyLoadBalancerTarget", "loadBalancerType": "A String", # The type of load balancer specified by this target. This value must match the configuration of the load balancer located at the LoadBalancerTarget's IP address, port, and region. Use the following: - *regionalL4ilb*: for a regional internal passthrough Network Load Balancer. - *regionalL7ilb*: for a regional internal Application Load Balancer. - *globalL7ilb*: for a global internal Application Load Balancer. - "networkUrl": "A String", # The fully qualified URL of the network that the load balancer is attached to. This should be formatted like https://www.googleapis.com/compute/v1/projects/{project}/global/networks/{network} . + "networkUrl": "A String", # The fully qualified URL of the network that the load balancer is attached to. This should be formatted like `https://www.googleapis.com/compute/v1/projects/{project}/global/networks/{network}`. "port": "A String", # The configured port of the load balancer. "project": "A String", # The project ID in which the load balancer is located. "region": "A String", # The region in which the load balancer is located. }, ], }, - "trickleTraffic": 3.14, # When serving state is PRIMARY, this field provides the option of sending a small percentage of the traffic to the backup targets. + "trickleTraffic": 3.14, # When serving state is `PRIMARY`, this field provides the option of sending a small percentage of the traffic to the backup targets. }, "wrr": { # Configures a RRSetRoutingPolicy that routes in a weighted round robin fashion. "items": [ { # A routing block which contains the routing information for one WRR item. - "healthCheckedTargets": { # HealthCheckTargets describes endpoints to health-check when responding to Routing Policy queries. Only the healthy endpoints will be included in the response. Only one of internal_load_balancer and external_endpoints should be set. # Endpoints that are health checked before making the routing decision. The unhealthy endpoints are omitted from the result. If all endpoints within a bucket are unhealthy, we choose a different bucket (sampled with respect to its weight) for responding. If DNSSEC is enabled for this zone, only one of rrdata or health_checked_targets can be set. + "healthCheckedTargets": { # HealthCheckTargets describes endpoints to health-check when responding to Routing Policy queries. Only the healthy endpoints will be included in the response. # Endpoints that are health checked before making the routing decision. The unhealthy endpoints are omitted from the result. If all endpoints within a bucket are unhealthy, we choose a different bucket (sampled with respect to its weight) for responding. If DNSSEC is enabled for this zone, only one of `rrdata` or `health_checked_targets` can be set. "internalLoadBalancers": [ # Configuration for internal load balancers to be health checked. { # The configuration for an individual load balancer to health check. "ipAddress": "A String", # The frontend IP address of the load balancer to health check. "ipProtocol": "A String", # The protocol of the load balancer to health check. "kind": "dns#rRSetRoutingPolicyLoadBalancerTarget", "loadBalancerType": "A String", # The type of load balancer specified by this target. This value must match the configuration of the load balancer located at the LoadBalancerTarget's IP address, port, and region. Use the following: - *regionalL4ilb*: for a regional internal passthrough Network Load Balancer. - *regionalL7ilb*: for a regional internal Application Load Balancer. - *globalL7ilb*: for a global internal Application Load Balancer. - "networkUrl": "A String", # The fully qualified URL of the network that the load balancer is attached to. This should be formatted like https://www.googleapis.com/compute/v1/projects/{project}/global/networks/{network} . + "networkUrl": "A String", # The fully qualified URL of the network that the load balancer is attached to. This should be formatted like `https://www.googleapis.com/compute/v1/projects/{project}/global/networks/{network}`. "port": "A String", # The configured port of the load balancer. "project": "A String", # The project ID in which the load balancer is located. "region": "A String", # The region in which the load balancer is located. @@ -690,10 +687,10 @@

Method Details

"rrdatas": [ "A String", ], - "signatureRrdatas": [ # DNSSEC generated signatures for all the rrdata within this item. Note that if health checked targets are provided for DNSSEC enabled zones, there's a restriction of 1 IP address per item. + "signatureRrdatas": [ # DNSSEC generated signatures for all the `rrdata` within this item. Note that if health checked targets are provided for DNSSEC enabled zones, there's a restriction of 1 IP address per item. "A String", ], - "weight": 3.14, # The weight corresponding to this WrrPolicyItem object. When multiple WrrPolicyItem objects are configured, the probability of returning an WrrPolicyItem object's data is proportional to its weight relative to the sum of weights configured for all items. This weight must be non-negative. + "weight": 3.14, # The weight corresponding to this `WrrPolicyItem` object. When multiple `WrrPolicyItem` objects are configured, the probability of returning an `WrrPolicyItem` object's data is proportional to its weight relative to the sum of weights configured for all items. This weight must be non-negative. }, ], "kind": "dns#rRSetRoutingPolicyWrrPolicy", @@ -705,7 +702,7 @@

Method Details

"signatureRrdatas": [ # As defined in RFC 4034 (section 3.2). "A String", ], - "ttl": 42, # Number of seconds that this ResourceRecordSet can be cached by resolvers. + "ttl": 42, # Number of seconds that this `ResourceRecordSet` can be cached by resolvers. "type": "A String", # The identifier of a supported record type. See the list of Supported DNS record types. }, ], @@ -750,19 +747,19 @@

Method Details

{ # A unit of data that is returned by the DNS servers. "kind": "dns#resourceRecordSet", "name": "A String", # For example, www.example.com. - "routingPolicy": { # A RRSetRoutingPolicy represents ResourceRecordSet data that is returned dynamically with the response varying based on configured properties such as geolocation or by weighted random selection. # Configures dynamic query responses based on either the geo location of the querying user or a weighted round robin based routing policy. A valid ResourceRecordSet contains only rrdata (for static resolution) or a routing_policy (for dynamic resolution). - "geo": { # Configures a RRSetRoutingPolicy that routes based on the geo location of the querying user. + "routingPolicy": { # A RRSetRoutingPolicy represents ResourceRecordSet data that is returned dynamically with the response varying based on configured properties such as geolocation or by weighted random selection. # Configures dynamic query responses based on either the geo location of the querying user or a weighted round robin based routing policy. A valid `ResourceRecordSet` contains only `rrdata` (for static resolution) or a `routing_policy` (for dynamic resolution). + "geo": { # Configures a `RRSetRoutingPolicy` that routes based on the geo location of the querying user. "enableFencing": True or False, # Without fencing, if health check fails for all configured items in the current geo bucket, we failover to the next nearest geo bucket. With fencing, if health checking is enabled, as long as some targets in the current geo bucket are healthy, we return only the healthy targets. However, if all targets are unhealthy, we don't failover to the next nearest bucket; instead, we return all the items in the current bucket even when all targets are unhealthy. "items": [ # The primary geo routing configuration. If there are multiple items with the same location, an error is returned instead. { # ResourceRecordSet data for one geo location. - "healthCheckedTargets": { # HealthCheckTargets describes endpoints to health-check when responding to Routing Policy queries. Only the healthy endpoints will be included in the response. Only one of internal_load_balancer and external_endpoints should be set. # For A and AAAA types only. Endpoints to return in the query result only if they are healthy. These can be specified along with rrdata within this item. + "healthCheckedTargets": { # HealthCheckTargets describes endpoints to health-check when responding to Routing Policy queries. Only the healthy endpoints will be included in the response. # For A and AAAA types only. Endpoints to return in the query result only if they are healthy. These can be specified along with `rrdata` within this item. "internalLoadBalancers": [ # Configuration for internal load balancers to be health checked. { # The configuration for an individual load balancer to health check. "ipAddress": "A String", # The frontend IP address of the load balancer to health check. "ipProtocol": "A String", # The protocol of the load balancer to health check. "kind": "dns#rRSetRoutingPolicyLoadBalancerTarget", "loadBalancerType": "A String", # The type of load balancer specified by this target. This value must match the configuration of the load balancer located at the LoadBalancerTarget's IP address, port, and region. Use the following: - *regionalL4ilb*: for a regional internal passthrough Network Load Balancer. - *regionalL7ilb*: for a regional internal Application Load Balancer. - *globalL7ilb*: for a global internal Application Load Balancer. - "networkUrl": "A String", # The fully qualified URL of the network that the load balancer is attached to. This should be formatted like https://www.googleapis.com/compute/v1/projects/{project}/global/networks/{network} . + "networkUrl": "A String", # The fully qualified URL of the network that the load balancer is attached to. This should be formatted like `https://www.googleapis.com/compute/v1/projects/{project}/global/networks/{network}`. "port": "A String", # The configured port of the load balancer. "project": "A String", # The project ID in which the load balancer is located. "region": "A String", # The region in which the load balancer is located. @@ -774,7 +771,7 @@

Method Details

"rrdatas": [ "A String", ], - "signatureRrdatas": [ # DNSSEC generated signatures for all the rrdata within this item. If health checked targets are provided for DNSSEC enabled zones, there's a restriction of 1 IP address per item. + "signatureRrdatas": [ # DNSSEC generated signatures for all the `rrdata` within this item. If health checked targets are provided for DNSSEC enabled zones, there's a restriction of 1 IP address per item. "A String", ], }, @@ -783,18 +780,18 @@

Method Details

}, "kind": "dns#rRSetRoutingPolicy", "primaryBackup": { # Configures a RRSetRoutingPolicy such that all queries are responded with the primary_targets if they are healthy. And if all of them are unhealthy, then we fallback to a geo localized policy. - "backupGeoTargets": { # Configures a RRSetRoutingPolicy that routes based on the geo location of the querying user. # Backup targets provide a regional failover policy for the otherwise global primary targets. If serving state is set to BACKUP, this policy essentially becomes a geo routing policy. + "backupGeoTargets": { # Configures a `RRSetRoutingPolicy` that routes based on the geo location of the querying user. # Backup targets provide a regional failover policy for the otherwise global primary targets. If serving state is set to `BACKUP`, this policy essentially becomes a geo routing policy. "enableFencing": True or False, # Without fencing, if health check fails for all configured items in the current geo bucket, we failover to the next nearest geo bucket. With fencing, if health checking is enabled, as long as some targets in the current geo bucket are healthy, we return only the healthy targets. However, if all targets are unhealthy, we don't failover to the next nearest bucket; instead, we return all the items in the current bucket even when all targets are unhealthy. "items": [ # The primary geo routing configuration. If there are multiple items with the same location, an error is returned instead. { # ResourceRecordSet data for one geo location. - "healthCheckedTargets": { # HealthCheckTargets describes endpoints to health-check when responding to Routing Policy queries. Only the healthy endpoints will be included in the response. Only one of internal_load_balancer and external_endpoints should be set. # For A and AAAA types only. Endpoints to return in the query result only if they are healthy. These can be specified along with rrdata within this item. + "healthCheckedTargets": { # HealthCheckTargets describes endpoints to health-check when responding to Routing Policy queries. Only the healthy endpoints will be included in the response. # For A and AAAA types only. Endpoints to return in the query result only if they are healthy. These can be specified along with `rrdata` within this item. "internalLoadBalancers": [ # Configuration for internal load balancers to be health checked. { # The configuration for an individual load balancer to health check. "ipAddress": "A String", # The frontend IP address of the load balancer to health check. "ipProtocol": "A String", # The protocol of the load balancer to health check. "kind": "dns#rRSetRoutingPolicyLoadBalancerTarget", "loadBalancerType": "A String", # The type of load balancer specified by this target. This value must match the configuration of the load balancer located at the LoadBalancerTarget's IP address, port, and region. Use the following: - *regionalL4ilb*: for a regional internal passthrough Network Load Balancer. - *regionalL7ilb*: for a regional internal Application Load Balancer. - *globalL7ilb*: for a global internal Application Load Balancer. - "networkUrl": "A String", # The fully qualified URL of the network that the load balancer is attached to. This should be formatted like https://www.googleapis.com/compute/v1/projects/{project}/global/networks/{network} . + "networkUrl": "A String", # The fully qualified URL of the network that the load balancer is attached to. This should be formatted like `https://www.googleapis.com/compute/v1/projects/{project}/global/networks/{network}`. "port": "A String", # The configured port of the load balancer. "project": "A String", # The project ID in which the load balancer is located. "region": "A String", # The region in which the load balancer is located. @@ -806,7 +803,7 @@

Method Details

"rrdatas": [ "A String", ], - "signatureRrdatas": [ # DNSSEC generated signatures for all the rrdata within this item. If health checked targets are provided for DNSSEC enabled zones, there's a restriction of 1 IP address per item. + "signatureRrdatas": [ # DNSSEC generated signatures for all the `rrdata` within this item. If health checked targets are provided for DNSSEC enabled zones, there's a restriction of 1 IP address per item. "A String", ], }, @@ -814,33 +811,33 @@

Method Details

"kind": "dns#rRSetRoutingPolicyGeoPolicy", }, "kind": "dns#rRSetRoutingPolicyPrimaryBackupPolicy", - "primaryTargets": { # HealthCheckTargets describes endpoints to health-check when responding to Routing Policy queries. Only the healthy endpoints will be included in the response. Only one of internal_load_balancer and external_endpoints should be set. # Endpoints that are health checked before making the routing decision. Unhealthy endpoints are omitted from the results. If all endpoints are unhealthy, we serve a response based on the backup_geo_targets. + "primaryTargets": { # HealthCheckTargets describes endpoints to health-check when responding to Routing Policy queries. Only the healthy endpoints will be included in the response. # Endpoints that are health checked before making the routing decision. Unhealthy endpoints are omitted from the results. If all endpoints are unhealthy, we serve a response based on the `backup_geo_targets`. "internalLoadBalancers": [ # Configuration for internal load balancers to be health checked. { # The configuration for an individual load balancer to health check. "ipAddress": "A String", # The frontend IP address of the load balancer to health check. "ipProtocol": "A String", # The protocol of the load balancer to health check. "kind": "dns#rRSetRoutingPolicyLoadBalancerTarget", "loadBalancerType": "A String", # The type of load balancer specified by this target. This value must match the configuration of the load balancer located at the LoadBalancerTarget's IP address, port, and region. Use the following: - *regionalL4ilb*: for a regional internal passthrough Network Load Balancer. - *regionalL7ilb*: for a regional internal Application Load Balancer. - *globalL7ilb*: for a global internal Application Load Balancer. - "networkUrl": "A String", # The fully qualified URL of the network that the load balancer is attached to. This should be formatted like https://www.googleapis.com/compute/v1/projects/{project}/global/networks/{network} . + "networkUrl": "A String", # The fully qualified URL of the network that the load balancer is attached to. This should be formatted like `https://www.googleapis.com/compute/v1/projects/{project}/global/networks/{network}`. "port": "A String", # The configured port of the load balancer. "project": "A String", # The project ID in which the load balancer is located. "region": "A String", # The region in which the load balancer is located. }, ], }, - "trickleTraffic": 3.14, # When serving state is PRIMARY, this field provides the option of sending a small percentage of the traffic to the backup targets. + "trickleTraffic": 3.14, # When serving state is `PRIMARY`, this field provides the option of sending a small percentage of the traffic to the backup targets. }, "wrr": { # Configures a RRSetRoutingPolicy that routes in a weighted round robin fashion. "items": [ { # A routing block which contains the routing information for one WRR item. - "healthCheckedTargets": { # HealthCheckTargets describes endpoints to health-check when responding to Routing Policy queries. Only the healthy endpoints will be included in the response. Only one of internal_load_balancer and external_endpoints should be set. # Endpoints that are health checked before making the routing decision. The unhealthy endpoints are omitted from the result. If all endpoints within a bucket are unhealthy, we choose a different bucket (sampled with respect to its weight) for responding. If DNSSEC is enabled for this zone, only one of rrdata or health_checked_targets can be set. + "healthCheckedTargets": { # HealthCheckTargets describes endpoints to health-check when responding to Routing Policy queries. Only the healthy endpoints will be included in the response. # Endpoints that are health checked before making the routing decision. The unhealthy endpoints are omitted from the result. If all endpoints within a bucket are unhealthy, we choose a different bucket (sampled with respect to its weight) for responding. If DNSSEC is enabled for this zone, only one of `rrdata` or `health_checked_targets` can be set. "internalLoadBalancers": [ # Configuration for internal load balancers to be health checked. { # The configuration for an individual load balancer to health check. "ipAddress": "A String", # The frontend IP address of the load balancer to health check. "ipProtocol": "A String", # The protocol of the load balancer to health check. "kind": "dns#rRSetRoutingPolicyLoadBalancerTarget", "loadBalancerType": "A String", # The type of load balancer specified by this target. This value must match the configuration of the load balancer located at the LoadBalancerTarget's IP address, port, and region. Use the following: - *regionalL4ilb*: for a regional internal passthrough Network Load Balancer. - *regionalL7ilb*: for a regional internal Application Load Balancer. - *globalL7ilb*: for a global internal Application Load Balancer. - "networkUrl": "A String", # The fully qualified URL of the network that the load balancer is attached to. This should be formatted like https://www.googleapis.com/compute/v1/projects/{project}/global/networks/{network} . + "networkUrl": "A String", # The fully qualified URL of the network that the load balancer is attached to. This should be formatted like `https://www.googleapis.com/compute/v1/projects/{project}/global/networks/{network}`. "port": "A String", # The configured port of the load balancer. "project": "A String", # The project ID in which the load balancer is located. "region": "A String", # The region in which the load balancer is located. @@ -851,10 +848,10 @@

Method Details

"rrdatas": [ "A String", ], - "signatureRrdatas": [ # DNSSEC generated signatures for all the rrdata within this item. Note that if health checked targets are provided for DNSSEC enabled zones, there's a restriction of 1 IP address per item. + "signatureRrdatas": [ # DNSSEC generated signatures for all the `rrdata` within this item. Note that if health checked targets are provided for DNSSEC enabled zones, there's a restriction of 1 IP address per item. "A String", ], - "weight": 3.14, # The weight corresponding to this WrrPolicyItem object. When multiple WrrPolicyItem objects are configured, the probability of returning an WrrPolicyItem object's data is proportional to its weight relative to the sum of weights configured for all items. This weight must be non-negative. + "weight": 3.14, # The weight corresponding to this `WrrPolicyItem` object. When multiple `WrrPolicyItem` objects are configured, the probability of returning an `WrrPolicyItem` object's data is proportional to its weight relative to the sum of weights configured for all items. This weight must be non-negative. }, ], "kind": "dns#rRSetRoutingPolicyWrrPolicy", @@ -866,7 +863,7 @@

Method Details

"signatureRrdatas": [ # As defined in RFC 4034 (section 3.2). "A String", ], - "ttl": 42, # Number of seconds that this ResourceRecordSet can be cached by resolvers. + "ttl": 42, # Number of seconds that this `ResourceRecordSet` can be cached by resolvers. "type": "A String", # The identifier of a supported record type. See the list of Supported DNS record types. }, ], @@ -884,9 +881,6 @@

Method Details

An object of the form: { - "header": { # Elements common to every response. - "operationId": "A String", # For mutating operation requests that completed successfully. This is the client_operation_id if the client specified it, otherwise it is generated by the server (output only). - }, "responsePolicyRule": { # A Response Policy Rule is a selector that applies its behavior to queries that match the selector. Selectors are DNS names, which may be wildcards or exact matches. Each DNS query subject to a Response Policy matches at most one ResponsePolicyRule, as identified by the dns_name field with the longest matching suffix. "behavior": "A String", # Answer this query with a behavior rather than DNS data. "dnsName": "A String", # The DNS name (wildcard or exact) to apply this rule to. Must be unique within the Response Policy Rule. @@ -896,19 +890,19 @@

Method Details

{ # A unit of data that is returned by the DNS servers. "kind": "dns#resourceRecordSet", "name": "A String", # For example, www.example.com. - "routingPolicy": { # A RRSetRoutingPolicy represents ResourceRecordSet data that is returned dynamically with the response varying based on configured properties such as geolocation or by weighted random selection. # Configures dynamic query responses based on either the geo location of the querying user or a weighted round robin based routing policy. A valid ResourceRecordSet contains only rrdata (for static resolution) or a routing_policy (for dynamic resolution). - "geo": { # Configures a RRSetRoutingPolicy that routes based on the geo location of the querying user. + "routingPolicy": { # A RRSetRoutingPolicy represents ResourceRecordSet data that is returned dynamically with the response varying based on configured properties such as geolocation or by weighted random selection. # Configures dynamic query responses based on either the geo location of the querying user or a weighted round robin based routing policy. A valid `ResourceRecordSet` contains only `rrdata` (for static resolution) or a `routing_policy` (for dynamic resolution). + "geo": { # Configures a `RRSetRoutingPolicy` that routes based on the geo location of the querying user. "enableFencing": True or False, # Without fencing, if health check fails for all configured items in the current geo bucket, we failover to the next nearest geo bucket. With fencing, if health checking is enabled, as long as some targets in the current geo bucket are healthy, we return only the healthy targets. However, if all targets are unhealthy, we don't failover to the next nearest bucket; instead, we return all the items in the current bucket even when all targets are unhealthy. "items": [ # The primary geo routing configuration. If there are multiple items with the same location, an error is returned instead. { # ResourceRecordSet data for one geo location. - "healthCheckedTargets": { # HealthCheckTargets describes endpoints to health-check when responding to Routing Policy queries. Only the healthy endpoints will be included in the response. Only one of internal_load_balancer and external_endpoints should be set. # For A and AAAA types only. Endpoints to return in the query result only if they are healthy. These can be specified along with rrdata within this item. + "healthCheckedTargets": { # HealthCheckTargets describes endpoints to health-check when responding to Routing Policy queries. Only the healthy endpoints will be included in the response. # For A and AAAA types only. Endpoints to return in the query result only if they are healthy. These can be specified along with `rrdata` within this item. "internalLoadBalancers": [ # Configuration for internal load balancers to be health checked. { # The configuration for an individual load balancer to health check. "ipAddress": "A String", # The frontend IP address of the load balancer to health check. "ipProtocol": "A String", # The protocol of the load balancer to health check. "kind": "dns#rRSetRoutingPolicyLoadBalancerTarget", "loadBalancerType": "A String", # The type of load balancer specified by this target. This value must match the configuration of the load balancer located at the LoadBalancerTarget's IP address, port, and region. Use the following: - *regionalL4ilb*: for a regional internal passthrough Network Load Balancer. - *regionalL7ilb*: for a regional internal Application Load Balancer. - *globalL7ilb*: for a global internal Application Load Balancer. - "networkUrl": "A String", # The fully qualified URL of the network that the load balancer is attached to. This should be formatted like https://www.googleapis.com/compute/v1/projects/{project}/global/networks/{network} . + "networkUrl": "A String", # The fully qualified URL of the network that the load balancer is attached to. This should be formatted like `https://www.googleapis.com/compute/v1/projects/{project}/global/networks/{network}`. "port": "A String", # The configured port of the load balancer. "project": "A String", # The project ID in which the load balancer is located. "region": "A String", # The region in which the load balancer is located. @@ -920,7 +914,7 @@

Method Details

"rrdatas": [ "A String", ], - "signatureRrdatas": [ # DNSSEC generated signatures for all the rrdata within this item. If health checked targets are provided for DNSSEC enabled zones, there's a restriction of 1 IP address per item. + "signatureRrdatas": [ # DNSSEC generated signatures for all the `rrdata` within this item. If health checked targets are provided for DNSSEC enabled zones, there's a restriction of 1 IP address per item. "A String", ], }, @@ -929,18 +923,18 @@

Method Details

}, "kind": "dns#rRSetRoutingPolicy", "primaryBackup": { # Configures a RRSetRoutingPolicy such that all queries are responded with the primary_targets if they are healthy. And if all of them are unhealthy, then we fallback to a geo localized policy. - "backupGeoTargets": { # Configures a RRSetRoutingPolicy that routes based on the geo location of the querying user. # Backup targets provide a regional failover policy for the otherwise global primary targets. If serving state is set to BACKUP, this policy essentially becomes a geo routing policy. + "backupGeoTargets": { # Configures a `RRSetRoutingPolicy` that routes based on the geo location of the querying user. # Backup targets provide a regional failover policy for the otherwise global primary targets. If serving state is set to `BACKUP`, this policy essentially becomes a geo routing policy. "enableFencing": True or False, # Without fencing, if health check fails for all configured items in the current geo bucket, we failover to the next nearest geo bucket. With fencing, if health checking is enabled, as long as some targets in the current geo bucket are healthy, we return only the healthy targets. However, if all targets are unhealthy, we don't failover to the next nearest bucket; instead, we return all the items in the current bucket even when all targets are unhealthy. "items": [ # The primary geo routing configuration. If there are multiple items with the same location, an error is returned instead. { # ResourceRecordSet data for one geo location. - "healthCheckedTargets": { # HealthCheckTargets describes endpoints to health-check when responding to Routing Policy queries. Only the healthy endpoints will be included in the response. Only one of internal_load_balancer and external_endpoints should be set. # For A and AAAA types only. Endpoints to return in the query result only if they are healthy. These can be specified along with rrdata within this item. + "healthCheckedTargets": { # HealthCheckTargets describes endpoints to health-check when responding to Routing Policy queries. Only the healthy endpoints will be included in the response. # For A and AAAA types only. Endpoints to return in the query result only if they are healthy. These can be specified along with `rrdata` within this item. "internalLoadBalancers": [ # Configuration for internal load balancers to be health checked. { # The configuration for an individual load balancer to health check. "ipAddress": "A String", # The frontend IP address of the load balancer to health check. "ipProtocol": "A String", # The protocol of the load balancer to health check. "kind": "dns#rRSetRoutingPolicyLoadBalancerTarget", "loadBalancerType": "A String", # The type of load balancer specified by this target. This value must match the configuration of the load balancer located at the LoadBalancerTarget's IP address, port, and region. Use the following: - *regionalL4ilb*: for a regional internal passthrough Network Load Balancer. - *regionalL7ilb*: for a regional internal Application Load Balancer. - *globalL7ilb*: for a global internal Application Load Balancer. - "networkUrl": "A String", # The fully qualified URL of the network that the load balancer is attached to. This should be formatted like https://www.googleapis.com/compute/v1/projects/{project}/global/networks/{network} . + "networkUrl": "A String", # The fully qualified URL of the network that the load balancer is attached to. This should be formatted like `https://www.googleapis.com/compute/v1/projects/{project}/global/networks/{network}`. "port": "A String", # The configured port of the load balancer. "project": "A String", # The project ID in which the load balancer is located. "region": "A String", # The region in which the load balancer is located. @@ -952,7 +946,7 @@

Method Details

"rrdatas": [ "A String", ], - "signatureRrdatas": [ # DNSSEC generated signatures for all the rrdata within this item. If health checked targets are provided for DNSSEC enabled zones, there's a restriction of 1 IP address per item. + "signatureRrdatas": [ # DNSSEC generated signatures for all the `rrdata` within this item. If health checked targets are provided for DNSSEC enabled zones, there's a restriction of 1 IP address per item. "A String", ], }, @@ -960,33 +954,33 @@

Method Details

"kind": "dns#rRSetRoutingPolicyGeoPolicy", }, "kind": "dns#rRSetRoutingPolicyPrimaryBackupPolicy", - "primaryTargets": { # HealthCheckTargets describes endpoints to health-check when responding to Routing Policy queries. Only the healthy endpoints will be included in the response. Only one of internal_load_balancer and external_endpoints should be set. # Endpoints that are health checked before making the routing decision. Unhealthy endpoints are omitted from the results. If all endpoints are unhealthy, we serve a response based on the backup_geo_targets. + "primaryTargets": { # HealthCheckTargets describes endpoints to health-check when responding to Routing Policy queries. Only the healthy endpoints will be included in the response. # Endpoints that are health checked before making the routing decision. Unhealthy endpoints are omitted from the results. If all endpoints are unhealthy, we serve a response based on the `backup_geo_targets`. "internalLoadBalancers": [ # Configuration for internal load balancers to be health checked. { # The configuration for an individual load balancer to health check. "ipAddress": "A String", # The frontend IP address of the load balancer to health check. "ipProtocol": "A String", # The protocol of the load balancer to health check. "kind": "dns#rRSetRoutingPolicyLoadBalancerTarget", "loadBalancerType": "A String", # The type of load balancer specified by this target. This value must match the configuration of the load balancer located at the LoadBalancerTarget's IP address, port, and region. Use the following: - *regionalL4ilb*: for a regional internal passthrough Network Load Balancer. - *regionalL7ilb*: for a regional internal Application Load Balancer. - *globalL7ilb*: for a global internal Application Load Balancer. - "networkUrl": "A String", # The fully qualified URL of the network that the load balancer is attached to. This should be formatted like https://www.googleapis.com/compute/v1/projects/{project}/global/networks/{network} . + "networkUrl": "A String", # The fully qualified URL of the network that the load balancer is attached to. This should be formatted like `https://www.googleapis.com/compute/v1/projects/{project}/global/networks/{network}`. "port": "A String", # The configured port of the load balancer. "project": "A String", # The project ID in which the load balancer is located. "region": "A String", # The region in which the load balancer is located. }, ], }, - "trickleTraffic": 3.14, # When serving state is PRIMARY, this field provides the option of sending a small percentage of the traffic to the backup targets. + "trickleTraffic": 3.14, # When serving state is `PRIMARY`, this field provides the option of sending a small percentage of the traffic to the backup targets. }, "wrr": { # Configures a RRSetRoutingPolicy that routes in a weighted round robin fashion. "items": [ { # A routing block which contains the routing information for one WRR item. - "healthCheckedTargets": { # HealthCheckTargets describes endpoints to health-check when responding to Routing Policy queries. Only the healthy endpoints will be included in the response. Only one of internal_load_balancer and external_endpoints should be set. # Endpoints that are health checked before making the routing decision. The unhealthy endpoints are omitted from the result. If all endpoints within a bucket are unhealthy, we choose a different bucket (sampled with respect to its weight) for responding. If DNSSEC is enabled for this zone, only one of rrdata or health_checked_targets can be set. + "healthCheckedTargets": { # HealthCheckTargets describes endpoints to health-check when responding to Routing Policy queries. Only the healthy endpoints will be included in the response. # Endpoints that are health checked before making the routing decision. The unhealthy endpoints are omitted from the result. If all endpoints within a bucket are unhealthy, we choose a different bucket (sampled with respect to its weight) for responding. If DNSSEC is enabled for this zone, only one of `rrdata` or `health_checked_targets` can be set. "internalLoadBalancers": [ # Configuration for internal load balancers to be health checked. { # The configuration for an individual load balancer to health check. "ipAddress": "A String", # The frontend IP address of the load balancer to health check. "ipProtocol": "A String", # The protocol of the load balancer to health check. "kind": "dns#rRSetRoutingPolicyLoadBalancerTarget", "loadBalancerType": "A String", # The type of load balancer specified by this target. This value must match the configuration of the load balancer located at the LoadBalancerTarget's IP address, port, and region. Use the following: - *regionalL4ilb*: for a regional internal passthrough Network Load Balancer. - *regionalL7ilb*: for a regional internal Application Load Balancer. - *globalL7ilb*: for a global internal Application Load Balancer. - "networkUrl": "A String", # The fully qualified URL of the network that the load balancer is attached to. This should be formatted like https://www.googleapis.com/compute/v1/projects/{project}/global/networks/{network} . + "networkUrl": "A String", # The fully qualified URL of the network that the load balancer is attached to. This should be formatted like `https://www.googleapis.com/compute/v1/projects/{project}/global/networks/{network}`. "port": "A String", # The configured port of the load balancer. "project": "A String", # The project ID in which the load balancer is located. "region": "A String", # The region in which the load balancer is located. @@ -997,10 +991,10 @@

Method Details

"rrdatas": [ "A String", ], - "signatureRrdatas": [ # DNSSEC generated signatures for all the rrdata within this item. Note that if health checked targets are provided for DNSSEC enabled zones, there's a restriction of 1 IP address per item. + "signatureRrdatas": [ # DNSSEC generated signatures for all the `rrdata` within this item. Note that if health checked targets are provided for DNSSEC enabled zones, there's a restriction of 1 IP address per item. "A String", ], - "weight": 3.14, # The weight corresponding to this WrrPolicyItem object. When multiple WrrPolicyItem objects are configured, the probability of returning an WrrPolicyItem object's data is proportional to its weight relative to the sum of weights configured for all items. This weight must be non-negative. + "weight": 3.14, # The weight corresponding to this `WrrPolicyItem` object. When multiple `WrrPolicyItem` objects are configured, the probability of returning an `WrrPolicyItem` object's data is proportional to its weight relative to the sum of weights configured for all items. This weight must be non-negative. }, ], "kind": "dns#rRSetRoutingPolicyWrrPolicy", @@ -1012,7 +1006,7 @@

Method Details

"signatureRrdatas": [ # As defined in RFC 4034 (section 3.2). "A String", ], - "ttl": 42, # Number of seconds that this ResourceRecordSet can be cached by resolvers. + "ttl": 42, # Number of seconds that this `ResourceRecordSet` can be cached by resolvers. "type": "A String", # The identifier of a supported record type. See the list of Supported DNS record types. }, ], @@ -1042,19 +1036,19 @@

Method Details

{ # A unit of data that is returned by the DNS servers. "kind": "dns#resourceRecordSet", "name": "A String", # For example, www.example.com. - "routingPolicy": { # A RRSetRoutingPolicy represents ResourceRecordSet data that is returned dynamically with the response varying based on configured properties such as geolocation or by weighted random selection. # Configures dynamic query responses based on either the geo location of the querying user or a weighted round robin based routing policy. A valid ResourceRecordSet contains only rrdata (for static resolution) or a routing_policy (for dynamic resolution). - "geo": { # Configures a RRSetRoutingPolicy that routes based on the geo location of the querying user. + "routingPolicy": { # A RRSetRoutingPolicy represents ResourceRecordSet data that is returned dynamically with the response varying based on configured properties such as geolocation or by weighted random selection. # Configures dynamic query responses based on either the geo location of the querying user or a weighted round robin based routing policy. A valid `ResourceRecordSet` contains only `rrdata` (for static resolution) or a `routing_policy` (for dynamic resolution). + "geo": { # Configures a `RRSetRoutingPolicy` that routes based on the geo location of the querying user. "enableFencing": True or False, # Without fencing, if health check fails for all configured items in the current geo bucket, we failover to the next nearest geo bucket. With fencing, if health checking is enabled, as long as some targets in the current geo bucket are healthy, we return only the healthy targets. However, if all targets are unhealthy, we don't failover to the next nearest bucket; instead, we return all the items in the current bucket even when all targets are unhealthy. "items": [ # The primary geo routing configuration. If there are multiple items with the same location, an error is returned instead. { # ResourceRecordSet data for one geo location. - "healthCheckedTargets": { # HealthCheckTargets describes endpoints to health-check when responding to Routing Policy queries. Only the healthy endpoints will be included in the response. Only one of internal_load_balancer and external_endpoints should be set. # For A and AAAA types only. Endpoints to return in the query result only if they are healthy. These can be specified along with rrdata within this item. + "healthCheckedTargets": { # HealthCheckTargets describes endpoints to health-check when responding to Routing Policy queries. Only the healthy endpoints will be included in the response. # For A and AAAA types only. Endpoints to return in the query result only if they are healthy. These can be specified along with `rrdata` within this item. "internalLoadBalancers": [ # Configuration for internal load balancers to be health checked. { # The configuration for an individual load balancer to health check. "ipAddress": "A String", # The frontend IP address of the load balancer to health check. "ipProtocol": "A String", # The protocol of the load balancer to health check. "kind": "dns#rRSetRoutingPolicyLoadBalancerTarget", "loadBalancerType": "A String", # The type of load balancer specified by this target. This value must match the configuration of the load balancer located at the LoadBalancerTarget's IP address, port, and region. Use the following: - *regionalL4ilb*: for a regional internal passthrough Network Load Balancer. - *regionalL7ilb*: for a regional internal Application Load Balancer. - *globalL7ilb*: for a global internal Application Load Balancer. - "networkUrl": "A String", # The fully qualified URL of the network that the load balancer is attached to. This should be formatted like https://www.googleapis.com/compute/v1/projects/{project}/global/networks/{network} . + "networkUrl": "A String", # The fully qualified URL of the network that the load balancer is attached to. This should be formatted like `https://www.googleapis.com/compute/v1/projects/{project}/global/networks/{network}`. "port": "A String", # The configured port of the load balancer. "project": "A String", # The project ID in which the load balancer is located. "region": "A String", # The region in which the load balancer is located. @@ -1066,7 +1060,7 @@

Method Details

"rrdatas": [ "A String", ], - "signatureRrdatas": [ # DNSSEC generated signatures for all the rrdata within this item. If health checked targets are provided for DNSSEC enabled zones, there's a restriction of 1 IP address per item. + "signatureRrdatas": [ # DNSSEC generated signatures for all the `rrdata` within this item. If health checked targets are provided for DNSSEC enabled zones, there's a restriction of 1 IP address per item. "A String", ], }, @@ -1075,18 +1069,18 @@

Method Details

}, "kind": "dns#rRSetRoutingPolicy", "primaryBackup": { # Configures a RRSetRoutingPolicy such that all queries are responded with the primary_targets if they are healthy. And if all of them are unhealthy, then we fallback to a geo localized policy. - "backupGeoTargets": { # Configures a RRSetRoutingPolicy that routes based on the geo location of the querying user. # Backup targets provide a regional failover policy for the otherwise global primary targets. If serving state is set to BACKUP, this policy essentially becomes a geo routing policy. + "backupGeoTargets": { # Configures a `RRSetRoutingPolicy` that routes based on the geo location of the querying user. # Backup targets provide a regional failover policy for the otherwise global primary targets. If serving state is set to `BACKUP`, this policy essentially becomes a geo routing policy. "enableFencing": True or False, # Without fencing, if health check fails for all configured items in the current geo bucket, we failover to the next nearest geo bucket. With fencing, if health checking is enabled, as long as some targets in the current geo bucket are healthy, we return only the healthy targets. However, if all targets are unhealthy, we don't failover to the next nearest bucket; instead, we return all the items in the current bucket even when all targets are unhealthy. "items": [ # The primary geo routing configuration. If there are multiple items with the same location, an error is returned instead. { # ResourceRecordSet data for one geo location. - "healthCheckedTargets": { # HealthCheckTargets describes endpoints to health-check when responding to Routing Policy queries. Only the healthy endpoints will be included in the response. Only one of internal_load_balancer and external_endpoints should be set. # For A and AAAA types only. Endpoints to return in the query result only if they are healthy. These can be specified along with rrdata within this item. + "healthCheckedTargets": { # HealthCheckTargets describes endpoints to health-check when responding to Routing Policy queries. Only the healthy endpoints will be included in the response. # For A and AAAA types only. Endpoints to return in the query result only if they are healthy. These can be specified along with `rrdata` within this item. "internalLoadBalancers": [ # Configuration for internal load balancers to be health checked. { # The configuration for an individual load balancer to health check. "ipAddress": "A String", # The frontend IP address of the load balancer to health check. "ipProtocol": "A String", # The protocol of the load balancer to health check. "kind": "dns#rRSetRoutingPolicyLoadBalancerTarget", "loadBalancerType": "A String", # The type of load balancer specified by this target. This value must match the configuration of the load balancer located at the LoadBalancerTarget's IP address, port, and region. Use the following: - *regionalL4ilb*: for a regional internal passthrough Network Load Balancer. - *regionalL7ilb*: for a regional internal Application Load Balancer. - *globalL7ilb*: for a global internal Application Load Balancer. - "networkUrl": "A String", # The fully qualified URL of the network that the load balancer is attached to. This should be formatted like https://www.googleapis.com/compute/v1/projects/{project}/global/networks/{network} . + "networkUrl": "A String", # The fully qualified URL of the network that the load balancer is attached to. This should be formatted like `https://www.googleapis.com/compute/v1/projects/{project}/global/networks/{network}`. "port": "A String", # The configured port of the load balancer. "project": "A String", # The project ID in which the load balancer is located. "region": "A String", # The region in which the load balancer is located. @@ -1098,7 +1092,7 @@

Method Details

"rrdatas": [ "A String", ], - "signatureRrdatas": [ # DNSSEC generated signatures for all the rrdata within this item. If health checked targets are provided for DNSSEC enabled zones, there's a restriction of 1 IP address per item. + "signatureRrdatas": [ # DNSSEC generated signatures for all the `rrdata` within this item. If health checked targets are provided for DNSSEC enabled zones, there's a restriction of 1 IP address per item. "A String", ], }, @@ -1106,33 +1100,33 @@

Method Details

"kind": "dns#rRSetRoutingPolicyGeoPolicy", }, "kind": "dns#rRSetRoutingPolicyPrimaryBackupPolicy", - "primaryTargets": { # HealthCheckTargets describes endpoints to health-check when responding to Routing Policy queries. Only the healthy endpoints will be included in the response. Only one of internal_load_balancer and external_endpoints should be set. # Endpoints that are health checked before making the routing decision. Unhealthy endpoints are omitted from the results. If all endpoints are unhealthy, we serve a response based on the backup_geo_targets. + "primaryTargets": { # HealthCheckTargets describes endpoints to health-check when responding to Routing Policy queries. Only the healthy endpoints will be included in the response. # Endpoints that are health checked before making the routing decision. Unhealthy endpoints are omitted from the results. If all endpoints are unhealthy, we serve a response based on the `backup_geo_targets`. "internalLoadBalancers": [ # Configuration for internal load balancers to be health checked. { # The configuration for an individual load balancer to health check. "ipAddress": "A String", # The frontend IP address of the load balancer to health check. "ipProtocol": "A String", # The protocol of the load balancer to health check. "kind": "dns#rRSetRoutingPolicyLoadBalancerTarget", "loadBalancerType": "A String", # The type of load balancer specified by this target. This value must match the configuration of the load balancer located at the LoadBalancerTarget's IP address, port, and region. Use the following: - *regionalL4ilb*: for a regional internal passthrough Network Load Balancer. - *regionalL7ilb*: for a regional internal Application Load Balancer. - *globalL7ilb*: for a global internal Application Load Balancer. - "networkUrl": "A String", # The fully qualified URL of the network that the load balancer is attached to. This should be formatted like https://www.googleapis.com/compute/v1/projects/{project}/global/networks/{network} . + "networkUrl": "A String", # The fully qualified URL of the network that the load balancer is attached to. This should be formatted like `https://www.googleapis.com/compute/v1/projects/{project}/global/networks/{network}`. "port": "A String", # The configured port of the load balancer. "project": "A String", # The project ID in which the load balancer is located. "region": "A String", # The region in which the load balancer is located. }, ], }, - "trickleTraffic": 3.14, # When serving state is PRIMARY, this field provides the option of sending a small percentage of the traffic to the backup targets. + "trickleTraffic": 3.14, # When serving state is `PRIMARY`, this field provides the option of sending a small percentage of the traffic to the backup targets. }, "wrr": { # Configures a RRSetRoutingPolicy that routes in a weighted round robin fashion. "items": [ { # A routing block which contains the routing information for one WRR item. - "healthCheckedTargets": { # HealthCheckTargets describes endpoints to health-check when responding to Routing Policy queries. Only the healthy endpoints will be included in the response. Only one of internal_load_balancer and external_endpoints should be set. # Endpoints that are health checked before making the routing decision. The unhealthy endpoints are omitted from the result. If all endpoints within a bucket are unhealthy, we choose a different bucket (sampled with respect to its weight) for responding. If DNSSEC is enabled for this zone, only one of rrdata or health_checked_targets can be set. + "healthCheckedTargets": { # HealthCheckTargets describes endpoints to health-check when responding to Routing Policy queries. Only the healthy endpoints will be included in the response. # Endpoints that are health checked before making the routing decision. The unhealthy endpoints are omitted from the result. If all endpoints within a bucket are unhealthy, we choose a different bucket (sampled with respect to its weight) for responding. If DNSSEC is enabled for this zone, only one of `rrdata` or `health_checked_targets` can be set. "internalLoadBalancers": [ # Configuration for internal load balancers to be health checked. { # The configuration for an individual load balancer to health check. "ipAddress": "A String", # The frontend IP address of the load balancer to health check. "ipProtocol": "A String", # The protocol of the load balancer to health check. "kind": "dns#rRSetRoutingPolicyLoadBalancerTarget", "loadBalancerType": "A String", # The type of load balancer specified by this target. This value must match the configuration of the load balancer located at the LoadBalancerTarget's IP address, port, and region. Use the following: - *regionalL4ilb*: for a regional internal passthrough Network Load Balancer. - *regionalL7ilb*: for a regional internal Application Load Balancer. - *globalL7ilb*: for a global internal Application Load Balancer. - "networkUrl": "A String", # The fully qualified URL of the network that the load balancer is attached to. This should be formatted like https://www.googleapis.com/compute/v1/projects/{project}/global/networks/{network} . + "networkUrl": "A String", # The fully qualified URL of the network that the load balancer is attached to. This should be formatted like `https://www.googleapis.com/compute/v1/projects/{project}/global/networks/{network}`. "port": "A String", # The configured port of the load balancer. "project": "A String", # The project ID in which the load balancer is located. "region": "A String", # The region in which the load balancer is located. @@ -1143,10 +1137,10 @@

Method Details

"rrdatas": [ "A String", ], - "signatureRrdatas": [ # DNSSEC generated signatures for all the rrdata within this item. Note that if health checked targets are provided for DNSSEC enabled zones, there's a restriction of 1 IP address per item. + "signatureRrdatas": [ # DNSSEC generated signatures for all the `rrdata` within this item. Note that if health checked targets are provided for DNSSEC enabled zones, there's a restriction of 1 IP address per item. "A String", ], - "weight": 3.14, # The weight corresponding to this WrrPolicyItem object. When multiple WrrPolicyItem objects are configured, the probability of returning an WrrPolicyItem object's data is proportional to its weight relative to the sum of weights configured for all items. This weight must be non-negative. + "weight": 3.14, # The weight corresponding to this `WrrPolicyItem` object. When multiple `WrrPolicyItem` objects are configured, the probability of returning an `WrrPolicyItem` object's data is proportional to its weight relative to the sum of weights configured for all items. This weight must be non-negative. }, ], "kind": "dns#rRSetRoutingPolicyWrrPolicy", @@ -1158,7 +1152,7 @@

Method Details

"signatureRrdatas": [ # As defined in RFC 4034 (section 3.2). "A String", ], - "ttl": 42, # Number of seconds that this ResourceRecordSet can be cached by resolvers. + "ttl": 42, # Number of seconds that this `ResourceRecordSet` can be cached by resolvers. "type": "A String", # The identifier of a supported record type. See the list of Supported DNS record types. }, ], @@ -1176,9 +1170,6 @@

Method Details

An object of the form: { - "header": { # Elements common to every response. - "operationId": "A String", # For mutating operation requests that completed successfully. This is the client_operation_id if the client specified it, otherwise it is generated by the server (output only). - }, "responsePolicyRule": { # A Response Policy Rule is a selector that applies its behavior to queries that match the selector. Selectors are DNS names, which may be wildcards or exact matches. Each DNS query subject to a Response Policy matches at most one ResponsePolicyRule, as identified by the dns_name field with the longest matching suffix. "behavior": "A String", # Answer this query with a behavior rather than DNS data. "dnsName": "A String", # The DNS name (wildcard or exact) to apply this rule to. Must be unique within the Response Policy Rule. @@ -1188,19 +1179,19 @@

Method Details

{ # A unit of data that is returned by the DNS servers. "kind": "dns#resourceRecordSet", "name": "A String", # For example, www.example.com. - "routingPolicy": { # A RRSetRoutingPolicy represents ResourceRecordSet data that is returned dynamically with the response varying based on configured properties such as geolocation or by weighted random selection. # Configures dynamic query responses based on either the geo location of the querying user or a weighted round robin based routing policy. A valid ResourceRecordSet contains only rrdata (for static resolution) or a routing_policy (for dynamic resolution). - "geo": { # Configures a RRSetRoutingPolicy that routes based on the geo location of the querying user. + "routingPolicy": { # A RRSetRoutingPolicy represents ResourceRecordSet data that is returned dynamically with the response varying based on configured properties such as geolocation or by weighted random selection. # Configures dynamic query responses based on either the geo location of the querying user or a weighted round robin based routing policy. A valid `ResourceRecordSet` contains only `rrdata` (for static resolution) or a `routing_policy` (for dynamic resolution). + "geo": { # Configures a `RRSetRoutingPolicy` that routes based on the geo location of the querying user. "enableFencing": True or False, # Without fencing, if health check fails for all configured items in the current geo bucket, we failover to the next nearest geo bucket. With fencing, if health checking is enabled, as long as some targets in the current geo bucket are healthy, we return only the healthy targets. However, if all targets are unhealthy, we don't failover to the next nearest bucket; instead, we return all the items in the current bucket even when all targets are unhealthy. "items": [ # The primary geo routing configuration. If there are multiple items with the same location, an error is returned instead. { # ResourceRecordSet data for one geo location. - "healthCheckedTargets": { # HealthCheckTargets describes endpoints to health-check when responding to Routing Policy queries. Only the healthy endpoints will be included in the response. Only one of internal_load_balancer and external_endpoints should be set. # For A and AAAA types only. Endpoints to return in the query result only if they are healthy. These can be specified along with rrdata within this item. + "healthCheckedTargets": { # HealthCheckTargets describes endpoints to health-check when responding to Routing Policy queries. Only the healthy endpoints will be included in the response. # For A and AAAA types only. Endpoints to return in the query result only if they are healthy. These can be specified along with `rrdata` within this item. "internalLoadBalancers": [ # Configuration for internal load balancers to be health checked. { # The configuration for an individual load balancer to health check. "ipAddress": "A String", # The frontend IP address of the load balancer to health check. "ipProtocol": "A String", # The protocol of the load balancer to health check. "kind": "dns#rRSetRoutingPolicyLoadBalancerTarget", "loadBalancerType": "A String", # The type of load balancer specified by this target. This value must match the configuration of the load balancer located at the LoadBalancerTarget's IP address, port, and region. Use the following: - *regionalL4ilb*: for a regional internal passthrough Network Load Balancer. - *regionalL7ilb*: for a regional internal Application Load Balancer. - *globalL7ilb*: for a global internal Application Load Balancer. - "networkUrl": "A String", # The fully qualified URL of the network that the load balancer is attached to. This should be formatted like https://www.googleapis.com/compute/v1/projects/{project}/global/networks/{network} . + "networkUrl": "A String", # The fully qualified URL of the network that the load balancer is attached to. This should be formatted like `https://www.googleapis.com/compute/v1/projects/{project}/global/networks/{network}`. "port": "A String", # The configured port of the load balancer. "project": "A String", # The project ID in which the load balancer is located. "region": "A String", # The region in which the load balancer is located. @@ -1212,7 +1203,7 @@

Method Details

"rrdatas": [ "A String", ], - "signatureRrdatas": [ # DNSSEC generated signatures for all the rrdata within this item. If health checked targets are provided for DNSSEC enabled zones, there's a restriction of 1 IP address per item. + "signatureRrdatas": [ # DNSSEC generated signatures for all the `rrdata` within this item. If health checked targets are provided for DNSSEC enabled zones, there's a restriction of 1 IP address per item. "A String", ], }, @@ -1221,18 +1212,18 @@

Method Details

}, "kind": "dns#rRSetRoutingPolicy", "primaryBackup": { # Configures a RRSetRoutingPolicy such that all queries are responded with the primary_targets if they are healthy. And if all of them are unhealthy, then we fallback to a geo localized policy. - "backupGeoTargets": { # Configures a RRSetRoutingPolicy that routes based on the geo location of the querying user. # Backup targets provide a regional failover policy for the otherwise global primary targets. If serving state is set to BACKUP, this policy essentially becomes a geo routing policy. + "backupGeoTargets": { # Configures a `RRSetRoutingPolicy` that routes based on the geo location of the querying user. # Backup targets provide a regional failover policy for the otherwise global primary targets. If serving state is set to `BACKUP`, this policy essentially becomes a geo routing policy. "enableFencing": True or False, # Without fencing, if health check fails for all configured items in the current geo bucket, we failover to the next nearest geo bucket. With fencing, if health checking is enabled, as long as some targets in the current geo bucket are healthy, we return only the healthy targets. However, if all targets are unhealthy, we don't failover to the next nearest bucket; instead, we return all the items in the current bucket even when all targets are unhealthy. "items": [ # The primary geo routing configuration. If there are multiple items with the same location, an error is returned instead. { # ResourceRecordSet data for one geo location. - "healthCheckedTargets": { # HealthCheckTargets describes endpoints to health-check when responding to Routing Policy queries. Only the healthy endpoints will be included in the response. Only one of internal_load_balancer and external_endpoints should be set. # For A and AAAA types only. Endpoints to return in the query result only if they are healthy. These can be specified along with rrdata within this item. + "healthCheckedTargets": { # HealthCheckTargets describes endpoints to health-check when responding to Routing Policy queries. Only the healthy endpoints will be included in the response. # For A and AAAA types only. Endpoints to return in the query result only if they are healthy. These can be specified along with `rrdata` within this item. "internalLoadBalancers": [ # Configuration for internal load balancers to be health checked. { # The configuration for an individual load balancer to health check. "ipAddress": "A String", # The frontend IP address of the load balancer to health check. "ipProtocol": "A String", # The protocol of the load balancer to health check. "kind": "dns#rRSetRoutingPolicyLoadBalancerTarget", "loadBalancerType": "A String", # The type of load balancer specified by this target. This value must match the configuration of the load balancer located at the LoadBalancerTarget's IP address, port, and region. Use the following: - *regionalL4ilb*: for a regional internal passthrough Network Load Balancer. - *regionalL7ilb*: for a regional internal Application Load Balancer. - *globalL7ilb*: for a global internal Application Load Balancer. - "networkUrl": "A String", # The fully qualified URL of the network that the load balancer is attached to. This should be formatted like https://www.googleapis.com/compute/v1/projects/{project}/global/networks/{network} . + "networkUrl": "A String", # The fully qualified URL of the network that the load balancer is attached to. This should be formatted like `https://www.googleapis.com/compute/v1/projects/{project}/global/networks/{network}`. "port": "A String", # The configured port of the load balancer. "project": "A String", # The project ID in which the load balancer is located. "region": "A String", # The region in which the load balancer is located. @@ -1244,7 +1235,7 @@

Method Details

"rrdatas": [ "A String", ], - "signatureRrdatas": [ # DNSSEC generated signatures for all the rrdata within this item. If health checked targets are provided for DNSSEC enabled zones, there's a restriction of 1 IP address per item. + "signatureRrdatas": [ # DNSSEC generated signatures for all the `rrdata` within this item. If health checked targets are provided for DNSSEC enabled zones, there's a restriction of 1 IP address per item. "A String", ], }, @@ -1252,33 +1243,33 @@

Method Details

"kind": "dns#rRSetRoutingPolicyGeoPolicy", }, "kind": "dns#rRSetRoutingPolicyPrimaryBackupPolicy", - "primaryTargets": { # HealthCheckTargets describes endpoints to health-check when responding to Routing Policy queries. Only the healthy endpoints will be included in the response. Only one of internal_load_balancer and external_endpoints should be set. # Endpoints that are health checked before making the routing decision. Unhealthy endpoints are omitted from the results. If all endpoints are unhealthy, we serve a response based on the backup_geo_targets. + "primaryTargets": { # HealthCheckTargets describes endpoints to health-check when responding to Routing Policy queries. Only the healthy endpoints will be included in the response. # Endpoints that are health checked before making the routing decision. Unhealthy endpoints are omitted from the results. If all endpoints are unhealthy, we serve a response based on the `backup_geo_targets`. "internalLoadBalancers": [ # Configuration for internal load balancers to be health checked. { # The configuration for an individual load balancer to health check. "ipAddress": "A String", # The frontend IP address of the load balancer to health check. "ipProtocol": "A String", # The protocol of the load balancer to health check. "kind": "dns#rRSetRoutingPolicyLoadBalancerTarget", "loadBalancerType": "A String", # The type of load balancer specified by this target. This value must match the configuration of the load balancer located at the LoadBalancerTarget's IP address, port, and region. Use the following: - *regionalL4ilb*: for a regional internal passthrough Network Load Balancer. - *regionalL7ilb*: for a regional internal Application Load Balancer. - *globalL7ilb*: for a global internal Application Load Balancer. - "networkUrl": "A String", # The fully qualified URL of the network that the load balancer is attached to. This should be formatted like https://www.googleapis.com/compute/v1/projects/{project}/global/networks/{network} . + "networkUrl": "A String", # The fully qualified URL of the network that the load balancer is attached to. This should be formatted like `https://www.googleapis.com/compute/v1/projects/{project}/global/networks/{network}`. "port": "A String", # The configured port of the load balancer. "project": "A String", # The project ID in which the load balancer is located. "region": "A String", # The region in which the load balancer is located. }, ], }, - "trickleTraffic": 3.14, # When serving state is PRIMARY, this field provides the option of sending a small percentage of the traffic to the backup targets. + "trickleTraffic": 3.14, # When serving state is `PRIMARY`, this field provides the option of sending a small percentage of the traffic to the backup targets. }, "wrr": { # Configures a RRSetRoutingPolicy that routes in a weighted round robin fashion. "items": [ { # A routing block which contains the routing information for one WRR item. - "healthCheckedTargets": { # HealthCheckTargets describes endpoints to health-check when responding to Routing Policy queries. Only the healthy endpoints will be included in the response. Only one of internal_load_balancer and external_endpoints should be set. # Endpoints that are health checked before making the routing decision. The unhealthy endpoints are omitted from the result. If all endpoints within a bucket are unhealthy, we choose a different bucket (sampled with respect to its weight) for responding. If DNSSEC is enabled for this zone, only one of rrdata or health_checked_targets can be set. + "healthCheckedTargets": { # HealthCheckTargets describes endpoints to health-check when responding to Routing Policy queries. Only the healthy endpoints will be included in the response. # Endpoints that are health checked before making the routing decision. The unhealthy endpoints are omitted from the result. If all endpoints within a bucket are unhealthy, we choose a different bucket (sampled with respect to its weight) for responding. If DNSSEC is enabled for this zone, only one of `rrdata` or `health_checked_targets` can be set. "internalLoadBalancers": [ # Configuration for internal load balancers to be health checked. { # The configuration for an individual load balancer to health check. "ipAddress": "A String", # The frontend IP address of the load balancer to health check. "ipProtocol": "A String", # The protocol of the load balancer to health check. "kind": "dns#rRSetRoutingPolicyLoadBalancerTarget", "loadBalancerType": "A String", # The type of load balancer specified by this target. This value must match the configuration of the load balancer located at the LoadBalancerTarget's IP address, port, and region. Use the following: - *regionalL4ilb*: for a regional internal passthrough Network Load Balancer. - *regionalL7ilb*: for a regional internal Application Load Balancer. - *globalL7ilb*: for a global internal Application Load Balancer. - "networkUrl": "A String", # The fully qualified URL of the network that the load balancer is attached to. This should be formatted like https://www.googleapis.com/compute/v1/projects/{project}/global/networks/{network} . + "networkUrl": "A String", # The fully qualified URL of the network that the load balancer is attached to. This should be formatted like `https://www.googleapis.com/compute/v1/projects/{project}/global/networks/{network}`. "port": "A String", # The configured port of the load balancer. "project": "A String", # The project ID in which the load balancer is located. "region": "A String", # The region in which the load balancer is located. @@ -1289,10 +1280,10 @@

Method Details

"rrdatas": [ "A String", ], - "signatureRrdatas": [ # DNSSEC generated signatures for all the rrdata within this item. Note that if health checked targets are provided for DNSSEC enabled zones, there's a restriction of 1 IP address per item. + "signatureRrdatas": [ # DNSSEC generated signatures for all the `rrdata` within this item. Note that if health checked targets are provided for DNSSEC enabled zones, there's a restriction of 1 IP address per item. "A String", ], - "weight": 3.14, # The weight corresponding to this WrrPolicyItem object. When multiple WrrPolicyItem objects are configured, the probability of returning an WrrPolicyItem object's data is proportional to its weight relative to the sum of weights configured for all items. This weight must be non-negative. + "weight": 3.14, # The weight corresponding to this `WrrPolicyItem` object. When multiple `WrrPolicyItem` objects are configured, the probability of returning an `WrrPolicyItem` object's data is proportional to its weight relative to the sum of weights configured for all items. This weight must be non-negative. }, ], "kind": "dns#rRSetRoutingPolicyWrrPolicy", @@ -1304,7 +1295,7 @@

Method Details

"signatureRrdatas": [ # As defined in RFC 4034 (section 3.2). "A String", ], - "ttl": 42, # Number of seconds that this ResourceRecordSet can be cached by resolvers. + "ttl": 42, # Number of seconds that this `ResourceRecordSet` can be cached by resolvers. "type": "A String", # The identifier of a supported record type. See the list of Supported DNS record types. }, ], diff --git a/docs/dyn/dns_v1beta2.changes.html b/docs/dyn/dns_v1beta2.changes.html index ed511c20edd..2bbcf6d8310 100644 --- a/docs/dyn/dns_v1beta2.changes.html +++ b/docs/dyn/dns_v1beta2.changes.html @@ -105,24 +105,24 @@

Method Details

body: object, The request body. The object takes the form of: -{ # A Change represents a set of ResourceRecordSet additions and deletions applied atomically to a ManagedZone. ResourceRecordSets within a ManagedZone are modified by creating a new Change element in the Changes collection. In turn the Changes collection also records the past modifications to the ResourceRecordSets in a ManagedZone. The current state of the ManagedZone is the sum effect of applying all Change elements in the Changes collection in sequence. +{ # A Change represents a set of `ResourceRecordSet` additions and deletions applied atomically to a ManagedZone. ResourceRecordSets within a ManagedZone are modified by creating a new Change element in the Changes collection. In turn the Changes collection also records the past modifications to the `ResourceRecordSets` in a `ManagedZone`. The current state of the `ManagedZone` is the sum effect of applying all `Change` elements in the `Changes` collection in sequence. "additions": [ # Which ResourceRecordSets to add? { # A unit of data that is returned by the DNS servers. "kind": "dns#resourceRecordSet", "name": "A String", # For example, www.example.com. - "routingPolicy": { # A RRSetRoutingPolicy represents ResourceRecordSet data that is returned dynamically with the response varying based on configured properties such as geolocation or by weighted random selection. # Configures dynamic query responses based on either the geo location of the querying user or a weighted round robin based routing policy. A valid ResourceRecordSet contains only rrdata (for static resolution) or a routing_policy (for dynamic resolution). - "geo": { # Configures a RRSetRoutingPolicy that routes based on the geo location of the querying user. + "routingPolicy": { # A RRSetRoutingPolicy represents ResourceRecordSet data that is returned dynamically with the response varying based on configured properties such as geolocation or by weighted random selection. # Configures dynamic query responses based on either the geo location of the querying user or a weighted round robin based routing policy. A valid `ResourceRecordSet` contains only `rrdata` (for static resolution) or a `routing_policy` (for dynamic resolution). + "geo": { # Configures a `RRSetRoutingPolicy` that routes based on the geo location of the querying user. "enableFencing": True or False, # Without fencing, if health check fails for all configured items in the current geo bucket, we failover to the next nearest geo bucket. With fencing, if health checking is enabled, as long as some targets in the current geo bucket are healthy, we return only the healthy targets. However, if all targets are unhealthy, we don't failover to the next nearest bucket; instead, we return all the items in the current bucket even when all targets are unhealthy. "items": [ # The primary geo routing configuration. If there are multiple items with the same location, an error is returned instead. { # ResourceRecordSet data for one geo location. - "healthCheckedTargets": { # HealthCheckTargets describes endpoints to health-check when responding to Routing Policy queries. Only the healthy endpoints will be included in the response. Only one of internal_load_balancer and external_endpoints should be set. # For A and AAAA types only. Endpoints to return in the query result only if they are healthy. These can be specified along with rrdata within this item. + "healthCheckedTargets": { # HealthCheckTargets describes endpoints to health-check when responding to Routing Policy queries. Only the healthy endpoints will be included in the response. # For A and AAAA types only. Endpoints to return in the query result only if they are healthy. These can be specified along with `rrdata` within this item. "internalLoadBalancers": [ # Configuration for internal load balancers to be health checked. { # The configuration for an individual load balancer to health check. "ipAddress": "A String", # The frontend IP address of the load balancer to health check. "ipProtocol": "A String", # The protocol of the load balancer to health check. "kind": "dns#rRSetRoutingPolicyLoadBalancerTarget", "loadBalancerType": "A String", # The type of load balancer specified by this target. This value must match the configuration of the load balancer located at the LoadBalancerTarget's IP address, port, and region. Use the following: - *regionalL4ilb*: for a regional internal passthrough Network Load Balancer. - *regionalL7ilb*: for a regional internal Application Load Balancer. - *globalL7ilb*: for a global internal Application Load Balancer. - "networkUrl": "A String", # The fully qualified URL of the network that the load balancer is attached to. This should be formatted like https://www.googleapis.com/compute/v1/projects/{project}/global/networks/{network} . + "networkUrl": "A String", # The fully qualified URL of the network that the load balancer is attached to. This should be formatted like `https://www.googleapis.com/compute/v1/projects/{project}/global/networks/{network}`. "port": "A String", # The configured port of the load balancer. "project": "A String", # The project ID in which the load balancer is located. "region": "A String", # The region in which the load balancer is located. @@ -134,25 +134,25 @@

Method Details

"rrdatas": [ "A String", ], - "signatureRrdatas": [ # DNSSEC generated signatures for all the rrdata within this item. If health checked targets are provided for DNSSEC enabled zones, there's a restriction of 1 IP address per item. + "signatureRrdatas": [ # DNSSEC generated signatures for all the `rrdata` within this item. If health checked targets are provided for DNSSEC enabled zones, there's a restriction of 1 IP address per item. "A String", ], }, ], "kind": "dns#rRSetRoutingPolicyGeoPolicy", }, - "geoPolicy": { # Configures a RRSetRoutingPolicy that routes based on the geo location of the querying user. + "geoPolicy": { # Configures a `RRSetRoutingPolicy` that routes based on the geo location of the querying user. "enableFencing": True or False, # Without fencing, if health check fails for all configured items in the current geo bucket, we failover to the next nearest geo bucket. With fencing, if health checking is enabled, as long as some targets in the current geo bucket are healthy, we return only the healthy targets. However, if all targets are unhealthy, we don't failover to the next nearest bucket; instead, we return all the items in the current bucket even when all targets are unhealthy. "items": [ # The primary geo routing configuration. If there are multiple items with the same location, an error is returned instead. { # ResourceRecordSet data for one geo location. - "healthCheckedTargets": { # HealthCheckTargets describes endpoints to health-check when responding to Routing Policy queries. Only the healthy endpoints will be included in the response. Only one of internal_load_balancer and external_endpoints should be set. # For A and AAAA types only. Endpoints to return in the query result only if they are healthy. These can be specified along with rrdata within this item. + "healthCheckedTargets": { # HealthCheckTargets describes endpoints to health-check when responding to Routing Policy queries. Only the healthy endpoints will be included in the response. # For A and AAAA types only. Endpoints to return in the query result only if they are healthy. These can be specified along with `rrdata` within this item. "internalLoadBalancers": [ # Configuration for internal load balancers to be health checked. { # The configuration for an individual load balancer to health check. "ipAddress": "A String", # The frontend IP address of the load balancer to health check. "ipProtocol": "A String", # The protocol of the load balancer to health check. "kind": "dns#rRSetRoutingPolicyLoadBalancerTarget", "loadBalancerType": "A String", # The type of load balancer specified by this target. This value must match the configuration of the load balancer located at the LoadBalancerTarget's IP address, port, and region. Use the following: - *regionalL4ilb*: for a regional internal passthrough Network Load Balancer. - *regionalL7ilb*: for a regional internal Application Load Balancer. - *globalL7ilb*: for a global internal Application Load Balancer. - "networkUrl": "A String", # The fully qualified URL of the network that the load balancer is attached to. This should be formatted like https://www.googleapis.com/compute/v1/projects/{project}/global/networks/{network} . + "networkUrl": "A String", # The fully qualified URL of the network that the load balancer is attached to. This should be formatted like `https://www.googleapis.com/compute/v1/projects/{project}/global/networks/{network}`. "port": "A String", # The configured port of the load balancer. "project": "A String", # The project ID in which the load balancer is located. "region": "A String", # The region in which the load balancer is located. @@ -164,7 +164,7 @@

Method Details

"rrdatas": [ "A String", ], - "signatureRrdatas": [ # DNSSEC generated signatures for all the rrdata within this item. If health checked targets are provided for DNSSEC enabled zones, there's a restriction of 1 IP address per item. + "signatureRrdatas": [ # DNSSEC generated signatures for all the `rrdata` within this item. If health checked targets are provided for DNSSEC enabled zones, there's a restriction of 1 IP address per item. "A String", ], }, @@ -173,18 +173,18 @@

Method Details

}, "kind": "dns#rRSetRoutingPolicy", "primaryBackup": { # Configures a RRSetRoutingPolicy such that all queries are responded with the primary_targets if they are healthy. And if all of them are unhealthy, then we fallback to a geo localized policy. - "backupGeoTargets": { # Configures a RRSetRoutingPolicy that routes based on the geo location of the querying user. # Backup targets provide a regional failover policy for the otherwise global primary targets. If serving state is set to BACKUP, this policy essentially becomes a geo routing policy. + "backupGeoTargets": { # Configures a `RRSetRoutingPolicy` that routes based on the geo location of the querying user. # Backup targets provide a regional failover policy for the otherwise global primary targets. If serving state is set to `BACKUP`, this policy essentially becomes a geo routing policy. "enableFencing": True or False, # Without fencing, if health check fails for all configured items in the current geo bucket, we failover to the next nearest geo bucket. With fencing, if health checking is enabled, as long as some targets in the current geo bucket are healthy, we return only the healthy targets. However, if all targets are unhealthy, we don't failover to the next nearest bucket; instead, we return all the items in the current bucket even when all targets are unhealthy. "items": [ # The primary geo routing configuration. If there are multiple items with the same location, an error is returned instead. { # ResourceRecordSet data for one geo location. - "healthCheckedTargets": { # HealthCheckTargets describes endpoints to health-check when responding to Routing Policy queries. Only the healthy endpoints will be included in the response. Only one of internal_load_balancer and external_endpoints should be set. # For A and AAAA types only. Endpoints to return in the query result only if they are healthy. These can be specified along with rrdata within this item. + "healthCheckedTargets": { # HealthCheckTargets describes endpoints to health-check when responding to Routing Policy queries. Only the healthy endpoints will be included in the response. # For A and AAAA types only. Endpoints to return in the query result only if they are healthy. These can be specified along with `rrdata` within this item. "internalLoadBalancers": [ # Configuration for internal load balancers to be health checked. { # The configuration for an individual load balancer to health check. "ipAddress": "A String", # The frontend IP address of the load balancer to health check. "ipProtocol": "A String", # The protocol of the load balancer to health check. "kind": "dns#rRSetRoutingPolicyLoadBalancerTarget", "loadBalancerType": "A String", # The type of load balancer specified by this target. This value must match the configuration of the load balancer located at the LoadBalancerTarget's IP address, port, and region. Use the following: - *regionalL4ilb*: for a regional internal passthrough Network Load Balancer. - *regionalL7ilb*: for a regional internal Application Load Balancer. - *globalL7ilb*: for a global internal Application Load Balancer. - "networkUrl": "A String", # The fully qualified URL of the network that the load balancer is attached to. This should be formatted like https://www.googleapis.com/compute/v1/projects/{project}/global/networks/{network} . + "networkUrl": "A String", # The fully qualified URL of the network that the load balancer is attached to. This should be formatted like `https://www.googleapis.com/compute/v1/projects/{project}/global/networks/{network}`. "port": "A String", # The configured port of the load balancer. "project": "A String", # The project ID in which the load balancer is located. "region": "A String", # The region in which the load balancer is located. @@ -196,7 +196,7 @@

Method Details

"rrdatas": [ "A String", ], - "signatureRrdatas": [ # DNSSEC generated signatures for all the rrdata within this item. If health checked targets are provided for DNSSEC enabled zones, there's a restriction of 1 IP address per item. + "signatureRrdatas": [ # DNSSEC generated signatures for all the `rrdata` within this item. If health checked targets are provided for DNSSEC enabled zones, there's a restriction of 1 IP address per item. "A String", ], }, @@ -204,33 +204,33 @@

Method Details

"kind": "dns#rRSetRoutingPolicyGeoPolicy", }, "kind": "dns#rRSetRoutingPolicyPrimaryBackupPolicy", - "primaryTargets": { # HealthCheckTargets describes endpoints to health-check when responding to Routing Policy queries. Only the healthy endpoints will be included in the response. Only one of internal_load_balancer and external_endpoints should be set. # Endpoints that are health checked before making the routing decision. Unhealthy endpoints are omitted from the results. If all endpoints are unhealthy, we serve a response based on the backup_geo_targets. + "primaryTargets": { # HealthCheckTargets describes endpoints to health-check when responding to Routing Policy queries. Only the healthy endpoints will be included in the response. # Endpoints that are health checked before making the routing decision. Unhealthy endpoints are omitted from the results. If all endpoints are unhealthy, we serve a response based on the `backup_geo_targets`. "internalLoadBalancers": [ # Configuration for internal load balancers to be health checked. { # The configuration for an individual load balancer to health check. "ipAddress": "A String", # The frontend IP address of the load balancer to health check. "ipProtocol": "A String", # The protocol of the load balancer to health check. "kind": "dns#rRSetRoutingPolicyLoadBalancerTarget", "loadBalancerType": "A String", # The type of load balancer specified by this target. This value must match the configuration of the load balancer located at the LoadBalancerTarget's IP address, port, and region. Use the following: - *regionalL4ilb*: for a regional internal passthrough Network Load Balancer. - *regionalL7ilb*: for a regional internal Application Load Balancer. - *globalL7ilb*: for a global internal Application Load Balancer. - "networkUrl": "A String", # The fully qualified URL of the network that the load balancer is attached to. This should be formatted like https://www.googleapis.com/compute/v1/projects/{project}/global/networks/{network} . + "networkUrl": "A String", # The fully qualified URL of the network that the load balancer is attached to. This should be formatted like `https://www.googleapis.com/compute/v1/projects/{project}/global/networks/{network}`. "port": "A String", # The configured port of the load balancer. "project": "A String", # The project ID in which the load balancer is located. "region": "A String", # The region in which the load balancer is located. }, ], }, - "trickleTraffic": 3.14, # When serving state is PRIMARY, this field provides the option of sending a small percentage of the traffic to the backup targets. + "trickleTraffic": 3.14, # When serving state is `PRIMARY`, this field provides the option of sending a small percentage of the traffic to the backup targets. }, "wrr": { # Configures a RRSetRoutingPolicy that routes in a weighted round robin fashion. "items": [ { # A routing block which contains the routing information for one WRR item. - "healthCheckedTargets": { # HealthCheckTargets describes endpoints to health-check when responding to Routing Policy queries. Only the healthy endpoints will be included in the response. Only one of internal_load_balancer and external_endpoints should be set. # Endpoints that are health checked before making the routing decision. The unhealthy endpoints are omitted from the result. If all endpoints within a bucket are unhealthy, we choose a different bucket (sampled with respect to its weight) for responding. If DNSSEC is enabled for this zone, only one of rrdata or health_checked_targets can be set. + "healthCheckedTargets": { # HealthCheckTargets describes endpoints to health-check when responding to Routing Policy queries. Only the healthy endpoints will be included in the response. # Endpoints that are health checked before making the routing decision. The unhealthy endpoints are omitted from the result. If all endpoints within a bucket are unhealthy, we choose a different bucket (sampled with respect to its weight) for responding. If DNSSEC is enabled for this zone, only one of `rrdata` or `health_checked_targets` can be set. "internalLoadBalancers": [ # Configuration for internal load balancers to be health checked. { # The configuration for an individual load balancer to health check. "ipAddress": "A String", # The frontend IP address of the load balancer to health check. "ipProtocol": "A String", # The protocol of the load balancer to health check. "kind": "dns#rRSetRoutingPolicyLoadBalancerTarget", "loadBalancerType": "A String", # The type of load balancer specified by this target. This value must match the configuration of the load balancer located at the LoadBalancerTarget's IP address, port, and region. Use the following: - *regionalL4ilb*: for a regional internal passthrough Network Load Balancer. - *regionalL7ilb*: for a regional internal Application Load Balancer. - *globalL7ilb*: for a global internal Application Load Balancer. - "networkUrl": "A String", # The fully qualified URL of the network that the load balancer is attached to. This should be formatted like https://www.googleapis.com/compute/v1/projects/{project}/global/networks/{network} . + "networkUrl": "A String", # The fully qualified URL of the network that the load balancer is attached to. This should be formatted like `https://www.googleapis.com/compute/v1/projects/{project}/global/networks/{network}`. "port": "A String", # The configured port of the load balancer. "project": "A String", # The project ID in which the load balancer is located. "region": "A String", # The region in which the load balancer is located. @@ -241,10 +241,10 @@

Method Details

"rrdatas": [ "A String", ], - "signatureRrdatas": [ # DNSSEC generated signatures for all the rrdata within this item. Note that if health checked targets are provided for DNSSEC enabled zones, there's a restriction of 1 IP address per item. + "signatureRrdatas": [ # DNSSEC generated signatures for all the `rrdata` within this item. Note that if health checked targets are provided for DNSSEC enabled zones, there's a restriction of 1 IP address per item. "A String", ], - "weight": 3.14, # The weight corresponding to this WrrPolicyItem object. When multiple WrrPolicyItem objects are configured, the probability of returning an WrrPolicyItem object's data is proportional to its weight relative to the sum of weights configured for all items. This weight must be non-negative. + "weight": 3.14, # The weight corresponding to this `WrrPolicyItem` object. When multiple `WrrPolicyItem` objects are configured, the probability of returning an `WrrPolicyItem` object's data is proportional to its weight relative to the sum of weights configured for all items. This weight must be non-negative. }, ], "kind": "dns#rRSetRoutingPolicyWrrPolicy", @@ -252,14 +252,14 @@

Method Details

"wrrPolicy": { # Configures a RRSetRoutingPolicy that routes in a weighted round robin fashion. "items": [ { # A routing block which contains the routing information for one WRR item. - "healthCheckedTargets": { # HealthCheckTargets describes endpoints to health-check when responding to Routing Policy queries. Only the healthy endpoints will be included in the response. Only one of internal_load_balancer and external_endpoints should be set. # Endpoints that are health checked before making the routing decision. The unhealthy endpoints are omitted from the result. If all endpoints within a bucket are unhealthy, we choose a different bucket (sampled with respect to its weight) for responding. If DNSSEC is enabled for this zone, only one of rrdata or health_checked_targets can be set. + "healthCheckedTargets": { # HealthCheckTargets describes endpoints to health-check when responding to Routing Policy queries. Only the healthy endpoints will be included in the response. # Endpoints that are health checked before making the routing decision. The unhealthy endpoints are omitted from the result. If all endpoints within a bucket are unhealthy, we choose a different bucket (sampled with respect to its weight) for responding. If DNSSEC is enabled for this zone, only one of `rrdata` or `health_checked_targets` can be set. "internalLoadBalancers": [ # Configuration for internal load balancers to be health checked. { # The configuration for an individual load balancer to health check. "ipAddress": "A String", # The frontend IP address of the load balancer to health check. "ipProtocol": "A String", # The protocol of the load balancer to health check. "kind": "dns#rRSetRoutingPolicyLoadBalancerTarget", "loadBalancerType": "A String", # The type of load balancer specified by this target. This value must match the configuration of the load balancer located at the LoadBalancerTarget's IP address, port, and region. Use the following: - *regionalL4ilb*: for a regional internal passthrough Network Load Balancer. - *regionalL7ilb*: for a regional internal Application Load Balancer. - *globalL7ilb*: for a global internal Application Load Balancer. - "networkUrl": "A String", # The fully qualified URL of the network that the load balancer is attached to. This should be formatted like https://www.googleapis.com/compute/v1/projects/{project}/global/networks/{network} . + "networkUrl": "A String", # The fully qualified URL of the network that the load balancer is attached to. This should be formatted like `https://www.googleapis.com/compute/v1/projects/{project}/global/networks/{network}`. "port": "A String", # The configured port of the load balancer. "project": "A String", # The project ID in which the load balancer is located. "region": "A String", # The region in which the load balancer is located. @@ -270,10 +270,10 @@

Method Details

"rrdatas": [ "A String", ], - "signatureRrdatas": [ # DNSSEC generated signatures for all the rrdata within this item. Note that if health checked targets are provided for DNSSEC enabled zones, there's a restriction of 1 IP address per item. + "signatureRrdatas": [ # DNSSEC generated signatures for all the `rrdata` within this item. Note that if health checked targets are provided for DNSSEC enabled zones, there's a restriction of 1 IP address per item. "A String", ], - "weight": 3.14, # The weight corresponding to this WrrPolicyItem object. When multiple WrrPolicyItem objects are configured, the probability of returning an WrrPolicyItem object's data is proportional to its weight relative to the sum of weights configured for all items. This weight must be non-negative. + "weight": 3.14, # The weight corresponding to this `WrrPolicyItem` object. When multiple `WrrPolicyItem` objects are configured, the probability of returning an `WrrPolicyItem` object's data is proportional to its weight relative to the sum of weights configured for all items. This weight must be non-negative. }, ], "kind": "dns#rRSetRoutingPolicyWrrPolicy", @@ -285,7 +285,7 @@

Method Details

"signatureRrdatas": [ # As defined in RFC 4034 (section 3.2). "A String", ], - "ttl": 42, # Number of seconds that this ResourceRecordSet can be cached by resolvers. + "ttl": 42, # Number of seconds that this `ResourceRecordSet` can be cached by resolvers. "type": "A String", # The identifier of a supported record type. See the list of Supported DNS record types. }, ], @@ -293,19 +293,19 @@

Method Details

{ # A unit of data that is returned by the DNS servers. "kind": "dns#resourceRecordSet", "name": "A String", # For example, www.example.com. - "routingPolicy": { # A RRSetRoutingPolicy represents ResourceRecordSet data that is returned dynamically with the response varying based on configured properties such as geolocation or by weighted random selection. # Configures dynamic query responses based on either the geo location of the querying user or a weighted round robin based routing policy. A valid ResourceRecordSet contains only rrdata (for static resolution) or a routing_policy (for dynamic resolution). - "geo": { # Configures a RRSetRoutingPolicy that routes based on the geo location of the querying user. + "routingPolicy": { # A RRSetRoutingPolicy represents ResourceRecordSet data that is returned dynamically with the response varying based on configured properties such as geolocation or by weighted random selection. # Configures dynamic query responses based on either the geo location of the querying user or a weighted round robin based routing policy. A valid `ResourceRecordSet` contains only `rrdata` (for static resolution) or a `routing_policy` (for dynamic resolution). + "geo": { # Configures a `RRSetRoutingPolicy` that routes based on the geo location of the querying user. "enableFencing": True or False, # Without fencing, if health check fails for all configured items in the current geo bucket, we failover to the next nearest geo bucket. With fencing, if health checking is enabled, as long as some targets in the current geo bucket are healthy, we return only the healthy targets. However, if all targets are unhealthy, we don't failover to the next nearest bucket; instead, we return all the items in the current bucket even when all targets are unhealthy. "items": [ # The primary geo routing configuration. If there are multiple items with the same location, an error is returned instead. { # ResourceRecordSet data for one geo location. - "healthCheckedTargets": { # HealthCheckTargets describes endpoints to health-check when responding to Routing Policy queries. Only the healthy endpoints will be included in the response. Only one of internal_load_balancer and external_endpoints should be set. # For A and AAAA types only. Endpoints to return in the query result only if they are healthy. These can be specified along with rrdata within this item. + "healthCheckedTargets": { # HealthCheckTargets describes endpoints to health-check when responding to Routing Policy queries. Only the healthy endpoints will be included in the response. # For A and AAAA types only. Endpoints to return in the query result only if they are healthy. These can be specified along with `rrdata` within this item. "internalLoadBalancers": [ # Configuration for internal load balancers to be health checked. { # The configuration for an individual load balancer to health check. "ipAddress": "A String", # The frontend IP address of the load balancer to health check. "ipProtocol": "A String", # The protocol of the load balancer to health check. "kind": "dns#rRSetRoutingPolicyLoadBalancerTarget", "loadBalancerType": "A String", # The type of load balancer specified by this target. This value must match the configuration of the load balancer located at the LoadBalancerTarget's IP address, port, and region. Use the following: - *regionalL4ilb*: for a regional internal passthrough Network Load Balancer. - *regionalL7ilb*: for a regional internal Application Load Balancer. - *globalL7ilb*: for a global internal Application Load Balancer. - "networkUrl": "A String", # The fully qualified URL of the network that the load balancer is attached to. This should be formatted like https://www.googleapis.com/compute/v1/projects/{project}/global/networks/{network} . + "networkUrl": "A String", # The fully qualified URL of the network that the load balancer is attached to. This should be formatted like `https://www.googleapis.com/compute/v1/projects/{project}/global/networks/{network}`. "port": "A String", # The configured port of the load balancer. "project": "A String", # The project ID in which the load balancer is located. "region": "A String", # The region in which the load balancer is located. @@ -317,25 +317,25 @@

Method Details

"rrdatas": [ "A String", ], - "signatureRrdatas": [ # DNSSEC generated signatures for all the rrdata within this item. If health checked targets are provided for DNSSEC enabled zones, there's a restriction of 1 IP address per item. + "signatureRrdatas": [ # DNSSEC generated signatures for all the `rrdata` within this item. If health checked targets are provided for DNSSEC enabled zones, there's a restriction of 1 IP address per item. "A String", ], }, ], "kind": "dns#rRSetRoutingPolicyGeoPolicy", }, - "geoPolicy": { # Configures a RRSetRoutingPolicy that routes based on the geo location of the querying user. + "geoPolicy": { # Configures a `RRSetRoutingPolicy` that routes based on the geo location of the querying user. "enableFencing": True or False, # Without fencing, if health check fails for all configured items in the current geo bucket, we failover to the next nearest geo bucket. With fencing, if health checking is enabled, as long as some targets in the current geo bucket are healthy, we return only the healthy targets. However, if all targets are unhealthy, we don't failover to the next nearest bucket; instead, we return all the items in the current bucket even when all targets are unhealthy. "items": [ # The primary geo routing configuration. If there are multiple items with the same location, an error is returned instead. { # ResourceRecordSet data for one geo location. - "healthCheckedTargets": { # HealthCheckTargets describes endpoints to health-check when responding to Routing Policy queries. Only the healthy endpoints will be included in the response. Only one of internal_load_balancer and external_endpoints should be set. # For A and AAAA types only. Endpoints to return in the query result only if they are healthy. These can be specified along with rrdata within this item. + "healthCheckedTargets": { # HealthCheckTargets describes endpoints to health-check when responding to Routing Policy queries. Only the healthy endpoints will be included in the response. # For A and AAAA types only. Endpoints to return in the query result only if they are healthy. These can be specified along with `rrdata` within this item. "internalLoadBalancers": [ # Configuration for internal load balancers to be health checked. { # The configuration for an individual load balancer to health check. "ipAddress": "A String", # The frontend IP address of the load balancer to health check. "ipProtocol": "A String", # The protocol of the load balancer to health check. "kind": "dns#rRSetRoutingPolicyLoadBalancerTarget", "loadBalancerType": "A String", # The type of load balancer specified by this target. This value must match the configuration of the load balancer located at the LoadBalancerTarget's IP address, port, and region. Use the following: - *regionalL4ilb*: for a regional internal passthrough Network Load Balancer. - *regionalL7ilb*: for a regional internal Application Load Balancer. - *globalL7ilb*: for a global internal Application Load Balancer. - "networkUrl": "A String", # The fully qualified URL of the network that the load balancer is attached to. This should be formatted like https://www.googleapis.com/compute/v1/projects/{project}/global/networks/{network} . + "networkUrl": "A String", # The fully qualified URL of the network that the load balancer is attached to. This should be formatted like `https://www.googleapis.com/compute/v1/projects/{project}/global/networks/{network}`. "port": "A String", # The configured port of the load balancer. "project": "A String", # The project ID in which the load balancer is located. "region": "A String", # The region in which the load balancer is located. @@ -347,7 +347,7 @@

Method Details

"rrdatas": [ "A String", ], - "signatureRrdatas": [ # DNSSEC generated signatures for all the rrdata within this item. If health checked targets are provided for DNSSEC enabled zones, there's a restriction of 1 IP address per item. + "signatureRrdatas": [ # DNSSEC generated signatures for all the `rrdata` within this item. If health checked targets are provided for DNSSEC enabled zones, there's a restriction of 1 IP address per item. "A String", ], }, @@ -356,18 +356,18 @@

Method Details

}, "kind": "dns#rRSetRoutingPolicy", "primaryBackup": { # Configures a RRSetRoutingPolicy such that all queries are responded with the primary_targets if they are healthy. And if all of them are unhealthy, then we fallback to a geo localized policy. - "backupGeoTargets": { # Configures a RRSetRoutingPolicy that routes based on the geo location of the querying user. # Backup targets provide a regional failover policy for the otherwise global primary targets. If serving state is set to BACKUP, this policy essentially becomes a geo routing policy. + "backupGeoTargets": { # Configures a `RRSetRoutingPolicy` that routes based on the geo location of the querying user. # Backup targets provide a regional failover policy for the otherwise global primary targets. If serving state is set to `BACKUP`, this policy essentially becomes a geo routing policy. "enableFencing": True or False, # Without fencing, if health check fails for all configured items in the current geo bucket, we failover to the next nearest geo bucket. With fencing, if health checking is enabled, as long as some targets in the current geo bucket are healthy, we return only the healthy targets. However, if all targets are unhealthy, we don't failover to the next nearest bucket; instead, we return all the items in the current bucket even when all targets are unhealthy. "items": [ # The primary geo routing configuration. If there are multiple items with the same location, an error is returned instead. { # ResourceRecordSet data for one geo location. - "healthCheckedTargets": { # HealthCheckTargets describes endpoints to health-check when responding to Routing Policy queries. Only the healthy endpoints will be included in the response. Only one of internal_load_balancer and external_endpoints should be set. # For A and AAAA types only. Endpoints to return in the query result only if they are healthy. These can be specified along with rrdata within this item. + "healthCheckedTargets": { # HealthCheckTargets describes endpoints to health-check when responding to Routing Policy queries. Only the healthy endpoints will be included in the response. # For A and AAAA types only. Endpoints to return in the query result only if they are healthy. These can be specified along with `rrdata` within this item. "internalLoadBalancers": [ # Configuration for internal load balancers to be health checked. { # The configuration for an individual load balancer to health check. "ipAddress": "A String", # The frontend IP address of the load balancer to health check. "ipProtocol": "A String", # The protocol of the load balancer to health check. "kind": "dns#rRSetRoutingPolicyLoadBalancerTarget", "loadBalancerType": "A String", # The type of load balancer specified by this target. This value must match the configuration of the load balancer located at the LoadBalancerTarget's IP address, port, and region. Use the following: - *regionalL4ilb*: for a regional internal passthrough Network Load Balancer. - *regionalL7ilb*: for a regional internal Application Load Balancer. - *globalL7ilb*: for a global internal Application Load Balancer. - "networkUrl": "A String", # The fully qualified URL of the network that the load balancer is attached to. This should be formatted like https://www.googleapis.com/compute/v1/projects/{project}/global/networks/{network} . + "networkUrl": "A String", # The fully qualified URL of the network that the load balancer is attached to. This should be formatted like `https://www.googleapis.com/compute/v1/projects/{project}/global/networks/{network}`. "port": "A String", # The configured port of the load balancer. "project": "A String", # The project ID in which the load balancer is located. "region": "A String", # The region in which the load balancer is located. @@ -379,7 +379,7 @@

Method Details

"rrdatas": [ "A String", ], - "signatureRrdatas": [ # DNSSEC generated signatures for all the rrdata within this item. If health checked targets are provided for DNSSEC enabled zones, there's a restriction of 1 IP address per item. + "signatureRrdatas": [ # DNSSEC generated signatures for all the `rrdata` within this item. If health checked targets are provided for DNSSEC enabled zones, there's a restriction of 1 IP address per item. "A String", ], }, @@ -387,33 +387,33 @@

Method Details

"kind": "dns#rRSetRoutingPolicyGeoPolicy", }, "kind": "dns#rRSetRoutingPolicyPrimaryBackupPolicy", - "primaryTargets": { # HealthCheckTargets describes endpoints to health-check when responding to Routing Policy queries. Only the healthy endpoints will be included in the response. Only one of internal_load_balancer and external_endpoints should be set. # Endpoints that are health checked before making the routing decision. Unhealthy endpoints are omitted from the results. If all endpoints are unhealthy, we serve a response based on the backup_geo_targets. + "primaryTargets": { # HealthCheckTargets describes endpoints to health-check when responding to Routing Policy queries. Only the healthy endpoints will be included in the response. # Endpoints that are health checked before making the routing decision. Unhealthy endpoints are omitted from the results. If all endpoints are unhealthy, we serve a response based on the `backup_geo_targets`. "internalLoadBalancers": [ # Configuration for internal load balancers to be health checked. { # The configuration for an individual load balancer to health check. "ipAddress": "A String", # The frontend IP address of the load balancer to health check. "ipProtocol": "A String", # The protocol of the load balancer to health check. "kind": "dns#rRSetRoutingPolicyLoadBalancerTarget", "loadBalancerType": "A String", # The type of load balancer specified by this target. This value must match the configuration of the load balancer located at the LoadBalancerTarget's IP address, port, and region. Use the following: - *regionalL4ilb*: for a regional internal passthrough Network Load Balancer. - *regionalL7ilb*: for a regional internal Application Load Balancer. - *globalL7ilb*: for a global internal Application Load Balancer. - "networkUrl": "A String", # The fully qualified URL of the network that the load balancer is attached to. This should be formatted like https://www.googleapis.com/compute/v1/projects/{project}/global/networks/{network} . + "networkUrl": "A String", # The fully qualified URL of the network that the load balancer is attached to. This should be formatted like `https://www.googleapis.com/compute/v1/projects/{project}/global/networks/{network}`. "port": "A String", # The configured port of the load balancer. "project": "A String", # The project ID in which the load balancer is located. "region": "A String", # The region in which the load balancer is located. }, ], }, - "trickleTraffic": 3.14, # When serving state is PRIMARY, this field provides the option of sending a small percentage of the traffic to the backup targets. + "trickleTraffic": 3.14, # When serving state is `PRIMARY`, this field provides the option of sending a small percentage of the traffic to the backup targets. }, "wrr": { # Configures a RRSetRoutingPolicy that routes in a weighted round robin fashion. "items": [ { # A routing block which contains the routing information for one WRR item. - "healthCheckedTargets": { # HealthCheckTargets describes endpoints to health-check when responding to Routing Policy queries. Only the healthy endpoints will be included in the response. Only one of internal_load_balancer and external_endpoints should be set. # Endpoints that are health checked before making the routing decision. The unhealthy endpoints are omitted from the result. If all endpoints within a bucket are unhealthy, we choose a different bucket (sampled with respect to its weight) for responding. If DNSSEC is enabled for this zone, only one of rrdata or health_checked_targets can be set. + "healthCheckedTargets": { # HealthCheckTargets describes endpoints to health-check when responding to Routing Policy queries. Only the healthy endpoints will be included in the response. # Endpoints that are health checked before making the routing decision. The unhealthy endpoints are omitted from the result. If all endpoints within a bucket are unhealthy, we choose a different bucket (sampled with respect to its weight) for responding. If DNSSEC is enabled for this zone, only one of `rrdata` or `health_checked_targets` can be set. "internalLoadBalancers": [ # Configuration for internal load balancers to be health checked. { # The configuration for an individual load balancer to health check. "ipAddress": "A String", # The frontend IP address of the load balancer to health check. "ipProtocol": "A String", # The protocol of the load balancer to health check. "kind": "dns#rRSetRoutingPolicyLoadBalancerTarget", "loadBalancerType": "A String", # The type of load balancer specified by this target. This value must match the configuration of the load balancer located at the LoadBalancerTarget's IP address, port, and region. Use the following: - *regionalL4ilb*: for a regional internal passthrough Network Load Balancer. - *regionalL7ilb*: for a regional internal Application Load Balancer. - *globalL7ilb*: for a global internal Application Load Balancer. - "networkUrl": "A String", # The fully qualified URL of the network that the load balancer is attached to. This should be formatted like https://www.googleapis.com/compute/v1/projects/{project}/global/networks/{network} . + "networkUrl": "A String", # The fully qualified URL of the network that the load balancer is attached to. This should be formatted like `https://www.googleapis.com/compute/v1/projects/{project}/global/networks/{network}`. "port": "A String", # The configured port of the load balancer. "project": "A String", # The project ID in which the load balancer is located. "region": "A String", # The region in which the load balancer is located. @@ -424,10 +424,10 @@

Method Details

"rrdatas": [ "A String", ], - "signatureRrdatas": [ # DNSSEC generated signatures for all the rrdata within this item. Note that if health checked targets are provided for DNSSEC enabled zones, there's a restriction of 1 IP address per item. + "signatureRrdatas": [ # DNSSEC generated signatures for all the `rrdata` within this item. Note that if health checked targets are provided for DNSSEC enabled zones, there's a restriction of 1 IP address per item. "A String", ], - "weight": 3.14, # The weight corresponding to this WrrPolicyItem object. When multiple WrrPolicyItem objects are configured, the probability of returning an WrrPolicyItem object's data is proportional to its weight relative to the sum of weights configured for all items. This weight must be non-negative. + "weight": 3.14, # The weight corresponding to this `WrrPolicyItem` object. When multiple `WrrPolicyItem` objects are configured, the probability of returning an `WrrPolicyItem` object's data is proportional to its weight relative to the sum of weights configured for all items. This weight must be non-negative. }, ], "kind": "dns#rRSetRoutingPolicyWrrPolicy", @@ -435,14 +435,14 @@

Method Details

"wrrPolicy": { # Configures a RRSetRoutingPolicy that routes in a weighted round robin fashion. "items": [ { # A routing block which contains the routing information for one WRR item. - "healthCheckedTargets": { # HealthCheckTargets describes endpoints to health-check when responding to Routing Policy queries. Only the healthy endpoints will be included in the response. Only one of internal_load_balancer and external_endpoints should be set. # Endpoints that are health checked before making the routing decision. The unhealthy endpoints are omitted from the result. If all endpoints within a bucket are unhealthy, we choose a different bucket (sampled with respect to its weight) for responding. If DNSSEC is enabled for this zone, only one of rrdata or health_checked_targets can be set. + "healthCheckedTargets": { # HealthCheckTargets describes endpoints to health-check when responding to Routing Policy queries. Only the healthy endpoints will be included in the response. # Endpoints that are health checked before making the routing decision. The unhealthy endpoints are omitted from the result. If all endpoints within a bucket are unhealthy, we choose a different bucket (sampled with respect to its weight) for responding. If DNSSEC is enabled for this zone, only one of `rrdata` or `health_checked_targets` can be set. "internalLoadBalancers": [ # Configuration for internal load balancers to be health checked. { # The configuration for an individual load balancer to health check. "ipAddress": "A String", # The frontend IP address of the load balancer to health check. "ipProtocol": "A String", # The protocol of the load balancer to health check. "kind": "dns#rRSetRoutingPolicyLoadBalancerTarget", "loadBalancerType": "A String", # The type of load balancer specified by this target. This value must match the configuration of the load balancer located at the LoadBalancerTarget's IP address, port, and region. Use the following: - *regionalL4ilb*: for a regional internal passthrough Network Load Balancer. - *regionalL7ilb*: for a regional internal Application Load Balancer. - *globalL7ilb*: for a global internal Application Load Balancer. - "networkUrl": "A String", # The fully qualified URL of the network that the load balancer is attached to. This should be formatted like https://www.googleapis.com/compute/v1/projects/{project}/global/networks/{network} . + "networkUrl": "A String", # The fully qualified URL of the network that the load balancer is attached to. This should be formatted like `https://www.googleapis.com/compute/v1/projects/{project}/global/networks/{network}`. "port": "A String", # The configured port of the load balancer. "project": "A String", # The project ID in which the load balancer is located. "region": "A String", # The region in which the load balancer is located. @@ -453,10 +453,10 @@

Method Details

"rrdatas": [ "A String", ], - "signatureRrdatas": [ # DNSSEC generated signatures for all the rrdata within this item. Note that if health checked targets are provided for DNSSEC enabled zones, there's a restriction of 1 IP address per item. + "signatureRrdatas": [ # DNSSEC generated signatures for all the `rrdata` within this item. Note that if health checked targets are provided for DNSSEC enabled zones, there's a restriction of 1 IP address per item. "A String", ], - "weight": 3.14, # The weight corresponding to this WrrPolicyItem object. When multiple WrrPolicyItem objects are configured, the probability of returning an WrrPolicyItem object's data is proportional to its weight relative to the sum of weights configured for all items. This weight must be non-negative. + "weight": 3.14, # The weight corresponding to this `WrrPolicyItem` object. When multiple `WrrPolicyItem` objects are configured, the probability of returning an `WrrPolicyItem` object's data is proportional to its weight relative to the sum of weights configured for all items. This weight must be non-negative. }, ], "kind": "dns#rRSetRoutingPolicyWrrPolicy", @@ -468,7 +468,7 @@

Method Details

"signatureRrdatas": [ # As defined in RFC 4034 (section 3.2). "A String", ], - "ttl": 42, # Number of seconds that this ResourceRecordSet can be cached by resolvers. + "ttl": 42, # Number of seconds that this `ResourceRecordSet` can be cached by resolvers. "type": "A String", # The identifier of a supported record type. See the list of Supported DNS record types. }, ], @@ -488,24 +488,24 @@

Method Details

Returns: An object of the form: - { # A Change represents a set of ResourceRecordSet additions and deletions applied atomically to a ManagedZone. ResourceRecordSets within a ManagedZone are modified by creating a new Change element in the Changes collection. In turn the Changes collection also records the past modifications to the ResourceRecordSets in a ManagedZone. The current state of the ManagedZone is the sum effect of applying all Change elements in the Changes collection in sequence. + { # A Change represents a set of `ResourceRecordSet` additions and deletions applied atomically to a ManagedZone. ResourceRecordSets within a ManagedZone are modified by creating a new Change element in the Changes collection. In turn the Changes collection also records the past modifications to the `ResourceRecordSets` in a `ManagedZone`. The current state of the `ManagedZone` is the sum effect of applying all `Change` elements in the `Changes` collection in sequence. "additions": [ # Which ResourceRecordSets to add? { # A unit of data that is returned by the DNS servers. "kind": "dns#resourceRecordSet", "name": "A String", # For example, www.example.com. - "routingPolicy": { # A RRSetRoutingPolicy represents ResourceRecordSet data that is returned dynamically with the response varying based on configured properties such as geolocation or by weighted random selection. # Configures dynamic query responses based on either the geo location of the querying user or a weighted round robin based routing policy. A valid ResourceRecordSet contains only rrdata (for static resolution) or a routing_policy (for dynamic resolution). - "geo": { # Configures a RRSetRoutingPolicy that routes based on the geo location of the querying user. + "routingPolicy": { # A RRSetRoutingPolicy represents ResourceRecordSet data that is returned dynamically with the response varying based on configured properties such as geolocation or by weighted random selection. # Configures dynamic query responses based on either the geo location of the querying user or a weighted round robin based routing policy. A valid `ResourceRecordSet` contains only `rrdata` (for static resolution) or a `routing_policy` (for dynamic resolution). + "geo": { # Configures a `RRSetRoutingPolicy` that routes based on the geo location of the querying user. "enableFencing": True or False, # Without fencing, if health check fails for all configured items in the current geo bucket, we failover to the next nearest geo bucket. With fencing, if health checking is enabled, as long as some targets in the current geo bucket are healthy, we return only the healthy targets. However, if all targets are unhealthy, we don't failover to the next nearest bucket; instead, we return all the items in the current bucket even when all targets are unhealthy. "items": [ # The primary geo routing configuration. If there are multiple items with the same location, an error is returned instead. { # ResourceRecordSet data for one geo location. - "healthCheckedTargets": { # HealthCheckTargets describes endpoints to health-check when responding to Routing Policy queries. Only the healthy endpoints will be included in the response. Only one of internal_load_balancer and external_endpoints should be set. # For A and AAAA types only. Endpoints to return in the query result only if they are healthy. These can be specified along with rrdata within this item. + "healthCheckedTargets": { # HealthCheckTargets describes endpoints to health-check when responding to Routing Policy queries. Only the healthy endpoints will be included in the response. # For A and AAAA types only. Endpoints to return in the query result only if they are healthy. These can be specified along with `rrdata` within this item. "internalLoadBalancers": [ # Configuration for internal load balancers to be health checked. { # The configuration for an individual load balancer to health check. "ipAddress": "A String", # The frontend IP address of the load balancer to health check. "ipProtocol": "A String", # The protocol of the load balancer to health check. "kind": "dns#rRSetRoutingPolicyLoadBalancerTarget", "loadBalancerType": "A String", # The type of load balancer specified by this target. This value must match the configuration of the load balancer located at the LoadBalancerTarget's IP address, port, and region. Use the following: - *regionalL4ilb*: for a regional internal passthrough Network Load Balancer. - *regionalL7ilb*: for a regional internal Application Load Balancer. - *globalL7ilb*: for a global internal Application Load Balancer. - "networkUrl": "A String", # The fully qualified URL of the network that the load balancer is attached to. This should be formatted like https://www.googleapis.com/compute/v1/projects/{project}/global/networks/{network} . + "networkUrl": "A String", # The fully qualified URL of the network that the load balancer is attached to. This should be formatted like `https://www.googleapis.com/compute/v1/projects/{project}/global/networks/{network}`. "port": "A String", # The configured port of the load balancer. "project": "A String", # The project ID in which the load balancer is located. "region": "A String", # The region in which the load balancer is located. @@ -517,25 +517,25 @@

Method Details

"rrdatas": [ "A String", ], - "signatureRrdatas": [ # DNSSEC generated signatures for all the rrdata within this item. If health checked targets are provided for DNSSEC enabled zones, there's a restriction of 1 IP address per item. + "signatureRrdatas": [ # DNSSEC generated signatures for all the `rrdata` within this item. If health checked targets are provided for DNSSEC enabled zones, there's a restriction of 1 IP address per item. "A String", ], }, ], "kind": "dns#rRSetRoutingPolicyGeoPolicy", }, - "geoPolicy": { # Configures a RRSetRoutingPolicy that routes based on the geo location of the querying user. + "geoPolicy": { # Configures a `RRSetRoutingPolicy` that routes based on the geo location of the querying user. "enableFencing": True or False, # Without fencing, if health check fails for all configured items in the current geo bucket, we failover to the next nearest geo bucket. With fencing, if health checking is enabled, as long as some targets in the current geo bucket are healthy, we return only the healthy targets. However, if all targets are unhealthy, we don't failover to the next nearest bucket; instead, we return all the items in the current bucket even when all targets are unhealthy. "items": [ # The primary geo routing configuration. If there are multiple items with the same location, an error is returned instead. { # ResourceRecordSet data for one geo location. - "healthCheckedTargets": { # HealthCheckTargets describes endpoints to health-check when responding to Routing Policy queries. Only the healthy endpoints will be included in the response. Only one of internal_load_balancer and external_endpoints should be set. # For A and AAAA types only. Endpoints to return in the query result only if they are healthy. These can be specified along with rrdata within this item. + "healthCheckedTargets": { # HealthCheckTargets describes endpoints to health-check when responding to Routing Policy queries. Only the healthy endpoints will be included in the response. # For A and AAAA types only. Endpoints to return in the query result only if they are healthy. These can be specified along with `rrdata` within this item. "internalLoadBalancers": [ # Configuration for internal load balancers to be health checked. { # The configuration for an individual load balancer to health check. "ipAddress": "A String", # The frontend IP address of the load balancer to health check. "ipProtocol": "A String", # The protocol of the load balancer to health check. "kind": "dns#rRSetRoutingPolicyLoadBalancerTarget", "loadBalancerType": "A String", # The type of load balancer specified by this target. This value must match the configuration of the load balancer located at the LoadBalancerTarget's IP address, port, and region. Use the following: - *regionalL4ilb*: for a regional internal passthrough Network Load Balancer. - *regionalL7ilb*: for a regional internal Application Load Balancer. - *globalL7ilb*: for a global internal Application Load Balancer. - "networkUrl": "A String", # The fully qualified URL of the network that the load balancer is attached to. This should be formatted like https://www.googleapis.com/compute/v1/projects/{project}/global/networks/{network} . + "networkUrl": "A String", # The fully qualified URL of the network that the load balancer is attached to. This should be formatted like `https://www.googleapis.com/compute/v1/projects/{project}/global/networks/{network}`. "port": "A String", # The configured port of the load balancer. "project": "A String", # The project ID in which the load balancer is located. "region": "A String", # The region in which the load balancer is located. @@ -547,7 +547,7 @@

Method Details

"rrdatas": [ "A String", ], - "signatureRrdatas": [ # DNSSEC generated signatures for all the rrdata within this item. If health checked targets are provided for DNSSEC enabled zones, there's a restriction of 1 IP address per item. + "signatureRrdatas": [ # DNSSEC generated signatures for all the `rrdata` within this item. If health checked targets are provided for DNSSEC enabled zones, there's a restriction of 1 IP address per item. "A String", ], }, @@ -556,18 +556,18 @@

Method Details

}, "kind": "dns#rRSetRoutingPolicy", "primaryBackup": { # Configures a RRSetRoutingPolicy such that all queries are responded with the primary_targets if they are healthy. And if all of them are unhealthy, then we fallback to a geo localized policy. - "backupGeoTargets": { # Configures a RRSetRoutingPolicy that routes based on the geo location of the querying user. # Backup targets provide a regional failover policy for the otherwise global primary targets. If serving state is set to BACKUP, this policy essentially becomes a geo routing policy. + "backupGeoTargets": { # Configures a `RRSetRoutingPolicy` that routes based on the geo location of the querying user. # Backup targets provide a regional failover policy for the otherwise global primary targets. If serving state is set to `BACKUP`, this policy essentially becomes a geo routing policy. "enableFencing": True or False, # Without fencing, if health check fails for all configured items in the current geo bucket, we failover to the next nearest geo bucket. With fencing, if health checking is enabled, as long as some targets in the current geo bucket are healthy, we return only the healthy targets. However, if all targets are unhealthy, we don't failover to the next nearest bucket; instead, we return all the items in the current bucket even when all targets are unhealthy. "items": [ # The primary geo routing configuration. If there are multiple items with the same location, an error is returned instead. { # ResourceRecordSet data for one geo location. - "healthCheckedTargets": { # HealthCheckTargets describes endpoints to health-check when responding to Routing Policy queries. Only the healthy endpoints will be included in the response. Only one of internal_load_balancer and external_endpoints should be set. # For A and AAAA types only. Endpoints to return in the query result only if they are healthy. These can be specified along with rrdata within this item. + "healthCheckedTargets": { # HealthCheckTargets describes endpoints to health-check when responding to Routing Policy queries. Only the healthy endpoints will be included in the response. # For A and AAAA types only. Endpoints to return in the query result only if they are healthy. These can be specified along with `rrdata` within this item. "internalLoadBalancers": [ # Configuration for internal load balancers to be health checked. { # The configuration for an individual load balancer to health check. "ipAddress": "A String", # The frontend IP address of the load balancer to health check. "ipProtocol": "A String", # The protocol of the load balancer to health check. "kind": "dns#rRSetRoutingPolicyLoadBalancerTarget", "loadBalancerType": "A String", # The type of load balancer specified by this target. This value must match the configuration of the load balancer located at the LoadBalancerTarget's IP address, port, and region. Use the following: - *regionalL4ilb*: for a regional internal passthrough Network Load Balancer. - *regionalL7ilb*: for a regional internal Application Load Balancer. - *globalL7ilb*: for a global internal Application Load Balancer. - "networkUrl": "A String", # The fully qualified URL of the network that the load balancer is attached to. This should be formatted like https://www.googleapis.com/compute/v1/projects/{project}/global/networks/{network} . + "networkUrl": "A String", # The fully qualified URL of the network that the load balancer is attached to. This should be formatted like `https://www.googleapis.com/compute/v1/projects/{project}/global/networks/{network}`. "port": "A String", # The configured port of the load balancer. "project": "A String", # The project ID in which the load balancer is located. "region": "A String", # The region in which the load balancer is located. @@ -579,7 +579,7 @@

Method Details

"rrdatas": [ "A String", ], - "signatureRrdatas": [ # DNSSEC generated signatures for all the rrdata within this item. If health checked targets are provided for DNSSEC enabled zones, there's a restriction of 1 IP address per item. + "signatureRrdatas": [ # DNSSEC generated signatures for all the `rrdata` within this item. If health checked targets are provided for DNSSEC enabled zones, there's a restriction of 1 IP address per item. "A String", ], }, @@ -587,33 +587,33 @@

Method Details

"kind": "dns#rRSetRoutingPolicyGeoPolicy", }, "kind": "dns#rRSetRoutingPolicyPrimaryBackupPolicy", - "primaryTargets": { # HealthCheckTargets describes endpoints to health-check when responding to Routing Policy queries. Only the healthy endpoints will be included in the response. Only one of internal_load_balancer and external_endpoints should be set. # Endpoints that are health checked before making the routing decision. Unhealthy endpoints are omitted from the results. If all endpoints are unhealthy, we serve a response based on the backup_geo_targets. + "primaryTargets": { # HealthCheckTargets describes endpoints to health-check when responding to Routing Policy queries. Only the healthy endpoints will be included in the response. # Endpoints that are health checked before making the routing decision. Unhealthy endpoints are omitted from the results. If all endpoints are unhealthy, we serve a response based on the `backup_geo_targets`. "internalLoadBalancers": [ # Configuration for internal load balancers to be health checked. { # The configuration for an individual load balancer to health check. "ipAddress": "A String", # The frontend IP address of the load balancer to health check. "ipProtocol": "A String", # The protocol of the load balancer to health check. "kind": "dns#rRSetRoutingPolicyLoadBalancerTarget", "loadBalancerType": "A String", # The type of load balancer specified by this target. This value must match the configuration of the load balancer located at the LoadBalancerTarget's IP address, port, and region. Use the following: - *regionalL4ilb*: for a regional internal passthrough Network Load Balancer. - *regionalL7ilb*: for a regional internal Application Load Balancer. - *globalL7ilb*: for a global internal Application Load Balancer. - "networkUrl": "A String", # The fully qualified URL of the network that the load balancer is attached to. This should be formatted like https://www.googleapis.com/compute/v1/projects/{project}/global/networks/{network} . + "networkUrl": "A String", # The fully qualified URL of the network that the load balancer is attached to. This should be formatted like `https://www.googleapis.com/compute/v1/projects/{project}/global/networks/{network}`. "port": "A String", # The configured port of the load balancer. "project": "A String", # The project ID in which the load balancer is located. "region": "A String", # The region in which the load balancer is located. }, ], }, - "trickleTraffic": 3.14, # When serving state is PRIMARY, this field provides the option of sending a small percentage of the traffic to the backup targets. + "trickleTraffic": 3.14, # When serving state is `PRIMARY`, this field provides the option of sending a small percentage of the traffic to the backup targets. }, "wrr": { # Configures a RRSetRoutingPolicy that routes in a weighted round robin fashion. "items": [ { # A routing block which contains the routing information for one WRR item. - "healthCheckedTargets": { # HealthCheckTargets describes endpoints to health-check when responding to Routing Policy queries. Only the healthy endpoints will be included in the response. Only one of internal_load_balancer and external_endpoints should be set. # Endpoints that are health checked before making the routing decision. The unhealthy endpoints are omitted from the result. If all endpoints within a bucket are unhealthy, we choose a different bucket (sampled with respect to its weight) for responding. If DNSSEC is enabled for this zone, only one of rrdata or health_checked_targets can be set. + "healthCheckedTargets": { # HealthCheckTargets describes endpoints to health-check when responding to Routing Policy queries. Only the healthy endpoints will be included in the response. # Endpoints that are health checked before making the routing decision. The unhealthy endpoints are omitted from the result. If all endpoints within a bucket are unhealthy, we choose a different bucket (sampled with respect to its weight) for responding. If DNSSEC is enabled for this zone, only one of `rrdata` or `health_checked_targets` can be set. "internalLoadBalancers": [ # Configuration for internal load balancers to be health checked. { # The configuration for an individual load balancer to health check. "ipAddress": "A String", # The frontend IP address of the load balancer to health check. "ipProtocol": "A String", # The protocol of the load balancer to health check. "kind": "dns#rRSetRoutingPolicyLoadBalancerTarget", "loadBalancerType": "A String", # The type of load balancer specified by this target. This value must match the configuration of the load balancer located at the LoadBalancerTarget's IP address, port, and region. Use the following: - *regionalL4ilb*: for a regional internal passthrough Network Load Balancer. - *regionalL7ilb*: for a regional internal Application Load Balancer. - *globalL7ilb*: for a global internal Application Load Balancer. - "networkUrl": "A String", # The fully qualified URL of the network that the load balancer is attached to. This should be formatted like https://www.googleapis.com/compute/v1/projects/{project}/global/networks/{network} . + "networkUrl": "A String", # The fully qualified URL of the network that the load balancer is attached to. This should be formatted like `https://www.googleapis.com/compute/v1/projects/{project}/global/networks/{network}`. "port": "A String", # The configured port of the load balancer. "project": "A String", # The project ID in which the load balancer is located. "region": "A String", # The region in which the load balancer is located. @@ -624,10 +624,10 @@

Method Details

"rrdatas": [ "A String", ], - "signatureRrdatas": [ # DNSSEC generated signatures for all the rrdata within this item. Note that if health checked targets are provided for DNSSEC enabled zones, there's a restriction of 1 IP address per item. + "signatureRrdatas": [ # DNSSEC generated signatures for all the `rrdata` within this item. Note that if health checked targets are provided for DNSSEC enabled zones, there's a restriction of 1 IP address per item. "A String", ], - "weight": 3.14, # The weight corresponding to this WrrPolicyItem object. When multiple WrrPolicyItem objects are configured, the probability of returning an WrrPolicyItem object's data is proportional to its weight relative to the sum of weights configured for all items. This weight must be non-negative. + "weight": 3.14, # The weight corresponding to this `WrrPolicyItem` object. When multiple `WrrPolicyItem` objects are configured, the probability of returning an `WrrPolicyItem` object's data is proportional to its weight relative to the sum of weights configured for all items. This weight must be non-negative. }, ], "kind": "dns#rRSetRoutingPolicyWrrPolicy", @@ -635,14 +635,14 @@

Method Details

"wrrPolicy": { # Configures a RRSetRoutingPolicy that routes in a weighted round robin fashion. "items": [ { # A routing block which contains the routing information for one WRR item. - "healthCheckedTargets": { # HealthCheckTargets describes endpoints to health-check when responding to Routing Policy queries. Only the healthy endpoints will be included in the response. Only one of internal_load_balancer and external_endpoints should be set. # Endpoints that are health checked before making the routing decision. The unhealthy endpoints are omitted from the result. If all endpoints within a bucket are unhealthy, we choose a different bucket (sampled with respect to its weight) for responding. If DNSSEC is enabled for this zone, only one of rrdata or health_checked_targets can be set. + "healthCheckedTargets": { # HealthCheckTargets describes endpoints to health-check when responding to Routing Policy queries. Only the healthy endpoints will be included in the response. # Endpoints that are health checked before making the routing decision. The unhealthy endpoints are omitted from the result. If all endpoints within a bucket are unhealthy, we choose a different bucket (sampled with respect to its weight) for responding. If DNSSEC is enabled for this zone, only one of `rrdata` or `health_checked_targets` can be set. "internalLoadBalancers": [ # Configuration for internal load balancers to be health checked. { # The configuration for an individual load balancer to health check. "ipAddress": "A String", # The frontend IP address of the load balancer to health check. "ipProtocol": "A String", # The protocol of the load balancer to health check. "kind": "dns#rRSetRoutingPolicyLoadBalancerTarget", "loadBalancerType": "A String", # The type of load balancer specified by this target. This value must match the configuration of the load balancer located at the LoadBalancerTarget's IP address, port, and region. Use the following: - *regionalL4ilb*: for a regional internal passthrough Network Load Balancer. - *regionalL7ilb*: for a regional internal Application Load Balancer. - *globalL7ilb*: for a global internal Application Load Balancer. - "networkUrl": "A String", # The fully qualified URL of the network that the load balancer is attached to. This should be formatted like https://www.googleapis.com/compute/v1/projects/{project}/global/networks/{network} . + "networkUrl": "A String", # The fully qualified URL of the network that the load balancer is attached to. This should be formatted like `https://www.googleapis.com/compute/v1/projects/{project}/global/networks/{network}`. "port": "A String", # The configured port of the load balancer. "project": "A String", # The project ID in which the load balancer is located. "region": "A String", # The region in which the load balancer is located. @@ -653,10 +653,10 @@

Method Details

"rrdatas": [ "A String", ], - "signatureRrdatas": [ # DNSSEC generated signatures for all the rrdata within this item. Note that if health checked targets are provided for DNSSEC enabled zones, there's a restriction of 1 IP address per item. + "signatureRrdatas": [ # DNSSEC generated signatures for all the `rrdata` within this item. Note that if health checked targets are provided for DNSSEC enabled zones, there's a restriction of 1 IP address per item. "A String", ], - "weight": 3.14, # The weight corresponding to this WrrPolicyItem object. When multiple WrrPolicyItem objects are configured, the probability of returning an WrrPolicyItem object's data is proportional to its weight relative to the sum of weights configured for all items. This weight must be non-negative. + "weight": 3.14, # The weight corresponding to this `WrrPolicyItem` object. When multiple `WrrPolicyItem` objects are configured, the probability of returning an `WrrPolicyItem` object's data is proportional to its weight relative to the sum of weights configured for all items. This weight must be non-negative. }, ], "kind": "dns#rRSetRoutingPolicyWrrPolicy", @@ -668,7 +668,7 @@

Method Details

"signatureRrdatas": [ # As defined in RFC 4034 (section 3.2). "A String", ], - "ttl": 42, # Number of seconds that this ResourceRecordSet can be cached by resolvers. + "ttl": 42, # Number of seconds that this `ResourceRecordSet` can be cached by resolvers. "type": "A String", # The identifier of a supported record type. See the list of Supported DNS record types. }, ], @@ -676,19 +676,19 @@

Method Details

{ # A unit of data that is returned by the DNS servers. "kind": "dns#resourceRecordSet", "name": "A String", # For example, www.example.com. - "routingPolicy": { # A RRSetRoutingPolicy represents ResourceRecordSet data that is returned dynamically with the response varying based on configured properties such as geolocation or by weighted random selection. # Configures dynamic query responses based on either the geo location of the querying user or a weighted round robin based routing policy. A valid ResourceRecordSet contains only rrdata (for static resolution) or a routing_policy (for dynamic resolution). - "geo": { # Configures a RRSetRoutingPolicy that routes based on the geo location of the querying user. + "routingPolicy": { # A RRSetRoutingPolicy represents ResourceRecordSet data that is returned dynamically with the response varying based on configured properties such as geolocation or by weighted random selection. # Configures dynamic query responses based on either the geo location of the querying user or a weighted round robin based routing policy. A valid `ResourceRecordSet` contains only `rrdata` (for static resolution) or a `routing_policy` (for dynamic resolution). + "geo": { # Configures a `RRSetRoutingPolicy` that routes based on the geo location of the querying user. "enableFencing": True or False, # Without fencing, if health check fails for all configured items in the current geo bucket, we failover to the next nearest geo bucket. With fencing, if health checking is enabled, as long as some targets in the current geo bucket are healthy, we return only the healthy targets. However, if all targets are unhealthy, we don't failover to the next nearest bucket; instead, we return all the items in the current bucket even when all targets are unhealthy. "items": [ # The primary geo routing configuration. If there are multiple items with the same location, an error is returned instead. { # ResourceRecordSet data for one geo location. - "healthCheckedTargets": { # HealthCheckTargets describes endpoints to health-check when responding to Routing Policy queries. Only the healthy endpoints will be included in the response. Only one of internal_load_balancer and external_endpoints should be set. # For A and AAAA types only. Endpoints to return in the query result only if they are healthy. These can be specified along with rrdata within this item. + "healthCheckedTargets": { # HealthCheckTargets describes endpoints to health-check when responding to Routing Policy queries. Only the healthy endpoints will be included in the response. # For A and AAAA types only. Endpoints to return in the query result only if they are healthy. These can be specified along with `rrdata` within this item. "internalLoadBalancers": [ # Configuration for internal load balancers to be health checked. { # The configuration for an individual load balancer to health check. "ipAddress": "A String", # The frontend IP address of the load balancer to health check. "ipProtocol": "A String", # The protocol of the load balancer to health check. "kind": "dns#rRSetRoutingPolicyLoadBalancerTarget", "loadBalancerType": "A String", # The type of load balancer specified by this target. This value must match the configuration of the load balancer located at the LoadBalancerTarget's IP address, port, and region. Use the following: - *regionalL4ilb*: for a regional internal passthrough Network Load Balancer. - *regionalL7ilb*: for a regional internal Application Load Balancer. - *globalL7ilb*: for a global internal Application Load Balancer. - "networkUrl": "A String", # The fully qualified URL of the network that the load balancer is attached to. This should be formatted like https://www.googleapis.com/compute/v1/projects/{project}/global/networks/{network} . + "networkUrl": "A String", # The fully qualified URL of the network that the load balancer is attached to. This should be formatted like `https://www.googleapis.com/compute/v1/projects/{project}/global/networks/{network}`. "port": "A String", # The configured port of the load balancer. "project": "A String", # The project ID in which the load balancer is located. "region": "A String", # The region in which the load balancer is located. @@ -700,25 +700,25 @@

Method Details

"rrdatas": [ "A String", ], - "signatureRrdatas": [ # DNSSEC generated signatures for all the rrdata within this item. If health checked targets are provided for DNSSEC enabled zones, there's a restriction of 1 IP address per item. + "signatureRrdatas": [ # DNSSEC generated signatures for all the `rrdata` within this item. If health checked targets are provided for DNSSEC enabled zones, there's a restriction of 1 IP address per item. "A String", ], }, ], "kind": "dns#rRSetRoutingPolicyGeoPolicy", }, - "geoPolicy": { # Configures a RRSetRoutingPolicy that routes based on the geo location of the querying user. + "geoPolicy": { # Configures a `RRSetRoutingPolicy` that routes based on the geo location of the querying user. "enableFencing": True or False, # Without fencing, if health check fails for all configured items in the current geo bucket, we failover to the next nearest geo bucket. With fencing, if health checking is enabled, as long as some targets in the current geo bucket are healthy, we return only the healthy targets. However, if all targets are unhealthy, we don't failover to the next nearest bucket; instead, we return all the items in the current bucket even when all targets are unhealthy. "items": [ # The primary geo routing configuration. If there are multiple items with the same location, an error is returned instead. { # ResourceRecordSet data for one geo location. - "healthCheckedTargets": { # HealthCheckTargets describes endpoints to health-check when responding to Routing Policy queries. Only the healthy endpoints will be included in the response. Only one of internal_load_balancer and external_endpoints should be set. # For A and AAAA types only. Endpoints to return in the query result only if they are healthy. These can be specified along with rrdata within this item. + "healthCheckedTargets": { # HealthCheckTargets describes endpoints to health-check when responding to Routing Policy queries. Only the healthy endpoints will be included in the response. # For A and AAAA types only. Endpoints to return in the query result only if they are healthy. These can be specified along with `rrdata` within this item. "internalLoadBalancers": [ # Configuration for internal load balancers to be health checked. { # The configuration for an individual load balancer to health check. "ipAddress": "A String", # The frontend IP address of the load balancer to health check. "ipProtocol": "A String", # The protocol of the load balancer to health check. "kind": "dns#rRSetRoutingPolicyLoadBalancerTarget", "loadBalancerType": "A String", # The type of load balancer specified by this target. This value must match the configuration of the load balancer located at the LoadBalancerTarget's IP address, port, and region. Use the following: - *regionalL4ilb*: for a regional internal passthrough Network Load Balancer. - *regionalL7ilb*: for a regional internal Application Load Balancer. - *globalL7ilb*: for a global internal Application Load Balancer. - "networkUrl": "A String", # The fully qualified URL of the network that the load balancer is attached to. This should be formatted like https://www.googleapis.com/compute/v1/projects/{project}/global/networks/{network} . + "networkUrl": "A String", # The fully qualified URL of the network that the load balancer is attached to. This should be formatted like `https://www.googleapis.com/compute/v1/projects/{project}/global/networks/{network}`. "port": "A String", # The configured port of the load balancer. "project": "A String", # The project ID in which the load balancer is located. "region": "A String", # The region in which the load balancer is located. @@ -730,7 +730,7 @@

Method Details

"rrdatas": [ "A String", ], - "signatureRrdatas": [ # DNSSEC generated signatures for all the rrdata within this item. If health checked targets are provided for DNSSEC enabled zones, there's a restriction of 1 IP address per item. + "signatureRrdatas": [ # DNSSEC generated signatures for all the `rrdata` within this item. If health checked targets are provided for DNSSEC enabled zones, there's a restriction of 1 IP address per item. "A String", ], }, @@ -739,18 +739,18 @@

Method Details

}, "kind": "dns#rRSetRoutingPolicy", "primaryBackup": { # Configures a RRSetRoutingPolicy such that all queries are responded with the primary_targets if they are healthy. And if all of them are unhealthy, then we fallback to a geo localized policy. - "backupGeoTargets": { # Configures a RRSetRoutingPolicy that routes based on the geo location of the querying user. # Backup targets provide a regional failover policy for the otherwise global primary targets. If serving state is set to BACKUP, this policy essentially becomes a geo routing policy. + "backupGeoTargets": { # Configures a `RRSetRoutingPolicy` that routes based on the geo location of the querying user. # Backup targets provide a regional failover policy for the otherwise global primary targets. If serving state is set to `BACKUP`, this policy essentially becomes a geo routing policy. "enableFencing": True or False, # Without fencing, if health check fails for all configured items in the current geo bucket, we failover to the next nearest geo bucket. With fencing, if health checking is enabled, as long as some targets in the current geo bucket are healthy, we return only the healthy targets. However, if all targets are unhealthy, we don't failover to the next nearest bucket; instead, we return all the items in the current bucket even when all targets are unhealthy. "items": [ # The primary geo routing configuration. If there are multiple items with the same location, an error is returned instead. { # ResourceRecordSet data for one geo location. - "healthCheckedTargets": { # HealthCheckTargets describes endpoints to health-check when responding to Routing Policy queries. Only the healthy endpoints will be included in the response. Only one of internal_load_balancer and external_endpoints should be set. # For A and AAAA types only. Endpoints to return in the query result only if they are healthy. These can be specified along with rrdata within this item. + "healthCheckedTargets": { # HealthCheckTargets describes endpoints to health-check when responding to Routing Policy queries. Only the healthy endpoints will be included in the response. # For A and AAAA types only. Endpoints to return in the query result only if they are healthy. These can be specified along with `rrdata` within this item. "internalLoadBalancers": [ # Configuration for internal load balancers to be health checked. { # The configuration for an individual load balancer to health check. "ipAddress": "A String", # The frontend IP address of the load balancer to health check. "ipProtocol": "A String", # The protocol of the load balancer to health check. "kind": "dns#rRSetRoutingPolicyLoadBalancerTarget", "loadBalancerType": "A String", # The type of load balancer specified by this target. This value must match the configuration of the load balancer located at the LoadBalancerTarget's IP address, port, and region. Use the following: - *regionalL4ilb*: for a regional internal passthrough Network Load Balancer. - *regionalL7ilb*: for a regional internal Application Load Balancer. - *globalL7ilb*: for a global internal Application Load Balancer. - "networkUrl": "A String", # The fully qualified URL of the network that the load balancer is attached to. This should be formatted like https://www.googleapis.com/compute/v1/projects/{project}/global/networks/{network} . + "networkUrl": "A String", # The fully qualified URL of the network that the load balancer is attached to. This should be formatted like `https://www.googleapis.com/compute/v1/projects/{project}/global/networks/{network}`. "port": "A String", # The configured port of the load balancer. "project": "A String", # The project ID in which the load balancer is located. "region": "A String", # The region in which the load balancer is located. @@ -762,7 +762,7 @@

Method Details

"rrdatas": [ "A String", ], - "signatureRrdatas": [ # DNSSEC generated signatures for all the rrdata within this item. If health checked targets are provided for DNSSEC enabled zones, there's a restriction of 1 IP address per item. + "signatureRrdatas": [ # DNSSEC generated signatures for all the `rrdata` within this item. If health checked targets are provided for DNSSEC enabled zones, there's a restriction of 1 IP address per item. "A String", ], }, @@ -770,33 +770,33 @@

Method Details

"kind": "dns#rRSetRoutingPolicyGeoPolicy", }, "kind": "dns#rRSetRoutingPolicyPrimaryBackupPolicy", - "primaryTargets": { # HealthCheckTargets describes endpoints to health-check when responding to Routing Policy queries. Only the healthy endpoints will be included in the response. Only one of internal_load_balancer and external_endpoints should be set. # Endpoints that are health checked before making the routing decision. Unhealthy endpoints are omitted from the results. If all endpoints are unhealthy, we serve a response based on the backup_geo_targets. + "primaryTargets": { # HealthCheckTargets describes endpoints to health-check when responding to Routing Policy queries. Only the healthy endpoints will be included in the response. # Endpoints that are health checked before making the routing decision. Unhealthy endpoints are omitted from the results. If all endpoints are unhealthy, we serve a response based on the `backup_geo_targets`. "internalLoadBalancers": [ # Configuration for internal load balancers to be health checked. { # The configuration for an individual load balancer to health check. "ipAddress": "A String", # The frontend IP address of the load balancer to health check. "ipProtocol": "A String", # The protocol of the load balancer to health check. "kind": "dns#rRSetRoutingPolicyLoadBalancerTarget", "loadBalancerType": "A String", # The type of load balancer specified by this target. This value must match the configuration of the load balancer located at the LoadBalancerTarget's IP address, port, and region. Use the following: - *regionalL4ilb*: for a regional internal passthrough Network Load Balancer. - *regionalL7ilb*: for a regional internal Application Load Balancer. - *globalL7ilb*: for a global internal Application Load Balancer. - "networkUrl": "A String", # The fully qualified URL of the network that the load balancer is attached to. This should be formatted like https://www.googleapis.com/compute/v1/projects/{project}/global/networks/{network} . + "networkUrl": "A String", # The fully qualified URL of the network that the load balancer is attached to. This should be formatted like `https://www.googleapis.com/compute/v1/projects/{project}/global/networks/{network}`. "port": "A String", # The configured port of the load balancer. "project": "A String", # The project ID in which the load balancer is located. "region": "A String", # The region in which the load balancer is located. }, ], }, - "trickleTraffic": 3.14, # When serving state is PRIMARY, this field provides the option of sending a small percentage of the traffic to the backup targets. + "trickleTraffic": 3.14, # When serving state is `PRIMARY`, this field provides the option of sending a small percentage of the traffic to the backup targets. }, "wrr": { # Configures a RRSetRoutingPolicy that routes in a weighted round robin fashion. "items": [ { # A routing block which contains the routing information for one WRR item. - "healthCheckedTargets": { # HealthCheckTargets describes endpoints to health-check when responding to Routing Policy queries. Only the healthy endpoints will be included in the response. Only one of internal_load_balancer and external_endpoints should be set. # Endpoints that are health checked before making the routing decision. The unhealthy endpoints are omitted from the result. If all endpoints within a bucket are unhealthy, we choose a different bucket (sampled with respect to its weight) for responding. If DNSSEC is enabled for this zone, only one of rrdata or health_checked_targets can be set. + "healthCheckedTargets": { # HealthCheckTargets describes endpoints to health-check when responding to Routing Policy queries. Only the healthy endpoints will be included in the response. # Endpoints that are health checked before making the routing decision. The unhealthy endpoints are omitted from the result. If all endpoints within a bucket are unhealthy, we choose a different bucket (sampled with respect to its weight) for responding. If DNSSEC is enabled for this zone, only one of `rrdata` or `health_checked_targets` can be set. "internalLoadBalancers": [ # Configuration for internal load balancers to be health checked. { # The configuration for an individual load balancer to health check. "ipAddress": "A String", # The frontend IP address of the load balancer to health check. "ipProtocol": "A String", # The protocol of the load balancer to health check. "kind": "dns#rRSetRoutingPolicyLoadBalancerTarget", "loadBalancerType": "A String", # The type of load balancer specified by this target. This value must match the configuration of the load balancer located at the LoadBalancerTarget's IP address, port, and region. Use the following: - *regionalL4ilb*: for a regional internal passthrough Network Load Balancer. - *regionalL7ilb*: for a regional internal Application Load Balancer. - *globalL7ilb*: for a global internal Application Load Balancer. - "networkUrl": "A String", # The fully qualified URL of the network that the load balancer is attached to. This should be formatted like https://www.googleapis.com/compute/v1/projects/{project}/global/networks/{network} . + "networkUrl": "A String", # The fully qualified URL of the network that the load balancer is attached to. This should be formatted like `https://www.googleapis.com/compute/v1/projects/{project}/global/networks/{network}`. "port": "A String", # The configured port of the load balancer. "project": "A String", # The project ID in which the load balancer is located. "region": "A String", # The region in which the load balancer is located. @@ -807,10 +807,10 @@

Method Details

"rrdatas": [ "A String", ], - "signatureRrdatas": [ # DNSSEC generated signatures for all the rrdata within this item. Note that if health checked targets are provided for DNSSEC enabled zones, there's a restriction of 1 IP address per item. + "signatureRrdatas": [ # DNSSEC generated signatures for all the `rrdata` within this item. Note that if health checked targets are provided for DNSSEC enabled zones, there's a restriction of 1 IP address per item. "A String", ], - "weight": 3.14, # The weight corresponding to this WrrPolicyItem object. When multiple WrrPolicyItem objects are configured, the probability of returning an WrrPolicyItem object's data is proportional to its weight relative to the sum of weights configured for all items. This weight must be non-negative. + "weight": 3.14, # The weight corresponding to this `WrrPolicyItem` object. When multiple `WrrPolicyItem` objects are configured, the probability of returning an `WrrPolicyItem` object's data is proportional to its weight relative to the sum of weights configured for all items. This weight must be non-negative. }, ], "kind": "dns#rRSetRoutingPolicyWrrPolicy", @@ -818,14 +818,14 @@

Method Details

"wrrPolicy": { # Configures a RRSetRoutingPolicy that routes in a weighted round robin fashion. "items": [ { # A routing block which contains the routing information for one WRR item. - "healthCheckedTargets": { # HealthCheckTargets describes endpoints to health-check when responding to Routing Policy queries. Only the healthy endpoints will be included in the response. Only one of internal_load_balancer and external_endpoints should be set. # Endpoints that are health checked before making the routing decision. The unhealthy endpoints are omitted from the result. If all endpoints within a bucket are unhealthy, we choose a different bucket (sampled with respect to its weight) for responding. If DNSSEC is enabled for this zone, only one of rrdata or health_checked_targets can be set. + "healthCheckedTargets": { # HealthCheckTargets describes endpoints to health-check when responding to Routing Policy queries. Only the healthy endpoints will be included in the response. # Endpoints that are health checked before making the routing decision. The unhealthy endpoints are omitted from the result. If all endpoints within a bucket are unhealthy, we choose a different bucket (sampled with respect to its weight) for responding. If DNSSEC is enabled for this zone, only one of `rrdata` or `health_checked_targets` can be set. "internalLoadBalancers": [ # Configuration for internal load balancers to be health checked. { # The configuration for an individual load balancer to health check. "ipAddress": "A String", # The frontend IP address of the load balancer to health check. "ipProtocol": "A String", # The protocol of the load balancer to health check. "kind": "dns#rRSetRoutingPolicyLoadBalancerTarget", "loadBalancerType": "A String", # The type of load balancer specified by this target. This value must match the configuration of the load balancer located at the LoadBalancerTarget's IP address, port, and region. Use the following: - *regionalL4ilb*: for a regional internal passthrough Network Load Balancer. - *regionalL7ilb*: for a regional internal Application Load Balancer. - *globalL7ilb*: for a global internal Application Load Balancer. - "networkUrl": "A String", # The fully qualified URL of the network that the load balancer is attached to. This should be formatted like https://www.googleapis.com/compute/v1/projects/{project}/global/networks/{network} . + "networkUrl": "A String", # The fully qualified URL of the network that the load balancer is attached to. This should be formatted like `https://www.googleapis.com/compute/v1/projects/{project}/global/networks/{network}`. "port": "A String", # The configured port of the load balancer. "project": "A String", # The project ID in which the load balancer is located. "region": "A String", # The region in which the load balancer is located. @@ -836,10 +836,10 @@

Method Details

"rrdatas": [ "A String", ], - "signatureRrdatas": [ # DNSSEC generated signatures for all the rrdata within this item. Note that if health checked targets are provided for DNSSEC enabled zones, there's a restriction of 1 IP address per item. + "signatureRrdatas": [ # DNSSEC generated signatures for all the `rrdata` within this item. Note that if health checked targets are provided for DNSSEC enabled zones, there's a restriction of 1 IP address per item. "A String", ], - "weight": 3.14, # The weight corresponding to this WrrPolicyItem object. When multiple WrrPolicyItem objects are configured, the probability of returning an WrrPolicyItem object's data is proportional to its weight relative to the sum of weights configured for all items. This weight must be non-negative. + "weight": 3.14, # The weight corresponding to this `WrrPolicyItem` object. When multiple `WrrPolicyItem` objects are configured, the probability of returning an `WrrPolicyItem` object's data is proportional to its weight relative to the sum of weights configured for all items. This weight must be non-negative. }, ], "kind": "dns#rRSetRoutingPolicyWrrPolicy", @@ -851,7 +851,7 @@

Method Details

"signatureRrdatas": [ # As defined in RFC 4034 (section 3.2). "A String", ], - "ttl": 42, # Number of seconds that this ResourceRecordSet can be cached by resolvers. + "ttl": 42, # Number of seconds that this `ResourceRecordSet` can be cached by resolvers. "type": "A String", # The identifier of a supported record type. See the list of Supported DNS record types. }, ], @@ -880,24 +880,24 @@

Method Details

Returns: An object of the form: - { # A Change represents a set of ResourceRecordSet additions and deletions applied atomically to a ManagedZone. ResourceRecordSets within a ManagedZone are modified by creating a new Change element in the Changes collection. In turn the Changes collection also records the past modifications to the ResourceRecordSets in a ManagedZone. The current state of the ManagedZone is the sum effect of applying all Change elements in the Changes collection in sequence. + { # A Change represents a set of `ResourceRecordSet` additions and deletions applied atomically to a ManagedZone. ResourceRecordSets within a ManagedZone are modified by creating a new Change element in the Changes collection. In turn the Changes collection also records the past modifications to the `ResourceRecordSets` in a `ManagedZone`. The current state of the `ManagedZone` is the sum effect of applying all `Change` elements in the `Changes` collection in sequence. "additions": [ # Which ResourceRecordSets to add? { # A unit of data that is returned by the DNS servers. "kind": "dns#resourceRecordSet", "name": "A String", # For example, www.example.com. - "routingPolicy": { # A RRSetRoutingPolicy represents ResourceRecordSet data that is returned dynamically with the response varying based on configured properties such as geolocation or by weighted random selection. # Configures dynamic query responses based on either the geo location of the querying user or a weighted round robin based routing policy. A valid ResourceRecordSet contains only rrdata (for static resolution) or a routing_policy (for dynamic resolution). - "geo": { # Configures a RRSetRoutingPolicy that routes based on the geo location of the querying user. + "routingPolicy": { # A RRSetRoutingPolicy represents ResourceRecordSet data that is returned dynamically with the response varying based on configured properties such as geolocation or by weighted random selection. # Configures dynamic query responses based on either the geo location of the querying user or a weighted round robin based routing policy. A valid `ResourceRecordSet` contains only `rrdata` (for static resolution) or a `routing_policy` (for dynamic resolution). + "geo": { # Configures a `RRSetRoutingPolicy` that routes based on the geo location of the querying user. "enableFencing": True or False, # Without fencing, if health check fails for all configured items in the current geo bucket, we failover to the next nearest geo bucket. With fencing, if health checking is enabled, as long as some targets in the current geo bucket are healthy, we return only the healthy targets. However, if all targets are unhealthy, we don't failover to the next nearest bucket; instead, we return all the items in the current bucket even when all targets are unhealthy. "items": [ # The primary geo routing configuration. If there are multiple items with the same location, an error is returned instead. { # ResourceRecordSet data for one geo location. - "healthCheckedTargets": { # HealthCheckTargets describes endpoints to health-check when responding to Routing Policy queries. Only the healthy endpoints will be included in the response. Only one of internal_load_balancer and external_endpoints should be set. # For A and AAAA types only. Endpoints to return in the query result only if they are healthy. These can be specified along with rrdata within this item. + "healthCheckedTargets": { # HealthCheckTargets describes endpoints to health-check when responding to Routing Policy queries. Only the healthy endpoints will be included in the response. # For A and AAAA types only. Endpoints to return in the query result only if they are healthy. These can be specified along with `rrdata` within this item. "internalLoadBalancers": [ # Configuration for internal load balancers to be health checked. { # The configuration for an individual load balancer to health check. "ipAddress": "A String", # The frontend IP address of the load balancer to health check. "ipProtocol": "A String", # The protocol of the load balancer to health check. "kind": "dns#rRSetRoutingPolicyLoadBalancerTarget", "loadBalancerType": "A String", # The type of load balancer specified by this target. This value must match the configuration of the load balancer located at the LoadBalancerTarget's IP address, port, and region. Use the following: - *regionalL4ilb*: for a regional internal passthrough Network Load Balancer. - *regionalL7ilb*: for a regional internal Application Load Balancer. - *globalL7ilb*: for a global internal Application Load Balancer. - "networkUrl": "A String", # The fully qualified URL of the network that the load balancer is attached to. This should be formatted like https://www.googleapis.com/compute/v1/projects/{project}/global/networks/{network} . + "networkUrl": "A String", # The fully qualified URL of the network that the load balancer is attached to. This should be formatted like `https://www.googleapis.com/compute/v1/projects/{project}/global/networks/{network}`. "port": "A String", # The configured port of the load balancer. "project": "A String", # The project ID in which the load balancer is located. "region": "A String", # The region in which the load balancer is located. @@ -909,25 +909,25 @@

Method Details

"rrdatas": [ "A String", ], - "signatureRrdatas": [ # DNSSEC generated signatures for all the rrdata within this item. If health checked targets are provided for DNSSEC enabled zones, there's a restriction of 1 IP address per item. + "signatureRrdatas": [ # DNSSEC generated signatures for all the `rrdata` within this item. If health checked targets are provided for DNSSEC enabled zones, there's a restriction of 1 IP address per item. "A String", ], }, ], "kind": "dns#rRSetRoutingPolicyGeoPolicy", }, - "geoPolicy": { # Configures a RRSetRoutingPolicy that routes based on the geo location of the querying user. + "geoPolicy": { # Configures a `RRSetRoutingPolicy` that routes based on the geo location of the querying user. "enableFencing": True or False, # Without fencing, if health check fails for all configured items in the current geo bucket, we failover to the next nearest geo bucket. With fencing, if health checking is enabled, as long as some targets in the current geo bucket are healthy, we return only the healthy targets. However, if all targets are unhealthy, we don't failover to the next nearest bucket; instead, we return all the items in the current bucket even when all targets are unhealthy. "items": [ # The primary geo routing configuration. If there are multiple items with the same location, an error is returned instead. { # ResourceRecordSet data for one geo location. - "healthCheckedTargets": { # HealthCheckTargets describes endpoints to health-check when responding to Routing Policy queries. Only the healthy endpoints will be included in the response. Only one of internal_load_balancer and external_endpoints should be set. # For A and AAAA types only. Endpoints to return in the query result only if they are healthy. These can be specified along with rrdata within this item. + "healthCheckedTargets": { # HealthCheckTargets describes endpoints to health-check when responding to Routing Policy queries. Only the healthy endpoints will be included in the response. # For A and AAAA types only. Endpoints to return in the query result only if they are healthy. These can be specified along with `rrdata` within this item. "internalLoadBalancers": [ # Configuration for internal load balancers to be health checked. { # The configuration for an individual load balancer to health check. "ipAddress": "A String", # The frontend IP address of the load balancer to health check. "ipProtocol": "A String", # The protocol of the load balancer to health check. "kind": "dns#rRSetRoutingPolicyLoadBalancerTarget", "loadBalancerType": "A String", # The type of load balancer specified by this target. This value must match the configuration of the load balancer located at the LoadBalancerTarget's IP address, port, and region. Use the following: - *regionalL4ilb*: for a regional internal passthrough Network Load Balancer. - *regionalL7ilb*: for a regional internal Application Load Balancer. - *globalL7ilb*: for a global internal Application Load Balancer. - "networkUrl": "A String", # The fully qualified URL of the network that the load balancer is attached to. This should be formatted like https://www.googleapis.com/compute/v1/projects/{project}/global/networks/{network} . + "networkUrl": "A String", # The fully qualified URL of the network that the load balancer is attached to. This should be formatted like `https://www.googleapis.com/compute/v1/projects/{project}/global/networks/{network}`. "port": "A String", # The configured port of the load balancer. "project": "A String", # The project ID in which the load balancer is located. "region": "A String", # The region in which the load balancer is located. @@ -939,7 +939,7 @@

Method Details

"rrdatas": [ "A String", ], - "signatureRrdatas": [ # DNSSEC generated signatures for all the rrdata within this item. If health checked targets are provided for DNSSEC enabled zones, there's a restriction of 1 IP address per item. + "signatureRrdatas": [ # DNSSEC generated signatures for all the `rrdata` within this item. If health checked targets are provided for DNSSEC enabled zones, there's a restriction of 1 IP address per item. "A String", ], }, @@ -948,18 +948,18 @@

Method Details

}, "kind": "dns#rRSetRoutingPolicy", "primaryBackup": { # Configures a RRSetRoutingPolicy such that all queries are responded with the primary_targets if they are healthy. And if all of them are unhealthy, then we fallback to a geo localized policy. - "backupGeoTargets": { # Configures a RRSetRoutingPolicy that routes based on the geo location of the querying user. # Backup targets provide a regional failover policy for the otherwise global primary targets. If serving state is set to BACKUP, this policy essentially becomes a geo routing policy. + "backupGeoTargets": { # Configures a `RRSetRoutingPolicy` that routes based on the geo location of the querying user. # Backup targets provide a regional failover policy for the otherwise global primary targets. If serving state is set to `BACKUP`, this policy essentially becomes a geo routing policy. "enableFencing": True or False, # Without fencing, if health check fails for all configured items in the current geo bucket, we failover to the next nearest geo bucket. With fencing, if health checking is enabled, as long as some targets in the current geo bucket are healthy, we return only the healthy targets. However, if all targets are unhealthy, we don't failover to the next nearest bucket; instead, we return all the items in the current bucket even when all targets are unhealthy. "items": [ # The primary geo routing configuration. If there are multiple items with the same location, an error is returned instead. { # ResourceRecordSet data for one geo location. - "healthCheckedTargets": { # HealthCheckTargets describes endpoints to health-check when responding to Routing Policy queries. Only the healthy endpoints will be included in the response. Only one of internal_load_balancer and external_endpoints should be set. # For A and AAAA types only. Endpoints to return in the query result only if they are healthy. These can be specified along with rrdata within this item. + "healthCheckedTargets": { # HealthCheckTargets describes endpoints to health-check when responding to Routing Policy queries. Only the healthy endpoints will be included in the response. # For A and AAAA types only. Endpoints to return in the query result only if they are healthy. These can be specified along with `rrdata` within this item. "internalLoadBalancers": [ # Configuration for internal load balancers to be health checked. { # The configuration for an individual load balancer to health check. "ipAddress": "A String", # The frontend IP address of the load balancer to health check. "ipProtocol": "A String", # The protocol of the load balancer to health check. "kind": "dns#rRSetRoutingPolicyLoadBalancerTarget", "loadBalancerType": "A String", # The type of load balancer specified by this target. This value must match the configuration of the load balancer located at the LoadBalancerTarget's IP address, port, and region. Use the following: - *regionalL4ilb*: for a regional internal passthrough Network Load Balancer. - *regionalL7ilb*: for a regional internal Application Load Balancer. - *globalL7ilb*: for a global internal Application Load Balancer. - "networkUrl": "A String", # The fully qualified URL of the network that the load balancer is attached to. This should be formatted like https://www.googleapis.com/compute/v1/projects/{project}/global/networks/{network} . + "networkUrl": "A String", # The fully qualified URL of the network that the load balancer is attached to. This should be formatted like `https://www.googleapis.com/compute/v1/projects/{project}/global/networks/{network}`. "port": "A String", # The configured port of the load balancer. "project": "A String", # The project ID in which the load balancer is located. "region": "A String", # The region in which the load balancer is located. @@ -971,7 +971,7 @@

Method Details

"rrdatas": [ "A String", ], - "signatureRrdatas": [ # DNSSEC generated signatures for all the rrdata within this item. If health checked targets are provided for DNSSEC enabled zones, there's a restriction of 1 IP address per item. + "signatureRrdatas": [ # DNSSEC generated signatures for all the `rrdata` within this item. If health checked targets are provided for DNSSEC enabled zones, there's a restriction of 1 IP address per item. "A String", ], }, @@ -979,33 +979,33 @@

Method Details

"kind": "dns#rRSetRoutingPolicyGeoPolicy", }, "kind": "dns#rRSetRoutingPolicyPrimaryBackupPolicy", - "primaryTargets": { # HealthCheckTargets describes endpoints to health-check when responding to Routing Policy queries. Only the healthy endpoints will be included in the response. Only one of internal_load_balancer and external_endpoints should be set. # Endpoints that are health checked before making the routing decision. Unhealthy endpoints are omitted from the results. If all endpoints are unhealthy, we serve a response based on the backup_geo_targets. + "primaryTargets": { # HealthCheckTargets describes endpoints to health-check when responding to Routing Policy queries. Only the healthy endpoints will be included in the response. # Endpoints that are health checked before making the routing decision. Unhealthy endpoints are omitted from the results. If all endpoints are unhealthy, we serve a response based on the `backup_geo_targets`. "internalLoadBalancers": [ # Configuration for internal load balancers to be health checked. { # The configuration for an individual load balancer to health check. "ipAddress": "A String", # The frontend IP address of the load balancer to health check. "ipProtocol": "A String", # The protocol of the load balancer to health check. "kind": "dns#rRSetRoutingPolicyLoadBalancerTarget", "loadBalancerType": "A String", # The type of load balancer specified by this target. This value must match the configuration of the load balancer located at the LoadBalancerTarget's IP address, port, and region. Use the following: - *regionalL4ilb*: for a regional internal passthrough Network Load Balancer. - *regionalL7ilb*: for a regional internal Application Load Balancer. - *globalL7ilb*: for a global internal Application Load Balancer. - "networkUrl": "A String", # The fully qualified URL of the network that the load balancer is attached to. This should be formatted like https://www.googleapis.com/compute/v1/projects/{project}/global/networks/{network} . + "networkUrl": "A String", # The fully qualified URL of the network that the load balancer is attached to. This should be formatted like `https://www.googleapis.com/compute/v1/projects/{project}/global/networks/{network}`. "port": "A String", # The configured port of the load balancer. "project": "A String", # The project ID in which the load balancer is located. "region": "A String", # The region in which the load balancer is located. }, ], }, - "trickleTraffic": 3.14, # When serving state is PRIMARY, this field provides the option of sending a small percentage of the traffic to the backup targets. + "trickleTraffic": 3.14, # When serving state is `PRIMARY`, this field provides the option of sending a small percentage of the traffic to the backup targets. }, "wrr": { # Configures a RRSetRoutingPolicy that routes in a weighted round robin fashion. "items": [ { # A routing block which contains the routing information for one WRR item. - "healthCheckedTargets": { # HealthCheckTargets describes endpoints to health-check when responding to Routing Policy queries. Only the healthy endpoints will be included in the response. Only one of internal_load_balancer and external_endpoints should be set. # Endpoints that are health checked before making the routing decision. The unhealthy endpoints are omitted from the result. If all endpoints within a bucket are unhealthy, we choose a different bucket (sampled with respect to its weight) for responding. If DNSSEC is enabled for this zone, only one of rrdata or health_checked_targets can be set. + "healthCheckedTargets": { # HealthCheckTargets describes endpoints to health-check when responding to Routing Policy queries. Only the healthy endpoints will be included in the response. # Endpoints that are health checked before making the routing decision. The unhealthy endpoints are omitted from the result. If all endpoints within a bucket are unhealthy, we choose a different bucket (sampled with respect to its weight) for responding. If DNSSEC is enabled for this zone, only one of `rrdata` or `health_checked_targets` can be set. "internalLoadBalancers": [ # Configuration for internal load balancers to be health checked. { # The configuration for an individual load balancer to health check. "ipAddress": "A String", # The frontend IP address of the load balancer to health check. "ipProtocol": "A String", # The protocol of the load balancer to health check. "kind": "dns#rRSetRoutingPolicyLoadBalancerTarget", "loadBalancerType": "A String", # The type of load balancer specified by this target. This value must match the configuration of the load balancer located at the LoadBalancerTarget's IP address, port, and region. Use the following: - *regionalL4ilb*: for a regional internal passthrough Network Load Balancer. - *regionalL7ilb*: for a regional internal Application Load Balancer. - *globalL7ilb*: for a global internal Application Load Balancer. - "networkUrl": "A String", # The fully qualified URL of the network that the load balancer is attached to. This should be formatted like https://www.googleapis.com/compute/v1/projects/{project}/global/networks/{network} . + "networkUrl": "A String", # The fully qualified URL of the network that the load balancer is attached to. This should be formatted like `https://www.googleapis.com/compute/v1/projects/{project}/global/networks/{network}`. "port": "A String", # The configured port of the load balancer. "project": "A String", # The project ID in which the load balancer is located. "region": "A String", # The region in which the load balancer is located. @@ -1016,10 +1016,10 @@

Method Details

"rrdatas": [ "A String", ], - "signatureRrdatas": [ # DNSSEC generated signatures for all the rrdata within this item. Note that if health checked targets are provided for DNSSEC enabled zones, there's a restriction of 1 IP address per item. + "signatureRrdatas": [ # DNSSEC generated signatures for all the `rrdata` within this item. Note that if health checked targets are provided for DNSSEC enabled zones, there's a restriction of 1 IP address per item. "A String", ], - "weight": 3.14, # The weight corresponding to this WrrPolicyItem object. When multiple WrrPolicyItem objects are configured, the probability of returning an WrrPolicyItem object's data is proportional to its weight relative to the sum of weights configured for all items. This weight must be non-negative. + "weight": 3.14, # The weight corresponding to this `WrrPolicyItem` object. When multiple `WrrPolicyItem` objects are configured, the probability of returning an `WrrPolicyItem` object's data is proportional to its weight relative to the sum of weights configured for all items. This weight must be non-negative. }, ], "kind": "dns#rRSetRoutingPolicyWrrPolicy", @@ -1027,14 +1027,14 @@

Method Details

"wrrPolicy": { # Configures a RRSetRoutingPolicy that routes in a weighted round robin fashion. "items": [ { # A routing block which contains the routing information for one WRR item. - "healthCheckedTargets": { # HealthCheckTargets describes endpoints to health-check when responding to Routing Policy queries. Only the healthy endpoints will be included in the response. Only one of internal_load_balancer and external_endpoints should be set. # Endpoints that are health checked before making the routing decision. The unhealthy endpoints are omitted from the result. If all endpoints within a bucket are unhealthy, we choose a different bucket (sampled with respect to its weight) for responding. If DNSSEC is enabled for this zone, only one of rrdata or health_checked_targets can be set. + "healthCheckedTargets": { # HealthCheckTargets describes endpoints to health-check when responding to Routing Policy queries. Only the healthy endpoints will be included in the response. # Endpoints that are health checked before making the routing decision. The unhealthy endpoints are omitted from the result. If all endpoints within a bucket are unhealthy, we choose a different bucket (sampled with respect to its weight) for responding. If DNSSEC is enabled for this zone, only one of `rrdata` or `health_checked_targets` can be set. "internalLoadBalancers": [ # Configuration for internal load balancers to be health checked. { # The configuration for an individual load balancer to health check. "ipAddress": "A String", # The frontend IP address of the load balancer to health check. "ipProtocol": "A String", # The protocol of the load balancer to health check. "kind": "dns#rRSetRoutingPolicyLoadBalancerTarget", "loadBalancerType": "A String", # The type of load balancer specified by this target. This value must match the configuration of the load balancer located at the LoadBalancerTarget's IP address, port, and region. Use the following: - *regionalL4ilb*: for a regional internal passthrough Network Load Balancer. - *regionalL7ilb*: for a regional internal Application Load Balancer. - *globalL7ilb*: for a global internal Application Load Balancer. - "networkUrl": "A String", # The fully qualified URL of the network that the load balancer is attached to. This should be formatted like https://www.googleapis.com/compute/v1/projects/{project}/global/networks/{network} . + "networkUrl": "A String", # The fully qualified URL of the network that the load balancer is attached to. This should be formatted like `https://www.googleapis.com/compute/v1/projects/{project}/global/networks/{network}`. "port": "A String", # The configured port of the load balancer. "project": "A String", # The project ID in which the load balancer is located. "region": "A String", # The region in which the load balancer is located. @@ -1045,10 +1045,10 @@

Method Details

"rrdatas": [ "A String", ], - "signatureRrdatas": [ # DNSSEC generated signatures for all the rrdata within this item. Note that if health checked targets are provided for DNSSEC enabled zones, there's a restriction of 1 IP address per item. + "signatureRrdatas": [ # DNSSEC generated signatures for all the `rrdata` within this item. Note that if health checked targets are provided for DNSSEC enabled zones, there's a restriction of 1 IP address per item. "A String", ], - "weight": 3.14, # The weight corresponding to this WrrPolicyItem object. When multiple WrrPolicyItem objects are configured, the probability of returning an WrrPolicyItem object's data is proportional to its weight relative to the sum of weights configured for all items. This weight must be non-negative. + "weight": 3.14, # The weight corresponding to this `WrrPolicyItem` object. When multiple `WrrPolicyItem` objects are configured, the probability of returning an `WrrPolicyItem` object's data is proportional to its weight relative to the sum of weights configured for all items. This weight must be non-negative. }, ], "kind": "dns#rRSetRoutingPolicyWrrPolicy", @@ -1060,7 +1060,7 @@

Method Details

"signatureRrdatas": [ # As defined in RFC 4034 (section 3.2). "A String", ], - "ttl": 42, # Number of seconds that this ResourceRecordSet can be cached by resolvers. + "ttl": 42, # Number of seconds that this `ResourceRecordSet` can be cached by resolvers. "type": "A String", # The identifier of a supported record type. See the list of Supported DNS record types. }, ], @@ -1068,19 +1068,19 @@

Method Details

{ # A unit of data that is returned by the DNS servers. "kind": "dns#resourceRecordSet", "name": "A String", # For example, www.example.com. - "routingPolicy": { # A RRSetRoutingPolicy represents ResourceRecordSet data that is returned dynamically with the response varying based on configured properties such as geolocation or by weighted random selection. # Configures dynamic query responses based on either the geo location of the querying user or a weighted round robin based routing policy. A valid ResourceRecordSet contains only rrdata (for static resolution) or a routing_policy (for dynamic resolution). - "geo": { # Configures a RRSetRoutingPolicy that routes based on the geo location of the querying user. + "routingPolicy": { # A RRSetRoutingPolicy represents ResourceRecordSet data that is returned dynamically with the response varying based on configured properties such as geolocation or by weighted random selection. # Configures dynamic query responses based on either the geo location of the querying user or a weighted round robin based routing policy. A valid `ResourceRecordSet` contains only `rrdata` (for static resolution) or a `routing_policy` (for dynamic resolution). + "geo": { # Configures a `RRSetRoutingPolicy` that routes based on the geo location of the querying user. "enableFencing": True or False, # Without fencing, if health check fails for all configured items in the current geo bucket, we failover to the next nearest geo bucket. With fencing, if health checking is enabled, as long as some targets in the current geo bucket are healthy, we return only the healthy targets. However, if all targets are unhealthy, we don't failover to the next nearest bucket; instead, we return all the items in the current bucket even when all targets are unhealthy. "items": [ # The primary geo routing configuration. If there are multiple items with the same location, an error is returned instead. { # ResourceRecordSet data for one geo location. - "healthCheckedTargets": { # HealthCheckTargets describes endpoints to health-check when responding to Routing Policy queries. Only the healthy endpoints will be included in the response. Only one of internal_load_balancer and external_endpoints should be set. # For A and AAAA types only. Endpoints to return in the query result only if they are healthy. These can be specified along with rrdata within this item. + "healthCheckedTargets": { # HealthCheckTargets describes endpoints to health-check when responding to Routing Policy queries. Only the healthy endpoints will be included in the response. # For A and AAAA types only. Endpoints to return in the query result only if they are healthy. These can be specified along with `rrdata` within this item. "internalLoadBalancers": [ # Configuration for internal load balancers to be health checked. { # The configuration for an individual load balancer to health check. "ipAddress": "A String", # The frontend IP address of the load balancer to health check. "ipProtocol": "A String", # The protocol of the load balancer to health check. "kind": "dns#rRSetRoutingPolicyLoadBalancerTarget", "loadBalancerType": "A String", # The type of load balancer specified by this target. This value must match the configuration of the load balancer located at the LoadBalancerTarget's IP address, port, and region. Use the following: - *regionalL4ilb*: for a regional internal passthrough Network Load Balancer. - *regionalL7ilb*: for a regional internal Application Load Balancer. - *globalL7ilb*: for a global internal Application Load Balancer. - "networkUrl": "A String", # The fully qualified URL of the network that the load balancer is attached to. This should be formatted like https://www.googleapis.com/compute/v1/projects/{project}/global/networks/{network} . + "networkUrl": "A String", # The fully qualified URL of the network that the load balancer is attached to. This should be formatted like `https://www.googleapis.com/compute/v1/projects/{project}/global/networks/{network}`. "port": "A String", # The configured port of the load balancer. "project": "A String", # The project ID in which the load balancer is located. "region": "A String", # The region in which the load balancer is located. @@ -1092,25 +1092,25 @@

Method Details

"rrdatas": [ "A String", ], - "signatureRrdatas": [ # DNSSEC generated signatures for all the rrdata within this item. If health checked targets are provided for DNSSEC enabled zones, there's a restriction of 1 IP address per item. + "signatureRrdatas": [ # DNSSEC generated signatures for all the `rrdata` within this item. If health checked targets are provided for DNSSEC enabled zones, there's a restriction of 1 IP address per item. "A String", ], }, ], "kind": "dns#rRSetRoutingPolicyGeoPolicy", }, - "geoPolicy": { # Configures a RRSetRoutingPolicy that routes based on the geo location of the querying user. + "geoPolicy": { # Configures a `RRSetRoutingPolicy` that routes based on the geo location of the querying user. "enableFencing": True or False, # Without fencing, if health check fails for all configured items in the current geo bucket, we failover to the next nearest geo bucket. With fencing, if health checking is enabled, as long as some targets in the current geo bucket are healthy, we return only the healthy targets. However, if all targets are unhealthy, we don't failover to the next nearest bucket; instead, we return all the items in the current bucket even when all targets are unhealthy. "items": [ # The primary geo routing configuration. If there are multiple items with the same location, an error is returned instead. { # ResourceRecordSet data for one geo location. - "healthCheckedTargets": { # HealthCheckTargets describes endpoints to health-check when responding to Routing Policy queries. Only the healthy endpoints will be included in the response. Only one of internal_load_balancer and external_endpoints should be set. # For A and AAAA types only. Endpoints to return in the query result only if they are healthy. These can be specified along with rrdata within this item. + "healthCheckedTargets": { # HealthCheckTargets describes endpoints to health-check when responding to Routing Policy queries. Only the healthy endpoints will be included in the response. # For A and AAAA types only. Endpoints to return in the query result only if they are healthy. These can be specified along with `rrdata` within this item. "internalLoadBalancers": [ # Configuration for internal load balancers to be health checked. { # The configuration for an individual load balancer to health check. "ipAddress": "A String", # The frontend IP address of the load balancer to health check. "ipProtocol": "A String", # The protocol of the load balancer to health check. "kind": "dns#rRSetRoutingPolicyLoadBalancerTarget", "loadBalancerType": "A String", # The type of load balancer specified by this target. This value must match the configuration of the load balancer located at the LoadBalancerTarget's IP address, port, and region. Use the following: - *regionalL4ilb*: for a regional internal passthrough Network Load Balancer. - *regionalL7ilb*: for a regional internal Application Load Balancer. - *globalL7ilb*: for a global internal Application Load Balancer. - "networkUrl": "A String", # The fully qualified URL of the network that the load balancer is attached to. This should be formatted like https://www.googleapis.com/compute/v1/projects/{project}/global/networks/{network} . + "networkUrl": "A String", # The fully qualified URL of the network that the load balancer is attached to. This should be formatted like `https://www.googleapis.com/compute/v1/projects/{project}/global/networks/{network}`. "port": "A String", # The configured port of the load balancer. "project": "A String", # The project ID in which the load balancer is located. "region": "A String", # The region in which the load balancer is located. @@ -1122,7 +1122,7 @@

Method Details

"rrdatas": [ "A String", ], - "signatureRrdatas": [ # DNSSEC generated signatures for all the rrdata within this item. If health checked targets are provided for DNSSEC enabled zones, there's a restriction of 1 IP address per item. + "signatureRrdatas": [ # DNSSEC generated signatures for all the `rrdata` within this item. If health checked targets are provided for DNSSEC enabled zones, there's a restriction of 1 IP address per item. "A String", ], }, @@ -1131,18 +1131,18 @@

Method Details

}, "kind": "dns#rRSetRoutingPolicy", "primaryBackup": { # Configures a RRSetRoutingPolicy such that all queries are responded with the primary_targets if they are healthy. And if all of them are unhealthy, then we fallback to a geo localized policy. - "backupGeoTargets": { # Configures a RRSetRoutingPolicy that routes based on the geo location of the querying user. # Backup targets provide a regional failover policy for the otherwise global primary targets. If serving state is set to BACKUP, this policy essentially becomes a geo routing policy. + "backupGeoTargets": { # Configures a `RRSetRoutingPolicy` that routes based on the geo location of the querying user. # Backup targets provide a regional failover policy for the otherwise global primary targets. If serving state is set to `BACKUP`, this policy essentially becomes a geo routing policy. "enableFencing": True or False, # Without fencing, if health check fails for all configured items in the current geo bucket, we failover to the next nearest geo bucket. With fencing, if health checking is enabled, as long as some targets in the current geo bucket are healthy, we return only the healthy targets. However, if all targets are unhealthy, we don't failover to the next nearest bucket; instead, we return all the items in the current bucket even when all targets are unhealthy. "items": [ # The primary geo routing configuration. If there are multiple items with the same location, an error is returned instead. { # ResourceRecordSet data for one geo location. - "healthCheckedTargets": { # HealthCheckTargets describes endpoints to health-check when responding to Routing Policy queries. Only the healthy endpoints will be included in the response. Only one of internal_load_balancer and external_endpoints should be set. # For A and AAAA types only. Endpoints to return in the query result only if they are healthy. These can be specified along with rrdata within this item. + "healthCheckedTargets": { # HealthCheckTargets describes endpoints to health-check when responding to Routing Policy queries. Only the healthy endpoints will be included in the response. # For A and AAAA types only. Endpoints to return in the query result only if they are healthy. These can be specified along with `rrdata` within this item. "internalLoadBalancers": [ # Configuration for internal load balancers to be health checked. { # The configuration for an individual load balancer to health check. "ipAddress": "A String", # The frontend IP address of the load balancer to health check. "ipProtocol": "A String", # The protocol of the load balancer to health check. "kind": "dns#rRSetRoutingPolicyLoadBalancerTarget", "loadBalancerType": "A String", # The type of load balancer specified by this target. This value must match the configuration of the load balancer located at the LoadBalancerTarget's IP address, port, and region. Use the following: - *regionalL4ilb*: for a regional internal passthrough Network Load Balancer. - *regionalL7ilb*: for a regional internal Application Load Balancer. - *globalL7ilb*: for a global internal Application Load Balancer. - "networkUrl": "A String", # The fully qualified URL of the network that the load balancer is attached to. This should be formatted like https://www.googleapis.com/compute/v1/projects/{project}/global/networks/{network} . + "networkUrl": "A String", # The fully qualified URL of the network that the load balancer is attached to. This should be formatted like `https://www.googleapis.com/compute/v1/projects/{project}/global/networks/{network}`. "port": "A String", # The configured port of the load balancer. "project": "A String", # The project ID in which the load balancer is located. "region": "A String", # The region in which the load balancer is located. @@ -1154,7 +1154,7 @@

Method Details

"rrdatas": [ "A String", ], - "signatureRrdatas": [ # DNSSEC generated signatures for all the rrdata within this item. If health checked targets are provided for DNSSEC enabled zones, there's a restriction of 1 IP address per item. + "signatureRrdatas": [ # DNSSEC generated signatures for all the `rrdata` within this item. If health checked targets are provided for DNSSEC enabled zones, there's a restriction of 1 IP address per item. "A String", ], }, @@ -1162,33 +1162,33 @@

Method Details

"kind": "dns#rRSetRoutingPolicyGeoPolicy", }, "kind": "dns#rRSetRoutingPolicyPrimaryBackupPolicy", - "primaryTargets": { # HealthCheckTargets describes endpoints to health-check when responding to Routing Policy queries. Only the healthy endpoints will be included in the response. Only one of internal_load_balancer and external_endpoints should be set. # Endpoints that are health checked before making the routing decision. Unhealthy endpoints are omitted from the results. If all endpoints are unhealthy, we serve a response based on the backup_geo_targets. + "primaryTargets": { # HealthCheckTargets describes endpoints to health-check when responding to Routing Policy queries. Only the healthy endpoints will be included in the response. # Endpoints that are health checked before making the routing decision. Unhealthy endpoints are omitted from the results. If all endpoints are unhealthy, we serve a response based on the `backup_geo_targets`. "internalLoadBalancers": [ # Configuration for internal load balancers to be health checked. { # The configuration for an individual load balancer to health check. "ipAddress": "A String", # The frontend IP address of the load balancer to health check. "ipProtocol": "A String", # The protocol of the load balancer to health check. "kind": "dns#rRSetRoutingPolicyLoadBalancerTarget", "loadBalancerType": "A String", # The type of load balancer specified by this target. This value must match the configuration of the load balancer located at the LoadBalancerTarget's IP address, port, and region. Use the following: - *regionalL4ilb*: for a regional internal passthrough Network Load Balancer. - *regionalL7ilb*: for a regional internal Application Load Balancer. - *globalL7ilb*: for a global internal Application Load Balancer. - "networkUrl": "A String", # The fully qualified URL of the network that the load balancer is attached to. This should be formatted like https://www.googleapis.com/compute/v1/projects/{project}/global/networks/{network} . + "networkUrl": "A String", # The fully qualified URL of the network that the load balancer is attached to. This should be formatted like `https://www.googleapis.com/compute/v1/projects/{project}/global/networks/{network}`. "port": "A String", # The configured port of the load balancer. "project": "A String", # The project ID in which the load balancer is located. "region": "A String", # The region in which the load balancer is located. }, ], }, - "trickleTraffic": 3.14, # When serving state is PRIMARY, this field provides the option of sending a small percentage of the traffic to the backup targets. + "trickleTraffic": 3.14, # When serving state is `PRIMARY`, this field provides the option of sending a small percentage of the traffic to the backup targets. }, "wrr": { # Configures a RRSetRoutingPolicy that routes in a weighted round robin fashion. "items": [ { # A routing block which contains the routing information for one WRR item. - "healthCheckedTargets": { # HealthCheckTargets describes endpoints to health-check when responding to Routing Policy queries. Only the healthy endpoints will be included in the response. Only one of internal_load_balancer and external_endpoints should be set. # Endpoints that are health checked before making the routing decision. The unhealthy endpoints are omitted from the result. If all endpoints within a bucket are unhealthy, we choose a different bucket (sampled with respect to its weight) for responding. If DNSSEC is enabled for this zone, only one of rrdata or health_checked_targets can be set. + "healthCheckedTargets": { # HealthCheckTargets describes endpoints to health-check when responding to Routing Policy queries. Only the healthy endpoints will be included in the response. # Endpoints that are health checked before making the routing decision. The unhealthy endpoints are omitted from the result. If all endpoints within a bucket are unhealthy, we choose a different bucket (sampled with respect to its weight) for responding. If DNSSEC is enabled for this zone, only one of `rrdata` or `health_checked_targets` can be set. "internalLoadBalancers": [ # Configuration for internal load balancers to be health checked. { # The configuration for an individual load balancer to health check. "ipAddress": "A String", # The frontend IP address of the load balancer to health check. "ipProtocol": "A String", # The protocol of the load balancer to health check. "kind": "dns#rRSetRoutingPolicyLoadBalancerTarget", "loadBalancerType": "A String", # The type of load balancer specified by this target. This value must match the configuration of the load balancer located at the LoadBalancerTarget's IP address, port, and region. Use the following: - *regionalL4ilb*: for a regional internal passthrough Network Load Balancer. - *regionalL7ilb*: for a regional internal Application Load Balancer. - *globalL7ilb*: for a global internal Application Load Balancer. - "networkUrl": "A String", # The fully qualified URL of the network that the load balancer is attached to. This should be formatted like https://www.googleapis.com/compute/v1/projects/{project}/global/networks/{network} . + "networkUrl": "A String", # The fully qualified URL of the network that the load balancer is attached to. This should be formatted like `https://www.googleapis.com/compute/v1/projects/{project}/global/networks/{network}`. "port": "A String", # The configured port of the load balancer. "project": "A String", # The project ID in which the load balancer is located. "region": "A String", # The region in which the load balancer is located. @@ -1199,10 +1199,10 @@

Method Details

"rrdatas": [ "A String", ], - "signatureRrdatas": [ # DNSSEC generated signatures for all the rrdata within this item. Note that if health checked targets are provided for DNSSEC enabled zones, there's a restriction of 1 IP address per item. + "signatureRrdatas": [ # DNSSEC generated signatures for all the `rrdata` within this item. Note that if health checked targets are provided for DNSSEC enabled zones, there's a restriction of 1 IP address per item. "A String", ], - "weight": 3.14, # The weight corresponding to this WrrPolicyItem object. When multiple WrrPolicyItem objects are configured, the probability of returning an WrrPolicyItem object's data is proportional to its weight relative to the sum of weights configured for all items. This weight must be non-negative. + "weight": 3.14, # The weight corresponding to this `WrrPolicyItem` object. When multiple `WrrPolicyItem` objects are configured, the probability of returning an `WrrPolicyItem` object's data is proportional to its weight relative to the sum of weights configured for all items. This weight must be non-negative. }, ], "kind": "dns#rRSetRoutingPolicyWrrPolicy", @@ -1210,14 +1210,14 @@

Method Details

"wrrPolicy": { # Configures a RRSetRoutingPolicy that routes in a weighted round robin fashion. "items": [ { # A routing block which contains the routing information for one WRR item. - "healthCheckedTargets": { # HealthCheckTargets describes endpoints to health-check when responding to Routing Policy queries. Only the healthy endpoints will be included in the response. Only one of internal_load_balancer and external_endpoints should be set. # Endpoints that are health checked before making the routing decision. The unhealthy endpoints are omitted from the result. If all endpoints within a bucket are unhealthy, we choose a different bucket (sampled with respect to its weight) for responding. If DNSSEC is enabled for this zone, only one of rrdata or health_checked_targets can be set. + "healthCheckedTargets": { # HealthCheckTargets describes endpoints to health-check when responding to Routing Policy queries. Only the healthy endpoints will be included in the response. # Endpoints that are health checked before making the routing decision. The unhealthy endpoints are omitted from the result. If all endpoints within a bucket are unhealthy, we choose a different bucket (sampled with respect to its weight) for responding. If DNSSEC is enabled for this zone, only one of `rrdata` or `health_checked_targets` can be set. "internalLoadBalancers": [ # Configuration for internal load balancers to be health checked. { # The configuration for an individual load balancer to health check. "ipAddress": "A String", # The frontend IP address of the load balancer to health check. "ipProtocol": "A String", # The protocol of the load balancer to health check. "kind": "dns#rRSetRoutingPolicyLoadBalancerTarget", "loadBalancerType": "A String", # The type of load balancer specified by this target. This value must match the configuration of the load balancer located at the LoadBalancerTarget's IP address, port, and region. Use the following: - *regionalL4ilb*: for a regional internal passthrough Network Load Balancer. - *regionalL7ilb*: for a regional internal Application Load Balancer. - *globalL7ilb*: for a global internal Application Load Balancer. - "networkUrl": "A String", # The fully qualified URL of the network that the load balancer is attached to. This should be formatted like https://www.googleapis.com/compute/v1/projects/{project}/global/networks/{network} . + "networkUrl": "A String", # The fully qualified URL of the network that the load balancer is attached to. This should be formatted like `https://www.googleapis.com/compute/v1/projects/{project}/global/networks/{network}`. "port": "A String", # The configured port of the load balancer. "project": "A String", # The project ID in which the load balancer is located. "region": "A String", # The region in which the load balancer is located. @@ -1228,10 +1228,10 @@

Method Details

"rrdatas": [ "A String", ], - "signatureRrdatas": [ # DNSSEC generated signatures for all the rrdata within this item. Note that if health checked targets are provided for DNSSEC enabled zones, there's a restriction of 1 IP address per item. + "signatureRrdatas": [ # DNSSEC generated signatures for all the `rrdata` within this item. Note that if health checked targets are provided for DNSSEC enabled zones, there's a restriction of 1 IP address per item. "A String", ], - "weight": 3.14, # The weight corresponding to this WrrPolicyItem object. When multiple WrrPolicyItem objects are configured, the probability of returning an WrrPolicyItem object's data is proportional to its weight relative to the sum of weights configured for all items. This weight must be non-negative. + "weight": 3.14, # The weight corresponding to this `WrrPolicyItem` object. When multiple `WrrPolicyItem` objects are configured, the probability of returning an `WrrPolicyItem` object's data is proportional to its weight relative to the sum of weights configured for all items. This weight must be non-negative. }, ], "kind": "dns#rRSetRoutingPolicyWrrPolicy", @@ -1243,7 +1243,7 @@

Method Details

"signatureRrdatas": [ # As defined in RFC 4034 (section 3.2). "A String", ], - "ttl": 42, # Number of seconds that this ResourceRecordSet can be cached by resolvers. + "ttl": 42, # Number of seconds that this `ResourceRecordSet` can be cached by resolvers. "type": "A String", # The identifier of a supported record type. See the list of Supported DNS record types. }, ], @@ -1278,24 +1278,24 @@

Method Details

{ # The response to a request to enumerate Changes to a ResourceRecordSets collection. "changes": [ # The requested changes. - { # A Change represents a set of ResourceRecordSet additions and deletions applied atomically to a ManagedZone. ResourceRecordSets within a ManagedZone are modified by creating a new Change element in the Changes collection. In turn the Changes collection also records the past modifications to the ResourceRecordSets in a ManagedZone. The current state of the ManagedZone is the sum effect of applying all Change elements in the Changes collection in sequence. + { # A Change represents a set of `ResourceRecordSet` additions and deletions applied atomically to a ManagedZone. ResourceRecordSets within a ManagedZone are modified by creating a new Change element in the Changes collection. In turn the Changes collection also records the past modifications to the `ResourceRecordSets` in a `ManagedZone`. The current state of the `ManagedZone` is the sum effect of applying all `Change` elements in the `Changes` collection in sequence. "additions": [ # Which ResourceRecordSets to add? { # A unit of data that is returned by the DNS servers. "kind": "dns#resourceRecordSet", "name": "A String", # For example, www.example.com. - "routingPolicy": { # A RRSetRoutingPolicy represents ResourceRecordSet data that is returned dynamically with the response varying based on configured properties such as geolocation or by weighted random selection. # Configures dynamic query responses based on either the geo location of the querying user or a weighted round robin based routing policy. A valid ResourceRecordSet contains only rrdata (for static resolution) or a routing_policy (for dynamic resolution). - "geo": { # Configures a RRSetRoutingPolicy that routes based on the geo location of the querying user. + "routingPolicy": { # A RRSetRoutingPolicy represents ResourceRecordSet data that is returned dynamically with the response varying based on configured properties such as geolocation or by weighted random selection. # Configures dynamic query responses based on either the geo location of the querying user or a weighted round robin based routing policy. A valid `ResourceRecordSet` contains only `rrdata` (for static resolution) or a `routing_policy` (for dynamic resolution). + "geo": { # Configures a `RRSetRoutingPolicy` that routes based on the geo location of the querying user. "enableFencing": True or False, # Without fencing, if health check fails for all configured items in the current geo bucket, we failover to the next nearest geo bucket. With fencing, if health checking is enabled, as long as some targets in the current geo bucket are healthy, we return only the healthy targets. However, if all targets are unhealthy, we don't failover to the next nearest bucket; instead, we return all the items in the current bucket even when all targets are unhealthy. "items": [ # The primary geo routing configuration. If there are multiple items with the same location, an error is returned instead. { # ResourceRecordSet data for one geo location. - "healthCheckedTargets": { # HealthCheckTargets describes endpoints to health-check when responding to Routing Policy queries. Only the healthy endpoints will be included in the response. Only one of internal_load_balancer and external_endpoints should be set. # For A and AAAA types only. Endpoints to return in the query result only if they are healthy. These can be specified along with rrdata within this item. + "healthCheckedTargets": { # HealthCheckTargets describes endpoints to health-check when responding to Routing Policy queries. Only the healthy endpoints will be included in the response. # For A and AAAA types only. Endpoints to return in the query result only if they are healthy. These can be specified along with `rrdata` within this item. "internalLoadBalancers": [ # Configuration for internal load balancers to be health checked. { # The configuration for an individual load balancer to health check. "ipAddress": "A String", # The frontend IP address of the load balancer to health check. "ipProtocol": "A String", # The protocol of the load balancer to health check. "kind": "dns#rRSetRoutingPolicyLoadBalancerTarget", "loadBalancerType": "A String", # The type of load balancer specified by this target. This value must match the configuration of the load balancer located at the LoadBalancerTarget's IP address, port, and region. Use the following: - *regionalL4ilb*: for a regional internal passthrough Network Load Balancer. - *regionalL7ilb*: for a regional internal Application Load Balancer. - *globalL7ilb*: for a global internal Application Load Balancer. - "networkUrl": "A String", # The fully qualified URL of the network that the load balancer is attached to. This should be formatted like https://www.googleapis.com/compute/v1/projects/{project}/global/networks/{network} . + "networkUrl": "A String", # The fully qualified URL of the network that the load balancer is attached to. This should be formatted like `https://www.googleapis.com/compute/v1/projects/{project}/global/networks/{network}`. "port": "A String", # The configured port of the load balancer. "project": "A String", # The project ID in which the load balancer is located. "region": "A String", # The region in which the load balancer is located. @@ -1307,25 +1307,25 @@

Method Details

"rrdatas": [ "A String", ], - "signatureRrdatas": [ # DNSSEC generated signatures for all the rrdata within this item. If health checked targets are provided for DNSSEC enabled zones, there's a restriction of 1 IP address per item. + "signatureRrdatas": [ # DNSSEC generated signatures for all the `rrdata` within this item. If health checked targets are provided for DNSSEC enabled zones, there's a restriction of 1 IP address per item. "A String", ], }, ], "kind": "dns#rRSetRoutingPolicyGeoPolicy", }, - "geoPolicy": { # Configures a RRSetRoutingPolicy that routes based on the geo location of the querying user. + "geoPolicy": { # Configures a `RRSetRoutingPolicy` that routes based on the geo location of the querying user. "enableFencing": True or False, # Without fencing, if health check fails for all configured items in the current geo bucket, we failover to the next nearest geo bucket. With fencing, if health checking is enabled, as long as some targets in the current geo bucket are healthy, we return only the healthy targets. However, if all targets are unhealthy, we don't failover to the next nearest bucket; instead, we return all the items in the current bucket even when all targets are unhealthy. "items": [ # The primary geo routing configuration. If there are multiple items with the same location, an error is returned instead. { # ResourceRecordSet data for one geo location. - "healthCheckedTargets": { # HealthCheckTargets describes endpoints to health-check when responding to Routing Policy queries. Only the healthy endpoints will be included in the response. Only one of internal_load_balancer and external_endpoints should be set. # For A and AAAA types only. Endpoints to return in the query result only if they are healthy. These can be specified along with rrdata within this item. + "healthCheckedTargets": { # HealthCheckTargets describes endpoints to health-check when responding to Routing Policy queries. Only the healthy endpoints will be included in the response. # For A and AAAA types only. Endpoints to return in the query result only if they are healthy. These can be specified along with `rrdata` within this item. "internalLoadBalancers": [ # Configuration for internal load balancers to be health checked. { # The configuration for an individual load balancer to health check. "ipAddress": "A String", # The frontend IP address of the load balancer to health check. "ipProtocol": "A String", # The protocol of the load balancer to health check. "kind": "dns#rRSetRoutingPolicyLoadBalancerTarget", "loadBalancerType": "A String", # The type of load balancer specified by this target. This value must match the configuration of the load balancer located at the LoadBalancerTarget's IP address, port, and region. Use the following: - *regionalL4ilb*: for a regional internal passthrough Network Load Balancer. - *regionalL7ilb*: for a regional internal Application Load Balancer. - *globalL7ilb*: for a global internal Application Load Balancer. - "networkUrl": "A String", # The fully qualified URL of the network that the load balancer is attached to. This should be formatted like https://www.googleapis.com/compute/v1/projects/{project}/global/networks/{network} . + "networkUrl": "A String", # The fully qualified URL of the network that the load balancer is attached to. This should be formatted like `https://www.googleapis.com/compute/v1/projects/{project}/global/networks/{network}`. "port": "A String", # The configured port of the load balancer. "project": "A String", # The project ID in which the load balancer is located. "region": "A String", # The region in which the load balancer is located. @@ -1337,7 +1337,7 @@

Method Details

"rrdatas": [ "A String", ], - "signatureRrdatas": [ # DNSSEC generated signatures for all the rrdata within this item. If health checked targets are provided for DNSSEC enabled zones, there's a restriction of 1 IP address per item. + "signatureRrdatas": [ # DNSSEC generated signatures for all the `rrdata` within this item. If health checked targets are provided for DNSSEC enabled zones, there's a restriction of 1 IP address per item. "A String", ], }, @@ -1346,18 +1346,18 @@

Method Details

}, "kind": "dns#rRSetRoutingPolicy", "primaryBackup": { # Configures a RRSetRoutingPolicy such that all queries are responded with the primary_targets if they are healthy. And if all of them are unhealthy, then we fallback to a geo localized policy. - "backupGeoTargets": { # Configures a RRSetRoutingPolicy that routes based on the geo location of the querying user. # Backup targets provide a regional failover policy for the otherwise global primary targets. If serving state is set to BACKUP, this policy essentially becomes a geo routing policy. + "backupGeoTargets": { # Configures a `RRSetRoutingPolicy` that routes based on the geo location of the querying user. # Backup targets provide a regional failover policy for the otherwise global primary targets. If serving state is set to `BACKUP`, this policy essentially becomes a geo routing policy. "enableFencing": True or False, # Without fencing, if health check fails for all configured items in the current geo bucket, we failover to the next nearest geo bucket. With fencing, if health checking is enabled, as long as some targets in the current geo bucket are healthy, we return only the healthy targets. However, if all targets are unhealthy, we don't failover to the next nearest bucket; instead, we return all the items in the current bucket even when all targets are unhealthy. "items": [ # The primary geo routing configuration. If there are multiple items with the same location, an error is returned instead. { # ResourceRecordSet data for one geo location. - "healthCheckedTargets": { # HealthCheckTargets describes endpoints to health-check when responding to Routing Policy queries. Only the healthy endpoints will be included in the response. Only one of internal_load_balancer and external_endpoints should be set. # For A and AAAA types only. Endpoints to return in the query result only if they are healthy. These can be specified along with rrdata within this item. + "healthCheckedTargets": { # HealthCheckTargets describes endpoints to health-check when responding to Routing Policy queries. Only the healthy endpoints will be included in the response. # For A and AAAA types only. Endpoints to return in the query result only if they are healthy. These can be specified along with `rrdata` within this item. "internalLoadBalancers": [ # Configuration for internal load balancers to be health checked. { # The configuration for an individual load balancer to health check. "ipAddress": "A String", # The frontend IP address of the load balancer to health check. "ipProtocol": "A String", # The protocol of the load balancer to health check. "kind": "dns#rRSetRoutingPolicyLoadBalancerTarget", "loadBalancerType": "A String", # The type of load balancer specified by this target. This value must match the configuration of the load balancer located at the LoadBalancerTarget's IP address, port, and region. Use the following: - *regionalL4ilb*: for a regional internal passthrough Network Load Balancer. - *regionalL7ilb*: for a regional internal Application Load Balancer. - *globalL7ilb*: for a global internal Application Load Balancer. - "networkUrl": "A String", # The fully qualified URL of the network that the load balancer is attached to. This should be formatted like https://www.googleapis.com/compute/v1/projects/{project}/global/networks/{network} . + "networkUrl": "A String", # The fully qualified URL of the network that the load balancer is attached to. This should be formatted like `https://www.googleapis.com/compute/v1/projects/{project}/global/networks/{network}`. "port": "A String", # The configured port of the load balancer. "project": "A String", # The project ID in which the load balancer is located. "region": "A String", # The region in which the load balancer is located. @@ -1369,7 +1369,7 @@

Method Details

"rrdatas": [ "A String", ], - "signatureRrdatas": [ # DNSSEC generated signatures for all the rrdata within this item. If health checked targets are provided for DNSSEC enabled zones, there's a restriction of 1 IP address per item. + "signatureRrdatas": [ # DNSSEC generated signatures for all the `rrdata` within this item. If health checked targets are provided for DNSSEC enabled zones, there's a restriction of 1 IP address per item. "A String", ], }, @@ -1377,33 +1377,33 @@

Method Details

"kind": "dns#rRSetRoutingPolicyGeoPolicy", }, "kind": "dns#rRSetRoutingPolicyPrimaryBackupPolicy", - "primaryTargets": { # HealthCheckTargets describes endpoints to health-check when responding to Routing Policy queries. Only the healthy endpoints will be included in the response. Only one of internal_load_balancer and external_endpoints should be set. # Endpoints that are health checked before making the routing decision. Unhealthy endpoints are omitted from the results. If all endpoints are unhealthy, we serve a response based on the backup_geo_targets. + "primaryTargets": { # HealthCheckTargets describes endpoints to health-check when responding to Routing Policy queries. Only the healthy endpoints will be included in the response. # Endpoints that are health checked before making the routing decision. Unhealthy endpoints are omitted from the results. If all endpoints are unhealthy, we serve a response based on the `backup_geo_targets`. "internalLoadBalancers": [ # Configuration for internal load balancers to be health checked. { # The configuration for an individual load balancer to health check. "ipAddress": "A String", # The frontend IP address of the load balancer to health check. "ipProtocol": "A String", # The protocol of the load balancer to health check. "kind": "dns#rRSetRoutingPolicyLoadBalancerTarget", "loadBalancerType": "A String", # The type of load balancer specified by this target. This value must match the configuration of the load balancer located at the LoadBalancerTarget's IP address, port, and region. Use the following: - *regionalL4ilb*: for a regional internal passthrough Network Load Balancer. - *regionalL7ilb*: for a regional internal Application Load Balancer. - *globalL7ilb*: for a global internal Application Load Balancer. - "networkUrl": "A String", # The fully qualified URL of the network that the load balancer is attached to. This should be formatted like https://www.googleapis.com/compute/v1/projects/{project}/global/networks/{network} . + "networkUrl": "A String", # The fully qualified URL of the network that the load balancer is attached to. This should be formatted like `https://www.googleapis.com/compute/v1/projects/{project}/global/networks/{network}`. "port": "A String", # The configured port of the load balancer. "project": "A String", # The project ID in which the load balancer is located. "region": "A String", # The region in which the load balancer is located. }, ], }, - "trickleTraffic": 3.14, # When serving state is PRIMARY, this field provides the option of sending a small percentage of the traffic to the backup targets. + "trickleTraffic": 3.14, # When serving state is `PRIMARY`, this field provides the option of sending a small percentage of the traffic to the backup targets. }, "wrr": { # Configures a RRSetRoutingPolicy that routes in a weighted round robin fashion. "items": [ { # A routing block which contains the routing information for one WRR item. - "healthCheckedTargets": { # HealthCheckTargets describes endpoints to health-check when responding to Routing Policy queries. Only the healthy endpoints will be included in the response. Only one of internal_load_balancer and external_endpoints should be set. # Endpoints that are health checked before making the routing decision. The unhealthy endpoints are omitted from the result. If all endpoints within a bucket are unhealthy, we choose a different bucket (sampled with respect to its weight) for responding. If DNSSEC is enabled for this zone, only one of rrdata or health_checked_targets can be set. + "healthCheckedTargets": { # HealthCheckTargets describes endpoints to health-check when responding to Routing Policy queries. Only the healthy endpoints will be included in the response. # Endpoints that are health checked before making the routing decision. The unhealthy endpoints are omitted from the result. If all endpoints within a bucket are unhealthy, we choose a different bucket (sampled with respect to its weight) for responding. If DNSSEC is enabled for this zone, only one of `rrdata` or `health_checked_targets` can be set. "internalLoadBalancers": [ # Configuration for internal load balancers to be health checked. { # The configuration for an individual load balancer to health check. "ipAddress": "A String", # The frontend IP address of the load balancer to health check. "ipProtocol": "A String", # The protocol of the load balancer to health check. "kind": "dns#rRSetRoutingPolicyLoadBalancerTarget", "loadBalancerType": "A String", # The type of load balancer specified by this target. This value must match the configuration of the load balancer located at the LoadBalancerTarget's IP address, port, and region. Use the following: - *regionalL4ilb*: for a regional internal passthrough Network Load Balancer. - *regionalL7ilb*: for a regional internal Application Load Balancer. - *globalL7ilb*: for a global internal Application Load Balancer. - "networkUrl": "A String", # The fully qualified URL of the network that the load balancer is attached to. This should be formatted like https://www.googleapis.com/compute/v1/projects/{project}/global/networks/{network} . + "networkUrl": "A String", # The fully qualified URL of the network that the load balancer is attached to. This should be formatted like `https://www.googleapis.com/compute/v1/projects/{project}/global/networks/{network}`. "port": "A String", # The configured port of the load balancer. "project": "A String", # The project ID in which the load balancer is located. "region": "A String", # The region in which the load balancer is located. @@ -1414,10 +1414,10 @@

Method Details

"rrdatas": [ "A String", ], - "signatureRrdatas": [ # DNSSEC generated signatures for all the rrdata within this item. Note that if health checked targets are provided for DNSSEC enabled zones, there's a restriction of 1 IP address per item. + "signatureRrdatas": [ # DNSSEC generated signatures for all the `rrdata` within this item. Note that if health checked targets are provided for DNSSEC enabled zones, there's a restriction of 1 IP address per item. "A String", ], - "weight": 3.14, # The weight corresponding to this WrrPolicyItem object. When multiple WrrPolicyItem objects are configured, the probability of returning an WrrPolicyItem object's data is proportional to its weight relative to the sum of weights configured for all items. This weight must be non-negative. + "weight": 3.14, # The weight corresponding to this `WrrPolicyItem` object. When multiple `WrrPolicyItem` objects are configured, the probability of returning an `WrrPolicyItem` object's data is proportional to its weight relative to the sum of weights configured for all items. This weight must be non-negative. }, ], "kind": "dns#rRSetRoutingPolicyWrrPolicy", @@ -1425,14 +1425,14 @@

Method Details

"wrrPolicy": { # Configures a RRSetRoutingPolicy that routes in a weighted round robin fashion. "items": [ { # A routing block which contains the routing information for one WRR item. - "healthCheckedTargets": { # HealthCheckTargets describes endpoints to health-check when responding to Routing Policy queries. Only the healthy endpoints will be included in the response. Only one of internal_load_balancer and external_endpoints should be set. # Endpoints that are health checked before making the routing decision. The unhealthy endpoints are omitted from the result. If all endpoints within a bucket are unhealthy, we choose a different bucket (sampled with respect to its weight) for responding. If DNSSEC is enabled for this zone, only one of rrdata or health_checked_targets can be set. + "healthCheckedTargets": { # HealthCheckTargets describes endpoints to health-check when responding to Routing Policy queries. Only the healthy endpoints will be included in the response. # Endpoints that are health checked before making the routing decision. The unhealthy endpoints are omitted from the result. If all endpoints within a bucket are unhealthy, we choose a different bucket (sampled with respect to its weight) for responding. If DNSSEC is enabled for this zone, only one of `rrdata` or `health_checked_targets` can be set. "internalLoadBalancers": [ # Configuration for internal load balancers to be health checked. { # The configuration for an individual load balancer to health check. "ipAddress": "A String", # The frontend IP address of the load balancer to health check. "ipProtocol": "A String", # The protocol of the load balancer to health check. "kind": "dns#rRSetRoutingPolicyLoadBalancerTarget", "loadBalancerType": "A String", # The type of load balancer specified by this target. This value must match the configuration of the load balancer located at the LoadBalancerTarget's IP address, port, and region. Use the following: - *regionalL4ilb*: for a regional internal passthrough Network Load Balancer. - *regionalL7ilb*: for a regional internal Application Load Balancer. - *globalL7ilb*: for a global internal Application Load Balancer. - "networkUrl": "A String", # The fully qualified URL of the network that the load balancer is attached to. This should be formatted like https://www.googleapis.com/compute/v1/projects/{project}/global/networks/{network} . + "networkUrl": "A String", # The fully qualified URL of the network that the load balancer is attached to. This should be formatted like `https://www.googleapis.com/compute/v1/projects/{project}/global/networks/{network}`. "port": "A String", # The configured port of the load balancer. "project": "A String", # The project ID in which the load balancer is located. "region": "A String", # The region in which the load balancer is located. @@ -1443,10 +1443,10 @@

Method Details

"rrdatas": [ "A String", ], - "signatureRrdatas": [ # DNSSEC generated signatures for all the rrdata within this item. Note that if health checked targets are provided for DNSSEC enabled zones, there's a restriction of 1 IP address per item. + "signatureRrdatas": [ # DNSSEC generated signatures for all the `rrdata` within this item. Note that if health checked targets are provided for DNSSEC enabled zones, there's a restriction of 1 IP address per item. "A String", ], - "weight": 3.14, # The weight corresponding to this WrrPolicyItem object. When multiple WrrPolicyItem objects are configured, the probability of returning an WrrPolicyItem object's data is proportional to its weight relative to the sum of weights configured for all items. This weight must be non-negative. + "weight": 3.14, # The weight corresponding to this `WrrPolicyItem` object. When multiple `WrrPolicyItem` objects are configured, the probability of returning an `WrrPolicyItem` object's data is proportional to its weight relative to the sum of weights configured for all items. This weight must be non-negative. }, ], "kind": "dns#rRSetRoutingPolicyWrrPolicy", @@ -1458,7 +1458,7 @@

Method Details

"signatureRrdatas": [ # As defined in RFC 4034 (section 3.2). "A String", ], - "ttl": 42, # Number of seconds that this ResourceRecordSet can be cached by resolvers. + "ttl": 42, # Number of seconds that this `ResourceRecordSet` can be cached by resolvers. "type": "A String", # The identifier of a supported record type. See the list of Supported DNS record types. }, ], @@ -1466,19 +1466,19 @@

Method Details

{ # A unit of data that is returned by the DNS servers. "kind": "dns#resourceRecordSet", "name": "A String", # For example, www.example.com. - "routingPolicy": { # A RRSetRoutingPolicy represents ResourceRecordSet data that is returned dynamically with the response varying based on configured properties such as geolocation or by weighted random selection. # Configures dynamic query responses based on either the geo location of the querying user or a weighted round robin based routing policy. A valid ResourceRecordSet contains only rrdata (for static resolution) or a routing_policy (for dynamic resolution). - "geo": { # Configures a RRSetRoutingPolicy that routes based on the geo location of the querying user. + "routingPolicy": { # A RRSetRoutingPolicy represents ResourceRecordSet data that is returned dynamically with the response varying based on configured properties such as geolocation or by weighted random selection. # Configures dynamic query responses based on either the geo location of the querying user or a weighted round robin based routing policy. A valid `ResourceRecordSet` contains only `rrdata` (for static resolution) or a `routing_policy` (for dynamic resolution). + "geo": { # Configures a `RRSetRoutingPolicy` that routes based on the geo location of the querying user. "enableFencing": True or False, # Without fencing, if health check fails for all configured items in the current geo bucket, we failover to the next nearest geo bucket. With fencing, if health checking is enabled, as long as some targets in the current geo bucket are healthy, we return only the healthy targets. However, if all targets are unhealthy, we don't failover to the next nearest bucket; instead, we return all the items in the current bucket even when all targets are unhealthy. "items": [ # The primary geo routing configuration. If there are multiple items with the same location, an error is returned instead. { # ResourceRecordSet data for one geo location. - "healthCheckedTargets": { # HealthCheckTargets describes endpoints to health-check when responding to Routing Policy queries. Only the healthy endpoints will be included in the response. Only one of internal_load_balancer and external_endpoints should be set. # For A and AAAA types only. Endpoints to return in the query result only if they are healthy. These can be specified along with rrdata within this item. + "healthCheckedTargets": { # HealthCheckTargets describes endpoints to health-check when responding to Routing Policy queries. Only the healthy endpoints will be included in the response. # For A and AAAA types only. Endpoints to return in the query result only if they are healthy. These can be specified along with `rrdata` within this item. "internalLoadBalancers": [ # Configuration for internal load balancers to be health checked. { # The configuration for an individual load balancer to health check. "ipAddress": "A String", # The frontend IP address of the load balancer to health check. "ipProtocol": "A String", # The protocol of the load balancer to health check. "kind": "dns#rRSetRoutingPolicyLoadBalancerTarget", "loadBalancerType": "A String", # The type of load balancer specified by this target. This value must match the configuration of the load balancer located at the LoadBalancerTarget's IP address, port, and region. Use the following: - *regionalL4ilb*: for a regional internal passthrough Network Load Balancer. - *regionalL7ilb*: for a regional internal Application Load Balancer. - *globalL7ilb*: for a global internal Application Load Balancer. - "networkUrl": "A String", # The fully qualified URL of the network that the load balancer is attached to. This should be formatted like https://www.googleapis.com/compute/v1/projects/{project}/global/networks/{network} . + "networkUrl": "A String", # The fully qualified URL of the network that the load balancer is attached to. This should be formatted like `https://www.googleapis.com/compute/v1/projects/{project}/global/networks/{network}`. "port": "A String", # The configured port of the load balancer. "project": "A String", # The project ID in which the load balancer is located. "region": "A String", # The region in which the load balancer is located. @@ -1490,25 +1490,25 @@

Method Details

"rrdatas": [ "A String", ], - "signatureRrdatas": [ # DNSSEC generated signatures for all the rrdata within this item. If health checked targets are provided for DNSSEC enabled zones, there's a restriction of 1 IP address per item. + "signatureRrdatas": [ # DNSSEC generated signatures for all the `rrdata` within this item. If health checked targets are provided for DNSSEC enabled zones, there's a restriction of 1 IP address per item. "A String", ], }, ], "kind": "dns#rRSetRoutingPolicyGeoPolicy", }, - "geoPolicy": { # Configures a RRSetRoutingPolicy that routes based on the geo location of the querying user. + "geoPolicy": { # Configures a `RRSetRoutingPolicy` that routes based on the geo location of the querying user. "enableFencing": True or False, # Without fencing, if health check fails for all configured items in the current geo bucket, we failover to the next nearest geo bucket. With fencing, if health checking is enabled, as long as some targets in the current geo bucket are healthy, we return only the healthy targets. However, if all targets are unhealthy, we don't failover to the next nearest bucket; instead, we return all the items in the current bucket even when all targets are unhealthy. "items": [ # The primary geo routing configuration. If there are multiple items with the same location, an error is returned instead. { # ResourceRecordSet data for one geo location. - "healthCheckedTargets": { # HealthCheckTargets describes endpoints to health-check when responding to Routing Policy queries. Only the healthy endpoints will be included in the response. Only one of internal_load_balancer and external_endpoints should be set. # For A and AAAA types only. Endpoints to return in the query result only if they are healthy. These can be specified along with rrdata within this item. + "healthCheckedTargets": { # HealthCheckTargets describes endpoints to health-check when responding to Routing Policy queries. Only the healthy endpoints will be included in the response. # For A and AAAA types only. Endpoints to return in the query result only if they are healthy. These can be specified along with `rrdata` within this item. "internalLoadBalancers": [ # Configuration for internal load balancers to be health checked. { # The configuration for an individual load balancer to health check. "ipAddress": "A String", # The frontend IP address of the load balancer to health check. "ipProtocol": "A String", # The protocol of the load balancer to health check. "kind": "dns#rRSetRoutingPolicyLoadBalancerTarget", "loadBalancerType": "A String", # The type of load balancer specified by this target. This value must match the configuration of the load balancer located at the LoadBalancerTarget's IP address, port, and region. Use the following: - *regionalL4ilb*: for a regional internal passthrough Network Load Balancer. - *regionalL7ilb*: for a regional internal Application Load Balancer. - *globalL7ilb*: for a global internal Application Load Balancer. - "networkUrl": "A String", # The fully qualified URL of the network that the load balancer is attached to. This should be formatted like https://www.googleapis.com/compute/v1/projects/{project}/global/networks/{network} . + "networkUrl": "A String", # The fully qualified URL of the network that the load balancer is attached to. This should be formatted like `https://www.googleapis.com/compute/v1/projects/{project}/global/networks/{network}`. "port": "A String", # The configured port of the load balancer. "project": "A String", # The project ID in which the load balancer is located. "region": "A String", # The region in which the load balancer is located. @@ -1520,7 +1520,7 @@

Method Details

"rrdatas": [ "A String", ], - "signatureRrdatas": [ # DNSSEC generated signatures for all the rrdata within this item. If health checked targets are provided for DNSSEC enabled zones, there's a restriction of 1 IP address per item. + "signatureRrdatas": [ # DNSSEC generated signatures for all the `rrdata` within this item. If health checked targets are provided for DNSSEC enabled zones, there's a restriction of 1 IP address per item. "A String", ], }, @@ -1529,18 +1529,18 @@

Method Details

}, "kind": "dns#rRSetRoutingPolicy", "primaryBackup": { # Configures a RRSetRoutingPolicy such that all queries are responded with the primary_targets if they are healthy. And if all of them are unhealthy, then we fallback to a geo localized policy. - "backupGeoTargets": { # Configures a RRSetRoutingPolicy that routes based on the geo location of the querying user. # Backup targets provide a regional failover policy for the otherwise global primary targets. If serving state is set to BACKUP, this policy essentially becomes a geo routing policy. + "backupGeoTargets": { # Configures a `RRSetRoutingPolicy` that routes based on the geo location of the querying user. # Backup targets provide a regional failover policy for the otherwise global primary targets. If serving state is set to `BACKUP`, this policy essentially becomes a geo routing policy. "enableFencing": True or False, # Without fencing, if health check fails for all configured items in the current geo bucket, we failover to the next nearest geo bucket. With fencing, if health checking is enabled, as long as some targets in the current geo bucket are healthy, we return only the healthy targets. However, if all targets are unhealthy, we don't failover to the next nearest bucket; instead, we return all the items in the current bucket even when all targets are unhealthy. "items": [ # The primary geo routing configuration. If there are multiple items with the same location, an error is returned instead. { # ResourceRecordSet data for one geo location. - "healthCheckedTargets": { # HealthCheckTargets describes endpoints to health-check when responding to Routing Policy queries. Only the healthy endpoints will be included in the response. Only one of internal_load_balancer and external_endpoints should be set. # For A and AAAA types only. Endpoints to return in the query result only if they are healthy. These can be specified along with rrdata within this item. + "healthCheckedTargets": { # HealthCheckTargets describes endpoints to health-check when responding to Routing Policy queries. Only the healthy endpoints will be included in the response. # For A and AAAA types only. Endpoints to return in the query result only if they are healthy. These can be specified along with `rrdata` within this item. "internalLoadBalancers": [ # Configuration for internal load balancers to be health checked. { # The configuration for an individual load balancer to health check. "ipAddress": "A String", # The frontend IP address of the load balancer to health check. "ipProtocol": "A String", # The protocol of the load balancer to health check. "kind": "dns#rRSetRoutingPolicyLoadBalancerTarget", "loadBalancerType": "A String", # The type of load balancer specified by this target. This value must match the configuration of the load balancer located at the LoadBalancerTarget's IP address, port, and region. Use the following: - *regionalL4ilb*: for a regional internal passthrough Network Load Balancer. - *regionalL7ilb*: for a regional internal Application Load Balancer. - *globalL7ilb*: for a global internal Application Load Balancer. - "networkUrl": "A String", # The fully qualified URL of the network that the load balancer is attached to. This should be formatted like https://www.googleapis.com/compute/v1/projects/{project}/global/networks/{network} . + "networkUrl": "A String", # The fully qualified URL of the network that the load balancer is attached to. This should be formatted like `https://www.googleapis.com/compute/v1/projects/{project}/global/networks/{network}`. "port": "A String", # The configured port of the load balancer. "project": "A String", # The project ID in which the load balancer is located. "region": "A String", # The region in which the load balancer is located. @@ -1552,7 +1552,7 @@

Method Details

"rrdatas": [ "A String", ], - "signatureRrdatas": [ # DNSSEC generated signatures for all the rrdata within this item. If health checked targets are provided for DNSSEC enabled zones, there's a restriction of 1 IP address per item. + "signatureRrdatas": [ # DNSSEC generated signatures for all the `rrdata` within this item. If health checked targets are provided for DNSSEC enabled zones, there's a restriction of 1 IP address per item. "A String", ], }, @@ -1560,33 +1560,33 @@

Method Details

"kind": "dns#rRSetRoutingPolicyGeoPolicy", }, "kind": "dns#rRSetRoutingPolicyPrimaryBackupPolicy", - "primaryTargets": { # HealthCheckTargets describes endpoints to health-check when responding to Routing Policy queries. Only the healthy endpoints will be included in the response. Only one of internal_load_balancer and external_endpoints should be set. # Endpoints that are health checked before making the routing decision. Unhealthy endpoints are omitted from the results. If all endpoints are unhealthy, we serve a response based on the backup_geo_targets. + "primaryTargets": { # HealthCheckTargets describes endpoints to health-check when responding to Routing Policy queries. Only the healthy endpoints will be included in the response. # Endpoints that are health checked before making the routing decision. Unhealthy endpoints are omitted from the results. If all endpoints are unhealthy, we serve a response based on the `backup_geo_targets`. "internalLoadBalancers": [ # Configuration for internal load balancers to be health checked. { # The configuration for an individual load balancer to health check. "ipAddress": "A String", # The frontend IP address of the load balancer to health check. "ipProtocol": "A String", # The protocol of the load balancer to health check. "kind": "dns#rRSetRoutingPolicyLoadBalancerTarget", "loadBalancerType": "A String", # The type of load balancer specified by this target. This value must match the configuration of the load balancer located at the LoadBalancerTarget's IP address, port, and region. Use the following: - *regionalL4ilb*: for a regional internal passthrough Network Load Balancer. - *regionalL7ilb*: for a regional internal Application Load Balancer. - *globalL7ilb*: for a global internal Application Load Balancer. - "networkUrl": "A String", # The fully qualified URL of the network that the load balancer is attached to. This should be formatted like https://www.googleapis.com/compute/v1/projects/{project}/global/networks/{network} . + "networkUrl": "A String", # The fully qualified URL of the network that the load balancer is attached to. This should be formatted like `https://www.googleapis.com/compute/v1/projects/{project}/global/networks/{network}`. "port": "A String", # The configured port of the load balancer. "project": "A String", # The project ID in which the load balancer is located. "region": "A String", # The region in which the load balancer is located. }, ], }, - "trickleTraffic": 3.14, # When serving state is PRIMARY, this field provides the option of sending a small percentage of the traffic to the backup targets. + "trickleTraffic": 3.14, # When serving state is `PRIMARY`, this field provides the option of sending a small percentage of the traffic to the backup targets. }, "wrr": { # Configures a RRSetRoutingPolicy that routes in a weighted round robin fashion. "items": [ { # A routing block which contains the routing information for one WRR item. - "healthCheckedTargets": { # HealthCheckTargets describes endpoints to health-check when responding to Routing Policy queries. Only the healthy endpoints will be included in the response. Only one of internal_load_balancer and external_endpoints should be set. # Endpoints that are health checked before making the routing decision. The unhealthy endpoints are omitted from the result. If all endpoints within a bucket are unhealthy, we choose a different bucket (sampled with respect to its weight) for responding. If DNSSEC is enabled for this zone, only one of rrdata or health_checked_targets can be set. + "healthCheckedTargets": { # HealthCheckTargets describes endpoints to health-check when responding to Routing Policy queries. Only the healthy endpoints will be included in the response. # Endpoints that are health checked before making the routing decision. The unhealthy endpoints are omitted from the result. If all endpoints within a bucket are unhealthy, we choose a different bucket (sampled with respect to its weight) for responding. If DNSSEC is enabled for this zone, only one of `rrdata` or `health_checked_targets` can be set. "internalLoadBalancers": [ # Configuration for internal load balancers to be health checked. { # The configuration for an individual load balancer to health check. "ipAddress": "A String", # The frontend IP address of the load balancer to health check. "ipProtocol": "A String", # The protocol of the load balancer to health check. "kind": "dns#rRSetRoutingPolicyLoadBalancerTarget", "loadBalancerType": "A String", # The type of load balancer specified by this target. This value must match the configuration of the load balancer located at the LoadBalancerTarget's IP address, port, and region. Use the following: - *regionalL4ilb*: for a regional internal passthrough Network Load Balancer. - *regionalL7ilb*: for a regional internal Application Load Balancer. - *globalL7ilb*: for a global internal Application Load Balancer. - "networkUrl": "A String", # The fully qualified URL of the network that the load balancer is attached to. This should be formatted like https://www.googleapis.com/compute/v1/projects/{project}/global/networks/{network} . + "networkUrl": "A String", # The fully qualified URL of the network that the load balancer is attached to. This should be formatted like `https://www.googleapis.com/compute/v1/projects/{project}/global/networks/{network}`. "port": "A String", # The configured port of the load balancer. "project": "A String", # The project ID in which the load balancer is located. "region": "A String", # The region in which the load balancer is located. @@ -1597,10 +1597,10 @@

Method Details

"rrdatas": [ "A String", ], - "signatureRrdatas": [ # DNSSEC generated signatures for all the rrdata within this item. Note that if health checked targets are provided for DNSSEC enabled zones, there's a restriction of 1 IP address per item. + "signatureRrdatas": [ # DNSSEC generated signatures for all the `rrdata` within this item. Note that if health checked targets are provided for DNSSEC enabled zones, there's a restriction of 1 IP address per item. "A String", ], - "weight": 3.14, # The weight corresponding to this WrrPolicyItem object. When multiple WrrPolicyItem objects are configured, the probability of returning an WrrPolicyItem object's data is proportional to its weight relative to the sum of weights configured for all items. This weight must be non-negative. + "weight": 3.14, # The weight corresponding to this `WrrPolicyItem` object. When multiple `WrrPolicyItem` objects are configured, the probability of returning an `WrrPolicyItem` object's data is proportional to its weight relative to the sum of weights configured for all items. This weight must be non-negative. }, ], "kind": "dns#rRSetRoutingPolicyWrrPolicy", @@ -1608,14 +1608,14 @@

Method Details

"wrrPolicy": { # Configures a RRSetRoutingPolicy that routes in a weighted round robin fashion. "items": [ { # A routing block which contains the routing information for one WRR item. - "healthCheckedTargets": { # HealthCheckTargets describes endpoints to health-check when responding to Routing Policy queries. Only the healthy endpoints will be included in the response. Only one of internal_load_balancer and external_endpoints should be set. # Endpoints that are health checked before making the routing decision. The unhealthy endpoints are omitted from the result. If all endpoints within a bucket are unhealthy, we choose a different bucket (sampled with respect to its weight) for responding. If DNSSEC is enabled for this zone, only one of rrdata or health_checked_targets can be set. + "healthCheckedTargets": { # HealthCheckTargets describes endpoints to health-check when responding to Routing Policy queries. Only the healthy endpoints will be included in the response. # Endpoints that are health checked before making the routing decision. The unhealthy endpoints are omitted from the result. If all endpoints within a bucket are unhealthy, we choose a different bucket (sampled with respect to its weight) for responding. If DNSSEC is enabled for this zone, only one of `rrdata` or `health_checked_targets` can be set. "internalLoadBalancers": [ # Configuration for internal load balancers to be health checked. { # The configuration for an individual load balancer to health check. "ipAddress": "A String", # The frontend IP address of the load balancer to health check. "ipProtocol": "A String", # The protocol of the load balancer to health check. "kind": "dns#rRSetRoutingPolicyLoadBalancerTarget", "loadBalancerType": "A String", # The type of load balancer specified by this target. This value must match the configuration of the load balancer located at the LoadBalancerTarget's IP address, port, and region. Use the following: - *regionalL4ilb*: for a regional internal passthrough Network Load Balancer. - *regionalL7ilb*: for a regional internal Application Load Balancer. - *globalL7ilb*: for a global internal Application Load Balancer. - "networkUrl": "A String", # The fully qualified URL of the network that the load balancer is attached to. This should be formatted like https://www.googleapis.com/compute/v1/projects/{project}/global/networks/{network} . + "networkUrl": "A String", # The fully qualified URL of the network that the load balancer is attached to. This should be formatted like `https://www.googleapis.com/compute/v1/projects/{project}/global/networks/{network}`. "port": "A String", # The configured port of the load balancer. "project": "A String", # The project ID in which the load balancer is located. "region": "A String", # The region in which the load balancer is located. @@ -1626,10 +1626,10 @@

Method Details

"rrdatas": [ "A String", ], - "signatureRrdatas": [ # DNSSEC generated signatures for all the rrdata within this item. Note that if health checked targets are provided for DNSSEC enabled zones, there's a restriction of 1 IP address per item. + "signatureRrdatas": [ # DNSSEC generated signatures for all the `rrdata` within this item. Note that if health checked targets are provided for DNSSEC enabled zones, there's a restriction of 1 IP address per item. "A String", ], - "weight": 3.14, # The weight corresponding to this WrrPolicyItem object. When multiple WrrPolicyItem objects are configured, the probability of returning an WrrPolicyItem object's data is proportional to its weight relative to the sum of weights configured for all items. This weight must be non-negative. + "weight": 3.14, # The weight corresponding to this `WrrPolicyItem` object. When multiple `WrrPolicyItem` objects are configured, the probability of returning an `WrrPolicyItem` object's data is proportional to its weight relative to the sum of weights configured for all items. This weight must be non-negative. }, ], "kind": "dns#rRSetRoutingPolicyWrrPolicy", @@ -1641,7 +1641,7 @@

Method Details

"signatureRrdatas": [ # As defined in RFC 4034 (section 3.2). "A String", ], - "ttl": 42, # Number of seconds that this ResourceRecordSet can be cached by resolvers. + "ttl": 42, # Number of seconds that this `ResourceRecordSet` can be cached by resolvers. "type": "A String", # The identifier of a supported record type. See the list of Supported DNS record types. }, ], @@ -1652,11 +1652,8 @@

Method Details

"status": "A String", # Status of the operation (output only). A status of "done" means that the request to update the authoritative servers has been sent, but the servers might not be updated yet. }, ], - "header": { # Elements common to every response. - "operationId": "A String", # For mutating operation requests that completed successfully. This is the client_operation_id if the client specified it, otherwise it is generated by the server (output only). - }, "kind": "dns#changesListResponse", # Type of resource. - "nextPageToken": "A String", # The presence of this field indicates that there exist more results following your last page of results in pagination order. To fetch them, make another list request using this value as your pagination token. This lets you retrieve the complete contents of even very large collections one page at a time. However, if the contents of the collection change between the first and last paginated list request, the set of all elements returned are an inconsistent view of the collection. You cannot retrieve a "snapshot" of collections larger than the maximum page size. + "nextPageToken": "A String", # This field indicates that more results are available beyond the last page displayed. To fetch the results, make another list request and use this value as your page token. This lets you retrieve the complete contents of a very large collection one page at a time. However, if the contents of the collection change between the first and last paginated list request, the set of all elements returned are an inconsistent view of the collection. You can't retrieve a consistent snapshot of a collection larger than the maximum page size. } diff --git a/docs/dyn/dns_v1beta2.dnsKeys.html b/docs/dyn/dns_v1beta2.dnsKeys.html index db8f3b22283..2acf69b2aca 100644 --- a/docs/dyn/dns_v1beta2.dnsKeys.html +++ b/docs/dyn/dns_v1beta2.dnsKeys.html @@ -169,11 +169,8 @@

Method Details

"type": "A String", # One of "KEY_SIGNING" or "ZONE_SIGNING". Keys of type KEY_SIGNING have the Secure Entry Point flag set and, when active, are used to sign only resource record sets of type DNSKEY. Otherwise, the Secure Entry Point flag is cleared, and this key is used to sign only resource record sets of other types. Immutable after creation time. }, ], - "header": { # Elements common to every response. - "operationId": "A String", # For mutating operation requests that completed successfully. This is the client_operation_id if the client specified it, otherwise it is generated by the server (output only). - }, "kind": "dns#dnsKeysListResponse", # Type of resource. - "nextPageToken": "A String", # The presence of this field indicates that there exist more results following your last page of results in pagination order. To fetch them, make another list request using this value as your pagination token. In this way you can retrieve the complete contents of even very large collections one page at a time. However, if the contents of the collection change between the first and last paginated list request, the set of all elements returned are an inconsistent view of the collection. There is no way to retrieve a "snapshot" of collections larger than the maximum page size. + "nextPageToken": "A String", # This field indicates that more results are available beyond the last page displayed. To fetch the results, make another list request and use this value as your page token. This lets you retrieve the complete contents of a very large collection one page at a time. However, if the contents of the collection change between the first and last paginated list request, the set of all elements returned are an inconsistent view of the collection. You can't retrieve a consistent snapshot of a collection larger than the maximum page size. } diff --git a/docs/dyn/dns_v1beta2.managedZoneOperations.html b/docs/dyn/dns_v1beta2.managedZoneOperations.html index 74a6d18afaf..24104ef40a5 100644 --- a/docs/dyn/dns_v1beta2.managedZoneOperations.html +++ b/docs/dyn/dns_v1beta2.managedZoneOperations.html @@ -202,7 +202,7 @@

Method Details

"targetNetwork": { # The network with which to peer. "deactivateTime": "A String", # The time at which the zone was deactivated, in RFC 3339 date-time format. An empty string indicates that the peering connection is active. The producer network can deactivate a zone. The zone is automatically deactivated if the producer network that the zone targeted is deleted. Output only. "kind": "dns#managedZonePeeringConfigTargetNetwork", - "networkUrl": "A String", # The fully qualified URL of the VPC network to forward queries to. This should be formatted like https://www.googleapis.com/compute/v1/projects/{project}/global/networks/{network} + "networkUrl": "A String", # The fully qualified URL of the VPC network to forward queries to. This should be formatted like `https://www.googleapis.com/compute/v1/projects/{project}/global/networks/{network}` }, }, "privateVisibilityConfig": { # For privately visible zones, the set of Virtual Private Cloud resources that the zone is visible from. @@ -216,7 +216,7 @@

Method Details

"networks": [ # The list of VPC networks that can see this zone. { "kind": "dns#managedZonePrivateVisibilityConfigNetwork", - "networkUrl": "A String", # The fully qualified URL of the VPC network to bind to. Format this URL like https://www.googleapis.com/compute/v1/projects/{project}/global/networks/{network} + "networkUrl": "A String", # The fully qualified URL of the VPC network to bind to. Format this URL like `https://www.googleapis.com/compute/v1/projects/{project}/global/networks/{network}` }, ], }, @@ -228,7 +228,7 @@

Method Details

"namespace": { # Contains information about the namespace associated with the zone. "deletionTime": "A String", # The time that the namespace backing this zone was deleted; an empty string if it still exists. This is in RFC3339 text format. Output only. "kind": "dns#managedZoneServiceDirectoryConfigNamespace", - "namespaceUrl": "A String", # The fully qualified URL of the namespace associated with the zone. Format must be https://servicedirectory.googleapis.com/v1/projects/{project}/locations/{location}/namespaces/{namespace} + "namespaceUrl": "A String", # The fully qualified URL of the namespace associated with the zone. Format must be `https://servicedirectory.googleapis.com/v1/projects/{project}/locations/{location}/namespaces/{namespace}` }, }, "visibility": "A String", # The zone's visibility: public zones are exposed to the Internet, while private zones are visible only to Virtual Private Cloud resources. @@ -280,7 +280,7 @@

Method Details

"targetNetwork": { # The network with which to peer. "deactivateTime": "A String", # The time at which the zone was deactivated, in RFC 3339 date-time format. An empty string indicates that the peering connection is active. The producer network can deactivate a zone. The zone is automatically deactivated if the producer network that the zone targeted is deleted. Output only. "kind": "dns#managedZonePeeringConfigTargetNetwork", - "networkUrl": "A String", # The fully qualified URL of the VPC network to forward queries to. This should be formatted like https://www.googleapis.com/compute/v1/projects/{project}/global/networks/{network} + "networkUrl": "A String", # The fully qualified URL of the VPC network to forward queries to. This should be formatted like `https://www.googleapis.com/compute/v1/projects/{project}/global/networks/{network}` }, }, "privateVisibilityConfig": { # For privately visible zones, the set of Virtual Private Cloud resources that the zone is visible from. @@ -294,7 +294,7 @@

Method Details

"networks": [ # The list of VPC networks that can see this zone. { "kind": "dns#managedZonePrivateVisibilityConfigNetwork", - "networkUrl": "A String", # The fully qualified URL of the VPC network to bind to. Format this URL like https://www.googleapis.com/compute/v1/projects/{project}/global/networks/{network} + "networkUrl": "A String", # The fully qualified URL of the VPC network to bind to. Format this URL like `https://www.googleapis.com/compute/v1/projects/{project}/global/networks/{network}` }, ], }, @@ -306,7 +306,7 @@

Method Details

"namespace": { # Contains information about the namespace associated with the zone. "deletionTime": "A String", # The time that the namespace backing this zone was deleted; an empty string if it still exists. This is in RFC3339 text format. Output only. "kind": "dns#managedZoneServiceDirectoryConfigNamespace", - "namespaceUrl": "A String", # The fully qualified URL of the namespace associated with the zone. Format must be https://servicedirectory.googleapis.com/v1/projects/{project}/locations/{location}/namespaces/{namespace} + "namespaceUrl": "A String", # The fully qualified URL of the namespace associated with the zone. Format must be `https://servicedirectory.googleapis.com/v1/projects/{project}/locations/{location}/namespaces/{namespace}` }, }, "visibility": "A String", # The zone's visibility: public zones are exposed to the Internet, while private zones are visible only to Virtual Private Cloud resources. @@ -337,11 +337,8 @@

Method Details

An object of the form: { - "header": { # Elements common to every response. - "operationId": "A String", # For mutating operation requests that completed successfully. This is the client_operation_id if the client specified it, otherwise it is generated by the server (output only). - }, "kind": "dns#managedZoneOperationsListResponse", # Type of resource. - "nextPageToken": "A String", # The presence of this field indicates that there exist more results following your last page of results in pagination order. To fetch them, make another list request using this value as your page token. This lets you retrieve the complete contents of even very large collections one page at a time. However, if the contents of the collection change between the first and last paginated list request, the set of all elements returned are an inconsistent view of the collection. You cannot retrieve a consistent snapshot of a collection larger than the maximum page size. + "nextPageToken": "A String", # This field indicates that more results are available beyond the last page displayed. To fetch the results, make another list request and use this value as your page token. This lets you retrieve the complete contents of a very large collection one page at a time. However, if the contents of the collection change between the first and last paginated list request, the set of all elements returned are an inconsistent view of the collection. You can't retrieve a consistent snapshot of a collection larger than the maximum page size. "operations": [ # The operation resources. { # An operation represents a successful mutation performed on a Cloud DNS resource. Operations provide: - An audit log of server resource mutations. - A way to recover/retry API calls in the case where the response is never received by the caller. Use the caller specified client_operation_id. "dnsKeyContext": { # Only populated if the operation targeted a DnsKey (output only). @@ -436,7 +433,7 @@

Method Details

"targetNetwork": { # The network with which to peer. "deactivateTime": "A String", # The time at which the zone was deactivated, in RFC 3339 date-time format. An empty string indicates that the peering connection is active. The producer network can deactivate a zone. The zone is automatically deactivated if the producer network that the zone targeted is deleted. Output only. "kind": "dns#managedZonePeeringConfigTargetNetwork", - "networkUrl": "A String", # The fully qualified URL of the VPC network to forward queries to. This should be formatted like https://www.googleapis.com/compute/v1/projects/{project}/global/networks/{network} + "networkUrl": "A String", # The fully qualified URL of the VPC network to forward queries to. This should be formatted like `https://www.googleapis.com/compute/v1/projects/{project}/global/networks/{network}` }, }, "privateVisibilityConfig": { # For privately visible zones, the set of Virtual Private Cloud resources that the zone is visible from. @@ -450,7 +447,7 @@

Method Details

"networks": [ # The list of VPC networks that can see this zone. { "kind": "dns#managedZonePrivateVisibilityConfigNetwork", - "networkUrl": "A String", # The fully qualified URL of the VPC network to bind to. Format this URL like https://www.googleapis.com/compute/v1/projects/{project}/global/networks/{network} + "networkUrl": "A String", # The fully qualified URL of the VPC network to bind to. Format this URL like `https://www.googleapis.com/compute/v1/projects/{project}/global/networks/{network}` }, ], }, @@ -462,7 +459,7 @@

Method Details

"namespace": { # Contains information about the namespace associated with the zone. "deletionTime": "A String", # The time that the namespace backing this zone was deleted; an empty string if it still exists. This is in RFC3339 text format. Output only. "kind": "dns#managedZoneServiceDirectoryConfigNamespace", - "namespaceUrl": "A String", # The fully qualified URL of the namespace associated with the zone. Format must be https://servicedirectory.googleapis.com/v1/projects/{project}/locations/{location}/namespaces/{namespace} + "namespaceUrl": "A String", # The fully qualified URL of the namespace associated with the zone. Format must be `https://servicedirectory.googleapis.com/v1/projects/{project}/locations/{location}/namespaces/{namespace}` }, }, "visibility": "A String", # The zone's visibility: public zones are exposed to the Internet, while private zones are visible only to Virtual Private Cloud resources. @@ -514,7 +511,7 @@

Method Details

"targetNetwork": { # The network with which to peer. "deactivateTime": "A String", # The time at which the zone was deactivated, in RFC 3339 date-time format. An empty string indicates that the peering connection is active. The producer network can deactivate a zone. The zone is automatically deactivated if the producer network that the zone targeted is deleted. Output only. "kind": "dns#managedZonePeeringConfigTargetNetwork", - "networkUrl": "A String", # The fully qualified URL of the VPC network to forward queries to. This should be formatted like https://www.googleapis.com/compute/v1/projects/{project}/global/networks/{network} + "networkUrl": "A String", # The fully qualified URL of the VPC network to forward queries to. This should be formatted like `https://www.googleapis.com/compute/v1/projects/{project}/global/networks/{network}` }, }, "privateVisibilityConfig": { # For privately visible zones, the set of Virtual Private Cloud resources that the zone is visible from. @@ -528,7 +525,7 @@

Method Details

"networks": [ # The list of VPC networks that can see this zone. { "kind": "dns#managedZonePrivateVisibilityConfigNetwork", - "networkUrl": "A String", # The fully qualified URL of the VPC network to bind to. Format this URL like https://www.googleapis.com/compute/v1/projects/{project}/global/networks/{network} + "networkUrl": "A String", # The fully qualified URL of the VPC network to bind to. Format this URL like `https://www.googleapis.com/compute/v1/projects/{project}/global/networks/{network}` }, ], }, @@ -540,7 +537,7 @@

Method Details

"namespace": { # Contains information about the namespace associated with the zone. "deletionTime": "A String", # The time that the namespace backing this zone was deleted; an empty string if it still exists. This is in RFC3339 text format. Output only. "kind": "dns#managedZoneServiceDirectoryConfigNamespace", - "namespaceUrl": "A String", # The fully qualified URL of the namespace associated with the zone. Format must be https://servicedirectory.googleapis.com/v1/projects/{project}/locations/{location}/namespaces/{namespace} + "namespaceUrl": "A String", # The fully qualified URL of the namespace associated with the zone. Format must be `https://servicedirectory.googleapis.com/v1/projects/{project}/locations/{location}/namespaces/{namespace}` }, }, "visibility": "A String", # The zone's visibility: public zones are exposed to the Internet, while private zones are visible only to Virtual Private Cloud resources. diff --git a/docs/dyn/dns_v1beta2.managedZones.html b/docs/dyn/dns_v1beta2.managedZones.html index 48b76f91e27..96c74006f3d 100644 --- a/docs/dyn/dns_v1beta2.managedZones.html +++ b/docs/dyn/dns_v1beta2.managedZones.html @@ -169,7 +169,7 @@

Method Details

"targetNetwork": { # The network with which to peer. "deactivateTime": "A String", # The time at which the zone was deactivated, in RFC 3339 date-time format. An empty string indicates that the peering connection is active. The producer network can deactivate a zone. The zone is automatically deactivated if the producer network that the zone targeted is deleted. Output only. "kind": "dns#managedZonePeeringConfigTargetNetwork", - "networkUrl": "A String", # The fully qualified URL of the VPC network to forward queries to. This should be formatted like https://www.googleapis.com/compute/v1/projects/{project}/global/networks/{network} + "networkUrl": "A String", # The fully qualified URL of the VPC network to forward queries to. This should be formatted like `https://www.googleapis.com/compute/v1/projects/{project}/global/networks/{network}` }, }, "privateVisibilityConfig": { # For privately visible zones, the set of Virtual Private Cloud resources that the zone is visible from. @@ -183,7 +183,7 @@

Method Details

"networks": [ # The list of VPC networks that can see this zone. { "kind": "dns#managedZonePrivateVisibilityConfigNetwork", - "networkUrl": "A String", # The fully qualified URL of the VPC network to bind to. Format this URL like https://www.googleapis.com/compute/v1/projects/{project}/global/networks/{network} + "networkUrl": "A String", # The fully qualified URL of the VPC network to bind to. Format this URL like `https://www.googleapis.com/compute/v1/projects/{project}/global/networks/{network}` }, ], }, @@ -195,7 +195,7 @@

Method Details

"namespace": { # Contains information about the namespace associated with the zone. "deletionTime": "A String", # The time that the namespace backing this zone was deleted; an empty string if it still exists. This is in RFC3339 text format. Output only. "kind": "dns#managedZoneServiceDirectoryConfigNamespace", - "namespaceUrl": "A String", # The fully qualified URL of the namespace associated with the zone. Format must be https://servicedirectory.googleapis.com/v1/projects/{project}/locations/{location}/namespaces/{namespace} + "namespaceUrl": "A String", # The fully qualified URL of the namespace associated with the zone. Format must be `https://servicedirectory.googleapis.com/v1/projects/{project}/locations/{location}/namespaces/{namespace}` }, }, "visibility": "A String", # The zone's visibility: public zones are exposed to the Internet, while private zones are visible only to Virtual Private Cloud resources. @@ -257,7 +257,7 @@

Method Details

"targetNetwork": { # The network with which to peer. "deactivateTime": "A String", # The time at which the zone was deactivated, in RFC 3339 date-time format. An empty string indicates that the peering connection is active. The producer network can deactivate a zone. The zone is automatically deactivated if the producer network that the zone targeted is deleted. Output only. "kind": "dns#managedZonePeeringConfigTargetNetwork", - "networkUrl": "A String", # The fully qualified URL of the VPC network to forward queries to. This should be formatted like https://www.googleapis.com/compute/v1/projects/{project}/global/networks/{network} + "networkUrl": "A String", # The fully qualified URL of the VPC network to forward queries to. This should be formatted like `https://www.googleapis.com/compute/v1/projects/{project}/global/networks/{network}` }, }, "privateVisibilityConfig": { # For privately visible zones, the set of Virtual Private Cloud resources that the zone is visible from. @@ -271,7 +271,7 @@

Method Details

"networks": [ # The list of VPC networks that can see this zone. { "kind": "dns#managedZonePrivateVisibilityConfigNetwork", - "networkUrl": "A String", # The fully qualified URL of the VPC network to bind to. Format this URL like https://www.googleapis.com/compute/v1/projects/{project}/global/networks/{network} + "networkUrl": "A String", # The fully qualified URL of the VPC network to bind to. Format this URL like `https://www.googleapis.com/compute/v1/projects/{project}/global/networks/{network}` }, ], }, @@ -283,7 +283,7 @@

Method Details

"namespace": { # Contains information about the namespace associated with the zone. "deletionTime": "A String", # The time that the namespace backing this zone was deleted; an empty string if it still exists. This is in RFC3339 text format. Output only. "kind": "dns#managedZoneServiceDirectoryConfigNamespace", - "namespaceUrl": "A String", # The fully qualified URL of the namespace associated with the zone. Format must be https://servicedirectory.googleapis.com/v1/projects/{project}/locations/{location}/namespaces/{namespace} + "namespaceUrl": "A String", # The fully qualified URL of the namespace associated with the zone. Format must be `https://servicedirectory.googleapis.com/v1/projects/{project}/locations/{location}/namespaces/{namespace}` }, }, "visibility": "A String", # The zone's visibility: public zones are exposed to the Internet, while private zones are visible only to Virtual Private Cloud resources. @@ -368,7 +368,7 @@

Method Details

"targetNetwork": { # The network with which to peer. "deactivateTime": "A String", # The time at which the zone was deactivated, in RFC 3339 date-time format. An empty string indicates that the peering connection is active. The producer network can deactivate a zone. The zone is automatically deactivated if the producer network that the zone targeted is deleted. Output only. "kind": "dns#managedZonePeeringConfigTargetNetwork", - "networkUrl": "A String", # The fully qualified URL of the VPC network to forward queries to. This should be formatted like https://www.googleapis.com/compute/v1/projects/{project}/global/networks/{network} + "networkUrl": "A String", # The fully qualified URL of the VPC network to forward queries to. This should be formatted like `https://www.googleapis.com/compute/v1/projects/{project}/global/networks/{network}` }, }, "privateVisibilityConfig": { # For privately visible zones, the set of Virtual Private Cloud resources that the zone is visible from. @@ -382,7 +382,7 @@

Method Details

"networks": [ # The list of VPC networks that can see this zone. { "kind": "dns#managedZonePrivateVisibilityConfigNetwork", - "networkUrl": "A String", # The fully qualified URL of the VPC network to bind to. Format this URL like https://www.googleapis.com/compute/v1/projects/{project}/global/networks/{network} + "networkUrl": "A String", # The fully qualified URL of the VPC network to bind to. Format this URL like `https://www.googleapis.com/compute/v1/projects/{project}/global/networks/{network}` }, ], }, @@ -394,7 +394,7 @@

Method Details

"namespace": { # Contains information about the namespace associated with the zone. "deletionTime": "A String", # The time that the namespace backing this zone was deleted; an empty string if it still exists. This is in RFC3339 text format. Output only. "kind": "dns#managedZoneServiceDirectoryConfigNamespace", - "namespaceUrl": "A String", # The fully qualified URL of the namespace associated with the zone. Format must be https://servicedirectory.googleapis.com/v1/projects/{project}/locations/{location}/namespaces/{namespace} + "namespaceUrl": "A String", # The fully qualified URL of the namespace associated with the zone. Format must be `https://servicedirectory.googleapis.com/v1/projects/{project}/locations/{location}/namespaces/{namespace}` }, }, "visibility": "A String", # The zone's visibility: public zones are exposed to the Internet, while private zones are visible only to Virtual Private Cloud resources. @@ -475,9 +475,6 @@

Method Details

An object of the form: { - "header": { # Elements common to every response. - "operationId": "A String", # For mutating operation requests that completed successfully. This is the client_operation_id if the client specified it, otherwise it is generated by the server (output only). - }, "kind": "dns#managedZonesListResponse", # Type of resource. "managedZones": [ # The managed zone resources. { # A zone is a subtree of the DNS namespace under one administrative responsibility. A ManagedZone is a resource that represents a DNS zone hosted by the Cloud DNS service. @@ -527,7 +524,7 @@

Method Details

"targetNetwork": { # The network with which to peer. "deactivateTime": "A String", # The time at which the zone was deactivated, in RFC 3339 date-time format. An empty string indicates that the peering connection is active. The producer network can deactivate a zone. The zone is automatically deactivated if the producer network that the zone targeted is deleted. Output only. "kind": "dns#managedZonePeeringConfigTargetNetwork", - "networkUrl": "A String", # The fully qualified URL of the VPC network to forward queries to. This should be formatted like https://www.googleapis.com/compute/v1/projects/{project}/global/networks/{network} + "networkUrl": "A String", # The fully qualified URL of the VPC network to forward queries to. This should be formatted like `https://www.googleapis.com/compute/v1/projects/{project}/global/networks/{network}` }, }, "privateVisibilityConfig": { # For privately visible zones, the set of Virtual Private Cloud resources that the zone is visible from. @@ -541,7 +538,7 @@

Method Details

"networks": [ # The list of VPC networks that can see this zone. { "kind": "dns#managedZonePrivateVisibilityConfigNetwork", - "networkUrl": "A String", # The fully qualified URL of the VPC network to bind to. Format this URL like https://www.googleapis.com/compute/v1/projects/{project}/global/networks/{network} + "networkUrl": "A String", # The fully qualified URL of the VPC network to bind to. Format this URL like `https://www.googleapis.com/compute/v1/projects/{project}/global/networks/{network}` }, ], }, @@ -553,13 +550,13 @@

Method Details

"namespace": { # Contains information about the namespace associated with the zone. "deletionTime": "A String", # The time that the namespace backing this zone was deleted; an empty string if it still exists. This is in RFC3339 text format. Output only. "kind": "dns#managedZoneServiceDirectoryConfigNamespace", - "namespaceUrl": "A String", # The fully qualified URL of the namespace associated with the zone. Format must be https://servicedirectory.googleapis.com/v1/projects/{project}/locations/{location}/namespaces/{namespace} + "namespaceUrl": "A String", # The fully qualified URL of the namespace associated with the zone. Format must be `https://servicedirectory.googleapis.com/v1/projects/{project}/locations/{location}/namespaces/{namespace}` }, }, "visibility": "A String", # The zone's visibility: public zones are exposed to the Internet, while private zones are visible only to Virtual Private Cloud resources. }, ], - "nextPageToken": "A String", # The presence of this field indicates that there exist more results following your last page of results in pagination order. To fetch them, make another list request using this value as your page token. This lets you the complete contents of even very large collections one page at a time. However, if the contents of the collection change between the first and last paginated list request, the set of all elements returned are an inconsistent view of the collection. You cannot retrieve a consistent snapshot of a collection larger than the maximum page size. + "nextPageToken": "A String", # This field indicates that more results are available beyond the last page displayed. To fetch the results, make another list request and use this value as your page token. This lets you retrieve the complete contents of a very large collection one page at a time. However, if the contents of the collection change between the first and last paginated list request, the set of all elements returned are an inconsistent view of the collection. You can't retrieve a consistent snapshot of a collection larger than the maximum page size. } @@ -634,7 +631,7 @@

Method Details

"targetNetwork": { # The network with which to peer. "deactivateTime": "A String", # The time at which the zone was deactivated, in RFC 3339 date-time format. An empty string indicates that the peering connection is active. The producer network can deactivate a zone. The zone is automatically deactivated if the producer network that the zone targeted is deleted. Output only. "kind": "dns#managedZonePeeringConfigTargetNetwork", - "networkUrl": "A String", # The fully qualified URL of the VPC network to forward queries to. This should be formatted like https://www.googleapis.com/compute/v1/projects/{project}/global/networks/{network} + "networkUrl": "A String", # The fully qualified URL of the VPC network to forward queries to. This should be formatted like `https://www.googleapis.com/compute/v1/projects/{project}/global/networks/{network}` }, }, "privateVisibilityConfig": { # For privately visible zones, the set of Virtual Private Cloud resources that the zone is visible from. @@ -648,7 +645,7 @@

Method Details

"networks": [ # The list of VPC networks that can see this zone. { "kind": "dns#managedZonePrivateVisibilityConfigNetwork", - "networkUrl": "A String", # The fully qualified URL of the VPC network to bind to. Format this URL like https://www.googleapis.com/compute/v1/projects/{project}/global/networks/{network} + "networkUrl": "A String", # The fully qualified URL of the VPC network to bind to. Format this URL like `https://www.googleapis.com/compute/v1/projects/{project}/global/networks/{network}` }, ], }, @@ -660,7 +657,7 @@

Method Details

"namespace": { # Contains information about the namespace associated with the zone. "deletionTime": "A String", # The time that the namespace backing this zone was deleted; an empty string if it still exists. This is in RFC3339 text format. Output only. "kind": "dns#managedZoneServiceDirectoryConfigNamespace", - "namespaceUrl": "A String", # The fully qualified URL of the namespace associated with the zone. Format must be https://servicedirectory.googleapis.com/v1/projects/{project}/locations/{location}/namespaces/{namespace} + "namespaceUrl": "A String", # The fully qualified URL of the namespace associated with the zone. Format must be `https://servicedirectory.googleapis.com/v1/projects/{project}/locations/{location}/namespaces/{namespace}` }, }, "visibility": "A String", # The zone's visibility: public zones are exposed to the Internet, while private zones are visible only to Virtual Private Cloud resources. @@ -768,7 +765,7 @@

Method Details

"targetNetwork": { # The network with which to peer. "deactivateTime": "A String", # The time at which the zone was deactivated, in RFC 3339 date-time format. An empty string indicates that the peering connection is active. The producer network can deactivate a zone. The zone is automatically deactivated if the producer network that the zone targeted is deleted. Output only. "kind": "dns#managedZonePeeringConfigTargetNetwork", - "networkUrl": "A String", # The fully qualified URL of the VPC network to forward queries to. This should be formatted like https://www.googleapis.com/compute/v1/projects/{project}/global/networks/{network} + "networkUrl": "A String", # The fully qualified URL of the VPC network to forward queries to. This should be formatted like `https://www.googleapis.com/compute/v1/projects/{project}/global/networks/{network}` }, }, "privateVisibilityConfig": { # For privately visible zones, the set of Virtual Private Cloud resources that the zone is visible from. @@ -782,7 +779,7 @@

Method Details

"networks": [ # The list of VPC networks that can see this zone. { "kind": "dns#managedZonePrivateVisibilityConfigNetwork", - "networkUrl": "A String", # The fully qualified URL of the VPC network to bind to. Format this URL like https://www.googleapis.com/compute/v1/projects/{project}/global/networks/{network} + "networkUrl": "A String", # The fully qualified URL of the VPC network to bind to. Format this URL like `https://www.googleapis.com/compute/v1/projects/{project}/global/networks/{network}` }, ], }, @@ -794,7 +791,7 @@

Method Details

"namespace": { # Contains information about the namespace associated with the zone. "deletionTime": "A String", # The time that the namespace backing this zone was deleted; an empty string if it still exists. This is in RFC3339 text format. Output only. "kind": "dns#managedZoneServiceDirectoryConfigNamespace", - "namespaceUrl": "A String", # The fully qualified URL of the namespace associated with the zone. Format must be https://servicedirectory.googleapis.com/v1/projects/{project}/locations/{location}/namespaces/{namespace} + "namespaceUrl": "A String", # The fully qualified URL of the namespace associated with the zone. Format must be `https://servicedirectory.googleapis.com/v1/projects/{project}/locations/{location}/namespaces/{namespace}` }, }, "visibility": "A String", # The zone's visibility: public zones are exposed to the Internet, while private zones are visible only to Virtual Private Cloud resources. @@ -846,7 +843,7 @@

Method Details

"targetNetwork": { # The network with which to peer. "deactivateTime": "A String", # The time at which the zone was deactivated, in RFC 3339 date-time format. An empty string indicates that the peering connection is active. The producer network can deactivate a zone. The zone is automatically deactivated if the producer network that the zone targeted is deleted. Output only. "kind": "dns#managedZonePeeringConfigTargetNetwork", - "networkUrl": "A String", # The fully qualified URL of the VPC network to forward queries to. This should be formatted like https://www.googleapis.com/compute/v1/projects/{project}/global/networks/{network} + "networkUrl": "A String", # The fully qualified URL of the VPC network to forward queries to. This should be formatted like `https://www.googleapis.com/compute/v1/projects/{project}/global/networks/{network}` }, }, "privateVisibilityConfig": { # For privately visible zones, the set of Virtual Private Cloud resources that the zone is visible from. @@ -860,7 +857,7 @@

Method Details

"networks": [ # The list of VPC networks that can see this zone. { "kind": "dns#managedZonePrivateVisibilityConfigNetwork", - "networkUrl": "A String", # The fully qualified URL of the VPC network to bind to. Format this URL like https://www.googleapis.com/compute/v1/projects/{project}/global/networks/{network} + "networkUrl": "A String", # The fully qualified URL of the VPC network to bind to. Format this URL like `https://www.googleapis.com/compute/v1/projects/{project}/global/networks/{network}` }, ], }, @@ -872,7 +869,7 @@

Method Details

"namespace": { # Contains information about the namespace associated with the zone. "deletionTime": "A String", # The time that the namespace backing this zone was deleted; an empty string if it still exists. This is in RFC3339 text format. Output only. "kind": "dns#managedZoneServiceDirectoryConfigNamespace", - "namespaceUrl": "A String", # The fully qualified URL of the namespace associated with the zone. Format must be https://servicedirectory.googleapis.com/v1/projects/{project}/locations/{location}/namespaces/{namespace} + "namespaceUrl": "A String", # The fully qualified URL of the namespace associated with the zone. Format must be `https://servicedirectory.googleapis.com/v1/projects/{project}/locations/{location}/namespaces/{namespace}` }, }, "visibility": "A String", # The zone's visibility: public zones are exposed to the Internet, while private zones are visible only to Virtual Private Cloud resources. @@ -1053,7 +1050,7 @@

Method Details

"targetNetwork": { # The network with which to peer. "deactivateTime": "A String", # The time at which the zone was deactivated, in RFC 3339 date-time format. An empty string indicates that the peering connection is active. The producer network can deactivate a zone. The zone is automatically deactivated if the producer network that the zone targeted is deleted. Output only. "kind": "dns#managedZonePeeringConfigTargetNetwork", - "networkUrl": "A String", # The fully qualified URL of the VPC network to forward queries to. This should be formatted like https://www.googleapis.com/compute/v1/projects/{project}/global/networks/{network} + "networkUrl": "A String", # The fully qualified URL of the VPC network to forward queries to. This should be formatted like `https://www.googleapis.com/compute/v1/projects/{project}/global/networks/{network}` }, }, "privateVisibilityConfig": { # For privately visible zones, the set of Virtual Private Cloud resources that the zone is visible from. @@ -1067,7 +1064,7 @@

Method Details

"networks": [ # The list of VPC networks that can see this zone. { "kind": "dns#managedZonePrivateVisibilityConfigNetwork", - "networkUrl": "A String", # The fully qualified URL of the VPC network to bind to. Format this URL like https://www.googleapis.com/compute/v1/projects/{project}/global/networks/{network} + "networkUrl": "A String", # The fully qualified URL of the VPC network to bind to. Format this URL like `https://www.googleapis.com/compute/v1/projects/{project}/global/networks/{network}` }, ], }, @@ -1079,7 +1076,7 @@

Method Details

"namespace": { # Contains information about the namespace associated with the zone. "deletionTime": "A String", # The time that the namespace backing this zone was deleted; an empty string if it still exists. This is in RFC3339 text format. Output only. "kind": "dns#managedZoneServiceDirectoryConfigNamespace", - "namespaceUrl": "A String", # The fully qualified URL of the namespace associated with the zone. Format must be https://servicedirectory.googleapis.com/v1/projects/{project}/locations/{location}/namespaces/{namespace} + "namespaceUrl": "A String", # The fully qualified URL of the namespace associated with the zone. Format must be `https://servicedirectory.googleapis.com/v1/projects/{project}/locations/{location}/namespaces/{namespace}` }, }, "visibility": "A String", # The zone's visibility: public zones are exposed to the Internet, while private zones are visible only to Virtual Private Cloud resources. @@ -1187,7 +1184,7 @@

Method Details

"targetNetwork": { # The network with which to peer. "deactivateTime": "A String", # The time at which the zone was deactivated, in RFC 3339 date-time format. An empty string indicates that the peering connection is active. The producer network can deactivate a zone. The zone is automatically deactivated if the producer network that the zone targeted is deleted. Output only. "kind": "dns#managedZonePeeringConfigTargetNetwork", - "networkUrl": "A String", # The fully qualified URL of the VPC network to forward queries to. This should be formatted like https://www.googleapis.com/compute/v1/projects/{project}/global/networks/{network} + "networkUrl": "A String", # The fully qualified URL of the VPC network to forward queries to. This should be formatted like `https://www.googleapis.com/compute/v1/projects/{project}/global/networks/{network}` }, }, "privateVisibilityConfig": { # For privately visible zones, the set of Virtual Private Cloud resources that the zone is visible from. @@ -1201,7 +1198,7 @@

Method Details

"networks": [ # The list of VPC networks that can see this zone. { "kind": "dns#managedZonePrivateVisibilityConfigNetwork", - "networkUrl": "A String", # The fully qualified URL of the VPC network to bind to. Format this URL like https://www.googleapis.com/compute/v1/projects/{project}/global/networks/{network} + "networkUrl": "A String", # The fully qualified URL of the VPC network to bind to. Format this URL like `https://www.googleapis.com/compute/v1/projects/{project}/global/networks/{network}` }, ], }, @@ -1213,7 +1210,7 @@

Method Details

"namespace": { # Contains information about the namespace associated with the zone. "deletionTime": "A String", # The time that the namespace backing this zone was deleted; an empty string if it still exists. This is in RFC3339 text format. Output only. "kind": "dns#managedZoneServiceDirectoryConfigNamespace", - "namespaceUrl": "A String", # The fully qualified URL of the namespace associated with the zone. Format must be https://servicedirectory.googleapis.com/v1/projects/{project}/locations/{location}/namespaces/{namespace} + "namespaceUrl": "A String", # The fully qualified URL of the namespace associated with the zone. Format must be `https://servicedirectory.googleapis.com/v1/projects/{project}/locations/{location}/namespaces/{namespace}` }, }, "visibility": "A String", # The zone's visibility: public zones are exposed to the Internet, while private zones are visible only to Virtual Private Cloud resources. @@ -1265,7 +1262,7 @@

Method Details

"targetNetwork": { # The network with which to peer. "deactivateTime": "A String", # The time at which the zone was deactivated, in RFC 3339 date-time format. An empty string indicates that the peering connection is active. The producer network can deactivate a zone. The zone is automatically deactivated if the producer network that the zone targeted is deleted. Output only. "kind": "dns#managedZonePeeringConfigTargetNetwork", - "networkUrl": "A String", # The fully qualified URL of the VPC network to forward queries to. This should be formatted like https://www.googleapis.com/compute/v1/projects/{project}/global/networks/{network} + "networkUrl": "A String", # The fully qualified URL of the VPC network to forward queries to. This should be formatted like `https://www.googleapis.com/compute/v1/projects/{project}/global/networks/{network}` }, }, "privateVisibilityConfig": { # For privately visible zones, the set of Virtual Private Cloud resources that the zone is visible from. @@ -1279,7 +1276,7 @@

Method Details

"networks": [ # The list of VPC networks that can see this zone. { "kind": "dns#managedZonePrivateVisibilityConfigNetwork", - "networkUrl": "A String", # The fully qualified URL of the VPC network to bind to. Format this URL like https://www.googleapis.com/compute/v1/projects/{project}/global/networks/{network} + "networkUrl": "A String", # The fully qualified URL of the VPC network to bind to. Format this URL like `https://www.googleapis.com/compute/v1/projects/{project}/global/networks/{network}` }, ], }, @@ -1291,7 +1288,7 @@

Method Details

"namespace": { # Contains information about the namespace associated with the zone. "deletionTime": "A String", # The time that the namespace backing this zone was deleted; an empty string if it still exists. This is in RFC3339 text format. Output only. "kind": "dns#managedZoneServiceDirectoryConfigNamespace", - "namespaceUrl": "A String", # The fully qualified URL of the namespace associated with the zone. Format must be https://servicedirectory.googleapis.com/v1/projects/{project}/locations/{location}/namespaces/{namespace} + "namespaceUrl": "A String", # The fully qualified URL of the namespace associated with the zone. Format must be `https://servicedirectory.googleapis.com/v1/projects/{project}/locations/{location}/namespaces/{namespace}` }, }, "visibility": "A String", # The zone's visibility: public zones are exposed to the Internet, while private zones are visible only to Virtual Private Cloud resources. diff --git a/docs/dyn/dns_v1beta2.policies.html b/docs/dyn/dns_v1beta2.policies.html index 1292ce7a519..c4d0299f4b7 100644 --- a/docs/dyn/dns_v1beta2.policies.html +++ b/docs/dyn/dns_v1beta2.policies.html @@ -250,11 +250,8 @@

Method Details

An object of the form: { - "header": { # Elements common to every response. - "operationId": "A String", # For mutating operation requests that completed successfully. This is the client_operation_id if the client specified it, otherwise it is generated by the server (output only). - }, "kind": "dns#policiesListResponse", # Type of resource. - "nextPageToken": "A String", # The presence of this field indicates that there exist more results following your last page of results in pagination order. To fetch them, make another list request using this value as your page token. This lets you the complete contents of even very large collections one page at a time. However, if the contents of the collection change between the first and last paginated list request, the set of all elements returned are an inconsistent view of the collection. You cannot retrieve a consistent snapshot of a collection larger than the maximum page size. + "nextPageToken": "A String", # This field indicates that more results are available beyond the last page displayed. To fetch the results, make another list request and use this value as your page token. This lets you retrieve the complete contents of a very large collection one page at a time. However, if the contents of the collection change between the first and last paginated list request, the set of all elements returned are an inconsistent view of the collection. You can't retrieve a consistent snapshot of a collection larger than the maximum page size. "policies": [ # The policy resources. { # A policy is a collection of DNS rules applied to one or more Virtual Private Cloud resources. "alternativeNameServerConfig": { # Sets an alternative name server for the associated networks. When specified, all DNS queries are forwarded to a name server that you choose. Names such as .internal are not available when an alternative name server is specified. @@ -345,9 +342,6 @@

Method Details

An object of the form: { - "header": { # Elements common to every response. - "operationId": "A String", # For mutating operation requests that completed successfully. This is the client_operation_id if the client specified it, otherwise it is generated by the server (output only). - }, "policy": { # A policy is a collection of DNS rules applied to one or more Virtual Private Cloud resources. "alternativeNameServerConfig": { # Sets an alternative name server for the associated networks. When specified, all DNS queries are forwarded to a name server that you choose. Names such as .internal are not available when an alternative name server is specified. "kind": "dns#policyAlternativeNameServerConfig", @@ -422,9 +416,6 @@

Method Details

An object of the form: { - "header": { # Elements common to every response. - "operationId": "A String", # For mutating operation requests that completed successfully. This is the client_operation_id if the client specified it, otherwise it is generated by the server (output only). - }, "policy": { # A policy is a collection of DNS rules applied to one or more Virtual Private Cloud resources. "alternativeNameServerConfig": { # Sets an alternative name server for the associated networks. When specified, all DNS queries are forwarded to a name server that you choose. Names such as .internal are not available when an alternative name server is specified. "kind": "dns#policyAlternativeNameServerConfig", diff --git a/docs/dyn/dns_v1beta2.projects.html b/docs/dyn/dns_v1beta2.projects.html index 58005f4ba0e..53635ea57e9 100644 --- a/docs/dyn/dns_v1beta2.projects.html +++ b/docs/dyn/dns_v1beta2.projects.html @@ -101,7 +101,7 @@

Method Details

Returns: An object of the form: - { # A project resource. The project is a top level container for resources including Cloud DNS ManagedZones. Projects can be created only in the APIs console. Next tag: 7. + { # A project resource. The project is a top level container for resources including Cloud DNS ManagedZones. Projects can be created only in the APIs console. "id": "A String", # User assigned unique identifier for the resource (output only). "kind": "dns#project", "number": "A String", # Unique numeric identifier for the resource; defined by the server (output only). diff --git a/docs/dyn/dns_v1beta2.resourceRecordSets.html b/docs/dyn/dns_v1beta2.resourceRecordSets.html index aef7300f525..e975dd386a1 100644 --- a/docs/dyn/dns_v1beta2.resourceRecordSets.html +++ b/docs/dyn/dns_v1beta2.resourceRecordSets.html @@ -114,19 +114,19 @@

Method Details

{ # A unit of data that is returned by the DNS servers. "kind": "dns#resourceRecordSet", "name": "A String", # For example, www.example.com. - "routingPolicy": { # A RRSetRoutingPolicy represents ResourceRecordSet data that is returned dynamically with the response varying based on configured properties such as geolocation or by weighted random selection. # Configures dynamic query responses based on either the geo location of the querying user or a weighted round robin based routing policy. A valid ResourceRecordSet contains only rrdata (for static resolution) or a routing_policy (for dynamic resolution). - "geo": { # Configures a RRSetRoutingPolicy that routes based on the geo location of the querying user. + "routingPolicy": { # A RRSetRoutingPolicy represents ResourceRecordSet data that is returned dynamically with the response varying based on configured properties such as geolocation or by weighted random selection. # Configures dynamic query responses based on either the geo location of the querying user or a weighted round robin based routing policy. A valid `ResourceRecordSet` contains only `rrdata` (for static resolution) or a `routing_policy` (for dynamic resolution). + "geo": { # Configures a `RRSetRoutingPolicy` that routes based on the geo location of the querying user. "enableFencing": True or False, # Without fencing, if health check fails for all configured items in the current geo bucket, we failover to the next nearest geo bucket. With fencing, if health checking is enabled, as long as some targets in the current geo bucket are healthy, we return only the healthy targets. However, if all targets are unhealthy, we don't failover to the next nearest bucket; instead, we return all the items in the current bucket even when all targets are unhealthy. "items": [ # The primary geo routing configuration. If there are multiple items with the same location, an error is returned instead. { # ResourceRecordSet data for one geo location. - "healthCheckedTargets": { # HealthCheckTargets describes endpoints to health-check when responding to Routing Policy queries. Only the healthy endpoints will be included in the response. Only one of internal_load_balancer and external_endpoints should be set. # For A and AAAA types only. Endpoints to return in the query result only if they are healthy. These can be specified along with rrdata within this item. + "healthCheckedTargets": { # HealthCheckTargets describes endpoints to health-check when responding to Routing Policy queries. Only the healthy endpoints will be included in the response. # For A and AAAA types only. Endpoints to return in the query result only if they are healthy. These can be specified along with `rrdata` within this item. "internalLoadBalancers": [ # Configuration for internal load balancers to be health checked. { # The configuration for an individual load balancer to health check. "ipAddress": "A String", # The frontend IP address of the load balancer to health check. "ipProtocol": "A String", # The protocol of the load balancer to health check. "kind": "dns#rRSetRoutingPolicyLoadBalancerTarget", "loadBalancerType": "A String", # The type of load balancer specified by this target. This value must match the configuration of the load balancer located at the LoadBalancerTarget's IP address, port, and region. Use the following: - *regionalL4ilb*: for a regional internal passthrough Network Load Balancer. - *regionalL7ilb*: for a regional internal Application Load Balancer. - *globalL7ilb*: for a global internal Application Load Balancer. - "networkUrl": "A String", # The fully qualified URL of the network that the load balancer is attached to. This should be formatted like https://www.googleapis.com/compute/v1/projects/{project}/global/networks/{network} . + "networkUrl": "A String", # The fully qualified URL of the network that the load balancer is attached to. This should be formatted like `https://www.googleapis.com/compute/v1/projects/{project}/global/networks/{network}`. "port": "A String", # The configured port of the load balancer. "project": "A String", # The project ID in which the load balancer is located. "region": "A String", # The region in which the load balancer is located. @@ -138,25 +138,25 @@

Method Details

"rrdatas": [ "A String", ], - "signatureRrdatas": [ # DNSSEC generated signatures for all the rrdata within this item. If health checked targets are provided for DNSSEC enabled zones, there's a restriction of 1 IP address per item. + "signatureRrdatas": [ # DNSSEC generated signatures for all the `rrdata` within this item. If health checked targets are provided for DNSSEC enabled zones, there's a restriction of 1 IP address per item. "A String", ], }, ], "kind": "dns#rRSetRoutingPolicyGeoPolicy", }, - "geoPolicy": { # Configures a RRSetRoutingPolicy that routes based on the geo location of the querying user. + "geoPolicy": { # Configures a `RRSetRoutingPolicy` that routes based on the geo location of the querying user. "enableFencing": True or False, # Without fencing, if health check fails for all configured items in the current geo bucket, we failover to the next nearest geo bucket. With fencing, if health checking is enabled, as long as some targets in the current geo bucket are healthy, we return only the healthy targets. However, if all targets are unhealthy, we don't failover to the next nearest bucket; instead, we return all the items in the current bucket even when all targets are unhealthy. "items": [ # The primary geo routing configuration. If there are multiple items with the same location, an error is returned instead. { # ResourceRecordSet data for one geo location. - "healthCheckedTargets": { # HealthCheckTargets describes endpoints to health-check when responding to Routing Policy queries. Only the healthy endpoints will be included in the response. Only one of internal_load_balancer and external_endpoints should be set. # For A and AAAA types only. Endpoints to return in the query result only if they are healthy. These can be specified along with rrdata within this item. + "healthCheckedTargets": { # HealthCheckTargets describes endpoints to health-check when responding to Routing Policy queries. Only the healthy endpoints will be included in the response. # For A and AAAA types only. Endpoints to return in the query result only if they are healthy. These can be specified along with `rrdata` within this item. "internalLoadBalancers": [ # Configuration for internal load balancers to be health checked. { # The configuration for an individual load balancer to health check. "ipAddress": "A String", # The frontend IP address of the load balancer to health check. "ipProtocol": "A String", # The protocol of the load balancer to health check. "kind": "dns#rRSetRoutingPolicyLoadBalancerTarget", "loadBalancerType": "A String", # The type of load balancer specified by this target. This value must match the configuration of the load balancer located at the LoadBalancerTarget's IP address, port, and region. Use the following: - *regionalL4ilb*: for a regional internal passthrough Network Load Balancer. - *regionalL7ilb*: for a regional internal Application Load Balancer. - *globalL7ilb*: for a global internal Application Load Balancer. - "networkUrl": "A String", # The fully qualified URL of the network that the load balancer is attached to. This should be formatted like https://www.googleapis.com/compute/v1/projects/{project}/global/networks/{network} . + "networkUrl": "A String", # The fully qualified URL of the network that the load balancer is attached to. This should be formatted like `https://www.googleapis.com/compute/v1/projects/{project}/global/networks/{network}`. "port": "A String", # The configured port of the load balancer. "project": "A String", # The project ID in which the load balancer is located. "region": "A String", # The region in which the load balancer is located. @@ -168,7 +168,7 @@

Method Details

"rrdatas": [ "A String", ], - "signatureRrdatas": [ # DNSSEC generated signatures for all the rrdata within this item. If health checked targets are provided for DNSSEC enabled zones, there's a restriction of 1 IP address per item. + "signatureRrdatas": [ # DNSSEC generated signatures for all the `rrdata` within this item. If health checked targets are provided for DNSSEC enabled zones, there's a restriction of 1 IP address per item. "A String", ], }, @@ -177,18 +177,18 @@

Method Details

}, "kind": "dns#rRSetRoutingPolicy", "primaryBackup": { # Configures a RRSetRoutingPolicy such that all queries are responded with the primary_targets if they are healthy. And if all of them are unhealthy, then we fallback to a geo localized policy. - "backupGeoTargets": { # Configures a RRSetRoutingPolicy that routes based on the geo location of the querying user. # Backup targets provide a regional failover policy for the otherwise global primary targets. If serving state is set to BACKUP, this policy essentially becomes a geo routing policy. + "backupGeoTargets": { # Configures a `RRSetRoutingPolicy` that routes based on the geo location of the querying user. # Backup targets provide a regional failover policy for the otherwise global primary targets. If serving state is set to `BACKUP`, this policy essentially becomes a geo routing policy. "enableFencing": True or False, # Without fencing, if health check fails for all configured items in the current geo bucket, we failover to the next nearest geo bucket. With fencing, if health checking is enabled, as long as some targets in the current geo bucket are healthy, we return only the healthy targets. However, if all targets are unhealthy, we don't failover to the next nearest bucket; instead, we return all the items in the current bucket even when all targets are unhealthy. "items": [ # The primary geo routing configuration. If there are multiple items with the same location, an error is returned instead. { # ResourceRecordSet data for one geo location. - "healthCheckedTargets": { # HealthCheckTargets describes endpoints to health-check when responding to Routing Policy queries. Only the healthy endpoints will be included in the response. Only one of internal_load_balancer and external_endpoints should be set. # For A and AAAA types only. Endpoints to return in the query result only if they are healthy. These can be specified along with rrdata within this item. + "healthCheckedTargets": { # HealthCheckTargets describes endpoints to health-check when responding to Routing Policy queries. Only the healthy endpoints will be included in the response. # For A and AAAA types only. Endpoints to return in the query result only if they are healthy. These can be specified along with `rrdata` within this item. "internalLoadBalancers": [ # Configuration for internal load balancers to be health checked. { # The configuration for an individual load balancer to health check. "ipAddress": "A String", # The frontend IP address of the load balancer to health check. "ipProtocol": "A String", # The protocol of the load balancer to health check. "kind": "dns#rRSetRoutingPolicyLoadBalancerTarget", "loadBalancerType": "A String", # The type of load balancer specified by this target. This value must match the configuration of the load balancer located at the LoadBalancerTarget's IP address, port, and region. Use the following: - *regionalL4ilb*: for a regional internal passthrough Network Load Balancer. - *regionalL7ilb*: for a regional internal Application Load Balancer. - *globalL7ilb*: for a global internal Application Load Balancer. - "networkUrl": "A String", # The fully qualified URL of the network that the load balancer is attached to. This should be formatted like https://www.googleapis.com/compute/v1/projects/{project}/global/networks/{network} . + "networkUrl": "A String", # The fully qualified URL of the network that the load balancer is attached to. This should be formatted like `https://www.googleapis.com/compute/v1/projects/{project}/global/networks/{network}`. "port": "A String", # The configured port of the load balancer. "project": "A String", # The project ID in which the load balancer is located. "region": "A String", # The region in which the load balancer is located. @@ -200,7 +200,7 @@

Method Details

"rrdatas": [ "A String", ], - "signatureRrdatas": [ # DNSSEC generated signatures for all the rrdata within this item. If health checked targets are provided for DNSSEC enabled zones, there's a restriction of 1 IP address per item. + "signatureRrdatas": [ # DNSSEC generated signatures for all the `rrdata` within this item. If health checked targets are provided for DNSSEC enabled zones, there's a restriction of 1 IP address per item. "A String", ], }, @@ -208,33 +208,33 @@

Method Details

"kind": "dns#rRSetRoutingPolicyGeoPolicy", }, "kind": "dns#rRSetRoutingPolicyPrimaryBackupPolicy", - "primaryTargets": { # HealthCheckTargets describes endpoints to health-check when responding to Routing Policy queries. Only the healthy endpoints will be included in the response. Only one of internal_load_balancer and external_endpoints should be set. # Endpoints that are health checked before making the routing decision. Unhealthy endpoints are omitted from the results. If all endpoints are unhealthy, we serve a response based on the backup_geo_targets. + "primaryTargets": { # HealthCheckTargets describes endpoints to health-check when responding to Routing Policy queries. Only the healthy endpoints will be included in the response. # Endpoints that are health checked before making the routing decision. Unhealthy endpoints are omitted from the results. If all endpoints are unhealthy, we serve a response based on the `backup_geo_targets`. "internalLoadBalancers": [ # Configuration for internal load balancers to be health checked. { # The configuration for an individual load balancer to health check. "ipAddress": "A String", # The frontend IP address of the load balancer to health check. "ipProtocol": "A String", # The protocol of the load balancer to health check. "kind": "dns#rRSetRoutingPolicyLoadBalancerTarget", "loadBalancerType": "A String", # The type of load balancer specified by this target. This value must match the configuration of the load balancer located at the LoadBalancerTarget's IP address, port, and region. Use the following: - *regionalL4ilb*: for a regional internal passthrough Network Load Balancer. - *regionalL7ilb*: for a regional internal Application Load Balancer. - *globalL7ilb*: for a global internal Application Load Balancer. - "networkUrl": "A String", # The fully qualified URL of the network that the load balancer is attached to. This should be formatted like https://www.googleapis.com/compute/v1/projects/{project}/global/networks/{network} . + "networkUrl": "A String", # The fully qualified URL of the network that the load balancer is attached to. This should be formatted like `https://www.googleapis.com/compute/v1/projects/{project}/global/networks/{network}`. "port": "A String", # The configured port of the load balancer. "project": "A String", # The project ID in which the load balancer is located. "region": "A String", # The region in which the load balancer is located. }, ], }, - "trickleTraffic": 3.14, # When serving state is PRIMARY, this field provides the option of sending a small percentage of the traffic to the backup targets. + "trickleTraffic": 3.14, # When serving state is `PRIMARY`, this field provides the option of sending a small percentage of the traffic to the backup targets. }, "wrr": { # Configures a RRSetRoutingPolicy that routes in a weighted round robin fashion. "items": [ { # A routing block which contains the routing information for one WRR item. - "healthCheckedTargets": { # HealthCheckTargets describes endpoints to health-check when responding to Routing Policy queries. Only the healthy endpoints will be included in the response. Only one of internal_load_balancer and external_endpoints should be set. # Endpoints that are health checked before making the routing decision. The unhealthy endpoints are omitted from the result. If all endpoints within a bucket are unhealthy, we choose a different bucket (sampled with respect to its weight) for responding. If DNSSEC is enabled for this zone, only one of rrdata or health_checked_targets can be set. + "healthCheckedTargets": { # HealthCheckTargets describes endpoints to health-check when responding to Routing Policy queries. Only the healthy endpoints will be included in the response. # Endpoints that are health checked before making the routing decision. The unhealthy endpoints are omitted from the result. If all endpoints within a bucket are unhealthy, we choose a different bucket (sampled with respect to its weight) for responding. If DNSSEC is enabled for this zone, only one of `rrdata` or `health_checked_targets` can be set. "internalLoadBalancers": [ # Configuration for internal load balancers to be health checked. { # The configuration for an individual load balancer to health check. "ipAddress": "A String", # The frontend IP address of the load balancer to health check. "ipProtocol": "A String", # The protocol of the load balancer to health check. "kind": "dns#rRSetRoutingPolicyLoadBalancerTarget", "loadBalancerType": "A String", # The type of load balancer specified by this target. This value must match the configuration of the load balancer located at the LoadBalancerTarget's IP address, port, and region. Use the following: - *regionalL4ilb*: for a regional internal passthrough Network Load Balancer. - *regionalL7ilb*: for a regional internal Application Load Balancer. - *globalL7ilb*: for a global internal Application Load Balancer. - "networkUrl": "A String", # The fully qualified URL of the network that the load balancer is attached to. This should be formatted like https://www.googleapis.com/compute/v1/projects/{project}/global/networks/{network} . + "networkUrl": "A String", # The fully qualified URL of the network that the load balancer is attached to. This should be formatted like `https://www.googleapis.com/compute/v1/projects/{project}/global/networks/{network}`. "port": "A String", # The configured port of the load balancer. "project": "A String", # The project ID in which the load balancer is located. "region": "A String", # The region in which the load balancer is located. @@ -245,10 +245,10 @@

Method Details

"rrdatas": [ "A String", ], - "signatureRrdatas": [ # DNSSEC generated signatures for all the rrdata within this item. Note that if health checked targets are provided for DNSSEC enabled zones, there's a restriction of 1 IP address per item. + "signatureRrdatas": [ # DNSSEC generated signatures for all the `rrdata` within this item. Note that if health checked targets are provided for DNSSEC enabled zones, there's a restriction of 1 IP address per item. "A String", ], - "weight": 3.14, # The weight corresponding to this WrrPolicyItem object. When multiple WrrPolicyItem objects are configured, the probability of returning an WrrPolicyItem object's data is proportional to its weight relative to the sum of weights configured for all items. This weight must be non-negative. + "weight": 3.14, # The weight corresponding to this `WrrPolicyItem` object. When multiple `WrrPolicyItem` objects are configured, the probability of returning an `WrrPolicyItem` object's data is proportional to its weight relative to the sum of weights configured for all items. This weight must be non-negative. }, ], "kind": "dns#rRSetRoutingPolicyWrrPolicy", @@ -256,14 +256,14 @@

Method Details

"wrrPolicy": { # Configures a RRSetRoutingPolicy that routes in a weighted round robin fashion. "items": [ { # A routing block which contains the routing information for one WRR item. - "healthCheckedTargets": { # HealthCheckTargets describes endpoints to health-check when responding to Routing Policy queries. Only the healthy endpoints will be included in the response. Only one of internal_load_balancer and external_endpoints should be set. # Endpoints that are health checked before making the routing decision. The unhealthy endpoints are omitted from the result. If all endpoints within a bucket are unhealthy, we choose a different bucket (sampled with respect to its weight) for responding. If DNSSEC is enabled for this zone, only one of rrdata or health_checked_targets can be set. + "healthCheckedTargets": { # HealthCheckTargets describes endpoints to health-check when responding to Routing Policy queries. Only the healthy endpoints will be included in the response. # Endpoints that are health checked before making the routing decision. The unhealthy endpoints are omitted from the result. If all endpoints within a bucket are unhealthy, we choose a different bucket (sampled with respect to its weight) for responding. If DNSSEC is enabled for this zone, only one of `rrdata` or `health_checked_targets` can be set. "internalLoadBalancers": [ # Configuration for internal load balancers to be health checked. { # The configuration for an individual load balancer to health check. "ipAddress": "A String", # The frontend IP address of the load balancer to health check. "ipProtocol": "A String", # The protocol of the load balancer to health check. "kind": "dns#rRSetRoutingPolicyLoadBalancerTarget", "loadBalancerType": "A String", # The type of load balancer specified by this target. This value must match the configuration of the load balancer located at the LoadBalancerTarget's IP address, port, and region. Use the following: - *regionalL4ilb*: for a regional internal passthrough Network Load Balancer. - *regionalL7ilb*: for a regional internal Application Load Balancer. - *globalL7ilb*: for a global internal Application Load Balancer. - "networkUrl": "A String", # The fully qualified URL of the network that the load balancer is attached to. This should be formatted like https://www.googleapis.com/compute/v1/projects/{project}/global/networks/{network} . + "networkUrl": "A String", # The fully qualified URL of the network that the load balancer is attached to. This should be formatted like `https://www.googleapis.com/compute/v1/projects/{project}/global/networks/{network}`. "port": "A String", # The configured port of the load balancer. "project": "A String", # The project ID in which the load balancer is located. "region": "A String", # The region in which the load balancer is located. @@ -274,10 +274,10 @@

Method Details

"rrdatas": [ "A String", ], - "signatureRrdatas": [ # DNSSEC generated signatures for all the rrdata within this item. Note that if health checked targets are provided for DNSSEC enabled zones, there's a restriction of 1 IP address per item. + "signatureRrdatas": [ # DNSSEC generated signatures for all the `rrdata` within this item. Note that if health checked targets are provided for DNSSEC enabled zones, there's a restriction of 1 IP address per item. "A String", ], - "weight": 3.14, # The weight corresponding to this WrrPolicyItem object. When multiple WrrPolicyItem objects are configured, the probability of returning an WrrPolicyItem object's data is proportional to its weight relative to the sum of weights configured for all items. This weight must be non-negative. + "weight": 3.14, # The weight corresponding to this `WrrPolicyItem` object. When multiple `WrrPolicyItem` objects are configured, the probability of returning an `WrrPolicyItem` object's data is proportional to its weight relative to the sum of weights configured for all items. This weight must be non-negative. }, ], "kind": "dns#rRSetRoutingPolicyWrrPolicy", @@ -289,7 +289,7 @@

Method Details

"signatureRrdatas": [ # As defined in RFC 4034 (section 3.2). "A String", ], - "ttl": 42, # Number of seconds that this ResourceRecordSet can be cached by resolvers. + "ttl": 42, # Number of seconds that this `ResourceRecordSet` can be cached by resolvers. "type": "A String", # The identifier of a supported record type. See the list of Supported DNS record types. } @@ -305,19 +305,19 @@

Method Details

{ # A unit of data that is returned by the DNS servers. "kind": "dns#resourceRecordSet", "name": "A String", # For example, www.example.com. - "routingPolicy": { # A RRSetRoutingPolicy represents ResourceRecordSet data that is returned dynamically with the response varying based on configured properties such as geolocation or by weighted random selection. # Configures dynamic query responses based on either the geo location of the querying user or a weighted round robin based routing policy. A valid ResourceRecordSet contains only rrdata (for static resolution) or a routing_policy (for dynamic resolution). - "geo": { # Configures a RRSetRoutingPolicy that routes based on the geo location of the querying user. + "routingPolicy": { # A RRSetRoutingPolicy represents ResourceRecordSet data that is returned dynamically with the response varying based on configured properties such as geolocation or by weighted random selection. # Configures dynamic query responses based on either the geo location of the querying user or a weighted round robin based routing policy. A valid `ResourceRecordSet` contains only `rrdata` (for static resolution) or a `routing_policy` (for dynamic resolution). + "geo": { # Configures a `RRSetRoutingPolicy` that routes based on the geo location of the querying user. "enableFencing": True or False, # Without fencing, if health check fails for all configured items in the current geo bucket, we failover to the next nearest geo bucket. With fencing, if health checking is enabled, as long as some targets in the current geo bucket are healthy, we return only the healthy targets. However, if all targets are unhealthy, we don't failover to the next nearest bucket; instead, we return all the items in the current bucket even when all targets are unhealthy. "items": [ # The primary geo routing configuration. If there are multiple items with the same location, an error is returned instead. { # ResourceRecordSet data for one geo location. - "healthCheckedTargets": { # HealthCheckTargets describes endpoints to health-check when responding to Routing Policy queries. Only the healthy endpoints will be included in the response. Only one of internal_load_balancer and external_endpoints should be set. # For A and AAAA types only. Endpoints to return in the query result only if they are healthy. These can be specified along with rrdata within this item. + "healthCheckedTargets": { # HealthCheckTargets describes endpoints to health-check when responding to Routing Policy queries. Only the healthy endpoints will be included in the response. # For A and AAAA types only. Endpoints to return in the query result only if they are healthy. These can be specified along with `rrdata` within this item. "internalLoadBalancers": [ # Configuration for internal load balancers to be health checked. { # The configuration for an individual load balancer to health check. "ipAddress": "A String", # The frontend IP address of the load balancer to health check. "ipProtocol": "A String", # The protocol of the load balancer to health check. "kind": "dns#rRSetRoutingPolicyLoadBalancerTarget", "loadBalancerType": "A String", # The type of load balancer specified by this target. This value must match the configuration of the load balancer located at the LoadBalancerTarget's IP address, port, and region. Use the following: - *regionalL4ilb*: for a regional internal passthrough Network Load Balancer. - *regionalL7ilb*: for a regional internal Application Load Balancer. - *globalL7ilb*: for a global internal Application Load Balancer. - "networkUrl": "A String", # The fully qualified URL of the network that the load balancer is attached to. This should be formatted like https://www.googleapis.com/compute/v1/projects/{project}/global/networks/{network} . + "networkUrl": "A String", # The fully qualified URL of the network that the load balancer is attached to. This should be formatted like `https://www.googleapis.com/compute/v1/projects/{project}/global/networks/{network}`. "port": "A String", # The configured port of the load balancer. "project": "A String", # The project ID in which the load balancer is located. "region": "A String", # The region in which the load balancer is located. @@ -329,25 +329,25 @@

Method Details

"rrdatas": [ "A String", ], - "signatureRrdatas": [ # DNSSEC generated signatures for all the rrdata within this item. If health checked targets are provided for DNSSEC enabled zones, there's a restriction of 1 IP address per item. + "signatureRrdatas": [ # DNSSEC generated signatures for all the `rrdata` within this item. If health checked targets are provided for DNSSEC enabled zones, there's a restriction of 1 IP address per item. "A String", ], }, ], "kind": "dns#rRSetRoutingPolicyGeoPolicy", }, - "geoPolicy": { # Configures a RRSetRoutingPolicy that routes based on the geo location of the querying user. + "geoPolicy": { # Configures a `RRSetRoutingPolicy` that routes based on the geo location of the querying user. "enableFencing": True or False, # Without fencing, if health check fails for all configured items in the current geo bucket, we failover to the next nearest geo bucket. With fencing, if health checking is enabled, as long as some targets in the current geo bucket are healthy, we return only the healthy targets. However, if all targets are unhealthy, we don't failover to the next nearest bucket; instead, we return all the items in the current bucket even when all targets are unhealthy. "items": [ # The primary geo routing configuration. If there are multiple items with the same location, an error is returned instead. { # ResourceRecordSet data for one geo location. - "healthCheckedTargets": { # HealthCheckTargets describes endpoints to health-check when responding to Routing Policy queries. Only the healthy endpoints will be included in the response. Only one of internal_load_balancer and external_endpoints should be set. # For A and AAAA types only. Endpoints to return in the query result only if they are healthy. These can be specified along with rrdata within this item. + "healthCheckedTargets": { # HealthCheckTargets describes endpoints to health-check when responding to Routing Policy queries. Only the healthy endpoints will be included in the response. # For A and AAAA types only. Endpoints to return in the query result only if they are healthy. These can be specified along with `rrdata` within this item. "internalLoadBalancers": [ # Configuration for internal load balancers to be health checked. { # The configuration for an individual load balancer to health check. "ipAddress": "A String", # The frontend IP address of the load balancer to health check. "ipProtocol": "A String", # The protocol of the load balancer to health check. "kind": "dns#rRSetRoutingPolicyLoadBalancerTarget", "loadBalancerType": "A String", # The type of load balancer specified by this target. This value must match the configuration of the load balancer located at the LoadBalancerTarget's IP address, port, and region. Use the following: - *regionalL4ilb*: for a regional internal passthrough Network Load Balancer. - *regionalL7ilb*: for a regional internal Application Load Balancer. - *globalL7ilb*: for a global internal Application Load Balancer. - "networkUrl": "A String", # The fully qualified URL of the network that the load balancer is attached to. This should be formatted like https://www.googleapis.com/compute/v1/projects/{project}/global/networks/{network} . + "networkUrl": "A String", # The fully qualified URL of the network that the load balancer is attached to. This should be formatted like `https://www.googleapis.com/compute/v1/projects/{project}/global/networks/{network}`. "port": "A String", # The configured port of the load balancer. "project": "A String", # The project ID in which the load balancer is located. "region": "A String", # The region in which the load balancer is located. @@ -359,7 +359,7 @@

Method Details

"rrdatas": [ "A String", ], - "signatureRrdatas": [ # DNSSEC generated signatures for all the rrdata within this item. If health checked targets are provided for DNSSEC enabled zones, there's a restriction of 1 IP address per item. + "signatureRrdatas": [ # DNSSEC generated signatures for all the `rrdata` within this item. If health checked targets are provided for DNSSEC enabled zones, there's a restriction of 1 IP address per item. "A String", ], }, @@ -368,18 +368,18 @@

Method Details

}, "kind": "dns#rRSetRoutingPolicy", "primaryBackup": { # Configures a RRSetRoutingPolicy such that all queries are responded with the primary_targets if they are healthy. And if all of them are unhealthy, then we fallback to a geo localized policy. - "backupGeoTargets": { # Configures a RRSetRoutingPolicy that routes based on the geo location of the querying user. # Backup targets provide a regional failover policy for the otherwise global primary targets. If serving state is set to BACKUP, this policy essentially becomes a geo routing policy. + "backupGeoTargets": { # Configures a `RRSetRoutingPolicy` that routes based on the geo location of the querying user. # Backup targets provide a regional failover policy for the otherwise global primary targets. If serving state is set to `BACKUP`, this policy essentially becomes a geo routing policy. "enableFencing": True or False, # Without fencing, if health check fails for all configured items in the current geo bucket, we failover to the next nearest geo bucket. With fencing, if health checking is enabled, as long as some targets in the current geo bucket are healthy, we return only the healthy targets. However, if all targets are unhealthy, we don't failover to the next nearest bucket; instead, we return all the items in the current bucket even when all targets are unhealthy. "items": [ # The primary geo routing configuration. If there are multiple items with the same location, an error is returned instead. { # ResourceRecordSet data for one geo location. - "healthCheckedTargets": { # HealthCheckTargets describes endpoints to health-check when responding to Routing Policy queries. Only the healthy endpoints will be included in the response. Only one of internal_load_balancer and external_endpoints should be set. # For A and AAAA types only. Endpoints to return in the query result only if they are healthy. These can be specified along with rrdata within this item. + "healthCheckedTargets": { # HealthCheckTargets describes endpoints to health-check when responding to Routing Policy queries. Only the healthy endpoints will be included in the response. # For A and AAAA types only. Endpoints to return in the query result only if they are healthy. These can be specified along with `rrdata` within this item. "internalLoadBalancers": [ # Configuration for internal load balancers to be health checked. { # The configuration for an individual load balancer to health check. "ipAddress": "A String", # The frontend IP address of the load balancer to health check. "ipProtocol": "A String", # The protocol of the load balancer to health check. "kind": "dns#rRSetRoutingPolicyLoadBalancerTarget", "loadBalancerType": "A String", # The type of load balancer specified by this target. This value must match the configuration of the load balancer located at the LoadBalancerTarget's IP address, port, and region. Use the following: - *regionalL4ilb*: for a regional internal passthrough Network Load Balancer. - *regionalL7ilb*: for a regional internal Application Load Balancer. - *globalL7ilb*: for a global internal Application Load Balancer. - "networkUrl": "A String", # The fully qualified URL of the network that the load balancer is attached to. This should be formatted like https://www.googleapis.com/compute/v1/projects/{project}/global/networks/{network} . + "networkUrl": "A String", # The fully qualified URL of the network that the load balancer is attached to. This should be formatted like `https://www.googleapis.com/compute/v1/projects/{project}/global/networks/{network}`. "port": "A String", # The configured port of the load balancer. "project": "A String", # The project ID in which the load balancer is located. "region": "A String", # The region in which the load balancer is located. @@ -391,7 +391,7 @@

Method Details

"rrdatas": [ "A String", ], - "signatureRrdatas": [ # DNSSEC generated signatures for all the rrdata within this item. If health checked targets are provided for DNSSEC enabled zones, there's a restriction of 1 IP address per item. + "signatureRrdatas": [ # DNSSEC generated signatures for all the `rrdata` within this item. If health checked targets are provided for DNSSEC enabled zones, there's a restriction of 1 IP address per item. "A String", ], }, @@ -399,33 +399,33 @@

Method Details

"kind": "dns#rRSetRoutingPolicyGeoPolicy", }, "kind": "dns#rRSetRoutingPolicyPrimaryBackupPolicy", - "primaryTargets": { # HealthCheckTargets describes endpoints to health-check when responding to Routing Policy queries. Only the healthy endpoints will be included in the response. Only one of internal_load_balancer and external_endpoints should be set. # Endpoints that are health checked before making the routing decision. Unhealthy endpoints are omitted from the results. If all endpoints are unhealthy, we serve a response based on the backup_geo_targets. + "primaryTargets": { # HealthCheckTargets describes endpoints to health-check when responding to Routing Policy queries. Only the healthy endpoints will be included in the response. # Endpoints that are health checked before making the routing decision. Unhealthy endpoints are omitted from the results. If all endpoints are unhealthy, we serve a response based on the `backup_geo_targets`. "internalLoadBalancers": [ # Configuration for internal load balancers to be health checked. { # The configuration for an individual load balancer to health check. "ipAddress": "A String", # The frontend IP address of the load balancer to health check. "ipProtocol": "A String", # The protocol of the load balancer to health check. "kind": "dns#rRSetRoutingPolicyLoadBalancerTarget", "loadBalancerType": "A String", # The type of load balancer specified by this target. This value must match the configuration of the load balancer located at the LoadBalancerTarget's IP address, port, and region. Use the following: - *regionalL4ilb*: for a regional internal passthrough Network Load Balancer. - *regionalL7ilb*: for a regional internal Application Load Balancer. - *globalL7ilb*: for a global internal Application Load Balancer. - "networkUrl": "A String", # The fully qualified URL of the network that the load balancer is attached to. This should be formatted like https://www.googleapis.com/compute/v1/projects/{project}/global/networks/{network} . + "networkUrl": "A String", # The fully qualified URL of the network that the load balancer is attached to. This should be formatted like `https://www.googleapis.com/compute/v1/projects/{project}/global/networks/{network}`. "port": "A String", # The configured port of the load balancer. "project": "A String", # The project ID in which the load balancer is located. "region": "A String", # The region in which the load balancer is located. }, ], }, - "trickleTraffic": 3.14, # When serving state is PRIMARY, this field provides the option of sending a small percentage of the traffic to the backup targets. + "trickleTraffic": 3.14, # When serving state is `PRIMARY`, this field provides the option of sending a small percentage of the traffic to the backup targets. }, "wrr": { # Configures a RRSetRoutingPolicy that routes in a weighted round robin fashion. "items": [ { # A routing block which contains the routing information for one WRR item. - "healthCheckedTargets": { # HealthCheckTargets describes endpoints to health-check when responding to Routing Policy queries. Only the healthy endpoints will be included in the response. Only one of internal_load_balancer and external_endpoints should be set. # Endpoints that are health checked before making the routing decision. The unhealthy endpoints are omitted from the result. If all endpoints within a bucket are unhealthy, we choose a different bucket (sampled with respect to its weight) for responding. If DNSSEC is enabled for this zone, only one of rrdata or health_checked_targets can be set. + "healthCheckedTargets": { # HealthCheckTargets describes endpoints to health-check when responding to Routing Policy queries. Only the healthy endpoints will be included in the response. # Endpoints that are health checked before making the routing decision. The unhealthy endpoints are omitted from the result. If all endpoints within a bucket are unhealthy, we choose a different bucket (sampled with respect to its weight) for responding. If DNSSEC is enabled for this zone, only one of `rrdata` or `health_checked_targets` can be set. "internalLoadBalancers": [ # Configuration for internal load balancers to be health checked. { # The configuration for an individual load balancer to health check. "ipAddress": "A String", # The frontend IP address of the load balancer to health check. "ipProtocol": "A String", # The protocol of the load balancer to health check. "kind": "dns#rRSetRoutingPolicyLoadBalancerTarget", "loadBalancerType": "A String", # The type of load balancer specified by this target. This value must match the configuration of the load balancer located at the LoadBalancerTarget's IP address, port, and region. Use the following: - *regionalL4ilb*: for a regional internal passthrough Network Load Balancer. - *regionalL7ilb*: for a regional internal Application Load Balancer. - *globalL7ilb*: for a global internal Application Load Balancer. - "networkUrl": "A String", # The fully qualified URL of the network that the load balancer is attached to. This should be formatted like https://www.googleapis.com/compute/v1/projects/{project}/global/networks/{network} . + "networkUrl": "A String", # The fully qualified URL of the network that the load balancer is attached to. This should be formatted like `https://www.googleapis.com/compute/v1/projects/{project}/global/networks/{network}`. "port": "A String", # The configured port of the load balancer. "project": "A String", # The project ID in which the load balancer is located. "region": "A String", # The region in which the load balancer is located. @@ -436,10 +436,10 @@

Method Details

"rrdatas": [ "A String", ], - "signatureRrdatas": [ # DNSSEC generated signatures for all the rrdata within this item. Note that if health checked targets are provided for DNSSEC enabled zones, there's a restriction of 1 IP address per item. + "signatureRrdatas": [ # DNSSEC generated signatures for all the `rrdata` within this item. Note that if health checked targets are provided for DNSSEC enabled zones, there's a restriction of 1 IP address per item. "A String", ], - "weight": 3.14, # The weight corresponding to this WrrPolicyItem object. When multiple WrrPolicyItem objects are configured, the probability of returning an WrrPolicyItem object's data is proportional to its weight relative to the sum of weights configured for all items. This weight must be non-negative. + "weight": 3.14, # The weight corresponding to this `WrrPolicyItem` object. When multiple `WrrPolicyItem` objects are configured, the probability of returning an `WrrPolicyItem` object's data is proportional to its weight relative to the sum of weights configured for all items. This weight must be non-negative. }, ], "kind": "dns#rRSetRoutingPolicyWrrPolicy", @@ -447,14 +447,14 @@

Method Details

"wrrPolicy": { # Configures a RRSetRoutingPolicy that routes in a weighted round robin fashion. "items": [ { # A routing block which contains the routing information for one WRR item. - "healthCheckedTargets": { # HealthCheckTargets describes endpoints to health-check when responding to Routing Policy queries. Only the healthy endpoints will be included in the response. Only one of internal_load_balancer and external_endpoints should be set. # Endpoints that are health checked before making the routing decision. The unhealthy endpoints are omitted from the result. If all endpoints within a bucket are unhealthy, we choose a different bucket (sampled with respect to its weight) for responding. If DNSSEC is enabled for this zone, only one of rrdata or health_checked_targets can be set. + "healthCheckedTargets": { # HealthCheckTargets describes endpoints to health-check when responding to Routing Policy queries. Only the healthy endpoints will be included in the response. # Endpoints that are health checked before making the routing decision. The unhealthy endpoints are omitted from the result. If all endpoints within a bucket are unhealthy, we choose a different bucket (sampled with respect to its weight) for responding. If DNSSEC is enabled for this zone, only one of `rrdata` or `health_checked_targets` can be set. "internalLoadBalancers": [ # Configuration for internal load balancers to be health checked. { # The configuration for an individual load balancer to health check. "ipAddress": "A String", # The frontend IP address of the load balancer to health check. "ipProtocol": "A String", # The protocol of the load balancer to health check. "kind": "dns#rRSetRoutingPolicyLoadBalancerTarget", "loadBalancerType": "A String", # The type of load balancer specified by this target. This value must match the configuration of the load balancer located at the LoadBalancerTarget's IP address, port, and region. Use the following: - *regionalL4ilb*: for a regional internal passthrough Network Load Balancer. - *regionalL7ilb*: for a regional internal Application Load Balancer. - *globalL7ilb*: for a global internal Application Load Balancer. - "networkUrl": "A String", # The fully qualified URL of the network that the load balancer is attached to. This should be formatted like https://www.googleapis.com/compute/v1/projects/{project}/global/networks/{network} . + "networkUrl": "A String", # The fully qualified URL of the network that the load balancer is attached to. This should be formatted like `https://www.googleapis.com/compute/v1/projects/{project}/global/networks/{network}`. "port": "A String", # The configured port of the load balancer. "project": "A String", # The project ID in which the load balancer is located. "region": "A String", # The region in which the load balancer is located. @@ -465,10 +465,10 @@

Method Details

"rrdatas": [ "A String", ], - "signatureRrdatas": [ # DNSSEC generated signatures for all the rrdata within this item. Note that if health checked targets are provided for DNSSEC enabled zones, there's a restriction of 1 IP address per item. + "signatureRrdatas": [ # DNSSEC generated signatures for all the `rrdata` within this item. Note that if health checked targets are provided for DNSSEC enabled zones, there's a restriction of 1 IP address per item. "A String", ], - "weight": 3.14, # The weight corresponding to this WrrPolicyItem object. When multiple WrrPolicyItem objects are configured, the probability of returning an WrrPolicyItem object's data is proportional to its weight relative to the sum of weights configured for all items. This weight must be non-negative. + "weight": 3.14, # The weight corresponding to this `WrrPolicyItem` object. When multiple `WrrPolicyItem` objects are configured, the probability of returning an `WrrPolicyItem` object's data is proportional to its weight relative to the sum of weights configured for all items. This weight must be non-negative. }, ], "kind": "dns#rRSetRoutingPolicyWrrPolicy", @@ -480,7 +480,7 @@

Method Details

"signatureRrdatas": [ # As defined in RFC 4034 (section 3.2). "A String", ], - "ttl": 42, # Number of seconds that this ResourceRecordSet can be cached by resolvers. + "ttl": 42, # Number of seconds that this `ResourceRecordSet` can be cached by resolvers. "type": "A String", # The identifier of a supported record type. See the list of Supported DNS record types. } @@ -523,19 +523,19 @@

Method Details

{ # A unit of data that is returned by the DNS servers. "kind": "dns#resourceRecordSet", "name": "A String", # For example, www.example.com. - "routingPolicy": { # A RRSetRoutingPolicy represents ResourceRecordSet data that is returned dynamically with the response varying based on configured properties such as geolocation or by weighted random selection. # Configures dynamic query responses based on either the geo location of the querying user or a weighted round robin based routing policy. A valid ResourceRecordSet contains only rrdata (for static resolution) or a routing_policy (for dynamic resolution). - "geo": { # Configures a RRSetRoutingPolicy that routes based on the geo location of the querying user. + "routingPolicy": { # A RRSetRoutingPolicy represents ResourceRecordSet data that is returned dynamically with the response varying based on configured properties such as geolocation or by weighted random selection. # Configures dynamic query responses based on either the geo location of the querying user or a weighted round robin based routing policy. A valid `ResourceRecordSet` contains only `rrdata` (for static resolution) or a `routing_policy` (for dynamic resolution). + "geo": { # Configures a `RRSetRoutingPolicy` that routes based on the geo location of the querying user. "enableFencing": True or False, # Without fencing, if health check fails for all configured items in the current geo bucket, we failover to the next nearest geo bucket. With fencing, if health checking is enabled, as long as some targets in the current geo bucket are healthy, we return only the healthy targets. However, if all targets are unhealthy, we don't failover to the next nearest bucket; instead, we return all the items in the current bucket even when all targets are unhealthy. "items": [ # The primary geo routing configuration. If there are multiple items with the same location, an error is returned instead. { # ResourceRecordSet data for one geo location. - "healthCheckedTargets": { # HealthCheckTargets describes endpoints to health-check when responding to Routing Policy queries. Only the healthy endpoints will be included in the response. Only one of internal_load_balancer and external_endpoints should be set. # For A and AAAA types only. Endpoints to return in the query result only if they are healthy. These can be specified along with rrdata within this item. + "healthCheckedTargets": { # HealthCheckTargets describes endpoints to health-check when responding to Routing Policy queries. Only the healthy endpoints will be included in the response. # For A and AAAA types only. Endpoints to return in the query result only if they are healthy. These can be specified along with `rrdata` within this item. "internalLoadBalancers": [ # Configuration for internal load balancers to be health checked. { # The configuration for an individual load balancer to health check. "ipAddress": "A String", # The frontend IP address of the load balancer to health check. "ipProtocol": "A String", # The protocol of the load balancer to health check. "kind": "dns#rRSetRoutingPolicyLoadBalancerTarget", "loadBalancerType": "A String", # The type of load balancer specified by this target. This value must match the configuration of the load balancer located at the LoadBalancerTarget's IP address, port, and region. Use the following: - *regionalL4ilb*: for a regional internal passthrough Network Load Balancer. - *regionalL7ilb*: for a regional internal Application Load Balancer. - *globalL7ilb*: for a global internal Application Load Balancer. - "networkUrl": "A String", # The fully qualified URL of the network that the load balancer is attached to. This should be formatted like https://www.googleapis.com/compute/v1/projects/{project}/global/networks/{network} . + "networkUrl": "A String", # The fully qualified URL of the network that the load balancer is attached to. This should be formatted like `https://www.googleapis.com/compute/v1/projects/{project}/global/networks/{network}`. "port": "A String", # The configured port of the load balancer. "project": "A String", # The project ID in which the load balancer is located. "region": "A String", # The region in which the load balancer is located. @@ -547,25 +547,25 @@

Method Details

"rrdatas": [ "A String", ], - "signatureRrdatas": [ # DNSSEC generated signatures for all the rrdata within this item. If health checked targets are provided for DNSSEC enabled zones, there's a restriction of 1 IP address per item. + "signatureRrdatas": [ # DNSSEC generated signatures for all the `rrdata` within this item. If health checked targets are provided for DNSSEC enabled zones, there's a restriction of 1 IP address per item. "A String", ], }, ], "kind": "dns#rRSetRoutingPolicyGeoPolicy", }, - "geoPolicy": { # Configures a RRSetRoutingPolicy that routes based on the geo location of the querying user. + "geoPolicy": { # Configures a `RRSetRoutingPolicy` that routes based on the geo location of the querying user. "enableFencing": True or False, # Without fencing, if health check fails for all configured items in the current geo bucket, we failover to the next nearest geo bucket. With fencing, if health checking is enabled, as long as some targets in the current geo bucket are healthy, we return only the healthy targets. However, if all targets are unhealthy, we don't failover to the next nearest bucket; instead, we return all the items in the current bucket even when all targets are unhealthy. "items": [ # The primary geo routing configuration. If there are multiple items with the same location, an error is returned instead. { # ResourceRecordSet data for one geo location. - "healthCheckedTargets": { # HealthCheckTargets describes endpoints to health-check when responding to Routing Policy queries. Only the healthy endpoints will be included in the response. Only one of internal_load_balancer and external_endpoints should be set. # For A and AAAA types only. Endpoints to return in the query result only if they are healthy. These can be specified along with rrdata within this item. + "healthCheckedTargets": { # HealthCheckTargets describes endpoints to health-check when responding to Routing Policy queries. Only the healthy endpoints will be included in the response. # For A and AAAA types only. Endpoints to return in the query result only if they are healthy. These can be specified along with `rrdata` within this item. "internalLoadBalancers": [ # Configuration for internal load balancers to be health checked. { # The configuration for an individual load balancer to health check. "ipAddress": "A String", # The frontend IP address of the load balancer to health check. "ipProtocol": "A String", # The protocol of the load balancer to health check. "kind": "dns#rRSetRoutingPolicyLoadBalancerTarget", "loadBalancerType": "A String", # The type of load balancer specified by this target. This value must match the configuration of the load balancer located at the LoadBalancerTarget's IP address, port, and region. Use the following: - *regionalL4ilb*: for a regional internal passthrough Network Load Balancer. - *regionalL7ilb*: for a regional internal Application Load Balancer. - *globalL7ilb*: for a global internal Application Load Balancer. - "networkUrl": "A String", # The fully qualified URL of the network that the load balancer is attached to. This should be formatted like https://www.googleapis.com/compute/v1/projects/{project}/global/networks/{network} . + "networkUrl": "A String", # The fully qualified URL of the network that the load balancer is attached to. This should be formatted like `https://www.googleapis.com/compute/v1/projects/{project}/global/networks/{network}`. "port": "A String", # The configured port of the load balancer. "project": "A String", # The project ID in which the load balancer is located. "region": "A String", # The region in which the load balancer is located. @@ -577,7 +577,7 @@

Method Details

"rrdatas": [ "A String", ], - "signatureRrdatas": [ # DNSSEC generated signatures for all the rrdata within this item. If health checked targets are provided for DNSSEC enabled zones, there's a restriction of 1 IP address per item. + "signatureRrdatas": [ # DNSSEC generated signatures for all the `rrdata` within this item. If health checked targets are provided for DNSSEC enabled zones, there's a restriction of 1 IP address per item. "A String", ], }, @@ -586,18 +586,18 @@

Method Details

}, "kind": "dns#rRSetRoutingPolicy", "primaryBackup": { # Configures a RRSetRoutingPolicy such that all queries are responded with the primary_targets if they are healthy. And if all of them are unhealthy, then we fallback to a geo localized policy. - "backupGeoTargets": { # Configures a RRSetRoutingPolicy that routes based on the geo location of the querying user. # Backup targets provide a regional failover policy for the otherwise global primary targets. If serving state is set to BACKUP, this policy essentially becomes a geo routing policy. + "backupGeoTargets": { # Configures a `RRSetRoutingPolicy` that routes based on the geo location of the querying user. # Backup targets provide a regional failover policy for the otherwise global primary targets. If serving state is set to `BACKUP`, this policy essentially becomes a geo routing policy. "enableFencing": True or False, # Without fencing, if health check fails for all configured items in the current geo bucket, we failover to the next nearest geo bucket. With fencing, if health checking is enabled, as long as some targets in the current geo bucket are healthy, we return only the healthy targets. However, if all targets are unhealthy, we don't failover to the next nearest bucket; instead, we return all the items in the current bucket even when all targets are unhealthy. "items": [ # The primary geo routing configuration. If there are multiple items with the same location, an error is returned instead. { # ResourceRecordSet data for one geo location. - "healthCheckedTargets": { # HealthCheckTargets describes endpoints to health-check when responding to Routing Policy queries. Only the healthy endpoints will be included in the response. Only one of internal_load_balancer and external_endpoints should be set. # For A and AAAA types only. Endpoints to return in the query result only if they are healthy. These can be specified along with rrdata within this item. + "healthCheckedTargets": { # HealthCheckTargets describes endpoints to health-check when responding to Routing Policy queries. Only the healthy endpoints will be included in the response. # For A and AAAA types only. Endpoints to return in the query result only if they are healthy. These can be specified along with `rrdata` within this item. "internalLoadBalancers": [ # Configuration for internal load balancers to be health checked. { # The configuration for an individual load balancer to health check. "ipAddress": "A String", # The frontend IP address of the load balancer to health check. "ipProtocol": "A String", # The protocol of the load balancer to health check. "kind": "dns#rRSetRoutingPolicyLoadBalancerTarget", "loadBalancerType": "A String", # The type of load balancer specified by this target. This value must match the configuration of the load balancer located at the LoadBalancerTarget's IP address, port, and region. Use the following: - *regionalL4ilb*: for a regional internal passthrough Network Load Balancer. - *regionalL7ilb*: for a regional internal Application Load Balancer. - *globalL7ilb*: for a global internal Application Load Balancer. - "networkUrl": "A String", # The fully qualified URL of the network that the load balancer is attached to. This should be formatted like https://www.googleapis.com/compute/v1/projects/{project}/global/networks/{network} . + "networkUrl": "A String", # The fully qualified URL of the network that the load balancer is attached to. This should be formatted like `https://www.googleapis.com/compute/v1/projects/{project}/global/networks/{network}`. "port": "A String", # The configured port of the load balancer. "project": "A String", # The project ID in which the load balancer is located. "region": "A String", # The region in which the load balancer is located. @@ -609,7 +609,7 @@

Method Details

"rrdatas": [ "A String", ], - "signatureRrdatas": [ # DNSSEC generated signatures for all the rrdata within this item. If health checked targets are provided for DNSSEC enabled zones, there's a restriction of 1 IP address per item. + "signatureRrdatas": [ # DNSSEC generated signatures for all the `rrdata` within this item. If health checked targets are provided for DNSSEC enabled zones, there's a restriction of 1 IP address per item. "A String", ], }, @@ -617,33 +617,33 @@

Method Details

"kind": "dns#rRSetRoutingPolicyGeoPolicy", }, "kind": "dns#rRSetRoutingPolicyPrimaryBackupPolicy", - "primaryTargets": { # HealthCheckTargets describes endpoints to health-check when responding to Routing Policy queries. Only the healthy endpoints will be included in the response. Only one of internal_load_balancer and external_endpoints should be set. # Endpoints that are health checked before making the routing decision. Unhealthy endpoints are omitted from the results. If all endpoints are unhealthy, we serve a response based on the backup_geo_targets. + "primaryTargets": { # HealthCheckTargets describes endpoints to health-check when responding to Routing Policy queries. Only the healthy endpoints will be included in the response. # Endpoints that are health checked before making the routing decision. Unhealthy endpoints are omitted from the results. If all endpoints are unhealthy, we serve a response based on the `backup_geo_targets`. "internalLoadBalancers": [ # Configuration for internal load balancers to be health checked. { # The configuration for an individual load balancer to health check. "ipAddress": "A String", # The frontend IP address of the load balancer to health check. "ipProtocol": "A String", # The protocol of the load balancer to health check. "kind": "dns#rRSetRoutingPolicyLoadBalancerTarget", "loadBalancerType": "A String", # The type of load balancer specified by this target. This value must match the configuration of the load balancer located at the LoadBalancerTarget's IP address, port, and region. Use the following: - *regionalL4ilb*: for a regional internal passthrough Network Load Balancer. - *regionalL7ilb*: for a regional internal Application Load Balancer. - *globalL7ilb*: for a global internal Application Load Balancer. - "networkUrl": "A String", # The fully qualified URL of the network that the load balancer is attached to. This should be formatted like https://www.googleapis.com/compute/v1/projects/{project}/global/networks/{network} . + "networkUrl": "A String", # The fully qualified URL of the network that the load balancer is attached to. This should be formatted like `https://www.googleapis.com/compute/v1/projects/{project}/global/networks/{network}`. "port": "A String", # The configured port of the load balancer. "project": "A String", # The project ID in which the load balancer is located. "region": "A String", # The region in which the load balancer is located. }, ], }, - "trickleTraffic": 3.14, # When serving state is PRIMARY, this field provides the option of sending a small percentage of the traffic to the backup targets. + "trickleTraffic": 3.14, # When serving state is `PRIMARY`, this field provides the option of sending a small percentage of the traffic to the backup targets. }, "wrr": { # Configures a RRSetRoutingPolicy that routes in a weighted round robin fashion. "items": [ { # A routing block which contains the routing information for one WRR item. - "healthCheckedTargets": { # HealthCheckTargets describes endpoints to health-check when responding to Routing Policy queries. Only the healthy endpoints will be included in the response. Only one of internal_load_balancer and external_endpoints should be set. # Endpoints that are health checked before making the routing decision. The unhealthy endpoints are omitted from the result. If all endpoints within a bucket are unhealthy, we choose a different bucket (sampled with respect to its weight) for responding. If DNSSEC is enabled for this zone, only one of rrdata or health_checked_targets can be set. + "healthCheckedTargets": { # HealthCheckTargets describes endpoints to health-check when responding to Routing Policy queries. Only the healthy endpoints will be included in the response. # Endpoints that are health checked before making the routing decision. The unhealthy endpoints are omitted from the result. If all endpoints within a bucket are unhealthy, we choose a different bucket (sampled with respect to its weight) for responding. If DNSSEC is enabled for this zone, only one of `rrdata` or `health_checked_targets` can be set. "internalLoadBalancers": [ # Configuration for internal load balancers to be health checked. { # The configuration for an individual load balancer to health check. "ipAddress": "A String", # The frontend IP address of the load balancer to health check. "ipProtocol": "A String", # The protocol of the load balancer to health check. "kind": "dns#rRSetRoutingPolicyLoadBalancerTarget", "loadBalancerType": "A String", # The type of load balancer specified by this target. This value must match the configuration of the load balancer located at the LoadBalancerTarget's IP address, port, and region. Use the following: - *regionalL4ilb*: for a regional internal passthrough Network Load Balancer. - *regionalL7ilb*: for a regional internal Application Load Balancer. - *globalL7ilb*: for a global internal Application Load Balancer. - "networkUrl": "A String", # The fully qualified URL of the network that the load balancer is attached to. This should be formatted like https://www.googleapis.com/compute/v1/projects/{project}/global/networks/{network} . + "networkUrl": "A String", # The fully qualified URL of the network that the load balancer is attached to. This should be formatted like `https://www.googleapis.com/compute/v1/projects/{project}/global/networks/{network}`. "port": "A String", # The configured port of the load balancer. "project": "A String", # The project ID in which the load balancer is located. "region": "A String", # The region in which the load balancer is located. @@ -654,10 +654,10 @@

Method Details

"rrdatas": [ "A String", ], - "signatureRrdatas": [ # DNSSEC generated signatures for all the rrdata within this item. Note that if health checked targets are provided for DNSSEC enabled zones, there's a restriction of 1 IP address per item. + "signatureRrdatas": [ # DNSSEC generated signatures for all the `rrdata` within this item. Note that if health checked targets are provided for DNSSEC enabled zones, there's a restriction of 1 IP address per item. "A String", ], - "weight": 3.14, # The weight corresponding to this WrrPolicyItem object. When multiple WrrPolicyItem objects are configured, the probability of returning an WrrPolicyItem object's data is proportional to its weight relative to the sum of weights configured for all items. This weight must be non-negative. + "weight": 3.14, # The weight corresponding to this `WrrPolicyItem` object. When multiple `WrrPolicyItem` objects are configured, the probability of returning an `WrrPolicyItem` object's data is proportional to its weight relative to the sum of weights configured for all items. This weight must be non-negative. }, ], "kind": "dns#rRSetRoutingPolicyWrrPolicy", @@ -665,14 +665,14 @@

Method Details

"wrrPolicy": { # Configures a RRSetRoutingPolicy that routes in a weighted round robin fashion. "items": [ { # A routing block which contains the routing information for one WRR item. - "healthCheckedTargets": { # HealthCheckTargets describes endpoints to health-check when responding to Routing Policy queries. Only the healthy endpoints will be included in the response. Only one of internal_load_balancer and external_endpoints should be set. # Endpoints that are health checked before making the routing decision. The unhealthy endpoints are omitted from the result. If all endpoints within a bucket are unhealthy, we choose a different bucket (sampled with respect to its weight) for responding. If DNSSEC is enabled for this zone, only one of rrdata or health_checked_targets can be set. + "healthCheckedTargets": { # HealthCheckTargets describes endpoints to health-check when responding to Routing Policy queries. Only the healthy endpoints will be included in the response. # Endpoints that are health checked before making the routing decision. The unhealthy endpoints are omitted from the result. If all endpoints within a bucket are unhealthy, we choose a different bucket (sampled with respect to its weight) for responding. If DNSSEC is enabled for this zone, only one of `rrdata` or `health_checked_targets` can be set. "internalLoadBalancers": [ # Configuration for internal load balancers to be health checked. { # The configuration for an individual load balancer to health check. "ipAddress": "A String", # The frontend IP address of the load balancer to health check. "ipProtocol": "A String", # The protocol of the load balancer to health check. "kind": "dns#rRSetRoutingPolicyLoadBalancerTarget", "loadBalancerType": "A String", # The type of load balancer specified by this target. This value must match the configuration of the load balancer located at the LoadBalancerTarget's IP address, port, and region. Use the following: - *regionalL4ilb*: for a regional internal passthrough Network Load Balancer. - *regionalL7ilb*: for a regional internal Application Load Balancer. - *globalL7ilb*: for a global internal Application Load Balancer. - "networkUrl": "A String", # The fully qualified URL of the network that the load balancer is attached to. This should be formatted like https://www.googleapis.com/compute/v1/projects/{project}/global/networks/{network} . + "networkUrl": "A String", # The fully qualified URL of the network that the load balancer is attached to. This should be formatted like `https://www.googleapis.com/compute/v1/projects/{project}/global/networks/{network}`. "port": "A String", # The configured port of the load balancer. "project": "A String", # The project ID in which the load balancer is located. "region": "A String", # The region in which the load balancer is located. @@ -683,10 +683,10 @@

Method Details

"rrdatas": [ "A String", ], - "signatureRrdatas": [ # DNSSEC generated signatures for all the rrdata within this item. Note that if health checked targets are provided for DNSSEC enabled zones, there's a restriction of 1 IP address per item. + "signatureRrdatas": [ # DNSSEC generated signatures for all the `rrdata` within this item. Note that if health checked targets are provided for DNSSEC enabled zones, there's a restriction of 1 IP address per item. "A String", ], - "weight": 3.14, # The weight corresponding to this WrrPolicyItem object. When multiple WrrPolicyItem objects are configured, the probability of returning an WrrPolicyItem object's data is proportional to its weight relative to the sum of weights configured for all items. This weight must be non-negative. + "weight": 3.14, # The weight corresponding to this `WrrPolicyItem` object. When multiple `WrrPolicyItem` objects are configured, the probability of returning an `WrrPolicyItem` object's data is proportional to its weight relative to the sum of weights configured for all items. This weight must be non-negative. }, ], "kind": "dns#rRSetRoutingPolicyWrrPolicy", @@ -698,7 +698,7 @@

Method Details

"signatureRrdatas": [ # As defined in RFC 4034 (section 3.2). "A String", ], - "ttl": 42, # Number of seconds that this ResourceRecordSet can be cached by resolvers. + "ttl": 42, # Number of seconds that this `ResourceRecordSet` can be cached by resolvers. "type": "A String", # The identifier of a supported record type. See the list of Supported DNS record types. } @@ -723,28 +723,25 @@

Method Details

An object of the form: { - "header": { # Elements common to every response. - "operationId": "A String", # For mutating operation requests that completed successfully. This is the client_operation_id if the client specified it, otherwise it is generated by the server (output only). - }, "kind": "dns#resourceRecordSetsListResponse", # Type of resource. - "nextPageToken": "A String", # The presence of this field indicates that there exist more results following your last page of results in pagination order. To fetch them, make another list request using this value as your pagination token. This lets you retrieve the complete contents of even larger collections, one page at a time. However, if the collection changes between paginated list requests, the set of elements returned is an inconsistent view of the collection. You cannot retrieve a consistent snapshot of a collection larger than the maximum page size. + "nextPageToken": "A String", # This field indicates that more results are available beyond the last page displayed. To fetch the results, make another list request and use this value as your page token. This lets you retrieve the complete contents of a very large collection one page at a time. However, if the contents of the collection change between the first and last paginated list request, the set of all elements returned are an inconsistent view of the collection. You can't retrieve a consistent snapshot of a collection larger than the maximum page size. "rrsets": [ # The resource record set resources. { # A unit of data that is returned by the DNS servers. "kind": "dns#resourceRecordSet", "name": "A String", # For example, www.example.com. - "routingPolicy": { # A RRSetRoutingPolicy represents ResourceRecordSet data that is returned dynamically with the response varying based on configured properties such as geolocation or by weighted random selection. # Configures dynamic query responses based on either the geo location of the querying user or a weighted round robin based routing policy. A valid ResourceRecordSet contains only rrdata (for static resolution) or a routing_policy (for dynamic resolution). - "geo": { # Configures a RRSetRoutingPolicy that routes based on the geo location of the querying user. + "routingPolicy": { # A RRSetRoutingPolicy represents ResourceRecordSet data that is returned dynamically with the response varying based on configured properties such as geolocation or by weighted random selection. # Configures dynamic query responses based on either the geo location of the querying user or a weighted round robin based routing policy. A valid `ResourceRecordSet` contains only `rrdata` (for static resolution) or a `routing_policy` (for dynamic resolution). + "geo": { # Configures a `RRSetRoutingPolicy` that routes based on the geo location of the querying user. "enableFencing": True or False, # Without fencing, if health check fails for all configured items in the current geo bucket, we failover to the next nearest geo bucket. With fencing, if health checking is enabled, as long as some targets in the current geo bucket are healthy, we return only the healthy targets. However, if all targets are unhealthy, we don't failover to the next nearest bucket; instead, we return all the items in the current bucket even when all targets are unhealthy. "items": [ # The primary geo routing configuration. If there are multiple items with the same location, an error is returned instead. { # ResourceRecordSet data for one geo location. - "healthCheckedTargets": { # HealthCheckTargets describes endpoints to health-check when responding to Routing Policy queries. Only the healthy endpoints will be included in the response. Only one of internal_load_balancer and external_endpoints should be set. # For A and AAAA types only. Endpoints to return in the query result only if they are healthy. These can be specified along with rrdata within this item. + "healthCheckedTargets": { # HealthCheckTargets describes endpoints to health-check when responding to Routing Policy queries. Only the healthy endpoints will be included in the response. # For A and AAAA types only. Endpoints to return in the query result only if they are healthy. These can be specified along with `rrdata` within this item. "internalLoadBalancers": [ # Configuration for internal load balancers to be health checked. { # The configuration for an individual load balancer to health check. "ipAddress": "A String", # The frontend IP address of the load balancer to health check. "ipProtocol": "A String", # The protocol of the load balancer to health check. "kind": "dns#rRSetRoutingPolicyLoadBalancerTarget", "loadBalancerType": "A String", # The type of load balancer specified by this target. This value must match the configuration of the load balancer located at the LoadBalancerTarget's IP address, port, and region. Use the following: - *regionalL4ilb*: for a regional internal passthrough Network Load Balancer. - *regionalL7ilb*: for a regional internal Application Load Balancer. - *globalL7ilb*: for a global internal Application Load Balancer. - "networkUrl": "A String", # The fully qualified URL of the network that the load balancer is attached to. This should be formatted like https://www.googleapis.com/compute/v1/projects/{project}/global/networks/{network} . + "networkUrl": "A String", # The fully qualified URL of the network that the load balancer is attached to. This should be formatted like `https://www.googleapis.com/compute/v1/projects/{project}/global/networks/{network}`. "port": "A String", # The configured port of the load balancer. "project": "A String", # The project ID in which the load balancer is located. "region": "A String", # The region in which the load balancer is located. @@ -756,25 +753,25 @@

Method Details

"rrdatas": [ "A String", ], - "signatureRrdatas": [ # DNSSEC generated signatures for all the rrdata within this item. If health checked targets are provided for DNSSEC enabled zones, there's a restriction of 1 IP address per item. + "signatureRrdatas": [ # DNSSEC generated signatures for all the `rrdata` within this item. If health checked targets are provided for DNSSEC enabled zones, there's a restriction of 1 IP address per item. "A String", ], }, ], "kind": "dns#rRSetRoutingPolicyGeoPolicy", }, - "geoPolicy": { # Configures a RRSetRoutingPolicy that routes based on the geo location of the querying user. + "geoPolicy": { # Configures a `RRSetRoutingPolicy` that routes based on the geo location of the querying user. "enableFencing": True or False, # Without fencing, if health check fails for all configured items in the current geo bucket, we failover to the next nearest geo bucket. With fencing, if health checking is enabled, as long as some targets in the current geo bucket are healthy, we return only the healthy targets. However, if all targets are unhealthy, we don't failover to the next nearest bucket; instead, we return all the items in the current bucket even when all targets are unhealthy. "items": [ # The primary geo routing configuration. If there are multiple items with the same location, an error is returned instead. { # ResourceRecordSet data for one geo location. - "healthCheckedTargets": { # HealthCheckTargets describes endpoints to health-check when responding to Routing Policy queries. Only the healthy endpoints will be included in the response. Only one of internal_load_balancer and external_endpoints should be set. # For A and AAAA types only. Endpoints to return in the query result only if they are healthy. These can be specified along with rrdata within this item. + "healthCheckedTargets": { # HealthCheckTargets describes endpoints to health-check when responding to Routing Policy queries. Only the healthy endpoints will be included in the response. # For A and AAAA types only. Endpoints to return in the query result only if they are healthy. These can be specified along with `rrdata` within this item. "internalLoadBalancers": [ # Configuration for internal load balancers to be health checked. { # The configuration for an individual load balancer to health check. "ipAddress": "A String", # The frontend IP address of the load balancer to health check. "ipProtocol": "A String", # The protocol of the load balancer to health check. "kind": "dns#rRSetRoutingPolicyLoadBalancerTarget", "loadBalancerType": "A String", # The type of load balancer specified by this target. This value must match the configuration of the load balancer located at the LoadBalancerTarget's IP address, port, and region. Use the following: - *regionalL4ilb*: for a regional internal passthrough Network Load Balancer. - *regionalL7ilb*: for a regional internal Application Load Balancer. - *globalL7ilb*: for a global internal Application Load Balancer. - "networkUrl": "A String", # The fully qualified URL of the network that the load balancer is attached to. This should be formatted like https://www.googleapis.com/compute/v1/projects/{project}/global/networks/{network} . + "networkUrl": "A String", # The fully qualified URL of the network that the load balancer is attached to. This should be formatted like `https://www.googleapis.com/compute/v1/projects/{project}/global/networks/{network}`. "port": "A String", # The configured port of the load balancer. "project": "A String", # The project ID in which the load balancer is located. "region": "A String", # The region in which the load balancer is located. @@ -786,7 +783,7 @@

Method Details

"rrdatas": [ "A String", ], - "signatureRrdatas": [ # DNSSEC generated signatures for all the rrdata within this item. If health checked targets are provided for DNSSEC enabled zones, there's a restriction of 1 IP address per item. + "signatureRrdatas": [ # DNSSEC generated signatures for all the `rrdata` within this item. If health checked targets are provided for DNSSEC enabled zones, there's a restriction of 1 IP address per item. "A String", ], }, @@ -795,18 +792,18 @@

Method Details

}, "kind": "dns#rRSetRoutingPolicy", "primaryBackup": { # Configures a RRSetRoutingPolicy such that all queries are responded with the primary_targets if they are healthy. And if all of them are unhealthy, then we fallback to a geo localized policy. - "backupGeoTargets": { # Configures a RRSetRoutingPolicy that routes based on the geo location of the querying user. # Backup targets provide a regional failover policy for the otherwise global primary targets. If serving state is set to BACKUP, this policy essentially becomes a geo routing policy. + "backupGeoTargets": { # Configures a `RRSetRoutingPolicy` that routes based on the geo location of the querying user. # Backup targets provide a regional failover policy for the otherwise global primary targets. If serving state is set to `BACKUP`, this policy essentially becomes a geo routing policy. "enableFencing": True or False, # Without fencing, if health check fails for all configured items in the current geo bucket, we failover to the next nearest geo bucket. With fencing, if health checking is enabled, as long as some targets in the current geo bucket are healthy, we return only the healthy targets. However, if all targets are unhealthy, we don't failover to the next nearest bucket; instead, we return all the items in the current bucket even when all targets are unhealthy. "items": [ # The primary geo routing configuration. If there are multiple items with the same location, an error is returned instead. { # ResourceRecordSet data for one geo location. - "healthCheckedTargets": { # HealthCheckTargets describes endpoints to health-check when responding to Routing Policy queries. Only the healthy endpoints will be included in the response. Only one of internal_load_balancer and external_endpoints should be set. # For A and AAAA types only. Endpoints to return in the query result only if they are healthy. These can be specified along with rrdata within this item. + "healthCheckedTargets": { # HealthCheckTargets describes endpoints to health-check when responding to Routing Policy queries. Only the healthy endpoints will be included in the response. # For A and AAAA types only. Endpoints to return in the query result only if they are healthy. These can be specified along with `rrdata` within this item. "internalLoadBalancers": [ # Configuration for internal load balancers to be health checked. { # The configuration for an individual load balancer to health check. "ipAddress": "A String", # The frontend IP address of the load balancer to health check. "ipProtocol": "A String", # The protocol of the load balancer to health check. "kind": "dns#rRSetRoutingPolicyLoadBalancerTarget", "loadBalancerType": "A String", # The type of load balancer specified by this target. This value must match the configuration of the load balancer located at the LoadBalancerTarget's IP address, port, and region. Use the following: - *regionalL4ilb*: for a regional internal passthrough Network Load Balancer. - *regionalL7ilb*: for a regional internal Application Load Balancer. - *globalL7ilb*: for a global internal Application Load Balancer. - "networkUrl": "A String", # The fully qualified URL of the network that the load balancer is attached to. This should be formatted like https://www.googleapis.com/compute/v1/projects/{project}/global/networks/{network} . + "networkUrl": "A String", # The fully qualified URL of the network that the load balancer is attached to. This should be formatted like `https://www.googleapis.com/compute/v1/projects/{project}/global/networks/{network}`. "port": "A String", # The configured port of the load balancer. "project": "A String", # The project ID in which the load balancer is located. "region": "A String", # The region in which the load balancer is located. @@ -818,7 +815,7 @@

Method Details

"rrdatas": [ "A String", ], - "signatureRrdatas": [ # DNSSEC generated signatures for all the rrdata within this item. If health checked targets are provided for DNSSEC enabled zones, there's a restriction of 1 IP address per item. + "signatureRrdatas": [ # DNSSEC generated signatures for all the `rrdata` within this item. If health checked targets are provided for DNSSEC enabled zones, there's a restriction of 1 IP address per item. "A String", ], }, @@ -826,33 +823,33 @@

Method Details

"kind": "dns#rRSetRoutingPolicyGeoPolicy", }, "kind": "dns#rRSetRoutingPolicyPrimaryBackupPolicy", - "primaryTargets": { # HealthCheckTargets describes endpoints to health-check when responding to Routing Policy queries. Only the healthy endpoints will be included in the response. Only one of internal_load_balancer and external_endpoints should be set. # Endpoints that are health checked before making the routing decision. Unhealthy endpoints are omitted from the results. If all endpoints are unhealthy, we serve a response based on the backup_geo_targets. + "primaryTargets": { # HealthCheckTargets describes endpoints to health-check when responding to Routing Policy queries. Only the healthy endpoints will be included in the response. # Endpoints that are health checked before making the routing decision. Unhealthy endpoints are omitted from the results. If all endpoints are unhealthy, we serve a response based on the `backup_geo_targets`. "internalLoadBalancers": [ # Configuration for internal load balancers to be health checked. { # The configuration for an individual load balancer to health check. "ipAddress": "A String", # The frontend IP address of the load balancer to health check. "ipProtocol": "A String", # The protocol of the load balancer to health check. "kind": "dns#rRSetRoutingPolicyLoadBalancerTarget", "loadBalancerType": "A String", # The type of load balancer specified by this target. This value must match the configuration of the load balancer located at the LoadBalancerTarget's IP address, port, and region. Use the following: - *regionalL4ilb*: for a regional internal passthrough Network Load Balancer. - *regionalL7ilb*: for a regional internal Application Load Balancer. - *globalL7ilb*: for a global internal Application Load Balancer. - "networkUrl": "A String", # The fully qualified URL of the network that the load balancer is attached to. This should be formatted like https://www.googleapis.com/compute/v1/projects/{project}/global/networks/{network} . + "networkUrl": "A String", # The fully qualified URL of the network that the load balancer is attached to. This should be formatted like `https://www.googleapis.com/compute/v1/projects/{project}/global/networks/{network}`. "port": "A String", # The configured port of the load balancer. "project": "A String", # The project ID in which the load balancer is located. "region": "A String", # The region in which the load balancer is located. }, ], }, - "trickleTraffic": 3.14, # When serving state is PRIMARY, this field provides the option of sending a small percentage of the traffic to the backup targets. + "trickleTraffic": 3.14, # When serving state is `PRIMARY`, this field provides the option of sending a small percentage of the traffic to the backup targets. }, "wrr": { # Configures a RRSetRoutingPolicy that routes in a weighted round robin fashion. "items": [ { # A routing block which contains the routing information for one WRR item. - "healthCheckedTargets": { # HealthCheckTargets describes endpoints to health-check when responding to Routing Policy queries. Only the healthy endpoints will be included in the response. Only one of internal_load_balancer and external_endpoints should be set. # Endpoints that are health checked before making the routing decision. The unhealthy endpoints are omitted from the result. If all endpoints within a bucket are unhealthy, we choose a different bucket (sampled with respect to its weight) for responding. If DNSSEC is enabled for this zone, only one of rrdata or health_checked_targets can be set. + "healthCheckedTargets": { # HealthCheckTargets describes endpoints to health-check when responding to Routing Policy queries. Only the healthy endpoints will be included in the response. # Endpoints that are health checked before making the routing decision. The unhealthy endpoints are omitted from the result. If all endpoints within a bucket are unhealthy, we choose a different bucket (sampled with respect to its weight) for responding. If DNSSEC is enabled for this zone, only one of `rrdata` or `health_checked_targets` can be set. "internalLoadBalancers": [ # Configuration for internal load balancers to be health checked. { # The configuration for an individual load balancer to health check. "ipAddress": "A String", # The frontend IP address of the load balancer to health check. "ipProtocol": "A String", # The protocol of the load balancer to health check. "kind": "dns#rRSetRoutingPolicyLoadBalancerTarget", "loadBalancerType": "A String", # The type of load balancer specified by this target. This value must match the configuration of the load balancer located at the LoadBalancerTarget's IP address, port, and region. Use the following: - *regionalL4ilb*: for a regional internal passthrough Network Load Balancer. - *regionalL7ilb*: for a regional internal Application Load Balancer. - *globalL7ilb*: for a global internal Application Load Balancer. - "networkUrl": "A String", # The fully qualified URL of the network that the load balancer is attached to. This should be formatted like https://www.googleapis.com/compute/v1/projects/{project}/global/networks/{network} . + "networkUrl": "A String", # The fully qualified URL of the network that the load balancer is attached to. This should be formatted like `https://www.googleapis.com/compute/v1/projects/{project}/global/networks/{network}`. "port": "A String", # The configured port of the load balancer. "project": "A String", # The project ID in which the load balancer is located. "region": "A String", # The region in which the load balancer is located. @@ -863,10 +860,10 @@

Method Details

"rrdatas": [ "A String", ], - "signatureRrdatas": [ # DNSSEC generated signatures for all the rrdata within this item. Note that if health checked targets are provided for DNSSEC enabled zones, there's a restriction of 1 IP address per item. + "signatureRrdatas": [ # DNSSEC generated signatures for all the `rrdata` within this item. Note that if health checked targets are provided for DNSSEC enabled zones, there's a restriction of 1 IP address per item. "A String", ], - "weight": 3.14, # The weight corresponding to this WrrPolicyItem object. When multiple WrrPolicyItem objects are configured, the probability of returning an WrrPolicyItem object's data is proportional to its weight relative to the sum of weights configured for all items. This weight must be non-negative. + "weight": 3.14, # The weight corresponding to this `WrrPolicyItem` object. When multiple `WrrPolicyItem` objects are configured, the probability of returning an `WrrPolicyItem` object's data is proportional to its weight relative to the sum of weights configured for all items. This weight must be non-negative. }, ], "kind": "dns#rRSetRoutingPolicyWrrPolicy", @@ -874,14 +871,14 @@

Method Details

"wrrPolicy": { # Configures a RRSetRoutingPolicy that routes in a weighted round robin fashion. "items": [ { # A routing block which contains the routing information for one WRR item. - "healthCheckedTargets": { # HealthCheckTargets describes endpoints to health-check when responding to Routing Policy queries. Only the healthy endpoints will be included in the response. Only one of internal_load_balancer and external_endpoints should be set. # Endpoints that are health checked before making the routing decision. The unhealthy endpoints are omitted from the result. If all endpoints within a bucket are unhealthy, we choose a different bucket (sampled with respect to its weight) for responding. If DNSSEC is enabled for this zone, only one of rrdata or health_checked_targets can be set. + "healthCheckedTargets": { # HealthCheckTargets describes endpoints to health-check when responding to Routing Policy queries. Only the healthy endpoints will be included in the response. # Endpoints that are health checked before making the routing decision. The unhealthy endpoints are omitted from the result. If all endpoints within a bucket are unhealthy, we choose a different bucket (sampled with respect to its weight) for responding. If DNSSEC is enabled for this zone, only one of `rrdata` or `health_checked_targets` can be set. "internalLoadBalancers": [ # Configuration for internal load balancers to be health checked. { # The configuration for an individual load balancer to health check. "ipAddress": "A String", # The frontend IP address of the load balancer to health check. "ipProtocol": "A String", # The protocol of the load balancer to health check. "kind": "dns#rRSetRoutingPolicyLoadBalancerTarget", "loadBalancerType": "A String", # The type of load balancer specified by this target. This value must match the configuration of the load balancer located at the LoadBalancerTarget's IP address, port, and region. Use the following: - *regionalL4ilb*: for a regional internal passthrough Network Load Balancer. - *regionalL7ilb*: for a regional internal Application Load Balancer. - *globalL7ilb*: for a global internal Application Load Balancer. - "networkUrl": "A String", # The fully qualified URL of the network that the load balancer is attached to. This should be formatted like https://www.googleapis.com/compute/v1/projects/{project}/global/networks/{network} . + "networkUrl": "A String", # The fully qualified URL of the network that the load balancer is attached to. This should be formatted like `https://www.googleapis.com/compute/v1/projects/{project}/global/networks/{network}`. "port": "A String", # The configured port of the load balancer. "project": "A String", # The project ID in which the load balancer is located. "region": "A String", # The region in which the load balancer is located. @@ -892,10 +889,10 @@

Method Details

"rrdatas": [ "A String", ], - "signatureRrdatas": [ # DNSSEC generated signatures for all the rrdata within this item. Note that if health checked targets are provided for DNSSEC enabled zones, there's a restriction of 1 IP address per item. + "signatureRrdatas": [ # DNSSEC generated signatures for all the `rrdata` within this item. Note that if health checked targets are provided for DNSSEC enabled zones, there's a restriction of 1 IP address per item. "A String", ], - "weight": 3.14, # The weight corresponding to this WrrPolicyItem object. When multiple WrrPolicyItem objects are configured, the probability of returning an WrrPolicyItem object's data is proportional to its weight relative to the sum of weights configured for all items. This weight must be non-negative. + "weight": 3.14, # The weight corresponding to this `WrrPolicyItem` object. When multiple `WrrPolicyItem` objects are configured, the probability of returning an `WrrPolicyItem` object's data is proportional to its weight relative to the sum of weights configured for all items. This weight must be non-negative. }, ], "kind": "dns#rRSetRoutingPolicyWrrPolicy", @@ -907,7 +904,7 @@

Method Details

"signatureRrdatas": [ # As defined in RFC 4034 (section 3.2). "A String", ], - "ttl": 42, # Number of seconds that this ResourceRecordSet can be cached by resolvers. + "ttl": 42, # Number of seconds that this `ResourceRecordSet` can be cached by resolvers. "type": "A String", # The identifier of a supported record type. See the list of Supported DNS record types. }, ], @@ -943,19 +940,19 @@

Method Details

{ # A unit of data that is returned by the DNS servers. "kind": "dns#resourceRecordSet", "name": "A String", # For example, www.example.com. - "routingPolicy": { # A RRSetRoutingPolicy represents ResourceRecordSet data that is returned dynamically with the response varying based on configured properties such as geolocation or by weighted random selection. # Configures dynamic query responses based on either the geo location of the querying user or a weighted round robin based routing policy. A valid ResourceRecordSet contains only rrdata (for static resolution) or a routing_policy (for dynamic resolution). - "geo": { # Configures a RRSetRoutingPolicy that routes based on the geo location of the querying user. + "routingPolicy": { # A RRSetRoutingPolicy represents ResourceRecordSet data that is returned dynamically with the response varying based on configured properties such as geolocation or by weighted random selection. # Configures dynamic query responses based on either the geo location of the querying user or a weighted round robin based routing policy. A valid `ResourceRecordSet` contains only `rrdata` (for static resolution) or a `routing_policy` (for dynamic resolution). + "geo": { # Configures a `RRSetRoutingPolicy` that routes based on the geo location of the querying user. "enableFencing": True or False, # Without fencing, if health check fails for all configured items in the current geo bucket, we failover to the next nearest geo bucket. With fencing, if health checking is enabled, as long as some targets in the current geo bucket are healthy, we return only the healthy targets. However, if all targets are unhealthy, we don't failover to the next nearest bucket; instead, we return all the items in the current bucket even when all targets are unhealthy. "items": [ # The primary geo routing configuration. If there are multiple items with the same location, an error is returned instead. { # ResourceRecordSet data for one geo location. - "healthCheckedTargets": { # HealthCheckTargets describes endpoints to health-check when responding to Routing Policy queries. Only the healthy endpoints will be included in the response. Only one of internal_load_balancer and external_endpoints should be set. # For A and AAAA types only. Endpoints to return in the query result only if they are healthy. These can be specified along with rrdata within this item. + "healthCheckedTargets": { # HealthCheckTargets describes endpoints to health-check when responding to Routing Policy queries. Only the healthy endpoints will be included in the response. # For A and AAAA types only. Endpoints to return in the query result only if they are healthy. These can be specified along with `rrdata` within this item. "internalLoadBalancers": [ # Configuration for internal load balancers to be health checked. { # The configuration for an individual load balancer to health check. "ipAddress": "A String", # The frontend IP address of the load balancer to health check. "ipProtocol": "A String", # The protocol of the load balancer to health check. "kind": "dns#rRSetRoutingPolicyLoadBalancerTarget", "loadBalancerType": "A String", # The type of load balancer specified by this target. This value must match the configuration of the load balancer located at the LoadBalancerTarget's IP address, port, and region. Use the following: - *regionalL4ilb*: for a regional internal passthrough Network Load Balancer. - *regionalL7ilb*: for a regional internal Application Load Balancer. - *globalL7ilb*: for a global internal Application Load Balancer. - "networkUrl": "A String", # The fully qualified URL of the network that the load balancer is attached to. This should be formatted like https://www.googleapis.com/compute/v1/projects/{project}/global/networks/{network} . + "networkUrl": "A String", # The fully qualified URL of the network that the load balancer is attached to. This should be formatted like `https://www.googleapis.com/compute/v1/projects/{project}/global/networks/{network}`. "port": "A String", # The configured port of the load balancer. "project": "A String", # The project ID in which the load balancer is located. "region": "A String", # The region in which the load balancer is located. @@ -967,25 +964,25 @@

Method Details

"rrdatas": [ "A String", ], - "signatureRrdatas": [ # DNSSEC generated signatures for all the rrdata within this item. If health checked targets are provided for DNSSEC enabled zones, there's a restriction of 1 IP address per item. + "signatureRrdatas": [ # DNSSEC generated signatures for all the `rrdata` within this item. If health checked targets are provided for DNSSEC enabled zones, there's a restriction of 1 IP address per item. "A String", ], }, ], "kind": "dns#rRSetRoutingPolicyGeoPolicy", }, - "geoPolicy": { # Configures a RRSetRoutingPolicy that routes based on the geo location of the querying user. + "geoPolicy": { # Configures a `RRSetRoutingPolicy` that routes based on the geo location of the querying user. "enableFencing": True or False, # Without fencing, if health check fails for all configured items in the current geo bucket, we failover to the next nearest geo bucket. With fencing, if health checking is enabled, as long as some targets in the current geo bucket are healthy, we return only the healthy targets. However, if all targets are unhealthy, we don't failover to the next nearest bucket; instead, we return all the items in the current bucket even when all targets are unhealthy. "items": [ # The primary geo routing configuration. If there are multiple items with the same location, an error is returned instead. { # ResourceRecordSet data for one geo location. - "healthCheckedTargets": { # HealthCheckTargets describes endpoints to health-check when responding to Routing Policy queries. Only the healthy endpoints will be included in the response. Only one of internal_load_balancer and external_endpoints should be set. # For A and AAAA types only. Endpoints to return in the query result only if they are healthy. These can be specified along with rrdata within this item. + "healthCheckedTargets": { # HealthCheckTargets describes endpoints to health-check when responding to Routing Policy queries. Only the healthy endpoints will be included in the response. # For A and AAAA types only. Endpoints to return in the query result only if they are healthy. These can be specified along with `rrdata` within this item. "internalLoadBalancers": [ # Configuration for internal load balancers to be health checked. { # The configuration for an individual load balancer to health check. "ipAddress": "A String", # The frontend IP address of the load balancer to health check. "ipProtocol": "A String", # The protocol of the load balancer to health check. "kind": "dns#rRSetRoutingPolicyLoadBalancerTarget", "loadBalancerType": "A String", # The type of load balancer specified by this target. This value must match the configuration of the load balancer located at the LoadBalancerTarget's IP address, port, and region. Use the following: - *regionalL4ilb*: for a regional internal passthrough Network Load Balancer. - *regionalL7ilb*: for a regional internal Application Load Balancer. - *globalL7ilb*: for a global internal Application Load Balancer. - "networkUrl": "A String", # The fully qualified URL of the network that the load balancer is attached to. This should be formatted like https://www.googleapis.com/compute/v1/projects/{project}/global/networks/{network} . + "networkUrl": "A String", # The fully qualified URL of the network that the load balancer is attached to. This should be formatted like `https://www.googleapis.com/compute/v1/projects/{project}/global/networks/{network}`. "port": "A String", # The configured port of the load balancer. "project": "A String", # The project ID in which the load balancer is located. "region": "A String", # The region in which the load balancer is located. @@ -997,7 +994,7 @@

Method Details

"rrdatas": [ "A String", ], - "signatureRrdatas": [ # DNSSEC generated signatures for all the rrdata within this item. If health checked targets are provided for DNSSEC enabled zones, there's a restriction of 1 IP address per item. + "signatureRrdatas": [ # DNSSEC generated signatures for all the `rrdata` within this item. If health checked targets are provided for DNSSEC enabled zones, there's a restriction of 1 IP address per item. "A String", ], }, @@ -1006,18 +1003,18 @@

Method Details

}, "kind": "dns#rRSetRoutingPolicy", "primaryBackup": { # Configures a RRSetRoutingPolicy such that all queries are responded with the primary_targets if they are healthy. And if all of them are unhealthy, then we fallback to a geo localized policy. - "backupGeoTargets": { # Configures a RRSetRoutingPolicy that routes based on the geo location of the querying user. # Backup targets provide a regional failover policy for the otherwise global primary targets. If serving state is set to BACKUP, this policy essentially becomes a geo routing policy. + "backupGeoTargets": { # Configures a `RRSetRoutingPolicy` that routes based on the geo location of the querying user. # Backup targets provide a regional failover policy for the otherwise global primary targets. If serving state is set to `BACKUP`, this policy essentially becomes a geo routing policy. "enableFencing": True or False, # Without fencing, if health check fails for all configured items in the current geo bucket, we failover to the next nearest geo bucket. With fencing, if health checking is enabled, as long as some targets in the current geo bucket are healthy, we return only the healthy targets. However, if all targets are unhealthy, we don't failover to the next nearest bucket; instead, we return all the items in the current bucket even when all targets are unhealthy. "items": [ # The primary geo routing configuration. If there are multiple items with the same location, an error is returned instead. { # ResourceRecordSet data for one geo location. - "healthCheckedTargets": { # HealthCheckTargets describes endpoints to health-check when responding to Routing Policy queries. Only the healthy endpoints will be included in the response. Only one of internal_load_balancer and external_endpoints should be set. # For A and AAAA types only. Endpoints to return in the query result only if they are healthy. These can be specified along with rrdata within this item. + "healthCheckedTargets": { # HealthCheckTargets describes endpoints to health-check when responding to Routing Policy queries. Only the healthy endpoints will be included in the response. # For A and AAAA types only. Endpoints to return in the query result only if they are healthy. These can be specified along with `rrdata` within this item. "internalLoadBalancers": [ # Configuration for internal load balancers to be health checked. { # The configuration for an individual load balancer to health check. "ipAddress": "A String", # The frontend IP address of the load balancer to health check. "ipProtocol": "A String", # The protocol of the load balancer to health check. "kind": "dns#rRSetRoutingPolicyLoadBalancerTarget", "loadBalancerType": "A String", # The type of load balancer specified by this target. This value must match the configuration of the load balancer located at the LoadBalancerTarget's IP address, port, and region. Use the following: - *regionalL4ilb*: for a regional internal passthrough Network Load Balancer. - *regionalL7ilb*: for a regional internal Application Load Balancer. - *globalL7ilb*: for a global internal Application Load Balancer. - "networkUrl": "A String", # The fully qualified URL of the network that the load balancer is attached to. This should be formatted like https://www.googleapis.com/compute/v1/projects/{project}/global/networks/{network} . + "networkUrl": "A String", # The fully qualified URL of the network that the load balancer is attached to. This should be formatted like `https://www.googleapis.com/compute/v1/projects/{project}/global/networks/{network}`. "port": "A String", # The configured port of the load balancer. "project": "A String", # The project ID in which the load balancer is located. "region": "A String", # The region in which the load balancer is located. @@ -1029,7 +1026,7 @@

Method Details

"rrdatas": [ "A String", ], - "signatureRrdatas": [ # DNSSEC generated signatures for all the rrdata within this item. If health checked targets are provided for DNSSEC enabled zones, there's a restriction of 1 IP address per item. + "signatureRrdatas": [ # DNSSEC generated signatures for all the `rrdata` within this item. If health checked targets are provided for DNSSEC enabled zones, there's a restriction of 1 IP address per item. "A String", ], }, @@ -1037,33 +1034,33 @@

Method Details

"kind": "dns#rRSetRoutingPolicyGeoPolicy", }, "kind": "dns#rRSetRoutingPolicyPrimaryBackupPolicy", - "primaryTargets": { # HealthCheckTargets describes endpoints to health-check when responding to Routing Policy queries. Only the healthy endpoints will be included in the response. Only one of internal_load_balancer and external_endpoints should be set. # Endpoints that are health checked before making the routing decision. Unhealthy endpoints are omitted from the results. If all endpoints are unhealthy, we serve a response based on the backup_geo_targets. + "primaryTargets": { # HealthCheckTargets describes endpoints to health-check when responding to Routing Policy queries. Only the healthy endpoints will be included in the response. # Endpoints that are health checked before making the routing decision. Unhealthy endpoints are omitted from the results. If all endpoints are unhealthy, we serve a response based on the `backup_geo_targets`. "internalLoadBalancers": [ # Configuration for internal load balancers to be health checked. { # The configuration for an individual load balancer to health check. "ipAddress": "A String", # The frontend IP address of the load balancer to health check. "ipProtocol": "A String", # The protocol of the load balancer to health check. "kind": "dns#rRSetRoutingPolicyLoadBalancerTarget", "loadBalancerType": "A String", # The type of load balancer specified by this target. This value must match the configuration of the load balancer located at the LoadBalancerTarget's IP address, port, and region. Use the following: - *regionalL4ilb*: for a regional internal passthrough Network Load Balancer. - *regionalL7ilb*: for a regional internal Application Load Balancer. - *globalL7ilb*: for a global internal Application Load Balancer. - "networkUrl": "A String", # The fully qualified URL of the network that the load balancer is attached to. This should be formatted like https://www.googleapis.com/compute/v1/projects/{project}/global/networks/{network} . + "networkUrl": "A String", # The fully qualified URL of the network that the load balancer is attached to. This should be formatted like `https://www.googleapis.com/compute/v1/projects/{project}/global/networks/{network}`. "port": "A String", # The configured port of the load balancer. "project": "A String", # The project ID in which the load balancer is located. "region": "A String", # The region in which the load balancer is located. }, ], }, - "trickleTraffic": 3.14, # When serving state is PRIMARY, this field provides the option of sending a small percentage of the traffic to the backup targets. + "trickleTraffic": 3.14, # When serving state is `PRIMARY`, this field provides the option of sending a small percentage of the traffic to the backup targets. }, "wrr": { # Configures a RRSetRoutingPolicy that routes in a weighted round robin fashion. "items": [ { # A routing block which contains the routing information for one WRR item. - "healthCheckedTargets": { # HealthCheckTargets describes endpoints to health-check when responding to Routing Policy queries. Only the healthy endpoints will be included in the response. Only one of internal_load_balancer and external_endpoints should be set. # Endpoints that are health checked before making the routing decision. The unhealthy endpoints are omitted from the result. If all endpoints within a bucket are unhealthy, we choose a different bucket (sampled with respect to its weight) for responding. If DNSSEC is enabled for this zone, only one of rrdata or health_checked_targets can be set. + "healthCheckedTargets": { # HealthCheckTargets describes endpoints to health-check when responding to Routing Policy queries. Only the healthy endpoints will be included in the response. # Endpoints that are health checked before making the routing decision. The unhealthy endpoints are omitted from the result. If all endpoints within a bucket are unhealthy, we choose a different bucket (sampled with respect to its weight) for responding. If DNSSEC is enabled for this zone, only one of `rrdata` or `health_checked_targets` can be set. "internalLoadBalancers": [ # Configuration for internal load balancers to be health checked. { # The configuration for an individual load balancer to health check. "ipAddress": "A String", # The frontend IP address of the load balancer to health check. "ipProtocol": "A String", # The protocol of the load balancer to health check. "kind": "dns#rRSetRoutingPolicyLoadBalancerTarget", "loadBalancerType": "A String", # The type of load balancer specified by this target. This value must match the configuration of the load balancer located at the LoadBalancerTarget's IP address, port, and region. Use the following: - *regionalL4ilb*: for a regional internal passthrough Network Load Balancer. - *regionalL7ilb*: for a regional internal Application Load Balancer. - *globalL7ilb*: for a global internal Application Load Balancer. - "networkUrl": "A String", # The fully qualified URL of the network that the load balancer is attached to. This should be formatted like https://www.googleapis.com/compute/v1/projects/{project}/global/networks/{network} . + "networkUrl": "A String", # The fully qualified URL of the network that the load balancer is attached to. This should be formatted like `https://www.googleapis.com/compute/v1/projects/{project}/global/networks/{network}`. "port": "A String", # The configured port of the load balancer. "project": "A String", # The project ID in which the load balancer is located. "region": "A String", # The region in which the load balancer is located. @@ -1074,10 +1071,10 @@

Method Details

"rrdatas": [ "A String", ], - "signatureRrdatas": [ # DNSSEC generated signatures for all the rrdata within this item. Note that if health checked targets are provided for DNSSEC enabled zones, there's a restriction of 1 IP address per item. + "signatureRrdatas": [ # DNSSEC generated signatures for all the `rrdata` within this item. Note that if health checked targets are provided for DNSSEC enabled zones, there's a restriction of 1 IP address per item. "A String", ], - "weight": 3.14, # The weight corresponding to this WrrPolicyItem object. When multiple WrrPolicyItem objects are configured, the probability of returning an WrrPolicyItem object's data is proportional to its weight relative to the sum of weights configured for all items. This weight must be non-negative. + "weight": 3.14, # The weight corresponding to this `WrrPolicyItem` object. When multiple `WrrPolicyItem` objects are configured, the probability of returning an `WrrPolicyItem` object's data is proportional to its weight relative to the sum of weights configured for all items. This weight must be non-negative. }, ], "kind": "dns#rRSetRoutingPolicyWrrPolicy", @@ -1085,14 +1082,14 @@

Method Details

"wrrPolicy": { # Configures a RRSetRoutingPolicy that routes in a weighted round robin fashion. "items": [ { # A routing block which contains the routing information for one WRR item. - "healthCheckedTargets": { # HealthCheckTargets describes endpoints to health-check when responding to Routing Policy queries. Only the healthy endpoints will be included in the response. Only one of internal_load_balancer and external_endpoints should be set. # Endpoints that are health checked before making the routing decision. The unhealthy endpoints are omitted from the result. If all endpoints within a bucket are unhealthy, we choose a different bucket (sampled with respect to its weight) for responding. If DNSSEC is enabled for this zone, only one of rrdata or health_checked_targets can be set. + "healthCheckedTargets": { # HealthCheckTargets describes endpoints to health-check when responding to Routing Policy queries. Only the healthy endpoints will be included in the response. # Endpoints that are health checked before making the routing decision. The unhealthy endpoints are omitted from the result. If all endpoints within a bucket are unhealthy, we choose a different bucket (sampled with respect to its weight) for responding. If DNSSEC is enabled for this zone, only one of `rrdata` or `health_checked_targets` can be set. "internalLoadBalancers": [ # Configuration for internal load balancers to be health checked. { # The configuration for an individual load balancer to health check. "ipAddress": "A String", # The frontend IP address of the load balancer to health check. "ipProtocol": "A String", # The protocol of the load balancer to health check. "kind": "dns#rRSetRoutingPolicyLoadBalancerTarget", "loadBalancerType": "A String", # The type of load balancer specified by this target. This value must match the configuration of the load balancer located at the LoadBalancerTarget's IP address, port, and region. Use the following: - *regionalL4ilb*: for a regional internal passthrough Network Load Balancer. - *regionalL7ilb*: for a regional internal Application Load Balancer. - *globalL7ilb*: for a global internal Application Load Balancer. - "networkUrl": "A String", # The fully qualified URL of the network that the load balancer is attached to. This should be formatted like https://www.googleapis.com/compute/v1/projects/{project}/global/networks/{network} . + "networkUrl": "A String", # The fully qualified URL of the network that the load balancer is attached to. This should be formatted like `https://www.googleapis.com/compute/v1/projects/{project}/global/networks/{network}`. "port": "A String", # The configured port of the load balancer. "project": "A String", # The project ID in which the load balancer is located. "region": "A String", # The region in which the load balancer is located. @@ -1103,10 +1100,10 @@

Method Details

"rrdatas": [ "A String", ], - "signatureRrdatas": [ # DNSSEC generated signatures for all the rrdata within this item. Note that if health checked targets are provided for DNSSEC enabled zones, there's a restriction of 1 IP address per item. + "signatureRrdatas": [ # DNSSEC generated signatures for all the `rrdata` within this item. Note that if health checked targets are provided for DNSSEC enabled zones, there's a restriction of 1 IP address per item. "A String", ], - "weight": 3.14, # The weight corresponding to this WrrPolicyItem object. When multiple WrrPolicyItem objects are configured, the probability of returning an WrrPolicyItem object's data is proportional to its weight relative to the sum of weights configured for all items. This weight must be non-negative. + "weight": 3.14, # The weight corresponding to this `WrrPolicyItem` object. When multiple `WrrPolicyItem` objects are configured, the probability of returning an `WrrPolicyItem` object's data is proportional to its weight relative to the sum of weights configured for all items. This weight must be non-negative. }, ], "kind": "dns#rRSetRoutingPolicyWrrPolicy", @@ -1118,7 +1115,7 @@

Method Details

"signatureRrdatas": [ # As defined in RFC 4034 (section 3.2). "A String", ], - "ttl": 42, # Number of seconds that this ResourceRecordSet can be cached by resolvers. + "ttl": 42, # Number of seconds that this `ResourceRecordSet` can be cached by resolvers. "type": "A String", # The identifier of a supported record type. See the list of Supported DNS record types. } @@ -1134,19 +1131,19 @@

Method Details

{ # A unit of data that is returned by the DNS servers. "kind": "dns#resourceRecordSet", "name": "A String", # For example, www.example.com. - "routingPolicy": { # A RRSetRoutingPolicy represents ResourceRecordSet data that is returned dynamically with the response varying based on configured properties such as geolocation or by weighted random selection. # Configures dynamic query responses based on either the geo location of the querying user or a weighted round robin based routing policy. A valid ResourceRecordSet contains only rrdata (for static resolution) or a routing_policy (for dynamic resolution). - "geo": { # Configures a RRSetRoutingPolicy that routes based on the geo location of the querying user. + "routingPolicy": { # A RRSetRoutingPolicy represents ResourceRecordSet data that is returned dynamically with the response varying based on configured properties such as geolocation or by weighted random selection. # Configures dynamic query responses based on either the geo location of the querying user or a weighted round robin based routing policy. A valid `ResourceRecordSet` contains only `rrdata` (for static resolution) or a `routing_policy` (for dynamic resolution). + "geo": { # Configures a `RRSetRoutingPolicy` that routes based on the geo location of the querying user. "enableFencing": True or False, # Without fencing, if health check fails for all configured items in the current geo bucket, we failover to the next nearest geo bucket. With fencing, if health checking is enabled, as long as some targets in the current geo bucket are healthy, we return only the healthy targets. However, if all targets are unhealthy, we don't failover to the next nearest bucket; instead, we return all the items in the current bucket even when all targets are unhealthy. "items": [ # The primary geo routing configuration. If there are multiple items with the same location, an error is returned instead. { # ResourceRecordSet data for one geo location. - "healthCheckedTargets": { # HealthCheckTargets describes endpoints to health-check when responding to Routing Policy queries. Only the healthy endpoints will be included in the response. Only one of internal_load_balancer and external_endpoints should be set. # For A and AAAA types only. Endpoints to return in the query result only if they are healthy. These can be specified along with rrdata within this item. + "healthCheckedTargets": { # HealthCheckTargets describes endpoints to health-check when responding to Routing Policy queries. Only the healthy endpoints will be included in the response. # For A and AAAA types only. Endpoints to return in the query result only if they are healthy. These can be specified along with `rrdata` within this item. "internalLoadBalancers": [ # Configuration for internal load balancers to be health checked. { # The configuration for an individual load balancer to health check. "ipAddress": "A String", # The frontend IP address of the load balancer to health check. "ipProtocol": "A String", # The protocol of the load balancer to health check. "kind": "dns#rRSetRoutingPolicyLoadBalancerTarget", "loadBalancerType": "A String", # The type of load balancer specified by this target. This value must match the configuration of the load balancer located at the LoadBalancerTarget's IP address, port, and region. Use the following: - *regionalL4ilb*: for a regional internal passthrough Network Load Balancer. - *regionalL7ilb*: for a regional internal Application Load Balancer. - *globalL7ilb*: for a global internal Application Load Balancer. - "networkUrl": "A String", # The fully qualified URL of the network that the load balancer is attached to. This should be formatted like https://www.googleapis.com/compute/v1/projects/{project}/global/networks/{network} . + "networkUrl": "A String", # The fully qualified URL of the network that the load balancer is attached to. This should be formatted like `https://www.googleapis.com/compute/v1/projects/{project}/global/networks/{network}`. "port": "A String", # The configured port of the load balancer. "project": "A String", # The project ID in which the load balancer is located. "region": "A String", # The region in which the load balancer is located. @@ -1158,25 +1155,25 @@

Method Details

"rrdatas": [ "A String", ], - "signatureRrdatas": [ # DNSSEC generated signatures for all the rrdata within this item. If health checked targets are provided for DNSSEC enabled zones, there's a restriction of 1 IP address per item. + "signatureRrdatas": [ # DNSSEC generated signatures for all the `rrdata` within this item. If health checked targets are provided for DNSSEC enabled zones, there's a restriction of 1 IP address per item. "A String", ], }, ], "kind": "dns#rRSetRoutingPolicyGeoPolicy", }, - "geoPolicy": { # Configures a RRSetRoutingPolicy that routes based on the geo location of the querying user. + "geoPolicy": { # Configures a `RRSetRoutingPolicy` that routes based on the geo location of the querying user. "enableFencing": True or False, # Without fencing, if health check fails for all configured items in the current geo bucket, we failover to the next nearest geo bucket. With fencing, if health checking is enabled, as long as some targets in the current geo bucket are healthy, we return only the healthy targets. However, if all targets are unhealthy, we don't failover to the next nearest bucket; instead, we return all the items in the current bucket even when all targets are unhealthy. "items": [ # The primary geo routing configuration. If there are multiple items with the same location, an error is returned instead. { # ResourceRecordSet data for one geo location. - "healthCheckedTargets": { # HealthCheckTargets describes endpoints to health-check when responding to Routing Policy queries. Only the healthy endpoints will be included in the response. Only one of internal_load_balancer and external_endpoints should be set. # For A and AAAA types only. Endpoints to return in the query result only if they are healthy. These can be specified along with rrdata within this item. + "healthCheckedTargets": { # HealthCheckTargets describes endpoints to health-check when responding to Routing Policy queries. Only the healthy endpoints will be included in the response. # For A and AAAA types only. Endpoints to return in the query result only if they are healthy. These can be specified along with `rrdata` within this item. "internalLoadBalancers": [ # Configuration for internal load balancers to be health checked. { # The configuration for an individual load balancer to health check. "ipAddress": "A String", # The frontend IP address of the load balancer to health check. "ipProtocol": "A String", # The protocol of the load balancer to health check. "kind": "dns#rRSetRoutingPolicyLoadBalancerTarget", "loadBalancerType": "A String", # The type of load balancer specified by this target. This value must match the configuration of the load balancer located at the LoadBalancerTarget's IP address, port, and region. Use the following: - *regionalL4ilb*: for a regional internal passthrough Network Load Balancer. - *regionalL7ilb*: for a regional internal Application Load Balancer. - *globalL7ilb*: for a global internal Application Load Balancer. - "networkUrl": "A String", # The fully qualified URL of the network that the load balancer is attached to. This should be formatted like https://www.googleapis.com/compute/v1/projects/{project}/global/networks/{network} . + "networkUrl": "A String", # The fully qualified URL of the network that the load balancer is attached to. This should be formatted like `https://www.googleapis.com/compute/v1/projects/{project}/global/networks/{network}`. "port": "A String", # The configured port of the load balancer. "project": "A String", # The project ID in which the load balancer is located. "region": "A String", # The region in which the load balancer is located. @@ -1188,7 +1185,7 @@

Method Details

"rrdatas": [ "A String", ], - "signatureRrdatas": [ # DNSSEC generated signatures for all the rrdata within this item. If health checked targets are provided for DNSSEC enabled zones, there's a restriction of 1 IP address per item. + "signatureRrdatas": [ # DNSSEC generated signatures for all the `rrdata` within this item. If health checked targets are provided for DNSSEC enabled zones, there's a restriction of 1 IP address per item. "A String", ], }, @@ -1197,18 +1194,18 @@

Method Details

}, "kind": "dns#rRSetRoutingPolicy", "primaryBackup": { # Configures a RRSetRoutingPolicy such that all queries are responded with the primary_targets if they are healthy. And if all of them are unhealthy, then we fallback to a geo localized policy. - "backupGeoTargets": { # Configures a RRSetRoutingPolicy that routes based on the geo location of the querying user. # Backup targets provide a regional failover policy for the otherwise global primary targets. If serving state is set to BACKUP, this policy essentially becomes a geo routing policy. + "backupGeoTargets": { # Configures a `RRSetRoutingPolicy` that routes based on the geo location of the querying user. # Backup targets provide a regional failover policy for the otherwise global primary targets. If serving state is set to `BACKUP`, this policy essentially becomes a geo routing policy. "enableFencing": True or False, # Without fencing, if health check fails for all configured items in the current geo bucket, we failover to the next nearest geo bucket. With fencing, if health checking is enabled, as long as some targets in the current geo bucket are healthy, we return only the healthy targets. However, if all targets are unhealthy, we don't failover to the next nearest bucket; instead, we return all the items in the current bucket even when all targets are unhealthy. "items": [ # The primary geo routing configuration. If there are multiple items with the same location, an error is returned instead. { # ResourceRecordSet data for one geo location. - "healthCheckedTargets": { # HealthCheckTargets describes endpoints to health-check when responding to Routing Policy queries. Only the healthy endpoints will be included in the response. Only one of internal_load_balancer and external_endpoints should be set. # For A and AAAA types only. Endpoints to return in the query result only if they are healthy. These can be specified along with rrdata within this item. + "healthCheckedTargets": { # HealthCheckTargets describes endpoints to health-check when responding to Routing Policy queries. Only the healthy endpoints will be included in the response. # For A and AAAA types only. Endpoints to return in the query result only if they are healthy. These can be specified along with `rrdata` within this item. "internalLoadBalancers": [ # Configuration for internal load balancers to be health checked. { # The configuration for an individual load balancer to health check. "ipAddress": "A String", # The frontend IP address of the load balancer to health check. "ipProtocol": "A String", # The protocol of the load balancer to health check. "kind": "dns#rRSetRoutingPolicyLoadBalancerTarget", "loadBalancerType": "A String", # The type of load balancer specified by this target. This value must match the configuration of the load balancer located at the LoadBalancerTarget's IP address, port, and region. Use the following: - *regionalL4ilb*: for a regional internal passthrough Network Load Balancer. - *regionalL7ilb*: for a regional internal Application Load Balancer. - *globalL7ilb*: for a global internal Application Load Balancer. - "networkUrl": "A String", # The fully qualified URL of the network that the load balancer is attached to. This should be formatted like https://www.googleapis.com/compute/v1/projects/{project}/global/networks/{network} . + "networkUrl": "A String", # The fully qualified URL of the network that the load balancer is attached to. This should be formatted like `https://www.googleapis.com/compute/v1/projects/{project}/global/networks/{network}`. "port": "A String", # The configured port of the load balancer. "project": "A String", # The project ID in which the load balancer is located. "region": "A String", # The region in which the load balancer is located. @@ -1220,7 +1217,7 @@

Method Details

"rrdatas": [ "A String", ], - "signatureRrdatas": [ # DNSSEC generated signatures for all the rrdata within this item. If health checked targets are provided for DNSSEC enabled zones, there's a restriction of 1 IP address per item. + "signatureRrdatas": [ # DNSSEC generated signatures for all the `rrdata` within this item. If health checked targets are provided for DNSSEC enabled zones, there's a restriction of 1 IP address per item. "A String", ], }, @@ -1228,33 +1225,33 @@

Method Details

"kind": "dns#rRSetRoutingPolicyGeoPolicy", }, "kind": "dns#rRSetRoutingPolicyPrimaryBackupPolicy", - "primaryTargets": { # HealthCheckTargets describes endpoints to health-check when responding to Routing Policy queries. Only the healthy endpoints will be included in the response. Only one of internal_load_balancer and external_endpoints should be set. # Endpoints that are health checked before making the routing decision. Unhealthy endpoints are omitted from the results. If all endpoints are unhealthy, we serve a response based on the backup_geo_targets. + "primaryTargets": { # HealthCheckTargets describes endpoints to health-check when responding to Routing Policy queries. Only the healthy endpoints will be included in the response. # Endpoints that are health checked before making the routing decision. Unhealthy endpoints are omitted from the results. If all endpoints are unhealthy, we serve a response based on the `backup_geo_targets`. "internalLoadBalancers": [ # Configuration for internal load balancers to be health checked. { # The configuration for an individual load balancer to health check. "ipAddress": "A String", # The frontend IP address of the load balancer to health check. "ipProtocol": "A String", # The protocol of the load balancer to health check. "kind": "dns#rRSetRoutingPolicyLoadBalancerTarget", "loadBalancerType": "A String", # The type of load balancer specified by this target. This value must match the configuration of the load balancer located at the LoadBalancerTarget's IP address, port, and region. Use the following: - *regionalL4ilb*: for a regional internal passthrough Network Load Balancer. - *regionalL7ilb*: for a regional internal Application Load Balancer. - *globalL7ilb*: for a global internal Application Load Balancer. - "networkUrl": "A String", # The fully qualified URL of the network that the load balancer is attached to. This should be formatted like https://www.googleapis.com/compute/v1/projects/{project}/global/networks/{network} . + "networkUrl": "A String", # The fully qualified URL of the network that the load balancer is attached to. This should be formatted like `https://www.googleapis.com/compute/v1/projects/{project}/global/networks/{network}`. "port": "A String", # The configured port of the load balancer. "project": "A String", # The project ID in which the load balancer is located. "region": "A String", # The region in which the load balancer is located. }, ], }, - "trickleTraffic": 3.14, # When serving state is PRIMARY, this field provides the option of sending a small percentage of the traffic to the backup targets. + "trickleTraffic": 3.14, # When serving state is `PRIMARY`, this field provides the option of sending a small percentage of the traffic to the backup targets. }, "wrr": { # Configures a RRSetRoutingPolicy that routes in a weighted round robin fashion. "items": [ { # A routing block which contains the routing information for one WRR item. - "healthCheckedTargets": { # HealthCheckTargets describes endpoints to health-check when responding to Routing Policy queries. Only the healthy endpoints will be included in the response. Only one of internal_load_balancer and external_endpoints should be set. # Endpoints that are health checked before making the routing decision. The unhealthy endpoints are omitted from the result. If all endpoints within a bucket are unhealthy, we choose a different bucket (sampled with respect to its weight) for responding. If DNSSEC is enabled for this zone, only one of rrdata or health_checked_targets can be set. + "healthCheckedTargets": { # HealthCheckTargets describes endpoints to health-check when responding to Routing Policy queries. Only the healthy endpoints will be included in the response. # Endpoints that are health checked before making the routing decision. The unhealthy endpoints are omitted from the result. If all endpoints within a bucket are unhealthy, we choose a different bucket (sampled with respect to its weight) for responding. If DNSSEC is enabled for this zone, only one of `rrdata` or `health_checked_targets` can be set. "internalLoadBalancers": [ # Configuration for internal load balancers to be health checked. { # The configuration for an individual load balancer to health check. "ipAddress": "A String", # The frontend IP address of the load balancer to health check. "ipProtocol": "A String", # The protocol of the load balancer to health check. "kind": "dns#rRSetRoutingPolicyLoadBalancerTarget", "loadBalancerType": "A String", # The type of load balancer specified by this target. This value must match the configuration of the load balancer located at the LoadBalancerTarget's IP address, port, and region. Use the following: - *regionalL4ilb*: for a regional internal passthrough Network Load Balancer. - *regionalL7ilb*: for a regional internal Application Load Balancer. - *globalL7ilb*: for a global internal Application Load Balancer. - "networkUrl": "A String", # The fully qualified URL of the network that the load balancer is attached to. This should be formatted like https://www.googleapis.com/compute/v1/projects/{project}/global/networks/{network} . + "networkUrl": "A String", # The fully qualified URL of the network that the load balancer is attached to. This should be formatted like `https://www.googleapis.com/compute/v1/projects/{project}/global/networks/{network}`. "port": "A String", # The configured port of the load balancer. "project": "A String", # The project ID in which the load balancer is located. "region": "A String", # The region in which the load balancer is located. @@ -1265,10 +1262,10 @@

Method Details

"rrdatas": [ "A String", ], - "signatureRrdatas": [ # DNSSEC generated signatures for all the rrdata within this item. Note that if health checked targets are provided for DNSSEC enabled zones, there's a restriction of 1 IP address per item. + "signatureRrdatas": [ # DNSSEC generated signatures for all the `rrdata` within this item. Note that if health checked targets are provided for DNSSEC enabled zones, there's a restriction of 1 IP address per item. "A String", ], - "weight": 3.14, # The weight corresponding to this WrrPolicyItem object. When multiple WrrPolicyItem objects are configured, the probability of returning an WrrPolicyItem object's data is proportional to its weight relative to the sum of weights configured for all items. This weight must be non-negative. + "weight": 3.14, # The weight corresponding to this `WrrPolicyItem` object. When multiple `WrrPolicyItem` objects are configured, the probability of returning an `WrrPolicyItem` object's data is proportional to its weight relative to the sum of weights configured for all items. This weight must be non-negative. }, ], "kind": "dns#rRSetRoutingPolicyWrrPolicy", @@ -1276,14 +1273,14 @@

Method Details

"wrrPolicy": { # Configures a RRSetRoutingPolicy that routes in a weighted round robin fashion. "items": [ { # A routing block which contains the routing information for one WRR item. - "healthCheckedTargets": { # HealthCheckTargets describes endpoints to health-check when responding to Routing Policy queries. Only the healthy endpoints will be included in the response. Only one of internal_load_balancer and external_endpoints should be set. # Endpoints that are health checked before making the routing decision. The unhealthy endpoints are omitted from the result. If all endpoints within a bucket are unhealthy, we choose a different bucket (sampled with respect to its weight) for responding. If DNSSEC is enabled for this zone, only one of rrdata or health_checked_targets can be set. + "healthCheckedTargets": { # HealthCheckTargets describes endpoints to health-check when responding to Routing Policy queries. Only the healthy endpoints will be included in the response. # Endpoints that are health checked before making the routing decision. The unhealthy endpoints are omitted from the result. If all endpoints within a bucket are unhealthy, we choose a different bucket (sampled with respect to its weight) for responding. If DNSSEC is enabled for this zone, only one of `rrdata` or `health_checked_targets` can be set. "internalLoadBalancers": [ # Configuration for internal load balancers to be health checked. { # The configuration for an individual load balancer to health check. "ipAddress": "A String", # The frontend IP address of the load balancer to health check. "ipProtocol": "A String", # The protocol of the load balancer to health check. "kind": "dns#rRSetRoutingPolicyLoadBalancerTarget", "loadBalancerType": "A String", # The type of load balancer specified by this target. This value must match the configuration of the load balancer located at the LoadBalancerTarget's IP address, port, and region. Use the following: - *regionalL4ilb*: for a regional internal passthrough Network Load Balancer. - *regionalL7ilb*: for a regional internal Application Load Balancer. - *globalL7ilb*: for a global internal Application Load Balancer. - "networkUrl": "A String", # The fully qualified URL of the network that the load balancer is attached to. This should be formatted like https://www.googleapis.com/compute/v1/projects/{project}/global/networks/{network} . + "networkUrl": "A String", # The fully qualified URL of the network that the load balancer is attached to. This should be formatted like `https://www.googleapis.com/compute/v1/projects/{project}/global/networks/{network}`. "port": "A String", # The configured port of the load balancer. "project": "A String", # The project ID in which the load balancer is located. "region": "A String", # The region in which the load balancer is located. @@ -1294,10 +1291,10 @@

Method Details

"rrdatas": [ "A String", ], - "signatureRrdatas": [ # DNSSEC generated signatures for all the rrdata within this item. Note that if health checked targets are provided for DNSSEC enabled zones, there's a restriction of 1 IP address per item. + "signatureRrdatas": [ # DNSSEC generated signatures for all the `rrdata` within this item. Note that if health checked targets are provided for DNSSEC enabled zones, there's a restriction of 1 IP address per item. "A String", ], - "weight": 3.14, # The weight corresponding to this WrrPolicyItem object. When multiple WrrPolicyItem objects are configured, the probability of returning an WrrPolicyItem object's data is proportional to its weight relative to the sum of weights configured for all items. This weight must be non-negative. + "weight": 3.14, # The weight corresponding to this `WrrPolicyItem` object. When multiple `WrrPolicyItem` objects are configured, the probability of returning an `WrrPolicyItem` object's data is proportional to its weight relative to the sum of weights configured for all items. This weight must be non-negative. }, ], "kind": "dns#rRSetRoutingPolicyWrrPolicy", @@ -1309,7 +1306,7 @@

Method Details

"signatureRrdatas": [ # As defined in RFC 4034 (section 3.2). "A String", ], - "ttl": 42, # Number of seconds that this ResourceRecordSet can be cached by resolvers. + "ttl": 42, # Number of seconds that this `ResourceRecordSet` can be cached by resolvers. "type": "A String", # The identifier of a supported record type. See the list of Supported DNS record types. } diff --git a/docs/dyn/dns_v1beta2.responsePolicies.html b/docs/dyn/dns_v1beta2.responsePolicies.html index 36504e0933d..40ba00e32ae 100644 --- a/docs/dyn/dns_v1beta2.responsePolicies.html +++ b/docs/dyn/dns_v1beta2.responsePolicies.html @@ -129,7 +129,7 @@

Method Details

"networks": [ # List of network names specifying networks to which this policy is applied. { "kind": "dns#responsePolicyNetwork", - "networkUrl": "A String", # The fully qualified URL of the VPC network to bind to. This should be formatted like https://www.googleapis.com/compute/v1/projects/{project}/global/networks/{network} + "networkUrl": "A String", # The fully qualified URL of the VPC network to bind to. This should be formatted like `https://www.googleapis.com/compute/v1/projects/{project}/global/networks/{network}` }, ], "responsePolicyName": "A String", # User assigned name for this Response Policy. @@ -160,7 +160,7 @@

Method Details

"networks": [ # List of network names specifying networks to which this policy is applied. { "kind": "dns#responsePolicyNetwork", - "networkUrl": "A String", # The fully qualified URL of the VPC network to bind to. This should be formatted like https://www.googleapis.com/compute/v1/projects/{project}/global/networks/{network} + "networkUrl": "A String", # The fully qualified URL of the VPC network to bind to. This should be formatted like `https://www.googleapis.com/compute/v1/projects/{project}/global/networks/{network}` }, ], "responsePolicyName": "A String", # User assigned name for this Response Policy. @@ -214,7 +214,7 @@

Method Details

"networks": [ # List of network names specifying networks to which this policy is applied. { "kind": "dns#responsePolicyNetwork", - "networkUrl": "A String", # The fully qualified URL of the VPC network to bind to. This should be formatted like https://www.googleapis.com/compute/v1/projects/{project}/global/networks/{network} + "networkUrl": "A String", # The fully qualified URL of the VPC network to bind to. This should be formatted like `https://www.googleapis.com/compute/v1/projects/{project}/global/networks/{network}` }, ], "responsePolicyName": "A String", # User assigned name for this Response Policy. @@ -238,10 +238,7 @@

Method Details

An object of the form: { - "header": { # Elements common to every response. - "operationId": "A String", # For mutating operation requests that completed successfully. This is the client_operation_id if the client specified it, otherwise it is generated by the server (output only). - }, - "nextPageToken": "A String", # The presence of this field indicates that more results exist following your last page of results in pagination order. To fetch them, make another list request by using this value as your page token. This lets you view the complete contents of even very large collections one page at a time. However, if the contents of the collection change between the first and last paginated list request, the set of all elements returned are an inconsistent view of the collection. You cannot retrieve a consistent snapshot of a collection larger than the maximum page size. + "nextPageToken": "A String", # This field indicates that more results are available beyond the last page displayed. To fetch the results, make another list request and use this value as your page token. This lets you retrieve the complete contents of a very large collection one page at a time. However, if the contents of the collection change between the first and last paginated list request, the set of all elements returned are an inconsistent view of the collection. You can't retrieve a consistent snapshot of a collection larger than the maximum page size. "responsePolicies": [ # The Response Policy resources. { # A Response Policy is a collection of selectors that apply to queries made against one or more Virtual Private Cloud networks. "description": "A String", # User-provided description for this Response Policy. @@ -259,7 +256,7 @@

Method Details

"networks": [ # List of network names specifying networks to which this policy is applied. { "kind": "dns#responsePolicyNetwork", - "networkUrl": "A String", # The fully qualified URL of the VPC network to bind to. This should be formatted like https://www.googleapis.com/compute/v1/projects/{project}/global/networks/{network} + "networkUrl": "A String", # The fully qualified URL of the VPC network to bind to. This should be formatted like `https://www.googleapis.com/compute/v1/projects/{project}/global/networks/{network}` }, ], "responsePolicyName": "A String", # User assigned name for this Response Policy. @@ -308,7 +305,7 @@

Method Details

"networks": [ # List of network names specifying networks to which this policy is applied. { "kind": "dns#responsePolicyNetwork", - "networkUrl": "A String", # The fully qualified URL of the VPC network to bind to. This should be formatted like https://www.googleapis.com/compute/v1/projects/{project}/global/networks/{network} + "networkUrl": "A String", # The fully qualified URL of the VPC network to bind to. This should be formatted like `https://www.googleapis.com/compute/v1/projects/{project}/global/networks/{network}` }, ], "responsePolicyName": "A String", # User assigned name for this Response Policy. @@ -324,9 +321,6 @@

Method Details

An object of the form: { - "header": { # Elements common to every response. - "operationId": "A String", # For mutating operation requests that completed successfully. This is the client_operation_id if the client specified it, otherwise it is generated by the server (output only). - }, "responsePolicy": { # A Response Policy is a collection of selectors that apply to queries made against one or more Virtual Private Cloud networks. "description": "A String", # User-provided description for this Response Policy. "gkeClusters": [ # The list of Google Kubernetes Engine clusters to which this response policy is applied. @@ -343,7 +337,7 @@

Method Details

"networks": [ # List of network names specifying networks to which this policy is applied. { "kind": "dns#responsePolicyNetwork", - "networkUrl": "A String", # The fully qualified URL of the VPC network to bind to. This should be formatted like https://www.googleapis.com/compute/v1/projects/{project}/global/networks/{network} + "networkUrl": "A String", # The fully qualified URL of the VPC network to bind to. This should be formatted like `https://www.googleapis.com/compute/v1/projects/{project}/global/networks/{network}` }, ], "responsePolicyName": "A String", # User assigned name for this Response Policy. @@ -377,7 +371,7 @@

Method Details

"networks": [ # List of network names specifying networks to which this policy is applied. { "kind": "dns#responsePolicyNetwork", - "networkUrl": "A String", # The fully qualified URL of the VPC network to bind to. This should be formatted like https://www.googleapis.com/compute/v1/projects/{project}/global/networks/{network} + "networkUrl": "A String", # The fully qualified URL of the VPC network to bind to. This should be formatted like `https://www.googleapis.com/compute/v1/projects/{project}/global/networks/{network}` }, ], "responsePolicyName": "A String", # User assigned name for this Response Policy. @@ -393,9 +387,6 @@

Method Details

An object of the form: { - "header": { # Elements common to every response. - "operationId": "A String", # For mutating operation requests that completed successfully. This is the client_operation_id if the client specified it, otherwise it is generated by the server (output only). - }, "responsePolicy": { # A Response Policy is a collection of selectors that apply to queries made against one or more Virtual Private Cloud networks. "description": "A String", # User-provided description for this Response Policy. "gkeClusters": [ # The list of Google Kubernetes Engine clusters to which this response policy is applied. @@ -412,7 +403,7 @@

Method Details

"networks": [ # List of network names specifying networks to which this policy is applied. { "kind": "dns#responsePolicyNetwork", - "networkUrl": "A String", # The fully qualified URL of the VPC network to bind to. This should be formatted like https://www.googleapis.com/compute/v1/projects/{project}/global/networks/{network} + "networkUrl": "A String", # The fully qualified URL of the VPC network to bind to. This should be formatted like `https://www.googleapis.com/compute/v1/projects/{project}/global/networks/{network}` }, ], "responsePolicyName": "A String", # User assigned name for this Response Policy. diff --git a/docs/dyn/dns_v1beta2.responsePolicyRules.html b/docs/dyn/dns_v1beta2.responsePolicyRules.html index 5c42525fb08..b361e1539d9 100644 --- a/docs/dyn/dns_v1beta2.responsePolicyRules.html +++ b/docs/dyn/dns_v1beta2.responsePolicyRules.html @@ -123,19 +123,19 @@

Method Details

{ # A unit of data that is returned by the DNS servers. "kind": "dns#resourceRecordSet", "name": "A String", # For example, www.example.com. - "routingPolicy": { # A RRSetRoutingPolicy represents ResourceRecordSet data that is returned dynamically with the response varying based on configured properties such as geolocation or by weighted random selection. # Configures dynamic query responses based on either the geo location of the querying user or a weighted round robin based routing policy. A valid ResourceRecordSet contains only rrdata (for static resolution) or a routing_policy (for dynamic resolution). - "geo": { # Configures a RRSetRoutingPolicy that routes based on the geo location of the querying user. + "routingPolicy": { # A RRSetRoutingPolicy represents ResourceRecordSet data that is returned dynamically with the response varying based on configured properties such as geolocation or by weighted random selection. # Configures dynamic query responses based on either the geo location of the querying user or a weighted round robin based routing policy. A valid `ResourceRecordSet` contains only `rrdata` (for static resolution) or a `routing_policy` (for dynamic resolution). + "geo": { # Configures a `RRSetRoutingPolicy` that routes based on the geo location of the querying user. "enableFencing": True or False, # Without fencing, if health check fails for all configured items in the current geo bucket, we failover to the next nearest geo bucket. With fencing, if health checking is enabled, as long as some targets in the current geo bucket are healthy, we return only the healthy targets. However, if all targets are unhealthy, we don't failover to the next nearest bucket; instead, we return all the items in the current bucket even when all targets are unhealthy. "items": [ # The primary geo routing configuration. If there are multiple items with the same location, an error is returned instead. { # ResourceRecordSet data for one geo location. - "healthCheckedTargets": { # HealthCheckTargets describes endpoints to health-check when responding to Routing Policy queries. Only the healthy endpoints will be included in the response. Only one of internal_load_balancer and external_endpoints should be set. # For A and AAAA types only. Endpoints to return in the query result only if they are healthy. These can be specified along with rrdata within this item. + "healthCheckedTargets": { # HealthCheckTargets describes endpoints to health-check when responding to Routing Policy queries. Only the healthy endpoints will be included in the response. # For A and AAAA types only. Endpoints to return in the query result only if they are healthy. These can be specified along with `rrdata` within this item. "internalLoadBalancers": [ # Configuration for internal load balancers to be health checked. { # The configuration for an individual load balancer to health check. "ipAddress": "A String", # The frontend IP address of the load balancer to health check. "ipProtocol": "A String", # The protocol of the load balancer to health check. "kind": "dns#rRSetRoutingPolicyLoadBalancerTarget", "loadBalancerType": "A String", # The type of load balancer specified by this target. This value must match the configuration of the load balancer located at the LoadBalancerTarget's IP address, port, and region. Use the following: - *regionalL4ilb*: for a regional internal passthrough Network Load Balancer. - *regionalL7ilb*: for a regional internal Application Load Balancer. - *globalL7ilb*: for a global internal Application Load Balancer. - "networkUrl": "A String", # The fully qualified URL of the network that the load balancer is attached to. This should be formatted like https://www.googleapis.com/compute/v1/projects/{project}/global/networks/{network} . + "networkUrl": "A String", # The fully qualified URL of the network that the load balancer is attached to. This should be formatted like `https://www.googleapis.com/compute/v1/projects/{project}/global/networks/{network}`. "port": "A String", # The configured port of the load balancer. "project": "A String", # The project ID in which the load balancer is located. "region": "A String", # The region in which the load balancer is located. @@ -147,25 +147,25 @@

Method Details

"rrdatas": [ "A String", ], - "signatureRrdatas": [ # DNSSEC generated signatures for all the rrdata within this item. If health checked targets are provided for DNSSEC enabled zones, there's a restriction of 1 IP address per item. + "signatureRrdatas": [ # DNSSEC generated signatures for all the `rrdata` within this item. If health checked targets are provided for DNSSEC enabled zones, there's a restriction of 1 IP address per item. "A String", ], }, ], "kind": "dns#rRSetRoutingPolicyGeoPolicy", }, - "geoPolicy": { # Configures a RRSetRoutingPolicy that routes based on the geo location of the querying user. + "geoPolicy": { # Configures a `RRSetRoutingPolicy` that routes based on the geo location of the querying user. "enableFencing": True or False, # Without fencing, if health check fails for all configured items in the current geo bucket, we failover to the next nearest geo bucket. With fencing, if health checking is enabled, as long as some targets in the current geo bucket are healthy, we return only the healthy targets. However, if all targets are unhealthy, we don't failover to the next nearest bucket; instead, we return all the items in the current bucket even when all targets are unhealthy. "items": [ # The primary geo routing configuration. If there are multiple items with the same location, an error is returned instead. { # ResourceRecordSet data for one geo location. - "healthCheckedTargets": { # HealthCheckTargets describes endpoints to health-check when responding to Routing Policy queries. Only the healthy endpoints will be included in the response. Only one of internal_load_balancer and external_endpoints should be set. # For A and AAAA types only. Endpoints to return in the query result only if they are healthy. These can be specified along with rrdata within this item. + "healthCheckedTargets": { # HealthCheckTargets describes endpoints to health-check when responding to Routing Policy queries. Only the healthy endpoints will be included in the response. # For A and AAAA types only. Endpoints to return in the query result only if they are healthy. These can be specified along with `rrdata` within this item. "internalLoadBalancers": [ # Configuration for internal load balancers to be health checked. { # The configuration for an individual load balancer to health check. "ipAddress": "A String", # The frontend IP address of the load balancer to health check. "ipProtocol": "A String", # The protocol of the load balancer to health check. "kind": "dns#rRSetRoutingPolicyLoadBalancerTarget", "loadBalancerType": "A String", # The type of load balancer specified by this target. This value must match the configuration of the load balancer located at the LoadBalancerTarget's IP address, port, and region. Use the following: - *regionalL4ilb*: for a regional internal passthrough Network Load Balancer. - *regionalL7ilb*: for a regional internal Application Load Balancer. - *globalL7ilb*: for a global internal Application Load Balancer. - "networkUrl": "A String", # The fully qualified URL of the network that the load balancer is attached to. This should be formatted like https://www.googleapis.com/compute/v1/projects/{project}/global/networks/{network} . + "networkUrl": "A String", # The fully qualified URL of the network that the load balancer is attached to. This should be formatted like `https://www.googleapis.com/compute/v1/projects/{project}/global/networks/{network}`. "port": "A String", # The configured port of the load balancer. "project": "A String", # The project ID in which the load balancer is located. "region": "A String", # The region in which the load balancer is located. @@ -177,7 +177,7 @@

Method Details

"rrdatas": [ "A String", ], - "signatureRrdatas": [ # DNSSEC generated signatures for all the rrdata within this item. If health checked targets are provided for DNSSEC enabled zones, there's a restriction of 1 IP address per item. + "signatureRrdatas": [ # DNSSEC generated signatures for all the `rrdata` within this item. If health checked targets are provided for DNSSEC enabled zones, there's a restriction of 1 IP address per item. "A String", ], }, @@ -186,18 +186,18 @@

Method Details

}, "kind": "dns#rRSetRoutingPolicy", "primaryBackup": { # Configures a RRSetRoutingPolicy such that all queries are responded with the primary_targets if they are healthy. And if all of them are unhealthy, then we fallback to a geo localized policy. - "backupGeoTargets": { # Configures a RRSetRoutingPolicy that routes based on the geo location of the querying user. # Backup targets provide a regional failover policy for the otherwise global primary targets. If serving state is set to BACKUP, this policy essentially becomes a geo routing policy. + "backupGeoTargets": { # Configures a `RRSetRoutingPolicy` that routes based on the geo location of the querying user. # Backup targets provide a regional failover policy for the otherwise global primary targets. If serving state is set to `BACKUP`, this policy essentially becomes a geo routing policy. "enableFencing": True or False, # Without fencing, if health check fails for all configured items in the current geo bucket, we failover to the next nearest geo bucket. With fencing, if health checking is enabled, as long as some targets in the current geo bucket are healthy, we return only the healthy targets. However, if all targets are unhealthy, we don't failover to the next nearest bucket; instead, we return all the items in the current bucket even when all targets are unhealthy. "items": [ # The primary geo routing configuration. If there are multiple items with the same location, an error is returned instead. { # ResourceRecordSet data for one geo location. - "healthCheckedTargets": { # HealthCheckTargets describes endpoints to health-check when responding to Routing Policy queries. Only the healthy endpoints will be included in the response. Only one of internal_load_balancer and external_endpoints should be set. # For A and AAAA types only. Endpoints to return in the query result only if they are healthy. These can be specified along with rrdata within this item. + "healthCheckedTargets": { # HealthCheckTargets describes endpoints to health-check when responding to Routing Policy queries. Only the healthy endpoints will be included in the response. # For A and AAAA types only. Endpoints to return in the query result only if they are healthy. These can be specified along with `rrdata` within this item. "internalLoadBalancers": [ # Configuration for internal load balancers to be health checked. { # The configuration for an individual load balancer to health check. "ipAddress": "A String", # The frontend IP address of the load balancer to health check. "ipProtocol": "A String", # The protocol of the load balancer to health check. "kind": "dns#rRSetRoutingPolicyLoadBalancerTarget", "loadBalancerType": "A String", # The type of load balancer specified by this target. This value must match the configuration of the load balancer located at the LoadBalancerTarget's IP address, port, and region. Use the following: - *regionalL4ilb*: for a regional internal passthrough Network Load Balancer. - *regionalL7ilb*: for a regional internal Application Load Balancer. - *globalL7ilb*: for a global internal Application Load Balancer. - "networkUrl": "A String", # The fully qualified URL of the network that the load balancer is attached to. This should be formatted like https://www.googleapis.com/compute/v1/projects/{project}/global/networks/{network} . + "networkUrl": "A String", # The fully qualified URL of the network that the load balancer is attached to. This should be formatted like `https://www.googleapis.com/compute/v1/projects/{project}/global/networks/{network}`. "port": "A String", # The configured port of the load balancer. "project": "A String", # The project ID in which the load balancer is located. "region": "A String", # The region in which the load balancer is located. @@ -209,7 +209,7 @@

Method Details

"rrdatas": [ "A String", ], - "signatureRrdatas": [ # DNSSEC generated signatures for all the rrdata within this item. If health checked targets are provided for DNSSEC enabled zones, there's a restriction of 1 IP address per item. + "signatureRrdatas": [ # DNSSEC generated signatures for all the `rrdata` within this item. If health checked targets are provided for DNSSEC enabled zones, there's a restriction of 1 IP address per item. "A String", ], }, @@ -217,33 +217,33 @@

Method Details

"kind": "dns#rRSetRoutingPolicyGeoPolicy", }, "kind": "dns#rRSetRoutingPolicyPrimaryBackupPolicy", - "primaryTargets": { # HealthCheckTargets describes endpoints to health-check when responding to Routing Policy queries. Only the healthy endpoints will be included in the response. Only one of internal_load_balancer and external_endpoints should be set. # Endpoints that are health checked before making the routing decision. Unhealthy endpoints are omitted from the results. If all endpoints are unhealthy, we serve a response based on the backup_geo_targets. + "primaryTargets": { # HealthCheckTargets describes endpoints to health-check when responding to Routing Policy queries. Only the healthy endpoints will be included in the response. # Endpoints that are health checked before making the routing decision. Unhealthy endpoints are omitted from the results. If all endpoints are unhealthy, we serve a response based on the `backup_geo_targets`. "internalLoadBalancers": [ # Configuration for internal load balancers to be health checked. { # The configuration for an individual load balancer to health check. "ipAddress": "A String", # The frontend IP address of the load balancer to health check. "ipProtocol": "A String", # The protocol of the load balancer to health check. "kind": "dns#rRSetRoutingPolicyLoadBalancerTarget", "loadBalancerType": "A String", # The type of load balancer specified by this target. This value must match the configuration of the load balancer located at the LoadBalancerTarget's IP address, port, and region. Use the following: - *regionalL4ilb*: for a regional internal passthrough Network Load Balancer. - *regionalL7ilb*: for a regional internal Application Load Balancer. - *globalL7ilb*: for a global internal Application Load Balancer. - "networkUrl": "A String", # The fully qualified URL of the network that the load balancer is attached to. This should be formatted like https://www.googleapis.com/compute/v1/projects/{project}/global/networks/{network} . + "networkUrl": "A String", # The fully qualified URL of the network that the load balancer is attached to. This should be formatted like `https://www.googleapis.com/compute/v1/projects/{project}/global/networks/{network}`. "port": "A String", # The configured port of the load balancer. "project": "A String", # The project ID in which the load balancer is located. "region": "A String", # The region in which the load balancer is located. }, ], }, - "trickleTraffic": 3.14, # When serving state is PRIMARY, this field provides the option of sending a small percentage of the traffic to the backup targets. + "trickleTraffic": 3.14, # When serving state is `PRIMARY`, this field provides the option of sending a small percentage of the traffic to the backup targets. }, "wrr": { # Configures a RRSetRoutingPolicy that routes in a weighted round robin fashion. "items": [ { # A routing block which contains the routing information for one WRR item. - "healthCheckedTargets": { # HealthCheckTargets describes endpoints to health-check when responding to Routing Policy queries. Only the healthy endpoints will be included in the response. Only one of internal_load_balancer and external_endpoints should be set. # Endpoints that are health checked before making the routing decision. The unhealthy endpoints are omitted from the result. If all endpoints within a bucket are unhealthy, we choose a different bucket (sampled with respect to its weight) for responding. If DNSSEC is enabled for this zone, only one of rrdata or health_checked_targets can be set. + "healthCheckedTargets": { # HealthCheckTargets describes endpoints to health-check when responding to Routing Policy queries. Only the healthy endpoints will be included in the response. # Endpoints that are health checked before making the routing decision. The unhealthy endpoints are omitted from the result. If all endpoints within a bucket are unhealthy, we choose a different bucket (sampled with respect to its weight) for responding. If DNSSEC is enabled for this zone, only one of `rrdata` or `health_checked_targets` can be set. "internalLoadBalancers": [ # Configuration for internal load balancers to be health checked. { # The configuration for an individual load balancer to health check. "ipAddress": "A String", # The frontend IP address of the load balancer to health check. "ipProtocol": "A String", # The protocol of the load balancer to health check. "kind": "dns#rRSetRoutingPolicyLoadBalancerTarget", "loadBalancerType": "A String", # The type of load balancer specified by this target. This value must match the configuration of the load balancer located at the LoadBalancerTarget's IP address, port, and region. Use the following: - *regionalL4ilb*: for a regional internal passthrough Network Load Balancer. - *regionalL7ilb*: for a regional internal Application Load Balancer. - *globalL7ilb*: for a global internal Application Load Balancer. - "networkUrl": "A String", # The fully qualified URL of the network that the load balancer is attached to. This should be formatted like https://www.googleapis.com/compute/v1/projects/{project}/global/networks/{network} . + "networkUrl": "A String", # The fully qualified URL of the network that the load balancer is attached to. This should be formatted like `https://www.googleapis.com/compute/v1/projects/{project}/global/networks/{network}`. "port": "A String", # The configured port of the load balancer. "project": "A String", # The project ID in which the load balancer is located. "region": "A String", # The region in which the load balancer is located. @@ -254,10 +254,10 @@

Method Details

"rrdatas": [ "A String", ], - "signatureRrdatas": [ # DNSSEC generated signatures for all the rrdata within this item. Note that if health checked targets are provided for DNSSEC enabled zones, there's a restriction of 1 IP address per item. + "signatureRrdatas": [ # DNSSEC generated signatures for all the `rrdata` within this item. Note that if health checked targets are provided for DNSSEC enabled zones, there's a restriction of 1 IP address per item. "A String", ], - "weight": 3.14, # The weight corresponding to this WrrPolicyItem object. When multiple WrrPolicyItem objects are configured, the probability of returning an WrrPolicyItem object's data is proportional to its weight relative to the sum of weights configured for all items. This weight must be non-negative. + "weight": 3.14, # The weight corresponding to this `WrrPolicyItem` object. When multiple `WrrPolicyItem` objects are configured, the probability of returning an `WrrPolicyItem` object's data is proportional to its weight relative to the sum of weights configured for all items. This weight must be non-negative. }, ], "kind": "dns#rRSetRoutingPolicyWrrPolicy", @@ -265,14 +265,14 @@

Method Details

"wrrPolicy": { # Configures a RRSetRoutingPolicy that routes in a weighted round robin fashion. "items": [ { # A routing block which contains the routing information for one WRR item. - "healthCheckedTargets": { # HealthCheckTargets describes endpoints to health-check when responding to Routing Policy queries. Only the healthy endpoints will be included in the response. Only one of internal_load_balancer and external_endpoints should be set. # Endpoints that are health checked before making the routing decision. The unhealthy endpoints are omitted from the result. If all endpoints within a bucket are unhealthy, we choose a different bucket (sampled with respect to its weight) for responding. If DNSSEC is enabled for this zone, only one of rrdata or health_checked_targets can be set. + "healthCheckedTargets": { # HealthCheckTargets describes endpoints to health-check when responding to Routing Policy queries. Only the healthy endpoints will be included in the response. # Endpoints that are health checked before making the routing decision. The unhealthy endpoints are omitted from the result. If all endpoints within a bucket are unhealthy, we choose a different bucket (sampled with respect to its weight) for responding. If DNSSEC is enabled for this zone, only one of `rrdata` or `health_checked_targets` can be set. "internalLoadBalancers": [ # Configuration for internal load balancers to be health checked. { # The configuration for an individual load balancer to health check. "ipAddress": "A String", # The frontend IP address of the load balancer to health check. "ipProtocol": "A String", # The protocol of the load balancer to health check. "kind": "dns#rRSetRoutingPolicyLoadBalancerTarget", "loadBalancerType": "A String", # The type of load balancer specified by this target. This value must match the configuration of the load balancer located at the LoadBalancerTarget's IP address, port, and region. Use the following: - *regionalL4ilb*: for a regional internal passthrough Network Load Balancer. - *regionalL7ilb*: for a regional internal Application Load Balancer. - *globalL7ilb*: for a global internal Application Load Balancer. - "networkUrl": "A String", # The fully qualified URL of the network that the load balancer is attached to. This should be formatted like https://www.googleapis.com/compute/v1/projects/{project}/global/networks/{network} . + "networkUrl": "A String", # The fully qualified URL of the network that the load balancer is attached to. This should be formatted like `https://www.googleapis.com/compute/v1/projects/{project}/global/networks/{network}`. "port": "A String", # The configured port of the load balancer. "project": "A String", # The project ID in which the load balancer is located. "region": "A String", # The region in which the load balancer is located. @@ -283,10 +283,10 @@

Method Details

"rrdatas": [ "A String", ], - "signatureRrdatas": [ # DNSSEC generated signatures for all the rrdata within this item. Note that if health checked targets are provided for DNSSEC enabled zones, there's a restriction of 1 IP address per item. + "signatureRrdatas": [ # DNSSEC generated signatures for all the `rrdata` within this item. Note that if health checked targets are provided for DNSSEC enabled zones, there's a restriction of 1 IP address per item. "A String", ], - "weight": 3.14, # The weight corresponding to this WrrPolicyItem object. When multiple WrrPolicyItem objects are configured, the probability of returning an WrrPolicyItem object's data is proportional to its weight relative to the sum of weights configured for all items. This weight must be non-negative. + "weight": 3.14, # The weight corresponding to this `WrrPolicyItem` object. When multiple `WrrPolicyItem` objects are configured, the probability of returning an `WrrPolicyItem` object's data is proportional to its weight relative to the sum of weights configured for all items. This weight must be non-negative. }, ], "kind": "dns#rRSetRoutingPolicyWrrPolicy", @@ -298,7 +298,7 @@

Method Details

"signatureRrdatas": [ # As defined in RFC 4034 (section 3.2). "A String", ], - "ttl": 42, # Number of seconds that this ResourceRecordSet can be cached by resolvers. + "ttl": 42, # Number of seconds that this `ResourceRecordSet` can be cached by resolvers. "type": "A String", # The identifier of a supported record type. See the list of Supported DNS record types. }, ], @@ -324,19 +324,19 @@

Method Details

{ # A unit of data that is returned by the DNS servers. "kind": "dns#resourceRecordSet", "name": "A String", # For example, www.example.com. - "routingPolicy": { # A RRSetRoutingPolicy represents ResourceRecordSet data that is returned dynamically with the response varying based on configured properties such as geolocation or by weighted random selection. # Configures dynamic query responses based on either the geo location of the querying user or a weighted round robin based routing policy. A valid ResourceRecordSet contains only rrdata (for static resolution) or a routing_policy (for dynamic resolution). - "geo": { # Configures a RRSetRoutingPolicy that routes based on the geo location of the querying user. + "routingPolicy": { # A RRSetRoutingPolicy represents ResourceRecordSet data that is returned dynamically with the response varying based on configured properties such as geolocation or by weighted random selection. # Configures dynamic query responses based on either the geo location of the querying user or a weighted round robin based routing policy. A valid `ResourceRecordSet` contains only `rrdata` (for static resolution) or a `routing_policy` (for dynamic resolution). + "geo": { # Configures a `RRSetRoutingPolicy` that routes based on the geo location of the querying user. "enableFencing": True or False, # Without fencing, if health check fails for all configured items in the current geo bucket, we failover to the next nearest geo bucket. With fencing, if health checking is enabled, as long as some targets in the current geo bucket are healthy, we return only the healthy targets. However, if all targets are unhealthy, we don't failover to the next nearest bucket; instead, we return all the items in the current bucket even when all targets are unhealthy. "items": [ # The primary geo routing configuration. If there are multiple items with the same location, an error is returned instead. { # ResourceRecordSet data for one geo location. - "healthCheckedTargets": { # HealthCheckTargets describes endpoints to health-check when responding to Routing Policy queries. Only the healthy endpoints will be included in the response. Only one of internal_load_balancer and external_endpoints should be set. # For A and AAAA types only. Endpoints to return in the query result only if they are healthy. These can be specified along with rrdata within this item. + "healthCheckedTargets": { # HealthCheckTargets describes endpoints to health-check when responding to Routing Policy queries. Only the healthy endpoints will be included in the response. # For A and AAAA types only. Endpoints to return in the query result only if they are healthy. These can be specified along with `rrdata` within this item. "internalLoadBalancers": [ # Configuration for internal load balancers to be health checked. { # The configuration for an individual load balancer to health check. "ipAddress": "A String", # The frontend IP address of the load balancer to health check. "ipProtocol": "A String", # The protocol of the load balancer to health check. "kind": "dns#rRSetRoutingPolicyLoadBalancerTarget", "loadBalancerType": "A String", # The type of load balancer specified by this target. This value must match the configuration of the load balancer located at the LoadBalancerTarget's IP address, port, and region. Use the following: - *regionalL4ilb*: for a regional internal passthrough Network Load Balancer. - *regionalL7ilb*: for a regional internal Application Load Balancer. - *globalL7ilb*: for a global internal Application Load Balancer. - "networkUrl": "A String", # The fully qualified URL of the network that the load balancer is attached to. This should be formatted like https://www.googleapis.com/compute/v1/projects/{project}/global/networks/{network} . + "networkUrl": "A String", # The fully qualified URL of the network that the load balancer is attached to. This should be formatted like `https://www.googleapis.com/compute/v1/projects/{project}/global/networks/{network}`. "port": "A String", # The configured port of the load balancer. "project": "A String", # The project ID in which the load balancer is located. "region": "A String", # The region in which the load balancer is located. @@ -348,25 +348,25 @@

Method Details

"rrdatas": [ "A String", ], - "signatureRrdatas": [ # DNSSEC generated signatures for all the rrdata within this item. If health checked targets are provided for DNSSEC enabled zones, there's a restriction of 1 IP address per item. + "signatureRrdatas": [ # DNSSEC generated signatures for all the `rrdata` within this item. If health checked targets are provided for DNSSEC enabled zones, there's a restriction of 1 IP address per item. "A String", ], }, ], "kind": "dns#rRSetRoutingPolicyGeoPolicy", }, - "geoPolicy": { # Configures a RRSetRoutingPolicy that routes based on the geo location of the querying user. + "geoPolicy": { # Configures a `RRSetRoutingPolicy` that routes based on the geo location of the querying user. "enableFencing": True or False, # Without fencing, if health check fails for all configured items in the current geo bucket, we failover to the next nearest geo bucket. With fencing, if health checking is enabled, as long as some targets in the current geo bucket are healthy, we return only the healthy targets. However, if all targets are unhealthy, we don't failover to the next nearest bucket; instead, we return all the items in the current bucket even when all targets are unhealthy. "items": [ # The primary geo routing configuration. If there are multiple items with the same location, an error is returned instead. { # ResourceRecordSet data for one geo location. - "healthCheckedTargets": { # HealthCheckTargets describes endpoints to health-check when responding to Routing Policy queries. Only the healthy endpoints will be included in the response. Only one of internal_load_balancer and external_endpoints should be set. # For A and AAAA types only. Endpoints to return in the query result only if they are healthy. These can be specified along with rrdata within this item. + "healthCheckedTargets": { # HealthCheckTargets describes endpoints to health-check when responding to Routing Policy queries. Only the healthy endpoints will be included in the response. # For A and AAAA types only. Endpoints to return in the query result only if they are healthy. These can be specified along with `rrdata` within this item. "internalLoadBalancers": [ # Configuration for internal load balancers to be health checked. { # The configuration for an individual load balancer to health check. "ipAddress": "A String", # The frontend IP address of the load balancer to health check. "ipProtocol": "A String", # The protocol of the load balancer to health check. "kind": "dns#rRSetRoutingPolicyLoadBalancerTarget", "loadBalancerType": "A String", # The type of load balancer specified by this target. This value must match the configuration of the load balancer located at the LoadBalancerTarget's IP address, port, and region. Use the following: - *regionalL4ilb*: for a regional internal passthrough Network Load Balancer. - *regionalL7ilb*: for a regional internal Application Load Balancer. - *globalL7ilb*: for a global internal Application Load Balancer. - "networkUrl": "A String", # The fully qualified URL of the network that the load balancer is attached to. This should be formatted like https://www.googleapis.com/compute/v1/projects/{project}/global/networks/{network} . + "networkUrl": "A String", # The fully qualified URL of the network that the load balancer is attached to. This should be formatted like `https://www.googleapis.com/compute/v1/projects/{project}/global/networks/{network}`. "port": "A String", # The configured port of the load balancer. "project": "A String", # The project ID in which the load balancer is located. "region": "A String", # The region in which the load balancer is located. @@ -378,7 +378,7 @@

Method Details

"rrdatas": [ "A String", ], - "signatureRrdatas": [ # DNSSEC generated signatures for all the rrdata within this item. If health checked targets are provided for DNSSEC enabled zones, there's a restriction of 1 IP address per item. + "signatureRrdatas": [ # DNSSEC generated signatures for all the `rrdata` within this item. If health checked targets are provided for DNSSEC enabled zones, there's a restriction of 1 IP address per item. "A String", ], }, @@ -387,18 +387,18 @@

Method Details

}, "kind": "dns#rRSetRoutingPolicy", "primaryBackup": { # Configures a RRSetRoutingPolicy such that all queries are responded with the primary_targets if they are healthy. And if all of them are unhealthy, then we fallback to a geo localized policy. - "backupGeoTargets": { # Configures a RRSetRoutingPolicy that routes based on the geo location of the querying user. # Backup targets provide a regional failover policy for the otherwise global primary targets. If serving state is set to BACKUP, this policy essentially becomes a geo routing policy. + "backupGeoTargets": { # Configures a `RRSetRoutingPolicy` that routes based on the geo location of the querying user. # Backup targets provide a regional failover policy for the otherwise global primary targets. If serving state is set to `BACKUP`, this policy essentially becomes a geo routing policy. "enableFencing": True or False, # Without fencing, if health check fails for all configured items in the current geo bucket, we failover to the next nearest geo bucket. With fencing, if health checking is enabled, as long as some targets in the current geo bucket are healthy, we return only the healthy targets. However, if all targets are unhealthy, we don't failover to the next nearest bucket; instead, we return all the items in the current bucket even when all targets are unhealthy. "items": [ # The primary geo routing configuration. If there are multiple items with the same location, an error is returned instead. { # ResourceRecordSet data for one geo location. - "healthCheckedTargets": { # HealthCheckTargets describes endpoints to health-check when responding to Routing Policy queries. Only the healthy endpoints will be included in the response. Only one of internal_load_balancer and external_endpoints should be set. # For A and AAAA types only. Endpoints to return in the query result only if they are healthy. These can be specified along with rrdata within this item. + "healthCheckedTargets": { # HealthCheckTargets describes endpoints to health-check when responding to Routing Policy queries. Only the healthy endpoints will be included in the response. # For A and AAAA types only. Endpoints to return in the query result only if they are healthy. These can be specified along with `rrdata` within this item. "internalLoadBalancers": [ # Configuration for internal load balancers to be health checked. { # The configuration for an individual load balancer to health check. "ipAddress": "A String", # The frontend IP address of the load balancer to health check. "ipProtocol": "A String", # The protocol of the load balancer to health check. "kind": "dns#rRSetRoutingPolicyLoadBalancerTarget", "loadBalancerType": "A String", # The type of load balancer specified by this target. This value must match the configuration of the load balancer located at the LoadBalancerTarget's IP address, port, and region. Use the following: - *regionalL4ilb*: for a regional internal passthrough Network Load Balancer. - *regionalL7ilb*: for a regional internal Application Load Balancer. - *globalL7ilb*: for a global internal Application Load Balancer. - "networkUrl": "A String", # The fully qualified URL of the network that the load balancer is attached to. This should be formatted like https://www.googleapis.com/compute/v1/projects/{project}/global/networks/{network} . + "networkUrl": "A String", # The fully qualified URL of the network that the load balancer is attached to. This should be formatted like `https://www.googleapis.com/compute/v1/projects/{project}/global/networks/{network}`. "port": "A String", # The configured port of the load balancer. "project": "A String", # The project ID in which the load balancer is located. "region": "A String", # The region in which the load balancer is located. @@ -410,7 +410,7 @@

Method Details

"rrdatas": [ "A String", ], - "signatureRrdatas": [ # DNSSEC generated signatures for all the rrdata within this item. If health checked targets are provided for DNSSEC enabled zones, there's a restriction of 1 IP address per item. + "signatureRrdatas": [ # DNSSEC generated signatures for all the `rrdata` within this item. If health checked targets are provided for DNSSEC enabled zones, there's a restriction of 1 IP address per item. "A String", ], }, @@ -418,33 +418,33 @@

Method Details

"kind": "dns#rRSetRoutingPolicyGeoPolicy", }, "kind": "dns#rRSetRoutingPolicyPrimaryBackupPolicy", - "primaryTargets": { # HealthCheckTargets describes endpoints to health-check when responding to Routing Policy queries. Only the healthy endpoints will be included in the response. Only one of internal_load_balancer and external_endpoints should be set. # Endpoints that are health checked before making the routing decision. Unhealthy endpoints are omitted from the results. If all endpoints are unhealthy, we serve a response based on the backup_geo_targets. + "primaryTargets": { # HealthCheckTargets describes endpoints to health-check when responding to Routing Policy queries. Only the healthy endpoints will be included in the response. # Endpoints that are health checked before making the routing decision. Unhealthy endpoints are omitted from the results. If all endpoints are unhealthy, we serve a response based on the `backup_geo_targets`. "internalLoadBalancers": [ # Configuration for internal load balancers to be health checked. { # The configuration for an individual load balancer to health check. "ipAddress": "A String", # The frontend IP address of the load balancer to health check. "ipProtocol": "A String", # The protocol of the load balancer to health check. "kind": "dns#rRSetRoutingPolicyLoadBalancerTarget", "loadBalancerType": "A String", # The type of load balancer specified by this target. This value must match the configuration of the load balancer located at the LoadBalancerTarget's IP address, port, and region. Use the following: - *regionalL4ilb*: for a regional internal passthrough Network Load Balancer. - *regionalL7ilb*: for a regional internal Application Load Balancer. - *globalL7ilb*: for a global internal Application Load Balancer. - "networkUrl": "A String", # The fully qualified URL of the network that the load balancer is attached to. This should be formatted like https://www.googleapis.com/compute/v1/projects/{project}/global/networks/{network} . + "networkUrl": "A String", # The fully qualified URL of the network that the load balancer is attached to. This should be formatted like `https://www.googleapis.com/compute/v1/projects/{project}/global/networks/{network}`. "port": "A String", # The configured port of the load balancer. "project": "A String", # The project ID in which the load balancer is located. "region": "A String", # The region in which the load balancer is located. }, ], }, - "trickleTraffic": 3.14, # When serving state is PRIMARY, this field provides the option of sending a small percentage of the traffic to the backup targets. + "trickleTraffic": 3.14, # When serving state is `PRIMARY`, this field provides the option of sending a small percentage of the traffic to the backup targets. }, "wrr": { # Configures a RRSetRoutingPolicy that routes in a weighted round robin fashion. "items": [ { # A routing block which contains the routing information for one WRR item. - "healthCheckedTargets": { # HealthCheckTargets describes endpoints to health-check when responding to Routing Policy queries. Only the healthy endpoints will be included in the response. Only one of internal_load_balancer and external_endpoints should be set. # Endpoints that are health checked before making the routing decision. The unhealthy endpoints are omitted from the result. If all endpoints within a bucket are unhealthy, we choose a different bucket (sampled with respect to its weight) for responding. If DNSSEC is enabled for this zone, only one of rrdata or health_checked_targets can be set. + "healthCheckedTargets": { # HealthCheckTargets describes endpoints to health-check when responding to Routing Policy queries. Only the healthy endpoints will be included in the response. # Endpoints that are health checked before making the routing decision. The unhealthy endpoints are omitted from the result. If all endpoints within a bucket are unhealthy, we choose a different bucket (sampled with respect to its weight) for responding. If DNSSEC is enabled for this zone, only one of `rrdata` or `health_checked_targets` can be set. "internalLoadBalancers": [ # Configuration for internal load balancers to be health checked. { # The configuration for an individual load balancer to health check. "ipAddress": "A String", # The frontend IP address of the load balancer to health check. "ipProtocol": "A String", # The protocol of the load balancer to health check. "kind": "dns#rRSetRoutingPolicyLoadBalancerTarget", "loadBalancerType": "A String", # The type of load balancer specified by this target. This value must match the configuration of the load balancer located at the LoadBalancerTarget's IP address, port, and region. Use the following: - *regionalL4ilb*: for a regional internal passthrough Network Load Balancer. - *regionalL7ilb*: for a regional internal Application Load Balancer. - *globalL7ilb*: for a global internal Application Load Balancer. - "networkUrl": "A String", # The fully qualified URL of the network that the load balancer is attached to. This should be formatted like https://www.googleapis.com/compute/v1/projects/{project}/global/networks/{network} . + "networkUrl": "A String", # The fully qualified URL of the network that the load balancer is attached to. This should be formatted like `https://www.googleapis.com/compute/v1/projects/{project}/global/networks/{network}`. "port": "A String", # The configured port of the load balancer. "project": "A String", # The project ID in which the load balancer is located. "region": "A String", # The region in which the load balancer is located. @@ -455,10 +455,10 @@

Method Details

"rrdatas": [ "A String", ], - "signatureRrdatas": [ # DNSSEC generated signatures for all the rrdata within this item. Note that if health checked targets are provided for DNSSEC enabled zones, there's a restriction of 1 IP address per item. + "signatureRrdatas": [ # DNSSEC generated signatures for all the `rrdata` within this item. Note that if health checked targets are provided for DNSSEC enabled zones, there's a restriction of 1 IP address per item. "A String", ], - "weight": 3.14, # The weight corresponding to this WrrPolicyItem object. When multiple WrrPolicyItem objects are configured, the probability of returning an WrrPolicyItem object's data is proportional to its weight relative to the sum of weights configured for all items. This weight must be non-negative. + "weight": 3.14, # The weight corresponding to this `WrrPolicyItem` object. When multiple `WrrPolicyItem` objects are configured, the probability of returning an `WrrPolicyItem` object's data is proportional to its weight relative to the sum of weights configured for all items. This weight must be non-negative. }, ], "kind": "dns#rRSetRoutingPolicyWrrPolicy", @@ -466,14 +466,14 @@

Method Details

"wrrPolicy": { # Configures a RRSetRoutingPolicy that routes in a weighted round robin fashion. "items": [ { # A routing block which contains the routing information for one WRR item. - "healthCheckedTargets": { # HealthCheckTargets describes endpoints to health-check when responding to Routing Policy queries. Only the healthy endpoints will be included in the response. Only one of internal_load_balancer and external_endpoints should be set. # Endpoints that are health checked before making the routing decision. The unhealthy endpoints are omitted from the result. If all endpoints within a bucket are unhealthy, we choose a different bucket (sampled with respect to its weight) for responding. If DNSSEC is enabled for this zone, only one of rrdata or health_checked_targets can be set. + "healthCheckedTargets": { # HealthCheckTargets describes endpoints to health-check when responding to Routing Policy queries. Only the healthy endpoints will be included in the response. # Endpoints that are health checked before making the routing decision. The unhealthy endpoints are omitted from the result. If all endpoints within a bucket are unhealthy, we choose a different bucket (sampled with respect to its weight) for responding. If DNSSEC is enabled for this zone, only one of `rrdata` or `health_checked_targets` can be set. "internalLoadBalancers": [ # Configuration for internal load balancers to be health checked. { # The configuration for an individual load balancer to health check. "ipAddress": "A String", # The frontend IP address of the load balancer to health check. "ipProtocol": "A String", # The protocol of the load balancer to health check. "kind": "dns#rRSetRoutingPolicyLoadBalancerTarget", "loadBalancerType": "A String", # The type of load balancer specified by this target. This value must match the configuration of the load balancer located at the LoadBalancerTarget's IP address, port, and region. Use the following: - *regionalL4ilb*: for a regional internal passthrough Network Load Balancer. - *regionalL7ilb*: for a regional internal Application Load Balancer. - *globalL7ilb*: for a global internal Application Load Balancer. - "networkUrl": "A String", # The fully qualified URL of the network that the load balancer is attached to. This should be formatted like https://www.googleapis.com/compute/v1/projects/{project}/global/networks/{network} . + "networkUrl": "A String", # The fully qualified URL of the network that the load balancer is attached to. This should be formatted like `https://www.googleapis.com/compute/v1/projects/{project}/global/networks/{network}`. "port": "A String", # The configured port of the load balancer. "project": "A String", # The project ID in which the load balancer is located. "region": "A String", # The region in which the load balancer is located. @@ -484,10 +484,10 @@

Method Details

"rrdatas": [ "A String", ], - "signatureRrdatas": [ # DNSSEC generated signatures for all the rrdata within this item. Note that if health checked targets are provided for DNSSEC enabled zones, there's a restriction of 1 IP address per item. + "signatureRrdatas": [ # DNSSEC generated signatures for all the `rrdata` within this item. Note that if health checked targets are provided for DNSSEC enabled zones, there's a restriction of 1 IP address per item. "A String", ], - "weight": 3.14, # The weight corresponding to this WrrPolicyItem object. When multiple WrrPolicyItem objects are configured, the probability of returning an WrrPolicyItem object's data is proportional to its weight relative to the sum of weights configured for all items. This weight must be non-negative. + "weight": 3.14, # The weight corresponding to this `WrrPolicyItem` object. When multiple `WrrPolicyItem` objects are configured, the probability of returning an `WrrPolicyItem` object's data is proportional to its weight relative to the sum of weights configured for all items. This weight must be non-negative. }, ], "kind": "dns#rRSetRoutingPolicyWrrPolicy", @@ -499,7 +499,7 @@

Method Details

"signatureRrdatas": [ # As defined in RFC 4034 (section 3.2). "A String", ], - "ttl": 42, # Number of seconds that this ResourceRecordSet can be cached by resolvers. + "ttl": 42, # Number of seconds that this `ResourceRecordSet` can be cached by resolvers. "type": "A String", # The identifier of a supported record type. See the list of Supported DNS record types. }, ], @@ -550,19 +550,19 @@

Method Details

{ # A unit of data that is returned by the DNS servers. "kind": "dns#resourceRecordSet", "name": "A String", # For example, www.example.com. - "routingPolicy": { # A RRSetRoutingPolicy represents ResourceRecordSet data that is returned dynamically with the response varying based on configured properties such as geolocation or by weighted random selection. # Configures dynamic query responses based on either the geo location of the querying user or a weighted round robin based routing policy. A valid ResourceRecordSet contains only rrdata (for static resolution) or a routing_policy (for dynamic resolution). - "geo": { # Configures a RRSetRoutingPolicy that routes based on the geo location of the querying user. + "routingPolicy": { # A RRSetRoutingPolicy represents ResourceRecordSet data that is returned dynamically with the response varying based on configured properties such as geolocation or by weighted random selection. # Configures dynamic query responses based on either the geo location of the querying user or a weighted round robin based routing policy. A valid `ResourceRecordSet` contains only `rrdata` (for static resolution) or a `routing_policy` (for dynamic resolution). + "geo": { # Configures a `RRSetRoutingPolicy` that routes based on the geo location of the querying user. "enableFencing": True or False, # Without fencing, if health check fails for all configured items in the current geo bucket, we failover to the next nearest geo bucket. With fencing, if health checking is enabled, as long as some targets in the current geo bucket are healthy, we return only the healthy targets. However, if all targets are unhealthy, we don't failover to the next nearest bucket; instead, we return all the items in the current bucket even when all targets are unhealthy. "items": [ # The primary geo routing configuration. If there are multiple items with the same location, an error is returned instead. { # ResourceRecordSet data for one geo location. - "healthCheckedTargets": { # HealthCheckTargets describes endpoints to health-check when responding to Routing Policy queries. Only the healthy endpoints will be included in the response. Only one of internal_load_balancer and external_endpoints should be set. # For A and AAAA types only. Endpoints to return in the query result only if they are healthy. These can be specified along with rrdata within this item. + "healthCheckedTargets": { # HealthCheckTargets describes endpoints to health-check when responding to Routing Policy queries. Only the healthy endpoints will be included in the response. # For A and AAAA types only. Endpoints to return in the query result only if they are healthy. These can be specified along with `rrdata` within this item. "internalLoadBalancers": [ # Configuration for internal load balancers to be health checked. { # The configuration for an individual load balancer to health check. "ipAddress": "A String", # The frontend IP address of the load balancer to health check. "ipProtocol": "A String", # The protocol of the load balancer to health check. "kind": "dns#rRSetRoutingPolicyLoadBalancerTarget", "loadBalancerType": "A String", # The type of load balancer specified by this target. This value must match the configuration of the load balancer located at the LoadBalancerTarget's IP address, port, and region. Use the following: - *regionalL4ilb*: for a regional internal passthrough Network Load Balancer. - *regionalL7ilb*: for a regional internal Application Load Balancer. - *globalL7ilb*: for a global internal Application Load Balancer. - "networkUrl": "A String", # The fully qualified URL of the network that the load balancer is attached to. This should be formatted like https://www.googleapis.com/compute/v1/projects/{project}/global/networks/{network} . + "networkUrl": "A String", # The fully qualified URL of the network that the load balancer is attached to. This should be formatted like `https://www.googleapis.com/compute/v1/projects/{project}/global/networks/{network}`. "port": "A String", # The configured port of the load balancer. "project": "A String", # The project ID in which the load balancer is located. "region": "A String", # The region in which the load balancer is located. @@ -574,25 +574,25 @@

Method Details

"rrdatas": [ "A String", ], - "signatureRrdatas": [ # DNSSEC generated signatures for all the rrdata within this item. If health checked targets are provided for DNSSEC enabled zones, there's a restriction of 1 IP address per item. + "signatureRrdatas": [ # DNSSEC generated signatures for all the `rrdata` within this item. If health checked targets are provided for DNSSEC enabled zones, there's a restriction of 1 IP address per item. "A String", ], }, ], "kind": "dns#rRSetRoutingPolicyGeoPolicy", }, - "geoPolicy": { # Configures a RRSetRoutingPolicy that routes based on the geo location of the querying user. + "geoPolicy": { # Configures a `RRSetRoutingPolicy` that routes based on the geo location of the querying user. "enableFencing": True or False, # Without fencing, if health check fails for all configured items in the current geo bucket, we failover to the next nearest geo bucket. With fencing, if health checking is enabled, as long as some targets in the current geo bucket are healthy, we return only the healthy targets. However, if all targets are unhealthy, we don't failover to the next nearest bucket; instead, we return all the items in the current bucket even when all targets are unhealthy. "items": [ # The primary geo routing configuration. If there are multiple items with the same location, an error is returned instead. { # ResourceRecordSet data for one geo location. - "healthCheckedTargets": { # HealthCheckTargets describes endpoints to health-check when responding to Routing Policy queries. Only the healthy endpoints will be included in the response. Only one of internal_load_balancer and external_endpoints should be set. # For A and AAAA types only. Endpoints to return in the query result only if they are healthy. These can be specified along with rrdata within this item. + "healthCheckedTargets": { # HealthCheckTargets describes endpoints to health-check when responding to Routing Policy queries. Only the healthy endpoints will be included in the response. # For A and AAAA types only. Endpoints to return in the query result only if they are healthy. These can be specified along with `rrdata` within this item. "internalLoadBalancers": [ # Configuration for internal load balancers to be health checked. { # The configuration for an individual load balancer to health check. "ipAddress": "A String", # The frontend IP address of the load balancer to health check. "ipProtocol": "A String", # The protocol of the load balancer to health check. "kind": "dns#rRSetRoutingPolicyLoadBalancerTarget", "loadBalancerType": "A String", # The type of load balancer specified by this target. This value must match the configuration of the load balancer located at the LoadBalancerTarget's IP address, port, and region. Use the following: - *regionalL4ilb*: for a regional internal passthrough Network Load Balancer. - *regionalL7ilb*: for a regional internal Application Load Balancer. - *globalL7ilb*: for a global internal Application Load Balancer. - "networkUrl": "A String", # The fully qualified URL of the network that the load balancer is attached to. This should be formatted like https://www.googleapis.com/compute/v1/projects/{project}/global/networks/{network} . + "networkUrl": "A String", # The fully qualified URL of the network that the load balancer is attached to. This should be formatted like `https://www.googleapis.com/compute/v1/projects/{project}/global/networks/{network}`. "port": "A String", # The configured port of the load balancer. "project": "A String", # The project ID in which the load balancer is located. "region": "A String", # The region in which the load balancer is located. @@ -604,7 +604,7 @@

Method Details

"rrdatas": [ "A String", ], - "signatureRrdatas": [ # DNSSEC generated signatures for all the rrdata within this item. If health checked targets are provided for DNSSEC enabled zones, there's a restriction of 1 IP address per item. + "signatureRrdatas": [ # DNSSEC generated signatures for all the `rrdata` within this item. If health checked targets are provided for DNSSEC enabled zones, there's a restriction of 1 IP address per item. "A String", ], }, @@ -613,18 +613,18 @@

Method Details

}, "kind": "dns#rRSetRoutingPolicy", "primaryBackup": { # Configures a RRSetRoutingPolicy such that all queries are responded with the primary_targets if they are healthy. And if all of them are unhealthy, then we fallback to a geo localized policy. - "backupGeoTargets": { # Configures a RRSetRoutingPolicy that routes based on the geo location of the querying user. # Backup targets provide a regional failover policy for the otherwise global primary targets. If serving state is set to BACKUP, this policy essentially becomes a geo routing policy. + "backupGeoTargets": { # Configures a `RRSetRoutingPolicy` that routes based on the geo location of the querying user. # Backup targets provide a regional failover policy for the otherwise global primary targets. If serving state is set to `BACKUP`, this policy essentially becomes a geo routing policy. "enableFencing": True or False, # Without fencing, if health check fails for all configured items in the current geo bucket, we failover to the next nearest geo bucket. With fencing, if health checking is enabled, as long as some targets in the current geo bucket are healthy, we return only the healthy targets. However, if all targets are unhealthy, we don't failover to the next nearest bucket; instead, we return all the items in the current bucket even when all targets are unhealthy. "items": [ # The primary geo routing configuration. If there are multiple items with the same location, an error is returned instead. { # ResourceRecordSet data for one geo location. - "healthCheckedTargets": { # HealthCheckTargets describes endpoints to health-check when responding to Routing Policy queries. Only the healthy endpoints will be included in the response. Only one of internal_load_balancer and external_endpoints should be set. # For A and AAAA types only. Endpoints to return in the query result only if they are healthy. These can be specified along with rrdata within this item. + "healthCheckedTargets": { # HealthCheckTargets describes endpoints to health-check when responding to Routing Policy queries. Only the healthy endpoints will be included in the response. # For A and AAAA types only. Endpoints to return in the query result only if they are healthy. These can be specified along with `rrdata` within this item. "internalLoadBalancers": [ # Configuration for internal load balancers to be health checked. { # The configuration for an individual load balancer to health check. "ipAddress": "A String", # The frontend IP address of the load balancer to health check. "ipProtocol": "A String", # The protocol of the load balancer to health check. "kind": "dns#rRSetRoutingPolicyLoadBalancerTarget", "loadBalancerType": "A String", # The type of load balancer specified by this target. This value must match the configuration of the load balancer located at the LoadBalancerTarget's IP address, port, and region. Use the following: - *regionalL4ilb*: for a regional internal passthrough Network Load Balancer. - *regionalL7ilb*: for a regional internal Application Load Balancer. - *globalL7ilb*: for a global internal Application Load Balancer. - "networkUrl": "A String", # The fully qualified URL of the network that the load balancer is attached to. This should be formatted like https://www.googleapis.com/compute/v1/projects/{project}/global/networks/{network} . + "networkUrl": "A String", # The fully qualified URL of the network that the load balancer is attached to. This should be formatted like `https://www.googleapis.com/compute/v1/projects/{project}/global/networks/{network}`. "port": "A String", # The configured port of the load balancer. "project": "A String", # The project ID in which the load balancer is located. "region": "A String", # The region in which the load balancer is located. @@ -636,7 +636,7 @@

Method Details

"rrdatas": [ "A String", ], - "signatureRrdatas": [ # DNSSEC generated signatures for all the rrdata within this item. If health checked targets are provided for DNSSEC enabled zones, there's a restriction of 1 IP address per item. + "signatureRrdatas": [ # DNSSEC generated signatures for all the `rrdata` within this item. If health checked targets are provided for DNSSEC enabled zones, there's a restriction of 1 IP address per item. "A String", ], }, @@ -644,33 +644,33 @@

Method Details

"kind": "dns#rRSetRoutingPolicyGeoPolicy", }, "kind": "dns#rRSetRoutingPolicyPrimaryBackupPolicy", - "primaryTargets": { # HealthCheckTargets describes endpoints to health-check when responding to Routing Policy queries. Only the healthy endpoints will be included in the response. Only one of internal_load_balancer and external_endpoints should be set. # Endpoints that are health checked before making the routing decision. Unhealthy endpoints are omitted from the results. If all endpoints are unhealthy, we serve a response based on the backup_geo_targets. + "primaryTargets": { # HealthCheckTargets describes endpoints to health-check when responding to Routing Policy queries. Only the healthy endpoints will be included in the response. # Endpoints that are health checked before making the routing decision. Unhealthy endpoints are omitted from the results. If all endpoints are unhealthy, we serve a response based on the `backup_geo_targets`. "internalLoadBalancers": [ # Configuration for internal load balancers to be health checked. { # The configuration for an individual load balancer to health check. "ipAddress": "A String", # The frontend IP address of the load balancer to health check. "ipProtocol": "A String", # The protocol of the load balancer to health check. "kind": "dns#rRSetRoutingPolicyLoadBalancerTarget", "loadBalancerType": "A String", # The type of load balancer specified by this target. This value must match the configuration of the load balancer located at the LoadBalancerTarget's IP address, port, and region. Use the following: - *regionalL4ilb*: for a regional internal passthrough Network Load Balancer. - *regionalL7ilb*: for a regional internal Application Load Balancer. - *globalL7ilb*: for a global internal Application Load Balancer. - "networkUrl": "A String", # The fully qualified URL of the network that the load balancer is attached to. This should be formatted like https://www.googleapis.com/compute/v1/projects/{project}/global/networks/{network} . + "networkUrl": "A String", # The fully qualified URL of the network that the load balancer is attached to. This should be formatted like `https://www.googleapis.com/compute/v1/projects/{project}/global/networks/{network}`. "port": "A String", # The configured port of the load balancer. "project": "A String", # The project ID in which the load balancer is located. "region": "A String", # The region in which the load balancer is located. }, ], }, - "trickleTraffic": 3.14, # When serving state is PRIMARY, this field provides the option of sending a small percentage of the traffic to the backup targets. + "trickleTraffic": 3.14, # When serving state is `PRIMARY`, this field provides the option of sending a small percentage of the traffic to the backup targets. }, "wrr": { # Configures a RRSetRoutingPolicy that routes in a weighted round robin fashion. "items": [ { # A routing block which contains the routing information for one WRR item. - "healthCheckedTargets": { # HealthCheckTargets describes endpoints to health-check when responding to Routing Policy queries. Only the healthy endpoints will be included in the response. Only one of internal_load_balancer and external_endpoints should be set. # Endpoints that are health checked before making the routing decision. The unhealthy endpoints are omitted from the result. If all endpoints within a bucket are unhealthy, we choose a different bucket (sampled with respect to its weight) for responding. If DNSSEC is enabled for this zone, only one of rrdata or health_checked_targets can be set. + "healthCheckedTargets": { # HealthCheckTargets describes endpoints to health-check when responding to Routing Policy queries. Only the healthy endpoints will be included in the response. # Endpoints that are health checked before making the routing decision. The unhealthy endpoints are omitted from the result. If all endpoints within a bucket are unhealthy, we choose a different bucket (sampled with respect to its weight) for responding. If DNSSEC is enabled for this zone, only one of `rrdata` or `health_checked_targets` can be set. "internalLoadBalancers": [ # Configuration for internal load balancers to be health checked. { # The configuration for an individual load balancer to health check. "ipAddress": "A String", # The frontend IP address of the load balancer to health check. "ipProtocol": "A String", # The protocol of the load balancer to health check. "kind": "dns#rRSetRoutingPolicyLoadBalancerTarget", "loadBalancerType": "A String", # The type of load balancer specified by this target. This value must match the configuration of the load balancer located at the LoadBalancerTarget's IP address, port, and region. Use the following: - *regionalL4ilb*: for a regional internal passthrough Network Load Balancer. - *regionalL7ilb*: for a regional internal Application Load Balancer. - *globalL7ilb*: for a global internal Application Load Balancer. - "networkUrl": "A String", # The fully qualified URL of the network that the load balancer is attached to. This should be formatted like https://www.googleapis.com/compute/v1/projects/{project}/global/networks/{network} . + "networkUrl": "A String", # The fully qualified URL of the network that the load balancer is attached to. This should be formatted like `https://www.googleapis.com/compute/v1/projects/{project}/global/networks/{network}`. "port": "A String", # The configured port of the load balancer. "project": "A String", # The project ID in which the load balancer is located. "region": "A String", # The region in which the load balancer is located. @@ -681,10 +681,10 @@

Method Details

"rrdatas": [ "A String", ], - "signatureRrdatas": [ # DNSSEC generated signatures for all the rrdata within this item. Note that if health checked targets are provided for DNSSEC enabled zones, there's a restriction of 1 IP address per item. + "signatureRrdatas": [ # DNSSEC generated signatures for all the `rrdata` within this item. Note that if health checked targets are provided for DNSSEC enabled zones, there's a restriction of 1 IP address per item. "A String", ], - "weight": 3.14, # The weight corresponding to this WrrPolicyItem object. When multiple WrrPolicyItem objects are configured, the probability of returning an WrrPolicyItem object's data is proportional to its weight relative to the sum of weights configured for all items. This weight must be non-negative. + "weight": 3.14, # The weight corresponding to this `WrrPolicyItem` object. When multiple `WrrPolicyItem` objects are configured, the probability of returning an `WrrPolicyItem` object's data is proportional to its weight relative to the sum of weights configured for all items. This weight must be non-negative. }, ], "kind": "dns#rRSetRoutingPolicyWrrPolicy", @@ -692,14 +692,14 @@

Method Details

"wrrPolicy": { # Configures a RRSetRoutingPolicy that routes in a weighted round robin fashion. "items": [ { # A routing block which contains the routing information for one WRR item. - "healthCheckedTargets": { # HealthCheckTargets describes endpoints to health-check when responding to Routing Policy queries. Only the healthy endpoints will be included in the response. Only one of internal_load_balancer and external_endpoints should be set. # Endpoints that are health checked before making the routing decision. The unhealthy endpoints are omitted from the result. If all endpoints within a bucket are unhealthy, we choose a different bucket (sampled with respect to its weight) for responding. If DNSSEC is enabled for this zone, only one of rrdata or health_checked_targets can be set. + "healthCheckedTargets": { # HealthCheckTargets describes endpoints to health-check when responding to Routing Policy queries. Only the healthy endpoints will be included in the response. # Endpoints that are health checked before making the routing decision. The unhealthy endpoints are omitted from the result. If all endpoints within a bucket are unhealthy, we choose a different bucket (sampled with respect to its weight) for responding. If DNSSEC is enabled for this zone, only one of `rrdata` or `health_checked_targets` can be set. "internalLoadBalancers": [ # Configuration for internal load balancers to be health checked. { # The configuration for an individual load balancer to health check. "ipAddress": "A String", # The frontend IP address of the load balancer to health check. "ipProtocol": "A String", # The protocol of the load balancer to health check. "kind": "dns#rRSetRoutingPolicyLoadBalancerTarget", "loadBalancerType": "A String", # The type of load balancer specified by this target. This value must match the configuration of the load balancer located at the LoadBalancerTarget's IP address, port, and region. Use the following: - *regionalL4ilb*: for a regional internal passthrough Network Load Balancer. - *regionalL7ilb*: for a regional internal Application Load Balancer. - *globalL7ilb*: for a global internal Application Load Balancer. - "networkUrl": "A String", # The fully qualified URL of the network that the load balancer is attached to. This should be formatted like https://www.googleapis.com/compute/v1/projects/{project}/global/networks/{network} . + "networkUrl": "A String", # The fully qualified URL of the network that the load balancer is attached to. This should be formatted like `https://www.googleapis.com/compute/v1/projects/{project}/global/networks/{network}`. "port": "A String", # The configured port of the load balancer. "project": "A String", # The project ID in which the load balancer is located. "region": "A String", # The region in which the load balancer is located. @@ -710,10 +710,10 @@

Method Details

"rrdatas": [ "A String", ], - "signatureRrdatas": [ # DNSSEC generated signatures for all the rrdata within this item. Note that if health checked targets are provided for DNSSEC enabled zones, there's a restriction of 1 IP address per item. + "signatureRrdatas": [ # DNSSEC generated signatures for all the `rrdata` within this item. Note that if health checked targets are provided for DNSSEC enabled zones, there's a restriction of 1 IP address per item. "A String", ], - "weight": 3.14, # The weight corresponding to this WrrPolicyItem object. When multiple WrrPolicyItem objects are configured, the probability of returning an WrrPolicyItem object's data is proportional to its weight relative to the sum of weights configured for all items. This weight must be non-negative. + "weight": 3.14, # The weight corresponding to this `WrrPolicyItem` object. When multiple `WrrPolicyItem` objects are configured, the probability of returning an `WrrPolicyItem` object's data is proportional to its weight relative to the sum of weights configured for all items. This weight must be non-negative. }, ], "kind": "dns#rRSetRoutingPolicyWrrPolicy", @@ -725,7 +725,7 @@

Method Details

"signatureRrdatas": [ # As defined in RFC 4034 (section 3.2). "A String", ], - "ttl": 42, # Number of seconds that this ResourceRecordSet can be cached by resolvers. + "ttl": 42, # Number of seconds that this `ResourceRecordSet` can be cached by resolvers. "type": "A String", # The identifier of a supported record type. See the list of Supported DNS record types. }, ], @@ -752,10 +752,7 @@

Method Details

An object of the form: { - "header": { # Elements common to every response. - "operationId": "A String", # For mutating operation requests that completed successfully. This is the client_operation_id if the client specified it, otherwise it is generated by the server (output only). - }, - "nextPageToken": "A String", # The presence of this field indicates that there exist more results following your last page of results in pagination order. To fetch them, make another list request using this value as your page token. This lets you the complete contents of even very large collections one page at a time. However, if the contents of the collection change between the first and last paginated list request, the set of all elements returned are an inconsistent view of the collection. You cannot retrieve a consistent snapshot of a collection larger than the maximum page size. + "nextPageToken": "A String", # This field indicates that more results are available beyond the last page displayed. To fetch the results, make another list request and use this value as your page token. This lets you retrieve the complete contents of a very large collection one page at a time. However, if the contents of the collection change between the first and last paginated list request, the set of all elements returned are an inconsistent view of the collection. You can't retrieve a consistent snapshot of a collection larger than the maximum page size. "responsePolicyRules": [ # The Response Policy Rule resources. { # A Response Policy Rule is a selector that applies its behavior to queries that match the selector. Selectors are DNS names, which may be wildcards or exact matches. Each DNS query subject to a Response Policy matches at most one ResponsePolicyRule, as identified by the dns_name field with the longest matching suffix. "behavior": "A String", # Answer this query with a behavior rather than DNS data. @@ -766,19 +763,19 @@

Method Details

{ # A unit of data that is returned by the DNS servers. "kind": "dns#resourceRecordSet", "name": "A String", # For example, www.example.com. - "routingPolicy": { # A RRSetRoutingPolicy represents ResourceRecordSet data that is returned dynamically with the response varying based on configured properties such as geolocation or by weighted random selection. # Configures dynamic query responses based on either the geo location of the querying user or a weighted round robin based routing policy. A valid ResourceRecordSet contains only rrdata (for static resolution) or a routing_policy (for dynamic resolution). - "geo": { # Configures a RRSetRoutingPolicy that routes based on the geo location of the querying user. + "routingPolicy": { # A RRSetRoutingPolicy represents ResourceRecordSet data that is returned dynamically with the response varying based on configured properties such as geolocation or by weighted random selection. # Configures dynamic query responses based on either the geo location of the querying user or a weighted round robin based routing policy. A valid `ResourceRecordSet` contains only `rrdata` (for static resolution) or a `routing_policy` (for dynamic resolution). + "geo": { # Configures a `RRSetRoutingPolicy` that routes based on the geo location of the querying user. "enableFencing": True or False, # Without fencing, if health check fails for all configured items in the current geo bucket, we failover to the next nearest geo bucket. With fencing, if health checking is enabled, as long as some targets in the current geo bucket are healthy, we return only the healthy targets. However, if all targets are unhealthy, we don't failover to the next nearest bucket; instead, we return all the items in the current bucket even when all targets are unhealthy. "items": [ # The primary geo routing configuration. If there are multiple items with the same location, an error is returned instead. { # ResourceRecordSet data for one geo location. - "healthCheckedTargets": { # HealthCheckTargets describes endpoints to health-check when responding to Routing Policy queries. Only the healthy endpoints will be included in the response. Only one of internal_load_balancer and external_endpoints should be set. # For A and AAAA types only. Endpoints to return in the query result only if they are healthy. These can be specified along with rrdata within this item. + "healthCheckedTargets": { # HealthCheckTargets describes endpoints to health-check when responding to Routing Policy queries. Only the healthy endpoints will be included in the response. # For A and AAAA types only. Endpoints to return in the query result only if they are healthy. These can be specified along with `rrdata` within this item. "internalLoadBalancers": [ # Configuration for internal load balancers to be health checked. { # The configuration for an individual load balancer to health check. "ipAddress": "A String", # The frontend IP address of the load balancer to health check. "ipProtocol": "A String", # The protocol of the load balancer to health check. "kind": "dns#rRSetRoutingPolicyLoadBalancerTarget", "loadBalancerType": "A String", # The type of load balancer specified by this target. This value must match the configuration of the load balancer located at the LoadBalancerTarget's IP address, port, and region. Use the following: - *regionalL4ilb*: for a regional internal passthrough Network Load Balancer. - *regionalL7ilb*: for a regional internal Application Load Balancer. - *globalL7ilb*: for a global internal Application Load Balancer. - "networkUrl": "A String", # The fully qualified URL of the network that the load balancer is attached to. This should be formatted like https://www.googleapis.com/compute/v1/projects/{project}/global/networks/{network} . + "networkUrl": "A String", # The fully qualified URL of the network that the load balancer is attached to. This should be formatted like `https://www.googleapis.com/compute/v1/projects/{project}/global/networks/{network}`. "port": "A String", # The configured port of the load balancer. "project": "A String", # The project ID in which the load balancer is located. "region": "A String", # The region in which the load balancer is located. @@ -790,25 +787,25 @@

Method Details

"rrdatas": [ "A String", ], - "signatureRrdatas": [ # DNSSEC generated signatures for all the rrdata within this item. If health checked targets are provided for DNSSEC enabled zones, there's a restriction of 1 IP address per item. + "signatureRrdatas": [ # DNSSEC generated signatures for all the `rrdata` within this item. If health checked targets are provided for DNSSEC enabled zones, there's a restriction of 1 IP address per item. "A String", ], }, ], "kind": "dns#rRSetRoutingPolicyGeoPolicy", }, - "geoPolicy": { # Configures a RRSetRoutingPolicy that routes based on the geo location of the querying user. + "geoPolicy": { # Configures a `RRSetRoutingPolicy` that routes based on the geo location of the querying user. "enableFencing": True or False, # Without fencing, if health check fails for all configured items in the current geo bucket, we failover to the next nearest geo bucket. With fencing, if health checking is enabled, as long as some targets in the current geo bucket are healthy, we return only the healthy targets. However, if all targets are unhealthy, we don't failover to the next nearest bucket; instead, we return all the items in the current bucket even when all targets are unhealthy. "items": [ # The primary geo routing configuration. If there are multiple items with the same location, an error is returned instead. { # ResourceRecordSet data for one geo location. - "healthCheckedTargets": { # HealthCheckTargets describes endpoints to health-check when responding to Routing Policy queries. Only the healthy endpoints will be included in the response. Only one of internal_load_balancer and external_endpoints should be set. # For A and AAAA types only. Endpoints to return in the query result only if they are healthy. These can be specified along with rrdata within this item. + "healthCheckedTargets": { # HealthCheckTargets describes endpoints to health-check when responding to Routing Policy queries. Only the healthy endpoints will be included in the response. # For A and AAAA types only. Endpoints to return in the query result only if they are healthy. These can be specified along with `rrdata` within this item. "internalLoadBalancers": [ # Configuration for internal load balancers to be health checked. { # The configuration for an individual load balancer to health check. "ipAddress": "A String", # The frontend IP address of the load balancer to health check. "ipProtocol": "A String", # The protocol of the load balancer to health check. "kind": "dns#rRSetRoutingPolicyLoadBalancerTarget", "loadBalancerType": "A String", # The type of load balancer specified by this target. This value must match the configuration of the load balancer located at the LoadBalancerTarget's IP address, port, and region. Use the following: - *regionalL4ilb*: for a regional internal passthrough Network Load Balancer. - *regionalL7ilb*: for a regional internal Application Load Balancer. - *globalL7ilb*: for a global internal Application Load Balancer. - "networkUrl": "A String", # The fully qualified URL of the network that the load balancer is attached to. This should be formatted like https://www.googleapis.com/compute/v1/projects/{project}/global/networks/{network} . + "networkUrl": "A String", # The fully qualified URL of the network that the load balancer is attached to. This should be formatted like `https://www.googleapis.com/compute/v1/projects/{project}/global/networks/{network}`. "port": "A String", # The configured port of the load balancer. "project": "A String", # The project ID in which the load balancer is located. "region": "A String", # The region in which the load balancer is located. @@ -820,7 +817,7 @@

Method Details

"rrdatas": [ "A String", ], - "signatureRrdatas": [ # DNSSEC generated signatures for all the rrdata within this item. If health checked targets are provided for DNSSEC enabled zones, there's a restriction of 1 IP address per item. + "signatureRrdatas": [ # DNSSEC generated signatures for all the `rrdata` within this item. If health checked targets are provided for DNSSEC enabled zones, there's a restriction of 1 IP address per item. "A String", ], }, @@ -829,18 +826,18 @@

Method Details

}, "kind": "dns#rRSetRoutingPolicy", "primaryBackup": { # Configures a RRSetRoutingPolicy such that all queries are responded with the primary_targets if they are healthy. And if all of them are unhealthy, then we fallback to a geo localized policy. - "backupGeoTargets": { # Configures a RRSetRoutingPolicy that routes based on the geo location of the querying user. # Backup targets provide a regional failover policy for the otherwise global primary targets. If serving state is set to BACKUP, this policy essentially becomes a geo routing policy. + "backupGeoTargets": { # Configures a `RRSetRoutingPolicy` that routes based on the geo location of the querying user. # Backup targets provide a regional failover policy for the otherwise global primary targets. If serving state is set to `BACKUP`, this policy essentially becomes a geo routing policy. "enableFencing": True or False, # Without fencing, if health check fails for all configured items in the current geo bucket, we failover to the next nearest geo bucket. With fencing, if health checking is enabled, as long as some targets in the current geo bucket are healthy, we return only the healthy targets. However, if all targets are unhealthy, we don't failover to the next nearest bucket; instead, we return all the items in the current bucket even when all targets are unhealthy. "items": [ # The primary geo routing configuration. If there are multiple items with the same location, an error is returned instead. { # ResourceRecordSet data for one geo location. - "healthCheckedTargets": { # HealthCheckTargets describes endpoints to health-check when responding to Routing Policy queries. Only the healthy endpoints will be included in the response. Only one of internal_load_balancer and external_endpoints should be set. # For A and AAAA types only. Endpoints to return in the query result only if they are healthy. These can be specified along with rrdata within this item. + "healthCheckedTargets": { # HealthCheckTargets describes endpoints to health-check when responding to Routing Policy queries. Only the healthy endpoints will be included in the response. # For A and AAAA types only. Endpoints to return in the query result only if they are healthy. These can be specified along with `rrdata` within this item. "internalLoadBalancers": [ # Configuration for internal load balancers to be health checked. { # The configuration for an individual load balancer to health check. "ipAddress": "A String", # The frontend IP address of the load balancer to health check. "ipProtocol": "A String", # The protocol of the load balancer to health check. "kind": "dns#rRSetRoutingPolicyLoadBalancerTarget", "loadBalancerType": "A String", # The type of load balancer specified by this target. This value must match the configuration of the load balancer located at the LoadBalancerTarget's IP address, port, and region. Use the following: - *regionalL4ilb*: for a regional internal passthrough Network Load Balancer. - *regionalL7ilb*: for a regional internal Application Load Balancer. - *globalL7ilb*: for a global internal Application Load Balancer. - "networkUrl": "A String", # The fully qualified URL of the network that the load balancer is attached to. This should be formatted like https://www.googleapis.com/compute/v1/projects/{project}/global/networks/{network} . + "networkUrl": "A String", # The fully qualified URL of the network that the load balancer is attached to. This should be formatted like `https://www.googleapis.com/compute/v1/projects/{project}/global/networks/{network}`. "port": "A String", # The configured port of the load balancer. "project": "A String", # The project ID in which the load balancer is located. "region": "A String", # The region in which the load balancer is located. @@ -852,7 +849,7 @@

Method Details

"rrdatas": [ "A String", ], - "signatureRrdatas": [ # DNSSEC generated signatures for all the rrdata within this item. If health checked targets are provided for DNSSEC enabled zones, there's a restriction of 1 IP address per item. + "signatureRrdatas": [ # DNSSEC generated signatures for all the `rrdata` within this item. If health checked targets are provided for DNSSEC enabled zones, there's a restriction of 1 IP address per item. "A String", ], }, @@ -860,33 +857,33 @@

Method Details

"kind": "dns#rRSetRoutingPolicyGeoPolicy", }, "kind": "dns#rRSetRoutingPolicyPrimaryBackupPolicy", - "primaryTargets": { # HealthCheckTargets describes endpoints to health-check when responding to Routing Policy queries. Only the healthy endpoints will be included in the response. Only one of internal_load_balancer and external_endpoints should be set. # Endpoints that are health checked before making the routing decision. Unhealthy endpoints are omitted from the results. If all endpoints are unhealthy, we serve a response based on the backup_geo_targets. + "primaryTargets": { # HealthCheckTargets describes endpoints to health-check when responding to Routing Policy queries. Only the healthy endpoints will be included in the response. # Endpoints that are health checked before making the routing decision. Unhealthy endpoints are omitted from the results. If all endpoints are unhealthy, we serve a response based on the `backup_geo_targets`. "internalLoadBalancers": [ # Configuration for internal load balancers to be health checked. { # The configuration for an individual load balancer to health check. "ipAddress": "A String", # The frontend IP address of the load balancer to health check. "ipProtocol": "A String", # The protocol of the load balancer to health check. "kind": "dns#rRSetRoutingPolicyLoadBalancerTarget", "loadBalancerType": "A String", # The type of load balancer specified by this target. This value must match the configuration of the load balancer located at the LoadBalancerTarget's IP address, port, and region. Use the following: - *regionalL4ilb*: for a regional internal passthrough Network Load Balancer. - *regionalL7ilb*: for a regional internal Application Load Balancer. - *globalL7ilb*: for a global internal Application Load Balancer. - "networkUrl": "A String", # The fully qualified URL of the network that the load balancer is attached to. This should be formatted like https://www.googleapis.com/compute/v1/projects/{project}/global/networks/{network} . + "networkUrl": "A String", # The fully qualified URL of the network that the load balancer is attached to. This should be formatted like `https://www.googleapis.com/compute/v1/projects/{project}/global/networks/{network}`. "port": "A String", # The configured port of the load balancer. "project": "A String", # The project ID in which the load balancer is located. "region": "A String", # The region in which the load balancer is located. }, ], }, - "trickleTraffic": 3.14, # When serving state is PRIMARY, this field provides the option of sending a small percentage of the traffic to the backup targets. + "trickleTraffic": 3.14, # When serving state is `PRIMARY`, this field provides the option of sending a small percentage of the traffic to the backup targets. }, "wrr": { # Configures a RRSetRoutingPolicy that routes in a weighted round robin fashion. "items": [ { # A routing block which contains the routing information for one WRR item. - "healthCheckedTargets": { # HealthCheckTargets describes endpoints to health-check when responding to Routing Policy queries. Only the healthy endpoints will be included in the response. Only one of internal_load_balancer and external_endpoints should be set. # Endpoints that are health checked before making the routing decision. The unhealthy endpoints are omitted from the result. If all endpoints within a bucket are unhealthy, we choose a different bucket (sampled with respect to its weight) for responding. If DNSSEC is enabled for this zone, only one of rrdata or health_checked_targets can be set. + "healthCheckedTargets": { # HealthCheckTargets describes endpoints to health-check when responding to Routing Policy queries. Only the healthy endpoints will be included in the response. # Endpoints that are health checked before making the routing decision. The unhealthy endpoints are omitted from the result. If all endpoints within a bucket are unhealthy, we choose a different bucket (sampled with respect to its weight) for responding. If DNSSEC is enabled for this zone, only one of `rrdata` or `health_checked_targets` can be set. "internalLoadBalancers": [ # Configuration for internal load balancers to be health checked. { # The configuration for an individual load balancer to health check. "ipAddress": "A String", # The frontend IP address of the load balancer to health check. "ipProtocol": "A String", # The protocol of the load balancer to health check. "kind": "dns#rRSetRoutingPolicyLoadBalancerTarget", "loadBalancerType": "A String", # The type of load balancer specified by this target. This value must match the configuration of the load balancer located at the LoadBalancerTarget's IP address, port, and region. Use the following: - *regionalL4ilb*: for a regional internal passthrough Network Load Balancer. - *regionalL7ilb*: for a regional internal Application Load Balancer. - *globalL7ilb*: for a global internal Application Load Balancer. - "networkUrl": "A String", # The fully qualified URL of the network that the load balancer is attached to. This should be formatted like https://www.googleapis.com/compute/v1/projects/{project}/global/networks/{network} . + "networkUrl": "A String", # The fully qualified URL of the network that the load balancer is attached to. This should be formatted like `https://www.googleapis.com/compute/v1/projects/{project}/global/networks/{network}`. "port": "A String", # The configured port of the load balancer. "project": "A String", # The project ID in which the load balancer is located. "region": "A String", # The region in which the load balancer is located. @@ -897,10 +894,10 @@

Method Details

"rrdatas": [ "A String", ], - "signatureRrdatas": [ # DNSSEC generated signatures for all the rrdata within this item. Note that if health checked targets are provided for DNSSEC enabled zones, there's a restriction of 1 IP address per item. + "signatureRrdatas": [ # DNSSEC generated signatures for all the `rrdata` within this item. Note that if health checked targets are provided for DNSSEC enabled zones, there's a restriction of 1 IP address per item. "A String", ], - "weight": 3.14, # The weight corresponding to this WrrPolicyItem object. When multiple WrrPolicyItem objects are configured, the probability of returning an WrrPolicyItem object's data is proportional to its weight relative to the sum of weights configured for all items. This weight must be non-negative. + "weight": 3.14, # The weight corresponding to this `WrrPolicyItem` object. When multiple `WrrPolicyItem` objects are configured, the probability of returning an `WrrPolicyItem` object's data is proportional to its weight relative to the sum of weights configured for all items. This weight must be non-negative. }, ], "kind": "dns#rRSetRoutingPolicyWrrPolicy", @@ -908,14 +905,14 @@

Method Details

"wrrPolicy": { # Configures a RRSetRoutingPolicy that routes in a weighted round robin fashion. "items": [ { # A routing block which contains the routing information for one WRR item. - "healthCheckedTargets": { # HealthCheckTargets describes endpoints to health-check when responding to Routing Policy queries. Only the healthy endpoints will be included in the response. Only one of internal_load_balancer and external_endpoints should be set. # Endpoints that are health checked before making the routing decision. The unhealthy endpoints are omitted from the result. If all endpoints within a bucket are unhealthy, we choose a different bucket (sampled with respect to its weight) for responding. If DNSSEC is enabled for this zone, only one of rrdata or health_checked_targets can be set. + "healthCheckedTargets": { # HealthCheckTargets describes endpoints to health-check when responding to Routing Policy queries. Only the healthy endpoints will be included in the response. # Endpoints that are health checked before making the routing decision. The unhealthy endpoints are omitted from the result. If all endpoints within a bucket are unhealthy, we choose a different bucket (sampled with respect to its weight) for responding. If DNSSEC is enabled for this zone, only one of `rrdata` or `health_checked_targets` can be set. "internalLoadBalancers": [ # Configuration for internal load balancers to be health checked. { # The configuration for an individual load balancer to health check. "ipAddress": "A String", # The frontend IP address of the load balancer to health check. "ipProtocol": "A String", # The protocol of the load balancer to health check. "kind": "dns#rRSetRoutingPolicyLoadBalancerTarget", "loadBalancerType": "A String", # The type of load balancer specified by this target. This value must match the configuration of the load balancer located at the LoadBalancerTarget's IP address, port, and region. Use the following: - *regionalL4ilb*: for a regional internal passthrough Network Load Balancer. - *regionalL7ilb*: for a regional internal Application Load Balancer. - *globalL7ilb*: for a global internal Application Load Balancer. - "networkUrl": "A String", # The fully qualified URL of the network that the load balancer is attached to. This should be formatted like https://www.googleapis.com/compute/v1/projects/{project}/global/networks/{network} . + "networkUrl": "A String", # The fully qualified URL of the network that the load balancer is attached to. This should be formatted like `https://www.googleapis.com/compute/v1/projects/{project}/global/networks/{network}`. "port": "A String", # The configured port of the load balancer. "project": "A String", # The project ID in which the load balancer is located. "region": "A String", # The region in which the load balancer is located. @@ -926,10 +923,10 @@

Method Details

"rrdatas": [ "A String", ], - "signatureRrdatas": [ # DNSSEC generated signatures for all the rrdata within this item. Note that if health checked targets are provided for DNSSEC enabled zones, there's a restriction of 1 IP address per item. + "signatureRrdatas": [ # DNSSEC generated signatures for all the `rrdata` within this item. Note that if health checked targets are provided for DNSSEC enabled zones, there's a restriction of 1 IP address per item. "A String", ], - "weight": 3.14, # The weight corresponding to this WrrPolicyItem object. When multiple WrrPolicyItem objects are configured, the probability of returning an WrrPolicyItem object's data is proportional to its weight relative to the sum of weights configured for all items. This weight must be non-negative. + "weight": 3.14, # The weight corresponding to this `WrrPolicyItem` object. When multiple `WrrPolicyItem` objects are configured, the probability of returning an `WrrPolicyItem` object's data is proportional to its weight relative to the sum of weights configured for all items. This weight must be non-negative. }, ], "kind": "dns#rRSetRoutingPolicyWrrPolicy", @@ -941,7 +938,7 @@

Method Details

"signatureRrdatas": [ # As defined in RFC 4034 (section 3.2). "A String", ], - "ttl": 42, # Number of seconds that this ResourceRecordSet can be cached by resolvers. + "ttl": 42, # Number of seconds that this `ResourceRecordSet` can be cached by resolvers. "type": "A String", # The identifier of a supported record type. See the list of Supported DNS record types. }, ], @@ -986,19 +983,19 @@

Method Details

{ # A unit of data that is returned by the DNS servers. "kind": "dns#resourceRecordSet", "name": "A String", # For example, www.example.com. - "routingPolicy": { # A RRSetRoutingPolicy represents ResourceRecordSet data that is returned dynamically with the response varying based on configured properties such as geolocation or by weighted random selection. # Configures dynamic query responses based on either the geo location of the querying user or a weighted round robin based routing policy. A valid ResourceRecordSet contains only rrdata (for static resolution) or a routing_policy (for dynamic resolution). - "geo": { # Configures a RRSetRoutingPolicy that routes based on the geo location of the querying user. + "routingPolicy": { # A RRSetRoutingPolicy represents ResourceRecordSet data that is returned dynamically with the response varying based on configured properties such as geolocation or by weighted random selection. # Configures dynamic query responses based on either the geo location of the querying user or a weighted round robin based routing policy. A valid `ResourceRecordSet` contains only `rrdata` (for static resolution) or a `routing_policy` (for dynamic resolution). + "geo": { # Configures a `RRSetRoutingPolicy` that routes based on the geo location of the querying user. "enableFencing": True or False, # Without fencing, if health check fails for all configured items in the current geo bucket, we failover to the next nearest geo bucket. With fencing, if health checking is enabled, as long as some targets in the current geo bucket are healthy, we return only the healthy targets. However, if all targets are unhealthy, we don't failover to the next nearest bucket; instead, we return all the items in the current bucket even when all targets are unhealthy. "items": [ # The primary geo routing configuration. If there are multiple items with the same location, an error is returned instead. { # ResourceRecordSet data for one geo location. - "healthCheckedTargets": { # HealthCheckTargets describes endpoints to health-check when responding to Routing Policy queries. Only the healthy endpoints will be included in the response. Only one of internal_load_balancer and external_endpoints should be set. # For A and AAAA types only. Endpoints to return in the query result only if they are healthy. These can be specified along with rrdata within this item. + "healthCheckedTargets": { # HealthCheckTargets describes endpoints to health-check when responding to Routing Policy queries. Only the healthy endpoints will be included in the response. # For A and AAAA types only. Endpoints to return in the query result only if they are healthy. These can be specified along with `rrdata` within this item. "internalLoadBalancers": [ # Configuration for internal load balancers to be health checked. { # The configuration for an individual load balancer to health check. "ipAddress": "A String", # The frontend IP address of the load balancer to health check. "ipProtocol": "A String", # The protocol of the load balancer to health check. "kind": "dns#rRSetRoutingPolicyLoadBalancerTarget", "loadBalancerType": "A String", # The type of load balancer specified by this target. This value must match the configuration of the load balancer located at the LoadBalancerTarget's IP address, port, and region. Use the following: - *regionalL4ilb*: for a regional internal passthrough Network Load Balancer. - *regionalL7ilb*: for a regional internal Application Load Balancer. - *globalL7ilb*: for a global internal Application Load Balancer. - "networkUrl": "A String", # The fully qualified URL of the network that the load balancer is attached to. This should be formatted like https://www.googleapis.com/compute/v1/projects/{project}/global/networks/{network} . + "networkUrl": "A String", # The fully qualified URL of the network that the load balancer is attached to. This should be formatted like `https://www.googleapis.com/compute/v1/projects/{project}/global/networks/{network}`. "port": "A String", # The configured port of the load balancer. "project": "A String", # The project ID in which the load balancer is located. "region": "A String", # The region in which the load balancer is located. @@ -1010,25 +1007,25 @@

Method Details

"rrdatas": [ "A String", ], - "signatureRrdatas": [ # DNSSEC generated signatures for all the rrdata within this item. If health checked targets are provided for DNSSEC enabled zones, there's a restriction of 1 IP address per item. + "signatureRrdatas": [ # DNSSEC generated signatures for all the `rrdata` within this item. If health checked targets are provided for DNSSEC enabled zones, there's a restriction of 1 IP address per item. "A String", ], }, ], "kind": "dns#rRSetRoutingPolicyGeoPolicy", }, - "geoPolicy": { # Configures a RRSetRoutingPolicy that routes based on the geo location of the querying user. + "geoPolicy": { # Configures a `RRSetRoutingPolicy` that routes based on the geo location of the querying user. "enableFencing": True or False, # Without fencing, if health check fails for all configured items in the current geo bucket, we failover to the next nearest geo bucket. With fencing, if health checking is enabled, as long as some targets in the current geo bucket are healthy, we return only the healthy targets. However, if all targets are unhealthy, we don't failover to the next nearest bucket; instead, we return all the items in the current bucket even when all targets are unhealthy. "items": [ # The primary geo routing configuration. If there are multiple items with the same location, an error is returned instead. { # ResourceRecordSet data for one geo location. - "healthCheckedTargets": { # HealthCheckTargets describes endpoints to health-check when responding to Routing Policy queries. Only the healthy endpoints will be included in the response. Only one of internal_load_balancer and external_endpoints should be set. # For A and AAAA types only. Endpoints to return in the query result only if they are healthy. These can be specified along with rrdata within this item. + "healthCheckedTargets": { # HealthCheckTargets describes endpoints to health-check when responding to Routing Policy queries. Only the healthy endpoints will be included in the response. # For A and AAAA types only. Endpoints to return in the query result only if they are healthy. These can be specified along with `rrdata` within this item. "internalLoadBalancers": [ # Configuration for internal load balancers to be health checked. { # The configuration for an individual load balancer to health check. "ipAddress": "A String", # The frontend IP address of the load balancer to health check. "ipProtocol": "A String", # The protocol of the load balancer to health check. "kind": "dns#rRSetRoutingPolicyLoadBalancerTarget", "loadBalancerType": "A String", # The type of load balancer specified by this target. This value must match the configuration of the load balancer located at the LoadBalancerTarget's IP address, port, and region. Use the following: - *regionalL4ilb*: for a regional internal passthrough Network Load Balancer. - *regionalL7ilb*: for a regional internal Application Load Balancer. - *globalL7ilb*: for a global internal Application Load Balancer. - "networkUrl": "A String", # The fully qualified URL of the network that the load balancer is attached to. This should be formatted like https://www.googleapis.com/compute/v1/projects/{project}/global/networks/{network} . + "networkUrl": "A String", # The fully qualified URL of the network that the load balancer is attached to. This should be formatted like `https://www.googleapis.com/compute/v1/projects/{project}/global/networks/{network}`. "port": "A String", # The configured port of the load balancer. "project": "A String", # The project ID in which the load balancer is located. "region": "A String", # The region in which the load balancer is located. @@ -1040,7 +1037,7 @@

Method Details

"rrdatas": [ "A String", ], - "signatureRrdatas": [ # DNSSEC generated signatures for all the rrdata within this item. If health checked targets are provided for DNSSEC enabled zones, there's a restriction of 1 IP address per item. + "signatureRrdatas": [ # DNSSEC generated signatures for all the `rrdata` within this item. If health checked targets are provided for DNSSEC enabled zones, there's a restriction of 1 IP address per item. "A String", ], }, @@ -1049,18 +1046,18 @@

Method Details

}, "kind": "dns#rRSetRoutingPolicy", "primaryBackup": { # Configures a RRSetRoutingPolicy such that all queries are responded with the primary_targets if they are healthy. And if all of them are unhealthy, then we fallback to a geo localized policy. - "backupGeoTargets": { # Configures a RRSetRoutingPolicy that routes based on the geo location of the querying user. # Backup targets provide a regional failover policy for the otherwise global primary targets. If serving state is set to BACKUP, this policy essentially becomes a geo routing policy. + "backupGeoTargets": { # Configures a `RRSetRoutingPolicy` that routes based on the geo location of the querying user. # Backup targets provide a regional failover policy for the otherwise global primary targets. If serving state is set to `BACKUP`, this policy essentially becomes a geo routing policy. "enableFencing": True or False, # Without fencing, if health check fails for all configured items in the current geo bucket, we failover to the next nearest geo bucket. With fencing, if health checking is enabled, as long as some targets in the current geo bucket are healthy, we return only the healthy targets. However, if all targets are unhealthy, we don't failover to the next nearest bucket; instead, we return all the items in the current bucket even when all targets are unhealthy. "items": [ # The primary geo routing configuration. If there are multiple items with the same location, an error is returned instead. { # ResourceRecordSet data for one geo location. - "healthCheckedTargets": { # HealthCheckTargets describes endpoints to health-check when responding to Routing Policy queries. Only the healthy endpoints will be included in the response. Only one of internal_load_balancer and external_endpoints should be set. # For A and AAAA types only. Endpoints to return in the query result only if they are healthy. These can be specified along with rrdata within this item. + "healthCheckedTargets": { # HealthCheckTargets describes endpoints to health-check when responding to Routing Policy queries. Only the healthy endpoints will be included in the response. # For A and AAAA types only. Endpoints to return in the query result only if they are healthy. These can be specified along with `rrdata` within this item. "internalLoadBalancers": [ # Configuration for internal load balancers to be health checked. { # The configuration for an individual load balancer to health check. "ipAddress": "A String", # The frontend IP address of the load balancer to health check. "ipProtocol": "A String", # The protocol of the load balancer to health check. "kind": "dns#rRSetRoutingPolicyLoadBalancerTarget", "loadBalancerType": "A String", # The type of load balancer specified by this target. This value must match the configuration of the load balancer located at the LoadBalancerTarget's IP address, port, and region. Use the following: - *regionalL4ilb*: for a regional internal passthrough Network Load Balancer. - *regionalL7ilb*: for a regional internal Application Load Balancer. - *globalL7ilb*: for a global internal Application Load Balancer. - "networkUrl": "A String", # The fully qualified URL of the network that the load balancer is attached to. This should be formatted like https://www.googleapis.com/compute/v1/projects/{project}/global/networks/{network} . + "networkUrl": "A String", # The fully qualified URL of the network that the load balancer is attached to. This should be formatted like `https://www.googleapis.com/compute/v1/projects/{project}/global/networks/{network}`. "port": "A String", # The configured port of the load balancer. "project": "A String", # The project ID in which the load balancer is located. "region": "A String", # The region in which the load balancer is located. @@ -1072,7 +1069,7 @@

Method Details

"rrdatas": [ "A String", ], - "signatureRrdatas": [ # DNSSEC generated signatures for all the rrdata within this item. If health checked targets are provided for DNSSEC enabled zones, there's a restriction of 1 IP address per item. + "signatureRrdatas": [ # DNSSEC generated signatures for all the `rrdata` within this item. If health checked targets are provided for DNSSEC enabled zones, there's a restriction of 1 IP address per item. "A String", ], }, @@ -1080,33 +1077,33 @@

Method Details

"kind": "dns#rRSetRoutingPolicyGeoPolicy", }, "kind": "dns#rRSetRoutingPolicyPrimaryBackupPolicy", - "primaryTargets": { # HealthCheckTargets describes endpoints to health-check when responding to Routing Policy queries. Only the healthy endpoints will be included in the response. Only one of internal_load_balancer and external_endpoints should be set. # Endpoints that are health checked before making the routing decision. Unhealthy endpoints are omitted from the results. If all endpoints are unhealthy, we serve a response based on the backup_geo_targets. + "primaryTargets": { # HealthCheckTargets describes endpoints to health-check when responding to Routing Policy queries. Only the healthy endpoints will be included in the response. # Endpoints that are health checked before making the routing decision. Unhealthy endpoints are omitted from the results. If all endpoints are unhealthy, we serve a response based on the `backup_geo_targets`. "internalLoadBalancers": [ # Configuration for internal load balancers to be health checked. { # The configuration for an individual load balancer to health check. "ipAddress": "A String", # The frontend IP address of the load balancer to health check. "ipProtocol": "A String", # The protocol of the load balancer to health check. "kind": "dns#rRSetRoutingPolicyLoadBalancerTarget", "loadBalancerType": "A String", # The type of load balancer specified by this target. This value must match the configuration of the load balancer located at the LoadBalancerTarget's IP address, port, and region. Use the following: - *regionalL4ilb*: for a regional internal passthrough Network Load Balancer. - *regionalL7ilb*: for a regional internal Application Load Balancer. - *globalL7ilb*: for a global internal Application Load Balancer. - "networkUrl": "A String", # The fully qualified URL of the network that the load balancer is attached to. This should be formatted like https://www.googleapis.com/compute/v1/projects/{project}/global/networks/{network} . + "networkUrl": "A String", # The fully qualified URL of the network that the load balancer is attached to. This should be formatted like `https://www.googleapis.com/compute/v1/projects/{project}/global/networks/{network}`. "port": "A String", # The configured port of the load balancer. "project": "A String", # The project ID in which the load balancer is located. "region": "A String", # The region in which the load balancer is located. }, ], }, - "trickleTraffic": 3.14, # When serving state is PRIMARY, this field provides the option of sending a small percentage of the traffic to the backup targets. + "trickleTraffic": 3.14, # When serving state is `PRIMARY`, this field provides the option of sending a small percentage of the traffic to the backup targets. }, "wrr": { # Configures a RRSetRoutingPolicy that routes in a weighted round robin fashion. "items": [ { # A routing block which contains the routing information for one WRR item. - "healthCheckedTargets": { # HealthCheckTargets describes endpoints to health-check when responding to Routing Policy queries. Only the healthy endpoints will be included in the response. Only one of internal_load_balancer and external_endpoints should be set. # Endpoints that are health checked before making the routing decision. The unhealthy endpoints are omitted from the result. If all endpoints within a bucket are unhealthy, we choose a different bucket (sampled with respect to its weight) for responding. If DNSSEC is enabled for this zone, only one of rrdata or health_checked_targets can be set. + "healthCheckedTargets": { # HealthCheckTargets describes endpoints to health-check when responding to Routing Policy queries. Only the healthy endpoints will be included in the response. # Endpoints that are health checked before making the routing decision. The unhealthy endpoints are omitted from the result. If all endpoints within a bucket are unhealthy, we choose a different bucket (sampled with respect to its weight) for responding. If DNSSEC is enabled for this zone, only one of `rrdata` or `health_checked_targets` can be set. "internalLoadBalancers": [ # Configuration for internal load balancers to be health checked. { # The configuration for an individual load balancer to health check. "ipAddress": "A String", # The frontend IP address of the load balancer to health check. "ipProtocol": "A String", # The protocol of the load balancer to health check. "kind": "dns#rRSetRoutingPolicyLoadBalancerTarget", "loadBalancerType": "A String", # The type of load balancer specified by this target. This value must match the configuration of the load balancer located at the LoadBalancerTarget's IP address, port, and region. Use the following: - *regionalL4ilb*: for a regional internal passthrough Network Load Balancer. - *regionalL7ilb*: for a regional internal Application Load Balancer. - *globalL7ilb*: for a global internal Application Load Balancer. - "networkUrl": "A String", # The fully qualified URL of the network that the load balancer is attached to. This should be formatted like https://www.googleapis.com/compute/v1/projects/{project}/global/networks/{network} . + "networkUrl": "A String", # The fully qualified URL of the network that the load balancer is attached to. This should be formatted like `https://www.googleapis.com/compute/v1/projects/{project}/global/networks/{network}`. "port": "A String", # The configured port of the load balancer. "project": "A String", # The project ID in which the load balancer is located. "region": "A String", # The region in which the load balancer is located. @@ -1117,10 +1114,10 @@

Method Details

"rrdatas": [ "A String", ], - "signatureRrdatas": [ # DNSSEC generated signatures for all the rrdata within this item. Note that if health checked targets are provided for DNSSEC enabled zones, there's a restriction of 1 IP address per item. + "signatureRrdatas": [ # DNSSEC generated signatures for all the `rrdata` within this item. Note that if health checked targets are provided for DNSSEC enabled zones, there's a restriction of 1 IP address per item. "A String", ], - "weight": 3.14, # The weight corresponding to this WrrPolicyItem object. When multiple WrrPolicyItem objects are configured, the probability of returning an WrrPolicyItem object's data is proportional to its weight relative to the sum of weights configured for all items. This weight must be non-negative. + "weight": 3.14, # The weight corresponding to this `WrrPolicyItem` object. When multiple `WrrPolicyItem` objects are configured, the probability of returning an `WrrPolicyItem` object's data is proportional to its weight relative to the sum of weights configured for all items. This weight must be non-negative. }, ], "kind": "dns#rRSetRoutingPolicyWrrPolicy", @@ -1128,14 +1125,14 @@

Method Details

"wrrPolicy": { # Configures a RRSetRoutingPolicy that routes in a weighted round robin fashion. "items": [ { # A routing block which contains the routing information for one WRR item. - "healthCheckedTargets": { # HealthCheckTargets describes endpoints to health-check when responding to Routing Policy queries. Only the healthy endpoints will be included in the response. Only one of internal_load_balancer and external_endpoints should be set. # Endpoints that are health checked before making the routing decision. The unhealthy endpoints are omitted from the result. If all endpoints within a bucket are unhealthy, we choose a different bucket (sampled with respect to its weight) for responding. If DNSSEC is enabled for this zone, only one of rrdata or health_checked_targets can be set. + "healthCheckedTargets": { # HealthCheckTargets describes endpoints to health-check when responding to Routing Policy queries. Only the healthy endpoints will be included in the response. # Endpoints that are health checked before making the routing decision. The unhealthy endpoints are omitted from the result. If all endpoints within a bucket are unhealthy, we choose a different bucket (sampled with respect to its weight) for responding. If DNSSEC is enabled for this zone, only one of `rrdata` or `health_checked_targets` can be set. "internalLoadBalancers": [ # Configuration for internal load balancers to be health checked. { # The configuration for an individual load balancer to health check. "ipAddress": "A String", # The frontend IP address of the load balancer to health check. "ipProtocol": "A String", # The protocol of the load balancer to health check. "kind": "dns#rRSetRoutingPolicyLoadBalancerTarget", "loadBalancerType": "A String", # The type of load balancer specified by this target. This value must match the configuration of the load balancer located at the LoadBalancerTarget's IP address, port, and region. Use the following: - *regionalL4ilb*: for a regional internal passthrough Network Load Balancer. - *regionalL7ilb*: for a regional internal Application Load Balancer. - *globalL7ilb*: for a global internal Application Load Balancer. - "networkUrl": "A String", # The fully qualified URL of the network that the load balancer is attached to. This should be formatted like https://www.googleapis.com/compute/v1/projects/{project}/global/networks/{network} . + "networkUrl": "A String", # The fully qualified URL of the network that the load balancer is attached to. This should be formatted like `https://www.googleapis.com/compute/v1/projects/{project}/global/networks/{network}`. "port": "A String", # The configured port of the load balancer. "project": "A String", # The project ID in which the load balancer is located. "region": "A String", # The region in which the load balancer is located. @@ -1146,10 +1143,10 @@

Method Details

"rrdatas": [ "A String", ], - "signatureRrdatas": [ # DNSSEC generated signatures for all the rrdata within this item. Note that if health checked targets are provided for DNSSEC enabled zones, there's a restriction of 1 IP address per item. + "signatureRrdatas": [ # DNSSEC generated signatures for all the `rrdata` within this item. Note that if health checked targets are provided for DNSSEC enabled zones, there's a restriction of 1 IP address per item. "A String", ], - "weight": 3.14, # The weight corresponding to this WrrPolicyItem object. When multiple WrrPolicyItem objects are configured, the probability of returning an WrrPolicyItem object's data is proportional to its weight relative to the sum of weights configured for all items. This weight must be non-negative. + "weight": 3.14, # The weight corresponding to this `WrrPolicyItem` object. When multiple `WrrPolicyItem` objects are configured, the probability of returning an `WrrPolicyItem` object's data is proportional to its weight relative to the sum of weights configured for all items. This weight must be non-negative. }, ], "kind": "dns#rRSetRoutingPolicyWrrPolicy", @@ -1161,7 +1158,7 @@

Method Details

"signatureRrdatas": [ # As defined in RFC 4034 (section 3.2). "A String", ], - "ttl": 42, # Number of seconds that this ResourceRecordSet can be cached by resolvers. + "ttl": 42, # Number of seconds that this `ResourceRecordSet` can be cached by resolvers. "type": "A String", # The identifier of a supported record type. See the list of Supported DNS record types. }, ], @@ -1179,9 +1176,6 @@

Method Details

An object of the form: { - "header": { # Elements common to every response. - "operationId": "A String", # For mutating operation requests that completed successfully. This is the client_operation_id if the client specified it, otherwise it is generated by the server (output only). - }, "responsePolicyRule": { # A Response Policy Rule is a selector that applies its behavior to queries that match the selector. Selectors are DNS names, which may be wildcards or exact matches. Each DNS query subject to a Response Policy matches at most one ResponsePolicyRule, as identified by the dns_name field with the longest matching suffix. "behavior": "A String", # Answer this query with a behavior rather than DNS data. "dnsName": "A String", # The DNS name (wildcard or exact) to apply this rule to. Must be unique within the Response Policy Rule. @@ -1191,19 +1185,19 @@

Method Details

{ # A unit of data that is returned by the DNS servers. "kind": "dns#resourceRecordSet", "name": "A String", # For example, www.example.com. - "routingPolicy": { # A RRSetRoutingPolicy represents ResourceRecordSet data that is returned dynamically with the response varying based on configured properties such as geolocation or by weighted random selection. # Configures dynamic query responses based on either the geo location of the querying user or a weighted round robin based routing policy. A valid ResourceRecordSet contains only rrdata (for static resolution) or a routing_policy (for dynamic resolution). - "geo": { # Configures a RRSetRoutingPolicy that routes based on the geo location of the querying user. + "routingPolicy": { # A RRSetRoutingPolicy represents ResourceRecordSet data that is returned dynamically with the response varying based on configured properties such as geolocation or by weighted random selection. # Configures dynamic query responses based on either the geo location of the querying user or a weighted round robin based routing policy. A valid `ResourceRecordSet` contains only `rrdata` (for static resolution) or a `routing_policy` (for dynamic resolution). + "geo": { # Configures a `RRSetRoutingPolicy` that routes based on the geo location of the querying user. "enableFencing": True or False, # Without fencing, if health check fails for all configured items in the current geo bucket, we failover to the next nearest geo bucket. With fencing, if health checking is enabled, as long as some targets in the current geo bucket are healthy, we return only the healthy targets. However, if all targets are unhealthy, we don't failover to the next nearest bucket; instead, we return all the items in the current bucket even when all targets are unhealthy. "items": [ # The primary geo routing configuration. If there are multiple items with the same location, an error is returned instead. { # ResourceRecordSet data for one geo location. - "healthCheckedTargets": { # HealthCheckTargets describes endpoints to health-check when responding to Routing Policy queries. Only the healthy endpoints will be included in the response. Only one of internal_load_balancer and external_endpoints should be set. # For A and AAAA types only. Endpoints to return in the query result only if they are healthy. These can be specified along with rrdata within this item. + "healthCheckedTargets": { # HealthCheckTargets describes endpoints to health-check when responding to Routing Policy queries. Only the healthy endpoints will be included in the response. # For A and AAAA types only. Endpoints to return in the query result only if they are healthy. These can be specified along with `rrdata` within this item. "internalLoadBalancers": [ # Configuration for internal load balancers to be health checked. { # The configuration for an individual load balancer to health check. "ipAddress": "A String", # The frontend IP address of the load balancer to health check. "ipProtocol": "A String", # The protocol of the load balancer to health check. "kind": "dns#rRSetRoutingPolicyLoadBalancerTarget", "loadBalancerType": "A String", # The type of load balancer specified by this target. This value must match the configuration of the load balancer located at the LoadBalancerTarget's IP address, port, and region. Use the following: - *regionalL4ilb*: for a regional internal passthrough Network Load Balancer. - *regionalL7ilb*: for a regional internal Application Load Balancer. - *globalL7ilb*: for a global internal Application Load Balancer. - "networkUrl": "A String", # The fully qualified URL of the network that the load balancer is attached to. This should be formatted like https://www.googleapis.com/compute/v1/projects/{project}/global/networks/{network} . + "networkUrl": "A String", # The fully qualified URL of the network that the load balancer is attached to. This should be formatted like `https://www.googleapis.com/compute/v1/projects/{project}/global/networks/{network}`. "port": "A String", # The configured port of the load balancer. "project": "A String", # The project ID in which the load balancer is located. "region": "A String", # The region in which the load balancer is located. @@ -1215,25 +1209,25 @@

Method Details

"rrdatas": [ "A String", ], - "signatureRrdatas": [ # DNSSEC generated signatures for all the rrdata within this item. If health checked targets are provided for DNSSEC enabled zones, there's a restriction of 1 IP address per item. + "signatureRrdatas": [ # DNSSEC generated signatures for all the `rrdata` within this item. If health checked targets are provided for DNSSEC enabled zones, there's a restriction of 1 IP address per item. "A String", ], }, ], "kind": "dns#rRSetRoutingPolicyGeoPolicy", }, - "geoPolicy": { # Configures a RRSetRoutingPolicy that routes based on the geo location of the querying user. + "geoPolicy": { # Configures a `RRSetRoutingPolicy` that routes based on the geo location of the querying user. "enableFencing": True or False, # Without fencing, if health check fails for all configured items in the current geo bucket, we failover to the next nearest geo bucket. With fencing, if health checking is enabled, as long as some targets in the current geo bucket are healthy, we return only the healthy targets. However, if all targets are unhealthy, we don't failover to the next nearest bucket; instead, we return all the items in the current bucket even when all targets are unhealthy. "items": [ # The primary geo routing configuration. If there are multiple items with the same location, an error is returned instead. { # ResourceRecordSet data for one geo location. - "healthCheckedTargets": { # HealthCheckTargets describes endpoints to health-check when responding to Routing Policy queries. Only the healthy endpoints will be included in the response. Only one of internal_load_balancer and external_endpoints should be set. # For A and AAAA types only. Endpoints to return in the query result only if they are healthy. These can be specified along with rrdata within this item. + "healthCheckedTargets": { # HealthCheckTargets describes endpoints to health-check when responding to Routing Policy queries. Only the healthy endpoints will be included in the response. # For A and AAAA types only. Endpoints to return in the query result only if they are healthy. These can be specified along with `rrdata` within this item. "internalLoadBalancers": [ # Configuration for internal load balancers to be health checked. { # The configuration for an individual load balancer to health check. "ipAddress": "A String", # The frontend IP address of the load balancer to health check. "ipProtocol": "A String", # The protocol of the load balancer to health check. "kind": "dns#rRSetRoutingPolicyLoadBalancerTarget", "loadBalancerType": "A String", # The type of load balancer specified by this target. This value must match the configuration of the load balancer located at the LoadBalancerTarget's IP address, port, and region. Use the following: - *regionalL4ilb*: for a regional internal passthrough Network Load Balancer. - *regionalL7ilb*: for a regional internal Application Load Balancer. - *globalL7ilb*: for a global internal Application Load Balancer. - "networkUrl": "A String", # The fully qualified URL of the network that the load balancer is attached to. This should be formatted like https://www.googleapis.com/compute/v1/projects/{project}/global/networks/{network} . + "networkUrl": "A String", # The fully qualified URL of the network that the load balancer is attached to. This should be formatted like `https://www.googleapis.com/compute/v1/projects/{project}/global/networks/{network}`. "port": "A String", # The configured port of the load balancer. "project": "A String", # The project ID in which the load balancer is located. "region": "A String", # The region in which the load balancer is located. @@ -1245,7 +1239,7 @@

Method Details

"rrdatas": [ "A String", ], - "signatureRrdatas": [ # DNSSEC generated signatures for all the rrdata within this item. If health checked targets are provided for DNSSEC enabled zones, there's a restriction of 1 IP address per item. + "signatureRrdatas": [ # DNSSEC generated signatures for all the `rrdata` within this item. If health checked targets are provided for DNSSEC enabled zones, there's a restriction of 1 IP address per item. "A String", ], }, @@ -1254,18 +1248,18 @@

Method Details

}, "kind": "dns#rRSetRoutingPolicy", "primaryBackup": { # Configures a RRSetRoutingPolicy such that all queries are responded with the primary_targets if they are healthy. And if all of them are unhealthy, then we fallback to a geo localized policy. - "backupGeoTargets": { # Configures a RRSetRoutingPolicy that routes based on the geo location of the querying user. # Backup targets provide a regional failover policy for the otherwise global primary targets. If serving state is set to BACKUP, this policy essentially becomes a geo routing policy. + "backupGeoTargets": { # Configures a `RRSetRoutingPolicy` that routes based on the geo location of the querying user. # Backup targets provide a regional failover policy for the otherwise global primary targets. If serving state is set to `BACKUP`, this policy essentially becomes a geo routing policy. "enableFencing": True or False, # Without fencing, if health check fails for all configured items in the current geo bucket, we failover to the next nearest geo bucket. With fencing, if health checking is enabled, as long as some targets in the current geo bucket are healthy, we return only the healthy targets. However, if all targets are unhealthy, we don't failover to the next nearest bucket; instead, we return all the items in the current bucket even when all targets are unhealthy. "items": [ # The primary geo routing configuration. If there are multiple items with the same location, an error is returned instead. { # ResourceRecordSet data for one geo location. - "healthCheckedTargets": { # HealthCheckTargets describes endpoints to health-check when responding to Routing Policy queries. Only the healthy endpoints will be included in the response. Only one of internal_load_balancer and external_endpoints should be set. # For A and AAAA types only. Endpoints to return in the query result only if they are healthy. These can be specified along with rrdata within this item. + "healthCheckedTargets": { # HealthCheckTargets describes endpoints to health-check when responding to Routing Policy queries. Only the healthy endpoints will be included in the response. # For A and AAAA types only. Endpoints to return in the query result only if they are healthy. These can be specified along with `rrdata` within this item. "internalLoadBalancers": [ # Configuration for internal load balancers to be health checked. { # The configuration for an individual load balancer to health check. "ipAddress": "A String", # The frontend IP address of the load balancer to health check. "ipProtocol": "A String", # The protocol of the load balancer to health check. "kind": "dns#rRSetRoutingPolicyLoadBalancerTarget", "loadBalancerType": "A String", # The type of load balancer specified by this target. This value must match the configuration of the load balancer located at the LoadBalancerTarget's IP address, port, and region. Use the following: - *regionalL4ilb*: for a regional internal passthrough Network Load Balancer. - *regionalL7ilb*: for a regional internal Application Load Balancer. - *globalL7ilb*: for a global internal Application Load Balancer. - "networkUrl": "A String", # The fully qualified URL of the network that the load balancer is attached to. This should be formatted like https://www.googleapis.com/compute/v1/projects/{project}/global/networks/{network} . + "networkUrl": "A String", # The fully qualified URL of the network that the load balancer is attached to. This should be formatted like `https://www.googleapis.com/compute/v1/projects/{project}/global/networks/{network}`. "port": "A String", # The configured port of the load balancer. "project": "A String", # The project ID in which the load balancer is located. "region": "A String", # The region in which the load balancer is located. @@ -1277,7 +1271,7 @@

Method Details

"rrdatas": [ "A String", ], - "signatureRrdatas": [ # DNSSEC generated signatures for all the rrdata within this item. If health checked targets are provided for DNSSEC enabled zones, there's a restriction of 1 IP address per item. + "signatureRrdatas": [ # DNSSEC generated signatures for all the `rrdata` within this item. If health checked targets are provided for DNSSEC enabled zones, there's a restriction of 1 IP address per item. "A String", ], }, @@ -1285,33 +1279,33 @@

Method Details

"kind": "dns#rRSetRoutingPolicyGeoPolicy", }, "kind": "dns#rRSetRoutingPolicyPrimaryBackupPolicy", - "primaryTargets": { # HealthCheckTargets describes endpoints to health-check when responding to Routing Policy queries. Only the healthy endpoints will be included in the response. Only one of internal_load_balancer and external_endpoints should be set. # Endpoints that are health checked before making the routing decision. Unhealthy endpoints are omitted from the results. If all endpoints are unhealthy, we serve a response based on the backup_geo_targets. + "primaryTargets": { # HealthCheckTargets describes endpoints to health-check when responding to Routing Policy queries. Only the healthy endpoints will be included in the response. # Endpoints that are health checked before making the routing decision. Unhealthy endpoints are omitted from the results. If all endpoints are unhealthy, we serve a response based on the `backup_geo_targets`. "internalLoadBalancers": [ # Configuration for internal load balancers to be health checked. { # The configuration for an individual load balancer to health check. "ipAddress": "A String", # The frontend IP address of the load balancer to health check. "ipProtocol": "A String", # The protocol of the load balancer to health check. "kind": "dns#rRSetRoutingPolicyLoadBalancerTarget", "loadBalancerType": "A String", # The type of load balancer specified by this target. This value must match the configuration of the load balancer located at the LoadBalancerTarget's IP address, port, and region. Use the following: - *regionalL4ilb*: for a regional internal passthrough Network Load Balancer. - *regionalL7ilb*: for a regional internal Application Load Balancer. - *globalL7ilb*: for a global internal Application Load Balancer. - "networkUrl": "A String", # The fully qualified URL of the network that the load balancer is attached to. This should be formatted like https://www.googleapis.com/compute/v1/projects/{project}/global/networks/{network} . + "networkUrl": "A String", # The fully qualified URL of the network that the load balancer is attached to. This should be formatted like `https://www.googleapis.com/compute/v1/projects/{project}/global/networks/{network}`. "port": "A String", # The configured port of the load balancer. "project": "A String", # The project ID in which the load balancer is located. "region": "A String", # The region in which the load balancer is located. }, ], }, - "trickleTraffic": 3.14, # When serving state is PRIMARY, this field provides the option of sending a small percentage of the traffic to the backup targets. + "trickleTraffic": 3.14, # When serving state is `PRIMARY`, this field provides the option of sending a small percentage of the traffic to the backup targets. }, "wrr": { # Configures a RRSetRoutingPolicy that routes in a weighted round robin fashion. "items": [ { # A routing block which contains the routing information for one WRR item. - "healthCheckedTargets": { # HealthCheckTargets describes endpoints to health-check when responding to Routing Policy queries. Only the healthy endpoints will be included in the response. Only one of internal_load_balancer and external_endpoints should be set. # Endpoints that are health checked before making the routing decision. The unhealthy endpoints are omitted from the result. If all endpoints within a bucket are unhealthy, we choose a different bucket (sampled with respect to its weight) for responding. If DNSSEC is enabled for this zone, only one of rrdata or health_checked_targets can be set. + "healthCheckedTargets": { # HealthCheckTargets describes endpoints to health-check when responding to Routing Policy queries. Only the healthy endpoints will be included in the response. # Endpoints that are health checked before making the routing decision. The unhealthy endpoints are omitted from the result. If all endpoints within a bucket are unhealthy, we choose a different bucket (sampled with respect to its weight) for responding. If DNSSEC is enabled for this zone, only one of `rrdata` or `health_checked_targets` can be set. "internalLoadBalancers": [ # Configuration for internal load balancers to be health checked. { # The configuration for an individual load balancer to health check. "ipAddress": "A String", # The frontend IP address of the load balancer to health check. "ipProtocol": "A String", # The protocol of the load balancer to health check. "kind": "dns#rRSetRoutingPolicyLoadBalancerTarget", "loadBalancerType": "A String", # The type of load balancer specified by this target. This value must match the configuration of the load balancer located at the LoadBalancerTarget's IP address, port, and region. Use the following: - *regionalL4ilb*: for a regional internal passthrough Network Load Balancer. - *regionalL7ilb*: for a regional internal Application Load Balancer. - *globalL7ilb*: for a global internal Application Load Balancer. - "networkUrl": "A String", # The fully qualified URL of the network that the load balancer is attached to. This should be formatted like https://www.googleapis.com/compute/v1/projects/{project}/global/networks/{network} . + "networkUrl": "A String", # The fully qualified URL of the network that the load balancer is attached to. This should be formatted like `https://www.googleapis.com/compute/v1/projects/{project}/global/networks/{network}`. "port": "A String", # The configured port of the load balancer. "project": "A String", # The project ID in which the load balancer is located. "region": "A String", # The region in which the load balancer is located. @@ -1322,10 +1316,10 @@

Method Details

"rrdatas": [ "A String", ], - "signatureRrdatas": [ # DNSSEC generated signatures for all the rrdata within this item. Note that if health checked targets are provided for DNSSEC enabled zones, there's a restriction of 1 IP address per item. + "signatureRrdatas": [ # DNSSEC generated signatures for all the `rrdata` within this item. Note that if health checked targets are provided for DNSSEC enabled zones, there's a restriction of 1 IP address per item. "A String", ], - "weight": 3.14, # The weight corresponding to this WrrPolicyItem object. When multiple WrrPolicyItem objects are configured, the probability of returning an WrrPolicyItem object's data is proportional to its weight relative to the sum of weights configured for all items. This weight must be non-negative. + "weight": 3.14, # The weight corresponding to this `WrrPolicyItem` object. When multiple `WrrPolicyItem` objects are configured, the probability of returning an `WrrPolicyItem` object's data is proportional to its weight relative to the sum of weights configured for all items. This weight must be non-negative. }, ], "kind": "dns#rRSetRoutingPolicyWrrPolicy", @@ -1333,14 +1327,14 @@

Method Details

"wrrPolicy": { # Configures a RRSetRoutingPolicy that routes in a weighted round robin fashion. "items": [ { # A routing block which contains the routing information for one WRR item. - "healthCheckedTargets": { # HealthCheckTargets describes endpoints to health-check when responding to Routing Policy queries. Only the healthy endpoints will be included in the response. Only one of internal_load_balancer and external_endpoints should be set. # Endpoints that are health checked before making the routing decision. The unhealthy endpoints are omitted from the result. If all endpoints within a bucket are unhealthy, we choose a different bucket (sampled with respect to its weight) for responding. If DNSSEC is enabled for this zone, only one of rrdata or health_checked_targets can be set. + "healthCheckedTargets": { # HealthCheckTargets describes endpoints to health-check when responding to Routing Policy queries. Only the healthy endpoints will be included in the response. # Endpoints that are health checked before making the routing decision. The unhealthy endpoints are omitted from the result. If all endpoints within a bucket are unhealthy, we choose a different bucket (sampled with respect to its weight) for responding. If DNSSEC is enabled for this zone, only one of `rrdata` or `health_checked_targets` can be set. "internalLoadBalancers": [ # Configuration for internal load balancers to be health checked. { # The configuration for an individual load balancer to health check. "ipAddress": "A String", # The frontend IP address of the load balancer to health check. "ipProtocol": "A String", # The protocol of the load balancer to health check. "kind": "dns#rRSetRoutingPolicyLoadBalancerTarget", "loadBalancerType": "A String", # The type of load balancer specified by this target. This value must match the configuration of the load balancer located at the LoadBalancerTarget's IP address, port, and region. Use the following: - *regionalL4ilb*: for a regional internal passthrough Network Load Balancer. - *regionalL7ilb*: for a regional internal Application Load Balancer. - *globalL7ilb*: for a global internal Application Load Balancer. - "networkUrl": "A String", # The fully qualified URL of the network that the load balancer is attached to. This should be formatted like https://www.googleapis.com/compute/v1/projects/{project}/global/networks/{network} . + "networkUrl": "A String", # The fully qualified URL of the network that the load balancer is attached to. This should be formatted like `https://www.googleapis.com/compute/v1/projects/{project}/global/networks/{network}`. "port": "A String", # The configured port of the load balancer. "project": "A String", # The project ID in which the load balancer is located. "region": "A String", # The region in which the load balancer is located. @@ -1351,10 +1345,10 @@

Method Details

"rrdatas": [ "A String", ], - "signatureRrdatas": [ # DNSSEC generated signatures for all the rrdata within this item. Note that if health checked targets are provided for DNSSEC enabled zones, there's a restriction of 1 IP address per item. + "signatureRrdatas": [ # DNSSEC generated signatures for all the `rrdata` within this item. Note that if health checked targets are provided for DNSSEC enabled zones, there's a restriction of 1 IP address per item. "A String", ], - "weight": 3.14, # The weight corresponding to this WrrPolicyItem object. When multiple WrrPolicyItem objects are configured, the probability of returning an WrrPolicyItem object's data is proportional to its weight relative to the sum of weights configured for all items. This weight must be non-negative. + "weight": 3.14, # The weight corresponding to this `WrrPolicyItem` object. When multiple `WrrPolicyItem` objects are configured, the probability of returning an `WrrPolicyItem` object's data is proportional to its weight relative to the sum of weights configured for all items. This weight must be non-negative. }, ], "kind": "dns#rRSetRoutingPolicyWrrPolicy", @@ -1366,7 +1360,7 @@

Method Details

"signatureRrdatas": [ # As defined in RFC 4034 (section 3.2). "A String", ], - "ttl": 42, # Number of seconds that this ResourceRecordSet can be cached by resolvers. + "ttl": 42, # Number of seconds that this `ResourceRecordSet` can be cached by resolvers. "type": "A String", # The identifier of a supported record type. See the list of Supported DNS record types. }, ], @@ -1396,19 +1390,19 @@

Method Details

{ # A unit of data that is returned by the DNS servers. "kind": "dns#resourceRecordSet", "name": "A String", # For example, www.example.com. - "routingPolicy": { # A RRSetRoutingPolicy represents ResourceRecordSet data that is returned dynamically with the response varying based on configured properties such as geolocation or by weighted random selection. # Configures dynamic query responses based on either the geo location of the querying user or a weighted round robin based routing policy. A valid ResourceRecordSet contains only rrdata (for static resolution) or a routing_policy (for dynamic resolution). - "geo": { # Configures a RRSetRoutingPolicy that routes based on the geo location of the querying user. + "routingPolicy": { # A RRSetRoutingPolicy represents ResourceRecordSet data that is returned dynamically with the response varying based on configured properties such as geolocation or by weighted random selection. # Configures dynamic query responses based on either the geo location of the querying user or a weighted round robin based routing policy. A valid `ResourceRecordSet` contains only `rrdata` (for static resolution) or a `routing_policy` (for dynamic resolution). + "geo": { # Configures a `RRSetRoutingPolicy` that routes based on the geo location of the querying user. "enableFencing": True or False, # Without fencing, if health check fails for all configured items in the current geo bucket, we failover to the next nearest geo bucket. With fencing, if health checking is enabled, as long as some targets in the current geo bucket are healthy, we return only the healthy targets. However, if all targets are unhealthy, we don't failover to the next nearest bucket; instead, we return all the items in the current bucket even when all targets are unhealthy. "items": [ # The primary geo routing configuration. If there are multiple items with the same location, an error is returned instead. { # ResourceRecordSet data for one geo location. - "healthCheckedTargets": { # HealthCheckTargets describes endpoints to health-check when responding to Routing Policy queries. Only the healthy endpoints will be included in the response. Only one of internal_load_balancer and external_endpoints should be set. # For A and AAAA types only. Endpoints to return in the query result only if they are healthy. These can be specified along with rrdata within this item. + "healthCheckedTargets": { # HealthCheckTargets describes endpoints to health-check when responding to Routing Policy queries. Only the healthy endpoints will be included in the response. # For A and AAAA types only. Endpoints to return in the query result only if they are healthy. These can be specified along with `rrdata` within this item. "internalLoadBalancers": [ # Configuration for internal load balancers to be health checked. { # The configuration for an individual load balancer to health check. "ipAddress": "A String", # The frontend IP address of the load balancer to health check. "ipProtocol": "A String", # The protocol of the load balancer to health check. "kind": "dns#rRSetRoutingPolicyLoadBalancerTarget", "loadBalancerType": "A String", # The type of load balancer specified by this target. This value must match the configuration of the load balancer located at the LoadBalancerTarget's IP address, port, and region. Use the following: - *regionalL4ilb*: for a regional internal passthrough Network Load Balancer. - *regionalL7ilb*: for a regional internal Application Load Balancer. - *globalL7ilb*: for a global internal Application Load Balancer. - "networkUrl": "A String", # The fully qualified URL of the network that the load balancer is attached to. This should be formatted like https://www.googleapis.com/compute/v1/projects/{project}/global/networks/{network} . + "networkUrl": "A String", # The fully qualified URL of the network that the load balancer is attached to. This should be formatted like `https://www.googleapis.com/compute/v1/projects/{project}/global/networks/{network}`. "port": "A String", # The configured port of the load balancer. "project": "A String", # The project ID in which the load balancer is located. "region": "A String", # The region in which the load balancer is located. @@ -1420,25 +1414,25 @@

Method Details

"rrdatas": [ "A String", ], - "signatureRrdatas": [ # DNSSEC generated signatures for all the rrdata within this item. If health checked targets are provided for DNSSEC enabled zones, there's a restriction of 1 IP address per item. + "signatureRrdatas": [ # DNSSEC generated signatures for all the `rrdata` within this item. If health checked targets are provided for DNSSEC enabled zones, there's a restriction of 1 IP address per item. "A String", ], }, ], "kind": "dns#rRSetRoutingPolicyGeoPolicy", }, - "geoPolicy": { # Configures a RRSetRoutingPolicy that routes based on the geo location of the querying user. + "geoPolicy": { # Configures a `RRSetRoutingPolicy` that routes based on the geo location of the querying user. "enableFencing": True or False, # Without fencing, if health check fails for all configured items in the current geo bucket, we failover to the next nearest geo bucket. With fencing, if health checking is enabled, as long as some targets in the current geo bucket are healthy, we return only the healthy targets. However, if all targets are unhealthy, we don't failover to the next nearest bucket; instead, we return all the items in the current bucket even when all targets are unhealthy. "items": [ # The primary geo routing configuration. If there are multiple items with the same location, an error is returned instead. { # ResourceRecordSet data for one geo location. - "healthCheckedTargets": { # HealthCheckTargets describes endpoints to health-check when responding to Routing Policy queries. Only the healthy endpoints will be included in the response. Only one of internal_load_balancer and external_endpoints should be set. # For A and AAAA types only. Endpoints to return in the query result only if they are healthy. These can be specified along with rrdata within this item. + "healthCheckedTargets": { # HealthCheckTargets describes endpoints to health-check when responding to Routing Policy queries. Only the healthy endpoints will be included in the response. # For A and AAAA types only. Endpoints to return in the query result only if they are healthy. These can be specified along with `rrdata` within this item. "internalLoadBalancers": [ # Configuration for internal load balancers to be health checked. { # The configuration for an individual load balancer to health check. "ipAddress": "A String", # The frontend IP address of the load balancer to health check. "ipProtocol": "A String", # The protocol of the load balancer to health check. "kind": "dns#rRSetRoutingPolicyLoadBalancerTarget", "loadBalancerType": "A String", # The type of load balancer specified by this target. This value must match the configuration of the load balancer located at the LoadBalancerTarget's IP address, port, and region. Use the following: - *regionalL4ilb*: for a regional internal passthrough Network Load Balancer. - *regionalL7ilb*: for a regional internal Application Load Balancer. - *globalL7ilb*: for a global internal Application Load Balancer. - "networkUrl": "A String", # The fully qualified URL of the network that the load balancer is attached to. This should be formatted like https://www.googleapis.com/compute/v1/projects/{project}/global/networks/{network} . + "networkUrl": "A String", # The fully qualified URL of the network that the load balancer is attached to. This should be formatted like `https://www.googleapis.com/compute/v1/projects/{project}/global/networks/{network}`. "port": "A String", # The configured port of the load balancer. "project": "A String", # The project ID in which the load balancer is located. "region": "A String", # The region in which the load balancer is located. @@ -1450,7 +1444,7 @@

Method Details

"rrdatas": [ "A String", ], - "signatureRrdatas": [ # DNSSEC generated signatures for all the rrdata within this item. If health checked targets are provided for DNSSEC enabled zones, there's a restriction of 1 IP address per item. + "signatureRrdatas": [ # DNSSEC generated signatures for all the `rrdata` within this item. If health checked targets are provided for DNSSEC enabled zones, there's a restriction of 1 IP address per item. "A String", ], }, @@ -1459,18 +1453,18 @@

Method Details

}, "kind": "dns#rRSetRoutingPolicy", "primaryBackup": { # Configures a RRSetRoutingPolicy such that all queries are responded with the primary_targets if they are healthy. And if all of them are unhealthy, then we fallback to a geo localized policy. - "backupGeoTargets": { # Configures a RRSetRoutingPolicy that routes based on the geo location of the querying user. # Backup targets provide a regional failover policy for the otherwise global primary targets. If serving state is set to BACKUP, this policy essentially becomes a geo routing policy. + "backupGeoTargets": { # Configures a `RRSetRoutingPolicy` that routes based on the geo location of the querying user. # Backup targets provide a regional failover policy for the otherwise global primary targets. If serving state is set to `BACKUP`, this policy essentially becomes a geo routing policy. "enableFencing": True or False, # Without fencing, if health check fails for all configured items in the current geo bucket, we failover to the next nearest geo bucket. With fencing, if health checking is enabled, as long as some targets in the current geo bucket are healthy, we return only the healthy targets. However, if all targets are unhealthy, we don't failover to the next nearest bucket; instead, we return all the items in the current bucket even when all targets are unhealthy. "items": [ # The primary geo routing configuration. If there are multiple items with the same location, an error is returned instead. { # ResourceRecordSet data for one geo location. - "healthCheckedTargets": { # HealthCheckTargets describes endpoints to health-check when responding to Routing Policy queries. Only the healthy endpoints will be included in the response. Only one of internal_load_balancer and external_endpoints should be set. # For A and AAAA types only. Endpoints to return in the query result only if they are healthy. These can be specified along with rrdata within this item. + "healthCheckedTargets": { # HealthCheckTargets describes endpoints to health-check when responding to Routing Policy queries. Only the healthy endpoints will be included in the response. # For A and AAAA types only. Endpoints to return in the query result only if they are healthy. These can be specified along with `rrdata` within this item. "internalLoadBalancers": [ # Configuration for internal load balancers to be health checked. { # The configuration for an individual load balancer to health check. "ipAddress": "A String", # The frontend IP address of the load balancer to health check. "ipProtocol": "A String", # The protocol of the load balancer to health check. "kind": "dns#rRSetRoutingPolicyLoadBalancerTarget", "loadBalancerType": "A String", # The type of load balancer specified by this target. This value must match the configuration of the load balancer located at the LoadBalancerTarget's IP address, port, and region. Use the following: - *regionalL4ilb*: for a regional internal passthrough Network Load Balancer. - *regionalL7ilb*: for a regional internal Application Load Balancer. - *globalL7ilb*: for a global internal Application Load Balancer. - "networkUrl": "A String", # The fully qualified URL of the network that the load balancer is attached to. This should be formatted like https://www.googleapis.com/compute/v1/projects/{project}/global/networks/{network} . + "networkUrl": "A String", # The fully qualified URL of the network that the load balancer is attached to. This should be formatted like `https://www.googleapis.com/compute/v1/projects/{project}/global/networks/{network}`. "port": "A String", # The configured port of the load balancer. "project": "A String", # The project ID in which the load balancer is located. "region": "A String", # The region in which the load balancer is located. @@ -1482,7 +1476,7 @@

Method Details

"rrdatas": [ "A String", ], - "signatureRrdatas": [ # DNSSEC generated signatures for all the rrdata within this item. If health checked targets are provided for DNSSEC enabled zones, there's a restriction of 1 IP address per item. + "signatureRrdatas": [ # DNSSEC generated signatures for all the `rrdata` within this item. If health checked targets are provided for DNSSEC enabled zones, there's a restriction of 1 IP address per item. "A String", ], }, @@ -1490,33 +1484,33 @@

Method Details

"kind": "dns#rRSetRoutingPolicyGeoPolicy", }, "kind": "dns#rRSetRoutingPolicyPrimaryBackupPolicy", - "primaryTargets": { # HealthCheckTargets describes endpoints to health-check when responding to Routing Policy queries. Only the healthy endpoints will be included in the response. Only one of internal_load_balancer and external_endpoints should be set. # Endpoints that are health checked before making the routing decision. Unhealthy endpoints are omitted from the results. If all endpoints are unhealthy, we serve a response based on the backup_geo_targets. + "primaryTargets": { # HealthCheckTargets describes endpoints to health-check when responding to Routing Policy queries. Only the healthy endpoints will be included in the response. # Endpoints that are health checked before making the routing decision. Unhealthy endpoints are omitted from the results. If all endpoints are unhealthy, we serve a response based on the `backup_geo_targets`. "internalLoadBalancers": [ # Configuration for internal load balancers to be health checked. { # The configuration for an individual load balancer to health check. "ipAddress": "A String", # The frontend IP address of the load balancer to health check. "ipProtocol": "A String", # The protocol of the load balancer to health check. "kind": "dns#rRSetRoutingPolicyLoadBalancerTarget", "loadBalancerType": "A String", # The type of load balancer specified by this target. This value must match the configuration of the load balancer located at the LoadBalancerTarget's IP address, port, and region. Use the following: - *regionalL4ilb*: for a regional internal passthrough Network Load Balancer. - *regionalL7ilb*: for a regional internal Application Load Balancer. - *globalL7ilb*: for a global internal Application Load Balancer. - "networkUrl": "A String", # The fully qualified URL of the network that the load balancer is attached to. This should be formatted like https://www.googleapis.com/compute/v1/projects/{project}/global/networks/{network} . + "networkUrl": "A String", # The fully qualified URL of the network that the load balancer is attached to. This should be formatted like `https://www.googleapis.com/compute/v1/projects/{project}/global/networks/{network}`. "port": "A String", # The configured port of the load balancer. "project": "A String", # The project ID in which the load balancer is located. "region": "A String", # The region in which the load balancer is located. }, ], }, - "trickleTraffic": 3.14, # When serving state is PRIMARY, this field provides the option of sending a small percentage of the traffic to the backup targets. + "trickleTraffic": 3.14, # When serving state is `PRIMARY`, this field provides the option of sending a small percentage of the traffic to the backup targets. }, "wrr": { # Configures a RRSetRoutingPolicy that routes in a weighted round robin fashion. "items": [ { # A routing block which contains the routing information for one WRR item. - "healthCheckedTargets": { # HealthCheckTargets describes endpoints to health-check when responding to Routing Policy queries. Only the healthy endpoints will be included in the response. Only one of internal_load_balancer and external_endpoints should be set. # Endpoints that are health checked before making the routing decision. The unhealthy endpoints are omitted from the result. If all endpoints within a bucket are unhealthy, we choose a different bucket (sampled with respect to its weight) for responding. If DNSSEC is enabled for this zone, only one of rrdata or health_checked_targets can be set. + "healthCheckedTargets": { # HealthCheckTargets describes endpoints to health-check when responding to Routing Policy queries. Only the healthy endpoints will be included in the response. # Endpoints that are health checked before making the routing decision. The unhealthy endpoints are omitted from the result. If all endpoints within a bucket are unhealthy, we choose a different bucket (sampled with respect to its weight) for responding. If DNSSEC is enabled for this zone, only one of `rrdata` or `health_checked_targets` can be set. "internalLoadBalancers": [ # Configuration for internal load balancers to be health checked. { # The configuration for an individual load balancer to health check. "ipAddress": "A String", # The frontend IP address of the load balancer to health check. "ipProtocol": "A String", # The protocol of the load balancer to health check. "kind": "dns#rRSetRoutingPolicyLoadBalancerTarget", "loadBalancerType": "A String", # The type of load balancer specified by this target. This value must match the configuration of the load balancer located at the LoadBalancerTarget's IP address, port, and region. Use the following: - *regionalL4ilb*: for a regional internal passthrough Network Load Balancer. - *regionalL7ilb*: for a regional internal Application Load Balancer. - *globalL7ilb*: for a global internal Application Load Balancer. - "networkUrl": "A String", # The fully qualified URL of the network that the load balancer is attached to. This should be formatted like https://www.googleapis.com/compute/v1/projects/{project}/global/networks/{network} . + "networkUrl": "A String", # The fully qualified URL of the network that the load balancer is attached to. This should be formatted like `https://www.googleapis.com/compute/v1/projects/{project}/global/networks/{network}`. "port": "A String", # The configured port of the load balancer. "project": "A String", # The project ID in which the load balancer is located. "region": "A String", # The region in which the load balancer is located. @@ -1527,10 +1521,10 @@

Method Details

"rrdatas": [ "A String", ], - "signatureRrdatas": [ # DNSSEC generated signatures for all the rrdata within this item. Note that if health checked targets are provided for DNSSEC enabled zones, there's a restriction of 1 IP address per item. + "signatureRrdatas": [ # DNSSEC generated signatures for all the `rrdata` within this item. Note that if health checked targets are provided for DNSSEC enabled zones, there's a restriction of 1 IP address per item. "A String", ], - "weight": 3.14, # The weight corresponding to this WrrPolicyItem object. When multiple WrrPolicyItem objects are configured, the probability of returning an WrrPolicyItem object's data is proportional to its weight relative to the sum of weights configured for all items. This weight must be non-negative. + "weight": 3.14, # The weight corresponding to this `WrrPolicyItem` object. When multiple `WrrPolicyItem` objects are configured, the probability of returning an `WrrPolicyItem` object's data is proportional to its weight relative to the sum of weights configured for all items. This weight must be non-negative. }, ], "kind": "dns#rRSetRoutingPolicyWrrPolicy", @@ -1538,14 +1532,14 @@

Method Details

"wrrPolicy": { # Configures a RRSetRoutingPolicy that routes in a weighted round robin fashion. "items": [ { # A routing block which contains the routing information for one WRR item. - "healthCheckedTargets": { # HealthCheckTargets describes endpoints to health-check when responding to Routing Policy queries. Only the healthy endpoints will be included in the response. Only one of internal_load_balancer and external_endpoints should be set. # Endpoints that are health checked before making the routing decision. The unhealthy endpoints are omitted from the result. If all endpoints within a bucket are unhealthy, we choose a different bucket (sampled with respect to its weight) for responding. If DNSSEC is enabled for this zone, only one of rrdata or health_checked_targets can be set. + "healthCheckedTargets": { # HealthCheckTargets describes endpoints to health-check when responding to Routing Policy queries. Only the healthy endpoints will be included in the response. # Endpoints that are health checked before making the routing decision. The unhealthy endpoints are omitted from the result. If all endpoints within a bucket are unhealthy, we choose a different bucket (sampled with respect to its weight) for responding. If DNSSEC is enabled for this zone, only one of `rrdata` or `health_checked_targets` can be set. "internalLoadBalancers": [ # Configuration for internal load balancers to be health checked. { # The configuration for an individual load balancer to health check. "ipAddress": "A String", # The frontend IP address of the load balancer to health check. "ipProtocol": "A String", # The protocol of the load balancer to health check. "kind": "dns#rRSetRoutingPolicyLoadBalancerTarget", "loadBalancerType": "A String", # The type of load balancer specified by this target. This value must match the configuration of the load balancer located at the LoadBalancerTarget's IP address, port, and region. Use the following: - *regionalL4ilb*: for a regional internal passthrough Network Load Balancer. - *regionalL7ilb*: for a regional internal Application Load Balancer. - *globalL7ilb*: for a global internal Application Load Balancer. - "networkUrl": "A String", # The fully qualified URL of the network that the load balancer is attached to. This should be formatted like https://www.googleapis.com/compute/v1/projects/{project}/global/networks/{network} . + "networkUrl": "A String", # The fully qualified URL of the network that the load balancer is attached to. This should be formatted like `https://www.googleapis.com/compute/v1/projects/{project}/global/networks/{network}`. "port": "A String", # The configured port of the load balancer. "project": "A String", # The project ID in which the load balancer is located. "region": "A String", # The region in which the load balancer is located. @@ -1556,10 +1550,10 @@

Method Details

"rrdatas": [ "A String", ], - "signatureRrdatas": [ # DNSSEC generated signatures for all the rrdata within this item. Note that if health checked targets are provided for DNSSEC enabled zones, there's a restriction of 1 IP address per item. + "signatureRrdatas": [ # DNSSEC generated signatures for all the `rrdata` within this item. Note that if health checked targets are provided for DNSSEC enabled zones, there's a restriction of 1 IP address per item. "A String", ], - "weight": 3.14, # The weight corresponding to this WrrPolicyItem object. When multiple WrrPolicyItem objects are configured, the probability of returning an WrrPolicyItem object's data is proportional to its weight relative to the sum of weights configured for all items. This weight must be non-negative. + "weight": 3.14, # The weight corresponding to this `WrrPolicyItem` object. When multiple `WrrPolicyItem` objects are configured, the probability of returning an `WrrPolicyItem` object's data is proportional to its weight relative to the sum of weights configured for all items. This weight must be non-negative. }, ], "kind": "dns#rRSetRoutingPolicyWrrPolicy", @@ -1571,7 +1565,7 @@

Method Details

"signatureRrdatas": [ # As defined in RFC 4034 (section 3.2). "A String", ], - "ttl": 42, # Number of seconds that this ResourceRecordSet can be cached by resolvers. + "ttl": 42, # Number of seconds that this `ResourceRecordSet` can be cached by resolvers. "type": "A String", # The identifier of a supported record type. See the list of Supported DNS record types. }, ], @@ -1589,9 +1583,6 @@

Method Details

An object of the form: { - "header": { # Elements common to every response. - "operationId": "A String", # For mutating operation requests that completed successfully. This is the client_operation_id if the client specified it, otherwise it is generated by the server (output only). - }, "responsePolicyRule": { # A Response Policy Rule is a selector that applies its behavior to queries that match the selector. Selectors are DNS names, which may be wildcards or exact matches. Each DNS query subject to a Response Policy matches at most one ResponsePolicyRule, as identified by the dns_name field with the longest matching suffix. "behavior": "A String", # Answer this query with a behavior rather than DNS data. "dnsName": "A String", # The DNS name (wildcard or exact) to apply this rule to. Must be unique within the Response Policy Rule. @@ -1601,19 +1592,19 @@

Method Details

{ # A unit of data that is returned by the DNS servers. "kind": "dns#resourceRecordSet", "name": "A String", # For example, www.example.com. - "routingPolicy": { # A RRSetRoutingPolicy represents ResourceRecordSet data that is returned dynamically with the response varying based on configured properties such as geolocation or by weighted random selection. # Configures dynamic query responses based on either the geo location of the querying user or a weighted round robin based routing policy. A valid ResourceRecordSet contains only rrdata (for static resolution) or a routing_policy (for dynamic resolution). - "geo": { # Configures a RRSetRoutingPolicy that routes based on the geo location of the querying user. + "routingPolicy": { # A RRSetRoutingPolicy represents ResourceRecordSet data that is returned dynamically with the response varying based on configured properties such as geolocation or by weighted random selection. # Configures dynamic query responses based on either the geo location of the querying user or a weighted round robin based routing policy. A valid `ResourceRecordSet` contains only `rrdata` (for static resolution) or a `routing_policy` (for dynamic resolution). + "geo": { # Configures a `RRSetRoutingPolicy` that routes based on the geo location of the querying user. "enableFencing": True or False, # Without fencing, if health check fails for all configured items in the current geo bucket, we failover to the next nearest geo bucket. With fencing, if health checking is enabled, as long as some targets in the current geo bucket are healthy, we return only the healthy targets. However, if all targets are unhealthy, we don't failover to the next nearest bucket; instead, we return all the items in the current bucket even when all targets are unhealthy. "items": [ # The primary geo routing configuration. If there are multiple items with the same location, an error is returned instead. { # ResourceRecordSet data for one geo location. - "healthCheckedTargets": { # HealthCheckTargets describes endpoints to health-check when responding to Routing Policy queries. Only the healthy endpoints will be included in the response. Only one of internal_load_balancer and external_endpoints should be set. # For A and AAAA types only. Endpoints to return in the query result only if they are healthy. These can be specified along with rrdata within this item. + "healthCheckedTargets": { # HealthCheckTargets describes endpoints to health-check when responding to Routing Policy queries. Only the healthy endpoints will be included in the response. # For A and AAAA types only. Endpoints to return in the query result only if they are healthy. These can be specified along with `rrdata` within this item. "internalLoadBalancers": [ # Configuration for internal load balancers to be health checked. { # The configuration for an individual load balancer to health check. "ipAddress": "A String", # The frontend IP address of the load balancer to health check. "ipProtocol": "A String", # The protocol of the load balancer to health check. "kind": "dns#rRSetRoutingPolicyLoadBalancerTarget", "loadBalancerType": "A String", # The type of load balancer specified by this target. This value must match the configuration of the load balancer located at the LoadBalancerTarget's IP address, port, and region. Use the following: - *regionalL4ilb*: for a regional internal passthrough Network Load Balancer. - *regionalL7ilb*: for a regional internal Application Load Balancer. - *globalL7ilb*: for a global internal Application Load Balancer. - "networkUrl": "A String", # The fully qualified URL of the network that the load balancer is attached to. This should be formatted like https://www.googleapis.com/compute/v1/projects/{project}/global/networks/{network} . + "networkUrl": "A String", # The fully qualified URL of the network that the load balancer is attached to. This should be formatted like `https://www.googleapis.com/compute/v1/projects/{project}/global/networks/{network}`. "port": "A String", # The configured port of the load balancer. "project": "A String", # The project ID in which the load balancer is located. "region": "A String", # The region in which the load balancer is located. @@ -1625,25 +1616,25 @@

Method Details

"rrdatas": [ "A String", ], - "signatureRrdatas": [ # DNSSEC generated signatures for all the rrdata within this item. If health checked targets are provided for DNSSEC enabled zones, there's a restriction of 1 IP address per item. + "signatureRrdatas": [ # DNSSEC generated signatures for all the `rrdata` within this item. If health checked targets are provided for DNSSEC enabled zones, there's a restriction of 1 IP address per item. "A String", ], }, ], "kind": "dns#rRSetRoutingPolicyGeoPolicy", }, - "geoPolicy": { # Configures a RRSetRoutingPolicy that routes based on the geo location of the querying user. + "geoPolicy": { # Configures a `RRSetRoutingPolicy` that routes based on the geo location of the querying user. "enableFencing": True or False, # Without fencing, if health check fails for all configured items in the current geo bucket, we failover to the next nearest geo bucket. With fencing, if health checking is enabled, as long as some targets in the current geo bucket are healthy, we return only the healthy targets. However, if all targets are unhealthy, we don't failover to the next nearest bucket; instead, we return all the items in the current bucket even when all targets are unhealthy. "items": [ # The primary geo routing configuration. If there are multiple items with the same location, an error is returned instead. { # ResourceRecordSet data for one geo location. - "healthCheckedTargets": { # HealthCheckTargets describes endpoints to health-check when responding to Routing Policy queries. Only the healthy endpoints will be included in the response. Only one of internal_load_balancer and external_endpoints should be set. # For A and AAAA types only. Endpoints to return in the query result only if they are healthy. These can be specified along with rrdata within this item. + "healthCheckedTargets": { # HealthCheckTargets describes endpoints to health-check when responding to Routing Policy queries. Only the healthy endpoints will be included in the response. # For A and AAAA types only. Endpoints to return in the query result only if they are healthy. These can be specified along with `rrdata` within this item. "internalLoadBalancers": [ # Configuration for internal load balancers to be health checked. { # The configuration for an individual load balancer to health check. "ipAddress": "A String", # The frontend IP address of the load balancer to health check. "ipProtocol": "A String", # The protocol of the load balancer to health check. "kind": "dns#rRSetRoutingPolicyLoadBalancerTarget", "loadBalancerType": "A String", # The type of load balancer specified by this target. This value must match the configuration of the load balancer located at the LoadBalancerTarget's IP address, port, and region. Use the following: - *regionalL4ilb*: for a regional internal passthrough Network Load Balancer. - *regionalL7ilb*: for a regional internal Application Load Balancer. - *globalL7ilb*: for a global internal Application Load Balancer. - "networkUrl": "A String", # The fully qualified URL of the network that the load balancer is attached to. This should be formatted like https://www.googleapis.com/compute/v1/projects/{project}/global/networks/{network} . + "networkUrl": "A String", # The fully qualified URL of the network that the load balancer is attached to. This should be formatted like `https://www.googleapis.com/compute/v1/projects/{project}/global/networks/{network}`. "port": "A String", # The configured port of the load balancer. "project": "A String", # The project ID in which the load balancer is located. "region": "A String", # The region in which the load balancer is located. @@ -1655,7 +1646,7 @@

Method Details

"rrdatas": [ "A String", ], - "signatureRrdatas": [ # DNSSEC generated signatures for all the rrdata within this item. If health checked targets are provided for DNSSEC enabled zones, there's a restriction of 1 IP address per item. + "signatureRrdatas": [ # DNSSEC generated signatures for all the `rrdata` within this item. If health checked targets are provided for DNSSEC enabled zones, there's a restriction of 1 IP address per item. "A String", ], }, @@ -1664,18 +1655,18 @@

Method Details

}, "kind": "dns#rRSetRoutingPolicy", "primaryBackup": { # Configures a RRSetRoutingPolicy such that all queries are responded with the primary_targets if they are healthy. And if all of them are unhealthy, then we fallback to a geo localized policy. - "backupGeoTargets": { # Configures a RRSetRoutingPolicy that routes based on the geo location of the querying user. # Backup targets provide a regional failover policy for the otherwise global primary targets. If serving state is set to BACKUP, this policy essentially becomes a geo routing policy. + "backupGeoTargets": { # Configures a `RRSetRoutingPolicy` that routes based on the geo location of the querying user. # Backup targets provide a regional failover policy for the otherwise global primary targets. If serving state is set to `BACKUP`, this policy essentially becomes a geo routing policy. "enableFencing": True or False, # Without fencing, if health check fails for all configured items in the current geo bucket, we failover to the next nearest geo bucket. With fencing, if health checking is enabled, as long as some targets in the current geo bucket are healthy, we return only the healthy targets. However, if all targets are unhealthy, we don't failover to the next nearest bucket; instead, we return all the items in the current bucket even when all targets are unhealthy. "items": [ # The primary geo routing configuration. If there are multiple items with the same location, an error is returned instead. { # ResourceRecordSet data for one geo location. - "healthCheckedTargets": { # HealthCheckTargets describes endpoints to health-check when responding to Routing Policy queries. Only the healthy endpoints will be included in the response. Only one of internal_load_balancer and external_endpoints should be set. # For A and AAAA types only. Endpoints to return in the query result only if they are healthy. These can be specified along with rrdata within this item. + "healthCheckedTargets": { # HealthCheckTargets describes endpoints to health-check when responding to Routing Policy queries. Only the healthy endpoints will be included in the response. # For A and AAAA types only. Endpoints to return in the query result only if they are healthy. These can be specified along with `rrdata` within this item. "internalLoadBalancers": [ # Configuration for internal load balancers to be health checked. { # The configuration for an individual load balancer to health check. "ipAddress": "A String", # The frontend IP address of the load balancer to health check. "ipProtocol": "A String", # The protocol of the load balancer to health check. "kind": "dns#rRSetRoutingPolicyLoadBalancerTarget", "loadBalancerType": "A String", # The type of load balancer specified by this target. This value must match the configuration of the load balancer located at the LoadBalancerTarget's IP address, port, and region. Use the following: - *regionalL4ilb*: for a regional internal passthrough Network Load Balancer. - *regionalL7ilb*: for a regional internal Application Load Balancer. - *globalL7ilb*: for a global internal Application Load Balancer. - "networkUrl": "A String", # The fully qualified URL of the network that the load balancer is attached to. This should be formatted like https://www.googleapis.com/compute/v1/projects/{project}/global/networks/{network} . + "networkUrl": "A String", # The fully qualified URL of the network that the load balancer is attached to. This should be formatted like `https://www.googleapis.com/compute/v1/projects/{project}/global/networks/{network}`. "port": "A String", # The configured port of the load balancer. "project": "A String", # The project ID in which the load balancer is located. "region": "A String", # The region in which the load balancer is located. @@ -1687,7 +1678,7 @@

Method Details

"rrdatas": [ "A String", ], - "signatureRrdatas": [ # DNSSEC generated signatures for all the rrdata within this item. If health checked targets are provided for DNSSEC enabled zones, there's a restriction of 1 IP address per item. + "signatureRrdatas": [ # DNSSEC generated signatures for all the `rrdata` within this item. If health checked targets are provided for DNSSEC enabled zones, there's a restriction of 1 IP address per item. "A String", ], }, @@ -1695,33 +1686,33 @@

Method Details

"kind": "dns#rRSetRoutingPolicyGeoPolicy", }, "kind": "dns#rRSetRoutingPolicyPrimaryBackupPolicy", - "primaryTargets": { # HealthCheckTargets describes endpoints to health-check when responding to Routing Policy queries. Only the healthy endpoints will be included in the response. Only one of internal_load_balancer and external_endpoints should be set. # Endpoints that are health checked before making the routing decision. Unhealthy endpoints are omitted from the results. If all endpoints are unhealthy, we serve a response based on the backup_geo_targets. + "primaryTargets": { # HealthCheckTargets describes endpoints to health-check when responding to Routing Policy queries. Only the healthy endpoints will be included in the response. # Endpoints that are health checked before making the routing decision. Unhealthy endpoints are omitted from the results. If all endpoints are unhealthy, we serve a response based on the `backup_geo_targets`. "internalLoadBalancers": [ # Configuration for internal load balancers to be health checked. { # The configuration for an individual load balancer to health check. "ipAddress": "A String", # The frontend IP address of the load balancer to health check. "ipProtocol": "A String", # The protocol of the load balancer to health check. "kind": "dns#rRSetRoutingPolicyLoadBalancerTarget", "loadBalancerType": "A String", # The type of load balancer specified by this target. This value must match the configuration of the load balancer located at the LoadBalancerTarget's IP address, port, and region. Use the following: - *regionalL4ilb*: for a regional internal passthrough Network Load Balancer. - *regionalL7ilb*: for a regional internal Application Load Balancer. - *globalL7ilb*: for a global internal Application Load Balancer. - "networkUrl": "A String", # The fully qualified URL of the network that the load balancer is attached to. This should be formatted like https://www.googleapis.com/compute/v1/projects/{project}/global/networks/{network} . + "networkUrl": "A String", # The fully qualified URL of the network that the load balancer is attached to. This should be formatted like `https://www.googleapis.com/compute/v1/projects/{project}/global/networks/{network}`. "port": "A String", # The configured port of the load balancer. "project": "A String", # The project ID in which the load balancer is located. "region": "A String", # The region in which the load balancer is located. }, ], }, - "trickleTraffic": 3.14, # When serving state is PRIMARY, this field provides the option of sending a small percentage of the traffic to the backup targets. + "trickleTraffic": 3.14, # When serving state is `PRIMARY`, this field provides the option of sending a small percentage of the traffic to the backup targets. }, "wrr": { # Configures a RRSetRoutingPolicy that routes in a weighted round robin fashion. "items": [ { # A routing block which contains the routing information for one WRR item. - "healthCheckedTargets": { # HealthCheckTargets describes endpoints to health-check when responding to Routing Policy queries. Only the healthy endpoints will be included in the response. Only one of internal_load_balancer and external_endpoints should be set. # Endpoints that are health checked before making the routing decision. The unhealthy endpoints are omitted from the result. If all endpoints within a bucket are unhealthy, we choose a different bucket (sampled with respect to its weight) for responding. If DNSSEC is enabled for this zone, only one of rrdata or health_checked_targets can be set. + "healthCheckedTargets": { # HealthCheckTargets describes endpoints to health-check when responding to Routing Policy queries. Only the healthy endpoints will be included in the response. # Endpoints that are health checked before making the routing decision. The unhealthy endpoints are omitted from the result. If all endpoints within a bucket are unhealthy, we choose a different bucket (sampled with respect to its weight) for responding. If DNSSEC is enabled for this zone, only one of `rrdata` or `health_checked_targets` can be set. "internalLoadBalancers": [ # Configuration for internal load balancers to be health checked. { # The configuration for an individual load balancer to health check. "ipAddress": "A String", # The frontend IP address of the load balancer to health check. "ipProtocol": "A String", # The protocol of the load balancer to health check. "kind": "dns#rRSetRoutingPolicyLoadBalancerTarget", "loadBalancerType": "A String", # The type of load balancer specified by this target. This value must match the configuration of the load balancer located at the LoadBalancerTarget's IP address, port, and region. Use the following: - *regionalL4ilb*: for a regional internal passthrough Network Load Balancer. - *regionalL7ilb*: for a regional internal Application Load Balancer. - *globalL7ilb*: for a global internal Application Load Balancer. - "networkUrl": "A String", # The fully qualified URL of the network that the load balancer is attached to. This should be formatted like https://www.googleapis.com/compute/v1/projects/{project}/global/networks/{network} . + "networkUrl": "A String", # The fully qualified URL of the network that the load balancer is attached to. This should be formatted like `https://www.googleapis.com/compute/v1/projects/{project}/global/networks/{network}`. "port": "A String", # The configured port of the load balancer. "project": "A String", # The project ID in which the load balancer is located. "region": "A String", # The region in which the load balancer is located. @@ -1732,10 +1723,10 @@

Method Details

"rrdatas": [ "A String", ], - "signatureRrdatas": [ # DNSSEC generated signatures for all the rrdata within this item. Note that if health checked targets are provided for DNSSEC enabled zones, there's a restriction of 1 IP address per item. + "signatureRrdatas": [ # DNSSEC generated signatures for all the `rrdata` within this item. Note that if health checked targets are provided for DNSSEC enabled zones, there's a restriction of 1 IP address per item. "A String", ], - "weight": 3.14, # The weight corresponding to this WrrPolicyItem object. When multiple WrrPolicyItem objects are configured, the probability of returning an WrrPolicyItem object's data is proportional to its weight relative to the sum of weights configured for all items. This weight must be non-negative. + "weight": 3.14, # The weight corresponding to this `WrrPolicyItem` object. When multiple `WrrPolicyItem` objects are configured, the probability of returning an `WrrPolicyItem` object's data is proportional to its weight relative to the sum of weights configured for all items. This weight must be non-negative. }, ], "kind": "dns#rRSetRoutingPolicyWrrPolicy", @@ -1743,14 +1734,14 @@

Method Details

"wrrPolicy": { # Configures a RRSetRoutingPolicy that routes in a weighted round robin fashion. "items": [ { # A routing block which contains the routing information for one WRR item. - "healthCheckedTargets": { # HealthCheckTargets describes endpoints to health-check when responding to Routing Policy queries. Only the healthy endpoints will be included in the response. Only one of internal_load_balancer and external_endpoints should be set. # Endpoints that are health checked before making the routing decision. The unhealthy endpoints are omitted from the result. If all endpoints within a bucket are unhealthy, we choose a different bucket (sampled with respect to its weight) for responding. If DNSSEC is enabled for this zone, only one of rrdata or health_checked_targets can be set. + "healthCheckedTargets": { # HealthCheckTargets describes endpoints to health-check when responding to Routing Policy queries. Only the healthy endpoints will be included in the response. # Endpoints that are health checked before making the routing decision. The unhealthy endpoints are omitted from the result. If all endpoints within a bucket are unhealthy, we choose a different bucket (sampled with respect to its weight) for responding. If DNSSEC is enabled for this zone, only one of `rrdata` or `health_checked_targets` can be set. "internalLoadBalancers": [ # Configuration for internal load balancers to be health checked. { # The configuration for an individual load balancer to health check. "ipAddress": "A String", # The frontend IP address of the load balancer to health check. "ipProtocol": "A String", # The protocol of the load balancer to health check. "kind": "dns#rRSetRoutingPolicyLoadBalancerTarget", "loadBalancerType": "A String", # The type of load balancer specified by this target. This value must match the configuration of the load balancer located at the LoadBalancerTarget's IP address, port, and region. Use the following: - *regionalL4ilb*: for a regional internal passthrough Network Load Balancer. - *regionalL7ilb*: for a regional internal Application Load Balancer. - *globalL7ilb*: for a global internal Application Load Balancer. - "networkUrl": "A String", # The fully qualified URL of the network that the load balancer is attached to. This should be formatted like https://www.googleapis.com/compute/v1/projects/{project}/global/networks/{network} . + "networkUrl": "A String", # The fully qualified URL of the network that the load balancer is attached to. This should be formatted like `https://www.googleapis.com/compute/v1/projects/{project}/global/networks/{network}`. "port": "A String", # The configured port of the load balancer. "project": "A String", # The project ID in which the load balancer is located. "region": "A String", # The region in which the load balancer is located. @@ -1761,10 +1752,10 @@

Method Details

"rrdatas": [ "A String", ], - "signatureRrdatas": [ # DNSSEC generated signatures for all the rrdata within this item. Note that if health checked targets are provided for DNSSEC enabled zones, there's a restriction of 1 IP address per item. + "signatureRrdatas": [ # DNSSEC generated signatures for all the `rrdata` within this item. Note that if health checked targets are provided for DNSSEC enabled zones, there's a restriction of 1 IP address per item. "A String", ], - "weight": 3.14, # The weight corresponding to this WrrPolicyItem object. When multiple WrrPolicyItem objects are configured, the probability of returning an WrrPolicyItem object's data is proportional to its weight relative to the sum of weights configured for all items. This weight must be non-negative. + "weight": 3.14, # The weight corresponding to this `WrrPolicyItem` object. When multiple `WrrPolicyItem` objects are configured, the probability of returning an `WrrPolicyItem` object's data is proportional to its weight relative to the sum of weights configured for all items. This weight must be non-negative. }, ], "kind": "dns#rRSetRoutingPolicyWrrPolicy", @@ -1776,7 +1767,7 @@

Method Details

"signatureRrdatas": [ # As defined in RFC 4034 (section 3.2). "A String", ], - "ttl": 42, # Number of seconds that this ResourceRecordSet can be cached by resolvers. + "ttl": 42, # Number of seconds that this `ResourceRecordSet` can be cached by resolvers. "type": "A String", # The identifier of a supported record type. See the list of Supported DNS record types. }, ], diff --git a/docs/dyn/domains_v1.projects.locations.registrations.html b/docs/dyn/domains_v1.projects.locations.registrations.html index 2c4f8dbf544..d4ba6dafa1f 100644 --- a/docs/dyn/domains_v1.projects.locations.registrations.html +++ b/docs/dyn/domains_v1.projects.locations.registrations.html @@ -101,6 +101,9 @@

Instance Methods

import_(parent, body=None, x__xgafv=None)

Deprecated: For more information, see [Cloud Domains feature deprecation](https://cloud.google.com/domains/docs/deprecations/feature-deprecations) Imports a domain name from [Google Domains](https://domains.google/) for use in Cloud Domains. To transfer a domain from another registrar, use the `TransferDomain` method instead. Since individual users can own domains in Google Domains, the calling user must have ownership permission on the domain.

+

+ initiatePushTransfer(registration, body=None, x__xgafv=None)

+

Initiates the `Push Transfer` process to transfer the domain to another registrar. The process might complete instantly or might require confirmation or additional work. Check the emails sent to the email address of the registrant. The process is aborted after a timeout if it's not completed. This method is only supported for domains that have the `REQUIRE_PUSH_TRANSFER` property in the list of `domain_properties`. The domain must also be unlocked before it can be transferred to a different registrar. For more information, see [Transfer a registered domain to another registrar](https://cloud.google.com/domains/docs/transfer-domain-to-another-registrar).

list(parent, filter=None, pageSize=None, pageToken=None, x__xgafv=None)

Lists the `Registration` resources in a project.

@@ -113,12 +116,18 @@

Instance Methods

register(parent, body=None, x__xgafv=None)

Registers a new domain name and creates a corresponding `Registration` resource. Call `RetrieveRegisterParameters` first to check availability of the domain name and determine parameters like price that are needed to build a call to this method. A successful call creates a `Registration` resource in state `REGISTRATION_PENDING`, which resolves to `ACTIVE` within 1-2 minutes, indicating that the domain was successfully registered. If the resource ends up in state `REGISTRATION_FAILED`, it indicates that the domain was not registered successfully, and you can safely delete the resource and retry registration.

+

+ renewDomain(registration, body=None, x__xgafv=None)

+

Renews a recently expired domain. This method can only be called on domains that expired in the previous 30 days. After the renewal, the new expiration time of the domain is one year after the old expiration time and you are charged a `yearly_price` for the renewal.

resetAuthorizationCode(registration, body=None, x__xgafv=None)

-

Resets the authorization code of the `Registration` to a new random string. You can call this method only after 60 days have elapsed since the initial domain registration.

+

Resets the authorization code of the `Registration` to a new random string. You can call this method only after 60 days have elapsed since the initial domain registration. Domains that have the `REQUIRE_PUSH_TRANSFER` property in the list of `domain_properties` don't support authorization codes and must use the `InitiatePushTransfer` method to initiate the process to transfer the domain to a different registrar.

retrieveAuthorizationCode(registration, x__xgafv=None)

-

Gets the authorization code of the `Registration` for the purpose of transferring the domain to another registrar. You can call this method only after 60 days have elapsed since the initial domain registration.

+

Gets the authorization code of the `Registration` for the purpose of transferring the domain to another registrar. You can call this method only after 60 days have elapsed since the initial domain registration. Domains that have the `REQUIRE_PUSH_TRANSFER` property in the list of `domain_properties` don't support authorization codes and must use the `InitiatePushTransfer` method to initiate the process to transfer the domain to a different registrar.

+

+ retrieveGoogleDomainsForwardingConfig(registration, x__xgafv=None)

+

Lists the deprecated domain and email forwarding configurations you set up in the deprecated Google Domains UI. The configuration is present only for domains with the `google_domains_redirects_data_available` set to `true` in the `Registration`'s `dns_settings`. A forwarding configuration might not work correctly if required DNS records are not present in the domain's authoritative DNS Zone.

retrieveImportableDomains(location, pageSize=None, pageToken=None, x__xgafv=None)

Deprecated: For more information, see [Cloud Domains feature deprecation](https://cloud.google.com/domains/docs/deprecations/feature-deprecations) Lists domain names from [Google Domains](https://domains.google/) that can be imported to Cloud Domains using the `ImportDomain` method. Since individual users can own domains in Google Domains, the list of domains returned depends on the individual user making the call. Domains already managed by Cloud Domains are not returned.

@@ -358,9 +367,10 @@

Method Details

{ # Request for the `ConfigureManagementSettings` method. "managementSettings": { # Defines renewal, billing, and transfer settings for a `Registration`. # Fields of the `ManagementSettings` to update. + "effectiveTransferLockState": "A String", # Output only. The actual transfer lock state for this `Registration`. "preferredRenewalMethod": "A String", # Optional. The desired renewal method for this `Registration`. The actual `renewal_method` is automatically updated to reflect this choice. If unset or equal to `RENEWAL_METHOD_UNSPECIFIED`, the actual `renewalMethod` is treated as if it were set to `AUTOMATIC_RENEWAL`. You cannot use `RENEWAL_DISABLED` during resource creation, and you can update the renewal status only when the `Registration` resource has state `ACTIVE` or `SUSPENDED`. When `preferred_renewal_method` is set to `AUTOMATIC_RENEWAL`, the actual `renewal_method` can be set to `RENEWAL_DISABLED` in case of problems with the billing account or reported domain abuse. In such cases, check the `issues` field on the `Registration`. After the problem is resolved, the `renewal_method` is automatically updated to `preferred_renewal_method` in a few hours. "renewalMethod": "A String", # Output only. The actual renewal method for this `Registration`. When `preferred_renewal_method` is set to `AUTOMATIC_RENEWAL`, the actual `renewal_method` can be equal to `RENEWAL_DISABLED`—for example, when there are problems with the billing account or reported domain abuse. In such cases, check the `issues` field on the `Registration`. After the problem is resolved, the `renewal_method` is automatically updated to `preferred_renewal_method` in a few hours. - "transferLockState": "A String", # This is the desired transfer lock state for this `Registration`. A transfer lock controls whether the domain can be transferred to another registrar. + "transferLockState": "A String", # This is the desired transfer lock state for this `Registration`. A transfer lock controls whether the domain can be transferred to another registrar. The transfer lock state of the domain is returned in the `effective_transfer_lock_state` property. The transfer lock state values might be different for the following reasons: * `transfer_lock_state` was updated only a short time ago. * Domains with the `TRANSFER_LOCK_UNSUPPORTED_BY_REGISTRY` state are in the list of `domain_properties`. These domains are always in the `UNLOCKED` state. }, "updateMask": "A String", # Required. The field mask describing which fields to update as a comma-separated list. For example, if only the transfer lock is being updated, the `update_mask` is `"transfer_lock_state"`. } @@ -596,6 +606,9 @@

Method Details

}, }, "domainName": "A String", # Required. Immutable. The domain name. Unicode domain names must be expressed in Punycode format. + "domainProperties": [ # Output only. Special properties of the domain. + "A String", + ], "expireTime": "A String", # Output only. The expiration timestamp of the `Registration`. "issues": [ # Output only. The set of issues with the `Registration` that require attention. "A String", @@ -604,9 +617,10 @@

Method Details

"a_key": "A String", }, "managementSettings": { # Defines renewal, billing, and transfer settings for a `Registration`. # Settings for management of the `Registration`, including renewal, billing, and transfer. You cannot update these with the `UpdateRegistration` method. To update these settings, use the `ConfigureManagementSettings` method. + "effectiveTransferLockState": "A String", # Output only. The actual transfer lock state for this `Registration`. "preferredRenewalMethod": "A String", # Optional. The desired renewal method for this `Registration`. The actual `renewal_method` is automatically updated to reflect this choice. If unset or equal to `RENEWAL_METHOD_UNSPECIFIED`, the actual `renewalMethod` is treated as if it were set to `AUTOMATIC_RENEWAL`. You cannot use `RENEWAL_DISABLED` during resource creation, and you can update the renewal status only when the `Registration` resource has state `ACTIVE` or `SUSPENDED`. When `preferred_renewal_method` is set to `AUTOMATIC_RENEWAL`, the actual `renewal_method` can be set to `RENEWAL_DISABLED` in case of problems with the billing account or reported domain abuse. In such cases, check the `issues` field on the `Registration`. After the problem is resolved, the `renewal_method` is automatically updated to `preferred_renewal_method` in a few hours. "renewalMethod": "A String", # Output only. The actual renewal method for this `Registration`. When `preferred_renewal_method` is set to `AUTOMATIC_RENEWAL`, the actual `renewal_method` can be equal to `RENEWAL_DISABLED`—for example, when there are problems with the billing account or reported domain abuse. In such cases, check the `issues` field on the `Registration`. After the problem is resolved, the `renewal_method` is automatically updated to `preferred_renewal_method` in a few hours. - "transferLockState": "A String", # This is the desired transfer lock state for this `Registration`. A transfer lock controls whether the domain can be transferred to another registrar. + "transferLockState": "A String", # This is the desired transfer lock state for this `Registration`. A transfer lock controls whether the domain can be transferred to another registrar. The transfer lock state of the domain is returned in the `effective_transfer_lock_state` property. The transfer lock state values might be different for the following reasons: * `transfer_lock_state` was updated only a short time ago. * Domains with the `TRANSFER_LOCK_UNSUPPORTED_BY_REGISTRY` state are in the list of `domain_properties`. These domains are always in the `UNLOCKED` state. }, "name": "A String", # Output only. Name of the `Registration` resource, in the format `projects/*/locations/*/registrations/`. "pendingContactSettings": { # Defines the contact information associated with a `Registration`. [ICANN](https://icann.org/) requires all domain names to have associated contact information. The `registrant_contact` is considered the domain's legal owner, and often the other contacts are identical. # Output only. Pending contact settings for the `Registration`. Updates to the `contact_settings` field that change its `registrant_contact` or `privacy` fields require email confirmation by the `registrant_contact` before taking effect. This field is set only if there are pending updates to the `contact_settings` that have not been confirmed. To confirm the changes, the `registrant_contact` must follow the instructions in the email they receive. @@ -780,6 +794,48 @@

Method Details

} +
+ initiatePushTransfer(registration, body=None, x__xgafv=None) +
Initiates the `Push Transfer` process to transfer the domain to another registrar. The process might complete instantly or might require confirmation or additional work. Check the emails sent to the email address of the registrant. The process is aborted after a timeout if it's not completed. This method is only supported for domains that have the `REQUIRE_PUSH_TRANSFER` property in the list of `domain_properties`. The domain must also be unlocked before it can be transferred to a different registrar. For more information, see [Transfer a registered domain to another registrar](https://cloud.google.com/domains/docs/transfer-domain-to-another-registrar).
+
+Args:
+  registration: string, Required. The name of the `Registration` for which the push transfer is initiated, in the format `projects/*/locations/*/registrations/*`. (required)
+  body: object, The request body.
+    The object takes the form of:
+
+{ # Request for the `InitiatePushTransfer` method.
+  "tag": "A String", # Required. The Tag of the new registrar. Can be found at [List of registrars](https://nominet.uk/registrar-list/).
+}
+
+  x__xgafv: string, V1 error format.
+    Allowed values
+      1 - v1 error format
+      2 - v2 error format
+
+Returns:
+  An object of the form:
+
+    { # This resource represents a long-running operation that is the result of a network API call.
+  "done": True or False, # If the value is `false`, it means the operation is still in progress. If `true`, the operation is completed, and either `error` or `response` is available.
+  "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). # The error result of the operation in case of failure or cancellation.
+    "code": 42, # The status code, which should be an enum value of google.rpc.Code.
+    "details": [ # A list of messages that carry the error details. There is a common set of message types for APIs to use.
+      {
+        "a_key": "", # Properties of the object. Contains field @type with type URL.
+      },
+    ],
+    "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.
+  },
+  "metadata": { # Service-specific metadata associated with the operation. It typically contains progress information and common metadata such as create time. Some services might not provide such metadata. Any method that returns a long-running operation should document the metadata type, if any.
+    "a_key": "", # Properties of the object. Contains field @type with type URL.
+  },
+  "name": "A String", # The server-assigned name, which is only unique within the same service that originally returns it. If you use the default HTTP mapping, the `name` should be a resource name ending with `operations/{unique_id}`.
+  "response": { # The normal, successful response of the operation. If the original method returns no data on success, such as `Delete`, the response is `google.protobuf.Empty`. If the original method is standard `Get`/`Create`/`Update`, the response should be the resource. For other methods, the response should have the type `XxxResponse`, where `Xxx` is the original method name. For example, if the original method name is `TakeSnapshot()`, the inferred response type is `TakeSnapshotResponse`.
+    "a_key": "", # Properties of the object. Contains field @type with type URL.
+  },
+}
+
+
list(parent, filter=None, pageSize=None, pageToken=None, x__xgafv=None)
Lists the `Registration` resources in a project.
@@ -912,6 +968,9 @@ 

Method Details

}, }, "domainName": "A String", # Required. Immutable. The domain name. Unicode domain names must be expressed in Punycode format. + "domainProperties": [ # Output only. Special properties of the domain. + "A String", + ], "expireTime": "A String", # Output only. The expiration timestamp of the `Registration`. "issues": [ # Output only. The set of issues with the `Registration` that require attention. "A String", @@ -920,9 +979,10 @@

Method Details

"a_key": "A String", }, "managementSettings": { # Defines renewal, billing, and transfer settings for a `Registration`. # Settings for management of the `Registration`, including renewal, billing, and transfer. You cannot update these with the `UpdateRegistration` method. To update these settings, use the `ConfigureManagementSettings` method. + "effectiveTransferLockState": "A String", # Output only. The actual transfer lock state for this `Registration`. "preferredRenewalMethod": "A String", # Optional. The desired renewal method for this `Registration`. The actual `renewal_method` is automatically updated to reflect this choice. If unset or equal to `RENEWAL_METHOD_UNSPECIFIED`, the actual `renewalMethod` is treated as if it were set to `AUTOMATIC_RENEWAL`. You cannot use `RENEWAL_DISABLED` during resource creation, and you can update the renewal status only when the `Registration` resource has state `ACTIVE` or `SUSPENDED`. When `preferred_renewal_method` is set to `AUTOMATIC_RENEWAL`, the actual `renewal_method` can be set to `RENEWAL_DISABLED` in case of problems with the billing account or reported domain abuse. In such cases, check the `issues` field on the `Registration`. After the problem is resolved, the `renewal_method` is automatically updated to `preferred_renewal_method` in a few hours. "renewalMethod": "A String", # Output only. The actual renewal method for this `Registration`. When `preferred_renewal_method` is set to `AUTOMATIC_RENEWAL`, the actual `renewal_method` can be equal to `RENEWAL_DISABLED`—for example, when there are problems with the billing account or reported domain abuse. In such cases, check the `issues` field on the `Registration`. After the problem is resolved, the `renewal_method` is automatically updated to `preferred_renewal_method` in a few hours. - "transferLockState": "A String", # This is the desired transfer lock state for this `Registration`. A transfer lock controls whether the domain can be transferred to another registrar. + "transferLockState": "A String", # This is the desired transfer lock state for this `Registration`. A transfer lock controls whether the domain can be transferred to another registrar. The transfer lock state of the domain is returned in the `effective_transfer_lock_state` property. The transfer lock state values might be different for the following reasons: * `transfer_lock_state` was updated only a short time ago. * Domains with the `TRANSFER_LOCK_UNSUPPORTED_BY_REGISTRY` state are in the list of `domain_properties`. These domains are always in the `UNLOCKED` state. }, "name": "A String", # Output only. Name of the `Registration` resource, in the format `projects/*/locations/*/registrations/`. "pendingContactSettings": { # Defines the contact information associated with a `Registration`. [ICANN](https://icann.org/) requires all domain names to have associated contact information. The `registrant_contact` is considered the domain's legal owner, and often the other contacts are identical. # Output only. Pending contact settings for the `Registration`. Updates to the `contact_settings` field that change its `registrant_contact` or `privacy` fields require email confirmation by the `registrant_contact` before taking effect. This field is set only if there are pending updates to the `contact_settings` that have not been confirmed. To confirm the changes, the `registrant_contact` must follow the instructions in the email they receive. @@ -1140,6 +1200,9 @@

Method Details

}, }, "domainName": "A String", # Required. Immutable. The domain name. Unicode domain names must be expressed in Punycode format. + "domainProperties": [ # Output only. Special properties of the domain. + "A String", + ], "expireTime": "A String", # Output only. The expiration timestamp of the `Registration`. "issues": [ # Output only. The set of issues with the `Registration` that require attention. "A String", @@ -1148,9 +1211,10 @@

Method Details

"a_key": "A String", }, "managementSettings": { # Defines renewal, billing, and transfer settings for a `Registration`. # Settings for management of the `Registration`, including renewal, billing, and transfer. You cannot update these with the `UpdateRegistration` method. To update these settings, use the `ConfigureManagementSettings` method. + "effectiveTransferLockState": "A String", # Output only. The actual transfer lock state for this `Registration`. "preferredRenewalMethod": "A String", # Optional. The desired renewal method for this `Registration`. The actual `renewal_method` is automatically updated to reflect this choice. If unset or equal to `RENEWAL_METHOD_UNSPECIFIED`, the actual `renewalMethod` is treated as if it were set to `AUTOMATIC_RENEWAL`. You cannot use `RENEWAL_DISABLED` during resource creation, and you can update the renewal status only when the `Registration` resource has state `ACTIVE` or `SUSPENDED`. When `preferred_renewal_method` is set to `AUTOMATIC_RENEWAL`, the actual `renewal_method` can be set to `RENEWAL_DISABLED` in case of problems with the billing account or reported domain abuse. In such cases, check the `issues` field on the `Registration`. After the problem is resolved, the `renewal_method` is automatically updated to `preferred_renewal_method` in a few hours. "renewalMethod": "A String", # Output only. The actual renewal method for this `Registration`. When `preferred_renewal_method` is set to `AUTOMATIC_RENEWAL`, the actual `renewal_method` can be equal to `RENEWAL_DISABLED`—for example, when there are problems with the billing account or reported domain abuse. In such cases, check the `issues` field on the `Registration`. After the problem is resolved, the `renewal_method` is automatically updated to `preferred_renewal_method` in a few hours. - "transferLockState": "A String", # This is the desired transfer lock state for this `Registration`. A transfer lock controls whether the domain can be transferred to another registrar. + "transferLockState": "A String", # This is the desired transfer lock state for this `Registration`. A transfer lock controls whether the domain can be transferred to another registrar. The transfer lock state of the domain is returned in the `effective_transfer_lock_state` property. The transfer lock state values might be different for the following reasons: * `transfer_lock_state` was updated only a short time ago. * Domains with the `TRANSFER_LOCK_UNSUPPORTED_BY_REGISTRY` state are in the list of `domain_properties`. These domains are always in the `UNLOCKED` state. }, "name": "A String", # Output only. Name of the `Registration` resource, in the format `projects/*/locations/*/registrations/`. "pendingContactSettings": { # Defines the contact information associated with a `Registration`. [ICANN](https://icann.org/) requires all domain names to have associated contact information. The `registrant_contact` is considered the domain's legal owner, and often the other contacts are identical. # Output only. Pending contact settings for the `Registration`. Updates to the `contact_settings` field that change its `registrant_contact` or `privacy` fields require email confirmation by the `registrant_contact` before taking effect. This field is set only if there are pending updates to the `contact_settings` that have not been confirmed. To confirm the changes, the `registrant_contact` must follow the instructions in the email they receive. @@ -1388,6 +1452,9 @@

Method Details

}, }, "domainName": "A String", # Required. Immutable. The domain name. Unicode domain names must be expressed in Punycode format. + "domainProperties": [ # Output only. Special properties of the domain. + "A String", + ], "expireTime": "A String", # Output only. The expiration timestamp of the `Registration`. "issues": [ # Output only. The set of issues with the `Registration` that require attention. "A String", @@ -1396,9 +1463,10 @@

Method Details

"a_key": "A String", }, "managementSettings": { # Defines renewal, billing, and transfer settings for a `Registration`. # Settings for management of the `Registration`, including renewal, billing, and transfer. You cannot update these with the `UpdateRegistration` method. To update these settings, use the `ConfigureManagementSettings` method. + "effectiveTransferLockState": "A String", # Output only. The actual transfer lock state for this `Registration`. "preferredRenewalMethod": "A String", # Optional. The desired renewal method for this `Registration`. The actual `renewal_method` is automatically updated to reflect this choice. If unset or equal to `RENEWAL_METHOD_UNSPECIFIED`, the actual `renewalMethod` is treated as if it were set to `AUTOMATIC_RENEWAL`. You cannot use `RENEWAL_DISABLED` during resource creation, and you can update the renewal status only when the `Registration` resource has state `ACTIVE` or `SUSPENDED`. When `preferred_renewal_method` is set to `AUTOMATIC_RENEWAL`, the actual `renewal_method` can be set to `RENEWAL_DISABLED` in case of problems with the billing account or reported domain abuse. In such cases, check the `issues` field on the `Registration`. After the problem is resolved, the `renewal_method` is automatically updated to `preferred_renewal_method` in a few hours. "renewalMethod": "A String", # Output only. The actual renewal method for this `Registration`. When `preferred_renewal_method` is set to `AUTOMATIC_RENEWAL`, the actual `renewal_method` can be equal to `RENEWAL_DISABLED`—for example, when there are problems with the billing account or reported domain abuse. In such cases, check the `issues` field on the `Registration`. After the problem is resolved, the `renewal_method` is automatically updated to `preferred_renewal_method` in a few hours. - "transferLockState": "A String", # This is the desired transfer lock state for this `Registration`. A transfer lock controls whether the domain can be transferred to another registrar. + "transferLockState": "A String", # This is the desired transfer lock state for this `Registration`. A transfer lock controls whether the domain can be transferred to another registrar. The transfer lock state of the domain is returned in the `effective_transfer_lock_state` property. The transfer lock state values might be different for the following reasons: * `transfer_lock_state` was updated only a short time ago. * Domains with the `TRANSFER_LOCK_UNSUPPORTED_BY_REGISTRY` state are in the list of `domain_properties`. These domains are always in the `UNLOCKED` state. }, "name": "A String", # Output only. Name of the `Registration` resource, in the format `projects/*/locations/*/registrations/`. "pendingContactSettings": { # Defines the contact information associated with a `Registration`. [ICANN](https://icann.org/) requires all domain names to have associated contact information. The `registrant_contact` is considered the domain's legal owner, and often the other contacts are identical. # Output only. Pending contact settings for the `Registration`. Updates to the `contact_settings` field that change its `registrant_contact` or `privacy` fields require email confirmation by the `registrant_contact` before taking effect. This field is set only if there are pending updates to the `contact_settings` that have not been confirmed. To confirm the changes, the `registrant_contact` must follow the instructions in the email they receive. @@ -1514,9 +1582,56 @@

Method Details

}
+
+ renewDomain(registration, body=None, x__xgafv=None) +
Renews a recently expired domain. This method can only be called on domains that expired in the previous 30 days. After the renewal, the new expiration time of the domain is one year after the old expiration time and you are charged a `yearly_price` for the renewal.
+
+Args:
+  registration: string, Required. The name of the `Registration` whish is being renewed, in the format `projects/*/locations/*/registrations/*`. (required)
+  body: object, The request body.
+    The object takes the form of:
+
+{ # Request for the `RenewDomain` method.
+  "validateOnly": True or False, # Optional. When true, only validation is performed, without actually renewing the domain. For more information, see [Request validation](https://cloud.google.com/apis/design/design_patterns#request_validation)
+  "yearlyPrice": { # Represents an amount of money with its currency type. # Required. Acknowledgement of the price to renew the domain for one year. To get the price, see [Cloud Domains pricing](https://cloud.google.com/domains/pricing). If not provided, the expected price is returned in the error message.
+    "currencyCode": "A String", # The three-letter currency code defined in ISO 4217.
+    "nanos": 42, # Number of nano (10^-9) units of the amount. The value must be between -999,999,999 and +999,999,999 inclusive. If `units` is positive, `nanos` must be positive or zero. If `units` is zero, `nanos` can be positive, zero, or negative. If `units` is negative, `nanos` must be negative or zero. For example $-1.75 is represented as `units`=-1 and `nanos`=-750,000,000.
+    "units": "A String", # The whole units of the amount. For example if `currencyCode` is `"USD"`, then 1 unit is one US dollar.
+  },
+}
+
+  x__xgafv: string, V1 error format.
+    Allowed values
+      1 - v1 error format
+      2 - v2 error format
+
+Returns:
+  An object of the form:
+
+    { # This resource represents a long-running operation that is the result of a network API call.
+  "done": True or False, # If the value is `false`, it means the operation is still in progress. If `true`, the operation is completed, and either `error` or `response` is available.
+  "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). # The error result of the operation in case of failure or cancellation.
+    "code": 42, # The status code, which should be an enum value of google.rpc.Code.
+    "details": [ # A list of messages that carry the error details. There is a common set of message types for APIs to use.
+      {
+        "a_key": "", # Properties of the object. Contains field @type with type URL.
+      },
+    ],
+    "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.
+  },
+  "metadata": { # Service-specific metadata associated with the operation. It typically contains progress information and common metadata such as create time. Some services might not provide such metadata. Any method that returns a long-running operation should document the metadata type, if any.
+    "a_key": "", # Properties of the object. Contains field @type with type URL.
+  },
+  "name": "A String", # The server-assigned name, which is only unique within the same service that originally returns it. If you use the default HTTP mapping, the `name` should be a resource name ending with `operations/{unique_id}`.
+  "response": { # The normal, successful response of the operation. If the original method returns no data on success, such as `Delete`, the response is `google.protobuf.Empty`. If the original method is standard `Get`/`Create`/`Update`, the response should be the resource. For other methods, the response should have the type `XxxResponse`, where `Xxx` is the original method name. For example, if the original method name is `TakeSnapshot()`, the inferred response type is `TakeSnapshotResponse`.
+    "a_key": "", # Properties of the object. Contains field @type with type URL.
+  },
+}
+
+
resetAuthorizationCode(registration, body=None, x__xgafv=None) -
Resets the authorization code of the `Registration` to a new random string. You can call this method only after 60 days have elapsed since the initial domain registration.
+  
Resets the authorization code of the `Registration` to a new random string. You can call this method only after 60 days have elapsed since the initial domain registration. Domains that have the `REQUIRE_PUSH_TRANSFER` property in the list of `domain_properties` don't support authorization codes and must use the `InitiatePushTransfer` method to initiate the process to transfer the domain to a different registrar.
 
 Args:
   registration: string, Required. The name of the `Registration` whose authorization code is being reset, in the format `projects/*/locations/*/registrations/*`. (required)
@@ -1541,7 +1656,7 @@ 

Method Details

retrieveAuthorizationCode(registration, x__xgafv=None) -
Gets the authorization code of the `Registration` for the purpose of transferring the domain to another registrar. You can call this method only after 60 days have elapsed since the initial domain registration.
+  
Gets the authorization code of the `Registration` for the purpose of transferring the domain to another registrar. You can call this method only after 60 days have elapsed since the initial domain registration. Domains that have the `REQUIRE_PUSH_TRANSFER` property in the list of `domain_properties` don't support authorization codes and must use the `InitiatePushTransfer` method to initiate the process to transfer the domain to a different registrar.
 
 Args:
   registration: string, Required. The name of the `Registration` whose authorization code is being retrieved, in the format `projects/*/locations/*/registrations/*`. (required)
@@ -1558,6 +1673,40 @@ 

Method Details

}
+
+ retrieveGoogleDomainsForwardingConfig(registration, x__xgafv=None) +
Lists the deprecated domain and email forwarding configurations you set up in the deprecated Google Domains UI. The configuration is present only for domains with the `google_domains_redirects_data_available` set to `true` in the `Registration`'s `dns_settings`. A forwarding configuration might not work correctly if required DNS records are not present in the domain's authoritative DNS Zone.
+
+Args:
+  registration: string, Required. The name of the `Registration` whose Google Domains forwarding configuration details are being retrieved, in the format `projects/*/locations/*/registrations/*`. (required)
+  x__xgafv: string, V1 error format.
+    Allowed values
+      1 - v1 error format
+      2 - v2 error format
+
+Returns:
+  An object of the form:
+
+    { # Response for the `RetrieveGoogleDomainsForwardingConfig` method.
+  "domainForwardings": [ # The list of domain forwarding configurations. A forwarding configuration might not work correctly if the required DNS records are not present in the domain's authoritative DNS zone.
+    { # Domain forwarding configuration.
+      "pathForwarding": True or False, # If true, forwards the path after the domain name to the same path at the new address.
+      "pemCertificate": "A String", # The PEM-encoded certificate chain.
+      "redirectType": "A String", # The redirect type.
+      "sslEnabled": True or False, # If true, the forwarding works also over HTTPS.
+      "subdomain": "A String", # The subdomain of the registered domain that is being forwarded. E.g. `www.example.com`, `example.com` (i.e. the registered domain itself) or `*.example.com` (i.e. all subdomains).
+      "targetUri": "A String", # The target of the domain forwarding, i.e. the path to redirect the `subdomain` to.
+    },
+  ],
+  "emailForwardings": [ # The list of email forwarding configurations. A forwarding configuration might not work correctly if the required DNS records are not present in the domain's authoritative DNS zone.
+    { # Email forwarding configuration.
+      "alias": "A String", # An alias recipient email that forwards emails to the `target_email_address`. For example, `admin@example.com` or `*@example.com` (wildcard alias forwards all the emails under the registered domain).
+      "targetEmailAddress": "A String", # Target email that receives emails sent to the `alias`.
+    },
+  ],
+}
+
+
retrieveImportableDomains(location, pageSize=None, pageToken=None, x__xgafv=None)
Deprecated: For more information, see [Cloud Domains feature deprecation](https://cloud.google.com/domains/docs/deprecations/feature-deprecations) Lists domain names from [Google Domains](https://domains.google/) that can be imported to Cloud Domains using the `ImportDomain` method. Since individual users can own domains in Google Domains, the list of domains returned depends on the individual user making the call. Domains already managed by Cloud Domains are not returned.
@@ -1953,6 +2102,9 @@ 

Method Details

}, }, "domainName": "A String", # Required. Immutable. The domain name. Unicode domain names must be expressed in Punycode format. + "domainProperties": [ # Output only. Special properties of the domain. + "A String", + ], "expireTime": "A String", # Output only. The expiration timestamp of the `Registration`. "issues": [ # Output only. The set of issues with the `Registration` that require attention. "A String", @@ -1961,9 +2113,10 @@

Method Details

"a_key": "A String", }, "managementSettings": { # Defines renewal, billing, and transfer settings for a `Registration`. # Settings for management of the `Registration`, including renewal, billing, and transfer. You cannot update these with the `UpdateRegistration` method. To update these settings, use the `ConfigureManagementSettings` method. + "effectiveTransferLockState": "A String", # Output only. The actual transfer lock state for this `Registration`. "preferredRenewalMethod": "A String", # Optional. The desired renewal method for this `Registration`. The actual `renewal_method` is automatically updated to reflect this choice. If unset or equal to `RENEWAL_METHOD_UNSPECIFIED`, the actual `renewalMethod` is treated as if it were set to `AUTOMATIC_RENEWAL`. You cannot use `RENEWAL_DISABLED` during resource creation, and you can update the renewal status only when the `Registration` resource has state `ACTIVE` or `SUSPENDED`. When `preferred_renewal_method` is set to `AUTOMATIC_RENEWAL`, the actual `renewal_method` can be set to `RENEWAL_DISABLED` in case of problems with the billing account or reported domain abuse. In such cases, check the `issues` field on the `Registration`. After the problem is resolved, the `renewal_method` is automatically updated to `preferred_renewal_method` in a few hours. "renewalMethod": "A String", # Output only. The actual renewal method for this `Registration`. When `preferred_renewal_method` is set to `AUTOMATIC_RENEWAL`, the actual `renewal_method` can be equal to `RENEWAL_DISABLED`—for example, when there are problems with the billing account or reported domain abuse. In such cases, check the `issues` field on the `Registration`. After the problem is resolved, the `renewal_method` is automatically updated to `preferred_renewal_method` in a few hours. - "transferLockState": "A String", # This is the desired transfer lock state for this `Registration`. A transfer lock controls whether the domain can be transferred to another registrar. + "transferLockState": "A String", # This is the desired transfer lock state for this `Registration`. A transfer lock controls whether the domain can be transferred to another registrar. The transfer lock state of the domain is returned in the `effective_transfer_lock_state` property. The transfer lock state values might be different for the following reasons: * `transfer_lock_state` was updated only a short time ago. * Domains with the `TRANSFER_LOCK_UNSUPPORTED_BY_REGISTRY` state are in the list of `domain_properties`. These domains are always in the `UNLOCKED` state. }, "name": "A String", # Output only. Name of the `Registration` resource, in the format `projects/*/locations/*/registrations/`. "pendingContactSettings": { # Defines the contact information associated with a `Registration`. [ICANN](https://icann.org/) requires all domain names to have associated contact information. The `registrant_contact` is considered the domain's legal owner, and often the other contacts are identical. # Output only. Pending contact settings for the `Registration`. Updates to the `contact_settings` field that change its `registrant_contact` or `privacy` fields require email confirmation by the `registrant_contact` before taking effect. This field is set only if there are pending updates to the `contact_settings` that have not been confirmed. To confirm the changes, the `registrant_contact` must follow the instructions in the email they receive. diff --git a/docs/dyn/domains_v1alpha2.projects.locations.registrations.html b/docs/dyn/domains_v1alpha2.projects.locations.registrations.html index 5be3ffaae98..fc7b07b048d 100644 --- a/docs/dyn/domains_v1alpha2.projects.locations.registrations.html +++ b/docs/dyn/domains_v1alpha2.projects.locations.registrations.html @@ -101,6 +101,9 @@

Instance Methods

import_(parent, body=None, x__xgafv=None)

Deprecated: For more information, see [Cloud Domains feature deprecation](https://cloud.google.com/domains/docs/deprecations/feature-deprecations) Imports a domain name from [Google Domains](https://domains.google/) for use in Cloud Domains. To transfer a domain from another registrar, use the `TransferDomain` method instead. Since individual users can own domains in Google Domains, the calling user must have ownership permission on the domain.

+

+ initiatePushTransfer(registration, body=None, x__xgafv=None)

+

Initiates the `Push Transfer` process to transfer the domain to another registrar. The process might complete instantly or might require confirmation or additional work. Check the emails sent to the email address of the registrant. The process is aborted after a timeout if it's not completed. This method is only supported for domains that have the `REQUIRE_PUSH_TRANSFER` property in the list of `domain_properties`. The domain must also be unlocked before it can be transferred to a different registrar. For more information, see [Transfer a registered domain to another registrar](https://cloud.google.com/domains/docs/transfer-domain-to-another-registrar).

list(parent, filter=None, pageSize=None, pageToken=None, x__xgafv=None)

Lists the `Registration` resources in a project.

@@ -113,12 +116,18 @@

Instance Methods

register(parent, body=None, x__xgafv=None)

Registers a new domain name and creates a corresponding `Registration` resource. Call `RetrieveRegisterParameters` first to check availability of the domain name and determine parameters like price that are needed to build a call to this method. A successful call creates a `Registration` resource in state `REGISTRATION_PENDING`, which resolves to `ACTIVE` within 1-2 minutes, indicating that the domain was successfully registered. If the resource ends up in state `REGISTRATION_FAILED`, it indicates that the domain was not registered successfully, and you can safely delete the resource and retry registration.

+

+ renewDomain(registration, body=None, x__xgafv=None)

+

Renews a recently expired domain. This method can only be called on domains that expired in the previous 30 days. After the renewal, the new expiration time of the domain is one year after the old expiration time and you are charged a `yearly_price` for the renewal.

resetAuthorizationCode(registration, body=None, x__xgafv=None)

-

Resets the authorization code of the `Registration` to a new random string. You can call this method only after 60 days have elapsed since the initial domain registration.

+

Resets the authorization code of the `Registration` to a new random string. You can call this method only after 60 days have elapsed since the initial domain registration. Domains that have the `REQUIRE_PUSH_TRANSFER` property in the list of `domain_properties` don't support authorization codes and must use the `InitiatePushTransfer` method to initiate the process to transfer the domain to a different registrar.

retrieveAuthorizationCode(registration, x__xgafv=None)

-

Gets the authorization code of the `Registration` for the purpose of transferring the domain to another registrar. You can call this method only after 60 days have elapsed since the initial domain registration.

+

Gets the authorization code of the `Registration` for the purpose of transferring the domain to another registrar. You can call this method only after 60 days have elapsed since the initial domain registration. Domains that have the `REQUIRE_PUSH_TRANSFER` property in the list of `domain_properties` don't support authorization codes and must use the `InitiatePushTransfer` method to initiate the process to transfer the domain to a different registrar.

+

+ retrieveGoogleDomainsForwardingConfig(registration, x__xgafv=None)

+

Lists the deprecated domain and email forwarding configurations you set up in the deprecated Google Domains UI. The configuration is present only for domains with the `google_domains_redirects_data_available` set to `true` in the `Registration`'s `dns_settings`. A forwarding configuration might not work correctly if required DNS records are not present in the domain's authoritative DNS Zone.

retrieveImportableDomains(location, pageSize=None, pageToken=None, x__xgafv=None)

Deprecated: For more information, see [Cloud Domains feature deprecation](https://cloud.google.com/domains/docs/deprecations/feature-deprecations) Lists domain names from [Google Domains](https://domains.google/) that can be imported to Cloud Domains using the `ImportDomain` method. Since individual users can own domains in Google Domains, the list of domains returned depends on the individual user making the call. Domains already managed by Cloud Domains are not returned.

@@ -358,9 +367,10 @@

Method Details

{ # Request for the `ConfigureManagementSettings` method. "managementSettings": { # Defines renewal, billing, and transfer settings for a `Registration`. # Fields of the `ManagementSettings` to update. + "effectiveTransferLockState": "A String", # Output only. The actual transfer lock state for this `Registration`. "preferredRenewalMethod": "A String", # Optional. The desired renewal method for this `Registration`. The actual `renewal_method` is automatically updated to reflect this choice. If unset or equal to `RENEWAL_METHOD_UNSPECIFIED`, the actual `renewalMethod` is treated as if it were set to `AUTOMATIC_RENEWAL`. You cannot use `RENEWAL_DISABLED` during resource creation, and you can update the renewal status only when the `Registration` resource has state `ACTIVE` or `SUSPENDED`. When `preferred_renewal_method` is set to `AUTOMATIC_RENEWAL`, the actual `renewal_method` can be set to `RENEWAL_DISABLED` in case of problems with the billing account or reported domain abuse. In such cases, check the `issues` field on the `Registration`. After the problem is resolved, the `renewal_method` is automatically updated to `preferred_renewal_method` in a few hours. "renewalMethod": "A String", # Output only. The actual renewal method for this `Registration`. When `preferred_renewal_method` is set to `AUTOMATIC_RENEWAL`, the actual `renewal_method` can be equal to `RENEWAL_DISABLED`—for example, when there are problems with the billing account or reported domain abuse. In such cases, check the `issues` field on the `Registration`. After the problem is resolved, the `renewal_method` is automatically updated to `preferred_renewal_method` in a few hours. - "transferLockState": "A String", # This is the desired transfer lock state for this `Registration`. A transfer lock controls whether the domain can be transferred to another registrar. + "transferLockState": "A String", # This is the desired transfer lock state for this `Registration`. A transfer lock controls whether the domain can be transferred to another registrar. The transfer lock state of the domain is returned in the `effective_transfer_lock_state` property. The transfer lock state values might be different for the following reasons: * `transfer_lock_state` was updated only a short time ago. * Domains with the `TRANSFER_LOCK_UNSUPPORTED_BY_REGISTRY` state are in the list of `domain_properties`. These domains are always in the `UNLOCKED` state. }, "updateMask": "A String", # Required. The field mask describing which fields to update as a comma-separated list. For example, if only the transfer lock is being updated, the `update_mask` is `"transfer_lock_state"`. } @@ -596,6 +606,9 @@

Method Details

}, }, "domainName": "A String", # Required. Immutable. The domain name. Unicode domain names must be expressed in Punycode format. + "domainProperties": [ # Output only. Special properties of the domain. + "A String", + ], "expireTime": "A String", # Output only. The expiration timestamp of the `Registration`. "issues": [ # Output only. The set of issues with the `Registration` that require attention. "A String", @@ -604,9 +617,10 @@

Method Details

"a_key": "A String", }, "managementSettings": { # Defines renewal, billing, and transfer settings for a `Registration`. # Settings for management of the `Registration`, including renewal, billing, and transfer. You cannot update these with the `UpdateRegistration` method. To update these settings, use the `ConfigureManagementSettings` method. + "effectiveTransferLockState": "A String", # Output only. The actual transfer lock state for this `Registration`. "preferredRenewalMethod": "A String", # Optional. The desired renewal method for this `Registration`. The actual `renewal_method` is automatically updated to reflect this choice. If unset or equal to `RENEWAL_METHOD_UNSPECIFIED`, the actual `renewalMethod` is treated as if it were set to `AUTOMATIC_RENEWAL`. You cannot use `RENEWAL_DISABLED` during resource creation, and you can update the renewal status only when the `Registration` resource has state `ACTIVE` or `SUSPENDED`. When `preferred_renewal_method` is set to `AUTOMATIC_RENEWAL`, the actual `renewal_method` can be set to `RENEWAL_DISABLED` in case of problems with the billing account or reported domain abuse. In such cases, check the `issues` field on the `Registration`. After the problem is resolved, the `renewal_method` is automatically updated to `preferred_renewal_method` in a few hours. "renewalMethod": "A String", # Output only. The actual renewal method for this `Registration`. When `preferred_renewal_method` is set to `AUTOMATIC_RENEWAL`, the actual `renewal_method` can be equal to `RENEWAL_DISABLED`—for example, when there are problems with the billing account or reported domain abuse. In such cases, check the `issues` field on the `Registration`. After the problem is resolved, the `renewal_method` is automatically updated to `preferred_renewal_method` in a few hours. - "transferLockState": "A String", # This is the desired transfer lock state for this `Registration`. A transfer lock controls whether the domain can be transferred to another registrar. + "transferLockState": "A String", # This is the desired transfer lock state for this `Registration`. A transfer lock controls whether the domain can be transferred to another registrar. The transfer lock state of the domain is returned in the `effective_transfer_lock_state` property. The transfer lock state values might be different for the following reasons: * `transfer_lock_state` was updated only a short time ago. * Domains with the `TRANSFER_LOCK_UNSUPPORTED_BY_REGISTRY` state are in the list of `domain_properties`. These domains are always in the `UNLOCKED` state. }, "name": "A String", # Output only. Name of the `Registration` resource, in the format `projects/*/locations/*/registrations/`. "pendingContactSettings": { # Defines the contact information associated with a `Registration`. [ICANN](https://icann.org/) requires all domain names to have associated contact information. The `registrant_contact` is considered the domain's legal owner, and often the other contacts are identical. # Output only. Pending contact settings for the `Registration`. Updates to the `contact_settings` field that change its `registrant_contact` or `privacy` fields require email confirmation by the `registrant_contact` before taking effect. This field is set only if there are pending updates to the `contact_settings` that have not been confirmed. To confirm the changes, the `registrant_contact` must follow the instructions in the email they receive. @@ -781,6 +795,48 @@

Method Details

}
+
+ initiatePushTransfer(registration, body=None, x__xgafv=None) +
Initiates the `Push Transfer` process to transfer the domain to another registrar. The process might complete instantly or might require confirmation or additional work. Check the emails sent to the email address of the registrant. The process is aborted after a timeout if it's not completed. This method is only supported for domains that have the `REQUIRE_PUSH_TRANSFER` property in the list of `domain_properties`. The domain must also be unlocked before it can be transferred to a different registrar. For more information, see [Transfer a registered domain to another registrar](https://cloud.google.com/domains/docs/transfer-domain-to-another-registrar).
+
+Args:
+  registration: string, Required. The name of the `Registration` for which the push transfer is initiated, in the format `projects/*/locations/*/registrations/*`. (required)
+  body: object, The request body.
+    The object takes the form of:
+
+{ # Request for the `InitiatePushTransfer` method.
+  "tag": "A String", # Required. The Tag of the new registrar. Can be found at [List of registrars](https://nominet.uk/registrar-list/).
+}
+
+  x__xgafv: string, V1 error format.
+    Allowed values
+      1 - v1 error format
+      2 - v2 error format
+
+Returns:
+  An object of the form:
+
+    { # This resource represents a long-running operation that is the result of a network API call.
+  "done": True or False, # If the value is `false`, it means the operation is still in progress. If `true`, the operation is completed, and either `error` or `response` is available.
+  "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). # The error result of the operation in case of failure or cancellation.
+    "code": 42, # The status code, which should be an enum value of google.rpc.Code.
+    "details": [ # A list of messages that carry the error details. There is a common set of message types for APIs to use.
+      {
+        "a_key": "", # Properties of the object. Contains field @type with type URL.
+      },
+    ],
+    "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.
+  },
+  "metadata": { # Service-specific metadata associated with the operation. It typically contains progress information and common metadata such as create time. Some services might not provide such metadata. Any method that returns a long-running operation should document the metadata type, if any.
+    "a_key": "", # Properties of the object. Contains field @type with type URL.
+  },
+  "name": "A String", # The server-assigned name, which is only unique within the same service that originally returns it. If you use the default HTTP mapping, the `name` should be a resource name ending with `operations/{unique_id}`.
+  "response": { # The normal, successful response of the operation. If the original method returns no data on success, such as `Delete`, the response is `google.protobuf.Empty`. If the original method is standard `Get`/`Create`/`Update`, the response should be the resource. For other methods, the response should have the type `XxxResponse`, where `Xxx` is the original method name. For example, if the original method name is `TakeSnapshot()`, the inferred response type is `TakeSnapshotResponse`.
+    "a_key": "", # Properties of the object. Contains field @type with type URL.
+  },
+}
+
+
list(parent, filter=None, pageSize=None, pageToken=None, x__xgafv=None)
Lists the `Registration` resources in a project.
@@ -913,6 +969,9 @@ 

Method Details

}, }, "domainName": "A String", # Required. Immutable. The domain name. Unicode domain names must be expressed in Punycode format. + "domainProperties": [ # Output only. Special properties of the domain. + "A String", + ], "expireTime": "A String", # Output only. The expiration timestamp of the `Registration`. "issues": [ # Output only. The set of issues with the `Registration` that require attention. "A String", @@ -921,9 +980,10 @@

Method Details

"a_key": "A String", }, "managementSettings": { # Defines renewal, billing, and transfer settings for a `Registration`. # Settings for management of the `Registration`, including renewal, billing, and transfer. You cannot update these with the `UpdateRegistration` method. To update these settings, use the `ConfigureManagementSettings` method. + "effectiveTransferLockState": "A String", # Output only. The actual transfer lock state for this `Registration`. "preferredRenewalMethod": "A String", # Optional. The desired renewal method for this `Registration`. The actual `renewal_method` is automatically updated to reflect this choice. If unset or equal to `RENEWAL_METHOD_UNSPECIFIED`, the actual `renewalMethod` is treated as if it were set to `AUTOMATIC_RENEWAL`. You cannot use `RENEWAL_DISABLED` during resource creation, and you can update the renewal status only when the `Registration` resource has state `ACTIVE` or `SUSPENDED`. When `preferred_renewal_method` is set to `AUTOMATIC_RENEWAL`, the actual `renewal_method` can be set to `RENEWAL_DISABLED` in case of problems with the billing account or reported domain abuse. In such cases, check the `issues` field on the `Registration`. After the problem is resolved, the `renewal_method` is automatically updated to `preferred_renewal_method` in a few hours. "renewalMethod": "A String", # Output only. The actual renewal method for this `Registration`. When `preferred_renewal_method` is set to `AUTOMATIC_RENEWAL`, the actual `renewal_method` can be equal to `RENEWAL_DISABLED`—for example, when there are problems with the billing account or reported domain abuse. In such cases, check the `issues` field on the `Registration`. After the problem is resolved, the `renewal_method` is automatically updated to `preferred_renewal_method` in a few hours. - "transferLockState": "A String", # This is the desired transfer lock state for this `Registration`. A transfer lock controls whether the domain can be transferred to another registrar. + "transferLockState": "A String", # This is the desired transfer lock state for this `Registration`. A transfer lock controls whether the domain can be transferred to another registrar. The transfer lock state of the domain is returned in the `effective_transfer_lock_state` property. The transfer lock state values might be different for the following reasons: * `transfer_lock_state` was updated only a short time ago. * Domains with the `TRANSFER_LOCK_UNSUPPORTED_BY_REGISTRY` state are in the list of `domain_properties`. These domains are always in the `UNLOCKED` state. }, "name": "A String", # Output only. Name of the `Registration` resource, in the format `projects/*/locations/*/registrations/`. "pendingContactSettings": { # Defines the contact information associated with a `Registration`. [ICANN](https://icann.org/) requires all domain names to have associated contact information. The `registrant_contact` is considered the domain's legal owner, and often the other contacts are identical. # Output only. Pending contact settings for the `Registration`. Updates to the `contact_settings` field that change its `registrant_contact` or `privacy` fields require email confirmation by the `registrant_contact` before taking effect. This field is set only if there are pending updates to the `contact_settings` that have not been confirmed. To confirm the changes, the `registrant_contact` must follow the instructions in the email they receive. @@ -1142,6 +1202,9 @@

Method Details

}, }, "domainName": "A String", # Required. Immutable. The domain name. Unicode domain names must be expressed in Punycode format. + "domainProperties": [ # Output only. Special properties of the domain. + "A String", + ], "expireTime": "A String", # Output only. The expiration timestamp of the `Registration`. "issues": [ # Output only. The set of issues with the `Registration` that require attention. "A String", @@ -1150,9 +1213,10 @@

Method Details

"a_key": "A String", }, "managementSettings": { # Defines renewal, billing, and transfer settings for a `Registration`. # Settings for management of the `Registration`, including renewal, billing, and transfer. You cannot update these with the `UpdateRegistration` method. To update these settings, use the `ConfigureManagementSettings` method. + "effectiveTransferLockState": "A String", # Output only. The actual transfer lock state for this `Registration`. "preferredRenewalMethod": "A String", # Optional. The desired renewal method for this `Registration`. The actual `renewal_method` is automatically updated to reflect this choice. If unset or equal to `RENEWAL_METHOD_UNSPECIFIED`, the actual `renewalMethod` is treated as if it were set to `AUTOMATIC_RENEWAL`. You cannot use `RENEWAL_DISABLED` during resource creation, and you can update the renewal status only when the `Registration` resource has state `ACTIVE` or `SUSPENDED`. When `preferred_renewal_method` is set to `AUTOMATIC_RENEWAL`, the actual `renewal_method` can be set to `RENEWAL_DISABLED` in case of problems with the billing account or reported domain abuse. In such cases, check the `issues` field on the `Registration`. After the problem is resolved, the `renewal_method` is automatically updated to `preferred_renewal_method` in a few hours. "renewalMethod": "A String", # Output only. The actual renewal method for this `Registration`. When `preferred_renewal_method` is set to `AUTOMATIC_RENEWAL`, the actual `renewal_method` can be equal to `RENEWAL_DISABLED`—for example, when there are problems with the billing account or reported domain abuse. In such cases, check the `issues` field on the `Registration`. After the problem is resolved, the `renewal_method` is automatically updated to `preferred_renewal_method` in a few hours. - "transferLockState": "A String", # This is the desired transfer lock state for this `Registration`. A transfer lock controls whether the domain can be transferred to another registrar. + "transferLockState": "A String", # This is the desired transfer lock state for this `Registration`. A transfer lock controls whether the domain can be transferred to another registrar. The transfer lock state of the domain is returned in the `effective_transfer_lock_state` property. The transfer lock state values might be different for the following reasons: * `transfer_lock_state` was updated only a short time ago. * Domains with the `TRANSFER_LOCK_UNSUPPORTED_BY_REGISTRY` state are in the list of `domain_properties`. These domains are always in the `UNLOCKED` state. }, "name": "A String", # Output only. Name of the `Registration` resource, in the format `projects/*/locations/*/registrations/`. "pendingContactSettings": { # Defines the contact information associated with a `Registration`. [ICANN](https://icann.org/) requires all domain names to have associated contact information. The `registrant_contact` is considered the domain's legal owner, and often the other contacts are identical. # Output only. Pending contact settings for the `Registration`. Updates to the `contact_settings` field that change its `registrant_contact` or `privacy` fields require email confirmation by the `registrant_contact` before taking effect. This field is set only if there are pending updates to the `contact_settings` that have not been confirmed. To confirm the changes, the `registrant_contact` must follow the instructions in the email they receive. @@ -1391,6 +1455,9 @@

Method Details

}, }, "domainName": "A String", # Required. Immutable. The domain name. Unicode domain names must be expressed in Punycode format. + "domainProperties": [ # Output only. Special properties of the domain. + "A String", + ], "expireTime": "A String", # Output only. The expiration timestamp of the `Registration`. "issues": [ # Output only. The set of issues with the `Registration` that require attention. "A String", @@ -1399,9 +1466,10 @@

Method Details

"a_key": "A String", }, "managementSettings": { # Defines renewal, billing, and transfer settings for a `Registration`. # Settings for management of the `Registration`, including renewal, billing, and transfer. You cannot update these with the `UpdateRegistration` method. To update these settings, use the `ConfigureManagementSettings` method. + "effectiveTransferLockState": "A String", # Output only. The actual transfer lock state for this `Registration`. "preferredRenewalMethod": "A String", # Optional. The desired renewal method for this `Registration`. The actual `renewal_method` is automatically updated to reflect this choice. If unset or equal to `RENEWAL_METHOD_UNSPECIFIED`, the actual `renewalMethod` is treated as if it were set to `AUTOMATIC_RENEWAL`. You cannot use `RENEWAL_DISABLED` during resource creation, and you can update the renewal status only when the `Registration` resource has state `ACTIVE` or `SUSPENDED`. When `preferred_renewal_method` is set to `AUTOMATIC_RENEWAL`, the actual `renewal_method` can be set to `RENEWAL_DISABLED` in case of problems with the billing account or reported domain abuse. In such cases, check the `issues` field on the `Registration`. After the problem is resolved, the `renewal_method` is automatically updated to `preferred_renewal_method` in a few hours. "renewalMethod": "A String", # Output only. The actual renewal method for this `Registration`. When `preferred_renewal_method` is set to `AUTOMATIC_RENEWAL`, the actual `renewal_method` can be equal to `RENEWAL_DISABLED`—for example, when there are problems with the billing account or reported domain abuse. In such cases, check the `issues` field on the `Registration`. After the problem is resolved, the `renewal_method` is automatically updated to `preferred_renewal_method` in a few hours. - "transferLockState": "A String", # This is the desired transfer lock state for this `Registration`. A transfer lock controls whether the domain can be transferred to another registrar. + "transferLockState": "A String", # This is the desired transfer lock state for this `Registration`. A transfer lock controls whether the domain can be transferred to another registrar. The transfer lock state of the domain is returned in the `effective_transfer_lock_state` property. The transfer lock state values might be different for the following reasons: * `transfer_lock_state` was updated only a short time ago. * Domains with the `TRANSFER_LOCK_UNSUPPORTED_BY_REGISTRY` state are in the list of `domain_properties`. These domains are always in the `UNLOCKED` state. }, "name": "A String", # Output only. Name of the `Registration` resource, in the format `projects/*/locations/*/registrations/`. "pendingContactSettings": { # Defines the contact information associated with a `Registration`. [ICANN](https://icann.org/) requires all domain names to have associated contact information. The `registrant_contact` is considered the domain's legal owner, and often the other contacts are identical. # Output only. Pending contact settings for the `Registration`. Updates to the `contact_settings` field that change its `registrant_contact` or `privacy` fields require email confirmation by the `registrant_contact` before taking effect. This field is set only if there are pending updates to the `contact_settings` that have not been confirmed. To confirm the changes, the `registrant_contact` must follow the instructions in the email they receive. @@ -1518,9 +1586,56 @@

Method Details

}
+
+ renewDomain(registration, body=None, x__xgafv=None) +
Renews a recently expired domain. This method can only be called on domains that expired in the previous 30 days. After the renewal, the new expiration time of the domain is one year after the old expiration time and you are charged a `yearly_price` for the renewal.
+
+Args:
+  registration: string, Required. The name of the `Registration` whish is being renewed, in the format `projects/*/locations/*/registrations/*`. (required)
+  body: object, The request body.
+    The object takes the form of:
+
+{ # Request for the `RenewDomain` method.
+  "validateOnly": True or False, # Optional. When true, only validation is performed, without actually renewing the domain. For more information, see [Request validation](https://cloud.google.com/apis/design/design_patterns#request_validation)
+  "yearlyPrice": { # Represents an amount of money with its currency type. # Required. Acknowledgement of the price to renew the domain for one year. To get the price, see [Cloud Domains pricing](https://cloud.google.com/domains/pricing). If not provided, the expected price is returned in the error message.
+    "currencyCode": "A String", # The three-letter currency code defined in ISO 4217.
+    "nanos": 42, # Number of nano (10^-9) units of the amount. The value must be between -999,999,999 and +999,999,999 inclusive. If `units` is positive, `nanos` must be positive or zero. If `units` is zero, `nanos` can be positive, zero, or negative. If `units` is negative, `nanos` must be negative or zero. For example $-1.75 is represented as `units`=-1 and `nanos`=-750,000,000.
+    "units": "A String", # The whole units of the amount. For example if `currencyCode` is `"USD"`, then 1 unit is one US dollar.
+  },
+}
+
+  x__xgafv: string, V1 error format.
+    Allowed values
+      1 - v1 error format
+      2 - v2 error format
+
+Returns:
+  An object of the form:
+
+    { # This resource represents a long-running operation that is the result of a network API call.
+  "done": True or False, # If the value is `false`, it means the operation is still in progress. If `true`, the operation is completed, and either `error` or `response` is available.
+  "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). # The error result of the operation in case of failure or cancellation.
+    "code": 42, # The status code, which should be an enum value of google.rpc.Code.
+    "details": [ # A list of messages that carry the error details. There is a common set of message types for APIs to use.
+      {
+        "a_key": "", # Properties of the object. Contains field @type with type URL.
+      },
+    ],
+    "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.
+  },
+  "metadata": { # Service-specific metadata associated with the operation. It typically contains progress information and common metadata such as create time. Some services might not provide such metadata. Any method that returns a long-running operation should document the metadata type, if any.
+    "a_key": "", # Properties of the object. Contains field @type with type URL.
+  },
+  "name": "A String", # The server-assigned name, which is only unique within the same service that originally returns it. If you use the default HTTP mapping, the `name` should be a resource name ending with `operations/{unique_id}`.
+  "response": { # The normal, successful response of the operation. If the original method returns no data on success, such as `Delete`, the response is `google.protobuf.Empty`. If the original method is standard `Get`/`Create`/`Update`, the response should be the resource. For other methods, the response should have the type `XxxResponse`, where `Xxx` is the original method name. For example, if the original method name is `TakeSnapshot()`, the inferred response type is `TakeSnapshotResponse`.
+    "a_key": "", # Properties of the object. Contains field @type with type URL.
+  },
+}
+
+
resetAuthorizationCode(registration, body=None, x__xgafv=None) -
Resets the authorization code of the `Registration` to a new random string. You can call this method only after 60 days have elapsed since the initial domain registration.
+  
Resets the authorization code of the `Registration` to a new random string. You can call this method only after 60 days have elapsed since the initial domain registration. Domains that have the `REQUIRE_PUSH_TRANSFER` property in the list of `domain_properties` don't support authorization codes and must use the `InitiatePushTransfer` method to initiate the process to transfer the domain to a different registrar.
 
 Args:
   registration: string, Required. The name of the `Registration` whose authorization code is being reset, in the format `projects/*/locations/*/registrations/*`. (required)
@@ -1545,7 +1660,7 @@ 

Method Details

retrieveAuthorizationCode(registration, x__xgafv=None) -
Gets the authorization code of the `Registration` for the purpose of transferring the domain to another registrar. You can call this method only after 60 days have elapsed since the initial domain registration.
+  
Gets the authorization code of the `Registration` for the purpose of transferring the domain to another registrar. You can call this method only after 60 days have elapsed since the initial domain registration. Domains that have the `REQUIRE_PUSH_TRANSFER` property in the list of `domain_properties` don't support authorization codes and must use the `InitiatePushTransfer` method to initiate the process to transfer the domain to a different registrar.
 
 Args:
   registration: string, Required. The name of the `Registration` whose authorization code is being retrieved, in the format `projects/*/locations/*/registrations/*`. (required)
@@ -1562,6 +1677,40 @@ 

Method Details

}
+
+ retrieveGoogleDomainsForwardingConfig(registration, x__xgafv=None) +
Lists the deprecated domain and email forwarding configurations you set up in the deprecated Google Domains UI. The configuration is present only for domains with the `google_domains_redirects_data_available` set to `true` in the `Registration`'s `dns_settings`. A forwarding configuration might not work correctly if required DNS records are not present in the domain's authoritative DNS Zone.
+
+Args:
+  registration: string, Required. The name of the `Registration` whose Google Domains forwarding configuration details are being retrieved, in the format `projects/*/locations/*/registrations/*`. (required)
+  x__xgafv: string, V1 error format.
+    Allowed values
+      1 - v1 error format
+      2 - v2 error format
+
+Returns:
+  An object of the form:
+
+    { # Response for the `RetrieveGoogleDomainsForwardingConfig` method.
+  "domainForwardings": [ # The list of domain forwarding configurations. A forwarding configuration might not work correctly if the required DNS records are not present in the domain's authoritative DNS zone.
+    { # Domain forwarding configuration.
+      "pathForwarding": True or False, # If true, forwards the path after the domain name to the same path at the new address.
+      "pemCertificate": "A String", # The PEM-encoded certificate chain.
+      "redirectType": "A String", # The redirect type.
+      "sslEnabled": True or False, # If true, the forwarding works also over HTTPS.
+      "subdomain": "A String", # The subdomain of the registered domain that is being forwarded. E.g. `www.example.com`, `example.com` (i.e. the registered domain itself) or `*.example.com` (i.e. all subdomains).
+      "targetUri": "A String", # The target of the domain forwarding, i.e. the path to redirect the `subdomain` to.
+    },
+  ],
+  "emailForwardings": [ # The list of email forwarding configurations. A forwarding configuration might not work correctly if the required DNS records are not present in the domain's authoritative DNS zone.
+    { # Email forwarding configuration.
+      "alias": "A String", # An alias recipient email that forwards emails to the `target_email_address`. For example, `admin@example.com` or `*@example.com` (wildcard alias forwards all the emails under the registered domain).
+      "targetEmailAddress": "A String", # Target email that receives emails sent to the `alias`.
+    },
+  ],
+}
+
+
retrieveImportableDomains(location, pageSize=None, pageToken=None, x__xgafv=None)
Deprecated: For more information, see [Cloud Domains feature deprecation](https://cloud.google.com/domains/docs/deprecations/feature-deprecations) Lists domain names from [Google Domains](https://domains.google/) that can be imported to Cloud Domains using the `ImportDomain` method. Since individual users can own domains in Google Domains, the list of domains returned depends on the individual user making the call. Domains already managed by Cloud Domains are not returned.
@@ -1957,6 +2106,9 @@ 

Method Details

}, }, "domainName": "A String", # Required. Immutable. The domain name. Unicode domain names must be expressed in Punycode format. + "domainProperties": [ # Output only. Special properties of the domain. + "A String", + ], "expireTime": "A String", # Output only. The expiration timestamp of the `Registration`. "issues": [ # Output only. The set of issues with the `Registration` that require attention. "A String", @@ -1965,9 +2117,10 @@

Method Details

"a_key": "A String", }, "managementSettings": { # Defines renewal, billing, and transfer settings for a `Registration`. # Settings for management of the `Registration`, including renewal, billing, and transfer. You cannot update these with the `UpdateRegistration` method. To update these settings, use the `ConfigureManagementSettings` method. + "effectiveTransferLockState": "A String", # Output only. The actual transfer lock state for this `Registration`. "preferredRenewalMethod": "A String", # Optional. The desired renewal method for this `Registration`. The actual `renewal_method` is automatically updated to reflect this choice. If unset or equal to `RENEWAL_METHOD_UNSPECIFIED`, the actual `renewalMethod` is treated as if it were set to `AUTOMATIC_RENEWAL`. You cannot use `RENEWAL_DISABLED` during resource creation, and you can update the renewal status only when the `Registration` resource has state `ACTIVE` or `SUSPENDED`. When `preferred_renewal_method` is set to `AUTOMATIC_RENEWAL`, the actual `renewal_method` can be set to `RENEWAL_DISABLED` in case of problems with the billing account or reported domain abuse. In such cases, check the `issues` field on the `Registration`. After the problem is resolved, the `renewal_method` is automatically updated to `preferred_renewal_method` in a few hours. "renewalMethod": "A String", # Output only. The actual renewal method for this `Registration`. When `preferred_renewal_method` is set to `AUTOMATIC_RENEWAL`, the actual `renewal_method` can be equal to `RENEWAL_DISABLED`—for example, when there are problems with the billing account or reported domain abuse. In such cases, check the `issues` field on the `Registration`. After the problem is resolved, the `renewal_method` is automatically updated to `preferred_renewal_method` in a few hours. - "transferLockState": "A String", # This is the desired transfer lock state for this `Registration`. A transfer lock controls whether the domain can be transferred to another registrar. + "transferLockState": "A String", # This is the desired transfer lock state for this `Registration`. A transfer lock controls whether the domain can be transferred to another registrar. The transfer lock state of the domain is returned in the `effective_transfer_lock_state` property. The transfer lock state values might be different for the following reasons: * `transfer_lock_state` was updated only a short time ago. * Domains with the `TRANSFER_LOCK_UNSUPPORTED_BY_REGISTRY` state are in the list of `domain_properties`. These domains are always in the `UNLOCKED` state. }, "name": "A String", # Output only. Name of the `Registration` resource, in the format `projects/*/locations/*/registrations/`. "pendingContactSettings": { # Defines the contact information associated with a `Registration`. [ICANN](https://icann.org/) requires all domain names to have associated contact information. The `registrant_contact` is considered the domain's legal owner, and often the other contacts are identical. # Output only. Pending contact settings for the `Registration`. Updates to the `contact_settings` field that change its `registrant_contact` or `privacy` fields require email confirmation by the `registrant_contact` before taking effect. This field is set only if there are pending updates to the `contact_settings` that have not been confirmed. To confirm the changes, the `registrant_contact` must follow the instructions in the email they receive. diff --git a/docs/dyn/domains_v1beta1.projects.locations.registrations.html b/docs/dyn/domains_v1beta1.projects.locations.registrations.html index 65acb92a1d4..b9f8d967c2d 100644 --- a/docs/dyn/domains_v1beta1.projects.locations.registrations.html +++ b/docs/dyn/domains_v1beta1.projects.locations.registrations.html @@ -101,6 +101,9 @@

Instance Methods

import_(parent, body=None, x__xgafv=None)

Deprecated: For more information, see [Cloud Domains feature deprecation](https://cloud.google.com/domains/docs/deprecations/feature-deprecations) Imports a domain name from [Google Domains](https://domains.google/) for use in Cloud Domains. To transfer a domain from another registrar, use the `TransferDomain` method instead. Since individual users can own domains in Google Domains, the calling user must have ownership permission on the domain.

+

+ initiatePushTransfer(registration, body=None, x__xgafv=None)

+

Initiates the `Push Transfer` process to transfer the domain to another registrar. The process might complete instantly or might require confirmation or additional work. Check the emails sent to the email address of the registrant. The process is aborted after a timeout if it's not completed. This method is only supported for domains that have the `REQUIRE_PUSH_TRANSFER` property in the list of `domain_properties`. The domain must also be unlocked before it can be transferred to a different registrar. For more information, see [Transfer a registered domain to another registrar](https://cloud.google.com/domains/docs/transfer-domain-to-another-registrar).

list(parent, filter=None, pageSize=None, pageToken=None, x__xgafv=None)

Lists the `Registration` resources in a project.

@@ -113,12 +116,18 @@

Instance Methods

register(parent, body=None, x__xgafv=None)

Registers a new domain name and creates a corresponding `Registration` resource. Call `RetrieveRegisterParameters` first to check availability of the domain name and determine parameters like price that are needed to build a call to this method. A successful call creates a `Registration` resource in state `REGISTRATION_PENDING`, which resolves to `ACTIVE` within 1-2 minutes, indicating that the domain was successfully registered. If the resource ends up in state `REGISTRATION_FAILED`, it indicates that the domain was not registered successfully, and you can safely delete the resource and retry registration.

+

+ renewDomain(registration, body=None, x__xgafv=None)

+

Renews a recently expired domain. This method can only be called on domains that expired in the previous 30 days. After the renewal, the new expiration time of the domain is one year after the old expiration time and you are charged a `yearly_price` for the renewal.

resetAuthorizationCode(registration, body=None, x__xgafv=None)

-

Resets the authorization code of the `Registration` to a new random string. You can call this method only after 60 days have elapsed since the initial domain registration.

+

Resets the authorization code of the `Registration` to a new random string. You can call this method only after 60 days have elapsed since the initial domain registration. Domains that have the `REQUIRE_PUSH_TRANSFER` property in the list of `domain_properties` don't support authorization codes and must use the `InitiatePushTransfer` method to initiate the process to transfer the domain to a different registrar.

retrieveAuthorizationCode(registration, x__xgafv=None)

-

Gets the authorization code of the `Registration` for the purpose of transferring the domain to another registrar. You can call this method only after 60 days have elapsed since the initial domain registration.

+

Gets the authorization code of the `Registration` for the purpose of transferring the domain to another registrar. You can call this method only after 60 days have elapsed since the initial domain registration. Domains that have the `REQUIRE_PUSH_TRANSFER` property in the list of `domain_properties` don't support authorization codes and must use the `InitiatePushTransfer` method to initiate the process to transfer the domain to a different registrar.

+

+ retrieveGoogleDomainsForwardingConfig(registration, x__xgafv=None)

+

Lists the deprecated domain and email forwarding configurations you set up in the deprecated Google Domains UI. The configuration is present only for domains with the `google_domains_redirects_data_available` set to `true` in the `Registration`'s `dns_settings`. A forwarding configuration might not work correctly if required DNS records are not present in the domain's authoritative DNS Zone.

retrieveImportableDomains(location, pageSize=None, pageToken=None, x__xgafv=None)

Deprecated: For more information, see [Cloud Domains feature deprecation](https://cloud.google.com/domains/docs/deprecations/feature-deprecations) Lists domain names from [Google Domains](https://domains.google/) that can be imported to Cloud Domains using the `ImportDomain` method. Since individual users can own domains in Google Domains, the list of domains returned depends on the individual user making the call. Domains already managed by Cloud Domains are not returned.

@@ -358,9 +367,10 @@

Method Details

{ # Request for the `ConfigureManagementSettings` method. "managementSettings": { # Defines renewal, billing, and transfer settings for a `Registration`. # Fields of the `ManagementSettings` to update. + "effectiveTransferLockState": "A String", # Output only. The actual transfer lock state for this `Registration`. "preferredRenewalMethod": "A String", # Optional. The desired renewal method for this `Registration`. The actual `renewal_method` is automatically updated to reflect this choice. If unset or equal to `RENEWAL_METHOD_UNSPECIFIED`, the actual `renewalMethod` is treated as if it were set to `AUTOMATIC_RENEWAL`. You cannot use `RENEWAL_DISABLED` during resource creation, and you can update the renewal status only when the `Registration` resource has state `ACTIVE` or `SUSPENDED`. When `preferred_renewal_method` is set to `AUTOMATIC_RENEWAL`, the actual `renewal_method` can be set to `RENEWAL_DISABLED` in case of problems with the billing account or reported domain abuse. In such cases, check the `issues` field on the `Registration`. After the problem is resolved, the `renewal_method` is automatically updated to `preferred_renewal_method` in a few hours. "renewalMethod": "A String", # Output only. The actual renewal method for this `Registration`. When `preferred_renewal_method` is set to `AUTOMATIC_RENEWAL`, the actual `renewal_method` can be equal to `RENEWAL_DISABLED`—for example, when there are problems with the billing account or reported domain abuse. In such cases, check the `issues` field on the `Registration`. After the problem is resolved, the `renewal_method` is automatically updated to `preferred_renewal_method` in a few hours. - "transferLockState": "A String", # This is the desired transfer lock state for this `Registration`. A transfer lock controls whether the domain can be transferred to another registrar. + "transferLockState": "A String", # This is the desired transfer lock state for this `Registration`. A transfer lock controls whether the domain can be transferred to another registrar. The transfer lock state of the domain is returned in the `effective_transfer_lock_state` property. The transfer lock state values might be different for the following reasons: * `transfer_lock_state` was updated only a short time ago. * Domains with the `TRANSFER_LOCK_UNSUPPORTED_BY_REGISTRY` state are in the list of `domain_properties`. These domains are always in the `UNLOCKED` state. }, "updateMask": "A String", # Required. The field mask describing which fields to update as a comma-separated list. For example, if only the transfer lock is being updated, the `update_mask` is `"transfer_lock_state"`. } @@ -596,6 +606,9 @@

Method Details

}, }, "domainName": "A String", # Required. Immutable. The domain name. Unicode domain names must be expressed in Punycode format. + "domainProperties": [ # Output only. Special properties of the domain. + "A String", + ], "expireTime": "A String", # Output only. The expiration timestamp of the `Registration`. "issues": [ # Output only. The set of issues with the `Registration` that require attention. "A String", @@ -604,9 +617,10 @@

Method Details

"a_key": "A String", }, "managementSettings": { # Defines renewal, billing, and transfer settings for a `Registration`. # Settings for management of the `Registration`, including renewal, billing, and transfer. You cannot update these with the `UpdateRegistration` method. To update these settings, use the `ConfigureManagementSettings` method. + "effectiveTransferLockState": "A String", # Output only. The actual transfer lock state for this `Registration`. "preferredRenewalMethod": "A String", # Optional. The desired renewal method for this `Registration`. The actual `renewal_method` is automatically updated to reflect this choice. If unset or equal to `RENEWAL_METHOD_UNSPECIFIED`, the actual `renewalMethod` is treated as if it were set to `AUTOMATIC_RENEWAL`. You cannot use `RENEWAL_DISABLED` during resource creation, and you can update the renewal status only when the `Registration` resource has state `ACTIVE` or `SUSPENDED`. When `preferred_renewal_method` is set to `AUTOMATIC_RENEWAL`, the actual `renewal_method` can be set to `RENEWAL_DISABLED` in case of problems with the billing account or reported domain abuse. In such cases, check the `issues` field on the `Registration`. After the problem is resolved, the `renewal_method` is automatically updated to `preferred_renewal_method` in a few hours. "renewalMethod": "A String", # Output only. The actual renewal method for this `Registration`. When `preferred_renewal_method` is set to `AUTOMATIC_RENEWAL`, the actual `renewal_method` can be equal to `RENEWAL_DISABLED`—for example, when there are problems with the billing account or reported domain abuse. In such cases, check the `issues` field on the `Registration`. After the problem is resolved, the `renewal_method` is automatically updated to `preferred_renewal_method` in a few hours. - "transferLockState": "A String", # This is the desired transfer lock state for this `Registration`. A transfer lock controls whether the domain can be transferred to another registrar. + "transferLockState": "A String", # This is the desired transfer lock state for this `Registration`. A transfer lock controls whether the domain can be transferred to another registrar. The transfer lock state of the domain is returned in the `effective_transfer_lock_state` property. The transfer lock state values might be different for the following reasons: * `transfer_lock_state` was updated only a short time ago. * Domains with the `TRANSFER_LOCK_UNSUPPORTED_BY_REGISTRY` state are in the list of `domain_properties`. These domains are always in the `UNLOCKED` state. }, "name": "A String", # Output only. Name of the `Registration` resource, in the format `projects/*/locations/*/registrations/`. "pendingContactSettings": { # Defines the contact information associated with a `Registration`. [ICANN](https://icann.org/) requires all domain names to have associated contact information. The `registrant_contact` is considered the domain's legal owner, and often the other contacts are identical. # Output only. Pending contact settings for the `Registration`. Updates to the `contact_settings` field that change its `registrant_contact` or `privacy` fields require email confirmation by the `registrant_contact` before taking effect. This field is set only if there are pending updates to the `contact_settings` that have not been confirmed. To confirm the changes, the `registrant_contact` must follow the instructions in the email they receive. @@ -780,6 +794,48 @@

Method Details

}
+
+ initiatePushTransfer(registration, body=None, x__xgafv=None) +
Initiates the `Push Transfer` process to transfer the domain to another registrar. The process might complete instantly or might require confirmation or additional work. Check the emails sent to the email address of the registrant. The process is aborted after a timeout if it's not completed. This method is only supported for domains that have the `REQUIRE_PUSH_TRANSFER` property in the list of `domain_properties`. The domain must also be unlocked before it can be transferred to a different registrar. For more information, see [Transfer a registered domain to another registrar](https://cloud.google.com/domains/docs/transfer-domain-to-another-registrar).
+
+Args:
+  registration: string, Required. The name of the `Registration` for which the push transfer is initiated, in the format `projects/*/locations/*/registrations/*`. (required)
+  body: object, The request body.
+    The object takes the form of:
+
+{ # Request for the `InitiatePushTransfer` method.
+  "tag": "A String", # Required. The Tag of the new registrar. Can be found at [List of registrars](https://nominet.uk/registrar-list/).
+}
+
+  x__xgafv: string, V1 error format.
+    Allowed values
+      1 - v1 error format
+      2 - v2 error format
+
+Returns:
+  An object of the form:
+
+    { # This resource represents a long-running operation that is the result of a network API call.
+  "done": True or False, # If the value is `false`, it means the operation is still in progress. If `true`, the operation is completed, and either `error` or `response` is available.
+  "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). # The error result of the operation in case of failure or cancellation.
+    "code": 42, # The status code, which should be an enum value of google.rpc.Code.
+    "details": [ # A list of messages that carry the error details. There is a common set of message types for APIs to use.
+      {
+        "a_key": "", # Properties of the object. Contains field @type with type URL.
+      },
+    ],
+    "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.
+  },
+  "metadata": { # Service-specific metadata associated with the operation. It typically contains progress information and common metadata such as create time. Some services might not provide such metadata. Any method that returns a long-running operation should document the metadata type, if any.
+    "a_key": "", # Properties of the object. Contains field @type with type URL.
+  },
+  "name": "A String", # The server-assigned name, which is only unique within the same service that originally returns it. If you use the default HTTP mapping, the `name` should be a resource name ending with `operations/{unique_id}`.
+  "response": { # The normal, successful response of the operation. If the original method returns no data on success, such as `Delete`, the response is `google.protobuf.Empty`. If the original method is standard `Get`/`Create`/`Update`, the response should be the resource. For other methods, the response should have the type `XxxResponse`, where `Xxx` is the original method name. For example, if the original method name is `TakeSnapshot()`, the inferred response type is `TakeSnapshotResponse`.
+    "a_key": "", # Properties of the object. Contains field @type with type URL.
+  },
+}
+
+
list(parent, filter=None, pageSize=None, pageToken=None, x__xgafv=None)
Lists the `Registration` resources in a project.
@@ -912,6 +968,9 @@ 

Method Details

}, }, "domainName": "A String", # Required. Immutable. The domain name. Unicode domain names must be expressed in Punycode format. + "domainProperties": [ # Output only. Special properties of the domain. + "A String", + ], "expireTime": "A String", # Output only. The expiration timestamp of the `Registration`. "issues": [ # Output only. The set of issues with the `Registration` that require attention. "A String", @@ -920,9 +979,10 @@

Method Details

"a_key": "A String", }, "managementSettings": { # Defines renewal, billing, and transfer settings for a `Registration`. # Settings for management of the `Registration`, including renewal, billing, and transfer. You cannot update these with the `UpdateRegistration` method. To update these settings, use the `ConfigureManagementSettings` method. + "effectiveTransferLockState": "A String", # Output only. The actual transfer lock state for this `Registration`. "preferredRenewalMethod": "A String", # Optional. The desired renewal method for this `Registration`. The actual `renewal_method` is automatically updated to reflect this choice. If unset or equal to `RENEWAL_METHOD_UNSPECIFIED`, the actual `renewalMethod` is treated as if it were set to `AUTOMATIC_RENEWAL`. You cannot use `RENEWAL_DISABLED` during resource creation, and you can update the renewal status only when the `Registration` resource has state `ACTIVE` or `SUSPENDED`. When `preferred_renewal_method` is set to `AUTOMATIC_RENEWAL`, the actual `renewal_method` can be set to `RENEWAL_DISABLED` in case of problems with the billing account or reported domain abuse. In such cases, check the `issues` field on the `Registration`. After the problem is resolved, the `renewal_method` is automatically updated to `preferred_renewal_method` in a few hours. "renewalMethod": "A String", # Output only. The actual renewal method for this `Registration`. When `preferred_renewal_method` is set to `AUTOMATIC_RENEWAL`, the actual `renewal_method` can be equal to `RENEWAL_DISABLED`—for example, when there are problems with the billing account or reported domain abuse. In such cases, check the `issues` field on the `Registration`. After the problem is resolved, the `renewal_method` is automatically updated to `preferred_renewal_method` in a few hours. - "transferLockState": "A String", # This is the desired transfer lock state for this `Registration`. A transfer lock controls whether the domain can be transferred to another registrar. + "transferLockState": "A String", # This is the desired transfer lock state for this `Registration`. A transfer lock controls whether the domain can be transferred to another registrar. The transfer lock state of the domain is returned in the `effective_transfer_lock_state` property. The transfer lock state values might be different for the following reasons: * `transfer_lock_state` was updated only a short time ago. * Domains with the `TRANSFER_LOCK_UNSUPPORTED_BY_REGISTRY` state are in the list of `domain_properties`. These domains are always in the `UNLOCKED` state. }, "name": "A String", # Output only. Name of the `Registration` resource, in the format `projects/*/locations/*/registrations/`. "pendingContactSettings": { # Defines the contact information associated with a `Registration`. [ICANN](https://icann.org/) requires all domain names to have associated contact information. The `registrant_contact` is considered the domain's legal owner, and often the other contacts are identical. # Output only. Pending contact settings for the `Registration`. Updates to the `contact_settings` field that change its `registrant_contact` or `privacy` fields require email confirmation by the `registrant_contact` before taking effect. This field is set only if there are pending updates to the `contact_settings` that have not been confirmed. To confirm the changes, the `registrant_contact` must follow the instructions in the email they receive. @@ -1140,6 +1200,9 @@

Method Details

}, }, "domainName": "A String", # Required. Immutable. The domain name. Unicode domain names must be expressed in Punycode format. + "domainProperties": [ # Output only. Special properties of the domain. + "A String", + ], "expireTime": "A String", # Output only. The expiration timestamp of the `Registration`. "issues": [ # Output only. The set of issues with the `Registration` that require attention. "A String", @@ -1148,9 +1211,10 @@

Method Details

"a_key": "A String", }, "managementSettings": { # Defines renewal, billing, and transfer settings for a `Registration`. # Settings for management of the `Registration`, including renewal, billing, and transfer. You cannot update these with the `UpdateRegistration` method. To update these settings, use the `ConfigureManagementSettings` method. + "effectiveTransferLockState": "A String", # Output only. The actual transfer lock state for this `Registration`. "preferredRenewalMethod": "A String", # Optional. The desired renewal method for this `Registration`. The actual `renewal_method` is automatically updated to reflect this choice. If unset or equal to `RENEWAL_METHOD_UNSPECIFIED`, the actual `renewalMethod` is treated as if it were set to `AUTOMATIC_RENEWAL`. You cannot use `RENEWAL_DISABLED` during resource creation, and you can update the renewal status only when the `Registration` resource has state `ACTIVE` or `SUSPENDED`. When `preferred_renewal_method` is set to `AUTOMATIC_RENEWAL`, the actual `renewal_method` can be set to `RENEWAL_DISABLED` in case of problems with the billing account or reported domain abuse. In such cases, check the `issues` field on the `Registration`. After the problem is resolved, the `renewal_method` is automatically updated to `preferred_renewal_method` in a few hours. "renewalMethod": "A String", # Output only. The actual renewal method for this `Registration`. When `preferred_renewal_method` is set to `AUTOMATIC_RENEWAL`, the actual `renewal_method` can be equal to `RENEWAL_DISABLED`—for example, when there are problems with the billing account or reported domain abuse. In such cases, check the `issues` field on the `Registration`. After the problem is resolved, the `renewal_method` is automatically updated to `preferred_renewal_method` in a few hours. - "transferLockState": "A String", # This is the desired transfer lock state for this `Registration`. A transfer lock controls whether the domain can be transferred to another registrar. + "transferLockState": "A String", # This is the desired transfer lock state for this `Registration`. A transfer lock controls whether the domain can be transferred to another registrar. The transfer lock state of the domain is returned in the `effective_transfer_lock_state` property. The transfer lock state values might be different for the following reasons: * `transfer_lock_state` was updated only a short time ago. * Domains with the `TRANSFER_LOCK_UNSUPPORTED_BY_REGISTRY` state are in the list of `domain_properties`. These domains are always in the `UNLOCKED` state. }, "name": "A String", # Output only. Name of the `Registration` resource, in the format `projects/*/locations/*/registrations/`. "pendingContactSettings": { # Defines the contact information associated with a `Registration`. [ICANN](https://icann.org/) requires all domain names to have associated contact information. The `registrant_contact` is considered the domain's legal owner, and often the other contacts are identical. # Output only. Pending contact settings for the `Registration`. Updates to the `contact_settings` field that change its `registrant_contact` or `privacy` fields require email confirmation by the `registrant_contact` before taking effect. This field is set only if there are pending updates to the `contact_settings` that have not been confirmed. To confirm the changes, the `registrant_contact` must follow the instructions in the email they receive. @@ -1388,6 +1452,9 @@

Method Details

}, }, "domainName": "A String", # Required. Immutable. The domain name. Unicode domain names must be expressed in Punycode format. + "domainProperties": [ # Output only. Special properties of the domain. + "A String", + ], "expireTime": "A String", # Output only. The expiration timestamp of the `Registration`. "issues": [ # Output only. The set of issues with the `Registration` that require attention. "A String", @@ -1396,9 +1463,10 @@

Method Details

"a_key": "A String", }, "managementSettings": { # Defines renewal, billing, and transfer settings for a `Registration`. # Settings for management of the `Registration`, including renewal, billing, and transfer. You cannot update these with the `UpdateRegistration` method. To update these settings, use the `ConfigureManagementSettings` method. + "effectiveTransferLockState": "A String", # Output only. The actual transfer lock state for this `Registration`. "preferredRenewalMethod": "A String", # Optional. The desired renewal method for this `Registration`. The actual `renewal_method` is automatically updated to reflect this choice. If unset or equal to `RENEWAL_METHOD_UNSPECIFIED`, the actual `renewalMethod` is treated as if it were set to `AUTOMATIC_RENEWAL`. You cannot use `RENEWAL_DISABLED` during resource creation, and you can update the renewal status only when the `Registration` resource has state `ACTIVE` or `SUSPENDED`. When `preferred_renewal_method` is set to `AUTOMATIC_RENEWAL`, the actual `renewal_method` can be set to `RENEWAL_DISABLED` in case of problems with the billing account or reported domain abuse. In such cases, check the `issues` field on the `Registration`. After the problem is resolved, the `renewal_method` is automatically updated to `preferred_renewal_method` in a few hours. "renewalMethod": "A String", # Output only. The actual renewal method for this `Registration`. When `preferred_renewal_method` is set to `AUTOMATIC_RENEWAL`, the actual `renewal_method` can be equal to `RENEWAL_DISABLED`—for example, when there are problems with the billing account or reported domain abuse. In such cases, check the `issues` field on the `Registration`. After the problem is resolved, the `renewal_method` is automatically updated to `preferred_renewal_method` in a few hours. - "transferLockState": "A String", # This is the desired transfer lock state for this `Registration`. A transfer lock controls whether the domain can be transferred to another registrar. + "transferLockState": "A String", # This is the desired transfer lock state for this `Registration`. A transfer lock controls whether the domain can be transferred to another registrar. The transfer lock state of the domain is returned in the `effective_transfer_lock_state` property. The transfer lock state values might be different for the following reasons: * `transfer_lock_state` was updated only a short time ago. * Domains with the `TRANSFER_LOCK_UNSUPPORTED_BY_REGISTRY` state are in the list of `domain_properties`. These domains are always in the `UNLOCKED` state. }, "name": "A String", # Output only. Name of the `Registration` resource, in the format `projects/*/locations/*/registrations/`. "pendingContactSettings": { # Defines the contact information associated with a `Registration`. [ICANN](https://icann.org/) requires all domain names to have associated contact information. The `registrant_contact` is considered the domain's legal owner, and often the other contacts are identical. # Output only. Pending contact settings for the `Registration`. Updates to the `contact_settings` field that change its `registrant_contact` or `privacy` fields require email confirmation by the `registrant_contact` before taking effect. This field is set only if there are pending updates to the `contact_settings` that have not been confirmed. To confirm the changes, the `registrant_contact` must follow the instructions in the email they receive. @@ -1514,9 +1582,56 @@

Method Details

}
+
+ renewDomain(registration, body=None, x__xgafv=None) +
Renews a recently expired domain. This method can only be called on domains that expired in the previous 30 days. After the renewal, the new expiration time of the domain is one year after the old expiration time and you are charged a `yearly_price` for the renewal.
+
+Args:
+  registration: string, Required. The name of the `Registration` whish is being renewed, in the format `projects/*/locations/*/registrations/*`. (required)
+  body: object, The request body.
+    The object takes the form of:
+
+{ # Request for the `RenewDomain` method.
+  "validateOnly": True or False, # Optional. When true, only validation is performed, without actually renewing the domain. For more information, see [Request validation](https://cloud.google.com/apis/design/design_patterns#request_validation)
+  "yearlyPrice": { # Represents an amount of money with its currency type. # Required. Acknowledgement of the price to renew the domain for one year. To get the price, see [Cloud Domains pricing](https://cloud.google.com/domains/pricing). If not provided, the expected price is returned in the error message.
+    "currencyCode": "A String", # The three-letter currency code defined in ISO 4217.
+    "nanos": 42, # Number of nano (10^-9) units of the amount. The value must be between -999,999,999 and +999,999,999 inclusive. If `units` is positive, `nanos` must be positive or zero. If `units` is zero, `nanos` can be positive, zero, or negative. If `units` is negative, `nanos` must be negative or zero. For example $-1.75 is represented as `units`=-1 and `nanos`=-750,000,000.
+    "units": "A String", # The whole units of the amount. For example if `currencyCode` is `"USD"`, then 1 unit is one US dollar.
+  },
+}
+
+  x__xgafv: string, V1 error format.
+    Allowed values
+      1 - v1 error format
+      2 - v2 error format
+
+Returns:
+  An object of the form:
+
+    { # This resource represents a long-running operation that is the result of a network API call.
+  "done": True or False, # If the value is `false`, it means the operation is still in progress. If `true`, the operation is completed, and either `error` or `response` is available.
+  "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). # The error result of the operation in case of failure or cancellation.
+    "code": 42, # The status code, which should be an enum value of google.rpc.Code.
+    "details": [ # A list of messages that carry the error details. There is a common set of message types for APIs to use.
+      {
+        "a_key": "", # Properties of the object. Contains field @type with type URL.
+      },
+    ],
+    "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.
+  },
+  "metadata": { # Service-specific metadata associated with the operation. It typically contains progress information and common metadata such as create time. Some services might not provide such metadata. Any method that returns a long-running operation should document the metadata type, if any.
+    "a_key": "", # Properties of the object. Contains field @type with type URL.
+  },
+  "name": "A String", # The server-assigned name, which is only unique within the same service that originally returns it. If you use the default HTTP mapping, the `name` should be a resource name ending with `operations/{unique_id}`.
+  "response": { # The normal, successful response of the operation. If the original method returns no data on success, such as `Delete`, the response is `google.protobuf.Empty`. If the original method is standard `Get`/`Create`/`Update`, the response should be the resource. For other methods, the response should have the type `XxxResponse`, where `Xxx` is the original method name. For example, if the original method name is `TakeSnapshot()`, the inferred response type is `TakeSnapshotResponse`.
+    "a_key": "", # Properties of the object. Contains field @type with type URL.
+  },
+}
+
+
resetAuthorizationCode(registration, body=None, x__xgafv=None) -
Resets the authorization code of the `Registration` to a new random string. You can call this method only after 60 days have elapsed since the initial domain registration.
+  
Resets the authorization code of the `Registration` to a new random string. You can call this method only after 60 days have elapsed since the initial domain registration. Domains that have the `REQUIRE_PUSH_TRANSFER` property in the list of `domain_properties` don't support authorization codes and must use the `InitiatePushTransfer` method to initiate the process to transfer the domain to a different registrar.
 
 Args:
   registration: string, Required. The name of the `Registration` whose authorization code is being reset, in the format `projects/*/locations/*/registrations/*`. (required)
@@ -1541,7 +1656,7 @@ 

Method Details

retrieveAuthorizationCode(registration, x__xgafv=None) -
Gets the authorization code of the `Registration` for the purpose of transferring the domain to another registrar. You can call this method only after 60 days have elapsed since the initial domain registration.
+  
Gets the authorization code of the `Registration` for the purpose of transferring the domain to another registrar. You can call this method only after 60 days have elapsed since the initial domain registration. Domains that have the `REQUIRE_PUSH_TRANSFER` property in the list of `domain_properties` don't support authorization codes and must use the `InitiatePushTransfer` method to initiate the process to transfer the domain to a different registrar.
 
 Args:
   registration: string, Required. The name of the `Registration` whose authorization code is being retrieved, in the format `projects/*/locations/*/registrations/*`. (required)
@@ -1558,6 +1673,40 @@ 

Method Details

}
+
+ retrieveGoogleDomainsForwardingConfig(registration, x__xgafv=None) +
Lists the deprecated domain and email forwarding configurations you set up in the deprecated Google Domains UI. The configuration is present only for domains with the `google_domains_redirects_data_available` set to `true` in the `Registration`'s `dns_settings`. A forwarding configuration might not work correctly if required DNS records are not present in the domain's authoritative DNS Zone.
+
+Args:
+  registration: string, Required. The name of the `Registration` whose Google Domains forwarding configuration details are being retrieved, in the format `projects/*/locations/*/registrations/*`. (required)
+  x__xgafv: string, V1 error format.
+    Allowed values
+      1 - v1 error format
+      2 - v2 error format
+
+Returns:
+  An object of the form:
+
+    { # Response for the `RetrieveGoogleDomainsForwardingConfig` method.
+  "domainForwardings": [ # The list of domain forwarding configurations. A forwarding configuration might not work correctly if the required DNS records are not present in the domain's authoritative DNS zone.
+    { # Domain forwarding configuration.
+      "pathForwarding": True or False, # If true, forwards the path after the domain name to the same path at the new address.
+      "pemCertificate": "A String", # The PEM-encoded certificate chain.
+      "redirectType": "A String", # The redirect type.
+      "sslEnabled": True or False, # If true, the forwarding works also over HTTPS.
+      "subdomain": "A String", # The subdomain of the registered domain that is being forwarded. E.g. `www.example.com`, `example.com` (i.e. the registered domain itself) or `*.example.com` (i.e. all subdomains).
+      "targetUri": "A String", # The target of the domain forwarding, i.e. the path to redirect the `subdomain` to.
+    },
+  ],
+  "emailForwardings": [ # The list of email forwarding configurations. A forwarding configuration might not work correctly if the required DNS records are not present in the domain's authoritative DNS zone.
+    { # Email forwarding configuration.
+      "alias": "A String", # An alias recipient email that forwards emails to the `target_email_address`. For example, `admin@example.com` or `*@example.com` (wildcard alias forwards all the emails under the registered domain).
+      "targetEmailAddress": "A String", # Target email that receives emails sent to the `alias`.
+    },
+  ],
+}
+
+
retrieveImportableDomains(location, pageSize=None, pageToken=None, x__xgafv=None)
Deprecated: For more information, see [Cloud Domains feature deprecation](https://cloud.google.com/domains/docs/deprecations/feature-deprecations) Lists domain names from [Google Domains](https://domains.google/) that can be imported to Cloud Domains using the `ImportDomain` method. Since individual users can own domains in Google Domains, the list of domains returned depends on the individual user making the call. Domains already managed by Cloud Domains are not returned.
@@ -1953,6 +2102,9 @@ 

Method Details

}, }, "domainName": "A String", # Required. Immutable. The domain name. Unicode domain names must be expressed in Punycode format. + "domainProperties": [ # Output only. Special properties of the domain. + "A String", + ], "expireTime": "A String", # Output only. The expiration timestamp of the `Registration`. "issues": [ # Output only. The set of issues with the `Registration` that require attention. "A String", @@ -1961,9 +2113,10 @@

Method Details

"a_key": "A String", }, "managementSettings": { # Defines renewal, billing, and transfer settings for a `Registration`. # Settings for management of the `Registration`, including renewal, billing, and transfer. You cannot update these with the `UpdateRegistration` method. To update these settings, use the `ConfigureManagementSettings` method. + "effectiveTransferLockState": "A String", # Output only. The actual transfer lock state for this `Registration`. "preferredRenewalMethod": "A String", # Optional. The desired renewal method for this `Registration`. The actual `renewal_method` is automatically updated to reflect this choice. If unset or equal to `RENEWAL_METHOD_UNSPECIFIED`, the actual `renewalMethod` is treated as if it were set to `AUTOMATIC_RENEWAL`. You cannot use `RENEWAL_DISABLED` during resource creation, and you can update the renewal status only when the `Registration` resource has state `ACTIVE` or `SUSPENDED`. When `preferred_renewal_method` is set to `AUTOMATIC_RENEWAL`, the actual `renewal_method` can be set to `RENEWAL_DISABLED` in case of problems with the billing account or reported domain abuse. In such cases, check the `issues` field on the `Registration`. After the problem is resolved, the `renewal_method` is automatically updated to `preferred_renewal_method` in a few hours. "renewalMethod": "A String", # Output only. The actual renewal method for this `Registration`. When `preferred_renewal_method` is set to `AUTOMATIC_RENEWAL`, the actual `renewal_method` can be equal to `RENEWAL_DISABLED`—for example, when there are problems with the billing account or reported domain abuse. In such cases, check the `issues` field on the `Registration`. After the problem is resolved, the `renewal_method` is automatically updated to `preferred_renewal_method` in a few hours. - "transferLockState": "A String", # This is the desired transfer lock state for this `Registration`. A transfer lock controls whether the domain can be transferred to another registrar. + "transferLockState": "A String", # This is the desired transfer lock state for this `Registration`. A transfer lock controls whether the domain can be transferred to another registrar. The transfer lock state of the domain is returned in the `effective_transfer_lock_state` property. The transfer lock state values might be different for the following reasons: * `transfer_lock_state` was updated only a short time ago. * Domains with the `TRANSFER_LOCK_UNSUPPORTED_BY_REGISTRY` state are in the list of `domain_properties`. These domains are always in the `UNLOCKED` state. }, "name": "A String", # Output only. Name of the `Registration` resource, in the format `projects/*/locations/*/registrations/`. "pendingContactSettings": { # Defines the contact information associated with a `Registration`. [ICANN](https://icann.org/) requires all domain names to have associated contact information. The `registrant_contact` is considered the domain's legal owner, and often the other contacts are identical. # Output only. Pending contact settings for the `Registration`. Updates to the `contact_settings` field that change its `registrant_contact` or `privacy` fields require email confirmation by the `registrant_contact` before taking effect. This field is set only if there are pending updates to the `contact_settings` that have not been confirmed. To confirm the changes, the `registrant_contact` must follow the instructions in the email they receive. diff --git a/docs/dyn/fcmdata_v1beta1.projects.androidApps.deliveryData.html b/docs/dyn/fcmdata_v1beta1.projects.androidApps.deliveryData.html index 7273f88af6b..9a8ff733f76 100644 --- a/docs/dyn/fcmdata_v1beta1.projects.androidApps.deliveryData.html +++ b/docs/dyn/fcmdata_v1beta1.projects.androidApps.deliveryData.html @@ -132,7 +132,7 @@

Method Details

"droppedTtlExpired": 3.14, # The percentage of accepted messages that expired because [Time To Live (TTL)](https://firebase.google.com/docs/cloud-messaging/concept-options#ttl) elapsed before the target device reconnected. "pending": 3.14, # The percentage of messages accepted on this day that were not dropped and not delivered, due to the device being disconnected (as of the end of the America/Los_Angeles day when the message was sent to FCM). A portion of these messages will be delivered the next day when the device connects but others may be destined to devices that ultimately never reconnect. }, - "proxyNotificationInsightPercents": { # Additional information about proxy notification delivery. All percentages are calculated with countNotificationsAccepted as the denominator. # Additional insights about proxy notification delivery. + "proxyNotificationInsightPercents": { # Additional information about [proxy notification](https://firebase.google.com/docs/cloud-messaging/android/message-priority#proxy) delivery. All percentages are calculated with countNotificationsAccepted as the denominator. # Additional insights about proxy notification delivery. "failed": 3.14, # The percentage of accepted notifications that failed to be proxied. This is usually caused by exceptions that occurred while calling [notifyAsPackage](https://developer.android.com/reference/android/app/NotificationManager#notifyAsPackage%28java.lang.String,%20java.lang.String,%20int,%20android.app.Notification%29). "proxied": 3.14, # The percentage of accepted notifications that were successfully proxied by [Google Play services](https://developers.google.com/android/guides/overview). "skippedNotThrottled": 3.14, # The percentage of accepted notifications that were skipped because the messages were not throttled. diff --git a/docs/dyn/firebaseappdistribution_v1.media.html b/docs/dyn/firebaseappdistribution_v1.media.html index dd59d8ace28..2c22fdb4ce4 100644 --- a/docs/dyn/firebaseappdistribution_v1.media.html +++ b/docs/dyn/firebaseappdistribution_v1.media.html @@ -302,7 +302,7 @@

Method Details

"ignoreRange": True or False, # Determining whether or not Apiary should skip the inclusion of any Content-Range header on its response to Scotty. }, "filename": "A String", # Original file name - "hash": "A String", # Deprecated, use one of explicit hash type fields instead. These two hash related fields will only be populated on Scotty based media uploads and will contain the content of the hash group in the NotificationRequest: http://cs/#google3/uploader/service/proto/upload_listener.proto&q=class:Hash Hex encoded hash value of the uploaded media. + "hash": "A String", # Deprecated, use one of explicit hash type fields instead. These two hash related fields will only be populated on Scotty based media uploads and will contain the content of the hash group in the NotificationRequest: http://cs/#google3/blobstore2/api/scotty/service/proto/upload_listener.proto&q=class:Hash Hex encoded hash value of the uploaded media. "hashVerified": True or False, # For Scotty uploads only. If a user sends a hash code and the backend has requested that Scotty verify the upload against the client hash, Scotty will perform the check on behalf of the backend and will reject it if the hashes don't match. This is set to true if Scotty performed this verification. "inline": "A String", # Media data, set if reference_type is INLINE "isPotentialRetry": True or False, # |is_potential_retry| is set false only when Scotty is certain that it has not sent the request before. When a client resumes an upload, this field must be set true in agent calls, because Scotty cannot be certain that it has never sent the request before due to potential failure in the session state persistence. diff --git a/docs/dyn/games_v1.recall.html b/docs/dyn/games_v1.recall.html index d8e62640aac..a9cc8fc6376 100644 --- a/docs/dyn/games_v1.recall.html +++ b/docs/dyn/games_v1.recall.html @@ -77,9 +77,12 @@

Instance Methods

close()

Close httplib2 connections.

+

+ gamesPlayerTokens(sessionId, applicationIds=None, x__xgafv=None)

+

Retrieve the Recall tokens from all requested games that is associated with the PGS Player encoded in the provided recall session id. The API is only available for users that have an active PGS Player profile.

lastTokenFromAllDeveloperGames(sessionId, x__xgafv=None)

-

Retrieve the last Recall token from all developer games that is associated with the PGS Player principal encoded in the provided recall session id. The API is only available for users that have active PGS Player profile.

+

Retrieve the last Recall token from all developer games that is associated with the PGS Player encoded in the provided recall session id. The API is only available for users that have active PGS Player profile.

linkPersona(body=None, x__xgafv=None)

Associate the PGS Player principal encoded in the provided recall session id with an in-game account

@@ -88,7 +91,7 @@

Instance Methods

Delete all Recall tokens linking the given persona to any player (with or without a profile).

retrieveTokens(sessionId, x__xgafv=None)

-

Retrieve all Recall tokens associated with the PGS Player principal encoded in the provided recall session id. The API is only available for users that have active PGS Player profile.

+

Retrieve all Recall tokens associated with the PGS Player encoded in the provided recall session id. The API is only available for users that have active PGS Player profile.

unlinkPersona(body=None, x__xgafv=None)

Delete a Recall token linking the PGS Player principal identified by the Recall session and an in-game account identified either by the 'persona' or by the token value.

@@ -98,9 +101,40 @@

Method Details

Close httplib2 connections.
+
+ gamesPlayerTokens(sessionId, applicationIds=None, x__xgafv=None) +
Retrieve the Recall tokens from all requested games that is associated with the PGS Player encoded in the provided recall session id. The API is only available for users that have an active PGS Player profile.
+
+Args:
+  sessionId: string, Required. Opaque server-generated string that encodes all the necessary information to identify the PGS player / Google user and application. (required)
+  applicationIds: string, Required. The application IDs from the Google Play developer console for the games to return scoped ids for. (repeated)
+  x__xgafv: string, V1 error format.
+    Allowed values
+      1 - v1 error format
+      2 - v2 error format
+
+Returns:
+  An object of the form:
+
+    { # A list of recall token data returned from the RetrieveGamesPlayerTokens RPC
+  "applicationRecallTokens": [ # The requested applications along with the recall tokens for the player. If the player does not have recall tokens for an application, that application is not included in the response.
+    { # Recall tokens for a game.
+      "applicationId": "A String", # The application that this player identifier is for.
+      "token": [ # Recall token data.
+        { # Recall token data returned from RetrievePlayerTokens RPC
+          "expireTime": "A String", # Optional. Optional expiration time of the token
+          "multiPlayerPersona": True or False, # Required. Whether the persona identified by the token is linked to multiple PGS Players
+          "token": "A String", # Required. Value of the Recall token as it is provided by the client via LinkPersona RPC
+        },
+      ],
+    },
+  ],
+}
+
+
lastTokenFromAllDeveloperGames(sessionId, x__xgafv=None) -
Retrieve the last Recall token from all developer games that is associated with the PGS Player principal encoded in the provided recall session id. The API is only available for users that have active PGS Player profile.
+  
Retrieve the last Recall token from all developer games that is associated with the PGS Player encoded in the provided recall session id. The API is only available for users that have active PGS Player profile.
 
 Args:
   sessionId: string, Required. Opaque server-generated string that encodes all the necessary information to identify the PGS player / Google user and application. (required)
@@ -179,7 +213,7 @@ 

Method Details

retrieveTokens(sessionId, x__xgafv=None) -
Retrieve all Recall tokens associated with the PGS Player principal encoded in the provided recall session id. The API is only available for users that have active PGS Player profile.
+  
Retrieve all Recall tokens associated with the PGS Player encoded in the provided recall session id. The API is only available for users that have active PGS Player profile.
 
 Args:
   sessionId: string, Required. Opaque server-generated string that encodes all the necessary information to identify the PGS player / Google user and application. (required)
diff --git a/docs/dyn/index.md b/docs/dyn/index.md
index 04d5daf2929..f56814dcfec 100644
--- a/docs/dyn/index.md
+++ b/docs/dyn/index.md
@@ -58,6 +58,10 @@
 * [v1beta1](http://googleapis.github.io/google-api-python-client/docs/dyn/aiplatform_v1beta1.html)
 
 
+## airquality
+* [v1](http://googleapis.github.io/google-api-python-client/docs/dyn/airquality_v1.html)
+
+
 ## alertcenter
 * [v1beta1](http://googleapis.github.io/google-api-python-client/docs/dyn/alertcenter_v1beta1.html)
 
diff --git a/docs/dyn/looker_v1.projects.locations.instances.html b/docs/dyn/looker_v1.projects.locations.instances.html
index 3e13c9f45b0..3b11c1c82e5 100644
--- a/docs/dyn/looker_v1.projects.locations.instances.html
+++ b/docs/dyn/looker_v1.projects.locations.instances.html
@@ -133,7 +133,7 @@ 

Method Details

body: object, The request body. The object takes the form of: -{ # A Looker instance. LINT.IfChange +{ # A Looker instance. "adminSettings": { # Looker instance Admin settings fields. # Looker Instance Admin settings. "allowedEmailDomains": [ # Email domain allowlist for the instance. "A String", @@ -348,7 +348,7 @@

Method Details

Returns: An object of the form: - { # A Looker instance. LINT.IfChange + { # A Looker instance. "adminSettings": { # Looker instance Admin settings fields. # Looker Instance Admin settings. "allowedEmailDomains": [ # Email domain allowlist for the instance. "A String", @@ -547,7 +547,7 @@

Method Details

{ # Response from ListInstances. "instances": [ # The list of instances matching the request filters, up to the requested ListInstancesRequest.pageSize. - { # A Looker instance. LINT.IfChange + { # A Looker instance. "adminSettings": { # Looker instance Admin settings fields. # Looker Instance Admin settings. "allowedEmailDomains": [ # Email domain allowlist for the instance. "A String", @@ -667,7 +667,7 @@

Method Details

body: object, The request body. The object takes the form of: -{ # A Looker instance. LINT.IfChange +{ # A Looker instance. "adminSettings": { # Looker instance Admin settings fields. # Looker Instance Admin settings. "allowedEmailDomains": [ # Email domain allowlist for the instance. "A String", diff --git a/docs/dyn/managedidentities_v1.projects.locations.global_.domains.backups.html b/docs/dyn/managedidentities_v1.projects.locations.global_.domains.backups.html index c73f11a0004..0009114773c 100644 --- a/docs/dyn/managedidentities_v1.projects.locations.global_.domains.backups.html +++ b/docs/dyn/managedidentities_v1.projects.locations.global_.domains.backups.html @@ -250,7 +250,7 @@

Method Details

"members": [ # Specifies the principals requesting access for a Google Cloud resource. `members` can have the following values: * `allUsers`: A special identifier that represents anyone who is on the internet; with or without a Google account. * `allAuthenticatedUsers`: A special identifier that represents anyone who is authenticated with a Google account or a service account. Does not include identities that come from external identity providers (IdPs) through identity federation. * `user:{emailid}`: An email address that represents a specific Google account. For example, `alice@example.com` . * `serviceAccount:{emailid}`: An email address that represents a Google service account. For example, `my-other-app@appspot.gserviceaccount.com`. * `serviceAccount:{projectid}.svc.id.goog[{namespace}/{kubernetes-sa}]`: An identifier for a [Kubernetes service account](https://cloud.google.com/kubernetes-engine/docs/how-to/kubernetes-service-accounts). For example, `my-project.svc.id.goog[my-namespace/my-kubernetes-sa]`. * `group:{emailid}`: An email address that represents a Google group. For example, `admins@example.com`. * `domain:{domain}`: The G Suite domain (primary) that represents all the users of that domain. For example, `google.com` or `example.com`. * `principal://iam.googleapis.com/locations/global/workforcePools/{pool_id}/subject/{subject_attribute_value}`: A single identity in a workforce identity pool. * `principalSet://iam.googleapis.com/locations/global/workforcePools/{pool_id}/group/{group_id}`: All workforce identities in a group. * `principalSet://iam.googleapis.com/locations/global/workforcePools/{pool_id}/attribute.{attribute_name}/{attribute_value}`: All workforce identities with a specific attribute value. * `principalSet://iam.googleapis.com/locations/global/workforcePools/{pool_id}/*`: All identities in a workforce identity pool. * `principal://iam.googleapis.com/projects/{project_number}/locations/global/workloadIdentityPools/{pool_id}/subject/{subject_attribute_value}`: A single identity in a workload identity pool. * `principalSet://iam.googleapis.com/projects/{project_number}/locations/global/workloadIdentityPools/{pool_id}/group/{group_id}`: A workload identity pool group. * `principalSet://iam.googleapis.com/projects/{project_number}/locations/global/workloadIdentityPools/{pool_id}/attribute.{attribute_name}/{attribute_value}`: All identities in a workload identity pool with a certain attribute. * `principalSet://iam.googleapis.com/projects/{project_number}/locations/global/workloadIdentityPools/{pool_id}/*`: All identities in a workload identity pool. * `deleted:user:{emailid}?uid={uniqueid}`: An email address (plus unique identifier) representing a user that has been recently deleted. For example, `alice@example.com?uid=123456789012345678901`. If the user is recovered, this value reverts to `user:{emailid}` and the recovered user retains the role in the binding. * `deleted:serviceAccount:{emailid}?uid={uniqueid}`: An email address (plus unique identifier) representing a service account that has been recently deleted. For example, `my-other-app@appspot.gserviceaccount.com?uid=123456789012345678901`. If the service account is undeleted, this value reverts to `serviceAccount:{emailid}` and the undeleted service account retains the role in the binding. * `deleted:group:{emailid}?uid={uniqueid}`: An email address (plus unique identifier) representing a Google group that has been recently deleted. For example, `admins@example.com?uid=123456789012345678901`. If the group is recovered, this value reverts to `group:{emailid}` and the recovered group retains the role in the binding. * `deleted:principal://iam.googleapis.com/locations/global/workforcePools/{pool_id}/subject/{subject_attribute_value}`: Deleted single identity in a workforce identity pool. For example, `deleted:principal://iam.googleapis.com/locations/global/workforcePools/my-pool-id/subject/my-subject-attribute-value`. "A String", ], - "role": "A String", # Role that is assigned to the list of `members`, or principals. For example, `roles/viewer`, `roles/editor`, or `roles/owner`. + "role": "A String", # Role that is assigned to the list of `members`, or principals. For example, `roles/viewer`, `roles/editor`, or `roles/owner`. For an overview of the IAM roles and permissions, see the [IAM documentation](https://cloud.google.com/iam/docs/roles-overview). For a list of the available pre-defined roles, see [here](https://cloud.google.com/iam/docs/understanding-roles). }, ], "etag": "A String", # `etag` is used for optimistic concurrency control as a way to help prevent simultaneous updates of a policy from overwriting each other. It is strongly suggested that systems make use of the `etag` in the read-modify-write cycle to perform policy updates in order to avoid race conditions: An `etag` is returned in the response to `getIamPolicy`, and systems are expected to put that etag in the request to `setIamPolicy` to ensure that their change will be applied to the same version of the policy. **Important:** If you use IAM Conditions, you must include the `etag` field whenever you call `setIamPolicy`. If you omit this field, then IAM allows you to overwrite a version `3` policy with a version `1` policy, and all of the conditions in the version `3` policy are lost. @@ -384,7 +384,7 @@

Method Details

"members": [ # Specifies the principals requesting access for a Google Cloud resource. `members` can have the following values: * `allUsers`: A special identifier that represents anyone who is on the internet; with or without a Google account. * `allAuthenticatedUsers`: A special identifier that represents anyone who is authenticated with a Google account or a service account. Does not include identities that come from external identity providers (IdPs) through identity federation. * `user:{emailid}`: An email address that represents a specific Google account. For example, `alice@example.com` . * `serviceAccount:{emailid}`: An email address that represents a Google service account. For example, `my-other-app@appspot.gserviceaccount.com`. * `serviceAccount:{projectid}.svc.id.goog[{namespace}/{kubernetes-sa}]`: An identifier for a [Kubernetes service account](https://cloud.google.com/kubernetes-engine/docs/how-to/kubernetes-service-accounts). For example, `my-project.svc.id.goog[my-namespace/my-kubernetes-sa]`. * `group:{emailid}`: An email address that represents a Google group. For example, `admins@example.com`. * `domain:{domain}`: The G Suite domain (primary) that represents all the users of that domain. For example, `google.com` or `example.com`. * `principal://iam.googleapis.com/locations/global/workforcePools/{pool_id}/subject/{subject_attribute_value}`: A single identity in a workforce identity pool. * `principalSet://iam.googleapis.com/locations/global/workforcePools/{pool_id}/group/{group_id}`: All workforce identities in a group. * `principalSet://iam.googleapis.com/locations/global/workforcePools/{pool_id}/attribute.{attribute_name}/{attribute_value}`: All workforce identities with a specific attribute value. * `principalSet://iam.googleapis.com/locations/global/workforcePools/{pool_id}/*`: All identities in a workforce identity pool. * `principal://iam.googleapis.com/projects/{project_number}/locations/global/workloadIdentityPools/{pool_id}/subject/{subject_attribute_value}`: A single identity in a workload identity pool. * `principalSet://iam.googleapis.com/projects/{project_number}/locations/global/workloadIdentityPools/{pool_id}/group/{group_id}`: A workload identity pool group. * `principalSet://iam.googleapis.com/projects/{project_number}/locations/global/workloadIdentityPools/{pool_id}/attribute.{attribute_name}/{attribute_value}`: All identities in a workload identity pool with a certain attribute. * `principalSet://iam.googleapis.com/projects/{project_number}/locations/global/workloadIdentityPools/{pool_id}/*`: All identities in a workload identity pool. * `deleted:user:{emailid}?uid={uniqueid}`: An email address (plus unique identifier) representing a user that has been recently deleted. For example, `alice@example.com?uid=123456789012345678901`. If the user is recovered, this value reverts to `user:{emailid}` and the recovered user retains the role in the binding. * `deleted:serviceAccount:{emailid}?uid={uniqueid}`: An email address (plus unique identifier) representing a service account that has been recently deleted. For example, `my-other-app@appspot.gserviceaccount.com?uid=123456789012345678901`. If the service account is undeleted, this value reverts to `serviceAccount:{emailid}` and the undeleted service account retains the role in the binding. * `deleted:group:{emailid}?uid={uniqueid}`: An email address (plus unique identifier) representing a Google group that has been recently deleted. For example, `admins@example.com?uid=123456789012345678901`. If the group is recovered, this value reverts to `group:{emailid}` and the recovered group retains the role in the binding. * `deleted:principal://iam.googleapis.com/locations/global/workforcePools/{pool_id}/subject/{subject_attribute_value}`: Deleted single identity in a workforce identity pool. For example, `deleted:principal://iam.googleapis.com/locations/global/workforcePools/my-pool-id/subject/my-subject-attribute-value`. "A String", ], - "role": "A String", # Role that is assigned to the list of `members`, or principals. For example, `roles/viewer`, `roles/editor`, or `roles/owner`. + "role": "A String", # Role that is assigned to the list of `members`, or principals. For example, `roles/viewer`, `roles/editor`, or `roles/owner`. For an overview of the IAM roles and permissions, see the [IAM documentation](https://cloud.google.com/iam/docs/roles-overview). For a list of the available pre-defined roles, see [here](https://cloud.google.com/iam/docs/understanding-roles). }, ], "etag": "A String", # `etag` is used for optimistic concurrency control as a way to help prevent simultaneous updates of a policy from overwriting each other. It is strongly suggested that systems make use of the `etag` in the read-modify-write cycle to perform policy updates in order to avoid race conditions: An `etag` is returned in the response to `getIamPolicy`, and systems are expected to put that etag in the request to `setIamPolicy` to ensure that their change will be applied to the same version of the policy. **Important:** If you use IAM Conditions, you must include the `etag` field whenever you call `setIamPolicy`. If you omit this field, then IAM allows you to overwrite a version `3` policy with a version `1` policy, and all of the conditions in the version `3` policy are lost. @@ -412,7 +412,7 @@

Method Details

"members": [ # Specifies the principals requesting access for a Google Cloud resource. `members` can have the following values: * `allUsers`: A special identifier that represents anyone who is on the internet; with or without a Google account. * `allAuthenticatedUsers`: A special identifier that represents anyone who is authenticated with a Google account or a service account. Does not include identities that come from external identity providers (IdPs) through identity federation. * `user:{emailid}`: An email address that represents a specific Google account. For example, `alice@example.com` . * `serviceAccount:{emailid}`: An email address that represents a Google service account. For example, `my-other-app@appspot.gserviceaccount.com`. * `serviceAccount:{projectid}.svc.id.goog[{namespace}/{kubernetes-sa}]`: An identifier for a [Kubernetes service account](https://cloud.google.com/kubernetes-engine/docs/how-to/kubernetes-service-accounts). For example, `my-project.svc.id.goog[my-namespace/my-kubernetes-sa]`. * `group:{emailid}`: An email address that represents a Google group. For example, `admins@example.com`. * `domain:{domain}`: The G Suite domain (primary) that represents all the users of that domain. For example, `google.com` or `example.com`. * `principal://iam.googleapis.com/locations/global/workforcePools/{pool_id}/subject/{subject_attribute_value}`: A single identity in a workforce identity pool. * `principalSet://iam.googleapis.com/locations/global/workforcePools/{pool_id}/group/{group_id}`: All workforce identities in a group. * `principalSet://iam.googleapis.com/locations/global/workforcePools/{pool_id}/attribute.{attribute_name}/{attribute_value}`: All workforce identities with a specific attribute value. * `principalSet://iam.googleapis.com/locations/global/workforcePools/{pool_id}/*`: All identities in a workforce identity pool. * `principal://iam.googleapis.com/projects/{project_number}/locations/global/workloadIdentityPools/{pool_id}/subject/{subject_attribute_value}`: A single identity in a workload identity pool. * `principalSet://iam.googleapis.com/projects/{project_number}/locations/global/workloadIdentityPools/{pool_id}/group/{group_id}`: A workload identity pool group. * `principalSet://iam.googleapis.com/projects/{project_number}/locations/global/workloadIdentityPools/{pool_id}/attribute.{attribute_name}/{attribute_value}`: All identities in a workload identity pool with a certain attribute. * `principalSet://iam.googleapis.com/projects/{project_number}/locations/global/workloadIdentityPools/{pool_id}/*`: All identities in a workload identity pool. * `deleted:user:{emailid}?uid={uniqueid}`: An email address (plus unique identifier) representing a user that has been recently deleted. For example, `alice@example.com?uid=123456789012345678901`. If the user is recovered, this value reverts to `user:{emailid}` and the recovered user retains the role in the binding. * `deleted:serviceAccount:{emailid}?uid={uniqueid}`: An email address (plus unique identifier) representing a service account that has been recently deleted. For example, `my-other-app@appspot.gserviceaccount.com?uid=123456789012345678901`. If the service account is undeleted, this value reverts to `serviceAccount:{emailid}` and the undeleted service account retains the role in the binding. * `deleted:group:{emailid}?uid={uniqueid}`: An email address (plus unique identifier) representing a Google group that has been recently deleted. For example, `admins@example.com?uid=123456789012345678901`. If the group is recovered, this value reverts to `group:{emailid}` and the recovered group retains the role in the binding. * `deleted:principal://iam.googleapis.com/locations/global/workforcePools/{pool_id}/subject/{subject_attribute_value}`: Deleted single identity in a workforce identity pool. For example, `deleted:principal://iam.googleapis.com/locations/global/workforcePools/my-pool-id/subject/my-subject-attribute-value`. "A String", ], - "role": "A String", # Role that is assigned to the list of `members`, or principals. For example, `roles/viewer`, `roles/editor`, or `roles/owner`. + "role": "A String", # Role that is assigned to the list of `members`, or principals. For example, `roles/viewer`, `roles/editor`, or `roles/owner`. For an overview of the IAM roles and permissions, see the [IAM documentation](https://cloud.google.com/iam/docs/roles-overview). For a list of the available pre-defined roles, see [here](https://cloud.google.com/iam/docs/understanding-roles). }, ], "etag": "A String", # `etag` is used for optimistic concurrency control as a way to help prevent simultaneous updates of a policy from overwriting each other. It is strongly suggested that systems make use of the `etag` in the read-modify-write cycle to perform policy updates in order to avoid race conditions: An `etag` is returned in the response to `getIamPolicy`, and systems are expected to put that etag in the request to `setIamPolicy` to ensure that their change will be applied to the same version of the policy. **Important:** If you use IAM Conditions, you must include the `etag` field whenever you call `setIamPolicy`. If you omit this field, then IAM allows you to overwrite a version `3` policy with a version `1` policy, and all of the conditions in the version `3` policy are lost. diff --git a/docs/dyn/managedidentities_v1.projects.locations.global_.domains.html b/docs/dyn/managedidentities_v1.projects.locations.global_.domains.html index 6be58948fdd..e52e60889ef 100644 --- a/docs/dyn/managedidentities_v1.projects.locations.global_.domains.html +++ b/docs/dyn/managedidentities_v1.projects.locations.global_.domains.html @@ -266,7 +266,7 @@

Method Details

"labels": { # Optional. Resource labels that can contain user-provided metadata. "a_key": "A String", }, - "locations": [ # Required. Locations where domain needs to be provisioned. regions e.g. us-west1 or us-east4 Service supports up to 4 locations at once. Each location will use a /26 block. + "locations": [ # Required. Locations where domain needs to be provisioned. The locations can be specified according to https://cloud.google.com/compute/docs/regions-zones, such as `us-west1` or `us-east4`. Each domain supports up to 4 locations, separated by commas. Each location will use a /26 block. "A String", ], "name": "A String", # Required. The unique name of the domain using the form: `projects/{project_id}/locations/global/domains/{domain_name}`. @@ -599,7 +599,7 @@

Method Details

"labels": { # Optional. Resource labels that can contain user-provided metadata. "a_key": "A String", }, - "locations": [ # Required. Locations where domain needs to be provisioned. regions e.g. us-west1 or us-east4 Service supports up to 4 locations at once. Each location will use a /26 block. + "locations": [ # Required. Locations where domain needs to be provisioned. The locations can be specified according to https://cloud.google.com/compute/docs/regions-zones, such as `us-west1` or `us-east4`. Each domain supports up to 4 locations, separated by commas. Each location will use a /26 block. "A String", ], "name": "A String", # Required. The unique name of the domain using the form: `projects/{project_id}/locations/global/domains/{domain_name}`. @@ -654,7 +654,7 @@

Method Details

"members": [ # Specifies the principals requesting access for a Google Cloud resource. `members` can have the following values: * `allUsers`: A special identifier that represents anyone who is on the internet; with or without a Google account. * `allAuthenticatedUsers`: A special identifier that represents anyone who is authenticated with a Google account or a service account. Does not include identities that come from external identity providers (IdPs) through identity federation. * `user:{emailid}`: An email address that represents a specific Google account. For example, `alice@example.com` . * `serviceAccount:{emailid}`: An email address that represents a Google service account. For example, `my-other-app@appspot.gserviceaccount.com`. * `serviceAccount:{projectid}.svc.id.goog[{namespace}/{kubernetes-sa}]`: An identifier for a [Kubernetes service account](https://cloud.google.com/kubernetes-engine/docs/how-to/kubernetes-service-accounts). For example, `my-project.svc.id.goog[my-namespace/my-kubernetes-sa]`. * `group:{emailid}`: An email address that represents a Google group. For example, `admins@example.com`. * `domain:{domain}`: The G Suite domain (primary) that represents all the users of that domain. For example, `google.com` or `example.com`. * `principal://iam.googleapis.com/locations/global/workforcePools/{pool_id}/subject/{subject_attribute_value}`: A single identity in a workforce identity pool. * `principalSet://iam.googleapis.com/locations/global/workforcePools/{pool_id}/group/{group_id}`: All workforce identities in a group. * `principalSet://iam.googleapis.com/locations/global/workforcePools/{pool_id}/attribute.{attribute_name}/{attribute_value}`: All workforce identities with a specific attribute value. * `principalSet://iam.googleapis.com/locations/global/workforcePools/{pool_id}/*`: All identities in a workforce identity pool. * `principal://iam.googleapis.com/projects/{project_number}/locations/global/workloadIdentityPools/{pool_id}/subject/{subject_attribute_value}`: A single identity in a workload identity pool. * `principalSet://iam.googleapis.com/projects/{project_number}/locations/global/workloadIdentityPools/{pool_id}/group/{group_id}`: A workload identity pool group. * `principalSet://iam.googleapis.com/projects/{project_number}/locations/global/workloadIdentityPools/{pool_id}/attribute.{attribute_name}/{attribute_value}`: All identities in a workload identity pool with a certain attribute. * `principalSet://iam.googleapis.com/projects/{project_number}/locations/global/workloadIdentityPools/{pool_id}/*`: All identities in a workload identity pool. * `deleted:user:{emailid}?uid={uniqueid}`: An email address (plus unique identifier) representing a user that has been recently deleted. For example, `alice@example.com?uid=123456789012345678901`. If the user is recovered, this value reverts to `user:{emailid}` and the recovered user retains the role in the binding. * `deleted:serviceAccount:{emailid}?uid={uniqueid}`: An email address (plus unique identifier) representing a service account that has been recently deleted. For example, `my-other-app@appspot.gserviceaccount.com?uid=123456789012345678901`. If the service account is undeleted, this value reverts to `serviceAccount:{emailid}` and the undeleted service account retains the role in the binding. * `deleted:group:{emailid}?uid={uniqueid}`: An email address (plus unique identifier) representing a Google group that has been recently deleted. For example, `admins@example.com?uid=123456789012345678901`. If the group is recovered, this value reverts to `group:{emailid}` and the recovered group retains the role in the binding. * `deleted:principal://iam.googleapis.com/locations/global/workforcePools/{pool_id}/subject/{subject_attribute_value}`: Deleted single identity in a workforce identity pool. For example, `deleted:principal://iam.googleapis.com/locations/global/workforcePools/my-pool-id/subject/my-subject-attribute-value`. "A String", ], - "role": "A String", # Role that is assigned to the list of `members`, or principals. For example, `roles/viewer`, `roles/editor`, or `roles/owner`. + "role": "A String", # Role that is assigned to the list of `members`, or principals. For example, `roles/viewer`, `roles/editor`, or `roles/owner`. For an overview of the IAM roles and permissions, see the [IAM documentation](https://cloud.google.com/iam/docs/roles-overview). For a list of the available pre-defined roles, see [here](https://cloud.google.com/iam/docs/understanding-roles). }, ], "etag": "A String", # `etag` is used for optimistic concurrency control as a way to help prevent simultaneous updates of a policy from overwriting each other. It is strongly suggested that systems make use of the `etag` in the read-modify-write cycle to perform policy updates in order to avoid race conditions: An `etag` is returned in the response to `getIamPolicy`, and systems are expected to put that etag in the request to `setIamPolicy` to ensure that their change will be applied to the same version of the policy. **Important:** If you use IAM Conditions, you must include the `etag` field whenever you call `setIamPolicy`. If you omit this field, then IAM allows you to overwrite a version `3` policy with a version `1` policy, and all of the conditions in the version `3` policy are lost. @@ -725,7 +725,7 @@

Method Details

"labels": { # Optional. Resource labels that can contain user-provided metadata. "a_key": "A String", }, - "locations": [ # Required. Locations where domain needs to be provisioned. regions e.g. us-west1 or us-east4 Service supports up to 4 locations at once. Each location will use a /26 block. + "locations": [ # Required. Locations where domain needs to be provisioned. The locations can be specified according to https://cloud.google.com/compute/docs/regions-zones, such as `us-west1` or `us-east4`. Each domain supports up to 4 locations, separated by commas. Each location will use a /26 block. "A String", ], "name": "A String", # Required. The unique name of the domain using the form: `projects/{project_id}/locations/global/domains/{domain_name}`. @@ -793,7 +793,7 @@

Method Details

"labels": { # Optional. Resource labels that can contain user-provided metadata. "a_key": "A String", }, - "locations": [ # Required. Locations where domain needs to be provisioned. regions e.g. us-west1 or us-east4 Service supports up to 4 locations at once. Each location will use a /26 block. + "locations": [ # Required. Locations where domain needs to be provisioned. The locations can be specified according to https://cloud.google.com/compute/docs/regions-zones, such as `us-west1` or `us-east4`. Each domain supports up to 4 locations, separated by commas. Each location will use a /26 block. "A String", ], "name": "A String", # Required. The unique name of the domain using the form: `projects/{project_id}/locations/global/domains/{domain_name}`. @@ -984,7 +984,7 @@

Method Details

"members": [ # Specifies the principals requesting access for a Google Cloud resource. `members` can have the following values: * `allUsers`: A special identifier that represents anyone who is on the internet; with or without a Google account. * `allAuthenticatedUsers`: A special identifier that represents anyone who is authenticated with a Google account or a service account. Does not include identities that come from external identity providers (IdPs) through identity federation. * `user:{emailid}`: An email address that represents a specific Google account. For example, `alice@example.com` . * `serviceAccount:{emailid}`: An email address that represents a Google service account. For example, `my-other-app@appspot.gserviceaccount.com`. * `serviceAccount:{projectid}.svc.id.goog[{namespace}/{kubernetes-sa}]`: An identifier for a [Kubernetes service account](https://cloud.google.com/kubernetes-engine/docs/how-to/kubernetes-service-accounts). For example, `my-project.svc.id.goog[my-namespace/my-kubernetes-sa]`. * `group:{emailid}`: An email address that represents a Google group. For example, `admins@example.com`. * `domain:{domain}`: The G Suite domain (primary) that represents all the users of that domain. For example, `google.com` or `example.com`. * `principal://iam.googleapis.com/locations/global/workforcePools/{pool_id}/subject/{subject_attribute_value}`: A single identity in a workforce identity pool. * `principalSet://iam.googleapis.com/locations/global/workforcePools/{pool_id}/group/{group_id}`: All workforce identities in a group. * `principalSet://iam.googleapis.com/locations/global/workforcePools/{pool_id}/attribute.{attribute_name}/{attribute_value}`: All workforce identities with a specific attribute value. * `principalSet://iam.googleapis.com/locations/global/workforcePools/{pool_id}/*`: All identities in a workforce identity pool. * `principal://iam.googleapis.com/projects/{project_number}/locations/global/workloadIdentityPools/{pool_id}/subject/{subject_attribute_value}`: A single identity in a workload identity pool. * `principalSet://iam.googleapis.com/projects/{project_number}/locations/global/workloadIdentityPools/{pool_id}/group/{group_id}`: A workload identity pool group. * `principalSet://iam.googleapis.com/projects/{project_number}/locations/global/workloadIdentityPools/{pool_id}/attribute.{attribute_name}/{attribute_value}`: All identities in a workload identity pool with a certain attribute. * `principalSet://iam.googleapis.com/projects/{project_number}/locations/global/workloadIdentityPools/{pool_id}/*`: All identities in a workload identity pool. * `deleted:user:{emailid}?uid={uniqueid}`: An email address (plus unique identifier) representing a user that has been recently deleted. For example, `alice@example.com?uid=123456789012345678901`. If the user is recovered, this value reverts to `user:{emailid}` and the recovered user retains the role in the binding. * `deleted:serviceAccount:{emailid}?uid={uniqueid}`: An email address (plus unique identifier) representing a service account that has been recently deleted. For example, `my-other-app@appspot.gserviceaccount.com?uid=123456789012345678901`. If the service account is undeleted, this value reverts to `serviceAccount:{emailid}` and the undeleted service account retains the role in the binding. * `deleted:group:{emailid}?uid={uniqueid}`: An email address (plus unique identifier) representing a Google group that has been recently deleted. For example, `admins@example.com?uid=123456789012345678901`. If the group is recovered, this value reverts to `group:{emailid}` and the recovered group retains the role in the binding. * `deleted:principal://iam.googleapis.com/locations/global/workforcePools/{pool_id}/subject/{subject_attribute_value}`: Deleted single identity in a workforce identity pool. For example, `deleted:principal://iam.googleapis.com/locations/global/workforcePools/my-pool-id/subject/my-subject-attribute-value`. "A String", ], - "role": "A String", # Role that is assigned to the list of `members`, or principals. For example, `roles/viewer`, `roles/editor`, or `roles/owner`. + "role": "A String", # Role that is assigned to the list of `members`, or principals. For example, `roles/viewer`, `roles/editor`, or `roles/owner`. For an overview of the IAM roles and permissions, see the [IAM documentation](https://cloud.google.com/iam/docs/roles-overview). For a list of the available pre-defined roles, see [here](https://cloud.google.com/iam/docs/understanding-roles). }, ], "etag": "A String", # `etag` is used for optimistic concurrency control as a way to help prevent simultaneous updates of a policy from overwriting each other. It is strongly suggested that systems make use of the `etag` in the read-modify-write cycle to perform policy updates in order to avoid race conditions: An `etag` is returned in the response to `getIamPolicy`, and systems are expected to put that etag in the request to `setIamPolicy` to ensure that their change will be applied to the same version of the policy. **Important:** If you use IAM Conditions, you must include the `etag` field whenever you call `setIamPolicy`. If you omit this field, then IAM allows you to overwrite a version `3` policy with a version `1` policy, and all of the conditions in the version `3` policy are lost. @@ -1012,7 +1012,7 @@

Method Details

"members": [ # Specifies the principals requesting access for a Google Cloud resource. `members` can have the following values: * `allUsers`: A special identifier that represents anyone who is on the internet; with or without a Google account. * `allAuthenticatedUsers`: A special identifier that represents anyone who is authenticated with a Google account or a service account. Does not include identities that come from external identity providers (IdPs) through identity federation. * `user:{emailid}`: An email address that represents a specific Google account. For example, `alice@example.com` . * `serviceAccount:{emailid}`: An email address that represents a Google service account. For example, `my-other-app@appspot.gserviceaccount.com`. * `serviceAccount:{projectid}.svc.id.goog[{namespace}/{kubernetes-sa}]`: An identifier for a [Kubernetes service account](https://cloud.google.com/kubernetes-engine/docs/how-to/kubernetes-service-accounts). For example, `my-project.svc.id.goog[my-namespace/my-kubernetes-sa]`. * `group:{emailid}`: An email address that represents a Google group. For example, `admins@example.com`. * `domain:{domain}`: The G Suite domain (primary) that represents all the users of that domain. For example, `google.com` or `example.com`. * `principal://iam.googleapis.com/locations/global/workforcePools/{pool_id}/subject/{subject_attribute_value}`: A single identity in a workforce identity pool. * `principalSet://iam.googleapis.com/locations/global/workforcePools/{pool_id}/group/{group_id}`: All workforce identities in a group. * `principalSet://iam.googleapis.com/locations/global/workforcePools/{pool_id}/attribute.{attribute_name}/{attribute_value}`: All workforce identities with a specific attribute value. * `principalSet://iam.googleapis.com/locations/global/workforcePools/{pool_id}/*`: All identities in a workforce identity pool. * `principal://iam.googleapis.com/projects/{project_number}/locations/global/workloadIdentityPools/{pool_id}/subject/{subject_attribute_value}`: A single identity in a workload identity pool. * `principalSet://iam.googleapis.com/projects/{project_number}/locations/global/workloadIdentityPools/{pool_id}/group/{group_id}`: A workload identity pool group. * `principalSet://iam.googleapis.com/projects/{project_number}/locations/global/workloadIdentityPools/{pool_id}/attribute.{attribute_name}/{attribute_value}`: All identities in a workload identity pool with a certain attribute. * `principalSet://iam.googleapis.com/projects/{project_number}/locations/global/workloadIdentityPools/{pool_id}/*`: All identities in a workload identity pool. * `deleted:user:{emailid}?uid={uniqueid}`: An email address (plus unique identifier) representing a user that has been recently deleted. For example, `alice@example.com?uid=123456789012345678901`. If the user is recovered, this value reverts to `user:{emailid}` and the recovered user retains the role in the binding. * `deleted:serviceAccount:{emailid}?uid={uniqueid}`: An email address (plus unique identifier) representing a service account that has been recently deleted. For example, `my-other-app@appspot.gserviceaccount.com?uid=123456789012345678901`. If the service account is undeleted, this value reverts to `serviceAccount:{emailid}` and the undeleted service account retains the role in the binding. * `deleted:group:{emailid}?uid={uniqueid}`: An email address (plus unique identifier) representing a Google group that has been recently deleted. For example, `admins@example.com?uid=123456789012345678901`. If the group is recovered, this value reverts to `group:{emailid}` and the recovered group retains the role in the binding. * `deleted:principal://iam.googleapis.com/locations/global/workforcePools/{pool_id}/subject/{subject_attribute_value}`: Deleted single identity in a workforce identity pool. For example, `deleted:principal://iam.googleapis.com/locations/global/workforcePools/my-pool-id/subject/my-subject-attribute-value`. "A String", ], - "role": "A String", # Role that is assigned to the list of `members`, or principals. For example, `roles/viewer`, `roles/editor`, or `roles/owner`. + "role": "A String", # Role that is assigned to the list of `members`, or principals. For example, `roles/viewer`, `roles/editor`, or `roles/owner`. For an overview of the IAM roles and permissions, see the [IAM documentation](https://cloud.google.com/iam/docs/roles-overview). For a list of the available pre-defined roles, see [here](https://cloud.google.com/iam/docs/understanding-roles). }, ], "etag": "A String", # `etag` is used for optimistic concurrency control as a way to help prevent simultaneous updates of a policy from overwriting each other. It is strongly suggested that systems make use of the `etag` in the read-modify-write cycle to perform policy updates in order to avoid race conditions: An `etag` is returned in the response to `getIamPolicy`, and systems are expected to put that etag in the request to `setIamPolicy` to ensure that their change will be applied to the same version of the policy. **Important:** If you use IAM Conditions, you must include the `etag` field whenever you call `setIamPolicy`. If you omit this field, then IAM allows you to overwrite a version `3` policy with a version `1` policy, and all of the conditions in the version `3` policy are lost. diff --git a/docs/dyn/managedidentities_v1.projects.locations.global_.peerings.html b/docs/dyn/managedidentities_v1.projects.locations.global_.peerings.html index 0bf71e414f3..f705cdd2292 100644 --- a/docs/dyn/managedidentities_v1.projects.locations.global_.peerings.html +++ b/docs/dyn/managedidentities_v1.projects.locations.global_.peerings.html @@ -252,7 +252,7 @@

Method Details

"members": [ # Specifies the principals requesting access for a Google Cloud resource. `members` can have the following values: * `allUsers`: A special identifier that represents anyone who is on the internet; with or without a Google account. * `allAuthenticatedUsers`: A special identifier that represents anyone who is authenticated with a Google account or a service account. Does not include identities that come from external identity providers (IdPs) through identity federation. * `user:{emailid}`: An email address that represents a specific Google account. For example, `alice@example.com` . * `serviceAccount:{emailid}`: An email address that represents a Google service account. For example, `my-other-app@appspot.gserviceaccount.com`. * `serviceAccount:{projectid}.svc.id.goog[{namespace}/{kubernetes-sa}]`: An identifier for a [Kubernetes service account](https://cloud.google.com/kubernetes-engine/docs/how-to/kubernetes-service-accounts). For example, `my-project.svc.id.goog[my-namespace/my-kubernetes-sa]`. * `group:{emailid}`: An email address that represents a Google group. For example, `admins@example.com`. * `domain:{domain}`: The G Suite domain (primary) that represents all the users of that domain. For example, `google.com` or `example.com`. * `principal://iam.googleapis.com/locations/global/workforcePools/{pool_id}/subject/{subject_attribute_value}`: A single identity in a workforce identity pool. * `principalSet://iam.googleapis.com/locations/global/workforcePools/{pool_id}/group/{group_id}`: All workforce identities in a group. * `principalSet://iam.googleapis.com/locations/global/workforcePools/{pool_id}/attribute.{attribute_name}/{attribute_value}`: All workforce identities with a specific attribute value. * `principalSet://iam.googleapis.com/locations/global/workforcePools/{pool_id}/*`: All identities in a workforce identity pool. * `principal://iam.googleapis.com/projects/{project_number}/locations/global/workloadIdentityPools/{pool_id}/subject/{subject_attribute_value}`: A single identity in a workload identity pool. * `principalSet://iam.googleapis.com/projects/{project_number}/locations/global/workloadIdentityPools/{pool_id}/group/{group_id}`: A workload identity pool group. * `principalSet://iam.googleapis.com/projects/{project_number}/locations/global/workloadIdentityPools/{pool_id}/attribute.{attribute_name}/{attribute_value}`: All identities in a workload identity pool with a certain attribute. * `principalSet://iam.googleapis.com/projects/{project_number}/locations/global/workloadIdentityPools/{pool_id}/*`: All identities in a workload identity pool. * `deleted:user:{emailid}?uid={uniqueid}`: An email address (plus unique identifier) representing a user that has been recently deleted. For example, `alice@example.com?uid=123456789012345678901`. If the user is recovered, this value reverts to `user:{emailid}` and the recovered user retains the role in the binding. * `deleted:serviceAccount:{emailid}?uid={uniqueid}`: An email address (plus unique identifier) representing a service account that has been recently deleted. For example, `my-other-app@appspot.gserviceaccount.com?uid=123456789012345678901`. If the service account is undeleted, this value reverts to `serviceAccount:{emailid}` and the undeleted service account retains the role in the binding. * `deleted:group:{emailid}?uid={uniqueid}`: An email address (plus unique identifier) representing a Google group that has been recently deleted. For example, `admins@example.com?uid=123456789012345678901`. If the group is recovered, this value reverts to `group:{emailid}` and the recovered group retains the role in the binding. * `deleted:principal://iam.googleapis.com/locations/global/workforcePools/{pool_id}/subject/{subject_attribute_value}`: Deleted single identity in a workforce identity pool. For example, `deleted:principal://iam.googleapis.com/locations/global/workforcePools/my-pool-id/subject/my-subject-attribute-value`. "A String", ], - "role": "A String", # Role that is assigned to the list of `members`, or principals. For example, `roles/viewer`, `roles/editor`, or `roles/owner`. + "role": "A String", # Role that is assigned to the list of `members`, or principals. For example, `roles/viewer`, `roles/editor`, or `roles/owner`. For an overview of the IAM roles and permissions, see the [IAM documentation](https://cloud.google.com/iam/docs/roles-overview). For a list of the available pre-defined roles, see [here](https://cloud.google.com/iam/docs/understanding-roles). }, ], "etag": "A String", # `etag` is used for optimistic concurrency control as a way to help prevent simultaneous updates of a policy from overwriting each other. It is strongly suggested that systems make use of the `etag` in the read-modify-write cycle to perform policy updates in order to avoid race conditions: An `etag` is returned in the response to `getIamPolicy`, and systems are expected to put that etag in the request to `setIamPolicy` to ensure that their change will be applied to the same version of the policy. **Important:** If you use IAM Conditions, you must include the `etag` field whenever you call `setIamPolicy`. If you omit this field, then IAM allows you to overwrite a version `3` policy with a version `1` policy, and all of the conditions in the version `3` policy are lost. @@ -388,7 +388,7 @@

Method Details

"members": [ # Specifies the principals requesting access for a Google Cloud resource. `members` can have the following values: * `allUsers`: A special identifier that represents anyone who is on the internet; with or without a Google account. * `allAuthenticatedUsers`: A special identifier that represents anyone who is authenticated with a Google account or a service account. Does not include identities that come from external identity providers (IdPs) through identity federation. * `user:{emailid}`: An email address that represents a specific Google account. For example, `alice@example.com` . * `serviceAccount:{emailid}`: An email address that represents a Google service account. For example, `my-other-app@appspot.gserviceaccount.com`. * `serviceAccount:{projectid}.svc.id.goog[{namespace}/{kubernetes-sa}]`: An identifier for a [Kubernetes service account](https://cloud.google.com/kubernetes-engine/docs/how-to/kubernetes-service-accounts). For example, `my-project.svc.id.goog[my-namespace/my-kubernetes-sa]`. * `group:{emailid}`: An email address that represents a Google group. For example, `admins@example.com`. * `domain:{domain}`: The G Suite domain (primary) that represents all the users of that domain. For example, `google.com` or `example.com`. * `principal://iam.googleapis.com/locations/global/workforcePools/{pool_id}/subject/{subject_attribute_value}`: A single identity in a workforce identity pool. * `principalSet://iam.googleapis.com/locations/global/workforcePools/{pool_id}/group/{group_id}`: All workforce identities in a group. * `principalSet://iam.googleapis.com/locations/global/workforcePools/{pool_id}/attribute.{attribute_name}/{attribute_value}`: All workforce identities with a specific attribute value. * `principalSet://iam.googleapis.com/locations/global/workforcePools/{pool_id}/*`: All identities in a workforce identity pool. * `principal://iam.googleapis.com/projects/{project_number}/locations/global/workloadIdentityPools/{pool_id}/subject/{subject_attribute_value}`: A single identity in a workload identity pool. * `principalSet://iam.googleapis.com/projects/{project_number}/locations/global/workloadIdentityPools/{pool_id}/group/{group_id}`: A workload identity pool group. * `principalSet://iam.googleapis.com/projects/{project_number}/locations/global/workloadIdentityPools/{pool_id}/attribute.{attribute_name}/{attribute_value}`: All identities in a workload identity pool with a certain attribute. * `principalSet://iam.googleapis.com/projects/{project_number}/locations/global/workloadIdentityPools/{pool_id}/*`: All identities in a workload identity pool. * `deleted:user:{emailid}?uid={uniqueid}`: An email address (plus unique identifier) representing a user that has been recently deleted. For example, `alice@example.com?uid=123456789012345678901`. If the user is recovered, this value reverts to `user:{emailid}` and the recovered user retains the role in the binding. * `deleted:serviceAccount:{emailid}?uid={uniqueid}`: An email address (plus unique identifier) representing a service account that has been recently deleted. For example, `my-other-app@appspot.gserviceaccount.com?uid=123456789012345678901`. If the service account is undeleted, this value reverts to `serviceAccount:{emailid}` and the undeleted service account retains the role in the binding. * `deleted:group:{emailid}?uid={uniqueid}`: An email address (plus unique identifier) representing a Google group that has been recently deleted. For example, `admins@example.com?uid=123456789012345678901`. If the group is recovered, this value reverts to `group:{emailid}` and the recovered group retains the role in the binding. * `deleted:principal://iam.googleapis.com/locations/global/workforcePools/{pool_id}/subject/{subject_attribute_value}`: Deleted single identity in a workforce identity pool. For example, `deleted:principal://iam.googleapis.com/locations/global/workforcePools/my-pool-id/subject/my-subject-attribute-value`. "A String", ], - "role": "A String", # Role that is assigned to the list of `members`, or principals. For example, `roles/viewer`, `roles/editor`, or `roles/owner`. + "role": "A String", # Role that is assigned to the list of `members`, or principals. For example, `roles/viewer`, `roles/editor`, or `roles/owner`. For an overview of the IAM roles and permissions, see the [IAM documentation](https://cloud.google.com/iam/docs/roles-overview). For a list of the available pre-defined roles, see [here](https://cloud.google.com/iam/docs/understanding-roles). }, ], "etag": "A String", # `etag` is used for optimistic concurrency control as a way to help prevent simultaneous updates of a policy from overwriting each other. It is strongly suggested that systems make use of the `etag` in the read-modify-write cycle to perform policy updates in order to avoid race conditions: An `etag` is returned in the response to `getIamPolicy`, and systems are expected to put that etag in the request to `setIamPolicy` to ensure that their change will be applied to the same version of the policy. **Important:** If you use IAM Conditions, you must include the `etag` field whenever you call `setIamPolicy`. If you omit this field, then IAM allows you to overwrite a version `3` policy with a version `1` policy, and all of the conditions in the version `3` policy are lost. @@ -416,7 +416,7 @@

Method Details

"members": [ # Specifies the principals requesting access for a Google Cloud resource. `members` can have the following values: * `allUsers`: A special identifier that represents anyone who is on the internet; with or without a Google account. * `allAuthenticatedUsers`: A special identifier that represents anyone who is authenticated with a Google account or a service account. Does not include identities that come from external identity providers (IdPs) through identity federation. * `user:{emailid}`: An email address that represents a specific Google account. For example, `alice@example.com` . * `serviceAccount:{emailid}`: An email address that represents a Google service account. For example, `my-other-app@appspot.gserviceaccount.com`. * `serviceAccount:{projectid}.svc.id.goog[{namespace}/{kubernetes-sa}]`: An identifier for a [Kubernetes service account](https://cloud.google.com/kubernetes-engine/docs/how-to/kubernetes-service-accounts). For example, `my-project.svc.id.goog[my-namespace/my-kubernetes-sa]`. * `group:{emailid}`: An email address that represents a Google group. For example, `admins@example.com`. * `domain:{domain}`: The G Suite domain (primary) that represents all the users of that domain. For example, `google.com` or `example.com`. * `principal://iam.googleapis.com/locations/global/workforcePools/{pool_id}/subject/{subject_attribute_value}`: A single identity in a workforce identity pool. * `principalSet://iam.googleapis.com/locations/global/workforcePools/{pool_id}/group/{group_id}`: All workforce identities in a group. * `principalSet://iam.googleapis.com/locations/global/workforcePools/{pool_id}/attribute.{attribute_name}/{attribute_value}`: All workforce identities with a specific attribute value. * `principalSet://iam.googleapis.com/locations/global/workforcePools/{pool_id}/*`: All identities in a workforce identity pool. * `principal://iam.googleapis.com/projects/{project_number}/locations/global/workloadIdentityPools/{pool_id}/subject/{subject_attribute_value}`: A single identity in a workload identity pool. * `principalSet://iam.googleapis.com/projects/{project_number}/locations/global/workloadIdentityPools/{pool_id}/group/{group_id}`: A workload identity pool group. * `principalSet://iam.googleapis.com/projects/{project_number}/locations/global/workloadIdentityPools/{pool_id}/attribute.{attribute_name}/{attribute_value}`: All identities in a workload identity pool with a certain attribute. * `principalSet://iam.googleapis.com/projects/{project_number}/locations/global/workloadIdentityPools/{pool_id}/*`: All identities in a workload identity pool. * `deleted:user:{emailid}?uid={uniqueid}`: An email address (plus unique identifier) representing a user that has been recently deleted. For example, `alice@example.com?uid=123456789012345678901`. If the user is recovered, this value reverts to `user:{emailid}` and the recovered user retains the role in the binding. * `deleted:serviceAccount:{emailid}?uid={uniqueid}`: An email address (plus unique identifier) representing a service account that has been recently deleted. For example, `my-other-app@appspot.gserviceaccount.com?uid=123456789012345678901`. If the service account is undeleted, this value reverts to `serviceAccount:{emailid}` and the undeleted service account retains the role in the binding. * `deleted:group:{emailid}?uid={uniqueid}`: An email address (plus unique identifier) representing a Google group that has been recently deleted. For example, `admins@example.com?uid=123456789012345678901`. If the group is recovered, this value reverts to `group:{emailid}` and the recovered group retains the role in the binding. * `deleted:principal://iam.googleapis.com/locations/global/workforcePools/{pool_id}/subject/{subject_attribute_value}`: Deleted single identity in a workforce identity pool. For example, `deleted:principal://iam.googleapis.com/locations/global/workforcePools/my-pool-id/subject/my-subject-attribute-value`. "A String", ], - "role": "A String", # Role that is assigned to the list of `members`, or principals. For example, `roles/viewer`, `roles/editor`, or `roles/owner`. + "role": "A String", # Role that is assigned to the list of `members`, or principals. For example, `roles/viewer`, `roles/editor`, or `roles/owner`. For an overview of the IAM roles and permissions, see the [IAM documentation](https://cloud.google.com/iam/docs/roles-overview). For a list of the available pre-defined roles, see [here](https://cloud.google.com/iam/docs/understanding-roles). }, ], "etag": "A String", # `etag` is used for optimistic concurrency control as a way to help prevent simultaneous updates of a policy from overwriting each other. It is strongly suggested that systems make use of the `etag` in the read-modify-write cycle to perform policy updates in order to avoid race conditions: An `etag` is returned in the response to `getIamPolicy`, and systems are expected to put that etag in the request to `setIamPolicy` to ensure that their change will be applied to the same version of the policy. **Important:** If you use IAM Conditions, you must include the `etag` field whenever you call `setIamPolicy`. If you omit this field, then IAM allows you to overwrite a version `3` policy with a version `1` policy, and all of the conditions in the version `3` policy are lost. diff --git a/docs/dyn/managedidentities_v1alpha1.projects.locations.global_.domains.backups.html b/docs/dyn/managedidentities_v1alpha1.projects.locations.global_.domains.backups.html index 4a578e6acb3..6acb28b5e71 100644 --- a/docs/dyn/managedidentities_v1alpha1.projects.locations.global_.domains.backups.html +++ b/docs/dyn/managedidentities_v1alpha1.projects.locations.global_.domains.backups.html @@ -252,7 +252,7 @@

Method Details

"members": [ # Specifies the principals requesting access for a Google Cloud resource. `members` can have the following values: * `allUsers`: A special identifier that represents anyone who is on the internet; with or without a Google account. * `allAuthenticatedUsers`: A special identifier that represents anyone who is authenticated with a Google account or a service account. Does not include identities that come from external identity providers (IdPs) through identity federation. * `user:{emailid}`: An email address that represents a specific Google account. For example, `alice@example.com` . * `serviceAccount:{emailid}`: An email address that represents a Google service account. For example, `my-other-app@appspot.gserviceaccount.com`. * `serviceAccount:{projectid}.svc.id.goog[{namespace}/{kubernetes-sa}]`: An identifier for a [Kubernetes service account](https://cloud.google.com/kubernetes-engine/docs/how-to/kubernetes-service-accounts). For example, `my-project.svc.id.goog[my-namespace/my-kubernetes-sa]`. * `group:{emailid}`: An email address that represents a Google group. For example, `admins@example.com`. * `domain:{domain}`: The G Suite domain (primary) that represents all the users of that domain. For example, `google.com` or `example.com`. * `principal://iam.googleapis.com/locations/global/workforcePools/{pool_id}/subject/{subject_attribute_value}`: A single identity in a workforce identity pool. * `principalSet://iam.googleapis.com/locations/global/workforcePools/{pool_id}/group/{group_id}`: All workforce identities in a group. * `principalSet://iam.googleapis.com/locations/global/workforcePools/{pool_id}/attribute.{attribute_name}/{attribute_value}`: All workforce identities with a specific attribute value. * `principalSet://iam.googleapis.com/locations/global/workforcePools/{pool_id}/*`: All identities in a workforce identity pool. * `principal://iam.googleapis.com/projects/{project_number}/locations/global/workloadIdentityPools/{pool_id}/subject/{subject_attribute_value}`: A single identity in a workload identity pool. * `principalSet://iam.googleapis.com/projects/{project_number}/locations/global/workloadIdentityPools/{pool_id}/group/{group_id}`: A workload identity pool group. * `principalSet://iam.googleapis.com/projects/{project_number}/locations/global/workloadIdentityPools/{pool_id}/attribute.{attribute_name}/{attribute_value}`: All identities in a workload identity pool with a certain attribute. * `principalSet://iam.googleapis.com/projects/{project_number}/locations/global/workloadIdentityPools/{pool_id}/*`: All identities in a workload identity pool. * `deleted:user:{emailid}?uid={uniqueid}`: An email address (plus unique identifier) representing a user that has been recently deleted. For example, `alice@example.com?uid=123456789012345678901`. If the user is recovered, this value reverts to `user:{emailid}` and the recovered user retains the role in the binding. * `deleted:serviceAccount:{emailid}?uid={uniqueid}`: An email address (plus unique identifier) representing a service account that has been recently deleted. For example, `my-other-app@appspot.gserviceaccount.com?uid=123456789012345678901`. If the service account is undeleted, this value reverts to `serviceAccount:{emailid}` and the undeleted service account retains the role in the binding. * `deleted:group:{emailid}?uid={uniqueid}`: An email address (plus unique identifier) representing a Google group that has been recently deleted. For example, `admins@example.com?uid=123456789012345678901`. If the group is recovered, this value reverts to `group:{emailid}` and the recovered group retains the role in the binding. * `deleted:principal://iam.googleapis.com/locations/global/workforcePools/{pool_id}/subject/{subject_attribute_value}`: Deleted single identity in a workforce identity pool. For example, `deleted:principal://iam.googleapis.com/locations/global/workforcePools/my-pool-id/subject/my-subject-attribute-value`. "A String", ], - "role": "A String", # Role that is assigned to the list of `members`, or principals. For example, `roles/viewer`, `roles/editor`, or `roles/owner`. + "role": "A String", # Role that is assigned to the list of `members`, or principals. For example, `roles/viewer`, `roles/editor`, or `roles/owner`. For an overview of the IAM roles and permissions, see the [IAM documentation](https://cloud.google.com/iam/docs/roles-overview). For a list of the available pre-defined roles, see [here](https://cloud.google.com/iam/docs/understanding-roles). }, ], "etag": "A String", # `etag` is used for optimistic concurrency control as a way to help prevent simultaneous updates of a policy from overwriting each other. It is strongly suggested that systems make use of the `etag` in the read-modify-write cycle to perform policy updates in order to avoid race conditions: An `etag` is returned in the response to `getIamPolicy`, and systems are expected to put that etag in the request to `setIamPolicy` to ensure that their change will be applied to the same version of the policy. **Important:** If you use IAM Conditions, you must include the `etag` field whenever you call `setIamPolicy`. If you omit this field, then IAM allows you to overwrite a version `3` policy with a version `1` policy, and all of the conditions in the version `3` policy are lost. @@ -388,7 +388,7 @@

Method Details

"members": [ # Specifies the principals requesting access for a Google Cloud resource. `members` can have the following values: * `allUsers`: A special identifier that represents anyone who is on the internet; with or without a Google account. * `allAuthenticatedUsers`: A special identifier that represents anyone who is authenticated with a Google account or a service account. Does not include identities that come from external identity providers (IdPs) through identity federation. * `user:{emailid}`: An email address that represents a specific Google account. For example, `alice@example.com` . * `serviceAccount:{emailid}`: An email address that represents a Google service account. For example, `my-other-app@appspot.gserviceaccount.com`. * `serviceAccount:{projectid}.svc.id.goog[{namespace}/{kubernetes-sa}]`: An identifier for a [Kubernetes service account](https://cloud.google.com/kubernetes-engine/docs/how-to/kubernetes-service-accounts). For example, `my-project.svc.id.goog[my-namespace/my-kubernetes-sa]`. * `group:{emailid}`: An email address that represents a Google group. For example, `admins@example.com`. * `domain:{domain}`: The G Suite domain (primary) that represents all the users of that domain. For example, `google.com` or `example.com`. * `principal://iam.googleapis.com/locations/global/workforcePools/{pool_id}/subject/{subject_attribute_value}`: A single identity in a workforce identity pool. * `principalSet://iam.googleapis.com/locations/global/workforcePools/{pool_id}/group/{group_id}`: All workforce identities in a group. * `principalSet://iam.googleapis.com/locations/global/workforcePools/{pool_id}/attribute.{attribute_name}/{attribute_value}`: All workforce identities with a specific attribute value. * `principalSet://iam.googleapis.com/locations/global/workforcePools/{pool_id}/*`: All identities in a workforce identity pool. * `principal://iam.googleapis.com/projects/{project_number}/locations/global/workloadIdentityPools/{pool_id}/subject/{subject_attribute_value}`: A single identity in a workload identity pool. * `principalSet://iam.googleapis.com/projects/{project_number}/locations/global/workloadIdentityPools/{pool_id}/group/{group_id}`: A workload identity pool group. * `principalSet://iam.googleapis.com/projects/{project_number}/locations/global/workloadIdentityPools/{pool_id}/attribute.{attribute_name}/{attribute_value}`: All identities in a workload identity pool with a certain attribute. * `principalSet://iam.googleapis.com/projects/{project_number}/locations/global/workloadIdentityPools/{pool_id}/*`: All identities in a workload identity pool. * `deleted:user:{emailid}?uid={uniqueid}`: An email address (plus unique identifier) representing a user that has been recently deleted. For example, `alice@example.com?uid=123456789012345678901`. If the user is recovered, this value reverts to `user:{emailid}` and the recovered user retains the role in the binding. * `deleted:serviceAccount:{emailid}?uid={uniqueid}`: An email address (plus unique identifier) representing a service account that has been recently deleted. For example, `my-other-app@appspot.gserviceaccount.com?uid=123456789012345678901`. If the service account is undeleted, this value reverts to `serviceAccount:{emailid}` and the undeleted service account retains the role in the binding. * `deleted:group:{emailid}?uid={uniqueid}`: An email address (plus unique identifier) representing a Google group that has been recently deleted. For example, `admins@example.com?uid=123456789012345678901`. If the group is recovered, this value reverts to `group:{emailid}` and the recovered group retains the role in the binding. * `deleted:principal://iam.googleapis.com/locations/global/workforcePools/{pool_id}/subject/{subject_attribute_value}`: Deleted single identity in a workforce identity pool. For example, `deleted:principal://iam.googleapis.com/locations/global/workforcePools/my-pool-id/subject/my-subject-attribute-value`. "A String", ], - "role": "A String", # Role that is assigned to the list of `members`, or principals. For example, `roles/viewer`, `roles/editor`, or `roles/owner`. + "role": "A String", # Role that is assigned to the list of `members`, or principals. For example, `roles/viewer`, `roles/editor`, or `roles/owner`. For an overview of the IAM roles and permissions, see the [IAM documentation](https://cloud.google.com/iam/docs/roles-overview). For a list of the available pre-defined roles, see [here](https://cloud.google.com/iam/docs/understanding-roles). }, ], "etag": "A String", # `etag` is used for optimistic concurrency control as a way to help prevent simultaneous updates of a policy from overwriting each other. It is strongly suggested that systems make use of the `etag` in the read-modify-write cycle to perform policy updates in order to avoid race conditions: An `etag` is returned in the response to `getIamPolicy`, and systems are expected to put that etag in the request to `setIamPolicy` to ensure that their change will be applied to the same version of the policy. **Important:** If you use IAM Conditions, you must include the `etag` field whenever you call `setIamPolicy`. If you omit this field, then IAM allows you to overwrite a version `3` policy with a version `1` policy, and all of the conditions in the version `3` policy are lost. @@ -416,7 +416,7 @@

Method Details

"members": [ # Specifies the principals requesting access for a Google Cloud resource. `members` can have the following values: * `allUsers`: A special identifier that represents anyone who is on the internet; with or without a Google account. * `allAuthenticatedUsers`: A special identifier that represents anyone who is authenticated with a Google account or a service account. Does not include identities that come from external identity providers (IdPs) through identity federation. * `user:{emailid}`: An email address that represents a specific Google account. For example, `alice@example.com` . * `serviceAccount:{emailid}`: An email address that represents a Google service account. For example, `my-other-app@appspot.gserviceaccount.com`. * `serviceAccount:{projectid}.svc.id.goog[{namespace}/{kubernetes-sa}]`: An identifier for a [Kubernetes service account](https://cloud.google.com/kubernetes-engine/docs/how-to/kubernetes-service-accounts). For example, `my-project.svc.id.goog[my-namespace/my-kubernetes-sa]`. * `group:{emailid}`: An email address that represents a Google group. For example, `admins@example.com`. * `domain:{domain}`: The G Suite domain (primary) that represents all the users of that domain. For example, `google.com` or `example.com`. * `principal://iam.googleapis.com/locations/global/workforcePools/{pool_id}/subject/{subject_attribute_value}`: A single identity in a workforce identity pool. * `principalSet://iam.googleapis.com/locations/global/workforcePools/{pool_id}/group/{group_id}`: All workforce identities in a group. * `principalSet://iam.googleapis.com/locations/global/workforcePools/{pool_id}/attribute.{attribute_name}/{attribute_value}`: All workforce identities with a specific attribute value. * `principalSet://iam.googleapis.com/locations/global/workforcePools/{pool_id}/*`: All identities in a workforce identity pool. * `principal://iam.googleapis.com/projects/{project_number}/locations/global/workloadIdentityPools/{pool_id}/subject/{subject_attribute_value}`: A single identity in a workload identity pool. * `principalSet://iam.googleapis.com/projects/{project_number}/locations/global/workloadIdentityPools/{pool_id}/group/{group_id}`: A workload identity pool group. * `principalSet://iam.googleapis.com/projects/{project_number}/locations/global/workloadIdentityPools/{pool_id}/attribute.{attribute_name}/{attribute_value}`: All identities in a workload identity pool with a certain attribute. * `principalSet://iam.googleapis.com/projects/{project_number}/locations/global/workloadIdentityPools/{pool_id}/*`: All identities in a workload identity pool. * `deleted:user:{emailid}?uid={uniqueid}`: An email address (plus unique identifier) representing a user that has been recently deleted. For example, `alice@example.com?uid=123456789012345678901`. If the user is recovered, this value reverts to `user:{emailid}` and the recovered user retains the role in the binding. * `deleted:serviceAccount:{emailid}?uid={uniqueid}`: An email address (plus unique identifier) representing a service account that has been recently deleted. For example, `my-other-app@appspot.gserviceaccount.com?uid=123456789012345678901`. If the service account is undeleted, this value reverts to `serviceAccount:{emailid}` and the undeleted service account retains the role in the binding. * `deleted:group:{emailid}?uid={uniqueid}`: An email address (plus unique identifier) representing a Google group that has been recently deleted. For example, `admins@example.com?uid=123456789012345678901`. If the group is recovered, this value reverts to `group:{emailid}` and the recovered group retains the role in the binding. * `deleted:principal://iam.googleapis.com/locations/global/workforcePools/{pool_id}/subject/{subject_attribute_value}`: Deleted single identity in a workforce identity pool. For example, `deleted:principal://iam.googleapis.com/locations/global/workforcePools/my-pool-id/subject/my-subject-attribute-value`. "A String", ], - "role": "A String", # Role that is assigned to the list of `members`, or principals. For example, `roles/viewer`, `roles/editor`, or `roles/owner`. + "role": "A String", # Role that is assigned to the list of `members`, or principals. For example, `roles/viewer`, `roles/editor`, or `roles/owner`. For an overview of the IAM roles and permissions, see the [IAM documentation](https://cloud.google.com/iam/docs/roles-overview). For a list of the available pre-defined roles, see [here](https://cloud.google.com/iam/docs/understanding-roles). }, ], "etag": "A String", # `etag` is used for optimistic concurrency control as a way to help prevent simultaneous updates of a policy from overwriting each other. It is strongly suggested that systems make use of the `etag` in the read-modify-write cycle to perform policy updates in order to avoid race conditions: An `etag` is returned in the response to `getIamPolicy`, and systems are expected to put that etag in the request to `setIamPolicy` to ensure that their change will be applied to the same version of the policy. **Important:** If you use IAM Conditions, you must include the `etag` field whenever you call `setIamPolicy`. If you omit this field, then IAM allows you to overwrite a version `3` policy with a version `1` policy, and all of the conditions in the version `3` policy are lost. diff --git a/docs/dyn/managedidentities_v1alpha1.projects.locations.global_.domains.html b/docs/dyn/managedidentities_v1alpha1.projects.locations.global_.domains.html index a281cc6571a..a12273cb8b1 100644 --- a/docs/dyn/managedidentities_v1alpha1.projects.locations.global_.domains.html +++ b/docs/dyn/managedidentities_v1alpha1.projects.locations.global_.domains.html @@ -655,7 +655,7 @@

Method Details

"members": [ # Specifies the principals requesting access for a Google Cloud resource. `members` can have the following values: * `allUsers`: A special identifier that represents anyone who is on the internet; with or without a Google account. * `allAuthenticatedUsers`: A special identifier that represents anyone who is authenticated with a Google account or a service account. Does not include identities that come from external identity providers (IdPs) through identity federation. * `user:{emailid}`: An email address that represents a specific Google account. For example, `alice@example.com` . * `serviceAccount:{emailid}`: An email address that represents a Google service account. For example, `my-other-app@appspot.gserviceaccount.com`. * `serviceAccount:{projectid}.svc.id.goog[{namespace}/{kubernetes-sa}]`: An identifier for a [Kubernetes service account](https://cloud.google.com/kubernetes-engine/docs/how-to/kubernetes-service-accounts). For example, `my-project.svc.id.goog[my-namespace/my-kubernetes-sa]`. * `group:{emailid}`: An email address that represents a Google group. For example, `admins@example.com`. * `domain:{domain}`: The G Suite domain (primary) that represents all the users of that domain. For example, `google.com` or `example.com`. * `principal://iam.googleapis.com/locations/global/workforcePools/{pool_id}/subject/{subject_attribute_value}`: A single identity in a workforce identity pool. * `principalSet://iam.googleapis.com/locations/global/workforcePools/{pool_id}/group/{group_id}`: All workforce identities in a group. * `principalSet://iam.googleapis.com/locations/global/workforcePools/{pool_id}/attribute.{attribute_name}/{attribute_value}`: All workforce identities with a specific attribute value. * `principalSet://iam.googleapis.com/locations/global/workforcePools/{pool_id}/*`: All identities in a workforce identity pool. * `principal://iam.googleapis.com/projects/{project_number}/locations/global/workloadIdentityPools/{pool_id}/subject/{subject_attribute_value}`: A single identity in a workload identity pool. * `principalSet://iam.googleapis.com/projects/{project_number}/locations/global/workloadIdentityPools/{pool_id}/group/{group_id}`: A workload identity pool group. * `principalSet://iam.googleapis.com/projects/{project_number}/locations/global/workloadIdentityPools/{pool_id}/attribute.{attribute_name}/{attribute_value}`: All identities in a workload identity pool with a certain attribute. * `principalSet://iam.googleapis.com/projects/{project_number}/locations/global/workloadIdentityPools/{pool_id}/*`: All identities in a workload identity pool. * `deleted:user:{emailid}?uid={uniqueid}`: An email address (plus unique identifier) representing a user that has been recently deleted. For example, `alice@example.com?uid=123456789012345678901`. If the user is recovered, this value reverts to `user:{emailid}` and the recovered user retains the role in the binding. * `deleted:serviceAccount:{emailid}?uid={uniqueid}`: An email address (plus unique identifier) representing a service account that has been recently deleted. For example, `my-other-app@appspot.gserviceaccount.com?uid=123456789012345678901`. If the service account is undeleted, this value reverts to `serviceAccount:{emailid}` and the undeleted service account retains the role in the binding. * `deleted:group:{emailid}?uid={uniqueid}`: An email address (plus unique identifier) representing a Google group that has been recently deleted. For example, `admins@example.com?uid=123456789012345678901`. If the group is recovered, this value reverts to `group:{emailid}` and the recovered group retains the role in the binding. * `deleted:principal://iam.googleapis.com/locations/global/workforcePools/{pool_id}/subject/{subject_attribute_value}`: Deleted single identity in a workforce identity pool. For example, `deleted:principal://iam.googleapis.com/locations/global/workforcePools/my-pool-id/subject/my-subject-attribute-value`. "A String", ], - "role": "A String", # Role that is assigned to the list of `members`, or principals. For example, `roles/viewer`, `roles/editor`, or `roles/owner`. + "role": "A String", # Role that is assigned to the list of `members`, or principals. For example, `roles/viewer`, `roles/editor`, or `roles/owner`. For an overview of the IAM roles and permissions, see the [IAM documentation](https://cloud.google.com/iam/docs/roles-overview). For a list of the available pre-defined roles, see [here](https://cloud.google.com/iam/docs/understanding-roles). }, ], "etag": "A String", # `etag` is used for optimistic concurrency control as a way to help prevent simultaneous updates of a policy from overwriting each other. It is strongly suggested that systems make use of the `etag` in the read-modify-write cycle to perform policy updates in order to avoid race conditions: An `etag` is returned in the response to `getIamPolicy`, and systems are expected to put that etag in the request to `setIamPolicy` to ensure that their change will be applied to the same version of the policy. **Important:** If you use IAM Conditions, you must include the `etag` field whenever you call `setIamPolicy`. If you omit this field, then IAM allows you to overwrite a version `3` policy with a version `1` policy, and all of the conditions in the version `3` policy are lost. @@ -996,7 +996,7 @@

Method Details

"members": [ # Specifies the principals requesting access for a Google Cloud resource. `members` can have the following values: * `allUsers`: A special identifier that represents anyone who is on the internet; with or without a Google account. * `allAuthenticatedUsers`: A special identifier that represents anyone who is authenticated with a Google account or a service account. Does not include identities that come from external identity providers (IdPs) through identity federation. * `user:{emailid}`: An email address that represents a specific Google account. For example, `alice@example.com` . * `serviceAccount:{emailid}`: An email address that represents a Google service account. For example, `my-other-app@appspot.gserviceaccount.com`. * `serviceAccount:{projectid}.svc.id.goog[{namespace}/{kubernetes-sa}]`: An identifier for a [Kubernetes service account](https://cloud.google.com/kubernetes-engine/docs/how-to/kubernetes-service-accounts). For example, `my-project.svc.id.goog[my-namespace/my-kubernetes-sa]`. * `group:{emailid}`: An email address that represents a Google group. For example, `admins@example.com`. * `domain:{domain}`: The G Suite domain (primary) that represents all the users of that domain. For example, `google.com` or `example.com`. * `principal://iam.googleapis.com/locations/global/workforcePools/{pool_id}/subject/{subject_attribute_value}`: A single identity in a workforce identity pool. * `principalSet://iam.googleapis.com/locations/global/workforcePools/{pool_id}/group/{group_id}`: All workforce identities in a group. * `principalSet://iam.googleapis.com/locations/global/workforcePools/{pool_id}/attribute.{attribute_name}/{attribute_value}`: All workforce identities with a specific attribute value. * `principalSet://iam.googleapis.com/locations/global/workforcePools/{pool_id}/*`: All identities in a workforce identity pool. * `principal://iam.googleapis.com/projects/{project_number}/locations/global/workloadIdentityPools/{pool_id}/subject/{subject_attribute_value}`: A single identity in a workload identity pool. * `principalSet://iam.googleapis.com/projects/{project_number}/locations/global/workloadIdentityPools/{pool_id}/group/{group_id}`: A workload identity pool group. * `principalSet://iam.googleapis.com/projects/{project_number}/locations/global/workloadIdentityPools/{pool_id}/attribute.{attribute_name}/{attribute_value}`: All identities in a workload identity pool with a certain attribute. * `principalSet://iam.googleapis.com/projects/{project_number}/locations/global/workloadIdentityPools/{pool_id}/*`: All identities in a workload identity pool. * `deleted:user:{emailid}?uid={uniqueid}`: An email address (plus unique identifier) representing a user that has been recently deleted. For example, `alice@example.com?uid=123456789012345678901`. If the user is recovered, this value reverts to `user:{emailid}` and the recovered user retains the role in the binding. * `deleted:serviceAccount:{emailid}?uid={uniqueid}`: An email address (plus unique identifier) representing a service account that has been recently deleted. For example, `my-other-app@appspot.gserviceaccount.com?uid=123456789012345678901`. If the service account is undeleted, this value reverts to `serviceAccount:{emailid}` and the undeleted service account retains the role in the binding. * `deleted:group:{emailid}?uid={uniqueid}`: An email address (plus unique identifier) representing a Google group that has been recently deleted. For example, `admins@example.com?uid=123456789012345678901`. If the group is recovered, this value reverts to `group:{emailid}` and the recovered group retains the role in the binding. * `deleted:principal://iam.googleapis.com/locations/global/workforcePools/{pool_id}/subject/{subject_attribute_value}`: Deleted single identity in a workforce identity pool. For example, `deleted:principal://iam.googleapis.com/locations/global/workforcePools/my-pool-id/subject/my-subject-attribute-value`. "A String", ], - "role": "A String", # Role that is assigned to the list of `members`, or principals. For example, `roles/viewer`, `roles/editor`, or `roles/owner`. + "role": "A String", # Role that is assigned to the list of `members`, or principals. For example, `roles/viewer`, `roles/editor`, or `roles/owner`. For an overview of the IAM roles and permissions, see the [IAM documentation](https://cloud.google.com/iam/docs/roles-overview). For a list of the available pre-defined roles, see [here](https://cloud.google.com/iam/docs/understanding-roles). }, ], "etag": "A String", # `etag` is used for optimistic concurrency control as a way to help prevent simultaneous updates of a policy from overwriting each other. It is strongly suggested that systems make use of the `etag` in the read-modify-write cycle to perform policy updates in order to avoid race conditions: An `etag` is returned in the response to `getIamPolicy`, and systems are expected to put that etag in the request to `setIamPolicy` to ensure that their change will be applied to the same version of the policy. **Important:** If you use IAM Conditions, you must include the `etag` field whenever you call `setIamPolicy`. If you omit this field, then IAM allows you to overwrite a version `3` policy with a version `1` policy, and all of the conditions in the version `3` policy are lost. @@ -1024,7 +1024,7 @@

Method Details

"members": [ # Specifies the principals requesting access for a Google Cloud resource. `members` can have the following values: * `allUsers`: A special identifier that represents anyone who is on the internet; with or without a Google account. * `allAuthenticatedUsers`: A special identifier that represents anyone who is authenticated with a Google account or a service account. Does not include identities that come from external identity providers (IdPs) through identity federation. * `user:{emailid}`: An email address that represents a specific Google account. For example, `alice@example.com` . * `serviceAccount:{emailid}`: An email address that represents a Google service account. For example, `my-other-app@appspot.gserviceaccount.com`. * `serviceAccount:{projectid}.svc.id.goog[{namespace}/{kubernetes-sa}]`: An identifier for a [Kubernetes service account](https://cloud.google.com/kubernetes-engine/docs/how-to/kubernetes-service-accounts). For example, `my-project.svc.id.goog[my-namespace/my-kubernetes-sa]`. * `group:{emailid}`: An email address that represents a Google group. For example, `admins@example.com`. * `domain:{domain}`: The G Suite domain (primary) that represents all the users of that domain. For example, `google.com` or `example.com`. * `principal://iam.googleapis.com/locations/global/workforcePools/{pool_id}/subject/{subject_attribute_value}`: A single identity in a workforce identity pool. * `principalSet://iam.googleapis.com/locations/global/workforcePools/{pool_id}/group/{group_id}`: All workforce identities in a group. * `principalSet://iam.googleapis.com/locations/global/workforcePools/{pool_id}/attribute.{attribute_name}/{attribute_value}`: All workforce identities with a specific attribute value. * `principalSet://iam.googleapis.com/locations/global/workforcePools/{pool_id}/*`: All identities in a workforce identity pool. * `principal://iam.googleapis.com/projects/{project_number}/locations/global/workloadIdentityPools/{pool_id}/subject/{subject_attribute_value}`: A single identity in a workload identity pool. * `principalSet://iam.googleapis.com/projects/{project_number}/locations/global/workloadIdentityPools/{pool_id}/group/{group_id}`: A workload identity pool group. * `principalSet://iam.googleapis.com/projects/{project_number}/locations/global/workloadIdentityPools/{pool_id}/attribute.{attribute_name}/{attribute_value}`: All identities in a workload identity pool with a certain attribute. * `principalSet://iam.googleapis.com/projects/{project_number}/locations/global/workloadIdentityPools/{pool_id}/*`: All identities in a workload identity pool. * `deleted:user:{emailid}?uid={uniqueid}`: An email address (plus unique identifier) representing a user that has been recently deleted. For example, `alice@example.com?uid=123456789012345678901`. If the user is recovered, this value reverts to `user:{emailid}` and the recovered user retains the role in the binding. * `deleted:serviceAccount:{emailid}?uid={uniqueid}`: An email address (plus unique identifier) representing a service account that has been recently deleted. For example, `my-other-app@appspot.gserviceaccount.com?uid=123456789012345678901`. If the service account is undeleted, this value reverts to `serviceAccount:{emailid}` and the undeleted service account retains the role in the binding. * `deleted:group:{emailid}?uid={uniqueid}`: An email address (plus unique identifier) representing a Google group that has been recently deleted. For example, `admins@example.com?uid=123456789012345678901`. If the group is recovered, this value reverts to `group:{emailid}` and the recovered group retains the role in the binding. * `deleted:principal://iam.googleapis.com/locations/global/workforcePools/{pool_id}/subject/{subject_attribute_value}`: Deleted single identity in a workforce identity pool. For example, `deleted:principal://iam.googleapis.com/locations/global/workforcePools/my-pool-id/subject/my-subject-attribute-value`. "A String", ], - "role": "A String", # Role that is assigned to the list of `members`, or principals. For example, `roles/viewer`, `roles/editor`, or `roles/owner`. + "role": "A String", # Role that is assigned to the list of `members`, or principals. For example, `roles/viewer`, `roles/editor`, or `roles/owner`. For an overview of the IAM roles and permissions, see the [IAM documentation](https://cloud.google.com/iam/docs/roles-overview). For a list of the available pre-defined roles, see [here](https://cloud.google.com/iam/docs/understanding-roles). }, ], "etag": "A String", # `etag` is used for optimistic concurrency control as a way to help prevent simultaneous updates of a policy from overwriting each other. It is strongly suggested that systems make use of the `etag` in the read-modify-write cycle to perform policy updates in order to avoid race conditions: An `etag` is returned in the response to `getIamPolicy`, and systems are expected to put that etag in the request to `setIamPolicy` to ensure that their change will be applied to the same version of the policy. **Important:** If you use IAM Conditions, you must include the `etag` field whenever you call `setIamPolicy`. If you omit this field, then IAM allows you to overwrite a version `3` policy with a version `1` policy, and all of the conditions in the version `3` policy are lost. diff --git a/docs/dyn/managedidentities_v1alpha1.projects.locations.global_.peerings.html b/docs/dyn/managedidentities_v1alpha1.projects.locations.global_.peerings.html index b3625788ecd..5121b8005ec 100644 --- a/docs/dyn/managedidentities_v1alpha1.projects.locations.global_.peerings.html +++ b/docs/dyn/managedidentities_v1alpha1.projects.locations.global_.peerings.html @@ -252,7 +252,7 @@

Method Details

"members": [ # Specifies the principals requesting access for a Google Cloud resource. `members` can have the following values: * `allUsers`: A special identifier that represents anyone who is on the internet; with or without a Google account. * `allAuthenticatedUsers`: A special identifier that represents anyone who is authenticated with a Google account or a service account. Does not include identities that come from external identity providers (IdPs) through identity federation. * `user:{emailid}`: An email address that represents a specific Google account. For example, `alice@example.com` . * `serviceAccount:{emailid}`: An email address that represents a Google service account. For example, `my-other-app@appspot.gserviceaccount.com`. * `serviceAccount:{projectid}.svc.id.goog[{namespace}/{kubernetes-sa}]`: An identifier for a [Kubernetes service account](https://cloud.google.com/kubernetes-engine/docs/how-to/kubernetes-service-accounts). For example, `my-project.svc.id.goog[my-namespace/my-kubernetes-sa]`. * `group:{emailid}`: An email address that represents a Google group. For example, `admins@example.com`. * `domain:{domain}`: The G Suite domain (primary) that represents all the users of that domain. For example, `google.com` or `example.com`. * `principal://iam.googleapis.com/locations/global/workforcePools/{pool_id}/subject/{subject_attribute_value}`: A single identity in a workforce identity pool. * `principalSet://iam.googleapis.com/locations/global/workforcePools/{pool_id}/group/{group_id}`: All workforce identities in a group. * `principalSet://iam.googleapis.com/locations/global/workforcePools/{pool_id}/attribute.{attribute_name}/{attribute_value}`: All workforce identities with a specific attribute value. * `principalSet://iam.googleapis.com/locations/global/workforcePools/{pool_id}/*`: All identities in a workforce identity pool. * `principal://iam.googleapis.com/projects/{project_number}/locations/global/workloadIdentityPools/{pool_id}/subject/{subject_attribute_value}`: A single identity in a workload identity pool. * `principalSet://iam.googleapis.com/projects/{project_number}/locations/global/workloadIdentityPools/{pool_id}/group/{group_id}`: A workload identity pool group. * `principalSet://iam.googleapis.com/projects/{project_number}/locations/global/workloadIdentityPools/{pool_id}/attribute.{attribute_name}/{attribute_value}`: All identities in a workload identity pool with a certain attribute. * `principalSet://iam.googleapis.com/projects/{project_number}/locations/global/workloadIdentityPools/{pool_id}/*`: All identities in a workload identity pool. * `deleted:user:{emailid}?uid={uniqueid}`: An email address (plus unique identifier) representing a user that has been recently deleted. For example, `alice@example.com?uid=123456789012345678901`. If the user is recovered, this value reverts to `user:{emailid}` and the recovered user retains the role in the binding. * `deleted:serviceAccount:{emailid}?uid={uniqueid}`: An email address (plus unique identifier) representing a service account that has been recently deleted. For example, `my-other-app@appspot.gserviceaccount.com?uid=123456789012345678901`. If the service account is undeleted, this value reverts to `serviceAccount:{emailid}` and the undeleted service account retains the role in the binding. * `deleted:group:{emailid}?uid={uniqueid}`: An email address (plus unique identifier) representing a Google group that has been recently deleted. For example, `admins@example.com?uid=123456789012345678901`. If the group is recovered, this value reverts to `group:{emailid}` and the recovered group retains the role in the binding. * `deleted:principal://iam.googleapis.com/locations/global/workforcePools/{pool_id}/subject/{subject_attribute_value}`: Deleted single identity in a workforce identity pool. For example, `deleted:principal://iam.googleapis.com/locations/global/workforcePools/my-pool-id/subject/my-subject-attribute-value`. "A String", ], - "role": "A String", # Role that is assigned to the list of `members`, or principals. For example, `roles/viewer`, `roles/editor`, or `roles/owner`. + "role": "A String", # Role that is assigned to the list of `members`, or principals. For example, `roles/viewer`, `roles/editor`, or `roles/owner`. For an overview of the IAM roles and permissions, see the [IAM documentation](https://cloud.google.com/iam/docs/roles-overview). For a list of the available pre-defined roles, see [here](https://cloud.google.com/iam/docs/understanding-roles). }, ], "etag": "A String", # `etag` is used for optimistic concurrency control as a way to help prevent simultaneous updates of a policy from overwriting each other. It is strongly suggested that systems make use of the `etag` in the read-modify-write cycle to perform policy updates in order to avoid race conditions: An `etag` is returned in the response to `getIamPolicy`, and systems are expected to put that etag in the request to `setIamPolicy` to ensure that their change will be applied to the same version of the policy. **Important:** If you use IAM Conditions, you must include the `etag` field whenever you call `setIamPolicy`. If you omit this field, then IAM allows you to overwrite a version `3` policy with a version `1` policy, and all of the conditions in the version `3` policy are lost. @@ -388,7 +388,7 @@

Method Details

"members": [ # Specifies the principals requesting access for a Google Cloud resource. `members` can have the following values: * `allUsers`: A special identifier that represents anyone who is on the internet; with or without a Google account. * `allAuthenticatedUsers`: A special identifier that represents anyone who is authenticated with a Google account or a service account. Does not include identities that come from external identity providers (IdPs) through identity federation. * `user:{emailid}`: An email address that represents a specific Google account. For example, `alice@example.com` . * `serviceAccount:{emailid}`: An email address that represents a Google service account. For example, `my-other-app@appspot.gserviceaccount.com`. * `serviceAccount:{projectid}.svc.id.goog[{namespace}/{kubernetes-sa}]`: An identifier for a [Kubernetes service account](https://cloud.google.com/kubernetes-engine/docs/how-to/kubernetes-service-accounts). For example, `my-project.svc.id.goog[my-namespace/my-kubernetes-sa]`. * `group:{emailid}`: An email address that represents a Google group. For example, `admins@example.com`. * `domain:{domain}`: The G Suite domain (primary) that represents all the users of that domain. For example, `google.com` or `example.com`. * `principal://iam.googleapis.com/locations/global/workforcePools/{pool_id}/subject/{subject_attribute_value}`: A single identity in a workforce identity pool. * `principalSet://iam.googleapis.com/locations/global/workforcePools/{pool_id}/group/{group_id}`: All workforce identities in a group. * `principalSet://iam.googleapis.com/locations/global/workforcePools/{pool_id}/attribute.{attribute_name}/{attribute_value}`: All workforce identities with a specific attribute value. * `principalSet://iam.googleapis.com/locations/global/workforcePools/{pool_id}/*`: All identities in a workforce identity pool. * `principal://iam.googleapis.com/projects/{project_number}/locations/global/workloadIdentityPools/{pool_id}/subject/{subject_attribute_value}`: A single identity in a workload identity pool. * `principalSet://iam.googleapis.com/projects/{project_number}/locations/global/workloadIdentityPools/{pool_id}/group/{group_id}`: A workload identity pool group. * `principalSet://iam.googleapis.com/projects/{project_number}/locations/global/workloadIdentityPools/{pool_id}/attribute.{attribute_name}/{attribute_value}`: All identities in a workload identity pool with a certain attribute. * `principalSet://iam.googleapis.com/projects/{project_number}/locations/global/workloadIdentityPools/{pool_id}/*`: All identities in a workload identity pool. * `deleted:user:{emailid}?uid={uniqueid}`: An email address (plus unique identifier) representing a user that has been recently deleted. For example, `alice@example.com?uid=123456789012345678901`. If the user is recovered, this value reverts to `user:{emailid}` and the recovered user retains the role in the binding. * `deleted:serviceAccount:{emailid}?uid={uniqueid}`: An email address (plus unique identifier) representing a service account that has been recently deleted. For example, `my-other-app@appspot.gserviceaccount.com?uid=123456789012345678901`. If the service account is undeleted, this value reverts to `serviceAccount:{emailid}` and the undeleted service account retains the role in the binding. * `deleted:group:{emailid}?uid={uniqueid}`: An email address (plus unique identifier) representing a Google group that has been recently deleted. For example, `admins@example.com?uid=123456789012345678901`. If the group is recovered, this value reverts to `group:{emailid}` and the recovered group retains the role in the binding. * `deleted:principal://iam.googleapis.com/locations/global/workforcePools/{pool_id}/subject/{subject_attribute_value}`: Deleted single identity in a workforce identity pool. For example, `deleted:principal://iam.googleapis.com/locations/global/workforcePools/my-pool-id/subject/my-subject-attribute-value`. "A String", ], - "role": "A String", # Role that is assigned to the list of `members`, or principals. For example, `roles/viewer`, `roles/editor`, or `roles/owner`. + "role": "A String", # Role that is assigned to the list of `members`, or principals. For example, `roles/viewer`, `roles/editor`, or `roles/owner`. For an overview of the IAM roles and permissions, see the [IAM documentation](https://cloud.google.com/iam/docs/roles-overview). For a list of the available pre-defined roles, see [here](https://cloud.google.com/iam/docs/understanding-roles). }, ], "etag": "A String", # `etag` is used for optimistic concurrency control as a way to help prevent simultaneous updates of a policy from overwriting each other. It is strongly suggested that systems make use of the `etag` in the read-modify-write cycle to perform policy updates in order to avoid race conditions: An `etag` is returned in the response to `getIamPolicy`, and systems are expected to put that etag in the request to `setIamPolicy` to ensure that their change will be applied to the same version of the policy. **Important:** If you use IAM Conditions, you must include the `etag` field whenever you call `setIamPolicy`. If you omit this field, then IAM allows you to overwrite a version `3` policy with a version `1` policy, and all of the conditions in the version `3` policy are lost. @@ -416,7 +416,7 @@

Method Details

"members": [ # Specifies the principals requesting access for a Google Cloud resource. `members` can have the following values: * `allUsers`: A special identifier that represents anyone who is on the internet; with or without a Google account. * `allAuthenticatedUsers`: A special identifier that represents anyone who is authenticated with a Google account or a service account. Does not include identities that come from external identity providers (IdPs) through identity federation. * `user:{emailid}`: An email address that represents a specific Google account. For example, `alice@example.com` . * `serviceAccount:{emailid}`: An email address that represents a Google service account. For example, `my-other-app@appspot.gserviceaccount.com`. * `serviceAccount:{projectid}.svc.id.goog[{namespace}/{kubernetes-sa}]`: An identifier for a [Kubernetes service account](https://cloud.google.com/kubernetes-engine/docs/how-to/kubernetes-service-accounts). For example, `my-project.svc.id.goog[my-namespace/my-kubernetes-sa]`. * `group:{emailid}`: An email address that represents a Google group. For example, `admins@example.com`. * `domain:{domain}`: The G Suite domain (primary) that represents all the users of that domain. For example, `google.com` or `example.com`. * `principal://iam.googleapis.com/locations/global/workforcePools/{pool_id}/subject/{subject_attribute_value}`: A single identity in a workforce identity pool. * `principalSet://iam.googleapis.com/locations/global/workforcePools/{pool_id}/group/{group_id}`: All workforce identities in a group. * `principalSet://iam.googleapis.com/locations/global/workforcePools/{pool_id}/attribute.{attribute_name}/{attribute_value}`: All workforce identities with a specific attribute value. * `principalSet://iam.googleapis.com/locations/global/workforcePools/{pool_id}/*`: All identities in a workforce identity pool. * `principal://iam.googleapis.com/projects/{project_number}/locations/global/workloadIdentityPools/{pool_id}/subject/{subject_attribute_value}`: A single identity in a workload identity pool. * `principalSet://iam.googleapis.com/projects/{project_number}/locations/global/workloadIdentityPools/{pool_id}/group/{group_id}`: A workload identity pool group. * `principalSet://iam.googleapis.com/projects/{project_number}/locations/global/workloadIdentityPools/{pool_id}/attribute.{attribute_name}/{attribute_value}`: All identities in a workload identity pool with a certain attribute. * `principalSet://iam.googleapis.com/projects/{project_number}/locations/global/workloadIdentityPools/{pool_id}/*`: All identities in a workload identity pool. * `deleted:user:{emailid}?uid={uniqueid}`: An email address (plus unique identifier) representing a user that has been recently deleted. For example, `alice@example.com?uid=123456789012345678901`. If the user is recovered, this value reverts to `user:{emailid}` and the recovered user retains the role in the binding. * `deleted:serviceAccount:{emailid}?uid={uniqueid}`: An email address (plus unique identifier) representing a service account that has been recently deleted. For example, `my-other-app@appspot.gserviceaccount.com?uid=123456789012345678901`. If the service account is undeleted, this value reverts to `serviceAccount:{emailid}` and the undeleted service account retains the role in the binding. * `deleted:group:{emailid}?uid={uniqueid}`: An email address (plus unique identifier) representing a Google group that has been recently deleted. For example, `admins@example.com?uid=123456789012345678901`. If the group is recovered, this value reverts to `group:{emailid}` and the recovered group retains the role in the binding. * `deleted:principal://iam.googleapis.com/locations/global/workforcePools/{pool_id}/subject/{subject_attribute_value}`: Deleted single identity in a workforce identity pool. For example, `deleted:principal://iam.googleapis.com/locations/global/workforcePools/my-pool-id/subject/my-subject-attribute-value`. "A String", ], - "role": "A String", # Role that is assigned to the list of `members`, or principals. For example, `roles/viewer`, `roles/editor`, or `roles/owner`. + "role": "A String", # Role that is assigned to the list of `members`, or principals. For example, `roles/viewer`, `roles/editor`, or `roles/owner`. For an overview of the IAM roles and permissions, see the [IAM documentation](https://cloud.google.com/iam/docs/roles-overview). For a list of the available pre-defined roles, see [here](https://cloud.google.com/iam/docs/understanding-roles). }, ], "etag": "A String", # `etag` is used for optimistic concurrency control as a way to help prevent simultaneous updates of a policy from overwriting each other. It is strongly suggested that systems make use of the `etag` in the read-modify-write cycle to perform policy updates in order to avoid race conditions: An `etag` is returned in the response to `getIamPolicy`, and systems are expected to put that etag in the request to `setIamPolicy` to ensure that their change will be applied to the same version of the policy. **Important:** If you use IAM Conditions, you must include the `etag` field whenever you call `setIamPolicy`. If you omit this field, then IAM allows you to overwrite a version `3` policy with a version `1` policy, and all of the conditions in the version `3` policy are lost. diff --git a/docs/dyn/managedidentities_v1beta1.projects.locations.global_.domains.backups.html b/docs/dyn/managedidentities_v1beta1.projects.locations.global_.domains.backups.html index 099a464bbd2..6ecf6e4d90d 100644 --- a/docs/dyn/managedidentities_v1beta1.projects.locations.global_.domains.backups.html +++ b/docs/dyn/managedidentities_v1beta1.projects.locations.global_.domains.backups.html @@ -252,7 +252,7 @@

Method Details

"members": [ # Specifies the principals requesting access for a Google Cloud resource. `members` can have the following values: * `allUsers`: A special identifier that represents anyone who is on the internet; with or without a Google account. * `allAuthenticatedUsers`: A special identifier that represents anyone who is authenticated with a Google account or a service account. Does not include identities that come from external identity providers (IdPs) through identity federation. * `user:{emailid}`: An email address that represents a specific Google account. For example, `alice@example.com` . * `serviceAccount:{emailid}`: An email address that represents a Google service account. For example, `my-other-app@appspot.gserviceaccount.com`. * `serviceAccount:{projectid}.svc.id.goog[{namespace}/{kubernetes-sa}]`: An identifier for a [Kubernetes service account](https://cloud.google.com/kubernetes-engine/docs/how-to/kubernetes-service-accounts). For example, `my-project.svc.id.goog[my-namespace/my-kubernetes-sa]`. * `group:{emailid}`: An email address that represents a Google group. For example, `admins@example.com`. * `domain:{domain}`: The G Suite domain (primary) that represents all the users of that domain. For example, `google.com` or `example.com`. * `principal://iam.googleapis.com/locations/global/workforcePools/{pool_id}/subject/{subject_attribute_value}`: A single identity in a workforce identity pool. * `principalSet://iam.googleapis.com/locations/global/workforcePools/{pool_id}/group/{group_id}`: All workforce identities in a group. * `principalSet://iam.googleapis.com/locations/global/workforcePools/{pool_id}/attribute.{attribute_name}/{attribute_value}`: All workforce identities with a specific attribute value. * `principalSet://iam.googleapis.com/locations/global/workforcePools/{pool_id}/*`: All identities in a workforce identity pool. * `principal://iam.googleapis.com/projects/{project_number}/locations/global/workloadIdentityPools/{pool_id}/subject/{subject_attribute_value}`: A single identity in a workload identity pool. * `principalSet://iam.googleapis.com/projects/{project_number}/locations/global/workloadIdentityPools/{pool_id}/group/{group_id}`: A workload identity pool group. * `principalSet://iam.googleapis.com/projects/{project_number}/locations/global/workloadIdentityPools/{pool_id}/attribute.{attribute_name}/{attribute_value}`: All identities in a workload identity pool with a certain attribute. * `principalSet://iam.googleapis.com/projects/{project_number}/locations/global/workloadIdentityPools/{pool_id}/*`: All identities in a workload identity pool. * `deleted:user:{emailid}?uid={uniqueid}`: An email address (plus unique identifier) representing a user that has been recently deleted. For example, `alice@example.com?uid=123456789012345678901`. If the user is recovered, this value reverts to `user:{emailid}` and the recovered user retains the role in the binding. * `deleted:serviceAccount:{emailid}?uid={uniqueid}`: An email address (plus unique identifier) representing a service account that has been recently deleted. For example, `my-other-app@appspot.gserviceaccount.com?uid=123456789012345678901`. If the service account is undeleted, this value reverts to `serviceAccount:{emailid}` and the undeleted service account retains the role in the binding. * `deleted:group:{emailid}?uid={uniqueid}`: An email address (plus unique identifier) representing a Google group that has been recently deleted. For example, `admins@example.com?uid=123456789012345678901`. If the group is recovered, this value reverts to `group:{emailid}` and the recovered group retains the role in the binding. * `deleted:principal://iam.googleapis.com/locations/global/workforcePools/{pool_id}/subject/{subject_attribute_value}`: Deleted single identity in a workforce identity pool. For example, `deleted:principal://iam.googleapis.com/locations/global/workforcePools/my-pool-id/subject/my-subject-attribute-value`. "A String", ], - "role": "A String", # Role that is assigned to the list of `members`, or principals. For example, `roles/viewer`, `roles/editor`, or `roles/owner`. + "role": "A String", # Role that is assigned to the list of `members`, or principals. For example, `roles/viewer`, `roles/editor`, or `roles/owner`. For an overview of the IAM roles and permissions, see the [IAM documentation](https://cloud.google.com/iam/docs/roles-overview). For a list of the available pre-defined roles, see [here](https://cloud.google.com/iam/docs/understanding-roles). }, ], "etag": "A String", # `etag` is used for optimistic concurrency control as a way to help prevent simultaneous updates of a policy from overwriting each other. It is strongly suggested that systems make use of the `etag` in the read-modify-write cycle to perform policy updates in order to avoid race conditions: An `etag` is returned in the response to `getIamPolicy`, and systems are expected to put that etag in the request to `setIamPolicy` to ensure that their change will be applied to the same version of the policy. **Important:** If you use IAM Conditions, you must include the `etag` field whenever you call `setIamPolicy`. If you omit this field, then IAM allows you to overwrite a version `3` policy with a version `1` policy, and all of the conditions in the version `3` policy are lost. @@ -388,7 +388,7 @@

Method Details

"members": [ # Specifies the principals requesting access for a Google Cloud resource. `members` can have the following values: * `allUsers`: A special identifier that represents anyone who is on the internet; with or without a Google account. * `allAuthenticatedUsers`: A special identifier that represents anyone who is authenticated with a Google account or a service account. Does not include identities that come from external identity providers (IdPs) through identity federation. * `user:{emailid}`: An email address that represents a specific Google account. For example, `alice@example.com` . * `serviceAccount:{emailid}`: An email address that represents a Google service account. For example, `my-other-app@appspot.gserviceaccount.com`. * `serviceAccount:{projectid}.svc.id.goog[{namespace}/{kubernetes-sa}]`: An identifier for a [Kubernetes service account](https://cloud.google.com/kubernetes-engine/docs/how-to/kubernetes-service-accounts). For example, `my-project.svc.id.goog[my-namespace/my-kubernetes-sa]`. * `group:{emailid}`: An email address that represents a Google group. For example, `admins@example.com`. * `domain:{domain}`: The G Suite domain (primary) that represents all the users of that domain. For example, `google.com` or `example.com`. * `principal://iam.googleapis.com/locations/global/workforcePools/{pool_id}/subject/{subject_attribute_value}`: A single identity in a workforce identity pool. * `principalSet://iam.googleapis.com/locations/global/workforcePools/{pool_id}/group/{group_id}`: All workforce identities in a group. * `principalSet://iam.googleapis.com/locations/global/workforcePools/{pool_id}/attribute.{attribute_name}/{attribute_value}`: All workforce identities with a specific attribute value. * `principalSet://iam.googleapis.com/locations/global/workforcePools/{pool_id}/*`: All identities in a workforce identity pool. * `principal://iam.googleapis.com/projects/{project_number}/locations/global/workloadIdentityPools/{pool_id}/subject/{subject_attribute_value}`: A single identity in a workload identity pool. * `principalSet://iam.googleapis.com/projects/{project_number}/locations/global/workloadIdentityPools/{pool_id}/group/{group_id}`: A workload identity pool group. * `principalSet://iam.googleapis.com/projects/{project_number}/locations/global/workloadIdentityPools/{pool_id}/attribute.{attribute_name}/{attribute_value}`: All identities in a workload identity pool with a certain attribute. * `principalSet://iam.googleapis.com/projects/{project_number}/locations/global/workloadIdentityPools/{pool_id}/*`: All identities in a workload identity pool. * `deleted:user:{emailid}?uid={uniqueid}`: An email address (plus unique identifier) representing a user that has been recently deleted. For example, `alice@example.com?uid=123456789012345678901`. If the user is recovered, this value reverts to `user:{emailid}` and the recovered user retains the role in the binding. * `deleted:serviceAccount:{emailid}?uid={uniqueid}`: An email address (plus unique identifier) representing a service account that has been recently deleted. For example, `my-other-app@appspot.gserviceaccount.com?uid=123456789012345678901`. If the service account is undeleted, this value reverts to `serviceAccount:{emailid}` and the undeleted service account retains the role in the binding. * `deleted:group:{emailid}?uid={uniqueid}`: An email address (plus unique identifier) representing a Google group that has been recently deleted. For example, `admins@example.com?uid=123456789012345678901`. If the group is recovered, this value reverts to `group:{emailid}` and the recovered group retains the role in the binding. * `deleted:principal://iam.googleapis.com/locations/global/workforcePools/{pool_id}/subject/{subject_attribute_value}`: Deleted single identity in a workforce identity pool. For example, `deleted:principal://iam.googleapis.com/locations/global/workforcePools/my-pool-id/subject/my-subject-attribute-value`. "A String", ], - "role": "A String", # Role that is assigned to the list of `members`, or principals. For example, `roles/viewer`, `roles/editor`, or `roles/owner`. + "role": "A String", # Role that is assigned to the list of `members`, or principals. For example, `roles/viewer`, `roles/editor`, or `roles/owner`. For an overview of the IAM roles and permissions, see the [IAM documentation](https://cloud.google.com/iam/docs/roles-overview). For a list of the available pre-defined roles, see [here](https://cloud.google.com/iam/docs/understanding-roles). }, ], "etag": "A String", # `etag` is used for optimistic concurrency control as a way to help prevent simultaneous updates of a policy from overwriting each other. It is strongly suggested that systems make use of the `etag` in the read-modify-write cycle to perform policy updates in order to avoid race conditions: An `etag` is returned in the response to `getIamPolicy`, and systems are expected to put that etag in the request to `setIamPolicy` to ensure that their change will be applied to the same version of the policy. **Important:** If you use IAM Conditions, you must include the `etag` field whenever you call `setIamPolicy`. If you omit this field, then IAM allows you to overwrite a version `3` policy with a version `1` policy, and all of the conditions in the version `3` policy are lost. @@ -416,7 +416,7 @@

Method Details

"members": [ # Specifies the principals requesting access for a Google Cloud resource. `members` can have the following values: * `allUsers`: A special identifier that represents anyone who is on the internet; with or without a Google account. * `allAuthenticatedUsers`: A special identifier that represents anyone who is authenticated with a Google account or a service account. Does not include identities that come from external identity providers (IdPs) through identity federation. * `user:{emailid}`: An email address that represents a specific Google account. For example, `alice@example.com` . * `serviceAccount:{emailid}`: An email address that represents a Google service account. For example, `my-other-app@appspot.gserviceaccount.com`. * `serviceAccount:{projectid}.svc.id.goog[{namespace}/{kubernetes-sa}]`: An identifier for a [Kubernetes service account](https://cloud.google.com/kubernetes-engine/docs/how-to/kubernetes-service-accounts). For example, `my-project.svc.id.goog[my-namespace/my-kubernetes-sa]`. * `group:{emailid}`: An email address that represents a Google group. For example, `admins@example.com`. * `domain:{domain}`: The G Suite domain (primary) that represents all the users of that domain. For example, `google.com` or `example.com`. * `principal://iam.googleapis.com/locations/global/workforcePools/{pool_id}/subject/{subject_attribute_value}`: A single identity in a workforce identity pool. * `principalSet://iam.googleapis.com/locations/global/workforcePools/{pool_id}/group/{group_id}`: All workforce identities in a group. * `principalSet://iam.googleapis.com/locations/global/workforcePools/{pool_id}/attribute.{attribute_name}/{attribute_value}`: All workforce identities with a specific attribute value. * `principalSet://iam.googleapis.com/locations/global/workforcePools/{pool_id}/*`: All identities in a workforce identity pool. * `principal://iam.googleapis.com/projects/{project_number}/locations/global/workloadIdentityPools/{pool_id}/subject/{subject_attribute_value}`: A single identity in a workload identity pool. * `principalSet://iam.googleapis.com/projects/{project_number}/locations/global/workloadIdentityPools/{pool_id}/group/{group_id}`: A workload identity pool group. * `principalSet://iam.googleapis.com/projects/{project_number}/locations/global/workloadIdentityPools/{pool_id}/attribute.{attribute_name}/{attribute_value}`: All identities in a workload identity pool with a certain attribute. * `principalSet://iam.googleapis.com/projects/{project_number}/locations/global/workloadIdentityPools/{pool_id}/*`: All identities in a workload identity pool. * `deleted:user:{emailid}?uid={uniqueid}`: An email address (plus unique identifier) representing a user that has been recently deleted. For example, `alice@example.com?uid=123456789012345678901`. If the user is recovered, this value reverts to `user:{emailid}` and the recovered user retains the role in the binding. * `deleted:serviceAccount:{emailid}?uid={uniqueid}`: An email address (plus unique identifier) representing a service account that has been recently deleted. For example, `my-other-app@appspot.gserviceaccount.com?uid=123456789012345678901`. If the service account is undeleted, this value reverts to `serviceAccount:{emailid}` and the undeleted service account retains the role in the binding. * `deleted:group:{emailid}?uid={uniqueid}`: An email address (plus unique identifier) representing a Google group that has been recently deleted. For example, `admins@example.com?uid=123456789012345678901`. If the group is recovered, this value reverts to `group:{emailid}` and the recovered group retains the role in the binding. * `deleted:principal://iam.googleapis.com/locations/global/workforcePools/{pool_id}/subject/{subject_attribute_value}`: Deleted single identity in a workforce identity pool. For example, `deleted:principal://iam.googleapis.com/locations/global/workforcePools/my-pool-id/subject/my-subject-attribute-value`. "A String", ], - "role": "A String", # Role that is assigned to the list of `members`, or principals. For example, `roles/viewer`, `roles/editor`, or `roles/owner`. + "role": "A String", # Role that is assigned to the list of `members`, or principals. For example, `roles/viewer`, `roles/editor`, or `roles/owner`. For an overview of the IAM roles and permissions, see the [IAM documentation](https://cloud.google.com/iam/docs/roles-overview). For a list of the available pre-defined roles, see [here](https://cloud.google.com/iam/docs/understanding-roles). }, ], "etag": "A String", # `etag` is used for optimistic concurrency control as a way to help prevent simultaneous updates of a policy from overwriting each other. It is strongly suggested that systems make use of the `etag` in the read-modify-write cycle to perform policy updates in order to avoid race conditions: An `etag` is returned in the response to `getIamPolicy`, and systems are expected to put that etag in the request to `setIamPolicy` to ensure that their change will be applied to the same version of the policy. **Important:** If you use IAM Conditions, you must include the `etag` field whenever you call `setIamPolicy`. If you omit this field, then IAM allows you to overwrite a version `3` policy with a version `1` policy, and all of the conditions in the version `3` policy are lost. diff --git a/docs/dyn/managedidentities_v1beta1.projects.locations.global_.domains.html b/docs/dyn/managedidentities_v1beta1.projects.locations.global_.domains.html index 7b2d0c705f4..4191c407495 100644 --- a/docs/dyn/managedidentities_v1beta1.projects.locations.global_.domains.html +++ b/docs/dyn/managedidentities_v1beta1.projects.locations.global_.domains.html @@ -655,7 +655,7 @@

Method Details

"members": [ # Specifies the principals requesting access for a Google Cloud resource. `members` can have the following values: * `allUsers`: A special identifier that represents anyone who is on the internet; with or without a Google account. * `allAuthenticatedUsers`: A special identifier that represents anyone who is authenticated with a Google account or a service account. Does not include identities that come from external identity providers (IdPs) through identity federation. * `user:{emailid}`: An email address that represents a specific Google account. For example, `alice@example.com` . * `serviceAccount:{emailid}`: An email address that represents a Google service account. For example, `my-other-app@appspot.gserviceaccount.com`. * `serviceAccount:{projectid}.svc.id.goog[{namespace}/{kubernetes-sa}]`: An identifier for a [Kubernetes service account](https://cloud.google.com/kubernetes-engine/docs/how-to/kubernetes-service-accounts). For example, `my-project.svc.id.goog[my-namespace/my-kubernetes-sa]`. * `group:{emailid}`: An email address that represents a Google group. For example, `admins@example.com`. * `domain:{domain}`: The G Suite domain (primary) that represents all the users of that domain. For example, `google.com` or `example.com`. * `principal://iam.googleapis.com/locations/global/workforcePools/{pool_id}/subject/{subject_attribute_value}`: A single identity in a workforce identity pool. * `principalSet://iam.googleapis.com/locations/global/workforcePools/{pool_id}/group/{group_id}`: All workforce identities in a group. * `principalSet://iam.googleapis.com/locations/global/workforcePools/{pool_id}/attribute.{attribute_name}/{attribute_value}`: All workforce identities with a specific attribute value. * `principalSet://iam.googleapis.com/locations/global/workforcePools/{pool_id}/*`: All identities in a workforce identity pool. * `principal://iam.googleapis.com/projects/{project_number}/locations/global/workloadIdentityPools/{pool_id}/subject/{subject_attribute_value}`: A single identity in a workload identity pool. * `principalSet://iam.googleapis.com/projects/{project_number}/locations/global/workloadIdentityPools/{pool_id}/group/{group_id}`: A workload identity pool group. * `principalSet://iam.googleapis.com/projects/{project_number}/locations/global/workloadIdentityPools/{pool_id}/attribute.{attribute_name}/{attribute_value}`: All identities in a workload identity pool with a certain attribute. * `principalSet://iam.googleapis.com/projects/{project_number}/locations/global/workloadIdentityPools/{pool_id}/*`: All identities in a workload identity pool. * `deleted:user:{emailid}?uid={uniqueid}`: An email address (plus unique identifier) representing a user that has been recently deleted. For example, `alice@example.com?uid=123456789012345678901`. If the user is recovered, this value reverts to `user:{emailid}` and the recovered user retains the role in the binding. * `deleted:serviceAccount:{emailid}?uid={uniqueid}`: An email address (plus unique identifier) representing a service account that has been recently deleted. For example, `my-other-app@appspot.gserviceaccount.com?uid=123456789012345678901`. If the service account is undeleted, this value reverts to `serviceAccount:{emailid}` and the undeleted service account retains the role in the binding. * `deleted:group:{emailid}?uid={uniqueid}`: An email address (plus unique identifier) representing a Google group that has been recently deleted. For example, `admins@example.com?uid=123456789012345678901`. If the group is recovered, this value reverts to `group:{emailid}` and the recovered group retains the role in the binding. * `deleted:principal://iam.googleapis.com/locations/global/workforcePools/{pool_id}/subject/{subject_attribute_value}`: Deleted single identity in a workforce identity pool. For example, `deleted:principal://iam.googleapis.com/locations/global/workforcePools/my-pool-id/subject/my-subject-attribute-value`. "A String", ], - "role": "A String", # Role that is assigned to the list of `members`, or principals. For example, `roles/viewer`, `roles/editor`, or `roles/owner`. + "role": "A String", # Role that is assigned to the list of `members`, or principals. For example, `roles/viewer`, `roles/editor`, or `roles/owner`. For an overview of the IAM roles and permissions, see the [IAM documentation](https://cloud.google.com/iam/docs/roles-overview). For a list of the available pre-defined roles, see [here](https://cloud.google.com/iam/docs/understanding-roles). }, ], "etag": "A String", # `etag` is used for optimistic concurrency control as a way to help prevent simultaneous updates of a policy from overwriting each other. It is strongly suggested that systems make use of the `etag` in the read-modify-write cycle to perform policy updates in order to avoid race conditions: An `etag` is returned in the response to `getIamPolicy`, and systems are expected to put that etag in the request to `setIamPolicy` to ensure that their change will be applied to the same version of the policy. **Important:** If you use IAM Conditions, you must include the `etag` field whenever you call `setIamPolicy`. If you omit this field, then IAM allows you to overwrite a version `3` policy with a version `1` policy, and all of the conditions in the version `3` policy are lost. @@ -985,7 +985,7 @@

Method Details

"members": [ # Specifies the principals requesting access for a Google Cloud resource. `members` can have the following values: * `allUsers`: A special identifier that represents anyone who is on the internet; with or without a Google account. * `allAuthenticatedUsers`: A special identifier that represents anyone who is authenticated with a Google account or a service account. Does not include identities that come from external identity providers (IdPs) through identity federation. * `user:{emailid}`: An email address that represents a specific Google account. For example, `alice@example.com` . * `serviceAccount:{emailid}`: An email address that represents a Google service account. For example, `my-other-app@appspot.gserviceaccount.com`. * `serviceAccount:{projectid}.svc.id.goog[{namespace}/{kubernetes-sa}]`: An identifier for a [Kubernetes service account](https://cloud.google.com/kubernetes-engine/docs/how-to/kubernetes-service-accounts). For example, `my-project.svc.id.goog[my-namespace/my-kubernetes-sa]`. * `group:{emailid}`: An email address that represents a Google group. For example, `admins@example.com`. * `domain:{domain}`: The G Suite domain (primary) that represents all the users of that domain. For example, `google.com` or `example.com`. * `principal://iam.googleapis.com/locations/global/workforcePools/{pool_id}/subject/{subject_attribute_value}`: A single identity in a workforce identity pool. * `principalSet://iam.googleapis.com/locations/global/workforcePools/{pool_id}/group/{group_id}`: All workforce identities in a group. * `principalSet://iam.googleapis.com/locations/global/workforcePools/{pool_id}/attribute.{attribute_name}/{attribute_value}`: All workforce identities with a specific attribute value. * `principalSet://iam.googleapis.com/locations/global/workforcePools/{pool_id}/*`: All identities in a workforce identity pool. * `principal://iam.googleapis.com/projects/{project_number}/locations/global/workloadIdentityPools/{pool_id}/subject/{subject_attribute_value}`: A single identity in a workload identity pool. * `principalSet://iam.googleapis.com/projects/{project_number}/locations/global/workloadIdentityPools/{pool_id}/group/{group_id}`: A workload identity pool group. * `principalSet://iam.googleapis.com/projects/{project_number}/locations/global/workloadIdentityPools/{pool_id}/attribute.{attribute_name}/{attribute_value}`: All identities in a workload identity pool with a certain attribute. * `principalSet://iam.googleapis.com/projects/{project_number}/locations/global/workloadIdentityPools/{pool_id}/*`: All identities in a workload identity pool. * `deleted:user:{emailid}?uid={uniqueid}`: An email address (plus unique identifier) representing a user that has been recently deleted. For example, `alice@example.com?uid=123456789012345678901`. If the user is recovered, this value reverts to `user:{emailid}` and the recovered user retains the role in the binding. * `deleted:serviceAccount:{emailid}?uid={uniqueid}`: An email address (plus unique identifier) representing a service account that has been recently deleted. For example, `my-other-app@appspot.gserviceaccount.com?uid=123456789012345678901`. If the service account is undeleted, this value reverts to `serviceAccount:{emailid}` and the undeleted service account retains the role in the binding. * `deleted:group:{emailid}?uid={uniqueid}`: An email address (plus unique identifier) representing a Google group that has been recently deleted. For example, `admins@example.com?uid=123456789012345678901`. If the group is recovered, this value reverts to `group:{emailid}` and the recovered group retains the role in the binding. * `deleted:principal://iam.googleapis.com/locations/global/workforcePools/{pool_id}/subject/{subject_attribute_value}`: Deleted single identity in a workforce identity pool. For example, `deleted:principal://iam.googleapis.com/locations/global/workforcePools/my-pool-id/subject/my-subject-attribute-value`. "A String", ], - "role": "A String", # Role that is assigned to the list of `members`, or principals. For example, `roles/viewer`, `roles/editor`, or `roles/owner`. + "role": "A String", # Role that is assigned to the list of `members`, or principals. For example, `roles/viewer`, `roles/editor`, or `roles/owner`. For an overview of the IAM roles and permissions, see the [IAM documentation](https://cloud.google.com/iam/docs/roles-overview). For a list of the available pre-defined roles, see [here](https://cloud.google.com/iam/docs/understanding-roles). }, ], "etag": "A String", # `etag` is used for optimistic concurrency control as a way to help prevent simultaneous updates of a policy from overwriting each other. It is strongly suggested that systems make use of the `etag` in the read-modify-write cycle to perform policy updates in order to avoid race conditions: An `etag` is returned in the response to `getIamPolicy`, and systems are expected to put that etag in the request to `setIamPolicy` to ensure that their change will be applied to the same version of the policy. **Important:** If you use IAM Conditions, you must include the `etag` field whenever you call `setIamPolicy`. If you omit this field, then IAM allows you to overwrite a version `3` policy with a version `1` policy, and all of the conditions in the version `3` policy are lost. @@ -1013,7 +1013,7 @@

Method Details

"members": [ # Specifies the principals requesting access for a Google Cloud resource. `members` can have the following values: * `allUsers`: A special identifier that represents anyone who is on the internet; with or without a Google account. * `allAuthenticatedUsers`: A special identifier that represents anyone who is authenticated with a Google account or a service account. Does not include identities that come from external identity providers (IdPs) through identity federation. * `user:{emailid}`: An email address that represents a specific Google account. For example, `alice@example.com` . * `serviceAccount:{emailid}`: An email address that represents a Google service account. For example, `my-other-app@appspot.gserviceaccount.com`. * `serviceAccount:{projectid}.svc.id.goog[{namespace}/{kubernetes-sa}]`: An identifier for a [Kubernetes service account](https://cloud.google.com/kubernetes-engine/docs/how-to/kubernetes-service-accounts). For example, `my-project.svc.id.goog[my-namespace/my-kubernetes-sa]`. * `group:{emailid}`: An email address that represents a Google group. For example, `admins@example.com`. * `domain:{domain}`: The G Suite domain (primary) that represents all the users of that domain. For example, `google.com` or `example.com`. * `principal://iam.googleapis.com/locations/global/workforcePools/{pool_id}/subject/{subject_attribute_value}`: A single identity in a workforce identity pool. * `principalSet://iam.googleapis.com/locations/global/workforcePools/{pool_id}/group/{group_id}`: All workforce identities in a group. * `principalSet://iam.googleapis.com/locations/global/workforcePools/{pool_id}/attribute.{attribute_name}/{attribute_value}`: All workforce identities with a specific attribute value. * `principalSet://iam.googleapis.com/locations/global/workforcePools/{pool_id}/*`: All identities in a workforce identity pool. * `principal://iam.googleapis.com/projects/{project_number}/locations/global/workloadIdentityPools/{pool_id}/subject/{subject_attribute_value}`: A single identity in a workload identity pool. * `principalSet://iam.googleapis.com/projects/{project_number}/locations/global/workloadIdentityPools/{pool_id}/group/{group_id}`: A workload identity pool group. * `principalSet://iam.googleapis.com/projects/{project_number}/locations/global/workloadIdentityPools/{pool_id}/attribute.{attribute_name}/{attribute_value}`: All identities in a workload identity pool with a certain attribute. * `principalSet://iam.googleapis.com/projects/{project_number}/locations/global/workloadIdentityPools/{pool_id}/*`: All identities in a workload identity pool. * `deleted:user:{emailid}?uid={uniqueid}`: An email address (plus unique identifier) representing a user that has been recently deleted. For example, `alice@example.com?uid=123456789012345678901`. If the user is recovered, this value reverts to `user:{emailid}` and the recovered user retains the role in the binding. * `deleted:serviceAccount:{emailid}?uid={uniqueid}`: An email address (plus unique identifier) representing a service account that has been recently deleted. For example, `my-other-app@appspot.gserviceaccount.com?uid=123456789012345678901`. If the service account is undeleted, this value reverts to `serviceAccount:{emailid}` and the undeleted service account retains the role in the binding. * `deleted:group:{emailid}?uid={uniqueid}`: An email address (plus unique identifier) representing a Google group that has been recently deleted. For example, `admins@example.com?uid=123456789012345678901`. If the group is recovered, this value reverts to `group:{emailid}` and the recovered group retains the role in the binding. * `deleted:principal://iam.googleapis.com/locations/global/workforcePools/{pool_id}/subject/{subject_attribute_value}`: Deleted single identity in a workforce identity pool. For example, `deleted:principal://iam.googleapis.com/locations/global/workforcePools/my-pool-id/subject/my-subject-attribute-value`. "A String", ], - "role": "A String", # Role that is assigned to the list of `members`, or principals. For example, `roles/viewer`, `roles/editor`, or `roles/owner`. + "role": "A String", # Role that is assigned to the list of `members`, or principals. For example, `roles/viewer`, `roles/editor`, or `roles/owner`. For an overview of the IAM roles and permissions, see the [IAM documentation](https://cloud.google.com/iam/docs/roles-overview). For a list of the available pre-defined roles, see [here](https://cloud.google.com/iam/docs/understanding-roles). }, ], "etag": "A String", # `etag` is used for optimistic concurrency control as a way to help prevent simultaneous updates of a policy from overwriting each other. It is strongly suggested that systems make use of the `etag` in the read-modify-write cycle to perform policy updates in order to avoid race conditions: An `etag` is returned in the response to `getIamPolicy`, and systems are expected to put that etag in the request to `setIamPolicy` to ensure that their change will be applied to the same version of the policy. **Important:** If you use IAM Conditions, you must include the `etag` field whenever you call `setIamPolicy`. If you omit this field, then IAM allows you to overwrite a version `3` policy with a version `1` policy, and all of the conditions in the version `3` policy are lost. diff --git a/docs/dyn/managedidentities_v1beta1.projects.locations.global_.peerings.html b/docs/dyn/managedidentities_v1beta1.projects.locations.global_.peerings.html index c0b0bdb2d5e..9ce3e367aaa 100644 --- a/docs/dyn/managedidentities_v1beta1.projects.locations.global_.peerings.html +++ b/docs/dyn/managedidentities_v1beta1.projects.locations.global_.peerings.html @@ -252,7 +252,7 @@

Method Details

"members": [ # Specifies the principals requesting access for a Google Cloud resource. `members` can have the following values: * `allUsers`: A special identifier that represents anyone who is on the internet; with or without a Google account. * `allAuthenticatedUsers`: A special identifier that represents anyone who is authenticated with a Google account or a service account. Does not include identities that come from external identity providers (IdPs) through identity federation. * `user:{emailid}`: An email address that represents a specific Google account. For example, `alice@example.com` . * `serviceAccount:{emailid}`: An email address that represents a Google service account. For example, `my-other-app@appspot.gserviceaccount.com`. * `serviceAccount:{projectid}.svc.id.goog[{namespace}/{kubernetes-sa}]`: An identifier for a [Kubernetes service account](https://cloud.google.com/kubernetes-engine/docs/how-to/kubernetes-service-accounts). For example, `my-project.svc.id.goog[my-namespace/my-kubernetes-sa]`. * `group:{emailid}`: An email address that represents a Google group. For example, `admins@example.com`. * `domain:{domain}`: The G Suite domain (primary) that represents all the users of that domain. For example, `google.com` or `example.com`. * `principal://iam.googleapis.com/locations/global/workforcePools/{pool_id}/subject/{subject_attribute_value}`: A single identity in a workforce identity pool. * `principalSet://iam.googleapis.com/locations/global/workforcePools/{pool_id}/group/{group_id}`: All workforce identities in a group. * `principalSet://iam.googleapis.com/locations/global/workforcePools/{pool_id}/attribute.{attribute_name}/{attribute_value}`: All workforce identities with a specific attribute value. * `principalSet://iam.googleapis.com/locations/global/workforcePools/{pool_id}/*`: All identities in a workforce identity pool. * `principal://iam.googleapis.com/projects/{project_number}/locations/global/workloadIdentityPools/{pool_id}/subject/{subject_attribute_value}`: A single identity in a workload identity pool. * `principalSet://iam.googleapis.com/projects/{project_number}/locations/global/workloadIdentityPools/{pool_id}/group/{group_id}`: A workload identity pool group. * `principalSet://iam.googleapis.com/projects/{project_number}/locations/global/workloadIdentityPools/{pool_id}/attribute.{attribute_name}/{attribute_value}`: All identities in a workload identity pool with a certain attribute. * `principalSet://iam.googleapis.com/projects/{project_number}/locations/global/workloadIdentityPools/{pool_id}/*`: All identities in a workload identity pool. * `deleted:user:{emailid}?uid={uniqueid}`: An email address (plus unique identifier) representing a user that has been recently deleted. For example, `alice@example.com?uid=123456789012345678901`. If the user is recovered, this value reverts to `user:{emailid}` and the recovered user retains the role in the binding. * `deleted:serviceAccount:{emailid}?uid={uniqueid}`: An email address (plus unique identifier) representing a service account that has been recently deleted. For example, `my-other-app@appspot.gserviceaccount.com?uid=123456789012345678901`. If the service account is undeleted, this value reverts to `serviceAccount:{emailid}` and the undeleted service account retains the role in the binding. * `deleted:group:{emailid}?uid={uniqueid}`: An email address (plus unique identifier) representing a Google group that has been recently deleted. For example, `admins@example.com?uid=123456789012345678901`. If the group is recovered, this value reverts to `group:{emailid}` and the recovered group retains the role in the binding. * `deleted:principal://iam.googleapis.com/locations/global/workforcePools/{pool_id}/subject/{subject_attribute_value}`: Deleted single identity in a workforce identity pool. For example, `deleted:principal://iam.googleapis.com/locations/global/workforcePools/my-pool-id/subject/my-subject-attribute-value`. "A String", ], - "role": "A String", # Role that is assigned to the list of `members`, or principals. For example, `roles/viewer`, `roles/editor`, or `roles/owner`. + "role": "A String", # Role that is assigned to the list of `members`, or principals. For example, `roles/viewer`, `roles/editor`, or `roles/owner`. For an overview of the IAM roles and permissions, see the [IAM documentation](https://cloud.google.com/iam/docs/roles-overview). For a list of the available pre-defined roles, see [here](https://cloud.google.com/iam/docs/understanding-roles). }, ], "etag": "A String", # `etag` is used for optimistic concurrency control as a way to help prevent simultaneous updates of a policy from overwriting each other. It is strongly suggested that systems make use of the `etag` in the read-modify-write cycle to perform policy updates in order to avoid race conditions: An `etag` is returned in the response to `getIamPolicy`, and systems are expected to put that etag in the request to `setIamPolicy` to ensure that their change will be applied to the same version of the policy. **Important:** If you use IAM Conditions, you must include the `etag` field whenever you call `setIamPolicy`. If you omit this field, then IAM allows you to overwrite a version `3` policy with a version `1` policy, and all of the conditions in the version `3` policy are lost. @@ -388,7 +388,7 @@

Method Details

"members": [ # Specifies the principals requesting access for a Google Cloud resource. `members` can have the following values: * `allUsers`: A special identifier that represents anyone who is on the internet; with or without a Google account. * `allAuthenticatedUsers`: A special identifier that represents anyone who is authenticated with a Google account or a service account. Does not include identities that come from external identity providers (IdPs) through identity federation. * `user:{emailid}`: An email address that represents a specific Google account. For example, `alice@example.com` . * `serviceAccount:{emailid}`: An email address that represents a Google service account. For example, `my-other-app@appspot.gserviceaccount.com`. * `serviceAccount:{projectid}.svc.id.goog[{namespace}/{kubernetes-sa}]`: An identifier for a [Kubernetes service account](https://cloud.google.com/kubernetes-engine/docs/how-to/kubernetes-service-accounts). For example, `my-project.svc.id.goog[my-namespace/my-kubernetes-sa]`. * `group:{emailid}`: An email address that represents a Google group. For example, `admins@example.com`. * `domain:{domain}`: The G Suite domain (primary) that represents all the users of that domain. For example, `google.com` or `example.com`. * `principal://iam.googleapis.com/locations/global/workforcePools/{pool_id}/subject/{subject_attribute_value}`: A single identity in a workforce identity pool. * `principalSet://iam.googleapis.com/locations/global/workforcePools/{pool_id}/group/{group_id}`: All workforce identities in a group. * `principalSet://iam.googleapis.com/locations/global/workforcePools/{pool_id}/attribute.{attribute_name}/{attribute_value}`: All workforce identities with a specific attribute value. * `principalSet://iam.googleapis.com/locations/global/workforcePools/{pool_id}/*`: All identities in a workforce identity pool. * `principal://iam.googleapis.com/projects/{project_number}/locations/global/workloadIdentityPools/{pool_id}/subject/{subject_attribute_value}`: A single identity in a workload identity pool. * `principalSet://iam.googleapis.com/projects/{project_number}/locations/global/workloadIdentityPools/{pool_id}/group/{group_id}`: A workload identity pool group. * `principalSet://iam.googleapis.com/projects/{project_number}/locations/global/workloadIdentityPools/{pool_id}/attribute.{attribute_name}/{attribute_value}`: All identities in a workload identity pool with a certain attribute. * `principalSet://iam.googleapis.com/projects/{project_number}/locations/global/workloadIdentityPools/{pool_id}/*`: All identities in a workload identity pool. * `deleted:user:{emailid}?uid={uniqueid}`: An email address (plus unique identifier) representing a user that has been recently deleted. For example, `alice@example.com?uid=123456789012345678901`. If the user is recovered, this value reverts to `user:{emailid}` and the recovered user retains the role in the binding. * `deleted:serviceAccount:{emailid}?uid={uniqueid}`: An email address (plus unique identifier) representing a service account that has been recently deleted. For example, `my-other-app@appspot.gserviceaccount.com?uid=123456789012345678901`. If the service account is undeleted, this value reverts to `serviceAccount:{emailid}` and the undeleted service account retains the role in the binding. * `deleted:group:{emailid}?uid={uniqueid}`: An email address (plus unique identifier) representing a Google group that has been recently deleted. For example, `admins@example.com?uid=123456789012345678901`. If the group is recovered, this value reverts to `group:{emailid}` and the recovered group retains the role in the binding. * `deleted:principal://iam.googleapis.com/locations/global/workforcePools/{pool_id}/subject/{subject_attribute_value}`: Deleted single identity in a workforce identity pool. For example, `deleted:principal://iam.googleapis.com/locations/global/workforcePools/my-pool-id/subject/my-subject-attribute-value`. "A String", ], - "role": "A String", # Role that is assigned to the list of `members`, or principals. For example, `roles/viewer`, `roles/editor`, or `roles/owner`. + "role": "A String", # Role that is assigned to the list of `members`, or principals. For example, `roles/viewer`, `roles/editor`, or `roles/owner`. For an overview of the IAM roles and permissions, see the [IAM documentation](https://cloud.google.com/iam/docs/roles-overview). For a list of the available pre-defined roles, see [here](https://cloud.google.com/iam/docs/understanding-roles). }, ], "etag": "A String", # `etag` is used for optimistic concurrency control as a way to help prevent simultaneous updates of a policy from overwriting each other. It is strongly suggested that systems make use of the `etag` in the read-modify-write cycle to perform policy updates in order to avoid race conditions: An `etag` is returned in the response to `getIamPolicy`, and systems are expected to put that etag in the request to `setIamPolicy` to ensure that their change will be applied to the same version of the policy. **Important:** If you use IAM Conditions, you must include the `etag` field whenever you call `setIamPolicy`. If you omit this field, then IAM allows you to overwrite a version `3` policy with a version `1` policy, and all of the conditions in the version `3` policy are lost. @@ -416,7 +416,7 @@

Method Details

"members": [ # Specifies the principals requesting access for a Google Cloud resource. `members` can have the following values: * `allUsers`: A special identifier that represents anyone who is on the internet; with or without a Google account. * `allAuthenticatedUsers`: A special identifier that represents anyone who is authenticated with a Google account or a service account. Does not include identities that come from external identity providers (IdPs) through identity federation. * `user:{emailid}`: An email address that represents a specific Google account. For example, `alice@example.com` . * `serviceAccount:{emailid}`: An email address that represents a Google service account. For example, `my-other-app@appspot.gserviceaccount.com`. * `serviceAccount:{projectid}.svc.id.goog[{namespace}/{kubernetes-sa}]`: An identifier for a [Kubernetes service account](https://cloud.google.com/kubernetes-engine/docs/how-to/kubernetes-service-accounts). For example, `my-project.svc.id.goog[my-namespace/my-kubernetes-sa]`. * `group:{emailid}`: An email address that represents a Google group. For example, `admins@example.com`. * `domain:{domain}`: The G Suite domain (primary) that represents all the users of that domain. For example, `google.com` or `example.com`. * `principal://iam.googleapis.com/locations/global/workforcePools/{pool_id}/subject/{subject_attribute_value}`: A single identity in a workforce identity pool. * `principalSet://iam.googleapis.com/locations/global/workforcePools/{pool_id}/group/{group_id}`: All workforce identities in a group. * `principalSet://iam.googleapis.com/locations/global/workforcePools/{pool_id}/attribute.{attribute_name}/{attribute_value}`: All workforce identities with a specific attribute value. * `principalSet://iam.googleapis.com/locations/global/workforcePools/{pool_id}/*`: All identities in a workforce identity pool. * `principal://iam.googleapis.com/projects/{project_number}/locations/global/workloadIdentityPools/{pool_id}/subject/{subject_attribute_value}`: A single identity in a workload identity pool. * `principalSet://iam.googleapis.com/projects/{project_number}/locations/global/workloadIdentityPools/{pool_id}/group/{group_id}`: A workload identity pool group. * `principalSet://iam.googleapis.com/projects/{project_number}/locations/global/workloadIdentityPools/{pool_id}/attribute.{attribute_name}/{attribute_value}`: All identities in a workload identity pool with a certain attribute. * `principalSet://iam.googleapis.com/projects/{project_number}/locations/global/workloadIdentityPools/{pool_id}/*`: All identities in a workload identity pool. * `deleted:user:{emailid}?uid={uniqueid}`: An email address (plus unique identifier) representing a user that has been recently deleted. For example, `alice@example.com?uid=123456789012345678901`. If the user is recovered, this value reverts to `user:{emailid}` and the recovered user retains the role in the binding. * `deleted:serviceAccount:{emailid}?uid={uniqueid}`: An email address (plus unique identifier) representing a service account that has been recently deleted. For example, `my-other-app@appspot.gserviceaccount.com?uid=123456789012345678901`. If the service account is undeleted, this value reverts to `serviceAccount:{emailid}` and the undeleted service account retains the role in the binding. * `deleted:group:{emailid}?uid={uniqueid}`: An email address (plus unique identifier) representing a Google group that has been recently deleted. For example, `admins@example.com?uid=123456789012345678901`. If the group is recovered, this value reverts to `group:{emailid}` and the recovered group retains the role in the binding. * `deleted:principal://iam.googleapis.com/locations/global/workforcePools/{pool_id}/subject/{subject_attribute_value}`: Deleted single identity in a workforce identity pool. For example, `deleted:principal://iam.googleapis.com/locations/global/workforcePools/my-pool-id/subject/my-subject-attribute-value`. "A String", ], - "role": "A String", # Role that is assigned to the list of `members`, or principals. For example, `roles/viewer`, `roles/editor`, or `roles/owner`. + "role": "A String", # Role that is assigned to the list of `members`, or principals. For example, `roles/viewer`, `roles/editor`, or `roles/owner`. For an overview of the IAM roles and permissions, see the [IAM documentation](https://cloud.google.com/iam/docs/roles-overview). For a list of the available pre-defined roles, see [here](https://cloud.google.com/iam/docs/understanding-roles). }, ], "etag": "A String", # `etag` is used for optimistic concurrency control as a way to help prevent simultaneous updates of a policy from overwriting each other. It is strongly suggested that systems make use of the `etag` in the read-modify-write cycle to perform policy updates in order to avoid race conditions: An `etag` is returned in the response to `getIamPolicy`, and systems are expected to put that etag in the request to `setIamPolicy` to ensure that their change will be applied to the same version of the policy. **Important:** If you use IAM Conditions, you must include the `etag` field whenever you call `setIamPolicy`. If you omit this field, then IAM allows you to overwrite a version `3` policy with a version `1` policy, and all of the conditions in the version `3` policy are lost. diff --git a/docs/dyn/memcache_v1.projects.locations.instances.html b/docs/dyn/memcache_v1.projects.locations.instances.html index 587be624dc5..0bb8428c1e6 100644 --- a/docs/dyn/memcache_v1.projects.locations.instances.html +++ b/docs/dyn/memcache_v1.projects.locations.instances.html @@ -237,6 +237,8 @@

Method Details

"reservedIpRangeId": [ # Optional. Contains the id of allocated IP address ranges associated with the private service access connection for example, "test-default" associated with IP range 10.0.0.0/29. "A String", ], + "satisfiesPzi": True or False, # Optional. Output only. Reserved for future use. + "satisfiesPzs": True or False, # Optional. Output only. Reserved for future use. "state": "A String", # Output only. The state of this Memcached instance. "updateTime": "A String", # Output only. The time the instance was updated. "zones": [ # Zones in which Memcached nodes should be provisioned. Memcached nodes will be equally distributed across these zones. If not provided, the service will by default create nodes in all zones in the region for the instance. @@ -393,6 +395,8 @@

Method Details

"reservedIpRangeId": [ # Optional. Contains the id of allocated IP address ranges associated with the private service access connection for example, "test-default" associated with IP range 10.0.0.0/29. "A String", ], + "satisfiesPzi": True or False, # Optional. Output only. Reserved for future use. + "satisfiesPzs": True or False, # Optional. Output only. Reserved for future use. "state": "A String", # Output only. The state of this Memcached instance. "updateTime": "A String", # Output only. The time the instance was updated. "zones": [ # Zones in which Memcached nodes should be provisioned. Memcached nodes will be equally distributed across these zones. If not provided, the service will by default create nodes in all zones in the region for the instance. @@ -491,6 +495,8 @@

Method Details

"reservedIpRangeId": [ # Optional. Contains the id of allocated IP address ranges associated with the private service access connection for example, "test-default" associated with IP range 10.0.0.0/29. "A String", ], + "satisfiesPzi": True or False, # Optional. Output only. Reserved for future use. + "satisfiesPzs": True or False, # Optional. Output only. Reserved for future use. "state": "A String", # Output only. The state of this Memcached instance. "updateTime": "A String", # Output only. The time the instance was updated. "zones": [ # Zones in which Memcached nodes should be provisioned. Memcached nodes will be equally distributed across these zones. If not provided, the service will by default create nodes in all zones in the region for the instance. @@ -598,6 +604,8 @@

Method Details

"reservedIpRangeId": [ # Optional. Contains the id of allocated IP address ranges associated with the private service access connection for example, "test-default" associated with IP range 10.0.0.0/29. "A String", ], + "satisfiesPzi": True or False, # Optional. Output only. Reserved for future use. + "satisfiesPzs": True or False, # Optional. Output only. Reserved for future use. "state": "A String", # Output only. The state of this Memcached instance. "updateTime": "A String", # Output only. The time the instance was updated. "zones": [ # Zones in which Memcached nodes should be provisioned. Memcached nodes will be equally distributed across these zones. If not provided, the service will by default create nodes in all zones in the region for the instance. diff --git a/docs/dyn/memcache_v1beta2.projects.locations.instances.html b/docs/dyn/memcache_v1beta2.projects.locations.instances.html index ad4357db002..781c7633573 100644 --- a/docs/dyn/memcache_v1beta2.projects.locations.instances.html +++ b/docs/dyn/memcache_v1beta2.projects.locations.instances.html @@ -286,6 +286,8 @@

Method Details

"reservedIpRangeId": [ # Optional. Contains the id of allocated IP address ranges associated with the private service access connection for example, "test-default" associated with IP range 10.0.0.0/29. "A String", ], + "satisfiesPzi": True or False, # Optional. Output only. Reserved for future use. + "satisfiesPzs": True or False, # Optional. Output only. Reserved for future use. "state": "A String", # Output only. The state of this Memcached instance. "updateAvailable": True or False, # Output only. Returns true if there is an update waiting to be applied "updateTime": "A String", # Output only. The time the instance was updated. @@ -444,6 +446,8 @@

Method Details

"reservedIpRangeId": [ # Optional. Contains the id of allocated IP address ranges associated with the private service access connection for example, "test-default" associated with IP range 10.0.0.0/29. "A String", ], + "satisfiesPzi": True or False, # Optional. Output only. Reserved for future use. + "satisfiesPzs": True or False, # Optional. Output only. Reserved for future use. "state": "A String", # Output only. The state of this Memcached instance. "updateAvailable": True or False, # Output only. Returns true if there is an update waiting to be applied "updateTime": "A String", # Output only. The time the instance was updated. @@ -545,6 +549,8 @@

Method Details

"reservedIpRangeId": [ # Optional. Contains the id of allocated IP address ranges associated with the private service access connection for example, "test-default" associated with IP range 10.0.0.0/29. "A String", ], + "satisfiesPzi": True or False, # Optional. Output only. Reserved for future use. + "satisfiesPzs": True or False, # Optional. Output only. Reserved for future use. "state": "A String", # Output only. The state of this Memcached instance. "updateAvailable": True or False, # Output only. Returns true if there is an update waiting to be applied "updateTime": "A String", # Output only. The time the instance was updated. @@ -653,6 +659,8 @@

Method Details

"reservedIpRangeId": [ # Optional. Contains the id of allocated IP address ranges associated with the private service access connection for example, "test-default" associated with IP range 10.0.0.0/29. "A String", ], + "satisfiesPzi": True or False, # Optional. Output only. Reserved for future use. + "satisfiesPzs": True or False, # Optional. Output only. Reserved for future use. "state": "A String", # Output only. The state of this Memcached instance. "updateAvailable": True or False, # Output only. Returns true if there is an update waiting to be applied "updateTime": "A String", # Output only. The time the instance was updated. diff --git a/docs/dyn/monitoring_v3.projects.snoozes.html b/docs/dyn/monitoring_v3.projects.snoozes.html index 440e8417760..aad617bd49b 100644 --- a/docs/dyn/monitoring_v3.projects.snoozes.html +++ b/docs/dyn/monitoring_v3.projects.snoozes.html @@ -118,7 +118,7 @@

Method Details

"endTime": "A String", # Required. The end of the time interval. "startTime": "A String", # Optional. The beginning of the time interval. The default value for the start time is the end time. The start time must not be later than the end time. }, - "name": "A String", # Required. The name of the Snooze. The format is: projects/[PROJECT_ID_OR_NUMBER]/snoozes/[SNOOZE_ID] The ID of the Snooze will be generated by the system. + "name": "A String", # Required. Identifier. The name of the Snooze. The format is: projects/[PROJECT_ID_OR_NUMBER]/snoozes/[SNOOZE_ID] The ID of the Snooze will be generated by the system. } x__xgafv: string, V1 error format. @@ -140,7 +140,7 @@

Method Details

"endTime": "A String", # Required. The end of the time interval. "startTime": "A String", # Optional. The beginning of the time interval. The default value for the start time is the end time. The start time must not be later than the end time. }, - "name": "A String", # Required. The name of the Snooze. The format is: projects/[PROJECT_ID_OR_NUMBER]/snoozes/[SNOOZE_ID] The ID of the Snooze will be generated by the system. + "name": "A String", # Required. Identifier. The name of the Snooze. The format is: projects/[PROJECT_ID_OR_NUMBER]/snoozes/[SNOOZE_ID] The ID of the Snooze will be generated by the system. }
@@ -169,7 +169,7 @@

Method Details

"endTime": "A String", # Required. The end of the time interval. "startTime": "A String", # Optional. The beginning of the time interval. The default value for the start time is the end time. The start time must not be later than the end time. }, - "name": "A String", # Required. The name of the Snooze. The format is: projects/[PROJECT_ID_OR_NUMBER]/snoozes/[SNOOZE_ID] The ID of the Snooze will be generated by the system. + "name": "A String", # Required. Identifier. The name of the Snooze. The format is: projects/[PROJECT_ID_OR_NUMBER]/snoozes/[SNOOZE_ID] The ID of the Snooze will be generated by the system. }
@@ -204,7 +204,7 @@

Method Details

"endTime": "A String", # Required. The end of the time interval. "startTime": "A String", # Optional. The beginning of the time interval. The default value for the start time is the end time. The start time must not be later than the end time. }, - "name": "A String", # Required. The name of the Snooze. The format is: projects/[PROJECT_ID_OR_NUMBER]/snoozes/[SNOOZE_ID] The ID of the Snooze will be generated by the system. + "name": "A String", # Required. Identifier. The name of the Snooze. The format is: projects/[PROJECT_ID_OR_NUMBER]/snoozes/[SNOOZE_ID] The ID of the Snooze will be generated by the system. }, ], }
@@ -229,7 +229,7 @@

Method Details

Updates a Snooze, identified by its name, with the parameters in the given Snooze object.
 
 Args:
-  name: string, Required. The name of the Snooze. The format is: projects/[PROJECT_ID_OR_NUMBER]/snoozes/[SNOOZE_ID] The ID of the Snooze will be generated by the system. (required)
+  name: string, Required. Identifier. The name of the Snooze. The format is: projects/[PROJECT_ID_OR_NUMBER]/snoozes/[SNOOZE_ID] The ID of the Snooze will be generated by the system. (required)
   body: object, The request body.
     The object takes the form of:
 
@@ -244,7 +244,7 @@ 

Method Details

"endTime": "A String", # Required. The end of the time interval. "startTime": "A String", # Optional. The beginning of the time interval. The default value for the start time is the end time. The start time must not be later than the end time. }, - "name": "A String", # Required. The name of the Snooze. The format is: projects/[PROJECT_ID_OR_NUMBER]/snoozes/[SNOOZE_ID] The ID of the Snooze will be generated by the system. + "name": "A String", # Required. Identifier. The name of the Snooze. The format is: projects/[PROJECT_ID_OR_NUMBER]/snoozes/[SNOOZE_ID] The ID of the Snooze will be generated by the system. } updateMask: string, Required. The fields to update.For each field listed in update_mask: If the Snooze object supplied in the UpdateSnoozeRequest has a value for that field, the value of the field in the existing Snooze will be set to the value of the field in the supplied Snooze. If the field does not have a value in the supplied Snooze, the field in the existing Snooze is set to its default value.Fields not listed retain their existing value.The following are the field names that are accepted in update_mask: display_name interval.start_time interval.end_timeThat said, the start time and end time of the Snooze determines which fields can legally be updated. Before attempting an update, users should consult the documentation for UpdateSnoozeRequest, which talks about which fields can be updated. @@ -267,7 +267,7 @@

Method Details

"endTime": "A String", # Required. The end of the time interval. "startTime": "A String", # Optional. The beginning of the time interval. The default value for the start time is the end time. The start time must not be later than the end time. }, - "name": "A String", # Required. The name of the Snooze. The format is: projects/[PROJECT_ID_OR_NUMBER]/snoozes/[SNOOZE_ID] The ID of the Snooze will be generated by the system. + "name": "A String", # Required. Identifier. The name of the Snooze. The format is: projects/[PROJECT_ID_OR_NUMBER]/snoozes/[SNOOZE_ID] The ID of the Snooze will be generated by the system. }
diff --git a/docs/dyn/networkconnectivity_v1.projects.locations.global_.hubs.html b/docs/dyn/networkconnectivity_v1.projects.locations.global_.hubs.html index 44f90ba2503..443e9404934 100644 --- a/docs/dyn/networkconnectivity_v1.projects.locations.global_.hubs.html +++ b/docs/dyn/networkconnectivity_v1.projects.locations.global_.hubs.html @@ -529,6 +529,9 @@

Method Details

"excludeExportRanges": [ # Optional. IP ranges encompassing the subnets to be excluded from peering. "A String", ], + "includeExportRanges": [ # Optional. IP ranges allowed to be included from peering. + "A String", + ], "uri": "A String", # Required. The URI of the VPC network resource. }, "linkedVpnTunnels": { # A collection of Cloud VPN tunnel resources. These resources should be redundant HA VPN tunnels that all advertise the same prefixes to Google Cloud. Alternatively, in a passive/active configuration, all tunnels should be capable of advertising the same prefixes. # VPN tunnels that are associated with the spoke. diff --git a/docs/dyn/networkconnectivity_v1.projects.locations.spokes.html b/docs/dyn/networkconnectivity_v1.projects.locations.spokes.html index 31ee32ee7ce..804f184832f 100644 --- a/docs/dyn/networkconnectivity_v1.projects.locations.spokes.html +++ b/docs/dyn/networkconnectivity_v1.projects.locations.spokes.html @@ -148,6 +148,9 @@

Method Details

"excludeExportRanges": [ # Optional. IP ranges encompassing the subnets to be excluded from peering. "A String", ], + "includeExportRanges": [ # Optional. IP ranges allowed to be included from peering. + "A String", + ], "uri": "A String", # Required. The URI of the VPC network resource. }, "linkedVpnTunnels": { # A collection of Cloud VPN tunnel resources. These resources should be redundant HA VPN tunnels that all advertise the same prefixes to Google Cloud. Alternatively, in a passive/active configuration, all tunnels should be capable of advertising the same prefixes. # VPN tunnels that are associated with the spoke. @@ -281,6 +284,9 @@

Method Details

"excludeExportRanges": [ # Optional. IP ranges encompassing the subnets to be excluded from peering. "A String", ], + "includeExportRanges": [ # Optional. IP ranges allowed to be included from peering. + "A String", + ], "uri": "A String", # Required. The URI of the VPC network resource. }, "linkedVpnTunnels": { # A collection of Cloud VPN tunnel resources. These resources should be redundant HA VPN tunnels that all advertise the same prefixes to Google Cloud. Alternatively, in a passive/active configuration, all tunnels should be capable of advertising the same prefixes. # VPN tunnels that are associated with the spoke. @@ -403,6 +409,9 @@

Method Details

"excludeExportRanges": [ # Optional. IP ranges encompassing the subnets to be excluded from peering. "A String", ], + "includeExportRanges": [ # Optional. IP ranges allowed to be included from peering. + "A String", + ], "uri": "A String", # Required. The URI of the VPC network resource. }, "linkedVpnTunnels": { # A collection of Cloud VPN tunnel resources. These resources should be redundant HA VPN tunnels that all advertise the same prefixes to Google Cloud. Alternatively, in a passive/active configuration, all tunnels should be capable of advertising the same prefixes. # VPN tunnels that are associated with the spoke. @@ -484,6 +493,9 @@

Method Details

"excludeExportRanges": [ # Optional. IP ranges encompassing the subnets to be excluded from peering. "A String", ], + "includeExportRanges": [ # Optional. IP ranges allowed to be included from peering. + "A String", + ], "uri": "A String", # Required. The URI of the VPC network resource. }, "linkedVpnTunnels": { # A collection of Cloud VPN tunnel resources. These resources should be redundant HA VPN tunnels that all advertise the same prefixes to Google Cloud. Alternatively, in a passive/active configuration, all tunnels should be capable of advertising the same prefixes. # VPN tunnels that are associated with the spoke. diff --git a/docs/dyn/notebooks_v2.projects.locations.instances.html b/docs/dyn/notebooks_v2.projects.locations.instances.html index e85fc174aa8..1165cae6bb4 100644 --- a/docs/dyn/notebooks_v2.projects.locations.instances.html +++ b/docs/dyn/notebooks_v2.projects.locations.instances.html @@ -215,6 +215,11 @@

Method Details

}, "networkInterfaces": [ # Optional. The network interfaces for the VM. Supports only one interface. { # The definition of a network interface resource attached to a VM. + "accessConfigs": [ # Optional. An array of configurations for this interface. Currently, only one access config, ONE_TO_ONE_NAT, is supported. If no accessConfigs specified, the instance will have an external internet access through an ephemeral external IP address. + { # An access configuration attached to an instance's network interface. + "externalIp": "A String", # An external IP address associated with this instance. Specify an unused static external IP address available to the project or leave this field undefined to use an IP from a shared ephemeral IP address pool. If you specify a static external IP address, it must live in the same region as the zone of the instance. + }, + ], "network": "A String", # Optional. The name of the VPC that this VM instance is in. Format: `projects/{project_id}/global/networks/{network_id}` "nicType": "A String", # Optional. The type of vNIC to be used on this interface. This may be gVNIC or VirtioNet. "subnet": "A String", # Optional. The name of the subnet that this VM instance is in. Format: `projects/{project_id}/regions/{region}/subnetworks/{subnetwork_id}` @@ -255,6 +260,8 @@

Method Details

}, "name": "A String", # Output only. The name of this notebook instance. Format: `projects/{project_id}/locations/{location}/instances/{instance_id}` "proxyUri": "A String", # Output only. The proxy endpoint that is used to access the Jupyter notebook. + "satisfiesPzi": True or False, # Output only. Reserved for future use for Zone Isolation. + "satisfiesPzs": True or False, # Output only. Reserved for future use for Zone Separation. "state": "A String", # Output only. The state of this instance. "thirdPartyProxyUrl": "A String", # Output only. The workforce pools proxy endpoint that is used to access the Jupyter notebook. "updateTime": "A String", # Output only. Instance update time. @@ -444,6 +451,11 @@

Method Details

}, "networkInterfaces": [ # Optional. The network interfaces for the VM. Supports only one interface. { # The definition of a network interface resource attached to a VM. + "accessConfigs": [ # Optional. An array of configurations for this interface. Currently, only one access config, ONE_TO_ONE_NAT, is supported. If no accessConfigs specified, the instance will have an external internet access through an ephemeral external IP address. + { # An access configuration attached to an instance's network interface. + "externalIp": "A String", # An external IP address associated with this instance. Specify an unused static external IP address available to the project or leave this field undefined to use an IP from a shared ephemeral IP address pool. If you specify a static external IP address, it must live in the same region as the zone of the instance. + }, + ], "network": "A String", # Optional. The name of the VPC that this VM instance is in. Format: `projects/{project_id}/global/networks/{network_id}` "nicType": "A String", # Optional. The type of vNIC to be used on this interface. This may be gVNIC or VirtioNet. "subnet": "A String", # Optional. The name of the subnet that this VM instance is in. Format: `projects/{project_id}/regions/{region}/subnetworks/{subnetwork_id}` @@ -484,6 +496,8 @@

Method Details

}, "name": "A String", # Output only. The name of this notebook instance. Format: `projects/{project_id}/locations/{location}/instances/{instance_id}` "proxyUri": "A String", # Output only. The proxy endpoint that is used to access the Jupyter notebook. + "satisfiesPzi": True or False, # Output only. Reserved for future use for Zone Isolation. + "satisfiesPzs": True or False, # Output only. Reserved for future use for Zone Separation. "state": "A String", # Output only. The state of this instance. "thirdPartyProxyUrl": "A String", # Output only. The workforce pools proxy endpoint that is used to access the Jupyter notebook. "updateTime": "A String", # Output only. Instance update time. @@ -634,6 +648,11 @@

Method Details

}, "networkInterfaces": [ # Optional. The network interfaces for the VM. Supports only one interface. { # The definition of a network interface resource attached to a VM. + "accessConfigs": [ # Optional. An array of configurations for this interface. Currently, only one access config, ONE_TO_ONE_NAT, is supported. If no accessConfigs specified, the instance will have an external internet access through an ephemeral external IP address. + { # An access configuration attached to an instance's network interface. + "externalIp": "A String", # An external IP address associated with this instance. Specify an unused static external IP address available to the project or leave this field undefined to use an IP from a shared ephemeral IP address pool. If you specify a static external IP address, it must live in the same region as the zone of the instance. + }, + ], "network": "A String", # Optional. The name of the VPC that this VM instance is in. Format: `projects/{project_id}/global/networks/{network_id}` "nicType": "A String", # Optional. The type of vNIC to be used on this interface. This may be gVNIC or VirtioNet. "subnet": "A String", # Optional. The name of the subnet that this VM instance is in. Format: `projects/{project_id}/regions/{region}/subnetworks/{subnetwork_id}` @@ -674,6 +693,8 @@

Method Details

}, "name": "A String", # Output only. The name of this notebook instance. Format: `projects/{project_id}/locations/{location}/instances/{instance_id}` "proxyUri": "A String", # Output only. The proxy endpoint that is used to access the Jupyter notebook. + "satisfiesPzi": True or False, # Output only. Reserved for future use for Zone Isolation. + "satisfiesPzs": True or False, # Output only. Reserved for future use for Zone Separation. "state": "A String", # Output only. The state of this instance. "thirdPartyProxyUrl": "A String", # Output only. The workforce pools proxy endpoint that is used to access the Jupyter notebook. "updateTime": "A String", # Output only. Instance update time. @@ -763,6 +784,11 @@

Method Details

}, "networkInterfaces": [ # Optional. The network interfaces for the VM. Supports only one interface. { # The definition of a network interface resource attached to a VM. + "accessConfigs": [ # Optional. An array of configurations for this interface. Currently, only one access config, ONE_TO_ONE_NAT, is supported. If no accessConfigs specified, the instance will have an external internet access through an ephemeral external IP address. + { # An access configuration attached to an instance's network interface. + "externalIp": "A String", # An external IP address associated with this instance. Specify an unused static external IP address available to the project or leave this field undefined to use an IP from a shared ephemeral IP address pool. If you specify a static external IP address, it must live in the same region as the zone of the instance. + }, + ], "network": "A String", # Optional. The name of the VPC that this VM instance is in. Format: `projects/{project_id}/global/networks/{network_id}` "nicType": "A String", # Optional. The type of vNIC to be used on this interface. This may be gVNIC or VirtioNet. "subnet": "A String", # Optional. The name of the subnet that this VM instance is in. Format: `projects/{project_id}/regions/{region}/subnetworks/{subnetwork_id}` @@ -803,6 +829,8 @@

Method Details

}, "name": "A String", # Output only. The name of this notebook instance. Format: `projects/{project_id}/locations/{location}/instances/{instance_id}` "proxyUri": "A String", # Output only. The proxy endpoint that is used to access the Jupyter notebook. + "satisfiesPzi": True or False, # Output only. Reserved for future use for Zone Isolation. + "satisfiesPzs": True or False, # Output only. Reserved for future use for Zone Separation. "state": "A String", # Output only. The state of this instance. "thirdPartyProxyUrl": "A String", # Output only. The workforce pools proxy endpoint that is used to access the Jupyter notebook. "updateTime": "A String", # Output only. Instance update time. diff --git a/docs/dyn/osconfig_v1.projects.locations.instances.osPolicyAssignments.reports.html b/docs/dyn/osconfig_v1.projects.locations.instances.osPolicyAssignments.reports.html index 64c8d081e30..a596d6b99c9 100644 --- a/docs/dyn/osconfig_v1.projects.locations.instances.osPolicyAssignments.reports.html +++ b/docs/dyn/osconfig_v1.projects.locations.instances.osPolicyAssignments.reports.html @@ -114,12 +114,12 @@

Method Details

"osPolicyCompliances": [ # Compliance data for each `OSPolicy` that is applied to the VM. { # Compliance data for an OS policy "complianceState": "A String", # The compliance state of the OS policy. - "complianceStateReason": "A String", # The reason for the OS policy to be in an unknown compliance state. This field is always populated when `compliance_state` is `UNKNOWN`. If populated, the field can contain one of the following values: * `vm-not-running`: The VM was not running. * `os-policies-not-supported-by-agent`: The version of the OS Config agent running on the VM does not support running OS policies. * `no-agent-detected`: The OS Config agent is not detected for the VM. * `resource-execution-errors`: The OS Config agent encountered errors while executing one or more resources in the policy. See `os_policy_resource_compliances` for details. * `task-timeout`: The task sent to the agent to apply the policy timed out. * `unexpected-agent-state`: The OS Config agent did not report the final status of the task that attempted to apply the policy. Instead, the agent unexpectedly started working on a different task. This mostly happens when the agent or VM unexpectedly restarts while applying OS policies. * `internal-service-errors`: Internal service errors were encountered while attempting to apply the policy. + "complianceStateReason": "A String", # The reason for the OS policy to be in an unknown compliance state. This field is always populated when `compliance_state` is `UNKNOWN`. If populated, the field can contain one of the following values: * `vm-not-running`: The VM was not running. * `os-policies-not-supported-by-agent`: The version of the OS Config agent running on the VM does not support running OS policies. * `no-agent-detected`: The OS Config agent is not detected for the VM. * `resource-execution-errors`: The OS Config agent encountered errors while executing one or more resources in the policy. See `os_policy_resource_compliances` for details. * `task-timeout`: The task sent to the agent to apply the policy timed out. * `unexpected-agent-state`: The OS Config agent did not report the final status of the task that attempted to apply the policy. Instead, the agent unexpectedly started working on a different task. This mostly happens when the agent or VM unexpectedly restarts while applying OS policies. * `internal-service-errors`: Internal service errors were encountered while attempting to apply the policy. * `os-policy-execution-pending`: OS policy was assigned to the given VM, but was not executed yet. Typically this is a transient condition that will go away after the next policy execution cycle. "osPolicyId": "A String", # The OS policy id "osPolicyResourceCompliances": [ # Compliance data for each resource within the policy that is applied to the VM. { # Compliance data for an OS policy resource. "complianceState": "A String", # The compliance state of the resource. - "complianceStateReason": "A String", # A reason for the resource to be in the given compliance state. This field is always populated when `compliance_state` is `UNKNOWN`. The following values are supported when `compliance_state == UNKNOWN` * `execution-errors`: Errors were encountered by the agent while executing the resource and the compliance state couldn't be determined. * `execution-skipped-by-agent`: Resource execution was skipped by the agent because errors were encountered while executing prior resources in the OS policy. * `os-policy-execution-attempt-failed`: The execution of the OS policy containing this resource failed and the compliance state couldn't be determined. + "complianceStateReason": "A String", # A reason for the resource to be in the given compliance state. This field is always populated when `compliance_state` is `UNKNOWN`. The following values are supported when `compliance_state == UNKNOWN` * `execution-errors`: Errors were encountered by the agent while executing the resource and the compliance state couldn't be determined. * `execution-skipped-by-agent`: Resource execution was skipped by the agent because errors were encountered while executing prior resources in the OS policy. * `os-policy-execution-attempt-failed`: The execution of the OS policy containing this resource failed and the compliance state couldn't be determined. * `os-policy-execution-pending`: OS policy that owns this resource was assigned to the given VM, but was not executed yet. "configSteps": [ # Ordered list of configuration completed by the agent for the OS policy resource. { # Step performed by the OS Config agent for configuring an `OSPolicy` resource to its desired state. "errorMessage": "A String", # An error message recorded during the execution of this step. Only populated if errors were encountered during this step execution. @@ -166,12 +166,12 @@

Method Details

"osPolicyCompliances": [ # Compliance data for each `OSPolicy` that is applied to the VM. { # Compliance data for an OS policy "complianceState": "A String", # The compliance state of the OS policy. - "complianceStateReason": "A String", # The reason for the OS policy to be in an unknown compliance state. This field is always populated when `compliance_state` is `UNKNOWN`. If populated, the field can contain one of the following values: * `vm-not-running`: The VM was not running. * `os-policies-not-supported-by-agent`: The version of the OS Config agent running on the VM does not support running OS policies. * `no-agent-detected`: The OS Config agent is not detected for the VM. * `resource-execution-errors`: The OS Config agent encountered errors while executing one or more resources in the policy. See `os_policy_resource_compliances` for details. * `task-timeout`: The task sent to the agent to apply the policy timed out. * `unexpected-agent-state`: The OS Config agent did not report the final status of the task that attempted to apply the policy. Instead, the agent unexpectedly started working on a different task. This mostly happens when the agent or VM unexpectedly restarts while applying OS policies. * `internal-service-errors`: Internal service errors were encountered while attempting to apply the policy. + "complianceStateReason": "A String", # The reason for the OS policy to be in an unknown compliance state. This field is always populated when `compliance_state` is `UNKNOWN`. If populated, the field can contain one of the following values: * `vm-not-running`: The VM was not running. * `os-policies-not-supported-by-agent`: The version of the OS Config agent running on the VM does not support running OS policies. * `no-agent-detected`: The OS Config agent is not detected for the VM. * `resource-execution-errors`: The OS Config agent encountered errors while executing one or more resources in the policy. See `os_policy_resource_compliances` for details. * `task-timeout`: The task sent to the agent to apply the policy timed out. * `unexpected-agent-state`: The OS Config agent did not report the final status of the task that attempted to apply the policy. Instead, the agent unexpectedly started working on a different task. This mostly happens when the agent or VM unexpectedly restarts while applying OS policies. * `internal-service-errors`: Internal service errors were encountered while attempting to apply the policy. * `os-policy-execution-pending`: OS policy was assigned to the given VM, but was not executed yet. Typically this is a transient condition that will go away after the next policy execution cycle. "osPolicyId": "A String", # The OS policy id "osPolicyResourceCompliances": [ # Compliance data for each resource within the policy that is applied to the VM. { # Compliance data for an OS policy resource. "complianceState": "A String", # The compliance state of the resource. - "complianceStateReason": "A String", # A reason for the resource to be in the given compliance state. This field is always populated when `compliance_state` is `UNKNOWN`. The following values are supported when `compliance_state == UNKNOWN` * `execution-errors`: Errors were encountered by the agent while executing the resource and the compliance state couldn't be determined. * `execution-skipped-by-agent`: Resource execution was skipped by the agent because errors were encountered while executing prior resources in the OS policy. * `os-policy-execution-attempt-failed`: The execution of the OS policy containing this resource failed and the compliance state couldn't be determined. + "complianceStateReason": "A String", # A reason for the resource to be in the given compliance state. This field is always populated when `compliance_state` is `UNKNOWN`. The following values are supported when `compliance_state == UNKNOWN` * `execution-errors`: Errors were encountered by the agent while executing the resource and the compliance state couldn't be determined. * `execution-skipped-by-agent`: Resource execution was skipped by the agent because errors were encountered while executing prior resources in the OS policy. * `os-policy-execution-attempt-failed`: The execution of the OS policy containing this resource failed and the compliance state couldn't be determined. * `os-policy-execution-pending`: OS policy that owns this resource was assigned to the given VM, but was not executed yet. "configSteps": [ # Ordered list of configuration completed by the agent for the OS policy resource. { # Step performed by the OS Config agent for configuring an `OSPolicy` resource to its desired state. "errorMessage": "A String", # An error message recorded during the execution of this step. Only populated if errors were encountered during this step execution. diff --git a/docs/dyn/osconfig_v1alpha.projects.locations.instances.osPolicyAssignments.reports.html b/docs/dyn/osconfig_v1alpha.projects.locations.instances.osPolicyAssignments.reports.html index 9ef46505bb2..59cdabfdb67 100644 --- a/docs/dyn/osconfig_v1alpha.projects.locations.instances.osPolicyAssignments.reports.html +++ b/docs/dyn/osconfig_v1alpha.projects.locations.instances.osPolicyAssignments.reports.html @@ -114,12 +114,12 @@

Method Details

"osPolicyCompliances": [ # Compliance data for each `OSPolicy` that is applied to the VM. { # Compliance data for an OS policy "complianceState": "A String", # The compliance state of the OS policy. - "complianceStateReason": "A String", # The reason for the OS policy to be in an unknown compliance state. This field is always populated when `compliance_state` is `UNKNOWN`. If populated, the field can contain one of the following values: * `vm-not-running`: The VM was not running. * `os-policies-not-supported-by-agent`: The version of the OS Config agent running on the VM does not support running OS policies. * `no-agent-detected`: The OS Config agent is not detected for the VM. * `resource-execution-errors`: The OS Config agent encountered errors while executing one or more resources in the policy. See `os_policy_resource_compliances` for details. * `task-timeout`: The task sent to the agent to apply the policy timed out. * `unexpected-agent-state`: The OS Config agent did not report the final status of the task that attempted to apply the policy. Instead, the agent unexpectedly started working on a different task. This mostly happens when the agent or VM unexpectedly restarts while applying OS policies. * `internal-service-errors`: Internal service errors were encountered while attempting to apply the policy. + "complianceStateReason": "A String", # The reason for the OS policy to be in an unknown compliance state. This field is always populated when `compliance_state` is `UNKNOWN`. If populated, the field can contain one of the following values: * `vm-not-running`: The VM was not running. * `os-policies-not-supported-by-agent`: The version of the OS Config agent running on the VM does not support running OS policies. * `no-agent-detected`: The OS Config agent is not detected for the VM. * `resource-execution-errors`: The OS Config agent encountered errors while executing one or more resources in the policy. See `os_policy_resource_compliances` for details. * `task-timeout`: The task sent to the agent to apply the policy timed out. * `unexpected-agent-state`: The OS Config agent did not report the final status of the task that attempted to apply the policy. Instead, the agent unexpectedly started working on a different task. This mostly happens when the agent or VM unexpectedly restarts while applying OS policies. * `internal-service-errors`: Internal service errors were encountered while attempting to apply the policy. * `os-policy-execution-pending`: OS policy was assigned to the given VM, but was not executed yet. Typically this is a transient condition that will go away after the next policy execution cycle. "osPolicyId": "A String", # The OS policy id "osPolicyResourceCompliances": [ # Compliance data for each resource within the policy that is applied to the VM. { # Compliance data for an OS policy resource. "complianceState": "A String", # The compliance state of the resource. - "complianceStateReason": "A String", # A reason for the resource to be in the given compliance state. This field is always populated when `compliance_state` is `UNKNOWN`. The following values are supported when `compliance_state == UNKNOWN` * `execution-errors`: Errors were encountered by the agent while executing the resource and the compliance state couldn't be determined. * `execution-skipped-by-agent`: Resource execution was skipped by the agent because errors were encountered while executing prior resources in the OS policy. * `os-policy-execution-attempt-failed`: The execution of the OS policy containing this resource failed and the compliance state couldn't be determined. + "complianceStateReason": "A String", # A reason for the resource to be in the given compliance state. This field is always populated when `compliance_state` is `UNKNOWN`. The following values are supported when `compliance_state == UNKNOWN` * `execution-errors`: Errors were encountered by the agent while executing the resource and the compliance state couldn't be determined. * `execution-skipped-by-agent`: Resource execution was skipped by the agent because errors were encountered while executing prior resources in the OS policy. * `os-policy-execution-attempt-failed`: The execution of the OS policy containing this resource failed and the compliance state couldn't be determined. * `os-policy-execution-pending`: OS policy that owns this resource was assigned to the given VM, but was not executed yet. "configSteps": [ # Ordered list of configuration completed by the agent for the OS policy resource. { # Step performed by the OS Config agent for configuring an `OSPolicy` resource to its desired state. "errorMessage": "A String", # An error message recorded during the execution of this step. Only populated if errors were encountered during this step execution. @@ -166,12 +166,12 @@

Method Details

"osPolicyCompliances": [ # Compliance data for each `OSPolicy` that is applied to the VM. { # Compliance data for an OS policy "complianceState": "A String", # The compliance state of the OS policy. - "complianceStateReason": "A String", # The reason for the OS policy to be in an unknown compliance state. This field is always populated when `compliance_state` is `UNKNOWN`. If populated, the field can contain one of the following values: * `vm-not-running`: The VM was not running. * `os-policies-not-supported-by-agent`: The version of the OS Config agent running on the VM does not support running OS policies. * `no-agent-detected`: The OS Config agent is not detected for the VM. * `resource-execution-errors`: The OS Config agent encountered errors while executing one or more resources in the policy. See `os_policy_resource_compliances` for details. * `task-timeout`: The task sent to the agent to apply the policy timed out. * `unexpected-agent-state`: The OS Config agent did not report the final status of the task that attempted to apply the policy. Instead, the agent unexpectedly started working on a different task. This mostly happens when the agent or VM unexpectedly restarts while applying OS policies. * `internal-service-errors`: Internal service errors were encountered while attempting to apply the policy. + "complianceStateReason": "A String", # The reason for the OS policy to be in an unknown compliance state. This field is always populated when `compliance_state` is `UNKNOWN`. If populated, the field can contain one of the following values: * `vm-not-running`: The VM was not running. * `os-policies-not-supported-by-agent`: The version of the OS Config agent running on the VM does not support running OS policies. * `no-agent-detected`: The OS Config agent is not detected for the VM. * `resource-execution-errors`: The OS Config agent encountered errors while executing one or more resources in the policy. See `os_policy_resource_compliances` for details. * `task-timeout`: The task sent to the agent to apply the policy timed out. * `unexpected-agent-state`: The OS Config agent did not report the final status of the task that attempted to apply the policy. Instead, the agent unexpectedly started working on a different task. This mostly happens when the agent or VM unexpectedly restarts while applying OS policies. * `internal-service-errors`: Internal service errors were encountered while attempting to apply the policy. * `os-policy-execution-pending`: OS policy was assigned to the given VM, but was not executed yet. Typically this is a transient condition that will go away after the next policy execution cycle. "osPolicyId": "A String", # The OS policy id "osPolicyResourceCompliances": [ # Compliance data for each resource within the policy that is applied to the VM. { # Compliance data for an OS policy resource. "complianceState": "A String", # The compliance state of the resource. - "complianceStateReason": "A String", # A reason for the resource to be in the given compliance state. This field is always populated when `compliance_state` is `UNKNOWN`. The following values are supported when `compliance_state == UNKNOWN` * `execution-errors`: Errors were encountered by the agent while executing the resource and the compliance state couldn't be determined. * `execution-skipped-by-agent`: Resource execution was skipped by the agent because errors were encountered while executing prior resources in the OS policy. * `os-policy-execution-attempt-failed`: The execution of the OS policy containing this resource failed and the compliance state couldn't be determined. + "complianceStateReason": "A String", # A reason for the resource to be in the given compliance state. This field is always populated when `compliance_state` is `UNKNOWN`. The following values are supported when `compliance_state == UNKNOWN` * `execution-errors`: Errors were encountered by the agent while executing the resource and the compliance state couldn't be determined. * `execution-skipped-by-agent`: Resource execution was skipped by the agent because errors were encountered while executing prior resources in the OS policy. * `os-policy-execution-attempt-failed`: The execution of the OS policy containing this resource failed and the compliance state couldn't be determined. * `os-policy-execution-pending`: OS policy that owns this resource was assigned to the given VM, but was not executed yet. "configSteps": [ # Ordered list of configuration completed by the agent for the OS policy resource. { # Step performed by the OS Config agent for configuring an `OSPolicy` resource to its desired state. "errorMessage": "A String", # An error message recorded during the execution of this step. Only populated if errors were encountered during this step execution. diff --git a/docs/dyn/oslogin_v1alpha.users.projects.locations.html b/docs/dyn/oslogin_v1alpha.users.projects.locations.html index eb4ce80903d..2cc058911c0 100644 --- a/docs/dyn/oslogin_v1alpha.users.projects.locations.html +++ b/docs/dyn/oslogin_v1alpha.users.projects.locations.html @@ -91,7 +91,7 @@

Method Details

Signs an SSH public key for a user to authenticate to a virtual machine on Google Compute Engine.
 
 Args:
-  parent: string, The parent project and zone for the signing request. This is needed to properly ensure per-organization ISS processing and potentially to provide for the possibility of zone-specific certificates used in the signing process. (required)
+  parent: string, The parent project and region for the signing request. (required)
   body: object, The request body.
     The object takes the form of:
 
diff --git a/docs/dyn/oslogin_v1alpha.users.projects.zones.html b/docs/dyn/oslogin_v1alpha.users.projects.zones.html
index fddc343e439..d0f8a57e143 100644
--- a/docs/dyn/oslogin_v1alpha.users.projects.zones.html
+++ b/docs/dyn/oslogin_v1alpha.users.projects.zones.html
@@ -91,7 +91,7 @@ 

Method Details

Signs an SSH public key for a user to authenticate to a virtual machine on Google Compute Engine.
 
 Args:
-  parent: string, The parent project and zone for the signing request. This is needed to properly ensure per-organization ISS processing and potentially to provide for the possibility of zone-specific certificates used in the signing process. (required)
+  parent: string, The parent project and region for the signing request. (required)
   body: object, The request body.
     The object takes the form of:
 
diff --git a/docs/dyn/privateca_v1.projects.locations.caPools.certificateAuthorities.html b/docs/dyn/privateca_v1.projects.locations.caPools.certificateAuthorities.html
index e3137b717ca..fa7ac92d605 100644
--- a/docs/dyn/privateca_v1.projects.locations.caPools.certificateAuthorities.html
+++ b/docs/dyn/privateca_v1.projects.locations.caPools.certificateAuthorities.html
@@ -265,9 +265,9 @@ 

Method Details

"aiaOcspServers": [ # Optional. Describes Online Certificate Status Protocol (OCSP) endpoint addresses that appear in the "Authority Information Access" extension in the certificate. "A String", ], - "caOptions": { # Describes values that are relevant in a CA certificate. # Optional. Describes options in this X509Parameters that are relevant in a CA certificate. - "isCa": True or False, # Optional. Refers to the "CA" X.509 extension, which is a boolean value. When this value is missing, the extension will be omitted from the CA certificate. - "maxIssuerPathLength": 42, # Optional. Refers to the path length restriction X.509 extension. For a CA certificate, this value describes the depth of subordinate CA certificates that are allowed. If this value is less than 0, the request will fail. If this value is missing, the max path length will be omitted from the CA certificate. + "caOptions": { # Describes the X.509 basic constraints extension, per [RFC 5280 section 4.2.1.9](https://tools.ietf.org/html/rfc5280#section-4.2.1.9) # Optional. Describes options in this X509Parameters that are relevant in a CA certificate. If not specified, a default basic constraints extension with `is_ca=false` will be added for leaf certificates. + "isCa": True or False, # Optional. Refers to the "CA" boolean field in the X.509 extension. When this value is missing, the basic constraints extension will be omitted from the certificate. + "maxIssuerPathLength": 42, # Optional. Refers to the path length constraint field in the X.509 extension. For a CA certificate, this value describes the depth of subordinate CA certificates that are allowed. If this value is less than 0, the request will fail. If this value is missing, the max path length will be omitted from the certificate. }, "keyUsage": { # A KeyUsage describes key usage values that may appear in an X.509 certificate. # Optional. Indicates the intended use for keys that correspond to a certificate. "baseKeyUsage": { # KeyUsage.KeyUsageOptions corresponds to the key usage values described in https://tools.ietf.org/html/rfc5280#section-4.2.1.3. # Describes high-level ways in which a key may be used. @@ -394,9 +394,9 @@

Method Details

"aiaOcspServers": [ # Optional. Describes Online Certificate Status Protocol (OCSP) endpoint addresses that appear in the "Authority Information Access" extension in the certificate. "A String", ], - "caOptions": { # Describes values that are relevant in a CA certificate. # Optional. Describes options in this X509Parameters that are relevant in a CA certificate. - "isCa": True or False, # Optional. Refers to the "CA" X.509 extension, which is a boolean value. When this value is missing, the extension will be omitted from the CA certificate. - "maxIssuerPathLength": 42, # Optional. Refers to the path length restriction X.509 extension. For a CA certificate, this value describes the depth of subordinate CA certificates that are allowed. If this value is less than 0, the request will fail. If this value is missing, the max path length will be omitted from the CA certificate. + "caOptions": { # Describes the X.509 basic constraints extension, per [RFC 5280 section 4.2.1.9](https://tools.ietf.org/html/rfc5280#section-4.2.1.9) # Optional. Describes options in this X509Parameters that are relevant in a CA certificate. If not specified, a default basic constraints extension with `is_ca=false` will be added for leaf certificates. + "isCa": True or False, # Optional. Refers to the "CA" boolean field in the X.509 extension. When this value is missing, the basic constraints extension will be omitted from the certificate. + "maxIssuerPathLength": 42, # Optional. Refers to the path length constraint field in the X.509 extension. For a CA certificate, this value describes the depth of subordinate CA certificates that are allowed. If this value is less than 0, the request will fail. If this value is missing, the max path length will be omitted from the certificate. }, "keyUsage": { # A KeyUsage describes key usage values that may appear in an X.509 certificate. # Optional. Indicates the intended use for keys that correspond to a certificate. "baseKeyUsage": { # KeyUsage.KeyUsageOptions corresponds to the key usage values described in https://tools.ietf.org/html/rfc5280#section-4.2.1.3. # Describes high-level ways in which a key may be used. @@ -766,9 +766,9 @@

Method Details

"aiaOcspServers": [ # Optional. Describes Online Certificate Status Protocol (OCSP) endpoint addresses that appear in the "Authority Information Access" extension in the certificate. "A String", ], - "caOptions": { # Describes values that are relevant in a CA certificate. # Optional. Describes options in this X509Parameters that are relevant in a CA certificate. - "isCa": True or False, # Optional. Refers to the "CA" X.509 extension, which is a boolean value. When this value is missing, the extension will be omitted from the CA certificate. - "maxIssuerPathLength": 42, # Optional. Refers to the path length restriction X.509 extension. For a CA certificate, this value describes the depth of subordinate CA certificates that are allowed. If this value is less than 0, the request will fail. If this value is missing, the max path length will be omitted from the CA certificate. + "caOptions": { # Describes the X.509 basic constraints extension, per [RFC 5280 section 4.2.1.9](https://tools.ietf.org/html/rfc5280#section-4.2.1.9) # Optional. Describes options in this X509Parameters that are relevant in a CA certificate. If not specified, a default basic constraints extension with `is_ca=false` will be added for leaf certificates. + "isCa": True or False, # Optional. Refers to the "CA" boolean field in the X.509 extension. When this value is missing, the basic constraints extension will be omitted from the certificate. + "maxIssuerPathLength": 42, # Optional. Refers to the path length constraint field in the X.509 extension. For a CA certificate, this value describes the depth of subordinate CA certificates that are allowed. If this value is less than 0, the request will fail. If this value is missing, the max path length will be omitted from the certificate. }, "keyUsage": { # A KeyUsage describes key usage values that may appear in an X.509 certificate. # Optional. Indicates the intended use for keys that correspond to a certificate. "baseKeyUsage": { # KeyUsage.KeyUsageOptions corresponds to the key usage values described in https://tools.ietf.org/html/rfc5280#section-4.2.1.3. # Describes high-level ways in which a key may be used. @@ -895,9 +895,9 @@

Method Details

"aiaOcspServers": [ # Optional. Describes Online Certificate Status Protocol (OCSP) endpoint addresses that appear in the "Authority Information Access" extension in the certificate. "A String", ], - "caOptions": { # Describes values that are relevant in a CA certificate. # Optional. Describes options in this X509Parameters that are relevant in a CA certificate. - "isCa": True or False, # Optional. Refers to the "CA" X.509 extension, which is a boolean value. When this value is missing, the extension will be omitted from the CA certificate. - "maxIssuerPathLength": 42, # Optional. Refers to the path length restriction X.509 extension. For a CA certificate, this value describes the depth of subordinate CA certificates that are allowed. If this value is less than 0, the request will fail. If this value is missing, the max path length will be omitted from the CA certificate. + "caOptions": { # Describes the X.509 basic constraints extension, per [RFC 5280 section 4.2.1.9](https://tools.ietf.org/html/rfc5280#section-4.2.1.9) # Optional. Describes options in this X509Parameters that are relevant in a CA certificate. If not specified, a default basic constraints extension with `is_ca=false` will be added for leaf certificates. + "isCa": True or False, # Optional. Refers to the "CA" boolean field in the X.509 extension. When this value is missing, the basic constraints extension will be omitted from the certificate. + "maxIssuerPathLength": 42, # Optional. Refers to the path length constraint field in the X.509 extension. For a CA certificate, this value describes the depth of subordinate CA certificates that are allowed. If this value is less than 0, the request will fail. If this value is missing, the max path length will be omitted from the certificate. }, "keyUsage": { # A KeyUsage describes key usage values that may appear in an X.509 certificate. # Optional. Indicates the intended use for keys that correspond to a certificate. "baseKeyUsage": { # KeyUsage.KeyUsageOptions corresponds to the key usage values described in https://tools.ietf.org/html/rfc5280#section-4.2.1.3. # Describes high-level ways in which a key may be used. @@ -1100,9 +1100,9 @@

Method Details

"aiaOcspServers": [ # Optional. Describes Online Certificate Status Protocol (OCSP) endpoint addresses that appear in the "Authority Information Access" extension in the certificate. "A String", ], - "caOptions": { # Describes values that are relevant in a CA certificate. # Optional. Describes options in this X509Parameters that are relevant in a CA certificate. - "isCa": True or False, # Optional. Refers to the "CA" X.509 extension, which is a boolean value. When this value is missing, the extension will be omitted from the CA certificate. - "maxIssuerPathLength": 42, # Optional. Refers to the path length restriction X.509 extension. For a CA certificate, this value describes the depth of subordinate CA certificates that are allowed. If this value is less than 0, the request will fail. If this value is missing, the max path length will be omitted from the CA certificate. + "caOptions": { # Describes the X.509 basic constraints extension, per [RFC 5280 section 4.2.1.9](https://tools.ietf.org/html/rfc5280#section-4.2.1.9) # Optional. Describes options in this X509Parameters that are relevant in a CA certificate. If not specified, a default basic constraints extension with `is_ca=false` will be added for leaf certificates. + "isCa": True or False, # Optional. Refers to the "CA" boolean field in the X.509 extension. When this value is missing, the basic constraints extension will be omitted from the certificate. + "maxIssuerPathLength": 42, # Optional. Refers to the path length constraint field in the X.509 extension. For a CA certificate, this value describes the depth of subordinate CA certificates that are allowed. If this value is less than 0, the request will fail. If this value is missing, the max path length will be omitted from the certificate. }, "keyUsage": { # A KeyUsage describes key usage values that may appear in an X.509 certificate. # Optional. Indicates the intended use for keys that correspond to a certificate. "baseKeyUsage": { # KeyUsage.KeyUsageOptions corresponds to the key usage values described in https://tools.ietf.org/html/rfc5280#section-4.2.1.3. # Describes high-level ways in which a key may be used. @@ -1229,9 +1229,9 @@

Method Details

"aiaOcspServers": [ # Optional. Describes Online Certificate Status Protocol (OCSP) endpoint addresses that appear in the "Authority Information Access" extension in the certificate. "A String", ], - "caOptions": { # Describes values that are relevant in a CA certificate. # Optional. Describes options in this X509Parameters that are relevant in a CA certificate. - "isCa": True or False, # Optional. Refers to the "CA" X.509 extension, which is a boolean value. When this value is missing, the extension will be omitted from the CA certificate. - "maxIssuerPathLength": 42, # Optional. Refers to the path length restriction X.509 extension. For a CA certificate, this value describes the depth of subordinate CA certificates that are allowed. If this value is less than 0, the request will fail. If this value is missing, the max path length will be omitted from the CA certificate. + "caOptions": { # Describes the X.509 basic constraints extension, per [RFC 5280 section 4.2.1.9](https://tools.ietf.org/html/rfc5280#section-4.2.1.9) # Optional. Describes options in this X509Parameters that are relevant in a CA certificate. If not specified, a default basic constraints extension with `is_ca=false` will be added for leaf certificates. + "isCa": True or False, # Optional. Refers to the "CA" boolean field in the X.509 extension. When this value is missing, the basic constraints extension will be omitted from the certificate. + "maxIssuerPathLength": 42, # Optional. Refers to the path length constraint field in the X.509 extension. For a CA certificate, this value describes the depth of subordinate CA certificates that are allowed. If this value is less than 0, the request will fail. If this value is missing, the max path length will be omitted from the certificate. }, "keyUsage": { # A KeyUsage describes key usage values that may appear in an X.509 certificate. # Optional. Indicates the intended use for keys that correspond to a certificate. "baseKeyUsage": { # KeyUsage.KeyUsageOptions corresponds to the key usage values described in https://tools.ietf.org/html/rfc5280#section-4.2.1.3. # Describes high-level ways in which a key may be used. @@ -1443,9 +1443,9 @@

Method Details

"aiaOcspServers": [ # Optional. Describes Online Certificate Status Protocol (OCSP) endpoint addresses that appear in the "Authority Information Access" extension in the certificate. "A String", ], - "caOptions": { # Describes values that are relevant in a CA certificate. # Optional. Describes options in this X509Parameters that are relevant in a CA certificate. - "isCa": True or False, # Optional. Refers to the "CA" X.509 extension, which is a boolean value. When this value is missing, the extension will be omitted from the CA certificate. - "maxIssuerPathLength": 42, # Optional. Refers to the path length restriction X.509 extension. For a CA certificate, this value describes the depth of subordinate CA certificates that are allowed. If this value is less than 0, the request will fail. If this value is missing, the max path length will be omitted from the CA certificate. + "caOptions": { # Describes the X.509 basic constraints extension, per [RFC 5280 section 4.2.1.9](https://tools.ietf.org/html/rfc5280#section-4.2.1.9) # Optional. Describes options in this X509Parameters that are relevant in a CA certificate. If not specified, a default basic constraints extension with `is_ca=false` will be added for leaf certificates. + "isCa": True or False, # Optional. Refers to the "CA" boolean field in the X.509 extension. When this value is missing, the basic constraints extension will be omitted from the certificate. + "maxIssuerPathLength": 42, # Optional. Refers to the path length constraint field in the X.509 extension. For a CA certificate, this value describes the depth of subordinate CA certificates that are allowed. If this value is less than 0, the request will fail. If this value is missing, the max path length will be omitted from the certificate. }, "keyUsage": { # A KeyUsage describes key usage values that may appear in an X.509 certificate. # Optional. Indicates the intended use for keys that correspond to a certificate. "baseKeyUsage": { # KeyUsage.KeyUsageOptions corresponds to the key usage values described in https://tools.ietf.org/html/rfc5280#section-4.2.1.3. # Describes high-level ways in which a key may be used. @@ -1572,9 +1572,9 @@

Method Details

"aiaOcspServers": [ # Optional. Describes Online Certificate Status Protocol (OCSP) endpoint addresses that appear in the "Authority Information Access" extension in the certificate. "A String", ], - "caOptions": { # Describes values that are relevant in a CA certificate. # Optional. Describes options in this X509Parameters that are relevant in a CA certificate. - "isCa": True or False, # Optional. Refers to the "CA" X.509 extension, which is a boolean value. When this value is missing, the extension will be omitted from the CA certificate. - "maxIssuerPathLength": 42, # Optional. Refers to the path length restriction X.509 extension. For a CA certificate, this value describes the depth of subordinate CA certificates that are allowed. If this value is less than 0, the request will fail. If this value is missing, the max path length will be omitted from the CA certificate. + "caOptions": { # Describes the X.509 basic constraints extension, per [RFC 5280 section 4.2.1.9](https://tools.ietf.org/html/rfc5280#section-4.2.1.9) # Optional. Describes options in this X509Parameters that are relevant in a CA certificate. If not specified, a default basic constraints extension with `is_ca=false` will be added for leaf certificates. + "isCa": True or False, # Optional. Refers to the "CA" boolean field in the X.509 extension. When this value is missing, the basic constraints extension will be omitted from the certificate. + "maxIssuerPathLength": 42, # Optional. Refers to the path length constraint field in the X.509 extension. For a CA certificate, this value describes the depth of subordinate CA certificates that are allowed. If this value is less than 0, the request will fail. If this value is missing, the max path length will be omitted from the certificate. }, "keyUsage": { # A KeyUsage describes key usage values that may appear in an X.509 certificate. # Optional. Indicates the intended use for keys that correspond to a certificate. "baseKeyUsage": { # KeyUsage.KeyUsageOptions corresponds to the key usage values described in https://tools.ietf.org/html/rfc5280#section-4.2.1.3. # Describes high-level ways in which a key may be used. diff --git a/docs/dyn/privateca_v1.projects.locations.caPools.certificates.html b/docs/dyn/privateca_v1.projects.locations.caPools.certificates.html index 6bf7592edea..185262d88c5 100644 --- a/docs/dyn/privateca_v1.projects.locations.caPools.certificates.html +++ b/docs/dyn/privateca_v1.projects.locations.caPools.certificates.html @@ -187,9 +187,9 @@

Method Details

"aiaOcspServers": [ # Optional. Describes Online Certificate Status Protocol (OCSP) endpoint addresses that appear in the "Authority Information Access" extension in the certificate. "A String", ], - "caOptions": { # Describes values that are relevant in a CA certificate. # Optional. Describes options in this X509Parameters that are relevant in a CA certificate. - "isCa": True or False, # Optional. Refers to the "CA" X.509 extension, which is a boolean value. When this value is missing, the extension will be omitted from the CA certificate. - "maxIssuerPathLength": 42, # Optional. Refers to the path length restriction X.509 extension. For a CA certificate, this value describes the depth of subordinate CA certificates that are allowed. If this value is less than 0, the request will fail. If this value is missing, the max path length will be omitted from the CA certificate. + "caOptions": { # Describes the X.509 basic constraints extension, per [RFC 5280 section 4.2.1.9](https://tools.ietf.org/html/rfc5280#section-4.2.1.9) # Optional. Describes options in this X509Parameters that are relevant in a CA certificate. If not specified, a default basic constraints extension with `is_ca=false` will be added for leaf certificates. + "isCa": True or False, # Optional. Refers to the "CA" boolean field in the X.509 extension. When this value is missing, the basic constraints extension will be omitted from the certificate. + "maxIssuerPathLength": 42, # Optional. Refers to the path length constraint field in the X.509 extension. For a CA certificate, this value describes the depth of subordinate CA certificates that are allowed. If this value is less than 0, the request will fail. If this value is missing, the max path length will be omitted from the certificate. }, "keyUsage": { # A KeyUsage describes key usage values that may appear in an X.509 certificate. # Optional. Indicates the intended use for keys that correspond to a certificate. "baseKeyUsage": { # KeyUsage.KeyUsageOptions corresponds to the key usage values described in https://tools.ietf.org/html/rfc5280#section-4.2.1.3. # Describes high-level ways in which a key may be used. @@ -316,9 +316,9 @@

Method Details

"aiaOcspServers": [ # Optional. Describes Online Certificate Status Protocol (OCSP) endpoint addresses that appear in the "Authority Information Access" extension in the certificate. "A String", ], - "caOptions": { # Describes values that are relevant in a CA certificate. # Optional. Describes options in this X509Parameters that are relevant in a CA certificate. - "isCa": True or False, # Optional. Refers to the "CA" X.509 extension, which is a boolean value. When this value is missing, the extension will be omitted from the CA certificate. - "maxIssuerPathLength": 42, # Optional. Refers to the path length restriction X.509 extension. For a CA certificate, this value describes the depth of subordinate CA certificates that are allowed. If this value is less than 0, the request will fail. If this value is missing, the max path length will be omitted from the CA certificate. + "caOptions": { # Describes the X.509 basic constraints extension, per [RFC 5280 section 4.2.1.9](https://tools.ietf.org/html/rfc5280#section-4.2.1.9) # Optional. Describes options in this X509Parameters that are relevant in a CA certificate. If not specified, a default basic constraints extension with `is_ca=false` will be added for leaf certificates. + "isCa": True or False, # Optional. Refers to the "CA" boolean field in the X.509 extension. When this value is missing, the basic constraints extension will be omitted from the certificate. + "maxIssuerPathLength": 42, # Optional. Refers to the path length constraint field in the X.509 extension. For a CA certificate, this value describes the depth of subordinate CA certificates that are allowed. If this value is less than 0, the request will fail. If this value is missing, the max path length will be omitted from the certificate. }, "keyUsage": { # A KeyUsage describes key usage values that may appear in an X.509 certificate. # Optional. Indicates the intended use for keys that correspond to a certificate. "baseKeyUsage": { # KeyUsage.KeyUsageOptions corresponds to the key usage values described in https://tools.ietf.org/html/rfc5280#section-4.2.1.3. # Describes high-level ways in which a key may be used. @@ -493,9 +493,9 @@

Method Details

"aiaOcspServers": [ # Optional. Describes Online Certificate Status Protocol (OCSP) endpoint addresses that appear in the "Authority Information Access" extension in the certificate. "A String", ], - "caOptions": { # Describes values that are relevant in a CA certificate. # Optional. Describes options in this X509Parameters that are relevant in a CA certificate. - "isCa": True or False, # Optional. Refers to the "CA" X.509 extension, which is a boolean value. When this value is missing, the extension will be omitted from the CA certificate. - "maxIssuerPathLength": 42, # Optional. Refers to the path length restriction X.509 extension. For a CA certificate, this value describes the depth of subordinate CA certificates that are allowed. If this value is less than 0, the request will fail. If this value is missing, the max path length will be omitted from the CA certificate. + "caOptions": { # Describes the X.509 basic constraints extension, per [RFC 5280 section 4.2.1.9](https://tools.ietf.org/html/rfc5280#section-4.2.1.9) # Optional. Describes options in this X509Parameters that are relevant in a CA certificate. If not specified, a default basic constraints extension with `is_ca=false` will be added for leaf certificates. + "isCa": True or False, # Optional. Refers to the "CA" boolean field in the X.509 extension. When this value is missing, the basic constraints extension will be omitted from the certificate. + "maxIssuerPathLength": 42, # Optional. Refers to the path length constraint field in the X.509 extension. For a CA certificate, this value describes the depth of subordinate CA certificates that are allowed. If this value is less than 0, the request will fail. If this value is missing, the max path length will be omitted from the certificate. }, "keyUsage": { # A KeyUsage describes key usage values that may appear in an X.509 certificate. # Optional. Indicates the intended use for keys that correspond to a certificate. "baseKeyUsage": { # KeyUsage.KeyUsageOptions corresponds to the key usage values described in https://tools.ietf.org/html/rfc5280#section-4.2.1.3. # Describes high-level ways in which a key may be used. @@ -622,9 +622,9 @@

Method Details

"aiaOcspServers": [ # Optional. Describes Online Certificate Status Protocol (OCSP) endpoint addresses that appear in the "Authority Information Access" extension in the certificate. "A String", ], - "caOptions": { # Describes values that are relevant in a CA certificate. # Optional. Describes options in this X509Parameters that are relevant in a CA certificate. - "isCa": True or False, # Optional. Refers to the "CA" X.509 extension, which is a boolean value. When this value is missing, the extension will be omitted from the CA certificate. - "maxIssuerPathLength": 42, # Optional. Refers to the path length restriction X.509 extension. For a CA certificate, this value describes the depth of subordinate CA certificates that are allowed. If this value is less than 0, the request will fail. If this value is missing, the max path length will be omitted from the CA certificate. + "caOptions": { # Describes the X.509 basic constraints extension, per [RFC 5280 section 4.2.1.9](https://tools.ietf.org/html/rfc5280#section-4.2.1.9) # Optional. Describes options in this X509Parameters that are relevant in a CA certificate. If not specified, a default basic constraints extension with `is_ca=false` will be added for leaf certificates. + "isCa": True or False, # Optional. Refers to the "CA" boolean field in the X.509 extension. When this value is missing, the basic constraints extension will be omitted from the certificate. + "maxIssuerPathLength": 42, # Optional. Refers to the path length constraint field in the X.509 extension. For a CA certificate, this value describes the depth of subordinate CA certificates that are allowed. If this value is less than 0, the request will fail. If this value is missing, the max path length will be omitted from the certificate. }, "keyUsage": { # A KeyUsage describes key usage values that may appear in an X.509 certificate. # Optional. Indicates the intended use for keys that correspond to a certificate. "baseKeyUsage": { # KeyUsage.KeyUsageOptions corresponds to the key usage values described in https://tools.ietf.org/html/rfc5280#section-4.2.1.3. # Describes high-level ways in which a key may be used. @@ -802,9 +802,9 @@

Method Details

"aiaOcspServers": [ # Optional. Describes Online Certificate Status Protocol (OCSP) endpoint addresses that appear in the "Authority Information Access" extension in the certificate. "A String", ], - "caOptions": { # Describes values that are relevant in a CA certificate. # Optional. Describes options in this X509Parameters that are relevant in a CA certificate. - "isCa": True or False, # Optional. Refers to the "CA" X.509 extension, which is a boolean value. When this value is missing, the extension will be omitted from the CA certificate. - "maxIssuerPathLength": 42, # Optional. Refers to the path length restriction X.509 extension. For a CA certificate, this value describes the depth of subordinate CA certificates that are allowed. If this value is less than 0, the request will fail. If this value is missing, the max path length will be omitted from the CA certificate. + "caOptions": { # Describes the X.509 basic constraints extension, per [RFC 5280 section 4.2.1.9](https://tools.ietf.org/html/rfc5280#section-4.2.1.9) # Optional. Describes options in this X509Parameters that are relevant in a CA certificate. If not specified, a default basic constraints extension with `is_ca=false` will be added for leaf certificates. + "isCa": True or False, # Optional. Refers to the "CA" boolean field in the X.509 extension. When this value is missing, the basic constraints extension will be omitted from the certificate. + "maxIssuerPathLength": 42, # Optional. Refers to the path length constraint field in the X.509 extension. For a CA certificate, this value describes the depth of subordinate CA certificates that are allowed. If this value is less than 0, the request will fail. If this value is missing, the max path length will be omitted from the certificate. }, "keyUsage": { # A KeyUsage describes key usage values that may appear in an X.509 certificate. # Optional. Indicates the intended use for keys that correspond to a certificate. "baseKeyUsage": { # KeyUsage.KeyUsageOptions corresponds to the key usage values described in https://tools.ietf.org/html/rfc5280#section-4.2.1.3. # Describes high-level ways in which a key may be used. @@ -931,9 +931,9 @@

Method Details

"aiaOcspServers": [ # Optional. Describes Online Certificate Status Protocol (OCSP) endpoint addresses that appear in the "Authority Information Access" extension in the certificate. "A String", ], - "caOptions": { # Describes values that are relevant in a CA certificate. # Optional. Describes options in this X509Parameters that are relevant in a CA certificate. - "isCa": True or False, # Optional. Refers to the "CA" X.509 extension, which is a boolean value. When this value is missing, the extension will be omitted from the CA certificate. - "maxIssuerPathLength": 42, # Optional. Refers to the path length restriction X.509 extension. For a CA certificate, this value describes the depth of subordinate CA certificates that are allowed. If this value is less than 0, the request will fail. If this value is missing, the max path length will be omitted from the CA certificate. + "caOptions": { # Describes the X.509 basic constraints extension, per [RFC 5280 section 4.2.1.9](https://tools.ietf.org/html/rfc5280#section-4.2.1.9) # Optional. Describes options in this X509Parameters that are relevant in a CA certificate. If not specified, a default basic constraints extension with `is_ca=false` will be added for leaf certificates. + "isCa": True or False, # Optional. Refers to the "CA" boolean field in the X.509 extension. When this value is missing, the basic constraints extension will be omitted from the certificate. + "maxIssuerPathLength": 42, # Optional. Refers to the path length constraint field in the X.509 extension. For a CA certificate, this value describes the depth of subordinate CA certificates that are allowed. If this value is less than 0, the request will fail. If this value is missing, the max path length will be omitted from the certificate. }, "keyUsage": { # A KeyUsage describes key usage values that may appear in an X.509 certificate. # Optional. Indicates the intended use for keys that correspond to a certificate. "baseKeyUsage": { # KeyUsage.KeyUsageOptions corresponds to the key usage values described in https://tools.ietf.org/html/rfc5280#section-4.2.1.3. # Describes high-level ways in which a key may be used. @@ -1117,9 +1117,9 @@

Method Details

"aiaOcspServers": [ # Optional. Describes Online Certificate Status Protocol (OCSP) endpoint addresses that appear in the "Authority Information Access" extension in the certificate. "A String", ], - "caOptions": { # Describes values that are relevant in a CA certificate. # Optional. Describes options in this X509Parameters that are relevant in a CA certificate. - "isCa": True or False, # Optional. Refers to the "CA" X.509 extension, which is a boolean value. When this value is missing, the extension will be omitted from the CA certificate. - "maxIssuerPathLength": 42, # Optional. Refers to the path length restriction X.509 extension. For a CA certificate, this value describes the depth of subordinate CA certificates that are allowed. If this value is less than 0, the request will fail. If this value is missing, the max path length will be omitted from the CA certificate. + "caOptions": { # Describes the X.509 basic constraints extension, per [RFC 5280 section 4.2.1.9](https://tools.ietf.org/html/rfc5280#section-4.2.1.9) # Optional. Describes options in this X509Parameters that are relevant in a CA certificate. If not specified, a default basic constraints extension with `is_ca=false` will be added for leaf certificates. + "isCa": True or False, # Optional. Refers to the "CA" boolean field in the X.509 extension. When this value is missing, the basic constraints extension will be omitted from the certificate. + "maxIssuerPathLength": 42, # Optional. Refers to the path length constraint field in the X.509 extension. For a CA certificate, this value describes the depth of subordinate CA certificates that are allowed. If this value is less than 0, the request will fail. If this value is missing, the max path length will be omitted from the certificate. }, "keyUsage": { # A KeyUsage describes key usage values that may appear in an X.509 certificate. # Optional. Indicates the intended use for keys that correspond to a certificate. "baseKeyUsage": { # KeyUsage.KeyUsageOptions corresponds to the key usage values described in https://tools.ietf.org/html/rfc5280#section-4.2.1.3. # Describes high-level ways in which a key may be used. @@ -1246,9 +1246,9 @@

Method Details

"aiaOcspServers": [ # Optional. Describes Online Certificate Status Protocol (OCSP) endpoint addresses that appear in the "Authority Information Access" extension in the certificate. "A String", ], - "caOptions": { # Describes values that are relevant in a CA certificate. # Optional. Describes options in this X509Parameters that are relevant in a CA certificate. - "isCa": True or False, # Optional. Refers to the "CA" X.509 extension, which is a boolean value. When this value is missing, the extension will be omitted from the CA certificate. - "maxIssuerPathLength": 42, # Optional. Refers to the path length restriction X.509 extension. For a CA certificate, this value describes the depth of subordinate CA certificates that are allowed. If this value is less than 0, the request will fail. If this value is missing, the max path length will be omitted from the CA certificate. + "caOptions": { # Describes the X.509 basic constraints extension, per [RFC 5280 section 4.2.1.9](https://tools.ietf.org/html/rfc5280#section-4.2.1.9) # Optional. Describes options in this X509Parameters that are relevant in a CA certificate. If not specified, a default basic constraints extension with `is_ca=false` will be added for leaf certificates. + "isCa": True or False, # Optional. Refers to the "CA" boolean field in the X.509 extension. When this value is missing, the basic constraints extension will be omitted from the certificate. + "maxIssuerPathLength": 42, # Optional. Refers to the path length constraint field in the X.509 extension. For a CA certificate, this value describes the depth of subordinate CA certificates that are allowed. If this value is less than 0, the request will fail. If this value is missing, the max path length will be omitted from the certificate. }, "keyUsage": { # A KeyUsage describes key usage values that may appear in an X.509 certificate. # Optional. Indicates the intended use for keys that correspond to a certificate. "baseKeyUsage": { # KeyUsage.KeyUsageOptions corresponds to the key usage values described in https://tools.ietf.org/html/rfc5280#section-4.2.1.3. # Describes high-level ways in which a key may be used. @@ -1441,9 +1441,9 @@

Method Details

"aiaOcspServers": [ # Optional. Describes Online Certificate Status Protocol (OCSP) endpoint addresses that appear in the "Authority Information Access" extension in the certificate. "A String", ], - "caOptions": { # Describes values that are relevant in a CA certificate. # Optional. Describes options in this X509Parameters that are relevant in a CA certificate. - "isCa": True or False, # Optional. Refers to the "CA" X.509 extension, which is a boolean value. When this value is missing, the extension will be omitted from the CA certificate. - "maxIssuerPathLength": 42, # Optional. Refers to the path length restriction X.509 extension. For a CA certificate, this value describes the depth of subordinate CA certificates that are allowed. If this value is less than 0, the request will fail. If this value is missing, the max path length will be omitted from the CA certificate. + "caOptions": { # Describes the X.509 basic constraints extension, per [RFC 5280 section 4.2.1.9](https://tools.ietf.org/html/rfc5280#section-4.2.1.9) # Optional. Describes options in this X509Parameters that are relevant in a CA certificate. If not specified, a default basic constraints extension with `is_ca=false` will be added for leaf certificates. + "isCa": True or False, # Optional. Refers to the "CA" boolean field in the X.509 extension. When this value is missing, the basic constraints extension will be omitted from the certificate. + "maxIssuerPathLength": 42, # Optional. Refers to the path length constraint field in the X.509 extension. For a CA certificate, this value describes the depth of subordinate CA certificates that are allowed. If this value is less than 0, the request will fail. If this value is missing, the max path length will be omitted from the certificate. }, "keyUsage": { # A KeyUsage describes key usage values that may appear in an X.509 certificate. # Optional. Indicates the intended use for keys that correspond to a certificate. "baseKeyUsage": { # KeyUsage.KeyUsageOptions corresponds to the key usage values described in https://tools.ietf.org/html/rfc5280#section-4.2.1.3. # Describes high-level ways in which a key may be used. @@ -1570,9 +1570,9 @@

Method Details

"aiaOcspServers": [ # Optional. Describes Online Certificate Status Protocol (OCSP) endpoint addresses that appear in the "Authority Information Access" extension in the certificate. "A String", ], - "caOptions": { # Describes values that are relevant in a CA certificate. # Optional. Describes options in this X509Parameters that are relevant in a CA certificate. - "isCa": True or False, # Optional. Refers to the "CA" X.509 extension, which is a boolean value. When this value is missing, the extension will be omitted from the CA certificate. - "maxIssuerPathLength": 42, # Optional. Refers to the path length restriction X.509 extension. For a CA certificate, this value describes the depth of subordinate CA certificates that are allowed. If this value is less than 0, the request will fail. If this value is missing, the max path length will be omitted from the CA certificate. + "caOptions": { # Describes the X.509 basic constraints extension, per [RFC 5280 section 4.2.1.9](https://tools.ietf.org/html/rfc5280#section-4.2.1.9) # Optional. Describes options in this X509Parameters that are relevant in a CA certificate. If not specified, a default basic constraints extension with `is_ca=false` will be added for leaf certificates. + "isCa": True or False, # Optional. Refers to the "CA" boolean field in the X.509 extension. When this value is missing, the basic constraints extension will be omitted from the certificate. + "maxIssuerPathLength": 42, # Optional. Refers to the path length constraint field in the X.509 extension. For a CA certificate, this value describes the depth of subordinate CA certificates that are allowed. If this value is less than 0, the request will fail. If this value is missing, the max path length will be omitted from the certificate. }, "keyUsage": { # A KeyUsage describes key usage values that may appear in an X.509 certificate. # Optional. Indicates the intended use for keys that correspond to a certificate. "baseKeyUsage": { # KeyUsage.KeyUsageOptions corresponds to the key usage values described in https://tools.ietf.org/html/rfc5280#section-4.2.1.3. # Describes high-level ways in which a key may be used. @@ -1745,9 +1745,9 @@

Method Details

"aiaOcspServers": [ # Optional. Describes Online Certificate Status Protocol (OCSP) endpoint addresses that appear in the "Authority Information Access" extension in the certificate. "A String", ], - "caOptions": { # Describes values that are relevant in a CA certificate. # Optional. Describes options in this X509Parameters that are relevant in a CA certificate. - "isCa": True or False, # Optional. Refers to the "CA" X.509 extension, which is a boolean value. When this value is missing, the extension will be omitted from the CA certificate. - "maxIssuerPathLength": 42, # Optional. Refers to the path length restriction X.509 extension. For a CA certificate, this value describes the depth of subordinate CA certificates that are allowed. If this value is less than 0, the request will fail. If this value is missing, the max path length will be omitted from the CA certificate. + "caOptions": { # Describes the X.509 basic constraints extension, per [RFC 5280 section 4.2.1.9](https://tools.ietf.org/html/rfc5280#section-4.2.1.9) # Optional. Describes options in this X509Parameters that are relevant in a CA certificate. If not specified, a default basic constraints extension with `is_ca=false` will be added for leaf certificates. + "isCa": True or False, # Optional. Refers to the "CA" boolean field in the X.509 extension. When this value is missing, the basic constraints extension will be omitted from the certificate. + "maxIssuerPathLength": 42, # Optional. Refers to the path length constraint field in the X.509 extension. For a CA certificate, this value describes the depth of subordinate CA certificates that are allowed. If this value is less than 0, the request will fail. If this value is missing, the max path length will be omitted from the certificate. }, "keyUsage": { # A KeyUsage describes key usage values that may appear in an X.509 certificate. # Optional. Indicates the intended use for keys that correspond to a certificate. "baseKeyUsage": { # KeyUsage.KeyUsageOptions corresponds to the key usage values described in https://tools.ietf.org/html/rfc5280#section-4.2.1.3. # Describes high-level ways in which a key may be used. @@ -1874,9 +1874,9 @@

Method Details

"aiaOcspServers": [ # Optional. Describes Online Certificate Status Protocol (OCSP) endpoint addresses that appear in the "Authority Information Access" extension in the certificate. "A String", ], - "caOptions": { # Describes values that are relevant in a CA certificate. # Optional. Describes options in this X509Parameters that are relevant in a CA certificate. - "isCa": True or False, # Optional. Refers to the "CA" X.509 extension, which is a boolean value. When this value is missing, the extension will be omitted from the CA certificate. - "maxIssuerPathLength": 42, # Optional. Refers to the path length restriction X.509 extension. For a CA certificate, this value describes the depth of subordinate CA certificates that are allowed. If this value is less than 0, the request will fail. If this value is missing, the max path length will be omitted from the CA certificate. + "caOptions": { # Describes the X.509 basic constraints extension, per [RFC 5280 section 4.2.1.9](https://tools.ietf.org/html/rfc5280#section-4.2.1.9) # Optional. Describes options in this X509Parameters that are relevant in a CA certificate. If not specified, a default basic constraints extension with `is_ca=false` will be added for leaf certificates. + "isCa": True or False, # Optional. Refers to the "CA" boolean field in the X.509 extension. When this value is missing, the basic constraints extension will be omitted from the certificate. + "maxIssuerPathLength": 42, # Optional. Refers to the path length constraint field in the X.509 extension. For a CA certificate, this value describes the depth of subordinate CA certificates that are allowed. If this value is less than 0, the request will fail. If this value is missing, the max path length will be omitted from the certificate. }, "keyUsage": { # A KeyUsage describes key usage values that may appear in an X.509 certificate. # Optional. Indicates the intended use for keys that correspond to a certificate. "baseKeyUsage": { # KeyUsage.KeyUsageOptions corresponds to the key usage values described in https://tools.ietf.org/html/rfc5280#section-4.2.1.3. # Describes high-level ways in which a key may be used. @@ -2062,9 +2062,9 @@

Method Details

"aiaOcspServers": [ # Optional. Describes Online Certificate Status Protocol (OCSP) endpoint addresses that appear in the "Authority Information Access" extension in the certificate. "A String", ], - "caOptions": { # Describes values that are relevant in a CA certificate. # Optional. Describes options in this X509Parameters that are relevant in a CA certificate. - "isCa": True or False, # Optional. Refers to the "CA" X.509 extension, which is a boolean value. When this value is missing, the extension will be omitted from the CA certificate. - "maxIssuerPathLength": 42, # Optional. Refers to the path length restriction X.509 extension. For a CA certificate, this value describes the depth of subordinate CA certificates that are allowed. If this value is less than 0, the request will fail. If this value is missing, the max path length will be omitted from the CA certificate. + "caOptions": { # Describes the X.509 basic constraints extension, per [RFC 5280 section 4.2.1.9](https://tools.ietf.org/html/rfc5280#section-4.2.1.9) # Optional. Describes options in this X509Parameters that are relevant in a CA certificate. If not specified, a default basic constraints extension with `is_ca=false` will be added for leaf certificates. + "isCa": True or False, # Optional. Refers to the "CA" boolean field in the X.509 extension. When this value is missing, the basic constraints extension will be omitted from the certificate. + "maxIssuerPathLength": 42, # Optional. Refers to the path length constraint field in the X.509 extension. For a CA certificate, this value describes the depth of subordinate CA certificates that are allowed. If this value is less than 0, the request will fail. If this value is missing, the max path length will be omitted from the certificate. }, "keyUsage": { # A KeyUsage describes key usage values that may appear in an X.509 certificate. # Optional. Indicates the intended use for keys that correspond to a certificate. "baseKeyUsage": { # KeyUsage.KeyUsageOptions corresponds to the key usage values described in https://tools.ietf.org/html/rfc5280#section-4.2.1.3. # Describes high-level ways in which a key may be used. @@ -2191,9 +2191,9 @@

Method Details

"aiaOcspServers": [ # Optional. Describes Online Certificate Status Protocol (OCSP) endpoint addresses that appear in the "Authority Information Access" extension in the certificate. "A String", ], - "caOptions": { # Describes values that are relevant in a CA certificate. # Optional. Describes options in this X509Parameters that are relevant in a CA certificate. - "isCa": True or False, # Optional. Refers to the "CA" X.509 extension, which is a boolean value. When this value is missing, the extension will be omitted from the CA certificate. - "maxIssuerPathLength": 42, # Optional. Refers to the path length restriction X.509 extension. For a CA certificate, this value describes the depth of subordinate CA certificates that are allowed. If this value is less than 0, the request will fail. If this value is missing, the max path length will be omitted from the CA certificate. + "caOptions": { # Describes the X.509 basic constraints extension, per [RFC 5280 section 4.2.1.9](https://tools.ietf.org/html/rfc5280#section-4.2.1.9) # Optional. Describes options in this X509Parameters that are relevant in a CA certificate. If not specified, a default basic constraints extension with `is_ca=false` will be added for leaf certificates. + "isCa": True or False, # Optional. Refers to the "CA" boolean field in the X.509 extension. When this value is missing, the basic constraints extension will be omitted from the certificate. + "maxIssuerPathLength": 42, # Optional. Refers to the path length constraint field in the X.509 extension. For a CA certificate, this value describes the depth of subordinate CA certificates that are allowed. If this value is less than 0, the request will fail. If this value is missing, the max path length will be omitted from the certificate. }, "keyUsage": { # A KeyUsage describes key usage values that may appear in an X.509 certificate. # Optional. Indicates the intended use for keys that correspond to a certificate. "baseKeyUsage": { # KeyUsage.KeyUsageOptions corresponds to the key usage values described in https://tools.ietf.org/html/rfc5280#section-4.2.1.3. # Describes high-level ways in which a key may be used. diff --git a/docs/dyn/privateca_v1.projects.locations.caPools.html b/docs/dyn/privateca_v1.projects.locations.caPools.html index e303600a0bd..f920bdc2c9a 100644 --- a/docs/dyn/privateca_v1.projects.locations.caPools.html +++ b/docs/dyn/privateca_v1.projects.locations.caPools.html @@ -164,9 +164,9 @@

Method Details

"aiaOcspServers": [ # Optional. Describes Online Certificate Status Protocol (OCSP) endpoint addresses that appear in the "Authority Information Access" extension in the certificate. "A String", ], - "caOptions": { # Describes values that are relevant in a CA certificate. # Optional. Describes options in this X509Parameters that are relevant in a CA certificate. - "isCa": True or False, # Optional. Refers to the "CA" X.509 extension, which is a boolean value. When this value is missing, the extension will be omitted from the CA certificate. - "maxIssuerPathLength": 42, # Optional. Refers to the path length restriction X.509 extension. For a CA certificate, this value describes the depth of subordinate CA certificates that are allowed. If this value is less than 0, the request will fail. If this value is missing, the max path length will be omitted from the CA certificate. + "caOptions": { # Describes the X.509 basic constraints extension, per [RFC 5280 section 4.2.1.9](https://tools.ietf.org/html/rfc5280#section-4.2.1.9) # Optional. Describes options in this X509Parameters that are relevant in a CA certificate. If not specified, a default basic constraints extension with `is_ca=false` will be added for leaf certificates. + "isCa": True or False, # Optional. Refers to the "CA" boolean field in the X.509 extension. When this value is missing, the basic constraints extension will be omitted from the certificate. + "maxIssuerPathLength": 42, # Optional. Refers to the path length constraint field in the X.509 extension. For a CA certificate, this value describes the depth of subordinate CA certificates that are allowed. If this value is less than 0, the request will fail. If this value is missing, the max path length will be omitted from the certificate. }, "keyUsage": { # A KeyUsage describes key usage values that may appear in an X.509 certificate. # Optional. Indicates the intended use for keys that correspond to a certificate. "baseKeyUsage": { # KeyUsage.KeyUsageOptions corresponds to the key usage values described in https://tools.ietf.org/html/rfc5280#section-4.2.1.3. # Describes high-level ways in which a key may be used. @@ -413,9 +413,9 @@

Method Details

"aiaOcspServers": [ # Optional. Describes Online Certificate Status Protocol (OCSP) endpoint addresses that appear in the "Authority Information Access" extension in the certificate. "A String", ], - "caOptions": { # Describes values that are relevant in a CA certificate. # Optional. Describes options in this X509Parameters that are relevant in a CA certificate. - "isCa": True or False, # Optional. Refers to the "CA" X.509 extension, which is a boolean value. When this value is missing, the extension will be omitted from the CA certificate. - "maxIssuerPathLength": 42, # Optional. Refers to the path length restriction X.509 extension. For a CA certificate, this value describes the depth of subordinate CA certificates that are allowed. If this value is less than 0, the request will fail. If this value is missing, the max path length will be omitted from the CA certificate. + "caOptions": { # Describes the X.509 basic constraints extension, per [RFC 5280 section 4.2.1.9](https://tools.ietf.org/html/rfc5280#section-4.2.1.9) # Optional. Describes options in this X509Parameters that are relevant in a CA certificate. If not specified, a default basic constraints extension with `is_ca=false` will be added for leaf certificates. + "isCa": True or False, # Optional. Refers to the "CA" boolean field in the X.509 extension. When this value is missing, the basic constraints extension will be omitted from the certificate. + "maxIssuerPathLength": 42, # Optional. Refers to the path length constraint field in the X.509 extension. For a CA certificate, this value describes the depth of subordinate CA certificates that are allowed. If this value is less than 0, the request will fail. If this value is missing, the max path length will be omitted from the certificate. }, "keyUsage": { # A KeyUsage describes key usage values that may appear in an X.509 certificate. # Optional. Indicates the intended use for keys that correspond to a certificate. "baseKeyUsage": { # KeyUsage.KeyUsageOptions corresponds to the key usage values described in https://tools.ietf.org/html/rfc5280#section-4.2.1.3. # Describes high-level ways in which a key may be used. @@ -617,9 +617,9 @@

Method Details

"aiaOcspServers": [ # Optional. Describes Online Certificate Status Protocol (OCSP) endpoint addresses that appear in the "Authority Information Access" extension in the certificate. "A String", ], - "caOptions": { # Describes values that are relevant in a CA certificate. # Optional. Describes options in this X509Parameters that are relevant in a CA certificate. - "isCa": True or False, # Optional. Refers to the "CA" X.509 extension, which is a boolean value. When this value is missing, the extension will be omitted from the CA certificate. - "maxIssuerPathLength": 42, # Optional. Refers to the path length restriction X.509 extension. For a CA certificate, this value describes the depth of subordinate CA certificates that are allowed. If this value is less than 0, the request will fail. If this value is missing, the max path length will be omitted from the CA certificate. + "caOptions": { # Describes the X.509 basic constraints extension, per [RFC 5280 section 4.2.1.9](https://tools.ietf.org/html/rfc5280#section-4.2.1.9) # Optional. Describes options in this X509Parameters that are relevant in a CA certificate. If not specified, a default basic constraints extension with `is_ca=false` will be added for leaf certificates. + "isCa": True or False, # Optional. Refers to the "CA" boolean field in the X.509 extension. When this value is missing, the basic constraints extension will be omitted from the certificate. + "maxIssuerPathLength": 42, # Optional. Refers to the path length constraint field in the X.509 extension. For a CA certificate, this value describes the depth of subordinate CA certificates that are allowed. If this value is less than 0, the request will fail. If this value is missing, the max path length will be omitted from the certificate. }, "keyUsage": { # A KeyUsage describes key usage values that may appear in an X.509 certificate. # Optional. Indicates the intended use for keys that correspond to a certificate. "baseKeyUsage": { # KeyUsage.KeyUsageOptions corresponds to the key usage values described in https://tools.ietf.org/html/rfc5280#section-4.2.1.3. # Describes high-level ways in which a key may be used. @@ -782,9 +782,9 @@

Method Details

"aiaOcspServers": [ # Optional. Describes Online Certificate Status Protocol (OCSP) endpoint addresses that appear in the "Authority Information Access" extension in the certificate. "A String", ], - "caOptions": { # Describes values that are relevant in a CA certificate. # Optional. Describes options in this X509Parameters that are relevant in a CA certificate. - "isCa": True or False, # Optional. Refers to the "CA" X.509 extension, which is a boolean value. When this value is missing, the extension will be omitted from the CA certificate. - "maxIssuerPathLength": 42, # Optional. Refers to the path length restriction X.509 extension. For a CA certificate, this value describes the depth of subordinate CA certificates that are allowed. If this value is less than 0, the request will fail. If this value is missing, the max path length will be omitted from the CA certificate. + "caOptions": { # Describes the X.509 basic constraints extension, per [RFC 5280 section 4.2.1.9](https://tools.ietf.org/html/rfc5280#section-4.2.1.9) # Optional. Describes options in this X509Parameters that are relevant in a CA certificate. If not specified, a default basic constraints extension with `is_ca=false` will be added for leaf certificates. + "isCa": True or False, # Optional. Refers to the "CA" boolean field in the X.509 extension. When this value is missing, the basic constraints extension will be omitted from the certificate. + "maxIssuerPathLength": 42, # Optional. Refers to the path length constraint field in the X.509 extension. For a CA certificate, this value describes the depth of subordinate CA certificates that are allowed. If this value is less than 0, the request will fail. If this value is missing, the max path length will be omitted from the certificate. }, "keyUsage": { # A KeyUsage describes key usage values that may appear in an X.509 certificate. # Optional. Indicates the intended use for keys that correspond to a certificate. "baseKeyUsage": { # KeyUsage.KeyUsageOptions corresponds to the key usage values described in https://tools.ietf.org/html/rfc5280#section-4.2.1.3. # Describes high-level ways in which a key may be used. diff --git a/docs/dyn/privateca_v1.projects.locations.certificateTemplates.html b/docs/dyn/privateca_v1.projects.locations.certificateTemplates.html index cc85803ce96..e3244ae7628 100644 --- a/docs/dyn/privateca_v1.projects.locations.certificateTemplates.html +++ b/docs/dyn/privateca_v1.projects.locations.certificateTemplates.html @@ -164,9 +164,9 @@

Method Details

"aiaOcspServers": [ # Optional. Describes Online Certificate Status Protocol (OCSP) endpoint addresses that appear in the "Authority Information Access" extension in the certificate. "A String", ], - "caOptions": { # Describes values that are relevant in a CA certificate. # Optional. Describes options in this X509Parameters that are relevant in a CA certificate. - "isCa": True or False, # Optional. Refers to the "CA" X.509 extension, which is a boolean value. When this value is missing, the extension will be omitted from the CA certificate. - "maxIssuerPathLength": 42, # Optional. Refers to the path length restriction X.509 extension. For a CA certificate, this value describes the depth of subordinate CA certificates that are allowed. If this value is less than 0, the request will fail. If this value is missing, the max path length will be omitted from the CA certificate. + "caOptions": { # Describes the X.509 basic constraints extension, per [RFC 5280 section 4.2.1.9](https://tools.ietf.org/html/rfc5280#section-4.2.1.9) # Optional. Describes options in this X509Parameters that are relevant in a CA certificate. If not specified, a default basic constraints extension with `is_ca=false` will be added for leaf certificates. + "isCa": True or False, # Optional. Refers to the "CA" boolean field in the X.509 extension. When this value is missing, the basic constraints extension will be omitted from the certificate. + "maxIssuerPathLength": 42, # Optional. Refers to the path length constraint field in the X.509 extension. For a CA certificate, this value describes the depth of subordinate CA certificates that are allowed. If this value is less than 0, the request will fail. If this value is missing, the max path length will be omitted from the certificate. }, "keyUsage": { # A KeyUsage describes key usage values that may appear in an X.509 certificate. # Optional. Indicates the intended use for keys that correspond to a certificate. "baseKeyUsage": { # KeyUsage.KeyUsageOptions corresponds to the key usage values described in https://tools.ietf.org/html/rfc5280#section-4.2.1.3. # Describes high-level ways in which a key may be used. @@ -360,9 +360,9 @@

Method Details

"aiaOcspServers": [ # Optional. Describes Online Certificate Status Protocol (OCSP) endpoint addresses that appear in the "Authority Information Access" extension in the certificate. "A String", ], - "caOptions": { # Describes values that are relevant in a CA certificate. # Optional. Describes options in this X509Parameters that are relevant in a CA certificate. - "isCa": True or False, # Optional. Refers to the "CA" X.509 extension, which is a boolean value. When this value is missing, the extension will be omitted from the CA certificate. - "maxIssuerPathLength": 42, # Optional. Refers to the path length restriction X.509 extension. For a CA certificate, this value describes the depth of subordinate CA certificates that are allowed. If this value is less than 0, the request will fail. If this value is missing, the max path length will be omitted from the CA certificate. + "caOptions": { # Describes the X.509 basic constraints extension, per [RFC 5280 section 4.2.1.9](https://tools.ietf.org/html/rfc5280#section-4.2.1.9) # Optional. Describes options in this X509Parameters that are relevant in a CA certificate. If not specified, a default basic constraints extension with `is_ca=false` will be added for leaf certificates. + "isCa": True or False, # Optional. Refers to the "CA" boolean field in the X.509 extension. When this value is missing, the basic constraints extension will be omitted from the certificate. + "maxIssuerPathLength": 42, # Optional. Refers to the path length constraint field in the X.509 extension. For a CA certificate, this value describes the depth of subordinate CA certificates that are allowed. If this value is less than 0, the request will fail. If this value is missing, the max path length will be omitted from the certificate. }, "keyUsage": { # A KeyUsage describes key usage values that may appear in an X.509 certificate. # Optional. Indicates the intended use for keys that correspond to a certificate. "baseKeyUsage": { # KeyUsage.KeyUsageOptions corresponds to the key usage values described in https://tools.ietf.org/html/rfc5280#section-4.2.1.3. # Describes high-level ways in which a key may be used. @@ -544,9 +544,9 @@

Method Details

"aiaOcspServers": [ # Optional. Describes Online Certificate Status Protocol (OCSP) endpoint addresses that appear in the "Authority Information Access" extension in the certificate. "A String", ], - "caOptions": { # Describes values that are relevant in a CA certificate. # Optional. Describes options in this X509Parameters that are relevant in a CA certificate. - "isCa": True or False, # Optional. Refers to the "CA" X.509 extension, which is a boolean value. When this value is missing, the extension will be omitted from the CA certificate. - "maxIssuerPathLength": 42, # Optional. Refers to the path length restriction X.509 extension. For a CA certificate, this value describes the depth of subordinate CA certificates that are allowed. If this value is less than 0, the request will fail. If this value is missing, the max path length will be omitted from the CA certificate. + "caOptions": { # Describes the X.509 basic constraints extension, per [RFC 5280 section 4.2.1.9](https://tools.ietf.org/html/rfc5280#section-4.2.1.9) # Optional. Describes options in this X509Parameters that are relevant in a CA certificate. If not specified, a default basic constraints extension with `is_ca=false` will be added for leaf certificates. + "isCa": True or False, # Optional. Refers to the "CA" boolean field in the X.509 extension. When this value is missing, the basic constraints extension will be omitted from the certificate. + "maxIssuerPathLength": 42, # Optional. Refers to the path length constraint field in the X.509 extension. For a CA certificate, this value describes the depth of subordinate CA certificates that are allowed. If this value is less than 0, the request will fail. If this value is missing, the max path length will be omitted from the certificate. }, "keyUsage": { # A KeyUsage describes key usage values that may appear in an X.509 certificate. # Optional. Indicates the intended use for keys that correspond to a certificate. "baseKeyUsage": { # KeyUsage.KeyUsageOptions corresponds to the key usage values described in https://tools.ietf.org/html/rfc5280#section-4.2.1.3. # Describes high-level ways in which a key may be used. @@ -689,9 +689,9 @@

Method Details

"aiaOcspServers": [ # Optional. Describes Online Certificate Status Protocol (OCSP) endpoint addresses that appear in the "Authority Information Access" extension in the certificate. "A String", ], - "caOptions": { # Describes values that are relevant in a CA certificate. # Optional. Describes options in this X509Parameters that are relevant in a CA certificate. - "isCa": True or False, # Optional. Refers to the "CA" X.509 extension, which is a boolean value. When this value is missing, the extension will be omitted from the CA certificate. - "maxIssuerPathLength": 42, # Optional. Refers to the path length restriction X.509 extension. For a CA certificate, this value describes the depth of subordinate CA certificates that are allowed. If this value is less than 0, the request will fail. If this value is missing, the max path length will be omitted from the CA certificate. + "caOptions": { # Describes the X.509 basic constraints extension, per [RFC 5280 section 4.2.1.9](https://tools.ietf.org/html/rfc5280#section-4.2.1.9) # Optional. Describes options in this X509Parameters that are relevant in a CA certificate. If not specified, a default basic constraints extension with `is_ca=false` will be added for leaf certificates. + "isCa": True or False, # Optional. Refers to the "CA" boolean field in the X.509 extension. When this value is missing, the basic constraints extension will be omitted from the certificate. + "maxIssuerPathLength": 42, # Optional. Refers to the path length constraint field in the X.509 extension. For a CA certificate, this value describes the depth of subordinate CA certificates that are allowed. If this value is less than 0, the request will fail. If this value is missing, the max path length will be omitted from the certificate. }, "keyUsage": { # A KeyUsage describes key usage values that may appear in an X.509 certificate. # Optional. Indicates the intended use for keys that correspond to a certificate. "baseKeyUsage": { # KeyUsage.KeyUsageOptions corresponds to the key usage values described in https://tools.ietf.org/html/rfc5280#section-4.2.1.3. # Describes high-level ways in which a key may be used. diff --git a/docs/dyn/pubsub_v1.projects.subscriptions.html b/docs/dyn/pubsub_v1.projects.subscriptions.html index 734d3b1968a..b680c627450 100644 --- a/docs/dyn/pubsub_v1.projects.subscriptions.html +++ b/docs/dyn/pubsub_v1.projects.subscriptions.html @@ -177,6 +177,7 @@

Method Details

}, "cloudStorageConfig": { # Configuration for a Cloud Storage subscription. # Optional. If delivery to Google Cloud Storage is used with this subscription, this field is used to configure it. "avroConfig": { # Configuration for writing message data in Avro format. Message payloads and metadata will be written to files as an Avro binary. # Optional. If set, message data will be written to Cloud Storage in Avro format. + "useTopicSchema": True or False, # Optional. When true, the output Cloud Storage file will be serialized using the topic schema, if it exists. "writeMetadata": True or False, # Optional. When true, write the subscription name, message_id, publish_time, attributes, and ordering_key as additional fields in the output. The subscription name, message_id, and publish_time fields are put in their own fields while all other message properties other than data (for example, an ordering_key, if present) are added as entries in the attributes map. }, "bucket": "A String", # Required. User-provided name for the Cloud Storage bucket. The bucket must be created by the user. The bucket name must be without any prefix like "gs://". See the [bucket naming requirements] (https://cloud.google.com/storage/docs/buckets#naming). @@ -252,6 +253,7 @@

Method Details

}, "cloudStorageConfig": { # Configuration for a Cloud Storage subscription. # Optional. If delivery to Google Cloud Storage is used with this subscription, this field is used to configure it. "avroConfig": { # Configuration for writing message data in Avro format. Message payloads and metadata will be written to files as an Avro binary. # Optional. If set, message data will be written to Cloud Storage in Avro format. + "useTopicSchema": True or False, # Optional. When true, the output Cloud Storage file will be serialized using the topic schema, if it exists. "writeMetadata": True or False, # Optional. When true, write the subscription name, message_id, publish_time, attributes, and ordering_key as additional fields in the output. The subscription name, message_id, and publish_time fields are put in their own fields while all other message properties other than data (for example, an ordering_key, if present) are added as entries in the attributes map. }, "bucket": "A String", # Required. User-provided name for the Cloud Storage bucket. The bucket must be created by the user. The bucket name must be without any prefix like "gs://". See the [bucket naming requirements] (https://cloud.google.com/storage/docs/buckets#naming). @@ -370,6 +372,7 @@

Method Details

}, "cloudStorageConfig": { # Configuration for a Cloud Storage subscription. # Optional. If delivery to Google Cloud Storage is used with this subscription, this field is used to configure it. "avroConfig": { # Configuration for writing message data in Avro format. Message payloads and metadata will be written to files as an Avro binary. # Optional. If set, message data will be written to Cloud Storage in Avro format. + "useTopicSchema": True or False, # Optional. When true, the output Cloud Storage file will be serialized using the topic schema, if it exists. "writeMetadata": True or False, # Optional. When true, write the subscription name, message_id, publish_time, attributes, and ordering_key as additional fields in the output. The subscription name, message_id, and publish_time fields are put in their own fields while all other message properties other than data (for example, an ordering_key, if present) are added as entries in the attributes map. }, "bucket": "A String", # Required. User-provided name for the Cloud Storage bucket. The bucket must be created by the user. The bucket name must be without any prefix like "gs://". See the [bucket naming requirements] (https://cloud.google.com/storage/docs/buckets#naming). @@ -492,6 +495,7 @@

Method Details

}, "cloudStorageConfig": { # Configuration for a Cloud Storage subscription. # Optional. If delivery to Google Cloud Storage is used with this subscription, this field is used to configure it. "avroConfig": { # Configuration for writing message data in Avro format. Message payloads and metadata will be written to files as an Avro binary. # Optional. If set, message data will be written to Cloud Storage in Avro format. + "useTopicSchema": True or False, # Optional. When true, the output Cloud Storage file will be serialized using the topic schema, if it exists. "writeMetadata": True or False, # Optional. When true, write the subscription name, message_id, publish_time, attributes, and ordering_key as additional fields in the output. The subscription name, message_id, and publish_time fields are put in their own fields while all other message properties other than data (for example, an ordering_key, if present) are added as entries in the attributes map. }, "bucket": "A String", # Required. User-provided name for the Cloud Storage bucket. The bucket must be created by the user. The bucket name must be without any prefix like "gs://". See the [bucket naming requirements] (https://cloud.google.com/storage/docs/buckets#naming). @@ -653,6 +657,7 @@

Method Details

}, "cloudStorageConfig": { # Configuration for a Cloud Storage subscription. # Optional. If delivery to Google Cloud Storage is used with this subscription, this field is used to configure it. "avroConfig": { # Configuration for writing message data in Avro format. Message payloads and metadata will be written to files as an Avro binary. # Optional. If set, message data will be written to Cloud Storage in Avro format. + "useTopicSchema": True or False, # Optional. When true, the output Cloud Storage file will be serialized using the topic schema, if it exists. "writeMetadata": True or False, # Optional. When true, write the subscription name, message_id, publish_time, attributes, and ordering_key as additional fields in the output. The subscription name, message_id, and publish_time fields are put in their own fields while all other message properties other than data (for example, an ordering_key, if present) are added as entries in the attributes map. }, "bucket": "A String", # Required. User-provided name for the Cloud Storage bucket. The bucket must be created by the user. The bucket name must be without any prefix like "gs://". See the [bucket naming requirements] (https://cloud.google.com/storage/docs/buckets#naming). @@ -730,6 +735,7 @@

Method Details

}, "cloudStorageConfig": { # Configuration for a Cloud Storage subscription. # Optional. If delivery to Google Cloud Storage is used with this subscription, this field is used to configure it. "avroConfig": { # Configuration for writing message data in Avro format. Message payloads and metadata will be written to files as an Avro binary. # Optional. If set, message data will be written to Cloud Storage in Avro format. + "useTopicSchema": True or False, # Optional. When true, the output Cloud Storage file will be serialized using the topic schema, if it exists. "writeMetadata": True or False, # Optional. When true, write the subscription name, message_id, publish_time, attributes, and ordering_key as additional fields in the output. The subscription name, message_id, and publish_time fields are put in their own fields while all other message properties other than data (for example, an ordering_key, if present) are added as entries in the attributes map. }, "bucket": "A String", # Required. User-provided name for the Cloud Storage bucket. The bucket must be created by the user. The bucket name must be without any prefix like "gs://". See the [bucket naming requirements] (https://cloud.google.com/storage/docs/buckets#naming). diff --git a/docs/dyn/redis_v1.projects.locations.clusters.html b/docs/dyn/redis_v1.projects.locations.clusters.html index aba222b8fa1..872bfafe01a 100644 --- a/docs/dyn/redis_v1.projects.locations.clusters.html +++ b/docs/dyn/redis_v1.projects.locations.clusters.html @@ -168,6 +168,10 @@

Method Details

}, "transitEncryptionMode": "A String", # Optional. The in-transit encryption for the Redis cluster. If not provided, encryption is disabled for the cluster. "uid": "A String", # Output only. System assigned, unique identifier for the cluster. + "zoneDistributionConfig": { # Zone distribution config for allocation of cluster resources. # Optional. This config will be used to determine how the customer wants us to distribute cluster resources within the region. + "mode": "A String", # Optional. The mode of zone distribution. Defaults to MULTI_ZONE, when not specified. + "zone": "A String", # Optional. When SINGLE ZONE distribution is selected, zone field would be used to allocate all resources in that zone. This is not applicable to MULTI_ZONE, and would be ignored for MULTI_ZONE clusters. + }, } clusterId: string, Required. The logical name of the Redis cluster in the customer project with the following restrictions: * Must contain only lowercase letters, numbers, and hyphens. * Must start with a letter. * Must be between 1-63 characters. * Must end with a number or a letter. * Must be unique within the customer project / location @@ -306,6 +310,10 @@

Method Details

}, "transitEncryptionMode": "A String", # Optional. The in-transit encryption for the Redis cluster. If not provided, encryption is disabled for the cluster. "uid": "A String", # Output only. System assigned, unique identifier for the cluster. + "zoneDistributionConfig": { # Zone distribution config for allocation of cluster resources. # Optional. This config will be used to determine how the customer wants us to distribute cluster resources within the region. + "mode": "A String", # Optional. The mode of zone distribution. Defaults to MULTI_ZONE, when not specified. + "zone": "A String", # Optional. When SINGLE ZONE distribution is selected, zone field would be used to allocate all resources in that zone. This is not applicable to MULTI_ZONE, and would be ignored for MULTI_ZONE clusters. + }, }
@@ -410,6 +418,10 @@

Method Details

}, "transitEncryptionMode": "A String", # Optional. The in-transit encryption for the Redis cluster. If not provided, encryption is disabled for the cluster. "uid": "A String", # Output only. System assigned, unique identifier for the cluster. + "zoneDistributionConfig": { # Zone distribution config for allocation of cluster resources. # Optional. This config will be used to determine how the customer wants us to distribute cluster resources within the region. + "mode": "A String", # Optional. The mode of zone distribution. Defaults to MULTI_ZONE, when not specified. + "zone": "A String", # Optional. When SINGLE ZONE distribution is selected, zone field would be used to allocate all resources in that zone. This is not applicable to MULTI_ZONE, and would be ignored for MULTI_ZONE clusters. + }, }, ], "nextPageToken": "A String", # Token to retrieve the next page of results, or empty if there are no more results in the list. @@ -497,6 +509,10 @@

Method Details

}, "transitEncryptionMode": "A String", # Optional. The in-transit encryption for the Redis cluster. If not provided, encryption is disabled for the cluster. "uid": "A String", # Output only. System assigned, unique identifier for the cluster. + "zoneDistributionConfig": { # Zone distribution config for allocation of cluster resources. # Optional. This config will be used to determine how the customer wants us to distribute cluster resources within the region. + "mode": "A String", # Optional. The mode of zone distribution. Defaults to MULTI_ZONE, when not specified. + "zone": "A String", # Optional. When SINGLE ZONE distribution is selected, zone field would be used to allocate all resources in that zone. This is not applicable to MULTI_ZONE, and would be ignored for MULTI_ZONE clusters. + }, } requestId: string, Idempotent request UUID. diff --git a/docs/dyn/redis_v1beta1.projects.locations.clusters.html b/docs/dyn/redis_v1beta1.projects.locations.clusters.html index 3c79cdfd036..7832c010f53 100644 --- a/docs/dyn/redis_v1beta1.projects.locations.clusters.html +++ b/docs/dyn/redis_v1beta1.projects.locations.clusters.html @@ -168,6 +168,10 @@

Method Details

}, "transitEncryptionMode": "A String", # Optional. The in-transit encryption for the Redis cluster. If not provided, encryption is disabled for the cluster. "uid": "A String", # Output only. System assigned, unique identifier for the cluster. + "zoneDistributionConfig": { # Zone distribution config for allocation of cluster resources. # Optional. This config will be used to determine how the customer wants us to distribute cluster resources within the region. + "mode": "A String", # Optional. The mode of zone distribution. Defaults to MULTI_ZONE, when not specified. + "zone": "A String", # Optional. When SINGLE ZONE distribution is selected, zone field would be used to allocate all resources in that zone. This is not applicable to MULTI_ZONE, and would be ignored for MULTI_ZONE clusters. + }, } clusterId: string, Required. The logical name of the Redis cluster in the customer project with the following restrictions: * Must contain only lowercase letters, numbers, and hyphens. * Must start with a letter. * Must be between 1-63 characters. * Must end with a number or a letter. * Must be unique within the customer project / location @@ -306,6 +310,10 @@

Method Details

}, "transitEncryptionMode": "A String", # Optional. The in-transit encryption for the Redis cluster. If not provided, encryption is disabled for the cluster. "uid": "A String", # Output only. System assigned, unique identifier for the cluster. + "zoneDistributionConfig": { # Zone distribution config for allocation of cluster resources. # Optional. This config will be used to determine how the customer wants us to distribute cluster resources within the region. + "mode": "A String", # Optional. The mode of zone distribution. Defaults to MULTI_ZONE, when not specified. + "zone": "A String", # Optional. When SINGLE ZONE distribution is selected, zone field would be used to allocate all resources in that zone. This is not applicable to MULTI_ZONE, and would be ignored for MULTI_ZONE clusters. + }, }
@@ -410,6 +418,10 @@

Method Details

}, "transitEncryptionMode": "A String", # Optional. The in-transit encryption for the Redis cluster. If not provided, encryption is disabled for the cluster. "uid": "A String", # Output only. System assigned, unique identifier for the cluster. + "zoneDistributionConfig": { # Zone distribution config for allocation of cluster resources. # Optional. This config will be used to determine how the customer wants us to distribute cluster resources within the region. + "mode": "A String", # Optional. The mode of zone distribution. Defaults to MULTI_ZONE, when not specified. + "zone": "A String", # Optional. When SINGLE ZONE distribution is selected, zone field would be used to allocate all resources in that zone. This is not applicable to MULTI_ZONE, and would be ignored for MULTI_ZONE clusters. + }, }, ], "nextPageToken": "A String", # Token to retrieve the next page of results, or empty if there are no more results in the list. @@ -497,6 +509,10 @@

Method Details

}, "transitEncryptionMode": "A String", # Optional. The in-transit encryption for the Redis cluster. If not provided, encryption is disabled for the cluster. "uid": "A String", # Output only. System assigned, unique identifier for the cluster. + "zoneDistributionConfig": { # Zone distribution config for allocation of cluster resources. # Optional. This config will be used to determine how the customer wants us to distribute cluster resources within the region. + "mode": "A String", # Optional. The mode of zone distribution. Defaults to MULTI_ZONE, when not specified. + "zone": "A String", # Optional. When SINGLE ZONE distribution is selected, zone field would be used to allocate all resources in that zone. This is not applicable to MULTI_ZONE, and would be ignored for MULTI_ZONE clusters. + }, } requestId: string, Idempotent request UUID. diff --git a/docs/dyn/servicemanagement_v1.services.configs.html b/docs/dyn/servicemanagement_v1.services.configs.html index 606a6f77bb1..6d3035fb2e4 100644 --- a/docs/dyn/servicemanagement_v1.services.configs.html +++ b/docs/dyn/servicemanagement_v1.services.configs.html @@ -335,7 +335,7 @@

Method Details

"http": { # Defines the HTTP configuration for an API service. It contains a list of HttpRule, each specifying the mapping of an RPC method to one or more HTTP REST API methods. # HTTP configuration. "fullyDecodeReservedExpansion": True or False, # When set to true, URL path parameters will be fully URI-decoded except in cases of single segment matches in reserved expansion, where "%2F" will be left encoded. The default behavior is to not decode RFC 6570 reserved characters in multi segment matches. "rules": [ # A list of HTTP configuration rules that apply to individual API methods. **NOTE:** All service configuration rules follow "last one wins" order. - { # # gRPC Transcoding gRPC Transcoding is a feature for mapping between a gRPC method and one or more HTTP REST endpoints. It allows developers to build a single API service that supports both gRPC APIs and REST APIs. Many systems, including [Google APIs](https://github.com/googleapis/googleapis), [Cloud Endpoints](https://cloud.google.com/endpoints), [gRPC Gateway](https://github.com/grpc-ecosystem/grpc-gateway), and [Envoy](https://github.com/envoyproxy/envoy) proxy support this feature and use it for large scale production services. `HttpRule` defines the schema of the gRPC/REST mapping. The mapping specifies how different portions of the gRPC request message are mapped to the URL path, URL query parameters, and HTTP request body. It also controls how the gRPC response message is mapped to the HTTP response body. `HttpRule` is typically specified as an `google.api.http` annotation on the gRPC method. Each mapping specifies a URL path template and an HTTP method. The path template may refer to one or more fields in the gRPC request message, as long as each field is a non-repeated field with a primitive (non-message) type. The path template controls how fields of the request message are mapped to the URL path. Example: service Messaging { rpc GetMessage(GetMessageRequest) returns (Message) { option (google.api.http) = { get: "/v1/{name=messages/*}" }; } } message GetMessageRequest { string name = 1; // Mapped to URL path. } message Message { string text = 1; // The resource content. } This enables an HTTP REST to gRPC mapping as below: HTTP | gRPC -----|----- `GET /v1/messages/123456` | `GetMessage(name: "messages/123456")` Any fields in the request message which are not bound by the path template automatically become HTTP query parameters if there is no HTTP request body. For example: service Messaging { rpc GetMessage(GetMessageRequest) returns (Message) { option (google.api.http) = { get:"/v1/messages/{message_id}" }; } } message GetMessageRequest { message SubMessage { string subfield = 1; } string message_id = 1; // Mapped to URL path. int64 revision = 2; // Mapped to URL query parameter `revision`. SubMessage sub = 3; // Mapped to URL query parameter `sub.subfield`. } This enables a HTTP JSON to RPC mapping as below: HTTP | gRPC -----|----- `GET /v1/messages/123456?revision=2&sub.subfield=foo` | `GetMessage(message_id: "123456" revision: 2 sub: SubMessage(subfield: "foo"))` Note that fields which are mapped to URL query parameters must have a primitive type or a repeated primitive type or a non-repeated message type. In the case of a repeated type, the parameter can be repeated in the URL as `...?param=A&param=B`. In the case of a message type, each field of the message is mapped to a separate parameter, such as `...?foo.a=A&foo.b=B&foo.c=C`. For HTTP methods that allow a request body, the `body` field specifies the mapping. Consider a REST update method on the message resource collection: service Messaging { rpc UpdateMessage(UpdateMessageRequest) returns (Message) { option (google.api.http) = { patch: "/v1/messages/{message_id}" body: "message" }; } } message UpdateMessageRequest { string message_id = 1; // mapped to the URL Message message = 2; // mapped to the body } The following HTTP JSON to RPC mapping is enabled, where the representation of the JSON in the request body is determined by protos JSON encoding: HTTP | gRPC -----|----- `PATCH /v1/messages/123456 { "text": "Hi!" }` | `UpdateMessage(message_id: "123456" message { text: "Hi!" })` The special name `*` can be used in the body mapping to define that every field not bound by the path template should be mapped to the request body. This enables the following alternative definition of the update method: service Messaging { rpc UpdateMessage(Message) returns (Message) { option (google.api.http) = { patch: "/v1/messages/{message_id}" body: "*" }; } } message Message { string message_id = 1; string text = 2; } The following HTTP JSON to RPC mapping is enabled: HTTP | gRPC -----|----- `PATCH /v1/messages/123456 { "text": "Hi!" }` | `UpdateMessage(message_id: "123456" text: "Hi!")` Note that when using `*` in the body mapping, it is not possible to have HTTP parameters, as all fields not bound by the path end in the body. This makes this option more rarely used in practice when defining REST APIs. The common usage of `*` is in custom methods which don't use the URL at all for transferring data. It is possible to define multiple HTTP methods for one RPC by using the `additional_bindings` option. Example: service Messaging { rpc GetMessage(GetMessageRequest) returns (Message) { option (google.api.http) = { get: "/v1/messages/{message_id}" additional_bindings { get: "/v1/users/{user_id}/messages/{message_id}" } }; } } message GetMessageRequest { string message_id = 1; string user_id = 2; } This enables the following two alternative HTTP JSON to RPC mappings: HTTP | gRPC -----|----- `GET /v1/messages/123456` | `GetMessage(message_id: "123456")` `GET /v1/users/me/messages/123456` | `GetMessage(user_id: "me" message_id: "123456")` ## Rules for HTTP mapping 1. Leaf request fields (recursive expansion nested messages in the request message) are classified into three categories: - Fields referred by the path template. They are passed via the URL path. - Fields referred by the HttpRule.body. They are passed via the HTTP request body. - All other fields are passed via the URL query parameters, and the parameter name is the field path in the request message. A repeated field can be represented as multiple query parameters under the same name. 2. If HttpRule.body is "*", there is no URL query parameter, all fields are passed via URL path and HTTP request body. 3. If HttpRule.body is omitted, there is no HTTP request body, all fields are passed via URL path and URL query parameters. ### Path template syntax Template = "/" Segments [ Verb ] ; Segments = Segment { "/" Segment } ; Segment = "*" | "**" | LITERAL | Variable ; Variable = "{" FieldPath [ "=" Segments ] "}" ; FieldPath = IDENT { "." IDENT } ; Verb = ":" LITERAL ; The syntax `*` matches a single URL path segment. The syntax `**` matches zero or more URL path segments, which must be the last part of the URL path except the `Verb`. The syntax `Variable` matches part of the URL path as specified by its template. A variable template must not contain other variables. If a variable matches a single path segment, its template may be omitted, e.g. `{var}` is equivalent to `{var=*}`. The syntax `LITERAL` matches literal text in the URL path. If the `LITERAL` contains any reserved character, such characters should be percent-encoded before the matching. If a variable contains exactly one path segment, such as `"{var}"` or `"{var=*}"`, when such a variable is expanded into a URL path on the client side, all characters except `[-_.~0-9a-zA-Z]` are percent-encoded. The server side does the reverse decoding. Such variables show up in the [Discovery Document](https://developers.google.com/discovery/v1/reference/apis) as `{var}`. If a variable contains multiple path segments, such as `"{var=foo/*}"` or `"{var=**}"`, when such a variable is expanded into a URL path on the client side, all characters except `[-_.~/0-9a-zA-Z]` are percent-encoded. The server side does the reverse decoding, except "%2F" and "%2f" are left unchanged. Such variables show up in the [Discovery Document](https://developers.google.com/discovery/v1/reference/apis) as `{+var}`. ## Using gRPC API Service Configuration gRPC API Service Configuration (service config) is a configuration language for configuring a gRPC service to become a user-facing product. The service config is simply the YAML representation of the `google.api.Service` proto message. As an alternative to annotating your proto file, you can configure gRPC transcoding in your service config YAML files. You do this by specifying a `HttpRule` that maps the gRPC method to a REST endpoint, achieving the same effect as the proto annotation. This can be particularly useful if you have a proto that is reused in multiple services. Note that any transcoding specified in the service config will override any matching transcoding configuration in the proto. Example: http: rules: # Selects a gRPC method and applies HttpRule to it. - selector: example.v1.Messaging.GetMessage get: /v1/messages/{message_id}/{sub.subfield} ## Special notes When gRPC Transcoding is used to map a gRPC to JSON REST endpoints, the proto to JSON conversion must follow the [proto3 specification](https://developers.google.com/protocol-buffers/docs/proto3#json). While the single segment variable follows the semantics of [RFC 6570](https://tools.ietf.org/html/rfc6570) Section 3.2.2 Simple String Expansion, the multi segment variable **does not** follow RFC 6570 Section 3.2.3 Reserved Expansion. The reason is that the Reserved Expansion does not expand special characters like `?` and `#`, which would lead to invalid URLs. As the result, gRPC Transcoding uses a custom encoding for multi segment variables. The path variables **must not** refer to any repeated or mapped field, because client libraries are not capable of handling such variable expansion. The path variables **must not** capture the leading "/" character. The reason is that the most common use case "{var}" does not capture the leading "/" character. For consistency, all path variables must share the same behavior. Repeated message fields must not be mapped to URL query parameters, because no client library can support such complicated mapping. If an API needs to use a JSON array for request or response body, it can map the request or response body to a repeated field. However, some gRPC Transcoding implementations may not support this feature. + { # gRPC Transcoding gRPC Transcoding is a feature for mapping between a gRPC method and one or more HTTP REST endpoints. It allows developers to build a single API service that supports both gRPC APIs and REST APIs. Many systems, including [Google APIs](https://github.com/googleapis/googleapis), [Cloud Endpoints](https://cloud.google.com/endpoints), [gRPC Gateway](https://github.com/grpc-ecosystem/grpc-gateway), and [Envoy](https://github.com/envoyproxy/envoy) proxy support this feature and use it for large scale production services. `HttpRule` defines the schema of the gRPC/REST mapping. The mapping specifies how different portions of the gRPC request message are mapped to the URL path, URL query parameters, and HTTP request body. It also controls how the gRPC response message is mapped to the HTTP response body. `HttpRule` is typically specified as an `google.api.http` annotation on the gRPC method. Each mapping specifies a URL path template and an HTTP method. The path template may refer to one or more fields in the gRPC request message, as long as each field is a non-repeated field with a primitive (non-message) type. The path template controls how fields of the request message are mapped to the URL path. Example: service Messaging { rpc GetMessage(GetMessageRequest) returns (Message) { option (google.api.http) = { get: "/v1/{name=messages/*}" }; } } message GetMessageRequest { string name = 1; // Mapped to URL path. } message Message { string text = 1; // The resource content. } This enables an HTTP REST to gRPC mapping as below: - HTTP: `GET /v1/messages/123456` - gRPC: `GetMessage(name: "messages/123456")` Any fields in the request message which are not bound by the path template automatically become HTTP query parameters if there is no HTTP request body. For example: service Messaging { rpc GetMessage(GetMessageRequest) returns (Message) { option (google.api.http) = { get:"/v1/messages/{message_id}" }; } } message GetMessageRequest { message SubMessage { string subfield = 1; } string message_id = 1; // Mapped to URL path. int64 revision = 2; // Mapped to URL query parameter `revision`. SubMessage sub = 3; // Mapped to URL query parameter `sub.subfield`. } This enables a HTTP JSON to RPC mapping as below: - HTTP: `GET /v1/messages/123456?revision=2&sub.subfield=foo` - gRPC: `GetMessage(message_id: "123456" revision: 2 sub: SubMessage(subfield: "foo"))` Note that fields which are mapped to URL query parameters must have a primitive type or a repeated primitive type or a non-repeated message type. In the case of a repeated type, the parameter can be repeated in the URL as `...?param=A&param=B`. In the case of a message type, each field of the message is mapped to a separate parameter, such as `...?foo.a=A&foo.b=B&foo.c=C`. For HTTP methods that allow a request body, the `body` field specifies the mapping. Consider a REST update method on the message resource collection: service Messaging { rpc UpdateMessage(UpdateMessageRequest) returns (Message) { option (google.api.http) = { patch: "/v1/messages/{message_id}" body: "message" }; } } message UpdateMessageRequest { string message_id = 1; // mapped to the URL Message message = 2; // mapped to the body } The following HTTP JSON to RPC mapping is enabled, where the representation of the JSON in the request body is determined by protos JSON encoding: - HTTP: `PATCH /v1/messages/123456 { "text": "Hi!" }` - gRPC: `UpdateMessage(message_id: "123456" message { text: "Hi!" })` The special name `*` can be used in the body mapping to define that every field not bound by the path template should be mapped to the request body. This enables the following alternative definition of the update method: service Messaging { rpc UpdateMessage(Message) returns (Message) { option (google.api.http) = { patch: "/v1/messages/{message_id}" body: "*" }; } } message Message { string message_id = 1; string text = 2; } The following HTTP JSON to RPC mapping is enabled: - HTTP: `PATCH /v1/messages/123456 { "text": "Hi!" }` - gRPC: `UpdateMessage(message_id: "123456" text: "Hi!")` Note that when using `*` in the body mapping, it is not possible to have HTTP parameters, as all fields not bound by the path end in the body. This makes this option more rarely used in practice when defining REST APIs. The common usage of `*` is in custom methods which don't use the URL at all for transferring data. It is possible to define multiple HTTP methods for one RPC by using the `additional_bindings` option. Example: service Messaging { rpc GetMessage(GetMessageRequest) returns (Message) { option (google.api.http) = { get: "/v1/messages/{message_id}" additional_bindings { get: "/v1/users/{user_id}/messages/{message_id}" } }; } } message GetMessageRequest { string message_id = 1; string user_id = 2; } This enables the following two alternative HTTP JSON to RPC mappings: - HTTP: `GET /v1/messages/123456` - gRPC: `GetMessage(message_id: "123456")` - HTTP: `GET /v1/users/me/messages/123456` - gRPC: `GetMessage(user_id: "me" message_id: "123456")` Rules for HTTP mapping 1. Leaf request fields (recursive expansion nested messages in the request message) are classified into three categories: - Fields referred by the path template. They are passed via the URL path. - Fields referred by the HttpRule.body. They are passed via the HTTP request body. - All other fields are passed via the URL query parameters, and the parameter name is the field path in the request message. A repeated field can be represented as multiple query parameters under the same name. 2. If HttpRule.body is "*", there is no URL query parameter, all fields are passed via URL path and HTTP request body. 3. If HttpRule.body is omitted, there is no HTTP request body, all fields are passed via URL path and URL query parameters. Path template syntax Template = "/" Segments [ Verb ] ; Segments = Segment { "/" Segment } ; Segment = "*" | "**" | LITERAL | Variable ; Variable = "{" FieldPath [ "=" Segments ] "}" ; FieldPath = IDENT { "." IDENT } ; Verb = ":" LITERAL ; The syntax `*` matches a single URL path segment. The syntax `**` matches zero or more URL path segments, which must be the last part of the URL path except the `Verb`. The syntax `Variable` matches part of the URL path as specified by its template. A variable template must not contain other variables. If a variable matches a single path segment, its template may be omitted, e.g. `{var}` is equivalent to `{var=*}`. The syntax `LITERAL` matches literal text in the URL path. If the `LITERAL` contains any reserved character, such characters should be percent-encoded before the matching. If a variable contains exactly one path segment, such as `"{var}"` or `"{var=*}"`, when such a variable is expanded into a URL path on the client side, all characters except `[-_.~0-9a-zA-Z]` are percent-encoded. The server side does the reverse decoding. Such variables show up in the [Discovery Document](https://developers.google.com/discovery/v1/reference/apis) as `{var}`. If a variable contains multiple path segments, such as `"{var=foo/*}"` or `"{var=**}"`, when such a variable is expanded into a URL path on the client side, all characters except `[-_.~/0-9a-zA-Z]` are percent-encoded. The server side does the reverse decoding, except "%2F" and "%2f" are left unchanged. Such variables show up in the [Discovery Document](https://developers.google.com/discovery/v1/reference/apis) as `{+var}`. Using gRPC API Service Configuration gRPC API Service Configuration (service config) is a configuration language for configuring a gRPC service to become a user-facing product. The service config is simply the YAML representation of the `google.api.Service` proto message. As an alternative to annotating your proto file, you can configure gRPC transcoding in your service config YAML files. You do this by specifying a `HttpRule` that maps the gRPC method to a REST endpoint, achieving the same effect as the proto annotation. This can be particularly useful if you have a proto that is reused in multiple services. Note that any transcoding specified in the service config will override any matching transcoding configuration in the proto. Example below selects a gRPC method and applies HttpRule to it. http: rules: - selector: example.v1.Messaging.GetMessage get: /v1/messages/{message_id}/{sub.subfield} Special notes When gRPC Transcoding is used to map a gRPC to JSON REST endpoints, the proto to JSON conversion must follow the [proto3 specification](https://developers.google.com/protocol-buffers/docs/proto3#json). While the single segment variable follows the semantics of [RFC 6570](https://tools.ietf.org/html/rfc6570) Section 3.2.2 Simple String Expansion, the multi segment variable **does not** follow RFC 6570 Section 3.2.3 Reserved Expansion. The reason is that the Reserved Expansion does not expand special characters like `?` and `#`, which would lead to invalid URLs. As the result, gRPC Transcoding uses a custom encoding for multi segment variables. The path variables **must not** refer to any repeated or mapped field, because client libraries are not capable of handling such variable expansion. The path variables **must not** capture the leading "/" character. The reason is that the most common use case "{var}" does not capture the leading "/" character. For consistency, all path variables must share the same behavior. Repeated message fields must not be mapped to URL query parameters, because no client library can support such complicated mapping. If an API needs to use a JSON array for request or response body, it can map the request or response body to a repeated field. However, some gRPC Transcoding implementations may not support this feature. "additionalBindings": [ # Additional HTTP bindings for the selector. Nested bindings must not contain an `additional_bindings` field themselves (that is, the nesting may only be one level deep). # Object with schema name: HttpRule ], @@ -950,7 +950,7 @@

Method Details

"http": { # Defines the HTTP configuration for an API service. It contains a list of HttpRule, each specifying the mapping of an RPC method to one or more HTTP REST API methods. # HTTP configuration. "fullyDecodeReservedExpansion": True or False, # When set to true, URL path parameters will be fully URI-decoded except in cases of single segment matches in reserved expansion, where "%2F" will be left encoded. The default behavior is to not decode RFC 6570 reserved characters in multi segment matches. "rules": [ # A list of HTTP configuration rules that apply to individual API methods. **NOTE:** All service configuration rules follow "last one wins" order. - { # # gRPC Transcoding gRPC Transcoding is a feature for mapping between a gRPC method and one or more HTTP REST endpoints. It allows developers to build a single API service that supports both gRPC APIs and REST APIs. Many systems, including [Google APIs](https://github.com/googleapis/googleapis), [Cloud Endpoints](https://cloud.google.com/endpoints), [gRPC Gateway](https://github.com/grpc-ecosystem/grpc-gateway), and [Envoy](https://github.com/envoyproxy/envoy) proxy support this feature and use it for large scale production services. `HttpRule` defines the schema of the gRPC/REST mapping. The mapping specifies how different portions of the gRPC request message are mapped to the URL path, URL query parameters, and HTTP request body. It also controls how the gRPC response message is mapped to the HTTP response body. `HttpRule` is typically specified as an `google.api.http` annotation on the gRPC method. Each mapping specifies a URL path template and an HTTP method. The path template may refer to one or more fields in the gRPC request message, as long as each field is a non-repeated field with a primitive (non-message) type. The path template controls how fields of the request message are mapped to the URL path. Example: service Messaging { rpc GetMessage(GetMessageRequest) returns (Message) { option (google.api.http) = { get: "/v1/{name=messages/*}" }; } } message GetMessageRequest { string name = 1; // Mapped to URL path. } message Message { string text = 1; // The resource content. } This enables an HTTP REST to gRPC mapping as below: HTTP | gRPC -----|----- `GET /v1/messages/123456` | `GetMessage(name: "messages/123456")` Any fields in the request message which are not bound by the path template automatically become HTTP query parameters if there is no HTTP request body. For example: service Messaging { rpc GetMessage(GetMessageRequest) returns (Message) { option (google.api.http) = { get:"/v1/messages/{message_id}" }; } } message GetMessageRequest { message SubMessage { string subfield = 1; } string message_id = 1; // Mapped to URL path. int64 revision = 2; // Mapped to URL query parameter `revision`. SubMessage sub = 3; // Mapped to URL query parameter `sub.subfield`. } This enables a HTTP JSON to RPC mapping as below: HTTP | gRPC -----|----- `GET /v1/messages/123456?revision=2&sub.subfield=foo` | `GetMessage(message_id: "123456" revision: 2 sub: SubMessage(subfield: "foo"))` Note that fields which are mapped to URL query parameters must have a primitive type or a repeated primitive type or a non-repeated message type. In the case of a repeated type, the parameter can be repeated in the URL as `...?param=A&param=B`. In the case of a message type, each field of the message is mapped to a separate parameter, such as `...?foo.a=A&foo.b=B&foo.c=C`. For HTTP methods that allow a request body, the `body` field specifies the mapping. Consider a REST update method on the message resource collection: service Messaging { rpc UpdateMessage(UpdateMessageRequest) returns (Message) { option (google.api.http) = { patch: "/v1/messages/{message_id}" body: "message" }; } } message UpdateMessageRequest { string message_id = 1; // mapped to the URL Message message = 2; // mapped to the body } The following HTTP JSON to RPC mapping is enabled, where the representation of the JSON in the request body is determined by protos JSON encoding: HTTP | gRPC -----|----- `PATCH /v1/messages/123456 { "text": "Hi!" }` | `UpdateMessage(message_id: "123456" message { text: "Hi!" })` The special name `*` can be used in the body mapping to define that every field not bound by the path template should be mapped to the request body. This enables the following alternative definition of the update method: service Messaging { rpc UpdateMessage(Message) returns (Message) { option (google.api.http) = { patch: "/v1/messages/{message_id}" body: "*" }; } } message Message { string message_id = 1; string text = 2; } The following HTTP JSON to RPC mapping is enabled: HTTP | gRPC -----|----- `PATCH /v1/messages/123456 { "text": "Hi!" }` | `UpdateMessage(message_id: "123456" text: "Hi!")` Note that when using `*` in the body mapping, it is not possible to have HTTP parameters, as all fields not bound by the path end in the body. This makes this option more rarely used in practice when defining REST APIs. The common usage of `*` is in custom methods which don't use the URL at all for transferring data. It is possible to define multiple HTTP methods for one RPC by using the `additional_bindings` option. Example: service Messaging { rpc GetMessage(GetMessageRequest) returns (Message) { option (google.api.http) = { get: "/v1/messages/{message_id}" additional_bindings { get: "/v1/users/{user_id}/messages/{message_id}" } }; } } message GetMessageRequest { string message_id = 1; string user_id = 2; } This enables the following two alternative HTTP JSON to RPC mappings: HTTP | gRPC -----|----- `GET /v1/messages/123456` | `GetMessage(message_id: "123456")` `GET /v1/users/me/messages/123456` | `GetMessage(user_id: "me" message_id: "123456")` ## Rules for HTTP mapping 1. Leaf request fields (recursive expansion nested messages in the request message) are classified into three categories: - Fields referred by the path template. They are passed via the URL path. - Fields referred by the HttpRule.body. They are passed via the HTTP request body. - All other fields are passed via the URL query parameters, and the parameter name is the field path in the request message. A repeated field can be represented as multiple query parameters under the same name. 2. If HttpRule.body is "*", there is no URL query parameter, all fields are passed via URL path and HTTP request body. 3. If HttpRule.body is omitted, there is no HTTP request body, all fields are passed via URL path and URL query parameters. ### Path template syntax Template = "/" Segments [ Verb ] ; Segments = Segment { "/" Segment } ; Segment = "*" | "**" | LITERAL | Variable ; Variable = "{" FieldPath [ "=" Segments ] "}" ; FieldPath = IDENT { "." IDENT } ; Verb = ":" LITERAL ; The syntax `*` matches a single URL path segment. The syntax `**` matches zero or more URL path segments, which must be the last part of the URL path except the `Verb`. The syntax `Variable` matches part of the URL path as specified by its template. A variable template must not contain other variables. If a variable matches a single path segment, its template may be omitted, e.g. `{var}` is equivalent to `{var=*}`. The syntax `LITERAL` matches literal text in the URL path. If the `LITERAL` contains any reserved character, such characters should be percent-encoded before the matching. If a variable contains exactly one path segment, such as `"{var}"` or `"{var=*}"`, when such a variable is expanded into a URL path on the client side, all characters except `[-_.~0-9a-zA-Z]` are percent-encoded. The server side does the reverse decoding. Such variables show up in the [Discovery Document](https://developers.google.com/discovery/v1/reference/apis) as `{var}`. If a variable contains multiple path segments, such as `"{var=foo/*}"` or `"{var=**}"`, when such a variable is expanded into a URL path on the client side, all characters except `[-_.~/0-9a-zA-Z]` are percent-encoded. The server side does the reverse decoding, except "%2F" and "%2f" are left unchanged. Such variables show up in the [Discovery Document](https://developers.google.com/discovery/v1/reference/apis) as `{+var}`. ## Using gRPC API Service Configuration gRPC API Service Configuration (service config) is a configuration language for configuring a gRPC service to become a user-facing product. The service config is simply the YAML representation of the `google.api.Service` proto message. As an alternative to annotating your proto file, you can configure gRPC transcoding in your service config YAML files. You do this by specifying a `HttpRule` that maps the gRPC method to a REST endpoint, achieving the same effect as the proto annotation. This can be particularly useful if you have a proto that is reused in multiple services. Note that any transcoding specified in the service config will override any matching transcoding configuration in the proto. Example: http: rules: # Selects a gRPC method and applies HttpRule to it. - selector: example.v1.Messaging.GetMessage get: /v1/messages/{message_id}/{sub.subfield} ## Special notes When gRPC Transcoding is used to map a gRPC to JSON REST endpoints, the proto to JSON conversion must follow the [proto3 specification](https://developers.google.com/protocol-buffers/docs/proto3#json). While the single segment variable follows the semantics of [RFC 6570](https://tools.ietf.org/html/rfc6570) Section 3.2.2 Simple String Expansion, the multi segment variable **does not** follow RFC 6570 Section 3.2.3 Reserved Expansion. The reason is that the Reserved Expansion does not expand special characters like `?` and `#`, which would lead to invalid URLs. As the result, gRPC Transcoding uses a custom encoding for multi segment variables. The path variables **must not** refer to any repeated or mapped field, because client libraries are not capable of handling such variable expansion. The path variables **must not** capture the leading "/" character. The reason is that the most common use case "{var}" does not capture the leading "/" character. For consistency, all path variables must share the same behavior. Repeated message fields must not be mapped to URL query parameters, because no client library can support such complicated mapping. If an API needs to use a JSON array for request or response body, it can map the request or response body to a repeated field. However, some gRPC Transcoding implementations may not support this feature. + { # gRPC Transcoding gRPC Transcoding is a feature for mapping between a gRPC method and one or more HTTP REST endpoints. It allows developers to build a single API service that supports both gRPC APIs and REST APIs. Many systems, including [Google APIs](https://github.com/googleapis/googleapis), [Cloud Endpoints](https://cloud.google.com/endpoints), [gRPC Gateway](https://github.com/grpc-ecosystem/grpc-gateway), and [Envoy](https://github.com/envoyproxy/envoy) proxy support this feature and use it for large scale production services. `HttpRule` defines the schema of the gRPC/REST mapping. The mapping specifies how different portions of the gRPC request message are mapped to the URL path, URL query parameters, and HTTP request body. It also controls how the gRPC response message is mapped to the HTTP response body. `HttpRule` is typically specified as an `google.api.http` annotation on the gRPC method. Each mapping specifies a URL path template and an HTTP method. The path template may refer to one or more fields in the gRPC request message, as long as each field is a non-repeated field with a primitive (non-message) type. The path template controls how fields of the request message are mapped to the URL path. Example: service Messaging { rpc GetMessage(GetMessageRequest) returns (Message) { option (google.api.http) = { get: "/v1/{name=messages/*}" }; } } message GetMessageRequest { string name = 1; // Mapped to URL path. } message Message { string text = 1; // The resource content. } This enables an HTTP REST to gRPC mapping as below: - HTTP: `GET /v1/messages/123456` - gRPC: `GetMessage(name: "messages/123456")` Any fields in the request message which are not bound by the path template automatically become HTTP query parameters if there is no HTTP request body. For example: service Messaging { rpc GetMessage(GetMessageRequest) returns (Message) { option (google.api.http) = { get:"/v1/messages/{message_id}" }; } } message GetMessageRequest { message SubMessage { string subfield = 1; } string message_id = 1; // Mapped to URL path. int64 revision = 2; // Mapped to URL query parameter `revision`. SubMessage sub = 3; // Mapped to URL query parameter `sub.subfield`. } This enables a HTTP JSON to RPC mapping as below: - HTTP: `GET /v1/messages/123456?revision=2&sub.subfield=foo` - gRPC: `GetMessage(message_id: "123456" revision: 2 sub: SubMessage(subfield: "foo"))` Note that fields which are mapped to URL query parameters must have a primitive type or a repeated primitive type or a non-repeated message type. In the case of a repeated type, the parameter can be repeated in the URL as `...?param=A&param=B`. In the case of a message type, each field of the message is mapped to a separate parameter, such as `...?foo.a=A&foo.b=B&foo.c=C`. For HTTP methods that allow a request body, the `body` field specifies the mapping. Consider a REST update method on the message resource collection: service Messaging { rpc UpdateMessage(UpdateMessageRequest) returns (Message) { option (google.api.http) = { patch: "/v1/messages/{message_id}" body: "message" }; } } message UpdateMessageRequest { string message_id = 1; // mapped to the URL Message message = 2; // mapped to the body } The following HTTP JSON to RPC mapping is enabled, where the representation of the JSON in the request body is determined by protos JSON encoding: - HTTP: `PATCH /v1/messages/123456 { "text": "Hi!" }` - gRPC: `UpdateMessage(message_id: "123456" message { text: "Hi!" })` The special name `*` can be used in the body mapping to define that every field not bound by the path template should be mapped to the request body. This enables the following alternative definition of the update method: service Messaging { rpc UpdateMessage(Message) returns (Message) { option (google.api.http) = { patch: "/v1/messages/{message_id}" body: "*" }; } } message Message { string message_id = 1; string text = 2; } The following HTTP JSON to RPC mapping is enabled: - HTTP: `PATCH /v1/messages/123456 { "text": "Hi!" }` - gRPC: `UpdateMessage(message_id: "123456" text: "Hi!")` Note that when using `*` in the body mapping, it is not possible to have HTTP parameters, as all fields not bound by the path end in the body. This makes this option more rarely used in practice when defining REST APIs. The common usage of `*` is in custom methods which don't use the URL at all for transferring data. It is possible to define multiple HTTP methods for one RPC by using the `additional_bindings` option. Example: service Messaging { rpc GetMessage(GetMessageRequest) returns (Message) { option (google.api.http) = { get: "/v1/messages/{message_id}" additional_bindings { get: "/v1/users/{user_id}/messages/{message_id}" } }; } } message GetMessageRequest { string message_id = 1; string user_id = 2; } This enables the following two alternative HTTP JSON to RPC mappings: - HTTP: `GET /v1/messages/123456` - gRPC: `GetMessage(message_id: "123456")` - HTTP: `GET /v1/users/me/messages/123456` - gRPC: `GetMessage(user_id: "me" message_id: "123456")` Rules for HTTP mapping 1. Leaf request fields (recursive expansion nested messages in the request message) are classified into three categories: - Fields referred by the path template. They are passed via the URL path. - Fields referred by the HttpRule.body. They are passed via the HTTP request body. - All other fields are passed via the URL query parameters, and the parameter name is the field path in the request message. A repeated field can be represented as multiple query parameters under the same name. 2. If HttpRule.body is "*", there is no URL query parameter, all fields are passed via URL path and HTTP request body. 3. If HttpRule.body is omitted, there is no HTTP request body, all fields are passed via URL path and URL query parameters. Path template syntax Template = "/" Segments [ Verb ] ; Segments = Segment { "/" Segment } ; Segment = "*" | "**" | LITERAL | Variable ; Variable = "{" FieldPath [ "=" Segments ] "}" ; FieldPath = IDENT { "." IDENT } ; Verb = ":" LITERAL ; The syntax `*` matches a single URL path segment. The syntax `**` matches zero or more URL path segments, which must be the last part of the URL path except the `Verb`. The syntax `Variable` matches part of the URL path as specified by its template. A variable template must not contain other variables. If a variable matches a single path segment, its template may be omitted, e.g. `{var}` is equivalent to `{var=*}`. The syntax `LITERAL` matches literal text in the URL path. If the `LITERAL` contains any reserved character, such characters should be percent-encoded before the matching. If a variable contains exactly one path segment, such as `"{var}"` or `"{var=*}"`, when such a variable is expanded into a URL path on the client side, all characters except `[-_.~0-9a-zA-Z]` are percent-encoded. The server side does the reverse decoding. Such variables show up in the [Discovery Document](https://developers.google.com/discovery/v1/reference/apis) as `{var}`. If a variable contains multiple path segments, such as `"{var=foo/*}"` or `"{var=**}"`, when such a variable is expanded into a URL path on the client side, all characters except `[-_.~/0-9a-zA-Z]` are percent-encoded. The server side does the reverse decoding, except "%2F" and "%2f" are left unchanged. Such variables show up in the [Discovery Document](https://developers.google.com/discovery/v1/reference/apis) as `{+var}`. Using gRPC API Service Configuration gRPC API Service Configuration (service config) is a configuration language for configuring a gRPC service to become a user-facing product. The service config is simply the YAML representation of the `google.api.Service` proto message. As an alternative to annotating your proto file, you can configure gRPC transcoding in your service config YAML files. You do this by specifying a `HttpRule` that maps the gRPC method to a REST endpoint, achieving the same effect as the proto annotation. This can be particularly useful if you have a proto that is reused in multiple services. Note that any transcoding specified in the service config will override any matching transcoding configuration in the proto. Example below selects a gRPC method and applies HttpRule to it. http: rules: - selector: example.v1.Messaging.GetMessage get: /v1/messages/{message_id}/{sub.subfield} Special notes When gRPC Transcoding is used to map a gRPC to JSON REST endpoints, the proto to JSON conversion must follow the [proto3 specification](https://developers.google.com/protocol-buffers/docs/proto3#json). While the single segment variable follows the semantics of [RFC 6570](https://tools.ietf.org/html/rfc6570) Section 3.2.2 Simple String Expansion, the multi segment variable **does not** follow RFC 6570 Section 3.2.3 Reserved Expansion. The reason is that the Reserved Expansion does not expand special characters like `?` and `#`, which would lead to invalid URLs. As the result, gRPC Transcoding uses a custom encoding for multi segment variables. The path variables **must not** refer to any repeated or mapped field, because client libraries are not capable of handling such variable expansion. The path variables **must not** capture the leading "/" character. The reason is that the most common use case "{var}" does not capture the leading "/" character. For consistency, all path variables must share the same behavior. Repeated message fields must not be mapped to URL query parameters, because no client library can support such complicated mapping. If an API needs to use a JSON array for request or response body, it can map the request or response body to a repeated field. However, some gRPC Transcoding implementations may not support this feature. "additionalBindings": [ # Additional HTTP bindings for the selector. Nested bindings must not contain an `additional_bindings` field themselves (that is, the nesting may only be one level deep). # Object with schema name: HttpRule ], @@ -1577,7 +1577,7 @@

Method Details

"http": { # Defines the HTTP configuration for an API service. It contains a list of HttpRule, each specifying the mapping of an RPC method to one or more HTTP REST API methods. # HTTP configuration. "fullyDecodeReservedExpansion": True or False, # When set to true, URL path parameters will be fully URI-decoded except in cases of single segment matches in reserved expansion, where "%2F" will be left encoded. The default behavior is to not decode RFC 6570 reserved characters in multi segment matches. "rules": [ # A list of HTTP configuration rules that apply to individual API methods. **NOTE:** All service configuration rules follow "last one wins" order. - { # # gRPC Transcoding gRPC Transcoding is a feature for mapping between a gRPC method and one or more HTTP REST endpoints. It allows developers to build a single API service that supports both gRPC APIs and REST APIs. Many systems, including [Google APIs](https://github.com/googleapis/googleapis), [Cloud Endpoints](https://cloud.google.com/endpoints), [gRPC Gateway](https://github.com/grpc-ecosystem/grpc-gateway), and [Envoy](https://github.com/envoyproxy/envoy) proxy support this feature and use it for large scale production services. `HttpRule` defines the schema of the gRPC/REST mapping. The mapping specifies how different portions of the gRPC request message are mapped to the URL path, URL query parameters, and HTTP request body. It also controls how the gRPC response message is mapped to the HTTP response body. `HttpRule` is typically specified as an `google.api.http` annotation on the gRPC method. Each mapping specifies a URL path template and an HTTP method. The path template may refer to one or more fields in the gRPC request message, as long as each field is a non-repeated field with a primitive (non-message) type. The path template controls how fields of the request message are mapped to the URL path. Example: service Messaging { rpc GetMessage(GetMessageRequest) returns (Message) { option (google.api.http) = { get: "/v1/{name=messages/*}" }; } } message GetMessageRequest { string name = 1; // Mapped to URL path. } message Message { string text = 1; // The resource content. } This enables an HTTP REST to gRPC mapping as below: HTTP | gRPC -----|----- `GET /v1/messages/123456` | `GetMessage(name: "messages/123456")` Any fields in the request message which are not bound by the path template automatically become HTTP query parameters if there is no HTTP request body. For example: service Messaging { rpc GetMessage(GetMessageRequest) returns (Message) { option (google.api.http) = { get:"/v1/messages/{message_id}" }; } } message GetMessageRequest { message SubMessage { string subfield = 1; } string message_id = 1; // Mapped to URL path. int64 revision = 2; // Mapped to URL query parameter `revision`. SubMessage sub = 3; // Mapped to URL query parameter `sub.subfield`. } This enables a HTTP JSON to RPC mapping as below: HTTP | gRPC -----|----- `GET /v1/messages/123456?revision=2&sub.subfield=foo` | `GetMessage(message_id: "123456" revision: 2 sub: SubMessage(subfield: "foo"))` Note that fields which are mapped to URL query parameters must have a primitive type or a repeated primitive type or a non-repeated message type. In the case of a repeated type, the parameter can be repeated in the URL as `...?param=A&param=B`. In the case of a message type, each field of the message is mapped to a separate parameter, such as `...?foo.a=A&foo.b=B&foo.c=C`. For HTTP methods that allow a request body, the `body` field specifies the mapping. Consider a REST update method on the message resource collection: service Messaging { rpc UpdateMessage(UpdateMessageRequest) returns (Message) { option (google.api.http) = { patch: "/v1/messages/{message_id}" body: "message" }; } } message UpdateMessageRequest { string message_id = 1; // mapped to the URL Message message = 2; // mapped to the body } The following HTTP JSON to RPC mapping is enabled, where the representation of the JSON in the request body is determined by protos JSON encoding: HTTP | gRPC -----|----- `PATCH /v1/messages/123456 { "text": "Hi!" }` | `UpdateMessage(message_id: "123456" message { text: "Hi!" })` The special name `*` can be used in the body mapping to define that every field not bound by the path template should be mapped to the request body. This enables the following alternative definition of the update method: service Messaging { rpc UpdateMessage(Message) returns (Message) { option (google.api.http) = { patch: "/v1/messages/{message_id}" body: "*" }; } } message Message { string message_id = 1; string text = 2; } The following HTTP JSON to RPC mapping is enabled: HTTP | gRPC -----|----- `PATCH /v1/messages/123456 { "text": "Hi!" }` | `UpdateMessage(message_id: "123456" text: "Hi!")` Note that when using `*` in the body mapping, it is not possible to have HTTP parameters, as all fields not bound by the path end in the body. This makes this option more rarely used in practice when defining REST APIs. The common usage of `*` is in custom methods which don't use the URL at all for transferring data. It is possible to define multiple HTTP methods for one RPC by using the `additional_bindings` option. Example: service Messaging { rpc GetMessage(GetMessageRequest) returns (Message) { option (google.api.http) = { get: "/v1/messages/{message_id}" additional_bindings { get: "/v1/users/{user_id}/messages/{message_id}" } }; } } message GetMessageRequest { string message_id = 1; string user_id = 2; } This enables the following two alternative HTTP JSON to RPC mappings: HTTP | gRPC -----|----- `GET /v1/messages/123456` | `GetMessage(message_id: "123456")` `GET /v1/users/me/messages/123456` | `GetMessage(user_id: "me" message_id: "123456")` ## Rules for HTTP mapping 1. Leaf request fields (recursive expansion nested messages in the request message) are classified into three categories: - Fields referred by the path template. They are passed via the URL path. - Fields referred by the HttpRule.body. They are passed via the HTTP request body. - All other fields are passed via the URL query parameters, and the parameter name is the field path in the request message. A repeated field can be represented as multiple query parameters under the same name. 2. If HttpRule.body is "*", there is no URL query parameter, all fields are passed via URL path and HTTP request body. 3. If HttpRule.body is omitted, there is no HTTP request body, all fields are passed via URL path and URL query parameters. ### Path template syntax Template = "/" Segments [ Verb ] ; Segments = Segment { "/" Segment } ; Segment = "*" | "**" | LITERAL | Variable ; Variable = "{" FieldPath [ "=" Segments ] "}" ; FieldPath = IDENT { "." IDENT } ; Verb = ":" LITERAL ; The syntax `*` matches a single URL path segment. The syntax `**` matches zero or more URL path segments, which must be the last part of the URL path except the `Verb`. The syntax `Variable` matches part of the URL path as specified by its template. A variable template must not contain other variables. If a variable matches a single path segment, its template may be omitted, e.g. `{var}` is equivalent to `{var=*}`. The syntax `LITERAL` matches literal text in the URL path. If the `LITERAL` contains any reserved character, such characters should be percent-encoded before the matching. If a variable contains exactly one path segment, such as `"{var}"` or `"{var=*}"`, when such a variable is expanded into a URL path on the client side, all characters except `[-_.~0-9a-zA-Z]` are percent-encoded. The server side does the reverse decoding. Such variables show up in the [Discovery Document](https://developers.google.com/discovery/v1/reference/apis) as `{var}`. If a variable contains multiple path segments, such as `"{var=foo/*}"` or `"{var=**}"`, when such a variable is expanded into a URL path on the client side, all characters except `[-_.~/0-9a-zA-Z]` are percent-encoded. The server side does the reverse decoding, except "%2F" and "%2f" are left unchanged. Such variables show up in the [Discovery Document](https://developers.google.com/discovery/v1/reference/apis) as `{+var}`. ## Using gRPC API Service Configuration gRPC API Service Configuration (service config) is a configuration language for configuring a gRPC service to become a user-facing product. The service config is simply the YAML representation of the `google.api.Service` proto message. As an alternative to annotating your proto file, you can configure gRPC transcoding in your service config YAML files. You do this by specifying a `HttpRule` that maps the gRPC method to a REST endpoint, achieving the same effect as the proto annotation. This can be particularly useful if you have a proto that is reused in multiple services. Note that any transcoding specified in the service config will override any matching transcoding configuration in the proto. Example: http: rules: # Selects a gRPC method and applies HttpRule to it. - selector: example.v1.Messaging.GetMessage get: /v1/messages/{message_id}/{sub.subfield} ## Special notes When gRPC Transcoding is used to map a gRPC to JSON REST endpoints, the proto to JSON conversion must follow the [proto3 specification](https://developers.google.com/protocol-buffers/docs/proto3#json). While the single segment variable follows the semantics of [RFC 6570](https://tools.ietf.org/html/rfc6570) Section 3.2.2 Simple String Expansion, the multi segment variable **does not** follow RFC 6570 Section 3.2.3 Reserved Expansion. The reason is that the Reserved Expansion does not expand special characters like `?` and `#`, which would lead to invalid URLs. As the result, gRPC Transcoding uses a custom encoding for multi segment variables. The path variables **must not** refer to any repeated or mapped field, because client libraries are not capable of handling such variable expansion. The path variables **must not** capture the leading "/" character. The reason is that the most common use case "{var}" does not capture the leading "/" character. For consistency, all path variables must share the same behavior. Repeated message fields must not be mapped to URL query parameters, because no client library can support such complicated mapping. If an API needs to use a JSON array for request or response body, it can map the request or response body to a repeated field. However, some gRPC Transcoding implementations may not support this feature. + { # gRPC Transcoding gRPC Transcoding is a feature for mapping between a gRPC method and one or more HTTP REST endpoints. It allows developers to build a single API service that supports both gRPC APIs and REST APIs. Many systems, including [Google APIs](https://github.com/googleapis/googleapis), [Cloud Endpoints](https://cloud.google.com/endpoints), [gRPC Gateway](https://github.com/grpc-ecosystem/grpc-gateway), and [Envoy](https://github.com/envoyproxy/envoy) proxy support this feature and use it for large scale production services. `HttpRule` defines the schema of the gRPC/REST mapping. The mapping specifies how different portions of the gRPC request message are mapped to the URL path, URL query parameters, and HTTP request body. It also controls how the gRPC response message is mapped to the HTTP response body. `HttpRule` is typically specified as an `google.api.http` annotation on the gRPC method. Each mapping specifies a URL path template and an HTTP method. The path template may refer to one or more fields in the gRPC request message, as long as each field is a non-repeated field with a primitive (non-message) type. The path template controls how fields of the request message are mapped to the URL path. Example: service Messaging { rpc GetMessage(GetMessageRequest) returns (Message) { option (google.api.http) = { get: "/v1/{name=messages/*}" }; } } message GetMessageRequest { string name = 1; // Mapped to URL path. } message Message { string text = 1; // The resource content. } This enables an HTTP REST to gRPC mapping as below: - HTTP: `GET /v1/messages/123456` - gRPC: `GetMessage(name: "messages/123456")` Any fields in the request message which are not bound by the path template automatically become HTTP query parameters if there is no HTTP request body. For example: service Messaging { rpc GetMessage(GetMessageRequest) returns (Message) { option (google.api.http) = { get:"/v1/messages/{message_id}" }; } } message GetMessageRequest { message SubMessage { string subfield = 1; } string message_id = 1; // Mapped to URL path. int64 revision = 2; // Mapped to URL query parameter `revision`. SubMessage sub = 3; // Mapped to URL query parameter `sub.subfield`. } This enables a HTTP JSON to RPC mapping as below: - HTTP: `GET /v1/messages/123456?revision=2&sub.subfield=foo` - gRPC: `GetMessage(message_id: "123456" revision: 2 sub: SubMessage(subfield: "foo"))` Note that fields which are mapped to URL query parameters must have a primitive type or a repeated primitive type or a non-repeated message type. In the case of a repeated type, the parameter can be repeated in the URL as `...?param=A&param=B`. In the case of a message type, each field of the message is mapped to a separate parameter, such as `...?foo.a=A&foo.b=B&foo.c=C`. For HTTP methods that allow a request body, the `body` field specifies the mapping. Consider a REST update method on the message resource collection: service Messaging { rpc UpdateMessage(UpdateMessageRequest) returns (Message) { option (google.api.http) = { patch: "/v1/messages/{message_id}" body: "message" }; } } message UpdateMessageRequest { string message_id = 1; // mapped to the URL Message message = 2; // mapped to the body } The following HTTP JSON to RPC mapping is enabled, where the representation of the JSON in the request body is determined by protos JSON encoding: - HTTP: `PATCH /v1/messages/123456 { "text": "Hi!" }` - gRPC: `UpdateMessage(message_id: "123456" message { text: "Hi!" })` The special name `*` can be used in the body mapping to define that every field not bound by the path template should be mapped to the request body. This enables the following alternative definition of the update method: service Messaging { rpc UpdateMessage(Message) returns (Message) { option (google.api.http) = { patch: "/v1/messages/{message_id}" body: "*" }; } } message Message { string message_id = 1; string text = 2; } The following HTTP JSON to RPC mapping is enabled: - HTTP: `PATCH /v1/messages/123456 { "text": "Hi!" }` - gRPC: `UpdateMessage(message_id: "123456" text: "Hi!")` Note that when using `*` in the body mapping, it is not possible to have HTTP parameters, as all fields not bound by the path end in the body. This makes this option more rarely used in practice when defining REST APIs. The common usage of `*` is in custom methods which don't use the URL at all for transferring data. It is possible to define multiple HTTP methods for one RPC by using the `additional_bindings` option. Example: service Messaging { rpc GetMessage(GetMessageRequest) returns (Message) { option (google.api.http) = { get: "/v1/messages/{message_id}" additional_bindings { get: "/v1/users/{user_id}/messages/{message_id}" } }; } } message GetMessageRequest { string message_id = 1; string user_id = 2; } This enables the following two alternative HTTP JSON to RPC mappings: - HTTP: `GET /v1/messages/123456` - gRPC: `GetMessage(message_id: "123456")` - HTTP: `GET /v1/users/me/messages/123456` - gRPC: `GetMessage(user_id: "me" message_id: "123456")` Rules for HTTP mapping 1. Leaf request fields (recursive expansion nested messages in the request message) are classified into three categories: - Fields referred by the path template. They are passed via the URL path. - Fields referred by the HttpRule.body. They are passed via the HTTP request body. - All other fields are passed via the URL query parameters, and the parameter name is the field path in the request message. A repeated field can be represented as multiple query parameters under the same name. 2. If HttpRule.body is "*", there is no URL query parameter, all fields are passed via URL path and HTTP request body. 3. If HttpRule.body is omitted, there is no HTTP request body, all fields are passed via URL path and URL query parameters. Path template syntax Template = "/" Segments [ Verb ] ; Segments = Segment { "/" Segment } ; Segment = "*" | "**" | LITERAL | Variable ; Variable = "{" FieldPath [ "=" Segments ] "}" ; FieldPath = IDENT { "." IDENT } ; Verb = ":" LITERAL ; The syntax `*` matches a single URL path segment. The syntax `**` matches zero or more URL path segments, which must be the last part of the URL path except the `Verb`. The syntax `Variable` matches part of the URL path as specified by its template. A variable template must not contain other variables. If a variable matches a single path segment, its template may be omitted, e.g. `{var}` is equivalent to `{var=*}`. The syntax `LITERAL` matches literal text in the URL path. If the `LITERAL` contains any reserved character, such characters should be percent-encoded before the matching. If a variable contains exactly one path segment, such as `"{var}"` or `"{var=*}"`, when such a variable is expanded into a URL path on the client side, all characters except `[-_.~0-9a-zA-Z]` are percent-encoded. The server side does the reverse decoding. Such variables show up in the [Discovery Document](https://developers.google.com/discovery/v1/reference/apis) as `{var}`. If a variable contains multiple path segments, such as `"{var=foo/*}"` or `"{var=**}"`, when such a variable is expanded into a URL path on the client side, all characters except `[-_.~/0-9a-zA-Z]` are percent-encoded. The server side does the reverse decoding, except "%2F" and "%2f" are left unchanged. Such variables show up in the [Discovery Document](https://developers.google.com/discovery/v1/reference/apis) as `{+var}`. Using gRPC API Service Configuration gRPC API Service Configuration (service config) is a configuration language for configuring a gRPC service to become a user-facing product. The service config is simply the YAML representation of the `google.api.Service` proto message. As an alternative to annotating your proto file, you can configure gRPC transcoding in your service config YAML files. You do this by specifying a `HttpRule` that maps the gRPC method to a REST endpoint, achieving the same effect as the proto annotation. This can be particularly useful if you have a proto that is reused in multiple services. Note that any transcoding specified in the service config will override any matching transcoding configuration in the proto. Example below selects a gRPC method and applies HttpRule to it. http: rules: - selector: example.v1.Messaging.GetMessage get: /v1/messages/{message_id}/{sub.subfield} Special notes When gRPC Transcoding is used to map a gRPC to JSON REST endpoints, the proto to JSON conversion must follow the [proto3 specification](https://developers.google.com/protocol-buffers/docs/proto3#json). While the single segment variable follows the semantics of [RFC 6570](https://tools.ietf.org/html/rfc6570) Section 3.2.2 Simple String Expansion, the multi segment variable **does not** follow RFC 6570 Section 3.2.3 Reserved Expansion. The reason is that the Reserved Expansion does not expand special characters like `?` and `#`, which would lead to invalid URLs. As the result, gRPC Transcoding uses a custom encoding for multi segment variables. The path variables **must not** refer to any repeated or mapped field, because client libraries are not capable of handling such variable expansion. The path variables **must not** capture the leading "/" character. The reason is that the most common use case "{var}" does not capture the leading "/" character. For consistency, all path variables must share the same behavior. Repeated message fields must not be mapped to URL query parameters, because no client library can support such complicated mapping. If an API needs to use a JSON array for request or response body, it can map the request or response body to a repeated field. However, some gRPC Transcoding implementations may not support this feature. "additionalBindings": [ # Additional HTTP bindings for the selector. Nested bindings must not contain an `additional_bindings` field themselves (that is, the nesting may only be one level deep). # Object with schema name: HttpRule ], @@ -2204,7 +2204,7 @@

Method Details

"http": { # Defines the HTTP configuration for an API service. It contains a list of HttpRule, each specifying the mapping of an RPC method to one or more HTTP REST API methods. # HTTP configuration. "fullyDecodeReservedExpansion": True or False, # When set to true, URL path parameters will be fully URI-decoded except in cases of single segment matches in reserved expansion, where "%2F" will be left encoded. The default behavior is to not decode RFC 6570 reserved characters in multi segment matches. "rules": [ # A list of HTTP configuration rules that apply to individual API methods. **NOTE:** All service configuration rules follow "last one wins" order. - { # # gRPC Transcoding gRPC Transcoding is a feature for mapping between a gRPC method and one or more HTTP REST endpoints. It allows developers to build a single API service that supports both gRPC APIs and REST APIs. Many systems, including [Google APIs](https://github.com/googleapis/googleapis), [Cloud Endpoints](https://cloud.google.com/endpoints), [gRPC Gateway](https://github.com/grpc-ecosystem/grpc-gateway), and [Envoy](https://github.com/envoyproxy/envoy) proxy support this feature and use it for large scale production services. `HttpRule` defines the schema of the gRPC/REST mapping. The mapping specifies how different portions of the gRPC request message are mapped to the URL path, URL query parameters, and HTTP request body. It also controls how the gRPC response message is mapped to the HTTP response body. `HttpRule` is typically specified as an `google.api.http` annotation on the gRPC method. Each mapping specifies a URL path template and an HTTP method. The path template may refer to one or more fields in the gRPC request message, as long as each field is a non-repeated field with a primitive (non-message) type. The path template controls how fields of the request message are mapped to the URL path. Example: service Messaging { rpc GetMessage(GetMessageRequest) returns (Message) { option (google.api.http) = { get: "/v1/{name=messages/*}" }; } } message GetMessageRequest { string name = 1; // Mapped to URL path. } message Message { string text = 1; // The resource content. } This enables an HTTP REST to gRPC mapping as below: HTTP | gRPC -----|----- `GET /v1/messages/123456` | `GetMessage(name: "messages/123456")` Any fields in the request message which are not bound by the path template automatically become HTTP query parameters if there is no HTTP request body. For example: service Messaging { rpc GetMessage(GetMessageRequest) returns (Message) { option (google.api.http) = { get:"/v1/messages/{message_id}" }; } } message GetMessageRequest { message SubMessage { string subfield = 1; } string message_id = 1; // Mapped to URL path. int64 revision = 2; // Mapped to URL query parameter `revision`. SubMessage sub = 3; // Mapped to URL query parameter `sub.subfield`. } This enables a HTTP JSON to RPC mapping as below: HTTP | gRPC -----|----- `GET /v1/messages/123456?revision=2&sub.subfield=foo` | `GetMessage(message_id: "123456" revision: 2 sub: SubMessage(subfield: "foo"))` Note that fields which are mapped to URL query parameters must have a primitive type or a repeated primitive type or a non-repeated message type. In the case of a repeated type, the parameter can be repeated in the URL as `...?param=A&param=B`. In the case of a message type, each field of the message is mapped to a separate parameter, such as `...?foo.a=A&foo.b=B&foo.c=C`. For HTTP methods that allow a request body, the `body` field specifies the mapping. Consider a REST update method on the message resource collection: service Messaging { rpc UpdateMessage(UpdateMessageRequest) returns (Message) { option (google.api.http) = { patch: "/v1/messages/{message_id}" body: "message" }; } } message UpdateMessageRequest { string message_id = 1; // mapped to the URL Message message = 2; // mapped to the body } The following HTTP JSON to RPC mapping is enabled, where the representation of the JSON in the request body is determined by protos JSON encoding: HTTP | gRPC -----|----- `PATCH /v1/messages/123456 { "text": "Hi!" }` | `UpdateMessage(message_id: "123456" message { text: "Hi!" })` The special name `*` can be used in the body mapping to define that every field not bound by the path template should be mapped to the request body. This enables the following alternative definition of the update method: service Messaging { rpc UpdateMessage(Message) returns (Message) { option (google.api.http) = { patch: "/v1/messages/{message_id}" body: "*" }; } } message Message { string message_id = 1; string text = 2; } The following HTTP JSON to RPC mapping is enabled: HTTP | gRPC -----|----- `PATCH /v1/messages/123456 { "text": "Hi!" }` | `UpdateMessage(message_id: "123456" text: "Hi!")` Note that when using `*` in the body mapping, it is not possible to have HTTP parameters, as all fields not bound by the path end in the body. This makes this option more rarely used in practice when defining REST APIs. The common usage of `*` is in custom methods which don't use the URL at all for transferring data. It is possible to define multiple HTTP methods for one RPC by using the `additional_bindings` option. Example: service Messaging { rpc GetMessage(GetMessageRequest) returns (Message) { option (google.api.http) = { get: "/v1/messages/{message_id}" additional_bindings { get: "/v1/users/{user_id}/messages/{message_id}" } }; } } message GetMessageRequest { string message_id = 1; string user_id = 2; } This enables the following two alternative HTTP JSON to RPC mappings: HTTP | gRPC -----|----- `GET /v1/messages/123456` | `GetMessage(message_id: "123456")` `GET /v1/users/me/messages/123456` | `GetMessage(user_id: "me" message_id: "123456")` ## Rules for HTTP mapping 1. Leaf request fields (recursive expansion nested messages in the request message) are classified into three categories: - Fields referred by the path template. They are passed via the URL path. - Fields referred by the HttpRule.body. They are passed via the HTTP request body. - All other fields are passed via the URL query parameters, and the parameter name is the field path in the request message. A repeated field can be represented as multiple query parameters under the same name. 2. If HttpRule.body is "*", there is no URL query parameter, all fields are passed via URL path and HTTP request body. 3. If HttpRule.body is omitted, there is no HTTP request body, all fields are passed via URL path and URL query parameters. ### Path template syntax Template = "/" Segments [ Verb ] ; Segments = Segment { "/" Segment } ; Segment = "*" | "**" | LITERAL | Variable ; Variable = "{" FieldPath [ "=" Segments ] "}" ; FieldPath = IDENT { "." IDENT } ; Verb = ":" LITERAL ; The syntax `*` matches a single URL path segment. The syntax `**` matches zero or more URL path segments, which must be the last part of the URL path except the `Verb`. The syntax `Variable` matches part of the URL path as specified by its template. A variable template must not contain other variables. If a variable matches a single path segment, its template may be omitted, e.g. `{var}` is equivalent to `{var=*}`. The syntax `LITERAL` matches literal text in the URL path. If the `LITERAL` contains any reserved character, such characters should be percent-encoded before the matching. If a variable contains exactly one path segment, such as `"{var}"` or `"{var=*}"`, when such a variable is expanded into a URL path on the client side, all characters except `[-_.~0-9a-zA-Z]` are percent-encoded. The server side does the reverse decoding. Such variables show up in the [Discovery Document](https://developers.google.com/discovery/v1/reference/apis) as `{var}`. If a variable contains multiple path segments, such as `"{var=foo/*}"` or `"{var=**}"`, when such a variable is expanded into a URL path on the client side, all characters except `[-_.~/0-9a-zA-Z]` are percent-encoded. The server side does the reverse decoding, except "%2F" and "%2f" are left unchanged. Such variables show up in the [Discovery Document](https://developers.google.com/discovery/v1/reference/apis) as `{+var}`. ## Using gRPC API Service Configuration gRPC API Service Configuration (service config) is a configuration language for configuring a gRPC service to become a user-facing product. The service config is simply the YAML representation of the `google.api.Service` proto message. As an alternative to annotating your proto file, you can configure gRPC transcoding in your service config YAML files. You do this by specifying a `HttpRule` that maps the gRPC method to a REST endpoint, achieving the same effect as the proto annotation. This can be particularly useful if you have a proto that is reused in multiple services. Note that any transcoding specified in the service config will override any matching transcoding configuration in the proto. Example: http: rules: # Selects a gRPC method and applies HttpRule to it. - selector: example.v1.Messaging.GetMessage get: /v1/messages/{message_id}/{sub.subfield} ## Special notes When gRPC Transcoding is used to map a gRPC to JSON REST endpoints, the proto to JSON conversion must follow the [proto3 specification](https://developers.google.com/protocol-buffers/docs/proto3#json). While the single segment variable follows the semantics of [RFC 6570](https://tools.ietf.org/html/rfc6570) Section 3.2.2 Simple String Expansion, the multi segment variable **does not** follow RFC 6570 Section 3.2.3 Reserved Expansion. The reason is that the Reserved Expansion does not expand special characters like `?` and `#`, which would lead to invalid URLs. As the result, gRPC Transcoding uses a custom encoding for multi segment variables. The path variables **must not** refer to any repeated or mapped field, because client libraries are not capable of handling such variable expansion. The path variables **must not** capture the leading "/" character. The reason is that the most common use case "{var}" does not capture the leading "/" character. For consistency, all path variables must share the same behavior. Repeated message fields must not be mapped to URL query parameters, because no client library can support such complicated mapping. If an API needs to use a JSON array for request or response body, it can map the request or response body to a repeated field. However, some gRPC Transcoding implementations may not support this feature. + { # gRPC Transcoding gRPC Transcoding is a feature for mapping between a gRPC method and one or more HTTP REST endpoints. It allows developers to build a single API service that supports both gRPC APIs and REST APIs. Many systems, including [Google APIs](https://github.com/googleapis/googleapis), [Cloud Endpoints](https://cloud.google.com/endpoints), [gRPC Gateway](https://github.com/grpc-ecosystem/grpc-gateway), and [Envoy](https://github.com/envoyproxy/envoy) proxy support this feature and use it for large scale production services. `HttpRule` defines the schema of the gRPC/REST mapping. The mapping specifies how different portions of the gRPC request message are mapped to the URL path, URL query parameters, and HTTP request body. It also controls how the gRPC response message is mapped to the HTTP response body. `HttpRule` is typically specified as an `google.api.http` annotation on the gRPC method. Each mapping specifies a URL path template and an HTTP method. The path template may refer to one or more fields in the gRPC request message, as long as each field is a non-repeated field with a primitive (non-message) type. The path template controls how fields of the request message are mapped to the URL path. Example: service Messaging { rpc GetMessage(GetMessageRequest) returns (Message) { option (google.api.http) = { get: "/v1/{name=messages/*}" }; } } message GetMessageRequest { string name = 1; // Mapped to URL path. } message Message { string text = 1; // The resource content. } This enables an HTTP REST to gRPC mapping as below: - HTTP: `GET /v1/messages/123456` - gRPC: `GetMessage(name: "messages/123456")` Any fields in the request message which are not bound by the path template automatically become HTTP query parameters if there is no HTTP request body. For example: service Messaging { rpc GetMessage(GetMessageRequest) returns (Message) { option (google.api.http) = { get:"/v1/messages/{message_id}" }; } } message GetMessageRequest { message SubMessage { string subfield = 1; } string message_id = 1; // Mapped to URL path. int64 revision = 2; // Mapped to URL query parameter `revision`. SubMessage sub = 3; // Mapped to URL query parameter `sub.subfield`. } This enables a HTTP JSON to RPC mapping as below: - HTTP: `GET /v1/messages/123456?revision=2&sub.subfield=foo` - gRPC: `GetMessage(message_id: "123456" revision: 2 sub: SubMessage(subfield: "foo"))` Note that fields which are mapped to URL query parameters must have a primitive type or a repeated primitive type or a non-repeated message type. In the case of a repeated type, the parameter can be repeated in the URL as `...?param=A&param=B`. In the case of a message type, each field of the message is mapped to a separate parameter, such as `...?foo.a=A&foo.b=B&foo.c=C`. For HTTP methods that allow a request body, the `body` field specifies the mapping. Consider a REST update method on the message resource collection: service Messaging { rpc UpdateMessage(UpdateMessageRequest) returns (Message) { option (google.api.http) = { patch: "/v1/messages/{message_id}" body: "message" }; } } message UpdateMessageRequest { string message_id = 1; // mapped to the URL Message message = 2; // mapped to the body } The following HTTP JSON to RPC mapping is enabled, where the representation of the JSON in the request body is determined by protos JSON encoding: - HTTP: `PATCH /v1/messages/123456 { "text": "Hi!" }` - gRPC: `UpdateMessage(message_id: "123456" message { text: "Hi!" })` The special name `*` can be used in the body mapping to define that every field not bound by the path template should be mapped to the request body. This enables the following alternative definition of the update method: service Messaging { rpc UpdateMessage(Message) returns (Message) { option (google.api.http) = { patch: "/v1/messages/{message_id}" body: "*" }; } } message Message { string message_id = 1; string text = 2; } The following HTTP JSON to RPC mapping is enabled: - HTTP: `PATCH /v1/messages/123456 { "text": "Hi!" }` - gRPC: `UpdateMessage(message_id: "123456" text: "Hi!")` Note that when using `*` in the body mapping, it is not possible to have HTTP parameters, as all fields not bound by the path end in the body. This makes this option more rarely used in practice when defining REST APIs. The common usage of `*` is in custom methods which don't use the URL at all for transferring data. It is possible to define multiple HTTP methods for one RPC by using the `additional_bindings` option. Example: service Messaging { rpc GetMessage(GetMessageRequest) returns (Message) { option (google.api.http) = { get: "/v1/messages/{message_id}" additional_bindings { get: "/v1/users/{user_id}/messages/{message_id}" } }; } } message GetMessageRequest { string message_id = 1; string user_id = 2; } This enables the following two alternative HTTP JSON to RPC mappings: - HTTP: `GET /v1/messages/123456` - gRPC: `GetMessage(message_id: "123456")` - HTTP: `GET /v1/users/me/messages/123456` - gRPC: `GetMessage(user_id: "me" message_id: "123456")` Rules for HTTP mapping 1. Leaf request fields (recursive expansion nested messages in the request message) are classified into three categories: - Fields referred by the path template. They are passed via the URL path. - Fields referred by the HttpRule.body. They are passed via the HTTP request body. - All other fields are passed via the URL query parameters, and the parameter name is the field path in the request message. A repeated field can be represented as multiple query parameters under the same name. 2. If HttpRule.body is "*", there is no URL query parameter, all fields are passed via URL path and HTTP request body. 3. If HttpRule.body is omitted, there is no HTTP request body, all fields are passed via URL path and URL query parameters. Path template syntax Template = "/" Segments [ Verb ] ; Segments = Segment { "/" Segment } ; Segment = "*" | "**" | LITERAL | Variable ; Variable = "{" FieldPath [ "=" Segments ] "}" ; FieldPath = IDENT { "." IDENT } ; Verb = ":" LITERAL ; The syntax `*` matches a single URL path segment. The syntax `**` matches zero or more URL path segments, which must be the last part of the URL path except the `Verb`. The syntax `Variable` matches part of the URL path as specified by its template. A variable template must not contain other variables. If a variable matches a single path segment, its template may be omitted, e.g. `{var}` is equivalent to `{var=*}`. The syntax `LITERAL` matches literal text in the URL path. If the `LITERAL` contains any reserved character, such characters should be percent-encoded before the matching. If a variable contains exactly one path segment, such as `"{var}"` or `"{var=*}"`, when such a variable is expanded into a URL path on the client side, all characters except `[-_.~0-9a-zA-Z]` are percent-encoded. The server side does the reverse decoding. Such variables show up in the [Discovery Document](https://developers.google.com/discovery/v1/reference/apis) as `{var}`. If a variable contains multiple path segments, such as `"{var=foo/*}"` or `"{var=**}"`, when such a variable is expanded into a URL path on the client side, all characters except `[-_.~/0-9a-zA-Z]` are percent-encoded. The server side does the reverse decoding, except "%2F" and "%2f" are left unchanged. Such variables show up in the [Discovery Document](https://developers.google.com/discovery/v1/reference/apis) as `{+var}`. Using gRPC API Service Configuration gRPC API Service Configuration (service config) is a configuration language for configuring a gRPC service to become a user-facing product. The service config is simply the YAML representation of the `google.api.Service` proto message. As an alternative to annotating your proto file, you can configure gRPC transcoding in your service config YAML files. You do this by specifying a `HttpRule` that maps the gRPC method to a REST endpoint, achieving the same effect as the proto annotation. This can be particularly useful if you have a proto that is reused in multiple services. Note that any transcoding specified in the service config will override any matching transcoding configuration in the proto. Example below selects a gRPC method and applies HttpRule to it. http: rules: - selector: example.v1.Messaging.GetMessage get: /v1/messages/{message_id}/{sub.subfield} Special notes When gRPC Transcoding is used to map a gRPC to JSON REST endpoints, the proto to JSON conversion must follow the [proto3 specification](https://developers.google.com/protocol-buffers/docs/proto3#json). While the single segment variable follows the semantics of [RFC 6570](https://tools.ietf.org/html/rfc6570) Section 3.2.2 Simple String Expansion, the multi segment variable **does not** follow RFC 6570 Section 3.2.3 Reserved Expansion. The reason is that the Reserved Expansion does not expand special characters like `?` and `#`, which would lead to invalid URLs. As the result, gRPC Transcoding uses a custom encoding for multi segment variables. The path variables **must not** refer to any repeated or mapped field, because client libraries are not capable of handling such variable expansion. The path variables **must not** capture the leading "/" character. The reason is that the most common use case "{var}" does not capture the leading "/" character. For consistency, all path variables must share the same behavior. Repeated message fields must not be mapped to URL query parameters, because no client library can support such complicated mapping. If an API needs to use a JSON array for request or response body, it can map the request or response body to a repeated field. However, some gRPC Transcoding implementations may not support this feature. "additionalBindings": [ # Additional HTTP bindings for the selector. Nested bindings must not contain an `additional_bindings` field themselves (that is, the nesting may only be one level deep). # Object with schema name: HttpRule ], diff --git a/docs/dyn/servicemanagement_v1.services.html b/docs/dyn/servicemanagement_v1.services.html index 7c06886a2fb..e233eb811f6 100644 --- a/docs/dyn/servicemanagement_v1.services.html +++ b/docs/dyn/servicemanagement_v1.services.html @@ -530,7 +530,7 @@

Method Details

"http": { # Defines the HTTP configuration for an API service. It contains a list of HttpRule, each specifying the mapping of an RPC method to one or more HTTP REST API methods. # HTTP configuration. "fullyDecodeReservedExpansion": True or False, # When set to true, URL path parameters will be fully URI-decoded except in cases of single segment matches in reserved expansion, where "%2F" will be left encoded. The default behavior is to not decode RFC 6570 reserved characters in multi segment matches. "rules": [ # A list of HTTP configuration rules that apply to individual API methods. **NOTE:** All service configuration rules follow "last one wins" order. - { # # gRPC Transcoding gRPC Transcoding is a feature for mapping between a gRPC method and one or more HTTP REST endpoints. It allows developers to build a single API service that supports both gRPC APIs and REST APIs. Many systems, including [Google APIs](https://github.com/googleapis/googleapis), [Cloud Endpoints](https://cloud.google.com/endpoints), [gRPC Gateway](https://github.com/grpc-ecosystem/grpc-gateway), and [Envoy](https://github.com/envoyproxy/envoy) proxy support this feature and use it for large scale production services. `HttpRule` defines the schema of the gRPC/REST mapping. The mapping specifies how different portions of the gRPC request message are mapped to the URL path, URL query parameters, and HTTP request body. It also controls how the gRPC response message is mapped to the HTTP response body. `HttpRule` is typically specified as an `google.api.http` annotation on the gRPC method. Each mapping specifies a URL path template and an HTTP method. The path template may refer to one or more fields in the gRPC request message, as long as each field is a non-repeated field with a primitive (non-message) type. The path template controls how fields of the request message are mapped to the URL path. Example: service Messaging { rpc GetMessage(GetMessageRequest) returns (Message) { option (google.api.http) = { get: "/v1/{name=messages/*}" }; } } message GetMessageRequest { string name = 1; // Mapped to URL path. } message Message { string text = 1; // The resource content. } This enables an HTTP REST to gRPC mapping as below: HTTP | gRPC -----|----- `GET /v1/messages/123456` | `GetMessage(name: "messages/123456")` Any fields in the request message which are not bound by the path template automatically become HTTP query parameters if there is no HTTP request body. For example: service Messaging { rpc GetMessage(GetMessageRequest) returns (Message) { option (google.api.http) = { get:"/v1/messages/{message_id}" }; } } message GetMessageRequest { message SubMessage { string subfield = 1; } string message_id = 1; // Mapped to URL path. int64 revision = 2; // Mapped to URL query parameter `revision`. SubMessage sub = 3; // Mapped to URL query parameter `sub.subfield`. } This enables a HTTP JSON to RPC mapping as below: HTTP | gRPC -----|----- `GET /v1/messages/123456?revision=2&sub.subfield=foo` | `GetMessage(message_id: "123456" revision: 2 sub: SubMessage(subfield: "foo"))` Note that fields which are mapped to URL query parameters must have a primitive type or a repeated primitive type or a non-repeated message type. In the case of a repeated type, the parameter can be repeated in the URL as `...?param=A&param=B`. In the case of a message type, each field of the message is mapped to a separate parameter, such as `...?foo.a=A&foo.b=B&foo.c=C`. For HTTP methods that allow a request body, the `body` field specifies the mapping. Consider a REST update method on the message resource collection: service Messaging { rpc UpdateMessage(UpdateMessageRequest) returns (Message) { option (google.api.http) = { patch: "/v1/messages/{message_id}" body: "message" }; } } message UpdateMessageRequest { string message_id = 1; // mapped to the URL Message message = 2; // mapped to the body } The following HTTP JSON to RPC mapping is enabled, where the representation of the JSON in the request body is determined by protos JSON encoding: HTTP | gRPC -----|----- `PATCH /v1/messages/123456 { "text": "Hi!" }` | `UpdateMessage(message_id: "123456" message { text: "Hi!" })` The special name `*` can be used in the body mapping to define that every field not bound by the path template should be mapped to the request body. This enables the following alternative definition of the update method: service Messaging { rpc UpdateMessage(Message) returns (Message) { option (google.api.http) = { patch: "/v1/messages/{message_id}" body: "*" }; } } message Message { string message_id = 1; string text = 2; } The following HTTP JSON to RPC mapping is enabled: HTTP | gRPC -----|----- `PATCH /v1/messages/123456 { "text": "Hi!" }` | `UpdateMessage(message_id: "123456" text: "Hi!")` Note that when using `*` in the body mapping, it is not possible to have HTTP parameters, as all fields not bound by the path end in the body. This makes this option more rarely used in practice when defining REST APIs. The common usage of `*` is in custom methods which don't use the URL at all for transferring data. It is possible to define multiple HTTP methods for one RPC by using the `additional_bindings` option. Example: service Messaging { rpc GetMessage(GetMessageRequest) returns (Message) { option (google.api.http) = { get: "/v1/messages/{message_id}" additional_bindings { get: "/v1/users/{user_id}/messages/{message_id}" } }; } } message GetMessageRequest { string message_id = 1; string user_id = 2; } This enables the following two alternative HTTP JSON to RPC mappings: HTTP | gRPC -----|----- `GET /v1/messages/123456` | `GetMessage(message_id: "123456")` `GET /v1/users/me/messages/123456` | `GetMessage(user_id: "me" message_id: "123456")` ## Rules for HTTP mapping 1. Leaf request fields (recursive expansion nested messages in the request message) are classified into three categories: - Fields referred by the path template. They are passed via the URL path. - Fields referred by the HttpRule.body. They are passed via the HTTP request body. - All other fields are passed via the URL query parameters, and the parameter name is the field path in the request message. A repeated field can be represented as multiple query parameters under the same name. 2. If HttpRule.body is "*", there is no URL query parameter, all fields are passed via URL path and HTTP request body. 3. If HttpRule.body is omitted, there is no HTTP request body, all fields are passed via URL path and URL query parameters. ### Path template syntax Template = "/" Segments [ Verb ] ; Segments = Segment { "/" Segment } ; Segment = "*" | "**" | LITERAL | Variable ; Variable = "{" FieldPath [ "=" Segments ] "}" ; FieldPath = IDENT { "." IDENT } ; Verb = ":" LITERAL ; The syntax `*` matches a single URL path segment. The syntax `**` matches zero or more URL path segments, which must be the last part of the URL path except the `Verb`. The syntax `Variable` matches part of the URL path as specified by its template. A variable template must not contain other variables. If a variable matches a single path segment, its template may be omitted, e.g. `{var}` is equivalent to `{var=*}`. The syntax `LITERAL` matches literal text in the URL path. If the `LITERAL` contains any reserved character, such characters should be percent-encoded before the matching. If a variable contains exactly one path segment, such as `"{var}"` or `"{var=*}"`, when such a variable is expanded into a URL path on the client side, all characters except `[-_.~0-9a-zA-Z]` are percent-encoded. The server side does the reverse decoding. Such variables show up in the [Discovery Document](https://developers.google.com/discovery/v1/reference/apis) as `{var}`. If a variable contains multiple path segments, such as `"{var=foo/*}"` or `"{var=**}"`, when such a variable is expanded into a URL path on the client side, all characters except `[-_.~/0-9a-zA-Z]` are percent-encoded. The server side does the reverse decoding, except "%2F" and "%2f" are left unchanged. Such variables show up in the [Discovery Document](https://developers.google.com/discovery/v1/reference/apis) as `{+var}`. ## Using gRPC API Service Configuration gRPC API Service Configuration (service config) is a configuration language for configuring a gRPC service to become a user-facing product. The service config is simply the YAML representation of the `google.api.Service` proto message. As an alternative to annotating your proto file, you can configure gRPC transcoding in your service config YAML files. You do this by specifying a `HttpRule` that maps the gRPC method to a REST endpoint, achieving the same effect as the proto annotation. This can be particularly useful if you have a proto that is reused in multiple services. Note that any transcoding specified in the service config will override any matching transcoding configuration in the proto. Example: http: rules: # Selects a gRPC method and applies HttpRule to it. - selector: example.v1.Messaging.GetMessage get: /v1/messages/{message_id}/{sub.subfield} ## Special notes When gRPC Transcoding is used to map a gRPC to JSON REST endpoints, the proto to JSON conversion must follow the [proto3 specification](https://developers.google.com/protocol-buffers/docs/proto3#json). While the single segment variable follows the semantics of [RFC 6570](https://tools.ietf.org/html/rfc6570) Section 3.2.2 Simple String Expansion, the multi segment variable **does not** follow RFC 6570 Section 3.2.3 Reserved Expansion. The reason is that the Reserved Expansion does not expand special characters like `?` and `#`, which would lead to invalid URLs. As the result, gRPC Transcoding uses a custom encoding for multi segment variables. The path variables **must not** refer to any repeated or mapped field, because client libraries are not capable of handling such variable expansion. The path variables **must not** capture the leading "/" character. The reason is that the most common use case "{var}" does not capture the leading "/" character. For consistency, all path variables must share the same behavior. Repeated message fields must not be mapped to URL query parameters, because no client library can support such complicated mapping. If an API needs to use a JSON array for request or response body, it can map the request or response body to a repeated field. However, some gRPC Transcoding implementations may not support this feature. + { # gRPC Transcoding gRPC Transcoding is a feature for mapping between a gRPC method and one or more HTTP REST endpoints. It allows developers to build a single API service that supports both gRPC APIs and REST APIs. Many systems, including [Google APIs](https://github.com/googleapis/googleapis), [Cloud Endpoints](https://cloud.google.com/endpoints), [gRPC Gateway](https://github.com/grpc-ecosystem/grpc-gateway), and [Envoy](https://github.com/envoyproxy/envoy) proxy support this feature and use it for large scale production services. `HttpRule` defines the schema of the gRPC/REST mapping. The mapping specifies how different portions of the gRPC request message are mapped to the URL path, URL query parameters, and HTTP request body. It also controls how the gRPC response message is mapped to the HTTP response body. `HttpRule` is typically specified as an `google.api.http` annotation on the gRPC method. Each mapping specifies a URL path template and an HTTP method. The path template may refer to one or more fields in the gRPC request message, as long as each field is a non-repeated field with a primitive (non-message) type. The path template controls how fields of the request message are mapped to the URL path. Example: service Messaging { rpc GetMessage(GetMessageRequest) returns (Message) { option (google.api.http) = { get: "/v1/{name=messages/*}" }; } } message GetMessageRequest { string name = 1; // Mapped to URL path. } message Message { string text = 1; // The resource content. } This enables an HTTP REST to gRPC mapping as below: - HTTP: `GET /v1/messages/123456` - gRPC: `GetMessage(name: "messages/123456")` Any fields in the request message which are not bound by the path template automatically become HTTP query parameters if there is no HTTP request body. For example: service Messaging { rpc GetMessage(GetMessageRequest) returns (Message) { option (google.api.http) = { get:"/v1/messages/{message_id}" }; } } message GetMessageRequest { message SubMessage { string subfield = 1; } string message_id = 1; // Mapped to URL path. int64 revision = 2; // Mapped to URL query parameter `revision`. SubMessage sub = 3; // Mapped to URL query parameter `sub.subfield`. } This enables a HTTP JSON to RPC mapping as below: - HTTP: `GET /v1/messages/123456?revision=2&sub.subfield=foo` - gRPC: `GetMessage(message_id: "123456" revision: 2 sub: SubMessage(subfield: "foo"))` Note that fields which are mapped to URL query parameters must have a primitive type or a repeated primitive type or a non-repeated message type. In the case of a repeated type, the parameter can be repeated in the URL as `...?param=A&param=B`. In the case of a message type, each field of the message is mapped to a separate parameter, such as `...?foo.a=A&foo.b=B&foo.c=C`. For HTTP methods that allow a request body, the `body` field specifies the mapping. Consider a REST update method on the message resource collection: service Messaging { rpc UpdateMessage(UpdateMessageRequest) returns (Message) { option (google.api.http) = { patch: "/v1/messages/{message_id}" body: "message" }; } } message UpdateMessageRequest { string message_id = 1; // mapped to the URL Message message = 2; // mapped to the body } The following HTTP JSON to RPC mapping is enabled, where the representation of the JSON in the request body is determined by protos JSON encoding: - HTTP: `PATCH /v1/messages/123456 { "text": "Hi!" }` - gRPC: `UpdateMessage(message_id: "123456" message { text: "Hi!" })` The special name `*` can be used in the body mapping to define that every field not bound by the path template should be mapped to the request body. This enables the following alternative definition of the update method: service Messaging { rpc UpdateMessage(Message) returns (Message) { option (google.api.http) = { patch: "/v1/messages/{message_id}" body: "*" }; } } message Message { string message_id = 1; string text = 2; } The following HTTP JSON to RPC mapping is enabled: - HTTP: `PATCH /v1/messages/123456 { "text": "Hi!" }` - gRPC: `UpdateMessage(message_id: "123456" text: "Hi!")` Note that when using `*` in the body mapping, it is not possible to have HTTP parameters, as all fields not bound by the path end in the body. This makes this option more rarely used in practice when defining REST APIs. The common usage of `*` is in custom methods which don't use the URL at all for transferring data. It is possible to define multiple HTTP methods for one RPC by using the `additional_bindings` option. Example: service Messaging { rpc GetMessage(GetMessageRequest) returns (Message) { option (google.api.http) = { get: "/v1/messages/{message_id}" additional_bindings { get: "/v1/users/{user_id}/messages/{message_id}" } }; } } message GetMessageRequest { string message_id = 1; string user_id = 2; } This enables the following two alternative HTTP JSON to RPC mappings: - HTTP: `GET /v1/messages/123456` - gRPC: `GetMessage(message_id: "123456")` - HTTP: `GET /v1/users/me/messages/123456` - gRPC: `GetMessage(user_id: "me" message_id: "123456")` Rules for HTTP mapping 1. Leaf request fields (recursive expansion nested messages in the request message) are classified into three categories: - Fields referred by the path template. They are passed via the URL path. - Fields referred by the HttpRule.body. They are passed via the HTTP request body. - All other fields are passed via the URL query parameters, and the parameter name is the field path in the request message. A repeated field can be represented as multiple query parameters under the same name. 2. If HttpRule.body is "*", there is no URL query parameter, all fields are passed via URL path and HTTP request body. 3. If HttpRule.body is omitted, there is no HTTP request body, all fields are passed via URL path and URL query parameters. Path template syntax Template = "/" Segments [ Verb ] ; Segments = Segment { "/" Segment } ; Segment = "*" | "**" | LITERAL | Variable ; Variable = "{" FieldPath [ "=" Segments ] "}" ; FieldPath = IDENT { "." IDENT } ; Verb = ":" LITERAL ; The syntax `*` matches a single URL path segment. The syntax `**` matches zero or more URL path segments, which must be the last part of the URL path except the `Verb`. The syntax `Variable` matches part of the URL path as specified by its template. A variable template must not contain other variables. If a variable matches a single path segment, its template may be omitted, e.g. `{var}` is equivalent to `{var=*}`. The syntax `LITERAL` matches literal text in the URL path. If the `LITERAL` contains any reserved character, such characters should be percent-encoded before the matching. If a variable contains exactly one path segment, such as `"{var}"` or `"{var=*}"`, when such a variable is expanded into a URL path on the client side, all characters except `[-_.~0-9a-zA-Z]` are percent-encoded. The server side does the reverse decoding. Such variables show up in the [Discovery Document](https://developers.google.com/discovery/v1/reference/apis) as `{var}`. If a variable contains multiple path segments, such as `"{var=foo/*}"` or `"{var=**}"`, when such a variable is expanded into a URL path on the client side, all characters except `[-_.~/0-9a-zA-Z]` are percent-encoded. The server side does the reverse decoding, except "%2F" and "%2f" are left unchanged. Such variables show up in the [Discovery Document](https://developers.google.com/discovery/v1/reference/apis) as `{+var}`. Using gRPC API Service Configuration gRPC API Service Configuration (service config) is a configuration language for configuring a gRPC service to become a user-facing product. The service config is simply the YAML representation of the `google.api.Service` proto message. As an alternative to annotating your proto file, you can configure gRPC transcoding in your service config YAML files. You do this by specifying a `HttpRule` that maps the gRPC method to a REST endpoint, achieving the same effect as the proto annotation. This can be particularly useful if you have a proto that is reused in multiple services. Note that any transcoding specified in the service config will override any matching transcoding configuration in the proto. Example below selects a gRPC method and applies HttpRule to it. http: rules: - selector: example.v1.Messaging.GetMessage get: /v1/messages/{message_id}/{sub.subfield} Special notes When gRPC Transcoding is used to map a gRPC to JSON REST endpoints, the proto to JSON conversion must follow the [proto3 specification](https://developers.google.com/protocol-buffers/docs/proto3#json). While the single segment variable follows the semantics of [RFC 6570](https://tools.ietf.org/html/rfc6570) Section 3.2.2 Simple String Expansion, the multi segment variable **does not** follow RFC 6570 Section 3.2.3 Reserved Expansion. The reason is that the Reserved Expansion does not expand special characters like `?` and `#`, which would lead to invalid URLs. As the result, gRPC Transcoding uses a custom encoding for multi segment variables. The path variables **must not** refer to any repeated or mapped field, because client libraries are not capable of handling such variable expansion. The path variables **must not** capture the leading "/" character. The reason is that the most common use case "{var}" does not capture the leading "/" character. For consistency, all path variables must share the same behavior. Repeated message fields must not be mapped to URL query parameters, because no client library can support such complicated mapping. If an API needs to use a JSON array for request or response body, it can map the request or response body to a repeated field. However, some gRPC Transcoding implementations may not support this feature. "additionalBindings": [ # Additional HTTP bindings for the selector. Nested bindings must not contain an `additional_bindings` field themselves (that is, the nesting may only be one level deep). # Object with schema name: HttpRule ], diff --git a/docs/dyn/sqladmin_v1.instances.html b/docs/dyn/sqladmin_v1.instances.html index c5004c77d11..dc20631d371 100644 --- a/docs/dyn/sqladmin_v1.instances.html +++ b/docs/dyn/sqladmin_v1.instances.html @@ -1354,6 +1354,7 @@

Method Details

}, ], "edition": "A String", # Optional. The edition of the instance. + "enableDataplexIntegration": True or False, # Optional. By default, Cloud SQL instances have schema extraction disabled for Dataplex. When this parameter is set to true, schema extraction for Dataplex on Cloud SQL instances is activated. "enableGoogleMlIntegration": True or False, # Optional. When this parameter is set to true, Cloud SQL instances can connect to Vertex AI to pass requests for real-time predictions and insights to the AI. The default value is false. This applies only to Cloud SQL for PostgreSQL instances. "insightsConfig": { # Insights configuration. This specifies when Cloud SQL Insights feature is enabled and optional configuration. # Insights configuration, for now relevant only for Postgres. "queryInsightsEnabled": True or False, # Whether Query Insights feature is enabled. @@ -1782,6 +1783,7 @@

Method Details

}, ], "edition": "A String", # Optional. The edition of the instance. + "enableDataplexIntegration": True or False, # Optional. By default, Cloud SQL instances have schema extraction disabled for Dataplex. When this parameter is set to true, schema extraction for Dataplex on Cloud SQL instances is activated. "enableGoogleMlIntegration": True or False, # Optional. When this parameter is set to true, Cloud SQL instances can connect to Vertex AI to pass requests for real-time predictions and insights to the AI. The default value is false. This applies only to Cloud SQL for PostgreSQL instances. "insightsConfig": { # Insights configuration. This specifies when Cloud SQL Insights feature is enabled and optional configuration. # Insights configuration, for now relevant only for Postgres. "queryInsightsEnabled": True or False, # Whether Query Insights feature is enabled. @@ -2172,6 +2174,7 @@

Method Details

}, ], "edition": "A String", # Optional. The edition of the instance. + "enableDataplexIntegration": True or False, # Optional. By default, Cloud SQL instances have schema extraction disabled for Dataplex. When this parameter is set to true, schema extraction for Dataplex on Cloud SQL instances is activated. "enableGoogleMlIntegration": True or False, # Optional. When this parameter is set to true, Cloud SQL instances can connect to Vertex AI to pass requests for real-time predictions and insights to the AI. The default value is false. This applies only to Cloud SQL for PostgreSQL instances. "insightsConfig": { # Insights configuration. This specifies when Cloud SQL Insights feature is enabled and optional configuration. # Insights configuration, for now relevant only for Postgres. "queryInsightsEnabled": True or False, # Whether Query Insights feature is enabled. @@ -2496,6 +2499,7 @@

Method Details

}, ], "edition": "A String", # Optional. The edition of the instance. + "enableDataplexIntegration": True or False, # Optional. By default, Cloud SQL instances have schema extraction disabled for Dataplex. When this parameter is set to true, schema extraction for Dataplex on Cloud SQL instances is activated. "enableGoogleMlIntegration": True or False, # Optional. When this parameter is set to true, Cloud SQL instances can connect to Vertex AI to pass requests for real-time predictions and insights to the AI. The default value is false. This applies only to Cloud SQL for PostgreSQL instances. "insightsConfig": { # Insights configuration. This specifies when Cloud SQL Insights feature is enabled and optional configuration. # Insights configuration, for now relevant only for Postgres. "queryInsightsEnabled": True or False, # Whether Query Insights feature is enabled. @@ -4181,6 +4185,7 @@

Method Details

}, ], "edition": "A String", # Optional. The edition of the instance. + "enableDataplexIntegration": True or False, # Optional. By default, Cloud SQL instances have schema extraction disabled for Dataplex. When this parameter is set to true, schema extraction for Dataplex on Cloud SQL instances is activated. "enableGoogleMlIntegration": True or False, # Optional. When this parameter is set to true, Cloud SQL instances can connect to Vertex AI to pass requests for real-time predictions and insights to the AI. The default value is false. This applies only to Cloud SQL for PostgreSQL instances. "insightsConfig": { # Insights configuration. This specifies when Cloud SQL Insights feature is enabled and optional configuration. # Insights configuration, for now relevant only for Postgres. "queryInsightsEnabled": True or False, # Whether Query Insights feature is enabled. diff --git a/docs/dyn/sqladmin_v1beta4.instances.html b/docs/dyn/sqladmin_v1beta4.instances.html index 0b3d8a954b4..9f815c042f1 100644 --- a/docs/dyn/sqladmin_v1beta4.instances.html +++ b/docs/dyn/sqladmin_v1beta4.instances.html @@ -1355,6 +1355,7 @@

Method Details

}, ], "edition": "A String", # Optional. The edition of the instance. + "enableDataplexIntegration": True or False, # Optional. By default, Cloud SQL instances have schema extraction disabled for Dataplex. When this parameter is set to true, schema extraction for Dataplex on Cloud SQL instances is activated. "enableGoogleMlIntegration": True or False, # Optional. When this parameter is set to true, Cloud SQL instances can connect to Vertex AI to pass requests for real-time predictions and insights to the AI. The default value is false. This applies only to Cloud SQL for PostgreSQL instances. "insightsConfig": { # Insights configuration. This specifies when Cloud SQL Insights feature is enabled and optional configuration. # Insights configuration, for now relevant only for Postgres. "queryInsightsEnabled": True or False, # Whether Query Insights feature is enabled. @@ -1783,6 +1784,7 @@

Method Details

}, ], "edition": "A String", # Optional. The edition of the instance. + "enableDataplexIntegration": True or False, # Optional. By default, Cloud SQL instances have schema extraction disabled for Dataplex. When this parameter is set to true, schema extraction for Dataplex on Cloud SQL instances is activated. "enableGoogleMlIntegration": True or False, # Optional. When this parameter is set to true, Cloud SQL instances can connect to Vertex AI to pass requests for real-time predictions and insights to the AI. The default value is false. This applies only to Cloud SQL for PostgreSQL instances. "insightsConfig": { # Insights configuration. This specifies when Cloud SQL Insights feature is enabled and optional configuration. # Insights configuration, for now relevant only for Postgres. "queryInsightsEnabled": True or False, # Whether Query Insights feature is enabled. @@ -2173,6 +2175,7 @@

Method Details

}, ], "edition": "A String", # Optional. The edition of the instance. + "enableDataplexIntegration": True or False, # Optional. By default, Cloud SQL instances have schema extraction disabled for Dataplex. When this parameter is set to true, schema extraction for Dataplex on Cloud SQL instances is activated. "enableGoogleMlIntegration": True or False, # Optional. When this parameter is set to true, Cloud SQL instances can connect to Vertex AI to pass requests for real-time predictions and insights to the AI. The default value is false. This applies only to Cloud SQL for PostgreSQL instances. "insightsConfig": { # Insights configuration. This specifies when Cloud SQL Insights feature is enabled and optional configuration. # Insights configuration, for now relevant only for Postgres. "queryInsightsEnabled": True or False, # Whether Query Insights feature is enabled. @@ -2497,6 +2500,7 @@

Method Details

}, ], "edition": "A String", # Optional. The edition of the instance. + "enableDataplexIntegration": True or False, # Optional. By default, Cloud SQL instances have schema extraction disabled for Dataplex. When this parameter is set to true, schema extraction for Dataplex on Cloud SQL instances is activated. "enableGoogleMlIntegration": True or False, # Optional. When this parameter is set to true, Cloud SQL instances can connect to Vertex AI to pass requests for real-time predictions and insights to the AI. The default value is false. This applies only to Cloud SQL for PostgreSQL instances. "insightsConfig": { # Insights configuration. This specifies when Cloud SQL Insights feature is enabled and optional configuration. # Insights configuration, for now relevant only for Postgres. "queryInsightsEnabled": True or False, # Whether Query Insights feature is enabled. @@ -4182,6 +4186,7 @@

Method Details

}, ], "edition": "A String", # Optional. The edition of the instance. + "enableDataplexIntegration": True or False, # Optional. By default, Cloud SQL instances have schema extraction disabled for Dataplex. When this parameter is set to true, schema extraction for Dataplex on Cloud SQL instances is activated. "enableGoogleMlIntegration": True or False, # Optional. When this parameter is set to true, Cloud SQL instances can connect to Vertex AI to pass requests for real-time predictions and insights to the AI. The default value is false. This applies only to Cloud SQL for PostgreSQL instances. "insightsConfig": { # Insights configuration. This specifies when Cloud SQL Insights feature is enabled and optional configuration. # Insights configuration, for now relevant only for Postgres. "queryInsightsEnabled": True or False, # Whether Query Insights feature is enabled. diff --git a/docs/dyn/vmmigration_v1.projects.locations.imageImports.html b/docs/dyn/vmmigration_v1.projects.locations.imageImports.html index f8303ecef4b..79fdefc8c64 100644 --- a/docs/dyn/vmmigration_v1.projects.locations.imageImports.html +++ b/docs/dyn/vmmigration_v1.projects.locations.imageImports.html @@ -200,18 +200,18 @@

Method Details

], "warnings": [ # Output only. Warnings that occurred during the image import. { # Represents migration resource warning information that can be used with google.rpc.Status message. MigrationWarning is used to present the user with warning information in migration operations. - "actionItem": { # Provides a localized error message that is safe to return to the user which can be attached to an RPC error. # Suggested action for solving the warning. + "actionItem": { # Provides a localized error message that is safe to return to the user which can be attached to an RPC error. # Output only. Suggested action for solving the warning. "locale": "A String", # The locale used following the specification defined at https://www.rfc-editor.org/rfc/bcp/bcp47.txt. Examples are: "en-US", "fr-CH", "es-MX" "message": "A String", # The localized error message in the above locale. }, "code": "A String", # The warning code. - "helpLinks": [ # URL(s) pointing to additional information on handling the current warning. + "helpLinks": [ # Output only. URL(s) pointing to additional information on handling the current warning. { # Describes a URL link. "description": "A String", # Describes what the link offers. "url": "A String", # The URL of the link. }, ], - "warningMessage": { # Provides a localized error message that is safe to return to the user which can be attached to an RPC error. # The localized warning message. + "warningMessage": { # Provides a localized error message that is safe to return to the user which can be attached to an RPC error. # Output only. The localized warning message. "locale": "A String", # The locale used following the specification defined at https://www.rfc-editor.org/rfc/bcp/bcp47.txt. Examples are: "en-US", "fr-CH", "es-MX" "message": "A String", # The localized error message in the above locale. }, @@ -391,18 +391,18 @@

Method Details

], "warnings": [ # Output only. Warnings that occurred during the image import. { # Represents migration resource warning information that can be used with google.rpc.Status message. MigrationWarning is used to present the user with warning information in migration operations. - "actionItem": { # Provides a localized error message that is safe to return to the user which can be attached to an RPC error. # Suggested action for solving the warning. + "actionItem": { # Provides a localized error message that is safe to return to the user which can be attached to an RPC error. # Output only. Suggested action for solving the warning. "locale": "A String", # The locale used following the specification defined at https://www.rfc-editor.org/rfc/bcp/bcp47.txt. Examples are: "en-US", "fr-CH", "es-MX" "message": "A String", # The localized error message in the above locale. }, "code": "A String", # The warning code. - "helpLinks": [ # URL(s) pointing to additional information on handling the current warning. + "helpLinks": [ # Output only. URL(s) pointing to additional information on handling the current warning. { # Describes a URL link. "description": "A String", # Describes what the link offers. "url": "A String", # The URL of the link. }, ], - "warningMessage": { # Provides a localized error message that is safe to return to the user which can be attached to an RPC error. # The localized warning message. + "warningMessage": { # Provides a localized error message that is safe to return to the user which can be attached to an RPC error. # Output only. The localized warning message. "locale": "A String", # The locale used following the specification defined at https://www.rfc-editor.org/rfc/bcp/bcp47.txt. Examples are: "en-US", "fr-CH", "es-MX" "message": "A String", # The localized error message in the above locale. }, @@ -522,18 +522,18 @@

Method Details

], "warnings": [ # Output only. Warnings that occurred during the image import. { # Represents migration resource warning information that can be used with google.rpc.Status message. MigrationWarning is used to present the user with warning information in migration operations. - "actionItem": { # Provides a localized error message that is safe to return to the user which can be attached to an RPC error. # Suggested action for solving the warning. + "actionItem": { # Provides a localized error message that is safe to return to the user which can be attached to an RPC error. # Output only. Suggested action for solving the warning. "locale": "A String", # The locale used following the specification defined at https://www.rfc-editor.org/rfc/bcp/bcp47.txt. Examples are: "en-US", "fr-CH", "es-MX" "message": "A String", # The localized error message in the above locale. }, "code": "A String", # The warning code. - "helpLinks": [ # URL(s) pointing to additional information on handling the current warning. + "helpLinks": [ # Output only. URL(s) pointing to additional information on handling the current warning. { # Describes a URL link. "description": "A String", # Describes what the link offers. "url": "A String", # The URL of the link. }, ], - "warningMessage": { # Provides a localized error message that is safe to return to the user which can be attached to an RPC error. # The localized warning message. + "warningMessage": { # Provides a localized error message that is safe to return to the user which can be attached to an RPC error. # Output only. The localized warning message. "locale": "A String", # The locale used following the specification defined at https://www.rfc-editor.org/rfc/bcp/bcp47.txt. Examples are: "en-US", "fr-CH", "es-MX" "message": "A String", # The localized error message in the above locale. }, diff --git a/docs/dyn/vmmigration_v1.projects.locations.imageImports.imageImportJobs.html b/docs/dyn/vmmigration_v1.projects.locations.imageImports.imageImportJobs.html index 3453e93840a..83b93ff8483 100644 --- a/docs/dyn/vmmigration_v1.projects.locations.imageImports.imageImportJobs.html +++ b/docs/dyn/vmmigration_v1.projects.locations.imageImports.imageImportJobs.html @@ -208,18 +208,18 @@

Method Details

], "warnings": [ # Output only. Warnings that occurred during the image import. { # Represents migration resource warning information that can be used with google.rpc.Status message. MigrationWarning is used to present the user with warning information in migration operations. - "actionItem": { # Provides a localized error message that is safe to return to the user which can be attached to an RPC error. # Suggested action for solving the warning. + "actionItem": { # Provides a localized error message that is safe to return to the user which can be attached to an RPC error. # Output only. Suggested action for solving the warning. "locale": "A String", # The locale used following the specification defined at https://www.rfc-editor.org/rfc/bcp/bcp47.txt. Examples are: "en-US", "fr-CH", "es-MX" "message": "A String", # The localized error message in the above locale. }, "code": "A String", # The warning code. - "helpLinks": [ # URL(s) pointing to additional information on handling the current warning. + "helpLinks": [ # Output only. URL(s) pointing to additional information on handling the current warning. { # Describes a URL link. "description": "A String", # Describes what the link offers. "url": "A String", # The URL of the link. }, ], - "warningMessage": { # Provides a localized error message that is safe to return to the user which can be attached to an RPC error. # The localized warning message. + "warningMessage": { # Provides a localized error message that is safe to return to the user which can be attached to an RPC error. # Output only. The localized warning message. "locale": "A String", # The locale used following the specification defined at https://www.rfc-editor.org/rfc/bcp/bcp47.txt. Examples are: "en-US", "fr-CH", "es-MX" "message": "A String", # The localized error message in the above locale. }, @@ -307,18 +307,18 @@

Method Details

], "warnings": [ # Output only. Warnings that occurred during the image import. { # Represents migration resource warning information that can be used with google.rpc.Status message. MigrationWarning is used to present the user with warning information in migration operations. - "actionItem": { # Provides a localized error message that is safe to return to the user which can be attached to an RPC error. # Suggested action for solving the warning. + "actionItem": { # Provides a localized error message that is safe to return to the user which can be attached to an RPC error. # Output only. Suggested action for solving the warning. "locale": "A String", # The locale used following the specification defined at https://www.rfc-editor.org/rfc/bcp/bcp47.txt. Examples are: "en-US", "fr-CH", "es-MX" "message": "A String", # The localized error message in the above locale. }, "code": "A String", # The warning code. - "helpLinks": [ # URL(s) pointing to additional information on handling the current warning. + "helpLinks": [ # Output only. URL(s) pointing to additional information on handling the current warning. { # Describes a URL link. "description": "A String", # Describes what the link offers. "url": "A String", # The URL of the link. }, ], - "warningMessage": { # Provides a localized error message that is safe to return to the user which can be attached to an RPC error. # The localized warning message. + "warningMessage": { # Provides a localized error message that is safe to return to the user which can be attached to an RPC error. # Output only. The localized warning message. "locale": "A String", # The locale used following the specification defined at https://www.rfc-editor.org/rfc/bcp/bcp47.txt. Examples are: "en-US", "fr-CH", "es-MX" "message": "A String", # The localized error message in the above locale. }, diff --git a/docs/dyn/vmmigration_v1.projects.locations.sources.datacenterConnectors.html b/docs/dyn/vmmigration_v1.projects.locations.sources.datacenterConnectors.html index 57ce05c403c..5beb152f040 100644 --- a/docs/dyn/vmmigration_v1.projects.locations.sources.datacenterConnectors.html +++ b/docs/dyn/vmmigration_v1.projects.locations.sources.datacenterConnectors.html @@ -145,7 +145,7 @@

Method Details

"stateTime": "A String", # Output only. The time the state was last set. "updateTime": "A String", # Output only. The last time the connector was updated with an API call. "upgradeStatus": { # UpgradeStatus contains information about upgradeAppliance operation. # Output only. The status of the current / last upgradeAppliance operation. - "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). # Provides details on the state of the upgrade operation in case of an error. + "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). # Output only. Provides details on the state of the upgrade operation in case of an error. "code": 42, # The status code, which should be an enum value of google.rpc.Code. "details": [ # A list of messages that carry the error details. There is a common set of message types for APIs to use. { @@ -278,7 +278,7 @@

Method Details

"stateTime": "A String", # Output only. The time the state was last set. "updateTime": "A String", # Output only. The last time the connector was updated with an API call. "upgradeStatus": { # UpgradeStatus contains information about upgradeAppliance operation. # Output only. The status of the current / last upgradeAppliance operation. - "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). # Provides details on the state of the upgrade operation in case of an error. + "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). # Output only. Provides details on the state of the upgrade operation in case of an error. "code": 42, # The status code, which should be an enum value of google.rpc.Code. "details": [ # A list of messages that carry the error details. There is a common set of message types for APIs to use. { @@ -351,7 +351,7 @@

Method Details

"stateTime": "A String", # Output only. The time the state was last set. "updateTime": "A String", # Output only. The last time the connector was updated with an API call. "upgradeStatus": { # UpgradeStatus contains information about upgradeAppliance operation. # Output only. The status of the current / last upgradeAppliance operation. - "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). # Provides details on the state of the upgrade operation in case of an error. + "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). # Output only. Provides details on the state of the upgrade operation in case of an error. "code": 42, # The status code, which should be an enum value of google.rpc.Code. "details": [ # A list of messages that carry the error details. There is a common set of message types for APIs to use. { diff --git a/docs/dyn/vmmigration_v1.projects.locations.sources.html b/docs/dyn/vmmigration_v1.projects.locations.sources.html index 347c0f4e857..dd8b6a90120 100644 --- a/docs/dyn/vmmigration_v1.projects.locations.sources.html +++ b/docs/dyn/vmmigration_v1.projects.locations.sources.html @@ -153,8 +153,8 @@

Method Details

], "inventoryTagList": [ # AWS resource tags to limit the scope of the source inventory. { # Tag is an AWS tag representation. - "key": "A String", # Key of tag. - "value": "A String", # Value of tag. + "key": "A String", # Required. Key of tag. + "value": "A String", # Required. Value of tag. }, ], "migrationResourcesUserTags": { # User specified tags to add to every M2VM generated resource in AWS. These tags will be set in addition to the default tags that are set as part of the migration process. The tags must not begin with the reserved prefix `m2vm`. @@ -430,8 +430,8 @@

Method Details

], "inventoryTagList": [ # AWS resource tags to limit the scope of the source inventory. { # Tag is an AWS tag representation. - "key": "A String", # Key of tag. - "value": "A String", # Value of tag. + "key": "A String", # Required. Key of tag. + "value": "A String", # Required. Value of tag. }, ], "migrationResourcesUserTags": { # User specified tags to add to every M2VM generated resource in AWS. These tags will be set in addition to the default tags that are set as part of the migration process. The tags must not begin with the reserved prefix `m2vm`. @@ -526,8 +526,8 @@

Method Details

], "inventoryTagList": [ # AWS resource tags to limit the scope of the source inventory. { # Tag is an AWS tag representation. - "key": "A String", # Key of tag. - "value": "A String", # Value of tag. + "key": "A String", # Required. Key of tag. + "value": "A String", # Required. Value of tag. }, ], "migrationResourcesUserTags": { # User specified tags to add to every M2VM generated resource in AWS. These tags will be set in addition to the default tags that are set as part of the migration process. The tags must not begin with the reserved prefix `m2vm`. @@ -629,8 +629,8 @@

Method Details

], "inventoryTagList": [ # AWS resource tags to limit the scope of the source inventory. { # Tag is an AWS tag representation. - "key": "A String", # Key of tag. - "value": "A String", # Value of tag. + "key": "A String", # Required. Key of tag. + "value": "A String", # Required. Value of tag. }, ], "migrationResourcesUserTags": { # User specified tags to add to every M2VM generated resource in AWS. These tags will be set in addition to the default tags that are set as part of the migration process. The tags must not begin with the reserved prefix `m2vm`. diff --git a/docs/dyn/vmmigration_v1.projects.locations.sources.migratingVms.cloneJobs.html b/docs/dyn/vmmigration_v1.projects.locations.sources.migratingVms.cloneJobs.html index 3992f230385..251fec45225 100644 --- a/docs/dyn/vmmigration_v1.projects.locations.sources.migratingVms.cloneJobs.html +++ b/docs/dyn/vmmigration_v1.projects.locations.sources.migratingVms.cloneJobs.html @@ -201,8 +201,8 @@

Method Details

}, "networkInterfaces": [ # List of NICs connected to this VM. { # NetworkInterface represents a NIC of a VM. - "externalIp": "A String", # The external IP to define in the NIC. - "internalIp": "A String", # The internal IP to define in the NIC. The formats accepted are: `ephemeral` \ ipv4 address \ a named address resource full path. + "externalIp": "A String", # Optional. The external IP to define in the NIC. + "internalIp": "A String", # Optional. The internal IP to define in the NIC. The formats accepted are: `ephemeral` \ ipv4 address \ a named address resource full path. "network": "A String", # The network to connect the NIC to. "subnetwork": "A String", # The subnetwork to connect the NIC to. }, @@ -342,8 +342,8 @@

Method Details

}, "networkInterfaces": [ # List of NICs connected to this VM. { # NetworkInterface represents a NIC of a VM. - "externalIp": "A String", # The external IP to define in the NIC. - "internalIp": "A String", # The internal IP to define in the NIC. The formats accepted are: `ephemeral` \ ipv4 address \ a named address resource full path. + "externalIp": "A String", # Optional. The external IP to define in the NIC. + "internalIp": "A String", # Optional. The internal IP to define in the NIC. The formats accepted are: `ephemeral` \ ipv4 address \ a named address resource full path. "network": "A String", # The network to connect the NIC to. "subnetwork": "A String", # The subnetwork to connect the NIC to. }, @@ -459,8 +459,8 @@

Method Details

}, "networkInterfaces": [ # List of NICs connected to this VM. { # NetworkInterface represents a NIC of a VM. - "externalIp": "A String", # The external IP to define in the NIC. - "internalIp": "A String", # The internal IP to define in the NIC. The formats accepted are: `ephemeral` \ ipv4 address \ a named address resource full path. + "externalIp": "A String", # Optional. The external IP to define in the NIC. + "internalIp": "A String", # Optional. The internal IP to define in the NIC. The formats accepted are: `ephemeral` \ ipv4 address \ a named address resource full path. "network": "A String", # The network to connect the NIC to. "subnetwork": "A String", # The subnetwork to connect the NIC to. }, diff --git a/docs/dyn/vmmigration_v1.projects.locations.sources.migratingVms.cutoverJobs.html b/docs/dyn/vmmigration_v1.projects.locations.sources.migratingVms.cutoverJobs.html index 50b274f0de3..e74babd2590 100644 --- a/docs/dyn/vmmigration_v1.projects.locations.sources.migratingVms.cutoverJobs.html +++ b/docs/dyn/vmmigration_v1.projects.locations.sources.migratingVms.cutoverJobs.html @@ -201,8 +201,8 @@

Method Details

}, "networkInterfaces": [ # List of NICs connected to this VM. { # NetworkInterface represents a NIC of a VM. - "externalIp": "A String", # The external IP to define in the NIC. - "internalIp": "A String", # The internal IP to define in the NIC. The formats accepted are: `ephemeral` \ ipv4 address \ a named address resource full path. + "externalIp": "A String", # Optional. The external IP to define in the NIC. + "internalIp": "A String", # Optional. The internal IP to define in the NIC. The formats accepted are: `ephemeral` \ ipv4 address \ a named address resource full path. "network": "A String", # The network to connect the NIC to. "subnetwork": "A String", # The subnetwork to connect the NIC to. }, @@ -238,7 +238,7 @@

Method Details

"finalSync": { # ReplicationCycle contains information about the current replication cycle status. # Final sync step. "cycleNumber": 42, # The cycle's ordinal number. "endTime": "A String", # The time the replication cycle has ended. - "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). # Provides details on the state of the cycle in case of an error. + "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). # Output only. Provides details on the state of the cycle in case of an error. "code": 42, # The status code, which should be an enum value of google.rpc.Code. "details": [ # A list of messages that carry the error details. There is a common set of message types for APIs to use. { @@ -270,18 +270,18 @@

Method Details

"totalPauseDuration": "A String", # The accumulated duration the replication cycle was paused. "warnings": [ # Output only. Warnings that occurred during the cycle. { # Represents migration resource warning information that can be used with google.rpc.Status message. MigrationWarning is used to present the user with warning information in migration operations. - "actionItem": { # Provides a localized error message that is safe to return to the user which can be attached to an RPC error. # Suggested action for solving the warning. + "actionItem": { # Provides a localized error message that is safe to return to the user which can be attached to an RPC error. # Output only. Suggested action for solving the warning. "locale": "A String", # The locale used following the specification defined at https://www.rfc-editor.org/rfc/bcp/bcp47.txt. Examples are: "en-US", "fr-CH", "es-MX" "message": "A String", # The localized error message in the above locale. }, "code": "A String", # The warning code. - "helpLinks": [ # URL(s) pointing to additional information on handling the current warning. + "helpLinks": [ # Output only. URL(s) pointing to additional information on handling the current warning. { # Describes a URL link. "description": "A String", # Describes what the link offers. "url": "A String", # The URL of the link. }, ], - "warningMessage": { # Provides a localized error message that is safe to return to the user which can be attached to an RPC error. # The localized warning message. + "warningMessage": { # Provides a localized error message that is safe to return to the user which can be attached to an RPC error. # Output only. The localized warning message. "locale": "A String", # The locale used following the specification defined at https://www.rfc-editor.org/rfc/bcp/bcp47.txt. Examples are: "en-US", "fr-CH", "es-MX" "message": "A String", # The localized error message in the above locale. }, @@ -296,7 +296,7 @@

Method Details

"previousReplicationCycle": { # ReplicationCycle contains information about the current replication cycle status. # A replication cycle prior cutover step. "cycleNumber": 42, # The cycle's ordinal number. "endTime": "A String", # The time the replication cycle has ended. - "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). # Provides details on the state of the cycle in case of an error. + "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). # Output only. Provides details on the state of the cycle in case of an error. "code": 42, # The status code, which should be an enum value of google.rpc.Code. "details": [ # A list of messages that carry the error details. There is a common set of message types for APIs to use. { @@ -328,18 +328,18 @@

Method Details

"totalPauseDuration": "A String", # The accumulated duration the replication cycle was paused. "warnings": [ # Output only. Warnings that occurred during the cycle. { # Represents migration resource warning information that can be used with google.rpc.Status message. MigrationWarning is used to present the user with warning information in migration operations. - "actionItem": { # Provides a localized error message that is safe to return to the user which can be attached to an RPC error. # Suggested action for solving the warning. + "actionItem": { # Provides a localized error message that is safe to return to the user which can be attached to an RPC error. # Output only. Suggested action for solving the warning. "locale": "A String", # The locale used following the specification defined at https://www.rfc-editor.org/rfc/bcp/bcp47.txt. Examples are: "en-US", "fr-CH", "es-MX" "message": "A String", # The localized error message in the above locale. }, "code": "A String", # The warning code. - "helpLinks": [ # URL(s) pointing to additional information on handling the current warning. + "helpLinks": [ # Output only. URL(s) pointing to additional information on handling the current warning. { # Describes a URL link. "description": "A String", # Describes what the link offers. "url": "A String", # The URL of the link. }, ], - "warningMessage": { # Provides a localized error message that is safe to return to the user which can be attached to an RPC error. # The localized warning message. + "warningMessage": { # Provides a localized error message that is safe to return to the user which can be attached to an RPC error. # Output only. The localized warning message. "locale": "A String", # The locale used following the specification defined at https://www.rfc-editor.org/rfc/bcp/bcp47.txt. Examples are: "en-US", "fr-CH", "es-MX" "message": "A String", # The localized error message in the above locale. }, @@ -452,8 +452,8 @@

Method Details

}, "networkInterfaces": [ # List of NICs connected to this VM. { # NetworkInterface represents a NIC of a VM. - "externalIp": "A String", # The external IP to define in the NIC. - "internalIp": "A String", # The internal IP to define in the NIC. The formats accepted are: `ephemeral` \ ipv4 address \ a named address resource full path. + "externalIp": "A String", # Optional. The external IP to define in the NIC. + "internalIp": "A String", # Optional. The internal IP to define in the NIC. The formats accepted are: `ephemeral` \ ipv4 address \ a named address resource full path. "network": "A String", # The network to connect the NIC to. "subnetwork": "A String", # The subnetwork to connect the NIC to. }, @@ -489,7 +489,7 @@

Method Details

"finalSync": { # ReplicationCycle contains information about the current replication cycle status. # Final sync step. "cycleNumber": 42, # The cycle's ordinal number. "endTime": "A String", # The time the replication cycle has ended. - "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). # Provides details on the state of the cycle in case of an error. + "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). # Output only. Provides details on the state of the cycle in case of an error. "code": 42, # The status code, which should be an enum value of google.rpc.Code. "details": [ # A list of messages that carry the error details. There is a common set of message types for APIs to use. { @@ -521,18 +521,18 @@

Method Details

"totalPauseDuration": "A String", # The accumulated duration the replication cycle was paused. "warnings": [ # Output only. Warnings that occurred during the cycle. { # Represents migration resource warning information that can be used with google.rpc.Status message. MigrationWarning is used to present the user with warning information in migration operations. - "actionItem": { # Provides a localized error message that is safe to return to the user which can be attached to an RPC error. # Suggested action for solving the warning. + "actionItem": { # Provides a localized error message that is safe to return to the user which can be attached to an RPC error. # Output only. Suggested action for solving the warning. "locale": "A String", # The locale used following the specification defined at https://www.rfc-editor.org/rfc/bcp/bcp47.txt. Examples are: "en-US", "fr-CH", "es-MX" "message": "A String", # The localized error message in the above locale. }, "code": "A String", # The warning code. - "helpLinks": [ # URL(s) pointing to additional information on handling the current warning. + "helpLinks": [ # Output only. URL(s) pointing to additional information on handling the current warning. { # Describes a URL link. "description": "A String", # Describes what the link offers. "url": "A String", # The URL of the link. }, ], - "warningMessage": { # Provides a localized error message that is safe to return to the user which can be attached to an RPC error. # The localized warning message. + "warningMessage": { # Provides a localized error message that is safe to return to the user which can be attached to an RPC error. # Output only. The localized warning message. "locale": "A String", # The locale used following the specification defined at https://www.rfc-editor.org/rfc/bcp/bcp47.txt. Examples are: "en-US", "fr-CH", "es-MX" "message": "A String", # The localized error message in the above locale. }, @@ -547,7 +547,7 @@

Method Details

"previousReplicationCycle": { # ReplicationCycle contains information about the current replication cycle status. # A replication cycle prior cutover step. "cycleNumber": 42, # The cycle's ordinal number. "endTime": "A String", # The time the replication cycle has ended. - "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). # Provides details on the state of the cycle in case of an error. + "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). # Output only. Provides details on the state of the cycle in case of an error. "code": 42, # The status code, which should be an enum value of google.rpc.Code. "details": [ # A list of messages that carry the error details. There is a common set of message types for APIs to use. { @@ -579,18 +579,18 @@

Method Details

"totalPauseDuration": "A String", # The accumulated duration the replication cycle was paused. "warnings": [ # Output only. Warnings that occurred during the cycle. { # Represents migration resource warning information that can be used with google.rpc.Status message. MigrationWarning is used to present the user with warning information in migration operations. - "actionItem": { # Provides a localized error message that is safe to return to the user which can be attached to an RPC error. # Suggested action for solving the warning. + "actionItem": { # Provides a localized error message that is safe to return to the user which can be attached to an RPC error. # Output only. Suggested action for solving the warning. "locale": "A String", # The locale used following the specification defined at https://www.rfc-editor.org/rfc/bcp/bcp47.txt. Examples are: "en-US", "fr-CH", "es-MX" "message": "A String", # The localized error message in the above locale. }, "code": "A String", # The warning code. - "helpLinks": [ # URL(s) pointing to additional information on handling the current warning. + "helpLinks": [ # Output only. URL(s) pointing to additional information on handling the current warning. { # Describes a URL link. "description": "A String", # Describes what the link offers. "url": "A String", # The URL of the link. }, ], - "warningMessage": { # Provides a localized error message that is safe to return to the user which can be attached to an RPC error. # The localized warning message. + "warningMessage": { # Provides a localized error message that is safe to return to the user which can be attached to an RPC error. # Output only. The localized warning message. "locale": "A String", # The locale used following the specification defined at https://www.rfc-editor.org/rfc/bcp/bcp47.txt. Examples are: "en-US", "fr-CH", "es-MX" "message": "A String", # The localized error message in the above locale. }, @@ -679,8 +679,8 @@

Method Details

}, "networkInterfaces": [ # List of NICs connected to this VM. { # NetworkInterface represents a NIC of a VM. - "externalIp": "A String", # The external IP to define in the NIC. - "internalIp": "A String", # The internal IP to define in the NIC. The formats accepted are: `ephemeral` \ ipv4 address \ a named address resource full path. + "externalIp": "A String", # Optional. The external IP to define in the NIC. + "internalIp": "A String", # Optional. The internal IP to define in the NIC. The formats accepted are: `ephemeral` \ ipv4 address \ a named address resource full path. "network": "A String", # The network to connect the NIC to. "subnetwork": "A String", # The subnetwork to connect the NIC to. }, @@ -716,7 +716,7 @@

Method Details

"finalSync": { # ReplicationCycle contains information about the current replication cycle status. # Final sync step. "cycleNumber": 42, # The cycle's ordinal number. "endTime": "A String", # The time the replication cycle has ended. - "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). # Provides details on the state of the cycle in case of an error. + "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). # Output only. Provides details on the state of the cycle in case of an error. "code": 42, # The status code, which should be an enum value of google.rpc.Code. "details": [ # A list of messages that carry the error details. There is a common set of message types for APIs to use. { @@ -748,18 +748,18 @@

Method Details

"totalPauseDuration": "A String", # The accumulated duration the replication cycle was paused. "warnings": [ # Output only. Warnings that occurred during the cycle. { # Represents migration resource warning information that can be used with google.rpc.Status message. MigrationWarning is used to present the user with warning information in migration operations. - "actionItem": { # Provides a localized error message that is safe to return to the user which can be attached to an RPC error. # Suggested action for solving the warning. + "actionItem": { # Provides a localized error message that is safe to return to the user which can be attached to an RPC error. # Output only. Suggested action for solving the warning. "locale": "A String", # The locale used following the specification defined at https://www.rfc-editor.org/rfc/bcp/bcp47.txt. Examples are: "en-US", "fr-CH", "es-MX" "message": "A String", # The localized error message in the above locale. }, "code": "A String", # The warning code. - "helpLinks": [ # URL(s) pointing to additional information on handling the current warning. + "helpLinks": [ # Output only. URL(s) pointing to additional information on handling the current warning. { # Describes a URL link. "description": "A String", # Describes what the link offers. "url": "A String", # The URL of the link. }, ], - "warningMessage": { # Provides a localized error message that is safe to return to the user which can be attached to an RPC error. # The localized warning message. + "warningMessage": { # Provides a localized error message that is safe to return to the user which can be attached to an RPC error. # Output only. The localized warning message. "locale": "A String", # The locale used following the specification defined at https://www.rfc-editor.org/rfc/bcp/bcp47.txt. Examples are: "en-US", "fr-CH", "es-MX" "message": "A String", # The localized error message in the above locale. }, @@ -774,7 +774,7 @@

Method Details

"previousReplicationCycle": { # ReplicationCycle contains information about the current replication cycle status. # A replication cycle prior cutover step. "cycleNumber": 42, # The cycle's ordinal number. "endTime": "A String", # The time the replication cycle has ended. - "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). # Provides details on the state of the cycle in case of an error. + "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). # Output only. Provides details on the state of the cycle in case of an error. "code": 42, # The status code, which should be an enum value of google.rpc.Code. "details": [ # A list of messages that carry the error details. There is a common set of message types for APIs to use. { @@ -806,18 +806,18 @@

Method Details

"totalPauseDuration": "A String", # The accumulated duration the replication cycle was paused. "warnings": [ # Output only. Warnings that occurred during the cycle. { # Represents migration resource warning information that can be used with google.rpc.Status message. MigrationWarning is used to present the user with warning information in migration operations. - "actionItem": { # Provides a localized error message that is safe to return to the user which can be attached to an RPC error. # Suggested action for solving the warning. + "actionItem": { # Provides a localized error message that is safe to return to the user which can be attached to an RPC error. # Output only. Suggested action for solving the warning. "locale": "A String", # The locale used following the specification defined at https://www.rfc-editor.org/rfc/bcp/bcp47.txt. Examples are: "en-US", "fr-CH", "es-MX" "message": "A String", # The localized error message in the above locale. }, "code": "A String", # The warning code. - "helpLinks": [ # URL(s) pointing to additional information on handling the current warning. + "helpLinks": [ # Output only. URL(s) pointing to additional information on handling the current warning. { # Describes a URL link. "description": "A String", # Describes what the link offers. "url": "A String", # The URL of the link. }, ], - "warningMessage": { # Provides a localized error message that is safe to return to the user which can be attached to an RPC error. # The localized warning message. + "warningMessage": { # Provides a localized error message that is safe to return to the user which can be attached to an RPC error. # Output only. The localized warning message. "locale": "A String", # The locale used following the specification defined at https://www.rfc-editor.org/rfc/bcp/bcp47.txt. Examples are: "en-US", "fr-CH", "es-MX" "message": "A String", # The localized error message in the above locale. }, diff --git a/docs/dyn/vmmigration_v1.projects.locations.sources.migratingVms.html b/docs/dyn/vmmigration_v1.projects.locations.sources.migratingVms.html index 055488099ae..1faa21ffc38 100644 --- a/docs/dyn/vmmigration_v1.projects.locations.sources.migratingVms.html +++ b/docs/dyn/vmmigration_v1.projects.locations.sources.migratingVms.html @@ -139,15 +139,15 @@

Method Details

{ # MigratingVm describes the VM that will be migrated from a Source environment and its replication state. "awsSourceVmDetails": { # Represent the source AWS VM details. # Output only. Details of the VM from an AWS source. - "committedStorageBytes": "A String", # The total size of the disks being migrated in bytes. - "disks": [ # The disks attached to the source VM. + "committedStorageBytes": "A String", # Output only. The total size of the disks being migrated in bytes. + "disks": [ # Output only. The disks attached to the source VM. { # The details of an AWS instance disk. - "diskNumber": 42, # The ordinal number of the disk. - "sizeGb": "A String", # Size in GB. - "volumeId": "A String", # AWS volume ID. + "diskNumber": 42, # Output only. The ordinal number of the disk. + "sizeGb": "A String", # Output only. Size in GB. + "volumeId": "A String", # Output only. AWS volume ID. }, ], - "firmware": "A String", # The firmware type of the source VM. + "firmware": "A String", # Output only. The firmware type of the source VM. "vmCapabilitiesInfo": { # Migrating VM source information about the VM capabilities needed for some Compute Engine features. # Output only. Information about VM capabilities needed for some Compute Engine features. "lastOsCapabilitiesUpdateTime": "A String", # Output only. The last time OS capabilities list was updated. "osCapabilities": [ # Output only. Unordered list. List of certain VM OS capabilities needed for some Compute Engine features. @@ -156,15 +156,15 @@

Method Details

}, }, "azureSourceVmDetails": { # Represent the source Azure VM details. # Output only. Details of the VM from an Azure source. - "committedStorageBytes": "A String", # The total size of the disks being migrated in bytes. - "disks": [ # The disks attached to the source VM. + "committedStorageBytes": "A String", # Output only. The total size of the disks being migrated in bytes. + "disks": [ # Output only. The disks attached to the source VM. { # The details of an Azure VM disk. - "diskId": "A String", # Azure disk ID. - "diskNumber": 42, # The ordinal number of the disk. - "sizeGb": "A String", # Size in GB. + "diskId": "A String", # Output only. Azure disk ID. + "diskNumber": 42, # Output only. The ordinal number of the disk. + "sizeGb": "A String", # Output only. Size in GB. }, ], - "firmware": "A String", # The firmware type of the source VM. + "firmware": "A String", # Output only. The firmware type of the source VM. "vmCapabilitiesInfo": { # Migrating VM source information about the VM capabilities needed for some Compute Engine features. # Output only. Information about VM capabilities needed for some Compute Engine features. "lastOsCapabilitiesUpdateTime": "A String", # Output only. The last time OS capabilities list was updated. "osCapabilities": [ # Output only. Unordered list. List of certain VM OS capabilities needed for some Compute Engine features. @@ -235,8 +235,8 @@

Method Details

}, "networkInterfaces": [ # Optional. NICs to attach to the VM. { # NetworkInterface represents a NIC of a VM. - "externalIp": "A String", # The external IP to define in the NIC. - "internalIp": "A String", # The internal IP to define in the NIC. The formats accepted are: `ephemeral` \ ipv4 address \ a named address resource full path. + "externalIp": "A String", # Optional. The external IP to define in the NIC. + "internalIp": "A String", # Optional. The internal IP to define in the NIC. The formats accepted are: `ephemeral` \ ipv4 address \ a named address resource full path. "network": "A String", # The network to connect the NIC to. "subnetwork": "A String", # The subnetwork to connect the NIC to. }, @@ -289,8 +289,8 @@

Method Details

}, "networkInterfaces": [ # List of NICs connected to this VM. { # NetworkInterface represents a NIC of a VM. - "externalIp": "A String", # The external IP to define in the NIC. - "internalIp": "A String", # The internal IP to define in the NIC. The formats accepted are: `ephemeral` \ ipv4 address \ a named address resource full path. + "externalIp": "A String", # Optional. The external IP to define in the NIC. + "internalIp": "A String", # Optional. The internal IP to define in the NIC. The formats accepted are: `ephemeral` \ ipv4 address \ a named address resource full path. "network": "A String", # The network to connect the NIC to. "subnetwork": "A String", # The subnetwork to connect the NIC to. }, @@ -308,7 +308,7 @@

Method Details

"currentSyncInfo": { # ReplicationCycle contains information about the current replication cycle status. # Output only. Details of the current running replication cycle. "cycleNumber": 42, # The cycle's ordinal number. "endTime": "A String", # The time the replication cycle has ended. - "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). # Provides details on the state of the cycle in case of an error. + "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). # Output only. Provides details on the state of the cycle in case of an error. "code": 42, # The status code, which should be an enum value of google.rpc.Code. "details": [ # A list of messages that carry the error details. There is a common set of message types for APIs to use. { @@ -340,18 +340,18 @@

Method Details

"totalPauseDuration": "A String", # The accumulated duration the replication cycle was paused. "warnings": [ # Output only. Warnings that occurred during the cycle. { # Represents migration resource warning information that can be used with google.rpc.Status message. MigrationWarning is used to present the user with warning information in migration operations. - "actionItem": { # Provides a localized error message that is safe to return to the user which can be attached to an RPC error. # Suggested action for solving the warning. + "actionItem": { # Provides a localized error message that is safe to return to the user which can be attached to an RPC error. # Output only. Suggested action for solving the warning. "locale": "A String", # The locale used following the specification defined at https://www.rfc-editor.org/rfc/bcp/bcp47.txt. Examples are: "en-US", "fr-CH", "es-MX" "message": "A String", # The localized error message in the above locale. }, "code": "A String", # The warning code. - "helpLinks": [ # URL(s) pointing to additional information on handling the current warning. + "helpLinks": [ # Output only. URL(s) pointing to additional information on handling the current warning. { # Describes a URL link. "description": "A String", # Describes what the link offers. "url": "A String", # The URL of the link. }, ], - "warningMessage": { # Provides a localized error message that is safe to return to the user which can be attached to an RPC error. # The localized warning message. + "warningMessage": { # Provides a localized error message that is safe to return to the user which can be attached to an RPC error. # Output only. The localized warning message. "locale": "A String", # The locale used following the specification defined at https://www.rfc-editor.org/rfc/bcp/bcp47.txt. Examples are: "en-US", "fr-CH", "es-MX" "message": "A String", # The localized error message in the above locale. }, @@ -380,7 +380,7 @@

Method Details

"lastReplicationCycle": { # ReplicationCycle contains information about the current replication cycle status. # Output only. Details of the last replication cycle. This will be updated whenever a replication cycle is finished and is not to be confused with last_sync which is only updated on successful replication cycles. "cycleNumber": 42, # The cycle's ordinal number. "endTime": "A String", # The time the replication cycle has ended. - "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). # Provides details on the state of the cycle in case of an error. + "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). # Output only. Provides details on the state of the cycle in case of an error. "code": 42, # The status code, which should be an enum value of google.rpc.Code. "details": [ # A list of messages that carry the error details. There is a common set of message types for APIs to use. { @@ -412,18 +412,18 @@

Method Details

"totalPauseDuration": "A String", # The accumulated duration the replication cycle was paused. "warnings": [ # Output only. Warnings that occurred during the cycle. { # Represents migration resource warning information that can be used with google.rpc.Status message. MigrationWarning is used to present the user with warning information in migration operations. - "actionItem": { # Provides a localized error message that is safe to return to the user which can be attached to an RPC error. # Suggested action for solving the warning. + "actionItem": { # Provides a localized error message that is safe to return to the user which can be attached to an RPC error. # Output only. Suggested action for solving the warning. "locale": "A String", # The locale used following the specification defined at https://www.rfc-editor.org/rfc/bcp/bcp47.txt. Examples are: "en-US", "fr-CH", "es-MX" "message": "A String", # The localized error message in the above locale. }, "code": "A String", # The warning code. - "helpLinks": [ # URL(s) pointing to additional information on handling the current warning. + "helpLinks": [ # Output only. URL(s) pointing to additional information on handling the current warning. { # Describes a URL link. "description": "A String", # Describes what the link offers. "url": "A String", # The URL of the link. }, ], - "warningMessage": { # Provides a localized error message that is safe to return to the user which can be attached to an RPC error. # The localized warning message. + "warningMessage": { # Provides a localized error message that is safe to return to the user which can be attached to an RPC error. # Output only. The localized warning message. "locale": "A String", # The locale used following the specification defined at https://www.rfc-editor.org/rfc/bcp/bcp47.txt. Examples are: "en-US", "fr-CH", "es-MX" "message": "A String", # The localized error message in the above locale. }, @@ -493,8 +493,8 @@

Method Details

}, "networkInterfaces": [ # List of NICs connected to this VM. { # NetworkInterface represents a NIC of a VM. - "externalIp": "A String", # The external IP to define in the NIC. - "internalIp": "A String", # The internal IP to define in the NIC. The formats accepted are: `ephemeral` \ ipv4 address \ a named address resource full path. + "externalIp": "A String", # Optional. The external IP to define in the NIC. + "internalIp": "A String", # Optional. The internal IP to define in the NIC. The formats accepted are: `ephemeral` \ ipv4 address \ a named address resource full path. "network": "A String", # The network to connect the NIC to. "subnetwork": "A String", # The subnetwork to connect the NIC to. }, @@ -590,8 +590,8 @@

Method Details

}, "networkInterfaces": [ # List of NICs connected to this VM. { # NetworkInterface represents a NIC of a VM. - "externalIp": "A String", # The external IP to define in the NIC. - "internalIp": "A String", # The internal IP to define in the NIC. The formats accepted are: `ephemeral` \ ipv4 address \ a named address resource full path. + "externalIp": "A String", # Optional. The external IP to define in the NIC. + "internalIp": "A String", # Optional. The internal IP to define in the NIC. The formats accepted are: `ephemeral` \ ipv4 address \ a named address resource full path. "network": "A String", # The network to connect the NIC to. "subnetwork": "A String", # The subnetwork to connect the NIC to. }, @@ -627,7 +627,7 @@

Method Details

"finalSync": { # ReplicationCycle contains information about the current replication cycle status. # Final sync step. "cycleNumber": 42, # The cycle's ordinal number. "endTime": "A String", # The time the replication cycle has ended. - "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). # Provides details on the state of the cycle in case of an error. + "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). # Output only. Provides details on the state of the cycle in case of an error. "code": 42, # The status code, which should be an enum value of google.rpc.Code. "details": [ # A list of messages that carry the error details. There is a common set of message types for APIs to use. { @@ -659,18 +659,18 @@

Method Details

"totalPauseDuration": "A String", # The accumulated duration the replication cycle was paused. "warnings": [ # Output only. Warnings that occurred during the cycle. { # Represents migration resource warning information that can be used with google.rpc.Status message. MigrationWarning is used to present the user with warning information in migration operations. - "actionItem": { # Provides a localized error message that is safe to return to the user which can be attached to an RPC error. # Suggested action for solving the warning. + "actionItem": { # Provides a localized error message that is safe to return to the user which can be attached to an RPC error. # Output only. Suggested action for solving the warning. "locale": "A String", # The locale used following the specification defined at https://www.rfc-editor.org/rfc/bcp/bcp47.txt. Examples are: "en-US", "fr-CH", "es-MX" "message": "A String", # The localized error message in the above locale. }, "code": "A String", # The warning code. - "helpLinks": [ # URL(s) pointing to additional information on handling the current warning. + "helpLinks": [ # Output only. URL(s) pointing to additional information on handling the current warning. { # Describes a URL link. "description": "A String", # Describes what the link offers. "url": "A String", # The URL of the link. }, ], - "warningMessage": { # Provides a localized error message that is safe to return to the user which can be attached to an RPC error. # The localized warning message. + "warningMessage": { # Provides a localized error message that is safe to return to the user which can be attached to an RPC error. # Output only. The localized warning message. "locale": "A String", # The locale used following the specification defined at https://www.rfc-editor.org/rfc/bcp/bcp47.txt. Examples are: "en-US", "fr-CH", "es-MX" "message": "A String", # The localized error message in the above locale. }, @@ -685,7 +685,7 @@

Method Details

"previousReplicationCycle": { # ReplicationCycle contains information about the current replication cycle status. # A replication cycle prior cutover step. "cycleNumber": 42, # The cycle's ordinal number. "endTime": "A String", # The time the replication cycle has ended. - "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). # Provides details on the state of the cycle in case of an error. + "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). # Output only. Provides details on the state of the cycle in case of an error. "code": 42, # The status code, which should be an enum value of google.rpc.Code. "details": [ # A list of messages that carry the error details. There is a common set of message types for APIs to use. { @@ -717,18 +717,18 @@

Method Details

"totalPauseDuration": "A String", # The accumulated duration the replication cycle was paused. "warnings": [ # Output only. Warnings that occurred during the cycle. { # Represents migration resource warning information that can be used with google.rpc.Status message. MigrationWarning is used to present the user with warning information in migration operations. - "actionItem": { # Provides a localized error message that is safe to return to the user which can be attached to an RPC error. # Suggested action for solving the warning. + "actionItem": { # Provides a localized error message that is safe to return to the user which can be attached to an RPC error. # Output only. Suggested action for solving the warning. "locale": "A String", # The locale used following the specification defined at https://www.rfc-editor.org/rfc/bcp/bcp47.txt. Examples are: "en-US", "fr-CH", "es-MX" "message": "A String", # The localized error message in the above locale. }, "code": "A String", # The warning code. - "helpLinks": [ # URL(s) pointing to additional information on handling the current warning. + "helpLinks": [ # Output only. URL(s) pointing to additional information on handling the current warning. { # Describes a URL link. "description": "A String", # Describes what the link offers. "url": "A String", # The URL of the link. }, ], - "warningMessage": { # Provides a localized error message that is safe to return to the user which can be attached to an RPC error. # The localized warning message. + "warningMessage": { # Provides a localized error message that is safe to return to the user which can be attached to an RPC error. # Output only. The localized warning message. "locale": "A String", # The locale used following the specification defined at https://www.rfc-editor.org/rfc/bcp/bcp47.txt. Examples are: "en-US", "fr-CH", "es-MX" "message": "A String", # The localized error message in the above locale. }, @@ -748,15 +748,15 @@

Method Details

"stateTime": "A String", # Output only. The last time the migrating VM state was updated. "updateTime": "A String", # Output only. The last time the migrating VM resource was updated. "vmwareSourceVmDetails": { # Represent the source Vmware VM details. # Output only. Details of the VM from a Vmware source. - "committedStorageBytes": "A String", # The total size of the disks being migrated in bytes. - "disks": [ # The disks attached to the source VM. + "committedStorageBytes": "A String", # Output only. The total size of the disks being migrated in bytes. + "disks": [ # Output only. The disks attached to the source VM. { # The details of a Vmware VM disk. - "diskNumber": 42, # The ordinal number of the disk. - "label": "A String", # The disk label. - "sizeGb": "A String", # Size in GB. + "diskNumber": 42, # Output only. The ordinal number of the disk. + "label": "A String", # Output only. The disk label. + "sizeGb": "A String", # Output only. Size in GB. }, ], - "firmware": "A String", # The firmware type of the source VM. + "firmware": "A String", # Output only. The firmware type of the source VM. "vmCapabilitiesInfo": { # Migrating VM source information about the VM capabilities needed for some Compute Engine features. # Output only. Information about VM capabilities needed for some Compute Engine features. "lastOsCapabilitiesUpdateTime": "A String", # Output only. The last time OS capabilities list was updated. "osCapabilities": [ # Output only. Unordered list. List of certain VM OS capabilities needed for some Compute Engine features. @@ -894,15 +894,15 @@

Method Details

{ # MigratingVm describes the VM that will be migrated from a Source environment and its replication state. "awsSourceVmDetails": { # Represent the source AWS VM details. # Output only. Details of the VM from an AWS source. - "committedStorageBytes": "A String", # The total size of the disks being migrated in bytes. - "disks": [ # The disks attached to the source VM. + "committedStorageBytes": "A String", # Output only. The total size of the disks being migrated in bytes. + "disks": [ # Output only. The disks attached to the source VM. { # The details of an AWS instance disk. - "diskNumber": 42, # The ordinal number of the disk. - "sizeGb": "A String", # Size in GB. - "volumeId": "A String", # AWS volume ID. + "diskNumber": 42, # Output only. The ordinal number of the disk. + "sizeGb": "A String", # Output only. Size in GB. + "volumeId": "A String", # Output only. AWS volume ID. }, ], - "firmware": "A String", # The firmware type of the source VM. + "firmware": "A String", # Output only. The firmware type of the source VM. "vmCapabilitiesInfo": { # Migrating VM source information about the VM capabilities needed for some Compute Engine features. # Output only. Information about VM capabilities needed for some Compute Engine features. "lastOsCapabilitiesUpdateTime": "A String", # Output only. The last time OS capabilities list was updated. "osCapabilities": [ # Output only. Unordered list. List of certain VM OS capabilities needed for some Compute Engine features. @@ -911,15 +911,15 @@

Method Details

}, }, "azureSourceVmDetails": { # Represent the source Azure VM details. # Output only. Details of the VM from an Azure source. - "committedStorageBytes": "A String", # The total size of the disks being migrated in bytes. - "disks": [ # The disks attached to the source VM. + "committedStorageBytes": "A String", # Output only. The total size of the disks being migrated in bytes. + "disks": [ # Output only. The disks attached to the source VM. { # The details of an Azure VM disk. - "diskId": "A String", # Azure disk ID. - "diskNumber": 42, # The ordinal number of the disk. - "sizeGb": "A String", # Size in GB. + "diskId": "A String", # Output only. Azure disk ID. + "diskNumber": 42, # Output only. The ordinal number of the disk. + "sizeGb": "A String", # Output only. Size in GB. }, ], - "firmware": "A String", # The firmware type of the source VM. + "firmware": "A String", # Output only. The firmware type of the source VM. "vmCapabilitiesInfo": { # Migrating VM source information about the VM capabilities needed for some Compute Engine features. # Output only. Information about VM capabilities needed for some Compute Engine features. "lastOsCapabilitiesUpdateTime": "A String", # Output only. The last time OS capabilities list was updated. "osCapabilities": [ # Output only. Unordered list. List of certain VM OS capabilities needed for some Compute Engine features. @@ -990,8 +990,8 @@

Method Details

}, "networkInterfaces": [ # Optional. NICs to attach to the VM. { # NetworkInterface represents a NIC of a VM. - "externalIp": "A String", # The external IP to define in the NIC. - "internalIp": "A String", # The internal IP to define in the NIC. The formats accepted are: `ephemeral` \ ipv4 address \ a named address resource full path. + "externalIp": "A String", # Optional. The external IP to define in the NIC. + "internalIp": "A String", # Optional. The internal IP to define in the NIC. The formats accepted are: `ephemeral` \ ipv4 address \ a named address resource full path. "network": "A String", # The network to connect the NIC to. "subnetwork": "A String", # The subnetwork to connect the NIC to. }, @@ -1044,8 +1044,8 @@

Method Details

}, "networkInterfaces": [ # List of NICs connected to this VM. { # NetworkInterface represents a NIC of a VM. - "externalIp": "A String", # The external IP to define in the NIC. - "internalIp": "A String", # The internal IP to define in the NIC. The formats accepted are: `ephemeral` \ ipv4 address \ a named address resource full path. + "externalIp": "A String", # Optional. The external IP to define in the NIC. + "internalIp": "A String", # Optional. The internal IP to define in the NIC. The formats accepted are: `ephemeral` \ ipv4 address \ a named address resource full path. "network": "A String", # The network to connect the NIC to. "subnetwork": "A String", # The subnetwork to connect the NIC to. }, @@ -1063,7 +1063,7 @@

Method Details

"currentSyncInfo": { # ReplicationCycle contains information about the current replication cycle status. # Output only. Details of the current running replication cycle. "cycleNumber": 42, # The cycle's ordinal number. "endTime": "A String", # The time the replication cycle has ended. - "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). # Provides details on the state of the cycle in case of an error. + "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). # Output only. Provides details on the state of the cycle in case of an error. "code": 42, # The status code, which should be an enum value of google.rpc.Code. "details": [ # A list of messages that carry the error details. There is a common set of message types for APIs to use. { @@ -1095,18 +1095,18 @@

Method Details

"totalPauseDuration": "A String", # The accumulated duration the replication cycle was paused. "warnings": [ # Output only. Warnings that occurred during the cycle. { # Represents migration resource warning information that can be used with google.rpc.Status message. MigrationWarning is used to present the user with warning information in migration operations. - "actionItem": { # Provides a localized error message that is safe to return to the user which can be attached to an RPC error. # Suggested action for solving the warning. + "actionItem": { # Provides a localized error message that is safe to return to the user which can be attached to an RPC error. # Output only. Suggested action for solving the warning. "locale": "A String", # The locale used following the specification defined at https://www.rfc-editor.org/rfc/bcp/bcp47.txt. Examples are: "en-US", "fr-CH", "es-MX" "message": "A String", # The localized error message in the above locale. }, "code": "A String", # The warning code. - "helpLinks": [ # URL(s) pointing to additional information on handling the current warning. + "helpLinks": [ # Output only. URL(s) pointing to additional information on handling the current warning. { # Describes a URL link. "description": "A String", # Describes what the link offers. "url": "A String", # The URL of the link. }, ], - "warningMessage": { # Provides a localized error message that is safe to return to the user which can be attached to an RPC error. # The localized warning message. + "warningMessage": { # Provides a localized error message that is safe to return to the user which can be attached to an RPC error. # Output only. The localized warning message. "locale": "A String", # The locale used following the specification defined at https://www.rfc-editor.org/rfc/bcp/bcp47.txt. Examples are: "en-US", "fr-CH", "es-MX" "message": "A String", # The localized error message in the above locale. }, @@ -1135,7 +1135,7 @@

Method Details

"lastReplicationCycle": { # ReplicationCycle contains information about the current replication cycle status. # Output only. Details of the last replication cycle. This will be updated whenever a replication cycle is finished and is not to be confused with last_sync which is only updated on successful replication cycles. "cycleNumber": 42, # The cycle's ordinal number. "endTime": "A String", # The time the replication cycle has ended. - "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). # Provides details on the state of the cycle in case of an error. + "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). # Output only. Provides details on the state of the cycle in case of an error. "code": 42, # The status code, which should be an enum value of google.rpc.Code. "details": [ # A list of messages that carry the error details. There is a common set of message types for APIs to use. { @@ -1167,18 +1167,18 @@

Method Details

"totalPauseDuration": "A String", # The accumulated duration the replication cycle was paused. "warnings": [ # Output only. Warnings that occurred during the cycle. { # Represents migration resource warning information that can be used with google.rpc.Status message. MigrationWarning is used to present the user with warning information in migration operations. - "actionItem": { # Provides a localized error message that is safe to return to the user which can be attached to an RPC error. # Suggested action for solving the warning. + "actionItem": { # Provides a localized error message that is safe to return to the user which can be attached to an RPC error. # Output only. Suggested action for solving the warning. "locale": "A String", # The locale used following the specification defined at https://www.rfc-editor.org/rfc/bcp/bcp47.txt. Examples are: "en-US", "fr-CH", "es-MX" "message": "A String", # The localized error message in the above locale. }, "code": "A String", # The warning code. - "helpLinks": [ # URL(s) pointing to additional information on handling the current warning. + "helpLinks": [ # Output only. URL(s) pointing to additional information on handling the current warning. { # Describes a URL link. "description": "A String", # Describes what the link offers. "url": "A String", # The URL of the link. }, ], - "warningMessage": { # Provides a localized error message that is safe to return to the user which can be attached to an RPC error. # The localized warning message. + "warningMessage": { # Provides a localized error message that is safe to return to the user which can be attached to an RPC error. # Output only. The localized warning message. "locale": "A String", # The locale used following the specification defined at https://www.rfc-editor.org/rfc/bcp/bcp47.txt. Examples are: "en-US", "fr-CH", "es-MX" "message": "A String", # The localized error message in the above locale. }, @@ -1248,8 +1248,8 @@

Method Details

}, "networkInterfaces": [ # List of NICs connected to this VM. { # NetworkInterface represents a NIC of a VM. - "externalIp": "A String", # The external IP to define in the NIC. - "internalIp": "A String", # The internal IP to define in the NIC. The formats accepted are: `ephemeral` \ ipv4 address \ a named address resource full path. + "externalIp": "A String", # Optional. The external IP to define in the NIC. + "internalIp": "A String", # Optional. The internal IP to define in the NIC. The formats accepted are: `ephemeral` \ ipv4 address \ a named address resource full path. "network": "A String", # The network to connect the NIC to. "subnetwork": "A String", # The subnetwork to connect the NIC to. }, @@ -1345,8 +1345,8 @@

Method Details

}, "networkInterfaces": [ # List of NICs connected to this VM. { # NetworkInterface represents a NIC of a VM. - "externalIp": "A String", # The external IP to define in the NIC. - "internalIp": "A String", # The internal IP to define in the NIC. The formats accepted are: `ephemeral` \ ipv4 address \ a named address resource full path. + "externalIp": "A String", # Optional. The external IP to define in the NIC. + "internalIp": "A String", # Optional. The internal IP to define in the NIC. The formats accepted are: `ephemeral` \ ipv4 address \ a named address resource full path. "network": "A String", # The network to connect the NIC to. "subnetwork": "A String", # The subnetwork to connect the NIC to. }, @@ -1382,7 +1382,7 @@

Method Details

"finalSync": { # ReplicationCycle contains information about the current replication cycle status. # Final sync step. "cycleNumber": 42, # The cycle's ordinal number. "endTime": "A String", # The time the replication cycle has ended. - "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). # Provides details on the state of the cycle in case of an error. + "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). # Output only. Provides details on the state of the cycle in case of an error. "code": 42, # The status code, which should be an enum value of google.rpc.Code. "details": [ # A list of messages that carry the error details. There is a common set of message types for APIs to use. { @@ -1414,18 +1414,18 @@

Method Details

"totalPauseDuration": "A String", # The accumulated duration the replication cycle was paused. "warnings": [ # Output only. Warnings that occurred during the cycle. { # Represents migration resource warning information that can be used with google.rpc.Status message. MigrationWarning is used to present the user with warning information in migration operations. - "actionItem": { # Provides a localized error message that is safe to return to the user which can be attached to an RPC error. # Suggested action for solving the warning. + "actionItem": { # Provides a localized error message that is safe to return to the user which can be attached to an RPC error. # Output only. Suggested action for solving the warning. "locale": "A String", # The locale used following the specification defined at https://www.rfc-editor.org/rfc/bcp/bcp47.txt. Examples are: "en-US", "fr-CH", "es-MX" "message": "A String", # The localized error message in the above locale. }, "code": "A String", # The warning code. - "helpLinks": [ # URL(s) pointing to additional information on handling the current warning. + "helpLinks": [ # Output only. URL(s) pointing to additional information on handling the current warning. { # Describes a URL link. "description": "A String", # Describes what the link offers. "url": "A String", # The URL of the link. }, ], - "warningMessage": { # Provides a localized error message that is safe to return to the user which can be attached to an RPC error. # The localized warning message. + "warningMessage": { # Provides a localized error message that is safe to return to the user which can be attached to an RPC error. # Output only. The localized warning message. "locale": "A String", # The locale used following the specification defined at https://www.rfc-editor.org/rfc/bcp/bcp47.txt. Examples are: "en-US", "fr-CH", "es-MX" "message": "A String", # The localized error message in the above locale. }, @@ -1440,7 +1440,7 @@

Method Details

"previousReplicationCycle": { # ReplicationCycle contains information about the current replication cycle status. # A replication cycle prior cutover step. "cycleNumber": 42, # The cycle's ordinal number. "endTime": "A String", # The time the replication cycle has ended. - "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). # Provides details on the state of the cycle in case of an error. + "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). # Output only. Provides details on the state of the cycle in case of an error. "code": 42, # The status code, which should be an enum value of google.rpc.Code. "details": [ # A list of messages that carry the error details. There is a common set of message types for APIs to use. { @@ -1472,18 +1472,18 @@

Method Details

"totalPauseDuration": "A String", # The accumulated duration the replication cycle was paused. "warnings": [ # Output only. Warnings that occurred during the cycle. { # Represents migration resource warning information that can be used with google.rpc.Status message. MigrationWarning is used to present the user with warning information in migration operations. - "actionItem": { # Provides a localized error message that is safe to return to the user which can be attached to an RPC error. # Suggested action for solving the warning. + "actionItem": { # Provides a localized error message that is safe to return to the user which can be attached to an RPC error. # Output only. Suggested action for solving the warning. "locale": "A String", # The locale used following the specification defined at https://www.rfc-editor.org/rfc/bcp/bcp47.txt. Examples are: "en-US", "fr-CH", "es-MX" "message": "A String", # The localized error message in the above locale. }, "code": "A String", # The warning code. - "helpLinks": [ # URL(s) pointing to additional information on handling the current warning. + "helpLinks": [ # Output only. URL(s) pointing to additional information on handling the current warning. { # Describes a URL link. "description": "A String", # Describes what the link offers. "url": "A String", # The URL of the link. }, ], - "warningMessage": { # Provides a localized error message that is safe to return to the user which can be attached to an RPC error. # The localized warning message. + "warningMessage": { # Provides a localized error message that is safe to return to the user which can be attached to an RPC error. # Output only. The localized warning message. "locale": "A String", # The locale used following the specification defined at https://www.rfc-editor.org/rfc/bcp/bcp47.txt. Examples are: "en-US", "fr-CH", "es-MX" "message": "A String", # The localized error message in the above locale. }, @@ -1503,15 +1503,15 @@

Method Details

"stateTime": "A String", # Output only. The last time the migrating VM state was updated. "updateTime": "A String", # Output only. The last time the migrating VM resource was updated. "vmwareSourceVmDetails": { # Represent the source Vmware VM details. # Output only. Details of the VM from a Vmware source. - "committedStorageBytes": "A String", # The total size of the disks being migrated in bytes. - "disks": [ # The disks attached to the source VM. + "committedStorageBytes": "A String", # Output only. The total size of the disks being migrated in bytes. + "disks": [ # Output only. The disks attached to the source VM. { # The details of a Vmware VM disk. - "diskNumber": 42, # The ordinal number of the disk. - "label": "A String", # The disk label. - "sizeGb": "A String", # Size in GB. + "diskNumber": 42, # Output only. The ordinal number of the disk. + "label": "A String", # Output only. The disk label. + "sizeGb": "A String", # Output only. Size in GB. }, ], - "firmware": "A String", # The firmware type of the source VM. + "firmware": "A String", # Output only. The firmware type of the source VM. "vmCapabilitiesInfo": { # Migrating VM source information about the VM capabilities needed for some Compute Engine features. # Output only. Information about VM capabilities needed for some Compute Engine features. "lastOsCapabilitiesUpdateTime": "A String", # Output only. The last time OS capabilities list was updated. "osCapabilities": [ # Output only. Unordered list. List of certain VM OS capabilities needed for some Compute Engine features. @@ -1549,15 +1549,15 @@

Method Details

"migratingVms": [ # Output only. The list of Migrating VMs response. { # MigratingVm describes the VM that will be migrated from a Source environment and its replication state. "awsSourceVmDetails": { # Represent the source AWS VM details. # Output only. Details of the VM from an AWS source. - "committedStorageBytes": "A String", # The total size of the disks being migrated in bytes. - "disks": [ # The disks attached to the source VM. + "committedStorageBytes": "A String", # Output only. The total size of the disks being migrated in bytes. + "disks": [ # Output only. The disks attached to the source VM. { # The details of an AWS instance disk. - "diskNumber": 42, # The ordinal number of the disk. - "sizeGb": "A String", # Size in GB. - "volumeId": "A String", # AWS volume ID. + "diskNumber": 42, # Output only. The ordinal number of the disk. + "sizeGb": "A String", # Output only. Size in GB. + "volumeId": "A String", # Output only. AWS volume ID. }, ], - "firmware": "A String", # The firmware type of the source VM. + "firmware": "A String", # Output only. The firmware type of the source VM. "vmCapabilitiesInfo": { # Migrating VM source information about the VM capabilities needed for some Compute Engine features. # Output only. Information about VM capabilities needed for some Compute Engine features. "lastOsCapabilitiesUpdateTime": "A String", # Output only. The last time OS capabilities list was updated. "osCapabilities": [ # Output only. Unordered list. List of certain VM OS capabilities needed for some Compute Engine features. @@ -1566,15 +1566,15 @@

Method Details

}, }, "azureSourceVmDetails": { # Represent the source Azure VM details. # Output only. Details of the VM from an Azure source. - "committedStorageBytes": "A String", # The total size of the disks being migrated in bytes. - "disks": [ # The disks attached to the source VM. + "committedStorageBytes": "A String", # Output only. The total size of the disks being migrated in bytes. + "disks": [ # Output only. The disks attached to the source VM. { # The details of an Azure VM disk. - "diskId": "A String", # Azure disk ID. - "diskNumber": 42, # The ordinal number of the disk. - "sizeGb": "A String", # Size in GB. + "diskId": "A String", # Output only. Azure disk ID. + "diskNumber": 42, # Output only. The ordinal number of the disk. + "sizeGb": "A String", # Output only. Size in GB. }, ], - "firmware": "A String", # The firmware type of the source VM. + "firmware": "A String", # Output only. The firmware type of the source VM. "vmCapabilitiesInfo": { # Migrating VM source information about the VM capabilities needed for some Compute Engine features. # Output only. Information about VM capabilities needed for some Compute Engine features. "lastOsCapabilitiesUpdateTime": "A String", # Output only. The last time OS capabilities list was updated. "osCapabilities": [ # Output only. Unordered list. List of certain VM OS capabilities needed for some Compute Engine features. @@ -1645,8 +1645,8 @@

Method Details

}, "networkInterfaces": [ # Optional. NICs to attach to the VM. { # NetworkInterface represents a NIC of a VM. - "externalIp": "A String", # The external IP to define in the NIC. - "internalIp": "A String", # The internal IP to define in the NIC. The formats accepted are: `ephemeral` \ ipv4 address \ a named address resource full path. + "externalIp": "A String", # Optional. The external IP to define in the NIC. + "internalIp": "A String", # Optional. The internal IP to define in the NIC. The formats accepted are: `ephemeral` \ ipv4 address \ a named address resource full path. "network": "A String", # The network to connect the NIC to. "subnetwork": "A String", # The subnetwork to connect the NIC to. }, @@ -1699,8 +1699,8 @@

Method Details

}, "networkInterfaces": [ # List of NICs connected to this VM. { # NetworkInterface represents a NIC of a VM. - "externalIp": "A String", # The external IP to define in the NIC. - "internalIp": "A String", # The internal IP to define in the NIC. The formats accepted are: `ephemeral` \ ipv4 address \ a named address resource full path. + "externalIp": "A String", # Optional. The external IP to define in the NIC. + "internalIp": "A String", # Optional. The internal IP to define in the NIC. The formats accepted are: `ephemeral` \ ipv4 address \ a named address resource full path. "network": "A String", # The network to connect the NIC to. "subnetwork": "A String", # The subnetwork to connect the NIC to. }, @@ -1718,7 +1718,7 @@

Method Details

"currentSyncInfo": { # ReplicationCycle contains information about the current replication cycle status. # Output only. Details of the current running replication cycle. "cycleNumber": 42, # The cycle's ordinal number. "endTime": "A String", # The time the replication cycle has ended. - "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). # Provides details on the state of the cycle in case of an error. + "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). # Output only. Provides details on the state of the cycle in case of an error. "code": 42, # The status code, which should be an enum value of google.rpc.Code. "details": [ # A list of messages that carry the error details. There is a common set of message types for APIs to use. { @@ -1750,18 +1750,18 @@

Method Details

"totalPauseDuration": "A String", # The accumulated duration the replication cycle was paused. "warnings": [ # Output only. Warnings that occurred during the cycle. { # Represents migration resource warning information that can be used with google.rpc.Status message. MigrationWarning is used to present the user with warning information in migration operations. - "actionItem": { # Provides a localized error message that is safe to return to the user which can be attached to an RPC error. # Suggested action for solving the warning. + "actionItem": { # Provides a localized error message that is safe to return to the user which can be attached to an RPC error. # Output only. Suggested action for solving the warning. "locale": "A String", # The locale used following the specification defined at https://www.rfc-editor.org/rfc/bcp/bcp47.txt. Examples are: "en-US", "fr-CH", "es-MX" "message": "A String", # The localized error message in the above locale. }, "code": "A String", # The warning code. - "helpLinks": [ # URL(s) pointing to additional information on handling the current warning. + "helpLinks": [ # Output only. URL(s) pointing to additional information on handling the current warning. { # Describes a URL link. "description": "A String", # Describes what the link offers. "url": "A String", # The URL of the link. }, ], - "warningMessage": { # Provides a localized error message that is safe to return to the user which can be attached to an RPC error. # The localized warning message. + "warningMessage": { # Provides a localized error message that is safe to return to the user which can be attached to an RPC error. # Output only. The localized warning message. "locale": "A String", # The locale used following the specification defined at https://www.rfc-editor.org/rfc/bcp/bcp47.txt. Examples are: "en-US", "fr-CH", "es-MX" "message": "A String", # The localized error message in the above locale. }, @@ -1790,7 +1790,7 @@

Method Details

"lastReplicationCycle": { # ReplicationCycle contains information about the current replication cycle status. # Output only. Details of the last replication cycle. This will be updated whenever a replication cycle is finished and is not to be confused with last_sync which is only updated on successful replication cycles. "cycleNumber": 42, # The cycle's ordinal number. "endTime": "A String", # The time the replication cycle has ended. - "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). # Provides details on the state of the cycle in case of an error. + "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). # Output only. Provides details on the state of the cycle in case of an error. "code": 42, # The status code, which should be an enum value of google.rpc.Code. "details": [ # A list of messages that carry the error details. There is a common set of message types for APIs to use. { @@ -1822,18 +1822,18 @@

Method Details

"totalPauseDuration": "A String", # The accumulated duration the replication cycle was paused. "warnings": [ # Output only. Warnings that occurred during the cycle. { # Represents migration resource warning information that can be used with google.rpc.Status message. MigrationWarning is used to present the user with warning information in migration operations. - "actionItem": { # Provides a localized error message that is safe to return to the user which can be attached to an RPC error. # Suggested action for solving the warning. + "actionItem": { # Provides a localized error message that is safe to return to the user which can be attached to an RPC error. # Output only. Suggested action for solving the warning. "locale": "A String", # The locale used following the specification defined at https://www.rfc-editor.org/rfc/bcp/bcp47.txt. Examples are: "en-US", "fr-CH", "es-MX" "message": "A String", # The localized error message in the above locale. }, "code": "A String", # The warning code. - "helpLinks": [ # URL(s) pointing to additional information on handling the current warning. + "helpLinks": [ # Output only. URL(s) pointing to additional information on handling the current warning. { # Describes a URL link. "description": "A String", # Describes what the link offers. "url": "A String", # The URL of the link. }, ], - "warningMessage": { # Provides a localized error message that is safe to return to the user which can be attached to an RPC error. # The localized warning message. + "warningMessage": { # Provides a localized error message that is safe to return to the user which can be attached to an RPC error. # Output only. The localized warning message. "locale": "A String", # The locale used following the specification defined at https://www.rfc-editor.org/rfc/bcp/bcp47.txt. Examples are: "en-US", "fr-CH", "es-MX" "message": "A String", # The localized error message in the above locale. }, @@ -1903,8 +1903,8 @@

Method Details

}, "networkInterfaces": [ # List of NICs connected to this VM. { # NetworkInterface represents a NIC of a VM. - "externalIp": "A String", # The external IP to define in the NIC. - "internalIp": "A String", # The internal IP to define in the NIC. The formats accepted are: `ephemeral` \ ipv4 address \ a named address resource full path. + "externalIp": "A String", # Optional. The external IP to define in the NIC. + "internalIp": "A String", # Optional. The internal IP to define in the NIC. The formats accepted are: `ephemeral` \ ipv4 address \ a named address resource full path. "network": "A String", # The network to connect the NIC to. "subnetwork": "A String", # The subnetwork to connect the NIC to. }, @@ -2000,8 +2000,8 @@

Method Details

}, "networkInterfaces": [ # List of NICs connected to this VM. { # NetworkInterface represents a NIC of a VM. - "externalIp": "A String", # The external IP to define in the NIC. - "internalIp": "A String", # The internal IP to define in the NIC. The formats accepted are: `ephemeral` \ ipv4 address \ a named address resource full path. + "externalIp": "A String", # Optional. The external IP to define in the NIC. + "internalIp": "A String", # Optional. The internal IP to define in the NIC. The formats accepted are: `ephemeral` \ ipv4 address \ a named address resource full path. "network": "A String", # The network to connect the NIC to. "subnetwork": "A String", # The subnetwork to connect the NIC to. }, @@ -2037,7 +2037,7 @@

Method Details

"finalSync": { # ReplicationCycle contains information about the current replication cycle status. # Final sync step. "cycleNumber": 42, # The cycle's ordinal number. "endTime": "A String", # The time the replication cycle has ended. - "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). # Provides details on the state of the cycle in case of an error. + "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). # Output only. Provides details on the state of the cycle in case of an error. "code": 42, # The status code, which should be an enum value of google.rpc.Code. "details": [ # A list of messages that carry the error details. There is a common set of message types for APIs to use. { @@ -2069,18 +2069,18 @@

Method Details

"totalPauseDuration": "A String", # The accumulated duration the replication cycle was paused. "warnings": [ # Output only. Warnings that occurred during the cycle. { # Represents migration resource warning information that can be used with google.rpc.Status message. MigrationWarning is used to present the user with warning information in migration operations. - "actionItem": { # Provides a localized error message that is safe to return to the user which can be attached to an RPC error. # Suggested action for solving the warning. + "actionItem": { # Provides a localized error message that is safe to return to the user which can be attached to an RPC error. # Output only. Suggested action for solving the warning. "locale": "A String", # The locale used following the specification defined at https://www.rfc-editor.org/rfc/bcp/bcp47.txt. Examples are: "en-US", "fr-CH", "es-MX" "message": "A String", # The localized error message in the above locale. }, "code": "A String", # The warning code. - "helpLinks": [ # URL(s) pointing to additional information on handling the current warning. + "helpLinks": [ # Output only. URL(s) pointing to additional information on handling the current warning. { # Describes a URL link. "description": "A String", # Describes what the link offers. "url": "A String", # The URL of the link. }, ], - "warningMessage": { # Provides a localized error message that is safe to return to the user which can be attached to an RPC error. # The localized warning message. + "warningMessage": { # Provides a localized error message that is safe to return to the user which can be attached to an RPC error. # Output only. The localized warning message. "locale": "A String", # The locale used following the specification defined at https://www.rfc-editor.org/rfc/bcp/bcp47.txt. Examples are: "en-US", "fr-CH", "es-MX" "message": "A String", # The localized error message in the above locale. }, @@ -2095,7 +2095,7 @@

Method Details

"previousReplicationCycle": { # ReplicationCycle contains information about the current replication cycle status. # A replication cycle prior cutover step. "cycleNumber": 42, # The cycle's ordinal number. "endTime": "A String", # The time the replication cycle has ended. - "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). # Provides details on the state of the cycle in case of an error. + "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). # Output only. Provides details on the state of the cycle in case of an error. "code": 42, # The status code, which should be an enum value of google.rpc.Code. "details": [ # A list of messages that carry the error details. There is a common set of message types for APIs to use. { @@ -2127,18 +2127,18 @@

Method Details

"totalPauseDuration": "A String", # The accumulated duration the replication cycle was paused. "warnings": [ # Output only. Warnings that occurred during the cycle. { # Represents migration resource warning information that can be used with google.rpc.Status message. MigrationWarning is used to present the user with warning information in migration operations. - "actionItem": { # Provides a localized error message that is safe to return to the user which can be attached to an RPC error. # Suggested action for solving the warning. + "actionItem": { # Provides a localized error message that is safe to return to the user which can be attached to an RPC error. # Output only. Suggested action for solving the warning. "locale": "A String", # The locale used following the specification defined at https://www.rfc-editor.org/rfc/bcp/bcp47.txt. Examples are: "en-US", "fr-CH", "es-MX" "message": "A String", # The localized error message in the above locale. }, "code": "A String", # The warning code. - "helpLinks": [ # URL(s) pointing to additional information on handling the current warning. + "helpLinks": [ # Output only. URL(s) pointing to additional information on handling the current warning. { # Describes a URL link. "description": "A String", # Describes what the link offers. "url": "A String", # The URL of the link. }, ], - "warningMessage": { # Provides a localized error message that is safe to return to the user which can be attached to an RPC error. # The localized warning message. + "warningMessage": { # Provides a localized error message that is safe to return to the user which can be attached to an RPC error. # Output only. The localized warning message. "locale": "A String", # The locale used following the specification defined at https://www.rfc-editor.org/rfc/bcp/bcp47.txt. Examples are: "en-US", "fr-CH", "es-MX" "message": "A String", # The localized error message in the above locale. }, @@ -2158,15 +2158,15 @@

Method Details

"stateTime": "A String", # Output only. The last time the migrating VM state was updated. "updateTime": "A String", # Output only. The last time the migrating VM resource was updated. "vmwareSourceVmDetails": { # Represent the source Vmware VM details. # Output only. Details of the VM from a Vmware source. - "committedStorageBytes": "A String", # The total size of the disks being migrated in bytes. - "disks": [ # The disks attached to the source VM. + "committedStorageBytes": "A String", # Output only. The total size of the disks being migrated in bytes. + "disks": [ # Output only. The disks attached to the source VM. { # The details of a Vmware VM disk. - "diskNumber": 42, # The ordinal number of the disk. - "label": "A String", # The disk label. - "sizeGb": "A String", # Size in GB. + "diskNumber": 42, # Output only. The ordinal number of the disk. + "label": "A String", # Output only. The disk label. + "sizeGb": "A String", # Output only. Size in GB. }, ], - "firmware": "A String", # The firmware type of the source VM. + "firmware": "A String", # Output only. The firmware type of the source VM. "vmCapabilitiesInfo": { # Migrating VM source information about the VM capabilities needed for some Compute Engine features. # Output only. Information about VM capabilities needed for some Compute Engine features. "lastOsCapabilitiesUpdateTime": "A String", # Output only. The last time OS capabilities list was updated. "osCapabilities": [ # Output only. Unordered list. List of certain VM OS capabilities needed for some Compute Engine features. @@ -2208,15 +2208,15 @@

Method Details

{ # MigratingVm describes the VM that will be migrated from a Source environment and its replication state. "awsSourceVmDetails": { # Represent the source AWS VM details. # Output only. Details of the VM from an AWS source. - "committedStorageBytes": "A String", # The total size of the disks being migrated in bytes. - "disks": [ # The disks attached to the source VM. + "committedStorageBytes": "A String", # Output only. The total size of the disks being migrated in bytes. + "disks": [ # Output only. The disks attached to the source VM. { # The details of an AWS instance disk. - "diskNumber": 42, # The ordinal number of the disk. - "sizeGb": "A String", # Size in GB. - "volumeId": "A String", # AWS volume ID. + "diskNumber": 42, # Output only. The ordinal number of the disk. + "sizeGb": "A String", # Output only. Size in GB. + "volumeId": "A String", # Output only. AWS volume ID. }, ], - "firmware": "A String", # The firmware type of the source VM. + "firmware": "A String", # Output only. The firmware type of the source VM. "vmCapabilitiesInfo": { # Migrating VM source information about the VM capabilities needed for some Compute Engine features. # Output only. Information about VM capabilities needed for some Compute Engine features. "lastOsCapabilitiesUpdateTime": "A String", # Output only. The last time OS capabilities list was updated. "osCapabilities": [ # Output only. Unordered list. List of certain VM OS capabilities needed for some Compute Engine features. @@ -2225,15 +2225,15 @@

Method Details

}, }, "azureSourceVmDetails": { # Represent the source Azure VM details. # Output only. Details of the VM from an Azure source. - "committedStorageBytes": "A String", # The total size of the disks being migrated in bytes. - "disks": [ # The disks attached to the source VM. + "committedStorageBytes": "A String", # Output only. The total size of the disks being migrated in bytes. + "disks": [ # Output only. The disks attached to the source VM. { # The details of an Azure VM disk. - "diskId": "A String", # Azure disk ID. - "diskNumber": 42, # The ordinal number of the disk. - "sizeGb": "A String", # Size in GB. + "diskId": "A String", # Output only. Azure disk ID. + "diskNumber": 42, # Output only. The ordinal number of the disk. + "sizeGb": "A String", # Output only. Size in GB. }, ], - "firmware": "A String", # The firmware type of the source VM. + "firmware": "A String", # Output only. The firmware type of the source VM. "vmCapabilitiesInfo": { # Migrating VM source information about the VM capabilities needed for some Compute Engine features. # Output only. Information about VM capabilities needed for some Compute Engine features. "lastOsCapabilitiesUpdateTime": "A String", # Output only. The last time OS capabilities list was updated. "osCapabilities": [ # Output only. Unordered list. List of certain VM OS capabilities needed for some Compute Engine features. @@ -2304,8 +2304,8 @@

Method Details

}, "networkInterfaces": [ # Optional. NICs to attach to the VM. { # NetworkInterface represents a NIC of a VM. - "externalIp": "A String", # The external IP to define in the NIC. - "internalIp": "A String", # The internal IP to define in the NIC. The formats accepted are: `ephemeral` \ ipv4 address \ a named address resource full path. + "externalIp": "A String", # Optional. The external IP to define in the NIC. + "internalIp": "A String", # Optional. The internal IP to define in the NIC. The formats accepted are: `ephemeral` \ ipv4 address \ a named address resource full path. "network": "A String", # The network to connect the NIC to. "subnetwork": "A String", # The subnetwork to connect the NIC to. }, @@ -2358,8 +2358,8 @@

Method Details

}, "networkInterfaces": [ # List of NICs connected to this VM. { # NetworkInterface represents a NIC of a VM. - "externalIp": "A String", # The external IP to define in the NIC. - "internalIp": "A String", # The internal IP to define in the NIC. The formats accepted are: `ephemeral` \ ipv4 address \ a named address resource full path. + "externalIp": "A String", # Optional. The external IP to define in the NIC. + "internalIp": "A String", # Optional. The internal IP to define in the NIC. The formats accepted are: `ephemeral` \ ipv4 address \ a named address resource full path. "network": "A String", # The network to connect the NIC to. "subnetwork": "A String", # The subnetwork to connect the NIC to. }, @@ -2377,7 +2377,7 @@

Method Details

"currentSyncInfo": { # ReplicationCycle contains information about the current replication cycle status. # Output only. Details of the current running replication cycle. "cycleNumber": 42, # The cycle's ordinal number. "endTime": "A String", # The time the replication cycle has ended. - "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). # Provides details on the state of the cycle in case of an error. + "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). # Output only. Provides details on the state of the cycle in case of an error. "code": 42, # The status code, which should be an enum value of google.rpc.Code. "details": [ # A list of messages that carry the error details. There is a common set of message types for APIs to use. { @@ -2409,18 +2409,18 @@

Method Details

"totalPauseDuration": "A String", # The accumulated duration the replication cycle was paused. "warnings": [ # Output only. Warnings that occurred during the cycle. { # Represents migration resource warning information that can be used with google.rpc.Status message. MigrationWarning is used to present the user with warning information in migration operations. - "actionItem": { # Provides a localized error message that is safe to return to the user which can be attached to an RPC error. # Suggested action for solving the warning. + "actionItem": { # Provides a localized error message that is safe to return to the user which can be attached to an RPC error. # Output only. Suggested action for solving the warning. "locale": "A String", # The locale used following the specification defined at https://www.rfc-editor.org/rfc/bcp/bcp47.txt. Examples are: "en-US", "fr-CH", "es-MX" "message": "A String", # The localized error message in the above locale. }, "code": "A String", # The warning code. - "helpLinks": [ # URL(s) pointing to additional information on handling the current warning. + "helpLinks": [ # Output only. URL(s) pointing to additional information on handling the current warning. { # Describes a URL link. "description": "A String", # Describes what the link offers. "url": "A String", # The URL of the link. }, ], - "warningMessage": { # Provides a localized error message that is safe to return to the user which can be attached to an RPC error. # The localized warning message. + "warningMessage": { # Provides a localized error message that is safe to return to the user which can be attached to an RPC error. # Output only. The localized warning message. "locale": "A String", # The locale used following the specification defined at https://www.rfc-editor.org/rfc/bcp/bcp47.txt. Examples are: "en-US", "fr-CH", "es-MX" "message": "A String", # The localized error message in the above locale. }, @@ -2449,7 +2449,7 @@

Method Details

"lastReplicationCycle": { # ReplicationCycle contains information about the current replication cycle status. # Output only. Details of the last replication cycle. This will be updated whenever a replication cycle is finished and is not to be confused with last_sync which is only updated on successful replication cycles. "cycleNumber": 42, # The cycle's ordinal number. "endTime": "A String", # The time the replication cycle has ended. - "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). # Provides details on the state of the cycle in case of an error. + "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). # Output only. Provides details on the state of the cycle in case of an error. "code": 42, # The status code, which should be an enum value of google.rpc.Code. "details": [ # A list of messages that carry the error details. There is a common set of message types for APIs to use. { @@ -2481,18 +2481,18 @@

Method Details

"totalPauseDuration": "A String", # The accumulated duration the replication cycle was paused. "warnings": [ # Output only. Warnings that occurred during the cycle. { # Represents migration resource warning information that can be used with google.rpc.Status message. MigrationWarning is used to present the user with warning information in migration operations. - "actionItem": { # Provides a localized error message that is safe to return to the user which can be attached to an RPC error. # Suggested action for solving the warning. + "actionItem": { # Provides a localized error message that is safe to return to the user which can be attached to an RPC error. # Output only. Suggested action for solving the warning. "locale": "A String", # The locale used following the specification defined at https://www.rfc-editor.org/rfc/bcp/bcp47.txt. Examples are: "en-US", "fr-CH", "es-MX" "message": "A String", # The localized error message in the above locale. }, "code": "A String", # The warning code. - "helpLinks": [ # URL(s) pointing to additional information on handling the current warning. + "helpLinks": [ # Output only. URL(s) pointing to additional information on handling the current warning. { # Describes a URL link. "description": "A String", # Describes what the link offers. "url": "A String", # The URL of the link. }, ], - "warningMessage": { # Provides a localized error message that is safe to return to the user which can be attached to an RPC error. # The localized warning message. + "warningMessage": { # Provides a localized error message that is safe to return to the user which can be attached to an RPC error. # Output only. The localized warning message. "locale": "A String", # The locale used following the specification defined at https://www.rfc-editor.org/rfc/bcp/bcp47.txt. Examples are: "en-US", "fr-CH", "es-MX" "message": "A String", # The localized error message in the above locale. }, @@ -2562,8 +2562,8 @@

Method Details

}, "networkInterfaces": [ # List of NICs connected to this VM. { # NetworkInterface represents a NIC of a VM. - "externalIp": "A String", # The external IP to define in the NIC. - "internalIp": "A String", # The internal IP to define in the NIC. The formats accepted are: `ephemeral` \ ipv4 address \ a named address resource full path. + "externalIp": "A String", # Optional. The external IP to define in the NIC. + "internalIp": "A String", # Optional. The internal IP to define in the NIC. The formats accepted are: `ephemeral` \ ipv4 address \ a named address resource full path. "network": "A String", # The network to connect the NIC to. "subnetwork": "A String", # The subnetwork to connect the NIC to. }, @@ -2659,8 +2659,8 @@

Method Details

}, "networkInterfaces": [ # List of NICs connected to this VM. { # NetworkInterface represents a NIC of a VM. - "externalIp": "A String", # The external IP to define in the NIC. - "internalIp": "A String", # The internal IP to define in the NIC. The formats accepted are: `ephemeral` \ ipv4 address \ a named address resource full path. + "externalIp": "A String", # Optional. The external IP to define in the NIC. + "internalIp": "A String", # Optional. The internal IP to define in the NIC. The formats accepted are: `ephemeral` \ ipv4 address \ a named address resource full path. "network": "A String", # The network to connect the NIC to. "subnetwork": "A String", # The subnetwork to connect the NIC to. }, @@ -2696,7 +2696,7 @@

Method Details

"finalSync": { # ReplicationCycle contains information about the current replication cycle status. # Final sync step. "cycleNumber": 42, # The cycle's ordinal number. "endTime": "A String", # The time the replication cycle has ended. - "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). # Provides details on the state of the cycle in case of an error. + "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). # Output only. Provides details on the state of the cycle in case of an error. "code": 42, # The status code, which should be an enum value of google.rpc.Code. "details": [ # A list of messages that carry the error details. There is a common set of message types for APIs to use. { @@ -2728,18 +2728,18 @@

Method Details

"totalPauseDuration": "A String", # The accumulated duration the replication cycle was paused. "warnings": [ # Output only. Warnings that occurred during the cycle. { # Represents migration resource warning information that can be used with google.rpc.Status message. MigrationWarning is used to present the user with warning information in migration operations. - "actionItem": { # Provides a localized error message that is safe to return to the user which can be attached to an RPC error. # Suggested action for solving the warning. + "actionItem": { # Provides a localized error message that is safe to return to the user which can be attached to an RPC error. # Output only. Suggested action for solving the warning. "locale": "A String", # The locale used following the specification defined at https://www.rfc-editor.org/rfc/bcp/bcp47.txt. Examples are: "en-US", "fr-CH", "es-MX" "message": "A String", # The localized error message in the above locale. }, "code": "A String", # The warning code. - "helpLinks": [ # URL(s) pointing to additional information on handling the current warning. + "helpLinks": [ # Output only. URL(s) pointing to additional information on handling the current warning. { # Describes a URL link. "description": "A String", # Describes what the link offers. "url": "A String", # The URL of the link. }, ], - "warningMessage": { # Provides a localized error message that is safe to return to the user which can be attached to an RPC error. # The localized warning message. + "warningMessage": { # Provides a localized error message that is safe to return to the user which can be attached to an RPC error. # Output only. The localized warning message. "locale": "A String", # The locale used following the specification defined at https://www.rfc-editor.org/rfc/bcp/bcp47.txt. Examples are: "en-US", "fr-CH", "es-MX" "message": "A String", # The localized error message in the above locale. }, @@ -2754,7 +2754,7 @@

Method Details

"previousReplicationCycle": { # ReplicationCycle contains information about the current replication cycle status. # A replication cycle prior cutover step. "cycleNumber": 42, # The cycle's ordinal number. "endTime": "A String", # The time the replication cycle has ended. - "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). # Provides details on the state of the cycle in case of an error. + "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). # Output only. Provides details on the state of the cycle in case of an error. "code": 42, # The status code, which should be an enum value of google.rpc.Code. "details": [ # A list of messages that carry the error details. There is a common set of message types for APIs to use. { @@ -2786,18 +2786,18 @@

Method Details

"totalPauseDuration": "A String", # The accumulated duration the replication cycle was paused. "warnings": [ # Output only. Warnings that occurred during the cycle. { # Represents migration resource warning information that can be used with google.rpc.Status message. MigrationWarning is used to present the user with warning information in migration operations. - "actionItem": { # Provides a localized error message that is safe to return to the user which can be attached to an RPC error. # Suggested action for solving the warning. + "actionItem": { # Provides a localized error message that is safe to return to the user which can be attached to an RPC error. # Output only. Suggested action for solving the warning. "locale": "A String", # The locale used following the specification defined at https://www.rfc-editor.org/rfc/bcp/bcp47.txt. Examples are: "en-US", "fr-CH", "es-MX" "message": "A String", # The localized error message in the above locale. }, "code": "A String", # The warning code. - "helpLinks": [ # URL(s) pointing to additional information on handling the current warning. + "helpLinks": [ # Output only. URL(s) pointing to additional information on handling the current warning. { # Describes a URL link. "description": "A String", # Describes what the link offers. "url": "A String", # The URL of the link. }, ], - "warningMessage": { # Provides a localized error message that is safe to return to the user which can be attached to an RPC error. # The localized warning message. + "warningMessage": { # Provides a localized error message that is safe to return to the user which can be attached to an RPC error. # Output only. The localized warning message. "locale": "A String", # The locale used following the specification defined at https://www.rfc-editor.org/rfc/bcp/bcp47.txt. Examples are: "en-US", "fr-CH", "es-MX" "message": "A String", # The localized error message in the above locale. }, @@ -2817,15 +2817,15 @@

Method Details

"stateTime": "A String", # Output only. The last time the migrating VM state was updated. "updateTime": "A String", # Output only. The last time the migrating VM resource was updated. "vmwareSourceVmDetails": { # Represent the source Vmware VM details. # Output only. Details of the VM from a Vmware source. - "committedStorageBytes": "A String", # The total size of the disks being migrated in bytes. - "disks": [ # The disks attached to the source VM. + "committedStorageBytes": "A String", # Output only. The total size of the disks being migrated in bytes. + "disks": [ # Output only. The disks attached to the source VM. { # The details of a Vmware VM disk. - "diskNumber": 42, # The ordinal number of the disk. - "label": "A String", # The disk label. - "sizeGb": "A String", # Size in GB. + "diskNumber": 42, # Output only. The ordinal number of the disk. + "label": "A String", # Output only. The disk label. + "sizeGb": "A String", # Output only. Size in GB. }, ], - "firmware": "A String", # The firmware type of the source VM. + "firmware": "A String", # Output only. The firmware type of the source VM. "vmCapabilitiesInfo": { # Migrating VM source information about the VM capabilities needed for some Compute Engine features. # Output only. Information about VM capabilities needed for some Compute Engine features. "lastOsCapabilitiesUpdateTime": "A String", # Output only. The last time OS capabilities list was updated. "osCapabilities": [ # Output only. Unordered list. List of certain VM OS capabilities needed for some Compute Engine features. diff --git a/docs/dyn/vmmigration_v1.projects.locations.sources.migratingVms.replicationCycles.html b/docs/dyn/vmmigration_v1.projects.locations.sources.migratingVms.replicationCycles.html index 2a3231e7de2..ae83c66fef7 100644 --- a/docs/dyn/vmmigration_v1.projects.locations.sources.migratingVms.replicationCycles.html +++ b/docs/dyn/vmmigration_v1.projects.locations.sources.migratingVms.replicationCycles.html @@ -109,7 +109,7 @@

Method Details

{ # ReplicationCycle contains information about the current replication cycle status. "cycleNumber": 42, # The cycle's ordinal number. "endTime": "A String", # The time the replication cycle has ended. - "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). # Provides details on the state of the cycle in case of an error. + "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). # Output only. Provides details on the state of the cycle in case of an error. "code": 42, # The status code, which should be an enum value of google.rpc.Code. "details": [ # A list of messages that carry the error details. There is a common set of message types for APIs to use. { @@ -141,18 +141,18 @@

Method Details

"totalPauseDuration": "A String", # The accumulated duration the replication cycle was paused. "warnings": [ # Output only. Warnings that occurred during the cycle. { # Represents migration resource warning information that can be used with google.rpc.Status message. MigrationWarning is used to present the user with warning information in migration operations. - "actionItem": { # Provides a localized error message that is safe to return to the user which can be attached to an RPC error. # Suggested action for solving the warning. + "actionItem": { # Provides a localized error message that is safe to return to the user which can be attached to an RPC error. # Output only. Suggested action for solving the warning. "locale": "A String", # The locale used following the specification defined at https://www.rfc-editor.org/rfc/bcp/bcp47.txt. Examples are: "en-US", "fr-CH", "es-MX" "message": "A String", # The localized error message in the above locale. }, "code": "A String", # The warning code. - "helpLinks": [ # URL(s) pointing to additional information on handling the current warning. + "helpLinks": [ # Output only. URL(s) pointing to additional information on handling the current warning. { # Describes a URL link. "description": "A String", # Describes what the link offers. "url": "A String", # The URL of the link. }, ], - "warningMessage": { # Provides a localized error message that is safe to return to the user which can be attached to an RPC error. # The localized warning message. + "warningMessage": { # Provides a localized error message that is safe to return to the user which can be attached to an RPC error. # Output only. The localized warning message. "locale": "A String", # The locale used following the specification defined at https://www.rfc-editor.org/rfc/bcp/bcp47.txt. Examples are: "en-US", "fr-CH", "es-MX" "message": "A String", # The localized error message in the above locale. }, @@ -186,7 +186,7 @@

Method Details

{ # ReplicationCycle contains information about the current replication cycle status. "cycleNumber": 42, # The cycle's ordinal number. "endTime": "A String", # The time the replication cycle has ended. - "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). # Provides details on the state of the cycle in case of an error. + "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). # Output only. Provides details on the state of the cycle in case of an error. "code": 42, # The status code, which should be an enum value of google.rpc.Code. "details": [ # A list of messages that carry the error details. There is a common set of message types for APIs to use. { @@ -218,18 +218,18 @@

Method Details

"totalPauseDuration": "A String", # The accumulated duration the replication cycle was paused. "warnings": [ # Output only. Warnings that occurred during the cycle. { # Represents migration resource warning information that can be used with google.rpc.Status message. MigrationWarning is used to present the user with warning information in migration operations. - "actionItem": { # Provides a localized error message that is safe to return to the user which can be attached to an RPC error. # Suggested action for solving the warning. + "actionItem": { # Provides a localized error message that is safe to return to the user which can be attached to an RPC error. # Output only. Suggested action for solving the warning. "locale": "A String", # The locale used following the specification defined at https://www.rfc-editor.org/rfc/bcp/bcp47.txt. Examples are: "en-US", "fr-CH", "es-MX" "message": "A String", # The localized error message in the above locale. }, "code": "A String", # The warning code. - "helpLinks": [ # URL(s) pointing to additional information on handling the current warning. + "helpLinks": [ # Output only. URL(s) pointing to additional information on handling the current warning. { # Describes a URL link. "description": "A String", # Describes what the link offers. "url": "A String", # The URL of the link. }, ], - "warningMessage": { # Provides a localized error message that is safe to return to the user which can be attached to an RPC error. # The localized warning message. + "warningMessage": { # Provides a localized error message that is safe to return to the user which can be attached to an RPC error. # Output only. The localized warning message. "locale": "A String", # The locale used following the specification defined at https://www.rfc-editor.org/rfc/bcp/bcp47.txt. Examples are: "en-US", "fr-CH", "es-MX" "message": "A String", # The localized error message in the above locale. }, diff --git a/docs/dyn/vmmigration_v1alpha1.projects.locations.imageImports.html b/docs/dyn/vmmigration_v1alpha1.projects.locations.imageImports.html index d21a1604e98..d0df9bb7ff0 100644 --- a/docs/dyn/vmmigration_v1alpha1.projects.locations.imageImports.html +++ b/docs/dyn/vmmigration_v1alpha1.projects.locations.imageImports.html @@ -200,18 +200,18 @@

Method Details

], "warnings": [ # Output only. Warnings that occurred during the image import. { # Represents migration resource warning information that can be used with google.rpc.Status message. MigrationWarning is used to present the user with warning information in migration operations. - "actionItem": { # Provides a localized error message that is safe to return to the user which can be attached to an RPC error. # Suggested action for solving the warning. + "actionItem": { # Provides a localized error message that is safe to return to the user which can be attached to an RPC error. # Output only. Suggested action for solving the warning. "locale": "A String", # The locale used following the specification defined at https://www.rfc-editor.org/rfc/bcp/bcp47.txt. Examples are: "en-US", "fr-CH", "es-MX" "message": "A String", # The localized error message in the above locale. }, "code": "A String", # The warning code. - "helpLinks": [ # URL(s) pointing to additional information on handling the current warning. + "helpLinks": [ # Output only. URL(s) pointing to additional information on handling the current warning. { # Describes a URL link. "description": "A String", # Describes what the link offers. "url": "A String", # The URL of the link. }, ], - "warningMessage": { # Provides a localized error message that is safe to return to the user which can be attached to an RPC error. # The localized warning message. + "warningMessage": { # Provides a localized error message that is safe to return to the user which can be attached to an RPC error. # Output only. The localized warning message. "locale": "A String", # The locale used following the specification defined at https://www.rfc-editor.org/rfc/bcp/bcp47.txt. Examples are: "en-US", "fr-CH", "es-MX" "message": "A String", # The localized error message in the above locale. }, @@ -391,18 +391,18 @@

Method Details

], "warnings": [ # Output only. Warnings that occurred during the image import. { # Represents migration resource warning information that can be used with google.rpc.Status message. MigrationWarning is used to present the user with warning information in migration operations. - "actionItem": { # Provides a localized error message that is safe to return to the user which can be attached to an RPC error. # Suggested action for solving the warning. + "actionItem": { # Provides a localized error message that is safe to return to the user which can be attached to an RPC error. # Output only. Suggested action for solving the warning. "locale": "A String", # The locale used following the specification defined at https://www.rfc-editor.org/rfc/bcp/bcp47.txt. Examples are: "en-US", "fr-CH", "es-MX" "message": "A String", # The localized error message in the above locale. }, "code": "A String", # The warning code. - "helpLinks": [ # URL(s) pointing to additional information on handling the current warning. + "helpLinks": [ # Output only. URL(s) pointing to additional information on handling the current warning. { # Describes a URL link. "description": "A String", # Describes what the link offers. "url": "A String", # The URL of the link. }, ], - "warningMessage": { # Provides a localized error message that is safe to return to the user which can be attached to an RPC error. # The localized warning message. + "warningMessage": { # Provides a localized error message that is safe to return to the user which can be attached to an RPC error. # Output only. The localized warning message. "locale": "A String", # The locale used following the specification defined at https://www.rfc-editor.org/rfc/bcp/bcp47.txt. Examples are: "en-US", "fr-CH", "es-MX" "message": "A String", # The localized error message in the above locale. }, @@ -522,18 +522,18 @@

Method Details

], "warnings": [ # Output only. Warnings that occurred during the image import. { # Represents migration resource warning information that can be used with google.rpc.Status message. MigrationWarning is used to present the user with warning information in migration operations. - "actionItem": { # Provides a localized error message that is safe to return to the user which can be attached to an RPC error. # Suggested action for solving the warning. + "actionItem": { # Provides a localized error message that is safe to return to the user which can be attached to an RPC error. # Output only. Suggested action for solving the warning. "locale": "A String", # The locale used following the specification defined at https://www.rfc-editor.org/rfc/bcp/bcp47.txt. Examples are: "en-US", "fr-CH", "es-MX" "message": "A String", # The localized error message in the above locale. }, "code": "A String", # The warning code. - "helpLinks": [ # URL(s) pointing to additional information on handling the current warning. + "helpLinks": [ # Output only. URL(s) pointing to additional information on handling the current warning. { # Describes a URL link. "description": "A String", # Describes what the link offers. "url": "A String", # The URL of the link. }, ], - "warningMessage": { # Provides a localized error message that is safe to return to the user which can be attached to an RPC error. # The localized warning message. + "warningMessage": { # Provides a localized error message that is safe to return to the user which can be attached to an RPC error. # Output only. The localized warning message. "locale": "A String", # The locale used following the specification defined at https://www.rfc-editor.org/rfc/bcp/bcp47.txt. Examples are: "en-US", "fr-CH", "es-MX" "message": "A String", # The localized error message in the above locale. }, diff --git a/docs/dyn/vmmigration_v1alpha1.projects.locations.imageImports.imageImportJobs.html b/docs/dyn/vmmigration_v1alpha1.projects.locations.imageImports.imageImportJobs.html index db50c09b31c..df572aac288 100644 --- a/docs/dyn/vmmigration_v1alpha1.projects.locations.imageImports.imageImportJobs.html +++ b/docs/dyn/vmmigration_v1alpha1.projects.locations.imageImports.imageImportJobs.html @@ -208,18 +208,18 @@

Method Details

], "warnings": [ # Output only. Warnings that occurred during the image import. { # Represents migration resource warning information that can be used with google.rpc.Status message. MigrationWarning is used to present the user with warning information in migration operations. - "actionItem": { # Provides a localized error message that is safe to return to the user which can be attached to an RPC error. # Suggested action for solving the warning. + "actionItem": { # Provides a localized error message that is safe to return to the user which can be attached to an RPC error. # Output only. Suggested action for solving the warning. "locale": "A String", # The locale used following the specification defined at https://www.rfc-editor.org/rfc/bcp/bcp47.txt. Examples are: "en-US", "fr-CH", "es-MX" "message": "A String", # The localized error message in the above locale. }, "code": "A String", # The warning code. - "helpLinks": [ # URL(s) pointing to additional information on handling the current warning. + "helpLinks": [ # Output only. URL(s) pointing to additional information on handling the current warning. { # Describes a URL link. "description": "A String", # Describes what the link offers. "url": "A String", # The URL of the link. }, ], - "warningMessage": { # Provides a localized error message that is safe to return to the user which can be attached to an RPC error. # The localized warning message. + "warningMessage": { # Provides a localized error message that is safe to return to the user which can be attached to an RPC error. # Output only. The localized warning message. "locale": "A String", # The locale used following the specification defined at https://www.rfc-editor.org/rfc/bcp/bcp47.txt. Examples are: "en-US", "fr-CH", "es-MX" "message": "A String", # The localized error message in the above locale. }, @@ -307,18 +307,18 @@

Method Details

], "warnings": [ # Output only. Warnings that occurred during the image import. { # Represents migration resource warning information that can be used with google.rpc.Status message. MigrationWarning is used to present the user with warning information in migration operations. - "actionItem": { # Provides a localized error message that is safe to return to the user which can be attached to an RPC error. # Suggested action for solving the warning. + "actionItem": { # Provides a localized error message that is safe to return to the user which can be attached to an RPC error. # Output only. Suggested action for solving the warning. "locale": "A String", # The locale used following the specification defined at https://www.rfc-editor.org/rfc/bcp/bcp47.txt. Examples are: "en-US", "fr-CH", "es-MX" "message": "A String", # The localized error message in the above locale. }, "code": "A String", # The warning code. - "helpLinks": [ # URL(s) pointing to additional information on handling the current warning. + "helpLinks": [ # Output only. URL(s) pointing to additional information on handling the current warning. { # Describes a URL link. "description": "A String", # Describes what the link offers. "url": "A String", # The URL of the link. }, ], - "warningMessage": { # Provides a localized error message that is safe to return to the user which can be attached to an RPC error. # The localized warning message. + "warningMessage": { # Provides a localized error message that is safe to return to the user which can be attached to an RPC error. # Output only. The localized warning message. "locale": "A String", # The locale used following the specification defined at https://www.rfc-editor.org/rfc/bcp/bcp47.txt. Examples are: "en-US", "fr-CH", "es-MX" "message": "A String", # The localized error message in the above locale. }, diff --git a/docs/dyn/vmmigration_v1alpha1.projects.locations.sources.datacenterConnectors.html b/docs/dyn/vmmigration_v1alpha1.projects.locations.sources.datacenterConnectors.html index c4b851e6ff7..693bfbe2867 100644 --- a/docs/dyn/vmmigration_v1alpha1.projects.locations.sources.datacenterConnectors.html +++ b/docs/dyn/vmmigration_v1alpha1.projects.locations.sources.datacenterConnectors.html @@ -145,7 +145,7 @@

Method Details

"stateTime": "A String", # Output only. The time the state was last set. "updateTime": "A String", # Output only. The last time the connector was updated with an API call. "upgradeStatus": { # UpgradeStatus contains information about upgradeAppliance operation. # Output only. The status of the current / last upgradeAppliance operation. - "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). # Provides details on the state of the upgrade operation in case of an error. + "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). # Output only. Provides details on the state of the upgrade operation in case of an error. "code": 42, # The status code, which should be an enum value of google.rpc.Code. "details": [ # A list of messages that carry the error details. There is a common set of message types for APIs to use. { @@ -278,7 +278,7 @@

Method Details

"stateTime": "A String", # Output only. The time the state was last set. "updateTime": "A String", # Output only. The last time the connector was updated with an API call. "upgradeStatus": { # UpgradeStatus contains information about upgradeAppliance operation. # Output only. The status of the current / last upgradeAppliance operation. - "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). # Provides details on the state of the upgrade operation in case of an error. + "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). # Output only. Provides details on the state of the upgrade operation in case of an error. "code": 42, # The status code, which should be an enum value of google.rpc.Code. "details": [ # A list of messages that carry the error details. There is a common set of message types for APIs to use. { @@ -351,7 +351,7 @@

Method Details

"stateTime": "A String", # Output only. The time the state was last set. "updateTime": "A String", # Output only. The last time the connector was updated with an API call. "upgradeStatus": { # UpgradeStatus contains information about upgradeAppliance operation. # Output only. The status of the current / last upgradeAppliance operation. - "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). # Provides details on the state of the upgrade operation in case of an error. + "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). # Output only. Provides details on the state of the upgrade operation in case of an error. "code": 42, # The status code, which should be an enum value of google.rpc.Code. "details": [ # A list of messages that carry the error details. There is a common set of message types for APIs to use. { diff --git a/docs/dyn/vmmigration_v1alpha1.projects.locations.sources.html b/docs/dyn/vmmigration_v1alpha1.projects.locations.sources.html index cda2e6aeee8..f5e1c7495e2 100644 --- a/docs/dyn/vmmigration_v1alpha1.projects.locations.sources.html +++ b/docs/dyn/vmmigration_v1alpha1.projects.locations.sources.html @@ -153,8 +153,8 @@

Method Details

], "inventoryTagList": [ # AWS resource tags to limit the scope of the source inventory. { # Tag is an AWS tag representation. - "key": "A String", # Key of tag. - "value": "A String", # Value of tag. + "key": "A String", # Required. Key of tag. + "value": "A String", # Required. Value of tag. }, ], "migrationResourcesUserTags": { # User specified tags to add to every M2VM generated resource in AWS. These tags will be set in addition to the default tags that are set as part of the migration process. The tags must not begin with the reserved prefix `m2vm`. @@ -440,8 +440,8 @@

Method Details

], "inventoryTagList": [ # AWS resource tags to limit the scope of the source inventory. { # Tag is an AWS tag representation. - "key": "A String", # Key of tag. - "value": "A String", # Value of tag. + "key": "A String", # Required. Key of tag. + "value": "A String", # Required. Value of tag. }, ], "migrationResourcesUserTags": { # User specified tags to add to every M2VM generated resource in AWS. These tags will be set in addition to the default tags that are set as part of the migration process. The tags must not begin with the reserved prefix `m2vm`. @@ -545,8 +545,8 @@

Method Details

], "inventoryTagList": [ # AWS resource tags to limit the scope of the source inventory. { # Tag is an AWS tag representation. - "key": "A String", # Key of tag. - "value": "A String", # Value of tag. + "key": "A String", # Required. Key of tag. + "value": "A String", # Required. Value of tag. }, ], "migrationResourcesUserTags": { # User specified tags to add to every M2VM generated resource in AWS. These tags will be set in addition to the default tags that are set as part of the migration process. The tags must not begin with the reserved prefix `m2vm`. @@ -657,8 +657,8 @@

Method Details

], "inventoryTagList": [ # AWS resource tags to limit the scope of the source inventory. { # Tag is an AWS tag representation. - "key": "A String", # Key of tag. - "value": "A String", # Value of tag. + "key": "A String", # Required. Key of tag. + "value": "A String", # Required. Value of tag. }, ], "migrationResourcesUserTags": { # User specified tags to add to every M2VM generated resource in AWS. These tags will be set in addition to the default tags that are set as part of the migration process. The tags must not begin with the reserved prefix `m2vm`. diff --git a/docs/dyn/vmmigration_v1alpha1.projects.locations.sources.migratingVms.cloneJobs.html b/docs/dyn/vmmigration_v1alpha1.projects.locations.sources.migratingVms.cloneJobs.html index fdc75f88fb0..c553b89e89a 100644 --- a/docs/dyn/vmmigration_v1alpha1.projects.locations.sources.migratingVms.cloneJobs.html +++ b/docs/dyn/vmmigration_v1alpha1.projects.locations.sources.migratingVms.cloneJobs.html @@ -202,8 +202,8 @@

Method Details

}, "networkInterfaces": [ # List of NICs connected to this VM. { # NetworkInterface represents a NIC of a VM. - "externalIp": "A String", # The external IP to define in the NIC. - "internalIp": "A String", # The internal IP to define in the NIC. The formats accepted are: `ephemeral` \ ipv4 address \ a named address resource full path. + "externalIp": "A String", # Optional. The external IP to define in the NIC. + "internalIp": "A String", # Optional. The internal IP to define in the NIC. The formats accepted are: `ephemeral` \ ipv4 address \ a named address resource full path. "network": "A String", # The network to connect the NIC to. "subnetwork": "A String", # The subnetwork to connect the NIC to. }, @@ -254,8 +254,8 @@

Method Details

"network": "A String", # The network to connect the VM to. "networkInterfaces": [ # List of NICs connected to this VM. { # NetworkInterface represents a NIC of a VM. - "externalIp": "A String", # The external IP to define in the NIC. - "internalIp": "A String", # The internal IP to define in the NIC. The formats accepted are: `ephemeral` \ ipv4 address \ a named address resource full path. + "externalIp": "A String", # Optional. The external IP to define in the NIC. + "internalIp": "A String", # Optional. The internal IP to define in the NIC. The formats accepted are: `ephemeral` \ ipv4 address \ a named address resource full path. "network": "A String", # The network to connect the NIC to. "subnetwork": "A String", # The subnetwork to connect the NIC to. }, @@ -333,8 +333,8 @@

Method Details

"network": "A String", # The network to connect the VM to. "networkInterfaces": [ # List of NICs connected to this VM. { # NetworkInterface represents a NIC of a VM. - "externalIp": "A String", # The external IP to define in the NIC. - "internalIp": "A String", # The internal IP to define in the NIC. The formats accepted are: `ephemeral` \ ipv4 address \ a named address resource full path. + "externalIp": "A String", # Optional. The external IP to define in the NIC. + "internalIp": "A String", # Optional. The internal IP to define in the NIC. The formats accepted are: `ephemeral` \ ipv4 address \ a named address resource full path. "network": "A String", # The network to connect the NIC to. "subnetwork": "A String", # The subnetwork to connect the NIC to. }, @@ -450,8 +450,8 @@

Method Details

}, "networkInterfaces": [ # List of NICs connected to this VM. { # NetworkInterface represents a NIC of a VM. - "externalIp": "A String", # The external IP to define in the NIC. - "internalIp": "A String", # The internal IP to define in the NIC. The formats accepted are: `ephemeral` \ ipv4 address \ a named address resource full path. + "externalIp": "A String", # Optional. The external IP to define in the NIC. + "internalIp": "A String", # Optional. The internal IP to define in the NIC. The formats accepted are: `ephemeral` \ ipv4 address \ a named address resource full path. "network": "A String", # The network to connect the NIC to. "subnetwork": "A String", # The subnetwork to connect the NIC to. }, @@ -502,8 +502,8 @@

Method Details

"network": "A String", # The network to connect the VM to. "networkInterfaces": [ # List of NICs connected to this VM. { # NetworkInterface represents a NIC of a VM. - "externalIp": "A String", # The external IP to define in the NIC. - "internalIp": "A String", # The internal IP to define in the NIC. The formats accepted are: `ephemeral` \ ipv4 address \ a named address resource full path. + "externalIp": "A String", # Optional. The external IP to define in the NIC. + "internalIp": "A String", # Optional. The internal IP to define in the NIC. The formats accepted are: `ephemeral` \ ipv4 address \ a named address resource full path. "network": "A String", # The network to connect the NIC to. "subnetwork": "A String", # The subnetwork to connect the NIC to. }, @@ -581,8 +581,8 @@

Method Details

"network": "A String", # The network to connect the VM to. "networkInterfaces": [ # List of NICs connected to this VM. { # NetworkInterface represents a NIC of a VM. - "externalIp": "A String", # The external IP to define in the NIC. - "internalIp": "A String", # The internal IP to define in the NIC. The formats accepted are: `ephemeral` \ ipv4 address \ a named address resource full path. + "externalIp": "A String", # Optional. The external IP to define in the NIC. + "internalIp": "A String", # Optional. The internal IP to define in the NIC. The formats accepted are: `ephemeral` \ ipv4 address \ a named address resource full path. "network": "A String", # The network to connect the NIC to. "subnetwork": "A String", # The subnetwork to connect the NIC to. }, @@ -674,8 +674,8 @@

Method Details

}, "networkInterfaces": [ # List of NICs connected to this VM. { # NetworkInterface represents a NIC of a VM. - "externalIp": "A String", # The external IP to define in the NIC. - "internalIp": "A String", # The internal IP to define in the NIC. The formats accepted are: `ephemeral` \ ipv4 address \ a named address resource full path. + "externalIp": "A String", # Optional. The external IP to define in the NIC. + "internalIp": "A String", # Optional. The internal IP to define in the NIC. The formats accepted are: `ephemeral` \ ipv4 address \ a named address resource full path. "network": "A String", # The network to connect the NIC to. "subnetwork": "A String", # The subnetwork to connect the NIC to. }, @@ -726,8 +726,8 @@

Method Details

"network": "A String", # The network to connect the VM to. "networkInterfaces": [ # List of NICs connected to this VM. { # NetworkInterface represents a NIC of a VM. - "externalIp": "A String", # The external IP to define in the NIC. - "internalIp": "A String", # The internal IP to define in the NIC. The formats accepted are: `ephemeral` \ ipv4 address \ a named address resource full path. + "externalIp": "A String", # Optional. The external IP to define in the NIC. + "internalIp": "A String", # Optional. The internal IP to define in the NIC. The formats accepted are: `ephemeral` \ ipv4 address \ a named address resource full path. "network": "A String", # The network to connect the NIC to. "subnetwork": "A String", # The subnetwork to connect the NIC to. }, @@ -805,8 +805,8 @@

Method Details

"network": "A String", # The network to connect the VM to. "networkInterfaces": [ # List of NICs connected to this VM. { # NetworkInterface represents a NIC of a VM. - "externalIp": "A String", # The external IP to define in the NIC. - "internalIp": "A String", # The internal IP to define in the NIC. The formats accepted are: `ephemeral` \ ipv4 address \ a named address resource full path. + "externalIp": "A String", # Optional. The external IP to define in the NIC. + "internalIp": "A String", # Optional. The internal IP to define in the NIC. The formats accepted are: `ephemeral` \ ipv4 address \ a named address resource full path. "network": "A String", # The network to connect the NIC to. "subnetwork": "A String", # The subnetwork to connect the NIC to. }, diff --git a/docs/dyn/vmmigration_v1alpha1.projects.locations.sources.migratingVms.cutoverJobs.html b/docs/dyn/vmmigration_v1alpha1.projects.locations.sources.migratingVms.cutoverJobs.html index defc940b249..a25631f6e0b 100644 --- a/docs/dyn/vmmigration_v1alpha1.projects.locations.sources.migratingVms.cutoverJobs.html +++ b/docs/dyn/vmmigration_v1alpha1.projects.locations.sources.migratingVms.cutoverJobs.html @@ -202,8 +202,8 @@

Method Details

}, "networkInterfaces": [ # List of NICs connected to this VM. { # NetworkInterface represents a NIC of a VM. - "externalIp": "A String", # The external IP to define in the NIC. - "internalIp": "A String", # The internal IP to define in the NIC. The formats accepted are: `ephemeral` \ ipv4 address \ a named address resource full path. + "externalIp": "A String", # Optional. The external IP to define in the NIC. + "internalIp": "A String", # Optional. The internal IP to define in the NIC. The formats accepted are: `ephemeral` \ ipv4 address \ a named address resource full path. "network": "A String", # The network to connect the NIC to. "subnetwork": "A String", # The subnetwork to connect the NIC to. }, @@ -254,8 +254,8 @@

Method Details

"network": "A String", # The network to connect the VM to. "networkInterfaces": [ # List of NICs connected to this VM. { # NetworkInterface represents a NIC of a VM. - "externalIp": "A String", # The external IP to define in the NIC. - "internalIp": "A String", # The internal IP to define in the NIC. The formats accepted are: `ephemeral` \ ipv4 address \ a named address resource full path. + "externalIp": "A String", # Optional. The external IP to define in the NIC. + "internalIp": "A String", # Optional. The internal IP to define in the NIC. The formats accepted are: `ephemeral` \ ipv4 address \ a named address resource full path. "network": "A String", # The network to connect the NIC to. "subnetwork": "A String", # The subnetwork to connect the NIC to. }, @@ -293,7 +293,7 @@

Method Details

"finalSync": { # ReplicationCycle contains information about the current replication cycle status. # Final sync step. "cycleNumber": 42, # The cycle's ordinal number. "endTime": "A String", # The time the replication cycle has ended. - "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). # Provides details on the state of the cycle in case of an error. + "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). # Output only. Provides details on the state of the cycle in case of an error. "code": 42, # The status code, which should be an enum value of google.rpc.Code. "details": [ # A list of messages that carry the error details. There is a common set of message types for APIs to use. { @@ -326,18 +326,18 @@

Method Details

"totalPauseDuration": "A String", # The accumulated duration the replication cycle was paused. "warnings": [ # Output only. Warnings that occurred during the cycle. { # Represents migration resource warning information that can be used with google.rpc.Status message. MigrationWarning is used to present the user with warning information in migration operations. - "actionItem": { # Provides a localized error message that is safe to return to the user which can be attached to an RPC error. # Suggested action for solving the warning. + "actionItem": { # Provides a localized error message that is safe to return to the user which can be attached to an RPC error. # Output only. Suggested action for solving the warning. "locale": "A String", # The locale used following the specification defined at https://www.rfc-editor.org/rfc/bcp/bcp47.txt. Examples are: "en-US", "fr-CH", "es-MX" "message": "A String", # The localized error message in the above locale. }, "code": "A String", # The warning code. - "helpLinks": [ # URL(s) pointing to additional information on handling the current warning. + "helpLinks": [ # Output only. URL(s) pointing to additional information on handling the current warning. { # Describes a URL link. "description": "A String", # Describes what the link offers. "url": "A String", # The URL of the link. }, ], - "warningMessage": { # Provides a localized error message that is safe to return to the user which can be attached to an RPC error. # The localized warning message. + "warningMessage": { # Provides a localized error message that is safe to return to the user which can be attached to an RPC error. # Output only. The localized warning message. "locale": "A String", # The locale used following the specification defined at https://www.rfc-editor.org/rfc/bcp/bcp47.txt. Examples are: "en-US", "fr-CH", "es-MX" "message": "A String", # The localized error message in the above locale. }, @@ -352,7 +352,7 @@

Method Details

"previousReplicationCycle": { # ReplicationCycle contains information about the current replication cycle status. # A replication cycle prior cutover step. "cycleNumber": 42, # The cycle's ordinal number. "endTime": "A String", # The time the replication cycle has ended. - "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). # Provides details on the state of the cycle in case of an error. + "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). # Output only. Provides details on the state of the cycle in case of an error. "code": 42, # The status code, which should be an enum value of google.rpc.Code. "details": [ # A list of messages that carry the error details. There is a common set of message types for APIs to use. { @@ -385,18 +385,18 @@

Method Details

"totalPauseDuration": "A String", # The accumulated duration the replication cycle was paused. "warnings": [ # Output only. Warnings that occurred during the cycle. { # Represents migration resource warning information that can be used with google.rpc.Status message. MigrationWarning is used to present the user with warning information in migration operations. - "actionItem": { # Provides a localized error message that is safe to return to the user which can be attached to an RPC error. # Suggested action for solving the warning. + "actionItem": { # Provides a localized error message that is safe to return to the user which can be attached to an RPC error. # Output only. Suggested action for solving the warning. "locale": "A String", # The locale used following the specification defined at https://www.rfc-editor.org/rfc/bcp/bcp47.txt. Examples are: "en-US", "fr-CH", "es-MX" "message": "A String", # The localized error message in the above locale. }, "code": "A String", # The warning code. - "helpLinks": [ # URL(s) pointing to additional information on handling the current warning. + "helpLinks": [ # Output only. URL(s) pointing to additional information on handling the current warning. { # Describes a URL link. "description": "A String", # Describes what the link offers. "url": "A String", # The URL of the link. }, ], - "warningMessage": { # Provides a localized error message that is safe to return to the user which can be attached to an RPC error. # The localized warning message. + "warningMessage": { # Provides a localized error message that is safe to return to the user which can be attached to an RPC error. # Output only. The localized warning message. "locale": "A String", # The locale used following the specification defined at https://www.rfc-editor.org/rfc/bcp/bcp47.txt. Examples are: "en-US", "fr-CH", "es-MX" "message": "A String", # The localized error message in the above locale. }, @@ -446,8 +446,8 @@

Method Details

"network": "A String", # The network to connect the VM to. "networkInterfaces": [ # List of NICs connected to this VM. { # NetworkInterface represents a NIC of a VM. - "externalIp": "A String", # The external IP to define in the NIC. - "internalIp": "A String", # The internal IP to define in the NIC. The formats accepted are: `ephemeral` \ ipv4 address \ a named address resource full path. + "externalIp": "A String", # Optional. The external IP to define in the NIC. + "internalIp": "A String", # Optional. The internal IP to define in the NIC. The formats accepted are: `ephemeral` \ ipv4 address \ a named address resource full path. "network": "A String", # The network to connect the NIC to. "subnetwork": "A String", # The subnetwork to connect the NIC to. }, @@ -563,8 +563,8 @@

Method Details

}, "networkInterfaces": [ # List of NICs connected to this VM. { # NetworkInterface represents a NIC of a VM. - "externalIp": "A String", # The external IP to define in the NIC. - "internalIp": "A String", # The internal IP to define in the NIC. The formats accepted are: `ephemeral` \ ipv4 address \ a named address resource full path. + "externalIp": "A String", # Optional. The external IP to define in the NIC. + "internalIp": "A String", # Optional. The internal IP to define in the NIC. The formats accepted are: `ephemeral` \ ipv4 address \ a named address resource full path. "network": "A String", # The network to connect the NIC to. "subnetwork": "A String", # The subnetwork to connect the NIC to. }, @@ -615,8 +615,8 @@

Method Details

"network": "A String", # The network to connect the VM to. "networkInterfaces": [ # List of NICs connected to this VM. { # NetworkInterface represents a NIC of a VM. - "externalIp": "A String", # The external IP to define in the NIC. - "internalIp": "A String", # The internal IP to define in the NIC. The formats accepted are: `ephemeral` \ ipv4 address \ a named address resource full path. + "externalIp": "A String", # Optional. The external IP to define in the NIC. + "internalIp": "A String", # Optional. The internal IP to define in the NIC. The formats accepted are: `ephemeral` \ ipv4 address \ a named address resource full path. "network": "A String", # The network to connect the NIC to. "subnetwork": "A String", # The subnetwork to connect the NIC to. }, @@ -654,7 +654,7 @@

Method Details

"finalSync": { # ReplicationCycle contains information about the current replication cycle status. # Final sync step. "cycleNumber": 42, # The cycle's ordinal number. "endTime": "A String", # The time the replication cycle has ended. - "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). # Provides details on the state of the cycle in case of an error. + "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). # Output only. Provides details on the state of the cycle in case of an error. "code": 42, # The status code, which should be an enum value of google.rpc.Code. "details": [ # A list of messages that carry the error details. There is a common set of message types for APIs to use. { @@ -687,18 +687,18 @@

Method Details

"totalPauseDuration": "A String", # The accumulated duration the replication cycle was paused. "warnings": [ # Output only. Warnings that occurred during the cycle. { # Represents migration resource warning information that can be used with google.rpc.Status message. MigrationWarning is used to present the user with warning information in migration operations. - "actionItem": { # Provides a localized error message that is safe to return to the user which can be attached to an RPC error. # Suggested action for solving the warning. + "actionItem": { # Provides a localized error message that is safe to return to the user which can be attached to an RPC error. # Output only. Suggested action for solving the warning. "locale": "A String", # The locale used following the specification defined at https://www.rfc-editor.org/rfc/bcp/bcp47.txt. Examples are: "en-US", "fr-CH", "es-MX" "message": "A String", # The localized error message in the above locale. }, "code": "A String", # The warning code. - "helpLinks": [ # URL(s) pointing to additional information on handling the current warning. + "helpLinks": [ # Output only. URL(s) pointing to additional information on handling the current warning. { # Describes a URL link. "description": "A String", # Describes what the link offers. "url": "A String", # The URL of the link. }, ], - "warningMessage": { # Provides a localized error message that is safe to return to the user which can be attached to an RPC error. # The localized warning message. + "warningMessage": { # Provides a localized error message that is safe to return to the user which can be attached to an RPC error. # Output only. The localized warning message. "locale": "A String", # The locale used following the specification defined at https://www.rfc-editor.org/rfc/bcp/bcp47.txt. Examples are: "en-US", "fr-CH", "es-MX" "message": "A String", # The localized error message in the above locale. }, @@ -713,7 +713,7 @@

Method Details

"previousReplicationCycle": { # ReplicationCycle contains information about the current replication cycle status. # A replication cycle prior cutover step. "cycleNumber": 42, # The cycle's ordinal number. "endTime": "A String", # The time the replication cycle has ended. - "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). # Provides details on the state of the cycle in case of an error. + "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). # Output only. Provides details on the state of the cycle in case of an error. "code": 42, # The status code, which should be an enum value of google.rpc.Code. "details": [ # A list of messages that carry the error details. There is a common set of message types for APIs to use. { @@ -746,18 +746,18 @@

Method Details

"totalPauseDuration": "A String", # The accumulated duration the replication cycle was paused. "warnings": [ # Output only. Warnings that occurred during the cycle. { # Represents migration resource warning information that can be used with google.rpc.Status message. MigrationWarning is used to present the user with warning information in migration operations. - "actionItem": { # Provides a localized error message that is safe to return to the user which can be attached to an RPC error. # Suggested action for solving the warning. + "actionItem": { # Provides a localized error message that is safe to return to the user which can be attached to an RPC error. # Output only. Suggested action for solving the warning. "locale": "A String", # The locale used following the specification defined at https://www.rfc-editor.org/rfc/bcp/bcp47.txt. Examples are: "en-US", "fr-CH", "es-MX" "message": "A String", # The localized error message in the above locale. }, "code": "A String", # The warning code. - "helpLinks": [ # URL(s) pointing to additional information on handling the current warning. + "helpLinks": [ # Output only. URL(s) pointing to additional information on handling the current warning. { # Describes a URL link. "description": "A String", # Describes what the link offers. "url": "A String", # The URL of the link. }, ], - "warningMessage": { # Provides a localized error message that is safe to return to the user which can be attached to an RPC error. # The localized warning message. + "warningMessage": { # Provides a localized error message that is safe to return to the user which can be attached to an RPC error. # Output only. The localized warning message. "locale": "A String", # The locale used following the specification defined at https://www.rfc-editor.org/rfc/bcp/bcp47.txt. Examples are: "en-US", "fr-CH", "es-MX" "message": "A String", # The localized error message in the above locale. }, @@ -807,8 +807,8 @@

Method Details

"network": "A String", # The network to connect the VM to. "networkInterfaces": [ # List of NICs connected to this VM. { # NetworkInterface represents a NIC of a VM. - "externalIp": "A String", # The external IP to define in the NIC. - "internalIp": "A String", # The internal IP to define in the NIC. The formats accepted are: `ephemeral` \ ipv4 address \ a named address resource full path. + "externalIp": "A String", # Optional. The external IP to define in the NIC. + "internalIp": "A String", # Optional. The internal IP to define in the NIC. The formats accepted are: `ephemeral` \ ipv4 address \ a named address resource full path. "network": "A String", # The network to connect the NIC to. "subnetwork": "A String", # The subnetwork to connect the NIC to. }, @@ -900,8 +900,8 @@

Method Details

}, "networkInterfaces": [ # List of NICs connected to this VM. { # NetworkInterface represents a NIC of a VM. - "externalIp": "A String", # The external IP to define in the NIC. - "internalIp": "A String", # The internal IP to define in the NIC. The formats accepted are: `ephemeral` \ ipv4 address \ a named address resource full path. + "externalIp": "A String", # Optional. The external IP to define in the NIC. + "internalIp": "A String", # Optional. The internal IP to define in the NIC. The formats accepted are: `ephemeral` \ ipv4 address \ a named address resource full path. "network": "A String", # The network to connect the NIC to. "subnetwork": "A String", # The subnetwork to connect the NIC to. }, @@ -952,8 +952,8 @@

Method Details

"network": "A String", # The network to connect the VM to. "networkInterfaces": [ # List of NICs connected to this VM. { # NetworkInterface represents a NIC of a VM. - "externalIp": "A String", # The external IP to define in the NIC. - "internalIp": "A String", # The internal IP to define in the NIC. The formats accepted are: `ephemeral` \ ipv4 address \ a named address resource full path. + "externalIp": "A String", # Optional. The external IP to define in the NIC. + "internalIp": "A String", # Optional. The internal IP to define in the NIC. The formats accepted are: `ephemeral` \ ipv4 address \ a named address resource full path. "network": "A String", # The network to connect the NIC to. "subnetwork": "A String", # The subnetwork to connect the NIC to. }, @@ -991,7 +991,7 @@

Method Details

"finalSync": { # ReplicationCycle contains information about the current replication cycle status. # Final sync step. "cycleNumber": 42, # The cycle's ordinal number. "endTime": "A String", # The time the replication cycle has ended. - "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). # Provides details on the state of the cycle in case of an error. + "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). # Output only. Provides details on the state of the cycle in case of an error. "code": 42, # The status code, which should be an enum value of google.rpc.Code. "details": [ # A list of messages that carry the error details. There is a common set of message types for APIs to use. { @@ -1024,18 +1024,18 @@

Method Details

"totalPauseDuration": "A String", # The accumulated duration the replication cycle was paused. "warnings": [ # Output only. Warnings that occurred during the cycle. { # Represents migration resource warning information that can be used with google.rpc.Status message. MigrationWarning is used to present the user with warning information in migration operations. - "actionItem": { # Provides a localized error message that is safe to return to the user which can be attached to an RPC error. # Suggested action for solving the warning. + "actionItem": { # Provides a localized error message that is safe to return to the user which can be attached to an RPC error. # Output only. Suggested action for solving the warning. "locale": "A String", # The locale used following the specification defined at https://www.rfc-editor.org/rfc/bcp/bcp47.txt. Examples are: "en-US", "fr-CH", "es-MX" "message": "A String", # The localized error message in the above locale. }, "code": "A String", # The warning code. - "helpLinks": [ # URL(s) pointing to additional information on handling the current warning. + "helpLinks": [ # Output only. URL(s) pointing to additional information on handling the current warning. { # Describes a URL link. "description": "A String", # Describes what the link offers. "url": "A String", # The URL of the link. }, ], - "warningMessage": { # Provides a localized error message that is safe to return to the user which can be attached to an RPC error. # The localized warning message. + "warningMessage": { # Provides a localized error message that is safe to return to the user which can be attached to an RPC error. # Output only. The localized warning message. "locale": "A String", # The locale used following the specification defined at https://www.rfc-editor.org/rfc/bcp/bcp47.txt. Examples are: "en-US", "fr-CH", "es-MX" "message": "A String", # The localized error message in the above locale. }, @@ -1050,7 +1050,7 @@

Method Details

"previousReplicationCycle": { # ReplicationCycle contains information about the current replication cycle status. # A replication cycle prior cutover step. "cycleNumber": 42, # The cycle's ordinal number. "endTime": "A String", # The time the replication cycle has ended. - "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). # Provides details on the state of the cycle in case of an error. + "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). # Output only. Provides details on the state of the cycle in case of an error. "code": 42, # The status code, which should be an enum value of google.rpc.Code. "details": [ # A list of messages that carry the error details. There is a common set of message types for APIs to use. { @@ -1083,18 +1083,18 @@

Method Details

"totalPauseDuration": "A String", # The accumulated duration the replication cycle was paused. "warnings": [ # Output only. Warnings that occurred during the cycle. { # Represents migration resource warning information that can be used with google.rpc.Status message. MigrationWarning is used to present the user with warning information in migration operations. - "actionItem": { # Provides a localized error message that is safe to return to the user which can be attached to an RPC error. # Suggested action for solving the warning. + "actionItem": { # Provides a localized error message that is safe to return to the user which can be attached to an RPC error. # Output only. Suggested action for solving the warning. "locale": "A String", # The locale used following the specification defined at https://www.rfc-editor.org/rfc/bcp/bcp47.txt. Examples are: "en-US", "fr-CH", "es-MX" "message": "A String", # The localized error message in the above locale. }, "code": "A String", # The warning code. - "helpLinks": [ # URL(s) pointing to additional information on handling the current warning. + "helpLinks": [ # Output only. URL(s) pointing to additional information on handling the current warning. { # Describes a URL link. "description": "A String", # Describes what the link offers. "url": "A String", # The URL of the link. }, ], - "warningMessage": { # Provides a localized error message that is safe to return to the user which can be attached to an RPC error. # The localized warning message. + "warningMessage": { # Provides a localized error message that is safe to return to the user which can be attached to an RPC error. # Output only. The localized warning message. "locale": "A String", # The locale used following the specification defined at https://www.rfc-editor.org/rfc/bcp/bcp47.txt. Examples are: "en-US", "fr-CH", "es-MX" "message": "A String", # The localized error message in the above locale. }, @@ -1144,8 +1144,8 @@

Method Details

"network": "A String", # The network to connect the VM to. "networkInterfaces": [ # List of NICs connected to this VM. { # NetworkInterface represents a NIC of a VM. - "externalIp": "A String", # The external IP to define in the NIC. - "internalIp": "A String", # The internal IP to define in the NIC. The formats accepted are: `ephemeral` \ ipv4 address \ a named address resource full path. + "externalIp": "A String", # Optional. The external IP to define in the NIC. + "internalIp": "A String", # Optional. The internal IP to define in the NIC. The formats accepted are: `ephemeral` \ ipv4 address \ a named address resource full path. "network": "A String", # The network to connect the NIC to. "subnetwork": "A String", # The subnetwork to connect the NIC to. }, diff --git a/docs/dyn/vmmigration_v1alpha1.projects.locations.sources.migratingVms.html b/docs/dyn/vmmigration_v1alpha1.projects.locations.sources.migratingVms.html index af7ef2adea2..2a784b7c618 100644 --- a/docs/dyn/vmmigration_v1alpha1.projects.locations.sources.migratingVms.html +++ b/docs/dyn/vmmigration_v1alpha1.projects.locations.sources.migratingVms.html @@ -139,15 +139,15 @@

Method Details

{ # MigratingVm describes the VM that will be migrated from a Source environment and its replication state. "awsSourceVmDetails": { # Represent the source AWS VM details. # Output only. Details of the VM from an AWS source. - "committedStorageBytes": "A String", # The total size of the disks being migrated in bytes. - "disks": [ # The disks attached to the source VM. + "committedStorageBytes": "A String", # Output only. The total size of the disks being migrated in bytes. + "disks": [ # Output only. The disks attached to the source VM. { # The details of an AWS instance disk. - "diskNumber": 42, # The ordinal number of the disk. - "sizeGb": "A String", # Size in GB. - "volumeId": "A String", # AWS volume ID. + "diskNumber": 42, # Output only. The ordinal number of the disk. + "sizeGb": "A String", # Output only. Size in GB. + "volumeId": "A String", # Output only. AWS volume ID. }, ], - "firmware": "A String", # The firmware type of the source VM. + "firmware": "A String", # Output only. The firmware type of the source VM. "vmCapabilitiesInfo": { # Migrating VM source information about the VM capabilities needed for some Compute Engine features. # Output only. Information about VM capabilities needed for some Compute Engine features. "lastOsCapabilitiesUpdateTime": "A String", # Output only. The last time OS capabilities list was updated. "osCapabilities": [ # Output only. Unordered list. List of certain VM OS capabilities needed for some Compute Engine features. @@ -156,15 +156,15 @@

Method Details

}, }, "azureSourceVmDetails": { # Represent the source Azure VM details. # Output only. Details of the VM from an Azure source. - "committedStorageBytes": "A String", # The total size of the disks being migrated in bytes. - "disks": [ # The disks attached to the source VM. + "committedStorageBytes": "A String", # Output only. The total size of the disks being migrated in bytes. + "disks": [ # Output only. The disks attached to the source VM. { # The details of an Azure VM disk. - "diskId": "A String", # Azure disk ID. - "diskNumber": 42, # The ordinal number of the disk. - "sizeGb": "A String", # Size in GB. + "diskId": "A String", # Output only. Azure disk ID. + "diskNumber": 42, # Output only. The ordinal number of the disk. + "sizeGb": "A String", # Output only. Size in GB. }, ], - "firmware": "A String", # The firmware type of the source VM. + "firmware": "A String", # Output only. The firmware type of the source VM. "vmCapabilitiesInfo": { # Migrating VM source information about the VM capabilities needed for some Compute Engine features. # Output only. Information about VM capabilities needed for some Compute Engine features. "lastOsCapabilitiesUpdateTime": "A String", # Output only. The last time OS capabilities list was updated. "osCapabilities": [ # Output only. Unordered list. List of certain VM OS capabilities needed for some Compute Engine features. @@ -236,8 +236,8 @@

Method Details

}, "networkInterfaces": [ # Optional. NICs to attach to the VM. { # NetworkInterface represents a NIC of a VM. - "externalIp": "A String", # The external IP to define in the NIC. - "internalIp": "A String", # The internal IP to define in the NIC. The formats accepted are: `ephemeral` \ ipv4 address \ a named address resource full path. + "externalIp": "A String", # Optional. The external IP to define in the NIC. + "internalIp": "A String", # Optional. The internal IP to define in the NIC. The formats accepted are: `ephemeral` \ ipv4 address \ a named address resource full path. "network": "A String", # The network to connect the NIC to. "subnetwork": "A String", # The subnetwork to connect the NIC to. }, @@ -291,8 +291,8 @@

Method Details

}, "networkInterfaces": [ # List of NICs connected to this VM. { # NetworkInterface represents a NIC of a VM. - "externalIp": "A String", # The external IP to define in the NIC. - "internalIp": "A String", # The internal IP to define in the NIC. The formats accepted are: `ephemeral` \ ipv4 address \ a named address resource full path. + "externalIp": "A String", # Optional. The external IP to define in the NIC. + "internalIp": "A String", # Optional. The internal IP to define in the NIC. The formats accepted are: `ephemeral` \ ipv4 address \ a named address resource full path. "network": "A String", # The network to connect the NIC to. "subnetwork": "A String", # The subnetwork to connect the NIC to. }, @@ -343,8 +343,8 @@

Method Details

"network": "A String", # The network to connect the VM to. "networkInterfaces": [ # List of NICs connected to this VM. { # NetworkInterface represents a NIC of a VM. - "externalIp": "A String", # The external IP to define in the NIC. - "internalIp": "A String", # The internal IP to define in the NIC. The formats accepted are: `ephemeral` \ ipv4 address \ a named address resource full path. + "externalIp": "A String", # Optional. The external IP to define in the NIC. + "internalIp": "A String", # Optional. The internal IP to define in the NIC. The formats accepted are: `ephemeral` \ ipv4 address \ a named address resource full path. "network": "A String", # The network to connect the NIC to. "subnetwork": "A String", # The subnetwork to connect the NIC to. }, @@ -363,7 +363,7 @@

Method Details

"currentSyncInfo": { # ReplicationCycle contains information about the current replication cycle status. # Output only. Details of the current running replication cycle. "cycleNumber": 42, # The cycle's ordinal number. "endTime": "A String", # The time the replication cycle has ended. - "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). # Provides details on the state of the cycle in case of an error. + "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). # Output only. Provides details on the state of the cycle in case of an error. "code": 42, # The status code, which should be an enum value of google.rpc.Code. "details": [ # A list of messages that carry the error details. There is a common set of message types for APIs to use. { @@ -396,18 +396,18 @@

Method Details

"totalPauseDuration": "A String", # The accumulated duration the replication cycle was paused. "warnings": [ # Output only. Warnings that occurred during the cycle. { # Represents migration resource warning information that can be used with google.rpc.Status message. MigrationWarning is used to present the user with warning information in migration operations. - "actionItem": { # Provides a localized error message that is safe to return to the user which can be attached to an RPC error. # Suggested action for solving the warning. + "actionItem": { # Provides a localized error message that is safe to return to the user which can be attached to an RPC error. # Output only. Suggested action for solving the warning. "locale": "A String", # The locale used following the specification defined at https://www.rfc-editor.org/rfc/bcp/bcp47.txt. Examples are: "en-US", "fr-CH", "es-MX" "message": "A String", # The localized error message in the above locale. }, "code": "A String", # The warning code. - "helpLinks": [ # URL(s) pointing to additional information on handling the current warning. + "helpLinks": [ # Output only. URL(s) pointing to additional information on handling the current warning. { # Describes a URL link. "description": "A String", # Describes what the link offers. "url": "A String", # The URL of the link. }, ], - "warningMessage": { # Provides a localized error message that is safe to return to the user which can be attached to an RPC error. # The localized warning message. + "warningMessage": { # Provides a localized error message that is safe to return to the user which can be attached to an RPC error. # Output only. The localized warning message. "locale": "A String", # The locale used following the specification defined at https://www.rfc-editor.org/rfc/bcp/bcp47.txt. Examples are: "en-US", "fr-CH", "es-MX" "message": "A String", # The localized error message in the above locale. }, @@ -436,7 +436,7 @@

Method Details

"lastReplicationCycle": { # ReplicationCycle contains information about the current replication cycle status. # Output only. Details of the last replication cycle. This will be updated whenever a replication cycle is finished and is not to be confused with last_sync which is only updated on successful replication cycles. "cycleNumber": 42, # The cycle's ordinal number. "endTime": "A String", # The time the replication cycle has ended. - "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). # Provides details on the state of the cycle in case of an error. + "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). # Output only. Provides details on the state of the cycle in case of an error. "code": 42, # The status code, which should be an enum value of google.rpc.Code. "details": [ # A list of messages that carry the error details. There is a common set of message types for APIs to use. { @@ -469,18 +469,18 @@

Method Details

"totalPauseDuration": "A String", # The accumulated duration the replication cycle was paused. "warnings": [ # Output only. Warnings that occurred during the cycle. { # Represents migration resource warning information that can be used with google.rpc.Status message. MigrationWarning is used to present the user with warning information in migration operations. - "actionItem": { # Provides a localized error message that is safe to return to the user which can be attached to an RPC error. # Suggested action for solving the warning. + "actionItem": { # Provides a localized error message that is safe to return to the user which can be attached to an RPC error. # Output only. Suggested action for solving the warning. "locale": "A String", # The locale used following the specification defined at https://www.rfc-editor.org/rfc/bcp/bcp47.txt. Examples are: "en-US", "fr-CH", "es-MX" "message": "A String", # The localized error message in the above locale. }, "code": "A String", # The warning code. - "helpLinks": [ # URL(s) pointing to additional information on handling the current warning. + "helpLinks": [ # Output only. URL(s) pointing to additional information on handling the current warning. { # Describes a URL link. "description": "A String", # Describes what the link offers. "url": "A String", # The URL of the link. }, ], - "warningMessage": { # Provides a localized error message that is safe to return to the user which can be attached to an RPC error. # The localized warning message. + "warningMessage": { # Provides a localized error message that is safe to return to the user which can be attached to an RPC error. # Output only. The localized warning message. "locale": "A String", # The locale used following the specification defined at https://www.rfc-editor.org/rfc/bcp/bcp47.txt. Examples are: "en-US", "fr-CH", "es-MX" "message": "A String", # The localized error message in the above locale. }, @@ -551,8 +551,8 @@

Method Details

}, "networkInterfaces": [ # List of NICs connected to this VM. { # NetworkInterface represents a NIC of a VM. - "externalIp": "A String", # The external IP to define in the NIC. - "internalIp": "A String", # The internal IP to define in the NIC. The formats accepted are: `ephemeral` \ ipv4 address \ a named address resource full path. + "externalIp": "A String", # Optional. The external IP to define in the NIC. + "internalIp": "A String", # Optional. The internal IP to define in the NIC. The formats accepted are: `ephemeral` \ ipv4 address \ a named address resource full path. "network": "A String", # The network to connect the NIC to. "subnetwork": "A String", # The subnetwork to connect the NIC to. }, @@ -603,8 +603,8 @@

Method Details

"network": "A String", # The network to connect the VM to. "networkInterfaces": [ # List of NICs connected to this VM. { # NetworkInterface represents a NIC of a VM. - "externalIp": "A String", # The external IP to define in the NIC. - "internalIp": "A String", # The internal IP to define in the NIC. The formats accepted are: `ephemeral` \ ipv4 address \ a named address resource full path. + "externalIp": "A String", # Optional. The external IP to define in the NIC. + "internalIp": "A String", # Optional. The internal IP to define in the NIC. The formats accepted are: `ephemeral` \ ipv4 address \ a named address resource full path. "network": "A String", # The network to connect the NIC to. "subnetwork": "A String", # The subnetwork to connect the NIC to. }, @@ -682,8 +682,8 @@

Method Details

"network": "A String", # The network to connect the VM to. "networkInterfaces": [ # List of NICs connected to this VM. { # NetworkInterface represents a NIC of a VM. - "externalIp": "A String", # The external IP to define in the NIC. - "internalIp": "A String", # The internal IP to define in the NIC. The formats accepted are: `ephemeral` \ ipv4 address \ a named address resource full path. + "externalIp": "A String", # Optional. The external IP to define in the NIC. + "internalIp": "A String", # Optional. The internal IP to define in the NIC. The formats accepted are: `ephemeral` \ ipv4 address \ a named address resource full path. "network": "A String", # The network to connect the NIC to. "subnetwork": "A String", # The subnetwork to connect the NIC to. }, @@ -755,8 +755,8 @@

Method Details

}, "networkInterfaces": [ # List of NICs connected to this VM. { # NetworkInterface represents a NIC of a VM. - "externalIp": "A String", # The external IP to define in the NIC. - "internalIp": "A String", # The internal IP to define in the NIC. The formats accepted are: `ephemeral` \ ipv4 address \ a named address resource full path. + "externalIp": "A String", # Optional. The external IP to define in the NIC. + "internalIp": "A String", # Optional. The internal IP to define in the NIC. The formats accepted are: `ephemeral` \ ipv4 address \ a named address resource full path. "network": "A String", # The network to connect the NIC to. "subnetwork": "A String", # The subnetwork to connect the NIC to. }, @@ -807,8 +807,8 @@

Method Details

"network": "A String", # The network to connect the VM to. "networkInterfaces": [ # List of NICs connected to this VM. { # NetworkInterface represents a NIC of a VM. - "externalIp": "A String", # The external IP to define in the NIC. - "internalIp": "A String", # The internal IP to define in the NIC. The formats accepted are: `ephemeral` \ ipv4 address \ a named address resource full path. + "externalIp": "A String", # Optional. The external IP to define in the NIC. + "internalIp": "A String", # Optional. The internal IP to define in the NIC. The formats accepted are: `ephemeral` \ ipv4 address \ a named address resource full path. "network": "A String", # The network to connect the NIC to. "subnetwork": "A String", # The subnetwork to connect the NIC to. }, @@ -846,7 +846,7 @@

Method Details

"finalSync": { # ReplicationCycle contains information about the current replication cycle status. # Final sync step. "cycleNumber": 42, # The cycle's ordinal number. "endTime": "A String", # The time the replication cycle has ended. - "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). # Provides details on the state of the cycle in case of an error. + "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). # Output only. Provides details on the state of the cycle in case of an error. "code": 42, # The status code, which should be an enum value of google.rpc.Code. "details": [ # A list of messages that carry the error details. There is a common set of message types for APIs to use. { @@ -879,18 +879,18 @@

Method Details

"totalPauseDuration": "A String", # The accumulated duration the replication cycle was paused. "warnings": [ # Output only. Warnings that occurred during the cycle. { # Represents migration resource warning information that can be used with google.rpc.Status message. MigrationWarning is used to present the user with warning information in migration operations. - "actionItem": { # Provides a localized error message that is safe to return to the user which can be attached to an RPC error. # Suggested action for solving the warning. + "actionItem": { # Provides a localized error message that is safe to return to the user which can be attached to an RPC error. # Output only. Suggested action for solving the warning. "locale": "A String", # The locale used following the specification defined at https://www.rfc-editor.org/rfc/bcp/bcp47.txt. Examples are: "en-US", "fr-CH", "es-MX" "message": "A String", # The localized error message in the above locale. }, "code": "A String", # The warning code. - "helpLinks": [ # URL(s) pointing to additional information on handling the current warning. + "helpLinks": [ # Output only. URL(s) pointing to additional information on handling the current warning. { # Describes a URL link. "description": "A String", # Describes what the link offers. "url": "A String", # The URL of the link. }, ], - "warningMessage": { # Provides a localized error message that is safe to return to the user which can be attached to an RPC error. # The localized warning message. + "warningMessage": { # Provides a localized error message that is safe to return to the user which can be attached to an RPC error. # Output only. The localized warning message. "locale": "A String", # The locale used following the specification defined at https://www.rfc-editor.org/rfc/bcp/bcp47.txt. Examples are: "en-US", "fr-CH", "es-MX" "message": "A String", # The localized error message in the above locale. }, @@ -905,7 +905,7 @@

Method Details

"previousReplicationCycle": { # ReplicationCycle contains information about the current replication cycle status. # A replication cycle prior cutover step. "cycleNumber": 42, # The cycle's ordinal number. "endTime": "A String", # The time the replication cycle has ended. - "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). # Provides details on the state of the cycle in case of an error. + "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). # Output only. Provides details on the state of the cycle in case of an error. "code": 42, # The status code, which should be an enum value of google.rpc.Code. "details": [ # A list of messages that carry the error details. There is a common set of message types for APIs to use. { @@ -938,18 +938,18 @@

Method Details

"totalPauseDuration": "A String", # The accumulated duration the replication cycle was paused. "warnings": [ # Output only. Warnings that occurred during the cycle. { # Represents migration resource warning information that can be used with google.rpc.Status message. MigrationWarning is used to present the user with warning information in migration operations. - "actionItem": { # Provides a localized error message that is safe to return to the user which can be attached to an RPC error. # Suggested action for solving the warning. + "actionItem": { # Provides a localized error message that is safe to return to the user which can be attached to an RPC error. # Output only. Suggested action for solving the warning. "locale": "A String", # The locale used following the specification defined at https://www.rfc-editor.org/rfc/bcp/bcp47.txt. Examples are: "en-US", "fr-CH", "es-MX" "message": "A String", # The localized error message in the above locale. }, "code": "A String", # The warning code. - "helpLinks": [ # URL(s) pointing to additional information on handling the current warning. + "helpLinks": [ # Output only. URL(s) pointing to additional information on handling the current warning. { # Describes a URL link. "description": "A String", # Describes what the link offers. "url": "A String", # The URL of the link. }, ], - "warningMessage": { # Provides a localized error message that is safe to return to the user which can be attached to an RPC error. # The localized warning message. + "warningMessage": { # Provides a localized error message that is safe to return to the user which can be attached to an RPC error. # Output only. The localized warning message. "locale": "A String", # The locale used following the specification defined at https://www.rfc-editor.org/rfc/bcp/bcp47.txt. Examples are: "en-US", "fr-CH", "es-MX" "message": "A String", # The localized error message in the above locale. }, @@ -999,8 +999,8 @@

Method Details

"network": "A String", # The network to connect the VM to. "networkInterfaces": [ # List of NICs connected to this VM. { # NetworkInterface represents a NIC of a VM. - "externalIp": "A String", # The external IP to define in the NIC. - "internalIp": "A String", # The internal IP to define in the NIC. The formats accepted are: `ephemeral` \ ipv4 address \ a named address resource full path. + "externalIp": "A String", # Optional. The external IP to define in the NIC. + "internalIp": "A String", # Optional. The internal IP to define in the NIC. The formats accepted are: `ephemeral` \ ipv4 address \ a named address resource full path. "network": "A String", # The network to connect the NIC to. "subnetwork": "A String", # The subnetwork to connect the NIC to. }, @@ -1057,8 +1057,8 @@

Method Details

"network": "A String", # The network to connect the VM to. "networkInterfaces": [ # List of NICs connected to this VM. { # NetworkInterface represents a NIC of a VM. - "externalIp": "A String", # The external IP to define in the NIC. - "internalIp": "A String", # The internal IP to define in the NIC. The formats accepted are: `ephemeral` \ ipv4 address \ a named address resource full path. + "externalIp": "A String", # Optional. The external IP to define in the NIC. + "internalIp": "A String", # Optional. The internal IP to define in the NIC. The formats accepted are: `ephemeral` \ ipv4 address \ a named address resource full path. "network": "A String", # The network to connect the NIC to. "subnetwork": "A String", # The subnetwork to connect the NIC to. }, @@ -1075,15 +1075,15 @@

Method Details

}, "updateTime": "A String", # Output only. The last time the migrating VM resource was updated. "vmwareSourceVmDetails": { # Represent the source Vmware VM details. # Output only. Details of the VM from a Vmware source. - "committedStorageBytes": "A String", # The total size of the disks being migrated in bytes. - "disks": [ # The disks attached to the source VM. + "committedStorageBytes": "A String", # Output only. The total size of the disks being migrated in bytes. + "disks": [ # Output only. The disks attached to the source VM. { # The details of a Vmware VM disk. - "diskNumber": 42, # The ordinal number of the disk. - "label": "A String", # The disk label. - "sizeGb": "A String", # Size in GB. + "diskNumber": 42, # Output only. The ordinal number of the disk. + "label": "A String", # Output only. The disk label. + "sizeGb": "A String", # Output only. Size in GB. }, ], - "firmware": "A String", # The firmware type of the source VM. + "firmware": "A String", # Output only. The firmware type of the source VM. "vmCapabilitiesInfo": { # Migrating VM source information about the VM capabilities needed for some Compute Engine features. # Output only. Information about VM capabilities needed for some Compute Engine features. "lastOsCapabilitiesUpdateTime": "A String", # Output only. The last time OS capabilities list was updated. "osCapabilities": [ # Output only. Unordered list. List of certain VM OS capabilities needed for some Compute Engine features. @@ -1221,15 +1221,15 @@

Method Details

{ # MigratingVm describes the VM that will be migrated from a Source environment and its replication state. "awsSourceVmDetails": { # Represent the source AWS VM details. # Output only. Details of the VM from an AWS source. - "committedStorageBytes": "A String", # The total size of the disks being migrated in bytes. - "disks": [ # The disks attached to the source VM. + "committedStorageBytes": "A String", # Output only. The total size of the disks being migrated in bytes. + "disks": [ # Output only. The disks attached to the source VM. { # The details of an AWS instance disk. - "diskNumber": 42, # The ordinal number of the disk. - "sizeGb": "A String", # Size in GB. - "volumeId": "A String", # AWS volume ID. + "diskNumber": 42, # Output only. The ordinal number of the disk. + "sizeGb": "A String", # Output only. Size in GB. + "volumeId": "A String", # Output only. AWS volume ID. }, ], - "firmware": "A String", # The firmware type of the source VM. + "firmware": "A String", # Output only. The firmware type of the source VM. "vmCapabilitiesInfo": { # Migrating VM source information about the VM capabilities needed for some Compute Engine features. # Output only. Information about VM capabilities needed for some Compute Engine features. "lastOsCapabilitiesUpdateTime": "A String", # Output only. The last time OS capabilities list was updated. "osCapabilities": [ # Output only. Unordered list. List of certain VM OS capabilities needed for some Compute Engine features. @@ -1238,15 +1238,15 @@

Method Details

}, }, "azureSourceVmDetails": { # Represent the source Azure VM details. # Output only. Details of the VM from an Azure source. - "committedStorageBytes": "A String", # The total size of the disks being migrated in bytes. - "disks": [ # The disks attached to the source VM. + "committedStorageBytes": "A String", # Output only. The total size of the disks being migrated in bytes. + "disks": [ # Output only. The disks attached to the source VM. { # The details of an Azure VM disk. - "diskId": "A String", # Azure disk ID. - "diskNumber": 42, # The ordinal number of the disk. - "sizeGb": "A String", # Size in GB. + "diskId": "A String", # Output only. Azure disk ID. + "diskNumber": 42, # Output only. The ordinal number of the disk. + "sizeGb": "A String", # Output only. Size in GB. }, ], - "firmware": "A String", # The firmware type of the source VM. + "firmware": "A String", # Output only. The firmware type of the source VM. "vmCapabilitiesInfo": { # Migrating VM source information about the VM capabilities needed for some Compute Engine features. # Output only. Information about VM capabilities needed for some Compute Engine features. "lastOsCapabilitiesUpdateTime": "A String", # Output only. The last time OS capabilities list was updated. "osCapabilities": [ # Output only. Unordered list. List of certain VM OS capabilities needed for some Compute Engine features. @@ -1318,8 +1318,8 @@

Method Details

}, "networkInterfaces": [ # Optional. NICs to attach to the VM. { # NetworkInterface represents a NIC of a VM. - "externalIp": "A String", # The external IP to define in the NIC. - "internalIp": "A String", # The internal IP to define in the NIC. The formats accepted are: `ephemeral` \ ipv4 address \ a named address resource full path. + "externalIp": "A String", # Optional. The external IP to define in the NIC. + "internalIp": "A String", # Optional. The internal IP to define in the NIC. The formats accepted are: `ephemeral` \ ipv4 address \ a named address resource full path. "network": "A String", # The network to connect the NIC to. "subnetwork": "A String", # The subnetwork to connect the NIC to. }, @@ -1373,8 +1373,8 @@

Method Details

}, "networkInterfaces": [ # List of NICs connected to this VM. { # NetworkInterface represents a NIC of a VM. - "externalIp": "A String", # The external IP to define in the NIC. - "internalIp": "A String", # The internal IP to define in the NIC. The formats accepted are: `ephemeral` \ ipv4 address \ a named address resource full path. + "externalIp": "A String", # Optional. The external IP to define in the NIC. + "internalIp": "A String", # Optional. The internal IP to define in the NIC. The formats accepted are: `ephemeral` \ ipv4 address \ a named address resource full path. "network": "A String", # The network to connect the NIC to. "subnetwork": "A String", # The subnetwork to connect the NIC to. }, @@ -1425,8 +1425,8 @@

Method Details

"network": "A String", # The network to connect the VM to. "networkInterfaces": [ # List of NICs connected to this VM. { # NetworkInterface represents a NIC of a VM. - "externalIp": "A String", # The external IP to define in the NIC. - "internalIp": "A String", # The internal IP to define in the NIC. The formats accepted are: `ephemeral` \ ipv4 address \ a named address resource full path. + "externalIp": "A String", # Optional. The external IP to define in the NIC. + "internalIp": "A String", # Optional. The internal IP to define in the NIC. The formats accepted are: `ephemeral` \ ipv4 address \ a named address resource full path. "network": "A String", # The network to connect the NIC to. "subnetwork": "A String", # The subnetwork to connect the NIC to. }, @@ -1445,7 +1445,7 @@

Method Details

"currentSyncInfo": { # ReplicationCycle contains information about the current replication cycle status. # Output only. Details of the current running replication cycle. "cycleNumber": 42, # The cycle's ordinal number. "endTime": "A String", # The time the replication cycle has ended. - "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). # Provides details on the state of the cycle in case of an error. + "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). # Output only. Provides details on the state of the cycle in case of an error. "code": 42, # The status code, which should be an enum value of google.rpc.Code. "details": [ # A list of messages that carry the error details. There is a common set of message types for APIs to use. { @@ -1478,18 +1478,18 @@

Method Details

"totalPauseDuration": "A String", # The accumulated duration the replication cycle was paused. "warnings": [ # Output only. Warnings that occurred during the cycle. { # Represents migration resource warning information that can be used with google.rpc.Status message. MigrationWarning is used to present the user with warning information in migration operations. - "actionItem": { # Provides a localized error message that is safe to return to the user which can be attached to an RPC error. # Suggested action for solving the warning. + "actionItem": { # Provides a localized error message that is safe to return to the user which can be attached to an RPC error. # Output only. Suggested action for solving the warning. "locale": "A String", # The locale used following the specification defined at https://www.rfc-editor.org/rfc/bcp/bcp47.txt. Examples are: "en-US", "fr-CH", "es-MX" "message": "A String", # The localized error message in the above locale. }, "code": "A String", # The warning code. - "helpLinks": [ # URL(s) pointing to additional information on handling the current warning. + "helpLinks": [ # Output only. URL(s) pointing to additional information on handling the current warning. { # Describes a URL link. "description": "A String", # Describes what the link offers. "url": "A String", # The URL of the link. }, ], - "warningMessage": { # Provides a localized error message that is safe to return to the user which can be attached to an RPC error. # The localized warning message. + "warningMessage": { # Provides a localized error message that is safe to return to the user which can be attached to an RPC error. # Output only. The localized warning message. "locale": "A String", # The locale used following the specification defined at https://www.rfc-editor.org/rfc/bcp/bcp47.txt. Examples are: "en-US", "fr-CH", "es-MX" "message": "A String", # The localized error message in the above locale. }, @@ -1518,7 +1518,7 @@

Method Details

"lastReplicationCycle": { # ReplicationCycle contains information about the current replication cycle status. # Output only. Details of the last replication cycle. This will be updated whenever a replication cycle is finished and is not to be confused with last_sync which is only updated on successful replication cycles. "cycleNumber": 42, # The cycle's ordinal number. "endTime": "A String", # The time the replication cycle has ended. - "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). # Provides details on the state of the cycle in case of an error. + "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). # Output only. Provides details on the state of the cycle in case of an error. "code": 42, # The status code, which should be an enum value of google.rpc.Code. "details": [ # A list of messages that carry the error details. There is a common set of message types for APIs to use. { @@ -1551,18 +1551,18 @@

Method Details

"totalPauseDuration": "A String", # The accumulated duration the replication cycle was paused. "warnings": [ # Output only. Warnings that occurred during the cycle. { # Represents migration resource warning information that can be used with google.rpc.Status message. MigrationWarning is used to present the user with warning information in migration operations. - "actionItem": { # Provides a localized error message that is safe to return to the user which can be attached to an RPC error. # Suggested action for solving the warning. + "actionItem": { # Provides a localized error message that is safe to return to the user which can be attached to an RPC error. # Output only. Suggested action for solving the warning. "locale": "A String", # The locale used following the specification defined at https://www.rfc-editor.org/rfc/bcp/bcp47.txt. Examples are: "en-US", "fr-CH", "es-MX" "message": "A String", # The localized error message in the above locale. }, "code": "A String", # The warning code. - "helpLinks": [ # URL(s) pointing to additional information on handling the current warning. + "helpLinks": [ # Output only. URL(s) pointing to additional information on handling the current warning. { # Describes a URL link. "description": "A String", # Describes what the link offers. "url": "A String", # The URL of the link. }, ], - "warningMessage": { # Provides a localized error message that is safe to return to the user which can be attached to an RPC error. # The localized warning message. + "warningMessage": { # Provides a localized error message that is safe to return to the user which can be attached to an RPC error. # Output only. The localized warning message. "locale": "A String", # The locale used following the specification defined at https://www.rfc-editor.org/rfc/bcp/bcp47.txt. Examples are: "en-US", "fr-CH", "es-MX" "message": "A String", # The localized error message in the above locale. }, @@ -1633,8 +1633,8 @@

Method Details

}, "networkInterfaces": [ # List of NICs connected to this VM. { # NetworkInterface represents a NIC of a VM. - "externalIp": "A String", # The external IP to define in the NIC. - "internalIp": "A String", # The internal IP to define in the NIC. The formats accepted are: `ephemeral` \ ipv4 address \ a named address resource full path. + "externalIp": "A String", # Optional. The external IP to define in the NIC. + "internalIp": "A String", # Optional. The internal IP to define in the NIC. The formats accepted are: `ephemeral` \ ipv4 address \ a named address resource full path. "network": "A String", # The network to connect the NIC to. "subnetwork": "A String", # The subnetwork to connect the NIC to. }, @@ -1685,8 +1685,8 @@

Method Details

"network": "A String", # The network to connect the VM to. "networkInterfaces": [ # List of NICs connected to this VM. { # NetworkInterface represents a NIC of a VM. - "externalIp": "A String", # The external IP to define in the NIC. - "internalIp": "A String", # The internal IP to define in the NIC. The formats accepted are: `ephemeral` \ ipv4 address \ a named address resource full path. + "externalIp": "A String", # Optional. The external IP to define in the NIC. + "internalIp": "A String", # Optional. The internal IP to define in the NIC. The formats accepted are: `ephemeral` \ ipv4 address \ a named address resource full path. "network": "A String", # The network to connect the NIC to. "subnetwork": "A String", # The subnetwork to connect the NIC to. }, @@ -1764,8 +1764,8 @@

Method Details

"network": "A String", # The network to connect the VM to. "networkInterfaces": [ # List of NICs connected to this VM. { # NetworkInterface represents a NIC of a VM. - "externalIp": "A String", # The external IP to define in the NIC. - "internalIp": "A String", # The internal IP to define in the NIC. The formats accepted are: `ephemeral` \ ipv4 address \ a named address resource full path. + "externalIp": "A String", # Optional. The external IP to define in the NIC. + "internalIp": "A String", # Optional. The internal IP to define in the NIC. The formats accepted are: `ephemeral` \ ipv4 address \ a named address resource full path. "network": "A String", # The network to connect the NIC to. "subnetwork": "A String", # The subnetwork to connect the NIC to. }, @@ -1837,8 +1837,8 @@

Method Details

}, "networkInterfaces": [ # List of NICs connected to this VM. { # NetworkInterface represents a NIC of a VM. - "externalIp": "A String", # The external IP to define in the NIC. - "internalIp": "A String", # The internal IP to define in the NIC. The formats accepted are: `ephemeral` \ ipv4 address \ a named address resource full path. + "externalIp": "A String", # Optional. The external IP to define in the NIC. + "internalIp": "A String", # Optional. The internal IP to define in the NIC. The formats accepted are: `ephemeral` \ ipv4 address \ a named address resource full path. "network": "A String", # The network to connect the NIC to. "subnetwork": "A String", # The subnetwork to connect the NIC to. }, @@ -1889,8 +1889,8 @@

Method Details

"network": "A String", # The network to connect the VM to. "networkInterfaces": [ # List of NICs connected to this VM. { # NetworkInterface represents a NIC of a VM. - "externalIp": "A String", # The external IP to define in the NIC. - "internalIp": "A String", # The internal IP to define in the NIC. The formats accepted are: `ephemeral` \ ipv4 address \ a named address resource full path. + "externalIp": "A String", # Optional. The external IP to define in the NIC. + "internalIp": "A String", # Optional. The internal IP to define in the NIC. The formats accepted are: `ephemeral` \ ipv4 address \ a named address resource full path. "network": "A String", # The network to connect the NIC to. "subnetwork": "A String", # The subnetwork to connect the NIC to. }, @@ -1928,7 +1928,7 @@

Method Details

"finalSync": { # ReplicationCycle contains information about the current replication cycle status. # Final sync step. "cycleNumber": 42, # The cycle's ordinal number. "endTime": "A String", # The time the replication cycle has ended. - "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). # Provides details on the state of the cycle in case of an error. + "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). # Output only. Provides details on the state of the cycle in case of an error. "code": 42, # The status code, which should be an enum value of google.rpc.Code. "details": [ # A list of messages that carry the error details. There is a common set of message types for APIs to use. { @@ -1961,18 +1961,18 @@

Method Details

"totalPauseDuration": "A String", # The accumulated duration the replication cycle was paused. "warnings": [ # Output only. Warnings that occurred during the cycle. { # Represents migration resource warning information that can be used with google.rpc.Status message. MigrationWarning is used to present the user with warning information in migration operations. - "actionItem": { # Provides a localized error message that is safe to return to the user which can be attached to an RPC error. # Suggested action for solving the warning. + "actionItem": { # Provides a localized error message that is safe to return to the user which can be attached to an RPC error. # Output only. Suggested action for solving the warning. "locale": "A String", # The locale used following the specification defined at https://www.rfc-editor.org/rfc/bcp/bcp47.txt. Examples are: "en-US", "fr-CH", "es-MX" "message": "A String", # The localized error message in the above locale. }, "code": "A String", # The warning code. - "helpLinks": [ # URL(s) pointing to additional information on handling the current warning. + "helpLinks": [ # Output only. URL(s) pointing to additional information on handling the current warning. { # Describes a URL link. "description": "A String", # Describes what the link offers. "url": "A String", # The URL of the link. }, ], - "warningMessage": { # Provides a localized error message that is safe to return to the user which can be attached to an RPC error. # The localized warning message. + "warningMessage": { # Provides a localized error message that is safe to return to the user which can be attached to an RPC error. # Output only. The localized warning message. "locale": "A String", # The locale used following the specification defined at https://www.rfc-editor.org/rfc/bcp/bcp47.txt. Examples are: "en-US", "fr-CH", "es-MX" "message": "A String", # The localized error message in the above locale. }, @@ -1987,7 +1987,7 @@

Method Details

"previousReplicationCycle": { # ReplicationCycle contains information about the current replication cycle status. # A replication cycle prior cutover step. "cycleNumber": 42, # The cycle's ordinal number. "endTime": "A String", # The time the replication cycle has ended. - "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). # Provides details on the state of the cycle in case of an error. + "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). # Output only. Provides details on the state of the cycle in case of an error. "code": 42, # The status code, which should be an enum value of google.rpc.Code. "details": [ # A list of messages that carry the error details. There is a common set of message types for APIs to use. { @@ -2020,18 +2020,18 @@

Method Details

"totalPauseDuration": "A String", # The accumulated duration the replication cycle was paused. "warnings": [ # Output only. Warnings that occurred during the cycle. { # Represents migration resource warning information that can be used with google.rpc.Status message. MigrationWarning is used to present the user with warning information in migration operations. - "actionItem": { # Provides a localized error message that is safe to return to the user which can be attached to an RPC error. # Suggested action for solving the warning. + "actionItem": { # Provides a localized error message that is safe to return to the user which can be attached to an RPC error. # Output only. Suggested action for solving the warning. "locale": "A String", # The locale used following the specification defined at https://www.rfc-editor.org/rfc/bcp/bcp47.txt. Examples are: "en-US", "fr-CH", "es-MX" "message": "A String", # The localized error message in the above locale. }, "code": "A String", # The warning code. - "helpLinks": [ # URL(s) pointing to additional information on handling the current warning. + "helpLinks": [ # Output only. URL(s) pointing to additional information on handling the current warning. { # Describes a URL link. "description": "A String", # Describes what the link offers. "url": "A String", # The URL of the link. }, ], - "warningMessage": { # Provides a localized error message that is safe to return to the user which can be attached to an RPC error. # The localized warning message. + "warningMessage": { # Provides a localized error message that is safe to return to the user which can be attached to an RPC error. # Output only. The localized warning message. "locale": "A String", # The locale used following the specification defined at https://www.rfc-editor.org/rfc/bcp/bcp47.txt. Examples are: "en-US", "fr-CH", "es-MX" "message": "A String", # The localized error message in the above locale. }, @@ -2081,8 +2081,8 @@

Method Details

"network": "A String", # The network to connect the VM to. "networkInterfaces": [ # List of NICs connected to this VM. { # NetworkInterface represents a NIC of a VM. - "externalIp": "A String", # The external IP to define in the NIC. - "internalIp": "A String", # The internal IP to define in the NIC. The formats accepted are: `ephemeral` \ ipv4 address \ a named address resource full path. + "externalIp": "A String", # Optional. The external IP to define in the NIC. + "internalIp": "A String", # Optional. The internal IP to define in the NIC. The formats accepted are: `ephemeral` \ ipv4 address \ a named address resource full path. "network": "A String", # The network to connect the NIC to. "subnetwork": "A String", # The subnetwork to connect the NIC to. }, @@ -2139,8 +2139,8 @@

Method Details

"network": "A String", # The network to connect the VM to. "networkInterfaces": [ # List of NICs connected to this VM. { # NetworkInterface represents a NIC of a VM. - "externalIp": "A String", # The external IP to define in the NIC. - "internalIp": "A String", # The internal IP to define in the NIC. The formats accepted are: `ephemeral` \ ipv4 address \ a named address resource full path. + "externalIp": "A String", # Optional. The external IP to define in the NIC. + "internalIp": "A String", # Optional. The internal IP to define in the NIC. The formats accepted are: `ephemeral` \ ipv4 address \ a named address resource full path. "network": "A String", # The network to connect the NIC to. "subnetwork": "A String", # The subnetwork to connect the NIC to. }, @@ -2157,15 +2157,15 @@

Method Details

}, "updateTime": "A String", # Output only. The last time the migrating VM resource was updated. "vmwareSourceVmDetails": { # Represent the source Vmware VM details. # Output only. Details of the VM from a Vmware source. - "committedStorageBytes": "A String", # The total size of the disks being migrated in bytes. - "disks": [ # The disks attached to the source VM. + "committedStorageBytes": "A String", # Output only. The total size of the disks being migrated in bytes. + "disks": [ # Output only. The disks attached to the source VM. { # The details of a Vmware VM disk. - "diskNumber": 42, # The ordinal number of the disk. - "label": "A String", # The disk label. - "sizeGb": "A String", # Size in GB. + "diskNumber": 42, # Output only. The ordinal number of the disk. + "label": "A String", # Output only. The disk label. + "sizeGb": "A String", # Output only. Size in GB. }, ], - "firmware": "A String", # The firmware type of the source VM. + "firmware": "A String", # Output only. The firmware type of the source VM. "vmCapabilitiesInfo": { # Migrating VM source information about the VM capabilities needed for some Compute Engine features. # Output only. Information about VM capabilities needed for some Compute Engine features. "lastOsCapabilitiesUpdateTime": "A String", # Output only. The last time OS capabilities list was updated. "osCapabilities": [ # Output only. Unordered list. List of certain VM OS capabilities needed for some Compute Engine features. @@ -2203,15 +2203,15 @@

Method Details

"migratingVms": [ # Output only. The list of Migrating VMs response. { # MigratingVm describes the VM that will be migrated from a Source environment and its replication state. "awsSourceVmDetails": { # Represent the source AWS VM details. # Output only. Details of the VM from an AWS source. - "committedStorageBytes": "A String", # The total size of the disks being migrated in bytes. - "disks": [ # The disks attached to the source VM. + "committedStorageBytes": "A String", # Output only. The total size of the disks being migrated in bytes. + "disks": [ # Output only. The disks attached to the source VM. { # The details of an AWS instance disk. - "diskNumber": 42, # The ordinal number of the disk. - "sizeGb": "A String", # Size in GB. - "volumeId": "A String", # AWS volume ID. + "diskNumber": 42, # Output only. The ordinal number of the disk. + "sizeGb": "A String", # Output only. Size in GB. + "volumeId": "A String", # Output only. AWS volume ID. }, ], - "firmware": "A String", # The firmware type of the source VM. + "firmware": "A String", # Output only. The firmware type of the source VM. "vmCapabilitiesInfo": { # Migrating VM source information about the VM capabilities needed for some Compute Engine features. # Output only. Information about VM capabilities needed for some Compute Engine features. "lastOsCapabilitiesUpdateTime": "A String", # Output only. The last time OS capabilities list was updated. "osCapabilities": [ # Output only. Unordered list. List of certain VM OS capabilities needed for some Compute Engine features. @@ -2220,15 +2220,15 @@

Method Details

}, }, "azureSourceVmDetails": { # Represent the source Azure VM details. # Output only. Details of the VM from an Azure source. - "committedStorageBytes": "A String", # The total size of the disks being migrated in bytes. - "disks": [ # The disks attached to the source VM. + "committedStorageBytes": "A String", # Output only. The total size of the disks being migrated in bytes. + "disks": [ # Output only. The disks attached to the source VM. { # The details of an Azure VM disk. - "diskId": "A String", # Azure disk ID. - "diskNumber": 42, # The ordinal number of the disk. - "sizeGb": "A String", # Size in GB. + "diskId": "A String", # Output only. Azure disk ID. + "diskNumber": 42, # Output only. The ordinal number of the disk. + "sizeGb": "A String", # Output only. Size in GB. }, ], - "firmware": "A String", # The firmware type of the source VM. + "firmware": "A String", # Output only. The firmware type of the source VM. "vmCapabilitiesInfo": { # Migrating VM source information about the VM capabilities needed for some Compute Engine features. # Output only. Information about VM capabilities needed for some Compute Engine features. "lastOsCapabilitiesUpdateTime": "A String", # Output only. The last time OS capabilities list was updated. "osCapabilities": [ # Output only. Unordered list. List of certain VM OS capabilities needed for some Compute Engine features. @@ -2300,8 +2300,8 @@

Method Details

}, "networkInterfaces": [ # Optional. NICs to attach to the VM. { # NetworkInterface represents a NIC of a VM. - "externalIp": "A String", # The external IP to define in the NIC. - "internalIp": "A String", # The internal IP to define in the NIC. The formats accepted are: `ephemeral` \ ipv4 address \ a named address resource full path. + "externalIp": "A String", # Optional. The external IP to define in the NIC. + "internalIp": "A String", # Optional. The internal IP to define in the NIC. The formats accepted are: `ephemeral` \ ipv4 address \ a named address resource full path. "network": "A String", # The network to connect the NIC to. "subnetwork": "A String", # The subnetwork to connect the NIC to. }, @@ -2355,8 +2355,8 @@

Method Details

}, "networkInterfaces": [ # List of NICs connected to this VM. { # NetworkInterface represents a NIC of a VM. - "externalIp": "A String", # The external IP to define in the NIC. - "internalIp": "A String", # The internal IP to define in the NIC. The formats accepted are: `ephemeral` \ ipv4 address \ a named address resource full path. + "externalIp": "A String", # Optional. The external IP to define in the NIC. + "internalIp": "A String", # Optional. The internal IP to define in the NIC. The formats accepted are: `ephemeral` \ ipv4 address \ a named address resource full path. "network": "A String", # The network to connect the NIC to. "subnetwork": "A String", # The subnetwork to connect the NIC to. }, @@ -2407,8 +2407,8 @@

Method Details

"network": "A String", # The network to connect the VM to. "networkInterfaces": [ # List of NICs connected to this VM. { # NetworkInterface represents a NIC of a VM. - "externalIp": "A String", # The external IP to define in the NIC. - "internalIp": "A String", # The internal IP to define in the NIC. The formats accepted are: `ephemeral` \ ipv4 address \ a named address resource full path. + "externalIp": "A String", # Optional. The external IP to define in the NIC. + "internalIp": "A String", # Optional. The internal IP to define in the NIC. The formats accepted are: `ephemeral` \ ipv4 address \ a named address resource full path. "network": "A String", # The network to connect the NIC to. "subnetwork": "A String", # The subnetwork to connect the NIC to. }, @@ -2427,7 +2427,7 @@

Method Details

"currentSyncInfo": { # ReplicationCycle contains information about the current replication cycle status. # Output only. Details of the current running replication cycle. "cycleNumber": 42, # The cycle's ordinal number. "endTime": "A String", # The time the replication cycle has ended. - "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). # Provides details on the state of the cycle in case of an error. + "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). # Output only. Provides details on the state of the cycle in case of an error. "code": 42, # The status code, which should be an enum value of google.rpc.Code. "details": [ # A list of messages that carry the error details. There is a common set of message types for APIs to use. { @@ -2460,18 +2460,18 @@

Method Details

"totalPauseDuration": "A String", # The accumulated duration the replication cycle was paused. "warnings": [ # Output only. Warnings that occurred during the cycle. { # Represents migration resource warning information that can be used with google.rpc.Status message. MigrationWarning is used to present the user with warning information in migration operations. - "actionItem": { # Provides a localized error message that is safe to return to the user which can be attached to an RPC error. # Suggested action for solving the warning. + "actionItem": { # Provides a localized error message that is safe to return to the user which can be attached to an RPC error. # Output only. Suggested action for solving the warning. "locale": "A String", # The locale used following the specification defined at https://www.rfc-editor.org/rfc/bcp/bcp47.txt. Examples are: "en-US", "fr-CH", "es-MX" "message": "A String", # The localized error message in the above locale. }, "code": "A String", # The warning code. - "helpLinks": [ # URL(s) pointing to additional information on handling the current warning. + "helpLinks": [ # Output only. URL(s) pointing to additional information on handling the current warning. { # Describes a URL link. "description": "A String", # Describes what the link offers. "url": "A String", # The URL of the link. }, ], - "warningMessage": { # Provides a localized error message that is safe to return to the user which can be attached to an RPC error. # The localized warning message. + "warningMessage": { # Provides a localized error message that is safe to return to the user which can be attached to an RPC error. # Output only. The localized warning message. "locale": "A String", # The locale used following the specification defined at https://www.rfc-editor.org/rfc/bcp/bcp47.txt. Examples are: "en-US", "fr-CH", "es-MX" "message": "A String", # The localized error message in the above locale. }, @@ -2500,7 +2500,7 @@

Method Details

"lastReplicationCycle": { # ReplicationCycle contains information about the current replication cycle status. # Output only. Details of the last replication cycle. This will be updated whenever a replication cycle is finished and is not to be confused with last_sync which is only updated on successful replication cycles. "cycleNumber": 42, # The cycle's ordinal number. "endTime": "A String", # The time the replication cycle has ended. - "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). # Provides details on the state of the cycle in case of an error. + "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). # Output only. Provides details on the state of the cycle in case of an error. "code": 42, # The status code, which should be an enum value of google.rpc.Code. "details": [ # A list of messages that carry the error details. There is a common set of message types for APIs to use. { @@ -2533,18 +2533,18 @@

Method Details

"totalPauseDuration": "A String", # The accumulated duration the replication cycle was paused. "warnings": [ # Output only. Warnings that occurred during the cycle. { # Represents migration resource warning information that can be used with google.rpc.Status message. MigrationWarning is used to present the user with warning information in migration operations. - "actionItem": { # Provides a localized error message that is safe to return to the user which can be attached to an RPC error. # Suggested action for solving the warning. + "actionItem": { # Provides a localized error message that is safe to return to the user which can be attached to an RPC error. # Output only. Suggested action for solving the warning. "locale": "A String", # The locale used following the specification defined at https://www.rfc-editor.org/rfc/bcp/bcp47.txt. Examples are: "en-US", "fr-CH", "es-MX" "message": "A String", # The localized error message in the above locale. }, "code": "A String", # The warning code. - "helpLinks": [ # URL(s) pointing to additional information on handling the current warning. + "helpLinks": [ # Output only. URL(s) pointing to additional information on handling the current warning. { # Describes a URL link. "description": "A String", # Describes what the link offers. "url": "A String", # The URL of the link. }, ], - "warningMessage": { # Provides a localized error message that is safe to return to the user which can be attached to an RPC error. # The localized warning message. + "warningMessage": { # Provides a localized error message that is safe to return to the user which can be attached to an RPC error. # Output only. The localized warning message. "locale": "A String", # The locale used following the specification defined at https://www.rfc-editor.org/rfc/bcp/bcp47.txt. Examples are: "en-US", "fr-CH", "es-MX" "message": "A String", # The localized error message in the above locale. }, @@ -2615,8 +2615,8 @@

Method Details

}, "networkInterfaces": [ # List of NICs connected to this VM. { # NetworkInterface represents a NIC of a VM. - "externalIp": "A String", # The external IP to define in the NIC. - "internalIp": "A String", # The internal IP to define in the NIC. The formats accepted are: `ephemeral` \ ipv4 address \ a named address resource full path. + "externalIp": "A String", # Optional. The external IP to define in the NIC. + "internalIp": "A String", # Optional. The internal IP to define in the NIC. The formats accepted are: `ephemeral` \ ipv4 address \ a named address resource full path. "network": "A String", # The network to connect the NIC to. "subnetwork": "A String", # The subnetwork to connect the NIC to. }, @@ -2667,8 +2667,8 @@

Method Details

"network": "A String", # The network to connect the VM to. "networkInterfaces": [ # List of NICs connected to this VM. { # NetworkInterface represents a NIC of a VM. - "externalIp": "A String", # The external IP to define in the NIC. - "internalIp": "A String", # The internal IP to define in the NIC. The formats accepted are: `ephemeral` \ ipv4 address \ a named address resource full path. + "externalIp": "A String", # Optional. The external IP to define in the NIC. + "internalIp": "A String", # Optional. The internal IP to define in the NIC. The formats accepted are: `ephemeral` \ ipv4 address \ a named address resource full path. "network": "A String", # The network to connect the NIC to. "subnetwork": "A String", # The subnetwork to connect the NIC to. }, @@ -2746,8 +2746,8 @@

Method Details

"network": "A String", # The network to connect the VM to. "networkInterfaces": [ # List of NICs connected to this VM. { # NetworkInterface represents a NIC of a VM. - "externalIp": "A String", # The external IP to define in the NIC. - "internalIp": "A String", # The internal IP to define in the NIC. The formats accepted are: `ephemeral` \ ipv4 address \ a named address resource full path. + "externalIp": "A String", # Optional. The external IP to define in the NIC. + "internalIp": "A String", # Optional. The internal IP to define in the NIC. The formats accepted are: `ephemeral` \ ipv4 address \ a named address resource full path. "network": "A String", # The network to connect the NIC to. "subnetwork": "A String", # The subnetwork to connect the NIC to. }, @@ -2819,8 +2819,8 @@

Method Details

}, "networkInterfaces": [ # List of NICs connected to this VM. { # NetworkInterface represents a NIC of a VM. - "externalIp": "A String", # The external IP to define in the NIC. - "internalIp": "A String", # The internal IP to define in the NIC. The formats accepted are: `ephemeral` \ ipv4 address \ a named address resource full path. + "externalIp": "A String", # Optional. The external IP to define in the NIC. + "internalIp": "A String", # Optional. The internal IP to define in the NIC. The formats accepted are: `ephemeral` \ ipv4 address \ a named address resource full path. "network": "A String", # The network to connect the NIC to. "subnetwork": "A String", # The subnetwork to connect the NIC to. }, @@ -2871,8 +2871,8 @@

Method Details

"network": "A String", # The network to connect the VM to. "networkInterfaces": [ # List of NICs connected to this VM. { # NetworkInterface represents a NIC of a VM. - "externalIp": "A String", # The external IP to define in the NIC. - "internalIp": "A String", # The internal IP to define in the NIC. The formats accepted are: `ephemeral` \ ipv4 address \ a named address resource full path. + "externalIp": "A String", # Optional. The external IP to define in the NIC. + "internalIp": "A String", # Optional. The internal IP to define in the NIC. The formats accepted are: `ephemeral` \ ipv4 address \ a named address resource full path. "network": "A String", # The network to connect the NIC to. "subnetwork": "A String", # The subnetwork to connect the NIC to. }, @@ -2910,7 +2910,7 @@

Method Details

"finalSync": { # ReplicationCycle contains information about the current replication cycle status. # Final sync step. "cycleNumber": 42, # The cycle's ordinal number. "endTime": "A String", # The time the replication cycle has ended. - "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). # Provides details on the state of the cycle in case of an error. + "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). # Output only. Provides details on the state of the cycle in case of an error. "code": 42, # The status code, which should be an enum value of google.rpc.Code. "details": [ # A list of messages that carry the error details. There is a common set of message types for APIs to use. { @@ -2943,18 +2943,18 @@

Method Details

"totalPauseDuration": "A String", # The accumulated duration the replication cycle was paused. "warnings": [ # Output only. Warnings that occurred during the cycle. { # Represents migration resource warning information that can be used with google.rpc.Status message. MigrationWarning is used to present the user with warning information in migration operations. - "actionItem": { # Provides a localized error message that is safe to return to the user which can be attached to an RPC error. # Suggested action for solving the warning. + "actionItem": { # Provides a localized error message that is safe to return to the user which can be attached to an RPC error. # Output only. Suggested action for solving the warning. "locale": "A String", # The locale used following the specification defined at https://www.rfc-editor.org/rfc/bcp/bcp47.txt. Examples are: "en-US", "fr-CH", "es-MX" "message": "A String", # The localized error message in the above locale. }, "code": "A String", # The warning code. - "helpLinks": [ # URL(s) pointing to additional information on handling the current warning. + "helpLinks": [ # Output only. URL(s) pointing to additional information on handling the current warning. { # Describes a URL link. "description": "A String", # Describes what the link offers. "url": "A String", # The URL of the link. }, ], - "warningMessage": { # Provides a localized error message that is safe to return to the user which can be attached to an RPC error. # The localized warning message. + "warningMessage": { # Provides a localized error message that is safe to return to the user which can be attached to an RPC error. # Output only. The localized warning message. "locale": "A String", # The locale used following the specification defined at https://www.rfc-editor.org/rfc/bcp/bcp47.txt. Examples are: "en-US", "fr-CH", "es-MX" "message": "A String", # The localized error message in the above locale. }, @@ -2969,7 +2969,7 @@

Method Details

"previousReplicationCycle": { # ReplicationCycle contains information about the current replication cycle status. # A replication cycle prior cutover step. "cycleNumber": 42, # The cycle's ordinal number. "endTime": "A String", # The time the replication cycle has ended. - "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). # Provides details on the state of the cycle in case of an error. + "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). # Output only. Provides details on the state of the cycle in case of an error. "code": 42, # The status code, which should be an enum value of google.rpc.Code. "details": [ # A list of messages that carry the error details. There is a common set of message types for APIs to use. { @@ -3002,18 +3002,18 @@

Method Details

"totalPauseDuration": "A String", # The accumulated duration the replication cycle was paused. "warnings": [ # Output only. Warnings that occurred during the cycle. { # Represents migration resource warning information that can be used with google.rpc.Status message. MigrationWarning is used to present the user with warning information in migration operations. - "actionItem": { # Provides a localized error message that is safe to return to the user which can be attached to an RPC error. # Suggested action for solving the warning. + "actionItem": { # Provides a localized error message that is safe to return to the user which can be attached to an RPC error. # Output only. Suggested action for solving the warning. "locale": "A String", # The locale used following the specification defined at https://www.rfc-editor.org/rfc/bcp/bcp47.txt. Examples are: "en-US", "fr-CH", "es-MX" "message": "A String", # The localized error message in the above locale. }, "code": "A String", # The warning code. - "helpLinks": [ # URL(s) pointing to additional information on handling the current warning. + "helpLinks": [ # Output only. URL(s) pointing to additional information on handling the current warning. { # Describes a URL link. "description": "A String", # Describes what the link offers. "url": "A String", # The URL of the link. }, ], - "warningMessage": { # Provides a localized error message that is safe to return to the user which can be attached to an RPC error. # The localized warning message. + "warningMessage": { # Provides a localized error message that is safe to return to the user which can be attached to an RPC error. # Output only. The localized warning message. "locale": "A String", # The locale used following the specification defined at https://www.rfc-editor.org/rfc/bcp/bcp47.txt. Examples are: "en-US", "fr-CH", "es-MX" "message": "A String", # The localized error message in the above locale. }, @@ -3063,8 +3063,8 @@

Method Details

"network": "A String", # The network to connect the VM to. "networkInterfaces": [ # List of NICs connected to this VM. { # NetworkInterface represents a NIC of a VM. - "externalIp": "A String", # The external IP to define in the NIC. - "internalIp": "A String", # The internal IP to define in the NIC. The formats accepted are: `ephemeral` \ ipv4 address \ a named address resource full path. + "externalIp": "A String", # Optional. The external IP to define in the NIC. + "internalIp": "A String", # Optional. The internal IP to define in the NIC. The formats accepted are: `ephemeral` \ ipv4 address \ a named address resource full path. "network": "A String", # The network to connect the NIC to. "subnetwork": "A String", # The subnetwork to connect the NIC to. }, @@ -3121,8 +3121,8 @@

Method Details

"network": "A String", # The network to connect the VM to. "networkInterfaces": [ # List of NICs connected to this VM. { # NetworkInterface represents a NIC of a VM. - "externalIp": "A String", # The external IP to define in the NIC. - "internalIp": "A String", # The internal IP to define in the NIC. The formats accepted are: `ephemeral` \ ipv4 address \ a named address resource full path. + "externalIp": "A String", # Optional. The external IP to define in the NIC. + "internalIp": "A String", # Optional. The internal IP to define in the NIC. The formats accepted are: `ephemeral` \ ipv4 address \ a named address resource full path. "network": "A String", # The network to connect the NIC to. "subnetwork": "A String", # The subnetwork to connect the NIC to. }, @@ -3139,15 +3139,15 @@

Method Details

}, "updateTime": "A String", # Output only. The last time the migrating VM resource was updated. "vmwareSourceVmDetails": { # Represent the source Vmware VM details. # Output only. Details of the VM from a Vmware source. - "committedStorageBytes": "A String", # The total size of the disks being migrated in bytes. - "disks": [ # The disks attached to the source VM. + "committedStorageBytes": "A String", # Output only. The total size of the disks being migrated in bytes. + "disks": [ # Output only. The disks attached to the source VM. { # The details of a Vmware VM disk. - "diskNumber": 42, # The ordinal number of the disk. - "label": "A String", # The disk label. - "sizeGb": "A String", # Size in GB. + "diskNumber": 42, # Output only. The ordinal number of the disk. + "label": "A String", # Output only. The disk label. + "sizeGb": "A String", # Output only. Size in GB. }, ], - "firmware": "A String", # The firmware type of the source VM. + "firmware": "A String", # Output only. The firmware type of the source VM. "vmCapabilitiesInfo": { # Migrating VM source information about the VM capabilities needed for some Compute Engine features. # Output only. Information about VM capabilities needed for some Compute Engine features. "lastOsCapabilitiesUpdateTime": "A String", # Output only. The last time OS capabilities list was updated. "osCapabilities": [ # Output only. Unordered list. List of certain VM OS capabilities needed for some Compute Engine features. @@ -3189,15 +3189,15 @@

Method Details

{ # MigratingVm describes the VM that will be migrated from a Source environment and its replication state. "awsSourceVmDetails": { # Represent the source AWS VM details. # Output only. Details of the VM from an AWS source. - "committedStorageBytes": "A String", # The total size of the disks being migrated in bytes. - "disks": [ # The disks attached to the source VM. + "committedStorageBytes": "A String", # Output only. The total size of the disks being migrated in bytes. + "disks": [ # Output only. The disks attached to the source VM. { # The details of an AWS instance disk. - "diskNumber": 42, # The ordinal number of the disk. - "sizeGb": "A String", # Size in GB. - "volumeId": "A String", # AWS volume ID. + "diskNumber": 42, # Output only. The ordinal number of the disk. + "sizeGb": "A String", # Output only. Size in GB. + "volumeId": "A String", # Output only. AWS volume ID. }, ], - "firmware": "A String", # The firmware type of the source VM. + "firmware": "A String", # Output only. The firmware type of the source VM. "vmCapabilitiesInfo": { # Migrating VM source information about the VM capabilities needed for some Compute Engine features. # Output only. Information about VM capabilities needed for some Compute Engine features. "lastOsCapabilitiesUpdateTime": "A String", # Output only. The last time OS capabilities list was updated. "osCapabilities": [ # Output only. Unordered list. List of certain VM OS capabilities needed for some Compute Engine features. @@ -3206,15 +3206,15 @@

Method Details

}, }, "azureSourceVmDetails": { # Represent the source Azure VM details. # Output only. Details of the VM from an Azure source. - "committedStorageBytes": "A String", # The total size of the disks being migrated in bytes. - "disks": [ # The disks attached to the source VM. + "committedStorageBytes": "A String", # Output only. The total size of the disks being migrated in bytes. + "disks": [ # Output only. The disks attached to the source VM. { # The details of an Azure VM disk. - "diskId": "A String", # Azure disk ID. - "diskNumber": 42, # The ordinal number of the disk. - "sizeGb": "A String", # Size in GB. + "diskId": "A String", # Output only. Azure disk ID. + "diskNumber": 42, # Output only. The ordinal number of the disk. + "sizeGb": "A String", # Output only. Size in GB. }, ], - "firmware": "A String", # The firmware type of the source VM. + "firmware": "A String", # Output only. The firmware type of the source VM. "vmCapabilitiesInfo": { # Migrating VM source information about the VM capabilities needed for some Compute Engine features. # Output only. Information about VM capabilities needed for some Compute Engine features. "lastOsCapabilitiesUpdateTime": "A String", # Output only. The last time OS capabilities list was updated. "osCapabilities": [ # Output only. Unordered list. List of certain VM OS capabilities needed for some Compute Engine features. @@ -3286,8 +3286,8 @@

Method Details

}, "networkInterfaces": [ # Optional. NICs to attach to the VM. { # NetworkInterface represents a NIC of a VM. - "externalIp": "A String", # The external IP to define in the NIC. - "internalIp": "A String", # The internal IP to define in the NIC. The formats accepted are: `ephemeral` \ ipv4 address \ a named address resource full path. + "externalIp": "A String", # Optional. The external IP to define in the NIC. + "internalIp": "A String", # Optional. The internal IP to define in the NIC. The formats accepted are: `ephemeral` \ ipv4 address \ a named address resource full path. "network": "A String", # The network to connect the NIC to. "subnetwork": "A String", # The subnetwork to connect the NIC to. }, @@ -3341,8 +3341,8 @@

Method Details

}, "networkInterfaces": [ # List of NICs connected to this VM. { # NetworkInterface represents a NIC of a VM. - "externalIp": "A String", # The external IP to define in the NIC. - "internalIp": "A String", # The internal IP to define in the NIC. The formats accepted are: `ephemeral` \ ipv4 address \ a named address resource full path. + "externalIp": "A String", # Optional. The external IP to define in the NIC. + "internalIp": "A String", # Optional. The internal IP to define in the NIC. The formats accepted are: `ephemeral` \ ipv4 address \ a named address resource full path. "network": "A String", # The network to connect the NIC to. "subnetwork": "A String", # The subnetwork to connect the NIC to. }, @@ -3393,8 +3393,8 @@

Method Details

"network": "A String", # The network to connect the VM to. "networkInterfaces": [ # List of NICs connected to this VM. { # NetworkInterface represents a NIC of a VM. - "externalIp": "A String", # The external IP to define in the NIC. - "internalIp": "A String", # The internal IP to define in the NIC. The formats accepted are: `ephemeral` \ ipv4 address \ a named address resource full path. + "externalIp": "A String", # Optional. The external IP to define in the NIC. + "internalIp": "A String", # Optional. The internal IP to define in the NIC. The formats accepted are: `ephemeral` \ ipv4 address \ a named address resource full path. "network": "A String", # The network to connect the NIC to. "subnetwork": "A String", # The subnetwork to connect the NIC to. }, @@ -3413,7 +3413,7 @@

Method Details

"currentSyncInfo": { # ReplicationCycle contains information about the current replication cycle status. # Output only. Details of the current running replication cycle. "cycleNumber": 42, # The cycle's ordinal number. "endTime": "A String", # The time the replication cycle has ended. - "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). # Provides details on the state of the cycle in case of an error. + "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). # Output only. Provides details on the state of the cycle in case of an error. "code": 42, # The status code, which should be an enum value of google.rpc.Code. "details": [ # A list of messages that carry the error details. There is a common set of message types for APIs to use. { @@ -3446,18 +3446,18 @@

Method Details

"totalPauseDuration": "A String", # The accumulated duration the replication cycle was paused. "warnings": [ # Output only. Warnings that occurred during the cycle. { # Represents migration resource warning information that can be used with google.rpc.Status message. MigrationWarning is used to present the user with warning information in migration operations. - "actionItem": { # Provides a localized error message that is safe to return to the user which can be attached to an RPC error. # Suggested action for solving the warning. + "actionItem": { # Provides a localized error message that is safe to return to the user which can be attached to an RPC error. # Output only. Suggested action for solving the warning. "locale": "A String", # The locale used following the specification defined at https://www.rfc-editor.org/rfc/bcp/bcp47.txt. Examples are: "en-US", "fr-CH", "es-MX" "message": "A String", # The localized error message in the above locale. }, "code": "A String", # The warning code. - "helpLinks": [ # URL(s) pointing to additional information on handling the current warning. + "helpLinks": [ # Output only. URL(s) pointing to additional information on handling the current warning. { # Describes a URL link. "description": "A String", # Describes what the link offers. "url": "A String", # The URL of the link. }, ], - "warningMessage": { # Provides a localized error message that is safe to return to the user which can be attached to an RPC error. # The localized warning message. + "warningMessage": { # Provides a localized error message that is safe to return to the user which can be attached to an RPC error. # Output only. The localized warning message. "locale": "A String", # The locale used following the specification defined at https://www.rfc-editor.org/rfc/bcp/bcp47.txt. Examples are: "en-US", "fr-CH", "es-MX" "message": "A String", # The localized error message in the above locale. }, @@ -3486,7 +3486,7 @@

Method Details

"lastReplicationCycle": { # ReplicationCycle contains information about the current replication cycle status. # Output only. Details of the last replication cycle. This will be updated whenever a replication cycle is finished and is not to be confused with last_sync which is only updated on successful replication cycles. "cycleNumber": 42, # The cycle's ordinal number. "endTime": "A String", # The time the replication cycle has ended. - "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). # Provides details on the state of the cycle in case of an error. + "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). # Output only. Provides details on the state of the cycle in case of an error. "code": 42, # The status code, which should be an enum value of google.rpc.Code. "details": [ # A list of messages that carry the error details. There is a common set of message types for APIs to use. { @@ -3519,18 +3519,18 @@

Method Details

"totalPauseDuration": "A String", # The accumulated duration the replication cycle was paused. "warnings": [ # Output only. Warnings that occurred during the cycle. { # Represents migration resource warning information that can be used with google.rpc.Status message. MigrationWarning is used to present the user with warning information in migration operations. - "actionItem": { # Provides a localized error message that is safe to return to the user which can be attached to an RPC error. # Suggested action for solving the warning. + "actionItem": { # Provides a localized error message that is safe to return to the user which can be attached to an RPC error. # Output only. Suggested action for solving the warning. "locale": "A String", # The locale used following the specification defined at https://www.rfc-editor.org/rfc/bcp/bcp47.txt. Examples are: "en-US", "fr-CH", "es-MX" "message": "A String", # The localized error message in the above locale. }, "code": "A String", # The warning code. - "helpLinks": [ # URL(s) pointing to additional information on handling the current warning. + "helpLinks": [ # Output only. URL(s) pointing to additional information on handling the current warning. { # Describes a URL link. "description": "A String", # Describes what the link offers. "url": "A String", # The URL of the link. }, ], - "warningMessage": { # Provides a localized error message that is safe to return to the user which can be attached to an RPC error. # The localized warning message. + "warningMessage": { # Provides a localized error message that is safe to return to the user which can be attached to an RPC error. # Output only. The localized warning message. "locale": "A String", # The locale used following the specification defined at https://www.rfc-editor.org/rfc/bcp/bcp47.txt. Examples are: "en-US", "fr-CH", "es-MX" "message": "A String", # The localized error message in the above locale. }, @@ -3601,8 +3601,8 @@

Method Details

}, "networkInterfaces": [ # List of NICs connected to this VM. { # NetworkInterface represents a NIC of a VM. - "externalIp": "A String", # The external IP to define in the NIC. - "internalIp": "A String", # The internal IP to define in the NIC. The formats accepted are: `ephemeral` \ ipv4 address \ a named address resource full path. + "externalIp": "A String", # Optional. The external IP to define in the NIC. + "internalIp": "A String", # Optional. The internal IP to define in the NIC. The formats accepted are: `ephemeral` \ ipv4 address \ a named address resource full path. "network": "A String", # The network to connect the NIC to. "subnetwork": "A String", # The subnetwork to connect the NIC to. }, @@ -3653,8 +3653,8 @@

Method Details

"network": "A String", # The network to connect the VM to. "networkInterfaces": [ # List of NICs connected to this VM. { # NetworkInterface represents a NIC of a VM. - "externalIp": "A String", # The external IP to define in the NIC. - "internalIp": "A String", # The internal IP to define in the NIC. The formats accepted are: `ephemeral` \ ipv4 address \ a named address resource full path. + "externalIp": "A String", # Optional. The external IP to define in the NIC. + "internalIp": "A String", # Optional. The internal IP to define in the NIC. The formats accepted are: `ephemeral` \ ipv4 address \ a named address resource full path. "network": "A String", # The network to connect the NIC to. "subnetwork": "A String", # The subnetwork to connect the NIC to. }, @@ -3732,8 +3732,8 @@

Method Details

"network": "A String", # The network to connect the VM to. "networkInterfaces": [ # List of NICs connected to this VM. { # NetworkInterface represents a NIC of a VM. - "externalIp": "A String", # The external IP to define in the NIC. - "internalIp": "A String", # The internal IP to define in the NIC. The formats accepted are: `ephemeral` \ ipv4 address \ a named address resource full path. + "externalIp": "A String", # Optional. The external IP to define in the NIC. + "internalIp": "A String", # Optional. The internal IP to define in the NIC. The formats accepted are: `ephemeral` \ ipv4 address \ a named address resource full path. "network": "A String", # The network to connect the NIC to. "subnetwork": "A String", # The subnetwork to connect the NIC to. }, @@ -3805,8 +3805,8 @@

Method Details

}, "networkInterfaces": [ # List of NICs connected to this VM. { # NetworkInterface represents a NIC of a VM. - "externalIp": "A String", # The external IP to define in the NIC. - "internalIp": "A String", # The internal IP to define in the NIC. The formats accepted are: `ephemeral` \ ipv4 address \ a named address resource full path. + "externalIp": "A String", # Optional. The external IP to define in the NIC. + "internalIp": "A String", # Optional. The internal IP to define in the NIC. The formats accepted are: `ephemeral` \ ipv4 address \ a named address resource full path. "network": "A String", # The network to connect the NIC to. "subnetwork": "A String", # The subnetwork to connect the NIC to. }, @@ -3857,8 +3857,8 @@

Method Details

"network": "A String", # The network to connect the VM to. "networkInterfaces": [ # List of NICs connected to this VM. { # NetworkInterface represents a NIC of a VM. - "externalIp": "A String", # The external IP to define in the NIC. - "internalIp": "A String", # The internal IP to define in the NIC. The formats accepted are: `ephemeral` \ ipv4 address \ a named address resource full path. + "externalIp": "A String", # Optional. The external IP to define in the NIC. + "internalIp": "A String", # Optional. The internal IP to define in the NIC. The formats accepted are: `ephemeral` \ ipv4 address \ a named address resource full path. "network": "A String", # The network to connect the NIC to. "subnetwork": "A String", # The subnetwork to connect the NIC to. }, @@ -3896,7 +3896,7 @@

Method Details

"finalSync": { # ReplicationCycle contains information about the current replication cycle status. # Final sync step. "cycleNumber": 42, # The cycle's ordinal number. "endTime": "A String", # The time the replication cycle has ended. - "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). # Provides details on the state of the cycle in case of an error. + "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). # Output only. Provides details on the state of the cycle in case of an error. "code": 42, # The status code, which should be an enum value of google.rpc.Code. "details": [ # A list of messages that carry the error details. There is a common set of message types for APIs to use. { @@ -3929,18 +3929,18 @@

Method Details

"totalPauseDuration": "A String", # The accumulated duration the replication cycle was paused. "warnings": [ # Output only. Warnings that occurred during the cycle. { # Represents migration resource warning information that can be used with google.rpc.Status message. MigrationWarning is used to present the user with warning information in migration operations. - "actionItem": { # Provides a localized error message that is safe to return to the user which can be attached to an RPC error. # Suggested action for solving the warning. + "actionItem": { # Provides a localized error message that is safe to return to the user which can be attached to an RPC error. # Output only. Suggested action for solving the warning. "locale": "A String", # The locale used following the specification defined at https://www.rfc-editor.org/rfc/bcp/bcp47.txt. Examples are: "en-US", "fr-CH", "es-MX" "message": "A String", # The localized error message in the above locale. }, "code": "A String", # The warning code. - "helpLinks": [ # URL(s) pointing to additional information on handling the current warning. + "helpLinks": [ # Output only. URL(s) pointing to additional information on handling the current warning. { # Describes a URL link. "description": "A String", # Describes what the link offers. "url": "A String", # The URL of the link. }, ], - "warningMessage": { # Provides a localized error message that is safe to return to the user which can be attached to an RPC error. # The localized warning message. + "warningMessage": { # Provides a localized error message that is safe to return to the user which can be attached to an RPC error. # Output only. The localized warning message. "locale": "A String", # The locale used following the specification defined at https://www.rfc-editor.org/rfc/bcp/bcp47.txt. Examples are: "en-US", "fr-CH", "es-MX" "message": "A String", # The localized error message in the above locale. }, @@ -3955,7 +3955,7 @@

Method Details

"previousReplicationCycle": { # ReplicationCycle contains information about the current replication cycle status. # A replication cycle prior cutover step. "cycleNumber": 42, # The cycle's ordinal number. "endTime": "A String", # The time the replication cycle has ended. - "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). # Provides details on the state of the cycle in case of an error. + "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). # Output only. Provides details on the state of the cycle in case of an error. "code": 42, # The status code, which should be an enum value of google.rpc.Code. "details": [ # A list of messages that carry the error details. There is a common set of message types for APIs to use. { @@ -3988,18 +3988,18 @@

Method Details

"totalPauseDuration": "A String", # The accumulated duration the replication cycle was paused. "warnings": [ # Output only. Warnings that occurred during the cycle. { # Represents migration resource warning information that can be used with google.rpc.Status message. MigrationWarning is used to present the user with warning information in migration operations. - "actionItem": { # Provides a localized error message that is safe to return to the user which can be attached to an RPC error. # Suggested action for solving the warning. + "actionItem": { # Provides a localized error message that is safe to return to the user which can be attached to an RPC error. # Output only. Suggested action for solving the warning. "locale": "A String", # The locale used following the specification defined at https://www.rfc-editor.org/rfc/bcp/bcp47.txt. Examples are: "en-US", "fr-CH", "es-MX" "message": "A String", # The localized error message in the above locale. }, "code": "A String", # The warning code. - "helpLinks": [ # URL(s) pointing to additional information on handling the current warning. + "helpLinks": [ # Output only. URL(s) pointing to additional information on handling the current warning. { # Describes a URL link. "description": "A String", # Describes what the link offers. "url": "A String", # The URL of the link. }, ], - "warningMessage": { # Provides a localized error message that is safe to return to the user which can be attached to an RPC error. # The localized warning message. + "warningMessage": { # Provides a localized error message that is safe to return to the user which can be attached to an RPC error. # Output only. The localized warning message. "locale": "A String", # The locale used following the specification defined at https://www.rfc-editor.org/rfc/bcp/bcp47.txt. Examples are: "en-US", "fr-CH", "es-MX" "message": "A String", # The localized error message in the above locale. }, @@ -4049,8 +4049,8 @@

Method Details

"network": "A String", # The network to connect the VM to. "networkInterfaces": [ # List of NICs connected to this VM. { # NetworkInterface represents a NIC of a VM. - "externalIp": "A String", # The external IP to define in the NIC. - "internalIp": "A String", # The internal IP to define in the NIC. The formats accepted are: `ephemeral` \ ipv4 address \ a named address resource full path. + "externalIp": "A String", # Optional. The external IP to define in the NIC. + "internalIp": "A String", # Optional. The internal IP to define in the NIC. The formats accepted are: `ephemeral` \ ipv4 address \ a named address resource full path. "network": "A String", # The network to connect the NIC to. "subnetwork": "A String", # The subnetwork to connect the NIC to. }, @@ -4107,8 +4107,8 @@

Method Details

"network": "A String", # The network to connect the VM to. "networkInterfaces": [ # List of NICs connected to this VM. { # NetworkInterface represents a NIC of a VM. - "externalIp": "A String", # The external IP to define in the NIC. - "internalIp": "A String", # The internal IP to define in the NIC. The formats accepted are: `ephemeral` \ ipv4 address \ a named address resource full path. + "externalIp": "A String", # Optional. The external IP to define in the NIC. + "internalIp": "A String", # Optional. The internal IP to define in the NIC. The formats accepted are: `ephemeral` \ ipv4 address \ a named address resource full path. "network": "A String", # The network to connect the NIC to. "subnetwork": "A String", # The subnetwork to connect the NIC to. }, @@ -4125,15 +4125,15 @@

Method Details

}, "updateTime": "A String", # Output only. The last time the migrating VM resource was updated. "vmwareSourceVmDetails": { # Represent the source Vmware VM details. # Output only. Details of the VM from a Vmware source. - "committedStorageBytes": "A String", # The total size of the disks being migrated in bytes. - "disks": [ # The disks attached to the source VM. + "committedStorageBytes": "A String", # Output only. The total size of the disks being migrated in bytes. + "disks": [ # Output only. The disks attached to the source VM. { # The details of a Vmware VM disk. - "diskNumber": 42, # The ordinal number of the disk. - "label": "A String", # The disk label. - "sizeGb": "A String", # Size in GB. + "diskNumber": 42, # Output only. The ordinal number of the disk. + "label": "A String", # Output only. The disk label. + "sizeGb": "A String", # Output only. Size in GB. }, ], - "firmware": "A String", # The firmware type of the source VM. + "firmware": "A String", # Output only. The firmware type of the source VM. "vmCapabilitiesInfo": { # Migrating VM source information about the VM capabilities needed for some Compute Engine features. # Output only. Information about VM capabilities needed for some Compute Engine features. "lastOsCapabilitiesUpdateTime": "A String", # Output only. The last time OS capabilities list was updated. "osCapabilities": [ # Output only. Unordered list. List of certain VM OS capabilities needed for some Compute Engine features. diff --git a/docs/dyn/vmmigration_v1alpha1.projects.locations.sources.migratingVms.replicationCycles.html b/docs/dyn/vmmigration_v1alpha1.projects.locations.sources.migratingVms.replicationCycles.html index fad645b00bb..64c9fa373a0 100644 --- a/docs/dyn/vmmigration_v1alpha1.projects.locations.sources.migratingVms.replicationCycles.html +++ b/docs/dyn/vmmigration_v1alpha1.projects.locations.sources.migratingVms.replicationCycles.html @@ -109,7 +109,7 @@

Method Details

{ # ReplicationCycle contains information about the current replication cycle status. "cycleNumber": 42, # The cycle's ordinal number. "endTime": "A String", # The time the replication cycle has ended. - "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). # Provides details on the state of the cycle in case of an error. + "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). # Output only. Provides details on the state of the cycle in case of an error. "code": 42, # The status code, which should be an enum value of google.rpc.Code. "details": [ # A list of messages that carry the error details. There is a common set of message types for APIs to use. { @@ -142,18 +142,18 @@

Method Details

"totalPauseDuration": "A String", # The accumulated duration the replication cycle was paused. "warnings": [ # Output only. Warnings that occurred during the cycle. { # Represents migration resource warning information that can be used with google.rpc.Status message. MigrationWarning is used to present the user with warning information in migration operations. - "actionItem": { # Provides a localized error message that is safe to return to the user which can be attached to an RPC error. # Suggested action for solving the warning. + "actionItem": { # Provides a localized error message that is safe to return to the user which can be attached to an RPC error. # Output only. Suggested action for solving the warning. "locale": "A String", # The locale used following the specification defined at https://www.rfc-editor.org/rfc/bcp/bcp47.txt. Examples are: "en-US", "fr-CH", "es-MX" "message": "A String", # The localized error message in the above locale. }, "code": "A String", # The warning code. - "helpLinks": [ # URL(s) pointing to additional information on handling the current warning. + "helpLinks": [ # Output only. URL(s) pointing to additional information on handling the current warning. { # Describes a URL link. "description": "A String", # Describes what the link offers. "url": "A String", # The URL of the link. }, ], - "warningMessage": { # Provides a localized error message that is safe to return to the user which can be attached to an RPC error. # The localized warning message. + "warningMessage": { # Provides a localized error message that is safe to return to the user which can be attached to an RPC error. # Output only. The localized warning message. "locale": "A String", # The locale used following the specification defined at https://www.rfc-editor.org/rfc/bcp/bcp47.txt. Examples are: "en-US", "fr-CH", "es-MX" "message": "A String", # The localized error message in the above locale. }, @@ -187,7 +187,7 @@

Method Details

{ # ReplicationCycle contains information about the current replication cycle status. "cycleNumber": 42, # The cycle's ordinal number. "endTime": "A String", # The time the replication cycle has ended. - "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). # Provides details on the state of the cycle in case of an error. + "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). # Output only. Provides details on the state of the cycle in case of an error. "code": 42, # The status code, which should be an enum value of google.rpc.Code. "details": [ # A list of messages that carry the error details. There is a common set of message types for APIs to use. { @@ -220,18 +220,18 @@

Method Details

"totalPauseDuration": "A String", # The accumulated duration the replication cycle was paused. "warnings": [ # Output only. Warnings that occurred during the cycle. { # Represents migration resource warning information that can be used with google.rpc.Status message. MigrationWarning is used to present the user with warning information in migration operations. - "actionItem": { # Provides a localized error message that is safe to return to the user which can be attached to an RPC error. # Suggested action for solving the warning. + "actionItem": { # Provides a localized error message that is safe to return to the user which can be attached to an RPC error. # Output only. Suggested action for solving the warning. "locale": "A String", # The locale used following the specification defined at https://www.rfc-editor.org/rfc/bcp/bcp47.txt. Examples are: "en-US", "fr-CH", "es-MX" "message": "A String", # The localized error message in the above locale. }, "code": "A String", # The warning code. - "helpLinks": [ # URL(s) pointing to additional information on handling the current warning. + "helpLinks": [ # Output only. URL(s) pointing to additional information on handling the current warning. { # Describes a URL link. "description": "A String", # Describes what the link offers. "url": "A String", # The URL of the link. }, ], - "warningMessage": { # Provides a localized error message that is safe to return to the user which can be attached to an RPC error. # The localized warning message. + "warningMessage": { # Provides a localized error message that is safe to return to the user which can be attached to an RPC error. # Output only. The localized warning message. "locale": "A String", # The locale used following the specification defined at https://www.rfc-editor.org/rfc/bcp/bcp47.txt. Examples are: "en-US", "fr-CH", "es-MX" "message": "A String", # The localized error message in the above locale. }, diff --git a/docs/dyn/walletobjects_v1.media.html b/docs/dyn/walletobjects_v1.media.html index 9ff5863751f..e1b8b853431 100644 --- a/docs/dyn/walletobjects_v1.media.html +++ b/docs/dyn/walletobjects_v1.media.html @@ -312,7 +312,7 @@

Method Details

"ignoreRange": True or False, # Determining whether or not Apiary should skip the inclusion of any Content-Range header on its response to Scotty. }, "filename": "A String", # Original file name - "hash": "A String", # Deprecated, use one of explicit hash type fields instead. These two hash related fields will only be populated on Scotty based media uploads and will contain the content of the hash group in the NotificationRequest: http://cs/#google3/uploader/service/proto/upload_listener.proto&q=class:Hash Hex encoded hash value of the uploaded media. + "hash": "A String", # Deprecated, use one of explicit hash type fields instead. These two hash related fields will only be populated on Scotty based media uploads and will contain the content of the hash group in the NotificationRequest: http://cs/#google3/blobstore2/api/scotty/service/proto/upload_listener.proto&q=class:Hash Hex encoded hash value of the uploaded media. "hashVerified": True or False, # For Scotty uploads only. If a user sends a hash code and the backend has requested that Scotty verify the upload against the client hash, Scotty will perform the check on behalf of the backend and will reject it if the hashes don't match. This is set to true if Scotty performed this verification. "inline": "A String", # Media data, set if reference_type is INLINE "isPotentialRetry": True or False, # |is_potential_retry| is set false only when Scotty is certain that it has not sent the request before. When a client resumes an upload, this field must be set true in agent calls, because Scotty cannot be certain that it has never sent the request before due to potential failure in the session state persistence. @@ -566,7 +566,7 @@

Method Details

"ignoreRange": True or False, # Determining whether or not Apiary should skip the inclusion of any Content-Range header on its response to Scotty. }, "filename": "A String", # Original file name - "hash": "A String", # Deprecated, use one of explicit hash type fields instead. These two hash related fields will only be populated on Scotty based media uploads and will contain the content of the hash group in the NotificationRequest: http://cs/#google3/uploader/service/proto/upload_listener.proto&q=class:Hash Hex encoded hash value of the uploaded media. + "hash": "A String", # Deprecated, use one of explicit hash type fields instead. These two hash related fields will only be populated on Scotty based media uploads and will contain the content of the hash group in the NotificationRequest: http://cs/#google3/blobstore2/api/scotty/service/proto/upload_listener.proto&q=class:Hash Hex encoded hash value of the uploaded media. "hashVerified": True or False, # For Scotty uploads only. If a user sends a hash code and the backend has requested that Scotty verify the upload against the client hash, Scotty will perform the check on behalf of the backend and will reject it if the hashes don't match. This is set to true if Scotty performed this verification. "inline": "A String", # Media data, set if reference_type is INLINE "isPotentialRetry": True or False, # |is_potential_retry| is set false only when Scotty is certain that it has not sent the request before. When a client resumes an upload, this field must be set true in agent calls, because Scotty cannot be certain that it has never sent the request before due to potential failure in the session state persistence. diff --git a/docs/dyn/workflowexecutions_v1.projects.locations.workflows.executions.html b/docs/dyn/workflowexecutions_v1.projects.locations.workflows.executions.html index cbee2a4637f..f9282d0411d 100644 --- a/docs/dyn/workflowexecutions_v1.projects.locations.workflows.executions.html +++ b/docs/dyn/workflowexecutions_v1.projects.locations.workflows.executions.html @@ -379,7 +379,7 @@

Method Details

Args: parent: string, Required. Name of the workflow for which the executions should be listed. Format: projects/{project}/locations/{location}/workflows/{workflow} (required) - filter: string, Optional. Filters applied to the `[Executions.ListExecutions]` results. The following fields are supported for filtering: `executionId`, `state`, `createTime`, `startTime`, `endTime`, `duration`, `workflowRevisionId`, `stepName`, and `label`. For details, see AIP-160. For example, if you are using the Google APIs Explorer: `state="SUCCEEDED"` or `startTime>"2023-08-01" AND state="FAILED"` + filter: string, Optional. Filters applied to the `[Executions.ListExecutions]` results. The following fields are supported for filtering: `executionId`, `state`, `createTime`, `startTime`, `endTime`, `duration`, `workflowRevisionId`, `stepName`, and `label`. For details, see AIP-160. For more information, see Filter executions. For example, if you are using the Google APIs Explorer: `state="SUCCEEDED"` or `startTime>"2023-08-01" AND state="FAILED"` orderBy: string, Optional. Comma-separated list of fields that specify the ordering applied to the `[Executions.ListExecutions]` results. By default the ordering is based on descending `createTime`. The following fields are supported for ordering: `executionId`, `state`, `createTime`, `startTime`, `endTime`, `duration`, and `workflowRevisionId`. For details, see AIP-132. pageSize: integer, Maximum number of executions to return per call. Max supported value depends on the selected Execution view: it's 1000 for BASIC and 100 for FULL. The default value used if the field is not specified is 100, regardless of the selected view. Values greater than the max value will be coerced down to it. pageToken: string, A page token, received from a previous `ListExecutions` call. Provide this to retrieve the subsequent page. When paginating, all other parameters provided to `ListExecutions` must match the call that provided the page token. Note that pagination is applied to dynamic data. The list of executions returned can change between page requests. diff --git a/docs/dyn/workstations_v1.projects.locations.workstationClusters.html b/docs/dyn/workstations_v1.projects.locations.workstationClusters.html index 39b9434e4ee..8c77eba924f 100644 --- a/docs/dyn/workstations_v1.projects.locations.workstationClusters.html +++ b/docs/dyn/workstations_v1.projects.locations.workstationClusters.html @@ -135,8 +135,8 @@

Method Details

"degraded": True or False, # Output only. Whether this workstation cluster is in degraded mode, in which case it may require user action to restore full functionality. Details can be found in conditions. "deleteTime": "A String", # Output only. Time when this workstation cluster was soft-deleted. "displayName": "A String", # Optional. Human-readable name for this workstation cluster. - "domainConfig": { # Configuration options for a custom domain. # Optional. Configuration options for a custom domain. - "domain": "A String", # Immutable. Domain used by Workstations for HTTP ingress. + "domainConfig": { # Configuration options for private workstation clusters. # Optional. Configuration options for a custom domain. + "domain": "A String", # Immutable. Whether Workstations endpoint is private. }, "etag": "A String", # Optional. Checksum computed by the server. May be sent on update and delete requests to make sure that the client has an up-to-date value before proceeding. "labels": { # Optional. [Labels](https://cloud.google.com/workstations/docs/label-resources) that are applied to the workstation cluster and that are also propagated to the underlying Compute Engine resources. @@ -144,13 +144,13 @@

Method Details

}, "name": "A String", # Identifier. Full name of this workstation cluster. "network": "A String", # Immutable. Name of the Compute Engine network in which instances associated with this workstation cluster will be created. - "privateClusterConfig": { # Configuration options for private workstation clusters. # Optional. Configuration for private workstation cluster. - "allowedProjects": [ # Optional. Additional projects that are allowed to attach to the workstation cluster's service attachment. By default, the workstation cluster's project and the VPC host project (if different) are allowed. + "privateClusterConfig": { # Optional. Configuration for private workstation cluster. + "allowedProjects": [ "A String", ], - "clusterHostname": "A String", # Output only. Hostname for the workstation cluster. This field will be populated only when private endpoint is enabled. To access workstations in the workstation cluster, create a new DNS zone mapping this domain name to an internal IP address and a forwarding rule mapping that address to the service attachment. - "enablePrivateEndpoint": True or False, # Immutable. Whether Workstations endpoint is private. - "serviceAttachmentUri": "A String", # Output only. Service attachment URI for the workstation cluster. The service attachemnt is created when private endpoint is enabled. To access workstations in the workstation cluster, configure access to the managed service using [Private Service Connect](https://cloud.google.com/vpc/docs/configure-private-service-connect-services). + "clusterHostname": "A String", + "enablePrivateEndpoint": True or False, + "serviceAttachmentUri": "A String", }, "reconciling": True or False, # Output only. Indicates whether this workstation cluster is currently being updated to match its intended state. "subnetwork": "A String", # Immutable. Name of the Compute Engine subnetwork in which instances associated with this workstation cluster will be created. Must be part of the subnetwork specified for this workstation cluster. @@ -261,8 +261,8 @@

Method Details

"degraded": True or False, # Output only. Whether this workstation cluster is in degraded mode, in which case it may require user action to restore full functionality. Details can be found in conditions. "deleteTime": "A String", # Output only. Time when this workstation cluster was soft-deleted. "displayName": "A String", # Optional. Human-readable name for this workstation cluster. - "domainConfig": { # Configuration options for a custom domain. # Optional. Configuration options for a custom domain. - "domain": "A String", # Immutable. Domain used by Workstations for HTTP ingress. + "domainConfig": { # Configuration options for private workstation clusters. # Optional. Configuration options for a custom domain. + "domain": "A String", # Immutable. Whether Workstations endpoint is private. }, "etag": "A String", # Optional. Checksum computed by the server. May be sent on update and delete requests to make sure that the client has an up-to-date value before proceeding. "labels": { # Optional. [Labels](https://cloud.google.com/workstations/docs/label-resources) that are applied to the workstation cluster and that are also propagated to the underlying Compute Engine resources. @@ -270,13 +270,13 @@

Method Details

}, "name": "A String", # Identifier. Full name of this workstation cluster. "network": "A String", # Immutable. Name of the Compute Engine network in which instances associated with this workstation cluster will be created. - "privateClusterConfig": { # Configuration options for private workstation clusters. # Optional. Configuration for private workstation cluster. - "allowedProjects": [ # Optional. Additional projects that are allowed to attach to the workstation cluster's service attachment. By default, the workstation cluster's project and the VPC host project (if different) are allowed. + "privateClusterConfig": { # Optional. Configuration for private workstation cluster. + "allowedProjects": [ "A String", ], - "clusterHostname": "A String", # Output only. Hostname for the workstation cluster. This field will be populated only when private endpoint is enabled. To access workstations in the workstation cluster, create a new DNS zone mapping this domain name to an internal IP address and a forwarding rule mapping that address to the service attachment. - "enablePrivateEndpoint": True or False, # Immutable. Whether Workstations endpoint is private. - "serviceAttachmentUri": "A String", # Output only. Service attachment URI for the workstation cluster. The service attachemnt is created when private endpoint is enabled. To access workstations in the workstation cluster, configure access to the managed service using [Private Service Connect](https://cloud.google.com/vpc/docs/configure-private-service-connect-services). + "clusterHostname": "A String", + "enablePrivateEndpoint": True or False, + "serviceAttachmentUri": "A String", }, "reconciling": True or False, # Output only. Indicates whether this workstation cluster is currently being updated to match its intended state. "subnetwork": "A String", # Immutable. Name of the Compute Engine subnetwork in which instances associated with this workstation cluster will be created. Must be part of the subnetwork specified for this workstation cluster. @@ -327,8 +327,8 @@

Method Details

"degraded": True or False, # Output only. Whether this workstation cluster is in degraded mode, in which case it may require user action to restore full functionality. Details can be found in conditions. "deleteTime": "A String", # Output only. Time when this workstation cluster was soft-deleted. "displayName": "A String", # Optional. Human-readable name for this workstation cluster. - "domainConfig": { # Configuration options for a custom domain. # Optional. Configuration options for a custom domain. - "domain": "A String", # Immutable. Domain used by Workstations for HTTP ingress. + "domainConfig": { # Configuration options for private workstation clusters. # Optional. Configuration options for a custom domain. + "domain": "A String", # Immutable. Whether Workstations endpoint is private. }, "etag": "A String", # Optional. Checksum computed by the server. May be sent on update and delete requests to make sure that the client has an up-to-date value before proceeding. "labels": { # Optional. [Labels](https://cloud.google.com/workstations/docs/label-resources) that are applied to the workstation cluster and that are also propagated to the underlying Compute Engine resources. @@ -336,13 +336,13 @@

Method Details

}, "name": "A String", # Identifier. Full name of this workstation cluster. "network": "A String", # Immutable. Name of the Compute Engine network in which instances associated with this workstation cluster will be created. - "privateClusterConfig": { # Configuration options for private workstation clusters. # Optional. Configuration for private workstation cluster. - "allowedProjects": [ # Optional. Additional projects that are allowed to attach to the workstation cluster's service attachment. By default, the workstation cluster's project and the VPC host project (if different) are allowed. + "privateClusterConfig": { # Optional. Configuration for private workstation cluster. + "allowedProjects": [ "A String", ], - "clusterHostname": "A String", # Output only. Hostname for the workstation cluster. This field will be populated only when private endpoint is enabled. To access workstations in the workstation cluster, create a new DNS zone mapping this domain name to an internal IP address and a forwarding rule mapping that address to the service attachment. - "enablePrivateEndpoint": True or False, # Immutable. Whether Workstations endpoint is private. - "serviceAttachmentUri": "A String", # Output only. Service attachment URI for the workstation cluster. The service attachemnt is created when private endpoint is enabled. To access workstations in the workstation cluster, configure access to the managed service using [Private Service Connect](https://cloud.google.com/vpc/docs/configure-private-service-connect-services). + "clusterHostname": "A String", + "enablePrivateEndpoint": True or False, + "serviceAttachmentUri": "A String", }, "reconciling": True or False, # Output only. Indicates whether this workstation cluster is currently being updated to match its intended state. "subnetwork": "A String", # Immutable. Name of the Compute Engine subnetwork in which instances associated with this workstation cluster will be created. Must be part of the subnetwork specified for this workstation cluster. @@ -396,8 +396,8 @@

Method Details

"degraded": True or False, # Output only. Whether this workstation cluster is in degraded mode, in which case it may require user action to restore full functionality. Details can be found in conditions. "deleteTime": "A String", # Output only. Time when this workstation cluster was soft-deleted. "displayName": "A String", # Optional. Human-readable name for this workstation cluster. - "domainConfig": { # Configuration options for a custom domain. # Optional. Configuration options for a custom domain. - "domain": "A String", # Immutable. Domain used by Workstations for HTTP ingress. + "domainConfig": { # Configuration options for private workstation clusters. # Optional. Configuration options for a custom domain. + "domain": "A String", # Immutable. Whether Workstations endpoint is private. }, "etag": "A String", # Optional. Checksum computed by the server. May be sent on update and delete requests to make sure that the client has an up-to-date value before proceeding. "labels": { # Optional. [Labels](https://cloud.google.com/workstations/docs/label-resources) that are applied to the workstation cluster and that are also propagated to the underlying Compute Engine resources. @@ -405,13 +405,13 @@

Method Details

}, "name": "A String", # Identifier. Full name of this workstation cluster. "network": "A String", # Immutable. Name of the Compute Engine network in which instances associated with this workstation cluster will be created. - "privateClusterConfig": { # Configuration options for private workstation clusters. # Optional. Configuration for private workstation cluster. - "allowedProjects": [ # Optional. Additional projects that are allowed to attach to the workstation cluster's service attachment. By default, the workstation cluster's project and the VPC host project (if different) are allowed. + "privateClusterConfig": { # Optional. Configuration for private workstation cluster. + "allowedProjects": [ "A String", ], - "clusterHostname": "A String", # Output only. Hostname for the workstation cluster. This field will be populated only when private endpoint is enabled. To access workstations in the workstation cluster, create a new DNS zone mapping this domain name to an internal IP address and a forwarding rule mapping that address to the service attachment. - "enablePrivateEndpoint": True or False, # Immutable. Whether Workstations endpoint is private. - "serviceAttachmentUri": "A String", # Output only. Service attachment URI for the workstation cluster. The service attachemnt is created when private endpoint is enabled. To access workstations in the workstation cluster, configure access to the managed service using [Private Service Connect](https://cloud.google.com/vpc/docs/configure-private-service-connect-services). + "clusterHostname": "A String", + "enablePrivateEndpoint": True or False, + "serviceAttachmentUri": "A String", }, "reconciling": True or False, # Output only. Indicates whether this workstation cluster is currently being updated to match its intended state. "subnetwork": "A String", # Immutable. Name of the Compute Engine subnetwork in which instances associated with this workstation cluster will be created. Must be part of the subnetwork specified for this workstation cluster. diff --git a/docs/dyn/workstations_v1.projects.locations.workstationClusters.workstationConfigs.html b/docs/dyn/workstations_v1.projects.locations.workstationClusters.workstationConfigs.html index 36d256e6d30..53cc3b669da 100644 --- a/docs/dyn/workstations_v1.projects.locations.workstationClusters.workstationConfigs.html +++ b/docs/dyn/workstations_v1.projects.locations.workstationClusters.workstationConfigs.html @@ -195,7 +195,7 @@

Method Details

}, "disablePublicIpAddresses": True or False, # Optional. When set to true, disables public IP addresses for VMs. If you disable public IP addresses, you must set up Private Google Access or Cloud NAT on your network. If you use Private Google Access and you use `private.googleapis.com` or `restricted.googleapis.com` for Container Registry and Artifact Registry, make sure that you set up DNS records for domains `*.gcr.io` and `*.pkg.dev`. Defaults to false (VMs have public IP addresses). "disableSsh": True or False, # Optional. Whether to disable SSH access to the VM. - "enableNestedVirtualization": True or False, # Optional. Whether to enable nested virtualization on Cloud Workstations VMs created using this workstation configuration. Nested virtualization lets you run virtual machine (VM) instances inside your workstation. Before enabling nested virtualization, consider the following important considerations. Cloud Workstations instances are subject to the [same restrictions as Compute Engine instances](https://cloud.google.com/compute/docs/instances/nested-virtualization/overview#restrictions): * **Organization policy**: projects, folders, or organizations may be restricted from creating nested VMs if the **Disable VM nested virtualization** constraint is enforced in the organization policy. For more information, see the Compute Engine section, [Checking whether nested virtualization is allowed](https://cloud.google.com/compute/docs/instances/nested-virtualization/managing-constraint#checking_whether_nested_virtualization_is_allowed). * **Performance**: nested VMs might experience a 10% or greater decrease in performance for workloads that are CPU-bound and possibly greater than a 10% decrease for workloads that are input/output bound. * **Machine Type**: nested virtualization can only be enabled on workstation configurations that specify a machine_type in the N1 or N2 machine series. * **GPUs**: nested virtualization may not be enabled on workstation configurations with accelerators. * **Operating System**: Because [Container-Optimized OS](https://cloud.google.com/compute/docs/images/os-details#container-optimized_os_cos) does not support nested virtualization, when nested virtualization is enabled, the underlying Compute Engine VM instances boot from an [Ubuntu LTS](https://cloud.google.com/compute/docs/images/os-details#ubuntu_lts) image. + "enableNestedVirtualization": True or False, # Optional. Whether to enable nested virtualization on Cloud Workstations VMs created using this workstation configuration. Nested virtualization lets you run virtual machine (VM) instances inside your workstation. Before enabling nested virtualization, consider the following important considerations. Cloud Workstations instances are subject to the [same restrictions as Compute Engine instances](https://cloud.google.com/compute/docs/instances/nested-virtualization/overview#restrictions): * **Organization policy**: projects, folders, or organizations may be restricted from creating nested VMs if the **Disable VM nested virtualization** constraint is enforced in the organization policy. For more information, see the Compute Engine section, [Checking whether nested virtualization is allowed](https://cloud.google.com/compute/docs/instances/nested-virtualization/managing-constraint#checking_whether_nested_virtualization_is_allowed). * **Performance**: nested VMs might experience a 10% or greater decrease in performance for workloads that are CPU-bound and possibly greater than a 10% decrease for workloads that are input/output bound. * **Machine Type**: nested virtualization can only be enabled on workstation configurations that specify a machine_type in the N1 or N2 machine series. * **GPUs**: nested virtualization may not be enabled on workstation configurations with accelerators. * **Operating System**: because [Container-Optimized OS](https://cloud.google.com/compute/docs/images/os-details#container-optimized_os_cos) does not support nested virtualization, when nested virtualization is enabled, the underlying Compute Engine VM instances boot from an [Ubuntu LTS](https://cloud.google.com/compute/docs/images/os-details#ubuntu_lts) image. "machineType": "A String", # Optional. The type of machine to use for VM instances—for example, `"e2-standard-4"`. For more information about machine types that Cloud Workstations supports, see the list of [available machine types](https://cloud.google.com/workstations/docs/available-machine-types). "poolSize": 42, # Optional. The number of VMs that the system should keep idle so that new workstations can be started quickly for new users. Defaults to `0` in the API. "pooledInstances": 42, # Output only. Number of instances currently available in the pool for faster workstation startup. @@ -393,7 +393,7 @@

Method Details

}, "disablePublicIpAddresses": True or False, # Optional. When set to true, disables public IP addresses for VMs. If you disable public IP addresses, you must set up Private Google Access or Cloud NAT on your network. If you use Private Google Access and you use `private.googleapis.com` or `restricted.googleapis.com` for Container Registry and Artifact Registry, make sure that you set up DNS records for domains `*.gcr.io` and `*.pkg.dev`. Defaults to false (VMs have public IP addresses). "disableSsh": True or False, # Optional. Whether to disable SSH access to the VM. - "enableNestedVirtualization": True or False, # Optional. Whether to enable nested virtualization on Cloud Workstations VMs created using this workstation configuration. Nested virtualization lets you run virtual machine (VM) instances inside your workstation. Before enabling nested virtualization, consider the following important considerations. Cloud Workstations instances are subject to the [same restrictions as Compute Engine instances](https://cloud.google.com/compute/docs/instances/nested-virtualization/overview#restrictions): * **Organization policy**: projects, folders, or organizations may be restricted from creating nested VMs if the **Disable VM nested virtualization** constraint is enforced in the organization policy. For more information, see the Compute Engine section, [Checking whether nested virtualization is allowed](https://cloud.google.com/compute/docs/instances/nested-virtualization/managing-constraint#checking_whether_nested_virtualization_is_allowed). * **Performance**: nested VMs might experience a 10% or greater decrease in performance for workloads that are CPU-bound and possibly greater than a 10% decrease for workloads that are input/output bound. * **Machine Type**: nested virtualization can only be enabled on workstation configurations that specify a machine_type in the N1 or N2 machine series. * **GPUs**: nested virtualization may not be enabled on workstation configurations with accelerators. * **Operating System**: Because [Container-Optimized OS](https://cloud.google.com/compute/docs/images/os-details#container-optimized_os_cos) does not support nested virtualization, when nested virtualization is enabled, the underlying Compute Engine VM instances boot from an [Ubuntu LTS](https://cloud.google.com/compute/docs/images/os-details#ubuntu_lts) image. + "enableNestedVirtualization": True or False, # Optional. Whether to enable nested virtualization on Cloud Workstations VMs created using this workstation configuration. Nested virtualization lets you run virtual machine (VM) instances inside your workstation. Before enabling nested virtualization, consider the following important considerations. Cloud Workstations instances are subject to the [same restrictions as Compute Engine instances](https://cloud.google.com/compute/docs/instances/nested-virtualization/overview#restrictions): * **Organization policy**: projects, folders, or organizations may be restricted from creating nested VMs if the **Disable VM nested virtualization** constraint is enforced in the organization policy. For more information, see the Compute Engine section, [Checking whether nested virtualization is allowed](https://cloud.google.com/compute/docs/instances/nested-virtualization/managing-constraint#checking_whether_nested_virtualization_is_allowed). * **Performance**: nested VMs might experience a 10% or greater decrease in performance for workloads that are CPU-bound and possibly greater than a 10% decrease for workloads that are input/output bound. * **Machine Type**: nested virtualization can only be enabled on workstation configurations that specify a machine_type in the N1 or N2 machine series. * **GPUs**: nested virtualization may not be enabled on workstation configurations with accelerators. * **Operating System**: because [Container-Optimized OS](https://cloud.google.com/compute/docs/images/os-details#container-optimized_os_cos) does not support nested virtualization, when nested virtualization is enabled, the underlying Compute Engine VM instances boot from an [Ubuntu LTS](https://cloud.google.com/compute/docs/images/os-details#ubuntu_lts) image. "machineType": "A String", # Optional. The type of machine to use for VM instances—for example, `"e2-standard-4"`. For more information about machine types that Cloud Workstations supports, see the list of [available machine types](https://cloud.google.com/workstations/docs/available-machine-types). "poolSize": 42, # Optional. The number of VMs that the system should keep idle so that new workstations can be started quickly for new users. Defaults to `0` in the API. "pooledInstances": 42, # Output only. Number of instances currently available in the pool for faster workstation startup. @@ -579,7 +579,7 @@

Method Details

}, "disablePublicIpAddresses": True or False, # Optional. When set to true, disables public IP addresses for VMs. If you disable public IP addresses, you must set up Private Google Access or Cloud NAT on your network. If you use Private Google Access and you use `private.googleapis.com` or `restricted.googleapis.com` for Container Registry and Artifact Registry, make sure that you set up DNS records for domains `*.gcr.io` and `*.pkg.dev`. Defaults to false (VMs have public IP addresses). "disableSsh": True or False, # Optional. Whether to disable SSH access to the VM. - "enableNestedVirtualization": True or False, # Optional. Whether to enable nested virtualization on Cloud Workstations VMs created using this workstation configuration. Nested virtualization lets you run virtual machine (VM) instances inside your workstation. Before enabling nested virtualization, consider the following important considerations. Cloud Workstations instances are subject to the [same restrictions as Compute Engine instances](https://cloud.google.com/compute/docs/instances/nested-virtualization/overview#restrictions): * **Organization policy**: projects, folders, or organizations may be restricted from creating nested VMs if the **Disable VM nested virtualization** constraint is enforced in the organization policy. For more information, see the Compute Engine section, [Checking whether nested virtualization is allowed](https://cloud.google.com/compute/docs/instances/nested-virtualization/managing-constraint#checking_whether_nested_virtualization_is_allowed). * **Performance**: nested VMs might experience a 10% or greater decrease in performance for workloads that are CPU-bound and possibly greater than a 10% decrease for workloads that are input/output bound. * **Machine Type**: nested virtualization can only be enabled on workstation configurations that specify a machine_type in the N1 or N2 machine series. * **GPUs**: nested virtualization may not be enabled on workstation configurations with accelerators. * **Operating System**: Because [Container-Optimized OS](https://cloud.google.com/compute/docs/images/os-details#container-optimized_os_cos) does not support nested virtualization, when nested virtualization is enabled, the underlying Compute Engine VM instances boot from an [Ubuntu LTS](https://cloud.google.com/compute/docs/images/os-details#ubuntu_lts) image. + "enableNestedVirtualization": True or False, # Optional. Whether to enable nested virtualization on Cloud Workstations VMs created using this workstation configuration. Nested virtualization lets you run virtual machine (VM) instances inside your workstation. Before enabling nested virtualization, consider the following important considerations. Cloud Workstations instances are subject to the [same restrictions as Compute Engine instances](https://cloud.google.com/compute/docs/instances/nested-virtualization/overview#restrictions): * **Organization policy**: projects, folders, or organizations may be restricted from creating nested VMs if the **Disable VM nested virtualization** constraint is enforced in the organization policy. For more information, see the Compute Engine section, [Checking whether nested virtualization is allowed](https://cloud.google.com/compute/docs/instances/nested-virtualization/managing-constraint#checking_whether_nested_virtualization_is_allowed). * **Performance**: nested VMs might experience a 10% or greater decrease in performance for workloads that are CPU-bound and possibly greater than a 10% decrease for workloads that are input/output bound. * **Machine Type**: nested virtualization can only be enabled on workstation configurations that specify a machine_type in the N1 or N2 machine series. * **GPUs**: nested virtualization may not be enabled on workstation configurations with accelerators. * **Operating System**: because [Container-Optimized OS](https://cloud.google.com/compute/docs/images/os-details#container-optimized_os_cos) does not support nested virtualization, when nested virtualization is enabled, the underlying Compute Engine VM instances boot from an [Ubuntu LTS](https://cloud.google.com/compute/docs/images/os-details#ubuntu_lts) image. "machineType": "A String", # Optional. The type of machine to use for VM instances—for example, `"e2-standard-4"`. For more information about machine types that Cloud Workstations supports, see the list of [available machine types](https://cloud.google.com/workstations/docs/available-machine-types). "poolSize": 42, # Optional. The number of VMs that the system should keep idle so that new workstations can be started quickly for new users. Defaults to `0` in the API. "pooledInstances": 42, # Output only. Number of instances currently available in the pool for faster workstation startup. @@ -719,7 +719,7 @@

Method Details

}, "disablePublicIpAddresses": True or False, # Optional. When set to true, disables public IP addresses for VMs. If you disable public IP addresses, you must set up Private Google Access or Cloud NAT on your network. If you use Private Google Access and you use `private.googleapis.com` or `restricted.googleapis.com` for Container Registry and Artifact Registry, make sure that you set up DNS records for domains `*.gcr.io` and `*.pkg.dev`. Defaults to false (VMs have public IP addresses). "disableSsh": True or False, # Optional. Whether to disable SSH access to the VM. - "enableNestedVirtualization": True or False, # Optional. Whether to enable nested virtualization on Cloud Workstations VMs created using this workstation configuration. Nested virtualization lets you run virtual machine (VM) instances inside your workstation. Before enabling nested virtualization, consider the following important considerations. Cloud Workstations instances are subject to the [same restrictions as Compute Engine instances](https://cloud.google.com/compute/docs/instances/nested-virtualization/overview#restrictions): * **Organization policy**: projects, folders, or organizations may be restricted from creating nested VMs if the **Disable VM nested virtualization** constraint is enforced in the organization policy. For more information, see the Compute Engine section, [Checking whether nested virtualization is allowed](https://cloud.google.com/compute/docs/instances/nested-virtualization/managing-constraint#checking_whether_nested_virtualization_is_allowed). * **Performance**: nested VMs might experience a 10% or greater decrease in performance for workloads that are CPU-bound and possibly greater than a 10% decrease for workloads that are input/output bound. * **Machine Type**: nested virtualization can only be enabled on workstation configurations that specify a machine_type in the N1 or N2 machine series. * **GPUs**: nested virtualization may not be enabled on workstation configurations with accelerators. * **Operating System**: Because [Container-Optimized OS](https://cloud.google.com/compute/docs/images/os-details#container-optimized_os_cos) does not support nested virtualization, when nested virtualization is enabled, the underlying Compute Engine VM instances boot from an [Ubuntu LTS](https://cloud.google.com/compute/docs/images/os-details#ubuntu_lts) image. + "enableNestedVirtualization": True or False, # Optional. Whether to enable nested virtualization on Cloud Workstations VMs created using this workstation configuration. Nested virtualization lets you run virtual machine (VM) instances inside your workstation. Before enabling nested virtualization, consider the following important considerations. Cloud Workstations instances are subject to the [same restrictions as Compute Engine instances](https://cloud.google.com/compute/docs/instances/nested-virtualization/overview#restrictions): * **Organization policy**: projects, folders, or organizations may be restricted from creating nested VMs if the **Disable VM nested virtualization** constraint is enforced in the organization policy. For more information, see the Compute Engine section, [Checking whether nested virtualization is allowed](https://cloud.google.com/compute/docs/instances/nested-virtualization/managing-constraint#checking_whether_nested_virtualization_is_allowed). * **Performance**: nested VMs might experience a 10% or greater decrease in performance for workloads that are CPU-bound and possibly greater than a 10% decrease for workloads that are input/output bound. * **Machine Type**: nested virtualization can only be enabled on workstation configurations that specify a machine_type in the N1 or N2 machine series. * **GPUs**: nested virtualization may not be enabled on workstation configurations with accelerators. * **Operating System**: because [Container-Optimized OS](https://cloud.google.com/compute/docs/images/os-details#container-optimized_os_cos) does not support nested virtualization, when nested virtualization is enabled, the underlying Compute Engine VM instances boot from an [Ubuntu LTS](https://cloud.google.com/compute/docs/images/os-details#ubuntu_lts) image. "machineType": "A String", # Optional. The type of machine to use for VM instances—for example, `"e2-standard-4"`. For more information about machine types that Cloud Workstations supports, see the list of [available machine types](https://cloud.google.com/workstations/docs/available-machine-types). "poolSize": 42, # Optional. The number of VMs that the system should keep idle so that new workstations can be started quickly for new users. Defaults to `0` in the API. "pooledInstances": 42, # Output only. Number of instances currently available in the pool for faster workstation startup. @@ -874,7 +874,7 @@

Method Details

}, "disablePublicIpAddresses": True or False, # Optional. When set to true, disables public IP addresses for VMs. If you disable public IP addresses, you must set up Private Google Access or Cloud NAT on your network. If you use Private Google Access and you use `private.googleapis.com` or `restricted.googleapis.com` for Container Registry and Artifact Registry, make sure that you set up DNS records for domains `*.gcr.io` and `*.pkg.dev`. Defaults to false (VMs have public IP addresses). "disableSsh": True or False, # Optional. Whether to disable SSH access to the VM. - "enableNestedVirtualization": True or False, # Optional. Whether to enable nested virtualization on Cloud Workstations VMs created using this workstation configuration. Nested virtualization lets you run virtual machine (VM) instances inside your workstation. Before enabling nested virtualization, consider the following important considerations. Cloud Workstations instances are subject to the [same restrictions as Compute Engine instances](https://cloud.google.com/compute/docs/instances/nested-virtualization/overview#restrictions): * **Organization policy**: projects, folders, or organizations may be restricted from creating nested VMs if the **Disable VM nested virtualization** constraint is enforced in the organization policy. For more information, see the Compute Engine section, [Checking whether nested virtualization is allowed](https://cloud.google.com/compute/docs/instances/nested-virtualization/managing-constraint#checking_whether_nested_virtualization_is_allowed). * **Performance**: nested VMs might experience a 10% or greater decrease in performance for workloads that are CPU-bound and possibly greater than a 10% decrease for workloads that are input/output bound. * **Machine Type**: nested virtualization can only be enabled on workstation configurations that specify a machine_type in the N1 or N2 machine series. * **GPUs**: nested virtualization may not be enabled on workstation configurations with accelerators. * **Operating System**: Because [Container-Optimized OS](https://cloud.google.com/compute/docs/images/os-details#container-optimized_os_cos) does not support nested virtualization, when nested virtualization is enabled, the underlying Compute Engine VM instances boot from an [Ubuntu LTS](https://cloud.google.com/compute/docs/images/os-details#ubuntu_lts) image. + "enableNestedVirtualization": True or False, # Optional. Whether to enable nested virtualization on Cloud Workstations VMs created using this workstation configuration. Nested virtualization lets you run virtual machine (VM) instances inside your workstation. Before enabling nested virtualization, consider the following important considerations. Cloud Workstations instances are subject to the [same restrictions as Compute Engine instances](https://cloud.google.com/compute/docs/instances/nested-virtualization/overview#restrictions): * **Organization policy**: projects, folders, or organizations may be restricted from creating nested VMs if the **Disable VM nested virtualization** constraint is enforced in the organization policy. For more information, see the Compute Engine section, [Checking whether nested virtualization is allowed](https://cloud.google.com/compute/docs/instances/nested-virtualization/managing-constraint#checking_whether_nested_virtualization_is_allowed). * **Performance**: nested VMs might experience a 10% or greater decrease in performance for workloads that are CPU-bound and possibly greater than a 10% decrease for workloads that are input/output bound. * **Machine Type**: nested virtualization can only be enabled on workstation configurations that specify a machine_type in the N1 or N2 machine series. * **GPUs**: nested virtualization may not be enabled on workstation configurations with accelerators. * **Operating System**: because [Container-Optimized OS](https://cloud.google.com/compute/docs/images/os-details#container-optimized_os_cos) does not support nested virtualization, when nested virtualization is enabled, the underlying Compute Engine VM instances boot from an [Ubuntu LTS](https://cloud.google.com/compute/docs/images/os-details#ubuntu_lts) image. "machineType": "A String", # Optional. The type of machine to use for VM instances—for example, `"e2-standard-4"`. For more information about machine types that Cloud Workstations supports, see the list of [available machine types](https://cloud.google.com/workstations/docs/available-machine-types). "poolSize": 42, # Optional. The number of VMs that the system should keep idle so that new workstations can be started quickly for new users. Defaults to `0` in the API. "pooledInstances": 42, # Output only. Number of instances currently available in the pool for faster workstation startup. diff --git a/docs/dyn/workstations_v1beta.projects.locations.workstationClusters.html b/docs/dyn/workstations_v1beta.projects.locations.workstationClusters.html index b8b4129618c..b3805f1a36f 100644 --- a/docs/dyn/workstations_v1beta.projects.locations.workstationClusters.html +++ b/docs/dyn/workstations_v1beta.projects.locations.workstationClusters.html @@ -135,8 +135,8 @@

Method Details

"degraded": True or False, # Output only. Whether this workstation cluster is in degraded mode, in which case it may require user action to restore full functionality. Details can be found in conditions. "deleteTime": "A String", # Output only. Time when this workstation cluster was soft-deleted. "displayName": "A String", # Optional. Human-readable name for this workstation cluster. - "domainConfig": { # Configuration options for a custom domain. # Optional. Configuration options for a custom domain. - "domain": "A String", # Immutable. Domain used by Workstations for HTTP ingress. + "domainConfig": { # Configuration options for private workstation clusters. # Optional. Configuration options for a custom domain. + "domain": "A String", # Immutable. Whether Workstations endpoint is private. }, "etag": "A String", # Optional. Checksum computed by the server. May be sent on update and delete requests to make sure that the client has an up-to-date value before proceeding. "labels": { # Optional. [Labels](https://cloud.google.com/workstations/docs/label-resources) that are applied to the workstation cluster and that are also propagated to the underlying Compute Engine resources. @@ -144,13 +144,13 @@

Method Details

}, "name": "A String", # Identifier. Full name of this workstation cluster. "network": "A String", # Immutable. Name of the Compute Engine network in which instances associated with this workstation cluster will be created. - "privateClusterConfig": { # Configuration options for private workstation clusters. # Optional. Configuration for private workstation cluster. - "allowedProjects": [ # Optional. Additional projects that are allowed to attach to the workstation cluster's service attachment. By default, the workstation cluster's project and the VPC host project (if different) are allowed. + "privateClusterConfig": { # Optional. Configuration for private workstation cluster. + "allowedProjects": [ "A String", ], - "clusterHostname": "A String", # Output only. Hostname for the workstation cluster. This field will be populated only when private endpoint is enabled. To access workstations in the workstation cluster, create a new DNS zone mapping this domain name to an internal IP address and a forwarding rule mapping that address to the service attachment. - "enablePrivateEndpoint": True or False, # Immutable. Whether Workstations endpoint is private. - "serviceAttachmentUri": "A String", # Output only. Service attachment URI for the workstation cluster. The service attachemnt is created when private endpoint is enabled. To access workstations in the workstation cluster, configure access to the managed service using [Private Service Connect](https://cloud.google.com/vpc/docs/configure-private-service-connect-services). + "clusterHostname": "A String", + "enablePrivateEndpoint": True or False, + "serviceAttachmentUri": "A String", }, "reconciling": True or False, # Output only. Indicates whether this workstation cluster is currently being updated to match its intended state. "subnetwork": "A String", # Immutable. Name of the Compute Engine subnetwork in which instances associated with this workstation cluster will be created. Must be part of the subnetwork specified for this workstation cluster. @@ -261,8 +261,8 @@

Method Details

"degraded": True or False, # Output only. Whether this workstation cluster is in degraded mode, in which case it may require user action to restore full functionality. Details can be found in conditions. "deleteTime": "A String", # Output only. Time when this workstation cluster was soft-deleted. "displayName": "A String", # Optional. Human-readable name for this workstation cluster. - "domainConfig": { # Configuration options for a custom domain. # Optional. Configuration options for a custom domain. - "domain": "A String", # Immutable. Domain used by Workstations for HTTP ingress. + "domainConfig": { # Configuration options for private workstation clusters. # Optional. Configuration options for a custom domain. + "domain": "A String", # Immutable. Whether Workstations endpoint is private. }, "etag": "A String", # Optional. Checksum computed by the server. May be sent on update and delete requests to make sure that the client has an up-to-date value before proceeding. "labels": { # Optional. [Labels](https://cloud.google.com/workstations/docs/label-resources) that are applied to the workstation cluster and that are also propagated to the underlying Compute Engine resources. @@ -270,13 +270,13 @@

Method Details

}, "name": "A String", # Identifier. Full name of this workstation cluster. "network": "A String", # Immutable. Name of the Compute Engine network in which instances associated with this workstation cluster will be created. - "privateClusterConfig": { # Configuration options for private workstation clusters. # Optional. Configuration for private workstation cluster. - "allowedProjects": [ # Optional. Additional projects that are allowed to attach to the workstation cluster's service attachment. By default, the workstation cluster's project and the VPC host project (if different) are allowed. + "privateClusterConfig": { # Optional. Configuration for private workstation cluster. + "allowedProjects": [ "A String", ], - "clusterHostname": "A String", # Output only. Hostname for the workstation cluster. This field will be populated only when private endpoint is enabled. To access workstations in the workstation cluster, create a new DNS zone mapping this domain name to an internal IP address and a forwarding rule mapping that address to the service attachment. - "enablePrivateEndpoint": True or False, # Immutable. Whether Workstations endpoint is private. - "serviceAttachmentUri": "A String", # Output only. Service attachment URI for the workstation cluster. The service attachemnt is created when private endpoint is enabled. To access workstations in the workstation cluster, configure access to the managed service using [Private Service Connect](https://cloud.google.com/vpc/docs/configure-private-service-connect-services). + "clusterHostname": "A String", + "enablePrivateEndpoint": True or False, + "serviceAttachmentUri": "A String", }, "reconciling": True or False, # Output only. Indicates whether this workstation cluster is currently being updated to match its intended state. "subnetwork": "A String", # Immutable. Name of the Compute Engine subnetwork in which instances associated with this workstation cluster will be created. Must be part of the subnetwork specified for this workstation cluster. @@ -327,8 +327,8 @@

Method Details

"degraded": True or False, # Output only. Whether this workstation cluster is in degraded mode, in which case it may require user action to restore full functionality. Details can be found in conditions. "deleteTime": "A String", # Output only. Time when this workstation cluster was soft-deleted. "displayName": "A String", # Optional. Human-readable name for this workstation cluster. - "domainConfig": { # Configuration options for a custom domain. # Optional. Configuration options for a custom domain. - "domain": "A String", # Immutable. Domain used by Workstations for HTTP ingress. + "domainConfig": { # Configuration options for private workstation clusters. # Optional. Configuration options for a custom domain. + "domain": "A String", # Immutable. Whether Workstations endpoint is private. }, "etag": "A String", # Optional. Checksum computed by the server. May be sent on update and delete requests to make sure that the client has an up-to-date value before proceeding. "labels": { # Optional. [Labels](https://cloud.google.com/workstations/docs/label-resources) that are applied to the workstation cluster and that are also propagated to the underlying Compute Engine resources. @@ -336,13 +336,13 @@

Method Details

}, "name": "A String", # Identifier. Full name of this workstation cluster. "network": "A String", # Immutable. Name of the Compute Engine network in which instances associated with this workstation cluster will be created. - "privateClusterConfig": { # Configuration options for private workstation clusters. # Optional. Configuration for private workstation cluster. - "allowedProjects": [ # Optional. Additional projects that are allowed to attach to the workstation cluster's service attachment. By default, the workstation cluster's project and the VPC host project (if different) are allowed. + "privateClusterConfig": { # Optional. Configuration for private workstation cluster. + "allowedProjects": [ "A String", ], - "clusterHostname": "A String", # Output only. Hostname for the workstation cluster. This field will be populated only when private endpoint is enabled. To access workstations in the workstation cluster, create a new DNS zone mapping this domain name to an internal IP address and a forwarding rule mapping that address to the service attachment. - "enablePrivateEndpoint": True or False, # Immutable. Whether Workstations endpoint is private. - "serviceAttachmentUri": "A String", # Output only. Service attachment URI for the workstation cluster. The service attachemnt is created when private endpoint is enabled. To access workstations in the workstation cluster, configure access to the managed service using [Private Service Connect](https://cloud.google.com/vpc/docs/configure-private-service-connect-services). + "clusterHostname": "A String", + "enablePrivateEndpoint": True or False, + "serviceAttachmentUri": "A String", }, "reconciling": True or False, # Output only. Indicates whether this workstation cluster is currently being updated to match its intended state. "subnetwork": "A String", # Immutable. Name of the Compute Engine subnetwork in which instances associated with this workstation cluster will be created. Must be part of the subnetwork specified for this workstation cluster. @@ -396,8 +396,8 @@

Method Details

"degraded": True or False, # Output only. Whether this workstation cluster is in degraded mode, in which case it may require user action to restore full functionality. Details can be found in conditions. "deleteTime": "A String", # Output only. Time when this workstation cluster was soft-deleted. "displayName": "A String", # Optional. Human-readable name for this workstation cluster. - "domainConfig": { # Configuration options for a custom domain. # Optional. Configuration options for a custom domain. - "domain": "A String", # Immutable. Domain used by Workstations for HTTP ingress. + "domainConfig": { # Configuration options for private workstation clusters. # Optional. Configuration options for a custom domain. + "domain": "A String", # Immutable. Whether Workstations endpoint is private. }, "etag": "A String", # Optional. Checksum computed by the server. May be sent on update and delete requests to make sure that the client has an up-to-date value before proceeding. "labels": { # Optional. [Labels](https://cloud.google.com/workstations/docs/label-resources) that are applied to the workstation cluster and that are also propagated to the underlying Compute Engine resources. @@ -405,13 +405,13 @@

Method Details

}, "name": "A String", # Identifier. Full name of this workstation cluster. "network": "A String", # Immutable. Name of the Compute Engine network in which instances associated with this workstation cluster will be created. - "privateClusterConfig": { # Configuration options for private workstation clusters. # Optional. Configuration for private workstation cluster. - "allowedProjects": [ # Optional. Additional projects that are allowed to attach to the workstation cluster's service attachment. By default, the workstation cluster's project and the VPC host project (if different) are allowed. + "privateClusterConfig": { # Optional. Configuration for private workstation cluster. + "allowedProjects": [ "A String", ], - "clusterHostname": "A String", # Output only. Hostname for the workstation cluster. This field will be populated only when private endpoint is enabled. To access workstations in the workstation cluster, create a new DNS zone mapping this domain name to an internal IP address and a forwarding rule mapping that address to the service attachment. - "enablePrivateEndpoint": True or False, # Immutable. Whether Workstations endpoint is private. - "serviceAttachmentUri": "A String", # Output only. Service attachment URI for the workstation cluster. The service attachemnt is created when private endpoint is enabled. To access workstations in the workstation cluster, configure access to the managed service using [Private Service Connect](https://cloud.google.com/vpc/docs/configure-private-service-connect-services). + "clusterHostname": "A String", + "enablePrivateEndpoint": True or False, + "serviceAttachmentUri": "A String", }, "reconciling": True or False, # Output only. Indicates whether this workstation cluster is currently being updated to match its intended state. "subnetwork": "A String", # Immutable. Name of the Compute Engine subnetwork in which instances associated with this workstation cluster will be created. Must be part of the subnetwork specified for this workstation cluster. diff --git a/docs/dyn/workstations_v1beta.projects.locations.workstationClusters.workstationConfigs.html b/docs/dyn/workstations_v1beta.projects.locations.workstationClusters.workstationConfigs.html index 1add550fc41..c3ca975c469 100644 --- a/docs/dyn/workstations_v1beta.projects.locations.workstationClusters.workstationConfigs.html +++ b/docs/dyn/workstations_v1beta.projects.locations.workstationClusters.workstationConfigs.html @@ -131,8 +131,8 @@

Method Details

The object takes the form of: { # A workstation configuration resource in the Cloud Workstations API. Workstation configurations act as templates for workstations. The workstation configuration defines details such as the workstation virtual machine (VM) instance type, persistent storage, container image defining environment, which IDE or Code Editor to use, and more. Administrators and platform teams can also use [Identity and Access Management (IAM)](https://cloud.google.com/iam/docs/overview) rules to grant access to teams or to individual developers. - "allowedPorts": [ # Optional. Single or Range of ports externally accessible in the workstation. If not specified defaults to ports 22, 80 and ports 1024-65535. - { # A PortsConfig defines a range of ports. Both first and last are inclusive. To specify a single port, both first and last should be same. + "allowedPorts": [ # Optional. A Single or Range of ports externally accessible in the workstation. If not specified defaults to ports 22, 80 and ports 1024-65535. + { # A PortsConfig defines a range of ports. Both first and last are inclusive. To specify a single port, both first and last should be the same. "first": 42, # Required. Starting port number for the current range of ports. "last": 42, # Required. Ending port number for the current range of ports. }, @@ -216,7 +216,7 @@

Method Details

}, "disablePublicIpAddresses": True or False, # Optional. When set to true, disables public IP addresses for VMs. If you disable public IP addresses, you must set up Private Google Access or Cloud NAT on your network. If you use Private Google Access and you use `private.googleapis.com` or `restricted.googleapis.com` for Container Registry and Artifact Registry, make sure that you set up DNS records for domains `*.gcr.io` and `*.pkg.dev`. Defaults to false (VMs have public IP addresses). "disableSsh": True or False, # Optional. Whether to disable SSH access to the VM. - "enableNestedVirtualization": True or False, # Optional. Whether to enable nested virtualization on Cloud Workstations VMs created using this workstation configuration. Nested virtualization lets you run virtual machine (VM) instances inside your workstation. Before enabling nested virtualization, consider the following important considerations. Cloud Workstations instances are subject to the [same restrictions as Compute Engine instances](https://cloud.google.com/compute/docs/instances/nested-virtualization/overview#restrictions): * **Organization policy**: projects, folders, or organizations may be restricted from creating nested VMs if the **Disable VM nested virtualization** constraint is enforced in the organization policy. For more information, see the Compute Engine section, [Checking whether nested virtualization is allowed](https://cloud.google.com/compute/docs/instances/nested-virtualization/managing-constraint#checking_whether_nested_virtualization_is_allowed). * **Performance**: nested VMs might experience a 10% or greater decrease in performance for workloads that are CPU-bound and possibly greater than a 10% decrease for workloads that are input/output bound. * **Machine Type**: nested virtualization can only be enabled on workstation configurations that specify a machine_type in the N1 or N2 machine series. * **GPUs**: nested virtualization may not be enabled on workstation configurations with accelerators. * **Operating System**: Because [Container-Optimized OS](https://cloud.google.com/compute/docs/images/os-details#container-optimized_os_cos) does not support nested virtualization, when nested virtualization is enabled, the underlying Compute Engine VM instances boot from an [Ubuntu LTS](https://cloud.google.com/compute/docs/images/os-details#ubuntu_lts) image. + "enableNestedVirtualization": True or False, # Optional. Whether to enable nested virtualization on Cloud Workstations VMs created using this workstation configuration. Nested virtualization lets you run virtual machine (VM) instances inside your workstation. Before enabling nested virtualization, consider the following important considerations. Cloud Workstations instances are subject to the [same restrictions as Compute Engine instances](https://cloud.google.com/compute/docs/instances/nested-virtualization/overview#restrictions): * **Organization policy**: projects, folders, or organizations may be restricted from creating nested VMs if the **Disable VM nested virtualization** constraint is enforced in the organization policy. For more information, see the Compute Engine section, [Checking whether nested virtualization is allowed](https://cloud.google.com/compute/docs/instances/nested-virtualization/managing-constraint#checking_whether_nested_virtualization_is_allowed). * **Performance**: nested VMs might experience a 10% or greater decrease in performance for workloads that are CPU-bound and possibly greater than a 10% decrease for workloads that are input/output bound. * **Machine Type**: nested virtualization can only be enabled on workstation configurations that specify a machine_type in the N1 or N2 machine series. * **GPUs**: nested virtualization may not be enabled on workstation configurations with accelerators. * **Operating System**: because [Container-Optimized OS](https://cloud.google.com/compute/docs/images/os-details#container-optimized_os_cos) does not support nested virtualization, when nested virtualization is enabled, the underlying Compute Engine VM instances boot from an [Ubuntu LTS](https://cloud.google.com/compute/docs/images/os-details#ubuntu_lts) image. "machineType": "A String", # Optional. The type of machine to use for VM instances—for example, `"e2-standard-4"`. For more information about machine types that Cloud Workstations supports, see the list of [available machine types](https://cloud.google.com/workstations/docs/available-machine-types). "poolSize": 42, # Optional. The number of VMs that the system should keep idle so that new workstations can be started quickly for new users. Defaults to `0` in the API. "pooledInstances": 42, # Output only. Number of instances currently available in the pool for faster workstation startup. @@ -353,8 +353,8 @@

Method Details

An object of the form: { # A workstation configuration resource in the Cloud Workstations API. Workstation configurations act as templates for workstations. The workstation configuration defines details such as the workstation virtual machine (VM) instance type, persistent storage, container image defining environment, which IDE or Code Editor to use, and more. Administrators and platform teams can also use [Identity and Access Management (IAM)](https://cloud.google.com/iam/docs/overview) rules to grant access to teams or to individual developers. - "allowedPorts": [ # Optional. Single or Range of ports externally accessible in the workstation. If not specified defaults to ports 22, 80 and ports 1024-65535. - { # A PortsConfig defines a range of ports. Both first and last are inclusive. To specify a single port, both first and last should be same. + "allowedPorts": [ # Optional. A Single or Range of ports externally accessible in the workstation. If not specified defaults to ports 22, 80 and ports 1024-65535. + { # A PortsConfig defines a range of ports. Both first and last are inclusive. To specify a single port, both first and last should be the same. "first": 42, # Required. Starting port number for the current range of ports. "last": 42, # Required. Ending port number for the current range of ports. }, @@ -438,7 +438,7 @@

Method Details

}, "disablePublicIpAddresses": True or False, # Optional. When set to true, disables public IP addresses for VMs. If you disable public IP addresses, you must set up Private Google Access or Cloud NAT on your network. If you use Private Google Access and you use `private.googleapis.com` or `restricted.googleapis.com` for Container Registry and Artifact Registry, make sure that you set up DNS records for domains `*.gcr.io` and `*.pkg.dev`. Defaults to false (VMs have public IP addresses). "disableSsh": True or False, # Optional. Whether to disable SSH access to the VM. - "enableNestedVirtualization": True or False, # Optional. Whether to enable nested virtualization on Cloud Workstations VMs created using this workstation configuration. Nested virtualization lets you run virtual machine (VM) instances inside your workstation. Before enabling nested virtualization, consider the following important considerations. Cloud Workstations instances are subject to the [same restrictions as Compute Engine instances](https://cloud.google.com/compute/docs/instances/nested-virtualization/overview#restrictions): * **Organization policy**: projects, folders, or organizations may be restricted from creating nested VMs if the **Disable VM nested virtualization** constraint is enforced in the organization policy. For more information, see the Compute Engine section, [Checking whether nested virtualization is allowed](https://cloud.google.com/compute/docs/instances/nested-virtualization/managing-constraint#checking_whether_nested_virtualization_is_allowed). * **Performance**: nested VMs might experience a 10% or greater decrease in performance for workloads that are CPU-bound and possibly greater than a 10% decrease for workloads that are input/output bound. * **Machine Type**: nested virtualization can only be enabled on workstation configurations that specify a machine_type in the N1 or N2 machine series. * **GPUs**: nested virtualization may not be enabled on workstation configurations with accelerators. * **Operating System**: Because [Container-Optimized OS](https://cloud.google.com/compute/docs/images/os-details#container-optimized_os_cos) does not support nested virtualization, when nested virtualization is enabled, the underlying Compute Engine VM instances boot from an [Ubuntu LTS](https://cloud.google.com/compute/docs/images/os-details#ubuntu_lts) image. + "enableNestedVirtualization": True or False, # Optional. Whether to enable nested virtualization on Cloud Workstations VMs created using this workstation configuration. Nested virtualization lets you run virtual machine (VM) instances inside your workstation. Before enabling nested virtualization, consider the following important considerations. Cloud Workstations instances are subject to the [same restrictions as Compute Engine instances](https://cloud.google.com/compute/docs/instances/nested-virtualization/overview#restrictions): * **Organization policy**: projects, folders, or organizations may be restricted from creating nested VMs if the **Disable VM nested virtualization** constraint is enforced in the organization policy. For more information, see the Compute Engine section, [Checking whether nested virtualization is allowed](https://cloud.google.com/compute/docs/instances/nested-virtualization/managing-constraint#checking_whether_nested_virtualization_is_allowed). * **Performance**: nested VMs might experience a 10% or greater decrease in performance for workloads that are CPU-bound and possibly greater than a 10% decrease for workloads that are input/output bound. * **Machine Type**: nested virtualization can only be enabled on workstation configurations that specify a machine_type in the N1 or N2 machine series. * **GPUs**: nested virtualization may not be enabled on workstation configurations with accelerators. * **Operating System**: because [Container-Optimized OS](https://cloud.google.com/compute/docs/images/os-details#container-optimized_os_cos) does not support nested virtualization, when nested virtualization is enabled, the underlying Compute Engine VM instances boot from an [Ubuntu LTS](https://cloud.google.com/compute/docs/images/os-details#ubuntu_lts) image. "machineType": "A String", # Optional. The type of machine to use for VM instances—for example, `"e2-standard-4"`. For more information about machine types that Cloud Workstations supports, see the list of [available machine types](https://cloud.google.com/workstations/docs/available-machine-types). "poolSize": 42, # Optional. The number of VMs that the system should keep idle so that new workstations can be started quickly for new users. Defaults to `0` in the API. "pooledInstances": 42, # Output only. Number of instances currently available in the pool for faster workstation startup. @@ -563,8 +563,8 @@

Method Details

], "workstationConfigs": [ # The requested configs. { # A workstation configuration resource in the Cloud Workstations API. Workstation configurations act as templates for workstations. The workstation configuration defines details such as the workstation virtual machine (VM) instance type, persistent storage, container image defining environment, which IDE or Code Editor to use, and more. Administrators and platform teams can also use [Identity and Access Management (IAM)](https://cloud.google.com/iam/docs/overview) rules to grant access to teams or to individual developers. - "allowedPorts": [ # Optional. Single or Range of ports externally accessible in the workstation. If not specified defaults to ports 22, 80 and ports 1024-65535. - { # A PortsConfig defines a range of ports. Both first and last are inclusive. To specify a single port, both first and last should be same. + "allowedPorts": [ # Optional. A Single or Range of ports externally accessible in the workstation. If not specified defaults to ports 22, 80 and ports 1024-65535. + { # A PortsConfig defines a range of ports. Both first and last are inclusive. To specify a single port, both first and last should be the same. "first": 42, # Required. Starting port number for the current range of ports. "last": 42, # Required. Ending port number for the current range of ports. }, @@ -648,7 +648,7 @@

Method Details

}, "disablePublicIpAddresses": True or False, # Optional. When set to true, disables public IP addresses for VMs. If you disable public IP addresses, you must set up Private Google Access or Cloud NAT on your network. If you use Private Google Access and you use `private.googleapis.com` or `restricted.googleapis.com` for Container Registry and Artifact Registry, make sure that you set up DNS records for domains `*.gcr.io` and `*.pkg.dev`. Defaults to false (VMs have public IP addresses). "disableSsh": True or False, # Optional. Whether to disable SSH access to the VM. - "enableNestedVirtualization": True or False, # Optional. Whether to enable nested virtualization on Cloud Workstations VMs created using this workstation configuration. Nested virtualization lets you run virtual machine (VM) instances inside your workstation. Before enabling nested virtualization, consider the following important considerations. Cloud Workstations instances are subject to the [same restrictions as Compute Engine instances](https://cloud.google.com/compute/docs/instances/nested-virtualization/overview#restrictions): * **Organization policy**: projects, folders, or organizations may be restricted from creating nested VMs if the **Disable VM nested virtualization** constraint is enforced in the organization policy. For more information, see the Compute Engine section, [Checking whether nested virtualization is allowed](https://cloud.google.com/compute/docs/instances/nested-virtualization/managing-constraint#checking_whether_nested_virtualization_is_allowed). * **Performance**: nested VMs might experience a 10% or greater decrease in performance for workloads that are CPU-bound and possibly greater than a 10% decrease for workloads that are input/output bound. * **Machine Type**: nested virtualization can only be enabled on workstation configurations that specify a machine_type in the N1 or N2 machine series. * **GPUs**: nested virtualization may not be enabled on workstation configurations with accelerators. * **Operating System**: Because [Container-Optimized OS](https://cloud.google.com/compute/docs/images/os-details#container-optimized_os_cos) does not support nested virtualization, when nested virtualization is enabled, the underlying Compute Engine VM instances boot from an [Ubuntu LTS](https://cloud.google.com/compute/docs/images/os-details#ubuntu_lts) image. + "enableNestedVirtualization": True or False, # Optional. Whether to enable nested virtualization on Cloud Workstations VMs created using this workstation configuration. Nested virtualization lets you run virtual machine (VM) instances inside your workstation. Before enabling nested virtualization, consider the following important considerations. Cloud Workstations instances are subject to the [same restrictions as Compute Engine instances](https://cloud.google.com/compute/docs/instances/nested-virtualization/overview#restrictions): * **Organization policy**: projects, folders, or organizations may be restricted from creating nested VMs if the **Disable VM nested virtualization** constraint is enforced in the organization policy. For more information, see the Compute Engine section, [Checking whether nested virtualization is allowed](https://cloud.google.com/compute/docs/instances/nested-virtualization/managing-constraint#checking_whether_nested_virtualization_is_allowed). * **Performance**: nested VMs might experience a 10% or greater decrease in performance for workloads that are CPU-bound and possibly greater than a 10% decrease for workloads that are input/output bound. * **Machine Type**: nested virtualization can only be enabled on workstation configurations that specify a machine_type in the N1 or N2 machine series. * **GPUs**: nested virtualization may not be enabled on workstation configurations with accelerators. * **Operating System**: because [Container-Optimized OS](https://cloud.google.com/compute/docs/images/os-details#container-optimized_os_cos) does not support nested virtualization, when nested virtualization is enabled, the underlying Compute Engine VM instances boot from an [Ubuntu LTS](https://cloud.google.com/compute/docs/images/os-details#ubuntu_lts) image. "machineType": "A String", # Optional. The type of machine to use for VM instances—for example, `"e2-standard-4"`. For more information about machine types that Cloud Workstations supports, see the list of [available machine types](https://cloud.google.com/workstations/docs/available-machine-types). "poolSize": 42, # Optional. The number of VMs that the system should keep idle so that new workstations can be started quickly for new users. Defaults to `0` in the API. "pooledInstances": 42, # Output only. Number of instances currently available in the pool for faster workstation startup. @@ -727,8 +727,8 @@

Method Details

], "workstationConfigs": [ # The requested configs. { # A workstation configuration resource in the Cloud Workstations API. Workstation configurations act as templates for workstations. The workstation configuration defines details such as the workstation virtual machine (VM) instance type, persistent storage, container image defining environment, which IDE or Code Editor to use, and more. Administrators and platform teams can also use [Identity and Access Management (IAM)](https://cloud.google.com/iam/docs/overview) rules to grant access to teams or to individual developers. - "allowedPorts": [ # Optional. Single or Range of ports externally accessible in the workstation. If not specified defaults to ports 22, 80 and ports 1024-65535. - { # A PortsConfig defines a range of ports. Both first and last are inclusive. To specify a single port, both first and last should be same. + "allowedPorts": [ # Optional. A Single or Range of ports externally accessible in the workstation. If not specified defaults to ports 22, 80 and ports 1024-65535. + { # A PortsConfig defines a range of ports. Both first and last are inclusive. To specify a single port, both first and last should be the same. "first": 42, # Required. Starting port number for the current range of ports. "last": 42, # Required. Ending port number for the current range of ports. }, @@ -812,7 +812,7 @@

Method Details

}, "disablePublicIpAddresses": True or False, # Optional. When set to true, disables public IP addresses for VMs. If you disable public IP addresses, you must set up Private Google Access or Cloud NAT on your network. If you use Private Google Access and you use `private.googleapis.com` or `restricted.googleapis.com` for Container Registry and Artifact Registry, make sure that you set up DNS records for domains `*.gcr.io` and `*.pkg.dev`. Defaults to false (VMs have public IP addresses). "disableSsh": True or False, # Optional. Whether to disable SSH access to the VM. - "enableNestedVirtualization": True or False, # Optional. Whether to enable nested virtualization on Cloud Workstations VMs created using this workstation configuration. Nested virtualization lets you run virtual machine (VM) instances inside your workstation. Before enabling nested virtualization, consider the following important considerations. Cloud Workstations instances are subject to the [same restrictions as Compute Engine instances](https://cloud.google.com/compute/docs/instances/nested-virtualization/overview#restrictions): * **Organization policy**: projects, folders, or organizations may be restricted from creating nested VMs if the **Disable VM nested virtualization** constraint is enforced in the organization policy. For more information, see the Compute Engine section, [Checking whether nested virtualization is allowed](https://cloud.google.com/compute/docs/instances/nested-virtualization/managing-constraint#checking_whether_nested_virtualization_is_allowed). * **Performance**: nested VMs might experience a 10% or greater decrease in performance for workloads that are CPU-bound and possibly greater than a 10% decrease for workloads that are input/output bound. * **Machine Type**: nested virtualization can only be enabled on workstation configurations that specify a machine_type in the N1 or N2 machine series. * **GPUs**: nested virtualization may not be enabled on workstation configurations with accelerators. * **Operating System**: Because [Container-Optimized OS](https://cloud.google.com/compute/docs/images/os-details#container-optimized_os_cos) does not support nested virtualization, when nested virtualization is enabled, the underlying Compute Engine VM instances boot from an [Ubuntu LTS](https://cloud.google.com/compute/docs/images/os-details#ubuntu_lts) image. + "enableNestedVirtualization": True or False, # Optional. Whether to enable nested virtualization on Cloud Workstations VMs created using this workstation configuration. Nested virtualization lets you run virtual machine (VM) instances inside your workstation. Before enabling nested virtualization, consider the following important considerations. Cloud Workstations instances are subject to the [same restrictions as Compute Engine instances](https://cloud.google.com/compute/docs/instances/nested-virtualization/overview#restrictions): * **Organization policy**: projects, folders, or organizations may be restricted from creating nested VMs if the **Disable VM nested virtualization** constraint is enforced in the organization policy. For more information, see the Compute Engine section, [Checking whether nested virtualization is allowed](https://cloud.google.com/compute/docs/instances/nested-virtualization/managing-constraint#checking_whether_nested_virtualization_is_allowed). * **Performance**: nested VMs might experience a 10% or greater decrease in performance for workloads that are CPU-bound and possibly greater than a 10% decrease for workloads that are input/output bound. * **Machine Type**: nested virtualization can only be enabled on workstation configurations that specify a machine_type in the N1 or N2 machine series. * **GPUs**: nested virtualization may not be enabled on workstation configurations with accelerators. * **Operating System**: because [Container-Optimized OS](https://cloud.google.com/compute/docs/images/os-details#container-optimized_os_cos) does not support nested virtualization, when nested virtualization is enabled, the underlying Compute Engine VM instances boot from an [Ubuntu LTS](https://cloud.google.com/compute/docs/images/os-details#ubuntu_lts) image. "machineType": "A String", # Optional. The type of machine to use for VM instances—for example, `"e2-standard-4"`. For more information about machine types that Cloud Workstations supports, see the list of [available machine types](https://cloud.google.com/workstations/docs/available-machine-types). "poolSize": 42, # Optional. The number of VMs that the system should keep idle so that new workstations can be started quickly for new users. Defaults to `0` in the API. "pooledInstances": 42, # Output only. Number of instances currently available in the pool for faster workstation startup. @@ -906,8 +906,8 @@

Method Details

The object takes the form of: { # A workstation configuration resource in the Cloud Workstations API. Workstation configurations act as templates for workstations. The workstation configuration defines details such as the workstation virtual machine (VM) instance type, persistent storage, container image defining environment, which IDE or Code Editor to use, and more. Administrators and platform teams can also use [Identity and Access Management (IAM)](https://cloud.google.com/iam/docs/overview) rules to grant access to teams or to individual developers. - "allowedPorts": [ # Optional. Single or Range of ports externally accessible in the workstation. If not specified defaults to ports 22, 80 and ports 1024-65535. - { # A PortsConfig defines a range of ports. Both first and last are inclusive. To specify a single port, both first and last should be same. + "allowedPorts": [ # Optional. A Single or Range of ports externally accessible in the workstation. If not specified defaults to ports 22, 80 and ports 1024-65535. + { # A PortsConfig defines a range of ports. Both first and last are inclusive. To specify a single port, both first and last should be the same. "first": 42, # Required. Starting port number for the current range of ports. "last": 42, # Required. Ending port number for the current range of ports. }, @@ -991,7 +991,7 @@

Method Details

}, "disablePublicIpAddresses": True or False, # Optional. When set to true, disables public IP addresses for VMs. If you disable public IP addresses, you must set up Private Google Access or Cloud NAT on your network. If you use Private Google Access and you use `private.googleapis.com` or `restricted.googleapis.com` for Container Registry and Artifact Registry, make sure that you set up DNS records for domains `*.gcr.io` and `*.pkg.dev`. Defaults to false (VMs have public IP addresses). "disableSsh": True or False, # Optional. Whether to disable SSH access to the VM. - "enableNestedVirtualization": True or False, # Optional. Whether to enable nested virtualization on Cloud Workstations VMs created using this workstation configuration. Nested virtualization lets you run virtual machine (VM) instances inside your workstation. Before enabling nested virtualization, consider the following important considerations. Cloud Workstations instances are subject to the [same restrictions as Compute Engine instances](https://cloud.google.com/compute/docs/instances/nested-virtualization/overview#restrictions): * **Organization policy**: projects, folders, or organizations may be restricted from creating nested VMs if the **Disable VM nested virtualization** constraint is enforced in the organization policy. For more information, see the Compute Engine section, [Checking whether nested virtualization is allowed](https://cloud.google.com/compute/docs/instances/nested-virtualization/managing-constraint#checking_whether_nested_virtualization_is_allowed). * **Performance**: nested VMs might experience a 10% or greater decrease in performance for workloads that are CPU-bound and possibly greater than a 10% decrease for workloads that are input/output bound. * **Machine Type**: nested virtualization can only be enabled on workstation configurations that specify a machine_type in the N1 or N2 machine series. * **GPUs**: nested virtualization may not be enabled on workstation configurations with accelerators. * **Operating System**: Because [Container-Optimized OS](https://cloud.google.com/compute/docs/images/os-details#container-optimized_os_cos) does not support nested virtualization, when nested virtualization is enabled, the underlying Compute Engine VM instances boot from an [Ubuntu LTS](https://cloud.google.com/compute/docs/images/os-details#ubuntu_lts) image. + "enableNestedVirtualization": True or False, # Optional. Whether to enable nested virtualization on Cloud Workstations VMs created using this workstation configuration. Nested virtualization lets you run virtual machine (VM) instances inside your workstation. Before enabling nested virtualization, consider the following important considerations. Cloud Workstations instances are subject to the [same restrictions as Compute Engine instances](https://cloud.google.com/compute/docs/instances/nested-virtualization/overview#restrictions): * **Organization policy**: projects, folders, or organizations may be restricted from creating nested VMs if the **Disable VM nested virtualization** constraint is enforced in the organization policy. For more information, see the Compute Engine section, [Checking whether nested virtualization is allowed](https://cloud.google.com/compute/docs/instances/nested-virtualization/managing-constraint#checking_whether_nested_virtualization_is_allowed). * **Performance**: nested VMs might experience a 10% or greater decrease in performance for workloads that are CPU-bound and possibly greater than a 10% decrease for workloads that are input/output bound. * **Machine Type**: nested virtualization can only be enabled on workstation configurations that specify a machine_type in the N1 or N2 machine series. * **GPUs**: nested virtualization may not be enabled on workstation configurations with accelerators. * **Operating System**: because [Container-Optimized OS](https://cloud.google.com/compute/docs/images/os-details#container-optimized_os_cos) does not support nested virtualization, when nested virtualization is enabled, the underlying Compute Engine VM instances boot from an [Ubuntu LTS](https://cloud.google.com/compute/docs/images/os-details#ubuntu_lts) image. "machineType": "A String", # Optional. The type of machine to use for VM instances—for example, `"e2-standard-4"`. For more information about machine types that Cloud Workstations supports, see the list of [available machine types](https://cloud.google.com/workstations/docs/available-machine-types). "poolSize": 42, # Optional. The number of VMs that the system should keep idle so that new workstations can be started quickly for new users. Defaults to `0` in the API. "pooledInstances": 42, # Output only. Number of instances currently available in the pool for faster workstation startup. diff --git a/docs/dyn/workstations_v1beta.projects.locations.workstationClusters.workstationConfigs.workstations.html b/docs/dyn/workstations_v1beta.projects.locations.workstationClusters.workstationConfigs.workstations.html index ee81043b7ed..e90d8ff5fa5 100644 --- a/docs/dyn/workstations_v1beta.projects.locations.workstationClusters.workstationConfigs.workstations.html +++ b/docs/dyn/workstations_v1beta.projects.locations.workstationClusters.workstationConfigs.workstations.html @@ -237,7 +237,7 @@

Method Details

{ # Request message for GenerateAccessToken. "expireTime": "A String", # Desired expiration time of the access token. This value must be at most 24 hours in the future. If a value is not specified, the token's expiration time will be set to a default value of 1 hour in the future. - "port": 42, # Optional. Port for which the access token should be generated. If specified, the generated access token will grant access only to the specified port of the workstation. If specified, values must be within the range [1 - 65535]. If not specified, the generated access token will grant access to all ports of the workstation. + "port": 42, # Optional. Port for which the access token should be generated. If specified, the generated access token grants access only to the specified port of the workstation. If specified, values must be within the range [1 - 65535]. If not specified, the generated access token grants access to all ports of the workstation. "ttl": "A String", # Desired lifetime duration of the access token. This value must be at most 24 hours. If a value is not specified, the token's lifetime will be set to a default value of 1 hour. } diff --git a/googleapiclient/discovery_cache/documents/abusiveexperiencereport.v1.json b/googleapiclient/discovery_cache/documents/abusiveexperiencereport.v1.json index 71f5acf3779..6ef6a43f6e0 100644 --- a/googleapiclient/discovery_cache/documents/abusiveexperiencereport.v1.json +++ b/googleapiclient/discovery_cache/documents/abusiveexperiencereport.v1.json @@ -139,7 +139,7 @@ } } }, -"revision": "20240527", +"revision": "20240610", "rootUrl": "https://abusiveexperiencereport.googleapis.com/", "schemas": { "SiteSummaryResponse": { diff --git a/googleapiclient/discovery_cache/documents/acceleratedmobilepageurl.v1.json b/googleapiclient/discovery_cache/documents/acceleratedmobilepageurl.v1.json index d93d5626155..3f4b06e9de1 100644 --- a/googleapiclient/discovery_cache/documents/acceleratedmobilepageurl.v1.json +++ b/googleapiclient/discovery_cache/documents/acceleratedmobilepageurl.v1.json @@ -115,7 +115,7 @@ } } }, -"revision": "20240602", +"revision": "20240609", "rootUrl": "https://acceleratedmobilepageurl.googleapis.com/", "schemas": { "AmpUrl": { diff --git a/googleapiclient/discovery_cache/documents/accessapproval.v1.json b/googleapiclient/discovery_cache/documents/accessapproval.v1.json index 9e139e3779b..ce6aa7c6477 100644 --- a/googleapiclient/discovery_cache/documents/accessapproval.v1.json +++ b/googleapiclient/discovery_cache/documents/accessapproval.v1.json @@ -913,7 +913,7 @@ } } }, -"revision": "20240531", +"revision": "20240607", "rootUrl": "https://accessapproval.googleapis.com/", "schemas": { "AccessApprovalServiceAccount": { @@ -985,6 +985,22 @@ "format": "int32", "type": "integer" }, +"requestScopeMaxWidthPreference": { +"description": "Optional. A setting to indicate the maximum width of an Access Approval request.", +"enum": [ +"REQUEST_SCOPE_MAX_WIDTH_PREFERENCE_UNSPECIFIED", +"ORGANIZATION", +"FOLDER", +"PROJECT" +], +"enumDescriptions": [ +"Default value for proto, shouldn't be used.", +"This is the widest scope possible. It means the customer has no scope restriction when it comes to Access Approval requests.", +"Customer allows the scope of Access Approval requests as broad as the Folder level.", +"Customer allows the scope of Access Approval requests as broad as the Project level." +], +"type": "string" +}, "requireCustomerVisibleJustification": { "description": "Optional. A setting to require approval request justifications to be customer visible.", "type": "boolean" diff --git a/googleapiclient/discovery_cache/documents/accesscontextmanager.v1.json b/googleapiclient/discovery_cache/documents/accesscontextmanager.v1.json index c94d18fbecf..b1b87545a05 100644 --- a/googleapiclient/discovery_cache/documents/accesscontextmanager.v1.json +++ b/googleapiclient/discovery_cache/documents/accesscontextmanager.v1.json @@ -1290,7 +1290,7 @@ } } }, -"revision": "20240527", +"revision": "20240605", "rootUrl": "https://accesscontextmanager.googleapis.com/", "schemas": { "AccessContextManagerOperationMetadata": { diff --git a/googleapiclient/discovery_cache/documents/acmedns.v1.json b/googleapiclient/discovery_cache/documents/acmedns.v1.json index d2c4deca4e4..6049b002871 100644 --- a/googleapiclient/discovery_cache/documents/acmedns.v1.json +++ b/googleapiclient/discovery_cache/documents/acmedns.v1.json @@ -146,7 +146,7 @@ } } }, -"revision": "20240602", +"revision": "20240609", "rootUrl": "https://acmedns.googleapis.com/", "schemas": { "AcmeChallengeSet": { diff --git a/googleapiclient/discovery_cache/documents/addressvalidation.v1.json b/googleapiclient/discovery_cache/documents/addressvalidation.v1.json index 3c53557faed..c73ce3d58c9 100644 --- a/googleapiclient/discovery_cache/documents/addressvalidation.v1.json +++ b/googleapiclient/discovery_cache/documents/addressvalidation.v1.json @@ -151,7 +151,7 @@ } } }, -"revision": "20240602", +"revision": "20240609", "rootUrl": "https://addressvalidation.googleapis.com/", "schemas": { "GoogleGeoTypeViewport": { diff --git a/googleapiclient/discovery_cache/documents/adexchangebuyer2.v2beta1.json b/googleapiclient/discovery_cache/documents/adexchangebuyer2.v2beta1.json index 877f8c9f08c..904ab2584f3 100644 --- a/googleapiclient/discovery_cache/documents/adexchangebuyer2.v2beta1.json +++ b/googleapiclient/discovery_cache/documents/adexchangebuyer2.v2beta1.json @@ -3115,7 +3115,7 @@ } } }, -"revision": "20240603", +"revision": "20240610", "rootUrl": "https://adexchangebuyer.googleapis.com/", "schemas": { "AbsoluteDateRange": { diff --git a/googleapiclient/discovery_cache/documents/adexperiencereport.v1.json b/googleapiclient/discovery_cache/documents/adexperiencereport.v1.json index c78d6ac8caa..6fd1b8dce4a 100644 --- a/googleapiclient/discovery_cache/documents/adexperiencereport.v1.json +++ b/googleapiclient/discovery_cache/documents/adexperiencereport.v1.json @@ -139,7 +139,7 @@ } } }, -"revision": "20240527", +"revision": "20240610", "rootUrl": "https://adexperiencereport.googleapis.com/", "schemas": { "PlatformSummary": { diff --git a/googleapiclient/discovery_cache/documents/admin.datatransfer_v1.json b/googleapiclient/discovery_cache/documents/admin.datatransfer_v1.json index 56371d1152f..323835eb64a 100644 --- a/googleapiclient/discovery_cache/documents/admin.datatransfer_v1.json +++ b/googleapiclient/discovery_cache/documents/admin.datatransfer_v1.json @@ -272,7 +272,7 @@ } } }, -"revision": "20240528", +"revision": "20240603", "rootUrl": "https://admin.googleapis.com/", "schemas": { "Application": { diff --git a/googleapiclient/discovery_cache/documents/admin.directory_v1.json b/googleapiclient/discovery_cache/documents/admin.directory_v1.json index c4ea893fed3..c6a6a1a4abf 100644 --- a/googleapiclient/discovery_cache/documents/admin.directory_v1.json +++ b/googleapiclient/discovery_cache/documents/admin.directory_v1.json @@ -403,7 +403,7 @@ }, "maxResults": { "default": "100", -"description": "Maximum number of results to return, value should not exceed 300.", +"description": "Maximum number of results to return. Value should not exceed 300.", "format": "int32", "location": "query", "minimum": "1", @@ -4671,7 +4671,7 @@ } } }, -"revision": "20240528", +"revision": "20240603", "rootUrl": "https://admin.googleapis.com/", "schemas": { "Alias": { diff --git a/googleapiclient/discovery_cache/documents/admin.reports_v1.json b/googleapiclient/discovery_cache/documents/admin.reports_v1.json index cd13533b980..dc9b024218d 100644 --- a/googleapiclient/discovery_cache/documents/admin.reports_v1.json +++ b/googleapiclient/discovery_cache/documents/admin.reports_v1.json @@ -626,7 +626,7 @@ } } }, -"revision": "20240528", +"revision": "20240603", "rootUrl": "https://admin.googleapis.com/", "schemas": { "Activities": { diff --git a/googleapiclient/discovery_cache/documents/admob.v1.json b/googleapiclient/discovery_cache/documents/admob.v1.json index d20353bd3ca..d15c0f37a73 100644 --- a/googleapiclient/discovery_cache/documents/admob.v1.json +++ b/googleapiclient/discovery_cache/documents/admob.v1.json @@ -321,7 +321,7 @@ } } }, -"revision": "20240603", +"revision": "20240610", "rootUrl": "https://admob.googleapis.com/", "schemas": { "AdUnit": { diff --git a/googleapiclient/discovery_cache/documents/admob.v1beta.json b/googleapiclient/discovery_cache/documents/admob.v1beta.json index 4176ed790f4..34e8c6924f1 100644 --- a/googleapiclient/discovery_cache/documents/admob.v1beta.json +++ b/googleapiclient/discovery_cache/documents/admob.v1beta.json @@ -758,7 +758,7 @@ } } }, -"revision": "20240603", +"revision": "20240610", "rootUrl": "https://admob.googleapis.com/", "schemas": { "AdSource": { diff --git a/googleapiclient/discovery_cache/documents/adsense.v2.json b/googleapiclient/discovery_cache/documents/adsense.v2.json index 79963f485aa..2b767da62a4 100644 --- a/googleapiclient/discovery_cache/documents/adsense.v2.json +++ b/googleapiclient/discovery_cache/documents/adsense.v2.json @@ -1912,7 +1912,7 @@ } } }, -"revision": "20240602", +"revision": "20240610", "rootUrl": "https://adsense.googleapis.com/", "schemas": { "Account": { diff --git a/googleapiclient/discovery_cache/documents/advisorynotifications.v1.json b/googleapiclient/discovery_cache/documents/advisorynotifications.v1.json index df8d8d1c2ca..b183a36d1ff 100644 --- a/googleapiclient/discovery_cache/documents/advisorynotifications.v1.json +++ b/googleapiclient/discovery_cache/documents/advisorynotifications.v1.json @@ -412,7 +412,7 @@ } } }, -"revision": "20240602", +"revision": "20240609", "rootUrl": "https://advisorynotifications.googleapis.com/", "schemas": { "GoogleCloudAdvisorynotificationsV1Attachment": { diff --git a/googleapiclient/discovery_cache/documents/aiplatform.v1.json b/googleapiclient/discovery_cache/documents/aiplatform.v1.json index c161881480a..3096d5a9988 100644 --- a/googleapiclient/discovery_cache/documents/aiplatform.v1.json +++ b/googleapiclient/discovery_cache/documents/aiplatform.v1.json @@ -16287,7 +16287,7 @@ } } }, -"revision": "20240529", +"revision": "20240531", "rootUrl": "https://aiplatform.googleapis.com/", "schemas": { "CloudAiLargeModelsVisionGenerateVideoResponse": { @@ -26463,7 +26463,7 @@ "Error parsing sparse dimensions field.", "Token restrict value is invalid.", "Invalid sparse embedding.", -"Invalid embedding." +"Invalid dense embedding." ], "type": "string" }, @@ -27847,10 +27847,6 @@ "$ref": "GoogleCloudAiplatformV1PublisherModelCallToActionDeployGke", "description": "Optional. Deploy PublisherModel to Google Kubernetes Engine." }, -"fineTune": { -"$ref": "GoogleCloudAiplatformV1PublisherModelCallToActionRegionalResourceReferences", -"description": "Optional. Fine tune the PublisherModel with the third-party model tuning UI." -}, "openEvaluationPipeline": { "$ref": "GoogleCloudAiplatformV1PublisherModelCallToActionRegionalResourceReferences", "description": "Optional. Open evaluation pipeline of the PublisherModel." diff --git a/googleapiclient/discovery_cache/documents/aiplatform.v1beta1.json b/googleapiclient/discovery_cache/documents/aiplatform.v1beta1.json index 25559b9d355..af6aa4c1275 100644 --- a/googleapiclient/discovery_cache/documents/aiplatform.v1beta1.json +++ b/googleapiclient/discovery_cache/documents/aiplatform.v1beta1.json @@ -1048,7 +1048,7 @@ }, "path": "v1beta1/{+name}", "response": { -"$ref": "GoogleLongrunningOperation" +"$ref": "GoogleProtobufEmpty" }, "scopes": [ "https://www.googleapis.com/auth/cloud-platform" @@ -4327,6 +4327,35 @@ "https://www.googleapis.com/auth/cloud-platform.read-only" ] }, +"streamRawPredict": { +"description": "Perform a streaming online prediction with an arbitrary HTTP payload.", +"flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/endpoints/{endpointsId}:streamRawPredict", +"httpMethod": "POST", +"id": "aiplatform.projects.locations.endpoints.streamRawPredict", +"parameterOrder": [ +"endpoint" +], +"parameters": { +"endpoint": { +"description": "Required. The name of the Endpoint requested to serve the prediction. Format: `projects/{project}/locations/{location}/endpoints/{endpoint}`", +"location": "path", +"pattern": "^projects/[^/]+/locations/[^/]+/endpoints/[^/]+$", +"required": true, +"type": "string" +} +}, +"path": "v1beta1/{+endpoint}:streamRawPredict", +"request": { +"$ref": "GoogleCloudAiplatformV1beta1StreamRawPredictRequest" +}, +"response": { +"$ref": "GoogleApiHttpBody" +}, +"scopes": [ +"https://www.googleapis.com/auth/cloud-platform", +"https://www.googleapis.com/auth/cloud-platform.read-only" +] +}, "testIamPermissions": { "description": "Returns permissions that a caller has on the specified resource. If the resource does not exist, this will return an empty set of permissions, not a `NOT_FOUND` error. Note: This operation is designed to be used for building permission-aware UIs and command-line tools, not for authorization checking. This operation may \"fail open\" without warning.", "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/endpoints/{endpointsId}:testIamPermissions", @@ -15331,6 +15360,35 @@ "https://www.googleapis.com/auth/cloud-platform", "https://www.googleapis.com/auth/cloud-platform.read-only" ] +}, +"streamRawPredict": { +"description": "Perform a streaming online prediction with an arbitrary HTTP payload.", +"flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/publishers/{publishersId}/models/{modelsId}:streamRawPredict", +"httpMethod": "POST", +"id": "aiplatform.projects.locations.publishers.models.streamRawPredict", +"parameterOrder": [ +"endpoint" +], +"parameters": { +"endpoint": { +"description": "Required. The name of the Endpoint requested to serve the prediction. Format: `projects/{project}/locations/{location}/endpoints/{endpoint}`", +"location": "path", +"pattern": "^projects/[^/]+/locations/[^/]+/publishers/[^/]+/models/[^/]+$", +"required": true, +"type": "string" +} +}, +"path": "v1beta1/{+endpoint}:streamRawPredict", +"request": { +"$ref": "GoogleCloudAiplatformV1beta1StreamRawPredictRequest" +}, +"response": { +"$ref": "GoogleApiHttpBody" +}, +"scopes": [ +"https://www.googleapis.com/auth/cloud-platform", +"https://www.googleapis.com/auth/cloud-platform.read-only" +] } } } @@ -19896,7 +19954,7 @@ } } }, -"revision": "20240529", +"revision": "20240531", "rootUrl": "https://aiplatform.googleapis.com/", "schemas": { "CloudAiLargeModelsVisionGenerateVideoResponse": { @@ -27958,6 +28016,11 @@ "$ref": "GoogleCloudAiplatformV1beta1GoogleDriveSource", "description": "Google Drive location. Supports importing individual files as well as Google Drive folders." }, +"maxEmbeddingRequestsPerMin": { +"description": "Optional. The max number of queries per minute that this job is allowed to make to the embedding model specified on the corpus. This value is specific to this job and not shared across other import jobs. Consult the Quotas page on the project to set an appropriate value here. If unspecified, a default value of 1,000 QPM would be used.", +"format": "int32", +"type": "integer" +}, "ragFileChunkingConfig": { "$ref": "GoogleCloudAiplatformV1beta1RagFileChunkingConfig", "description": "Specifies the size and overlap of chunks after importing RagFiles." @@ -31025,28 +31088,6 @@ }, "type": "object" }, -"GoogleCloudAiplatformV1beta1ModelMonitoringGenAiStats": { -"description": "A collection of data points that describes the time-varying values of a gen ai metric.", -"id": "GoogleCloudAiplatformV1beta1ModelMonitoringGenAiStats", -"properties": { -"dataPoints": { -"description": "The data points of this time series. When listing time series, points are returned in reverse time order.", -"items": { -"$ref": "GoogleCloudAiplatformV1beta1ModelMonitoringStatsDataPoint" -}, -"type": "array" -}, -"objectiveType": { -"description": "One of the supported monitoring objectives: `gen-ai-general` `gen-ai-evaluation` `gen-ai-safety`", -"type": "string" -}, -"statsName": { -"description": "The stats name.", -"type": "string" -} -}, -"type": "object" -}, "GoogleCloudAiplatformV1beta1ModelMonitoringInput": { "description": "Model monitoring data input spec.", "id": "GoogleCloudAiplatformV1beta1ModelMonitoringInput", @@ -31691,10 +31732,6 @@ "description": "Represents the collection of statistics for a metric.", "id": "GoogleCloudAiplatformV1beta1ModelMonitoringStats", "properties": { -"genAiStats": { -"$ref": "GoogleCloudAiplatformV1beta1ModelMonitoringGenAiStats", -"description": "Generated gen ai statistics." -}, "tabularStats": { "$ref": "GoogleCloudAiplatformV1beta1ModelMonitoringTabularStats", "description": "Generated tabular statistics." @@ -32511,7 +32548,7 @@ "Error parsing sparse dimensions field.", "Token restrict value is invalid.", "Invalid sparse embedding.", -"Invalid embedding." +"Invalid dense embedding." ], "type": "string" }, @@ -34242,10 +34279,6 @@ "$ref": "GoogleCloudAiplatformV1beta1PublisherModelCallToActionDeployGke", "description": "Optional. Deploy PublisherModel to Google Kubernetes Engine." }, -"fineTune": { -"$ref": "GoogleCloudAiplatformV1beta1PublisherModelCallToActionRegionalResourceReferences", -"description": "Optional. Fine tune the PublisherModel with the third-party model tuning UI." -}, "openEvaluationPipeline": { "$ref": "GoogleCloudAiplatformV1beta1PublisherModelCallToActionRegionalResourceReferences", "description": "Optional. Open evaluation pipeline of the PublisherModel." @@ -35115,6 +35148,10 @@ "readOnly": true, "type": "string" }, +"ragEmbeddingModelConfig": { +"$ref": "GoogleCloudAiplatformV1beta1RagEmbeddingModelConfig", +"description": "Optional. Immutable. The embedding model config of the RagCorpus." +}, "updateTime": { "description": "Output only. Timestamp when this RagCorpus was last updated.", "format": "google-datetime", @@ -35124,6 +35161,38 @@ }, "type": "object" }, +"GoogleCloudAiplatformV1beta1RagEmbeddingModelConfig": { +"description": "Config for the embedding model to use for RAG.", +"id": "GoogleCloudAiplatformV1beta1RagEmbeddingModelConfig", +"properties": { +"vertexPredictionEndpoint": { +"$ref": "GoogleCloudAiplatformV1beta1RagEmbeddingModelConfigVertexPredictionEndpoint", +"description": "The Vertex AI Prediction Endpoint that either refers to a publisher model or an endpoint that is hosting a 1P fine-tuned text embedding model. Endpoints hosting non-1P fine-tuned text embedding models are currently not supported." +} +}, +"type": "object" +}, +"GoogleCloudAiplatformV1beta1RagEmbeddingModelConfigVertexPredictionEndpoint": { +"description": "Config representing a model hosted on Vertex Prediction Endpoint.", +"id": "GoogleCloudAiplatformV1beta1RagEmbeddingModelConfigVertexPredictionEndpoint", +"properties": { +"endpoint": { +"description": "Required. The endpoint resource name. Format: `projects/{project}/locations/{location}/publishers/{publisher}/models/{model}` or `projects/{project}/locations/{location}/endpoints/{endpoint}`", +"type": "string" +}, +"model": { +"description": "Output only. The resource name of the model that is deployed on the endpoint. Present only when the endpoint is not a publisher model. Pattern: `projects/{project}/locations/{location}/models/{model}`", +"readOnly": true, +"type": "string" +}, +"modelVersionId": { +"description": "Output only. Version ID of the model that is deployed on the endpoint. Present only when the endpoint is not a publisher model.", +"readOnly": true, +"type": "string" +} +}, +"type": "object" +}, "GoogleCloudAiplatformV1beta1RagFile": { "description": "A RagFile contains user data for chunking, embedding and indexing.", "id": "GoogleCloudAiplatformV1beta1RagFile", @@ -40636,10 +40705,6 @@ "description": "Filter for searching ModelMonitoringStats.", "id": "GoogleCloudAiplatformV1beta1SearchModelMonitoringStatsFilter", "properties": { -"genAiStatsFilter": { -"$ref": "GoogleCloudAiplatformV1beta1SearchModelMonitoringStatsFilterGenAiStatsFilter", -"description": "GenAi statistics filter." -}, "tabularStatsFilter": { "$ref": "GoogleCloudAiplatformV1beta1SearchModelMonitoringStatsFilterTabularStatsFilter", "description": "Tabular statistics filter." @@ -40647,33 +40712,6 @@ }, "type": "object" }, -"GoogleCloudAiplatformV1beta1SearchModelMonitoringStatsFilterGenAiStatsFilter": { -"description": "GenAi statistics filter.", -"id": "GoogleCloudAiplatformV1beta1SearchModelMonitoringStatsFilterGenAiStatsFilter", -"properties": { -"clusterId": { -"description": "From a particular cluster of monitoring results.", -"type": "string" -}, -"modelMonitoringJob": { -"description": "From a particular monitoring job.", -"type": "string" -}, -"modelMonitoringSchedule": { -"description": "From a particular monitoring schedule.", -"type": "string" -}, -"objectiveType": { -"description": "One of the supported monitoring objectives: `gen-ai-general` `gen-ai-evaluation` `gen-ai-safety`", -"type": "string" -}, -"statsName": { -"description": "If not specified, will return all the stats_names.", -"type": "string" -} -}, -"type": "object" -}, "GoogleCloudAiplatformV1beta1SearchModelMonitoringStatsFilterTabularStatsFilter": { "description": "Tabular statistics filter.", "id": "GoogleCloudAiplatformV1beta1SearchModelMonitoringStatsFilterTabularStatsFilter", @@ -40912,6 +40950,17 @@ }, "type": "object" }, +"GoogleCloudAiplatformV1beta1StreamRawPredictRequest": { +"description": "Request message for PredictionService.StreamRawPredict.", +"id": "GoogleCloudAiplatformV1beta1StreamRawPredictRequest", +"properties": { +"httpBody": { +"$ref": "GoogleApiHttpBody", +"description": "The prediction input. Supports HTTP headers and arbitrary data payload." +} +}, +"type": "object" +}, "GoogleCloudAiplatformV1beta1StreamingFetchFeatureValuesRequest": { "description": "Request message for FeatureOnlineStoreService.StreamingFetchFeatureValues. For the entities requested, all features under the requested feature view will be returned.", "id": "GoogleCloudAiplatformV1beta1StreamingFetchFeatureValuesRequest", diff --git a/googleapiclient/discovery_cache/documents/airquality.v1.json b/googleapiclient/discovery_cache/documents/airquality.v1.json new file mode 100644 index 00000000000..8a8d069a393 --- /dev/null +++ b/googleapiclient/discovery_cache/documents/airquality.v1.json @@ -0,0 +1,875 @@ +{ +"auth": { +"oauth2": { +"scopes": { +"https://www.googleapis.com/auth/cloud-platform": { +"description": "See, edit, configure, and delete your Google Cloud data and see the email address for your Google Account." +} +} +} +}, +"basePath": "", +"baseUrl": "https://airquality.googleapis.com/", +"batchPath": "batch", +"canonicalName": "Air Quality", +"description": "The Air Quality API.", +"discoveryVersion": "v1", +"documentationLink": "https://developers.google.com/maps/documentation/air-quality", +"fullyEncodeReservedExpansion": true, +"icons": { +"x16": "http://www.google.com/images/icons/product/search-16.gif", +"x32": "http://www.google.com/images/icons/product/search-32.gif" +}, +"id": "airquality:v1", +"kind": "discovery#restDescription", +"mtlsRootUrl": "https://airquality.mtls.googleapis.com/", +"name": "airquality", +"ownerDomain": "google.com", +"ownerName": "Google", +"parameters": { +"$.xgafv": { +"description": "V1 error format.", +"enum": [ +"1", +"2" +], +"enumDescriptions": [ +"v1 error format", +"v2 error format" +], +"location": "query", +"type": "string" +}, +"access_token": { +"description": "OAuth access token.", +"location": "query", +"type": "string" +}, +"alt": { +"default": "json", +"description": "Data format for response.", +"enum": [ +"json", +"media", +"proto" +], +"enumDescriptions": [ +"Responses with Content-Type of application/json", +"Media download with context-dependent Content-Type", +"Responses with Content-Type of application/x-protobuf" +], +"location": "query", +"type": "string" +}, +"callback": { +"description": "JSONP", +"location": "query", +"type": "string" +}, +"fields": { +"description": "Selector specifying which fields to include in a partial response.", +"location": "query", +"type": "string" +}, +"key": { +"description": "API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token.", +"location": "query", +"type": "string" +}, +"oauth_token": { +"description": "OAuth 2.0 token for the current user.", +"location": "query", +"type": "string" +}, +"prettyPrint": { +"default": "true", +"description": "Returns response with indentations and line breaks.", +"location": "query", +"type": "boolean" +}, +"quotaUser": { +"description": "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.", +"location": "query", +"type": "string" +}, +"uploadType": { +"description": "Legacy upload protocol for media (e.g. \"media\", \"multipart\").", +"location": "query", +"type": "string" +}, +"upload_protocol": { +"description": "Upload protocol for media (e.g. \"raw\", \"multipart\").", +"location": "query", +"type": "string" +} +}, +"protocol": "rest", +"resources": { +"currentConditions": { +"methods": { +"lookup": { +"description": "The Current Conditions endpoint provides hourly air quality information in more than 100 countries, up to a 500 x 500 meters resolution. Includes over 70 local indexes and global air quality index and categories.", +"flatPath": "v1/currentConditions:lookup", +"httpMethod": "POST", +"id": "airquality.currentConditions.lookup", +"parameterOrder": [], +"parameters": {}, +"path": "v1/currentConditions:lookup", +"request": { +"$ref": "LookupCurrentConditionsRequest" +}, +"response": { +"$ref": "LookupCurrentConditionsResponse" +}, +"scopes": [ +"https://www.googleapis.com/auth/cloud-platform" +] +} +} +}, +"forecast": { +"methods": { +"lookup": { +"description": "Returns air quality forecast for a specific location for a given time range.", +"flatPath": "v1/forecast:lookup", +"httpMethod": "POST", +"id": "airquality.forecast.lookup", +"parameterOrder": [], +"parameters": {}, +"path": "v1/forecast:lookup", +"request": { +"$ref": "LookupForecastRequest" +}, +"response": { +"$ref": "LookupForecastResponse" +}, +"scopes": [ +"https://www.googleapis.com/auth/cloud-platform" +] +} +} +}, +"history": { +"methods": { +"lookup": { +"description": "Returns air quality history for a specific location for a given time range.", +"flatPath": "v1/history:lookup", +"httpMethod": "POST", +"id": "airquality.history.lookup", +"parameterOrder": [], +"parameters": {}, +"path": "v1/history:lookup", +"request": { +"$ref": "LookupHistoryRequest" +}, +"response": { +"$ref": "LookupHistoryResponse" +}, +"scopes": [ +"https://www.googleapis.com/auth/cloud-platform" +] +} +} +}, +"mapTypes": { +"resources": { +"heatmapTiles": { +"methods": { +"lookupHeatmapTile": { +"description": "Returns a bytes array containing the data of the tile PNG image.", +"flatPath": "v1/mapTypes/{mapType}/heatmapTiles/{zoom}/{x}/{y}", +"httpMethod": "GET", +"id": "airquality.mapTypes.heatmapTiles.lookupHeatmapTile", +"parameterOrder": [ +"mapType", +"zoom", +"x", +"y" +], +"parameters": { +"mapType": { +"description": "Required. The type of the air quality heatmap. Defines the pollutant that the map will graphically represent. Allowed values: - UAQI_RED_GREEN (UAQI, red-green palette) - UAQI_INDIGO_PERSIAN (UAQI, indigo-persian palette) - PM25_INDIGO_PERSIAN - GBR_DEFRA - DEU_UBA - CAN_EC - FRA_ATMO - US_AQI", +"enum": [ +"MAP_TYPE_UNSPECIFIED", +"UAQI_RED_GREEN", +"UAQI_INDIGO_PERSIAN", +"PM25_INDIGO_PERSIAN", +"GBR_DEFRA", +"DEU_UBA", +"CAN_EC", +"FRA_ATMO", +"US_AQI" +], +"enumDescriptions": [ +"The default value. The server ignores it if it is passed as a parameter.", +"Universal Air Quality Index red-green palette.", +"Universal Air Quality Index indigo-persian palette.", +"PM2.5 index indigo-persian palette.", +"Daily Air Quality Index (UK) color palette.", +"German Local Air Quality Index color palette.", +"Canadian Air Quality Health Index color palette.", +"France Air Quality Index color palette.", +"US Air Quality Index color palette." +], +"location": "path", +"required": true, +"type": "string" +}, +"x": { +"description": "Required. Defines the east-west point in the requested tile.", +"format": "int32", +"location": "path", +"required": true, +"type": "integer" +}, +"y": { +"description": "Required. Defines the north-south point in the requested tile.", +"format": "int32", +"location": "path", +"required": true, +"type": "integer" +}, +"zoom": { +"description": "Required. The map's zoom level. Defines how large or small the contents of a map appear in a map view. Zoom level 0 is the entire world in a single tile. Zoom level 1 is the entire world in 4 tiles. Zoom level 2 is the entire world in 16 tiles. Zoom level 16 is the entire world in 65,536 tiles. Allowed values: 0-16", +"format": "int32", +"location": "path", +"required": true, +"type": "integer" +} +}, +"path": "v1/mapTypes/{mapType}/heatmapTiles/{zoom}/{x}/{y}", +"response": { +"$ref": "HttpBody" +}, +"scopes": [ +"https://www.googleapis.com/auth/cloud-platform" +] +} +} +} +} +} +}, +"revision": "20240609", +"rootUrl": "https://airquality.googleapis.com/", +"schemas": { +"AdditionalInfo": { +"description": "The emission sources and health effects of a given pollutant.", +"id": "AdditionalInfo", +"properties": { +"effects": { +"description": "Text representing the pollutant's main health effects.", +"type": "string" +}, +"sources": { +"description": "Text representing the pollutant's main emission sources.", +"type": "string" +} +}, +"type": "object" +}, +"AirQualityIndex": { +"description": "The basic object for representing different air quality metrics. When brought together, these metrics provide a snapshot about the current air quality conditions. There are multiple indexes in the world serving different purposes and groups interested in measuring different aspects of air quality.", +"id": "AirQualityIndex", +"properties": { +"aqi": { +"description": " The index's numeric score. Examples: 10, 100. The value is not normalized and should only be interpreted in the context of its related air-quality index. For non-numeric indexes, this field will not be returned. Note: This field should be used for calculations, graph display, etc. For displaying the index score, you should use the AQI display field.", +"format": "int32", +"type": "integer" +}, +"aqiDisplay": { +"description": "Textual representation of the index numeric score, that may include prefix or suffix symbols, which usually represents the worst index score. Example: >100 or 10+. Note: This field should be used when you want to display the index score. For non-numeric indexes, this field is empty.", +"type": "string" +}, +"category": { +"description": "Textual classification of the index numeric score interpretation. For example: \"Excellent air quality\".", +"type": "string" +}, +"code": { +"description": "The index's code. This field represents the index for programming purposes by using snake case instead of spaces. Examples: \"uaqi\", \"fra_atmo\".", +"type": "string" +}, +"color": { +"$ref": "Color", +"description": "The color used to represent the AQI numeric score." +}, +"displayName": { +"description": "A human readable representation of the index name. Example: \"AQI (US)\"", +"type": "string" +}, +"dominantPollutant": { +"description": "The chemical symbol of the dominant pollutant. For example: \"CO\".", +"type": "string" +} +}, +"type": "object" +}, +"Color": { +"description": "Represents a color in the RGBA color space. This representation is designed for simplicity of conversion to and from color representations in various languages over compactness. For example, the fields of this representation can be trivially provided to the constructor of `java.awt.Color` in Java; it can also be trivially provided to UIColor's `+colorWithRed:green:blue:alpha` method in iOS; and, with just a little work, it can be easily formatted into a CSS `rgba()` string in JavaScript. This reference page doesn't have information about the absolute color space that should be used to interpret the RGB value\u2014for example, sRGB, Adobe RGB, DCI-P3, and BT.2020. By default, applications should assume the sRGB color space. When color equality needs to be decided, implementations, unless documented otherwise, treat two colors as equal if all their red, green, blue, and alpha values each differ by at most `1e-5`. Example (Java): import com.google.type.Color; // ... public static java.awt.Color fromProto(Color protocolor) { float alpha = protocolor.hasAlpha() ? protocolor.getAlpha().getValue() : 1.0; return new java.awt.Color( protocolor.getRed(), protocolor.getGreen(), protocolor.getBlue(), alpha); } public static Color toProto(java.awt.Color color) { float red = (float) color.getRed(); float green = (float) color.getGreen(); float blue = (float) color.getBlue(); float denominator = 255.0; Color.Builder resultBuilder = Color .newBuilder() .setRed(red / denominator) .setGreen(green / denominator) .setBlue(blue / denominator); int alpha = color.getAlpha(); if (alpha != 255) { result.setAlpha( FloatValue .newBuilder() .setValue(((float) alpha) / denominator) .build()); } return resultBuilder.build(); } // ... Example (iOS / Obj-C): // ... static UIColor* fromProto(Color* protocolor) { float red = [protocolor red]; float green = [protocolor green]; float blue = [protocolor blue]; FloatValue* alpha_wrapper = [protocolor alpha]; float alpha = 1.0; if (alpha_wrapper != nil) { alpha = [alpha_wrapper value]; } return [UIColor colorWithRed:red green:green blue:blue alpha:alpha]; } static Color* toProto(UIColor* color) { CGFloat red, green, blue, alpha; if (![color getRed:&red green:&green blue:&blue alpha:&alpha]) { return nil; } Color* result = [[Color alloc] init]; [result setRed:red]; [result setGreen:green]; [result setBlue:blue]; if (alpha <= 0.9999) { [result setAlpha:floatWrapperWithValue(alpha)]; } [result autorelease]; return result; } // ... Example (JavaScript): // ... var protoToCssColor = function(rgb_color) { var redFrac = rgb_color.red || 0.0; var greenFrac = rgb_color.green || 0.0; var blueFrac = rgb_color.blue || 0.0; var red = Math.floor(redFrac * 255); var green = Math.floor(greenFrac * 255); var blue = Math.floor(blueFrac * 255); if (!('alpha' in rgb_color)) { return rgbToCssColor(red, green, blue); } var alphaFrac = rgb_color.alpha.value || 0.0; var rgbParams = [red, green, blue].join(','); return ['rgba(', rgbParams, ',', alphaFrac, ')'].join(''); }; var rgbToCssColor = function(red, green, blue) { var rgbNumber = new Number((red << 16) | (green << 8) | blue); var hexString = rgbNumber.toString(16); var missingZeros = 6 - hexString.length; var resultBuilder = ['#']; for (var i = 0; i < missingZeros; i++) { resultBuilder.push('0'); } resultBuilder.push(hexString); return resultBuilder.join(''); }; // ...", +"id": "Color", +"properties": { +"alpha": { +"description": "The fraction of this color that should be applied to the pixel. That is, the final pixel color is defined by the equation: `pixel color = alpha * (this color) + (1.0 - alpha) * (background color)` This means that a value of 1.0 corresponds to a solid color, whereas a value of 0.0 corresponds to a completely transparent color. This uses a wrapper message rather than a simple float scalar so that it is possible to distinguish between a default value and the value being unset. If omitted, this color object is rendered as a solid color (as if the alpha value had been explicitly given a value of 1.0).", +"format": "float", +"type": "number" +}, +"blue": { +"description": "The amount of blue in the color as a value in the interval [0, 1].", +"format": "float", +"type": "number" +}, +"green": { +"description": "The amount of green in the color as a value in the interval [0, 1].", +"format": "float", +"type": "number" +}, +"red": { +"description": "The amount of red in the color as a value in the interval [0, 1].", +"format": "float", +"type": "number" +} +}, +"type": "object" +}, +"Concentration": { +"description": "The concentration of a given pollutant in the air.", +"id": "Concentration", +"properties": { +"units": { +"description": "Units for measuring this pollutant concentration.", +"enum": [ +"UNIT_UNSPECIFIED", +"PARTS_PER_BILLION", +"MICROGRAMS_PER_CUBIC_METER" +], +"enumDescriptions": [ +"Unspecified concentration unit.", +"The ppb (parts per billion) concentration unit.", +"The \"\u00b5g/m^3\" (micrograms per cubic meter) concentration unit." +], +"type": "string" +}, +"value": { +"description": "Value of pollutant concentration.", +"format": "float", +"type": "number" +} +}, +"type": "object" +}, +"CustomLocalAqi": { +"description": "Expresses a 'country/region to AQI' relationship. Pairs a country/region with a desired AQI so that air quality data that is required for that country/region will be displayed according to the chosen AQI.", +"id": "CustomLocalAqi", +"properties": { +"aqi": { +"description": "The AQI to associate the country/region with. Value should be a [valid index](/maps/documentation/air-quality/laqis) code.", +"type": "string" +}, +"regionCode": { +"description": "The country/region requiring the custom AQI. Value should be provided using [ISO 3166-1 alpha-2](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2) code.", +"type": "string" +} +}, +"type": "object" +}, +"HealthRecommendations": { +"description": "Health recommendations for different population groups in a free text format. The recommendations are derived from their associated air quality conditions.", +"id": "HealthRecommendations", +"properties": { +"athletes": { +"description": "Sports and other strenuous outdoor activities.", +"type": "string" +}, +"children": { +"description": "Younger populations including children, toddlers, and babies.", +"type": "string" +}, +"elderly": { +"description": "Retirees and people older than the general population.", +"type": "string" +}, +"generalPopulation": { +"description": "No specific sensitivities.", +"type": "string" +}, +"heartDiseasePopulation": { +"description": "Heart and circulatory system diseases.", +"type": "string" +}, +"lungDiseasePopulation": { +"description": "Respiratory related problems and asthma suffers.", +"type": "string" +}, +"pregnantWomen": { +"description": "Women at all stages of pregnancy.", +"type": "string" +} +}, +"type": "object" +}, +"HourInfo": { +"description": "Contains the air quality information for each hour in the requested range. For example, if the request is for 48 hours of history there will be 48 elements of hourly info.", +"id": "HourInfo", +"properties": { +"dateTime": { +"description": "A rounded down timestamp indicating the time the data refers to in RFC3339 UTC \"Zulu\" format, with nanosecond resolution and up to nine fractional digits. For example: \"2014-10-02T15:00:00Z\".", +"format": "google-datetime", +"type": "string" +}, +"healthRecommendations": { +"$ref": "HealthRecommendations", +"description": "Health advice and recommended actions related to the reported air quality conditions. Recommendations are tailored differently for populations at risk, groups with greater sensitivities to pollutants, and the general population." +}, +"indexes": { +"description": "Based on the request parameters, this list will include (up to) two air quality indexes: - Universal AQI. Will be returned if the universalAqi boolean is set to true. - Local AQI. Will be returned if the LOCAL_AQI extra computation is specified.", +"items": { +"$ref": "AirQualityIndex" +}, +"type": "array" +}, +"pollutants": { +"description": "A list of pollutants affecting the location specified in the request. Note: This field will be returned only for requests that specified one or more of the following extra computations: POLLUTANT_ADDITIONAL_INFO, DOMINANT_POLLUTANT_CONCENTRATION, POLLUTANT_CONCENTRATION.", +"items": { +"$ref": "Pollutant" +}, +"type": "array" +} +}, +"type": "object" +}, +"HourlyForecast": { +"description": "Contains the air quality information for each hour in the requested range. For example, if the request is for 48 hours of forecast there will be 48 elements of hourly forecasts.", +"id": "HourlyForecast", +"properties": { +"dateTime": { +"description": "A rounded down timestamp indicating the time (hour) the data refers to in RFC3339 UTC \"Zulu\" format. For example: \"2014-10-02T15:00:00Z\".", +"format": "google-datetime", +"type": "string" +}, +"healthRecommendations": { +"$ref": "HealthRecommendations", +"description": "Health advice and recommended actions related to the reported air quality conditions. Recommendations are tailored differently for populations at risk, groups with greater sensitivities to pollutants, and the general population." +}, +"indexes": { +"description": "Based on the request parameters, this list will include (up to) two air quality indexes: - Universal AQI. Will be returned if the `universal_aqi` boolean is set to true. - Local AQI. Will be returned if the LOCAL_AQI extra computation is specified.", +"items": { +"$ref": "AirQualityIndex" +}, +"type": "array" +}, +"pollutants": { +"description": "A list of pollutants affecting the location specified in the request. Note: This field will be returned only for requests that specified one or more of the following extra computations: POLLUTANT_ADDITIONAL_INFO, DOMINANT_POLLUTANT_CONCENTRATION, POLLUTANT_CONCENTRATION.", +"items": { +"$ref": "Pollutant" +}, +"type": "array" +} +}, +"type": "object" +}, +"HttpBody": { +"description": "Message that represents an arbitrary HTTP body. It should only be used for payload formats that can't be represented as JSON, such as raw binary or an HTML page. This message can be used both in streaming and non-streaming API methods in the request as well as the response. It can be used as a top-level request field, which is convenient if one wants to extract parameters from either the URL or HTTP template into the request fields and also want access to the raw HTTP body. Example: message GetResourceRequest { // A unique request id. string request_id = 1; // The raw HTTP body is bound to this field. google.api.HttpBody http_body = 2; } service ResourceService { rpc GetResource(GetResourceRequest) returns (google.api.HttpBody); rpc UpdateResource(google.api.HttpBody) returns (google.protobuf.Empty); } Example with streaming methods: service CaldavService { rpc GetCalendar(stream google.api.HttpBody) returns (stream google.api.HttpBody); rpc UpdateCalendar(stream google.api.HttpBody) returns (stream google.api.HttpBody); } Use of this type only changes how the request and response bodies are handled, all other features will continue to work unchanged.", +"id": "HttpBody", +"properties": { +"contentType": { +"description": "The HTTP Content-Type header value specifying the content type of the body.", +"type": "string" +}, +"data": { +"description": "The HTTP request/response body as raw binary.", +"format": "byte", +"type": "string" +}, +"extensions": { +"description": "Application specific response metadata. Must be set in the first response for streaming APIs.", +"items": { +"additionalProperties": { +"description": "Properties of the object. Contains field @type with type URL.", +"type": "any" +}, +"type": "object" +}, +"type": "array" +} +}, +"type": "object" +}, +"Interval": { +"description": "Represents a time interval, encoded as a Timestamp start (inclusive) and a Timestamp end (exclusive). The start must be less than or equal to the end. When the start equals the end, the interval is empty (matches no time). When both start and end are unspecified, the interval matches any time.", +"id": "Interval", +"properties": { +"endTime": { +"description": "Optional. Exclusive end of the interval. If specified, a Timestamp matching this interval will have to be before the end.", +"format": "google-datetime", +"type": "string" +}, +"startTime": { +"description": "Optional. Inclusive start of the interval. If specified, a Timestamp matching this interval will have to be the same or after the start.", +"format": "google-datetime", +"type": "string" +} +}, +"type": "object" +}, +"LatLng": { +"description": "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.", +"id": "LatLng", +"properties": { +"latitude": { +"description": "The latitude in degrees. It must be in the range [-90.0, +90.0].", +"format": "double", +"type": "number" +}, +"longitude": { +"description": "The longitude in degrees. It must be in the range [-180.0, +180.0].", +"format": "double", +"type": "number" +} +}, +"type": "object" +}, +"LookupCurrentConditionsRequest": { +"description": "The request definition of the air quality current conditions.", +"id": "LookupCurrentConditionsRequest", +"properties": { +"customLocalAqis": { +"description": "Optional. Expresses a 'country/region to AQI' relationship. Pairs a country/region with a desired AQI so that air quality data that is required for that country/region will be displayed according to the chosen AQI. This parameter can be used to specify a non-default AQI for a given country, for example, to get the US EPA index for Canada rather than the default index for Canada.", +"items": { +"$ref": "CustomLocalAqi" +}, +"type": "array" +}, +"extraComputations": { +"description": "Optional. Additional features that can be optionally enabled. Specifying extra computations will result in the relevant elements and fields to be returned in the response.", +"items": { +"enum": [ +"EXTRA_COMPUTATION_UNSPECIFIED", +"LOCAL_AQI", +"HEALTH_RECOMMENDATIONS", +"POLLUTANT_ADDITIONAL_INFO", +"DOMINANT_POLLUTANT_CONCENTRATION", +"POLLUTANT_CONCENTRATION" +], +"enumDescriptions": [ +"The default value. The server ignores it if it is passed as a parameter.", +"Determines whether to include the local (national) AQI of the requested location (country) in the response. If specified, the response will contain an 'air_quality_index' data structure with all the relevant data on the location's local AQI.", +"Determines whether the response will include the health advice and recommended actions for the current AQI conditions. The recommendations are tailored for the general population and six populations at risk groups with greater sensitivities to pollutants than the general population. If specified, the `health_recommendations` field will be populated in the response when the relevant data is available.", +"Determines whether to include in the response the additional information of each pollutant. If specified, each air quality index object contained in the 'indexes' field response will include an `additional_info` field when the data is available.", +"Determines whether the response would include the concentrations of the dominant pollutants measured according to global and/or local indexes. If the request specified both the global AQI and the local AQI, there may be up to two pollutant codes returned. If specified, the dominant pollutant object contained in the 'pollutants' list will include a `concentration` field when the data is available.", +"Determines whether the response would include the concentrations of all pollutants with available measurements according to global and/or local indexes. If specified, each pollutant object contained in the 'pollutants' field in the response will include a `concentration` field when the data is available." +], +"type": "string" +}, +"type": "array" +}, +"languageCode": { +"description": "Optional. Allows the client to choose the language for the response. If data cannot be provided for that language the API uses the closest match. Allowed values rely on the IETF standard. Default value is en.", +"type": "string" +}, +"location": { +"$ref": "LatLng", +"description": "Required. The longitude and latitude from which the API looks for air quality current conditions data." +}, +"uaqiColorPalette": { +"description": "Optional. Determines the color palette used for data provided by the 'Universal Air Quality Index' (UAQI). This color palette is relevant just for UAQI, other AQIs have a predetermined color palette that can't be controlled.", +"enum": [ +"COLOR_PALETTE_UNSPECIFIED", +"RED_GREEN", +"INDIGO_PERSIAN_DARK", +"INDIGO_PERSIAN_LIGHT" +], +"enumDescriptions": [ +"The default value. Ignored if passed as a parameter.", +"Determines whether to use a red/green palette.", +"Determines whether to use a indigo/persian palette (dark theme).", +"Determines whether to use a indigo/persian palette (light theme)." +], +"type": "string" +}, +"universalAqi": { +"description": "Optional. If set to true, the Universal AQI will be included in the 'indexes' field of the response. Default value is true.", +"type": "boolean" +} +}, +"type": "object" +}, +"LookupCurrentConditionsResponse": { +"id": "LookupCurrentConditionsResponse", +"properties": { +"dateTime": { +"description": "A rounded down timestamp in RFC3339 UTC \"Zulu\" format, with nanosecond resolution and up to nine fractional digits. For example: \"2014-10-02T15:00:00Z\".", +"format": "google-datetime", +"type": "string" +}, +"healthRecommendations": { +"$ref": "HealthRecommendations", +"description": "Health advice and recommended actions related to the reported air quality conditions. Recommendations are tailored differently for populations at risk, groups with greater sensitivities to pollutants, and the general population." +}, +"indexes": { +"description": "Based on the request parameters, this list will include (up to) two air quality indexes: - Universal AQI. Will be returned if the universalAqi boolean is set to true. - Local AQI. Will be returned if the LOCAL_AQI extra computation is specified.", +"items": { +"$ref": "AirQualityIndex" +}, +"type": "array" +}, +"pollutants": { +"description": "A list of pollutants affecting the location specified in the request. Note: This field will be returned only for requests that specified one or more of the following extra computations: POLLUTANT_ADDITIONAL_INFO, DOMINANT_POLLUTANT_CONCENTRATION, POLLUTANT_CONCENTRATION.", +"items": { +"$ref": "Pollutant" +}, +"type": "array" +}, +"regionCode": { +"description": "The ISO_3166-1 alpha-2 code of the country/region corresponding to the location provided in the request. This field might be omitted from the response if the location provided in the request resides in a disputed territory.", +"type": "string" +} +}, +"type": "object" +}, +"LookupForecastRequest": { +"description": "The request object of the air quality forecast API.", +"id": "LookupForecastRequest", +"properties": { +"customLocalAqis": { +"description": "Optional. Expresses a 'country/region to AQI' relationship. Pairs a country/region with a desired AQI so that air quality data that is required for that country/region will be displayed according to the chosen AQI. This parameter can be used to specify a non-default AQI for a given country, for example, to get the US EPA index for Canada rather than the default index for Canada.", +"items": { +"$ref": "CustomLocalAqi" +}, +"type": "array" +}, +"dateTime": { +"description": "A timestamp for which to return the data for a specific point in time. The timestamp is rounded to the previous exact hour. Note: this will return hourly data for the requested timestamp only (i.e. a single hourly info element). For example, a request sent where the date_time parameter is set to 2023-01-03T11:05:49Z will be rounded down to 2023-01-03T11:00:00Z.", +"format": "google-datetime", +"type": "string" +}, +"extraComputations": { +"description": "Optional. Additional features that can be optionally enabled. Specifying extra computations will result in the relevant elements and fields to be returned in the response.", +"items": { +"enum": [ +"EXTRA_COMPUTATION_UNSPECIFIED", +"LOCAL_AQI", +"HEALTH_RECOMMENDATIONS", +"POLLUTANT_ADDITIONAL_INFO", +"DOMINANT_POLLUTANT_CONCENTRATION", +"POLLUTANT_CONCENTRATION" +], +"enumDescriptions": [ +"The default value. The server ignores it if it is passed as a parameter.", +"Determines whether to include the local (national) AQI of the requested location (country) in the response. If specified, the response will contain an 'air_quality_index' data structure with all the relevant data on the location's local AQI.", +"Determines whether the response will include the health advice and recommended actions for the current AQI conditions. The recommendations are tailored for the general population and six populations at risk groups with greater sensitivities to pollutants than the general population. If specified, the `health_recommendations` field will be populated in the response when the relevant data is available.", +"Determines whether to include in the response the additional information of each pollutant. If specified, each air quality index object contained in the 'indexes' field response will include an `additional_info` field when the data is available.", +"Determines whether the response would include the concentrations of the dominant pollutants measured according to global and/or local indexes. If the request specified both the global AQI and the local AQI, there may be up to two pollutant codes returned. If specified, the dominant pollutant object contained in the 'pollutants' list will include a `concentration` field when the data is available.", +"Determines whether the response would include the concentrations of all pollutants with available measurements according to global and/or local indexes. If specified, each pollutant object contained in the 'pollutants' field in the response will include a `concentration` field when the data is available." +], +"type": "string" +}, +"type": "array" +}, +"languageCode": { +"description": "Optional. Allows the client to choose the language for the response. If data cannot be provided for that language the API uses the closest match. Allowed values rely on the IETF standard (default = 'en').", +"type": "string" +}, +"location": { +"$ref": "LatLng", +"description": "Required. The latitude and longitude for which the API looks for air quality data." +}, +"pageSize": { +"description": "Optional. The maximum number of hourly info records to return per page (default = 24).", +"format": "int32", +"type": "integer" +}, +"pageToken": { +"description": "Optional. A page token received from a previous forecast call. It is used to retrieve the subsequent page.", +"type": "string" +}, +"period": { +"$ref": "Interval", +"description": "Indicates the start and end period for which to get the forecast data. The timestamp is rounded to the previous exact hour." +}, +"uaqiColorPalette": { +"description": "Optional. Determines the color palette used for data provided by the 'Universal Air Quality Index' (UAQI). This color palette is relevant just for UAQI, other AQIs have a predetermined color palette that can't be controlled.", +"enum": [ +"COLOR_PALETTE_UNSPECIFIED", +"RED_GREEN", +"INDIGO_PERSIAN_DARK", +"INDIGO_PERSIAN_LIGHT" +], +"enumDescriptions": [ +"The default value. Ignored if passed as a parameter.", +"Determines whether to use a red/green palette.", +"Determines whether to use a indigo/persian palette (dark theme).", +"Determines whether to use a indigo/persian palette (light theme)." +], +"type": "string" +}, +"universalAqi": { +"description": "Optional. If set to true, the Universal AQI will be included in the 'indexes' field of the response (default = true).", +"type": "boolean" +} +}, +"type": "object" +}, +"LookupForecastResponse": { +"description": "The response object of the air quality forecast API.", +"id": "LookupForecastResponse", +"properties": { +"hourlyForecasts": { +"description": "Optional. Contains the air quality information for each hour in the requested range. For example, if the request is for 48 hours of forecast there will be 48 elements of hourly forecasts.", +"items": { +"$ref": "HourlyForecast" +}, +"type": "array" +}, +"nextPageToken": { +"description": "Optional. The token to retrieve the next page.", +"type": "string" +}, +"regionCode": { +"description": "Optional. The ISO_3166-1 alpha-2 code of the country/region corresponding to the location provided in the request. This field might be omitted from the response if the location provided in the request resides in a disputed territory.", +"type": "string" +} +}, +"type": "object" +}, +"LookupHistoryRequest": { +"description": "The request object of the air quality history API.", +"id": "LookupHistoryRequest", +"properties": { +"customLocalAqis": { +"description": "Optional. Expresses a 'country/region to AQI' relationship. Pairs a country/region with a desired AQI so that air quality data that is required for that country/region will be displayed according to the chosen AQI. This parameter can be used to specify a non-default AQI for a given country, for example, to get the US EPA index for Canada rather than the default index for Canada.", +"items": { +"$ref": "CustomLocalAqi" +}, +"type": "array" +}, +"dateTime": { +"description": "A timestamp for which to return historical data. The timestamp is rounded to the previous exact hour. Note: this will return hourly data for the requested timestamp only (i.e. a single hourly info element). For example, a request sent where the dateTime parameter is set to 2023-01-03T11:05:49Z will be rounded down to 2023-01-03T11:00:00Z. A timestamp in RFC3339 UTC \"Zulu\" format, with nanosecond resolution and up to nine fractional digits. Examples: \"2014-10-02T15:01:23Z\" and \"2014-10-02T15:01:23.045123456Z\".", +"format": "google-datetime", +"type": "string" +}, +"extraComputations": { +"description": "Optional. Additional features that can be optionally enabled. Specifying extra computations will result in the relevant elements and fields to be returned in the response.", +"items": { +"enum": [ +"EXTRA_COMPUTATION_UNSPECIFIED", +"LOCAL_AQI", +"HEALTH_RECOMMENDATIONS", +"POLLUTANT_ADDITIONAL_INFO", +"DOMINANT_POLLUTANT_CONCENTRATION", +"POLLUTANT_CONCENTRATION" +], +"enumDescriptions": [ +"The default value. The server ignores it if it is passed as a parameter.", +"Determines whether to include the local (national) AQI of the requested location (country) in the response. If specified, the response will contain an 'air_quality_index' data structure with all the relevant data on the location's local AQI.", +"Determines whether the response will include the health advice and recommended actions for the current AQI conditions. The recommendations are tailored for the general population and six populations at risk groups with greater sensitivities to pollutants than the general population. If specified, the `health_recommendations` field will be populated in the response when the relevant data is available.", +"Determines whether to include in the response the additional information of each pollutant. If specified, each air quality index object contained in the 'indexes' field response will include an `additional_info` field when the data is available.", +"Determines whether the response would include the concentrations of the dominant pollutants measured according to global and/or local indexes. If the request specified both the global AQI and the local AQI, there may be up to two pollutant codes returned. If specified, the dominant pollutant object contained in the 'pollutants' list will include a `concentration` field when the data is available.", +"Determines whether the response would include the concentrations of all pollutants with available measurements according to global and/or local indexes. If specified, each pollutant object contained in the 'pollutants' field in the response will include a `concentration` field when the data is available." +], +"type": "string" +}, +"type": "array" +}, +"hours": { +"description": "Number from 1 to 720 that indicates the hours range for the request. For example: A value of 48 will yield data from the last 48 hours.", +"format": "int32", +"type": "integer" +}, +"languageCode": { +"description": "Optional. Allows the client to choose the language for the response. If data cannot be provided for that language the API uses the closest match. Allowed values rely on the IETF standard. Default value is en.", +"type": "string" +}, +"location": { +"$ref": "LatLng", +"description": "Required. The latitude and longitude for which the API looks for air quality history data." +}, +"pageSize": { +"description": "Optional. The maximum number of hourly info records to return per page. The default is 72 and the max value is 168 (7 days of data).", +"format": "int32", +"type": "integer" +}, +"pageToken": { +"description": "Optional. A page token received from a previous history call. It is used to retrieve the subsequent page. Note that when providing a value for this parameter all other parameters provided must match the call that provided the page token (the previous call).", +"type": "string" +}, +"period": { +"$ref": "Interval", +"description": "Indicates the start and end period for which to get the historical data. The timestamp is rounded to the previous exact hour." +}, +"uaqiColorPalette": { +"description": "Optional. Determines the color palette used for data provided by the 'Universal Air Quality Index' (UAQI). This color palette is relevant just for UAQI, other AQIs have a predetermined color palette that can't be controlled.", +"enum": [ +"COLOR_PALETTE_UNSPECIFIED", +"RED_GREEN", +"INDIGO_PERSIAN_DARK", +"INDIGO_PERSIAN_LIGHT" +], +"enumDescriptions": [ +"The default value. Ignored if passed as a parameter.", +"Determines whether to use a red/green palette.", +"Determines whether to use a indigo/persian palette (dark theme).", +"Determines whether to use a indigo/persian palette (light theme)." +], +"type": "string" +}, +"universalAqi": { +"description": "Optional. If set to true, the Universal AQI will be included in the 'indexes' field of the response. Default value is true.", +"type": "boolean" +} +}, +"type": "object" +}, +"LookupHistoryResponse": { +"id": "LookupHistoryResponse", +"properties": { +"hoursInfo": { +"description": "Optional. Contains the air quality information for each hour in the requested range. For example, if the request is for 48 hours of history there will be 48 elements of hourly info.", +"items": { +"$ref": "HourInfo" +}, +"type": "array" +}, +"nextPageToken": { +"description": "Optional. The token to retrieve the next page.", +"type": "string" +}, +"regionCode": { +"description": "Optional. The ISO_3166-1 alpha-2 code of the country/region corresponding to the location provided in the request. This field might be omitted from the response if the location provided in the request resides in a disputed territory.", +"type": "string" +} +}, +"type": "object" +}, +"Pollutant": { +"description": "Data regarding an air quality pollutant.", +"id": "Pollutant", +"properties": { +"additionalInfo": { +"$ref": "AdditionalInfo", +"description": "Additional information about the pollutant." +}, +"code": { +"description": "The pollutant's code name. For example: \"so2\". A list of all available codes could be found [here](/maps/documentation/air-quality/pollutants#reported_pollutants).", +"type": "string" +}, +"concentration": { +"$ref": "Concentration", +"description": "The pollutant's concentration level measured by one of the standard air pollutation measure units." +}, +"displayName": { +"description": "The pollutant's display name. For example: \"NOx\".", +"type": "string" +}, +"fullName": { +"description": "The pollutant's full name. For chemical compounds, this is the IUPAC name. Example: \"Sulfur Dioxide\". For more information about the IUPAC names table, see https://iupac.org/what-we-do/periodic-table-of-elements/", +"type": "string" +} +}, +"type": "object" +} +}, +"servicePath": "", +"title": "Air Quality API", +"version": "v1", +"version_module": true +} \ No newline at end of file diff --git a/googleapiclient/discovery_cache/documents/alertcenter.v1beta1.json b/googleapiclient/discovery_cache/documents/alertcenter.v1beta1.json index dccca905844..7b44e62cd3d 100644 --- a/googleapiclient/discovery_cache/documents/alertcenter.v1beta1.json +++ b/googleapiclient/discovery_cache/documents/alertcenter.v1beta1.json @@ -423,7 +423,7 @@ } } }, -"revision": "20240527", +"revision": "20240603", "rootUrl": "https://alertcenter.googleapis.com/", "schemas": { "AbuseDetected": { diff --git a/googleapiclient/discovery_cache/documents/alloydb.v1.json b/googleapiclient/discovery_cache/documents/alloydb.v1.json index f6f94bd1e1f..3a08b7571bb 100644 --- a/googleapiclient/discovery_cache/documents/alloydb.v1.json +++ b/googleapiclient/discovery_cache/documents/alloydb.v1.json @@ -1461,7 +1461,7 @@ } } }, -"revision": "20240517", +"revision": "20240529", "rootUrl": "https://alloydb.googleapis.com/", "schemas": { "AuthorizedNetwork": { @@ -3375,9 +3375,17 @@ false "SIGNAL_TYPE_VIOLATES_CIS_GCP_FOUNDATION_1_2", "SIGNAL_TYPE_VIOLATES_CIS_GCP_FOUNDATION_1_1", "SIGNAL_TYPE_VIOLATES_CIS_GCP_FOUNDATION_1_0", +"SIGNAL_TYPE_VIOLATES_CIS_CONTROLS_V8_0", "SIGNAL_TYPE_VIOLATES_NIST_800_53", +"SIGNAL_TYPE_VIOLATES_NIST_800_53_R5", +"SIGNAL_TYPE_VIOLATES_NIST_CYBERSECURITY_FRAMEWORK_V1_0", "SIGNAL_TYPE_VIOLATES_ISO_27001", +"SIGNAL_TYPE_VIOLATES_ISO_27001_V2022", "SIGNAL_TYPE_VIOLATES_PCI_DSS_V3_2_1", +"SIGNAL_TYPE_VIOLATES_PCI_DSS_V4_0", +"SIGNAL_TYPE_VIOLATES_CLOUD_CONTROLS_MATRIX_V4", +"SIGNAL_TYPE_VIOLATES_HIPAA", +"SIGNAL_TYPE_VIOLATES_SOC2_V2017", "SIGNAL_TYPE_LOGS_NOT_OPTIMIZED_FOR_TROUBLESHOOTING", "SIGNAL_TYPE_QUERY_DURATIONS_NOT_LOGGED", "SIGNAL_TYPE_VERBOSE_ERROR_LOGGING", @@ -3503,6 +3511,14 @@ false, false, false, false, +false, +false, +false, +false, +false, +false, +false, +false, false ], "enumDescriptions": [ @@ -3521,9 +3537,17 @@ false "Represents if a resource violates CIS GCP Foundation 1.2.", "Represents if a resource violates CIS GCP Foundation 1.1.", "Represents if a resource violates CIS GCP Foundation 1.0.", +"Represents if a resource violates CIS Controls 8.0.", "Represents if a resource violates NIST 800-53.", +"Represents if a resource violates NIST 800-53 R5.", +"Represents if a resource violates NIST Cybersecurity Framework 1.0.", "Represents if a resource violates ISO-27001.", +"Represents if a resource violates ISO 27001 2022.", "Represents if a resource violates PCI-DSS v3.2.1.", +"Represents if a resource violates PCI-DSS v4.0.", +"Represents if a resource violates Cloud Controls Matrix v4.0.", +"Represents if a resource violates HIPAA.", +"Represents if a resource violates SOC2 v2017.", "Represents if log_checkpoints database flag for a Cloud SQL for PostgreSQL instance is not set to on.", "Represents if the log_duration database flag for a Cloud SQL for PostgreSQL instance is not set to on.", "Represents if the log_error_verbosity database flag for a Cloud SQL for PostgreSQL instance is not set to default or stricter (default or terse).", @@ -3787,14 +3811,6 @@ false "userLabelSet": { "$ref": "StorageDatabasecenterPartnerapiV1mainUserLabels", "description": "User-provided labels associated with the resource" -}, -"userLabels": { -"additionalProperties": { -"type": "string" -}, -"deprecated": true, -"description": "User-provided labels, represented as a dictionary where each label is a single key value pair.", -"type": "object" } }, "type": "object" @@ -3870,9 +3886,17 @@ false "SIGNAL_TYPE_VIOLATES_CIS_GCP_FOUNDATION_1_2", "SIGNAL_TYPE_VIOLATES_CIS_GCP_FOUNDATION_1_1", "SIGNAL_TYPE_VIOLATES_CIS_GCP_FOUNDATION_1_0", +"SIGNAL_TYPE_VIOLATES_CIS_CONTROLS_V8_0", "SIGNAL_TYPE_VIOLATES_NIST_800_53", +"SIGNAL_TYPE_VIOLATES_NIST_800_53_R5", +"SIGNAL_TYPE_VIOLATES_NIST_CYBERSECURITY_FRAMEWORK_V1_0", "SIGNAL_TYPE_VIOLATES_ISO_27001", +"SIGNAL_TYPE_VIOLATES_ISO_27001_V2022", "SIGNAL_TYPE_VIOLATES_PCI_DSS_V3_2_1", +"SIGNAL_TYPE_VIOLATES_PCI_DSS_V4_0", +"SIGNAL_TYPE_VIOLATES_CLOUD_CONTROLS_MATRIX_V4", +"SIGNAL_TYPE_VIOLATES_HIPAA", +"SIGNAL_TYPE_VIOLATES_SOC2_V2017", "SIGNAL_TYPE_LOGS_NOT_OPTIMIZED_FOR_TROUBLESHOOTING", "SIGNAL_TYPE_QUERY_DURATIONS_NOT_LOGGED", "SIGNAL_TYPE_VERBOSE_ERROR_LOGGING", @@ -3998,6 +4022,14 @@ false, false, false, false, +false, +false, +false, +false, +false, +false, +false, +false, false ], "enumDescriptions": [ @@ -4016,9 +4048,17 @@ false "Represents if a resource violates CIS GCP Foundation 1.2.", "Represents if a resource violates CIS GCP Foundation 1.1.", "Represents if a resource violates CIS GCP Foundation 1.0.", +"Represents if a resource violates CIS Controls 8.0.", "Represents if a resource violates NIST 800-53.", +"Represents if a resource violates NIST 800-53 R5.", +"Represents if a resource violates NIST Cybersecurity Framework 1.0.", "Represents if a resource violates ISO-27001.", +"Represents if a resource violates ISO 27001 2022.", "Represents if a resource violates PCI-DSS v3.2.1.", +"Represents if a resource violates PCI-DSS v4.0.", +"Represents if a resource violates Cloud Controls Matrix v4.0.", +"Represents if a resource violates HIPAA.", +"Represents if a resource violates SOC2 v2017.", "Represents if log_checkpoints database flag for a Cloud SQL for PostgreSQL instance is not set to on.", "Represents if the log_duration database flag for a Cloud SQL for PostgreSQL instance is not set to on.", "Represents if the log_error_verbosity database flag for a Cloud SQL for PostgreSQL instance is not set to default or stricter (default or terse).", @@ -4116,12 +4156,12 @@ false "id": "StorageDatabasecenterPartnerapiV1mainMachineConfiguration", "properties": { "cpuCount": { -"description": "The number of CPUs.", +"description": "The number of CPUs. TODO(b/342344482, b/342346271) add proto validations again after bug fix.", "format": "int32", "type": "integer" }, "memorySizeInBytes": { -"description": "Memory size in bytes.", +"description": "Memory size in bytes. TODO(b/342344482, b/342346271) add proto validations again after bug fix.", "format": "int64", "type": "string" } @@ -4131,31 +4171,46 @@ false "StorageDatabasecenterPartnerapiV1mainObservabilityMetricData": { "id": "StorageDatabasecenterPartnerapiV1mainObservabilityMetricData", "properties": { -"metricTimestamp": { -"description": "Required. The timestamp of the metric value.", -"format": "google-datetime", +"aggregationType": { +"description": "Required. Type of aggregation performed on the metric.", +"enum": [ +"AGGREGATION_TYPE_UNSPECIFIED", +"MAXIMUM" +], +"enumDescriptions": [ +"Unspecified aggregation type.", +"Maximum aggregation type." +], "type": "string" }, "metricType": { "description": "Required. Type of metric like CPU, Memory, etc.", "enum": [ "METRIC_TYPE_UNSPECIFIED", -"INSTANCE_PEAK_CPU_UTILISATION" +"CPU_UTILIZATION", +"MEMORY_UTILIZATION", +"NETWORK_CONNECTIONS" ], "enumDescriptions": [ -"", -"Peak CPU utilization for a DB instance as a fraction between 0.0 and 1.0 (may momentarily exceed 1.0 in some cases) List will keep increasing, e.g. PEAK_MEMORY_UTILISATION, NUMBER_OF_CONNECTIONS, SUCCESS_RATIO_FOR_QUERIES, etc." +"Unspecified metric type.", +"CPU utilization for a resource. The value is a fraction between 0.0 and 1.0 (may momentarily exceed 1.0 in some cases).", +"Memory utilization for a resource. The value is a fraction between 0.0 and 1.0 (may momentarily exceed 1.0 in some cases).", +"Number of network connections for a resource." ], "type": "string" }, +"observationTime": { +"description": "Required. The time the metric value was observed.", +"format": "google-datetime", +"type": "string" +}, "resourceName": { "description": "Required. Database resource name associated with the signal. Resource name to follow CAIS resource_name format as noted here go/condor-common-datamodel", "type": "string" }, "value": { -"description": "Required. Value of the metric type.", -"format": "double", -"type": "number" +"$ref": "StorageDatabasecenterProtoCommonTypedValue", +"description": "Required. Value of the metric type." } }, "type": "object" @@ -4345,6 +4400,31 @@ false }, "type": "object" }, +"StorageDatabasecenterProtoCommonTypedValue": { +"description": "TypedValue represents the value of a metric type. It can either be a double, an int64, a string or a bool.", +"id": "StorageDatabasecenterProtoCommonTypedValue", +"properties": { +"boolValue": { +"description": "For boolean value", +"type": "boolean" +}, +"doubleValue": { +"description": "For double value", +"format": "double", +"type": "number" +}, +"int64Value": { +"description": "For integer value", +"format": "int64", +"type": "string" +}, +"stringValue": { +"description": "For string value", +"type": "string" +} +}, +"type": "object" +}, "StringRestrictions": { "description": "Restrictions on STRING type values", "id": "StringRestrictions", diff --git a/googleapiclient/discovery_cache/documents/alloydb.v1alpha.json b/googleapiclient/discovery_cache/documents/alloydb.v1alpha.json index c59ad666759..39ef401038a 100644 --- a/googleapiclient/discovery_cache/documents/alloydb.v1alpha.json +++ b/googleapiclient/discovery_cache/documents/alloydb.v1alpha.json @@ -1461,7 +1461,7 @@ } } }, -"revision": "20240517", +"revision": "20240529", "rootUrl": "https://alloydb.googleapis.com/", "schemas": { "AuthorizedNetwork": { @@ -3498,9 +3498,17 @@ false "SIGNAL_TYPE_VIOLATES_CIS_GCP_FOUNDATION_1_2", "SIGNAL_TYPE_VIOLATES_CIS_GCP_FOUNDATION_1_1", "SIGNAL_TYPE_VIOLATES_CIS_GCP_FOUNDATION_1_0", +"SIGNAL_TYPE_VIOLATES_CIS_CONTROLS_V8_0", "SIGNAL_TYPE_VIOLATES_NIST_800_53", +"SIGNAL_TYPE_VIOLATES_NIST_800_53_R5", +"SIGNAL_TYPE_VIOLATES_NIST_CYBERSECURITY_FRAMEWORK_V1_0", "SIGNAL_TYPE_VIOLATES_ISO_27001", +"SIGNAL_TYPE_VIOLATES_ISO_27001_V2022", "SIGNAL_TYPE_VIOLATES_PCI_DSS_V3_2_1", +"SIGNAL_TYPE_VIOLATES_PCI_DSS_V4_0", +"SIGNAL_TYPE_VIOLATES_CLOUD_CONTROLS_MATRIX_V4", +"SIGNAL_TYPE_VIOLATES_HIPAA", +"SIGNAL_TYPE_VIOLATES_SOC2_V2017", "SIGNAL_TYPE_LOGS_NOT_OPTIMIZED_FOR_TROUBLESHOOTING", "SIGNAL_TYPE_QUERY_DURATIONS_NOT_LOGGED", "SIGNAL_TYPE_VERBOSE_ERROR_LOGGING", @@ -3626,6 +3634,14 @@ false, false, false, false, +false, +false, +false, +false, +false, +false, +false, +false, false ], "enumDescriptions": [ @@ -3644,9 +3660,17 @@ false "Represents if a resource violates CIS GCP Foundation 1.2.", "Represents if a resource violates CIS GCP Foundation 1.1.", "Represents if a resource violates CIS GCP Foundation 1.0.", +"Represents if a resource violates CIS Controls 8.0.", "Represents if a resource violates NIST 800-53.", +"Represents if a resource violates NIST 800-53 R5.", +"Represents if a resource violates NIST Cybersecurity Framework 1.0.", "Represents if a resource violates ISO-27001.", +"Represents if a resource violates ISO 27001 2022.", "Represents if a resource violates PCI-DSS v3.2.1.", +"Represents if a resource violates PCI-DSS v4.0.", +"Represents if a resource violates Cloud Controls Matrix v4.0.", +"Represents if a resource violates HIPAA.", +"Represents if a resource violates SOC2 v2017.", "Represents if log_checkpoints database flag for a Cloud SQL for PostgreSQL instance is not set to on.", "Represents if the log_duration database flag for a Cloud SQL for PostgreSQL instance is not set to on.", "Represents if the log_error_verbosity database flag for a Cloud SQL for PostgreSQL instance is not set to default or stricter (default or terse).", @@ -3910,14 +3934,6 @@ false "userLabelSet": { "$ref": "StorageDatabasecenterPartnerapiV1mainUserLabels", "description": "User-provided labels associated with the resource" -}, -"userLabels": { -"additionalProperties": { -"type": "string" -}, -"deprecated": true, -"description": "User-provided labels, represented as a dictionary where each label is a single key value pair.", -"type": "object" } }, "type": "object" @@ -3993,9 +4009,17 @@ false "SIGNAL_TYPE_VIOLATES_CIS_GCP_FOUNDATION_1_2", "SIGNAL_TYPE_VIOLATES_CIS_GCP_FOUNDATION_1_1", "SIGNAL_TYPE_VIOLATES_CIS_GCP_FOUNDATION_1_0", +"SIGNAL_TYPE_VIOLATES_CIS_CONTROLS_V8_0", "SIGNAL_TYPE_VIOLATES_NIST_800_53", +"SIGNAL_TYPE_VIOLATES_NIST_800_53_R5", +"SIGNAL_TYPE_VIOLATES_NIST_CYBERSECURITY_FRAMEWORK_V1_0", "SIGNAL_TYPE_VIOLATES_ISO_27001", +"SIGNAL_TYPE_VIOLATES_ISO_27001_V2022", "SIGNAL_TYPE_VIOLATES_PCI_DSS_V3_2_1", +"SIGNAL_TYPE_VIOLATES_PCI_DSS_V4_0", +"SIGNAL_TYPE_VIOLATES_CLOUD_CONTROLS_MATRIX_V4", +"SIGNAL_TYPE_VIOLATES_HIPAA", +"SIGNAL_TYPE_VIOLATES_SOC2_V2017", "SIGNAL_TYPE_LOGS_NOT_OPTIMIZED_FOR_TROUBLESHOOTING", "SIGNAL_TYPE_QUERY_DURATIONS_NOT_LOGGED", "SIGNAL_TYPE_VERBOSE_ERROR_LOGGING", @@ -4121,6 +4145,14 @@ false, false, false, false, +false, +false, +false, +false, +false, +false, +false, +false, false ], "enumDescriptions": [ @@ -4139,9 +4171,17 @@ false "Represents if a resource violates CIS GCP Foundation 1.2.", "Represents if a resource violates CIS GCP Foundation 1.1.", "Represents if a resource violates CIS GCP Foundation 1.0.", +"Represents if a resource violates CIS Controls 8.0.", "Represents if a resource violates NIST 800-53.", +"Represents if a resource violates NIST 800-53 R5.", +"Represents if a resource violates NIST Cybersecurity Framework 1.0.", "Represents if a resource violates ISO-27001.", +"Represents if a resource violates ISO 27001 2022.", "Represents if a resource violates PCI-DSS v3.2.1.", +"Represents if a resource violates PCI-DSS v4.0.", +"Represents if a resource violates Cloud Controls Matrix v4.0.", +"Represents if a resource violates HIPAA.", +"Represents if a resource violates SOC2 v2017.", "Represents if log_checkpoints database flag for a Cloud SQL for PostgreSQL instance is not set to on.", "Represents if the log_duration database flag for a Cloud SQL for PostgreSQL instance is not set to on.", "Represents if the log_error_verbosity database flag for a Cloud SQL for PostgreSQL instance is not set to default or stricter (default or terse).", @@ -4239,12 +4279,12 @@ false "id": "StorageDatabasecenterPartnerapiV1mainMachineConfiguration", "properties": { "cpuCount": { -"description": "The number of CPUs.", +"description": "The number of CPUs. TODO(b/342344482, b/342346271) add proto validations again after bug fix.", "format": "int32", "type": "integer" }, "memorySizeInBytes": { -"description": "Memory size in bytes.", +"description": "Memory size in bytes. TODO(b/342344482, b/342346271) add proto validations again after bug fix.", "format": "int64", "type": "string" } @@ -4254,31 +4294,46 @@ false "StorageDatabasecenterPartnerapiV1mainObservabilityMetricData": { "id": "StorageDatabasecenterPartnerapiV1mainObservabilityMetricData", "properties": { -"metricTimestamp": { -"description": "Required. The timestamp of the metric value.", -"format": "google-datetime", +"aggregationType": { +"description": "Required. Type of aggregation performed on the metric.", +"enum": [ +"AGGREGATION_TYPE_UNSPECIFIED", +"MAXIMUM" +], +"enumDescriptions": [ +"Unspecified aggregation type.", +"Maximum aggregation type." +], "type": "string" }, "metricType": { "description": "Required. Type of metric like CPU, Memory, etc.", "enum": [ "METRIC_TYPE_UNSPECIFIED", -"INSTANCE_PEAK_CPU_UTILISATION" +"CPU_UTILIZATION", +"MEMORY_UTILIZATION", +"NETWORK_CONNECTIONS" ], "enumDescriptions": [ -"", -"Peak CPU utilization for a DB instance as a fraction between 0.0 and 1.0 (may momentarily exceed 1.0 in some cases) List will keep increasing, e.g. PEAK_MEMORY_UTILISATION, NUMBER_OF_CONNECTIONS, SUCCESS_RATIO_FOR_QUERIES, etc." +"Unspecified metric type.", +"CPU utilization for a resource. The value is a fraction between 0.0 and 1.0 (may momentarily exceed 1.0 in some cases).", +"Memory utilization for a resource. The value is a fraction between 0.0 and 1.0 (may momentarily exceed 1.0 in some cases).", +"Number of network connections for a resource." ], "type": "string" }, +"observationTime": { +"description": "Required. The time the metric value was observed.", +"format": "google-datetime", +"type": "string" +}, "resourceName": { "description": "Required. Database resource name associated with the signal. Resource name to follow CAIS resource_name format as noted here go/condor-common-datamodel", "type": "string" }, "value": { -"description": "Required. Value of the metric type.", -"format": "double", -"type": "number" +"$ref": "StorageDatabasecenterProtoCommonTypedValue", +"description": "Required. Value of the metric type." } }, "type": "object" @@ -4468,6 +4523,31 @@ false }, "type": "object" }, +"StorageDatabasecenterProtoCommonTypedValue": { +"description": "TypedValue represents the value of a metric type. It can either be a double, an int64, a string or a bool.", +"id": "StorageDatabasecenterProtoCommonTypedValue", +"properties": { +"boolValue": { +"description": "For boolean value", +"type": "boolean" +}, +"doubleValue": { +"description": "For double value", +"format": "double", +"type": "number" +}, +"int64Value": { +"description": "For integer value", +"format": "int64", +"type": "string" +}, +"stringValue": { +"description": "For string value", +"type": "string" +} +}, +"type": "object" +}, "StringRestrictions": { "description": "Restrictions on STRING type values", "id": "StringRestrictions", diff --git a/googleapiclient/discovery_cache/documents/alloydb.v1beta.json b/googleapiclient/discovery_cache/documents/alloydb.v1beta.json index 9056a62b1b8..55d334b0630 100644 --- a/googleapiclient/discovery_cache/documents/alloydb.v1beta.json +++ b/googleapiclient/discovery_cache/documents/alloydb.v1beta.json @@ -1458,7 +1458,7 @@ } } }, -"revision": "20240517", +"revision": "20240529", "rootUrl": "https://alloydb.googleapis.com/", "schemas": { "AuthorizedNetwork": { @@ -3474,9 +3474,17 @@ false "SIGNAL_TYPE_VIOLATES_CIS_GCP_FOUNDATION_1_2", "SIGNAL_TYPE_VIOLATES_CIS_GCP_FOUNDATION_1_1", "SIGNAL_TYPE_VIOLATES_CIS_GCP_FOUNDATION_1_0", +"SIGNAL_TYPE_VIOLATES_CIS_CONTROLS_V8_0", "SIGNAL_TYPE_VIOLATES_NIST_800_53", +"SIGNAL_TYPE_VIOLATES_NIST_800_53_R5", +"SIGNAL_TYPE_VIOLATES_NIST_CYBERSECURITY_FRAMEWORK_V1_0", "SIGNAL_TYPE_VIOLATES_ISO_27001", +"SIGNAL_TYPE_VIOLATES_ISO_27001_V2022", "SIGNAL_TYPE_VIOLATES_PCI_DSS_V3_2_1", +"SIGNAL_TYPE_VIOLATES_PCI_DSS_V4_0", +"SIGNAL_TYPE_VIOLATES_CLOUD_CONTROLS_MATRIX_V4", +"SIGNAL_TYPE_VIOLATES_HIPAA", +"SIGNAL_TYPE_VIOLATES_SOC2_V2017", "SIGNAL_TYPE_LOGS_NOT_OPTIMIZED_FOR_TROUBLESHOOTING", "SIGNAL_TYPE_QUERY_DURATIONS_NOT_LOGGED", "SIGNAL_TYPE_VERBOSE_ERROR_LOGGING", @@ -3602,6 +3610,14 @@ false, false, false, false, +false, +false, +false, +false, +false, +false, +false, +false, false ], "enumDescriptions": [ @@ -3620,9 +3636,17 @@ false "Represents if a resource violates CIS GCP Foundation 1.2.", "Represents if a resource violates CIS GCP Foundation 1.1.", "Represents if a resource violates CIS GCP Foundation 1.0.", +"Represents if a resource violates CIS Controls 8.0.", "Represents if a resource violates NIST 800-53.", +"Represents if a resource violates NIST 800-53 R5.", +"Represents if a resource violates NIST Cybersecurity Framework 1.0.", "Represents if a resource violates ISO-27001.", +"Represents if a resource violates ISO 27001 2022.", "Represents if a resource violates PCI-DSS v3.2.1.", +"Represents if a resource violates PCI-DSS v4.0.", +"Represents if a resource violates Cloud Controls Matrix v4.0.", +"Represents if a resource violates HIPAA.", +"Represents if a resource violates SOC2 v2017.", "Represents if log_checkpoints database flag for a Cloud SQL for PostgreSQL instance is not set to on.", "Represents if the log_duration database flag for a Cloud SQL for PostgreSQL instance is not set to on.", "Represents if the log_error_verbosity database flag for a Cloud SQL for PostgreSQL instance is not set to default or stricter (default or terse).", @@ -3886,14 +3910,6 @@ false "userLabelSet": { "$ref": "StorageDatabasecenterPartnerapiV1mainUserLabels", "description": "User-provided labels associated with the resource" -}, -"userLabels": { -"additionalProperties": { -"type": "string" -}, -"deprecated": true, -"description": "User-provided labels, represented as a dictionary where each label is a single key value pair.", -"type": "object" } }, "type": "object" @@ -3969,9 +3985,17 @@ false "SIGNAL_TYPE_VIOLATES_CIS_GCP_FOUNDATION_1_2", "SIGNAL_TYPE_VIOLATES_CIS_GCP_FOUNDATION_1_1", "SIGNAL_TYPE_VIOLATES_CIS_GCP_FOUNDATION_1_0", +"SIGNAL_TYPE_VIOLATES_CIS_CONTROLS_V8_0", "SIGNAL_TYPE_VIOLATES_NIST_800_53", +"SIGNAL_TYPE_VIOLATES_NIST_800_53_R5", +"SIGNAL_TYPE_VIOLATES_NIST_CYBERSECURITY_FRAMEWORK_V1_0", "SIGNAL_TYPE_VIOLATES_ISO_27001", +"SIGNAL_TYPE_VIOLATES_ISO_27001_V2022", "SIGNAL_TYPE_VIOLATES_PCI_DSS_V3_2_1", +"SIGNAL_TYPE_VIOLATES_PCI_DSS_V4_0", +"SIGNAL_TYPE_VIOLATES_CLOUD_CONTROLS_MATRIX_V4", +"SIGNAL_TYPE_VIOLATES_HIPAA", +"SIGNAL_TYPE_VIOLATES_SOC2_V2017", "SIGNAL_TYPE_LOGS_NOT_OPTIMIZED_FOR_TROUBLESHOOTING", "SIGNAL_TYPE_QUERY_DURATIONS_NOT_LOGGED", "SIGNAL_TYPE_VERBOSE_ERROR_LOGGING", @@ -4097,6 +4121,14 @@ false, false, false, false, +false, +false, +false, +false, +false, +false, +false, +false, false ], "enumDescriptions": [ @@ -4115,9 +4147,17 @@ false "Represents if a resource violates CIS GCP Foundation 1.2.", "Represents if a resource violates CIS GCP Foundation 1.1.", "Represents if a resource violates CIS GCP Foundation 1.0.", +"Represents if a resource violates CIS Controls 8.0.", "Represents if a resource violates NIST 800-53.", +"Represents if a resource violates NIST 800-53 R5.", +"Represents if a resource violates NIST Cybersecurity Framework 1.0.", "Represents if a resource violates ISO-27001.", +"Represents if a resource violates ISO 27001 2022.", "Represents if a resource violates PCI-DSS v3.2.1.", +"Represents if a resource violates PCI-DSS v4.0.", +"Represents if a resource violates Cloud Controls Matrix v4.0.", +"Represents if a resource violates HIPAA.", +"Represents if a resource violates SOC2 v2017.", "Represents if log_checkpoints database flag for a Cloud SQL for PostgreSQL instance is not set to on.", "Represents if the log_duration database flag for a Cloud SQL for PostgreSQL instance is not set to on.", "Represents if the log_error_verbosity database flag for a Cloud SQL for PostgreSQL instance is not set to default or stricter (default or terse).", @@ -4215,12 +4255,12 @@ false "id": "StorageDatabasecenterPartnerapiV1mainMachineConfiguration", "properties": { "cpuCount": { -"description": "The number of CPUs.", +"description": "The number of CPUs. TODO(b/342344482, b/342346271) add proto validations again after bug fix.", "format": "int32", "type": "integer" }, "memorySizeInBytes": { -"description": "Memory size in bytes.", +"description": "Memory size in bytes. TODO(b/342344482, b/342346271) add proto validations again after bug fix.", "format": "int64", "type": "string" } @@ -4230,31 +4270,46 @@ false "StorageDatabasecenterPartnerapiV1mainObservabilityMetricData": { "id": "StorageDatabasecenterPartnerapiV1mainObservabilityMetricData", "properties": { -"metricTimestamp": { -"description": "Required. The timestamp of the metric value.", -"format": "google-datetime", +"aggregationType": { +"description": "Required. Type of aggregation performed on the metric.", +"enum": [ +"AGGREGATION_TYPE_UNSPECIFIED", +"MAXIMUM" +], +"enumDescriptions": [ +"Unspecified aggregation type.", +"Maximum aggregation type." +], "type": "string" }, "metricType": { "description": "Required. Type of metric like CPU, Memory, etc.", "enum": [ "METRIC_TYPE_UNSPECIFIED", -"INSTANCE_PEAK_CPU_UTILISATION" +"CPU_UTILIZATION", +"MEMORY_UTILIZATION", +"NETWORK_CONNECTIONS" ], "enumDescriptions": [ -"", -"Peak CPU utilization for a DB instance as a fraction between 0.0 and 1.0 (may momentarily exceed 1.0 in some cases) List will keep increasing, e.g. PEAK_MEMORY_UTILISATION, NUMBER_OF_CONNECTIONS, SUCCESS_RATIO_FOR_QUERIES, etc." +"Unspecified metric type.", +"CPU utilization for a resource. The value is a fraction between 0.0 and 1.0 (may momentarily exceed 1.0 in some cases).", +"Memory utilization for a resource. The value is a fraction between 0.0 and 1.0 (may momentarily exceed 1.0 in some cases).", +"Number of network connections for a resource." ], "type": "string" }, +"observationTime": { +"description": "Required. The time the metric value was observed.", +"format": "google-datetime", +"type": "string" +}, "resourceName": { "description": "Required. Database resource name associated with the signal. Resource name to follow CAIS resource_name format as noted here go/condor-common-datamodel", "type": "string" }, "value": { -"description": "Required. Value of the metric type.", -"format": "double", -"type": "number" +"$ref": "StorageDatabasecenterProtoCommonTypedValue", +"description": "Required. Value of the metric type." } }, "type": "object" @@ -4444,6 +4499,31 @@ false }, "type": "object" }, +"StorageDatabasecenterProtoCommonTypedValue": { +"description": "TypedValue represents the value of a metric type. It can either be a double, an int64, a string or a bool.", +"id": "StorageDatabasecenterProtoCommonTypedValue", +"properties": { +"boolValue": { +"description": "For boolean value", +"type": "boolean" +}, +"doubleValue": { +"description": "For double value", +"format": "double", +"type": "number" +}, +"int64Value": { +"description": "For integer value", +"format": "int64", +"type": "string" +}, +"stringValue": { +"description": "For string value", +"type": "string" +} +}, +"type": "object" +}, "StringRestrictions": { "description": "Restrictions on STRING type values", "id": "StringRestrictions", diff --git a/googleapiclient/discovery_cache/documents/analyticsadmin.v1alpha.json b/googleapiclient/discovery_cache/documents/analyticsadmin.v1alpha.json index c222c65f800..f9e2eef00da 100644 --- a/googleapiclient/discovery_cache/documents/analyticsadmin.v1alpha.json +++ b/googleapiclient/discovery_cache/documents/analyticsadmin.v1alpha.json @@ -4646,7 +4646,7 @@ } } }, -"revision": "20240602", +"revision": "20240610", "rootUrl": "https://analyticsadmin.googleapis.com/", "schemas": { "GoogleAnalyticsAdminV1alphaAccessBetweenFilter": { diff --git a/googleapiclient/discovery_cache/documents/analyticsadmin.v1beta.json b/googleapiclient/discovery_cache/documents/analyticsadmin.v1beta.json index cef3f579101..cdf9f295364 100644 --- a/googleapiclient/discovery_cache/documents/analyticsadmin.v1beta.json +++ b/googleapiclient/discovery_cache/documents/analyticsadmin.v1beta.json @@ -1817,7 +1817,7 @@ } } }, -"revision": "20240602", +"revision": "20240610", "rootUrl": "https://analyticsadmin.googleapis.com/", "schemas": { "GoogleAnalyticsAdminV1betaAccessBetweenFilter": { diff --git a/googleapiclient/discovery_cache/documents/analyticsdata.v1beta.json b/googleapiclient/discovery_cache/documents/analyticsdata.v1beta.json index bd556a91e0b..82b8ef7c364 100644 --- a/googleapiclient/discovery_cache/documents/analyticsdata.v1beta.json +++ b/googleapiclient/discovery_cache/documents/analyticsdata.v1beta.json @@ -440,7 +440,7 @@ } } }, -"revision": "20240602", +"revision": "20240609", "rootUrl": "https://analyticsdata.googleapis.com/", "schemas": { "ActiveMetricRestriction": { diff --git a/googleapiclient/discovery_cache/documents/analyticshub.v1.json b/googleapiclient/discovery_cache/documents/analyticshub.v1.json index eb3a515a405..6c762a31f30 100644 --- a/googleapiclient/discovery_cache/documents/analyticshub.v1.json +++ b/googleapiclient/discovery_cache/documents/analyticshub.v1.json @@ -1022,7 +1022,7 @@ } } }, -"revision": "20240527", +"revision": "20240603", "rootUrl": "https://analyticshub.googleapis.com/", "schemas": { "AuditConfig": { diff --git a/googleapiclient/discovery_cache/documents/analyticshub.v1beta1.json b/googleapiclient/discovery_cache/documents/analyticshub.v1beta1.json index 6bdfa29927a..12ba9b12cc4 100644 --- a/googleapiclient/discovery_cache/documents/analyticshub.v1beta1.json +++ b/googleapiclient/discovery_cache/documents/analyticshub.v1beta1.json @@ -695,7 +695,7 @@ } } }, -"revision": "20240527", +"revision": "20240603", "rootUrl": "https://analyticshub.googleapis.com/", "schemas": { "AuditConfig": { diff --git a/googleapiclient/discovery_cache/documents/androiddeviceprovisioning.v1.json b/googleapiclient/discovery_cache/documents/androiddeviceprovisioning.v1.json index 945b8d38666..74f132a4044 100644 --- a/googleapiclient/discovery_cache/documents/androiddeviceprovisioning.v1.json +++ b/googleapiclient/discovery_cache/documents/androiddeviceprovisioning.v1.json @@ -851,7 +851,7 @@ } } }, -"revision": "20240529", +"revision": "20240609", "rootUrl": "https://androiddeviceprovisioning.googleapis.com/", "schemas": { "ClaimDeviceRequest": { diff --git a/googleapiclient/discovery_cache/documents/androidenterprise.v1.json b/googleapiclient/discovery_cache/documents/androidenterprise.v1.json index b6c869481d6..fcf4dcc8764 100644 --- a/googleapiclient/discovery_cache/documents/androidenterprise.v1.json +++ b/googleapiclient/discovery_cache/documents/androidenterprise.v1.json @@ -2649,7 +2649,7 @@ } } }, -"revision": "20240530", +"revision": "20240606", "rootUrl": "https://androidenterprise.googleapis.com/", "schemas": { "Administrator": { diff --git a/googleapiclient/discovery_cache/documents/androidmanagement.v1.json b/googleapiclient/discovery_cache/documents/androidmanagement.v1.json index 4fc15cd29c6..67f72996a35 100644 --- a/googleapiclient/discovery_cache/documents/androidmanagement.v1.json +++ b/googleapiclient/discovery_cache/documents/androidmanagement.v1.json @@ -638,7 +638,7 @@ ] }, "get": { -"description": "Gets an active, unexpired enrollment token. Only a partial view of EnrollmentToken is returned: all the fields but name and expiration_timestamp are empty. This method is meant to help manage active enrollment tokens lifecycle. For security reasons, it's recommended to delete active enrollment tokens as soon as they're not intended to be used anymore.", +"description": "Gets an active, unexpired enrollment token. A partial view of the enrollment token is returned. Only the following fields are populated: name, expirationTimestamp, allowPersonalUsage, value, qrCode. This method is meant to help manage active enrollment tokens lifecycle. For security reasons, it's recommended to delete active enrollment tokens as soon as they're not intended to be used anymore.", "flatPath": "v1/enterprises/{enterprisesId}/enrollmentTokens/{enrollmentTokensId}", "httpMethod": "GET", "id": "androidmanagement.enterprises.enrollmentTokens.get", @@ -663,7 +663,7 @@ ] }, "list": { -"description": "Lists active, unexpired enrollment tokens for a given enterprise. The list items contain only a partial view of EnrollmentToken: all the fields but name and expiration_timestamp are empty. This method is meant to help manage active enrollment tokens lifecycle. For security reasons, it's recommended to delete active enrollment tokens as soon as they're not intended to be used anymore.", +"description": "Lists active, unexpired enrollment tokens for a given enterprise. The list items contain only a partial view of EnrollmentToken object. Only the following fields are populated: name, expirationTimestamp, allowPersonalUsage, value, qrCode. This method is meant to help manage active enrollment tokens lifecycle. For security reasons, it's recommended to delete active enrollment tokens as soon as they're not intended to be used anymore.", "flatPath": "v1/enterprises/{enterprisesId}/enrollmentTokens", "httpMethod": "GET", "id": "androidmanagement.enterprises.enrollmentTokens.list", @@ -1168,7 +1168,7 @@ } } }, -"revision": "20240531", +"revision": "20240610", "rootUrl": "https://androidmanagement.googleapis.com/", "schemas": { "AdbShellCommandEvent": { @@ -1659,7 +1659,7 @@ "Unspecified. Defaults to AUTO_UPDATE_DEFAULT.", "The default update mode.The app is automatically updated with low priority to minimize the impact on the user.The app is updated when all of the following constraints are met: The device is not actively used. The device is connected to an unmetered network. The device is charging. The app to be updated is not running in the foreground.The device is notified about a new update within 24 hours after it is published by the developer, after which the app is updated the next time the constraints above are met.", "The app is not automatically updated for a maximum of 90 days after the app becomes out of date.90 days after the app becomes out of date, the latest available version is installed automatically with low priority (see AUTO_UPDATE_DEFAULT). After the app is updated it is not automatically updated again until 90 days after it becomes out of date again.The user can still manually update the app from the Play Store at any time.", -"The app is updated as soon as possible. No constraints are applied.The device is notified as soon as possible about a new update after it becomes available." +"The app is updated as soon as possible. No constraints are applied.The device is notified as soon as possible about a new update after it becomes available.*NOTE:* Updates to apps with larger deployments across Android's ecosystem can take up to 24h." ], "type": "string" }, @@ -5498,6 +5498,10 @@ false "format": "int32", "type": "integer" }, +"authenticatedUserEmail": { +"description": "The email address of the authenticated user (only present for Google Account provisioning method).", +"type": "string" +}, "brand": { "description": "The brand of the device. For example, Google.", "type": "string" diff --git a/googleapiclient/discovery_cache/documents/androidpublisher.v3.json b/googleapiclient/discovery_cache/documents/androidpublisher.v3.json index 978608e6fee..fa00a03e725 100644 --- a/googleapiclient/discovery_cache/documents/androidpublisher.v3.json +++ b/googleapiclient/discovery_cache/documents/androidpublisher.v3.json @@ -4731,7 +4731,7 @@ } } }, -"revision": "20240530", +"revision": "20240610", "rootUrl": "https://androidpublisher.googleapis.com/", "schemas": { "Abi": { @@ -9942,7 +9942,7 @@ false "type": "integer" }, "voidedReason": { -"description": "The reason why the purchase was voided, possible values are: 0. Other 1. Remorse 2. Not_received 3. Defective 4. Accidental_purchase 5. Fraud 6. Friendly_fraud 7. Chargeback", +"description": "The reason why the purchase was voided, possible values are: 0. Other 1. Remorse 2. Not_received 3. Defective 4. Accidental_purchase 5. Fraud 6. Friendly_fraud 7. Chargeback 8. Unacknowledged_purchase", "format": "int32", "type": "integer" }, diff --git a/googleapiclient/discovery_cache/documents/apigateway.v1.json b/googleapiclient/discovery_cache/documents/apigateway.v1.json index d4619d22a1c..300fe67fa53 100644 --- a/googleapiclient/discovery_cache/documents/apigateway.v1.json +++ b/googleapiclient/discovery_cache/documents/apigateway.v1.json @@ -1083,7 +1083,7 @@ } } }, -"revision": "20240515", +"revision": "20240529", "rootUrl": "https://apigateway.googleapis.com/", "schemas": { "ApigatewayApi": { diff --git a/googleapiclient/discovery_cache/documents/apigateway.v1beta.json b/googleapiclient/discovery_cache/documents/apigateway.v1beta.json index 5fd6a6346b7..ae727d217f0 100644 --- a/googleapiclient/discovery_cache/documents/apigateway.v1beta.json +++ b/googleapiclient/discovery_cache/documents/apigateway.v1beta.json @@ -1083,7 +1083,7 @@ } } }, -"revision": "20240515", +"revision": "20240529", "rootUrl": "https://apigateway.googleapis.com/", "schemas": { "ApigatewayApi": { diff --git a/googleapiclient/discovery_cache/documents/apikeys.v2.json b/googleapiclient/discovery_cache/documents/apikeys.v2.json index eacc655b8be..e9ca04391e9 100644 --- a/googleapiclient/discovery_cache/documents/apikeys.v2.json +++ b/googleapiclient/discovery_cache/documents/apikeys.v2.json @@ -396,7 +396,7 @@ } } }, -"revision": "20240520", +"revision": "20240603", "rootUrl": "https://apikeys.googleapis.com/", "schemas": { "Operation": { diff --git a/googleapiclient/discovery_cache/documents/appengine.v1.json b/googleapiclient/discovery_cache/documents/appengine.v1.json index 81d60c7bde3..5754ff3c4b2 100644 --- a/googleapiclient/discovery_cache/documents/appengine.v1.json +++ b/googleapiclient/discovery_cache/documents/appengine.v1.json @@ -1718,7 +1718,7 @@ } } }, -"revision": "20240527", +"revision": "20240603", "rootUrl": "https://appengine.googleapis.com/", "schemas": { "ApiConfigHandler": { diff --git a/googleapiclient/discovery_cache/documents/appengine.v1alpha.json b/googleapiclient/discovery_cache/documents/appengine.v1alpha.json index fb5dded963d..53b62e72b56 100644 --- a/googleapiclient/discovery_cache/documents/appengine.v1alpha.json +++ b/googleapiclient/discovery_cache/documents/appengine.v1alpha.json @@ -946,7 +946,7 @@ } } }, -"revision": "20240527", +"revision": "20240603", "rootUrl": "https://appengine.googleapis.com/", "schemas": { "AuthorizedCertificate": { diff --git a/googleapiclient/discovery_cache/documents/appengine.v1beta.json b/googleapiclient/discovery_cache/documents/appengine.v1beta.json index b51882bd1df..6fbfe3fffab 100644 --- a/googleapiclient/discovery_cache/documents/appengine.v1beta.json +++ b/googleapiclient/discovery_cache/documents/appengine.v1beta.json @@ -1918,7 +1918,7 @@ } } }, -"revision": "20240527", +"revision": "20240603", "rootUrl": "https://appengine.googleapis.com/", "schemas": { "ApiConfigHandler": { diff --git a/googleapiclient/discovery_cache/documents/apphub.v1.json b/googleapiclient/discovery_cache/documents/apphub.v1.json index 6c0c65909f5..ea4b7924897 100644 --- a/googleapiclient/discovery_cache/documents/apphub.v1.json +++ b/googleapiclient/discovery_cache/documents/apphub.v1.json @@ -1346,7 +1346,7 @@ } } }, -"revision": "20240515", +"revision": "20240529", "rootUrl": "https://apphub.googleapis.com/", "schemas": { "Application": { diff --git a/googleapiclient/discovery_cache/documents/apphub.v1alpha.json b/googleapiclient/discovery_cache/documents/apphub.v1alpha.json index dd3203dc361..9863e42809a 100644 --- a/googleapiclient/discovery_cache/documents/apphub.v1alpha.json +++ b/googleapiclient/discovery_cache/documents/apphub.v1alpha.json @@ -1438,7 +1438,7 @@ } } }, -"revision": "20240515", +"revision": "20240529", "rootUrl": "https://apphub.googleapis.com/", "schemas": { "Application": { diff --git a/googleapiclient/discovery_cache/documents/area120tables.v1alpha1.json b/googleapiclient/discovery_cache/documents/area120tables.v1alpha1.json index b9ccda6231e..0dd4c44e5c9 100644 --- a/googleapiclient/discovery_cache/documents/area120tables.v1alpha1.json +++ b/googleapiclient/discovery_cache/documents/area120tables.v1alpha1.json @@ -586,7 +586,7 @@ } } }, -"revision": "20240530", +"revision": "20240609", "rootUrl": "https://area120tables.googleapis.com/", "schemas": { "BatchCreateRowsRequest": { diff --git a/googleapiclient/discovery_cache/documents/artifactregistry.v1.json b/googleapiclient/discovery_cache/documents/artifactregistry.v1.json index 6e8780da210..ee2f34dd8f1 100644 --- a/googleapiclient/discovery_cache/documents/artifactregistry.v1.json +++ b/googleapiclient/discovery_cache/documents/artifactregistry.v1.json @@ -1637,7 +1637,7 @@ ], "parameters": { "filter": { -"description": "An expression for filtering the results of the request. Filter rules are case insensitive. The fields eligible for filtering are: * `version` An example of using a filter: * `version=\"projects/p1/locations/us-central1/repositories/repo1/packages/pkg1/versions/1.0\"` --> Tags that are applied to the version `1.0` in package `pkg1`.", +"description": "An expression for filtering the results of the request. Filter rules are case insensitive. The fields eligible for filtering are: * `version` An example of using a filter: * `version=\"projects/p1/locations/us-central1/repositories/repo1/packages/pkg1/versions/1.0\"` --> Tags that are applied to the version `1.0` in package `pkg1`. * `name=\"projects/p1/locations/us-central1/repositories/repo1/packages/pkg1/tags/a%2Fb%2F*\"` --> tags with an ID starting with \"a/b/\". * `name=\"projects/p1/locations/us-central1/repositories/repo1/packages/pkg1/tags/*%2Fb%2Fc\"` --> tags with an ID ending with \"/b/c\". * `name=\"projects/p1/locations/us-central1/repositories/repo1/packages/pkg1/tags/*%2Fb%2F*\"` --> tags with an ID containing \"/b/\".", "location": "query", "type": "string" }, @@ -2013,7 +2013,7 @@ } } }, -"revision": "20240520", +"revision": "20240603", "rootUrl": "https://artifactregistry.googleapis.com/", "schemas": { "AptArtifact": { @@ -3327,13 +3327,15 @@ "REDIRECTION_FROM_GCR_IO_DISABLED", "REDIRECTION_FROM_GCR_IO_ENABLED", "REDIRECTION_FROM_GCR_IO_FINALIZED", -"REDIRECTION_FROM_GCR_IO_ENABLED_AND_COPYING" +"REDIRECTION_FROM_GCR_IO_ENABLED_AND_COPYING", +"REDIRECTION_FROM_GCR_IO_PARTIAL_AND_COPYING" ], "enumDeprecated": [ false, false, false, true, +false, false ], "enumDescriptions": [ @@ -3341,7 +3343,8 @@ false "Redirection is disabled.", "Redirection is enabled.", "Redirection is enabled, and has been finalized so cannot be reverted.", -"Redirection is enabled and missing images are copied from GCR" +"Redirection is enabled and missing images are copied from GCR", +"Redirection is partially enabled and missing images are copied from GCR" ], "type": "string" }, diff --git a/googleapiclient/discovery_cache/documents/artifactregistry.v1beta1.json b/googleapiclient/discovery_cache/documents/artifactregistry.v1beta1.json index b8865915fc9..9f54c3f2b3a 100644 --- a/googleapiclient/discovery_cache/documents/artifactregistry.v1beta1.json +++ b/googleapiclient/discovery_cache/documents/artifactregistry.v1beta1.json @@ -937,7 +937,7 @@ ], "parameters": { "filter": { -"description": "An expression for filtering the results of the request. Filter rules are case insensitive. The fields eligible for filtering are: * `version` An example of using a filter: * `version=\"projects/p1/locations/us-central1/repositories/repo1/packages/pkg1/versions/1.0\"` --> Tags that are applied to the version `1.0` in package `pkg1`.", +"description": "An expression for filtering the results of the request. Filter rules are case insensitive. The fields eligible for filtering are: * `version` An example of using a filter: * `version=\"projects/p1/locations/us-central1/repositories/repo1/packages/pkg1/versions/1.0\"` --> Tags that are applied to the version `1.0` in package `pkg1`. * `name=\"projects/p1/locations/us-central1/repositories/repo1/packages/pkg1/tags/a%2Fb%2F*\"` --> tags with an ID starting with \"a/b/\". * `name=\"projects/p1/locations/us-central1/repositories/repo1/packages/pkg1/tags/*%2Fb%2Fc\"` --> tags with an ID ending with \"/b/c\". * `name=\"projects/p1/locations/us-central1/repositories/repo1/packages/pkg1/tags/*%2Fb%2F*\"` --> tags with an ID containing \"/b/\".", "location": "query", "type": "string" }, @@ -1146,7 +1146,7 @@ } } }, -"revision": "20240520", +"revision": "20240603", "rootUrl": "https://artifactregistry.googleapis.com/", "schemas": { "Binding": { diff --git a/googleapiclient/discovery_cache/documents/artifactregistry.v1beta2.json b/googleapiclient/discovery_cache/documents/artifactregistry.v1beta2.json index f227142addf..0a1860f512a 100644 --- a/googleapiclient/discovery_cache/documents/artifactregistry.v1beta2.json +++ b/googleapiclient/discovery_cache/documents/artifactregistry.v1beta2.json @@ -1133,7 +1133,7 @@ ], "parameters": { "filter": { -"description": "An expression for filtering the results of the request. Filter rules are case insensitive. The fields eligible for filtering are: * `version` An example of using a filter: * `version=\"projects/p1/locations/us-central1/repositories/repo1/packages/pkg1/versions/1.0\"` --> Tags that are applied to the version `1.0` in package `pkg1`.", +"description": "An expression for filtering the results of the request. Filter rules are case insensitive. The fields eligible for filtering are: * `version` An example of using a filter: * `version=\"projects/p1/locations/us-central1/repositories/repo1/packages/pkg1/versions/1.0\"` --> Tags that are applied to the version `1.0` in package `pkg1`. * `name=\"projects/p1/locations/us-central1/repositories/repo1/packages/pkg1/tags/a%2Fb%2F*\"` --> tags with an ID starting with \"a/b/\". * `name=\"projects/p1/locations/us-central1/repositories/repo1/packages/pkg1/tags/*%2Fb%2Fc\"` --> tags with an ID ending with \"/b/c\". * `name=\"projects/p1/locations/us-central1/repositories/repo1/packages/pkg1/tags/*%2Fb%2F*\"` --> tags with an ID containing \"/b/\".", "location": "query", "type": "string" }, @@ -1414,7 +1414,7 @@ } } }, -"revision": "20240520", +"revision": "20240603", "rootUrl": "https://artifactregistry.googleapis.com/", "schemas": { "AptArtifact": { @@ -2004,13 +2004,15 @@ "REDIRECTION_FROM_GCR_IO_DISABLED", "REDIRECTION_FROM_GCR_IO_ENABLED", "REDIRECTION_FROM_GCR_IO_FINALIZED", -"REDIRECTION_FROM_GCR_IO_ENABLED_AND_COPYING" +"REDIRECTION_FROM_GCR_IO_ENABLED_AND_COPYING", +"REDIRECTION_FROM_GCR_IO_PARTIAL_AND_COPYING" ], "enumDeprecated": [ false, false, false, true, +false, false ], "enumDescriptions": [ @@ -2018,7 +2020,8 @@ false "Redirection is disabled.", "Redirection is enabled.", "Redirection is enabled, and has been finalized so cannot be reverted.", -"Redirection is enabled and missing images are copied from GCR" +"Redirection is enabled and missing images are copied from GCR", +"Redirection is partially enabled and missing images are copied from GCR" ], "type": "string" }, diff --git a/googleapiclient/discovery_cache/documents/assuredworkloads.v1.json b/googleapiclient/discovery_cache/documents/assuredworkloads.v1.json index 181739f6417..f652b8df922 100644 --- a/googleapiclient/discovery_cache/documents/assuredworkloads.v1.json +++ b/googleapiclient/discovery_cache/documents/assuredworkloads.v1.json @@ -591,7 +591,7 @@ } } }, -"revision": "20240523", +"revision": "20240530", "rootUrl": "https://assuredworkloads.googleapis.com/", "schemas": { "GoogleCloudAssuredworkloadsV1AcknowledgeViolationRequest": { @@ -1074,7 +1074,8 @@ "REMEDIATION_LIST_ALLOWED_VALUES_ORG_POLICY_VIOLATION", "REMEDIATION_LIST_DENIED_VALUES_ORG_POLICY_VIOLATION", "REMEDIATION_RESTRICT_CMEK_CRYPTO_KEY_PROJECTS_ORG_POLICY_VIOLATION", -"REMEDIATION_RESOURCE_VIOLATION" +"REMEDIATION_RESOURCE_VIOLATION", +"REMEDIATION_RESOURCE_VIOLATION_NON_CMEK_SERVICES" ], "enumDescriptions": [ "Unspecified remediation type", @@ -1082,7 +1083,8 @@ "Remediation type for list org policy which have allowed values in the monitoring rule", "Remediation type for list org policy which have denied values in the monitoring rule", "Remediation type for gcp.restrictCmekCryptoKeyProjects", -"Remediation type for resource violation." +"Remediation type for resource violation.", +"Remediation type for resource violation due to gcp.restrictNonCmekServices" ], "readOnly": true, "type": "string" diff --git a/googleapiclient/discovery_cache/documents/assuredworkloads.v1beta1.json b/googleapiclient/discovery_cache/documents/assuredworkloads.v1beta1.json index 0eba4afe010..947d82cb6d5 100644 --- a/googleapiclient/discovery_cache/documents/assuredworkloads.v1beta1.json +++ b/googleapiclient/discovery_cache/documents/assuredworkloads.v1beta1.json @@ -563,7 +563,7 @@ } } }, -"revision": "20240523", +"revision": "20240530", "rootUrl": "https://assuredworkloads.googleapis.com/", "schemas": { "GoogleCloudAssuredworkloadsV1beta1AcknowledgeViolationRequest": { @@ -1033,7 +1033,8 @@ "REMEDIATION_LIST_ALLOWED_VALUES_ORG_POLICY_VIOLATION", "REMEDIATION_LIST_DENIED_VALUES_ORG_POLICY_VIOLATION", "REMEDIATION_RESTRICT_CMEK_CRYPTO_KEY_PROJECTS_ORG_POLICY_VIOLATION", -"REMEDIATION_RESOURCE_VIOLATION" +"REMEDIATION_RESOURCE_VIOLATION", +"REMEDIATION_RESOURCE_VIOLATION_NON_CMEK_SERVICES" ], "enumDescriptions": [ "Unspecified remediation type", @@ -1041,7 +1042,8 @@ "Remediation type for list org policy which have allowed values in the monitoring rule", "Remediation type for list org policy which have denied values in the monitoring rule", "Remediation type for gcp.restrictCmekCryptoKeyProjects", -"Remediation type for resource violation." +"Remediation type for resource violation.", +"Remediation type for resource violation due to gcp.restrictNonCmekServices" ], "readOnly": true, "type": "string" diff --git a/googleapiclient/discovery_cache/documents/authorizedbuyersmarketplace.v1.json b/googleapiclient/discovery_cache/documents/authorizedbuyersmarketplace.v1.json index f935158aba2..a946f91fe07 100644 --- a/googleapiclient/discovery_cache/documents/authorizedbuyersmarketplace.v1.json +++ b/googleapiclient/discovery_cache/documents/authorizedbuyersmarketplace.v1.json @@ -864,7 +864,7 @@ ] }, "pause": { -"description": "Pauses serving of the given finalized deal. This call only pauses the serving status, and does not affect other fields of the finalized deal. Calling this method for an already paused deal has no effect. This method only applies to programmatic guaranteed deals.", +"description": "Pauses serving of the given finalized deal. This call only pauses the serving status, and does not affect other fields of the finalized deal. Calling this method for an already paused deal has no effect. This method only applies to programmatic guaranteed deals and preferred deals.", "flatPath": "v1/buyers/{buyersId}/finalizedDeals/{finalizedDealsId}:pause", "httpMethod": "POST", "id": "authorizedbuyersmarketplace.buyers.finalizedDeals.pause", @@ -892,7 +892,7 @@ ] }, "resume": { -"description": "Resumes serving of the given finalized deal. Calling this method for an running deal has no effect. If a deal is initially paused by the seller, calling this method will not resume serving of the deal until the seller also resumes the deal. This method only applies to programmatic guaranteed deals.", +"description": "Resumes serving of the given finalized deal. Calling this method for an running deal has no effect. If a deal is initially paused by the seller, calling this method will not resume serving of the deal until the seller also resumes the deal. This method only applies to programmatic guaranteed deals and preferred deals.", "flatPath": "v1/buyers/{buyersId}/finalizedDeals/{finalizedDealsId}:resume", "httpMethod": "POST", "id": "authorizedbuyersmarketplace.buyers.finalizedDeals.resume", @@ -1367,7 +1367,7 @@ } } }, -"revision": "20240603", +"revision": "20240610", "rootUrl": "https://authorizedbuyersmarketplace.googleapis.com/", "schemas": { "AcceptProposalRequest": { diff --git a/googleapiclient/discovery_cache/documents/backupdr.v1.json b/googleapiclient/discovery_cache/documents/backupdr.v1.json index 4909711e183..603921f2ae9 100644 --- a/googleapiclient/discovery_cache/documents/backupdr.v1.json +++ b/googleapiclient/discovery_cache/documents/backupdr.v1.json @@ -535,7 +535,7 @@ } } }, -"revision": "20240522", +"revision": "20240529", "rootUrl": "https://backupdr.googleapis.com/", "schemas": { "AuditConfig": { diff --git a/googleapiclient/discovery_cache/documents/baremetalsolution.v2.json b/googleapiclient/discovery_cache/documents/baremetalsolution.v2.json index d962b0e82b2..ca78790efff 100644 --- a/googleapiclient/discovery_cache/documents/baremetalsolution.v2.json +++ b/googleapiclient/discovery_cache/documents/baremetalsolution.v2.json @@ -1722,7 +1722,7 @@ } } }, -"revision": "20240513", +"revision": "20240603", "rootUrl": "https://baremetalsolution.googleapis.com/", "schemas": { "AllowedClient": { diff --git a/googleapiclient/discovery_cache/documents/biglake.v1.json b/googleapiclient/discovery_cache/documents/biglake.v1.json index 27451a2e001..89ed132caba 100644 --- a/googleapiclient/discovery_cache/documents/biglake.v1.json +++ b/googleapiclient/discovery_cache/documents/biglake.v1.json @@ -616,7 +616,7 @@ } } }, -"revision": "20240529", +"revision": "20240605", "rootUrl": "https://biglake.googleapis.com/", "schemas": { "Catalog": { diff --git a/googleapiclient/discovery_cache/documents/bigquery.v2.json b/googleapiclient/discovery_cache/documents/bigquery.v2.json index cdc1782ee44..f2badce0e2b 100644 --- a/googleapiclient/discovery_cache/documents/bigquery.v2.json +++ b/googleapiclient/discovery_cache/documents/bigquery.v2.json @@ -1935,7 +1935,7 @@ } } }, -"revision": "20240423", +"revision": "20240602", "rootUrl": "https://bigquery.googleapis.com/", "schemas": { "AggregateClassificationMetrics": { @@ -3160,7 +3160,7 @@ }, "defaultEncryptionConfiguration": { "$ref": "EncryptionConfiguration", -"description": "The default encryption key for all tables in the dataset. Once this property is set, all newly-created partitioned tables in the dataset will have encryption key set to this value, unless table creation request (or query) overrides the key." +"description": "The default encryption key for all tables in the dataset. After this property is set, the encryption key of all newly-created tables in the dataset is set to this value unless the table creation request or query explicitly overrides the key." }, "defaultPartitionExpirationMs": { "description": "This default partition expiration, expressed in milliseconds. When new time-partitioned tables are created in a dataset where this property is set, the table will inherit this value, propagated as the `TimePartitioning.expirationMs` property on the new table. If you set `TimePartitioning.expirationMs` explicitly when creating a table, the `defaultPartitionExpirationMs` of the containing dataset is ignored. When creating a partitioned table, if `defaultPartitionExpirationMs` is set, the `defaultTableExpirationMs` value is ignored and the table will not be inherit a table expiration deadline.", @@ -3253,6 +3253,13 @@ "format": "int64", "type": "string" }, +"resourceTags": { +"additionalProperties": { +"type": "string" +}, +"description": "Optional. The [tags](/bigquery/docs/tags) attached to this dataset. Tag keys are globally unique. Tag key is expected to be in the namespaced format, for example \"123456789012/environment\" where 123456789012 is the ID of the parent organization or project resource for this tag key. Tag value is expected to be the short name, for example \"Production\". See [Tag definitions](/iam/docs/tags-access-control#definitions) for more details.", +"type": "object" +}, "restrictions": { "$ref": "RestrictionConfig", "description": "Optional. Output only. Restriction config for all tables and dataset. If set, restrict certain accesses on the dataset and all its tables based on the config. See [Data egress](/bigquery/docs/analytics-hub-introduction#data_egress) for more details.", @@ -4184,6 +4191,21 @@ }, "type": "object" }, +"ForeignViewDefinition": { +"description": "A view can be represented in multiple ways. Each representation has its own dialect. This message stores the metadata required for these representations.", +"id": "ForeignViewDefinition", +"properties": { +"dialect": { +"description": "Optional. Represents the dialect of the query.", +"type": "string" +}, +"query": { +"description": "Required. The query that defines the view.", +"type": "string" +} +}, +"type": "object" +}, "GetIamPolicyRequest": { "description": "Request message for `GetIamPolicy` method.", "id": "GetIamPolicyRequest", @@ -4846,7 +4868,7 @@ "description": "[Pick one] Configures an extract job." }, "jobTimeoutMs": { -"description": "Optional. Job timeout in milliseconds. If this time limit is exceeded, BigQuery might attempt to stop the job.", +"description": "Optional. Job timeout in milliseconds. If this time limit is exceeded, BigQuery will attempt to stop a longer job, but may not always succeed in canceling it before the job completes. For example, a job that takes more than 60 seconds to complete has a better chance of being stopped than a job that takes 10 seconds to complete.", "format": "int64", "type": "string" }, @@ -4943,6 +4965,22 @@ "$ref": "Clustering", "description": "Clustering specification for the destination table." }, +"columnNameCharacterMap": { +"description": "Optional. Character map supported for column names in CSV/Parquet loads. Defaults to STRICT and can be overridden by Project Config Service. Using this option with unsupporting load formats will result in an error.", +"enum": [ +"COLUMN_NAME_CHARACTER_MAP_UNSPECIFIED", +"STRICT", +"V1", +"V2" +], +"enumDescriptions": [ +"Unspecified column name character map.", +"Support flexible column name and reject invalid column names.", +"Support alphanumeric + underscore characters and names must start with a letter or underscore. Invalid column names will be normalized.", +"Support flexible column name. Invalid column names will be normalized." +], +"type": "string" +}, "connectionProperties": { "description": "Optional. Connection properties which can modify the load job behavior. Currently, only the 'session_id' connection property is supported, and is used to resolve _SESSION appearing as the dataset id.", "items": { @@ -6675,14 +6713,14 @@ "type": "boolean" }, "mapTargetType": { -"description": "Optional. Will indicate how to represent a parquet map if present.", +"description": "Optional. Indicates how to represent a Parquet map if present.", "enum": [ "MAP_TARGET_TYPE_UNSPECIFIED", "ARRAY_OF_STRUCT" ], "enumDescriptions": [ -"In this mode, we fall back to the default. Currently (3/24) we represent the map as: struct map_field_name { repeated struct key_value { key value } }", -"In this mode, we omit parquet's key_value struct and represent the map as: repeated struct map_field_name { key value }" +"In this mode, the map will have the following schema: struct map_field_name { repeated struct key_value { key value } }.", +"In this mode, the map will have the following schema: repeated struct map_field_name { key value }." ], "type": "string" } @@ -7243,7 +7281,7 @@ "id": "RangePartitioning", "properties": { "field": { -"description": "Required. [Experimental] The table is partitioned by this field. The field must be a top-level NULLABLE/REQUIRED field. The only supported type is INTEGER/INT64.", +"description": "Required. The name of the column to partition the table on. It must be a top-level, INT64 column whose mode is NULLABLE or REQUIRED.", "type": "string" }, "range": { @@ -8407,6 +8445,12 @@ "readOnly": true, "type": "string" }, +"numCurrentPhysicalBytes": { +"description": "Output only. Number of physical bytes used by current live data storage. This data is not kept in real time, and might be delayed by a few seconds to a few minutes.", +"format": "int64", +"readOnly": true, +"type": "string" +}, "numLongTermBytes": { "description": "Output only. The number of logical bytes in the table that are considered \"long-term storage\".", "format": "int64", @@ -10137,7 +10181,7 @@ "id": "UndeleteDatasetRequest", "properties": { "deletionTime": { -"description": "Optional. The exact time when the dataset was deleted. If not specified, the most recently deleted version is undeleted.", +"description": "Optional. The exact time when the dataset was deleted. If not specified, the most recently deleted version is undeleted. Undeleting a dataset using deletion time is not supported.", "format": "google-datetime", "type": "string" } @@ -10193,6 +10237,13 @@ "description": "Describes the definition of a logical view.", "id": "ViewDefinition", "properties": { +"foreignDefinitions": { +"description": "Optional. Foreign view representations.", +"items": { +"$ref": "ForeignViewDefinition" +}, +"type": "array" +}, "privacyPolicy": { "$ref": "PrivacyPolicy", "description": "Optional. Specifices the privacy policy for the view." diff --git a/googleapiclient/discovery_cache/documents/bigqueryconnection.v1.json b/googleapiclient/discovery_cache/documents/bigqueryconnection.v1.json index 1121c409a45..e5ea06135da 100644 --- a/googleapiclient/discovery_cache/documents/bigqueryconnection.v1.json +++ b/googleapiclient/discovery_cache/documents/bigqueryconnection.v1.json @@ -366,7 +366,7 @@ } } }, -"revision": "20240423", +"revision": "20240602", "rootUrl": "https://bigqueryconnection.googleapis.com/", "schemas": { "AuditConfig": { @@ -681,7 +681,7 @@ "properties": { "asset": { "$ref": "ConnectorConfigurationAsset", -"description": "Optional. Data asset." +"description": "Data asset." }, "authentication": { "$ref": "ConnectorConfigurationAuthentication", @@ -707,7 +707,7 @@ "id": "ConnectorConfigurationAsset", "properties": { "database": { -"description": "Optional. Name of the database.", +"description": "Name of the database.", "type": "string" }, "googleCloudResource": { @@ -721,6 +721,11 @@ "description": "Client authentication.", "id": "ConnectorConfigurationAuthentication", "properties": { +"serviceAccount": { +"description": "Output only. Google-managed service account associated with this connection, e.g., `service-{project_number}@gcp-sa-bigqueryconnection.iam.gserviceaccount.com`. BigQuery jobs using this connection will act as `service_account` identity while connecting to the datasource.", +"readOnly": true, +"type": "string" +}, "usernamePassword": { "$ref": "ConnectorConfigurationUsernamePassword", "description": "Username/password authentication." diff --git a/googleapiclient/discovery_cache/documents/bigqueryconnection.v1beta1.json b/googleapiclient/discovery_cache/documents/bigqueryconnection.v1beta1.json index 29bd2deee8d..6b98168de3e 100644 --- a/googleapiclient/discovery_cache/documents/bigqueryconnection.v1beta1.json +++ b/googleapiclient/discovery_cache/documents/bigqueryconnection.v1beta1.json @@ -395,7 +395,7 @@ } } }, -"revision": "20240423", +"revision": "20240602", "rootUrl": "https://bigqueryconnection.googleapis.com/", "schemas": { "AuditConfig": { diff --git a/googleapiclient/discovery_cache/documents/bigquerydatapolicy.v1.json b/googleapiclient/discovery_cache/documents/bigquerydatapolicy.v1.json index 550d1393d6b..26fb596c5a2 100644 --- a/googleapiclient/discovery_cache/documents/bigquerydatapolicy.v1.json +++ b/googleapiclient/discovery_cache/documents/bigquerydatapolicy.v1.json @@ -395,7 +395,7 @@ } } }, -"revision": "20240520", +"revision": "20240527", "rootUrl": "https://bigquerydatapolicy.googleapis.com/", "schemas": { "AuditConfig": { diff --git a/googleapiclient/discovery_cache/documents/bigquerydatatransfer.v1.json b/googleapiclient/discovery_cache/documents/bigquerydatatransfer.v1.json index 3d513f0b162..1d96d3fdfe3 100644 --- a/googleapiclient/discovery_cache/documents/bigquerydatatransfer.v1.json +++ b/googleapiclient/discovery_cache/documents/bigquerydatatransfer.v1.json @@ -1398,7 +1398,7 @@ } } }, -"revision": "20240519", +"revision": "20240527", "rootUrl": "https://bigquerydatatransfer.googleapis.com/", "schemas": { "CheckValidCredsRequest": { diff --git a/googleapiclient/discovery_cache/documents/bigqueryreservation.v1.json b/googleapiclient/discovery_cache/documents/bigqueryreservation.v1.json index 2952dfa92ce..230cc5635a2 100644 --- a/googleapiclient/discovery_cache/documents/bigqueryreservation.v1.json +++ b/googleapiclient/discovery_cache/documents/bigqueryreservation.v1.json @@ -880,7 +880,7 @@ } } }, -"revision": "20240518", +"revision": "20240604", "rootUrl": "https://bigqueryreservation.googleapis.com/", "schemas": { "Assignment": { diff --git a/googleapiclient/discovery_cache/documents/bigtableadmin.v2.json b/googleapiclient/discovery_cache/documents/bigtableadmin.v2.json index 32bf3ce9222..59f6b95821c 100644 --- a/googleapiclient/discovery_cache/documents/bigtableadmin.v2.json +++ b/googleapiclient/discovery_cache/documents/bigtableadmin.v2.json @@ -2194,7 +2194,7 @@ } } }, -"revision": "20240520", +"revision": "20240522", "rootUrl": "https://bigtableadmin.googleapis.com/", "schemas": { "AppProfile": { @@ -4103,7 +4103,7 @@ "type": "object" }, "Type": { -"description": "`Type` represents the type of data that is written to, read from, or stored in Bigtable. It is heavily based on the GoogleSQL standard to help maintain familiarity and consistency across products and features. For compatibility with Bigtable's existing untyped APIs, each `Type` includes an `Encoding` which describes how to convert to/from the underlying data. This might involve composing a series of steps into an \"encoding chain,\" for example to convert from INT64 -> STRING -> raw bytes. In most cases, a \"link\" in the encoding chain will be based an on existing GoogleSQL conversion function like `CAST`. Each link in the encoding chain also defines the following properties: * Natural sort: Does the encoded value sort consistently with the original typed value? Note that Bigtable will always sort data based on the raw encoded value, *not* the decoded type. - Example: STRING values sort in the same order as their UTF-8 encodings. - Counterexample: Encoding INT64 to a fixed-width STRING does *not* preserve sort order when dealing with negative numbers. INT64(1) > INT64(-1), but STRING(\"-00001\") > STRING(\"00001). - The overall encoding chain sorts naturally if *every* link does. * Self-delimiting: If we concatenate two encoded values, can we always tell where the first one ends and the second one begins? - Example: If we encode INT64s to fixed-width STRINGs, the first value will always contain exactly N digits, possibly preceded by a sign. - Counterexample: If we concatenate two UTF-8 encoded STRINGs, we have no way to tell where the first one ends. - The overall encoding chain is self-delimiting if *any* link is. * Compatibility: Which other systems have matching encoding schemes? For example, does this encoding have a GoogleSQL equivalent? HBase? Java?", +"description": "`Type` represents the type of data that is written to, read from, or stored in Bigtable. It is heavily based on the GoogleSQL standard to help maintain familiarity and consistency across products and features. For compatibility with Bigtable's existing untyped APIs, each `Type` includes an `Encoding` which describes how to convert to/from the underlying data. This might involve composing a series of steps into an \"encoding chain,\" for example to convert from INT64 -> STRING -> raw bytes. In most cases, a \"link\" in the encoding chain will be based an on existing GoogleSQL conversion function like `CAST`. Each link in the encoding chain also defines the following properties: * Natural sort: Does the encoded value sort consistently with the original typed value? Note that Bigtable will always sort data based on the raw encoded value, *not* the decoded type. - Example: BYTES values sort in the same order as their raw encodings. - Counterexample: Encoding INT64 to a fixed-width STRING does *not* preserve sort order when dealing with negative numbers. INT64(1) > INT64(-1), but STRING(\"-00001\") > STRING(\"00001). - The overall encoding chain has this property if *every* link does. * Self-delimiting: If we concatenate two encoded values, can we always tell where the first one ends and the second one begins? - Example: If we encode INT64s to fixed-width STRINGs, the first value will always contain exactly N digits, possibly preceded by a sign. - Counterexample: If we concatenate two UTF-8 encoded STRINGs, we have no way to tell where the first one ends. - The overall encoding chain has this property if *any* link does. * Compatibility: Which other systems have matching encoding schemes? For example, does this encoding have a GoogleSQL equivalent? HBase? Java?", "id": "Type", "properties": { "aggregateType": { diff --git a/googleapiclient/discovery_cache/documents/billingbudgets.v1.json b/googleapiclient/discovery_cache/documents/billingbudgets.v1.json index fbebf3c3698..e12a5c88c0b 100644 --- a/googleapiclient/discovery_cache/documents/billingbudgets.v1.json +++ b/googleapiclient/discovery_cache/documents/billingbudgets.v1.json @@ -275,7 +275,7 @@ } } }, -"revision": "20240602", +"revision": "20240609", "rootUrl": "https://billingbudgets.googleapis.com/", "schemas": { "GoogleCloudBillingBudgetsV1Budget": { diff --git a/googleapiclient/discovery_cache/documents/billingbudgets.v1beta1.json b/googleapiclient/discovery_cache/documents/billingbudgets.v1beta1.json index 08e8841d6e1..2bf98d5ccdc 100644 --- a/googleapiclient/discovery_cache/documents/billingbudgets.v1beta1.json +++ b/googleapiclient/discovery_cache/documents/billingbudgets.v1beta1.json @@ -269,7 +269,7 @@ } } }, -"revision": "20240602", +"revision": "20240609", "rootUrl": "https://billingbudgets.googleapis.com/", "schemas": { "GoogleCloudBillingBudgetsV1beta1AllUpdatesRule": { diff --git a/googleapiclient/discovery_cache/documents/binaryauthorization.v1beta1.json b/googleapiclient/discovery_cache/documents/binaryauthorization.v1beta1.json index 6445a4b4a4a..0aa3ff41531 100644 --- a/googleapiclient/discovery_cache/documents/binaryauthorization.v1beta1.json +++ b/googleapiclient/discovery_cache/documents/binaryauthorization.v1beta1.json @@ -551,7 +551,7 @@ } } }, -"revision": "20240531", +"revision": "20240607", "rootUrl": "https://binaryauthorization.googleapis.com/", "schemas": { "AdmissionRule": { diff --git a/googleapiclient/discovery_cache/documents/blockchainnodeengine.v1.json b/googleapiclient/discovery_cache/documents/blockchainnodeengine.v1.json index 49e2975e0df..8e36d5407a7 100644 --- a/googleapiclient/discovery_cache/documents/blockchainnodeengine.v1.json +++ b/googleapiclient/discovery_cache/documents/blockchainnodeengine.v1.json @@ -487,7 +487,7 @@ } } }, -"revision": "20240529", +"revision": "20240605", "rootUrl": "https://blockchainnodeengine.googleapis.com/", "schemas": { "BlockchainNode": { diff --git a/googleapiclient/discovery_cache/documents/blogger.v2.json b/googleapiclient/discovery_cache/documents/blogger.v2.json index 69266f8c643..3793e042ad8 100644 --- a/googleapiclient/discovery_cache/documents/blogger.v2.json +++ b/googleapiclient/discovery_cache/documents/blogger.v2.json @@ -401,7 +401,7 @@ } } }, -"revision": "20240602", +"revision": "20240610", "rootUrl": "https://blogger.googleapis.com/", "schemas": { "Blog": { diff --git a/googleapiclient/discovery_cache/documents/blogger.v3.json b/googleapiclient/discovery_cache/documents/blogger.v3.json index dba77240baf..7a6790ae45d 100644 --- a/googleapiclient/discovery_cache/documents/blogger.v3.json +++ b/googleapiclient/discovery_cache/documents/blogger.v3.json @@ -1710,7 +1710,7 @@ } } }, -"revision": "20240602", +"revision": "20240610", "rootUrl": "https://blogger.googleapis.com/", "schemas": { "Blog": { diff --git a/googleapiclient/discovery_cache/documents/books.v1.json b/googleapiclient/discovery_cache/documents/books.v1.json index 3be57320135..0a2aa504394 100644 --- a/googleapiclient/discovery_cache/documents/books.v1.json +++ b/googleapiclient/discovery_cache/documents/books.v1.json @@ -2677,7 +2677,7 @@ } } }, -"revision": "20240528", +"revision": "20240604", "rootUrl": "https://books.googleapis.com/", "schemas": { "Annotation": { diff --git a/googleapiclient/discovery_cache/documents/businessprofileperformance.v1.json b/googleapiclient/discovery_cache/documents/businessprofileperformance.v1.json index b1f4e4a280e..0155cb76ba6 100644 --- a/googleapiclient/discovery_cache/documents/businessprofileperformance.v1.json +++ b/googleapiclient/discovery_cache/documents/businessprofileperformance.v1.json @@ -417,7 +417,7 @@ } } }, -"revision": "20240602", +"revision": "20240609", "rootUrl": "https://businessprofileperformance.googleapis.com/", "schemas": { "DailyMetricTimeSeries": { diff --git a/googleapiclient/discovery_cache/documents/chat.v1.json b/googleapiclient/discovery_cache/documents/chat.v1.json index a2807d5e1f8..ccd7e1b40f9 100644 --- a/googleapiclient/discovery_cache/documents/chat.v1.json +++ b/googleapiclient/discovery_cache/documents/chat.v1.json @@ -2,6 +2,21 @@ "auth": { "oauth2": { "scopes": { +"https://www.googleapis.com/auth/chat.admin.delete": { +"description": "Delete conversations and spaces owned by your organization and remove access to associated files in Google Chat" +}, +"https://www.googleapis.com/auth/chat.admin.memberships": { +"description": "View, add, update and remove members and managers in conversations owned by your organization" +}, +"https://www.googleapis.com/auth/chat.admin.memberships.readonly": { +"description": "View members and managers in conversations owned by your organization" +}, +"https://www.googleapis.com/auth/chat.admin.spaces": { +"description": "View or edit display name, description, and other metadata for all Google Chat conversations owned by your organization" +}, +"https://www.googleapis.com/auth/chat.admin.spaces.readonly": { +"description": "View display name, description, and other metadata for all Google Chat conversations owned by your organization" +}, "https://www.googleapis.com/auth/chat.bot": { "description": "Private Service: https://www.googleapis.com/auth/chat.bot" }, @@ -310,6 +325,7 @@ "$ref": "Empty" }, "scopes": [ +"https://www.googleapis.com/auth/chat.admin.delete", "https://www.googleapis.com/auth/chat.delete", "https://www.googleapis.com/auth/chat.import" ] @@ -359,13 +375,15 @@ "$ref": "Space" }, "scopes": [ +"https://www.googleapis.com/auth/chat.admin.spaces", +"https://www.googleapis.com/auth/chat.admin.spaces.readonly", "https://www.googleapis.com/auth/chat.bot", "https://www.googleapis.com/auth/chat.spaces", "https://www.googleapis.com/auth/chat.spaces.readonly" ] }, "list": { -"description": "Lists spaces the caller is a member of. Group chats and DMs aren't listed until the first message is sent. For an example, see [List spaces](https://developers.google.com/workspace/chat/list-spaces). Requires [authentication](https://developers.google.com/workspace/chat/authenticate-authorize). Supports [app authentication](https://developers.google.com/workspace/chat/authenticate-authorize-chat-app) and [user authentication](https://developers.google.com/workspace/chat/authenticate-authorize-chat-user). Lists spaces visible to the caller or authenticated user. Group chats and DMs aren't listed until the first message is sent. To list all named spaces by Google Workspace organization, use the `spaces.search()` method using Workspace administrator privileges instead.", +"description": "Lists spaces the caller is a member of. Group chats and DMs aren't listed until the first message is sent. For an example, see [List spaces](https://developers.google.com/workspace/chat/list-spaces). Requires [authentication](https://developers.google.com/workspace/chat/authenticate-authorize). Supports [app authentication](https://developers.google.com/workspace/chat/authenticate-authorize-chat-app) and [user authentication](https://developers.google.com/workspace/chat/authenticate-authorize-chat-user). Lists spaces visible to the caller or authenticated user. Group chats and DMs aren't listed until the first message is sent. To list all named spaces by Google Workspace organization, use the [`spaces.search()`](https://developers.google.com/workspace/chat/api/reference/rest/v1/spaces/search) method using Workspace administrator privileges instead.", "flatPath": "v1/spaces", "httpMethod": "GET", "id": "chat.spaces.list", @@ -429,6 +447,7 @@ "$ref": "Space" }, "scopes": [ +"https://www.googleapis.com/auth/chat.admin.spaces", "https://www.googleapis.com/auth/chat.import", "https://www.googleapis.com/auth/chat.spaces" ] @@ -481,6 +500,7 @@ "$ref": "Membership" }, "scopes": [ +"https://www.googleapis.com/auth/chat.admin.memberships", "https://www.googleapis.com/auth/chat.import", "https://www.googleapis.com/auth/chat.memberships", "https://www.googleapis.com/auth/chat.memberships.app" @@ -508,6 +528,7 @@ "$ref": "Membership" }, "scopes": [ +"https://www.googleapis.com/auth/chat.admin.memberships", "https://www.googleapis.com/auth/chat.import", "https://www.googleapis.com/auth/chat.memberships", "https://www.googleapis.com/auth/chat.memberships.app" @@ -535,6 +556,8 @@ "$ref": "Membership" }, "scopes": [ +"https://www.googleapis.com/auth/chat.admin.memberships", +"https://www.googleapis.com/auth/chat.admin.memberships.readonly", "https://www.googleapis.com/auth/chat.bot", "https://www.googleapis.com/auth/chat.memberships", "https://www.googleapis.com/auth/chat.memberships.readonly" @@ -588,6 +611,8 @@ "$ref": "ListMembershipsResponse" }, "scopes": [ +"https://www.googleapis.com/auth/chat.admin.memberships", +"https://www.googleapis.com/auth/chat.admin.memberships.readonly", "https://www.googleapis.com/auth/chat.bot", "https://www.googleapis.com/auth/chat.import", "https://www.googleapis.com/auth/chat.memberships", @@ -625,6 +650,7 @@ "$ref": "Membership" }, "scopes": [ +"https://www.googleapis.com/auth/chat.admin.memberships", "https://www.googleapis.com/auth/chat.import", "https://www.googleapis.com/auth/chat.memberships" ] @@ -1215,7 +1241,7 @@ } } }, -"revision": "20240521", +"revision": "20240604", "rootUrl": "https://chat.googleapis.com/", "schemas": { "AccessoryWidget": { @@ -1665,7 +1691,7 @@ "The add-on launches from Google Sheets.", "The add-on launches from Google Slides.", "The add-on launches from Google Drawings.", -"A Google Chat app. Not used for Google Workspace Add-ons." +"A Google Chat app." ], "type": "string" }, @@ -2692,11 +2718,13 @@ "description": "A data source shared by all Google Workspace applications, such as users in a Google Workspace organization.", "enum": [ "UNKNOWN", -"USER" +"USER", +"DRIVE" ], "enumDescriptions": [ "Default value. Don't use.", -"Google Workspace users. The user can only view and select users from their Google Workspace organization." +"Google Workspace users. The user can only view and select users from their Google Workspace organization.", +"Represents a data source from Google Drive OnePick." ], "type": "string" }, diff --git a/googleapiclient/discovery_cache/documents/checks.v1alpha.json b/googleapiclient/discovery_cache/documents/checks.v1alpha.json index a16bd3a7365..4ef532f7b3c 100644 --- a/googleapiclient/discovery_cache/documents/checks.v1alpha.json +++ b/googleapiclient/discovery_cache/documents/checks.v1alpha.json @@ -414,7 +414,7 @@ } } }, -"revision": "20240602", +"revision": "20240609", "rootUrl": "https://checks.googleapis.com/", "schemas": { "CancelOperationRequest": { diff --git a/googleapiclient/discovery_cache/documents/chromemanagement.v1.json b/googleapiclient/discovery_cache/documents/chromemanagement.v1.json index 984a5f9ae24..e3592aeab16 100644 --- a/googleapiclient/discovery_cache/documents/chromemanagement.v1.json +++ b/googleapiclient/discovery_cache/documents/chromemanagement.v1.json @@ -1172,7 +1172,7 @@ } } }, -"revision": "20240602", +"revision": "20240609", "rootUrl": "https://chromemanagement.googleapis.com/", "schemas": { "GoogleChromeManagementV1AndroidAppInfo": { diff --git a/googleapiclient/discovery_cache/documents/chromepolicy.v1.json b/googleapiclient/discovery_cache/documents/chromepolicy.v1.json index 1cb2911b636..a702685f1d4 100644 --- a/googleapiclient/discovery_cache/documents/chromepolicy.v1.json +++ b/googleapiclient/discovery_cache/documents/chromepolicy.v1.json @@ -557,7 +557,7 @@ } } }, -"revision": "20240602", +"revision": "20240609", "rootUrl": "https://chromepolicy.googleapis.com/", "schemas": { "GoogleChromePolicyVersionsV1AdditionalTargetKeyName": { diff --git a/googleapiclient/discovery_cache/documents/chromeuxreport.v1.json b/googleapiclient/discovery_cache/documents/chromeuxreport.v1.json index 1d01c388001..a6393564c66 100644 --- a/googleapiclient/discovery_cache/documents/chromeuxreport.v1.json +++ b/googleapiclient/discovery_cache/documents/chromeuxreport.v1.json @@ -131,7 +131,7 @@ } } }, -"revision": "20240528", +"revision": "20240605", "rootUrl": "https://chromeuxreport.googleapis.com/", "schemas": { "Bin": { diff --git a/googleapiclient/discovery_cache/documents/civicinfo.v2.json b/googleapiclient/discovery_cache/documents/civicinfo.v2.json index 898ad7fca62..9799136c621 100644 --- a/googleapiclient/discovery_cache/documents/civicinfo.v2.json +++ b/googleapiclient/discovery_cache/documents/civicinfo.v2.json @@ -365,7 +365,7 @@ } } }, -"revision": "20240528", +"revision": "20240604", "rootUrl": "https://civicinfo.googleapis.com/", "schemas": { "AdministrationRegion": { diff --git a/googleapiclient/discovery_cache/documents/classroom.v1.json b/googleapiclient/discovery_cache/documents/classroom.v1.json index d3b8f853d62..7bc28684225 100644 --- a/googleapiclient/discovery_cache/documents/classroom.v1.json +++ b/googleapiclient/discovery_cache/documents/classroom.v1.json @@ -2400,7 +2400,7 @@ } } }, -"revision": "20240523", +"revision": "20240604", "rootUrl": "https://classroom.googleapis.com/", "schemas": { "Announcement": { diff --git a/googleapiclient/discovery_cache/documents/cloudasset.v1.json b/googleapiclient/discovery_cache/documents/cloudasset.v1.json index 2770523fa47..0c7b5acb075 100644 --- a/googleapiclient/discovery_cache/documents/cloudasset.v1.json +++ b/googleapiclient/discovery_cache/documents/cloudasset.v1.json @@ -1095,7 +1095,7 @@ } } }, -"revision": "20240530", +"revision": "20240601", "rootUrl": "https://cloudasset.googleapis.com/", "schemas": { "AccessSelector": { diff --git a/googleapiclient/discovery_cache/documents/cloudasset.v1beta1.json b/googleapiclient/discovery_cache/documents/cloudasset.v1beta1.json index 7833d55276e..60d126cd70a 100644 --- a/googleapiclient/discovery_cache/documents/cloudasset.v1beta1.json +++ b/googleapiclient/discovery_cache/documents/cloudasset.v1beta1.json @@ -411,7 +411,7 @@ } } }, -"revision": "20240530", +"revision": "20240601", "rootUrl": "https://cloudasset.googleapis.com/", "schemas": { "AnalyzeIamPolicyLongrunningMetadata": { diff --git a/googleapiclient/discovery_cache/documents/cloudasset.v1p1beta1.json b/googleapiclient/discovery_cache/documents/cloudasset.v1p1beta1.json index 94221c2914c..9b5d0297716 100644 --- a/googleapiclient/discovery_cache/documents/cloudasset.v1p1beta1.json +++ b/googleapiclient/discovery_cache/documents/cloudasset.v1p1beta1.json @@ -207,7 +207,7 @@ } } }, -"revision": "20240530", +"revision": "20240601", "rootUrl": "https://cloudasset.googleapis.com/", "schemas": { "AnalyzeIamPolicyLongrunningMetadata": { diff --git a/googleapiclient/discovery_cache/documents/cloudasset.v1p5beta1.json b/googleapiclient/discovery_cache/documents/cloudasset.v1p5beta1.json index f522b5855a3..a8578501a47 100644 --- a/googleapiclient/discovery_cache/documents/cloudasset.v1p5beta1.json +++ b/googleapiclient/discovery_cache/documents/cloudasset.v1p5beta1.json @@ -177,7 +177,7 @@ } } }, -"revision": "20240530", +"revision": "20240601", "rootUrl": "https://cloudasset.googleapis.com/", "schemas": { "AnalyzeIamPolicyLongrunningMetadata": { diff --git a/googleapiclient/discovery_cache/documents/cloudasset.v1p7beta1.json b/googleapiclient/discovery_cache/documents/cloudasset.v1p7beta1.json index dc932f903fa..22526076a6c 100644 --- a/googleapiclient/discovery_cache/documents/cloudasset.v1p7beta1.json +++ b/googleapiclient/discovery_cache/documents/cloudasset.v1p7beta1.json @@ -167,7 +167,7 @@ } } }, -"revision": "20240530", +"revision": "20240601", "rootUrl": "https://cloudasset.googleapis.com/", "schemas": { "AnalyzeIamPolicyLongrunningMetadata": { diff --git a/googleapiclient/discovery_cache/documents/cloudbilling.v1.json b/googleapiclient/discovery_cache/documents/cloudbilling.v1.json index 9c59a16c230..894a279986f 100644 --- a/googleapiclient/discovery_cache/documents/cloudbilling.v1.json +++ b/googleapiclient/discovery_cache/documents/cloudbilling.v1.json @@ -751,7 +751,7 @@ } } }, -"revision": "20240531", +"revision": "20240607", "rootUrl": "https://cloudbilling.googleapis.com/", "schemas": { "AggregationInfo": { diff --git a/googleapiclient/discovery_cache/documents/cloudbilling.v1beta.json b/googleapiclient/discovery_cache/documents/cloudbilling.v1beta.json index d9e95fe2e5e..5c2cdcc7a9e 100644 --- a/googleapiclient/discovery_cache/documents/cloudbilling.v1beta.json +++ b/googleapiclient/discovery_cache/documents/cloudbilling.v1beta.json @@ -761,7 +761,7 @@ } } }, -"revision": "20240531", +"revision": "20240607", "rootUrl": "https://cloudbilling.googleapis.com/", "schemas": { "CacheFillRegions": { diff --git a/googleapiclient/discovery_cache/documents/cloudbuild.v1.json b/googleapiclient/discovery_cache/documents/cloudbuild.v1.json index 537f90b6cc9..b0f9f4347f3 100644 --- a/googleapiclient/discovery_cache/documents/cloudbuild.v1.json +++ b/googleapiclient/discovery_cache/documents/cloudbuild.v1.json @@ -2346,7 +2346,7 @@ } } }, -"revision": "20240528", +"revision": "20240531", "rootUrl": "https://cloudbuild.googleapis.com/", "schemas": { "ApprovalConfig": { diff --git a/googleapiclient/discovery_cache/documents/cloudbuild.v2.json b/googleapiclient/discovery_cache/documents/cloudbuild.v2.json index d4307f76917..b6774165baf 100644 --- a/googleapiclient/discovery_cache/documents/cloudbuild.v2.json +++ b/googleapiclient/discovery_cache/documents/cloudbuild.v2.json @@ -844,7 +844,7 @@ } } }, -"revision": "20240528", +"revision": "20240531", "rootUrl": "https://cloudbuild.googleapis.com/", "schemas": { "AuditConfig": { diff --git a/googleapiclient/discovery_cache/documents/cloudchannel.v1.json b/googleapiclient/discovery_cache/documents/cloudchannel.v1.json index ce33c82c583..dde6a30a675 100644 --- a/googleapiclient/discovery_cache/documents/cloudchannel.v1.json +++ b/googleapiclient/discovery_cache/documents/cloudchannel.v1.json @@ -2183,7 +2183,7 @@ } } }, -"revision": "20240602", +"revision": "20240609", "rootUrl": "https://cloudchannel.googleapis.com/", "schemas": { "GoogleCloudChannelV1ActivateEntitlementRequest": { diff --git a/googleapiclient/discovery_cache/documents/cloudcontrolspartner.v1.json b/googleapiclient/discovery_cache/documents/cloudcontrolspartner.v1.json index 91eaf0df913..5e026e5a04c 100644 --- a/googleapiclient/discovery_cache/documents/cloudcontrolspartner.v1.json +++ b/googleapiclient/discovery_cache/documents/cloudcontrolspartner.v1.json @@ -482,7 +482,7 @@ } } }, -"revision": "20240515", +"revision": "20240529", "rootUrl": "https://cloudcontrolspartner.googleapis.com/", "schemas": { "AccessApprovalRequest": { diff --git a/googleapiclient/discovery_cache/documents/cloudcontrolspartner.v1beta.json b/googleapiclient/discovery_cache/documents/cloudcontrolspartner.v1beta.json index 55c2ebd2f9a..14c2b4f41c3 100644 --- a/googleapiclient/discovery_cache/documents/cloudcontrolspartner.v1beta.json +++ b/googleapiclient/discovery_cache/documents/cloudcontrolspartner.v1beta.json @@ -482,7 +482,7 @@ } } }, -"revision": "20240515", +"revision": "20240529", "rootUrl": "https://cloudcontrolspartner.googleapis.com/", "schemas": { "AccessApprovalRequest": { diff --git a/googleapiclient/discovery_cache/documents/clouddeploy.v1.json b/googleapiclient/discovery_cache/documents/clouddeploy.v1.json index 2c972c2d60d..b7ef3aea2aa 100644 --- a/googleapiclient/discovery_cache/documents/clouddeploy.v1.json +++ b/googleapiclient/discovery_cache/documents/clouddeploy.v1.json @@ -2065,7 +2065,7 @@ } } }, -"revision": "20240515", +"revision": "20240529", "rootUrl": "https://clouddeploy.googleapis.com/", "schemas": { "AbandonReleaseRequest": { @@ -2348,7 +2348,6 @@ "TYPE_RESTRICTION_VIOLATED", "TYPE_RESOURCE_DELETED", "TYPE_ROLLOUT_UPDATE", -"TYPE_DEPLOY_POLICY_EVALUATION", "TYPE_RENDER_STATUES_CHANGE" ], "enumDeprecated": [ @@ -2359,7 +2358,6 @@ false, false, false, false, -false, true ], "enumDescriptions": [ @@ -2370,7 +2368,6 @@ true "Restriction check failed.", "Resource deleted.", "Rollout updated.", -"Deploy Policy evaluation.", "Deprecated: This field is never used. Use release_render log type instead." ], "type": "string" @@ -2404,11 +2401,6 @@ true "readOnly": true, "type": "array" }, -"currentRepairAutomationRun": { -"description": "Output only. The current AutomationRun repairing the rollout.", -"readOnly": true, -"type": "string" -}, "promoteAutomationRun": { "description": "Output only. The name of the AutomationRun initiated by a promote release rule.", "readOnly": true, @@ -2602,7 +2594,6 @@ true "TYPE_RESTRICTION_VIOLATED", "TYPE_RESOURCE_DELETED", "TYPE_ROLLOUT_UPDATE", -"TYPE_DEPLOY_POLICY_EVALUATION", "TYPE_RENDER_STATUES_CHANGE" ], "enumDeprecated": [ @@ -2613,7 +2604,6 @@ false, false, false, false, -false, true ], "enumDescriptions": [ @@ -2624,7 +2614,6 @@ true "Restriction check failed.", "Resource deleted.", "Rollout updated.", -"Deploy Policy evaluation.", "Deprecated: This field is never used. Use release_render log type instead." ], "type": "string" @@ -3157,7 +3146,6 @@ true "TYPE_RESTRICTION_VIOLATED", "TYPE_RESOURCE_DELETED", "TYPE_ROLLOUT_UPDATE", -"TYPE_DEPLOY_POLICY_EVALUATION", "TYPE_RENDER_STATUES_CHANGE" ], "enumDeprecated": [ @@ -3168,7 +3156,6 @@ false, false, false, false, -false, true ], "enumDescriptions": [ @@ -3179,7 +3166,6 @@ true "Restriction check failed.", "Resource deleted.", "Rollout updated.", -"Deploy Policy evaluation.", "Deprecated: This field is never used. Use release_render log type instead." ], "type": "string" @@ -3461,6 +3447,10 @@ true "internalIp": { "description": "Optional. If true, `cluster` is accessed using the private IP address of the control plane endpoint. Otherwise, the default IP address of the control plane endpoint is used. The default IP address is the private IP address for clusters with private control-plane endpoints and the public IP address otherwise. Only specify this option when `cluster` is a [private GKE cluster](https://cloud.google.com/kubernetes-engine/docs/concepts/private-cluster-concept).", "type": "boolean" +}, +"proxyUrl": { +"description": "Optional. If set, used to configure a [proxy](https://kubernetes.io/docs/concepts/configuration/organize-cluster-access-kubeconfig/#proxy) to the Kubernetes server.", +"type": "string" } }, "type": "object" @@ -3711,7 +3701,6 @@ true "TYPE_RESTRICTION_VIOLATED", "TYPE_RESOURCE_DELETED", "TYPE_ROLLOUT_UPDATE", -"TYPE_DEPLOY_POLICY_EVALUATION", "TYPE_RENDER_STATUES_CHANGE" ], "enumDeprecated": [ @@ -3722,7 +3711,6 @@ false, false, false, false, -false, true ], "enumDescriptions": [ @@ -3733,7 +3721,6 @@ true "Restriction check failed.", "Resource deleted.", "Rollout updated.", -"Deploy Policy evaluation.", "Deprecated: This field is never used. Use release_render log type instead." ], "type": "string" @@ -4711,7 +4698,6 @@ true "TYPE_RESTRICTION_VIOLATED", "TYPE_RESOURCE_DELETED", "TYPE_ROLLOUT_UPDATE", -"TYPE_DEPLOY_POLICY_EVALUATION", "TYPE_RENDER_STATUES_CHANGE" ], "enumDeprecated": [ @@ -4722,7 +4708,6 @@ false, false, false, false, -false, true ], "enumDescriptions": [ @@ -4733,7 +4718,6 @@ true "Restriction check failed.", "Resource deleted.", "Rollout updated.", -"Deploy Policy evaluation.", "Deprecated: This field is never used. Use release_render log type instead." ], "type": "string" @@ -4794,7 +4778,6 @@ true "TYPE_RESTRICTION_VIOLATED", "TYPE_RESOURCE_DELETED", "TYPE_ROLLOUT_UPDATE", -"TYPE_DEPLOY_POLICY_EVALUATION", "TYPE_RENDER_STATUES_CHANGE" ], "enumDeprecated": [ @@ -4805,7 +4788,6 @@ false, false, false, false, -false, true ], "enumDescriptions": [ @@ -4816,7 +4798,6 @@ true "Restriction check failed.", "Resource deleted.", "Rollout updated.", -"Deploy Policy evaluation.", "Deprecated: This field is never used. Use release_render log type instead." ], "type": "string" @@ -4841,23 +4822,8 @@ true }, "type": "object" }, -"RepairMode": { -"description": "Configuration of the repair action.", -"id": "RepairMode", -"properties": { -"retry": { -"$ref": "Retry", -"description": "Optional. Retries a failed job." -}, -"rollback": { -"$ref": "Rollback", -"description": "Optional. Rolls back a `Rollout`." -} -}, -"type": "object" -}, "RepairPhase": { -"description": "RepairPhase tracks the repair attempts that have been made for each `RepairMode` specified in the `Automation` resource.", +"description": "RepairPhase tracks the repair attempts that have been made for each `RepairPhaseConfig` specified in the `Automation` resource.", "id": "RepairPhase", "properties": { "retry": { @@ -4877,12 +4843,6 @@ true "description": "Contains the information for an automated `repair rollout` operation.", "id": "RepairRolloutOperation", "properties": { -"currentRepairModeIndex": { -"description": "Output only. The index of the current repair action in the repair sequence.", -"format": "int64", -"readOnly": true, -"type": "string" -}, "jobId": { "description": "Output only. The job ID for the Job to repair.", "readOnly": true, @@ -4928,51 +4888,6 @@ true "type": "string" }, "type": "array" -}, -"repairModes": { -"description": "Required. Defines the types of automatic repair actions for failed jobs.", -"items": { -"$ref": "RepairMode" -}, -"type": "array" -}, -"sourcePhases": { -"description": "Optional. Phases within which jobs are subject to automatic repair actions on failure. Proceeds only after phase name matched any one in the list, or for all phases if unspecified. This value must consist of lower-case letters, numbers, and hyphens, start with a letter and end with a letter or a number, and have a max length of 63 characters. In other words, it must match the following regex: `^[a-z]([a-z0-9-]{0,61}[a-z0-9])?$`.", -"items": { -"type": "string" -}, -"type": "array" -} -}, -"type": "object" -}, -"Retry": { -"description": "Retries the failed job.", -"id": "Retry", -"properties": { -"attempts": { -"description": "Required. Total number of retries. Retry is skipped if set to 0; The minimum value is 1, and the maximum value is 10.", -"format": "int64", -"type": "string" -}, -"backoffMode": { -"description": "Optional. The pattern of how wait time will be increased. Default is linear. Backoff mode will be ignored if `wait` is 0.", -"enum": [ -"BACKOFF_MODE_UNSPECIFIED", -"BACKOFF_MODE_LINEAR", -"BACKOFF_MODE_EXPONENTIAL" -], -"enumDescriptions": [ -"No WaitMode is specified.", -"Increases the wait time linearly.", -"Increases the wait time exponentially." -], -"type": "string" -}, -"wait": { -"description": "Optional. How long to wait for the first retry. Default is 0, and the maximum value is 14d.", -"format": "google-duration", -"type": "string" } }, "type": "object" @@ -4996,7 +4911,6 @@ true "REPAIR_STATE_FAILED", "REPAIR_STATE_IN_PROGRESS", "REPAIR_STATE_PENDING", -"REPAIR_STATE_SKIPPED", "REPAIR_STATE_ABORTED" ], "enumDescriptions": [ @@ -5006,7 +4920,6 @@ true "The `repair` action has failed.", "The `repair` action is in progress.", "The `repair` action is pending.", -"The `repair` action was skipped.", "The `repair` action was aborted." ], "readOnly": true, @@ -5074,18 +4987,6 @@ true "readOnly": true, "type": "string" }, -"jobId": { -"deprecated": true, -"description": "Output only. The job ID for the Job to retry.", -"readOnly": true, -"type": "string" -}, -"phaseId": { -"deprecated": true, -"description": "Output only. The phase ID of the phase that includes the job being retried.", -"readOnly": true, -"type": "string" -}, "totalAttempts": { "description": "Output only. The number of attempts that have been made.", "format": "int64", @@ -5095,17 +4996,6 @@ true }, "type": "object" }, -"Rollback": { -"description": "Rolls back a `Rollout`.", -"id": "Rollback", -"properties": { -"destinationPhase": { -"description": "Optional. The starting phase ID for the `Rollout`. If unspecified, the `Rollout` will start in the stable phase.", -"type": "string" -} -}, -"type": "object" -}, "RollbackAttempt": { "description": "RollbackAttempt represents an action of rolling back a Cloud Deploy 'Target'.", "id": "RollbackAttempt", @@ -5129,7 +5019,6 @@ true "REPAIR_STATE_FAILED", "REPAIR_STATE_IN_PROGRESS", "REPAIR_STATE_PENDING", -"REPAIR_STATE_SKIPPED", "REPAIR_STATE_ABORTED" ], "enumDescriptions": [ @@ -5139,7 +5028,6 @@ true "The `repair` action has failed.", "The `repair` action is in progress.", "The `repair` action is pending.", -"The `repair` action was skipped.", "The `repair` action was aborted." ], "readOnly": true, @@ -5442,7 +5330,6 @@ true "TYPE_RESTRICTION_VIOLATED", "TYPE_RESOURCE_DELETED", "TYPE_ROLLOUT_UPDATE", -"TYPE_DEPLOY_POLICY_EVALUATION", "TYPE_RENDER_STATUES_CHANGE" ], "enumDeprecated": [ @@ -5453,7 +5340,6 @@ false, false, false, false, -false, true ], "enumDescriptions": [ @@ -5464,7 +5350,6 @@ true "Restriction check failed.", "Resource deleted.", "Rollout updated.", -"Deploy Policy evaluation.", "Deprecated: This field is never used. Use release_render log type instead." ], "type": "string" @@ -5546,7 +5431,6 @@ true "TYPE_RESTRICTION_VIOLATED", "TYPE_RESOURCE_DELETED", "TYPE_ROLLOUT_UPDATE", -"TYPE_DEPLOY_POLICY_EVALUATION", "TYPE_RENDER_STATUES_CHANGE" ], "enumDeprecated": [ @@ -5557,7 +5441,6 @@ false, false, false, false, -false, true ], "enumDescriptions": [ @@ -5568,7 +5451,6 @@ true "Restriction check failed.", "Resource deleted.", "Rollout updated.", -"Deploy Policy evaluation.", "Deprecated: This field is never used. Use release_render log type instead." ], "type": "string" @@ -6034,7 +5916,6 @@ true "TYPE_RESTRICTION_VIOLATED", "TYPE_RESOURCE_DELETED", "TYPE_ROLLOUT_UPDATE", -"TYPE_DEPLOY_POLICY_EVALUATION", "TYPE_RENDER_STATUES_CHANGE" ], "enumDeprecated": [ @@ -6045,7 +5926,6 @@ false, false, false, false, -false, true ], "enumDescriptions": [ @@ -6056,7 +5936,6 @@ true "Restriction check failed.", "Resource deleted.", "Rollout updated.", -"Deploy Policy evaluation.", "Deprecated: This field is never used. Use release_render log type instead." ], "type": "string" diff --git a/googleapiclient/discovery_cache/documents/cloudfunctions.v1.json b/googleapiclient/discovery_cache/documents/cloudfunctions.v1.json index 088862a04b9..032d8d4beb5 100644 --- a/googleapiclient/discovery_cache/documents/cloudfunctions.v1.json +++ b/googleapiclient/discovery_cache/documents/cloudfunctions.v1.json @@ -552,7 +552,7 @@ } } }, -"revision": "20240523", +"revision": "20240530", "rootUrl": "https://cloudfunctions.googleapis.com/", "schemas": { "AuditConfig": { diff --git a/googleapiclient/discovery_cache/documents/cloudfunctions.v2.json b/googleapiclient/discovery_cache/documents/cloudfunctions.v2.json index a9f36b7afd5..69ba007a4be 100644 --- a/googleapiclient/discovery_cache/documents/cloudfunctions.v2.json +++ b/googleapiclient/discovery_cache/documents/cloudfunctions.v2.json @@ -716,7 +716,7 @@ } } }, -"revision": "20240523", +"revision": "20240530", "rootUrl": "https://cloudfunctions.googleapis.com/", "schemas": { "AbortFunctionUpgradeRequest": { diff --git a/googleapiclient/discovery_cache/documents/cloudfunctions.v2alpha.json b/googleapiclient/discovery_cache/documents/cloudfunctions.v2alpha.json index 11dc4fde05e..471e05bfe5d 100644 --- a/googleapiclient/discovery_cache/documents/cloudfunctions.v2alpha.json +++ b/googleapiclient/discovery_cache/documents/cloudfunctions.v2alpha.json @@ -716,7 +716,7 @@ } } }, -"revision": "20240523", +"revision": "20240530", "rootUrl": "https://cloudfunctions.googleapis.com/", "schemas": { "AbortFunctionUpgradeRequest": { diff --git a/googleapiclient/discovery_cache/documents/cloudfunctions.v2beta.json b/googleapiclient/discovery_cache/documents/cloudfunctions.v2beta.json index 14b9f1c4e18..73ca26066cf 100644 --- a/googleapiclient/discovery_cache/documents/cloudfunctions.v2beta.json +++ b/googleapiclient/discovery_cache/documents/cloudfunctions.v2beta.json @@ -716,7 +716,7 @@ } } }, -"revision": "20240523", +"revision": "20240530", "rootUrl": "https://cloudfunctions.googleapis.com/", "schemas": { "AbortFunctionUpgradeRequest": { diff --git a/googleapiclient/discovery_cache/documents/cloudidentity.v1.json b/googleapiclient/discovery_cache/documents/cloudidentity.v1.json index e67221c54bd..3db111f7955 100644 --- a/googleapiclient/discovery_cache/documents/cloudidentity.v1.json +++ b/googleapiclient/discovery_cache/documents/cloudidentity.v1.json @@ -1990,7 +1990,7 @@ } } }, -"revision": "20240527", +"revision": "20240603", "rootUrl": "https://cloudidentity.googleapis.com/", "schemas": { "AddIdpCredentialOperationMetadata": { diff --git a/googleapiclient/discovery_cache/documents/cloudidentity.v1beta1.json b/googleapiclient/discovery_cache/documents/cloudidentity.v1beta1.json index 7ae4a79756e..5b79372a918 100644 --- a/googleapiclient/discovery_cache/documents/cloudidentity.v1beta1.json +++ b/googleapiclient/discovery_cache/documents/cloudidentity.v1beta1.json @@ -2015,7 +2015,7 @@ } } }, -"revision": "20240527", +"revision": "20240603", "rootUrl": "https://cloudidentity.googleapis.com/", "schemas": { "AddIdpCredentialOperationMetadata": { diff --git a/googleapiclient/discovery_cache/documents/cloudprofiler.v2.json b/googleapiclient/discovery_cache/documents/cloudprofiler.v2.json index 7daa7396755..7354ae738f1 100644 --- a/googleapiclient/discovery_cache/documents/cloudprofiler.v2.json +++ b/googleapiclient/discovery_cache/documents/cloudprofiler.v2.json @@ -254,7 +254,7 @@ } } }, -"revision": "20240520", +"revision": "20240603", "rootUrl": "https://cloudprofiler.googleapis.com/", "schemas": { "CreateProfileRequest": { diff --git a/googleapiclient/discovery_cache/documents/cloudresourcemanager.v1.json b/googleapiclient/discovery_cache/documents/cloudresourcemanager.v1.json index 2d9ebea6856..140f56bc46c 100644 --- a/googleapiclient/discovery_cache/documents/cloudresourcemanager.v1.json +++ b/googleapiclient/discovery_cache/documents/cloudresourcemanager.v1.json @@ -1171,7 +1171,7 @@ } } }, -"revision": "20240602", +"revision": "20240604", "rootUrl": "https://cloudresourcemanager.googleapis.com/", "schemas": { "Ancestor": { diff --git a/googleapiclient/discovery_cache/documents/cloudresourcemanager.v1beta1.json b/googleapiclient/discovery_cache/documents/cloudresourcemanager.v1beta1.json index 11534e89e54..a6f976fdb49 100644 --- a/googleapiclient/discovery_cache/documents/cloudresourcemanager.v1beta1.json +++ b/googleapiclient/discovery_cache/documents/cloudresourcemanager.v1beta1.json @@ -568,7 +568,7 @@ } } }, -"revision": "20240602", +"revision": "20240604", "rootUrl": "https://cloudresourcemanager.googleapis.com/", "schemas": { "Ancestor": { diff --git a/googleapiclient/discovery_cache/documents/cloudresourcemanager.v2.json b/googleapiclient/discovery_cache/documents/cloudresourcemanager.v2.json index 452edcc899c..0e8c2bfe955 100644 --- a/googleapiclient/discovery_cache/documents/cloudresourcemanager.v2.json +++ b/googleapiclient/discovery_cache/documents/cloudresourcemanager.v2.json @@ -450,7 +450,7 @@ } } }, -"revision": "20240602", +"revision": "20240604", "rootUrl": "https://cloudresourcemanager.googleapis.com/", "schemas": { "AuditConfig": { diff --git a/googleapiclient/discovery_cache/documents/cloudresourcemanager.v2beta1.json b/googleapiclient/discovery_cache/documents/cloudresourcemanager.v2beta1.json index b47b2c5d00d..54300bc7fe9 100644 --- a/googleapiclient/discovery_cache/documents/cloudresourcemanager.v2beta1.json +++ b/googleapiclient/discovery_cache/documents/cloudresourcemanager.v2beta1.json @@ -450,7 +450,7 @@ } } }, -"revision": "20240602", +"revision": "20240604", "rootUrl": "https://cloudresourcemanager.googleapis.com/", "schemas": { "AuditConfig": { diff --git a/googleapiclient/discovery_cache/documents/cloudresourcemanager.v3.json b/googleapiclient/discovery_cache/documents/cloudresourcemanager.v3.json index 7f7e74e53f5..451edafaef7 100644 --- a/googleapiclient/discovery_cache/documents/cloudresourcemanager.v3.json +++ b/googleapiclient/discovery_cache/documents/cloudresourcemanager.v3.json @@ -1805,7 +1805,7 @@ } } }, -"revision": "20240602", +"revision": "20240604", "rootUrl": "https://cloudresourcemanager.googleapis.com/", "schemas": { "AuditConfig": { diff --git a/googleapiclient/discovery_cache/documents/cloudsupport.v2.json b/googleapiclient/discovery_cache/documents/cloudsupport.v2.json index 01f2f17e575..06127c4bb51 100644 --- a/googleapiclient/discovery_cache/documents/cloudsupport.v2.json +++ b/googleapiclient/discovery_cache/documents/cloudsupport.v2.json @@ -552,7 +552,7 @@ } } }, -"revision": "20240602", +"revision": "20240604", "rootUrl": "https://cloudsupport.googleapis.com/", "schemas": { "Actor": { diff --git a/googleapiclient/discovery_cache/documents/cloudsupport.v2beta.json b/googleapiclient/discovery_cache/documents/cloudsupport.v2beta.json index c02bfc8a388..26940bba424 100644 --- a/googleapiclient/discovery_cache/documents/cloudsupport.v2beta.json +++ b/googleapiclient/discovery_cache/documents/cloudsupport.v2beta.json @@ -619,7 +619,7 @@ } } }, -"revision": "20240602", +"revision": "20240604", "rootUrl": "https://cloudsupport.googleapis.com/", "schemas": { "Actor": { diff --git a/googleapiclient/discovery_cache/documents/cloudtasks.v2.json b/googleapiclient/discovery_cache/documents/cloudtasks.v2.json index 32ea140c51c..d64b5a52ce2 100644 --- a/googleapiclient/discovery_cache/documents/cloudtasks.v2.json +++ b/googleapiclient/discovery_cache/documents/cloudtasks.v2.json @@ -779,7 +779,7 @@ } } }, -"revision": "20240412", +"revision": "20240524", "rootUrl": "https://cloudtasks.googleapis.com/", "schemas": { "AppEngineHttpRequest": { diff --git a/googleapiclient/discovery_cache/documents/cloudtasks.v2beta2.json b/googleapiclient/discovery_cache/documents/cloudtasks.v2beta2.json index e532cbe2f7a..87039aab4fa 100644 --- a/googleapiclient/discovery_cache/documents/cloudtasks.v2beta2.json +++ b/googleapiclient/discovery_cache/documents/cloudtasks.v2beta2.json @@ -935,7 +935,7 @@ } } }, -"revision": "20240412", +"revision": "20240524", "rootUrl": "https://cloudtasks.googleapis.com/", "schemas": { "AcknowledgeTaskRequest": { diff --git a/googleapiclient/discovery_cache/documents/cloudtasks.v2beta3.json b/googleapiclient/discovery_cache/documents/cloudtasks.v2beta3.json index 57e6d794115..4af7df04239 100644 --- a/googleapiclient/discovery_cache/documents/cloudtasks.v2beta3.json +++ b/googleapiclient/discovery_cache/documents/cloudtasks.v2beta3.json @@ -791,7 +791,7 @@ } } }, -"revision": "20240412", +"revision": "20240524", "rootUrl": "https://cloudtasks.googleapis.com/", "schemas": { "AppEngineHttpQueue": { diff --git a/googleapiclient/discovery_cache/documents/composer.v1.json b/googleapiclient/discovery_cache/documents/composer.v1.json index 5177cd4b468..44b8763daf8 100644 --- a/googleapiclient/discovery_cache/documents/composer.v1.json +++ b/googleapiclient/discovery_cache/documents/composer.v1.json @@ -966,7 +966,7 @@ } } }, -"revision": "20240520", +"revision": "20240604", "rootUrl": "https://composer.googleapis.com/", "schemas": { "AirflowMetadataRetentionPolicyConfig": { diff --git a/googleapiclient/discovery_cache/documents/composer.v1beta1.json b/googleapiclient/discovery_cache/documents/composer.v1beta1.json index b1d06e2c272..dc1bee410aa 100644 --- a/googleapiclient/discovery_cache/documents/composer.v1beta1.json +++ b/googleapiclient/discovery_cache/documents/composer.v1beta1.json @@ -994,7 +994,7 @@ } } }, -"revision": "20240520", +"revision": "20240604", "rootUrl": "https://composer.googleapis.com/", "schemas": { "AirflowMetadataRetentionPolicyConfig": { diff --git a/googleapiclient/discovery_cache/documents/config.v1.json b/googleapiclient/discovery_cache/documents/config.v1.json index 56da112eee8..a68edf3ba3e 100644 --- a/googleapiclient/discovery_cache/documents/config.v1.json +++ b/googleapiclient/discovery_cache/documents/config.v1.json @@ -1187,7 +1187,7 @@ } } }, -"revision": "20240515", +"revision": "20240527", "rootUrl": "https://config.googleapis.com/", "schemas": { "ApplyResults": { diff --git a/googleapiclient/discovery_cache/documents/connectors.v2.json b/googleapiclient/discovery_cache/documents/connectors.v2.json index 069c44120a5..2371440dc84 100644 --- a/googleapiclient/discovery_cache/documents/connectors.v2.json +++ b/googleapiclient/discovery_cache/documents/connectors.v2.json @@ -672,34 +672,17 @@ "location": "query", "type": "string" }, -"pageSize": { -"description": "Number of entity rows to return. Defaults page size = 25. Max page size = 200.", -"format": "int32", -"location": "query", -"type": "integer" -}, -"pageToken": { -"description": "Page token value if available from a previous request.", -"location": "query", -"type": "string" -}, "parent": { "description": "Required. Resource name of the Entity Type. Format: projects/{project}/locations/{location}/connections/{connection}/entityTypes/{type}", "location": "path", "pattern": "^projects/[^/]+/locations/[^/]+/connections/[^/]+/entityTypes/[^/]+$", "required": true, "type": "string" -}, -"sortBy": { -"description": "List of 'sort_by' columns to use when returning the results.", -"location": "query", -"repeated": true, -"type": "string" } }, "path": "v2/{+parent}/entitieswithacls", "response": { -"$ref": "ListEntitiesWithACLsResponse" +"$ref": "Operation" }, "scopes": [ "https://www.googleapis.com/auth/cloud-platform" @@ -716,7 +699,7 @@ } } }, -"revision": "20240529", +"revision": "20240606", "rootUrl": "https://connectors.googleapis.com/", "schemas": { "AccessCredentials": { @@ -739,20 +722,6 @@ }, "type": "object" }, -"AclInfo": { -"description": "AclInfo has a list of readers for a resource. This is defined as per the below docs https://cloud.google.com/generative-ai-app-builder/docs/reference/rest/v1alpha/projects.locations.collections.dataStores.branches.documents#aclinfo", -"id": "AclInfo", -"properties": { -"readers": { -"description": "A list of readers for a resource.", -"items": { -"$ref": "Readers" -}, -"type": "array" -} -}, -"type": "object" -}, "Action": { "description": "Action message contains metadata information about a single action present in the external system.", "id": "Action", @@ -957,25 +926,6 @@ }, "type": "object" }, -"EntityWithACL": { -"description": "EntityWithACL refers to a single row of an entity type with ACL information.", -"id": "EntityWithACL", -"properties": { -"acl_info": { -"$ref": "AclInfo", -"description": "ACL information of the entity." -}, -"id": { -"readOnly": true, -"type": "string" -}, -"jsonData": { -"description": "Entity data in JSON format.", -"type": "string" -} -}, -"type": "object" -}, "ExchangeAuthCodeRequest": { "description": "ExchangeAuthCodeRequest currently includes no fields.", "id": "ExchangeAuthCodeRequest", @@ -1792,24 +1742,6 @@ false }, "type": "object" }, -"ListEntitiesWithACLsResponse": { -"description": "Response message for EntityService.ListEntitiesWithACLs", -"id": "ListEntitiesWithACLsResponse", -"properties": { -"entitiesWithAcl": { -"description": "List containing entity rows.", -"items": { -"$ref": "EntityWithACL" -}, -"type": "array" -}, -"nextPageToken": { -"description": "Next page token if more records are available.", -"type": "string" -} -}, -"type": "object" -}, "ListEntityTypesResponse": { "description": "Response message for EntityService.ListEntityTypes", "id": "ListEntityTypesResponse", @@ -1986,31 +1918,51 @@ false }, "type": "object" }, -"PerSliSloEligibility": { -"description": "PerSliSloEligibility is a mapping from an SLI name to eligibility.", -"id": "PerSliSloEligibility", +"Operation": { +"description": "This resource represents a long-running operation that is the result of a network API call.", +"id": "Operation", "properties": { -"eligibilities": { +"done": { +"description": "If the value is `false`, it means the operation is still in progress. If `true`, the operation is completed, and either `error` or `response` is available.", +"type": "boolean" +}, +"error": { +"$ref": "Status", +"description": "The error result of the operation in case of failure or cancellation." +}, +"metadata": { "additionalProperties": { -"$ref": "SloEligibility" +"description": "Properties of the object. Contains field @type with type URL.", +"type": "any" }, -"description": "An entry in the eligibilities map specifies an eligibility for a particular SLI for the given instance. The SLI key in the name must be a valid SLI name specified in the Eligibility Exporter binary flags otherwise an error will be emitted by Eligibility Exporter and the oncaller will be alerted. If an SLI has been defined in the binary flags but the eligibilities map does not contain it, the corresponding SLI time series will not be emitted by the Eligibility Exporter. This ensures a smooth rollout and compatibility between the data produced by different versions of the Eligibility Exporters. If eligibilities map contains a key for an SLI which has not been declared in the binary flags, there will be an error message emitted in the Eligibility Exporter log and the metric for the SLI in question will not be emitted.", +"description": "Service-specific metadata associated with the operation. It typically contains progress information and common metadata such as create time. Some services might not provide such metadata. Any method that returns a long-running operation should document the metadata type, if any.", +"type": "object" +}, +"name": { +"description": "The server-assigned name, which is only unique within the same service that originally returns it. If you use the default HTTP mapping, the `name` should be a resource name ending with `operations/{unique_id}`.", +"type": "string" +}, +"response": { +"additionalProperties": { +"description": "Properties of the object. Contains field @type with type URL.", +"type": "any" +}, +"description": "The normal, successful response of the operation. If the original method returns no data on success, such as `Delete`, the response is `google.protobuf.Empty`. If the original method is standard `Get`/`Create`/`Update`, the response should be the resource. For other methods, the response should have the type `XxxResponse`, where `Xxx` is the original method name. For example, if the original method name is `TakeSnapshot()`, the inferred response type is `TakeSnapshotResponse`.", "type": "object" } }, "type": "object" }, -"Principal": { -"description": "Principal is a user or group that has access to a resource.", -"id": "Principal", +"PerSliSloEligibility": { +"description": "PerSliSloEligibility is a mapping from an SLI name to eligibility.", +"id": "PerSliSloEligibility", "properties": { -"group_id": { -"description": "The group that has access to a resource.", -"type": "string" +"eligibilities": { +"additionalProperties": { +"$ref": "SloEligibility" }, -"user_id": { -"description": "The user that has access to a resource.", -"type": "string" +"description": "An entry in the eligibilities map specifies an eligibility for a particular SLI for the given instance. The SLI key in the name must be a valid SLI name specified in the Eligibility Exporter binary flags otherwise an error will be emitted by Eligibility Exporter and the oncaller will be alerted. If an SLI has been defined in the binary flags but the eligibilities map does not contain it, the corresponding SLI time series will not be emitted by the Eligibility Exporter. This ensures a smooth rollout and compatibility between the data produced by different versions of the Eligibility Exporters. If eligibilities map contains a key for an SLI which has not been declared in the binary flags, there will be an error message emitted in the Eligibility Exporter log and the metric for the SLI in question will not be emitted.", +"type": "object" } }, "type": "object" @@ -2212,20 +2164,6 @@ false }, "type": "object" }, -"Readers": { -"description": "Readers is a list of principals that have read access to a resource.", -"id": "Readers", -"properties": { -"principals": { -"description": "A list of principals that have read access to a resource.", -"items": { -"$ref": "Principal" -}, -"type": "array" -} -}, -"type": "object" -}, "Reference": { "id": "Reference", "properties": { @@ -2497,6 +2435,33 @@ false }, "type": "object" }, +"Status": { +"description": "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).", +"id": "Status", +"properties": { +"code": { +"description": "The status code, which should be an enum value of google.rpc.Code.", +"format": "int32", +"type": "integer" +}, +"details": { +"description": "A list of messages that carry the error details. There is a common set of message types for APIs to use.", +"items": { +"additionalProperties": { +"description": "Properties of the object. Contains field @type with type URL.", +"type": "any" +}, +"type": "object" +}, +"type": "array" +}, +"message": { +"description": "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.", +"type": "string" +} +}, +"type": "object" +}, "TimeOfDay": { "description": "Represents a time of day. The date and time zone are either not significant or are specified elsewhere. An API may choose to allow leap seconds. Related types are google.type.Date and `google.protobuf.Timestamp`.", "id": "TimeOfDay", diff --git a/googleapiclient/discovery_cache/documents/contactcenteraiplatform.v1alpha1.json b/googleapiclient/discovery_cache/documents/contactcenteraiplatform.v1alpha1.json index c0253abf3bb..84a1283b886 100644 --- a/googleapiclient/discovery_cache/documents/contactcenteraiplatform.v1alpha1.json +++ b/googleapiclient/discovery_cache/documents/contactcenteraiplatform.v1alpha1.json @@ -512,7 +512,7 @@ } } }, -"revision": "20240531", +"revision": "20240607", "rootUrl": "https://contactcenteraiplatform.googleapis.com/", "schemas": { "AdminUser": { @@ -544,10 +544,10 @@ "description": "Name of the component.", "type": "string" }, -"serviceAttachments": { -"description": "Associated service attachments.", +"serviceAttachmentNames": { +"description": "Associated service attachments. The service attachment names that will be used for sending private traffic to the CCAIP tenant project. Example service attachment name: \"projects/${TENANT_PROJECT_ID}/regions/${REGION}/serviceAttachments/ingress-default\".", "items": { -"$ref": "ServiceAttachment" +"type": "string" }, "type": "array" } @@ -1016,6 +1016,24 @@ "$ref": "Component" }, "type": "array" +}, +"pscSetting": { +"$ref": "PscSetting", +"description": "Private service connect settings." +} +}, +"type": "object" +}, +"PscSetting": { +"description": "Private service connect settings.", +"id": "PscSetting", +"properties": { +"allowedConsumerProjectIds": { +"description": "The list of project ids that are allowed to send traffic to the service attachment. This field should be filled only for the ingress components.", +"items": { +"type": "string" +}, +"type": "array" } }, "type": "object" @@ -1162,24 +1180,6 @@ }, "type": "object" }, -"ServiceAttachment": { -"description": "Container for the VPC-SC networking configurations.", -"id": "ServiceAttachment", -"properties": { -"allowedProjectIds": { -"description": "The list of project ids that are allowed to send traffic to the service attachment. This field should be filled only for the ingress service attachments.", -"items": { -"type": "string" -}, -"type": "array" -}, -"name": { -"description": "The service attachment name that will be used for sending private traffic to the CCAIP tenant project. Example: \"projects/${TENANT_PROJECT_ID}/regions/${REGION}/serviceAttachments/ingress-default\".", -"type": "string" -} -}, -"type": "object" -}, "Status": { "description": "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).", "id": "Status", diff --git a/googleapiclient/discovery_cache/documents/contactcenterinsights.v1.json b/googleapiclient/discovery_cache/documents/contactcenterinsights.v1.json index 6ff3cd43796..37751c518a2 100644 --- a/googleapiclient/discovery_cache/documents/contactcenterinsights.v1.json +++ b/googleapiclient/discovery_cache/documents/contactcenterinsights.v1.json @@ -1474,7 +1474,7 @@ } } }, -"revision": "20240603", +"revision": "20240610", "rootUrl": "https://contactcenterinsights.googleapis.com/", "schemas": { "GoogleCloudContactcenterinsightsV1Analysis": { diff --git a/googleapiclient/discovery_cache/documents/containeranalysis.v1.json b/googleapiclient/discovery_cache/documents/containeranalysis.v1.json index fb2b1f4f28f..f5f9c064baf 100644 --- a/googleapiclient/discovery_cache/documents/containeranalysis.v1.json +++ b/googleapiclient/discovery_cache/documents/containeranalysis.v1.json @@ -1065,7 +1065,7 @@ } } }, -"revision": "20240524", +"revision": "20240531", "rootUrl": "https://containeranalysis.googleapis.com/", "schemas": { "AliasContext": { diff --git a/googleapiclient/discovery_cache/documents/containeranalysis.v1alpha1.json b/googleapiclient/discovery_cache/documents/containeranalysis.v1alpha1.json index 5041cc03884..61eee9abfe5 100644 --- a/googleapiclient/discovery_cache/documents/containeranalysis.v1alpha1.json +++ b/googleapiclient/discovery_cache/documents/containeranalysis.v1alpha1.json @@ -1233,7 +1233,7 @@ } } }, -"revision": "20240524", +"revision": "20240531", "rootUrl": "https://containeranalysis.googleapis.com/", "schemas": { "AnalysisCompleted": { diff --git a/googleapiclient/discovery_cache/documents/containeranalysis.v1beta1.json b/googleapiclient/discovery_cache/documents/containeranalysis.v1beta1.json index 831d370c669..8133c716c4e 100644 --- a/googleapiclient/discovery_cache/documents/containeranalysis.v1beta1.json +++ b/googleapiclient/discovery_cache/documents/containeranalysis.v1beta1.json @@ -1121,7 +1121,7 @@ } } }, -"revision": "20240524", +"revision": "20240531", "rootUrl": "https://containeranalysis.googleapis.com/", "schemas": { "AliasContext": { diff --git a/googleapiclient/discovery_cache/documents/content.v2.1.json b/googleapiclient/discovery_cache/documents/content.v2.1.json index b23299a2fb3..3ffd49b5eff 100644 --- a/googleapiclient/discovery_cache/documents/content.v2.1.json +++ b/googleapiclient/discovery_cache/documents/content.v2.1.json @@ -6219,7 +6219,7 @@ } } }, -"revision": "20240529", +"revision": "20240609", "rootUrl": "https://shoppingcontent.googleapis.com/", "schemas": { "Account": { @@ -14766,7 +14766,7 @@ false "description": "Clarifies the severity of the issue. The summarizing message, if present, should be shown right under the title for each issue. It helps merchants to quickly understand the impact of the issue. The detailed breakdown helps the merchant to fully understand the impact of the issue. It can be rendered as dialog that opens when the merchant mouse over the summarized impact statement. Issues with different severity can be styled differently. They may use a different color or icon to signal the difference between `ERROR`, `WARNING` and `INFO`." }, "prerenderedContent": { -"description": "Details of the issue as a pre-rendered HTML. HTML elements contain CSS classes that can be used to customize the style of the content. Always sanitize the HTML before embedding it directly to your application. The sanitizer needs to allow basic HTML tags, such as: `div`, `span`, `p`, `a`, `ul`, `li`, `table`, `tr`, `td`. For example, you can use [DOMPurify](https://www.npmjs.com/package/dompurify). CSS classes: * `issue-detail` - top level container for the detail of the issue * `callout-banners` - section of the `issue-detail` with callout banners * `callout-banner` - single callout banner, inside `callout-banners` * `callout-banner-info` - callout with important information (default) * `callout-banner-warning` - callout with a warning * `callout-banner-error` - callout informing about an error (most severe) * `issue-content` - section of the `issue-detail`, contains multiple `content-element` * `content-element` - content element such as a list, link or paragraph, inside `issue-content` * `root-causes` - unordered list with items describing root causes of the issue, inside `issue-content` * `root-causes-intro` - intro text before the `root-causes` list, inside `issue-content` * `segment` - section of the text, `span` inside paragraph * `segment-attribute` - section of the text that represents a product attribute, for example 'image\\_link' * `segment-literal` - section of the text that contains a special value, for example '0-1000 kg' * `segment-bold` - section of the text that should be rendered as bold * `segment-italic` - section of the text that should be rendered as italic * `tooltip` - used on paragraphs that should be rendered with a tooltip. A section of the text in such a paragraph will have a class `tooltip-text` and is intended to be shown in a mouse over dialog. If the style is not used, the `tooltip-text` section would be shown on a new line, after the main part of the text. * `tooltip-text` - marks a section of the text within a `tooltip`, that is intended to be shown in a mouse over dialog. * `tooltip-icon` - marks a section of the text within a `tooltip`, that can be replaced with a tooltip icon, for example '?' or 'i'. By default, this section contains a `br` tag, that is separating the main text and the tooltip text when the style is not used. * `tooltip-style-question` - the tooltip shows helpful information, can use the '?' as an icon. * `tooltip-style-info` - the tooltip adds additional information fitting to the context, can use the 'i' as an icon. * `content-moderation` - marks the paragraph that explains how the issue was identified. * `new-element` - Present for new elements added to the pre-rendered content in the future. To make sure that a new content element does not break your style, you can hide everything with this class.", +"description": "Details of the issue as a pre-rendered HTML. HTML elements contain CSS classes that can be used to customize the style of the content. Always sanitize the HTML before embedding it directly to your application. The sanitizer needs to allow basic HTML tags, such as: `div`, `span`, `p`, `a`, `ul`, `li`, `table`, `tr`, `td`. For example, you can use [DOMPurify](https://www.npmjs.com/package/dompurify). CSS classes: * `issue-detail` - top level container for the detail of the issue * `callout-banners` - section of the `issue-detail` with callout banners * `callout-banner` - single callout banner, inside `callout-banners` * `callout-banner-info` - callout with important information (default) * `callout-banner-warning` - callout with a warning * `callout-banner-error` - callout informing about an error (most severe) * `issue-content` - section of the `issue-detail`, contains multiple `content-element` * `content-element` - content element such as a list, link or paragraph, inside `issue-content` * `root-causes` - unordered list with items describing root causes of the issue, inside `issue-content` * `root-causes-intro` - intro text before the `root-causes` list, inside `issue-content` * `segment` - section of the text, `span` inside paragraph * `segment-attribute` - section of the text that represents a product attribute, for example 'image\\_link' * `segment-literal` - section of the text that contains a special value, for example '0-1000 kg' * `segment-bold` - section of the text that should be rendered as bold * `segment-italic` - section of the text that should be rendered as italic * `tooltip` - used on paragraphs that should be rendered with a tooltip. A section of the text in such a paragraph will have a class `tooltip-text` and is intended to be shown in a mouse over dialog. If the style is not used, the `tooltip-text` section would be shown on a new line, after the main part of the text. * `tooltip-text` - marks a section of the text within a `tooltip`, that is intended to be shown in a mouse over dialog. * `tooltip-icon` - marks a section of the text within a `tooltip`, that can be replaced with a tooltip icon, for example '?' or 'i'. By default, this section contains a `br` tag, that is separating the main text and the tooltip text when the style is not used. * `tooltip-style-question` - the tooltip shows helpful information, can use the '?' as an icon. * `tooltip-style-info` - the tooltip adds additional information fitting to the context, can use the 'i' as an icon. * `content-moderation` - marks the paragraph that explains how the issue was identified. * `list-intro` - marks the paragraph that contains an intro for a list. This paragraph will be always followed by a list. * `new-element` - Present for new elements added to the pre-rendered content in the future. To make sure that a new content element does not break your style, you can hide everything with this class.", "type": "string" }, "title": { diff --git a/googleapiclient/discovery_cache/documents/customsearch.v1.json b/googleapiclient/discovery_cache/documents/customsearch.v1.json index d76a3c16f49..92bec84ddf6 100644 --- a/googleapiclient/discovery_cache/documents/customsearch.v1.json +++ b/googleapiclient/discovery_cache/documents/customsearch.v1.json @@ -702,7 +702,7 @@ false } } }, -"revision": "20240602", +"revision": "20240609", "rootUrl": "https://customsearch.googleapis.com/", "schemas": { "Promotion": { diff --git a/googleapiclient/discovery_cache/documents/dataflow.v1b3.json b/googleapiclient/discovery_cache/documents/dataflow.v1b3.json index f4d4af4fdd9..eab6b812dde 100644 --- a/googleapiclient/discovery_cache/documents/dataflow.v1b3.json +++ b/googleapiclient/discovery_cache/documents/dataflow.v1b3.json @@ -24,18 +24,28 @@ "endpoints": [ { "description": "Regional Endpoint", -"endpointUrl": "https://dataflow.me-central2.rep.googleapis.com/", -"location": "me-central2" +"endpointUrl": "https://dataflow.europe-west3.rep.googleapis.com/", +"location": "europe-west3" }, { "description": "Regional Endpoint", -"endpointUrl": "https://dataflow.europe-west3.rep.googleapis.com/", -"location": "europe-west3" +"endpointUrl": "https://dataflow.europe-west8.rep.googleapis.com/", +"location": "europe-west8" }, { "description": "Regional Endpoint", "endpointUrl": "https://dataflow.europe-west9.rep.googleapis.com/", "location": "europe-west9" +}, +{ +"description": "Regional Endpoint", +"endpointUrl": "https://dataflow.me-central2.rep.googleapis.com/", +"location": "me-central2" +}, +{ +"description": "Regional Endpoint", +"endpointUrl": "https://dataflow.us-east7.rep.googleapis.com/", +"location": "us-east7" } ], "fullyEncodeReservedExpansion": true, @@ -2187,7 +2197,7 @@ } } }, -"revision": "20240520", +"revision": "20240603", "rootUrl": "https://dataflow.googleapis.com/", "schemas": { "ApproximateProgress": { @@ -4981,7 +4991,34 @@ "BOOLEAN", "ENUM", "NUMBER", -"KAFKA_TOPIC" +"KAFKA_TOPIC", +"KAFKA_READ_TOPIC", +"KAFKA_WRITE_TOPIC" +], +"enumDeprecated": [ +false, +false, +false, +false, +false, +false, +false, +false, +false, +false, +false, +false, +false, +false, +false, +false, +false, +false, +false, +false, +true, +false, +false ], "enumDescriptions": [ "Default input type.", @@ -5004,7 +5041,9 @@ "The parameter specifies a boolean input.", "The parameter specifies an enum input.", "The parameter specifies a number input.", -"The parameter specifies the fully-qualified name of an Apache Kafka topic. This can be either a Google Managed Kafka topic or a non-managed Kafka topic." +"Deprecated. Please use KAFKA_READ_TOPIC instead.", +"The parameter specifies the fully-qualified name of an Apache Kafka topic. This can be either a Google Managed Kafka topic or a non-managed Kafka topic.", +"The parameter specifies the fully-qualified name of an Apache Kafka topic. This can be an existing Google Managed Kafka topic, the name for a new Google Managed Kafka topic, or an existing non-managed Kafka topic." ], "type": "string" }, diff --git a/googleapiclient/discovery_cache/documents/dataform.v1beta1.json b/googleapiclient/discovery_cache/documents/dataform.v1beta1.json index fbc1de1beb6..616ba3c5002 100644 --- a/googleapiclient/discovery_cache/documents/dataform.v1beta1.json +++ b/googleapiclient/discovery_cache/documents/dataform.v1beta1.json @@ -2171,7 +2171,7 @@ } } }, -"revision": "20240504", +"revision": "20240516", "rootUrl": "https://dataform.googleapis.com/", "schemas": { "Assertion": { diff --git a/googleapiclient/discovery_cache/documents/datalineage.v1.json b/googleapiclient/discovery_cache/documents/datalineage.v1.json index 60dc08ee4b7..931a59c846a 100644 --- a/googleapiclient/discovery_cache/documents/datalineage.v1.json +++ b/googleapiclient/discovery_cache/documents/datalineage.v1.json @@ -798,7 +798,7 @@ } } }, -"revision": "20240517", +"revision": "20240531", "rootUrl": "https://datalineage.googleapis.com/", "schemas": { "GoogleCloudDatacatalogLineageV1BatchSearchLinkProcessesRequest": { diff --git a/googleapiclient/discovery_cache/documents/datamigration.v1.json b/googleapiclient/discovery_cache/documents/datamigration.v1.json index 398562c8ce6..fa5663dbe60 100644 --- a/googleapiclient/discovery_cache/documents/datamigration.v1.json +++ b/googleapiclient/discovery_cache/documents/datamigration.v1.json @@ -2125,7 +2125,7 @@ } } }, -"revision": "20240522", +"revision": "20240605", "rootUrl": "https://datamigration.googleapis.com/", "schemas": { "AlloyDbConnectionProfile": { diff --git a/googleapiclient/discovery_cache/documents/datamigration.v1beta1.json b/googleapiclient/discovery_cache/documents/datamigration.v1beta1.json index c97e3988a6f..47c7deb1e49 100644 --- a/googleapiclient/discovery_cache/documents/datamigration.v1beta1.json +++ b/googleapiclient/discovery_cache/documents/datamigration.v1beta1.json @@ -1049,7 +1049,7 @@ } } }, -"revision": "20240522", +"revision": "20240605", "rootUrl": "https://datamigration.googleapis.com/", "schemas": { "AuditConfig": { diff --git a/googleapiclient/discovery_cache/documents/datapipelines.v1.json b/googleapiclient/discovery_cache/documents/datapipelines.v1.json index 4b4d24fb514..9bc3b808860 100644 --- a/googleapiclient/discovery_cache/documents/datapipelines.v1.json +++ b/googleapiclient/discovery_cache/documents/datapipelines.v1.json @@ -369,7 +369,7 @@ } } }, -"revision": "20240526", +"revision": "20240602", "rootUrl": "https://datapipelines.googleapis.com/", "schemas": { "GoogleCloudDatapipelinesV1DataflowJobDetails": { diff --git a/googleapiclient/discovery_cache/documents/dataplex.v1.json b/googleapiclient/discovery_cache/documents/dataplex.v1.json index 96c2a075958..c5bb4046c83 100644 --- a/googleapiclient/discovery_cache/documents/dataplex.v1.json +++ b/googleapiclient/discovery_cache/documents/dataplex.v1.json @@ -892,7 +892,7 @@ ] }, "generateDataQualityRules": { -"description": "Generates recommended DataQualityRule from a data profiling DataScan.", +"description": "Generates recommended data quality rules based on the results of a data profiling scan.Use the recommendations to build rules for a data quality scan.", "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/dataScans/{dataScansId}:generateDataQualityRules", "httpMethod": "POST", "id": "dataplex.projects.locations.dataScans.generateDataQualityRules", @@ -901,7 +901,7 @@ ], "parameters": { "name": { -"description": "Required. The name should be either * the name of a datascan with at least one successful completed data profiling job, or * the name of a successful completed data profiling datascan job.", +"description": "Required. The name must be one of the following: The name of a data scan with at least one successful, completed data profiling job The name of a successful, completed data profiling job (a data scan job where the job type is data profiling)", "location": "path", "pattern": "^projects/[^/]+/locations/[^/]+/dataScans/[^/]+$", "required": true, @@ -1164,7 +1164,7 @@ "jobs": { "methods": { "generateDataQualityRules": { -"description": "Generates recommended DataQualityRule from a data profiling DataScan.", +"description": "Generates recommended data quality rules based on the results of a data profiling scan.Use the recommendations to build rules for a data quality scan.", "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/dataScans/{dataScansId}/jobs/{jobsId}:generateDataQualityRules", "httpMethod": "POST", "id": "dataplex.projects.locations.dataScans.jobs.generateDataQualityRules", @@ -1173,7 +1173,7 @@ ], "parameters": { "name": { -"description": "Required. The name should be either * the name of a datascan with at least one successful completed data profiling job, or * the name of a successful completed data profiling datascan job.", +"description": "Required. The name must be one of the following: The name of a data scan with at least one successful, completed data profiling job The name of a successful, completed data profiling job (a data scan job where the job type is data profiling)", "location": "path", "pattern": "^projects/[^/]+/locations/[^/]+/dataScans/[^/]+/jobs/[^/]+$", "required": true, @@ -5271,7 +5271,7 @@ } } }, -"revision": "20240523", +"revision": "20240529", "rootUrl": "https://dataplex.googleapis.com/", "schemas": { "Empty": { @@ -8302,6 +8302,11 @@ "description": "User-defined labels. The maximum size of keys and values is 128 characters each.", "type": "object" }, +"location": { +"description": "Output only. Location of the resource in the source system. Entry will be searchable by this location. By default, this should match the location of the EntryGroup containing this entry. A different value allows capturing source location for data external to GCP.", +"readOnly": true, +"type": "string" +}, "platform": { "description": "The platform containing the source system. The maximum size of the field is 64 characters.", "type": "string" @@ -8628,17 +8633,17 @@ "type": "object" }, "GoogleCloudDataplexV1GenerateDataQualityRulesRequest": { -"description": "Generate recommended DataQualityRules request.", +"description": "Request details for generating data quality rule recommendations.", "id": "GoogleCloudDataplexV1GenerateDataQualityRulesRequest", "properties": {}, "type": "object" }, "GoogleCloudDataplexV1GenerateDataQualityRulesResponse": { -"description": "Generate recommended DataQualityRules response.", +"description": "Response details for data quality rule recommendations.", "id": "GoogleCloudDataplexV1GenerateDataQualityRulesResponse", "properties": { "rule": { -"description": "Generated recommended {@link DataQualityRule}s.", +"description": "The data quality rules that Dataplex generates based on the results of a data profiling scan.", "items": { "$ref": "GoogleCloudDataplexV1DataQualityRule" }, diff --git a/googleapiclient/discovery_cache/documents/dataportability.v1.json b/googleapiclient/discovery_cache/documents/dataportability.v1.json index 7a3880a888b..450a1d1e15f 100644 --- a/googleapiclient/discovery_cache/documents/dataportability.v1.json +++ b/googleapiclient/discovery_cache/documents/dataportability.v1.json @@ -641,7 +641,7 @@ } } }, -"revision": "20240602", +"revision": "20240609", "rootUrl": "https://dataportability.googleapis.com/", "schemas": { "Empty": { diff --git a/googleapiclient/discovery_cache/documents/dataportability.v1beta.json b/googleapiclient/discovery_cache/documents/dataportability.v1beta.json index a18e88a0f3d..7844c8a0ef2 100644 --- a/googleapiclient/discovery_cache/documents/dataportability.v1beta.json +++ b/googleapiclient/discovery_cache/documents/dataportability.v1beta.json @@ -641,7 +641,7 @@ } } }, -"revision": "20240602", +"revision": "20240609", "rootUrl": "https://dataportability.googleapis.com/", "schemas": { "Empty": { diff --git a/googleapiclient/discovery_cache/documents/dataproc.v1.json b/googleapiclient/discovery_cache/documents/dataproc.v1.json index 486c55e866d..4e40cc938ff 100644 --- a/googleapiclient/discovery_cache/documents/dataproc.v1.json +++ b/googleapiclient/discovery_cache/documents/dataproc.v1.json @@ -3072,7 +3072,7 @@ } } }, -"revision": "20240525", +"revision": "20240605", "rootUrl": "https://dataproc.googleapis.com/", "schemas": { "AcceleratorConfig": { @@ -3210,6 +3210,32 @@ }, "type": "object" }, +"AutotuningConfig": { +"description": "Autotuning configuration of the workload.", +"id": "AutotuningConfig", +"properties": { +"scenarios": { +"description": "Optional. Scenarios for which tunings are applied.", +"items": { +"enum": [ +"SCENARIO_UNSPECIFIED", +"SCALING", +"BROADCAST_HASH_JOIN", +"MEMORY" +], +"enumDescriptions": [ +"Default value.", +"Scaling recommendations such as initialExecutors.", +"Adding hints for potential relation broadcasts.", +"Memory management for workloads." +], +"type": "string" +}, +"type": "array" +} +}, +"type": "object" +}, "AuxiliaryNodeGroup": { "description": "Node group identification and configuration information.", "id": "AuxiliaryNodeGroup", @@ -5606,7 +5632,9 @@ "DELETE", "RESIZE", "REPAIR", -"UPDATE_LABELS" +"UPDATE_LABELS", +"START", +"STOP" ], "enumDescriptions": [ "Node group operation type is unknown.", @@ -5615,7 +5643,9 @@ "Delete node group operation type.", "Resize node group operation type.", "Repair node group operation type.", -"Update node group label operation type." +"Update node group label operation type.", +"Start node group operation type.", +"Stop node group operation type." ], "type": "string" }, @@ -6208,6 +6238,14 @@ "description": "Runtime configuration for a workload.", "id": "RuntimeConfig", "properties": { +"autotuningConfig": { +"$ref": "AutotuningConfig", +"description": "Optional. Autotuning configuration of the workload." +}, +"cohort": { +"description": "Optional. Cohort identifier. Identifies families of the workloads having the same shape, e.g. daily ETL jobs.", +"type": "string" +}, "containerImage": { "description": "Optional. Optional custom container image for the job runtime environment. If not specified, a default container image will be used.", "type": "string" diff --git a/googleapiclient/discovery_cache/documents/datastream.v1.json b/googleapiclient/discovery_cache/documents/datastream.v1.json index 70a56649461..fbe6f16d523 100644 --- a/googleapiclient/discovery_cache/documents/datastream.v1.json +++ b/googleapiclient/discovery_cache/documents/datastream.v1.json @@ -1250,7 +1250,7 @@ } } }, -"revision": "20240515", +"revision": "20240529", "rootUrl": "https://datastream.googleapis.com/", "schemas": { "AppendOnly": { @@ -1560,6 +1560,10 @@ "postgresqlRdbms": { "$ref": "PostgresqlRdbms", "description": "PostgreSQL RDBMS to enrich with child data objects and metadata." +}, +"sqlServerRdbms": { +"$ref": "SqlServerRdbms", +"description": "SQLServer RDBMS to enrich with child data objects and metadata." } }, "type": "object" @@ -1579,6 +1583,10 @@ "postgresqlRdbms": { "$ref": "PostgresqlRdbms", "description": "Enriched PostgreSQL RDBMS object." +}, +"sqlServerRdbms": { +"$ref": "SqlServerRdbms", +"description": "Enriched SQLServer RDBMS object." } }, "type": "object" diff --git a/googleapiclient/discovery_cache/documents/datastream.v1alpha1.json b/googleapiclient/discovery_cache/documents/datastream.v1alpha1.json index 6d2edab15ff..bf8dc5b14ec 100644 --- a/googleapiclient/discovery_cache/documents/datastream.v1alpha1.json +++ b/googleapiclient/discovery_cache/documents/datastream.v1alpha1.json @@ -1224,7 +1224,7 @@ } } }, -"revision": "20240515", +"revision": "20240529", "rootUrl": "https://datastream.googleapis.com/", "schemas": { "AvroFileFormat": { diff --git a/googleapiclient/discovery_cache/documents/developerconnect.v1.json b/googleapiclient/discovery_cache/documents/developerconnect.v1.json index e732722b716..ec4abd60829 100644 --- a/googleapiclient/discovery_cache/documents/developerconnect.v1.json +++ b/googleapiclient/discovery_cache/documents/developerconnect.v1.json @@ -840,7 +840,7 @@ } } }, -"revision": "20240527", +"revision": "20240529", "rootUrl": "https://developerconnect.googleapis.com/", "schemas": { "CancelOperationRequest": { diff --git a/googleapiclient/discovery_cache/documents/dialogflow.v2.json b/googleapiclient/discovery_cache/documents/dialogflow.v2.json index 42f495edf71..7ff76fb2261 100644 --- a/googleapiclient/discovery_cache/documents/dialogflow.v2.json +++ b/googleapiclient/discovery_cache/documents/dialogflow.v2.json @@ -3644,6 +3644,35 @@ "https://www.googleapis.com/auth/dialogflow" ] }, +"suggestKnowledgeAssist": { +"description": "Gets knowledge assist suggestions based on historical messages.", +"flatPath": "v2/projects/{projectsId}/conversations/{conversationsId}/participants/{participantsId}/suggestions:suggestKnowledgeAssist", +"httpMethod": "POST", +"id": "dialogflow.projects.conversations.participants.suggestions.suggestKnowledgeAssist", +"parameterOrder": [ +"parent" +], +"parameters": { +"parent": { +"description": "Required. The name of the participant to fetch suggestions for. Format: `projects//locations//conversations//participants/`.", +"location": "path", +"pattern": "^projects/[^/]+/conversations/[^/]+/participants/[^/]+$", +"required": true, +"type": "string" +} +}, +"path": "v2/{+parent}/suggestions:suggestKnowledgeAssist", +"request": { +"$ref": "GoogleCloudDialogflowV2SuggestKnowledgeAssistRequest" +}, +"response": { +"$ref": "GoogleCloudDialogflowV2SuggestKnowledgeAssistResponse" +}, +"scopes": [ +"https://www.googleapis.com/auth/cloud-platform", +"https://www.googleapis.com/auth/dialogflow" +] +}, "suggestSmartReplies": { "description": "Gets smart replies for a participant based on specific historical messages.", "flatPath": "v2/projects/{projectsId}/conversations/{conversationsId}/participants/{participantsId}/suggestions:suggestSmartReplies", @@ -7562,6 +7591,35 @@ "https://www.googleapis.com/auth/dialogflow" ] }, +"suggestKnowledgeAssist": { +"description": "Gets knowledge assist suggestions based on historical messages.", +"flatPath": "v2/projects/{projectsId}/locations/{locationsId}/conversations/{conversationsId}/participants/{participantsId}/suggestions:suggestKnowledgeAssist", +"httpMethod": "POST", +"id": "dialogflow.projects.locations.conversations.participants.suggestions.suggestKnowledgeAssist", +"parameterOrder": [ +"parent" +], +"parameters": { +"parent": { +"description": "Required. The name of the participant to fetch suggestions for. Format: `projects//locations//conversations//participants/`.", +"location": "path", +"pattern": "^projects/[^/]+/locations/[^/]+/conversations/[^/]+/participants/[^/]+$", +"required": true, +"type": "string" +} +}, +"path": "v2/{+parent}/suggestions:suggestKnowledgeAssist", +"request": { +"$ref": "GoogleCloudDialogflowV2SuggestKnowledgeAssistRequest" +}, +"response": { +"$ref": "GoogleCloudDialogflowV2SuggestKnowledgeAssistResponse" +}, +"scopes": [ +"https://www.googleapis.com/auth/cloud-platform", +"https://www.googleapis.com/auth/dialogflow" +] +}, "suggestSmartReplies": { "description": "Gets smart replies for a participant based on specific historical messages.", "flatPath": "v2/projects/{projectsId}/locations/{locationsId}/conversations/{conversationsId}/participants/{participantsId}/suggestions:suggestSmartReplies", @@ -8597,7 +8655,7 @@ } } }, -"revision": "20240523", +"revision": "20240605", "rootUrl": "https://dialogflow.googleapis.com/", "schemas": { "GoogleCloudDialogflowCxV3AdvancedSettings": { @@ -8658,11 +8716,11 @@ "id": "GoogleCloudDialogflowCxV3AdvancedSettingsLoggingSettings", "properties": { "enableInteractionLogging": { -"description": "If true, DF Interaction logging is currently enabled.", +"description": "Enables DF Interaction logging.", "type": "boolean" }, "enableStackdriverLogging": { -"description": "If true, StackDriver logging is currently enabled.", +"description": "Enables StackDriver logging.", "type": "boolean" } }, @@ -11048,11 +11106,11 @@ "id": "GoogleCloudDialogflowCxV3beta1AdvancedSettingsLoggingSettings", "properties": { "enableInteractionLogging": { -"description": "If true, DF Interaction logging is currently enabled.", +"description": "Enables DF Interaction logging.", "type": "boolean" }, "enableStackdriverLogging": { -"description": "If true, StackDriver logging is currently enabled.", +"description": "Enables StackDriver logging.", "type": "boolean" } }, @@ -12405,6 +12463,10 @@ "text": { "$ref": "GoogleCloudDialogflowCxV3beta1TextInput", "description": "The natural language text to be processed." +}, +"toolCallResult": { +"$ref": "GoogleCloudDialogflowCxV3beta1ToolCallResult", +"description": "The results of a tool executed by the client." } }, "type": "object" @@ -12473,6 +12535,10 @@ "text": { "$ref": "GoogleCloudDialogflowCxV3beta1ResponseMessageText", "description": "Returns a text response." +}, +"toolCall": { +"$ref": "GoogleCloudDialogflowCxV3beta1ToolCall", +"description": "Returns the definition of a tool call that should be executed by the client." } }, "type": "object" @@ -12867,6 +12933,67 @@ }, "type": "object" }, +"GoogleCloudDialogflowCxV3beta1ToolCall": { +"description": "Represents a call of a specific tool's action with the specified inputs.", +"id": "GoogleCloudDialogflowCxV3beta1ToolCall", +"properties": { +"action": { +"description": "Required. The name of the tool's action associated with this call.", +"type": "string" +}, +"inputParameters": { +"additionalProperties": { +"description": "Properties of the object.", +"type": "any" +}, +"description": "Optional. The action's input parameters.", +"type": "object" +}, +"tool": { +"description": "Required. The tool associated with this call. Format: `projects//locations//agents//tools/`.", +"type": "string" +} +}, +"type": "object" +}, +"GoogleCloudDialogflowCxV3beta1ToolCallResult": { +"description": "The result of calling a tool's action that has been executed by the client.", +"id": "GoogleCloudDialogflowCxV3beta1ToolCallResult", +"properties": { +"action": { +"description": "Required. The name of the tool's action associated with this call.", +"type": "string" +}, +"error": { +"$ref": "GoogleCloudDialogflowCxV3beta1ToolCallResultError", +"description": "The tool call's error." +}, +"outputParameters": { +"additionalProperties": { +"description": "Properties of the object.", +"type": "any" +}, +"description": "The tool call's output parameters.", +"type": "object" +}, +"tool": { +"description": "Required. The tool associated with this call. Format: `projects//locations//agents//tools/`.", +"type": "string" +} +}, +"type": "object" +}, +"GoogleCloudDialogflowCxV3beta1ToolCallResultError": { +"description": "An error produced by the tool call.", +"id": "GoogleCloudDialogflowCxV3beta1ToolCallResultError", +"properties": { +"message": { +"description": "Optional. The error message of the function.", +"type": "string" +} +}, +"type": "object" +}, "GoogleCloudDialogflowCxV3beta1TransitionRoute": { "description": "A transition route specifies a intent that can be matched and/or a data condition that can be evaluated during a session. When a specified transition is matched, the following actions are taken in order: * If there is a `trigger_fulfillment` associated with the transition, it will be called. * If there is a `target_page` associated with the transition, the session will transition into the specified page. * If there is a `target_flow` associated with the transition, the session will transition into the specified flow.", "id": "GoogleCloudDialogflowCxV3beta1TransitionRoute", @@ -13510,6 +13637,10 @@ true ], "type": "string" }, +"knowledgeAssistFeedback": { +"$ref": "GoogleCloudDialogflowV2AgentAssistantFeedbackKnowledgeAssistFeedback", +"description": "Optional. Feedback for knowledge assist." +}, "knowledgeSearchFeedback": { "$ref": "GoogleCloudDialogflowV2AgentAssistantFeedbackKnowledgeSearchFeedback", "description": "Optional. Feedback for knowledge search." @@ -13521,6 +13652,24 @@ true }, "type": "object" }, +"GoogleCloudDialogflowV2AgentAssistantFeedbackKnowledgeAssistFeedback": { +"description": "Feedback for knowledge assist.", +"id": "GoogleCloudDialogflowV2AgentAssistantFeedbackKnowledgeAssistFeedback", +"properties": { +"answerCopied": { +"description": "Whether the suggested answer was copied by the human agent. If the value is set to be true, AnswerFeedback.clicked will be updated to be true.", +"type": "boolean" +}, +"clickedUris": { +"description": "The URIs clicked by the human agent. The value is appended for each UpdateAnswerRecordRequest. If the value is not empty, AnswerFeedback.clicked will be updated to be true.", +"items": { +"type": "string" +}, +"type": "array" +} +}, +"type": "object" +}, "GoogleCloudDialogflowV2AgentAssistantFeedbackKnowledgeSearchFeedback": { "description": "Feedback for knowledge search.", "id": "GoogleCloudDialogflowV2AgentAssistantFeedbackKnowledgeSearchFeedback", @@ -14089,14 +14238,16 @@ true "ARTICLE_SUGGESTION", "FAQ", "SMART_REPLY", -"KNOWLEDGE_SEARCH" +"KNOWLEDGE_SEARCH", +"KNOWLEDGE_ASSIST" ], "enumDescriptions": [ "Unspecified feature type.", "Run article suggestion model for chat.", "Run FAQ model for chat.", "Run smart reply model for chat.", -"Run knowledge search with text input from agent or text generated query." +"Run knowledge search with text input from agent or text generated query.", +"Run knowledge assist with automatic query generation." ], "type": "string" } @@ -14130,14 +14281,16 @@ true "ARTICLE_SUGGESTION", "FAQ", "SMART_REPLY", -"KNOWLEDGE_SEARCH" +"KNOWLEDGE_SEARCH", +"KNOWLEDGE_ASSIST" ], "enumDescriptions": [ "Unspecified feature type.", "Run article suggestion model for chat.", "Run FAQ model for chat.", "Run smart reply model for chat.", -"Run knowledge search with text input from agent or text generated query." +"Run knowledge search with text input from agent or text generated query.", +"Run knowledge assist with automatic query generation." ], "type": "string" } @@ -15599,6 +15752,10 @@ true "description": "Detail human agent assistant config.", "id": "GoogleCloudDialogflowV2HumanAgentAssistantConfigSuggestionConfig", "properties": { +"disableHighLatencyFeaturesSyncDelivery": { +"description": "Optional. When disable_high_latency_features_sync_delivery is true and using the AnalyzeContent API, we will not deliver the responses from high latency features in the API response. The human_agent_assistant_config.notification_config must be configured and enable_event_based_suggestion must be set to true to receive the responses from high latency features in Pub/Sub. High latency feature(s): KNOWLEDGE_ASSIST.", +"type": "boolean" +}, "featureConfigs": { "description": "Configuration of different suggestion features. One feature can have only one config.", "items": { @@ -15644,6 +15801,14 @@ true "description": "Automatically iterates all participants and tries to compile suggestions. Supported features: ARTICLE_SUGGESTION, FAQ, DIALOGFLOW_ASSIST, KNOWLEDGE_ASSIST.", "type": "boolean" }, +"enableQuerySuggestionOnly": { +"description": "Optional. Enable query suggestion only. Supported features: KNOWLEDGE_ASSIST", +"type": "boolean" +}, +"enableQuerySuggestionWhenNoAnswer": { +"description": "Optional. Enable query suggestion even if we can't find its answer. By default, queries are suggested only if we find its answer. Supported features: KNOWLEDGE_ASSIST", +"type": "boolean" +}, "queryConfig": { "$ref": "GoogleCloudDialogflowV2HumanAgentAssistantConfigSuggestionQueryConfig", "description": "Configs of query." @@ -17117,6 +17282,99 @@ true }, "type": "object" }, +"GoogleCloudDialogflowV2KnowledgeAssistAnswer": { +"description": "Represents a Knowledge Assist answer.", +"id": "GoogleCloudDialogflowV2KnowledgeAssistAnswer", +"properties": { +"answerRecord": { +"description": "The name of the answer record. Format: `projects//locations//answer Records/`.", +"type": "string" +}, +"suggestedQuery": { +"$ref": "GoogleCloudDialogflowV2KnowledgeAssistAnswerSuggestedQuery", +"description": "The query suggested based on the context. Suggestion is made only if it is different from the previous suggestion." +}, +"suggestedQueryAnswer": { +"$ref": "GoogleCloudDialogflowV2KnowledgeAssistAnswerKnowledgeAnswer", +"description": "The answer generated for the suggested query. Whether or not an answer is generated depends on how confident we are about the generated query." +} +}, +"type": "object" +}, +"GoogleCloudDialogflowV2KnowledgeAssistAnswerKnowledgeAnswer": { +"description": "Represents an answer from Knowledge. Currently supports FAQ and Generative answers.", +"id": "GoogleCloudDialogflowV2KnowledgeAssistAnswerKnowledgeAnswer", +"properties": { +"answerText": { +"description": "The piece of text from the `source` that answers this suggested query.", +"type": "string" +}, +"faqSource": { +"$ref": "GoogleCloudDialogflowV2KnowledgeAssistAnswerKnowledgeAnswerFaqSource", +"description": "Populated if the prediction came from FAQ." +}, +"generativeSource": { +"$ref": "GoogleCloudDialogflowV2KnowledgeAssistAnswerKnowledgeAnswerGenerativeSource", +"description": "Populated if the prediction was Generative." +} +}, +"type": "object" +}, +"GoogleCloudDialogflowV2KnowledgeAssistAnswerKnowledgeAnswerFaqSource": { +"description": "Details about source of FAQ answer.", +"id": "GoogleCloudDialogflowV2KnowledgeAssistAnswerKnowledgeAnswerFaqSource", +"properties": { +"question": { +"description": "The corresponding FAQ question.", +"type": "string" +} +}, +"type": "object" +}, +"GoogleCloudDialogflowV2KnowledgeAssistAnswerKnowledgeAnswerGenerativeSource": { +"description": "Details about source of Generative answer.", +"id": "GoogleCloudDialogflowV2KnowledgeAssistAnswerKnowledgeAnswerGenerativeSource", +"properties": { +"snippets": { +"description": "All snippets used for this Generative Prediction, with their source URI and data.", +"items": { +"$ref": "GoogleCloudDialogflowV2KnowledgeAssistAnswerKnowledgeAnswerGenerativeSourceSnippet" +}, +"type": "array" +} +}, +"type": "object" +}, +"GoogleCloudDialogflowV2KnowledgeAssistAnswerKnowledgeAnswerGenerativeSourceSnippet": { +"description": "Snippet Source for a Generative Prediction.", +"id": "GoogleCloudDialogflowV2KnowledgeAssistAnswerKnowledgeAnswerGenerativeSourceSnippet", +"properties": { +"text": { +"description": "Text taken from that URI.", +"type": "string" +}, +"title": { +"description": "Title of the document.", +"type": "string" +}, +"uri": { +"description": "URI the data is sourced from.", +"type": "string" +} +}, +"type": "object" +}, +"GoogleCloudDialogflowV2KnowledgeAssistAnswerSuggestedQuery": { +"description": "Represents a suggested query.", +"id": "GoogleCloudDialogflowV2KnowledgeAssistAnswerSuggestedQuery", +"properties": { +"queryText": { +"description": "Suggested query text.", +"type": "string" +} +}, +"type": "object" +}, "GoogleCloudDialogflowV2KnowledgeBase": { "description": "A knowledge base represents a collection of knowledge documents that you provide to Dialogflow. Your knowledge documents contain information that may be useful during conversations with end-users. Some Dialogflow features use knowledge bases when looking for a response to an end-user input. For more information, see the [knowledge base guide](https://cloud.google.com/dialogflow/docs/how/knowledge-bases). Note: The `projects.agent.knowledgeBases` resource is deprecated; only use `projects.knowledgeBases`.", "id": "GoogleCloudDialogflowV2KnowledgeBase", @@ -18175,14 +18433,16 @@ true "ARTICLE_SUGGESTION", "FAQ", "SMART_REPLY", -"KNOWLEDGE_SEARCH" +"KNOWLEDGE_SEARCH", +"KNOWLEDGE_ASSIST" ], "enumDescriptions": [ "Unspecified feature type.", "Run article suggestion model for chat.", "Run FAQ model for chat.", "Run smart reply model for chat.", -"Run knowledge search with text input from agent or text generated query." +"Run knowledge search with text input from agent or text generated query.", +"Run knowledge assist with automatic query generation." ], "type": "string" } @@ -18500,6 +18760,47 @@ true }, "type": "object" }, +"GoogleCloudDialogflowV2SuggestKnowledgeAssistRequest": { +"description": "The request message for Participants.SuggestKnowledgeAssist.", +"id": "GoogleCloudDialogflowV2SuggestKnowledgeAssistRequest", +"properties": { +"contextSize": { +"description": "Optional. Max number of messages prior to and including latest_message to use as context when compiling the suggestion. The context size is by default 100 and at most 100.", +"format": "int32", +"type": "integer" +}, +"latestMessage": { +"description": "Optional. The name of the latest conversation message to compile suggestions for. If empty, it will be the latest message of the conversation. Format: `projects//locations//conversations//messages/`.", +"type": "string" +}, +"previousSuggestedQuery": { +"description": "Optional. The previously suggested query for the given conversation. This helps identify whether the next suggestion we generate is resonably different from the previous one. This is useful to avoid similar suggestions within the conversation.", +"type": "string" +} +}, +"type": "object" +}, +"GoogleCloudDialogflowV2SuggestKnowledgeAssistResponse": { +"description": "The response message for Participants.SuggestKnowledgeAssist.", +"id": "GoogleCloudDialogflowV2SuggestKnowledgeAssistResponse", +"properties": { +"contextSize": { +"description": "Number of messages prior to and including latest_message to compile the suggestion. It may be smaller than the SuggestKnowledgeAssistRequest.context_size field in the request if there are fewer messages in the conversation.", +"format": "int32", +"type": "integer" +}, +"knowledgeAssistAnswer": { +"$ref": "GoogleCloudDialogflowV2KnowledgeAssistAnswer", +"description": "Output only. Knowledge Assist suggestion.", +"readOnly": true +}, +"latestMessage": { +"description": "The name of the latest conversation message used to compile suggestion for. Format: `projects//locations//conversations//messages/`.", +"type": "string" +} +}, +"type": "object" +}, "GoogleCloudDialogflowV2SuggestSmartRepliesRequest": { "description": "The request message for Participants.SuggestSmartReplies.", "id": "GoogleCloudDialogflowV2SuggestSmartRepliesRequest", @@ -18555,14 +18856,16 @@ true "ARTICLE_SUGGESTION", "FAQ", "SMART_REPLY", -"KNOWLEDGE_SEARCH" +"KNOWLEDGE_SEARCH", +"KNOWLEDGE_ASSIST" ], "enumDescriptions": [ "Unspecified feature type.", "Run article suggestion model for chat.", "Run FAQ model for chat.", "Run smart reply model for chat.", -"Run knowledge search with text input from agent or text generated query." +"Run knowledge search with text input from agent or text generated query.", +"Run knowledge assist with automatic query generation." ], "type": "string" } @@ -18596,6 +18899,10 @@ true "$ref": "GoogleCloudDialogflowV2SuggestFaqAnswersResponse", "description": "SuggestFaqAnswersResponse if request is for FAQ_ANSWER." }, +"suggestKnowledgeAssistResponse": { +"$ref": "GoogleCloudDialogflowV2SuggestKnowledgeAssistResponse", +"description": "SuggestKnowledgeAssistResponse if request is for KNOWLEDGE_ASSIST." +}, "suggestSmartRepliesResponse": { "$ref": "GoogleCloudDialogflowV2SuggestSmartRepliesResponse", "description": "SuggestSmartRepliesResponse if request is for SMART_REPLY." @@ -19144,7 +19451,8 @@ true "SMART_REPLY", "DIALOGFLOW_ASSIST", "CONVERSATION_SUMMARIZATION", -"KNOWLEDGE_SEARCH" +"KNOWLEDGE_SEARCH", +"KNOWLEDGE_ASSIST" ], "enumDescriptions": [ "Unspecified feature type.", @@ -19153,7 +19461,8 @@ true "Run smart reply model for chat.", "Run Dialogflow assist model for chat, which will return automated agent response as suggestion.", "Run conversation summarization model for chat.", -"Run knowledge search with text input from agent or text generated query." +"Run knowledge search with text input from agent or text generated query.", +"Run knowledge assist with automatic query generation." ], "type": "string" } @@ -20731,6 +21040,99 @@ true }, "type": "object" }, +"GoogleCloudDialogflowV2beta1KnowledgeAssistAnswer": { +"description": "Represents a Knowledge Assist answer.", +"id": "GoogleCloudDialogflowV2beta1KnowledgeAssistAnswer", +"properties": { +"answerRecord": { +"description": "The name of the answer record. Format: `projects//locations//answer Records/`.", +"type": "string" +}, +"suggestedQuery": { +"$ref": "GoogleCloudDialogflowV2beta1KnowledgeAssistAnswerSuggestedQuery", +"description": "The query suggested based on the context. Suggestion is made only if it is different from the previous suggestion." +}, +"suggestedQueryAnswer": { +"$ref": "GoogleCloudDialogflowV2beta1KnowledgeAssistAnswerKnowledgeAnswer", +"description": "The answer generated for the suggested query. Whether or not an answer is generated depends on how confident we are about the generated query." +} +}, +"type": "object" +}, +"GoogleCloudDialogflowV2beta1KnowledgeAssistAnswerKnowledgeAnswer": { +"description": "Represents an answer from Knowledge. Currently supports FAQ and Generative answers.", +"id": "GoogleCloudDialogflowV2beta1KnowledgeAssistAnswerKnowledgeAnswer", +"properties": { +"answerText": { +"description": "The piece of text from the `source` that answers this suggested query.", +"type": "string" +}, +"faqSource": { +"$ref": "GoogleCloudDialogflowV2beta1KnowledgeAssistAnswerKnowledgeAnswerFaqSource", +"description": "Populated if the prediction came from FAQ." +}, +"generativeSource": { +"$ref": "GoogleCloudDialogflowV2beta1KnowledgeAssistAnswerKnowledgeAnswerGenerativeSource", +"description": "Populated if the prediction was Generative." +} +}, +"type": "object" +}, +"GoogleCloudDialogflowV2beta1KnowledgeAssistAnswerKnowledgeAnswerFaqSource": { +"description": "Details about source of FAQ answer.", +"id": "GoogleCloudDialogflowV2beta1KnowledgeAssistAnswerKnowledgeAnswerFaqSource", +"properties": { +"question": { +"description": "The corresponding FAQ question.", +"type": "string" +} +}, +"type": "object" +}, +"GoogleCloudDialogflowV2beta1KnowledgeAssistAnswerKnowledgeAnswerGenerativeSource": { +"description": "Details about source of Generative answer.", +"id": "GoogleCloudDialogflowV2beta1KnowledgeAssistAnswerKnowledgeAnswerGenerativeSource", +"properties": { +"snippets": { +"description": "All snippets used for this Generative Prediction, with their source URI and data.", +"items": { +"$ref": "GoogleCloudDialogflowV2beta1KnowledgeAssistAnswerKnowledgeAnswerGenerativeSourceSnippet" +}, +"type": "array" +} +}, +"type": "object" +}, +"GoogleCloudDialogflowV2beta1KnowledgeAssistAnswerKnowledgeAnswerGenerativeSourceSnippet": { +"description": "Snippet Source for a Generative Prediction.", +"id": "GoogleCloudDialogflowV2beta1KnowledgeAssistAnswerKnowledgeAnswerGenerativeSourceSnippet", +"properties": { +"text": { +"description": "Text taken from that URI.", +"type": "string" +}, +"title": { +"description": "Title of the document.", +"type": "string" +}, +"uri": { +"description": "URI the data is sourced from.", +"type": "string" +} +}, +"type": "object" +}, +"GoogleCloudDialogflowV2beta1KnowledgeAssistAnswerSuggestedQuery": { +"description": "Represents a suggested query.", +"id": "GoogleCloudDialogflowV2beta1KnowledgeAssistAnswerSuggestedQuery", +"properties": { +"queryText": { +"description": "Suggested query text.", +"type": "string" +} +}, +"type": "object" +}, "GoogleCloudDialogflowV2beta1KnowledgeOperationMetadata": { "description": "Metadata in google::longrunning::Operation for Knowledge operations.", "id": "GoogleCloudDialogflowV2beta1KnowledgeOperationMetadata", @@ -21059,7 +21461,8 @@ true "SMART_REPLY", "DIALOGFLOW_ASSIST", "CONVERSATION_SUMMARIZATION", -"KNOWLEDGE_SEARCH" +"KNOWLEDGE_SEARCH", +"KNOWLEDGE_ASSIST" ], "enumDescriptions": [ "Unspecified feature type.", @@ -21068,7 +21471,8 @@ true "Run smart reply model for chat.", "Run Dialogflow assist model for chat, which will return automated agent response as suggestion.", "Run conversation summarization model for chat.", -"Run knowledge search with text input from agent or text generated query." +"Run knowledge search with text input from agent or text generated query.", +"Run knowledge assist with automatic query generation." ], "type": "string" } @@ -21164,6 +21568,27 @@ true }, "type": "object" }, +"GoogleCloudDialogflowV2beta1SuggestKnowledgeAssistResponse": { +"description": "The response message for Participants.SuggestKnowledgeAssist.", +"id": "GoogleCloudDialogflowV2beta1SuggestKnowledgeAssistResponse", +"properties": { +"contextSize": { +"description": "Number of messages prior to and including latest_message to compile the suggestion. It may be smaller than the SuggestKnowledgeAssistRequest.context_size field in the request if there are fewer messages in the conversation.", +"format": "int32", +"type": "integer" +}, +"knowledgeAssistAnswer": { +"$ref": "GoogleCloudDialogflowV2beta1KnowledgeAssistAnswer", +"description": "Output only. Knowledge Assist suggestion.", +"readOnly": true +}, +"latestMessage": { +"description": "The name of the latest conversation message used to compile suggestion for. Format: `projects//locations//conversations//messages/`.", +"type": "string" +} +}, +"type": "object" +}, "GoogleCloudDialogflowV2beta1SuggestSmartRepliesResponse": { "description": "The response message for Participants.SuggestSmartReplies.", "id": "GoogleCloudDialogflowV2beta1SuggestSmartRepliesResponse", @@ -21211,6 +21636,10 @@ true "$ref": "GoogleCloudDialogflowV2beta1SuggestFaqAnswersResponse", "description": "SuggestFaqAnswersResponse if request is for FAQ_ANSWER." }, +"suggestKnowledgeAssistResponse": { +"$ref": "GoogleCloudDialogflowV2beta1SuggestKnowledgeAssistResponse", +"description": "SuggestKnowledgeAssistResponse if request is for KNOWLEDGE_ASSIST." +}, "suggestSmartRepliesResponse": { "$ref": "GoogleCloudDialogflowV2beta1SuggestSmartRepliesResponse", "description": "SuggestSmartRepliesResponse if request is for SMART_REPLY." diff --git a/googleapiclient/discovery_cache/documents/dialogflow.v2beta1.json b/googleapiclient/discovery_cache/documents/dialogflow.v2beta1.json index 75f402d6920..93a68d67514 100644 --- a/googleapiclient/discovery_cache/documents/dialogflow.v2beta1.json +++ b/googleapiclient/discovery_cache/documents/dialogflow.v2beta1.json @@ -3433,6 +3433,35 @@ "https://www.googleapis.com/auth/dialogflow" ] }, +"suggestKnowledgeAssist": { +"description": "Gets knowledge assist suggestions based on historical messages.", +"flatPath": "v2beta1/projects/{projectsId}/conversations/{conversationsId}/participants/{participantsId}/suggestions:suggestKnowledgeAssist", +"httpMethod": "POST", +"id": "dialogflow.projects.conversations.participants.suggestions.suggestKnowledgeAssist", +"parameterOrder": [ +"parent" +], +"parameters": { +"parent": { +"description": "Required. The name of the participant to fetch suggestions for. Format: `projects//locations//conversations//participants/`.", +"location": "path", +"pattern": "^projects/[^/]+/conversations/[^/]+/participants/[^/]+$", +"required": true, +"type": "string" +} +}, +"path": "v2beta1/{+parent}/suggestions:suggestKnowledgeAssist", +"request": { +"$ref": "GoogleCloudDialogflowV2beta1SuggestKnowledgeAssistRequest" +}, +"response": { +"$ref": "GoogleCloudDialogflowV2beta1SuggestKnowledgeAssistResponse" +}, +"scopes": [ +"https://www.googleapis.com/auth/cloud-platform", +"https://www.googleapis.com/auth/dialogflow" +] +}, "suggestSmartReplies": { "description": "Gets smart replies for a participant based on specific historical messages.", "flatPath": "v2beta1/projects/{projectsId}/conversations/{conversationsId}/participants/{participantsId}/suggestions:suggestSmartReplies", @@ -6954,6 +6983,35 @@ "https://www.googleapis.com/auth/dialogflow" ] }, +"suggestKnowledgeAssist": { +"description": "Gets knowledge assist suggestions based on historical messages.", +"flatPath": "v2beta1/projects/{projectsId}/locations/{locationsId}/conversations/{conversationsId}/participants/{participantsId}/suggestions:suggestKnowledgeAssist", +"httpMethod": "POST", +"id": "dialogflow.projects.locations.conversations.participants.suggestions.suggestKnowledgeAssist", +"parameterOrder": [ +"parent" +], +"parameters": { +"parent": { +"description": "Required. The name of the participant to fetch suggestions for. Format: `projects//locations//conversations//participants/`.", +"location": "path", +"pattern": "^projects/[^/]+/locations/[^/]+/conversations/[^/]+/participants/[^/]+$", +"required": true, +"type": "string" +} +}, +"path": "v2beta1/{+parent}/suggestions:suggestKnowledgeAssist", +"request": { +"$ref": "GoogleCloudDialogflowV2beta1SuggestKnowledgeAssistRequest" +}, +"response": { +"$ref": "GoogleCloudDialogflowV2beta1SuggestKnowledgeAssistResponse" +}, +"scopes": [ +"https://www.googleapis.com/auth/cloud-platform", +"https://www.googleapis.com/auth/dialogflow" +] +}, "suggestSmartReplies": { "description": "Gets smart replies for a participant based on specific historical messages.", "flatPath": "v2beta1/projects/{projectsId}/locations/{locationsId}/conversations/{conversationsId}/participants/{participantsId}/suggestions:suggestSmartReplies", @@ -7965,7 +8023,7 @@ } } }, -"revision": "20240523", +"revision": "20240605", "rootUrl": "https://dialogflow.googleapis.com/", "schemas": { "GoogleCloudDialogflowCxV3AdvancedSettings": { @@ -8026,11 +8084,11 @@ "id": "GoogleCloudDialogflowCxV3AdvancedSettingsLoggingSettings", "properties": { "enableInteractionLogging": { -"description": "If true, DF Interaction logging is currently enabled.", +"description": "Enables DF Interaction logging.", "type": "boolean" }, "enableStackdriverLogging": { -"description": "If true, StackDriver logging is currently enabled.", +"description": "Enables StackDriver logging.", "type": "boolean" } }, @@ -10416,11 +10474,11 @@ "id": "GoogleCloudDialogflowCxV3beta1AdvancedSettingsLoggingSettings", "properties": { "enableInteractionLogging": { -"description": "If true, DF Interaction logging is currently enabled.", +"description": "Enables DF Interaction logging.", "type": "boolean" }, "enableStackdriverLogging": { -"description": "If true, StackDriver logging is currently enabled.", +"description": "Enables StackDriver logging.", "type": "boolean" } }, @@ -11773,6 +11831,10 @@ "text": { "$ref": "GoogleCloudDialogflowCxV3beta1TextInput", "description": "The natural language text to be processed." +}, +"toolCallResult": { +"$ref": "GoogleCloudDialogflowCxV3beta1ToolCallResult", +"description": "The results of a tool executed by the client." } }, "type": "object" @@ -11841,6 +11903,10 @@ "text": { "$ref": "GoogleCloudDialogflowCxV3beta1ResponseMessageText", "description": "Returns a text response." +}, +"toolCall": { +"$ref": "GoogleCloudDialogflowCxV3beta1ToolCall", +"description": "Returns the definition of a tool call that should be executed by the client." } }, "type": "object" @@ -12235,6 +12301,67 @@ }, "type": "object" }, +"GoogleCloudDialogflowCxV3beta1ToolCall": { +"description": "Represents a call of a specific tool's action with the specified inputs.", +"id": "GoogleCloudDialogflowCxV3beta1ToolCall", +"properties": { +"action": { +"description": "Required. The name of the tool's action associated with this call.", +"type": "string" +}, +"inputParameters": { +"additionalProperties": { +"description": "Properties of the object.", +"type": "any" +}, +"description": "Optional. The action's input parameters.", +"type": "object" +}, +"tool": { +"description": "Required. The tool associated with this call. Format: `projects//locations//agents//tools/`.", +"type": "string" +} +}, +"type": "object" +}, +"GoogleCloudDialogflowCxV3beta1ToolCallResult": { +"description": "The result of calling a tool's action that has been executed by the client.", +"id": "GoogleCloudDialogflowCxV3beta1ToolCallResult", +"properties": { +"action": { +"description": "Required. The name of the tool's action associated with this call.", +"type": "string" +}, +"error": { +"$ref": "GoogleCloudDialogflowCxV3beta1ToolCallResultError", +"description": "The tool call's error." +}, +"outputParameters": { +"additionalProperties": { +"description": "Properties of the object.", +"type": "any" +}, +"description": "The tool call's output parameters.", +"type": "object" +}, +"tool": { +"description": "Required. The tool associated with this call. Format: `projects//locations//agents//tools/`.", +"type": "string" +} +}, +"type": "object" +}, +"GoogleCloudDialogflowCxV3beta1ToolCallResultError": { +"description": "An error produced by the tool call.", +"id": "GoogleCloudDialogflowCxV3beta1ToolCallResultError", +"properties": { +"message": { +"description": "Optional. The error message of the function.", +"type": "string" +} +}, +"type": "object" +}, "GoogleCloudDialogflowCxV3beta1TransitionRoute": { "description": "A transition route specifies a intent that can be matched and/or a data condition that can be evaluated during a session. When a specified transition is matched, the following actions are taken in order: * If there is a `trigger_fulfillment` associated with the transition, it will be called. * If there is a `target_page` associated with the transition, the session will transition into the specified page. * If there is a `target_flow` associated with the transition, the session will transition into the specified flow.", "id": "GoogleCloudDialogflowCxV3beta1TransitionRoute", @@ -12874,14 +13001,16 @@ "ARTICLE_SUGGESTION", "FAQ", "SMART_REPLY", -"KNOWLEDGE_SEARCH" +"KNOWLEDGE_SEARCH", +"KNOWLEDGE_ASSIST" ], "enumDescriptions": [ "Unspecified feature type.", "Run article suggestion model for chat.", "Run FAQ model for chat.", "Run smart reply model for chat.", -"Run knowledge search with text input from agent or text generated query." +"Run knowledge search with text input from agent or text generated query.", +"Run knowledge assist with automatic query generation." ], "type": "string" } @@ -14314,6 +14443,99 @@ true }, "type": "object" }, +"GoogleCloudDialogflowV2KnowledgeAssistAnswer": { +"description": "Represents a Knowledge Assist answer.", +"id": "GoogleCloudDialogflowV2KnowledgeAssistAnswer", +"properties": { +"answerRecord": { +"description": "The name of the answer record. Format: `projects//locations//answer Records/`.", +"type": "string" +}, +"suggestedQuery": { +"$ref": "GoogleCloudDialogflowV2KnowledgeAssistAnswerSuggestedQuery", +"description": "The query suggested based on the context. Suggestion is made only if it is different from the previous suggestion." +}, +"suggestedQueryAnswer": { +"$ref": "GoogleCloudDialogflowV2KnowledgeAssistAnswerKnowledgeAnswer", +"description": "The answer generated for the suggested query. Whether or not an answer is generated depends on how confident we are about the generated query." +} +}, +"type": "object" +}, +"GoogleCloudDialogflowV2KnowledgeAssistAnswerKnowledgeAnswer": { +"description": "Represents an answer from Knowledge. Currently supports FAQ and Generative answers.", +"id": "GoogleCloudDialogflowV2KnowledgeAssistAnswerKnowledgeAnswer", +"properties": { +"answerText": { +"description": "The piece of text from the `source` that answers this suggested query.", +"type": "string" +}, +"faqSource": { +"$ref": "GoogleCloudDialogflowV2KnowledgeAssistAnswerKnowledgeAnswerFaqSource", +"description": "Populated if the prediction came from FAQ." +}, +"generativeSource": { +"$ref": "GoogleCloudDialogflowV2KnowledgeAssistAnswerKnowledgeAnswerGenerativeSource", +"description": "Populated if the prediction was Generative." +} +}, +"type": "object" +}, +"GoogleCloudDialogflowV2KnowledgeAssistAnswerKnowledgeAnswerFaqSource": { +"description": "Details about source of FAQ answer.", +"id": "GoogleCloudDialogflowV2KnowledgeAssistAnswerKnowledgeAnswerFaqSource", +"properties": { +"question": { +"description": "The corresponding FAQ question.", +"type": "string" +} +}, +"type": "object" +}, +"GoogleCloudDialogflowV2KnowledgeAssistAnswerKnowledgeAnswerGenerativeSource": { +"description": "Details about source of Generative answer.", +"id": "GoogleCloudDialogflowV2KnowledgeAssistAnswerKnowledgeAnswerGenerativeSource", +"properties": { +"snippets": { +"description": "All snippets used for this Generative Prediction, with their source URI and data.", +"items": { +"$ref": "GoogleCloudDialogflowV2KnowledgeAssistAnswerKnowledgeAnswerGenerativeSourceSnippet" +}, +"type": "array" +} +}, +"type": "object" +}, +"GoogleCloudDialogflowV2KnowledgeAssistAnswerKnowledgeAnswerGenerativeSourceSnippet": { +"description": "Snippet Source for a Generative Prediction.", +"id": "GoogleCloudDialogflowV2KnowledgeAssistAnswerKnowledgeAnswerGenerativeSourceSnippet", +"properties": { +"text": { +"description": "Text taken from that URI.", +"type": "string" +}, +"title": { +"description": "Title of the document.", +"type": "string" +}, +"uri": { +"description": "URI the data is sourced from.", +"type": "string" +} +}, +"type": "object" +}, +"GoogleCloudDialogflowV2KnowledgeAssistAnswerSuggestedQuery": { +"description": "Represents a suggested query.", +"id": "GoogleCloudDialogflowV2KnowledgeAssistAnswerSuggestedQuery", +"properties": { +"queryText": { +"description": "Suggested query text.", +"type": "string" +} +}, +"type": "object" +}, "GoogleCloudDialogflowV2KnowledgeOperationMetadata": { "description": "Metadata in google::longrunning::Operation for Knowledge operations.", "id": "GoogleCloudDialogflowV2KnowledgeOperationMetadata", @@ -14636,14 +14858,16 @@ true "ARTICLE_SUGGESTION", "FAQ", "SMART_REPLY", -"KNOWLEDGE_SEARCH" +"KNOWLEDGE_SEARCH", +"KNOWLEDGE_ASSIST" ], "enumDescriptions": [ "Unspecified feature type.", "Run article suggestion model for chat.", "Run FAQ model for chat.", "Run smart reply model for chat.", -"Run knowledge search with text input from agent or text generated query." +"Run knowledge search with text input from agent or text generated query.", +"Run knowledge assist with automatic query generation." ], "type": "string" } @@ -14737,6 +14961,27 @@ true }, "type": "object" }, +"GoogleCloudDialogflowV2SuggestKnowledgeAssistResponse": { +"description": "The response message for Participants.SuggestKnowledgeAssist.", +"id": "GoogleCloudDialogflowV2SuggestKnowledgeAssistResponse", +"properties": { +"contextSize": { +"description": "Number of messages prior to and including latest_message to compile the suggestion. It may be smaller than the SuggestKnowledgeAssistRequest.context_size field in the request if there are fewer messages in the conversation.", +"format": "int32", +"type": "integer" +}, +"knowledgeAssistAnswer": { +"$ref": "GoogleCloudDialogflowV2KnowledgeAssistAnswer", +"description": "Output only. Knowledge Assist suggestion.", +"readOnly": true +}, +"latestMessage": { +"description": "The name of the latest conversation message used to compile suggestion for. Format: `projects//locations//conversations//messages/`.", +"type": "string" +} +}, +"type": "object" +}, "GoogleCloudDialogflowV2SuggestSmartRepliesResponse": { "description": "The response message for Participants.SuggestSmartReplies.", "id": "GoogleCloudDialogflowV2SuggestSmartRepliesResponse", @@ -14777,6 +15022,10 @@ true "$ref": "GoogleCloudDialogflowV2SuggestFaqAnswersResponse", "description": "SuggestFaqAnswersResponse if request is for FAQ_ANSWER." }, +"suggestKnowledgeAssistResponse": { +"$ref": "GoogleCloudDialogflowV2SuggestKnowledgeAssistResponse", +"description": "SuggestKnowledgeAssistResponse if request is for KNOWLEDGE_ASSIST." +}, "suggestSmartRepliesResponse": { "$ref": "GoogleCloudDialogflowV2SuggestSmartRepliesResponse", "description": "SuggestSmartRepliesResponse if request is for SMART_REPLY." @@ -15017,6 +15266,10 @@ true ], "type": "string" }, +"knowledgeAssistFeedback": { +"$ref": "GoogleCloudDialogflowV2beta1AgentAssistantFeedbackKnowledgeAssistFeedback", +"description": "Optional. Feedback for knowledge assist." +}, "knowledgeSearchFeedback": { "$ref": "GoogleCloudDialogflowV2beta1AgentAssistantFeedbackKnowledgeSearchFeedback", "description": "Optional. Feedback for knowledge search." @@ -15028,6 +15281,24 @@ true }, "type": "object" }, +"GoogleCloudDialogflowV2beta1AgentAssistantFeedbackKnowledgeAssistFeedback": { +"description": "Feedback for knowledge assist.", +"id": "GoogleCloudDialogflowV2beta1AgentAssistantFeedbackKnowledgeAssistFeedback", +"properties": { +"answerCopied": { +"description": "Whether the suggested answer was copied by the human agent. If the value is set to be true, AnswerFeedback.clicked will be updated to be true.", +"type": "boolean" +}, +"clickedUris": { +"description": "The URIs clicked by the human agent. The value is appended for each UpdateAnswerRecordRequest. If the value is not empty, AnswerFeedback.clicked will be updated to be true.", +"items": { +"type": "string" +}, +"type": "array" +} +}, +"type": "object" +}, "GoogleCloudDialogflowV2beta1AgentAssistantFeedbackKnowledgeSearchFeedback": { "description": "Feedback for knowledge search.", "id": "GoogleCloudDialogflowV2beta1AgentAssistantFeedbackKnowledgeSearchFeedback", @@ -15381,6 +15652,11 @@ true ], "type": "string" }, +"callCompanionAuthCode": { +"description": "The auth code for accessing Call Companion UI.", +"format": "byte", +"type": "string" +}, "cxCurrentPage": { "description": "The unique identifier of the current Dialogflow CX conversation page. Format: `projects//locations//agents//flows//pages/`.", "type": "string" @@ -15687,7 +15963,8 @@ true "SMART_REPLY", "DIALOGFLOW_ASSIST", "CONVERSATION_SUMMARIZATION", -"KNOWLEDGE_SEARCH" +"KNOWLEDGE_SEARCH", +"KNOWLEDGE_ASSIST" ], "enumDescriptions": [ "Unspecified feature type.", @@ -15696,7 +15973,8 @@ true "Run smart reply model for chat.", "Run Dialogflow assist model for chat, which will return automated agent response as suggestion.", "Run conversation summarization model for chat.", -"Run knowledge search with text input from agent or text generated query." +"Run knowledge search with text input from agent or text generated query.", +"Run knowledge assist with automatic query generation." ], "type": "string" } @@ -15732,7 +16010,8 @@ true "SMART_REPLY", "DIALOGFLOW_ASSIST", "CONVERSATION_SUMMARIZATION", -"KNOWLEDGE_SEARCH" +"KNOWLEDGE_SEARCH", +"KNOWLEDGE_ASSIST" ], "enumDescriptions": [ "Unspecified feature type.", @@ -15741,7 +16020,8 @@ true "Run smart reply model for chat.", "Run Dialogflow assist model for chat, which will return automated agent response as suggestion.", "Run conversation summarization model for chat.", -"Run knowledge search with text input from agent or text generated query." +"Run knowledge search with text input from agent or text generated query.", +"Run knowledge assist with automatic query generation." ], "type": "string" } @@ -16909,6 +17189,10 @@ true "description": "Detail human agent assistant config.", "id": "GoogleCloudDialogflowV2beta1HumanAgentAssistantConfigSuggestionConfig", "properties": { +"disableHighLatencyFeaturesSyncDelivery": { +"description": "Optional. When disable_high_latency_features_sync_delivery is true and using the AnalyzeContent API, we will not deliver the responses from high latency features in the API response. The human_agent_assistant_config.notification_config must be configured and enable_event_based_suggestion must be set to true to receive the responses from high latency features in Pub/Sub. High latency feature(s): KNOWLEDGE_ASSIST.", +"type": "boolean" +}, "featureConfigs": { "description": "Configuration of different suggestion features. One feature can have only one config.", "items": { @@ -16954,6 +17238,14 @@ true "description": "Automatically iterates all participants and tries to compile suggestions. Supported features: ARTICLE_SUGGESTION, FAQ, DIALOGFLOW_ASSIST, ENTITY_EXTRACTION, KNOWLEDGE_ASSIST.", "type": "boolean" }, +"enableQuerySuggestionOnly": { +"description": "Optional. Enable query suggestion only. Supported features: KNOWLEDGE_ASSIST", +"type": "boolean" +}, +"enableQuerySuggestionWhenNoAnswer": { +"description": "Optional. Enable query suggestion even if we can't find its answer. By default, queries are suggested only if we find its answer. Supported features: KNOWLEDGE_ASSIST", +"type": "boolean" +}, "queryConfig": { "$ref": "GoogleCloudDialogflowV2beta1HumanAgentAssistantConfigSuggestionQueryConfig", "description": "Configs of query." @@ -18732,6 +19024,99 @@ true }, "type": "object" }, +"GoogleCloudDialogflowV2beta1KnowledgeAssistAnswer": { +"description": "Represents a Knowledge Assist answer.", +"id": "GoogleCloudDialogflowV2beta1KnowledgeAssistAnswer", +"properties": { +"answerRecord": { +"description": "The name of the answer record. Format: `projects//locations//answer Records/`.", +"type": "string" +}, +"suggestedQuery": { +"$ref": "GoogleCloudDialogflowV2beta1KnowledgeAssistAnswerSuggestedQuery", +"description": "The query suggested based on the context. Suggestion is made only if it is different from the previous suggestion." +}, +"suggestedQueryAnswer": { +"$ref": "GoogleCloudDialogflowV2beta1KnowledgeAssistAnswerKnowledgeAnswer", +"description": "The answer generated for the suggested query. Whether or not an answer is generated depends on how confident we are about the generated query." +} +}, +"type": "object" +}, +"GoogleCloudDialogflowV2beta1KnowledgeAssistAnswerKnowledgeAnswer": { +"description": "Represents an answer from Knowledge. Currently supports FAQ and Generative answers.", +"id": "GoogleCloudDialogflowV2beta1KnowledgeAssistAnswerKnowledgeAnswer", +"properties": { +"answerText": { +"description": "The piece of text from the `source` that answers this suggested query.", +"type": "string" +}, +"faqSource": { +"$ref": "GoogleCloudDialogflowV2beta1KnowledgeAssistAnswerKnowledgeAnswerFaqSource", +"description": "Populated if the prediction came from FAQ." +}, +"generativeSource": { +"$ref": "GoogleCloudDialogflowV2beta1KnowledgeAssistAnswerKnowledgeAnswerGenerativeSource", +"description": "Populated if the prediction was Generative." +} +}, +"type": "object" +}, +"GoogleCloudDialogflowV2beta1KnowledgeAssistAnswerKnowledgeAnswerFaqSource": { +"description": "Details about source of FAQ answer.", +"id": "GoogleCloudDialogflowV2beta1KnowledgeAssistAnswerKnowledgeAnswerFaqSource", +"properties": { +"question": { +"description": "The corresponding FAQ question.", +"type": "string" +} +}, +"type": "object" +}, +"GoogleCloudDialogflowV2beta1KnowledgeAssistAnswerKnowledgeAnswerGenerativeSource": { +"description": "Details about source of Generative answer.", +"id": "GoogleCloudDialogflowV2beta1KnowledgeAssistAnswerKnowledgeAnswerGenerativeSource", +"properties": { +"snippets": { +"description": "All snippets used for this Generative Prediction, with their source URI and data.", +"items": { +"$ref": "GoogleCloudDialogflowV2beta1KnowledgeAssistAnswerKnowledgeAnswerGenerativeSourceSnippet" +}, +"type": "array" +} +}, +"type": "object" +}, +"GoogleCloudDialogflowV2beta1KnowledgeAssistAnswerKnowledgeAnswerGenerativeSourceSnippet": { +"description": "Snippet Source for a Generative Prediction.", +"id": "GoogleCloudDialogflowV2beta1KnowledgeAssistAnswerKnowledgeAnswerGenerativeSourceSnippet", +"properties": { +"text": { +"description": "Text taken from that URI.", +"type": "string" +}, +"title": { +"description": "Title of the document.", +"type": "string" +}, +"uri": { +"description": "URI the data is sourced from.", +"type": "string" +} +}, +"type": "object" +}, +"GoogleCloudDialogflowV2beta1KnowledgeAssistAnswerSuggestedQuery": { +"description": "Represents a suggested query.", +"id": "GoogleCloudDialogflowV2beta1KnowledgeAssistAnswerSuggestedQuery", +"properties": { +"queryText": { +"description": "Suggested query text.", +"type": "string" +} +}, +"type": "object" +}, "GoogleCloudDialogflowV2beta1KnowledgeBase": { "description": "A knowledge base represents a collection of knowledge documents that you provide to Dialogflow. Your knowledge documents contain information that may be useful during conversations with end-users. Some Dialogflow features use knowledge bases when looking for a response to an end-user input. For more information, see the [knowledge base guide](https://cloud.google.com/dialogflow/docs/how/knowledge-bases). Note: The `projects.agent.knowledgeBases` resource is deprecated; only use `projects.knowledgeBases`.", "id": "GoogleCloudDialogflowV2beta1KnowledgeBase", @@ -19890,7 +20275,8 @@ true "SMART_REPLY", "DIALOGFLOW_ASSIST", "CONVERSATION_SUMMARIZATION", -"KNOWLEDGE_SEARCH" +"KNOWLEDGE_SEARCH", +"KNOWLEDGE_ASSIST" ], "enumDescriptions": [ "Unspecified feature type.", @@ -19899,7 +20285,8 @@ true "Run smart reply model for chat.", "Run Dialogflow assist model for chat, which will return automated agent response as suggestion.", "Run conversation summarization model for chat.", -"Run knowledge search with text input from agent or text generated query." +"Run knowledge search with text input from agent or text generated query.", +"Run knowledge assist with automatic query generation." ], "type": "string" } @@ -20193,6 +20580,47 @@ true }, "type": "object" }, +"GoogleCloudDialogflowV2beta1SuggestKnowledgeAssistRequest": { +"description": "The request message for Participants.SuggestKnowledgeAssist.", +"id": "GoogleCloudDialogflowV2beta1SuggestKnowledgeAssistRequest", +"properties": { +"contextSize": { +"description": "Optional. Max number of messages prior to and including latest_message to use as context when compiling the suggestion. The context size is by default 100 and at most 100.", +"format": "int32", +"type": "integer" +}, +"latestMessage": { +"description": "Optional. The name of the latest conversation message to compile suggestions for. If empty, it will be the latest message of the conversation. Format: `projects//locations//conversations//messages/`.", +"type": "string" +}, +"previousSuggestedQuery": { +"description": "Optional. The previously suggested query for the given conversation. This helps identify whether the next suggestion we generate is resonably different from the previous one. This is useful to avoid similar suggestions within the conversation.", +"type": "string" +} +}, +"type": "object" +}, +"GoogleCloudDialogflowV2beta1SuggestKnowledgeAssistResponse": { +"description": "The response message for Participants.SuggestKnowledgeAssist.", +"id": "GoogleCloudDialogflowV2beta1SuggestKnowledgeAssistResponse", +"properties": { +"contextSize": { +"description": "Number of messages prior to and including latest_message to compile the suggestion. It may be smaller than the SuggestKnowledgeAssistRequest.context_size field in the request if there are fewer messages in the conversation.", +"format": "int32", +"type": "integer" +}, +"knowledgeAssistAnswer": { +"$ref": "GoogleCloudDialogflowV2beta1KnowledgeAssistAnswer", +"description": "Output only. Knowledge Assist suggestion.", +"readOnly": true +}, +"latestMessage": { +"description": "The name of the latest conversation message used to compile suggestion for. Format: `projects//locations//conversations//messages/`.", +"type": "string" +} +}, +"type": "object" +}, "GoogleCloudDialogflowV2beta1SuggestSmartRepliesRequest": { "description": "The request message for Participants.SuggestSmartReplies.", "id": "GoogleCloudDialogflowV2beta1SuggestSmartRepliesRequest", @@ -20352,7 +20780,8 @@ true "SMART_REPLY", "DIALOGFLOW_ASSIST", "CONVERSATION_SUMMARIZATION", -"KNOWLEDGE_SEARCH" +"KNOWLEDGE_SEARCH", +"KNOWLEDGE_ASSIST" ], "enumDescriptions": [ "Unspecified feature type.", @@ -20361,7 +20790,8 @@ true "Run smart reply model for chat.", "Run Dialogflow assist model for chat, which will return automated agent response as suggestion.", "Run conversation summarization model for chat.", -"Run knowledge search with text input from agent or text generated query." +"Run knowledge search with text input from agent or text generated query.", +"Run knowledge assist with automatic query generation." ], "type": "string" } @@ -20419,6 +20849,10 @@ true "$ref": "GoogleCloudDialogflowV2beta1SuggestFaqAnswersResponse", "description": "SuggestFaqAnswersResponse if request is for FAQ_ANSWER." }, +"suggestKnowledgeAssistResponse": { +"$ref": "GoogleCloudDialogflowV2beta1SuggestKnowledgeAssistResponse", +"description": "SuggestKnowledgeAssistResponse if request is for KNOWLEDGE_ASSIST." +}, "suggestSmartRepliesResponse": { "$ref": "GoogleCloudDialogflowV2beta1SuggestSmartRepliesResponse", "description": "SuggestSmartRepliesResponse if request is for SMART_REPLY." diff --git a/googleapiclient/discovery_cache/documents/dialogflow.v3.json b/googleapiclient/discovery_cache/documents/dialogflow.v3.json index 3b01711e641..546810ae623 100644 --- a/googleapiclient/discovery_cache/documents/dialogflow.v3.json +++ b/googleapiclient/discovery_cache/documents/dialogflow.v3.json @@ -4453,7 +4453,7 @@ } } }, -"revision": "20240523", +"revision": "20240605", "rootUrl": "https://dialogflow.googleapis.com/", "schemas": { "GoogleCloudDialogflowCxV3AdvancedSettings": { @@ -4514,11 +4514,11 @@ "id": "GoogleCloudDialogflowCxV3AdvancedSettingsLoggingSettings", "properties": { "enableInteractionLogging": { -"description": "If true, DF Interaction logging is currently enabled.", +"description": "Enables DF Interaction logging.", "type": "boolean" }, "enableStackdriverLogging": { -"description": "If true, StackDriver logging is currently enabled.", +"description": "Enables StackDriver logging.", "type": "boolean" } }, @@ -10261,11 +10261,11 @@ false "id": "GoogleCloudDialogflowCxV3beta1AdvancedSettingsLoggingSettings", "properties": { "enableInteractionLogging": { -"description": "If true, DF Interaction logging is currently enabled.", +"description": "Enables DF Interaction logging.", "type": "boolean" }, "enableStackdriverLogging": { -"description": "If true, StackDriver logging is currently enabled.", +"description": "Enables StackDriver logging.", "type": "boolean" } }, @@ -11618,6 +11618,10 @@ false "text": { "$ref": "GoogleCloudDialogflowCxV3beta1TextInput", "description": "The natural language text to be processed." +}, +"toolCallResult": { +"$ref": "GoogleCloudDialogflowCxV3beta1ToolCallResult", +"description": "The results of a tool executed by the client." } }, "type": "object" @@ -11686,6 +11690,10 @@ false "text": { "$ref": "GoogleCloudDialogflowCxV3beta1ResponseMessageText", "description": "Returns a text response." +}, +"toolCall": { +"$ref": "GoogleCloudDialogflowCxV3beta1ToolCall", +"description": "Returns the definition of a tool call that should be executed by the client." } }, "type": "object" @@ -12080,6 +12088,67 @@ false }, "type": "object" }, +"GoogleCloudDialogflowCxV3beta1ToolCall": { +"description": "Represents a call of a specific tool's action with the specified inputs.", +"id": "GoogleCloudDialogflowCxV3beta1ToolCall", +"properties": { +"action": { +"description": "Required. The name of the tool's action associated with this call.", +"type": "string" +}, +"inputParameters": { +"additionalProperties": { +"description": "Properties of the object.", +"type": "any" +}, +"description": "Optional. The action's input parameters.", +"type": "object" +}, +"tool": { +"description": "Required. The tool associated with this call. Format: `projects//locations//agents//tools/`.", +"type": "string" +} +}, +"type": "object" +}, +"GoogleCloudDialogflowCxV3beta1ToolCallResult": { +"description": "The result of calling a tool's action that has been executed by the client.", +"id": "GoogleCloudDialogflowCxV3beta1ToolCallResult", +"properties": { +"action": { +"description": "Required. The name of the tool's action associated with this call.", +"type": "string" +}, +"error": { +"$ref": "GoogleCloudDialogflowCxV3beta1ToolCallResultError", +"description": "The tool call's error." +}, +"outputParameters": { +"additionalProperties": { +"description": "Properties of the object.", +"type": "any" +}, +"description": "The tool call's output parameters.", +"type": "object" +}, +"tool": { +"description": "Required. The tool associated with this call. Format: `projects//locations//agents//tools/`.", +"type": "string" +} +}, +"type": "object" +}, +"GoogleCloudDialogflowCxV3beta1ToolCallResultError": { +"description": "An error produced by the tool call.", +"id": "GoogleCloudDialogflowCxV3beta1ToolCallResultError", +"properties": { +"message": { +"description": "Optional. The error message of the function.", +"type": "string" +} +}, +"type": "object" +}, "GoogleCloudDialogflowCxV3beta1TransitionRoute": { "description": "A transition route specifies a intent that can be matched and/or a data condition that can be evaluated during a session. When a specified transition is matched, the following actions are taken in order: * If there is a `trigger_fulfillment` associated with the transition, it will be called. * If there is a `target_page` associated with the transition, the session will transition into the specified page. * If there is a `target_flow` associated with the transition, the session will transition into the specified flow.", "id": "GoogleCloudDialogflowCxV3beta1TransitionRoute", @@ -12719,14 +12788,16 @@ false "ARTICLE_SUGGESTION", "FAQ", "SMART_REPLY", -"KNOWLEDGE_SEARCH" +"KNOWLEDGE_SEARCH", +"KNOWLEDGE_ASSIST" ], "enumDescriptions": [ "Unspecified feature type.", "Run article suggestion model for chat.", "Run FAQ model for chat.", "Run smart reply model for chat.", -"Run knowledge search with text input from agent or text generated query." +"Run knowledge search with text input from agent or text generated query.", +"Run knowledge assist with automatic query generation." ], "type": "string" } @@ -14159,6 +14230,99 @@ true }, "type": "object" }, +"GoogleCloudDialogflowV2KnowledgeAssistAnswer": { +"description": "Represents a Knowledge Assist answer.", +"id": "GoogleCloudDialogflowV2KnowledgeAssistAnswer", +"properties": { +"answerRecord": { +"description": "The name of the answer record. Format: `projects//locations//answer Records/`.", +"type": "string" +}, +"suggestedQuery": { +"$ref": "GoogleCloudDialogflowV2KnowledgeAssistAnswerSuggestedQuery", +"description": "The query suggested based on the context. Suggestion is made only if it is different from the previous suggestion." +}, +"suggestedQueryAnswer": { +"$ref": "GoogleCloudDialogflowV2KnowledgeAssistAnswerKnowledgeAnswer", +"description": "The answer generated for the suggested query. Whether or not an answer is generated depends on how confident we are about the generated query." +} +}, +"type": "object" +}, +"GoogleCloudDialogflowV2KnowledgeAssistAnswerKnowledgeAnswer": { +"description": "Represents an answer from Knowledge. Currently supports FAQ and Generative answers.", +"id": "GoogleCloudDialogflowV2KnowledgeAssistAnswerKnowledgeAnswer", +"properties": { +"answerText": { +"description": "The piece of text from the `source` that answers this suggested query.", +"type": "string" +}, +"faqSource": { +"$ref": "GoogleCloudDialogflowV2KnowledgeAssistAnswerKnowledgeAnswerFaqSource", +"description": "Populated if the prediction came from FAQ." +}, +"generativeSource": { +"$ref": "GoogleCloudDialogflowV2KnowledgeAssistAnswerKnowledgeAnswerGenerativeSource", +"description": "Populated if the prediction was Generative." +} +}, +"type": "object" +}, +"GoogleCloudDialogflowV2KnowledgeAssistAnswerKnowledgeAnswerFaqSource": { +"description": "Details about source of FAQ answer.", +"id": "GoogleCloudDialogflowV2KnowledgeAssistAnswerKnowledgeAnswerFaqSource", +"properties": { +"question": { +"description": "The corresponding FAQ question.", +"type": "string" +} +}, +"type": "object" +}, +"GoogleCloudDialogflowV2KnowledgeAssistAnswerKnowledgeAnswerGenerativeSource": { +"description": "Details about source of Generative answer.", +"id": "GoogleCloudDialogflowV2KnowledgeAssistAnswerKnowledgeAnswerGenerativeSource", +"properties": { +"snippets": { +"description": "All snippets used for this Generative Prediction, with their source URI and data.", +"items": { +"$ref": "GoogleCloudDialogflowV2KnowledgeAssistAnswerKnowledgeAnswerGenerativeSourceSnippet" +}, +"type": "array" +} +}, +"type": "object" +}, +"GoogleCloudDialogflowV2KnowledgeAssistAnswerKnowledgeAnswerGenerativeSourceSnippet": { +"description": "Snippet Source for a Generative Prediction.", +"id": "GoogleCloudDialogflowV2KnowledgeAssistAnswerKnowledgeAnswerGenerativeSourceSnippet", +"properties": { +"text": { +"description": "Text taken from that URI.", +"type": "string" +}, +"title": { +"description": "Title of the document.", +"type": "string" +}, +"uri": { +"description": "URI the data is sourced from.", +"type": "string" +} +}, +"type": "object" +}, +"GoogleCloudDialogflowV2KnowledgeAssistAnswerSuggestedQuery": { +"description": "Represents a suggested query.", +"id": "GoogleCloudDialogflowV2KnowledgeAssistAnswerSuggestedQuery", +"properties": { +"queryText": { +"description": "Suggested query text.", +"type": "string" +} +}, +"type": "object" +}, "GoogleCloudDialogflowV2KnowledgeOperationMetadata": { "description": "Metadata in google::longrunning::Operation for Knowledge operations.", "id": "GoogleCloudDialogflowV2KnowledgeOperationMetadata", @@ -14481,14 +14645,16 @@ true "ARTICLE_SUGGESTION", "FAQ", "SMART_REPLY", -"KNOWLEDGE_SEARCH" +"KNOWLEDGE_SEARCH", +"KNOWLEDGE_ASSIST" ], "enumDescriptions": [ "Unspecified feature type.", "Run article suggestion model for chat.", "Run FAQ model for chat.", "Run smart reply model for chat.", -"Run knowledge search with text input from agent or text generated query." +"Run knowledge search with text input from agent or text generated query.", +"Run knowledge assist with automatic query generation." ], "type": "string" } @@ -14582,6 +14748,27 @@ true }, "type": "object" }, +"GoogleCloudDialogflowV2SuggestKnowledgeAssistResponse": { +"description": "The response message for Participants.SuggestKnowledgeAssist.", +"id": "GoogleCloudDialogflowV2SuggestKnowledgeAssistResponse", +"properties": { +"contextSize": { +"description": "Number of messages prior to and including latest_message to compile the suggestion. It may be smaller than the SuggestKnowledgeAssistRequest.context_size field in the request if there are fewer messages in the conversation.", +"format": "int32", +"type": "integer" +}, +"knowledgeAssistAnswer": { +"$ref": "GoogleCloudDialogflowV2KnowledgeAssistAnswer", +"description": "Output only. Knowledge Assist suggestion.", +"readOnly": true +}, +"latestMessage": { +"description": "The name of the latest conversation message used to compile suggestion for. Format: `projects//locations//conversations//messages/`.", +"type": "string" +} +}, +"type": "object" +}, "GoogleCloudDialogflowV2SuggestSmartRepliesResponse": { "description": "The response message for Participants.SuggestSmartReplies.", "id": "GoogleCloudDialogflowV2SuggestSmartRepliesResponse", @@ -14622,6 +14809,10 @@ true "$ref": "GoogleCloudDialogflowV2SuggestFaqAnswersResponse", "description": "SuggestFaqAnswersResponse if request is for FAQ_ANSWER." }, +"suggestKnowledgeAssistResponse": { +"$ref": "GoogleCloudDialogflowV2SuggestKnowledgeAssistResponse", +"description": "SuggestKnowledgeAssistResponse if request is for KNOWLEDGE_ASSIST." +}, "suggestSmartRepliesResponse": { "$ref": "GoogleCloudDialogflowV2SuggestSmartRepliesResponse", "description": "SuggestSmartRepliesResponse if request is for SMART_REPLY." @@ -14834,7 +15025,8 @@ true "SMART_REPLY", "DIALOGFLOW_ASSIST", "CONVERSATION_SUMMARIZATION", -"KNOWLEDGE_SEARCH" +"KNOWLEDGE_SEARCH", +"KNOWLEDGE_ASSIST" ], "enumDescriptions": [ "Unspecified feature type.", @@ -14843,7 +15035,8 @@ true "Run smart reply model for chat.", "Run Dialogflow assist model for chat, which will return automated agent response as suggestion.", "Run conversation summarization model for chat.", -"Run knowledge search with text input from agent or text generated query." +"Run knowledge search with text input from agent or text generated query.", +"Run knowledge assist with automatic query generation." ], "type": "string" } @@ -16421,6 +16614,99 @@ true }, "type": "object" }, +"GoogleCloudDialogflowV2beta1KnowledgeAssistAnswer": { +"description": "Represents a Knowledge Assist answer.", +"id": "GoogleCloudDialogflowV2beta1KnowledgeAssistAnswer", +"properties": { +"answerRecord": { +"description": "The name of the answer record. Format: `projects//locations//answer Records/`.", +"type": "string" +}, +"suggestedQuery": { +"$ref": "GoogleCloudDialogflowV2beta1KnowledgeAssistAnswerSuggestedQuery", +"description": "The query suggested based on the context. Suggestion is made only if it is different from the previous suggestion." +}, +"suggestedQueryAnswer": { +"$ref": "GoogleCloudDialogflowV2beta1KnowledgeAssistAnswerKnowledgeAnswer", +"description": "The answer generated for the suggested query. Whether or not an answer is generated depends on how confident we are about the generated query." +} +}, +"type": "object" +}, +"GoogleCloudDialogflowV2beta1KnowledgeAssistAnswerKnowledgeAnswer": { +"description": "Represents an answer from Knowledge. Currently supports FAQ and Generative answers.", +"id": "GoogleCloudDialogflowV2beta1KnowledgeAssistAnswerKnowledgeAnswer", +"properties": { +"answerText": { +"description": "The piece of text from the `source` that answers this suggested query.", +"type": "string" +}, +"faqSource": { +"$ref": "GoogleCloudDialogflowV2beta1KnowledgeAssistAnswerKnowledgeAnswerFaqSource", +"description": "Populated if the prediction came from FAQ." +}, +"generativeSource": { +"$ref": "GoogleCloudDialogflowV2beta1KnowledgeAssistAnswerKnowledgeAnswerGenerativeSource", +"description": "Populated if the prediction was Generative." +} +}, +"type": "object" +}, +"GoogleCloudDialogflowV2beta1KnowledgeAssistAnswerKnowledgeAnswerFaqSource": { +"description": "Details about source of FAQ answer.", +"id": "GoogleCloudDialogflowV2beta1KnowledgeAssistAnswerKnowledgeAnswerFaqSource", +"properties": { +"question": { +"description": "The corresponding FAQ question.", +"type": "string" +} +}, +"type": "object" +}, +"GoogleCloudDialogflowV2beta1KnowledgeAssistAnswerKnowledgeAnswerGenerativeSource": { +"description": "Details about source of Generative answer.", +"id": "GoogleCloudDialogflowV2beta1KnowledgeAssistAnswerKnowledgeAnswerGenerativeSource", +"properties": { +"snippets": { +"description": "All snippets used for this Generative Prediction, with their source URI and data.", +"items": { +"$ref": "GoogleCloudDialogflowV2beta1KnowledgeAssistAnswerKnowledgeAnswerGenerativeSourceSnippet" +}, +"type": "array" +} +}, +"type": "object" +}, +"GoogleCloudDialogflowV2beta1KnowledgeAssistAnswerKnowledgeAnswerGenerativeSourceSnippet": { +"description": "Snippet Source for a Generative Prediction.", +"id": "GoogleCloudDialogflowV2beta1KnowledgeAssistAnswerKnowledgeAnswerGenerativeSourceSnippet", +"properties": { +"text": { +"description": "Text taken from that URI.", +"type": "string" +}, +"title": { +"description": "Title of the document.", +"type": "string" +}, +"uri": { +"description": "URI the data is sourced from.", +"type": "string" +} +}, +"type": "object" +}, +"GoogleCloudDialogflowV2beta1KnowledgeAssistAnswerSuggestedQuery": { +"description": "Represents a suggested query.", +"id": "GoogleCloudDialogflowV2beta1KnowledgeAssistAnswerSuggestedQuery", +"properties": { +"queryText": { +"description": "Suggested query text.", +"type": "string" +} +}, +"type": "object" +}, "GoogleCloudDialogflowV2beta1KnowledgeOperationMetadata": { "description": "Metadata in google::longrunning::Operation for Knowledge operations.", "id": "GoogleCloudDialogflowV2beta1KnowledgeOperationMetadata", @@ -16749,7 +17035,8 @@ true "SMART_REPLY", "DIALOGFLOW_ASSIST", "CONVERSATION_SUMMARIZATION", -"KNOWLEDGE_SEARCH" +"KNOWLEDGE_SEARCH", +"KNOWLEDGE_ASSIST" ], "enumDescriptions": [ "Unspecified feature type.", @@ -16758,7 +17045,8 @@ true "Run smart reply model for chat.", "Run Dialogflow assist model for chat, which will return automated agent response as suggestion.", "Run conversation summarization model for chat.", -"Run knowledge search with text input from agent or text generated query." +"Run knowledge search with text input from agent or text generated query.", +"Run knowledge assist with automatic query generation." ], "type": "string" } @@ -16854,6 +17142,27 @@ true }, "type": "object" }, +"GoogleCloudDialogflowV2beta1SuggestKnowledgeAssistResponse": { +"description": "The response message for Participants.SuggestKnowledgeAssist.", +"id": "GoogleCloudDialogflowV2beta1SuggestKnowledgeAssistResponse", +"properties": { +"contextSize": { +"description": "Number of messages prior to and including latest_message to compile the suggestion. It may be smaller than the SuggestKnowledgeAssistRequest.context_size field in the request if there are fewer messages in the conversation.", +"format": "int32", +"type": "integer" +}, +"knowledgeAssistAnswer": { +"$ref": "GoogleCloudDialogflowV2beta1KnowledgeAssistAnswer", +"description": "Output only. Knowledge Assist suggestion.", +"readOnly": true +}, +"latestMessage": { +"description": "The name of the latest conversation message used to compile suggestion for. Format: `projects//locations//conversations//messages/`.", +"type": "string" +} +}, +"type": "object" +}, "GoogleCloudDialogflowV2beta1SuggestSmartRepliesResponse": { "description": "The response message for Participants.SuggestSmartReplies.", "id": "GoogleCloudDialogflowV2beta1SuggestSmartRepliesResponse", @@ -16901,6 +17210,10 @@ true "$ref": "GoogleCloudDialogflowV2beta1SuggestFaqAnswersResponse", "description": "SuggestFaqAnswersResponse if request is for FAQ_ANSWER." }, +"suggestKnowledgeAssistResponse": { +"$ref": "GoogleCloudDialogflowV2beta1SuggestKnowledgeAssistResponse", +"description": "SuggestKnowledgeAssistResponse if request is for KNOWLEDGE_ASSIST." +}, "suggestSmartRepliesResponse": { "$ref": "GoogleCloudDialogflowV2beta1SuggestSmartRepliesResponse", "description": "SuggestSmartRepliesResponse if request is for SMART_REPLY." diff --git a/googleapiclient/discovery_cache/documents/dialogflow.v3beta1.json b/googleapiclient/discovery_cache/documents/dialogflow.v3beta1.json index b843a2cb219..ae42080e947 100644 --- a/googleapiclient/discovery_cache/documents/dialogflow.v3beta1.json +++ b/googleapiclient/discovery_cache/documents/dialogflow.v3beta1.json @@ -3131,6 +3131,449 @@ } } }, +"playbooks": { +"methods": { +"create": { +"description": "Creates a playbook in a specified agent.", +"flatPath": "v3beta1/projects/{projectsId}/locations/{locationsId}/agents/{agentsId}/playbooks", +"httpMethod": "POST", +"id": "dialogflow.projects.locations.agents.playbooks.create", +"parameterOrder": [ +"parent" +], +"parameters": { +"parent": { +"description": "Required. The agent to create a playbook for. Format: `projects//locations//agents/`.", +"location": "path", +"pattern": "^projects/[^/]+/locations/[^/]+/agents/[^/]+$", +"required": true, +"type": "string" +} +}, +"path": "v3beta1/{+parent}/playbooks", +"request": { +"$ref": "GoogleCloudDialogflowCxV3beta1Playbook" +}, +"response": { +"$ref": "GoogleCloudDialogflowCxV3beta1Playbook" +}, +"scopes": [ +"https://www.googleapis.com/auth/cloud-platform", +"https://www.googleapis.com/auth/dialogflow" +] +}, +"delete": { +"description": "Deletes a specified playbook.", +"flatPath": "v3beta1/projects/{projectsId}/locations/{locationsId}/agents/{agentsId}/playbooks/{playbooksId}", +"httpMethod": "DELETE", +"id": "dialogflow.projects.locations.agents.playbooks.delete", +"parameterOrder": [ +"name" +], +"parameters": { +"name": { +"description": "Required. The name of the playbook to delete. Format: `projects//locations//agents//playbooks/`.", +"location": "path", +"pattern": "^projects/[^/]+/locations/[^/]+/agents/[^/]+/playbooks/[^/]+$", +"required": true, +"type": "string" +} +}, +"path": "v3beta1/{+name}", +"response": { +"$ref": "GoogleProtobufEmpty" +}, +"scopes": [ +"https://www.googleapis.com/auth/cloud-platform", +"https://www.googleapis.com/auth/dialogflow" +] +}, +"get": { +"description": "Retrieves the specified Playbook.", +"flatPath": "v3beta1/projects/{projectsId}/locations/{locationsId}/agents/{agentsId}/playbooks/{playbooksId}", +"httpMethod": "GET", +"id": "dialogflow.projects.locations.agents.playbooks.get", +"parameterOrder": [ +"name" +], +"parameters": { +"name": { +"description": "Required. The name of the playbook. Format: `projects//locations//agents//playbooks/`.", +"location": "path", +"pattern": "^projects/[^/]+/locations/[^/]+/agents/[^/]+/playbooks/[^/]+$", +"required": true, +"type": "string" +} +}, +"path": "v3beta1/{+name}", +"response": { +"$ref": "GoogleCloudDialogflowCxV3beta1Playbook" +}, +"scopes": [ +"https://www.googleapis.com/auth/cloud-platform", +"https://www.googleapis.com/auth/dialogflow" +] +}, +"list": { +"description": "Returns a list of playbooks in the specified agent.", +"flatPath": "v3beta1/projects/{projectsId}/locations/{locationsId}/agents/{agentsId}/playbooks", +"httpMethod": "GET", +"id": "dialogflow.projects.locations.agents.playbooks.list", +"parameterOrder": [ +"parent" +], +"parameters": { +"pageSize": { +"description": "The maximum number of items to return in a single page. By default 100 and at most 1000.", +"format": "int32", +"location": "query", +"type": "integer" +}, +"pageToken": { +"description": "The next_page_token value returned from a previous list request.", +"location": "query", +"type": "string" +}, +"parent": { +"description": "Required. The agent to list playbooks from. Format: `projects//locations//agents/`.", +"location": "path", +"pattern": "^projects/[^/]+/locations/[^/]+/agents/[^/]+$", +"required": true, +"type": "string" +} +}, +"path": "v3beta1/{+parent}/playbooks", +"response": { +"$ref": "GoogleCloudDialogflowCxV3beta1ListPlaybooksResponse" +}, +"scopes": [ +"https://www.googleapis.com/auth/cloud-platform", +"https://www.googleapis.com/auth/dialogflow" +] +}, +"patch": { +"description": "Updates the specified Playbook.", +"flatPath": "v3beta1/projects/{projectsId}/locations/{locationsId}/agents/{agentsId}/playbooks/{playbooksId}", +"httpMethod": "PATCH", +"id": "dialogflow.projects.locations.agents.playbooks.patch", +"parameterOrder": [ +"name" +], +"parameters": { +"name": { +"description": "The unique identifier of the playbook. Format: `projects//locations//agents//playbooks/`.", +"location": "path", +"pattern": "^projects/[^/]+/locations/[^/]+/agents/[^/]+/playbooks/[^/]+$", +"required": true, +"type": "string" +}, +"updateMask": { +"description": "The mask to control which fields get updated. If the mask is not present, all fields will be updated.", +"format": "google-fieldmask", +"location": "query", +"type": "string" +} +}, +"path": "v3beta1/{+name}", +"request": { +"$ref": "GoogleCloudDialogflowCxV3beta1Playbook" +}, +"response": { +"$ref": "GoogleCloudDialogflowCxV3beta1Playbook" +}, +"scopes": [ +"https://www.googleapis.com/auth/cloud-platform", +"https://www.googleapis.com/auth/dialogflow" +] +} +}, +"resources": { +"examples": { +"methods": { +"create": { +"description": "Creates an example in the specified playbook.", +"flatPath": "v3beta1/projects/{projectsId}/locations/{locationsId}/agents/{agentsId}/playbooks/{playbooksId}/examples", +"httpMethod": "POST", +"id": "dialogflow.projects.locations.agents.playbooks.examples.create", +"parameterOrder": [ +"parent" +], +"parameters": { +"parent": { +"description": "Required. The playbook to create an example for. Format: `projects//locations//agents//playbooks/`.", +"location": "path", +"pattern": "^projects/[^/]+/locations/[^/]+/agents/[^/]+/playbooks/[^/]+$", +"required": true, +"type": "string" +} +}, +"path": "v3beta1/{+parent}/examples", +"request": { +"$ref": "GoogleCloudDialogflowCxV3beta1Example" +}, +"response": { +"$ref": "GoogleCloudDialogflowCxV3beta1Example" +}, +"scopes": [ +"https://www.googleapis.com/auth/cloud-platform", +"https://www.googleapis.com/auth/dialogflow" +] +}, +"delete": { +"description": "Deletes the specified example.", +"flatPath": "v3beta1/projects/{projectsId}/locations/{locationsId}/agents/{agentsId}/playbooks/{playbooksId}/examples/{examplesId}", +"httpMethod": "DELETE", +"id": "dialogflow.projects.locations.agents.playbooks.examples.delete", +"parameterOrder": [ +"name" +], +"parameters": { +"name": { +"description": "Required. The name of the example to delete. Format: `projects//locations//agents//playbooks//examples/`.", +"location": "path", +"pattern": "^projects/[^/]+/locations/[^/]+/agents/[^/]+/playbooks/[^/]+/examples/[^/]+$", +"required": true, +"type": "string" +} +}, +"path": "v3beta1/{+name}", +"response": { +"$ref": "GoogleProtobufEmpty" +}, +"scopes": [ +"https://www.googleapis.com/auth/cloud-platform", +"https://www.googleapis.com/auth/dialogflow" +] +}, +"get": { +"description": "Retrieves the specified example.", +"flatPath": "v3beta1/projects/{projectsId}/locations/{locationsId}/agents/{agentsId}/playbooks/{playbooksId}/examples/{examplesId}", +"httpMethod": "GET", +"id": "dialogflow.projects.locations.agents.playbooks.examples.get", +"parameterOrder": [ +"name" +], +"parameters": { +"name": { +"description": "Required. The name of the example. Format: `projects//locations//agents//playbooks//examples/`.", +"location": "path", +"pattern": "^projects/[^/]+/locations/[^/]+/agents/[^/]+/playbooks/[^/]+/examples/[^/]+$", +"required": true, +"type": "string" +} +}, +"path": "v3beta1/{+name}", +"response": { +"$ref": "GoogleCloudDialogflowCxV3beta1Example" +}, +"scopes": [ +"https://www.googleapis.com/auth/cloud-platform", +"https://www.googleapis.com/auth/dialogflow" +] +}, +"list": { +"description": "Returns a list of examples in the specified playbook.", +"flatPath": "v3beta1/projects/{projectsId}/locations/{locationsId}/agents/{agentsId}/playbooks/{playbooksId}/examples", +"httpMethod": "GET", +"id": "dialogflow.projects.locations.agents.playbooks.examples.list", +"parameterOrder": [ +"parent" +], +"parameters": { +"languageCode": { +"description": "Optional. The language to list examples for. If not specified, the agent's default language is used. Note: languages must be enabled in the agent before they can be used.", +"location": "query", +"type": "string" +}, +"pageSize": { +"description": "Optional. The maximum number of items to return in a single page. By default 100 and at most 1000.", +"format": "int32", +"location": "query", +"type": "integer" +}, +"pageToken": { +"description": "Optional. The next_page_token value returned from a previous list request.", +"location": "query", +"type": "string" +}, +"parent": { +"description": "Required. The playbook to list the examples from. Format: `projects//locations//agents//playbooks/`.", +"location": "path", +"pattern": "^projects/[^/]+/locations/[^/]+/agents/[^/]+/playbooks/[^/]+$", +"required": true, +"type": "string" +} +}, +"path": "v3beta1/{+parent}/examples", +"response": { +"$ref": "GoogleCloudDialogflowCxV3beta1ListExamplesResponse" +}, +"scopes": [ +"https://www.googleapis.com/auth/cloud-platform", +"https://www.googleapis.com/auth/dialogflow" +] +}, +"patch": { +"description": "Update the specified example.", +"flatPath": "v3beta1/projects/{projectsId}/locations/{locationsId}/agents/{agentsId}/playbooks/{playbooksId}/examples/{examplesId}", +"httpMethod": "PATCH", +"id": "dialogflow.projects.locations.agents.playbooks.examples.patch", +"parameterOrder": [ +"name" +], +"parameters": { +"name": { +"description": "The unique identifier of the playbook example. Format: `projects//locations//agents//playbooks//examples/`.", +"location": "path", +"pattern": "^projects/[^/]+/locations/[^/]+/agents/[^/]+/playbooks/[^/]+/examples/[^/]+$", +"required": true, +"type": "string" +}, +"updateMask": { +"description": "Optional. The mask to control which fields get updated. If the mask is not present, all fields will be updated.", +"format": "google-fieldmask", +"location": "query", +"type": "string" +} +}, +"path": "v3beta1/{+name}", +"request": { +"$ref": "GoogleCloudDialogflowCxV3beta1Example" +}, +"response": { +"$ref": "GoogleCloudDialogflowCxV3beta1Example" +}, +"scopes": [ +"https://www.googleapis.com/auth/cloud-platform", +"https://www.googleapis.com/auth/dialogflow" +] +} +} +}, +"versions": { +"methods": { +"create": { +"description": "Creates a version for the specified Playbook.", +"flatPath": "v3beta1/projects/{projectsId}/locations/{locationsId}/agents/{agentsId}/playbooks/{playbooksId}/versions", +"httpMethod": "POST", +"id": "dialogflow.projects.locations.agents.playbooks.versions.create", +"parameterOrder": [ +"parent" +], +"parameters": { +"parent": { +"description": "Required. The playbook to create a version for. Format: `projects//locations//agents//playbooks/`.", +"location": "path", +"pattern": "^projects/[^/]+/locations/[^/]+/agents/[^/]+/playbooks/[^/]+$", +"required": true, +"type": "string" +} +}, +"path": "v3beta1/{+parent}/versions", +"request": { +"$ref": "GoogleCloudDialogflowCxV3beta1PlaybookVersion" +}, +"response": { +"$ref": "GoogleCloudDialogflowCxV3beta1PlaybookVersion" +}, +"scopes": [ +"https://www.googleapis.com/auth/cloud-platform", +"https://www.googleapis.com/auth/dialogflow" +] +}, +"delete": { +"description": "Deletes the specified version of the Playbook.", +"flatPath": "v3beta1/projects/{projectsId}/locations/{locationsId}/agents/{agentsId}/playbooks/{playbooksId}/versions/{versionsId}", +"httpMethod": "DELETE", +"id": "dialogflow.projects.locations.agents.playbooks.versions.delete", +"parameterOrder": [ +"name" +], +"parameters": { +"name": { +"description": "Required. The name of the playbook version to delete. Format: `projects//locations//agents//playbooks//versions/`.", +"location": "path", +"pattern": "^projects/[^/]+/locations/[^/]+/agents/[^/]+/playbooks/[^/]+/versions/[^/]+$", +"required": true, +"type": "string" +} +}, +"path": "v3beta1/{+name}", +"response": { +"$ref": "GoogleProtobufEmpty" +}, +"scopes": [ +"https://www.googleapis.com/auth/cloud-platform", +"https://www.googleapis.com/auth/dialogflow" +] +}, +"get": { +"description": "Retrieves the specified version of the Playbook.", +"flatPath": "v3beta1/projects/{projectsId}/locations/{locationsId}/agents/{agentsId}/playbooks/{playbooksId}/versions/{versionsId}", +"httpMethod": "GET", +"id": "dialogflow.projects.locations.agents.playbooks.versions.get", +"parameterOrder": [ +"name" +], +"parameters": { +"name": { +"description": "Required. The name of the playbook version. Format: `projects//locations//agents//playbooks//versions/`.", +"location": "path", +"pattern": "^projects/[^/]+/locations/[^/]+/agents/[^/]+/playbooks/[^/]+/versions/[^/]+$", +"required": true, +"type": "string" +} +}, +"path": "v3beta1/{+name}", +"response": { +"$ref": "GoogleCloudDialogflowCxV3beta1PlaybookVersion" +}, +"scopes": [ +"https://www.googleapis.com/auth/cloud-platform", +"https://www.googleapis.com/auth/dialogflow" +] +}, +"list": { +"description": "Lists versions for the specified Playbook.", +"flatPath": "v3beta1/projects/{projectsId}/locations/{locationsId}/agents/{agentsId}/playbooks/{playbooksId}/versions", +"httpMethod": "GET", +"id": "dialogflow.projects.locations.agents.playbooks.versions.list", +"parameterOrder": [ +"parent" +], +"parameters": { +"pageSize": { +"description": "Optional. The maximum number of items to return in a single page. By default 100 and at most 1000.", +"format": "int32", +"location": "query", +"type": "integer" +}, +"pageToken": { +"description": "Optional. The next_page_token value returned from a previous list request.", +"location": "query", +"type": "string" +}, +"parent": { +"description": "Required. The playbook to list versions for. Format: `projects//locations//agents//playbooks/`.", +"location": "path", +"pattern": "^projects/[^/]+/locations/[^/]+/agents/[^/]+/playbooks/[^/]+$", +"required": true, +"type": "string" +} +}, +"path": "v3beta1/{+parent}/versions", +"response": { +"$ref": "GoogleCloudDialogflowCxV3beta1ListPlaybookVersionsResponse" +}, +"scopes": [ +"https://www.googleapis.com/auth/cloud-platform", +"https://www.googleapis.com/auth/dialogflow" +] +} +} +} +} +}, "sessions": { "methods": { "detectIntent": { @@ -3847,6 +4290,197 @@ } } }, +"tools": { +"methods": { +"create": { +"description": "Creates a Tool in the specified agent.", +"flatPath": "v3beta1/projects/{projectsId}/locations/{locationsId}/agents/{agentsId}/tools", +"httpMethod": "POST", +"id": "dialogflow.projects.locations.agents.tools.create", +"parameterOrder": [ +"parent" +], +"parameters": { +"parent": { +"description": "Required. The agent to create a Tool for. Format: `projects//locations//agents/`.", +"location": "path", +"pattern": "^projects/[^/]+/locations/[^/]+/agents/[^/]+$", +"required": true, +"type": "string" +} +}, +"path": "v3beta1/{+parent}/tools", +"request": { +"$ref": "GoogleCloudDialogflowCxV3beta1Tool" +}, +"response": { +"$ref": "GoogleCloudDialogflowCxV3beta1Tool" +}, +"scopes": [ +"https://www.googleapis.com/auth/cloud-platform", +"https://www.googleapis.com/auth/dialogflow" +] +}, +"delete": { +"description": "Deletes a specified Tool.", +"flatPath": "v3beta1/projects/{projectsId}/locations/{locationsId}/agents/{agentsId}/tools/{toolsId}", +"httpMethod": "DELETE", +"id": "dialogflow.projects.locations.agents.tools.delete", +"parameterOrder": [ +"name" +], +"parameters": { +"force": { +"description": "This field has no effect for Tools not being used. For Tools that are used: * If `force` is set to false, an error will be returned with message indicating the referenced resources. * If `force` is set to true, Dialogflow will remove the tool, as well as any references to the tool.", +"location": "query", +"type": "boolean" +}, +"name": { +"description": "Required. The name of the Tool to be deleted. Format: `projects//locations//agents//tools/`.", +"location": "path", +"pattern": "^projects/[^/]+/locations/[^/]+/agents/[^/]+/tools/[^/]+$", +"required": true, +"type": "string" +} +}, +"path": "v3beta1/{+name}", +"response": { +"$ref": "GoogleProtobufEmpty" +}, +"scopes": [ +"https://www.googleapis.com/auth/cloud-platform", +"https://www.googleapis.com/auth/dialogflow" +] +}, +"export": { +"description": "Exports the selected tools.", +"flatPath": "v3beta1/projects/{projectsId}/locations/{locationsId}/agents/{agentsId}/tools:export", +"httpMethod": "POST", +"id": "dialogflow.projects.locations.agents.tools.export", +"parameterOrder": [ +"parent" +], +"parameters": { +"parent": { +"description": "Required. The agent to export tools from. Format: `projects//locations//agents/`.", +"location": "path", +"pattern": "^projects/[^/]+/locations/[^/]+/agents/[^/]+$", +"required": true, +"type": "string" +} +}, +"path": "v3beta1/{+parent}/tools:export", +"request": { +"$ref": "GoogleCloudDialogflowCxV3beta1ExportToolsRequest" +}, +"response": { +"$ref": "GoogleLongrunningOperation" +}, +"scopes": [ +"https://www.googleapis.com/auth/cloud-platform", +"https://www.googleapis.com/auth/dialogflow" +] +}, +"get": { +"description": "Retrieves the specified Tool.", +"flatPath": "v3beta1/projects/{projectsId}/locations/{locationsId}/agents/{agentsId}/tools/{toolsId}", +"httpMethod": "GET", +"id": "dialogflow.projects.locations.agents.tools.get", +"parameterOrder": [ +"name" +], +"parameters": { +"name": { +"description": "Required. The name of the Tool. Format: `projects//locations//agents//tools/`.", +"location": "path", +"pattern": "^projects/[^/]+/locations/[^/]+/agents/[^/]+/tools/[^/]+$", +"required": true, +"type": "string" +} +}, +"path": "v3beta1/{+name}", +"response": { +"$ref": "GoogleCloudDialogflowCxV3beta1Tool" +}, +"scopes": [ +"https://www.googleapis.com/auth/cloud-platform", +"https://www.googleapis.com/auth/dialogflow" +] +}, +"list": { +"description": "Returns a list of Tools in the specified agent.", +"flatPath": "v3beta1/projects/{projectsId}/locations/{locationsId}/agents/{agentsId}/tools", +"httpMethod": "GET", +"id": "dialogflow.projects.locations.agents.tools.list", +"parameterOrder": [ +"parent" +], +"parameters": { +"pageSize": { +"description": "The maximum number of items to return in a single page. By default 100 and at most 1000.", +"format": "int32", +"location": "query", +"type": "integer" +}, +"pageToken": { +"description": "The next_page_token value returned from a previous list request.", +"location": "query", +"type": "string" +}, +"parent": { +"description": "Required. The agent to list the Tools from. Format: `projects//locations//agents/`.", +"location": "path", +"pattern": "^projects/[^/]+/locations/[^/]+/agents/[^/]+$", +"required": true, +"type": "string" +} +}, +"path": "v3beta1/{+parent}/tools", +"response": { +"$ref": "GoogleCloudDialogflowCxV3beta1ListToolsResponse" +}, +"scopes": [ +"https://www.googleapis.com/auth/cloud-platform", +"https://www.googleapis.com/auth/dialogflow" +] +}, +"patch": { +"description": "Update the specified Tool.", +"flatPath": "v3beta1/projects/{projectsId}/locations/{locationsId}/agents/{agentsId}/tools/{toolsId}", +"httpMethod": "PATCH", +"id": "dialogflow.projects.locations.agents.tools.patch", +"parameterOrder": [ +"name" +], +"parameters": { +"name": { +"description": "The unique identifier of the Tool. Format: `projects//locations//agents//tools/`.", +"location": "path", +"pattern": "^projects/[^/]+/locations/[^/]+/agents/[^/]+/tools/[^/]+$", +"required": true, +"type": "string" +}, +"updateMask": { +"description": "The mask to control which fields get updated. If the mask is not present, all fields will be updated.", +"format": "google-fieldmask", +"location": "query", +"type": "string" +} +}, +"path": "v3beta1/{+name}", +"request": { +"$ref": "GoogleCloudDialogflowCxV3beta1Tool" +}, +"response": { +"$ref": "GoogleCloudDialogflowCxV3beta1Tool" +}, +"scopes": [ +"https://www.googleapis.com/auth/cloud-platform", +"https://www.googleapis.com/auth/dialogflow" +] +} +} +}, "transitionRouteGroups": { "methods": { "create": { @@ -4551,7 +5185,7 @@ } } }, -"revision": "20240523", +"revision": "20240605", "rootUrl": "https://dialogflow.googleapis.com/", "schemas": { "GoogleCloudDialogflowCxV3AdvancedSettings": { @@ -4612,11 +5246,11 @@ "id": "GoogleCloudDialogflowCxV3AdvancedSettingsLoggingSettings", "properties": { "enableInteractionLogging": { -"description": "If true, DF Interaction logging is currently enabled.", +"description": "Enables DF Interaction logging.", "type": "boolean" }, "enableStackdriverLogging": { -"description": "If true, StackDriver logging is currently enabled.", +"description": "Enables StackDriver logging.", "type": "boolean" } }, @@ -6944,6 +7578,33 @@ }, "type": "object" }, +"GoogleCloudDialogflowCxV3beta1Action": { +"description": "Action performed by end user or Dialogflow agent in the conversation.", +"id": "GoogleCloudDialogflowCxV3beta1Action", +"properties": { +"agentUtterance": { +"$ref": "GoogleCloudDialogflowCxV3beta1AgentUtterance", +"description": "Optional. Action performed by the agent as a message." +}, +"flowInvocation": { +"$ref": "GoogleCloudDialogflowCxV3beta1FlowInvocation", +"description": "Optional. Action performed on behalf of the agent by invoking a CX flow." +}, +"playbookInvocation": { +"$ref": "GoogleCloudDialogflowCxV3beta1PlaybookInvocation", +"description": "Optional. Action performed on behalf of the agent by invoking a child playbook." +}, +"toolUse": { +"$ref": "GoogleCloudDialogflowCxV3beta1ToolUse", +"description": "Optional. Action performed on behalf of the agent by calling a plugin tool." +}, +"userUtterance": { +"$ref": "GoogleCloudDialogflowCxV3beta1UserUtterance", +"description": "Optional. Agent obtained a message from the customer." +} +}, +"type": "object" +}, "GoogleCloudDialogflowCxV3beta1AdvancedSettings": { "description": "Hierarchical advanced settings for agent/flow/page/fulfillment/parameter. Settings exposed at lower level overrides the settings exposed at higher level. Overriding occurs at the sub-setting level. For example, the playback_interruption_settings at fulfillment level only overrides the playback_interruption_settings at the agent level, leaving other settings at the agent level unchanged. DTMF settings does not override each other. DTMF settings set at different levels define DTMF detections running in parallel. Hierarchy: Agent->Flow->Page->Fulfillment/Parameter.", "id": "GoogleCloudDialogflowCxV3beta1AdvancedSettings", @@ -7002,11 +7663,11 @@ "id": "GoogleCloudDialogflowCxV3beta1AdvancedSettingsLoggingSettings", "properties": { "enableInteractionLogging": { -"description": "If true, DF Interaction logging is currently enabled.", +"description": "Enables DF Interaction logging.", "type": "boolean" }, "enableStackdriverLogging": { -"description": "If true, StackDriver logging is currently enabled.", +"description": "Enables StackDriver logging.", "type": "boolean" } }, @@ -7110,7 +7771,11 @@ "description": "Speech recognition related settings." }, "startFlow": { -"description": "Immutable. Name of the start flow in this agent. A start flow will be automatically created when the agent is created, and can only be deleted by deleting the agent. Format: `projects//locations//agents//flows/`.", +"description": "Name of the start flow in this agent. A start flow will be automatically created when the agent is created, and can only be deleted by deleting the agent. Format: `projects//locations//agents//flows/`. Currently only the default start flow with id \"00000000-0000-0000-0000-000000000000\" is allowed.", +"type": "string" +}, +"startPlaybook": { +"description": "Name of the start playbook in this agent. A start playbook will be automatically created when the agent is created, and can only be deleted by deleting the agent. Format: `projects//locations//agents//playbooks/`. Currently only the default playbook with id \"00000000-0000-0000-0000-000000000000\" is allowed.", "type": "string" }, "supportedLanguageCodes": { @@ -7209,6 +7874,17 @@ }, "type": "object" }, +"GoogleCloudDialogflowCxV3beta1AgentUtterance": { +"description": "AgentUtterance represents one message sent by the agent.", +"id": "GoogleCloudDialogflowCxV3beta1AgentUtterance", +"properties": { +"text": { +"description": "Required. Message content in text.", +"type": "string" +} +}, +"type": "object" +}, "GoogleCloudDialogflowCxV3beta1AgentValidationResult": { "description": "The response message for Agents.GetAgentValidationResult.", "id": "GoogleCloudDialogflowCxV3beta1AgentValidationResult", @@ -8586,14 +9262,90 @@ "description": "The fulfillment to call when the event occurs. Handling webhook errors with a fulfillment enabled with webhook could cause infinite loop. It is invalid to specify such fulfillment for a handler handling webhooks." } }, -"type": "object" +"type": "object" +}, +"GoogleCloudDialogflowCxV3beta1EventInput": { +"description": "Represents the event to trigger.", +"id": "GoogleCloudDialogflowCxV3beta1EventInput", +"properties": { +"event": { +"description": "Name of the event.", +"type": "string" +} +}, +"type": "object" +}, +"GoogleCloudDialogflowCxV3beta1Example": { +"description": "Example represents a sample execution of the playbook in the conversation. An example consists of a list of ordered actions performed by end user or Dialogflow agent according the playbook instructions to fulfill the task.", +"id": "GoogleCloudDialogflowCxV3beta1Example", +"properties": { +"actions": { +"description": "Required. The ordered list of actions performed by the end user and the Dialogflow agent.", +"items": { +"$ref": "GoogleCloudDialogflowCxV3beta1Action" +}, +"type": "array" +}, +"conversationState": { +"description": "Required. Example's output state.", +"enum": [ +"OUTPUT_STATE_UNSPECIFIED", +"OUTPUT_STATE_OK", +"OUTPUT_STATE_CANCELLED", +"OUTPUT_STATE_FAILED", +"OUTPUT_STATE_ESCALATED", +"OUTPUT_STATE_PENDING" +], +"enumDescriptions": [ +"Unspecified output.", +"Succeeded.", +"Cancelled.", +"Failed.", +"Escalated.", +"Pending." +], +"type": "string" +}, +"createTime": { +"description": "Output only. The timestamp of initial example creation.", +"format": "google-datetime", +"readOnly": true, +"type": "string" +}, +"description": { +"description": "Optional. The high level concise description of the example. The max number of characters is 200.", +"type": "string" +}, +"displayName": { +"description": "Required. The display name of the example.", +"type": "string" +}, +"languageCode": { +"description": "Optional. The language code of the example. If not specified, the agent's default language is used. Note: languages must be enabled in the agent before they can be used.", +"type": "string" +}, +"name": { +"description": "The unique identifier of the playbook example. Format: `projects//locations//agents//playbooks//examples/`.", +"type": "string" +}, +"playbookInput": { +"$ref": "GoogleCloudDialogflowCxV3beta1PlaybookInput", +"description": "Optional. The input to the playbook in the example." }, -"GoogleCloudDialogflowCxV3beta1EventInput": { -"description": "Represents the event to trigger.", -"id": "GoogleCloudDialogflowCxV3beta1EventInput", -"properties": { -"event": { -"description": "Name of the event.", +"playbookOutput": { +"$ref": "GoogleCloudDialogflowCxV3beta1PlaybookOutput", +"description": "Optional. The output of the playbook in the example." +}, +"tokenCount": { +"description": "Output only. Estimated number of tokes current example takes when sent to the LLM.", +"format": "int64", +"readOnly": true, +"type": "string" +}, +"updateTime": { +"description": "Output only. Last time the example was updated.", +"format": "google-datetime", +"readOnly": true, "type": "string" } }, @@ -9103,6 +9855,42 @@ }, "type": "object" }, +"GoogleCloudDialogflowCxV3beta1ExportToolsRequest": { +"description": "The request message for Tools.ExportTools.", +"id": "GoogleCloudDialogflowCxV3beta1ExportToolsRequest", +"properties": { +"dataFormat": { +"description": "Optional. The data format of the exported tools. If not specified, `BLOB` is assumed.", +"enum": [ +"DATA_FORMAT_UNSPECIFIED", +"BLOB", +"JSON" +], +"enumDescriptions": [ +"Unspecified format. Treated as `BLOB`.", +"Tools will be exported as raw bytes.", +"Tools will be exported in JSON format." +], +"type": "string" +}, +"tools": { +"description": "Required. The name of the tools to export. Format: `projects//locations//agents//tools/`.", +"items": { +"type": "string" +}, +"type": "array" +}, +"toolsContentInline": { +"description": "Optional. The option to return the serialized tools inline.", +"type": "boolean" +}, +"toolsUri": { +"description": "Optional. The [Google Cloud Storage](https://cloud.google.com/storage/docs/) URI to export the tools to. The format of this URI must be `gs:///`. Dialogflow performs a write operation for the Cloud Storage object on the caller's behalf, so your request authentication must have write permissions for the object. For more information, see [Dialogflow access control](https://cloud.google.com/dialogflow/cx/docs/concept/access-control#storage).", +"type": "string" +} +}, +"type": "object" +}, "GoogleCloudDialogflowCxV3beta1FilterSpecs": { "description": "Filter specifications for data stores.", "id": "GoogleCloudDialogflowCxV3beta1FilterSpecs", @@ -9204,6 +9992,53 @@ }, "type": "object" }, +"GoogleCloudDialogflowCxV3beta1FlowInvocation": { +"description": "Stores metadata of the invocation of a CX flow. Next Id: 7", +"id": "GoogleCloudDialogflowCxV3beta1FlowInvocation", +"properties": { +"flow": { +"description": "Required. The unique identifier of the flow. Format: `projects//locations//agents/`.", +"type": "string" +}, +"flowState": { +"description": "Required. Flow invocation's output state.", +"enum": [ +"OUTPUT_STATE_UNSPECIFIED", +"OUTPUT_STATE_OK", +"OUTPUT_STATE_CANCELLED", +"OUTPUT_STATE_FAILED", +"OUTPUT_STATE_ESCALATED", +"OUTPUT_STATE_PENDING" +], +"enumDescriptions": [ +"Unspecified output.", +"Succeeded.", +"Cancelled.", +"Failed.", +"Escalated.", +"Pending." +], +"type": "string" +}, +"inputActionParameters": { +"additionalProperties": { +"description": "Properties of the object.", +"type": "any" +}, +"description": "Optional. A list of input parameters for the flow.", +"type": "object" +}, +"outputActionParameters": { +"additionalProperties": { +"description": "Properties of the object.", +"type": "any" +}, +"description": "Optional. A list of output parameters generated by the flow invocation.", +"type": "object" +} +}, +"type": "object" +}, "GoogleCloudDialogflowCxV3beta1FlowMultiLanguageSettings": { "description": "Settings for multi-lingual agents.", "id": "GoogleCloudDialogflowCxV3beta1FlowMultiLanguageSettings", @@ -9480,6 +10315,24 @@ }, "type": "object" }, +"GoogleCloudDialogflowCxV3beta1GenerativeInfo": { +"description": "Represents the information of a query if handled by generative agent resources.", +"id": "GoogleCloudDialogflowCxV3beta1GenerativeInfo", +"properties": { +"actionTracingInfo": { +"$ref": "GoogleCloudDialogflowCxV3beta1Example", +"description": "The actions performed by the generative playbook for the current agent response." +}, +"currentPlaybooks": { +"description": "The stack of playbooks that the conversation has currently entered, with the most recent one on the top.", +"items": { +"type": "string" +}, +"type": "array" +} +}, +"type": "object" +}, "GoogleCloudDialogflowCxV3beta1GenerativeSettings": { "description": "Settings for Generative AI.", "id": "GoogleCloudDialogflowCxV3beta1GenerativeSettings", @@ -9500,6 +10353,10 @@ "description": "Language for this settings.", "type": "string" }, +"llmModelSettings": { +"$ref": "GoogleCloudDialogflowCxV3beta1LlmModelSettings", +"description": "LLM model settings." +}, "name": { "description": "Format: `projects//locations//agents//generativeSettings`.", "type": "string" @@ -9583,6 +10440,10 @@ "description": "Required. The human-readable name of the generator, unique within the agent. The prompt contains pre-defined parameters such as $conversation, $last-user-utterance, etc. populated by Dialogflow. It can also contain custom placeholders which will be resolved during fulfillment.", "type": "string" }, +"llmModelSettings": { +"$ref": "GoogleCloudDialogflowCxV3beta1LlmModelSettings", +"description": "The LLM model settings." +}, "name": { "description": "The unique identifier of the generator. Must be set for the Generators.UpdateGenerator method. Generators.CreateGenerate populates the name automatically. Format: `projects//locations//agents//generators/`.", "type": "string" @@ -10364,6 +11225,24 @@ false }, "type": "object" }, +"GoogleCloudDialogflowCxV3beta1ListExamplesResponse": { +"description": "The response message for Examples.ListExamples.", +"id": "GoogleCloudDialogflowCxV3beta1ListExamplesResponse", +"properties": { +"examples": { +"description": "The list of examples. There will be a maximum number of items returned based on the page_size field in the request.", +"items": { +"$ref": "GoogleCloudDialogflowCxV3beta1Example" +}, +"type": "array" +}, +"nextPageToken": { +"description": "Token to retrieve the next page of results, or empty if there are no more results in the list.", +"type": "string" +} +}, +"type": "object" +}, "GoogleCloudDialogflowCxV3beta1ListExperimentsResponse": { "description": "The response message for Experiments.ListExperiments.", "id": "GoogleCloudDialogflowCxV3beta1ListExperimentsResponse", @@ -10454,6 +11333,42 @@ false }, "type": "object" }, +"GoogleCloudDialogflowCxV3beta1ListPlaybookVersionsResponse": { +"description": "The response message for Playbooks.ListPlaybookVersions.", +"id": "GoogleCloudDialogflowCxV3beta1ListPlaybookVersionsResponse", +"properties": { +"nextPageToken": { +"description": "Token to retrieve the next page of results, or empty if there are no more results in the list.", +"type": "string" +}, +"playbookVersions": { +"description": "The list of playbook version. There will be a maximum number of items returned based on the page_size field in the request.", +"items": { +"$ref": "GoogleCloudDialogflowCxV3beta1PlaybookVersion" +}, +"type": "array" +} +}, +"type": "object" +}, +"GoogleCloudDialogflowCxV3beta1ListPlaybooksResponse": { +"description": "The response message for Playbooks.ListPlaybooks.", +"id": "GoogleCloudDialogflowCxV3beta1ListPlaybooksResponse", +"properties": { +"nextPageToken": { +"description": "Token to retrieve the next page of results, or empty if there are no more results in the list.", +"type": "string" +}, +"playbooks": { +"description": "The list of playbooks. There will be a maximum number of items returned based on the page_size field in the request.", +"items": { +"$ref": "GoogleCloudDialogflowCxV3beta1Playbook" +}, +"type": "array" +} +}, +"type": "object" +}, "GoogleCloudDialogflowCxV3beta1ListSecuritySettingsResponse": { "description": "The response message for SecuritySettings.ListSecuritySettings.", "id": "GoogleCloudDialogflowCxV3beta1ListSecuritySettingsResponse", @@ -10526,6 +11441,24 @@ false }, "type": "object" }, +"GoogleCloudDialogflowCxV3beta1ListToolsResponse": { +"description": "The response message for Tools.ListTools.", +"id": "GoogleCloudDialogflowCxV3beta1ListToolsResponse", +"properties": { +"nextPageToken": { +"description": "Token to retrieve the next page of results, or empty if there are no more results in the list.", +"type": "string" +}, +"tools": { +"description": "The list of Tools. There will be a maximum number of items returned based on the page_size field in the request.", +"items": { +"$ref": "GoogleCloudDialogflowCxV3beta1Tool" +}, +"type": "array" +} +}, +"type": "object" +}, "GoogleCloudDialogflowCxV3beta1ListTransitionRouteGroupsResponse": { "description": "The response message for TransitionRouteGroups.ListTransitionRouteGroups.", "id": "GoogleCloudDialogflowCxV3beta1ListTransitionRouteGroupsResponse", @@ -10580,6 +11513,21 @@ false }, "type": "object" }, +"GoogleCloudDialogflowCxV3beta1LlmModelSettings": { +"description": "Settings for LLM models.", +"id": "GoogleCloudDialogflowCxV3beta1LlmModelSettings", +"properties": { +"model": { +"description": "The selected LLM model.", +"type": "string" +}, +"promptText": { +"description": "The custom prompt to use.", +"type": "string" +} +}, +"type": "object" +}, "GoogleCloudDialogflowCxV3beta1LoadVersionRequest": { "description": "The request message for Versions.LoadVersion.", "id": "GoogleCloudDialogflowCxV3beta1LoadVersionRequest", @@ -10908,26 +11856,288 @@ false "FILLED" ], "enumDescriptions": [ -"Not specified. This value should be never used.", -"Indicates that the parameter does not have a value.", -"Indicates that the parameter value is invalid. This field can be used by the webhook to invalidate the parameter and ask the server to collect it from the user again.", -"Indicates that the parameter has a value." +"Not specified. This value should be never used.", +"Indicates that the parameter does not have a value.", +"Indicates that the parameter value is invalid. This field can be used by the webhook to invalidate the parameter and ask the server to collect it from the user again.", +"Indicates that the parameter has a value." +], +"type": "string" +}, +"value": { +"description": "Optional for both WebhookRequest and WebhookResponse. The value of the parameter. This field can be set by the webhook to change the parameter value.", +"type": "any" +} +}, +"type": "object" +}, +"GoogleCloudDialogflowCxV3beta1ParameterDefinition": { +"description": "Defines the properties of a parameter. Used to define parameters used in the agent and the input / output parameters for each fulfillment.", +"id": "GoogleCloudDialogflowCxV3beta1ParameterDefinition", +"properties": { +"description": { +"description": "Human-readable description of the parameter. Limited to 300 characters.", +"type": "string" +}, +"name": { +"description": "Required. Name of parameter.", +"type": "string" +}, +"type": { +"description": "Required. Type of parameter.", +"enum": [ +"PARAMETER_TYPE_UNSPECIFIED", +"STRING", +"NUMBER", +"BOOLEAN", +"NULL", +"OBJECT", +"LIST" +], +"enumDescriptions": [ +"Not specified. No validation will be performed.", +"Represents any string value.", +"Represents any number value.", +"Represents a boolean value.", +"Represents a null value.", +"Represents any object value.", +"Represents a repeated value." +], +"type": "string" +} +}, +"type": "object" +}, +"GoogleCloudDialogflowCxV3beta1Phrase": { +"description": "Text input which can be used for prompt or banned phrases.", +"id": "GoogleCloudDialogflowCxV3beta1Phrase", +"properties": { +"text": { +"description": "Required. Text input which can be used for prompt or banned phrases.", +"type": "string" +} +}, +"type": "object" +}, +"GoogleCloudDialogflowCxV3beta1Playbook": { +"description": "Playbook is the basic building block to instruct the LLM how to execute a certain task. A playbook consists of a goal to accomplish, an optional list of step by step instructions (the step instruction may refers to name of the custom or default plugin tools to use) to perform the task, a list of contextual input data to be passed in at the beginning of the invoked, and a list of output parameters to store the playbook result.", +"id": "GoogleCloudDialogflowCxV3beta1Playbook", +"properties": { +"createTime": { +"description": "Output only. The timestamp of initial playbook creation.", +"format": "google-datetime", +"readOnly": true, +"type": "string" +}, +"displayName": { +"description": "Required. The human-readable name of the playbook, unique within an agent.", +"type": "string" +}, +"goal": { +"description": "Required. High level description of the goal the playbook intend to accomplish.", +"type": "string" +}, +"inputParameterDefinitions": { +"description": "Optional. Defined structured input parameters for this playbook.", +"items": { +"$ref": "GoogleCloudDialogflowCxV3beta1ParameterDefinition" +}, +"type": "array" +}, +"instruction": { +"$ref": "GoogleCloudDialogflowCxV3beta1PlaybookInstruction", +"description": "Instruction to accomplish target goal." +}, +"llmModelSettings": { +"$ref": "GoogleCloudDialogflowCxV3beta1LlmModelSettings", +"description": "Optional. Llm model settings for the playbook." +}, +"name": { +"description": "The unique identifier of the playbook. Format: `projects//locations//agents//playbooks/`.", +"type": "string" +}, +"outputParameterDefinitions": { +"description": "Optional. Defined structured output parameters for this playbook.", +"items": { +"$ref": "GoogleCloudDialogflowCxV3beta1ParameterDefinition" +}, +"type": "array" +}, +"referencedFlows": { +"description": "Output only. The resource name of flows referenced by the current playbook in the instructions.", +"items": { +"type": "string" +}, +"readOnly": true, +"type": "array" +}, +"referencedPlaybooks": { +"description": "Output only. The resource name of other playbooks referenced by the current playbook in the instructions.", +"items": { +"type": "string" +}, +"readOnly": true, +"type": "array" +}, +"referencedTools": { +"description": "Optional. The resource name of tools referenced by the current playbook in the instructions. If not provided explicitly, they are will be implied using the tool being referenced in goal and steps.", +"items": { +"type": "string" +}, +"type": "array" +}, +"tokenCount": { +"description": "Output only. Estimated number of tokes current playbook takes when sent to the LLM.", +"format": "int64", +"readOnly": true, +"type": "string" +}, +"updateTime": { +"description": "Output only. Last time the playbook version was updated.", +"format": "google-datetime", +"readOnly": true, +"type": "string" +} +}, +"type": "object" +}, +"GoogleCloudDialogflowCxV3beta1PlaybookInput": { +"description": "Input of the playbook.", +"id": "GoogleCloudDialogflowCxV3beta1PlaybookInput", +"properties": { +"actionParameters": { +"additionalProperties": { +"description": "Properties of the object.", +"type": "any" +}, +"description": "Optional. A list of input parameters for the action.", +"type": "object" +}, +"precedingConversationSummary": { +"description": "Optional. Summary string of the preceding conversation for the child playbook invocation.", +"type": "string" +} +}, +"type": "object" +}, +"GoogleCloudDialogflowCxV3beta1PlaybookInstruction": { +"description": "Message of the Instruction of the playbook.", +"id": "GoogleCloudDialogflowCxV3beta1PlaybookInstruction", +"properties": { +"steps": { +"description": "Ordered list of step by step execution instructions to accomplish target goal.", +"items": { +"$ref": "GoogleCloudDialogflowCxV3beta1PlaybookStep" +}, +"type": "array" +} +}, +"type": "object" +}, +"GoogleCloudDialogflowCxV3beta1PlaybookInvocation": { +"description": "Stores metadata of the invocation of a child playbook. Next Id: 5", +"id": "GoogleCloudDialogflowCxV3beta1PlaybookInvocation", +"properties": { +"playbook": { +"description": "Required. The unique identifier of the playbook. Format: `projects//locations//agents//playbooks/`.", +"type": "string" +}, +"playbookInput": { +"$ref": "GoogleCloudDialogflowCxV3beta1PlaybookInput", +"description": "Optional. Input of the child playbook invocation." +}, +"playbookOutput": { +"$ref": "GoogleCloudDialogflowCxV3beta1PlaybookOutput", +"description": "Optional. Output of the child playbook invocation." +}, +"playbookState": { +"description": "Required. Playbook invocation's output state.", +"enum": [ +"OUTPUT_STATE_UNSPECIFIED", +"OUTPUT_STATE_OK", +"OUTPUT_STATE_CANCELLED", +"OUTPUT_STATE_FAILED", +"OUTPUT_STATE_ESCALATED", +"OUTPUT_STATE_PENDING" +], +"enumDescriptions": [ +"Unspecified output.", +"Succeeded.", +"Cancelled.", +"Failed.", +"Escalated.", +"Pending." ], "type": "string" +} }, -"value": { -"description": "Optional for both WebhookRequest and WebhookResponse. The value of the parameter. This field can be set by the webhook to change the parameter value.", +"type": "object" +}, +"GoogleCloudDialogflowCxV3beta1PlaybookOutput": { +"description": "Output of the playbook.", +"id": "GoogleCloudDialogflowCxV3beta1PlaybookOutput", +"properties": { +"actionParameters": { +"additionalProperties": { +"description": "Properties of the object.", "type": "any" +}, +"description": "Optional. A Struct object of output parameters for the action.", +"type": "object" +}, +"executionSummary": { +"description": "Optional. Summary string of the execution result of the child playbook.", +"type": "string" } }, "type": "object" }, -"GoogleCloudDialogflowCxV3beta1Phrase": { -"description": "Text input which can be used for prompt or banned phrases.", -"id": "GoogleCloudDialogflowCxV3beta1Phrase", +"GoogleCloudDialogflowCxV3beta1PlaybookStep": { +"description": "Message of single step execution.", +"id": "GoogleCloudDialogflowCxV3beta1PlaybookStep", "properties": { +"steps": { +"description": "Sub-processing needed to execute the current step.", +"items": { +"$ref": "GoogleCloudDialogflowCxV3beta1PlaybookStep" +}, +"type": "array" +}, "text": { -"description": "Required. Text input which can be used for prompt or banned phrases.", +"description": "Step instruction in text format.", +"type": "string" +} +}, +"type": "object" +}, +"GoogleCloudDialogflowCxV3beta1PlaybookVersion": { +"description": "Playbook version is a snapshot of the playbook at certain timestamp.", +"id": "GoogleCloudDialogflowCxV3beta1PlaybookVersion", +"properties": { +"description": { +"description": "Optional. The description of the playbook version.", +"type": "string" +}, +"examples": { +"description": "Output only. Snapshot of the examples belonging to the playbook when the playbook version is created.", +"items": { +"$ref": "GoogleCloudDialogflowCxV3beta1Example" +}, +"readOnly": true, +"type": "array" +}, +"name": { +"description": "The unique identifier of the playbook version. Format: `projects//locations//agents//playbooks//versions/`.", +"type": "string" +}, +"playbook": { +"$ref": "GoogleCloudDialogflowCxV3beta1Playbook", +"description": "Output only. Snapshot of the playbook when the playbook version is created.", +"readOnly": true +}, +"updateTime": { +"description": "Output only. Last time the playbook version was created or modified.", +"format": "google-datetime", +"readOnly": true, "type": "string" } }, @@ -10960,6 +12170,10 @@ false "text": { "$ref": "GoogleCloudDialogflowCxV3beta1TextInput", "description": "The natural language text to be processed." +}, +"toolCallResult": { +"$ref": "GoogleCloudDialogflowCxV3beta1ToolCallResult", +"description": "The results of a tool executed by the client." } }, "type": "object" @@ -10980,6 +12194,10 @@ false "description": "The unique identifier of the page to override the current page in the session. Format: `projects//locations//agents//flows//pages/`. If `current_page` is specified, the previous state of the session will be ignored by Dialogflow, including the previous page and the previous session parameters. In most cases, current_page and parameters should be configured together to direct a session to a specific state.", "type": "string" }, +"currentPlaybook": { +"description": "Optional. Start the session with the specified playbook. You can only specify the playbook at the beginning of the session. Otherwise, an error will be thrown. Format: `projects//locations//agents//playbooks/`.", +"type": "string" +}, "disableWebhook": { "description": "Whether to disable webhook calls for this request.", "type": "boolean" @@ -11003,6 +12221,10 @@ false "$ref": "GoogleTypeLatLng", "description": "The geo location of this conversational query." }, +"llmModelSettings": { +"$ref": "GoogleCloudDialogflowCxV3beta1LlmModelSettings", +"description": "Optional. Use the specified LLM model settings for processing the request." +}, "parameters": { "additionalProperties": { "description": "Properties of the object.", @@ -11065,6 +12287,10 @@ false "description": "Indicates whether the Thumbs up/Thumbs down rating controls are need to be shown for the response in the Dialogflow Messenger widget.", "type": "boolean" }, +"currentFlow": { +"$ref": "GoogleCloudDialogflowCxV3beta1Flow", +"description": "The current Flow. Some, not all fields are filled in this message, including but not limited to `name` and `display_name`." +}, "currentPage": { "$ref": "GoogleCloudDialogflowCxV3beta1Page", "description": "The current Page. Some, not all fields are filled in this message, including but not limited to `name` and `display_name`." @@ -11085,6 +12311,10 @@ false "$ref": "GoogleCloudDialogflowCxV3beta1DtmfInput", "description": "If a DTMF was provided as input, this field will contain a copy of the DtmfInput." }, +"generativeInfo": { +"$ref": "GoogleCloudDialogflowCxV3beta1GenerativeInfo", +"description": "The information of a query if handled by generative agent resources." +}, "intent": { "$ref": "GoogleCloudDialogflowCxV3beta1Intent", "deprecated": true, @@ -11268,6 +12498,10 @@ false "text": { "$ref": "GoogleCloudDialogflowCxV3beta1ResponseMessageText", "description": "Returns a text response." +}, +"toolCall": { +"$ref": "GoogleCloudDialogflowCxV3beta1ToolCall", +"description": "Returns the definition of a tool call that should be executed by the client." } }, "type": "object" @@ -12016,100 +13250,434 @@ false }, "type": "object" }, -"GoogleCloudDialogflowCxV3beta1TestConfig": { -"description": "Represents configurations for a test case.", -"id": "GoogleCloudDialogflowCxV3beta1TestConfig", +"GoogleCloudDialogflowCxV3beta1TestConfig": { +"description": "Represents configurations for a test case.", +"id": "GoogleCloudDialogflowCxV3beta1TestConfig", +"properties": { +"flow": { +"description": "Flow name to start the test case with. Format: `projects//locations//agents//flows/`. Only one of `flow` and `page` should be set to indicate the starting point of the test case. If both are set, `page` takes precedence over `flow`. If neither is set, the test case will start with start page on the default start flow.", +"type": "string" +}, +"page": { +"description": "The page to start the test case with. Format: `projects//locations//agents//flows//pages/`. Only one of `flow` and `page` should be set to indicate the starting point of the test case. If both are set, `page` takes precedence over `flow`. If neither is set, the test case will start with start page on the default start flow.", +"type": "string" +}, +"trackingParameters": { +"description": "Session parameters to be compared when calculating differences.", +"items": { +"type": "string" +}, +"type": "array" +} +}, +"type": "object" +}, +"GoogleCloudDialogflowCxV3beta1TestError": { +"description": "Error info for running a test.", +"id": "GoogleCloudDialogflowCxV3beta1TestError", +"properties": { +"status": { +"$ref": "GoogleRpcStatus", +"description": "The status associated with the test." +}, +"testCase": { +"description": "The test case resource name.", +"type": "string" +}, +"testTime": { +"description": "The timestamp when the test was completed.", +"format": "google-datetime", +"type": "string" +} +}, +"type": "object" +}, +"GoogleCloudDialogflowCxV3beta1TestRunDifference": { +"description": "The description of differences between original and replayed agent output.", +"id": "GoogleCloudDialogflowCxV3beta1TestRunDifference", +"properties": { +"description": { +"description": "A human readable description of the diff, showing the actual output vs expected output.", +"type": "string" +}, +"type": { +"description": "The type of diff.", +"enum": [ +"DIFF_TYPE_UNSPECIFIED", +"INTENT", +"PAGE", +"PARAMETERS", +"UTTERANCE", +"FLOW" +], +"enumDescriptions": [ +"Should never be used.", +"The intent.", +"The page.", +"The parameters.", +"The message utterance.", +"The flow." +], +"type": "string" +} +}, +"type": "object" +}, +"GoogleCloudDialogflowCxV3beta1TextInput": { +"description": "Represents the natural language text to be processed.", +"id": "GoogleCloudDialogflowCxV3beta1TextInput", +"properties": { +"text": { +"description": "Required. The UTF-8 encoded natural language text to be processed.", +"type": "string" +} +}, +"type": "object" +}, +"GoogleCloudDialogflowCxV3beta1TextToSpeechSettings": { +"description": "Settings related to speech synthesizing.", +"id": "GoogleCloudDialogflowCxV3beta1TextToSpeechSettings", +"properties": { +"synthesizeSpeechConfigs": { +"additionalProperties": { +"$ref": "GoogleCloudDialogflowCxV3beta1SynthesizeSpeechConfig" +}, +"description": "Configuration of how speech should be synthesized, mapping from language (https://cloud.google.com/dialogflow/cx/docs/reference/language) to SynthesizeSpeechConfig. These settings affect: - The [phone gateway](https://cloud.google.com/dialogflow/cx/docs/concept/integration/phone-gateway) synthesize configuration set via Agent.text_to_speech_settings. - How speech is synthesized when invoking session APIs. Agent.text_to_speech_settings only applies if OutputAudioConfig.synthesize_speech_config is not specified.", +"type": "object" +} +}, +"type": "object" +}, +"GoogleCloudDialogflowCxV3beta1Tool": { +"description": "A tool provides a list of actions which are available to the Playbook to attain its goal. A Tool consists of a description of the tool's usage and a specification of the tool which contains the schema and authentication information.", +"id": "GoogleCloudDialogflowCxV3beta1Tool", +"properties": { +"dataStoreSpec": { +"$ref": "GoogleCloudDialogflowCxV3beta1ToolDataStoreTool", +"description": "Data store search tool specification." +}, +"description": { +"description": "Required. High level description of the Tool and its usage.", +"type": "string" +}, +"displayName": { +"description": "Required. The human-readable name of the Tool, unique within an agent.", +"type": "string" +}, +"extensionSpec": { +"$ref": "GoogleCloudDialogflowCxV3beta1ToolExtensionTool", +"description": "Vertex extension tool specification." +}, +"functionSpec": { +"$ref": "GoogleCloudDialogflowCxV3beta1ToolFunctionTool", +"description": "Client side executed function specification." +}, +"name": { +"description": "The unique identifier of the Tool. Format: `projects//locations//agents//tools/`.", +"type": "string" +}, +"openApiSpec": { +"$ref": "GoogleCloudDialogflowCxV3beta1ToolOpenApiTool", +"description": "OpenAPI specification of the Tool." +}, +"toolType": { +"description": "Output only. The tool type.", +"enum": [ +"TOOL_TYPE_UNSPECIFIED", +"CUSTOMIZED_TOOL", +"BUILTIN_TOOL" +], +"enumDescriptions": [ +"Default value. This value is unused.", +"Customer provided tool.", +"First party built-in tool created by Dialogflow which cannot be modified." +], +"readOnly": true, +"type": "string" +} +}, +"type": "object" +}, +"GoogleCloudDialogflowCxV3beta1ToolAuthentication": { +"description": "Authentication information required for API calls", +"id": "GoogleCloudDialogflowCxV3beta1ToolAuthentication", +"properties": { +"apiKeyConfig": { +"$ref": "GoogleCloudDialogflowCxV3beta1ToolAuthenticationApiKeyConfig", +"description": "Config for API key auth." +}, +"oauthConfig": { +"$ref": "GoogleCloudDialogflowCxV3beta1ToolAuthenticationOAuthConfig", +"description": "Config for OAuth." +}, +"serviceAgentAuthConfig": { +"$ref": "GoogleCloudDialogflowCxV3beta1ToolAuthenticationServiceAgentAuthConfig", +"description": "Config for [Diglogflow service agent](https://cloud.google.com/iam/docs/service-agents#dialogflow-service-agent) auth." +} +}, +"type": "object" +}, +"GoogleCloudDialogflowCxV3beta1ToolAuthenticationApiKeyConfig": { +"description": "Config for authentication with API key.", +"id": "GoogleCloudDialogflowCxV3beta1ToolAuthenticationApiKeyConfig", +"properties": { +"apiKey": { +"description": "Required. The API key.", +"type": "string" +}, +"keyName": { +"description": "Required. The parameter name or the header name of the API key. E.g., If the API request is \"https://example.com/act?X-Api-Key=\", \"X-Api-Key\" would be the parameter name.", +"type": "string" +}, +"requestLocation": { +"description": "Required. Key location in the request.", +"enum": [ +"REQUEST_LOCATION_UNSPECIFIED", +"HEADER", +"QUERY_STRING" +], +"enumDescriptions": [ +"Default value. This value is unused.", +"Represents the key in http header.", +"Represents the key in query string." +], +"type": "string" +} +}, +"type": "object" +}, +"GoogleCloudDialogflowCxV3beta1ToolAuthenticationOAuthConfig": { +"description": "Config for authentication with OAuth.", +"id": "GoogleCloudDialogflowCxV3beta1ToolAuthenticationOAuthConfig", +"properties": { +"clientId": { +"description": "Required. The client ID from the OAuth provider.", +"type": "string" +}, +"clientSecret": { +"description": "Required. The client secret from the OAuth provider.", +"type": "string" +}, +"oauthGrantType": { +"description": "Required. OAuth grant types.", +"enum": [ +"OAUTH_GRANT_TYPE_UNSPECIFIED", +"CLIENT_CREDENTIAL" +], +"enumDescriptions": [ +"Default value. This value is unused.", +"Represents the [client credential flow](https://oauth.net/2/grant-types/client-credentials)." +], +"type": "string" +}, +"tokenEndpoint": { +"description": "Required. The token endpoint in the OAuth provider to exchange for an access token.", +"type": "string" +} +}, +"type": "object" +}, +"GoogleCloudDialogflowCxV3beta1ToolAuthenticationServiceAgentAuthConfig": { +"description": "Config for auth using [Diglogflow service agent](https://cloud.google.com/iam/docs/service-agents#dialogflow-service-agent).", +"id": "GoogleCloudDialogflowCxV3beta1ToolAuthenticationServiceAgentAuthConfig", +"properties": {}, +"type": "object" +}, +"GoogleCloudDialogflowCxV3beta1ToolCall": { +"description": "Represents a call of a specific tool's action with the specified inputs.", +"id": "GoogleCloudDialogflowCxV3beta1ToolCall", +"properties": { +"action": { +"description": "Required. The name of the tool's action associated with this call.", +"type": "string" +}, +"inputParameters": { +"additionalProperties": { +"description": "Properties of the object.", +"type": "any" +}, +"description": "Optional. The action's input parameters.", +"type": "object" +}, +"tool": { +"description": "Required. The tool associated with this call. Format: `projects//locations//agents//tools/`.", +"type": "string" +} +}, +"type": "object" +}, +"GoogleCloudDialogflowCxV3beta1ToolCallResult": { +"description": "The result of calling a tool's action that has been executed by the client.", +"id": "GoogleCloudDialogflowCxV3beta1ToolCallResult", +"properties": { +"action": { +"description": "Required. The name of the tool's action associated with this call.", +"type": "string" +}, +"error": { +"$ref": "GoogleCloudDialogflowCxV3beta1ToolCallResultError", +"description": "The tool call's error." +}, +"outputParameters": { +"additionalProperties": { +"description": "Properties of the object.", +"type": "any" +}, +"description": "The tool call's output parameters.", +"type": "object" +}, +"tool": { +"description": "Required. The tool associated with this call. Format: `projects//locations//agents//tools/`.", +"type": "string" +} +}, +"type": "object" +}, +"GoogleCloudDialogflowCxV3beta1ToolCallResultError": { +"description": "An error produced by the tool call.", +"id": "GoogleCloudDialogflowCxV3beta1ToolCallResultError", "properties": { -"flow": { -"description": "Flow name to start the test case with. Format: `projects//locations//agents//flows/`. Only one of `flow` and `page` should be set to indicate the starting point of the test case. If both are set, `page` takes precedence over `flow`. If neither is set, the test case will start with start page on the default start flow.", +"message": { +"description": "Optional. The error message of the function.", "type": "string" +} }, -"page": { -"description": "The page to start the test case with. Format: `projects//locations//agents//flows//pages/`. Only one of `flow` and `page` should be set to indicate the starting point of the test case. If both are set, `page` takes precedence over `flow`. If neither is set, the test case will start with start page on the default start flow.", -"type": "string" +"type": "object" }, -"trackingParameters": { -"description": "Session parameters to be compared when calculating differences.", +"GoogleCloudDialogflowCxV3beta1ToolDataStoreTool": { +"description": "A DataStoreTool is a way to provide specifications needed to search a list of data stores.", +"id": "GoogleCloudDialogflowCxV3beta1ToolDataStoreTool", +"properties": { +"dataStoreConnections": { +"description": "Required. List of data stores to search.", "items": { -"type": "string" +"$ref": "GoogleCloudDialogflowCxV3beta1DataStoreConnection" }, "type": "array" +}, +"fallbackPrompt": { +"$ref": "GoogleCloudDialogflowCxV3beta1ToolDataStoreToolFallbackPrompt", +"description": "Required. Fallback prompt configurations to use." } }, "type": "object" }, -"GoogleCloudDialogflowCxV3beta1TestError": { -"description": "Error info for running a test.", -"id": "GoogleCloudDialogflowCxV3beta1TestError", -"properties": { -"status": { -"$ref": "GoogleRpcStatus", -"description": "The status associated with the test." +"GoogleCloudDialogflowCxV3beta1ToolDataStoreToolFallbackPrompt": { +"description": "A FallbackPrompt is a way to provide specifications for the Data Store fallback prompt when generating responses.", +"id": "GoogleCloudDialogflowCxV3beta1ToolDataStoreToolFallbackPrompt", +"properties": {}, +"type": "object" }, -"testCase": { -"description": "The test case resource name.", +"GoogleCloudDialogflowCxV3beta1ToolExtensionTool": { +"description": "An ExtensionTool is a way to use Vertex Extensions as a tool.", +"id": "GoogleCloudDialogflowCxV3beta1ToolExtensionTool", +"properties": { +"name": { +"description": "Required. The full name of the referenced vertex extension. Formats: `projects/{project}/locations/{location}/extensions/{extension}`", "type": "string" +} }, -"testTime": { -"description": "The timestamp when the test was completed.", -"format": "google-datetime", -"type": "string" +"type": "object" +}, +"GoogleCloudDialogflowCxV3beta1ToolFunctionTool": { +"description": "A Function tool describes the functions to be invoked on the client side.", +"id": "GoogleCloudDialogflowCxV3beta1ToolFunctionTool", +"properties": { +"inputSchema": { +"additionalProperties": { +"description": "Properties of the object.", +"type": "any" +}, +"description": "Optional. The JSON schema is encapsulated in a google.protobuf.Struct to describe the input of the function. This input is a JSON object that contains the function's parameters as properties of the object.", +"type": "object" +}, +"outputSchema": { +"additionalProperties": { +"description": "Properties of the object.", +"type": "any" +}, +"description": "Optional. The JSON schema is encapsulated in a google.protobuf.Struct to describe the output of the function. This output is a JSON object that contains the function's parameters as properties of the object.", +"type": "object" } }, "type": "object" }, -"GoogleCloudDialogflowCxV3beta1TestRunDifference": { -"description": "The description of differences between original and replayed agent output.", -"id": "GoogleCloudDialogflowCxV3beta1TestRunDifference", +"GoogleCloudDialogflowCxV3beta1ToolOpenApiTool": { +"description": "An OpenAPI tool is a way to provide the Tool specifications in the Open API schema format.", +"id": "GoogleCloudDialogflowCxV3beta1ToolOpenApiTool", "properties": { -"description": { -"description": "A human readable description of the diff, showing the actual output vs expected output.", -"type": "string" +"authentication": { +"$ref": "GoogleCloudDialogflowCxV3beta1ToolAuthentication", +"description": "Optional. Authentication information required by the API." }, -"type": { -"description": "The type of diff.", -"enum": [ -"DIFF_TYPE_UNSPECIFIED", -"INTENT", -"PAGE", -"PARAMETERS", -"UTTERANCE", -"FLOW" -], -"enumDescriptions": [ -"Should never be used.", -"The intent.", -"The page.", -"The parameters.", -"The message utterance.", -"The flow." -], +"textSchema": { +"description": "Required. The OpenAPI schema specified as a text.", "type": "string" +}, +"tlsConfig": { +"$ref": "GoogleCloudDialogflowCxV3beta1ToolTLSConfig", +"description": "Optional. TLS configuration for the HTTPS verification." } }, "type": "object" }, -"GoogleCloudDialogflowCxV3beta1TextInput": { -"description": "Represents the natural language text to be processed.", -"id": "GoogleCloudDialogflowCxV3beta1TextInput", +"GoogleCloudDialogflowCxV3beta1ToolTLSConfig": { +"description": "The TLS configuration.", +"id": "GoogleCloudDialogflowCxV3beta1ToolTLSConfig", "properties": { -"text": { -"description": "Required. The UTF-8 encoded natural language text to be processed.", +"caCerts": { +"description": "Required. Specifies a list of allowed custom CA certificates for HTTPS verification.", +"items": { +"$ref": "GoogleCloudDialogflowCxV3beta1ToolTLSConfigCACert" +}, +"type": "array" +} +}, +"type": "object" +}, +"GoogleCloudDialogflowCxV3beta1ToolTLSConfigCACert": { +"description": "The CA certificate.", +"id": "GoogleCloudDialogflowCxV3beta1ToolTLSConfigCACert", +"properties": { +"cert": { +"description": "Required. The allowed custom CA certificates (in DER format) for HTTPS verification. This overrides the default SSL trust store. If this is empty or unspecified, Dialogflow will use Google's default trust store to verify certificates. N.B. Make sure the HTTPS server certificates are signed with \"subject alt name\". For instance a certificate can be self-signed using the following command, openssl x509 -req -days 200 -in example.com.csr \\ -signkey example.com.key \\ -out example.com.crt \\ -extfile <(printf \"\\nsubjectAltName='DNS:www.example.com'\")", +"format": "byte", +"type": "string" +}, +"displayName": { +"description": "Required. The name of the allowed custom CA certificates. This can be used to disambiguate the custom CA certificates.", "type": "string" } }, "type": "object" }, -"GoogleCloudDialogflowCxV3beta1TextToSpeechSettings": { -"description": "Settings related to speech synthesizing.", -"id": "GoogleCloudDialogflowCxV3beta1TextToSpeechSettings", +"GoogleCloudDialogflowCxV3beta1ToolUse": { +"description": "Stores metadata of the invocation of an action supported by a tool.", +"id": "GoogleCloudDialogflowCxV3beta1ToolUse", "properties": { -"synthesizeSpeechConfigs": { +"action": { +"description": "Optional. Name of the action to be called during the tool use.", +"type": "string" +}, +"inputActionParameters": { "additionalProperties": { -"$ref": "GoogleCloudDialogflowCxV3beta1SynthesizeSpeechConfig" +"description": "Properties of the object.", +"type": "any" }, -"description": "Configuration of how speech should be synthesized, mapping from language (https://cloud.google.com/dialogflow/cx/docs/reference/language) to SynthesizeSpeechConfig. These settings affect: - The [phone gateway](https://cloud.google.com/dialogflow/cx/docs/concept/integration/phone-gateway) synthesize configuration set via Agent.text_to_speech_settings. - How speech is synthesized when invoking session APIs. Agent.text_to_speech_settings only applies if OutputAudioConfig.synthesize_speech_config is not specified.", +"description": "Optional. A list of input parameters for the action.", +"type": "object" +}, +"outputActionParameters": { +"additionalProperties": { +"description": "Properties of the object.", +"type": "any" +}, +"description": "Optional. A list of output parameters generated by the action.", "type": "object" +}, +"tool": { +"description": "Required. The tool that should be used. Format: `projects//locations//agents//tools/`.", +"type": "string" } }, "type": "object" @@ -12377,6 +13945,17 @@ false }, "type": "object" }, +"GoogleCloudDialogflowCxV3beta1UserUtterance": { +"description": "UserUtterance represents one message sent by the customer.", +"id": "GoogleCloudDialogflowCxV3beta1UserUtterance", +"properties": { +"text": { +"description": "Required. Message content in text.", +"type": "string" +} +}, +"type": "object" +}, "GoogleCloudDialogflowCxV3beta1ValidateAgentRequest": { "description": "The request message for Agents.ValidateAgent.", "id": "GoogleCloudDialogflowCxV3beta1ValidateAgentRequest", @@ -13130,14 +14709,16 @@ false "ARTICLE_SUGGESTION", "FAQ", "SMART_REPLY", -"KNOWLEDGE_SEARCH" +"KNOWLEDGE_SEARCH", +"KNOWLEDGE_ASSIST" ], "enumDescriptions": [ "Unspecified feature type.", "Run article suggestion model for chat.", "Run FAQ model for chat.", "Run smart reply model for chat.", -"Run knowledge search with text input from agent or text generated query." +"Run knowledge search with text input from agent or text generated query.", +"Run knowledge assist with automatic query generation." ], "type": "string" } @@ -14570,6 +16151,99 @@ true }, "type": "object" }, +"GoogleCloudDialogflowV2KnowledgeAssistAnswer": { +"description": "Represents a Knowledge Assist answer.", +"id": "GoogleCloudDialogflowV2KnowledgeAssistAnswer", +"properties": { +"answerRecord": { +"description": "The name of the answer record. Format: `projects//locations//answer Records/`.", +"type": "string" +}, +"suggestedQuery": { +"$ref": "GoogleCloudDialogflowV2KnowledgeAssistAnswerSuggestedQuery", +"description": "The query suggested based on the context. Suggestion is made only if it is different from the previous suggestion." +}, +"suggestedQueryAnswer": { +"$ref": "GoogleCloudDialogflowV2KnowledgeAssistAnswerKnowledgeAnswer", +"description": "The answer generated for the suggested query. Whether or not an answer is generated depends on how confident we are about the generated query." +} +}, +"type": "object" +}, +"GoogleCloudDialogflowV2KnowledgeAssistAnswerKnowledgeAnswer": { +"description": "Represents an answer from Knowledge. Currently supports FAQ and Generative answers.", +"id": "GoogleCloudDialogflowV2KnowledgeAssistAnswerKnowledgeAnswer", +"properties": { +"answerText": { +"description": "The piece of text from the `source` that answers this suggested query.", +"type": "string" +}, +"faqSource": { +"$ref": "GoogleCloudDialogflowV2KnowledgeAssistAnswerKnowledgeAnswerFaqSource", +"description": "Populated if the prediction came from FAQ." +}, +"generativeSource": { +"$ref": "GoogleCloudDialogflowV2KnowledgeAssistAnswerKnowledgeAnswerGenerativeSource", +"description": "Populated if the prediction was Generative." +} +}, +"type": "object" +}, +"GoogleCloudDialogflowV2KnowledgeAssistAnswerKnowledgeAnswerFaqSource": { +"description": "Details about source of FAQ answer.", +"id": "GoogleCloudDialogflowV2KnowledgeAssistAnswerKnowledgeAnswerFaqSource", +"properties": { +"question": { +"description": "The corresponding FAQ question.", +"type": "string" +} +}, +"type": "object" +}, +"GoogleCloudDialogflowV2KnowledgeAssistAnswerKnowledgeAnswerGenerativeSource": { +"description": "Details about source of Generative answer.", +"id": "GoogleCloudDialogflowV2KnowledgeAssistAnswerKnowledgeAnswerGenerativeSource", +"properties": { +"snippets": { +"description": "All snippets used for this Generative Prediction, with their source URI and data.", +"items": { +"$ref": "GoogleCloudDialogflowV2KnowledgeAssistAnswerKnowledgeAnswerGenerativeSourceSnippet" +}, +"type": "array" +} +}, +"type": "object" +}, +"GoogleCloudDialogflowV2KnowledgeAssistAnswerKnowledgeAnswerGenerativeSourceSnippet": { +"description": "Snippet Source for a Generative Prediction.", +"id": "GoogleCloudDialogflowV2KnowledgeAssistAnswerKnowledgeAnswerGenerativeSourceSnippet", +"properties": { +"text": { +"description": "Text taken from that URI.", +"type": "string" +}, +"title": { +"description": "Title of the document.", +"type": "string" +}, +"uri": { +"description": "URI the data is sourced from.", +"type": "string" +} +}, +"type": "object" +}, +"GoogleCloudDialogflowV2KnowledgeAssistAnswerSuggestedQuery": { +"description": "Represents a suggested query.", +"id": "GoogleCloudDialogflowV2KnowledgeAssistAnswerSuggestedQuery", +"properties": { +"queryText": { +"description": "Suggested query text.", +"type": "string" +} +}, +"type": "object" +}, "GoogleCloudDialogflowV2KnowledgeOperationMetadata": { "description": "Metadata in google::longrunning::Operation for Knowledge operations.", "id": "GoogleCloudDialogflowV2KnowledgeOperationMetadata", @@ -14892,14 +16566,16 @@ true "ARTICLE_SUGGESTION", "FAQ", "SMART_REPLY", -"KNOWLEDGE_SEARCH" +"KNOWLEDGE_SEARCH", +"KNOWLEDGE_ASSIST" ], "enumDescriptions": [ "Unspecified feature type.", "Run article suggestion model for chat.", "Run FAQ model for chat.", "Run smart reply model for chat.", -"Run knowledge search with text input from agent or text generated query." +"Run knowledge search with text input from agent or text generated query.", +"Run knowledge assist with automatic query generation." ], "type": "string" } @@ -14993,6 +16669,27 @@ true }, "type": "object" }, +"GoogleCloudDialogflowV2SuggestKnowledgeAssistResponse": { +"description": "The response message for Participants.SuggestKnowledgeAssist.", +"id": "GoogleCloudDialogflowV2SuggestKnowledgeAssistResponse", +"properties": { +"contextSize": { +"description": "Number of messages prior to and including latest_message to compile the suggestion. It may be smaller than the SuggestKnowledgeAssistRequest.context_size field in the request if there are fewer messages in the conversation.", +"format": "int32", +"type": "integer" +}, +"knowledgeAssistAnswer": { +"$ref": "GoogleCloudDialogflowV2KnowledgeAssistAnswer", +"description": "Output only. Knowledge Assist suggestion.", +"readOnly": true +}, +"latestMessage": { +"description": "The name of the latest conversation message used to compile suggestion for. Format: `projects//locations//conversations//messages/`.", +"type": "string" +} +}, +"type": "object" +}, "GoogleCloudDialogflowV2SuggestSmartRepliesResponse": { "description": "The response message for Participants.SuggestSmartReplies.", "id": "GoogleCloudDialogflowV2SuggestSmartRepliesResponse", @@ -15033,6 +16730,10 @@ true "$ref": "GoogleCloudDialogflowV2SuggestFaqAnswersResponse", "description": "SuggestFaqAnswersResponse if request is for FAQ_ANSWER." }, +"suggestKnowledgeAssistResponse": { +"$ref": "GoogleCloudDialogflowV2SuggestKnowledgeAssistResponse", +"description": "SuggestKnowledgeAssistResponse if request is for KNOWLEDGE_ASSIST." +}, "suggestSmartRepliesResponse": { "$ref": "GoogleCloudDialogflowV2SuggestSmartRepliesResponse", "description": "SuggestSmartRepliesResponse if request is for SMART_REPLY." @@ -15245,7 +16946,8 @@ true "SMART_REPLY", "DIALOGFLOW_ASSIST", "CONVERSATION_SUMMARIZATION", -"KNOWLEDGE_SEARCH" +"KNOWLEDGE_SEARCH", +"KNOWLEDGE_ASSIST" ], "enumDescriptions": [ "Unspecified feature type.", @@ -15254,7 +16956,8 @@ true "Run smart reply model for chat.", "Run Dialogflow assist model for chat, which will return automated agent response as suggestion.", "Run conversation summarization model for chat.", -"Run knowledge search with text input from agent or text generated query." +"Run knowledge search with text input from agent or text generated query.", +"Run knowledge assist with automatic query generation." ], "type": "string" } @@ -16832,6 +18535,99 @@ true }, "type": "object" }, +"GoogleCloudDialogflowV2beta1KnowledgeAssistAnswer": { +"description": "Represents a Knowledge Assist answer.", +"id": "GoogleCloudDialogflowV2beta1KnowledgeAssistAnswer", +"properties": { +"answerRecord": { +"description": "The name of the answer record. Format: `projects//locations//answer Records/`.", +"type": "string" +}, +"suggestedQuery": { +"$ref": "GoogleCloudDialogflowV2beta1KnowledgeAssistAnswerSuggestedQuery", +"description": "The query suggested based on the context. Suggestion is made only if it is different from the previous suggestion." +}, +"suggestedQueryAnswer": { +"$ref": "GoogleCloudDialogflowV2beta1KnowledgeAssistAnswerKnowledgeAnswer", +"description": "The answer generated for the suggested query. Whether or not an answer is generated depends on how confident we are about the generated query." +} +}, +"type": "object" +}, +"GoogleCloudDialogflowV2beta1KnowledgeAssistAnswerKnowledgeAnswer": { +"description": "Represents an answer from Knowledge. Currently supports FAQ and Generative answers.", +"id": "GoogleCloudDialogflowV2beta1KnowledgeAssistAnswerKnowledgeAnswer", +"properties": { +"answerText": { +"description": "The piece of text from the `source` that answers this suggested query.", +"type": "string" +}, +"faqSource": { +"$ref": "GoogleCloudDialogflowV2beta1KnowledgeAssistAnswerKnowledgeAnswerFaqSource", +"description": "Populated if the prediction came from FAQ." +}, +"generativeSource": { +"$ref": "GoogleCloudDialogflowV2beta1KnowledgeAssistAnswerKnowledgeAnswerGenerativeSource", +"description": "Populated if the prediction was Generative." +} +}, +"type": "object" +}, +"GoogleCloudDialogflowV2beta1KnowledgeAssistAnswerKnowledgeAnswerFaqSource": { +"description": "Details about source of FAQ answer.", +"id": "GoogleCloudDialogflowV2beta1KnowledgeAssistAnswerKnowledgeAnswerFaqSource", +"properties": { +"question": { +"description": "The corresponding FAQ question.", +"type": "string" +} +}, +"type": "object" +}, +"GoogleCloudDialogflowV2beta1KnowledgeAssistAnswerKnowledgeAnswerGenerativeSource": { +"description": "Details about source of Generative answer.", +"id": "GoogleCloudDialogflowV2beta1KnowledgeAssistAnswerKnowledgeAnswerGenerativeSource", +"properties": { +"snippets": { +"description": "All snippets used for this Generative Prediction, with their source URI and data.", +"items": { +"$ref": "GoogleCloudDialogflowV2beta1KnowledgeAssistAnswerKnowledgeAnswerGenerativeSourceSnippet" +}, +"type": "array" +} +}, +"type": "object" +}, +"GoogleCloudDialogflowV2beta1KnowledgeAssistAnswerKnowledgeAnswerGenerativeSourceSnippet": { +"description": "Snippet Source for a Generative Prediction.", +"id": "GoogleCloudDialogflowV2beta1KnowledgeAssistAnswerKnowledgeAnswerGenerativeSourceSnippet", +"properties": { +"text": { +"description": "Text taken from that URI.", +"type": "string" +}, +"title": { +"description": "Title of the document.", +"type": "string" +}, +"uri": { +"description": "URI the data is sourced from.", +"type": "string" +} +}, +"type": "object" +}, +"GoogleCloudDialogflowV2beta1KnowledgeAssistAnswerSuggestedQuery": { +"description": "Represents a suggested query.", +"id": "GoogleCloudDialogflowV2beta1KnowledgeAssistAnswerSuggestedQuery", +"properties": { +"queryText": { +"description": "Suggested query text.", +"type": "string" +} +}, +"type": "object" +}, "GoogleCloudDialogflowV2beta1KnowledgeOperationMetadata": { "description": "Metadata in google::longrunning::Operation for Knowledge operations.", "id": "GoogleCloudDialogflowV2beta1KnowledgeOperationMetadata", @@ -17160,7 +18956,8 @@ true "SMART_REPLY", "DIALOGFLOW_ASSIST", "CONVERSATION_SUMMARIZATION", -"KNOWLEDGE_SEARCH" +"KNOWLEDGE_SEARCH", +"KNOWLEDGE_ASSIST" ], "enumDescriptions": [ "Unspecified feature type.", @@ -17169,7 +18966,8 @@ true "Run smart reply model for chat.", "Run Dialogflow assist model for chat, which will return automated agent response as suggestion.", "Run conversation summarization model for chat.", -"Run knowledge search with text input from agent or text generated query." +"Run knowledge search with text input from agent or text generated query.", +"Run knowledge assist with automatic query generation." ], "type": "string" } @@ -17265,6 +19063,27 @@ true }, "type": "object" }, +"GoogleCloudDialogflowV2beta1SuggestKnowledgeAssistResponse": { +"description": "The response message for Participants.SuggestKnowledgeAssist.", +"id": "GoogleCloudDialogflowV2beta1SuggestKnowledgeAssistResponse", +"properties": { +"contextSize": { +"description": "Number of messages prior to and including latest_message to compile the suggestion. It may be smaller than the SuggestKnowledgeAssistRequest.context_size field in the request if there are fewer messages in the conversation.", +"format": "int32", +"type": "integer" +}, +"knowledgeAssistAnswer": { +"$ref": "GoogleCloudDialogflowV2beta1KnowledgeAssistAnswer", +"description": "Output only. Knowledge Assist suggestion.", +"readOnly": true +}, +"latestMessage": { +"description": "The name of the latest conversation message used to compile suggestion for. Format: `projects//locations//conversations//messages/`.", +"type": "string" +} +}, +"type": "object" +}, "GoogleCloudDialogflowV2beta1SuggestSmartRepliesResponse": { "description": "The response message for Participants.SuggestSmartReplies.", "id": "GoogleCloudDialogflowV2beta1SuggestSmartRepliesResponse", @@ -17312,6 +19131,10 @@ true "$ref": "GoogleCloudDialogflowV2beta1SuggestFaqAnswersResponse", "description": "SuggestFaqAnswersResponse if request is for FAQ_ANSWER." }, +"suggestKnowledgeAssistResponse": { +"$ref": "GoogleCloudDialogflowV2beta1SuggestKnowledgeAssistResponse", +"description": "SuggestKnowledgeAssistResponse if request is for KNOWLEDGE_ASSIST." +}, "suggestSmartRepliesResponse": { "$ref": "GoogleCloudDialogflowV2beta1SuggestSmartRepliesResponse", "description": "SuggestSmartRepliesResponse if request is for SMART_REPLY." diff --git a/googleapiclient/discovery_cache/documents/digitalassetlinks.v1.json b/googleapiclient/discovery_cache/documents/digitalassetlinks.v1.json index 9af9e2aa018..7b514955289 100644 --- a/googleapiclient/discovery_cache/documents/digitalassetlinks.v1.json +++ b/googleapiclient/discovery_cache/documents/digitalassetlinks.v1.json @@ -199,7 +199,7 @@ } } }, -"revision": "20240528", +"revision": "20240610", "rootUrl": "https://digitalassetlinks.googleapis.com/", "schemas": { "AndroidAppAsset": { diff --git a/googleapiclient/discovery_cache/documents/discoveryengine.v1.json b/googleapiclient/discovery_cache/documents/discoveryengine.v1.json index af7962de27d..09c2d636a53 100644 --- a/googleapiclient/discovery_cache/documents/discoveryengine.v1.json +++ b/googleapiclient/discovery_cache/documents/discoveryengine.v1.json @@ -789,7 +789,7 @@ "type": "string" }, "parent": { -"description": "Required. Full resource name of parent data store. Format: `projects/{project_number}/locations/{location_id}/collections/{collection_id}/dataStores/{data_store_id}`", +"description": "Required. Full resource name of parent data store. Format: `projects/{project_number}/locations/{location_id}/collections/{collection_id}/dataStores/{data_store_id}` or `projects/{project_number}/locations/{location_id}/collections/{collection_id}/engines/{engine_id}`.", "location": "path", "pattern": "^projects/[^/]+/locations/[^/]+/collections/[^/]+/dataStores/[^/]+$", "required": true, @@ -883,7 +883,7 @@ "type": "string" }, "parent": { -"description": "Required. The data store resource name. Format: `projects/{project_number}/locations/{location_id}/collections/{collection_id}/dataStores/{data_store_id}`", +"description": "Required. The data store resource name. Format: `projects/{project_number}/locations/{location_id}/collections/{collection_id}/dataStores/{data_store_id}` or `projects/{project_number}/locations/{location_id}/collections/{collection_id}/engines/{engine_id}`.", "location": "path", "pattern": "^projects/[^/]+/locations/[^/]+/collections/[^/]+/dataStores/[^/]+$", "required": true, @@ -2594,7 +2594,7 @@ "type": "string" }, "parent": { -"description": "Required. Full resource name of parent data store. Format: `projects/{project_number}/locations/{location_id}/collections/{collection_id}/dataStores/{data_store_id}`", +"description": "Required. Full resource name of parent data store. Format: `projects/{project_number}/locations/{location_id}/collections/{collection_id}/dataStores/{data_store_id}` or `projects/{project_number}/locations/{location_id}/collections/{collection_id}/engines/{engine_id}`.", "location": "path", "pattern": "^projects/[^/]+/locations/[^/]+/collections/[^/]+/engines/[^/]+$", "required": true, @@ -2688,7 +2688,7 @@ "type": "string" }, "parent": { -"description": "Required. The data store resource name. Format: `projects/{project_number}/locations/{location_id}/collections/{collection_id}/dataStores/{data_store_id}`", +"description": "Required. The data store resource name. Format: `projects/{project_number}/locations/{location_id}/collections/{collection_id}/dataStores/{data_store_id}` or `projects/{project_number}/locations/{location_id}/collections/{collection_id}/engines/{engine_id}`.", "location": "path", "pattern": "^projects/[^/]+/locations/[^/]+/collections/[^/]+/engines/[^/]+$", "required": true, @@ -3928,7 +3928,7 @@ "type": "string" }, "parent": { -"description": "Required. Full resource name of parent data store. Format: `projects/{project_number}/locations/{location_id}/collections/{collection_id}/dataStores/{data_store_id}`", +"description": "Required. Full resource name of parent data store. Format: `projects/{project_number}/locations/{location_id}/collections/{collection_id}/dataStores/{data_store_id}` or `projects/{project_number}/locations/{location_id}/collections/{collection_id}/engines/{engine_id}`.", "location": "path", "pattern": "^projects/[^/]+/locations/[^/]+/dataStores/[^/]+$", "required": true, @@ -4022,7 +4022,7 @@ "type": "string" }, "parent": { -"description": "Required. The data store resource name. Format: `projects/{project_number}/locations/{location_id}/collections/{collection_id}/dataStores/{data_store_id}`", +"description": "Required. The data store resource name. Format: `projects/{project_number}/locations/{location_id}/collections/{collection_id}/dataStores/{data_store_id}` or `projects/{project_number}/locations/{location_id}/collections/{collection_id}/engines/{engine_id}`.", "location": "path", "pattern": "^projects/[^/]+/locations/[^/]+/dataStores/[^/]+$", "required": true, @@ -5412,6 +5412,47 @@ }, "userEvents": { "methods": { +"collect": { +"description": "Writes a single user event from the browser. This uses a GET request to due to browser restriction of POST-ing to a third-party domain. This method is used only by the Discovery Engine API JavaScript pixel and Google Tag Manager. Users should not call this method directly.", +"flatPath": "v1/projects/{projectsId}/locations/{locationsId}/userEvents:collect", +"httpMethod": "GET", +"id": "discoveryengine.projects.locations.userEvents.collect", +"parameterOrder": [ +"parent" +], +"parameters": { +"ets": { +"description": "The event timestamp in milliseconds. This prevents browser caching of otherwise identical get requests. The name is abbreviated to reduce the payload bytes.", +"format": "int64", +"location": "query", +"type": "string" +}, +"parent": { +"description": "Required. The parent DataStore resource name, such as `projects/{project}/locations/{location}/collections/{collection}/dataStores/{data_store}`.", +"location": "path", +"pattern": "^projects/[^/]+/locations/[^/]+$", +"required": true, +"type": "string" +}, +"uri": { +"description": "The URL including cgi-parameters but excluding the hash fragment with a length limit of 5,000 characters. This is often more useful than the referer URL, because many browsers only send the domain for third-party requests.", +"location": "query", +"type": "string" +}, +"userEvent": { +"description": "Required. URL encoded UserEvent proto with a length limit of 2,000,000 characters.", +"location": "query", +"type": "string" +} +}, +"path": "v1/{+parent}/userEvents:collect", +"response": { +"$ref": "GoogleApiHttpBody" +}, +"scopes": [ +"https://www.googleapis.com/auth/cloud-platform" +] +}, "write": { "description": "Writes a single user event.", "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/userEvents:write", @@ -5550,7 +5591,7 @@ } } }, -"revision": "20240526", +"revision": "20240607", "rootUrl": "https://discoveryengine.googleapis.com/", "schemas": { "GoogleApiHttpBody": { @@ -5699,6 +5740,37 @@ }, "type": "object" }, +"GoogleCloudDiscoveryengineV1AlloyDbSource": { +"description": "AlloyDB source import data from.", +"id": "GoogleCloudDiscoveryengineV1AlloyDbSource", +"properties": { +"clusterId": { +"description": "Required. The AlloyDB cluster to copy the data from with a length limit of 256 characters.", +"type": "string" +}, +"databaseId": { +"description": "Required. The AlloyDB database to copy the data from with a length limit of 256 characters.", +"type": "string" +}, +"gcsStagingDir": { +"description": "Intermediate Cloud Storage directory used for the import with a length limit of 2,000 characters. Can be specified if one wants to have the AlloyDB export to a specific Cloud Storage directory. Ensure that the AlloyDB service account has the necessary Cloud Storage Admin permissions to access the specified Cloud Storage directory.", +"type": "string" +}, +"locationId": { +"description": "Required. The AlloyDB location to copy the data from with a length limit of 256 characters.", +"type": "string" +}, +"projectId": { +"description": "The project ID that the AlloyDB source is in with a length limit of 128 characters. If not specified, inherits the project ID from the parent request.", +"type": "string" +}, +"tableId": { +"description": "Required. The AlloyDB table to copy the data from with a length limit of 256 characters.", +"type": "string" +} +}, +"type": "object" +}, "GoogleCloudDiscoveryengineV1Answer": { "description": "Defines an answer.", "id": "GoogleCloudDiscoveryengineV1Answer", @@ -5866,6 +5938,13 @@ "description": "The session resource name. Not required. When session field is not set, the API is in sessionless mode. We support auto session mode: users can use the wildcard symbol `-` as session ID. A new ID will be automatically generated and assigned.", "type": "string" }, +"userLabels": { +"additionalProperties": { +"type": "string" +}, +"description": "The user labels applied to a resource must meet the following requirements: * Each resource can have multiple labels, up to a maximum of 64. * Each label must be a key-value pair. * Keys have a minimum length of 1 character and a maximum length of 63 characters and cannot be empty. Values can be empty and have a maximum length of 63 characters. * Keys and values can contain only lowercase letters, numeric characters, underscores, and dashes. All characters must use UTF-8 encoding, and international characters are allowed. * The key portion of a label must be unique. However, you can use the same key with multiple resources. * Keys must start with a lowercase letter or international character. See [Google Cloud Document](https://cloud.google.com/resource-manager/docs/creating-managing-labels#requirements) for more details.", +"type": "object" +}, "userPseudoId": { "description": "A unique identifier for tracking visitors. For example, this could be implemented with an HTTP cookie, which should be able to uniquely identify a visitor on a single device. This unique identifier should not change if the visitor logs in or out of the website. This field should NOT have a fixed value such as `unknown_visitor`. The field must be a UTF-8 encoded string with a length limit of 128 characters. Otherwise, an `INVALID_ARGUMENT` error is returned.", "type": "string" @@ -6044,6 +6123,20 @@ "orderBy": { "description": "The order in which documents are returned. Documents can be ordered by a field in an Document object. Leave it unset if ordered by relevance. `order_by` expression is case-sensitive. For more information on ordering, see [Ordering](https://cloud.google.com/retail/docs/filter-and-order#order) If this field is unrecognizable, an `INVALID_ARGUMENT` is returned.", "type": "string" +}, +"searchResultMode": { +"description": "Specifies the search result mode. If unspecified, the search result mode is based on DataStore.DocumentProcessingConfig.chunking_config: * If DataStore.DocumentProcessingConfig.chunking_config is specified, it defaults to `CHUNKS`. * Otherwise, it defaults to `DOCUMENTS`. See [parse and chunk documents](https://cloud.google.com/generative-ai-app-builder/docs/parse-chunk-documents)", +"enum": [ +"SEARCH_RESULT_MODE_UNSPECIFIED", +"DOCUMENTS", +"CHUNKS" +], +"enumDescriptions": [ +"Default value.", +"Returns documents in the search result.", +"Returns chunks in the search result. Only available if the DataStore.DocumentProcessingConfig.chunking_config is specified." +], +"type": "string" } }, "type": "object" @@ -6832,6 +6925,114 @@ }, "type": "object" }, +"GoogleCloudDiscoveryengineV1Chunk": { +"description": "Chunk captures all raw metadata information of items to be recommended or searched in the chunk mode.", +"id": "GoogleCloudDiscoveryengineV1Chunk", +"properties": { +"chunkMetadata": { +"$ref": "GoogleCloudDiscoveryengineV1ChunkChunkMetadata", +"description": "Output only. Metadata of the current chunk.", +"readOnly": true +}, +"content": { +"description": "Content is a string from a document (parsed content).", +"type": "string" +}, +"derivedStructData": { +"additionalProperties": { +"description": "Properties of the object.", +"type": "any" +}, +"description": "Output only. This field is OUTPUT_ONLY. It contains derived data that are not in the original input document.", +"readOnly": true, +"type": "object" +}, +"documentMetadata": { +"$ref": "GoogleCloudDiscoveryengineV1ChunkDocumentMetadata", +"description": "Metadata of the document from the current chunk." +}, +"id": { +"description": "Unique chunk ID of the current chunk.", +"type": "string" +}, +"name": { +"description": "The full resource name of the chunk. Format: `projects/{project}/locations/{location}/collections/{collection}/dataStores/{data_store}/branches/{branch}/documents/{document_id}/chunks/{chunk_id}`. This field must be a UTF-8 encoded string with a length limit of 1024 characters.", +"type": "string" +}, +"pageSpan": { +"$ref": "GoogleCloudDiscoveryengineV1ChunkPageSpan", +"description": "Page span of the chunk." +}, +"relevanceScore": { +"description": "Output only. Represents the relevance score based on similarity. Higher score indicates higher chunk relevance. The score is in range [-1.0, 1.0]. Only populated on SearchService.SearchResponse.", +"format": "double", +"readOnly": true, +"type": "number" +} +}, +"type": "object" +}, +"GoogleCloudDiscoveryengineV1ChunkChunkMetadata": { +"description": "Metadata of the current chunk. This field is only populated on SearchService.Search API.", +"id": "GoogleCloudDiscoveryengineV1ChunkChunkMetadata", +"properties": { +"nextChunks": { +"description": "The next chunks of the current chunk. The number is controlled by SearchRequest.ContentSearchSpec.ChunkSpec.num_next_chunks. This field is only populated on SearchService.Search API.", +"items": { +"$ref": "GoogleCloudDiscoveryengineV1Chunk" +}, +"type": "array" +}, +"previousChunks": { +"description": "The previous chunks of the current chunk. The number is controlled by SearchRequest.ContentSearchSpec.ChunkSpec.num_previous_chunks. This field is only populated on SearchService.Search API.", +"items": { +"$ref": "GoogleCloudDiscoveryengineV1Chunk" +}, +"type": "array" +} +}, +"type": "object" +}, +"GoogleCloudDiscoveryengineV1ChunkDocumentMetadata": { +"description": "Document metadata contains the information of the document of the current chunk.", +"id": "GoogleCloudDiscoveryengineV1ChunkDocumentMetadata", +"properties": { +"structData": { +"additionalProperties": { +"description": "Properties of the object.", +"type": "any" +}, +"description": "Data representation. The structured JSON data for the document. It should conform to the registered Schema or an `INVALID_ARGUMENT` error is thrown.", +"type": "object" +}, +"title": { +"description": "Title of the document.", +"type": "string" +}, +"uri": { +"description": "Uri of the document.", +"type": "string" +} +}, +"type": "object" +}, +"GoogleCloudDiscoveryengineV1ChunkPageSpan": { +"description": "Page span of the chunk.", +"id": "GoogleCloudDiscoveryengineV1ChunkPageSpan", +"properties": { +"pageEnd": { +"description": "The end page of the chunk.", +"format": "int32", +"type": "integer" +}, +"pageStart": { +"description": "The start page of the chunk.", +"format": "int32", +"type": "integer" +} +}, +"type": "object" +}, "GoogleCloudDiscoveryengineV1CloudSqlSource": { "description": "Cloud SQL source import data from.", "id": "GoogleCloudDiscoveryengineV1CloudSqlSource", @@ -7658,6 +7859,10 @@ "description": "A singleton resource of DataStore. It's empty when DataStore is created, which defaults to digital parser. The first call to DataStoreService.UpdateDocumentProcessingConfig method will initialize the config.", "id": "GoogleCloudDiscoveryengineV1DocumentProcessingConfig", "properties": { +"chunkingConfig": { +"$ref": "GoogleCloudDiscoveryengineV1DocumentProcessingConfigChunkingConfig", +"description": "Whether chunking mode is enabled." +}, "defaultParsingConfig": { "$ref": "GoogleCloudDiscoveryengineV1DocumentProcessingConfigParsingConfig", "description": "Configurations for default Document parser. If not specified, we will configure it as default DigitalParsingConfig, and the default parsing config will be applied to all file types for Document parsing." @@ -7676,6 +7881,33 @@ }, "type": "object" }, +"GoogleCloudDiscoveryengineV1DocumentProcessingConfigChunkingConfig": { +"description": "Configuration for chunking config.", +"id": "GoogleCloudDiscoveryengineV1DocumentProcessingConfigChunkingConfig", +"properties": { +"layoutBasedChunkingConfig": { +"$ref": "GoogleCloudDiscoveryengineV1DocumentProcessingConfigChunkingConfigLayoutBasedChunkingConfig", +"description": "Configuration for the layout based chunking." +} +}, +"type": "object" +}, +"GoogleCloudDiscoveryengineV1DocumentProcessingConfigChunkingConfigLayoutBasedChunkingConfig": { +"description": "Configuration for the layout based chunking.", +"id": "GoogleCloudDiscoveryengineV1DocumentProcessingConfigChunkingConfigLayoutBasedChunkingConfig", +"properties": { +"chunkSize": { +"description": "The token size limit for each chunk. Supported values: 100-500 (inclusive). Default value: 500.", +"format": "int32", +"type": "integer" +}, +"includeAncestorHeadings": { +"description": "Whether to include appending different levels of headings to chunks from the middle of the document to prevent context loss. Default value: False.", +"type": "boolean" +} +}, +"type": "object" +}, "GoogleCloudDiscoveryengineV1DocumentProcessingConfigParsingConfig": { "description": "Related configurations applied to a specific type of document parser.", "id": "GoogleCloudDiscoveryengineV1DocumentProcessingConfigParsingConfig", @@ -7684,6 +7916,10 @@ "$ref": "GoogleCloudDiscoveryengineV1DocumentProcessingConfigParsingConfigDigitalParsingConfig", "description": "Configurations applied to digital parser." }, +"layoutParsingConfig": { +"$ref": "GoogleCloudDiscoveryengineV1DocumentProcessingConfigParsingConfigLayoutParsingConfig", +"description": "Configurations applied to layout parser." +}, "ocrParsingConfig": { "$ref": "GoogleCloudDiscoveryengineV1DocumentProcessingConfigParsingConfigOcrParsingConfig", "description": "Configurations applied to OCR parser. Currently it only applies to PDFs." @@ -7697,6 +7933,12 @@ "properties": {}, "type": "object" }, +"GoogleCloudDiscoveryengineV1DocumentProcessingConfigParsingConfigLayoutParsingConfig": { +"description": "The layout parsing configurations for documents.", +"id": "GoogleCloudDiscoveryengineV1DocumentProcessingConfigParsingConfigLayoutParsingConfig", +"properties": {}, +"type": "object" +}, "GoogleCloudDiscoveryengineV1DocumentProcessingConfigParsingConfigOcrParsingConfig": { "description": "The OCR parsing configurations for documents.", "id": "GoogleCloudDiscoveryengineV1DocumentProcessingConfigParsingConfigOcrParsingConfig", @@ -8086,6 +8328,10 @@ "description": "Request message for Import methods.", "id": "GoogleCloudDiscoveryengineV1ImportDocumentsRequest", "properties": { +"alloyDbSource": { +"$ref": "GoogleCloudDiscoveryengineV1AlloyDbSource", +"description": "AlloyDB input source." +}, "autoGenerateIds": { "description": "Whether to automatically generate IDs for the documents if absent. If set to `true`, Document.ids are automatically generated based on the hash of the payload, where IDs may not be consistent during multiple imports. In which case ReconciliationMode.FULL is highly recommended to avoid duplicate contents. If unset or set to `false`, Document.ids have to be specified using id_field, otherwise, documents without IDs fail to be imported. Supported data sources: * GcsSource. GcsSource.data_schema must be `custom` or `csv`. Otherwise, an INVALID_ARGUMENT error is thrown. * BigQuerySource. BigQuerySource.data_schema must be `custom` or `csv`. Otherwise, an INVALID_ARGUMENT error is thrown. * SpannerSource. * CloudSqlSource. * FirestoreSource. * BigtableSource.", "type": "boolean" @@ -9183,10 +9429,28 @@ "description": "A specification for configuring the behavior of content search.", "id": "GoogleCloudDiscoveryengineV1SearchRequestContentSearchSpec", "properties": { +"chunkSpec": { +"$ref": "GoogleCloudDiscoveryengineV1SearchRequestContentSearchSpecChunkSpec", +"description": "Specifies the chunk spec to be returned from the search response. Only available if the SearchRequest.ContentSearchSpec.search_result_mode is set to CHUNKS" +}, "extractiveContentSpec": { "$ref": "GoogleCloudDiscoveryengineV1SearchRequestContentSearchSpecExtractiveContentSpec", "description": "If there is no extractive_content_spec provided, there will be no extractive answer in the search response." }, +"searchResultMode": { +"description": "Specifies the search result mode. If unspecified, the search result mode is based on DataStore.DocumentProcessingConfig.chunking_config: * If DataStore.DocumentProcessingConfig.chunking_config is specified, it defaults to `CHUNKS`. * Otherwise, it defaults to `DOCUMENTS`.", +"enum": [ +"SEARCH_RESULT_MODE_UNSPECIFIED", +"DOCUMENTS", +"CHUNKS" +], +"enumDescriptions": [ +"Default value.", +"Returns documents in the search result.", +"Returns chunks in the search result. Only available if the DataStore.DocumentProcessingConfig.chunking_config is specified." +], +"type": "string" +}, "snippetSpec": { "$ref": "GoogleCloudDiscoveryengineV1SearchRequestContentSearchSpecSnippetSpec", "description": "If `snippetSpec` is not specified, snippets are not included in the search response." @@ -9198,6 +9462,23 @@ }, "type": "object" }, +"GoogleCloudDiscoveryengineV1SearchRequestContentSearchSpecChunkSpec": { +"description": "Specifies the chunk spec to be returned from the search response. Only available if the SearchRequest.ContentSearchSpec.search_result_mode is set to CHUNKS", +"id": "GoogleCloudDiscoveryengineV1SearchRequestContentSearchSpecChunkSpec", +"properties": { +"numNextChunks": { +"description": "The number of next chunks to be returned of the current chunk. The maximum allowed value is 3. If not specified, no next chunks will be returned.", +"format": "int32", +"type": "integer" +}, +"numPreviousChunks": { +"description": "The number of previous chunks to be returned of the current chunk. The maximum allowed value is 3. If not specified, no previous chunks will be returned.", +"format": "int32", +"type": "integer" +} +}, +"type": "object" +}, "GoogleCloudDiscoveryengineV1SearchRequestContentSearchSpecExtractiveContentSpec": { "description": "A specification for configuring the extractive content in a search response.", "id": "GoogleCloudDiscoveryengineV1SearchRequestContentSearchSpecExtractiveContentSpec", @@ -9567,6 +9848,10 @@ "description": "Represents the search results.", "id": "GoogleCloudDiscoveryengineV1SearchResponseSearchResult", "properties": { +"chunk": { +"$ref": "GoogleCloudDiscoveryengineV1Chunk", +"description": "The chunk data in the search response if the SearchRequest.ContentSearchSpec.search_result_mode is set to CHUNKS." +}, "document": { "$ref": "GoogleCloudDiscoveryengineV1Document", "description": "The document data snippet in the search response. Only fields that are marked as `retrievable` are populated." @@ -13176,6 +13461,10 @@ "description": "A singleton resource of DataStore. It's empty when DataStore is created, which defaults to digital parser. The first call to DataStoreService.UpdateDocumentProcessingConfig method will initialize the config.", "id": "GoogleCloudDiscoveryengineV1betaDocumentProcessingConfig", "properties": { +"chunkingConfig": { +"$ref": "GoogleCloudDiscoveryengineV1betaDocumentProcessingConfigChunkingConfig", +"description": "Whether chunking mode is enabled." +}, "defaultParsingConfig": { "$ref": "GoogleCloudDiscoveryengineV1betaDocumentProcessingConfigParsingConfig", "description": "Configurations for default Document parser. If not specified, we will configure it as default DigitalParsingConfig, and the default parsing config will be applied to all file types for Document parsing." @@ -13194,6 +13483,33 @@ }, "type": "object" }, +"GoogleCloudDiscoveryengineV1betaDocumentProcessingConfigChunkingConfig": { +"description": "Configuration for chunking config.", +"id": "GoogleCloudDiscoveryengineV1betaDocumentProcessingConfigChunkingConfig", +"properties": { +"layoutBasedChunkingConfig": { +"$ref": "GoogleCloudDiscoveryengineV1betaDocumentProcessingConfigChunkingConfigLayoutBasedChunkingConfig", +"description": "Configuration for the layout based chunking." +} +}, +"type": "object" +}, +"GoogleCloudDiscoveryengineV1betaDocumentProcessingConfigChunkingConfigLayoutBasedChunkingConfig": { +"description": "Configuration for the layout based chunking.", +"id": "GoogleCloudDiscoveryengineV1betaDocumentProcessingConfigChunkingConfigLayoutBasedChunkingConfig", +"properties": { +"chunkSize": { +"description": "The token size limit for each chunk. Supported values: 100-500 (inclusive). Default value: 500.", +"format": "int32", +"type": "integer" +}, +"includeAncestorHeadings": { +"description": "Whether to include appending different levels of headings to chunks from the middle of the document to prevent context loss. Default value: False.", +"type": "boolean" +} +}, +"type": "object" +}, "GoogleCloudDiscoveryengineV1betaDocumentProcessingConfigParsingConfig": { "description": "Related configurations applied to a specific type of document parser.", "id": "GoogleCloudDiscoveryengineV1betaDocumentProcessingConfigParsingConfig", @@ -13202,6 +13518,10 @@ "$ref": "GoogleCloudDiscoveryengineV1betaDocumentProcessingConfigParsingConfigDigitalParsingConfig", "description": "Configurations applied to digital parser." }, +"layoutParsingConfig": { +"$ref": "GoogleCloudDiscoveryengineV1betaDocumentProcessingConfigParsingConfigLayoutParsingConfig", +"description": "Configurations applied to layout parser." +}, "ocrParsingConfig": { "$ref": "GoogleCloudDiscoveryengineV1betaDocumentProcessingConfigParsingConfigOcrParsingConfig", "description": "Configurations applied to OCR parser. Currently it only applies to PDFs." @@ -13215,6 +13535,12 @@ "properties": {}, "type": "object" }, +"GoogleCloudDiscoveryengineV1betaDocumentProcessingConfigParsingConfigLayoutParsingConfig": { +"description": "The layout parsing configurations for documents.", +"id": "GoogleCloudDiscoveryengineV1betaDocumentProcessingConfigParsingConfigLayoutParsingConfig", +"properties": {}, +"type": "object" +}, "GoogleCloudDiscoveryengineV1betaDocumentProcessingConfigParsingConfigOcrParsingConfig": { "description": "The OCR parsing configurations for documents.", "id": "GoogleCloudDiscoveryengineV1betaDocumentProcessingConfigParsingConfigOcrParsingConfig", diff --git a/googleapiclient/discovery_cache/documents/discoveryengine.v1alpha.json b/googleapiclient/discovery_cache/documents/discoveryengine.v1alpha.json index d5e70de7353..343ed1697ae 100644 --- a/googleapiclient/discovery_cache/documents/discoveryengine.v1alpha.json +++ b/googleapiclient/discovery_cache/documents/discoveryengine.v1alpha.json @@ -1134,7 +1134,7 @@ "type": "string" }, "parent": { -"description": "Required. Full resource name of parent data store. Format: `projects/{project_number}/locations/{location_id}/collections/{collection_id}/dataStores/{data_store_id}`", +"description": "Required. Full resource name of parent data store. Format: `projects/{project_number}/locations/{location_id}/collections/{collection_id}/dataStores/{data_store_id}` or `projects/{project_number}/locations/{location_id}/collections/{collection_id}/engines/{engine_id}`.", "location": "path", "pattern": "^projects/[^/]+/locations/[^/]+/collections/[^/]+/dataStores/[^/]+$", "required": true, @@ -1228,7 +1228,7 @@ "type": "string" }, "parent": { -"description": "Required. The data store resource name. Format: `projects/{project_number}/locations/{location_id}/collections/{collection_id}/dataStores/{data_store_id}`", +"description": "Required. The data store resource name. Format: `projects/{project_number}/locations/{location_id}/collections/{collection_id}/dataStores/{data_store_id}` or `projects/{project_number}/locations/{location_id}/collections/{collection_id}/engines/{engine_id}`.", "location": "path", "pattern": "^projects/[^/]+/locations/[^/]+/collections/[^/]+/dataStores/[^/]+$", "required": true, @@ -3175,7 +3175,7 @@ "type": "string" }, "parent": { -"description": "Required. Full resource name of parent data store. Format: `projects/{project_number}/locations/{location_id}/collections/{collection_id}/dataStores/{data_store_id}`", +"description": "Required. Full resource name of parent data store. Format: `projects/{project_number}/locations/{location_id}/collections/{collection_id}/dataStores/{data_store_id}` or `projects/{project_number}/locations/{location_id}/collections/{collection_id}/engines/{engine_id}`.", "location": "path", "pattern": "^projects/[^/]+/locations/[^/]+/collections/[^/]+/engines/[^/]+$", "required": true, @@ -3269,7 +3269,7 @@ "type": "string" }, "parent": { -"description": "Required. The data store resource name. Format: `projects/{project_number}/locations/{location_id}/collections/{collection_id}/dataStores/{data_store_id}`", +"description": "Required. The data store resource name. Format: `projects/{project_number}/locations/{location_id}/collections/{collection_id}/dataStores/{data_store_id}` or `projects/{project_number}/locations/{location_id}/collections/{collection_id}/engines/{engine_id}`.", "location": "path", "pattern": "^projects/[^/]+/locations/[^/]+/collections/[^/]+/engines/[^/]+$", "required": true, @@ -4785,7 +4785,7 @@ "type": "string" }, "parent": { -"description": "Required. Full resource name of parent data store. Format: `projects/{project_number}/locations/{location_id}/collections/{collection_id}/dataStores/{data_store_id}`", +"description": "Required. Full resource name of parent data store. Format: `projects/{project_number}/locations/{location_id}/collections/{collection_id}/dataStores/{data_store_id}` or `projects/{project_number}/locations/{location_id}/collections/{collection_id}/engines/{engine_id}`.", "location": "path", "pattern": "^projects/[^/]+/locations/[^/]+/dataStores/[^/]+$", "required": true, @@ -4879,7 +4879,7 @@ "type": "string" }, "parent": { -"description": "Required. The data store resource name. Format: `projects/{project_number}/locations/{location_id}/collections/{collection_id}/dataStores/{data_store_id}`", +"description": "Required. The data store resource name. Format: `projects/{project_number}/locations/{location_id}/collections/{collection_id}/dataStores/{data_store_id}` or `projects/{project_number}/locations/{location_id}/collections/{collection_id}/engines/{engine_id}`.", "location": "path", "pattern": "^projects/[^/]+/locations/[^/]+/dataStores/[^/]+$", "required": true, @@ -6423,6 +6423,38 @@ } } }, +"requirements": { +"methods": { +"checkRequirement": { +"description": "Check a particular requirement.", +"flatPath": "v1alpha/projects/{projectsId}/locations/{locationsId}/requirements:checkRequirement", +"httpMethod": "POST", +"id": "discoveryengine.projects.locations.requirements.checkRequirement", +"parameterOrder": [ +"location" +], +"parameters": { +"location": { +"description": "Required. Full resource name of the location. Format `projects/{project_number_or_id}/locations/{location}`", +"location": "path", +"pattern": "^projects/[^/]+/locations/[^/]+$", +"required": true, +"type": "string" +} +}, +"path": "v1alpha/{+location}/requirements:checkRequirement", +"request": { +"$ref": "GoogleCloudDiscoveryengineV1alphaCheckRequirementRequest" +}, +"response": { +"$ref": "GoogleCloudDiscoveryengineV1alphaCheckRequirementResponse" +}, +"scopes": [ +"https://www.googleapis.com/auth/cloud-platform" +] +} +} +}, "sampleQuerySets": { "resources": { "operations": { @@ -6458,6 +6490,47 @@ }, "userEvents": { "methods": { +"collect": { +"description": "Writes a single user event from the browser. This uses a GET request to due to browser restriction of POST-ing to a third-party domain. This method is used only by the Discovery Engine API JavaScript pixel and Google Tag Manager. Users should not call this method directly.", +"flatPath": "v1alpha/projects/{projectsId}/locations/{locationsId}/userEvents:collect", +"httpMethod": "GET", +"id": "discoveryengine.projects.locations.userEvents.collect", +"parameterOrder": [ +"parent" +], +"parameters": { +"ets": { +"description": "The event timestamp in milliseconds. This prevents browser caching of otherwise identical get requests. The name is abbreviated to reduce the payload bytes.", +"format": "int64", +"location": "query", +"type": "string" +}, +"parent": { +"description": "Required. The parent DataStore resource name, such as `projects/{project}/locations/{location}/collections/{collection}/dataStores/{data_store}`.", +"location": "path", +"pattern": "^projects/[^/]+/locations/[^/]+$", +"required": true, +"type": "string" +}, +"uri": { +"description": "The URL including cgi-parameters but excluding the hash fragment with a length limit of 5,000 characters. This is often more useful than the referer URL, because many browsers only send the domain for third-party requests.", +"location": "query", +"type": "string" +}, +"userEvent": { +"description": "Required. URL encoded UserEvent proto with a length limit of 2,000,000 characters.", +"location": "query", +"type": "string" +} +}, +"path": "v1alpha/{+parent}/userEvents:collect", +"response": { +"$ref": "GoogleApiHttpBody" +}, +"scopes": [ +"https://www.googleapis.com/auth/cloud-platform" +] +}, "write": { "description": "Writes a single user event.", "flatPath": "v1alpha/projects/{projectsId}/locations/{locationsId}/userEvents:write", @@ -6568,9 +6641,177 @@ } } }, -"revision": "20240526", +"revision": "20240607", "rootUrl": "https://discoveryengine.googleapis.com/", "schemas": { +"GoogleApiDistribution": { +"description": "`Distribution` contains summary statistics for a population of values. It optionally contains a histogram representing the distribution of those values across a set of buckets. The summary statistics are the count, mean, sum of the squared deviation from the mean, the minimum, and the maximum of the set of population of values. The histogram is based on a sequence of buckets and gives a count of values that fall into each bucket. The boundaries of the buckets are given either explicitly or by formulas for buckets of fixed or exponentially increasing widths. Although it is not forbidden, it is generally a bad idea to include non-finite values (infinities or NaNs) in the population of values, as this will render the `mean` and `sum_of_squared_deviation` fields meaningless.", +"id": "GoogleApiDistribution", +"properties": { +"bucketCounts": { +"description": "The number of values in each bucket of the histogram, as described in `bucket_options`. If the distribution does not have a histogram, then omit this field. If there is a histogram, then the sum of the values in `bucket_counts` must equal the value in the `count` field of the distribution. If present, `bucket_counts` should contain N values, where N is the number of buckets specified in `bucket_options`. If you supply fewer than N values, the remaining values are assumed to be 0. The order of the values in `bucket_counts` follows the bucket numbering schemes described for the three bucket types. The first value must be the count for the underflow bucket (number 0). The next N-2 values are the counts for the finite buckets (number 1 through N-2). The N'th value in `bucket_counts` is the count for the overflow bucket (number N-1).", +"items": { +"format": "int64", +"type": "string" +}, +"type": "array" +}, +"bucketOptions": { +"$ref": "GoogleApiDistributionBucketOptions", +"description": "Defines the histogram bucket boundaries. If the distribution does not contain a histogram, then omit this field." +}, +"count": { +"description": "The number of values in the population. Must be non-negative. This value must equal the sum of the values in `bucket_counts` if a histogram is provided.", +"format": "int64", +"type": "string" +}, +"exemplars": { +"description": "Must be in increasing order of `value` field.", +"items": { +"$ref": "GoogleApiDistributionExemplar" +}, +"type": "array" +}, +"mean": { +"description": "The arithmetic mean of the values in the population. If `count` is zero then this field must be zero.", +"format": "double", +"type": "number" +}, +"range": { +"$ref": "GoogleApiDistributionRange", +"description": "If specified, contains the range of the population values. The field must not be present if the `count` is zero." +}, +"sumOfSquaredDeviation": { +"description": "The sum of squared deviations from the mean of the values in the population. For values x_i this is: Sum[i=1..n]((x_i - mean)^2) Knuth, \"The Art of Computer Programming\", Vol. 2, page 232, 3rd edition describes Welford's method for accumulating this sum in one pass. If `count` is zero then this field must be zero.", +"format": "double", +"type": "number" +} +}, +"type": "object" +}, +"GoogleApiDistributionBucketOptions": { +"description": "`BucketOptions` describes the bucket boundaries used to create a histogram for the distribution. The buckets can be in a linear sequence, an exponential sequence, or each bucket can be specified explicitly. `BucketOptions` does not include the number of values in each bucket. A bucket has an inclusive lower bound and exclusive upper bound for the values that are counted for that bucket. The upper bound of a bucket must be strictly greater than the lower bound. The sequence of N buckets for a distribution consists of an underflow bucket (number 0), zero or more finite buckets (number 1 through N - 2) and an overflow bucket (number N - 1). The buckets are contiguous: the lower bound of bucket i (i > 0) is the same as the upper bound of bucket i - 1. The buckets span the whole range of finite values: lower bound of the underflow bucket is -infinity and the upper bound of the overflow bucket is +infinity. The finite buckets are so-called because both bounds are finite.", +"id": "GoogleApiDistributionBucketOptions", +"properties": { +"explicitBuckets": { +"$ref": "GoogleApiDistributionBucketOptionsExplicit", +"description": "The explicit buckets." +}, +"exponentialBuckets": { +"$ref": "GoogleApiDistributionBucketOptionsExponential", +"description": "The exponential buckets." +}, +"linearBuckets": { +"$ref": "GoogleApiDistributionBucketOptionsLinear", +"description": "The linear bucket." +} +}, +"type": "object" +}, +"GoogleApiDistributionBucketOptionsExplicit": { +"description": "Specifies a set of buckets with arbitrary widths. There are `size(bounds) + 1` (= N) buckets. Bucket `i` has the following boundaries: Upper bound (0 <= i < N-1): bounds[i] Lower bound (1 <= i < N); bounds[i - 1] The `bounds` field must contain at least one element. If `bounds` has only one element, then there are no finite buckets, and that single element is the common boundary of the overflow and underflow buckets.", +"id": "GoogleApiDistributionBucketOptionsExplicit", +"properties": { +"bounds": { +"description": "The values must be monotonically increasing.", +"items": { +"format": "double", +"type": "number" +}, +"type": "array" +} +}, +"type": "object" +}, +"GoogleApiDistributionBucketOptionsExponential": { +"description": "Specifies an exponential sequence of buckets that have a width that is proportional to the value of the lower bound. Each bucket represents a constant relative uncertainty on a specific value in the bucket. There are `num_finite_buckets + 2` (= N) buckets. Bucket `i` has the following boundaries: Upper bound (0 <= i < N-1): scale * (growth_factor ^ i). Lower bound (1 <= i < N): scale * (growth_factor ^ (i - 1)).", +"id": "GoogleApiDistributionBucketOptionsExponential", +"properties": { +"growthFactor": { +"description": "Must be greater than 1.", +"format": "double", +"type": "number" +}, +"numFiniteBuckets": { +"description": "Must be greater than 0.", +"format": "int32", +"type": "integer" +}, +"scale": { +"description": "Must be greater than 0.", +"format": "double", +"type": "number" +} +}, +"type": "object" +}, +"GoogleApiDistributionBucketOptionsLinear": { +"description": "Specifies a linear sequence of buckets that all have the same width (except overflow and underflow). Each bucket represents a constant absolute uncertainty on the specific value in the bucket. There are `num_finite_buckets + 2` (= N) buckets. Bucket `i` has the following boundaries: Upper bound (0 <= i < N-1): offset + (width * i). Lower bound (1 <= i < N): offset + (width * (i - 1)).", +"id": "GoogleApiDistributionBucketOptionsLinear", +"properties": { +"numFiniteBuckets": { +"description": "Must be greater than 0.", +"format": "int32", +"type": "integer" +}, +"offset": { +"description": "Lower bound of the first bucket.", +"format": "double", +"type": "number" +}, +"width": { +"description": "Must be greater than 0.", +"format": "double", +"type": "number" +} +}, +"type": "object" +}, +"GoogleApiDistributionExemplar": { +"description": "Exemplars are example points that may be used to annotate aggregated distribution values. They are metadata that gives information about a particular value added to a Distribution bucket, such as a trace ID that was active when a value was added. They may contain further information, such as a example values and timestamps, origin, etc.", +"id": "GoogleApiDistributionExemplar", +"properties": { +"attachments": { +"description": "Contextual information about the example value. Examples are: Trace: type.googleapis.com/google.monitoring.v3.SpanContext Literal string: type.googleapis.com/google.protobuf.StringValue Labels dropped during aggregation: type.googleapis.com/google.monitoring.v3.DroppedLabels There may be only a single attachment of any given message type in a single exemplar, and this is enforced by the system.", +"items": { +"additionalProperties": { +"description": "Properties of the object. Contains field @type with type URL.", +"type": "any" +}, +"type": "object" +}, +"type": "array" +}, +"timestamp": { +"description": "The observation (sampling) time of the above value.", +"format": "google-datetime", +"type": "string" +}, +"value": { +"description": "Value of the exemplar point. This value determines to which bucket the exemplar belongs.", +"format": "double", +"type": "number" +} +}, +"type": "object" +}, +"GoogleApiDistributionRange": { +"description": "The range of the population values.", +"id": "GoogleApiDistributionRange", +"properties": { +"max": { +"description": "The maximum of the population values.", +"format": "double", +"type": "number" +}, +"min": { +"description": "The minimum of the population values.", +"format": "double", +"type": "number" +} +}, +"type": "object" +}, "GoogleApiHttpBody": { "description": "Message that represents an arbitrary HTTP body. It should only be used for payload formats that can't be represented as JSON, such as raw binary or an HTML page. This message can be used both in streaming and non-streaming API methods in the request as well as the response. It can be used as a top-level request field, which is convenient if one wants to extract parameters from either the URL or HTTP template into the request fields and also want access to the raw HTTP body. Example: message GetResourceRequest { // A unique request id. string request_id = 1; // The raw HTTP body is bound to this field. google.api.HttpBody http_body = 2; } service ResourceService { rpc GetResource(GetResourceRequest) returns (google.api.HttpBody); rpc UpdateResource(google.api.HttpBody) returns (google.protobuf.Empty); } Example with streaming methods: service CaldavService { rpc GetCalendar(stream google.api.HttpBody) returns (stream google.api.HttpBody); rpc UpdateCalendar(stream google.api.HttpBody) returns (stream google.api.HttpBody); } Use of this type only changes how the request and response bodies are handled, all other features will continue to work unchanged.", "id": "GoogleApiHttpBody", @@ -6598,6 +6839,24 @@ }, "type": "object" }, +"GoogleApiMonitoredResource": { +"description": "An object representing a resource that can be used for monitoring, logging, billing, or other purposes. Examples include virtual machine instances, databases, and storage devices such as disks. The `type` field identifies a MonitoredResourceDescriptor object that describes the resource's schema. Information in the `labels` field identifies the actual resource and its attributes according to the schema. For example, a particular Compute Engine VM instance could be represented by the following object, because the MonitoredResourceDescriptor for `\"gce_instance\"` has labels `\"project_id\"`, `\"instance_id\"` and `\"zone\"`: { \"type\": \"gce_instance\", \"labels\": { \"project_id\": \"my-project\", \"instance_id\": \"12345678901234\", \"zone\": \"us-central1-a\" }}", +"id": "GoogleApiMonitoredResource", +"properties": { +"labels": { +"additionalProperties": { +"type": "string" +}, +"description": "Required. Values for all of the labels listed in the associated monitored resource descriptor. For example, Compute Engine VM instances use the labels `\"project_id\"`, `\"instance_id\"`, and `\"zone\"`.", +"type": "object" +}, +"type": { +"description": "Required. The monitored resource type. This field must match the `type` field of a MonitoredResourceDescriptor object. For example, the type of a Compute Engine VM instance is `gce_instance`. Some descriptors include the service name in the type; for example, the type of a Datastream stream is `datastream.googleapis.com/Stream`.", +"type": "string" +} +}, +"type": "object" +}, "GoogleCloudDiscoveryengineLoggingErrorContext": { "description": "A description of the context in which an error occurred.", "id": "GoogleCloudDiscoveryengineLoggingErrorContext", @@ -7192,6 +7451,10 @@ "description": "A singleton resource of DataStore. It's empty when DataStore is created, which defaults to digital parser. The first call to DataStoreService.UpdateDocumentProcessingConfig method will initialize the config.", "id": "GoogleCloudDiscoveryengineV1DocumentProcessingConfig", "properties": { +"chunkingConfig": { +"$ref": "GoogleCloudDiscoveryengineV1DocumentProcessingConfigChunkingConfig", +"description": "Whether chunking mode is enabled." +}, "defaultParsingConfig": { "$ref": "GoogleCloudDiscoveryengineV1DocumentProcessingConfigParsingConfig", "description": "Configurations for default Document parser. If not specified, we will configure it as default DigitalParsingConfig, and the default parsing config will be applied to all file types for Document parsing." @@ -7210,6 +7473,33 @@ }, "type": "object" }, +"GoogleCloudDiscoveryengineV1DocumentProcessingConfigChunkingConfig": { +"description": "Configuration for chunking config.", +"id": "GoogleCloudDiscoveryengineV1DocumentProcessingConfigChunkingConfig", +"properties": { +"layoutBasedChunkingConfig": { +"$ref": "GoogleCloudDiscoveryengineV1DocumentProcessingConfigChunkingConfigLayoutBasedChunkingConfig", +"description": "Configuration for the layout based chunking." +} +}, +"type": "object" +}, +"GoogleCloudDiscoveryengineV1DocumentProcessingConfigChunkingConfigLayoutBasedChunkingConfig": { +"description": "Configuration for the layout based chunking.", +"id": "GoogleCloudDiscoveryengineV1DocumentProcessingConfigChunkingConfigLayoutBasedChunkingConfig", +"properties": { +"chunkSize": { +"description": "The token size limit for each chunk. Supported values: 100-500 (inclusive). Default value: 500.", +"format": "int32", +"type": "integer" +}, +"includeAncestorHeadings": { +"description": "Whether to include appending different levels of headings to chunks from the middle of the document to prevent context loss. Default value: False.", +"type": "boolean" +} +}, +"type": "object" +}, "GoogleCloudDiscoveryengineV1DocumentProcessingConfigParsingConfig": { "description": "Related configurations applied to a specific type of document parser.", "id": "GoogleCloudDiscoveryengineV1DocumentProcessingConfigParsingConfig", @@ -7218,6 +7508,10 @@ "$ref": "GoogleCloudDiscoveryengineV1DocumentProcessingConfigParsingConfigDigitalParsingConfig", "description": "Configurations applied to digital parser." }, +"layoutParsingConfig": { +"$ref": "GoogleCloudDiscoveryengineV1DocumentProcessingConfigParsingConfigLayoutParsingConfig", +"description": "Configurations applied to layout parser." +}, "ocrParsingConfig": { "$ref": "GoogleCloudDiscoveryengineV1DocumentProcessingConfigParsingConfigOcrParsingConfig", "description": "Configurations applied to OCR parser. Currently it only applies to PDFs." @@ -7231,6 +7525,12 @@ "properties": {}, "type": "object" }, +"GoogleCloudDiscoveryengineV1DocumentProcessingConfigParsingConfigLayoutParsingConfig": { +"description": "The layout parsing configurations for documents.", +"id": "GoogleCloudDiscoveryengineV1DocumentProcessingConfigParsingConfigLayoutParsingConfig", +"properties": {}, +"type": "object" +}, "GoogleCloudDiscoveryengineV1DocumentProcessingConfigParsingConfigOcrParsingConfig": { "description": "The OCR parsing configurations for documents.", "id": "GoogleCloudDiscoveryengineV1DocumentProcessingConfigParsingConfigOcrParsingConfig", @@ -7979,6 +8279,37 @@ }, "type": "object" }, +"GoogleCloudDiscoveryengineV1alphaAlloyDbSource": { +"description": "AlloyDB source import data from.", +"id": "GoogleCloudDiscoveryengineV1alphaAlloyDbSource", +"properties": { +"clusterId": { +"description": "Required. The AlloyDB cluster to copy the data from with a length limit of 256 characters.", +"type": "string" +}, +"databaseId": { +"description": "Required. The AlloyDB database to copy the data from with a length limit of 256 characters.", +"type": "string" +}, +"gcsStagingDir": { +"description": "Intermediate Cloud Storage directory used for the import with a length limit of 2,000 characters. Can be specified if one wants to have the AlloyDB export to a specific Cloud Storage directory. Ensure that the AlloyDB service account has the necessary Cloud Storage Admin permissions to access the specified Cloud Storage directory.", +"type": "string" +}, +"locationId": { +"description": "Required. The AlloyDB location to copy the data from with a length limit of 256 characters.", +"type": "string" +}, +"projectId": { +"description": "The project ID that the AlloyDB source is in with a length limit of 128 characters. If not specified, inherits the project ID from the parent request.", +"type": "string" +}, +"tableId": { +"description": "Required. The AlloyDB table to copy the data from with a length limit of 256 characters.", +"type": "string" +} +}, +"type": "object" +}, "GoogleCloudDiscoveryengineV1alphaAnswer": { "description": "Defines an answer.", "id": "GoogleCloudDiscoveryengineV1alphaAnswer", @@ -8146,6 +8477,13 @@ "description": "The session resource name. Not required. When session field is not set, the API is in sessionless mode. We support auto session mode: users can use the wildcard symbol `-` as session ID. A new ID will be automatically generated and assigned.", "type": "string" }, +"userLabels": { +"additionalProperties": { +"type": "string" +}, +"description": "The user labels applied to a resource must meet the following requirements: * Each resource can have multiple labels, up to a maximum of 64. * Each label must be a key-value pair. * Keys have a minimum length of 1 character and a maximum length of 63 characters and cannot be empty. Values can be empty and have a maximum length of 63 characters. * Keys and values can contain only lowercase letters, numeric characters, underscores, and dashes. All characters must use UTF-8 encoding, and international characters are allowed. * The key portion of a label must be unique. However, you can use the same key with multiple resources. * Keys must start with a lowercase letter or international character. See [Google Cloud Document](https://cloud.google.com/resource-manager/docs/creating-managing-labels#requirements) for more details.", +"type": "object" +}, "userPseudoId": { "description": "A unique identifier for tracking visitors. For example, this could be implemented with an HTTP cookie, which should be able to uniquely identify a visitor on a single device. This unique identifier should not change if the visitor logs in or out of the website. This field should NOT have a fixed value such as `unknown_visitor`. The field must be a UTF-8 encoded string with a length limit of 128 characters. Otherwise, an `INVALID_ARGUMENT` error is returned.", "type": "string" @@ -9135,6 +9473,95 @@ }, "type": "object" }, +"GoogleCloudDiscoveryengineV1alphaCheckRequirementRequest": { +"description": "Request for CheckRequirement method.", +"id": "GoogleCloudDiscoveryengineV1alphaCheckRequirementRequest", +"properties": { +"requirementType": { +"description": "A Requirement.type specifying the requirement to check.", +"type": "string" +}, +"resources": { +"description": "The resources to be checked for this requirement.", +"items": { +"$ref": "GoogleApiMonitoredResource" +}, +"type": "array" +} +}, +"type": "object" +}, +"GoogleCloudDiscoveryengineV1alphaCheckRequirementResponse": { +"description": "Response for CheckRequirement method.", +"id": "GoogleCloudDiscoveryengineV1alphaCheckRequirementResponse", +"properties": { +"metricResults": { +"description": "Metric results.", +"items": { +"$ref": "GoogleCloudDiscoveryengineV1alphaCheckRequirementResponseMetricQueryResult" +}, +"type": "array" +}, +"oldestMetricTimestamp": { +"description": "Timestamp of the oldest calculated metric (i.e. the most stale metric). Indicates that the `requirement_result` may not accurately reflect any Event and Product Catalog updates performed after this time.", +"format": "google-datetime", +"type": "string" +}, +"requirement": { +"$ref": "GoogleCloudDiscoveryengineV1alphaRequirement", +"description": "Requirement definition." +}, +"requirementCondition": { +"$ref": "GoogleTypeExpr", +"description": "The condition for evaluating the requirement result." +}, +"requirementResult": { +"description": "Requirement result, e.g. pass or fail.", +"enum": [ +"UNKNOWN", +"SUCCESS", +"FAILURE", +"WARNING" +], +"enumDescriptions": [ +"The requirement is unknown.", +"The requirement check is passed.", +"The requirement check fails to meet at least one blocking threshold.", +"The requirement check fails at least one warning threshold, but passes all blocking thresholds." +], +"type": "string" +} +}, +"type": "object" +}, +"GoogleCloudDiscoveryengineV1alphaCheckRequirementResponseMetricQueryResult": { +"description": "Metric result. The metric are in the requirement_condition.", +"id": "GoogleCloudDiscoveryengineV1alphaCheckRequirementResponseMetricQueryResult", +"properties": { +"metricType": { +"description": "Type identifier of the metric corresponding to this query result.", +"type": "string" +}, +"name": { +"description": "This metric query name is mapping to variables in the requirement_condition.", +"type": "string" +}, +"timestamp": { +"description": "Time corresponding to when this metric value was calculated.", +"format": "google-datetime", +"type": "string" +}, +"unit": { +"description": "The unit in which this metric is reported. Follows [The Unified Code for Units of Measure](https://unitsofmeasure.org/ucum.html) standard.", +"type": "string" +}, +"value": { +"$ref": "GoogleMonitoringV3TypedValue", +"description": "Value of the metric query." +} +}, +"type": "object" +}, "GoogleCloudDiscoveryengineV1alphaChunk": { "description": "Chunk captures all raw metadata information of items to be recommended or searched in the chunk mode.", "id": "GoogleCloudDiscoveryengineV1alphaChunk", @@ -11090,6 +11517,10 @@ "description": "Request message for Import methods.", "id": "GoogleCloudDiscoveryengineV1alphaImportDocumentsRequest", "properties": { +"alloyDbSource": { +"$ref": "GoogleCloudDiscoveryengineV1alphaAlloyDbSource", +"description": "AlloyDB input source." +}, "autoGenerateIds": { "description": "Whether to automatically generate IDs for the documents if absent. If set to `true`, Document.ids are automatically generated based on the hash of the payload, where IDs may not be consistent during multiple imports. In which case ReconciliationMode.FULL is highly recommended to avoid duplicate contents. If unset or set to `false`, Document.ids have to be specified using id_field, otherwise, documents without IDs fail to be imported. Supported data sources: * GcsSource. GcsSource.data_schema must be `custom` or `csv`. Otherwise, an INVALID_ARGUMENT error is thrown. * BigQuerySource. BigQuerySource.data_schema must be `custom` or `csv`. Otherwise, an INVALID_ARGUMENT error is thrown. * SpannerSource. * CloudSqlSource. * FirestoreSource. * BigtableSource.", "type": "boolean" @@ -12342,6 +12773,121 @@ }, "type": "object" }, +"GoogleCloudDiscoveryengineV1alphaRequirement": { +"description": "A data requirement.", +"id": "GoogleCloudDiscoveryengineV1alphaRequirement", +"properties": { +"condition": { +"$ref": "GoogleTypeExpr", +"description": "The condition for evaluating the requirement result. Variables in the expression should be provided by `metrics_bindings` or `threshold_bindings`. Where `metrics_bindings` are used for computed metrics and `threshold_bindings` are used to define thresholds for corresponding `metric_bindings`." +}, +"description": { +"description": "The description of the requirement.", +"type": "string" +}, +"displayName": { +"description": "The name of the requirement.", +"type": "string" +}, +"metricBindings": { +"description": "A list of the metric bindings to be used in `condition`.", +"items": { +"$ref": "GoogleCloudDiscoveryengineV1alphaRequirementMetricBinding" +}, +"type": "array" +}, +"thresholdBindings": { +"description": "A list of threshold bindings to be used in `condition`.", +"items": { +"$ref": "GoogleCloudDiscoveryengineV1alphaRequirementThresholdBinding" +}, +"type": "array" +}, +"type": { +"description": "The requirement type, used as an identifier. Must be unique. The type should prefix with service name to avoid possible collision. It's encoraged to use natural hierarchical grouping for similar requirements. Examples: * `library.googleapis.com/books/min_available_books` * `discoveryengine.googleapis.com/media_rec/recommended_for_you/conversion_rate`", +"type": "string" +}, +"violationSamplesBindings": { +"description": "A list of the metric bindings to be used in `condition`.", +"items": { +"$ref": "GoogleCloudDiscoveryengineV1alphaRequirementViolationSamplesBinding" +}, +"type": "array" +} +}, +"type": "object" +}, +"GoogleCloudDiscoveryengineV1alphaRequirementMetricBinding": { +"description": "Specifies a metrics query and bind its result to a variable which will be used in the `condition`.", +"id": "GoogleCloudDiscoveryengineV1alphaRequirementMetricBinding", +"properties": { +"category": { +"description": "The category of the metric's target resource. Example: \"Events\"", +"type": "string" +}, +"description": { +"description": "Human readable description of the corresponding metric filter.", +"type": "string" +}, +"metricFilter": { +"description": "The filter string used for metrics query. Example: \"metric.type = \\\"discoveryengine.googleapis.com/events/day_count\\\" AND \" \"metric.conditions.time_range = \\\"NINETY_DAYS\\\"\"", +"type": "string" +}, +"resourceType": { +"description": "The resource being monitored for the metric.", +"type": "string" +}, +"variableId": { +"description": "The variable id to be referenced in `condition`.", +"type": "string" +} +}, +"type": "object" +}, +"GoogleCloudDiscoveryengineV1alphaRequirementThresholdBinding": { +"description": "Specifies a multi-level threshold to apply to apply to a `metric_bindings` in the `condition` CEL expression.", +"id": "GoogleCloudDiscoveryengineV1alphaRequirementThresholdBinding", +"properties": { +"blockingThreshold": { +"description": "Threshold to trigger a blocking failure. If not met, the requirement will evaluate as a `FAILURE`.", +"format": "double", +"type": "number" +}, +"description": { +"description": "Human readable description of the corresponding threshold and sub-requirement.", +"type": "string" +}, +"variableId": { +"description": "The variable id to be referenced in `condition`. Must be unique across all `metric_bindings` and `threshold_bindings`.", +"type": "string" +}, +"warningThreshold": { +"description": "Threshold to trigger a warning. If not met, the requirement will evaluate as a `WARNING`.", +"format": "double", +"type": "number" +} +}, +"type": "object" +}, +"GoogleCloudDiscoveryengineV1alphaRequirementViolationSamplesBinding": { +"description": "Specifies a samples query and bind its result to a variable which will be used in the `condition`.", +"id": "GoogleCloudDiscoveryengineV1alphaRequirementViolationSamplesBinding", +"properties": { +"description": { +"description": "Description of this sample binding. Used by the UI to render user friendly descriptions for each requirement condition. Should be less than 128 characters long.", +"type": "string" +}, +"sampleFilter": { +"description": "The filter string used for samples query. Example: \"sample.type = \\\"retail.googleapis.com/user_event\\\" AND \" \"sample.labels.event_type = \\\"PURCHASE\\\" \"", +"type": "string" +}, +"variableId": { +"description": "The variable id to be referenced in `condition`.", +"type": "string" +} +}, +"type": "object" +}, "GoogleCloudDiscoveryengineV1alphaResumeEngineRequest": { "description": "Request for resuming training of an engine.", "id": "GoogleCloudDiscoveryengineV1alphaResumeEngineRequest", @@ -12619,7 +13165,7 @@ "description": "If there is no extractive_content_spec provided, there will be no extractive answer in the search response." }, "searchResultMode": { -"description": "Specifies the search result mode. If unspecified, the search result mode defaults to `DOCUMENTS`.", +"description": "Specifies the search result mode. If unspecified, the search result mode is based on DataStore.DocumentProcessingConfig.chunking_config: * If DataStore.DocumentProcessingConfig.chunking_config is specified, it defaults to `CHUNKS`. * Otherwise, it defaults to `DOCUMENTS`.", "enum": [ "SEARCH_RESULT_MODE_UNSPECIFIED", "DOCUMENTS", @@ -14597,6 +15143,10 @@ "description": "A singleton resource of DataStore. It's empty when DataStore is created, which defaults to digital parser. The first call to DataStoreService.UpdateDocumentProcessingConfig method will initialize the config.", "id": "GoogleCloudDiscoveryengineV1betaDocumentProcessingConfig", "properties": { +"chunkingConfig": { +"$ref": "GoogleCloudDiscoveryengineV1betaDocumentProcessingConfigChunkingConfig", +"description": "Whether chunking mode is enabled." +}, "defaultParsingConfig": { "$ref": "GoogleCloudDiscoveryengineV1betaDocumentProcessingConfigParsingConfig", "description": "Configurations for default Document parser. If not specified, we will configure it as default DigitalParsingConfig, and the default parsing config will be applied to all file types for Document parsing." @@ -14615,6 +15165,33 @@ }, "type": "object" }, +"GoogleCloudDiscoveryengineV1betaDocumentProcessingConfigChunkingConfig": { +"description": "Configuration for chunking config.", +"id": "GoogleCloudDiscoveryengineV1betaDocumentProcessingConfigChunkingConfig", +"properties": { +"layoutBasedChunkingConfig": { +"$ref": "GoogleCloudDiscoveryengineV1betaDocumentProcessingConfigChunkingConfigLayoutBasedChunkingConfig", +"description": "Configuration for the layout based chunking." +} +}, +"type": "object" +}, +"GoogleCloudDiscoveryengineV1betaDocumentProcessingConfigChunkingConfigLayoutBasedChunkingConfig": { +"description": "Configuration for the layout based chunking.", +"id": "GoogleCloudDiscoveryengineV1betaDocumentProcessingConfigChunkingConfigLayoutBasedChunkingConfig", +"properties": { +"chunkSize": { +"description": "The token size limit for each chunk. Supported values: 100-500 (inclusive). Default value: 500.", +"format": "int32", +"type": "integer" +}, +"includeAncestorHeadings": { +"description": "Whether to include appending different levels of headings to chunks from the middle of the document to prevent context loss. Default value: False.", +"type": "boolean" +} +}, +"type": "object" +}, "GoogleCloudDiscoveryengineV1betaDocumentProcessingConfigParsingConfig": { "description": "Related configurations applied to a specific type of document parser.", "id": "GoogleCloudDiscoveryengineV1betaDocumentProcessingConfigParsingConfig", @@ -14623,6 +15200,10 @@ "$ref": "GoogleCloudDiscoveryengineV1betaDocumentProcessingConfigParsingConfigDigitalParsingConfig", "description": "Configurations applied to digital parser." }, +"layoutParsingConfig": { +"$ref": "GoogleCloudDiscoveryengineV1betaDocumentProcessingConfigParsingConfigLayoutParsingConfig", +"description": "Configurations applied to layout parser." +}, "ocrParsingConfig": { "$ref": "GoogleCloudDiscoveryengineV1betaDocumentProcessingConfigParsingConfigOcrParsingConfig", "description": "Configurations applied to OCR parser. Currently it only applies to PDFs." @@ -14636,6 +15217,12 @@ "properties": {}, "type": "object" }, +"GoogleCloudDiscoveryengineV1betaDocumentProcessingConfigParsingConfigLayoutParsingConfig": { +"description": "The layout parsing configurations for documents.", +"id": "GoogleCloudDiscoveryengineV1betaDocumentProcessingConfigParsingConfigLayoutParsingConfig", +"properties": {}, +"type": "object" +}, "GoogleCloudDiscoveryengineV1betaDocumentProcessingConfigParsingConfigOcrParsingConfig": { "description": "The OCR parsing configurations for documents.", "id": "GoogleCloudDiscoveryengineV1betaDocumentProcessingConfigParsingConfigOcrParsingConfig", @@ -15510,6 +16097,35 @@ }, "type": "object" }, +"GoogleMonitoringV3TypedValue": { +"description": "A single strongly-typed value.", +"id": "GoogleMonitoringV3TypedValue", +"properties": { +"boolValue": { +"description": "A Boolean value: `true` or `false`.", +"type": "boolean" +}, +"distributionValue": { +"$ref": "GoogleApiDistribution", +"description": "A distribution value." +}, +"doubleValue": { +"description": "A 64-bit double-precision floating-point number. Its magnitude is approximately \u00b110\u00b1300 and it has 16 significant digits of precision.", +"format": "double", +"type": "number" +}, +"int64Value": { +"description": "A 64-bit integer. Its range is approximately \u00b19.2x1018.", +"format": "int64", +"type": "string" +}, +"stringValue": { +"description": "A variable-length string value.", +"type": "string" +} +}, +"type": "object" +}, "GoogleProtobufEmpty": { "description": "A generic empty message that you can re-use to avoid defining duplicated empty messages in your APIs. A typical example is to use it as the request or the response type of an API method. For instance: service Foo { rpc Bar(google.protobuf.Empty) returns (google.protobuf.Empty); }", "id": "GoogleProtobufEmpty", @@ -15564,6 +16180,29 @@ } }, "type": "object" +}, +"GoogleTypeExpr": { +"description": "Represents a textual expression in the Common Expression Language (CEL) syntax. CEL is a C-like expression language. The syntax and semantics of CEL are documented at https://github.com/google/cel-spec. Example (Comparison): title: \"Summary size limit\" description: \"Determines if a summary is less than 100 chars\" expression: \"document.summary.size() < 100\" Example (Equality): title: \"Requestor is owner\" description: \"Determines if requestor is the document owner\" expression: \"document.owner == request.auth.claims.email\" Example (Logic): title: \"Public documents\" description: \"Determine whether the document should be publicly visible\" expression: \"document.type != 'private' && document.type != 'internal'\" Example (Data Manipulation): title: \"Notification string\" description: \"Create a notification string with a timestamp.\" expression: \"'New message received at ' + string(document.create_time)\" The exact variables and functions that may be referenced within an expression are determined by the service that evaluates it. See the service documentation for additional information.", +"id": "GoogleTypeExpr", +"properties": { +"description": { +"description": "Optional. Description of the expression. This is a longer text which describes the expression, e.g. when hovered over it in a UI.", +"type": "string" +}, +"expression": { +"description": "Textual representation of an expression in Common Expression Language syntax.", +"type": "string" +}, +"location": { +"description": "Optional. String indicating the location of the expression for error reporting, e.g. a file name and a position in the file.", +"type": "string" +}, +"title": { +"description": "Optional. Title for the expression, i.e. a short string describing its purpose. This can be used e.g. in UIs which allow to enter the expression.", +"type": "string" +} +}, +"type": "object" } }, "servicePath": "", diff --git a/googleapiclient/discovery_cache/documents/discoveryengine.v1beta.json b/googleapiclient/discovery_cache/documents/discoveryengine.v1beta.json index 6799652a25d..dba7390de55 100644 --- a/googleapiclient/discovery_cache/documents/discoveryengine.v1beta.json +++ b/googleapiclient/discovery_cache/documents/discoveryengine.v1beta.json @@ -817,7 +817,7 @@ "type": "string" }, "parent": { -"description": "Required. Full resource name of parent data store. Format: `projects/{project_number}/locations/{location_id}/collections/{collection_id}/dataStores/{data_store_id}`", +"description": "Required. Full resource name of parent data store. Format: `projects/{project_number}/locations/{location_id}/collections/{collection_id}/dataStores/{data_store_id}` or `projects/{project_number}/locations/{location_id}/collections/{collection_id}/engines/{engine_id}`.", "location": "path", "pattern": "^projects/[^/]+/locations/[^/]+/collections/[^/]+/dataStores/[^/]+$", "required": true, @@ -911,7 +911,7 @@ "type": "string" }, "parent": { -"description": "Required. The data store resource name. Format: `projects/{project_number}/locations/{location_id}/collections/{collection_id}/dataStores/{data_store_id}`", +"description": "Required. The data store resource name. Format: `projects/{project_number}/locations/{location_id}/collections/{collection_id}/dataStores/{data_store_id}` or `projects/{project_number}/locations/{location_id}/collections/{collection_id}/engines/{engine_id}`.", "location": "path", "pattern": "^projects/[^/]+/locations/[^/]+/collections/[^/]+/dataStores/[^/]+$", "required": true, @@ -2830,7 +2830,7 @@ "type": "string" }, "parent": { -"description": "Required. Full resource name of parent data store. Format: `projects/{project_number}/locations/{location_id}/collections/{collection_id}/dataStores/{data_store_id}`", +"description": "Required. Full resource name of parent data store. Format: `projects/{project_number}/locations/{location_id}/collections/{collection_id}/dataStores/{data_store_id}` or `projects/{project_number}/locations/{location_id}/collections/{collection_id}/engines/{engine_id}`.", "location": "path", "pattern": "^projects/[^/]+/locations/[^/]+/collections/[^/]+/engines/[^/]+$", "required": true, @@ -2924,7 +2924,7 @@ "type": "string" }, "parent": { -"description": "Required. The data store resource name. Format: `projects/{project_number}/locations/{location_id}/collections/{collection_id}/dataStores/{data_store_id}`", +"description": "Required. The data store resource name. Format: `projects/{project_number}/locations/{location_id}/collections/{collection_id}/dataStores/{data_store_id}` or `projects/{project_number}/locations/{location_id}/collections/{collection_id}/engines/{engine_id}`.", "location": "path", "pattern": "^projects/[^/]+/locations/[^/]+/collections/[^/]+/engines/[^/]+$", "required": true, @@ -4259,7 +4259,7 @@ "type": "string" }, "parent": { -"description": "Required. Full resource name of parent data store. Format: `projects/{project_number}/locations/{location_id}/collections/{collection_id}/dataStores/{data_store_id}`", +"description": "Required. Full resource name of parent data store. Format: `projects/{project_number}/locations/{location_id}/collections/{collection_id}/dataStores/{data_store_id}` or `projects/{project_number}/locations/{location_id}/collections/{collection_id}/engines/{engine_id}`.", "location": "path", "pattern": "^projects/[^/]+/locations/[^/]+/dataStores/[^/]+$", "required": true, @@ -4353,7 +4353,7 @@ "type": "string" }, "parent": { -"description": "Required. The data store resource name. Format: `projects/{project_number}/locations/{location_id}/collections/{collection_id}/dataStores/{data_store_id}`", +"description": "Required. The data store resource name. Format: `projects/{project_number}/locations/{location_id}/collections/{collection_id}/dataStores/{data_store_id}` or `projects/{project_number}/locations/{location_id}/collections/{collection_id}/engines/{engine_id}`.", "location": "path", "pattern": "^projects/[^/]+/locations/[^/]+/dataStores/[^/]+$", "required": true, @@ -5838,6 +5838,47 @@ }, "userEvents": { "methods": { +"collect": { +"description": "Writes a single user event from the browser. This uses a GET request to due to browser restriction of POST-ing to a third-party domain. This method is used only by the Discovery Engine API JavaScript pixel and Google Tag Manager. Users should not call this method directly.", +"flatPath": "v1beta/projects/{projectsId}/locations/{locationsId}/userEvents:collect", +"httpMethod": "GET", +"id": "discoveryengine.projects.locations.userEvents.collect", +"parameterOrder": [ +"parent" +], +"parameters": { +"ets": { +"description": "The event timestamp in milliseconds. This prevents browser caching of otherwise identical get requests. The name is abbreviated to reduce the payload bytes.", +"format": "int64", +"location": "query", +"type": "string" +}, +"parent": { +"description": "Required. The parent DataStore resource name, such as `projects/{project}/locations/{location}/collections/{collection}/dataStores/{data_store}`.", +"location": "path", +"pattern": "^projects/[^/]+/locations/[^/]+$", +"required": true, +"type": "string" +}, +"uri": { +"description": "The URL including cgi-parameters but excluding the hash fragment with a length limit of 5,000 characters. This is often more useful than the referer URL, because many browsers only send the domain for third-party requests.", +"location": "query", +"type": "string" +}, +"userEvent": { +"description": "Required. URL encoded UserEvent proto with a length limit of 2,000,000 characters.", +"location": "query", +"type": "string" +} +}, +"path": "v1beta/{+parent}/userEvents:collect", +"response": { +"$ref": "GoogleApiHttpBody" +}, +"scopes": [ +"https://www.googleapis.com/auth/cloud-platform" +] +}, "write": { "description": "Writes a single user event.", "flatPath": "v1beta/projects/{projectsId}/locations/{locationsId}/userEvents:write", @@ -5948,7 +5989,7 @@ } } }, -"revision": "20240526", +"revision": "20240607", "rootUrl": "https://discoveryengine.googleapis.com/", "schemas": { "GoogleApiHttpBody": { @@ -6572,6 +6613,10 @@ "description": "A singleton resource of DataStore. It's empty when DataStore is created, which defaults to digital parser. The first call to DataStoreService.UpdateDocumentProcessingConfig method will initialize the config.", "id": "GoogleCloudDiscoveryengineV1DocumentProcessingConfig", "properties": { +"chunkingConfig": { +"$ref": "GoogleCloudDiscoveryengineV1DocumentProcessingConfigChunkingConfig", +"description": "Whether chunking mode is enabled." +}, "defaultParsingConfig": { "$ref": "GoogleCloudDiscoveryengineV1DocumentProcessingConfigParsingConfig", "description": "Configurations for default Document parser. If not specified, we will configure it as default DigitalParsingConfig, and the default parsing config will be applied to all file types for Document parsing." @@ -6590,6 +6635,33 @@ }, "type": "object" }, +"GoogleCloudDiscoveryengineV1DocumentProcessingConfigChunkingConfig": { +"description": "Configuration for chunking config.", +"id": "GoogleCloudDiscoveryengineV1DocumentProcessingConfigChunkingConfig", +"properties": { +"layoutBasedChunkingConfig": { +"$ref": "GoogleCloudDiscoveryengineV1DocumentProcessingConfigChunkingConfigLayoutBasedChunkingConfig", +"description": "Configuration for the layout based chunking." +} +}, +"type": "object" +}, +"GoogleCloudDiscoveryengineV1DocumentProcessingConfigChunkingConfigLayoutBasedChunkingConfig": { +"description": "Configuration for the layout based chunking.", +"id": "GoogleCloudDiscoveryengineV1DocumentProcessingConfigChunkingConfigLayoutBasedChunkingConfig", +"properties": { +"chunkSize": { +"description": "The token size limit for each chunk. Supported values: 100-500 (inclusive). Default value: 500.", +"format": "int32", +"type": "integer" +}, +"includeAncestorHeadings": { +"description": "Whether to include appending different levels of headings to chunks from the middle of the document to prevent context loss. Default value: False.", +"type": "boolean" +} +}, +"type": "object" +}, "GoogleCloudDiscoveryengineV1DocumentProcessingConfigParsingConfig": { "description": "Related configurations applied to a specific type of document parser.", "id": "GoogleCloudDiscoveryengineV1DocumentProcessingConfigParsingConfig", @@ -6598,6 +6670,10 @@ "$ref": "GoogleCloudDiscoveryengineV1DocumentProcessingConfigParsingConfigDigitalParsingConfig", "description": "Configurations applied to digital parser." }, +"layoutParsingConfig": { +"$ref": "GoogleCloudDiscoveryengineV1DocumentProcessingConfigParsingConfigLayoutParsingConfig", +"description": "Configurations applied to layout parser." +}, "ocrParsingConfig": { "$ref": "GoogleCloudDiscoveryengineV1DocumentProcessingConfigParsingConfigOcrParsingConfig", "description": "Configurations applied to OCR parser. Currently it only applies to PDFs." @@ -6611,6 +6687,12 @@ "properties": {}, "type": "object" }, +"GoogleCloudDiscoveryengineV1DocumentProcessingConfigParsingConfigLayoutParsingConfig": { +"description": "The layout parsing configurations for documents.", +"id": "GoogleCloudDiscoveryengineV1DocumentProcessingConfigParsingConfigLayoutParsingConfig", +"properties": {}, +"type": "object" +}, "GoogleCloudDiscoveryengineV1DocumentProcessingConfigParsingConfigOcrParsingConfig": { "description": "The OCR parsing configurations for documents.", "id": "GoogleCloudDiscoveryengineV1DocumentProcessingConfigParsingConfigOcrParsingConfig", @@ -9787,6 +9869,37 @@ }, "type": "object" }, +"GoogleCloudDiscoveryengineV1betaAlloyDbSource": { +"description": "AlloyDB source import data from.", +"id": "GoogleCloudDiscoveryengineV1betaAlloyDbSource", +"properties": { +"clusterId": { +"description": "Required. The AlloyDB cluster to copy the data from with a length limit of 256 characters.", +"type": "string" +}, +"databaseId": { +"description": "Required. The AlloyDB database to copy the data from with a length limit of 256 characters.", +"type": "string" +}, +"gcsStagingDir": { +"description": "Intermediate Cloud Storage directory used for the import with a length limit of 2,000 characters. Can be specified if one wants to have the AlloyDB export to a specific Cloud Storage directory. Ensure that the AlloyDB service account has the necessary Cloud Storage Admin permissions to access the specified Cloud Storage directory.", +"type": "string" +}, +"locationId": { +"description": "Required. The AlloyDB location to copy the data from with a length limit of 256 characters.", +"type": "string" +}, +"projectId": { +"description": "The project ID that the AlloyDB source is in with a length limit of 128 characters. If not specified, inherits the project ID from the parent request.", +"type": "string" +}, +"tableId": { +"description": "Required. The AlloyDB table to copy the data from with a length limit of 256 characters.", +"type": "string" +} +}, +"type": "object" +}, "GoogleCloudDiscoveryengineV1betaAnswer": { "description": "Defines an answer.", "id": "GoogleCloudDiscoveryengineV1betaAnswer", @@ -9954,6 +10067,13 @@ "description": "The session resource name. Not required. When session field is not set, the API is in sessionless mode. We support auto session mode: users can use the wildcard symbol `-` as session ID. A new ID will be automatically generated and assigned.", "type": "string" }, +"userLabels": { +"additionalProperties": { +"type": "string" +}, +"description": "The user labels applied to a resource must meet the following requirements: * Each resource can have multiple labels, up to a maximum of 64. * Each label must be a key-value pair. * Keys have a minimum length of 1 character and a maximum length of 63 characters and cannot be empty. Values can be empty and have a maximum length of 63 characters. * Keys and values can contain only lowercase letters, numeric characters, underscores, and dashes. All characters must use UTF-8 encoding, and international characters are allowed. * The key portion of a label must be unique. However, you can use the same key with multiple resources. * Keys must start with a lowercase letter or international character. See [Google Cloud Document](https://cloud.google.com/resource-manager/docs/creating-managing-labels#requirements) for more details.", +"type": "object" +}, "userPseudoId": { "description": "A unique identifier for tracking visitors. For example, this could be implemented with an HTTP cookie, which should be able to uniquely identify a visitor on a single device. This unique identifier should not change if the visitor logs in or out of the website. This field should NOT have a fixed value such as `unknown_visitor`. The field must be a UTF-8 encoded string with a length limit of 128 characters. Otherwise, an `INVALID_ARGUMENT` error is returned.", "type": "string" @@ -10137,6 +10257,20 @@ "orderBy": { "description": "The order in which documents are returned. Documents can be ordered by a field in an Document object. Leave it unset if ordered by relevance. `order_by` expression is case-sensitive. For more information on ordering, see [Ordering](https://cloud.google.com/retail/docs/filter-and-order#order) If this field is unrecognizable, an `INVALID_ARGUMENT` is returned.", "type": "string" +}, +"searchResultMode": { +"description": "Specifies the search result mode. If unspecified, the search result mode is based on DataStore.DocumentProcessingConfig.chunking_config: * If DataStore.DocumentProcessingConfig.chunking_config is specified, it defaults to `CHUNKS`. * Otherwise, it defaults to `DOCUMENTS`. See [parse and chunk documents](https://cloud.google.com/generative-ai-app-builder/docs/parse-chunk-documents)", +"enum": [ +"SEARCH_RESULT_MODE_UNSPECIFIED", +"DOCUMENTS", +"CHUNKS" +], +"enumDescriptions": [ +"Default value.", +"Returns documents in the search result.", +"Returns chunks in the search result. Only available if the DataStore.DocumentProcessingConfig.chunking_config is specified." +], +"type": "string" } }, "type": "object" @@ -10925,6 +11059,114 @@ }, "type": "object" }, +"GoogleCloudDiscoveryengineV1betaChunk": { +"description": "Chunk captures all raw metadata information of items to be recommended or searched in the chunk mode.", +"id": "GoogleCloudDiscoveryengineV1betaChunk", +"properties": { +"chunkMetadata": { +"$ref": "GoogleCloudDiscoveryengineV1betaChunkChunkMetadata", +"description": "Output only. Metadata of the current chunk.", +"readOnly": true +}, +"content": { +"description": "Content is a string from a document (parsed content).", +"type": "string" +}, +"derivedStructData": { +"additionalProperties": { +"description": "Properties of the object.", +"type": "any" +}, +"description": "Output only. This field is OUTPUT_ONLY. It contains derived data that are not in the original input document.", +"readOnly": true, +"type": "object" +}, +"documentMetadata": { +"$ref": "GoogleCloudDiscoveryengineV1betaChunkDocumentMetadata", +"description": "Metadata of the document from the current chunk." +}, +"id": { +"description": "Unique chunk ID of the current chunk.", +"type": "string" +}, +"name": { +"description": "The full resource name of the chunk. Format: `projects/{project}/locations/{location}/collections/{collection}/dataStores/{data_store}/branches/{branch}/documents/{document_id}/chunks/{chunk_id}`. This field must be a UTF-8 encoded string with a length limit of 1024 characters.", +"type": "string" +}, +"pageSpan": { +"$ref": "GoogleCloudDiscoveryengineV1betaChunkPageSpan", +"description": "Page span of the chunk." +}, +"relevanceScore": { +"description": "Output only. Represents the relevance score based on similarity. Higher score indicates higher chunk relevance. The score is in range [-1.0, 1.0]. Only populated on SearchService.SearchResponse.", +"format": "double", +"readOnly": true, +"type": "number" +} +}, +"type": "object" +}, +"GoogleCloudDiscoveryengineV1betaChunkChunkMetadata": { +"description": "Metadata of the current chunk. This field is only populated on SearchService.Search API.", +"id": "GoogleCloudDiscoveryengineV1betaChunkChunkMetadata", +"properties": { +"nextChunks": { +"description": "The next chunks of the current chunk. The number is controlled by SearchRequest.ContentSearchSpec.ChunkSpec.num_next_chunks. This field is only populated on SearchService.Search API.", +"items": { +"$ref": "GoogleCloudDiscoveryengineV1betaChunk" +}, +"type": "array" +}, +"previousChunks": { +"description": "The previous chunks of the current chunk. The number is controlled by SearchRequest.ContentSearchSpec.ChunkSpec.num_previous_chunks. This field is only populated on SearchService.Search API.", +"items": { +"$ref": "GoogleCloudDiscoveryengineV1betaChunk" +}, +"type": "array" +} +}, +"type": "object" +}, +"GoogleCloudDiscoveryengineV1betaChunkDocumentMetadata": { +"description": "Document metadata contains the information of the document of the current chunk.", +"id": "GoogleCloudDiscoveryengineV1betaChunkDocumentMetadata", +"properties": { +"structData": { +"additionalProperties": { +"description": "Properties of the object.", +"type": "any" +}, +"description": "Data representation. The structured JSON data for the document. It should conform to the registered Schema or an `INVALID_ARGUMENT` error is thrown.", +"type": "object" +}, +"title": { +"description": "Title of the document.", +"type": "string" +}, +"uri": { +"description": "Uri of the document.", +"type": "string" +} +}, +"type": "object" +}, +"GoogleCloudDiscoveryengineV1betaChunkPageSpan": { +"description": "Page span of the chunk.", +"id": "GoogleCloudDiscoveryengineV1betaChunkPageSpan", +"properties": { +"pageEnd": { +"description": "The end page of the chunk.", +"format": "int32", +"type": "integer" +}, +"pageStart": { +"description": "The start page of the chunk.", +"format": "int32", +"type": "integer" +} +}, +"type": "object" +}, "GoogleCloudDiscoveryengineV1betaCloudSqlSource": { "description": "Cloud SQL source import data from.", "id": "GoogleCloudDiscoveryengineV1betaCloudSqlSource", @@ -11808,6 +12050,10 @@ "description": "A singleton resource of DataStore. It's empty when DataStore is created, which defaults to digital parser. The first call to DataStoreService.UpdateDocumentProcessingConfig method will initialize the config.", "id": "GoogleCloudDiscoveryengineV1betaDocumentProcessingConfig", "properties": { +"chunkingConfig": { +"$ref": "GoogleCloudDiscoveryengineV1betaDocumentProcessingConfigChunkingConfig", +"description": "Whether chunking mode is enabled." +}, "defaultParsingConfig": { "$ref": "GoogleCloudDiscoveryengineV1betaDocumentProcessingConfigParsingConfig", "description": "Configurations for default Document parser. If not specified, we will configure it as default DigitalParsingConfig, and the default parsing config will be applied to all file types for Document parsing." @@ -11826,6 +12072,33 @@ }, "type": "object" }, +"GoogleCloudDiscoveryengineV1betaDocumentProcessingConfigChunkingConfig": { +"description": "Configuration for chunking config.", +"id": "GoogleCloudDiscoveryengineV1betaDocumentProcessingConfigChunkingConfig", +"properties": { +"layoutBasedChunkingConfig": { +"$ref": "GoogleCloudDiscoveryengineV1betaDocumentProcessingConfigChunkingConfigLayoutBasedChunkingConfig", +"description": "Configuration for the layout based chunking." +} +}, +"type": "object" +}, +"GoogleCloudDiscoveryengineV1betaDocumentProcessingConfigChunkingConfigLayoutBasedChunkingConfig": { +"description": "Configuration for the layout based chunking.", +"id": "GoogleCloudDiscoveryengineV1betaDocumentProcessingConfigChunkingConfigLayoutBasedChunkingConfig", +"properties": { +"chunkSize": { +"description": "The token size limit for each chunk. Supported values: 100-500 (inclusive). Default value: 500.", +"format": "int32", +"type": "integer" +}, +"includeAncestorHeadings": { +"description": "Whether to include appending different levels of headings to chunks from the middle of the document to prevent context loss. Default value: False.", +"type": "boolean" +} +}, +"type": "object" +}, "GoogleCloudDiscoveryengineV1betaDocumentProcessingConfigParsingConfig": { "description": "Related configurations applied to a specific type of document parser.", "id": "GoogleCloudDiscoveryengineV1betaDocumentProcessingConfigParsingConfig", @@ -11834,6 +12107,10 @@ "$ref": "GoogleCloudDiscoveryengineV1betaDocumentProcessingConfigParsingConfigDigitalParsingConfig", "description": "Configurations applied to digital parser." }, +"layoutParsingConfig": { +"$ref": "GoogleCloudDiscoveryengineV1betaDocumentProcessingConfigParsingConfigLayoutParsingConfig", +"description": "Configurations applied to layout parser." +}, "ocrParsingConfig": { "$ref": "GoogleCloudDiscoveryengineV1betaDocumentProcessingConfigParsingConfigOcrParsingConfig", "description": "Configurations applied to OCR parser. Currently it only applies to PDFs." @@ -11847,6 +12124,12 @@ "properties": {}, "type": "object" }, +"GoogleCloudDiscoveryengineV1betaDocumentProcessingConfigParsingConfigLayoutParsingConfig": { +"description": "The layout parsing configurations for documents.", +"id": "GoogleCloudDiscoveryengineV1betaDocumentProcessingConfigParsingConfigLayoutParsingConfig", +"properties": {}, +"type": "object" +}, "GoogleCloudDiscoveryengineV1betaDocumentProcessingConfigParsingConfigOcrParsingConfig": { "description": "The OCR parsing configurations for documents.", "id": "GoogleCloudDiscoveryengineV1betaDocumentProcessingConfigParsingConfigOcrParsingConfig", @@ -12262,6 +12545,10 @@ "description": "Request message for Import methods.", "id": "GoogleCloudDiscoveryengineV1betaImportDocumentsRequest", "properties": { +"alloyDbSource": { +"$ref": "GoogleCloudDiscoveryengineV1betaAlloyDbSource", +"description": "AlloyDB input source." +}, "autoGenerateIds": { "description": "Whether to automatically generate IDs for the documents if absent. If set to `true`, Document.ids are automatically generated based on the hash of the payload, where IDs may not be consistent during multiple imports. In which case ReconciliationMode.FULL is highly recommended to avoid duplicate contents. If unset or set to `false`, Document.ids have to be specified using id_field, otherwise, documents without IDs fail to be imported. Supported data sources: * GcsSource. GcsSource.data_schema must be `custom` or `csv`. Otherwise, an INVALID_ARGUMENT error is thrown. * BigQuerySource. BigQuerySource.data_schema must be `custom` or `csv`. Otherwise, an INVALID_ARGUMENT error is thrown. * SpannerSource. * CloudSqlSource. * FirestoreSource. * BigtableSource.", "type": "boolean" @@ -13514,10 +13801,28 @@ "description": "A specification for configuring the behavior of content search.", "id": "GoogleCloudDiscoveryengineV1betaSearchRequestContentSearchSpec", "properties": { +"chunkSpec": { +"$ref": "GoogleCloudDiscoveryengineV1betaSearchRequestContentSearchSpecChunkSpec", +"description": "Specifies the chunk spec to be returned from the search response. Only available if the SearchRequest.ContentSearchSpec.search_result_mode is set to CHUNKS" +}, "extractiveContentSpec": { "$ref": "GoogleCloudDiscoveryengineV1betaSearchRequestContentSearchSpecExtractiveContentSpec", "description": "If there is no extractive_content_spec provided, there will be no extractive answer in the search response." }, +"searchResultMode": { +"description": "Specifies the search result mode. If unspecified, the search result mode is based on DataStore.DocumentProcessingConfig.chunking_config: * If DataStore.DocumentProcessingConfig.chunking_config is specified, it defaults to `CHUNKS`. * Otherwise, it defaults to `DOCUMENTS`.", +"enum": [ +"SEARCH_RESULT_MODE_UNSPECIFIED", +"DOCUMENTS", +"CHUNKS" +], +"enumDescriptions": [ +"Default value.", +"Returns documents in the search result.", +"Returns chunks in the search result. Only available if the DataStore.DocumentProcessingConfig.chunking_config is specified." +], +"type": "string" +}, "snippetSpec": { "$ref": "GoogleCloudDiscoveryengineV1betaSearchRequestContentSearchSpecSnippetSpec", "description": "If `snippetSpec` is not specified, snippets are not included in the search response." @@ -13529,6 +13834,23 @@ }, "type": "object" }, +"GoogleCloudDiscoveryengineV1betaSearchRequestContentSearchSpecChunkSpec": { +"description": "Specifies the chunk spec to be returned from the search response. Only available if the SearchRequest.ContentSearchSpec.search_result_mode is set to CHUNKS", +"id": "GoogleCloudDiscoveryengineV1betaSearchRequestContentSearchSpecChunkSpec", +"properties": { +"numNextChunks": { +"description": "The number of next chunks to be returned of the current chunk. The maximum allowed value is 3. If not specified, no next chunks will be returned.", +"format": "int32", +"type": "integer" +}, +"numPreviousChunks": { +"description": "The number of previous chunks to be returned of the current chunk. The maximum allowed value is 3. If not specified, no previous chunks will be returned.", +"format": "int32", +"type": "integer" +} +}, +"type": "object" +}, "GoogleCloudDiscoveryengineV1betaSearchRequestContentSearchSpecExtractiveContentSpec": { "description": "A specification for configuring the extractive content in a search response.", "id": "GoogleCloudDiscoveryengineV1betaSearchRequestContentSearchSpecExtractiveContentSpec", @@ -13999,6 +14321,10 @@ "description": "Represents the search results.", "id": "GoogleCloudDiscoveryengineV1betaSearchResponseSearchResult", "properties": { +"chunk": { +"$ref": "GoogleCloudDiscoveryengineV1betaChunk", +"description": "The chunk data in the search response if the SearchRequest.ContentSearchSpec.search_result_mode is set to CHUNKS." +}, "document": { "$ref": "GoogleCloudDiscoveryengineV1betaDocument", "description": "The document data snippet in the search response. Only fields that are marked as `retrievable` are populated." diff --git a/googleapiclient/discovery_cache/documents/displayvideo.v2.json b/googleapiclient/discovery_cache/documents/displayvideo.v2.json index 1fae481b419..4650336820a 100644 --- a/googleapiclient/discovery_cache/documents/displayvideo.v2.json +++ b/googleapiclient/discovery_cache/documents/displayvideo.v2.json @@ -9267,7 +9267,7 @@ } } }, -"revision": "20240530", +"revision": "20240604", "rootUrl": "https://displayvideo.googleapis.com/", "schemas": { "ActivateManualTriggerRequest": { diff --git a/googleapiclient/discovery_cache/documents/displayvideo.v3.json b/googleapiclient/discovery_cache/documents/displayvideo.v3.json index a934d154a32..4cbb99e72c2 100644 --- a/googleapiclient/discovery_cache/documents/displayvideo.v3.json +++ b/googleapiclient/discovery_cache/documents/displayvideo.v3.json @@ -9222,7 +9222,7 @@ } } }, -"revision": "20240530", +"revision": "20240604", "rootUrl": "https://displayvideo.googleapis.com/", "schemas": { "ActiveViewVideoViewabilityMetricConfig": { diff --git a/googleapiclient/discovery_cache/documents/dlp.v2.json b/googleapiclient/discovery_cache/documents/dlp.v2.json index 54bc8743e43..25ec9d8bfc1 100644 --- a/googleapiclient/discovery_cache/documents/dlp.v2.json +++ b/googleapiclient/discovery_cache/documents/dlp.v2.json @@ -4451,7 +4451,7 @@ } } }, -"revision": "20240526", +"revision": "20240602", "rootUrl": "https://dlp.googleapis.com/", "schemas": { "GooglePrivacyDlpV2Action": { diff --git a/googleapiclient/discovery_cache/documents/dns.v1.json b/googleapiclient/discovery_cache/documents/dns.v1.json index f321c425602..ed18d31bd1f 100644 --- a/googleapiclient/discovery_cache/documents/dns.v1.json +++ b/googleapiclient/discovery_cache/documents/dns.v1.json @@ -1824,11 +1824,11 @@ } } }, -"revision": "20240524", +"revision": "20240531", "rootUrl": "https://dns.googleapis.com/", "schemas": { "Change": { -"description": "A Change represents a set of ResourceRecordSet additions and deletions applied atomically to a ManagedZone. ResourceRecordSets within a ManagedZone are modified by creating a new Change element in the Changes collection. In turn the Changes collection also records the past modifications to the ResourceRecordSets in a ManagedZone. The current state of the ManagedZone is the sum effect of applying all Change elements in the Changes collection in sequence.", +"description": "A Change represents a set of `ResourceRecordSet` additions and deletions applied atomically to a ManagedZone. ResourceRecordSets within a ManagedZone are modified by creating a new Change element in the Changes collection. In turn the Changes collection also records the past modifications to the `ResourceRecordSets` in a `ManagedZone`. The current state of the `ManagedZone` is the sum effect of applying all `Change` elements in the `Changes` collection in sequence.", "id": "Change", "properties": { "additions": { @@ -1887,16 +1887,13 @@ }, "type": "array" }, -"header": { -"$ref": "ResponseHeader" -}, "kind": { "default": "dns#changesListResponse", "description": "Type of resource.", "type": "string" }, "nextPageToken": { -"description": "The presence of this field indicates that there exist more results following your last page of results in pagination order. To fetch them, make another list request using this value as your pagination token. This lets you retrieve the complete contents of even very large collections one page at a time. However, if the contents of the collection change between the first and last paginated list request, the set of all elements returned are an inconsistent view of the collection. You cannot retrieve a \"snapshot\" of collections larger than the maximum page size.", +"description": "This field indicates that more results are available beyond the last page displayed. To fetch the results, make another list request and use this value as your page token. This lets you retrieve the complete contents of a very large collection one page at a time. However, if the contents of the collection change between the first and last paginated list request, the set of all elements returned are an inconsistent view of the collection. You can't retrieve a consistent snapshot of a collection larger than the maximum page size.", "type": "string" } }, @@ -2061,16 +2058,13 @@ }, "type": "array" }, -"header": { -"$ref": "ResponseHeader" -}, "kind": { "default": "dns#dnsKeysListResponse", "description": "Type of resource.", "type": "string" }, "nextPageToken": { -"description": "The presence of this field indicates that there exist more results following your last page of results in pagination order. To fetch them, make another list request using this value as your pagination token. In this way you can retrieve the complete contents of even very large collections one page at a time. However, if the contents of the collection change between the first and last paginated list request, the set of all elements returned are an inconsistent view of the collection. There is no way to retrieve a \"snapshot\" of collections larger than the maximum page size.", +"description": "This field indicates that more results are available beyond the last page displayed. To fetch the results, make another list request and use this value as your page token. This lets you retrieve the complete contents of a very large collection one page at a time. However, if the contents of the collection change between the first and last paginated list request, the set of all elements returned are an inconsistent view of the collection. You can't retrieve a consistent snapshot of a collection larger than the maximum page size.", "type": "string" } }, @@ -2348,8 +2342,8 @@ "private" ], "enumDescriptions": [ -"", -"" +"Indicates that records in this zone can be queried from the public internet.", +"Indicates that records in this zone cannot be queried from the public internet. Access to private zones depends on the zone configuration." ], "type": "string" } @@ -2392,8 +2386,8 @@ "nsec3" ], "enumDescriptions": [ -"", -"" +"Indicates that Cloud DNS will sign records in the managed zone according to RFC 4034 and respond with NSEC records for names that do not exist.", +"Indicates that Cloud DNS will sign records in the managed zone according to RFC 5155 and respond with NSEC3 records for names that do not exist." ], "type": "string" }, @@ -2464,16 +2458,13 @@ "ManagedZoneOperationsListResponse": { "id": "ManagedZoneOperationsListResponse", "properties": { -"header": { -"$ref": "ResponseHeader" -}, "kind": { "default": "dns#managedZoneOperationsListResponse", "description": "Type of resource.", "type": "string" }, "nextPageToken": { -"description": "The presence of this field indicates that there exist more results following your last page of results in pagination order. To fetch them, make another list request using this value as your page token. This lets you retrieve the complete contents of even very large collections one page at a time. However, if the contents of the collection change between the first and last paginated list request, the set of all elements returned are an inconsistent view of the collection. You cannot retrieve a consistent snapshot of a collection larger than the maximum page size.", +"description": "This field indicates that more results are available beyond the last page displayed. To fetch the results, make another list request and use this value as your page token. This lets you retrieve the complete contents of a very large collection one page at a time. However, if the contents of the collection change between the first and last paginated list request, the set of all elements returned are an inconsistent view of the collection. You can't retrieve a consistent snapshot of a collection larger than the maximum page size.", "type": "string" }, "operations": { @@ -2512,7 +2503,7 @@ "type": "string" }, "networkUrl": { -"description": "The fully qualified URL of the VPC network to forward queries to. This should be formatted like https://www.googleapis.com/compute/v1/projects/{project}/global/networks/{network}", +"description": "The fully qualified URL of the VPC network to forward queries to. This should be formatted like `https://www.googleapis.com/compute/v1/projects/{project}/global/networks/{network}`", "type": "string" } }, @@ -2564,7 +2555,7 @@ "type": "string" }, "networkUrl": { -"description": "The fully qualified URL of the VPC network to bind to. Format this URL like https://www.googleapis.com/compute/v1/projects/{project}/global/networks/{network}", +"description": "The fully qualified URL of the VPC network to bind to. Format this URL like `https://www.googleapis.com/compute/v1/projects/{project}/global/networks/{network}`", "type": "string" } }, @@ -2607,7 +2598,7 @@ "type": "string" }, "namespaceUrl": { -"description": "The fully qualified URL of the namespace associated with the zone. Format must be https://servicedirectory.googleapis.com/v1/projects/{project}/locations/{location}/namespaces/{namespace}", +"description": "The fully qualified URL of the namespace associated with the zone. Format must be `https://servicedirectory.googleapis.com/v1/projects/{project}/locations/{location}/namespaces/{namespace}`", "type": "string" } }, @@ -2616,9 +2607,6 @@ "ManagedZonesListResponse": { "id": "ManagedZonesListResponse", "properties": { -"header": { -"$ref": "ResponseHeader" -}, "kind": { "default": "dns#managedZonesListResponse", "description": "Type of resource.", @@ -2632,7 +2620,7 @@ "type": "array" }, "nextPageToken": { -"description": "The presence of this field indicates that there exist more results following your last page of results in pagination order. To fetch them, make another list request using this value as your page token. This lets you the complete contents of even very large collections one page at a time. However, if the contents of the collection change between the first and last paginated list request, the set of all elements returned are an inconsistent view of the collection. You cannot retrieve a consistent snapshot of a collection larger than the maximum page size.", +"description": "This field indicates that more results are available beyond the last page displayed. To fetch the results, make another list request and use this value as your page token. This lets you retrieve the complete contents of a very large collection one page at a time. However, if the contents of the collection change between the first and last paginated list request, the set of all elements returned are an inconsistent view of the collection. You can't retrieve a consistent snapshot of a collection larger than the maximum page size.", "type": "string" } }, @@ -2716,16 +2704,13 @@ "PoliciesListResponse": { "id": "PoliciesListResponse", "properties": { -"header": { -"$ref": "ResponseHeader" -}, "kind": { "default": "dns#policiesListResponse", "description": "Type of resource.", "type": "string" }, "nextPageToken": { -"description": "The presence of this field indicates that there exist more results following your last page of results in pagination order. To fetch them, make another list request using this value as your page token. This lets you the complete contents of even very large collections one page at a time. However, if the contents of the collection change between the first and last paginated list request, the set of all elements returned are an inconsistent view of the collection. You cannot retrieve a consistent snapshot of a collection larger than the maximum page size.", +"description": "This field indicates that more results are available beyond the last page displayed. To fetch the results, make another list request and use this value as your page token. This lets you retrieve the complete contents of a very large collection one page at a time. However, if the contents of the collection change between the first and last paginated list request, the set of all elements returned are an inconsistent view of the collection. You can't retrieve a consistent snapshot of a collection larger than the maximum page size.", "type": "string" }, "policies": { @@ -2741,9 +2726,6 @@ "PoliciesPatchResponse": { "id": "PoliciesPatchResponse", "properties": { -"header": { -"$ref": "ResponseHeader" -}, "policy": { "$ref": "Policy" } @@ -2753,9 +2735,6 @@ "PoliciesUpdateResponse": { "id": "PoliciesUpdateResponse", "properties": { -"header": { -"$ref": "ResponseHeader" -}, "policy": { "$ref": "Policy" } @@ -2867,7 +2846,7 @@ "type": "object" }, "Project": { -"description": "A project resource. The project is a top level container for resources including Cloud DNS ManagedZones. Projects can be created only in the APIs console. Next tag: 7.", +"description": "A project resource. The project is a top level container for resources including Cloud DNS ManagedZones. Projects can be created only in the APIs console.", "id": "Project", "properties": { "id": { @@ -3044,7 +3023,7 @@ "type": "object" }, "RRSetRoutingPolicyGeoPolicy": { -"description": "Configures a RRSetRoutingPolicy that routes based on the geo location of the querying user.", +"description": "Configures a `RRSetRoutingPolicy` that routes based on the geo location of the querying user.", "id": "RRSetRoutingPolicyGeoPolicy", "properties": { "enableFencing": { @@ -3071,7 +3050,7 @@ "properties": { "healthCheckedTargets": { "$ref": "RRSetRoutingPolicyHealthCheckTargets", -"description": "For A and AAAA types only. Endpoints to return in the query result only if they are healthy. These can be specified along with rrdata within this item." +"description": "For A and AAAA types only. Endpoints to return in the query result only if they are healthy. These can be specified along with `rrdata` within this item." }, "kind": { "default": "dns#rRSetRoutingPolicyGeoPolicyGeoPolicyItem", @@ -3088,7 +3067,7 @@ "type": "array" }, "signatureRrdatas": { -"description": "DNSSEC generated signatures for all the rrdata within this item. If health checked targets are provided for DNSSEC enabled zones, there's a restriction of 1 IP address per item.", +"description": "DNSSEC generated signatures for all the `rrdata` within this item. If health checked targets are provided for DNSSEC enabled zones, there's a restriction of 1 IP address per item.", "items": { "type": "string" }, @@ -3098,7 +3077,7 @@ "type": "object" }, "RRSetRoutingPolicyHealthCheckTargets": { -"description": "HealthCheckTargets describes endpoints to health-check when responding to Routing Policy queries. Only the healthy endpoints will be included in the response. Only one of internal_load_balancer and external_endpoints should be set.", +"description": "HealthCheckTargets describes endpoints to health-check when responding to Routing Policy queries. Only the healthy endpoints will be included in the response.", "id": "RRSetRoutingPolicyHealthCheckTargets", "properties": { "internalLoadBalancers": { @@ -3128,8 +3107,8 @@ ], "enumDescriptions": [ "", -"", -"" +"Indicates the load balancer is accessible via TCP.", +"Indicates the load balancer is accessible via UDP." ], "type": "string" }, @@ -3147,14 +3126,14 @@ ], "enumDescriptions": [ "", -"", -"", -"" +"Indicates the load balancer is a Cross-Region Application Load Balancer.", +"Indicates the load balancer is a Regional Network Passthrough Load Balancer.", +"Indicates the load balancer is a Regional Application Load Balancer." ], "type": "string" }, "networkUrl": { -"description": "The fully qualified URL of the network that the load balancer is attached to. This should be formatted like https://www.googleapis.com/compute/v1/projects/{project}/global/networks/{network} .", +"description": "The fully qualified URL of the network that the load balancer is attached to. This should be formatted like `https://www.googleapis.com/compute/v1/projects/{project}/global/networks/{network}`.", "type": "string" }, "port": { @@ -3178,7 +3157,7 @@ "properties": { "backupGeoTargets": { "$ref": "RRSetRoutingPolicyGeoPolicy", -"description": "Backup targets provide a regional failover policy for the otherwise global primary targets. If serving state is set to BACKUP, this policy essentially becomes a geo routing policy." +"description": "Backup targets provide a regional failover policy for the otherwise global primary targets. If serving state is set to `BACKUP`, this policy essentially becomes a geo routing policy." }, "kind": { "default": "dns#rRSetRoutingPolicyPrimaryBackupPolicy", @@ -3186,10 +3165,10 @@ }, "primaryTargets": { "$ref": "RRSetRoutingPolicyHealthCheckTargets", -"description": "Endpoints that are health checked before making the routing decision. Unhealthy endpoints are omitted from the results. If all endpoints are unhealthy, we serve a response based on the backup_geo_targets." +"description": "Endpoints that are health checked before making the routing decision. Unhealthy endpoints are omitted from the results. If all endpoints are unhealthy, we serve a response based on the `backup_geo_targets`." }, "trickleTraffic": { -"description": "When serving state is PRIMARY, this field provides the option of sending a small percentage of the traffic to the backup targets.", +"description": "When serving state is `PRIMARY`, this field provides the option of sending a small percentage of the traffic to the backup targets.", "format": "double", "type": "number" } @@ -3219,7 +3198,7 @@ "properties": { "healthCheckedTargets": { "$ref": "RRSetRoutingPolicyHealthCheckTargets", -"description": "Endpoints that are health checked before making the routing decision. The unhealthy endpoints are omitted from the result. If all endpoints within a bucket are unhealthy, we choose a different bucket (sampled with respect to its weight) for responding. If DNSSEC is enabled for this zone, only one of rrdata or health_checked_targets can be set." +"description": "Endpoints that are health checked before making the routing decision. The unhealthy endpoints are omitted from the result. If all endpoints within a bucket are unhealthy, we choose a different bucket (sampled with respect to its weight) for responding. If DNSSEC is enabled for this zone, only one of `rrdata` or `health_checked_targets` can be set." }, "kind": { "default": "dns#rRSetRoutingPolicyWrrPolicyWrrPolicyItem", @@ -3232,14 +3211,14 @@ "type": "array" }, "signatureRrdatas": { -"description": "DNSSEC generated signatures for all the rrdata within this item. Note that if health checked targets are provided for DNSSEC enabled zones, there's a restriction of 1 IP address per item.", +"description": "DNSSEC generated signatures for all the `rrdata` within this item. Note that if health checked targets are provided for DNSSEC enabled zones, there's a restriction of 1 IP address per item.", "items": { "type": "string" }, "type": "array" }, "weight": { -"description": "The weight corresponding to this WrrPolicyItem object. When multiple WrrPolicyItem objects are configured, the probability of returning an WrrPolicyItem object's data is proportional to its weight relative to the sum of weights configured for all items. This weight must be non-negative.", +"description": "The weight corresponding to this `WrrPolicyItem` object. When multiple `WrrPolicyItem` objects are configured, the probability of returning an `WrrPolicyItem` object's data is proportional to its weight relative to the sum of weights configured for all items. This weight must be non-negative.", "format": "double", "type": "number" } @@ -3260,7 +3239,7 @@ }, "routingPolicy": { "$ref": "RRSetRoutingPolicy", -"description": "Configures dynamic query responses based on either the geo location of the querying user or a weighted round robin based routing policy. A valid ResourceRecordSet contains only rrdata (for static resolution) or a routing_policy (for dynamic resolution)." +"description": "Configures dynamic query responses based on either the geo location of the querying user or a weighted round robin based routing policy. A valid `ResourceRecordSet` contains only `rrdata` (for static resolution) or a `routing_policy` (for dynamic resolution)." }, "rrdatas": { "description": "As defined in RFC 1035 (section 5) and RFC 1034 (section 3.6.1) -- see examples.", @@ -3277,7 +3256,7 @@ "type": "array" }, "ttl": { -"description": "Number of seconds that this ResourceRecordSet can be cached by resolvers.", +"description": "Number of seconds that this `ResourceRecordSet` can be cached by resolvers.", "format": "int32", "type": "integer" }, @@ -3296,16 +3275,13 @@ "ResourceRecordSetsListResponse": { "id": "ResourceRecordSetsListResponse", "properties": { -"header": { -"$ref": "ResponseHeader" -}, "kind": { "default": "dns#resourceRecordSetsListResponse", "description": "Type of resource.", "type": "string" }, "nextPageToken": { -"description": "The presence of this field indicates that there exist more results following your last page of results in pagination order. To fetch them, make another list request using this value as your pagination token. This lets you retrieve the complete contents of even larger collections, one page at a time. However, if the collection changes between paginated list requests, the set of elements returned is an inconsistent view of the collection. You cannot retrieve a consistent snapshot of a collection larger than the maximum page size.", +"description": "This field indicates that more results are available beyond the last page displayed. To fetch the results, make another list request and use this value as your page token. This lets you retrieve the complete contents of a very large collection one page at a time. However, if the contents of the collection change between the first and last paginated list request, the set of all elements returned are an inconsistent view of the collection. You can't retrieve a consistent snapshot of a collection larger than the maximum page size.", "type": "string" }, "rrsets": { @@ -3318,25 +3294,11 @@ }, "type": "object" }, -"ResponseHeader": { -"description": "Elements common to every response.", -"id": "ResponseHeader", -"properties": { -"operationId": { -"description": "For mutating operation requests that completed successfully. This is the client_operation_id if the client specified it, otherwise it is generated by the server (output only).", -"type": "string" -} -}, -"type": "object" -}, "ResponsePoliciesListResponse": { "id": "ResponsePoliciesListResponse", "properties": { -"header": { -"$ref": "ResponseHeader" -}, "nextPageToken": { -"description": "The presence of this field indicates that more results exist following your last page of results in pagination order. To fetch them, make another list request by using this value as your page token. This lets you view the complete contents of even very large collections one page at a time. However, if the contents of the collection change between the first and last paginated list request, the set of all elements returned are an inconsistent view of the collection. You cannot retrieve a consistent snapshot of a collection larger than the maximum page size.", +"description": "This field indicates that more results are available beyond the last page displayed. To fetch the results, make another list request and use this value as your page token. This lets you retrieve the complete contents of a very large collection one page at a time. However, if the contents of the collection change between the first and last paginated list request, the set of all elements returned are an inconsistent view of the collection. You can't retrieve a consistent snapshot of a collection larger than the maximum page size.", "type": "string" }, "responsePolicies": { @@ -3352,9 +3314,6 @@ "ResponsePoliciesPatchResponse": { "id": "ResponsePoliciesPatchResponse", "properties": { -"header": { -"$ref": "ResponseHeader" -}, "responsePolicy": { "$ref": "ResponsePolicy" } @@ -3364,9 +3323,6 @@ "ResponsePoliciesUpdateResponse": { "id": "ResponsePoliciesUpdateResponse", "properties": { -"header": { -"$ref": "ResponseHeader" -}, "responsePolicy": { "$ref": "ResponsePolicy" } @@ -3440,7 +3396,7 @@ "type": "string" }, "networkUrl": { -"description": "The fully qualified URL of the VPC network to bind to. This should be formatted like https://www.googleapis.com/compute/v1/projects/{project}/global/networks/{network}", +"description": "The fully qualified URL of the VPC network to bind to. This should be formatted like `https://www.googleapis.com/compute/v1/projects/{project}/global/networks/{network}`", "type": "string" } }, @@ -3458,7 +3414,7 @@ ], "enumDescriptions": [ "", -"Skip a less-specific ResponsePolicyRule and continue normal query logic. This can be used with a less-specific wildcard selector to exempt a subset of the wildcard ResponsePolicyRule from the ResponsePolicy behavior and query the public Internet instead. For instance, if these rules exist: *.example.com -> LocalData 1.2.3.4 foo.example.com -> Behavior 'bypassResponsePolicy' Then a query for 'foo.example.com' skips the wildcard. This additionally functions to facilitate the allowlist feature. RPZs can be applied to multiple levels in the (eventually org, folder, project, network) hierarchy. If a rule is applied at a higher level of the hierarchy, adding a passthru rule at a lower level will supersede that, and a query from an affected vm to that domain will be exempt from the RPZ and proceed to normal resolution behavior." +"Skip a less-specific Response Policy Rule and let the query logic continue. This mechanism, when used with wildcard selectors, lets you exempt specific subdomains from a broader Response Policy Rule and direct the queries to the public internet instead. For example, if the following rules exist: ``` *.example.com -> LocalData 1.2.3.4 foo.example.com -> Behavior 'passthrough' ``` A query for foo.example.com skips the wildcard rule. This functionality also facilitates allowlisting. Response Policy Zones (RPZs) can be applied at multiple levels within the hierarchy: for example, an organization, a folder, a project, or a VPC network. If an RPZ rule is applied at a higher level, adding a `passthrough` rule at a lower level will override it. Queries from affected virtual machines (VMs) to that domain bypass the RPZ and proceed with normal resolution." ], "type": "string" }, @@ -3497,11 +3453,8 @@ "ResponsePolicyRulesListResponse": { "id": "ResponsePolicyRulesListResponse", "properties": { -"header": { -"$ref": "ResponseHeader" -}, "nextPageToken": { -"description": "The presence of this field indicates that there exist more results following your last page of results in pagination order. To fetch them, make another list request using this value as your page token. This lets you the complete contents of even very large collections one page at a time. However, if the contents of the collection change between the first and last paginated list request, the set of all elements returned are an inconsistent view of the collection. You cannot retrieve a consistent snapshot of a collection larger than the maximum page size.", +"description": "This field indicates that more results are available beyond the last page displayed. To fetch the results, make another list request and use this value as your page token. This lets you retrieve the complete contents of a very large collection one page at a time. However, if the contents of the collection change between the first and last paginated list request, the set of all elements returned are an inconsistent view of the collection. You can't retrieve a consistent snapshot of a collection larger than the maximum page size.", "type": "string" }, "responsePolicyRules": { @@ -3517,9 +3470,6 @@ "ResponsePolicyRulesPatchResponse": { "id": "ResponsePolicyRulesPatchResponse", "properties": { -"header": { -"$ref": "ResponseHeader" -}, "responsePolicyRule": { "$ref": "ResponsePolicyRule" } @@ -3529,9 +3479,6 @@ "ResponsePolicyRulesUpdateResponse": { "id": "ResponsePolicyRulesUpdateResponse", "properties": { -"header": { -"$ref": "ResponseHeader" -}, "responsePolicyRule": { "$ref": "ResponsePolicyRule" } diff --git a/googleapiclient/discovery_cache/documents/dns.v1beta2.json b/googleapiclient/discovery_cache/documents/dns.v1beta2.json index 044828410fc..0134dda1b85 100644 --- a/googleapiclient/discovery_cache/documents/dns.v1beta2.json +++ b/googleapiclient/discovery_cache/documents/dns.v1beta2.json @@ -1821,11 +1821,11 @@ } } }, -"revision": "20240524", +"revision": "20240531", "rootUrl": "https://dns.googleapis.com/", "schemas": { "Change": { -"description": "A Change represents a set of ResourceRecordSet additions and deletions applied atomically to a ManagedZone. ResourceRecordSets within a ManagedZone are modified by creating a new Change element in the Changes collection. In turn the Changes collection also records the past modifications to the ResourceRecordSets in a ManagedZone. The current state of the ManagedZone is the sum effect of applying all Change elements in the Changes collection in sequence.", +"description": "A Change represents a set of `ResourceRecordSet` additions and deletions applied atomically to a ManagedZone. ResourceRecordSets within a ManagedZone are modified by creating a new Change element in the Changes collection. In turn the Changes collection also records the past modifications to the `ResourceRecordSets` in a `ManagedZone`. The current state of the `ManagedZone` is the sum effect of applying all `Change` elements in the `Changes` collection in sequence.", "id": "Change", "properties": { "additions": { @@ -1884,16 +1884,13 @@ }, "type": "array" }, -"header": { -"$ref": "ResponseHeader" -}, "kind": { "default": "dns#changesListResponse", "description": "Type of resource.", "type": "string" }, "nextPageToken": { -"description": "The presence of this field indicates that there exist more results following your last page of results in pagination order. To fetch them, make another list request using this value as your pagination token. This lets you retrieve the complete contents of even very large collections one page at a time. However, if the contents of the collection change between the first and last paginated list request, the set of all elements returned are an inconsistent view of the collection. You cannot retrieve a \"snapshot\" of collections larger than the maximum page size.", +"description": "This field indicates that more results are available beyond the last page displayed. To fetch the results, make another list request and use this value as your page token. This lets you retrieve the complete contents of a very large collection one page at a time. However, if the contents of the collection change between the first and last paginated list request, the set of all elements returned are an inconsistent view of the collection. You can't retrieve a consistent snapshot of a collection larger than the maximum page size.", "type": "string" } }, @@ -2058,16 +2055,13 @@ }, "type": "array" }, -"header": { -"$ref": "ResponseHeader" -}, "kind": { "default": "dns#dnsKeysListResponse", "description": "Type of resource.", "type": "string" }, "nextPageToken": { -"description": "The presence of this field indicates that there exist more results following your last page of results in pagination order. To fetch them, make another list request using this value as your pagination token. In this way you can retrieve the complete contents of even very large collections one page at a time. However, if the contents of the collection change between the first and last paginated list request, the set of all elements returned are an inconsistent view of the collection. There is no way to retrieve a \"snapshot\" of collections larger than the maximum page size.", +"description": "This field indicates that more results are available beyond the last page displayed. To fetch the results, make another list request and use this value as your page token. This lets you retrieve the complete contents of a very large collection one page at a time. However, if the contents of the collection change between the first and last paginated list request, the set of all elements returned are an inconsistent view of the collection. You can't retrieve a consistent snapshot of a collection larger than the maximum page size.", "type": "string" } }, @@ -2345,8 +2339,8 @@ "private" ], "enumDescriptions": [ -"", -"" +"Indicates that records in this zone can be queried from the public internet.", +"Indicates that records in this zone cannot be queried from the public internet. Access to private zones depends on the zone configuration." ], "type": "string" } @@ -2389,8 +2383,8 @@ "nsec3" ], "enumDescriptions": [ -"", -"" +"Indicates that Cloud DNS will sign records in the managed zone according to RFC 4034 and respond with NSEC records for names that do not exist.", +"Indicates that Cloud DNS will sign records in the managed zone according to RFC 5155 and respond with NSEC3 records for names that do not exist." ], "type": "string" }, @@ -2461,16 +2455,13 @@ "ManagedZoneOperationsListResponse": { "id": "ManagedZoneOperationsListResponse", "properties": { -"header": { -"$ref": "ResponseHeader" -}, "kind": { "default": "dns#managedZoneOperationsListResponse", "description": "Type of resource.", "type": "string" }, "nextPageToken": { -"description": "The presence of this field indicates that there exist more results following your last page of results in pagination order. To fetch them, make another list request using this value as your page token. This lets you retrieve the complete contents of even very large collections one page at a time. However, if the contents of the collection change between the first and last paginated list request, the set of all elements returned are an inconsistent view of the collection. You cannot retrieve a consistent snapshot of a collection larger than the maximum page size.", +"description": "This field indicates that more results are available beyond the last page displayed. To fetch the results, make another list request and use this value as your page token. This lets you retrieve the complete contents of a very large collection one page at a time. However, if the contents of the collection change between the first and last paginated list request, the set of all elements returned are an inconsistent view of the collection. You can't retrieve a consistent snapshot of a collection larger than the maximum page size.", "type": "string" }, "operations": { @@ -2509,7 +2500,7 @@ "type": "string" }, "networkUrl": { -"description": "The fully qualified URL of the VPC network to forward queries to. This should be formatted like https://www.googleapis.com/compute/v1/projects/{project}/global/networks/{network}", +"description": "The fully qualified URL of the VPC network to forward queries to. This should be formatted like `https://www.googleapis.com/compute/v1/projects/{project}/global/networks/{network}`", "type": "string" } }, @@ -2561,7 +2552,7 @@ "type": "string" }, "networkUrl": { -"description": "The fully qualified URL of the VPC network to bind to. Format this URL like https://www.googleapis.com/compute/v1/projects/{project}/global/networks/{network}", +"description": "The fully qualified URL of the VPC network to bind to. Format this URL like `https://www.googleapis.com/compute/v1/projects/{project}/global/networks/{network}`", "type": "string" } }, @@ -2604,7 +2595,7 @@ "type": "string" }, "namespaceUrl": { -"description": "The fully qualified URL of the namespace associated with the zone. Format must be https://servicedirectory.googleapis.com/v1/projects/{project}/locations/{location}/namespaces/{namespace}", +"description": "The fully qualified URL of the namespace associated with the zone. Format must be `https://servicedirectory.googleapis.com/v1/projects/{project}/locations/{location}/namespaces/{namespace}`", "type": "string" } }, @@ -2613,9 +2604,6 @@ "ManagedZonesListResponse": { "id": "ManagedZonesListResponse", "properties": { -"header": { -"$ref": "ResponseHeader" -}, "kind": { "default": "dns#managedZonesListResponse", "description": "Type of resource.", @@ -2629,7 +2617,7 @@ "type": "array" }, "nextPageToken": { -"description": "The presence of this field indicates that there exist more results following your last page of results in pagination order. To fetch them, make another list request using this value as your page token. This lets you the complete contents of even very large collections one page at a time. However, if the contents of the collection change between the first and last paginated list request, the set of all elements returned are an inconsistent view of the collection. You cannot retrieve a consistent snapshot of a collection larger than the maximum page size.", +"description": "This field indicates that more results are available beyond the last page displayed. To fetch the results, make another list request and use this value as your page token. This lets you retrieve the complete contents of a very large collection one page at a time. However, if the contents of the collection change between the first and last paginated list request, the set of all elements returned are an inconsistent view of the collection. You can't retrieve a consistent snapshot of a collection larger than the maximum page size.", "type": "string" } }, @@ -2713,16 +2701,13 @@ "PoliciesListResponse": { "id": "PoliciesListResponse", "properties": { -"header": { -"$ref": "ResponseHeader" -}, "kind": { "default": "dns#policiesListResponse", "description": "Type of resource.", "type": "string" }, "nextPageToken": { -"description": "The presence of this field indicates that there exist more results following your last page of results in pagination order. To fetch them, make another list request using this value as your page token. This lets you the complete contents of even very large collections one page at a time. However, if the contents of the collection change between the first and last paginated list request, the set of all elements returned are an inconsistent view of the collection. You cannot retrieve a consistent snapshot of a collection larger than the maximum page size.", +"description": "This field indicates that more results are available beyond the last page displayed. To fetch the results, make another list request and use this value as your page token. This lets you retrieve the complete contents of a very large collection one page at a time. However, if the contents of the collection change between the first and last paginated list request, the set of all elements returned are an inconsistent view of the collection. You can't retrieve a consistent snapshot of a collection larger than the maximum page size.", "type": "string" }, "policies": { @@ -2738,9 +2723,6 @@ "PoliciesPatchResponse": { "id": "PoliciesPatchResponse", "properties": { -"header": { -"$ref": "ResponseHeader" -}, "policy": { "$ref": "Policy" } @@ -2750,9 +2732,6 @@ "PoliciesUpdateResponse": { "id": "PoliciesUpdateResponse", "properties": { -"header": { -"$ref": "ResponseHeader" -}, "policy": { "$ref": "Policy" } @@ -2864,7 +2843,7 @@ "type": "object" }, "Project": { -"description": "A project resource. The project is a top level container for resources including Cloud DNS ManagedZones. Projects can be created only in the APIs console. Next tag: 7.", +"description": "A project resource. The project is a top level container for resources including Cloud DNS ManagedZones. Projects can be created only in the APIs console.", "id": "Project", "properties": { "id": { @@ -3049,7 +3028,7 @@ "type": "object" }, "RRSetRoutingPolicyGeoPolicy": { -"description": "Configures a RRSetRoutingPolicy that routes based on the geo location of the querying user.", +"description": "Configures a `RRSetRoutingPolicy` that routes based on the geo location of the querying user.", "id": "RRSetRoutingPolicyGeoPolicy", "properties": { "enableFencing": { @@ -3076,7 +3055,7 @@ "properties": { "healthCheckedTargets": { "$ref": "RRSetRoutingPolicyHealthCheckTargets", -"description": "For A and AAAA types only. Endpoints to return in the query result only if they are healthy. These can be specified along with rrdata within this item." +"description": "For A and AAAA types only. Endpoints to return in the query result only if they are healthy. These can be specified along with `rrdata` within this item." }, "kind": { "default": "dns#rRSetRoutingPolicyGeoPolicyGeoPolicyItem", @@ -3093,7 +3072,7 @@ "type": "array" }, "signatureRrdatas": { -"description": "DNSSEC generated signatures for all the rrdata within this item. If health checked targets are provided for DNSSEC enabled zones, there's a restriction of 1 IP address per item.", +"description": "DNSSEC generated signatures for all the `rrdata` within this item. If health checked targets are provided for DNSSEC enabled zones, there's a restriction of 1 IP address per item.", "items": { "type": "string" }, @@ -3103,7 +3082,7 @@ "type": "object" }, "RRSetRoutingPolicyHealthCheckTargets": { -"description": "HealthCheckTargets describes endpoints to health-check when responding to Routing Policy queries. Only the healthy endpoints will be included in the response. Only one of internal_load_balancer and external_endpoints should be set.", +"description": "HealthCheckTargets describes endpoints to health-check when responding to Routing Policy queries. Only the healthy endpoints will be included in the response.", "id": "RRSetRoutingPolicyHealthCheckTargets", "properties": { "internalLoadBalancers": { @@ -3133,8 +3112,8 @@ ], "enumDescriptions": [ "", -"", -"" +"Indicates the load balancer is accessible via TCP.", +"Indicates the load balancer is accessible via UDP." ], "type": "string" }, @@ -3152,14 +3131,14 @@ ], "enumDescriptions": [ "", -"", -"", -"" +"Indicates the load balancer is a Cross-Region Application Load Balancer.", +"Indicates the load balancer is a Regional Network Passthrough Load Balancer.", +"Indicates the load balancer is a Regional Application Load Balancer." ], "type": "string" }, "networkUrl": { -"description": "The fully qualified URL of the network that the load balancer is attached to. This should be formatted like https://www.googleapis.com/compute/v1/projects/{project}/global/networks/{network} .", +"description": "The fully qualified URL of the network that the load balancer is attached to. This should be formatted like `https://www.googleapis.com/compute/v1/projects/{project}/global/networks/{network}`.", "type": "string" }, "port": { @@ -3183,7 +3162,7 @@ "properties": { "backupGeoTargets": { "$ref": "RRSetRoutingPolicyGeoPolicy", -"description": "Backup targets provide a regional failover policy for the otherwise global primary targets. If serving state is set to BACKUP, this policy essentially becomes a geo routing policy." +"description": "Backup targets provide a regional failover policy for the otherwise global primary targets. If serving state is set to `BACKUP`, this policy essentially becomes a geo routing policy." }, "kind": { "default": "dns#rRSetRoutingPolicyPrimaryBackupPolicy", @@ -3191,10 +3170,10 @@ }, "primaryTargets": { "$ref": "RRSetRoutingPolicyHealthCheckTargets", -"description": "Endpoints that are health checked before making the routing decision. Unhealthy endpoints are omitted from the results. If all endpoints are unhealthy, we serve a response based on the backup_geo_targets." +"description": "Endpoints that are health checked before making the routing decision. Unhealthy endpoints are omitted from the results. If all endpoints are unhealthy, we serve a response based on the `backup_geo_targets`." }, "trickleTraffic": { -"description": "When serving state is PRIMARY, this field provides the option of sending a small percentage of the traffic to the backup targets.", +"description": "When serving state is `PRIMARY`, this field provides the option of sending a small percentage of the traffic to the backup targets.", "format": "double", "type": "number" } @@ -3224,7 +3203,7 @@ "properties": { "healthCheckedTargets": { "$ref": "RRSetRoutingPolicyHealthCheckTargets", -"description": "Endpoints that are health checked before making the routing decision. The unhealthy endpoints are omitted from the result. If all endpoints within a bucket are unhealthy, we choose a different bucket (sampled with respect to its weight) for responding. If DNSSEC is enabled for this zone, only one of rrdata or health_checked_targets can be set." +"description": "Endpoints that are health checked before making the routing decision. The unhealthy endpoints are omitted from the result. If all endpoints within a bucket are unhealthy, we choose a different bucket (sampled with respect to its weight) for responding. If DNSSEC is enabled for this zone, only one of `rrdata` or `health_checked_targets` can be set." }, "kind": { "default": "dns#rRSetRoutingPolicyWrrPolicyWrrPolicyItem", @@ -3237,14 +3216,14 @@ "type": "array" }, "signatureRrdatas": { -"description": "DNSSEC generated signatures for all the rrdata within this item. Note that if health checked targets are provided for DNSSEC enabled zones, there's a restriction of 1 IP address per item.", +"description": "DNSSEC generated signatures for all the `rrdata` within this item. Note that if health checked targets are provided for DNSSEC enabled zones, there's a restriction of 1 IP address per item.", "items": { "type": "string" }, "type": "array" }, "weight": { -"description": "The weight corresponding to this WrrPolicyItem object. When multiple WrrPolicyItem objects are configured, the probability of returning an WrrPolicyItem object's data is proportional to its weight relative to the sum of weights configured for all items. This weight must be non-negative.", +"description": "The weight corresponding to this `WrrPolicyItem` object. When multiple `WrrPolicyItem` objects are configured, the probability of returning an `WrrPolicyItem` object's data is proportional to its weight relative to the sum of weights configured for all items. This weight must be non-negative.", "format": "double", "type": "number" } @@ -3265,7 +3244,7 @@ }, "routingPolicy": { "$ref": "RRSetRoutingPolicy", -"description": "Configures dynamic query responses based on either the geo location of the querying user or a weighted round robin based routing policy. A valid ResourceRecordSet contains only rrdata (for static resolution) or a routing_policy (for dynamic resolution)." +"description": "Configures dynamic query responses based on either the geo location of the querying user or a weighted round robin based routing policy. A valid `ResourceRecordSet` contains only `rrdata` (for static resolution) or a `routing_policy` (for dynamic resolution)." }, "rrdatas": { "description": "As defined in RFC 1035 (section 5) and RFC 1034 (section 3.6.1) -- see examples.", @@ -3282,7 +3261,7 @@ "type": "array" }, "ttl": { -"description": "Number of seconds that this ResourceRecordSet can be cached by resolvers.", +"description": "Number of seconds that this `ResourceRecordSet` can be cached by resolvers.", "format": "int32", "type": "integer" }, @@ -3296,16 +3275,13 @@ "ResourceRecordSetsListResponse": { "id": "ResourceRecordSetsListResponse", "properties": { -"header": { -"$ref": "ResponseHeader" -}, "kind": { "default": "dns#resourceRecordSetsListResponse", "description": "Type of resource.", "type": "string" }, "nextPageToken": { -"description": "The presence of this field indicates that there exist more results following your last page of results in pagination order. To fetch them, make another list request using this value as your pagination token. This lets you retrieve the complete contents of even larger collections, one page at a time. However, if the collection changes between paginated list requests, the set of elements returned is an inconsistent view of the collection. You cannot retrieve a consistent snapshot of a collection larger than the maximum page size.", +"description": "This field indicates that more results are available beyond the last page displayed. To fetch the results, make another list request and use this value as your page token. This lets you retrieve the complete contents of a very large collection one page at a time. However, if the contents of the collection change between the first and last paginated list request, the set of all elements returned are an inconsistent view of the collection. You can't retrieve a consistent snapshot of a collection larger than the maximum page size.", "type": "string" }, "rrsets": { @@ -3318,25 +3294,11 @@ }, "type": "object" }, -"ResponseHeader": { -"description": "Elements common to every response.", -"id": "ResponseHeader", -"properties": { -"operationId": { -"description": "For mutating operation requests that completed successfully. This is the client_operation_id if the client specified it, otherwise it is generated by the server (output only).", -"type": "string" -} -}, -"type": "object" -}, "ResponsePoliciesListResponse": { "id": "ResponsePoliciesListResponse", "properties": { -"header": { -"$ref": "ResponseHeader" -}, "nextPageToken": { -"description": "The presence of this field indicates that more results exist following your last page of results in pagination order. To fetch them, make another list request by using this value as your page token. This lets you view the complete contents of even very large collections one page at a time. However, if the contents of the collection change between the first and last paginated list request, the set of all elements returned are an inconsistent view of the collection. You cannot retrieve a consistent snapshot of a collection larger than the maximum page size.", +"description": "This field indicates that more results are available beyond the last page displayed. To fetch the results, make another list request and use this value as your page token. This lets you retrieve the complete contents of a very large collection one page at a time. However, if the contents of the collection change between the first and last paginated list request, the set of all elements returned are an inconsistent view of the collection. You can't retrieve a consistent snapshot of a collection larger than the maximum page size.", "type": "string" }, "responsePolicies": { @@ -3352,9 +3314,6 @@ "ResponsePoliciesPatchResponse": { "id": "ResponsePoliciesPatchResponse", "properties": { -"header": { -"$ref": "ResponseHeader" -}, "responsePolicy": { "$ref": "ResponsePolicy" } @@ -3364,9 +3323,6 @@ "ResponsePoliciesUpdateResponse": { "id": "ResponsePoliciesUpdateResponse", "properties": { -"header": { -"$ref": "ResponseHeader" -}, "responsePolicy": { "$ref": "ResponsePolicy" } @@ -3440,7 +3396,7 @@ "type": "string" }, "networkUrl": { -"description": "The fully qualified URL of the VPC network to bind to. This should be formatted like https://www.googleapis.com/compute/v1/projects/{project}/global/networks/{network}", +"description": "The fully qualified URL of the VPC network to bind to. This should be formatted like `https://www.googleapis.com/compute/v1/projects/{project}/global/networks/{network}`", "type": "string" } }, @@ -3458,7 +3414,7 @@ ], "enumDescriptions": [ "", -"Skip a less-specific ResponsePolicyRule and continue normal query logic. This can be used with a less-specific wildcard selector to exempt a subset of the wildcard ResponsePolicyRule from the ResponsePolicy behavior and query the public Internet instead. For instance, if these rules exist: *.example.com -> LocalData 1.2.3.4 foo.example.com -> Behavior 'bypassResponsePolicy' Then a query for 'foo.example.com' skips the wildcard. This additionally functions to facilitate the allowlist feature. RPZs can be applied to multiple levels in the (eventually org, folder, project, network) hierarchy. If a rule is applied at a higher level of the hierarchy, adding a passthru rule at a lower level will supersede that, and a query from an affected vm to that domain will be exempt from the RPZ and proceed to normal resolution behavior." +"Skip a less-specific Response Policy Rule and let the query logic continue. This mechanism, when used with wildcard selectors, lets you exempt specific subdomains from a broader Response Policy Rule and direct the queries to the public internet instead. For example, if the following rules exist: ``` *.example.com -> LocalData 1.2.3.4 foo.example.com -> Behavior 'passthrough' ``` A query for foo.example.com skips the wildcard rule. This functionality also facilitates allowlisting. Response Policy Zones (RPZs) can be applied at multiple levels within the hierarchy: for example, an organization, a folder, a project, or a VPC network. If an RPZ rule is applied at a higher level, adding a `passthrough` rule at a lower level will override it. Queries from affected virtual machines (VMs) to that domain bypass the RPZ and proceed with normal resolution." ], "type": "string" }, @@ -3497,11 +3453,8 @@ "ResponsePolicyRulesListResponse": { "id": "ResponsePolicyRulesListResponse", "properties": { -"header": { -"$ref": "ResponseHeader" -}, "nextPageToken": { -"description": "The presence of this field indicates that there exist more results following your last page of results in pagination order. To fetch them, make another list request using this value as your page token. This lets you the complete contents of even very large collections one page at a time. However, if the contents of the collection change between the first and last paginated list request, the set of all elements returned are an inconsistent view of the collection. You cannot retrieve a consistent snapshot of a collection larger than the maximum page size.", +"description": "This field indicates that more results are available beyond the last page displayed. To fetch the results, make another list request and use this value as your page token. This lets you retrieve the complete contents of a very large collection one page at a time. However, if the contents of the collection change between the first and last paginated list request, the set of all elements returned are an inconsistent view of the collection. You can't retrieve a consistent snapshot of a collection larger than the maximum page size.", "type": "string" }, "responsePolicyRules": { @@ -3517,9 +3470,6 @@ "ResponsePolicyRulesPatchResponse": { "id": "ResponsePolicyRulesPatchResponse", "properties": { -"header": { -"$ref": "ResponseHeader" -}, "responsePolicyRule": { "$ref": "ResponsePolicyRule" } @@ -3529,9 +3479,6 @@ "ResponsePolicyRulesUpdateResponse": { "id": "ResponsePolicyRulesUpdateResponse", "properties": { -"header": { -"$ref": "ResponseHeader" -}, "responsePolicyRule": { "$ref": "ResponsePolicyRule" } diff --git a/googleapiclient/discovery_cache/documents/docs.v1.json b/googleapiclient/discovery_cache/documents/docs.v1.json index 3da4ec778b6..7fadaeadc9e 100644 --- a/googleapiclient/discovery_cache/documents/docs.v1.json +++ b/googleapiclient/discovery_cache/documents/docs.v1.json @@ -216,7 +216,7 @@ } } }, -"revision": "20240603", +"revision": "20240604", "rootUrl": "https://docs.googleapis.com/", "schemas": { "AutoText": { diff --git a/googleapiclient/discovery_cache/documents/domains.v1.json b/googleapiclient/discovery_cache/documents/domains.v1.json index 6d38d544c9c..20526664694 100644 --- a/googleapiclient/discovery_cache/documents/domains.v1.json +++ b/googleapiclient/discovery_cache/documents/domains.v1.json @@ -472,6 +472,34 @@ "https://www.googleapis.com/auth/cloud-platform" ] }, +"initiatePushTransfer": { +"description": "Initiates the `Push Transfer` process to transfer the domain to another registrar. The process might complete instantly or might require confirmation or additional work. Check the emails sent to the email address of the registrant. The process is aborted after a timeout if it's not completed. This method is only supported for domains that have the `REQUIRE_PUSH_TRANSFER` property in the list of `domain_properties`. The domain must also be unlocked before it can be transferred to a different registrar. For more information, see [Transfer a registered domain to another registrar](https://cloud.google.com/domains/docs/transfer-domain-to-another-registrar).", +"flatPath": "v1/projects/{projectsId}/locations/{locationsId}/registrations/{registrationsId}:initiatePushTransfer", +"httpMethod": "POST", +"id": "domains.projects.locations.registrations.initiatePushTransfer", +"parameterOrder": [ +"registration" +], +"parameters": { +"registration": { +"description": "Required. The name of the `Registration` for which the push transfer is initiated, in the format `projects/*/locations/*/registrations/*`.", +"location": "path", +"pattern": "^projects/[^/]+/locations/[^/]+/registrations/[^/]+$", +"required": true, +"type": "string" +} +}, +"path": "v1/{+registration}:initiatePushTransfer", +"request": { +"$ref": "InitiatePushTransferRequest" +}, +"response": { +"$ref": "Operation" +}, +"scopes": [ +"https://www.googleapis.com/auth/cloud-platform" +] +}, "list": { "description": "Lists the `Registration` resources in a project.", "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/registrations", @@ -575,8 +603,36 @@ "https://www.googleapis.com/auth/cloud-platform" ] }, +"renewDomain": { +"description": "Renews a recently expired domain. This method can only be called on domains that expired in the previous 30 days. After the renewal, the new expiration time of the domain is one year after the old expiration time and you are charged a `yearly_price` for the renewal.", +"flatPath": "v1/projects/{projectsId}/locations/{locationsId}/registrations/{registrationsId}:renewDomain", +"httpMethod": "POST", +"id": "domains.projects.locations.registrations.renewDomain", +"parameterOrder": [ +"registration" +], +"parameters": { +"registration": { +"description": "Required. The name of the `Registration` whish is being renewed, in the format `projects/*/locations/*/registrations/*`.", +"location": "path", +"pattern": "^projects/[^/]+/locations/[^/]+/registrations/[^/]+$", +"required": true, +"type": "string" +} +}, +"path": "v1/{+registration}:renewDomain", +"request": { +"$ref": "RenewDomainRequest" +}, +"response": { +"$ref": "Operation" +}, +"scopes": [ +"https://www.googleapis.com/auth/cloud-platform" +] +}, "resetAuthorizationCode": { -"description": "Resets the authorization code of the `Registration` to a new random string. You can call this method only after 60 days have elapsed since the initial domain registration.", +"description": "Resets the authorization code of the `Registration` to a new random string. You can call this method only after 60 days have elapsed since the initial domain registration. Domains that have the `REQUIRE_PUSH_TRANSFER` property in the list of `domain_properties` don't support authorization codes and must use the `InitiatePushTransfer` method to initiate the process to transfer the domain to a different registrar.", "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/registrations/{registrationsId}:resetAuthorizationCode", "httpMethod": "POST", "id": "domains.projects.locations.registrations.resetAuthorizationCode", @@ -604,7 +660,7 @@ ] }, "retrieveAuthorizationCode": { -"description": "Gets the authorization code of the `Registration` for the purpose of transferring the domain to another registrar. You can call this method only after 60 days have elapsed since the initial domain registration.", +"description": "Gets the authorization code of the `Registration` for the purpose of transferring the domain to another registrar. You can call this method only after 60 days have elapsed since the initial domain registration. Domains that have the `REQUIRE_PUSH_TRANSFER` property in the list of `domain_properties` don't support authorization codes and must use the `InitiatePushTransfer` method to initiate the process to transfer the domain to a different registrar.", "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/registrations/{registrationsId}:retrieveAuthorizationCode", "httpMethod": "GET", "id": "domains.projects.locations.registrations.retrieveAuthorizationCode", @@ -628,6 +684,31 @@ "https://www.googleapis.com/auth/cloud-platform" ] }, +"retrieveGoogleDomainsForwardingConfig": { +"description": "Lists the deprecated domain and email forwarding configurations you set up in the deprecated Google Domains UI. The configuration is present only for domains with the `google_domains_redirects_data_available` set to `true` in the `Registration`'s `dns_settings`. A forwarding configuration might not work correctly if required DNS records are not present in the domain's authoritative DNS Zone.", +"flatPath": "v1/projects/{projectsId}/locations/{locationsId}/registrations/{registrationsId}:retrieveGoogleDomainsForwardingConfig", +"httpMethod": "GET", +"id": "domains.projects.locations.registrations.retrieveGoogleDomainsForwardingConfig", +"parameterOrder": [ +"registration" +], +"parameters": { +"registration": { +"description": "Required. The name of the `Registration` whose Google Domains forwarding configuration details are being retrieved, in the format `projects/*/locations/*/registrations/*`.", +"location": "path", +"pattern": "^projects/[^/]+/locations/[^/]+/registrations/[^/]+$", +"required": true, +"type": "string" +} +}, +"path": "v1/{+registration}:retrieveGoogleDomainsForwardingConfig", +"response": { +"$ref": "RetrieveGoogleDomainsForwardingConfigResponse" +}, +"scopes": [ +"https://www.googleapis.com/auth/cloud-platform" +] +}, "retrieveImportableDomains": { "deprecated": true, "description": "Deprecated: For more information, see [Cloud Domains feature deprecation](https://cloud.google.com/domains/docs/deprecations/feature-deprecations) Lists domain names from [Google Domains](https://domains.google/) that can be imported to Cloud Domains using the `ImportDomain` method. Since individual users can own domains in Google Domains, the list of domains returned depends on the individual user making the call. Domains already managed by Cloud Domains are not returned.", @@ -848,7 +929,7 @@ } } }, -"revision": "20240520", +"revision": "20240603", "rootUrl": "https://domains.googleapis.com/", "schemas": { "AuditConfig": { @@ -1146,6 +1227,47 @@ false }, "type": "object" }, +"DomainForwarding": { +"description": "Domain forwarding configuration.", +"id": "DomainForwarding", +"properties": { +"pathForwarding": { +"description": "If true, forwards the path after the domain name to the same path at the new address.", +"type": "boolean" +}, +"pemCertificate": { +"description": "The PEM-encoded certificate chain.", +"type": "string" +}, +"redirectType": { +"description": "The redirect type.", +"enum": [ +"REDIRECT_TYPE_UNSPECIFIED", +"TEMPORARY", +"PERMANENT" +], +"enumDescriptions": [ +"Redirect Type is unspecified.", +"301 redirect. Allows to propagate changes to the forwarding address quickly.", +"302 redirect. Allows browsers to cache the forwarding address. This may help the address resolve more quickly. Changes may take longer to propagate" +], +"type": "string" +}, +"sslEnabled": { +"description": "If true, the forwarding works also over HTTPS.", +"type": "boolean" +}, +"subdomain": { +"description": "The subdomain of the registered domain that is being forwarded. E.g. `www.example.com`, `example.com` (i.e. the registered domain itself) or `*.example.com` (i.e. all subdomains).", +"type": "string" +}, +"targetUri": { +"description": "The target of the domain forwarding, i.e. the path to redirect the `subdomain` to.", +"type": "string" +} +}, +"type": "object" +}, "DsRecord": { "description": "Defines a Delegation Signer (DS) record, which is needed to enable DNSSEC for a domain. It contains a digest (hash) of a DNSKEY record that must be present in the domain's DNS zone.", "id": "DsRecord", @@ -1224,6 +1346,21 @@ false }, "type": "object" }, +"EmailForwarding": { +"description": "Email forwarding configuration.", +"id": "EmailForwarding", +"properties": { +"alias": { +"description": "An alias recipient email that forwards emails to the `target_email_address`. For example, `admin@example.com` or `*@example.com` (wildcard alias forwards all the emails under the registered domain).", +"type": "string" +}, +"targetEmailAddress": { +"description": "Target email that receives emails sent to the `alias`.", +"type": "string" +} +}, +"type": "object" +}, "ExportRegistrationRequest": { "deprecated": true, "description": "Deprecated: For more information, see [Cloud Domains feature deprecation](https://cloud.google.com/domains/docs/deprecations/feature-deprecations). Request for the `ExportRegistration` method.", @@ -1336,6 +1473,17 @@ false }, "type": "object" }, +"InitiatePushTransferRequest": { +"description": "Request for the `InitiatePushTransfer` method.", +"id": "InitiatePushTransferRequest", +"properties": { +"tag": { +"description": "Required. The Tag of the new registrar. Can be found at [List of registrars](https://nominet.uk/registrar-list/).", +"type": "string" +} +}, +"type": "object" +}, "ListLocationsResponse": { "description": "The response message for Locations.ListLocations.", "id": "ListLocationsResponse", @@ -1428,6 +1576,21 @@ false "description": "Defines renewal, billing, and transfer settings for a `Registration`.", "id": "ManagementSettings", "properties": { +"effectiveTransferLockState": { +"description": "Output only. The actual transfer lock state for this `Registration`.", +"enum": [ +"TRANSFER_LOCK_STATE_UNSPECIFIED", +"UNLOCKED", +"LOCKED" +], +"enumDescriptions": [ +"The state is unspecified.", +"The domain is unlocked and can be transferred to another registrar.", +"The domain is locked and cannot be transferred to another registrar." +], +"readOnly": true, +"type": "string" +}, "preferredRenewalMethod": { "description": "Optional. The desired renewal method for this `Registration`. The actual `renewal_method` is automatically updated to reflect this choice. If unset or equal to `RENEWAL_METHOD_UNSPECIFIED`, the actual `renewalMethod` is treated as if it were set to `AUTOMATIC_RENEWAL`. You cannot use `RENEWAL_DISABLED` during resource creation, and you can update the renewal status only when the `Registration` resource has state `ACTIVE` or `SUSPENDED`. When `preferred_renewal_method` is set to `AUTOMATIC_RENEWAL`, the actual `renewal_method` can be set to `RENEWAL_DISABLED` in case of problems with the billing account or reported domain abuse. In such cases, check the `issues` field on the `Registration`. After the problem is resolved, the `renewal_method` is automatically updated to `preferred_renewal_method` in a few hours.", "enum": [ @@ -1474,7 +1637,7 @@ false "type": "string" }, "transferLockState": { -"description": "This is the desired transfer lock state for this `Registration`. A transfer lock controls whether the domain can be transferred to another registrar.", +"description": "This is the desired transfer lock state for this `Registration`. A transfer lock controls whether the domain can be transferred to another registrar. The transfer lock state of the domain is returned in the `effective_transfer_lock_state` property. The transfer lock state values might be different for the following reasons: * `transfer_lock_state` was updated only a short time ago. * Domains with the `TRANSFER_LOCK_UNSUPPORTED_BY_REGISTRY` state are in the list of `domain_properties`. These domains are always in the `UNLOCKED` state.", "enum": [ "TRANSFER_LOCK_STATE_UNSPECIFIED", "UNLOCKED", @@ -1812,6 +1975,24 @@ false "description": "Required. Immutable. The domain name. Unicode domain names must be expressed in Punycode format.", "type": "string" }, +"domainProperties": { +"description": "Output only. Special properties of the domain.", +"items": { +"enum": [ +"DOMAIN_PROPERTY_UNSPECIFIED", +"TRANSFER_LOCK_UNSUPPORTED_BY_REGISTRY", +"REQUIRE_PUSH_TRANSFER" +], +"enumDescriptions": [ +"The property is undefined.", +"The domain does not support transfer locks due to restrictions of the registry. Such domains are effectively always unlocked and any change made to `management_settings.transfer_lock_state` is ignored.", +"The domain uses an alternative `Push Transfer` process to transfer the domain to another registrar. There are two important consequences: * Cloud Domains does not supply the authorization codes. * To initiate the process to transfer the domain to another registrar, you must provide a tag of the registrar you want to transfer to. You can do this by using the `InitiatePushTransfer` method. For more information, see [Transfer a registered domain to another registrar](https://cloud.google.com/domains/docs/transfer-domain-to-another-registrar)." +], +"type": "string" +}, +"readOnly": true, +"type": "array" +}, "expireTime": { "description": "Output only. The expiration timestamp of the `Registration`.", "format": "google-datetime", @@ -1825,13 +2006,15 @@ false "ISSUE_UNSPECIFIED", "CONTACT_SUPPORT", "UNVERIFIED_EMAIL", -"PROBLEM_WITH_BILLING" +"PROBLEM_WITH_BILLING", +"DNS_NOT_ACTIVATED" ], "enumDescriptions": [ "The issue is undefined.", "Contact the Cloud Support team to resolve a problem with this domain.", "[ICANN](https://icann.org/) requires verification of the email address in the `Registration`'s `contact_settings.registrant_contact` field. To verify the email address, follow the instructions in the email the `registrant_contact` receives following registration. If you do not complete email verification within 15 days of registration, the domain is suspended. To resend the verification email, call ConfigureContactSettings and provide the current `registrant_contact.email`.", -"The billing account is not in good standing. The domain is not automatically renewed at its expiration time unless you resolve problems with your billing account." +"The billing account is not in good standing. The domain is not automatically renewed at its expiration time unless you resolve problems with your billing account.", +"The registry failed to validate your DNS configuration and activate your domain. The failure might happen for the following reasons: * You recently registered the domain (wait up to 72 hours). * You provided invalid name servers or name servers that correspond to a newly created DNS zone. Verify your DNS configuration. If the configuration is incorrect, you must fix it. If the configuration is correct, either wait or call the ConfigureDnsSettings method to retry the registry validation." ], "type": "string" }, @@ -1978,12 +2161,48 @@ false }, "type": "object" }, +"RenewDomainRequest": { +"description": "Request for the `RenewDomain` method.", +"id": "RenewDomainRequest", +"properties": { +"validateOnly": { +"description": "Optional. When true, only validation is performed, without actually renewing the domain. For more information, see [Request validation](https://cloud.google.com/apis/design/design_patterns#request_validation)", +"type": "boolean" +}, +"yearlyPrice": { +"$ref": "Money", +"description": "Required. Acknowledgement of the price to renew the domain for one year. To get the price, see [Cloud Domains pricing](https://cloud.google.com/domains/pricing). If not provided, the expected price is returned in the error message." +} +}, +"type": "object" +}, "ResetAuthorizationCodeRequest": { "description": "Request for the `ResetAuthorizationCode` method.", "id": "ResetAuthorizationCodeRequest", "properties": {}, "type": "object" }, +"RetrieveGoogleDomainsForwardingConfigResponse": { +"description": "Response for the `RetrieveGoogleDomainsForwardingConfig` method.", +"id": "RetrieveGoogleDomainsForwardingConfigResponse", +"properties": { +"domainForwardings": { +"description": "The list of domain forwarding configurations. A forwarding configuration might not work correctly if the required DNS records are not present in the domain's authoritative DNS zone.", +"items": { +"$ref": "DomainForwarding" +}, +"type": "array" +}, +"emailForwardings": { +"description": "The list of email forwarding configurations. A forwarding configuration might not work correctly if the required DNS records are not present in the domain's authoritative DNS zone.", +"items": { +"$ref": "EmailForwarding" +}, +"type": "array" +} +}, +"type": "object" +}, "RetrieveImportableDomainsResponse": { "deprecated": true, "description": "Deprecated: For more information, see [Cloud Domains feature deprecation](https://cloud.google.com/domains/docs/deprecations/feature-deprecations). Response for the `RetrieveImportableDomains` method.", diff --git a/googleapiclient/discovery_cache/documents/domains.v1alpha2.json b/googleapiclient/discovery_cache/documents/domains.v1alpha2.json index f9d16734e6d..a84c3ffb9e9 100644 --- a/googleapiclient/discovery_cache/documents/domains.v1alpha2.json +++ b/googleapiclient/discovery_cache/documents/domains.v1alpha2.json @@ -472,6 +472,34 @@ "https://www.googleapis.com/auth/cloud-platform" ] }, +"initiatePushTransfer": { +"description": "Initiates the `Push Transfer` process to transfer the domain to another registrar. The process might complete instantly or might require confirmation or additional work. Check the emails sent to the email address of the registrant. The process is aborted after a timeout if it's not completed. This method is only supported for domains that have the `REQUIRE_PUSH_TRANSFER` property in the list of `domain_properties`. The domain must also be unlocked before it can be transferred to a different registrar. For more information, see [Transfer a registered domain to another registrar](https://cloud.google.com/domains/docs/transfer-domain-to-another-registrar).", +"flatPath": "v1alpha2/projects/{projectsId}/locations/{locationsId}/registrations/{registrationsId}:initiatePushTransfer", +"httpMethod": "POST", +"id": "domains.projects.locations.registrations.initiatePushTransfer", +"parameterOrder": [ +"registration" +], +"parameters": { +"registration": { +"description": "Required. The name of the `Registration` for which the push transfer is initiated, in the format `projects/*/locations/*/registrations/*`.", +"location": "path", +"pattern": "^projects/[^/]+/locations/[^/]+/registrations/[^/]+$", +"required": true, +"type": "string" +} +}, +"path": "v1alpha2/{+registration}:initiatePushTransfer", +"request": { +"$ref": "InitiatePushTransferRequest" +}, +"response": { +"$ref": "Operation" +}, +"scopes": [ +"https://www.googleapis.com/auth/cloud-platform" +] +}, "list": { "description": "Lists the `Registration` resources in a project.", "flatPath": "v1alpha2/projects/{projectsId}/locations/{locationsId}/registrations", @@ -575,8 +603,36 @@ "https://www.googleapis.com/auth/cloud-platform" ] }, +"renewDomain": { +"description": "Renews a recently expired domain. This method can only be called on domains that expired in the previous 30 days. After the renewal, the new expiration time of the domain is one year after the old expiration time and you are charged a `yearly_price` for the renewal.", +"flatPath": "v1alpha2/projects/{projectsId}/locations/{locationsId}/registrations/{registrationsId}:renewDomain", +"httpMethod": "POST", +"id": "domains.projects.locations.registrations.renewDomain", +"parameterOrder": [ +"registration" +], +"parameters": { +"registration": { +"description": "Required. The name of the `Registration` whish is being renewed, in the format `projects/*/locations/*/registrations/*`.", +"location": "path", +"pattern": "^projects/[^/]+/locations/[^/]+/registrations/[^/]+$", +"required": true, +"type": "string" +} +}, +"path": "v1alpha2/{+registration}:renewDomain", +"request": { +"$ref": "RenewDomainRequest" +}, +"response": { +"$ref": "Operation" +}, +"scopes": [ +"https://www.googleapis.com/auth/cloud-platform" +] +}, "resetAuthorizationCode": { -"description": "Resets the authorization code of the `Registration` to a new random string. You can call this method only after 60 days have elapsed since the initial domain registration.", +"description": "Resets the authorization code of the `Registration` to a new random string. You can call this method only after 60 days have elapsed since the initial domain registration. Domains that have the `REQUIRE_PUSH_TRANSFER` property in the list of `domain_properties` don't support authorization codes and must use the `InitiatePushTransfer` method to initiate the process to transfer the domain to a different registrar.", "flatPath": "v1alpha2/projects/{projectsId}/locations/{locationsId}/registrations/{registrationsId}:resetAuthorizationCode", "httpMethod": "POST", "id": "domains.projects.locations.registrations.resetAuthorizationCode", @@ -604,7 +660,7 @@ ] }, "retrieveAuthorizationCode": { -"description": "Gets the authorization code of the `Registration` for the purpose of transferring the domain to another registrar. You can call this method only after 60 days have elapsed since the initial domain registration.", +"description": "Gets the authorization code of the `Registration` for the purpose of transferring the domain to another registrar. You can call this method only after 60 days have elapsed since the initial domain registration. Domains that have the `REQUIRE_PUSH_TRANSFER` property in the list of `domain_properties` don't support authorization codes and must use the `InitiatePushTransfer` method to initiate the process to transfer the domain to a different registrar.", "flatPath": "v1alpha2/projects/{projectsId}/locations/{locationsId}/registrations/{registrationsId}:retrieveAuthorizationCode", "httpMethod": "GET", "id": "domains.projects.locations.registrations.retrieveAuthorizationCode", @@ -628,6 +684,31 @@ "https://www.googleapis.com/auth/cloud-platform" ] }, +"retrieveGoogleDomainsForwardingConfig": { +"description": "Lists the deprecated domain and email forwarding configurations you set up in the deprecated Google Domains UI. The configuration is present only for domains with the `google_domains_redirects_data_available` set to `true` in the `Registration`'s `dns_settings`. A forwarding configuration might not work correctly if required DNS records are not present in the domain's authoritative DNS Zone.", +"flatPath": "v1alpha2/projects/{projectsId}/locations/{locationsId}/registrations/{registrationsId}:retrieveGoogleDomainsForwardingConfig", +"httpMethod": "GET", +"id": "domains.projects.locations.registrations.retrieveGoogleDomainsForwardingConfig", +"parameterOrder": [ +"registration" +], +"parameters": { +"registration": { +"description": "Required. The name of the `Registration` whose Google Domains forwarding configuration details are being retrieved, in the format `projects/*/locations/*/registrations/*`.", +"location": "path", +"pattern": "^projects/[^/]+/locations/[^/]+/registrations/[^/]+$", +"required": true, +"type": "string" +} +}, +"path": "v1alpha2/{+registration}:retrieveGoogleDomainsForwardingConfig", +"response": { +"$ref": "RetrieveGoogleDomainsForwardingConfigResponse" +}, +"scopes": [ +"https://www.googleapis.com/auth/cloud-platform" +] +}, "retrieveImportableDomains": { "deprecated": true, "description": "Deprecated: For more information, see [Cloud Domains feature deprecation](https://cloud.google.com/domains/docs/deprecations/feature-deprecations) Lists domain names from [Google Domains](https://domains.google/) that can be imported to Cloud Domains using the `ImportDomain` method. Since individual users can own domains in Google Domains, the list of domains returned depends on the individual user making the call. Domains already managed by Cloud Domains are not returned.", @@ -848,7 +929,7 @@ } } }, -"revision": "20240520", +"revision": "20240603", "rootUrl": "https://domains.googleapis.com/", "schemas": { "AuditConfig": { @@ -1146,6 +1227,47 @@ false }, "type": "object" }, +"DomainForwarding": { +"description": "Domain forwarding configuration.", +"id": "DomainForwarding", +"properties": { +"pathForwarding": { +"description": "If true, forwards the path after the domain name to the same path at the new address.", +"type": "boolean" +}, +"pemCertificate": { +"description": "The PEM-encoded certificate chain.", +"type": "string" +}, +"redirectType": { +"description": "The redirect type.", +"enum": [ +"REDIRECT_TYPE_UNSPECIFIED", +"TEMPORARY", +"PERMANENT" +], +"enumDescriptions": [ +"Redirect Type is unspecified.", +"301 redirect. Allows to propagate changes to the forwarding address quickly.", +"302 redirect. Allows browsers to cache the forwarding address. This may help the address resolve more quickly. Changes may take longer to propagate" +], +"type": "string" +}, +"sslEnabled": { +"description": "If true, the forwarding works also over HTTPS.", +"type": "boolean" +}, +"subdomain": { +"description": "The subdomain of the registered domain that is being forwarded. E.g. `www.example.com`, `example.com` (i.e. the registered domain itself) or `*.example.com` (i.e. all subdomains).", +"type": "string" +}, +"targetUri": { +"description": "The target of the domain forwarding, i.e. the path to redirect the `subdomain` to.", +"type": "string" +} +}, +"type": "object" +}, "DsRecord": { "description": "Defines a Delegation Signer (DS) record, which is needed to enable DNSSEC for a domain. It contains a digest (hash) of a DNSKEY record that must be present in the domain's DNS zone.", "id": "DsRecord", @@ -1224,6 +1346,21 @@ false }, "type": "object" }, +"EmailForwarding": { +"description": "Email forwarding configuration.", +"id": "EmailForwarding", +"properties": { +"alias": { +"description": "An alias recipient email that forwards emails to the `target_email_address`. For example, `admin@example.com` or `*@example.com` (wildcard alias forwards all the emails under the registered domain).", +"type": "string" +}, +"targetEmailAddress": { +"description": "Target email that receives emails sent to the `alias`.", +"type": "string" +} +}, +"type": "object" +}, "ExportRegistrationRequest": { "deprecated": true, "description": "Deprecated: For more information, see [Cloud Domains feature deprecation](https://cloud.google.com/domains/docs/deprecations/feature-deprecations). Request for the `ExportRegistration` method.", @@ -1336,6 +1473,17 @@ false }, "type": "object" }, +"InitiatePushTransferRequest": { +"description": "Request for the `InitiatePushTransfer` method.", +"id": "InitiatePushTransferRequest", +"properties": { +"tag": { +"description": "Required. The Tag of the new registrar. Can be found at [List of registrars](https://nominet.uk/registrar-list/).", +"type": "string" +} +}, +"type": "object" +}, "ListLocationsResponse": { "description": "The response message for Locations.ListLocations.", "id": "ListLocationsResponse", @@ -1428,6 +1576,21 @@ false "description": "Defines renewal, billing, and transfer settings for a `Registration`.", "id": "ManagementSettings", "properties": { +"effectiveTransferLockState": { +"description": "Output only. The actual transfer lock state for this `Registration`.", +"enum": [ +"TRANSFER_LOCK_STATE_UNSPECIFIED", +"UNLOCKED", +"LOCKED" +], +"enumDescriptions": [ +"The state is unspecified.", +"The domain is unlocked and can be transferred to another registrar.", +"The domain is locked and cannot be transferred to another registrar." +], +"readOnly": true, +"type": "string" +}, "preferredRenewalMethod": { "description": "Optional. The desired renewal method for this `Registration`. The actual `renewal_method` is automatically updated to reflect this choice. If unset or equal to `RENEWAL_METHOD_UNSPECIFIED`, the actual `renewalMethod` is treated as if it were set to `AUTOMATIC_RENEWAL`. You cannot use `RENEWAL_DISABLED` during resource creation, and you can update the renewal status only when the `Registration` resource has state `ACTIVE` or `SUSPENDED`. When `preferred_renewal_method` is set to `AUTOMATIC_RENEWAL`, the actual `renewal_method` can be set to `RENEWAL_DISABLED` in case of problems with the billing account or reported domain abuse. In such cases, check the `issues` field on the `Registration`. After the problem is resolved, the `renewal_method` is automatically updated to `preferred_renewal_method` in a few hours.", "enum": [ @@ -1474,7 +1637,7 @@ false "type": "string" }, "transferLockState": { -"description": "This is the desired transfer lock state for this `Registration`. A transfer lock controls whether the domain can be transferred to another registrar.", +"description": "This is the desired transfer lock state for this `Registration`. A transfer lock controls whether the domain can be transferred to another registrar. The transfer lock state of the domain is returned in the `effective_transfer_lock_state` property. The transfer lock state values might be different for the following reasons: * `transfer_lock_state` was updated only a short time ago. * Domains with the `TRANSFER_LOCK_UNSUPPORTED_BY_REGISTRY` state are in the list of `domain_properties`. These domains are always in the `UNLOCKED` state.", "enum": [ "TRANSFER_LOCK_STATE_UNSPECIFIED", "UNLOCKED", @@ -1812,6 +1975,24 @@ false "description": "Required. Immutable. The domain name. Unicode domain names must be expressed in Punycode format.", "type": "string" }, +"domainProperties": { +"description": "Output only. Special properties of the domain.", +"items": { +"enum": [ +"DOMAIN_PROPERTY_UNSPECIFIED", +"TRANSFER_LOCK_UNSUPPORTED_BY_REGISTRY", +"REQUIRE_PUSH_TRANSFER" +], +"enumDescriptions": [ +"The property is undefined.", +"The domain does not support transfer locks due to restrictions of the registry. Such domains are effectively always unlocked and any change made to `management_settings.transfer_lock_state` is ignored.", +"The domain uses an alternative `Push Transfer` process to transfer the domain to another registrar. There are two important consequences: * Cloud Domains does not supply the authorization codes. * To initiate the process to transfer the domain to another registrar, you must provide a tag of the registrar you want to transfer to. You can do this by using the `InitiatePushTransfer` method. For more information, see [Transfer a registered domain to another registrar](https://cloud.google.com/domains/docs/transfer-domain-to-another-registrar)." +], +"type": "string" +}, +"readOnly": true, +"type": "array" +}, "expireTime": { "description": "Output only. The expiration timestamp of the `Registration`.", "format": "google-datetime", @@ -1825,13 +2006,15 @@ false "ISSUE_UNSPECIFIED", "CONTACT_SUPPORT", "UNVERIFIED_EMAIL", -"PROBLEM_WITH_BILLING" +"PROBLEM_WITH_BILLING", +"DNS_NOT_ACTIVATED" ], "enumDescriptions": [ "The issue is undefined.", "Contact the Cloud Support team to resolve a problem with this domain.", "[ICANN](https://icann.org/) requires verification of the email address in the `Registration`'s `contact_settings.registrant_contact` field. To verify the email address, follow the instructions in the email the `registrant_contact` receives following registration. If you do not complete email verification within 15 days of registration, the domain is suspended. To resend the verification email, call ConfigureContactSettings and provide the current `registrant_contact.email`.", -"The billing account is not in good standing. The domain is not automatically renewed at its expiration time unless you resolve problems with your billing account." +"The billing account is not in good standing. The domain is not automatically renewed at its expiration time unless you resolve problems with your billing account.", +"The registry failed to validate your DNS configuration and activate your domain. The failure might happen for the following reasons: * You recently registered the domain (wait up to 72 hours). * You provided invalid name servers or name servers that correspond to a newly created DNS zone. Verify your DNS configuration. If the configuration is incorrect, you must fix it. If the configuration is correct, either wait or call the ConfigureDnsSettings method to retry the registry validation." ], "type": "string" }, @@ -1993,12 +2176,48 @@ false }, "type": "object" }, +"RenewDomainRequest": { +"description": "Request for the `RenewDomain` method.", +"id": "RenewDomainRequest", +"properties": { +"validateOnly": { +"description": "Optional. When true, only validation is performed, without actually renewing the domain. For more information, see [Request validation](https://cloud.google.com/apis/design/design_patterns#request_validation)", +"type": "boolean" +}, +"yearlyPrice": { +"$ref": "Money", +"description": "Required. Acknowledgement of the price to renew the domain for one year. To get the price, see [Cloud Domains pricing](https://cloud.google.com/domains/pricing). If not provided, the expected price is returned in the error message." +} +}, +"type": "object" +}, "ResetAuthorizationCodeRequest": { "description": "Request for the `ResetAuthorizationCode` method.", "id": "ResetAuthorizationCodeRequest", "properties": {}, "type": "object" }, +"RetrieveGoogleDomainsForwardingConfigResponse": { +"description": "Response for the `RetrieveGoogleDomainsForwardingConfig` method.", +"id": "RetrieveGoogleDomainsForwardingConfigResponse", +"properties": { +"domainForwardings": { +"description": "The list of domain forwarding configurations. A forwarding configuration might not work correctly if the required DNS records are not present in the domain's authoritative DNS zone.", +"items": { +"$ref": "DomainForwarding" +}, +"type": "array" +}, +"emailForwardings": { +"description": "The list of email forwarding configurations. A forwarding configuration might not work correctly if the required DNS records are not present in the domain's authoritative DNS zone.", +"items": { +"$ref": "EmailForwarding" +}, +"type": "array" +} +}, +"type": "object" +}, "RetrieveImportableDomainsResponse": { "deprecated": true, "description": "Deprecated: For more information, see [Cloud Domains feature deprecation](https://cloud.google.com/domains/docs/deprecations/feature-deprecations). Response for the `RetrieveImportableDomains` method.", diff --git a/googleapiclient/discovery_cache/documents/domains.v1beta1.json b/googleapiclient/discovery_cache/documents/domains.v1beta1.json index 2a5fa691277..8d826a19438 100644 --- a/googleapiclient/discovery_cache/documents/domains.v1beta1.json +++ b/googleapiclient/discovery_cache/documents/domains.v1beta1.json @@ -472,6 +472,34 @@ "https://www.googleapis.com/auth/cloud-platform" ] }, +"initiatePushTransfer": { +"description": "Initiates the `Push Transfer` process to transfer the domain to another registrar. The process might complete instantly or might require confirmation or additional work. Check the emails sent to the email address of the registrant. The process is aborted after a timeout if it's not completed. This method is only supported for domains that have the `REQUIRE_PUSH_TRANSFER` property in the list of `domain_properties`. The domain must also be unlocked before it can be transferred to a different registrar. For more information, see [Transfer a registered domain to another registrar](https://cloud.google.com/domains/docs/transfer-domain-to-another-registrar).", +"flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/registrations/{registrationsId}:initiatePushTransfer", +"httpMethod": "POST", +"id": "domains.projects.locations.registrations.initiatePushTransfer", +"parameterOrder": [ +"registration" +], +"parameters": { +"registration": { +"description": "Required. The name of the `Registration` for which the push transfer is initiated, in the format `projects/*/locations/*/registrations/*`.", +"location": "path", +"pattern": "^projects/[^/]+/locations/[^/]+/registrations/[^/]+$", +"required": true, +"type": "string" +} +}, +"path": "v1beta1/{+registration}:initiatePushTransfer", +"request": { +"$ref": "InitiatePushTransferRequest" +}, +"response": { +"$ref": "Operation" +}, +"scopes": [ +"https://www.googleapis.com/auth/cloud-platform" +] +}, "list": { "description": "Lists the `Registration` resources in a project.", "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/registrations", @@ -575,8 +603,36 @@ "https://www.googleapis.com/auth/cloud-platform" ] }, +"renewDomain": { +"description": "Renews a recently expired domain. This method can only be called on domains that expired in the previous 30 days. After the renewal, the new expiration time of the domain is one year after the old expiration time and you are charged a `yearly_price` for the renewal.", +"flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/registrations/{registrationsId}:renewDomain", +"httpMethod": "POST", +"id": "domains.projects.locations.registrations.renewDomain", +"parameterOrder": [ +"registration" +], +"parameters": { +"registration": { +"description": "Required. The name of the `Registration` whish is being renewed, in the format `projects/*/locations/*/registrations/*`.", +"location": "path", +"pattern": "^projects/[^/]+/locations/[^/]+/registrations/[^/]+$", +"required": true, +"type": "string" +} +}, +"path": "v1beta1/{+registration}:renewDomain", +"request": { +"$ref": "RenewDomainRequest" +}, +"response": { +"$ref": "Operation" +}, +"scopes": [ +"https://www.googleapis.com/auth/cloud-platform" +] +}, "resetAuthorizationCode": { -"description": "Resets the authorization code of the `Registration` to a new random string. You can call this method only after 60 days have elapsed since the initial domain registration.", +"description": "Resets the authorization code of the `Registration` to a new random string. You can call this method only after 60 days have elapsed since the initial domain registration. Domains that have the `REQUIRE_PUSH_TRANSFER` property in the list of `domain_properties` don't support authorization codes and must use the `InitiatePushTransfer` method to initiate the process to transfer the domain to a different registrar.", "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/registrations/{registrationsId}:resetAuthorizationCode", "httpMethod": "POST", "id": "domains.projects.locations.registrations.resetAuthorizationCode", @@ -604,7 +660,7 @@ ] }, "retrieveAuthorizationCode": { -"description": "Gets the authorization code of the `Registration` for the purpose of transferring the domain to another registrar. You can call this method only after 60 days have elapsed since the initial domain registration.", +"description": "Gets the authorization code of the `Registration` for the purpose of transferring the domain to another registrar. You can call this method only after 60 days have elapsed since the initial domain registration. Domains that have the `REQUIRE_PUSH_TRANSFER` property in the list of `domain_properties` don't support authorization codes and must use the `InitiatePushTransfer` method to initiate the process to transfer the domain to a different registrar.", "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/registrations/{registrationsId}:retrieveAuthorizationCode", "httpMethod": "GET", "id": "domains.projects.locations.registrations.retrieveAuthorizationCode", @@ -628,6 +684,31 @@ "https://www.googleapis.com/auth/cloud-platform" ] }, +"retrieveGoogleDomainsForwardingConfig": { +"description": "Lists the deprecated domain and email forwarding configurations you set up in the deprecated Google Domains UI. The configuration is present only for domains with the `google_domains_redirects_data_available` set to `true` in the `Registration`'s `dns_settings`. A forwarding configuration might not work correctly if required DNS records are not present in the domain's authoritative DNS Zone.", +"flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/registrations/{registrationsId}:retrieveGoogleDomainsForwardingConfig", +"httpMethod": "GET", +"id": "domains.projects.locations.registrations.retrieveGoogleDomainsForwardingConfig", +"parameterOrder": [ +"registration" +], +"parameters": { +"registration": { +"description": "Required. The name of the `Registration` whose Google Domains forwarding configuration details are being retrieved, in the format `projects/*/locations/*/registrations/*`.", +"location": "path", +"pattern": "^projects/[^/]+/locations/[^/]+/registrations/[^/]+$", +"required": true, +"type": "string" +} +}, +"path": "v1beta1/{+registration}:retrieveGoogleDomainsForwardingConfig", +"response": { +"$ref": "RetrieveGoogleDomainsForwardingConfigResponse" +}, +"scopes": [ +"https://www.googleapis.com/auth/cloud-platform" +] +}, "retrieveImportableDomains": { "deprecated": true, "description": "Deprecated: For more information, see [Cloud Domains feature deprecation](https://cloud.google.com/domains/docs/deprecations/feature-deprecations) Lists domain names from [Google Domains](https://domains.google/) that can be imported to Cloud Domains using the `ImportDomain` method. Since individual users can own domains in Google Domains, the list of domains returned depends on the individual user making the call. Domains already managed by Cloud Domains are not returned.", @@ -848,7 +929,7 @@ } } }, -"revision": "20240520", +"revision": "20240603", "rootUrl": "https://domains.googleapis.com/", "schemas": { "AuditConfig": { @@ -1146,6 +1227,47 @@ false }, "type": "object" }, +"DomainForwarding": { +"description": "Domain forwarding configuration.", +"id": "DomainForwarding", +"properties": { +"pathForwarding": { +"description": "If true, forwards the path after the domain name to the same path at the new address.", +"type": "boolean" +}, +"pemCertificate": { +"description": "The PEM-encoded certificate chain.", +"type": "string" +}, +"redirectType": { +"description": "The redirect type.", +"enum": [ +"REDIRECT_TYPE_UNSPECIFIED", +"TEMPORARY", +"PERMANENT" +], +"enumDescriptions": [ +"Redirect Type is unspecified.", +"301 redirect. Allows to propagate changes to the forwarding address quickly.", +"302 redirect. Allows browsers to cache the forwarding address. This may help the address resolve more quickly. Changes may take longer to propagate" +], +"type": "string" +}, +"sslEnabled": { +"description": "If true, the forwarding works also over HTTPS.", +"type": "boolean" +}, +"subdomain": { +"description": "The subdomain of the registered domain that is being forwarded. E.g. `www.example.com`, `example.com` (i.e. the registered domain itself) or `*.example.com` (i.e. all subdomains).", +"type": "string" +}, +"targetUri": { +"description": "The target of the domain forwarding, i.e. the path to redirect the `subdomain` to.", +"type": "string" +} +}, +"type": "object" +}, "DsRecord": { "description": "Defines a Delegation Signer (DS) record, which is needed to enable DNSSEC for a domain. It contains a digest (hash) of a DNSKEY record that must be present in the domain's DNS zone.", "id": "DsRecord", @@ -1224,6 +1346,21 @@ false }, "type": "object" }, +"EmailForwarding": { +"description": "Email forwarding configuration.", +"id": "EmailForwarding", +"properties": { +"alias": { +"description": "An alias recipient email that forwards emails to the `target_email_address`. For example, `admin@example.com` or `*@example.com` (wildcard alias forwards all the emails under the registered domain).", +"type": "string" +}, +"targetEmailAddress": { +"description": "Target email that receives emails sent to the `alias`.", +"type": "string" +} +}, +"type": "object" +}, "ExportRegistrationRequest": { "deprecated": true, "description": "Deprecated: For more information, see [Cloud Domains feature deprecation](https://cloud.google.com/domains/docs/deprecations/feature-deprecations). Request for the `ExportRegistration` method.", @@ -1336,6 +1473,17 @@ false }, "type": "object" }, +"InitiatePushTransferRequest": { +"description": "Request for the `InitiatePushTransfer` method.", +"id": "InitiatePushTransferRequest", +"properties": { +"tag": { +"description": "Required. The Tag of the new registrar. Can be found at [List of registrars](https://nominet.uk/registrar-list/).", +"type": "string" +} +}, +"type": "object" +}, "ListLocationsResponse": { "description": "The response message for Locations.ListLocations.", "id": "ListLocationsResponse", @@ -1428,6 +1576,21 @@ false "description": "Defines renewal, billing, and transfer settings for a `Registration`.", "id": "ManagementSettings", "properties": { +"effectiveTransferLockState": { +"description": "Output only. The actual transfer lock state for this `Registration`.", +"enum": [ +"TRANSFER_LOCK_STATE_UNSPECIFIED", +"UNLOCKED", +"LOCKED" +], +"enumDescriptions": [ +"The state is unspecified.", +"The domain is unlocked and can be transferred to another registrar.", +"The domain is locked and cannot be transferred to another registrar." +], +"readOnly": true, +"type": "string" +}, "preferredRenewalMethod": { "description": "Optional. The desired renewal method for this `Registration`. The actual `renewal_method` is automatically updated to reflect this choice. If unset or equal to `RENEWAL_METHOD_UNSPECIFIED`, the actual `renewalMethod` is treated as if it were set to `AUTOMATIC_RENEWAL`. You cannot use `RENEWAL_DISABLED` during resource creation, and you can update the renewal status only when the `Registration` resource has state `ACTIVE` or `SUSPENDED`. When `preferred_renewal_method` is set to `AUTOMATIC_RENEWAL`, the actual `renewal_method` can be set to `RENEWAL_DISABLED` in case of problems with the billing account or reported domain abuse. In such cases, check the `issues` field on the `Registration`. After the problem is resolved, the `renewal_method` is automatically updated to `preferred_renewal_method` in a few hours.", "enum": [ @@ -1474,7 +1637,7 @@ false "type": "string" }, "transferLockState": { -"description": "This is the desired transfer lock state for this `Registration`. A transfer lock controls whether the domain can be transferred to another registrar.", +"description": "This is the desired transfer lock state for this `Registration`. A transfer lock controls whether the domain can be transferred to another registrar. The transfer lock state of the domain is returned in the `effective_transfer_lock_state` property. The transfer lock state values might be different for the following reasons: * `transfer_lock_state` was updated only a short time ago. * Domains with the `TRANSFER_LOCK_UNSUPPORTED_BY_REGISTRY` state are in the list of `domain_properties`. These domains are always in the `UNLOCKED` state.", "enum": [ "TRANSFER_LOCK_STATE_UNSPECIFIED", "UNLOCKED", @@ -1812,6 +1975,24 @@ false "description": "Required. Immutable. The domain name. Unicode domain names must be expressed in Punycode format.", "type": "string" }, +"domainProperties": { +"description": "Output only. Special properties of the domain.", +"items": { +"enum": [ +"DOMAIN_PROPERTY_UNSPECIFIED", +"TRANSFER_LOCK_UNSUPPORTED_BY_REGISTRY", +"REQUIRE_PUSH_TRANSFER" +], +"enumDescriptions": [ +"The property is undefined.", +"The domain does not support transfer locks due to restrictions of the registry. Such domains are effectively always unlocked and any change made to `management_settings.transfer_lock_state` is ignored.", +"The domain uses an alternative `Push Transfer` process to transfer the domain to another registrar. There are two important consequences: * Cloud Domains does not supply the authorization codes. * To initiate the process to transfer the domain to another registrar, you must provide a tag of the registrar you want to transfer to. You can do this by using the `InitiatePushTransfer` method. For more information, see [Transfer a registered domain to another registrar](https://cloud.google.com/domains/docs/transfer-domain-to-another-registrar)." +], +"type": "string" +}, +"readOnly": true, +"type": "array" +}, "expireTime": { "description": "Output only. The expiration timestamp of the `Registration`.", "format": "google-datetime", @@ -1825,13 +2006,15 @@ false "ISSUE_UNSPECIFIED", "CONTACT_SUPPORT", "UNVERIFIED_EMAIL", -"PROBLEM_WITH_BILLING" +"PROBLEM_WITH_BILLING", +"DNS_NOT_ACTIVATED" ], "enumDescriptions": [ "The issue is undefined.", "Contact the Cloud Support team to resolve a problem with this domain.", "[ICANN](https://icann.org/) requires verification of the email address in the `Registration`'s `contact_settings.registrant_contact` field. To verify the email address, follow the instructions in the email the `registrant_contact` receives following registration. If you do not complete email verification within 15 days of registration, the domain is suspended. To resend the verification email, call ConfigureContactSettings and provide the current `registrant_contact.email`.", -"The billing account is not in good standing. The domain is not automatically renewed at its expiration time unless you resolve problems with your billing account." +"The billing account is not in good standing. The domain is not automatically renewed at its expiration time unless you resolve problems with your billing account.", +"The registry failed to validate your DNS configuration and activate your domain. The failure might happen for the following reasons: * You recently registered the domain (wait up to 72 hours). * You provided invalid name servers or name servers that correspond to a newly created DNS zone. Verify your DNS configuration. If the configuration is incorrect, you must fix it. If the configuration is correct, either wait or call the ConfigureDnsSettings method to retry the registry validation." ], "type": "string" }, @@ -1978,12 +2161,48 @@ false }, "type": "object" }, +"RenewDomainRequest": { +"description": "Request for the `RenewDomain` method.", +"id": "RenewDomainRequest", +"properties": { +"validateOnly": { +"description": "Optional. When true, only validation is performed, without actually renewing the domain. For more information, see [Request validation](https://cloud.google.com/apis/design/design_patterns#request_validation)", +"type": "boolean" +}, +"yearlyPrice": { +"$ref": "Money", +"description": "Required. Acknowledgement of the price to renew the domain for one year. To get the price, see [Cloud Domains pricing](https://cloud.google.com/domains/pricing). If not provided, the expected price is returned in the error message." +} +}, +"type": "object" +}, "ResetAuthorizationCodeRequest": { "description": "Request for the `ResetAuthorizationCode` method.", "id": "ResetAuthorizationCodeRequest", "properties": {}, "type": "object" }, +"RetrieveGoogleDomainsForwardingConfigResponse": { +"description": "Response for the `RetrieveGoogleDomainsForwardingConfig` method.", +"id": "RetrieveGoogleDomainsForwardingConfigResponse", +"properties": { +"domainForwardings": { +"description": "The list of domain forwarding configurations. A forwarding configuration might not work correctly if the required DNS records are not present in the domain's authoritative DNS zone.", +"items": { +"$ref": "DomainForwarding" +}, +"type": "array" +}, +"emailForwardings": { +"description": "The list of email forwarding configurations. A forwarding configuration might not work correctly if the required DNS records are not present in the domain's authoritative DNS zone.", +"items": { +"$ref": "EmailForwarding" +}, +"type": "array" +} +}, +"type": "object" +}, "RetrieveImportableDomainsResponse": { "deprecated": true, "description": "Deprecated: For more information, see [Cloud Domains feature deprecation](https://cloud.google.com/domains/docs/deprecations/feature-deprecations). Response for the `RetrieveImportableDomains` method.", diff --git a/googleapiclient/discovery_cache/documents/domainsrdap.v1.json b/googleapiclient/discovery_cache/documents/domainsrdap.v1.json index acdfd0d80ad..b73e7bc0d3e 100644 --- a/googleapiclient/discovery_cache/documents/domainsrdap.v1.json +++ b/googleapiclient/discovery_cache/documents/domainsrdap.v1.json @@ -289,7 +289,7 @@ } } }, -"revision": "20240603", +"revision": "20240610", "rootUrl": "https://domainsrdap.googleapis.com/", "schemas": { "HttpBody": { diff --git a/googleapiclient/discovery_cache/documents/doubleclickbidmanager.v2.json b/googleapiclient/discovery_cache/documents/doubleclickbidmanager.v2.json index 3efe53e22c2..9cdfcfc00c5 100644 --- a/googleapiclient/discovery_cache/documents/doubleclickbidmanager.v2.json +++ b/googleapiclient/discovery_cache/documents/doubleclickbidmanager.v2.json @@ -319,7 +319,7 @@ } } }, -"revision": "20240522", +"revision": "20240529", "rootUrl": "https://doubleclickbidmanager.googleapis.com/", "schemas": { "DataRange": { diff --git a/googleapiclient/discovery_cache/documents/doubleclicksearch.v2.json b/googleapiclient/discovery_cache/documents/doubleclicksearch.v2.json index 039fd7fd657..beabf2cfdf2 100644 --- a/googleapiclient/discovery_cache/documents/doubleclicksearch.v2.json +++ b/googleapiclient/discovery_cache/documents/doubleclicksearch.v2.json @@ -543,7 +543,7 @@ } } }, -"revision": "20240530", +"revision": "20240605", "rootUrl": "https://doubleclicksearch.googleapis.com/", "schemas": { "Availability": { diff --git a/googleapiclient/discovery_cache/documents/drive.v2.json b/googleapiclient/discovery_cache/documents/drive.v2.json index 3e7fafba568..f8e11d6b417 100644 --- a/googleapiclient/discovery_cache/documents/drive.v2.json +++ b/googleapiclient/discovery_cache/documents/drive.v2.json @@ -3869,7 +3869,7 @@ } } }, -"revision": "20240522", +"revision": "20240604", "rootUrl": "https://www.googleapis.com/", "schemas": { "About": { diff --git a/googleapiclient/discovery_cache/documents/drive.v3.json b/googleapiclient/discovery_cache/documents/drive.v3.json index 6b731d28260..e1c80ca580c 100644 --- a/googleapiclient/discovery_cache/documents/drive.v3.json +++ b/googleapiclient/discovery_cache/documents/drive.v3.json @@ -2523,7 +2523,7 @@ } } }, -"revision": "20240522", +"revision": "20240604", "rootUrl": "https://www.googleapis.com/", "schemas": { "About": { diff --git a/googleapiclient/discovery_cache/documents/driveactivity.v2.json b/googleapiclient/discovery_cache/documents/driveactivity.v2.json index 210d7a1d071..a7f8714bd1a 100644 --- a/googleapiclient/discovery_cache/documents/driveactivity.v2.json +++ b/googleapiclient/discovery_cache/documents/driveactivity.v2.json @@ -132,7 +132,7 @@ } } }, -"revision": "20240528", +"revision": "20240604", "rootUrl": "https://driveactivity.googleapis.com/", "schemas": { "Action": { diff --git a/googleapiclient/discovery_cache/documents/drivelabels.v2.json b/googleapiclient/discovery_cache/documents/drivelabels.v2.json index 1644b8946b6..5a98a9713b0 100644 --- a/googleapiclient/discovery_cache/documents/drivelabels.v2.json +++ b/googleapiclient/discovery_cache/documents/drivelabels.v2.json @@ -1032,7 +1032,7 @@ } } }, -"revision": "20240528", +"revision": "20240603", "rootUrl": "https://drivelabels.googleapis.com/", "schemas": { "GoogleAppsDriveLabelsV2BadgeColors": { diff --git a/googleapiclient/discovery_cache/documents/drivelabels.v2beta.json b/googleapiclient/discovery_cache/documents/drivelabels.v2beta.json index 5983772e86a..d202c541ba4 100644 --- a/googleapiclient/discovery_cache/documents/drivelabels.v2beta.json +++ b/googleapiclient/discovery_cache/documents/drivelabels.v2beta.json @@ -1032,7 +1032,7 @@ } } }, -"revision": "20240528", +"revision": "20240603", "rootUrl": "https://drivelabels.googleapis.com/", "schemas": { "GoogleAppsDriveLabelsV2betaBadgeColors": { diff --git a/googleapiclient/discovery_cache/documents/essentialcontacts.v1.json b/googleapiclient/discovery_cache/documents/essentialcontacts.v1.json index cbc4caaf7ce..75292940aab 100644 --- a/googleapiclient/discovery_cache/documents/essentialcontacts.v1.json +++ b/googleapiclient/discovery_cache/documents/essentialcontacts.v1.json @@ -850,7 +850,7 @@ } } }, -"revision": "20240526", +"revision": "20240602", "rootUrl": "https://essentialcontacts.googleapis.com/", "schemas": { "GoogleCloudEssentialcontactsV1ComputeContactsResponse": { diff --git a/googleapiclient/discovery_cache/documents/eventarc.v1.json b/googleapiclient/discovery_cache/documents/eventarc.v1.json index 44d3e0e8abe..2694db576b5 100644 --- a/googleapiclient/discovery_cache/documents/eventarc.v1.json +++ b/googleapiclient/discovery_cache/documents/eventarc.v1.json @@ -1197,7 +1197,7 @@ } } }, -"revision": "20240524", +"revision": "20240531", "rootUrl": "https://eventarc.googleapis.com/", "schemas": { "AuditConfig": { diff --git a/googleapiclient/discovery_cache/documents/factchecktools.v1alpha1.json b/googleapiclient/discovery_cache/documents/factchecktools.v1alpha1.json index df5a1bca2dd..d815e23aa80 100644 --- a/googleapiclient/discovery_cache/documents/factchecktools.v1alpha1.json +++ b/googleapiclient/discovery_cache/documents/factchecktools.v1alpha1.json @@ -344,7 +344,7 @@ } } }, -"revision": "20240602", +"revision": "20240609", "rootUrl": "https://factchecktools.googleapis.com/", "schemas": { "GoogleFactcheckingFactchecktoolsV1alpha1Claim": { diff --git a/googleapiclient/discovery_cache/documents/fcm.v1.json b/googleapiclient/discovery_cache/documents/fcm.v1.json index 1007f93953f..6ed2323b72f 100644 --- a/googleapiclient/discovery_cache/documents/fcm.v1.json +++ b/googleapiclient/discovery_cache/documents/fcm.v1.json @@ -146,7 +146,7 @@ } } }, -"revision": "20240528", +"revision": "20240604", "rootUrl": "https://fcm.googleapis.com/", "schemas": { "AndroidConfig": { diff --git a/googleapiclient/discovery_cache/documents/fcmdata.v1beta1.json b/googleapiclient/discovery_cache/documents/fcmdata.v1beta1.json index 6304622802b..bccd58c83b0 100644 --- a/googleapiclient/discovery_cache/documents/fcmdata.v1beta1.json +++ b/googleapiclient/discovery_cache/documents/fcmdata.v1beta1.json @@ -154,7 +154,7 @@ } } }, -"revision": "20240602", +"revision": "20240609", "rootUrl": "https://fcmdata.googleapis.com/", "schemas": { "GoogleFirebaseFcmDataV1beta1AndroidDeliveryData": { @@ -318,7 +318,7 @@ "type": "object" }, "GoogleFirebaseFcmDataV1beta1ProxyNotificationInsightPercents": { -"description": "Additional information about proxy notification delivery. All percentages are calculated with countNotificationsAccepted as the denominator.", +"description": "Additional information about [proxy notification](https://firebase.google.com/docs/cloud-messaging/android/message-priority#proxy) delivery. All percentages are calculated with countNotificationsAccepted as the denominator.", "id": "GoogleFirebaseFcmDataV1beta1ProxyNotificationInsightPercents", "properties": { "failed": { diff --git a/googleapiclient/discovery_cache/documents/firebase.v1beta1.json b/googleapiclient/discovery_cache/documents/firebase.v1beta1.json index e1c307e67a2..697522fa8a2 100644 --- a/googleapiclient/discovery_cache/documents/firebase.v1beta1.json +++ b/googleapiclient/discovery_cache/documents/firebase.v1beta1.json @@ -1324,7 +1324,7 @@ } } }, -"revision": "20240531", +"revision": "20240607", "rootUrl": "https://firebase.googleapis.com/", "schemas": { "AddFirebaseRequest": { diff --git a/googleapiclient/discovery_cache/documents/firebaseappcheck.v1.json b/googleapiclient/discovery_cache/documents/firebaseappcheck.v1.json index eab376e106c..8f5f1ff9742 100644 --- a/googleapiclient/discovery_cache/documents/firebaseappcheck.v1.json +++ b/googleapiclient/discovery_cache/documents/firebaseappcheck.v1.json @@ -1463,7 +1463,7 @@ } } }, -"revision": "20240603", +"revision": "20240610", "rootUrl": "https://firebaseappcheck.googleapis.com/", "schemas": { "GoogleFirebaseAppcheckV1AppAttestConfig": { diff --git a/googleapiclient/discovery_cache/documents/firebaseappcheck.v1beta.json b/googleapiclient/discovery_cache/documents/firebaseappcheck.v1beta.json index 4a42b9f4ad4..1f2cbcc2a1b 100644 --- a/googleapiclient/discovery_cache/documents/firebaseappcheck.v1beta.json +++ b/googleapiclient/discovery_cache/documents/firebaseappcheck.v1beta.json @@ -1823,7 +1823,7 @@ } } }, -"revision": "20240603", +"revision": "20240610", "rootUrl": "https://firebaseappcheck.googleapis.com/", "schemas": { "GoogleFirebaseAppcheckV1betaAppAttestConfig": { diff --git a/googleapiclient/discovery_cache/documents/firebaseappdistribution.v1.json b/googleapiclient/discovery_cache/documents/firebaseappdistribution.v1.json index be4b8396d7e..d10bbbc20f2 100644 --- a/googleapiclient/discovery_cache/documents/firebaseappdistribution.v1.json +++ b/googleapiclient/discovery_cache/documents/firebaseappdistribution.v1.json @@ -941,7 +941,7 @@ } } }, -"revision": "20240603", +"revision": "20240610", "rootUrl": "https://firebaseappdistribution.googleapis.com/", "schemas": { "GdataBlobstore2Info": { @@ -1259,7 +1259,7 @@ }, "hash": { "deprecated": true, -"description": "Deprecated, use one of explicit hash type fields instead. These two hash related fields will only be populated on Scotty based media uploads and will contain the content of the hash group in the NotificationRequest: http://cs/#google3/uploader/service/proto/upload_listener.proto&q=class:Hash Hex encoded hash value of the uploaded media.", +"description": "Deprecated, use one of explicit hash type fields instead. These two hash related fields will only be populated on Scotty based media uploads and will contain the content of the hash group in the NotificationRequest: http://cs/#google3/blobstore2/api/scotty/service/proto/upload_listener.proto&q=class:Hash Hex encoded hash value of the uploaded media.", "type": "string" }, "hashVerified": { diff --git a/googleapiclient/discovery_cache/documents/firebaseappdistribution.v1alpha.json b/googleapiclient/discovery_cache/documents/firebaseappdistribution.v1alpha.json index 9e9320b6aa5..7365c0bebac 100644 --- a/googleapiclient/discovery_cache/documents/firebaseappdistribution.v1alpha.json +++ b/googleapiclient/discovery_cache/documents/firebaseappdistribution.v1alpha.json @@ -585,7 +585,7 @@ } } }, -"revision": "20240603", +"revision": "20240610", "rootUrl": "https://firebaseappdistribution.googleapis.com/", "schemas": { "GoogleFirebaseAppdistroV1Release": { diff --git a/googleapiclient/discovery_cache/documents/firebasedatabase.v1beta.json b/googleapiclient/discovery_cache/documents/firebasedatabase.v1beta.json index ba5c0ebd2cb..b4cfa2fd6ca 100644 --- a/googleapiclient/discovery_cache/documents/firebasedatabase.v1beta.json +++ b/googleapiclient/discovery_cache/documents/firebasedatabase.v1beta.json @@ -351,7 +351,7 @@ } } }, -"revision": "20240602", +"revision": "20240609", "rootUrl": "https://firebasedatabase.googleapis.com/", "schemas": { "DatabaseInstance": { diff --git a/googleapiclient/discovery_cache/documents/firebasedynamiclinks.v1.json b/googleapiclient/discovery_cache/documents/firebasedynamiclinks.v1.json index 571ecaba0ae..dd09304557e 100644 --- a/googleapiclient/discovery_cache/documents/firebasedynamiclinks.v1.json +++ b/googleapiclient/discovery_cache/documents/firebasedynamiclinks.v1.json @@ -224,7 +224,7 @@ } } }, -"revision": "20240527", +"revision": "20240603", "rootUrl": "https://firebasedynamiclinks.googleapis.com/", "schemas": { "AnalyticsInfo": { diff --git a/googleapiclient/discovery_cache/documents/firebasehosting.v1.json b/googleapiclient/discovery_cache/documents/firebasehosting.v1.json index 2198f78f690..7ac5f3f8e99 100644 --- a/googleapiclient/discovery_cache/documents/firebasehosting.v1.json +++ b/googleapiclient/discovery_cache/documents/firebasehosting.v1.json @@ -269,7 +269,7 @@ } } }, -"revision": "20240602", +"revision": "20240609", "rootUrl": "https://firebasehosting.googleapis.com/", "schemas": { "CancelOperationRequest": { diff --git a/googleapiclient/discovery_cache/documents/firebasehosting.v1beta1.json b/googleapiclient/discovery_cache/documents/firebasehosting.v1beta1.json index e2ae2b3b605..6b1974abcd9 100644 --- a/googleapiclient/discovery_cache/documents/firebasehosting.v1beta1.json +++ b/googleapiclient/discovery_cache/documents/firebasehosting.v1beta1.json @@ -2422,7 +2422,7 @@ } } }, -"revision": "20240602", +"revision": "20240609", "rootUrl": "https://firebasehosting.googleapis.com/", "schemas": { "ActingUser": { diff --git a/googleapiclient/discovery_cache/documents/firebaseml.v1.json b/googleapiclient/discovery_cache/documents/firebaseml.v1.json index 384397d44c5..eb5b371fcf0 100644 --- a/googleapiclient/discovery_cache/documents/firebaseml.v1.json +++ b/googleapiclient/discovery_cache/documents/firebaseml.v1.json @@ -204,7 +204,7 @@ } } }, -"revision": "20240531", +"revision": "20240607", "rootUrl": "https://firebaseml.googleapis.com/", "schemas": { "CancelOperationRequest": { diff --git a/googleapiclient/discovery_cache/documents/firebaseml.v1beta2.json b/googleapiclient/discovery_cache/documents/firebaseml.v1beta2.json index f370802ac7d..8fc6b3afe3a 100644 --- a/googleapiclient/discovery_cache/documents/firebaseml.v1beta2.json +++ b/googleapiclient/discovery_cache/documents/firebaseml.v1beta2.json @@ -318,7 +318,7 @@ } } }, -"revision": "20240531", +"revision": "20240607", "rootUrl": "https://firebaseml.googleapis.com/", "schemas": { "DownloadModelResponse": { diff --git a/googleapiclient/discovery_cache/documents/firebaseml.v2beta.json b/googleapiclient/discovery_cache/documents/firebaseml.v2beta.json index e10ca4a7cf0..8404f2700d2 100644 --- a/googleapiclient/discovery_cache/documents/firebaseml.v2beta.json +++ b/googleapiclient/discovery_cache/documents/firebaseml.v2beta.json @@ -206,7 +206,7 @@ } } }, -"revision": "20240531", +"revision": "20240607", "rootUrl": "https://firebaseml.googleapis.com/", "schemas": { "Blob": { @@ -255,7 +255,8 @@ "OTHER", "BLOCKLIST", "PROHIBITED_CONTENT", -"SPII" +"SPII", +"MALFORMED_FUNCTION_CALL" ], "enumDescriptions": [ "The finish reason is unspecified.", @@ -266,7 +267,8 @@ "All other reasons that stopped the token generation", "The token generation was stopped as the response was flagged for the terms which are included from the terminology blocklist.", "The token generation was stopped as the response was flagged for the prohibited contents.", -"The token generation was stopped as the response was flagged for Sensitive Personally Identifiable Information (SPII) contents." +"The token generation was stopped as the response was flagged for Sensitive Personally Identifiable Information (SPII) contents.", +"The function call generated by the model is invalid." ], "readOnly": true, "type": "string" diff --git a/googleapiclient/discovery_cache/documents/firebasestorage.v1beta.json b/googleapiclient/discovery_cache/documents/firebasestorage.v1beta.json index 3dffbe175ca..d94622c6652 100644 --- a/googleapiclient/discovery_cache/documents/firebasestorage.v1beta.json +++ b/googleapiclient/discovery_cache/documents/firebasestorage.v1beta.json @@ -238,7 +238,7 @@ } } }, -"revision": "20240524", +"revision": "20240531", "rootUrl": "https://firebasestorage.googleapis.com/", "schemas": { "AddFirebaseRequest": { diff --git a/googleapiclient/discovery_cache/documents/fitness.v1.json b/googleapiclient/discovery_cache/documents/fitness.v1.json index 6b2be0abd12..2cf72c7e320 100644 --- a/googleapiclient/discovery_cache/documents/fitness.v1.json +++ b/googleapiclient/discovery_cache/documents/fitness.v1.json @@ -832,7 +832,7 @@ } } }, -"revision": "20240602", +"revision": "20240609", "rootUrl": "https://fitness.googleapis.com/", "schemas": { "AggregateBucket": { diff --git a/googleapiclient/discovery_cache/documents/forms.v1.json b/googleapiclient/discovery_cache/documents/forms.v1.json index 0409e3a9c3a..6aa70d0948c 100644 --- a/googleapiclient/discovery_cache/documents/forms.v1.json +++ b/googleapiclient/discovery_cache/documents/forms.v1.json @@ -423,7 +423,7 @@ } } }, -"revision": "20240521", +"revision": "20240528", "rootUrl": "https://forms.googleapis.com/", "schemas": { "Answer": { diff --git a/googleapiclient/discovery_cache/documents/games.v1.json b/googleapiclient/discovery_cache/documents/games.v1.json index 66d3b1243a0..e33dbff9fa1 100644 --- a/googleapiclient/discovery_cache/documents/games.v1.json +++ b/googleapiclient/discovery_cache/documents/games.v1.json @@ -822,8 +822,38 @@ false }, "recall": { "methods": { +"gamesPlayerTokens": { +"description": "Retrieve the Recall tokens from all requested games that is associated with the PGS Player encoded in the provided recall session id. The API is only available for users that have an active PGS Player profile.", +"flatPath": "games/v1/recall/gamesPlayerTokens/{sessionId}", +"httpMethod": "GET", +"id": "games.recall.gamesPlayerTokens", +"parameterOrder": [ +"sessionId" +], +"parameters": { +"applicationIds": { +"description": "Required. The application IDs from the Google Play developer console for the games to return scoped ids for.", +"location": "query", +"repeated": true, +"type": "string" +}, +"sessionId": { +"description": "Required. Opaque server-generated string that encodes all the necessary information to identify the PGS player / Google user and application.", +"location": "path", +"required": true, +"type": "string" +} +}, +"path": "games/v1/recall/gamesPlayerTokens/{sessionId}", +"response": { +"$ref": "RetrieveGamesPlayerTokensResponse" +}, +"scopes": [ +"https://www.googleapis.com/auth/androidpublisher" +] +}, "lastTokenFromAllDeveloperGames": { -"description": "Retrieve the last Recall token from all developer games that is associated with the PGS Player principal encoded in the provided recall session id. The API is only available for users that have active PGS Player profile.", +"description": "Retrieve the last Recall token from all developer games that is associated with the PGS Player encoded in the provided recall session id. The API is only available for users that have active PGS Player profile.", "flatPath": "games/v1/recall/developerGamesLastPlayerToken/{sessionId}", "httpMethod": "GET", "id": "games.recall.lastTokenFromAllDeveloperGames", @@ -883,7 +913,7 @@ false ] }, "retrieveTokens": { -"description": "Retrieve all Recall tokens associated with the PGS Player principal encoded in the provided recall session id. The API is only available for users that have active PGS Player profile.", +"description": "Retrieve all Recall tokens associated with the PGS Player encoded in the provided recall session id. The API is only available for users that have active PGS Player profile.", "flatPath": "games/v1/recall/tokens/{sessionId}", "httpMethod": "GET", "id": "games.recall.retrieveTokens", @@ -1378,7 +1408,7 @@ false } } }, -"revision": "20240515", +"revision": "20240529", "rootUrl": "https://games.googleapis.com/", "schemas": { "AchievementDefinition": { @@ -2132,6 +2162,24 @@ false }, "type": "object" }, +"GamePlayerToken": { +"description": "Recall tokens for a game.", +"id": "GamePlayerToken", +"properties": { +"applicationId": { +"description": "The application that this player identifier is for.", +"type": "string" +}, +"token": { +"description": "Recall token data.", +"items": { +"$ref": "RecallToken" +}, +"type": "array" +} +}, +"type": "object" +}, "GamesAchievementIncrement": { "description": "The payload to request to increment an achievement.", "id": "GamesAchievementIncrement", @@ -3179,6 +3227,20 @@ false }, "type": "object" }, +"RetrieveGamesPlayerTokensResponse": { +"description": "A list of recall token data returned from the RetrieveGamesPlayerTokens RPC", +"id": "RetrieveGamesPlayerTokensResponse", +"properties": { +"applicationRecallTokens": { +"description": "The requested applications along with the recall tokens for the player. If the player does not have recall tokens for an application, that application is not included in the response.", +"items": { +"$ref": "GamePlayerToken" +}, +"type": "array" +} +}, +"type": "object" +}, "RetrievePlayerTokensResponse": { "description": "Response for the RetrievePlayerTokens RPC", "id": "RetrievePlayerTokensResponse", diff --git a/googleapiclient/discovery_cache/documents/gamesConfiguration.v1configuration.json b/googleapiclient/discovery_cache/documents/gamesConfiguration.v1configuration.json index b3523e6dbde..d8847932aaa 100644 --- a/googleapiclient/discovery_cache/documents/gamesConfiguration.v1configuration.json +++ b/googleapiclient/discovery_cache/documents/gamesConfiguration.v1configuration.json @@ -381,7 +381,7 @@ } } }, -"revision": "20240515", +"revision": "20240529", "rootUrl": "https://gamesconfiguration.googleapis.com/", "schemas": { "AchievementConfiguration": { diff --git a/googleapiclient/discovery_cache/documents/gamesManagement.v1management.json b/googleapiclient/discovery_cache/documents/gamesManagement.v1management.json index 72c923f9695..8ebbd0091cc 100644 --- a/googleapiclient/discovery_cache/documents/gamesManagement.v1management.json +++ b/googleapiclient/discovery_cache/documents/gamesManagement.v1management.json @@ -471,7 +471,7 @@ } } }, -"revision": "20240515", +"revision": "20240529", "rootUrl": "https://gamesmanagement.googleapis.com/", "schemas": { "AchievementResetAllResponse": { diff --git a/googleapiclient/discovery_cache/documents/gkebackup.v1.json b/googleapiclient/discovery_cache/documents/gkebackup.v1.json index 3166c6c4a3a..0aad6c4766f 100644 --- a/googleapiclient/discovery_cache/documents/gkebackup.v1.json +++ b/googleapiclient/discovery_cache/documents/gkebackup.v1.json @@ -1713,7 +1713,7 @@ } } }, -"revision": "20240518", +"revision": "20240529", "rootUrl": "https://gkebackup.googleapis.com/", "schemas": { "AuditConfig": { diff --git a/googleapiclient/discovery_cache/documents/gkehub.v1.json b/googleapiclient/discovery_cache/documents/gkehub.v1.json index d9b5edb659b..b864478b254 100644 --- a/googleapiclient/discovery_cache/documents/gkehub.v1.json +++ b/googleapiclient/discovery_cache/documents/gkehub.v1.json @@ -1911,7 +1911,7 @@ } } }, -"revision": "20240519", +"revision": "20240522", "rootUrl": "https://gkehub.googleapis.com/", "schemas": { "AppDevExperienceFeatureSpec": { diff --git a/googleapiclient/discovery_cache/documents/gkehub.v1alpha.json b/googleapiclient/discovery_cache/documents/gkehub.v1alpha.json index c20430dd780..a0282e63550 100644 --- a/googleapiclient/discovery_cache/documents/gkehub.v1alpha.json +++ b/googleapiclient/discovery_cache/documents/gkehub.v1alpha.json @@ -2175,7 +2175,7 @@ } } }, -"revision": "20240519", +"revision": "20240522", "rootUrl": "https://gkehub.googleapis.com/", "schemas": { "AnthosObservabilityFeatureSpec": { diff --git a/googleapiclient/discovery_cache/documents/gkehub.v1beta.json b/googleapiclient/discovery_cache/documents/gkehub.v1beta.json index f237516dc88..092489c62b6 100644 --- a/googleapiclient/discovery_cache/documents/gkehub.v1beta.json +++ b/googleapiclient/discovery_cache/documents/gkehub.v1beta.json @@ -2101,7 +2101,7 @@ } } }, -"revision": "20240519", +"revision": "20240522", "rootUrl": "https://gkehub.googleapis.com/", "schemas": { "AnthosObservabilityFeatureSpec": { diff --git a/googleapiclient/discovery_cache/documents/gkehub.v1beta1.json b/googleapiclient/discovery_cache/documents/gkehub.v1beta1.json index fb360170279..45519e711f2 100644 --- a/googleapiclient/discovery_cache/documents/gkehub.v1beta1.json +++ b/googleapiclient/discovery_cache/documents/gkehub.v1beta1.json @@ -712,7 +712,7 @@ } } }, -"revision": "20240519", +"revision": "20240522", "rootUrl": "https://gkehub.googleapis.com/", "schemas": { "ApplianceCluster": { diff --git a/googleapiclient/discovery_cache/documents/gkehub.v2alpha.json b/googleapiclient/discovery_cache/documents/gkehub.v2alpha.json index 98084eb23ac..bdb226499b9 100644 --- a/googleapiclient/discovery_cache/documents/gkehub.v2alpha.json +++ b/googleapiclient/discovery_cache/documents/gkehub.v2alpha.json @@ -280,7 +280,7 @@ } } }, -"revision": "20240519", +"revision": "20240522", "rootUrl": "https://gkehub.googleapis.com/", "schemas": { "CancelOperationRequest": { diff --git a/googleapiclient/discovery_cache/documents/gmail.v1.json b/googleapiclient/discovery_cache/documents/gmail.v1.json index 42714ecd65f..a6a8ce3e8da 100644 --- a/googleapiclient/discovery_cache/documents/gmail.v1.json +++ b/googleapiclient/discovery_cache/documents/gmail.v1.json @@ -3077,7 +3077,7 @@ } } }, -"revision": "20240527", +"revision": "20240603", "rootUrl": "https://gmail.googleapis.com/", "schemas": { "AutoForwarding": { diff --git a/googleapiclient/discovery_cache/documents/gmailpostmastertools.v1.json b/googleapiclient/discovery_cache/documents/gmailpostmastertools.v1.json index e9993430b2d..0a932eaa9bb 100644 --- a/googleapiclient/discovery_cache/documents/gmailpostmastertools.v1.json +++ b/googleapiclient/discovery_cache/documents/gmailpostmastertools.v1.json @@ -265,7 +265,7 @@ } } }, -"revision": "20240602", +"revision": "20240609", "rootUrl": "https://gmailpostmastertools.googleapis.com/", "schemas": { "DeliveryError": { diff --git a/googleapiclient/discovery_cache/documents/gmailpostmastertools.v1beta1.json b/googleapiclient/discovery_cache/documents/gmailpostmastertools.v1beta1.json index 1d369114bb8..d7f80e6960d 100644 --- a/googleapiclient/discovery_cache/documents/gmailpostmastertools.v1beta1.json +++ b/googleapiclient/discovery_cache/documents/gmailpostmastertools.v1beta1.json @@ -265,7 +265,7 @@ } } }, -"revision": "20240602", +"revision": "20240609", "rootUrl": "https://gmailpostmastertools.googleapis.com/", "schemas": { "DeliveryError": { diff --git a/googleapiclient/discovery_cache/documents/groupsmigration.v1.json b/googleapiclient/discovery_cache/documents/groupsmigration.v1.json index 18c3047964e..7d49fed35a6 100644 --- a/googleapiclient/discovery_cache/documents/groupsmigration.v1.json +++ b/googleapiclient/discovery_cache/documents/groupsmigration.v1.json @@ -146,7 +146,7 @@ } } }, -"revision": "20240527", +"revision": "20240603", "rootUrl": "https://groupsmigration.googleapis.com/", "schemas": { "Groups": { diff --git a/googleapiclient/discovery_cache/documents/healthcare.v1.json b/googleapiclient/discovery_cache/documents/healthcare.v1.json index 6e2f91cd77a..15d73432d65 100644 --- a/googleapiclient/discovery_cache/documents/healthcare.v1.json +++ b/googleapiclient/discovery_cache/documents/healthcare.v1.json @@ -4554,7 +4554,7 @@ } } }, -"revision": "20240521", +"revision": "20240605", "rootUrl": "https://healthcare.googleapis.com/", "schemas": { "ActivateConsentRequest": { diff --git a/googleapiclient/discovery_cache/documents/healthcare.v1beta1.json b/googleapiclient/discovery_cache/documents/healthcare.v1beta1.json index 26308768f43..ac6b9a3c382 100644 --- a/googleapiclient/discovery_cache/documents/healthcare.v1beta1.json +++ b/googleapiclient/discovery_cache/documents/healthcare.v1beta1.json @@ -5672,7 +5672,7 @@ } } }, -"revision": "20240521", +"revision": "20240605", "rootUrl": "https://healthcare.googleapis.com/", "schemas": { "AccessDeterminationLogConfig": { diff --git a/googleapiclient/discovery_cache/documents/homegraph.v1.json b/googleapiclient/discovery_cache/documents/homegraph.v1.json index ddc9110e4e4..760540dc2db 100644 --- a/googleapiclient/discovery_cache/documents/homegraph.v1.json +++ b/googleapiclient/discovery_cache/documents/homegraph.v1.json @@ -216,7 +216,7 @@ } } }, -"revision": "20240529", +"revision": "20240605", "rootUrl": "https://homegraph.googleapis.com/", "schemas": { "AgentDeviceId": { diff --git a/googleapiclient/discovery_cache/documents/iamcredentials.v1.json b/googleapiclient/discovery_cache/documents/iamcredentials.v1.json index 2e39940312c..ccbf704ec61 100644 --- a/googleapiclient/discovery_cache/documents/iamcredentials.v1.json +++ b/googleapiclient/discovery_cache/documents/iamcredentials.v1.json @@ -226,7 +226,7 @@ } } }, -"revision": "20240521", +"revision": "20240529", "rootUrl": "https://iamcredentials.googleapis.com/", "schemas": { "GenerateAccessTokenRequest": { diff --git a/googleapiclient/discovery_cache/documents/iap.v1.json b/googleapiclient/discovery_cache/documents/iap.v1.json index 42bb3ea20a4..709a1e6e944 100644 --- a/googleapiclient/discovery_cache/documents/iap.v1.json +++ b/googleapiclient/discovery_cache/documents/iap.v1.json @@ -682,7 +682,7 @@ } } }, -"revision": "20240527", +"revision": "20240603", "rootUrl": "https://iap.googleapis.com/", "schemas": { "AccessDeniedPageSettings": { diff --git a/googleapiclient/discovery_cache/documents/iap.v1beta1.json b/googleapiclient/discovery_cache/documents/iap.v1beta1.json index 68fba604abb..bc38ef4a36e 100644 --- a/googleapiclient/discovery_cache/documents/iap.v1beta1.json +++ b/googleapiclient/discovery_cache/documents/iap.v1beta1.json @@ -194,7 +194,7 @@ } } }, -"revision": "20240527", +"revision": "20240603", "rootUrl": "https://iap.googleapis.com/", "schemas": { "Binding": { diff --git a/googleapiclient/discovery_cache/documents/identitytoolkit.v1.json b/googleapiclient/discovery_cache/documents/identitytoolkit.v1.json index 33ecd6795f1..077ea5eeffb 100644 --- a/googleapiclient/discovery_cache/documents/identitytoolkit.v1.json +++ b/googleapiclient/discovery_cache/documents/identitytoolkit.v1.json @@ -1239,7 +1239,7 @@ } } }, -"revision": "20240522", +"revision": "20240530", "rootUrl": "https://identitytoolkit.googleapis.com/", "schemas": { "GoogleCloudIdentitytoolkitV1Argon2Parameters": { diff --git a/googleapiclient/discovery_cache/documents/identitytoolkit.v2.json b/googleapiclient/discovery_cache/documents/identitytoolkit.v2.json index 4d181dc1e28..90880b8266d 100644 --- a/googleapiclient/discovery_cache/documents/identitytoolkit.v2.json +++ b/googleapiclient/discovery_cache/documents/identitytoolkit.v2.json @@ -1655,7 +1655,7 @@ } } }, -"revision": "20240522", +"revision": "20240530", "rootUrl": "https://identitytoolkit.googleapis.com/", "schemas": { "GoogleCloudIdentitytoolkitAdminV2AllowByDefault": { diff --git a/googleapiclient/discovery_cache/documents/indexing.v3.json b/googleapiclient/discovery_cache/documents/indexing.v3.json index e12edde16cc..7fadf761d1e 100644 --- a/googleapiclient/discovery_cache/documents/indexing.v3.json +++ b/googleapiclient/discovery_cache/documents/indexing.v3.json @@ -149,7 +149,7 @@ } } }, -"revision": "20240528", +"revision": "20240604", "rootUrl": "https://indexing.googleapis.com/", "schemas": { "PublishUrlNotificationResponse": { diff --git a/googleapiclient/discovery_cache/documents/integrations.v1.json b/googleapiclient/discovery_cache/documents/integrations.v1.json index 445b49fc10f..41405cb4244 100644 --- a/googleapiclient/discovery_cache/documents/integrations.v1.json +++ b/googleapiclient/discovery_cache/documents/integrations.v1.json @@ -3740,7 +3740,7 @@ } } }, -"revision": "20240526", +"revision": "20240602", "rootUrl": "https://integrations.googleapis.com/", "schemas": { "CrmlogErrorCode": { diff --git a/googleapiclient/discovery_cache/documents/keep.v1.json b/googleapiclient/discovery_cache/documents/keep.v1.json index 8240cb894a7..b5be547e026 100644 --- a/googleapiclient/discovery_cache/documents/keep.v1.json +++ b/googleapiclient/discovery_cache/documents/keep.v1.json @@ -314,7 +314,7 @@ } } }, -"revision": "20240528", +"revision": "20240604", "rootUrl": "https://keep.googleapis.com/", "schemas": { "Attachment": { diff --git a/googleapiclient/discovery_cache/documents/kgsearch.v1.json b/googleapiclient/discovery_cache/documents/kgsearch.v1.json index 3223876512d..6ada3451ea0 100644 --- a/googleapiclient/discovery_cache/documents/kgsearch.v1.json +++ b/googleapiclient/discovery_cache/documents/kgsearch.v1.json @@ -151,7 +151,7 @@ } } }, -"revision": "20240602", +"revision": "20240609", "rootUrl": "https://kgsearch.googleapis.com/", "schemas": { "SearchResponse": { diff --git a/googleapiclient/discovery_cache/documents/kmsinventory.v1.json b/googleapiclient/discovery_cache/documents/kmsinventory.v1.json index 7583c25bd6c..60e63c10426 100644 --- a/googleapiclient/discovery_cache/documents/kmsinventory.v1.json +++ b/googleapiclient/discovery_cache/documents/kmsinventory.v1.json @@ -242,7 +242,7 @@ } } }, -"revision": "20240526", +"revision": "20240602", "rootUrl": "https://kmsinventory.googleapis.com/", "schemas": { "GoogleCloudKmsInventoryV1ListCryptoKeysResponse": { diff --git a/googleapiclient/discovery_cache/documents/libraryagent.v1.json b/googleapiclient/discovery_cache/documents/libraryagent.v1.json index 3350b41ec5f..8e32a3d0fa9 100644 --- a/googleapiclient/discovery_cache/documents/libraryagent.v1.json +++ b/googleapiclient/discovery_cache/documents/libraryagent.v1.json @@ -279,7 +279,7 @@ } } }, -"revision": "20240602", +"revision": "20240609", "rootUrl": "https://libraryagent.googleapis.com/", "schemas": { "GoogleExampleLibraryagentV1Book": { diff --git a/googleapiclient/discovery_cache/documents/licensing.v1.json b/googleapiclient/discovery_cache/documents/licensing.v1.json index c31cf2664cf..2c414b11eca 100644 --- a/googleapiclient/discovery_cache/documents/licensing.v1.json +++ b/googleapiclient/discovery_cache/documents/licensing.v1.json @@ -400,7 +400,7 @@ } } }, -"revision": "20240601", +"revision": "20240608", "rootUrl": "https://licensing.googleapis.com/", "schemas": { "Empty": { diff --git a/googleapiclient/discovery_cache/documents/lifesciences.v2beta.json b/googleapiclient/discovery_cache/documents/lifesciences.v2beta.json index 7fa6f8f8813..568b468573f 100644 --- a/googleapiclient/discovery_cache/documents/lifesciences.v2beta.json +++ b/googleapiclient/discovery_cache/documents/lifesciences.v2beta.json @@ -312,7 +312,7 @@ } } }, -"revision": "20240524", +"revision": "20240531", "rootUrl": "https://lifesciences.googleapis.com/", "schemas": { "Accelerator": { diff --git a/googleapiclient/discovery_cache/documents/localservices.v1.json b/googleapiclient/discovery_cache/documents/localservices.v1.json index 931c55ed905..4d213ce1635 100644 --- a/googleapiclient/discovery_cache/documents/localservices.v1.json +++ b/googleapiclient/discovery_cache/documents/localservices.v1.json @@ -250,7 +250,7 @@ } } }, -"revision": "20240602", +"revision": "20240609", "rootUrl": "https://localservices.googleapis.com/", "schemas": { "GoogleAdsHomeservicesLocalservicesV1AccountReport": { diff --git a/googleapiclient/discovery_cache/documents/logging.v2.json b/googleapiclient/discovery_cache/documents/logging.v2.json index a1475d149fe..39d395044cc 100644 --- a/googleapiclient/discovery_cache/documents/logging.v2.json +++ b/googleapiclient/discovery_cache/documents/logging.v2.json @@ -8132,7 +8132,7 @@ } } }, -"revision": "20240523", +"revision": "20240531", "rootUrl": "https://logging.googleapis.com/", "schemas": { "AuditConfig": { diff --git a/googleapiclient/discovery_cache/documents/looker.v1.json b/googleapiclient/discovery_cache/documents/looker.v1.json index 447aa45aaca..bed2f2d973e 100644 --- a/googleapiclient/discovery_cache/documents/looker.v1.json +++ b/googleapiclient/discovery_cache/documents/looker.v1.json @@ -731,7 +731,7 @@ } } }, -"revision": "20240516", +"revision": "20240522", "rootUrl": "https://looker.googleapis.com/", "schemas": { "AdminSettings": { @@ -1059,7 +1059,7 @@ "type": "object" }, "Instance": { -"description": "A Looker instance. LINT.IfChange", +"description": "A Looker instance.", "id": "Instance", "properties": { "adminSettings": { diff --git a/googleapiclient/discovery_cache/documents/managedidentities.v1.json b/googleapiclient/discovery_cache/documents/managedidentities.v1.json index 3cee9e65978..d1531864cf0 100644 --- a/googleapiclient/discovery_cache/documents/managedidentities.v1.json +++ b/googleapiclient/discovery_cache/documents/managedidentities.v1.json @@ -1515,7 +1515,7 @@ } } }, -"revision": "20240112", +"revision": "20240530", "rootUrl": "https://managedidentities.googleapis.com/", "schemas": { "AttachTrustRequest": { @@ -1615,7 +1615,7 @@ "type": "array" }, "role": { -"description": "Role that is assigned to the list of `members`, or principals. For example, `roles/viewer`, `roles/editor`, or `roles/owner`.", +"description": "Role that is assigned to the list of `members`, or principals. For example, `roles/viewer`, `roles/editor`, or `roles/owner`. For an overview of the IAM roles and permissions, see the [IAM documentation](https://cloud.google.com/iam/docs/roles-overview). For a list of the available pre-defined roles, see [here](https://cloud.google.com/iam/docs/understanding-roles).", "type": "string" } }, @@ -1806,7 +1806,7 @@ "type": "object" }, "locations": { -"description": "Required. Locations where domain needs to be provisioned. regions e.g. us-west1 or us-east4 Service supports up to 4 locations at once. Each location will use a /26 block.", +"description": "Required. Locations where domain needs to be provisioned. The locations can be specified according to https://cloud.google.com/compute/docs/regions-zones, such as `us-west1` or `us-east4`. Each domain supports up to 4 locations, separated by commas. Each location will use a /26 block.", "items": { "type": "string" }, @@ -2571,7 +2571,7 @@ "type": "object" }, "MaintenancePolicy": { -"description": "LINT.IfChange Defines policies to service maintenance events.", +"description": "Defines policies to service maintenance events.", "id": "MaintenancePolicy", "properties": { "createTime": { diff --git a/googleapiclient/discovery_cache/documents/managedidentities.v1alpha1.json b/googleapiclient/discovery_cache/documents/managedidentities.v1alpha1.json index 3ae7cbbc906..ee1f7f93558 100644 --- a/googleapiclient/discovery_cache/documents/managedidentities.v1alpha1.json +++ b/googleapiclient/discovery_cache/documents/managedidentities.v1alpha1.json @@ -1515,7 +1515,7 @@ } } }, -"revision": "20240112", +"revision": "20240530", "rootUrl": "https://managedidentities.googleapis.com/", "schemas": { "AttachTrustRequest": { @@ -1620,7 +1620,7 @@ "type": "array" }, "role": { -"description": "Role that is assigned to the list of `members`, or principals. For example, `roles/viewer`, `roles/editor`, or `roles/owner`.", +"description": "Role that is assigned to the list of `members`, or principals. For example, `roles/viewer`, `roles/editor`, or `roles/owner`. For an overview of the IAM roles and permissions, see the [IAM documentation](https://cloud.google.com/iam/docs/roles-overview). For a list of the available pre-defined roles, see [here](https://cloud.google.com/iam/docs/understanding-roles).", "type": "string" } }, @@ -2573,7 +2573,7 @@ "type": "object" }, "MaintenancePolicy": { -"description": "LINT.IfChange Defines policies to service maintenance events.", +"description": "Defines policies to service maintenance events.", "id": "MaintenancePolicy", "properties": { "createTime": { diff --git a/googleapiclient/discovery_cache/documents/managedidentities.v1beta1.json b/googleapiclient/discovery_cache/documents/managedidentities.v1beta1.json index fb37be952a4..3a2e0e7bd2b 100644 --- a/googleapiclient/discovery_cache/documents/managedidentities.v1beta1.json +++ b/googleapiclient/discovery_cache/documents/managedidentities.v1beta1.json @@ -1515,7 +1515,7 @@ } } }, -"revision": "20240112", +"revision": "20240530", "rootUrl": "https://managedidentities.googleapis.com/", "schemas": { "AttachTrustRequest": { @@ -1621,7 +1621,7 @@ "type": "array" }, "role": { -"description": "Role that is assigned to the list of `members`, or principals. For example, `roles/viewer`, `roles/editor`, or `roles/owner`.", +"description": "Role that is assigned to the list of `members`, or principals. For example, `roles/viewer`, `roles/editor`, or `roles/owner`. For an overview of the IAM roles and permissions, see the [IAM documentation](https://cloud.google.com/iam/docs/roles-overview). For a list of the available pre-defined roles, see [here](https://cloud.google.com/iam/docs/understanding-roles).", "type": "string" } }, @@ -2583,7 +2583,7 @@ "type": "object" }, "MaintenancePolicy": { -"description": "LINT.IfChange Defines policies to service maintenance events.", +"description": "Defines policies to service maintenance events.", "id": "MaintenancePolicy", "properties": { "createTime": { diff --git a/googleapiclient/discovery_cache/documents/marketingplatformadmin.v1alpha.json b/googleapiclient/discovery_cache/documents/marketingplatformadmin.v1alpha.json index 6abc1f93f93..ab1af9a051c 100644 --- a/googleapiclient/discovery_cache/documents/marketingplatformadmin.v1alpha.json +++ b/googleapiclient/discovery_cache/documents/marketingplatformadmin.v1alpha.json @@ -263,7 +263,7 @@ } } }, -"revision": "20240603", +"revision": "20240610", "rootUrl": "https://marketingplatformadmin.googleapis.com/", "schemas": { "AnalyticsAccountLink": { diff --git a/googleapiclient/discovery_cache/documents/memcache.v1.json b/googleapiclient/discovery_cache/documents/memcache.v1.json index b0b6d703b66..9445d1e59fa 100644 --- a/googleapiclient/discovery_cache/documents/memcache.v1.json +++ b/googleapiclient/discovery_cache/documents/memcache.v1.json @@ -584,7 +584,7 @@ } } }, -"revision": "20240502", +"revision": "20240604", "rootUrl": "https://memcache.googleapis.com/", "schemas": { "ApplyParametersRequest": { @@ -1161,6 +1161,16 @@ }, "type": "array" }, +"satisfiesPzi": { +"description": "Optional. Output only. Reserved for future use.", +"readOnly": true, +"type": "boolean" +}, +"satisfiesPzs": { +"description": "Optional. Output only. Reserved for future use.", +"readOnly": true, +"type": "boolean" +}, "state": { "description": "Output only. The state of this Memcached instance.", "enum": [ diff --git a/googleapiclient/discovery_cache/documents/memcache.v1beta2.json b/googleapiclient/discovery_cache/documents/memcache.v1beta2.json index 20ce8c7075a..407b0e7db39 100644 --- a/googleapiclient/discovery_cache/documents/memcache.v1beta2.json +++ b/googleapiclient/discovery_cache/documents/memcache.v1beta2.json @@ -612,7 +612,7 @@ } } }, -"revision": "20240502", +"revision": "20240604", "rootUrl": "https://memcache.googleapis.com/", "schemas": { "ApplyParametersRequest": { @@ -1207,6 +1207,16 @@ }, "type": "array" }, +"satisfiesPzi": { +"description": "Optional. Output only. Reserved for future use.", +"readOnly": true, +"type": "boolean" +}, +"satisfiesPzs": { +"description": "Optional. Output only. Reserved for future use.", +"readOnly": true, +"type": "boolean" +}, "state": { "description": "Output only. The state of this Memcached instance.", "enum": [ diff --git a/googleapiclient/discovery_cache/documents/migrationcenter.v1.json b/googleapiclient/discovery_cache/documents/migrationcenter.v1.json index d0e89fb2bcc..f5573559de9 100644 --- a/googleapiclient/discovery_cache/documents/migrationcenter.v1.json +++ b/googleapiclient/discovery_cache/documents/migrationcenter.v1.json @@ -2309,7 +2309,7 @@ } } }, -"revision": "20240523", +"revision": "20240530", "rootUrl": "https://migrationcenter.googleapis.com/", "schemas": { "AddAssetsToGroupRequest": { diff --git a/googleapiclient/discovery_cache/documents/migrationcenter.v1alpha1.json b/googleapiclient/discovery_cache/documents/migrationcenter.v1alpha1.json index 32edbca96dc..4757abf15b4 100644 --- a/googleapiclient/discovery_cache/documents/migrationcenter.v1alpha1.json +++ b/googleapiclient/discovery_cache/documents/migrationcenter.v1alpha1.json @@ -2473,7 +2473,7 @@ } } }, -"revision": "20240523", +"revision": "20240530", "rootUrl": "https://migrationcenter.googleapis.com/", "schemas": { "AddAssetsToGroupRequest": { diff --git a/googleapiclient/discovery_cache/documents/monitoring.v1.json b/googleapiclient/discovery_cache/documents/monitoring.v1.json index c94f1659f74..161e2ceb53b 100644 --- a/googleapiclient/discovery_cache/documents/monitoring.v1.json +++ b/googleapiclient/discovery_cache/documents/monitoring.v1.json @@ -753,7 +753,7 @@ } } }, -"revision": "20240526", +"revision": "20240602", "rootUrl": "https://monitoring.googleapis.com/", "schemas": { "Aggregation": { diff --git a/googleapiclient/discovery_cache/documents/monitoring.v3.json b/googleapiclient/discovery_cache/documents/monitoring.v3.json index 56748535399..8b6ed7c5eed 100644 --- a/googleapiclient/discovery_cache/documents/monitoring.v3.json +++ b/googleapiclient/discovery_cache/documents/monitoring.v3.json @@ -1758,7 +1758,7 @@ ], "parameters": { "name": { -"description": "Required. The name of the Snooze. The format is: projects/[PROJECT_ID_OR_NUMBER]/snoozes/[SNOOZE_ID] The ID of the Snooze will be generated by the system.", +"description": "Required. Identifier. The name of the Snooze. The format is: projects/[PROJECT_ID_OR_NUMBER]/snoozes/[SNOOZE_ID] The ID of the Snooze will be generated by the system.", "location": "path", "pattern": "^projects/[^/]+/snoozes/[^/]+$", "required": true, @@ -2714,7 +2714,7 @@ } } }, -"revision": "20240526", +"revision": "20240602", "rootUrl": "https://monitoring.googleapis.com/", "schemas": { "Aggregation": { @@ -5503,7 +5503,7 @@ "description": "Required. The Snooze will be active from interval.start_time through interval.end_time. interval.start_time cannot be in the past. There is a 15 second clock skew to account for the time it takes for a request to reach the API from the UI." }, "name": { -"description": "Required. The name of the Snooze. The format is: projects/[PROJECT_ID_OR_NUMBER]/snoozes/[SNOOZE_ID] The ID of the Snooze will be generated by the system.", +"description": "Required. Identifier. The name of the Snooze. The format is: projects/[PROJECT_ID_OR_NUMBER]/snoozes/[SNOOZE_ID] The ID of the Snooze will be generated by the system.", "type": "string" } }, diff --git a/googleapiclient/discovery_cache/documents/mybusinessaccountmanagement.v1.json b/googleapiclient/discovery_cache/documents/mybusinessaccountmanagement.v1.json index 8b24ba38e52..fdeab4311f1 100644 --- a/googleapiclient/discovery_cache/documents/mybusinessaccountmanagement.v1.json +++ b/googleapiclient/discovery_cache/documents/mybusinessaccountmanagement.v1.json @@ -530,7 +530,7 @@ } } }, -"revision": "20240602", +"revision": "20240609", "rootUrl": "https://mybusinessaccountmanagement.googleapis.com/", "schemas": { "AcceptInvitationRequest": { diff --git a/googleapiclient/discovery_cache/documents/mybusinessbusinessinformation.v1.json b/googleapiclient/discovery_cache/documents/mybusinessbusinessinformation.v1.json index ee71120579a..771d81a7c04 100644 --- a/googleapiclient/discovery_cache/documents/mybusinessbusinessinformation.v1.json +++ b/googleapiclient/discovery_cache/documents/mybusinessbusinessinformation.v1.json @@ -612,7 +612,7 @@ } } }, -"revision": "20240602", +"revision": "20240609", "rootUrl": "https://mybusinessbusinessinformation.googleapis.com/", "schemas": { "AdWordsLocationExtensions": { diff --git a/googleapiclient/discovery_cache/documents/mybusinesslodging.v1.json b/googleapiclient/discovery_cache/documents/mybusinesslodging.v1.json index f664a2278b7..f3db2502747 100644 --- a/googleapiclient/discovery_cache/documents/mybusinesslodging.v1.json +++ b/googleapiclient/discovery_cache/documents/mybusinesslodging.v1.json @@ -194,7 +194,7 @@ } } }, -"revision": "20240602", +"revision": "20240609", "rootUrl": "https://mybusinesslodging.googleapis.com/", "schemas": { "Accessibility": { diff --git a/googleapiclient/discovery_cache/documents/mybusinessnotifications.v1.json b/googleapiclient/discovery_cache/documents/mybusinessnotifications.v1.json index f632b509a7d..c64e8950e45 100644 --- a/googleapiclient/discovery_cache/documents/mybusinessnotifications.v1.json +++ b/googleapiclient/discovery_cache/documents/mybusinessnotifications.v1.json @@ -154,7 +154,7 @@ } } }, -"revision": "20240602", +"revision": "20240609", "rootUrl": "https://mybusinessnotifications.googleapis.com/", "schemas": { "NotificationSetting": { diff --git a/googleapiclient/discovery_cache/documents/mybusinessplaceactions.v1.json b/googleapiclient/discovery_cache/documents/mybusinessplaceactions.v1.json index ed8b69d4afe..270c9c62c42 100644 --- a/googleapiclient/discovery_cache/documents/mybusinessplaceactions.v1.json +++ b/googleapiclient/discovery_cache/documents/mybusinessplaceactions.v1.json @@ -281,7 +281,7 @@ } } }, -"revision": "20240602", +"revision": "20240609", "rootUrl": "https://mybusinessplaceactions.googleapis.com/", "schemas": { "Empty": { diff --git a/googleapiclient/discovery_cache/documents/mybusinessqanda.v1.json b/googleapiclient/discovery_cache/documents/mybusinessqanda.v1.json index 440c2d46099..34c32d44380 100644 --- a/googleapiclient/discovery_cache/documents/mybusinessqanda.v1.json +++ b/googleapiclient/discovery_cache/documents/mybusinessqanda.v1.json @@ -323,7 +323,7 @@ } } }, -"revision": "20240602", +"revision": "20240609", "rootUrl": "https://mybusinessqanda.googleapis.com/", "schemas": { "Answer": { diff --git a/googleapiclient/discovery_cache/documents/mybusinessverifications.v1.json b/googleapiclient/discovery_cache/documents/mybusinessverifications.v1.json index c1add92c455..d1e57f8e54a 100644 --- a/googleapiclient/discovery_cache/documents/mybusinessverifications.v1.json +++ b/googleapiclient/discovery_cache/documents/mybusinessverifications.v1.json @@ -237,7 +237,7 @@ } } }, -"revision": "20240602", +"revision": "20240609", "rootUrl": "https://mybusinessverifications.googleapis.com/", "schemas": { "AddressVerificationData": { diff --git a/googleapiclient/discovery_cache/documents/networkconnectivity.v1.json b/googleapiclient/discovery_cache/documents/networkconnectivity.v1.json index 2bbb75f8015..3a5f9f4dae1 100644 --- a/googleapiclient/discovery_cache/documents/networkconnectivity.v1.json +++ b/googleapiclient/discovery_cache/documents/networkconnectivity.v1.json @@ -2812,7 +2812,7 @@ } } }, -"revision": "20240523", +"revision": "20240529", "rootUrl": "https://networkconnectivity.googleapis.com/", "schemas": { "AcceptHubSpokeRequest": { @@ -3595,6 +3595,13 @@ }, "type": "array" }, +"includeExportRanges": { +"description": "Optional. IP ranges allowed to be included from peering.", +"items": { +"type": "string" +}, +"type": "array" +}, "uri": { "description": "Required. The URI of the VPC network resource.", "type": "string" diff --git a/googleapiclient/discovery_cache/documents/networkconnectivity.v1alpha1.json b/googleapiclient/discovery_cache/documents/networkconnectivity.v1alpha1.json index e41b66f0088..0ad72d5dfc0 100644 --- a/googleapiclient/discovery_cache/documents/networkconnectivity.v1alpha1.json +++ b/googleapiclient/discovery_cache/documents/networkconnectivity.v1alpha1.json @@ -1116,7 +1116,7 @@ } } }, -"revision": "20240523", +"revision": "20240529", "rootUrl": "https://networkconnectivity.googleapis.com/", "schemas": { "AuditConfig": { diff --git a/googleapiclient/discovery_cache/documents/networksecurity.v1.json b/googleapiclient/discovery_cache/documents/networksecurity.v1.json index be3cbff64c8..7cb7db0af23 100644 --- a/googleapiclient/discovery_cache/documents/networksecurity.v1.json +++ b/googleapiclient/discovery_cache/documents/networksecurity.v1.json @@ -3162,7 +3162,7 @@ } } }, -"revision": "20240510", +"revision": "20240527", "rootUrl": "https://networksecurity.googleapis.com/", "schemas": { "AddAddressGroupItemsRequest": { diff --git a/googleapiclient/discovery_cache/documents/networksecurity.v1beta1.json b/googleapiclient/discovery_cache/documents/networksecurity.v1beta1.json index 18c540ba5b0..ea34ea839c8 100644 --- a/googleapiclient/discovery_cache/documents/networksecurity.v1beta1.json +++ b/googleapiclient/discovery_cache/documents/networksecurity.v1beta1.json @@ -3162,7 +3162,7 @@ } } }, -"revision": "20240510", +"revision": "20240527", "rootUrl": "https://networksecurity.googleapis.com/", "schemas": { "AddAddressGroupItemsRequest": { diff --git a/googleapiclient/discovery_cache/documents/notebooks.v1.json b/googleapiclient/discovery_cache/documents/notebooks.v1.json index 67bd5d363bb..9074acb7acd 100644 --- a/googleapiclient/discovery_cache/documents/notebooks.v1.json +++ b/googleapiclient/discovery_cache/documents/notebooks.v1.json @@ -2008,7 +2008,7 @@ } } }, -"revision": "20240422", +"revision": "20240530", "rootUrl": "https://notebooks.googleapis.com/", "schemas": { "AcceleratorConfig": { diff --git a/googleapiclient/discovery_cache/documents/notebooks.v2.json b/googleapiclient/discovery_cache/documents/notebooks.v2.json index 912ecdc13ba..78b051d4b8a 100644 --- a/googleapiclient/discovery_cache/documents/notebooks.v2.json +++ b/googleapiclient/discovery_cache/documents/notebooks.v2.json @@ -876,7 +876,7 @@ } } }, -"revision": "20240422", +"revision": "20240530", "rootUrl": "https://notebooks.googleapis.com/", "schemas": { "AcceleratorConfig": { @@ -921,6 +921,17 @@ }, "type": "object" }, +"AccessConfig": { +"description": "An access configuration attached to an instance's network interface.", +"id": "AccessConfig", +"properties": { +"externalIp": { +"description": "An external IP address associated with this instance. Specify an unused static external IP address available to the project or leave this field undefined to use an IP from a shared ephemeral IP address pool. If you specify a static external IP address, it must live in the same region as the zone of the instance.", +"type": "string" +} +}, +"type": "object" +}, "Binding": { "description": "Associates `members`, or principals, with a `role`.", "id": "Binding", @@ -1423,6 +1434,16 @@ "readOnly": true, "type": "string" }, +"satisfiesPzi": { +"description": "Output only. Reserved for future use for Zone Isolation.", +"readOnly": true, +"type": "boolean" +}, +"satisfiesPzs": { +"description": "Output only. Reserved for future use for Zone Separation.", +"readOnly": true, +"type": "boolean" +}, "state": { "description": "Output only. The state of this instance.", "enum": [ @@ -1575,6 +1596,13 @@ "description": "The definition of a network interface resource attached to a VM.", "id": "NetworkInterface", "properties": { +"accessConfigs": { +"description": "Optional. An array of configurations for this interface. Currently, only one access config, ONE_TO_ONE_NAT, is supported. If no accessConfigs specified, the instance will have an external internet access through an ephemeral external IP address.", +"items": { +"$ref": "AccessConfig" +}, +"type": "array" +}, "network": { "description": "Optional. The name of the VPC that this VM instance is in. Format: `projects/{project_id}/global/networks/{network_id}`", "type": "string" diff --git a/googleapiclient/discovery_cache/documents/ondemandscanning.v1.json b/googleapiclient/discovery_cache/documents/ondemandscanning.v1.json index 512d84419bc..464c4bb48ec 100644 --- a/googleapiclient/discovery_cache/documents/ondemandscanning.v1.json +++ b/googleapiclient/discovery_cache/documents/ondemandscanning.v1.json @@ -339,7 +339,7 @@ } } }, -"revision": "20240527", +"revision": "20240603", "rootUrl": "https://ondemandscanning.googleapis.com/", "schemas": { "AliasContext": { diff --git a/googleapiclient/discovery_cache/documents/ondemandscanning.v1beta1.json b/googleapiclient/discovery_cache/documents/ondemandscanning.v1beta1.json index 388de7faf7c..f265471518a 100644 --- a/googleapiclient/discovery_cache/documents/ondemandscanning.v1beta1.json +++ b/googleapiclient/discovery_cache/documents/ondemandscanning.v1beta1.json @@ -339,7 +339,7 @@ } } }, -"revision": "20240527", +"revision": "20240603", "rootUrl": "https://ondemandscanning.googleapis.com/", "schemas": { "AliasContext": { diff --git a/googleapiclient/discovery_cache/documents/orgpolicy.v2.json b/googleapiclient/discovery_cache/documents/orgpolicy.v2.json index 97d3697efc4..17da1d14588 100644 --- a/googleapiclient/discovery_cache/documents/orgpolicy.v2.json +++ b/googleapiclient/discovery_cache/documents/orgpolicy.v2.json @@ -930,7 +930,7 @@ } } }, -"revision": "20240524", +"revision": "20240531", "rootUrl": "https://orgpolicy.googleapis.com/", "schemas": { "GoogleCloudOrgpolicyV2AlternatePolicySpec": { diff --git a/googleapiclient/discovery_cache/documents/osconfig.v1.json b/googleapiclient/discovery_cache/documents/osconfig.v1.json index 58126d54e94..4a00c2bbb9f 100644 --- a/googleapiclient/discovery_cache/documents/osconfig.v1.json +++ b/googleapiclient/discovery_cache/documents/osconfig.v1.json @@ -1083,7 +1083,7 @@ } } }, -"revision": "20240526", +"revision": "20240602", "rootUrl": "https://osconfig.googleapis.com/", "schemas": { "AptSettings": { @@ -2277,7 +2277,7 @@ "type": "string" }, "complianceStateReason": { -"description": "The reason for the OS policy to be in an unknown compliance state. This field is always populated when `compliance_state` is `UNKNOWN`. If populated, the field can contain one of the following values: * `vm-not-running`: The VM was not running. * `os-policies-not-supported-by-agent`: The version of the OS Config agent running on the VM does not support running OS policies. * `no-agent-detected`: The OS Config agent is not detected for the VM. * `resource-execution-errors`: The OS Config agent encountered errors while executing one or more resources in the policy. See `os_policy_resource_compliances` for details. * `task-timeout`: The task sent to the agent to apply the policy timed out. * `unexpected-agent-state`: The OS Config agent did not report the final status of the task that attempted to apply the policy. Instead, the agent unexpectedly started working on a different task. This mostly happens when the agent or VM unexpectedly restarts while applying OS policies. * `internal-service-errors`: Internal service errors were encountered while attempting to apply the policy.", +"description": "The reason for the OS policy to be in an unknown compliance state. This field is always populated when `compliance_state` is `UNKNOWN`. If populated, the field can contain one of the following values: * `vm-not-running`: The VM was not running. * `os-policies-not-supported-by-agent`: The version of the OS Config agent running on the VM does not support running OS policies. * `no-agent-detected`: The OS Config agent is not detected for the VM. * `resource-execution-errors`: The OS Config agent encountered errors while executing one or more resources in the policy. See `os_policy_resource_compliances` for details. * `task-timeout`: The task sent to the agent to apply the policy timed out. * `unexpected-agent-state`: The OS Config agent did not report the final status of the task that attempted to apply the policy. Instead, the agent unexpectedly started working on a different task. This mostly happens when the agent or VM unexpectedly restarts while applying OS policies. * `internal-service-errors`: Internal service errors were encountered while attempting to apply the policy. * `os-policy-execution-pending`: OS policy was assigned to the given VM, but was not executed yet. Typically this is a transient condition that will go away after the next policy execution cycle.", "type": "string" }, "osPolicyId": { @@ -2313,7 +2313,7 @@ "type": "string" }, "complianceStateReason": { -"description": "A reason for the resource to be in the given compliance state. This field is always populated when `compliance_state` is `UNKNOWN`. The following values are supported when `compliance_state == UNKNOWN` * `execution-errors`: Errors were encountered by the agent while executing the resource and the compliance state couldn't be determined. * `execution-skipped-by-agent`: Resource execution was skipped by the agent because errors were encountered while executing prior resources in the OS policy. * `os-policy-execution-attempt-failed`: The execution of the OS policy containing this resource failed and the compliance state couldn't be determined.", +"description": "A reason for the resource to be in the given compliance state. This field is always populated when `compliance_state` is `UNKNOWN`. The following values are supported when `compliance_state == UNKNOWN` * `execution-errors`: Errors were encountered by the agent while executing the resource and the compliance state couldn't be determined. * `execution-skipped-by-agent`: Resource execution was skipped by the agent because errors were encountered while executing prior resources in the OS policy. * `os-policy-execution-attempt-failed`: The execution of the OS policy containing this resource failed and the compliance state couldn't be determined. * `os-policy-execution-pending`: OS policy that owns this resource was assigned to the given VM, but was not executed yet.", "type": "string" }, "configSteps": { diff --git a/googleapiclient/discovery_cache/documents/osconfig.v1alpha.json b/googleapiclient/discovery_cache/documents/osconfig.v1alpha.json index 22d54cbf034..19ed1752c52 100644 --- a/googleapiclient/discovery_cache/documents/osconfig.v1alpha.json +++ b/googleapiclient/discovery_cache/documents/osconfig.v1alpha.json @@ -707,7 +707,7 @@ } } }, -"revision": "20240526", +"revision": "20240602", "rootUrl": "https://osconfig.googleapis.com/", "schemas": { "CVSSv3": { @@ -1810,7 +1810,7 @@ "type": "string" }, "complianceStateReason": { -"description": "The reason for the OS policy to be in an unknown compliance state. This field is always populated when `compliance_state` is `UNKNOWN`. If populated, the field can contain one of the following values: * `vm-not-running`: The VM was not running. * `os-policies-not-supported-by-agent`: The version of the OS Config agent running on the VM does not support running OS policies. * `no-agent-detected`: The OS Config agent is not detected for the VM. * `resource-execution-errors`: The OS Config agent encountered errors while executing one or more resources in the policy. See `os_policy_resource_compliances` for details. * `task-timeout`: The task sent to the agent to apply the policy timed out. * `unexpected-agent-state`: The OS Config agent did not report the final status of the task that attempted to apply the policy. Instead, the agent unexpectedly started working on a different task. This mostly happens when the agent or VM unexpectedly restarts while applying OS policies. * `internal-service-errors`: Internal service errors were encountered while attempting to apply the policy.", +"description": "The reason for the OS policy to be in an unknown compliance state. This field is always populated when `compliance_state` is `UNKNOWN`. If populated, the field can contain one of the following values: * `vm-not-running`: The VM was not running. * `os-policies-not-supported-by-agent`: The version of the OS Config agent running on the VM does not support running OS policies. * `no-agent-detected`: The OS Config agent is not detected for the VM. * `resource-execution-errors`: The OS Config agent encountered errors while executing one or more resources in the policy. See `os_policy_resource_compliances` for details. * `task-timeout`: The task sent to the agent to apply the policy timed out. * `unexpected-agent-state`: The OS Config agent did not report the final status of the task that attempted to apply the policy. Instead, the agent unexpectedly started working on a different task. This mostly happens when the agent or VM unexpectedly restarts while applying OS policies. * `internal-service-errors`: Internal service errors were encountered while attempting to apply the policy. * `os-policy-execution-pending`: OS policy was assigned to the given VM, but was not executed yet. Typically this is a transient condition that will go away after the next policy execution cycle.", "type": "string" }, "osPolicyId": { @@ -1846,7 +1846,7 @@ "type": "string" }, "complianceStateReason": { -"description": "A reason for the resource to be in the given compliance state. This field is always populated when `compliance_state` is `UNKNOWN`. The following values are supported when `compliance_state == UNKNOWN` * `execution-errors`: Errors were encountered by the agent while executing the resource and the compliance state couldn't be determined. * `execution-skipped-by-agent`: Resource execution was skipped by the agent because errors were encountered while executing prior resources in the OS policy. * `os-policy-execution-attempt-failed`: The execution of the OS policy containing this resource failed and the compliance state couldn't be determined.", +"description": "A reason for the resource to be in the given compliance state. This field is always populated when `compliance_state` is `UNKNOWN`. The following values are supported when `compliance_state == UNKNOWN` * `execution-errors`: Errors were encountered by the agent while executing the resource and the compliance state couldn't be determined. * `execution-skipped-by-agent`: Resource execution was skipped by the agent because errors were encountered while executing prior resources in the OS policy. * `os-policy-execution-attempt-failed`: The execution of the OS policy containing this resource failed and the compliance state couldn't be determined. * `os-policy-execution-pending`: OS policy that owns this resource was assigned to the given VM, but was not executed yet.", "type": "string" }, "configSteps": { diff --git a/googleapiclient/discovery_cache/documents/osconfig.v1beta.json b/googleapiclient/discovery_cache/documents/osconfig.v1beta.json index 158614ca5ad..26fb8ffe24c 100644 --- a/googleapiclient/discovery_cache/documents/osconfig.v1beta.json +++ b/googleapiclient/discovery_cache/documents/osconfig.v1beta.json @@ -689,7 +689,7 @@ } } }, -"revision": "20240526", +"revision": "20240602", "rootUrl": "https://osconfig.googleapis.com/", "schemas": { "AptRepository": { diff --git a/googleapiclient/discovery_cache/documents/oslogin.v1alpha.json b/googleapiclient/discovery_cache/documents/oslogin.v1alpha.json index dc9a291c31a..151385fce58 100644 --- a/googleapiclient/discovery_cache/documents/oslogin.v1alpha.json +++ b/googleapiclient/discovery_cache/documents/oslogin.v1alpha.json @@ -298,7 +298,7 @@ ], "parameters": { "parent": { -"description": "The parent project and zone for the signing request. This is needed to properly ensure per-organization ISS processing and potentially to provide for the possibility of zone-specific certificates used in the signing process.", +"description": "The parent project and region for the signing request.", "location": "path", "pattern": "^users/[^/]+/projects/[^/]+/locations/[^/]+$", "required": true, @@ -331,7 +331,7 @@ ], "parameters": { "parent": { -"description": "The parent project and zone for the signing request. This is needed to properly ensure per-organization ISS processing and potentially to provide for the possibility of zone-specific certificates used in the signing process.", +"description": "The parent project and region for the signing request.", "location": "path", "pattern": "^users/[^/]+/projects/[^/]+/zones/[^/]+$", "required": true, @@ -477,7 +477,7 @@ } } }, -"revision": "20240519", +"revision": "20240609", "rootUrl": "https://oslogin.googleapis.com/", "schemas": { "Empty": { diff --git a/googleapiclient/discovery_cache/documents/pagespeedonline.v5.json b/googleapiclient/discovery_cache/documents/pagespeedonline.v5.json index f9e48ff7a46..0852e9824da 100644 --- a/googleapiclient/discovery_cache/documents/pagespeedonline.v5.json +++ b/googleapiclient/discovery_cache/documents/pagespeedonline.v5.json @@ -201,7 +201,7 @@ false } } }, -"revision": "20240531", +"revision": "20240607", "rootUrl": "https://pagespeedonline.googleapis.com/", "schemas": { "AuditRefs": { diff --git a/googleapiclient/discovery_cache/documents/paymentsresellersubscription.v1.json b/googleapiclient/discovery_cache/documents/paymentsresellersubscription.v1.json index 25cf868c009..44be496dc86 100644 --- a/googleapiclient/discovery_cache/documents/paymentsresellersubscription.v1.json +++ b/googleapiclient/discovery_cache/documents/paymentsresellersubscription.v1.json @@ -435,7 +435,7 @@ } } }, -"revision": "20240602", +"revision": "20240609", "rootUrl": "https://paymentsresellersubscription.googleapis.com/", "schemas": { "GoogleCloudPaymentsResellerSubscriptionV1Amount": { diff --git a/googleapiclient/discovery_cache/documents/people.v1.json b/googleapiclient/discovery_cache/documents/people.v1.json index 823be8df137..a661758f7e0 100644 --- a/googleapiclient/discovery_cache/documents/people.v1.json +++ b/googleapiclient/discovery_cache/documents/people.v1.json @@ -1190,7 +1190,7 @@ } } }, -"revision": "20240602", +"revision": "20240609", "rootUrl": "https://people.googleapis.com/", "schemas": { "Address": { diff --git a/googleapiclient/discovery_cache/documents/places.v1.json b/googleapiclient/discovery_cache/documents/places.v1.json index 956da97c4a8..358f92b1766 100644 --- a/googleapiclient/discovery_cache/documents/places.v1.json +++ b/googleapiclient/discovery_cache/documents/places.v1.json @@ -276,7 +276,7 @@ } } }, -"revision": "20240602", +"revision": "20240609", "rootUrl": "https://places.googleapis.com/", "schemas": { "GoogleGeoTypeViewport": { diff --git a/googleapiclient/discovery_cache/documents/playcustomapp.v1.json b/googleapiclient/discovery_cache/documents/playcustomapp.v1.json index 3c82524d882..8c5704a5304 100644 --- a/googleapiclient/discovery_cache/documents/playcustomapp.v1.json +++ b/googleapiclient/discovery_cache/documents/playcustomapp.v1.json @@ -158,7 +158,7 @@ } } }, -"revision": "20240602", +"revision": "20240609", "rootUrl": "https://playcustomapp.googleapis.com/", "schemas": { "CustomApp": { diff --git a/googleapiclient/discovery_cache/documents/playdeveloperreporting.v1alpha1.json b/googleapiclient/discovery_cache/documents/playdeveloperreporting.v1alpha1.json index 2a594f19dce..82eb90b9350 100644 --- a/googleapiclient/discovery_cache/documents/playdeveloperreporting.v1alpha1.json +++ b/googleapiclient/discovery_cache/documents/playdeveloperreporting.v1alpha1.json @@ -947,7 +947,7 @@ } } }, -"revision": "20240602", +"revision": "20240609", "rootUrl": "https://playdeveloperreporting.googleapis.com/", "schemas": { "GooglePlayDeveloperReportingV1alpha1Anomaly": { diff --git a/googleapiclient/discovery_cache/documents/playdeveloperreporting.v1beta1.json b/googleapiclient/discovery_cache/documents/playdeveloperreporting.v1beta1.json index 86f96946c52..da24a7e167a 100644 --- a/googleapiclient/discovery_cache/documents/playdeveloperreporting.v1beta1.json +++ b/googleapiclient/discovery_cache/documents/playdeveloperreporting.v1beta1.json @@ -947,7 +947,7 @@ } } }, -"revision": "20240602", +"revision": "20240609", "rootUrl": "https://playdeveloperreporting.googleapis.com/", "schemas": { "GooglePlayDeveloperReportingV1beta1Anomaly": { diff --git a/googleapiclient/discovery_cache/documents/playgrouping.v1alpha1.json b/googleapiclient/discovery_cache/documents/playgrouping.v1alpha1.json index b7e576113d8..95bfd0e00bf 100644 --- a/googleapiclient/discovery_cache/documents/playgrouping.v1alpha1.json +++ b/googleapiclient/discovery_cache/documents/playgrouping.v1alpha1.json @@ -177,7 +177,7 @@ } } }, -"revision": "20240602", +"revision": "20240609", "rootUrl": "https://playgrouping.googleapis.com/", "schemas": { "CreateOrUpdateTagsRequest": { diff --git a/googleapiclient/discovery_cache/documents/playintegrity.v1.json b/googleapiclient/discovery_cache/documents/playintegrity.v1.json index 86b7a2c8740..5f87fe38d61 100644 --- a/googleapiclient/discovery_cache/documents/playintegrity.v1.json +++ b/googleapiclient/discovery_cache/documents/playintegrity.v1.json @@ -138,7 +138,7 @@ } } }, -"revision": "20240602", +"revision": "20240609", "rootUrl": "https://playintegrity.googleapis.com/", "schemas": { "AccountActivity": { diff --git a/googleapiclient/discovery_cache/documents/policyanalyzer.v1.json b/googleapiclient/discovery_cache/documents/policyanalyzer.v1.json index 66bdc558b9a..0b44fe28af9 100644 --- a/googleapiclient/discovery_cache/documents/policyanalyzer.v1.json +++ b/googleapiclient/discovery_cache/documents/policyanalyzer.v1.json @@ -277,7 +277,7 @@ } } }, -"revision": "20240602", +"revision": "20240609", "rootUrl": "https://policyanalyzer.googleapis.com/", "schemas": { "GoogleCloudPolicyanalyzerV1Activity": { diff --git a/googleapiclient/discovery_cache/documents/policyanalyzer.v1beta1.json b/googleapiclient/discovery_cache/documents/policyanalyzer.v1beta1.json index 5420621e859..659b3968781 100644 --- a/googleapiclient/discovery_cache/documents/policyanalyzer.v1beta1.json +++ b/googleapiclient/discovery_cache/documents/policyanalyzer.v1beta1.json @@ -277,7 +277,7 @@ } } }, -"revision": "20240602", +"revision": "20240609", "rootUrl": "https://policyanalyzer.googleapis.com/", "schemas": { "GoogleCloudPolicyanalyzerV1beta1Activity": { diff --git a/googleapiclient/discovery_cache/documents/policysimulator.v1.json b/googleapiclient/discovery_cache/documents/policysimulator.v1.json index 71ec6c6265d..010489aec63 100644 --- a/googleapiclient/discovery_cache/documents/policysimulator.v1.json +++ b/googleapiclient/discovery_cache/documents/policysimulator.v1.json @@ -942,7 +942,7 @@ } } }, -"revision": "20240526", +"revision": "20240602", "rootUrl": "https://policysimulator.googleapis.com/", "schemas": { "GoogleCloudOrgpolicyV2AlternatePolicySpec": { diff --git a/googleapiclient/discovery_cache/documents/policysimulator.v1alpha.json b/googleapiclient/discovery_cache/documents/policysimulator.v1alpha.json index 76bf2cfd17e..d3253ac3586 100644 --- a/googleapiclient/discovery_cache/documents/policysimulator.v1alpha.json +++ b/googleapiclient/discovery_cache/documents/policysimulator.v1alpha.json @@ -1078,7 +1078,7 @@ } } }, -"revision": "20240526", +"revision": "20240602", "rootUrl": "https://policysimulator.googleapis.com/", "schemas": { "GoogleCloudOrgpolicyV2AlternatePolicySpec": { diff --git a/googleapiclient/discovery_cache/documents/policysimulator.v1beta.json b/googleapiclient/discovery_cache/documents/policysimulator.v1beta.json index 40449be6d92..67e0d44d000 100644 --- a/googleapiclient/discovery_cache/documents/policysimulator.v1beta.json +++ b/googleapiclient/discovery_cache/documents/policysimulator.v1beta.json @@ -1078,7 +1078,7 @@ } } }, -"revision": "20240526", +"revision": "20240602", "rootUrl": "https://policysimulator.googleapis.com/", "schemas": { "GoogleCloudOrgpolicyV2AlternatePolicySpec": { diff --git a/googleapiclient/discovery_cache/documents/policytroubleshooter.v1.json b/googleapiclient/discovery_cache/documents/policytroubleshooter.v1.json index d49a974a4e4..f57d9068a23 100644 --- a/googleapiclient/discovery_cache/documents/policytroubleshooter.v1.json +++ b/googleapiclient/discovery_cache/documents/policytroubleshooter.v1.json @@ -128,7 +128,7 @@ } } }, -"revision": "20240602", +"revision": "20240609", "rootUrl": "https://policytroubleshooter.googleapis.com/", "schemas": { "GoogleCloudPolicytroubleshooterV1AccessTuple": { diff --git a/googleapiclient/discovery_cache/documents/policytroubleshooter.v1beta.json b/googleapiclient/discovery_cache/documents/policytroubleshooter.v1beta.json index 9cbf1dcf723..dff3285be33 100644 --- a/googleapiclient/discovery_cache/documents/policytroubleshooter.v1beta.json +++ b/googleapiclient/discovery_cache/documents/policytroubleshooter.v1beta.json @@ -128,7 +128,7 @@ } } }, -"revision": "20240602", +"revision": "20240609", "rootUrl": "https://policytroubleshooter.googleapis.com/", "schemas": { "GoogleCloudPolicytroubleshooterV1betaAccessTuple": { diff --git a/googleapiclient/discovery_cache/documents/privateca.v1.json b/googleapiclient/discovery_cache/documents/privateca.v1.json index 5019b56c59d..076087a946d 100644 --- a/googleapiclient/discovery_cache/documents/privateca.v1.json +++ b/googleapiclient/discovery_cache/documents/privateca.v1.json @@ -1605,7 +1605,7 @@ } } }, -"revision": "20240515", +"revision": "20240529", "rootUrl": "https://privateca.googleapis.com/", "schemas": { "AccessUrls": { @@ -1731,15 +1731,15 @@ "type": "object" }, "CaOptions": { -"description": "Describes values that are relevant in a CA certificate.", +"description": "Describes the X.509 basic constraints extension, per [RFC 5280 section 4.2.1.9](https://tools.ietf.org/html/rfc5280#section-4.2.1.9)", "id": "CaOptions", "properties": { "isCa": { -"description": "Optional. Refers to the \"CA\" X.509 extension, which is a boolean value. When this value is missing, the extension will be omitted from the CA certificate.", +"description": "Optional. Refers to the \"CA\" boolean field in the X.509 extension. When this value is missing, the basic constraints extension will be omitted from the certificate.", "type": "boolean" }, "maxIssuerPathLength": { -"description": "Optional. Refers to the path length restriction X.509 extension. For a CA certificate, this value describes the depth of subordinate CA certificates that are allowed. If this value is less than 0, the request will fail. If this value is missing, the max path length will be omitted from the CA certificate.", +"description": "Optional. Refers to the path length constraint field in the X.509 extension. For a CA certificate, this value describes the depth of subordinate CA certificates that are allowed. If this value is less than 0, the request will fail. If this value is missing, the max path length will be omitted from the certificate.", "format": "int32", "type": "integer" } @@ -3510,7 +3510,7 @@ false }, "caOptions": { "$ref": "CaOptions", -"description": "Optional. Describes options in this X509Parameters that are relevant in a CA certificate." +"description": "Optional. Describes options in this X509Parameters that are relevant in a CA certificate. If not specified, a default basic constraints extension with `is_ca=false` will be added for leaf certificates." }, "keyUsage": { "$ref": "KeyUsage", diff --git a/googleapiclient/discovery_cache/documents/privateca.v1beta1.json b/googleapiclient/discovery_cache/documents/privateca.v1beta1.json index aef1ac248db..fe5b8902c09 100644 --- a/googleapiclient/discovery_cache/documents/privateca.v1beta1.json +++ b/googleapiclient/discovery_cache/documents/privateca.v1beta1.json @@ -580,7 +580,7 @@ } } }, -"revision": "20240515", +"revision": "20240529", "rootUrl": "https://privateca.googleapis.com/", "schemas": { "AuditConfig": { diff --git a/googleapiclient/discovery_cache/documents/prod_tt_sasportal.v1alpha1.json b/googleapiclient/discovery_cache/documents/prod_tt_sasportal.v1alpha1.json index 8f6ce8d6c81..3d625669539 100644 --- a/googleapiclient/discovery_cache/documents/prod_tt_sasportal.v1alpha1.json +++ b/googleapiclient/discovery_cache/documents/prod_tt_sasportal.v1alpha1.json @@ -2653,7 +2653,7 @@ } } }, -"revision": "20240602", +"revision": "20240610", "rootUrl": "https://prod-tt-sasportal.googleapis.com/", "schemas": { "SasPortalAssignment": { diff --git a/googleapiclient/discovery_cache/documents/pubsub.v1.json b/googleapiclient/discovery_cache/documents/pubsub.v1.json index 876c3f6c812..6fd039431df 100644 --- a/googleapiclient/discovery_cache/documents/pubsub.v1.json +++ b/googleapiclient/discovery_cache/documents/pubsub.v1.json @@ -1583,7 +1583,7 @@ } } }, -"revision": "20240528", +"revision": "20240607", "rootUrl": "https://pubsub.googleapis.com/", "schemas": { "AcknowledgeRequest": { @@ -1604,6 +1604,10 @@ "description": "Configuration for writing message data in Avro format. Message payloads and metadata will be written to files as an Avro binary.", "id": "AvroConfig", "properties": { +"useTopicSchema": { +"description": "Optional. When true, the output Cloud Storage file will be serialized using the topic schema, if it exists.", +"type": "boolean" +}, "writeMetadata": { "description": "Optional. When true, write the subscription name, message_id, publish_time, attributes, and ordering_key as additional fields in the output. The subscription name, message_id, and publish_time fields are put in their own fields while all other message properties other than data (for example, an ordering_key, if present) are added as entries in the attributes map.", "type": "boolean" diff --git a/googleapiclient/discovery_cache/documents/pubsub.v1beta1a.json b/googleapiclient/discovery_cache/documents/pubsub.v1beta1a.json index 75a221d605d..59e21522c42 100644 --- a/googleapiclient/discovery_cache/documents/pubsub.v1beta1a.json +++ b/googleapiclient/discovery_cache/documents/pubsub.v1beta1a.json @@ -474,7 +474,7 @@ } } }, -"revision": "20240528", +"revision": "20240607", "rootUrl": "https://pubsub.googleapis.com/", "schemas": { "AcknowledgeRequest": { diff --git a/googleapiclient/discovery_cache/documents/pubsub.v1beta2.json b/googleapiclient/discovery_cache/documents/pubsub.v1beta2.json index 948fa17e9eb..5470914bb74 100644 --- a/googleapiclient/discovery_cache/documents/pubsub.v1beta2.json +++ b/googleapiclient/discovery_cache/documents/pubsub.v1beta2.json @@ -741,7 +741,7 @@ } } }, -"revision": "20240528", +"revision": "20240607", "rootUrl": "https://pubsub.googleapis.com/", "schemas": { "AcknowledgeRequest": { diff --git a/googleapiclient/discovery_cache/documents/pubsublite.v1.json b/googleapiclient/discovery_cache/documents/pubsublite.v1.json index 078cfb3ca8e..be560650f5c 100644 --- a/googleapiclient/discovery_cache/documents/pubsublite.v1.json +++ b/googleapiclient/discovery_cache/documents/pubsublite.v1.json @@ -1040,7 +1040,7 @@ } } }, -"revision": "20240524", +"revision": "20240531", "rootUrl": "https://pubsublite.googleapis.com/", "schemas": { "CancelOperationRequest": { diff --git a/googleapiclient/discovery_cache/documents/rapidmigrationassessment.v1.json b/googleapiclient/discovery_cache/documents/rapidmigrationassessment.v1.json index e639a4f215f..6c8f12c9bf6 100644 --- a/googleapiclient/discovery_cache/documents/rapidmigrationassessment.v1.json +++ b/googleapiclient/discovery_cache/documents/rapidmigrationassessment.v1.json @@ -633,7 +633,7 @@ } } }, -"revision": "20240510", +"revision": "20240525", "rootUrl": "https://rapidmigrationassessment.googleapis.com/", "schemas": { "Annotation": { diff --git a/googleapiclient/discovery_cache/documents/readerrevenuesubscriptionlinking.v1.json b/googleapiclient/discovery_cache/documents/readerrevenuesubscriptionlinking.v1.json index a8b97ffa99b..d2b3999f17b 100644 --- a/googleapiclient/discovery_cache/documents/readerrevenuesubscriptionlinking.v1.json +++ b/googleapiclient/discovery_cache/documents/readerrevenuesubscriptionlinking.v1.json @@ -207,7 +207,7 @@ } } }, -"revision": "20240528", +"revision": "20240609", "rootUrl": "https://readerrevenuesubscriptionlinking.googleapis.com/", "schemas": { "DeleteReaderResponse": { diff --git a/googleapiclient/discovery_cache/documents/realtimebidding.v1.json b/googleapiclient/discovery_cache/documents/realtimebidding.v1.json index 32897352604..a4b05e525cb 100644 --- a/googleapiclient/discovery_cache/documents/realtimebidding.v1.json +++ b/googleapiclient/discovery_cache/documents/realtimebidding.v1.json @@ -1305,7 +1305,7 @@ } } }, -"revision": "20240603", +"revision": "20240610", "rootUrl": "https://realtimebidding.googleapis.com/", "schemas": { "ActivatePretargetingConfigRequest": { diff --git a/googleapiclient/discovery_cache/documents/recaptchaenterprise.v1.json b/googleapiclient/discovery_cache/documents/recaptchaenterprise.v1.json index 38a8ef2e16f..bc6d3c6748e 100644 --- a/googleapiclient/discovery_cache/documents/recaptchaenterprise.v1.json +++ b/googleapiclient/discovery_cache/documents/recaptchaenterprise.v1.json @@ -694,7 +694,7 @@ } } }, -"revision": "20240526", +"revision": "20240602", "rootUrl": "https://recaptchaenterprise.googleapis.com/", "schemas": { "GoogleCloudRecaptchaenterpriseV1AccountDefenderAssessment": { diff --git a/googleapiclient/discovery_cache/documents/recommendationengine.v1beta1.json b/googleapiclient/discovery_cache/documents/recommendationengine.v1beta1.json index 186b0ee9644..9f0527ac5fc 100644 --- a/googleapiclient/discovery_cache/documents/recommendationengine.v1beta1.json +++ b/googleapiclient/discovery_cache/documents/recommendationengine.v1beta1.json @@ -841,7 +841,7 @@ } } }, -"revision": "20240523", +"revision": "20240530", "rootUrl": "https://recommendationengine.googleapis.com/", "schemas": { "GoogleApiHttpBody": { diff --git a/googleapiclient/discovery_cache/documents/recommender.v1.json b/googleapiclient/discovery_cache/documents/recommender.v1.json index 93788f545c6..e8d8ad63545 100644 --- a/googleapiclient/discovery_cache/documents/recommender.v1.json +++ b/googleapiclient/discovery_cache/documents/recommender.v1.json @@ -1686,7 +1686,7 @@ } } }, -"revision": "20240519", +"revision": "20240602", "rootUrl": "https://recommender.googleapis.com/", "schemas": { "GoogleCloudRecommenderV1CostProjection": { diff --git a/googleapiclient/discovery_cache/documents/recommender.v1beta1.json b/googleapiclient/discovery_cache/documents/recommender.v1beta1.json index 51284a11886..55837a32238 100644 --- a/googleapiclient/discovery_cache/documents/recommender.v1beta1.json +++ b/googleapiclient/discovery_cache/documents/recommender.v1beta1.json @@ -1920,7 +1920,7 @@ } } }, -"revision": "20240519", +"revision": "20240602", "rootUrl": "https://recommender.googleapis.com/", "schemas": { "GoogleCloudLocationListLocationsResponse": { diff --git a/googleapiclient/discovery_cache/documents/redis.v1.json b/googleapiclient/discovery_cache/documents/redis.v1.json index 520282c7b79..c45e089cfd4 100644 --- a/googleapiclient/discovery_cache/documents/redis.v1.json +++ b/googleapiclient/discovery_cache/documents/redis.v1.json @@ -821,7 +821,7 @@ } } }, -"revision": "20240524", +"revision": "20240604", "rootUrl": "https://redis.googleapis.com/", "schemas": { "AOFConfig": { @@ -1111,6 +1111,10 @@ "description": "Output only. System assigned, unique identifier for the cluster.", "readOnly": true, "type": "string" +}, +"zoneDistributionConfig": { +"$ref": "ZoneDistributionConfig", +"description": "Optional. This config will be used to determine how the customer wants us to distribute cluster resources within the region." } }, "type": "object" @@ -2801,11 +2805,17 @@ false "description": "Required. Type of aggregation performed on the metric.", "enum": [ "AGGREGATION_TYPE_UNSPECIFIED", -"MAXIMUM" +"PEAK", +"P99", +"P95", +"CURRENT" ], "enumDescriptions": [ "Unspecified aggregation type.", -"Maximum aggregation type." +"PEAK aggregation type.", +"P99 aggregation type.", +"P95 aggregation type.", +"current aggregation type." ], "type": "string" }, @@ -2815,13 +2825,17 @@ false "METRIC_TYPE_UNSPECIFIED", "CPU_UTILIZATION", "MEMORY_UTILIZATION", -"NETWORK_CONNECTIONS" +"NETWORK_CONNECTIONS", +"STORAGE_UTILIZATION", +"STORAGE_USED_BYTES" ], "enumDescriptions": [ -"", +"Unspecified metric type.", "CPU utilization for a resource. The value is a fraction between 0.0 and 1.0 (may momentarily exceed 1.0 in some cases).", "Memory utilization for a resource. The value is a fraction between 0.0 and 1.0 (may momentarily exceed 1.0 in some cases).", -"Number of network connections for a resource." +"Number of network connections for a resource.", +"Storage utilization for a resource. The value is a fraction between 0.0 and 1.0 (may momentarily exceed 1.0 in some cases).", +"Sotrage used by a resource." ], "type": "string" }, @@ -3384,17 +3398,21 @@ false "id": "TypedValue", "properties": { "boolValue": { +"description": "For boolean value", "type": "boolean" }, "doubleValue": { +"description": "For double value", "format": "double", "type": "number" }, "int64Value": { +"description": "For integer value", "format": "int64", "type": "string" }, "stringValue": { +"description": "For string value", "type": "string" } }, @@ -3481,6 +3499,31 @@ false } }, "type": "object" +}, +"ZoneDistributionConfig": { +"description": "Zone distribution config for allocation of cluster resources.", +"id": "ZoneDistributionConfig", +"properties": { +"mode": { +"description": "Optional. The mode of zone distribution. Defaults to MULTI_ZONE, when not specified.", +"enum": [ +"ZONE_DISTRIBUTION_MODE_UNSPECIFIED", +"MULTI_ZONE", +"SINGLE_ZONE" +], +"enumDescriptions": [ +"Not Set. Default: MULTI_ZONE", +"Distribute all resources across 3 zones picked at random, within the region.", +"Distribute all resources in a single zone. The zone field must be specified, when this mode is selected." +], +"type": "string" +}, +"zone": { +"description": "Optional. When SINGLE ZONE distribution is selected, zone field would be used to allocate all resources in that zone. This is not applicable to MULTI_ZONE, and would be ignored for MULTI_ZONE clusters.", +"type": "string" +} +}, +"type": "object" } }, "servicePath": "", diff --git a/googleapiclient/discovery_cache/documents/redis.v1beta1.json b/googleapiclient/discovery_cache/documents/redis.v1beta1.json index 01e54504657..bbe68ce6a54 100644 --- a/googleapiclient/discovery_cache/documents/redis.v1beta1.json +++ b/googleapiclient/discovery_cache/documents/redis.v1beta1.json @@ -821,7 +821,7 @@ } } }, -"revision": "20240524", +"revision": "20240604", "rootUrl": "https://redis.googleapis.com/", "schemas": { "AOFConfig": { @@ -1111,6 +1111,10 @@ "description": "Output only. System assigned, unique identifier for the cluster.", "readOnly": true, "type": "string" +}, +"zoneDistributionConfig": { +"$ref": "ZoneDistributionConfig", +"description": "Optional. This config will be used to determine how the customer wants us to distribute cluster resources within the region." } }, "type": "object" @@ -2808,11 +2812,17 @@ false "description": "Required. Type of aggregation performed on the metric.", "enum": [ "AGGREGATION_TYPE_UNSPECIFIED", -"MAXIMUM" +"PEAK", +"P99", +"P95", +"CURRENT" ], "enumDescriptions": [ "Unspecified aggregation type.", -"Maximum aggregation type." +"PEAK aggregation type.", +"P99 aggregation type.", +"P95 aggregation type.", +"current aggregation type." ], "type": "string" }, @@ -2822,13 +2832,17 @@ false "METRIC_TYPE_UNSPECIFIED", "CPU_UTILIZATION", "MEMORY_UTILIZATION", -"NETWORK_CONNECTIONS" +"NETWORK_CONNECTIONS", +"STORAGE_UTILIZATION", +"STORAGE_USED_BYTES" ], "enumDescriptions": [ -"", +"Unspecified metric type.", "CPU utilization for a resource. The value is a fraction between 0.0 and 1.0 (may momentarily exceed 1.0 in some cases).", "Memory utilization for a resource. The value is a fraction between 0.0 and 1.0 (may momentarily exceed 1.0 in some cases).", -"Number of network connections for a resource." +"Number of network connections for a resource.", +"Storage utilization for a resource. The value is a fraction between 0.0 and 1.0 (may momentarily exceed 1.0 in some cases).", +"Sotrage used by a resource." ], "type": "string" }, @@ -3391,17 +3405,21 @@ false "id": "TypedValue", "properties": { "boolValue": { +"description": "For boolean value", "type": "boolean" }, "doubleValue": { +"description": "For double value", "format": "double", "type": "number" }, "int64Value": { +"description": "For integer value", "format": "int64", "type": "string" }, "stringValue": { +"description": "For string value", "type": "string" } }, @@ -3488,6 +3506,31 @@ false } }, "type": "object" +}, +"ZoneDistributionConfig": { +"description": "Zone distribution config for allocation of cluster resources.", +"id": "ZoneDistributionConfig", +"properties": { +"mode": { +"description": "Optional. The mode of zone distribution. Defaults to MULTI_ZONE, when not specified.", +"enum": [ +"ZONE_DISTRIBUTION_MODE_UNSPECIFIED", +"MULTI_ZONE", +"SINGLE_ZONE" +], +"enumDescriptions": [ +"Not Set. Default: MULTI_ZONE", +"Distribute all resources across 3 zones picked at random, within the region.", +"Distribute all resources in a single zone. The zone field must be specified, when this mode is selected." +], +"type": "string" +}, +"zone": { +"description": "Optional. When SINGLE ZONE distribution is selected, zone field would be used to allocate all resources in that zone. This is not applicable to MULTI_ZONE, and would be ignored for MULTI_ZONE clusters.", +"type": "string" +} +}, +"type": "object" } }, "servicePath": "", diff --git a/googleapiclient/discovery_cache/documents/reseller.v1.json b/googleapiclient/discovery_cache/documents/reseller.v1.json index 9c6b8b0e4dc..be5594aec5d 100644 --- a/googleapiclient/discovery_cache/documents/reseller.v1.json +++ b/googleapiclient/discovery_cache/documents/reseller.v1.json @@ -651,7 +651,7 @@ } } }, -"revision": "20240531", +"revision": "20240606", "rootUrl": "https://reseller.googleapis.com/", "schemas": { "Address": { diff --git a/googleapiclient/discovery_cache/documents/resourcesettings.v1.json b/googleapiclient/discovery_cache/documents/resourcesettings.v1.json index 8f729d27b1d..7014b38e299 100644 --- a/googleapiclient/discovery_cache/documents/resourcesettings.v1.json +++ b/googleapiclient/discovery_cache/documents/resourcesettings.v1.json @@ -511,7 +511,7 @@ } } }, -"revision": "20240602", +"revision": "20240609", "rootUrl": "https://resourcesettings.googleapis.com/", "schemas": { "GoogleCloudResourcesettingsV1ListSettingsResponse": { diff --git a/googleapiclient/discovery_cache/documents/retail.v2.json b/googleapiclient/discovery_cache/documents/retail.v2.json index 4c7db988087..b981750de99 100644 --- a/googleapiclient/discovery_cache/documents/retail.v2.json +++ b/googleapiclient/discovery_cache/documents/retail.v2.json @@ -2092,7 +2092,7 @@ } } }, -"revision": "20240523", +"revision": "20240530", "rootUrl": "https://retail.googleapis.com/", "schemas": { "GoogleApiHttpBody": { diff --git a/googleapiclient/discovery_cache/documents/retail.v2alpha.json b/googleapiclient/discovery_cache/documents/retail.v2alpha.json index f60c47e8477..df9151ae0a8 100644 --- a/googleapiclient/discovery_cache/documents/retail.v2alpha.json +++ b/googleapiclient/discovery_cache/documents/retail.v2alpha.json @@ -2557,7 +2557,7 @@ } } }, -"revision": "20240523", +"revision": "20240530", "rootUrl": "https://retail.googleapis.com/", "schemas": { "GoogleApiHttpBody": { diff --git a/googleapiclient/discovery_cache/documents/retail.v2beta.json b/googleapiclient/discovery_cache/documents/retail.v2beta.json index 081130bfa22..544be9d2d1c 100644 --- a/googleapiclient/discovery_cache/documents/retail.v2beta.json +++ b/googleapiclient/discovery_cache/documents/retail.v2beta.json @@ -2120,7 +2120,7 @@ } } }, -"revision": "20240523", +"revision": "20240530", "rootUrl": "https://retail.googleapis.com/", "schemas": { "GoogleApiHttpBody": { diff --git a/googleapiclient/discovery_cache/documents/safebrowsing.v4.json b/googleapiclient/discovery_cache/documents/safebrowsing.v4.json index 56c22469a2b..839eced7933 100644 --- a/googleapiclient/discovery_cache/documents/safebrowsing.v4.json +++ b/googleapiclient/discovery_cache/documents/safebrowsing.v4.json @@ -261,7 +261,7 @@ } } }, -"revision": "20240519", +"revision": "20240602", "rootUrl": "https://safebrowsing.googleapis.com/", "schemas": { "GoogleProtobufEmpty": { diff --git a/googleapiclient/discovery_cache/documents/safebrowsing.v5.json b/googleapiclient/discovery_cache/documents/safebrowsing.v5.json index 2636413552a..daafa164a82 100644 --- a/googleapiclient/discovery_cache/documents/safebrowsing.v5.json +++ b/googleapiclient/discovery_cache/documents/safebrowsing.v5.json @@ -121,7 +121,7 @@ } } }, -"revision": "20240519", +"revision": "20240602", "rootUrl": "https://safebrowsing.googleapis.com/", "schemas": { "GoogleSecuritySafebrowsingV5FullHash": { diff --git a/googleapiclient/discovery_cache/documents/sasportal.v1alpha1.json b/googleapiclient/discovery_cache/documents/sasportal.v1alpha1.json index 1782265a9c5..041f547fa74 100644 --- a/googleapiclient/discovery_cache/documents/sasportal.v1alpha1.json +++ b/googleapiclient/discovery_cache/documents/sasportal.v1alpha1.json @@ -2652,7 +2652,7 @@ } } }, -"revision": "20240521", +"revision": "20240606", "rootUrl": "https://sasportal.googleapis.com/", "schemas": { "SasPortalAssignment": { diff --git a/googleapiclient/discovery_cache/documents/script.v1.json b/googleapiclient/discovery_cache/documents/script.v1.json index bde26dcc916..6db5c22fe83 100644 --- a/googleapiclient/discovery_cache/documents/script.v1.json +++ b/googleapiclient/discovery_cache/documents/script.v1.json @@ -891,7 +891,7 @@ } } }, -"revision": "20240527", +"revision": "20240602", "rootUrl": "https://script.googleapis.com/", "schemas": { "Content": { diff --git a/googleapiclient/discovery_cache/documents/searchconsole.v1.json b/googleapiclient/discovery_cache/documents/searchconsole.v1.json index 5deb32699b9..92b45dd1d40 100644 --- a/googleapiclient/discovery_cache/documents/searchconsole.v1.json +++ b/googleapiclient/discovery_cache/documents/searchconsole.v1.json @@ -400,7 +400,7 @@ } } }, -"revision": "20240602", +"revision": "20240608", "rootUrl": "https://searchconsole.googleapis.com/", "schemas": { "AmpInspectionResult": { diff --git a/googleapiclient/discovery_cache/documents/secretmanager.v1.json b/googleapiclient/discovery_cache/documents/secretmanager.v1.json index 58a61b96d2b..dc5a3490e37 100644 --- a/googleapiclient/discovery_cache/documents/secretmanager.v1.json +++ b/googleapiclient/discovery_cache/documents/secretmanager.v1.json @@ -1185,7 +1185,7 @@ } } }, -"revision": "20240527", +"revision": "20240531", "rootUrl": "https://secretmanager.googleapis.com/", "schemas": { "AccessSecretVersionResponse": { diff --git a/googleapiclient/discovery_cache/documents/secretmanager.v1beta1.json b/googleapiclient/discovery_cache/documents/secretmanager.v1beta1.json index fc5f8ae2b2a..79b09c9fbea 100644 --- a/googleapiclient/discovery_cache/documents/secretmanager.v1beta1.json +++ b/googleapiclient/discovery_cache/documents/secretmanager.v1beta1.json @@ -705,7 +705,7 @@ } } }, -"revision": "20240527", +"revision": "20240531", "rootUrl": "https://secretmanager.googleapis.com/", "schemas": { "AccessSecretVersionResponse": { diff --git a/googleapiclient/discovery_cache/documents/secretmanager.v1beta2.json b/googleapiclient/discovery_cache/documents/secretmanager.v1beta2.json index 8ad0f0aa2a3..1b5c59f1789 100644 --- a/googleapiclient/discovery_cache/documents/secretmanager.v1beta2.json +++ b/googleapiclient/discovery_cache/documents/secretmanager.v1beta2.json @@ -1185,7 +1185,7 @@ } } }, -"revision": "20240527", +"revision": "20240531", "rootUrl": "https://secretmanager.googleapis.com/", "schemas": { "AccessSecretVersionResponse": { diff --git a/googleapiclient/discovery_cache/documents/serviceconsumermanagement.v1.json b/googleapiclient/discovery_cache/documents/serviceconsumermanagement.v1.json index 8f859eb0270..7781cc7a3ff 100644 --- a/googleapiclient/discovery_cache/documents/serviceconsumermanagement.v1.json +++ b/googleapiclient/discovery_cache/documents/serviceconsumermanagement.v1.json @@ -542,7 +542,7 @@ } } }, -"revision": "20240520", +"revision": "20240603", "rootUrl": "https://serviceconsumermanagement.googleapis.com/", "schemas": { "AddTenantProjectRequest": { @@ -1495,7 +1495,7 @@ "type": "object" }, "HttpRule": { -"description": "# gRPC Transcoding gRPC Transcoding is a feature for mapping between a gRPC method and one or more HTTP REST endpoints. It allows developers to build a single API service that supports both gRPC APIs and REST APIs. Many systems, including [Google APIs](https://github.com/googleapis/googleapis), [Cloud Endpoints](https://cloud.google.com/endpoints), [gRPC Gateway](https://github.com/grpc-ecosystem/grpc-gateway), and [Envoy](https://github.com/envoyproxy/envoy) proxy support this feature and use it for large scale production services. `HttpRule` defines the schema of the gRPC/REST mapping. The mapping specifies how different portions of the gRPC request message are mapped to the URL path, URL query parameters, and HTTP request body. It also controls how the gRPC response message is mapped to the HTTP response body. `HttpRule` is typically specified as an `google.api.http` annotation on the gRPC method. Each mapping specifies a URL path template and an HTTP method. The path template may refer to one or more fields in the gRPC request message, as long as each field is a non-repeated field with a primitive (non-message) type. The path template controls how fields of the request message are mapped to the URL path. Example: service Messaging { rpc GetMessage(GetMessageRequest) returns (Message) { option (google.api.http) = { get: \"/v1/{name=messages/*}\" }; } } message GetMessageRequest { string name = 1; // Mapped to URL path. } message Message { string text = 1; // The resource content. } This enables an HTTP REST to gRPC mapping as below: HTTP | gRPC -----|----- `GET /v1/messages/123456` | `GetMessage(name: \"messages/123456\")` Any fields in the request message which are not bound by the path template automatically become HTTP query parameters if there is no HTTP request body. For example: service Messaging { rpc GetMessage(GetMessageRequest) returns (Message) { option (google.api.http) = { get:\"/v1/messages/{message_id}\" }; } } message GetMessageRequest { message SubMessage { string subfield = 1; } string message_id = 1; // Mapped to URL path. int64 revision = 2; // Mapped to URL query parameter `revision`. SubMessage sub = 3; // Mapped to URL query parameter `sub.subfield`. } This enables a HTTP JSON to RPC mapping as below: HTTP | gRPC -----|----- `GET /v1/messages/123456?revision=2&sub.subfield=foo` | `GetMessage(message_id: \"123456\" revision: 2 sub: SubMessage(subfield: \"foo\"))` Note that fields which are mapped to URL query parameters must have a primitive type or a repeated primitive type or a non-repeated message type. In the case of a repeated type, the parameter can be repeated in the URL as `...?param=A¶m=B`. In the case of a message type, each field of the message is mapped to a separate parameter, such as `...?foo.a=A&foo.b=B&foo.c=C`. For HTTP methods that allow a request body, the `body` field specifies the mapping. Consider a REST update method on the message resource collection: service Messaging { rpc UpdateMessage(UpdateMessageRequest) returns (Message) { option (google.api.http) = { patch: \"/v1/messages/{message_id}\" body: \"message\" }; } } message UpdateMessageRequest { string message_id = 1; // mapped to the URL Message message = 2; // mapped to the body } The following HTTP JSON to RPC mapping is enabled, where the representation of the JSON in the request body is determined by protos JSON encoding: HTTP | gRPC -----|----- `PATCH /v1/messages/123456 { \"text\": \"Hi!\" }` | `UpdateMessage(message_id: \"123456\" message { text: \"Hi!\" })` The special name `*` can be used in the body mapping to define that every field not bound by the path template should be mapped to the request body. This enables the following alternative definition of the update method: service Messaging { rpc UpdateMessage(Message) returns (Message) { option (google.api.http) = { patch: \"/v1/messages/{message_id}\" body: \"*\" }; } } message Message { string message_id = 1; string text = 2; } The following HTTP JSON to RPC mapping is enabled: HTTP | gRPC -----|----- `PATCH /v1/messages/123456 { \"text\": \"Hi!\" }` | `UpdateMessage(message_id: \"123456\" text: \"Hi!\")` Note that when using `*` in the body mapping, it is not possible to have HTTP parameters, as all fields not bound by the path end in the body. This makes this option more rarely used in practice when defining REST APIs. The common usage of `*` is in custom methods which don't use the URL at all for transferring data. It is possible to define multiple HTTP methods for one RPC by using the `additional_bindings` option. Example: service Messaging { rpc GetMessage(GetMessageRequest) returns (Message) { option (google.api.http) = { get: \"/v1/messages/{message_id}\" additional_bindings { get: \"/v1/users/{user_id}/messages/{message_id}\" } }; } } message GetMessageRequest { string message_id = 1; string user_id = 2; } This enables the following two alternative HTTP JSON to RPC mappings: HTTP | gRPC -----|----- `GET /v1/messages/123456` | `GetMessage(message_id: \"123456\")` `GET /v1/users/me/messages/123456` | `GetMessage(user_id: \"me\" message_id: \"123456\")` ## Rules for HTTP mapping 1. Leaf request fields (recursive expansion nested messages in the request message) are classified into three categories: - Fields referred by the path template. They are passed via the URL path. - Fields referred by the HttpRule.body. They are passed via the HTTP request body. - All other fields are passed via the URL query parameters, and the parameter name is the field path in the request message. A repeated field can be represented as multiple query parameters under the same name. 2. If HttpRule.body is \"*\", there is no URL query parameter, all fields are passed via URL path and HTTP request body. 3. If HttpRule.body is omitted, there is no HTTP request body, all fields are passed via URL path and URL query parameters. ### Path template syntax Template = \"/\" Segments [ Verb ] ; Segments = Segment { \"/\" Segment } ; Segment = \"*\" | \"**\" | LITERAL | Variable ; Variable = \"{\" FieldPath [ \"=\" Segments ] \"}\" ; FieldPath = IDENT { \".\" IDENT } ; Verb = \":\" LITERAL ; The syntax `*` matches a single URL path segment. The syntax `**` matches zero or more URL path segments, which must be the last part of the URL path except the `Verb`. The syntax `Variable` matches part of the URL path as specified by its template. A variable template must not contain other variables. If a variable matches a single path segment, its template may be omitted, e.g. `{var}` is equivalent to `{var=*}`. The syntax `LITERAL` matches literal text in the URL path. If the `LITERAL` contains any reserved character, such characters should be percent-encoded before the matching. If a variable contains exactly one path segment, such as `\"{var}\"` or `\"{var=*}\"`, when such a variable is expanded into a URL path on the client side, all characters except `[-_.~0-9a-zA-Z]` are percent-encoded. The server side does the reverse decoding. Such variables show up in the [Discovery Document](https://developers.google.com/discovery/v1/reference/apis) as `{var}`. If a variable contains multiple path segments, such as `\"{var=foo/*}\"` or `\"{var=**}\"`, when such a variable is expanded into a URL path on the client side, all characters except `[-_.~/0-9a-zA-Z]` are percent-encoded. The server side does the reverse decoding, except \"%2F\" and \"%2f\" are left unchanged. Such variables show up in the [Discovery Document](https://developers.google.com/discovery/v1/reference/apis) as `{+var}`. ## Using gRPC API Service Configuration gRPC API Service Configuration (service config) is a configuration language for configuring a gRPC service to become a user-facing product. The service config is simply the YAML representation of the `google.api.Service` proto message. As an alternative to annotating your proto file, you can configure gRPC transcoding in your service config YAML files. You do this by specifying a `HttpRule` that maps the gRPC method to a REST endpoint, achieving the same effect as the proto annotation. This can be particularly useful if you have a proto that is reused in multiple services. Note that any transcoding specified in the service config will override any matching transcoding configuration in the proto. Example: http: rules: # Selects a gRPC method and applies HttpRule to it. - selector: example.v1.Messaging.GetMessage get: /v1/messages/{message_id}/{sub.subfield} ## Special notes When gRPC Transcoding is used to map a gRPC to JSON REST endpoints, the proto to JSON conversion must follow the [proto3 specification](https://developers.google.com/protocol-buffers/docs/proto3#json). While the single segment variable follows the semantics of [RFC 6570](https://tools.ietf.org/html/rfc6570) Section 3.2.2 Simple String Expansion, the multi segment variable **does not** follow RFC 6570 Section 3.2.3 Reserved Expansion. The reason is that the Reserved Expansion does not expand special characters like `?` and `#`, which would lead to invalid URLs. As the result, gRPC Transcoding uses a custom encoding for multi segment variables. The path variables **must not** refer to any repeated or mapped field, because client libraries are not capable of handling such variable expansion. The path variables **must not** capture the leading \"/\" character. The reason is that the most common use case \"{var}\" does not capture the leading \"/\" character. For consistency, all path variables must share the same behavior. Repeated message fields must not be mapped to URL query parameters, because no client library can support such complicated mapping. If an API needs to use a JSON array for request or response body, it can map the request or response body to a repeated field. However, some gRPC Transcoding implementations may not support this feature.", +"description": "gRPC Transcoding gRPC Transcoding is a feature for mapping between a gRPC method and one or more HTTP REST endpoints. It allows developers to build a single API service that supports both gRPC APIs and REST APIs. Many systems, including [Google APIs](https://github.com/googleapis/googleapis), [Cloud Endpoints](https://cloud.google.com/endpoints), [gRPC Gateway](https://github.com/grpc-ecosystem/grpc-gateway), and [Envoy](https://github.com/envoyproxy/envoy) proxy support this feature and use it for large scale production services. `HttpRule` defines the schema of the gRPC/REST mapping. The mapping specifies how different portions of the gRPC request message are mapped to the URL path, URL query parameters, and HTTP request body. It also controls how the gRPC response message is mapped to the HTTP response body. `HttpRule` is typically specified as an `google.api.http` annotation on the gRPC method. Each mapping specifies a URL path template and an HTTP method. The path template may refer to one or more fields in the gRPC request message, as long as each field is a non-repeated field with a primitive (non-message) type. The path template controls how fields of the request message are mapped to the URL path. Example: service Messaging { rpc GetMessage(GetMessageRequest) returns (Message) { option (google.api.http) = { get: \"/v1/{name=messages/*}\" }; } } message GetMessageRequest { string name = 1; // Mapped to URL path. } message Message { string text = 1; // The resource content. } This enables an HTTP REST to gRPC mapping as below: - HTTP: `GET /v1/messages/123456` - gRPC: `GetMessage(name: \"messages/123456\")` Any fields in the request message which are not bound by the path template automatically become HTTP query parameters if there is no HTTP request body. For example: service Messaging { rpc GetMessage(GetMessageRequest) returns (Message) { option (google.api.http) = { get:\"/v1/messages/{message_id}\" }; } } message GetMessageRequest { message SubMessage { string subfield = 1; } string message_id = 1; // Mapped to URL path. int64 revision = 2; // Mapped to URL query parameter `revision`. SubMessage sub = 3; // Mapped to URL query parameter `sub.subfield`. } This enables a HTTP JSON to RPC mapping as below: - HTTP: `GET /v1/messages/123456?revision=2&sub.subfield=foo` - gRPC: `GetMessage(message_id: \"123456\" revision: 2 sub: SubMessage(subfield: \"foo\"))` Note that fields which are mapped to URL query parameters must have a primitive type or a repeated primitive type or a non-repeated message type. In the case of a repeated type, the parameter can be repeated in the URL as `...?param=A¶m=B`. In the case of a message type, each field of the message is mapped to a separate parameter, such as `...?foo.a=A&foo.b=B&foo.c=C`. For HTTP methods that allow a request body, the `body` field specifies the mapping. Consider a REST update method on the message resource collection: service Messaging { rpc UpdateMessage(UpdateMessageRequest) returns (Message) { option (google.api.http) = { patch: \"/v1/messages/{message_id}\" body: \"message\" }; } } message UpdateMessageRequest { string message_id = 1; // mapped to the URL Message message = 2; // mapped to the body } The following HTTP JSON to RPC mapping is enabled, where the representation of the JSON in the request body is determined by protos JSON encoding: - HTTP: `PATCH /v1/messages/123456 { \"text\": \"Hi!\" }` - gRPC: `UpdateMessage(message_id: \"123456\" message { text: \"Hi!\" })` The special name `*` can be used in the body mapping to define that every field not bound by the path template should be mapped to the request body. This enables the following alternative definition of the update method: service Messaging { rpc UpdateMessage(Message) returns (Message) { option (google.api.http) = { patch: \"/v1/messages/{message_id}\" body: \"*\" }; } } message Message { string message_id = 1; string text = 2; } The following HTTP JSON to RPC mapping is enabled: - HTTP: `PATCH /v1/messages/123456 { \"text\": \"Hi!\" }` - gRPC: `UpdateMessage(message_id: \"123456\" text: \"Hi!\")` Note that when using `*` in the body mapping, it is not possible to have HTTP parameters, as all fields not bound by the path end in the body. This makes this option more rarely used in practice when defining REST APIs. The common usage of `*` is in custom methods which don't use the URL at all for transferring data. It is possible to define multiple HTTP methods for one RPC by using the `additional_bindings` option. Example: service Messaging { rpc GetMessage(GetMessageRequest) returns (Message) { option (google.api.http) = { get: \"/v1/messages/{message_id}\" additional_bindings { get: \"/v1/users/{user_id}/messages/{message_id}\" } }; } } message GetMessageRequest { string message_id = 1; string user_id = 2; } This enables the following two alternative HTTP JSON to RPC mappings: - HTTP: `GET /v1/messages/123456` - gRPC: `GetMessage(message_id: \"123456\")` - HTTP: `GET /v1/users/me/messages/123456` - gRPC: `GetMessage(user_id: \"me\" message_id: \"123456\")` Rules for HTTP mapping 1. Leaf request fields (recursive expansion nested messages in the request message) are classified into three categories: - Fields referred by the path template. They are passed via the URL path. - Fields referred by the HttpRule.body. They are passed via the HTTP request body. - All other fields are passed via the URL query parameters, and the parameter name is the field path in the request message. A repeated field can be represented as multiple query parameters under the same name. 2. If HttpRule.body is \"*\", there is no URL query parameter, all fields are passed via URL path and HTTP request body. 3. If HttpRule.body is omitted, there is no HTTP request body, all fields are passed via URL path and URL query parameters. Path template syntax Template = \"/\" Segments [ Verb ] ; Segments = Segment { \"/\" Segment } ; Segment = \"*\" | \"**\" | LITERAL | Variable ; Variable = \"{\" FieldPath [ \"=\" Segments ] \"}\" ; FieldPath = IDENT { \".\" IDENT } ; Verb = \":\" LITERAL ; The syntax `*` matches a single URL path segment. The syntax `**` matches zero or more URL path segments, which must be the last part of the URL path except the `Verb`. The syntax `Variable` matches part of the URL path as specified by its template. A variable template must not contain other variables. If a variable matches a single path segment, its template may be omitted, e.g. `{var}` is equivalent to `{var=*}`. The syntax `LITERAL` matches literal text in the URL path. If the `LITERAL` contains any reserved character, such characters should be percent-encoded before the matching. If a variable contains exactly one path segment, such as `\"{var}\"` or `\"{var=*}\"`, when such a variable is expanded into a URL path on the client side, all characters except `[-_.~0-9a-zA-Z]` are percent-encoded. The server side does the reverse decoding. Such variables show up in the [Discovery Document](https://developers.google.com/discovery/v1/reference/apis) as `{var}`. If a variable contains multiple path segments, such as `\"{var=foo/*}\"` or `\"{var=**}\"`, when such a variable is expanded into a URL path on the client side, all characters except `[-_.~/0-9a-zA-Z]` are percent-encoded. The server side does the reverse decoding, except \"%2F\" and \"%2f\" are left unchanged. Such variables show up in the [Discovery Document](https://developers.google.com/discovery/v1/reference/apis) as `{+var}`. Using gRPC API Service Configuration gRPC API Service Configuration (service config) is a configuration language for configuring a gRPC service to become a user-facing product. The service config is simply the YAML representation of the `google.api.Service` proto message. As an alternative to annotating your proto file, you can configure gRPC transcoding in your service config YAML files. You do this by specifying a `HttpRule` that maps the gRPC method to a REST endpoint, achieving the same effect as the proto annotation. This can be particularly useful if you have a proto that is reused in multiple services. Note that any transcoding specified in the service config will override any matching transcoding configuration in the proto. Example below selects a gRPC method and applies HttpRule to it. http: rules: - selector: example.v1.Messaging.GetMessage get: /v1/messages/{message_id}/{sub.subfield} Special notes When gRPC Transcoding is used to map a gRPC to JSON REST endpoints, the proto to JSON conversion must follow the [proto3 specification](https://developers.google.com/protocol-buffers/docs/proto3#json). While the single segment variable follows the semantics of [RFC 6570](https://tools.ietf.org/html/rfc6570) Section 3.2.2 Simple String Expansion, the multi segment variable **does not** follow RFC 6570 Section 3.2.3 Reserved Expansion. The reason is that the Reserved Expansion does not expand special characters like `?` and `#`, which would lead to invalid URLs. As the result, gRPC Transcoding uses a custom encoding for multi segment variables. The path variables **must not** refer to any repeated or mapped field, because client libraries are not capable of handling such variable expansion. The path variables **must not** capture the leading \"/\" character. The reason is that the most common use case \"{var}\" does not capture the leading \"/\" character. For consistency, all path variables must share the same behavior. Repeated message fields must not be mapped to URL query parameters, because no client library can support such complicated mapping. If an API needs to use a JSON array for request or response body, it can map the request or response body to a repeated field. However, some gRPC Transcoding implementations may not support this feature.", "id": "HttpRule", "properties": { "additionalBindings": { diff --git a/googleapiclient/discovery_cache/documents/serviceconsumermanagement.v1beta1.json b/googleapiclient/discovery_cache/documents/serviceconsumermanagement.v1beta1.json index 102b81362d1..f14575480ab 100644 --- a/googleapiclient/discovery_cache/documents/serviceconsumermanagement.v1beta1.json +++ b/googleapiclient/discovery_cache/documents/serviceconsumermanagement.v1beta1.json @@ -515,7 +515,7 @@ } } }, -"revision": "20240520", +"revision": "20240603", "rootUrl": "https://serviceconsumermanagement.googleapis.com/", "schemas": { "Api": { @@ -1380,7 +1380,7 @@ "type": "object" }, "HttpRule": { -"description": "# gRPC Transcoding gRPC Transcoding is a feature for mapping between a gRPC method and one or more HTTP REST endpoints. It allows developers to build a single API service that supports both gRPC APIs and REST APIs. Many systems, including [Google APIs](https://github.com/googleapis/googleapis), [Cloud Endpoints](https://cloud.google.com/endpoints), [gRPC Gateway](https://github.com/grpc-ecosystem/grpc-gateway), and [Envoy](https://github.com/envoyproxy/envoy) proxy support this feature and use it for large scale production services. `HttpRule` defines the schema of the gRPC/REST mapping. The mapping specifies how different portions of the gRPC request message are mapped to the URL path, URL query parameters, and HTTP request body. It also controls how the gRPC response message is mapped to the HTTP response body. `HttpRule` is typically specified as an `google.api.http` annotation on the gRPC method. Each mapping specifies a URL path template and an HTTP method. The path template may refer to one or more fields in the gRPC request message, as long as each field is a non-repeated field with a primitive (non-message) type. The path template controls how fields of the request message are mapped to the URL path. Example: service Messaging { rpc GetMessage(GetMessageRequest) returns (Message) { option (google.api.http) = { get: \"/v1/{name=messages/*}\" }; } } message GetMessageRequest { string name = 1; // Mapped to URL path. } message Message { string text = 1; // The resource content. } This enables an HTTP REST to gRPC mapping as below: HTTP | gRPC -----|----- `GET /v1/messages/123456` | `GetMessage(name: \"messages/123456\")` Any fields in the request message which are not bound by the path template automatically become HTTP query parameters if there is no HTTP request body. For example: service Messaging { rpc GetMessage(GetMessageRequest) returns (Message) { option (google.api.http) = { get:\"/v1/messages/{message_id}\" }; } } message GetMessageRequest { message SubMessage { string subfield = 1; } string message_id = 1; // Mapped to URL path. int64 revision = 2; // Mapped to URL query parameter `revision`. SubMessage sub = 3; // Mapped to URL query parameter `sub.subfield`. } This enables a HTTP JSON to RPC mapping as below: HTTP | gRPC -----|----- `GET /v1/messages/123456?revision=2&sub.subfield=foo` | `GetMessage(message_id: \"123456\" revision: 2 sub: SubMessage(subfield: \"foo\"))` Note that fields which are mapped to URL query parameters must have a primitive type or a repeated primitive type or a non-repeated message type. In the case of a repeated type, the parameter can be repeated in the URL as `...?param=A¶m=B`. In the case of a message type, each field of the message is mapped to a separate parameter, such as `...?foo.a=A&foo.b=B&foo.c=C`. For HTTP methods that allow a request body, the `body` field specifies the mapping. Consider a REST update method on the message resource collection: service Messaging { rpc UpdateMessage(UpdateMessageRequest) returns (Message) { option (google.api.http) = { patch: \"/v1/messages/{message_id}\" body: \"message\" }; } } message UpdateMessageRequest { string message_id = 1; // mapped to the URL Message message = 2; // mapped to the body } The following HTTP JSON to RPC mapping is enabled, where the representation of the JSON in the request body is determined by protos JSON encoding: HTTP | gRPC -----|----- `PATCH /v1/messages/123456 { \"text\": \"Hi!\" }` | `UpdateMessage(message_id: \"123456\" message { text: \"Hi!\" })` The special name `*` can be used in the body mapping to define that every field not bound by the path template should be mapped to the request body. This enables the following alternative definition of the update method: service Messaging { rpc UpdateMessage(Message) returns (Message) { option (google.api.http) = { patch: \"/v1/messages/{message_id}\" body: \"*\" }; } } message Message { string message_id = 1; string text = 2; } The following HTTP JSON to RPC mapping is enabled: HTTP | gRPC -----|----- `PATCH /v1/messages/123456 { \"text\": \"Hi!\" }` | `UpdateMessage(message_id: \"123456\" text: \"Hi!\")` Note that when using `*` in the body mapping, it is not possible to have HTTP parameters, as all fields not bound by the path end in the body. This makes this option more rarely used in practice when defining REST APIs. The common usage of `*` is in custom methods which don't use the URL at all for transferring data. It is possible to define multiple HTTP methods for one RPC by using the `additional_bindings` option. Example: service Messaging { rpc GetMessage(GetMessageRequest) returns (Message) { option (google.api.http) = { get: \"/v1/messages/{message_id}\" additional_bindings { get: \"/v1/users/{user_id}/messages/{message_id}\" } }; } } message GetMessageRequest { string message_id = 1; string user_id = 2; } This enables the following two alternative HTTP JSON to RPC mappings: HTTP | gRPC -----|----- `GET /v1/messages/123456` | `GetMessage(message_id: \"123456\")` `GET /v1/users/me/messages/123456` | `GetMessage(user_id: \"me\" message_id: \"123456\")` ## Rules for HTTP mapping 1. Leaf request fields (recursive expansion nested messages in the request message) are classified into three categories: - Fields referred by the path template. They are passed via the URL path. - Fields referred by the HttpRule.body. They are passed via the HTTP request body. - All other fields are passed via the URL query parameters, and the parameter name is the field path in the request message. A repeated field can be represented as multiple query parameters under the same name. 2. If HttpRule.body is \"*\", there is no URL query parameter, all fields are passed via URL path and HTTP request body. 3. If HttpRule.body is omitted, there is no HTTP request body, all fields are passed via URL path and URL query parameters. ### Path template syntax Template = \"/\" Segments [ Verb ] ; Segments = Segment { \"/\" Segment } ; Segment = \"*\" | \"**\" | LITERAL | Variable ; Variable = \"{\" FieldPath [ \"=\" Segments ] \"}\" ; FieldPath = IDENT { \".\" IDENT } ; Verb = \":\" LITERAL ; The syntax `*` matches a single URL path segment. The syntax `**` matches zero or more URL path segments, which must be the last part of the URL path except the `Verb`. The syntax `Variable` matches part of the URL path as specified by its template. A variable template must not contain other variables. If a variable matches a single path segment, its template may be omitted, e.g. `{var}` is equivalent to `{var=*}`. The syntax `LITERAL` matches literal text in the URL path. If the `LITERAL` contains any reserved character, such characters should be percent-encoded before the matching. If a variable contains exactly one path segment, such as `\"{var}\"` or `\"{var=*}\"`, when such a variable is expanded into a URL path on the client side, all characters except `[-_.~0-9a-zA-Z]` are percent-encoded. The server side does the reverse decoding. Such variables show up in the [Discovery Document](https://developers.google.com/discovery/v1/reference/apis) as `{var}`. If a variable contains multiple path segments, such as `\"{var=foo/*}\"` or `\"{var=**}\"`, when such a variable is expanded into a URL path on the client side, all characters except `[-_.~/0-9a-zA-Z]` are percent-encoded. The server side does the reverse decoding, except \"%2F\" and \"%2f\" are left unchanged. Such variables show up in the [Discovery Document](https://developers.google.com/discovery/v1/reference/apis) as `{+var}`. ## Using gRPC API Service Configuration gRPC API Service Configuration (service config) is a configuration language for configuring a gRPC service to become a user-facing product. The service config is simply the YAML representation of the `google.api.Service` proto message. As an alternative to annotating your proto file, you can configure gRPC transcoding in your service config YAML files. You do this by specifying a `HttpRule` that maps the gRPC method to a REST endpoint, achieving the same effect as the proto annotation. This can be particularly useful if you have a proto that is reused in multiple services. Note that any transcoding specified in the service config will override any matching transcoding configuration in the proto. Example: http: rules: # Selects a gRPC method and applies HttpRule to it. - selector: example.v1.Messaging.GetMessage get: /v1/messages/{message_id}/{sub.subfield} ## Special notes When gRPC Transcoding is used to map a gRPC to JSON REST endpoints, the proto to JSON conversion must follow the [proto3 specification](https://developers.google.com/protocol-buffers/docs/proto3#json). While the single segment variable follows the semantics of [RFC 6570](https://tools.ietf.org/html/rfc6570) Section 3.2.2 Simple String Expansion, the multi segment variable **does not** follow RFC 6570 Section 3.2.3 Reserved Expansion. The reason is that the Reserved Expansion does not expand special characters like `?` and `#`, which would lead to invalid URLs. As the result, gRPC Transcoding uses a custom encoding for multi segment variables. The path variables **must not** refer to any repeated or mapped field, because client libraries are not capable of handling such variable expansion. The path variables **must not** capture the leading \"/\" character. The reason is that the most common use case \"{var}\" does not capture the leading \"/\" character. For consistency, all path variables must share the same behavior. Repeated message fields must not be mapped to URL query parameters, because no client library can support such complicated mapping. If an API needs to use a JSON array for request or response body, it can map the request or response body to a repeated field. However, some gRPC Transcoding implementations may not support this feature.", +"description": "gRPC Transcoding gRPC Transcoding is a feature for mapping between a gRPC method and one or more HTTP REST endpoints. It allows developers to build a single API service that supports both gRPC APIs and REST APIs. Many systems, including [Google APIs](https://github.com/googleapis/googleapis), [Cloud Endpoints](https://cloud.google.com/endpoints), [gRPC Gateway](https://github.com/grpc-ecosystem/grpc-gateway), and [Envoy](https://github.com/envoyproxy/envoy) proxy support this feature and use it for large scale production services. `HttpRule` defines the schema of the gRPC/REST mapping. The mapping specifies how different portions of the gRPC request message are mapped to the URL path, URL query parameters, and HTTP request body. It also controls how the gRPC response message is mapped to the HTTP response body. `HttpRule` is typically specified as an `google.api.http` annotation on the gRPC method. Each mapping specifies a URL path template and an HTTP method. The path template may refer to one or more fields in the gRPC request message, as long as each field is a non-repeated field with a primitive (non-message) type. The path template controls how fields of the request message are mapped to the URL path. Example: service Messaging { rpc GetMessage(GetMessageRequest) returns (Message) { option (google.api.http) = { get: \"/v1/{name=messages/*}\" }; } } message GetMessageRequest { string name = 1; // Mapped to URL path. } message Message { string text = 1; // The resource content. } This enables an HTTP REST to gRPC mapping as below: - HTTP: `GET /v1/messages/123456` - gRPC: `GetMessage(name: \"messages/123456\")` Any fields in the request message which are not bound by the path template automatically become HTTP query parameters if there is no HTTP request body. For example: service Messaging { rpc GetMessage(GetMessageRequest) returns (Message) { option (google.api.http) = { get:\"/v1/messages/{message_id}\" }; } } message GetMessageRequest { message SubMessage { string subfield = 1; } string message_id = 1; // Mapped to URL path. int64 revision = 2; // Mapped to URL query parameter `revision`. SubMessage sub = 3; // Mapped to URL query parameter `sub.subfield`. } This enables a HTTP JSON to RPC mapping as below: - HTTP: `GET /v1/messages/123456?revision=2&sub.subfield=foo` - gRPC: `GetMessage(message_id: \"123456\" revision: 2 sub: SubMessage(subfield: \"foo\"))` Note that fields which are mapped to URL query parameters must have a primitive type or a repeated primitive type or a non-repeated message type. In the case of a repeated type, the parameter can be repeated in the URL as `...?param=A¶m=B`. In the case of a message type, each field of the message is mapped to a separate parameter, such as `...?foo.a=A&foo.b=B&foo.c=C`. For HTTP methods that allow a request body, the `body` field specifies the mapping. Consider a REST update method on the message resource collection: service Messaging { rpc UpdateMessage(UpdateMessageRequest) returns (Message) { option (google.api.http) = { patch: \"/v1/messages/{message_id}\" body: \"message\" }; } } message UpdateMessageRequest { string message_id = 1; // mapped to the URL Message message = 2; // mapped to the body } The following HTTP JSON to RPC mapping is enabled, where the representation of the JSON in the request body is determined by protos JSON encoding: - HTTP: `PATCH /v1/messages/123456 { \"text\": \"Hi!\" }` - gRPC: `UpdateMessage(message_id: \"123456\" message { text: \"Hi!\" })` The special name `*` can be used in the body mapping to define that every field not bound by the path template should be mapped to the request body. This enables the following alternative definition of the update method: service Messaging { rpc UpdateMessage(Message) returns (Message) { option (google.api.http) = { patch: \"/v1/messages/{message_id}\" body: \"*\" }; } } message Message { string message_id = 1; string text = 2; } The following HTTP JSON to RPC mapping is enabled: - HTTP: `PATCH /v1/messages/123456 { \"text\": \"Hi!\" }` - gRPC: `UpdateMessage(message_id: \"123456\" text: \"Hi!\")` Note that when using `*` in the body mapping, it is not possible to have HTTP parameters, as all fields not bound by the path end in the body. This makes this option more rarely used in practice when defining REST APIs. The common usage of `*` is in custom methods which don't use the URL at all for transferring data. It is possible to define multiple HTTP methods for one RPC by using the `additional_bindings` option. Example: service Messaging { rpc GetMessage(GetMessageRequest) returns (Message) { option (google.api.http) = { get: \"/v1/messages/{message_id}\" additional_bindings { get: \"/v1/users/{user_id}/messages/{message_id}\" } }; } } message GetMessageRequest { string message_id = 1; string user_id = 2; } This enables the following two alternative HTTP JSON to RPC mappings: - HTTP: `GET /v1/messages/123456` - gRPC: `GetMessage(message_id: \"123456\")` - HTTP: `GET /v1/users/me/messages/123456` - gRPC: `GetMessage(user_id: \"me\" message_id: \"123456\")` Rules for HTTP mapping 1. Leaf request fields (recursive expansion nested messages in the request message) are classified into three categories: - Fields referred by the path template. They are passed via the URL path. - Fields referred by the HttpRule.body. They are passed via the HTTP request body. - All other fields are passed via the URL query parameters, and the parameter name is the field path in the request message. A repeated field can be represented as multiple query parameters under the same name. 2. If HttpRule.body is \"*\", there is no URL query parameter, all fields are passed via URL path and HTTP request body. 3. If HttpRule.body is omitted, there is no HTTP request body, all fields are passed via URL path and URL query parameters. Path template syntax Template = \"/\" Segments [ Verb ] ; Segments = Segment { \"/\" Segment } ; Segment = \"*\" | \"**\" | LITERAL | Variable ; Variable = \"{\" FieldPath [ \"=\" Segments ] \"}\" ; FieldPath = IDENT { \".\" IDENT } ; Verb = \":\" LITERAL ; The syntax `*` matches a single URL path segment. The syntax `**` matches zero or more URL path segments, which must be the last part of the URL path except the `Verb`. The syntax `Variable` matches part of the URL path as specified by its template. A variable template must not contain other variables. If a variable matches a single path segment, its template may be omitted, e.g. `{var}` is equivalent to `{var=*}`. The syntax `LITERAL` matches literal text in the URL path. If the `LITERAL` contains any reserved character, such characters should be percent-encoded before the matching. If a variable contains exactly one path segment, such as `\"{var}\"` or `\"{var=*}\"`, when such a variable is expanded into a URL path on the client side, all characters except `[-_.~0-9a-zA-Z]` are percent-encoded. The server side does the reverse decoding. Such variables show up in the [Discovery Document](https://developers.google.com/discovery/v1/reference/apis) as `{var}`. If a variable contains multiple path segments, such as `\"{var=foo/*}\"` or `\"{var=**}\"`, when such a variable is expanded into a URL path on the client side, all characters except `[-_.~/0-9a-zA-Z]` are percent-encoded. The server side does the reverse decoding, except \"%2F\" and \"%2f\" are left unchanged. Such variables show up in the [Discovery Document](https://developers.google.com/discovery/v1/reference/apis) as `{+var}`. Using gRPC API Service Configuration gRPC API Service Configuration (service config) is a configuration language for configuring a gRPC service to become a user-facing product. The service config is simply the YAML representation of the `google.api.Service` proto message. As an alternative to annotating your proto file, you can configure gRPC transcoding in your service config YAML files. You do this by specifying a `HttpRule` that maps the gRPC method to a REST endpoint, achieving the same effect as the proto annotation. This can be particularly useful if you have a proto that is reused in multiple services. Note that any transcoding specified in the service config will override any matching transcoding configuration in the proto. Example below selects a gRPC method and applies HttpRule to it. http: rules: - selector: example.v1.Messaging.GetMessage get: /v1/messages/{message_id}/{sub.subfield} Special notes When gRPC Transcoding is used to map a gRPC to JSON REST endpoints, the proto to JSON conversion must follow the [proto3 specification](https://developers.google.com/protocol-buffers/docs/proto3#json). While the single segment variable follows the semantics of [RFC 6570](https://tools.ietf.org/html/rfc6570) Section 3.2.2 Simple String Expansion, the multi segment variable **does not** follow RFC 6570 Section 3.2.3 Reserved Expansion. The reason is that the Reserved Expansion does not expand special characters like `?` and `#`, which would lead to invalid URLs. As the result, gRPC Transcoding uses a custom encoding for multi segment variables. The path variables **must not** refer to any repeated or mapped field, because client libraries are not capable of handling such variable expansion. The path variables **must not** capture the leading \"/\" character. The reason is that the most common use case \"{var}\" does not capture the leading \"/\" character. For consistency, all path variables must share the same behavior. Repeated message fields must not be mapped to URL query parameters, because no client library can support such complicated mapping. If an API needs to use a JSON array for request or response body, it can map the request or response body to a repeated field. However, some gRPC Transcoding implementations may not support this feature.", "id": "HttpRule", "properties": { "additionalBindings": { diff --git a/googleapiclient/discovery_cache/documents/servicecontrol.v1.json b/googleapiclient/discovery_cache/documents/servicecontrol.v1.json index a413d09d0e1..d8f7c03b47a 100644 --- a/googleapiclient/discovery_cache/documents/servicecontrol.v1.json +++ b/googleapiclient/discovery_cache/documents/servicecontrol.v1.json @@ -197,7 +197,7 @@ } } }, -"revision": "20240524", +"revision": "20240607", "rootUrl": "https://servicecontrol.googleapis.com/", "schemas": { "AllocateInfo": { @@ -1290,7 +1290,7 @@ "type": "any" }, "deprecated": true, -"description": "Optional. Resource payload that is currently in scope and is subjected to orgpolicy conditions. This payload may be the subset of the actual Resource that may come in the request. This payload should not contain any core content.", +"description": "Optional. Deprecated. Resource payload that is currently in scope and is subjected to orgpolicy conditions. This payload may be the subset of the actual Resource that may come in the request.", "type": "object" }, "resourceTags": { @@ -1298,7 +1298,7 @@ "type": "string" }, "deprecated": true, -"description": "Optional. Tags referenced on the resource at the time of evaluation. These also include the federated tags, if they are supplied in the CheckOrgPolicy or CheckCustomConstraints Requests. Optional field as of now. These tags are the Cloud tags that are available on the resource during the policy evaluation and will be available as part of the OrgPolicy check response for logging purposes.", +"description": "Optional. Deprecated. Tags referenced on the resource at the time of evaluation.", "type": "object" }, "resourceType": { diff --git a/googleapiclient/discovery_cache/documents/servicecontrol.v2.json b/googleapiclient/discovery_cache/documents/servicecontrol.v2.json index 5a87c1a3615..0b5c6e84b8a 100644 --- a/googleapiclient/discovery_cache/documents/servicecontrol.v2.json +++ b/googleapiclient/discovery_cache/documents/servicecontrol.v2.json @@ -169,7 +169,7 @@ } } }, -"revision": "20240524", +"revision": "20240607", "rootUrl": "https://servicecontrol.googleapis.com/", "schemas": { "Api": { @@ -530,7 +530,7 @@ "type": "any" }, "deprecated": true, -"description": "Optional. Resource payload that is currently in scope and is subjected to orgpolicy conditions. This payload may be the subset of the actual Resource that may come in the request. This payload should not contain any core content.", +"description": "Optional. Deprecated. Resource payload that is currently in scope and is subjected to orgpolicy conditions. This payload may be the subset of the actual Resource that may come in the request.", "type": "object" }, "resourceTags": { @@ -538,7 +538,7 @@ "type": "string" }, "deprecated": true, -"description": "Optional. Tags referenced on the resource at the time of evaluation. These also include the federated tags, if they are supplied in the CheckOrgPolicy or CheckCustomConstraints Requests. Optional field as of now. These tags are the Cloud tags that are available on the resource during the policy evaluation and will be available as part of the OrgPolicy check response for logging purposes.", +"description": "Optional. Deprecated. Tags referenced on the resource at the time of evaluation.", "type": "object" }, "resourceType": { diff --git a/googleapiclient/discovery_cache/documents/servicedirectory.v1.json b/googleapiclient/discovery_cache/documents/servicedirectory.v1.json index 6069468a989..d086d928c52 100644 --- a/googleapiclient/discovery_cache/documents/servicedirectory.v1.json +++ b/googleapiclient/discovery_cache/documents/servicedirectory.v1.json @@ -883,7 +883,7 @@ } } }, -"revision": "20240526", +"revision": "20240602", "rootUrl": "https://servicedirectory.googleapis.com/", "schemas": { "Binding": { diff --git a/googleapiclient/discovery_cache/documents/servicedirectory.v1beta1.json b/googleapiclient/discovery_cache/documents/servicedirectory.v1beta1.json index bde46b92788..67db3320452 100644 --- a/googleapiclient/discovery_cache/documents/servicedirectory.v1beta1.json +++ b/googleapiclient/discovery_cache/documents/servicedirectory.v1beta1.json @@ -971,7 +971,7 @@ } } }, -"revision": "20240526", +"revision": "20240602", "rootUrl": "https://servicedirectory.googleapis.com/", "schemas": { "Binding": { diff --git a/googleapiclient/discovery_cache/documents/servicemanagement.v1.json b/googleapiclient/discovery_cache/documents/servicemanagement.v1.json index 2cf20dbddea..9366b6ce8a9 100644 --- a/googleapiclient/discovery_cache/documents/servicemanagement.v1.json +++ b/googleapiclient/discovery_cache/documents/servicemanagement.v1.json @@ -830,7 +830,7 @@ } } }, -"revision": "20240524", +"revision": "20240531", "rootUrl": "https://servicemanagement.googleapis.com/", "schemas": { "Advice": { @@ -2043,7 +2043,7 @@ "type": "object" }, "HttpRule": { -"description": "# gRPC Transcoding gRPC Transcoding is a feature for mapping between a gRPC method and one or more HTTP REST endpoints. It allows developers to build a single API service that supports both gRPC APIs and REST APIs. Many systems, including [Google APIs](https://github.com/googleapis/googleapis), [Cloud Endpoints](https://cloud.google.com/endpoints), [gRPC Gateway](https://github.com/grpc-ecosystem/grpc-gateway), and [Envoy](https://github.com/envoyproxy/envoy) proxy support this feature and use it for large scale production services. `HttpRule` defines the schema of the gRPC/REST mapping. The mapping specifies how different portions of the gRPC request message are mapped to the URL path, URL query parameters, and HTTP request body. It also controls how the gRPC response message is mapped to the HTTP response body. `HttpRule` is typically specified as an `google.api.http` annotation on the gRPC method. Each mapping specifies a URL path template and an HTTP method. The path template may refer to one or more fields in the gRPC request message, as long as each field is a non-repeated field with a primitive (non-message) type. The path template controls how fields of the request message are mapped to the URL path. Example: service Messaging { rpc GetMessage(GetMessageRequest) returns (Message) { option (google.api.http) = { get: \"/v1/{name=messages/*}\" }; } } message GetMessageRequest { string name = 1; // Mapped to URL path. } message Message { string text = 1; // The resource content. } This enables an HTTP REST to gRPC mapping as below: HTTP | gRPC -----|----- `GET /v1/messages/123456` | `GetMessage(name: \"messages/123456\")` Any fields in the request message which are not bound by the path template automatically become HTTP query parameters if there is no HTTP request body. For example: service Messaging { rpc GetMessage(GetMessageRequest) returns (Message) { option (google.api.http) = { get:\"/v1/messages/{message_id}\" }; } } message GetMessageRequest { message SubMessage { string subfield = 1; } string message_id = 1; // Mapped to URL path. int64 revision = 2; // Mapped to URL query parameter `revision`. SubMessage sub = 3; // Mapped to URL query parameter `sub.subfield`. } This enables a HTTP JSON to RPC mapping as below: HTTP | gRPC -----|----- `GET /v1/messages/123456?revision=2&sub.subfield=foo` | `GetMessage(message_id: \"123456\" revision: 2 sub: SubMessage(subfield: \"foo\"))` Note that fields which are mapped to URL query parameters must have a primitive type or a repeated primitive type or a non-repeated message type. In the case of a repeated type, the parameter can be repeated in the URL as `...?param=A¶m=B`. In the case of a message type, each field of the message is mapped to a separate parameter, such as `...?foo.a=A&foo.b=B&foo.c=C`. For HTTP methods that allow a request body, the `body` field specifies the mapping. Consider a REST update method on the message resource collection: service Messaging { rpc UpdateMessage(UpdateMessageRequest) returns (Message) { option (google.api.http) = { patch: \"/v1/messages/{message_id}\" body: \"message\" }; } } message UpdateMessageRequest { string message_id = 1; // mapped to the URL Message message = 2; // mapped to the body } The following HTTP JSON to RPC mapping is enabled, where the representation of the JSON in the request body is determined by protos JSON encoding: HTTP | gRPC -----|----- `PATCH /v1/messages/123456 { \"text\": \"Hi!\" }` | `UpdateMessage(message_id: \"123456\" message { text: \"Hi!\" })` The special name `*` can be used in the body mapping to define that every field not bound by the path template should be mapped to the request body. This enables the following alternative definition of the update method: service Messaging { rpc UpdateMessage(Message) returns (Message) { option (google.api.http) = { patch: \"/v1/messages/{message_id}\" body: \"*\" }; } } message Message { string message_id = 1; string text = 2; } The following HTTP JSON to RPC mapping is enabled: HTTP | gRPC -----|----- `PATCH /v1/messages/123456 { \"text\": \"Hi!\" }` | `UpdateMessage(message_id: \"123456\" text: \"Hi!\")` Note that when using `*` in the body mapping, it is not possible to have HTTP parameters, as all fields not bound by the path end in the body. This makes this option more rarely used in practice when defining REST APIs. The common usage of `*` is in custom methods which don't use the URL at all for transferring data. It is possible to define multiple HTTP methods for one RPC by using the `additional_bindings` option. Example: service Messaging { rpc GetMessage(GetMessageRequest) returns (Message) { option (google.api.http) = { get: \"/v1/messages/{message_id}\" additional_bindings { get: \"/v1/users/{user_id}/messages/{message_id}\" } }; } } message GetMessageRequest { string message_id = 1; string user_id = 2; } This enables the following two alternative HTTP JSON to RPC mappings: HTTP | gRPC -----|----- `GET /v1/messages/123456` | `GetMessage(message_id: \"123456\")` `GET /v1/users/me/messages/123456` | `GetMessage(user_id: \"me\" message_id: \"123456\")` ## Rules for HTTP mapping 1. Leaf request fields (recursive expansion nested messages in the request message) are classified into three categories: - Fields referred by the path template. They are passed via the URL path. - Fields referred by the HttpRule.body. They are passed via the HTTP request body. - All other fields are passed via the URL query parameters, and the parameter name is the field path in the request message. A repeated field can be represented as multiple query parameters under the same name. 2. If HttpRule.body is \"*\", there is no URL query parameter, all fields are passed via URL path and HTTP request body. 3. If HttpRule.body is omitted, there is no HTTP request body, all fields are passed via URL path and URL query parameters. ### Path template syntax Template = \"/\" Segments [ Verb ] ; Segments = Segment { \"/\" Segment } ; Segment = \"*\" | \"**\" | LITERAL | Variable ; Variable = \"{\" FieldPath [ \"=\" Segments ] \"}\" ; FieldPath = IDENT { \".\" IDENT } ; Verb = \":\" LITERAL ; The syntax `*` matches a single URL path segment. The syntax `**` matches zero or more URL path segments, which must be the last part of the URL path except the `Verb`. The syntax `Variable` matches part of the URL path as specified by its template. A variable template must not contain other variables. If a variable matches a single path segment, its template may be omitted, e.g. `{var}` is equivalent to `{var=*}`. The syntax `LITERAL` matches literal text in the URL path. If the `LITERAL` contains any reserved character, such characters should be percent-encoded before the matching. If a variable contains exactly one path segment, such as `\"{var}\"` or `\"{var=*}\"`, when such a variable is expanded into a URL path on the client side, all characters except `[-_.~0-9a-zA-Z]` are percent-encoded. The server side does the reverse decoding. Such variables show up in the [Discovery Document](https://developers.google.com/discovery/v1/reference/apis) as `{var}`. If a variable contains multiple path segments, such as `\"{var=foo/*}\"` or `\"{var=**}\"`, when such a variable is expanded into a URL path on the client side, all characters except `[-_.~/0-9a-zA-Z]` are percent-encoded. The server side does the reverse decoding, except \"%2F\" and \"%2f\" are left unchanged. Such variables show up in the [Discovery Document](https://developers.google.com/discovery/v1/reference/apis) as `{+var}`. ## Using gRPC API Service Configuration gRPC API Service Configuration (service config) is a configuration language for configuring a gRPC service to become a user-facing product. The service config is simply the YAML representation of the `google.api.Service` proto message. As an alternative to annotating your proto file, you can configure gRPC transcoding in your service config YAML files. You do this by specifying a `HttpRule` that maps the gRPC method to a REST endpoint, achieving the same effect as the proto annotation. This can be particularly useful if you have a proto that is reused in multiple services. Note that any transcoding specified in the service config will override any matching transcoding configuration in the proto. Example: http: rules: # Selects a gRPC method and applies HttpRule to it. - selector: example.v1.Messaging.GetMessage get: /v1/messages/{message_id}/{sub.subfield} ## Special notes When gRPC Transcoding is used to map a gRPC to JSON REST endpoints, the proto to JSON conversion must follow the [proto3 specification](https://developers.google.com/protocol-buffers/docs/proto3#json). While the single segment variable follows the semantics of [RFC 6570](https://tools.ietf.org/html/rfc6570) Section 3.2.2 Simple String Expansion, the multi segment variable **does not** follow RFC 6570 Section 3.2.3 Reserved Expansion. The reason is that the Reserved Expansion does not expand special characters like `?` and `#`, which would lead to invalid URLs. As the result, gRPC Transcoding uses a custom encoding for multi segment variables. The path variables **must not** refer to any repeated or mapped field, because client libraries are not capable of handling such variable expansion. The path variables **must not** capture the leading \"/\" character. The reason is that the most common use case \"{var}\" does not capture the leading \"/\" character. For consistency, all path variables must share the same behavior. Repeated message fields must not be mapped to URL query parameters, because no client library can support such complicated mapping. If an API needs to use a JSON array for request or response body, it can map the request or response body to a repeated field. However, some gRPC Transcoding implementations may not support this feature.", +"description": "gRPC Transcoding gRPC Transcoding is a feature for mapping between a gRPC method and one or more HTTP REST endpoints. It allows developers to build a single API service that supports both gRPC APIs and REST APIs. Many systems, including [Google APIs](https://github.com/googleapis/googleapis), [Cloud Endpoints](https://cloud.google.com/endpoints), [gRPC Gateway](https://github.com/grpc-ecosystem/grpc-gateway), and [Envoy](https://github.com/envoyproxy/envoy) proxy support this feature and use it for large scale production services. `HttpRule` defines the schema of the gRPC/REST mapping. The mapping specifies how different portions of the gRPC request message are mapped to the URL path, URL query parameters, and HTTP request body. It also controls how the gRPC response message is mapped to the HTTP response body. `HttpRule` is typically specified as an `google.api.http` annotation on the gRPC method. Each mapping specifies a URL path template and an HTTP method. The path template may refer to one or more fields in the gRPC request message, as long as each field is a non-repeated field with a primitive (non-message) type. The path template controls how fields of the request message are mapped to the URL path. Example: service Messaging { rpc GetMessage(GetMessageRequest) returns (Message) { option (google.api.http) = { get: \"/v1/{name=messages/*}\" }; } } message GetMessageRequest { string name = 1; // Mapped to URL path. } message Message { string text = 1; // The resource content. } This enables an HTTP REST to gRPC mapping as below: - HTTP: `GET /v1/messages/123456` - gRPC: `GetMessage(name: \"messages/123456\")` Any fields in the request message which are not bound by the path template automatically become HTTP query parameters if there is no HTTP request body. For example: service Messaging { rpc GetMessage(GetMessageRequest) returns (Message) { option (google.api.http) = { get:\"/v1/messages/{message_id}\" }; } } message GetMessageRequest { message SubMessage { string subfield = 1; } string message_id = 1; // Mapped to URL path. int64 revision = 2; // Mapped to URL query parameter `revision`. SubMessage sub = 3; // Mapped to URL query parameter `sub.subfield`. } This enables a HTTP JSON to RPC mapping as below: - HTTP: `GET /v1/messages/123456?revision=2&sub.subfield=foo` - gRPC: `GetMessage(message_id: \"123456\" revision: 2 sub: SubMessage(subfield: \"foo\"))` Note that fields which are mapped to URL query parameters must have a primitive type or a repeated primitive type or a non-repeated message type. In the case of a repeated type, the parameter can be repeated in the URL as `...?param=A¶m=B`. In the case of a message type, each field of the message is mapped to a separate parameter, such as `...?foo.a=A&foo.b=B&foo.c=C`. For HTTP methods that allow a request body, the `body` field specifies the mapping. Consider a REST update method on the message resource collection: service Messaging { rpc UpdateMessage(UpdateMessageRequest) returns (Message) { option (google.api.http) = { patch: \"/v1/messages/{message_id}\" body: \"message\" }; } } message UpdateMessageRequest { string message_id = 1; // mapped to the URL Message message = 2; // mapped to the body } The following HTTP JSON to RPC mapping is enabled, where the representation of the JSON in the request body is determined by protos JSON encoding: - HTTP: `PATCH /v1/messages/123456 { \"text\": \"Hi!\" }` - gRPC: `UpdateMessage(message_id: \"123456\" message { text: \"Hi!\" })` The special name `*` can be used in the body mapping to define that every field not bound by the path template should be mapped to the request body. This enables the following alternative definition of the update method: service Messaging { rpc UpdateMessage(Message) returns (Message) { option (google.api.http) = { patch: \"/v1/messages/{message_id}\" body: \"*\" }; } } message Message { string message_id = 1; string text = 2; } The following HTTP JSON to RPC mapping is enabled: - HTTP: `PATCH /v1/messages/123456 { \"text\": \"Hi!\" }` - gRPC: `UpdateMessage(message_id: \"123456\" text: \"Hi!\")` Note that when using `*` in the body mapping, it is not possible to have HTTP parameters, as all fields not bound by the path end in the body. This makes this option more rarely used in practice when defining REST APIs. The common usage of `*` is in custom methods which don't use the URL at all for transferring data. It is possible to define multiple HTTP methods for one RPC by using the `additional_bindings` option. Example: service Messaging { rpc GetMessage(GetMessageRequest) returns (Message) { option (google.api.http) = { get: \"/v1/messages/{message_id}\" additional_bindings { get: \"/v1/users/{user_id}/messages/{message_id}\" } }; } } message GetMessageRequest { string message_id = 1; string user_id = 2; } This enables the following two alternative HTTP JSON to RPC mappings: - HTTP: `GET /v1/messages/123456` - gRPC: `GetMessage(message_id: \"123456\")` - HTTP: `GET /v1/users/me/messages/123456` - gRPC: `GetMessage(user_id: \"me\" message_id: \"123456\")` Rules for HTTP mapping 1. Leaf request fields (recursive expansion nested messages in the request message) are classified into three categories: - Fields referred by the path template. They are passed via the URL path. - Fields referred by the HttpRule.body. They are passed via the HTTP request body. - All other fields are passed via the URL query parameters, and the parameter name is the field path in the request message. A repeated field can be represented as multiple query parameters under the same name. 2. If HttpRule.body is \"*\", there is no URL query parameter, all fields are passed via URL path and HTTP request body. 3. If HttpRule.body is omitted, there is no HTTP request body, all fields are passed via URL path and URL query parameters. Path template syntax Template = \"/\" Segments [ Verb ] ; Segments = Segment { \"/\" Segment } ; Segment = \"*\" | \"**\" | LITERAL | Variable ; Variable = \"{\" FieldPath [ \"=\" Segments ] \"}\" ; FieldPath = IDENT { \".\" IDENT } ; Verb = \":\" LITERAL ; The syntax `*` matches a single URL path segment. The syntax `**` matches zero or more URL path segments, which must be the last part of the URL path except the `Verb`. The syntax `Variable` matches part of the URL path as specified by its template. A variable template must not contain other variables. If a variable matches a single path segment, its template may be omitted, e.g. `{var}` is equivalent to `{var=*}`. The syntax `LITERAL` matches literal text in the URL path. If the `LITERAL` contains any reserved character, such characters should be percent-encoded before the matching. If a variable contains exactly one path segment, such as `\"{var}\"` or `\"{var=*}\"`, when such a variable is expanded into a URL path on the client side, all characters except `[-_.~0-9a-zA-Z]` are percent-encoded. The server side does the reverse decoding. Such variables show up in the [Discovery Document](https://developers.google.com/discovery/v1/reference/apis) as `{var}`. If a variable contains multiple path segments, such as `\"{var=foo/*}\"` or `\"{var=**}\"`, when such a variable is expanded into a URL path on the client side, all characters except `[-_.~/0-9a-zA-Z]` are percent-encoded. The server side does the reverse decoding, except \"%2F\" and \"%2f\" are left unchanged. Such variables show up in the [Discovery Document](https://developers.google.com/discovery/v1/reference/apis) as `{+var}`. Using gRPC API Service Configuration gRPC API Service Configuration (service config) is a configuration language for configuring a gRPC service to become a user-facing product. The service config is simply the YAML representation of the `google.api.Service` proto message. As an alternative to annotating your proto file, you can configure gRPC transcoding in your service config YAML files. You do this by specifying a `HttpRule` that maps the gRPC method to a REST endpoint, achieving the same effect as the proto annotation. This can be particularly useful if you have a proto that is reused in multiple services. Note that any transcoding specified in the service config will override any matching transcoding configuration in the proto. Example below selects a gRPC method and applies HttpRule to it. http: rules: - selector: example.v1.Messaging.GetMessage get: /v1/messages/{message_id}/{sub.subfield} Special notes When gRPC Transcoding is used to map a gRPC to JSON REST endpoints, the proto to JSON conversion must follow the [proto3 specification](https://developers.google.com/protocol-buffers/docs/proto3#json). While the single segment variable follows the semantics of [RFC 6570](https://tools.ietf.org/html/rfc6570) Section 3.2.2 Simple String Expansion, the multi segment variable **does not** follow RFC 6570 Section 3.2.3 Reserved Expansion. The reason is that the Reserved Expansion does not expand special characters like `?` and `#`, which would lead to invalid URLs. As the result, gRPC Transcoding uses a custom encoding for multi segment variables. The path variables **must not** refer to any repeated or mapped field, because client libraries are not capable of handling such variable expansion. The path variables **must not** capture the leading \"/\" character. The reason is that the most common use case \"{var}\" does not capture the leading \"/\" character. For consistency, all path variables must share the same behavior. Repeated message fields must not be mapped to URL query parameters, because no client library can support such complicated mapping. If an API needs to use a JSON array for request or response body, it can map the request or response body to a repeated field. However, some gRPC Transcoding implementations may not support this feature.", "id": "HttpRule", "properties": { "additionalBindings": { diff --git a/googleapiclient/discovery_cache/documents/servicenetworking.v1.json b/googleapiclient/discovery_cache/documents/servicenetworking.v1.json index f58083171ed..aedbb9f8533 100644 --- a/googleapiclient/discovery_cache/documents/servicenetworking.v1.json +++ b/googleapiclient/discovery_cache/documents/servicenetworking.v1.json @@ -1029,7 +1029,7 @@ } } }, -"revision": "20240602", +"revision": "20240603", "rootUrl": "https://servicenetworking.googleapis.com/", "schemas": { "AddDnsRecordSetMetadata": { diff --git a/googleapiclient/discovery_cache/documents/servicenetworking.v1beta.json b/googleapiclient/discovery_cache/documents/servicenetworking.v1beta.json index 6ce3d85ce56..cce62151a42 100644 --- a/googleapiclient/discovery_cache/documents/servicenetworking.v1beta.json +++ b/googleapiclient/discovery_cache/documents/servicenetworking.v1beta.json @@ -307,7 +307,7 @@ } } }, -"revision": "20240602", +"revision": "20240603", "rootUrl": "https://servicenetworking.googleapis.com/", "schemas": { "AddDnsRecordSetMetadata": { diff --git a/googleapiclient/discovery_cache/documents/serviceusage.v1.json b/googleapiclient/discovery_cache/documents/serviceusage.v1.json index 11d0dff0756..cb872b456f2 100644 --- a/googleapiclient/discovery_cache/documents/serviceusage.v1.json +++ b/googleapiclient/discovery_cache/documents/serviceusage.v1.json @@ -426,7 +426,7 @@ } } }, -"revision": "20240520", +"revision": "20240603", "rootUrl": "https://serviceusage.googleapis.com/", "schemas": { "AddEnableRulesMetadata": { @@ -1971,7 +1971,7 @@ "type": "object" }, "HttpRule": { -"description": "# gRPC Transcoding gRPC Transcoding is a feature for mapping between a gRPC method and one or more HTTP REST endpoints. It allows developers to build a single API service that supports both gRPC APIs and REST APIs. Many systems, including [Google APIs](https://github.com/googleapis/googleapis), [Cloud Endpoints](https://cloud.google.com/endpoints), [gRPC Gateway](https://github.com/grpc-ecosystem/grpc-gateway), and [Envoy](https://github.com/envoyproxy/envoy) proxy support this feature and use it for large scale production services. `HttpRule` defines the schema of the gRPC/REST mapping. The mapping specifies how different portions of the gRPC request message are mapped to the URL path, URL query parameters, and HTTP request body. It also controls how the gRPC response message is mapped to the HTTP response body. `HttpRule` is typically specified as an `google.api.http` annotation on the gRPC method. Each mapping specifies a URL path template and an HTTP method. The path template may refer to one or more fields in the gRPC request message, as long as each field is a non-repeated field with a primitive (non-message) type. The path template controls how fields of the request message are mapped to the URL path. Example: service Messaging { rpc GetMessage(GetMessageRequest) returns (Message) { option (google.api.http) = { get: \"/v1/{name=messages/*}\" }; } } message GetMessageRequest { string name = 1; // Mapped to URL path. } message Message { string text = 1; // The resource content. } This enables an HTTP REST to gRPC mapping as below: HTTP | gRPC -----|----- `GET /v1/messages/123456` | `GetMessage(name: \"messages/123456\")` Any fields in the request message which are not bound by the path template automatically become HTTP query parameters if there is no HTTP request body. For example: service Messaging { rpc GetMessage(GetMessageRequest) returns (Message) { option (google.api.http) = { get:\"/v1/messages/{message_id}\" }; } } message GetMessageRequest { message SubMessage { string subfield = 1; } string message_id = 1; // Mapped to URL path. int64 revision = 2; // Mapped to URL query parameter `revision`. SubMessage sub = 3; // Mapped to URL query parameter `sub.subfield`. } This enables a HTTP JSON to RPC mapping as below: HTTP | gRPC -----|----- `GET /v1/messages/123456?revision=2&sub.subfield=foo` | `GetMessage(message_id: \"123456\" revision: 2 sub: SubMessage(subfield: \"foo\"))` Note that fields which are mapped to URL query parameters must have a primitive type or a repeated primitive type or a non-repeated message type. In the case of a repeated type, the parameter can be repeated in the URL as `...?param=A¶m=B`. In the case of a message type, each field of the message is mapped to a separate parameter, such as `...?foo.a=A&foo.b=B&foo.c=C`. For HTTP methods that allow a request body, the `body` field specifies the mapping. Consider a REST update method on the message resource collection: service Messaging { rpc UpdateMessage(UpdateMessageRequest) returns (Message) { option (google.api.http) = { patch: \"/v1/messages/{message_id}\" body: \"message\" }; } } message UpdateMessageRequest { string message_id = 1; // mapped to the URL Message message = 2; // mapped to the body } The following HTTP JSON to RPC mapping is enabled, where the representation of the JSON in the request body is determined by protos JSON encoding: HTTP | gRPC -----|----- `PATCH /v1/messages/123456 { \"text\": \"Hi!\" }` | `UpdateMessage(message_id: \"123456\" message { text: \"Hi!\" })` The special name `*` can be used in the body mapping to define that every field not bound by the path template should be mapped to the request body. This enables the following alternative definition of the update method: service Messaging { rpc UpdateMessage(Message) returns (Message) { option (google.api.http) = { patch: \"/v1/messages/{message_id}\" body: \"*\" }; } } message Message { string message_id = 1; string text = 2; } The following HTTP JSON to RPC mapping is enabled: HTTP | gRPC -----|----- `PATCH /v1/messages/123456 { \"text\": \"Hi!\" }` | `UpdateMessage(message_id: \"123456\" text: \"Hi!\")` Note that when using `*` in the body mapping, it is not possible to have HTTP parameters, as all fields not bound by the path end in the body. This makes this option more rarely used in practice when defining REST APIs. The common usage of `*` is in custom methods which don't use the URL at all for transferring data. It is possible to define multiple HTTP methods for one RPC by using the `additional_bindings` option. Example: service Messaging { rpc GetMessage(GetMessageRequest) returns (Message) { option (google.api.http) = { get: \"/v1/messages/{message_id}\" additional_bindings { get: \"/v1/users/{user_id}/messages/{message_id}\" } }; } } message GetMessageRequest { string message_id = 1; string user_id = 2; } This enables the following two alternative HTTP JSON to RPC mappings: HTTP | gRPC -----|----- `GET /v1/messages/123456` | `GetMessage(message_id: \"123456\")` `GET /v1/users/me/messages/123456` | `GetMessage(user_id: \"me\" message_id: \"123456\")` ## Rules for HTTP mapping 1. Leaf request fields (recursive expansion nested messages in the request message) are classified into three categories: - Fields referred by the path template. They are passed via the URL path. - Fields referred by the HttpRule.body. They are passed via the HTTP request body. - All other fields are passed via the URL query parameters, and the parameter name is the field path in the request message. A repeated field can be represented as multiple query parameters under the same name. 2. If HttpRule.body is \"*\", there is no URL query parameter, all fields are passed via URL path and HTTP request body. 3. If HttpRule.body is omitted, there is no HTTP request body, all fields are passed via URL path and URL query parameters. ### Path template syntax Template = \"/\" Segments [ Verb ] ; Segments = Segment { \"/\" Segment } ; Segment = \"*\" | \"**\" | LITERAL | Variable ; Variable = \"{\" FieldPath [ \"=\" Segments ] \"}\" ; FieldPath = IDENT { \".\" IDENT } ; Verb = \":\" LITERAL ; The syntax `*` matches a single URL path segment. The syntax `**` matches zero or more URL path segments, which must be the last part of the URL path except the `Verb`. The syntax `Variable` matches part of the URL path as specified by its template. A variable template must not contain other variables. If a variable matches a single path segment, its template may be omitted, e.g. `{var}` is equivalent to `{var=*}`. The syntax `LITERAL` matches literal text in the URL path. If the `LITERAL` contains any reserved character, such characters should be percent-encoded before the matching. If a variable contains exactly one path segment, such as `\"{var}\"` or `\"{var=*}\"`, when such a variable is expanded into a URL path on the client side, all characters except `[-_.~0-9a-zA-Z]` are percent-encoded. The server side does the reverse decoding. Such variables show up in the [Discovery Document](https://developers.google.com/discovery/v1/reference/apis) as `{var}`. If a variable contains multiple path segments, such as `\"{var=foo/*}\"` or `\"{var=**}\"`, when such a variable is expanded into a URL path on the client side, all characters except `[-_.~/0-9a-zA-Z]` are percent-encoded. The server side does the reverse decoding, except \"%2F\" and \"%2f\" are left unchanged. Such variables show up in the [Discovery Document](https://developers.google.com/discovery/v1/reference/apis) as `{+var}`. ## Using gRPC API Service Configuration gRPC API Service Configuration (service config) is a configuration language for configuring a gRPC service to become a user-facing product. The service config is simply the YAML representation of the `google.api.Service` proto message. As an alternative to annotating your proto file, you can configure gRPC transcoding in your service config YAML files. You do this by specifying a `HttpRule` that maps the gRPC method to a REST endpoint, achieving the same effect as the proto annotation. This can be particularly useful if you have a proto that is reused in multiple services. Note that any transcoding specified in the service config will override any matching transcoding configuration in the proto. Example: http: rules: # Selects a gRPC method and applies HttpRule to it. - selector: example.v1.Messaging.GetMessage get: /v1/messages/{message_id}/{sub.subfield} ## Special notes When gRPC Transcoding is used to map a gRPC to JSON REST endpoints, the proto to JSON conversion must follow the [proto3 specification](https://developers.google.com/protocol-buffers/docs/proto3#json). While the single segment variable follows the semantics of [RFC 6570](https://tools.ietf.org/html/rfc6570) Section 3.2.2 Simple String Expansion, the multi segment variable **does not** follow RFC 6570 Section 3.2.3 Reserved Expansion. The reason is that the Reserved Expansion does not expand special characters like `?` and `#`, which would lead to invalid URLs. As the result, gRPC Transcoding uses a custom encoding for multi segment variables. The path variables **must not** refer to any repeated or mapped field, because client libraries are not capable of handling such variable expansion. The path variables **must not** capture the leading \"/\" character. The reason is that the most common use case \"{var}\" does not capture the leading \"/\" character. For consistency, all path variables must share the same behavior. Repeated message fields must not be mapped to URL query parameters, because no client library can support such complicated mapping. If an API needs to use a JSON array for request or response body, it can map the request or response body to a repeated field. However, some gRPC Transcoding implementations may not support this feature.", +"description": "gRPC Transcoding gRPC Transcoding is a feature for mapping between a gRPC method and one or more HTTP REST endpoints. It allows developers to build a single API service that supports both gRPC APIs and REST APIs. Many systems, including [Google APIs](https://github.com/googleapis/googleapis), [Cloud Endpoints](https://cloud.google.com/endpoints), [gRPC Gateway](https://github.com/grpc-ecosystem/grpc-gateway), and [Envoy](https://github.com/envoyproxy/envoy) proxy support this feature and use it for large scale production services. `HttpRule` defines the schema of the gRPC/REST mapping. The mapping specifies how different portions of the gRPC request message are mapped to the URL path, URL query parameters, and HTTP request body. It also controls how the gRPC response message is mapped to the HTTP response body. `HttpRule` is typically specified as an `google.api.http` annotation on the gRPC method. Each mapping specifies a URL path template and an HTTP method. The path template may refer to one or more fields in the gRPC request message, as long as each field is a non-repeated field with a primitive (non-message) type. The path template controls how fields of the request message are mapped to the URL path. Example: service Messaging { rpc GetMessage(GetMessageRequest) returns (Message) { option (google.api.http) = { get: \"/v1/{name=messages/*}\" }; } } message GetMessageRequest { string name = 1; // Mapped to URL path. } message Message { string text = 1; // The resource content. } This enables an HTTP REST to gRPC mapping as below: - HTTP: `GET /v1/messages/123456` - gRPC: `GetMessage(name: \"messages/123456\")` Any fields in the request message which are not bound by the path template automatically become HTTP query parameters if there is no HTTP request body. For example: service Messaging { rpc GetMessage(GetMessageRequest) returns (Message) { option (google.api.http) = { get:\"/v1/messages/{message_id}\" }; } } message GetMessageRequest { message SubMessage { string subfield = 1; } string message_id = 1; // Mapped to URL path. int64 revision = 2; // Mapped to URL query parameter `revision`. SubMessage sub = 3; // Mapped to URL query parameter `sub.subfield`. } This enables a HTTP JSON to RPC mapping as below: - HTTP: `GET /v1/messages/123456?revision=2&sub.subfield=foo` - gRPC: `GetMessage(message_id: \"123456\" revision: 2 sub: SubMessage(subfield: \"foo\"))` Note that fields which are mapped to URL query parameters must have a primitive type or a repeated primitive type or a non-repeated message type. In the case of a repeated type, the parameter can be repeated in the URL as `...?param=A¶m=B`. In the case of a message type, each field of the message is mapped to a separate parameter, such as `...?foo.a=A&foo.b=B&foo.c=C`. For HTTP methods that allow a request body, the `body` field specifies the mapping. Consider a REST update method on the message resource collection: service Messaging { rpc UpdateMessage(UpdateMessageRequest) returns (Message) { option (google.api.http) = { patch: \"/v1/messages/{message_id}\" body: \"message\" }; } } message UpdateMessageRequest { string message_id = 1; // mapped to the URL Message message = 2; // mapped to the body } The following HTTP JSON to RPC mapping is enabled, where the representation of the JSON in the request body is determined by protos JSON encoding: - HTTP: `PATCH /v1/messages/123456 { \"text\": \"Hi!\" }` - gRPC: `UpdateMessage(message_id: \"123456\" message { text: \"Hi!\" })` The special name `*` can be used in the body mapping to define that every field not bound by the path template should be mapped to the request body. This enables the following alternative definition of the update method: service Messaging { rpc UpdateMessage(Message) returns (Message) { option (google.api.http) = { patch: \"/v1/messages/{message_id}\" body: \"*\" }; } } message Message { string message_id = 1; string text = 2; } The following HTTP JSON to RPC mapping is enabled: - HTTP: `PATCH /v1/messages/123456 { \"text\": \"Hi!\" }` - gRPC: `UpdateMessage(message_id: \"123456\" text: \"Hi!\")` Note that when using `*` in the body mapping, it is not possible to have HTTP parameters, as all fields not bound by the path end in the body. This makes this option more rarely used in practice when defining REST APIs. The common usage of `*` is in custom methods which don't use the URL at all for transferring data. It is possible to define multiple HTTP methods for one RPC by using the `additional_bindings` option. Example: service Messaging { rpc GetMessage(GetMessageRequest) returns (Message) { option (google.api.http) = { get: \"/v1/messages/{message_id}\" additional_bindings { get: \"/v1/users/{user_id}/messages/{message_id}\" } }; } } message GetMessageRequest { string message_id = 1; string user_id = 2; } This enables the following two alternative HTTP JSON to RPC mappings: - HTTP: `GET /v1/messages/123456` - gRPC: `GetMessage(message_id: \"123456\")` - HTTP: `GET /v1/users/me/messages/123456` - gRPC: `GetMessage(user_id: \"me\" message_id: \"123456\")` Rules for HTTP mapping 1. Leaf request fields (recursive expansion nested messages in the request message) are classified into three categories: - Fields referred by the path template. They are passed via the URL path. - Fields referred by the HttpRule.body. They are passed via the HTTP request body. - All other fields are passed via the URL query parameters, and the parameter name is the field path in the request message. A repeated field can be represented as multiple query parameters under the same name. 2. If HttpRule.body is \"*\", there is no URL query parameter, all fields are passed via URL path and HTTP request body. 3. If HttpRule.body is omitted, there is no HTTP request body, all fields are passed via URL path and URL query parameters. Path template syntax Template = \"/\" Segments [ Verb ] ; Segments = Segment { \"/\" Segment } ; Segment = \"*\" | \"**\" | LITERAL | Variable ; Variable = \"{\" FieldPath [ \"=\" Segments ] \"}\" ; FieldPath = IDENT { \".\" IDENT } ; Verb = \":\" LITERAL ; The syntax `*` matches a single URL path segment. The syntax `**` matches zero or more URL path segments, which must be the last part of the URL path except the `Verb`. The syntax `Variable` matches part of the URL path as specified by its template. A variable template must not contain other variables. If a variable matches a single path segment, its template may be omitted, e.g. `{var}` is equivalent to `{var=*}`. The syntax `LITERAL` matches literal text in the URL path. If the `LITERAL` contains any reserved character, such characters should be percent-encoded before the matching. If a variable contains exactly one path segment, such as `\"{var}\"` or `\"{var=*}\"`, when such a variable is expanded into a URL path on the client side, all characters except `[-_.~0-9a-zA-Z]` are percent-encoded. The server side does the reverse decoding. Such variables show up in the [Discovery Document](https://developers.google.com/discovery/v1/reference/apis) as `{var}`. If a variable contains multiple path segments, such as `\"{var=foo/*}\"` or `\"{var=**}\"`, when such a variable is expanded into a URL path on the client side, all characters except `[-_.~/0-9a-zA-Z]` are percent-encoded. The server side does the reverse decoding, except \"%2F\" and \"%2f\" are left unchanged. Such variables show up in the [Discovery Document](https://developers.google.com/discovery/v1/reference/apis) as `{+var}`. Using gRPC API Service Configuration gRPC API Service Configuration (service config) is a configuration language for configuring a gRPC service to become a user-facing product. The service config is simply the YAML representation of the `google.api.Service` proto message. As an alternative to annotating your proto file, you can configure gRPC transcoding in your service config YAML files. You do this by specifying a `HttpRule` that maps the gRPC method to a REST endpoint, achieving the same effect as the proto annotation. This can be particularly useful if you have a proto that is reused in multiple services. Note that any transcoding specified in the service config will override any matching transcoding configuration in the proto. Example below selects a gRPC method and applies HttpRule to it. http: rules: - selector: example.v1.Messaging.GetMessage get: /v1/messages/{message_id}/{sub.subfield} Special notes When gRPC Transcoding is used to map a gRPC to JSON REST endpoints, the proto to JSON conversion must follow the [proto3 specification](https://developers.google.com/protocol-buffers/docs/proto3#json). While the single segment variable follows the semantics of [RFC 6570](https://tools.ietf.org/html/rfc6570) Section 3.2.2 Simple String Expansion, the multi segment variable **does not** follow RFC 6570 Section 3.2.3 Reserved Expansion. The reason is that the Reserved Expansion does not expand special characters like `?` and `#`, which would lead to invalid URLs. As the result, gRPC Transcoding uses a custom encoding for multi segment variables. The path variables **must not** refer to any repeated or mapped field, because client libraries are not capable of handling such variable expansion. The path variables **must not** capture the leading \"/\" character. The reason is that the most common use case \"{var}\" does not capture the leading \"/\" character. For consistency, all path variables must share the same behavior. Repeated message fields must not be mapped to URL query parameters, because no client library can support such complicated mapping. If an API needs to use a JSON array for request or response body, it can map the request or response body to a repeated field. However, some gRPC Transcoding implementations may not support this feature.", "id": "HttpRule", "properties": { "additionalBindings": { diff --git a/googleapiclient/discovery_cache/documents/serviceusage.v1beta1.json b/googleapiclient/discovery_cache/documents/serviceusage.v1beta1.json index 39a2d3fb307..2eb099b0d4d 100644 --- a/googleapiclient/discovery_cache/documents/serviceusage.v1beta1.json +++ b/googleapiclient/discovery_cache/documents/serviceusage.v1beta1.json @@ -964,7 +964,7 @@ } } }, -"revision": "20240520", +"revision": "20240603", "rootUrl": "https://serviceusage.googleapis.com/", "schemas": { "AddEnableRulesMetadata": { @@ -2548,7 +2548,7 @@ "type": "object" }, "HttpRule": { -"description": "# gRPC Transcoding gRPC Transcoding is a feature for mapping between a gRPC method and one or more HTTP REST endpoints. It allows developers to build a single API service that supports both gRPC APIs and REST APIs. Many systems, including [Google APIs](https://github.com/googleapis/googleapis), [Cloud Endpoints](https://cloud.google.com/endpoints), [gRPC Gateway](https://github.com/grpc-ecosystem/grpc-gateway), and [Envoy](https://github.com/envoyproxy/envoy) proxy support this feature and use it for large scale production services. `HttpRule` defines the schema of the gRPC/REST mapping. The mapping specifies how different portions of the gRPC request message are mapped to the URL path, URL query parameters, and HTTP request body. It also controls how the gRPC response message is mapped to the HTTP response body. `HttpRule` is typically specified as an `google.api.http` annotation on the gRPC method. Each mapping specifies a URL path template and an HTTP method. The path template may refer to one or more fields in the gRPC request message, as long as each field is a non-repeated field with a primitive (non-message) type. The path template controls how fields of the request message are mapped to the URL path. Example: service Messaging { rpc GetMessage(GetMessageRequest) returns (Message) { option (google.api.http) = { get: \"/v1/{name=messages/*}\" }; } } message GetMessageRequest { string name = 1; // Mapped to URL path. } message Message { string text = 1; // The resource content. } This enables an HTTP REST to gRPC mapping as below: HTTP | gRPC -----|----- `GET /v1/messages/123456` | `GetMessage(name: \"messages/123456\")` Any fields in the request message which are not bound by the path template automatically become HTTP query parameters if there is no HTTP request body. For example: service Messaging { rpc GetMessage(GetMessageRequest) returns (Message) { option (google.api.http) = { get:\"/v1/messages/{message_id}\" }; } } message GetMessageRequest { message SubMessage { string subfield = 1; } string message_id = 1; // Mapped to URL path. int64 revision = 2; // Mapped to URL query parameter `revision`. SubMessage sub = 3; // Mapped to URL query parameter `sub.subfield`. } This enables a HTTP JSON to RPC mapping as below: HTTP | gRPC -----|----- `GET /v1/messages/123456?revision=2&sub.subfield=foo` | `GetMessage(message_id: \"123456\" revision: 2 sub: SubMessage(subfield: \"foo\"))` Note that fields which are mapped to URL query parameters must have a primitive type or a repeated primitive type or a non-repeated message type. In the case of a repeated type, the parameter can be repeated in the URL as `...?param=A¶m=B`. In the case of a message type, each field of the message is mapped to a separate parameter, such as `...?foo.a=A&foo.b=B&foo.c=C`. For HTTP methods that allow a request body, the `body` field specifies the mapping. Consider a REST update method on the message resource collection: service Messaging { rpc UpdateMessage(UpdateMessageRequest) returns (Message) { option (google.api.http) = { patch: \"/v1/messages/{message_id}\" body: \"message\" }; } } message UpdateMessageRequest { string message_id = 1; // mapped to the URL Message message = 2; // mapped to the body } The following HTTP JSON to RPC mapping is enabled, where the representation of the JSON in the request body is determined by protos JSON encoding: HTTP | gRPC -----|----- `PATCH /v1/messages/123456 { \"text\": \"Hi!\" }` | `UpdateMessage(message_id: \"123456\" message { text: \"Hi!\" })` The special name `*` can be used in the body mapping to define that every field not bound by the path template should be mapped to the request body. This enables the following alternative definition of the update method: service Messaging { rpc UpdateMessage(Message) returns (Message) { option (google.api.http) = { patch: \"/v1/messages/{message_id}\" body: \"*\" }; } } message Message { string message_id = 1; string text = 2; } The following HTTP JSON to RPC mapping is enabled: HTTP | gRPC -----|----- `PATCH /v1/messages/123456 { \"text\": \"Hi!\" }` | `UpdateMessage(message_id: \"123456\" text: \"Hi!\")` Note that when using `*` in the body mapping, it is not possible to have HTTP parameters, as all fields not bound by the path end in the body. This makes this option more rarely used in practice when defining REST APIs. The common usage of `*` is in custom methods which don't use the URL at all for transferring data. It is possible to define multiple HTTP methods for one RPC by using the `additional_bindings` option. Example: service Messaging { rpc GetMessage(GetMessageRequest) returns (Message) { option (google.api.http) = { get: \"/v1/messages/{message_id}\" additional_bindings { get: \"/v1/users/{user_id}/messages/{message_id}\" } }; } } message GetMessageRequest { string message_id = 1; string user_id = 2; } This enables the following two alternative HTTP JSON to RPC mappings: HTTP | gRPC -----|----- `GET /v1/messages/123456` | `GetMessage(message_id: \"123456\")` `GET /v1/users/me/messages/123456` | `GetMessage(user_id: \"me\" message_id: \"123456\")` ## Rules for HTTP mapping 1. Leaf request fields (recursive expansion nested messages in the request message) are classified into three categories: - Fields referred by the path template. They are passed via the URL path. - Fields referred by the HttpRule.body. They are passed via the HTTP request body. - All other fields are passed via the URL query parameters, and the parameter name is the field path in the request message. A repeated field can be represented as multiple query parameters under the same name. 2. If HttpRule.body is \"*\", there is no URL query parameter, all fields are passed via URL path and HTTP request body. 3. If HttpRule.body is omitted, there is no HTTP request body, all fields are passed via URL path and URL query parameters. ### Path template syntax Template = \"/\" Segments [ Verb ] ; Segments = Segment { \"/\" Segment } ; Segment = \"*\" | \"**\" | LITERAL | Variable ; Variable = \"{\" FieldPath [ \"=\" Segments ] \"}\" ; FieldPath = IDENT { \".\" IDENT } ; Verb = \":\" LITERAL ; The syntax `*` matches a single URL path segment. The syntax `**` matches zero or more URL path segments, which must be the last part of the URL path except the `Verb`. The syntax `Variable` matches part of the URL path as specified by its template. A variable template must not contain other variables. If a variable matches a single path segment, its template may be omitted, e.g. `{var}` is equivalent to `{var=*}`. The syntax `LITERAL` matches literal text in the URL path. If the `LITERAL` contains any reserved character, such characters should be percent-encoded before the matching. If a variable contains exactly one path segment, such as `\"{var}\"` or `\"{var=*}\"`, when such a variable is expanded into a URL path on the client side, all characters except `[-_.~0-9a-zA-Z]` are percent-encoded. The server side does the reverse decoding. Such variables show up in the [Discovery Document](https://developers.google.com/discovery/v1/reference/apis) as `{var}`. If a variable contains multiple path segments, such as `\"{var=foo/*}\"` or `\"{var=**}\"`, when such a variable is expanded into a URL path on the client side, all characters except `[-_.~/0-9a-zA-Z]` are percent-encoded. The server side does the reverse decoding, except \"%2F\" and \"%2f\" are left unchanged. Such variables show up in the [Discovery Document](https://developers.google.com/discovery/v1/reference/apis) as `{+var}`. ## Using gRPC API Service Configuration gRPC API Service Configuration (service config) is a configuration language for configuring a gRPC service to become a user-facing product. The service config is simply the YAML representation of the `google.api.Service` proto message. As an alternative to annotating your proto file, you can configure gRPC transcoding in your service config YAML files. You do this by specifying a `HttpRule` that maps the gRPC method to a REST endpoint, achieving the same effect as the proto annotation. This can be particularly useful if you have a proto that is reused in multiple services. Note that any transcoding specified in the service config will override any matching transcoding configuration in the proto. Example: http: rules: # Selects a gRPC method and applies HttpRule to it. - selector: example.v1.Messaging.GetMessage get: /v1/messages/{message_id}/{sub.subfield} ## Special notes When gRPC Transcoding is used to map a gRPC to JSON REST endpoints, the proto to JSON conversion must follow the [proto3 specification](https://developers.google.com/protocol-buffers/docs/proto3#json). While the single segment variable follows the semantics of [RFC 6570](https://tools.ietf.org/html/rfc6570) Section 3.2.2 Simple String Expansion, the multi segment variable **does not** follow RFC 6570 Section 3.2.3 Reserved Expansion. The reason is that the Reserved Expansion does not expand special characters like `?` and `#`, which would lead to invalid URLs. As the result, gRPC Transcoding uses a custom encoding for multi segment variables. The path variables **must not** refer to any repeated or mapped field, because client libraries are not capable of handling such variable expansion. The path variables **must not** capture the leading \"/\" character. The reason is that the most common use case \"{var}\" does not capture the leading \"/\" character. For consistency, all path variables must share the same behavior. Repeated message fields must not be mapped to URL query parameters, because no client library can support such complicated mapping. If an API needs to use a JSON array for request or response body, it can map the request or response body to a repeated field. However, some gRPC Transcoding implementations may not support this feature.", +"description": "gRPC Transcoding gRPC Transcoding is a feature for mapping between a gRPC method and one or more HTTP REST endpoints. It allows developers to build a single API service that supports both gRPC APIs and REST APIs. Many systems, including [Google APIs](https://github.com/googleapis/googleapis), [Cloud Endpoints](https://cloud.google.com/endpoints), [gRPC Gateway](https://github.com/grpc-ecosystem/grpc-gateway), and [Envoy](https://github.com/envoyproxy/envoy) proxy support this feature and use it for large scale production services. `HttpRule` defines the schema of the gRPC/REST mapping. The mapping specifies how different portions of the gRPC request message are mapped to the URL path, URL query parameters, and HTTP request body. It also controls how the gRPC response message is mapped to the HTTP response body. `HttpRule` is typically specified as an `google.api.http` annotation on the gRPC method. Each mapping specifies a URL path template and an HTTP method. The path template may refer to one or more fields in the gRPC request message, as long as each field is a non-repeated field with a primitive (non-message) type. The path template controls how fields of the request message are mapped to the URL path. Example: service Messaging { rpc GetMessage(GetMessageRequest) returns (Message) { option (google.api.http) = { get: \"/v1/{name=messages/*}\" }; } } message GetMessageRequest { string name = 1; // Mapped to URL path. } message Message { string text = 1; // The resource content. } This enables an HTTP REST to gRPC mapping as below: - HTTP: `GET /v1/messages/123456` - gRPC: `GetMessage(name: \"messages/123456\")` Any fields in the request message which are not bound by the path template automatically become HTTP query parameters if there is no HTTP request body. For example: service Messaging { rpc GetMessage(GetMessageRequest) returns (Message) { option (google.api.http) = { get:\"/v1/messages/{message_id}\" }; } } message GetMessageRequest { message SubMessage { string subfield = 1; } string message_id = 1; // Mapped to URL path. int64 revision = 2; // Mapped to URL query parameter `revision`. SubMessage sub = 3; // Mapped to URL query parameter `sub.subfield`. } This enables a HTTP JSON to RPC mapping as below: - HTTP: `GET /v1/messages/123456?revision=2&sub.subfield=foo` - gRPC: `GetMessage(message_id: \"123456\" revision: 2 sub: SubMessage(subfield: \"foo\"))` Note that fields which are mapped to URL query parameters must have a primitive type or a repeated primitive type or a non-repeated message type. In the case of a repeated type, the parameter can be repeated in the URL as `...?param=A¶m=B`. In the case of a message type, each field of the message is mapped to a separate parameter, such as `...?foo.a=A&foo.b=B&foo.c=C`. For HTTP methods that allow a request body, the `body` field specifies the mapping. Consider a REST update method on the message resource collection: service Messaging { rpc UpdateMessage(UpdateMessageRequest) returns (Message) { option (google.api.http) = { patch: \"/v1/messages/{message_id}\" body: \"message\" }; } } message UpdateMessageRequest { string message_id = 1; // mapped to the URL Message message = 2; // mapped to the body } The following HTTP JSON to RPC mapping is enabled, where the representation of the JSON in the request body is determined by protos JSON encoding: - HTTP: `PATCH /v1/messages/123456 { \"text\": \"Hi!\" }` - gRPC: `UpdateMessage(message_id: \"123456\" message { text: \"Hi!\" })` The special name `*` can be used in the body mapping to define that every field not bound by the path template should be mapped to the request body. This enables the following alternative definition of the update method: service Messaging { rpc UpdateMessage(Message) returns (Message) { option (google.api.http) = { patch: \"/v1/messages/{message_id}\" body: \"*\" }; } } message Message { string message_id = 1; string text = 2; } The following HTTP JSON to RPC mapping is enabled: - HTTP: `PATCH /v1/messages/123456 { \"text\": \"Hi!\" }` - gRPC: `UpdateMessage(message_id: \"123456\" text: \"Hi!\")` Note that when using `*` in the body mapping, it is not possible to have HTTP parameters, as all fields not bound by the path end in the body. This makes this option more rarely used in practice when defining REST APIs. The common usage of `*` is in custom methods which don't use the URL at all for transferring data. It is possible to define multiple HTTP methods for one RPC by using the `additional_bindings` option. Example: service Messaging { rpc GetMessage(GetMessageRequest) returns (Message) { option (google.api.http) = { get: \"/v1/messages/{message_id}\" additional_bindings { get: \"/v1/users/{user_id}/messages/{message_id}\" } }; } } message GetMessageRequest { string message_id = 1; string user_id = 2; } This enables the following two alternative HTTP JSON to RPC mappings: - HTTP: `GET /v1/messages/123456` - gRPC: `GetMessage(message_id: \"123456\")` - HTTP: `GET /v1/users/me/messages/123456` - gRPC: `GetMessage(user_id: \"me\" message_id: \"123456\")` Rules for HTTP mapping 1. Leaf request fields (recursive expansion nested messages in the request message) are classified into three categories: - Fields referred by the path template. They are passed via the URL path. - Fields referred by the HttpRule.body. They are passed via the HTTP request body. - All other fields are passed via the URL query parameters, and the parameter name is the field path in the request message. A repeated field can be represented as multiple query parameters under the same name. 2. If HttpRule.body is \"*\", there is no URL query parameter, all fields are passed via URL path and HTTP request body. 3. If HttpRule.body is omitted, there is no HTTP request body, all fields are passed via URL path and URL query parameters. Path template syntax Template = \"/\" Segments [ Verb ] ; Segments = Segment { \"/\" Segment } ; Segment = \"*\" | \"**\" | LITERAL | Variable ; Variable = \"{\" FieldPath [ \"=\" Segments ] \"}\" ; FieldPath = IDENT { \".\" IDENT } ; Verb = \":\" LITERAL ; The syntax `*` matches a single URL path segment. The syntax `**` matches zero or more URL path segments, which must be the last part of the URL path except the `Verb`. The syntax `Variable` matches part of the URL path as specified by its template. A variable template must not contain other variables. If a variable matches a single path segment, its template may be omitted, e.g. `{var}` is equivalent to `{var=*}`. The syntax `LITERAL` matches literal text in the URL path. If the `LITERAL` contains any reserved character, such characters should be percent-encoded before the matching. If a variable contains exactly one path segment, such as `\"{var}\"` or `\"{var=*}\"`, when such a variable is expanded into a URL path on the client side, all characters except `[-_.~0-9a-zA-Z]` are percent-encoded. The server side does the reverse decoding. Such variables show up in the [Discovery Document](https://developers.google.com/discovery/v1/reference/apis) as `{var}`. If a variable contains multiple path segments, such as `\"{var=foo/*}\"` or `\"{var=**}\"`, when such a variable is expanded into a URL path on the client side, all characters except `[-_.~/0-9a-zA-Z]` are percent-encoded. The server side does the reverse decoding, except \"%2F\" and \"%2f\" are left unchanged. Such variables show up in the [Discovery Document](https://developers.google.com/discovery/v1/reference/apis) as `{+var}`. Using gRPC API Service Configuration gRPC API Service Configuration (service config) is a configuration language for configuring a gRPC service to become a user-facing product. The service config is simply the YAML representation of the `google.api.Service` proto message. As an alternative to annotating your proto file, you can configure gRPC transcoding in your service config YAML files. You do this by specifying a `HttpRule` that maps the gRPC method to a REST endpoint, achieving the same effect as the proto annotation. This can be particularly useful if you have a proto that is reused in multiple services. Note that any transcoding specified in the service config will override any matching transcoding configuration in the proto. Example below selects a gRPC method and applies HttpRule to it. http: rules: - selector: example.v1.Messaging.GetMessage get: /v1/messages/{message_id}/{sub.subfield} Special notes When gRPC Transcoding is used to map a gRPC to JSON REST endpoints, the proto to JSON conversion must follow the [proto3 specification](https://developers.google.com/protocol-buffers/docs/proto3#json). While the single segment variable follows the semantics of [RFC 6570](https://tools.ietf.org/html/rfc6570) Section 3.2.2 Simple String Expansion, the multi segment variable **does not** follow RFC 6570 Section 3.2.3 Reserved Expansion. The reason is that the Reserved Expansion does not expand special characters like `?` and `#`, which would lead to invalid URLs. As the result, gRPC Transcoding uses a custom encoding for multi segment variables. The path variables **must not** refer to any repeated or mapped field, because client libraries are not capable of handling such variable expansion. The path variables **must not** capture the leading \"/\" character. The reason is that the most common use case \"{var}\" does not capture the leading \"/\" character. For consistency, all path variables must share the same behavior. Repeated message fields must not be mapped to URL query parameters, because no client library can support such complicated mapping. If an API needs to use a JSON array for request or response body, it can map the request or response body to a repeated field. However, some gRPC Transcoding implementations may not support this feature.", "id": "HttpRule", "properties": { "additionalBindings": { diff --git a/googleapiclient/discovery_cache/documents/sheets.v4.json b/googleapiclient/discovery_cache/documents/sheets.v4.json index b15f998a31b..af9a3e9e4bf 100644 --- a/googleapiclient/discovery_cache/documents/sheets.v4.json +++ b/googleapiclient/discovery_cache/documents/sheets.v4.json @@ -870,7 +870,7 @@ } } }, -"revision": "20240528", +"revision": "20240604", "rootUrl": "https://sheets.googleapis.com/", "schemas": { "AddBandingRequest": { diff --git a/googleapiclient/discovery_cache/documents/slides.v1.json b/googleapiclient/discovery_cache/documents/slides.v1.json index 4d184f07924..27d828d6388 100644 --- a/googleapiclient/discovery_cache/documents/slides.v1.json +++ b/googleapiclient/discovery_cache/documents/slides.v1.json @@ -313,7 +313,7 @@ } } }, -"revision": "20240528", +"revision": "20240604", "rootUrl": "https://slides.googleapis.com/", "schemas": { "AffineTransform": { diff --git a/googleapiclient/discovery_cache/documents/smartdevicemanagement.v1.json b/googleapiclient/discovery_cache/documents/smartdevicemanagement.v1.json index 0033454ec82..bb20e60df6e 100644 --- a/googleapiclient/discovery_cache/documents/smartdevicemanagement.v1.json +++ b/googleapiclient/discovery_cache/documents/smartdevicemanagement.v1.json @@ -312,7 +312,7 @@ } } }, -"revision": "20240503", +"revision": "20240527", "rootUrl": "https://smartdevicemanagement.googleapis.com/", "schemas": { "GoogleHomeEnterpriseSdmV1Device": { diff --git a/googleapiclient/discovery_cache/documents/solar.v1.json b/googleapiclient/discovery_cache/documents/solar.v1.json index b42c2f5f92c..7b3a551c345 100644 --- a/googleapiclient/discovery_cache/documents/solar.v1.json +++ b/googleapiclient/discovery_cache/documents/solar.v1.json @@ -267,7 +267,7 @@ } } }, -"revision": "20240602", +"revision": "20240609", "rootUrl": "https://solar.googleapis.com/", "schemas": { "BuildingInsights": { diff --git a/googleapiclient/discovery_cache/documents/sourcerepo.v1.json b/googleapiclient/discovery_cache/documents/sourcerepo.v1.json index 98fc463027d..a1f00142d99 100644 --- a/googleapiclient/discovery_cache/documents/sourcerepo.v1.json +++ b/googleapiclient/discovery_cache/documents/sourcerepo.v1.json @@ -450,7 +450,7 @@ } } }, -"revision": "20240520", +"revision": "20240602", "rootUrl": "https://sourcerepo.googleapis.com/", "schemas": { "AuditConfig": { diff --git a/googleapiclient/discovery_cache/documents/spanner.v1.json b/googleapiclient/discovery_cache/documents/spanner.v1.json index 412c3e6d30d..779ada5c2db 100644 --- a/googleapiclient/discovery_cache/documents/spanner.v1.json +++ b/googleapiclient/discovery_cache/documents/spanner.v1.json @@ -3005,7 +3005,7 @@ } } }, -"revision": "20240529", +"revision": "20240607", "rootUrl": "https://spanner.googleapis.com/", "schemas": { "AutoscalingConfig": { diff --git a/googleapiclient/discovery_cache/documents/speech.v1.json b/googleapiclient/discovery_cache/documents/speech.v1.json index b8176b0f326..5164a1d66bc 100644 --- a/googleapiclient/discovery_cache/documents/speech.v1.json +++ b/googleapiclient/discovery_cache/documents/speech.v1.json @@ -524,7 +524,7 @@ } } }, -"revision": "20240523", +"revision": "20240605", "rootUrl": "https://speech.googleapis.com/", "schemas": { "ABNFGrammar": { diff --git a/googleapiclient/discovery_cache/documents/speech.v1p1beta1.json b/googleapiclient/discovery_cache/documents/speech.v1p1beta1.json index 702490cb621..97c5a3d183d 100644 --- a/googleapiclient/discovery_cache/documents/speech.v1p1beta1.json +++ b/googleapiclient/discovery_cache/documents/speech.v1p1beta1.json @@ -524,7 +524,7 @@ } } }, -"revision": "20240523", +"revision": "20240605", "rootUrl": "https://speech.googleapis.com/", "schemas": { "ABNFGrammar": { diff --git a/googleapiclient/discovery_cache/documents/sqladmin.v1.json b/googleapiclient/discovery_cache/documents/sqladmin.v1.json index 8086ec8b4a5..4de46b9b8bf 100644 --- a/googleapiclient/discovery_cache/documents/sqladmin.v1.json +++ b/googleapiclient/discovery_cache/documents/sqladmin.v1.json @@ -2267,7 +2267,7 @@ } } }, -"revision": "20240529", +"revision": "20240607", "rootUrl": "https://sqladmin.googleapis.com/", "schemas": { "AclEntry": { @@ -5376,6 +5376,10 @@ true ], "type": "string" }, +"enableDataplexIntegration": { +"description": "Optional. By default, Cloud SQL instances have schema extraction disabled for Dataplex. When this parameter is set to true, schema extraction for Dataplex on Cloud SQL instances is activated.", +"type": "boolean" +}, "enableGoogleMlIntegration": { "description": "Optional. When this parameter is set to true, Cloud SQL instances can connect to Vertex AI to pass requests for real-time predictions and insights to the AI. The default value is false. This applies only to Cloud SQL for PostgreSQL instances.", "type": "boolean" @@ -5546,7 +5550,8 @@ true "INSUFFICIENT_MACHINE_TIER", "UNSUPPORTED_EXTENSIONS_NOT_MIGRATED", "EXTENSIONS_NOT_MIGRATED", -"PG_CRON_FLAG_ENABLED_IN_REPLICA" +"PG_CRON_FLAG_ENABLED_IN_REPLICA", +"EXTENSIONS_NOT_ENABLED_IN_REPLICA" ], "enumDescriptions": [ "", @@ -5596,7 +5601,8 @@ true "The data size of the source instance is greater than 1 TB, the number of cores of the replica instance is less than 8, and the memory of the replica is less than 32 GB.", "The warning message indicates the unsupported extensions will not be migrated to the destination.", "The warning message indicates the pg_cron extension and settings will not be migrated to the destination.", -"The error message indicates that pg_cron flags are enabled on the destination which is not supported during the migration." +"The error message indicates that pg_cron flags are enabled on the destination which is not supported during the migration.", +"This error message indicates that the specified extensions are not enabled on destination instance. For example, before you can migrate data to the destination instance, you must enable the PGAudit extension on the instance." ], "type": "string" } diff --git a/googleapiclient/discovery_cache/documents/sqladmin.v1beta4.json b/googleapiclient/discovery_cache/documents/sqladmin.v1beta4.json index 4fb18648910..29b55329c14 100644 --- a/googleapiclient/discovery_cache/documents/sqladmin.v1beta4.json +++ b/googleapiclient/discovery_cache/documents/sqladmin.v1beta4.json @@ -2267,7 +2267,7 @@ } } }, -"revision": "20240529", +"revision": "20240607", "rootUrl": "https://sqladmin.googleapis.com/", "schemas": { "AclEntry": { @@ -5381,6 +5381,10 @@ true ], "type": "string" }, +"enableDataplexIntegration": { +"description": "Optional. By default, Cloud SQL instances have schema extraction disabled for Dataplex. When this parameter is set to true, schema extraction for Dataplex on Cloud SQL instances is activated.", +"type": "boolean" +}, "enableGoogleMlIntegration": { "description": "Optional. When this parameter is set to true, Cloud SQL instances can connect to Vertex AI to pass requests for real-time predictions and insights to the AI. The default value is false. This applies only to Cloud SQL for PostgreSQL instances.", "type": "boolean" @@ -5551,7 +5555,8 @@ true "INSUFFICIENT_MACHINE_TIER", "UNSUPPORTED_EXTENSIONS_NOT_MIGRATED", "EXTENSIONS_NOT_MIGRATED", -"PG_CRON_FLAG_ENABLED_IN_REPLICA" +"PG_CRON_FLAG_ENABLED_IN_REPLICA", +"EXTENSIONS_NOT_ENABLED_IN_REPLICA" ], "enumDescriptions": [ "", @@ -5601,7 +5606,8 @@ true "The data size of the source instance is greater than 1 TB, the number of cores of the replica instance is less than 8, and the memory of the replica is less than 32 GB.", "The warning message indicates the unsupported extensions will not be migrated to the destination.", "The warning message indicates the pg_cron extension and settings will not be migrated to the destination.", -"The error message indicates that pg_cron flags are enabled on the destination which is not supported during the migration." +"The error message indicates that pg_cron flags are enabled on the destination which is not supported during the migration.", +"This error message indicates that the specified extensions are not enabled on destination instance. For example, before you can migrate data to the destination instance, you must enable the PGAudit extension on the instance." ], "type": "string" } diff --git a/googleapiclient/discovery_cache/documents/storage.v1.json b/googleapiclient/discovery_cache/documents/storage.v1.json index d4e63518d20..df15e2329aa 100644 --- a/googleapiclient/discovery_cache/documents/storage.v1.json +++ b/googleapiclient/discovery_cache/documents/storage.v1.json @@ -33,7 +33,7 @@ "location": "me-central2" } ], -"etag": "\"3131333631343030313731353833323230393337\"", +"etag": "\"37303234393035393631323836383536303834\"", "icons": { "x16": "https://www.google.com/images/icons/product/cloud_storage-16.png", "x32": "https://www.google.com/images/icons/product/cloud_storage-32.png" @@ -4075,7 +4075,7 @@ } } }, -"revision": "20240528", +"revision": "20240605", "rootUrl": "https://storage.googleapis.com/", "schemas": { "AnywhereCache": { diff --git a/googleapiclient/discovery_cache/documents/storagetransfer.v1.json b/googleapiclient/discovery_cache/documents/storagetransfer.v1.json index 8b55d09ab43..1259e9b5fc6 100644 --- a/googleapiclient/discovery_cache/documents/storagetransfer.v1.json +++ b/googleapiclient/discovery_cache/documents/storagetransfer.v1.json @@ -632,7 +632,7 @@ } } }, -"revision": "20240525", +"revision": "20240531", "rootUrl": "https://storagetransfer.googleapis.com/", "schemas": { "AgentPool": { diff --git a/googleapiclient/discovery_cache/documents/streetviewpublish.v1.json b/googleapiclient/discovery_cache/documents/streetviewpublish.v1.json index 4566fc78880..598c5964fe5 100644 --- a/googleapiclient/discovery_cache/documents/streetviewpublish.v1.json +++ b/googleapiclient/discovery_cache/documents/streetviewpublish.v1.json @@ -534,7 +534,7 @@ } } }, -"revision": "20240602", +"revision": "20240609", "rootUrl": "https://streetviewpublish.googleapis.com/", "schemas": { "BatchDeletePhotosRequest": { diff --git a/googleapiclient/discovery_cache/documents/sts.v1.json b/googleapiclient/discovery_cache/documents/sts.v1.json index 8db4011d71c..1af71b01dfc 100644 --- a/googleapiclient/discovery_cache/documents/sts.v1.json +++ b/googleapiclient/discovery_cache/documents/sts.v1.json @@ -116,7 +116,7 @@ } } }, -"revision": "20240523", +"revision": "20240530", "rootUrl": "https://sts.googleapis.com/", "schemas": { "GoogleIamV1Binding": { diff --git a/googleapiclient/discovery_cache/documents/sts.v1beta.json b/googleapiclient/discovery_cache/documents/sts.v1beta.json index 436b9c9a2bf..fd175dc29a7 100644 --- a/googleapiclient/discovery_cache/documents/sts.v1beta.json +++ b/googleapiclient/discovery_cache/documents/sts.v1beta.json @@ -116,7 +116,7 @@ } } }, -"revision": "20240523", +"revision": "20240530", "rootUrl": "https://sts.googleapis.com/", "schemas": { "GoogleIamV1Binding": { diff --git a/googleapiclient/discovery_cache/documents/tagmanager.v1.json b/googleapiclient/discovery_cache/documents/tagmanager.v1.json index 9627e8c164c..4223d155807 100644 --- a/googleapiclient/discovery_cache/documents/tagmanager.v1.json +++ b/googleapiclient/discovery_cache/documents/tagmanager.v1.json @@ -1932,7 +1932,7 @@ } } }, -"revision": "20240531", +"revision": "20240605", "rootUrl": "https://tagmanager.googleapis.com/", "schemas": { "Account": { diff --git a/googleapiclient/discovery_cache/documents/tagmanager.v2.json b/googleapiclient/discovery_cache/documents/tagmanager.v2.json index 272b73d8bf5..0a20980bf4c 100644 --- a/googleapiclient/discovery_cache/documents/tagmanager.v2.json +++ b/googleapiclient/discovery_cache/documents/tagmanager.v2.json @@ -3890,7 +3890,7 @@ } } }, -"revision": "20240531", +"revision": "20240605", "rootUrl": "https://tagmanager.googleapis.com/", "schemas": { "Account": { diff --git a/googleapiclient/discovery_cache/documents/tasks.v1.json b/googleapiclient/discovery_cache/documents/tasks.v1.json index 15fde63a434..988e2e39055 100644 --- a/googleapiclient/discovery_cache/documents/tasks.v1.json +++ b/googleapiclient/discovery_cache/documents/tasks.v1.json @@ -566,7 +566,7 @@ } } }, -"revision": "20240602", +"revision": "20240609", "rootUrl": "https://tasks.googleapis.com/", "schemas": { "Task": { diff --git a/googleapiclient/discovery_cache/documents/testing.v1.json b/googleapiclient/discovery_cache/documents/testing.v1.json index 37f11dd5a93..889ee9f15a7 100644 --- a/googleapiclient/discovery_cache/documents/testing.v1.json +++ b/googleapiclient/discovery_cache/documents/testing.v1.json @@ -449,7 +449,7 @@ } } }, -"revision": "20240530", +"revision": "20240604", "rootUrl": "https://testing.googleapis.com/", "schemas": { "Account": { diff --git a/googleapiclient/discovery_cache/documents/texttospeech.v1.json b/googleapiclient/discovery_cache/documents/texttospeech.v1.json index c4664f964a2..8bc4f6238ff 100644 --- a/googleapiclient/discovery_cache/documents/texttospeech.v1.json +++ b/googleapiclient/discovery_cache/documents/texttospeech.v1.json @@ -318,7 +318,7 @@ } } }, -"revision": "20240525", +"revision": "20240530", "rootUrl": "https://texttospeech.googleapis.com/", "schemas": { "AudioConfig": { diff --git a/googleapiclient/discovery_cache/documents/texttospeech.v1beta1.json b/googleapiclient/discovery_cache/documents/texttospeech.v1beta1.json index 483455eaac1..fa5dd27ef82 100644 --- a/googleapiclient/discovery_cache/documents/texttospeech.v1beta1.json +++ b/googleapiclient/discovery_cache/documents/texttospeech.v1beta1.json @@ -261,7 +261,7 @@ } } }, -"revision": "20240525", +"revision": "20240530", "rootUrl": "https://texttospeech.googleapis.com/", "schemas": { "AudioConfig": { diff --git a/googleapiclient/discovery_cache/documents/toolresults.v1beta3.json b/googleapiclient/discovery_cache/documents/toolresults.v1beta3.json index 2cae6f4470b..a2450c75b42 100644 --- a/googleapiclient/discovery_cache/documents/toolresults.v1beta3.json +++ b/googleapiclient/discovery_cache/documents/toolresults.v1beta3.json @@ -1463,7 +1463,7 @@ } } }, -"revision": "20240529", +"revision": "20240606", "rootUrl": "https://toolresults.googleapis.com/", "schemas": { "ANR": { diff --git a/googleapiclient/discovery_cache/documents/tpu.v1.json b/googleapiclient/discovery_cache/documents/tpu.v1.json index 94b66ee02d5..d0a24f8545e 100644 --- a/googleapiclient/discovery_cache/documents/tpu.v1.json +++ b/googleapiclient/discovery_cache/documents/tpu.v1.json @@ -659,7 +659,7 @@ } } }, -"revision": "20240528", +"revision": "20240530", "rootUrl": "https://tpu.googleapis.com/", "schemas": { "AcceleratorType": { diff --git a/googleapiclient/discovery_cache/documents/tpu.v1alpha1.json b/googleapiclient/discovery_cache/documents/tpu.v1alpha1.json index 5fd9ab8db8c..259a9eeae30 100644 --- a/googleapiclient/discovery_cache/documents/tpu.v1alpha1.json +++ b/googleapiclient/discovery_cache/documents/tpu.v1alpha1.json @@ -669,7 +669,7 @@ } } }, -"revision": "20240528", +"revision": "20240530", "rootUrl": "https://tpu.googleapis.com/", "schemas": { "AcceleratorType": { diff --git a/googleapiclient/discovery_cache/documents/tpu.v2.json b/googleapiclient/discovery_cache/documents/tpu.v2.json index 44925504c0f..b6b7ec1d4ab 100644 --- a/googleapiclient/discovery_cache/documents/tpu.v2.json +++ b/googleapiclient/discovery_cache/documents/tpu.v2.json @@ -887,7 +887,7 @@ } } }, -"revision": "20240528", +"revision": "20240530", "rootUrl": "https://tpu.googleapis.com/", "schemas": { "AcceleratorConfig": { @@ -905,6 +905,7 @@ "V2", "V3", "V4", +"V5LITE_POD", "V5P" ], "enumDescriptions": [ @@ -912,6 +913,7 @@ "TPU v2.", "TPU v3.", "TPU v4.", +"TPU v5lite pod.", "TPU v5p" ], "type": "string" diff --git a/googleapiclient/discovery_cache/documents/tpu.v2alpha1.json b/googleapiclient/discovery_cache/documents/tpu.v2alpha1.json index a298d9b49d1..cb4425cc195 100644 --- a/googleapiclient/discovery_cache/documents/tpu.v2alpha1.json +++ b/googleapiclient/discovery_cache/documents/tpu.v2alpha1.json @@ -965,7 +965,7 @@ } } }, -"revision": "20240528", +"revision": "20240530", "rootUrl": "https://tpu.googleapis.com/", "schemas": { "AcceleratorConfig": { @@ -983,6 +983,7 @@ "V2", "V3", "V4", +"V5LITE_POD", "V5P" ], "enumDescriptions": [ @@ -990,6 +991,7 @@ "TPU v2.", "TPU v3.", "TPU v4.", +"TPU v5lite pod.", "TPU v5." ], "type": "string" diff --git a/googleapiclient/discovery_cache/documents/trafficdirector.v2.json b/googleapiclient/discovery_cache/documents/trafficdirector.v2.json index 7be72a70130..79dbb0e2f0c 100644 --- a/googleapiclient/discovery_cache/documents/trafficdirector.v2.json +++ b/googleapiclient/discovery_cache/documents/trafficdirector.v2.json @@ -128,7 +128,7 @@ } } }, -"revision": "20240513", +"revision": "20240522", "rootUrl": "https://trafficdirector.googleapis.com/", "schemas": { "Address": { diff --git a/googleapiclient/discovery_cache/documents/trafficdirector.v3.json b/googleapiclient/discovery_cache/documents/trafficdirector.v3.json index f5bb1085b0c..8a217bdea0a 100644 --- a/googleapiclient/discovery_cache/documents/trafficdirector.v3.json +++ b/googleapiclient/discovery_cache/documents/trafficdirector.v3.json @@ -128,7 +128,7 @@ } } }, -"revision": "20240513", +"revision": "20240522", "rootUrl": "https://trafficdirector.googleapis.com/", "schemas": { "Address": { diff --git a/googleapiclient/discovery_cache/documents/transcoder.v1.json b/googleapiclient/discovery_cache/documents/transcoder.v1.json index 684514e5175..9955010f236 100644 --- a/googleapiclient/discovery_cache/documents/transcoder.v1.json +++ b/googleapiclient/discovery_cache/documents/transcoder.v1.json @@ -385,7 +385,7 @@ } } }, -"revision": "20240515", +"revision": "20240529", "rootUrl": "https://transcoder.googleapis.com/", "schemas": { "AdBreak": { diff --git a/googleapiclient/discovery_cache/documents/travelimpactmodel.v1.json b/googleapiclient/discovery_cache/documents/travelimpactmodel.v1.json index 24cfe552492..224d492481a 100644 --- a/googleapiclient/discovery_cache/documents/travelimpactmodel.v1.json +++ b/googleapiclient/discovery_cache/documents/travelimpactmodel.v1.json @@ -116,7 +116,7 @@ } } }, -"revision": "20240602", +"revision": "20240609", "rootUrl": "https://travelimpactmodel.googleapis.com/", "schemas": { "ComputeFlightEmissionsRequest": { diff --git a/googleapiclient/discovery_cache/documents/vault.v1.json b/googleapiclient/discovery_cache/documents/vault.v1.json index 03dc9dcf5dd..4912f04c672 100644 --- a/googleapiclient/discovery_cache/documents/vault.v1.json +++ b/googleapiclient/discovery_cache/documents/vault.v1.json @@ -1203,7 +1203,7 @@ } } }, -"revision": "20240530", +"revision": "20240605", "rootUrl": "https://vault.googleapis.com/", "schemas": { "AccountCount": { diff --git a/googleapiclient/discovery_cache/documents/verifiedaccess.v1.json b/googleapiclient/discovery_cache/documents/verifiedaccess.v1.json index a429d39d6ab..437a60c16b8 100644 --- a/googleapiclient/discovery_cache/documents/verifiedaccess.v1.json +++ b/googleapiclient/discovery_cache/documents/verifiedaccess.v1.json @@ -146,7 +146,7 @@ } } }, -"revision": "20240531", +"revision": "20240605", "rootUrl": "https://verifiedaccess.googleapis.com/", "schemas": { "Challenge": { diff --git a/googleapiclient/discovery_cache/documents/verifiedaccess.v2.json b/googleapiclient/discovery_cache/documents/verifiedaccess.v2.json index 84edd0ce52c..a92eab481a0 100644 --- a/googleapiclient/discovery_cache/documents/verifiedaccess.v2.json +++ b/googleapiclient/discovery_cache/documents/verifiedaccess.v2.json @@ -146,7 +146,7 @@ } } }, -"revision": "20240531", +"revision": "20240605", "rootUrl": "https://verifiedaccess.googleapis.com/", "schemas": { "Challenge": { diff --git a/googleapiclient/discovery_cache/documents/versionhistory.v1.json b/googleapiclient/discovery_cache/documents/versionhistory.v1.json index 42146e6b8b7..cec46189b51 100644 --- a/googleapiclient/discovery_cache/documents/versionhistory.v1.json +++ b/googleapiclient/discovery_cache/documents/versionhistory.v1.json @@ -271,7 +271,7 @@ } } }, -"revision": "20240602", +"revision": "20240609", "rootUrl": "https://versionhistory.googleapis.com/", "schemas": { "Channel": { diff --git a/googleapiclient/discovery_cache/documents/videointelligence.v1.json b/googleapiclient/discovery_cache/documents/videointelligence.v1.json index a1b44739530..971b785cc11 100644 --- a/googleapiclient/discovery_cache/documents/videointelligence.v1.json +++ b/googleapiclient/discovery_cache/documents/videointelligence.v1.json @@ -350,7 +350,7 @@ } } }, -"revision": "20240327", +"revision": "20240530", "rootUrl": "https://videointelligence.googleapis.com/", "schemas": { "GoogleCloudVideointelligenceV1_AnnotateVideoProgress": { diff --git a/googleapiclient/discovery_cache/documents/videointelligence.v1beta2.json b/googleapiclient/discovery_cache/documents/videointelligence.v1beta2.json index a41eeab71c2..ef7c503f7af 100644 --- a/googleapiclient/discovery_cache/documents/videointelligence.v1beta2.json +++ b/googleapiclient/discovery_cache/documents/videointelligence.v1beta2.json @@ -128,7 +128,7 @@ } } }, -"revision": "20240327", +"revision": "20240530", "rootUrl": "https://videointelligence.googleapis.com/", "schemas": { "GoogleCloudVideointelligenceV1_AnnotateVideoProgress": { diff --git a/googleapiclient/discovery_cache/documents/videointelligence.v1p1beta1.json b/googleapiclient/discovery_cache/documents/videointelligence.v1p1beta1.json index efcbfeb3f53..aebc6a34e1c 100644 --- a/googleapiclient/discovery_cache/documents/videointelligence.v1p1beta1.json +++ b/googleapiclient/discovery_cache/documents/videointelligence.v1p1beta1.json @@ -128,7 +128,7 @@ } } }, -"revision": "20240327", +"revision": "20240530", "rootUrl": "https://videointelligence.googleapis.com/", "schemas": { "GoogleCloudVideointelligenceV1_AnnotateVideoProgress": { diff --git a/googleapiclient/discovery_cache/documents/videointelligence.v1p2beta1.json b/googleapiclient/discovery_cache/documents/videointelligence.v1p2beta1.json index 462c4b38e8b..bddd7dd9266 100644 --- a/googleapiclient/discovery_cache/documents/videointelligence.v1p2beta1.json +++ b/googleapiclient/discovery_cache/documents/videointelligence.v1p2beta1.json @@ -128,7 +128,7 @@ } } }, -"revision": "20240327", +"revision": "20240530", "rootUrl": "https://videointelligence.googleapis.com/", "schemas": { "GoogleCloudVideointelligenceV1_AnnotateVideoProgress": { diff --git a/googleapiclient/discovery_cache/documents/videointelligence.v1p3beta1.json b/googleapiclient/discovery_cache/documents/videointelligence.v1p3beta1.json index e1324b3c10d..f24ac133f2e 100644 --- a/googleapiclient/discovery_cache/documents/videointelligence.v1p3beta1.json +++ b/googleapiclient/discovery_cache/documents/videointelligence.v1p3beta1.json @@ -128,7 +128,7 @@ } } }, -"revision": "20240327", +"revision": "20240530", "rootUrl": "https://videointelligence.googleapis.com/", "schemas": { "GoogleCloudVideointelligenceV1_AnnotateVideoProgress": { diff --git a/googleapiclient/discovery_cache/documents/vision.v1.json b/googleapiclient/discovery_cache/documents/vision.v1.json index 68ad473ce30..923d404dcfd 100644 --- a/googleapiclient/discovery_cache/documents/vision.v1.json +++ b/googleapiclient/discovery_cache/documents/vision.v1.json @@ -1282,7 +1282,7 @@ } } }, -"revision": "20240524", +"revision": "20240531", "rootUrl": "https://vision.googleapis.com/", "schemas": { "AddProductToProductSetRequest": { diff --git a/googleapiclient/discovery_cache/documents/vision.v1p1beta1.json b/googleapiclient/discovery_cache/documents/vision.v1p1beta1.json index 2f96c8cdbef..d6d9bcd316f 100644 --- a/googleapiclient/discovery_cache/documents/vision.v1p1beta1.json +++ b/googleapiclient/discovery_cache/documents/vision.v1p1beta1.json @@ -449,7 +449,7 @@ } } }, -"revision": "20240524", +"revision": "20240531", "rootUrl": "https://vision.googleapis.com/", "schemas": { "AnnotateFileResponse": { diff --git a/googleapiclient/discovery_cache/documents/vision.v1p2beta1.json b/googleapiclient/discovery_cache/documents/vision.v1p2beta1.json index d95f0fd9fc7..a9e48afa2f6 100644 --- a/googleapiclient/discovery_cache/documents/vision.v1p2beta1.json +++ b/googleapiclient/discovery_cache/documents/vision.v1p2beta1.json @@ -449,7 +449,7 @@ } } }, -"revision": "20240524", +"revision": "20240531", "rootUrl": "https://vision.googleapis.com/", "schemas": { "AnnotateFileResponse": { diff --git a/googleapiclient/discovery_cache/documents/vmmigration.v1.json b/googleapiclient/discovery_cache/documents/vmmigration.v1.json index 7d135c73ea6..8568c285d4f 100644 --- a/googleapiclient/discovery_cache/documents/vmmigration.v1.json +++ b/googleapiclient/discovery_cache/documents/vmmigration.v1.json @@ -2220,7 +2220,7 @@ } } }, -"revision": "20240523", +"revision": "20240530", "rootUrl": "https://vmmigration.googleapis.com/", "schemas": { "AccessKeyCredentials": { @@ -2329,17 +2329,20 @@ "id": "AwsDiskDetails", "properties": { "diskNumber": { -"description": "The ordinal number of the disk.", +"description": "Output only. The ordinal number of the disk.", "format": "int32", +"readOnly": true, "type": "integer" }, "sizeGb": { -"description": "Size in GB.", +"description": "Output only. Size in GB.", "format": "int64", +"readOnly": true, "type": "string" }, "volumeId": { -"description": "AWS volume ID.", +"description": "Output only. AWS volume ID.", +"readOnly": true, "type": "string" } }, @@ -2428,19 +2431,21 @@ "id": "AwsSourceVmDetails", "properties": { "committedStorageBytes": { -"description": "The total size of the disks being migrated in bytes.", +"description": "Output only. The total size of the disks being migrated in bytes.", "format": "int64", +"readOnly": true, "type": "string" }, "disks": { -"description": "The disks attached to the source VM.", +"description": "Output only. The disks attached to the source VM.", "items": { "$ref": "AwsDiskDetails" }, +"readOnly": true, "type": "array" }, "firmware": { -"description": "The firmware type of the source VM.", +"description": "Output only. The firmware type of the source VM.", "enum": [ "FIRMWARE_UNSPECIFIED", "EFI", @@ -2451,6 +2456,7 @@ "The firmware is EFI.", "The firmware is BIOS." ], +"readOnly": true, "type": "string" }, "vmCapabilitiesInfo": { @@ -2618,17 +2624,20 @@ "id": "AzureDiskDetails", "properties": { "diskId": { -"description": "Azure disk ID.", +"description": "Output only. Azure disk ID.", +"readOnly": true, "type": "string" }, "diskNumber": { -"description": "The ordinal number of the disk.", +"description": "Output only. The ordinal number of the disk.", "format": "int32", +"readOnly": true, "type": "integer" }, "sizeGb": { -"description": "Size in GB.", +"description": "Output only. Size in GB.", "format": "int64", +"readOnly": true, "type": "string" } }, @@ -2692,19 +2701,21 @@ "id": "AzureSourceVmDetails", "properties": { "committedStorageBytes": { -"description": "The total size of the disks being migrated in bytes.", +"description": "Output only. The total size of the disks being migrated in bytes.", "format": "int64", +"readOnly": true, "type": "string" }, "disks": { -"description": "The disks attached to the source VM.", +"description": "Output only. The disks attached to the source VM.", "items": { "$ref": "AzureDiskDetails" }, +"readOnly": true, "type": "array" }, "firmware": { -"description": "The firmware type of the source VM.", +"description": "Output only. The firmware type of the source VM.", "enum": [ "FIRMWARE_UNSPECIFIED", "EFI", @@ -2715,6 +2726,7 @@ "The firmware is EFI.", "The firmware is BIOS." ], +"readOnly": true, "type": "string" }, "vmCapabilitiesInfo": { @@ -4787,7 +4799,8 @@ "properties": { "actionItem": { "$ref": "LocalizedMessage", -"description": "Suggested action for solving the warning." +"description": "Output only. Suggested action for solving the warning.", +"readOnly": true }, "code": { "description": "The warning code.", @@ -4802,15 +4815,17 @@ "type": "string" }, "helpLinks": { -"description": "URL(s) pointing to additional information on handling the current warning.", +"description": "Output only. URL(s) pointing to additional information on handling the current warning.", "items": { "$ref": "Link" }, +"readOnly": true, "type": "array" }, "warningMessage": { "$ref": "LocalizedMessage", -"description": "The localized warning message." +"description": "Output only. The localized warning message.", +"readOnly": true }, "warningTime": { "description": "The time the warning occurred.", @@ -4825,11 +4840,11 @@ "id": "NetworkInterface", "properties": { "externalIp": { -"description": "The external IP to define in the NIC.", +"description": "Optional. The external IP to define in the NIC.", "type": "string" }, "internalIp": { -"description": "The internal IP to define in the NIC. The formats accepted are: `ephemeral` \\ ipv4 address \\ a named address resource full path.", +"description": "Optional. The internal IP to define in the NIC. The formats accepted are: `ephemeral` \\ ipv4 address \\ a named address resource full path.", "type": "string" }, "network": { @@ -5100,7 +5115,8 @@ }, "error": { "$ref": "Status", -"description": "Provides details on the state of the cycle in case of an error." +"description": "Output only. Provides details on the state of the cycle in case of an error.", +"readOnly": true }, "name": { "description": "The identifier of the ReplicationCycle.", @@ -5319,11 +5335,11 @@ "id": "Tag", "properties": { "key": { -"description": "Key of tag.", +"description": "Required. Key of tag.", "type": "string" }, "value": { -"description": "Value of tag.", +"description": "Required. Value of tag.", "type": "string" } }, @@ -5378,7 +5394,8 @@ "properties": { "error": { "$ref": "Status", -"description": "Provides details on the state of the upgrade operation in case of an error." +"description": "Output only. Provides details on the state of the upgrade operation in case of an error.", +"readOnly": true }, "previousVersion": { "description": "The version from which we upgraded.", @@ -5610,17 +5627,20 @@ "id": "VmwareDiskDetails", "properties": { "diskNumber": { -"description": "The ordinal number of the disk.", +"description": "Output only. The ordinal number of the disk.", "format": "int32", +"readOnly": true, "type": "integer" }, "label": { -"description": "The disk label.", +"description": "Output only. The disk label.", +"readOnly": true, "type": "string" }, "sizeGb": { -"description": "Size in GB.", +"description": "Output only. Size in GB.", "format": "int64", +"readOnly": true, "type": "string" } }, @@ -5658,19 +5678,21 @@ "id": "VmwareSourceVmDetails", "properties": { "committedStorageBytes": { -"description": "The total size of the disks being migrated in bytes.", +"description": "Output only. The total size of the disks being migrated in bytes.", "format": "int64", +"readOnly": true, "type": "string" }, "disks": { -"description": "The disks attached to the source VM.", +"description": "Output only. The disks attached to the source VM.", "items": { "$ref": "VmwareDiskDetails" }, +"readOnly": true, "type": "array" }, "firmware": { -"description": "The firmware type of the source VM.", +"description": "Output only. The firmware type of the source VM.", "enum": [ "FIRMWARE_UNSPECIFIED", "EFI", @@ -5681,6 +5703,7 @@ "The firmware is EFI.", "The firmware is BIOS." ], +"readOnly": true, "type": "string" }, "vmCapabilitiesInfo": { diff --git a/googleapiclient/discovery_cache/documents/vmmigration.v1alpha1.json b/googleapiclient/discovery_cache/documents/vmmigration.v1alpha1.json index 2519440be84..ae679871d58 100644 --- a/googleapiclient/discovery_cache/documents/vmmigration.v1alpha1.json +++ b/googleapiclient/discovery_cache/documents/vmmigration.v1alpha1.json @@ -2220,7 +2220,7 @@ } } }, -"revision": "20240523", +"revision": "20240530", "rootUrl": "https://vmmigration.googleapis.com/", "schemas": { "AccessKeyCredentials": { @@ -2329,17 +2329,20 @@ "id": "AwsDiskDetails", "properties": { "diskNumber": { -"description": "The ordinal number of the disk.", +"description": "Output only. The ordinal number of the disk.", "format": "int32", +"readOnly": true, "type": "integer" }, "sizeGb": { -"description": "Size in GB.", +"description": "Output only. Size in GB.", "format": "int64", +"readOnly": true, "type": "string" }, "volumeId": { -"description": "AWS volume ID.", +"description": "Output only. AWS volume ID.", +"readOnly": true, "type": "string" } }, @@ -2428,19 +2431,21 @@ "id": "AwsSourceVmDetails", "properties": { "committedStorageBytes": { -"description": "The total size of the disks being migrated in bytes.", +"description": "Output only. The total size of the disks being migrated in bytes.", "format": "int64", +"readOnly": true, "type": "string" }, "disks": { -"description": "The disks attached to the source VM.", +"description": "Output only. The disks attached to the source VM.", "items": { "$ref": "AwsDiskDetails" }, +"readOnly": true, "type": "array" }, "firmware": { -"description": "The firmware type of the source VM.", +"description": "Output only. The firmware type of the source VM.", "enum": [ "FIRMWARE_UNSPECIFIED", "EFI", @@ -2451,6 +2456,7 @@ "The firmware is EFI.", "The firmware is BIOS." ], +"readOnly": true, "type": "string" }, "vmCapabilitiesInfo": { @@ -2618,17 +2624,20 @@ "id": "AzureDiskDetails", "properties": { "diskId": { -"description": "Azure disk ID.", +"description": "Output only. Azure disk ID.", +"readOnly": true, "type": "string" }, "diskNumber": { -"description": "The ordinal number of the disk.", +"description": "Output only. The ordinal number of the disk.", "format": "int32", +"readOnly": true, "type": "integer" }, "sizeGb": { -"description": "Size in GB.", +"description": "Output only. Size in GB.", "format": "int64", +"readOnly": true, "type": "string" } }, @@ -2692,19 +2701,21 @@ "id": "AzureSourceVmDetails", "properties": { "committedStorageBytes": { -"description": "The total size of the disks being migrated in bytes.", +"description": "Output only. The total size of the disks being migrated in bytes.", "format": "int64", +"readOnly": true, "type": "string" }, "disks": { -"description": "The disks attached to the source VM.", +"description": "Output only. The disks attached to the source VM.", "items": { "$ref": "AzureDiskDetails" }, +"readOnly": true, "type": "array" }, "firmware": { -"description": "The firmware type of the source VM.", +"description": "Output only. The firmware type of the source VM.", "enum": [ "FIRMWARE_UNSPECIFIED", "EFI", @@ -2715,6 +2726,7 @@ "The firmware is EFI.", "The firmware is BIOS." ], +"readOnly": true, "type": "string" }, "vmCapabilitiesInfo": { @@ -4832,7 +4844,8 @@ "properties": { "actionItem": { "$ref": "LocalizedMessage", -"description": "Suggested action for solving the warning." +"description": "Output only. Suggested action for solving the warning.", +"readOnly": true }, "code": { "description": "The warning code.", @@ -4847,15 +4860,17 @@ "type": "string" }, "helpLinks": { -"description": "URL(s) pointing to additional information on handling the current warning.", +"description": "Output only. URL(s) pointing to additional information on handling the current warning.", "items": { "$ref": "Link" }, +"readOnly": true, "type": "array" }, "warningMessage": { "$ref": "LocalizedMessage", -"description": "The localized warning message." +"description": "Output only. The localized warning message.", +"readOnly": true }, "warningTime": { "description": "The time the warning occurred.", @@ -4870,11 +4885,11 @@ "id": "NetworkInterface", "properties": { "externalIp": { -"description": "The external IP to define in the NIC.", +"description": "Optional. The external IP to define in the NIC.", "type": "string" }, "internalIp": { -"description": "The internal IP to define in the NIC. The formats accepted are: `ephemeral` \\ ipv4 address \\ a named address resource full path.", +"description": "Optional. The internal IP to define in the NIC. The formats accepted are: `ephemeral` \\ ipv4 address \\ a named address resource full path.", "type": "string" }, "network": { @@ -5145,7 +5160,8 @@ }, "error": { "$ref": "Status", -"description": "Provides details on the state of the cycle in case of an error." +"description": "Output only. Provides details on the state of the cycle in case of an error.", +"readOnly": true }, "name": { "description": "The identifier of the ReplicationCycle.", @@ -5376,11 +5392,11 @@ "id": "Tag", "properties": { "key": { -"description": "Key of tag.", +"description": "Required. Key of tag.", "type": "string" }, "value": { -"description": "Value of tag.", +"description": "Required. Value of tag.", "type": "string" } }, @@ -5577,7 +5593,8 @@ "properties": { "error": { "$ref": "Status", -"description": "Provides details on the state of the upgrade operation in case of an error." +"description": "Output only. Provides details on the state of the upgrade operation in case of an error.", +"readOnly": true }, "previousVersion": { "description": "The version from which we upgraded.", @@ -5864,17 +5881,20 @@ "id": "VmwareDiskDetails", "properties": { "diskNumber": { -"description": "The ordinal number of the disk.", +"description": "Output only. The ordinal number of the disk.", "format": "int32", +"readOnly": true, "type": "integer" }, "label": { -"description": "The disk label.", +"description": "Output only. The disk label.", +"readOnly": true, "type": "string" }, "sizeGb": { -"description": "Size in GB.", +"description": "Output only. Size in GB.", "format": "int64", +"readOnly": true, "type": "string" } }, @@ -5912,19 +5932,21 @@ "id": "VmwareSourceVmDetails", "properties": { "committedStorageBytes": { -"description": "The total size of the disks being migrated in bytes.", +"description": "Output only. The total size of the disks being migrated in bytes.", "format": "int64", +"readOnly": true, "type": "string" }, "disks": { -"description": "The disks attached to the source VM.", +"description": "Output only. The disks attached to the source VM.", "items": { "$ref": "VmwareDiskDetails" }, +"readOnly": true, "type": "array" }, "firmware": { -"description": "The firmware type of the source VM.", +"description": "Output only. The firmware type of the source VM.", "enum": [ "FIRMWARE_UNSPECIFIED", "EFI", @@ -5935,6 +5957,7 @@ "The firmware is EFI.", "The firmware is BIOS." ], +"readOnly": true, "type": "string" }, "vmCapabilitiesInfo": { diff --git a/googleapiclient/discovery_cache/documents/vmwareengine.v1.json b/googleapiclient/discovery_cache/documents/vmwareengine.v1.json index 1b19f2c8eeb..06e31ea9674 100644 --- a/googleapiclient/discovery_cache/documents/vmwareengine.v1.json +++ b/googleapiclient/discovery_cache/documents/vmwareengine.v1.json @@ -3173,7 +3173,7 @@ } } }, -"revision": "20240509", +"revision": "20240528", "rootUrl": "https://vmwareengine.googleapis.com/", "schemas": { "AuditConfig": { @@ -3639,12 +3639,14 @@ "enum": [ "STATE_UNSPECIFIED", "ACTIVE", -"CREATING" +"CREATING", +"ACTIVATING" ], "enumDescriptions": [ "Unspecified appliance state. This is the default value.", "The appliance is operational and can be used.", -"The appliance is being deployed." +"The appliance is being deployed.", +"The appliance is being activated." ], "readOnly": true, "type": "string" @@ -4436,7 +4438,8 @@ "PRIVATE_SERVICES_ACCESS", "NETAPP_CLOUD_VOLUMES", "THIRD_PARTY_SERVICE", -"DELL_POWERSCALE" +"DELL_POWERSCALE", +"GOOGLE_CLOUD_NETAPP_VOLUMES" ], "enumDescriptions": [ "Unspecified", @@ -4445,7 +4448,8 @@ "Peering connection used for establishing [private services access](https://cloud.google.com/vpc/docs/private-services-access).", "Peering connection used for connecting to NetApp Cloud Volumes.", "Peering connection used for connecting to third-party services. Most third-party services require manual setup of reverse peering on the VPC network associated with the third-party service.", -"Peering connection used for connecting to Dell PowerScale Filers" +"Peering connection used for connecting to Dell PowerScale Filers", +"Peering connection used for connecting to Google Cloud NetApp Volumes." ], "type": "string" }, diff --git a/googleapiclient/discovery_cache/documents/vpcaccess.v1.json b/googleapiclient/discovery_cache/documents/vpcaccess.v1.json index e1a884d3989..d94d7ff63ff 100644 --- a/googleapiclient/discovery_cache/documents/vpcaccess.v1.json +++ b/googleapiclient/discovery_cache/documents/vpcaccess.v1.json @@ -384,7 +384,7 @@ } } }, -"revision": "20240502", +"revision": "20240530", "rootUrl": "https://vpcaccess.googleapis.com/", "schemas": { "Connector": { diff --git a/googleapiclient/discovery_cache/documents/walletobjects.v1.json b/googleapiclient/discovery_cache/documents/walletobjects.v1.json index 19ed139135a..565c1df458b 100644 --- a/googleapiclient/discovery_cache/documents/walletobjects.v1.json +++ b/googleapiclient/discovery_cache/documents/walletobjects.v1.json @@ -2681,7 +2681,7 @@ } } }, -"revision": "20240603", +"revision": "20240610", "rootUrl": "https://walletobjects.googleapis.com/", "schemas": { "ActivationOptions": { @@ -6851,7 +6851,7 @@ true }, "hash": { "deprecated": true, -"description": "Deprecated, use one of explicit hash type fields instead. These two hash related fields will only be populated on Scotty based media uploads and will contain the content of the hash group in the NotificationRequest: http://cs/#google3/uploader/service/proto/upload_listener.proto&q=class:Hash Hex encoded hash value of the uploaded media.", +"description": "Deprecated, use one of explicit hash type fields instead. These two hash related fields will only be populated on Scotty based media uploads and will contain the content of the hash group in the NotificationRequest: http://cs/#google3/blobstore2/api/scotty/service/proto/upload_listener.proto&q=class:Hash Hex encoded hash value of the uploaded media.", "type": "string" }, "hashVerified": { diff --git a/googleapiclient/discovery_cache/documents/webfonts.v1.json b/googleapiclient/discovery_cache/documents/webfonts.v1.json index 51b20d45dfd..d1e4dae9160 100644 --- a/googleapiclient/discovery_cache/documents/webfonts.v1.json +++ b/googleapiclient/discovery_cache/documents/webfonts.v1.json @@ -161,7 +161,7 @@ } } }, -"revision": "20240528", +"revision": "20240605", "rootUrl": "https://webfonts.googleapis.com/", "schemas": { "Axis": { diff --git a/googleapiclient/discovery_cache/documents/webrisk.v1.json b/googleapiclient/discovery_cache/documents/webrisk.v1.json index 8bb0d53c1ff..732bb409e4a 100644 --- a/googleapiclient/discovery_cache/documents/webrisk.v1.json +++ b/googleapiclient/discovery_cache/documents/webrisk.v1.json @@ -420,7 +420,7 @@ } } }, -"revision": "20240603", +"revision": "20240609", "rootUrl": "https://webrisk.googleapis.com/", "schemas": { "GoogleCloudWebriskV1ComputeThreatListDiffResponse": { diff --git a/googleapiclient/discovery_cache/documents/workflowexecutions.v1.json b/googleapiclient/discovery_cache/documents/workflowexecutions.v1.json index 70c8f21664b..f25ae0c7232 100644 --- a/googleapiclient/discovery_cache/documents/workflowexecutions.v1.json +++ b/googleapiclient/discovery_cache/documents/workflowexecutions.v1.json @@ -274,7 +274,7 @@ ], "parameters": { "filter": { -"description": "Optional. Filters applied to the `[Executions.ListExecutions]` results. The following fields are supported for filtering: `executionId`, `state`, `createTime`, `startTime`, `endTime`, `duration`, `workflowRevisionId`, `stepName`, and `label`. For details, see AIP-160. For example, if you are using the Google APIs Explorer: `state=\"SUCCEEDED\"` or `startTime>\"2023-08-01\" AND state=\"FAILED\"`", +"description": "Optional. Filters applied to the `[Executions.ListExecutions]` results. The following fields are supported for filtering: `executionId`, `state`, `createTime`, `startTime`, `endTime`, `duration`, `workflowRevisionId`, `stepName`, and `label`. For details, see AIP-160. For more information, see Filter executions. For example, if you are using the Google APIs Explorer: `state=\"SUCCEEDED\"` or `startTime>\"2023-08-01\" AND state=\"FAILED\"`", "location": "query", "type": "string" }, diff --git a/googleapiclient/discovery_cache/documents/workflows.v1.json b/googleapiclient/discovery_cache/documents/workflows.v1.json index 3cb57bc4a9b..72249bbf1be 100644 --- a/googleapiclient/discovery_cache/documents/workflows.v1.json +++ b/googleapiclient/discovery_cache/documents/workflows.v1.json @@ -485,7 +485,7 @@ } } }, -"revision": "20240522", +"revision": "20240529", "rootUrl": "https://workflows.googleapis.com/", "schemas": { "Empty": { diff --git a/googleapiclient/discovery_cache/documents/workflows.v1beta.json b/googleapiclient/discovery_cache/documents/workflows.v1beta.json index 02765016a36..f47616aa760 100644 --- a/googleapiclient/discovery_cache/documents/workflows.v1beta.json +++ b/googleapiclient/discovery_cache/documents/workflows.v1beta.json @@ -444,7 +444,7 @@ } } }, -"revision": "20240522", +"revision": "20240529", "rootUrl": "https://workflows.googleapis.com/", "schemas": { "Empty": { diff --git a/googleapiclient/discovery_cache/documents/workspaceevents.v1.json b/googleapiclient/discovery_cache/documents/workspaceevents.v1.json index 4bf408a582e..c7f0e93af4d 100644 --- a/googleapiclient/discovery_cache/documents/workspaceevents.v1.json +++ b/googleapiclient/discovery_cache/documents/workspaceevents.v1.json @@ -424,7 +424,7 @@ } } }, -"revision": "20240528", +"revision": "20240604", "rootUrl": "https://workspaceevents.googleapis.com/", "schemas": { "ListSubscriptionsResponse": { diff --git a/googleapiclient/discovery_cache/documents/workstations.v1.json b/googleapiclient/discovery_cache/documents/workstations.v1.json index 781660dcfe8..07ccb65f5a2 100644 --- a/googleapiclient/discovery_cache/documents/workstations.v1.json +++ b/googleapiclient/discovery_cache/documents/workstations.v1.json @@ -1195,7 +1195,7 @@ } } }, -"revision": "20240520", +"revision": "20240528", "rootUrl": "https://workstations.googleapis.com/", "schemas": { "Accelerator": { @@ -1347,11 +1347,11 @@ "type": "object" }, "DomainConfig": { -"description": "Configuration options for a custom domain.", +"description": "Configuration options for private workstation clusters.", "id": "DomainConfig", "properties": { "domain": { -"description": "Immutable. Domain used by Workstations for HTTP ingress.", +"description": "Immutable. Whether Workstations endpoint is private.", "type": "string" } }, @@ -1435,7 +1435,7 @@ "type": "boolean" }, "enableNestedVirtualization": { -"description": "Optional. Whether to enable nested virtualization on Cloud Workstations VMs created using this workstation configuration. Nested virtualization lets you run virtual machine (VM) instances inside your workstation. Before enabling nested virtualization, consider the following important considerations. Cloud Workstations instances are subject to the [same restrictions as Compute Engine instances](https://cloud.google.com/compute/docs/instances/nested-virtualization/overview#restrictions): * **Organization policy**: projects, folders, or organizations may be restricted from creating nested VMs if the **Disable VM nested virtualization** constraint is enforced in the organization policy. For more information, see the Compute Engine section, [Checking whether nested virtualization is allowed](https://cloud.google.com/compute/docs/instances/nested-virtualization/managing-constraint#checking_whether_nested_virtualization_is_allowed). * **Performance**: nested VMs might experience a 10% or greater decrease in performance for workloads that are CPU-bound and possibly greater than a 10% decrease for workloads that are input/output bound. * **Machine Type**: nested virtualization can only be enabled on workstation configurations that specify a machine_type in the N1 or N2 machine series. * **GPUs**: nested virtualization may not be enabled on workstation configurations with accelerators. * **Operating System**: Because [Container-Optimized OS](https://cloud.google.com/compute/docs/images/os-details#container-optimized_os_cos) does not support nested virtualization, when nested virtualization is enabled, the underlying Compute Engine VM instances boot from an [Ubuntu LTS](https://cloud.google.com/compute/docs/images/os-details#ubuntu_lts) image.", +"description": "Optional. Whether to enable nested virtualization on Cloud Workstations VMs created using this workstation configuration. Nested virtualization lets you run virtual machine (VM) instances inside your workstation. Before enabling nested virtualization, consider the following important considerations. Cloud Workstations instances are subject to the [same restrictions as Compute Engine instances](https://cloud.google.com/compute/docs/instances/nested-virtualization/overview#restrictions): * **Organization policy**: projects, folders, or organizations may be restricted from creating nested VMs if the **Disable VM nested virtualization** constraint is enforced in the organization policy. For more information, see the Compute Engine section, [Checking whether nested virtualization is allowed](https://cloud.google.com/compute/docs/instances/nested-virtualization/managing-constraint#checking_whether_nested_virtualization_is_allowed). * **Performance**: nested VMs might experience a 10% or greater decrease in performance for workloads that are CPU-bound and possibly greater than a 10% decrease for workloads that are input/output bound. * **Machine Type**: nested virtualization can only be enabled on workstation configurations that specify a machine_type in the N1 or N2 machine series. * **GPUs**: nested virtualization may not be enabled on workstation configurations with accelerators. * **Operating System**: because [Container-Optimized OS](https://cloud.google.com/compute/docs/images/os-details#container-optimized_os_cos) does not support nested virtualization, when nested virtualization is enabled, the underlying Compute Engine VM instances boot from an [Ubuntu LTS](https://cloud.google.com/compute/docs/images/os-details#ubuntu_lts) image.", "type": "boolean" }, "machineType": { @@ -1929,27 +1929,22 @@ "type": "object" }, "PrivateClusterConfig": { -"description": "Configuration options for private workstation clusters.", "id": "PrivateClusterConfig", "properties": { "allowedProjects": { -"description": "Optional. Additional projects that are allowed to attach to the workstation cluster's service attachment. By default, the workstation cluster's project and the VPC host project (if different) are allowed.", "items": { "type": "string" }, "type": "array" }, "clusterHostname": { -"description": "Output only. Hostname for the workstation cluster. This field will be populated only when private endpoint is enabled. To access workstations in the workstation cluster, create a new DNS zone mapping this domain name to an internal IP address and a forwarding rule mapping that address to the service attachment.", "readOnly": true, "type": "string" }, "enablePrivateEndpoint": { -"description": "Immutable. Whether Workstations endpoint is private.", "type": "boolean" }, "serviceAttachmentUri": { -"description": "Output only. Service attachment URI for the workstation cluster. The service attachemnt is created when private endpoint is enabled. To access workstations in the workstation cluster, configure access to the managed service using [Private Service Connect](https://cloud.google.com/vpc/docs/configure-private-service-connect-services).", "readOnly": true, "type": "string" } diff --git a/googleapiclient/discovery_cache/documents/workstations.v1beta.json b/googleapiclient/discovery_cache/documents/workstations.v1beta.json index 04777ad002b..e652a82dccf 100644 --- a/googleapiclient/discovery_cache/documents/workstations.v1beta.json +++ b/googleapiclient/discovery_cache/documents/workstations.v1beta.json @@ -1127,7 +1127,7 @@ } } }, -"revision": "20240520", +"revision": "20240528", "rootUrl": "https://workstations.googleapis.com/", "schemas": { "Accelerator": { @@ -1315,11 +1315,11 @@ "type": "object" }, "DomainConfig": { -"description": "Configuration options for a custom domain.", +"description": "Configuration options for private workstation clusters.", "id": "DomainConfig", "properties": { "domain": { -"description": "Immutable. Domain used by Workstations for HTTP ingress.", +"description": "Immutable. Whether Workstations endpoint is private.", "type": "string" } }, @@ -1410,7 +1410,7 @@ "type": "boolean" }, "enableNestedVirtualization": { -"description": "Optional. Whether to enable nested virtualization on Cloud Workstations VMs created using this workstation configuration. Nested virtualization lets you run virtual machine (VM) instances inside your workstation. Before enabling nested virtualization, consider the following important considerations. Cloud Workstations instances are subject to the [same restrictions as Compute Engine instances](https://cloud.google.com/compute/docs/instances/nested-virtualization/overview#restrictions): * **Organization policy**: projects, folders, or organizations may be restricted from creating nested VMs if the **Disable VM nested virtualization** constraint is enforced in the organization policy. For more information, see the Compute Engine section, [Checking whether nested virtualization is allowed](https://cloud.google.com/compute/docs/instances/nested-virtualization/managing-constraint#checking_whether_nested_virtualization_is_allowed). * **Performance**: nested VMs might experience a 10% or greater decrease in performance for workloads that are CPU-bound and possibly greater than a 10% decrease for workloads that are input/output bound. * **Machine Type**: nested virtualization can only be enabled on workstation configurations that specify a machine_type in the N1 or N2 machine series. * **GPUs**: nested virtualization may not be enabled on workstation configurations with accelerators. * **Operating System**: Because [Container-Optimized OS](https://cloud.google.com/compute/docs/images/os-details#container-optimized_os_cos) does not support nested virtualization, when nested virtualization is enabled, the underlying Compute Engine VM instances boot from an [Ubuntu LTS](https://cloud.google.com/compute/docs/images/os-details#ubuntu_lts) image.", +"description": "Optional. Whether to enable nested virtualization on Cloud Workstations VMs created using this workstation configuration. Nested virtualization lets you run virtual machine (VM) instances inside your workstation. Before enabling nested virtualization, consider the following important considerations. Cloud Workstations instances are subject to the [same restrictions as Compute Engine instances](https://cloud.google.com/compute/docs/instances/nested-virtualization/overview#restrictions): * **Organization policy**: projects, folders, or organizations may be restricted from creating nested VMs if the **Disable VM nested virtualization** constraint is enforced in the organization policy. For more information, see the Compute Engine section, [Checking whether nested virtualization is allowed](https://cloud.google.com/compute/docs/instances/nested-virtualization/managing-constraint#checking_whether_nested_virtualization_is_allowed). * **Performance**: nested VMs might experience a 10% or greater decrease in performance for workloads that are CPU-bound and possibly greater than a 10% decrease for workloads that are input/output bound. * **Machine Type**: nested virtualization can only be enabled on workstation configurations that specify a machine_type in the N1 or N2 machine series. * **GPUs**: nested virtualization may not be enabled on workstation configurations with accelerators. * **Operating System**: because [Container-Optimized OS](https://cloud.google.com/compute/docs/images/os-details#container-optimized_os_cos) does not support nested virtualization, when nested virtualization is enabled, the underlying Compute Engine VM instances boot from an [Ubuntu LTS](https://cloud.google.com/compute/docs/images/os-details#ubuntu_lts) image.", "type": "boolean" }, "machineType": { @@ -1550,7 +1550,7 @@ "type": "string" }, "port": { -"description": "Optional. Port for which the access token should be generated. If specified, the generated access token will grant access only to the specified port of the workstation. If specified, values must be within the range [1 - 65535]. If not specified, the generated access token will grant access to all ports of the workstation.", +"description": "Optional. Port for which the access token should be generated. If specified, the generated access token grants access only to the specified port of the workstation. If specified, values must be within the range [1 - 65535]. If not specified, the generated access token grants access to all ports of the workstation.", "format": "int32", "type": "integer" }, @@ -1864,7 +1864,7 @@ "type": "object" }, "PortRange": { -"description": "A PortsConfig defines a range of ports. Both first and last are inclusive. To specify a single port, both first and last should be same.", +"description": "A PortsConfig defines a range of ports. Both first and last are inclusive. To specify a single port, both first and last should be the same.", "id": "PortRange", "properties": { "first": { @@ -1881,27 +1881,22 @@ "type": "object" }, "PrivateClusterConfig": { -"description": "Configuration options for private workstation clusters.", "id": "PrivateClusterConfig", "properties": { "allowedProjects": { -"description": "Optional. Additional projects that are allowed to attach to the workstation cluster's service attachment. By default, the workstation cluster's project and the VPC host project (if different) are allowed.", "items": { "type": "string" }, "type": "array" }, "clusterHostname": { -"description": "Output only. Hostname for the workstation cluster. This field will be populated only when private endpoint is enabled. To access workstations in the workstation cluster, create a new DNS zone mapping this domain name to an internal IP address and a forwarding rule mapping that address to the service attachment.", "readOnly": true, "type": "string" }, "enablePrivateEndpoint": { -"description": "Immutable. Whether Workstations endpoint is private.", "type": "boolean" }, "serviceAttachmentUri": { -"description": "Output only. Service attachment URI for the workstation cluster. The service attachemnt is created when private endpoint is enabled. To access workstations in the workstation cluster, configure access to the managed service using [Private Service Connect](https://cloud.google.com/vpc/docs/configure-private-service-connect-services).", "readOnly": true, "type": "string" } @@ -2232,7 +2227,7 @@ "id": "WorkstationConfig", "properties": { "allowedPorts": { -"description": "Optional. Single or Range of ports externally accessible in the workstation. If not specified defaults to ports 22, 80 and ports 1024-65535.", +"description": "Optional. A Single or Range of ports externally accessible in the workstation. If not specified defaults to ports 22, 80 and ports 1024-65535.", "items": { "$ref": "PortRange" }, diff --git a/googleapiclient/discovery_cache/documents/youtube.v3.json b/googleapiclient/discovery_cache/documents/youtube.v3.json index 466fdee87f0..c467f2c744d 100644 --- a/googleapiclient/discovery_cache/documents/youtube.v3.json +++ b/googleapiclient/discovery_cache/documents/youtube.v3.json @@ -4072,7 +4072,7 @@ } } }, -"revision": "20240602", +"revision": "20240609", "rootUrl": "https://youtube.googleapis.com/", "schemas": { "AbuseReport": { diff --git a/googleapiclient/discovery_cache/documents/youtubeAnalytics.v2.json b/googleapiclient/discovery_cache/documents/youtubeAnalytics.v2.json index 3d94335f64f..f67734c3141 100644 --- a/googleapiclient/discovery_cache/documents/youtubeAnalytics.v2.json +++ b/googleapiclient/discovery_cache/documents/youtubeAnalytics.v2.json @@ -421,7 +421,7 @@ } } }, -"revision": "20240602", +"revision": "20240609", "rootUrl": "https://youtubeanalytics.googleapis.com/", "schemas": { "EmptyResponse": { diff --git a/googleapiclient/discovery_cache/documents/youtubereporting.v1.json b/googleapiclient/discovery_cache/documents/youtubereporting.v1.json index 2e300ac8b51..fa567d87648 100644 --- a/googleapiclient/discovery_cache/documents/youtubereporting.v1.json +++ b/googleapiclient/discovery_cache/documents/youtubereporting.v1.json @@ -411,7 +411,7 @@ } } }, -"revision": "20240602", +"revision": "20240609", "rootUrl": "https://youtubereporting.googleapis.com/", "schemas": { "Empty": { diff --git a/googleapiclient/version.py b/googleapiclient/version.py index a9ac4c31ed9..f95eedb3478 100644 --- a/googleapiclient/version.py +++ b/googleapiclient/version.py @@ -12,4 +12,4 @@ # See the License for the specific language governing permissions and # limitations under the License. -__version__ = "2.132.0" +__version__ = "2.133.0"