docs: added notes to train agent before sending queries (#111)

PiperOrigin-RevId: 380267079 Source-Link: googleapis/googleapis@01bad53 Source-Link: https://github.com/googleapis/googleapis-gen/commit/5810da64fdeccb8ad0a1b34e2f1cab777d04552a

Author: gcf-owl-bot[bot]

google/cloud/dialogflowcx_v3beta1/services/agents/async_client.py

@@ -354,6 +354,10 @@ async def create_agent(
  ) -> gcdc_agent.Agent:
  r"""Creates an agent in the specified location.
 
+ Note: You should always train a flow prior to sending it
+ queries. See the `training
+ documentation <https://cloud.google.com/dialogflow/cx/docs/concept/training>`__.
+
  Args:
  request (:class:`google.cloud.dialogflowcx_v3beta1.types.CreateAgentRequest`):
  The request object. The request message for
@@ -445,6 +449,10 @@ async def update_agent(
  ) -> gcdc_agent.Agent:
  r"""Updates the specified agent.
 
+ Note: You should always train a flow prior to sending it
+ queries. See the `training
+ documentation <https://cloud.google.com/dialogflow/cx/docs/concept/training>`__.
+
  Args:
  request (:class:`google.cloud.dialogflowcx_v3beta1.types.UpdateAgentRequest`):
  The request object. The request message for
@@ -661,9 +669,14 @@ async def restore_agent(
  metadata: Sequence[Tuple[str, str]] = (),
  ) -> operation_async.AsyncOperation:
  r"""Restores the specified agent from a binary file.
+
  Replaces the current agent with a new one. Note that all
- existing resources in agent (e.g. intents, entity types,
- flows) will be removed.
+ existing resources in agent (e.g. intents, entity types, flows)
+ will be removed.
+
+ Note: You should always train a flow prior to sending it
+ queries. See the `training
+ documentation <https://cloud.google.com/dialogflow/cx/docs/concept/training>`__.
 
  Args:
  request (:class:`google.cloud.dialogflowcx_v3beta1.types.RestoreAgentRequest`):

google/cloud/dialogflowcx_v3beta1/services/agents/client.py

@@ -615,6 +615,10 @@ def create_agent(
  ) -> gcdc_agent.Agent:
  r"""Creates an agent in the specified location.
 
+ Note: You should always train a flow prior to sending it
+ queries. See the `training
+ documentation <https://cloud.google.com/dialogflow/cx/docs/concept/training>`__.
+
  Args:
  request (google.cloud.dialogflowcx_v3beta1.types.CreateAgentRequest):
  The request object. The request message for
@@ -706,6 +710,10 @@ def update_agent(
  ) -> gcdc_agent.Agent:
  r"""Updates the specified agent.
 
+ Note: You should always train a flow prior to sending it
+ queries. See the `training
+ documentation <https://cloud.google.com/dialogflow/cx/docs/concept/training>`__.
+
  Args:
  request (google.cloud.dialogflowcx_v3beta1.types.UpdateAgentRequest):
  The request object. The request message for
@@ -923,9 +931,14 @@ def restore_agent(
  metadata: Sequence[Tuple[str, str]] = (),
  ) -> operation.Operation:
  r"""Restores the specified agent from a binary file.
+
  Replaces the current agent with a new one. Note that all
- existing resources in agent (e.g. intents, entity types,
- flows) will be removed.
+ existing resources in agent (e.g. intents, entity types, flows)
+ will be removed.
+
+ Note: You should always train a flow prior to sending it
+ queries. See the `training
+ documentation <https://cloud.google.com/dialogflow/cx/docs/concept/training>`__.
 
  Args:
  request (google.cloud.dialogflowcx_v3beta1.types.RestoreAgentRequest):

google/cloud/dialogflowcx_v3beta1/services/agents/transports/grpc.py

@@ -300,6 +300,10 @@ def create_agent(
 
  Creates an agent in the specified location.
 
+ Note: You should always train a flow prior to sending it
+ queries. See the `training
+ documentation <https://cloud.google.com/dialogflow/cx/docs/concept/training>`__.
+
  Returns:
  Callable[[~.CreateAgentRequest],
  ~.Agent]:
@@ -326,6 +330,10 @@ def update_agent(
 
  Updates the specified agent.
 
+ Note: You should always train a flow prior to sending it
+ queries. See the `training
+ documentation <https://cloud.google.com/dialogflow/cx/docs/concept/training>`__.
+
  Returns:
  Callable[[~.UpdateAgentRequest],
  ~.Agent]:
@@ -401,9 +409,14 @@ def restore_agent(
  r"""Return a callable for the restore agent method over gRPC.
 
  Restores the specified agent from a binary file.
+
  Replaces the current agent with a new one. Note that all
- existing resources in agent (e.g. intents, entity types,
- flows) will be removed.
+ existing resources in agent (e.g. intents, entity types, flows)
+ will be removed.
+
+ Note: You should always train a flow prior to sending it
+ queries. See the `training
+ documentation <https://cloud.google.com/dialogflow/cx/docs/concept/training>`__.
 
  Returns:
  Callable[[~.RestoreAgentRequest],

google/cloud/dialogflowcx_v3beta1/services/agents/transports/grpc_asyncio.py

@@ -305,6 +305,10 @@ def create_agent(
 
  Creates an agent in the specified location.
 
+ Note: You should always train a flow prior to sending it
+ queries. See the `training
+ documentation <https://cloud.google.com/dialogflow/cx/docs/concept/training>`__.
+
  Returns:
  Callable[[~.CreateAgentRequest],
  Awaitable[~.Agent]]:
@@ -331,6 +335,10 @@ def update_agent(
 
  Updates the specified agent.
 
+ Note: You should always train a flow prior to sending it
+ queries. See the `training
+ documentation <https://cloud.google.com/dialogflow/cx/docs/concept/training>`__.
+
  Returns:
  Callable[[~.UpdateAgentRequest],
  Awaitable[~.Agent]]:
@@ -408,9 +416,14 @@ def restore_agent(
  r"""Return a callable for the restore agent method over gRPC.
 
  Restores the specified agent from a binary file.
+
  Replaces the current agent with a new one. Note that all
- existing resources in agent (e.g. intents, entity types,
- flows) will be removed.
+ existing resources in agent (e.g. intents, entity types, flows)
+ will be removed.
+
+ Note: You should always train a flow prior to sending it
+ queries. See the `training
+ documentation <https://cloud.google.com/dialogflow/cx/docs/concept/training>`__.
 
  Returns:
  Callable[[~.RestoreAgentRequest],

google/cloud/dialogflowcx_v3beta1/services/entity_types/async_client.py

@@ -469,6 +469,10 @@ async def update_entity_type(
  ) -> gcdc_entity_type.EntityType:
  r"""Updates the specified entity type.
 
+ Note: You should always train a flow prior to sending it
+ queries. See the `training
+ documentation <https://cloud.google.com/dialogflow/cx/docs/concept/training>`__.
+
  Args:
  request (:class:`google.cloud.dialogflowcx_v3beta1.types.UpdateEntityTypeRequest`):
  The request object. The request message for
@@ -581,6 +585,10 @@ async def delete_entity_type(
  ) -> None:
  r"""Deletes the specified entity type.
 
+ Note: You should always train a flow prior to sending it
+ queries. See the `training
+ documentation <https://cloud.google.com/dialogflow/cx/docs/concept/training>`__.
+
  Args:
  request (:class:`google.cloud.dialogflowcx_v3beta1.types.DeleteEntityTypeRequest`):
  The request object. The request message for

google/cloud/dialogflowcx_v3beta1/services/entity_types/client.py

@@ -658,6 +658,10 @@ def update_entity_type(
  ) -> gcdc_entity_type.EntityType:
  r"""Updates the specified entity type.
 
+ Note: You should always train a flow prior to sending it
+ queries. See the `training
+ documentation <https://cloud.google.com/dialogflow/cx/docs/concept/training>`__.
+
  Args:
  request (google.cloud.dialogflowcx_v3beta1.types.UpdateEntityTypeRequest):
  The request object. The request message for
@@ -770,6 +774,10 @@ def delete_entity_type(
  ) -> None:
  r"""Deletes the specified entity type.
 
+ Note: You should always train a flow prior to sending it
+ queries. See the `training
+ documentation <https://cloud.google.com/dialogflow/cx/docs/concept/training>`__.
+
  Args:
  request (google.cloud.dialogflowcx_v3beta1.types.DeleteEntityTypeRequest):
  The request object. The request message for

google/cloud/dialogflowcx_v3beta1/services/entity_types/transports/grpc.py

@@ -317,6 +317,10 @@ def update_entity_type(
 
  Updates the specified entity type.
 
+ Note: You should always train a flow prior to sending it
+ queries. See the `training
+ documentation <https://cloud.google.com/dialogflow/cx/docs/concept/training>`__.
+
  Returns:
  Callable[[~.UpdateEntityTypeRequest],
  ~.EntityType]:
@@ -343,6 +347,10 @@ def delete_entity_type(
 
  Deletes the specified entity type.
 
+ Note: You should always train a flow prior to sending it
+ queries. See the `training
+ documentation <https://cloud.google.com/dialogflow/cx/docs/concept/training>`__.
+
  Returns:
  Callable[[~.DeleteEntityTypeRequest],
  ~.Empty]:

google/cloud/dialogflowcx_v3beta1/services/entity_types/transports/grpc_asyncio.py

@@ -325,6 +325,10 @@ def update_entity_type(
 
  Updates the specified entity type.
 
+ Note: You should always train a flow prior to sending it
+ queries. See the `training
+ documentation <https://cloud.google.com/dialogflow/cx/docs/concept/training>`__.
+
  Returns:
  Callable[[~.UpdateEntityTypeRequest],
  Awaitable[~.EntityType]]:
@@ -351,6 +355,10 @@ def delete_entity_type(
 
  Deletes the specified entity type.
 
+ Note: You should always train a flow prior to sending it
+ queries. See the `training
+ documentation <https://cloud.google.com/dialogflow/cx/docs/concept/training>`__.
+
  Returns:
  Callable[[~.DeleteEntityTypeRequest],
  Awaitable[~.Empty]]:

google/cloud/dialogflowcx_v3beta1/services/flows/async_client.py

@@ -188,6 +188,10 @@ async def create_flow(
  ) -> gcdc_flow.Flow:
  r"""Creates a flow in the specified agent.
 
+ Note: You should always train a flow prior to sending it
+ queries. See the `training
+ documentation <https://cloud.google.com/dialogflow/cx/docs/concept/training>`__.
+
  Args:
  request (:class:`google.cloud.dialogflowcx_v3beta1.types.CreateFlowRequest`):
  The request object. The request message for
@@ -524,6 +528,10 @@ async def update_flow(
  ) -> gcdc_flow.Flow:
  r"""Updates the specified flow.
 
+ Note: You should always train a flow prior to sending it
+ queries. See the `training
+ documentation <https://cloud.google.com/dialogflow/cx/docs/concept/training>`__.
+
  Args:
  request (:class:`google.cloud.dialogflowcx_v3beta1.types.UpdateFlowRequest`):
  The request object. The request message for
@@ -624,8 +632,12 @@ async def train_flow(
  timeout: float = None,
  metadata: Sequence[Tuple[str, str]] = (),
  ) -> operation_async.AsyncOperation:
- r"""Trains the specified flow. Note that only the flow in
- 'draft' environment is trained.
+ r"""Trains the specified flow. Note that only the flow in 'draft'
+ environment is trained.
+
+ Note: You should always train a flow prior to sending it
+ queries. See the `training
+ documentation <https://cloud.google.com/dialogflow/cx/docs/concept/training>`__.
 
  Args:
  request (:class:`google.cloud.dialogflowcx_v3beta1.types.TrainFlowRequest`):
@@ -840,8 +852,12 @@ async def import_flow(
  timeout: float = None,
  metadata: Sequence[Tuple[str, str]] = (),
  ) -> operation_async.AsyncOperation:
- r"""Imports the specified flow to the specified agent
- from a binary file.
+ r"""Imports the specified flow to the specified agent from a binary
+ file.
+
+ Note: You should always train a flow prior to sending it
+ queries. See the `training
+ documentation <https://cloud.google.com/dialogflow/cx/docs/concept/training>`__.
 
  Args:
  request (:class:`google.cloud.dialogflowcx_v3beta1.types.ImportFlowRequest`):

google/cloud/dialogflowcx_v3beta1/services/flows/client.py

@@ -457,6 +457,10 @@ def create_flow(
  ) -> gcdc_flow.Flow:
  r"""Creates a flow in the specified agent.
 
+ Note: You should always train a flow prior to sending it
+ queries. See the `training
+ documentation <https://cloud.google.com/dialogflow/cx/docs/concept/training>`__.
+
  Args:
  request (google.cloud.dialogflowcx_v3beta1.types.CreateFlowRequest):
  The request object. The request message for
@@ -793,6 +797,10 @@ def update_flow(
  ) -> gcdc_flow.Flow:
  r"""Updates the specified flow.
 
+ Note: You should always train a flow prior to sending it
+ queries. See the `training
+ documentation <https://cloud.google.com/dialogflow/cx/docs/concept/training>`__.
+
  Args:
  request (google.cloud.dialogflowcx_v3beta1.types.UpdateFlowRequest):
  The request object. The request message for
@@ -893,8 +901,12 @@ def train_flow(
  timeout: float = None,
  metadata: Sequence[Tuple[str, str]] = (),
  ) -> operation.Operation:
- r"""Trains the specified flow. Note that only the flow in
- 'draft' environment is trained.
+ r"""Trains the specified flow. Note that only the flow in 'draft'
+ environment is trained.
+
+ Note: You should always train a flow prior to sending it
+ queries. See the `training
+ documentation <https://cloud.google.com/dialogflow/cx/docs/concept/training>`__.
 
  Args:
  request (google.cloud.dialogflowcx_v3beta1.types.TrainFlowRequest):
@@ -1112,8 +1124,12 @@ def import_flow(
  timeout: float = None,
  metadata: Sequence[Tuple[str, str]] = (),
  ) -> operation.Operation:
- r"""Imports the specified flow to the specified agent
- from a binary file.
+ r"""Imports the specified flow to the specified agent from a binary
+ file.
+
+ Note: You should always train a flow prior to sending it
+ queries. See the `training
+ documentation <https://cloud.google.com/dialogflow/cx/docs/concept/training>`__.
 
  Args:
  request (google.cloud.dialogflowcx_v3beta1.types.ImportFlowRequest):