📝 add SKILL file

SKILL.md

@@ -0,0 +1,172 @@
+# Mindee Ruby SDK
+
+Use this skill for Mindee V2 integrations with the official Ruby SDK.
+
+## Scope
+
+- Use the official `mindee` Ruby gem.
+- 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
+- https://docs.mindee.com/integrations/client-libraries-sdk.md
+
+### Client setup
+- https://docs.mindee.com/integrations/client-libraries-sdk/configure-the-client.md
+
+### Model parameters
+- https://docs.mindee.com/integrations/client-libraries-sdk/basic-model-configuration.md
+
+### Load local files
+- https://docs.mindee.com/integrations/client-libraries-sdk/load-and-adjust-a-file.md
+
+### Load remote URLs
+- https://docs.mindee.com/integrations/client-libraries-sdk/load-an-url.md
+
+### Send files and URLs
+- https://docs.mindee.com/integrations/client-libraries-sdk/send-a-file-or-url.md
+
+### Process responses
+- https://docs.mindee.com/integrations/client-libraries-sdk/process-the-response.md
+
+### Handle errors
+- https://docs.mindee.com/integrations/problem-database.md
+
+## Handling responses by model type
+
+### Extraction
+- Use: https://docs.mindee.com/extraction-models/sdk-integration/extraction-result.md
+- Use this page for accessing dynamic fields from `response.inference.result.fields`.
+- Use this page for examples of `SimpleField`, `ObjectField`, `ListField`, confidence, and locations.
+
+### Split
+- Use: https://docs.mindee.com/split-models/sdk-integration/split-result.md
+- Use this page for iterating over `response.inference.result.splits`.
+- Use this page for `document_type`, `page_range`, and optional chained extraction results.
+
+### Crop
+- Use: https://docs.mindee.com/crop-models/sdk-integration/crop-result.md
+- Use this page for iterating over `response.inference.result.crops`.
+- Use this page for `object_type`, crop location, polygon data, and optional chained extraction results.
+
+### Classification
+- Use: https://docs.mindee.com/classification-models/sdk-integration/classification-result.md
+- Use this page for accessing `response.inference.result.classification`.
+- Use this page for `document_type` and optional chained extraction results.
+
+### OCR
+- Use: https://docs.mindee.com/raw-text-ocr-models/sdk-integration/ocr-result.md
+- Use this page for iterating over `response.inference.result.pages`.
+- Use this page for page text (`content`), words, and word polygon data.
+
+## Default workflow
+
+When answering questions, follow this order:
+
+1. Initialize the SDK client.
+2. Configure `model_id` 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 variables for API keys in production.
+- Reuse a client instance when possible.
+- Prefer polling for simple examples.
+- Prefer webhooks for production or high-volume workflows.
+- If a feature is not documented, say it is not officially supported.
+- If a user asks for code, keep examples minimal and working.
+
+## Code sample rules
+
+- Use Ruby examples only.
+- Use the official `mindee` gem.
+- Show requires 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.
+
+## Preferred example topics
+
+### Client initialization
+Use:
+- `Mindee::V2::Client.new(api_key: 'MY_API_KEY')`
+- `Mindee::V2::Client.new` with `MINDEE_V2_API_KEY` env var
+
+### Input loading
+Use:
+- `Mindee::Input::Source::PathInputSource`
+- `Mindee::Input::Source::BytesInputSource`
+- `Mindee::Input::Source::Base64InputSource`
+- `Mindee::Input::Source::FileInputSource`
+- `Mindee::Input::Source::URLInputSource`
+
+### Sending documents
+Use:
+- `client.enqueue_and_get_result(...)` for polling
+- `client.enqueue(...)` for webhooks
+
+### Response handling
+Use:
+- `response.inference`
+- `response.raw_http`
+- `Mindee::Input::LocalResponse` for webhook payloads
+- HMAC signature validation via `local_response.valid_hmac_signature?(secret_key, signature)` when relevant
+
+### File preparation
+Use:
+- `input_source.page_count` — get number of pages
+- `input_source.compress!(...)` — compress before upload
+- `input_source.apply_page_options(options)` — trim or remove pages
+
+## Avoid
+
+- Direct REST examples
+- cURL examples
+- Manual authentication header construction
+- Bearer token examples for API keys
+- Non-Ruby 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
+- runtime context: Rails, Sinatra, background job, or script
+
+## 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 `ruby+sdk+-+` at the beginning of the question to get answers specific to this library:
+
+```
+GET https://docs.mindee.com/integrations.md?ask=ruby+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.