快速入門：針對健康情況客戶端連結庫和 REST API 使用 文字分析
本文包含有關適用於健康情況的文字分析快速入門，有助於使用支援的用戶端程式庫、C#、JAVA、NodeJS 和 Python，以及使用 REST API。
提示
您可以使用 Language Studio 來嘗試語言服務功能，而不需要撰寫程式代碼。
參考檔 | 其他範例 | 套件 （NuGet） | 連結庫原始程式碼
使用本快速入門，使用適用於 .NET 的用戶端連結庫建立健康情況應用程式的 文字分析。 在下列範例中，您將建立 C# 應用程式，以識別出現在文字中的醫療 實體、 關聯和 判斷提示 。
必要條件
- Azure 訂用帳戶 - 建立免費帳戶
- Visual Studio IDE
- 擁有 Azure 訂用帳戶之後，請在 Azure 入口網站 中建立語言資源，以取得您的密鑰和端點。 在其部署後，選取 [前往資源]。
- 您需要從您建立的資源取得密鑰和端點，才能將應用程式連線到 API。 您稍後會在快速入門中將金鑰和端點貼到下列程式代碼中。
- 您可以使用免費定價層
Free F0() 來試用服務 (提供 5000 筆文字記錄 - 每筆 1000 個字元)，並在稍後升級至生產環境的Standard S定價層。 您也可以從Standard S定價層開始，在收費之前免費接收相同的初始配額 (5000 筆文字記錄)。 如需定價的詳細資訊，請瀏覽語言服務定價。
設定
建立環境變數
您的應用程式必須經過驗證，才能傳送 API 要求。 針對生產環境，請使用安全的方式來儲存和存取您的認證。 在此範例中，您會將認證寫入執行應用程式的本機計算機上環境變數。
提示
請勿將金鑰直接包含在您的程式代碼中，且絕不會公開發佈。 如需更多驗證選項 (例如 Azure Key Vault)，請參閱 Azure AI 服務安全性文章。
若要設定語言資源密鑰的環境變數，請開啟控制台視窗，並遵循作業系統和開發環境的指示。
- 若要設定
LANGUAGE_KEY環境變數，請將 取代your-key為您資源的其中一個密鑰。 - 若要設定
LANGUAGE_ENDPOINT環境變數，請將 取代your-endpoint為您資源的端點。
setx LANGUAGE_KEY your-key
setx LANGUAGE_ENDPOINT your-endpoint
注意
如果您只需要存取目前執行控制台中的環境變數，您可以使用 來設定環境變數 set ，而不是 setx。
新增環境變數之後，您可能需要重新啟動任何需要讀取環境變數的執行中程式，包括主控台視窗。 例如，如果您使用 Visual Studio 作為編輯器，請在執行範例之前重新啟動 Visual Studio。
建立新的 .NET Core 應用程式
使用 Visual Studio IDE，建立新的 .NET Core 控制台應用程式。 這會建立具有單一 C# 原始程序檔的 「Hello World」 專案： program.cs。
以滑鼠右鍵按兩下 方案總管中的解決方案，然後選取 [管理 NuGet 套件]，以安裝客戶端連結庫。 開啟的套件管理員中，選取 [ 瀏覽 ] 並搜尋 Azure.AI.TextAnalytics。 選取 [版本 5.2.0]，然後 選取 [安裝]。 您也可以使用 封裝管理員 主控台。
程式碼範例
將下列程式代碼複製到您的 program.cs 檔案。 然後執行程式碼。
重要
前往 Azure 入口網站。 如果您在成功部署必要條件一節中建立的語言資源，請按兩下 [後續步驟] 底下的 [移至資源] 按鈕。 您可以在 [資源管理] 底下瀏覽至資源的 [金鑰和端點] 頁面，以尋找您的金鑰和端點。
重要
完成時，請記得從程式碼中移除金鑰，且不要公開張貼金鑰。 在生產環境中，請使用安全的方式來儲存和存取您的認證，例如 Azure Key Vault。 如需詳細資訊，請參閱 Azure AI 服務安全性一文。
using Azure;
using System;
using Azure.AI.TextAnalytics;
using System.Collections.Generic;
using System.Threading.Tasks;
namespace Example
{
class Program
{
// This example requires environment variables named "LANGUAGE_KEY" and "LANGUAGE_ENDPOINT"
private static readonly AzureKeyCredential credentials = new (Environment.GetEnvironmentVariable("LANGUAGE_KEY"));
private static readonly Uri endpoint = new (Environment.GetEnvironmentVariable("LANGUAGE_ENDPOINT"));
// Example method for extracting information from healthcare-related text
static async Task healthExample(TextAnalyticsClient client)
{
string document = "Prescribed 100mg ibuprofen, taken twice daily.";
List<string> batchInput = new List<string>()
{
document
};
AnalyzeHealthcareEntitiesOperation healthOperation = await client.StartAnalyzeHealthcareEntitiesAsync(batchInput);
await healthOperation.WaitForCompletionAsync();
await foreach (AnalyzeHealthcareEntitiesResultCollection documentsInPage in healthOperation.Value)
{
Console.WriteLine($"Results of Azure Text Analytics for health async model, version: \"{documentsInPage.ModelVersion}\"");
Console.WriteLine("");
foreach (AnalyzeHealthcareEntitiesResult entitiesInDoc in documentsInPage)
{
if (!entitiesInDoc.HasError)
{
foreach (var entity in entitiesInDoc.Entities)
{
// view recognized healthcare entities
Console.WriteLine($" Entity: {entity.Text}");
Console.WriteLine($" Category: {entity.Category}");
Console.WriteLine($" Offset: {entity.Offset}");
Console.WriteLine($" Length: {entity.Length}");
Console.WriteLine($" NormalizedText: {entity.NormalizedText}");
}
Console.WriteLine($" Found {entitiesInDoc.EntityRelations.Count} relations in the current document:");
Console.WriteLine("");
// view recognized healthcare relations
foreach (HealthcareEntityRelation relations in entitiesInDoc.EntityRelations)
{
Console.WriteLine($" Relation: {relations.RelationType}");
Console.WriteLine($" For this relation there are {relations.Roles.Count} roles");
// view relation roles
foreach (HealthcareEntityRelationRole role in relations.Roles)
{
Console.WriteLine($" Role Name: {role.Name}");
Console.WriteLine($" Associated Entity Text: {role.Entity.Text}");
Console.WriteLine($" Associated Entity Category: {role.Entity.Category}");
Console.WriteLine("");
}
Console.WriteLine("");
}
}
else
{
Console.WriteLine(" Error!");
Console.WriteLine($" Document error code: {entitiesInDoc.Error.ErrorCode}.");
Console.WriteLine($" Message: {entitiesInDoc.Error.Message}");
}
Console.WriteLine("");
}
}
}
static async Task Main(string[] args)
{
var client = new TextAnalyticsClient(endpoint, credentials);
await healthExample(client);
}
}
}
輸出
Results of Azure Text Analytics for health async model, version: "2022-03-01"
Entity: 100mg
Category: Dosage
Offset: 11
Length: 5
NormalizedText:
Entity: ibuprofen
Category: MedicationName
Offset: 17
Length: 9
NormalizedText: ibuprofen
Entity: twice daily
Category: Frequency
Offset: 34
Length: 11
NormalizedText:
Found 2 relations in the current document:
Relation: DosageOfMedication
For this relation there are 2 roles
Role Name: Dosage
Associated Entity Text: 100mg
Associated Entity Category: Dosage
Role Name: Medication
Associated Entity Text: ibuprofen
Associated Entity Category: MedicationName
Relation: FrequencyOfMedication
For this relation there are 2 roles
Role Name: Medication
Associated Entity Text: ibuprofen
Associated Entity Category: MedicationName
Role Name: Frequency
Associated Entity Text: twice daily
Associated Entity Category: Frequency
提示
快速醫療保健互操作性資源 （FHIR） 建構可使用語言 REST API 進行預覽。 目前不支援客戶端連結庫。 深入瞭解 如何在 API 呼叫中使用 FHIR 結構。
參考檔 | 其他範例 | 套件 （Maven） | 連結庫原始程式碼
使用本快速入門，使用適用於 Java 的用戶端連結庫建立健康情況應用程式的 文字分析。 在下列範例中，您將建立 Java 應用程式，以識別出現在文字中的醫療 實體、 關聯性和 判斷提示 。
必要條件
- Azure 訂用帳戶 - 建立免費帳戶
- 具有 8 版或更新版本的 Java 開發工具套件 （JDK）
- 擁有 Azure 訂用帳戶之後，請在 Azure 入口網站 中建立語言資源，以取得您的密鑰和端點。 在其部署後，選取 [前往資源]。
- 您需要從您建立的資源取得密鑰和端點，才能將應用程式連線到 API。 您稍後會在快速入門中將金鑰和端點貼到下列程式代碼中。
- 您可以使用免費定價層
Free F0() 來試用服務 (提供 5000 筆文字記錄 - 每筆 1000 個字元)，並在稍後升級至生產環境的Standard S定價層。 您也可以從Standard S定價層開始，在收費之前免費接收相同的初始配額 (5000 筆文字記錄)。 如需定價的詳細資訊，請瀏覽語言服務定價。
設定
建立環境變數
您的應用程式必須經過驗證，才能傳送 API 要求。 針對生產環境，請使用安全的方式來儲存和存取您的認證。 在此範例中，您會將認證寫入執行應用程式的本機計算機上環境變數。
提示
請勿將金鑰直接包含在您的程式代碼中，且絕不會公開發佈。 如需更多驗證選項 (例如 Azure Key Vault)，請參閱 Azure AI 服務安全性文章。
若要設定語言資源密鑰的環境變數，請開啟控制台視窗，並遵循作業系統和開發環境的指示。
- 若要設定
LANGUAGE_KEY環境變數，請將 取代your-key為您資源的其中一個密鑰。 - 若要設定
LANGUAGE_ENDPOINT環境變數，請將 取代your-endpoint為您資源的端點。
setx LANGUAGE_KEY your-key
setx LANGUAGE_ENDPOINT your-endpoint
注意
如果您只需要存取目前執行控制台中的環境變數，您可以使用 來設定環境變數 set ，而不是 setx。
新增環境變數之後，您可能需要重新啟動任何需要讀取環境變數的執行中程式，包括主控台視窗。 例如，如果您使用 Visual Studio 作為編輯器，請在執行範例之前重新啟動 Visual Studio。
新增 用戶端程式庫
在慣用的 IDE 或開發環境中建立 Maven 專案。 然後將下列相依性新增至專案的 pom.xml 檔案。 您可以在在線找到其他建置工具的實作語法。
<dependencies>
<dependency>
<groupId>com.azure</groupId>
<artifactId>azure-ai-textanalytics</artifactId>
<version>5.2.0</version>
</dependency>
</dependencies>
程式碼範例
建立名為 EntityLinking.java的 Java 檔案。 開啟檔案並複製下列程序代碼。 然後執行程式碼。
重要
前往 Azure 入口網站。 如果您在成功部署必要條件一節中建立的語言資源，請按兩下 [後續步驟] 底下的 [移至資源] 按鈕。 您可以在 [資源管理] 底下瀏覽至資源的 [金鑰和端點] 頁面，以尋找您的金鑰和端點。
重要
完成時，請記得從程式碼中移除金鑰，且不要公開張貼金鑰。 在生產環境中，請使用安全的方式來儲存和存取您的認證，例如 Azure Key Vault。 如需詳細資訊，請參閱 Azure AI 服務安全性一文。
import com.azure.core.credential.AzureKeyCredential;
import com.azure.ai.textanalytics.models.*;
import com.azure.ai.textanalytics.TextAnalyticsClientBuilder;
import com.azure.ai.textanalytics.TextAnalyticsClient;
import java.util.List;
import java.util.Arrays;
import com.azure.core.util.Context;
import com.azure.core.util.polling.SyncPoller;
import com.azure.ai.textanalytics.util.*;
public class Example {
// This example requires environment variables named "LANGUAGE_KEY" and "LANGUAGE_ENDPOINT"
private static String KEY = System.getenv("LANGUAGE_KEY");
private static String ENDPOINT = System.getenv("LANGUAGE_ENDPOINT");
public static void main(String[] args) {
TextAnalyticsClient client = authenticateClient(languageKey, languageEndpoint);
healthExample(client);
}
// Method to authenticate the client object with your key and endpoint
static TextAnalyticsClient authenticateClient(String key, String endpoint) {
return new TextAnalyticsClientBuilder()
.credential(new AzureKeyCredential(key))
.endpoint(endpoint)
.buildClient();
}
// Example method for extracting information from healthcare-related text
static void healthExample(TextAnalyticsClient client){
List<TextDocumentInput> documents = Arrays.asList(
new TextDocumentInput("0",
"Prescribed 100mg ibuprofen, taken twice daily."));
AnalyzeHealthcareEntitiesOptions options = new AnalyzeHealthcareEntitiesOptions().setIncludeStatistics(true);
SyncPoller<AnalyzeHealthcareEntitiesOperationDetail, AnalyzeHealthcareEntitiesPagedIterable>
syncPoller = client.beginAnalyzeHealthcareEntities(documents, options, Context.NONE);
System.out.printf("Poller status: %s.%n", syncPoller.poll().getStatus());
syncPoller.waitForCompletion();
// Task operation statistics
AnalyzeHealthcareEntitiesOperationDetail operationResult = syncPoller.poll().getValue();
System.out.printf("Operation created time: %s, expiration time: %s.%n",
operationResult.getCreatedAt(), operationResult.getExpiresAt());
System.out.printf("Poller status: %s.%n", syncPoller.poll().getStatus());
for (AnalyzeHealthcareEntitiesResultCollection resultCollection : syncPoller.getFinalResult()) {
// Model version
System.out.printf(
"Results of Azure Text Analytics for health entities\" Model, version: %s%n",
resultCollection.getModelVersion());
for (AnalyzeHealthcareEntitiesResult healthcareEntitiesResult : resultCollection) {
System.out.println("Document ID = " + healthcareEntitiesResult.getId());
System.out.println("Document entities: ");
// Recognized healthcare entities
for (HealthcareEntity entity : healthcareEntitiesResult.getEntities()) {
System.out.printf(
"\tText: %s, normalized name: %s, category: %s, subcategory: %s, confidence score: %f.%n",
entity.getText(), entity.getNormalizedText(), entity.getCategory(),
entity.getSubcategory(), entity.getConfidenceScore());
}
// Recognized healthcare entity relation groups
for (HealthcareEntityRelation entityRelation : healthcareEntitiesResult.getEntityRelations()) {
System.out.printf("Relation type: %s.%n", entityRelation.getRelationType());
for (HealthcareEntityRelationRole role : entityRelation.getRoles()) {
HealthcareEntity entity = role.getEntity();
System.out.printf("\tEntity text: %s, category: %s, role: %s.%n",
entity.getText(), entity.getCategory(), role.getName());
}
}
}
}
}
}
輸出
Poller status: IN_PROGRESS.
Operation created time: 2022-09-15T19:06:11Z, expiration time: 2022-09-16T19:06:11Z.
Poller status: SUCCESSFULLY_COMPLETED.
Results of Azure Text Analytics for health entities" Model, version: 2022-03-01
Document ID = 0
Document entities:
Text: 100mg, normalized name: null, category: Dosage, subcategory: null, confidence score: 0.980000.
Text: ibuprofen, normalized name: ibuprofen, category: MedicationName, subcategory: null, confidence score: 1.000000.
Text: twice daily, normalized name: null, category: Frequency, subcategory: null, confidence score: 1.000000.
Relation type: DosageOfMedication.
Entity text: 100mg, category: Dosage, role: Dosage.
Entity text: ibuprofen, category: MedicationName, role: Medication.
Relation type: FrequencyOfMedication.
Entity text: ibuprofen, category: MedicationName, role: Medication.
Entity text: twice daily, category: Frequency, role: Frequency.
提示
快速醫療保健互操作性資源 （FHIR） 建構可使用語言 REST API 進行預覽。 目前不支援客戶端連結庫。 深入瞭解 如何在 API 呼叫中使用 FHIR 結構。
參考檔 | 其他範例 | 套件 （npm） | 連結庫原始程式碼
使用本快速入門，使用適用於 Node.js的用戶端連結庫建立健康情況應用程式的 文字分析。 在下列範例中，您將建立 JavaScript 應用程式，以識別出現在文字中的醫療 實體、 關聯性和 判斷提示 。
必要條件
- Azure 訂用帳戶 - 建立免費帳戶
- Node.js v14 LTS 或更新版本
- 擁有 Azure 訂用帳戶之後，請在 Azure 入口網站 中建立語言資源，以取得您的密鑰和端點。 在其部署後，選取 [前往資源]。
- 您需要從您建立的資源取得密鑰和端點，才能將應用程式連線到 API。 您稍後會在快速入門中將金鑰和端點貼到下列程式代碼中。
- 您可以使用免費定價層
Free F0() 來試用服務 (提供 5000 筆文字記錄 - 每筆 1000 個字元)，並在稍後升級至生產環境的Standard S定價層。 您也可以從Standard S定價層開始，在收費之前免費接收相同的初始配額 (5000 筆文字記錄)。 如需定價的詳細資訊，請瀏覽語言服務定價。
設定
建立環境變數
您的應用程式必須經過驗證，才能傳送 API 要求。 針對生產環境，請使用安全的方式來儲存和存取您的認證。 在此範例中，您會將認證寫入執行應用程式的本機計算機上環境變數。
提示
請勿將金鑰直接包含在您的程式代碼中，且絕不會公開發佈。 如需更多驗證選項 (例如 Azure Key Vault)，請參閱 Azure AI 服務安全性文章。
若要設定語言資源密鑰的環境變數，請開啟控制台視窗，並遵循作業系統和開發環境的指示。
- 若要設定
LANGUAGE_KEY環境變數，請將 取代your-key為您資源的其中一個密鑰。 - 若要設定
LANGUAGE_ENDPOINT環境變數，請將 取代your-endpoint為您資源的端點。
setx LANGUAGE_KEY your-key
setx LANGUAGE_ENDPOINT your-endpoint
注意
如果您只需要存取目前執行控制台中的環境變數，您可以使用 來設定環境變數 set ，而不是 setx。
新增環境變數之後，您可能需要重新啟動任何需要讀取環境變數的執行中程式，包括主控台視窗。 例如，如果您使用 Visual Studio 作為編輯器，請在執行範例之前重新啟動 Visual Studio。
建立新的Node.js應用程式
在主控台視窗中（例如 cmd、PowerShell 或 Bash），為您的應用程式建立新的目錄，然後流覽至它。
mkdir myapp
cd myapp
npm init執行 命令以使用 package.json 檔案建立節點應用程式。
npm init
安裝客戶端連結庫
安裝 npm 套件：
npm install @azure/ai-language-text
程式碼範例
開啟檔案並複製下列程序代碼。 然後執行程式碼。
重要
前往 Azure 入口網站。 如果您在成功部署必要條件一節中建立的語言資源，請按兩下 [後續步驟] 底下的 [移至資源] 按鈕。 您可以在 [資源管理] 底下瀏覽至資源的 [金鑰和端點] 頁面，以尋找您的金鑰和端點。
重要
完成時，請記得從程式碼中移除金鑰，且不要公開張貼金鑰。 在生產環境中，請使用安全的方式來儲存和存取您的認證，例如 Azure Key Vault。 如需詳細資訊，請參閱 Azure AI 服務安全性一文。
"use strict";
const { TextAnalyticsClient, AzureKeyCredential } = require("@azure/ai-text-analytics");
// This example requires environment variables named "LANGUAGE_KEY" and "LANGUAGE_ENDPOINT"
const key = process.env.LANGUAGE_KEY;
const endpoint = process.env.LANGUAGE_ENDPOINT;
const documents = ["Patient does not suffer from high blood pressure."];
async function main() {
console.log("== Text analytics for health sample ==");
const client = new TextAnalysisClient(endpoint, new AzureKeyCredential(key));
const actions = [
{
kind: "Healthcare",
},
];
const poller = await client.beginAnalyzeBatch(actions, documents, "en");
poller.onProgress(() => {
console.log(
`Last time the operation was updated was on: ${poller.getOperationState().modifiedOn}`
);
});
console.log(`The operation was created on ${poller.getOperationState().createdOn}`);
console.log(`The operation results will expire on ${poller.getOperationState().expiresOn}`);
const results = await poller.pollUntilDone();
for await (const actionResult of results) {
if (actionResult.kind !== "Healthcare") {
throw new Error(`Expected a healthcare results but got: ${actionResult.kind}`);
}
if (actionResult.error) {
const { code, message } = actionResult.error;
throw new Error(`Unexpected error (${code}): ${message}`);
}
for (const result of actionResult.results) {
console.log(`- Document ${result.id}`);
if (result.error) {
const { code, message } = result.error;
throw new Error(`Unexpected error (${code}): ${message}`);
}
console.log("\tRecognized Entities:");
for (const entity of result.entities) {
console.log(`\t- Entity "${entity.text}" of type ${entity.category}`);
if (entity.dataSources.length > 0) {
console.log("\t and it can be referenced in the following data sources:");
for (const ds of entity.dataSources) {
console.log(`\t\t- ${ds.name} with Entity ID: ${ds.entityId}`);
}
}
}
if (result.entityRelations.length > 0) {
console.log(`\tRecognized relations between entities:`);
for (const relation of result.entityRelations) {
console.log(
`\t\t- Relation of type ${relation.relationType} found between the following entities:`
);
for (const role of relation.roles) {
console.log(`\t\t\t- "${role.entity.text}" with the role ${role.name}`);
}
}
}
}
}
}
main().catch((err) => {
console.error("The sample encountered an error:", err);
});
輸出
== Text analytics for health sample ==
The operation was created on Mon Feb 13 2023 13:12:10 GMT-0800 (Pacific Standard Time)
The operation results will expire on Tue Feb 14 2023 13:12:10 GMT-0800 (Pacific Standard Time)
Last time the operation was updated was on: Mon Feb 13 2023 13:12:10 GMT-0800 (Pacific Standard Time)
- Document 0
Recognized Entities:
- Entity "high blood pressure" of type SymptomOrSign
and it can be referenced in the following data sources:
- UMLS with Entity ID: C0020538
- AOD with Entity ID: 0000023317
- BI with Entity ID: BI00001
- CCPSS with Entity ID: 1017493
- CCS with Entity ID: 7.1
- CHV with Entity ID: 0000015800
- COSTAR with Entity ID: 397
- CSP with Entity ID: 0571-5243
- CST with Entity ID: HYPERTENS
- DXP with Entity ID: U002034
- HPO with Entity ID: HP:0000822
- ICD10 with Entity ID: I10-I15.9
- ICD10AM with Entity ID: I10-I15.9
- ICD10CM with Entity ID: I10
- ICD9CM with Entity ID: 997.91
- ICPC2ICD10ENG with Entity ID: MTHU035456
- ICPC2P with Entity ID: K85004
- LCH with Entity ID: U002317
- LCH_NW with Entity ID: sh85063723
- LNC with Entity ID: LA14293-7
- MDR with Entity ID: 10020772
- MEDCIN with Entity ID: 33288
- MEDLINEPLUS with Entity ID: 34
- MSH with Entity ID: D006973
- MTH with Entity ID: 005
- MTHICD9 with Entity ID: 997.91
- NANDA-I with Entity ID: 00905
- NCI with Entity ID: C3117
- NCI_CPTAC with Entity ID: C3117
- NCI_CTCAE with Entity ID: E13785
- NCI_CTRP with Entity ID: C3117
- NCI_FDA with Entity ID: 1908
- NCI_GDC with Entity ID: C3117
- NCI_NCI-GLOSS with Entity ID: CDR0000458091
- NCI_NICHD with Entity ID: C3117
- NCI_caDSR with Entity ID: C3117
- NOC with Entity ID: 060808
- OMIM with Entity ID: MTHU002068
- PCDS with Entity ID: PRB_11000.06
- PDQ with Entity ID: CDR0000686951
- PSY with Entity ID: 23830
- RCD with Entity ID: XE0Ub
- SNM with Entity ID: F-70700
- SNMI with Entity ID: D3-02000
- SNOMEDCT_US with Entity ID: 38341003
- WHO with Entity ID: 0210
提示
快速醫療保健互操作性資源 （FHIR） 建構可使用語言 REST API 進行預覽。 目前不支援客戶端連結庫。 深入瞭解 如何在 API 呼叫中使用 FHIR 結構。
參考檔 | 其他範例 | 套件 （PyPi） | 連結庫原始程式碼
使用本快速入門，透過適用於 Python 的用戶端連結庫建立健康情況應用程式的 文字分析。 在下列範例中，您將建立 Python 應用程式，以識別出現在文字中的醫療 實體、 關聯性和 判斷提示 。
必要條件
- Azure 訂用帳戶 - 建立免費帳戶
- Python 3.8 或更新版本
- 擁有 Azure 訂用帳戶之後，請在 Azure 入口網站 中建立語言資源，以取得您的密鑰和端點。 在其部署後，選取 [前往資源]。
- 您需要從您建立的資源取得密鑰和端點，才能將應用程式連線到 API。 您稍後會在快速入門中將金鑰和端點貼到下列程式代碼中。
- 您可以使用免費定價層
Free F0() 來試用服務 (提供 5000 筆文字記錄 - 每筆 1000 個字元)，並在稍後升級至生產環境的Standard S定價層。 您也可以從Standard S定價層開始，在收費之前免費接收相同的初始配額 (5000 筆文字記錄)。 如需定價的詳細資訊，請瀏覽語言服務定價。
設定
建立環境變數
您的應用程式必須經過驗證，才能傳送 API 要求。 針對生產環境，請使用安全的方式來儲存和存取您的認證。 在此範例中，您會將認證寫入執行應用程式的本機計算機上環境變數。
提示
請勿將金鑰直接包含在您的程式代碼中，且絕不會公開發佈。 如需更多驗證選項 (例如 Azure Key Vault)，請參閱 Azure AI 服務安全性文章。
若要設定語言資源密鑰的環境變數，請開啟控制台視窗，並遵循作業系統和開發環境的指示。
- 若要設定
LANGUAGE_KEY環境變數，請將 取代your-key為您資源的其中一個密鑰。 - 若要設定
LANGUAGE_ENDPOINT環境變數，請將 取代your-endpoint為您資源的端點。
setx LANGUAGE_KEY your-key
setx LANGUAGE_ENDPOINT your-endpoint
注意
如果您只需要存取目前執行控制台中的環境變數，您可以使用 來設定環境變數 set ，而不是 setx。
新增環境變數之後，您可能需要重新啟動任何需要讀取環境變數的執行中程式，包括主控台視窗。 例如，如果您使用 Visual Studio 作為編輯器，請在執行範例之前重新啟動 Visual Studio。
安裝客戶端連結庫
安裝 Python 之後，您可以使用下列項目來安裝用戶端連結庫：
pip install azure-ai-textanalytics==5.2.0
程式碼範例
建立新的 Python 檔案，並複製下列程式代碼。 然後執行程式碼。
重要
前往 Azure 入口網站。 如果您在成功部署必要條件一節中建立的語言資源，請按兩下 [後續步驟] 底下的 [移至資源] 按鈕。 您可以在 [資源管理] 底下瀏覽至資源的 [金鑰和端點] 頁面，以尋找您的金鑰和端點。
重要
完成時，請記得從程式碼中移除金鑰，且不要公開張貼金鑰。 在生產環境中，請使用安全的方式來儲存和存取您的認證，例如 Azure Key Vault。 如需詳細資訊，請參閱 Azure AI 服務安全性一文。
# This example requires environment variables named "LANGUAGE_KEY" and "LANGUAGE_ENDPOINT"
key = os.environ.get('LANGUAGE_KEY')
endpoint = os.environ.get('LANGUAGE_ENDPOINT')
from azure.ai.textanalytics import TextAnalyticsClient
from azure.core.credentials import AzureKeyCredential
# Authenticate the client using your key and endpoint
def authenticate_client():
ta_credential = AzureKeyCredential(key)
text_analytics_client = TextAnalyticsClient(
endpoint=endpoint,
credential=ta_credential)
return text_analytics_client
client = authenticate_client()
# Example function for extracting information from healthcare-related text
def health_example(client):
documents = [
"""
Patient needs to take 50 mg of ibuprofen.
"""
]
poller = client.begin_analyze_healthcare_entities(documents)
result = poller.result()
docs = [doc for doc in result if not doc.is_error]
for idx, doc in enumerate(docs):
for entity in doc.entities:
print("Entity: {}".format(entity.text))
print("...Normalized Text: {}".format(entity.normalized_text))
print("...Category: {}".format(entity.category))
print("...Subcategory: {}".format(entity.subcategory))
print("...Offset: {}".format(entity.offset))
print("...Confidence score: {}".format(entity.confidence_score))
for relation in doc.entity_relations:
print("Relation of type: {} has the following roles".format(relation.relation_type))
for role in relation.roles:
print("...Role '{}' with entity '{}'".format(role.name, role.entity.text))
print("------------------------------------------")
health_example(client)
輸出
Entity: 50 mg
...Normalized Text: None
...Category: Dosage
...Subcategory: None
...Offset: 31
...Confidence score: 1.0
Entity: ibuprofen
...Normalized Text: ibuprofen
...Category: MedicationName
...Subcategory: None
...Offset: 40
...Confidence score: 1.0
Relation of type: DosageOfMedication has the following roles
...Role 'Dosage' with entity '50 mg'
...Role 'Medication' with entity 'ibuprofen'
提示
快速醫療保健互操作性資源 （FHIR） 建構可使用語言 REST API 進行預覽。 目前不支援客戶端連結庫。 深入瞭解 如何在 API 呼叫中使用 FHIR 結構。
使用此快速入門，使用 REST API 傳送語言偵測要求。 在下列範例中，您將使用 cURL 來識別出現在文字中的醫療 實體、 關聯和 判斷 提示。
必要條件
- cURL 目前的版本
- Azure 訂用帳戶 - 建立免費帳戶
- 擁有 Azure 訂用帳戶之後，請在 Azure 入口網站 中建立語言資源，以取得您的密鑰和端點。 在其部署後，選取 [前往資源]。
- 您需要從您建立的資源取得密鑰和端點，才能將應用程式連線到 API。 您稍後會在快速入門中將金鑰和端點貼到下列程式代碼中。
- 您可以使用免費定價層
Free F0() 來試用服務 (提供 5000 筆文字記錄 - 每筆 1000 個字元)，並在稍後升級至生產環境的Standard S定價層。 您也可以從Standard S定價層開始，在收費之前免費接收相同的初始配額 (5000 筆文字記錄)。 如需定價的詳細資訊，請瀏覽語言服務定價。
注意
- 下列BASH範例使用
\行接續字元。 如果您的主控台或終端機使用不同的行接續字元，請使用該字元。 - 您可以在 GitHub 上找到語言特定範例。
- 移至 Azure 入口網站，並尋找您在必要條件中建立之語言資源的密鑰和端點。 它們會位於資源管理的 [金鑰和端點] 頁面上。 然後將下列程式代碼中的字串取代為您的金鑰和端點。 若要呼叫 API，您需要下列資訊：
設定
建立環境變數
您的應用程式必須經過驗證，才能傳送 API 要求。 針對生產環境，請使用安全的方式來儲存和存取您的認證。 在此範例中，您會將認證寫入執行應用程式的本機計算機上環境變數。
提示
請勿將金鑰直接包含在您的程式代碼中，且絕不會公開發佈。 如需更多驗證選項 (例如 Azure Key Vault)，請參閱 Azure AI 服務安全性文章。
若要設定語言資源密鑰的環境變數，請開啟控制台視窗，並遵循作業系統和開發環境的指示。
- 若要設定
LANGUAGE_KEY環境變數，請將 取代your-key為您資源的其中一個密鑰。 - 若要設定
LANGUAGE_ENDPOINT環境變數，請將 取代your-endpoint為您資源的端點。
setx LANGUAGE_KEY your-key
setx LANGUAGE_ENDPOINT your-endpoint
注意
如果您只需要存取目前執行控制台中的環境變數，您可以使用 來設定環境變數 set ，而不是 setx。
新增環境變數之後，您可能需要重新啟動任何需要讀取環境變數的執行中程式，包括主控台視窗。 例如，如果您使用 Visual Studio 作為編輯器，請在執行範例之前重新啟動 Visual Studio。
| parameter | 描述 |
|---|---|
-X POST <endpoint> |
指定用於存取 API 的端點。 |
-H Content-Type: application/json |
傳送 JSON 資料的內容類型。 |
-H "Ocp-Apim-Subscription-Key:<key> |
指定用來存取 API 的金鑰。 |
-d <documents> |
包含您要傳送之檔的 JSON。 |
下列 cURL 命令是從 BASH 殼層執行。 使用您自己的資源名稱、資源索引鍵和 JSON 值來編輯這些命令。
健康情況的文字分析
- 將命令複製到文字編輯器中。
- 視需要在命令中進行下列變更：
- 以您的索引鍵取代 值
<your-language-resource-key>。 - 將要求URL
<your-language-resource-endpoint>的第一個部分取代為您的端點URL。
- 以您的索引鍵取代 值
- 開啟 [命令提示字元] 視窗。
- 將命令從文字編輯器貼到命令提示字元視窗中，然後執行命令。
curl -i -X POST $LANGUAGE_ENDPOINT/language/analyze-text/jobs?api-version=2022-05-15-preview \
-H "Content-Type: application/json" \
-H "Ocp-Apim-Subscription-Key: $LANGUAGE_KEY" \
-d '{"analysisInput":{"documents": [{"text": "The doctor prescried 200mg Ibuprofen.","language": "en","id": "1"}]},"tasks":[{"taskId": "analyze 1","kind": "Healthcare","parameters": {"fhirVersion": "4.0.1"}}]}'
operation-location從回應標頭取得 。 數值會如以下 URL 所示：
https://your-resource.cognitiveservices.azure.com/language/analyze-text/jobs/{JOB-ID}?api-version=2022-05-15-preview
若要取得要求的結果，請使用下列 cURL 命令。 請務必將 取代 {JOB-ID} 為您從上 operation-location 一個回應標頭收到的數值識別碼值：
curl -X GET $LANGUAGE_ENDPOINT/language/analyze-text/jobs/{JOB-ID}?api-version=2022-05-15-preview \
-H "Content-Type: application/json" \
-H "Ocp-Apim-Subscription-Key: $LANGUAGE_KEY"
JSON 回應
{
"jobId": "{JOB-ID}",
"lastUpdatedDateTime": "2022-06-27T22:04:39Z",
"createdDateTime": "2022-06-27T22:04:38Z",
"expirationDateTime": "2022-06-28T22:04:38Z",
"status": "succeeded",
"errors": [],
"tasks": {
"completed": 1,
"failed": 0,
"inProgress": 0,
"total": 1,
"items": [
{
"kind": "HealthcareLROResults",
"lastUpdateDateTime": "2022-06-27T22:04:39.7086762Z",
"status": "succeeded",
"results": {
"documents": [
{
"id": "1",
"entities": [
{
"offset": 4,
"length": 6,
"text": "doctor",
"category": "HealthcareProfession",
"confidenceScore": 0.76
},
{
"offset": 21,
"length": 5,
"text": "200mg",
"category": "Dosage",
"confidenceScore": 0.99
},
{
"offset": 27,
"length": 9,
"text": "Ibuprofen",
"category": "MedicationName",
"confidenceScore": 1.0,
"name": "ibuprofen",
"links": [
{
"dataSource": "UMLS",
"id": "C0020740"
},
{
"dataSource": "AOD",
"id": "0000019879"
},
{
"dataSource": "ATC",
"id": "M01AE01"
},
{
"dataSource": "CCPSS",
"id": "0046165"
},
{
"dataSource": "CHV",
"id": "0000006519"
},
{
"dataSource": "CSP",
"id": "2270-2077"
},
{
"dataSource": "DRUGBANK",
"id": "DB01050"
},
{
"dataSource": "GS",
"id": "1611"
},
{
"dataSource": "LCH_NW",
"id": "sh97005926"
},
{
"dataSource": "LNC",
"id": "LP16165-0"
},
{
"dataSource": "MEDCIN",
"id": "40458"
},
{
"dataSource": "MMSL",
"id": "d00015"
},
{
"dataSource": "MSH",
"id": "D007052"
},
{
"dataSource": "MTHSPL",
"id": "WK2XYI10QM"
},
{
"dataSource": "NCI",
"id": "C561"
},
{
"dataSource": "NCI_CTRP",
"id": "C561"
},
{
"dataSource": "NCI_DCP",
"id": "00803"
},
{
"dataSource": "NCI_DTP",
"id": "NSC0256857"
},
{
"dataSource": "NCI_FDA",
"id": "WK2XYI10QM"
},
{
"dataSource": "NCI_NCI-GLOSS",
"id": "CDR0000613511"
},
{
"dataSource": "NDDF",
"id": "002377"
},
{
"dataSource": "PDQ",
"id": "CDR0000040475"
},
{
"dataSource": "RCD",
"id": "x02MO"
},
{
"dataSource": "RXNORM",
"id": "5640"
},
{
"dataSource": "SNM",
"id": "E-7772"
},
{
"dataSource": "SNMI",
"id": "C-603C0"
},
{
"dataSource": "SNOMEDCT_US",
"id": "387207008"
},
{
"dataSource": "USP",
"id": "m39860"
},
{
"dataSource": "USPMG",
"id": "MTHU000060"
},
{
"dataSource": "VANDF",
"id": "4017840"
}
]
}
],
"relations": [
{
"relationType": "DosageOfMedication",
"entities": [
{
"ref": "#/results/documents/0/entities/1",
"role": "Dosage"
},
{
"ref": "#/results/documents/0/entities/2",
"role": "Medication"
}
]
}
],
"warnings": [],
"fhirBundle": {
"resourceType": "Bundle",
"id": "95d61191-402a-48c6-9657-a1e4efbda877",
"meta": {
"profile": [
"http://hl7.org/fhir/4.0.1/StructureDefinition/Bundle"
]
},
"identifier": {
"system": "urn:ietf:rfc:3986",
"value": "urn:uuid:95d61191-402a-48c6-9657-a1e4efbda877"
},
"type": "document",
"entry": [
{
"fullUrl": "Composition/34b666d3-45e7-474d-a398-d3b0329541ad",
"resource": {
"resourceType": "Composition",
"id": "34b666d3-45e7-474d-a398-d3b0329541ad",
"status": "final",
"type": {
"coding": [
{
"system": "http://loinc.org",
"code": "11526-1",
"display": "Pathology study"
}
],
"text": "Pathology study"
},
"subject": {
"reference": "Patient/68dd21ce-58ae-4e59-9445-8331f99899ed",
"type": "Patient"
},
"encounter": {
"reference": "Encounter/90c75fea-4526-4e94-82f8-8df3bc983a14",
"type": "Encounter",
"display": "unknown"
},
"date": "2022-06-27",
"author": [
{
"reference": "Practitioner/a8ef1526-d4ce-41df-96df-e9d03428c840",
"type": "Practitioner",
"display": "Unknown"
}
],
"title": "Pathology study",
"section": [
{
"title": "General",
"code": {
"coding": [
{
"system": "",
"display": "Unrecognized Section"
}
],
"text": "General"
},
"text": {
"div": "<div>\r\n\t\t\t\t\t\t\t<h1>General</h1>\r\n\t\t\t\t\t\t\t<p>The doctor prescried 200mg Ibuprofen.</p>\r\n\t\t\t\t\t</div>"
},
"entry": [
{
"reference": "List/c8ca6757-1d7c-4c49-94e9-ef5263cb943c",
"type": "List",
"display": "General"
}
]
}
]
}
},
{
"fullUrl": "Practitioner/a8ef1526-d4ce-41df-96df-e9d03428c840",
"resource": {
"resourceType": "Practitioner",
"id": "a8ef1526-d4ce-41df-96df-e9d03428c840",
"extension": [
{
"extension": [
{
"url": "offset",
"valueInteger": -1
},
{
"url": "length",
"valueInteger": 7
}
],
"url": "http://hl7.org/fhir/StructureDefinition/derivation-reference"
}
],
"name": [
{
"text": "Unknown",
"family": "Unknown"
}
]
}
},
{
"fullUrl": "Patient/68dd21ce-58ae-4e59-9445-8331f99899ed",
"resource": {
"resourceType": "Patient",
"id": "68dd21ce-58ae-4e59-9445-8331f99899ed",
"gender": "unknown"
}
},
{
"fullUrl": "Encounter/90c75fea-4526-4e94-82f8-8df3bc983a14",
"resource": {
"resourceType": "Encounter",
"id": "90c75fea-4526-4e94-82f8-8df3bc983a14",
"meta": {
"profile": [
"http://hl7.org/fhir/us/core/StructureDefinition/us-core-encounter"
]
},
"status": "finished",
"class": {
"system": "http://terminology.hl7.org/CodeSystem/v3-ActCode",
"display": "unknown"
},
"subject": {
"reference": "Patient/68dd21ce-58ae-4e59-9445-8331f99899ed",
"type": "Patient"
}
}
},
{
"fullUrl": "MedicationStatement/17aeee32-1189-47fc-9223-8abe174f1292",
"resource": {
"resourceType": "MedicationStatement",
"id": "17aeee32-1189-47fc-9223-8abe174f1292",
"extension": [
{
"extension": [
{
"url": "offset",
"valueInteger": 27
},
{
"url": "length",
"valueInteger": 9
}
],
"url": "http://hl7.org/fhir/StructureDefinition/derivation-reference"
}
],
"status": "active",
"medicationCodeableConcept": {
"coding": [
{
"system": "http://www.nlm.nih.gov/research/umls",
"code": "C0020740",
"display": "ibuprofen"
},
{
"system": "http://www.nlm.nih.gov/research/umls/aod",
"code": "0000019879"
},
{
"system": "http://www.whocc.no/atc",
"code": "M01AE01"
},
{
"system": "http://www.nlm.nih.gov/research/umls/ccpss",
"code": "0046165"
},
{
"system": "http://www.nlm.nih.gov/research/umls/chv",
"code": "0000006519"
},
{
"system": "http://www.nlm.nih.gov/research/umls/csp",
"code": "2270-2077"
},
{
"system": "http://www.nlm.nih.gov/research/umls/drugbank",
"code": "DB01050"
},
{
"system": "http://www.nlm.nih.gov/research/umls/gs",
"code": "1611"
},
{
"system": "http://www.nlm.nih.gov/research/umls/lch_nw",
"code": "sh97005926"
},
{
"system": "http://loinc.org",
"code": "LP16165-0"
},
{
"system": "http://www.nlm.nih.gov/research/umls/medcin",
"code": "40458"
},
{
"system": "http://www.nlm.nih.gov/research/umls/mmsl",
"code": "d00015"
},
{
"system": "http://www.nlm.nih.gov/research/umls/msh",
"code": "D007052"
},
{
"system": "http://www.nlm.nih.gov/research/umls/mthspl",
"code": "WK2XYI10QM"
},
{
"system": "http://ncimeta.nci.nih.gov",
"code": "C561"
},
{
"system": "http://www.nlm.nih.gov/research/umls/nci_ctrp",
"code": "C561"
},
{
"system": "http://www.nlm.nih.gov/research/umls/nci_dcp",
"code": "00803"
},
{
"system": "http://www.nlm.nih.gov/research/umls/nci_dtp",
"code": "NSC0256857"
},
{
"system": "http://www.nlm.nih.gov/research/umls/nci_fda",
"code": "WK2XYI10QM"
},
{
"system": "http://www.nlm.nih.gov/research/umls/nci_nci-gloss",
"code": "CDR0000613511"
},
{
"system": "http://www.nlm.nih.gov/research/umls/nddf",
"code": "002377"
},
{
"system": "http://www.nlm.nih.gov/research/umls/pdq",
"code": "CDR0000040475"
},
{
"system": "http://www.nlm.nih.gov/research/umls/rcd",
"code": "x02MO"
},
{
"system": "http://www.nlm.nih.gov/research/umls/rxnorm",
"code": "5640"
},
{
"system": "http://snomed.info/sct",
"code": "E-7772"
},
{
"system": "http://snomed.info/sct/900000000000207008",
"code": "C-603C0"
},
{
"system": "http://snomed.info/sct/731000124108",
"code": "387207008"
},
{
"system": "http://www.nlm.nih.gov/research/umls/usp",
"code": "m39860"
},
{
"system": "http://www.nlm.nih.gov/research/umls/uspmg",
"code": "MTHU000060"
},
{
"system": "http://hl7.org/fhir/ndfrt",
"code": "4017840"
}
],
"text": "Ibuprofen"
},
"subject": {
"reference": "Patient/68dd21ce-58ae-4e59-9445-8331f99899ed",
"type": "Patient"
},
"context": {
"reference": "Encounter/90c75fea-4526-4e94-82f8-8df3bc983a14",
"type": "Encounter",
"display": "unknown"
},
"dosage": [
{
"text": "200mg",
"doseAndRate": [
{
"doseQuantity": {
"value": 200
}
}
]
}
]
}
},
{
"fullUrl": "List/c8ca6757-1d7c-4c49-94e9-ef5263cb943c",
"resource": {
"resourceType": "List",
"id": "c8ca6757-1d7c-4c49-94e9-ef5263cb943c",
"status": "current",
"mode": "snapshot",
"title": "General",
"subject": {
"reference": "Patient/68dd21ce-58ae-4e59-9445-8331f99899ed",
"type": "Patient"
},
"encounter": {
"reference": "Encounter/90c75fea-4526-4e94-82f8-8df3bc983a14",
"type": "Encounter",
"display": "unknown"
},
"entry": [
{
"item": {
"reference": "MedicationStatement/17aeee32-1189-47fc-9223-8abe174f1292",
"type": "MedicationStatement",
"display": "Ibuprofen"
}
}
]
}
}
]
}
}
],
"errors": [],
"modelVersion": "2022-03-01"
}
}
]
}
}
提示
快速醫療保健互操作性資源 （FHIR） 建構可使用語言 REST API 進行預覽。 目前不支援客戶端連結庫。 深入瞭解 如何在 API 呼叫中使用 FHIR 結構。
清除資源
如果您想要清除和移除 Azure AI 服務訂用帳戶，則可以刪除資源或資源群組。 刪除資源群組也會刪除與其相關聯的任何其他資源。