Represents an EvaluateInstancesRequest.
Package
@google-cloud/aiplatformConstructors
(constructor)(properties)
constructor(properties?: google.cloud.aiplatform.v1beta1.IEvaluateInstancesRequest);Constructs a new EvaluateInstancesRequest.
| Parameter | |
|---|---|
| Name | Description |
properties |
IEvaluateInstancesRequest
Properties to set |
Properties
autoraterConfig
public autoraterConfig?: (google.cloud.aiplatform.v1beta1.IAutoraterConfig|null);EvaluateInstancesRequest autoraterConfig.
bleuInput
public bleuInput?: (google.cloud.aiplatform.v1beta1.IBleuInput|null);EvaluateInstancesRequest bleuInput.
coherenceInput
public coherenceInput?: (google.cloud.aiplatform.v1beta1.ICoherenceInput|null);EvaluateInstancesRequest coherenceInput.
cometInput
public cometInput?: (google.cloud.aiplatform.v1beta1.ICometInput|null);EvaluateInstancesRequest cometInput.
exactMatchInput
public exactMatchInput?: (google.cloud.aiplatform.v1beta1.IExactMatchInput|null);EvaluateInstancesRequest exactMatchInput.
fluencyInput
public fluencyInput?: (google.cloud.aiplatform.v1beta1.IFluencyInput|null);EvaluateInstancesRequest fluencyInput.
fulfillmentInput
public fulfillmentInput?: (google.cloud.aiplatform.v1beta1.IFulfillmentInput|null);EvaluateInstancesRequest fulfillmentInput.
groundednessInput
public groundednessInput?: (google.cloud.aiplatform.v1beta1.IGroundednessInput|null);EvaluateInstancesRequest groundednessInput.
location
public location: string;EvaluateInstancesRequest location.
metricInputs
public metricInputs?: ("exactMatchInput"|"bleuInput"|"rougeInput"|"fluencyInput"|"coherenceInput"|"safetyInput"|"groundednessInput"|"fulfillmentInput"|"summarizationQualityInput"|"pairwiseSummarizationQualityInput"|"summarizationHelpfulnessInput"|"summarizationVerbosityInput"|"questionAnsweringQualityInput"|"pairwiseQuestionAnsweringQualityInput"|"questionAnsweringRelevanceInput"|"questionAnsweringHelpfulnessInput"|"questionAnsweringCorrectnessInput"|"pointwiseMetricInput"|"pairwiseMetricInput"|"toolCallValidInput"|"toolNameMatchInput"|"toolParameterKeyMatchInput"|"toolParameterKvMatchInput"|"cometInput"|"metricxInput"|"trajectoryExactMatchInput"|"trajectoryInOrderMatchInput"|"trajectoryAnyOrderMatchInput"|"trajectoryPrecisionInput"|"trajectoryRecallInput"|"trajectorySingleToolUseInput"|"rubricBasedInstructionFollowingInput");EvaluateInstancesRequest metricInputs.
metricxInput
public metricxInput?: (google.cloud.aiplatform.v1beta1.IMetricxInput|null);EvaluateInstancesRequest metricxInput.
pairwiseMetricInput
public pairwiseMetricInput?: (google.cloud.aiplatform.v1beta1.IPairwiseMetricInput|null);EvaluateInstancesRequest pairwiseMetricInput.
pairwiseQuestionAnsweringQualityInput
public pairwiseQuestionAnsweringQualityInput?: (google.cloud.aiplatform.v1beta1.IPairwiseQuestionAnsweringQualityInput|null);EvaluateInstancesRequest pairwiseQuestionAnsweringQualityInput.
pairwiseSummarizationQualityInput
public pairwiseSummarizationQualityInput?: (google.cloud.aiplatform.v1beta1.IPairwiseSummarizationQualityInput|null);EvaluateInstancesRequest pairwiseSummarizationQualityInput.
pointwiseMetricInput
public pointwiseMetricInput?: (google.cloud.aiplatform.v1beta1.IPointwiseMetricInput|null);EvaluateInstancesRequest pointwiseMetricInput.
questionAnsweringCorrectnessInput
public questionAnsweringCorrectnessInput?: (google.cloud.aiplatform.v1beta1.IQuestionAnsweringCorrectnessInput|null);EvaluateInstancesRequest questionAnsweringCorrectnessInput.
questionAnsweringHelpfulnessInput
public questionAnsweringHelpfulnessInput?: (google.cloud.aiplatform.v1beta1.IQuestionAnsweringHelpfulnessInput|null);EvaluateInstancesRequest questionAnsweringHelpfulnessInput.
questionAnsweringQualityInput
public questionAnsweringQualityInput?: (google.cloud.aiplatform.v1beta1.IQuestionAnsweringQualityInput|null);EvaluateInstancesRequest questionAnsweringQualityInput.
questionAnsweringRelevanceInput
public questionAnsweringRelevanceInput?: (google.cloud.aiplatform.v1beta1.IQuestionAnsweringRelevanceInput|null);EvaluateInstancesRequest questionAnsweringRelevanceInput.
rougeInput
public rougeInput?: (google.cloud.aiplatform.v1beta1.IRougeInput|null);EvaluateInstancesRequest rougeInput.
rubricBasedInstructionFollowingInput
public rubricBasedInstructionFollowingInput?: (google.cloud.aiplatform.v1beta1.IRubricBasedInstructionFollowingInput|null);EvaluateInstancesRequest rubricBasedInstructionFollowingInput.
safetyInput
public safetyInput?: (google.cloud.aiplatform.v1beta1.ISafetyInput|null);EvaluateInstancesRequest safetyInput.
summarizationHelpfulnessInput
public summarizationHelpfulnessInput?: (google.cloud.aiplatform.v1beta1.ISummarizationHelpfulnessInput|null);EvaluateInstancesRequest summarizationHelpfulnessInput.
summarizationQualityInput
public summarizationQualityInput?: (google.cloud.aiplatform.v1beta1.ISummarizationQualityInput|null);EvaluateInstancesRequest summarizationQualityInput.
summarizationVerbosityInput
public summarizationVerbosityInput?: (google.cloud.aiplatform.v1beta1.ISummarizationVerbosityInput|null);EvaluateInstancesRequest summarizationVerbosityInput.
toolCallValidInput
public toolCallValidInput?: (google.cloud.aiplatform.v1beta1.IToolCallValidInput|null);EvaluateInstancesRequest toolCallValidInput.
toolNameMatchInput
public toolNameMatchInput?: (google.cloud.aiplatform.v1beta1.IToolNameMatchInput|null);EvaluateInstancesRequest toolNameMatchInput.
toolParameterKeyMatchInput
public toolParameterKeyMatchInput?: (google.cloud.aiplatform.v1beta1.IToolParameterKeyMatchInput|null);EvaluateInstancesRequest toolParameterKeyMatchInput.
toolParameterKvMatchInput
public toolParameterKvMatchInput?: (google.cloud.aiplatform.v1beta1.IToolParameterKVMatchInput|null);EvaluateInstancesRequest toolParameterKvMatchInput.
trajectoryAnyOrderMatchInput
public trajectoryAnyOrderMatchInput?: (google.cloud.aiplatform.v1beta1.ITrajectoryAnyOrderMatchInput|null);EvaluateInstancesRequest trajectoryAnyOrderMatchInput.
trajectoryExactMatchInput
public trajectoryExactMatchInput?: (google.cloud.aiplatform.v1beta1.ITrajectoryExactMatchInput|null);EvaluateInstancesRequest trajectoryExactMatchInput.
trajectoryInOrderMatchInput
public trajectoryInOrderMatchInput?: (google.cloud.aiplatform.v1beta1.ITrajectoryInOrderMatchInput|null);EvaluateInstancesRequest trajectoryInOrderMatchInput.
trajectoryPrecisionInput
public trajectoryPrecisionInput?: (google.cloud.aiplatform.v1beta1.ITrajectoryPrecisionInput|null);EvaluateInstancesRequest trajectoryPrecisionInput.
trajectoryRecallInput
public trajectoryRecallInput?: (google.cloud.aiplatform.v1beta1.ITrajectoryRecallInput|null);EvaluateInstancesRequest trajectoryRecallInput.
trajectorySingleToolUseInput
public trajectorySingleToolUseInput?: (google.cloud.aiplatform.v1beta1.ITrajectorySingleToolUseInput|null);EvaluateInstancesRequest trajectorySingleToolUseInput.
Methods
create(properties)
public static create(properties?: google.cloud.aiplatform.v1beta1.IEvaluateInstancesRequest): google.cloud.aiplatform.v1beta1.EvaluateInstancesRequest;Creates a new EvaluateInstancesRequest instance using the specified properties.
| Parameter | |
|---|---|
| Name | Description |
properties |
IEvaluateInstancesRequest
Properties to set |
| Returns | |
|---|---|
| Type | Description |
EvaluateInstancesRequest |
EvaluateInstancesRequest instance |
decode(reader, length)
public static decode(reader: ($protobuf.Reader|Uint8Array), length?: number): google.cloud.aiplatform.v1beta1.EvaluateInstancesRequest;Decodes an EvaluateInstancesRequest 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 |
EvaluateInstancesRequest |
EvaluateInstancesRequest |
decodeDelimited(reader)
public static decodeDelimited(reader: ($protobuf.Reader|Uint8Array)): google.cloud.aiplatform.v1beta1.EvaluateInstancesRequest;Decodes an EvaluateInstancesRequest message from the specified reader or buffer, length delimited.
| Parameter | |
|---|---|
| Name | Description |
reader |
(Reader|Uint8Array)
Reader or buffer to decode from |
| Returns | |
|---|---|
| Type | Description |
EvaluateInstancesRequest |
EvaluateInstancesRequest |
encode(message, writer)
public static encode(message: google.cloud.aiplatform.v1beta1.IEvaluateInstancesRequest, writer?: $protobuf.Writer): $protobuf.Writer;Encodes the specified EvaluateInstancesRequest message. Does not implicitly messages.
| Parameters | |
|---|---|
| Name | Description |
message |
IEvaluateInstancesRequest
EvaluateInstancesRequest 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.v1beta1.IEvaluateInstancesRequest, writer?: $protobuf.Writer): $protobuf.Writer;Encodes the specified EvaluateInstancesRequest message, length delimited. Does not implicitly messages.
| Parameters | |
|---|---|
| Name | Description |
message |
IEvaluateInstancesRequest
EvaluateInstancesRequest 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.v1beta1.EvaluateInstancesRequest;Creates an EvaluateInstancesRequest 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 |
EvaluateInstancesRequest |
EvaluateInstancesRequest |
getTypeUrl(typeUrlPrefix)
public static getTypeUrl(typeUrlPrefix?: string): string;Gets the default type url for EvaluateInstancesRequest
| 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 EvaluateInstancesRequest to JSON.
| Returns | |
|---|---|
| Type | Description |
{ [k: string]: any } |
JSON object |
toObject(message, options)
public static toObject(message: google.cloud.aiplatform.v1beta1.EvaluateInstancesRequest, options?: $protobuf.IConversionOptions): { [k: string]: any };Creates a plain object from an EvaluateInstancesRequest message. Also converts values to other types if specified.
| Parameters | |
|---|---|
| Name | Description |
message |
EvaluateInstancesRequest
EvaluateInstancesRequest |
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 EvaluateInstancesRequest message.
| Parameter | |
|---|---|
| Name | Description |
message |
{ [k: string]: any }
Plain object to verify |
| Returns | |
|---|---|
| Type | Description |
(string|null) |
|