Skip to content

IDisposable implemented. Web proxy option. Constants made public. #1

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
sbohmig wants to merge 3 commits into
base: master
Choose a base branch
from
Open

IDisposable implemented. Web proxy option. Constants made public. #1

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
2a2a4be
IDisposable implemented. Web proxy parameter. Constants made public f…
sbohmig Dec 5, 2019
27efddf
Update RequestParameter.cs
sbohmig Dec 5, 2019
253b07d
Added custom field at the discretion of user.
sbohmig Dec 5, 2019
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
7 changes: 7 additions & 0 deletions CognitiveServices.Translator.Client/Translate/RequestContent.cs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -25,5 +25,12 @@ public string Text
_text = value;
}
}


/// <summary>
/// User optional key
/// </summary>
public int Key { get; set; }

}
}
2 changes: 1 addition & 1 deletion CognitiveServices.Translator.Client/Translate/RequestParameter.cs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -40,7 +40,7 @@ public RequestParameter()
/// A string specifying the category (domain) of the translation. This parameter
/// is used to get translations from a customized system built with Microsoft Translator Hub. Default value is: general.
/// </summary>
public string Category => "general";
public string Category { get; set; } = "general";

/// <summary>
/// Specifies how profanities should be treated in translations. Possible values
Expand Down
260 changes: 140 additions & 120 deletions CognitiveServices.Translator.Client/TranslateClient.cs
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,6 +1,7 @@
using System;
using System;
using System.Collections.Generic;
using System.Linq;
using System.Net;
using System.Net.Http;
using System.Text;
using System.Threading.Tasks;
Expand All @@ -10,123 +11,142 @@

namespace CognitiveServices.Translator
{
/// <summary>
/// Translate using cognitive service from Microsoft
/// </summary>
/// <seealso cref="ITranslateClient" />
/// <remarks>https://docs.microsoft.com/en-us/azure/cognitive-services/translator/quickstarts/csharp</remarks>
public class TranslateClient : ITranslateClient
{
private const int MaxNumberOfRequestContent = 25;
private const int MaxNumberOfCharacterPerRequest = 5_000;
private const string UriExtensionPath = "translate";

private readonly CognitiveServicesConfig _cognitiveServiceConfig = new CognitiveServicesConfig();
private readonly HttpClient _httpClient;

/// <summary>
/// Initializes a new instance of the <see cref="TranslateClient" /> class.
/// </summary>
/// <param name="logger">The logger.</param>
/// <param name="cognitiveServiceConfig">The cognitive service configuration.</param>
public TranslateClient(CognitiveServicesConfig cognitiveServiceConfig)
{
_cognitiveServiceConfig = cognitiveServiceConfig;

// In Core 2.1, we can use what is described in: https://docs.microsoft.com/en-gb/aspnet/core/fundamentals/http-requests?view=aspnetcore-2.1
// Otherwise, maybe use RestSharp?
_httpClient = new HttpClient
{
BaseAddress = new Uri(Constants.TranslatorApiBasePath)
};
}

/// <summary>
/// Translates the content.
/// </summary>
/// <param name="content">The content. (Max.: 25 items)</param>
/// <param name="options">The options.</param>
/// <returns>
/// The translated content
/// </returns>
public IList<ResponseBody> Translate(IEnumerable<RequestContent> content, RequestParameter options)
{
return TranslateAsync(content, options).Result;
}

/// <summary>
/// Translates the content.
/// </summary>
/// <param name="content">The content. (Max.: 25 items)</param>
/// <param name="options">The options.</param>
/// <returns>
/// The translated content
/// </returns>
public IList<ResponseBody> Translate(RequestContent content, RequestParameter options)
{
return TranslateAsync(new[] { content }, options).Result;
}

/// <summary>
/// Translates the content.
/// </summary>
/// <param name="content">The content. (Max.: 25 items)</param>
/// <param name="options">The options.</param>
/// <returns>
/// The translated content
/// </returns>
public async Task<IList<ResponseBody>> TranslateAsync(IEnumerable<RequestContent> content, RequestParameter options)
{
if (content.Count() > MaxNumberOfRequestContent)
throw new Exception($"Maximum amount of text to be translated have been reached (Max: {MaxNumberOfRequestContent})");
else if (string.Join(string.Empty, content).Length > MaxNumberOfCharacterPerRequest)
throw new Exception($"Maximum length of all the text to be translated is {MaxNumberOfCharacterPerRequest} characters.");

var qs = options.ToQueryString();

using (var request = new HttpRequestMessage(HttpMethod.Post, $"{UriExtensionPath}?{qs}"))
{
var requestBody = JsonConvert.SerializeObject(content.ToList());

// For the request, don't forget the request header stuff.
request.Content = new StringContent(requestBody, Encoding.UTF8, Constants.RequestMediaType);
// Todo We should be alternating between the subscription key. When we detect it's not working.
request.Headers.Add(Constants.RequestHeaderSubscriptionKey, _cognitiveServiceConfig.SubscriptionKey);

using (var response = await _httpClient.SendAsync(request).ConfigureAwait(false))
{
if (response.IsSuccessStatusCode)
{
var responseBody = await response.Content.ReadAsStringAsync();
var result = JsonConvert.DeserializeObject<List<ResponseBody>>(responseBody);

return result;
}
else
{
var message = $"Problem happened during translation. " +
$"Status code: {response.StatusCode}, " +
$"Reason: {response.ReasonPhrase}";

var exception = new TranslateException(message);
exception.ParseResponseError(response);
throw exception;
}
}
}
}

/// <summary>
/// Translates the content.
/// </summary>
/// <param name="content">The content. (Max.: 25 items)</param>
/// <param name="options">The options.</param>
/// <returns>
/// The translated content
/// </returns>
public Task<IList<ResponseBody>> TranslateAsync(RequestContent content, RequestParameter options)
{
return TranslateAsync(new[] { content }, options);
}
}
/// <summary>
/// Translate using cognitive service from Microsoft
/// </summary>
/// <seealso cref="ITranslateClient" />
/// <remarks>https://docs.microsoft.com/en-us/azure/cognitive-services/translator/quickstarts/csharp</remarks>
public class TranslateClient : ITranslateClient, IDisposable
{
private const string UriExtensionPath = "translate";

private readonly CognitiveServicesConfig _cognitiveServiceConfig = new CognitiveServicesConfig();
private HttpClient _httpClient;



public const int MaxNumberOfRequestContent = 25;
public const int MaxNumberOfCharacterPerRequest = 5_000;



/// <summary>
/// Initializes a new instance of the <see cref="TranslateClient" /> class.
/// </summary>
/// <param name="logger">The logger.</param>
/// <param name="cognitiveServiceConfig">The cognitive service configuration.</param>
public TranslateClient(CognitiveServicesConfig cognitiveServiceConfig, IWebProxy proxy = null)
{
_cognitiveServiceConfig = cognitiveServiceConfig;


proxy = proxy ?? WebRequest.DefaultWebProxy;
var handler = new HttpClientHandler()
{
Proxy = proxy,
UseProxy = proxy != WebRequest.DefaultWebProxy
};


// In Core 2.1, we can use what is described in: https://docs.microsoft.com/en-gb/aspnet/core/fundamentals/http-requests?view=aspnetcore-2.1
// Otherwise, maybe use RestSharp?
_httpClient = new HttpClient(handler, true);
_httpClient.BaseAddress = new Uri(Constants.TranslatorApiBasePath);
}

/// <summary>
/// Translates the content.
/// </summary>
/// <param name="content">The content. (Max.: 25 items)</param>
/// <param name="options">The options.</param>
/// <returns>
/// The translated content
/// </returns>
public IList<ResponseBody> Translate(IEnumerable<RequestContent> content, RequestParameter options)
{
return TranslateAsync(content, options).Result;
}

/// <summary>
/// Translates the content.
/// </summary>
/// <param name="content">The content. (Max.: 25 items)</param>
/// <param name="options">The options.</param>
/// <returns>
/// The translated content
/// </returns>
public IList<ResponseBody> Translate(RequestContent content, RequestParameter options)
{
return TranslateAsync(new[] { content }, options).Result;
}

/// <summary>
/// Translates the content.
/// </summary>
/// <param name="content">The content. (Max.: 25 items)</param>
/// <param name="options">The options.</param>
/// <returns>
/// The translated content
/// </returns>
public async Task<IList<ResponseBody>> TranslateAsync(IEnumerable<RequestContent> content, RequestParameter options)
{
if (content.Count() > MaxNumberOfRequestContent)
throw new Exception($"Maximum amount of text to be translated have been reached (Max: {MaxNumberOfRequestContent})");
else if (string.Join(string.Empty, content).Length > MaxNumberOfCharacterPerRequest)
throw new Exception($"Maximum length of all the text to be translated is {MaxNumberOfCharacterPerRequest} characters.");

var qs = options.ToQueryString();

using (var request = new HttpRequestMessage(HttpMethod.Post, $"{UriExtensionPath}?{qs}"))
{
var requestBody = JsonConvert.SerializeObject(content.ToList());

// For the request, don't forget the request header stuff.
request.Content = new StringContent(requestBody, Encoding.UTF8, Constants.RequestMediaType);
// Todo We should be alternating between the subscription key. When we detect it's not working.
request.Headers.Add(Constants.RequestHeaderSubscriptionKey, _cognitiveServiceConfig.SubscriptionKey);

using (var response = await _httpClient.SendAsync(request).ConfigureAwait(false))
{
if (response.IsSuccessStatusCode)
{
var responseBody = await response.Content.ReadAsStringAsync();
var result = JsonConvert.DeserializeObject<List<ResponseBody>>(responseBody);
return result;
}
else
{
var message = $"Problem happened during translation. " +
$"Status code: {response.StatusCode}, " +
$"Reason: {response.ReasonPhrase}";

var exception = new TranslateException(message);
exception.ParseResponseError(response);
throw exception;
}
}
}
}

/// <summary>
/// Translates the content.
/// </summary>
/// <param name="content">The content. (Max.: 25 items)</param>
/// <param name="options">The options.</param>
/// <returns>
/// The translated content
/// </returns>
public Task<IList<ResponseBody>> TranslateAsync(RequestContent content, RequestParameter options)
{
return TranslateAsync(new[] { content }, options);
}


public void Dispose()
{
_httpClient?.Dispose();
_httpClient = null;
}

}
}