CreateExtractSchemaRequest

Example Usage

import { CreateExtractSchemaRequest } from "@meetkai/mka1/models/operations";

let value: CreateExtractSchemaRequest = {
  extractionSchema: {
    name: "Invoice Extraction",
    description: "Schema for extracting invoice data from PDF documents",
    schema: {
      "type": "object",
      "properties": {
        "invoice_number": {
          "type": "string",
        },
        "vendor_name": {
          "type": "string",
        },
        "total_amount": {
          "type": "number",
        },
        "date": {
          "type": "string",
          "format": "date",
        },
      },
      "required": [
        "invoice_number",
        "total_amount",
      ],
    },
  },
};

Fields

Field	Type	Required	Description	Example
xOnBehalfOf	string	➖	Optional external end-user identifier forwarded by the API gateway.
extractionSchema	components.ExtractionSchema	✔️	N/A	{ "name": "Invoice Extraction", "description": "Schema for extracting invoice data from PDF documents", "schema": { "type": "object", "properties": { "invoice_number": { "type": "string" }, "vendor_name": { "type": "string" }, "total_amount": { "type": "number" }, "date": { "type": "string", "format": "date" } }, "required": [ "invoice_number", "total_amount" ] } }