2024-09-12
▼ ▲ documentai.projects.operations.get
Path : v1beta2/{+name}
Description : Gets the latest state of a long-running operation. Clients can use this method to poll the operation result at intervals as recommended by the API service.
Parameter Order : name
Flat Path : v1beta2/projects/{projectsId}/operations/{operationsId}
Scopes : https://www.googleapis.com/auth/cloud-platform
Parameters :
name
Location : path
Pattern : ^projects/[^/]+/operations/[^/]+$
Description : The name of the operation resource.
Type : string
Required : Yes
HTTP Method : GET
▼ ▲ documentai.projects.locations.documents.batchProcess
Scopes : https://www.googleapis.com/auth/cloud-platform
Path : v1beta2/{+parent}/documents:batchProcess
Description : LRO endpoint to batch process many documents. The output is written to Cloud Storage as JSON in the [Document] format.
Flat Path : v1beta2/projects/{projectsId}/locations/{locationsId}/documents:batchProcess
Parameters :
parent
Description : Target project and location to make a call. Format: `projects/{project-id}/locations/{location-id}`. If no location is specified, a region will be chosen automatically.
Required : Yes
Pattern : ^projects/[^/]+/locations/[^/]+$
Location : path
Type : string
Parameter Order : parent
HTTP Method : POST
▼ ▲ documentai.projects.locations.documents.process
Scopes : https://www.googleapis.com/auth/cloud-platform
Parameter Order : parent
Parameters :
parent
Location : path
Type : string
Pattern : ^projects/[^/]+/locations/[^/]+$
Required : Yes
Description : Target project and location to make a call. Format: `projects/{project-id}/locations/{location-id}`. If no location is specified, a region will be chosen automatically. This field is only populated when used in ProcessDocument method.
HTTP Method : POST
Description : Processes a single document.
Flat Path : v1beta2/projects/{projectsId}/locations/{locationsId}/documents:process
Path : v1beta2/{+parent}/documents:process
▼ ▲ documentai.projects.locations.operations.get
Path : v1beta2/{+name}
Flat Path : v1beta2/projects/{projectsId}/locations/{locationsId}/operations/{operationsId}
Scopes : https://www.googleapis.com/auth/cloud-platform
Description : Gets the latest state of a long-running operation. Clients can use this method to poll the operation result at intervals as recommended by the API service.
Parameter Order : name
HTTP Method : GET
Parameters :
name
Required : Yes
Description : The name of the operation resource.
Location : path
Type : string
Pattern : ^projects/[^/]+/locations/[^/]+/operations/[^/]+$
▼ ▲ documentai.projects.documents.process
Parameter Order : parent
Parameters :
parent
Location : path
Required : Yes
Description : Target project and location to make a call. Format: `projects/{project-id}/locations/{location-id}`. If no location is specified, a region will be chosen automatically. This field is only populated when used in ProcessDocument method.
Pattern : ^projects/[^/]+$
Type : string
HTTP Method : POST
Path : v1beta2/{+parent}/documents:process
Scopes : https://www.googleapis.com/auth/cloud-platform
Flat Path : v1beta2/projects/{projectsId}/documents:process
Description : Processes a single document.
▼ ▲ documentai.projects.documents.batchProcess
Parameters :
parent
Description : Target project and location to make a call. Format: `projects/{project-id}/locations/{location-id}`. If no location is specified, a region will be chosen automatically.
Location : path
Required : Yes
Type : string
Pattern : ^projects/[^/]+$
Scopes : https://www.googleapis.com/auth/cloud-platform
Description : LRO endpoint to batch process many documents. The output is written to Cloud Storage as JSON in the [Document] format.
Path : v1beta2/{+parent}/documents:batchProcess
Flat Path : v1beta2/projects/{projectsId}/documents:batchProcess
HTTP Method : POST
Parameter Order : parent