Click on the Browse tab and search for "APIVerve.API.TextSimilarity"
Click on the APIVerve.API.TextSimilarity package, select the appropriate version in the right-tab and click Install
Configuration
Before using the textsimilarity API client, you have to setup your account and obtain your API Key.
You can get it by signing up at https://apiverve.com
Quick Start
Here's a simple example to get you started quickly:
using System;
using APIVerve;
class Program
{
static async Task Main(string[] args)
{
// Initialize the API client
var apiClient = new TextSimilarityAPIClient("[YOUR_API_KEY]");
var queryOptions = new QueryOptions {
text1 = "I'm so excited that tomorrow is going to be sunny! Can't wait!",
text2 = "We're pretty excited about the weather tomorrow. It's going to be sunny!"
};
// Make the API call
try
{
var response = await apiClient.ExecuteAsync(queryOptions);
if (response.Error != null)
{
Console.WriteLine($"API Error: {response.Error}");
}
else
{
Console.WriteLine("Success!");
// Access response data using the strongly-typed ResponseObj properties
Console.WriteLine(Newtonsoft.Json.JsonConvert.SerializeObject(response, Newtonsoft.Json.Formatting.Indented));
}
}
catch (Exception ex)
{
Console.WriteLine($"Exception: {ex.Message}");
}
}
}
TextSimilarity API uses API Key-based authentication. When you create an instance of the API client, you can pass your API Key as a parameter.
// Create an instance of the API client
var apiClient = new TextSimilarityAPIClient("[YOUR_API_KEY]");
Usage Examples
Basic Usage (Async/Await Pattern - Recommended)
The modern async/await pattern provides the best performance and code readability:
using System;
using System.Threading.Tasks;
using APIVerve;
public class Example
{
public static async Task Main(string[] args)
{
var apiClient = new TextSimilarityAPIClient("[YOUR_API_KEY]");
var queryOptions = new QueryOptions {
text1 = "I'm so excited that tomorrow is going to be sunny! Can't wait!",
text2 = "We're pretty excited about the weather tomorrow. It's going to be sunny!"
};
var response = await apiClient.ExecuteAsync(queryOptions);
if (response.Error != null)
{
Console.WriteLine($"Error: {response.Error}");
}
else
{
Console.WriteLine(Newtonsoft.Json.JsonConvert.SerializeObject(response, Newtonsoft.Json.Formatting.Indented));
}
}
}
Synchronous Usage
If you need to use synchronous code, you can use the Execute method:
using System;
using APIVerve;
public class Example
{
public static void Main(string[] args)
{
var apiClient = new TextSimilarityAPIClient("[YOUR_API_KEY]");
var queryOptions = new QueryOptions {
text1 = "I'm so excited that tomorrow is going to be sunny! Can't wait!",
text2 = "We're pretty excited about the weather tomorrow. It's going to be sunny!"
};
var response = apiClient.Execute(queryOptions);
if (response.Error != null)
{
Console.WriteLine($"Error: {response.Error}");
}
else
{
Console.WriteLine(Newtonsoft.Json.JsonConvert.SerializeObject(response, Newtonsoft.Json.Formatting.Indented));
}
}
}
Error Handling
The API client provides comprehensive error handling. Here are some examples:
Handling API Errors
using System;
using System.Threading.Tasks;
using APIVerve;
public class Example
{
public static async Task Main(string[] args)
{
var apiClient = new TextSimilarityAPIClient("[YOUR_API_KEY]");
var queryOptions = new QueryOptions {
text1 = "I'm so excited that tomorrow is going to be sunny! Can't wait!",
text2 = "We're pretty excited about the weather tomorrow. It's going to be sunny!"
};
try
{
var response = await apiClient.ExecuteAsync(queryOptions);
// Check for API-level errors
if (response.Error != null)
{
Console.WriteLine($"API Error: {response.Error}");
Console.WriteLine($"Status: {response.Status}");
return;
}
// Success - use the data
Console.WriteLine("Request successful!");
Console.WriteLine(Newtonsoft.Json.JsonConvert.SerializeObject(response, Newtonsoft.Json.Formatting.Indented));
}
catch (ArgumentException ex)
{
// Invalid API key or parameters
Console.WriteLine($"Invalid argument: {ex.Message}");
}
catch (System.Net.Http.HttpRequestException ex)
{
// Network or HTTP errors
Console.WriteLine($"Network error: {ex.Message}");
}
catch (Exception ex)
{
// Other errors
Console.WriteLine($"Unexpected error: {ex.Message}");
}
}
}
Comprehensive Error Handling with Retry Logic
using System;
using System.Threading.Tasks;
using APIVerve;
public class Example
{
public static async Task Main(string[] args)
{
var apiClient = new TextSimilarityAPIClient("[YOUR_API_KEY]");
// Configure retry behavior (max 3 retries)
apiClient.SetMaxRetries(3); // Retry up to 3 times (default: 0, max: 3)
apiClient.SetRetryDelay(2000); // Wait 2 seconds between retries
var queryOptions = new QueryOptions {
text1 = "I'm so excited that tomorrow is going to be sunny! Can't wait!",
text2 = "We're pretty excited about the weather tomorrow. It's going to be sunny!"
};
try
{
var response = await apiClient.ExecuteAsync(queryOptions);
if (response.Error != null)
{
Console.WriteLine($"API Error: {response.Error}");
}
else
{
Console.WriteLine("Success!");
Console.WriteLine(Newtonsoft.Json.JsonConvert.SerializeObject(response, Newtonsoft.Json.Formatting.Indented));
}
}
catch (Exception ex)
{
Console.WriteLine($"Failed after retries: {ex.Message}");
}
}
}
Advanced Features
Custom Headers
Add custom headers to your requests:
var apiClient = new TextSimilarityAPIClient("[YOUR_API_KEY]");
// Add custom headers
apiClient.AddCustomHeader("X-Custom-Header", "custom-value");
apiClient.AddCustomHeader("X-Request-ID", Guid.NewGuid().ToString());
var queryOptions = new QueryOptions {
text1 = "I'm so excited that tomorrow is going to be sunny! Can't wait!",
text2 = "We're pretty excited about the weather tomorrow. It's going to be sunny!"
};
var response = await apiClient.ExecuteAsync(queryOptions);
// Remove a header
apiClient.RemoveCustomHeader("X-Custom-Header");
// Clear all custom headers
apiClient.ClearCustomHeaders();
Request Logging
Enable logging for debugging:
var apiClient = new TextSimilarityAPIClient("[YOUR_API_KEY]", isDebug: true);
// Or use a custom logger
apiClient.SetLogger(message =>
{
Console.WriteLine($"[LOG] {DateTime.Now:yyyy-MM-dd HH:mm:ss} - {message}");
});
var queryOptions = new QueryOptions {
text1 = "I'm so excited that tomorrow is going to be sunny! Can't wait!",
text2 = "We're pretty excited about the weather tomorrow. It's going to be sunny!"
};
var response = await apiClient.ExecuteAsync(queryOptions);
Retry Configuration
Customize retry behavior for failed requests:
var apiClient = new TextSimilarityAPIClient("[YOUR_API_KEY]");
// Set retry options
apiClient.SetMaxRetries(3); // Retry up to 3 times (default: 0, max: 3)
apiClient.SetRetryDelay(1500); // Wait 1.5 seconds between retries (default: 1000ms)
var queryOptions = new QueryOptions {
text1 = "I'm so excited that tomorrow is going to be sunny! Can't wait!",
text2 = "We're pretty excited about the weather tomorrow. It's going to be sunny!"
};
var response = await apiClient.ExecuteAsync(queryOptions);
Dispose Pattern
The API client implements IDisposable for proper resource cleanup:
var queryOptions = new QueryOptions {
text1 = "I'm so excited that tomorrow is going to be sunny! Can't wait!",
text2 = "We're pretty excited about the weather tomorrow. It's going to be sunny!"
};
using (var apiClient = new TextSimilarityAPIClient("[YOUR_API_KEY]"))
{
var response = await apiClient.ExecuteAsync(queryOptions);
Console.WriteLine(Newtonsoft.Json.JsonConvert.SerializeObject(response, Newtonsoft.Json.Formatting.Indented));
}
// HttpClient is automatically disposed here
Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:
The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
