Class AnnotatedListField

Field having a list of fields.

Hierarchy

AnnotatedBaseField
- AnnotatedListField

Index

Constructors

Properties

guidelines items selected

Accessors

objectItems simpleItems

Methods

Constructors

constructor

new AnnotatedListField(serverResponse: StringDict): AnnotatedListField
Parameters
- serverResponse: StringDict
Returns AnnotatedListField
Overrides AnnotatedBaseField.constructor
- Defined in src/v2/product/extraction/ragDocuments/annotatedListField.ts:17

Properties

guidelines

guidelines: string | null

Guidelines or instructions for processing this field.

items

items: (AnnotatedSimpleField | AnnotatedListField | AnnotatedObjectField)[]

Items contained in the list.

selected

selected: boolean

When true, use the RAG information for the final result. When false, use the Data Schema information.

Accessors

objectItems

get objectItems(): AnnotatedObjectField[]
AnnotatedObjectField items from the list.

Returns AnnotatedObjectField[]
- Defined in src/v2/product/extraction/ragDocuments/annotatedListField.ts:51

simpleItems

get simpleItems(): AnnotatedSimpleField[]
AnnotatedSimpleField items from the list.

Returns AnnotatedSimpleField[]
- Defined in src/v2/product/extraction/ragDocuments/annotatedListField.ts:33

Methods

toString

toString(): string
Returns a readable representation of list items.

Returns string
- Defined in src/v2/product/extraction/ragDocuments/annotatedListField.ts:69