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	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

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	Det numeriska värde som den extraherade texten anger.

AgeUnit

Enheten för åldersmätning

Name	Typ	Description
Day	string	Tidsperiod på en dag
Month	string	Tidsperiod på en månad
Unspecified	string	Ospecificerad tidsperiod
Week	string	Tidsperiod på en vecka
Year	string	Tidsperiod på ett år

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

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

AnalyzeTextEntityLinkingInput

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

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

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

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

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

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

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

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

AnalyzeTextTaskResultsKind

Typen av svarsobjekt som returneras av uppgiften analyze-text.

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

AreaMetadata

Representerar områdesentitetens metadatamodell.

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

AreaUnit

Mätningens områdesenhet.

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

CurrencyMetadata

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	Det numeriska värde som den extraherade texten anger.

DateMetadata

Metadata för datumentitetsinstanser.

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

DateTimeMetadata

Metadata för datetime-entitetsinstanser.

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

DateValue

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

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

Name	Typ	Description
confidenceScore	number	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

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

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

Name	Typ	Description
mixed	string	Blandad instruktion
negative	string	Negativ instruktion
neutral	string	Neutralt uttryck
positive	string	Positiv instruktion

DocumentStatistics

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

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

DocumentWarning

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

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

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

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

Innehåller entitetsaktiviteten

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

Entity

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

Name	Typ	Description
category	string	Entitetstyp.
confidenceScore	number	Konfidenspoäng mellan 0 och 1 av den extraherade entiteten.
length	integer	Längd för entitetstexten. Användningen av olika "stringIndexType"-värden kan påverka längden som returneras.
offset	integer	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

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

Name	Typ	Description
Address	string	Specifika gatunivå omnämnanden av platser: hus/ byggnadsnummer, gator, avenyer, motorvägar, korsningar som refereras till med namn.
Age	string	Åldersrelaterade värden.
Airport	string	Flygplatser.
Area	string	Område för ett objekt.
City	string	Stadsrelaterade värden.
ComputingProduct	string	Databehandlingsprodukter.
Continent	string	Kontinentrelaterade värden.
CountryRegion	string	Lands- eller regionrelaterade värden.
CulturalEvent	string	Kulturella händelserelaterade värden.
Currency	string	Valutarelaterade värden.
Date	string	Kalenderdatum.
DateRange	string	Datumintervall.
DateTime	string	Kalenderdatum med tid.
DateTimeRange	string	Datum- och tidsintervall.
Dimension	string	Måttdimension
Duration	string	Tidsåtgång.
Email	string	E-postadresser.
Event	string	Social, sport, företag, politisk, utbildning, naturlig, historisk, kriminell, våldsam, juridisk, militär händelser med en tidsperiod.
GPE	string	Städer, länder/regioner, stater.
Geological	string	Geografiska och naturliga funktioner som floder, hav och öknar.
Height	string	Höjden på ett objekt.
IP	string	nätverks-IP-adresser.
Information	string	Måttenhet för digital information.
Length	string	Längden på ett objekt.
Location	string	Viss punkt eller plats i fysiskt utrymme.
NaturalEvent	string	Naturliga händelserelaterade värden.
Number	string	Tal utan enhet
NumberRange	string	Intervall med tal
Numeric	string	Numeriska värden, inklusive siffror och talord.
Ordinal	string	Ordningstal.
Organization	string	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	string	Medicinska företag och grupper.
OrganizationSports	string	Idrottsrelaterade organisationer.
OrganizationStockExchange	string	Börsgrupper.
Percentage	string	Procentrelaterade värden.
Person	string	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	string	Mänskliga roller klassificerade efter ett gruppmedlemskap.
PhoneNumber	string	Telefonnummer (endast telefonnummer för USA och EU).
Product	string	Enstaka eller grupp av kommersiella, förbrukningsbara föremål, elektronik, fordon, livsmedelsgrupper.
SetTemporal	string	Uppsättning tidsrelaterade värden.
Skill	string	En förmåga, kompetens eller expertis.
Speed	string	Hastighet för ett objekt.
SportsEvent	string	Sportevenemangsrelaterade värden.
State	string	Tillståndsrelaterade värden.
Structural	string	Konstgjorda strukturer.
Temperature	string	Temperaturrelaterade värden.
Temporal	string	Artiklar som rör tid.
Time	string	Tider på dagen.
TimeRange	string	Tidsintervall.
URL	string	URL:er till webbplatser.
Volume	string	Volymen för ett objekt.
Weight	string	Ett objekts vikt.

EntityInferenceOptions

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

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

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

Innehåller analystexten Entitetslänkningsaktivitetsresultat.

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

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.

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

EntityWithMetadata

Entitetsobjekt med taggar och metadata.

Name	Typ	Description
category	string	Entitetstyp.
confidenceScore	number	Konfidenspoäng mellan 0 och 1 av den extraherade entiteten.
length	integer	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	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

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

Felkod som kan läsas av människor.

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

ErrorResponse

Felsvar.

Name	Typ	Description
error	Error	Felobjektet.

InformationMetadata

Representerar entitetsmetadatamodellen Information (data).

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

InformationUnit

Måttenheten för information (data).

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

InnerErrorCode

Felkod som kan läsas av människor.

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

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.

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

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

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

Parametrar som stöds för en nyckelfrasextraheringsaktivitet.

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

KeyPhraseTaskResult

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

Innehåller indata för språkidentifieringsdokumentanalys.

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

LanguageDetectionDocumentResult

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

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

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

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

LanguageDetectionTaskResult

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

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

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	Det numeriska värde som den extraherade texten anger.

LengthUnit

Måttenhetens längd.

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

LinkedEntitiesDocumentResult

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

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

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

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

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.

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

MetadataKind

Objekttypen entitetsmetadata.

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

MultiLanguageAnalysisInput

Insamling av indatadokument som ska analyseras av tjänsten.

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

MultiLanguageInput

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

Typen av den extraherade talentiteten.

Name	Typ	Description
Decimal	string	Decimaltal
Fraction	string	Bråktal
Integer	string	Heltalsnummer
Percent	string	Procenttal
Power	string	Strömnummer
Unspecified	string	Ospecificerad nummertyp

NumberMetadata

Metadata för numeriska entitetsinstanser.

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

NumericRangeMetadata

representerar metadata för numeriska intervall.

Name	Typ	Description
maximum	number	Slutvärdet för intervallet.
metadataKind	string: NumericRangeMetadata	Objekttypen entitetsmetadata.
minimum	number	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

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

(Valfritt) beskriver PII-kategorierna som ska returneras

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

PiiDomain

Domän för PII-uppgift

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

PiiEntitiesDocumentResult

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

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

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

Innehåller LRO-uppgiften analysera text PIIEntityRecognition.

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

RangeInclusivity

Den här egenskapsegenskapens inkluderingsområde.

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

RangeKind

Typen av talintervallentitet.

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

RelativeTo

Referenspunkten som ordningstalet anger.

Name	Typ	Description
Current	string	Aktuellt tillstånd eller position
End	string	Sluttillstånd eller position
Start	string	Starttillstånd eller position

RequestStatistics

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	Antal dokument som skickats i begäran.
erroneousDocumentsCount	integer	Antal ogiltiga dokument. Detta inkluderar tomma, överstorleksgräns eller språkdokument som inte stöds.
transactionsCount	integer	Antal transaktioner för begäran.
validDocumentsCount	integer	Antal giltiga dokument. Detta utesluter tomma dokument, överstorleksgränser eller språk som inte stöds.

ScriptCode

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

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

ScriptKind

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

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

SentenceAssessment

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	Målets längd.
offset	integer	Målförskjutningen från början av meningen.
sentiment	TokenSentimentValue	Meningens känsla.
text	string	Måltexten har identifierats.

SentenceSentiment

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	Målets längd.
offset	integer	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

Den förutsagda attityden för meningen.

Name	Typ	Description
negative	string	Negativt sentiment
neutral	string	Neutralt sentiment
positive	string	Positiv attityd

SentenceTarget

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	Målets längd.
offset	integer	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

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

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

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

SentimentDocumentResult

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

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

Innehåller analystexten SentimentAnalysis LRO-aktivitetsresultat.

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

SpeedMetadata

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	Det numeriska värde som den extraherade texten anger.

SpeedUnit

Måttenhetens hastighet

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

StringIndexType

Strängindextyp

Name	Typ	Description
TextElements_v8	string	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	string	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	string	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

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

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

TargetRelation

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

Den typ som är relaterad till målet.

Name	Typ	Description
assessment	string	Utvärderingsrelation.
target	string	Målrelation.

TemperatureMetadata

Representerar metadatamodellen informationsentitet.

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

TemperatureUnit

Mätningsenhetens temperatur.

Name	Typ	Description
Celsius	string	Temperaturenhet i Celsius
Fahrenheit	string	Temperaturenhet i Fahrenheit
Kelvin	string	Temperaturenhet i Kelvin
Rankine	string	Temperaturenhet i Rankine
Unspecified	string	Ospecificerad temperaturenhet

TemporalModifier

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

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

TemporalSetMetadata

Metadata för temporala entitetsinstanser.

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

TemporalSpanMetadata

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

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

Metadata för tidsinstanser för entiteter.

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

TokenSentimentValue

Den förutsagda attityden för meningen.

Name	Typ	Description
mixed	string	Blandade sentiment
negative	string	Negativt sentiment
positive	string	Positiv attityd

VolumeMetadata

Representerar modellen för volymentitetsmetadata.

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

VolumeUnit

Måttenhet för volym

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

WarningCodeValue

Definierar listan över varningskoderna.

Name	Typ	Description
DocumentTruncated	string	Varning om trunkerat dokument
LongWordsInDocument	string	Långa ord i dokumentvarning

WeightMetadata

Representerar entitetsmetadatamodellen Weight ).

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

WeightUnit

Måttenhetens vikt.

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