def get_knowledge_base( self, request: Union[knowledge_base.GetKnowledgeBaseRequest, dict] = None, *, name: str = None, retry: OptionalRetry = gapic_v1.method.DEFAULT, timeout: float = None, metadata: Sequence[Tuple[str, str]] = (), ) -> knowledge_base.KnowledgeBase: r"""Retrieves the specified knowledge base. Note: The ``projects.agent.knowledgeBases`` resource is deprecated; only use ``projects.knowledgeBases``. .. code-block:: python from google.cloud import dialogflow_v2beta1 def sample_get_knowledge_base(): # Create a client client = dialogflow_v2beta1.KnowledgeBasesClient() # Initialize request argument(s) request = dialogflow_v2beta1.GetKnowledgeBaseRequest( name="name_value", ) # Make the request response = client.get_knowledge_base(request=request) # Handle the response print(response) Args: request (Union[google.cloud.dialogflow_v2beta1.types.GetKnowledgeBaseRequest, dict]): The request object. Request message for [KnowledgeBases.GetKnowledgeBase][google.cloud.dialogflow.v2beta1.KnowledgeBases.GetKnowledgeBase]. name (str): Required. The name of the knowledge base to retrieve. Format ``projects/<Project ID>/locations/<Location ID>/knowledgeBases/<Knowledge Base ID>``. This corresponds to the ``name`` field on the ``request`` instance; if ``request`` is provided, this should not be set. retry (google.api_core.retry.Retry): Designation of what errors, if any, should be retried. timeout (float): The timeout for this request. metadata (Sequence[Tuple[str, str]]): Strings which should be sent along with the request as metadata. Returns: google.cloud.dialogflow_v2beta1.types.KnowledgeBase: 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. """ # Create or coerce a protobuf request object. # Quick check: If we got a request object, we should *not* have # gotten any keyword arguments that map to the request. has_flattened_params = any([name]) if request is not None and has_flattened_params: raise ValueError("If the `request` argument is set, then none of " "the individual field arguments should be set.") # Minor optimization to avoid making a copy if the user passes # in a knowledge_base.GetKnowledgeBaseRequest. # There's no risk of modifying the input as we've already verified # there are no flattened fields. if not isinstance(request, knowledge_base.GetKnowledgeBaseRequest): request = knowledge_base.GetKnowledgeBaseRequest(request) # If we have keyword arguments corresponding to fields on the # request, apply these. if name is not None: request.name = name # Wrap the RPC method; this adds retry and timeout information, # and friendly error handling. rpc = self._transport._wrapped_methods[ self._transport.get_knowledge_base] # Certain fields should be provided within the metadata header; # add these here. metadata = tuple(metadata) + (gapic_v1.routing_header.to_grpc_metadata( (("name", request.name), )), ) # Send the request. response = rpc( request, retry=retry, timeout=timeout, metadata=metadata, ) # Done; return the response. return response
async def get_knowledge_base( self, request: knowledge_base.GetKnowledgeBaseRequest = None, *, name: str = None, retry: retries.Retry = gapic_v1.method.DEFAULT, timeout: float = None, metadata: Sequence[Tuple[str, str]] = (), ) -> knowledge_base.KnowledgeBase: r"""Retrieves the specified knowledge base. Note: The ``projects.agent.knowledgeBases`` resource is deprecated; only use ``projects.knowledgeBases``. Args: request (:class:`google.cloud.dialogflow_v2beta1.types.GetKnowledgeBaseRequest`): The request object. Request message for [KnowledgeBases.GetKnowledgeBase][google.cloud.dialogflow.v2beta1.KnowledgeBases.GetKnowledgeBase]. name (:class:`str`): Required. The name of the knowledge base to retrieve. Format ``projects/<Project ID>/locations/<Location ID>/knowledgeBases/<Knowledge Base ID>``. This corresponds to the ``name`` field on the ``request`` instance; if ``request`` is provided, this should not be set. retry (google.api_core.retry.Retry): Designation of what errors, if any, should be retried. timeout (float): The timeout for this request. metadata (Sequence[Tuple[str, str]]): Strings which should be sent along with the request as metadata. Returns: google.cloud.dialogflow_v2beta1.types.KnowledgeBase: 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. """ # Create or coerce a protobuf request object. # Sanity check: If we got a request object, we should *not* have # gotten any keyword arguments that map to the request. has_flattened_params = any([name]) if request is not None and has_flattened_params: raise ValueError("If the `request` argument is set, then none of " "the individual field arguments should be set.") request = knowledge_base.GetKnowledgeBaseRequest(request) # If we have keyword arguments corresponding to fields on the # request, apply these. if name is not None: request.name = name # Wrap the RPC method; this adds retry and timeout information, # and friendly error handling. rpc = gapic_v1.method_async.wrap_method( self._client._transport.get_knowledge_base, default_timeout=None, client_info=DEFAULT_CLIENT_INFO, ) # Certain fields should be provided within the metadata header; # add these here. metadata = tuple(metadata) + (gapic_v1.routing_header.to_grpc_metadata( (("name", request.name), )), ) # Send the request. response = await rpc( request, retry=retry, timeout=timeout, metadata=metadata, ) # Done; return the response. return response