Interface ExtractAIMessageOptions

Extract structured data from an existing email or SMS. Supply exactly one of extractionPreset, outputSchema or transformId. Required strings must be grounded in source evidence; missing or ambiguous fields are reported as INCONCLUSIVE.

Export

Interface

ExtractAIMessageOptions

Hierarchy

  • ExtractAIMessageOptions

Properties

aiOptions extractionPreset? instructions? message outputSchema? timeout transformId?

Properties

aiOptions

aiOptions: AIMessageAIOptions

Memberof

ExtractAIMessageOptions

Optional extractionPreset

extractionPreset?: OTP_CODE

Built-in extraction schema. OTP_CODE returns data.code as a verbatim string, preserving leading zeros and letter case. Missing or equally eligible codes are INCONCLUSIVE.

Memberof

ExtractAIMessageOptions

Optional instructions

instructions?: string

Memberof

ExtractAIMessageOptions

message

message: AIMessageReference

Memberof

ExtractAIMessageOptions

Optional outputSchema

outputSchema?: StructuredOutputSchema

Memberof

ExtractAIMessageOptions

timeout

timeout: number

Memberof

ExtractAIMessageOptions

Optional transformId

transformId?: string

Memberof

ExtractAIMessageOptions

Settings

Member Visibility

Theme