Get Image Embeddings - Get Image Embeddings

Service:: AI Foundry

API-versie:: 2024-05-01-preview

Retourneert de insluitvectors voor bepaalde afbeeldingen. De methode maakt een REST API-aanroep naar de /images/embeddings route op het opgegeven eindpunt.

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

URI-parameters

Name	In	Vereist	Type	Description
resource	path	True	string	De resourcenaam van Azure AI Services, bijvoorbeeld 'my-resource'
api-version	query	True	string minLength: 1	De API-versie die voor deze bewerking moet worden gebruikt.

Aanvraagkoptekst

Name	Vereist	Type	Description
extra-parameters		ExtraParameters	Hiermee bepaalt u wat er gebeurt als extra parameters, die niet zijn gedefinieerd door de REST API, worden doorgegeven in de nettolading van de JSON-aanvraag. Hiermee stelt u de HTTP-aanvraagheader in `extra-parameters`.

Aanvraagbody

Name	Vereist	Type	Description
input	True	ImageEmbeddingInput[]	Invoerafbeelding die moet worden ingesloten. Als u meerdere invoer in één aanvraag wilt insluiten, geeft u een matrix door. De invoer mag de maximuminvoertokens voor het model niet overschrijden.
dimensions		integer (int32)	Facultatief. Het aantal dimensies dat de resulterende uitvoer-insluitingen moeten hebben. Het doorgeven van null zorgt ervoor dat het model de standaardwaarde gebruikt. Retourneert een 422-fout als het model de waarde of parameter niet ondersteunt.
encoding_format		EmbeddingEncodingFormat	Facultatief. Het aantal dimensies dat de resulterende uitvoer-insluitingen moeten hebben. Het doorgeven van null zorgt ervoor dat het model de standaardwaarde gebruikt. Retourneert een 422-fout als het model de waarde of parameter niet ondersteunt.
input_type		EmbeddingInputType	Facultatief. Het type invoer. Retourneert een 422-fout als het model de waarde of parameter niet ondersteunt.
model		string	Id van het specifieke AI-model dat moet worden gebruikt, als er meer dan één model beschikbaar is op het eindpunt.

Antwoorden

Name	Type	Description
200 OK	EmbeddingsResult	De aanvraag is voltooid.
Other Status Codes	Azure.Core.Foundations.ErrorResponse	Een onverwachte foutreactie. Kopteksten x-ms-error-code: string

Name

Type

Description

200 OK

EmbeddingsResult

De aanvraag is voltooid.

Other Status Codes

Azure.Core.Foundations.ErrorResponse

Een onverwachte foutreactie.

Kopteksten

x-ms-error-code: string

Beveiliging

api-key

Type: apiKey
In: header

OAuth2Auth

Type: oauth2
Stroom: implicit
Autorisatie-URL: https://login.microsoftonline.com/common/oauth2/v2.0/authorize

Bereiken

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

Voorbeelden

maximum set image embeddings

minimum set image embeddings

maximum set image embeddings

Voorbeeldaanvraag

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"
}

Voorbeeldrespons

Statuscode:: 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

Voorbeeldaanvraag

HTTP

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

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

Voorbeeldrespons

Statuscode:: 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
  }
}

Definities

Name	Description
Azure.Core.Foundations.Error	Het foutobject.
Azure.Core.Foundations.ErrorResponse	Een antwoord met foutdetails.
Azure.Core.Foundations.InnerError	Een object met meer specifieke informatie over de fout. Volgens de Azure REST API-richtlijnen - . https://aka.ms/AzureRestApiGuidelines#handling-errors
EmbeddingEncodingFormat	Hiermee geeft u de typen insluitingen die moeten worden gegenereerd. Gecomprimeerde typen insluitingen, zoals `uint8`, `int8`, `ubinary` en `binary`, kunnen de opslagkosten verlagen zonder de integriteit van de gegevens op te offeren. Retourneert een 422-fout als het model de waarde of parameter niet ondersteunt. Lees de documentatie van het model om de waarden te kennen die door het model worden ondersteund.
EmbeddingInputType	Vertegenwoordigt de invoertypen die worden gebruikt voor het insluiten van zoekopdrachten.
EmbeddingItem	Weergave van één insluitingsvergelijking.
EmbeddingsResult	Weergave van de antwoordgegevens van een insluitingsaanvraag. Met insluitingen worden de gerelateerdheid van teksttekenreeksen gemeten en worden vaak gebruikt voor zoeken, clusteren, aanbevelingen en andere vergelijkbare scenario's.
EmbeddingsUsage	Meting van de hoeveelheid tokens die in deze aanvraag en reactie worden gebruikt.
ExtraParameters	Hiermee bepaalt u wat er gebeurt als extra parameters, die niet zijn gedefinieerd door de REST API, worden doorgegeven in de nettolading van de JSON-aanvraag.
ImageEmbeddingInput	Vertegenwoordigt een afbeelding met optionele tekst.
ImageEmbeddingsOptions	De configuratiegegevens voor een aanvraag voor het insluiten van afbeeldingen.

Azure.Core.Foundations.Error

Object

Het foutobject.

Name	Type	Description
code	string	Een van een door de server gedefinieerde set foutcodes.
details	Azure.Core.Foundations.Error[]	Een matrix met details over specifieke fouten die hebben geleid tot deze gemelde fout.
innererror	Azure.Core.Foundations.InnerError	Een object met meer specifieke informatie dan het huidige object over de fout.
message	string	Een leesbare weergave van de fout.
target	string	Het doel van de fout.

Azure.Core.Foundations.ErrorResponse

Object

Een antwoord met foutdetails.

Name	Type	Description
error	Azure.Core.Foundations.Error	Het foutobject.

Azure.Core.Foundations.InnerError

Object

Een object met meer specifieke informatie over de fout. Volgens de Azure REST API-richtlijnen - . https://aka.ms/AzureRestApiGuidelines#handling-errors

Name	Type	Description
code	string	Een van een door de server gedefinieerde set foutcodes.
innererror	Azure.Core.Foundations.InnerError	Interne fout.

EmbeddingEncodingFormat

Inventarisatie

Hiermee geeft u de typen insluitingen die moeten worden gegenereerd. Gecomprimeerde typen insluitingen, zoals uint8, int8, ubinary en binary, kunnen de opslagkosten verlagen zonder de integriteit van de gegevens op te offeren. Retourneert een 422-fout als het model de waarde of parameter niet ondersteunt. Lees de documentatie van het model om de waarden te kennen die door het model worden ondersteund.

Waarde	Description
base64	Ga terug naar de binaire weergave van de insluitingen die zijn gecodeerd als Base64-tekenreeks. Met de OpenAI Python-bibliotheek worden insluitingen opgehaald uit de API als gecodeerde binaire gegevens in plaats van tussenliggende decimale representaties te gebruiken, zoals meestal wordt gedaan.
binary	Ondertekende binaire insluitingen terughalen
float	Volledige precisie-insluitingen terughalen
int8	Aangemeld int8-insluitingen terughalen
ubinary	Niet-ondertekende binaire insluitingen terughalen
uint8	Niet-ondertekende int8-insluitingen terughalen

EmbeddingInputType

Inventarisatie

Vertegenwoordigt de invoertypen die worden gebruikt voor het insluiten van zoekopdrachten.

Waarde	Description
text	Geeft aan dat de invoer een algemene tekstinvoer is.
query	Geeft aan dat de invoer een zoekquery vertegenwoordigt om de meest relevante documenten in uw vectordatabase te vinden.
document	Hiermee wordt aangegeven dat de invoer een document vertegenwoordigt dat is opgeslagen in een vectordatabase.

EmbeddingItem

Object

Weergave van één insluitingsvergelijking.

Name	Type	Description
embedding	number[] (float)	Lijst met insluitingswaarden voor de invoerprompt. Deze vertegenwoordigen een meting van de vectorgerelateerde verwantschap van de opgegeven invoer. Of een met base64 gecodeerde tekenreeks van de insluitvector.
index	integer (int32)	Index van de prompt waarnaar de EmbeddingItem overeenkomt.
object	enum: embedding	Het objecttype van dit item voor insluitingen. Zal altijd `embedding`zijn.

EmbeddingsResult

Object

Weergave van de antwoordgegevens van een insluitingsaanvraag. Met insluitingen worden de gerelateerdheid van teksttekenreeksen gemeten en worden vaak gebruikt voor zoeken, clusteren, aanbevelingen en andere vergelijkbare scenario's.

Name	Type	Description
data	EmbeddingItem[]	Waarden insluiten voor de prompts die zijn ingediend in de aanvraag.
id	string	Unieke id voor het resultaat van insluitingen.
model	string	De model-id die wordt gebruikt om dit resultaat te genereren.
object	enum: list	Het objecttype van het resultaat van insluitingen. Zal altijd `list`zijn.
usage	EmbeddingsUsage	Het aantal gebruiksgegevens voor tokensinvoer met behulp van de API voor insluitingen.

EmbeddingsUsage

Object

Meting van de hoeveelheid tokens die in deze aanvraag en reactie worden gebruikt.

Name	Type	Description
prompt_tokens	integer (int32)	Aantal tokens in de aanvraag.
total_tokens	integer (int32)	Het totale aantal tokens dat is verwerkt in deze aanvraag/reactie. Moet gelijk zijn aan het aantal tokens in de aanvraag.

ExtraParameters

Inventarisatie

Hiermee bepaalt u wat er gebeurt als extra parameters, die niet zijn gedefinieerd door de REST API, worden doorgegeven in de nettolading van de JSON-aanvraag.

Waarde	Description
error	De service treedt op als er extra parameters zijn gedetecteerd in de nettolading van de aanvraag. Dit is de standaardservice.
drop	De service negeert extra parameters (drop) in de nettolading van de aanvraag. Hiermee worden alleen de bekende parameters doorgegeven aan het AI-model van de back-end.
pass-through	De service geeft extra parameters door aan het AI-model van de back-end.

ImageEmbeddingInput

Object

Vertegenwoordigt een afbeelding met optionele tekst.

Name	Type	Description
image	string	De invoerafbeelding die in de base64-tekenreeks is gecodeerd als een gegevens-URL. Voorbeeld: `data:image/{format};base64,{data}`.
text	string	Facultatief. De tekstinvoer die moet worden ingevoerd in het model (zoals DINO, CLIP). Retourneert een 422-fout als het model de waarde of parameter niet ondersteunt.

ImageEmbeddingsOptions

Object

De configuratiegegevens voor een aanvraag voor het insluiten van afbeeldingen.

Name	Type	Description
dimensions	integer (int32)	Facultatief. Het aantal dimensies dat de resulterende uitvoer-insluitingen moeten hebben. Het doorgeven van null zorgt ervoor dat het model de standaardwaarde gebruikt. Retourneert een 422-fout als het model de waarde of parameter niet ondersteunt.
encoding_format	EmbeddingEncodingFormat	Facultatief. Het aantal dimensies dat de resulterende uitvoer-insluitingen moeten hebben. Het doorgeven van null zorgt ervoor dat het model de standaardwaarde gebruikt. Retourneert een 422-fout als het model de waarde of parameter niet ondersteunt.
input	ImageEmbeddingInput[]	Invoerafbeelding die moet worden ingesloten. Als u meerdere invoer in één aanvraag wilt insluiten, geeft u een matrix door. De invoer mag de maximuminvoertokens voor het model niet overschrijden.
input_type	EmbeddingInputType	Facultatief. Het type invoer. Retourneert een 422-fout als het model de waarde of parameter niet ondersteunt.
model	string	Id van het specifieke AI-model dat moet worden gebruikt, als er meer dan één model beschikbaar is op het eindpunt.

Delen via

Get Image Embeddings - Get Image Embeddings

URI-parameters

Aanvraagkoptekst

Aanvraagbody

Antwoorden

Beveiliging

api-key

OAuth2Auth

Bereiken

Voorbeelden

maximum set image embeddings

Voorbeeldaanvraag

Voorbeeldrespons

minimum set image embeddings

Voorbeeldaanvraag

Voorbeeldrespons

Definities

Azure.Core.Foundations.Error

Azure.Core.Foundations.ErrorResponse

Azure.Core.Foundations.InnerError

EmbeddingEncodingFormat

EmbeddingInputType

EmbeddingItem

EmbeddingsResult

EmbeddingsUsage

ExtraParameters

ImageEmbeddingInput

ImageEmbeddingsOptions