Analyzer - Analyze Business Card

Tjänst:

Azure AI Services

API-version:

2.1

Extrahera fälttext och semantiska värden från ett visst visitkortsdokument. Indatadokumentet måste ha någon av de innehållstyper som stöds – "application/pdf", "image/jpeg", "image/png", "image/tiff" eller "image/bmp". Du kan också använda typen "application/json" för att ange platsen (URI) för dokumentet som ska analyseras.

POST {endpoint}/formrecognizer/v2.1/prebuilt/businessCard/analyze

Med valfria parametrar:

POST {endpoint}/formrecognizer/v2.1/prebuilt/businessCard/analyze?includeTextDetails={includeTextDetails}&locale={locale}&pages={pages}

URI-parametrar

Name	I	Obligatorisk	Typ	Description
endpoint	path	True	string	Cognitive Services-slutpunkter som stöds (protokoll och värdnamn, till exempel: https://westus2.api.cognitive.microsoft.com).
includeTextDetails	query		boolean	Inkludera textrader och elementreferenser i resultatet.
locale	query		Locale	Nationella inställningar för indatadokumentet. Språk som stöds är: en-AU, en-CA, en-GB, en-IN, en-US(standard).
pages	query		string[]	Anpassade sidnummer för flersidiga dokument (PDF/TIFF), anger antalet sidor som du vill få OCR-resultat. Använd ett bindestreck för ett antal sidor. Avgränsa varje sida eller intervall med kommatecken.

Begärandehuvud

Media Types: "application/pdf", "application/json", "image/jpeg", "image/png", "image/tiff", "image/bmp"

Name	Obligatorisk	Typ	Description
Ocp-Apim-Subscription-Key	True	string

Begärandetext

Media Types: "application/pdf", "application/json", "image/jpeg", "image/png", "image/tiff", "image/bmp"

Name	Typ	Description
source	string	Sökväg till filkälla.

Svar

Name	Typ	Description
202 Accepted		Begäran har placerats i kö. Sidhuvuden Operation-Location: string
Other Status Codes	ErrorResponse	Svarsentitet som medföljer icke-lyckade svar som innehåller ytterligare information om felet.

Säkerhet

Ocp-Apim-Subscription-Key

Typ: apiKey
I: header

Exempel

Analyze Business Card

Exempelbegäran

HTTP

POST {endpoint}/formrecognizer/v2.1/prebuilt/businessCard/analyze

Exempelsvar

Statuskod:

202

Operation-Location: {endpoint}/formrecognizer/v2.1/prebuilt/businessCard/analyzeResults/3b1e6c5b-e113-4114-ab6b-ce65dfe8050f

Definitioner

Name	Description
ErrorInformation
ErrorResponse
Locale	Nationella inställningar för indatadokumentet. Språk som stöds är: en-AU, en-CA, en-GB, en-IN, en-US(standard).
SourcePath	URI eller lokal sökväg till källdata.

ErrorInformation

Name	Typ	Description
code	string
message	string

ErrorResponse

Name	Typ	Description
error	ErrorInformation

Locale

Nationella inställningar för indatadokumentet. Språk som stöds är: en-AU, en-CA, en-GB, en-IN, en-US(standard).

Name	Typ	Description
en-AU	string
en-CA	string
en-GB	string
en-IN	string
en-US	string

SourcePath

URI eller lokal sökväg till källdata.

Name	Typ	Description
source	string	Sökväg till filkälla.