Class GeneratedV1Document

Generated V1 document prediction results.

Hierarchy

GeneratedV1Prediction
- GeneratedV1Document

Index

Constructors

Properties

Methods

getArrayFields getObjectFields getSingleField listFieldNames toString

Constructors

constructor

new GeneratedV1Document(rawPrediction: StringDict): GeneratedV1Document
Parameters
- rawPrediction: StringDict
Returns GeneratedV1Document
Overrides GeneratedV1Prediction.constructor
- Defined in src/product/generated/generatedV1Document.ts:10

Properties

fields

fields: Map<string, any>

Map of all fields in the document.

Methods

getArrayFields

getArrayFields(): Map<string, GeneratedListField>
Returns a dictionary of all array-like fields.

Returns Map<string, GeneratedListField>
Inherited from GeneratedV1Prediction.getArrayFields
- Defined in src/product/generated/generatedV1Prediction.ts:66

getObjectFields

getObjectFields(): Map<string, GeneratedListField>
Returns a dictionary of all object-like fields.

Returns Map<string, GeneratedListField>
Inherited from GeneratedV1Prediction.getObjectFields
- Defined in src/product/generated/generatedV1Prediction.ts:79

getSingleField

getSingleField(): Map<string, StringField>
Returns a dictionary of all fields that aren't a collection.

Returns Map<string, StringField>
Inherited from GeneratedV1Prediction.getSingleField
- Defined in src/product/generated/generatedV1Prediction.ts:53

listFieldNames

listFieldNames(): string[]
Lists names of all top-level field keys.

Returns string[]
Inherited from GeneratedV1Prediction.listFieldNames
- Defined in src/product/generated/generatedV1Prediction.ts:92

toString

toString(): string
Returns string
Inherited from GeneratedV1Prediction.toString
- Defined in src/product/generated/generatedV1Prediction.ts:14

Generated using TypeDoc