Naslaginformatie: Insluitingen | Azure AI Studio
Belangrijk
Items die in dit artikel zijn gemarkeerd (preview) zijn momenteel beschikbaar als openbare preview. Deze preview wordt aangeboden zonder een service level agreement en we raden deze niet aan voor productieworkloads. Misschien worden bepaalde functies niet ondersteund of zijn de mogelijkheden ervan beperkt. Zie Aanvullende gebruiksvoorwaarden voor Microsoft Azure-previews voor meer informatie.
Hiermee maakt u een insluitvector die de invoertekst vertegenwoordigt.
POST /embeddings?api-version=2024-04-01-preview
URI-parameters
| Naam | In | Vereist | Type | Description |
|---|---|---|---|---|
api-version |
query | Waar | tekenreeks | De versie van de API in de indeling 'JJJJ-MM-DD' of 'JJJJ-MM-DD-preview'. |
Aanvraagkoptekst
| Naam | Vereist | Type | Description |
|---|---|---|---|
| extra parameters | tekenreeks | Het gedrag van de API wanneer extra parameters worden aangegeven in de nettolading. Als pass-through u de API gebruikt om de parameter door te geven aan het onderliggende model. Gebruik deze waarde als u parameters wilt doorgeven die u kent die door het onderliggende model kunnen worden ondersteund. Als u de API gebruikt ignore om een niet-ondersteunde parameter te verwijderen. Gebruik deze waarde wanneer u dezelfde nettolading voor verschillende modellen moet gebruiken, maar een van de extra parameters kan een model tot een fout maken als dit niet wordt ondersteund. Door de API te gebruiken error om eventuele extra parameters in de nettolading te weigeren. Alleen parameters die in deze API zijn opgegeven, kunnen worden aangegeven of er wordt een 400-fout geretourneerd. |
|
| azureml-model-deployment | tekenreeks | De naam van de implementatie waarnaar u de aanvraag wilt routeren. Ondersteund voor eindpunten die ondersteuning bieden voor meerdere implementaties. |
Aanvraagbody
| Naam | Vereist | Type | Description |
|---|---|---|---|
| model | tekenreeks | De modelnaam. Deze parameter wordt genegeerd als het eindpunt slechts één model gebruikt. | |
| input | Waar | tekenreeks[] | Invoertekst voor insluiten, gecodeerd als een tekenreeks of matrix met tokens. Als u meerdere invoer in één aanvraag wilt insluiten, geeft u een matrix van tekenreeksen of matrix met tokenmatrices door. |
| dimensions | geheel getal | Het aantal dimensies dat de resulterende uitvoer-insluitingen moeten hebben. Retourneert een 422-fout als het model de waarde of parameter niet ondersteunt. | |
| encoding_format | EmbeddingEncodingFormat | De indeling waarin de insluitingen moeten worden geretourneerd. Base64, float, int8, uint8, binair of ubinair. Retourneert een 422-fout als het model de waarde of parameter niet ondersteunt. | |
| input_type | EmbeddingInputType | Het type invoer. Ofwel text, queryof document. Retourneert een 422-fout als het model de waarde of parameter niet ondersteunt. |
Antwoorden
| Name | Type | Description |
|---|---|---|
| 200 OK | CreateEmbeddingResponse | OK |
| 401 Onbevoegd | UnauthorizedError | Toegangstoken ontbreekt of is ongeldig Kopteksten x-ms-error-code: tekenreeks |
| 404 Niet gevonden | NotFoundError | Modaliteit wordt niet ondersteund door het model. Raadpleeg de documentatie van het model om te zien welke routes beschikbaar zijn. Kopteksten x-ms-error-code: tekenreeks |
| 422 Niet-verwerkte entiteit | UnprocessableContentError | De aanvraag bevat niet-verwerkte inhoud Kopteksten x-ms-error-code: tekenreeks |
| 429 Te veel aanvragen | TooManyRequestsError | U hebt uw toegewezen frequentielimiet bereikt en uw aanvraag moet worden aangepast. Kopteksten x-ms-error-code: tekenreeks |
| Overige statuscodes | ContentFilterError | Ongeldige aanvraag Kopteksten x-ms-error-code: tekenreeks |
Beveiliging
Autorisatie
Het token met de Bearer: prefix, bijvoorbeeld Bearer abcde12345
Type: apiKey In: header
AADToken
Azure Active Directory OAuth2-verificatie
Type: oauth2 Flow: URL van toepassingstoken:https://login.microsoftonline.com/common/oauth2/v2.0/token
Voorbeelden
Hiermee maakt u een insluitvector die de invoertekst vertegenwoordigt
Voorbeeldaanvraag
POST /embeddings?api-version=2024-04-01-preview
{
"input": [
"This is a very good text"
],
"input_type": "text",
"encoding_format": "float",
"dimensions": 1024
}
Voorbeeldantwoord
Statuscode: 200
{
"data": [
{
"index": 0,
"object": "embedding",
"embedding": [
0,
0,
0,
0,
0,
0,
0,
0,
0,
0,
0,
0
]
}
],
"object": "list",
"model": "BERT",
"usage": {
"prompt_tokens": 15,
"total_tokens": 15
}
}
Definities
| Name | Beschrijving |
|---|---|
| ContentFilterError | De API-aanroep mislukt wanneer de prompt een inhoudsfilter activeert zoals geconfigureerd. Wijzig de prompt en probeer het opnieuw. |
| CreateEmbeddingRequest | Aanvraag voor het maken van insluitingen. |
| CreateEmbeddingResponse | Antwoord van een insluitingsaanvraag. |
| Detail | Details van de fouten. |
| Insluiten | Vertegenwoordigt het insluitobject dat is gegenereerd. |
| EmbeddingEncodingFormat | De indeling waarin de insluitingen moeten worden geretourneerd. Base64, float, int8, uint8, binair of ubinair. Retourneert een 422-fout als het model de waarde of parameter niet ondersteunt. |
| EmbeddingInputType | Het type invoer. Ofwel text, queryof document. Retourneert een 422-fout als het model de waarde of parameter niet ondersteunt. |
| EmbeddingObject | Het objecttype, dat altijd 'insluiten' is. |
| ListObject | Het objecttype, dat altijd 'list' is. |
| NotFoundError | De route is niet geldig voor het geïmplementeerde model. |
| TooManyRequestsError | U hebt uw toegewezen frequentielimiet bereikt en uw aanvragen moeten worden aangepast. |
| UnauthorizedError | Verificatie ontbreekt of is ongeldig. |
| UnprocessableContentError | De aanvraag bevat niet-verwerkte inhoud. De fout wordt geretourneerd wanneer de aangegeven nettolading geldig is volgens deze specificatie. Sommige instructies die in de nettolading worden aangegeven, worden echter niet ondersteund door het onderliggende model. Gebruik de details sectie om inzicht te hebben in de offendingparameter. |
| Gebruik | De gebruiksgegevens voor de aanvraag. |
ContentFilterError
De API-aanroep mislukt wanneer de prompt een inhoudsfilter activeert zoals geconfigureerd. Wijzig de prompt en probeer het opnieuw.
| Name | Type | Description |
|---|---|---|
| code | tekenreeks | De foutcode. |
| error | tekenreeks | De foutbeschrijving. |
| bericht | tekenreeks | Het foutbericht. |
| param | tekenreeks | De parameter die het inhoudsfilter heeft geactiveerd. |
| status | geheel getal | De HTTP-statuscode. |
CreateEmbeddingRequest
Aanvraag voor het maken van insluitingen.
| Naam | Vereist | Type | Description |
|---|---|---|---|
| input | Waar | tekenreeks[] | Invoertekst voor insluiten, gecodeerd als een tekenreeks of matrix met tokens. Als u meerdere invoer in één aanvraag wilt insluiten, geeft u een matrix van tekenreeksen of matrix met tokenmatrices door. |
| dimensions | geheel getal | Het aantal dimensies dat de resulterende uitvoer-insluitingen moeten hebben. Retourneert een 422-fout als het model de waarde of parameter niet ondersteunt. | |
| encoding_format | EmbeddingEncodingFormat | De indeling waarin de insluitingen moeten worden geretourneerd. Base64, float, int8, uint8, binair of ubinair. Retourneert een 422-fout als het model de waarde of parameter niet ondersteunt. | |
| input_type | EmbeddingInputType | Het type invoer. Ofwel text, queryof document. Retourneert een 422-fout als het model de waarde of parameter niet ondersteunt. |
CreateEmbeddingResponse
Antwoord van een insluitingsaanvraag.
| Name | Type | Description |
|---|---|---|
| gegevens | Insluiten[] | De lijst met insluitingen die door het model worden gegenereerd. |
| model | tekenreeks | De naam van het model dat wordt gebruikt voor het genereren van de insluiting. |
| object | ListObject | Het objecttype, dat altijd 'list' is. |
| gebruikt | Gebruik | De gebruiksgegevens voor de aanvraag. |
Detail
Details voor de fout UnprocessableContentError .
| Name | Type | Description |
|---|---|---|
| LOC | tekenreeks[] | De parameter die het probleem veroorzaakt |
| waarde | tekenreeks | De waarde die is doorgegeven aan de parameter die problemen veroorzaakt. |
Insluiten
Vertegenwoordigt de gegenereerde insluiting.
| Name | Type | Description |
|---|---|---|
| Insluiten | [] | De insluitvector. De lengte van de vector is afhankelijk van het gebruikte model en het type is afhankelijk van de encoding_format gebruikte. |
| index | geheel getal | De index van de insluiting in de lijst met insluitingen. |
| object | EmbeddingObject | Het objecttype, dat altijd 'insluiten' is. |
EmbeddingEncodingFormat
De indeling waarin de insluitingen moeten worden geretourneerd. Base64, float, int8, uint8, binair of ubinair. Retourneert een 422-fout als het model de waarde of parameter niet ondersteunt.
| Name | Type | Description |
|---|---|---|
| base64 | tekenreeks | |
| binair | tekenreeks | |
| zwevend | tekenreeks | |
| int8 | tekenreeks | |
| ubinary | tekenreeks | |
| uint8 | tekenreeks |
EmbeddingInputType
Het type invoer. Ofwel text, queryof document. Retourneert een 422-fout als het model de waarde of parameter niet ondersteunt.
| Name | Type | Description |
|---|---|---|
| document | tekenreeks | Hiermee wordt aangegeven dat de invoer een document vertegenwoordigt dat is opgeslagen in een vectordatabase. |
| query | tekenreeks | Hiermee wordt aangegeven dat de invoer een zoekquery vertegenwoordigt om de meest relevante documenten in uw vectordatabase te vinden. |
| sms verzenden | tekenreeks | Geeft aan dat de invoer een algemene tekstinvoer is. |
EmbeddingObject
| Name | Type | Description |
|---|---|---|
| Insluiten | tekenreeks |
ListObject
Het objecttype, dat altijd 'list' is.
| Name | Type | Omschrijving |
|---|---|---|
| lijst | tekenreeks |
NotFoundError
| Name | Type | Description |
|---|---|---|
| error | tekenreeks | De foutbeschrijving. |
| bericht | tekenreeks | Het foutbericht. |
| status | geheel getal | De HTTP-statuscode. |
TooManyRequestsError
| Name | Type | Description |
|---|---|---|
| error | tekenreeks | De foutbeschrijving. |
| bericht | tekenreeks | Het foutbericht. |
| status | geheel getal | De HTTP-statuscode. |
UnauthorizedError
| Name | Type | Description |
|---|---|---|
| error | tekenreeks | De foutbeschrijving. |
| bericht | tekenreeks | Het foutbericht. |
| status | geheel getal | De HTTP-statuscode. |
UnprocessableContentError
De aanvraag bevat niet-verwerkte inhoud. De fout wordt geretourneerd wanneer de aangegeven nettolading geldig is volgens deze specificatie. Sommige instructies die in de nettolading worden aangegeven, worden echter niet ondersteund door het onderliggende model. Gebruik de details sectie om inzicht te hebben in de offendingparameter.
| Name | Type | Description |
|---|---|---|
| code | tekenreeks | De foutcode. |
| gedetailleerd | Detail | |
| error | tekenreeks | De foutbeschrijving. |
| bericht | tekenreeks | Het foutbericht. |
| status | geheel getal | De HTTP-statuscode. |
Gebruik
De gebruiksgegevens voor de aanvraag.
| Name | Type | Description |
|---|---|---|
| prompt_tokens | geheel getal | Het aantal tokens dat door de prompt wordt gebruikt. |
| total_tokens | geheel getal | Het totale aantal tokens dat door de aanvraag wordt gebruikt. |