Skip to content

Commit af5cba5

Browse files
authored
update readme and samples (Azure#35198)
* update readme and samples * set changelog date * Prepare-Release * fix SDK Version format
1 parent e0e86be commit af5cba5

File tree

14 files changed

+69
-81
lines changed

14 files changed

+69
-81
lines changed
Lines changed: 1 addition & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -1,12 +1,7 @@
11
# Release History
22

3-
## 1.0.0-beta.1 (Unreleased)
3+
## 1.0.0-beta.1 (2023-04-11)
44

55
### Features Added
66
- Initial preview of the Azure.Health.Insights.CancerProfiling client library.
77

8-
### Breaking Changes
9-
10-
### Bugs Fixed
11-
12-
### Other Changes

sdk/healthinsights/Azure.Health.Insights.CancerProfiling/README.md

Lines changed: 20 additions & 30 deletions
Original file line numberDiff line numberDiff line change
@@ -1,10 +1,11 @@
11
# Azure Cognitive Services Health Insights Cancer Profiling client library for .NET
22

3-
<!-- [Health Insights](https://review.learn.microsoft.com/en-us/azure/cognitive-services/health-decision-support/overview?branch=main) is an Azure Applied AI Service built with the Azure Cognitive Services Framework, that leverages multiple Cognitive Services, Healthcare API services and other Azure resources.
4-
The [Cancer Profiling model](https://review.learn.microsoft.com/en-us/azure/cognitive-services/health-decision-support/oncophenotype/overview?branch=main) receives clinical records of oncology patients and outputs cancer staging, such as clinical stage TNM categories and pathologic stage TNM categories as well as tumor site, histology. -->
3+
[Health Insights](https://review.learn.microsoft.com/azure/azure-health-insights/?branch=release-azure-health-insights) is an Azure Applied AI Service built with the Azure Cognitive Services Framework, that leverages multiple Cognitive Services, Healthcare API services and other Azure resources.
4+
5+
The [Cancer Profiling model][cancer_profiling_docs] receives clinical records of oncology patients and outputs cancer staging, such as clinical stage TNM categories and pathologic stage TNM categories as well as tumor site, histology.
6+
7+
[Source code][cancer_profiling_client_src] | [Package (NuGet)][cancer_profiling_client_nuget_package] | [API reference documentation][cancer_profiling_api_documentation] | [Product documentation][product_docs]
58

6-
[Health Insights] is an Azure Applied AI Service built with the Azure Cognitive Services Framework, that leverages multiple Cognitive Services, Healthcare API services and other Azure resources.
7-
The [Cancer Profiling model] receives clinical records of oncology patients and outputs cancer staging, such as clinical stage TNM categories and pathologic stage TNM categories as well as tumor site, histology.
89

910
## Getting started
1011

@@ -25,13 +26,11 @@ This table shows the relationship between SDK versions and supported API version
2526

2627
|SDK version|Supported API version of service |
2728
|-------------|---------------|
28-
|1.0.0b1 | 2023-03-01-preview|
29+
|1.0.0-beta.1 | 2023-03-01-preview|
2930

3031
### Authenticate the client
3132

32-
You can find the endpoint for your Health Insights service resource using the
33-
[Azure Portal](https://ms.portal.azure.com/#create/Microsoft.CognitiveServicesHealthInsights)
34-
or [Azure CLI](https://learn.microsoft.com/cli/azure/):
33+
You can find the endpoint for your Health Insights service resource using the [Azure Portal][azure_portal] or [Azure CLI][azure_cli]
3534

3635
```bash
3736
# Get the endpoint for the Health Insights service resource
@@ -58,18 +57,12 @@ var credential = new AzureKeyCredential(apiKey);
5857
var client = new CancerProfilingClient(new Uri(endpoint), credential);
5958
```
6059

61-
### Long-Running Operations
62-
63-
For large documents which take a long time to execute, these operations are implemented as [**long-running operations**][dotnet_lro]. Long-running operations consist of an initial request sent to the service to start an operation, followed by polling the service at intervals to determine whether the operation has completed or failed, and if it has succeeded, to get the result.
64-
65-
For long running operations in the Azure SDK, the client exposes a `Start<operation-name>` method that returns an `Operation<T>` or a `PageableOperation<T>`. You can use the extension method `WaitForCompletionAsync()` to wait for the operation to complete and obtain its result. A sample code snippet is provided to illustrate using long-running operations [below](#run-multiple-actions-asynchronously).
66-
6760
## Key concepts
6861
The Cancer Profiling model allows you to infer cancer attributes such as tumor site, histology, clinical stage TNM categories and pathologic stage TNM categories from unstructured clinical documents.
6962

7063
## Examples
7164

72-
- [Infer Cancer Profiling](#cancer-profiling)
65+
- [Infer Cancer Profiling][samples_location]
7366

7467
### Cancer Profiling
7568

@@ -140,14 +133,9 @@ To learn more about other logging mechanisms see [Diagnostics Samples][logging].
140133

141134
## Next steps
142135

143-
<!-- These code samples show common scenario operations with the Azure health Insights Cancer Profiling library. More samples can be found under the [samples](https://github.com/Azure/azure-sdk-for-net/blob/main/sdk/healthinsights/Azure.Health.Insights.CancerProfiling/tests/Samples/) directory.
136+
## Additional documentation
144137

145-
- Infer Cancer Profile: [Sample_InferCancerProfile.cs](https://github.com/Azure/azure-sdk-for-net/blob/main/sdk/healthinsights/Azure.Health.Insights.CancerProfiling/tests/Samples/Sample_InferCancerProfile.cs) -->
146-
147-
148-
### Additional documentation
149-
150-
<!-- For more extensive documentation on Azure Health Insights Cancer Profiling, see the [Cancer Profiling documentation](https://review.learn.microsoft.com/en-us/azure/cognitive-services/health-decision-support/oncophenotype/overview?branch=main) on docs.microsoft.com. -->
138+
For more extensive documentation on Azure Health Insights Cancer Profiling, see the [Cancer Profiling documentation][cancer_profiling_docs] on docs.microsoft.com.
151139

152140
## Contributing
153141

@@ -158,18 +146,20 @@ When you submit a pull request, a CLA-bot will automatically determine whether y
158146
This project has adopted the [Microsoft Open Source Code of Conduct][code_of_conduct]. For more information see the [Code of Conduct FAQ][coc_faq] or contact [opencode@microsoft.com][coc_contact] with any additional questions or comments.
159147

160148
<!-- LINKS -->
161-
[cancer_profiling_client_class]:
162-
<!-- https://github.com/Azure/azure-sdk-for-net/tree/main/
163-
sdk/healthinsights/Azure.Health.Insights.CancerProfiling/src/Generated/CancerProfilingClient.cs -->
164-
165-
[DefaultAzureCredential]: https://github.com/Azure/azure-sdk-for-net/tree/main/sdk/identity/Azure.Identity/README.md
166-
[cognitive_resource_cli]: https://docs.microsoft.com/azure/cognitive-services/cognitive-services-apis-create-account-cli
149+
[cancer_profiling_client_src]: https://github.com/Azure/azure-sdk-for-net/tree/main/sdk/healthinsights/Azure.Health.Insights.CancerProfiling/src/
150+
[cancer_profiling_client_nuget_package]: https://www.nuget.org/packages/
151+
[cancer_profiling_api_documentation]: https://review.learn.microsoft.com/rest/api/cognitiveservices/healthinsights/onco-phenotype?branch=healthin202303
152+
[cancer_profiling_client_class]: https://github.com/Azure/azure-sdk-for-net/tree/main/sdk/healthinsights/Azure.Health.Insights.CancerProfiling/src/Generated/CancerProfilingClient.cs
153+
[samples_location]: https://github.com/Azure/azure-sdk-for-net/tree/main/sdk/healthinsights/Azure.Health.Insights.CancerProfiling/samples
167154
[logging]: https://github.com/Azure/azure-sdk-for-net/tree/main/sdk/core/Azure.Core/samples/Diagnostics.md
168155
[azure_cli]: https://docs.microsoft.com/cli/azure
169-
[azure_sub]: https://azure.microsoft.com/free/dotnet/
156+
[azure_sub
157+
]: https://azure.microsoft.com/free/dotnet/
170158
[nuget]: https://www.nuget.org/
171-
[azure_portal]: https://portal.azure.com
159+
[azure_portal]: https://ms.portal.azure.com/#create/Microsoft.CognitiveServicesHealthInsights
172160
[cla]: https://cla.microsoft.com
173161
[code_of_conduct]: https://opensource.microsoft.com/codeofconduct/
174162
[coc_faq]: https://opensource.microsoft.com/codeofconduct/faq/
175163
[coc_contact]: mailto:opencode@microsoft.com
164+
[cancer_profiling_docs]: https://review.learn.microsoft.com/azure/cognitive-services/health-decision-support/oncophenotype/overview?branch=main
165+
[product_docs]:https://review.learn.microsoft.com/azure/cognitive-services/health-decision-support/oncophenotype/?branch=main

sdk/healthinsights/Azure.Health.Insights.CancerProfiling/samples/README.md

Lines changed: 0 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -19,8 +19,6 @@ These code samples show common scenario operations with the Azure Health Insight
1919
|[Sample01_InferCancerProfileAsync][sample_get_the_inferred_cancer_staging_for_an_oncology_patient_async] |Get the inferred cancer staging for an oncology patient (Async).|
2020

2121

22-
<!-- LINKS
2322
[sample_get_the_inferred_cancer_staging_for_an_oncology_patient_async]: https://github.com/Azure/azure-sdk-for-net/tree/main/sdk/healthinsights/Azure.Health.Insights.CancerProfiling/samples/Sample01_InferCancerProfile.md
2423
[sample_get_the_inferred_cancer_staging_for_an_oncology_patient]: https://github.com/Azure/azure-sdk-for-net/tree/main/sdk/healthinsights/Azure.Health.Insights.CancerProfiling/samples/Sample01_InferCancerProfileAsync.md
25-
-->
2624

sdk/healthinsights/Azure.Health.Insights.CancerProfiling/samples/Sample01_InferCancerProfile.md

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,8 @@
11
# Get the inferred cancer staging for an oncology patient
22
This sample demonstrates how to get the inferred cancer staging, such as pTNM staging and histology codes, for an oncology patient, based on his/her clinical documents (medical records), and to review the clinical evidence for each inference, extracted from these documents.
33

4+
To get started, make sure you have satisfied all the prerequisites and got all the resources required by [README][README].
5+
46
## Creating a `CancerProfilingClient`
57

68
To create a new `CancerProfilingClient` to get the inferred cancer staging, you need a Cognitive Services endpoint and credentials. You can use the [DefaultAzureCredential][DefaultAzureCredential] to try a number of common authentication methods optimized for both running as a service and development. In the sample below, however, you'll use a AzureHealthInsights service API key credential by creating an `AzureKeyCredential` object, that if needed, will allow you to update the API key without creating a new client.
@@ -194,3 +196,5 @@ else
194196
}
195197
}
196198
```
199+
<!-- Links -->
200+
[README]:https://github.com/Azure/azure-sdk-for-net/blob/main/sdk/healthinsights/Azure.Health.Insights.CancerProfiling/README.md

sdk/healthinsights/Azure.Health.Insights.CancerProfiling/samples/Sample01_InferCancerProfileAsync.md

Lines changed: 6 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,8 @@
11
# Get the inferred cancer staging for an oncology patient
22
This sample demonstrates how to get the inferred cancer staging, such as pTNM staging and histology codes, for an oncology patient, based on his/her clinical documents (medical records), and to review the clinical evidence for each inference, extracted from these documents.
33

4+
To get started, make sure you have satisfied all the prerequisites and got all the resources required by [README][README].
5+
46
## Creating a `CancerProfilingClient`
57

68
To create a new `CancerProfilingClient` to get the inferred cancer staging, you need a Cognitive Services endpoint and credentials. You can use the [DefaultAzureCredential][DefaultAzureCredential] to try a number of common authentication methods optimized for both running as a service and development. In the sample below, however, you'll use a AzureHealthInsights service API key credential by creating an `AzureKeyCredential` object, that if needed, will allow you to update the API key without creating a new client.
@@ -194,3 +196,7 @@ else
194196
}
195197
}
196198
```
199+
200+
201+
<!-- Links -->
202+
[README]:https://github.com/Azure/azure-sdk-for-net/blob/main/sdk/healthinsights/Azure.Health.Insights.CancerProfiling/README.md

sdk/healthinsights/Azure.Health.Insights.CancerProfiling/src/Azure.Health.Insights.CancerProfiling.csproj

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
1-
<Project Sdk="Microsoft.NET.Sdk">
1+
<Project Sdk="Microsoft.NET.Sdk">
22
<PropertyGroup>
33
<Description>This is the Azure Health Insights CancerProfiling client library for developing .NET applications with rich experience.</Description>
44
<AssemblyTitle>Azure SDK Code Generation HealthInsights for Azure Data Plane</AssemblyTitle>
Lines changed: 2 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,4 @@
11
Source files in this directory are written as tests from which samples are extracted.
22
They are not intended to be viewed directly and help ensure our samples compile and work correctly.
3-
<!-- LINKS
4-
See our [list of samples](https://github.com/Azure/azure-sdk-for-net-pr/tree/main/sdk/healthinsights/Azure.Health.Insights.CancerProfiling/samples) for more explanation about how to use this client library.
5-
-->
3+
4+
See our [list of samples](https://github.com/Azure/azure-sdk-for-net/tree/main/sdk/healthinsights/Azure.Health.Insights.CancerProfiling/samples) for more explanation about how to use this client library.
Lines changed: 1 addition & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -1,12 +1,7 @@
11
# Release History
22

3-
## 1.0.0-beta.1 (Unreleased)
3+
## 1.0.0-beta.1 (2023-04-11)
44

55
### Features Added
66
- Initial preview of the Azure.Health.Insights.ClinicalMatching client library.
77

8-
### Breaking Changes
9-
10-
### Bugs Fixed
11-
12-
### Other Changes

sdk/healthinsights/Azure.Health.Insights.ClinicalMatching/README.md

Lines changed: 19 additions & 27 deletions
Original file line numberDiff line numberDiff line change
@@ -1,10 +1,11 @@
11
# Azure Cognitive Services Health Insights Clinical Matching client library for .NET
2-
<!--
3-
[Health Insights](https://review.learn.microsoft.com/en-us/azure/cognitive-services/health-decision-support/overview?branch=main) is an Azure Applied AI Service built with the Azure Cognitive Services Framework, that leverages multiple Cognitive Services, Healthcare API services and other Azure resources.
4-
The [Clinical Matching model](https://review.learn.microsoft.com/en-us/azure/cognitive-services/health-decision-support/trial-matcher/overview?branch=main) receives patients data and clinical trials protocols, and provides relevant clinical trials based on eligibility criteria. -->
52

6-
[Health Insights] is an Azure Applied AI Service built with the Azure Cognitive Services Framework, that leverages multiple Cognitive Services, Healthcare API services and other Azure resources.
7-
The [Clinical Matching model] receives patients data and clinical trials protocols, and provides relevant clinical trials based on eligibility criteria.
3+
[Health Insights](https://review.learn.microsoft.com/azure/cognitive-services/health-decision-support/overview?branch=main) is an Azure Applied AI Service built with the Azure Cognitive Services Framework, that leverages multiple Cognitive Services, Healthcare API services and other Azure resources.
4+
5+
The [Clinical Matching model][clinical_matching_docs] receives patients data and clinical trials protocols, and provides relevant clinical trials based on eligibility criteria.
6+
7+
[Source code][clinical_matching_client_src] | [Package (NuGet)][clinical_matching_client_nuget_package] | [API reference documentation][clinical_matching_api_documentation] | [Product documentation][product_docs]
8+
89

910
## Getting started
1011

@@ -25,13 +26,11 @@ This table shows the relationship between SDK versions and supported API version
2526

2627
|SDK version|Supported API version of service |
2728
|-------------|---------------|
28-
|1.0.0b1 | 2023-03-01-preview|
29+
|1.0.0-beta.1 | 2023-03-01-preview|
2930

3031
### Authenticate the client
3132

32-
You can find the endpoint for your Health Insights service resource using the
33-
[Azure Portal](https://ms.portal.azure.com/#create/Microsoft.CognitiveServicesHealthInsights)
34-
or [Azure CLI](https://learn.microsoft.com/cli/azure/):
33+
You can find the endpoint for your Health Insights service resource using the [Azure Portal][azure_portal] or [Azure CLI][azure_cli]
3534

3635
```bash
3736
# Get the endpoint for the Health Insights service resource
@@ -58,12 +57,6 @@ var credential = new AzureKeyCredential(apiKey);
5857
var client = new ClinicalMatchingClient(new Uri(endpoint), credential);
5958
```
6059

61-
### Long-Running Operations
62-
63-
For large documents which take a long time to execute, these operations are implemented as [**long-running operations**][dotnet_lro]. Long-running operations consist of an initial request sent to the service to start an operation, followed by polling the service at intervals to determine whether the operation has completed or failed, and if it has succeeded, to get the result.
64-
65-
For long running operations in the Azure SDK, the client exposes a `Start<operation-name>` method that returns an `Operation<T>` or a `PageableOperation<T>`. You can use the extension method `WaitForCompletionAsync()` to wait for the operation to complete and obtain its result. A sample code snippet is provided to illustrate using long-running operations [below](#run-multiple-actions-asynchronously).
66-
6760
## Key concepts
6861
Trial Matcher provides the user of the services two main modes of operation: patients centric and clinical trial centric.
6962

@@ -72,7 +65,7 @@ Trial Matcher provides the user of the services two main modes of operation: pat
7265

7366
## Examples
7467

75-
- [Match Trials](#match-trials)
68+
- [Match Trials][samples_location]
7669

7770
### Match Trials
7871

@@ -133,14 +126,9 @@ To learn more about other logging mechanisms see [Diagnostics Samples][logging].
133126

134127
## Next steps
135128

136-
<!-- These code samples show common scenario operations with the Azure health Insights Clinical Matching library. More samples can be found under the [samples](https://github.com/Azure/azure-sdk-for-net/blob/main/sdk/healthinsights/Azure.Health.Insights.ClinicalMatching/tests/Samples/) directory.
137-
138-
- Match Trials: [Sample_MatchTrials.cs](https://github.com/Azure/azure-sdk-for-net/blob/main/sdk/healthinsights/Azure.Health.Insights.ClinicalMatching/tests/Samples/Sample_MatchTrials.cs) -->
139-
129+
## Additional documentation
140130

141-
### Additional documentation
142-
143-
<!-- For more extensive documentation on Azure Health Insights Clinical Matching, see the [Clinical Matching documentation](https://review.learn.microsoft.com/en-us/azure/cognitive-services/health-decision-support/trial-matcher/?branch=main) on docs.microsoft.com. -->
131+
For more extensive documentation on Azure Health Insights Clinical Matching, see the [Clinical Matching documentation][clinical_matching_docs] on docs.microsoft.com.
144132

145133
## Contributing
146134

@@ -151,9 +139,7 @@ When you submit a pull request, a CLA-bot will automatically determine whether y
151139
This project has adopted the [Microsoft Open Source Code of Conduct][code_of_conduct]. For more information see the [Code of Conduct FAQ][coc_faq] or contact [opencode@microsoft.com][coc_contact] with any additional questions or comments.
152140

153141
<!-- LINKS -->
154-
[clinical_matching_client_class]:
155-
<!-- https://github.com/Azure/azure-sdk-for-net/tree/main/sdk/healthinsights/Azure.Health.Insights.ClinicalMatching/src/Generated/ClinicalMatchingClient.cs -->
156-
142+
[clinical_matching_client_class]: https://github.com/Azure/azure-sdk-for-net/tree/main/sdk/healthinsights/Azure.Health.Insights.ClinicalMatching/src/Generated/ClinicalMatchingClient.cs
157143
[DefaultAzureCredential]: https://github.com/Azure/azure-sdk-for-net/tree/main/sdk/identity/Azure.Identity/README.md
158144
[cognitive_resource_cli]: https://docs.microsoft.com/azure/cognitive-services/cognitive-services-apis-create-account-cli
159145
[logging]: https://github.com/Azure/azure-sdk-for-net/tree/main/sdk/core/Azure.Core/samples/Diagnostics.md
@@ -164,4 +150,10 @@ This project has adopted the [Microsoft Open Source Code of Conduct][code_of_con
164150
[cla]: https://cla.microsoft.com
165151
[code_of_conduct]: https://opensource.microsoft.com/codeofconduct/
166152
[coc_faq]: https://opensource.microsoft.com/codeofconduct/faq/
167-
[coc_contact]: mailto:opencode@microsoft.com -->
153+
[coc_contact]: mailto:opencode@microsoft.com
154+
[clinical_matching_docs]: https://review.learn.microsoft.com/azure/cognitive-services/health-decision-support/trial-matcher/overview?branch=main
155+
[clinical_matching_client_src]: https://github.com/Azure/azure-sdk-for-net/tree/main/sdk/healthinsights/Azure.Health.Insights.ClinicalMatching/src/
156+
[clinical_matching_client_nuget_package]: https://www.nuget.org/packages/
157+
[clinical_matching_api_documentation]: https://review.learn.microsoft.com/rest/api/cognitiveservices/healthinsights/trial-matcher?branch=healthin202303
158+
[product_docs]:https://review.learn.microsoft.com/azure/cognitive-services/health-decision-support/trial-matcher/?branch=main
159+
[samples_location]: https://github.com/Azure/azure-sdk-for-net/tree/main/sdk/healthinsights/Azure.Health.Insights.ClinicalMatching/samples

sdk/healthinsights/Azure.Health.Insights.ClinicalMatching/samples/README.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -17,7 +17,7 @@ These code samples show common scenario operations with the Azure Health Insight
1717
|----------------|-------------|
1818
|[Sample01_MatchTrials][sample_get_all_matching_clinical_trials_for_a_specific_patient] |Get all matching clinical trials for a specific patient. (sync)|
1919
|[Sample01_MatchTrialsAsync][sample_get_all_matching_clinical_trials_for_a_specific_patient_async] |Get all matching clinical trials for a specific patient. (async)|
20-
<!-- LINKS
20+
21+
<!-- LINKS -->
2122
[sample_get_all_matching_clinical_trials_for_a_specific_patient]: https://github.com/Azure/azure-sdk-for-net/tree/main/sdk/healthinsights/Azure.Health.Insights.ClinicalMatching/samples/Sample01_MatchTrials.md
2223
[sample_get_all_matching_clinical_trials_for_a_specific_patient_async]: https://github.com/Azure/azure-sdk-for-net/tree/main/sdk/healthinsights/Azure.Health.Insights.ClinicalMatching/samples/Sample01_MatchTrialsAsync.md
23-
-->

0 commit comments

Comments
 (0)