Indico Client
//indico-client-java/com.indico/IndicoClient
IndicoClient
interface IndicoClient : AutoCloseable
Indico Client for communicating with the platform's GraphQL API.
Inheritors
| IndicoKtorClient |
Functions
| Name | Summary |
|---|---|
| close | [jvm] abstract override fun close() Close and dispose of connections. |
| documentExtraction | [jvm] abstract fun documentExtraction(): DocumentExtraction? Execute a mutation to extract information from a document. |
| execute | [jvm] abstract fun <T : Any> execute(request: GraphQLClientRequest<T>): GraphQLClientResponse<T> Execute any request which inherits from GraphQLClientRequest synchronously. |
| executeAsync | [jvm] abstract suspend fun <T : Any> executeAsync(request: GraphQLClientRequest<T>): GraphQLClientResponse<T> Execute any request which inherits from GraphQLClientRequest asynchronously. |
| generateSubmissionResult | [jvm] abstract fun generateSubmissionResult(): GenerateSubmissionResult? Generate submission results post-submission and post-review. |
| getSubmission | [jvm] abstract fun getSubmission(): GetSubmission? Retrieve a particular submission. |
| listSubmissions | [jvm] abstract fun listSubmissions(): ListSubmissions? Query for submissions and recieve a list. |
| modelGroupLoad | [jvm] abstract fun modelGroupLoad(): ModelGroupLoad? Load a model group given a ModelGroup or an integer id. |
| modelGroupPredict | [jvm] abstract fun modelGroupPredict(): ModelGroupPredict? Retrieve model group predictions. |
| modelGroupQuery | [jvm] abstract fun modelGroupQuery(): ModelGroupQuery? Retrieve a particular model group. |
| rawGraphQLQuery | [jvm] abstract fun rawGraphQLQuery(query: String, operationName: String, variables: JsonNode): GraphQLRequest? Make raw GraphQL query |
| retrieveBlob | [jvm] abstract fun retrieveBlob(): RetrieveBlob? Download a blob. Must call close() on the retrieved blob to dispose of the object after. |
| retrySubmission | [jvm] abstract fun retrySubmission(): RetrySubmission? Retry a submission which has failed or otherwise is not completed. |
| submissionResult | [jvm] abstract fun submissionResult(): SubmissionResult? Retrieve submission result, especially after running GenerateSubmissionResult |
| trainingModelWithProgressQuery | [jvm] abstract fun trainingModelWithProgressQuery(): TrainingModelWithProgressQuery? Retrieve information about the training progress of a model. |
| updateSubmission | [jvm] abstract fun updateSubmission(): UpdateSubmission? Execute a mutation to update the status of a submission. |
| uploadFile | [jvm] abstract fun uploadFile(): UploadFile? Upload a particular file. |
| workflowSubmission | [jvm] abstract fun workflowSubmission(): WorkflowSubmission? Execute a mutation which submits to a workflow and generates a submission. |
Updated 12 months ago