Full name: projects.locations.processors.dataset.listDocuments
Returns a list of documents present in the dataset.
HTTP request
POST https://{endpoint}/v1beta3/{dataset}:listDocuments
Where {endpoint}
is one of the supported service endpoints.
Path parameters
Parameters | |
---|---|
dataset |
Required. The resource name of the dataset to be listed. Format: projects/{project}/locations/{location}/processors/{processor}/dataset It takes the form |
Request body
The request body contains data with the following structure:
JSON representation |
---|
{ "pageSize": integer, "pageToken": string, "filter": string, "returnTotalSize": boolean, "skip": integer } |
Fields | |
---|---|
pageSize |
The maximum number of documents to return. The service may return fewer than this value. If unspecified, at most 20 documents will be returned. The maximum value is 100; values above 100 will be coerced to 100. |
pageToken |
A page token, received from a previous When paginating, all other parameters provided to |
filter |
Optional. Query to filter the documents based on https://google.aip.dev/160.
Note: - Only |
returnTotalSize |
Optional. Controls if the request requires a total size of matched documents. See Enabling this flag may adversely impact performance. Defaults to false. |
skip |
Optional. Number of results to skip beginning from the |
Response body
If successful, the response body contains data with the following structure:
JSON representation |
---|
{
"documentMetadata": [
{
object ( |
Fields | |
---|---|
documentMetadata[] |
Document metadata corresponding to the listed documents. |
nextPageToken |
A token, which can be sent as |
totalSize |
Total count of documents queried. |
Authorization scopes
Requires the following OAuth scope:
https://www.googleapis.com/auth/cloud-platform
For more information, see the Authentication Overview.
IAM Permissions
Requires the following IAM permission on the dataset
resource:
documentai.datasets.listDocuments
For more information, see the IAM documentation.
DocumentMetadata
Metadata about a document.
JSON representation |
---|
{ "documentId": { object ( |
Fields | |
---|---|
documentId |
Document identifier. |
pageCount |
Number of pages in the document. |
datasetType |
Type of the dataset split to which the document belongs. |
labelingState |
Labeling state of the document. |
displayName |
The display name of the document. |
DocumentLabelingState
Describes the labeling status of a document.
Enums | |
---|---|
DOCUMENT_LABELING_STATE_UNSPECIFIED |
Default value if the enum is not set. |
DOCUMENT_LABELED |
Document has been labeled. |
DOCUMENT_UNLABELED |
Document has not been labeled. |
DOCUMENT_AUTO_LABELED |
Document has been auto-labeled. |