Service for managing KnowledgeBases.
Equality
Instances of this class created via copy-construction or copy-assignment always compare equal. Instances created with equal std::shared_ptr<*Connection>
objects compare equal. Objects that compare equal share the same underlying resources.
Performance
Creating a new instance of this class is a relatively expensive operation, new objects establish new connections to the service. In contrast, copy-construction, move-construction, and the corresponding assignment operations are relatively efficient as the copies share all underlying resources.
Thread Safety
Concurrent access to different instances of this class, even if they compare equal, is guaranteed to work. Two or more threads operating on the same instance of this class is not guaranteed to work. Since copy-construction and move-construction is a relatively efficient operation, consider using such a copy when using this class from multiple threads.
Constructors
KnowledgeBasesClient(KnowledgeBasesClient const &)
Copy and move support
Parameter | |
---|---|
Name | Description |
|
KnowledgeBasesClient const &
|
KnowledgeBasesClient(KnowledgeBasesClient &&)
Copy and move support
Parameter | |
---|---|
Name | Description |
|
KnowledgeBasesClient &&
|
KnowledgeBasesClient(std::shared_ptr< KnowledgeBasesConnection >, Options)
Parameters | |
---|---|
Name | Description |
connection |
std::shared_ptr< KnowledgeBasesConnection >
|
opts |
Options
|
Operators
operator=(KnowledgeBasesClient const &)
Copy and move support
Parameter | |
---|---|
Name | Description |
|
KnowledgeBasesClient const &
|
Returns | |
---|---|
Type | Description |
KnowledgeBasesClient & |
operator=(KnowledgeBasesClient &&)
Copy and move support
Parameter | |
---|---|
Name | Description |
|
KnowledgeBasesClient &&
|
Returns | |
---|---|
Type | Description |
KnowledgeBasesClient & |
Functions
ListKnowledgeBases(std::string const &, Options)
Returns the list of all knowledge bases of the specified agent.
Parameters | |
---|---|
Name | Description |
parent |
std::string const &
Required. The project to list of knowledge bases for. Format: |
opts |
Options
Optional. Override the class-level options, such as retry and backoff policies. |
Returns | |
---|---|
Type | Description |
StreamRange< google::cloud::dialogflow::v2::KnowledgeBase > |
a StreamRange to iterate of the results. See the documentation of this type for details. In brief, this class has |
ListKnowledgeBases(google::cloud::dialogflow::v2::ListKnowledgeBasesRequest, Options)
Returns the list of all knowledge bases of the specified agent.
Parameters | |
---|---|
Name | Description |
request |
google::cloud::dialogflow::v2::ListKnowledgeBasesRequest
Unary RPCs, such as the one wrapped by this function, receive a single |
opts |
Options
Optional. Override the class-level options, such as retry and backoff policies. |
Returns | |
---|---|
Type | Description |
StreamRange< google::cloud::dialogflow::v2::KnowledgeBase > |
a StreamRange to iterate of the results. See the documentation of this type for details. In brief, this class has |
GetKnowledgeBase(std::string const &, Options)
Retrieves the specified knowledge base.
Parameters | |
---|---|
Name | Description |
name |
std::string const &
Required. The name of the knowledge base to retrieve. Format |
opts |
Options
Optional. Override the class-level options, such as retry and backoff policies. |
Returns | |
---|---|
Type | Description |
StatusOr< google::cloud::dialogflow::v2::KnowledgeBase > |
the result of the RPC. The response message type (google.cloud.dialogflow.v2.KnowledgeBase) is mapped to a C++ class using the Protobuf mapping rules. If the request fails, the |
GetKnowledgeBase(google::cloud::dialogflow::v2::GetKnowledgeBaseRequest const &, Options)
Retrieves the specified knowledge base.
Parameters | |
---|---|
Name | Description |
request |
google::cloud::dialogflow::v2::GetKnowledgeBaseRequest const &
Unary RPCs, such as the one wrapped by this function, receive a single |
opts |
Options
Optional. Override the class-level options, such as retry and backoff policies. |
Returns | |
---|---|
Type | Description |
StatusOr< google::cloud::dialogflow::v2::KnowledgeBase > |
the result of the RPC. The response message type (google.cloud.dialogflow.v2.KnowledgeBase) is mapped to a C++ class using the Protobuf mapping rules. If the request fails, the |
CreateKnowledgeBase(std::string const &, google::cloud::dialogflow::v2::KnowledgeBase const &, Options)
Creates a knowledge base.
Parameters | |
---|---|
Name | Description |
parent |
std::string const &
Required. The project to create a knowledge base for. Format: |
knowledge_base |
google::cloud::dialogflow::v2::KnowledgeBase const &
Required. The knowledge base to create. |
opts |
Options
Optional. Override the class-level options, such as retry and backoff policies. |
Returns | |
---|---|
Type | Description |
StatusOr< google::cloud::dialogflow::v2::KnowledgeBase > |
the result of the RPC. The response message type (google.cloud.dialogflow.v2.KnowledgeBase) is mapped to a C++ class using the Protobuf mapping rules. If the request fails, the |
CreateKnowledgeBase(google::cloud::dialogflow::v2::CreateKnowledgeBaseRequest const &, Options)
Creates a knowledge base.
Parameters | |
---|---|
Name | Description |
request |
google::cloud::dialogflow::v2::CreateKnowledgeBaseRequest const &
Unary RPCs, such as the one wrapped by this function, receive a single |
opts |
Options
Optional. Override the class-level options, such as retry and backoff policies. |
Returns | |
---|---|
Type | Description |
StatusOr< google::cloud::dialogflow::v2::KnowledgeBase > |
the result of the RPC. The response message type (google.cloud.dialogflow.v2.KnowledgeBase) is mapped to a C++ class using the Protobuf mapping rules. If the request fails, the |
DeleteKnowledgeBase(std::string const &, Options)
Deletes the specified knowledge base.
Parameters | |
---|---|
Name | Description |
name |
std::string const &
Required. The name of the knowledge base to delete. Format: |
opts |
Options
Optional. Override the class-level options, such as retry and backoff policies. |
Returns | |
---|---|
Type | Description |
Status |
a |
DeleteKnowledgeBase(google::cloud::dialogflow::v2::DeleteKnowledgeBaseRequest const &, Options)
Deletes the specified knowledge base.
Parameters | |
---|---|
Name | Description |
request |
google::cloud::dialogflow::v2::DeleteKnowledgeBaseRequest const &
Unary RPCs, such as the one wrapped by this function, receive a single |
opts |
Options
Optional. Override the class-level options, such as retry and backoff policies. |
Returns | |
---|---|
Type | Description |
Status |
a |
UpdateKnowledgeBase(google::cloud::dialogflow::v2::KnowledgeBase const &, google::protobuf::FieldMask const &, Options)
Updates the specified knowledge base.
Parameters | |
---|---|
Name | Description |
knowledge_base |
google::cloud::dialogflow::v2::KnowledgeBase const &
Required. The knowledge base to update. |
update_mask |
google::protobuf::FieldMask const &
Optional. Not specified means |
opts |
Options
Optional. Override the class-level options, such as retry and backoff policies. |
Returns | |
---|---|
Type | Description |
StatusOr< google::cloud::dialogflow::v2::KnowledgeBase > |
the result of the RPC. The response message type (google.cloud.dialogflow.v2.KnowledgeBase) is mapped to a C++ class using the Protobuf mapping rules. If the request fails, the |
UpdateKnowledgeBase(google::cloud::dialogflow::v2::UpdateKnowledgeBaseRequest const &, Options)
Updates the specified knowledge base.
Parameters | |
---|---|
Name | Description |
request |
google::cloud::dialogflow::v2::UpdateKnowledgeBaseRequest const &
Unary RPCs, such as the one wrapped by this function, receive a single |
opts |
Options
Optional. Override the class-level options, such as retry and backoff policies. |
Returns | |
---|---|
Type | Description |
StatusOr< google::cloud::dialogflow::v2::KnowledgeBase > |
the result of the RPC. The response message type (google.cloud.dialogflow.v2.KnowledgeBase) is mapped to a C++ class using the Protobuf mapping rules. If the request fails, the |