Skip to content

Commit 5ef02e5

Browse files
committed
add product docs
1 parent 6e0474e commit 5ef02e5

1 file changed

Lines changed: 82 additions & 0 deletions

File tree

SKILL.md

Lines changed: 82 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -409,6 +409,88 @@ if (!localResponse.isValidHmacSignature(secretKey, hmacSignature)) {
409409
}
410410
```
411411

412+
## Product Specific Handling
413+
414+
### Extraction
415+
416+
#### Parameters
417+
418+
There are additional parameters:
419+
420+
```typescript
421+
const params = {
422+
modelId: "MY_MODEL_ID",
423+
424+
// Options: set to `true` or `false` to override defaults
425+
426+
// Enhance extraction accuracy with Retrieval-Augmented Generation.
427+
rag: undefined,
428+
// Extract the full text content from the document as strings.
429+
rawText: undefined,
430+
// Calculate bounding box polygons for all fields.
431+
polygon: undefined,
432+
// Calculate confidence scores for all fields.
433+
confidence: undefined,
434+
// Additional text context used by the model during inference.
435+
// Not recommended, for specific use only.
436+
textContext: undefined,
437+
// Dynamic changes to the data schema of the model for this inference.
438+
// Not recommended, for specific use only.
439+
dataSchema: undefined,
440+
};
441+
```
442+
443+
#### Response
444+
445+
### Split
446+
447+
#### Parameters
448+
449+
No additional parameters beyond the base ones.
450+
451+
#### Response
452+
453+
### Crop
454+
455+
#### Parameters
456+
457+
No additional parameters beyond the base ones.
458+
459+
#### Response
460+
461+
The `CropResponse` contains a `CropInference` object at `response.inference`.
462+
463+
The `CropInference` exposes a `result` property of type `CropResult`, which contains an array of `CropItem` objects.
464+
465+
##### Accessing Crop Items
466+
467+
Each `CropItem` in `response.inference.result.crops` describes a detected region:
468+
469+
| Property | Type |
470+
|----------------------|-----------------------|
471+
| `objectType` | `string` |
472+
| `location` | `FieldLocation` |
473+
| `extractionResponse` | `ExtractionResponse` |
474+
475+
The `objectType` property is the classification of the detected object, as defined on the Mindee platform.
476+
477+
The `location` property contains a `FieldLocation` instance:
478+
- `location.polygon` – a `Polygon` instance defining the crop boundary.
479+
- `location.page` – the 0-based page index where the crop was found.
480+
481+
The `extractionResponse` property is an `ExtractionResponse` instance, which is identical to the response from Extraction product request.
482+
It will contain data extracted from the crop, if:
483+
* an extraction model was associated with a class on the Mindee platform
484+
* the class was detected on the crop
485+
486+
### OCR
487+
488+
#### Parameters
489+
490+
No additional parameters beyond the base ones.
491+
492+
#### Response
493+
412494
---
413495

414496
# Agent Instructions: Querying The Documentation

0 commit comments

Comments
 (0)