Text Analysis Runtime - Analyze Text

參考

服務:: Azure AI Services

API 版本:: 2024-11-01

要求檔集合的文字分析。

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

含選擇性參數:

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

URI 參數

名稱	位於	必要	類型	Description
Endpoint	path	True	string	支援的認知服務端點（例如，https://.api.cognitiveservices.azure.com).
api-version	query	True	string minLength: 1	要用於這項作業的 API 版本。
showStats	query		boolean	（選擇性）如果設定為 true，回應將包含要求和檔層級統計數據。

要求本文

要求主體可以是下列其中一項：

名稱	Description
AnalyzeTextEntityLinkingInput	包含分析文字實體鏈接輸入。
AnalyzeTextEntityRecognitionInput	實體辨識會分析文字輸入工作要求。
AnalyzeTextKeyPhraseExtractionInput	包含分析文字 KeyPhraseExtraction 工作輸入。
AnalyzeTextLanguageDetectionInput	包含語言偵測檔分析工作輸入。
AnalyzeTextPiiEntitiesRecognitionInput	包含分析文字 PIIEntityRecognition 工作輸入。
AnalyzeTextSentimentAnalysisInput	包含分析文字 SentimentAnalysis 工作輸入。

AnalyzeTextEntityLinkingInput

包含分析文字實體鏈接輸入。

名稱	必要	類型	Description
kind	True	string: EntityLinking	要執行的工作種類。
analysisInput		MultiLanguageAnalysisInput	包含服務要處理的分析輸入。
parameters		EntityLinkingTaskParameters	工作參數。

AnalyzeTextEntityRecognitionInput

實體辨識會分析文字輸入工作要求。

名稱	必要	類型	Description
kind	True	string: EntityRecognition	要執行的工作種類。
analysisInput		MultiLanguageAnalysisInput	要分析的輸入。
parameters		EntitiesTaskParameters	工作參數。

AnalyzeTextKeyPhraseExtractionInput

包含分析文字 KeyPhraseExtraction 工作輸入。

名稱	必要	類型	Description
kind	True	string: KeyPhraseExtraction	要執行的工作種類。
analysisInput		MultiLanguageAnalysisInput	包含輸入檔。
parameters		KeyPhraseTaskParameters	關鍵片語擷取工作參數。

AnalyzeTextLanguageDetectionInput

包含語言偵測檔分析工作輸入。

名稱	必要	類型	Description
kind	True	string: LanguageDetection	要執行的工作種類。
analysisInput		LanguageDetectionAnalysisInput	要分析的檔。
parameters		LanguageDetectionTaskParameters	工作參數。

AnalyzeTextPiiEntitiesRecognitionInput

包含分析文字 PIIEntityRecognition 工作輸入。

名稱	必要	類型	Description
kind	True	string: PiiEntityRecognition	要執行的工作種類。
analysisInput		MultiLanguageAnalysisInput	包含輸入檔。
parameters		PiiTaskParameters	Pii 工作參數。

AnalyzeTextSentimentAnalysisInput

包含分析文字 SentimentAnalysis 工作輸入。

名稱	必要	類型	Description
kind	True	string: SentimentAnalysis	要執行的工作種類。
analysisInput		MultiLanguageAnalysisInput	包含輸入檔。
parameters		SentimentAnalysisTaskParameters	情感分析工作參數。

回應

名稱	類型	Description
200 OK	AnalyzeTextTaskResult: EntitiesTaskResult EntityLinkingTaskResult KeyPhraseTaskResult LanguageDetectionTaskResult PiiTaskResult SentimentTaskResult	要求已成功。
Other Status Codes	ErrorResponse	未預期的錯誤回應。標題 x-ms-error-code: string

名稱

類型

Description

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
Flow: accessCode
授權 URL: https://login.microsoftonline.com/common/oauth2/authorize
權杖 URL: https://login.microsoftonline.com/common/oauth2/token

範圍

名稱	Description
https://cognitiveservices.azure.com/.default

範例

SuccessfulEntityLinkingRequest

SuccessfulEntityRecognitionExclusionRequest

SuccessfulEntityRecognitionInclusionRequest

SuccessfulEntityRecognitionInferenceOptionsRequest

SuccessfulEntityRecognitionOverlapPolicy

SuccessfulEntityRecognitionRequest

SuccessfulKeyPhraseExtractionRequest

SuccessfulLanguageDetectionRequest

SuccessfulPiiEntityRecognitionRequest

SuccessfulSentimentAnalysisRequest

SuccessfulEntityLinkingRequest

範例要求

HTTP

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

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

範例回覆

狀態碼:: 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=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."
      }
    ]
  }
}

範例回覆

狀態碼:: 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=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."
      }
    ]
  }
}

範例回覆

狀態碼:: 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=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."
      }
    ]
  }
}

範例回覆

狀態碼:: 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=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"
      }
    ]
  }
}

範例回覆

狀態碼:: 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=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"
      }
    ]
  }
}

範例回覆

狀態碼:: 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=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."
      }
    ]
  }
}

範例回覆

狀態碼:: 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=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?"
      }
    ]
  }
}

範例回覆

狀態碼:: 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=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?"
      }
    ]
  }
}

範例回覆

狀態碼:: 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=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."
      }
    ]
  }
}

範例回覆

狀態碼:: 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"
  }
}

定義

名稱	Description
AgeMetadata	表示 Age 實體元數據模型。
AgeUnit	測量年齡單位
AllowOverlapEntityPolicyType	表示允許重疊原則。不會對實體套用後續處理邏輯。無論模型預測什麼，都會傳回給使用者。這可讓使用者取得每個單一模型可能值的完整檢視，並在實體選取上套用自己的自定義邏輯
AnalyzeTextEntityLinkingInput	包含分析文字實體鏈接輸入。
AnalyzeTextEntityRecognitionInput	實體辨識會分析文字輸入工作要求。
AnalyzeTextKeyPhraseExtractionInput	包含分析文字 KeyPhraseExtraction 工作輸入。
AnalyzeTextLanguageDetectionInput	包含語言偵測檔分析工作輸入。
AnalyzeTextPiiEntitiesRecognitionInput	包含分析文字 PIIEntityRecognition 工作輸入。
AnalyzeTextSentimentAnalysisInput	包含分析文字 SentimentAnalysis 工作輸入。
AnalyzeTextTaskKind	支援的分析文字工作種類。
AnalyzeTextTaskResultsKind	分析文字工作所傳回之回應物件的種類。
AreaMetadata	代表區域實體元數據模型。
AreaUnit	測量的區域單位。
CurrencyMetadata	表示 Currency ）實體元數據模型。
DateMetadata	日期實體實例的元數據。
DateTimeMetadata	datetime 實體實例的元數據。
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。如果實體分數相同，則傳回套用先前規則之後仍存在的所有實體。 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	代表權數）實體元數據模型。
WeightUnit	度量單位。

AgeMetadata

Object

表示 Age 實體元數據模型。

名稱	類型	Description
metadataKind	string: AgeMetadata	實體元數據物件種類。
unit	AgeUnit	年齡的測量單位。
value	number (double)	擷取文字所代表的數值。

AgeUnit

列舉型別

測量年齡單位

值	Description
Day	一天的時間週期
Month	一個月的時間週期
Unspecified	未指定的時間週期
Week	一周的時間週期
Year	一年的時間週期

AllowOverlapEntityPolicyType

Object

表示允許重疊原則。不會對實體套用後續處理邏輯。無論模型預測什麼，都會傳回給使用者。這可讓使用者取得每個單一模型可能值的完整檢視，並在實體選取上套用自己的自定義邏輯

名稱	類型	預設值	Description
policyKind	string: allowOverlap	matchLongest	實體 OverlapPolicy 物件種類。

AnalyzeTextEntityLinkingInput

Object

包含分析文字實體鏈接輸入。

名稱	類型	Description
analysisInput	MultiLanguageAnalysisInput	包含服務要處理的分析輸入。
kind	string: EntityLinking	要執行的工作種類。
parameters	EntityLinkingTaskParameters	工作參數。

AnalyzeTextEntityRecognitionInput

Object

實體辨識會分析文字輸入工作要求。

名稱	類型	Description
analysisInput	MultiLanguageAnalysisInput	要分析的輸入。
kind	string: EntityRecognition	要執行的工作種類。
parameters	EntitiesTaskParameters	工作參數。

AnalyzeTextKeyPhraseExtractionInput

Object

包含分析文字 KeyPhraseExtraction 工作輸入。

名稱	類型	Description
analysisInput	MultiLanguageAnalysisInput	包含輸入檔。
kind	string: KeyPhraseExtraction	要執行的工作種類。
parameters	KeyPhraseTaskParameters	關鍵片語擷取工作參數。

AnalyzeTextLanguageDetectionInput

Object

包含語言偵測檔分析工作輸入。

名稱	類型	Description
analysisInput	LanguageDetectionAnalysisInput	要分析的檔。
kind	string: LanguageDetection	要執行的工作種類。
parameters	LanguageDetectionTaskParameters	工作參數。

AnalyzeTextPiiEntitiesRecognitionInput

Object

包含分析文字 PIIEntityRecognition 工作輸入。

名稱	類型	Description
analysisInput	MultiLanguageAnalysisInput	包含輸入檔。
kind	string: PiiEntityRecognition	要執行的工作種類。
parameters	PiiTaskParameters	Pii 工作參數。

AnalyzeTextSentimentAnalysisInput

Object

包含分析文字 SentimentAnalysis 工作輸入。

名稱	類型	Description
analysisInput	MultiLanguageAnalysisInput	包含輸入檔。
kind	string: SentimentAnalysis	要執行的工作種類。
parameters	SentimentAnalysisTaskParameters	情感分析工作參數。

AnalyzeTextTaskKind

列舉型別

支援的分析文字工作種類。

值	Description
EntityLinking	實體連結工作
EntityRecognition	實體辨識工作
KeyPhraseExtraction	關鍵片語擷取工作
LanguageDetection	語言偵測工作
PiiEntityRecognition	PII 實體辨識工作
SentimentAnalysis	情感分析工作

AnalyzeTextTaskResultsKind

列舉型別

分析文字工作所傳回之回應物件的種類。

值	Description
EntityLinkingResults	實體連結結果
EntityRecognitionResults	實體辨識結果
KeyPhraseExtractionResults	關鍵片語擷取結果
LanguageDetectionResults	語言偵測結果
PiiEntityRecognitionResults	PII 實體辨識結果
SentimentAnalysisResults	情感分析結果

AreaMetadata

Object

代表區域實體元數據模型。

名稱	類型	Description
metadataKind	string: AreaMetadata	實體元數據物件種類。
unit	AreaUnit	區域的測量單位。
value	number (double)	擷取文字所代表的數值。

AreaUnit

列舉型別

測量的區域單位。

值	Description
Acre	面積單位英畝
SquareCentimeter	平方公分的面積單位
SquareDecameter	平方分尺的區域單位
SquareDecimeter	平方分數的面積單位
SquareFoot	平方英呎面積單位
SquareHectometer	平方十六角計的區域單位
SquareInch	以平方英吋為單位的區域單位
SquareKilometer	以平方公里為單位的區域單位
SquareMeter	平方公尺面積單位
SquareMile	平方英哩的面積單位
SquareMillimeter	平方公厘的面積單位
SquareYard	平方碼的面積單位
Unspecified	未指定的區域單位

CurrencyMetadata

Object

表示 Currency ）實體元數據模型。

名稱	類型	Description
iso4217	string	以另一個 ISO 標準 ISO 3166 為基礎的字母代碼，其中列出國家/地區名稱的代碼。 ISO 4217 三個字母代碼的前兩個字母與國家/地區名稱的程式代碼相同，而且，如果可能的話，第三個字母會對應至貨幣名稱的第一個字母。
metadataKind	string: CurrencyMetadata	實體元數據物件種類。
unit	string	貨幣單位。
value	number (double)	擷取文字所代表的數值。

DateMetadata

Object

日期實體實例的元數據。

名稱	類型	Description
dateValues	DateValue[]	日期值的清單。
metadataKind	string: DateMetadata	實體元數據物件種類。

DateTimeMetadata

Object

datetime 實體實例的元數據。

名稱	類型	Description
dateValues	DateValue[]	日期值的清單。
metadataKind	string: DateTimeMetadata	實體元數據物件種類。

DateValue

Object

表示日期值。

名稱	類型	Description
modifier	TemporalModifier	datetime 的修飾詞，表示參考點，例如之前、之後等。
timex	string	如中所述的擴充 ISO 8601 日期/時間表示法（https://github.com/Microsoft/Recognizers-Text/blob/master/Patterns/English/English-DateTime.yaml）
value	string	擷取文字所代表的實際時間。

DetectedLanguage

Object

包含文字偵測到語言的詳細數據。

名稱	類型	Description
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

包含作業執行期間所發生錯誤的詳細數據。

名稱	類型	Description
error	Error	發生錯誤。
id	string	輸入文件的識別碼。

DocumentSentimentValue

列舉型別

文件的預測情感（負面、中性、正面或混合）。

值	Description
mixed	混合語句
negative	負語句
neutral	中性語句
positive	正數語句

DocumentStatistics

Object

如果在要求中指定 showStats=true，則此字段將包含文件承載的相關信息。

名稱	類型	Description
charactersCount	integer (int32)	檔中可辨識的文字項目數目。
transactionsCount	integer (int32)	檔的交易數目。

DocumentWarning

Object

包含具有已處理檔所發生警告的警告物件。

名稱	類型	Description
code	WarningCodeValue	警告碼。
message	string	警告訊息。
targetRef	string	指出目標物件的 JSON 指標參考。

EntitiesDocumentResultWithMetadata

Object

具有元數據的實體文件結果。

名稱	類型	Description
entities	EntityWithMetadata[]	檔中可辨識的實體。
id	string	唯一的非空白文件標識碼。
statistics	DocumentStatistics	如果在要求中指定 showStats=true，則此字段將包含文件承載的相關信息。
warnings	DocumentWarning[]	處理檔時遇到的警告。

EntitiesResult

Object

包含實體辨識工作結果。

名稱	類型	Description
documents	EntitiesDocumentResultWithMetadata[]	依文件回應
errors	DocumentError[]	依文件識別碼的錯誤。
modelVersion	string	此欄位會指出要用於評分的模型。
statistics	RequestStatistics	如果在要求中指定 showStats=true，則此字段將包含要求承載的相關信息。

EntitiesTaskParameters

Object

實體辨識工作支持的參數。

名稱	類型	預設值	Description
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 （Graphemes）。

EntitiesTaskResult

Object

包含實體工作

名稱	類型	Description
kind	string: EntityRecognitionResults	工作結果的種類。
results	EntitiesResult	實體辨識的結果。

Entity

Object

定義偵測到的實體物件，其中包含偵測到的實體類別和實體文字等等。

名稱	類型	Description
category	string	實體類型。
confidenceScore	number (double)	擷取實體 0 到 1 之間的信賴分數。
length	integer (int32)	實體文字的長度。使用不同的『stringIndexType』值可能會影響傳回的長度。
offset	integer (int32)	實體文字的開始位置。使用不同的『stringIndexType』值可能會影響傳回的位移。
subcategory	string	（選擇性）實體子類型。
text	string	要求中顯示的實體文字。

EntityCategory

列舉型別

包含實體辨識偵測到的所有實體類別。

值	Description
Address	具體街道層級提及的位置：房屋/建築編號、街道、大道、高速公路、名稱所參考的交叉口。
Age	年齡相關值。
Airport	機場。
Area	對象的區域。
City	城市相關值。
ComputingProduct	計算產品。
Continent	大陸相關值。
CountryRegion	國家或地區相關值。
CulturalEvent	文化事件相關值。
Currency	貨幣相關值。
Date	行事曆日期。
DateRange	日期範圍。
DateTime	具有時間的行事曆日期。
DateTimeRange	日期和時間範圍。
Dimension	度量維度
Duration	持續時間。
Email	電子郵件位址。
Event	社交、體育、商業、政治、教育、自然、歷史、犯罪、暴力、法律、軍事活動等一段時間。
GPE	城市、國家/地區、州。
Geological	地理和自然特徵，如河流、海洋和沙漠。
Height	物件的高度。
IP	網路IP位址。
Information	數位信息的測量單位。
Length	對象的長度。
Location	實體空間中的特定點或位置。
NaturalEvent	自然事件相關值。
Number	沒有單位的數位
NumberRange	數字範圍
Numeric	數值，包括數位和數位字。
Ordinal	序數。
Organization	由一些已建立的組織結構所定義的公司、機構和其他人員群組。這些標籤可以包括公司、政黨/運動、音樂樂隊、體育俱樂部、政府機構和公共組織。民族或宗教不是組織。
OrganizationMedical	醫療公司和團體。
OrganizationSports	體育相關組織。
OrganizationStockExchange	證券交易所群組。
Percentage	百分比相關值。
Person	第一個、最後一個和中間名、虛構字元的名稱和別名。標題，如『先生』。或「總統」，不會被視為具名實體的一部分。
PersonType	由群組成員資格分類的人類角色。
PhoneNumber	電話號碼（僅限美國和歐盟電話號碼）。
Product	單一或一組商業、消費性物品、電子、車輛、食品群組。
SetTemporal	一組時間相關值。
Skill	功能、技能或專業知識。
Speed	物件的速度。
SportsEvent	體育活動相關值。
State	狀態相關值。
Structural	人造結構。
Temperature	溫度相關值。
Temporal	與時間相關的專案。
Time	一天中的時間。
TimeRange	時間範圍。
URL	網站的 URL。
Volume	物件的磁碟區。
Weight	對象的權數。

EntityInferenceOptions

Object

類別，其中包含允許具名實體辨識的推斷選項。

名稱	類型	預設值	Description
excludeNormalizedValues	boolean	False	包含/排除要正規化並包含在元數據中之偵測到之實體值的選項。數值和時態性實體類型支援值正規化。

EntityLinkingResult

Object

實體連結結果。

名稱	類型	Description
documents	LinkedEntitiesDocumentResult[]	依文件回應
errors	DocumentError[]	依文件識別碼的錯誤。
modelVersion	string	此欄位會指出要用於評分的模型。
statistics	RequestStatistics	如果在要求中指定 showStats=true，則此字段將包含要求承載的相關信息。

EntityLinkingTaskParameters

Object

實體連結工作支持的參數。

名稱	類型	預設值	Description
loggingOptOut	boolean	False	記錄退出宣告
modelVersion	string	latest	模型版本
stringIndexType	StringIndexType	TextElements_v8	選擇性參數，提供用來解譯字串位移的字串索引類型。默認為 TextElements （Graphemes）。

EntityLinkingTaskResult

Object

包含分析文字實體連結工作結果。

名稱	類型	Description
kind	string: EntityLinkingResults	工作結果的種類。
results	EntityLinkingResult	實體連結結果。

EntityTag

Object

實體標籤物件，其中包含標記的名稱會中止任何相關聯的信賴分數。實體標籤可用來表達實體之間的一些相似性/親和性。

名稱	類型	Description
confidenceScore	number (double)	在擷取實體的 0 到 1 之間偵測分數。
name	string	標記的名稱。實體標籤名稱將全域是唯一的。

EntityWithMetadata

Object

具有標記和元數據的實體物件。

名稱	類型	Description
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

服務在處理要求期間遇到某些錯誤時所傳回的錯誤回應物件。

名稱	類型	Description
code	ErrorCode	其中一組伺服器定義的錯誤碼。
details	Error[]	導致此錯誤之特定錯誤的詳細數據陣列。
innererror	InnerErrorModel	物件，包含與目前對象有關錯誤更具體的資訊。
message	string	錯誤的人類可讀取表示法。
target	string	錯誤的目標。

ErrorCode

列舉型別

人類可讀取的錯誤碼。

值	Description
AzureCognitiveSearchIndexLimitReached	Azure 認知搜尋索引限制已達錯誤
AzureCognitiveSearchIndexNotFound	Azure 認知搜尋索引找不到錯誤
AzureCognitiveSearchNotFound	Azure 認知搜尋找不到錯誤
AzureCognitiveSearchThrottling	Azure 認知搜尋節流錯誤
Conflict	衝突錯誤
Forbidden	禁止存取錯誤
InternalServerError	內部伺服器錯誤
InvalidArgument	無效的自變數錯誤
InvalidRequest	要求錯誤無效
NotFound	找不到錯誤
OperationNotFound	找不到作業錯誤
ProjectNotFound	找不到項目錯誤
QuotaExceeded	超過配額錯誤
ServiceUnavailable	服務無法使用錯誤
Timeout	逾時錯誤
TooManyRequests	要求太多錯誤
Unauthorized	未經授權的存取錯誤
Warning	警告錯誤

ErrorResponse

Object

錯誤回應。

名稱	類型	Description
error	Error	error 物件。

InformationMetadata

Object

代表資訊（數據）實體元數據模型。

名稱	類型	Description
metadataKind	string: InformationMetadata	實體元數據物件種類。
unit	InformationUnit	信息測量單位。
value	number (double)	擷取文字所代表的數值。

InformationUnit

列舉型別

信息（數據）測量單位。

值	Description
Bit	位的數據大小單位
Byte	以位元組為單位的數據大小單位
Gigabit	以千兆位為單位的數據大小單位
Gigabyte	以 GB 為單位的數據大小單位
Kilobit	以千位為單位的數據大小單位
Kilobyte	以 KB 為單位的數據大小單位
Megabit	以 MB 為單位的數據大小單位
Megabyte	以 MB 為單位的數據大小單位
Petabit	petabits 中的數據大小單位
Petabyte	以 PB 為單位的數據大小單位
Terabit	terabits 中的數據大小單位
Terabyte	以 TB 為單位的數據大小單位
Unspecified	未指定的數據大小單位

InnerErrorCode

列舉型別

人類可讀取的錯誤碼。

值	Description
AzureCognitiveSearchNotFound	Azure 認知搜尋找不到錯誤
AzureCognitiveSearchThrottling	Azure 認知搜尋節流錯誤
EmptyRequest	空白要求錯誤
ExtractionFailure	擷取失敗錯誤
InvalidCountryHint	無效的國家/地區提示錯誤
InvalidDocument	檔錯誤無效
InvalidDocumentBatch	檔批次錯誤無效
InvalidParameterValue	無效的參數值錯誤
InvalidRequest	要求錯誤無效
InvalidRequestBodyFormat	無效的要求本文格式錯誤
KnowledgeBaseNotFound	知識庫找不到錯誤
MissingInputDocuments	遺漏輸入文件錯誤
ModelVersionIncorrect	模型版本不正確錯誤
UnsupportedLanguageCode	不支援的語言代碼錯誤

InnerErrorModel

Object

物件，包含有關錯誤的更特定資訊。根據Microsoft一個 API 指導方針 - https://github.com/Microsoft/api-guidelines/blob/vNext/Guidelines.md#7102-error-condition-responses。

名稱	類型	Description
code	InnerErrorCode	其中一組伺服器定義的錯誤碼。
details	object	錯誤詳細數據。
innererror	InnerErrorModel	物件，包含與目前對象有關錯誤更具體的資訊。
message	string	錯誤資訊。
target	string	錯誤目標。

KeyPhraseResult

Object

包含 KeyPhraseResult。

名稱	類型	Description
documents	KeyPhrasesDocumentResult[]	依文件回應
errors	DocumentError[]	依文件識別碼的錯誤。
modelVersion	string	此欄位會指出要用於評分的模型。
statistics	RequestStatistics	如果在要求中指定 showStats=true，則此字段將包含要求承載的相關信息。

KeyPhrasesDocumentResult

Object

包含文件的關鍵片語擷取結果。

名稱	類型	Description
id	string	唯一的非空白文件標識碼。
keyPhrases	string[]	代表性單字或片語的清單。傳回的關鍵片語數目會與輸入檔中的字數成正比。
statistics	DocumentStatistics	如果在要求中指定 showStats=true，則此字段將包含文件承載的相關信息。
warnings	DocumentWarning[]	處理檔時遇到的警告。

KeyPhraseTaskParameters

Object

關鍵片語擷取工作支持的參數。

名稱	類型	預設值	Description
loggingOptOut	boolean	False	記錄退出宣告
modelVersion	string	latest	模型版本

KeyPhraseTaskResult

Object

包含分析文字 KeyPhraseExtraction 工作結果。

名稱	類型	Description
kind	string: KeyPhraseExtractionResults	工作結果的種類。
results	KeyPhraseResult	關鍵片語擷取結果的清單

LanguageDetectionAnalysisInput

Object

包含語言偵測檔分析輸入。

名稱	類型	Description
documents	LanguageInput[]	要分析的檔案清單。

LanguageDetectionDocumentResult

Object

包含文件的語言偵測。

名稱	類型	Description
detectedLanguage	DetectedLanguage	偵測到的語言。
id	string	唯一的非空白文件標識碼。
statistics	DocumentStatistics	如果在要求中指定 showStats=true，則此字段將包含文件承載的相關信息。
warnings	DocumentWarning[]	處理檔時遇到的警告。

LanguageDetectionResult

Object

包含要求的語言偵測結果。

名稱	類型	Description
documents	LanguageDetectionDocumentResult[]	每個輸入文件的語言偵測結果列舉。
errors	DocumentError[]	依文件識別碼的錯誤。
modelVersion	string	此欄位會指出要用於評分的模型。
statistics	RequestStatistics	如果在要求中指定 showStats=true，則此字段將包含要求承載的相關信息。

LanguageDetectionTaskParameters

Object

語言偵測工作支持的參數。

名稱	類型	預設值	Description
loggingOptOut	boolean	False	記錄退出宣告
modelVersion	string	latest	模型版本

LanguageDetectionTaskResult

Object

包含要求的語言偵測工作結果。

名稱	類型	Description
kind	string: LanguageDetectionResults	工作結果的種類。
results	LanguageDetectionResult	包含語言偵測結果。

LanguageInput

Object

包含語言偵測輸入。

名稱	類型	Description
countryHint	string	協助語言偵測文字的國家/地區提示。
id	string	唯一的非空白文件標識碼。
text	string	要處理的輸入文字。

LengthMetadata

Object

表示 Length 實體元數據模型。

名稱	類型	Description
metadataKind	string: LengthMetadata	實體元數據物件種類。
unit	LengthUnit	長度的測量單位。
value	number (double)	擷取文字所代表的數值。

LengthUnit

列舉型別

測量的長度單位。

值	Description
Centimeter	以公分為單位的長度單位。
Decameter	以分碼為單位的長度單位。
Decimeter	以十分為單位的長度單位。
Foot	長度單位以英呎為單位。
Hectometer	hectometers 中的長度單位。
Inch	長度單位以英吋為單位。
Kilometer	以公里為單位的長度單位。
LightYear	以光年為單位的長度單位。
Meter	以公尺為單位的長度單位。
Micrometer	以微計為單位的長度單位。
Mile	長度單位以英里為單位。
Millimeter	以公厘為單位的長度單位。
Nanometer	以納米為單位的長度單位。
Picometer	picometers 中的長度單位。
Point	長度單位以點為單位。
Unspecified	未指定的長度單位。
Yard	長度單位以碼為單位。

LinkedEntitiesDocumentResult

Object

實體鏈接文件結果。

名稱	類型	Description
entities	LinkedEntity[]	檔中已辨識的已知實體。
id	string	唯一的非空白文件標識碼。
statistics	DocumentStatistics	如果在要求中指定 showStats=true，則此字段將包含文件承載的相關信息。
warnings	DocumentWarning[]	處理檔時遇到的警告。

LinkedEntity

Object

LinkedEntity 物件，其中包含具有相關聯來源/連結之偵測到的實體。

名稱	類型	Description
bingId	string	Bing 實體搜尋 API 已辨識實體的唯一標識碼。
dataSource	string	用來擷取實體鏈接的數據源，例如Wiki/Bing等。
id	string	數據源中已辨識實體的唯一標識符。
language	string	數據源中使用的語言。
matches	Match[]	此實體的實例清單會出現在文字中。
name	string	實體連結正式名稱。
url	string	數據源中實體頁面的 URL。

Match

Object

Match 物件，其中包含具有位移和長度的偵測到實體文字。

名稱	類型	Description
confidenceScore	number (double)	如果辨識出已知的專案，則會傳回十進制數，表示介於 0 和 1 之間的信賴等級。
length	integer (int32)	實體比對文字的長度。
offset	integer (int32)	實體比對文字的開始位置。
text	string	要求中顯示的實體文字。

MatchLongestEntityPolicyType

Object

代表比對最長重疊原則。盡可能沒有重疊的實體。 1. 如果有重疊的實體，則會傳回最長的實體。 2. 如果針對 2 個或多個實體預測的字元集完全相同，請選取信賴分數較高的實體。3。如果實體分數相同，則傳回套用先前規則之後仍存在的所有實體。 3. 如果有部分重疊（如 Hello 文字分析所示），請遵循上述步驟，從 1 開始。

名稱	類型	預設值	Description
policyKind	string: matchLongest	matchLongest	實體 OverlapPolicy 物件種類。

MetadataKind

列舉型別

實體元數據物件種類。

值	Description
AgeMetadata	年齡相關值的元數據。
AreaMetadata	區域相關值的元數據。
CurrencyMetadata	貨幣相關值的元數據。
DateMetadata	日期相關值的元數據。
DateTimeMetadata	日期和時間相關值的元數據。
InformationMetadata	信息相關值的元數據。
LengthMetadata	長度相關值的元數據。
NumberMetadata	數值的元數據。
NumericRangeMetadata	數值範圍值的元數據。
OrdinalMetadata	序數的元數據。
SpeedMetadata	速度相關值的元數據。
TemperatureMetadata	溫度相關值的元數據。
TemporalSetMetadata	時間相關值集合的元數據。
TemporalSpanMetadata	時態範圍值的元數據。
TimeMetadata	時間相關值的元數據。
VolumeMetadata	磁碟區相關值的元數據。
WeightMetadata	權數相關值的元數據。

MultiLanguageAnalysisInput

Object

服務要分析的輸入檔集合。

名稱	類型	Description
documents	MultiLanguageInput[]	要分析的輸入檔。

MultiLanguageInput

Object

包含服務要分析的輸入檔。

名稱	類型	Description
id	string	唯一的非空白文件標識碼。
language	string	（選擇性）這是語言的 2 個字母 ISO 639-1 表示法。例如，使用「en」表示英文;“es” 適用於西班牙文等。如果未設定，請針對英文使用「en」作為預設值。（以下僅適用於 2023-04-15-preview 和更新版本）針對自動語言偵測，請使用「auto」。如果未設定，請針對英文使用「en」作為預設值。
text	string	要處理的輸入文字。

NumberKind

列舉型別

擷取的數位實體類型。

值	Description
Decimal	十進位數
Fraction	分數編號
Integer	整數
Percent	百分比數位
Power	電源號碼
Unspecified	未指定的數位種類

NumberMetadata

Object

數值實體實例的元數據。

名稱	類型	Description
metadataKind	string: NumberMetadata	實體元數據物件種類。
numberKind	NumberKind	數位類型的種類。
value	number (double)	擷取文字所代表的數值表示。

NumericRangeMetadata

Object

表示數值間隔的元數據。

名稱	類型	Description
maximum	number (double)	間隔的結束值。
metadataKind	string: NumericRangeMetadata	實體元數據物件種類。
minimum	number (double)	間隔的起始值。
rangeInclusivity	RangeInclusivity	此範圍的內含性。
rangeKind	RangeKind	支援的數值範圍種類 - 例如數位、速度等。

OrdinalMetadata

Object

數值實體實例的元數據。

名稱	類型	Description
metadataKind	string: OrdinalMetadata	實體元數據物件種類。
offset	string	參考的位移（例如 offset = -1 表示第二個到最後一個）
relativeTo	RelativeTo	序數表示的參考點。
value	string	序數表示的簡單算術表達式。

PiiCategory

列舉型別

（選擇性）描述要傳回的 PII 類別

值	Description
ABARoutingNumber	ABA 路由號碼
ARNationalIdentityNumber	AR 國家識別號碼
ATIdentityCard	AT 身分識別卡
ATTaxIdentificationNumber	AT 稅務標識碼
ATValueAddedTaxNumber	AT 增值稅號碼
AUBankAccountNumber	AT 身分識別卡
AUBusinessNumber	AU 商務號碼
AUCompanyNumber	AU 公司號碼
AUDriversLicenseNumber	AU 驅動程式的授權號碼
AUMedicalAccountNumber	AU 醫療帳戶號碼
AUPassportNumber	AU Passport 號碼
AUTaxFileNumber	AU 稅務檔案編號
Address	位址
Age	年齡
All	所有 PII 類別。
AzureDocumentDBAuthKey	Azure Document DB 驗證金鑰
AzureIAASDatabaseConnectionAndSQLString	Azure IAAS 資料庫連線和 SQL 字串
AzureIoTConnectionString	Azure IoT 連接字串
AzurePublishSettingPassword	Azure 發佈設定密碼
AzureRedisCacheString	Azure Redis 快取字串
AzureSAS	Azure SAS
AzureServiceBusString	Azure 服務總線字串
AzureStorageAccountGeneric	Azure 記憶體帳戶泛型
AzureStorageAccountKey	Azure 記憶體帳戶金鑰
BENationalNumber	BE National Number
BENationalNumberV2	BE National Number V2
BEValueAddedTaxNumber	加值稅號
BGUniformCivilNumber	BG 統一民事號碼
BRCPFNumber	BR CPF 編號
BRLegalEntityNumber	BR 法律實體編號
BRNationalIDRG	BR 國家識別碼 RG
CABankAccountNumber	CA 銀行帳戶號碼
CADriversLicenseNumber	CA 驅動程式的授權號碼
CAHealthServiceNumber	CA 健全狀況服務號碼
CAPassportNumber	CA Passport 號碼
CAPersonalHealthIdentification	CA 個人健康情況識別
CASocialInsuranceNumber	CA 社會保險號碼
CHSocialSecurityNumber	CH 社會安全號碼
CLIdentityCardNumber	CL 識別卡號碼
CNResidentIdentityCardNumber	CN 居民身份證號碼
CYIdentityCard	CY 身份證
CYTaxIdentificationNumber	CY 稅務標識碼
CZPersonalIdentityNumber	CZ 個人身分識別號碼
CZPersonalIdentityV2	CZ 個人識別 V2
CreditCardNumber	信用卡號碼
DEDriversLicenseNumber	DE 驅動程式授權號碼
DEIdentityCardNumber	DE 識別卡號碼
DEPassportNumber	DE Passport 號碼
DETaxIdentificationNumber	DE 稅務標識碼
DEValueAddedNumber	DE Value Added Number
DKPersonalIdentificationNumber	DK 個人標識號
DKPersonalIdentificationV2	DK 個人識別 V2
Date	日期
Default	語言的預設 PII 類別。
DrugEnforcementAgencyNumber	毒品執法局號碼
EEPersonalIdentificationCode	EE 個人識別碼
ESDNI	ES DNI
ESSocialSecurityNumber	ES 社會安全號碼
ESTaxIdentificationNumber	ES 稅務標識碼
EUDebitCardNumber	歐盟轉帳卡號碼
EUDriversLicenseNumber	歐盟駕駛執照號碼
EUGPSCoordinates	歐盟 GPS 座標
EUNationalIdentificationNumber	歐盟國家標識號
EUPassportNumber	歐盟護照號碼
EUSocialSecurityNumber	歐盟社會安全號碼
EUTaxIdentificationNumber	歐盟稅務標識碼
Email	電子郵件
FIEuropeanHealthNumber	FI 歐洲健康號碼
FINationalID	FI 國家識別碼
FINationalIDV2	FI 國家標識碼 V2
FIPassportNumber	FI Passport 號碼
FRDriversLicenseNumber	FR 驅動程式的授權號碼
FRHealthInsuranceNumber	FR 健康保險號碼
FRNationalID	FR 國家標識碼
FRPassportNumber	FR Passport 號碼
FRSocialSecurityNumber	FR 社會安全號碼
FRTaxIdentificationNumber	FR 稅務標識碼
FRValueAddedTaxNumber	FR 增值稅號碼
GRNationalIDCard	GR 國家身份證
GRNationalIDV2	GR 國家識別碼 V2
GRTaxIdentificationNumber	GR 稅務標識碼
HKIdentityCardNumber	HK 身份證號碼
HRIdentityCardNumber	HR 身分識別卡號碼
HRNationalIDNumber	HR 國家識別碼
HRPersonalIdentificationNumber	HR 個人標識號
HRPersonalIdentificationOIBNumberV2	HR 個人識別 OIB 數位 V2
HUPersonalIdentificationNumber	胡個人標識號
HUTaxIdentificationNumber	胡稅務標識碼
HUValueAddedNumber	胡增加值號碼
IDIdentityCardNumber	標識碼識別卡號碼
IEPersonalPublicServiceNumber	IE 個人公共服務號碼
IEPersonalPublicServiceNumberV2	IE 個人公共服務號碼 V2
ILBankAccountNumber	IL 銀行帳戶號碼
ILNationalID	IL 國家識別碼
INPermanentAccount	IN 永久帳戶
INUniqueIdentificationNumber	IN 唯一標識碼
IPAddress	IP位址
ITDriversLicenseNumber	IT 驅動程式的授權號碼
ITFiscalCode	IT 會計程式代碼
ITValueAddedTaxNumber	IT 增值稅號碼
InternationalBankingAccountNumber	國際銀行帳戶號碼
JPBankAccountNumber	JP 銀行帳戶號碼
JPDriversLicenseNumber	JP 驅動程式的授權號碼
JPMyNumberCorporate	JP 我的號碼公司
JPMyNumberPersonal	JP 我的號碼個人
JPPassportNumber	JP Passport 號碼
JPResidenceCardNumber	JP 住宅卡號碼
JPResidentRegistrationNumber	JP 居民註冊號碼
JPSocialInsuranceNumber	JP 社會保險號碼
KRResidentRegistrationNumber	KR 居民註冊號碼
LTPersonalCode	LT 個人代碼
LUNationalIdentificationNumberNatural	LU 國家標識號自然
LUNationalIdentificationNumberNonNatural	LU 國家標識號非自然
LVPersonalCode	LV 個人代碼
MTIdentityCardNumber	MT 身分識別卡號碼
MTTaxIDNumber	MT 稅金標識碼
MYIdentityCardNumber	MY 身分識別卡號碼
NLCitizensServiceNumber	NL 公民服務號碼
NLCitizensServiceNumberV2	NL 公民服務號碼 V2
NLTaxIdentificationNumber	NL 稅務標識碼
NLValueAddedTaxNumber	NL 增值稅號碼
NOIdentityNumber	NO Identity Number
NZBankAccountNumber	NZ 銀行帳戶號碼
NZDriversLicenseNumber	NZ 驅動程式的授權號碼
NZInlandRevenueNumber	NZ 內陸營收號碼
NZMinistryOfHealthNumber	NZ 衛生部編號
NZSocialWelfareNumber	NZ 社會福利號碼
Organization	組織
PHUnifiedMultiPurposeIDNumber	PH 整合多重用途標識碼
PLIdentityCard	PL 身分識別卡
PLNationalID	PL 國家識別碼
PLNationalIDV2	PL 國家識別碼 V2
PLPassportNumber	PL Passport 號碼
PLREGONNumber	PL REGON 編號
PLTaxIdentificationNumber	PL 稅務標識碼
PTCitizenCardNumber	PT 公民卡號碼
PTCitizenCardNumberV2	PT 公民卡號碼 V2
PTTaxIdentificationNumber	PT 稅務標識碼
Person	人
PhoneNumber	電話號碼
ROPersonalNumericalCode	RO 個人數值代碼
RUPassportNumberDomestic	RU Passport 號碼國內
RUPassportNumberInternational	RU Passport 號碼國際
SANationalID	SA 國家標識碼
SENationalID	SE 國家識別碼
SENationalIDV2	SE 國家標識碼 V2
SEPassportNumber	SE Passport 號碼
SETaxIdentificationNumber	SE 稅務標識碼
SGNationalRegistrationIdentityCardNumber	SG 國家註冊身份證號碼
SITaxIdentificationNumber	SI 稅務標識碼
SIUniqueMasterCitizenNumber	SI 唯一主要公民號碼
SKPersonalNumber	SK 個人號碼
SQLServerConnectionString	SQL Server 連接字串
SWIFTCode	SWIFT 程式代碼
THPopulationIdentificationCode	TH 母體識別碼
TRNationalIdentificationNumber	TR 國家識別碼
TWNationalID	TW 國家識別碼
TWPassportNumber	TW Passport 號碼
TWResidentCertificate	TW 常駐憑證
UAPassportNumberDomestic	國內 UA 護照號碼
UAPassportNumberInternational	UA Passport Number International
UKDriversLicenseNumber	英國駕駛執照號碼
UKElectoralRollNumber	英國選舉捲數
UKNationalHealthNumber	英國國民健康號碼
UKNationalInsuranceNumber	英國國家保險號碼
UKUniqueTaxpayerNumber	英國唯一納稅人號碼
URL	URL
USBankAccountNumber	美國銀行帳戶號碼
USDriversLicenseNumber	美國駕駛執照號碼
USIndividualTaxpayerIdentification	美國個人納稅人識別
USSocialSecurityNumber	美國社會安全號碼
USUKPassportNumber	美國英國護照號碼
ZAIdentificationNumber	ZA 識別碼

PiiDomain

列舉型別

PII 工作的網域

值	Description
none	表示未指定任何網域。
phi	指出應該修訂個人健康情況資訊網域中的實體。

PiiEntitiesDocumentResult

Object

包含 PII 結果。

名稱	類型	Description
entities	Entity[]	檔中可辨識的實體。
id	string	唯一的非空白文件標識碼。
redactedText	string	傳回修訂的文字。
statistics	DocumentStatistics	如果在要求中指定 showStats=true，則此字段將包含文件承載的相關信息。
warnings	DocumentWarning[]	處理檔時遇到的警告。

PiiResult

Object

包含 PiiResult。

名稱	類型	Description
documents	PiiEntitiesDocumentResult[]	依文件回應
errors	DocumentError[]	依文件識別碼的錯誤。
modelVersion	string	此欄位會指出要用於評分的模型。
statistics	RequestStatistics	如果在要求中指定 showStats=true，則此字段將包含要求承載的相關信息。

PiiTaskParameters

Object

PII 實體辨識工作支持的參數。

名稱	類型	預設值	Description
domain	PiiDomain	none	PII 工作的網域
loggingOptOut	boolean	False	記錄退出宣告
modelVersion	string	latest	模型版本
piiCategories	PiiCategory[]		在回應中傳回的 PII 類別列舉。
stringIndexType	StringIndexType	TextElements_v8	要用於分析的 StringIndexType。

PiiTaskResult

Object

包含分析文字 PIIEntityRecognition LRO 工作。

名稱	類型	Description
kind	string: PiiEntityRecognitionResults	工作結果的種類。
results	PiiResult	pii 結果的清單

RangeInclusivity

列舉型別

此屬性屬性的範圍內含性。

值	Description
LeftInclusive	左側包含
LeftRightInclusive	雙方包容
NoneInclusive	無包容性
RightInclusive	右側包含

RangeKind

列舉型別

數位範圍實體的種類。

值	Description
Age	年齡範圍
Area	區域範圍
Currency	貨幣範圍
Information	信息範圍
Length	長度範圍
Number	數字範圍
Speed	速度範圍
Temperature	溫度範圍
Volume	磁碟區範圍
Weight	權數範圍

RelativeTo

列舉型別

序數表示的參考點。

值	Description
Current	目前的狀態或位置
End	結束狀態或位置
Start	開始狀態或位置

RequestStatistics

Object

如果在要求中指定 showStats=true，則此字段將包含要求承載的相關信息。

名稱	類型	Description
documentsCount	integer (int32)	要求中提交的文件數目。
erroneousDocumentsCount	integer (int32)	無效的檔數目。這包括空白、大小過高或不支援的語言檔。
transactionsCount	integer (int64)	要求的交易數目。
validDocumentsCount	integer (int32)	有效檔數目。這會排除空白、大小過高或不支援的語言檔。

ScriptCode

列舉型別

識別輸入檔的腳本。對應至 ISO 15924 標準腳本程式代碼。

值	Description
Arab	阿拉伯文文本的腳本程序代碼。
Armn	亞美尼亞文腳本的腳本程序代碼。
Beng	編寫班格拉腳本的程序代碼。
Cans	UnifiedCanadianAboriginalSyllabics 腳本的腳本程序代碼。
Cyrl	為斯拉夫文腳本編寫程序代碼。
Deva	撰寫Devanagari腳本的程式代碼。
Ethi	編寫 Epic 腳本的程式代碼。
Geor	喬治亞文腳本的腳本程序代碼。
Grek	編寫希臘腳本的程序代碼。
Gujr	為 Gujarati 文本編寫程式代碼。
Guru	為 Gurmukhi 腳本編寫程式代碼。
Hang	韓文腳本的腳本程序代碼。
Hani	為 HanLiteral 腳本編寫程式代碼。
Hans	為 HanSimplified 腳本編寫程式代碼。
Hant	編寫 HanTraditional 腳本的程式代碼。
Hebr	希伯來文腳本的腳本程序代碼。
Jpan	編寫日文文文本的程序代碼。
Khmr	高棉腳本的腳本程序代碼。
Knda	編寫 Kannada 腳本的程式代碼。
Laoo	老撾腳本的腳本程序代碼。
Latn	拉丁腳本的腳本程序代碼。
Mlym	馬來亞蘭文腳本的腳本程序代碼。
Mong	蒙古文文本的腳本程序代碼。
Mtei	編寫 Meitei 腳本的程式代碼。
Mymr	緬甸腳本的腳本程序代碼。
Olck	為 Santali 文稿編寫程式代碼。
Orya	編寫 Odia 文本的程式代碼。
Shrd	為 Sharada 腳本編寫程式代碼。
Sinh	為 Sinhala 腳本編寫程式代碼。
Taml	泰米爾腳本的腳本程序代碼。
Telu	編寫 Telugu 腳本的程式代碼。
Thaa	編寫 Thaana 腳本的程式代碼。
Thai	泰文文本的腳本程序代碼。
Tibt	編寫藏文文稿的腳本程序代碼。

ScriptKind

列舉型別

識別輸入檔的腳本。對應至 ISO 15924 標準正式名稱。

值	Description
Arabic	阿拉伯文文稿的腳本名稱。
Armenian	亞美尼亞文腳本的腳本名稱。
Bangla	班格拉腳本的腳本名稱。
Cyrillic	斯拉夫文腳本的腳本名稱。
Devanagari	Devanagari 腳本的腳本名稱。
Ethiopic	Epic 文稿的腳本名稱。
Georgian	喬治亞文腳本的腳本名稱。
Greek	希臘文文本的腳本名稱。
Gujarati	Gujarati 文稿的腳本名稱。
Gurmukhi	Gurmukhi 腳本的腳本名稱。
HanLiteral	HanLiteral 腳本的腳本名稱。
HanSimplified	HanSimplified 腳本的腳本名稱。
HanTraditional	HanTraditional 腳本的腳本名稱。
Hangul	韓文文稿的腳本名稱。
Hebrew	希伯來文腳本的腳本名稱。
Japanese	日文文本的腳本名稱。
Kannada	Kannada 文稿的文稿名稱。
Khmer	高棉腳本的腳本名稱。
Lao	老撾腳本的腳本名稱。
Latin	拉丁腳本的腳本名稱。
Malayalam	馬來亞蘭文腳本的腳本名稱。
Meitei	Meitei 腳本的腳本名稱。
Mongolian	蒙古文文本的腳本名稱。
Myanmar	緬甸腳本的腳本名稱。
Odia	Odia 腳本的腳本名稱。
Santali	聖誕老人腳本的腳本名稱。
Sharada	Sharada 腳本的腳本名稱。
Sinhala	Sinhala 腳本的腳本名稱。
Tamil	泰米爾腳本的腳本名稱。
Telugu	Telugu 腳本的腳本名稱。
Thaana	Thaana 腳本的腳本名稱。
Thai	泰文文本的腳本名稱。
Tibetan	藏文文稿的腳本名稱。
UnifiedCanadianAboriginalSyllabics	UnifiedCanadianAboriginalSyllabics 腳本的腳本名稱。

SentenceAssessment

Object

表示句子評量和與其相關的評量或目標物件。

名稱	類型	Description
confidenceScores	TargetConfidenceScoreLabel	代表所有情感類別的信賴分數：正面和負面。
isNegated	boolean	表示評估是否已否定的指標。
length	integer (int32)	目標的長度。
offset	integer (int32)	句子開頭的目標位移。
sentiment	TokenSentimentValue	句子的情感。
text	string	偵測到的目標文字。

SentenceSentiment

Object

檔的句子情感。

名稱	類型	Description
assessments	SentenceAssessment[]	句子的評量陣列。
confidenceScores	SentimentConfidenceScores	所有類別句子的情感信賴分數介於 0 到 1 之間。
length	integer (int32)	目標的長度。
offset	integer (int32)	句子開頭的目標位移。
sentiment	SentenceSentimentValue	句子的預測情感。
targets	SentenceTarget[]	句子的句子目標陣列。
text	string	句子文字。

SentenceSentimentValue

列舉型別

句子的預測情感。

值	Description
negative	負面情緒
neutral	中性情感
positive	正面情感

SentenceTarget

Object

表示句子目標，以及與其相關的評量或目標物件。

名稱	類型	Description
confidenceScores	TargetConfidenceScoreLabel	代表所有情感類別的信賴分數：正面和負面。
length	integer (int32)	目標的長度。
offset	integer (int32)	句子開頭的目標位移。
relations	TargetRelation[]	與目標相關的評估或目標物件的陣列。
sentiment	TokenSentimentValue	句子的情感。
text	string	偵測到的目標文字。

SentimentAnalysisTaskParameters

Object

情感分析工作的支持參數。

名稱	類型	預設值	Description
loggingOptOut	boolean	False	記錄退出宣告
modelVersion	string	latest	模型版本
opinionMining	boolean	False	是否要在要求中使用意見採礦。
stringIndexType	StringIndexType	TextElements_v8	指定用來解譯字串位移的方法。

SentimentConfidenceScores

Object

代表所有情感類別之間介於 0 到 1 之間的信賴分數：正面、中性、負數。

名稱	類型	Description
negative	number (double)	負面情感的信心分數
neutral	number (double)	中性情感的信心分數
positive	number (double)	正面情感的信心分數

SentimentDocumentResult

Object

物件，代表每個文件預先建置的情感分析結果。

名稱	類型	Description
confidenceScores	SentimentConfidenceScores	所有類別句子的情感信賴分數介於 0 到 1 之間。
id	string	唯一的非空白文件標識碼。
sentences	SentenceSentiment[]	檔的句子情感。
sentiment	DocumentSentimentValue	文件的預測情感（負面、中性、正面或混合）。
statistics	DocumentStatistics	如果在要求中指定 showStats=true，則此字段將包含文件承載的相關信息。
warnings	DocumentWarning[]	處理檔時遇到的警告。

SentimentResponse

Object

輸入檔的情感分析結果。

名稱	類型	Description
documents	SentimentDocumentResult[]	輸入中每個檔的情感分析結果。
errors	DocumentError[]	依文件識別碼的錯誤。
modelVersion	string	此欄位會指出要用於評分的模型。
statistics	RequestStatistics	如果在要求中指定 showStats=true，則此字段將包含要求承載的相關信息。

SentimentTaskResult

Object

包含分析文字 SentimentAnalysis LRO 工作結果。

名稱	類型	Description
kind	string: SentimentAnalysisResults	工作結果的種類。
results	SentimentResponse	情感分析結果

SpeedMetadata

Object

表示 Speed 實體元數據模型。

名稱	類型	Description
metadataKind	string: SpeedMetadata	實體元數據物件種類。
unit	SpeedUnit	速度的測量單位。
value	number (double)	擷取文字所代表的數值。

SpeedUnit

列舉型別

測量速度單位

值	Description
CentimetersPerMillisecond	以毫秒為單位的速度單位。
FeetPerMinute	每分鐘以英呎為單位的速度單位。
FeetPerSecond	每秒以英呎為單位的速度單位。
KilometersPerHour	每小時以公里為單位的速度單位。
KilometersPerMillisecond	以毫秒為單位的速度單位。
KilometersPerMinute	每分鐘以公里為單位的速度單位。
KilometersPerSecond	每秒以公里為單位的速度單位。
Knots	節中的速度單位。
MetersPerMillisecond	以毫秒為單位的速度單位。
MetersPerSecond	每秒以公尺為單位的速度單位。
MilesPerHour	每小時以英里為單位的速度單位。
Unspecified	未指定的速度單位。
YardsPerMinute	每分鐘以碼為單位的速度單位。
YardsPerSecond	每秒以碼為單位的速度單位。

StringIndexType

列舉型別

字串索引類型

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

代表所有情感類別的信賴分數：正面和負面。

名稱	類型	Description
negative	number (double)	負面情感的信心分數
positive	number (double)	正面情感的信心分數

TargetRelation

Object

表示評量和/或目標之間的關聯性。

名稱	類型	Description
ref	string	表示連結物件的 JSON 指標。
relationType	TargetRelationType	與目標相關的類型。

TargetRelationType

列舉型別

與目標相關的類型。

值	Description
assessment	評量關聯性。
target	目標關聯。

TemperatureMetadata

Object

表示資訊實體元數據模型。

名稱	類型	Description
metadataKind	string: TemperatureMetadata	實體元數據物件種類。
unit	TemperatureUnit	溫度的測量單位。
value	number (double)	擷取文字所代表的數值。

TemperatureUnit

列舉型別

測量溫度單位。

值	Description
Celsius	攝氏溫度單位
Fahrenheit	華氏溫度單位
Kelvin	開爾文的溫度單位
Rankine	Rankine 中的溫度單位
Unspecified	未指定的溫度單位

TemporalModifier

列舉型別

日期/時間實例的選擇性修飾詞。

值	Description
After	在特定時間之後
AfterApprox	大約一段時間之後
AfterMid	時間週期中期之後
AfterStart	時間週期開始之後
Approx	大約在特定時間
Before	在特定時間之前
BeforeApprox	大約時間之前
BeforeEnd	在時間週期結束之前
BeforeStart	在時間週期開始之前
End	在時間週期結束時
Less	小於特定時間
Mid	在一段時間的中間
More	超過特定時間
ReferenceUndefined	未定義時間的參考
Since	自特定時間起
SinceEnd	自時間週期結束以來
Start	在時間週期開始時
Until	直到特定時間

TemporalSetMetadata

Object

時態集實體實例的元數據。

名稱	類型	Description
dateValues	DateValue[]	日期值的清單。
metadataKind	string: TemporalSetMetadata	實體元數據物件種類。

TemporalSpanMetadata

Object

代表日期和/或時間範圍的元數據。

名稱	類型	Description
metadataKind	string: TemporalSpanMetadata	實體元數據物件種類。
spanValues	TemporalSpanValues[]	偵測到的時態範圍清單。

TemporalSpanValues

Object

時態範圍物件。

名稱	類型	Description
begin	string	範圍開始值。
duration	string	根據 ISO 8601 格式化的選擇性持續時間值（https://en.wikipedia.org/wiki/ISO_8601#Durations）
end	string	範圍的結束值。
modifier	TemporalModifier	datetime 的修飾詞，表示參考點，例如之前、之後等。
timex	string	選擇性三重項，其中包含開頭、結尾和持續時間，全都表示為 ISO 8601 格式化字串。

TimeMetadata

Object

時間實體實例的元數據。

名稱	類型	Description
dateValues	DateValue[]	日期值的清單。
metadataKind	string: TimeMetadata	實體元數據物件種類。

TokenSentimentValue

列舉型別

句子的預測情感。

值	Description
mixed	混合情感
negative	負面情緒
positive	正面情感

VolumeMetadata

Object

表示磁碟區實體元數據模型。

名稱	類型	Description
metadataKind	string: VolumeMetadata	實體元數據物件種類。
unit	VolumeUnit	磁碟區的測量單位。
value	number (double)	擷取文字所代表的數值。

VolumeUnit

列舉型別

測量量單位

值	Description
Barrel	以桶為單位的體積單位。
Bushel	總線的音量單位。
Centiliter	以百分為單位的磁碟區單位。
Cord	纜線中的音量單位。
CubicCentimeter	立方釐米的體積單位。
CubicFoot	以立方英尺為單位的體積單位。
CubicInch	以立方英吋為單位的體積單位。
CubicMeter	以立方米為單位的體積單位。
CubicMile	以立方英里為單位的體積單位。
CubicMillimeter	以立方毫米為單位的體積單位。
CubicYard	以立方碼為單位的體積單位。
Cup	杯子中的音量單位。
Decaliter	分化器中的磁碟區單位。
FluidDram	液體drams中的體積單位。
FluidOunce	液體盎司的體積單位。
Gill	吉爾斯中的磁碟區單位。
Hectoliter	堆積體中的磁碟區單位。
Hogshead	豬頭中的音量單位。
Liter	以升為單位的音量單位。
Milliliter	以毫升為單位的體積單位。
Minim	迷你中的磁碟區單位。
Peck	pecks 中的音量單位。
Pinch	以英吋為單位的磁碟區單位。
Pint	品脫中的磁碟區單位。
Quart	四重中的磁碟區單位。
Tablespoon	數據表茶匙中的磁碟區單位。
Teaspoon	以茶匙為單位的體積單位。
Unspecified	未指定的磁碟區單位。

WarningCodeValue

列舉型別

定義警告碼的清單。

值	Description
DocumentTruncated	檔截斷警告
LongWordsInDocument	檔警告中的長字

WeightMetadata

Object

代表權數）實體元數據模型。

名稱	類型	Description
metadataKind	string: WeightMetadata	實體元數據物件種類。
unit	WeightUnit	權數的測量單位。
value	number (double)	擷取文字所代表的數值。

WeightUnit

列舉型別

度量單位。

值	Description
Dram	drams 中的重量單位
Gallon	以加侖為單位的體積單位
Grain	粒紋中的重量單位
Gram	以克為單位的重量單位
Kilogram	重量單位以公斤為單位
LongTonBritish	長噸重量單位（英國）
MetricTon	計量噸的重量單位
Milligram	以毫克為單位的重量單位
Ounce	盎司重量單位
PennyWeight	重量單位以佩尼重量為單位
Pound	重量單位以磅為單位
ShortHundredWeightUS	短百重量級重量單位（美國）
ShortTonUS	短噸重量單位（美國）
Stone	石頭重量單位
Ton	重量單位以噸為單位
Unspecified	未指定的權數單位

共用方式為

Text Analysis Runtime - 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