Visão geral da API Vertex AI

Esta página oferece uma visão geral do uso das APIs instaladas com a Vertex AI no Google Distributed Cloud (GDC) isolado e a documentação de referência.

Endpoint de serviço e documento de descoberta

Um endpoint de serviço é necessário para interagir programaticamente com as APIs da Vertex AI.

Acessar o endpoint e o documento de descoberta do Vertex AI Workbench

O endpoint de API para a API KRM do Vertex AI Workbench é:

https://ENDPOINT/apis/aiplatform.gdc.goog/v1

Substitua ENDPOINT pelo endpoint de API do servidor da API Management.

Para acessar o documento de descoberta do Vertex AI Workbench, realize uma das seguintes ações:

  • Insira o URL do endpoint em um navegador.

  • Execute o comando kubectl proxy em uma ferramenta como o curl para abrir um proxy para o servidor da API Management na sua máquina local. Depois que o comando estiver em execução, insira o seguinte URL no navegador:

    http://127.0.0.1:8001/apis/aiplatform.gdc.goog/v1.

Acessar os endpoints das APIs pré-treinadas

Para acessar os endpoints das APIs pré-treinadas, consulte o status do serviço e os endpoints.

REST, gRPC, KRM e bibliotecas de cliente

É possível acessar as APIs pré-treinadas usando o gRPC ou uma das bibliotecas de cliente fornecidas. As bibliotecas de cliente são criadas no gRPC.

Como alternativa, você pode acessar algumas APIs pré-treinadas usando REST.

É possível gerenciar o Vertex AI Workbench usando a API Kubernetes Resource Model (KRM) dele.

Bibliotecas de cliente

A Vertex AI oferece bibliotecas de cliente Python para APIs pré-treinadas. A tabela a seguir mostra uma comparação das vantagens e desvantagens de usar bibliotecas de cliente:

Vantagens Desvantagens
Mantidos pelo Google.
Autenticação integrada.
Repetições integradas.
Corpo da solicitação HTTP de buffer de protocolo eficiente. 		Não disponível para todas as linguagens de programação.

REST

As APIs OCR e Translation oferecem suporte a REST. Para mais informações, consulte as referências da API REST para esses serviços:

A tabela a seguir mostra uma comparação das vantagens e desvantagens de usar REST:

Vantagens Desvantagens
Interface JSON simples.
É compatível com muitas ferramentas e bibliotecas do Google e de terceiros. 		Você precisa criar seu próprio cliente.
Você precisa implementar a autenticação.
Você precisa implementar repetições.
Corpo da solicitação HTTP JSON menos eficiente.
O streaming REST não é compatível com essas APIs.

gRPC

As APIs pré-treinadas oferecem suporte a gRPC. Para mais informações sobre as descrições genéricas dos tipos, métodos e campos gerados para uma biblioteca gRPC, consulte a seguinte referência de gRPC:

A tabela a seguir mostra uma comparação das vantagens e desvantagens de usar gRPC:

Vantagens Desvantagem
Oferece suporte a muitas linguagens de programação.
Corpo da solicitação HTTP de buffer de protocolo eficiente. 		Você precisa gerar o próprio cliente com buffers de protocolo fornecidos pelo Google.
Você precisa implementar a autenticação.
Você precisa implementar repetições.

KRM

A API Vertex AI Workbench oferece suporte a KRM. Para mais informações, consulte a referência da API KRM do Vertex AI Workbench.

Tipo, método e nomes de campos

Dependendo de você usar bibliotecas de cliente, REST, gRPC ou KRM, o tipo, o método e os nomes dos campos da API variam das seguintes maneiras:

  • REST é organizado por hierarquia de recursos e seus métodos.
  • As bibliotecas de cliente e o gRPC são organizadas por serviços e por seus métodos.
  • Os nomes dos campos KRM usam camelCase, mas o serviço da API aceita camelCase ou snake_case.
  • Os nomes dos campos REST e gRPC usam snake_case.
  • Os nomes dos campos das bibliotecas de cliente usam maiúsculas ou minúsculas e a concatenação de texto, dependendo do nome idiomático da linguagem.

REST e buffers de protocolo

Ao chamar a API REST, o comportamento do valor padrão para buffers de protocolo pode resultar em campos ausentes em uma resposta JSON. Esses campos são definidos como o valor padrão, portanto, não são incluídos na resposta.