Skip to content

Commit 557fab8

Browse files
tamarakhadertamarakhader
authored
Merge pull request #202788 from aahill/lang-dev-guide
samples developer guide
2 parents e05113b + 01d8841 commit 557fab8

File tree

2 files changed

+188
-5
lines changed

2 files changed

+188
-5
lines changed

‎articles/cognitive-services/language-service/concepts/developer-guide.md

Lines changed: 165 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,165 @@
1+
---
2+
title: Use the Language SDK and REST API
3+
titleSuffix: Azure Cognitive Services
4+
description: Learn about how to integrate the Language service SDK and REST API into your applications.
5+
services: cognitive-services
6+
author: aahill
7+
manager: nitinme
8+
ms.service: cognitive-services
9+
ms.subservice: language-service
10+
ms.topic: conceptual
11+
ms.date: 06/30/2022
12+
ms.author: aahi
13+
---
14+
15+
# SDK and REST developer guide for the Language service
16+
17+
Use this article to find information on integrating the Language service SDKs and REST API into your applications.
18+
19+
## Development options
20+
21+
The Language service provides support through a REST API, and client libraries in several languages.
22+
23+
# [Client library (Azure SDK)](#tab/language-studio)
24+
25+
## Client libraries (Azure SDK)
26+
27+
The Language service provides three namespaces for using the available features. Depending on which features and programming language you're using, you will need to download one or more of the following packages.
28+
29+
### Azure.AI.TextAnalytics
30+
31+
>[!NOTE]
32+
> If you're using custom named entity recognition or custom text classification, you will need to create a project and train a model before using the SDK. The SDK only provides the ability to analyze text using models you create. See the following quickstarts for information on creating a model.
33+
> * [Custom named entity recognition](../custom-named-entity-recognition/quickstart.md)
34+
> * [Custom text classification](../custom-text-classification/quickstart.md)
35+
36+
The `Azure.AI.TextAnalytics` namespace enables you to use the following Language features. Use the links below for articles to help you send API requests using the SDK.
37+
38+
* [Custom named entity recognition](../custom-named-entity-recognition/how-to/call-api.md?tabs=client#send-an-entity-recognition-request-to-your-model)
39+
* [Custom text classification](../custom-text-classification/how-to/call-api.md?tabs=client-libraries#send-a-text-classification-request-to-your-model)
40+
* [Document summarization](../summarization/quickstart.md)
41+
* [Entity linking](../entity-linking/quickstart.md)
42+
* [Key phrase extraction](../key-phrase-extraction/quickstart.md)
43+
* [Named entity recognition (NER)](../named-entity-recognition/quickstart.md)
44+
* [Personally Identifying Information (PII) detection](../personally-identifiable-information/quickstart.md)
45+
* [Sentiment analysis and opinion mining](../sentiment-opinion-mining/quickstart.md)
46+
* [Text analytics for health](../text-analytics-for-health/quickstart.md)
47+
48+
As you use these features in your application, use the following documentation and code samples for additional information.
49+
50+
|Reference documentation |Samples |
51+
|---------|---------|
52+
| [C# documentation](/dotnet/api/azure.ai.textanalytics?view=azure-dotnet-preview&preserve-view=true) | [C# samples](https://github.com/Azure/azure-sdk-for-net/tree/master/sdk/textanalytics/Azure.AI.TextAnalytics/samples) |
53+
| [Java documentation](/java/api/overview/azure/ai-textanalytics-readme?view=azure-java-preview&preserve-view=true) | [Java Samples](https://github.com/Azure/azure-sdk-for-java/tree/main/sdk/textanalytics/azure-ai-textanalytics/src/samples) |
54+
| [JavaScript documentation](/javascript/api/overview/azure/ai-text-analytics-readme?view=azure-node-preview&preserve-view=true) | [JavaScript samples](https://github.com/Azure/azure-sdk-for-js/tree/main/sdk/textanalytics/ai-text-analytics/samples/v5) |
55+
[Python documentation](/python/api/overview/azure/ai-textanalytics-readme?view=azure-python-preview&preserve-view=true) | [Python samples](https://github.com/Azure/azure-sdk-for-python/tree/main/sdk/textanalytics/azure-ai-textanalytics/samples) |
56+
57+
58+
### Azure.AI.Language.Conversations
59+
60+
> [!NOTE]
61+
> If you're using conversational language understanding or orchestration workflow, you will need to create a project and train a model before using the SDK. The SDK only provides the ability to analyze text using models you create. See the following quickstarts for more information.
62+
> * [Conversational language understanding](../conversational-language-understanding/quickstart.md)
63+
> * [Orchestration workflow](../orchestration-workflow/quickstart.md)
64+
65+
The `Azure.AI.Language.Conversations` namespace enables you to use the following Language features. Use the links below for articles to help you send API requests using the SDK.
66+
67+
* [Conversational language understanding](../conversational-language-understanding/how-to/call-api.md?tabs=azure-sdk#send-a-conversational-language-understanding-request)
68+
* [Orchestration workflow](../orchestration-workflow/how-to/call-api.md?tabs=azure-sdk#send-an-orchestration-workflow-request)
69+
* [Conversation summarization (Python only)](../summarization/quickstart.md?tabs=conversation-summarization&pivots=programming-language-python)
70+
* [Personally Identifying Information (PII) detection for conversations](../personally-identifiable-information/how-to-call-for-conversations.md?tabs=client-libraries#examples)
71+
72+
As you use these features in your application, use the following documentation and code samples for additional information.
73+
74+
| Reference documentation |Samples |
75+
|---------|---------|
76+
| [C# documentation](/dotnet/api/overview/azure/ai.language.conversations-readme-pre) | [C# samples](https://aka.ms/sdk-sample-conversation-dot-net) |
77+
| [Python documentation](/python/api/overview/azure/ai-language-conversations-readme) | [Python samples](https://aka.ms/sdk-samples-conversation-python) |
78+
79+
### Azure.AI.Language.QuestionAnswering
80+
81+
The `Azure.AI.Language.QuestionAnswering` namespace enables you to use the following Language features:
82+
83+
* [Question answering](../question-answering/quickstart/sdk.md?pivots=programming-language-csharp)
84+
* Authoring - Automate common tasks like adding new question answer pairs and working with projects/knowledge bases.
85+
* Prediction - Answer questions based on passages of text.
86+
87+
As you use these features in your application, use the following documentation and code samples for additional information.
88+
89+
|Reference documentation |Samples |
90+
|---------|---------|
91+
| [C# documentation](/dotnet/api/overview/azure/ai.language.questionanswering-readme-pre) | [C# samples](https://github.com/Azure/azure-sdk-for-net/tree/main/sdk/cognitivelanguage/Azure.AI.Language.QuestionAnswering) |
92+
| [Python documentation](/python/api/overview/azure/ai-language-questionanswering-readme) | [Python samples](https://github.com/Azure/azure-sdk-for-python/tree/main/sdk/cognitivelanguage/azure-ai-language-questionanswering) |
93+
94+
95+
# [REST API](#tab/rest-api)
96+
97+
## REST API
98+
99+
The Language service provides multiple API endpoints depending on which feature you wish to use.
100+
101+
### Conversation analysis authoring API
102+
103+
The conversation analysis authoring API enables you to author custom models and create/manage projects for the following features.
104+
* [Conversational language understanding](../conversational-language-understanding/quickstart.md?pivots=rest-api)
105+
* [Orchestration workflow](../orchestration-workflow/quickstart.md?pivots=rest-api)
106+
107+
As you use this API in your application, see the [reference documentation](/rest/api/language/conversational-analysis-authoring) for additional information.
108+
109+
### Conversation analysis runtime API
110+
111+
The conversation analysis runtime API enables you to send requests to custom models you've created for:
112+
* [Conversational language understanding](../conversational-language-understanding/how-to/call-api.md?tabs=REST-APIs#send-a-conversational-language-understanding-request)
113+
* [Orchestration workflow](../orchestration-workflow/how-to/call-api.md?tabs=REST-APIs#send-an-orchestration-workflow-request)
114+
115+
It additionally enables you to use the following features, without creating any models:
116+
* [Conversation summarization](../summarization/quickstart.md?pivots=rest-api&tabs=conversation-summarization)
117+
* [Personally Identifiable Information (PII) detection for conversations](../personally-identifiable-information/how-to-call-for-conversations.md?tabs=rest-api#examples)
118+
119+
As you use this API in your application, see the [reference documentation](/rest/api/language/conversation-analysis-runtime) for additional information.
120+
121+
122+
### Text analysis authoring API
123+
124+
The text analysis authoring API enables you to author custom models and create/manage projects for:
125+
* [Custom named entity recognition](../custom-named-entity-recognition/quickstart.md?pivots=rest-api)
126+
* [Custom text classification](../custom-text-classification/quickstart.md?pivots=rest-api)
127+
128+
As you use this API in your application, see the [reference documentation](/rest/api/language/text-analysis-authoring) for additional information.
129+
130+
### Text analysis runtime API
131+
132+
The text analysis runtime API enables you to send requests to custom models you've created for:
133+
134+
* [Custom named entity recognition](../custom-named-entity-recognition/quickstart.md?pivots=rest-api)
135+
* [Custom text classification](../custom-text-classification/quickstart.md?pivots=rest-api)
136+
137+
It additionally enables you to use the following features, without creating any models:
138+
139+
* [Document summarization](../summarization/quickstart.md?tabs=document-summarization&pivots=rest-api)
140+
* [Entity linking](../entity-linking/quickstart.md?pivots=rest-api)
141+
* [Key phrase extraction](../key-phrase-extraction/quickstart.md?pivots=rest-api)
142+
* [Named entity recognition (NER)](../named-entity-recognition/quickstart.md?pivots=rest-api)
143+
* [Personally Identifying Information (PII) detection](../personally-identifiable-information/quickstart.md?pivots=rest-api)
144+
* [Sentiment analysis and opinion mining](../sentiment-opinion-mining/quickstart.md?pivots=rest-api)
145+
* [Text analytics for health](../text-analytics-for-health/quickstart.md?pivots=rest-api)
146+
147+
As you use this API in your application, see the [reference documentation](/rest/api/language/text-analysis-runtime) for additional information.
148+
149+
### Question answering APIs
150+
151+
The question answering APIs enables you to use the [question answering](../question-answering/quickstart/sdk.md?pivots=rest) feature.
152+
153+
#### Reference documentation
154+
155+
As you use this API in your application, see the following reference documentation for additional information.
156+
157+
* [Prebuilt API](/rest/api/cognitiveservices/questionanswering/question-answering/get-answers-from-text) - Use the prebuilt runtime API to answer specified question using text provided by users.
158+
* [Custom authoring API](/rest/api/cognitiveservices/questionanswering/question-answering-projects) - Create a knowledge base to answer questions.
159+
* [Custom runtime API](/rest/api/cognitiveservices/questionanswering/question-answering/get-answers) - Query and knowledge base to generate an answer.
160+
161+
---
162+
163+
## See also
164+
165+
[Azure Cognitive Service for Language overview](../overview.md)

‎articles/cognitive-services/language-service/toc.yml

Lines changed: 23 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -14,16 +14,34 @@ items:
1414
href: https://aka.ms/unifiedLanguagePricing
1515
- name: Language Studio quickstart
1616
href: language-studio.md
17-
- name: Samples
17+
- name: Samples
18+
items:
19+
- name: Developer overview
20+
href: concepts/developer-guide.md
21+
- name: C#
1822
items:
19-
- name: C#
23+
- name: Azure.AI.TextAnalytics namespace
2024
href: https://github.com/Azure/azure-sdk-for-net/tree/master/sdk/textanalytics/Azure.AI.TextAnalytics/samples
21-
- name: Java
25+
- name: Azure.AI.Language.Conversations namespace
26+
href: https://aka.ms/sdk-sample-conversation-dot-net
27+
- name: Azure.AI.Language.QuestionAnswering namespace
28+
href: https://github.com/Azure/azure-sdk-for-net/tree/main/sdk/cognitivelanguage/Azure.AI.Language.QuestionAnswering
29+
- name: Java
30+
items:
31+
- name: Azure.AI.TextAnalytics namespace
2232
href: https://github.com/Azure/azure-sdk-for-java/tree/main/sdk/textanalytics/azure-ai-textanalytics/src/samples
23-
- name: JavaScript
33+
- name: JavaScript
34+
items:
35+
- name: Azure.AI.TextAnalytics namespace
2436
href: https://github.com/Azure/azure-sdk-for-js/tree/main/sdk/textanalytics/ai-text-analytics/samples/v5
25-
- name: Python
37+
- name: Python
38+
items:
39+
- name: Azure.AI.TextAnalytics namespace
2640
href: https://github.com/Azure/azure-sdk-for-python/tree/main/sdk/textanalytics/azure-ai-textanalytics/samples
41+
- name: Azure.AI.Language.Conversations namespace
42+
href: https://aka.ms/sdk-samples-conversation-python
43+
- name: Azure.AI.Language.QuestionAnswering namespace
44+
href: https://github.com/Azure/azure-sdk-for-python/tree/main/sdk/cognitivelanguage/azure-ai-language-questionanswering
2745
- name: Responsible use of AI
2846
items:
2947
- name: Transparency note for Azure Cognitive Service for Language

0 commit comments

Comments
 (0)