diff --git a/sdk/documentintelligence/azure-ai-documentintelligence/README.md b/sdk/documentintelligence/azure-ai-documentintelligence/README.md index 4dba9a4f8c4b8..0677c116a5612 100644 --- a/sdk/documentintelligence/azure-ai-documentintelligence/README.md +++ b/sdk/documentintelligence/azure-ai-documentintelligence/README.md @@ -293,7 +293,7 @@ in the [service quickstart documentation][quickstart_training]. **Note** -You can use the [Document Intelligence Studio preview][fr-studio] for creating a labeled file for your training forms. +You can use the [Document Intelligence Studio preview][di-studio] for creating a labeled file for your training forms. More details on setting up a container and required file structure can be found in [here][fr_build_training_set]. ```java com.azure.ai.documentintelligence.readme.buildModel @@ -451,7 +451,6 @@ For details on contributing to this repository, see the [contributing guide](htt [azure_key_credential]: https://github.com/Azure/azure-sdk-for-java/blob/main/sdk/core/azure-core/src/main/java/com/azure/core/credential/AzureKeyCredential.java [key]: https://docs.microsoft.com/azure/cognitive-services/cognitive-services-apis-create-account?tabs=multiservice%2Cwindows#get-the-keys-for-your-resource [api_reference_doc]: https://learn.microsoft.com/java/api/overview/azure/ai-documentintelligence-readme?view=azure-java-preview -[form_recognizer_doc]: https://aka.ms/azsdk-java-documentintelligence-ref-doc [azure_identity_credential_type]: https://github.com/Azure/azure-sdk-for-java/tree/main/sdk/identity/azure-identity#credentials [azure_cli]: https://docs.microsoft.com/azure/cognitive-services/cognitive-services-apis-create-account-cli?tabs=windows [azure_cli_endpoint]: https://docs.microsoft.com/cli/azure/cognitiveservices/account?view=azure-cli-latest#az-cognitiveservices-account-show @@ -474,7 +473,7 @@ For details on contributing to this repository, see the [contributing guide](htt [performance_tuning]: https://github.com/Azure/azure-sdk-for-java/wiki/Performance-Tuning [product_documentation]: https://docs.microsoft.com/azure/cognitive-services/form-recognizer/overview [register_AAD_application]: https://docs.microsoft.com/azure/cognitive-services/authentication#assign-a-role-to-a-service-principal -[fr-studio]: https://aka.ms/azsdk/formrecognizer/documentintelligencestudio +[di-studio]: https://aka.ms/azsdk/formrecognizer/formrecognizerstudio [fr_build_training_set]: https://aka.ms/azsdk/formrecognizer/buildcustommodel [sample_examples]: https://github.com/Azure/azure-sdk-for-java/tree/main/sdk/documentintelligence/azure-ai-documentintelligence/src/samples#examples [samples_readme]: https://github.com/Azure/azure-sdk-for-java/tree/main/sdk/documentintelligence/azure-ai-documentintelligence/src/samples#readme diff --git a/sdk/documentintelligence/azure-ai-documentintelligence/src/samples/README.md b/sdk/documentintelligence/azure-ai-documentintelligence/src/samples/README.md index dc2adeeff58c2..c760cd38a10be 100644 --- a/sdk/documentintelligence/azure-ai-documentintelligence/src/samples/README.md +++ b/sdk/documentintelligence/azure-ai-documentintelligence/src/samples/README.md @@ -56,7 +56,7 @@ All of these samples need the endpoint to your Document Intelligence resource ([ Troubleshooting steps can be found [here][SDK_README_TROUBLESHOOTING]. ## Next steps -Check out the [API reference documentation][java_fr_ref_docs] to learn more about +Check out the [API reference documentation][api_reference_doc] to learn more about what you can do with the Azure Document Intelligence client library. ## Contributing @@ -70,7 +70,7 @@ Guidelines][SDK_README_CONTRIBUTING] for more information. [SDK_README_KEY_CONCEPTS]: https://github.com/Azure/azure-sdk-for-java/blob/main/sdk/documentintelligence/azure-ai-documentintelligence/README.md#key-concepts [SDK_README_DEPENDENCY]: ../../README.md#adding-the-package-to-your-product [SDK_README_NEXT_STEPS]: ../../README.md#next-steps -[java_fr_ref_docs]: https://aka.ms/azsdk-java-documentintelligence-ref-doc +[api_reference_doc]: https://learn.microsoft.com/java/api/overview/azure/ai-documentintelligence-readme?view=azure-java-preview [get-endpoint-instructions]: https://github.com/Azure/azure-sdk-for-java/tree/main/sdk/documentintelligence/azure-ai-documentintelligence# [get-key-instructions]: https://github.com/Azure/azure-sdk-for-java/tree/main/sdk/documentintelligence/azure-ai-documentintelligence#create-a-form-recognizer-client-using-azurekeycredential diff --git a/sdk/documentintelligence/azure-ai-documentintelligence/src/samples/java/com/azure/ai/documentintelligence/AnalyzeIdentityDocuments.java b/sdk/documentintelligence/azure-ai-documentintelligence/src/samples/java/com/azure/ai/documentintelligence/AnalyzeIdentityDocuments.java index 87beadb68e50c..dc214031e9cd2 100644 --- a/sdk/documentintelligence/azure-ai-documentintelligence/src/samples/java/com/azure/ai/documentintelligence/AnalyzeIdentityDocuments.java +++ b/sdk/documentintelligence/azure-ai-documentintelligence/src/samples/java/com/azure/ai/documentintelligence/AnalyzeIdentityDocuments.java @@ -20,7 +20,7 @@ /** * Sample for analyzing commonly found License document fields from a local file input stream. - * See fields found on an identity document here + * See fields found on an identity document here */ public class AnalyzeIdentityDocuments { diff --git a/sdk/documentintelligence/azure-ai-documentintelligence/src/samples/java/com/azure/ai/documentintelligence/AnalyzeIdentityDocumentsAsync.java b/sdk/documentintelligence/azure-ai-documentintelligence/src/samples/java/com/azure/ai/documentintelligence/AnalyzeIdentityDocumentsAsync.java index b9767477b7f25..332f66bd510aa 100644 --- a/sdk/documentintelligence/azure-ai-documentintelligence/src/samples/java/com/azure/ai/documentintelligence/AnalyzeIdentityDocumentsAsync.java +++ b/sdk/documentintelligence/azure-ai-documentintelligence/src/samples/java/com/azure/ai/documentintelligence/AnalyzeIdentityDocumentsAsync.java @@ -22,7 +22,7 @@ /** * Async sample for analyzing commonly found license fields from a local file input stream of a license identity - * document. See fields found on license here + * document. See fields found on license here */ public class AnalyzeIdentityDocumentsAsync { diff --git a/sdk/documentintelligence/azure-ai-documentintelligence/src/samples/java/com/azure/ai/documentintelligence/AnalyzeIdentityDocumentsFromUrl.java b/sdk/documentintelligence/azure-ai-documentintelligence/src/samples/java/com/azure/ai/documentintelligence/AnalyzeIdentityDocumentsFromUrl.java index 98d1e64f53870..6e3347fefdbea 100644 --- a/sdk/documentintelligence/azure-ai-documentintelligence/src/samples/java/com/azure/ai/documentintelligence/AnalyzeIdentityDocumentsFromUrl.java +++ b/sdk/documentintelligence/azure-ai-documentintelligence/src/samples/java/com/azure/ai/documentintelligence/AnalyzeIdentityDocumentsFromUrl.java @@ -18,7 +18,7 @@ /** * Sample for analyzing commonly found ID document fields from a file source URL of an identity document. - * See fields found on an identity document href + * See fields found on an identity document href */ public class AnalyzeIdentityDocumentsFromUrl { diff --git a/sdk/documentintelligence/azure-ai-documentintelligence/src/samples/java/com/azure/ai/documentintelligence/AnalyzeIdentityDocumentsFromUrlAsync.java b/sdk/documentintelligence/azure-ai-documentintelligence/src/samples/java/com/azure/ai/documentintelligence/AnalyzeIdentityDocumentsFromUrlAsync.java index 55870d17ad32b..6514355cdf298 100644 --- a/sdk/documentintelligence/azure-ai-documentintelligence/src/samples/java/com/azure/ai/documentintelligence/AnalyzeIdentityDocumentsFromUrlAsync.java +++ b/sdk/documentintelligence/azure-ai-documentintelligence/src/samples/java/com/azure/ai/documentintelligence/AnalyzeIdentityDocumentsFromUrlAsync.java @@ -19,7 +19,7 @@ /** * Async sample for analyzing commonly found identity document fields from a file source URL. - * See fields found on a license here + * See fields found on a license here */ public class AnalyzeIdentityDocumentsFromUrlAsync { diff --git a/sdk/documentintelligence/azure-ai-documentintelligence/src/samples/java/com/azure/ai/documentintelligence/AnalyzeInvoices.java b/sdk/documentintelligence/azure-ai-documentintelligence/src/samples/java/com/azure/ai/documentintelligence/AnalyzeInvoices.java index a948371a7a500..231e694946c94 100644 --- a/sdk/documentintelligence/azure-ai-documentintelligence/src/samples/java/com/azure/ai/documentintelligence/AnalyzeInvoices.java +++ b/sdk/documentintelligence/azure-ai-documentintelligence/src/samples/java/com/azure/ai/documentintelligence/AnalyzeInvoices.java @@ -21,7 +21,7 @@ /** * Sample for analyzing commonly found invoice fields from a local file input stream of an invoice document. - * See fields found on an invoice here + * See fields found on an invoice here */ public class AnalyzeInvoices { /** @@ -130,7 +130,7 @@ public static void main(final String[] args) throws IOException { .map(documentField -> documentField.getValueObject()) .forEach(documentFieldMap -> documentFieldMap.forEach((key, documentField) -> { // See a full list of fields found on an invoice here: - // https://aka.ms/documentintelligence/invoicefields + // https://aka.ms/formrecognizer/invoicefields if ("Description".equals(key)) { if (DocumentFieldType.STRING == documentField.getType()) { String name = documentField.getValueString(); diff --git a/sdk/documentintelligence/azure-ai-documentintelligence/src/samples/java/com/azure/ai/documentintelligence/AnalyzeInvoicesAsync.java b/sdk/documentintelligence/azure-ai-documentintelligence/src/samples/java/com/azure/ai/documentintelligence/AnalyzeInvoicesAsync.java index 200c831047cc3..d83b35208fe8e 100644 --- a/sdk/documentintelligence/azure-ai-documentintelligence/src/samples/java/com/azure/ai/documentintelligence/AnalyzeInvoicesAsync.java +++ b/sdk/documentintelligence/azure-ai-documentintelligence/src/samples/java/com/azure/ai/documentintelligence/AnalyzeInvoicesAsync.java @@ -23,7 +23,7 @@ /** * Async sample for analyzing commonly found invoice fields from a local file input stream of an invoice document. - * See fields found on an invoice here + * See fields found on an invoice here */ public class AnalyzeInvoicesAsync { @@ -145,7 +145,7 @@ public static void main(final String[] args) throws IOException { .map(DocumentField::getValueObject) .forEach(documentFieldMap -> documentFieldMap.forEach((key, documentField) -> { // See a full list of fields found on an invoice here: - // https://aka.ms/documentintelligence/invoicefields + // https://aka.ms/formrecognizer/invoicefields if ("Description".equals(key)) { if (DocumentFieldType.STRING == documentField.getType()) { String name = documentField.getValueString(); diff --git a/sdk/documentintelligence/azure-ai-documentintelligence/src/samples/java/com/azure/ai/documentintelligence/AnalyzeInvoicesFromUrl.java b/sdk/documentintelligence/azure-ai-documentintelligence/src/samples/java/com/azure/ai/documentintelligence/AnalyzeInvoicesFromUrl.java index 0324116ca57d4..f1dcf6692b719 100644 --- a/sdk/documentintelligence/azure-ai-documentintelligence/src/samples/java/com/azure/ai/documentintelligence/AnalyzeInvoicesFromUrl.java +++ b/sdk/documentintelligence/azure-ai-documentintelligence/src/samples/java/com/azure/ai/documentintelligence/AnalyzeInvoicesFromUrl.java @@ -19,7 +19,7 @@ /** * Sample for analyzing commonly found invoice fields from a file source URL of an invoice document. - * See fields found on an invoice here + * See fields found on an invoice here */ public class AnalyzeInvoicesFromUrl { @@ -129,7 +129,7 @@ public static void main(final String[] args) throws IOException { .map(documentField -> documentField.getValueObject()) .forEach(documentFieldMap -> documentFieldMap.forEach((key, documentField) -> { // See a full list of fields found on an invoice here: - // https://aka.ms/documentintelligence/invoicefields + // https://aka.ms/formrecognizer/invoicefields if ("Description".equals(key)) { if (DocumentFieldType.STRING == documentField.getType()) { String name = documentField.getValueString(); diff --git a/sdk/documentintelligence/azure-ai-documentintelligence/src/samples/java/com/azure/ai/documentintelligence/AnalyzeInvoicesFromUrlAsync.java b/sdk/documentintelligence/azure-ai-documentintelligence/src/samples/java/com/azure/ai/documentintelligence/AnalyzeInvoicesFromUrlAsync.java index 66aeae7ee5829..4269e085bf7e5 100644 --- a/sdk/documentintelligence/azure-ai-documentintelligence/src/samples/java/com/azure/ai/documentintelligence/AnalyzeInvoicesFromUrlAsync.java +++ b/sdk/documentintelligence/azure-ai-documentintelligence/src/samples/java/com/azure/ai/documentintelligence/AnalyzeInvoicesFromUrlAsync.java @@ -21,7 +21,7 @@ /** * Async sample for analyzing commonly found invoice fields from a file source URL of an invoice document. - * See fields found on an invoice here + * See fields found on an invoice here */ public class AnalyzeInvoicesFromUrlAsync { /** @@ -141,7 +141,7 @@ public static void main(final String[] args) throws IOException { .map(documentField -> documentField.getValueObject()) .forEach(documentFieldMap -> documentFieldMap.forEach((key, documentField) -> { // See a full list of fields found on an invoice here: - // https://aka.ms/documentintelligence/invoicefields + // https://aka.ms/formrecognizer/invoicefields if ("Description".equals(key)) { if (DocumentFieldType.STRING == documentField.getType()) { String name = documentField.getValueString(); diff --git a/sdk/documentintelligence/azure-ai-documentintelligence/src/samples/java/com/azure/ai/documentintelligence/AnalyzeReceipts.java b/sdk/documentintelligence/azure-ai-documentintelligence/src/samples/java/com/azure/ai/documentintelligence/AnalyzeReceipts.java index 54438f50c8516..10314fbdd1836 100644 --- a/sdk/documentintelligence/azure-ai-documentintelligence/src/samples/java/com/azure/ai/documentintelligence/AnalyzeReceipts.java +++ b/sdk/documentintelligence/azure-ai-documentintelligence/src/samples/java/com/azure/ai/documentintelligence/AnalyzeReceipts.java @@ -21,7 +21,7 @@ /** * Sample for analyzing commonly found receipt fields from a local file input stream. - * See fields found on a receipt here + * See fields found on a receipt here */ public class AnalyzeReceipts { diff --git a/sdk/documentintelligence/azure-ai-documentintelligence/src/samples/java/com/azure/ai/documentintelligence/AnalyzeReceiptsAsync.java b/sdk/documentintelligence/azure-ai-documentintelligence/src/samples/java/com/azure/ai/documentintelligence/AnalyzeReceiptsAsync.java index dfe6c3dea8ad1..e53433507185a 100644 --- a/sdk/documentintelligence/azure-ai-documentintelligence/src/samples/java/com/azure/ai/documentintelligence/AnalyzeReceiptsAsync.java +++ b/sdk/documentintelligence/azure-ai-documentintelligence/src/samples/java/com/azure/ai/documentintelligence/AnalyzeReceiptsAsync.java @@ -23,7 +23,7 @@ /** * Async sample for analyzing commonly found receipt fields from a local file input stream. - * See fields found on a receipt here + * See fields found on a receipt here */ public class AnalyzeReceiptsAsync { diff --git a/sdk/documentintelligence/azure-ai-documentintelligence/src/samples/java/com/azure/ai/documentintelligence/AnalyzeReceiptsFromUrl.java b/sdk/documentintelligence/azure-ai-documentintelligence/src/samples/java/com/azure/ai/documentintelligence/AnalyzeReceiptsFromUrl.java index 7c6c99d97a086..a8bbabbd6b693 100644 --- a/sdk/documentintelligence/azure-ai-documentintelligence/src/samples/java/com/azure/ai/documentintelligence/AnalyzeReceiptsFromUrl.java +++ b/sdk/documentintelligence/azure-ai-documentintelligence/src/samples/java/com/azure/ai/documentintelligence/AnalyzeReceiptsFromUrl.java @@ -18,7 +18,7 @@ /** * Sample for analyzing commonly found receipt fields from a file source URL. - * See fields found on a receipt here. + * See fields found on a receipt here. * */ public class AnalyzeReceiptsFromUrl { diff --git a/sdk/documentintelligence/azure-ai-documentintelligence/src/samples/java/com/azure/ai/documentintelligence/AnalyzeReceiptsFromUrlAsync.java b/sdk/documentintelligence/azure-ai-documentintelligence/src/samples/java/com/azure/ai/documentintelligence/AnalyzeReceiptsFromUrlAsync.java index 2b6403d10d41d..edda539290f95 100644 --- a/sdk/documentintelligence/azure-ai-documentintelligence/src/samples/java/com/azure/ai/documentintelligence/AnalyzeReceiptsFromUrlAsync.java +++ b/sdk/documentintelligence/azure-ai-documentintelligence/src/samples/java/com/azure/ai/documentintelligence/AnalyzeReceiptsFromUrlAsync.java @@ -20,7 +20,7 @@ /** * Async sample for analyzing commonly found receipt fields from a file source URL. - * See fields found on a receipt here + * See fields found on a receipt here */ public class AnalyzeReceiptsFromUrlAsync { diff --git a/sdk/documentintelligence/azure-ai-documentintelligence/src/samples/java/com/azure/ai/documentintelligence/AnalyzeTaxW2.java b/sdk/documentintelligence/azure-ai-documentintelligence/src/samples/java/com/azure/ai/documentintelligence/AnalyzeTaxW2.java index e3d22975c1787..56e967b4ba12f 100644 --- a/sdk/documentintelligence/azure-ai-documentintelligence/src/samples/java/com/azure/ai/documentintelligence/AnalyzeTaxW2.java +++ b/sdk/documentintelligence/azure-ai-documentintelligence/src/samples/java/com/azure/ai/documentintelligence/AnalyzeTaxW2.java @@ -20,7 +20,7 @@ /** * Sample for analyzing commonly found W-2 fields from a local file input stream of a tax W-2 document. - * See fields found on a US Tax W2 document here + * See fields found on a US Tax W2 document here */ public class AnalyzeTaxW2 { /** diff --git a/sdk/documentintelligence/azure-ai-documentintelligence/src/samples/java/com/azure/ai/documentintelligence/AnalyzeTaxW2Async.java b/sdk/documentintelligence/azure-ai-documentintelligence/src/samples/java/com/azure/ai/documentintelligence/AnalyzeTaxW2Async.java index 5c7838a11d073..80511ff81d6cc 100644 --- a/sdk/documentintelligence/azure-ai-documentintelligence/src/samples/java/com/azure/ai/documentintelligence/AnalyzeTaxW2Async.java +++ b/sdk/documentintelligence/azure-ai-documentintelligence/src/samples/java/com/azure/ai/documentintelligence/AnalyzeTaxW2Async.java @@ -19,7 +19,7 @@ /** * Async Sample for analyzing commonly found W-2 fields from a local file input stream of a tax W-2 document. - * See fields found on a US Tax W2 document here + * See fields found on a US Tax W2 document here */ public class AnalyzeTaxW2Async { /** diff --git a/sdk/metricsadvisor/azure-ai-metricsadvisor/src/samples/README.md b/sdk/metricsadvisor/azure-ai-metricsadvisor/src/samples/README.md index 4db76990e3408..ce321a13f114f 100644 --- a/sdk/metricsadvisor/azure-ai-metricsadvisor/src/samples/README.md +++ b/sdk/metricsadvisor/azure-ai-metricsadvisor/src/samples/README.md @@ -24,51 +24,51 @@ The following sections provide code samples covering common scenario operations All of these samples need the endpoint to your Metrics Advisor resource ([instructions on how to get endpoint][get-endpoint-instructions]), and your Metrics Advisor API key ([instructions on how to get key][get-key-instructions]). -|**File Name**|**Description**| -|----------------|-------------| -|[DataFeedSample][data_feed_sample] -& [DataFeedAsyncSample][data_feed_async_sample] | Create, list, get, update, and delete data feeds| -|[AnomalyDetectionConfigurationSample][anomaly_detection_sample] -& [AnomalyDetectionConfigurationAsyncSample][anomaly_detection_async_sample] | Create, list, get, update, and delete anomaly detection configurations| -|[DatafeedIngestionSample][data_feed_ingestion_sample] -& [DatafeedIngestionSampleAsyncSample][data_feed_ingestion_async_sample] | List, get progress, and refresh data feed ingestion| -|[HookSample][hook_sample] -& [HookAsyncSample][hook_async_sample] | Create, list, get, update, and delete hooks||[MetricFeedbackSample][metric_feedback_sample] -|[MetricFeedbackSample][metric_feedback_sample] -& [MetricFeedbackAsyncSample][metric_feedback_async_sample] | Create, get and list feedbacks| +| **File Name** | **Description** | +|------------------------------------------------------------------------------|------------------------------------------------------------------------| +| [DataFeedSample][data_feed_sample] | | +| & [DataFeedAsyncSample][data_feed_async_sample] | Create, list, get, update, and delete data feeds | +| [AnomalyDetectionConfigurationSample][anomaly_detection_sample] | | +| & [AnomalyDetectionConfigurationAsyncSample][anomaly_detection_async_sample] | Create, list, get, update, and delete anomaly detection configurations | +| [DatafeedIngestionSample][data_feed_ingestion_sample] | | +| & [DatafeedIngestionSampleAsyncSample][data_feed_ingestion_async_sample] | List, get progress, and refresh data feed ingestion | +| [HookSample][hook_sample] | | +| & [HookAsyncSample][hook_async_sample] | Create, list, get, update, and delete hooks ||[MetricFeedbackSample][metric_feedback_sample] +| [MetricFeedbackSample][metric_feedback_sample] | | +| & [MetricFeedbackAsyncSample][metric_feedback_async_sample] | Create, get and list feedbacks | -Querying API's +Querying APIs -|**File Name**|**Description**| -|----------------|-------------| -|[ListAlertsSample][list_alerts_sample] -& [ListAlertsAsyncSample][list_alerts_async_sample] | List alerts produced by an AlertConfiguration| -|[ListDimensionValuesForMetricSample][list_dimension_values_sample] -& [ListDimensionValuesForMetricAsyncSample][list_dimension_values_async_sample] | List dimension values for a metric| -|[ListEnrichedSeriesSample][list_enrichment_series_sample] -& [ListEnrichedSeriesAsyncSample][list_enrichment_series_async_sample] | List enriched time series| -|[ListEnrichmentStatusForMetricSample][list_enrichment_status_sample] -& [ListEnrichmentStatusForMetricAsyncSample][list_enrichment_status_async_sample] | List enrichment statuses for a metric| -|[ListIncidentRootCausesSample][list_incident_root_causes_sample] -& [ListIncidentRootCausesAsyncSample][list_incident_root_causes_async_sample] | List root causes for an incident| -|[ListIncidentsAlertedSample][list_incidents_alerted_sample] -& [ListIncidentsAlertedAsyncSample][list_incidents_alerted_async_sample] | List incidents in an anomaly alert| -|[ListIncidentsDetectedSample][list_incidents_sample] -& [ListIncidentsDetectedAsyncSample][list_incidents_async_sample] | List incidents detected by a detection configuration| -|[ListsAnomaliesForAlertsSample][list_anomaly_alert_sample] -& [ListsAnomaliesForAlertsAsyncSample][list_anomaly_alert_async_sample] | List anomalies triggered for an anomaly alert| -|[ListsAnomaliesForDetectionConfigSample][list_anomalies_detection_config_sample] -& [ListsAnomaliesForDetectionConfigAsyncSample][list_anomalies_detection_config_async_sample] | List anomalies identified by a detection configuration| -|[ListSeriesDataForMetricSample][list_series_data_sample] -& [ListSeriesDataForMetricAsyncSample][list_series_data_async_sample] | List metric series data for a metric| -|[ListSeriesDefinitionsForMetricSample][list_series_def_sample] -& [ListSeriesDefinitionsForMetricAsyncSample][list_series_def_async_sample] | List series definition for a metric| +| **File Name** | **Description** | +|-----------------------------------------------------------------------------------------------|--------------------------------------------------------| +| [ListAlertsSample][list_alerts_sample] | | +| & [ListAlertsAsyncSample][list_alerts_async_sample] | List alerts produced by an AlertConfiguration | +| [ListDimensionValuesForMetricSample][list_dimension_values_sample] | | +| & [ListDimensionValuesForMetricAsyncSample][list_dimension_values_async_sample] | List dimension values for a metric | +| [ListEnrichedSeriesSample][list_enrichment_series_sample] | | +| & [ListEnrichedSeriesAsyncSample][list_enrichment_series_async_sample] | List enriched time series | +| [ListEnrichmentStatusForMetricSample][list_enrichment_status_sample] | | +| & [ListEnrichmentStatusForMetricAsyncSample][list_enrichment_status_async_sample] | List enrichment statuses for a metric | +| [ListIncidentRootCausesSample][list_incident_root_causes_sample] | | +| & [ListIncidentRootCausesAsyncSample][list_incident_root_causes_async_sample] | List root causes for an incident | +| [ListIncidentsAlertedSample][list_incidents_alerted_sample] | | +| & [ListIncidentsAlertedAsyncSample][list_incidents_alerted_async_sample] | List incidents in an anomaly alert | +| [ListIncidentsDetectedSample][list_incidents_sample] | | +| & [ListIncidentsDetectedAsyncSample][list_incidents_async_sample] | List incidents detected by a detection configuration | +| [ListsAnomaliesForAlertsSample][list_anomaly_alert_sample] | | +| & [ListsAnomaliesForAlertsAsyncSample][list_anomaly_alert_async_sample] | List anomalies triggered for an anomaly alert | +| [ListsAnomaliesForDetectionConfigSample][list_anomalies_detection_config_sample] | | +| & [ListsAnomaliesForDetectionConfigAsyncSample][list_anomalies_detection_config_async_sample] | List anomalies identified by a detection configuration | +| [ListSeriesDataForMetricSample][list_series_data_sample] | | +| & [ListSeriesDataForMetricAsyncSample][list_series_data_async_sample] | List metric series data for a metric | +| [ListSeriesDefinitionsForMetricSample][list_series_def_sample] | | +| & [ListSeriesDefinitionsForMetricAsyncSample][list_series_def_async_sample] | List series definition for a metric | ## Troubleshooting Troubleshooting steps can be found [here][SDK_README_TROUBLESHOOTING]. ## Next steps -Check out the [API reference documentation][java_ma_ref_docs] to learn more about +Check out the [API reference documentation][api_reference_doc] to learn more about what you can do with the Azure Metrics Advisor client library. ## Contributing @@ -82,7 +82,9 @@ Guidelines][SDK_README_CONTRIBUTING] for more information. [SDK_README_KEY_CONCEPTS]: https://github.com/Azure/azure-sdk-for-java/tree/main/sdk/metricsadvisor/azure-ai-metricsadvisor#key-concepts [SDK_README_DEPENDENCY]: https://github.com/Azure/azure-sdk-for-java/tree/main/sdk/metricsadvisor/azure-ai-metricsadvisor#include-the-package [SDK_README_NEXT_STEPS]: https://github.com/Azure/azure-sdk-for-java/tree/main/sdk/metricsadvisor/azure-ai-metricsadvisor#next-steps -[java_ma_ref_docs]: https://aka.ms/azsdk-java-metricsadvisor-ref-docs +[get-endpoint-instructions]: https://github.com/Azure/azure-sdk-for-java/tree/main/sdk/metricsadvisor/azure-ai-metricsadvisor#looking-up-the-endpoint +[get-key-instructions]: https://github.com/Azure/azure-sdk-for-java/tree/main/sdk/metricsadvisor/azure-ai-metricsadvisor#create-a-metricsadvisor-client-using-metricsadvisorkeycredential +[api_reference_doc]: https://docs.microsoft.com/java/api/com.azure.ai.metricsadvisor?view=azure-java-preview [data_feed_sample]: https://github.com/Azure/azure-sdk-for-java/blob/main/sdk/metricsadvisor/azure-ai-metricsadvisor/src/samples/java/com/azure/ai/metricsadvisor/administration/DatafeedSample.java [data_feed_async_sample]: https://github.com/Azure/azure-sdk-for-java/blob/main/sdk/metricsadvisor/azure-ai-metricsadvisor/src/samples/java/com/azure/ai/metricsadvisor/administration/DatafeedAsyncSample.java [anomaly_detection_sample]: https://github.com/Azure/azure-sdk-for-java/blob/main/sdk/metricsadvisor/azure-ai-metricsadvisor/src/samples/java/com/azure/ai/metricsadvisor/administration/AnomalyDetectionConfigurationSample.java