Text Analysis Runtime - Analyze Text

Tjänst:

Azure AI Services

API-version:

2024-11-01

Begär textanalys över en samling dokument.

POST {Endpoint}/language/:analyze-text?api-version=2024-11-01

Med valfria parametrar:

POST {Endpoint}/language/:analyze-text?api-version=2024-11-01&showStats={showStats}

URI-parametrar

Name	I	Obligatorisk	Typ	Description
Endpoint	path	True	string	Cognitive Services-slutpunkt som stöds (t.ex. https://.api.cognitiveservices.azure.com).
api-version	query	True	string minLength: 1	DEN API-version som ska användas för den här åtgärden.
showStats	query		boolean	(Valfritt) om det är inställt på sant innehåller svaret statistik på begäran och dokumentnivå.

Begärandetext

Brödtexten i begäran kan vara något av följande:

Name	Description
AnalyzeTextEntityLinkingInput	Innehåller analystexten Entitetslänkningsindata.
AnalyzeTextEntityRecognitionInput	Entitetsigenkänningen analyserar uppgiftsbegäran för textinmatning.
AnalyzeTextKeyPhraseExtractionInput	Innehåller indata för att analysera texten KeyPhraseExtraction-uppgift.
AnalyzeTextLanguageDetectionInput	Innehåller indata för språkidentifieringsdokumentanalys.
AnalyzeTextPiiEntitiesRecognitionInput	Innehåller indata för att analysera text-PIIEntityRecognition-uppgift.
AnalyzeTextSentimentAnalysisInput	Innehåller analystexten SentimentAnalysis uppgiftsindata.

AnalyzeTextEntityLinkingInput

Innehåller analystexten Entitetslänkningsindata.

Name	Obligatorisk	Typ	Description
kind	True	string: EntityLinking	Den typ av uppgift som ska utföras.
analysisInput		MultiLanguageAnalysisInput	Innehåller de analysindata som ska hanteras av tjänsten.
parameters		EntityLinkingTaskParameters	Uppgiftsparametrar.

AnalyzeTextEntityRecognitionInput

Entitetsigenkänningen analyserar uppgiftsbegäran för textinmatning.

Name	Obligatorisk	Typ	Description
kind	True	string: EntityRecognition	Den typ av uppgift som ska utföras.
analysisInput		MultiLanguageAnalysisInput	Indata som ska analyseras.
parameters		EntitiesTaskParameters	Uppgiftsparametrar.

AnalyzeTextKeyPhraseExtractionInput

Innehåller indata för att analysera texten KeyPhraseExtraction-uppgift.

Name	Obligatorisk	Typ	Description
kind	True	string: KeyPhraseExtraction	Den typ av uppgift som ska utföras.
analysisInput		MultiLanguageAnalysisInput	Innehåller indatadokumenten.
parameters		KeyPhraseTaskParameters	Parametrar för extrahering av nyckelfraser.

AnalyzeTextLanguageDetectionInput

Innehåller indata för språkidentifieringsdokumentanalys.

Name	Obligatorisk	Typ	Description
kind	True	string: LanguageDetection	Den typ av uppgift som ska utföras.
analysisInput		LanguageDetectionAnalysisInput	Dokument som ska analyseras.
parameters		LanguageDetectionTaskParameters	aktivitetsparametrar.

AnalyzeTextPiiEntitiesRecognitionInput

Innehåller indata för att analysera text-PIIEntityRecognition-uppgift.

Name	Obligatorisk	Typ	Description
kind	True	string: PiiEntityRecognition	Den typ av uppgift som ska utföras.
analysisInput		MultiLanguageAnalysisInput	Innehåller indatadokumenten.
parameters		PiiTaskParameters	Pii-aktivitetsparametrar.

AnalyzeTextSentimentAnalysisInput

Innehåller analystexten SentimentAnalysis uppgiftsindata.

Name	Obligatorisk	Typ	Description
kind	True	string: SentimentAnalysis	Den typ av uppgift som ska utföras.
analysisInput		MultiLanguageAnalysisInput	Innehåller indatadokumenten.
parameters		SentimentAnalysisTaskParameters	Aktivitetsparametrar för attitydanalys.

Svar

Name	Typ	Description
200 OK	AnalyzeTextTaskResult: EntitiesTaskResult EntityLinkingTaskResult KeyPhraseTaskResult LanguageDetectionTaskResult PiiTaskResult SentimentTaskResult	Begäran har slutförts.
Other Status Codes	ErrorResponse	Ett oväntat felsvar. Sidhuvuden x-ms-error-code: string

Säkerhet

Ocp-Apim-Subscription-Key

Typ: apiKey
I: header

OAuth2Auth

Typ: oauth2
Flow: accessCode
Auktoriseringswebbadress: https://login.microsoftonline.com/common/oauth2/authorize
Token-webbadress: https://login.microsoftonline.com/common/oauth2/token

Omfattningar

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

Exempel

SuccessfulEntityLinkingRequest

SuccessfulEntityRecognitionExclusionRequest

SuccessfulEntityRecognitionInclusionRequest

SuccessfulEntityRecognitionInferenceOptionsRequest

SuccessfulEntityRecognitionOverlapPolicy

SuccessfulEntityRecognitionRequest

SuccessfulKeyPhraseExtractionRequest

SuccessfulLanguageDetectionRequest

SuccessfulPiiEntityRecognitionRequest

SuccessfulSentimentAnalysisRequest

SuccessfulEntityLinkingRequest

Exempelbegäran

HTTP

POST {Endpoint}/language/:analyze-text?api-version=2024-11-01

{
  "kind": "EntityLinking",
  "parameters": {
    "modelVersion": "latest"
  },
  "analysisInput": {
    "documents": [
      {
        "id": "1",
        "language": "en",
        "text": "Microsoft was founded by Bill Gates and Paul Allen."
      },
      {
        "id": "2",
        "language": "en",
        "text": "Pike place market is my favorite Seattle attraction."
      }
    ]
  }
}

Exempelsvar

Statuskod:

200

{
  "kind": "EntityLinkingResults",
  "results": {
    "documents": [
      {
        "entities": [
          {
            "dataSource": "Wikipedia",
            "id": "Bill Gates",
            "language": "en",
            "matches": [
              {
                "confidenceScore": 0.52,
                "length": 10,
                "offset": 25,
                "text": "Bill Gates"
              }
            ],
            "name": "Bill Gates",
            "url": "https://en.wikipedia.org/wiki/Bill_Gates"
          },
          {
            "dataSource": "Wikipedia",
            "id": "Paul Allen",
            "language": "en",
            "matches": [
              {
                "confidenceScore": 0.54,
                "length": 10,
                "offset": 40,
                "text": "Paul Allen"
              }
            ],
            "name": "Paul Allen",
            "url": "https://en.wikipedia.org/wiki/Paul_Allen"
          },
          {
            "dataSource": "Wikipedia",
            "id": "Microsoft",
            "language": "en",
            "matches": [
              {
                "confidenceScore": 0.49,
                "length": 9,
                "offset": 0,
                "text": "Microsoft"
              }
            ],
            "name": "Microsoft",
            "url": "https://en.wikipedia.org/wiki/Microsoft"
          }
        ],
        "id": "1",
        "warnings": []
      },
      {
        "entities": [
          {
            "dataSource": "Wikipedia",
            "id": "Pike Place Market",
            "language": "en",
            "matches": [
              {
                "confidenceScore": 0.86,
                "length": 17,
                "offset": 0,
                "text": "Pike place market"
              }
            ],
            "name": "Pike Place Market",
            "url": "https://en.wikipedia.org/wiki/Pike_Place_Market"
          },
          {
            "dataSource": "Wikipedia",
            "id": "Seattle",
            "language": "en",
            "matches": [
              {
                "confidenceScore": 0.27,
                "length": 7,
                "offset": 33,
                "text": "Seattle"
              }
            ],
            "name": "Seattle",
            "url": "https://en.wikipedia.org/wiki/Seattle"
          }
        ],
        "id": "2",
        "warnings": []
      }
    ],
    "errors": [],
    "modelVersion": "2020-02-01"
  }
}

SuccessfulEntityRecognitionExclusionRequest

Exempelbegäran

HTTP

POST {Endpoint}/language/:analyze-text?api-version=2024-11-01

{
  "kind": "EntityRecognition",
  "parameters": {
    "modelVersion": "latest",
    "exclusionList": [
      "Numeric"
    ],
    "overlapPolicy": {
      "policyKind": "allowOverlap"
    }
  },
  "analysisInput": {
    "documents": [
      {
        "id": "2",
        "language": "en",
        "text": "When I was 5 years old I had $90.00 dollars to my name."
      },
      {
        "id": "3",
        "language": "en",
        "text": "When we flew from LAX it seemed like we were moving at 10 meters per second. I was lucky to see Amsterdam, Effile Tower, and the Nile."
      }
    ]
  }
}

Exempelsvar

Statuskod:

200

{
  "kind": "EntityRecognitionResults",
  "results": {
    "documents": [
      {
        "entities": [],
        "id": "2",
        "warnings": []
      },
      {
        "entities": [
          {
            "text": "LAX",
            "category": "Location",
            "type": "Airport",
            "offset": 18,
            "length": 3,
            "confidenceScore": 0.72,
            "tags": [
              {
                "name": "Location",
                "confidenceScore": 0.9
              },
              {
                "name": "Structural",
                "confidenceScore": 0.72
              }
            ]
          },
          {
            "text": "Amsterdam",
            "category": "Location",
            "type": "City",
            "offset": 96,
            "length": 9,
            "confidenceScore": 0.8,
            "tags": [
              {
                "name": "Location",
                "confidenceScore": 0.84
              },
              {
                "name": "GPE",
                "confidenceScore": 0.84
              },
              {
                "name": "City",
                "confidenceScore": 0.8
              }
            ]
          },
          {
            "text": "Eiffel Tower",
            "category": "Location",
            "type": "Structural",
            "offset": 107,
            "length": 12,
            "confidenceScore": 0.9,
            "tags": [
              {
                "name": "Location",
                "confidenceScore": 0.9
              },
              {
                "name": "Structural",
                "confidenceScore": 0.9
              }
            ]
          },
          {
            "text": "Nile",
            "category": "Location",
            "type": "Geological",
            "offset": 129,
            "length": 4,
            "confidenceScore": 0.63,
            "tags": [
              {
                "name": "Location",
                "confidenceScore": 0.9
              },
              {
                "name": "Geological",
                "confidenceScore": 0.63
              }
            ]
          }
        ],
        "id": "3",
        "warnings": []
      }
    ],
    "errors": [],
    "modelVersion": "2021-06-01"
  }
}

SuccessfulEntityRecognitionInclusionRequest

Exempelbegäran

HTTP

POST {Endpoint}/language/:analyze-text?api-version=2024-11-01

{
  "kind": "EntityRecognition",
  "parameters": {
    "modelVersion": "latest",
    "inclusionList": [
      "Location"
    ]
  },
  "analysisInput": {
    "documents": [
      {
        "id": "2",
        "language": "en",
        "text": "When I was 5 years old I had $90.00 dollars to my name."
      },
      {
        "id": "3",
        "language": "en",
        "text": "When we flew from LAX it seemed like we were moving at 10 meters per second. I was lucky to see Amsterdam, Effile Tower, and the Nile."
      }
    ]
  }
}

Exempelsvar

Statuskod:

200

{
  "kind": "EntityRecognitionResults",
  "results": {
    "documents": [
      {
        "entities": [],
        "id": "2",
        "warnings": []
      },
      {
        "entities": [
          {
            "text": "LAX",
            "category": "Location",
            "type": "Structural",
            "offset": 18,
            "length": 3,
            "confidenceScore": 0.72,
            "tags": [
              {
                "name": "Location",
                "confidenceScore": 0.9
              },
              {
                "name": "Structural",
                "confidenceScore": 0.72
              }
            ]
          },
          {
            "text": "Amsterdam",
            "category": "Location",
            "type": "City",
            "offset": 96,
            "length": 9,
            "confidenceScore": 0.8,
            "tags": [
              {
                "name": "Location",
                "confidenceScore": 0.84
              },
              {
                "name": "GPE",
                "confidenceScore": 0.84
              },
              {
                "name": "City",
                "confidenceScore": 0.8
              }
            ]
          },
          {
            "text": "Eiffel Tower",
            "category": "Location",
            "type": "Structural",
            "offset": 107,
            "length": 12,
            "confidenceScore": 0.9,
            "tags": [
              {
                "name": "Location",
                "confidenceScore": 0.9
              },
              {
                "name": "Structural",
                "confidenceScore": 0.9
              }
            ]
          },
          {
            "text": "Nile",
            "category": "Location",
            "type": "Geological",
            "offset": 129,
            "length": 4,
            "confidenceScore": 0.63,
            "tags": [
              {
                "name": "Location",
                "confidenceScore": 0.9
              },
              {
                "name": "Geological",
                "confidenceScore": 0.63
              }
            ]
          }
        ],
        "id": "3",
        "warnings": []
      }
    ],
    "errors": [],
    "modelVersion": "2021-06-01"
  }
}

SuccessfulEntityRecognitionInferenceOptionsRequest

Exempelbegäran

HTTP

POST {Endpoint}/language/:analyze-text?api-version=2024-11-01

{
  "kind": "EntityRecognition",
  "parameters": {
    "modelVersion": "latest",
    "inferenceOptions": {
      "excludeNormalizedValues": true
    }
  },
  "analysisInput": {
    "documents": [
      {
        "id": "1",
        "language": "en",
        "text": "When I was 5 years old I had $90.00 dollars to my name."
      }
    ]
  }
}

Exempelsvar

Statuskod:

200

{
  "kind": "EntityRecognitionResults",
  "results": {
    "documents": [
      {
        "entities": [
          {
            "text": "5 years old",
            "category": "Numeric",
            "type": "Age",
            "offset": 11,
            "length": 11,
            "confidenceScore": 0.99,
            "tags": [
              {
                "name": "Numeric",
                "confidenceScore": 0.99
              },
              {
                "name": "Age",
                "confidenceScore": 0.99
              }
            ]
          },
          {
            "text": "$90.00",
            "category": "Numeric",
            "type": "Currency",
            "offset": 29,
            "length": 14,
            "confidenceScore": 0.99,
            "tags": [
              {
                "name": "Numeric",
                "confidenceScore": 0.99
              },
              {
                "name": "Currency",
                "confidenceScore": 0.99
              }
            ]
          }
        ],
        "id": "1",
        "warnings": []
      }
    ],
    "errors": [],
    "modelVersion": "2023-09-01"
  }
}

SuccessfulEntityRecognitionOverlapPolicy

Exempelbegäran

HTTP

POST {Endpoint}/language/:analyze-text?api-version=2024-11-01

{
  "kind": "EntityRecognition",
  "parameters": {
    "modelVersion": "latest",
    "overlapPolicy": {
      "policyKind": "matchLongest"
    }
  },
  "analysisInput": {
    "documents": [
      {
        "id": "4",
        "language": "en",
        "text": "25th April Meeting was an intresting one. At least we gont to experience the WorldCup"
      }
    ]
  }
}

Exempelsvar

Statuskod:

200

{
  "kind": "EntityRecognitionResults",
  "results": {
    "documents": [
      {
        "entities": [
          {
            "text": "25th April Meeting",
            "category": "Event",
            "type": "Event",
            "offset": 0,
            "length": 18,
            "confidenceScore": 0.59,
            "tags": [
              {
                "name": "Event",
                "confidenceScore": 0.59
              }
            ]
          },
          {
            "text": "Worldcup",
            "category": "Event",
            "type": "SportsEvent",
            "offset": 0,
            "length": 8,
            "confidenceScore": 0.51,
            "tags": [
              {
                "name": "Event",
                "confidenceScore": 0.55
              },
              {
                "name": "SportsEvent",
                "confidenceScore": 0.51
              }
            ]
          }
        ],
        "id": "4",
        "warnings": []
      }
    ],
    "errors": [],
    "modelVersion": "2021-06-01"
  }
}

SuccessfulEntityRecognitionRequest

Exempelbegäran

HTTP

POST {Endpoint}/language/:analyze-text?api-version=2024-11-01

{
  "kind": "EntityRecognition",
  "parameters": {
    "modelVersion": "latest",
    "overlapPolicy": {
      "policyKind": "allowOverlap"
    }
  },
  "analysisInput": {
    "documents": [
      {
        "id": "2",
        "language": "en",
        "text": "When I was 5 years old I had $90.00 dollars to my name."
      },
      {
        "id": "3",
        "language": "en",
        "text": "When we flew from LAX it seemed like we were moving at 10 meters per second. I was lucky to see Amsterdam, Effile Tower, and the Nile."
      },
      {
        "id": "4",
        "language": "en",
        "text": "25th April Meeting was an intresting one. At least we gont to experience the WorldCup"
      },
      {
        "id": "5",
        "language": "en",
        "text": "My IP is 127.12.1.1 and my phone   number is 5555555555"
      }
    ]
  }
}

Exempelsvar

Statuskod:

200

{
  "kind": "EntityRecognitionResults",
  "results": {
    "documents": [
      {
        "entities": [
          {
            "text": "5 years old",
            "category": "Numeric",
            "type": "Age",
            "offset": 11,
            "length": 11,
            "confidenceScore": 0.99,
            "tags": [
              {
                "name": "Numeric",
                "confidenceScore": 0.99
              },
              {
                "name": "Age",
                "confidenceScore": 0.99
              }
            ],
            "metadata": {
              "metadataKind": "AgeMetadata",
              "unit": "Year",
              "value": 5
            }
          },
          {
            "text": "$90.00",
            "category": "Numeric",
            "type": "Currency",
            "offset": 29,
            "length": 14,
            "confidenceScore": 0.99,
            "tags": [
              {
                "name": "Numeric",
                "confidenceScore": 0.99
              },
              {
                "name": "Currency",
                "confidenceScore": 0.99
              }
            ],
            "metadata": {
              "metadataKind": "CurrencyMetadata",
              "unit": "Dollar",
              "iso4217": "USD",
              "value": 90
            }
          }
        ],
        "id": "2",
        "warnings": []
      },
      {
        "entities": [
          {
            "text": "LAX",
            "category": "Location",
            "type": "Structural",
            "offset": 18,
            "length": 3,
            "confidenceScore": 0.72,
            "tags": [
              {
                "name": "Location",
                "confidenceScore": 0.9
              },
              {
                "name": "Structural",
                "confidenceScore": 0.72
              }
            ]
          },
          {
            "text": "10 meters per second",
            "category": "Numeric",
            "type": "Speed",
            "offset": 55,
            "length": 20,
            "confidenceScore": 0.8,
            "tags": [
              {
                "name": "Dimension",
                "confidenceScore": 0.84
              },
              {
                "name": "Numeric",
                "confidenceScore": 0.84
              },
              {
                "name": "Speed",
                "confidenceScore": 0.8
              }
            ],
            "metadata": {
              "metadataKind": "SpeedMetadata",
              "unit": "MetersPerSecond",
              "value": 10
            }
          },
          {
            "text": "Amsterdam",
            "category": "Location",
            "type": "City",
            "offset": 96,
            "length": 9,
            "confidenceScore": 0.8,
            "tags": [
              {
                "name": "Location",
                "confidenceScore": 0.84
              },
              {
                "name": "GPE",
                "confidenceScore": 0.84
              },
              {
                "name": "City",
                "confidenceScore": 0.8
              }
            ]
          },
          {
            "text": "Eiffel Tower",
            "category": "Location",
            "type": "Structural",
            "offset": 107,
            "length": 12,
            "confidenceScore": 0.9,
            "tags": [
              {
                "name": "Location",
                "confidenceScore": 0.9
              },
              {
                "name": "Structural",
                "confidenceScore": 0.9
              }
            ]
          },
          {
            "text": "Nile",
            "category": "Location",
            "type": "Geological",
            "offset": 129,
            "length": 4,
            "confidenceScore": 0.63,
            "tags": [
              {
                "name": "Location",
                "confidenceScore": 0.9
              },
              {
                "name": "Geological",
                "confidenceScore": 0.63
              }
            ]
          }
        ],
        "id": "3",
        "warnings": []
      },
      {
        "entities": [
          {
            "text": "25th April",
            "category": "Temporal",
            "type": "Date",
            "offset": 0,
            "length": 10,
            "confidenceScore": 0.58,
            "tags": [
              {
                "name": "Temporal",
                "confidenceScore": 0.9
              },
              {
                "name": "Date",
                "confidenceScore": 0.58
              }
            ],
            "metadata": {
              "metadataKind": "DateMetadata",
              "dateValues": [
                {
                  "timex": "XXXX-04-25",
                  "value": "2022-04-25"
                },
                {
                  "timex": "XXXX-04-25",
                  "value": "2023-04-25"
                }
              ]
            }
          },
          {
            "text": "25th April Meeting",
            "category": "Event",
            "type": "Event",
            "offset": 0,
            "length": 18,
            "confidenceScore": 0.55,
            "tags": [
              {
                "name": "Event",
                "confidenceScore": 0.55
              }
            ]
          },
          {
            "text": "25th April Meeting",
            "category": "Event",
            "type": "CulturalEvent",
            "offset": 0,
            "length": 18,
            "confidenceScore": 0.55,
            "tags": [
              {
                "name": "Event",
                "confidenceScore": 0.55
              },
              {
                "name": "CulturalEvent",
                "confidenceScore": 0.55
              }
            ]
          },
          {
            "text": "Worldcup",
            "category": "Event",
            "type": "SportsEvent",
            "offset": 0,
            "length": 8,
            "confidenceScore": 0.51,
            "tags": [
              {
                "name": "Event",
                "confidenceScore": 0.55
              },
              {
                "name": "SportsEvent",
                "confidenceScore": 0.51
              }
            ]
          }
        ],
        "id": "4",
        "warnings": []
      },
      {
        "entities": [
          {
            "text": "127.12.1.1",
            "category": "IP",
            "type": "IP",
            "offset": 9,
            "length": 10,
            "confidenceScore": 0.8,
            "tags": [
              {
                "name": "IP",
                "confidenceScore": 0.8
              }
            ]
          },
          {
            "text": "5555555555",
            "category": "PhoneNumber",
            "type": "PhoneNumber",
            "offset": 45,
            "length": 9,
            "confidenceScore": 0.8,
            "tags": [
              {
                "name": "PhoneNumber",
                "confidenceScore": 0.8
              }
            ]
          }
        ],
        "id": "5",
        "warnings": []
      }
    ],
    "errors": [],
    "modelVersion": "2021-06-01"
  }
}

SuccessfulKeyPhraseExtractionRequest

Exempelbegäran

HTTP

POST {Endpoint}/language/:analyze-text?api-version=2024-11-01

{
  "kind": "KeyPhraseExtraction",
  "parameters": {
    "modelVersion": "latest"
  },
  "analysisInput": {
    "documents": [
      {
        "id": "1",
        "language": "en",
        "text": "Microsoft was founded by Bill Gates and Paul Allen."
      },
      {
        "id": "2",
        "language": "en",
        "text": "Text Analytics is one of the Azure Cognitive Services."
      },
      {
        "id": "3",
        "language": "en",
        "text": "My cat might need to see a veterinarian."
      }
    ]
  }
}

Exempelsvar

Statuskod:

200

{
  "kind": "KeyPhraseExtractionResults",
  "results": {
    "documents": [
      {
        "id": "1",
        "keyPhrases": [
          "Bill Gates",
          "Paul Allen",
          "Microsoft"
        ],
        "warnings": []
      },
      {
        "id": "2",
        "keyPhrases": [
          "Azure Cognitive Services",
          "Text Analytics"
        ],
        "warnings": []
      },
      {
        "id": "3",
        "keyPhrases": [
          "cat",
          "veterinarian"
        ],
        "warnings": []
      }
    ],
    "errors": [],
    "modelVersion": "2021-06-01"
  }
}

SuccessfulLanguageDetectionRequest

Exempelbegäran

HTTP

POST {Endpoint}/language/:analyze-text?api-version=2024-11-01

{
  "kind": "LanguageDetection",
  "parameters": {
    "modelVersion": "latest"
  },
  "analysisInput": {
    "documents": [
      {
        "id": "1",
        "text": "Hello world"
      },
      {
        "id": "2",
        "text": "Bonjour tout le monde"
      },
      {
        "id": "3",
        "text": "Hola mundo"
      },
      {
        "id": "4",
        "text": "Tumhara naam kya hai?"
      }
    ]
  }
}

Exempelsvar

Statuskod:

200

{
  "kind": "LanguageDetectionResults",
  "results": {
    "documents": [
      {
        "detectedLanguage": {
          "confidenceScore": 1,
          "iso6391Name": "en",
          "name": "English",
          "scriptName": "Latin",
          "scriptIso15924Code": "Latn"
        },
        "id": "1",
        "warnings": []
      },
      {
        "detectedLanguage": {
          "confidenceScore": 1,
          "iso6391Name": "fr",
          "name": "French",
          "scriptName": "Latin",
          "scriptIso15924Code": "Latn"
        },
        "id": "2",
        "warnings": []
      },
      {
        "detectedLanguage": {
          "confidenceScore": 1,
          "iso6391Name": "es",
          "name": "Spanish",
          "scriptName": "Latin",
          "scriptIso15924Code": "Latn"
        },
        "id": "3",
        "warnings": []
      },
      {
        "detectedLanguage": {
          "confidenceScore": 1,
          "iso6391Name": "hi",
          "name": "Hindi",
          "scriptName": "Latin",
          "scriptIso15924Code": "Latn"
        },
        "id": "4",
        "warnings": []
      }
    ],
    "errors": [],
    "modelVersion": "2023-12-01"
  }
}

SuccessfulPiiEntityRecognitionRequest

Exempelbegäran

HTTP

POST {Endpoint}/language/:analyze-text?api-version=2024-11-01

{
  "kind": "PiiEntityRecognition",
  "parameters": {
    "modelVersion": "latest"
  },
  "analysisInput": {
    "documents": [
      {
        "id": "1",
        "language": "en",
        "text": "My SSN is 859-98-0987"
      },
      {
        "id": "2",
        "language": "en",
        "text": "Your ABA number - 111000025 - is the first 9 digits in the lower left hand corner of your personal check."
      },
      {
        "id": "3",
        "language": "en",
        "text": "Is 998.214.865-68 your Brazilian CPF number?"
      }
    ]
  }
}

Exempelsvar

Statuskod:

200

{
  "kind": "PiiEntityRecognitionResults",
  "results": {
    "documents": [
      {
        "id": "1",
        "redactedText": "My SSN is ***********",
        "entities": [
          {
            "category": "USSocialSecurityNumber",
            "confidenceScore": 0.65,
            "length": 11,
            "offset": 28,
            "text": "859-98-0987"
          }
        ],
        "warnings": []
      },
      {
        "id": "2",
        "redactedText": "Your ABA number - ********* - is the first 9 digits in the lower left hand corner of your personal check.",
        "entities": [
          {
            "category": "ABARoutingNumber",
            "confidenceScore": 0.75,
            "length": 9,
            "offset": 18,
            "text": "111000025"
          }
        ],
        "warnings": []
      },
      {
        "id": "3",
        "redactedText": "Is ************** your Brazilian CPF number?",
        "entities": [
          {
            "category": "BRCPFNumber",
            "confidenceScore": 0.85,
            "length": 14,
            "offset": 3,
            "text": "998.214.865-68"
          }
        ],
        "warnings": []
      }
    ],
    "errors": [],
    "modelVersion": "2021-01-15"
  }
}

SuccessfulSentimentAnalysisRequest

Exempelbegäran

HTTP

POST {Endpoint}/language/:analyze-text?api-version=2024-11-01

{
  "kind": "SentimentAnalysis",
  "parameters": {
    "modelVersion": "latest"
  },
  "analysisInput": {
    "documents": [
      {
        "id": "1",
        "language": "en",
        "text": "Great atmosphere. Close to plenty of restaurants, hotels, and transit! Staff are friendly and helpful."
      }
    ]
  }
}

Exempelsvar

Statuskod:

200

{
  "kind": "SentimentAnalysisResults",
  "results": {
    "documents": [
      {
        "confidenceScores": {
          "negative": 0,
          "neutral": 0,
          "positive": 1
        },
        "id": "1",
        "sentences": [
          {
            "targets": [
              {
                "confidenceScores": {
                  "negative": 0,
                  "positive": 1
                },
                "length": 10,
                "offset": 6,
                "relations": [
                  {
                    "ref": "#/documents/0/sentences/0/assessments/0",
                    "relationType": "assessment"
                  }
                ],
                "sentiment": "positive",
                "text": "atmosphere"
              }
            ],
            "confidenceScores": {
              "negative": 0,
              "neutral": 0,
              "positive": 1
            },
            "length": 17,
            "offset": 0,
            "assessments": [
              {
                "confidenceScores": {
                  "negative": 0,
                  "positive": 1
                },
                "isNegated": false,
                "length": 5,
                "offset": 0,
                "sentiment": "positive",
                "text": "great"
              }
            ],
            "sentiment": "positive",
            "text": "Great atmosphere."
          },
          {
            "targets": [
              {
                "confidenceScores": {
                  "negative": 0.01,
                  "positive": 0.99
                },
                "length": 11,
                "offset": 37,
                "relations": [
                  {
                    "ref": "#/documents/0/sentences/1/assessments/0",
                    "relationType": "assessment"
                  }
                ],
                "sentiment": "positive",
                "text": "restaurants"
              },
              {
                "confidenceScores": {
                  "negative": 0.01,
                  "positive": 0.99
                },
                "length": 6,
                "offset": 50,
                "relations": [
                  {
                    "ref": "#/documents/0/sentences/1/assessments/0",
                    "relationType": "assessment"
                  }
                ],
                "sentiment": "positive",
                "text": "hotels"
              }
            ],
            "confidenceScores": {
              "negative": 0.01,
              "neutral": 0.86,
              "positive": 0.13
            },
            "length": 52,
            "offset": 18,
            "assessments": [
              {
                "confidenceScores": {
                  "negative": 0.01,
                  "positive": 0.99
                },
                "isNegated": false,
                "length": 15,
                "offset": 18,
                "sentiment": "positive",
                "text": "Close to plenty"
              }
            ],
            "sentiment": "neutral",
            "text": "Close to plenty of restaurants, hotels, and transit!"
          }
        ],
        "sentiment": "positive",
        "warnings": []
      }
    ],
    "errors": [],
    "modelVersion": "2021-10-01"
  }
}

Definitioner

Name	Description
AgeMetadata	Representerar modellen För entitetsmetadata för ålder.
AgeUnit	Enheten för åldersmätning
AllowOverlapEntityPolicyType	Representerar principen tillåt överlappning. Tillämpar ingen logik efter bearbetning för entiteterna. Det som modellen förutsäger är vad som ska returneras till användaren. Detta gör det möjligt för användaren att få en fullständig vy över varje enskild modells möjliga värden och tillämpa sin egen anpassade logik på entitetsval
AnalyzeTextEntityLinkingInput	Innehåller analystexten Entitetslänkningsindata.
AnalyzeTextEntityRecognitionInput	Entitetsigenkänningen analyserar uppgiftsbegäran för textinmatning.
AnalyzeTextKeyPhraseExtractionInput	Innehåller indata för att analysera texten KeyPhraseExtraction-uppgift.
AnalyzeTextLanguageDetectionInput	Innehåller indata för språkidentifieringsdokumentanalys.
AnalyzeTextPiiEntitiesRecognitionInput	Innehåller indata för att analysera text-PIIEntityRecognition-uppgift.
AnalyzeTextSentimentAnalysisInput	Innehåller analystexten SentimentAnalysis uppgiftsindata.
AnalyzeTextTaskKind	Den typ av analys-text-uppgifter som stöds.
AnalyzeTextTaskResultsKind	Typen av svarsobjekt som returneras av uppgiften analyze-text.
AreaMetadata	Representerar områdesentitetens metadatamodell.
AreaUnit	Mätningens områdesenhet.
CurrencyMetadata	Representerar entiteten Valuta ) metadatamodell.
DateMetadata	Metadata för datumentitetsinstanser.
DateTimeMetadata	Metadata för datetime-entitetsinstanser.
DateValue	Representerar datumvärdet.
DetectedLanguage	Innehåller information om det identifierade språket för texten.
DocumentError	Innehåller information om fel som påträffades under en jobbkörning.
DocumentSentimentValue	Förutsagt sentiment för dokument (negativt, neutralt, positivt eller blandat).
DocumentStatistics	om showStats=true angavs i begäran innehåller det här fältet information om dokumentets nyttolast.
DocumentWarning	Innehåller varningsobjektet med varningar som påträffas för det bearbetade dokumentet.
EntitiesDocumentResultWithMetadata	Entitetsdokument resulterar med metadata.
EntitiesResult	Innehåller aktivitetsresultatet för entitetsigenkänning.
EntitiesTaskParameters	Parametrar som stöds för en entitetsigenkänningsaktivitet.
EntitiesTaskResult	Innehåller entitetsaktiviteten
Entity	Definierar det identifierade entitetsobjektet som innehåller entitetskategorin och entitetstexten som identifierats osv.
EntityCategory	Innehåller alla entitetskategorier som identifierats av entitetsigenkänning.
EntityInferenceOptions	Klassen som innehåller de slutsatsdragningsalternativ som tillåts för namngiven entitetsigenkänning.
EntityLinkingResult	Resultat för entitetslänkning.
EntityLinkingTaskParameters	Parametrar som stöds för en entitetslänkningsaktivitet.
EntityLinkingTaskResult	Innehåller analystexten Entitetslänkningsaktivitetsresultat.
EntityTag	Entitetstaggobjekt som innehåller namnet på taggarna abd alla associerade konfidenspoäng. Entitetstaggar används för att uttrycka vissa likheter/tillhörighet mellan entiteter.
EntityWithMetadata	Entitetsobjekt med taggar och metadata.
Error	Felsvarsobjektet returnerades när tjänsten stöter på vissa fel under bearbetningen av begäran.
ErrorCode	Felkod som kan läsas av människor.
ErrorResponse	Felsvar.
InformationMetadata	Representerar entitetsmetadatamodellen Information (data).
InformationUnit	Måttenheten för information (data).
InnerErrorCode	Felkod som kan läsas av människor.
InnerErrorModel	Ett objekt som innehåller mer specifik information om felet. Enligt Riktlinjerna för Microsoft One API – https://github.com/Microsoft/api-guidelines/blob/vNext/Guidelines.md#7102-error-condition-responses.
KeyPhraseResult	Innehåller KeyPhraseResult.
KeyPhrasesDocumentResult	Innehåller resultatet av extrahering av nyckelfraser för ett dokument.
KeyPhraseTaskParameters	Parametrar som stöds för en nyckelfrasextraheringsaktivitet.
KeyPhraseTaskResult	Innehåller analystexten KeyPhraseExtraction-aktivitetsresultatet.
LanguageDetectionAnalysisInput	Innehåller indata för språkidentifieringsdokumentanalys.
LanguageDetectionDocumentResult	Innehåller språkidentifiering för ett dokument.
LanguageDetectionResult	Innehåller språkidentifieringsresultatet för begäran.
LanguageDetectionTaskParameters	Parametrar som stöds för en språkidentifieringsaktivitet.
LanguageDetectionTaskResult	Innehåller resultatet av språkidentifieringsaktiviteten för begäran.
LanguageInput	Innehåller indata för språkidentifiering.
LengthMetadata	Representerar modellen För entitetsmetadata för entitet.
LengthUnit	Måttenhetens längd.
LinkedEntitiesDocumentResult	Entitet som länkar dokumentresultat.
LinkedEntity	LinkedEntity-objektet som innehåller den identifierade entiteten med associerade källor/länkar.
Match	Match-objektet som innehåller den identifierade entitetstexten med förskjutningen och längden.
MatchLongestEntityPolicyType	Representerar den matchnings längsta överlappningsprincipen. Inga överlappande entiteter så långt det är möjligt. 1. Om det finns överlappande entiteter returneras den längsta. 2. Om uppsättningen tecken som förutsägs för 2 eller fler entiteter är exakt densamma väljer du den entitet som har högre konfidenspoäng.3. Om entitetspoängen är identiska returnerar du alla entiteter som fortfarande finns kvar efter att de tidigare reglerna har tillämpats. 3. Om det finns partiell överlappning (som i Hello Text Analytics) följer du stegen ovan från och med 1.
MetadataKind	Objekttypen entitetsmetadata.
MultiLanguageAnalysisInput	Insamling av indatadokument som ska analyseras av tjänsten.
MultiLanguageInput	Innehåller ett indatadokument som ska analyseras av tjänsten.
NumberKind	Typen av den extraherade talentiteten.
NumberMetadata	Metadata för numeriska entitetsinstanser.
NumericRangeMetadata	representerar metadata för numeriska intervall.
OrdinalMetadata	Metadata för numeriska entitetsinstanser.
PiiCategory	(Valfritt) beskriver PII-kategorierna som ska returneras
PiiDomain	Domän för PII-uppgift
PiiEntitiesDocumentResult	Innehåller PII-resultaten.
PiiResult	Innehåller PiiResult.
PiiTaskParameters	Parametrar som stöds för en PII-entitetsigenkänningsaktivitet.
PiiTaskResult	Innehåller LRO-uppgiften analysera text PIIEntityRecognition.
RangeInclusivity	Den här egenskapsegenskapens inkluderingsområde.
RangeKind	Typen av talintervallentitet.
RelativeTo	Referenspunkten som ordningstalet anger.
RequestStatistics	om showStats=true angavs i begäran innehåller det här fältet information om nyttolasten för begäran.
ScriptCode	Identifierar skriptet för indatadokumentet. Mappar till standardskriptkoden ISO 15924.
ScriptKind	Identifierar skriptet för indatadokumentet. Mappar till standardnamnet ISO 15924.
SentenceAssessment	Representerar en meningsbedömning och de utvärderingar eller målobjekt som är relaterade till den.
SentenceSentiment	Ett dokuments meningssentiment.
SentenceSentimentValue	Den förutsagda attityden för meningen.
SentenceTarget	Representerar ett meningsmål och de utvärderingar eller målobjekt som är relaterade till det.
SentimentAnalysisTaskParameters	Parametrar som stöds för en attitydanalysaktivitet.
SentimentConfidenceScores	Representerar konfidenspoängen mellan 0 och 1 i alla sentimentklasser: positiv, neutral, negativ.
SentimentDocumentResult	Ett objekt som representerar de fördefinierade sentimentanalysresultaten för varje dokument.
SentimentResponse	Resultat av attitydanalys för indatadokumenten.
SentimentTaskResult	Innehåller analystexten SentimentAnalysis LRO-aktivitetsresultat.
SpeedMetadata	Representerar modellen För entitetsmetadata för hastighet.
SpeedUnit	Måttenhetens hastighet
StringIndexType	Strängindextyp
TargetConfidenceScoreLabel	Representerar konfidenspoängen i alla sentimentklasser: positiva och negativa.
TargetRelation	Representerar relationen mellan utvärderingar och/eller mål.
TargetRelationType	Den typ som är relaterad till målet.
TemperatureMetadata	Representerar metadatamodellen informationsentitet.
TemperatureUnit	Mätningsenhetens temperatur.
TemporalModifier	En valfri modifierare för en datum/tid-instans.
TemporalSetMetadata	Metadata för temporala entitetsinstanser.
TemporalSpanMetadata	representerar metadata för ett datum- och/eller tidsintervall.
TemporalSpanValues	Temporal span-objekt.
TimeMetadata	Metadata för tidsinstanser för entiteter.
TokenSentimentValue	Den förutsagda attityden för meningen.
VolumeMetadata	Representerar modellen för volymentitetsmetadata.
VolumeUnit	Måttenhet för volym
WarningCodeValue	Definierar listan över varningskoderna.
WeightMetadata	Representerar entitetsmetadatamodellen Weight ).
WeightUnit	Måttenhetens vikt.

AgeMetadata

Objekt

Representerar modellen För entitetsmetadata för ålder.

Name	Typ	Description
metadataKind	string: AgeMetadata	Objekttypen entitetsmetadata.
unit	AgeUnit	Måttenhet för ålder.
value	number (double)	Det numeriska värde som den extraherade texten anger.

AgeUnit

Uppräkning

Enheten för åldersmätning

Värde	Description
Day	Tidsperiod på en dag
Month	Tidsperiod på en månad
Unspecified	Ospecificerad tidsperiod
Week	Tidsperiod på en vecka
Year	Tidsperiod på ett år

AllowOverlapEntityPolicyType

Objekt

Representerar principen tillåt överlappning. Tillämpar ingen logik efter bearbetning för entiteterna. Det som modellen förutsäger är vad som ska returneras till användaren. Detta gör det möjligt för användaren att få en fullständig vy över varje enskild modells möjliga värden och tillämpa sin egen anpassade logik på entitetsval

Name	Typ	Standardvärde	Description
policyKind	string: allowOverlap	matchLongest	Objekttypen Entity OverlapPolicy.

AnalyzeTextEntityLinkingInput

Objekt

Innehåller analystexten Entitetslänkningsindata.

Name	Typ	Description
analysisInput	MultiLanguageAnalysisInput	Innehåller de analysindata som ska hanteras av tjänsten.
kind	string: EntityLinking	Den typ av uppgift som ska utföras.
parameters	EntityLinkingTaskParameters	Uppgiftsparametrar.

AnalyzeTextEntityRecognitionInput

Objekt

Entitetsigenkänningen analyserar uppgiftsbegäran för textinmatning.

Name	Typ	Description
analysisInput	MultiLanguageAnalysisInput	Indata som ska analyseras.
kind	string: EntityRecognition	Den typ av uppgift som ska utföras.
parameters	EntitiesTaskParameters	Uppgiftsparametrar.

AnalyzeTextKeyPhraseExtractionInput

Objekt

Innehåller indata för att analysera texten KeyPhraseExtraction-uppgift.

Name	Typ	Description
analysisInput	MultiLanguageAnalysisInput	Innehåller indatadokumenten.
kind	string: KeyPhraseExtraction	Den typ av uppgift som ska utföras.
parameters	KeyPhraseTaskParameters	Parametrar för extrahering av nyckelfraser.

AnalyzeTextLanguageDetectionInput

Objekt

Innehåller indata för språkidentifieringsdokumentanalys.

Name	Typ	Description
analysisInput	LanguageDetectionAnalysisInput	Dokument som ska analyseras.
kind	string: LanguageDetection	Den typ av uppgift som ska utföras.
parameters	LanguageDetectionTaskParameters	aktivitetsparametrar.

AnalyzeTextPiiEntitiesRecognitionInput

Objekt

Innehåller indata för att analysera text-PIIEntityRecognition-uppgift.

Name	Typ	Description
analysisInput	MultiLanguageAnalysisInput	Innehåller indatadokumenten.
kind	string: PiiEntityRecognition	Den typ av uppgift som ska utföras.
parameters	PiiTaskParameters	Pii-aktivitetsparametrar.

AnalyzeTextSentimentAnalysisInput

Objekt

Innehåller analystexten SentimentAnalysis uppgiftsindata.

Name	Typ	Description
analysisInput	MultiLanguageAnalysisInput	Innehåller indatadokumenten.
kind	string: SentimentAnalysis	Den typ av uppgift som ska utföras.
parameters	SentimentAnalysisTaskParameters	Aktivitetsparametrar för attitydanalys.

AnalyzeTextTaskKind

Uppräkning

Den typ av analys-text-uppgifter som stöds.

Värde	Description
EntityLinking	Entitetslänkningsaktivitet
EntityRecognition	Entitetsigenkänningsaktivitet
KeyPhraseExtraction	Extrahering av nyckelfras
LanguageDetection	Språkidentifieringsuppgift
PiiEntityRecognition	PII-entitetsigenkänningsaktivitet
SentimentAnalysis	Attitydanalysuppgift

AnalyzeTextTaskResultsKind

Uppräkning

Typen av svarsobjekt som returneras av uppgiften analyze-text.

Värde	Description
EntityLinkingResults	Entitetslänkningsresultat
EntityRecognitionResults	Resultat av entitetsigenkänning
KeyPhraseExtractionResults	Extraheringsresultat för nyckelfraser
LanguageDetectionResults	Språkidentifieringsresultat
PiiEntityRecognitionResults	PII-entitetsigenkänningsresultat
SentimentAnalysisResults	Resultat av attitydanalys

AreaMetadata

Objekt

Representerar områdesentitetens metadatamodell.

Name	Typ	Description
metadataKind	string: AreaMetadata	Objekttypen entitetsmetadata.
unit	AreaUnit	Måttenhet för område.
value	number (double)	Det numeriska värde som den extraherade texten anger.

AreaUnit

Uppräkning

Mätningens områdesenhet.

Värde	Description
Acre	Områdesenhet i tunnland
SquareCentimeter	Areaenhet i kvadratcentik
SquareDecameter	Areaenhet i kvadratdecametrar
SquareDecimeter	Areaenhet i kvadratdecimetrar
SquareFoot	Areaenhet i kvadratfot
SquareHectometer	Areaenhet i kvadratiska hektometrar
SquareInch	Areaenhet i kvadrattum
SquareKilometer	Areaenhet i kvadratkilometer
SquareMeter	Areaenhet i kvadratmeter
SquareMile	Areaenhet i kvadratmil
SquareMillimeter	Areaenhet i kvadrat millimeter
SquareYard	Areaenhet i kvadratmeter
Unspecified	Ospecificerad områdesenhet

CurrencyMetadata

Objekt

Representerar entiteten Valuta ) metadatamodell.

Name	Typ	Description
iso4217	string	Den alfabetiska koden baserat på en annan ISO-standard, ISO 3166, som listar koderna för landsnamn. De två första bokstäverna i ISO 4217-koden med tre bokstäver är samma som koden för landsnamnet, och om möjligt motsvarar den tredje bokstaven den första bokstaven i valutanamnet.
metadataKind	string: CurrencyMetadata	Objekttypen entitetsmetadata.
unit	string	Valutaenhet.
value	number (double)	Det numeriska värde som den extraherade texten anger.

DateMetadata

Objekt

Metadata för datumentitetsinstanser.

Name	Typ	Description
dateValues	DateValue[]	Lista över datumvärden.
metadataKind	string: DateMetadata	Objekttypen entitetsmetadata.

DateTimeMetadata

Objekt

Metadata för datetime-entitetsinstanser.

Name	Typ	Description
dateValues	DateValue[]	Lista över datumvärden.
metadataKind	string: DateTimeMetadata	Objekttypen entitetsmetadata.

DateValue

Objekt

Representerar datumvärdet.

Name	Typ	Description
modifier	TemporalModifier	Modifierare för datetime för att ange referenspunkt som före, efter osv.
timex	string	En utökad ISO 8601-datum/tid-representation enligt beskrivningen i (https://github.com/Microsoft/Recognizers-Text/blob/master/Patterns/English/English-DateTime.yaml)
value	string	Den faktiska tid som den extraherade texten anger.

DetectedLanguage

Objekt

Innehåller information om det identifierade språket för texten.

Name	Typ	Description
confidenceScore	number (double)	En konfidenspoäng mellan 0 och 1. Poäng nära 1 anger 100% visshet om att det identifierade språket är sant.
iso6391Name	string	En tvåbokstavsrepresentation av det identifierade språket enligt STANDARDEN ISO 639-1 (t.ex. en, fr).
name	string	Långt namn på ett identifierat språk (t.ex. engelska, franska).
scriptIso15924Code	ScriptCode	Identifierar skriptkoden för indatadokumentet enligt STANDARDEN ISO 15924.
scriptName	ScriptKind	Identifierar skriptnamnet för indatadokumentet enligt standarden ISO 15924.

DocumentError

Objekt

Innehåller information om fel som påträffades under en jobbkörning.

Name	Typ	Description
error	Error	Fel påträffades.
id	string	ID för indatadokumentet.

DocumentSentimentValue

Uppräkning

Förutsagt sentiment för dokument (negativt, neutralt, positivt eller blandat).

Värde	Description
mixed	Blandad instruktion
negative	Negativ instruktion
neutral	Neutralt uttryck
positive	Positiv instruktion

DocumentStatistics

Objekt

om showStats=true angavs i begäran innehåller det här fältet information om dokumentets nyttolast.

Name	Typ	Description
charactersCount	integer (int32)	Antal textelement som känns igen i dokumentet.
transactionsCount	integer (int32)	Antal transaktioner för dokumentet.

DocumentWarning

Objekt

Innehåller varningsobjektet med varningar som påträffas för det bearbetade dokumentet.

Name	Typ	Description
code	WarningCodeValue	Varningskod.
message	string	Varningsmeddelande.
targetRef	string	En JSON-pekarreferens som anger målobjektet.

EntitiesDocumentResultWithMetadata

Objekt

Entitetsdokument resulterar med metadata.

Name	Typ	Description
entities	EntityWithMetadata[]	Identifierade entiteter i dokumentet.
id	string	Unik, icke-tom dokumentidentifierare.
statistics	DocumentStatistics	om showStats=true angavs i begäran innehåller det här fältet information om dokumentets nyttolast.
warnings	DocumentWarning[]	Varningar påträffades när dokumentet bearbetas.

EntitiesResult

Objekt

Innehåller aktivitetsresultatet för entitetsigenkänning.

Name	Typ	Description
documents	EntitiesDocumentResultWithMetadata[]	Svar efter dokument
errors	DocumentError[]	Fel efter dokument-ID.
modelVersion	string	Det här fältet anger vilken modell som används för bedömning.
statistics	RequestStatistics	om showStats=true angavs i begäran innehåller det här fältet information om nyttolasten för begäran.

EntitiesTaskParameters

Objekt

Parametrar som stöds för en entitetsigenkänningsaktivitet.

Name	Typ	Standardvärde	Description
exclusionList	EntityCategory[]		(Valfritt) begärandeparameter som filtrerar bort alla entiteter som ingår i excludeList. När en användare anger en excludeList kan de inte få en förutsägelse returnerad med en entitet i listan. Vi kommer att tillämpa inclusionList före exclusionList
inclusionList	EntityCategory[]		(Valfritt) parameter för begäran som begränsar utdata till de begärda entitetstyperna som ingår i den här listan. Vi kommer att tillämpa inclusionList före exclusionList
inferenceOptions	EntityInferenceOptions		(Valfritt) förfrågningsparameter som gör att användaren kan ange inställningar för att köra slutsatsdragningen.
loggingOptOut	boolean	False	avregistrera loggning
modelVersion	string	latest	modellversion
overlapPolicy	BaseEntityOverlapPolicy: AllowOverlapEntityPolicyType MatchLongestEntityPolicyType		(Valfritt) beskriver vilken typ av överlappningsprincip som ska tillämpas på ner-utdata.
stringIndexType	StringIndexType	TextElements_v8	(Valfritt) parameter för att ange den strängindextyp som används för att tolka strängförskjutningar. Standardvärdet är TextElements (Graphemes).

EntitiesTaskResult

Objekt

Innehåller entitetsaktiviteten

Name	Typ	Description
kind	string: EntityRecognitionResults	Typen av aktivitetsresultat.
results	EntitiesResult	Resultat för entitetsigenkänning.

Entity

Objekt

Definierar det identifierade entitetsobjektet som innehåller entitetskategorin och entitetstexten som identifierats osv.

Name	Typ	Description
category	string	Entitetstyp.
confidenceScore	number (double)	Konfidenspoäng mellan 0 och 1 av den extraherade entiteten.
length	integer (int32)	Längd för entitetstexten. Användningen av olika "stringIndexType"-värden kan påverka längden som returneras.
offset	integer (int32)	Startposition för entitetstexten. Användning av olika "stringIndexType"-värden kan påverka den returnerade förskjutningen.
subcategory	string	(Valfritt) Entitetsundertyp.
text	string	Entitetstext som visas i begäran.

EntityCategory

Uppräkning

Innehåller alla entitetskategorier som identifierats av entitetsigenkänning.

Värde	Description
Address	Specifika gatunivå omnämnanden av platser: hus/ byggnadsnummer, gator, avenyer, motorvägar, korsningar som refereras till med namn.
Age	Åldersrelaterade värden.
Airport	Flygplatser.
Area	Område för ett objekt.
City	Stadsrelaterade värden.
ComputingProduct	Databehandlingsprodukter.
Continent	Kontinentrelaterade värden.
CountryRegion	Lands- eller regionrelaterade värden.
CulturalEvent	Kulturella händelserelaterade värden.
Currency	Valutarelaterade värden.
Date	Kalenderdatum.
DateRange	Datumintervall.
DateTime	Kalenderdatum med tid.
DateTimeRange	Datum- och tidsintervall.
Dimension	Måttdimension
Duration	Tidsåtgång.
Email	E-postadresser.
Event	Social, sport, företag, politisk, utbildning, naturlig, historisk, kriminell, våldsam, juridisk, militär händelser med en tidsperiod.
GPE	Städer, länder/regioner, stater.
Geological	Geografiska och naturliga funktioner som floder, hav och öknar.
Height	Höjden på ett objekt.
IP	nätverks-IP-adresser.
Information	Måttenhet för digital information.
Length	Längden på ett objekt.
Location	Viss punkt eller plats i fysiskt utrymme.
NaturalEvent	Naturliga händelserelaterade värden.
Number	Tal utan enhet
NumberRange	Intervall med tal
Numeric	Numeriska värden, inklusive siffror och talord.
Ordinal	Ordningstal.
Organization	Företag, byråer och andra grupper av personer som definieras av någon etablerad organisationsstruktur. Dessa etiketter kan omfatta företag, politiska partier/rörelser, musikband, idrottsklubbar, statliga organ och offentliga organisationer. Nationaliteter eller religioner är inte ORGANISATION.
OrganizationMedical	Medicinska företag och grupper.
OrganizationSports	Idrottsrelaterade organisationer.
OrganizationStockExchange	Börsgrupper.
Percentage	Procentrelaterade värden.
Person	För det första, sista och mellannamn, namn på fiktiva tecken och alias. Titlar, till exempel "Mr". eller "President", betraktas inte som en del av den namngivna entiteten.
PersonType	Mänskliga roller klassificerade efter ett gruppmedlemskap.
PhoneNumber	Telefonnummer (endast telefonnummer för USA och EU).
Product	Enstaka eller grupp av kommersiella, förbrukningsbara föremål, elektronik, fordon, livsmedelsgrupper.
SetTemporal	Uppsättning tidsrelaterade värden.
Skill	En förmåga, kompetens eller expertis.
Speed	Hastighet för ett objekt.
SportsEvent	Sportevenemangsrelaterade värden.
State	Tillståndsrelaterade värden.
Structural	Konstgjorda strukturer.
Temperature	Temperaturrelaterade värden.
Temporal	Artiklar som rör tid.
Time	Tider på dagen.
TimeRange	Tidsintervall.
URL	URL:er till webbplatser.
Volume	Volymen för ett objekt.
Weight	Ett objekts vikt.

EntityInferenceOptions

Objekt

Klassen som innehåller de slutsatsdragningsalternativ som tillåts för namngiven entitetsigenkänning.

Name	Typ	Standardvärde	Description
excludeNormalizedValues	boolean	False	Alternativ för att inkludera/exkludera de identifierade entitetsvärden som ska normaliseras och inkluderas i metadata. De numeriska och temporala entitetstyperna stöder värdenormalisering.

EntityLinkingResult

Objekt

Resultat för entitetslänkning.

Name	Typ	Description
documents	LinkedEntitiesDocumentResult[]	Svar efter dokument
errors	DocumentError[]	Fel efter dokument-ID.
modelVersion	string	Det här fältet anger vilken modell som används för bedömning.
statistics	RequestStatistics	om showStats=true angavs i begäran innehåller det här fältet information om nyttolasten för begäran.

EntityLinkingTaskParameters

Objekt

Parametrar som stöds för en entitetslänkningsaktivitet.

Name	Typ	Standardvärde	Description
loggingOptOut	boolean	False	avregistrera loggning
modelVersion	string	latest	modellversion
stringIndexType	StringIndexType	TextElements_v8	Valfri parameter för att ange den strängindextyp som används för att tolka strängförskjutningar. Standardvärdet är TextElements (Graphemes).

EntityLinkingTaskResult

Objekt

Innehåller analystexten Entitetslänkningsaktivitetsresultat.

Name	Typ	Description
kind	string: EntityLinkingResults	Typen av aktivitetsresultat.
results	EntityLinkingResult	Resultat för entitetslänkning.

EntityTag

Objekt

Entitetstaggobjekt som innehåller namnet på taggarna abd alla associerade konfidenspoäng. Entitetstaggar används för att uttrycka vissa likheter/tillhörighet mellan entiteter.

Name	Typ	Description
confidenceScore	number (double)	Identifieringspoäng mellan 0 och 1 av den extraherade entiteten.
name	string	Namnet på taggen. Namn på entitetstagg kommer att vara unika globalt.

EntityWithMetadata

Objekt

Entitetsobjekt med taggar och metadata.

Name	Typ	Description
category	string	Entitetstyp.
confidenceScore	number (double)	Konfidenspoäng mellan 0 och 1 av den extraherade entiteten.
length	integer (int32)	Längd för entitetstexten. Användningen av olika "stringIndexType"-värden kan påverka längden som returneras.
metadata	BaseMetadata: AgeMetadata AreaMetadata CurrencyMetadata DateMetadata DateTimeMetadata InformationMetadata LengthMetadata NumberMetadata NumericRangeMetadata OrdinalMetadata SpeedMetadata TemperatureMetadata TemporalSetMetadata TemporalSpanMetadata TimeMetadata VolumeMetadata WeightMetadata	Entitetsmetadataobjektet.
offset	integer (int32)	Startposition för entitetstexten. Användning av olika "stringIndexType"-värden kan påverka den returnerade förskjutningen.
subcategory	string	(Valfritt) Entitetsundertyp.
tags	EntityTag[]	Lista över entitetstaggar. Taggar är till för att uttrycka vissa likheter/tillhörighet mellan entiteter.
text	string	Entitetstext som visas i begäran.
type	string	En entitetstyp är den lägsta (eller finaste) kornigheten där entiteten har identifierats. Typen mappar till de specifika metadataattribut som är associerade med den identifierade entiteten.

Error

Objekt

Felsvarsobjektet returnerades när tjänsten stöter på vissa fel under bearbetningen av begäran.

Name	Typ	Description
code	ErrorCode	En av en serverdefinierad uppsättning felkoder.
details	Error[]	En matris med information om specifika fel som ledde till det rapporterade felet.
innererror	InnerErrorModel	Ett objekt som innehåller mer specifik information än det aktuella objektet om felet.
message	string	En mänsklig läsbar representation av felet.
target	string	Målet för felet.

ErrorCode

Uppräkning

Felkod som kan läsas av människor.

Värde	Description
AzureCognitiveSearchIndexLimitReached	Azure Cognitive Search-indexgränsen nådde fel
AzureCognitiveSearchIndexNotFound	Azure Cognitive Search-indexet hittades inte
AzureCognitiveSearchNotFound	Azure Cognitive Search hittades inte
AzureCognitiveSearchThrottling	Azure Cognitive Search-begränsningsfel
Conflict	Konfliktfel
Forbidden	Fel om förbjuden åtkomst
InternalServerError	Internt serverfel
InvalidArgument	Ogiltigt argumentfel
InvalidRequest	Ogiltigt begärandefel
NotFound	Det gick inte att hitta felet
OperationNotFound	Det gick inte att hitta åtgärden
ProjectNotFound	Det gick inte att hitta projektet
QuotaExceeded	Fel om överskriden kvot
ServiceUnavailable	Fel som inte är tillgänglig för tjänsten
Timeout	Timeout-fel
TooManyRequests	Fel vid för många begäranden
Unauthorized	Fel vid obehörig åtkomst
Warning	Varningsfel

ErrorResponse

Objekt

Felsvar.

Name	Typ	Description
error	Error	Felobjektet.

InformationMetadata

Objekt

Representerar entitetsmetadatamodellen Information (data).

Name	Typ	Description
metadataKind	string: InformationMetadata	Objekttypen entitetsmetadata.
unit	InformationUnit	Måttenhet för information.
value	number (double)	Det numeriska värde som den extraherade texten anger.

InformationUnit

Uppräkning

Måttenheten för information (data).

Värde	Description
Bit	Datastorleksenhet i bitar
Byte	Datastorleksenhet i byte
Gigabit	Datastorleksenhet i gigabits
Gigabyte	Datastorleksenhet i gigabyte
Kilobit	Datastorleksenhet i kilobitar
Kilobyte	Datastorleksenhet i kilobyte
Megabit	Datastorleksenhet i megabitar
Megabyte	Datastorleksenhet i megabyte
Petabit	Datastorleksenhet i petabits
Petabyte	Datastorleksenhet i petabyte
Terabit	Datastorleksenhet i terabits
Terabyte	Datastorleksenhet i terabyte
Unspecified	Ospecificerad datastorleksenhet

InnerErrorCode

Uppräkning

Felkod som kan läsas av människor.

Värde	Description
AzureCognitiveSearchNotFound	Azure Cognitive Search hittades inte
AzureCognitiveSearchThrottling	Azure Cognitive Search-begränsningsfel
EmptyRequest	Fel vid tom begäran
ExtractionFailure	Fel vid extrahering
InvalidCountryHint	Ogiltigt landtipsfel
InvalidDocument	Ogiltigt dokumentfel
InvalidDocumentBatch	Ogiltigt dokumentbatchfel
InvalidParameterValue	Ogiltigt parametervärdefel
InvalidRequest	Ogiltigt begärandefel
InvalidRequestBodyFormat	Ogiltigt fel i brödtextformat för begäran
KnowledgeBaseNotFound	Det gick inte att hitta kunskapsbasen
MissingInputDocuments	Fel i indatadokument saknas
ModelVersionIncorrect	Fel i modellversion
UnsupportedLanguageCode	Fel med språkkod som inte stöds

InnerErrorModel

Objekt

Ett objekt som innehåller mer specifik information om felet. Enligt Riktlinjerna för Microsoft One API – https://github.com/Microsoft/api-guidelines/blob/vNext/Guidelines.md#7102-error-condition-responses.

Name	Typ	Description
code	InnerErrorCode	En av en serverdefinierad uppsättning felkoder.
details	object	Felinformation.
innererror	InnerErrorModel	Ett objekt som innehåller mer specifik information än det aktuella objektet om felet.
message	string	Felmeddelande.
target	string	Felmål.

KeyPhraseResult

Objekt

Innehåller KeyPhraseResult.

Name	Typ	Description
documents	KeyPhrasesDocumentResult[]	Svar efter dokument
errors	DocumentError[]	Fel efter dokument-ID.
modelVersion	string	Det här fältet anger vilken modell som används för bedömning.
statistics	RequestStatistics	om showStats=true angavs i begäran innehåller det här fältet information om nyttolasten för begäran.

KeyPhrasesDocumentResult

Objekt

Innehåller resultatet av extrahering av nyckelfraser för ett dokument.

Name	Typ	Description
id	string	Unik, icke-tom dokumentidentifierare.
keyPhrases	string[]	En lista över representativa ord eller fraser. Antalet nyckelfraser som returneras är proportionellt mot antalet ord i indatadokumentet.
statistics	DocumentStatistics	om showStats=true angavs i begäran innehåller det här fältet information om dokumentets nyttolast.
warnings	DocumentWarning[]	Varningar påträffades när dokumentet bearbetas.

KeyPhraseTaskParameters

Objekt

Parametrar som stöds för en nyckelfrasextraheringsaktivitet.

Name	Typ	Standardvärde	Description
loggingOptOut	boolean	False	avregistrera loggning
modelVersion	string	latest	modellversion

KeyPhraseTaskResult

Objekt

Innehåller analystexten KeyPhraseExtraction-aktivitetsresultatet.

Name	Typ	Description
kind	string: KeyPhraseExtractionResults	Typen av aktivitetsresultat.
results	KeyPhraseResult	Listan över resultat för extrahering av nyckelfraser

LanguageDetectionAnalysisInput

Objekt

Innehåller indata för språkidentifieringsdokumentanalys.

Name	Typ	Description
documents	LanguageInput[]	Lista över dokument som ska analyseras.

LanguageDetectionDocumentResult

Objekt

Innehåller språkidentifiering för ett dokument.

Name	Typ	Description
detectedLanguage	DetectedLanguage	Det identifierade språket.
id	string	Unik, icke-tom dokumentidentifierare.
statistics	DocumentStatistics	om showStats=true angavs i begäran innehåller det här fältet information om dokumentets nyttolast.
warnings	DocumentWarning[]	Varningar påträffades när dokumentet bearbetas.

LanguageDetectionResult

Objekt

Innehåller språkidentifieringsresultatet för begäran.

Name	Typ	Description
documents	LanguageDetectionDocumentResult[]	Uppräkning av språkidentifieringsresultat för varje indatadokument.
errors	DocumentError[]	Fel efter dokument-ID.
modelVersion	string	Det här fältet anger vilken modell som används för bedömning.
statistics	RequestStatistics	om showStats=true angavs i begäran innehåller det här fältet information om nyttolasten för begäran.

LanguageDetectionTaskParameters

Objekt

Parametrar som stöds för en språkidentifieringsaktivitet.

Name	Typ	Standardvärde	Description
loggingOptOut	boolean	False	avregistrera loggning
modelVersion	string	latest	modellversion

LanguageDetectionTaskResult

Objekt

Innehåller resultatet av språkidentifieringsaktiviteten för begäran.

Name	Typ	Description
kind	string: LanguageDetectionResults	Typen av aktivitetsresultat.
results	LanguageDetectionResult	Innehåller språkidentifieringsresultatet.

LanguageInput

Objekt

Innehåller indata för språkidentifiering.

Name	Typ	Description
countryHint	string	Landet tips för att hjälpa till med språkidentifiering av texten.
id	string	En unik, icke-tom dokumentidentifierare.
text	string	Den indatatext som ska bearbetas.

LengthMetadata

Objekt

Representerar modellen För entitetsmetadata för entitet.

Name	Typ	Description
metadataKind	string: LengthMetadata	Objekttypen entitetsmetadata.
unit	LengthUnit	Måttenhet för längd.
value	number (double)	Det numeriska värde som den extraherade texten anger.

LengthUnit

Uppräkning

Måttenhetens längd.

Värde	Description
Centimeter	Längdenhet i centimeter.
Decameter	Längdenhet i dekametrar.
Decimeter	Längdenhet i decimetrar.
Foot	Längdenhet i fot.
Hectometer	Längdenhet i hektometer.
Inch	Längdenhet i tum.
Kilometer	Längdenhet i kilometer.
LightYear	Längdenhet i ljusår.
Meter	Längdenhet i meter.
Micrometer	Längdenhet i mikrometrar.
Mile	Längdenhet i miles.
Millimeter	Längdenhet i millimeter.
Nanometer	Längdenhet i nanometer.
Picometer	Längdenhet i picometers.
Point	Längdenhet i punkter.
Unspecified	Ospecificerad längdenhet.
Yard	Längdenhet i meter.

LinkedEntitiesDocumentResult

Objekt

Entitet som länkar dokumentresultat.

Name	Typ	Description
entities	LinkedEntity[]	Identifierade välkända entiteter i dokumentet.
id	string	Unik, icke-tom dokumentidentifierare.
statistics	DocumentStatistics	om showStats=true angavs i begäran innehåller det här fältet information om dokumentets nyttolast.
warnings	DocumentWarning[]	Varningar påträffades när dokumentet bearbetas.

LinkedEntity

Objekt

LinkedEntity-objektet som innehåller den identifierade entiteten med associerade källor/länkar.

Name	Typ	Description
bingId	string	Api för entitetssökning i Bing unik identifierare för den identifierade entiteten.
dataSource	string	Datakälla som används för att extrahera entitetslänkning, till exempel Wiki/Bing osv.
id	string	Unik identifierare för den identifierade entiteten från datakällan.
language	string	Språk som används i datakällan.
matches	Match[]	Lista över instanser som den här entiteten visas i texten.
name	string	Entitet som länkar formellt namn.
url	string	URL för entitetens sida från datakällan.

Match

Objekt

Match-objektet som innehåller den identifierade entitetstexten med förskjutningen och längden.

Name	Typ	Description
confidenceScore	number (double)	Om ett välkänt objekt identifieras returneras ett decimaltal som anger konfidensnivån mellan 0 och 1.
length	integer (int32)	Längd för entitetsmatchningstexten.
offset	integer (int32)	Startposition för entitetsmatchningstexten.
text	string	Entitetstext som visas i begäran.

MatchLongestEntityPolicyType

Objekt

Representerar den matchnings längsta överlappningsprincipen. Inga överlappande entiteter så långt det är möjligt. 1. Om det finns överlappande entiteter returneras den längsta. 2. Om uppsättningen tecken som förutsägs för 2 eller fler entiteter är exakt densamma väljer du den entitet som har högre konfidenspoäng.3. Om entitetspoängen är identiska returnerar du alla entiteter som fortfarande finns kvar efter att de tidigare reglerna har tillämpats. 3. Om det finns partiell överlappning (som i Hello Text Analytics) följer du stegen ovan från och med 1.

Name	Typ	Standardvärde	Description
policyKind	string: matchLongest	matchLongest	Objekttypen Entity OverlapPolicy.

MetadataKind

Uppräkning

Objekttypen entitetsmetadata.

Värde	Description
AgeMetadata	Metadata för åldersrelaterade värden.
AreaMetadata	Metadata för områdesrelaterade värden.
CurrencyMetadata	Metadata för valutarelaterade värden.
DateMetadata	Metadata för datumrelaterade värden.
DateTimeMetadata	Metadata för datum- och tidsrelaterade värden.
InformationMetadata	Metadata för informationsrelaterade värden.
LengthMetadata	Metadata för längdrelaterade värden.
NumberMetadata	Metadata för numeriska värden.
NumericRangeMetadata	Metadata för numeriska intervallvärden.
OrdinalMetadata	Metadata för ordningstal.
SpeedMetadata	Metadata för hastighetsrelaterade värden.
TemperatureMetadata	Metadata för temperaturrelaterade värden.
TemporalSetMetadata	Metadata för uppsättning tidsrelaterade värden.
TemporalSpanMetadata	Metadata för värden för tidsintervall.
TimeMetadata	Metadata för tidsrelaterade värden.
VolumeMetadata	Metadata för volymrelaterade värden.
WeightMetadata	Metadata för viktrelaterade värden.

MultiLanguageAnalysisInput

Objekt

Insamling av indatadokument som ska analyseras av tjänsten.

Name	Typ	Description
documents	MultiLanguageInput[]	De indatadokument som ska analyseras.

MultiLanguageInput

Objekt

Innehåller ett indatadokument som ska analyseras av tjänsten.

Name	Typ	Description
id	string	En unik, icke-tom dokumentidentifierare.
language	string	(Valfritt) Detta är 2-bokstaven ISO 639-1 representation av ett språk. Använd till exempel "en" för engelska; "es" för spanska etc. Om du inte anger använder du "en" för engelska som standard. (Följande gäller endast för 2023-04-15-preview och senare) För Automatisk språkidentifiering använder du "auto". Om du inte anger använder du "en" för engelska som standard.
text	string	Den indatatext som ska bearbetas.

NumberKind

Uppräkning

Typen av den extraherade talentiteten.

Värde	Description
Decimal	Decimaltal
Fraction	Bråktal
Integer	Heltalsnummer
Percent	Procenttal
Power	Strömnummer
Unspecified	Ospecificerad nummertyp

NumberMetadata

Objekt

Metadata för numeriska entitetsinstanser.

Name	Typ	Description
metadataKind	string: NumberMetadata	Objekttypen entitetsmetadata.
numberKind	NumberKind	Typ av taltyp.
value	number (double)	En numerisk representation av vad den extraherade texten anger.

NumericRangeMetadata

Objekt

representerar metadata för numeriska intervall.

Name	Typ	Description
maximum	number (double)	Slutvärdet för intervallet.
metadataKind	string: NumericRangeMetadata	Objekttypen entitetsmetadata.
minimum	number (double)	Intervallets startvärde.
rangeInclusivity	RangeInclusivity	Inkluderingen i det här intervallet.
rangeKind	RangeKind	Typ av numeriska intervall som stöds – t.ex. Tal, hastighet osv.

OrdinalMetadata

Objekt

Metadata för numeriska entitetsinstanser.

Name	Typ	Description
metadataKind	string: OrdinalMetadata	Objekttypen entitetsmetadata.
offset	string	Förskjutningen med avseende på referensen (t.ex. offset = -1 anger den näst sista)
relativeTo	RelativeTo	Referenspunkten som ordningstalet anger.
value	string	Ett enkelt aritmiskt uttryck som ordningstalet anger.

PiiCategory

Uppräkning

(Valfritt) beskriver PII-kategorierna som ska returneras

Värde	Description
ABARoutingNumber	ABA-routningsnummer
ARNationalIdentityNumber	Nationellt AR-identitetsnummer
ATIdentityCard	AT Identity Card
ATTaxIdentificationNumber	AT Skatteidentifieringsnummer
ATValueAddedTaxNumber	AT Value Added Tax Number
AUBankAccountNumber	AT Identity Card
AUBusinessNumber	AU Business Number
AUCompanyNumber	AU-företagsnummer
AUDriversLicenseNumber	AU-körkortsnummer
AUMedicalAccountNumber	Kontonummer för AU Medical
AUPassportNumber	AU Passport-nummer
AUTaxFileNumber	AU-skattefilnummer
Address	Adress
Age	Ålder
All	Alla PII-kategorier.
AzureDocumentDBAuthKey	Azure Document DB-autentiseringsnyckel
AzureIAASDatabaseConnectionAndSQLString	Azure IAAS-databasanslutning och SQL-sträng
AzureIoTConnectionString	Azure IoT-anslutningssträng
AzurePublishSettingPassword	Lösenord för Azure-publiceringsinställning
AzureRedisCacheString	Azure Redis Cache String
AzureSAS	Azure SAS
AzureServiceBusString	Azure Service Bus-sträng
AzureStorageAccountGeneric	Allmänt Azure Storage-konto
AzureStorageAccountKey	Azure Storage-kontonyckel
BENationalNumber	BE Nationellt nummer
BENationalNumberV2	BE National Number V2
BEValueAddedTaxNumber	BE Momsregistreringsnummer
BGUniformCivilNumber	BG Enhetligt civilnummer
BRCPFNumber	BR CPF-nummer
BRLegalEntityNumber	BR-nummer för juridisk person
BRNationalIDRG	BR Nationella ID RG
CABankAccountNumber	CA Bankkontonummer
CADriversLicenseNumber	CA-körkortsnummer
CAHealthServiceNumber	CA Health Service Number
CAPassportNumber	CA Passport-nummer
CAPersonalHealthIdentification	Ca Personlig hälsoidentifiering
CASocialInsuranceNumber	CA Socialförsäkringsnummer
CHSocialSecurityNumber	CH Socialförsäkringsnummer
CLIdentityCardNumber	CL-identitetskortnummer
CNResidentIdentityCardNumber	Cn Resident Identity Card-nummer
CYIdentityCard	CY-identitetskort
CYTaxIdentificationNumber	CY-skatteidentifieringsnummer
CZPersonalIdentityNumber	Personligt identitetsnummer för CZ
CZPersonalIdentityV2	CZ Personlig identitet V2
CreditCardNumber	Kreditkortsnummer
DEDriversLicenseNumber	DE-körkortsnummer
DEIdentityCardNumber	DE-identitetskortnummer
DEPassportNumber	DE Passport-nummer
DETaxIdentificationNumber	DE-skatteidentifieringsnummer
DEValueAddedNumber	DE-värde tillagt tal
DKPersonalIdentificationNumber	Personidentifieringsnummer för DK
DKPersonalIdentificationV2	DK Personlig identifiering V2
Date	Datum
Default	Standard-PII-kategorier för språket.
DrugEnforcementAgencyNumber	Nummer på drug enforcement agency
EEPersonalIdentificationCode	EE-kod för personlig identifiering
ESDNI	ES DNI
ESSocialSecurityNumber	ES Socialförsäkringsnummer
ESTaxIdentificationNumber	ES-skatteidentifieringsnummer
EUDebitCardNumber	EU-betalkortsnummer
EUDriversLicenseNumber	EU-körkortsnummer
EUGPSCoordinates	EU GPS-koordinater
EUNationalIdentificationNumber	NATIONELLT ID-nummer för EU
EUPassportNumber	EU-passnummer
EUSocialSecurityNumber	EU:s personnummer
EUTaxIdentificationNumber	EU-skatteidentifieringsnummer
Email	E-post
FIEuropeanHealthNumber	FI European Health Number
FINationalID	FI-nationellt ID
FINationalIDV2	FI National ID V2
FIPassportNumber	FI Passport-nummer
FRDriversLicenseNumber	FR Körkortsnummer
FRHealthInsuranceNumber	FR Sjukförsäkringsnummer
FRNationalID	Nationellt ID för FR
FRPassportNumber	FR Passport-nummer
FRSocialSecurityNumber	FR Socialförsäkringsnummer
FRTaxIdentificationNumber	FR Skatteidentifieringsnummer
FRValueAddedTaxNumber	Momsregistreringsnummer för FR
GRNationalIDCard	GR Nationellt ID-kort
GRNationalIDV2	GR National ID V2
GRTaxIdentificationNumber	GR-skatteidentifieringsnummer
HKIdentityCardNumber	HK-identitetskortnummer
HRIdentityCardNumber	HR-identitetskortnummer
HRNationalIDNumber	HR-nummer för nationellt ID
HRPersonalIdentificationNumber	Personalidentifieringsnummer för HR
HRPersonalIdentificationOIBNumberV2	HR-personidentifiering OIB-nummer V2
HUPersonalIdentificationNumber	PERSONLIGT ID-nummer för HU
HUTaxIdentificationNumber	HU-skatteidentifieringsnummer
HUValueAddedNumber	HU-värde tillagt tal
IDIdentityCardNumber	ID-identitetskortnummer
IEPersonalPublicServiceNumber	IE Personligt public service-nummer
IEPersonalPublicServiceNumberV2	IE Personligt public service-nummer V2
ILBankAccountNumber	IL-bankkontonummer
ILNationalID	IL-nationellt ID
INPermanentAccount	I permanent konto
INUniqueIdentificationNumber	I unikt identifieringsnummer
IPAddress	IP-adress
ITDriversLicenseNumber	IT-körkortsnummer
ITFiscalCode	IT-räkenskapskod
ITValueAddedTaxNumber	Momsnummer för IT-mervärde
InternationalBankingAccountNumber	Internationellt bankkontonummer
JPBankAccountNumber	JP Bankkontonummer
JPDriversLicenseNumber	JP-körkortsnummer
JPMyNumberCorporate	JP My Number Corporate
JPMyNumberPersonal	JP My Number Personal
JPPassportNumber	JP Passport-nummer
JPResidenceCardNumber	JP Residence-kortnummer
JPResidentRegistrationNumber	JP Resident Registreringsnummer
JPSocialInsuranceNumber	JP Socialförsäkringsnummer
KRResidentRegistrationNumber	Registreringsnummer för KR Resident
LTPersonalCode	LT-personlig kod
LUNationalIdentificationNumberNatural	LU Nationellt identifieringsnummer Naturligt
LUNationalIdentificationNumberNonNatural	LU National Identification Number Non Natural
LVPersonalCode	LV-personlig kod
MTIdentityCardNumber	MT-identitetskortnummer
MTTaxIDNumber	MT-skatte-ID-nummer
MYIdentityCardNumber	MITT identitetskortnummer
NLCitizensServiceNumber	Servicenummer för NL-medborgare
NLCitizensServiceNumberV2	NL Citizens Service Nummer V2
NLTaxIdentificationNumber	NL-skatteidentifieringsnummer
NLValueAddedTaxNumber	Nl-momsnummer
NOIdentityNumber	INGET identitetsnummer
NZBankAccountNumber	NZ Bankkontonummer
NZDriversLicenseNumber	NZ-körkortsnummer
NZInlandRevenueNumber	NZ Inlandsintäktsnummer
NZMinistryOfHealthNumber	NZ Ministry Of Health Number
NZSocialWelfareNumber	NZ Social Welfare Number
Organization	Organisation
PHUnifiedMultiPurposeIDNumber	PH Unified Multi Purpose ID-nummer
PLIdentityCard	PL-identitetskort
PLNationalID	PL Nationellt ID
PLNationalIDV2	PL National ID V2
PLPassportNumber	PL Passport-nummer
PLREGONNumber	PL REGON-nummer
PLTaxIdentificationNumber	PL-skatteidentifieringsnummer
PTCitizenCardNumber	PT-medborgarkortnummer
PTCitizenCardNumberV2	PT Citizen Card Number V2
PTTaxIdentificationNumber	PT-skatteidentifieringsnummer
Person	Person
PhoneNumber	Telefonnummer
ROPersonalNumericalCode	RO Personal Numerical Code
RUPassportNumberDomestic	RU Passport Number Domestic
RUPassportNumberInternational	RU Passport Number International
SANationalID	NATIONELLT ID för SA
SENationalID	SE Nationellt ID
SENationalIDV2	SE Nationellt ID V2
SEPassportNumber	SE Passport-nummer
SETaxIdentificationNumber	SE-skatteidentifieringsnummer
SGNationalRegistrationIdentityCardNumber	SG National Registration Identity Card Number
SITaxIdentificationNumber	SI-skatteidentifieringsnummer
SIUniqueMasterCitizenNumber	SI Unikt huvudpersonnummer
SKPersonalNumber	PERSONLIGT SK-nummer
SQLServerConnectionString	SQL Server-anslutningssträng
SWIFTCode	SWIFT-kod
THPopulationIdentificationCode	Identifieringskod för TH-population
TRNationalIdentificationNumber	NationellT identifieringsnummer för TR
TWNationalID	TW Nationella ID
TWPassportNumber	TW Passport-nummer
TWResidentCertificate	TW Resident Certificate
UAPassportNumberDomestic	UA Passport-nummer inrikes
UAPassportNumberInternational	UA Passport Number International
UKDriversLicenseNumber	Brittiskt körkortsnummer
UKElectoralRollNumber	Röstlängdsnummer i Storbritannien
UKNationalHealthNumber	Storbritanniens nationella hälsonummer
UKNationalInsuranceNumber	UK National Insurance Number
UKUniqueTaxpayerNumber	UK Unique Taxpayer Number
URL	URL
USBankAccountNumber	Kontonummer för USA
USDriversLicenseNumber	Amerikanskt körkortsnummer
USIndividualTaxpayerIdentification	Identifiering av enskilda skattebetalare i USA
USSocialSecurityNumber	Socialförsäkringsnummer för USA
USUKPassportNumber	Passnummer för USA, Storbritannien
ZAIdentificationNumber	ZA-identifieringsnummer

PiiDomain

Uppräkning

Domän för PII-uppgift

Värde	Description
none	Anger att ingen domän har angetts.
phi	Anger att entiteter i domänen personlig hälsoinformation ska redigeras.

PiiEntitiesDocumentResult

Objekt

Innehåller PII-resultaten.

Name	Typ	Description
entities	Entity[]	Identifierade entiteter i dokumentet.
id	string	Unik, icke-tom dokumentidentifierare.
redactedText	string	Returnerar redigerad text.
statistics	DocumentStatistics	om showStats=true angavs i begäran innehåller det här fältet information om dokumentets nyttolast.
warnings	DocumentWarning[]	Varningar påträffades när dokumentet bearbetas.

PiiResult

Objekt

Innehåller PiiResult.

Name	Typ	Description
documents	PiiEntitiesDocumentResult[]	Svar efter dokument
errors	DocumentError[]	Fel efter dokument-ID.
modelVersion	string	Det här fältet anger vilken modell som används för bedömning.
statistics	RequestStatistics	om showStats=true angavs i begäran innehåller det här fältet information om nyttolasten för begäran.

PiiTaskParameters

Objekt

Parametrar som stöds för en PII-entitetsigenkänningsaktivitet.

Name	Typ	Standardvärde	Description
domain	PiiDomain	none	Domän för PII-uppgift
loggingOptOut	boolean	False	avregistrera loggning
modelVersion	string	latest	modellversion
piiCategories	PiiCategory[]		Uppräkning av PII-kategorier som ska returneras i svaret.
stringIndexType	StringIndexType	TextElements_v8	StringIndexType som ska användas för analys.

PiiTaskResult

Objekt

Innehåller LRO-uppgiften analysera text PIIEntityRecognition.

Name	Typ	Description
kind	string: PiiEntityRecognitionResults	Typen av aktivitetsresultat.
results	PiiResult	Listan över pii-resultat

RangeInclusivity

Uppräkning

Den här egenskapsegenskapens inkluderingsområde.

Värde	Description
LeftInclusive	Vänster sida inkluderande
LeftRightInclusive	Båda sidor inkluderande
NoneInclusive	Ingen inkludering
RightInclusive	Inkluderande höger sida

RangeKind

Uppräkning

Typen av talintervallentitet.

Värde	Description
Age	Åldersintervall
Area	Områdesområde
Currency	Valutaintervall
Information	Informationsintervall
Length	Längdintervall
Number	Nummerintervall
Speed	Hastighetsintervall
Temperature	Temperaturområde
Volume	Volymintervall
Weight	Viktintervall

RelativeTo

Uppräkning

Referenspunkten som ordningstalet anger.

Värde	Description
Current	Aktuellt tillstånd eller position
End	Sluttillstånd eller position
Start	Starttillstånd eller position

RequestStatistics

Objekt

om showStats=true angavs i begäran innehåller det här fältet information om nyttolasten för begäran.

Name	Typ	Description
documentsCount	integer (int32)	Antal dokument som skickats i begäran.
erroneousDocumentsCount	integer (int32)	Antal ogiltiga dokument. Detta inkluderar tomma, överstorleksgräns eller språkdokument som inte stöds.
transactionsCount	integer (int64)	Antal transaktioner för begäran.
validDocumentsCount	integer (int32)	Antal giltiga dokument. Detta utesluter tomma dokument, överstorleksgränser eller språk som inte stöds.

ScriptCode

Uppräkning

Identifierar skriptet för indatadokumentet. Mappar till standardskriptkoden ISO 15924.

Värde	Description
Arab	Skriptkod för det arabiska skriptet.
Armn	Skriptkod för det armeniska skriptet.
Beng	Skriptkod för Bangla-skriptet.
Cans	Skriptkod för UnifiedCanadianAboriginalSyllabics-skriptet.
Cyrl	Skriptkod för det kyrilliska skriptet.
Deva	Skriptkod för Devanagari-skriptet.
Ethi	Skriptkod för Ethiopic-skriptet.
Geor	Skriptkod för det georgiska skriptet.
Grek	Skriptkod för det grekiska skriptet.
Gujr	Skriptkod för Gujarati-skriptet.
Guru	Skriptkod för Gurmukhi-skriptet.
Hang	Skriptkod för Hangul-skriptet.
Hani	Skriptkod för HanLiteral-skriptet.
Hans	Skriptkod för HanSimplified-skriptet.
Hant	Skriptkod för HanTraditional-skriptet.
Hebr	Skriptkod för det hebreiska skriptet.
Jpan	Skriptkod för det japanska skriptet.
Khmr	Skriptkod för Khmer-skriptet.
Knda	Skriptkod för Kannada-skriptet.
Laoo	Skriptkod för Lao-skriptet.
Latn	Skriptkod för det latinska skriptet.
Mlym	Skriptkod för Malayalam-skriptet.
Mong	Skriptkod för det mongoliska skriptet.
Mtei	Skriptkod för Meitei-skriptet.
Mymr	Skriptkod för Myanmar-skriptet.
Olck	Skriptkod för Santali-skriptet.
Orya	Skriptkod för Odia-skriptet.
Shrd	Skriptkod för Sharada-skriptet.
Sinh	Skriptkod för Sinhala-skriptet.
Taml	Skriptkod för tamilskt skript.
Telu	Skriptkod för Telugu-skriptet.
Thaa	Skriptkod för Thaana-skriptet.
Thai	Skriptkod för det thailändska skriptet.
Tibt	Skriptkod för det tibetanska skriptet.

ScriptKind

Uppräkning

Identifierar skriptet för indatadokumentet. Mappar till standardnamnet ISO 15924.

Värde	Description
Arabic	Skriptnamn för det arabiska skriptet.
Armenian	Skriptnamn för det armeniska skriptet.
Bangla	Skriptnamn för Bangla-skriptet.
Cyrillic	Skriptnamn för det kyrilliska skriptet.
Devanagari	Skriptnamn för Devanagari-skriptet.
Ethiopic	Skriptnamn för Ethiopic-skriptet.
Georgian	Skriptnamn för det georgiska skriptet.
Greek	Skriptnamn för det grekiska skriptet.
Gujarati	Skriptnamn för Gujarati-skriptet.
Gurmukhi	Skriptnamn för Gurmukhi-skriptet.
HanLiteral	Skriptnamn för HanLiteral-skriptet.
HanSimplified	Skriptnamn för HanSimplified-skriptet.
HanTraditional	Skriptnamn för HanTraditional-skriptet.
Hangul	Skriptnamn för Hangul-skriptet.
Hebrew	Skriptnamn för det hebreiska skriptet.
Japanese	Skriptnamn för det japanska skriptet.
Kannada	Skriptnamn för Kannada-skriptet.
Khmer	Skriptnamn för Khmer-skriptet.
Lao	Skriptnamn för Lao-skriptet.
Latin	Skriptnamn för det latinska skriptet.
Malayalam	Skriptnamn för Malayalam-skriptet.
Meitei	Skriptnamn för Meitei-skriptet.
Mongolian	Skriptnamn för det mongoliska skriptet.
Myanmar	Skriptnamn för Myanmar-skriptet.
Odia	Skriptnamn för Odia-skriptet.
Santali	Skriptnamn för Santali-skriptet.
Sharada	Skriptnamn för Sharada-skriptet.
Sinhala	Skriptnamn för Sinhala-skriptet.
Tamil	Skriptnamn för tamilskt skript.
Telugu	Skriptnamn för Telugu-skriptet.
Thaana	Skriptnamn för Thaana-skriptet.
Thai	Skriptnamn för det thailändska skriptet.
Tibetan	Skriptnamn för det tibetanska skriptet.
UnifiedCanadianAboriginalSyllabics	Skriptnamn för skriptet UnifiedCanadianAboriginalSyllabics.

SentenceAssessment

Objekt

Representerar en meningsbedömning och de utvärderingar eller målobjekt som är relaterade till den.

Name	Typ	Description
confidenceScores	TargetConfidenceScoreLabel	Representerar konfidenspoängen i alla sentimentklasser: positiva och negativa.
isNegated	boolean	Indikatorn som representerar om utvärderingen negeras.
length	integer (int32)	Målets längd.
offset	integer (int32)	Målförskjutningen från början av meningen.
sentiment	TokenSentimentValue	Meningens känsla.
text	string	Måltexten har identifierats.

SentenceSentiment

Objekt

Ett dokuments meningssentiment.

Name	Typ	Description
assessments	SentenceAssessment[]	Matrisen med utvärderingar för meningen.
confidenceScores	SentimentConfidenceScores	Attitydförtroendepoängen mellan 0 och 1 för meningen för alla klasser.
length	integer (int32)	Målets längd.
offset	integer (int32)	Målförskjutningen från början av meningen.
sentiment	SentenceSentimentValue	Den förutsagda attityden för meningen.
targets	SentenceTarget[]	Matrisen med meningsmål för meningen.
text	string	Meningstexten.

SentenceSentimentValue

Uppräkning

Den förutsagda attityden för meningen.

Värde	Description
negative	Negativt sentiment
neutral	Neutralt sentiment
positive	Positiv attityd

SentenceTarget

Objekt

Representerar ett meningsmål och de utvärderingar eller målobjekt som är relaterade till det.

Name	Typ	Description
confidenceScores	TargetConfidenceScoreLabel	Representerar konfidenspoängen i alla sentimentklasser: positiva och negativa.
length	integer (int32)	Målets längd.
offset	integer (int32)	Målförskjutningen från början av meningen.
relations	TargetRelation[]	Matrisen med antingen utvärderings- eller målobjekt som är relaterade till målet.
sentiment	TokenSentimentValue	Meningens känsla.
text	string	Måltexten har identifierats.

SentimentAnalysisTaskParameters

Objekt

Parametrar som stöds för en attitydanalysaktivitet.

Name	Typ	Standardvärde	Description
loggingOptOut	boolean	False	avregistrera loggning
modelVersion	string	latest	modellversion
opinionMining	boolean	False	Om du vill använda åsiktsutvinning i begäran eller inte.
stringIndexType	StringIndexType	TextElements_v8	Anger den metod som används för att tolka strängförskjutningar.

SentimentConfidenceScores

Objekt

Representerar konfidenspoängen mellan 0 och 1 i alla sentimentklasser: positiv, neutral, negativ.

Name	Typ	Description
negative	number (double)	Konfidenspoäng för negativt sentiment
neutral	number (double)	Konfidenspoäng för neutralt sentiment
positive	number (double)	Konfidenspoäng för positiv attityd

SentimentDocumentResult

Objekt

Ett objekt som representerar de fördefinierade sentimentanalysresultaten för varje dokument.

Name	Typ	Description
confidenceScores	SentimentConfidenceScores	Attitydförtroendepoängen mellan 0 och 1 för meningen för alla klasser.
id	string	Unik, icke-tom dokumentidentifierare.
sentences	SentenceSentiment[]	Dokumentets meningar attityd.
sentiment	DocumentSentimentValue	Förutsagt sentiment för dokument (negativt, neutralt, positivt eller blandat).
statistics	DocumentStatistics	om showStats=true angavs i begäran innehåller det här fältet information om dokumentets nyttolast.
warnings	DocumentWarning[]	Varningar påträffades när dokumentet bearbetas.

SentimentResponse

Objekt

Resultat av attitydanalys för indatadokumenten.

Name	Typ	Description
documents	SentimentDocumentResult[]	Sentimentanalysresultaten för varje dokument i indata.
errors	DocumentError[]	Fel efter dokument-ID.
modelVersion	string	Det här fältet anger vilken modell som används för bedömning.
statistics	RequestStatistics	om showStats=true angavs i begäran innehåller det här fältet information om nyttolasten för begäran.

SentimentTaskResult

Objekt

Innehåller analystexten SentimentAnalysis LRO-aktivitetsresultat.

Name	Typ	Description
kind	string: SentimentAnalysisResults	Typen av aktivitetsresultat.
results	SentimentResponse	Resultatet av attitydanalysen

SpeedMetadata

Objekt

Representerar modellen För entitetsmetadata för hastighet.

Name	Typ	Description
metadataKind	string: SpeedMetadata	Objekttypen entitetsmetadata.
unit	SpeedUnit	Måttenhet för hastighet.
value	number (double)	Det numeriska värde som den extraherade texten anger.

SpeedUnit

Uppräkning

Måttenhetens hastighet

Värde	Description
CentimetersPerMillisecond	Hastighetsenhet i centimeter per millisekunder.
FeetPerMinute	Hastighetsenhet i fot per minut.
FeetPerSecond	Hastighetsenhet i fot per sekund.
KilometersPerHour	Hastighetsenhet i kilometer per timme.
KilometersPerMillisecond	Hastighetsenhet i kilometer per millisekunder.
KilometersPerMinute	Hastighetsenhet i kilometer per minut.
KilometersPerSecond	Hastighetsenhet i kilometer per sekund.
Knots	Hastighetsenhet i knutar.
MetersPerMillisecond	Hastighetsenhet i meter per millisekunder.
MetersPerSecond	Hastighetsenhet i meter per sekund.
MilesPerHour	Hastighetsenhet i miles per timme.
Unspecified	Ospecificerad hastighetsenhet.
YardsPerMinute	Hastighetsenhet i meter per minut.
YardsPerSecond	Hastighetsenhet i varv per sekund.

StringIndexType

Uppräkning

Strängindextyp

Värde	Description
TextElements_v8	Returnerade förskjutnings- och längdvärden motsvarar TextElements (Graphemes- och Grapheme-kluster) som bekräftar unicode 8.0.0-standarden. Använd det här alternativet om ditt program är skrivet i .Net Framework eller .Net Core och du kommer att använda StringInfo.
UnicodeCodePoint	Returnerade förskjutnings- och längdvärden motsvarar Unicode-kodpunkter. Använd det här alternativet om programmet är skrivet på ett språk som stöder Unicode, till exempel Python.
Utf16CodeUnit	Returnerade förskjutnings- och längdvärden motsvarar UTF-16-kodenheter. Använd det här alternativet om ditt program är skrivet på ett språk som stöder Unicode, till exempel Java, JavaScript.

TargetConfidenceScoreLabel

Objekt

Representerar konfidenspoängen i alla sentimentklasser: positiva och negativa.

Name	Typ	Description
negative	number (double)	Konfidenspoäng för negativt sentiment
positive	number (double)	Konfidenspoäng för positiv attityd

TargetRelation

Objekt

Representerar relationen mellan utvärderingar och/eller mål.

Name	Typ	Description
ref	string	JSON-pekaren som anger det länkade objektet.
relationType	TargetRelationType	Den typ som är relaterad till målet.

TargetRelationType

Uppräkning

Den typ som är relaterad till målet.

Värde	Description
assessment	Utvärderingsrelation.
target	Målrelation.

TemperatureMetadata

Objekt

Representerar metadatamodellen informationsentitet.

Name	Typ	Description
metadataKind	string: TemperatureMetadata	Objekttypen entitetsmetadata.
unit	TemperatureUnit	Måttenhet för temperatur.
value	number (double)	Det numeriska värde som den extraherade texten anger.

TemperatureUnit

Uppräkning

Mätningsenhetens temperatur.

Värde	Description
Celsius	Temperaturenhet i Celsius
Fahrenheit	Temperaturenhet i Fahrenheit
Kelvin	Temperaturenhet i Kelvin
Rankine	Temperaturenhet i Rankine
Unspecified	Ospecificerad temperaturenhet

TemporalModifier

Uppräkning

En valfri modifierare för en datum/tid-instans.

Värde	Description
After	Efter en viss tid
AfterApprox	Efter en ungefärlig tid
AfterMid	Efter mitten av en tidsperiod
AfterStart	Efter starten av en tidsperiod
Approx	Ungefär vid en viss tidpunkt
Before	Före en viss tid
BeforeApprox	Före en ungefärlig tid
BeforeEnd	Före slutet av en tidsperiod
BeforeStart	Innan en tidsperiod börjar
End	I slutet av en tidsperiod
Less	Mindre än en viss tid
Mid	I mitten av en tidsperiod
More	Mer än en viss tid
ReferenceUndefined	Referens till en odefinierad tid
Since	Eftersom en viss tid
SinceEnd	Sedan slutet av en tidsperiod
Start	I början av en tidsperiod
Until	Tills en viss tid

TemporalSetMetadata

Objekt

Metadata för temporala entitetsinstanser.

Name	Typ	Description
dateValues	DateValue[]	Lista över datumvärden.
metadataKind	string: TemporalSetMetadata	Objekttypen entitetsmetadata.

TemporalSpanMetadata

Objekt

representerar metadata för ett datum- och/eller tidsintervall.

Name	Typ	Description
metadataKind	string: TemporalSpanMetadata	Objekttypen entitetsmetadata.
spanValues	TemporalSpanValues[]	Lista över tidsintervall som identifierats.

TemporalSpanValues

Objekt

Temporal span-objekt.

Name	Typ	Description
begin	string	Startvärde för intervallet.
duration	string	Ett valfritt varaktighetsvärde formaterat baserat på ISO 8601 (https://en.wikipedia.org/wiki/ISO_8601#Durations)
end	string	Slutvärde för spannet.
modifier	TemporalModifier	Modifierare för datetime för att ange referenspunkt som före, efter osv.
timex	string	En valfri trilling som innehåller början, slutet och varaktigheten som alla anges som ISO 8601-formaterade strängar.

TimeMetadata

Objekt

Metadata för tidsinstanser för entiteter.

Name	Typ	Description
dateValues	DateValue[]	Lista över datumvärden.
metadataKind	string: TimeMetadata	Objekttypen entitetsmetadata.

TokenSentimentValue

Uppräkning

Den förutsagda attityden för meningen.

Värde	Description
mixed	Blandade sentiment
negative	Negativt sentiment
positive	Positiv attityd

VolumeMetadata

Objekt

Representerar modellen för volymentitetsmetadata.

Name	Typ	Description
metadataKind	string: VolumeMetadata	Objekttypen entitetsmetadata.
unit	VolumeUnit	Måttenhet för volym.
value	number (double)	Det numeriska värde som den extraherade texten anger.

VolumeUnit

Uppräkning

Måttenhet för volym

Värde	Description
Barrel	Volymenhet i fat.
Bushel	Volymenhet i bushels.
Centiliter	Volymenhet i centiliters.
Cord	Volymenhet i sladdar.
CubicCentimeter	Volymenhet i kubikcentik.
CubicFoot	Volymenhet i kubikfot.
CubicInch	Volymenhet i kubiktum.
CubicMeter	Volymenhet i kubikmeter.
CubicMile	Volymenhet i kubikmil.
CubicMillimeter	Volymenhet i kubik millimeter.
CubicYard	Volymenhet i kubikmeter.
Cup	Volymenhet i koppar.
Decaliter	Volymenhet i dekaliter.
FluidDram	Volymenhet i vätskedramer.
FluidOunce	Volymenhet i vätske ounces.
Gill	Volymenhet i gälar.
Hectoliter	Volymenhet i hectoliters.
Hogshead	Volymenhet i hogsheads.
Liter	Volymenhet i liter.
Milliliter	Volymenhet i milliliter.
Minim	Volymenhet i minimer.
Peck	Volymenhet i pecks.
Pinch	Volymenhet i kläm.
Pint	Volymenhet i pints.
Quart	Volymenhet i kvartar.
Tablespoon	Volymenhet i matskedar.
Teaspoon	Volymenhet i teskedar.
Unspecified	Ospecificerad volymenhet.

WarningCodeValue

Uppräkning

Definierar listan över varningskoderna.

Värde	Description
DocumentTruncated	Varning om trunkerat dokument
LongWordsInDocument	Långa ord i dokumentvarning

WeightMetadata

Objekt

Representerar entitetsmetadatamodellen Weight ).

Name	Typ	Description
metadataKind	string: WeightMetadata	Objekttypen entitetsmetadata.
unit	WeightUnit	Måttenhet för vikt.
value	number (double)	Det numeriska värde som den extraherade texten anger.

WeightUnit

Uppräkning

Måttenhetens vikt.

Värde	Description
Dram	Viktenhet i dram
Gallon	Volymenhet i gallon
Grain	Viktenhet i korn
Gram	Viktenhet i gram
Kilogram	Viktenhet i kg
LongTonBritish	Viktenhet i långa ton (brittisk)
MetricTon	Viktenhet i måttton
Milligram	Viktenhet i milligram
Ounce	Viktenhet i uns
PennyWeight	Viktenhet i pennyweights
Pound	Viktenhet i pund
ShortHundredWeightUS	Viktenhet i korta hundravikter (USA)
ShortTonUS	Viktenhet i korta ton (USA)
Stone	Viktenhet i stenar
Ton	Viktenhet i ton
Unspecified	Ospecificerad viktenhet