Class DocumentsClient (4.5.11)

Version 4.5.11

• 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 class DocumentsClient implements BackgroundResource

Service Description: Service for managing knowledge Documents.

This class provides the ability to make remote calls to the backing service through method calls that map to API methods. Sample code to get started:

 try (DocumentsClient documentsClient = DocumentsClient.create()) {
   DocumentName name =
       DocumentName.ofProjectKnowledgeBaseDocumentName(
           "[PROJECT]", "[KNOWLEDGE_BASE]", "[DOCUMENT]");
   Document response = documentsClient.getDocument(name);
 }
 

Note: close() needs to be called on the DocumentsClient object to clean up resources such as threads. In the example above, try-with-resources is used, which automatically calls close().

The surface of this class includes several types of Java methods for each of the API's methods:

1. A "flattened" method. With this type of method, the fields of the request type have been converted into function parameters. It may be the case that not all fields are available as parameters, and not every API method will have a flattened method entry point.
2. A "request object" method. This type of method only takes one parameter, a request object, which must be constructed before the call. Not every API method will have a request object method.
3. A "callable" method. This type of method takes no parameters and returns an immutable API callable object, which can be used to initiate calls to the service.

See the individual methods for example code.

Many parameters require resource names to be formatted in a particular way. To assist with these names, this class includes a format method for each type of name, and additionally a parse method to extract the individual identifiers contained within names that are returned.

This class can be customized by passing in a custom instance of DocumentsSettings to create(). For example:

To customize credentials:

 DocumentsSettings documentsSettings =
     DocumentsSettings.newBuilder()
         .setCredentialsProvider(FixedCredentialsProvider.create(myCredentials))
         .build();
 DocumentsClient documentsClient = DocumentsClient.create(documentsSettings);
 

To customize the endpoint:

 DocumentsSettings documentsSettings =
     DocumentsSettings.newBuilder().setEndpoint(myEndpoint).build();
 DocumentsClient documentsClient = DocumentsClient.create(documentsSettings);
 

Please refer to the GitHub repository's samples for more quickstart code snippets.

Inheritance

java.lang.Object > DocumentsClient

Implements

BackgroundResource

Inherited Members

Object.clone()

Object.equals(Object)

Object.finalize()

Object.getClass()

Object.hashCode()

Object.notify()

Object.notifyAll()

Object.toString()

Object.wait()

Object.wait(long)

Object.wait(long,int)

Static Methods

create()

public static final DocumentsClient create()

Constructs an instance of DocumentsClient with default settings.

Returns

Type	Description
DocumentsClient

Exceptions

Type	Description
IOException

create(DocumentsSettings settings)

public static final DocumentsClient create(DocumentsSettings settings)

Constructs an instance of DocumentsClient, using the given settings. The channels are created based on the settings passed in, or defaults for any settings that are not set.

Parameter

Name	Description
settings	DocumentsSettings

Returns

Type	Description
DocumentsClient

Exceptions

Type	Description
IOException

create(DocumentsStub stub)

public static final DocumentsClient create(DocumentsStub stub)

Constructs an instance of DocumentsClient, using the given stub for making calls. This is for advanced usage - prefer using create(DocumentsSettings).

Parameter

Name	Description
stub	DocumentsStub

Returns

Type	Description
DocumentsClient

Constructors

DocumentsClient(DocumentsSettings settings)

protected DocumentsClient(DocumentsSettings settings)

Constructs an instance of DocumentsClient, using the given settings. This is protected so that it is easy to make a subclass, but otherwise, the static factory methods should be preferred.

Parameter

Name	Description
settings	DocumentsSettings

DocumentsClient(DocumentsStub stub)

protected DocumentsClient(DocumentsStub stub)

Parameter

Name	Description
stub	DocumentsStub

Methods

awaitTermination(long duration, TimeUnit unit)

public boolean awaitTermination(long duration, TimeUnit unit)

Parameters

Name	Description
duration	long
unit	TimeUnit

Returns

Type	Description
boolean

Exceptions

Type	Description
InterruptedException

close()

public final void close()

createDocumentAsync(CreateDocumentRequest request)

public final OperationFuture<Document,KnowledgeOperationMetadata> createDocumentAsync(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

Sample code:

 try (DocumentsClient documentsClient = DocumentsClient.create()) {
   CreateDocumentRequest request =
       CreateDocumentRequest.newBuilder()
           .setParent(
               KnowledgeBaseName.ofProjectKnowledgeBaseName("[PROJECT]", "[KNOWLEDGE_BASE]")
                   .toString())
           .setDocument(Document.newBuilder().build())
           .build();
   Document response = documentsClient.createDocumentAsync(request).get();
 }
 

Parameter

Name	Description
request	CreateDocumentRequest The request object containing all of the parameters for the API call.

Returns

Type	Description
OperationFuture<Document,KnowledgeOperationMetadata>

createDocumentAsync(KnowledgeBaseName parent, Document document)

public final OperationFuture<Document,KnowledgeOperationMetadata> createDocumentAsync(KnowledgeBaseName parent, Document document)

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

Sample code:

 try (DocumentsClient documentsClient = DocumentsClient.create()) {
   KnowledgeBaseName parent =
       KnowledgeBaseName.ofProjectKnowledgeBaseName("[PROJECT]", "[KNOWLEDGE_BASE]");
   Document document = Document.newBuilder().build();
   Document response = documentsClient.createDocumentAsync(parent, document).get();
 }
 

Parameters

Name	Description
parent	KnowledgeBaseName Required. The knowledge base to create a document for. Format: projects/<Project ID>/locations/<Location ID>/knowledgeBases/<Knowledge Base ID>.
document	Document Required. The document to create.

Returns

Type	Description
OperationFuture<Document,KnowledgeOperationMetadata>

createDocumentAsync(String parent, Document document)

public final OperationFuture<Document,KnowledgeOperationMetadata> createDocumentAsync(String parent, Document document)

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

Sample code:

 try (DocumentsClient documentsClient = DocumentsClient.create()) {
   String parent =
       KnowledgeBaseName.ofProjectKnowledgeBaseName("[PROJECT]", "[KNOWLEDGE_BASE]").toString();
   Document document = Document.newBuilder().build();
   Document response = documentsClient.createDocumentAsync(parent, document).get();
 }
 

Parameters

Name	Description
parent	String Required. The knowledge base to create a document for. Format: projects/<Project ID>/locations/<Location ID>/knowledgeBases/<Knowledge Base ID>.
document	Document Required. The document to create.

Returns

Type	Description
OperationFuture<Document,KnowledgeOperationMetadata>

createDocumentCallable()

public final UnaryCallable<CreateDocumentRequest,Operation> createDocumentCallable()

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

Sample code:

 try (DocumentsClient documentsClient = DocumentsClient.create()) {
   CreateDocumentRequest request =
       CreateDocumentRequest.newBuilder()
           .setParent(
               KnowledgeBaseName.ofProjectKnowledgeBaseName("[PROJECT]", "[KNOWLEDGE_BASE]")
                   .toString())
           .setDocument(Document.newBuilder().build())
           .build();
   ApiFuture<Operation> future = documentsClient.createDocumentCallable().futureCall(request);
   // Do something.
   Operation response = future.get();
 }
 

Returns

Type	Description
UnaryCallable<CreateDocumentRequest,Operation>

createDocumentOperationCallable()

public final OperationCallable<CreateDocumentRequest,Document,KnowledgeOperationMetadata> createDocumentOperationCallable()

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

Sample code:

 try (DocumentsClient documentsClient = DocumentsClient.create()) {
   CreateDocumentRequest request =
       CreateDocumentRequest.newBuilder()
           .setParent(
               KnowledgeBaseName.ofProjectKnowledgeBaseName("[PROJECT]", "[KNOWLEDGE_BASE]")
                   .toString())
           .setDocument(Document.newBuilder().build())
           .build();
   OperationFuture<Document, KnowledgeOperationMetadata> future =
       documentsClient.createDocumentOperationCallable().futureCall(request);
   // Do something.
   Document response = future.get();
 }
 

Returns

Type	Description
OperationCallable<CreateDocumentRequest,Document,KnowledgeOperationMetadata>

deleteDocumentAsync(DeleteDocumentRequest request)

public final OperationFuture<Empty,KnowledgeOperationMetadata> deleteDocumentAsync(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

Sample code:

 try (DocumentsClient documentsClient = DocumentsClient.create()) {
   DeleteDocumentRequest request =
       DeleteDocumentRequest.newBuilder()
           .setName(
               DocumentName.ofProjectKnowledgeBaseDocumentName(
                       "[PROJECT]", "[KNOWLEDGE_BASE]", "[DOCUMENT]")
                   .toString())
           .build();
   documentsClient.deleteDocumentAsync(request).get();
 }
 

Parameter

Name	Description
request	DeleteDocumentRequest The request object containing all of the parameters for the API call.

Returns

Type	Description
OperationFuture<Empty,KnowledgeOperationMetadata>

deleteDocumentAsync(DocumentName name)

public final OperationFuture<Empty,KnowledgeOperationMetadata> deleteDocumentAsync(DocumentName name)

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

Sample code:

 try (DocumentsClient documentsClient = DocumentsClient.create()) {
   DocumentName name =
       DocumentName.ofProjectKnowledgeBaseDocumentName(
           "[PROJECT]", "[KNOWLEDGE_BASE]", "[DOCUMENT]");
   documentsClient.deleteDocumentAsync(name).get();
 }
 

Parameter

Name	Description
name	DocumentName Required. The name of the document to delete. Format: projects/<Project ID>/locations/<Location ID>/knowledgeBases/<Knowledge Base ID>/documents/<Document ID>.

Returns

Type	Description
OperationFuture<Empty,KnowledgeOperationMetadata>

deleteDocumentAsync(String name)

public final OperationFuture<Empty,KnowledgeOperationMetadata> deleteDocumentAsync(String name)

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

Sample code:

 try (DocumentsClient documentsClient = DocumentsClient.create()) {
   String name =
       DocumentName.ofProjectKnowledgeBaseDocumentName(
               "[PROJECT]", "[KNOWLEDGE_BASE]", "[DOCUMENT]")
           .toString();
   documentsClient.deleteDocumentAsync(name).get();
 }
 

Parameter

Name	Description
name	String Required. The name of the document to delete. Format: projects/<Project ID>/locations/<Location ID>/knowledgeBases/<Knowledge Base ID>/documents/<Document ID>.

Returns

Type	Description
OperationFuture<Empty,KnowledgeOperationMetadata>

deleteDocumentCallable()

public final UnaryCallable<DeleteDocumentRequest,Operation> deleteDocumentCallable()

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

Sample code:

 try (DocumentsClient documentsClient = DocumentsClient.create()) {
   DeleteDocumentRequest request =
       DeleteDocumentRequest.newBuilder()
           .setName(
               DocumentName.ofProjectKnowledgeBaseDocumentName(
                       "[PROJECT]", "[KNOWLEDGE_BASE]", "[DOCUMENT]")
                   .toString())
           .build();
   ApiFuture<Operation> future = documentsClient.deleteDocumentCallable().futureCall(request);
   // Do something.
   future.get();
 }
 

Returns

Type	Description
UnaryCallable<DeleteDocumentRequest,Operation>

deleteDocumentOperationCallable()

public final OperationCallable<DeleteDocumentRequest,Empty,KnowledgeOperationMetadata> deleteDocumentOperationCallable()

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

Sample code:

 try (DocumentsClient documentsClient = DocumentsClient.create()) {
   DeleteDocumentRequest request =
       DeleteDocumentRequest.newBuilder()
           .setName(
               DocumentName.ofProjectKnowledgeBaseDocumentName(
                       "[PROJECT]", "[KNOWLEDGE_BASE]", "[DOCUMENT]")
                   .toString())
           .build();
   OperationFuture<Empty, KnowledgeOperationMetadata> future =
       documentsClient.deleteDocumentOperationCallable().futureCall(request);
   // Do something.
   future.get();
 }
 

Returns

Type	Description
OperationCallable<DeleteDocumentRequest,Empty,KnowledgeOperationMetadata>

exportDocumentAsync(ExportDocumentRequest request)

public final OperationFuture<Document,KnowledgeOperationMetadata> exportDocumentAsync(ExportDocumentRequest request)

Exports a smart messaging candidate document into the specified destination.

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

- metadata: KnowledgeOperationMetadata - response: Document

Sample code:

 try (DocumentsClient documentsClient = DocumentsClient.create()) {
   ExportDocumentRequest request =
       ExportDocumentRequest.newBuilder()
           .setName(
               DocumentName.ofProjectKnowledgeBaseDocumentName(
                       "[PROJECT]", "[KNOWLEDGE_BASE]", "[DOCUMENT]")
                   .toString())
           .setExportFullContent(true)
           .setSmartMessagingPartialUpdate(true)
           .build();
   Document response = documentsClient.exportDocumentAsync(request).get();
 }
 

Parameter

Name	Description
request	ExportDocumentRequest The request object containing all of the parameters for the API call.

Returns

Type	Description
OperationFuture<Document,KnowledgeOperationMetadata>

exportDocumentCallable()

public final UnaryCallable<ExportDocumentRequest,Operation> exportDocumentCallable()

Exports a smart messaging candidate document into the specified destination.

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

- metadata: KnowledgeOperationMetadata - response: Document

Sample code:

 try (DocumentsClient documentsClient = DocumentsClient.create()) {
   ExportDocumentRequest request =
       ExportDocumentRequest.newBuilder()
           .setName(
               DocumentName.ofProjectKnowledgeBaseDocumentName(
                       "[PROJECT]", "[KNOWLEDGE_BASE]", "[DOCUMENT]")
                   .toString())
           .setExportFullContent(true)
           .setSmartMessagingPartialUpdate(true)
           .build();
   ApiFuture<Operation> future = documentsClient.exportDocumentCallable().futureCall(request);
   // Do something.
   Operation response = future.get();
 }
 

Returns

Type	Description
UnaryCallable<ExportDocumentRequest,Operation>

exportDocumentOperationCallable()

public final OperationCallable<ExportDocumentRequest,Document,KnowledgeOperationMetadata> exportDocumentOperationCallable()

Exports a smart messaging candidate document into the specified destination.

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

- metadata: KnowledgeOperationMetadata - response: Document

Sample code:

 try (DocumentsClient documentsClient = DocumentsClient.create()) {
   ExportDocumentRequest request =
       ExportDocumentRequest.newBuilder()
           .setName(
               DocumentName.ofProjectKnowledgeBaseDocumentName(
                       "[PROJECT]", "[KNOWLEDGE_BASE]", "[DOCUMENT]")
                   .toString())
           .setExportFullContent(true)
           .setSmartMessagingPartialUpdate(true)
           .build();
   OperationFuture<Document, KnowledgeOperationMetadata> future =
       documentsClient.exportDocumentOperationCallable().futureCall(request);
   // Do something.
   Document response = future.get();
 }
 

Returns

Type	Description
OperationCallable<ExportDocumentRequest,Document,KnowledgeOperationMetadata>

getDocument(DocumentName name)

public final Document getDocument(DocumentName name)

Retrieves the specified document.

Sample code:

 try (DocumentsClient documentsClient = DocumentsClient.create()) {
   DocumentName name =
       DocumentName.ofProjectKnowledgeBaseDocumentName(
           "[PROJECT]", "[KNOWLEDGE_BASE]", "[DOCUMENT]");
   Document response = documentsClient.getDocument(name);
 }
 

Parameter

Name	Description
name	DocumentName Required. The name of the document to retrieve. Format projects/<Project ID>/locations/<Location ID>/knowledgeBases/<Knowledge Base ID>/documents/<Document ID>.

Returns

Type	Description
Document

getDocument(GetDocumentRequest request)

public final Document getDocument(GetDocumentRequest request)

Retrieves the specified document.

Sample code:

 try (DocumentsClient documentsClient = DocumentsClient.create()) {
   GetDocumentRequest request =
       GetDocumentRequest.newBuilder()
           .setName(
               DocumentName.ofProjectKnowledgeBaseDocumentName(
                       "[PROJECT]", "[KNOWLEDGE_BASE]", "[DOCUMENT]")
                   .toString())
           .build();
   Document response = documentsClient.getDocument(request);
 }
 

Parameter

Name	Description
request	GetDocumentRequest The request object containing all of the parameters for the API call.

Returns

Type	Description
Document

getDocument(String name)

public final Document getDocument(String name)

Retrieves the specified document.

Sample code:

 try (DocumentsClient documentsClient = DocumentsClient.create()) {
   String name =
       DocumentName.ofProjectKnowledgeBaseDocumentName(
               "[PROJECT]", "[KNOWLEDGE_BASE]", "[DOCUMENT]")
           .toString();
   Document response = documentsClient.getDocument(name);
 }
 

Parameter

Name	Description
name	String Required. The name of the document to retrieve. Format projects/<Project ID>/locations/<Location ID>/knowledgeBases/<Knowledge Base ID>/documents/<Document ID>.

Returns

Type	Description
Document

getDocumentCallable()

public final UnaryCallable<GetDocumentRequest,Document> getDocumentCallable()

Retrieves the specified document.

Sample code:

 try (DocumentsClient documentsClient = DocumentsClient.create()) {
   GetDocumentRequest request =
       GetDocumentRequest.newBuilder()
           .setName(
               DocumentName.ofProjectKnowledgeBaseDocumentName(
                       "[PROJECT]", "[KNOWLEDGE_BASE]", "[DOCUMENT]")
                   .toString())
           .build();
   ApiFuture<Document> future = documentsClient.getDocumentCallable().futureCall(request);
   // Do something.
   Document response = future.get();
 }
 

Returns

Type	Description
UnaryCallable<GetDocumentRequest,Document>

getOperationsClient()

public final OperationsClient getOperationsClient()

Returns the OperationsClient that can be used to query the status of a long-running operation returned by another API method call.

Returns

Type	Description
OperationsClient

getSettings()

public final DocumentsSettings getSettings()

Returns

Type	Description
DocumentsSettings

getStub()

public DocumentsStub getStub()

Returns

Type	Description
DocumentsStub

importDocumentsAsync(ImportDocumentsRequest request)

public final OperationFuture<ImportDocumentsResponse,KnowledgeOperationMetadata> importDocumentsAsync(ImportDocumentsRequest request)

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. The returned Operation type has the following method-specific fields:

- metadata: KnowledgeOperationMetadata - response: ImportDocumentsResponse

Sample code:

 try (DocumentsClient documentsClient = DocumentsClient.create()) {
   ImportDocumentsRequest request =
       ImportDocumentsRequest.newBuilder()
           .setParent(
               KnowledgeBaseName.ofProjectKnowledgeBaseName("[PROJECT]", "[KNOWLEDGE_BASE]")
                   .toString())
           .setDocumentTemplate(ImportDocumentTemplate.newBuilder().build())
           .setImportGcsCustomMetadata(true)
           .build();
   ImportDocumentsResponse response = documentsClient.importDocumentsAsync(request).get();
 }
 

Parameter

Name	Description
request	ImportDocumentsRequest The request object containing all of the parameters for the API call.

Returns

Type	Description
OperationFuture<ImportDocumentsResponse,KnowledgeOperationMetadata>

importDocumentsCallable()

public final UnaryCallable<ImportDocumentsRequest,Operation> importDocumentsCallable()

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. The returned Operation type has the following method-specific fields:

- metadata: KnowledgeOperationMetadata - response: ImportDocumentsResponse

Sample code:

 try (DocumentsClient documentsClient = DocumentsClient.create()) {
   ImportDocumentsRequest request =
       ImportDocumentsRequest.newBuilder()
           .setParent(
               KnowledgeBaseName.ofProjectKnowledgeBaseName("[PROJECT]", "[KNOWLEDGE_BASE]")
                   .toString())
           .setDocumentTemplate(ImportDocumentTemplate.newBuilder().build())
           .setImportGcsCustomMetadata(true)
           .build();
   ApiFuture<Operation> future = documentsClient.importDocumentsCallable().futureCall(request);
   // Do something.
   Operation response = future.get();
 }
 

Returns

Type	Description
UnaryCallable<ImportDocumentsRequest,Operation>

importDocumentsOperationCallable()

public final OperationCallable<ImportDocumentsRequest,ImportDocumentsResponse,KnowledgeOperationMetadata> importDocumentsOperationCallable()

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. The returned Operation type has the following method-specific fields:

- metadata: KnowledgeOperationMetadata - response: ImportDocumentsResponse

Sample code:

 try (DocumentsClient documentsClient = DocumentsClient.create()) {
   ImportDocumentsRequest request =
       ImportDocumentsRequest.newBuilder()
           .setParent(
               KnowledgeBaseName.ofProjectKnowledgeBaseName("[PROJECT]", "[KNOWLEDGE_BASE]")
                   .toString())
           .setDocumentTemplate(ImportDocumentTemplate.newBuilder().build())
           .setImportGcsCustomMetadata(true)
           .build();
   OperationFuture<ImportDocumentsResponse, KnowledgeOperationMetadata> future =
       documentsClient.importDocumentsOperationCallable().futureCall(request);
   // Do something.
   ImportDocumentsResponse response = future.get();
 }
 

Returns

Type	Description
OperationCallable<ImportDocumentsRequest,ImportDocumentsResponse,KnowledgeOperationMetadata>

isShutdown()

public boolean isShutdown()

Returns

Type	Description
boolean

isTerminated()

public boolean isTerminated()

Returns

Type	Description
boolean

listDocuments(KnowledgeBaseName parent)

public final DocumentsClient.ListDocumentsPagedResponse listDocuments(KnowledgeBaseName parent)

Returns the list of all documents of the knowledge base.

Sample code:

 try (DocumentsClient documentsClient = DocumentsClient.create()) {
   KnowledgeBaseName parent =
       KnowledgeBaseName.ofProjectKnowledgeBaseName("[PROJECT]", "[KNOWLEDGE_BASE]");
   for (Document element : documentsClient.listDocuments(parent).iterateAll()) {
     // doThingsWith(element);
   }
 }
 

Parameter

Name	Description
parent	KnowledgeBaseName Required. The knowledge base to list all documents for. Format: projects/<Project ID>/locations/<Location ID>/knowledgeBases/<Knowledge Base ID>.

Returns

Type	Description
DocumentsClient.ListDocumentsPagedResponse

listDocuments(ListDocumentsRequest request)

public final DocumentsClient.ListDocumentsPagedResponse listDocuments(ListDocumentsRequest request)

Returns the list of all documents of the knowledge base.

Sample code:

 try (DocumentsClient documentsClient = DocumentsClient.create()) {
   ListDocumentsRequest request =
       ListDocumentsRequest.newBuilder()
           .setParent(
               KnowledgeBaseName.ofProjectKnowledgeBaseName("[PROJECT]", "[KNOWLEDGE_BASE]")
                   .toString())
           .setPageSize(883849137)
           .setPageToken("pageToken873572522")
           .setFilter("filter-1274492040")
           .build();
   for (Document element : documentsClient.listDocuments(request).iterateAll()) {
     // doThingsWith(element);
   }
 }
 

Parameter

Name	Description
request	ListDocumentsRequest The request object containing all of the parameters for the API call.

Returns

Type	Description
DocumentsClient.ListDocumentsPagedResponse

listDocuments(String parent)

public final DocumentsClient.ListDocumentsPagedResponse listDocuments(String parent)

Returns the list of all documents of the knowledge base.

Sample code:

 try (DocumentsClient documentsClient = DocumentsClient.create()) {
   String parent =
       KnowledgeBaseName.ofProjectKnowledgeBaseName("[PROJECT]", "[KNOWLEDGE_BASE]").toString();
   for (Document element : documentsClient.listDocuments(parent).iterateAll()) {
     // doThingsWith(element);
   }
 }
 

Parameter

Name	Description
parent	String Required. The knowledge base to list all documents for. Format: projects/<Project ID>/locations/<Location ID>/knowledgeBases/<Knowledge Base ID>.

Returns

Type	Description
DocumentsClient.ListDocumentsPagedResponse

listDocumentsCallable()

public final UnaryCallable<ListDocumentsRequest,ListDocumentsResponse> listDocumentsCallable()

Returns the list of all documents of the knowledge base.

Sample code:

 try (DocumentsClient documentsClient = DocumentsClient.create()) {
   ListDocumentsRequest request =
       ListDocumentsRequest.newBuilder()
           .setParent(
               KnowledgeBaseName.ofProjectKnowledgeBaseName("[PROJECT]", "[KNOWLEDGE_BASE]")
                   .toString())
           .setPageSize(883849137)
           .setPageToken("pageToken873572522")
           .setFilter("filter-1274492040")
           .build();
   while (true) {
     ListDocumentsResponse response = documentsClient.listDocumentsCallable().call(request);
     for (Document element : response.getResponsesList()) {
       // doThingsWith(element);
     }
     String nextPageToken = response.getNextPageToken();
     if (!Strings.isNullOrEmpty(nextPageToken)) {
       request = request.toBuilder().setPageToken(nextPageToken).build();
     } else {
       break;
     }
   }
 }
 

Returns

Type	Description
UnaryCallable<ListDocumentsRequest,ListDocumentsResponse>

listDocumentsPagedCallable()

public final UnaryCallable<ListDocumentsRequest,DocumentsClient.ListDocumentsPagedResponse> listDocumentsPagedCallable()

Returns the list of all documents of the knowledge base.

Sample code:

 try (DocumentsClient documentsClient = DocumentsClient.create()) {
   ListDocumentsRequest request =
       ListDocumentsRequest.newBuilder()
           .setParent(
               KnowledgeBaseName.ofProjectKnowledgeBaseName("[PROJECT]", "[KNOWLEDGE_BASE]")
                   .toString())
           .setPageSize(883849137)
           .setPageToken("pageToken873572522")
           .setFilter("filter-1274492040")
           .build();
   ApiFuture<Document> future = documentsClient.listDocumentsPagedCallable().futureCall(request);
   // Do something.
   for (Document element : future.get().iterateAll()) {
     // doThingsWith(element);
   }
 }
 

Returns

Type	Description
UnaryCallable<ListDocumentsRequest,ListDocumentsPagedResponse>

reloadDocumentAsync(DocumentName name, String contentUri)

public final OperationFuture<Document,KnowledgeOperationMetadata> reloadDocumentAsync(DocumentName name, String contentUri)

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. 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.

Sample code:

 try (DocumentsClient documentsClient = DocumentsClient.create()) {
   DocumentName name =
       DocumentName.ofProjectKnowledgeBaseDocumentName(
           "[PROJECT]", "[KNOWLEDGE_BASE]", "[DOCUMENT]");
   String contentUri = "contentUri264542771";
   Document response = documentsClient.reloadDocumentAsync(name, contentUri).get();
 }
 

Parameters

Name	Description
name	DocumentName Required. The name of the document to reload. Format: projects/<Project ID>/locations/<Location ID>/knowledgeBases/<Knowledge Base ID>/documents/<Document ID>
contentUri	String Optional. The path of gcs source file for reloading document content. For now, only gcs uri is supported. For documents stored in Google Cloud Storage, these URIs must have the form gs://<bucket-name>/<object-name>.

Returns

Type	Description
OperationFuture<Document,KnowledgeOperationMetadata>

reloadDocumentAsync(ReloadDocumentRequest request)

public final OperationFuture<Document,KnowledgeOperationMetadata> reloadDocumentAsync(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.

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.

Sample code:

 try (DocumentsClient documentsClient = DocumentsClient.create()) {
   ReloadDocumentRequest request =
       ReloadDocumentRequest.newBuilder()
           .setName(
               DocumentName.ofProjectKnowledgeBaseDocumentName(
                       "[PROJECT]", "[KNOWLEDGE_BASE]", "[DOCUMENT]")
                   .toString())
           .setImportGcsCustomMetadata(true)
           .setSmartMessagingPartialUpdate(true)
           .build();
   Document response = documentsClient.reloadDocumentAsync(request).get();
 }
 

Parameter

Name	Description
request	ReloadDocumentRequest The request object containing all of the parameters for the API call.

Returns

Type	Description
OperationFuture<Document,KnowledgeOperationMetadata>

reloadDocumentAsync(String name, String contentUri)

public final OperationFuture<Document,KnowledgeOperationMetadata> reloadDocumentAsync(String name, String contentUri)

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. 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.

Sample code:

 try (DocumentsClient documentsClient = DocumentsClient.create()) {
   String name =
       DocumentName.ofProjectKnowledgeBaseDocumentName(
               "[PROJECT]", "[KNOWLEDGE_BASE]", "[DOCUMENT]")
           .toString();
   String contentUri = "contentUri264542771";
   Document response = documentsClient.reloadDocumentAsync(name, contentUri).get();
 }
 

Parameters

Name	Description
name	String Required. The name of the document to reload. Format: projects/<Project ID>/locations/<Location ID>/knowledgeBases/<Knowledge Base ID>/documents/<Document ID>
contentUri	String Optional. The path of gcs source file for reloading document content. For now, only gcs uri is supported. For documents stored in Google Cloud Storage, these URIs must have the form gs://<bucket-name>/<object-name>.

Returns

Type	Description
OperationFuture<Document,KnowledgeOperationMetadata>

reloadDocumentCallable()

public final UnaryCallable<ReloadDocumentRequest,Operation> reloadDocumentCallable()

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. 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.

Sample code:

 try (DocumentsClient documentsClient = DocumentsClient.create()) {
   ReloadDocumentRequest request =
       ReloadDocumentRequest.newBuilder()
           .setName(
               DocumentName.ofProjectKnowledgeBaseDocumentName(
                       "[PROJECT]", "[KNOWLEDGE_BASE]", "[DOCUMENT]")
                   .toString())
           .setImportGcsCustomMetadata(true)
           .setSmartMessagingPartialUpdate(true)
           .build();
   ApiFuture<Operation> future = documentsClient.reloadDocumentCallable().futureCall(request);
   // Do something.
   Operation response = future.get();
 }
 

Returns

Type	Description
UnaryCallable<ReloadDocumentRequest,Operation>

reloadDocumentOperationCallable()

public final OperationCallable<ReloadDocumentRequest,Document,KnowledgeOperationMetadata> reloadDocumentOperationCallable()

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. 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.

Sample code:

 try (DocumentsClient documentsClient = DocumentsClient.create()) {
   ReloadDocumentRequest request =
       ReloadDocumentRequest.newBuilder()
           .setName(
               DocumentName.ofProjectKnowledgeBaseDocumentName(
                       "[PROJECT]", "[KNOWLEDGE_BASE]", "[DOCUMENT]")
                   .toString())
           .setImportGcsCustomMetadata(true)
           .setSmartMessagingPartialUpdate(true)
           .build();
   OperationFuture<Document, KnowledgeOperationMetadata> future =
       documentsClient.reloadDocumentOperationCallable().futureCall(request);
   // Do something.
   Document response = future.get();
 }
 

Returns

Type	Description
OperationCallable<ReloadDocumentRequest,Document,KnowledgeOperationMetadata>

shutdown()

public void shutdown()

shutdownNow()

public void shutdownNow()

updateDocumentAsync(Document document, FieldMask updateMask)

public final OperationFuture<Document,KnowledgeOperationMetadata> updateDocumentAsync(Document document, FieldMask updateMask)

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

Sample code:

 try (DocumentsClient documentsClient = DocumentsClient.create()) {
   Document document = Document.newBuilder().build();
   FieldMask updateMask = FieldMask.newBuilder().build();
   Document response = documentsClient.updateDocumentAsync(document, updateMask).get();
 }
 

Parameters

Name	Description
document	Document Required. The document to update.
updateMask	FieldMask Optional. Not specified means update all. Currently, only display_name can be updated, an InvalidArgument will be returned for attempting to update other fields.

Returns

Type	Description
OperationFuture<Document,KnowledgeOperationMetadata>

updateDocumentAsync(UpdateDocumentRequest request)

public final OperationFuture<Document,KnowledgeOperationMetadata> updateDocumentAsync(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

Sample code:

 try (DocumentsClient documentsClient = DocumentsClient.create()) {
   UpdateDocumentRequest request =
       UpdateDocumentRequest.newBuilder()
           .setDocument(Document.newBuilder().build())
           .setUpdateMask(FieldMask.newBuilder().build())
           .build();
   Document response = documentsClient.updateDocumentAsync(request).get();
 }
 

Parameter

Name	Description
request	UpdateDocumentRequest The request object containing all of the parameters for the API call.

Returns

Type	Description
OperationFuture<Document,KnowledgeOperationMetadata>

updateDocumentCallable()

public final UnaryCallable<UpdateDocumentRequest,Operation> updateDocumentCallable()

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

Sample code:

 try (DocumentsClient documentsClient = DocumentsClient.create()) {
   UpdateDocumentRequest request =
       UpdateDocumentRequest.newBuilder()
           .setDocument(Document.newBuilder().build())
           .setUpdateMask(FieldMask.newBuilder().build())
           .build();
   ApiFuture<Operation> future = documentsClient.updateDocumentCallable().futureCall(request);
   // Do something.
   Operation response = future.get();
 }
 

Returns

Type	Description
UnaryCallable<UpdateDocumentRequest,Operation>

updateDocumentOperationCallable()

public final OperationCallable<UpdateDocumentRequest,Document,KnowledgeOperationMetadata> updateDocumentOperationCallable()

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

Sample code:

 try (DocumentsClient documentsClient = DocumentsClient.create()) {
   UpdateDocumentRequest request =
       UpdateDocumentRequest.newBuilder()
           .setDocument(Document.newBuilder().build())
           .setUpdateMask(FieldMask.newBuilder().build())
           .build();
   OperationFuture<Document, KnowledgeOperationMetadata> future =
       documentsClient.updateDocumentOperationCallable().futureCall(request);
   // Do something.
   Document response = future.get();
 }
 

Returns

Type	Description
OperationCallable<UpdateDocumentRequest,Document,KnowledgeOperationMetadata>