Get Embeddings - Get Embeddings

Serviço:: AI Foundry

Versão da API:: 2024-05-01-preview

Retorne os vetores de inserção para determinados prompts de texto. O método faz uma chamada à API REST para a rota /embeddings no ponto de extremidade especificado.

POST https://{resource}.services.ai.azure.com/models/embeddings?api-version=2024-05-01-preview

Parâmetros de URI

Nome	Em	Obrigatório	Tipo	Description
resource	path	True	string	O nome do recurso dos Serviços de IA do Azure, por exemplo, 'my-resource'
api-version	query	True	string minLength: 1	A versão da API a ser usada para esta operação.

Cabeçalho da solicitação

Nome	Obrigatório	Tipo	Description
extra-parameters		ExtraParameters	Controla o que acontece se parâmetros extras, indefinidos pela API REST, forem passados no conteúdo da solicitação JSON. Isso define o cabeçalho de solicitação HTTP `extra-parameters`.

Corpo da solicitação

Nome	Obrigatório	Tipo	Description
input	True	string[]	Texto de entrada para inserir, codificado como uma cadeia de caracteres ou matriz de tokens. Para inserir várias entradas em uma única solicitação, passe uma matriz de cadeias de caracteres ou matriz de matrizes de token.
dimensions		integer (int32)	Opcional. O número de dimensões que as inserções de saída resultantes devem ter. Passar nulo faz com que o modelo use seu valor padrão. Retornará um erro 422 se o modelo não der suporte ao valor ou ao parâmetro.
encoding_format		EmbeddingEncodingFormat	Opcional. O formato desejado para as inserções retornadas.
input_type		EmbeddingInputType	Opcional. O tipo de entrada. Retornará um erro 422 se o modelo não der suporte ao valor ou ao parâmetro.
model		string	ID do modelo de IA específico a ser usado, se mais de um modelo estiver disponível no ponto de extremidade.

Respostas

Nome	Tipo	Description
200 OK	EmbeddingsResult	A solicitação foi bem-sucedida.
Other Status Codes	Azure.Core.Foundations.ErrorResponse	Uma resposta de erro inesperada. Cabeçalhos x-ms-error-code: string

Nome

Tipo

Description

200 OK

EmbeddingsResult

A solicitação foi bem-sucedida.

Other Status Codes

Azure.Core.Foundations.ErrorResponse

Uma resposta de erro inesperada.

Cabeçalhos

x-ms-error-code: string

Segurança

api-key

Tipo: apiKey
Em: header

OAuth2Auth

Tipo: oauth2
Flow: implicit
URL de Autorização: https://login.microsoftonline.com/common/oauth2/v2.0/authorize

Escopos

Nome	Description
https://cognitiveservices.azure.com/.default

Exemplos

maximum set embeddings

minimum set embeddings

maximum set embeddings

Solicitação de exemplo

HTTP

POST https://{resource}.services.ai.azure.com/models/embeddings?api-version=2024-05-01-preview


{
  "input": [
    "This is a very good text"
  ],
  "dimensions": 1024,
  "encoding_format": "float",
  "input_type": "text",
  "model": "my-model-name"
}

Resposta de exemplo

Código de status:: 200

{
  "id": "cknxthfa",
  "data": [
    {
      "index": 0,
      "object": "embedding",
      "embedding": [
        0,
        0,
        0,
        0,
        0,
        0,
        0,
        0,
        0,
        0,
        0,
        0
      ]
    }
  ],
  "object": "list",
  "model": "my-model-name",
  "usage": {
    "prompt_tokens": 15,
    "total_tokens": 15
  }
}

minimum set embeddings

Solicitação de exemplo

HTTP

POST https://{resource}.services.ai.azure.com/models/embeddings?api-version=2024-05-01-preview

{
  "input": [
    "This is a very good text"
  ]
}

Resposta de exemplo

Código de status:: 200

{
  "id": "cknxthfa",
  "data": [
    {
      "index": 0,
      "object": "embedding",
      "embedding": [
        0,
        0,
        0,
        0,
        0,
        0,
        0,
        0,
        0,
        0,
        0,
        0
      ]
    }
  ],
  "object": "list",
  "model": "my-model-name",
  "usage": {
    "prompt_tokens": 15,
    "total_tokens": 15
  }
}

Definições

Nome	Description
Azure.Core.Foundations.Error	O objeto de erro.
Azure.Core.Foundations.ErrorResponse	Uma resposta que contém detalhes do erro.
Azure.Core.Foundations.InnerError	Um objeto que contém informações mais específicas sobre o erro. De acordo com as diretrizes da API REST do Azure - https://aka.ms/AzureRestApiGuidelines#handling-errors.
EmbeddingEncodingFormat	Especifica os tipos de inserções a serem geradas. Tipos de inserções compactadas, como `uint8`, `int8`, `ubinary` e `binary`, podem reduzir os custos de armazenamento sem sacrificar a integridade dos dados. Retornará um erro 422 se o modelo não der suporte ao valor ou ao parâmetro. Leia a documentação do modelo para saber os valores compatíveis com o modelo.
EmbeddingInputType	Representa os tipos de entrada usados para a pesquisa de inserção.
EmbeddingItem	Representação de uma única comparação de relação de inserções.
EmbeddingsOptions	As informações de configuração de uma solicitação de inserções.
EmbeddingsResult	Representação dos dados de resposta de uma solicitação de inserção. As inserções medem a relação das cadeias de caracteres de texto e geralmente são usadas para pesquisa, clustering, recomendações e outros cenários semelhantes.
EmbeddingsUsage	Medição da quantidade de tokens usados nesta solicitação e resposta.
ExtraParameters	Controla o que acontece se parâmetros extras, indefinidos pela API REST, forem passados no conteúdo da solicitação JSON.

Azure.Core.Foundations.Error

Objeto

O objeto de erro.

Nome	Tipo	Description
code	string	Um de um conjunto definido pelo servidor de códigos de erro.
details	Azure.Core.Foundations.Error[]	Uma matriz de detalhes sobre erros específicos que levaram a esse erro relatado.
innererror	Azure.Core.Foundations.InnerError	Um objeto que contém informações mais específicas do que o objeto atual sobre o erro.
message	string	Uma representação legível pelo ser humano do erro.
target	string	O destino do erro.

Azure.Core.Foundations.ErrorResponse

Objeto

Uma resposta que contém detalhes do erro.

Nome	Tipo	Description
error	Azure.Core.Foundations.Error	O objeto de erro.

Azure.Core.Foundations.InnerError

Objeto

Um objeto que contém informações mais específicas sobre o erro. De acordo com as diretrizes da API REST do Azure - https://aka.ms/AzureRestApiGuidelines#handling-errors.

Nome	Tipo	Description
code	string	Um de um conjunto definido pelo servidor de códigos de erro.
innererror	Azure.Core.Foundations.InnerError	Erro interno.

EmbeddingEncodingFormat

Enumeração

Especifica os tipos de inserções a serem geradas. Tipos de inserções compactadas, como uint8, int8, ubinary e binary, podem reduzir os custos de armazenamento sem sacrificar a integridade dos dados. Retornará um erro 422 se o modelo não der suporte ao valor ou ao parâmetro. Leia a documentação do modelo para saber os valores compatíveis com o modelo.

Valor	Description
base64	Retome a representação binária das inserções codificadas como cadeia de caracteres Base64. A biblioteca OpenAI Python recupera inserções da API como dados binários codificados, em vez de usar representações decimais intermediárias, como normalmente é feito.
binary	Recuperar inserções binárias assinadas
float	Recuperar inserções de precisão total
int8	Recuperar inserções int8 assinadas
ubinary	Recuperar inserções binárias sem sinal
uint8	Obter inserções int8 sem sinal

EmbeddingInputType

Enumeração

Representa os tipos de entrada usados para a pesquisa de inserção.

Valor	Description
text	Indica que a entrada é uma entrada de texto geral.
query	Indica que a entrada representa uma consulta de pesquisa para localizar os documentos mais relevantes em seu banco de dados vetor.
document	Indica que a entrada representa um documento armazenado em um banco de dados de vetor.

EmbeddingItem

Objeto

Representação de uma única comparação de relação de inserções.

Nome	Tipo	Description
embedding	number[] (float)	Lista de valores de inserção para o prompt de entrada. Elas representam uma medida da relação baseada em vetor da entrada fornecida. Ou uma cadeia de caracteres codificada em base64 do vetor de inserção.
index	integer (int32)	Índice do prompt ao qual o EmbeddingItem corresponde.
object	enum: embedding	O tipo de objeto desse item de inserção. Sempre será `embedding`.

EmbeddingsOptions

Objeto

As informações de configuração de uma solicitação de inserções.

Nome	Tipo	Description
dimensions	integer (int32)	Opcional. O número de dimensões que as inserções de saída resultantes devem ter. Passar nulo faz com que o modelo use seu valor padrão. Retornará um erro 422 se o modelo não der suporte ao valor ou ao parâmetro.
encoding_format	EmbeddingEncodingFormat	Opcional. O formato desejado para as inserções retornadas.
input	string[]	Texto de entrada para inserir, codificado como uma cadeia de caracteres ou matriz de tokens. Para inserir várias entradas em uma única solicitação, passe uma matriz de cadeias de caracteres ou matriz de matrizes de token.
input_type	EmbeddingInputType	Opcional. O tipo de entrada. Retornará um erro 422 se o modelo não der suporte ao valor ou ao parâmetro.
model	string	ID do modelo de IA específico a ser usado, se mais de um modelo estiver disponível no ponto de extremidade.

EmbeddingsResult

Objeto

Representação dos dados de resposta de uma solicitação de inserção. As inserções medem a relação das cadeias de caracteres de texto e geralmente são usadas para pesquisa, clustering, recomendações e outros cenários semelhantes.

Nome	Tipo	Description
data	EmbeddingItem[]	Inserindo valores para os prompts enviados na solicitação.
id	string	Identificador exclusivo para o resultado das inserções.
model	string	A ID do modelo usada para gerar esse resultado.
object	enum: list	O tipo de objeto do resultado das inserções. Sempre será `list`.
usage	EmbeddingsUsage	Contagens de uso para entrada de tokens usando a API de inserções.

EmbeddingsUsage

Objeto

Medição da quantidade de tokens usados nesta solicitação e resposta.

Nome	Tipo	Description
prompt_tokens	integer (int32)	Número de tokens na solicitação.
total_tokens	integer (int32)	Número total de tokens transacionados nesta solicitação/resposta. Deve ser igual ao número de tokens na solicitação.

ExtraParameters

Enumeração

Controla o que acontece se parâmetros extras, indefinidos pela API REST, forem passados no conteúdo da solicitação JSON.

Valor	Description
error	O serviço errou se detectou parâmetros extras no conteúdo da solicitação. Esse é o padrão do serviço.
drop	O serviço ignorará (soltar) parâmetros extras no conteúdo da solicitação. Ele só passará os parâmetros conhecidos para o modelo de IA de back-end.
pass-through	O serviço passará parâmetros extras para o modelo de IA de back-end.

Compartilhar via

Get Embeddings - Get Embeddings

Parâmetros de URI

Cabeçalho da solicitação

Corpo da solicitação

Respostas

Segurança

api-key

OAuth2Auth

Escopos

Exemplos

maximum set embeddings

Solicitação de exemplo

Resposta de exemplo

minimum set embeddings

Solicitação de exemplo

Resposta de exemplo

Definições

Azure.Core.Foundations.Error

Azure.Core.Foundations.ErrorResponse

Azure.Core.Foundations.InnerError

EmbeddingEncodingFormat

EmbeddingInputType

EmbeddingItem

EmbeddingsOptions

EmbeddingsResult

EmbeddingsUsage

ExtraParameters