- 4.53.0 (latest)
- 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:
- 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.
- 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.
- 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.
Implements
BackgroundResourceConstructors
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.
Name | Description |
settings | DocumentsSettings |
DocumentsClient(DocumentsStub stub)
protected DocumentsClient(DocumentsStub stub)
Name | Description |
stub | DocumentsStub |
Methods
awaitTermination(long duration, TimeUnit unit)
public boolean awaitTermination(long duration, TimeUnit unit)
Name | Description |
duration | long |
unit | TimeUnit |
Type | Description |
boolean |
Type | Description |
InterruptedException |
close()
public final void close()
create()
public static final DocumentsClient create()
Constructs an instance of DocumentsClient with default settings.
Type | Description |
DocumentsClient |
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.
Name | Description |
settings | DocumentsSettings |
Type | Description |
DocumentsClient |
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).
Name | Description |
stub | DocumentsStub |
Type | Description |
DocumentsClient |
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
Note: The projects.agent.knowledgeBases.documents
resource is deprecated; only use
projects.knowledgeBases.documents
.
Sample code:
try (DocumentsClient documentsClient = DocumentsClient.create()) {
CreateDocumentRequest request =
CreateDocumentRequest.newBuilder()
.setParent(
KnowledgeBaseName.ofProjectKnowledgeBaseName("[PROJECT]", "[KNOWLEDGE_BASE]")
.toString())
.setDocument(Document.newBuilder().build())
.setImportGcsCustomMetadata(true)
.build();
Document response = documentsClient.createDocumentAsync(request).get();
}
Name | Description |
request | CreateDocumentRequest The request object containing all of the parameters for the API call. |
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
Note: The projects.agent.knowledgeBases.documents
resource is deprecated; only use
projects.knowledgeBases.documents
.
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();
}
Name | Description |
parent | KnowledgeBaseName Required. The knowledge base to create a document for. Format:
|
document | Document Required. The document to create. |
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
Note: The projects.agent.knowledgeBases.documents
resource is deprecated; only use
projects.knowledgeBases.documents
.
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();
}
Name | Description |
parent | String Required. The knowledge base to create a document for. Format:
|
document | Document Required. The document to create. |
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
Note: The projects.agent.knowledgeBases.documents
resource is deprecated; only use
projects.knowledgeBases.documents
.
Sample code:
try (DocumentsClient documentsClient = DocumentsClient.create()) {
CreateDocumentRequest request =
CreateDocumentRequest.newBuilder()
.setParent(
KnowledgeBaseName.ofProjectKnowledgeBaseName("[PROJECT]", "[KNOWLEDGE_BASE]")
.toString())
.setDocument(Document.newBuilder().build())
.setImportGcsCustomMetadata(true)
.build();
ApiFuture
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
Note: The projects.agent.knowledgeBases.documents
resource is deprecated; only use
projects.knowledgeBases.documents
.
Sample code:
try (DocumentsClient documentsClient = DocumentsClient.create()) {
CreateDocumentRequest request =
CreateDocumentRequest.newBuilder()
.setParent(
KnowledgeBaseName.ofProjectKnowledgeBaseName("[PROJECT]", "[KNOWLEDGE_BASE]")
.toString())
.setDocument(Document.newBuilder().build())
.setImportGcsCustomMetadata(true)
.build();
OperationFuture
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
Note: The projects.agent.knowledgeBases.documents
resource is deprecated; only use
projects.knowledgeBases.documents
.
Sample code:
try (DocumentsClient documentsClient = DocumentsClient.create()) {
DeleteDocumentRequest request =
DeleteDocumentRequest.newBuilder()
.setName(
DocumentName.ofProjectKnowledgeBaseDocumentName(
"[PROJECT]", "[KNOWLEDGE_BASE]", "[DOCUMENT]")
.toString())
.build();
documentsClient.deleteDocumentAsync(request).get();
}
Name | Description |
request | DeleteDocumentRequest The request object containing all of the parameters for the API call. |
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
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]");
documentsClient.deleteDocumentAsync(name).get();
}
Name | Description |
name | DocumentName Required. The name of the document to delete. Format: |
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
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();
documentsClient.deleteDocumentAsync(name).get();
}
Name | Description |
name | String Required. The name of the document to delete. Format: |
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
Note: The projects.agent.knowledgeBases.documents
resource is deprecated; only use
projects.knowledgeBases.documents
.
Sample code:
try (DocumentsClient documentsClient = DocumentsClient.create()) {
DeleteDocumentRequest request =
DeleteDocumentRequest.newBuilder()
.setName(
DocumentName.ofProjectKnowledgeBaseDocumentName(
"[PROJECT]", "[KNOWLEDGE_BASE]", "[DOCUMENT]")
.toString())
.build();
ApiFuture
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
Note: The projects.agent.knowledgeBases.documents
resource is deprecated; only use
projects.knowledgeBases.documents
.
Sample code:
try (DocumentsClient documentsClient = DocumentsClient.create()) {
DeleteDocumentRequest request =
DeleteDocumentRequest.newBuilder()
.setName(
DocumentName.ofProjectKnowledgeBaseDocumentName(
"[PROJECT]", "[KNOWLEDGE_BASE]", "[DOCUMENT]")
.toString())
.build();
OperationFuture
Type | Description |
OperationCallable<DeleteDocumentRequest,Empty,KnowledgeOperationMetadata> |
getDocument(DocumentName name)
public final Document getDocument(DocumentName name)
Retrieves the specified 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]");
Document response = documentsClient.getDocument(name);
}
Name | Description |
name | DocumentName Required. The name of the document to retrieve. Format |
Type | Description |
Document |
getDocument(GetDocumentRequest request)
public final Document getDocument(GetDocumentRequest request)
Retrieves the specified document.
Note: The projects.agent.knowledgeBases.documents
resource is deprecated; only use
projects.knowledgeBases.documents
.
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);
}
Name | Description |
request | GetDocumentRequest The request object containing all of the parameters for the API call. |
Type | Description |
Document |
getDocument(String name)
public final Document getDocument(String name)
Retrieves the specified 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();
Document response = documentsClient.getDocument(name);
}
Name | Description |
name | String Required. The name of the document to retrieve. Format |
Type | Description |
Document |
getDocumentCallable()
public final UnaryCallable<GetDocumentRequest,Document> getDocumentCallable()
Retrieves the specified document.
Note: The projects.agent.knowledgeBases.documents
resource is deprecated; only use
projects.knowledgeBases.documents
.
Sample code:
try (DocumentsClient documentsClient = DocumentsClient.create()) {
GetDocumentRequest request =
GetDocumentRequest.newBuilder()
.setName(
DocumentName.ofProjectKnowledgeBaseDocumentName(
"[PROJECT]", "[KNOWLEDGE_BASE]", "[DOCUMENT]")
.toString())
.build();
ApiFuture
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.
Type | Description |
OperationsClient |
getSettings()
public final DocumentsSettings getSettings()
Type | Description |
DocumentsSettings |
getStub()
public DocumentsStub getStub()
Type | Description |
DocumentsStub |
importDocumentsAsync(ImportDocumentsRequest request)
public final OperationFuture<ImportDocumentsResponse,KnowledgeOperationMetadata> importDocumentsAsync(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
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();
}
Name | Description |
request | ImportDocumentsRequest The request object containing all of the parameters for the API call. |
Type | Description |
OperationFuture<ImportDocumentsResponse,KnowledgeOperationMetadata> |
importDocumentsCallable()
public final UnaryCallable<ImportDocumentsRequest,Operation> importDocumentsCallable()
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
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
Type | Description |
UnaryCallable<ImportDocumentsRequest,Operation> |
importDocumentsOperationCallable()
public final OperationCallable<ImportDocumentsRequest,ImportDocumentsResponse,KnowledgeOperationMetadata> importDocumentsOperationCallable()
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
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
Type | Description |
OperationCallable<ImportDocumentsRequest,ImportDocumentsResponse,KnowledgeOperationMetadata> |
isShutdown()
public boolean isShutdown()
Type | Description |
boolean |
isTerminated()
public boolean isTerminated()
Type | Description |
boolean |
listDocuments(KnowledgeBaseName parent)
public final DocumentsClient.ListDocumentsPagedResponse listDocuments(KnowledgeBaseName parent)
Returns the list of all documents of the knowledge base.
Note: The projects.agent.knowledgeBases.documents
resource is deprecated; only use
projects.knowledgeBases.documents
.
Sample code:
try (DocumentsClient documentsClient = DocumentsClient.create()) {
KnowledgeBaseName parent =
KnowledgeBaseName.ofProjectKnowledgeBaseName("[PROJECT]", "[KNOWLEDGE_BASE]");
for (Document element : documentsClient.listDocuments(parent).iterateAll()) {
// doThingsWith(element);
}
}
Name | Description |
parent | KnowledgeBaseName Required. The knowledge base to list all documents for. Format:
|
Type | Description |
DocumentsClient.ListDocumentsPagedResponse |
listDocuments(ListDocumentsRequest request)
public final DocumentsClient.ListDocumentsPagedResponse 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
.
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);
}
}
Name | Description |
request | ListDocumentsRequest The request object containing all of the parameters for the API call. |
Type | Description |
DocumentsClient.ListDocumentsPagedResponse |
listDocuments(String parent)
public final DocumentsClient.ListDocumentsPagedResponse listDocuments(String parent)
Returns the list of all documents of the knowledge base.
Note: The projects.agent.knowledgeBases.documents
resource is deprecated; only use
projects.knowledgeBases.documents
.
Sample code:
try (DocumentsClient documentsClient = DocumentsClient.create()) {
String parent =
KnowledgeBaseName.ofProjectKnowledgeBaseName("[PROJECT]", "[KNOWLEDGE_BASE]").toString();
for (Document element : documentsClient.listDocuments(parent).iterateAll()) {
// doThingsWith(element);
}
}
Name | Description |
parent | String Required. The knowledge base to list all documents for. Format:
|
Type | Description |
DocumentsClient.ListDocumentsPagedResponse |
listDocumentsCallable()
public final UnaryCallable<ListDocumentsRequest,ListDocumentsResponse> listDocumentsCallable()
Returns the list of all documents of the knowledge base.
Note: The projects.agent.knowledgeBases.documents
resource is deprecated; only use
projects.knowledgeBases.documents
.
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;
}
}
}
Type | Description |
UnaryCallable<ListDocumentsRequest,ListDocumentsResponse> |
listDocumentsPagedCallable()
public final UnaryCallable<ListDocumentsRequest,DocumentsClient.ListDocumentsPagedResponse> listDocumentsPagedCallable()
Returns the list of all documents of the knowledge base.
Note: The projects.agent.knowledgeBases.documents
resource is deprecated; only use
projects.knowledgeBases.documents
.
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
Type | Description |
UnaryCallable<ListDocumentsRequest,ListDocumentsPagedResponse> |
reloadDocumentAsync(DocumentName name, GcsSource gcsSource)
public final OperationFuture<Document,KnowledgeOperationMetadata> reloadDocumentAsync(DocumentName name, GcsSource gcsSource)
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
.
Sample code:
try (DocumentsClient documentsClient = DocumentsClient.create()) {
DocumentName name =
DocumentName.ofProjectKnowledgeBaseDocumentName(
"[PROJECT]", "[KNOWLEDGE_BASE]", "[DOCUMENT]");
GcsSource gcsSource = GcsSource.newBuilder().build();
Document response = documentsClient.reloadDocumentAsync(name, gcsSource).get();
}
Name | Description |
name | DocumentName Required. The name of the document to reload. Format: |
gcsSource | GcsSource The path for a Cloud Storage source file for reloading document content. If not provided, the Document's existing source will be reloaded. |
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. 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
.
Sample code:
try (DocumentsClient documentsClient = DocumentsClient.create()) {
ReloadDocumentRequest request =
ReloadDocumentRequest.newBuilder()
.setName(
DocumentName.ofProjectKnowledgeBaseDocumentName(
"[PROJECT]", "[KNOWLEDGE_BASE]", "[DOCUMENT]")
.toString())
.setImportGcsCustomMetadata(true)
.build();
Document response = documentsClient.reloadDocumentAsync(request).get();
}
Name | Description |
request | ReloadDocumentRequest The request object containing all of the parameters for the API call. |
Type | Description |
OperationFuture<Document,KnowledgeOperationMetadata> |
reloadDocumentAsync(String name, GcsSource gcsSource)
public final OperationFuture<Document,KnowledgeOperationMetadata> reloadDocumentAsync(String name, GcsSource gcsSource)
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
.
Sample code:
try (DocumentsClient documentsClient = DocumentsClient.create()) {
String name =
DocumentName.ofProjectKnowledgeBaseDocumentName(
"[PROJECT]", "[KNOWLEDGE_BASE]", "[DOCUMENT]")
.toString();
GcsSource gcsSource = GcsSource.newBuilder().build();
Document response = documentsClient.reloadDocumentAsync(name, gcsSource).get();
}
Name | Description |
name | String Required. The name of the document to reload. Format: |
gcsSource | GcsSource The path for a Cloud Storage source file for reloading document content. If not provided, the Document's existing source will be reloaded. |
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. 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
.
Sample code:
try (DocumentsClient documentsClient = DocumentsClient.create()) {
ReloadDocumentRequest request =
ReloadDocumentRequest.newBuilder()
.setName(
DocumentName.ofProjectKnowledgeBaseDocumentName(
"[PROJECT]", "[KNOWLEDGE_BASE]", "[DOCUMENT]")
.toString())
.setImportGcsCustomMetadata(true)
.build();
ApiFuture
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. 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
.
Sample code:
try (DocumentsClient documentsClient = DocumentsClient.create()) {
ReloadDocumentRequest request =
ReloadDocumentRequest.newBuilder()
.setName(
DocumentName.ofProjectKnowledgeBaseDocumentName(
"[PROJECT]", "[KNOWLEDGE_BASE]", "[DOCUMENT]")
.toString())
.setImportGcsCustomMetadata(true)
.build();
OperationFuture
Type | Description |
OperationCallable<ReloadDocumentRequest,Document,KnowledgeOperationMetadata> |
shutdown()
public void shutdown()
shutdownNow()
public void shutdownNow()
updateDocumentAsync(Document document)
public final OperationFuture<Document,KnowledgeOperationMetadata> updateDocumentAsync(Document document)
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
.
Sample code:
try (DocumentsClient documentsClient = DocumentsClient.create()) {
Document document = Document.newBuilder().build();
Document response = documentsClient.updateDocumentAsync(document).get();
}
Name | Description |
document | Document Required. The document to update. |
Type | Description |
OperationFuture<Document,KnowledgeOperationMetadata> |
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
Note: The projects.agent.knowledgeBases.documents
resource is deprecated; only use
projects.knowledgeBases.documents
.
Sample code:
try (DocumentsClient documentsClient = DocumentsClient.create()) {
Document document = Document.newBuilder().build();
FieldMask updateMask = FieldMask.newBuilder().build();
Document response = documentsClient.updateDocumentAsync(document, updateMask).get();
}
Name | Description |
document | Document Required. The document to update. |
updateMask | FieldMask Optional. Not specified means |
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
Note: The projects.agent.knowledgeBases.documents
resource is deprecated; only use
projects.knowledgeBases.documents
.
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();
}
Name | Description |
request | UpdateDocumentRequest The request object containing all of the parameters for the API call. |
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
Note: The projects.agent.knowledgeBases.documents
resource is deprecated; only use
projects.knowledgeBases.documents
.
Sample code:
try (DocumentsClient documentsClient = DocumentsClient.create()) {
UpdateDocumentRequest request =
UpdateDocumentRequest.newBuilder()
.setDocument(Document.newBuilder().build())
.setUpdateMask(FieldMask.newBuilder().build())
.build();
ApiFuture
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
Note: The projects.agent.knowledgeBases.documents
resource is deprecated; only use
projects.knowledgeBases.documents
.
Sample code:
try (DocumentsClient documentsClient = DocumentsClient.create()) {
UpdateDocumentRequest request =
UpdateDocumentRequest.newBuilder()
.setDocument(Document.newBuilder().build())
.setUpdateMask(FieldMask.newBuilder().build())
.build();
OperationFuture
Type | Description |
OperationCallable<UpdateDocumentRequest,Document,KnowledgeOperationMetadata> |