public sealed class DocumentsClientImpl : DocumentsClientReference documentation and code samples for the Google Cloud Dialogflow v2 API class DocumentsClientImpl.
Documents client wrapper implementation, for convenient use.
Namespace
Google.Cloud.Dialogflow.V2Assembly
Google.Cloud.Dialogflow.V2.dll
Remarks
Service for managing knowledge [Documents][google.cloud.dialogflow.v2.Document].
Constructors
DocumentsClientImpl(DocumentsClient, DocumentsSettings, ILogger)
public DocumentsClientImpl(Documents.DocumentsClient grpcClient, DocumentsSettings settings, ILogger logger)Constructs a client wrapper for the Documents service, with the specified gRPC client and settings.
| Parameters | |
|---|---|
| Name | Description |
grpcClient | DocumentsDocumentsClientThe underlying gRPC client. |
settings | DocumentsSettingsThe base DocumentsSettings used within this client. |
logger | ILoggerOptional ILogger to use within this client. |
Properties
CreateDocumentOperationsClient
public override OperationsClient CreateDocumentOperationsClient { get; }The long-running operations client for CreateDocument.
| Property Value | |
|---|---|
| Type | Description |
OperationsClient | |
DeleteDocumentOperationsClient
public override OperationsClient DeleteDocumentOperationsClient { get; }The long-running operations client for DeleteDocument.
| Property Value | |
|---|---|
| Type | Description |
OperationsClient | |
ExportDocumentOperationsClient
public override OperationsClient ExportDocumentOperationsClient { get; }The long-running operations client for ExportDocument.
| Property Value | |
|---|---|
| Type | Description |
OperationsClient | |
GrpcClient
public override Documents.DocumentsClient GrpcClient { get; }The underlying gRPC Documents client
| Property Value | |
|---|---|
| Type | Description |
DocumentsDocumentsClient | |
ImportDocumentsOperationsClient
public override OperationsClient ImportDocumentsOperationsClient { get; }The long-running operations client for ImportDocuments.
| Property Value | |
|---|---|
| Type | Description |
OperationsClient | |
LocationsClient
public override LocationsClient LocationsClient { get; }The LocationsClient associated with this client.
| Property Value | |
|---|---|
| Type | Description |
LocationsClient | |
ReloadDocumentOperationsClient
public override OperationsClient ReloadDocumentOperationsClient { get; }The long-running operations client for ReloadDocument.
| Property Value | |
|---|---|
| Type | Description |
OperationsClient | |
UpdateDocumentOperationsClient
public override OperationsClient UpdateDocumentOperationsClient { get; }The long-running operations client for UpdateDocument.
| Property Value | |
|---|---|
| Type | Description |
OperationsClient | |
Methods
CreateDocument(CreateDocumentRequest, CallSettings)
public override Operation<Document, KnowledgeOperationMetadata> CreateDocument(CreateDocumentRequest request, CallSettings callSettings = null)Creates a new document.
This method is a long-running
operation.
The returned Operation type has the following method-specific fields:
metadata: [KnowledgeOperationMetadata][google.cloud.dialogflow.v2.KnowledgeOperationMetadata]response: [Document][google.cloud.dialogflow.v2.Document]
| Parameters | |
|---|---|
| Name | Description |
request | CreateDocumentRequestThe request object containing all of the parameters for the API call. |
callSettings | CallSettingsIf not null, applies overrides to this RPC call. |
| Returns | |
|---|---|
| Type | Description |
OperationDocumentKnowledgeOperationMetadata | The RPC response. |
CreateDocumentAsync(CreateDocumentRequest, CallSettings)
public override Task<Operation<Document, KnowledgeOperationMetadata>> CreateDocumentAsync(CreateDocumentRequest request, CallSettings callSettings = null)Creates a new document.
This method is a long-running
operation.
The returned Operation type has the following method-specific fields:
metadata: [KnowledgeOperationMetadata][google.cloud.dialogflow.v2.KnowledgeOperationMetadata]response: [Document][google.cloud.dialogflow.v2.Document]
| Parameters | |
|---|---|
| Name | Description |
request | CreateDocumentRequestThe request object containing all of the parameters for the API call. |
callSettings | CallSettingsIf not null, applies overrides to this RPC call. |
| Returns | |
|---|---|
| Type | Description |
TaskOperationDocumentKnowledgeOperationMetadata | A Task containing the RPC response. |
DeleteDocument(DeleteDocumentRequest, CallSettings)
public override Operation<Empty, KnowledgeOperationMetadata> DeleteDocument(DeleteDocumentRequest request, CallSettings callSettings = null)Deletes the specified document.
This method is a long-running
operation.
The returned Operation type has the following method-specific fields:
metadata: [KnowledgeOperationMetadata][google.cloud.dialogflow.v2.KnowledgeOperationMetadata]response: An Empty message
| Parameters | |
|---|---|
| Name | Description |
request | DeleteDocumentRequestThe request object containing all of the parameters for the API call. |
callSettings | CallSettingsIf not null, applies overrides to this RPC call. |
| Returns | |
|---|---|
| Type | Description |
OperationEmptyKnowledgeOperationMetadata | The RPC response. |
DeleteDocumentAsync(DeleteDocumentRequest, CallSettings)
public override Task<Operation<Empty, KnowledgeOperationMetadata>> DeleteDocumentAsync(DeleteDocumentRequest request, CallSettings callSettings = null)Deletes the specified document.
This method is a long-running
operation.
The returned Operation type has the following method-specific fields:
metadata: [KnowledgeOperationMetadata][google.cloud.dialogflow.v2.KnowledgeOperationMetadata]response: An Empty message
| Parameters | |
|---|---|
| Name | Description |
request | DeleteDocumentRequestThe request object containing all of the parameters for the API call. |
callSettings | CallSettingsIf not null, applies overrides to this RPC call. |
| Returns | |
|---|---|
| Type | Description |
TaskOperationEmptyKnowledgeOperationMetadata | A Task containing the RPC response. |
ExportDocument(ExportDocumentRequest, CallSettings)
public override Operation<Document, KnowledgeOperationMetadata> ExportDocument(ExportDocumentRequest request, CallSettings callSettings = null)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: [KnowledgeOperationMetadata][google.cloud.dialogflow.v2.KnowledgeOperationMetadata]response: [Document][google.cloud.dialogflow.v2.Document]
| Parameters | |
|---|---|
| Name | Description |
request | ExportDocumentRequestThe request object containing all of the parameters for the API call. |
callSettings | CallSettingsIf not null, applies overrides to this RPC call. |
| Returns | |
|---|---|
| Type | Description |
OperationDocumentKnowledgeOperationMetadata | The RPC response. |
ExportDocumentAsync(ExportDocumentRequest, CallSettings)
public override Task<Operation<Document, KnowledgeOperationMetadata>> ExportDocumentAsync(ExportDocumentRequest request, CallSettings callSettings = null)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: [KnowledgeOperationMetadata][google.cloud.dialogflow.v2.KnowledgeOperationMetadata]response: [Document][google.cloud.dialogflow.v2.Document]
| Parameters | |
|---|---|
| Name | Description |
request | ExportDocumentRequestThe request object containing all of the parameters for the API call. |
callSettings | CallSettingsIf not null, applies overrides to this RPC call. |
| Returns | |
|---|---|
| Type | Description |
TaskOperationDocumentKnowledgeOperationMetadata | A Task containing the RPC response. |
GetDocument(GetDocumentRequest, CallSettings)
public override Document GetDocument(GetDocumentRequest request, CallSettings callSettings = null)Retrieves the specified document.
| Parameters | |
|---|---|
| Name | Description |
request | GetDocumentRequestThe request object containing all of the parameters for the API call. |
callSettings | CallSettingsIf not null, applies overrides to this RPC call. |
| Returns | |
|---|---|
| Type | Description |
Document | The RPC response. |
GetDocumentAsync(GetDocumentRequest, CallSettings)
public override Task<Document> GetDocumentAsync(GetDocumentRequest request, CallSettings callSettings = null)Retrieves the specified document.
| Parameters | |
|---|---|
| Name | Description |
request | GetDocumentRequestThe request object containing all of the parameters for the API call. |
callSettings | CallSettingsIf not null, applies overrides to this RPC call. |
| Returns | |
|---|---|
| Type | Description |
TaskDocument | A Task containing the RPC response. |
ImportDocuments(ImportDocumentsRequest, CallSettings)
public override Operation<ImportDocumentsResponse, KnowledgeOperationMetadata> ImportDocuments(ImportDocumentsRequest request, CallSettings callSettings = null)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: [KnowledgeOperationMetadata][google.cloud.dialogflow.v2.KnowledgeOperationMetadata]response: [ImportDocumentsResponse][google.cloud.dialogflow.v2.ImportDocumentsResponse]
| Parameters | |
|---|---|
| Name | Description |
request | ImportDocumentsRequestThe request object containing all of the parameters for the API call. |
callSettings | CallSettingsIf not null, applies overrides to this RPC call. |
| Returns | |
|---|---|
| Type | Description |
OperationImportDocumentsResponseKnowledgeOperationMetadata | The RPC response. |
ImportDocumentsAsync(ImportDocumentsRequest, CallSettings)
public override Task<Operation<ImportDocumentsResponse, KnowledgeOperationMetadata>> ImportDocumentsAsync(ImportDocumentsRequest request, CallSettings callSettings = null)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: [KnowledgeOperationMetadata][google.cloud.dialogflow.v2.KnowledgeOperationMetadata]response: [ImportDocumentsResponse][google.cloud.dialogflow.v2.ImportDocumentsResponse]
| Parameters | |
|---|---|
| Name | Description |
request | ImportDocumentsRequestThe request object containing all of the parameters for the API call. |
callSettings | CallSettingsIf not null, applies overrides to this RPC call. |
| Returns | |
|---|---|
| Type | Description |
TaskOperationImportDocumentsResponseKnowledgeOperationMetadata | A Task containing the RPC response. |
ListDocuments(ListDocumentsRequest, CallSettings)
public override PagedEnumerable<ListDocumentsResponse, Document> ListDocuments(ListDocumentsRequest request, CallSettings callSettings = null)Returns the list of all documents of the knowledge base.
| Parameters | |
|---|---|
| Name | Description |
request | ListDocumentsRequestThe request object containing all of the parameters for the API call. |
callSettings | CallSettingsIf not null, applies overrides to this RPC call. |
| Returns | |
|---|---|
| Type | Description |
PagedEnumerableListDocumentsResponseDocument | A pageable sequence of Document resources. |
ListDocumentsAsync(ListDocumentsRequest, CallSettings)
public override PagedAsyncEnumerable<ListDocumentsResponse, Document> ListDocumentsAsync(ListDocumentsRequest request, CallSettings callSettings = null)Returns the list of all documents of the knowledge base.
| Parameters | |
|---|---|
| Name | Description |
request | ListDocumentsRequestThe request object containing all of the parameters for the API call. |
callSettings | CallSettingsIf not null, applies overrides to this RPC call. |
| Returns | |
|---|---|
| Type | Description |
PagedAsyncEnumerableListDocumentsResponseDocument | A pageable asynchronous sequence of Document resources. |
ReloadDocument(ReloadDocumentRequest, CallSettings)
public override Operation<Document, KnowledgeOperationMetadata> ReloadDocument(ReloadDocumentRequest request, CallSettings callSettings = null)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: [KnowledgeOperationMetadata][google.cloud.dialogflow.v2.KnowledgeOperationMetadata]response: [Document][google.cloud.dialogflow.v2.Document]
Note: The projects.agent.knowledgeBases.documents resource is deprecated;
only use projects.knowledgeBases.documents.
| Parameters | |
|---|---|
| Name | Description |
request | ReloadDocumentRequestThe request object containing all of the parameters for the API call. |
callSettings | CallSettingsIf not null, applies overrides to this RPC call. |
| Returns | |
|---|---|
| Type | Description |
OperationDocumentKnowledgeOperationMetadata | The RPC response. |
ReloadDocumentAsync(ReloadDocumentRequest, CallSettings)
public override Task<Operation<Document, KnowledgeOperationMetadata>> ReloadDocumentAsync(ReloadDocumentRequest request, CallSettings callSettings = null)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: [KnowledgeOperationMetadata][google.cloud.dialogflow.v2.KnowledgeOperationMetadata]response: [Document][google.cloud.dialogflow.v2.Document]
Note: The projects.agent.knowledgeBases.documents resource is deprecated;
only use projects.knowledgeBases.documents.
| Parameters | |
|---|---|
| Name | Description |
request | ReloadDocumentRequestThe request object containing all of the parameters for the API call. |
callSettings | CallSettingsIf not null, applies overrides to this RPC call. |
| Returns | |
|---|---|
| Type | Description |
TaskOperationDocumentKnowledgeOperationMetadata | A Task containing the RPC response. |
UpdateDocument(UpdateDocumentRequest, CallSettings)
public override Operation<Document, KnowledgeOperationMetadata> UpdateDocument(UpdateDocumentRequest request, CallSettings callSettings = null)Updates the specified document.
This method is a long-running
operation.
The returned Operation type has the following method-specific fields:
metadata: [KnowledgeOperationMetadata][google.cloud.dialogflow.v2.KnowledgeOperationMetadata]response: [Document][google.cloud.dialogflow.v2.Document]
| Parameters | |
|---|---|
| Name | Description |
request | UpdateDocumentRequestThe request object containing all of the parameters for the API call. |
callSettings | CallSettingsIf not null, applies overrides to this RPC call. |
| Returns | |
|---|---|
| Type | Description |
OperationDocumentKnowledgeOperationMetadata | The RPC response. |
UpdateDocumentAsync(UpdateDocumentRequest, CallSettings)
public override Task<Operation<Document, KnowledgeOperationMetadata>> UpdateDocumentAsync(UpdateDocumentRequest request, CallSettings callSettings = null)Updates the specified document.
This method is a long-running
operation.
The returned Operation type has the following method-specific fields:
metadata: [KnowledgeOperationMetadata][google.cloud.dialogflow.v2.KnowledgeOperationMetadata]response: [Document][google.cloud.dialogflow.v2.Document]
| Parameters | |
|---|---|
| Name | Description |
request | UpdateDocumentRequestThe request object containing all of the parameters for the API call. |
callSettings | CallSettingsIf not null, applies overrides to this RPC call. |
| Returns | |
|---|---|
| Type | Description |
TaskOperationDocumentKnowledgeOperationMetadata | A Task containing the RPC response. |