public abstract class DocumentsClientReference documentation and code samples for the Google Cloud Dialogflow v2beta1 API class DocumentsClient.
Documents client wrapper, for convenient use.
Derived Types
Namespace
Google.Cloud.Dialogflow.V2Beta1Assembly
Google.Cloud.Dialogflow.V2Beta1.dll
Remarks
Service for managing knowledge [Documents][google.cloud.dialogflow.v2beta1.Document].
Properties
CreateDocumentOperationsClient
public virtual OperationsClient CreateDocumentOperationsClient { get; }The long-running operations client for CreateDocument.
| Property Value | |
|---|---|
| Type | Description |
OperationsClient |
|
DefaultEndpoint
public static string DefaultEndpoint { get; }The default endpoint for the Documents service, which is a host of "dialogflow.googleapis.com" and a port of 443.
| Property Value | |
|---|---|
| Type | Description |
string |
|
DefaultScopes
public static IReadOnlyList<string> DefaultScopes { get; }The default Documents scopes.
| Property Value | |
|---|---|
| Type | Description |
IReadOnlyListstring |
|
The default Documents scopes are:
DeleteDocumentOperationsClient
public virtual OperationsClient DeleteDocumentOperationsClient { get; }The long-running operations client for DeleteDocument.
| Property Value | |
|---|---|
| Type | Description |
OperationsClient |
|
GrpcClient
public virtual Documents.DocumentsClient GrpcClient { get; }The underlying gRPC Documents client
| Property Value | |
|---|---|
| Type | Description |
DocumentsDocumentsClient |
|
ImportDocumentsOperationsClient
public virtual OperationsClient ImportDocumentsOperationsClient { get; }The long-running operations client for ImportDocuments.
| Property Value | |
|---|---|
| Type | Description |
OperationsClient |
|
LocationsClient
public virtual LocationsClient LocationsClient { get; }The LocationsClient associated with this client.
| Property Value | |
|---|---|
| Type | Description |
LocationsClient |
|
ReloadDocumentOperationsClient
public virtual OperationsClient ReloadDocumentOperationsClient { get; }The long-running operations client for ReloadDocument.
| Property Value | |
|---|---|
| Type | Description |
OperationsClient |
|
ServiceMetadata
public static ServiceMetadata ServiceMetadata { get; }The service metadata associated with this client type.
| Property Value | |
|---|---|
| Type | Description |
ServiceMetadata |
|
UpdateDocumentOperationsClient
public virtual OperationsClient UpdateDocumentOperationsClient { get; }The long-running operations client for UpdateDocument.
| Property Value | |
|---|---|
| Type | Description |
OperationsClient |
|
Methods
Create()
public static DocumentsClient Create()Synchronously creates a DocumentsClient using the default credentials, endpoint and settings. To specify custom credentials or other settings, use DocumentsClientBuilder.
| Returns | |
|---|---|
| Type | Description |
DocumentsClient |
The created DocumentsClient. |
CreateAsync(CancellationToken)
public static Task<DocumentsClient> CreateAsync(CancellationToken cancellationToken = default)Asynchronously creates a DocumentsClient using the default credentials, endpoint and settings. To specify custom credentials or other settings, use DocumentsClientBuilder.
| Parameter | |
|---|---|
| Name | Description |
cancellationToken |
CancellationTokenThe CancellationToken to use while creating the client. |
| Returns | |
|---|---|
| Type | Description |
TaskDocumentsClient |
The task representing the created DocumentsClient. |
CreateDocument(CreateDocumentRequest, CallSettings)
public virtual 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.v2beta1.KnowledgeOperationMetadata]response: [Document][google.cloud.dialogflow.v2beta1.Document]
Note: The projects.agent.knowledgeBases.documents resource is deprecated;
only use projects.knowledgeBases.documents.
| 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. |
// Create client
DocumentsClient documentsClient = DocumentsClient.Create();
// Initialize request argument(s)
CreateDocumentRequest request = new CreateDocumentRequest
{
ParentAsKnowledgeBaseName = KnowledgeBaseName.FromProjectKnowledgeBase("[PROJECT]", "[KNOWLEDGE_BASE]"),
Document = new Document(),
ImportGcsCustomMetadata = false,
};
// Make the request
Operation<Document, KnowledgeOperationMetadata> response = documentsClient.CreateDocument(request);
// Poll until the returned long-running operation is complete
Operation<Document, KnowledgeOperationMetadata> completedResponse = response.PollUntilCompleted();
// Retrieve the operation result
Document result = completedResponse.Result;
// Or get the name of the operation
string operationName = response.Name;
// This name can be stored, then the long-running operation retrieved later by name
Operation<Document, KnowledgeOperationMetadata> retrievedResponse = documentsClient.PollOnceCreateDocument(operationName);
// Check if the retrieved long-running operation has completed
if (retrievedResponse.IsCompleted)
{
// If it has completed, then access the result
Document retrievedResult = retrievedResponse.Result;
}
CreateDocument(KnowledgeBaseName, Document, CallSettings)
public virtual Operation<Document, KnowledgeOperationMetadata> CreateDocument(KnowledgeBaseName parent, Document document, 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.v2beta1.KnowledgeOperationMetadata]response: [Document][google.cloud.dialogflow.v2beta1.Document]
Note: The projects.agent.knowledgeBases.documents resource is deprecated;
only use projects.knowledgeBases.documents.
| Parameters | |
|---|---|
| Name | Description |
parent |
KnowledgeBaseNameRequired. The knowledge base to create a document for.
Format: |
document |
DocumentRequired. The document to create. |
callSettings |
CallSettingsIf not null, applies overrides to this RPC call. |
| Returns | |
|---|---|
| Type | Description |
OperationDocumentKnowledgeOperationMetadata |
The RPC response. |
// Create client
DocumentsClient documentsClient = DocumentsClient.Create();
// Initialize request argument(s)
KnowledgeBaseName parent = KnowledgeBaseName.FromProjectKnowledgeBase("[PROJECT]", "[KNOWLEDGE_BASE]");
Document document = new Document();
// Make the request
Operation<Document, KnowledgeOperationMetadata> response = documentsClient.CreateDocument(parent, document);
// Poll until the returned long-running operation is complete
Operation<Document, KnowledgeOperationMetadata> completedResponse = response.PollUntilCompleted();
// Retrieve the operation result
Document result = completedResponse.Result;
// Or get the name of the operation
string operationName = response.Name;
// This name can be stored, then the long-running operation retrieved later by name
Operation<Document, KnowledgeOperationMetadata> retrievedResponse = documentsClient.PollOnceCreateDocument(operationName);
// Check if the retrieved long-running operation has completed
if (retrievedResponse.IsCompleted)
{
// If it has completed, then access the result
Document retrievedResult = retrievedResponse.Result;
}
CreateDocument(string, Document, CallSettings)
public virtual Operation<Document, KnowledgeOperationMetadata> CreateDocument(string parent, Document document, 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.v2beta1.KnowledgeOperationMetadata]response: [Document][google.cloud.dialogflow.v2beta1.Document]
Note: The projects.agent.knowledgeBases.documents resource is deprecated;
only use projects.knowledgeBases.documents.
| Parameters | |
|---|---|
| Name | Description |
parent |
stringRequired. The knowledge base to create a document for.
Format: |
document |
DocumentRequired. The document to create. |
callSettings |
CallSettingsIf not null, applies overrides to this RPC call. |
| Returns | |
|---|---|
| Type | Description |
OperationDocumentKnowledgeOperationMetadata |
The RPC response. |
// Create client
DocumentsClient documentsClient = DocumentsClient.Create();
// Initialize request argument(s)
string parent = "projects/[PROJECT]/knowledgeBases/[KNOWLEDGE_BASE]";
Document document = new Document();
// Make the request
Operation<Document, KnowledgeOperationMetadata> response = documentsClient.CreateDocument(parent, document);
// Poll until the returned long-running operation is complete
Operation<Document, KnowledgeOperationMetadata> completedResponse = response.PollUntilCompleted();
// Retrieve the operation result
Document result = completedResponse.Result;
// Or get the name of the operation
string operationName = response.Name;
// This name can be stored, then the long-running operation retrieved later by name
Operation<Document, KnowledgeOperationMetadata> retrievedResponse = documentsClient.PollOnceCreateDocument(operationName);
// Check if the retrieved long-running operation has completed
if (retrievedResponse.IsCompleted)
{
// If it has completed, then access the result
Document retrievedResult = retrievedResponse.Result;
}
CreateDocumentAsync(CreateDocumentRequest, CallSettings)
public virtual 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.v2beta1.KnowledgeOperationMetadata]response: [Document][google.cloud.dialogflow.v2beta1.Document]
Note: The projects.agent.knowledgeBases.documents resource is deprecated;
only use projects.knowledgeBases.documents.
| 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. |
// Create client
DocumentsClient documentsClient = await DocumentsClient.CreateAsync();
// Initialize request argument(s)
CreateDocumentRequest request = new CreateDocumentRequest
{
ParentAsKnowledgeBaseName = KnowledgeBaseName.FromProjectKnowledgeBase("[PROJECT]", "[KNOWLEDGE_BASE]"),
Document = new Document(),
ImportGcsCustomMetadata = false,
};
// Make the request
Operation<Document, KnowledgeOperationMetadata> response = await documentsClient.CreateDocumentAsync(request);
// Poll until the returned long-running operation is complete
Operation<Document, KnowledgeOperationMetadata> completedResponse = await response.PollUntilCompletedAsync();
// Retrieve the operation result
Document result = completedResponse.Result;
// Or get the name of the operation
string operationName = response.Name;
// This name can be stored, then the long-running operation retrieved later by name
Operation<Document, KnowledgeOperationMetadata> retrievedResponse = await documentsClient.PollOnceCreateDocumentAsync(operationName);
// Check if the retrieved long-running operation has completed
if (retrievedResponse.IsCompleted)
{
// If it has completed, then access the result
Document retrievedResult = retrievedResponse.Result;
}
CreateDocumentAsync(CreateDocumentRequest, CancellationToken)
public virtual Task<Operation<Document, KnowledgeOperationMetadata>> CreateDocumentAsync(CreateDocumentRequest request, CancellationToken cancellationToken)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.v2beta1.KnowledgeOperationMetadata]response: [Document][google.cloud.dialogflow.v2beta1.Document]
Note: The projects.agent.knowledgeBases.documents resource is deprecated;
only use projects.knowledgeBases.documents.
| Parameters | |
|---|---|
| Name | Description |
request |
CreateDocumentRequestThe request object containing all of the parameters for the API call. |
cancellationToken |
CancellationTokenA CancellationToken to use for this RPC. |
| Returns | |
|---|---|
| Type | Description |
TaskOperationDocumentKnowledgeOperationMetadata |
A Task containing the RPC response. |
// Create client
DocumentsClient documentsClient = await DocumentsClient.CreateAsync();
// Initialize request argument(s)
CreateDocumentRequest request = new CreateDocumentRequest
{
ParentAsKnowledgeBaseName = KnowledgeBaseName.FromProjectKnowledgeBase("[PROJECT]", "[KNOWLEDGE_BASE]"),
Document = new Document(),
ImportGcsCustomMetadata = false,
};
// Make the request
Operation<Document, KnowledgeOperationMetadata> response = await documentsClient.CreateDocumentAsync(request);
// Poll until the returned long-running operation is complete
Operation<Document, KnowledgeOperationMetadata> completedResponse = await response.PollUntilCompletedAsync();
// Retrieve the operation result
Document result = completedResponse.Result;
// Or get the name of the operation
string operationName = response.Name;
// This name can be stored, then the long-running operation retrieved later by name
Operation<Document, KnowledgeOperationMetadata> retrievedResponse = await documentsClient.PollOnceCreateDocumentAsync(operationName);
// Check if the retrieved long-running operation has completed
if (retrievedResponse.IsCompleted)
{
// If it has completed, then access the result
Document retrievedResult = retrievedResponse.Result;
}
CreateDocumentAsync(KnowledgeBaseName, Document, CallSettings)
public virtual Task<Operation<Document, KnowledgeOperationMetadata>> CreateDocumentAsync(KnowledgeBaseName parent, Document document, 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.v2beta1.KnowledgeOperationMetadata]response: [Document][google.cloud.dialogflow.v2beta1.Document]
Note: The projects.agent.knowledgeBases.documents resource is deprecated;
only use projects.knowledgeBases.documents.
| Parameters | |
|---|---|
| Name | Description |
parent |
KnowledgeBaseNameRequired. The knowledge base to create a document for.
Format: |
document |
DocumentRequired. The document to create. |
callSettings |
CallSettingsIf not null, applies overrides to this RPC call. |
| Returns | |
|---|---|
| Type | Description |
TaskOperationDocumentKnowledgeOperationMetadata |
A Task containing the RPC response. |
// Create client
DocumentsClient documentsClient = await DocumentsClient.CreateAsync();
// Initialize request argument(s)
KnowledgeBaseName parent = KnowledgeBaseName.FromProjectKnowledgeBase("[PROJECT]", "[KNOWLEDGE_BASE]");
Document document = new Document();
// Make the request
Operation<Document, KnowledgeOperationMetadata> response = await documentsClient.CreateDocumentAsync(parent, document);
// Poll until the returned long-running operation is complete
Operation<Document, KnowledgeOperationMetadata> completedResponse = await response.PollUntilCompletedAsync();
// Retrieve the operation result
Document result = completedResponse.Result;
// Or get the name of the operation
string operationName = response.Name;
// This name can be stored, then the long-running operation retrieved later by name
Operation<Document, KnowledgeOperationMetadata> retrievedResponse = await documentsClient.PollOnceCreateDocumentAsync(operationName);
// Check if the retrieved long-running operation has completed
if (retrievedResponse.IsCompleted)
{
// If it has completed, then access the result
Document retrievedResult = retrievedResponse.Result;
}
CreateDocumentAsync(KnowledgeBaseName, Document, CancellationToken)
public virtual Task<Operation<Document, KnowledgeOperationMetadata>> CreateDocumentAsync(KnowledgeBaseName parent, Document document, CancellationToken cancellationToken)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.v2beta1.KnowledgeOperationMetadata]response: [Document][google.cloud.dialogflow.v2beta1.Document]
Note: The projects.agent.knowledgeBases.documents resource is deprecated;
only use projects.knowledgeBases.documents.
| Parameters | |
|---|---|
| Name | Description |
parent |
KnowledgeBaseNameRequired. The knowledge base to create a document for.
Format: |
document |
DocumentRequired. The document to create. |
cancellationToken |
CancellationTokenA CancellationToken to use for this RPC. |
| Returns | |
|---|---|
| Type | Description |
TaskOperationDocumentKnowledgeOperationMetadata |
A Task containing the RPC response. |
// Create client
DocumentsClient documentsClient = await DocumentsClient.CreateAsync();
// Initialize request argument(s)
KnowledgeBaseName parent = KnowledgeBaseName.FromProjectKnowledgeBase("[PROJECT]", "[KNOWLEDGE_BASE]");
Document document = new Document();
// Make the request
Operation<Document, KnowledgeOperationMetadata> response = await documentsClient.CreateDocumentAsync(parent, document);
// Poll until the returned long-running operation is complete
Operation<Document, KnowledgeOperationMetadata> completedResponse = await response.PollUntilCompletedAsync();
// Retrieve the operation result
Document result = completedResponse.Result;
// Or get the name of the operation
string operationName = response.Name;
// This name can be stored, then the long-running operation retrieved later by name
Operation<Document, KnowledgeOperationMetadata> retrievedResponse = await documentsClient.PollOnceCreateDocumentAsync(operationName);
// Check if the retrieved long-running operation has completed
if (retrievedResponse.IsCompleted)
{
// If it has completed, then access the result
Document retrievedResult = retrievedResponse.Result;
}
CreateDocumentAsync(string, Document, CallSettings)
public virtual Task<Operation<Document, KnowledgeOperationMetadata>> CreateDocumentAsync(string parent, Document document, 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.v2beta1.KnowledgeOperationMetadata]response: [Document][google.cloud.dialogflow.v2beta1.Document]
Note: The projects.agent.knowledgeBases.documents resource is deprecated;
only use projects.knowledgeBases.documents.
| Parameters | |
|---|---|
| Name | Description |
parent |
stringRequired. The knowledge base to create a document for.
Format: |
document |
DocumentRequired. The document to create. |
callSettings |
CallSettingsIf not null, applies overrides to this RPC call. |
| Returns | |
|---|---|
| Type | Description |
TaskOperationDocumentKnowledgeOperationMetadata |
A Task containing the RPC response. |
// Create client
DocumentsClient documentsClient = await DocumentsClient.CreateAsync();
// Initialize request argument(s)
string parent = "projects/[PROJECT]/knowledgeBases/[KNOWLEDGE_BASE]";
Document document = new Document();
// Make the request
Operation<Document, KnowledgeOperationMetadata> response = await documentsClient.CreateDocumentAsync(parent, document);
// Poll until the returned long-running operation is complete
Operation<Document, KnowledgeOperationMetadata> completedResponse = await response.PollUntilCompletedAsync();
// Retrieve the operation result
Document result = completedResponse.Result;
// Or get the name of the operation
string operationName = response.Name;
// This name can be stored, then the long-running operation retrieved later by name
Operation<Document, KnowledgeOperationMetadata> retrievedResponse = await documentsClient.PollOnceCreateDocumentAsync(operationName);
// Check if the retrieved long-running operation has completed
if (retrievedResponse.IsCompleted)
{
// If it has completed, then access the result
Document retrievedResult = retrievedResponse.Result;
}
CreateDocumentAsync(string, Document, CancellationToken)
public virtual Task<Operation<Document, KnowledgeOperationMetadata>> CreateDocumentAsync(string parent, Document document, CancellationToken cancellationToken)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.v2beta1.KnowledgeOperationMetadata]response: [Document][google.cloud.dialogflow.v2beta1.Document]
Note: The projects.agent.knowledgeBases.documents resource is deprecated;
only use projects.knowledgeBases.documents.
| Parameters | |
|---|---|
| Name | Description |
parent |
stringRequired. The knowledge base to create a document for.
Format: |
document |
DocumentRequired. The document to create. |
cancellationToken |
CancellationTokenA CancellationToken to use for this RPC. |
| Returns | |
|---|---|
| Type | Description |
TaskOperationDocumentKnowledgeOperationMetadata |
A Task containing the RPC response. |
// Create client
DocumentsClient documentsClient = await DocumentsClient.CreateAsync();
// Initialize request argument(s)
string parent = "projects/[PROJECT]/knowledgeBases/[KNOWLEDGE_BASE]";
Document document = new Document();
// Make the request
Operation<Document, KnowledgeOperationMetadata> response = await documentsClient.CreateDocumentAsync(parent, document);
// Poll until the returned long-running operation is complete
Operation<Document, KnowledgeOperationMetadata> completedResponse = await response.PollUntilCompletedAsync();
// Retrieve the operation result
Document result = completedResponse.Result;
// Or get the name of the operation
string operationName = response.Name;
// This name can be stored, then the long-running operation retrieved later by name
Operation<Document, KnowledgeOperationMetadata> retrievedResponse = await documentsClient.PollOnceCreateDocumentAsync(operationName);
// Check if the retrieved long-running operation has completed
if (retrievedResponse.IsCompleted)
{
// If it has completed, then access the result
Document retrievedResult = retrievedResponse.Result;
}
DeleteDocument(DeleteDocumentRequest, CallSettings)
public virtual 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.v2beta1.KnowledgeOperationMetadata]response: An Empty message
Note: The projects.agent.knowledgeBases.documents resource is deprecated;
only use projects.knowledgeBases.documents.
| 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. |
// Create client
DocumentsClient documentsClient = DocumentsClient.Create();
// Initialize request argument(s)
DeleteDocumentRequest request = new DeleteDocumentRequest
{
DocumentName = DocumentName.FromProjectKnowledgeBaseDocument("[PROJECT]", "[KNOWLEDGE_BASE]", "[DOCUMENT]"),
};
// Make the request
Operation<Empty, KnowledgeOperationMetadata> response = documentsClient.DeleteDocument(request);
// Poll until the returned long-running operation is complete
Operation<Empty, KnowledgeOperationMetadata> completedResponse = response.PollUntilCompleted();
// Retrieve the operation result
Empty result = completedResponse.Result;
// Or get the name of the operation
string operationName = response.Name;
// This name can be stored, then the long-running operation retrieved later by name
Operation<Empty, KnowledgeOperationMetadata> retrievedResponse = documentsClient.PollOnceDeleteDocument(operationName);
// Check if the retrieved long-running operation has completed
if (retrievedResponse.IsCompleted)
{
// If it has completed, then access the result
Empty retrievedResult = retrievedResponse.Result;
}
DeleteDocument(DocumentName, CallSettings)
public virtual Operation<Empty, KnowledgeOperationMetadata> DeleteDocument(DocumentName name, 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.v2beta1.KnowledgeOperationMetadata]response: An Empty message
Note: The projects.agent.knowledgeBases.documents resource is deprecated;
only use projects.knowledgeBases.documents.
| Parameters | |
|---|---|
| Name | Description |
name |
DocumentNameRequired. The name of the document to delete.
Format: |
callSettings |
CallSettingsIf not null, applies overrides to this RPC call. |
| Returns | |
|---|---|
| Type | Description |
OperationEmptyKnowledgeOperationMetadata |
The RPC response. |
// Create client
DocumentsClient documentsClient = DocumentsClient.Create();
// Initialize request argument(s)
DocumentName name = DocumentName.FromProjectKnowledgeBaseDocument("[PROJECT]", "[KNOWLEDGE_BASE]", "[DOCUMENT]");
// Make the request
Operation<Empty, KnowledgeOperationMetadata> response = documentsClient.DeleteDocument(name);
// Poll until the returned long-running operation is complete
Operation<Empty, KnowledgeOperationMetadata> completedResponse = response.PollUntilCompleted();
// Retrieve the operation result
Empty result = completedResponse.Result;
// Or get the name of the operation
string operationName = response.Name;
// This name can be stored, then the long-running operation retrieved later by name
Operation<Empty, KnowledgeOperationMetadata> retrievedResponse = documentsClient.PollOnceDeleteDocument(operationName);
// Check if the retrieved long-running operation has completed
if (retrievedResponse.IsCompleted)
{
// If it has completed, then access the result
Empty retrievedResult = retrievedResponse.Result;
}
DeleteDocument(string, CallSettings)
public virtual Operation<Empty, KnowledgeOperationMetadata> DeleteDocument(string name, 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.v2beta1.KnowledgeOperationMetadata]response: An Empty message
Note: The projects.agent.knowledgeBases.documents resource is deprecated;
only use projects.knowledgeBases.documents.
| Parameters | |
|---|---|
| Name | Description |
name |
stringRequired. The name of the document to delete.
Format: |
callSettings |
CallSettingsIf not null, applies overrides to this RPC call. |
| Returns | |
|---|---|
| Type | Description |
OperationEmptyKnowledgeOperationMetadata |
The RPC response. |
// Create client
DocumentsClient documentsClient = DocumentsClient.Create();
// Initialize request argument(s)
string name = "projects/[PROJECT]/knowledgeBases/[KNOWLEDGE_BASE]/documents/[DOCUMENT]";
// Make the request
Operation<Empty, KnowledgeOperationMetadata> response = documentsClient.DeleteDocument(name);
// Poll until the returned long-running operation is complete
Operation<Empty, KnowledgeOperationMetadata> completedResponse = response.PollUntilCompleted();
// Retrieve the operation result
Empty result = completedResponse.Result;
// Or get the name of the operation
string operationName = response.Name;
// This name can be stored, then the long-running operation retrieved later by name
Operation<Empty, KnowledgeOperationMetadata> retrievedResponse = documentsClient.PollOnceDeleteDocument(operationName);
// Check if the retrieved long-running operation has completed
if (retrievedResponse.IsCompleted)
{
// If it has completed, then access the result
Empty retrievedResult = retrievedResponse.Result;
}
DeleteDocumentAsync(DeleteDocumentRequest, CallSettings)
public virtual 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.v2beta1.KnowledgeOperationMetadata]response: An Empty message
Note: The projects.agent.knowledgeBases.documents resource is deprecated;
only use projects.knowledgeBases.documents.
| 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. |
// Create client
DocumentsClient documentsClient = await DocumentsClient.CreateAsync();
// Initialize request argument(s)
DeleteDocumentRequest request = new DeleteDocumentRequest
{
DocumentName = DocumentName.FromProjectKnowledgeBaseDocument("[PROJECT]", "[KNOWLEDGE_BASE]", "[DOCUMENT]"),
};
// Make the request
Operation<Empty, KnowledgeOperationMetadata> response = await documentsClient.DeleteDocumentAsync(request);
// Poll until the returned long-running operation is complete
Operation<Empty, KnowledgeOperationMetadata> completedResponse = await response.PollUntilCompletedAsync();
// Retrieve the operation result
Empty result = completedResponse.Result;
// Or get the name of the operation
string operationName = response.Name;
// This name can be stored, then the long-running operation retrieved later by name
Operation<Empty, KnowledgeOperationMetadata> retrievedResponse = await documentsClient.PollOnceDeleteDocumentAsync(operationName);
// Check if the retrieved long-running operation has completed
if (retrievedResponse.IsCompleted)
{
// If it has completed, then access the result
Empty retrievedResult = retrievedResponse.Result;
}
DeleteDocumentAsync(DeleteDocumentRequest, CancellationToken)
public virtual Task<Operation<Empty, KnowledgeOperationMetadata>> DeleteDocumentAsync(DeleteDocumentRequest request, CancellationToken cancellationToken)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.v2beta1.KnowledgeOperationMetadata]response: An Empty message
Note: The projects.agent.knowledgeBases.documents resource is deprecated;
only use projects.knowledgeBases.documents.
| Parameters | |
|---|---|
| Name | Description |
request |
DeleteDocumentRequestThe request object containing all of the parameters for the API call. |
cancellationToken |
CancellationTokenA CancellationToken to use for this RPC. |
| Returns | |
|---|---|
| Type | Description |
TaskOperationEmptyKnowledgeOperationMetadata |
A Task containing the RPC response. |
// Create client
DocumentsClient documentsClient = await DocumentsClient.CreateAsync();
// Initialize request argument(s)
DeleteDocumentRequest request = new DeleteDocumentRequest
{
DocumentName = DocumentName.FromProjectKnowledgeBaseDocument("[PROJECT]", "[KNOWLEDGE_BASE]", "[DOCUMENT]"),
};
// Make the request
Operation<Empty, KnowledgeOperationMetadata> response = await documentsClient.DeleteDocumentAsync(request);
// Poll until the returned long-running operation is complete
Operation<Empty, KnowledgeOperationMetadata> completedResponse = await response.PollUntilCompletedAsync();
// Retrieve the operation result
Empty result = completedResponse.Result;
// Or get the name of the operation
string operationName = response.Name;
// This name can be stored, then the long-running operation retrieved later by name
Operation<Empty, KnowledgeOperationMetadata> retrievedResponse = await documentsClient.PollOnceDeleteDocumentAsync(operationName);
// Check if the retrieved long-running operation has completed
if (retrievedResponse.IsCompleted)
{
// If it has completed, then access the result
Empty retrievedResult = retrievedResponse.Result;
}
DeleteDocumentAsync(DocumentName, CallSettings)
public virtual Task<Operation<Empty, KnowledgeOperationMetadata>> DeleteDocumentAsync(DocumentName name, 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.v2beta1.KnowledgeOperationMetadata]response: An Empty message
Note: The projects.agent.knowledgeBases.documents resource is deprecated;
only use projects.knowledgeBases.documents.
| Parameters | |
|---|---|
| Name | Description |
name |
DocumentNameRequired. The name of the document to delete.
Format: |
callSettings |
CallSettingsIf not null, applies overrides to this RPC call. |
| Returns | |
|---|---|
| Type | Description |
TaskOperationEmptyKnowledgeOperationMetadata |
A Task containing the RPC response. |
// Create client
DocumentsClient documentsClient = await DocumentsClient.CreateAsync();
// Initialize request argument(s)
DocumentName name = DocumentName.FromProjectKnowledgeBaseDocument("[PROJECT]", "[KNOWLEDGE_BASE]", "[DOCUMENT]");
// Make the request
Operation<Empty, KnowledgeOperationMetadata> response = await documentsClient.DeleteDocumentAsync(name);
// Poll until the returned long-running operation is complete
Operation<Empty, KnowledgeOperationMetadata> completedResponse = await response.PollUntilCompletedAsync();
// Retrieve the operation result
Empty result = completedResponse.Result;
// Or get the name of the operation
string operationName = response.Name;
// This name can be stored, then the long-running operation retrieved later by name
Operation<Empty, KnowledgeOperationMetadata> retrievedResponse = await documentsClient.PollOnceDeleteDocumentAsync(operationName);
// Check if the retrieved long-running operation has completed
if (retrievedResponse.IsCompleted)
{
// If it has completed, then access the result
Empty retrievedResult = retrievedResponse.Result;
}
DeleteDocumentAsync(DocumentName, CancellationToken)
public virtual Task<Operation<Empty, KnowledgeOperationMetadata>> DeleteDocumentAsync(DocumentName name, CancellationToken cancellationToken)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.v2beta1.KnowledgeOperationMetadata]response: An Empty message
Note: The projects.agent.knowledgeBases.documents resource is deprecated;
only use projects.knowledgeBases.documents.
| Parameters | |
|---|---|
| Name | Description |
name |
DocumentNameRequired. The name of the document to delete.
Format: |
cancellationToken |
CancellationTokenA CancellationToken to use for this RPC. |
| Returns | |
|---|---|
| Type | Description |
TaskOperationEmptyKnowledgeOperationMetadata |
A Task containing the RPC response. |
// Create client
DocumentsClient documentsClient = await DocumentsClient.CreateAsync();
// Initialize request argument(s)
DocumentName name = DocumentName.FromProjectKnowledgeBaseDocument("[PROJECT]", "[KNOWLEDGE_BASE]", "[DOCUMENT]");
// Make the request
Operation<Empty, KnowledgeOperationMetadata> response = await documentsClient.DeleteDocumentAsync(name);
// Poll until the returned long-running operation is complete
Operation<Empty, KnowledgeOperationMetadata> completedResponse = await response.PollUntilCompletedAsync();
// Retrieve the operation result
Empty result = completedResponse.Result;
// Or get the name of the operation
string operationName = response.Name;
// This name can be stored, then the long-running operation retrieved later by name
Operation<Empty, KnowledgeOperationMetadata> retrievedResponse = await documentsClient.PollOnceDeleteDocumentAsync(operationName);
// Check if the retrieved long-running operation has completed
if (retrievedResponse.IsCompleted)
{
// If it has completed, then access the result
Empty retrievedResult = retrievedResponse.Result;
}
DeleteDocumentAsync(string, CallSettings)
public virtual Task<Operation<Empty, KnowledgeOperationMetadata>> DeleteDocumentAsync(string name, 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.v2beta1.KnowledgeOperationMetadata]response: An Empty message
Note: The projects.agent.knowledgeBases.documents resource is deprecated;
only use projects.knowledgeBases.documents.
| Parameters | |
|---|---|
| Name | Description |
name |
stringRequired. The name of the document to delete.
Format: |
callSettings |
CallSettingsIf not null, applies overrides to this RPC call. |
| Returns | |
|---|---|
| Type | Description |
TaskOperationEmptyKnowledgeOperationMetadata |
A Task containing the RPC response. |
// Create client
DocumentsClient documentsClient = await DocumentsClient.CreateAsync();
// Initialize request argument(s)
string name = "projects/[PROJECT]/knowledgeBases/[KNOWLEDGE_BASE]/documents/[DOCUMENT]";
// Make the request
Operation<Empty, KnowledgeOperationMetadata> response = await documentsClient.DeleteDocumentAsync(name);
// Poll until the returned long-running operation is complete
Operation<Empty, KnowledgeOperationMetadata> completedResponse = await response.PollUntilCompletedAsync();
// Retrieve the operation result
Empty result = completedResponse.Result;
// Or get the name of the operation
string operationName = response.Name;
// This name can be stored, then the long-running operation retrieved later by name
Operation<Empty, KnowledgeOperationMetadata> retrievedResponse = await documentsClient.PollOnceDeleteDocumentAsync(operationName);
// Check if the retrieved long-running operation has completed
if (retrievedResponse.IsCompleted)
{
// If it has completed, then access the result
Empty retrievedResult = retrievedResponse.Result;
}
DeleteDocumentAsync(string, CancellationToken)
public virtual Task<Operation<Empty, KnowledgeOperationMetadata>> DeleteDocumentAsync(string name, CancellationToken cancellationToken)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.v2beta1.KnowledgeOperationMetadata]response: An Empty message
Note: The projects.agent.knowledgeBases.documents resource is deprecated;
only use projects.knowledgeBases.documents.
| Parameters | |
|---|---|
| Name | Description |
name |
stringRequired. The name of the document to delete.
Format: |
cancellationToken |
CancellationTokenA CancellationToken to use for this RPC. |
| Returns | |
|---|---|
| Type | Description |
TaskOperationEmptyKnowledgeOperationMetadata |
A Task containing the RPC response. |
// Create client
DocumentsClient documentsClient = await DocumentsClient.CreateAsync();
// Initialize request argument(s)
string name = "projects/[PROJECT]/knowledgeBases/[KNOWLEDGE_BASE]/documents/[DOCUMENT]";
// Make the request
Operation<Empty, KnowledgeOperationMetadata> response = await documentsClient.DeleteDocumentAsync(name);
// Poll until the returned long-running operation is complete
Operation<Empty, KnowledgeOperationMetadata> completedResponse = await response.PollUntilCompletedAsync();
// Retrieve the operation result
Empty result = completedResponse.Result;
// Or get the name of the operation
string operationName = response.Name;
// This name can be stored, then the long-running operation retrieved later by name
Operation<Empty, KnowledgeOperationMetadata> retrievedResponse = await documentsClient.PollOnceDeleteDocumentAsync(operationName);
// Check if the retrieved long-running operation has completed
if (retrievedResponse.IsCompleted)
{
// If it has completed, then access the result
Empty retrievedResult = retrievedResponse.Result;
}
GetDocument(DocumentName, CallSettings)
public virtual Document GetDocument(DocumentName name, CallSettings callSettings = null)Retrieves the specified document.
Note: The projects.agent.knowledgeBases.documents resource is deprecated;
only use projects.knowledgeBases.documents.
| Parameters | |
|---|---|
| Name | Description |
name |
DocumentNameRequired. The name of the document to retrieve.
Format |
callSettings |
CallSettingsIf not null, applies overrides to this RPC call. |
| Returns | |
|---|---|
| Type | Description |
Document |
The RPC response. |
// Create client
DocumentsClient documentsClient = DocumentsClient.Create();
// Initialize request argument(s)
DocumentName name = DocumentName.FromProjectKnowledgeBaseDocument("[PROJECT]", "[KNOWLEDGE_BASE]", "[DOCUMENT]");
// Make the request
Document response = documentsClient.GetDocument(name);
GetDocument(GetDocumentRequest, CallSettings)
public virtual Document GetDocument(GetDocumentRequest request, CallSettings callSettings = null)Retrieves the specified document.
Note: The projects.agent.knowledgeBases.documents resource is deprecated;
only use projects.knowledgeBases.documents.
| 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. |
// Create client
DocumentsClient documentsClient = DocumentsClient.Create();
// Initialize request argument(s)
GetDocumentRequest request = new GetDocumentRequest
{
DocumentName = DocumentName.FromProjectKnowledgeBaseDocument("[PROJECT]", "[KNOWLEDGE_BASE]", "[DOCUMENT]"),
};
// Make the request
Document response = documentsClient.GetDocument(request);
GetDocument(string, CallSettings)
public virtual Document GetDocument(string name, CallSettings callSettings = null)Retrieves the specified document.
Note: The projects.agent.knowledgeBases.documents resource is deprecated;
only use projects.knowledgeBases.documents.
| Parameters | |
|---|---|
| Name | Description |
name |
stringRequired. The name of the document to retrieve.
Format |
callSettings |
CallSettingsIf not null, applies overrides to this RPC call. |
| Returns | |
|---|---|
| Type | Description |
Document |
The RPC response. |
// Create client
DocumentsClient documentsClient = DocumentsClient.Create();
// Initialize request argument(s)
string name = "projects/[PROJECT]/knowledgeBases/[KNOWLEDGE_BASE]/documents/[DOCUMENT]";
// Make the request
Document response = documentsClient.GetDocument(name);
GetDocumentAsync(DocumentName, CallSettings)
public virtual Task<Document> GetDocumentAsync(DocumentName name, CallSettings callSettings = null)Retrieves the specified document.
Note: The projects.agent.knowledgeBases.documents resource is deprecated;
only use projects.knowledgeBases.documents.
| Parameters | |
|---|---|
| Name | Description |
name |
DocumentNameRequired. The name of the document to retrieve.
Format |
callSettings |
CallSettingsIf not null, applies overrides to this RPC call. |
| Returns | |
|---|---|
| Type | Description |
TaskDocument |
A Task containing the RPC response. |
// Create client
DocumentsClient documentsClient = await DocumentsClient.CreateAsync();
// Initialize request argument(s)
DocumentName name = DocumentName.FromProjectKnowledgeBaseDocument("[PROJECT]", "[KNOWLEDGE_BASE]", "[DOCUMENT]");
// Make the request
Document response = await documentsClient.GetDocumentAsync(name);
GetDocumentAsync(DocumentName, CancellationToken)
public virtual Task<Document> GetDocumentAsync(DocumentName name, CancellationToken cancellationToken)Retrieves the specified document.
Note: The projects.agent.knowledgeBases.documents resource is deprecated;
only use projects.knowledgeBases.documents.
| Parameters | |
|---|---|
| Name | Description |
name |
DocumentNameRequired. The name of the document to retrieve.
Format |
cancellationToken |
CancellationTokenA CancellationToken to use for this RPC. |
| Returns | |
|---|---|
| Type | Description |
TaskDocument |
A Task containing the RPC response. |
// Create client
DocumentsClient documentsClient = await DocumentsClient.CreateAsync();
// Initialize request argument(s)
DocumentName name = DocumentName.FromProjectKnowledgeBaseDocument("[PROJECT]", "[KNOWLEDGE_BASE]", "[DOCUMENT]");
// Make the request
Document response = await documentsClient.GetDocumentAsync(name);
GetDocumentAsync(GetDocumentRequest, CallSettings)
public virtual Task<Document> GetDocumentAsync(GetDocumentRequest request, CallSettings callSettings = null)Retrieves the specified document.
Note: The projects.agent.knowledgeBases.documents resource is deprecated;
only use projects.knowledgeBases.documents.
| 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. |
// Create client
DocumentsClient documentsClient = await DocumentsClient.CreateAsync();
// Initialize request argument(s)
GetDocumentRequest request = new GetDocumentRequest
{
DocumentName = DocumentName.FromProjectKnowledgeBaseDocument("[PROJECT]", "[KNOWLEDGE_BASE]", "[DOCUMENT]"),
};
// Make the request
Document response = await documentsClient.GetDocumentAsync(request);
GetDocumentAsync(GetDocumentRequest, CancellationToken)
public virtual Task<Document> GetDocumentAsync(GetDocumentRequest request, CancellationToken cancellationToken)Retrieves the specified document.
Note: The projects.agent.knowledgeBases.documents resource is deprecated;
only use projects.knowledgeBases.documents.
| Parameters | |
|---|---|
| Name | Description |
request |
GetDocumentRequestThe request object containing all of the parameters for the API call. |
cancellationToken |
CancellationTokenA CancellationToken to use for this RPC. |
| Returns | |
|---|---|
| Type | Description |
TaskDocument |
A Task containing the RPC response. |
// Create client
DocumentsClient documentsClient = await DocumentsClient.CreateAsync();
// Initialize request argument(s)
GetDocumentRequest request = new GetDocumentRequest
{
DocumentName = DocumentName.FromProjectKnowledgeBaseDocument("[PROJECT]", "[KNOWLEDGE_BASE]", "[DOCUMENT]"),
};
// Make the request
Document response = await documentsClient.GetDocumentAsync(request);
GetDocumentAsync(string, CallSettings)
public virtual Task<Document> GetDocumentAsync(string name, CallSettings callSettings = null)Retrieves the specified document.
Note: The projects.agent.knowledgeBases.documents resource is deprecated;
only use projects.knowledgeBases.documents.
| Parameters | |
|---|---|
| Name | Description |
name |
stringRequired. The name of the document to retrieve.
Format |
callSettings |
CallSettingsIf not null, applies overrides to this RPC call. |
| Returns | |
|---|---|
| Type | Description |
TaskDocument |
A Task containing the RPC response. |
// Create client
DocumentsClient documentsClient = await DocumentsClient.CreateAsync();
// Initialize request argument(s)
string name = "projects/[PROJECT]/knowledgeBases/[KNOWLEDGE_BASE]/documents/[DOCUMENT]";
// Make the request
Document response = await documentsClient.GetDocumentAsync(name);
GetDocumentAsync(string, CancellationToken)
public virtual Task<Document> GetDocumentAsync(string name, CancellationToken cancellationToken)Retrieves the specified document.
Note: The projects.agent.knowledgeBases.documents resource is deprecated;
only use projects.knowledgeBases.documents.
| Parameters | |
|---|---|
| Name | Description |
name |
stringRequired. The name of the document to retrieve.
Format |
cancellationToken |
CancellationTokenA CancellationToken to use for this RPC. |
| Returns | |
|---|---|
| Type | Description |
TaskDocument |
A Task containing the RPC response. |
// Create client
DocumentsClient documentsClient = await DocumentsClient.CreateAsync();
// Initialize request argument(s)
string name = "projects/[PROJECT]/knowledgeBases/[KNOWLEDGE_BASE]/documents/[DOCUMENT]";
// Make the request
Document response = await documentsClient.GetDocumentAsync(name);
ImportDocuments(ImportDocumentsRequest, CallSettings)
public virtual Operation<ImportDocumentsResponse, KnowledgeOperationMetadata> ImportDocuments(ImportDocumentsRequest request, CallSettings callSettings = null)Create 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.v2beta1.KnowledgeOperationMetadata]response: [ImportDocumentsResponse][google.cloud.dialogflow.v2beta1.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. |
// Create client
DocumentsClient documentsClient = DocumentsClient.Create();
// Initialize request argument(s)
ImportDocumentsRequest request = new ImportDocumentsRequest
{
ParentAsKnowledgeBaseName = KnowledgeBaseName.FromProjectKnowledgeBase("[PROJECT]", "[KNOWLEDGE_BASE]"),
GcsSource = new GcsSources(),
DocumentTemplate = new ImportDocumentTemplate(),
ImportGcsCustomMetadata = false,
};
// Make the request
Operation<ImportDocumentsResponse, KnowledgeOperationMetadata> response = documentsClient.ImportDocuments(request);
// Poll until the returned long-running operation is complete
Operation<ImportDocumentsResponse, KnowledgeOperationMetadata> completedResponse = response.PollUntilCompleted();
// Retrieve the operation result
ImportDocumentsResponse result = completedResponse.Result;
// Or get the name of the operation
string operationName = response.Name;
// This name can be stored, then the long-running operation retrieved later by name
Operation<ImportDocumentsResponse, KnowledgeOperationMetadata> retrievedResponse = documentsClient.PollOnceImportDocuments(operationName);
// Check if the retrieved long-running operation has completed
if (retrievedResponse.IsCompleted)
{
// If it has completed, then access the result
ImportDocumentsResponse retrievedResult = retrievedResponse.Result;
}
ImportDocumentsAsync(ImportDocumentsRequest, CallSettings)
public virtual Task<Operation<ImportDocumentsResponse, KnowledgeOperationMetadata>> ImportDocumentsAsync(ImportDocumentsRequest request, CallSettings callSettings = null)Create 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.v2beta1.KnowledgeOperationMetadata]response: [ImportDocumentsResponse][google.cloud.dialogflow.v2beta1.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. |
// Create client
DocumentsClient documentsClient = await DocumentsClient.CreateAsync();
// Initialize request argument(s)
ImportDocumentsRequest request = new ImportDocumentsRequest
{
ParentAsKnowledgeBaseName = KnowledgeBaseName.FromProjectKnowledgeBase("[PROJECT]", "[KNOWLEDGE_BASE]"),
GcsSource = new GcsSources(),
DocumentTemplate = new ImportDocumentTemplate(),
ImportGcsCustomMetadata = false,
};
// Make the request
Operation<ImportDocumentsResponse, KnowledgeOperationMetadata> response = await documentsClient.ImportDocumentsAsync(request);
// Poll until the returned long-running operation is complete
Operation<ImportDocumentsResponse, KnowledgeOperationMetadata> completedResponse = await response.PollUntilCompletedAsync();
// Retrieve the operation result
ImportDocumentsResponse result = completedResponse.Result;
// Or get the name of the operation
string operationName = response.Name;
// This name can be stored, then the long-running operation retrieved later by name
Operation<ImportDocumentsResponse, KnowledgeOperationMetadata> retrievedResponse = await documentsClient.PollOnceImportDocumentsAsync(operationName);
// Check if the retrieved long-running operation has completed
if (retrievedResponse.IsCompleted)
{
// If it has completed, then access the result
ImportDocumentsResponse retrievedResult = retrievedResponse.Result;
}
ImportDocumentsAsync(ImportDocumentsRequest, CancellationToken)
public virtual Task<Operation<ImportDocumentsResponse, KnowledgeOperationMetadata>> ImportDocumentsAsync(ImportDocumentsRequest request, CancellationToken cancellationToken)Create 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.v2beta1.KnowledgeOperationMetadata]response: [ImportDocumentsResponse][google.cloud.dialogflow.v2beta1.ImportDocumentsResponse]
| Parameters | |
|---|---|
| Name | Description |
request |
ImportDocumentsRequestThe request object containing all of the parameters for the API call. |
cancellationToken |
CancellationTokenA CancellationToken to use for this RPC. |
| Returns | |
|---|---|
| Type | Description |
TaskOperationImportDocumentsResponseKnowledgeOperationMetadata |
A Task containing the RPC response. |
// Create client
DocumentsClient documentsClient = await DocumentsClient.CreateAsync();
// Initialize request argument(s)
ImportDocumentsRequest request = new ImportDocumentsRequest
{
ParentAsKnowledgeBaseName = KnowledgeBaseName.FromProjectKnowledgeBase("[PROJECT]", "[KNOWLEDGE_BASE]"),
GcsSource = new GcsSources(),
DocumentTemplate = new ImportDocumentTemplate(),
ImportGcsCustomMetadata = false,
};
// Make the request
Operation<ImportDocumentsResponse, KnowledgeOperationMetadata> response = await documentsClient.ImportDocumentsAsync(request);
// Poll until the returned long-running operation is complete
Operation<ImportDocumentsResponse, KnowledgeOperationMetadata> completedResponse = await response.PollUntilCompletedAsync();
// Retrieve the operation result
ImportDocumentsResponse result = completedResponse.Result;
// Or get the name of the operation
string operationName = response.Name;
// This name can be stored, then the long-running operation retrieved later by name
Operation<ImportDocumentsResponse, KnowledgeOperationMetadata> retrievedResponse = await documentsClient.PollOnceImportDocumentsAsync(operationName);
// Check if the retrieved long-running operation has completed
if (retrievedResponse.IsCompleted)
{
// If it has completed, then access the result
ImportDocumentsResponse retrievedResult = retrievedResponse.Result;
}
ListDocuments(KnowledgeBaseName, string, int?, CallSettings)
public virtual PagedEnumerable<ListDocumentsResponse, Document> ListDocuments(KnowledgeBaseName parent, string pageToken = null, int? pageSize = null, CallSettings callSettings = null)Returns the list of all documents of the knowledge base.
Note: The projects.agent.knowledgeBases.documents resource is deprecated;
only use projects.knowledgeBases.documents.
| Parameters | |
|---|---|
| Name | Description |
parent |
KnowledgeBaseNameRequired. The knowledge base to list all documents for.
Format: |
pageToken |
stringThe token returned from the previous request. A value of |
pageSize |
intThe size of page to request. The response will not be larger than this, but may be smaller. A value of
|
callSettings |
CallSettingsIf not null, applies overrides to this RPC call. |
| Returns | |
|---|---|
| Type | Description |
PagedEnumerableListDocumentsResponseDocument |
A pageable sequence of Document resources. |
// Create client
DocumentsClient documentsClient = DocumentsClient.Create();
// Initialize request argument(s)
KnowledgeBaseName parent = KnowledgeBaseName.FromProjectKnowledgeBase("[PROJECT]", "[KNOWLEDGE_BASE]");
// Make the request
PagedEnumerable<ListDocumentsResponse, Document> response = documentsClient.ListDocuments(parent);
// Iterate over all response items, lazily performing RPCs as required
foreach (Document item in response)
{
// Do something with each item
Console.WriteLine(item);
}
// Or iterate over pages (of server-defined size), performing one RPC per page
foreach (ListDocumentsResponse page in response.AsRawResponses())
{
// Do something with each page of items
Console.WriteLine("A page of results:");
foreach (Document item in page)
{
// Do something with each item
Console.WriteLine(item);
}
}
// Or retrieve a single page of known size (unless it's the final page), performing as many RPCs as required
int pageSize = 10;
Page<Document> singlePage = response.ReadPage(pageSize);
// Do something with the page of items
Console.WriteLine($"A page of {pageSize} results (unless it's the final page):");
foreach (Document item in singlePage)
{
// Do something with each item
Console.WriteLine(item);
}
// Store the pageToken, for when the next page is required.
string nextPageToken = singlePage.NextPageToken;
ListDocuments(ListDocumentsRequest, CallSettings)
public virtual PagedEnumerable<ListDocumentsResponse, Document> ListDocuments(ListDocumentsRequest request, CallSettings callSettings = null)Returns the list of all documents of the knowledge base.
Note: The projects.agent.knowledgeBases.documents resource is deprecated;
only use projects.knowledgeBases.documents.
| 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. |
// Create client
DocumentsClient documentsClient = DocumentsClient.Create();
// Initialize request argument(s)
ListDocumentsRequest request = new ListDocumentsRequest
{
ParentAsKnowledgeBaseName = KnowledgeBaseName.FromProjectKnowledgeBase("[PROJECT]", "[KNOWLEDGE_BASE]"),
Filter = "",
};
// Make the request
PagedEnumerable<ListDocumentsResponse, Document> response = documentsClient.ListDocuments(request);
// Iterate over all response items, lazily performing RPCs as required
foreach (Document item in response)
{
// Do something with each item
Console.WriteLine(item);
}
// Or iterate over pages (of server-defined size), performing one RPC per page
foreach (ListDocumentsResponse page in response.AsRawResponses())
{
// Do something with each page of items
Console.WriteLine("A page of results:");
foreach (Document item in page)
{
// Do something with each item
Console.WriteLine(item);
}
}
// Or retrieve a single page of known size (unless it's the final page), performing as many RPCs as required
int pageSize = 10;
Page<Document> singlePage = response.ReadPage(pageSize);
// Do something with the page of items
Console.WriteLine($"A page of {pageSize} results (unless it's the final page):");
foreach (Document item in singlePage)
{
// Do something with each item
Console.WriteLine(item);
}
// Store the pageToken, for when the next page is required.
string nextPageToken = singlePage.NextPageToken;
ListDocuments(string, string, int?, CallSettings)
public virtual PagedEnumerable<ListDocumentsResponse, Document> ListDocuments(string parent, string pageToken = null, int? pageSize = null, CallSettings callSettings = null)Returns the list of all documents of the knowledge base.
Note: The projects.agent.knowledgeBases.documents resource is deprecated;
only use projects.knowledgeBases.documents.
| Parameters | |
|---|---|
| Name | Description |
parent |
stringRequired. The knowledge base to list all documents for.
Format: |
pageToken |
stringThe token returned from the previous request. A value of |
pageSize |
intThe size of page to request. The response will not be larger than this, but may be smaller. A value of
|
callSettings |
CallSettingsIf not null, applies overrides to this RPC call. |
| Returns | |
|---|---|
| Type | Description |
PagedEnumerableListDocumentsResponseDocument |
A pageable sequence of Document resources. |
// Create client
DocumentsClient documentsClient = DocumentsClient.Create();
// Initialize request argument(s)
string parent = "projects/[PROJECT]/knowledgeBases/[KNOWLEDGE_BASE]";
// Make the request
PagedEnumerable<ListDocumentsResponse, Document> response = documentsClient.ListDocuments(parent);
// Iterate over all response items, lazily performing RPCs as required
foreach (Document item in response)
{
// Do something with each item
Console.WriteLine(item);
}
// Or iterate over pages (of server-defined size), performing one RPC per page
foreach (ListDocumentsResponse page in response.AsRawResponses())
{
// Do something with each page of items
Console.WriteLine("A page of results:");
foreach (Document item in page)
{
// Do something with each item
Console.WriteLine(item);
}
}
// Or retrieve a single page of known size (unless it's the final page), performing as many RPCs as required
int pageSize = 10;
Page<Document> singlePage = response.ReadPage(pageSize);
// Do something with the page of items
Console.WriteLine($"A page of {pageSize} results (unless it's the final page):");
foreach (Document item in singlePage)
{
// Do something with each item
Console.WriteLine(item);
}
// Store the pageToken, for when the next page is required.
string nextPageToken = singlePage.NextPageToken;
ListDocumentsAsync(KnowledgeBaseName, string, int?, CallSettings)
public virtual PagedAsyncEnumerable<ListDocumentsResponse, Document> ListDocumentsAsync(KnowledgeBaseName parent, string pageToken = null, int? pageSize = null, CallSettings callSettings = null)Returns the list of all documents of the knowledge base.
Note: The projects.agent.knowledgeBases.documents resource is deprecated;
only use projects.knowledgeBases.documents.
| Parameters | |
|---|---|
| Name | Description |
parent |
KnowledgeBaseNameRequired. The knowledge base to list all documents for.
Format: |
pageToken |
stringThe token returned from the previous request. A value of |
pageSize |
intThe size of page to request. The response will not be larger than this, but may be smaller. A value of
|
callSettings |
CallSettingsIf not null, applies overrides to this RPC call. |
| Returns | |
|---|---|
| Type | Description |
PagedAsyncEnumerableListDocumentsResponseDocument |
A pageable asynchronous sequence of Document resources. |
// Create client
DocumentsClient documentsClient = await DocumentsClient.CreateAsync();
// Initialize request argument(s)
KnowledgeBaseName parent = KnowledgeBaseName.FromProjectKnowledgeBase("[PROJECT]", "[KNOWLEDGE_BASE]");
// Make the request
PagedAsyncEnumerable<ListDocumentsResponse, Document> response = documentsClient.ListDocumentsAsync(parent);
// Iterate over all response items, lazily performing RPCs as required
await response.ForEachAsync((Document item) =>
{
// Do something with each item
Console.WriteLine(item);
});
// Or iterate over pages (of server-defined size), performing one RPC per page
await response.AsRawResponses().ForEachAsync((ListDocumentsResponse page) =>
{
// Do something with each page of items
Console.WriteLine("A page of results:");
foreach (Document item in page)
{
// Do something with each item
Console.WriteLine(item);
}
});
// Or retrieve a single page of known size (unless it's the final page), performing as many RPCs as required
int pageSize = 10;
Page<Document> singlePage = await response.ReadPageAsync(pageSize);
// Do something with the page of items
Console.WriteLine($"A page of {pageSize} results (unless it's the final page):");
foreach (Document item in singlePage)
{
// Do something with each item
Console.WriteLine(item);
}
// Store the pageToken, for when the next page is required.
string nextPageToken = singlePage.NextPageToken;
ListDocumentsAsync(ListDocumentsRequest, CallSettings)
public virtual PagedAsyncEnumerable<ListDocumentsResponse, Document> ListDocumentsAsync(ListDocumentsRequest request, CallSettings callSettings = null)Returns the list of all documents of the knowledge base.
Note: The projects.agent.knowledgeBases.documents resource is deprecated;
only use projects.knowledgeBases.documents.
| 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. |
// Create client
DocumentsClient documentsClient = await DocumentsClient.CreateAsync();
// Initialize request argument(s)
ListDocumentsRequest request = new ListDocumentsRequest
{
ParentAsKnowledgeBaseName = KnowledgeBaseName.FromProjectKnowledgeBase("[PROJECT]", "[KNOWLEDGE_BASE]"),
Filter = "",
};
// Make the request
PagedAsyncEnumerable<ListDocumentsResponse, Document> response = documentsClient.ListDocumentsAsync(request);
// Iterate over all response items, lazily performing RPCs as required
await response.ForEachAsync((Document item) =>
{
// Do something with each item
Console.WriteLine(item);
});
// Or iterate over pages (of server-defined size), performing one RPC per page
await response.AsRawResponses().ForEachAsync((ListDocumentsResponse page) =>
{
// Do something with each page of items
Console.WriteLine("A page of results:");
foreach (Document item in page)
{
// Do something with each item
Console.WriteLine(item);
}
});
// Or retrieve a single page of known size (unless it's the final page), performing as many RPCs as required
int pageSize = 10;
Page<Document> singlePage = await response.ReadPageAsync(pageSize);
// Do something with the page of items
Console.WriteLine($"A page of {pageSize} results (unless it's the final page):");
foreach (Document item in singlePage)
{
// Do something with each item
Console.WriteLine(item);
}
// Store the pageToken, for when the next page is required.
string nextPageToken = singlePage.NextPageToken;
ListDocumentsAsync(string, string, int?, CallSettings)
public virtual PagedAsyncEnumerable<ListDocumentsResponse, Document> ListDocumentsAsync(string parent, string pageToken = null, int? pageSize = null, CallSettings callSettings = null)Returns the list of all documents of the knowledge base.
Note: The projects.agent.knowledgeBases.documents resource is deprecated;
only use projects.knowledgeBases.documents.
| Parameters | |
|---|---|
| Name | Description |
parent |
stringRequired. The knowledge base to list all documents for.
Format: |
pageToken |
stringThe token returned from the previous request. A value of |
pageSize |
intThe size of page to request. The response will not be larger than this, but may be smaller. A value of
|
callSettings |
CallSettingsIf not null, applies overrides to this RPC call. |
| Returns | |
|---|---|
| Type | Description |
PagedAsyncEnumerableListDocumentsResponseDocument |
A pageable asynchronous sequence of Document resources. |
// Create client
DocumentsClient documentsClient = await DocumentsClient.CreateAsync();
// Initialize request argument(s)
string parent = "projects/[PROJECT]/knowledgeBases/[KNOWLEDGE_BASE]";
// Make the request
PagedAsyncEnumerable<ListDocumentsResponse, Document> response = documentsClient.ListDocumentsAsync(parent);
// Iterate over all response items, lazily performing RPCs as required
await response.ForEachAsync((Document item) =>
{
// Do something with each item
Console.WriteLine(item);
});
// Or iterate over pages (of server-defined size), performing one RPC per page
await response.AsRawResponses().ForEachAsync((ListDocumentsResponse page) =>
{
// Do something with each page of items
Console.WriteLine("A page of results:");
foreach (Document item in page)
{
// Do something with each item
Console.WriteLine(item);
}
});
// Or retrieve a single page of known size (unless it's the final page), performing as many RPCs as required
int pageSize = 10;
Page<Document> singlePage = await response.ReadPageAsync(pageSize);
// Do something with the page of items
Console.WriteLine($"A page of {pageSize} results (unless it's the final page):");
foreach (Document item in singlePage)
{
// Do something with each item
Console.WriteLine(item);
}
// Store the pageToken, for when the next page is required.
string nextPageToken = singlePage.NextPageToken;
PollOnceCreateDocument(string, CallSettings)
public virtual Operation<Document, KnowledgeOperationMetadata> PollOnceCreateDocument(string operationName, CallSettings callSettings = null)Poll an operation once, using an operationName from a previous invocation of CreateDocument.
| Parameters | |
|---|---|
| Name | Description |
operationName |
stringThe name of a previously invoked operation. Must not be |
callSettings |
CallSettingsIf not null, applies overrides to this RPC call. |
| Returns | |
|---|---|
| Type | Description |
OperationDocumentKnowledgeOperationMetadata |
The result of polling the operation. |
PollOnceCreateDocumentAsync(string, CallSettings)
public virtual Task<Operation<Document, KnowledgeOperationMetadata>> PollOnceCreateDocumentAsync(string operationName, CallSettings callSettings = null)Asynchronously poll an operation once, using an operationName from a previous invocation of
CreateDocument.
| Parameters | |
|---|---|
| Name | Description |
operationName |
stringThe name of a previously invoked operation. Must not be |
callSettings |
CallSettingsIf not null, applies overrides to this RPC call. |
| Returns | |
|---|---|
| Type | Description |
TaskOperationDocumentKnowledgeOperationMetadata |
A task representing the result of polling the operation. |
PollOnceDeleteDocument(string, CallSettings)
public virtual Operation<Empty, KnowledgeOperationMetadata> PollOnceDeleteDocument(string operationName, CallSettings callSettings = null)Poll an operation once, using an operationName from a previous invocation of DeleteDocument.
| Parameters | |
|---|---|
| Name | Description |
operationName |
stringThe name of a previously invoked operation. Must not be |
callSettings |
CallSettingsIf not null, applies overrides to this RPC call. |
| Returns | |
|---|---|
| Type | Description |
OperationEmptyKnowledgeOperationMetadata |
The result of polling the operation. |
PollOnceDeleteDocumentAsync(string, CallSettings)
public virtual Task<Operation<Empty, KnowledgeOperationMetadata>> PollOnceDeleteDocumentAsync(string operationName, CallSettings callSettings = null)Asynchronously poll an operation once, using an operationName from a previous invocation of
DeleteDocument.
| Parameters | |
|---|---|
| Name | Description |
operationName |
stringThe name of a previously invoked operation. Must not be |
callSettings |
CallSettingsIf not null, applies overrides to this RPC call. |
| Returns | |
|---|---|
| Type | Description |
TaskOperationEmptyKnowledgeOperationMetadata |
A task representing the result of polling the operation. |
PollOnceImportDocuments(string, CallSettings)
public virtual Operation<ImportDocumentsResponse, KnowledgeOperationMetadata> PollOnceImportDocuments(string operationName, CallSettings callSettings = null)Poll an operation once, using an operationName from a previous invocation of ImportDocuments.
| Parameters | |
|---|---|
| Name | Description |
operationName |
stringThe name of a previously invoked operation. Must not be |
callSettings |
CallSettingsIf not null, applies overrides to this RPC call. |
| Returns | |
|---|---|
| Type | Description |
OperationImportDocumentsResponseKnowledgeOperationMetadata |
The result of polling the operation. |
PollOnceImportDocumentsAsync(string, CallSettings)
public virtual Task<Operation<ImportDocumentsResponse, KnowledgeOperationMetadata>> PollOnceImportDocumentsAsync(string operationName, CallSettings callSettings = null)Asynchronously poll an operation once, using an operationName from a previous invocation of
ImportDocuments.
| Parameters | |
|---|---|
| Name | Description |
operationName |
stringThe name of a previously invoked operation. Must not be |
callSettings |
CallSettingsIf not null, applies overrides to this RPC call. |
| Returns | |
|---|---|
| Type | Description |
TaskOperationImportDocumentsResponseKnowledgeOperationMetadata |
A task representing the result of polling the operation. |
PollOnceReloadDocument(string, CallSettings)
public virtual Operation<Document, KnowledgeOperationMetadata> PollOnceReloadDocument(string operationName, CallSettings callSettings = null)Poll an operation once, using an operationName from a previous invocation of ReloadDocument.
| Parameters | |
|---|---|
| Name | Description |
operationName |
stringThe name of a previously invoked operation. Must not be |
callSettings |
CallSettingsIf not null, applies overrides to this RPC call. |
| Returns | |
|---|---|
| Type | Description |
OperationDocumentKnowledgeOperationMetadata |
The result of polling the operation. |
PollOnceReloadDocumentAsync(string, CallSettings)
public virtual Task<Operation<Document, KnowledgeOperationMetadata>> PollOnceReloadDocumentAsync(string operationName, CallSettings callSettings = null)Asynchronously poll an operation once, using an operationName from a previous invocation of
ReloadDocument.
| Parameters | |
|---|---|
| Name | Description |
operationName |
stringThe name of a previously invoked operation. Must not be |
callSettings |
CallSettingsIf not null, applies overrides to this RPC call. |
| Returns | |
|---|---|
| Type | Description |
TaskOperationDocumentKnowledgeOperationMetadata |
A task representing the result of polling the operation. |
PollOnceUpdateDocument(string, CallSettings)
public virtual Operation<Document, KnowledgeOperationMetadata> PollOnceUpdateDocument(string operationName, CallSettings callSettings = null)Poll an operation once, using an operationName from a previous invocation of UpdateDocument.
| Parameters | |
|---|---|
| Name | Description |
operationName |
stringThe name of a previously invoked operation. Must not be |
callSettings |
CallSettingsIf not null, applies overrides to this RPC call. |
| Returns | |
|---|---|
| Type | Description |
OperationDocumentKnowledgeOperationMetadata |
The result of polling the operation. |
PollOnceUpdateDocumentAsync(string, CallSettings)
public virtual Task<Operation<Document, KnowledgeOperationMetadata>> PollOnceUpdateDocumentAsync(string operationName, CallSettings callSettings = null)Asynchronously poll an operation once, using an operationName from a previous invocation of
UpdateDocument.
| Parameters | |
|---|---|
| Name | Description |
operationName |
stringThe name of a previously invoked operation. Must not be |
callSettings |
CallSettingsIf not null, applies overrides to this RPC call. |
| Returns | |
|---|---|
| Type | Description |
TaskOperationDocumentKnowledgeOperationMetadata |
A task representing the result of polling the operation. |
ReloadDocument(DocumentName, GcsSource, CallSettings)
public virtual Operation<Document, KnowledgeOperationMetadata> ReloadDocument(DocumentName name, GcsSource gcsSource, 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.
Note: If the document source is Google Cloud Storage URI, its metadata will
be replaced with the custom metadata from Google Cloud Storage if the
import_gcs_custom_metadata field is set to true in the request.
This method is a long-running
operation.
The returned Operation type has the following method-specific fields:
metadata: [KnowledgeOperationMetadata][google.cloud.dialogflow.v2beta1.KnowledgeOperationMetadata]response: [Document][google.cloud.dialogflow.v2beta1.Document]
Note: The projects.agent.knowledgeBases.documents resource is deprecated;
only use projects.knowledgeBases.documents.
| Parameters | |
|---|---|
| Name | Description |
name |
DocumentNameRequired. The name of the document to reload.
Format: |
gcsSource |
GcsSourceThe path for a Cloud Storage source file for reloading document content. If not provided, the Document's existing source will be reloaded. |
callSettings |
CallSettingsIf not null, applies overrides to this RPC call. |
| Returns | |
|---|---|
| Type | Description |
OperationDocumentKnowledgeOperationMetadata |
The RPC response. |
// Create client
DocumentsClient documentsClient = DocumentsClient.Create();
// Initialize request argument(s)
DocumentName name = DocumentName.FromProjectKnowledgeBaseDocument("[PROJECT]", "[KNOWLEDGE_BASE]", "[DOCUMENT]");
GcsSource gcsSource = new GcsSource();
// Make the request
Operation<Document, KnowledgeOperationMetadata> response = documentsClient.ReloadDocument(name, gcsSource);
// Poll until the returned long-running operation is complete
Operation<Document, KnowledgeOperationMetadata> completedResponse = response.PollUntilCompleted();
// Retrieve the operation result
Document result = completedResponse.Result;
// Or get the name of the operation
string operationName = response.Name;
// This name can be stored, then the long-running operation retrieved later by name
Operation<Document, KnowledgeOperationMetadata> retrievedResponse = documentsClient.PollOnceReloadDocument(operationName);
// Check if the retrieved long-running operation has completed
if (retrievedResponse.IsCompleted)
{
// If it has completed, then access the result
Document retrievedResult = retrievedResponse.Result;
}
ReloadDocument(ReloadDocumentRequest, CallSettings)
public virtual 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.
Note: If the document source is Google Cloud Storage URI, its metadata will
be replaced with the custom metadata from Google Cloud Storage if the
import_gcs_custom_metadata field is set to true in the request.
This method is a long-running
operation.
The returned Operation type has the following method-specific fields:
metadata: [KnowledgeOperationMetadata][google.cloud.dialogflow.v2beta1.KnowledgeOperationMetadata]response: [Document][google.cloud.dialogflow.v2beta1.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. |
// Create client
DocumentsClient documentsClient = DocumentsClient.Create();
// Initialize request argument(s)
ReloadDocumentRequest request = new ReloadDocumentRequest
{
DocumentName = DocumentName.FromProjectKnowledgeBaseDocument("[PROJECT]", "[KNOWLEDGE_BASE]", "[DOCUMENT]"),
GcsSource = new GcsSource(),
ImportGcsCustomMetadata = false,
};
// Make the request
Operation<Document, KnowledgeOperationMetadata> response = documentsClient.ReloadDocument(request);
// Poll until the returned long-running operation is complete
Operation<Document, KnowledgeOperationMetadata> completedResponse = response.PollUntilCompleted();
// Retrieve the operation result
Document result = completedResponse.Result;
// Or get the name of the operation
string operationName = response.Name;
// This name can be stored, then the long-running operation retrieved later by name
Operation<Document, KnowledgeOperationMetadata> retrievedResponse = documentsClient.PollOnceReloadDocument(operationName);
// Check if the retrieved long-running operation has completed
if (retrievedResponse.IsCompleted)
{
// If it has completed, then access the result
Document retrievedResult = retrievedResponse.Result;
}
ReloadDocument(string, GcsSource, CallSettings)
public virtual Operation<Document, KnowledgeOperationMetadata> ReloadDocument(string name, GcsSource gcsSource, 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.
Note: If the document source is Google Cloud Storage URI, its metadata will
be replaced with the custom metadata from Google Cloud Storage if the
import_gcs_custom_metadata field is set to true in the request.
This method is a long-running
operation.
The returned Operation type has the following method-specific fields:
metadata: [KnowledgeOperationMetadata][google.cloud.dialogflow.v2beta1.KnowledgeOperationMetadata]response: [Document][google.cloud.dialogflow.v2beta1.Document]
Note: The projects.agent.knowledgeBases.documents resource is deprecated;
only use projects.knowledgeBases.documents.
| Parameters | |
|---|---|
| Name | Description |
name |
stringRequired. The name of the document to reload.
Format: |
gcsSource |
GcsSourceThe path for a Cloud Storage source file for reloading document content. If not provided, the Document's existing source will be reloaded. |
callSettings |
CallSettingsIf not null, applies overrides to this RPC call. |
| Returns | |
|---|---|
| Type | Description |
OperationDocumentKnowledgeOperationMetadata |
The RPC response. |
// Create client
DocumentsClient documentsClient = DocumentsClient.Create();
// Initialize request argument(s)
string name = "projects/[PROJECT]/knowledgeBases/[KNOWLEDGE_BASE]/documents/[DOCUMENT]";
GcsSource gcsSource = new GcsSource();
// Make the request
Operation<Document, KnowledgeOperationMetadata> response = documentsClient.ReloadDocument(name, gcsSource);
// Poll until the returned long-running operation is complete
Operation<Document, KnowledgeOperationMetadata> completedResponse = response.PollUntilCompleted();
// Retrieve the operation result
Document result = completedResponse.Result;
// Or get the name of the operation
string operationName = response.Name;
// This name can be stored, then the long-running operation retrieved later by name
Operation<Document, KnowledgeOperationMetadata> retrievedResponse = documentsClient.PollOnceReloadDocument(operationName);
// Check if the retrieved long-running operation has completed
if (retrievedResponse.IsCompleted)
{
// If it has completed, then access the result
Document retrievedResult = retrievedResponse.Result;
}
ReloadDocumentAsync(DocumentName, GcsSource, CallSettings)
public virtual Task<Operation<Document, KnowledgeOperationMetadata>> ReloadDocumentAsync(DocumentName name, GcsSource gcsSource, 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.
Note: If the document source is Google Cloud Storage URI, its metadata will
be replaced with the custom metadata from Google Cloud Storage if the
import_gcs_custom_metadata field is set to true in the request.
This method is a long-running
operation.
The returned Operation type has the following method-specific fields:
metadata: [KnowledgeOperationMetadata][google.cloud.dialogflow.v2beta1.KnowledgeOperationMetadata]response: [Document][google.cloud.dialogflow.v2beta1.Document]
Note: The projects.agent.knowledgeBases.documents resource is deprecated;
only use projects.knowledgeBases.documents.
| Parameters | |
|---|---|
| Name | Description |
name |
DocumentNameRequired. The name of the document to reload.
Format: |
gcsSource |
GcsSourceThe path for a Cloud Storage source file for reloading document content. If not provided, the Document's existing source will be reloaded. |
callSettings |
CallSettingsIf not null, applies overrides to this RPC call. |
| Returns | |
|---|---|
| Type | Description |
TaskOperationDocumentKnowledgeOperationMetadata |
A Task containing the RPC response. |
// Create client
DocumentsClient documentsClient = await DocumentsClient.CreateAsync();
// Initialize request argument(s)
DocumentName name = DocumentName.FromProjectKnowledgeBaseDocument("[PROJECT]", "[KNOWLEDGE_BASE]", "[DOCUMENT]");
GcsSource gcsSource = new GcsSource();
// Make the request
Operation<Document, KnowledgeOperationMetadata> response = await documentsClient.ReloadDocumentAsync(name, gcsSource);
// Poll until the returned long-running operation is complete
Operation<Document, KnowledgeOperationMetadata> completedResponse = await response.PollUntilCompletedAsync();
// Retrieve the operation result
Document result = completedResponse.Result;
// Or get the name of the operation
string operationName = response.Name;
// This name can be stored, then the long-running operation retrieved later by name
Operation<Document, KnowledgeOperationMetadata> retrievedResponse = await documentsClient.PollOnceReloadDocumentAsync(operationName);
// Check if the retrieved long-running operation has completed
if (retrievedResponse.IsCompleted)
{
// If it has completed, then access the result
Document retrievedResult = retrievedResponse.Result;
}
ReloadDocumentAsync(DocumentName, GcsSource, CancellationToken)
public virtual Task<Operation<Document, KnowledgeOperationMetadata>> ReloadDocumentAsync(DocumentName name, GcsSource gcsSource, CancellationToken cancellationToken)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.
Note: If the document source is Google Cloud Storage URI, its metadata will
be replaced with the custom metadata from Google Cloud Storage if the
import_gcs_custom_metadata field is set to true in the request.
This method is a long-running
operation.
The returned Operation type has the following method-specific fields:
metadata: [KnowledgeOperationMetadata][google.cloud.dialogflow.v2beta1.KnowledgeOperationMetadata]response: [Document][google.cloud.dialogflow.v2beta1.Document]
Note: The projects.agent.knowledgeBases.documents resource is deprecated;
only use projects.knowledgeBases.documents.
| Parameters | |
|---|---|
| Name | Description |
name |
DocumentNameRequired. The name of the document to reload.
Format: |
gcsSource |
GcsSourceThe path for a Cloud Storage source file for reloading document content. If not provided, the Document's existing source will be reloaded. |
cancellationToken |
CancellationTokenA CancellationToken to use for this RPC. |
| Returns | |
|---|---|
| Type | Description |
TaskOperationDocumentKnowledgeOperationMetadata |
A Task containing the RPC response. |
// Create client
DocumentsClient documentsClient = await DocumentsClient.CreateAsync();
// Initialize request argument(s)
DocumentName name = DocumentName.FromProjectKnowledgeBaseDocument("[PROJECT]", "[KNOWLEDGE_BASE]", "[DOCUMENT]");
GcsSource gcsSource = new GcsSource();
// Make the request
Operation<Document, KnowledgeOperationMetadata> response = await documentsClient.ReloadDocumentAsync(name, gcsSource);
// Poll until the returned long-running operation is complete
Operation<Document, KnowledgeOperationMetadata> completedResponse = await response.PollUntilCompletedAsync();
// Retrieve the operation result
Document result = completedResponse.Result;
// Or get the name of the operation
string operationName = response.Name;
// This name can be stored, then the long-running operation retrieved later by name
Operation<Document, KnowledgeOperationMetadata> retrievedResponse = await documentsClient.PollOnceReloadDocumentAsync(operationName);
// Check if the retrieved long-running operation has completed
if (retrievedResponse.IsCompleted)
{
// If it has completed, then access the result
Document retrievedResult = retrievedResponse.Result;
}
ReloadDocumentAsync(ReloadDocumentRequest, CallSettings)
public virtual 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.
Note: If the document source is Google Cloud Storage URI, its metadata will
be replaced with the custom metadata from Google Cloud Storage if the
import_gcs_custom_metadata field is set to true in the request.
This method is a long-running
operation.
The returned Operation type has the following method-specific fields:
metadata: [KnowledgeOperationMetadata][google.cloud.dialogflow.v2beta1.KnowledgeOperationMetadata]response: [Document][google.cloud.dialogflow.v2beta1.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. |
// Create client
DocumentsClient documentsClient = await DocumentsClient.CreateAsync();
// Initialize request argument(s)
ReloadDocumentRequest request = new ReloadDocumentRequest
{
DocumentName = DocumentName.FromProjectKnowledgeBaseDocument("[PROJECT]", "[KNOWLEDGE_BASE]", "[DOCUMENT]"),
GcsSource = new GcsSource(),
ImportGcsCustomMetadata = false,
};
// Make the request
Operation<Document, KnowledgeOperationMetadata> response = await documentsClient.ReloadDocumentAsync(request);
// Poll until the returned long-running operation is complete
Operation<Document, KnowledgeOperationMetadata> completedResponse = await response.PollUntilCompletedAsync();
// Retrieve the operation result
Document result = completedResponse.Result;
// Or get the name of the operation
string operationName = response.Name;
// This name can be stored, then the long-running operation retrieved later by name
Operation<Document, KnowledgeOperationMetadata> retrievedResponse = await documentsClient.PollOnceReloadDocumentAsync(operationName);
// Check if the retrieved long-running operation has completed
if (retrievedResponse.IsCompleted)
{
// If it has completed, then access the result
Document retrievedResult = retrievedResponse.Result;
}
ReloadDocumentAsync(ReloadDocumentRequest, CancellationToken)
public virtual Task<Operation<Document, KnowledgeOperationMetadata>> ReloadDocumentAsync(ReloadDocumentRequest request, CancellationToken cancellationToken)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.
Note: If the document source is Google Cloud Storage URI, its metadata will
be replaced with the custom metadata from Google Cloud Storage if the
import_gcs_custom_metadata field is set to true in the request.
This method is a long-running
operation.
The returned Operation type has the following method-specific fields:
metadata: [KnowledgeOperationMetadata][google.cloud.dialogflow.v2beta1.KnowledgeOperationMetadata]response: [Document][google.cloud.dialogflow.v2beta1.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. |
cancellationToken |
CancellationTokenA CancellationToken to use for this RPC. |
| Returns | |
|---|---|
| Type | Description |
TaskOperationDocumentKnowledgeOperationMetadata |
A Task containing the RPC response. |
// Create client
DocumentsClient documentsClient = await DocumentsClient.CreateAsync();
// Initialize request argument(s)
ReloadDocumentRequest request = new ReloadDocumentRequest
{
DocumentName = DocumentName.FromProjectKnowledgeBaseDocument("[PROJECT]", "[KNOWLEDGE_BASE]", "[DOCUMENT]"),
GcsSource = new GcsSource(),
ImportGcsCustomMetadata = false,
};
// Make the request
Operation<Document, KnowledgeOperationMetadata> response = await documentsClient.ReloadDocumentAsync(request);
// Poll until the returned long-running operation is complete
Operation<Document, KnowledgeOperationMetadata> completedResponse = await response.PollUntilCompletedAsync();
// Retrieve the operation result
Document result = completedResponse.Result;
// Or get the name of the operation
string operationName = response.Name;
// This name can be stored, then the long-running operation retrieved later by name
Operation<Document, KnowledgeOperationMetadata> retrievedResponse = await documentsClient.PollOnceReloadDocumentAsync(operationName);
// Check if the retrieved long-running operation has completed
if (retrievedResponse.IsCompleted)
{
// If it has completed, then access the result
Document retrievedResult = retrievedResponse.Result;
}
ReloadDocumentAsync(string, GcsSource, CallSettings)
public virtual Task<Operation<Document, KnowledgeOperationMetadata>> ReloadDocumentAsync(string name, GcsSource gcsSource, 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.
Note: If the document source is Google Cloud Storage URI, its metadata will
be replaced with the custom metadata from Google Cloud Storage if the
import_gcs_custom_metadata field is set to true in the request.
This method is a long-running
operation.
The returned Operation type has the following method-specific fields:
metadata: [KnowledgeOperationMetadata][google.cloud.dialogflow.v2beta1.KnowledgeOperationMetadata]response: [Document][google.cloud.dialogflow.v2beta1.Document]
Note: The projects.agent.knowledgeBases.documents resource is deprecated;
only use projects.knowledgeBases.documents.
| Parameters | |
|---|---|
| Name | Description |
name |
stringRequired. The name of the document to reload.
Format: |
gcsSource |
GcsSourceThe path for a Cloud Storage source file for reloading document content. If not provided, the Document's existing source will be reloaded. |
callSettings |
CallSettingsIf not null, applies overrides to this RPC call. |
| Returns | |
|---|---|
| Type | Description |
TaskOperationDocumentKnowledgeOperationMetadata |
A Task containing the RPC response. |
// Create client
DocumentsClient documentsClient = await DocumentsClient.CreateAsync();
// Initialize request argument(s)
string name = "projects/[PROJECT]/knowledgeBases/[KNOWLEDGE_BASE]/documents/[DOCUMENT]";
GcsSource gcsSource = new GcsSource();
// Make the request
Operation<Document, KnowledgeOperationMetadata> response = await documentsClient.ReloadDocumentAsync(name, gcsSource);
// Poll until the returned long-running operation is complete
Operation<Document, KnowledgeOperationMetadata> completedResponse = await response.PollUntilCompletedAsync();
// Retrieve the operation result
Document result = completedResponse.Result;
// Or get the name of the operation
string operationName = response.Name;
// This name can be stored, then the long-running operation retrieved later by name
Operation<Document, KnowledgeOperationMetadata> retrievedResponse = await documentsClient.PollOnceReloadDocumentAsync(operationName);
// Check if the retrieved long-running operation has completed
if (retrievedResponse.IsCompleted)
{
// If it has completed, then access the result
Document retrievedResult = retrievedResponse.Result;
}
ReloadDocumentAsync(string, GcsSource, CancellationToken)
public virtual Task<Operation<Document, KnowledgeOperationMetadata>> ReloadDocumentAsync(string name, GcsSource gcsSource, CancellationToken cancellationToken)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.
Note: If the document source is Google Cloud Storage URI, its metadata will
be replaced with the custom metadata from Google Cloud Storage if the
import_gcs_custom_metadata field is set to true in the request.
This method is a long-running
operation.
The returned Operation type has the following method-specific fields:
metadata: [KnowledgeOperationMetadata][google.cloud.dialogflow.v2beta1.KnowledgeOperationMetadata]response: [Document][google.cloud.dialogflow.v2beta1.Document]
Note: The projects.agent.knowledgeBases.documents resource is deprecated;
only use projects.knowledgeBases.documents.
| Parameters | |
|---|---|
| Name | Description |
name |
stringRequired. The name of the document to reload.
Format: |
gcsSource |
GcsSourceThe path for a Cloud Storage source file for reloading document content. If not provided, the Document's existing source will be reloaded. |
cancellationToken |
CancellationTokenA CancellationToken to use for this RPC. |
| Returns | |
|---|---|
| Type | Description |
TaskOperationDocumentKnowledgeOperationMetadata |
A Task containing the RPC response. |
// Create client
DocumentsClient documentsClient = await DocumentsClient.CreateAsync();
// Initialize request argument(s)
string name = "projects/[PROJECT]/knowledgeBases/[KNOWLEDGE_BASE]/documents/[DOCUMENT]";
GcsSource gcsSource = new GcsSource();
// Make the request
Operation<Document, KnowledgeOperationMetadata> response = await documentsClient.ReloadDocumentAsync(name, gcsSource);
// Poll until the returned long-running operation is complete
Operation<Document, KnowledgeOperationMetadata> completedResponse = await response.PollUntilCompletedAsync();
// Retrieve the operation result
Document result = completedResponse.Result;
// Or get the name of the operation
string operationName = response.Name;
// This name can be stored, then the long-running operation retrieved later by name
Operation<Document, KnowledgeOperationMetadata> retrievedResponse = await documentsClient.PollOnceReloadDocumentAsync(operationName);
// Check if the retrieved long-running operation has completed
if (retrievedResponse.IsCompleted)
{
// If it has completed, then access the result
Document retrievedResult = retrievedResponse.Result;
}
ShutdownDefaultChannelsAsync()
public static Task ShutdownDefaultChannelsAsync()Shuts down any channels automatically created by Create() and CreateAsync(CancellationToken). Channels which weren't automatically created are not affected.
| Returns | |
|---|---|
| Type | Description |
Task |
A task representing the asynchronous shutdown operation. |
After calling this method, further calls to Create() and CreateAsync(CancellationToken) will create new channels, which could in turn be shut down by another call to this method.
UpdateDocument(Document, CallSettings)
public virtual Operation<Document, KnowledgeOperationMetadata> UpdateDocument(Document document, 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.v2beta1.KnowledgeOperationMetadata]response: [Document][google.cloud.dialogflow.v2beta1.Document]
Note: The projects.agent.knowledgeBases.documents resource is deprecated;
only use projects.knowledgeBases.documents.
| Parameters | |
|---|---|
| Name | Description |
document |
DocumentRequired. The document to update. |
callSettings |
CallSettingsIf not null, applies overrides to this RPC call. |
| Returns | |
|---|---|
| Type | Description |
OperationDocumentKnowledgeOperationMetadata |
The RPC response. |
// Create client
DocumentsClient documentsClient = DocumentsClient.Create();
// Initialize request argument(s)
Document document = new Document();
// Make the request
Operation<Document, KnowledgeOperationMetadata> response = documentsClient.UpdateDocument(document);
// Poll until the returned long-running operation is complete
Operation<Document, KnowledgeOperationMetadata> completedResponse = response.PollUntilCompleted();
// Retrieve the operation result
Document result = completedResponse.Result;
// Or get the name of the operation
string operationName = response.Name;
// This name can be stored, then the long-running operation retrieved later by name
Operation<Document, KnowledgeOperationMetadata> retrievedResponse = documentsClient.PollOnceUpdateDocument(operationName);
// Check if the retrieved long-running operation has completed
if (retrievedResponse.IsCompleted)
{
// If it has completed, then access the result
Document retrievedResult = retrievedResponse.Result;
}
UpdateDocument(Document, FieldMask, CallSettings)
public virtual Operation<Document, KnowledgeOperationMetadata> UpdateDocument(Document document, FieldMask updateMask, 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.v2beta1.KnowledgeOperationMetadata]response: [Document][google.cloud.dialogflow.v2beta1.Document]
Note: The projects.agent.knowledgeBases.documents resource is deprecated;
only use projects.knowledgeBases.documents.
| Parameters | |
|---|---|
| Name | Description |
document |
DocumentRequired. The document to update. |
updateMask |
FieldMaskOptional. Not specified means |
callSettings |
CallSettingsIf not null, applies overrides to this RPC call. |
| Returns | |
|---|---|
| Type | Description |
OperationDocumentKnowledgeOperationMetadata |
The RPC response. |
// Create client
DocumentsClient documentsClient = DocumentsClient.Create();
// Initialize request argument(s)
Document document = new Document();
FieldMask updateMask = new FieldMask();
// Make the request
Operation<Document, KnowledgeOperationMetadata> response = documentsClient.UpdateDocument(document, updateMask);
// Poll until the returned long-running operation is complete
Operation<Document, KnowledgeOperationMetadata> completedResponse = response.PollUntilCompleted();
// Retrieve the operation result
Document result = completedResponse.Result;
// Or get the name of the operation
string operationName = response.Name;
// This name can be stored, then the long-running operation retrieved later by name
Operation<Document, KnowledgeOperationMetadata> retrievedResponse = documentsClient.PollOnceUpdateDocument(operationName);
// Check if the retrieved long-running operation has completed
if (retrievedResponse.IsCompleted)
{
// If it has completed, then access the result
Document retrievedResult = retrievedResponse.Result;
}
UpdateDocument(UpdateDocumentRequest, CallSettings)
public virtual 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.v2beta1.KnowledgeOperationMetadata]response: [Document][google.cloud.dialogflow.v2beta1.Document]
Note: The projects.agent.knowledgeBases.documents resource is deprecated;
only use projects.knowledgeBases.documents.
| 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. |
// Create client
DocumentsClient documentsClient = DocumentsClient.Create();
// Initialize request argument(s)
UpdateDocumentRequest request = new UpdateDocumentRequest
{
Document = new Document(),
UpdateMask = new FieldMask(),
};
// Make the request
Operation<Document, KnowledgeOperationMetadata> response = documentsClient.UpdateDocument(request);
// Poll until the returned long-running operation is complete
Operation<Document, KnowledgeOperationMetadata> completedResponse = response.PollUntilCompleted();
// Retrieve the operation result
Document result = completedResponse.Result;
// Or get the name of the operation
string operationName = response.Name;
// This name can be stored, then the long-running operation retrieved later by name
Operation<Document, KnowledgeOperationMetadata> retrievedResponse = documentsClient.PollOnceUpdateDocument(operationName);
// Check if the retrieved long-running operation has completed
if (retrievedResponse.IsCompleted)
{
// If it has completed, then access the result
Document retrievedResult = retrievedResponse.Result;
}
UpdateDocumentAsync(Document, CallSettings)
public virtual Task<Operation<Document, KnowledgeOperationMetadata>> UpdateDocumentAsync(Document document, 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.v2beta1.KnowledgeOperationMetadata]response: [Document][google.cloud.dialogflow.v2beta1.Document]
Note: The projects.agent.knowledgeBases.documents resource is deprecated;
only use projects.knowledgeBases.documents.
| Parameters | |
|---|---|
| Name | Description |
document |
DocumentRequired. The document to update. |
callSettings |
CallSettingsIf not null, applies overrides to this RPC call. |
| Returns | |
|---|---|
| Type | Description |
TaskOperationDocumentKnowledgeOperationMetadata |
A Task containing the RPC response. |
// Create client
DocumentsClient documentsClient = await DocumentsClient.CreateAsync();
// Initialize request argument(s)
Document document = new Document();
// Make the request
Operation<Document, KnowledgeOperationMetadata> response = await documentsClient.UpdateDocumentAsync(document);
// Poll until the returned long-running operation is complete
Operation<Document, KnowledgeOperationMetadata> completedResponse = await response.PollUntilCompletedAsync();
// Retrieve the operation result
Document result = completedResponse.Result;
// Or get the name of the operation
string operationName = response.Name;
// This name can be stored, then the long-running operation retrieved later by name
Operation<Document, KnowledgeOperationMetadata> retrievedResponse = await documentsClient.PollOnceUpdateDocumentAsync(operationName);
// Check if the retrieved long-running operation has completed
if (retrievedResponse.IsCompleted)
{
// If it has completed, then access the result
Document retrievedResult = retrievedResponse.Result;
}
UpdateDocumentAsync(Document, FieldMask, CallSettings)
public virtual Task<Operation<Document, KnowledgeOperationMetadata>> UpdateDocumentAsync(Document document, FieldMask updateMask, 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.v2beta1.KnowledgeOperationMetadata]response: [Document][google.cloud.dialogflow.v2beta1.Document]
Note: The projects.agent.knowledgeBases.documents resource is deprecated;
only use projects.knowledgeBases.documents.
| Parameters | |
|---|---|
| Name | Description |
document |
DocumentRequired. The document to update. |
updateMask |
FieldMaskOptional. Not specified means |
callSettings |
CallSettingsIf not null, applies overrides to this RPC call. |
| Returns | |
|---|---|
| Type | Description |
TaskOperationDocumentKnowledgeOperationMetadata |
A Task containing the RPC response. |
// Create client
DocumentsClient documentsClient = await DocumentsClient.CreateAsync();
// Initialize request argument(s)
Document document = new Document();
FieldMask updateMask = new FieldMask();
// Make the request
Operation<Document, KnowledgeOperationMetadata> response = await documentsClient.UpdateDocumentAsync(document, updateMask);
// Poll until the returned long-running operation is complete
Operation<Document, KnowledgeOperationMetadata> completedResponse = await response.PollUntilCompletedAsync();
// Retrieve the operation result
Document result = completedResponse.Result;
// Or get the name of the operation
string operationName = response.Name;
// This name can be stored, then the long-running operation retrieved later by name
Operation<Document, KnowledgeOperationMetadata> retrievedResponse = await documentsClient.PollOnceUpdateDocumentAsync(operationName);
// Check if the retrieved long-running operation has completed
if (retrievedResponse.IsCompleted)
{
// If it has completed, then access the result
Document retrievedResult = retrievedResponse.Result;
}
UpdateDocumentAsync(Document, FieldMask, CancellationToken)
public virtual Task<Operation<Document, KnowledgeOperationMetadata>> UpdateDocumentAsync(Document document, FieldMask updateMask, CancellationToken cancellationToken)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.v2beta1.KnowledgeOperationMetadata]response: [Document][google.cloud.dialogflow.v2beta1.Document]
Note: The projects.agent.knowledgeBases.documents resource is deprecated;
only use projects.knowledgeBases.documents.
| Parameters | |
|---|---|
| Name | Description |
document |
DocumentRequired. The document to update. |
updateMask |
FieldMaskOptional. Not specified means |
cancellationToken |
CancellationTokenA CancellationToken to use for this RPC. |
| Returns | |
|---|---|
| Type | Description |
TaskOperationDocumentKnowledgeOperationMetadata |
A Task containing the RPC response. |
// Create client
DocumentsClient documentsClient = await DocumentsClient.CreateAsync();
// Initialize request argument(s)
Document document = new Document();
FieldMask updateMask = new FieldMask();
// Make the request
Operation<Document, KnowledgeOperationMetadata> response = await documentsClient.UpdateDocumentAsync(document, updateMask);
// Poll until the returned long-running operation is complete
Operation<Document, KnowledgeOperationMetadata> completedResponse = await response.PollUntilCompletedAsync();
// Retrieve the operation result
Document result = completedResponse.Result;
// Or get the name of the operation
string operationName = response.Name;
// This name can be stored, then the long-running operation retrieved later by name
Operation<Document, KnowledgeOperationMetadata> retrievedResponse = await documentsClient.PollOnceUpdateDocumentAsync(operationName);
// Check if the retrieved long-running operation has completed
if (retrievedResponse.IsCompleted)
{
// If it has completed, then access the result
Document retrievedResult = retrievedResponse.Result;
}
UpdateDocumentAsync(Document, CancellationToken)
public virtual Task<Operation<Document, KnowledgeOperationMetadata>> UpdateDocumentAsync(Document document, CancellationToken cancellationToken)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.v2beta1.KnowledgeOperationMetadata]response: [Document][google.cloud.dialogflow.v2beta1.Document]
Note: The projects.agent.knowledgeBases.documents resource is deprecated;
only use projects.knowledgeBases.documents.
| Parameters | |
|---|---|
| Name | Description |
document |
DocumentRequired. The document to update. |
cancellationToken |
CancellationTokenA CancellationToken to use for this RPC. |
| Returns | |
|---|---|
| Type | Description |
TaskOperationDocumentKnowledgeOperationMetadata |
A Task containing the RPC response. |
// Create client
DocumentsClient documentsClient = await DocumentsClient.CreateAsync();
// Initialize request argument(s)
Document document = new Document();
// Make the request
Operation<Document, KnowledgeOperationMetadata> response = await documentsClient.UpdateDocumentAsync(document);
// Poll until the returned long-running operation is complete
Operation<Document, KnowledgeOperationMetadata> completedResponse = await response.PollUntilCompletedAsync();
// Retrieve the operation result
Document result = completedResponse.Result;
// Or get the name of the operation
string operationName = response.Name;
// This name can be stored, then the long-running operation retrieved later by name
Operation<Document, KnowledgeOperationMetadata> retrievedResponse = await documentsClient.PollOnceUpdateDocumentAsync(operationName);
// Check if the retrieved long-running operation has completed
if (retrievedResponse.IsCompleted)
{
// If it has completed, then access the result
Document retrievedResult = retrievedResponse.Result;
}
UpdateDocumentAsync(UpdateDocumentRequest, CallSettings)
public virtual 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.v2beta1.KnowledgeOperationMetadata]response: [Document][google.cloud.dialogflow.v2beta1.Document]
Note: The projects.agent.knowledgeBases.documents resource is deprecated;
only use projects.knowledgeBases.documents.
| 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. |
// Create client
DocumentsClient documentsClient = await DocumentsClient.CreateAsync();
// Initialize request argument(s)
UpdateDocumentRequest request = new UpdateDocumentRequest
{
Document = new Document(),
UpdateMask = new FieldMask(),
};
// Make the request
Operation<Document, KnowledgeOperationMetadata> response = await documentsClient.UpdateDocumentAsync(request);
// Poll until the returned long-running operation is complete
Operation<Document, KnowledgeOperationMetadata> completedResponse = await response.PollUntilCompletedAsync();
// Retrieve the operation result
Document result = completedResponse.Result;
// Or get the name of the operation
string operationName = response.Name;
// This name can be stored, then the long-running operation retrieved later by name
Operation<Document, KnowledgeOperationMetadata> retrievedResponse = await documentsClient.PollOnceUpdateDocumentAsync(operationName);
// Check if the retrieved long-running operation has completed
if (retrievedResponse.IsCompleted)
{
// If it has completed, then access the result
Document retrievedResult = retrievedResponse.Result;
}
UpdateDocumentAsync(UpdateDocumentRequest, CancellationToken)
public virtual Task<Operation<Document, KnowledgeOperationMetadata>> UpdateDocumentAsync(UpdateDocumentRequest request, CancellationToken cancellationToken)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.v2beta1.KnowledgeOperationMetadata]response: [Document][google.cloud.dialogflow.v2beta1.Document]
Note: The projects.agent.knowledgeBases.documents resource is deprecated;
only use projects.knowledgeBases.documents.
| Parameters | |
|---|---|
| Name | Description |
request |
UpdateDocumentRequestThe request object containing all of the parameters for the API call. |
cancellationToken |
CancellationTokenA CancellationToken to use for this RPC. |
| Returns | |
|---|---|
| Type | Description |
TaskOperationDocumentKnowledgeOperationMetadata |
A Task containing the RPC response. |
// Create client
DocumentsClient documentsClient = await DocumentsClient.CreateAsync();
// Initialize request argument(s)
UpdateDocumentRequest request = new UpdateDocumentRequest
{
Document = new Document(),
UpdateMask = new FieldMask(),
};
// Make the request
Operation<Document, KnowledgeOperationMetadata> response = await documentsClient.UpdateDocumentAsync(request);
// Poll until the returned long-running operation is complete
Operation<Document, KnowledgeOperationMetadata> completedResponse = await response.PollUntilCompletedAsync();
// Retrieve the operation result
Document result = completedResponse.Result;
// Or get the name of the operation
string operationName = response.Name;
// This name can be stored, then the long-running operation retrieved later by name
Operation<Document, KnowledgeOperationMetadata> retrievedResponse = await documentsClient.PollOnceUpdateDocumentAsync(operationName);
// Check if the retrieved long-running operation has completed
if (retrievedResponse.IsCompleted)
{
// If it has completed, then access the result
Document retrievedResult = retrievedResponse.Result;
}