KnowledgeBasesClient(*, credentials: Optional[google.auth.credentials.Credentials] = None, transport: Optional[Union[str, google.cloud.dialogflow_v2beta1.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.
Inheritance
builtins.object > KnowledgeBasesClientProperties
transport
Returns the transport used by the client instance.
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_v2beta1.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>)
Instantiates the knowledge bases client.
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 |
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 |
Type | Description |
google.auth.exceptions.MutualTLSChannelError | If mutual TLS transport creation failed for any reason. |
__exit__
__exit__(type, value, traceback)
Releases underlying transport's resources.
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[Union[google.cloud.dialogflow_v2beta1.types.knowledge_base.CreateKnowledgeBaseRequest, dict]] = None, *, parent: Optional[str] = None, knowledge_base: Optional[google.cloud.dialogflow_v2beta1.types.knowledge_base.KnowledgeBase] = None, retry: Union[google.api_core.retry.Retry, google.api_core.gapic_v1.method._MethodDefault] = <_MethodDefault._DEFAULT_VALUE: <object object>>, timeout: Optional[float] = None, metadata: Sequence[Tuple[str, str]] = ())
Creates a knowledge base.
Note: The projects.agent.knowledgeBases
resource is
deprecated; only use projects.knowledgeBases
.
from google.cloud import dialogflow_v2beta1
def sample_create_knowledge_base():
# Create a client
client = dialogflow_v2beta1.KnowledgeBasesClient()
# Initialize request argument(s)
knowledge_base = dialogflow_v2beta1.KnowledgeBase()
knowledge_base.display_name = "display_name_value"
request = dialogflow_v2beta1.CreateKnowledgeBaseRequest(
parent="parent_value",
knowledge_base=knowledge_base,
)
# Make the request
response = client.create_knowledge_base(request=request)
# Handle the response
print(response)
Name | Description |
request |
Union[google.cloud.dialogflow_v2beta1.types.CreateKnowledgeBaseRequest, dict]
The request object. Request message for KnowledgeBases.CreateKnowledgeBase. |
parent |
str
Required. The project to create a knowledge base for. Format: |
knowledge_base |
google.cloud.dialogflow_v2beta1.types.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. |
Type | Description |
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. |
delete_knowledge_base
delete_knowledge_base(request: Optional[Union[google.cloud.dialogflow_v2beta1.types.knowledge_base.DeleteKnowledgeBaseRequest, dict]] = None, *, name: Optional[str] = None, retry: Union[google.api_core.retry.Retry, google.api_core.gapic_v1.method._MethodDefault] = <_MethodDefault._DEFAULT_VALUE: <object object>>, timeout: Optional[float] = None, metadata: Sequence[Tuple[str, str]] = ())
Deletes the specified knowledge base.
Note: The projects.agent.knowledgeBases
resource is
deprecated; only use projects.knowledgeBases
.
from google.cloud import dialogflow_v2beta1
def sample_delete_knowledge_base():
# Create a client
client = dialogflow_v2beta1.KnowledgeBasesClient()
# Initialize request argument(s)
request = dialogflow_v2beta1.DeleteKnowledgeBaseRequest(
name="name_value",
)
# Make the request
client.delete_knowledge_base(request=request)
Name | Description |
request |
Union[google.cloud.dialogflow_v2beta1.types.DeleteKnowledgeBaseRequest, dict]
The request object. Request message for KnowledgeBases.DeleteKnowledgeBase. |
name |
str
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.
Name | Description |
filename |
str
The path to the service account private key json file. |
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.
Name | Description |
info |
dict
The service account private key info. |
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.
Name | Description |
filename |
str
The path to the service account private key json file. |
Type | Description |
KnowledgeBasesClient | The constructed client. |
get_knowledge_base
get_knowledge_base(request: Optional[Union[google.cloud.dialogflow_v2beta1.types.knowledge_base.GetKnowledgeBaseRequest, dict]] = None, *, name: Optional[str] = None, retry: Union[google.api_core.retry.Retry, google.api_core.gapic_v1.method._MethodDefault] = <_MethodDefault._DEFAULT_VALUE: <object object>>, timeout: Optional[float] = None, metadata: Sequence[Tuple[str, str]] = ())
Retrieves the specified knowledge base.
Note: The projects.agent.knowledgeBases
resource is
deprecated; only use projects.knowledgeBases
.
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)
Name | Description |
request |
Union[google.cloud.dialogflow_v2beta1.types.GetKnowledgeBaseRequest, dict]
The request object. Request message for KnowledgeBases.GetKnowledgeBase. |
name |
str
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. |
Type | Description |
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. |
get_mtls_endpoint_and_cert_source
get_mtls_endpoint_and_cert_source(
client_options: Optional[google.api_core.client_options.ClientOptions] = None,
)
Return the API endpoint and client cert source for mutual TLS.
The client cert source is determined in the following order:
(1) if GOOGLE_API_USE_CLIENT_CERTIFICATE
environment variable is not "true", the
client cert source is None.
(2) if client_options.client_cert_source
is provided, use the provided one; if the
default client cert source exists, use the default one; otherwise the client cert
source is None.
The API endpoint is determined in the following order:
(1) if client_options.api_endpoint
if provided, use the provided one.
(2) if GOOGLE_API_USE_CLIENT_CERTIFICATE
environment variable is "always", use the
default mTLS endpoint; if the environment variabel is "never", use the default API
endpoint; otherwise if client cert source exists, use the default mTLS endpoint, otherwise
use the default API endpoint.
More details can be found at https://google.aip.dev/auth/4114.
Name | Description |
client_options |
google.api_core.client_options.ClientOptions
Custom options for the client. Only the |
Type | Description |
google.auth.exceptions.MutualTLSChannelError | If any errors happen. |
Type | Description |
Tuple[str, Callable[[], Tuple[bytes, bytes]]] | returns the API endpoint and the client cert source to use. |
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[Union[google.cloud.dialogflow_v2beta1.types.knowledge_base.ListKnowledgeBasesRequest, dict]] = None, *, parent: Optional[str] = None, retry: Union[google.api_core.retry.Retry, google.api_core.gapic_v1.method._MethodDefault] = <_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.
Note: The projects.agent.knowledgeBases
resource is
deprecated; only use projects.knowledgeBases
.
from google.cloud import dialogflow_v2beta1
def sample_list_knowledge_bases():
# Create a client
client = dialogflow_v2beta1.KnowledgeBasesClient()
# Initialize request argument(s)
request = dialogflow_v2beta1.ListKnowledgeBasesRequest(
parent="parent_value",
)
# Make the request
page_result = client.list_knowledge_bases(request=request)
# Handle the response
for response in page_result:
print(response)
Name | Description |
request |
Union[google.cloud.dialogflow_v2beta1.types.ListKnowledgeBasesRequest, dict]
The request object. Request message for KnowledgeBases.ListKnowledgeBases. |
parent |
str
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. |
Type | Description |
google.cloud.dialogflow_v2beta1.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)
Parses a knowledge_base path into its component segments.
update_knowledge_base
update_knowledge_base(request: Optional[Union[google.cloud.dialogflow_v2beta1.types.knowledge_base.UpdateKnowledgeBaseRequest, dict]] = None, *, knowledge_base: Optional[google.cloud.dialogflow_v2beta1.types.knowledge_base.KnowledgeBase] = None, update_mask: Optional[google.protobuf.field_mask_pb2.FieldMask] = None, retry: Union[google.api_core.retry.Retry, google.api_core.gapic_v1.method._MethodDefault] = <_MethodDefault._DEFAULT_VALUE: <object object>>, timeout: Optional[float] = None, metadata: Sequence[Tuple[str, str]] = ())
Updates the specified knowledge base.
Note: The projects.agent.knowledgeBases
resource is
deprecated; only use projects.knowledgeBases
.
from google.cloud import dialogflow_v2beta1
def sample_update_knowledge_base():
# Create a client
client = dialogflow_v2beta1.KnowledgeBasesClient()
# Initialize request argument(s)
knowledge_base = dialogflow_v2beta1.KnowledgeBase()
knowledge_base.display_name = "display_name_value"
request = dialogflow_v2beta1.UpdateKnowledgeBaseRequest(
knowledge_base=knowledge_base,
)
# Make the request
response = client.update_knowledge_base(request=request)
# Handle the response
print(response)
Name | Description |
request |
Union[google.cloud.dialogflow_v2beta1.types.UpdateKnowledgeBaseRequest, dict]
The request object. Request message for KnowledgeBases.UpdateKnowledgeBase. |
knowledge_base |
google.cloud.dialogflow_v2beta1.types.KnowledgeBase
Required. The knowledge base to update. This corresponds to the |
update_mask |
google.protobuf.field_mask_pb2.FieldMask
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. |
Type | Description |
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. |