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

Text Analysis Authoring Get Supported Prebuilt Entities - Text Analysis Authoring Get Supported Prebuilt Entities

参考

服务:: Azure AI Services

API 版本:: 2025-05-15-preview

列出在创建组合实体时可以使用的受支持预生成实体。

GET {Endpoint}/language/authoring/analyze-text/projects/global/prebuilt-entities?api-version=2025-05-15-preview

URI 参数

名称	在	必需	类型	说明
Endpoint	path	True	string (url)	支持的认知服务终结点，例如 https://.api.cognitiveservices.azure.com.
api-version	query	True	string minLength: 1	要用于此操作的 API 版本。

响应

名称	类型	说明
200 OK	PagedTextAnalysisAuthoringPrebuiltEntity	请求已成功。
Other Status Codes	Azure.Core.Foundations.ErrorResponse	意外的错误响应。标头 x-ms-error-code: string

名称

类型

说明

200 OK

PagedTextAnalysisAuthoringPrebuiltEntity

请求已成功。

Other Status Codes

Azure.Core.Foundations.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

示例

SuccessfulGetSupportedPrebuiltEntities

示例请求

HTTP

GET {Endpoint}/language/authoring/analyze-text/projects/global/prebuilt-entities?api-version=2025-05-15-preview

示例响应

状态代码:: 200

{
  "value": [
    {
      "category": "BodyStructure",
      "description": "Body systems, anatomic locations or regions, and body sites",
      "examples": "arm, knee, abdomen, nose, liver, head, respiratory system, lymphocytes"
    },
    {
      "category": "Age",
      "description": "All age terms and phrases, including ones for patients, family members, and others",
      "examples": "40-year-old, 51 yo, 3 months old, adult, infant, elderly, young, minor, middle-aged"
    },
    {
      "category": "Gender",
      "description": "Terms that disclose the gender of the subject",
      "examples": "male, female, woman, gentleman, lady"
    },
    {
      "category": "Ethnicity",
      "description": "Phrases that indicate the ethnicity of the subject",
      "examples": "African American, Asian"
    },
    {
      "category": "ExaminationName",
      "description": "Diagnostic procedures and tests, including vital signs and body measurements",
      "examples": "MRI, ECG, HIV test, hemoglobin, platelets count, scale systems such as Bristol stool scale"
    },
    {
      "category": "Date",
      "description": "Full date relating to a medical condition, examination, treatment, medication, or administrative event",
      "examples": "May 11th"
    },
    {
      "category": "Direction",
      "description": "Directional terms that may relate to a body structure, medical condition, examination, or treatment",
      "examples": "left, lateral, upper, posterior"
    },
    {
      "category": "Frequency",
      "description": "how often a medical condition, examination, treatment, or medication occurred, occurs, or should occur",
      "examples": "usually"
    },
    {
      "category": "MeasurementValue",
      "description": "The value related to an examination or a medical condition measurement",
      "examples": "1, 18"
    },
    {
      "category": "MeasurementUnit",
      "description": "The unit of measurement related to an examination or a medical condition measurement",
      "examples": "cm"
    },
    {
      "category": "RelationalOperator",
      "description": "Phrases that express the quantitative relation between an entity and some additional information",
      "examples": ">, <="
    },
    {
      "category": "Time",
      "description": "Temporal terms relating to the beginning and/or length (duration) of a medical condition, examination, treatment, medication, or administrative event",
      "examples": "10/92"
    },
    {
      "category": "Course",
      "description": "Description of a change in another entity over time, such as condition progression / a course of treatment or medication",
      "examples": "improvement, worsening, resolution, remission, increase in medication dosage"
    },
    {
      "category": "GeneOrProtein",
      "description": "All mentions of names and symbols of human genes as well as chromosomes and parts of chromosomes and proteins",
      "examples": "MTRR, F2"
    },
    {
      "category": "Variant",
      "description": "All mentions of gene variations and mutations",
      "examples": "c.524C>T, (MTRR):r.1462_1557del96"
    },
    {
      "category": "Expression",
      "description": "Gene expression level",
      "examples": "positive for-, negative for-, overexpressed, detected in high/low levels, elevated"
    },
    {
      "category": "MutationType",
      "description": "MTRR, F2",
      "examples": "trisomy, germline mutation, loss of function"
    },
    {
      "category": "AdministrativeEvent",
      "description": "Events that relate to the healthcare system but of an administrative/semi-administrative nature",
      "examples": "registration, admission, trial, study entry, transfer, discharge, hospitalization, hospital stay"
    },
    {
      "category": "CareEnvironment",
      "description": "registration, admission, trial, study entry, transfer, discharge, hospitalization, hospital stay",
      "examples": "emergency room, physician’s office, cardio unit, hospice, hospital"
    },
    {
      "category": "HealthcareProfession",
      "description": "emergency room, physician’s office, cardio unit, hospice, hospital",
      "examples": "dentist, pathologist, neurologist, radiologist, pharmacist, nutritionist, physical therapist, chiropractor"
    },
    {
      "category": "Diagnosis",
      "description": "Disease, syndrome, poisoning",
      "examples": "breast cancer, Alzheimer’s, HTN, CHF, spinal cord injury"
    },
    {
      "category": "SymptomOrSign",
      "description": "Subjective or objective evidence of disease or other diagnoses",
      "examples": "chest pain, headache, dizziness, rash, SOB, abdomen was soft, good bowel sounds, well nourished"
    },
    {
      "category": "ConditionQualifier",
      "description": "Qualitative terms that are used to describe a medical condition",
      "examples": "sudden, acute, chronic, longstanding, burning, sharp, severe, mild, a bit, uncontrolled, local, focal, diffuse"
    },
    {
      "category": "ConditionScale",
      "description": "Qualitative terms that characterize the condition by a scale, which is a finite ordered list of values",
      "examples": "stage III"
    },
    {
      "category": "MedicationClass",
      "description": "A set of medications that have a similar mechanism of action, a related mode of action, a similar chemical structure, and/or are used to treat the same disease",
      "examples": "ACE inhibitor, opioid, antibiotics, pain relievers"
    },
    {
      "category": "MedicationName",
      "description": "Medication mentions, including copyrighted brand names, and non-brand names",
      "examples": "Ibuprofen"
    },
    {
      "category": "Dosage",
      "description": "Amount of medication ordered",
      "examples": "Infuse Sodium Chloride solution 1000 mL"
    },
    {
      "category": "MedicationForm",
      "description": "The form of the medication",
      "examples": "solution, pill, capsule, tablet, patch, gel, paste, foam, spray, drops, cream, syrup"
    },
    {
      "category": "MedicationRoute",
      "description": "The administration method of medication",
      "examples": "oral, topical, inhaled"
    },
    {
      "category": "FamilyRelation",
      "description": "Mentions of family relatives of the subject",
      "examples": "father, daughter, siblings, parents"
    },
    {
      "category": "TreatmentName",
      "description": "Therapeutic procedures",
      "examples": "knee replacement surgery, bone marrow transplant, TAVI, diet"
    },
    {
      "category": "Allergen",
      "description": "an antigen triggering an allergic reaction",
      "examples": "cats, peanuts"
    },
    {
      "category": "Employment",
      "description": "Mentions of employment status including specific profession",
      "examples": "unemployed, retired, firefighter, student"
    },
    {
      "category": "LivingStatus",
      "description": "Mentions of the housing situation",
      "examples": "homeless, living with parents, living alone, living with others"
    },
    {
      "category": "SubstanceUse",
      "description": "Mentions of use of legal or illegal drugs, tobacco or alcohol",
      "examples": "smoking, drinking, or heroin"
    },
    {
      "category": "SubstanceUseAmount",
      "description": "Mentions of specific amounts of substance use",
      "examples": "a pack (of cigarettes) or a few glasses (of wine)"
    }
  ],
  "nextLink": null
}

定义

名称	说明
Azure.Core.Foundations.Error	错误对象。
Azure.Core.Foundations.ErrorResponse	包含错误详细信息的响应。
Azure.Core.Foundations.InnerError	包含有关错误的更具体信息的对象。根据Microsoft一个 API 指南 - https://github.com/microsoft/api-guidelines/blob/vNext/azure/Guidelines.md#handling-errors。
PagedTextAnalysisAuthoringPrebuiltEntity	TextAnalysisAuthoringPrebuiltEntity 项的分页集合
TextAnalysisAuthoringPrebuiltEntity	表示支持的预生成实体。

Azure.Core.Foundations.Error

Object

错误对象。

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

Azure.Core.Foundations.ErrorResponse

Object

包含错误详细信息的响应。

名称	类型	说明
error	Azure.Core.Foundations.Error	错误对象。

Azure.Core.Foundations.InnerError

Object

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

名称	类型	说明
code	string	服务器定义的错误代码集之一。
innererror	Azure.Core.Foundations.InnerError	内部错误。

PagedTextAnalysisAuthoringPrebuiltEntity

Object

TextAnalysisAuthoringPrebuiltEntity 项的分页集合

名称	类型	说明
nextLink	string (uri)	指向下一页项的链接
value	TextAnalysisAuthoringPrebuiltEntity[]	此页面上的 TextAnalysisAuthoringPrebuiltEntity 项

TextAnalysisAuthoringPrebuiltEntity

Object

表示支持的预生成实体。

名称	类型	说明
category	string	预生成的实体类别。
description	string	说明。
examples	string	实体的英语示例。

通过

Text Analysis Authoring Get Supported Prebuilt Entities - Text Analysis Authoring Get Supported Prebuilt Entities

URI 参数

响应

安全性

Ocp-Apim-Subscription-Key

OAuth2Auth

作用域

示例

SuccessfulGetSupportedPrebuiltEntities

示例请求

示例响应

定义

Azure.Core.Foundations.Error

Azure.Core.Foundations.ErrorResponse

Azure.Core.Foundations.InnerError

PagedTextAnalysisAuthoringPrebuiltEntity

TextAnalysisAuthoringPrebuiltEntity