Skip to content

Commit 92cd196

Browse files
Merge pull request #71 from textkernel/update-docs
update docfx index page
2 parents 61393d5 + bd86537 commit 92cd196

File tree

1 file changed

+8
-15
lines changed

1 file changed

+8
-15
lines changed

docfx/sdk/index.md

Lines changed: 8 additions & 15 deletions
Original file line numberDiff line numberDiff line change
@@ -10,25 +10,18 @@ You can also go back to the [GitHub project page](https://github.com/textkernel/
1010
- @"Textkernel.Tx.DataCenter" - used to point the @"Textkernel.Tx.TxClient" at the correct data center for your account.
1111
- @"Textkernel.Tx.TxException" - the @"Textkernel.Tx.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.
1212

13+
## Services
14+
- @"Textkernel.Tx.TxClient.Parser" - provides all parsing functionality.
15+
- @"Textkernel.Tx.TxClient.Geocoder" - determines geocoordinates based on addresses.
16+
- @"Textkernel.Tx.TxClient.Formatter" - transforms a parsed resume into a standard/templated format.
17+
- @"Textkernel.Tx.TxClient.SkillsIntelligence" - provides all Skills Intelligence functionality.
18+
- @"Textkernel.Tx.TxClient.SearchMatchV1" - provides all Search & Match V1 functionality.
19+
- @"Textkernel.Tx.TxClient.SearchMatchV2" - provides all Search & Match V2 functionality.
20+
1321
## Core Models
1422
- @"Textkernel.Tx.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 @"Textkernel.Tx.TxClient" for parsing.
1523
- @"Textkernel.Tx.Models.Resume.ParsedResume" - contains all of the properties/information that is extracted when a resume/cv is parsed.
1624
- @"Textkernel.Tx.Models.Job.ParsedJob" - contains all of the properties/information that is extracted when a job description is parsed.
1725
- @"Textkernel.Tx.Models.API.ApiResponseInfo" - returned with every API call, this contains information about the transaction (error messages, cost, duration, account information, etc).
1826

19-
## Parsing
20-
- @"Textkernel.Tx.Models.API.Parsing.ParseRequest" - used to make a parse API call. Also note the properties inherited from @"Textkernel.Tx.Models.API.Parsing.ParseOptions" and @"Textkernel.Tx.Models.API.Parsing.BasicParseOptions".
21-
- @"Textkernel.Tx.Models.API.Parsing.ParseResumeResponseValue" & @"Textkernel.Tx.Models.API.Parsing.ParseJobResponseValue" - the <code>Value</code> returned for a parse API call. Note the properties inherited from @"Textkernel.Tx.Models.API.Parsing.BaseParseResponseValue".
22-
- view all relevant classes: @"Textkernel.Tx.Models.API.Parsing"
2327

24-
## Matching/Searching/Bimetric Scoring
25-
- @"Textkernel.Tx.Models.API.Matching.Request.MatchRequest" & @"Textkernel.Tx.Models.API.Matching.SearchRequest" - used to make Matching/Searching API calls. Most notably the @"Textkernel.Tx.Models.API.Matching.Request.FilterCriteria" for filtering results.
26-
- @"Textkernel.Tx.Models.API.BimetricScoring.BimetricScoreRequest" - used to perform a Bimetric Score API call to score any combination of resumes/jobs.
27-
- Matching/Searching/Bimetric Scoring all return lists of results. Each result is one of the following, depending on which API call you are using:
28-
- @"Textkernel.Tx.Models.API.Matching.Response.IBimetricScoredResult" - all Match/Bimetric Score results implement this interface.
29-
- @"Textkernel.Tx.Models.API.Matching.Response.SearchResult" - search results are not scored. Each result simply represents a document in the searched index(es) that matched the @"Textkernel.Tx.Models.API.Matching.Request.FilterCriteria".
30-
- view all relevant classes:
31-
- @"Textkernel.Tx.Models.API.Matching"
32-
- @"Textkernel.Tx.Models.API.Matching.Request"
33-
- @"Textkernel.Tx.Models.API.Matching.Response"
34-
- @"Textkernel.Tx.Models.API.BimetricScoring"

0 commit comments

Comments
 (0)