Prévia

Esse recurso está em Public Preview e é compatível com os sites us-east1 e us-central1.

Referência da API REST do modelo básico

Este artigo fornece API informações gerais sobre Databricks o Foundation Model APIs e os modelos que ele suporta. As APIs do Foundation Model foram projetadas para serem semelhantes à API REST da OpenAI para facilitar a migração de projetos existentes.

ponto final

provisionamento O ponto de extremidade da taxa de transferência pode ser criado usando o site API ou a UI de serviço. Esses pontos de extremidade também suportam vários modelos por endpoint para testes A/B, desde que ambos os modelos atendidos exponham o mesmo formato API. Por exemplo, os dois modelos são modelos de incorporação.

Uso

As respostas incluem uma submensagem usage que informa o número de tokens na solicitação e na resposta. O formato dessa submensagem é o mesmo em todos os tipos de tarefa.

campo	Tipo	Descrição
`completion_tokens`	Integer	Número de tokens gerados. Não incluído na incorporação de respostas.
`prompt_tokens`	Integer	Número de tokens do(s) prompt(s) de entrada.
`total_tokens`	Integer	Número total de tokens.

Tarefa de incorporação

A tarefa de incorporação mapeia a entrada strings em vetores de incorporação. Muitas entradas podem ser agrupadas em cada solicitação. Consulte POST /serving-endpoint/{name}/invocations para consultar os parâmetros de endpoint.

Solicitação de incorporação

campo	Tipo	Descrição
`input`	strings ou List[strings]	Obrigatório. O texto de entrada a ser incorporado. Pode ser uma cadeia de caracteres ou uma lista de strings.
`instruction`	String	Uma instrução opcional a ser passada para o modelo de incorporação.

As instruções são opcionais e altamente específicas do modelo. Por exemplo, os autores do The BGE não recomendam nenhuma instrução ao indexar blocos e recomendam o uso da instrução "Represent this sentence for searching relevant passages:" para consultas de recuperação. Outros modelos, como o Instructor-XL, suportam uma ampla variedade de instruções strings.

Resposta de incorporações

campo	Tipo	Descrição
`id`	String	Identificador exclusivo para a incorporação.
`object`	String	O tipo de objeto. Igual a `"list"`.
`model`	String	O nome do modelo de incorporação usado para criar a incorporação.
`data`	Objeto de incorporação	O objeto de incorporação.
`usage`	Uso	metadados de uso de tokens.

`EmbeddingObject`

campo	Tipo	Descrição
`object`	String	O tipo de objeto. Igual a `"embedding"`.
`index`	Integer	O índice da incorporação na lista de incorporações gerada pelo modelo.
`embedding`	Lista [Float]	O vetor de incorporação. Cada modelo retornará um vetor de tamanho fixo (1024 para BGE-Large)