Interface EntityExtractionResult<T>

Result of entity extraction.

interface EntityExtractionResult<T> {
    success: boolean;
    entities: T[];
    confidenceScores?: number[];
    sourceSpans?: {
        start: number;
        end: number;
        text: string;
    }[];
    issues?: string[];
    tokenUsage?: {
        promptTokens: number;
        completionTokens: number;
        totalTokens: number;
    };
}

Type Parameters

  • T = unknown

Properties

success entities confidenceScores? sourceSpans? issues? tokenUsage?

Properties

success

success: boolean

Whether extraction succeeded

entities

entities: T[]

Extracted entities

Optional confidenceScores

confidenceScores?: number[]

Confidence scores for each entity (0-1)

Optional sourceSpans

sourceSpans?: {
    start: number;
    end: number;
    text: string;
}[]

Source text spans for each entity

Type declaration

  • start: number
  • end: number
  • text: string

Optional issues

issues?: string[]

Any extraction issues

Optional tokenUsage

tokenUsage?: {
    promptTokens: number;
    completionTokens: number;
    totalTokens: number;
}

Token usage

Type declaration

  • promptTokens: number
  • completionTokens: number
  • totalTokens: number

Settings

Member Visibility

Theme

On This Page

successentitiesconfidenceScoressourceSpansissuestokenUsage