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 descoberta

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

Obtenha o ponto final e o documento de descoberta 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 descoberta 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 executar esse comando, introduza o seguinte URL no navegador:

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

Obtenha os pontos finais das APIs pré-formadas

Para obter os pontos finais das APIs pré-formadas, consulte o estado do serviço e os pontos finais.

REST, gRPC, KRM e bibliotecas cliente

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

Em alternativa, pode aceder a algumas APIs pré-preparadas através de REST.

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

Bibliotecas cliente

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

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

REST

As APIs OCR e Translation suportam 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.
Bem suportado por 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 novas tentativas.
Corpo do pedido HTTP JSON menos eficiente. O streaming REST
não é suportado por estas APIs.

gRPC

As APIs pré-preparadas suportam 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 do gRPC:

Vantagens Desvantagem
Suporta muitas linguagens de programação.
Corpo do pedido HTTP do buffer do protocolo eficiente. 		Tem de gerar o seu próprio cliente a partir dos buffers do protocolo fornecidos pela Google.
Tem de implementar a autenticação.
Tem de implementar novas tentativas.

KRM

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

Tipo, método e nomes de campos

Consoante esteja a usar bibliotecas cliente, REST, gRPC ou KRM, o tipo, o método e os nomes dos campos da API variam das seguintes formas:

  • O REST está organizado por hierarquias de recursos e respetivos métodos.
  • As bibliotecas cliente e o gRPC estão organizados por serviços e respetivos métodos.
  • Os nomes dos campos KRM usam camelCase, mas o serviço API aceita camelCase ou snake_case.
  • Os nomes dos campos REST e gRPC usam snake_case.
  • Os nomes dos campos da biblioteca de cliente usam letras maiúsculas no início de cada palavra, camelCase ou snake_case, dependendo do 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 com o valor predefinido, pelo que não estão incluídos na resposta.