Mindee

https://docs.mindee.com/
Admin
Mindee helps automate document processing through data recognition, computer vision, and machine...
Tokens:91,364
Snippets:889
Trust Score:9.5
Update:2 months ago
Show doc for...
Tokens:
Raw
### GET /getting-started/key-features.md

Source: https://docs.mindee.com/getting-started/key-features.md

Perform an HTTP GET request to query the documentation for specific information using natural language.

```APIDOC
## GET /getting-started/key-features.md

### Description
Queries the documentation dynamically to retrieve answers, excerpts, and sources based on a specific question and an optional end goal.

### Method
GET

### Endpoint
https://docs.mindee.com/getting-started/key-features.md

### Parameters
#### Query Parameters
- **ask** (string) - Required - The immediate question to ask, written in natural language.
- **goal** (string) - Optional - The broader end goal to help tailor the answer.
```

--------------------------------

### Install Mindee SDK via Package Managers

Source: https://docs.mindee.com/classification-models/sdk-integration/classification-quick-start.md

Commands to install the Mindee client library for supported languages using their respective package managers.

```sh
pip install -U mindee~=5.1
```

```sh
npm install mindee@^5.5.0
```

```sh
php composer.phar require "mindee/mindee:>=3.0"
```

```shell
gem install mindee -v '~> 5.2'
```

```sh
dotnet add package Mindee --version 4.4
```

--------------------------------

### GET /getting-started/glossary.md

Source: https://docs.mindee.com/getting-started/glossary.md

Queries the documentation for specific information by providing a question and an optional goal.

```APIDOC
## GET /getting-started/glossary.md

### Description
Perform an HTTP GET request on the current page URL to query the documentation dynamically.

### Method
GET

### Endpoint
https://docs.mindee.com/getting-started/glossary.md

### Parameters
#### Query Parameters
- **ask** (string) - Required - The immediate question to ask.
- **goal** (string) - Optional - The broader end goal to help tailor the answer.

### Response
#### Success Response (200)
- **answer** (string) - A direct answer to the question.
- **excerpts** (array) - Relevant excerpts and sources from the documentation.
```

--------------------------------

### Query Documentation via HTTP GET

Source: https://docs.mindee.com/account-management/account-settings.md

Perform an HTTP GET request to the documentation URL with 'ask' and 'goal' parameters to retrieve context-aware answers.

```http
GET https://docs.mindee.com/account-management/account-settings.md?ask=<question>&goal=<endgoal>
```

--------------------------------

### GET /integrations/client-libraries-sdk/send-a-file-or-url.md

Source: https://docs.mindee.com/integrations/client-libraries-sdk/send-a-file-or-url.md

Perform an HTTP GET request to query the documentation dynamically for specific information.

```APIDOC
## GET /integrations/client-libraries-sdk/send-a-file-or-url.md

### Description
Perform an HTTP GET request on the current page URL to query the documentation dynamically. This allows for retrieving direct answers, relevant excerpts, and sources based on a specific question.

### Method
GET

### Endpoint
https://docs.mindee.com/integrations/client-libraries-sdk/send-a-file-or-url.md

### Parameters
#### Query Parameters
- **ask** (string) - Required - The immediate question to ask, written in natural language.
- **goal** (string) - Optional - Describes the broader end goal to help tailor the response.
```

--------------------------------

### GET /integrations/client-libraries-sdk.md

Source: https://docs.mindee.com/integrations/client-libraries-sdk.md

Queries the documentation for specific information by providing a question and an optional goal.

```APIDOC
## GET /integrations/client-libraries-sdk.md

### Description
Queries the documentation dynamically to retrieve answers, excerpts, and sources based on a specific question.

### Method
GET

### Endpoint
https://docs.mindee.com/integrations/client-libraries-sdk.md

### Parameters
#### Query Parameters
- **ask** (string) - Required - The immediate question to ask the documentation.
- **goal** (string) - Optional - The broader end goal to help tailor the response.
```

--------------------------------

### GET /integrations/client-libraries-sdk/command-line-tools-cli.md

Source: https://docs.mindee.com/integrations/client-libraries-sdk/command-line-tools-cli.md

Queries the documentation page for specific information using natural language questions.

```APIDOC
## GET /integrations/client-libraries-sdk/command-line-tools-cli.md

### Description
Performs a dynamic query on the documentation page to retrieve answers, excerpts, and sources based on a provided question.

### Method
GET

### Endpoint
https://docs.mindee.com/integrations/client-libraries-sdk/command-line-tools-cli.md

### Parameters
#### Query Parameters
- **ask** (string) - Required - The specific, self-contained question to ask.
- **goal** (string) - Optional - The broader end goal to help tailor the response.
```

--------------------------------

### GET /getting-started.md

Source: https://docs.mindee.com/getting-started

Queries the documentation dynamically by providing a specific question and an optional goal to receive a tailored answer with relevant excerpts.

```APIDOC
## GET /getting-started.md

### Description
Queries the documentation dynamically by providing a specific question and an optional goal to receive a tailored answer with relevant excerpts.

### Method
GET

### Endpoint
https://docs.mindee.com/getting-started.md

### Parameters
#### Query Parameters
- **ask** (string) - Required - The specific, self-contained question written in natural language.
- **goal** (string) - Optional - Describes the broader end goal to help tailor the answer.
```

--------------------------------

### GET /v2/products/ocr/polling_url

Source: https://docs.mindee.com/integrations/api-reference/ocr-models.md

Get the status of an inference that was previously enqueued. If the job status is 'Processed', the return code is 302, otherwise it is 200.

```APIDOC
## GET /v2/products/ocr/polling_url

### Description
Get the status of an inference that was previously enqueued. When the job status is 'Processed', the return code will be HTTP 302. Otherwise, the return code will be HTTP 200.

### Method
GET

### Endpoint
{polling_url}

### Parameters
#### Query Parameters
- **redirect** (boolean) - Optional - Set to false to disable the redirection behavior and always return HTTP 200.
```

--------------------------------

### Initialize Mindee Client in Ruby

Source: https://docs.mindee.com/integrations/client-libraries-sdk/configure-the-client.md

Import the package and initialize the client using an API key or the MINDEE_V2_API_KEY environment variable.

```ruby
require 'mindee'
```

```ruby
api_key = 'MY_API_KEY'
mindee_client = Mindee::V2::Client.new(api_key: api_key)
```

```ruby
mindee_client = Mindee::V2::Client.new()
```

--------------------------------

### Query Documentation via HTTP GET

Source: https://docs.mindee.com/extraction-models/optional-features/automation-confidence-score.md

Perform an HTTP GET request to the documentation URL to retrieve answers to specific questions.

```http
GET https://docs.mindee.com/extraction-models/optional-features/automation-confidence-score.md?ask=<question>&goal=<endgoal>
```

--------------------------------

### Initialize Mindee Client in Node.js

Source: https://docs.mindee.com/integrations/client-libraries-sdk/configure-the-client.md

Import the SDK and initialize the client. Environment variables are recommended for production API key management.

```typescript
import * as mindee from "mindee";
// If you're on CommonJS:
// const mindee = require("mindee");
```

```typescript
const apiKey = "MY_API_KEY";

const mindeeClient = new mindee.Client({ apiKey: apiKey });
```

```typescript
const mindeeClient = new mindee.Client();
```

--------------------------------

### Query Documentation via HTTP GET

Source: https://docs.mindee.com/classification-models/sdk-integration/classification-result.md

Perform an HTTP GET request to the documentation URL with query parameters to retrieve specific information.

```http
GET https://docs.mindee.com/classification-models/sdk-integration/classification-result.md?ask=<question>&goal=<endgoal>
```

--------------------------------

### Query Documentation via HTTP GET

Source: https://docs.mindee.com/classification-models/sdk-integration/classification-quick-start.md

Perform an HTTP GET request to the documentation URL with query parameters to retrieve specific information or context.

```http
GET https://docs.mindee.com/classification-models/sdk-integration/classification-quick-start.md?ask=<question>&goal=<endgoal>
```

--------------------------------

### Initialize Mindee Client in Python

Source: https://docs.mindee.com/integrations/client-libraries-sdk/configure-the-client.md

Import the Client class and initialize it using either a direct API key or the MINDEE_V2_API_KEY environment variable.

```python
from mindee.v2 import Client
```

```python
api_key = "MY_API_KEY"

mindee_client = Client(api_key)
```

```python
mindee_client = Client()
```

--------------------------------

### Send a File and Poll with Mindee SDK

Source: https://docs.mindee.com/extraction-models/sdk-integration/quick-start.md

Demonstrates the complete flow of initializing the client, configuring extraction parameters, loading a file from disk, and polling for the extraction result.

```python
from mindee import PathInput
from mindee.v2 import (
    Client,
    ExtractionParameters,
    ExtractionResponse,
)

input_path = "/path/to/the/file.ext"
api_key = "MY_API_KEY"
model_id = "MY_MODEL_ID"

# Init a new client
mindee_client = Client(api_key)

# Set Extraction parameters
model_params = ExtractionParameters(
    # ID of the model, required.
    model_id=model_id,

    # Options: set to `True` or `False` to override defaults

    # Enhance extraction accuracy with Retrieval-Augmented Generation.
    rag=None,
    # Extract the full text content from the document as strings.
    raw_text=None,
    # Calculate bounding box polygons for all fields.
    polygon=None,
    # Boost the precision and accuracy of all extractions.
    # Calculate confidence scores for all fields.
    confidence=None,
)

# Load a file from disk
input_source = PathInput(input_path)

# Send for processing
response = mindee_client.enqueue_and_get_result(
    ExtractionResponse,
    input_source,
    model_params,
)

# Print a brief summary of the parsed data
print(response.inference)

# Access the result fields
fields: dict = response.inference.result.fields
```

```javascript
import * as mindee from "mindee";
// If you're on CommonJS:
// const mindee = require("mindee");

const apiKey = "MY_API_KEY";
const filePath = "/path/to/the/file.ext";
const modelId = "MY_MODEL_ID";

// Init a new client
const mindeeClient = new mindee.Client(
  { apiKey: apiKey }
);

// Set Extraction parameters
const modelParams = {
  modelId: modelId,

  // Options: set to `true` or `false` to override defaults

  // Enhance extraction accuracy with Retrieval-Augmented Generation.
  rag: undefined,
  // Extract the full text content from the document as strings.
  rawText: undefined,
  // Calculate bounding box polygons for all fields.
  polygon: undefined,
  // Boost the precision and accuracy of all extractions.
  // Calculate confidence scores for all fields.
  confidence: undefined,
};

// Load a file from disk
const inputSource = new mindee.PathInput({ inputPath: filePath });

// Send for processing
const response = await mindeeClient.enqueueAndGetResult(
  mindee.product.Extraction,
  inputSource,
  modelParams,
);

// print a string summary
console.log(response.inference.toString());

// Access the result fields
const fields = response.inference.result.fields;
```

```php
<?php

use Mindee\Input\PathInput;
use Mindee\V2\Client;
use Mindee\V2\Product\Extraction\Params\ExtractionParameters;
use Mindee\V2\Product\Extraction\ExtractionResponse;

$apiKey = "MY_API_KEY";
$modelId = "MY_MODEL_ID";
$filePath = "/path/to/the/file.ext";

// Init a new client
$mindeeClient = new Client($apiKey);

// Set Extraction parameters
$modelParams = new ExtractionParameters(
    // ID of the model, required.
    $modelId,

    // Options: set to `true` or `false` to override defaults

    // Enhance extraction accuracy with Retrieval-Augmented Generation.
    rag: null,
    // Extract the full text content from the document as strings.
    rawText: null,
    // Calculate bounding box polygons for all fields.
    polygon: null,
    // Boost the precision and accuracy of all extractions.
    // Calculate confidence scores for all fields.
    confidence: null
);

// Load a file from disk
$inputSource = new PathInput($filePath);

// Send for processing using polling
$response = $mindeeClient->enqueueAndGetResult(
    ExtractionResponse::class,
    $inputSource,
    $modelParams
);

// Print a summary of the response
echo strval($response->inference);

// Access the extracted fields
$fields = $response->inference->result->fields;
```

--------------------------------

### Send a File and Poll for Crop Results

Source: https://docs.mindee.com/crop-models/sdk-integration/crop-quick-start.md

Use the SDK to initialize a client, configure model parameters, and poll for the processing result of a file.

```python
from mindee import PathInput
from mindee.v2 import (
    Client,
    CropParameters,
    CropResponse,
)

input_path = "/path/to/the/file.ext"
api_key = "MY_API_KEY"
model_id = "MY_MODEL_ID"

# Init a new client
mindee_client = Client(api_key)

# Set Crop parameters
model_params = CropParameters(
    # ID of the model, required.
    model_id=model_id,
)

# Load a file from disk
input_source = PathInput(input_path)

# Send for processing using polling
response = mindee_client.enqueue_and_get_result(
    CropResponse,
    input_source,
    model_params,
)

# Print a brief summary of the parsed data
print(response.inference)

# Access the crop result
crops: list = response.inference.result.crops
```

```javascript
import * as mindee from "mindee";
// If you're on CommonJS:
// const mindee = require("mindee");

const apiKey = "MY_API_KEY";
const filePath = "/path/to/the/file.ext";
const modelId = "MY_MODEL_ID";

// Init a new client
const mindeeClient = new mindee.Client(
  { apiKey: apiKey }
);

// Set Crop parameters
const modelParams = {
  modelId: modelId,
};

// Load a file from disk
const inputSource = new mindee.PathInput({ inputPath: filePath });

// Send for processing
const response = await mindeeClient.enqueueAndGetResult(
  mindee.product.Crop,
  inputSource,
  modelParams,
);

// print a string summary
console.log(response.inference.toString());

// Access the result crops
const crops = response.inference.result.crops;
```

```php
<?php

use Mindee\Input\PathInput;
use Mindee\V2\Client;
use Mindee\V2\Product\Crop\Params\CropParameters;
use Mindee\V2\Product\Crop\CropResponse;

$apiKey = "MY_API_KEY";
$modelId = "MY_MODEL_ID";
$filePath = "/path/to/the/file.ext";

// Init a new client
$mindeeClient = new Client($apiKey);

// Set Crop parameters
$modelParams = new CropParameters(
    // ID of the model, required.
    $modelId,
);

// Load a file from disk
$inputSource = new PathInput($filePath);

// Send for processing using polling
$response = $mindeeClient->enqueueAndGetResult(
    CropResponse::class,
    $inputSource,
    $modelParams
);

// Print a summary of the response
echo strval($response->inference);

// Access the crop results
$crops = $response->inference->result->crops;
```

```ruby
require 'mindee'
require 'mindee/v2/product'

input_path = '/path/to/the/file.ext'
api_key = 'MY_API_KEY'
model_id = 'MY_MODEL_ID'

# Init a new client
mindee_client = Mindee::V2::Client.new(api_key: api_key)

# Set Crop parameters
model_params = {
    # ID of the model, required.
    model_id: model_id,
}

# Load a file from disk
input_source = Mindee::Input::Source::PathInputSource.new(input_path)

# Send for processing
response = mindee_client.enqueue_and_get_result(
    Mindee::V2::Product::Crop::Crop,
    input_source,
    model_params
)

# Access the result crops
puts response.inference.result.crops
```

--------------------------------

### GET /use-cases/extraction-models/payslip.md

Source: https://docs.mindee.com/use-cases/extraction-models/payslip.md

Queries the documentation dynamically by asking a question related to the content.

```APIDOC
## GET /use-cases/extraction-models/payslip.md

### Description
Perform an HTTP GET request on the current page URL to query the documentation dynamically when information is not explicitly present or further clarification is needed.

### Method
GET

### Endpoint
https://docs.mindee.com/use-cases/extraction-models/payslip.md

### Parameters
#### Query Parameters
- **ask** (string) - Required - The immediate question to ask.
- **goal** (string) - Optional - The broader end goal to help tailor the answer.
```

--------------------------------

### Initialize Mindee Client in Java

Source: https://docs.mindee.com/integrations/client-libraries-sdk/configure-the-client.md

Import the MindeeClient class and initialize it with an API key or via the MINDEE_V2_API_KEY environment variable.

```java
import com.mindee.v2.MindeeClient;
```

```java
String apiKey = "MY_API_KEY";

MindeeClient mindeeClient = new MindeeClient(apiKey);
```

```java
MindeeClient mindeeClient = new MindeeClient();
```

--------------------------------

### GET /split-models.md

Source: https://docs.mindee.com/split-models

Queries the documentation for specific information using natural language.

```APIDOC
## GET /split-models.md

### Description
Queries the documentation dynamically by asking a question to retrieve relevant excerpts and answers.

### Method
GET

### Endpoint
https://docs.mindee.com/split-models.md

### Parameters
#### Query Parameters
- **ask** (string) - Required - The specific, self-contained question to ask.
- **goal** (string) - Optional - The broader end goal to help tailor the answer.

### Response
#### Success Response (200)
- **answer** (string) - The direct answer to the question.
- **excerpts** (array) - Relevant excerpts and sources from the documentation.
```

--------------------------------

### Initialize Mindee Client in PHP

Source: https://docs.mindee.com/integrations/client-libraries-sdk/configure-the-client.md

Initialize the client by passing the API key directly or by relying on the MINDEE_V2_API_KEY environment variable.

```php
$apiKey = "MY_API_KEY";

$mindeeClient = new Client($apiKey);
```

```php
$mindeeClient = new Client($apiKey);
```

--------------------------------

### GET /raw-text-ocr-models.md

Source: https://docs.mindee.com/raw-text-ocr-models

Queries the documentation dynamically by providing a question and an optional goal.

```APIDOC
## GET /raw-text-ocr-models.md

### Description
Perform an HTTP GET request on the current page URL to query the documentation dynamically. This is useful when specific information is not explicitly present in the current page.

### Method
GET

### Endpoint
https://docs.mindee.com/raw-text-ocr-models.md

### Parameters
#### Query Parameters
- **ask** (string) - Required - The immediate question to ask, written in natural language.
- **goal** (string) - Optional - Describes the broader end goal to help tailor the answer.
```

--------------------------------

### GET /v2/products/extraction/results/{inference_id}

Source: https://docs.mindee.com/integrations/api-reference/extraction-models.md

Retrieves the result of an extraction inference that was previously enqueued.

```APIDOC
## GET /v2/products/extraction/results/{inference_id}

### Description
Get the result of an extraction inference that was previously enqueued. It is recommended to use the value returned in `job.result_url` rather than calling this endpoint directly.

### Method
GET

### Endpoint
/v2/products/extraction/results/{inference_id}

### Parameters
#### Path Parameters
- **inference_id** (string) - Required - UUID of the inference to retrieve

### Response
#### Success Response (200)
- **ExtractionResponse** (object) - The result of the extraction inference.

#### Error Response (404)
- **ErrorResponse** (object) - Returned when the inference ID is not found.

#### Error Response (422)
- **ErrorResponse** (object) - Returned for unprocessable content.
```

--------------------------------

### Initialize Mindee Client in .NET

Source: https://docs.mindee.com/integrations/client-libraries-sdk/configure-the-client.md

Include the required namespace and initialize the client using an API key or the MindeeV2__ApiKey environment variable.

```csharp
using Mindee.V2;
```

```csharp
string apiKey = "MY_API_KEY";

Client mindeeClient = new Client(apiKey);
```

```csharp
Client mindeeClient = new Client();
```

--------------------------------

### Initialize Mindee Client in PHP

Source: https://docs.mindee.com/integrations/client-libraries-sdk/configure-the-client.md

Import the Client class for use in PHP applications.

```php
use Mindee\V2\Client;
```

--------------------------------

### GET /inference/{inference_id}

Source: https://docs.mindee.com/integrations/api-reference/extraction-models.md

Retrieves the result of a completed extraction inference by its ID.

```APIDOC
## GET /inference/{inference_id}

### Description
Retrieves the result of an extraction inference that was previously enqueued. Note that the inference must be finished processing before it can be retrieved.

### Method
GET

### Endpoint
/inference/{inference_id}

### Parameters
#### Path Parameters
- **inference_id** (string) - Required - The UUID of the inference to retrieve.

### Response
#### Success Response (200)
- **inference** (object) - The extraction inference result containing the job, model, file, and extracted fields.
```

--------------------------------

### GET /getting-started/defining-a-model.md

Source: https://docs.mindee.com/getting-started/defining-a-model.md

Perform a query against the documentation to retrieve answers, excerpts, and sources based on a specific question and optional goal.

```APIDOC
## GET /getting-started/defining-a-model.md

### Description
Queries the documentation dynamically to retrieve information, excerpts, and sources based on a natural language question.

### Method
GET

### Endpoint
https://docs.mindee.com/getting-started/defining-a-model.md

### Parameters
#### Query Parameters
- **ask** (string) - Required - The specific, self-contained question to ask.
- **goal** (string) - Optional - The broader end goal to help tailor the response.
```

--------------------------------

### Load an URL

Source: https://docs.mindee.com/integrations/client-libraries-sdk/load-an-url.md

Documentation for querying the documentation dynamically via HTTP GET.

```APIDOC
## GET /integrations/client-libraries-sdk/load-an-url.md

### Description
Perform an HTTP GET request on the current page URL to query the documentation dynamically.

### Method
GET

### Endpoint
/integrations/client-libraries-sdk/load-an-url.md

### Parameters
#### Query Parameters
- **ask** (string) - Required - The immediate question to ask.
- **goal** (string) - Optional - Describes the broader end goal to tailor the answer.
```

--------------------------------

### GET /integrations/ai-coding-assistants.md

Source: https://docs.mindee.com/integrations/ai-coding-assistants.md

Queries the documentation dynamically by providing a question and an optional goal.

```APIDOC
## GET /integrations/ai-coding-assistants.md

### Description
Perform an HTTP GET request on the current page URL to query the documentation dynamically when information is not explicitly present or additional context is needed.

### Method
GET

### Endpoint
https://docs.mindee.com/integrations/ai-coding-assistants.md

### Parameters
#### Query Parameters
- **ask** (string) - Required - The immediate question to ask, written in natural language.
- **goal** (string) - Optional - Describes the broader end goal to help tailor the answer.
```

--------------------------------

### GET /crop-models/sdk-integration/crop-quick-start.md

Source: https://docs.mindee.com/crop-models/sdk-integration/crop-quick-start.md

Queries the documentation page dynamically to retrieve answers, excerpts, and sources based on a specific question and optional goal.

```APIDOC
## GET /crop-models/sdk-integration/crop-quick-start.md

### Description
Perform a dynamic query on the documentation page to retrieve information not explicitly present in the current content.

### Method
GET

### Endpoint
https://docs.mindee.com/crop-models/sdk-integration/crop-quick-start.md

### Parameters
#### Query Parameters
- **ask** (string) - Required - The immediate question to ask.
- **goal** (string) - Optional - The broader end goal to help tailor the response.
```

--------------------------------

### Use Mindee CLI for .NET

Source: https://docs.mindee.com/integrations/client-libraries-sdk/command-line-tools-cli.md

Install the Mindee.Cli tool via dotnet and run commands using the dotnet mindee prefix.

```bash
# Install the package
dotnet tool install Mindee.Cli

# General help
dotnet mindee --help

# Help for extraction models
dotnet mindee extraction --help

# Run extraction on a file
#   -k: API key, you can instead `export MINDEE_V2_API_KEY=md_XXXXXXXXXXXX`
#   -m: Your model ID
#   Positional arg: Absolute path to the file
dotnet mindee extraction \
  -k md_XXXXXXXXXXXX \
  -m xxxx-xxxx-xxxx-xxxx-xxxx \
  /path/to/the/file.pdf
```

--------------------------------

### GET /use-cases/extraction-models/passport.md

Source: https://docs.mindee.com/use-cases/extraction-models/passport.md

Queries the documentation for specific information by providing a question and an optional goal.

```APIDOC
## GET /use-cases/extraction-models/passport.md

### Description
Perform an HTTP GET request on the current page URL to query the documentation dynamically.

### Method
GET

### Endpoint
https://docs.mindee.com/use-cases/extraction-models/passport.md

### Parameters
#### Query Parameters
- **ask** (string) - Required - The immediate question to ask.
- **goal** (string) - Optional - The broader end goal to help tailor the answer.
```

--------------------------------

### Query Documentation via HTTP GET

Source: https://docs.mindee.com/classification-models

Perform a dynamic query against the documentation by appending ask and goal parameters to the page URL.

```http
GET https://docs.mindee.com/classification-models.md?ask=<question>&goal=<endgoal>
```

--------------------------------

### GET /split-models/extraction-model-chaining.md

Source: https://docs.mindee.com/split-models/extraction-model-chaining.md

Query the documentation dynamically by asking a question related to the content of this page.

```APIDOC
## GET /split-models/extraction-model-chaining.md

### Description
Perform an HTTP GET request on the current page URL to query the documentation dynamically using natural language.

### Method
GET

### Endpoint
https://docs.mindee.com/split-models/extraction-model-chaining.md

### Parameters
#### Query Parameters
- **ask** (string) - Required - The immediate question to ask, written in natural language.
- **goal** (string) - Optional - Describes the broader end goal to help tailor the answer.

### Response
#### Success Response (200)
- **answer** (string) - A direct answer to the question with relevant excerpts and sources.
```

--------------------------------

### Use Mindee CLI for Java

Source: https://docs.mindee.com/integrations/client-libraries-sdk/command-line-tools-cli.md

Compile the project using Maven and execute the cli.sh script from the repository root.

```bash
# Compile locally
mvn clean verify

# General help
./cli.sh --help

# Help for extraction models
./cli.sh extraction --help

# Run extraction on a file
#   -k: API key, you can instead `export MINDEE_V2_API_KEY=md_XXXXXXXXXXXX`
#   -m: Your model ID
#   Positional arg: Absolute path to the file
./cli.sh extraction \
  -k md_XXXXXXXXXXXX \
  -m xxxx-xxxx-xxxx-xxxx-xxxx \
  /path/to/the/file.pdf
```

--------------------------------

### GET /integrations/client-libraries-sdk/process-the-response.md

Source: https://docs.mindee.com/integrations/client-libraries-sdk/process-the-response.md

Queries the documentation for specific information by providing a question and an optional goal.

```APIDOC
## GET /integrations/client-libraries-sdk/process-the-response.md

### Description
Perform an HTTP GET request on the current page URL to retrieve a direct answer to a question based on the documentation content.

### Method
GET

### Endpoint
https://docs.mindee.com/integrations/client-libraries-sdk/process-the-response.md

### Parameters
#### Query Parameters
- **ask** (string) - Required - The immediate question to ask.
- **goal** (string) - Optional - The broader end goal to help tailor the response.

### Response
#### Success Response (200)
- **answer** (string) - A direct answer to the question.
- **excerpts** (array) - Relevant excerpts from the documentation.
- **sources** (array) - Sources used to generate the answer.
```

--------------------------------

### GET /integrations/technical-limitations.md

Source: https://docs.mindee.com/integrations/technical-limitations.md

Queries the documentation page for specific information using natural language.

```APIDOC
## GET /integrations/technical-limitations.md

### Description
Performs a query against the documentation page to retrieve answers, excerpts, and sources based on a natural language question.

### Method
GET

### Endpoint
https://docs.mindee.com/integrations/technical-limitations.md

### Parameters
#### Query Parameters
- **ask** (string) - Required - The specific, self-contained question to ask.
- **goal** (string) - Optional - The broader end goal to help tailor the response.
```

--------------------------------

### GET /extraction-models/sdk-integration/extraction-configuration.md

Source: https://docs.mindee.com/extraction-models/sdk-integration/extraction-configuration.md

Queries the documentation page for specific information using natural language.

```APIDOC
## GET /extraction-models/sdk-integration/extraction-configuration.md

### Description
Queries the current documentation page dynamically to retrieve answers, excerpts, or context based on a user question.

### Method
GET

### Endpoint
https://docs.mindee.com/extraction-models/sdk-integration/extraction-configuration.md

### Parameters
#### Query Parameters
- **ask** (string) - Required - The specific, self-contained question to ask.
- **goal** (string) - Optional - The broader end goal to help tailor the response.
```

--------------------------------

### Query Documentation via HTTP GET

Source: https://docs.mindee.com/raw-text-ocr-models/sdk-integration/ocr-result.md

Use this request to ask specific questions about the documentation content dynamically.

```http
GET https://docs.mindee.com/raw-text-ocr-models/sdk-integration/ocr-result.md?ask=<question>&goal=<endgoal>
```

--------------------------------

### Configure Extraction Parameters

Source: https://docs.mindee.com/extraction-models/sdk-integration/extraction-configuration.md

Examples of setting up model parameters including model ID, text context, and data schema across multiple programming languages.

```python
model_params = ExtractionParameters(
    # ID of the model, required.
    model_id="MY_MODEL_ID",

    # Text Context
    text_context="this is an invoice.",

    # Data Schema
    data_schema="{ ... JSON DATA ... }",

    # ... any other options ...
)
```

```typescript
const modelParams = {
  // ID of the model, required.
  modelId: "MY_MODEL_ID",

  // Text Context
  textContext: "this is an invoice.",

  // Data Schema
  dataSchema: "{ ... JSON DATA ... }",

  // ... any other options ...
};
```

```php
$modelParams = new ExtractionParameters(
    // ID of the model, required.
    "MY_MODEL_ID",

    // Text Context
    textContext: "this is an invoice.",

    // Data Schema
    dataSchema: "{ ... JSON DATA ... }",

    // ... any other options ...
);
```

```ruby
model_params = {
    # ID of the model, required.
    model_id: 'MY_MODEL_ID',

    # Text Context
    text_context: "this is an invoice.",

    # Data Schema
    data_schema: "{ ... JSON DATA ... }",

    # ... any other options ...
}
```

```java
var modelParams = ExtractionParameters
    // ID of the model, required.
    .builder("MY_MODEL_ID")

    // Text Context
    .textContext("this is an invoice.")

    // Data Schema
    .dataSchema("{ ... JSON DATA ... }")

    // ... any other options ...

    // complete the builder
    .build();
```

```csharp
var modelParams = new ExtractionParameters(
    // ID of the model, required.
    modelId: "MY_MODEL_ID"
    
    // Text Context
    , textContext: "this is an invoice."
    
    // Data Schema
    , dataSchema: "{ ... JSON DATA ... }"
    
    // ... any other options ...
);
```

--------------------------------

### Load Files in Java

Source: https://docs.mindee.com/integrations/client-libraries-sdk/load-and-adjust-a-file.md

Initialize LocalInputSource using various constructors for different input types.

```java
var filePath = "/path/to/the/file.ext";

var inputSource = new LocalInputSource(filePath);
```

```java
var filePath = new Path("/path/to/the/file.ext");

var inputSource = new LocalInputSource(filePath);
```

```java
var file = new File("/path/to/the/file.ext");

var inputSource = new LocalInputSource(file);
```

```java
var fileBytes = Files.readAllBytes("/path/to/the/file.ext");
var filename = "file.ext";

var inputSource = new LocalInputSource(fileBytes, filename);
```

```java
var fileStream = new FileInputStream(
    new File("/path/to/the/file.ext")
);
var filename = "file.ext";

var inputSource = new LocalInputSource(fileStream, filename);
```

```java
var inputBase64 = "iVBORw0KGgoAAAANSUhEUgAAABgAAA ...";
var filename = "file.ext";

var inputSource = new LocalInputSource(inputBase64, filename);
```
Tokens:
Raw