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.
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).
Parsing
- ParseRequest - used to make a parse API call. Also note the properties inherited from ParseOptions and BasicParseOptions.
- ParseResumeResponseValue & ParseJobResponseValue - the
Value
returned for a parse API call. Note the properties inherited from BaseParseResponseValue. - view all relevant classes: Textkernel.Tx.Models.API.Parsing
Matching/Searching/Bimetric Scoring
- MatchRequest & SearchRequest - used to make Matching/Searching API calls. Most notably the FilterCriteria for filtering results.
- BimetricScoreRequest - used to perform a Bimetric Score API call to score any combination of resumes/jobs.
- Matching/Searching/Bimetric Scoring all return lists of results. Each result is one of the following, depending on which API call you are using:
- IBimetricScoredResult - all Match/Bimetric Score results implement this interface.
- SearchResult - search results are not scored. Each result simply represents a document in the searched index(es) that matched the FilterCriteria.
- view all relevant classes: