Get Image Embeddings - Get Image Embeddings

Služba:: AI Foundry

Verze rozhraní API:: 2024-05-01-preview

Vrátí vložené vektory pro dané obrázky. Metoda provede volání rozhraní REST API na trasu /images/embeddings na daném koncovém bodu.

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

Parametry identifikátoru URI

Name	V	Vyžadováno	Typ	Description
resource	path	True	string	Název prostředku Azure AI Services, například my-resource
api-version	query	True	string minLength: 1	Verze rozhraní API, která se má použít pro tuto operaci.

Hlavička požadavku

Name	Vyžadováno	Typ	Description
extra-parameters		ExtraParameters	Určuje, co se stane, když se v datové části požadavku JSON předají dodatečné parametry, které rozhraní REST API nedefinuje. Tím se nastaví hlavička požadavku HTTP `extra-parameters`.

Text požadavku

Name	Vyžadováno	Typ	Description
input	True	ImageEmbeddingInput[]	Vstupní obrázek pro vložení Pokud chcete vložit více vstupů do jednoho požadavku, předejte pole. Vstup nesmí překročit maximální vstupní tokeny modelu.
dimensions		integer (int32)	Volitelný. Početdimenzích Předání hodnoty null způsobí, že model použije výchozí hodnotu. Vrátí chybu 422, pokud model nepodporuje hodnotu nebo parametr.
encoding_format		EmbeddingEncodingFormat	Volitelný. Početdimenzích Předání hodnoty null způsobí, že model použije výchozí hodnotu. Vrátí chybu 422, pokud model nepodporuje hodnotu nebo parametr.
input_type		EmbeddingInputType	Volitelný. Typ vstupu. Vrátí chybu 422, pokud model nepodporuje hodnotu nebo parametr.
model		string	ID konkrétního modelu AI, který se má použít, pokud je v koncovém bodu k dispozici více než jeden model.

Odpovědi

Name	Typ	Description
200 OK	EmbeddingsResult	Požadavek byl úspěšný.
Other Status Codes	Azure.Core.Foundations.ErrorResponse	Neočekávaná chybová odpověď Hlavičky x-ms-error-code: string

Name

Typ

Description

200 OK

EmbeddingsResult

Požadavek byl úspěšný.

Other Status Codes

Azure.Core.Foundations.ErrorResponse

Neočekávaná chybová odpověď

Hlavičky

x-ms-error-code: string

Zabezpečení

api-key

Typ: apiKey
V: header

OAuth2Auth

Typ: oauth2
Tok: implicit
URL autorizace: https://login.microsoftonline.com/common/oauth2/v2.0/authorize

Rozsahy

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

Příklady

maximum set image embeddings

minimum set image embeddings

maximum set image embeddings

Ukázkový požadavek

HTTP

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


{
  "input": [
    {
      "image": "puqkvvlvgcjyzughesnkena",
      "text": "azrzyjsmnuefqpowpvfmyobeehqsni"
    }
  ],
  "dimensions": 1024,
  "encoding_format": "float",
  "input_type": "text",
  "model": "my-model-name"
}

Ukázková odpověď

Stavový kód:: 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 image embeddings

Ukázkový požadavek

HTTP

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

{
  "input": [
    {
      "image": "gvmojtfooxixxzayrditjlyymg"
    }
  ]
}

Ukázková odpověď

Stavový kód:: 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
  }
}

Definice

Name	Description
Azure.Core.Foundations.Error	Objekt chyby.
Azure.Core.Foundations.ErrorResponse	Odpověď obsahující podrobnosti o chybě.
Azure.Core.Foundations.InnerError	Objekt obsahující konkrétnější informace o chybě. Podle pokynů pro rozhraní Azure REST API - https://aka.ms/AzureRestApiGuidelines#handling-errors.
EmbeddingEncodingFormat	Určuje typy vkládání, které se mají vygenerovat. Komprimované typy vkládání, jako jsou `uint8`, `int8`, `ubinary` a `binary`, mohou snížit náklady na úložiště bez obětování integrity dat. Vrátí chybu 422, pokud model nepodporuje hodnotu nebo parametr. Přečtěte si dokumentaci k modelu, kde najdete informace o hodnotách podporovaných modelem.
EmbeddingInputType	Představuje vstupní typy používané pro vkládání hledání.
EmbeddingItem	Reprezentace jednoho porovnání souvisejících vlastností pro vložení
EmbeddingsResult	Reprezentace dat odpovědi z požadavku vkládání Vkládání měří související textových řetězců a běžně se používají pro vyhledávání, clustering, doporučení a další podobné scénáře.
EmbeddingsUsage	Měření množství tokenů použitých v tomto požadavku a odpovědi
ExtraParameters	Určuje, co se stane, když se v datové části požadavku JSON předají dodatečné parametry, které rozhraní REST API nedefinuje.
ImageEmbeddingInput	Představuje obrázek s volitelným textem.
ImageEmbeddingsOptions	Informace o konfiguraci pro požadavek vložení obrázku.

Azure.Core.Foundations.Error

Objekt

Objekt chyby.

Name	Typ	Description
code	string	Jedna ze serverově definovaných kódů chyb.
details	Azure.Core.Foundations.Error[]	Pole podrobností o konkrétních chybách, které vedly k této nahlášené chybě.
innererror	Azure.Core.Foundations.InnerError	Objekt obsahující konkrétnější informace, než je aktuální objekt o chybě.
message	string	Čitelné znázornění chyby člověkem.
target	string	Cíl chyby.

Azure.Core.Foundations.ErrorResponse

Objekt

Odpověď obsahující podrobnosti o chybě.

Name	Typ	Description
error	Azure.Core.Foundations.Error	Objekt chyby.

Azure.Core.Foundations.InnerError

Objekt

Objekt obsahující konkrétnější informace o chybě. Podle pokynů pro rozhraní Azure REST API - https://aka.ms/AzureRestApiGuidelines#handling-errors.

Name	Typ	Description
code	string	Jedna ze serverově definovaných kódů chyb.
innererror	Azure.Core.Foundations.InnerError	Vnitřní chyba.

EmbeddingEncodingFormat

Výčet

Určuje typy vkládání, které se mají vygenerovat. Komprimované typy vkládání, jako jsou uint8, int8, ubinary a binary, mohou snížit náklady na úložiště bez obětování integrity dat. Vrátí chybu 422, pokud model nepodporuje hodnotu nebo parametr. Přečtěte si dokumentaci k modelu, kde najdete informace o hodnotách podporovaných modelem.

Hodnota	Description
base64	Získejte binární reprezentaci vložených kódů kódovaných jako řetězec Base64. Knihovna OpenAI Python načítá vkládání z rozhraní API jako zakódovaná binární data místo použití zprostředkujících desítkových reprezentací, jak je obvykle provedeno.
binary	Získání binárních vkládání podepsaných zpět
float	Získání úplné přesnosti vkládání
int8	Získat zpět podepsané vložené int8
ubinary	Získání binárních vkládání bez znaménka
uint8	Získání zpětných vkládání bez znaménka int8

EmbeddingInputType

Výčet

Představuje vstupní typy používané pro vkládání hledání.

Hodnota	Description
text	Označuje, že vstup je obecný textový vstup.
query	Označuje vstup představuje vyhledávací dotaz, který vyhledá nejrelevavantnější dokumenty ve vaší vektorové databázi.
document	Označuje vstup představuje dokument, který je uložen v vektorové databázi.

EmbeddingItem

Objekt

Reprezentace jednoho porovnání souvisejících vlastností pro vložení

Name	Typ	Description
embedding	number[] (float)	Seznam hodnot vložení pro vstupní výzvu Představují měření vektorové relace poskytnutého vstupu. Nebo řetězec s kódováním base64 vloženého vektoru.
index	integer (int32)	Index výzvy, ke které odpovídá EmbeddingItem.
object	enum: embedding	Typ objektu této položky vkládání. Bude vždy `embedding`.

EmbeddingsResult

Objekt

Reprezentace dat odpovědi z požadavku vkládání Vkládání měří související textových řetězců a běžně se používají pro vyhledávání, clustering, doporučení a další podobné scénáře.

Name	Typ	Description
data	EmbeddingItem[]	Vložení hodnot pro výzvy odeslané v požadavku
id	string	Jedinečný identifikátor výsledku vkládání
model	string	ID modelu použité k vygenerování tohoto výsledku.
object	enum: list	Typ objektu výsledku vkládání. Bude vždy `list`.
usage	EmbeddingsUsage	Počty využití pro vstup tokenů pomocí rozhraní API pro vkládání

EmbeddingsUsage

Objekt

Měření množství tokenů použitých v tomto požadavku a odpovědi

Name	Typ	Description
prompt_tokens	integer (int32)	Počet tokenů v požadavku
total_tokens	integer (int32)	Celkový počet tokenů převedených v tomto požadavku nebo odpovědi Měl by se rovnat počtu tokenů v požadavku.

ExtraParameters

Výčet

Určuje, co se stane, když se v datové části požadavku JSON předají dodatečné parametry, které rozhraní REST API nedefinuje.

Hodnota	Description
error	Pokud služba zjistila v datové části požadavku další parametry, dojde k chybě. Toto je výchozí služba.
drop	Služba bude v datové části požadavku ignorovat (vynechat) další parametry. Předá pouze známé parametry modelu AI back-endu.
pass-through	Služba předá back-endový model AI další parametry.

ImageEmbeddingInput

Objekt

Představuje obrázek s volitelným textem.

Name	Typ	Description
image	string	Vstupní obrázek kódovaný v řetězci base64 jako adresa URL dat. Příklad: `data:image/{format};base64,{data}`.
text	string	Volitelný. Textový vstup, který se má vložit do modelu (například DINO, CLIP). Vrátí chybu 422, pokud model nepodporuje hodnotu nebo parametr.

ImageEmbeddingsOptions

Objekt

Informace o konfiguraci pro požadavek vložení obrázku.

Name	Typ	Description
dimensions	integer (int32)	Volitelný. Početdimenzích Předání hodnoty null způsobí, že model použije výchozí hodnotu. Vrátí chybu 422, pokud model nepodporuje hodnotu nebo parametr.
encoding_format	EmbeddingEncodingFormat	Volitelný. Početdimenzích Předání hodnoty null způsobí, že model použije výchozí hodnotu. Vrátí chybu 422, pokud model nepodporuje hodnotu nebo parametr.
input	ImageEmbeddingInput[]	Vstupní obrázek pro vložení Pokud chcete vložit více vstupů do jednoho požadavku, předejte pole. Vstup nesmí překročit maximální vstupní tokeny modelu.
input_type	EmbeddingInputType	Volitelný. Typ vstupu. Vrátí chybu 422, pokud model nepodporuje hodnotu nebo parametr.
model	string	ID konkrétního modelu AI, který se má použít, pokud je v koncovém bodu k dispozici více než jeden model.

Sdílet prostřednictvím

Get Image Embeddings - Get Image Embeddings

Parametry identifikátoru URI

Hlavička požadavku

Text požadavku

Odpovědi

Zabezpečení

api-key

OAuth2Auth

Rozsahy

Příklady

maximum set image embeddings

Ukázkový požadavek

Ukázková odpověď

minimum set image embeddings

Ukázkový požadavek

Ukázková odpověď

Definice

Azure.Core.Foundations.Error

Azure.Core.Foundations.ErrorResponse

Azure.Core.Foundations.InnerError

EmbeddingEncodingFormat

EmbeddingInputType

EmbeddingItem

EmbeddingsResult

EmbeddingsUsage

ExtraParameters

ImageEmbeddingInput

ImageEmbeddingsOptions