Package com.google.cloud.dialogflow.v2

Interface DocumentsGrpc.AsyncService

All Known Implementing Classes:
DocumentsGrpc.DocumentsImplBase
Enclosing class:
DocumentsGrpc
public static interface DocumentsGrpc.AsyncService
 Service for managing knowledge
 [Documents][google.cloud.dialogflow.v2.Document].

  • Method Details

    • listDocuments

      default void listDocuments(ListDocumentsRequest request, io.grpc.stub.StreamObserver<ListDocumentsResponse> responseObserver)
       Returns the list of all documents of the knowledge base.

    • getDocument

      default void getDocument(GetDocumentRequest request, io.grpc.stub.StreamObserver<Document> responseObserver)
       Retrieves the specified document.

    • createDocument

      default void createDocument(CreateDocumentRequest request, io.grpc.stub.StreamObserver<Operation> responseObserver)
       Creates a new document.
 This method is a [long-running
 operation](https://cloud.google.com/dialogflow/cx/docs/how/long-running-operation).
 The returned `Operation` type has the following method-specific fields:
 - `metadata`:
 [KnowledgeOperationMetadata][google.cloud.dialogflow.v2.KnowledgeOperationMetadata]
 - `response`: [Document][google.cloud.dialogflow.v2.Document]

    • importDocuments

      default void importDocuments(ImportDocumentsRequest request, io.grpc.stub.StreamObserver<Operation> responseObserver)
       Creates documents by importing data from external sources.
 Dialogflow supports up to 350 documents in each request. If you try to
 import more, Dialogflow will return an error.
 This method is a [long-running
 operation](https://cloud.google.com/dialogflow/cx/docs/how/long-running-operation).
 The returned `Operation` type has the following method-specific fields:
 - `metadata`:
 [KnowledgeOperationMetadata][google.cloud.dialogflow.v2.KnowledgeOperationMetadata]
 - `response`:
 [ImportDocumentsResponse][google.cloud.dialogflow.v2.ImportDocumentsResponse]

    • deleteDocument

      default void deleteDocument(DeleteDocumentRequest request, io.grpc.stub.StreamObserver<Operation> responseObserver)
       Deletes the specified document.
 This method is a [long-running
 operation](https://cloud.google.com/dialogflow/cx/docs/how/long-running-operation).
 The returned `Operation` type has the following method-specific fields:
 - `metadata`:
 [KnowledgeOperationMetadata][google.cloud.dialogflow.v2.KnowledgeOperationMetadata]
 - `response`: An [Empty
   message](https://developers.google.com/protocol-buffers/docs/reference/google.protobuf#empty)

    • updateDocument

      default void updateDocument(UpdateDocumentRequest request, io.grpc.stub.StreamObserver<Operation> responseObserver)
       Updates the specified document.
 This method is a [long-running
 operation](https://cloud.google.com/dialogflow/cx/docs/how/long-running-operation).
 The returned `Operation` type has the following method-specific fields:
 - `metadata`:
 [KnowledgeOperationMetadata][google.cloud.dialogflow.v2.KnowledgeOperationMetadata]
 - `response`: [Document][google.cloud.dialogflow.v2.Document]

    • reloadDocument

      default void reloadDocument(ReloadDocumentRequest request, io.grpc.stub.StreamObserver<Operation> responseObserver)
       Reloads the specified document from its specified source, content_uri or
 content. The previously loaded content of the document will be deleted.
 Note: Even when the content of the document has not changed, there still
 may be side effects because of internal implementation changes.
 This method is a [long-running
 operation](https://cloud.google.com/dialogflow/cx/docs/how/long-running-operation).
 The returned `Operation` type has the following method-specific fields:
 - `metadata`:
 [KnowledgeOperationMetadata][google.cloud.dialogflow.v2.KnowledgeOperationMetadata]
 - `response`: [Document][google.cloud.dialogflow.v2.Document]
 Note: The `projects.agent.knowledgeBases.documents` resource is deprecated;
 only use `projects.knowledgeBases.documents`.

    • exportDocument

      default void exportDocument(ExportDocumentRequest request, io.grpc.stub.StreamObserver<Operation> responseObserver)
       Exports a smart messaging candidate document into the specified
 destination.
 This method is a [long-running
 operation](https://cloud.google.com/dialogflow/cx/docs/how/long-running-operation).
 The returned `Operation` type has the following method-specific fields:
 - `metadata`:
 [KnowledgeOperationMetadata][google.cloud.dialogflow.v2.KnowledgeOperationMetadata]
 - `response`: [Document][google.cloud.dialogflow.v2.Document]