Class TxClient

The SDK client to perform Tx API calls.

Inheritance
System.Object
TxClient
Implements
System.IDisposable
Inherited Members
System.Object.Equals(System.Object)
System.Object.Equals(System.Object, System.Object)
System.Object.GetHashCode()
System.Object.GetType()
System.Object.MemberwiseClone()
System.Object.ReferenceEquals(System.Object, System.Object)
System.Object.ToString()
Namespace: Textkernel.Tx
Assembly: Textkernel.Tx.SDK.dll
Syntax
public class TxClient : ITxClient, IDisposable

Constructors

| Improve this Doc View Source

TxClient(HttpClient, TxClientSettings)

This constructor allows the user to specify the HttpClient to use. For best practices, see here.
Here is an example of how to inject a TxClient with DI:

var builder = WebApplication.CreateBuilder(args);
builder.Services.AddSingleton(_ => new TxClientSettings
{
    AccountId = "12345678",
    ...
});
//requires Microsoft.Extensions.Http package
builder.Services.AddHttpClient<ITxClient, TxClient>();

//now you can retrieve your injected client from the service provider
TxClient client = builder.Services.GetRequiredService<TxClient>();
Declaration
public TxClient(HttpClient httpClient, TxClientSettings settings)
Parameters
Type Name Description
System.Net.Http.HttpClient httpClient

The HttpClient to use
TxClientSettings settings

The settings for this client

Properties

| Improve this Doc View Source

Formatter

Contains all endpoints/methods for the Resume Formatter

Declaration
public IFormatterService Formatter { get; }
Property Value
Type Description
IFormatterService
| Improve this Doc View Source

Geocoder

Contains all endpoints/methods for the Geocoder

Declaration
public IGeocoderService Geocoder { get; }
Property Value
Type Description
IGeocoderService
| Improve this Doc View Source

Parser

Contains all endpoints/methods for the Resume & Job Parsers

Declaration
public IParserService Parser { get; }
Property Value
Type Description
IParserService
| Improve this Doc View Source

SearchMatchV1

Contains all endpoints/methods for Search & Match

Declaration
public ISearchMatchService SearchMatchV1 { get; }
Property Value
Type Description
ISearchMatchService
| Improve this Doc View Source

SearchMatchV2

Contains all endpoints/methods for Match V2

Declaration
public IMatchV2Service SearchMatchV2 { get; set; }
Property Value
Type Description
IMatchV2Service
| Improve this Doc View Source

ShowFullRequestBodyInExceptions

Set to true for debugging API errors. It will show the full JSON request body in RequestBody
NOTE: do not set this to true in your production system, as it increases the memory footprint

Declaration
public static bool ShowFullRequestBodyInExceptions { get; set; }
Property Value
Type Description
System.Boolean
| Improve this Doc View Source

SkillsIntelligence

Contains all endpoints/methods for Skills Intelligence

Declaration
public ISkillsIntelligenceClient SkillsIntelligence { get; }
Property Value
Type Description
ISkillsIntelligenceClient

Methods

| Improve this Doc View Source

Dispose()

Disposes this object and the contained HttpClient

Declaration
public void Dispose()
| Improve this Doc View Source

GetAccountInfo()

Get the account info (remaining credits, max concurrency, etc).

Declaration
public async Task<GetAccountInfoResponse> GetAccountInfo()
Returns
Type Description
System.Threading.Tasks.Task<GetAccountInfoResponse>
Exceptions
Type Condition
TxException

Thrown when an API error occurs

Implements

System.IDisposable