@cityssm/bill-data-extract/extracts/sectorflow.ts

Extracts data from scanned bill documents into usable details.

// eslint-disable-next-line eslint-comments/disable-enable-pair
/* eslint-disable @typescript-eslint/indent */

import { SectorFlow } from '@cityssm/sectorflow'

import { extractFullPageText } from '../index.js'
import { getTemporaryProjectId } from '../utilities/sectorflowUtilities.js'

import type {
  ElectricityBillData,
  GasBillData,
  WaterBillData
} from './types.js'

export const sectorflowExtractType = 'sectorflow'

const sectorFlowPrompt = `Given the following text, extract the "account number" as "accountNumber", the "service address" as "serviceAddress", the "total amount due" as "totalAmountDue", and the "due date" as "dueDate" into a JSON object.
The "totalAmountDue" should be formatted as a number.
The "dueDate" should be formatted as "yyyy-mm-dd".
If the text represents a gas bill, include
the "gas usage" as "gasUsage",
and the unit of measure for the gas usage (likely m3) as "gasUsageUnit".
If the text represents a utility bill, include
the "electricity usage" as "electricityUsage",
the unit of measure for the electricity usage (likely kWh) as "electricityUsageUnit",
the "water usage" as "waterUsage"
and the unit of measure for the water usage (likely m3 or cu. metre) as "waterUsageUnit".`

interface SectorFlowBillData
  extends Partial<GasBillData>,
    Partial<ElectricityBillData>,
    Partial<WaterBillData> {}

/**
 * Extracts data from a bill using SecotrFlow's AI platform.
 * @param {string} billPath - Path to the bill.
 * @param {string} sectorFlowApiKey - SectorFlow API key.
 * @returns {Promise<SectorFlowBillData>} - Bill data.
 */
export async function extractBillDataWithSectorFlow(
  billPath: string,
  sectorFlowApiKey: string
): Promise<SectorFlowBillData> {
  /*
   * Run OCR
   */

  const rawText = await extractFullPageText(billPath)

  /*
   * Connect to SectorFlow
   */

  const sectorFlow = new SectorFlow(sectorFlowApiKey)

  const projectId = await getTemporaryProjectId(sectorFlow)

  const response = await sectorFlow.sendChatMessage(
    projectId,
    `${sectorFlowPrompt}\n\n${rawText}`
  )

  const json = JSON.parse(response.choices[0].choices[0].message.content)

  /*
   * Clean up project.
   */

  await sectorFlow.deleteProject(projectId)

  return json
}