KnowledgeBasesAsyncClient(*, credentials: google.auth.credentials.Credentials = None, transport: Union[str, google.cloud.dialogflow_v2.services.knowledge_bases.transports.base.KnowledgeBasesTransport] = 'grpc_asyncio', client_options: <module 'google.api_core.client_options' from '/workspace/python-dialogflow/.nox/docfx/lib/python3.9/site-packages/google/api_core/client_options.py'> = None, client_info: google.api_core.gapic_v1.client_info.ClientInfo = <google.api_core.gapic_v1.client_info.ClientInfo object>)
Service for managing KnowledgeBases.
Properties
transport
Returns the transport used by the client instance.
Returns | |
---|---|
Type | Description |
KnowledgeBasesTransport | The transport used by the client instance. |
Methods
KnowledgeBasesAsyncClient
KnowledgeBasesAsyncClient(*, credentials: google.auth.credentials.Credentials = None, transport: Union[str, google.cloud.dialogflow_v2.services.knowledge_bases.transports.base.KnowledgeBasesTransport] = 'grpc_asyncio', client_options: <module 'google.api_core.client_options' from '/workspace/python-dialogflow/.nox/docfx/lib/python3.9/site-packages/google/api_core/client_options.py'> = None, client_info: google.api_core.gapic_v1.client_info.ClientInfo = <google.api_core.gapic_v1.client_info.ClientInfo object>)
Instantiates the knowledge bases client.
Parameters | |
---|---|
Name | Description |
credentials |
Optional[google.auth.credentials.Credentials]
The authorization credentials to attach to requests. These credentials identify the application to the service; if none are specified, the client will attempt to ascertain the credentials from the environment. |
transport |
Union[str,
The transport to use. If set to None, a transport is chosen automatically. |
client_options |
ClientOptions
Custom options for the client. It won't take effect if a |
Exceptions | |
---|---|
Type | Description |
google.auth.exceptions.MutualTlsChannelError | If mutual TLS transport creation failed for any reason. |
common_billing_account_path
common_billing_account_path(billing_account: str)
Returns a fully-qualified billing_account string.
common_folder_path
common_folder_path(folder: str)
Returns a fully-qualified folder string.
common_location_path
common_location_path(project: str, location: str)
Returns a fully-qualified location string.
common_organization_path
common_organization_path(organization: str)
Returns a fully-qualified organization string.
common_project_path
common_project_path(project: str)
Returns a fully-qualified project string.
create_knowledge_base
create_knowledge_base(request: Optional[google.cloud.dialogflow_v2.types.knowledge_base.CreateKnowledgeBaseRequest] = None, *, parent: Optional[str] = None, knowledge_base: Optional[google.cloud.dialogflow_v2.types.knowledge_base.KnowledgeBase] = None, retry: google.api_core.retry.Retry = <_MethodDefault._DEFAULT_VALUE: <object object>>, timeout: Optional[float] = None, metadata: Sequence[Tuple[str, str]] = ())
Creates a knowledge base.
Parameters | |
---|---|
Name | Description |
request |
CreateKnowledgeBaseRequest
The request object. Request message for KnowledgeBases.CreateKnowledgeBase. |
parent |
Required. The project to create a knowledge base for. Format: |
knowledge_base |
KnowledgeBase
Required. The knowledge base to create. This corresponds to the |
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 | |
---|---|
Type | Description |
google.cloud.dialogflow_v2.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. |
delete_knowledge_base
delete_knowledge_base(request: Optional[google.cloud.dialogflow_v2.types.knowledge_base.DeleteKnowledgeBaseRequest] = None, *, name: Optional[str] = None, retry: google.api_core.retry.Retry = <_MethodDefault._DEFAULT_VALUE: <object object>>, timeout: Optional[float] = None, metadata: Sequence[Tuple[str, str]] = ())
Deletes the specified knowledge base.
Parameters | |
---|---|
Name | Description |
request |
DeleteKnowledgeBaseRequest
The request object. Request message for KnowledgeBases.DeleteKnowledgeBase. |
name |
Required. The name of the knowledge base to delete. Format: |
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. |
from_service_account_file
from_service_account_file(filename: str, *args, **kwargs)
Creates an instance of this client using the provided credentials file.
Parameter | |
---|---|
Name | Description |
filename |
str
The path to the service account private key json file. |
Returns | |
---|---|
Type | Description |
KnowledgeBasesAsyncClient | The constructed client. |
from_service_account_info
from_service_account_info(info: dict, *args, **kwargs)
Creates an instance of this client using the provided credentials info.
Parameter | |
---|---|
Name | Description |
info |
dict
The service account private key info. |
Returns | |
---|---|
Type | Description |
KnowledgeBasesAsyncClient | The constructed client. |
from_service_account_json
from_service_account_json(filename: str, *args, **kwargs)
Creates an instance of this client using the provided credentials file.
Parameter | |
---|---|
Name | Description |
filename |
str
The path to the service account private key json file. |
Returns | |
---|---|
Type | Description |
KnowledgeBasesAsyncClient | The constructed client. |
get_knowledge_base
get_knowledge_base(request: Optional[google.cloud.dialogflow_v2.types.knowledge_base.GetKnowledgeBaseRequest] = None, *, name: Optional[str] = None, retry: google.api_core.retry.Retry = <_MethodDefault._DEFAULT_VALUE: <object object>>, timeout: Optional[float] = None, metadata: Sequence[Tuple[str, str]] = ())
Retrieves the specified knowledge base.
Parameters | |
---|---|
Name | Description |
request |
GetKnowledgeBaseRequest
The request object. Request message for KnowledgeBases.GetKnowledgeBase. |
name |
Required. The name of the knowledge base to retrieve. Format |
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 | |
---|---|
Type | Description |
google.cloud.dialogflow_v2.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. |
get_transport_class
get_transport_class()
Returns an appropriate transport class.
knowledge_base_path
knowledge_base_path(project: str, knowledge_base: str)
Returns a fully-qualified knowledge_base string.
list_knowledge_bases
list_knowledge_bases(request: Optional[google.cloud.dialogflow_v2.types.knowledge_base.ListKnowledgeBasesRequest] = None, *, parent: Optional[str] = None, retry: google.api_core.retry.Retry = <_MethodDefault._DEFAULT_VALUE: <object object>>, timeout: Optional[float] = None, metadata: Sequence[Tuple[str, str]] = ())
Returns the list of all knowledge bases of the specified agent.
Parameters | |
---|---|
Name | Description |
request |
ListKnowledgeBasesRequest
The request object. Request message for KnowledgeBases.ListKnowledgeBases. |
parent |
Required. The project to list of knowledge bases for. Format: |
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 | |
---|---|
Type | Description |
google.cloud.dialogflow_v2.services.knowledge_bases.pagers.ListKnowledgeBasesAsyncPager | Response message for KnowledgeBases.ListKnowledgeBases. Iterating over this object will yield results and resolve additional pages automatically. |
parse_common_billing_account_path
parse_common_billing_account_path(path: str)
Parse a billing_account path into its component segments.
parse_common_folder_path
parse_common_folder_path(path: str)
Parse a folder path into its component segments.
parse_common_location_path
parse_common_location_path(path: str)
Parse a location path into its component segments.
parse_common_organization_path
parse_common_organization_path(path: str)
Parse a organization path into its component segments.
parse_common_project_path
parse_common_project_path(path: str)
Parse a project path into its component segments.
parse_knowledge_base_path
parse_knowledge_base_path(path: str)
Parses a knowledge_base path into its component segments.
update_knowledge_base
update_knowledge_base(request: Optional[google.cloud.dialogflow_v2.types.knowledge_base.UpdateKnowledgeBaseRequest] = None, *, knowledge_base: Optional[google.cloud.dialogflow_v2.types.knowledge_base.KnowledgeBase] = None, update_mask: Optional[google.protobuf.field_mask_pb2.FieldMask] = None, retry: google.api_core.retry.Retry = <_MethodDefault._DEFAULT_VALUE: <object object>>, timeout: Optional[float] = None, metadata: Sequence[Tuple[str, str]] = ())
Updates the specified knowledge base.
Parameters | |
---|---|
Name | Description |
request |
UpdateKnowledgeBaseRequest
The request object. Request message for KnowledgeBases.UpdateKnowledgeBase. |
knowledge_base |
KnowledgeBase
Required. The knowledge base to update. This corresponds to the |
update_mask |
Optional. Not specified means |
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 | |
---|---|
Type | Description |
google.cloud.dialogflow_v2.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. |