Face Recognition Operations - Find Similar From Large Face List

Service:

Azure AI Services

API Version:

v1.1-preview.1

Angivet faceId för frågeansiktet för att söka i liknande ansikten från en stor ansiktslista. Ett "largeFaceListId" skapas av Skapa stor ansiktslista.
Beroende på indata innehåller den returnerade liknande ansiktslistan faceIds eller persistedFaceIds rangordnade efter likhet.

Hitta liknande har två arbetslägen, "matchPerson" och "matchFace". "matchPerson" är standardläget där det försöker hitta ansikten för samma person som möjligt med hjälp av interna tröskelvärden för samma person. Det är användbart att hitta en känd persons andra foton. Observera att en tom lista returneras om inga ansikten överskrider de interna tröskelvärdena. Läget "matchFace" ignorerar tröskelvärden för samma person och returnerar rankade liknande ansikten ändå, även likheten är låg. Det kan användas i fall som att söka i kändisliknande ansikten.

"recognitionModel" som är associerad med frågans faceId ska vara samma som "recognitionModel" som används av målets stora ansiktslista.

POST {endpoint}/face/{apiVersion}/findsimilars

URI-parametrar

Name	I	Obligatorisk	Typ	Description
apiVersion	path	True	string	API-version
endpoint	path	True	string uri	Cognitive Services-slutpunkter som stöds (protokoll och värdnamn, till exempel: https://{resource-name}.cognitiveservices.azure.com).

Begärandetext

Name	Obligatorisk	Typ	Description
faceId	True	string	faceId för frågans ansikte. Användaren måste anropa "Detect" först för att få ett giltigt faceId. Observera att detta faceId inte är beständiga och upphör att gälla 24 timmar efter identifieringsanropet.
largeFaceListId	True	string	En befintlig användardefinerad unik kandidat stor ansiktslista, skapad i "Skapa stor ansiktslista". En stor ansiktslista innehåller en uppsättning persistedFaceIds som sparas och aldrig upphör att gälla.
maxNumOfCandidatesReturned		integer	Antalet ansikten som liknar de vanligaste som returneras. Det giltiga intervallet är [1, 1000]. Standardvärdet är 20.
mode		FindSimilarMatchMode	Liknande ansiktssökningsläge. Det kan vara "matchPerson" eller "matchFace". Standardvärdet är "matchPerson".

Svar

Name	Typ	Description
200 OK	FindSimilarResult[]	Ett lyckat anrop returnerar en matris med de mest liknande ansikten som representeras i faceId om indataparametern är faceIds eller persistedFaceId om indataparametern är faceListId eller largeFaceListId.
Other Status Codes	FaceErrorResponse	Ett oväntat felsvar. Headers x-ms-error-code: string

Säkerhet

Ocp-Apim-Subscription-Key

Den hemliga nyckeln för din Ansiktsprenumeration på Azure AI.

Type: apiKey
In: header

AADToken

Azure Active Directory OAuth2-flödet

Type: oauth2
Flow: accessCode
Authorization URL: https://api.example.com/oauth2/authorize
Token URL: https://api.example.com/oauth2/token

Scopes

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

Exempel

Find Similar from LargeFaceList

Sample Request

HTTP

POST {endpoint}/face/v1.1-preview.1/findsimilars

{
  "faceId": "c5c24a82-6845-4031-9d5d-978df9175426",
  "maxNumOfCandidatesReturned": 3,
  "mode": "matchPerson",
  "largeFaceListId": "your_large_face_list_id"
}

Sample Response

Status code:

200

[
  {
    "confidence": 0.8,
    "faceId": "015839fb-fbd9-4f79-ace9-7675fc2f1dd9"
  }
]

Definitioner

Name	Description
FaceError	Felobjektet. Omfattande information om felkoder och meddelanden som returneras av ansiktstjänsten finns på följande länk: https://aka.ms/face-error-codes-and-messages.
FaceErrorResponse	Ett svar som innehåller felinformation.
FindSimilarResult	Svarstext för att hitta liknande ansiktsoperation.

FaceError

Felobjektet. Omfattande information om felkoder och meddelanden som returneras av ansiktstjänsten finns på följande länk: https://aka.ms/face-error-codes-and-messages.

Name	Typ	Description
code	string	En av en serverdefinierad uppsättning felkoder.
message	string	En mänsklig läsbar representation av felet.

FaceErrorResponse

Ett svar som innehåller felinformation.

Name	Typ	Description
error	FaceError	Felobjektet.

FindSimilarResult

Svarstext för att hitta liknande ansiktsoperation.

Name	Typ	Description
confidence	number	Förtroendevärde för kandidaten. Ju högre konfidens, desto mer lika. Intervall mellan [0,1].
faceId	string	faceId för kandidat ansikte när hittas av faceIds. faceId skapas av "Detect" och upphör att gälla 24 timmar efter identifieringsanropet.
persistedFaceId	string	persistedFaceId för kandidatansiktet när det hittas av faceListId eller largeFaceListId. persistedFaceId i ansiktslistan/den stora ansiktslistan sparas och upphör inte att gälla.