Class protos.google.cloud.documentai.v1.Evaluation.MultiConfidenceMetrics (8.8.0)

Represents a MultiConfidenceMetrics.

Package

@google-cloud/documentai

Constructors

(constructor)(properties)

constructor(properties?: google.cloud.documentai.v1.Evaluation.IMultiConfidenceMetrics);

Constructs a new MultiConfidenceMetrics.

Parameter
Name Description
properties IMultiConfidenceMetrics

Properties to set

Properties

auprc

public auprc: number;

MultiConfidenceMetrics auprc.

auprcExact

public auprcExact: number;

MultiConfidenceMetrics auprcExact.

confidenceLevelMetrics

public confidenceLevelMetrics: google.cloud.documentai.v1.Evaluation.IConfidenceLevelMetrics[];

MultiConfidenceMetrics confidenceLevelMetrics.

confidenceLevelMetricsExact

public confidenceLevelMetricsExact: google.cloud.documentai.v1.Evaluation.IConfidenceLevelMetrics[];

MultiConfidenceMetrics confidenceLevelMetricsExact.

estimatedCalibrationError

public estimatedCalibrationError: number;

MultiConfidenceMetrics estimatedCalibrationError.

estimatedCalibrationErrorExact

public estimatedCalibrationErrorExact: number;

MultiConfidenceMetrics estimatedCalibrationErrorExact.

metricsType

public metricsType: (google.cloud.documentai.v1.Evaluation.MultiConfidenceMetrics.MetricsType|keyof typeof google.cloud.documentai.v1.Evaluation.MultiConfidenceMetrics.MetricsType);

MultiConfidenceMetrics metricsType.

Methods

create(properties)

public static create(properties?: google.cloud.documentai.v1.Evaluation.IMultiConfidenceMetrics): google.cloud.documentai.v1.Evaluation.MultiConfidenceMetrics;

Creates a new MultiConfidenceMetrics instance using the specified properties.

Parameter
Name Description
properties IMultiConfidenceMetrics

Properties to set

Returns
Type Description
MultiConfidenceMetrics

MultiConfidenceMetrics instance

decode(reader, length)

public static decode(reader: ($protobuf.Reader|Uint8Array), length?: number): google.cloud.documentai.v1.Evaluation.MultiConfidenceMetrics;

Decodes a MultiConfidenceMetrics message from the specified reader or buffer.

Parameters
Name Description
reader (Reader|Uint8Array)

Reader or buffer to decode from

length number

Message length if known beforehand

Returns
Type Description
MultiConfidenceMetrics

MultiConfidenceMetrics

decodeDelimited(reader)

public static decodeDelimited(reader: ($protobuf.Reader|Uint8Array)): google.cloud.documentai.v1.Evaluation.MultiConfidenceMetrics;

Decodes a MultiConfidenceMetrics message from the specified reader or buffer, length delimited.

Parameter
Name Description
reader (Reader|Uint8Array)

Reader or buffer to decode from

Returns
Type Description
MultiConfidenceMetrics

MultiConfidenceMetrics

encode(message, writer)

public static encode(message: google.cloud.documentai.v1.Evaluation.IMultiConfidenceMetrics, writer?: $protobuf.Writer): $protobuf.Writer;

Encodes the specified MultiConfidenceMetrics message. Does not implicitly messages.

Parameters
Name Description
message IMultiConfidenceMetrics

MultiConfidenceMetrics message or plain object to encode

writer $protobuf.Writer

Writer to encode to

Returns
Type Description
$protobuf.Writer

Writer

encodeDelimited(message, writer)

public static encodeDelimited(message: google.cloud.documentai.v1.Evaluation.IMultiConfidenceMetrics, writer?: $protobuf.Writer): $protobuf.Writer;

Encodes the specified MultiConfidenceMetrics message, length delimited. Does not implicitly messages.

Parameters
Name Description
message IMultiConfidenceMetrics

MultiConfidenceMetrics message or plain object to encode

writer $protobuf.Writer

Writer to encode to

Returns
Type Description
$protobuf.Writer

Writer

fromObject(object)

public static fromObject(object: { [k: string]: any }): google.cloud.documentai.v1.Evaluation.MultiConfidenceMetrics;

Creates a MultiConfidenceMetrics message from a plain object. Also converts values to their respective internal types.

Parameter
Name Description
object { [k: string]: any }

Plain object

Returns
Type Description
MultiConfidenceMetrics

MultiConfidenceMetrics

getTypeUrl(typeUrlPrefix)

public static getTypeUrl(typeUrlPrefix?: string): string;

Gets the default type url for MultiConfidenceMetrics

Parameter
Name Description
typeUrlPrefix string

your custom typeUrlPrefix(default "type.googleapis.com")

Returns
Type Description
string

The default type url

toJSON()

public toJSON(): { [k: string]: any };

Converts this MultiConfidenceMetrics to JSON.

Returns
Type Description
{ [k: string]: any }

JSON object

toObject(message, options)

public static toObject(message: google.cloud.documentai.v1.Evaluation.MultiConfidenceMetrics, options?: $protobuf.IConversionOptions): { [k: string]: any };

Creates a plain object from a MultiConfidenceMetrics message. Also converts values to other types if specified.

Parameters
Name Description
message MultiConfidenceMetrics

MultiConfidenceMetrics

options $protobuf.IConversionOptions

Conversion options

Returns
Type Description
{ [k: string]: any }

Plain object

verify(message)

public static verify(message: { [k: string]: any }): (string|null);

Verifies a MultiConfidenceMetrics message.

Parameter
Name Description
message { [k: string]: any }

Plain object to verify

Returns
Type Description
(string|null)

null if valid, otherwise the reason why it is not