你当前正在访问 Microsoft Azure Global Edition 技术文档网站。如果需要访问由世纪互联运营的 Microsoft Azure 中国技术文档网站，请访问 https://docs.azure.cn。

Analyze Text - Analyze Text

服务:: Azure AI Services

API 版本:: 2025-11-01

请求对文档集合进行文本分析。

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

具有可选参数:

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

URI 参数

名称	在	必需	类型	说明
Endpoint	path	True	string (uri)	支持的认知服务终结点（例如，https://< resource-name.api.cognitiveservices.azure.com>）。
api-version	query	True	string minLength: 1	要用于此操作的 API 版本。
showStats	query		boolean	（可选）如果设置为 true，响应将包含请求和文档级别统计信息。

请求正文

请求正文可以为下列任一内容：

名称	说明
AnalyzeTextEntityLinkingInput	包含分析文本实体链接输入。
AnalyzeTextEntityRecognitionInput	实体识别分析文本输入任务请求。
AnalyzeTextKeyPhraseExtractionInput	包含分析文本 KeyPhraseExtraction 任务输入。
AnalyzeTextLanguageDetectionInput	包含语言检测文档分析任务输入。
AnalyzeTextPiiEntitiesRecognitionInput	包含分析文本 PIIEntityRecognition 任务输入。
AnalyzeTextSentimentAnalysisInput	包含分析文本 SentimentAnalysis 任务输入。

AnalyzeTextEntityLinkingInput

包含分析文本实体链接输入。

名称	必需	类型	说明
kind	True	string: EntityLinking	要执行的任务类型。
analysisInput		MultiLanguageAnalysisInput	包含要由服务处理的分析输入。
parameters		EntityLinkingTaskParameters	任务参数。

AnalyzeTextEntityRecognitionInput

实体识别分析文本输入任务请求。

名称	必需	类型	说明
kind	True	string: EntityRecognition	要执行的任务类型。
analysisInput		MultiLanguageAnalysisInput	要分析的输入。
parameters		EntitiesTaskParameters	任务参数。

AnalyzeTextKeyPhraseExtractionInput

包含分析文本 KeyPhraseExtraction 任务输入。

名称	必需	类型	说明
kind	True	string: KeyPhraseExtraction	要执行的任务类型。
analysisInput		MultiLanguageAnalysisInput	包含输入文档。
parameters		KeyPhraseTaskParameters	关键短语提取任务参数。

AnalyzeTextLanguageDetectionInput

包含语言检测文档分析任务输入。

名称	必需	类型	说明
kind	True	string: LanguageDetection	要执行的任务类型。
analysisInput		LanguageDetectionAnalysisInput	要分析的文档。
parameters		LanguageDetectionTaskParameters	任务参数。

AnalyzeTextPiiEntitiesRecognitionInput

包含分析文本 PIIEntityRecognition 任务输入。

名称	必需	类型	说明
kind	True	string: PiiEntityRecognition	要执行的任务类型。
analysisInput		MultiLanguageAnalysisInput	包含输入文档。
parameters		PiiTaskParameters	Pii 任务参数。

AnalyzeTextSentimentAnalysisInput

包含分析文本 SentimentAnalysis 任务输入。

名称	必需	类型	说明
kind	True	string: SentimentAnalysis	要执行的任务类型。
analysisInput		MultiLanguageAnalysisInput	包含输入文档。
parameters		SentimentAnalysisTaskParameters	情绪分析任务参数。

响应

名称	类型	说明
200 OK	AnalyzeTextTaskResult: EntitiesTaskResult EntityLinkingTaskResult KeyPhraseTaskResult LanguageDetectionTaskResult PiiTaskResult SentimentTaskResult	请求已成功。
Other Status Codes	ErrorResponse	意外错误响应。标头 x-ms-error-code: string

名称

类型

说明

200 OK

AnalyzeTextTaskResult:

EntitiesTaskResult
EntityLinkingTaskResult
KeyPhraseTaskResult
LanguageDetectionTaskResult
PiiTaskResult
SentimentTaskResult

请求已成功。

Other Status Codes

ErrorResponse

意外错误响应。

标头

x-ms-error-code: string

安全性

Ocp-Apim-Subscription-Key

类型: apiKey
在: header

OAuth2Auth

类型: oauth2
流向: accessCode
授权 URL: https://login.microsoftonline.com/common/oauth2/authorize
令牌 URL: https://login.microsoftonline.com/common/oauth2/token

作用域

名称	说明
https://cognitiveservices.azure.com/.default

示例

SuccessfulEntityLinkingRequest

SuccessfulEntityRecognitionExclusionRequest

SuccessfulEntityRecognitionInclusionRequest

SuccessfulEntityRecognitionInferenceOptionsRequest

SuccessfulEntityRecognitionOverlapPolicy

SuccessfulEntityRecognitionRequest

SuccessfulKeyPhraseExtractionRequest

SuccessfulLanguageDetectionRequest

SuccessfulPiiEntityRecognitionRequest

SuccessfulSentimentAnalysisRequest

SuccessfulEntityLinkingRequest

示例请求

HTTP

POST {Endpoint}/language/:analyze-text?api-version=2025-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."
      }
    ]
  }
}

示例响应

状态代码:: 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

示例请求

HTTP

POST {Endpoint}/language/:analyze-text?api-version=2025-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."
      }
    ]
  }
}

示例响应

状态代码:: 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

示例请求

HTTP

POST {Endpoint}/language/:analyze-text?api-version=2025-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."
      }
    ]
  }
}

示例响应

状态代码:: 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

示例请求

HTTP

POST {Endpoint}/language/:analyze-text?api-version=2025-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."
      }
    ]
  }
}

示例响应

状态代码:: 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

示例请求

HTTP

POST {Endpoint}/language/:analyze-text?api-version=2025-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"
      }
    ]
  }
}

示例响应

状态代码:: 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

示例请求

HTTP

POST {Endpoint}/language/:analyze-text?api-version=2025-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"
      }
    ]
  }
}

示例响应

状态代码:: 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

示例请求

HTTP

POST {Endpoint}/language/:analyze-text?api-version=2025-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."
      }
    ]
  }
}

示例响应

状态代码:: 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

示例请求

HTTP

POST {Endpoint}/language/:analyze-text?api-version=2025-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?"
      }
    ]
  }
}

示例响应

状态代码:: 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

示例请求

HTTP

POST {Endpoint}/language/:analyze-text?api-version=2025-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?"
      }
    ]
  }
}

示例响应

状态代码:: 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

示例请求

HTTP

POST {Endpoint}/language/:analyze-text?api-version=2025-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."
      }
    ]
  }
}

示例响应

状态代码:: 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"
  }
}

定义

名称	说明
AgeMetadata	表示年龄实体元数据模型。
AgeUnit	度量的年龄单位
AllowOverlapEntityPolicyType	表示允许重叠策略。不会对实体应用任何后处理逻辑。无论模型预测什么，都会返回给用户。这允许用户全面了解每个模型的可能值，并在实体选择上应用自己的自定义逻辑
AnalyzeTextEntityLinkingInput	包含分析文本实体链接输入。
AnalyzeTextEntityRecognitionInput	实体识别分析文本输入任务请求。
AnalyzeTextKeyPhraseExtractionInput	包含分析文本 KeyPhraseExtraction 任务输入。
AnalyzeTextLanguageDetectionInput	包含语言检测文档分析任务输入。
AnalyzeTextPiiEntitiesRecognitionInput	包含分析文本 PIIEntityRecognition 任务输入。
AnalyzeTextSentimentAnalysisInput	包含分析文本 SentimentAnalysis 任务输入。
AnalyzeTextTaskKind	支持的分析文本任务类型。
AnalyzeTextTaskResultsKind	analyze-text 任务返回的响应对象的类型。
AreaMetadata	表示 Area 实体元数据模型。
AreaUnit	度量面积单位。
CurrencyMetadata	表示 Currency ）实体元数据模型。
DateMetadata	日期实体实例的元数据。
DateTimeMetadata	日期时间实体实例的元数据。
DateValue	表示日期值。
DetectedLanguage	包含检测到的文本语言的详细信息。
DocumentError	包含作业执行期间遇到的错误的详细信息。
DocumentSentimentValue	文档的预测情绪（负面、中性、积极或混合）。
DocumentStatistics	如果在请求中指定 showStats=true，则此字段将包含有关文档有效负载的信息。
DocumentWarning	包含警告对象，其中包含已处理文档遇到的警告。
EntitiesDocumentResultWithMetadata	包含元数据的实体文档结果。
EntitiesResult	包含实体识别任务结果。
EntitiesTaskParameters	实体识别任务支持的参数。
EntitiesTaskResult	包含实体任务
Entity	定义检测到的实体对象，该对象包含检测到的实体类别和实体文本等。
EntityCategory	包含实体识别检测到的所有实体类别。
EntityInferenceOptions	包含允许命名实体识别的推理选项的类。
EntityLinkingResult	实体链接结果。
EntityLinkingTaskParameters	实体链接任务支持的参数。
EntityLinkingTaskResult	包含分析文本实体链接任务结果。
EntityTag	实体标记对象，其中包含标记的名称和任何关联的置信度分数。实体标签用于表达实体之间的一些相似性/亲和力。
EntityWithMetadata	带有标记和元数据的实体对象。
Error	当服务在处理请求期间遇到一些错误时返回的错误响应对象。
ErrorCode	人工可读错误代码。
ErrorResponse	错误响应。
InformationMetadata	表示信息（数据）实体元数据模型。
InformationUnit	信息（数据）度量单位。
InnerErrorCode	人工可读错误代码。
InnerErrorModel	包含有关错误的更具体信息的对象。根据Microsoft一个 API 指南 - https://github.com/Microsoft/api-guidelines/blob/vNext/Guidelines.md#7102-error-condition-responses。
KeyPhraseResult	包含 KeyPhraseResult。
KeyPhrasesDocumentResult	包含文档的关键短语提取结果。
KeyPhraseTaskParameters	关键短语提取任务支持的参数。
KeyPhraseTaskResult	包含分析文本 KeyPhraseExtraction 任务结果。
LanguageDetectionAnalysisInput	包含语言检测文档分析输入。
LanguageDetectionDocumentResult	包含文档的语言检测。
LanguageDetectionResult	包含请求的语言检测结果。
LanguageDetectionTaskParameters	语言检测任务支持的参数。
LanguageDetectionTaskResult	包含请求的语言检测任务结果。
LanguageInput	包含语言检测输入。
LengthMetadata	表示长度实体元数据模型。
LengthUnit	测量的长度单位。
LinkedEntitiesDocumentResult	实体链接文档结果。
LinkedEntity	LinkedEntity 对象，其中包含检测到的实体以及关联的源/链接。
Match	Match 对象包含检测到的实体文本及其偏移量和长度。
MatchLongestEntityPolicyType	表示匹配最长重叠策略。尽可能不要有重叠的实体。 1. 如果存在重叠的实体，则返回最长的实体。 2. 如果预测的 2 个或更多实体的字符集完全相同，请选择置信度得分较高的实体。如果实体分数相同，则返回应用先前规则后仍然存在的所有实体。 3. 如果存在部分重叠（如 Hello Text Analytics），请从 1 开始执行上述步骤。
MetadataKind	实体 Metadata 对象类型。
MultiLanguageAnalysisInput	要由服务分析的输入文档的集合。
MultiLanguageInput	包含要由服务分析的输入文档。
NumberKind	提取的数字实体的类型。
NumberMetadata	数字实体实例的元数据。
NumericRangeMetadata	表示数字间隔的元数据。
OrdinalMetadata	数字实体实例的元数据。
PiiCategory	（可选）描述要返回的 PII 类别
PiiDomain	PII 任务的域
PiiEntitiesDocumentResult	包含 PII 结果。
PiiResult	包含 PiiResult。
PiiTaskParameters	PII 实体识别任务支持的参数。
PiiTaskResult	包含分析文本 PIIEntityRecognition LRO 任务。
RangeInclusivity	此属性属性的范围包含性。
RangeKind	数字范围实体的类型。
RelativeTo	序号表示的引用点。
RequestStatistics	如果在请求中指定 showStats=true，则此字段将包含有关请求有效负载的信息。
ScriptCode	标识输入文档的脚本。映射到 ISO 15924 标准脚本代码。
ScriptKind	标识输入文档的脚本。映射到 ISO 15924 标准正式名称。
SentenceAssessment	表示句子评估以及与之相关的评估或目标对象。
SentenceSentiment	文档的句子情绪。
SentenceSentimentValue	句子的预测情绪。
SentenceTarget	表示句子目标以及与之相关的评估或目标对象。
SentimentAnalysisTaskParameters	情绪分析任务支持的参数。
SentimentConfidenceScores	表示所有情绪类中介于 0 和 1 之间的置信度分数：正、中性、负数。
SentimentDocumentResult	表示每个文档的预构建情绪分析结果的对象。
SentimentResponse	输入文档的情绪分析结果。
SentimentTaskResult	包含分析文本 SentimentAnalysis LRO 任务结果。
SpeedMetadata	表示 Speed 实体元数据模型。
SpeedUnit	测量速度单位
StringIndexType	字符串索引类型
TargetConfidenceScoreLabel	表示所有情绪类的置信度分数：正数和负数。
TargetRelation	表示评估和/或目标之间的关系。
TargetRelationType	与目标相关的类型。
TemperatureMetadata	表示信息实体元数据模型。
TemperatureUnit	温度度量单位。
TemporalModifier	日期/时间实例的可选修饰符。
TemporalSetMetadata	时态集实体实例的元数据。
TemporalSpanMetadata	表示日期和/或时间跨度的元数据。
TemporalSpanValues	时态跨度对象。
TimeMetadata	时间实体实例的元数据。
TokenSentimentValue	句子的预测情绪。
VolumeMetadata	表示卷实体元数据模型。
VolumeUnit	测量量单位
WarningCodeValue	定义警告代码的列表。
WeightMetadata	表示 Weight ）实体元数据模型。
WeightUnit	度量单位的权重单位。

AgeMetadata

Object

表示年龄实体元数据模型。

名称	类型	说明
metadataKind	string: AgeMetadata	实体 Metadata 对象类型。
unit	AgeUnit	年龄的度量单位。
value	number (double)	提取的文本表示的数值。

AgeUnit

枚举

度量的年龄单位

值	说明
Unspecified	未指定的时间段
Year	一年的时间段
Month	一个月的时间段
Week	一周的时间段
Day	一天中的时间段

AllowOverlapEntityPolicyType

Object

表示允许重叠策略。不会对实体应用任何后处理逻辑。无论模型预测什么，都会返回给用户。这允许用户全面了解每个模型的可能值，并在实体选择上应用自己的自定义逻辑

名称	类型	默认值	说明
policyKind	string: allowOverlap	matchLongest	实体 OverlapPolicy 对象类型。

AnalyzeTextEntityLinkingInput

Object

包含分析文本实体链接输入。

名称	类型	说明
analysisInput	MultiLanguageAnalysisInput	包含要由服务处理的分析输入。
kind	string: EntityLinking	要执行的任务类型。
parameters	EntityLinkingTaskParameters	任务参数。

AnalyzeTextEntityRecognitionInput

Object

实体识别分析文本输入任务请求。

名称	类型	说明
analysisInput	MultiLanguageAnalysisInput	要分析的输入。
kind	string: EntityRecognition	要执行的任务类型。
parameters	EntitiesTaskParameters	任务参数。

AnalyzeTextKeyPhraseExtractionInput

Object

包含分析文本 KeyPhraseExtraction 任务输入。

名称	类型	说明
analysisInput	MultiLanguageAnalysisInput	包含输入文档。
kind	string: KeyPhraseExtraction	要执行的任务类型。
parameters	KeyPhraseTaskParameters	关键短语提取任务参数。

AnalyzeTextLanguageDetectionInput

Object

包含语言检测文档分析任务输入。

名称	类型	说明
analysisInput	LanguageDetectionAnalysisInput	要分析的文档。
kind	string: LanguageDetection	要执行的任务类型。
parameters	LanguageDetectionTaskParameters	任务参数。

AnalyzeTextPiiEntitiesRecognitionInput

Object

包含分析文本 PIIEntityRecognition 任务输入。

名称	类型	说明
analysisInput	MultiLanguageAnalysisInput	包含输入文档。
kind	string: PiiEntityRecognition	要执行的任务类型。
parameters	PiiTaskParameters	Pii 任务参数。

AnalyzeTextSentimentAnalysisInput

Object

包含分析文本 SentimentAnalysis 任务输入。

名称	类型	说明
analysisInput	MultiLanguageAnalysisInput	包含输入文档。
kind	string: SentimentAnalysis	要执行的任务类型。
parameters	SentimentAnalysisTaskParameters	情绪分析任务参数。

AnalyzeTextTaskKind

枚举

支持的分析文本任务类型。

值	说明
SentimentAnalysis	情绪分析任务
EntityRecognition	实体识别任务
PiiEntityRecognition	PII 实体识别任务
KeyPhraseExtraction	关键短语提取任务
LanguageDetection	语言检测任务
EntityLinking	实体链接任务

AnalyzeTextTaskResultsKind

枚举

analyze-text 任务返回的响应对象的类型。

值	说明
SentimentAnalysisResults	情绪分析结果
EntityRecognitionResults	实体识别结果
PiiEntityRecognitionResults	PII 实体识别结果
KeyPhraseExtractionResults	关键短语提取结果
LanguageDetectionResults	语言检测结果
EntityLinkingResults	实体链接结果

AreaMetadata

Object

表示 Area 实体元数据模型。

名称	类型	说明
metadataKind	string: AreaMetadata	实体 Metadata 对象类型。
unit	AreaUnit	面积的计量单位。
value	number (double)	提取的文本表示的数值。

AreaUnit

枚举

度量面积单位。

值	说明
Unspecified	未指定的区域单位
SquareKilometer	面积单位（平方公里）
SquareHectometer	面积单位（平方百米）
SquareDecameter	面积单位（以平方十进米为单位）
SquareDecimeter	面积单位（平方分米）
SquareMeter	面积单位（平方米）
SquareCentimeter	面积单位（平方厘米）
SquareMillimeter	面积单位（平方毫米）
SquareInch	面积单位（平方英寸）
SquareFoot	面积单位（平方英尺）
SquareMile	面积单位（平方英里）
SquareYard	面积单位（平方米）
Acre	面积单位（英亩）

CurrencyMetadata

Object

表示 Currency ）实体元数据模型。

名称	类型	说明
iso4217	string	基于另一个 ISO 标准 ISO 3166 的字母代码，其中列出了国家/地区名称的代码。 ISO 4217 三字母代码的前两个字母与国家/地区名称的代码相同，并且，如果可能，第三个字母对应于货币名称的第一个字母。
metadataKind	string: CurrencyMetadata	实体 Metadata 对象类型。
unit	string	货币单位。
value	number (double)	提取的文本表示的数值。

DateMetadata

Object

日期实体实例的元数据。

名称	类型	说明
dateValues	DateValue[]	日期值列表。
metadataKind	string: DateMetadata	实体 Metadata 对象类型。

DateTimeMetadata

Object

日期时间实体实例的元数据。

名称	类型	说明
dateValues	DateValue[]	日期值列表。
metadataKind	string: DateTimeMetadata	实体 Metadata 对象类型。

DateValue

Object

表示日期值。

名称	类型	说明
modifier	TemporalModifier	日期时间的修饰符，用于指示参考点，如之前、之后等。
timex	string	如（https://github.com/Microsoft/Recognizers-Text/blob/master/Patterns/English/English-DateTime.yaml）中所述的延长 ISO 8601 日期/时间表示形式
value	string	提取的文本表示的实际时间。

DetectedLanguage

Object

包含检测到的文本语言的详细信息。

名称	类型	说明
confidenceScore	number (double)	置信度分数介于 0 和 1 之间。分数接近 1 表示 100% 确定所识别语言为 true。
iso6391Name	string	根据 ISO 639-1 标准（例如 en、fr）检测语言的两个字母表示形式。
name	string	检测到的语言（例如英语、法语）的长名称。
scriptIso15924Code	ScriptCode	根据 ISO 15924 标准标识输入文档的脚本代码。
scriptName	ScriptKind	根据 ISO 15924 标准标识输入文档的脚本名称。

DocumentError

Object

包含作业执行期间遇到的错误的详细信息。

名称	类型	说明
error	Error	遇到错误。
id	string	输入文档的 ID。

DocumentSentimentValue

枚举

文档的预测情绪（负面、中性、积极或混合）。

值	说明
positive	正面陈述
neutral	中立声明
negative	否定声明
mixed	混合声明

DocumentStatistics

Object

如果在请求中指定 showStats=true，则此字段将包含有关文档有效负载的信息。

名称	类型	说明
charactersCount	integer (int32)	文档中识别的文本元素数。
transactionsCount	integer (int32)	文档的事务数。

DocumentWarning

Object

包含警告对象，其中包含已处理文档遇到的警告。

名称	类型	说明
code	WarningCodeValue	警告代码。
message	string	警告消息。
targetRef	string	指示目标对象的 JSON 指针引用。

EntitiesDocumentResultWithMetadata

Object

包含元数据的实体文档结果。

名称	类型	说明
entities	EntityWithMetadata[]	文档中的已识别实体。
id	string	唯一的非空文档标识符。
statistics	DocumentStatistics	如果在请求中指定 showStats=true，则此字段将包含有关文档有效负载的信息。
warnings	DocumentWarning[]	处理文档时遇到的警告。

EntitiesResult

Object

包含实体识别任务结果。

名称	类型	说明
documents	EntitiesDocumentResultWithMetadata[]	按文档响应
errors	DocumentError[]	按文档 ID 显示的错误。
modelVersion	string	此字段指示用于评分的模型。
statistics	RequestStatistics	如果在请求中指定 showStats=true，则此字段将包含有关请求有效负载的信息。

EntitiesTaskParameters

Object

实体识别任务支持的参数。

名称	类型	默认值	说明
exclusionList	EntityCategory[]		（可选）请求参数，用于筛选出包含 excludeList 的任何实体。当用户指定 excludeList 时，他们无法获取与该列表中的实体一起返回的预测。我们将在 exclusionList 之前应用 inclusionList
inclusionList	EntityCategory[]		（可选）请求参数，该参数将输出限制为此列表中包含的请求实体类型。我们将在 exclusionList 之前应用 inclusionList
inferenceOptions	EntityInferenceOptions		（可选）请求参数，允许用户提供运行推理的设置。
loggingOptOut	boolean	False	登录选择退出
modelVersion	string	latest	型号版本
overlapPolicy	BaseEntityOverlapPolicy: AllowOverlapEntityPolicyType MatchLongestEntityPolicyType		（可选）描述要应用于 ner 输出的重叠策略类型。
stringIndexType	StringIndexType	TextElements_v8	（可选）参数，用于提供用于解释字符串偏移量的字符串索引类型。默认为 TextElements（字素）。

EntitiesTaskResult

Object

包含实体任务

名称	类型	说明
kind	string: EntityRecognitionResults	任务结果的类型。
results	EntitiesResult	实体识别的结果。

Entity

Object

定义检测到的实体对象，该对象包含检测到的实体类别和实体文本等。

名称	类型	说明
category	string	实体类型。
confidenceScore	number (double)	提取实体的 0 到 1 之间的置信度分数。
length	integer (int32)	实体文本的长度。使用不同的“stringIndexType”值可能会影响返回的长度。
offset	integer (int32)	实体文本的起始位置。使用不同的“stringIndexType”值可能会影响返回的偏移量。
subcategory	string	（可选）实体子类型。
text	string	请求中显示的实体文本。

EntityCategory

枚举

包含实体识别检测到的所有实体类别。

值	说明
Address	具体的街道级别提及位置：房屋/建筑物编号、街道、大道、高速公路、名称引用的十字路口。
Numeric	数值，包括数字和数字单词。
Age	与年龄相关的值。
Currency	与货币相关的值。
Number	没有单位的数字
NumberRange	数字范围
Percentage	与百分比相关的值。
Ordinal	序数。
Temperature	与温度相关的值。
Dimension	测量尺寸
Length	对象的长度。
Weight	物体的重量。
Height	物体的高度。
Speed	物体的速度。
Area	对象的面积。
Volume	对象的体积。
Information	数字信息的计量单位。
Temporal	与时间有关的项目。
Date	日历日期。
Time	一天中的时间。
DateTime	日历日期与时间。
DateRange	日期范围。
TimeRange	时间范围。
DateTimeRange	日期和时间范围。
Duration	持续时间。
SetTemporal	与时间相关的值集。
Event	有时间段的社会、体育、商业、政治、教育、自然、历史、犯罪、暴力、法律、军事事件。
SportsEvent	与体育赛事相关的值。
CulturalEvent	与文化活动相关的价值观。
NaturalEvent	与自然事件相关的值。
Location	物理空间中的特定点或地点。
GPE	城市、国家/地区、州。
City	与城市相关的值。
State	与状态相关的值。
CountryRegion	与国家或地区相关的值。
Continent	与大陆相关的值。
Structural	人造结构。
Airport	机场。
Geological	地理和自然特征，例如河流、海洋和沙漠。
Organization	由某种既定组织结构定义的公司、机构和其他人群。这些标签可以包括公司、政党/运动、乐队、体育俱乐部、政府机构和公共组织。国籍或宗教不是组织。
OrganizationMedical	医疗公司和团体。
OrganizationStockExchange	证券交易所集团。
OrganizationSports	与体育相关的组织。
Person	名字、姓氏和中间名、虚构人物的名字和别名。头衔，例如“先生”。或“总统”，不被视为指定实体的一部分。
PersonType	按组成员身份分类的人类角色。
Email	电子邮件地址。
URL	网站的 URL。
IP	网络 IP 地址。
PhoneNumber	电话号码（仅限美国和欧洲电话号码）。
Product	单个或一组商业、消耗品、电子产品、车辆、食品组。
ComputingProduct	计算产品。
Skill	一种能力、技能或专业知识。

EntityInferenceOptions

Object

包含允许命名实体识别的推理选项的类。

名称	类型	默认值	说明
excludeNormalizedValues	boolean	False	包含/排除检测到的实体值以进行规范化并包含在元数据中的选项。数字和时态实体类型支持值规范化。

EntityLinkingResult

Object

实体链接结果。

名称	类型	说明
documents	LinkedEntitiesDocumentResult[]	按文档响应
errors	DocumentError[]	按文档 ID 显示的错误。
modelVersion	string	此字段指示用于评分的模型。
statistics	RequestStatistics	如果在请求中指定 showStats=true，则此字段将包含有关请求有效负载的信息。

EntityLinkingTaskParameters

Object

实体链接任务支持的参数。

名称	类型	默认值	说明
loggingOptOut	boolean	False	登录选择退出
modelVersion	string	latest	型号版本
stringIndexType	StringIndexType	TextElements_v8	可选参数，用于提供用于解释字符串偏移量的字符串索引类型。默认为 TextElements（字素）。

EntityLinkingTaskResult

Object

包含分析文本实体链接任务结果。

名称	类型	说明
kind	string: EntityLinkingResults	任务结果的类型。
results	EntityLinkingResult	实体链接结果。

EntityTag

Object

实体标记对象，其中包含标记的名称和任何关联的置信度分数。实体标签用于表达实体之间的一些相似性/亲和力。

名称	类型	说明
confidenceScore	number (double)	提取实体的检测分数介于 0 和 1 之间。
name	string	标记的名称。实体标记名称将在全局范围内是唯一的。

EntityWithMetadata

Object

带有标记和元数据的实体对象。

名称	类型	说明
category	string	实体类型。
confidenceScore	number (double)	提取实体的 0 到 1 之间的置信度分数。
length	integer (int32)	实体文本的长度。使用不同的“stringIndexType”值可能会影响返回的长度。
metadata	BaseMetadata: AgeMetadata AreaMetadata CurrencyMetadata DateMetadata DateTimeMetadata InformationMetadata LengthMetadata NumberMetadata NumericRangeMetadata OrdinalMetadata SpeedMetadata TemperatureMetadata TemporalSetMetadata TemporalSpanMetadata TimeMetadata VolumeMetadata WeightMetadata	实体元数据对象。
offset	integer (int32)	实体文本的起始位置。使用不同的“stringIndexType”值可能会影响返回的偏移量。
subcategory	string	（可选）实体子类型。
tags	EntityTag[]	实体标记列表。标签是为了表达实体之间的一些相似性/亲和力。
text	string	请求中显示的实体文本。
type	string	实体类型是检测到实体的最低（或最细）粒度。该类型映射到与检测到的实体关联的特定元数据属性。

Error

Object

当服务在处理请求期间遇到一些错误时返回的错误响应对象。

名称	类型	说明
code	ErrorCode	服务器定义的错误代码集之一。
details	Error[]	导致此报告错误的特定错误的详细信息数组。
innererror	InnerErrorModel	包含与当前对象有关错误的更具体信息的对象。
message	string	错误的人工可读表示形式。
target	string	错误的目标。

ErrorCode

枚举

人工可读错误代码。

值	说明
InvalidRequest	请求错误无效
InvalidArgument	参数错误无效
Unauthorized	未经授权的访问错误
Forbidden	禁止访问错误
NotFound	找不到错误
ProjectNotFound	项目找不到错误
OperationNotFound	找不到操作错误
AzureCognitiveSearchNotFound	Azure 认知搜索找不到错误
AzureCognitiveSearchIndexNotFound	Azure 认知搜索索引找不到错误
TooManyRequests	请求过多错误
AzureCognitiveSearchThrottling	Azure 认知搜索限制错误
AzureCognitiveSearchIndexLimitReached	Azure 认知搜索索引限制达到错误
InternalServerError	内部服务器错误
ServiceUnavailable	服务不可用错误
Timeout	超时错误
QuotaExceeded	超出配额错误
Conflict	冲突错误
Warning	警告错误

ErrorResponse

Object

错误响应。

名称	类型	说明
error	Error	错误对象。

InformationMetadata

Object

表示信息（数据）实体元数据模型。

名称	类型	说明
metadataKind	string: InformationMetadata	实体 Metadata 对象类型。
unit	InformationUnit	信息的度量单位。
value	number (double)	提取的文本表示的数值。

InformationUnit

枚举

信息（数据）度量单位。

值	说明
Unspecified	未指定的数据大小单位
Bit	数据大小单位（以位为单位）
Kilobit	数据大小单位（以千比特为单位）
Megabit	数据大小单位（以兆位为单位）
Gigabit	数据大小单位（千兆位）
Terabit	数据大小单位（以太比特为单位）
Petabit	数据大小单位（以 PB 为单位）
Byte	数据大小单位（以字节为单位）
Kilobyte	数据大小单位（以千字节为单位）
Megabyte	数据大小单位（以兆字节为单位）
Gigabyte	数据大小单位（以千兆字节为单位）
Terabyte	数据大小单位（以 TB 为单位）
Petabyte	数据大小单位（PB）

InnerErrorCode

枚举

人工可读错误代码。

值	说明
InvalidRequest	请求错误无效
InvalidParameterValue	参数值错误无效
KnowledgeBaseNotFound	知识库找不到错误
AzureCognitiveSearchNotFound	Azure 认知搜索找不到错误
AzureCognitiveSearchThrottling	Azure 认知搜索限制错误
ExtractionFailure	提取失败错误
InvalidRequestBodyFormat	请求正文格式错误无效
EmptyRequest	空请求错误
MissingInputDocuments	缺少输入文档错误
InvalidDocument	文档错误无效
ModelVersionIncorrect	模型版本错误错误
InvalidDocumentBatch	文档批处理错误无效
UnsupportedLanguageCode	不支持的语言代码错误
InvalidCountryHint	国家/地区提示错误无效

InnerErrorModel

Object

包含有关错误的更具体信息的对象。根据Microsoft一个 API 指南 - https://github.com/Microsoft/api-guidelines/blob/vNext/Guidelines.md#7102-error-condition-responses。

名称	类型	说明
code	InnerErrorCode	服务器定义的错误代码集之一。
details	object	错误详细信息。
innererror	InnerErrorModel	包含与当前对象有关错误的更具体信息的对象。
message	string	错误消息。
target	string	错误目标。

KeyPhraseResult

Object

包含 KeyPhraseResult。

名称	类型	说明
documents	KeyPhrasesDocumentResult[]	按文档响应
errors	DocumentError[]	按文档 ID 显示的错误。
modelVersion	string	此字段指示用于评分的模型。
statistics	RequestStatistics	如果在请求中指定 showStats=true，则此字段将包含有关请求有效负载的信息。

KeyPhrasesDocumentResult

Object

包含文档的关键短语提取结果。

名称	类型	说明
id	string	唯一的非空文档标识符。
keyPhrases	string[]	具有代表性的字词或短语的列表。返回的关键短语数与输入文档中的字数成正比。
statistics	DocumentStatistics	如果在请求中指定 showStats=true，则此字段将包含有关文档有效负载的信息。
warnings	DocumentWarning[]	处理文档时遇到的警告。

KeyPhraseTaskParameters

Object

关键短语提取任务支持的参数。

名称	类型	默认值	说明
loggingOptOut	boolean	False	登录选择退出
modelVersion	string	latest	型号版本

KeyPhraseTaskResult

Object

包含分析文本 KeyPhraseExtraction 任务结果。

名称	类型	说明
kind	string: KeyPhraseExtractionResults	任务结果的类型。
results	KeyPhraseResult	关键短语提取结果列表

LanguageDetectionAnalysisInput

Object

包含语言检测文档分析输入。

名称	类型	说明
documents	LanguageInput[]	要分析的文档列表。

LanguageDetectionDocumentResult

Object

包含文档的语言检测。

名称	类型	说明
detectedLanguage	DetectedLanguage	检测到的语言。
id	string	唯一的非空文档标识符。
statistics	DocumentStatistics	如果在请求中指定 showStats=true，则此字段将包含有关文档有效负载的信息。
warnings	DocumentWarning[]	处理文档时遇到的警告。

LanguageDetectionResult

Object

包含请求的语言检测结果。

名称	类型	说明
documents	LanguageDetectionDocumentResult[]	枚举每个输入文档的语言检测结果。
errors	DocumentError[]	按文档 ID 显示的错误。
modelVersion	string	此字段指示用于评分的模型。
statistics	RequestStatistics	如果在请求中指定 showStats=true，则此字段将包含有关请求有效负载的信息。

LanguageDetectionTaskParameters

Object

语言检测任务支持的参数。

名称	类型	默认值	说明
loggingOptOut	boolean	False	登录选择退出
modelVersion	string	latest	型号版本

LanguageDetectionTaskResult

Object

包含请求的语言检测任务结果。

名称	类型	说明
kind	string: LanguageDetectionResults	任务结果的类型。
results	LanguageDetectionResult	包含语言检测结果。

LanguageInput

Object

包含语言检测输入。

名称	类型	说明
countryHint	string	该国暗示帮助文本的语言检测。
id	string	唯一的非空文档标识符。
text	string	要处理的输入文本。

LengthMetadata

Object

表示长度实体元数据模型。

名称	类型	说明
metadataKind	string: LengthMetadata	实体 Metadata 对象类型。
unit	LengthUnit	长度的度量单位。
value	number (double)	提取的文本表示的数值。

LengthUnit

枚举

测量的长度单位。

值	说明
Unspecified	未指定的长度单位。
Kilometer	长度单位，以公里为单位。
Hectometer	长度单位，以百米为单位。
Decameter	长度单位，以十米为单位。
Meter	长度单位，以米为单位。
Decimeter	长度单位，单位为分米。
Centimeter	长度单位（以厘米为单位）。
Millimeter	长度单位（以毫米为单位）。
Micrometer	长度单位，单位为微米。
Nanometer	长度单位，单位为纳米。
Picometer	长度单位（以皮米为单位）。
Mile	长度单位，以英里为单位。
Yard	长度单位（以码为单位）。
Inch	长度单位，以英寸为单位。
Foot	长度单位，以英尺为单位。
LightYear	长度单位，以光年为单位。
Point	长度单位（以点为单位）。

LinkedEntitiesDocumentResult

Object

实体链接文档结果。

名称	类型	说明
entities	LinkedEntity[]	文档中已识别的已知实体。
id	string	唯一的非空文档标识符。
statistics	DocumentStatistics	如果在请求中指定 showStats=true，则此字段将包含有关文档有效负载的信息。
warnings	DocumentWarning[]	处理文档时遇到的警告。

LinkedEntity

Object

LinkedEntity 对象，其中包含检测到的实体以及关联的源/链接。

名称	类型	说明
bingId	string	已识别实体的必应实体搜索 API 唯一标识符。
dataSource	string	用于提取实体链接的数据源，如 Wiki/必应等。
id	string	数据源中已识别实体的唯一标识符。
language	string	数据源中使用的语言。
matches	Match[]	此实体的实例列表显示在文本中。
name	string	实体链接形式名称。
url	string	数据源中实体页面的 URL。

Match

Object

Match 对象包含检测到的实体文本及其偏移量和长度。

名称	类型	说明
confidenceScore	number (double)	如果识别出已知项，则会返回一个十进制数字，表示 0 和 1 之间的置信度级别。
length	integer (int32)	实体匹配文本的长度。
offset	integer (int32)	实体匹配文本的起始位置。
text	string	请求中显示的实体文本。

MatchLongestEntityPolicyType

Object

表示匹配最长重叠策略。尽可能不要有重叠的实体。 1. 如果存在重叠的实体，则返回最长的实体。 2. 如果预测的 2 个或更多实体的字符集完全相同，请选择置信度得分较高的实体。如果实体分数相同，则返回应用先前规则后仍然存在的所有实体。 3. 如果存在部分重叠（如 Hello Text Analytics），请从 1 开始执行上述步骤。

名称	类型	默认值	说明
policyKind	string: matchLongest	matchLongest	实体 OverlapPolicy 对象类型。

MetadataKind

枚举

实体 Metadata 对象类型。

值	说明
DateMetadata	日期相关值的元数据。
DateTimeMetadata	日期和时间相关值的元数据。
TimeMetadata	与时间相关的值的元数据。
TemporalSetMetadata	与时间相关的值集的元数据。
NumberMetadata	数值的元数据。
OrdinalMetadata	序数的元数据。
SpeedMetadata	与速度相关的值的元数据。
WeightMetadata	与权重相关的值的元数据。
LengthMetadata	长度相关值的元数据。
VolumeMetadata	卷相关值的元数据。
AreaMetadata	区域相关值的元数据。
AgeMetadata	与年龄相关的值的元数据。
InformationMetadata	信息相关值的元数据。
TemperatureMetadata	温度相关值的元数据。
CurrencyMetadata	货币相关值的元数据。
NumericRangeMetadata	数值范围值的元数据。
TemporalSpanMetadata	时态跨度值的元数据。

MultiLanguageAnalysisInput

Object

要由服务分析的输入文档的集合。

名称	类型	说明
documents	MultiLanguageInput[]	要分析的输入文档。

MultiLanguageInput

Object

包含要由服务分析的输入文档。

名称	类型	说明
id	string	唯一的非空文档标识符。
language	string	（可选）这是语言的 2 个字母 ISO 639-1 表示形式。例如，将“en”用于英语;西班牙语等的“es”。如果未设置，请将“en”用于英语作为默认值。（以下内容仅适用于 2023-04-15-preview 及以上版本）对于自动语言检测，请使用“auto”。如果未设置，则默认使用“en”表示英语。
text	string	要处理的输入文本。

NumberKind

枚举

提取的数字实体的类型。

值	说明
Integer	整数
Decimal	十进制数
Power	电源编号
Fraction	分数号
Percent	百分比
Unspecified	未指定的数字类型

NumberMetadata

Object

数字实体实例的元数据。

名称	类型	说明
metadataKind	string: NumberMetadata	实体 Metadata 对象类型。
numberKind	NumberKind	数字类型的种类。
value	number (double)	提取的文本所表示内容的数值表示形式。

NumericRangeMetadata

Object

表示数字间隔的元数据。

名称	类型	说明
maximum	number (double)	间隔的结束值。
metadataKind	string: NumericRangeMetadata	实体 Metadata 对象类型。
minimum	number (double)	间隔的起始值。
rangeInclusivity	RangeInclusivity	这个范围的包容性。
rangeKind	RangeKind	支持的数字范围类型 - 如数字、速度等。

OrdinalMetadata

Object

数字实体实例的元数据。

名称	类型	说明
metadataKind	string: OrdinalMetadata	实体 Metadata 对象类型。
offset	string	引用的偏移量（例如偏移量 = -1 指示第二个到最后一个）
relativeTo	RelativeTo	序号表示的引用点。
value	string	序号表示的简单算术表达式。

PiiCategory

枚举

（可选）描述要返回的 PII 类别

值	说明
ABARoutingNumber	ABA 路由号码
ARNationalIdentityNumber	AR 国民身份证号码
AUBankAccountNumber	AT 银行帐号
AUDriversLicenseNumber	AU 驾照号码
AUMedicalAccountNumber	AU 医疗账号
AUPassportNumber	澳大利亚护照号码
AUTaxFileNumber	AU 税号
AUBusinessNumber	AU 商业号码
AUCompanyNumber	AU 公司编号
ATIdentityCard	AT 身份证
ATTaxIdentificationNumber	AT 税号
ATValueAddedTaxNumber	AT 增值税号
AzureDocumentDBAuthKey	Azure 文档数据库身份验证密钥
AzureIAASDatabaseConnectionAndSQLString	Azure IAAS 数据库连接和 SQL 字符串
AzureIoTConnectionString	Azure IoT 连接字符串
AzurePublishSettingPassword	Azure 发布设置密码
AzureRedisCacheString	Azure Redis 缓存字符串
AzureSAS	Azure SAS
AzureServiceBusString	Azure 服务总线字符串
AzureStorageAccountKey	Azure 存储帐户密钥
AzureStorageAccountGeneric	Azure 存储帐户通用
BENationalNumber	BE国家号码
BENationalNumberV2	BE国家号码V2
BEValueAddedTaxNumber	BE增值税号
BRCPFNumber	BR CPF 编号
BRLegalEntityNumber	BR 法人实体编号
BRNationalIDRG	BR 国民身份证 RG
BGUniformCivilNumber	BG统一民用编号
CABankAccountNumber	CA 银行帐号
CADriversLicenseNumber	CA 驾照号码
CAHealthServiceNumber	CA 运行状况服务编号
CAPassportNumber	CA 护照号码
CAPersonalHealthIdentification	CA 个人健康识别
CASocialInsuranceNumber	CA社会保险号码
CLIdentityCardNumber	CL身份证号码
CNResidentIdentityCardNumber	中国居民身份证号码
CreditCardNumber	信用卡号
HRIdentityCardNumber	人力资源身份证号码
HRNationalIDNumber	人力资源国民身份证号码
HRPersonalIdentificationNumber	人力资源个人识别号码
HRPersonalIdentificationOIBNumberV2	HR 个人识别 OIB 编号 V2
CYIdentityCard	CY身份证
CYTaxIdentificationNumber	CY 税号
CZPersonalIdentityNumber	CZ个人身份证号码
CZPersonalIdentityV2	CZ 个人身份 V2
DKPersonalIdentificationNumber	DK 个人识别码
DKPersonalIdentificationV2	DK 个人识别 V2
DrugEnforcementAgencyNumber	缉毒局编号
EEPersonalIdentificationCode	EE 个人识别码
EUDebitCardNumber	欧盟借记卡号码
EUDriversLicenseNumber	欧盟驾照号码
EUGPSCoordinates	欧盟 GPS 坐标
EUNationalIdentificationNumber	欧盟国民身份证号码
EUPassportNumber	欧盟护照号码
EUSocialSecurityNumber	欧盟社会安全号码
EUTaxIdentificationNumber	欧盟税号
FIEuropeanHealthNumber	FI 欧洲健康号码
FINationalID	FI 国民身份证
FINationalIDV2	FI 国民身份证 V2
FIPassportNumber	FI 护照号码
FRDriversLicenseNumber	FR 驾照号码
FRHealthInsuranceNumber	FR 健康保险号码
FRNationalID	FR 国民身份证
FRPassportNumber	法国护照号码
FRSocialSecurityNumber	FR 社会安全号码
FRTaxIdentificationNumber	FR 税号
FRValueAddedTaxNumber	FR 增值税号
DEDriversLicenseNumber	德国驾照号码
DEPassportNumber	DE 护照号码
DEIdentityCardNumber	德国身份证号码
DETaxIdentificationNumber	DE 税号
DEValueAddedNumber	DE增值数
GRNationalIDCard	GR 国民身份证
GRNationalIDV2	GR 国民身份证 V2
GRTaxIdentificationNumber	GR 税号
HKIdentityCardNumber	香港身份证号码
HUValueAddedNumber	胡增值号
HUPersonalIdentificationNumber	胡个人识别号码
HUTaxIdentificationNumber	胡税号
INPermanentAccount	IN 永久账户
INUniqueIdentificationNumber	IN 唯一识别号
IDIdentityCardNumber	身份证号码
InternationalBankingAccountNumber	国际银行账号
IEPersonalPublicServiceNumber	IE个人公共服务号码
IEPersonalPublicServiceNumberV2	IE个人公共服务号码V2
ILBankAccountNumber	IL 银行帐号
ILNationalID	IL 国民身份证
ITDriversLicenseNumber	IT驾照号码
ITFiscalCode	IT 财务代码
ITValueAddedTaxNumber	IT增值税号
JPBankAccountNumber	JP 银行账号
JPDriversLicenseNumber	日本驾照号码
JPPassportNumber	日本护照号码
JPResidentRegistrationNumber	日本居民登记号码
JPSocialInsuranceNumber	日本社会保险号码
JPMyNumberCorporate	JP 个人编号公司
JPMyNumberPersonal	JP 个人编号个人
JPResidenceCardNumber	日本在留卡号码
LVPersonalCode	LV个人代码
LTPersonalCode	LT 个人代码
LUNationalIdentificationNumberNatural	LU 国民身份证号码自然
LUNationalIdentificationNumberNonNatural	LU 国民身份证号码非自然
MYIdentityCardNumber	我的身份证号码
MTIdentityCardNumber	MT 身份证号码
MTTaxIDNumber	MT 税号
NLCitizensServiceNumber	荷兰公民服务号码
NLCitizensServiceNumberV2	荷兰公民服务编号 V2
NLTaxIdentificationNumber	荷兰税务识别号
NLValueAddedTaxNumber	荷兰增值税号
NZBankAccountNumber	新西兰银行帐号
NZDriversLicenseNumber	新西兰驾照号码
NZInlandRevenueNumber	新西兰税务数字
NZMinistryOfHealthNumber	新西兰卫生部编号
NZSocialWelfareNumber	新西兰社会福利号码
NOIdentityNumber	无身份证号码
PHUnifiedMultiPurposeIDNumber	PH 统一多用途 ID 号
PLIdentityCard	PL身份证
PLNationalID	PL 国民身份证
PLNationalIDV2	PL 国民身份证 V2
PLPassportNumber	PL 护照号码
PLTaxIdentificationNumber	PL 税号
PLREGONNumber	PL REGON编号
PTCitizenCardNumber	PT 公民卡号
PTCitizenCardNumberV2	PT 公民卡号 V2
PTTaxIdentificationNumber	PT 税号
ROPersonalNumericalCode	RO个人数字代码
RUPassportNumberDomestic	RU 护照号码国内
RUPassportNumberInternational	RU 护照号码国际
SANationalID	南澳国民身份证
SGNationalRegistrationIdentityCardNumber	新加坡国民登记身份证号码
SKPersonalNumber	SK个人号码
SITaxIdentificationNumber	SI 税号
SIUniqueMasterCitizenNumber	SI 唯一主公民号码
ZAIdentificationNumber	ZA 识别号
KRResidentRegistrationNumber	韩国居民登录号码
ESDNI	ES DNI
ESSocialSecurityNumber	ES 社会安全号码
ESTaxIdentificationNumber	ES 税号
SQLServerConnectionString	SQL Server 连接字符串
SENationalID	东南国民身份证
SENationalIDV2	SE 国民身份证 V2
SEPassportNumber	SE 护照号码
SETaxIdentificationNumber	SE 税号
SWIFTCode	SWIFT 代码
CHSocialSecurityNumber	CH 社会安全号码
TWNationalID	台湾国民身份证
TWPassportNumber	台湾护照号码
TWResidentCertificate	台湾居民证
THPopulationIdentificationCode	TH 人口识别码
TRNationalIdentificationNumber	TR 国民身份证号码
UKDriversLicenseNumber	英国驾照号码
UKElectoralRollNumber	英国选民名册号码
UKNationalHealthNumber	英国国民健康号码
UKNationalInsuranceNumber	英国国民保险号码
UKUniqueTaxpayerNumber	英国唯一纳税人号码
USUKPassportNumber	美国英国护照号码
USBankAccountNumber	美国银行帐号
USDriversLicenseNumber	美国驾照号码
USIndividualTaxpayerIdentification	美国个人纳税人身份证明
USSocialSecurityNumber	美国社会保险号码
UAPassportNumberDomestic	UA 护照号码国内
UAPassportNumberInternational	UA 国际护照号码
Organization	组织
Email	Email
URL	URL
Age	年龄
PhoneNumber	电话号码
IPAddress	IP 地址
Date	日期
Person	人员
Address	地址
DateOfBirth	出生日期
BankAccountNumber	银行帐户号
PassportNumber	护照号码
DriversLicenseNumber	驾照号码
SortCode	排序代码。在英国用于识别持有银行账户的特定银行和分行的 6 位数字
VehicleIdentificationNumber	VIN
All	所有 PII 类别。
Default	语言的默认 PII 类别。

PiiDomain

枚举

PII 任务的域

值	说明
phi	指示应编辑“个人健康信息”域中的实体。
none	表示未指定域。

PiiEntitiesDocumentResult

Object

包含 PII 结果。

名称	类型	说明
entities	Entity[]	文档中的已识别实体。
id	string	唯一的非空文档标识符。
redactedText	string	返回经过编辑的文本。
statistics	DocumentStatistics	如果在请求中指定 showStats=true，则此字段将包含有关文档有效负载的信息。
warnings	DocumentWarning[]	处理文档时遇到的警告。

PiiResult

Object

包含 PiiResult。

名称	类型	说明
documents	PiiEntitiesDocumentResult[]	按文档响应
errors	DocumentError[]	按文档 ID 显示的错误。
modelVersion	string	此字段指示用于评分的模型。
statistics	RequestStatistics	如果在请求中指定 showStats=true，则此字段将包含有关请求有效负载的信息。

PiiTaskParameters

Object

PII 实体识别任务支持的参数。

名称	类型	默认值	说明
domain	PiiDomain	none	PII 任务的域
loggingOptOut	boolean	True	登录选择退出
modelVersion	string	latest	型号版本
piiCategories	PiiCategory[]		要在响应中返回的 PII 类别的枚举。
stringIndexType	StringIndexType	TextElements_v8	StringIndexType 用于分析。

PiiTaskResult

Object

包含分析文本 PIIEntityRecognition LRO 任务。

名称	类型	说明
kind	string: PiiEntityRecognitionResults	任务结果的类型。
results	PiiResult	pii 结果列表

RangeInclusivity

枚举

此属性属性的范围包含性。

值	说明
NoneInclusive	没有包容性
LeftInclusive	左侧（含）
RightInclusive	右侧包括
LeftRightInclusive	双方兼收

RangeKind

枚举

数字范围实体的类型。

值	说明
Number	编号范围
Speed	速度范围
Weight	权重范围
Length	长度范围
Volume	音量范围
Area	区域范围
Age	年龄范围
Information	信息范围
Temperature	温度范围
Currency	货币范围

RelativeTo

枚举

序号表示的引用点。

值	说明
Current	当前状态或位置
End	结束状态或位置
Start	起始状态或位置

RequestStatistics

Object

如果在请求中指定 showStats=true，则此字段将包含有关请求有效负载的信息。

名称	类型	说明
documentsCount	integer (int32)	请求中提交的文档数。
erroneousDocumentsCount	integer (int32)	无效文档数。这包括空、大小过高或不支持的语言文档。
transactionsCount	integer (int64)	请求的事务数。
validDocumentsCount	integer (int32)	有效文档数。这不包括空的、大小过大的限制或不支持的语言文档。

ScriptCode

枚举

标识输入文档的脚本。映射到 ISO 15924 标准脚本代码。

值	说明
Arab	阿拉伯文字的脚本代码。
Armn	亚美尼亚文字的脚本代码。
Beng	孟加拉语脚本的脚本代码。
Cans	UnifiedCanadianAboriginalSyllabics 脚本的脚本代码。
Cyrl	西里尔字母的脚本代码。
Deva	梵文脚本的脚本代码。
Ethi	埃塞俄比亚文字的脚本代码。
Geor	格鲁吉亚文字的脚本代码。
Grek	希腊文字的脚本代码。
Gujr	古吉拉特语脚本的脚本代码。
Guru	Gurmukhi 脚本的脚本代码。
Hang	韩文脚本的脚本代码。
Hani	HanLiteral 脚本的脚本代码。
Hans	HanSimplified 脚本的脚本代码。
Hant	汉繁体脚本的脚本代码。
Hebr	希伯来语脚本的脚本代码。
Jpan	日语脚本的脚本代码。
Khmr	高棉文字的脚本代码。
Knda	卡纳达语脚本的脚本代码。
Laoo	老挝文字的脚本代码。
Latn	拉丁文字的脚本代码。
Mlym	马拉雅拉姆语脚本的脚本代码。
Mong	蒙古文字的脚本代码。
Mtei	美帝脚本的脚本代码。
Mymr	缅甸文字的脚本代码。
Olck	Santali 脚本的脚本代码。
Orya	Odia 脚本的脚本代码。
Sinh	僧伽罗语脚本的脚本代码。
Shrd	Sharada 脚本的脚本代码。
Taml	泰米尔语脚本的脚本代码。
Telu	泰卢固语脚本的脚本代码。
Thaa	Thaana 脚本的脚本代码。
Thai	泰语脚本的脚本代码。
Tibt	藏文的脚本代码。

ScriptKind

枚举

标识输入文档的脚本。映射到 ISO 15924 标准正式名称。

值	说明
Arabic	阿拉伯文字的脚本名称。
Armenian	亚美尼亚语文字的文字名称。
Bangla	孟加拉语脚本的脚本名称。
UnifiedCanadianAboriginalSyllabics	UnifiedCanadianAboriginalSyllabics 脚本的脚本名称。
Cyrillic	西里尔字母的脚本名称。
Devanagari	梵文脚本的脚本名称。
Ethiopic	埃塞俄比亚文字的文字名称。
Georgian	格鲁吉亚文字的文字名称。
Greek	希腊文字的脚本名称。
Gujarati	古吉拉特语脚本的脚本名称。
Gurmukhi	古尔穆基语脚本的脚本名称。
Hangul	韩文脚本的脚本名称。
HanLiteral	HanLiteral 脚本的脚本名称。
HanSimplified	HanSimplified 脚本的脚本名称。
HanTraditional	汉繁体脚本的脚本名称。
Hebrew	希伯来语脚本的脚本名称。
Japanese	日语脚本的脚本名称。
Khmer	高棉文字的文字名称。
Kannada	卡纳达语脚本的脚本名称。
Lao	老挝文字的脚本名称。
Latin	拉丁文字的脚本名称。
Malayalam	马拉雅拉姆语脚本的脚本名称。
Meitei	美帝脚本的脚本名称。
Mongolian	蒙古文字的脚本名称。
Myanmar	缅甸文字的文字名称。
Odia	Odia 脚本的脚本名称。
Santali	Santali 脚本的脚本名称。
Sharada	Sharada 脚本的脚本名称。
Sinhala	僧伽罗语脚本的脚本名称。
Tamil	泰米尔语脚本的脚本名称。
Telugu	泰卢固语脚本的脚本名称。
Thaana	Thaana 脚本的脚本名称。
Thai	泰语脚本的脚本名称。
Tibetan	藏文的文字名称。

SentenceAssessment

Object

表示句子评估以及与之相关的评估或目标对象。

名称	类型	说明
confidenceScores	TargetConfidenceScoreLabel	表示所有情绪类的置信度分数：正数和负数。
isNegated	boolean	表示评估是否被否定的指示器。
length	integer (int32)	目标的长度。
offset	integer (int32)	与句子开头的目标偏移量。
sentiment	TokenSentimentValue	句子的情绪。
text	string	检测到的目标文本。

SentenceSentiment

Object

文档的句子情绪。

名称	类型	说明
assessments	SentenceAssessment[]	句子的评估数组。
confidenceScores	SentimentConfidenceScores	所有类的句子的情绪置信度得分介于 0 和 1 之间。
length	integer (int32)	目标的长度。
offset	integer (int32)	与句子开头的目标偏移量。
sentiment	SentenceSentimentValue	句子的预测情绪。
targets	SentenceTarget[]	句子目标的数组。
text	string	句子文本。

SentenceSentimentValue

枚举

句子的预测情绪。

值	说明
positive	积极情绪
neutral	中性情绪
negative	负面情绪

SentenceTarget

Object

表示句子目标以及与之相关的评估或目标对象。

名称	类型	说明
confidenceScores	TargetConfidenceScoreLabel	表示所有情绪类的置信度分数：正数和负数。
length	integer (int32)	目标的长度。
offset	integer (int32)	与句子开头的目标偏移量。
relations	TargetRelation[]	与目标相关的评估或目标对象的数组。
sentiment	TokenSentimentValue	句子的情绪。
text	string	检测到的目标文本。

SentimentAnalysisTaskParameters

Object

情绪分析任务支持的参数。

名称	类型	默认值	说明
loggingOptOut	boolean	False	登录选择退出
modelVersion	string	latest	型号版本
opinionMining	boolean	False	是否在请求中使用意见挖掘。
stringIndexType	StringIndexType	TextElements_v8	指定用于解释字符串偏移的方法。

SentimentConfidenceScores

Object

表示所有情绪类中介于 0 和 1 之间的置信度分数：正、中性、负数。

名称	类型	说明
negative	number (double)	负面情绪的置信度分数
neutral	number (double)	中性情绪的置信度分数
positive	number (double)	正面情绪的置信度分数

SentimentDocumentResult

Object

表示每个文档的预构建情绪分析结果的对象。

名称	类型	说明
confidenceScores	SentimentConfidenceScores	所有类的句子的情绪置信度得分介于 0 和 1 之间。
id	string	唯一的非空文档标识符。
sentences	SentenceSentiment[]	该文件的句子情绪。
sentiment	DocumentSentimentValue	文档的预测情绪（负面、中性、积极或混合）。
statistics	DocumentStatistics	如果在请求中指定 showStats=true，则此字段将包含有关文档有效负载的信息。
warnings	DocumentWarning[]	处理文档时遇到的警告。

SentimentResponse

Object

输入文档的情绪分析结果。

名称	类型	说明
documents	SentimentDocumentResult[]	输入中每个文档的情绪分析结果。
errors	DocumentError[]	按文档 ID 显示的错误。
modelVersion	string	此字段指示用于评分的模型。
statistics	RequestStatistics	如果在请求中指定 showStats=true，则此字段将包含有关请求有效负载的信息。

SentimentTaskResult

Object

包含分析文本 SentimentAnalysis LRO 任务结果。

名称	类型	说明
kind	string: SentimentAnalysisResults	任务结果的类型。
results	SentimentResponse	情绪分析结果

SpeedMetadata

Object

表示 Speed 实体元数据模型。

名称	类型	说明
metadataKind	string: SpeedMetadata	实体 Metadata 对象类型。
unit	SpeedUnit	速度的计量单位。
value	number (double)	提取的文本表示的数值。

SpeedUnit

枚举

测量速度单位

值	说明
Unspecified	未指定的速度单位。
MetersPerSecond	速度单位，以米每秒为单位。
KilometersPerHour	速度单位，以公里每小时为单位。
KilometersPerMinute	速度单位，以公里每分钟为单位。
KilometersPerSecond	速度单位，以公里每秒为单位。
MilesPerHour	速度单位，以英里/小时为单位。
Knots	速度单位以节为单位。
FeetPerSecond	速度单位，以英尺每秒为单位。
FeetPerMinute	速度单位，以英尺/分钟为单位。
YardsPerMinute	速度单位，以码每分钟为单位。
YardsPerSecond	速度单位，以每秒码为单位。
MetersPerMillisecond	速度单位，单位为米每毫秒。
CentimetersPerMillisecond	速度单位，单位为厘米每毫秒。
KilometersPerMillisecond	速度单位，以公里每毫秒为单位。

StringIndexType

枚举

字符串索引类型

值	说明
TextElements_v8	返回的偏移量和长度值将与 TextElements（Graphemes 和 Grapheme 群集）相对应，确认为 Unicode 8.0.0 标准。如果应用程序是用 .Net Framework 或 .Net Core 编写的，并且将使用 StringInfo，请使用此选项。
UnicodeCodePoint	返回的偏移量和长度值将对应于 Unicode 码位。如果使用支持 Unicode 的语言（例如 Python）编写应用程序，请使用此选项。
Utf16CodeUnit	返回的偏移量和长度值将对应于 UTF-16 代码单元。如果应用程序是用支持 Unicode 的语言（例如 Java、JavaScript）编写的，请使用此选项。

TargetConfidenceScoreLabel

Object

表示所有情绪类的置信度分数：正数和负数。

名称	类型	说明
negative	number (double)	负面情绪的置信度分数
positive	number (double)	正面情绪的置信度分数

TargetRelation

Object

表示评估和/或目标之间的关系。

名称	类型	说明
ref	string	指示链接对象的 JSON 指针。
relationType	TargetRelationType	与目标相关的类型。

TargetRelationType

枚举

与目标相关的类型。

值	说明
assessment	评估关系。
target	目标关系。

TemperatureMetadata

Object

表示信息实体元数据模型。

名称	类型	说明
metadataKind	string: TemperatureMetadata	实体 Metadata 对象类型。
unit	TemperatureUnit	温度的测量单位。
value	number (double)	提取的文本表示的数值。

TemperatureUnit

枚举

温度度量单位。

值	说明
Unspecified	未指定的温度单位
Fahrenheit	温度单位（华氏度）
Kelvin	温度单位（开尔文）
Rankine	朗肯的温度单位
Celsius	温度单位（摄氏度）

TemporalModifier

枚举

日期/时间实例的可选修饰符。

值	说明
AfterApprox	大约一段时间后
Before	在特定时间之前
BeforeStart	在时间段开始之前
Approx	大约在特定时间
ReferenceUndefined	对未定义时间的引用
SinceEnd	自时间段结束以来
AfterMid	时间段中间之后
Start	在时间段开始时
After	在特定时间后
BeforeEnd	在时间段结束之前
Until	直到特定时间
End	在时间段结束时
Less	小于特定时间
Since	从特定时间开始
AfterStart	时间段开始后
BeforeApprox	在大约时间之前
Mid	在一个时间段的中间
More	超过特定时间

TemporalSetMetadata

Object

时态集实体实例的元数据。

名称	类型	说明
dateValues	DateValue[]	日期值列表。
metadataKind	string: TemporalSetMetadata	实体 Metadata 对象类型。

TemporalSpanMetadata

Object

表示日期和/或时间跨度的元数据。

名称	类型	说明
metadataKind	string: TemporalSpanMetadata	实体 Metadata 对象类型。
spanValues	TemporalSpanValues[]	检测到的时间跨度列表。

TemporalSpanValues

Object

时态跨度对象。

名称	类型	说明
begin	string	跨度的起始值。
duration	string	基于 ISO 8601（https://en.wikipedia.org/wiki/ISO_8601#Durations）格式的可选持续时间值
end	string	跨度的结束值。
modifier	TemporalModifier	日期时间的修饰符，用于指示参考点，如之前、之后等。
timex	string	一个可选的三元列，其中包含开头、结尾和持续时间，所有表示为 ISO 8601 格式的字符串。

TimeMetadata

Object

时间实体实例的元数据。

名称	类型	说明
dateValues	DateValue[]	日期值列表。
metadataKind	string: TimeMetadata	实体 Metadata 对象类型。

TokenSentimentValue

枚举

句子的预测情绪。

值	说明
positive	积极情绪
mixed	喜忧参半
negative	负面情绪

VolumeMetadata

Object

表示卷实体元数据模型。

名称	类型	说明
metadataKind	string: VolumeMetadata	实体 Metadata 对象类型。
unit	VolumeUnit	体积的度量单位。
value	number (double)	提取的文本表示的数值。

VolumeUnit

枚举

测量量单位

值	说明
Unspecified	未指定的卷单位。
CubicMeter	体积单位（以立方米为单位）。
CubicCentimeter	以立方厘米为单位的体积单位。
CubicMillimeter	体积单位（以立方毫米为单位）。
Hectoliter	百叶数中的卷单位。
Decaliter	卷单位（以解码器为单位）。
Liter	音量单位（升）。
Centiliter	卷单位（以百分比为单位）。
Milliliter	以毫升为单位的卷单位。
CubicYard	卷单位（以立方码为单位）。
CubicInch	卷单位（以立方英寸为单位）。
CubicFoot	体积单位（以立方英尺为单位）。
CubicMile	体积单位（以立方英里为单位）。
FluidOunce	液体盎司的体积单位。
Teaspoon	卷单位（以茶匙为单位）。
Tablespoon	表匙中的卷单位。
Pint	品脱中的卷单位。
Quart	卷单位（以四分为单位）。
Cup	杯子中的音量单位。
Gill	金牌中的卷单位。
Pinch	卷单位（以英寸为单位）。
FluidDram	液体 drams 中的音量单位。
Barrel	卷单位（以桶为单位）。
Minim	小型卷单元。
Cord	带中的音量单位。
Peck	卷单位（以 pecks 为单位）。
Bushel	bushels 中的卷单元。
Hogshead	猪头中的卷单位。

WarningCodeValue

枚举

定义警告代码的列表。

值	说明
LongWordsInDocument	文档中的长字警告
DocumentTruncated	文档截断警告

WeightMetadata

Object

表示 Weight ）实体元数据模型。

名称	类型	说明
metadataKind	string: WeightMetadata	实体 Metadata 对象类型。
unit	WeightUnit	重量的计量单位。
value	number (double)	提取的文本表示的数值。

WeightUnit

枚举

度量单位的权重单位。

值	说明
Unspecified	未指定的权重单位
Kilogram	重量单位（以公斤为单位）
Gram	以克为单位的重量单位
Milligram	以毫米为单位的重量单位
Gallon	容量单位（以加仑为单位）
MetricTon	以指标吨为单位的重量单位
Ton	重量单位（以吨为单位）
Pound	重量单位（磅）
Ounce	重量单位（盎司）
Grain	粒度中的重量单位
PennyWeight	重量单位（以便士为单位）
LongTonBritish	长吨重量单位（英国）
ShortTonUS	短吨（美国）重量单位
ShortHundredWeightUS	短百重量级重量单位（美国）
Stone	石头中的重量单位
Dram	drams 中的重量单位

通过

Analyze Text - Analyze Text

URI 参数

请求正文

AnalyzeTextEntityLinkingInput

AnalyzeTextEntityRecognitionInput

AnalyzeTextKeyPhraseExtractionInput

AnalyzeTextLanguageDetectionInput

AnalyzeTextPiiEntitiesRecognitionInput

AnalyzeTextSentimentAnalysisInput

响应

安全性

Ocp-Apim-Subscription-Key

OAuth2Auth

作用域

示例

SuccessfulEntityLinkingRequest

示例请求

示例响应

SuccessfulEntityRecognitionExclusionRequest

示例请求

示例响应

SuccessfulEntityRecognitionInclusionRequest

示例请求

示例响应

SuccessfulEntityRecognitionInferenceOptionsRequest

示例请求

示例响应

SuccessfulEntityRecognitionOverlapPolicy

示例请求

示例响应

SuccessfulEntityRecognitionRequest

示例请求

示例响应

SuccessfulKeyPhraseExtractionRequest

示例请求

示例响应

SuccessfulLanguageDetectionRequest

示例请求

示例响应

SuccessfulPiiEntityRecognitionRequest

示例请求

示例响应

SuccessfulSentimentAnalysisRequest

示例请求

示例响应

定义

AgeMetadata

AgeUnit

AllowOverlapEntityPolicyType

AnalyzeTextEntityLinkingInput

AnalyzeTextEntityRecognitionInput

AnalyzeTextKeyPhraseExtractionInput

AnalyzeTextLanguageDetectionInput

AnalyzeTextPiiEntitiesRecognitionInput

AnalyzeTextSentimentAnalysisInput

AnalyzeTextTaskKind

AnalyzeTextTaskResultsKind

AreaMetadata

AreaUnit

CurrencyMetadata

DateMetadata

DateTimeMetadata

DateValue

DetectedLanguage

DocumentError

DocumentSentimentValue

DocumentStatistics

DocumentWarning

EntitiesDocumentResultWithMetadata

EntitiesResult

EntitiesTaskParameters

EntitiesTaskResult

Entity

EntityCategory

EntityInferenceOptions

EntityLinkingResult

EntityLinkingTaskParameters

EntityLinkingTaskResult

EntityTag