Class DocumentsGrpc.DocumentsBlockingStub (4.28.0)

public static final class DocumentsGrpc.DocumentsBlockingStub extends AbstractBlockingStub<DocumentsGrpc.DocumentsBlockingStub>

A stub to allow clients to do synchronous rpc calls to service Documents.

Service for managing knowledge Documents.

Inheritance

java.lang.Object > io.grpc.stub.AbstractStub > io.grpc.stub.AbstractBlockingStub > DocumentsGrpc.DocumentsBlockingStub

Methods

build(Channel channel, CallOptions callOptions)

protected DocumentsGrpc.DocumentsBlockingStub build(Channel channel, CallOptions callOptions)
Parameters
Name Description
channel io.grpc.Channel
callOptions io.grpc.CallOptions
Returns
Type Description
DocumentsGrpc.DocumentsBlockingStub
Overrides
io.grpc.stub.AbstractStub.build(io.grpc.Channel,io.grpc.CallOptions)

createDocument(CreateDocumentRequest request)

public Operation createDocument(CreateDocumentRequest request)

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.
Parameter
Name Description
request CreateDocumentRequest
Returns
Type Description
Operation

deleteDocument(DeleteDocumentRequest request)

public Operation deleteDocument(DeleteDocumentRequest request)

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.
Parameter
Name Description
request DeleteDocumentRequest
Returns
Type Description
Operation

getDocument(GetDocumentRequest request)

public Document getDocument(GetDocumentRequest request)

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

Parameter
Name Description
request GetDocumentRequest
Returns
Type Description
Document

importDocuments(ImportDocumentsRequest request)

public Operation importDocuments(ImportDocumentsRequest request)

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
Parameter
Name Description
request ImportDocumentsRequest
Returns
Type Description
Operation

listDocuments(ListDocumentsRequest request)

public ListDocumentsResponse listDocuments(ListDocumentsRequest request)

Returns the list of all documents of the knowledge base. Note: The projects.agent.knowledgeBases.documents resource is deprecated; only use projects.knowledgeBases.documents.

Parameter
Name Description
request ListDocumentsRequest
Returns
Type Description
ListDocumentsResponse

reloadDocument(ReloadDocumentRequest request)

public Operation reloadDocument(ReloadDocumentRequest request)

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.
Parameter
Name Description
request ReloadDocumentRequest
Returns
Type Description
Operation

updateDocument(UpdateDocumentRequest request)

public Operation updateDocument(UpdateDocumentRequest request)

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.
Parameter
Name Description
request UpdateDocumentRequest
Returns
Type Description
Operation