Get Embeddings - Get Embeddings

Serviço:: AI Foundry

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

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

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

Parâmetros do URI

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

Cabeçalho do Pedido

Name	Necessário	Tipo	Description
extra-parameters		ExtraParameters	Controla o que acontece se parâmetros extras, não definidos pela API REST, forem passados na carga útil da solicitação JSON. Isso define o cabeçalho da solicitação HTTP `extra-parameters`.

Corpo do Pedido

Name	Necessário	Tipo	Description
input	True	string[]	Insira texto para incorporar, codificado como uma cadeia de caracteres ou matriz de tokens. Para incorporar 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 incorporações de saída resultantes devem ter. Passar null faz com que o modelo use seu valor padrão. Retorna um erro 422 se o modelo não suportar o valor ou parâmetro.
encoding_format		EmbeddingEncodingFormat	Opcional. O formato desejado para as incorporações retornadas.
input_type		EmbeddingInputType	Opcional. O tipo de entrada. Retorna um erro 422 se o modelo não suportar o valor ou 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

Name	Tipo	Description
200 OK	EmbeddingsResult	O pedido foi bem-sucedido.
Other Status Codes	Azure.Core.Foundations.ErrorResponse	Uma resposta de erro inesperada. Cabeçalhos x-ms-error-code: string

Name

Tipo

Description

200 OK

EmbeddingsResult

O pedido foi bem-sucedido.

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
Fluxo: implicit
URL de Autorização: https://login.microsoftonline.com/common/oauth2/v2.0/authorize

Âmbitos

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

Exemplos

maximum set embeddings

minimum set embeddings

maximum set embeddings

Pedido de amostra

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 da amostra

Código de estado:: 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

Pedido de amostra

HTTP

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

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

Resposta da amostra

Código de estado:: 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

Name	Description
Azure.Core.Foundations.Error	O objeto de erro.
Azure.Core.Foundations.ErrorResponse	Uma resposta contendo 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 incorporações a serem geradas. Tipos de incorporações compactadas, como `uint8`, `int8`, `ubinary` e `binary`, podem reduzir os custos de armazenamento sem sacrificar a integridade dos dados. Retorna um erro 422 se o modelo não suportar o valor ou parâmetro. Leia a documentação do modelo para saber os valores suportados pelo seu modelo.
EmbeddingInputType	Representa os tipos de entrada usados para incorporar a pesquisa.
EmbeddingItem	Representação de uma única comparação de parentesco incorporado.
EmbeddingsOptions	As informações de configuração para uma solicitação de incorporação.
EmbeddingsResult	Representação dos dados de resposta de uma solicitação de incorporação. As incorporações medem a relação de cadeias de caracteres de texto e são comumente 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, não definidos pela API REST, forem passados na carga útil da solicitação JSON.

Azure.Core.Foundations.Error

Object

O objeto de erro.

Name	Tipo	Description
code	string	Um de um conjunto de códigos de erro definido pelo servidor.
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 por humanos do erro.
target	string	O alvo do erro.

Azure.Core.Foundations.ErrorResponse

Object

Uma resposta contendo detalhes do erro.

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

Azure.Core.Foundations.InnerError

Object

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.

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

EmbeddingEncodingFormat

Enumeração

Especifica os tipos de incorporações a serem geradas. Tipos de incorporações compactadas, como uint8, int8, ubinary e binary, podem reduzir os custos de armazenamento sem sacrificar a integridade dos dados. Retorna um erro 422 se o modelo não suportar o valor ou parâmetro. Leia a documentação do modelo para saber os valores suportados pelo seu modelo.

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

EmbeddingInputType

Enumeração

Representa os tipos de entrada usados para incorporar a pesquisa.

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

EmbeddingItem

Object

Representação de uma única comparação de parentesco incorporado.

Name	Tipo	Description
embedding	number[] (float)	Lista de valores de incorporação para o prompt de entrada. Estes representam uma medida da relação vetorial da entrada fornecida. Ou uma cadeia de caracteres codificada em base64 do vetor de incorporação.
index	integer (int32)	Índice do prompt ao qual o EmbeddingItem corresponde.
object	enum: embedding	O tipo de objeto deste item incorporado. Será sempre `embedding`.

EmbeddingsOptions

Object

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

Name	Tipo	Description
dimensions	integer (int32)	Opcional. O número de dimensões que as incorporações de saída resultantes devem ter. Passar null faz com que o modelo use seu valor padrão. Retorna um erro 422 se o modelo não suportar o valor ou parâmetro.
encoding_format	EmbeddingEncodingFormat	Opcional. O formato desejado para as incorporações retornadas.
input	string[]	Insira texto para incorporar, codificado como uma cadeia de caracteres ou matriz de tokens. Para incorporar 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. Retorna um erro 422 se o modelo não suportar o valor ou 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

Object

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

Name	Tipo	Description
data	EmbeddingItem[]	Incorporação de valores para os prompts enviados na solicitação.
id	string	Identificador exclusivo para o resultado de incorporações.
model	string	O ID do modelo usado para gerar esse resultado.
object	enum: list	O tipo de objeto do resultado das incorporações. Será sempre `list`.
usage	EmbeddingsUsage	O uso conta para a entrada de tokens usando a API de incorporação.

EmbeddingsUsage

Object

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

Name	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, não definidos pela API REST, forem passados na carga útil da solicitação JSON.

Valor	Description
error	O serviço errará se detetar parâmetros extras na carga útil da solicitação. Este é o padrão do serviço.
drop	O serviço ignorará (descartará) parâmetros extras na carga útil da solicitação. Ele só passará os parâmetros conhecidos para o modelo de IA back-end.
pass-through	O serviço passará parâmetros extras para o modelo de IA back-end.

Partilhar via

Get Embeddings - Get Embeddings

Parâmetros do URI

Cabeçalho do Pedido

Corpo do Pedido

Respostas

Segurança

api-key

OAuth2Auth

Âmbitos

Exemplos

maximum set embeddings

Pedido de amostra

Resposta da amostra

minimum set embeddings

Pedido de amostra

Resposta da amostra

Definições

Azure.Core.Foundations.Error

Azure.Core.Foundations.ErrorResponse

Azure.Core.Foundations.InnerError

EmbeddingEncodingFormat

EmbeddingInputType

EmbeddingItem

EmbeddingsOptions

EmbeddingsResult

EmbeddingsUsage

ExtraParameters