Class KnowledgeBasesClient (2.1.2)

KnowledgeBasesClient(*, credentials: Optional[google.auth.credentials.Credentials] = None, transport: Optional[Union[str, google.cloud.dialogflow_v2.services.knowledge_bases.transports.base.KnowledgeBasesTransport]] = None, client_options: Optional[google.api_core.client_options.ClientOptions] = 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

Return the transport used by the client instance.

Returns
Type	Description
`KnowledgeBasesTransport`	The transport used by the client instance.

Methods

KnowledgeBasesClient

KnowledgeBasesClient(*, credentials: Optional[google.auth.credentials.Credentials] = None, transport: Optional[Union[str, google.cloud.dialogflow_v2.services.knowledge_bases.transports.base.KnowledgeBasesTransport]] = None, client_options: Optional[google.api_core.client_options.ClientOptions] = None, client_info: google.api_core.gapic_v1.client_info.ClientInfo = <google.api_core.gapic_v1.client_info.ClientInfo object>)

Instantiate 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, KnowledgeBasesTransport]` The transport to use. If set to None, a transport is chosen automatically.
`client_options`	`google.api_core.client_options.ClientOptions` Custom options for the client. It won't take effect if a `transport` instance is provided. (1) The `api_endpoint` property can be used to override the default endpoint provided by the client. GOOGLE_API_USE_MTLS_ENDPOINT environment variable can also be used to override the endpoint: "always" (always use the default mTLS endpoint), "never" (always use the default regular endpoint) and "auto" (auto switch to the default mTLS endpoint if client certificate is present, this is the default value). However, the `api_endpoint` property takes precedence if provided. (2) If GOOGLE_API_USE_CLIENT_CERTIFICATE environment variable is "true", then the `client_cert_source` property can be used to provide client certificate for mutual TLS transport. If not provided, the default SSL client certificate will be used if present. If GOOGLE_API_USE_CLIENT_CERTIFICATE is "false" or not set, no client certificate will be used.
`client_info`	`google.api_core.gapic_v1.client_info.ClientInfo` The client info used to send a user-agent string along with API requests. If `None`, then default info will be used. Generally, you only need to set this if you're developing your own client library.

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)

Return a fully-qualified billing_account string.

common_folder_path

common_folder_path(folder: str)

Return a fully-qualified folder string.

common_location_path

common_location_path(project: str, location: str)

Return a fully-qualified location string.

common_organization_path

common_organization_path(organization: str)

Return a fully-qualified organization string.

common_project_path

common_project_path(project: str)

Return 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`	`google.cloud.dialogflow_v2.types.CreateKnowledgeBaseRequest` The request object. Request message for KnowledgeBases.CreateKnowledgeBase.
`parent`	`str` Required. The project to create a knowledge base for. Format: `projects/`. This corresponds to the `parent` field on the `request` instance; if `request` is provided, this should not be set.
`knowledge_base`	`google.cloud.dialogflow_v2.types.KnowledgeBase` Required. The knowledge base to create. This corresponds to the `knowledge_base` 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

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`	`google.cloud.dialogflow_v2.types.DeleteKnowledgeBaseRequest` The request object. Request message for KnowledgeBases.DeleteKnowledgeBase.
`name`	`str` Required. The name of the knowledge base to delete. Format: `projects/`. 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.

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
`KnowledgeBasesClient`	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
`KnowledgeBasesClient`	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
`KnowledgeBasesClient`	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`	`google.cloud.dialogflow_v2.types.GetKnowledgeBaseRequest` The request object. Request message for KnowledgeBases.GetKnowledgeBase.
`name`	`str` Required. The name of the knowledge base to retrieve. Format `projects/`. 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

Type Description

knowledge_base_path

knowledge_base_path(project: str, knowledge_base: str)

Return 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`	`google.cloud.dialogflow_v2.types.ListKnowledgeBasesRequest` The request object. Request message for KnowledgeBases.ListKnowledgeBases.
`parent`	`str` Required. The project to list of knowledge bases for. Format: `projects/`. This corresponds to the `parent` 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
Type	Description
`google.cloud.dialogflow_v2.services.knowledge_bases.pagers.ListKnowledgeBasesPager`	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)

Parse 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`	`google.cloud.dialogflow_v2.types.UpdateKnowledgeBaseRequest` The request object. Request message for KnowledgeBases.UpdateKnowledgeBase.
`knowledge_base`	`google.cloud.dialogflow_v2.types.KnowledgeBase` Required. The knowledge base to update. This corresponds to the `knowledge_base` field on the `request` instance; if `request` is provided, this should not be set.
`update_mask`	`google.protobuf.field_mask_pb2.FieldMask` Optional. Not specified means `update all`. Currently, only `display_name` can be updated, an InvalidArgument will be returned for attempting to update other fields. This corresponds to the `update_mask` 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

Type Description