You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: sdk/healthinsights/Azure.Health.Insights.CancerProfiling/README.md
+20-30Lines changed: 20 additions & 30 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -1,10 +1,11 @@
1
1
# Azure Cognitive Services Health Insights Cancer Profiling client library for .NET
2
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 [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.
[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.
8
9
9
10
## Getting started
10
11
@@ -25,13 +26,11 @@ This table shows the relationship between SDK versions and supported API version
25
26
26
27
|SDK version|Supported API version of service |
27
28
|-------------|---------------|
28
-
|1.0.0b1| 2023-03-01-preview|
29
+
|1.0.0-beta.1| 2023-03-01-preview|
29
30
30
31
### Authenticate the client
31
32
32
-
You can find the endpoint for your Health Insights service resource using the
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
-
67
60
## Key concepts
68
61
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.
69
62
70
63
## Examples
71
64
72
-
-[Infer Cancer Profiling](#cancer-profiling)
65
+
-[Infer Cancer Profiling][samples_location]
73
66
74
67
### Cancer Profiling
75
68
@@ -140,14 +133,9 @@ To learn more about other logging mechanisms see [Diagnostics Samples][logging].
140
133
141
134
## Next steps
142
135
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
144
137
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.
151
139
152
140
## Contributing
153
141
@@ -158,18 +146,20 @@ When you submit a pull request, a CLA-bot will automatically determine whether y
158
146
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.
Copy file name to clipboardExpand all lines: sdk/healthinsights/Azure.Health.Insights.CancerProfiling/samples/README.md
-2Lines changed: 0 additions & 2 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -19,8 +19,6 @@ These code samples show common scenario operations with the Azure Health Insight
19
19
|[Sample01_InferCancerProfileAsync][sample_get_the_inferred_cancer_staging_for_an_oncology_patient_async]|Get the inferred cancer staging for an oncology patient (Async).|
Copy file name to clipboardExpand all lines: sdk/healthinsights/Azure.Health.Insights.CancerProfiling/samples/Sample01_InferCancerProfile.md
+4Lines changed: 4 additions & 0 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -1,6 +1,8 @@
1
1
# Get the inferred cancer staging for an oncology patient
2
2
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.
3
3
4
+
To get started, make sure you have satisfied all the prerequisites and got all the resources required by [README][README].
5
+
4
6
## Creating a `CancerProfilingClient`
5
7
6
8
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.
Copy file name to clipboardExpand all lines: sdk/healthinsights/Azure.Health.Insights.CancerProfiling/samples/Sample01_InferCancerProfileAsync.md
+6Lines changed: 6 additions & 0 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -1,6 +1,8 @@
1
1
# Get the inferred cancer staging for an oncology patient
2
2
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.
3
3
4
+
To get started, make sure you have satisfied all the prerequisites and got all the resources required by [README][README].
5
+
4
6
## Creating a `CancerProfilingClient`
5
7
6
8
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.
Source files in this directory are written as tests from which samples are extracted.
2
2
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.
Copy file name to clipboardExpand all lines: sdk/healthinsights/Azure.Health.Insights.ClinicalMatching/README.md
+19-27Lines changed: 19 additions & 27 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -1,10 +1,11 @@
1
1
# 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. -->
5
2
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.
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
-
67
60
## Key concepts
68
61
Trial Matcher provides the user of the services two main modes of operation: patients centric and clinical trial centric.
69
62
@@ -72,7 +65,7 @@ Trial Matcher provides the user of the services two main modes of operation: pat
72
65
73
66
## Examples
74
67
75
-
-[Match Trials](#match-trials)
68
+
-[Match Trials][samples_location]
76
69
77
70
### Match Trials
78
71
@@ -133,14 +126,9 @@ To learn more about other logging mechanisms see [Diagnostics Samples][logging].
133
126
134
127
## Next steps
135
128
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
140
130
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.
144
132
145
133
## Contributing
146
134
@@ -151,9 +139,7 @@ When you submit a pull request, a CLA-bot will automatically determine whether y
151
139
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.
Copy file name to clipboardExpand all lines: sdk/healthinsights/Azure.Health.Insights.ClinicalMatching/samples/README.md
+2-2Lines changed: 2 additions & 2 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -17,7 +17,7 @@ These code samples show common scenario operations with the Azure Health Insight
17
17
|----------------|-------------|
18
18
|[Sample01_MatchTrials][sample_get_all_matching_clinical_trials_for_a_specific_patient]|Get all matching clinical trials for a specific patient. (sync)|
19
19
|[Sample01_MatchTrialsAsync][sample_get_all_matching_clinical_trials_for_a_specific_patient_async]|Get all matching clinical trials for a specific patient. (async)|
0 commit comments