Conversational Analysis Authoring - Get Supported Prebuilt Entities

清單 建立組成實體時可以使用的支持預先建置實體。

GET {Endpoint}/language/authoring/analyze-conversations/projects/global/prebuilt-entities?api-version=2023-04-01
GET {Endpoint}/language/authoring/analyze-conversations/projects/global/prebuilt-entities?language={language}&multilingual={multilingual}&top={top}&skip={skip}&maxpagesize={maxpagesize}&api-version=2023-04-01

URI 參數

名稱 位於 必要 類型 Description
Endpoint
path True

string

支援的認知服務端點 (例如 https://.api.cognitiveservices.azure.com).

api-version
query True

string

用戶端 API 版本。

language
query

string

要取得預先建置實體的語言。 如果多語系為 false,則為必要項。 這是語言的 BCP-47 表示法。 例如,將 「en」 用於英文、“en-gb” 用於英文 (UK) 、西班牙文為 “es”。

maxpagesize
query

integer

int32

要包含在單一回應中的資源數目上限。

multilingual
query

string

是否要取得多語系或單一語言專案的預先建置實體支援。 如果為 true,則會忽略語言參數。

skip
query

integer

int32

要傳回之第一個資源的集合中的位移。

top
query

integer

int32

要從集合傳回的資源數目上限。

回應

名稱 類型 Description
200 OK

ConversationalAnalysisAuthoringPrebuiltEntities

支援的預先建置實體清單。

Other Status Codes

ErrorResponse

錯誤回應。

安全性

AADToken

這些是 Azure Active Directory OAuth2 流程。 與 Azure 角色型存取控制配對時,可用來控制對 REST API 的存取 Azure 地圖服務。 Azure 角色型訪問控制可用來指定一或多個 Azure 地圖服務 資源帳戶或子資源的存取權。 任何使用者、群組或服務主體都可以透過內建角色或由一或多個許可權組成的自定義角色來授與存取權,以 Azure 地圖服務 REST API。

若要實作案例,建議您檢視 驗證概念。 總而言之,此安全性定義提供一個解決方案,可透過能夠針對特定 API 和範圍進行存取控制的物件,將應用程式模型化 () 。

備註

  • 此安全性定義需要使用x-ms-client-id 標頭來指出應用程式要求存取權 Azure 地圖服務 資源。 這可以從 地圖服務管理 API 取得。

Authorization URL專屬於 Azure 公用雲端實例。 主權雲端具有唯一的授權 URL 和 Azure Active Directory 設定。 * 透過 Azure 入口網站、PowerShell、CLI、Azure SDK 或 REST API,從 Azure 管理平面設定 Azure 角色型存取控制。 * Azure 地圖服務 Web SDK 的使用方式允許針對多個使用案例設定應用程式。

  • Azure Active Directory v1.0 或 v2.0 目前支援公司、學校和來賓,但不支持個人帳戶。

類型: oauth2
Flow: implicit
授權 URL: https://login.microsoftonline.com/common/oauth2/authorize

範圍

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

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=2023-04-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
}

定義

名稱 Description
ConversationalAnalysisAuthoringPrebuiltEntities

表示所擷取之預先建置實體的清單。

ConversationalAnalysisAuthoringPrebuiltEntity

表示支援的預先建置實體。

Error

error 物件。

ErrorCode

人類可讀取的錯誤碼。

ErrorResponse

錯誤回應。

InnerErrorCode

人類可讀取的錯誤碼。

InnerErrorModel

物件,包含錯誤的詳細資訊。 根據 Microsoft One API 指導方針 - https://github.com/Microsoft/api-guidelines/blob/vNext/Guidelines.md#7102-error-condition-responses

ConversationalAnalysisAuthoringPrebuiltEntities

表示所擷取之預先建置實體的清單。

名稱 類型 Description
nextLink

string

下一頁連結。

value

ConversationalAnalysisAuthoringPrebuiltEntity[]

支援的預先建置實體。

ConversationalAnalysisAuthoringPrebuiltEntity

表示支援的預先建置實體。

名稱 類型 Description
category

string

預先建置的實體類別目錄。

description

string

描述。

examples

string

實體的英文範例。

Error

error 物件。

名稱 類型 Description
code

ErrorCode

其中一組伺服器定義的錯誤碼。

details

Error[]

導致此錯誤之特定錯誤的詳細數據陣列。

innererror

InnerErrorModel

物件,包含比目前對象有關錯誤更具體的資訊。

message

string

人類可讀取的錯誤表示法。

target

string

錯誤的目標。

ErrorCode

人類可讀取的錯誤碼。

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

錯誤回應。

名稱 類型 Description
error

Error

error 物件。

InnerErrorCode

人類可讀取的錯誤碼。

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

名稱 類型 Description
code

InnerErrorCode

其中一組伺服器定義的錯誤碼。

details

object

錯誤詳細數據。

innererror

InnerErrorModel

物件,包含比目前對象有關錯誤更具體的資訊。

message

string

錯誤訊息。

target

string

錯誤目標。