public async Task RecognizeLinkedEntitiesBatchWithStatisticsTest()
{
TextAnalyticsClient client = GetClient();
var inputs = new List <TextDocumentInput>
{
new TextDocumentInput("1", "Microsoft was founded by Bill Gates and Paul Allen.")
{
Language = "en",
},
new TextDocumentInput("3", "Pike place market is my favorite Seattle attraction.")
{
Language = "en",
}
};
RecognizeLinkedEntitiesResultCollection results = await client.RecognizeLinkedEntitiesBatchAsync(inputs, new TextAnalyticsRequestOptions { IncludeStatistics = true });
foreach (RecognizeLinkedEntitiesResult result in results)
{
Assert.GreaterOrEqual(result.Entities.Count(), 2);
}
Assert.IsNotNull(results.Statistics.DocumentCount);
Assert.IsNotNull(results.Statistics.InvalidDocumentCount);
Assert.IsNotNull(results.Statistics.TransactionCount);
Assert.IsNotNull(results.Statistics.ValidDocumentCount);
}
public async Task AnalyzeOperationAllActionsAndDisableServiceLogs()
{
TextAnalyticsClient client = GetClient();
TextAnalyticsActions batchActions = new TextAnalyticsActions()
{
ExtractKeyPhrasesOptions = new List <ExtractKeyPhrasesOptions>()
{
new ExtractKeyPhrasesOptions()
{
DisableServiceLogs = true
}
},
RecognizeEntitiesOptions = new List <RecognizeEntitiesOptions>()
{
new RecognizeEntitiesOptions()
{
DisableServiceLogs = true
}
},
RecognizePiiEntitiesOptions = new List <RecognizePiiEntitiesOptions>()
{
new RecognizePiiEntitiesOptions()
{
DisableServiceLogs = false
}
},
RecognizeLinkedEntitiesOptions = new List <RecognizeLinkedEntitiesOptions>()
{
new RecognizeLinkedEntitiesOptions()
{
DisableServiceLogs = true
}
},
};
AnalyzeBatchActionsOperation operation = await client.StartAnalyzeBatchActionsAsync(batchConvenienceDocuments, batchActions);
await operation.WaitForCompletionAsync();
//Take the first page
AnalyzeBatchActionsResult resultCollection = operation.Value.ToEnumerableAsync().Result.FirstOrDefault();
ExtractKeyPhrasesResultCollection keyPhrasesResult = resultCollection.ExtractKeyPhrasesActionsResults.FirstOrDefault().Result;
RecognizeEntitiesResultCollection entitiesResult = resultCollection.RecognizeEntitiesActionsResults.FirstOrDefault().Result;
RecognizePiiEntitiesResultCollection piiResult = resultCollection.RecognizePiiEntitiesActionsResults.FirstOrDefault().Result;
RecognizeLinkedEntitiesResultCollection entityLinkingResult = resultCollection.RecognizeLinkedEntitiesActionsResults.FirstOrDefault().Result;
Assert.IsNotNull(keyPhrasesResult);
Assert.AreEqual(2, keyPhrasesResult.Count);
Assert.IsNotNull(entitiesResult);
Assert.AreEqual(2, keyPhrasesResult.Count);
Assert.IsNotNull(piiResult);
Assert.AreEqual(2, keyPhrasesResult.Count);
Assert.IsNotNull(entityLinkingResult);
Assert.AreEqual(2, keyPhrasesResult.Count);
}
public async Task RecognizeLinkedEntitiesBatchTest()
{
TextAnalyticsClient client = GetClient();
List <TextDocumentInput> documents = batchDocuments;
RecognizeLinkedEntitiesResultCollection results = await client.RecognizeLinkedEntitiesBatchAsync(documents);
foreach (RecognizeLinkedEntitiesResult result in results)
{
Assert.GreaterOrEqual(result.Entities.Count(), 2);
}
}
public async Task RecognizeLinkedEntitiesBatchWithStatisticsTest()
{
TextAnalyticsClient client = GetClient();
RecognizeLinkedEntitiesResultCollection results = await client.RecognizeLinkedEntitiesBatchAsync(s_batchDocuments, new TextAnalyticsRequestOptions { IncludeStatistics = true });
var expectedOutput = new Dictionary <string, List <string> >()
{
{ "1", s_document1ExpectedOutput },
{ "3", s_document1ExpectedOutput },
};
ValidateBatchDocumentsResult(results, expectedOutput, includeStatistics: true);
}
public async Task RecognizeLinkedEntitiesBatchTest()
{
TextAnalyticsClient client = GetClient();
RecognizeLinkedEntitiesResultCollection results = await client.RecognizeLinkedEntitiesBatchAsync(s_batchDocuments);
var expectedOutput = new Dictionary <string, List <string> >()
{
{ "1", s_document1ExpectedOutput },
{ "3", s_document1ExpectedOutput },
};
ValidateBatchDocumentsResult(results, expectedOutput);
}
public async Task RecognizeLinkedEntitiesBatchWithNullTextTest()
{
TextAnalyticsClient client = GetClient();
var documents = new List <TextDocumentInput> {
new TextDocumentInput("1", null)
};
RecognizeLinkedEntitiesResultCollection results = await client.RecognizeLinkedEntitiesBatchAsync(documents);
var exceptionMessage = "Cannot access result for document 1, due to error InvalidDocument: Document text is empty.";
Assert.IsTrue(results[0].HasError);
InvalidOperationException ex = Assert.Throws <InvalidOperationException>(() => results[0].Entities.Count());
Assert.AreEqual(exceptionMessage, ex.Message);
}
public async Task RecognizeLinkedEntitiesBatchConvenienceTest()
{
TextAnalyticsClient client = GetClient();
var inputs = new List <string>
{
"Microsoft was founded by Bill Gates and Paul Allen.",
"Pike place market is my favorite Seattle attraction.",
};
RecognizeLinkedEntitiesResultCollection results = await client.RecognizeLinkedEntitiesBatchAsync(inputs);
foreach (RecognizeLinkedEntitiesResult result in results)
{
Assert.GreaterOrEqual(result.Entities.Count(), 2);
}
}
public async Task RecognizeLinkedEntitiesBatchWithStatisticsTest()
{
TextAnalyticsClient client = GetClient();
List <TextDocumentInput> documents = batchDocuments;
RecognizeLinkedEntitiesResultCollection results = await client.RecognizeLinkedEntitiesBatchAsync(documents, new TextAnalyticsRequestOptions { IncludeStatistics = true });
foreach (RecognizeLinkedEntitiesResult result in results)
{
Assert.GreaterOrEqual(result.Entities.Count(), 2);
}
Assert.IsNotNull(results.Statistics.DocumentCount);
Assert.IsNotNull(results.Statistics.InvalidDocumentCount);
Assert.IsNotNull(results.Statistics.TransactionCount);
Assert.IsNotNull(results.Statistics.ValidDocumentCount);
}
public async Task RecognizeLinkedEntitiesBatchWithErrorTest()
{
TextAnalyticsClient client = GetClient();
var inputs = new List <string>
{
"Microsoft was founded by Bill Gates and Paul Allen.",
"",
"Pike place market is my favorite Seattle attraction.",
};
RecognizeLinkedEntitiesResultCollection results = await client.RecognizeLinkedEntitiesBatchAsync(inputs);
Assert.IsTrue(!results[0].HasError);
Assert.IsTrue(!results[2].HasError);
Assert.IsTrue(results[1].HasError);
Assert.Throws <InvalidOperationException>(() => results[1].Entities.GetType());
}
public async Task RecognizeLinkedEntitiesBatchWithStatisticsTest()
{
TextAnalyticsRequestOptions options = new TextAnalyticsRequestOptions {
IncludeStatistics = true
};
TextAnalyticsClient client = GetClient();
RecognizeLinkedEntitiesResultCollection results = await client.RecognizeLinkedEntitiesBatchAsync(s_batchDocuments, options);
var expectedOutput = new Dictionary <string, List <string> >()
{
{ "1", s_document1ExpectedOutput },
{ "3", s_document1ExpectedOutput },
};
ValidateBatchDocumentsResult(results, expectedOutput, includeStatistics: true);
// Assert the options classes since overloads were added and the original now instantiates a RecognizeLinkedEntitiesOptions.
Assert.IsTrue(options.IncludeStatistics);
Assert.IsNull(options.ModelVersion);
}
public async Task RecognizeLinkedEntitiesBatchConvenienceWithRecognizeLinkedEntitiesOptionsStatisticsTest()
{
RecognizeLinkedEntitiesOptions options = new RecognizeLinkedEntitiesOptions {
IncludeStatistics = true
};
TextAnalyticsClient client = GetClient();
RecognizeLinkedEntitiesResultCollection results = await client.RecognizeLinkedEntitiesBatchAsync(s_batchConvenienceDocuments, "en", options);
var expectedOutput = new Dictionary <string, List <string> >()
{
{ "0", s_document1ExpectedOutput },
{ "1", s_document2ExpectedOutput },
};
ValidateBatchDocumentsResult(results, expectedOutput, includeStatistics: true);
// Assert the options classes since overloads were added and the original now instantiates a RecognizeLinkedEntitiesOptions.
Assert.IsTrue(options.IncludeStatistics);
Assert.IsNull(options.ModelVersion);
Assert.AreEqual(StringIndexType.Utf16CodeUnit, options.StringIndexType);
}
private void ValidateBatchDocumentsResult(RecognizeLinkedEntitiesResultCollection results, Dictionary <string, List <string> > minimumExpectedOutput, bool includeStatistics = default)
{
Assert.That(results.ModelVersion, Is.Not.Null.And.Not.Empty);
if (includeStatistics)
{
Assert.IsNotNull(results.Statistics);
Assert.Greater(results.Statistics.DocumentCount, 0);
Assert.Greater(results.Statistics.TransactionCount, 0);
Assert.GreaterOrEqual(results.Statistics.InvalidDocumentCount, 0);
Assert.GreaterOrEqual(results.Statistics.ValidDocumentCount, 0);
}
else
{
Assert.IsNull(results.Statistics);
}
foreach (RecognizeLinkedEntitiesResult entitiesInDocument in results)
{
Assert.That(entitiesInDocument.Id, Is.Not.Null.And.Not.Empty);
Assert.False(entitiesInDocument.HasError);
//Even though statistics are not asked for, TA 5.0.0 shipped with Statistics default always present.
Assert.IsNotNull(entitiesInDocument.Statistics);
if (includeStatistics)
{
Assert.GreaterOrEqual(entitiesInDocument.Statistics.CharacterCount, 0);
Assert.Greater(entitiesInDocument.Statistics.TransactionCount, 0);
}
else
{
Assert.AreEqual(0, entitiesInDocument.Statistics.CharacterCount);
Assert.AreEqual(0, entitiesInDocument.Statistics.TransactionCount);
}
ValidateInDocumenResult(entitiesInDocument.Entities, minimumExpectedOutput[entitiesInDocument.Id]);
}
}
public void ExtractEntityLinkingBatchConvenience()
{
string endpoint = TestEnvironment.Endpoint;
string apiKey = TestEnvironment.ApiKey;
// Instantiate a client that will be used to call the service.
var client = new TextAnalyticsClient(new Uri(endpoint), new AzureKeyCredential(apiKey));
var documents = new List <string>
{
"Microsoft was founded by Bill Gates and Paul Allen.",
"Text Analytics is one of the Azure Cognitive Services.",
"Pike place market is my favorite Seattle attraction.",
};
#region Snippet:TextAnalyticsSample6RecognizeLinkedEntitiesConvenience
RecognizeLinkedEntitiesResultCollection results = client.RecognizeLinkedEntitiesBatch(documents);
#endregion
Debug.WriteLine($"Linked entities for each document are:\n");
int i = 0;
foreach (RecognizeLinkedEntitiesResult result in results)
{
Debug.Write($"For document: \"{documents[i++]}\", ");
Debug.WriteLine($"extracted {result.Entities.Count()} linked entit{(result.Entities.Count() > 1 ? "ies" : "y")}:");
foreach (LinkedEntity linkedEntity in result.Entities)
{
Debug.WriteLine($" Name: \"{linkedEntity.Name}\", Language: {linkedEntity.Language}, Data Source: {linkedEntity.DataSource}, Url: {linkedEntity.Url.ToString()}, Entity Id in Data Source: \"{linkedEntity.DataSourceEntityId}\"");
foreach (LinkedEntityMatch match in linkedEntity.Matches)
{
Debug.WriteLine($" Match Text: \"{match.Text}\", Offset (in UTF-16 code units): {match.Offset}, Length (in UTF-16 code units): {match.Length}");
Debug.WriteLine($" Confidence score: {match.ConfidenceScore}");
}
}
Debug.WriteLine("");
}
}
public async Task RecognizeLinkedEntitiesBatchTest()
{
TextAnalyticsClient client = GetClient();
var inputs = new List <TextDocumentInput>
{
new TextDocumentInput("1", "Microsoft was founded by Bill Gates and Paul Allen.")
{
Language = "en",
},
new TextDocumentInput("3", "Pike place market is my favorite Seattle attraction.")
{
Language = "en",
}
};
RecognizeLinkedEntitiesResultCollection results = await client.RecognizeLinkedEntitiesBatchAsync(inputs);
foreach (RecognizeLinkedEntitiesResult result in results)
{
Assert.GreaterOrEqual(result.Entities.Count(), 2);
}
}
public async Task RecognizeLinkedEntitiesBatchWithErrorTest()
{
TextAnalyticsClient client = GetClient();
var inputs = new List <string>
{
"Microsoft was founded by Bill Gates and Paul Allen.",
"",
"Pike place market is my favorite Seattle attraction.",
};
RecognizeLinkedEntitiesResultCollection results = await client.RecognizeLinkedEntitiesBatchAsync(inputs);
Assert.IsTrue(!results[0].HasError);
Assert.IsTrue(!results[2].HasError);
var exceptionMessage = "Cannot access result for document 1, due to error InvalidDocument: Document text is empty.";
Assert.IsTrue(results[1].HasError);
InvalidOperationException ex = Assert.Throws <InvalidOperationException>(() => results[1].Entities.GetType());
Assert.AreEqual(exceptionMessage, ex.Message);
}
public void ExtractEntityLinkingBatchConvenience()
{
string endpoint = Environment.GetEnvironmentVariable("TEXT_ANALYTICS_ENDPOINT");
string apiKey = Environment.GetEnvironmentVariable("TEXT_ANALYTICS_API_KEY");
// Instantiate a client that will be used to call the service.
var client = new TextAnalyticsClient(new Uri(endpoint), new TextAnalyticsApiKeyCredential(apiKey));
var inputs = new List <string>
{
"Microsoft was founded by Bill Gates and Paul Allen.",
"Text Analytics is one of the Azure Cognitive Services.",
"Pike place market is my favorite Seattle attraction.",
};
#region Snippet:TextAnalyticsSample6RecognizeLinkedEntitiesConvenience
RecognizeLinkedEntitiesResultCollection results = client.RecognizeLinkedEntitiesBatch(inputs);
#endregion
Debug.WriteLine($"Linked entities for each input are:\n");
int i = 0;
foreach (RecognizeLinkedEntitiesResult result in results)
{
Debug.Write($"For input: \"{inputs[i++]}\", ");
Debug.WriteLine($"extracted {result.Entities.Count()} linked entit{(result.Entities.Count() > 1 ? "ies" : "y")}:");
foreach (LinkedEntity linkedEntity in result.Entities)
{
Debug.WriteLine($" Name: \"{linkedEntity.Name}\", Id: \"{linkedEntity.Id}\", Language: {linkedEntity.Language}, Data Source: {linkedEntity.DataSource}, Url: {linkedEntity.Url.ToString()}");
foreach (LinkedEntityMatch match in linkedEntity.Matches)
{
Debug.WriteLine($" Match Text: \"{match.Text}\", Score: {match.Score:0.00}, Offset: {match.Offset}, Length: {match.Length}.");
}
}
Debug.WriteLine("");
}
}
public async Task ExtractEntityLinkingBatchConvenienceAsync()
{
string endpoint = Environment.GetEnvironmentVariable("TEXT_ANALYTICS_ENDPOINT");
string apiKey = Environment.GetEnvironmentVariable("TEXT_ANALYTICS_API_KEY");
// Instantiate a client that will be used to call the service.
var client = new TextAnalyticsClient(new Uri(endpoint), new AzureKeyCredential(apiKey));
var documents = new List <string>
{
"Microsoft was founded by Bill Gates and Paul Allen.",
"Text Analytics is one of the Azure Cognitive Services.",
"Pike place market is my favorite Seattle attraction.",
};
RecognizeLinkedEntitiesResultCollection results = await client.RecognizeLinkedEntitiesBatchAsync(documents);
Console.WriteLine($"Linked entities for each document are:\n");
int i = 0;
foreach (RecognizeLinkedEntitiesResult result in results)
{
Console.Write($"For document: \"{documents[i++]}\", ");
Console.WriteLine($"extracted {result.Entities.Count()} linked entit{(result.Entities.Count() > 1 ? "ies" : "y")}:");
foreach (LinkedEntity linkedEntity in result.Entities)
{
Console.WriteLine($" Name: \"{linkedEntity.Name}\", Language: {linkedEntity.Language}, Data Source: {linkedEntity.DataSource}, Url: {linkedEntity.Url.ToString()}, Entity Id in Data Source: \"{linkedEntity.DataSourceEntityId}\"");
foreach (LinkedEntityMatch match in linkedEntity.Matches)
{
Console.WriteLine($" Match Text: \"{match.Text}\", Confidence score: {match.ConfidenceScore}");
}
}
Console.WriteLine("");
}
}
public void ExtractEntityLinkingBatch()
{
string endpoint = Environment.GetEnvironmentVariable("TEXT_ANALYTICS_ENDPOINT");
string apiKey = Environment.GetEnvironmentVariable("TEXT_ANALYTICS_API_KEY");
// Instantiate a client that will be used to call the service.
var client = new TextAnalyticsClient(new Uri(endpoint), new TextAnalyticsApiKeyCredential(apiKey));
#region Snippet:TextAnalyticsSample6RecognizeLinkedEntitiesBatch
var inputs = new List <TextDocumentInput>
{
new TextDocumentInput("1", "Microsoft was founded by Bill Gates and Paul Allen.")
{
Language = "en",
},
new TextDocumentInput("2", "Text Analytics is one of the Azure Cognitive Services.")
{
Language = "en",
},
new TextDocumentInput("3", "Pike place market is my favorite Seattle attraction.")
{
Language = "en",
}
};
RecognizeLinkedEntitiesResultCollection results = client.RecognizeLinkedEntitiesBatch(inputs, new TextAnalyticsRequestOptions {
IncludeStatistics = true
});
#endregion
int i = 0;
Debug.WriteLine($"Results of Azure Text Analytics \"Entity Linking\", version: \"{results.ModelVersion}\"");
Debug.WriteLine("");
foreach (RecognizeLinkedEntitiesResult result in results)
{
TextDocumentInput document = inputs[i++];
Debug.WriteLine($"On document (Id={document.Id}, Language=\"{document.Language}\", Text=\"{document.Text}\"):");
if (result.HasError)
{
Debug.WriteLine($" Document error code: {result.Error.Code}.");
Debug.WriteLine($" Message: {result.Error.Message}.");
}
else
{
Debug.WriteLine($" Extracted the following {result.Entities.Count()} linked entities:");
foreach (LinkedEntity linkedEntity in result.Entities)
{
Debug.WriteLine($" Name: \"{linkedEntity.Name}\", Language: {linkedEntity.Language}, Data Source: {linkedEntity.DataSource}, Url: {linkedEntity.Url.ToString()}, Entity Id in Data Source: \"{linkedEntity.DataSourceEntityId}\"");
foreach (LinkedEntityMatch match in linkedEntity.Matches)
{
Debug.WriteLine($" Match Text: \"{match.Text}\", Score: {match.Score:0.00}, Offset: {match.Offset}, Length: {match.Length}.");
}
}
Debug.WriteLine($" Document statistics:");
Debug.WriteLine($" Character count: {result.Statistics.CharacterCount}");
Debug.WriteLine($" Transaction count: {result.Statistics.TransactionCount}");
Debug.WriteLine("");
}
}
Debug.WriteLine($"Batch operation statistics:");
Debug.WriteLine($" Document count: {results.Statistics.DocumentCount}");
Debug.WriteLine($" Valid document count: {results.Statistics.ValidDocumentCount}");
Debug.WriteLine($" Invalid document count: {results.Statistics.InvalidDocumentCount}");
Debug.WriteLine($" Transaction count: {results.Statistics.TransactionCount}");
Debug.WriteLine("");
}
public async Task AnalyzeOperationWithMultipleActions()
{
TextAnalyticsClient client = GetClient();
var batchDocuments = new List <TextDocumentInput>
{
new TextDocumentInput("1", "Microsoft was founded by Bill Gates and Paul Allen.")
{
Language = "en",
},
new TextDocumentInput("2", "Mi perro y mi gato tienen que ir al veterinario.")
{
Language = "es",
}
};
TextAnalyticsActions batchActions = new TextAnalyticsActions()
{
ExtractKeyPhrasesActions = new List <ExtractKeyPhrasesAction>()
{
new ExtractKeyPhrasesAction()
},
RecognizeEntitiesActions = new List <RecognizeEntitiesAction>()
{
new RecognizeEntitiesAction()
},
RecognizePiiEntitiesActions = new List <RecognizePiiEntitiesAction>()
{
new RecognizePiiEntitiesAction()
},
RecognizeLinkedEntitiesActions = new List <RecognizeLinkedEntitiesAction>()
{
new RecognizeLinkedEntitiesAction()
},
AnalyzeSentimentActions = new List <AnalyzeSentimentAction>()
{
new AnalyzeSentimentAction()
},
DisplayName = "AnalyzeOperationWithMultipleTasks"
};
AnalyzeActionsOperation operation = await client.StartAnalyzeActionsAsync(batchDocuments, batchActions);
Assert.AreEqual(0, operation.ActionsFailed);
Assert.AreEqual(0, operation.ActionsSucceeded);
Assert.AreEqual(0, operation.ActionsInProgress);
Assert.AreEqual(0, operation.ActionsTotal);
await operation.WaitForCompletionAsync();
Assert.AreEqual(0, operation.ActionsFailed);
Assert.AreEqual(5, operation.ActionsSucceeded);
Assert.AreEqual(0, operation.ActionsInProgress);
Assert.AreEqual(5, operation.ActionsTotal);
Assert.AreNotEqual(new DateTimeOffset(), operation.CreatedOn);
Assert.AreNotEqual(new DateTimeOffset(), operation.LastModified);
Assert.AreNotEqual(new DateTimeOffset(), operation.ExpiresOn);
//Take the first page
AnalyzeActionsResult resultCollection = operation.Value.ToEnumerableAsync().Result.FirstOrDefault();
IReadOnlyCollection <RecognizeEntitiesActionResult> entitiesActionsResults = resultCollection.RecognizeEntitiesResults;
IReadOnlyCollection <ExtractKeyPhrasesActionResult> keyPhrasesActionsResults = resultCollection.ExtractKeyPhrasesResults;
IReadOnlyCollection <RecognizePiiEntitiesActionResult> piiActionsResults = resultCollection.RecognizePiiEntitiesResults;
IReadOnlyCollection <RecognizeLinkedEntitiesActionResult> entityLinkingActionsResults = resultCollection.RecognizeLinkedEntitiesResults;
IReadOnlyCollection <AnalyzeSentimentActionResult> analyzeSentimentActionsResults = resultCollection.AnalyzeSentimentResults;
Assert.IsNotNull(keyPhrasesActionsResults);
Assert.IsNotNull(entitiesActionsResults);
Assert.IsNotNull(piiActionsResults);
Assert.IsNotNull(entityLinkingActionsResults);
Assert.IsNotNull(analyzeSentimentActionsResults);
Assert.AreEqual("AnalyzeOperationWithMultipleTasks", operation.DisplayName);
// Keyphrases
ExtractKeyPhrasesResultCollection keyPhrasesDocumentsResults = keyPhrasesActionsResults.FirstOrDefault().DocumentsResults;
Assert.AreEqual(2, keyPhrasesDocumentsResults.Count);
var keyPhrasesListId1 = new List <string> {
"Bill Gates", "Paul Allen", "Microsoft"
};
var keyPhrasesListId2 = new List <string> {
"Mi", "gato", "perro", "veterinario"
};
foreach (string keyphrase in keyPhrasesDocumentsResults[0].KeyPhrases)
{
Assert.IsTrue(keyPhrasesListId1.Contains(keyphrase));
}
foreach (string keyphrase in keyPhrasesDocumentsResults[1].KeyPhrases)
{
Assert.IsTrue(keyPhrasesListId2.Contains(keyphrase));
}
// Entities
RecognizeEntitiesResultCollection entitiesDocumentsResults = entitiesActionsResults.FirstOrDefault().DocumentsResults;
Assert.AreEqual(2, entitiesDocumentsResults.Count);
Assert.AreEqual(3, entitiesDocumentsResults[0].Entities.Count);
var entitiesList = new List <string> {
"Bill Gates", "Microsoft", "Paul Allen"
};
foreach (CategorizedEntity entity in entitiesDocumentsResults[0].Entities)
{
Assert.IsTrue(entitiesList.Contains(entity.Text));
Assert.IsNotNull(entity.Category);
Assert.IsNotNull(entity.Offset);
Assert.IsNotNull(entity.ConfidenceScore);
}
// PII
RecognizePiiEntitiesResultCollection piiDocumentsResults = piiActionsResults.FirstOrDefault().DocumentsResults;
Assert.AreEqual(2, piiDocumentsResults.Count);
Assert.AreEqual(3, piiDocumentsResults[0].Entities.Count);
Assert.IsNotNull(piiDocumentsResults[0].Id);
Assert.IsNotNull(piiDocumentsResults[0].Entities);
Assert.IsNotNull(piiDocumentsResults[0].Error);
// Entity Linking
RecognizeLinkedEntitiesResultCollection entityLinkingDocumentsResults = entityLinkingActionsResults.FirstOrDefault().DocumentsResults;
// Disable because of bug https://github.com/Azure/azure-sdk-for-net/issues/22648
//Assert.AreEqual(2, entityLinkingDocumentsResults.Count);
Assert.AreEqual(3, entityLinkingDocumentsResults[0].Entities.Count);
Assert.IsNotNull(entityLinkingDocumentsResults[0].Id);
Assert.IsNotNull(entityLinkingDocumentsResults[0].Entities);
Assert.IsNotNull(entityLinkingDocumentsResults[0].Error);
foreach (LinkedEntity entity in entityLinkingDocumentsResults[0].Entities)
{
if (entity.Name == "Bill Gates")
{
Assert.AreEqual("Bill Gates", entity.DataSourceEntityId);
Assert.AreEqual("Wikipedia", entity.DataSource);
}
if (entity.Name == "Microsoft")
{
Assert.AreEqual("Microsoft", entity.DataSourceEntityId);
Assert.AreEqual("Wikipedia", entity.DataSource);
}
}
// Analyze sentiment
AnalyzeSentimentResultCollection analyzeSentimentDocumentsResults = analyzeSentimentActionsResults.FirstOrDefault().DocumentsResults;
Assert.AreEqual(2, analyzeSentimentDocumentsResults.Count);
Assert.AreEqual(TextSentiment.Neutral, analyzeSentimentDocumentsResults[0].DocumentSentiment.Sentiment);
Assert.AreEqual(TextSentiment.Neutral, analyzeSentimentDocumentsResults[1].DocumentSentiment.Sentiment);
}
public async Task ExtractEntityLinkingBatchAsync()
{
string endpoint = TestEnvironment.Endpoint;
string apiKey = TestEnvironment.ApiKey;
// Instantiate a client that will be used to call the service.
var client = new TextAnalyticsClient(new Uri(endpoint), new AzureKeyCredential(apiKey));
string documentA = @"Microsoft was founded by Bill Gates with some friends he met at Harvard. One of his friends,
Steve Ballmer, eventually became CEO after Bill Gates as well.Steve Ballmer eventually stepped
down as CEO of Microsoft, and was succeeded by Satya Nadella.
Microsoft originally moved its headquarters to Bellevue, Washington in Januaray 1979, but is now
headquartered in Redmond";
string documentB = @"El CEO de Microsoft es Satya Nadella, quien asumió esta posición en Febrero de 2014. Él
empezó como Ingeniero de Software en el año 1992.";
string documentC = @"Microsoft was founded by Bill Gates and Paul Allen on April 4, 1975, to develop and
sell BASIC interpreters for the Altair 8800. During his career at Microsoft, Gates held
the positions of chairman chief executive officer, president and chief software architect
while also being the largest individual shareholder until May 2014.";
var documents = new List <TextDocumentInput>
{
new TextDocumentInput("1", documentA)
{
Language = "en",
},
new TextDocumentInput("2", documentB)
{
Language = "es",
},
new TextDocumentInput("3", documentC)
{
Language = "en",
},
new TextDocumentInput("4", string.Empty)
};
var options = new RecognizeLinkedEntitiesOptions {
IncludeStatistics = true
};
Response <RecognizeLinkedEntitiesResultCollection> response = await client.RecognizeLinkedEntitiesBatchAsync(documents, options);
RecognizeLinkedEntitiesResultCollection entitiesInDocuments = response.Value;
int i = 0;
Console.WriteLine($"Results of Azure Text Analytics \"Entity Linking\", version: \"{entitiesInDocuments.ModelVersion}\"");
Console.WriteLine("");
foreach (RecognizeLinkedEntitiesResult entitiesInDocument in entitiesInDocuments)
{
TextDocumentInput document = documents[i++];
Console.WriteLine($"On document (Id={document.Id}, Language=\"{document.Language}\"):");
if (entitiesInDocument.HasError)
{
Console.WriteLine(" Error!");
Console.WriteLine($" Document error code: {entitiesInDocument.Error.ErrorCode}.");
Console.WriteLine($" Message: {entitiesInDocument.Error.Message}");
}
else
{
Console.WriteLine($"Recognized {entitiesInDocument.Entities.Count} entities:");
foreach (LinkedEntity linkedEntity in entitiesInDocument.Entities)
{
Console.WriteLine($" Name: {linkedEntity.Name}");
Console.WriteLine($" Language: {linkedEntity.Language}");
Console.WriteLine($" Data Source: {linkedEntity.DataSource}");
Console.WriteLine($" URL: {linkedEntity.Url}");
Console.WriteLine($" Entity Id in Data Source: {linkedEntity.DataSourceEntityId}");
foreach (LinkedEntityMatch match in linkedEntity.Matches)
{
Console.WriteLine($" Match Text: {match.Text}");
Console.WriteLine($" Offset: {match.Offset}");
Console.WriteLine($" Length: {match.Length}");
Console.WriteLine($" Confidence score: {match.ConfidenceScore}");
}
Console.WriteLine("");
}
Console.WriteLine($" Document statistics:");
Console.WriteLine($" Character count: {entitiesInDocument.Statistics.CharacterCount}");
Console.WriteLine($" Transaction count: {entitiesInDocument.Statistics.TransactionCount}");
}
Console.WriteLine("");
}
Console.WriteLine($"Batch operation statistics:");
Console.WriteLine($" Document count: {entitiesInDocuments.Statistics.DocumentCount}");
Console.WriteLine($" Valid document count: {entitiesInDocuments.Statistics.ValidDocumentCount}");
Console.WriteLine($" Invalid document count: {entitiesInDocuments.Statistics.InvalidDocumentCount}");
Console.WriteLine($" Transaction count: {entitiesInDocuments.Statistics.TransactionCount}");
Console.WriteLine("");
}
public async Task AnalyzeOperationWithMultipleActions()
{
TextAnalyticsClient client = GetClient();
var batchDocuments = new List <TextDocumentInput>
{
new TextDocumentInput("1", "Microsoft was founded by Bill Gates and Paul Allen.")
{
Language = "en",
},
new TextDocumentInput("2", "Mi perro y mi gato tienen que ir al veterinario.")
{
Language = "es",
}
};
TextAnalyticsActions batchActions = new TextAnalyticsActions()
{
ExtractKeyPhrasesOptions = new List <ExtractKeyPhrasesOptions>()
{
new ExtractKeyPhrasesOptions()
},
RecognizeEntitiesOptions = new List <RecognizeEntitiesOptions>()
{
new RecognizeEntitiesOptions()
},
RecognizePiiEntitiesOptions = new List <RecognizePiiEntitiesOptions>()
{
new RecognizePiiEntitiesOptions()
},
RecognizeLinkedEntitiesOptions = new List <RecognizeLinkedEntitiesOptions>()
{
new RecognizeLinkedEntitiesOptions()
},
DisplayName = "AnalyzeOperationWithMultipleTasks"
};
AnalyzeBatchActionsOperation operation = await client.StartAnalyzeBatchActionsAsync(batchDocuments, batchActions);
Assert.AreEqual(0, operation.ActionsFailed);
Assert.AreEqual(0, operation.ActionsSucceeded);
Assert.AreEqual(0, operation.ActionsInProgress);
Assert.AreEqual(0, operation.TotalActions);
await operation.WaitForCompletionAsync(PollingInterval);
Assert.AreEqual(0, operation.ActionsFailed);
Assert.AreEqual(4, operation.ActionsSucceeded);
Assert.AreEqual(0, operation.ActionsInProgress);
Assert.AreEqual(4, operation.TotalActions);
Assert.AreNotEqual(new DateTimeOffset(), operation.CreatedOn);
Assert.AreNotEqual(new DateTimeOffset(), operation.LastModified);
Assert.AreNotEqual(new DateTimeOffset(), operation.ExpiresOn);
//Take the first page
AnalyzeBatchActionsResult resultCollection = operation.Value.ToEnumerableAsync().Result.FirstOrDefault();
RecognizeEntitiesResultCollection entitiesResult = resultCollection.RecognizeEntitiesActionsResults.ElementAt(0).Result;
ExtractKeyPhrasesResultCollection keyPhrasesResult = resultCollection.ExtractKeyPhrasesActionsResults.ElementAt(0).Result;
RecognizePiiEntitiesResultCollection piiResult = resultCollection.RecognizePiiEntitiesActionsResults.ElementAt(0).Result;
RecognizeLinkedEntitiesResultCollection entityLinkingResult = resultCollection.RecognizeLinkedEntitiesActionsResults.ElementAt(0).Result;
Assert.IsNotNull(keyPhrasesResult);
Assert.IsNotNull(entitiesResult);
Assert.IsNotNull(piiResult);
Assert.IsNotNull(entityLinkingResult);
Assert.AreEqual("AnalyzeOperationWithMultipleTasks", operation.DisplayName);
// Keyphrases
Assert.AreEqual(2, keyPhrasesResult.Count);
var keyPhrasesListId1 = new List <string> {
"Bill Gates", "Paul Allen", "Microsoft"
};
var keyPhrasesListId2 = new List <string> {
"gato", "perro", "veterinario"
};
foreach (string keyphrase in keyPhrasesResult[0].KeyPhrases)
{
Assert.IsTrue(keyPhrasesListId1.Contains(keyphrase));
}
foreach (string keyphrase in keyPhrasesResult[1].KeyPhrases)
{
Assert.IsTrue(keyPhrasesListId2.Contains(keyphrase));
}
// Entities
Assert.AreEqual(2, entitiesResult.Count);
Assert.AreEqual(3, entitiesResult[0].Entities.Count);
var entitiesList = new List <string> {
"Bill Gates", "Microsoft", "Paul Allen"
};
foreach (CategorizedEntity entity in entitiesResult[0].Entities)
{
Assert.IsTrue(entitiesList.Contains(entity.Text));
Assert.IsNotNull(entity.Category);
Assert.IsNotNull(entity.Offset);
Assert.IsNotNull(entity.ConfidenceScore);
}
// PII
Assert.AreEqual(2, entitiesResult.Count);
Assert.AreEqual(3, entitiesResult[0].Entities.Count);
Assert.IsNotNull(entitiesResult[0].Id);
Assert.IsNotNull(entitiesResult[0].Entities);
Assert.IsNotNull(entitiesResult[0].Error);
// Entity Linking
Assert.AreEqual(2, entityLinkingResult.Count);
Assert.AreEqual(3, entityLinkingResult[0].Entities.Count);
Assert.IsNotNull(entityLinkingResult[0].Id);
Assert.IsNotNull(entityLinkingResult[0].Entities);
Assert.IsNotNull(entityLinkingResult[0].Error);
foreach (LinkedEntity entity in entityLinkingResult[0].Entities)
{
if (entity.Name == "Bill Gates")
{
Assert.AreEqual("Bill Gates", entity.DataSourceEntityId);
Assert.AreEqual("Wikipedia", entity.DataSource);
}
if (entity.Name == "Microsoft")
{
Assert.AreEqual("Microsoft", entity.DataSourceEntityId);
Assert.AreEqual("Wikipedia", entity.DataSource);
}
}
}
public async Task ExtractEntityLinkingBatchConvenienceAsync()
{
string endpoint = TestEnvironment.Endpoint;
string apiKey = TestEnvironment.ApiKey;
// Instantiate a client that will be used to call the service.
var client = new TextAnalyticsClient(new Uri(endpoint), new AzureKeyCredential(apiKey), CreateSampleOptions());
string documentA = @"Microsoft was founded by Bill Gates with some friends he met at Harvard. One of his friends,
Steve Ballmer, eventually became CEO after Bill Gates as well.Steve Ballmer eventually stepped
down as CEO of Microsoft, and was succeeded by Satya Nadella.
Microsoft originally moved its headquarters to Bellevue, Washington in Januaray 1979, but is now
headquartered in Redmond";
string documentB = @"Microsoft was founded by Bill Gates and Paul Allen on April 4, 1975, to develop and
sell BASIC interpreters for the Altair 8800. During his career at Microsoft, Gates held
the positions of chairman chief executive officer, president and chief software architect
while also being the largest individual shareholder until May 2014.";
string documentC = string.Empty;
var documents = new List <string>
{
documentA,
documentB,
documentC
};
Response <RecognizeLinkedEntitiesResultCollection> response = await client.RecognizeLinkedEntitiesBatchAsync(documents);
RecognizeLinkedEntitiesResultCollection entitiesPerDocuments = response.Value;
int i = 0;
Console.WriteLine($"Results of Azure Text Analytics \"Entity Linking\", version: \"{entitiesPerDocuments.ModelVersion}\"");
Console.WriteLine("");
foreach (RecognizeLinkedEntitiesResult entitiesInDocument in entitiesPerDocuments)
{
Console.WriteLine($"On document with Text: \"{documents[i++]}\"");
Console.WriteLine("");
if (entitiesInDocument.HasError)
{
Console.WriteLine(" Error!");
Console.WriteLine($" Document error code: {entitiesInDocument.Error.ErrorCode}.");
Console.WriteLine($" Message: {entitiesInDocument.Error.Message}");
}
else
{
Console.WriteLine($"Recognized {entitiesInDocument.Entities.Count} entities:");
foreach (LinkedEntity linkedEntity in entitiesInDocument.Entities)
{
Console.WriteLine($" Name: {linkedEntity.Name}");
Console.WriteLine($" Language: {linkedEntity.Language}");
Console.WriteLine($" Data Source: {linkedEntity.DataSource}");
Console.WriteLine($" URL: {linkedEntity.Url}");
Console.WriteLine($" Entity Id in Data Source: {linkedEntity.DataSourceEntityId}");
foreach (LinkedEntityMatch match in linkedEntity.Matches)
{
Console.WriteLine($" Match Text: {match.Text}");
Console.WriteLine($" Offset: {match.Offset}");
Console.WriteLine($" Length: {match.Length}");
Console.WriteLine($" Confidence score: {match.ConfidenceScore}");
}
Console.WriteLine("");
}
}
Console.WriteLine("");
}
}
public async Task ExtractEntityLinkingBatchAsync()
{
string endpoint = TestEnvironment.Endpoint;
string apiKey = TestEnvironment.ApiKey;
// Instantiate a client that will be used to call the service.
var client = new TextAnalyticsClient(new Uri(endpoint), new AzureKeyCredential(apiKey));
var documents = new List <TextDocumentInput>
{
new TextDocumentInput("1", "Microsoft was founded by Bill Gates and Paul Allen.")
{
Language = "en",
},
new TextDocumentInput("2", "Text Analytics is one of the Azure Cognitive Services.")
{
Language = "en",
},
new TextDocumentInput("3", "Pike place market is my favorite Seattle attraction.")
{
Language = "en",
}
};
RecognizeLinkedEntitiesResultCollection results = await client.RecognizeLinkedEntitiesBatchAsync(documents, new TextAnalyticsRequestOptions { IncludeStatistics = true });
int i = 0;
Console.WriteLine($"Results of Azure Text Analytics \"Entity Linking\", version: \"{results.ModelVersion}\"");
Console.WriteLine("");
foreach (RecognizeLinkedEntitiesResult result in results)
{
TextDocumentInput document = documents[i++];
Console.WriteLine($"On document (Id={document.Id}, Language=\"{document.Language}\", Text=\"{document.Text}\"):");
if (result.HasError)
{
Console.WriteLine($" Document error code: {result.Error.ErrorCode}.");
Console.WriteLine($" Message: {result.Error.Message}.");
}
else
{
Console.WriteLine($" Extracted the following {result.Entities.Count()} linked entities:");
foreach (LinkedEntity linkedEntity in result.Entities)
{
Console.WriteLine($" Name: \"{linkedEntity.Name}\", Language: {linkedEntity.Language}, Data Source: {linkedEntity.DataSource}, Url: {linkedEntity.Url.ToString()}, Entity Id in Data Source: \"{linkedEntity.DataSourceEntityId}\"");
foreach (LinkedEntityMatch match in linkedEntity.Matches)
{
Console.WriteLine($" Match Text: \"{match.Text}\", Offset (in UTF-16 code units): {match.Offset}");
Console.WriteLine($" Confidence score: {match.ConfidenceScore}");
}
}
Console.WriteLine($" Document statistics:");
Console.WriteLine($" Character count (in Unicode graphemes): {result.Statistics.CharacterCount}");
Console.WriteLine($" Transaction count: {result.Statistics.TransactionCount}");
Console.WriteLine("");
}
}
Console.WriteLine($"Batch operation statistics:");
Console.WriteLine($" Document count: {results.Statistics.DocumentCount}");
Console.WriteLine($" Valid document count: {results.Statistics.ValidDocumentCount}");
Console.WriteLine($" Invalid document count: {results.Statistics.InvalidDocumentCount}");
Console.WriteLine($" Transaction count: {results.Statistics.TransactionCount}");
Console.WriteLine("");
}
public void AnalyzeOperationBatchConvenience()
{
string endpoint = TestEnvironment.Endpoint;
string apiKey = TestEnvironment.ApiKey;
var client = new TextAnalyticsClient(new Uri(endpoint), new AzureKeyCredential(apiKey));
#region Snippet:AnalyzeOperationBatchConvenience
string documentA = @"We love this trail and make the trip every year. The views are breathtaking and well
worth the hike! Yesterday was foggy though, so we missed the spectacular views.
We tried again today and it was amazing. Everyone in my family liked the trail although
it was too challenging for the less athletic among us.
Not necessarily recommended for small children.
A hotel close to the trail offers services for childcare in case you want that.";
string documentB = @"Last week we stayed at Hotel Foo to celebrate our anniversary. The staff knew about
our anniversary so they helped me organize a little surprise for my partner.
The room was clean and with the decoration I requested. It was perfect!";
string documentC = @"That was the best day of my life! We went on a 4 day trip where we stayed at Hotel Foo.
They had great amenities that included an indoor pool, a spa, and a bar.
The spa offered couples massages which were really good.
The spa was clean and felt very peaceful. Overall the whole experience was great.
We will definitely come back.";
var batchDocuments = new List <string>
{
documentA,
documentB,
documentC
};
TextAnalyticsActions actions = new TextAnalyticsActions()
{
ExtractKeyPhrasesOptions = new List <ExtractKeyPhrasesOptions>()
{
new ExtractKeyPhrasesOptions()
},
RecognizeEntitiesOptions = new List <RecognizeEntitiesOptions>()
{
new RecognizeEntitiesOptions()
},
RecognizePiiEntitiesOptions = new List <RecognizePiiEntitiesOptions>()
{
new RecognizePiiEntitiesOptions()
},
RecognizeLinkedEntitiesOptions = new List <RecognizeLinkedEntitiesOptions>()
{
new RecognizeLinkedEntitiesOptions()
},
DisplayName = "AnalyzeOperationSample"
};
AnalyzeBatchActionsOperation operation = client.StartAnalyzeBatchActions(batchDocuments, actions);
TimeSpan pollingInterval = new TimeSpan(1000);
while (!operation.HasCompleted)
{
Thread.Sleep(pollingInterval);
operation.UpdateStatus();
Console.WriteLine($"Status: {operation.Status}");
//If operation has not started, all other fields are null
if (operation.Status != TextAnalyticsOperationStatus.NotStarted)
{
Console.WriteLine($"Expires On: {operation.ExpiresOn}");
Console.WriteLine($"Last modified: {operation.LastModified}");
if (!string.IsNullOrEmpty(operation.DisplayName))
{
Console.WriteLine($"Display name: {operation.DisplayName}");
}
Console.WriteLine($"Total actions: {operation.TotalActions}");
Console.WriteLine($" Succeeded actions: {operation.ActionsSucceeded}");
Console.WriteLine($" Failed actions: {operation.ActionsFailed}");
Console.WriteLine($" In progress actions: {operation.ActionsInProgress}");
}
}
foreach (AnalyzeBatchActionsResult documentsInPage in operation.GetValues())
{
RecognizeEntitiesResultCollection entitiesResult = documentsInPage.RecognizeEntitiesActionsResults.FirstOrDefault().Result;
ExtractKeyPhrasesResultCollection keyPhrasesResult = documentsInPage.ExtractKeyPhrasesActionsResults.FirstOrDefault().Result;
RecognizePiiEntitiesResultCollection piiResult = documentsInPage.RecognizePiiEntitiesActionsResults.FirstOrDefault().Result;
RecognizeLinkedEntitiesResultCollection linkedEntitiesResult = documentsInPage.RecognizeLinkedEntitiesActionsResults.FirstOrDefault().Result;
Console.WriteLine("Recognized Entities");
foreach (RecognizeEntitiesResult result in entitiesResult)
{
Console.WriteLine($" Recognized the following {result.Entities.Count} entities:");
foreach (CategorizedEntity entity in result.Entities)
{
Console.WriteLine($" Entity: {entity.Text}");
Console.WriteLine($" Category: {entity.Category}");
Console.WriteLine($" Offset: {entity.Offset}");
Console.WriteLine($" Length: {entity.Length}");
Console.WriteLine($" ConfidenceScore: {entity.ConfidenceScore}");
Console.WriteLine($" SubCategory: {entity.SubCategory}");
}
Console.WriteLine("");
}
Console.WriteLine("Recognized PII Entities");
foreach (RecognizePiiEntitiesResult result in piiResult)
{
Console.WriteLine($" Recognized the following {result.Entities.Count} PII entities:");
foreach (PiiEntity entity in result.Entities)
{
Console.WriteLine($" Entity: {entity.Text}");
Console.WriteLine($" Category: {entity.Category}");
Console.WriteLine($" Offset: {entity.Offset}");
Console.WriteLine($" Length: {entity.Length}");
Console.WriteLine($" ConfidenceScore: {entity.ConfidenceScore}");
Console.WriteLine($" SubCategory: {entity.SubCategory}");
}
Console.WriteLine("");
}
Console.WriteLine("Key Phrases");
foreach (ExtractKeyPhrasesResult result in keyPhrasesResult)
{
Console.WriteLine($" Recognized the following {result.KeyPhrases.Count} Keyphrases:");
foreach (string keyphrase in result.KeyPhrases)
{
Console.WriteLine($" {keyphrase}");
}
Console.WriteLine("");
}
Console.WriteLine("Recognized Linked Entities");
foreach (RecognizeLinkedEntitiesResult result in linkedEntitiesResult)
{
Console.WriteLine($" Recognized the following {result.Entities.Count} linked entities:");
foreach (LinkedEntity entity in result.Entities)
{
Console.WriteLine($" Entity: {entity.Name}");
Console.WriteLine($" DataSource: {entity.DataSource}");
Console.WriteLine($" DataSource EntityId: {entity.DataSourceEntityId}");
Console.WriteLine($" Language: {entity.Language}");
Console.WriteLine($" DataSource Url: {entity.Url}");
Console.WriteLine($" Total Matches: {entity.Matches.Count()}");
foreach (LinkedEntityMatch match in entity.Matches)
{
Console.WriteLine($" Match Text: {match.Text}");
Console.WriteLine($" ConfidenceScore: {match.ConfidenceScore}");
Console.WriteLine($" Offset: {match.Offset}");
Console.WriteLine($" Length: {match.Length}");
}
Console.WriteLine("");
}
Console.WriteLine("");
}
}
}
