Extraction

• Extraction Params
  • Extraction Parameters
    • ExtractionParameters
  • Data Schema
    • DataSchema
  • Data Schema Field
    • DataSchemaField
  • Data Schema Replace
    • DataSchemaReplace
  • String Data Class
    • StringDataClass

Extraction Inference

class ExtractionInference(raw_response)

Inference object for a V2 API return.

Parameters:

raw_response (dict[str, Any])

active_options: InferenceActiveOptions

Active options for the inference.

file: InferenceFile

File info for the inference.

id: str

ID of the inference.

job: InferenceJob

Job the inference belongs to.

model: InferenceModel

Model info for the inference.

result: ExtractionResult

Result of the inference.

Extraction Response

class ExtractionResponse(raw_response)

Represent an inference response from Mindee V2 API.

Parameters:

raw_response (dict[str, Any])

classmethod get_result_slug()

Getter for the inference slug.

Return type:

str

inference: ExtractionInference

Inference result.

property raw_http: str

Displays the result of the raw response as json string.

Extraction Result

class ExtractionResult(raw_response)

Inference result info.

Parameters:

raw_response (dict[str, Any])

fields: InferenceFields

Fields contained in the inference.

rag: RAGMetadata | None = None

RAG metadata.

raw_text: RawText | None = None

Potential options retrieved alongside the inference.