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

Text Analysis Runtime - Analyze Text

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

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

URI 参数

名称 必需 类型 说明
Endpoint
path True

string

支持的认知服务终结点(例如 https://.api.cognitiveservices.azure.com).

api-version
query True

string

用于此操作的 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:

请求已成功。

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

示例请求

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."
      }
    ]
  }
}

示例响应

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

示例请求

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."
      }
    ]
  }
}

示例响应

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

示例请求

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."
      }
    ]
  }
}

示例响应

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

示例请求

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."
      }
    ]
  }
}

示例响应

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

示例请求

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"
      }
    ]
  }
}

示例响应

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

示例请求

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"
      }
    ]
  }
}

示例响应

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

示例请求

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."
      }
    ]
  }
}

示例响应

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

示例请求

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?"
      }
    ]
  }
}

示例响应

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

示例请求

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?"
      }
    ]
  }
}

示例响应

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

示例请求

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."
      }
    ]
  }
}

示例响应

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

表示 Age 实体元数据模型。

AgeUnit

度量的年龄单位

AllowOverlapEntityPolicyType

表示允许重叠策略。 不会对实体应用后期处理逻辑。 模型预测的任何内容都将返回给用户。 这样,用户就可以获取每个模型可能值的完整视图,并在实体选择时应用自己的自定义逻辑

AnalyzeTextEntityLinkingInput

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

AnalyzeTextEntityRecognitionInput

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

AnalyzeTextKeyPhraseExtractionInput

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

AnalyzeTextLanguageDetectionInput

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

AnalyzeTextPiiEntitiesRecognitionInput

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

AnalyzeTextSentimentAnalysisInput

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

AnalyzeTextTaskKind

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

AnalyzeTextTaskResultsKind

分析文本任务返回的响应对象的类型。

AreaMetadata

表示区域实体元数据模型。

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

表示 Length 实体元数据模型。

LengthUnit

测量的长度单位。

LinkedEntitiesDocumentResult

实体链接文档结果。

LinkedEntity

包含检测到的实体与关联的源/链接的 LinkedEntity 对象。

Match

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

MatchLongestEntityPolicyType

表示匹配最长重叠策略。 尽可能没有重叠实体。 1. 如果有重叠的实体,将返回最长的实体。 2. 如果为 2 个或多个实体预测的字符集完全相同,请选择置信度分数较高的实体。 如果实体分数相同,则返回应用上述规则后仍然存在的所有实体。 3. 如果部分重叠(如 Hello 文本分析中所示),请遵循从 1 开始的上述步骤。

MetadataKind

实体元数据对象类型。

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

表示 Age 实体元数据模型。

名称 类型 说明
metadataKind string:

AgeMetadata

实体元数据对象类型。

unit

AgeUnit

年龄度量单位。

value

number

提取的文本表示的数值。

AgeUnit

度量的年龄单位

名称 类型 说明
Day

string

一天中的时间段

Month

string

一个月的时间段

Unspecified

string

未指定的时间段

Week

string

一周的时间段

Year

string

一年的时间段

AllowOverlapEntityPolicyType

表示允许重叠策略。 不会对实体应用后期处理逻辑。 模型预测的任何内容都将返回给用户。 这样,用户就可以获取每个模型可能值的完整视图,并在实体选择时应用自己的自定义逻辑

名称 类型 默认值 说明
policyKind string:

allowOverlap

matchLongest

实体 OverlapPolicy 对象类型。

AnalyzeTextEntityLinkingInput

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

名称 类型 说明
analysisInput

MultiLanguageAnalysisInput

包含要由服务处理的分析输入。

kind string:

EntityLinking

要执行的任务类型。

parameters

EntityLinkingTaskParameters

任务参数。

AnalyzeTextEntityRecognitionInput

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

名称 类型 说明
analysisInput

MultiLanguageAnalysisInput

要分析的输入。

kind string:

EntityRecognition

要执行的任务类型。

parameters

EntitiesTaskParameters

任务参数。

AnalyzeTextKeyPhraseExtractionInput

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

名称 类型 说明
analysisInput

MultiLanguageAnalysisInput

包含输入文档。

kind string:

KeyPhraseExtraction

要执行的任务类型。

parameters

KeyPhraseTaskParameters

关键短语提取任务参数。

AnalyzeTextLanguageDetectionInput

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

名称 类型 说明
analysisInput

LanguageDetectionAnalysisInput

要分析的文档。

kind string:

LanguageDetection

要执行的任务类型。

parameters

LanguageDetectionTaskParameters

任务参数。

AnalyzeTextPiiEntitiesRecognitionInput

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

名称 类型 说明
analysisInput

MultiLanguageAnalysisInput

包含输入文档。

kind string:

PiiEntityRecognition

要执行的任务类型。

parameters

PiiTaskParameters

Pii 任务参数。

AnalyzeTextSentimentAnalysisInput

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

名称 类型 说明
analysisInput

MultiLanguageAnalysisInput

包含输入文档。

kind string:

SentimentAnalysis

要执行的任务类型。

parameters

SentimentAnalysisTaskParameters

情绪分析任务参数。

AnalyzeTextTaskKind

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

名称 类型 说明
EntityLinking

string

实体链接任务

EntityRecognition

string

实体识别任务

KeyPhraseExtraction

string

关键短语提取任务

LanguageDetection

string

语言检测任务

PiiEntityRecognition

string

PII 实体识别任务

SentimentAnalysis

string

情绪分析任务

AnalyzeTextTaskResultsKind

分析文本任务返回的响应对象的类型。

名称 类型 说明
EntityLinkingResults

string

实体链接结果

EntityRecognitionResults

string

实体识别结果

KeyPhraseExtractionResults

string

关键短语提取结果

LanguageDetectionResults

string

语言检测结果

PiiEntityRecognitionResults

string

PII 实体识别结果

SentimentAnalysisResults

string

情绪分析结果

AreaMetadata

表示区域实体元数据模型。

名称 类型 说明
metadataKind string:

AreaMetadata

实体元数据对象类型。

unit

AreaUnit

面积的度量单位。

value

number

提取的文本表示的数值。

AreaUnit

度量面积单位。

名称 类型 说明
Acre

string

面积单位(以英亩为单位)

SquareCentimeter

string

面积单位(平方厘米)

SquareDecameter

string

正方形十分仪中的面积单位

SquareDecimeter

string

面积单位(以平方分数为单位)

SquareFoot

string

面积单位(平方英尺)

SquareHectometer

string

方堆计中的面积单位

SquareInch

string

面积单位(以平方英寸为单位)

SquareKilometer

string

面积单位(平方公里)

SquareMeter

string

面积单位(平方米)

SquareMile

string

面积单位(平方英里)

SquareMillimeter

string

面积单位(以平方毫米为单位)

SquareYard

string

面积单位(以平方码为单位)

Unspecified

string

未指定的区域单位

CurrencyMetadata

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

名称 类型 说明
iso4217

string

基于另一个 ISO 标准 ISO 3166 的字母代码,其中列出了国家/地区名称的代码。 ISO 4217 三字母代码的前两个字母与国家/地区名称的代码相同,并且,如果可能,第三个字母对应于货币名称的第一个字母。

metadataKind string:

CurrencyMetadata

实体元数据对象类型。

unit

string

货币单位。

value

number

提取的文本表示的数值。

DateMetadata

日期实体实例的元数据。

名称 类型 说明
dateValues

DateValue[]

日期值列表。

metadataKind string:

DateMetadata

实体元数据对象类型。

DateTimeMetadata

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

名称 类型 说明
dateValues

DateValue[]

日期值列表。

metadataKind string:

DateTimeMetadata

实体元数据对象类型。

DateValue

表示日期值。

名称 类型 说明
modifier

TemporalModifier

日期时间的修饰符,用于指示引用点,如之前、之后等。

timex

string

如 (https://github.com/Microsoft/Recognizers-Text/blob/master/Patterns/English/English-DateTime.yaml) 中所述的延长 ISO 8601 日期/时间表示形式

value

string

提取的文本表示的实际时间。

DetectedLanguage

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

名称 类型 说明
confidenceScore

number

置信度分数介于 0 和 1 之间。 分数接近 1 表示 100% 确定所识别语言为 true。

iso6391Name

string

根据 ISO 639-1 标准(例如 en、fr)检测语言的两个字母表示形式。

name

string

检测到的语言(例如英语、法语)的长名称。

scriptIso15924Code

ScriptCode

根据 ISO 15924 标准标识输入文档的脚本代码。

scriptName

ScriptKind

根据 ISO 15924 标准标识输入文档的脚本名称。

DocumentError

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

名称 类型 说明
error

Error

遇到错误。

id

string

输入文档的 ID。

DocumentSentimentValue

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

名称 类型 说明
mixed

string

Mixed 语句

negative

string

负语句

neutral

string

Neutral 语句

positive

string

Positive 语句

DocumentStatistics

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

名称 类型 说明
charactersCount

integer

文档中识别的文本元素数。

transactionsCount

integer

文档的事务数。

DocumentWarning

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

名称 类型 说明
code

WarningCodeValue

警告代码。

message

string

警告消息。

targetRef

string

指示目标对象的 JSON 指针引用。

EntitiesDocumentResultWithMetadata

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

名称 类型 说明
entities

EntityWithMetadata[]

文档中的已识别实体。

id

string

唯一的非空文档标识符。

statistics

DocumentStatistics

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

warnings

DocumentWarning[]

处理文档时遇到的警告。

EntitiesResult

包含实体识别任务结果。

名称 类型 说明
documents

EntitiesDocumentResultWithMetadata[]

按文档响应

errors

DocumentError[]

按文档 ID 显示的错误。

modelVersion

string

此字段指示用于评分的模型。

statistics

RequestStatistics

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

EntitiesTaskParameters

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

名称 类型 默认值 说明
exclusionList

EntityCategory[]

(可选)请求参数,用于筛选出包含 excludeList 的任何实体。 当用户指定 excludeList 时,他们无法获取使用该列表中的实体返回的预测。 我们将在 exclusionList 之前应用 inclusionList

inclusionList

EntityCategory[]

(可选) 请求参数,用于将输出限制为此列表中包含的请求实体类型。 我们将在 exclusionList 之前应用 inclusionList

inferenceOptions

EntityInferenceOptions

(可选)请求参数,允许用户提供运行推理的设置。

loggingOptOut

boolean

False

日志记录选择退出

modelVersion

string

latest

模型版本

overlapPolicy BaseEntityOverlapPolicy:

(可选)描述应用于 ner 输出的重叠策略的类型。

stringIndexType

StringIndexType

TextElements_v8

(可选)参数,用于提供用于解释字符串偏移量的字符串索引类型。 默认为 TextElements (Graphemes)。

EntitiesTaskResult

包含实体任务

名称 类型 说明
kind string:

EntityRecognitionResults

任务结果的类型。

results

EntitiesResult

实体识别的结果。

Entity

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

名称 类型 说明
category

string

实体类型。

confidenceScore

number

提取实体的 0 到 1 之间的置信度分数。

length

integer

实体文本的长度。 使用不同的“stringIndexType”值可能会影响返回的长度。

offset

integer

实体文本的起始位置。 使用不同的“stringIndexType”值可能会影响返回的偏移量。

subcategory

string

(可选)实体子类型。

text

string

请求中显示的实体文本。

EntityCategory

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

名称 类型 说明
Address

string

具体街道级别提到位置:房屋/建筑编号、街道、大道、高速公路、按名称引用的交叉口。

Age

string

与年龄相关的值。

Airport

string

机场。

Area

string

对象的区域。

City

string

与城市相关的值。

ComputingProduct

string

计算产品。

Continent

string

与大陆相关的值。

CountryRegion

string

与国家或地区相关的值。

CulturalEvent

string

与文化事件相关的值。

Currency

string

与货币相关的值。

Date

string

日历日期。

DateRange

string

日期范围。

DateTime

string

带时间的日历日期。

DateTimeRange

string

日期和时间范围。

Dimension

string

度量维度

Duration

string

持续时间。

Email

string

电子邮件地址。

Event

string

社会、体育、商业、政治、教育、自然、历史、犯罪、暴力、法律、军事活动等一段时间。

GPE

string

城市、国家/地区、州。

Geological

string

地理和自然特征,如河流、海洋和沙漠。

Height

string

对象的高度。

IP

string

网络 IP 地址。

Information

string

数字信息的度量单位。

Length

string

对象的长度。

Location

string

物理空间中的特定点或位置。

NaturalEvent

string

与事件相关的自然值。

Number

string

没有单位的数字

NumberRange

string

数字范围

Numeric

string

数值,包括数字和数字字。

Ordinal

string

序号。

Organization

string

由一些既定组织结构定义的公司、机构和其他人员群体。 这些标签可以包括公司、政党/运动、音乐乐队、体育俱乐部、政府机构和公共组织。 民族或宗教不是组织。

OrganizationMedical

string

医疗公司和集团。

OrganizationSports

string

与体育相关的组织。

OrganizationStockExchange

string

证券交易所集团。

Percentage

string

与百分比相关的值。

Person

string

第一个、最后一个和中间名、虚构字符的名称和别名。 标题,如“先生”。 或“总统”,不被视为命名实体的一部分。

PersonType

string

按组成员身份分类的人类角色。

PhoneNumber

string

电话号码(仅限美国和欧盟电话号码)。

Product

string

单一或一组商业、易耗品、电子、车辆、食品组。

SetTemporal

string

与时间相关的值集。

Skill

string

功能、技能或专业知识。

Speed

string

对象的速度。

SportsEvent

string

与体育赛事相关的值。

State

string

与状态相关的值。

Structural

string

人造结构。

Temperature

string

与温度相关的值。

Temporal

string

与时间相关的项。

Time

string

一天中的时间。

TimeRange

string

时间范围。

URL

string

网站的 URL。

Volume

string

对象的卷。

Weight

string

对象的权重。

EntityInferenceOptions

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

名称 类型 默认值 说明
excludeNormalizedValues

boolean

False

用于包括/排除要规范化的检测到的实体值并将其包含在元数据中的选项。 数值和临时实体类型支持值规范化。

EntityLinkingResult

实体链接结果。

名称 类型 说明
documents

LinkedEntitiesDocumentResult[]

按文档响应

errors

DocumentError[]

按文档 ID 显示的错误。

modelVersion

string

此字段指示用于评分的模型。

statistics

RequestStatistics

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

EntityLinkingTaskParameters

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

名称 类型 默认值 说明
loggingOptOut

boolean

False

日志记录选择退出

modelVersion

string

latest

模型版本

stringIndexType

StringIndexType

TextElements_v8

用于提供用于解释字符串偏移的字符串索引类型的可选参数。 默认为 TextElements (Graphemes)。

EntityLinkingTaskResult

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

名称 类型 说明
kind string:

EntityLinkingResults

任务结果的类型。

results

EntityLinkingResult

实体链接结果。

EntityTag

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

名称 类型 说明
confidenceScore

number

提取实体的 0 到 1 之间的检测分数。

name

string

标记的名称。 实体标记名称将全局唯一。

EntityWithMetadata

包含标记和元数据的实体对象。

名称 类型 说明
category

string

实体类型。

confidenceScore

number

提取实体的 0 到 1 之间的置信度分数。

length

integer

实体文本的长度。 使用不同的“stringIndexType”值可能会影响返回的长度。

metadata BaseMetadata:

实体元数据对象。

offset

integer

实体文本的起始位置。 使用不同的“stringIndexType”值可能会影响返回的偏移量。

subcategory

string

(可选)实体子类型。

tags

EntityTag[]

实体标记列表。 标记表示实体之间的一些相似性/相关性。

text

string

请求中显示的实体文本。

type

string

实体类型是检测到实体的最低(或最佳)粒度。 该类型映射到与检测到的实体关联的特定元数据属性。

Error

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

名称 类型 说明
code

ErrorCode

服务器定义的错误代码集之一。

details

Error[]

导致此报告错误的特定错误的详细信息数组。

innererror

InnerErrorModel

包含与当前对象有关错误的更具体信息的对象。

message

string

错误的人工可读表示形式。

target

string

错误的目标。

ErrorCode

人工可读错误代码。

名称 类型 说明
AzureCognitiveSearchIndexLimitReached

string

Azure 认知搜索索引限制达到错误

AzureCognitiveSearchIndexNotFound

string

Azure 认知搜索索引找不到错误

AzureCognitiveSearchNotFound

string

Azure 认知搜索找不到错误

AzureCognitiveSearchThrottling

string

Azure 认知搜索限制错误

Conflict

string

冲突错误

Forbidden

string

禁止访问错误

InternalServerError

string

内部服务器错误

InvalidArgument

string

参数错误无效

InvalidRequest

string

请求错误无效

NotFound

string

找不到错误

OperationNotFound

string

找不到操作错误

ProjectNotFound

string

项目找不到错误

QuotaExceeded

string

超出配额错误

ServiceUnavailable

string

服务不可用错误

Timeout

string

超时错误

TooManyRequests

string

请求过多错误

Unauthorized

string

未经授权的访问错误

Warning

string

警告错误

ErrorResponse

错误响应。

名称 类型 说明
error

Error

错误对象。

InformationMetadata

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

名称 类型 说明
metadataKind string:

InformationMetadata

实体元数据对象类型。

unit

InformationUnit

信息的度量单位。

value

number

提取的文本表示的数值。

InformationUnit

信息(数据)度量单位。

名称 类型 说明
Bit

string

数据大小单位(以位为单位)

Byte

string

数据大小单位(以字节为单位)

Gigabit

string

数据大小单位(以千兆位为单位)

Gigabyte

string

数据大小单位(以 GB 为单位)

Kilobit

string

千位中的数据大小单位

Kilobyte

string

数据大小单位(以 KB 为单位)

Megabit

string

以兆位为单位的数据大小单位

Megabyte

string

数据大小单位(以兆字节为单位)

Petabit

string

petabits 中的数据大小单位

Petabyte

string

数据大小单位(以 PB 为单位)

Terabit

string

terabits 中的数据大小单位

Terabyte

string

数据大小单位(以 TB 为单位)

Unspecified

string

未指定的数据大小单位

InnerErrorCode

人工可读错误代码。

名称 类型 说明
AzureCognitiveSearchNotFound

string

Azure 认知搜索找不到错误

AzureCognitiveSearchThrottling

string

Azure 认知搜索限制错误

EmptyRequest

string

空请求错误

ExtractionFailure

string

提取失败错误

InvalidCountryHint

string

国家/地区提示错误无效

InvalidDocument

string

文档错误无效

InvalidDocumentBatch

string

文档批处理错误无效

InvalidParameterValue

string

参数值错误无效

InvalidRequest

string

请求错误无效

InvalidRequestBodyFormat

string

请求正文格式错误无效

KnowledgeBaseNotFound

string

知识库找不到错误

MissingInputDocuments

string

缺少输入文档错误

ModelVersionIncorrect

string

模型版本错误错误

UnsupportedLanguageCode

string

不支持的语言代码错误

InnerErrorModel

包含有关错误的更具体信息的对象。 根据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

包含 KeyPhraseResult。

名称 类型 说明
documents

KeyPhrasesDocumentResult[]

按文档响应

errors

DocumentError[]

按文档 ID 显示的错误。

modelVersion

string

此字段指示用于评分的模型。

statistics

RequestStatistics

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

KeyPhrasesDocumentResult

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

名称 类型 说明
id

string

唯一的非空文档标识符。

keyPhrases

string[]

具有代表性的字词或短语的列表。 返回的关键短语数与输入文档中的字数成正比。

statistics

DocumentStatistics

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

warnings

DocumentWarning[]

处理文档时遇到的警告。

KeyPhraseTaskParameters

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

名称 类型 默认值 说明
loggingOptOut

boolean

False

日志记录选择退出

modelVersion

string

latest

模型版本

KeyPhraseTaskResult

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

名称 类型 说明
kind string:

KeyPhraseExtractionResults

任务结果的类型。

results

KeyPhraseResult

关键短语提取结果的列表

LanguageDetectionAnalysisInput

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

名称 类型 说明
documents

LanguageInput[]

要分析的文档列表。

LanguageDetectionDocumentResult

包含文档的语言检测。

名称 类型 说明
detectedLanguage

DetectedLanguage

检测到的语言。

id

string

唯一的非空文档标识符。

statistics

DocumentStatistics

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

warnings

DocumentWarning[]

处理文档时遇到的警告。

LanguageDetectionResult

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

名称 类型 说明
documents

LanguageDetectionDocumentResult[]

每个输入文档的语言检测结果枚举。

errors

DocumentError[]

按文档 ID 显示的错误。

modelVersion

string

此字段指示用于评分的模型。

statistics

RequestStatistics

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

LanguageDetectionTaskParameters

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

名称 类型 默认值 说明
loggingOptOut

boolean

False

日志记录选择退出

modelVersion

string

latest

模型版本

LanguageDetectionTaskResult

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

名称 类型 说明
kind string:

LanguageDetectionResults

任务结果的类型。

results

LanguageDetectionResult

包含语言检测结果。

LanguageInput

包含语言检测输入。

名称 类型 说明
countryHint

string

帮助语言检测文本的国家/地区提示。

id

string

唯一的非空文档标识符。

text

string

要处理的输入文本。

LengthMetadata

表示 Length 实体元数据模型。

名称 类型 说明
metadataKind string:

LengthMetadata

实体元数据对象类型。

unit

LengthUnit

长度度量单位。

value

number

提取的文本表示的数值。

LengthUnit

测量的长度单位。

名称 类型 说明
Centimeter

string

长度单位(以厘米为单位)。

Decameter

string

长度单位(以十分计为单位)。

Decimeter

string

长度单位(以分数为单位)。

Foot

string

长度单位(以英尺为单位)。

Hectometer

string

hectometers 中的长度单位。

Inch

string

长度单位(以英寸为单位)。

Kilometer

string

长度单位(以公里为单位)。

LightYear

string

长度单位(以光年为单位)。

Meter

string

长度单位(以米为单位)。

Micrometer

string

长度单位(以微计为单位)。

Mile

string

长度单位(以英里为单位)。

Millimeter

string

长度单位(以毫米为单位)。

Nanometer

string

长度单位(以纳米为单位)。

Picometer

string

picometers 中的长度单位。

Point

string

长度单位(以磅为单位)。

Unspecified

string

未指定的长度单位。

Yard

string

长度单位(以码为单位)。

LinkedEntitiesDocumentResult

实体链接文档结果。

名称 类型 说明
entities

LinkedEntity[]

文档中已识别的已知实体。

id

string

唯一的非空文档标识符。

statistics

DocumentStatistics

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

warnings

DocumentWarning[]

处理文档时遇到的警告。

LinkedEntity

包含检测到的实体与关联的源/链接的 LinkedEntity 对象。

名称 类型 说明
bingId

string

已识别实体的必应实体搜索 API 唯一标识符。

dataSource

string

用于提取实体链接的数据源,如 Wiki/必应等。

id

string

数据源中已识别实体的唯一标识符。

language

string

数据源中使用的语言。

matches

Match[]

此实体的实例列表显示在文本中。

name

string

实体链接形式名称。

url

string

数据源中实体页面的 URL。

Match

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

名称 类型 说明
confidenceScore

number

如果识别出已知项,则会返回一个十进制数字,表示 0 和 1 之间的置信度级别。

length

integer

实体匹配文本的长度。

offset

integer

实体匹配文本的起始位置。

text

string

请求中显示的实体文本。

MatchLongestEntityPolicyType

表示匹配最长重叠策略。 尽可能没有重叠实体。 1. 如果有重叠的实体,将返回最长的实体。 2. 如果为 2 个或多个实体预测的字符集完全相同,请选择置信度分数较高的实体。 如果实体分数相同,则返回应用上述规则后仍然存在的所有实体。 3. 如果部分重叠(如 Hello 文本分析中所示),请遵循从 1 开始的上述步骤。

名称 类型 默认值 说明
policyKind string:

matchLongest

matchLongest

实体 OverlapPolicy 对象类型。

MetadataKind

实体元数据对象类型。

名称 类型 说明
AgeMetadata

string

与年龄相关的值的元数据。

AreaMetadata

string

区域相关值的元数据。

CurrencyMetadata

string

与货币相关的值的元数据。

DateMetadata

string

与日期相关的值的元数据。

DateTimeMetadata

string

日期和时间相关值的元数据。

InformationMetadata

string

与信息相关的值的元数据。

LengthMetadata

string

与长度相关的值的元数据。

NumberMetadata

string

数值的元数据。

NumericRangeMetadata

string

数值范围的元数据。

OrdinalMetadata

string

序号的元数据。

SpeedMetadata

string

与速度相关的值的元数据。

TemperatureMetadata

string

与温度相关的值的元数据。

TemporalSetMetadata

string

与时间相关的值集的元数据。

TemporalSpanMetadata

string

时态跨度值的元数据。

TimeMetadata

string

与时间相关的值的元数据。

VolumeMetadata

string

卷相关值的元数据。

WeightMetadata

string

与权重相关的值的元数据。

MultiLanguageAnalysisInput

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

名称 类型 说明
documents

MultiLanguageInput[]

要分析的输入文档。

MultiLanguageInput

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

名称 类型 说明
id

string

唯一的非空文档标识符。

language

string

(可选)这是语言的 2 个字母 ISO 639-1 表示形式。 例如,将“en”用于英语;西班牙语等的“es”。如果未设置,请将“en”用于英语作为默认值。 (以下仅适用于 2023-04-15-preview 及更高版本)对于自动语言检测,请使用“auto”。 如果未设置,请将“en”用于英语作为默认值。

text

string

要处理的输入文本。

NumberKind

提取的数字实体的类型。

名称 类型 说明
Decimal

string

十进制数

Fraction

string

分数号

Integer

string

整数

Percent

string

百分比

Power

string

电源编号

Unspecified

string

未指定的数字类型

NumberMetadata

数值实体实例的元数据。

名称 类型 说明
metadataKind string:

NumberMetadata

实体元数据对象类型。

numberKind

NumberKind

数字类型的类型。

value

number

提取的文本所表示内容的数值表示形式。

NumericRangeMetadata

表示数值间隔的元数据。

名称 类型 说明
maximum

number

间隔的结束值。

metadataKind string:

NumericRangeMetadata

实体元数据对象类型。

minimum

number

间隔的起始值。

rangeInclusivity

RangeInclusivity

此范围的包容性。

rangeKind

RangeKind

支持的数值范围类型 - 例如数字、速度等。

OrdinalMetadata

数值实体实例的元数据。

名称 类型 说明
metadataKind string:

OrdinalMetadata

实体元数据对象类型。

offset

string

引用的偏移量(例如偏移量 = -1 指示第二个到最后一个)

relativeTo

RelativeTo

序号表示的引用点。

value

string

序号表示的简单算术表达式。

PiiCategory

(可选)描述要返回的 PII 类别

名称 类型 说明
ABARoutingNumber

string

ABA 路由编号

ARNationalIdentityNumber

string

AR 国家标识号

ATIdentityCard

string

AT 标识卡

ATTaxIdentificationNumber

string

AT 税务标识号

ATValueAddedTaxNumber

string

AT 增值税号码

AUBankAccountNumber

string

AT 标识卡

AUBusinessNumber

string

AU 业务编号

AUCompanyNumber

string

AU 公司编号

AUDriversLicenseNumber

string

AU 驾照编号

AUMedicalAccountNumber

string

AU 医疗帐户号

AUPassportNumber

string

AU Passport 号码

AUTaxFileNumber

string

AU 税务文件编号

Address

string

地址

Age

string

年龄

All

string

所有 PII 类别。

AzureDocumentDBAuthKey

string

Azure Document DB 身份验证密钥

AzureIAASDatabaseConnectionAndSQLString

string

Azure IAAS 数据库连接和 SQL 字符串

AzureIoTConnectionString

string

Azure IoT 连接字符串

AzurePublishSettingPassword

string

Azure 发布设置密码

AzureRedisCacheString

string

Azure Redis 缓存字符串

AzureSAS

string

Azure SAS

AzureServiceBusString

string

Azure 服务总线字符串

AzureStorageAccountGeneric

string

Azure 存储帐户通用

AzureStorageAccountKey

string

Azure 存储帐户密钥

BENationalNumber

string

BE National Number

BENationalNumberV2

string

BE National Number V2

BEValueAddedTaxNumber

string

BE 增值税号码

BGUniformCivilNumber

string

BG 统一民用号码

BRCPFNumber

string

BR CPF 编号

BRLegalEntityNumber

string

BR 法律实体编号

BRNationalIDRG

string

BR 国家 ID RG

CABankAccountNumber

string

CA 银行帐户号

CADriversLicenseNumber

string

CA 驱动程序许可证号

CAHealthServiceNumber

string

CA 运行状况服务编号

CAPassportNumber

string

CA Passport 号码

CAPersonalHealthIdentification

string

CA 个人运行状况标识

CASocialInsuranceNumber

string

CA 社会保险号码

CHSocialSecurityNumber

string

CH 社会保险号码

CLIdentityCardNumber

string

CL 标识卡号

CNResidentIdentityCardNumber

string

CN 居民身份证号

CYIdentityCard

string

CY 标识卡

CYTaxIdentificationNumber

string

CY 税务标识号

CZPersonalIdentityNumber

string

CZ 个人标识号

CZPersonalIdentityV2

string

CZ 个人标识 V2

CreditCardNumber

string

信用卡号

DEDriversLicenseNumber

string

DE Driver's License Number

DEIdentityCardNumber

string

DE Identity Card Number

DEPassportNumber

string

DE Passport 号码

DETaxIdentificationNumber

string

DE 税务标识号

DEValueAddedNumber

string

DE Value Added Number

DKPersonalIdentificationNumber

string

DK 个人标识号

DKPersonalIdentificationV2

string

DK 个人标识 V2

Date

string

日期

Default

string

语言的默认 PII 类别。

DrugEnforcementAgencyNumber

string

毒品执法局号码

EEPersonalIdentificationCode

string

EE 个人标识代码

ESDNI

string

ES DNI

ESSocialSecurityNumber

string

ES 社会保险号码

ESTaxIdentificationNumber

string

ES 税务标识号

EUDebitCardNumber

string

欧盟借记卡号码

EUDriversLicenseNumber

string

欧盟驾照编号

EUGPSCoordinates

string

欧盟 GPS 坐标

EUNationalIdentificationNumber

string

欧盟国家标识号

EUPassportNumber

string

欧盟护照号码

EUSocialSecurityNumber

string

欧盟社会保障号码

EUTaxIdentificationNumber

string

欧盟税务标识号

Email

string

电子邮件

FIEuropeanHealthNumber

string

FI 欧洲健康号码

FINationalID

string

FI 国家/地区 ID

FINationalIDV2

string

FI 国家/地区 ID V2

FIPassportNumber

string

FI Passport 号码

FRDriversLicenseNumber

string

FR 驱动程序许可证号

FRHealthInsuranceNumber

string

FR 健康保险号码

FRNationalID

string

FR 国家/地区 ID

FRPassportNumber

string

FR Passport 号码

FRSocialSecurityNumber

string

FR 社会保险号码

FRTaxIdentificationNumber

string

FR 税务标识号

FRValueAddedTaxNumber

string

FR 增值税号

GRNationalIDCard

string

GR 国家 ID 卡

GRNationalIDV2

string

GR 国家/地区 ID V2

GRTaxIdentificationNumber

string

GR 税务标识号

HKIdentityCardNumber

string

HK 身份证号码

HRIdentityCardNumber

string

HR 标识卡号

HRNationalIDNumber

string

HR 国家/地区 ID 编号

HRPersonalIdentificationNumber

string

HR 个人标识号

HRPersonalIdentificationOIBNumberV2

string

HR 个人标识 OIB 号码 V2

HUPersonalIdentificationNumber

string

胡个人标识号

HUTaxIdentificationNumber

string

胡税务标识号

HUValueAddedNumber

string

胡增值数字

IDIdentityCardNumber

string

ID 标识卡号

IEPersonalPublicServiceNumber

string

IE 个人公共服务号码

IEPersonalPublicServiceNumberV2

string

IE 个人公共服务号码 V2

ILBankAccountNumber

string

IL 银行帐户号

ILNationalID

string

IL 国家/地区 ID

INPermanentAccount

string

IN 永久帐户

INUniqueIdentificationNumber

string

IN 唯一标识号

IPAddress

string

IP地址

ITDriversLicenseNumber

string

IT 驱动程序的许可证号

ITFiscalCode

string

IT 会计代码

ITValueAddedTaxNumber

string

IT 增值税号

InternationalBankingAccountNumber

string

国际银行帐户编号

JPBankAccountNumber

string

JP 银行帐户编号

JPDriversLicenseNumber

string

JP 驱动程序许可证号

JPMyNumberCorporate

string

JP 我的号码公司

JPMyNumberPersonal

string

JP 我的号码个人

JPPassportNumber

string

JP Passport 号码

JPResidenceCardNumber

string

JP 住宅卡号码

JPResidentRegistrationNumber

string

JP 居民注册号

JPSocialInsuranceNumber

string

JP 社会保险号码

KRResidentRegistrationNumber

string

KR 居民注册号码

LTPersonalCode

string

LT 个人代码

LUNationalIdentificationNumberNatural

string

LU 国家标识号自然

LUNationalIdentificationNumberNonNatural

string

LU 国家标识号非自然

LVPersonalCode

string

LV 个人代码

MTIdentityCardNumber

string

MT 标识卡号

MTTaxIDNumber

string

MT 税号

MYIdentityCardNumber

string

MY Identity Card Number

NLCitizensServiceNumber

string

NL 公民服务号码

NLCitizensServiceNumberV2

string

NL 公民服务号码 V2

NLTaxIdentificationNumber

string

NL 税务标识号

NLValueAddedTaxNumber

string

NL 增值税号

NOIdentityNumber

string

NO 标识号

NZBankAccountNumber

string

NZ Bank 帐户编号

NZDriversLicenseNumber

string

NZ Driver's License Number

NZInlandRevenueNumber

string

NZ 内陆收入号码

NZMinistryOfHealthNumber

string

新西兰卫生部号码

NZSocialWelfareNumber

string

NZ 社会福利号码

Organization

string

组织

PHUnifiedMultiPurposeIDNumber

string

PH 统一多用途 ID 号

PLIdentityCard

string

PL 标识卡

PLNationalID

string

PL 国家 ID

PLNationalIDV2

string

PL 国家 ID V2

PLPassportNumber

string

PL Passport 号码

PLREGONNumber

string

PL REGON 编号

PLTaxIdentificationNumber

string

PL 税务标识号

PTCitizenCardNumber

string

PT 公民卡号码

PTCitizenCardNumberV2

string

PT 公民卡号码 V2

PTTaxIdentificationNumber

string

PT 税务标识号

Person

string

PhoneNumber

string

电话号码

ROPersonalNumericalCode

string

RO 个人数字代码

RUPassportNumberDomestic

string

RU Passport 号码国内

RUPassportNumberInternational

string

RU Passport 号码国际

SANationalID

string

SA 国家/地区 ID

SENationalID

string

SE 国家/地区 ID

SENationalIDV2

string

SE 国家 ID V2

SEPassportNumber

string

SE Passport 号码

SETaxIdentificationNumber

string

SE 税务标识号

SGNationalRegistrationIdentityCardNumber

string

SG 国家注册身份证号

SITaxIdentificationNumber

string

SI 税务标识号

SIUniqueMasterCitizenNumber

string

SI 唯一主公民号码

SKPersonalNumber

string

SK 个人号码

SQLServerConnectionString

string

SQL Server 连接字符串

SWIFTCode

string

SWIFT 代码

THPopulationIdentificationCode

string

TH 总体标识代码

TRNationalIdentificationNumber

string

TR 国家标识号

TWNationalID

string

TW 国家/地区 ID

TWPassportNumber

string

TW Passport 号码

TWResidentCertificate

string

TW 居民证书

UAPassportNumberDomestic

string

UA 护照号码国内

UAPassportNumberInternational

string

UA Passport Number International

UKDriversLicenseNumber

string

英国驾照编号

UKElectoralRollNumber

string

英国选举卷编号

UKNationalHealthNumber

string

英国国民健康号码

UKNationalInsuranceNumber

string

英国国民保险号码

UKUniqueTaxpayerNumber

string

英国唯一纳税人号码

URL

string

URL

USBankAccountNumber

string

美国银行帐户号

USDriversLicenseNumber

string

美国驾照编号

USIndividualTaxpayerIdentification

string

美国个人纳税人身份

USSocialSecurityNumber

string

美国社会保险号码

USUKPassportNumber

string

美国英国护照号码

ZAIdentificationNumber

string

ZA 标识号

PiiDomain

PII 任务的域

名称 类型 说明
none

string

指示未指定域。

phi

string

指示应对个人运行状况信息域中的实体进行修订。

PiiEntitiesDocumentResult

包含 PII 结果。

名称 类型 说明
entities

Entity[]

文档中的已识别实体。

id

string

唯一的非空文档标识符。

redactedText

string

返回经过编辑的文本。

statistics

DocumentStatistics

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

warnings

DocumentWarning[]

处理文档时遇到的警告。

PiiResult

包含 PiiResult。

名称 类型 说明
documents

PiiEntitiesDocumentResult[]

按文档响应

errors

DocumentError[]

按文档 ID 显示的错误。

modelVersion

string

此字段指示用于评分的模型。

statistics

RequestStatistics

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

PiiTaskParameters

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

名称 类型 默认值 说明
domain

PiiDomain

none

PII 任务的域

loggingOptOut

boolean

False

日志记录选择退出

modelVersion

string

latest

模型版本

piiCategories

PiiCategory[]

将在响应中返回的 PII 类别的枚举。

stringIndexType

StringIndexType

TextElements_v8

要用于分析的 StringIndexType。

PiiTaskResult

包含分析文本 PIIEntityRecognition LRO 任务。

名称 类型 说明
kind string:

PiiEntityRecognitionResults

任务结果的类型。

results

PiiResult

pii 结果列表

RangeInclusivity

此属性属性的范围非独占性。

名称 类型 说明
LeftInclusive

string

左侧非独占

LeftRightInclusive

string

双方均包含

NoneInclusive

string

无包容性

RightInclusive

string

右侧(含)

RangeKind

数字范围实体的类型。

名称 类型 说明
Age

string

年龄范围

Area

string

区域范围

Currency

string

货币范围

Information

string

信息范围

Length

string

长度范围

Number

string

数字范围

Speed

string

速度范围

Temperature

string

温度范围

Volume

string

音量范围

Weight

string

权重范围

RelativeTo

序号表示的引用点。

名称 类型 说明
Current

string

当前状态或位置

End

string

结束状态或位置

Start

string

开始状态或位置

RequestStatistics

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

名称 类型 说明
documentsCount

integer

请求中提交的文档数。

erroneousDocumentsCount

integer

无效文档数。 这包括空、大小过高或不支持的语言文档。

transactionsCount

integer

请求的事务数。

validDocumentsCount

integer

有效文档数。 这不包括空的、大小过大的限制或不支持的语言文档。

ScriptCode

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

名称 类型 说明
Arab

string

阿拉伯语脚本的脚本代码。

Armn

string

亚美尼亚脚本的脚本代码。

Beng

string

孟加拉语脚本的脚本代码。

Cans

string

UnifiedCanadianAboriginalSyllabics 脚本的脚本代码。

Cyrl

string

西里尔文脚本的脚本代码。

Deva

string

Devanagari 脚本的脚本代码。

Ethi

string

埃塞俄比亚文脚本的脚本代码。

Geor

string

格鲁吉亚脚本的脚本代码。

Grek

string

希腊脚本的脚本代码。

Gujr

string

古吉拉蒂脚本的脚本代码。

Guru

string

Gurmukhi 脚本的脚本代码。

Hang

string

朝鲜文脚本的脚本代码。

Hani

string

HanLiteral 脚本的脚本代码。

Hans

string

HanSimplified 脚本的脚本代码。

Hant

string

HanTraditional 脚本的脚本代码。

Hebr

string

希伯来语脚本的脚本代码。

Jpan

string

日语脚本的脚本代码。

Khmr

string

高棉脚本的脚本代码。

Knda

string

Kannada 脚本的脚本代码。

Laoo

string

老挝脚本的脚本代码。

Latn

string

拉丁语脚本的脚本代码。

Mlym

string

马拉雅拉姆语脚本的脚本代码。

Mong

string

蒙古脚本的脚本代码。

Mtei

string

Meitei 脚本的脚本代码。

Mymr

string

缅甸脚本的脚本代码。

Olck

string

桑塔利脚本的脚本代码。

Orya

string

Odia 脚本的脚本代码。

Shrd

string

Sharada 脚本的脚本代码。

Sinh

string

僧伽罗脚本的脚本代码。

Taml

string

泰米尔语脚本的脚本代码。

Telu

string

泰卢固脚本的脚本代码。

Thaa

string

Thaana 脚本的脚本代码。

Thai

string

泰文脚本的脚本代码。

Tibt

string

藏语脚本的脚本代码。

ScriptKind

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

名称 类型 说明
Arabic

string

阿拉伯语脚本的脚本名称。

Armenian

string

亚美尼亚语脚本的脚本名称。

Bangla

string

孟加拉语脚本的脚本名称。

Cyrillic

string

西里尔文脚本的脚本名称。

Devanagari

string

Devanagari 脚本的脚本名称。

Ethiopic

string

埃塞俄比亚文脚本的脚本名称。

Georgian

string

格鲁吉亚脚本的脚本名称。

Greek

string

希腊脚本的脚本名称。

Gujarati

string

古吉拉蒂脚本的脚本名称。

Gurmukhi

string

Gurmukhi 脚本的脚本名称。

HanLiteral

string

HanLiteral 脚本的脚本名称。

HanSimplified

string

HanSimplified 脚本的脚本名称。

HanTraditional

string

HanTraditional 脚本的脚本名称。

Hangul

string

朝鲜文脚本的脚本名称。

Hebrew

string

希伯来语脚本的脚本名称。

Japanese

string

日语脚本的脚本名称。

Kannada

string

Kannada 脚本的脚本名称。

Khmer

string

高棉脚本的脚本名称。

Lao

string

老挝脚本的脚本名称。

Latin

string

拉丁语脚本的脚本名称。

Malayalam

string

马拉雅拉姆语脚本的脚本名称。

Meitei

string

Meitei 脚本的脚本名称。

Mongolian

string

蒙古语脚本的脚本名称。

Myanmar

string

缅甸脚本的脚本名称。

Odia

string

Odia 脚本的脚本名称。

Santali

string

桑塔利脚本的脚本名称。

Sharada

string

Sharada 脚本的脚本名称。

Sinhala

string

僧伽罗脚本的脚本名称。

Tamil

string

泰米尔语脚本的脚本名称。

Telugu

string

泰卢固脚本的脚本名称。

Thaana

string

Thaana 脚本的脚本名称。

Thai

string

泰文脚本的脚本名称。

Tibetan

string

藏语脚本的脚本名称。

UnifiedCanadianAboriginalSyllabics

string

UnifiedCanadianAboriginalSyllabics 脚本的脚本名称。

SentenceAssessment

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

名称 类型 说明
confidenceScores

TargetConfidenceScoreLabel

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

isNegated

boolean

表示评估是否被否定的指示器。

length

integer

目标的长度。

offset

integer

与句子开头的目标偏移量。

sentiment

TokenSentimentValue

句子的情绪。

text

string

检测到的目标文本。

SentenceSentiment

文档的句子情绪。

名称 类型 说明
assessments

SentenceAssessment[]

句子的评估数组。

confidenceScores

SentimentConfidenceScores

所有类的句子的情绪置信度分数介于 0 和 1 之间。

length

integer

目标的长度。

offset

integer

与句子开头的目标偏移量。

sentiment

SentenceSentimentValue

句子的预测情绪。

targets

SentenceTarget[]

句子目标的数组。

text

string

句子文本。

SentenceSentimentValue

句子的预测情绪。

名称 类型 说明
negative

string

负面情绪

neutral

string

中性情绪

positive

string

积极情绪

SentenceTarget

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

名称 类型 说明
confidenceScores

TargetConfidenceScoreLabel

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

length

integer

目标的长度。

offset

integer

与句子开头的目标偏移量。

relations

TargetRelation[]

与目标相关的评估或目标对象的数组。

sentiment

TokenSentimentValue

句子的情绪。

text

string

检测到的目标文本。

SentimentAnalysisTaskParameters

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

名称 类型 默认值 说明
loggingOptOut

boolean

False

日志记录选择退出

modelVersion

string

latest

模型版本

opinionMining

boolean

False

是否在请求中使用意见挖掘。

stringIndexType

StringIndexType

TextElements_v8

指定用于解释字符串偏移的方法。

SentimentConfidenceScores

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

名称 类型 说明
negative

number

负面情绪的置信度分数

neutral

number

中性情绪的置信度分数

positive

number

正面情绪的置信度分数

SentimentDocumentResult

一个对象,表示每个文档预先生成的情绪分析结果。

名称 类型 说明
confidenceScores

SentimentConfidenceScores

所有类的句子的情绪置信度分数介于 0 和 1 之间。

id

string

唯一的非空文档标识符。

sentences

SentenceSentiment[]

文档的句子情绪。

sentiment

DocumentSentimentValue

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

statistics

DocumentStatistics

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

warnings

DocumentWarning[]

处理文档时遇到的警告。

SentimentResponse

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

名称 类型 说明
documents

SentimentDocumentResult[]

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

errors

DocumentError[]

按文档 ID 显示的错误。

modelVersion

string

此字段指示用于评分的模型。

statistics

RequestStatistics

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

SentimentTaskResult

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

名称 类型 说明
kind string:

SentimentAnalysisResults

任务结果的类型。

results

SentimentResponse

情绪分析结果

SpeedMetadata

表示 Speed 实体元数据模型。

名称 类型 说明
metadataKind string:

SpeedMetadata

实体元数据对象类型。

unit

SpeedUnit

速度度量单位。

value

number

提取的文本表示的数值。

SpeedUnit

测量速度单位

名称 类型 说明
CentimetersPerMillisecond

string

速度单位(以厘米/毫秒为单位)。

FeetPerMinute

string

每分钟的速度单位(以英尺为单位)。

FeetPerSecond

string

速度单位(以英尺/秒为单位)。

KilometersPerHour

string

每小时速度单位(以公里为单位)。

KilometersPerMillisecond

string

速度单位(以千米/毫秒为单位)。

KilometersPerMinute

string

速度单位(以公里/分钟为单位)。

KilometersPerSecond

string

速度单位(以公里/秒为单位)。

Knots

string

结中的速度单位。

MetersPerMillisecond

string

速度单位(以米/毫秒为单位)。

MetersPerSecond

string

速度单位(以米/秒为单位)。

MilesPerHour

string

速度单位,以英里/小时为单位。

Unspecified

string

未指定的速度单位。

YardsPerMinute

string

每分钟的速度单位(以码为单位)。

YardsPerSecond

string

每秒速度单位(以码为单位)。

StringIndexType

字符串索引类型

名称 类型 说明
TextElements_v8

string

返回的偏移量和长度值将与 TextElements(Graphemes 和 Grapheme 群集)相对应,确认为 Unicode 8.0.0 标准。 如果应用程序是用 .Net Framework 或 .Net Core 编写的,并且将使用 StringInfo,请使用此选项。

UnicodeCodePoint

string

返回的偏移量和长度值将对应于 Unicode 码位。 如果使用支持 Unicode 的语言(例如 Python)编写应用程序,请使用此选项。

Utf16CodeUnit

string

返回的偏移量和长度值将对应于 UTF-16 代码单元。 如果应用程序是用支持 Unicode 的语言(例如 Java、JavaScript)编写的,请使用此选项。

TargetConfidenceScoreLabel

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

名称 类型 说明
negative

number

负面情绪的置信度分数

positive

number

正面情绪的置信度分数

TargetRelation

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

名称 类型 说明
ref

string

指示链接对象的 JSON 指针。

relationType

TargetRelationType

与目标相关的类型。

TargetRelationType

与目标相关的类型。

名称 类型 说明
assessment

string

评估关系。

target

string

目标关系。

TemperatureMetadata

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

名称 类型 说明
metadataKind string:

TemperatureMetadata

实体元数据对象类型。

unit

TemperatureUnit

温度的度量单位。

value

number

提取的文本表示的数值。

TemperatureUnit

温度度量单位。

名称 类型 说明
Celsius

string

温度单位(摄氏度)

Fahrenheit

string

华氏温度单位

Kelvin

string

凯尔文的温度单位

Rankine

string

Rankine 中的温度单位

Unspecified

string

未指定的温度单位

TemporalModifier

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

名称 类型 说明
After

string

在特定时间之后

AfterApprox

string

大约一段时间后

AfterMid

string

时间段中间之后

AfterStart

string

时间段开始后

Approx

string

大约在特定时间

Before

string

在特定时间之前

BeforeApprox

string

大致时间之前

BeforeEnd

string

时间段结束前

BeforeStart

string

在时间段开始之前

End

string

时间段结束时

Less

string

小于特定时间

Mid

string

在一段时间内

More

string

比特定时间多

ReferenceUndefined

string

对未定义时间的引用

Since

string

自特定时间起

SinceEnd

string

自时间段结束以来

Start

string

在时间段开始时

Until

string

直到特定时间

TemporalSetMetadata

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

名称 类型 说明
dateValues

DateValue[]

日期值列表。

metadataKind string:

TemporalSetMetadata

实体元数据对象类型。

TemporalSpanMetadata

表示日期和/或时间范围的元数据。

名称 类型 说明
metadataKind string:

TemporalSpanMetadata

实体元数据对象类型。

spanValues

TemporalSpanValues[]

检测到的时态跨度列表。

TemporalSpanValues

时态跨度对象。

名称 类型 说明
begin

string

范围起始值。

duration

string

基于 ISO 8601(https://en.wikipedia.org/wiki/ISO_8601#Durations) 格式的可选持续时间值

end

string

范围结束值。

modifier

TemporalModifier

日期时间的修饰符,用于指示引用点,如之前、之后等。

timex

string

一个可选的三元列,其中包含开头、结尾和持续时间,所有表示为 ISO 8601 格式的字符串。

TimeMetadata

时间实体实例的元数据。

名称 类型 说明
dateValues

DateValue[]

日期值列表。

metadataKind string:

TimeMetadata

实体元数据对象类型。

TokenSentimentValue

句子的预测情绪。

名称 类型 说明
mixed

string

混合情绪

negative

string

负面情绪

positive

string

积极情绪

VolumeMetadata

表示卷实体元数据模型。

名称 类型 说明
metadataKind string:

VolumeMetadata

实体元数据对象类型。

unit

VolumeUnit

卷的度量单位。

value

number

提取的文本表示的数值。

VolumeUnit

测量量单位

名称 类型 说明
Barrel

string

卷单位(以桶为单位)。

Bushel

string

bushels 中的卷单元。

Centiliter

string

卷单位(以百分比为单位)。

Cord

string

带中的音量单位。

CubicCentimeter

string

以立方厘米为单位的体积单位。

CubicFoot

string

体积单位(以立方英尺为单位)。

CubicInch

string

卷单位(以立方英寸为单位)。

CubicMeter

string

体积单位(以立方米为单位)。

CubicMile

string

体积单位(以立方英里为单位)。

CubicMillimeter

string

体积单位(以立方毫米为单位)。

CubicYard

string

卷单位(以立方码为单位)。

Cup

string

杯子中的音量单位。

Decaliter

string

卷单位(以解码器为单位)。

FluidDram

string

液体 drams 中的音量单位。

FluidOunce

string

液体盎司的体积单位。

Gill

string

金牌中的卷单位。

Hectoliter

string

百叶数中的卷单位。

Hogshead

string

猪头中的卷单位。

Liter

string

音量单位(升)。

Milliliter

string

以毫升为单位的卷单位。

Minim

string

小型卷单元。

Peck

string

卷单位(以 pecks 为单位)。

Pinch

string

卷单位(以英寸为单位)。

Pint

string

品脱中的卷单位。

Quart

string

卷单位(以四分为单位)。

Tablespoon

string

表匙中的卷单位。

Teaspoon

string

卷单位(以茶匙为单位)。

Unspecified

string

未指定的卷单位。

WarningCodeValue

定义警告代码的列表。

名称 类型 说明
DocumentTruncated

string

文档截断警告

LongWordsInDocument

string

文档警告中的长字

WeightMetadata

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

名称 类型 说明
metadataKind string:

WeightMetadata

实体元数据对象类型。

unit

WeightUnit

权重度量单位。

value

number

提取的文本表示的数值。

WeightUnit

度量单位的权重单位。

名称 类型 说明
Dram

string

drams 中的重量单位

Gallon

string

容量单位(以加仑为单位)

Grain

string

粒度中的重量单位

Gram

string

以克为单位的重量单位

Kilogram

string

重量单位(以公斤为单位)

LongTonBritish

string

长吨重量单位(英国)

MetricTon

string

以指标吨为单位的重量单位

Milligram

string

以毫米为单位的重量单位

Ounce

string

重量单位(盎司)

PennyWeight

string

重量单位(以便士为单位)

Pound

string

重量单位(磅)

ShortHundredWeightUS

string

短百重量级重量单位(美国)

ShortTonUS

string

短吨(美国)重量单位

Stone

string

石头中的重量单位

Ton

string

重量单位(以吨为单位)

Unspecified

string

未指定的权重单位