Textkernel Tx .NET SDK Documentation

This is the auto-generated (by DocFX) documentation for the SDK codebase. If you were looking for best-practices, transaction costs, or other API documentation, you can find that here.

You can also go back to the GitHub project page for more usage information and examples.

Basics

• TxClient - the core class of the SDK. It is used to make all of the API calls.
• DataCenter - used to point the TxClient at the correct data center for your account.
• TxException - the TxClient will throw these during normal operations, for example, when you try to parse a resume that is a scanned image. See the GitHub project page for more information and examples.

Services

• Parser - provides all parsing functionality.
• Geocoder - determines geocoordinates based on addresses.
• Formatter - transforms a parsed resume into a standard/templated format.
• SkillsIntelligence - provides all Skills Intelligence functionality.
• SearchMatchV1 - provides all Search & Match V1 functionality.
• SearchMatchV2 - provides all Search & Match V2 functionality.

Core Models

• Document - represents an unparsed resume/job, such as a file on the file system or a byte[] in a database. This is what you pass to the TxClient for parsing.
• ParsedResume - contains all of the properties/information that is extracted when a resume/cv is parsed.
• ParsedJob - contains all of the properties/information that is extracted when a job description is parsed.
• ApiResponseInfo - returned with every API call, this contains information about the transaction (error messages, cost, duration, account information, etc).