Conversational Analysis Authoring - Get Supported Prebuilt Entities
構成済みエンティティの作成時に使用できる、サポートされている事前構築済みエンティティを一覧表示します。
GET {Endpoint}/language/authoring/analyze-conversations/projects/global/prebuilt-entities?api-version=2022-05-01
GET {Endpoint}/language/authoring/analyze-conversations/projects/global/prebuilt-entities?language={language}&multilingual={multilingual}&top={top}&skip={skip}&maxpagesize={maxpagesize}&api-version=2022-05-01
URI パラメーター
名前 | / | 必須 | 型 | 説明 |
---|---|---|---|---|
Endpoint
|
path | True |
string |
サポートされている Cognitive Services エンドポイント (例: https://.api.cognitiveservices.azure.com). |
api-version
|
query | True |
string |
クライアント API バージョン。 |
language
|
query |
string |
サポートされている事前構築済みエンティティを取得する言語。 多言語が false の場合は必須。 これは、言語の BCP-47 表現です。 たとえば、英語の場合は "en"、英語 (英国) の場合は "en-gb"、スペイン語の場合は "es" などを使用します。 |
|
maxpagesize
|
query |
integer int32 |
1 つの応答に含めるリソースの最大数。 |
|
multilingual
|
query |
string |
多言語プロジェクトまたは単一言語プロジェクトのサポート事前構築済みエンティティを取得するかどうか。 true の場合、言語パラメーターは無視されます。 |
|
skip
|
query |
integer int32 |
返される最初のリソースのコレクションへのオフセット。 |
|
top
|
query |
integer int32 |
コレクションから返されるリソースの最大数。 |
要求ヘッダー
名前 | 必須 | 型 | 説明 |
---|---|---|---|
Ocp-Apim-Subscription-Key | True |
string |
言語サービス リソースのサブスクリプション キー。 |
応答
名前 | 型 | 説明 |
---|---|---|
200 OK |
サポートされている事前構築済みエンティティの一覧。 |
|
Other Status Codes |
エラー応答。 |
セキュリティ
Ocp-Apim-Subscription-Key
言語サービス リソースのサブスクリプション キー。
型:
apiKey
/:
header
例
Successful Get Supported Prebuilt Entities
要求のサンプル
GET {Endpoint}/language/authoring/analyze-conversations/projects/global/prebuilt-entities?language=en&api-version=2022-05-01
応答のサンプル
{
"value": [
{
"category": "Person.Name",
"description": "Name of an individual",
"examples": "john, Sam, Lisa"
},
{
"category": "General.Event",
"description": "Important events",
"examples": "World War two, Covid 19"
},
{
"category": "General.Organization",
"description": "Companies and corporations",
"examples": "Microsoft, Amazon"
},
{
"category": "Choice.Boolean",
"description": "boolean choice",
"examples": "yes, no, agreed"
},
{
"category": "Quantity.Age",
"description": "Age of a person or thing",
"examples": "10-month-old, 19 years old, 58 year-old"
},
{
"category": "Quantity.NumberRange",
"description": "a numeric interval",
"examples": "between 25 and 35, 25-35"
},
{
"category": "Quantity.Number",
"description": "A cardinal number in numeric or text form",
"examples": "ten, forty two, 3.141, 10K"
},
{
"category": "Quantity.Percentage",
"description": "A percentage, using the symbol % or the word \"percent\"",
"examples": "10%, 5.6 percent"
},
{
"category": "Quantity.Ordinal",
"description": "An ordinal number in numeric or text form",
"examples": "first, second, tenth, 1st, 2nd, 10th"
},
{
"category": "Quantity.Dimension",
"description": "Spacial dimensions, including length, distance, area, and volume",
"examples": "2 miles, 650 square kilometres, 9,350 feet"
},
{
"category": "Quantity.Temperature",
"description": "A temperature in celsius or fahrenheit",
"examples": "32F, 34 degrees celsius, 2 deg C"
},
{
"category": "Quantity.Currency",
"description": "Monetary amounts, including currency",
"examples": "1000.00 US dollars, £20.00, $ 67.5 B"
},
{
"category": "DateTime",
"description": "exact date values",
"examples": "May 11th"
},
{
"category": "Email",
"description": "Email addresses",
"examples": "user@example.net, user_name@example.com, user.Name12@example.net"
},
{
"category": "Phone Number",
"description": "US phone numbers",
"examples": "123-456-7890, +1 123 456 789, (123)456-789"
},
{
"category": "URL",
"description": "Websites URLs and links",
"examples": "www.example.com, http://example.net?name=my_name&age=10"
}
],
"nextLink": null
}
定義
名前 | 説明 |
---|---|
Conversational |
取得されたサポートされている事前構築済みエンティティの一覧を表します。 |
Conversational |
サポートされている事前構築済みエンティティを表します。 |
Error |
error オブジェクト。 |
Error |
人間が判読できるエラー コード。 |
Error |
エラー応答。 |
Inner |
人間が判読できるエラー コード。 |
Inner |
エラーに関するより具体的な情報を含むオブジェクト。 Microsoft One API のガイドラインに従って - https://github.com/Microsoft/api-guidelines/blob/vNext/Guidelines.md#7102-error-condition-responses。 |
ConversationalAnalysisAuthoringPrebuiltEntities
取得されたサポートされている事前構築済みエンティティの一覧を表します。
名前 | 型 | 説明 |
---|---|---|
nextLink |
string |
次のページ リンク。 |
value |
サポートされている事前構築済みエンティティ。 |
ConversationalAnalysisAuthoringPrebuiltEntity
サポートされている事前構築済みエンティティを表します。
名前 | 型 | 説明 |
---|---|---|
category |
string |
事前構築済みのエンティティ カテゴリ。 |
description |
string |
説明です。 |
examples |
string |
エンティティの英語の例。 |
Error
error オブジェクト。
名前 | 型 | 説明 |
---|---|---|
code |
サーバー定義のエラー コードのセットの 1 つ。 |
|
details |
Error[] |
この報告されたエラーの原因となった特定のエラーに関する詳細の配列。 |
innererror |
エラーに関する現在のオブジェクトよりも具体的な情報を含む オブジェクト。 |
|
message |
string |
エラーの人間が判読できる表現。 |
target |
string |
エラーのターゲット。 |
ErrorCode
人間が判読できるエラー コード。
名前 | 型 | 説明 |
---|---|---|
AzureCognitiveSearchIndexLimitReached |
string |
|
AzureCognitiveSearchIndexNotFound |
string |
|
AzureCognitiveSearchNotFound |
string |
|
AzureCognitiveSearchThrottling |
string |
|
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 オブジェクト。 |
InnerErrorCode
人間が判読できるエラー コード。
名前 | 型 | 説明 |
---|---|---|
AzureCognitiveSearchNotFound |
string |
|
AzureCognitiveSearchThrottling |
string |
|
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 One API のガイドラインに従って - https://github.com/Microsoft/api-guidelines/blob/vNext/Guidelines.md#7102-error-condition-responses。
名前 | 型 | 説明 |
---|---|---|
code |
サーバー定義のエラー コードのセットの 1 つ。 |
|
details |
object |
エラーの詳細。 |
innererror |
エラーに関する現在のオブジェクトよりも具体的な情報を含む オブジェクト。 |
|
message |
string |
エラー メッセージ。 |
target |
string |
エラーターゲット。 |