Analyzers - Get Result

Service:

Azure AI Services

API-versie:

2024-12-01-preview

Haal het resultaat van een analysebewerking op.

GET {endpoint}/contentunderstanding/analyzers/{analyzerId}/results/{operationId}?api-version=2024-12-01-preview

URI-parameters

Name	In	Vereist	Type	Description
analyzerId	path	True	string	Analyse-id.
endpoint	path	True	string (uri)	Content Understanding-service-eindpunt.
operationId	path	True	string	De unieke id van de bewerking.
api-version	query	True	string minLength: 1	De API-versie die voor deze bewerking moet worden gebruikt.

Antwoorden

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

Beveiliging

Ocp-Apim-Subscription-Key

Type: apiKey
In: header

OAuth2Auth

Type: oauth2
Stroom: accessCode
Autorisatie-URL: https://login.microsoftonline.com/common/oauth2/authorize
Token-URL: https://login.microsoftonline.com/common/oauth2/token

Bereiken

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

Voorbeelden

Get Analysis Result

Voorbeeldaanvraag

HTTP

GET {endpoint}/contentunderstanding/analyzers/myAnalyzer/results/3b31320d-8bab-4f88-b19c-2322a7f11034?api-version=2024-12-01-preview

Voorbeeldrespons

Statuscode:

200

{
  "id": "3b31320d-8bab-4f88-b19c-2322a7f11034",
  "status": "Succeeded",
  "result": {
    "analyzerId": "myAnalyzer",
    "apiVersion": "2024-12-01-preview",
    "createdAt": "2024-10-14T18:46:36.244Z",
    "contents": [
      {
        "kind": "document",
        "markdown": "# CONTOSO\n\n...",
        "startPageNumber": 1,
        "endPageNumber": 2,
        "unit": "inch",
        "pages": [
          {
            "pageNumber": 1,
            "width": 8.5,
            "height": 11
          },
          {
            "pageNumber": 2,
            "width": 8.5,
            "height": 11
          }
        ],
        "fields": {
          "Company": {
            "type": "string",
            "valueString": "CONTOSO",
            "spans": [
              {
                "offset": 7,
                "length": 2
              }
            ],
            "confidence": 0.95,
            "source": "D(1,5,1,7,1,7,1.5,5,1.5)"
          }
        }
      }
    ]
  }
}

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 richtlijnen voor Microsoft One-API- https://github.com/Microsoft/api-guidelines/blob/vNext/Guidelines.md#7102-error-condition-responses.

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 richtlijnen voor Microsoft One-API- https://github.com/Microsoft/api-guidelines/blob/vNext/Guidelines.md#7102-error-condition-responses.

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