Skip to content

SKILL.md

Latest commit

 

History

History
182 lines (135 loc) · 6.8 KB

SKILL.md

File metadata and controls

182 lines (135 loc) · 6.8 KB

Mindee Java SDK

Use this skill for Mindee V2 integrations with the official Java SDK.

Scope

  • Use the official com.mindee.sdk Java SDK.
  • Focus on SDK-based integration patterns only.
  • Do not suggest direct HTTP calls, cURL, or non-SDK integrations.
  • Do not use undocumented SDK internals.

Primary documentation

SDK overview

Client setup

Model parameters

Load local files

Load remote URLs

Send files and URLs

Process responses

Handle errors

Handling responses by model type

Extraction

Split

Crop

Classification

OCR

Default workflow

When answering questions, follow this order:

  1. Initialize the SDK client.
  2. Configure modelId and other inference parameters.
  3. Load the input source.
  4. Optionally adjust the file before upload.
  5. Send with polling or webhooks.
  6. Process the response.
  7. Handle errors and retries.

Answering rules

  • Base answers on the documentation above.
  • Prefer documented SDK methods and patterns.
  • Use environment variable MINDEE_V2_API_KEY for API keys in production.
  • Reuse a client instance when possible.
  • Prefer polling (enqueueAndGetResult()) for simple examples.
  • Prefer webhooks for production or high-volume workflows.
  • Declare throws IOException, InterruptedException on methods that call polling.
  • If a feature is not documented, say it is not officially supported.
  • If a user asks for code, keep examples minimal and working.
  • This SDK has two API versions: V2 (com.mindee.v2) and V1 (com.mindee.v1). Default to V2 unless the user asks for V1.

Code sample rules

  • Use Java examples only.
  • Use the official Maven artifact com.mindee.sdk:mindee-api-java.
  • Show imports explicitly.
  • Include the exact documented class and method names.
  • Use placeholders like MY_API_KEY, MY_MODEL_ID, and /path/to/file.pdf.
  • Keep samples focused on one task.
  • Use Java 11+ syntax.

Preferred example topics

Client initialization

Use:

  • new MindeeClient("MY_API_KEY") — explicit key (com.mindee.v2.MindeeClient)
  • new MindeeClient() — reads from MINDEE_V2_API_KEY environment variable

Input loading

Use (com.mindee.input):

  • new LocalInputSource("path/to/file.pdf") — from file path
  • new LocalInputSource(new File(...)) — from File object
  • new LocalInputSource(inputStream, "filename.pdf") — from InputStream
  • new LocalInputSource(byteArray, "filename.pdf") — from byte array
  • new LocalInputSource(base64String, "filename.pdf") — from Base64 string
  • URLInputSource.builder("https://...").build() — from URL

Sending documents

Use (com.mindee.v2.MindeeClient):

  • enqueueAndGetResult(ResponseClass.class, inputSource, parameters) — polling
  • enqueue(inputSource, parameters) — for webhooks

Response handling

Use:

  • response.getInference() — access the typed inference object
  • response.getInference().getResult() — access the result fields
  • response.getRawResponse() — raw JSON string
  • new LocalResponse(file).deserialize(ResponseClass.class) — for webhook payloads

File preparation

Use (com.mindee.input.LocalInputSource):

  • source.getPageCount() — count pages
  • source.compress() — compress before upload
  • source.applyPageOptions(pageOptions) — trim or remove pages

Error handling

Use:

  • MindeeException — base exception (com.mindee.MindeeException)
  • MindeeHttpExceptionV2 — HTTP errors with getStatus() and getDetail() (com.mindee.v2.http)

Avoid

  • Direct REST examples
  • cURL examples
  • Manual authentication header construction
  • Bearer token examples for API keys
  • Non-Java examples
  • V1 examples unless the user explicitly asks for V1

If the user is unclear

Ask for only what is needed:

  • input type: local file or URL
  • delivery pattern: polling or webhook
  • model ID
  • model type: extraction, split, crop, classification, or OCR

Output style

  • Be concise.
  • Answer with runnable examples when code is requested.
  • Link to the most relevant doc section.
  • Do not overwhelm the user with every option.
  • Start with the documented default path.

Agent Instructions: Querying The Documentation

If you need additional information that is not directly available in this page, you can query the documentation dynamically by asking a question.

Perform an HTTP GET request on the documentation URL with the ask query parameter. Include java+sdk+-+ at the beginning of the question to get answers specific to this library:

GET https://docs.mindee.com/integrations.md?ask=java+sdk+-+<question>

The question should be specific, self-contained, and written in natural language. The response will contain a direct answer to the question and relevant excerpts and sources from the documentation.

Use this mechanism when the answer is not explicitly present in the current page, you need clarification or additional context, or you want to retrieve related documentation sections.