Interface DocumentsGrpc.AsyncService (4.53.0)

Version 4.53.0

• 4.59.0 (latest)
• 4.58.0
• 4.57.0
• 4.55.0
• 4.54.0
• 4.53.0
• 4.52.0
• 4.51.0
• 4.50.0
• 4.49.0
• 4.48.0
• 4.47.0
• 4.46.0
• 4.45.0
• 4.43.0
• 4.42.0
• 4.41.0
• 4.40.0
• 4.39.0
• 4.38.0
• 4.37.0
• 4.36.0
• 4.35.0
• 4.34.0
• 4.33.0
• 4.30.0
• 4.29.0
• 4.28.0
• 4.27.0
• 4.26.0
• 4.25.0
• 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.15.0
• 4.14.0
• 4.13.0
• 4.12.0
• 4.11.0
• 4.10.0
• 4.9.1
• 4.8.6
• 4.7.5
• 4.6.0
• 4.5.11
• 4.4.0
• 4.3.1

public static interface DocumentsGrpc.AsyncService

Service for managing knowledge Documents.

Methods

createDocument(CreateDocumentRequest request, StreamObserver<Operation> responseObserver)

public default void createDocument(CreateDocumentRequest request, StreamObserver<Operation> responseObserver)

Creates a new document. This method is a long-running operation. The returned Operation type has the following method-specific fields:

• metadata: KnowledgeOperationMetadata
• response: Document Note: The projects.agent.knowledgeBases.documents resource is deprecated; only use projects.knowledgeBases.documents.

Parameters
Name	Description
request	CreateDocumentRequest
responseObserver	io.grpc.stub.StreamObserver<Operation>

deleteDocument(DeleteDocumentRequest request, StreamObserver<Operation> responseObserver)

public default void deleteDocument(DeleteDocumentRequest request, StreamObserver<Operation> responseObserver)

Deletes the specified document. This method is a long-running operation. The returned Operation type has the following method-specific fields:

• metadata: KnowledgeOperationMetadata
• response: An Empty message Note: The projects.agent.knowledgeBases.documents resource is deprecated; only use projects.knowledgeBases.documents.

Parameters
Name	Description
request	DeleteDocumentRequest
responseObserver	io.grpc.stub.StreamObserver<Operation>

getDocument(GetDocumentRequest request, StreamObserver<Document> responseObserver)

public default void getDocument(GetDocumentRequest request, StreamObserver<Document> responseObserver)

Retrieves the specified document. Note: The projects.agent.knowledgeBases.documents resource is deprecated; only use projects.knowledgeBases.documents.

Parameters
Name	Description
request	GetDocumentRequest
responseObserver	io.grpc.stub.StreamObserver<Document>

importDocuments(ImportDocumentsRequest request, StreamObserver<Operation> responseObserver)

public default void importDocuments(ImportDocumentsRequest request, StreamObserver<Operation> responseObserver)

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
• response: ImportDocumentsResponse

Parameters
Name	Description
request	ImportDocumentsRequest
responseObserver	io.grpc.stub.StreamObserver<Operation>

listDocuments(ListDocumentsRequest request, StreamObserver<ListDocumentsResponse> responseObserver)

public default void listDocuments(ListDocumentsRequest request, StreamObserver<ListDocumentsResponse> responseObserver)

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	ListDocumentsRequest
responseObserver	io.grpc.stub.StreamObserver<ListDocumentsResponse>

reloadDocument(ReloadDocumentRequest request, StreamObserver<Operation> responseObserver)

public default void reloadDocument(ReloadDocumentRequest request, 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. 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
• response: Document Note: The projects.agent.knowledgeBases.documents resource is deprecated; only use projects.knowledgeBases.documents.

Parameters
Name	Description
request	ReloadDocumentRequest
responseObserver	io.grpc.stub.StreamObserver<Operation>

updateDocument(UpdateDocumentRequest request, StreamObserver<Operation> responseObserver)

public default void updateDocument(UpdateDocumentRequest request, StreamObserver<Operation> responseObserver)

Updates the specified document. This method is a long-running operation. The returned Operation type has the following method-specific fields:

• metadata: KnowledgeOperationMetadata
• response: Document Note: The projects.agent.knowledgeBases.documents resource is deprecated; only use projects.knowledgeBases.documents.

Parameters
Name	Description
request	UpdateDocumentRequest
responseObserver	io.grpc.stub.StreamObserver<Operation>