Skip to content

Commit 098747a

Browse files
mfriesenmfriesen
committed
Added 'contentUrls' to GetDocumentOcrResponse
1 parent 2fa3923 commit 098747a

185 files changed

Lines changed: 353 additions & 1320 deletions

File tree

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

‎.openapi-generator/VERSION‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1 +1 @@
1-
7.1.0
1+
7.2.0

‎api/openapi.yaml‎

Lines changed: 29 additions & 17 deletions
Original file line numberDiff line numberDiff line change
@@ -1868,7 +1868,9 @@ paths:
18681868
\ Composite Keys feature then multiple tag(s) can be searched for.\n\nIf Typesense\
18691869
\ is enabled, full text search is supported through the \"text\" parameter.\
18701870
\ Full text search will look for the text in the \"content\" and/or document\
1871-
\ \"metadata\".\n\nSee requestBody examples below for commmon examples."
1871+
\ \"metadata\".\n\nDocumentIds parameter allows you to filter your results\
1872+
\ to a specific set of documents. \n\nSee requestBody examples below for commmon\
1873+
\ examples."
18721874
operationId: DocumentSearch
18731875
parameters:
18741876
- description: Site Identifier
@@ -2115,24 +2117,26 @@ paths:
21152117
description: |-
21162118
Add one or more actions to a document; this appends actions and does not replace previous actions
21172119
2120+
Each action type supports a different set of parameters as shown in the table below:
2121+
21182122
### Action Parameters
21192123
2120-
| ActionType | Parameter | Description |
2121-
| -------- | ------- | ------- |
2122-
| OCR | ocrParseTypes | Ocr Parsing strategy to use |
2123-
| OCR | ocrEngine | Ocr Engine to use |
2124-
| OCR | addPdfDetectedCharactersAsText | PDF Documents convert images to text |
2125-
| FULLTEXT | characterMax | Maximum number of characters to add to Fulltext destination |
2126-
| DOCUMENTTAGGING | engine | Tagging Engine to use |
2127-
| DOCUMENTTAGGING | tags | Comma-deliminted list of keywords |
2128-
| WEBHOOK | url | Webhook URL |
2129-
| NOTIFICATION | notificationType | Type of Notification |
2130-
| NOTIFICATION | notificationToCc | Notification Carbon Copy |
2131-
| NOTIFICATION | notificationToBcc | Notification Blind Carbon Copy |
2132-
| NOTIFICATION | notificationSubject | Notification Subject |
2133-
| NOTIFICATION | notificationText | Notification as Text |
2134-
| NOTIFICATION | notificationHtml | Notification as Html |
2135-
| QUEUE | queueName | Name of Queue |
2124+
| ActionType | Parameter | Description | Example |
2125+
| -------- | ------- | ------- | ------- |
2126+
| OCR | ocrParseTypes | Ocr Parsing strategy to use | TEXT, FORMS, TABLES |
2127+
| OCR | ocrEngine | Ocr Engine to use | tesseract or textract |
2128+
| OCR | addPdfDetectedCharactersAsText | PDF Documents convert images to text | true or false |
2129+
| FULLTEXT | characterMax | Maximum number of characters to add to Fulltext destination | -1 |
2130+
| DOCUMENTTAGGING | engine | Tagging Engine to use | chatgpt |
2131+
| DOCUMENTTAGGING | tags | Comma-deliminted list of keywords | author,title,description |
2132+
| WEBHOOK | url | Webhook URL | https://yourdomain.com/webhook-endpoint |
2133+
| NOTIFICATION | notificationType | Type of Notification | email |
2134+
| NOTIFICATION | notificationToCc | Notification Carbon Copy | <email>@yourdomain.com |
2135+
| NOTIFICATION | notificationToBcc | Notification Blind Carbon Copy | <email>@yourdomain.com |
2136+
| NOTIFICATION | notificationSubject | Notification Subject | Email Subject |
2137+
| NOTIFICATION | notificationText | Notification as Text | Email Text |
2138+
| NOTIFICATION | notificationHtml | Notification as Html | Email HTML Text |
2139+
| QUEUE | queueName | Name of Queue | |
21362140
operationId: AddDocumentActions
21372141
parameters:
21382142
- description: Site Identifier
@@ -8848,6 +8852,9 @@ components:
88488852
type: object
88498853
GetDocumentOcrResponse:
88508854
example:
8855+
contentUrls:
8856+
- contentUrls
8857+
- contentUrls
88518858
ocrEngine: ocrEngine
88528859
data: data
88538860
insertedDate: insertedDate
@@ -8857,6 +8864,11 @@ components:
88578864
isBase64: true
88588865
userId: userId
88598866
properties:
8867+
contentUrls:
8868+
description: Presigned S3 Urls for the OCR content
8869+
items:
8870+
type: string
8871+
type: array
88608872
data:
88618873
description: OCR text result
88628874
type: string

‎build.gradle‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -7,7 +7,7 @@ plugins {
77
}
88

99
group = 'com.formkiq'
10-
version = '1.13.0'
10+
version = '1.13.1'
1111

1212
sourceCompatibility = JavaVersion.VERSION_11
1313
targetCompatibility = JavaVersion.VERSION_11

‎docs/DocumentActionsApi.md‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -15,7 +15,7 @@ All URIs are relative to *http://localhost*
1515
1616
Add document action
1717

18-
Add one or more actions to a document; this appends actions and does not replace previous actions ### Action Parameters | ActionType | Parameter | Description | | -------- | ------- | ------- | | OCR | ocrParseTypes | Ocr Parsing strategy to use | | OCR | ocrEngine | Ocr Engine to use | | OCR | addPdfDetectedCharactersAsText | PDF Documents convert images to text | | FULLTEXT | characterMax | Maximum number of characters to add to Fulltext destination | | DOCUMENTTAGGING | engine | Tagging Engine to use | | DOCUMENTTAGGING | tags | Comma-deliminted list of keywords | | WEBHOOK | url | Webhook URL | | NOTIFICATION | notificationType | Type of Notification | | NOTIFICATION | notificationToCc | Notification Carbon Copy | | NOTIFICATION | notificationToBcc | Notification Blind Carbon Copy | | NOTIFICATION | notificationSubject | Notification Subject | | NOTIFICATION | notificationText | Notification as Text | | NOTIFICATION | notificationHtml | Notification as Html | | QUEUE | queueName | Name of Queue |
18+
Add one or more actions to a document; this appends actions and does not replace previous actions Each action type supports a different set of parameters as shown in the table below: ### Action Parameters | ActionType | Parameter | Description | Example | | -------- | ------- | ------- | ------- | | OCR | ocrParseTypes | Ocr Parsing strategy to use | TEXT, FORMS, TABLES | | OCR | ocrEngine | Ocr Engine to use | tesseract or textract | | OCR | addPdfDetectedCharactersAsText | PDF Documents convert images to text | true or false | | FULLTEXT | characterMax | Maximum number of characters to add to Fulltext destination | -1 | | DOCUMENTTAGGING | engine | Tagging Engine to use | chatgpt | | DOCUMENTTAGGING | tags | Comma-deliminted list of keywords | author,title,description | | WEBHOOK | url | Webhook URL | https://yourdomain.com/webhook-endpoint | | NOTIFICATION | notificationType | Type of Notification | email | | NOTIFICATION | notificationToCc | Notification Carbon Copy | &lt;email&gt;@yourdomain.com | | NOTIFICATION | notificationToBcc | Notification Blind Carbon Copy | &lt;email&gt;@yourdomain.com | | NOTIFICATION | notificationSubject | Notification Subject | Email Subject | | NOTIFICATION | notificationText | Notification as Text | Email Text | | NOTIFICATION | notificationHtml | Notification as Html | Email HTML Text | | QUEUE | queueName | Name of Queue | |
1919

2020
### Example
2121
```java

‎docs/DocumentSearchApi.md‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -13,7 +13,7 @@ All URIs are relative to *http://localhost*
1313
1414
Document search
1515

16-
Document search query request; Supports searching DynamoDB for document(s) by a single TAG key and/or value. Value can be \&quot;exacted\&quot; or \&quot;begins_with\&quot; matched. Search can be filtered to only check certain documentIds (up to 100 documentIds accepted). If using Enteprise TagSchema Composite Keys feature then multiple tag(s) can be searched for. If Typesense is enabled, full text search is supported through the \&quot;text\&quot; parameter. Full text search will look for the text in the \&quot;content\&quot; and/or document \&quot;metadata\&quot;. See requestBody examples below for commmon examples.
16+
Document search query request; Supports searching DynamoDB for document(s) by a single TAG key and/or value. Value can be \&quot;exacted\&quot; or \&quot;begins_with\&quot; matched. Search can be filtered to only check certain documentIds (up to 100 documentIds accepted). If using Enteprise TagSchema Composite Keys feature then multiple tag(s) can be searched for. If Typesense is enabled, full text search is supported through the \&quot;text\&quot; parameter. Full text search will look for the text in the \&quot;content\&quot; and/or document \&quot;metadata\&quot;. DocumentIds parameter allows you to filter your results to a specific set of documents. See requestBody examples below for commmon examples.
1717

1818
### Example
1919
```java

‎docs/GetDocumentOcrResponse.md‎

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -7,6 +7,7 @@
77

88
| Name | Type | Description | Notes |
99
|------------ | ------------- | ------------- | -------------|
10+
|**contentUrls** | **List&lt;String&gt;** | Presigned S3 Urls for the OCR content | [optional] |
1011
|**data** | **String** | OCR text result | [optional] |
1112
|**ocrEngine** | **String** | The OCR technique used | [optional] |
1213
|**ocrStatus** | **String** | The status of the OCR request | [optional] |

‎src/main/java/com/formkiq/client/api/DocumentActionsApi.java‎

Lines changed: 45 additions & 33 deletions
Original file line numberDiff line numberDiff line change
@@ -181,17 +181,21 @@ private okhttp3.Call addDocumentActionsValidateBeforeCall(String documentId, Str
181181

182182
/**
183183
* Add document action Add one or more actions to a document; this appends actions and does not
184-
* replace previous actions ### Action Parameters | ActionType | Parameter | Description | |
185-
* -------- | ------- | ------- | | OCR | ocrParseTypes | Ocr Parsing strategy to use | | OCR |
186-
* ocrEngine | Ocr Engine to use | | OCR | addPdfDetectedCharactersAsText | PDF Documents convert
187-
* images to text | | FULLTEXT | characterMax | Maximum number of characters to add to Fulltext
188-
* destination | | DOCUMENTTAGGING | engine | Tagging Engine to use | | DOCUMENTTAGGING | tags |
189-
* Comma-deliminted list of keywords | | WEBHOOK | url | Webhook URL | | NOTIFICATION |
190-
* notificationType | Type of Notification | | NOTIFICATION | notificationToCc | Notification
191-
* Carbon Copy | | NOTIFICATION | notificationToBcc | Notification Blind Carbon Copy | |
192-
* NOTIFICATION | notificationSubject | Notification Subject | | NOTIFICATION | notificationText |
193-
* Notification as Text | | NOTIFICATION | notificationHtml | Notification as Html | | QUEUE |
194-
* queueName | Name of Queue |
184+
* replace previous actions Each action type supports a different set of parameters as shown in
185+
* the table below: ### Action Parameters | ActionType | Parameter | Description | Example | |
186+
* -------- | ------- | ------- | ------- | | OCR | ocrParseTypes | Ocr Parsing strategy to use |
187+
* TEXT, FORMS, TABLES | | OCR | ocrEngine | Ocr Engine to use | tesseract or textract | | OCR |
188+
* addPdfDetectedCharactersAsText | PDF Documents convert images to text | true or false | |
189+
* FULLTEXT | characterMax | Maximum number of characters to add to Fulltext destination | -1 | |
190+
* DOCUMENTTAGGING | engine | Tagging Engine to use | chatgpt | | DOCUMENTTAGGING | tags |
191+
* Comma-deliminted list of keywords | author,title,description | | WEBHOOK | url | Webhook URL |
192+
* https://yourdomain.com/webhook-endpoint | | NOTIFICATION | notificationType | Type of
193+
* Notification | email | | NOTIFICATION | notificationToCc | Notification Carbon Copy |
194+
* &lt;email&gt;@yourdomain.com | | NOTIFICATION | notificationToBcc | Notification Blind Carbon
195+
* Copy | &lt;email&gt;@yourdomain.com | | NOTIFICATION | notificationSubject | Notification
196+
* Subject | Email Subject | | NOTIFICATION | notificationText | Notification as Text | Email Text
197+
* | | NOTIFICATION | notificationHtml | Notification as Html | Email HTML Text | | QUEUE |
198+
* queueName | Name of Queue | |
195199
*
196200
* @param documentId Document Identifier (required)
197201
* @param siteId Site Identifier (optional)
@@ -230,17 +234,21 @@ public AddDocumentActionsResponse addDocumentActions(String documentId, String s
230234

231235
/**
232236
* Add document action Add one or more actions to a document; this appends actions and does not
233-
* replace previous actions ### Action Parameters | ActionType | Parameter | Description | |
234-
* -------- | ------- | ------- | | OCR | ocrParseTypes | Ocr Parsing strategy to use | | OCR |
235-
* ocrEngine | Ocr Engine to use | | OCR | addPdfDetectedCharactersAsText | PDF Documents convert
236-
* images to text | | FULLTEXT | characterMax | Maximum number of characters to add to Fulltext
237-
* destination | | DOCUMENTTAGGING | engine | Tagging Engine to use | | DOCUMENTTAGGING | tags |
238-
* Comma-deliminted list of keywords | | WEBHOOK | url | Webhook URL | | NOTIFICATION |
239-
* notificationType | Type of Notification | | NOTIFICATION | notificationToCc | Notification
240-
* Carbon Copy | | NOTIFICATION | notificationToBcc | Notification Blind Carbon Copy | |
241-
* NOTIFICATION | notificationSubject | Notification Subject | | NOTIFICATION | notificationText |
242-
* Notification as Text | | NOTIFICATION | notificationHtml | Notification as Html | | QUEUE |
243-
* queueName | Name of Queue |
237+
* replace previous actions Each action type supports a different set of parameters as shown in
238+
* the table below: ### Action Parameters | ActionType | Parameter | Description | Example | |
239+
* -------- | ------- | ------- | ------- | | OCR | ocrParseTypes | Ocr Parsing strategy to use |
240+
* TEXT, FORMS, TABLES | | OCR | ocrEngine | Ocr Engine to use | tesseract or textract | | OCR |
241+
* addPdfDetectedCharactersAsText | PDF Documents convert images to text | true or false | |
242+
* FULLTEXT | characterMax | Maximum number of characters to add to Fulltext destination | -1 | |
243+
* DOCUMENTTAGGING | engine | Tagging Engine to use | chatgpt | | DOCUMENTTAGGING | tags |
244+
* Comma-deliminted list of keywords | author,title,description | | WEBHOOK | url | Webhook URL |
245+
* https://yourdomain.com/webhook-endpoint | | NOTIFICATION | notificationType | Type of
246+
* Notification | email | | NOTIFICATION | notificationToCc | Notification Carbon Copy |
247+
* &lt;email&gt;@yourdomain.com | | NOTIFICATION | notificationToBcc | Notification Blind Carbon
248+
* Copy | &lt;email&gt;@yourdomain.com | | NOTIFICATION | notificationSubject | Notification
249+
* Subject | Email Subject | | NOTIFICATION | notificationText | Notification as Text | Email Text
250+
* | | NOTIFICATION | notificationHtml | Notification as Html | Email HTML Text | | QUEUE |
251+
* queueName | Name of Queue | |
244252
*
245253
* @param documentId Document Identifier (required)
246254
* @param siteId Site Identifier (optional)
@@ -280,17 +288,21 @@ public ApiResponse<AddDocumentActionsResponse> addDocumentActionsWithHttpInfo(St
280288

281289
/**
282290
* Add document action (asynchronously) Add one or more actions to a document; this appends
283-
* actions and does not replace previous actions ### Action Parameters | ActionType | Parameter |
284-
* Description | | -------- | ------- | ------- | | OCR | ocrParseTypes | Ocr Parsing strategy to
285-
* use | | OCR | ocrEngine | Ocr Engine to use | | OCR | addPdfDetectedCharactersAsText | PDF
286-
* Documents convert images to text | | FULLTEXT | characterMax | Maximum number of characters to
287-
* add to Fulltext destination | | DOCUMENTTAGGING | engine | Tagging Engine to use | |
288-
* DOCUMENTTAGGING | tags | Comma-deliminted list of keywords | | WEBHOOK | url | Webhook URL | |
289-
* NOTIFICATION | notificationType | Type of Notification | | NOTIFICATION | notificationToCc |
290-
* Notification Carbon Copy | | NOTIFICATION | notificationToBcc | Notification Blind Carbon Copy
291-
* | | NOTIFICATION | notificationSubject | Notification Subject | | NOTIFICATION |
292-
* notificationText | Notification as Text | | NOTIFICATION | notificationHtml | Notification as
293-
* Html | | QUEUE | queueName | Name of Queue |
291+
* actions and does not replace previous actions Each action type supports a different set of
292+
* parameters as shown in the table below: ### Action Parameters | ActionType | Parameter |
293+
* Description | Example | | -------- | ------- | ------- | ------- | | OCR | ocrParseTypes | Ocr
294+
* Parsing strategy to use | TEXT, FORMS, TABLES | | OCR | ocrEngine | Ocr Engine to use |
295+
* tesseract or textract | | OCR | addPdfDetectedCharactersAsText | PDF Documents convert images
296+
* to text | true or false | | FULLTEXT | characterMax | Maximum number of characters to add to
297+
* Fulltext destination | -1 | | DOCUMENTTAGGING | engine | Tagging Engine to use | chatgpt | |
298+
* DOCUMENTTAGGING | tags | Comma-deliminted list of keywords | author,title,description | |
299+
* WEBHOOK | url | Webhook URL | https://yourdomain.com/webhook-endpoint | | NOTIFICATION |
300+
* notificationType | Type of Notification | email | | NOTIFICATION | notificationToCc |
301+
* Notification Carbon Copy | &lt;email&gt;@yourdomain.com | | NOTIFICATION | notificationToBcc |
302+
* Notification Blind Carbon Copy | &lt;email&gt;@yourdomain.com | | NOTIFICATION |
303+
* notificationSubject | Notification Subject | Email Subject | | NOTIFICATION | notificationText
304+
* | Notification as Text | Email Text | | NOTIFICATION | notificationHtml | Notification as Html
305+
* | Email HTML Text | | QUEUE | queueName | Name of Queue | |
294306
*
295307
* @param documentId Document Identifier (required)
296308
* @param siteId Site Identifier (optional)

‎src/main/java/com/formkiq/client/api/DocumentSearchApi.java‎

Lines changed: 9 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -190,8 +190,9 @@ private okhttp3.Call documentSearchValidateBeforeCall(DocumentSearchRequest docu
190190
* accepted). If using Enteprise TagSchema Composite Keys feature then multiple tag(s) can be
191191
* searched for. If Typesense is enabled, full text search is supported through the
192192
* \&quot;text\&quot; parameter. Full text search will look for the text in the
193-
* \&quot;content\&quot; and/or document \&quot;metadata\&quot;. See requestBody examples below
194-
* for commmon examples.
193+
* \&quot;content\&quot; and/or document \&quot;metadata\&quot;. DocumentIds parameter allows you
194+
* to filter your results to a specific set of documents. See requestBody examples below for
195+
* commmon examples.
195196
*
196197
* @param documentSearchRequest (required)
197198
* @param siteId Site Identifier (optional)
@@ -232,8 +233,9 @@ public DocumentSearchResponse documentSearch(DocumentSearchRequest documentSearc
232233
* accepted). If using Enteprise TagSchema Composite Keys feature then multiple tag(s) can be
233234
* searched for. If Typesense is enabled, full text search is supported through the
234235
* \&quot;text\&quot; parameter. Full text search will look for the text in the
235-
* \&quot;content\&quot; and/or document \&quot;metadata\&quot;. See requestBody examples below
236-
* for commmon examples.
236+
* \&quot;content\&quot; and/or document \&quot;metadata\&quot;. DocumentIds parameter allows you
237+
* to filter your results to a specific set of documents. See requestBody examples below for
238+
* commmon examples.
237239
*
238240
* @param documentSearchRequest (required)
239241
* @param siteId Site Identifier (optional)
@@ -276,8 +278,9 @@ public ApiResponse<DocumentSearchResponse> documentSearchWithHttpInfo(
276278
* to 100 documentIds accepted). If using Enteprise TagSchema Composite Keys feature then multiple
277279
* tag(s) can be searched for. If Typesense is enabled, full text search is supported through the
278280
* \&quot;text\&quot; parameter. Full text search will look for the text in the
279-
* \&quot;content\&quot; and/or document \&quot;metadata\&quot;. See requestBody examples below
280-
* for commmon examples.
281+
* \&quot;content\&quot; and/or document \&quot;metadata\&quot;. DocumentIds parameter allows you
282+
* to filter your results to a specific set of documents. See requestBody examples below for
283+
* commmon examples.
281284
*
282285
* @param documentSearchRequest (required)
283286
* @param siteId Site Identifier (optional)

‎src/main/java/com/formkiq/client/invoker/ApiException.java‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -31,7 +31,7 @@
3131
*/
3232
@SuppressWarnings("serial")
3333
@javax.annotation.Generated(value = "org.openapitools.codegen.languages.JavaClientCodegen",
34-
date = "2023-12-16T14:07:54.900671-06:00[America/Winnipeg]")
34+
date = "2024-01-23T19:44:28.335991-06:00[America/Winnipeg]")
3535
public class ApiException extends Exception {
3636
private int code = 0;
3737
private Map<String, List<String>> responseHeaders = null;

‎src/main/java/com/formkiq/client/invoker/Configuration.java‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -21,7 +21,7 @@
2121
package com.formkiq.client.invoker;
2222

2323
@javax.annotation.Generated(value = "org.openapitools.codegen.languages.JavaClientCodegen",
24-
date = "2023-12-16T14:07:54.900671-06:00[America/Winnipeg]")
24+
date = "2024-01-23T19:44:28.335991-06:00[America/Winnipeg]")
2525
public class Configuration {
2626
public static final String VERSION = "1.13.0";
2727

0 commit comments

Comments
 (0)