IntelligentDocumentProcessingApi

All URIs are relative to http://localhost

Method	HTTP request	Description
addDocumentAiPrompt	POST /documents/{documentId}/ai/prompts/{llmPromptEntityName}	Add document AI result from LLM prompt
addDocumentMetadataExtractionResult	POST /documents/{documentId}/metadataExtractionResults/{llmPromptEntityName}	Add document's metadata extraction result
getAllDocumentMetadataExtractionResults	GET /documents/{documentId}/metadataExtractionResults	Get all document's metadata extraction results
getDocumentAiPromptResults	GET /documents/{documentId}/ai/prompts/{llmPromptEntityName}	Get document AI results from LLM prompt
getDocumentAiPromptsResults	GET /documents/{documentId}/ai/prompts	Get document AI results from LLM prompts
getDocumentDataClassification	GET /documents/{documentId}/dataClassification	Get document's data classification
getDocumentMetadataExtractionResults	GET /documents/{documentId}/metadataExtractionResults/{llmPromptEntityName}	Get document's metadata extraction results
setDocumentDataClassification	PUT /documents/{documentId}/dataClassification	Set document's data classification

addDocumentAiPrompt

AddDocumentAiResponse addDocumentAiPrompt(documentId, llmPromptEntityName, siteId, artifactId, addDocumentAiPromptRequest)

Add document AI result from LLM prompt

Run an LLM prompt against a document; available as an Add-On Module

Example

// Import classes:
import com.formkiq.client.invoker.ApiClient;
import com.formkiq.client.invoker.ApiException;
import com.formkiq.client.invoker.Configuration;
import com.formkiq.client.invoker.auth.*;
import com.formkiq.client.invoker.models.*;
import com.formkiq.client.api.IntelligentDocumentProcessingApi;

public class Example {
  public static void main(String[] args) {
    ApiClient defaultClient = Configuration.getDefaultApiClient();
    defaultClient.setBasePath("http://localhost");
    // Configure AWS Signature V4 authorization
    defaultClient.setAWS4Configuration("YOUR_ACCESS_KEY", "YOUR_SECRET_KEY", "REGION", "SERVICE")
    
    IntelligentDocumentProcessingApi apiInstance = new IntelligentDocumentProcessingApi(defaultClient);
    String documentId = "documentId_example"; // String | Document Identifier
    String llmPromptEntityName = "llmPromptEntityName_example"; // String | LlmPrompt Entity Name
    String siteId = "siteId_example"; // String | Site Identifier
    String artifactId = "artifactId_example"; // String | Artifact Document Identifier
    AddDocumentAiPromptRequest addDocumentAiPromptRequest = new AddDocumentAiPromptRequest(); // AddDocumentAiPromptRequest | 
    try {
      AddDocumentAiResponse result = apiInstance.addDocumentAiPrompt(documentId, llmPromptEntityName, siteId, artifactId, addDocumentAiPromptRequest);
      System.out.println(result);
    } catch (ApiException e) {
      System.err.println("Exception when calling IntelligentDocumentProcessingApi#addDocumentAiPrompt");
      System.err.println("Status code: " + e.getCode());
      System.err.println("Reason: " + e.getResponseBody());
      System.err.println("Response headers: " + e.getResponseHeaders());
      e.printStackTrace();
    }
  }
}

Parameters

Name	Type	Description	Notes
documentId	String	Document Identifier
llmPromptEntityName	String	LlmPrompt Entity Name
siteId	String	Site Identifier	[optional]
artifactId	String	Artifact Document Identifier	[optional]
addDocumentAiPromptRequest	AddDocumentAiPromptRequest		[optional]

Return type

AddDocumentAiResponse

Authorization

No authorization required

HTTP request headers

Content-Type: application/json
Accept: application/json

HTTP response details

Status code	Description	Response headers
200	200 OK	* Access-Control-Allow-Origin - * Access-Control-Allow-Methods - * Access-Control-Allow-Headers -

addDocumentMetadataExtractionResult

AddDocumentMetadataExtractionResponse addDocumentMetadataExtractionResult(documentId, llmPromptEntityName, siteId, artifactId)

Add document's metadata extraction result

Create a document Metadatq Extraction Result attributes within a document; available as an Add-On Module. Deprecated. This endpoint is no longer recommended. Please use `/documents/{documentId}/ai/prompts/{llmPromptEntityName}` instead.

Example

// Import classes:
import com.formkiq.client.invoker.ApiClient;
import com.formkiq.client.invoker.ApiException;
import com.formkiq.client.invoker.Configuration;
import com.formkiq.client.invoker.auth.*;
import com.formkiq.client.invoker.models.*;
import com.formkiq.client.api.IntelligentDocumentProcessingApi;

public class Example {
  public static void main(String[] args) {
    ApiClient defaultClient = Configuration.getDefaultApiClient();
    defaultClient.setBasePath("http://localhost");
    // Configure AWS Signature V4 authorization
    defaultClient.setAWS4Configuration("YOUR_ACCESS_KEY", "YOUR_SECRET_KEY", "REGION", "SERVICE")
    
    IntelligentDocumentProcessingApi apiInstance = new IntelligentDocumentProcessingApi(defaultClient);
    String documentId = "documentId_example"; // String | Document Identifier
    String llmPromptEntityName = "llmPromptEntityName_example"; // String | LlmPrompt Entity Name
    String siteId = "siteId_example"; // String | Site Identifier
    String artifactId = "artifactId_example"; // String | Artifact Document Identifier
    try {
      AddDocumentMetadataExtractionResponse result = apiInstance.addDocumentMetadataExtractionResult(documentId, llmPromptEntityName, siteId, artifactId);
      System.out.println(result);
    } catch (ApiException e) {
      System.err.println("Exception when calling IntelligentDocumentProcessingApi#addDocumentMetadataExtractionResult");
      System.err.println("Status code: " + e.getCode());
      System.err.println("Reason: " + e.getResponseBody());
      System.err.println("Response headers: " + e.getResponseHeaders());
      e.printStackTrace();
    }
  }
}

Parameters

Name	Type	Description	Notes
documentId	String	Document Identifier
llmPromptEntityName	String	LlmPrompt Entity Name
siteId	String	Site Identifier	[optional]
artifactId	String	Artifact Document Identifier	[optional]

Return type

AddDocumentMetadataExtractionResponse

Authorization

No authorization required

HTTP request headers

Content-Type: Not defined
Accept: application/json

HTTP response details

Status code	Description	Response headers
200	200 OK	* Access-Control-Allow-Origin - * Access-Control-Allow-Methods - * Access-Control-Allow-Headers -

getAllDocumentMetadataExtractionResults

GetDocumentMetadataExtractionResponse getAllDocumentMetadataExtractionResults(documentId, siteId, artifactId, limit, next)

Get all document's metadata extraction results

Retrieve all document's metadata extraction; available as an Add-On Module. Deprecated. This endpoint is no longer recommended. Please use `/documents/{documentId}/ai/prompts/{llmPromptEntityName}` instead.

Example

// Import classes:
import com.formkiq.client.invoker.ApiClient;
import com.formkiq.client.invoker.ApiException;
import com.formkiq.client.invoker.Configuration;
import com.formkiq.client.invoker.auth.*;
import com.formkiq.client.invoker.models.*;
import com.formkiq.client.api.IntelligentDocumentProcessingApi;

public class Example {
  public static void main(String[] args) {
    ApiClient defaultClient = Configuration.getDefaultApiClient();
    defaultClient.setBasePath("http://localhost");
    // Configure AWS Signature V4 authorization
    defaultClient.setAWS4Configuration("YOUR_ACCESS_KEY", "YOUR_SECRET_KEY", "REGION", "SERVICE")
    
    IntelligentDocumentProcessingApi apiInstance = new IntelligentDocumentProcessingApi(defaultClient);
    String documentId = "documentId_example"; // String | Document Identifier
    String siteId = "siteId_example"; // String | Site Identifier
    String artifactId = "artifactId_example"; // String | Artifact Document Identifier
    String limit = "10"; // String | Limit Results
    String next = "next_example"; // String | Next page of results token
    try {
      GetDocumentMetadataExtractionResponse result = apiInstance.getAllDocumentMetadataExtractionResults(documentId, siteId, artifactId, limit, next);
      System.out.println(result);
    } catch (ApiException e) {
      System.err.println("Exception when calling IntelligentDocumentProcessingApi#getAllDocumentMetadataExtractionResults");
      System.err.println("Status code: " + e.getCode());
      System.err.println("Reason: " + e.getResponseBody());
      System.err.println("Response headers: " + e.getResponseHeaders());
      e.printStackTrace();
    }
  }
}

Parameters

Name	Type	Description	Notes
documentId	String	Document Identifier
siteId	String	Site Identifier	[optional]
artifactId	String	Artifact Document Identifier	[optional]
limit	String	Limit Results	[optional] [default to 10]
next	String	Next page of results token	[optional]

Return type

GetDocumentMetadataExtractionResponse

Authorization

No authorization required

HTTP request headers

Content-Type: Not defined
Accept: application/json

HTTP response details

Status code	Description	Response headers
200	200 OK	* Access-Control-Allow-Origin - * Access-Control-Allow-Methods - * Access-Control-Allow-Headers -

getDocumentAiPromptResults

GetDocumentAiPromptResultsResponse getDocumentAiPromptResults(documentId, llmPromptEntityName, siteId, artifactId, analysisCategory, limit, next)

Get document AI results from LLM prompt

Retrieve document AI results from an LLM prompt; available as an Add-On Module

Example

// Import classes:
import com.formkiq.client.invoker.ApiClient;
import com.formkiq.client.invoker.ApiException;
import com.formkiq.client.invoker.Configuration;
import com.formkiq.client.invoker.auth.*;
import com.formkiq.client.invoker.models.*;
import com.formkiq.client.api.IntelligentDocumentProcessingApi;

public class Example {
  public static void main(String[] args) {
    ApiClient defaultClient = Configuration.getDefaultApiClient();
    defaultClient.setBasePath("http://localhost");
    // Configure AWS Signature V4 authorization
    defaultClient.setAWS4Configuration("YOUR_ACCESS_KEY", "YOUR_SECRET_KEY", "REGION", "SERVICE")
    
    IntelligentDocumentProcessingApi apiInstance = new IntelligentDocumentProcessingApi(defaultClient);
    String documentId = "documentId_example"; // String | Document Identifier
    String llmPromptEntityName = "llmPromptEntityName_example"; // String | LlmPrompt Entity Name
    String siteId = "siteId_example"; // String | Site Identifier
    String artifactId = "artifactId_example"; // String | Artifact Document Identifier
    String analysisCategory = "analysisCategory_example"; // String | Analysis Category
    String limit = "10"; // String | Limit Results
    String next = "next_example"; // String | Next page of results token
    try {
      GetDocumentAiPromptResultsResponse result = apiInstance.getDocumentAiPromptResults(documentId, llmPromptEntityName, siteId, artifactId, analysisCategory, limit, next);
      System.out.println(result);
    } catch (ApiException e) {
      System.err.println("Exception when calling IntelligentDocumentProcessingApi#getDocumentAiPromptResults");
      System.err.println("Status code: " + e.getCode());
      System.err.println("Reason: " + e.getResponseBody());
      System.err.println("Response headers: " + e.getResponseHeaders());
      e.printStackTrace();
    }
  }
}

Parameters

Name	Type	Description	Notes
documentId	String	Document Identifier
llmPromptEntityName	String	LlmPrompt Entity Name
siteId	String	Site Identifier	[optional]
artifactId	String	Artifact Document Identifier	[optional]
analysisCategory	String	Analysis Category	[optional]
limit	String	Limit Results	[optional] [default to 10]
next	String	Next page of results token	[optional]

Return type

GetDocumentAiPromptResultsResponse

Authorization

No authorization required

HTTP request headers

Content-Type: Not defined
Accept: application/json

HTTP response details

Status code	Description	Response headers
200	200 OK	* Access-Control-Allow-Origin - * Access-Control-Allow-Methods - * Access-Control-Allow-Headers -

getDocumentAiPromptsResults

GetDocumentAiPromptsResultsResponse getDocumentAiPromptsResults(documentId, siteId, artifactId, analysisCategory, limit, next)

Get document AI results from LLM prompts

Retrieve document AI results from LLM prompts; available as an Add-On Module

Example

// Import classes:
import com.formkiq.client.invoker.ApiClient;
import com.formkiq.client.invoker.ApiException;
import com.formkiq.client.invoker.Configuration;
import com.formkiq.client.invoker.auth.*;
import com.formkiq.client.invoker.models.*;
import com.formkiq.client.api.IntelligentDocumentProcessingApi;

public class Example {
  public static void main(String[] args) {
    ApiClient defaultClient = Configuration.getDefaultApiClient();
    defaultClient.setBasePath("http://localhost");
    // Configure AWS Signature V4 authorization
    defaultClient.setAWS4Configuration("YOUR_ACCESS_KEY", "YOUR_SECRET_KEY", "REGION", "SERVICE")
    
    IntelligentDocumentProcessingApi apiInstance = new IntelligentDocumentProcessingApi(defaultClient);
    String documentId = "documentId_example"; // String | Document Identifier
    String siteId = "siteId_example"; // String | Site Identifier
    String artifactId = "artifactId_example"; // String | Artifact Document Identifier
    String analysisCategory = "analysisCategory_example"; // String | Analysis Category
    String limit = "10"; // String | Limit Results
    String next = "next_example"; // String | Next page of results token
    try {
      GetDocumentAiPromptsResultsResponse result = apiInstance.getDocumentAiPromptsResults(documentId, siteId, artifactId, analysisCategory, limit, next);
      System.out.println(result);
    } catch (ApiException e) {
      System.err.println("Exception when calling IntelligentDocumentProcessingApi#getDocumentAiPromptsResults");
      System.err.println("Status code: " + e.getCode());
      System.err.println("Reason: " + e.getResponseBody());
      System.err.println("Response headers: " + e.getResponseHeaders());
      e.printStackTrace();
    }
  }
}

Parameters

Name	Type	Description	Notes
documentId	String	Document Identifier
siteId	String	Site Identifier	[optional]
artifactId	String	Artifact Document Identifier	[optional]
analysisCategory	String	Analysis Category	[optional]
limit	String	Limit Results	[optional] [default to 10]
next	String	Next page of results token	[optional]

Return type

GetDocumentAiPromptsResultsResponse

Authorization

No authorization required

HTTP request headers

Content-Type: Not defined
Accept: application/json

HTTP response details

Status code	Description	Response headers
200	200 OK	* Access-Control-Allow-Origin - * Access-Control-Allow-Methods - * Access-Control-Allow-Headers -

getDocumentDataClassification

GetDocumentDataClassificationResponse getDocumentDataClassification(documentId, siteId, artifactId, limit, next)

Get document's data classification

Retrieve an document's data classification; available as an Add-On Module. Deprecated. This endpoint is no longer recommended. Please use `/documents/{documentId}/ai/prompts/{llmPromptEntityName}` instead.

Example

// Import classes:
import com.formkiq.client.invoker.ApiClient;
import com.formkiq.client.invoker.ApiException;
import com.formkiq.client.invoker.Configuration;
import com.formkiq.client.invoker.auth.*;
import com.formkiq.client.invoker.models.*;
import com.formkiq.client.api.IntelligentDocumentProcessingApi;

public class Example {
  public static void main(String[] args) {
    ApiClient defaultClient = Configuration.getDefaultApiClient();
    defaultClient.setBasePath("http://localhost");
    // Configure AWS Signature V4 authorization
    defaultClient.setAWS4Configuration("YOUR_ACCESS_KEY", "YOUR_SECRET_KEY", "REGION", "SERVICE")
    
    IntelligentDocumentProcessingApi apiInstance = new IntelligentDocumentProcessingApi(defaultClient);
    String documentId = "documentId_example"; // String | Document Identifier
    String siteId = "siteId_example"; // String | Site Identifier
    String artifactId = "artifactId_example"; // String | Artifact Document Identifier
    String limit = "10"; // String | Limit Results
    String next = "next_example"; // String | Next page of results token
    try {
      GetDocumentDataClassificationResponse result = apiInstance.getDocumentDataClassification(documentId, siteId, artifactId, limit, next);
      System.out.println(result);
    } catch (ApiException e) {
      System.err.println("Exception when calling IntelligentDocumentProcessingApi#getDocumentDataClassification");
      System.err.println("Status code: " + e.getCode());
      System.err.println("Reason: " + e.getResponseBody());
      System.err.println("Response headers: " + e.getResponseHeaders());
      e.printStackTrace();
    }
  }
}

Parameters

Name	Type	Description	Notes
documentId	String	Document Identifier
siteId	String	Site Identifier	[optional]
artifactId	String	Artifact Document Identifier	[optional]
limit	String	Limit Results	[optional] [default to 10]
next	String	Next page of results token	[optional]

Return type

GetDocumentDataClassificationResponse

Authorization

No authorization required

HTTP request headers

Content-Type: Not defined
Accept: application/json

HTTP response details

Status code	Description	Response headers
200	200 OK	* Access-Control-Allow-Origin - * Access-Control-Allow-Methods - * Access-Control-Allow-Headers -

getDocumentMetadataExtractionResults

GetDocumentMetadataExtractionResponse getDocumentMetadataExtractionResults(documentId, llmPromptEntityName, siteId, artifactId, limit, next)

Get document's metadata extraction results

Retrieve an document's metadata extraction; available as an Add-On Module. Deprecated. This endpoint is no longer recommended. Please use `/documents/{documentId}/ai/prompts/{llmPromptEntityName}` instead.

Example

// Import classes:
import com.formkiq.client.invoker.ApiClient;
import com.formkiq.client.invoker.ApiException;
import com.formkiq.client.invoker.Configuration;
import com.formkiq.client.invoker.auth.*;
import com.formkiq.client.invoker.models.*;
import com.formkiq.client.api.IntelligentDocumentProcessingApi;

public class Example {
  public static void main(String[] args) {
    ApiClient defaultClient = Configuration.getDefaultApiClient();
    defaultClient.setBasePath("http://localhost");
    // Configure AWS Signature V4 authorization
    defaultClient.setAWS4Configuration("YOUR_ACCESS_KEY", "YOUR_SECRET_KEY", "REGION", "SERVICE")
    
    IntelligentDocumentProcessingApi apiInstance = new IntelligentDocumentProcessingApi(defaultClient);
    String documentId = "documentId_example"; // String | Document Identifier
    String llmPromptEntityName = "llmPromptEntityName_example"; // String | LlmPrompt Entity Name
    String siteId = "siteId_example"; // String | Site Identifier
    String artifactId = "artifactId_example"; // String | Artifact Document Identifier
    String limit = "10"; // String | Limit Results
    String next = "next_example"; // String | Next page of results token
    try {
      GetDocumentMetadataExtractionResponse result = apiInstance.getDocumentMetadataExtractionResults(documentId, llmPromptEntityName, siteId, artifactId, limit, next);
      System.out.println(result);
    } catch (ApiException e) {
      System.err.println("Exception when calling IntelligentDocumentProcessingApi#getDocumentMetadataExtractionResults");
      System.err.println("Status code: " + e.getCode());
      System.err.println("Reason: " + e.getResponseBody());
      System.err.println("Response headers: " + e.getResponseHeaders());
      e.printStackTrace();
    }
  }
}

Parameters

Name	Type	Description	Notes
documentId	String	Document Identifier
llmPromptEntityName	String	LlmPrompt Entity Name
siteId	String	Site Identifier	[optional]
artifactId	String	Artifact Document Identifier	[optional]
limit	String	Limit Results	[optional] [default to 10]
next	String	Next page of results token	[optional]

Return type

GetDocumentMetadataExtractionResponse

Authorization

No authorization required

HTTP request headers

Content-Type: Not defined
Accept: application/json

HTTP response details

Status code	Description	Response headers
200	200 OK	* Access-Control-Allow-Origin - * Access-Control-Allow-Methods - * Access-Control-Allow-Headers -

setDocumentDataClassification

SetDocumentDataClassificationResponse setDocumentDataClassification(documentId, siteId, artifactId, setDocumentDataClassificationRequest)

Set document's data classification

Generate Data Classfication attributes within a document; available as an Add-On Module. Deprecated. This endpoint is no longer recommended. Please use `/documents/{documentId}/ai/prompts/{llmPromptEntityName}` instead.

Example

// Import classes:
import com.formkiq.client.invoker.ApiClient;
import com.formkiq.client.invoker.ApiException;
import com.formkiq.client.invoker.Configuration;
import com.formkiq.client.invoker.auth.*;
import com.formkiq.client.invoker.models.*;
import com.formkiq.client.api.IntelligentDocumentProcessingApi;

public class Example {
  public static void main(String[] args) {
    ApiClient defaultClient = Configuration.getDefaultApiClient();
    defaultClient.setBasePath("http://localhost");
    // Configure AWS Signature V4 authorization
    defaultClient.setAWS4Configuration("YOUR_ACCESS_KEY", "YOUR_SECRET_KEY", "REGION", "SERVICE")
    
    IntelligentDocumentProcessingApi apiInstance = new IntelligentDocumentProcessingApi(defaultClient);
    String documentId = "documentId_example"; // String | Document Identifier
    String siteId = "siteId_example"; // String | Site Identifier
    String artifactId = "artifactId_example"; // String | Artifact Document Identifier
    SetDocumentDataClassificationRequest setDocumentDataClassificationRequest = new SetDocumentDataClassificationRequest(); // SetDocumentDataClassificationRequest | 
    try {
      SetDocumentDataClassificationResponse result = apiInstance.setDocumentDataClassification(documentId, siteId, artifactId, setDocumentDataClassificationRequest);
      System.out.println(result);
    } catch (ApiException e) {
      System.err.println("Exception when calling IntelligentDocumentProcessingApi#setDocumentDataClassification");
      System.err.println("Status code: " + e.getCode());
      System.err.println("Reason: " + e.getResponseBody());
      System.err.println("Response headers: " + e.getResponseHeaders());
      e.printStackTrace();
    }
  }
}

Parameters

Name	Type	Description	Notes
documentId	String	Document Identifier
siteId	String	Site Identifier	[optional]
artifactId	String	Artifact Document Identifier	[optional]
setDocumentDataClassificationRequest	SetDocumentDataClassificationRequest		[optional]

Return type

SetDocumentDataClassificationResponse

Authorization

No authorization required

HTTP request headers

Content-Type: application/json
Accept: application/json

HTTP response details

Status code	Description	Response headers
200	200 OK	* Access-Control-Allow-Origin - * Access-Control-Allow-Methods - * Access-Control-Allow-Headers -

Uh oh!

FilesExpand file tree

IntelligentDocumentProcessingApi.md

Latest commit

History

IntelligentDocumentProcessingApi.md

File metadata and controls

IntelligentDocumentProcessingApi

addDocumentAiPrompt

Example

Parameters

Return type

Authorization

HTTP request headers

HTTP response details

addDocumentMetadataExtractionResult

Example

Parameters

Return type

Authorization

HTTP request headers

HTTP response details

getAllDocumentMetadataExtractionResults

Example

Parameters

Return type

Authorization

HTTP request headers

HTTP response details

getDocumentAiPromptResults

Example

Parameters

Return type

Authorization

HTTP request headers

HTTP response details

getDocumentAiPromptsResults

Example

Parameters

Return type

Authorization

HTTP request headers

HTTP response details

getDocumentDataClassification

Example

Parameters

Return type

Authorization

HTTP request headers

HTTP response details

getDocumentMetadataExtractionResults

Example

Parameters

Return type

Authorization

HTTP request headers

HTTP response details

setDocumentDataClassification

Example

Parameters

Return type

Authorization

HTTP request headers

HTTP response details