Class Documents.DocumentsBase (3.3.0)

Version 3.3.0

• 4.25.0 (latest)
• 4.24.0
• 4.23.0
• 4.22.0
• 4.21.0
• 4.20.0
• 4.19.0
• 4.18.0
• 4.17.0
• 4.16.0
• 4.15.0
• 4.14.0
• 4.13.0
• 4.12.0
• 4.11.0
• 4.10.0
• 4.9.0
• 4.8.0
• 4.7.0
• 4.6.0
• 4.5.0
• 4.4.0
• 4.3.0
• 4.2.0
• 4.1.0
• 4.0.0
• 3.11.0
• 3.10.0
• 3.9.0
• 3.8.0
• 3.7.0
• 3.6.0
• 3.5.0
• 3.4.0
• 3.3.0
• 3.2.0

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

Base class for server-side implementations of Documents

Inheritance

Object > Documents.DocumentsBase

Inherited Members

Object.GetHashCode()

Object.GetType()

Object.MemberwiseClone()

Object.ToString()

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
Name	Description
request	CreateDocumentRequest The request received from the client.
context	ServerCallContext The context of the server-side call handler being invoked.

Returns
Type	Description
Task<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
Name	Description
request	DeleteDocumentRequest The request received from the client.
context	ServerCallContext The context of the server-side call handler being invoked.

Returns
Type	Description
Task<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
Name	Description
request	GetDocumentRequest The request received from the client.
context	ServerCallContext The context of the server-side call handler being invoked.

Returns
Type	Description
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
Name	Description
request	ListDocumentsRequest The request received from the client.
context	ServerCallContext The context of the server-side call handler being invoked.

Returns
Type	Description
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
Name	Description
request	ReloadDocumentRequest The request received from the client.
context	ServerCallContext The context of the server-side call handler being invoked.

Returns
Type	Description
Task<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
Name	Description
request	UpdateDocumentRequest The request received from the client.
context	ServerCallContext The context of the server-side call handler being invoked.

Returns
Type	Description
Task<Operation>	The response to send back to the client (wrapped by a task).