Router
Ocr
Extracts text content while maintaining document structure and hierarchyfrom orq_ai_sdk import Orq
import os
with Orq(
api_key=os.getenv("ORQ_API_KEY", ""),
) as orq:
res = orq.router.ocr(model="Golf", document={
"type": "document_url",
"document_url": "https://fond-pants.net/",
})
# Handle response
print(res)
import { Orq } from "@orq-ai/node";
const orq = new Orq({
apiKey: process.env["ORQ_API_KEY"] ?? "",
});
async function run() {
const result = await orq.router.ocr({
model: "Golf",
document: {
type: "document_url",
documentUrl: "https://fond-pants.net/",
},
});
console.log(result);
}
run();
Show Parameters
Show Parameters
{
"model": str, # required
"document": Union[Document1, Document2], # required
"pages": List[int],
"ocr_settings": { # optional
"include_image_base64": OptionalNullable[bool],
"max_images_to_include": Optional[int],
"image_min_size": Optional[int],
},
}
{
model: string; // required
document: string; // required
pages?: number[];
ocrSettings?: {
includeImageBase64?: boolean;
maxImagesToInclude?: number;
imageMinSize?: number;
};
}
Show Response
Show Response
{
"model": str,
"pages": {
"index": float,
"markdown": str,
"images": {
"id": str,
"image_base64": OptionalNullable[str],
},
"dimensions": { # optional
"dpi": int,
"height": int,
"width": int,
},
},
"usage": Union[Usage1, Usage2],
}
{
model: string;
pages: {
index: number;
markdown: string;
images: {
id: string;
imageBase64?: string;
};
dimensions?: {
dpi: number;
height: number;
width: number;
};
};
usage: string;
}