Represents an EvaluateInstancesResponse.
Package
@google-cloud/aiplatformConstructors
(constructor)(properties)
constructor(properties?: google.cloud.aiplatform.v1.IEvaluateInstancesResponse);Constructs a new EvaluateInstancesResponse.
| Parameter | |
|---|---|
| Name | Description |
properties |
IEvaluateInstancesResponse
Properties to set |
Properties
bleuResults
public bleuResults?: (google.cloud.aiplatform.v1.IBleuResults|null);EvaluateInstancesResponse bleuResults.
coherenceResult
public coherenceResult?: (google.cloud.aiplatform.v1.ICoherenceResult|null);EvaluateInstancesResponse coherenceResult.
cometResult
public cometResult?: (google.cloud.aiplatform.v1.ICometResult|null);EvaluateInstancesResponse cometResult.
evaluationResults
public evaluationResults?: ("exactMatchResults"|"bleuResults"|"rougeResults"|"fluencyResult"|"coherenceResult"|"safetyResult"|"groundednessResult"|"fulfillmentResult"|"summarizationQualityResult"|"pairwiseSummarizationQualityResult"|"summarizationHelpfulnessResult"|"summarizationVerbosityResult"|"questionAnsweringQualityResult"|"pairwiseQuestionAnsweringQualityResult"|"questionAnsweringRelevanceResult"|"questionAnsweringHelpfulnessResult"|"questionAnsweringCorrectnessResult"|"pointwiseMetricResult"|"pairwiseMetricResult"|"toolCallValidResults"|"toolNameMatchResults"|"toolParameterKeyMatchResults"|"toolParameterKvMatchResults"|"cometResult"|"metricxResult");EvaluateInstancesResponse evaluationResults.
exactMatchResults
public exactMatchResults?: (google.cloud.aiplatform.v1.IExactMatchResults|null);EvaluateInstancesResponse exactMatchResults.
fluencyResult
public fluencyResult?: (google.cloud.aiplatform.v1.IFluencyResult|null);EvaluateInstancesResponse fluencyResult.
fulfillmentResult
public fulfillmentResult?: (google.cloud.aiplatform.v1.IFulfillmentResult|null);EvaluateInstancesResponse fulfillmentResult.
groundednessResult
public groundednessResult?: (google.cloud.aiplatform.v1.IGroundednessResult|null);EvaluateInstancesResponse groundednessResult.
metricxResult
public metricxResult?: (google.cloud.aiplatform.v1.IMetricxResult|null);EvaluateInstancesResponse metricxResult.
pairwiseMetricResult
public pairwiseMetricResult?: (google.cloud.aiplatform.v1.IPairwiseMetricResult|null);EvaluateInstancesResponse pairwiseMetricResult.
pairwiseQuestionAnsweringQualityResult
public pairwiseQuestionAnsweringQualityResult?: (google.cloud.aiplatform.v1.IPairwiseQuestionAnsweringQualityResult|null);EvaluateInstancesResponse pairwiseQuestionAnsweringQualityResult.
pairwiseSummarizationQualityResult
public pairwiseSummarizationQualityResult?: (google.cloud.aiplatform.v1.IPairwiseSummarizationQualityResult|null);EvaluateInstancesResponse pairwiseSummarizationQualityResult.
pointwiseMetricResult
public pointwiseMetricResult?: (google.cloud.aiplatform.v1.IPointwiseMetricResult|null);EvaluateInstancesResponse pointwiseMetricResult.
questionAnsweringCorrectnessResult
public questionAnsweringCorrectnessResult?: (google.cloud.aiplatform.v1.IQuestionAnsweringCorrectnessResult|null);EvaluateInstancesResponse questionAnsweringCorrectnessResult.
questionAnsweringHelpfulnessResult
public questionAnsweringHelpfulnessResult?: (google.cloud.aiplatform.v1.IQuestionAnsweringHelpfulnessResult|null);EvaluateInstancesResponse questionAnsweringHelpfulnessResult.
questionAnsweringQualityResult
public questionAnsweringQualityResult?: (google.cloud.aiplatform.v1.IQuestionAnsweringQualityResult|null);EvaluateInstancesResponse questionAnsweringQualityResult.
questionAnsweringRelevanceResult
public questionAnsweringRelevanceResult?: (google.cloud.aiplatform.v1.IQuestionAnsweringRelevanceResult|null);EvaluateInstancesResponse questionAnsweringRelevanceResult.
rougeResults
public rougeResults?: (google.cloud.aiplatform.v1.IRougeResults|null);EvaluateInstancesResponse rougeResults.
safetyResult
public safetyResult?: (google.cloud.aiplatform.v1.ISafetyResult|null);EvaluateInstancesResponse safetyResult.
summarizationHelpfulnessResult
public summarizationHelpfulnessResult?: (google.cloud.aiplatform.v1.ISummarizationHelpfulnessResult|null);EvaluateInstancesResponse summarizationHelpfulnessResult.
summarizationQualityResult
public summarizationQualityResult?: (google.cloud.aiplatform.v1.ISummarizationQualityResult|null);EvaluateInstancesResponse summarizationQualityResult.
summarizationVerbosityResult
public summarizationVerbosityResult?: (google.cloud.aiplatform.v1.ISummarizationVerbosityResult|null);EvaluateInstancesResponse summarizationVerbosityResult.
toolCallValidResults
public toolCallValidResults?: (google.cloud.aiplatform.v1.IToolCallValidResults|null);EvaluateInstancesResponse toolCallValidResults.
toolNameMatchResults
public toolNameMatchResults?: (google.cloud.aiplatform.v1.IToolNameMatchResults|null);EvaluateInstancesResponse toolNameMatchResults.
toolParameterKeyMatchResults
public toolParameterKeyMatchResults?: (google.cloud.aiplatform.v1.IToolParameterKeyMatchResults|null);EvaluateInstancesResponse toolParameterKeyMatchResults.
toolParameterKvMatchResults
public toolParameterKvMatchResults?: (google.cloud.aiplatform.v1.IToolParameterKVMatchResults|null);EvaluateInstancesResponse toolParameterKvMatchResults.
Methods
create(properties)
public static create(properties?: google.cloud.aiplatform.v1.IEvaluateInstancesResponse): google.cloud.aiplatform.v1.EvaluateInstancesResponse;Creates a new EvaluateInstancesResponse instance using the specified properties.
| Parameter | |
|---|---|
| Name | Description |
properties |
IEvaluateInstancesResponse
Properties to set |
| Returns | |
|---|---|
| Type | Description |
EvaluateInstancesResponse |
EvaluateInstancesResponse instance |
decode(reader, length)
public static decode(reader: ($protobuf.Reader|Uint8Array), length?: number): google.cloud.aiplatform.v1.EvaluateInstancesResponse;Decodes an EvaluateInstancesResponse 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 |
EvaluateInstancesResponse |
EvaluateInstancesResponse |
decodeDelimited(reader)
public static decodeDelimited(reader: ($protobuf.Reader|Uint8Array)): google.cloud.aiplatform.v1.EvaluateInstancesResponse;Decodes an EvaluateInstancesResponse message from the specified reader or buffer, length delimited.
| Parameter | |
|---|---|
| Name | Description |
reader |
(Reader|Uint8Array)
Reader or buffer to decode from |
| Returns | |
|---|---|
| Type | Description |
EvaluateInstancesResponse |
EvaluateInstancesResponse |
encode(message, writer)
public static encode(message: google.cloud.aiplatform.v1.IEvaluateInstancesResponse, writer?: $protobuf.Writer): $protobuf.Writer;Encodes the specified EvaluateInstancesResponse message. Does not implicitly messages.
| Parameters | |
|---|---|
| Name | Description |
message |
IEvaluateInstancesResponse
EvaluateInstancesResponse 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.aiplatform.v1.IEvaluateInstancesResponse, writer?: $protobuf.Writer): $protobuf.Writer;Encodes the specified EvaluateInstancesResponse message, length delimited. Does not implicitly messages.
| Parameters | |
|---|---|
| Name | Description |
message |
IEvaluateInstancesResponse
EvaluateInstancesResponse 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.aiplatform.v1.EvaluateInstancesResponse;Creates an EvaluateInstancesResponse 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 |
EvaluateInstancesResponse |
EvaluateInstancesResponse |
getTypeUrl(typeUrlPrefix)
public static getTypeUrl(typeUrlPrefix?: string): string;Gets the default type url for EvaluateInstancesResponse
| 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 EvaluateInstancesResponse to JSON.
| Returns | |
|---|---|
| Type | Description |
{ [k: string]: any } |
JSON object |
toObject(message, options)
public static toObject(message: google.cloud.aiplatform.v1.EvaluateInstancesResponse, options?: $protobuf.IConversionOptions): { [k: string]: any };Creates a plain object from an EvaluateInstancesResponse message. Also converts values to other types if specified.
| Parameters | |
|---|---|
| Name | Description |
message |
EvaluateInstancesResponse
EvaluateInstancesResponse |
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 an EvaluateInstancesResponse message.
| Parameter | |
|---|---|
| Name | Description |
message |
{ [k: string]: any }
Plain object to verify |
| Returns | |
|---|---|
| Type | Description |
(string|null) |
|