This is the REST API reference for the Optical Character Recognition pre-trained API that is included with Vertex AI on Google Distributed Cloud (GDC) air-gapped. Use this guide to programmatically detect text in files and images.
Service: Optical Character Recognition (OCR)
Service endpoint
A service endpoint is a base URL that specifies the network address of an API service. One service might have multiple service endpoints. This service has the following service endpoint and URIs that are relative to this service endpoint:
https://OCR_ENDPOINT
Replace OCR_ENDPOINT with the endpoint used to access
Vertex AI OCR API.
For more information, see
View
Vertex AI service statuses and endpoints.
REST Resource: v1.files
| Methods | |
|---|---|
annotate |
POST /v1/files:annotate Service that performs image detection and annotation for a batch of files. |
REST Resource: v1.images
| Methods | |
|---|---|
annotate |
POST /v1/images:annotate Run image detection and annotation for a batch of images. |
REST Resource: v1.projects.files
| Methods | |
|---|---|
annotate |
POST /v1/{parent}/files:annotate Service that performs image detection and annotation for a batch of files. |
REST Resource: v1.projects.images
| Methods | |
|---|---|
annotate |
POST /v1/{parent}/images:annotate Run image detection and annotation for a batch of images. |
REST Resource: v1.projects.locations.files
| Methods | |
|---|---|
annotate |
POST /v1/{parent}/files:annotate Service that performs image detection and annotation for a batch of files. |
REST Resource: v1.projects.locations.images
| Methods | |
|---|---|
annotate |
POST /v1/{parent}/images:annotate Run image detection and annotation for a batch of images. |