update readme and examples

Author: JW Wesson

README.md

@@ -46,11 +46,32 @@ For full code examples, see [here][examples].
 ### Creating a `TxClient`
 This is the object that you will use to perform API calls. You create it with your account credentials and the `TxClient` makes the raw API calls for you. These credentials can be found in the [Tx Console][portal]. Be sure to select the correct `DataCenter` for your account.
 ```java
-TxClient client = new TxClient("12345678", "abcdefghijklmnopqrstuvwxyz", DataCenter.US);
+TxClientSettings settings = new TxClientSettings();
+settings.AccountId = "12345678";
+settings.ServiceKey = "abcdefghijklmnopqrstuvwxyz";
+settings.DataCenter = DataCenter.US;
+TxClient client = new TxClient(settings);
 ```
 
 For self-hosted customers, you can create a `DataCenter` object with your custom URL using the constructor provided on that class.
 
+### Using the various `TxClient` services
+The `TxClient` has the following services available:
+- `parser()`
+- `geocoder()`
+- `formatter()`
+- `skillsIntelligence()`
+- `searchMatchV1()`
+- `searchMatchV2()`
+
+Each service exposes certain API functionality via its methods. For example, to parse a resume you would do something like:
+```java
+TxClient client;//created or injected however
+ParseResumeResponse parseResponse = client.parser().parseResume(...);
+```
+
+For the complete list of methods on each service and their method signatures, check out our [online Javadoc][javadoc_url].
+
 ### Handling errors and the `TxException`
 Every call to any of the methods in the `TxClient` should be wrapped in a `try/catch` block. Any 4xx/5xx level errors will cause a `TxException` to be thrown. Sometimes these are a normal and expected part of the Tx API. For example, if you have a website where users upload resumes, sometimes a user will upload a scanned image as their resume. Textkernel does not process these, and will return a `422 Unprocessable Entity` response which will throw a `TxException`. You should handle any `TxException` in a way that makes sense in your application.
 

examples/indexing/Create an Index and Add Documents.md

@@ -8,17 +8,21 @@ import com.textkernel.tx.models.resume.ParsedResume;
 
 public class ParsingExample {
     public static void main(String[] args) {
-        TxClient client = new TxClient("12345678", "abcdefghijklmnopqrstuvwxyz", DataCenter.US);
+        TxClientSettings settings = new TxClientSettings();
+        settings.AccountId = "12345678";
+        settings.ServiceKey = "abcdefghijklmnopqrstuvwxyz";
+        settings.DataCenter = DataCenter.US;
+        TxClient client = new TxClient(settings);
 
         ParsedResume parsedResume1 = ...;//output from Resume Parser
         ParsedResume parsedResume2 = ...;//output from Resume Parser
 
         String indexId = "myResumes";
 
         try {
-            client.createIndex(IndexType.Resume, indexId);
-            client.indexDocument(parsedResume1, indexId, "resume-1", null);
-            client.indexDocument(parsedResume2, indexId, "resume-2", null);
+            client.searchMatchV1().createIndex(IndexType.Resume, indexId);
+            client.searchMatchV1().indexDocument(parsedResume1, indexId, "resume-1", null);
+            client.searchMatchV1().indexDocument(parsedResume2, indexId, "resume-2", null);
 
             //if we get here, it was 200-OK and all operations succeeded
             System.out.println("Success!");

examples/parsing/Basic Parsing.md

@@ -21,7 +21,11 @@ import java.time.format.DateTimeFormatter;
 
 public class ParsingExample {
     public static void main(String[] args) throws IOException {
-        TxClient client = new TxClient("12345678", "abcdefghijklmnopqrstuvwxyz", DataCenter.US);
+        TxClientSettings settings = new TxClientSettings();
+        settings.AccountId = "12345678";
+        settings.ServiceKey = "abcdefghijklmnopqrstuvwxyz";
+        settings.DataCenter = DataCenter.US;
+        TxClient client = new TxClient(settings);
 
         //A Document is an unparsed File (PDF, Word Doc, etc)
         Document doc = new Document("resume.docx");
@@ -31,7 +35,7 @@ public class ParsingExample {
         ParseRequest request = new ParseRequest(doc, new ParseOptions());
 
         try {
-            ParseResumeResponse response = client.parseResume(request);
+            ParseResumeResponse response = client.parser().parseResume(request);
             //if we get here, it was 200-OK and all operations succeeded
 
             //now we can use the response to output some of the data from the resume

examples/parsing/Parsing With Geocoding and Indexing.md

@@ -7,15 +7,19 @@ import com.textkernel.tx.exceptions.TxUsableResumeException;
 import com.textkernel.tx.models.Document;
 import com.textkernel.tx.models.api.geocoding.GeocodeOptions;
 import com.textkernel.tx.models.api.geocoding.GeocodeProvider;
-import com.textkernel.tx.models.api.indexes.IndexSingleDocumentInfo;
+import com.textkernel.tx.models.api.indexes.IndexingOptionsGeneric;
 import com.textkernel.tx.models.api.parsing.ParseOptions;
 import com.textkernel.tx.models.api.parsing.ParseRequest;
 import com.textkernel.tx.models.api.parsing.ParseResumeResponse;
 import java.io.IOException;
 
 public class ParsingExample {
     public static void main(String[] args) throws IOException {
-        TxClient client = new TxClient("12345678", "abcdefghijklmnopqrstuvwxyz", DataCenter.US);
+        TxClientSettings settings = new TxClientSettings();
+        settings.AccountId = "12345678";
+        settings.ServiceKey = "abcdefghijklmnopqrstuvwxyz";
+        settings.DataCenter = DataCenter.US;
+        TxClient client = new TxClient(settings);
 
         //A Document is an unparsed File (PDF, Word Doc, etc)
         Document doc = new Document("resume.docx");
@@ -24,15 +28,13 @@ public class ParsingExample {
         options.GeocodeOptions = new GeocodeOptions();
         options.GeocodeOptions.IncludeGeocoding = true;
 
-        options.IndexingOptions = new IndexSingleDocumentInfo();
-        options.IndexingOptions.IndexId = "myResumes";
-        options.IndexingOptions.DocumentId = "abc-123";
+        options.IndexingOptions = new IndexingOptionsGeneric("abc-123", "myResumes", null);
 
         //create a request to send
         ParseRequest request = new ParseRequest(doc, options);
 
         try {
-            ParseResumeResponse response = client.parseResume(request);
+            ParseResumeResponse response = client.parser().parseResume(request);
             //if we get here, it was 200-OK and all operations succeeded
 
             System.out.println("Success!");