Vista geral da API Vertex AI

Esta página oferece uma vista geral da utilização das APIs instaladas com o Vertex AI no Google Distributed Cloud (GDC) air-gapped e a respetiva documentação de referência.

Ponto final do serviço e documento de deteção

É necessário um ponto final do serviço para interagir programaticamente com as APIs do Vertex AI.

Obtenha o ponto final e o documento de deteção do Vertex AI Workbench

O ponto final da API para a API KRM do Vertex AI Workbench é:

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

Substitua ENDPOINT pelo ponto final da API do servidor da API Management.

Para aceder ao documento de deteção do Vertex AI Workbench, execute uma das seguintes ações:

  • Introduza o URL do ponto final num navegador.

  • Execute o comando kubectl proxy numa ferramenta, como o curl, para abrir um proxy para o servidor da API Management na sua máquina local. Depois de o comando estar a ser executado, introduza o seguinte URL no navegador:

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

Obtenha os pontos finais das APIs pré-treinadas

Para obter os pontos finais das APIs pré-treinadas, veja o estado e os pontos finais dos serviços.

REST, gRPC, KRM e bibliotecas de clientes

Pode aceder às APIs pré-treinadas através do gRPC ou de uma das bibliotecas de clientes fornecidas. As bibliotecas de clientes são criadas com base no gRPC.

Em alternativa, pode aceder a algumas APIs pré-treinadas através do REST.

Pode gerir o Vertex AI Workbench através da respetiva API Kubernetes Resource Model (KRM).

Bibliotecas de clientes

O Vertex AI oferece bibliotecas de clientes Python para APIs pré-treinadas. A tabela seguinte mostra uma comparação das vantagens e desvantagens da utilização de bibliotecas de clientes:

Vantagens Desvantagens
Manutenção pela Google.
Autenticação integrada.
Repetições integradas.
Corpo do pedido HTTP de buffer de protocolo eficiente. 		Não disponível para todas as linguagens de programação.

REST

As APIs OCR e Translation são compatíveis com REST. Para mais informações, consulte as referências da API REST para estes serviços:

A tabela seguinte mostra uma comparação das vantagens e desvantagens da utilização de REST:

Vantagens Desvantagens
Interface JSON simples.
Boa compatibilidade com muitas ferramentas e bibliotecas Google e de terceiros. 		Tem de criar o seu próprio cliente.
Tem de implementar a autenticação.
Tem de implementar repetições.
Corpo do pedido HTTP JSON menos eficiente.
O streaming REST não é compatível com estas APIs.

gRPC

As APIs pré-treinadas são compatíveis com 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 gRPC:

A tabela seguinte mostra uma comparação das vantagens e desvantagens da utilização de gRPC:

Vantagens Desvantagem
Compatibilidade com muitas linguagens de programação.
Corpo do pedido HTTP de buffer de protocolo eficiente. 		Tem de gerar o seu próprio cliente a partir de buffers de protocolo fornecidos pela Google.
Tem de implementar a autenticação.
Tem de implementar repetições.

KRM

A API Vertex AI Workbench é compatível com KRM. Para mais informações, consulte a referência da API KRM do Vertex AI Workbench.

Nomes de tipos, métodos e campos

Consoante esteja a usar bibliotecas de clientes, REST, gRPC ou KRM, os nomes de tipos, métodos e campos da API variam das seguintes formas:

  • O REST está organizado por hierarquias de recursos e respetivos métodos.
  • As bibliotecas de clientes e o gRPC estão organizados por serviços e respetivos 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 da biblioteca de clientes usam Title Case, camelCase ou snake_case, consoante o nome idiomático para o idioma.

REST e buffers de protocolo

Quando chama a API REST, o comportamento do valor predefinido para os buffers de protocolo pode resultar em campos em falta numa resposta JSON. Estes campos estão definidos como o valor predefinido, pelo que não são incluídos na resposta.