diff --git a/google/cloud/dialogflow_v2/services/agents/async_client.py b/google/cloud/dialogflow_v2/services/agents/async_client.py index 6991f78e4..0c6102e66 100644 --- a/google/cloud/dialogflow_v2/services/agents/async_client.py +++ b/google/cloud/dialogflow_v2/services/agents/async_client.py @@ -482,6 +482,16 @@ async def train_agent( ) -> operation_async.AsyncOperation: r"""Trains the specified agent. + This method is a `long-running + operation `__. + The returned ``Operation`` type has the following + method-specific fields: + + - ``metadata``: An empty `Struct + message `__ + - ``response``: An `Empty + message `__ + Note: You should always train an agent prior to sending it queries. See the `training documentation `__. @@ -578,6 +588,16 @@ async def export_agent( ) -> operation_async.AsyncOperation: r"""Exports the specified agent to a ZIP file. + This method is a `long-running + operation `__. + The returned ``Operation`` type has the following + method-specific fields: + + - ``metadata``: An empty `Struct + message `__ + - ``response``: + [ExportAgentResponse][google.cloud.dialogflow.v2.ExportAgentResponse] + Args: request (:class:`google.cloud.dialogflow_v2.types.ExportAgentRequest`): The request object. The request message for @@ -671,9 +691,18 @@ async def import_agent( and wait for the operation it returns in order to train explicitly. - An operation which tracks when importing is complete. It only - tracks when the draft agent is updated not when it is done - training. + This method is a `long-running + operation `__. + The returned ``Operation`` type has the following + method-specific fields: + + - ``metadata``: An empty `Struct + message `__ + - ``response``: An `Empty + message `__ + + The operation only tracks when importing is complete, not when + it is done training. Note: You should always train an agent prior to sending it queries. See the `training @@ -758,9 +787,18 @@ async def restore_agent( and wait for the operation it returns in order to train explicitly. - An operation which tracks when restoring is complete. It only - tracks when the draft agent is updated not when it is done - training. + This method is a `long-running + operation `__. + The returned ``Operation`` type has the following + method-specific fields: + + - ``metadata``: An empty `Struct + message `__ + - ``response``: An `Empty + message `__ + + The operation only tracks when restoring is complete, not when + it is done training. Note: You should always train an agent prior to sending it queries. See the `training diff --git a/google/cloud/dialogflow_v2/services/agents/client.py b/google/cloud/dialogflow_v2/services/agents/client.py index df852f3f8..7daa6a8ff 100644 --- a/google/cloud/dialogflow_v2/services/agents/client.py +++ b/google/cloud/dialogflow_v2/services/agents/client.py @@ -674,6 +674,16 @@ def train_agent( ) -> operation.Operation: r"""Trains the specified agent. + This method is a `long-running + operation `__. + The returned ``Operation`` type has the following + method-specific fields: + + - ``metadata``: An empty `Struct + message `__ + - ``response``: An `Empty + message `__ + Note: You should always train an agent prior to sending it queries. See the `training documentation `__. @@ -770,6 +780,16 @@ def export_agent( ) -> operation.Operation: r"""Exports the specified agent to a ZIP file. + This method is a `long-running + operation `__. + The returned ``Operation`` type has the following + method-specific fields: + + - ``metadata``: An empty `Struct + message `__ + - ``response``: + [ExportAgentResponse][google.cloud.dialogflow.v2.ExportAgentResponse] + Args: request (google.cloud.dialogflow_v2.types.ExportAgentRequest): The request object. The request message for @@ -863,9 +883,18 @@ def import_agent( and wait for the operation it returns in order to train explicitly. - An operation which tracks when importing is complete. It only - tracks when the draft agent is updated not when it is done - training. + This method is a `long-running + operation `__. + The returned ``Operation`` type has the following + method-specific fields: + + - ``metadata``: An empty `Struct + message `__ + - ``response``: An `Empty + message `__ + + The operation only tracks when importing is complete, not when + it is done training. Note: You should always train an agent prior to sending it queries. See the `training @@ -951,9 +980,18 @@ def restore_agent( and wait for the operation it returns in order to train explicitly. - An operation which tracks when restoring is complete. It only - tracks when the draft agent is updated not when it is done - training. + This method is a `long-running + operation `__. + The returned ``Operation`` type has the following + method-specific fields: + + - ``metadata``: An empty `Struct + message `__ + - ``response``: An `Empty + message `__ + + The operation only tracks when restoring is complete, not when + it is done training. Note: You should always train an agent prior to sending it queries. See the `training diff --git a/google/cloud/dialogflow_v2/services/agents/transports/grpc.py b/google/cloud/dialogflow_v2/services/agents/transports/grpc.py index 3029b8951..ae2f3fff5 100644 --- a/google/cloud/dialogflow_v2/services/agents/transports/grpc.py +++ b/google/cloud/dialogflow_v2/services/agents/transports/grpc.py @@ -361,6 +361,16 @@ def train_agent( Trains the specified agent. + This method is a `long-running + operation `__. + The returned ``Operation`` type has the following + method-specific fields: + + - ``metadata``: An empty `Struct + message `__ + - ``response``: An `Empty + message `__ + Note: You should always train an agent prior to sending it queries. See the `training documentation `__. @@ -391,6 +401,16 @@ def export_agent( Exports the specified agent to a ZIP file. + This method is a `long-running + operation `__. + The returned ``Operation`` type has the following + method-specific fields: + + - ``metadata``: An empty `Struct + message `__ + - ``response``: + [ExportAgentResponse][google.cloud.dialogflow.v2.ExportAgentResponse] + Returns: Callable[[~.ExportAgentRequest], ~.Operation]: @@ -428,9 +448,18 @@ def import_agent( and wait for the operation it returns in order to train explicitly. - An operation which tracks when importing is complete. It only - tracks when the draft agent is updated not when it is done - training. + This method is a `long-running + operation `__. + The returned ``Operation`` type has the following + method-specific fields: + + - ``metadata``: An empty `Struct + message `__ + - ``response``: An `Empty + message `__ + + The operation only tracks when importing is complete, not when + it is done training. Note: You should always train an agent prior to sending it queries. See the `training @@ -471,9 +500,18 @@ def restore_agent( and wait for the operation it returns in order to train explicitly. - An operation which tracks when restoring is complete. It only - tracks when the draft agent is updated not when it is done - training. + This method is a `long-running + operation `__. + The returned ``Operation`` type has the following + method-specific fields: + + - ``metadata``: An empty `Struct + message `__ + - ``response``: An `Empty + message `__ + + The operation only tracks when restoring is complete, not when + it is done training. Note: You should always train an agent prior to sending it queries. See the `training diff --git a/google/cloud/dialogflow_v2/services/agents/transports/grpc_asyncio.py b/google/cloud/dialogflow_v2/services/agents/transports/grpc_asyncio.py index ca35e7761..a8d59018b 100644 --- a/google/cloud/dialogflow_v2/services/agents/transports/grpc_asyncio.py +++ b/google/cloud/dialogflow_v2/services/agents/transports/grpc_asyncio.py @@ -370,6 +370,16 @@ def train_agent( Trains the specified agent. + This method is a `long-running + operation `__. + The returned ``Operation`` type has the following + method-specific fields: + + - ``metadata``: An empty `Struct + message `__ + - ``response``: An `Empty + message `__ + Note: You should always train an agent prior to sending it queries. See the `training documentation `__. @@ -400,6 +410,16 @@ def export_agent( Exports the specified agent to a ZIP file. + This method is a `long-running + operation `__. + The returned ``Operation`` type has the following + method-specific fields: + + - ``metadata``: An empty `Struct + message `__ + - ``response``: + [ExportAgentResponse][google.cloud.dialogflow.v2.ExportAgentResponse] + Returns: Callable[[~.ExportAgentRequest], Awaitable[~.Operation]]: @@ -437,9 +457,18 @@ def import_agent( and wait for the operation it returns in order to train explicitly. - An operation which tracks when importing is complete. It only - tracks when the draft agent is updated not when it is done - training. + This method is a `long-running + operation `__. + The returned ``Operation`` type has the following + method-specific fields: + + - ``metadata``: An empty `Struct + message `__ + - ``response``: An `Empty + message `__ + + The operation only tracks when importing is complete, not when + it is done training. Note: You should always train an agent prior to sending it queries. See the `training @@ -480,9 +509,18 @@ def restore_agent( and wait for the operation it returns in order to train explicitly. - An operation which tracks when restoring is complete. It only - tracks when the draft agent is updated not when it is done - training. + This method is a `long-running + operation `__. + The returned ``Operation`` type has the following + method-specific fields: + + - ``metadata``: An empty `Struct + message `__ + - ``response``: An `Empty + message `__ + + The operation only tracks when restoring is complete, not when + it is done training. Note: You should always train an agent prior to sending it queries. See the `training diff --git a/google/cloud/dialogflow_v2/services/documents/async_client.py b/google/cloud/dialogflow_v2/services/documents/async_client.py index 4eb8d9ce8..5290615b6 100644 --- a/google/cloud/dialogflow_v2/services/documents/async_client.py +++ b/google/cloud/dialogflow_v2/services/documents/async_client.py @@ -334,9 +334,14 @@ async def create_document( ) -> operation_async.AsyncOperation: r"""Creates a new document. - Operation + This method is a `long-running + operation `__. + The returned ``Operation`` type has the following + method-specific fields: + + - ``metadata``: + [KnowledgeOperationMetadata][google.cloud.dialogflow.v2.KnowledgeOperationMetadata] + - ``response``: [Document][google.cloud.dialogflow.v2.Document] Args: request (:class:`google.cloud.dialogflow_v2.types.CreateDocumentRequest`): @@ -436,9 +441,15 @@ async def delete_document( ) -> operation_async.AsyncOperation: r"""Deletes the specified document. - Operation + This method is a `long-running + operation `__. + The returned ``Operation`` type has the following + method-specific fields: + + - ``metadata``: + [KnowledgeOperationMetadata][google.cloud.dialogflow.v2.KnowledgeOperationMetadata] + - ``response``: An `Empty + message `__ Args: request (:class:`google.cloud.dialogflow_v2.types.DeleteDocumentRequest`): @@ -533,9 +544,14 @@ async def update_document( ) -> operation_async.AsyncOperation: r"""Updates the specified document. - Operation + This method is a `long-running + operation `__. + The returned ``Operation`` type has the following + method-specific fields: + + - ``metadata``: + [KnowledgeOperationMetadata][google.cloud.dialogflow.v2.KnowledgeOperationMetadata] + - ``response``: [Document][google.cloud.dialogflow.v2.Document] Args: request (:class:`google.cloud.dialogflow_v2.types.UpdateDocumentRequest`): @@ -642,13 +658,18 @@ async def reload_document( document has not changed, there still may be side effects because of internal implementation changes. + This method is a `long-running + operation `__. + The returned ``Operation`` type has the following + method-specific fields: + + - ``metadata``: + [KnowledgeOperationMetadata][google.cloud.dialogflow.v2.KnowledgeOperationMetadata] + - ``response``: [Document][google.cloud.dialogflow.v2.Document] + Note: The ``projects.agent.knowledgeBases.documents`` resource is deprecated; only use ``projects.knowledgeBases.documents``. - Operation - Args: request (:class:`google.cloud.dialogflow_v2.types.ReloadDocumentRequest`): The request object. Request message for diff --git a/google/cloud/dialogflow_v2/services/documents/client.py b/google/cloud/dialogflow_v2/services/documents/client.py index b4539a5e8..3476f2f7f 100644 --- a/google/cloud/dialogflow_v2/services/documents/client.py +++ b/google/cloud/dialogflow_v2/services/documents/client.py @@ -527,9 +527,14 @@ def create_document( ) -> operation.Operation: r"""Creates a new document. - Operation + This method is a `long-running + operation `__. + The returned ``Operation`` type has the following + method-specific fields: + + - ``metadata``: + [KnowledgeOperationMetadata][google.cloud.dialogflow.v2.KnowledgeOperationMetadata] + - ``response``: [Document][google.cloud.dialogflow.v2.Document] Args: request (google.cloud.dialogflow_v2.types.CreateDocumentRequest): @@ -629,9 +634,15 @@ def delete_document( ) -> operation.Operation: r"""Deletes the specified document. - Operation + This method is a `long-running + operation `__. + The returned ``Operation`` type has the following + method-specific fields: + + - ``metadata``: + [KnowledgeOperationMetadata][google.cloud.dialogflow.v2.KnowledgeOperationMetadata] + - ``response``: An `Empty + message `__ Args: request (google.cloud.dialogflow_v2.types.DeleteDocumentRequest): @@ -726,9 +737,14 @@ def update_document( ) -> operation.Operation: r"""Updates the specified document. - Operation + This method is a `long-running + operation `__. + The returned ``Operation`` type has the following + method-specific fields: + + - ``metadata``: + [KnowledgeOperationMetadata][google.cloud.dialogflow.v2.KnowledgeOperationMetadata] + - ``response``: [Document][google.cloud.dialogflow.v2.Document] Args: request (google.cloud.dialogflow_v2.types.UpdateDocumentRequest): @@ -835,13 +851,18 @@ def reload_document( document has not changed, there still may be side effects because of internal implementation changes. + This method is a `long-running + operation `__. + The returned ``Operation`` type has the following + method-specific fields: + + - ``metadata``: + [KnowledgeOperationMetadata][google.cloud.dialogflow.v2.KnowledgeOperationMetadata] + - ``response``: [Document][google.cloud.dialogflow.v2.Document] + Note: The ``projects.agent.knowledgeBases.documents`` resource is deprecated; only use ``projects.knowledgeBases.documents``. - Operation - Args: request (google.cloud.dialogflow_v2.types.ReloadDocumentRequest): The request object. Request message for diff --git a/google/cloud/dialogflow_v2/services/documents/transports/grpc.py b/google/cloud/dialogflow_v2/services/documents/transports/grpc.py index c92335722..45e865f87 100644 --- a/google/cloud/dialogflow_v2/services/documents/transports/grpc.py +++ b/google/cloud/dialogflow_v2/services/documents/transports/grpc.py @@ -305,9 +305,14 @@ def create_document( Creates a new document. - Operation + This method is a `long-running + operation `__. + The returned ``Operation`` type has the following + method-specific fields: + + - ``metadata``: + [KnowledgeOperationMetadata][google.cloud.dialogflow.v2.KnowledgeOperationMetadata] + - ``response``: [Document][google.cloud.dialogflow.v2.Document] Returns: Callable[[~.CreateDocumentRequest], @@ -335,9 +340,15 @@ def delete_document( Deletes the specified document. - Operation + This method is a `long-running + operation `__. + The returned ``Operation`` type has the following + method-specific fields: + + - ``metadata``: + [KnowledgeOperationMetadata][google.cloud.dialogflow.v2.KnowledgeOperationMetadata] + - ``response``: An `Empty + message `__ Returns: Callable[[~.DeleteDocumentRequest], @@ -365,9 +376,14 @@ def update_document( Updates the specified document. - Operation + This method is a `long-running + operation `__. + The returned ``Operation`` type has the following + method-specific fields: + + - ``metadata``: + [KnowledgeOperationMetadata][google.cloud.dialogflow.v2.KnowledgeOperationMetadata] + - ``response``: [Document][google.cloud.dialogflow.v2.Document] Returns: Callable[[~.UpdateDocumentRequest], @@ -399,13 +415,18 @@ def reload_document( document has not changed, there still may be side effects because of internal implementation changes. + This method is a `long-running + operation `__. + The returned ``Operation`` type has the following + method-specific fields: + + - ``metadata``: + [KnowledgeOperationMetadata][google.cloud.dialogflow.v2.KnowledgeOperationMetadata] + - ``response``: [Document][google.cloud.dialogflow.v2.Document] + Note: The ``projects.agent.knowledgeBases.documents`` resource is deprecated; only use ``projects.knowledgeBases.documents``. - Operation - Returns: Callable[[~.ReloadDocumentRequest], ~.Operation]: diff --git a/google/cloud/dialogflow_v2/services/documents/transports/grpc_asyncio.py b/google/cloud/dialogflow_v2/services/documents/transports/grpc_asyncio.py index 1ffc2d5e4..7300d06af 100644 --- a/google/cloud/dialogflow_v2/services/documents/transports/grpc_asyncio.py +++ b/google/cloud/dialogflow_v2/services/documents/transports/grpc_asyncio.py @@ -314,9 +314,14 @@ def create_document( Creates a new document. - Operation + This method is a `long-running + operation `__. + The returned ``Operation`` type has the following + method-specific fields: + + - ``metadata``: + [KnowledgeOperationMetadata][google.cloud.dialogflow.v2.KnowledgeOperationMetadata] + - ``response``: [Document][google.cloud.dialogflow.v2.Document] Returns: Callable[[~.CreateDocumentRequest], @@ -346,9 +351,15 @@ def delete_document( Deletes the specified document. - Operation + This method is a `long-running + operation `__. + The returned ``Operation`` type has the following + method-specific fields: + + - ``metadata``: + [KnowledgeOperationMetadata][google.cloud.dialogflow.v2.KnowledgeOperationMetadata] + - ``response``: An `Empty + message `__ Returns: Callable[[~.DeleteDocumentRequest], @@ -378,9 +389,14 @@ def update_document( Updates the specified document. - Operation + This method is a `long-running + operation `__. + The returned ``Operation`` type has the following + method-specific fields: + + - ``metadata``: + [KnowledgeOperationMetadata][google.cloud.dialogflow.v2.KnowledgeOperationMetadata] + - ``response``: [Document][google.cloud.dialogflow.v2.Document] Returns: Callable[[~.UpdateDocumentRequest], @@ -414,13 +430,18 @@ def reload_document( document has not changed, there still may be side effects because of internal implementation changes. + This method is a `long-running + operation `__. + The returned ``Operation`` type has the following + method-specific fields: + + - ``metadata``: + [KnowledgeOperationMetadata][google.cloud.dialogflow.v2.KnowledgeOperationMetadata] + - ``response``: [Document][google.cloud.dialogflow.v2.Document] + Note: The ``projects.agent.knowledgeBases.documents`` resource is deprecated; only use ``projects.knowledgeBases.documents``. - Operation - Returns: Callable[[~.ReloadDocumentRequest], Awaitable[~.Operation]]: diff --git a/google/cloud/dialogflow_v2/services/entity_types/async_client.py b/google/cloud/dialogflow_v2/services/entity_types/async_client.py index 42f3f2e60..3ad711d39 100644 --- a/google/cloud/dialogflow_v2/services/entity_types/async_client.py +++ b/google/cloud/dialogflow_v2/services/entity_types/async_client.py @@ -643,6 +643,16 @@ async def batch_update_entity_types( ) -> operation_async.AsyncOperation: r"""Updates/Creates multiple entity types in the specified agent. + This method is a `long-running + operation `__. + The returned ``Operation`` type has the following + method-specific fields: + + - ``metadata``: An empty `Struct + message `__ + - ``response``: + [BatchUpdateEntityTypesResponse][google.cloud.dialogflow.v2.BatchUpdateEntityTypesResponse] + Note: You should always train an agent prior to sending it queries. See the `training documentation `__. @@ -710,6 +720,16 @@ async def batch_delete_entity_types( ) -> operation_async.AsyncOperation: r"""Deletes entity types in the specified agent. + This method is a `long-running + operation `__. + The returned ``Operation`` type has the following + method-specific fields: + + - ``metadata``: An empty `Struct + message `__ + - ``response``: An `Empty + message `__ + Note: You should always train an agent prior to sending it queries. See the `training documentation `__. @@ -817,6 +837,16 @@ async def batch_create_entities( ) -> operation_async.AsyncOperation: r"""Creates multiple new entities in the specified entity type. + This method is a `long-running + operation `__. + The returned ``Operation`` type has the following + method-specific fields: + + - ``metadata``: An empty `Struct + message `__ + - ``response``: An `Empty + message `__ + Note: You should always train an agent prior to sending it queries. See the `training documentation `__. @@ -937,6 +967,16 @@ async def batch_update_entities( type. This method does not affect entities in the entity type that aren't explicitly specified in the request. + This method is a `long-running + operation `__. + The returned ``Operation`` type has the following + method-specific fields: + + - ``metadata``: An empty `Struct + message `__ + - ``response``: An `Empty + message `__ + Note: You should always train an agent prior to sending it queries. See the `training documentation `__. @@ -1057,6 +1097,16 @@ async def batch_delete_entities( ) -> operation_async.AsyncOperation: r"""Deletes entities in the specified entity type. + This method is a `long-running + operation `__. + The returned ``Operation`` type has the following + method-specific fields: + + - ``metadata``: An empty `Struct + message `__ + - ``response``: An `Empty + message `__ + Note: You should always train an agent prior to sending it queries. See the `training documentation `__. diff --git a/google/cloud/dialogflow_v2/services/entity_types/client.py b/google/cloud/dialogflow_v2/services/entity_types/client.py index 9116efc5f..ec063c017 100644 --- a/google/cloud/dialogflow_v2/services/entity_types/client.py +++ b/google/cloud/dialogflow_v2/services/entity_types/client.py @@ -833,6 +833,16 @@ def batch_update_entity_types( ) -> operation.Operation: r"""Updates/Creates multiple entity types in the specified agent. + This method is a `long-running + operation `__. + The returned ``Operation`` type has the following + method-specific fields: + + - ``metadata``: An empty `Struct + message `__ + - ``response``: + [BatchUpdateEntityTypesResponse][google.cloud.dialogflow.v2.BatchUpdateEntityTypesResponse] + Note: You should always train an agent prior to sending it queries. See the `training documentation `__. @@ -903,6 +913,16 @@ def batch_delete_entity_types( ) -> operation.Operation: r"""Deletes entity types in the specified agent. + This method is a `long-running + operation `__. + The returned ``Operation`` type has the following + method-specific fields: + + - ``metadata``: An empty `Struct + message `__ + - ``response``: An `Empty + message `__ + Note: You should always train an agent prior to sending it queries. See the `training documentation `__. @@ -1012,6 +1032,16 @@ def batch_create_entities( ) -> operation.Operation: r"""Creates multiple new entities in the specified entity type. + This method is a `long-running + operation `__. + The returned ``Operation`` type has the following + method-specific fields: + + - ``metadata``: An empty `Struct + message `__ + - ``response``: An `Empty + message `__ + Note: You should always train an agent prior to sending it queries. See the `training documentation `__. @@ -1132,6 +1162,16 @@ def batch_update_entities( type. This method does not affect entities in the entity type that aren't explicitly specified in the request. + This method is a `long-running + operation `__. + The returned ``Operation`` type has the following + method-specific fields: + + - ``metadata``: An empty `Struct + message `__ + - ``response``: An `Empty + message `__ + Note: You should always train an agent prior to sending it queries. See the `training documentation `__. @@ -1252,6 +1292,16 @@ def batch_delete_entities( ) -> operation.Operation: r"""Deletes entities in the specified entity type. + This method is a `long-running + operation `__. + The returned ``Operation`` type has the following + method-specific fields: + + - ``metadata``: An empty `Struct + message `__ + - ``response``: An `Empty + message `__ + Note: You should always train an agent prior to sending it queries. See the `training documentation `__. diff --git a/google/cloud/dialogflow_v2/services/entity_types/transports/grpc.py b/google/cloud/dialogflow_v2/services/entity_types/transports/grpc.py index 10432a288..2a1ecabbc 100644 --- a/google/cloud/dialogflow_v2/services/entity_types/transports/grpc.py +++ b/google/cloud/dialogflow_v2/services/entity_types/transports/grpc.py @@ -404,6 +404,16 @@ def batch_update_entity_types( Updates/Creates multiple entity types in the specified agent. + This method is a `long-running + operation `__. + The returned ``Operation`` type has the following + method-specific fields: + + - ``metadata``: An empty `Struct + message `__ + - ``response``: + [BatchUpdateEntityTypesResponse][google.cloud.dialogflow.v2.BatchUpdateEntityTypesResponse] + Note: You should always train an agent prior to sending it queries. See the `training documentation `__. @@ -436,6 +446,16 @@ def batch_delete_entity_types( Deletes entity types in the specified agent. + This method is a `long-running + operation `__. + The returned ``Operation`` type has the following + method-specific fields: + + - ``metadata``: An empty `Struct + message `__ + - ``response``: An `Empty + message `__ + Note: You should always train an agent prior to sending it queries. See the `training documentation `__. @@ -466,6 +486,16 @@ def batch_create_entities( Creates multiple new entities in the specified entity type. + This method is a `long-running + operation `__. + The returned ``Operation`` type has the following + method-specific fields: + + - ``metadata``: An empty `Struct + message `__ + - ``response``: An `Empty + message `__ + Note: You should always train an agent prior to sending it queries. See the `training documentation `__. @@ -498,6 +528,16 @@ def batch_update_entities( type. This method does not affect entities in the entity type that aren't explicitly specified in the request. + This method is a `long-running + operation `__. + The returned ``Operation`` type has the following + method-specific fields: + + - ``metadata``: An empty `Struct + message `__ + - ``response``: An `Empty + message `__ + Note: You should always train an agent prior to sending it queries. See the `training documentation `__. @@ -528,6 +568,16 @@ def batch_delete_entities( Deletes entities in the specified entity type. + This method is a `long-running + operation `__. + The returned ``Operation`` type has the following + method-specific fields: + + - ``metadata``: An empty `Struct + message `__ + - ``response``: An `Empty + message `__ + Note: You should always train an agent prior to sending it queries. See the `training documentation `__. diff --git a/google/cloud/dialogflow_v2/services/entity_types/transports/grpc_asyncio.py b/google/cloud/dialogflow_v2/services/entity_types/transports/grpc_asyncio.py index 28f630db5..7c8024396 100644 --- a/google/cloud/dialogflow_v2/services/entity_types/transports/grpc_asyncio.py +++ b/google/cloud/dialogflow_v2/services/entity_types/transports/grpc_asyncio.py @@ -412,6 +412,16 @@ def batch_update_entity_types( Updates/Creates multiple entity types in the specified agent. + This method is a `long-running + operation `__. + The returned ``Operation`` type has the following + method-specific fields: + + - ``metadata``: An empty `Struct + message `__ + - ``response``: + [BatchUpdateEntityTypesResponse][google.cloud.dialogflow.v2.BatchUpdateEntityTypesResponse] + Note: You should always train an agent prior to sending it queries. See the `training documentation `__. @@ -444,6 +454,16 @@ def batch_delete_entity_types( Deletes entity types in the specified agent. + This method is a `long-running + operation `__. + The returned ``Operation`` type has the following + method-specific fields: + + - ``metadata``: An empty `Struct + message `__ + - ``response``: An `Empty + message `__ + Note: You should always train an agent prior to sending it queries. See the `training documentation `__. @@ -476,6 +496,16 @@ def batch_create_entities( Creates multiple new entities in the specified entity type. + This method is a `long-running + operation `__. + The returned ``Operation`` type has the following + method-specific fields: + + - ``metadata``: An empty `Struct + message `__ + - ``response``: An `Empty + message `__ + Note: You should always train an agent prior to sending it queries. See the `training documentation `__. @@ -510,6 +540,16 @@ def batch_update_entities( type. This method does not affect entities in the entity type that aren't explicitly specified in the request. + This method is a `long-running + operation `__. + The returned ``Operation`` type has the following + method-specific fields: + + - ``metadata``: An empty `Struct + message `__ + - ``response``: An `Empty + message `__ + Note: You should always train an agent prior to sending it queries. See the `training documentation `__. @@ -542,6 +582,16 @@ def batch_delete_entities( Deletes entities in the specified entity type. + This method is a `long-running + operation `__. + The returned ``Operation`` type has the following + method-specific fields: + + - ``metadata``: An empty `Struct + message `__ + - ``response``: An `Empty + message `__ + Note: You should always train an agent prior to sending it queries. See the `training documentation `__. diff --git a/google/cloud/dialogflow_v2/services/intents/async_client.py b/google/cloud/dialogflow_v2/services/intents/async_client.py index 9f75c3f06..6f175859d 100644 --- a/google/cloud/dialogflow_v2/services/intents/async_client.py +++ b/google/cloud/dialogflow_v2/services/intents/async_client.py @@ -654,6 +654,16 @@ async def batch_update_intents( ) -> operation_async.AsyncOperation: r"""Updates/Creates multiple intents in the specified agent. + This method is a `long-running + operation `__. + The returned ``Operation`` type has the following + method-specific fields: + + - ``metadata``: An empty `Struct + message `__ + - ``response``: + [BatchUpdateIntentsResponse][google.cloud.dialogflow.v2.BatchUpdateIntentsResponse] + Note: You should always train an agent prior to sending it queries. See the `training documentation `__. @@ -763,6 +773,16 @@ async def batch_delete_intents( ) -> operation_async.AsyncOperation: r"""Deletes intents in the specified agent. + This method is a `long-running + operation `__. + The returned ``Operation`` type has the following + method-specific fields: + + - ``metadata``: An empty `Struct + message `__ + - ``response``: An `Empty + message `__ + Note: You should always train an agent prior to sending it queries. See the `training documentation `__. diff --git a/google/cloud/dialogflow_v2/services/intents/client.py b/google/cloud/dialogflow_v2/services/intents/client.py index fbc3cfa49..861cb24cc 100644 --- a/google/cloud/dialogflow_v2/services/intents/client.py +++ b/google/cloud/dialogflow_v2/services/intents/client.py @@ -860,6 +860,16 @@ def batch_update_intents( ) -> operation.Operation: r"""Updates/Creates multiple intents in the specified agent. + This method is a `long-running + operation `__. + The returned ``Operation`` type has the following + method-specific fields: + + - ``metadata``: An empty `Struct + message `__ + - ``response``: + [BatchUpdateIntentsResponse][google.cloud.dialogflow.v2.BatchUpdateIntentsResponse] + Note: You should always train an agent prior to sending it queries. See the `training documentation `__. @@ -969,6 +979,16 @@ def batch_delete_intents( ) -> operation.Operation: r"""Deletes intents in the specified agent. + This method is a `long-running + operation `__. + The returned ``Operation`` type has the following + method-specific fields: + + - ``metadata``: An empty `Struct + message `__ + - ``response``: An `Empty + message `__ + Note: You should always train an agent prior to sending it queries. See the `training documentation `__. diff --git a/google/cloud/dialogflow_v2/services/intents/transports/grpc.py b/google/cloud/dialogflow_v2/services/intents/transports/grpc.py index f58bd813a..89624d701 100644 --- a/google/cloud/dialogflow_v2/services/intents/transports/grpc.py +++ b/google/cloud/dialogflow_v2/services/intents/transports/grpc.py @@ -392,6 +392,16 @@ def batch_update_intents( Updates/Creates multiple intents in the specified agent. + This method is a `long-running + operation `__. + The returned ``Operation`` type has the following + method-specific fields: + + - ``metadata``: An empty `Struct + message `__ + - ``response``: + [BatchUpdateIntentsResponse][google.cloud.dialogflow.v2.BatchUpdateIntentsResponse] + Note: You should always train an agent prior to sending it queries. See the `training documentation `__. @@ -422,6 +432,16 @@ def batch_delete_intents( Deletes intents in the specified agent. + This method is a `long-running + operation `__. + The returned ``Operation`` type has the following + method-specific fields: + + - ``metadata``: An empty `Struct + message `__ + - ``response``: An `Empty + message `__ + Note: You should always train an agent prior to sending it queries. See the `training documentation `__. diff --git a/google/cloud/dialogflow_v2/services/intents/transports/grpc_asyncio.py b/google/cloud/dialogflow_v2/services/intents/transports/grpc_asyncio.py index 9a0d167a0..d609d8ee6 100644 --- a/google/cloud/dialogflow_v2/services/intents/transports/grpc_asyncio.py +++ b/google/cloud/dialogflow_v2/services/intents/transports/grpc_asyncio.py @@ -403,6 +403,16 @@ def batch_update_intents( Updates/Creates multiple intents in the specified agent. + This method is a `long-running + operation `__. + The returned ``Operation`` type has the following + method-specific fields: + + - ``metadata``: An empty `Struct + message `__ + - ``response``: + [BatchUpdateIntentsResponse][google.cloud.dialogflow.v2.BatchUpdateIntentsResponse] + Note: You should always train an agent prior to sending it queries. See the `training documentation `__. @@ -435,6 +445,16 @@ def batch_delete_intents( Deletes intents in the specified agent. + This method is a `long-running + operation `__. + The returned ``Operation`` type has the following + method-specific fields: + + - ``metadata``: An empty `Struct + message `__ + - ``response``: An `Empty + message `__ + Note: You should always train an agent prior to sending it queries. See the `training documentation `__. diff --git a/google/cloud/dialogflow_v2beta1/services/agents/async_client.py b/google/cloud/dialogflow_v2beta1/services/agents/async_client.py index f5f9c4c1a..af66e7981 100644 --- a/google/cloud/dialogflow_v2beta1/services/agents/async_client.py +++ b/google/cloud/dialogflow_v2beta1/services/agents/async_client.py @@ -486,6 +486,16 @@ async def train_agent( ) -> operation_async.AsyncOperation: r"""Trains the specified agent. + This method is a `long-running + operation `__. + The returned ``Operation`` type has the following + method-specific fields: + + - ``metadata``: An empty `Struct + message `__ + - ``response``: An `Empty + message `__ + Note: You should always train an agent prior to sending it queries. See the `training documentation `__. @@ -583,6 +593,16 @@ async def export_agent( ) -> operation_async.AsyncOperation: r"""Exports the specified agent to a ZIP file. + This method is a `long-running + operation `__. + The returned ``Operation`` type has the following + method-specific fields: + + - ``metadata``: An empty `Struct + message `__ + - ``response``: + [ExportAgentResponse][google.cloud.dialogflow.v2beta1.ExportAgentResponse] + Args: request (:class:`google.cloud.dialogflow_v2beta1.types.ExportAgentRequest`): The request object. The request message for @@ -678,6 +698,19 @@ async def import_agent( and wait for the operation it returns in order to train explicitly. + This method is a `long-running + operation `__. + The returned ``Operation`` type has the following + method-specific fields: + + - ``metadata``: An empty `Struct + message `__ + - ``response``: An `Empty + message `__ + + The operation only tracks when importing is complete, not when + it is done training. + Note: You should always train an agent prior to sending it queries. See the `training documentation `__. @@ -762,6 +795,19 @@ async def restore_agent( and wait for the operation it returns in order to train explicitly. + This method is a `long-running + operation `__. + The returned ``Operation`` type has the following + method-specific fields: + + - ``metadata``: An empty `Struct + message `__ + - ``response``: An `Empty + message `__ + + The operation only tracks when restoring is complete, not when + it is done training. + Note: You should always train an agent prior to sending it queries. See the `training documentation `__. diff --git a/google/cloud/dialogflow_v2beta1/services/agents/client.py b/google/cloud/dialogflow_v2beta1/services/agents/client.py index 75f65744f..51bbbcb55 100644 --- a/google/cloud/dialogflow_v2beta1/services/agents/client.py +++ b/google/cloud/dialogflow_v2beta1/services/agents/client.py @@ -678,6 +678,16 @@ def train_agent( ) -> operation.Operation: r"""Trains the specified agent. + This method is a `long-running + operation `__. + The returned ``Operation`` type has the following + method-specific fields: + + - ``metadata``: An empty `Struct + message `__ + - ``response``: An `Empty + message `__ + Note: You should always train an agent prior to sending it queries. See the `training documentation `__. @@ -775,6 +785,16 @@ def export_agent( ) -> operation.Operation: r"""Exports the specified agent to a ZIP file. + This method is a `long-running + operation `__. + The returned ``Operation`` type has the following + method-specific fields: + + - ``metadata``: An empty `Struct + message `__ + - ``response``: + [ExportAgentResponse][google.cloud.dialogflow.v2beta1.ExportAgentResponse] + Args: request (google.cloud.dialogflow_v2beta1.types.ExportAgentRequest): The request object. The request message for @@ -870,6 +890,19 @@ def import_agent( and wait for the operation it returns in order to train explicitly. + This method is a `long-running + operation `__. + The returned ``Operation`` type has the following + method-specific fields: + + - ``metadata``: An empty `Struct + message `__ + - ``response``: An `Empty + message `__ + + The operation only tracks when importing is complete, not when + it is done training. + Note: You should always train an agent prior to sending it queries. See the `training documentation `__. @@ -955,6 +988,19 @@ def restore_agent( and wait for the operation it returns in order to train explicitly. + This method is a `long-running + operation `__. + The returned ``Operation`` type has the following + method-specific fields: + + - ``metadata``: An empty `Struct + message `__ + - ``response``: An `Empty + message `__ + + The operation only tracks when restoring is complete, not when + it is done training. + Note: You should always train an agent prior to sending it queries. See the `training documentation `__. diff --git a/google/cloud/dialogflow_v2beta1/services/agents/transports/grpc.py b/google/cloud/dialogflow_v2beta1/services/agents/transports/grpc.py index d880d6e19..4543c2da7 100644 --- a/google/cloud/dialogflow_v2beta1/services/agents/transports/grpc.py +++ b/google/cloud/dialogflow_v2beta1/services/agents/transports/grpc.py @@ -361,6 +361,16 @@ def train_agent( Trains the specified agent. + This method is a `long-running + operation `__. + The returned ``Operation`` type has the following + method-specific fields: + + - ``metadata``: An empty `Struct + message `__ + - ``response``: An `Empty + message `__ + Note: You should always train an agent prior to sending it queries. See the `training documentation `__. @@ -391,6 +401,16 @@ def export_agent( Exports the specified agent to a ZIP file. + This method is a `long-running + operation `__. + The returned ``Operation`` type has the following + method-specific fields: + + - ``metadata``: An empty `Struct + message `__ + - ``response``: + [ExportAgentResponse][google.cloud.dialogflow.v2beta1.ExportAgentResponse] + Returns: Callable[[~.ExportAgentRequest], ~.Operation]: @@ -429,6 +449,19 @@ def import_agent( and wait for the operation it returns in order to train explicitly. + This method is a `long-running + operation `__. + The returned ``Operation`` type has the following + method-specific fields: + + - ``metadata``: An empty `Struct + message `__ + - ``response``: An `Empty + message `__ + + The operation only tracks when importing is complete, not when + it is done training. + Note: You should always train an agent prior to sending it queries. See the `training documentation `__. @@ -469,6 +502,19 @@ def restore_agent( and wait for the operation it returns in order to train explicitly. + This method is a `long-running + operation `__. + The returned ``Operation`` type has the following + method-specific fields: + + - ``metadata``: An empty `Struct + message `__ + - ``response``: An `Empty + message `__ + + The operation only tracks when restoring is complete, not when + it is done training. + Note: You should always train an agent prior to sending it queries. See the `training documentation `__. diff --git a/google/cloud/dialogflow_v2beta1/services/agents/transports/grpc_asyncio.py b/google/cloud/dialogflow_v2beta1/services/agents/transports/grpc_asyncio.py index 9ca6b6f45..54c2ff3b9 100644 --- a/google/cloud/dialogflow_v2beta1/services/agents/transports/grpc_asyncio.py +++ b/google/cloud/dialogflow_v2beta1/services/agents/transports/grpc_asyncio.py @@ -370,6 +370,16 @@ def train_agent( Trains the specified agent. + This method is a `long-running + operation `__. + The returned ``Operation`` type has the following + method-specific fields: + + - ``metadata``: An empty `Struct + message `__ + - ``response``: An `Empty + message `__ + Note: You should always train an agent prior to sending it queries. See the `training documentation `__. @@ -400,6 +410,16 @@ def export_agent( Exports the specified agent to a ZIP file. + This method is a `long-running + operation `__. + The returned ``Operation`` type has the following + method-specific fields: + + - ``metadata``: An empty `Struct + message `__ + - ``response``: + [ExportAgentResponse][google.cloud.dialogflow.v2beta1.ExportAgentResponse] + Returns: Callable[[~.ExportAgentRequest], Awaitable[~.Operation]]: @@ -438,6 +458,19 @@ def import_agent( and wait for the operation it returns in order to train explicitly. + This method is a `long-running + operation `__. + The returned ``Operation`` type has the following + method-specific fields: + + - ``metadata``: An empty `Struct + message `__ + - ``response``: An `Empty + message `__ + + The operation only tracks when importing is complete, not when + it is done training. + Note: You should always train an agent prior to sending it queries. See the `training documentation `__. @@ -478,6 +511,19 @@ def restore_agent( and wait for the operation it returns in order to train explicitly. + This method is a `long-running + operation `__. + The returned ``Operation`` type has the following + method-specific fields: + + - ``metadata``: An empty `Struct + message `__ + - ``response``: An `Empty + message `__ + + The operation only tracks when restoring is complete, not when + it is done training. + Note: You should always train an agent prior to sending it queries. See the `training documentation `__. diff --git a/google/cloud/dialogflow_v2beta1/services/documents/async_client.py b/google/cloud/dialogflow_v2beta1/services/documents/async_client.py index 9a02c9097..53e4b07d3 100644 --- a/google/cloud/dialogflow_v2beta1/services/documents/async_client.py +++ b/google/cloud/dialogflow_v2beta1/services/documents/async_client.py @@ -340,6 +340,16 @@ async def create_document( ) -> operation_async.AsyncOperation: r"""Creates a new document. + This method is a `long-running + operation `__. + The returned ``Operation`` type has the following + method-specific fields: + + - ``metadata``: + [KnowledgeOperationMetadata][google.cloud.dialogflow.v2beta1.KnowledgeOperationMetadata] + - ``response``: + [Document][google.cloud.dialogflow.v2beta1.Document] + Note: The ``projects.agent.knowledgeBases.documents`` resource is deprecated; only use ``projects.knowledgeBases.documents``. @@ -438,10 +448,19 @@ async def import_documents( timeout: float = None, metadata: Sequence[Tuple[str, str]] = (), ) -> operation_async.AsyncOperation: - r"""Create documents by importing data from external - sources. Dialogflow supports up to 350 documents in each - request. If you try to import more, Dialogflow will - return an error. + r"""Create documents by importing data from external sources. + Dialogflow supports up to 350 documents in each request. If you + try to import more, Dialogflow will return an error. + + This method is a `long-running + operation `__. + The returned ``Operation`` type has the following + method-specific fields: + + - ``metadata``: + [KnowledgeOperationMetadata][google.cloud.dialogflow.v2beta1.KnowledgeOperationMetadata] + - ``response``: + [ImportDocumentsResponse][google.cloud.dialogflow.v2beta1.ImportDocumentsResponse] Args: request (:class:`google.cloud.dialogflow_v2beta1.types.ImportDocumentsRequest`): @@ -505,6 +524,16 @@ async def delete_document( ) -> operation_async.AsyncOperation: r"""Deletes the specified document. + This method is a `long-running + operation `__. + The returned ``Operation`` type has the following + method-specific fields: + + - ``metadata``: + [KnowledgeOperationMetadata][google.cloud.dialogflow.v2beta1.KnowledgeOperationMetadata] + - ``response``: An `Empty + message `__ + Note: The ``projects.agent.knowledgeBases.documents`` resource is deprecated; only use ``projects.knowledgeBases.documents``. @@ -601,6 +630,16 @@ async def update_document( ) -> operation_async.AsyncOperation: r"""Updates the specified document. + This method is a `long-running + operation `__. + The returned ``Operation`` type has the following + method-specific fields: + + - ``metadata``: + [KnowledgeOperationMetadata][google.cloud.dialogflow.v2beta1.KnowledgeOperationMetadata] + - ``response``: + [Document][google.cloud.dialogflow.v2beta1.Document] + Note: The ``projects.agent.knowledgeBases.documents`` resource is deprecated; only use ``projects.knowledgeBases.documents``. @@ -713,6 +752,16 @@ async def reload_document( if the ``import_gcs_custom_metadata`` field is set to true in the request. + This method is a `long-running + operation `__. + The returned ``Operation`` type has the following + method-specific fields: + + - ``metadata``: + [KnowledgeOperationMetadata][google.cloud.dialogflow.v2beta1.KnowledgeOperationMetadata] + - ``response``: + [Document][google.cloud.dialogflow.v2beta1.Document] + Note: The ``projects.agent.knowledgeBases.documents`` resource is deprecated; only use ``projects.knowledgeBases.documents``. diff --git a/google/cloud/dialogflow_v2beta1/services/documents/client.py b/google/cloud/dialogflow_v2beta1/services/documents/client.py index a67aa124c..e4058b3f7 100644 --- a/google/cloud/dialogflow_v2beta1/services/documents/client.py +++ b/google/cloud/dialogflow_v2beta1/services/documents/client.py @@ -533,6 +533,16 @@ def create_document( ) -> operation.Operation: r"""Creates a new document. + This method is a `long-running + operation `__. + The returned ``Operation`` type has the following + method-specific fields: + + - ``metadata``: + [KnowledgeOperationMetadata][google.cloud.dialogflow.v2beta1.KnowledgeOperationMetadata] + - ``response``: + [Document][google.cloud.dialogflow.v2beta1.Document] + Note: The ``projects.agent.knowledgeBases.documents`` resource is deprecated; only use ``projects.knowledgeBases.documents``. @@ -631,10 +641,19 @@ def import_documents( timeout: float = None, metadata: Sequence[Tuple[str, str]] = (), ) -> operation.Operation: - r"""Create documents by importing data from external - sources. Dialogflow supports up to 350 documents in each - request. If you try to import more, Dialogflow will - return an error. + r"""Create documents by importing data from external sources. + Dialogflow supports up to 350 documents in each request. If you + try to import more, Dialogflow will return an error. + + This method is a `long-running + operation `__. + The returned ``Operation`` type has the following + method-specific fields: + + - ``metadata``: + [KnowledgeOperationMetadata][google.cloud.dialogflow.v2beta1.KnowledgeOperationMetadata] + - ``response``: + [ImportDocumentsResponse][google.cloud.dialogflow.v2beta1.ImportDocumentsResponse] Args: request (google.cloud.dialogflow_v2beta1.types.ImportDocumentsRequest): @@ -699,6 +718,16 @@ def delete_document( ) -> operation.Operation: r"""Deletes the specified document. + This method is a `long-running + operation `__. + The returned ``Operation`` type has the following + method-specific fields: + + - ``metadata``: + [KnowledgeOperationMetadata][google.cloud.dialogflow.v2beta1.KnowledgeOperationMetadata] + - ``response``: An `Empty + message `__ + Note: The ``projects.agent.knowledgeBases.documents`` resource is deprecated; only use ``projects.knowledgeBases.documents``. @@ -795,6 +824,16 @@ def update_document( ) -> operation.Operation: r"""Updates the specified document. + This method is a `long-running + operation `__. + The returned ``Operation`` type has the following + method-specific fields: + + - ``metadata``: + [KnowledgeOperationMetadata][google.cloud.dialogflow.v2beta1.KnowledgeOperationMetadata] + - ``response``: + [Document][google.cloud.dialogflow.v2beta1.Document] + Note: The ``projects.agent.knowledgeBases.documents`` resource is deprecated; only use ``projects.knowledgeBases.documents``. @@ -907,6 +946,16 @@ def reload_document( if the ``import_gcs_custom_metadata`` field is set to true in the request. + This method is a `long-running + operation `__. + The returned ``Operation`` type has the following + method-specific fields: + + - ``metadata``: + [KnowledgeOperationMetadata][google.cloud.dialogflow.v2beta1.KnowledgeOperationMetadata] + - ``response``: + [Document][google.cloud.dialogflow.v2beta1.Document] + Note: The ``projects.agent.knowledgeBases.documents`` resource is deprecated; only use ``projects.knowledgeBases.documents``. diff --git a/google/cloud/dialogflow_v2beta1/services/documents/transports/grpc.py b/google/cloud/dialogflow_v2beta1/services/documents/transports/grpc.py index 07671affe..eb0218fe9 100644 --- a/google/cloud/dialogflow_v2beta1/services/documents/transports/grpc.py +++ b/google/cloud/dialogflow_v2beta1/services/documents/transports/grpc.py @@ -310,6 +310,16 @@ def create_document( Creates a new document. + This method is a `long-running + operation `__. + The returned ``Operation`` type has the following + method-specific fields: + + - ``metadata``: + [KnowledgeOperationMetadata][google.cloud.dialogflow.v2beta1.KnowledgeOperationMetadata] + - ``response``: + [Document][google.cloud.dialogflow.v2beta1.Document] + Note: The ``projects.agent.knowledgeBases.documents`` resource is deprecated; only use ``projects.knowledgeBases.documents``. @@ -337,10 +347,19 @@ def import_documents( ) -> Callable[[document.ImportDocumentsRequest], operations_pb2.Operation]: r"""Return a callable for the import documents method over gRPC. - Create documents by importing data from external - sources. Dialogflow supports up to 350 documents in each - request. If you try to import more, Dialogflow will - return an error. + Create documents by importing data from external sources. + Dialogflow supports up to 350 documents in each request. If you + try to import more, Dialogflow will return an error. + + This method is a `long-running + operation `__. + The returned ``Operation`` type has the following + method-specific fields: + + - ``metadata``: + [KnowledgeOperationMetadata][google.cloud.dialogflow.v2beta1.KnowledgeOperationMetadata] + - ``response``: + [ImportDocumentsResponse][google.cloud.dialogflow.v2beta1.ImportDocumentsResponse] Returns: Callable[[~.ImportDocumentsRequest], @@ -368,6 +387,16 @@ def delete_document( Deletes the specified document. + This method is a `long-running + operation `__. + The returned ``Operation`` type has the following + method-specific fields: + + - ``metadata``: + [KnowledgeOperationMetadata][google.cloud.dialogflow.v2beta1.KnowledgeOperationMetadata] + - ``response``: An `Empty + message `__ + Note: The ``projects.agent.knowledgeBases.documents`` resource is deprecated; only use ``projects.knowledgeBases.documents``. @@ -397,6 +426,16 @@ def update_document( Updates the specified document. + This method is a `long-running + operation `__. + The returned ``Operation`` type has the following + method-specific fields: + + - ``metadata``: + [KnowledgeOperationMetadata][google.cloud.dialogflow.v2beta1.KnowledgeOperationMetadata] + - ``response``: + [Document][google.cloud.dialogflow.v2beta1.Document] + Note: The ``projects.agent.knowledgeBases.documents`` resource is deprecated; only use ``projects.knowledgeBases.documents``. @@ -434,6 +473,16 @@ def reload_document( if the ``import_gcs_custom_metadata`` field is set to true in the request. + This method is a `long-running + operation `__. + The returned ``Operation`` type has the following + method-specific fields: + + - ``metadata``: + [KnowledgeOperationMetadata][google.cloud.dialogflow.v2beta1.KnowledgeOperationMetadata] + - ``response``: + [Document][google.cloud.dialogflow.v2beta1.Document] + Note: The ``projects.agent.knowledgeBases.documents`` resource is deprecated; only use ``projects.knowledgeBases.documents``. diff --git a/google/cloud/dialogflow_v2beta1/services/documents/transports/grpc_asyncio.py b/google/cloud/dialogflow_v2beta1/services/documents/transports/grpc_asyncio.py index 6a336b9d1..f62bfe680 100644 --- a/google/cloud/dialogflow_v2beta1/services/documents/transports/grpc_asyncio.py +++ b/google/cloud/dialogflow_v2beta1/services/documents/transports/grpc_asyncio.py @@ -319,6 +319,16 @@ def create_document( Creates a new document. + This method is a `long-running + operation `__. + The returned ``Operation`` type has the following + method-specific fields: + + - ``metadata``: + [KnowledgeOperationMetadata][google.cloud.dialogflow.v2beta1.KnowledgeOperationMetadata] + - ``response``: + [Document][google.cloud.dialogflow.v2beta1.Document] + Note: The ``projects.agent.knowledgeBases.documents`` resource is deprecated; only use ``projects.knowledgeBases.documents``. @@ -348,10 +358,19 @@ def import_documents( ]: r"""Return a callable for the import documents method over gRPC. - Create documents by importing data from external - sources. Dialogflow supports up to 350 documents in each - request. If you try to import more, Dialogflow will - return an error. + Create documents by importing data from external sources. + Dialogflow supports up to 350 documents in each request. If you + try to import more, Dialogflow will return an error. + + This method is a `long-running + operation `__. + The returned ``Operation`` type has the following + method-specific fields: + + - ``metadata``: + [KnowledgeOperationMetadata][google.cloud.dialogflow.v2beta1.KnowledgeOperationMetadata] + - ``response``: + [ImportDocumentsResponse][google.cloud.dialogflow.v2beta1.ImportDocumentsResponse] Returns: Callable[[~.ImportDocumentsRequest], @@ -381,6 +400,16 @@ def delete_document( Deletes the specified document. + This method is a `long-running + operation `__. + The returned ``Operation`` type has the following + method-specific fields: + + - ``metadata``: + [KnowledgeOperationMetadata][google.cloud.dialogflow.v2beta1.KnowledgeOperationMetadata] + - ``response``: An `Empty + message `__ + Note: The ``projects.agent.knowledgeBases.documents`` resource is deprecated; only use ``projects.knowledgeBases.documents``. @@ -412,6 +441,16 @@ def update_document( Updates the specified document. + This method is a `long-running + operation `__. + The returned ``Operation`` type has the following + method-specific fields: + + - ``metadata``: + [KnowledgeOperationMetadata][google.cloud.dialogflow.v2beta1.KnowledgeOperationMetadata] + - ``response``: + [Document][google.cloud.dialogflow.v2beta1.Document] + Note: The ``projects.agent.knowledgeBases.documents`` resource is deprecated; only use ``projects.knowledgeBases.documents``. @@ -451,6 +490,16 @@ def reload_document( if the ``import_gcs_custom_metadata`` field is set to true in the request. + This method is a `long-running + operation `__. + The returned ``Operation`` type has the following + method-specific fields: + + - ``metadata``: + [KnowledgeOperationMetadata][google.cloud.dialogflow.v2beta1.KnowledgeOperationMetadata] + - ``response``: + [Document][google.cloud.dialogflow.v2beta1.Document] + Note: The ``projects.agent.knowledgeBases.documents`` resource is deprecated; only use ``projects.knowledgeBases.documents``. diff --git a/google/cloud/dialogflow_v2beta1/services/entity_types/async_client.py b/google/cloud/dialogflow_v2beta1/services/entity_types/async_client.py index 5142b3df8..4e1f861cc 100644 --- a/google/cloud/dialogflow_v2beta1/services/entity_types/async_client.py +++ b/google/cloud/dialogflow_v2beta1/services/entity_types/async_client.py @@ -666,6 +666,16 @@ async def batch_update_entity_types( ) -> operation_async.AsyncOperation: r"""Updates/Creates multiple entity types in the specified agent. + This method is a `long-running + operation `__. + The returned ``Operation`` type has the following + method-specific fields: + + - ``metadata``: An empty `Struct + message `__ + - ``response``: + [BatchUpdateEntityTypesResponse][google.cloud.dialogflow.v2beta1.BatchUpdateEntityTypesResponse] + Note: You should always train an agent prior to sending it queries. See the `training documentation `__. @@ -733,6 +743,16 @@ async def batch_delete_entity_types( ) -> operation_async.AsyncOperation: r"""Deletes entity types in the specified agent. + This method is a `long-running + operation `__. + The returned ``Operation`` type has the following + method-specific fields: + + - ``metadata``: An empty `Struct + message `__ + - ``response``: An `Empty + message `__ + Note: You should always train an agent prior to sending it queries. See the `training documentation `__. @@ -843,6 +863,16 @@ async def batch_create_entities( ) -> operation_async.AsyncOperation: r"""Creates multiple new entities in the specified entity type. + This method is a `long-running + operation `__. + The returned ``Operation`` type has the following + method-specific fields: + + - ``metadata``: An empty `Struct + message `__ + - ``response``: An `Empty + message `__ + Note: You should always train an agent prior to sending it queries. See the `training documentation `__. @@ -969,6 +999,16 @@ async def batch_update_entities( queries. See the `training documentation `__. + This method is a `long-running + operation `__. + The returned ``Operation`` type has the following + method-specific fields: + + - ``metadata``: An empty `Struct + message `__ + - ``response``: An `Empty + message `__ + Args: request (:class:`google.cloud.dialogflow_v2beta1.types.BatchUpdateEntitiesRequest`): The request object. The request message for @@ -1087,6 +1127,16 @@ async def batch_delete_entities( ) -> operation_async.AsyncOperation: r"""Deletes entities in the specified entity type. + This method is a `long-running + operation `__. + The returned ``Operation`` type has the following + method-specific fields: + + - ``metadata``: An empty `Struct + message `__ + - ``response``: An `Empty + message `__ + Note: You should always train an agent prior to sending it queries. See the `training documentation `__. diff --git a/google/cloud/dialogflow_v2beta1/services/entity_types/client.py b/google/cloud/dialogflow_v2beta1/services/entity_types/client.py index 2db693cca..0cfc745f2 100644 --- a/google/cloud/dialogflow_v2beta1/services/entity_types/client.py +++ b/google/cloud/dialogflow_v2beta1/services/entity_types/client.py @@ -856,6 +856,16 @@ def batch_update_entity_types( ) -> operation.Operation: r"""Updates/Creates multiple entity types in the specified agent. + This method is a `long-running + operation `__. + The returned ``Operation`` type has the following + method-specific fields: + + - ``metadata``: An empty `Struct + message `__ + - ``response``: + [BatchUpdateEntityTypesResponse][google.cloud.dialogflow.v2beta1.BatchUpdateEntityTypesResponse] + Note: You should always train an agent prior to sending it queries. See the `training documentation `__. @@ -926,6 +936,16 @@ def batch_delete_entity_types( ) -> operation.Operation: r"""Deletes entity types in the specified agent. + This method is a `long-running + operation `__. + The returned ``Operation`` type has the following + method-specific fields: + + - ``metadata``: An empty `Struct + message `__ + - ``response``: An `Empty + message `__ + Note: You should always train an agent prior to sending it queries. See the `training documentation `__. @@ -1038,6 +1058,16 @@ def batch_create_entities( ) -> operation.Operation: r"""Creates multiple new entities in the specified entity type. + This method is a `long-running + operation `__. + The returned ``Operation`` type has the following + method-specific fields: + + - ``metadata``: An empty `Struct + message `__ + - ``response``: An `Empty + message `__ + Note: You should always train an agent prior to sending it queries. See the `training documentation `__. @@ -1164,6 +1194,16 @@ def batch_update_entities( queries. See the `training documentation `__. + This method is a `long-running + operation `__. + The returned ``Operation`` type has the following + method-specific fields: + + - ``metadata``: An empty `Struct + message `__ + - ``response``: An `Empty + message `__ + Args: request (google.cloud.dialogflow_v2beta1.types.BatchUpdateEntitiesRequest): The request object. The request message for @@ -1282,6 +1322,16 @@ def batch_delete_entities( ) -> operation.Operation: r"""Deletes entities in the specified entity type. + This method is a `long-running + operation `__. + The returned ``Operation`` type has the following + method-specific fields: + + - ``metadata``: An empty `Struct + message `__ + - ``response``: An `Empty + message `__ + Note: You should always train an agent prior to sending it queries. See the `training documentation `__. diff --git a/google/cloud/dialogflow_v2beta1/services/entity_types/transports/grpc.py b/google/cloud/dialogflow_v2beta1/services/entity_types/transports/grpc.py index d5ff8ffe0..31e019c74 100644 --- a/google/cloud/dialogflow_v2beta1/services/entity_types/transports/grpc.py +++ b/google/cloud/dialogflow_v2beta1/services/entity_types/transports/grpc.py @@ -404,6 +404,16 @@ def batch_update_entity_types( Updates/Creates multiple entity types in the specified agent. + This method is a `long-running + operation `__. + The returned ``Operation`` type has the following + method-specific fields: + + - ``metadata``: An empty `Struct + message `__ + - ``response``: + [BatchUpdateEntityTypesResponse][google.cloud.dialogflow.v2beta1.BatchUpdateEntityTypesResponse] + Note: You should always train an agent prior to sending it queries. See the `training documentation `__. @@ -436,6 +446,16 @@ def batch_delete_entity_types( Deletes entity types in the specified agent. + This method is a `long-running + operation `__. + The returned ``Operation`` type has the following + method-specific fields: + + - ``metadata``: An empty `Struct + message `__ + - ``response``: An `Empty + message `__ + Note: You should always train an agent prior to sending it queries. See the `training documentation `__. @@ -466,6 +486,16 @@ def batch_create_entities( Creates multiple new entities in the specified entity type. + This method is a `long-running + operation `__. + The returned ``Operation`` type has the following + method-specific fields: + + - ``metadata``: An empty `Struct + message `__ + - ``response``: An `Empty + message `__ + Note: You should always train an agent prior to sending it queries. See the `training documentation `__. @@ -502,6 +532,16 @@ def batch_update_entities( queries. See the `training documentation `__. + This method is a `long-running + operation `__. + The returned ``Operation`` type has the following + method-specific fields: + + - ``metadata``: An empty `Struct + message `__ + - ``response``: An `Empty + message `__ + Returns: Callable[[~.BatchUpdateEntitiesRequest], ~.Operation]: @@ -528,6 +568,16 @@ def batch_delete_entities( Deletes entities in the specified entity type. + This method is a `long-running + operation `__. + The returned ``Operation`` type has the following + method-specific fields: + + - ``metadata``: An empty `Struct + message `__ + - ``response``: An `Empty + message `__ + Note: You should always train an agent prior to sending it queries. See the `training documentation `__. diff --git a/google/cloud/dialogflow_v2beta1/services/entity_types/transports/grpc_asyncio.py b/google/cloud/dialogflow_v2beta1/services/entity_types/transports/grpc_asyncio.py index 5e654392f..5796ec3c7 100644 --- a/google/cloud/dialogflow_v2beta1/services/entity_types/transports/grpc_asyncio.py +++ b/google/cloud/dialogflow_v2beta1/services/entity_types/transports/grpc_asyncio.py @@ -412,6 +412,16 @@ def batch_update_entity_types( Updates/Creates multiple entity types in the specified agent. + This method is a `long-running + operation `__. + The returned ``Operation`` type has the following + method-specific fields: + + - ``metadata``: An empty `Struct + message `__ + - ``response``: + [BatchUpdateEntityTypesResponse][google.cloud.dialogflow.v2beta1.BatchUpdateEntityTypesResponse] + Note: You should always train an agent prior to sending it queries. See the `training documentation `__. @@ -444,6 +454,16 @@ def batch_delete_entity_types( Deletes entity types in the specified agent. + This method is a `long-running + operation `__. + The returned ``Operation`` type has the following + method-specific fields: + + - ``metadata``: An empty `Struct + message `__ + - ``response``: An `Empty + message `__ + Note: You should always train an agent prior to sending it queries. See the `training documentation `__. @@ -476,6 +496,16 @@ def batch_create_entities( Creates multiple new entities in the specified entity type. + This method is a `long-running + operation `__. + The returned ``Operation`` type has the following + method-specific fields: + + - ``metadata``: An empty `Struct + message `__ + - ``response``: An `Empty + message `__ + Note: You should always train an agent prior to sending it queries. See the `training documentation `__. @@ -514,6 +544,16 @@ def batch_update_entities( queries. See the `training documentation `__. + This method is a `long-running + operation `__. + The returned ``Operation`` type has the following + method-specific fields: + + - ``metadata``: An empty `Struct + message `__ + - ``response``: An `Empty + message `__ + Returns: Callable[[~.BatchUpdateEntitiesRequest], Awaitable[~.Operation]]: @@ -542,6 +582,16 @@ def batch_delete_entities( Deletes entities in the specified entity type. + This method is a `long-running + operation `__. + The returned ``Operation`` type has the following + method-specific fields: + + - ``metadata``: An empty `Struct + message `__ + - ``response``: An `Empty + message `__ + Note: You should always train an agent prior to sending it queries. See the `training documentation `__. diff --git a/google/cloud/dialogflow_v2beta1/services/intents/async_client.py b/google/cloud/dialogflow_v2beta1/services/intents/async_client.py index 21c61653c..463806566 100644 --- a/google/cloud/dialogflow_v2beta1/services/intents/async_client.py +++ b/google/cloud/dialogflow_v2beta1/services/intents/async_client.py @@ -665,6 +665,16 @@ async def batch_update_intents( ) -> operation_async.AsyncOperation: r"""Updates/Creates multiple intents in the specified agent. + This method is a `long-running + operation `__. + The returned ``Operation`` type has the following + method-specific fields: + + - ``metadata``: An empty `Struct + message `__ + - ``response``: + [BatchUpdateIntentsResponse][google.cloud.dialogflow.v2beta1.BatchUpdateIntentsResponse] + Note: You should always train an agent prior to sending it queries. See the `training documentation `__. @@ -778,6 +788,16 @@ async def batch_delete_intents( ) -> operation_async.AsyncOperation: r"""Deletes intents in the specified agent. + This method is a `long-running + operation `__. + The returned ``Operation`` type has the following + method-specific fields: + + - ``metadata``: An empty `Struct + message `__ + - ``response``: An `Empty + message `__ + Note: You should always train an agent prior to sending it queries. See the `training documentation `__. diff --git a/google/cloud/dialogflow_v2beta1/services/intents/client.py b/google/cloud/dialogflow_v2beta1/services/intents/client.py index 3d49e0d2e..d376d6877 100644 --- a/google/cloud/dialogflow_v2beta1/services/intents/client.py +++ b/google/cloud/dialogflow_v2beta1/services/intents/client.py @@ -871,6 +871,16 @@ def batch_update_intents( ) -> operation.Operation: r"""Updates/Creates multiple intents in the specified agent. + This method is a `long-running + operation `__. + The returned ``Operation`` type has the following + method-specific fields: + + - ``metadata``: An empty `Struct + message `__ + - ``response``: + [BatchUpdateIntentsResponse][google.cloud.dialogflow.v2beta1.BatchUpdateIntentsResponse] + Note: You should always train an agent prior to sending it queries. See the `training documentation `__. @@ -984,6 +994,16 @@ def batch_delete_intents( ) -> operation.Operation: r"""Deletes intents in the specified agent. + This method is a `long-running + operation `__. + The returned ``Operation`` type has the following + method-specific fields: + + - ``metadata``: An empty `Struct + message `__ + - ``response``: An `Empty + message `__ + Note: You should always train an agent prior to sending it queries. See the `training documentation `__. diff --git a/google/cloud/dialogflow_v2beta1/services/intents/transports/grpc.py b/google/cloud/dialogflow_v2beta1/services/intents/transports/grpc.py index 3fc2416c7..9e5615006 100644 --- a/google/cloud/dialogflow_v2beta1/services/intents/transports/grpc.py +++ b/google/cloud/dialogflow_v2beta1/services/intents/transports/grpc.py @@ -393,6 +393,16 @@ def batch_update_intents( Updates/Creates multiple intents in the specified agent. + This method is a `long-running + operation `__. + The returned ``Operation`` type has the following + method-specific fields: + + - ``metadata``: An empty `Struct + message `__ + - ``response``: + [BatchUpdateIntentsResponse][google.cloud.dialogflow.v2beta1.BatchUpdateIntentsResponse] + Note: You should always train an agent prior to sending it queries. See the `training documentation `__. @@ -423,6 +433,16 @@ def batch_delete_intents( Deletes intents in the specified agent. + This method is a `long-running + operation `__. + The returned ``Operation`` type has the following + method-specific fields: + + - ``metadata``: An empty `Struct + message `__ + - ``response``: An `Empty + message `__ + Note: You should always train an agent prior to sending it queries. See the `training documentation `__. diff --git a/google/cloud/dialogflow_v2beta1/services/intents/transports/grpc_asyncio.py b/google/cloud/dialogflow_v2beta1/services/intents/transports/grpc_asyncio.py index dcc780589..228075d62 100644 --- a/google/cloud/dialogflow_v2beta1/services/intents/transports/grpc_asyncio.py +++ b/google/cloud/dialogflow_v2beta1/services/intents/transports/grpc_asyncio.py @@ -404,6 +404,16 @@ def batch_update_intents( Updates/Creates multiple intents in the specified agent. + This method is a `long-running + operation `__. + The returned ``Operation`` type has the following + method-specific fields: + + - ``metadata``: An empty `Struct + message `__ + - ``response``: + [BatchUpdateIntentsResponse][google.cloud.dialogflow.v2beta1.BatchUpdateIntentsResponse] + Note: You should always train an agent prior to sending it queries. See the `training documentation `__. @@ -436,6 +446,16 @@ def batch_delete_intents( Deletes intents in the specified agent. + This method is a `long-running + operation `__. + The returned ``Operation`` type has the following + method-specific fields: + + - ``metadata``: An empty `Struct + message `__ + - ``response``: An `Empty + message `__ + Note: You should always train an agent prior to sending it queries. See the `training documentation `__.