Service for managing knowledge Documents.
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
DocumentsClient(DocumentsClient const &)
Copy and move support
Parameter | |
---|---|
Name | Description |
|
DocumentsClient const &
|
DocumentsClient(DocumentsClient &&)
Copy and move support
Parameter | |
---|---|
Name | Description |
|
DocumentsClient &&
|
DocumentsClient(std::shared_ptr< DocumentsConnection >, Options)
Parameters | |
---|---|
Name | Description |
connection |
std::shared_ptr< DocumentsConnection >
|
opts |
Options
|
Operators
operator=(DocumentsClient const &)
Copy and move support
Parameter | |
---|---|
Name | Description |
|
DocumentsClient const &
|
Returns | |
---|---|
Type | Description |
DocumentsClient & |
operator=(DocumentsClient &&)
Copy and move support
Parameter | |
---|---|
Name | Description |
|
DocumentsClient &&
|
Returns | |
---|---|
Type | Description |
DocumentsClient & |
Functions
ListDocuments(std::string const &, Options)
Returns the list of all documents of the knowledge base.
Parameters | |
---|---|
Name | Description |
parent |
std::string const &
Required. The knowledge base to list all documents for. Format: |
opts |
Options
Optional. Override the class-level options, such as retry and backoff policies. |
Returns | |
---|---|
Type | Description |
StreamRange< google::cloud::dialogflow::v2::Document > |
a StreamRange to iterate of the results. See the documentation of this type for details. In brief, this class has |
ListDocuments(google::cloud::dialogflow::v2::ListDocumentsRequest, Options)
Returns the list of all documents of the knowledge base.
Parameters | |
---|---|
Name | Description |
request |
google::cloud::dialogflow::v2::ListDocumentsRequest
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::Document > |
a StreamRange to iterate of the results. See the documentation of this type for details. In brief, this class has |
GetDocument(std::string const &, Options)
Retrieves the specified document.
Parameters | |
---|---|
Name | Description |
name |
std::string const &
Required. The name of the document 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::Document > |
the result of the RPC. The response message type (google.cloud.dialogflow.v2.Document) is mapped to a C++ class using the Protobuf mapping rules. If the request fails, the |
GetDocument(google::cloud::dialogflow::v2::GetDocumentRequest const &, Options)
Retrieves the specified document.
Parameters | |
---|---|
Name | Description |
request |
google::cloud::dialogflow::v2::GetDocumentRequest 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::Document > |
the result of the RPC. The response message type (google.cloud.dialogflow.v2.Document) is mapped to a C++ class using the Protobuf mapping rules. If the request fails, the |
CreateDocument(std::string const &, google::cloud::dialogflow::v2::Document const &, Options)
Creates a new document.
This method is a long-running operation. The returned Operation
type has the following method-specific fields:
metadata
: KnowledgeOperationMetadataresponse
: Document
Parameters | |
---|---|
Name | Description |
parent |
std::string const &
Required. The knowledge base to create a document for. Format: |
document |
google::cloud::dialogflow::v2::Document const &
Required. The document to create. |
opts |
Options
Optional. Override the class-level options, such as retry and backoff policies. |
Returns | |
---|---|
Type | Description |
future< StatusOr< google::cloud::dialogflow::v2::Document > > |
A |
CreateDocument(NoAwaitTag, std::string const &, google::cloud::dialogflow::v2::Document const &, Options)
Creates a new document.
Specifying the NoAwaitTag
immediately returns the [google::longrunning::Operation
] that corresponds to the Long Running Operation that has been started. No polling for operation status occurs.
Parameters | |
---|---|
Name | Description |
|
NoAwaitTag
|
parent |
std::string const &
|
document |
google::cloud::dialogflow::v2::Document const &
|
opts |
Options
|
Returns | |
---|---|
Type | Description |
StatusOr< google::longrunning::Operation > |
CreateDocument(google::cloud::dialogflow::v2::CreateDocumentRequest const &, Options)
Creates a new document.
This method is a long-running operation. The returned Operation
type has the following method-specific fields:
metadata
: KnowledgeOperationMetadataresponse
: Document
Parameters | |
---|---|
Name | Description |
request |
google::cloud::dialogflow::v2::CreateDocumentRequest 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 |
future< StatusOr< google::cloud::dialogflow::v2::Document > > |
A |
CreateDocument(NoAwaitTag, google::cloud::dialogflow::v2::CreateDocumentRequest const &, Options)
Creates a new document.
Specifying the NoAwaitTag
immediately returns the [google::longrunning::Operation
] that corresponds to the Long Running Operation that has been started. No polling for operation status occurs.
Parameters | |
---|---|
Name | Description |
|
NoAwaitTag
|
request |
google::cloud::dialogflow::v2::CreateDocumentRequest const &
|
opts |
Options
|
Returns | |
---|---|
Type | Description |
StatusOr< google::longrunning::Operation > |
CreateDocument(google::longrunning::Operation const &, Options)
Creates a new document.
This method accepts a google::longrunning::Operation
that corresponds to a previously started Long Running Operation (LRO) and polls the status of the LRO in the background.
Parameters | |
---|---|
Name | Description |
operation |
google::longrunning::Operation const &
|
opts |
Options
|
Returns | |
---|---|
Type | Description |
future< StatusOr< google::cloud::dialogflow::v2::Document > > |
ImportDocuments(google::cloud::dialogflow::v2::ImportDocumentsRequest const &, Options)
Creates documents by importing data from external sources.
Dialogflow supports up to 350 documents in each request. If you try to import more, Dialogflow will return an error.
This method is a long-running operation. The returned Operation
type has the following method-specific fields:
metadata
: KnowledgeOperationMetadataresponse
: ImportDocumentsResponse
Parameters | |
---|---|
Name | Description |
request |
google::cloud::dialogflow::v2::ImportDocumentsRequest 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 |
future< StatusOr< google::cloud::dialogflow::v2::ImportDocumentsResponse > > |
A |
ImportDocuments(NoAwaitTag, google::cloud::dialogflow::v2::ImportDocumentsRequest const &, Options)
Creates documents by importing data from external sources.
Specifying the NoAwaitTag
immediately returns the [google::longrunning::Operation
] that corresponds to the Long Running Operation that has been started. No polling for operation status occurs.
Parameters | |
---|---|
Name | Description |
|
NoAwaitTag
|
request |
google::cloud::dialogflow::v2::ImportDocumentsRequest const &
|
opts |
Options
|
Returns | |
---|---|
Type | Description |
StatusOr< google::longrunning::Operation > |
ImportDocuments(google::longrunning::Operation const &, Options)
Creates documents by importing data from external sources.
This method accepts a google::longrunning::Operation
that corresponds to a previously started Long Running Operation (LRO) and polls the status of the LRO in the background.
Parameters | |
---|---|
Name | Description |
operation |
google::longrunning::Operation const &
|
opts |
Options
|
Returns | |
---|---|
Type | Description |
future< StatusOr< google::cloud::dialogflow::v2::ImportDocumentsResponse > > |
DeleteDocument(std::string const &, Options)
Deletes the specified document.
This method is a long-running operation. The returned Operation
type has the following method-specific fields:
metadata
: KnowledgeOperationMetadataresponse
: An Empty message
Parameters | |
---|---|
Name | Description |
name |
std::string const &
Required. The name of the document to delete. Format: |
opts |
Options
Optional. Override the class-level options, such as retry and backoff policies. |
Returns | |
---|---|
Type | Description |
future< StatusOr< google::cloud::dialogflow::v2::KnowledgeOperationMetadata > > |
A |
DeleteDocument(NoAwaitTag, std::string const &, Options)
Deletes the specified document.
Specifying the NoAwaitTag
immediately returns the [google::longrunning::Operation
] that corresponds to the Long Running Operation that has been started. No polling for operation status occurs.
Parameters | |
---|---|
Name | Description |
|
NoAwaitTag
|
name |
std::string const &
|
opts |
Options
|
Returns | |
---|---|
Type | Description |
StatusOr< google::longrunning::Operation > |
DeleteDocument(google::cloud::dialogflow::v2::DeleteDocumentRequest const &, Options)
Deletes the specified document.
This method is a long-running operation. The returned Operation
type has the following method-specific fields:
metadata
: KnowledgeOperationMetadataresponse
: An Empty message
Parameters | |
---|---|
Name | Description |
request |
google::cloud::dialogflow::v2::DeleteDocumentRequest 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 |
future< StatusOr< google::cloud::dialogflow::v2::KnowledgeOperationMetadata > > |
A |
DeleteDocument(NoAwaitTag, google::cloud::dialogflow::v2::DeleteDocumentRequest const &, Options)
Deletes the specified document.
Specifying the NoAwaitTag
immediately returns the [google::longrunning::Operation
] that corresponds to the Long Running Operation that has been started. No polling for operation status occurs.
Parameters | |
---|---|
Name | Description |
|
NoAwaitTag
|
request |
google::cloud::dialogflow::v2::DeleteDocumentRequest const &
|
opts |
Options
|
Returns | |
---|---|
Type | Description |
StatusOr< google::longrunning::Operation > |
DeleteDocument(google::longrunning::Operation const &, Options)
Deletes the specified document.
This method accepts a google::longrunning::Operation
that corresponds to a previously started Long Running Operation (LRO) and polls the status of the LRO in the background.
Parameters | |
---|---|
Name | Description |
operation |
google::longrunning::Operation const &
|
opts |
Options
|
Returns | |
---|---|
Type | Description |
future< StatusOr< google::cloud::dialogflow::v2::KnowledgeOperationMetadata > > |
UpdateDocument(google::cloud::dialogflow::v2::Document const &, google::protobuf::FieldMask const &, Options)
Updates the specified document.
This method is a long-running operation. The returned Operation
type has the following method-specific fields:
metadata
: KnowledgeOperationMetadataresponse
: Document
Parameters | |
---|---|
Name | Description |
document |
google::cloud::dialogflow::v2::Document const &
Required. The document 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 |
future< StatusOr< google::cloud::dialogflow::v2::Document > > |
A |
UpdateDocument(NoAwaitTag, google::cloud::dialogflow::v2::Document const &, google::protobuf::FieldMask const &, Options)
Updates the specified document.
Specifying the NoAwaitTag
immediately returns the [google::longrunning::Operation
] that corresponds to the Long Running Operation that has been started. No polling for operation status occurs.
Parameters | |
---|---|
Name | Description |
|
NoAwaitTag
|
document |
google::cloud::dialogflow::v2::Document const &
|
update_mask |
google::protobuf::FieldMask const &
|
opts |
Options
|
Returns | |
---|---|
Type | Description |
StatusOr< google::longrunning::Operation > |
UpdateDocument(google::cloud::dialogflow::v2::UpdateDocumentRequest const &, Options)
Updates the specified document.
This method is a long-running operation. The returned Operation
type has the following method-specific fields:
metadata
: KnowledgeOperationMetadataresponse
: Document
Parameters | |
---|---|
Name | Description |
request |
google::cloud::dialogflow::v2::UpdateDocumentRequest 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 |
future< StatusOr< google::cloud::dialogflow::v2::Document > > |
A |
UpdateDocument(NoAwaitTag, google::cloud::dialogflow::v2::UpdateDocumentRequest const &, Options)
Updates the specified document.
Specifying the NoAwaitTag
immediately returns the [google::longrunning::Operation
] that corresponds to the Long Running Operation that has been started. No polling for operation status occurs.
Parameters | |
---|---|
Name | Description |
|
NoAwaitTag
|
request |
google::cloud::dialogflow::v2::UpdateDocumentRequest const &
|
opts |
Options
|
Returns | |
---|---|
Type | Description |
StatusOr< google::longrunning::Operation > |
UpdateDocument(google::longrunning::Operation const &, Options)
Updates the specified document.
This method accepts a google::longrunning::Operation
that corresponds to a previously started Long Running Operation (LRO) and polls the status of the LRO in the background.
Parameters | |
---|---|
Name | Description |
operation |
google::longrunning::Operation const &
|
opts |
Options
|
Returns | |
---|---|
Type | Description |
future< StatusOr< google::cloud::dialogflow::v2::Document > > |
ReloadDocument(std::string const &, std::string const &, Options)
Reloads the specified document from its specified source, content_uri or content.
The previously loaded content of the document will be deleted. Note: Even when the content of the document has not changed, there still may be side effects because of internal implementation changes.
This method is a long-running operation. The returned Operation
type has the following method-specific fields:
metadata
: KnowledgeOperationMetadataresponse
: Document
Note: The projects.agent.knowledgeBases.documents
resource is deprecated; only use projects.knowledgeBases.documents
.
Parameters | |
---|---|
Name | Description |
name |
std::string const &
Required. The name of the document to reload. Format: |
content_uri |
std::string const &
Optional. The path of gcs source file for reloading document content. For now, only gcs uri is supported. |
opts |
Options
Optional. Override the class-level options, such as retry and backoff policies. |
Returns | |
---|---|
Type | Description |
future< StatusOr< google::cloud::dialogflow::v2::Document > > |
A |
ReloadDocument(NoAwaitTag, std::string const &, std::string const &, Options)
Reloads the specified document from its specified source, content_uri or content.
Specifying the NoAwaitTag
immediately returns the [google::longrunning::Operation
] that corresponds to the Long Running Operation that has been started. No polling for operation status occurs.
Parameters | |
---|---|
Name | Description |
|
NoAwaitTag
|
name |
std::string const &
|
content_uri |
std::string const &
|
opts |
Options
|
Returns | |
---|---|
Type | Description |
StatusOr< google::longrunning::Operation > |
ReloadDocument(google::cloud::dialogflow::v2::ReloadDocumentRequest const &, Options)
Reloads the specified document from its specified source, content_uri or content.
The previously loaded content of the document will be deleted. Note: Even when the content of the document has not changed, there still may be side effects because of internal implementation changes.
This method is a long-running operation. The returned Operation
type has the following method-specific fields:
metadata
: KnowledgeOperationMetadataresponse
: Document
Note: The projects.agent.knowledgeBases.documents
resource is deprecated; only use projects.knowledgeBases.documents
.
Parameters | |
---|---|
Name | Description |
request |
google::cloud::dialogflow::v2::ReloadDocumentRequest 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 |
future< StatusOr< google::cloud::dialogflow::v2::Document > > |
A |
ReloadDocument(NoAwaitTag, google::cloud::dialogflow::v2::ReloadDocumentRequest const &, Options)
Reloads the specified document from its specified source, content_uri or content.
Specifying the NoAwaitTag
immediately returns the [google::longrunning::Operation
] that corresponds to the Long Running Operation that has been started. No polling for operation status occurs.
Parameters | |
---|---|
Name | Description |
|
NoAwaitTag
|
request |
google::cloud::dialogflow::v2::ReloadDocumentRequest const &
|
opts |
Options
|
Returns | |
---|---|
Type | Description |
StatusOr< google::longrunning::Operation > |
ReloadDocument(google::longrunning::Operation const &, Options)
Reloads the specified document from its specified source, content_uri or content.
This method accepts a google::longrunning::Operation
that corresponds to a previously started Long Running Operation (LRO) and polls the status of the LRO in the background.
Parameters | |
---|---|
Name | Description |
operation |
google::longrunning::Operation const &
|
opts |
Options
|
Returns | |
---|---|
Type | Description |
future< StatusOr< google::cloud::dialogflow::v2::Document > > |
ExportDocument(google::cloud::dialogflow::v2::ExportDocumentRequest const &, Options)
Exports a smart messaging candidate document into the specified destination.
This method is a long-running operation. The returned Operation
type has the following method-specific fields:
metadata
: KnowledgeOperationMetadataresponse
: Document
Parameters | |
---|---|
Name | Description |
request |
google::cloud::dialogflow::v2::ExportDocumentRequest 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 |
future< StatusOr< google::cloud::dialogflow::v2::Document > > |
A |
ExportDocument(NoAwaitTag, google::cloud::dialogflow::v2::ExportDocumentRequest const &, Options)
Exports a smart messaging candidate document into the specified destination.
Specifying the NoAwaitTag
immediately returns the [google::longrunning::Operation
] that corresponds to the Long Running Operation that has been started. No polling for operation status occurs.
Parameters | |
---|---|
Name | Description |
|
NoAwaitTag
|
request |
google::cloud::dialogflow::v2::ExportDocumentRequest const &
|
opts |
Options
|
Returns | |
---|---|
Type | Description |
StatusOr< google::longrunning::Operation > |
ExportDocument(google::longrunning::Operation const &, Options)
Exports a smart messaging candidate document into the specified destination.
This method accepts a google::longrunning::Operation
that corresponds to a previously started Long Running Operation (LRO) and polls the status of the LRO in the background.
Parameters | |
---|---|
Name | Description |
operation |
google::longrunning::Operation const &
|
opts |
Options
|
Returns | |
---|---|
Type | Description |
future< StatusOr< google::cloud::dialogflow::v2::Document > > |