Esta página foi traduzida pela API Cloud Translation.

Detectar texto em arquivos

O serviço de reconhecimento óptico de caracteres (OCR) da Vertex AI no Google Distributed Cloud (GDC) isolado por ar detecta texto em arquivos PDF e TIFF usando os dois métodos de API a seguir:

BatchAnnotateFiles: Detectar texto com solicitações inline.
AsyncBatchAnnotateFiles: Detectar texto com solicitações off-line (assíncronas).

Nesta página, mostramos como detectar texto em arquivos usando a API OCR no Distributed Cloud.

Antes de começar

Antes de começar a usar a API OCR, é preciso ter um projeto com a API OCR ativada e as credenciais apropriadas. Também é possível instalar bibliotecas de cliente para ajudar você a fazer chamadas para a API. Para mais informações, consulte Configurar um projeto de reconhecimento de caracteres.

Detectar texto com solicitações inline

O método BatchAnnotateFiles detecta texto de um lote de arquivos PDF ou TIFF. Você envia o arquivo de onde quer detectar o texto diretamente como conteúdo na solicitação da API. O sistema retorna o texto detectado resultante no formato JSON na resposta da API.

É preciso especificar valores para os campos no corpo JSON da solicitação de API. A tabela a seguir contém uma descrição dos campos do corpo da solicitação que você precisa fornecer ao usar o método da API BatchAnnotateFiles para suas solicitações de detecção de texto:

Campos do corpo da solicitação	Descrição do campo
`content`	Os arquivos com texto a serem detectados. Você fornece a representação Base64 (string ASCII) do conteúdo do arquivo binário. Observação:só é possível processar arquivos armazenados localmente no seu ambiente do Distributed Cloud.
`mime_type`	O tipo de arquivo de origem. Defina um dos seguintes valores: `application/pdf` para arquivos PDF `image/tiff` para arquivos TIFF
`type`	O tipo de detecção de texto que você precisa do arquivo. Especifique um dos dois recursos de anotação: `TEXT_DETECTION` detecta e extrai texto de qualquer arquivo. A resposta JSON inclui a string extraída, palavras individuais e caixas delimitadoras. `DOCUMENT_TEXT_DETECTION` também extrai texto de um arquivo, mas o serviço otimiza a resposta para textos e documentos densos. O JSON inclui informações de página, bloco, parágrafo, palavra e quebra de linha. Para mais informações sobre esses recursos de anotação, consulte Recursos de reconhecimento óptico de caracteres.
`language_hints`	Opcional. Lista de idiomas a serem usados para a detecção de texto. O sistema interpreta um valor vazio para esse campo como detecção automática de idioma. Não é necessário definir o campo `language_hints` para idiomas baseados no alfabeto latino. Se você souber o idioma do texto no arquivo, definir uma dica vai melhorar os resultados. Como as dicas de idioma funcionam? O formato `language_hints` usa as seguintes diretrizes de formatação de tag de idioma `BCP 47`: `language` ["-" `script`] ["-" `region`] ("-" `variant`) ("-" `extension`) ["-" `privateuse`]. Por exemplo, a dica de idioma "`en`-`t`-`i0`-`handwrit`" especifica o idioma inglês (`en`), o singleton de extensão de transformação (`t`), o código de extensão de transformação do mecanismo de método de entrada (`i0`) e o código de transformação de escrita à mão (`handwrit`). Isso significa que o idioma é "inglês transformado da escrita à mão". Não é necessário especificar um código de script porque o idioma "`en`" implica `Latn`. Para uma lista de idiomas compatíveis, consulte Idiomas compatíveis.
`pages`	Opcional. O número de páginas do arquivo a serem processadas para detecção de texto. O número máximo de páginas que você pode especificar é cinco. Se você não especificar o número de páginas, o serviço vai processar as cinco primeiras páginas do arquivo.

Para informações sobre a representação JSON completa, consulte AnnotateFileRequest.

Fazer uma solicitação de API inline

Faça uma solicitação à API pré-treinada de OCR usando o método da API REST. Caso contrário, interaja com a API pré-treinada de OCR usando um script Python para detectar texto em arquivos PDF ou TIFF.

Os exemplos a seguir mostram como detectar texto em um arquivo usando OCR:

REST

Siga estas etapas para detectar texto em arquivos usando o método da API REST:

Salve o seguinte arquivo request.json para o corpo da solicitação:
```
cat <<- EOF > request.json
{
  "requests": [
    {
      "input_config": {
        "content": BASE64_ENCODED_FILE,
        "mime_type": "application/pdf"
      },
      "features": [
        {
          "type": "FEATURE_TYPE"
        }
      ],
      "image_context": {
        "language_hints": [
          "LANGUAGE_HINT_1",
          "LANGUAGE_HINT_2",
          ...
        ]
      },
      "pages": []
    }
  ]
}
EOF
```
Substitua:
- BASE64_ENCODED_FILE: a representação em Base64 (string ASCII) do conteúdo do arquivo binário. Essa string começa com caracteres semelhantes a /9j/4QAYRXhpZgAA...9tAVx/zDQDlGxn//2Q==.
- FEATURE_TYPE: o tipo de detecção de texto que você precisa do arquivo. Os valores permitidos são TEXT_DETECTION ou DOCUMENT_TEXT_DETECTION.
- LANGUAGE_HINT: as tags de idioma BCP 47 a serem usadas como dicas de idioma para detecção de texto, como en-t-i0-handwrit. Este campo é opcional, e o sistema interpreta um valor vazio como detecção automática de idioma.
Receber um token de autenticação.

Faça a solicitação:

curl

curl -X POST \
  -H "Authorization: Bearer TOKEN" \
  -H "x-goog-user-project: projects/PROJECT_ID" \
  -H "Content-Type: application/json; charset=utf-8" \
  -d @request.json \
  https://ENDPOINT/v1/files:annotate

Substitua:

TOKEN: o token de autenticação que você recebeu.
PROJECT_ID: o ID do projeto.
ENDPOINT: o endpoint de OCR que você usa na sua organização. Para mais informações, consulte o status do serviço e os endpoints.

PowerShell

$headers = @{
  "Authorization" = "Bearer TOKEN"
  "x-goog-user-project" = "projects/PROJECT_ID"
}

Invoke-WebRequest
  -Method POST
  -Headers $headers
  -ContentType: "application/json; charset=utf-8"
  -InFile request.json
  -Uri "ENDPOINT/v1/files:annotate" | Select-Object -Expand Content

Substitua:

TOKEN: o token de autenticação que você recebeu.
ENDPOINT: o endpoint de OCR que você usa na sua organização. Para mais informações, consulte o status do serviço e os endpoints.

Python

Siga estas etapas para usar o serviço de OCR de um script Python para detectar texto em um arquivo:

Instale a versão mais recente da biblioteca de cliente de OCR.
Defina as variáveis de ambiente necessárias em um script Python.
Autentique sua solicitação de API.

Adicione o seguinte código ao script Python que você criou:

from google.cloud import vision
import google.auth
from google.auth.transport import requests
from google.api_core.client_options import ClientOptions

audience = "https://ENDPOINT:443"
api_endpoint="ENDPOINT:443"

def vision_client(creds):
  opts = ClientOptions(api_endpoint=api_endpoint)
  return vision.ImageAnnotatorClient(credentials=creds, client_options=opts)

def main():
  creds = None
  try:
    creds, project_id = google.auth.default()
    creds = creds.with_gdch_audience(audience)
    req = requests.Request()
    creds.refresh(req)
    print("Got token: ")
    print(creds.token)
  except Exception as e:
    print("Caught exception" + str(e))
    raise e
  return creds

def vision_func(creds):
  vc = vision_client(creds)
  input_config = {"content": "BASE64_ENCODED_FILE"}
  features = [{"type_": vision.Feature.Type.FEATURE_TYPE}]
  # Each requests element corresponds to a single file. To annotate more
  # files, create a request element for each file and add it to
  # the array of requests
  req = {"input_config": input_config, "features": features}

  metadata = [("x-goog-user-project", "projects/PROJECT_ID")]

  resp = vc.annotate_file(req,metadata=metadata)

  print(resp)

if __name__=="__main__":
  creds = main()
  vision_func(creds)

Substitua:

ENDPOINT: o endpoint de OCR que você usa na sua organização. Para mais informações, consulte o status e os endpoints do serviço.
BASE64_ENCODED_FILE: a representação em Base64 (string ASCII) do conteúdo do arquivo. Essa string começa com caracteres semelhantes a /9j/4QAYRXhpZgAA...9tAVx/zDQDlGxn//2Q==.
FEATURE_TYPE: o tipo de detecção de texto que você precisa do arquivo. Os valores permitidos são TEXT_DETECTION ou DOCUMENT_TEXT_DETECTION.
PROJECT_ID: o ID do projeto.

Salve o script Python.
Execute o script Python para detectar texto no arquivo:
```
python SCRIPT_NAME
```
Substitua SCRIPT_NAME pelo nome que você deu ao script do Python, como vision.py.

Detectar texto com solicitações off-line

O método AsyncBatchAnnotateFiles detecta texto de um lote de arquivos PDF ou TIFF executando uma solicitação off-line (assíncrona). Os arquivos podem conter várias páginas e várias imagens por página. Os arquivos de origem precisam estar em um bucket de armazenamento do projeto do Distributed Cloud. O sistema salva o texto detectado resultante em formato JSON em um bucket de armazenamento.

O serviço de OCR inicia o processamento off-line e retorna o ID do processo de longa duração que realiza a detecção de texto no arquivo. Você pode usar o ID retornado para acompanhar o status do processamento off-line. Se houver muitas operações em andamento, o processamento off-line poderá não ser iniciado imediatamente.

É preciso especificar valores para os campos no corpo JSON da solicitação de API. A tabela a seguir contém uma descrição dos campos do corpo da solicitação que você precisa fornecer ao usar o método da API AsyncBatchAnnotateFiles para suas solicitações de detecção de texto:

Campos do corpo da solicitação	Descrição do campo
`s3_source.uri`	O caminho do URI para um arquivo de origem válido (PDF ou TIFF) em um bucket de armazenamento do seu projeto do Distributed Cloud. Esse arquivo contém o texto que você quer detectar. O usuário ou a conta de serviço solicitante precisa ter pelo menos privilégios de leitura para o arquivo.
`mime_type`	O tipo de arquivo de origem. Defina um dos seguintes valores: `application/pdf` para arquivos PDF `image/tiff` para arquivos TIFF
`type`	O tipo de detecção de texto que você precisa do arquivo. Especifique um dos dois recursos de anotação: `TEXT_DETECTION` detecta e extrai texto de qualquer arquivo. A resposta JSON inclui a string extraída, palavras individuais e caixas delimitadoras. `DOCUMENT_TEXT_DETECTION` também extrai texto de um arquivo, mas o serviço otimiza a resposta para textos e documentos densos. O JSON inclui informações de página, bloco, parágrafo, palavra e quebra de linha. Para mais informações sobre esses recursos de anotação, consulte Recursos de reconhecimento óptico de caracteres.
`s3_destination.uri`	O caminho do URI para um bucket de armazenamento do seu projeto do Distributed Cloud em que os arquivos de saída serão salvos. É onde você quer armazenar os resultados da detecção. O usuário ou a conta de serviço solicitante precisa ter permissão de gravação no bucket.

Armazenar o arquivo de origem em um bucket de armazenamento

Antes de enviar uma solicitação, verifique se a conta de serviço de OCR tem permissões de leitura para o bucket de entrada e de gravação para o bucket de saída.

Os buckets de entrada e saída podem ser diferentes e estar em namespaces de projetos diferentes. Recomendamos usar os mesmos buckets de entrada e saída para evitar erros, como armazenar os resultados em buckets incorretos.

Siga estas etapas para armazenar o arquivo em que você quer detectar texto em um bucket de armazenamento:

Configure a CLI gdcloud para armazenamento de objetos.

Crie um bucket de armazenamento no namespace do projeto. Use uma classe de armazenamento Standard.

Para criar o bucket de armazenamento, implante um recurso Bucket no namespace do projeto:

apiVersion: object.gdc.goog/v1
kind: Bucket
metadata:
  name: ocr-async-bucket
  namespace: PROJECT_NAMESPACE
spec:
  description: bucket for async ocr
  storageClass: Standard
  bucketPolicy:
    lockingPolicy:
      defaultObjectRetentionDays: 90

Conceda permissões read e write no bucket à conta de serviço (g-vai-ocr-sie-sa) usada pelo serviço de OCR.

Siga estas etapas para criar a função e a vinculação de função usando recursos personalizados:

Crie a função implantando um recurso Role no namespace do projeto:

  apiVersion: rbac.authorization.k8s.io/v1
  kind: Role
  metadata:
    name: ocr-async-reader-writer
    namespace: PROJECT_NAMESPACE
  rules:
    -
      apiGroups:
        - object.gdc.goog
      resources:
        - buckets
      verbs:
        - read-object
        - write-object

Implante um recurso RoleBinding no namespace do projeto para criar a vinculação de função:

  apiVersion: rbac.authorization.k8s.io/v1
  kind: RoleBinding

  metadata:
    name: ocr-async-reader-writer-rolebinding
    namespace: PROJECT_NAMESPACE
  roleRef:
    apiGroup: rbac.authorization.k8s.io
    kind: Role
    name: ocr-async-reader-writer
  subjects:
    -
      kind: ServiceAccount
      name: g-vai-ocr-sie-sa
      namespace: g-vai-ocr-sie

Faça upload do arquivo para o bucket de armazenamento que você criou. Para mais informações, consulte Fazer upload e download de objetos de armazenamento em projetos.

Fazer uma solicitação de API off-line

Os exemplos a seguir mostram como detectar texto em um arquivo usando OCR:

REST

Siga estas etapas para detectar texto em arquivos usando o método da API REST:

Salve o seguinte arquivo request.json para o corpo da solicitação:

cat <<- EOF > request.json
{
  "parent": PROJECT_ID,
  "requests":[
    {
      "input_config": {
        "s3_source": {
          "uri": "SOURCE_FILE"
        },
        "mime_type": "application/pdf"
      },
      "features": [
        {
          "type": "FEATURE_TYPE"
        }
      ],
      "output_config": {
        "s3_destination": {
          "uri": "DESTINATION_BUCKET"
        }
      }
    }
  ]
}
EOF

Substitua:

PROJECT_ID: o ID do projeto.
SOURCE_FILE: o caminho do URI para um arquivo de origem válido (PDF ou TIFF) em um bucket de armazenamento do seu projeto do Distributed Cloud.
FEATURE_TYPE: o tipo de detecção de texto que você precisa do arquivo. Os valores permitidos são TEXT_DETECTION ou DOCUMENT_TEXT_DETECTION.
DESTINATION_BUCKET: o caminho do URI para um bucket de armazenamento do seu projeto do Distributed Cloud para salvar arquivos de saída.

Receber um token de autenticação.

Faça a solicitação:

curl

curl -X POST \
  -H "Authorization: Bearer TOKEN" \
  -H "x-goog-user-project: projects/PROJECT_ID" \
  -H "Content-Type: application/json; charset=utf-8" \
  -d @request.json \
  https://ENDPOINT/v1/files:asyncBatchAnnotate

Substitua:

TOKEN: o token de autenticação que você recebeu.
PROJECT_ID: o ID do projeto.
ENDPOINT: o endpoint de OCR que você usa na sua organização. Para mais informações, consulte o status do serviço e os endpoints.

PowerShell

$headers = @{
  "Authorization" = "Bearer TOKEN"
  "x-goog-user-project" = "projects/PROJECT_ID"
}

Invoke-WebRequest
  -Method POST
  -Headers $headers
  -ContentType: "application/json; charset=utf-8"
  -InFile request.json
  -Uri "ENDPOINT/v1/files:asyncBatchAnnotate" | Select-Object -Expand Content

Substitua:

TOKEN: o token de autenticação que você recebeu.
ENDPOINT: o endpoint de OCR que você usa na sua organização. Para mais informações, consulte o status do serviço e os endpoints.

Python

Siga estas etapas para usar o serviço de OCR de um script Python para detectar texto em um arquivo:

Instale a versão mais recente da biblioteca de cliente de OCR.
Defina as variáveis de ambiente necessárias em um script Python.
Autentique sua solicitação de API.

Adicione o seguinte código ao script Python que você criou:

from google.cloud import vision
import google.auth
from google.auth.transport import requests
from google.api_core.client_options import ClientOptions

audience = "https://ENDPOINT:443"
api_endpoint="ENDPOINT:443"

def vision_func_async(creds):
  vc = vision_client(creds)
  features = [{"type_": vision.Feature.Type.FEATURE_TYPE}]
  input_config = {"s3_source":{"uri":SOURCE_FILE},"mime_type": "application/pdf"}
  output_config = {"s3_destination": {"uri": DESTINATION_BUKET}}
  req = {"input_config": input_config, "output_config": output_config, "features":features}
  reqs = {"requests":[req],"parent":PROJECT_ID}

  metadata = [("x-goog-user-project", "projects/PROJECT_ID")]

  operation = vc.async_batch_annotate_files(request=reqs, metadata=metadata)
  lro = operation.operation
  resp = operation.result()

def main():
  creds = None
  try:
    creds, project_id = google.auth.default()
    creds = creds.with_gdch_audience(audience)
    req = requests.Request()
    creds.refresh(req)
    print("Got token: ")
    print(creds.token)
  except Exception as e:
    print("Caught exception" + str(e))
    raise e
  return creds

if __name__=="__main__":
  creds = main()
  vision_func_async(creds)

Substitua:

ENDPOINT: o endpoint de OCR que você usa na sua organização. Para mais informações, consulte o status e os endpoints do serviço.
FEATURE_TYPE: o tipo de detecção de texto que você precisa do arquivo. Os valores permitidos são TEXT_DETECTION ou DOCUMENT_TEXT_DETECTION.
SOURCE_FILE: o caminho do URI para um arquivo de origem válido (PDF ou TIFF) em um bucket de armazenamento do seu projeto do Distributed Cloud.
DESTINATION_BUCKET: o caminho do URI para um bucket de armazenamento do seu projeto do Distributed Cloud para salvar arquivos de saída.
PROJECT_ID: o ID do projeto.

Salve o script Python.
Execute o script Python para detectar texto no arquivo:
```
python SCRIPT_NAME
```
Substitua SCRIPT_NAME pelo nome que você deu ao script do Python, como vision.py.

Use o nome da operação retornado pelo método AsyncBatchAnnotateFiles para verificar o status dela.

Acessar o status da operação

O método get retorna o estado mais recente de uma operação de longa duração, como a solicitação off-line para detecção de texto. Use este método para verificar o status da operação, como no exemplo a seguir:

curl -X GET "http://ENDPOINT/v1/OPERATION_NAME"

Substitua OPERATION_NAME pelo nome da operação que o método AsyncBatchAnnotateFiles retornou quando você fez a solicitação off-line.

Listar operações

O método list retorna uma lista das operações que correspondem a um filtro especificado na solicitação. O método pode retornar operações de um projeto específico. Para chamar o método list, especifique o ID do projeto e o endpoint de OCR, como no exemplo a seguir:

curl -X GET "http://ENDPOINT/v1/PROJECT_ID?page_size=10"

Detectar texto em arquivos Mantenha tudo organizado com as coleções Salve e categorize o conteúdo com base nas suas preferências.

Antes de começar

Detectar texto com solicitações inline

Fazer uma solicitação de API inline

REST

curl

PowerShell

Python

Detectar texto com solicitações off-line

Armazenar o arquivo de origem em um bucket de armazenamento

Fazer uma solicitação de API off-line

REST

curl

PowerShell

Python

Acessar o status da operação

Listar operações

Detectar texto em arquivos