Class Documents.DocumentsBase (3.2.0)

[BindServiceMethod(typeof(Documents), "BindService")]
public abstract class DocumentsBase

Base class for server-side implementations of Documents

Inheritance

Object > Documents.DocumentsBase

Namespace

Google.Cloud.Dialogflow.V2

Assembly

Google.Cloud.Dialogflow.V2.dll

Methods

CreateDocument(CreateDocumentRequest, ServerCallContext)

public virtual Task<Operation> CreateDocument(CreateDocumentRequest request, ServerCallContext context)

Creates a new document.

Operation <response: [Document][google.cloud.dialogflow.v2.Document], metadata: [KnowledgeOperationMetadata][google.cloud.dialogflow.v2.KnowledgeOperationMetadata]>

Parameters
NameDescription
requestCreateDocumentRequest

The request received from the client.

contextServerCallContext

The context of the server-side call handler being invoked.

Returns
TypeDescription
Task<Google.LongRunning.Operation>

The response to send back to the client (wrapped by a task).

DeleteDocument(DeleteDocumentRequest, ServerCallContext)

public virtual Task<Operation> DeleteDocument(DeleteDocumentRequest request, ServerCallContext context)

Deletes the specified document.

Operation <response: [google.protobuf.Empty][google.protobuf.Empty], metadata: [KnowledgeOperationMetadata][google.cloud.dialogflow.v2.KnowledgeOperationMetadata]>

Parameters
NameDescription
requestDeleteDocumentRequest

The request received from the client.

contextServerCallContext

The context of the server-side call handler being invoked.

Returns
TypeDescription
Task<Google.LongRunning.Operation>

The response to send back to the client (wrapped by a task).

GetDocument(GetDocumentRequest, ServerCallContext)

public virtual Task<Document> GetDocument(GetDocumentRequest request, ServerCallContext context)

Retrieves the specified document.

Parameters
NameDescription
requestGetDocumentRequest

The request received from the client.

contextServerCallContext

The context of the server-side call handler being invoked.

Returns
TypeDescription
Task<Document>

The response to send back to the client (wrapped by a task).

ListDocuments(ListDocumentsRequest, ServerCallContext)

public virtual Task<ListDocumentsResponse> ListDocuments(ListDocumentsRequest request, ServerCallContext context)

Returns the list of all documents of the knowledge base.

Parameters
NameDescription
requestListDocumentsRequest

The request received from the client.

contextServerCallContext

The context of the server-side call handler being invoked.

Returns
TypeDescription
Task<ListDocumentsResponse>

The response to send back to the client (wrapped by a task).

ReloadDocument(ReloadDocumentRequest, ServerCallContext)

public virtual Task<Operation> ReloadDocument(ReloadDocumentRequest request, ServerCallContext context)

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: The projects.agent.knowledgeBases.documents resource is deprecated; only use projects.knowledgeBases.documents.

Operation <response: [Document][google.cloud.dialogflow.v2.Document], metadata: [KnowledgeOperationMetadata][google.cloud.dialogflow.v2.KnowledgeOperationMetadata]>

Parameters
NameDescription
requestReloadDocumentRequest

The request received from the client.

contextServerCallContext

The context of the server-side call handler being invoked.

Returns
TypeDescription
Task<Google.LongRunning.Operation>

The response to send back to the client (wrapped by a task).

UpdateDocument(UpdateDocumentRequest, ServerCallContext)

public virtual Task<Operation> UpdateDocument(UpdateDocumentRequest request, ServerCallContext context)

Updates the specified document.

Operation <response: [Document][google.cloud.dialogflow.v2.Document], metadata: [KnowledgeOperationMetadata][google.cloud.dialogflow.v2.KnowledgeOperationMetadata]>

Parameters
NameDescription
requestUpdateDocumentRequest

The request received from the client.

contextServerCallContext

The context of the server-side call handler being invoked.

Returns
TypeDescription
Task<Google.LongRunning.Operation>

The response to send back to the client (wrapped by a task).