public async Task RecognizeLinkedEntitiesBatchConvenienceTest()
{
TextAnalyticsClient client = GetClient();
var documents = batchConvenienceDocuments;
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 void RecognizeLinkedEntitiesBatchWithInvalidDocumentBatch()
{
TextAnalyticsClient client = GetClient();
var documents = new List <string>
{
"Microsoft was founded by Bill Gates and Paul Allen.",
"Hello world",
"Pike place market is my favorite Seattle attraction.",
"I had a wonderful trip to Seattle last week and even visited the Space Needle 2 times!",
"Unfortunately, it rained during my entire trip to Seattle. I didn't even get to visit the Space Needle",
"This should fail!"
};
RequestFailedException ex = Assert.ThrowsAsync <RequestFailedException>(
async() => await client.RecognizeLinkedEntitiesBatchAsync(documents));
Assert.AreEqual(400, ex.Status);
Assert.AreEqual(TextAnalyticsErrorCode.InvalidDocumentBatch, ex.ErrorCode);
}
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 RecognizeLinkedEntitiesBatchConvenienceWithStatisticsTest()
{
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, "en", 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 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);
}
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 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));
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}\", Offset (in UTF-16 code units): {match.Offset}");
Console.WriteLine($" Confidence score: {match.ConfidenceScore}");
}
}
Console.WriteLine("");
}
}
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 void RecognizeLinkedEntitiesBatchWithNullIdTest()
{
TextAnalyticsClient client = GetClient();
var documents = new List <TextDocumentInput> {
new TextDocumentInput(null, "Hello world")
};
RequestFailedException ex = Assert.ThrowsAsync <RequestFailedException>(async() => await client.RecognizeLinkedEntitiesBatchAsync(documents));
Assert.AreEqual(TextAnalyticsErrorCode.InvalidDocument, ex.ErrorCode);
}
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 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("");
}
