--- title: "GET /v1/projects/{projectsId}/locations/{locationsId}/onlineEvaluators" method: GET path: "/v1/projects/{projectsId}/locations/{locationsId}/onlineEvaluators" tags: ["projects"] --- # GET /v1/projects/{projectsId}/locations/{locationsId}/onlineEvaluators `GET /v1/projects/{projectsId}/locations/{locationsId}/onlineEvaluators` ## Request - Base URL: `https://aiplatform.googleapis.com` - URL: `https://aiplatform.googleapis.com/v1/projects/{projectsId}/locations/{locationsId}/onlineEvaluators` - Auth: OAuth 2 and OAuth 2 - Implicit: `https://accounts.google.com/o/oauth2/auth` - Scopes: `https://www.googleapis.com/auth/cloud-platform` - Authorization code: `https://accounts.google.com/o/oauth2/auth` - Token URL: `https://accounts.google.com/o/oauth2/token` scopes: `https://www.googleapis.com/auth/cloud-platform` Lists the OnlineEvaluators for the given project and location. ## Path parameters - `projectsId` string, required - `locationsId` string, required ## Query parameters - `filter` string - `orderBy` string - `pageSize` integer - `pageToken` string ## Response `200` Successful response - GoogleCloudAiplatformV1ListOnlineEvaluatorsResponse: Response message for ListOnlineEvaluators. - `nextPageToken` string: A token to retrieve the next page. Absence of this field indicates there are no subsequent pages. - `onlineEvaluators` GoogleCloudAiplatformV1OnlineEvaluator[]: A list of OnlineEvaluators matching the request. - `agentResource` string: Required. Immutable. The name of the agent that the OnlineEvaluator evaluates periodically. This value is used to filter the traces with a matching cloud.resource_id and link the evaluation results with relevant dashboards/UIs. This field is immutable. Once set, it cannot be changed. - `cloudObservability` GoogleCloudAiplatformV1OnlineEvaluatorCloudObservability: Data source for the OnlineEvaluator, based on Google Cloud Observability stack (Cloud Trace & Cloud Logging). - `logView` string: Optional. Optional log view that will be used to query logs. If empty, the project's default view (`projects/{project_id}`) will be used. - `openTelemetry` GoogleCloudAiplatformV1OnlineEvaluatorCloudObservabilityOpenTelemetry: Configuration for data source following OpenTelemetry. - `semconvVersion` string: Required. Defines which version OTel Semantic Convention the data follows. Can be "1.39.0" or newer. - `sessionScope` GoogleCloudAiplatformV1OnlineEvaluatorCloudObservabilitySessionScope: If chosen, the online evaluator will evaluate sessions matching specified `filter`. A session is a group of traces with a common `gen_ai.conversation.id`. - `filter` GoogleCloudAiplatformV1OnlineEvaluatorCloudObservabilitySessionScopePredicate[]: Optional. A list of predicates to filter sessions. Multiple predicates are combined using AND. The maximum number of predicates is 10. - `duration` GoogleCloudAiplatformV1OnlineEvaluatorCloudObservabilityNumericPredicate: Defines a predicate for filtering based on a numeric value. - `comparisonOperator` 'COMPARISON_OPERATOR_UNSPECIFIED' | 'LESS' | 'LESS_OR_EQUAL' | 'EQUAL' | 'NOT_EQUAL' | 'GREATER_OR_EQUAL' | 'GREATER': Required. The comparison operator to apply. - `value` number, float: Required. The value to compare against. - `modelCallErrors` GoogleCloudAiplatformV1OnlineEvaluatorCloudObservabilityNumericPredicate: Defines a predicate for filtering based on a numeric value. - `comparisonOperator` 'COMPARISON_OPERATOR_UNSPECIFIED' | 'LESS' | 'LESS_OR_EQUAL' | 'EQUAL' | 'NOT_EQUAL' | 'GREATER_OR_EQUAL' | 'GREATER': Required. The comparison operator to apply. - `value` number, float: Required. The value to compare against. - `modelCalls` GoogleCloudAiplatformV1OnlineEvaluatorCloudObservabilityNumericPredicate: Defines a predicate for filtering based on a numeric value. - `comparisonOperator` 'COMPARISON_OPERATOR_UNSPECIFIED' | 'LESS' | 'LESS_OR_EQUAL' | 'EQUAL' | 'NOT_EQUAL' | 'GREATER_OR_EQUAL' | 'GREATER': Required. The comparison operator to apply. - `value` number, float: Required. The value to compare against. - `serviceVersion` GoogleCloudAiplatformV1OnlineEvaluatorCloudObservabilityStringPredicate: Defines a predicate for filtering based on a string value. - `values` string[]: Required. The values to match exactly (case-sensitive). Requires 1 to 20 values, each at most 128 characters long. - `toolCallErrors` GoogleCloudAiplatformV1OnlineEvaluatorCloudObservabilityNumericPredicate: Defines a predicate for filtering based on a numeric value. - `comparisonOperator` 'COMPARISON_OPERATOR_UNSPECIFIED' | 'LESS' | 'LESS_OR_EQUAL' | 'EQUAL' | 'NOT_EQUAL' | 'GREATER_OR_EQUAL' | 'GREATER': Required. The comparison operator to apply. - `value` number, float: Required. The value to compare against. - `toolCalls` GoogleCloudAiplatformV1OnlineEvaluatorCloudObservabilityNumericPredicate: Defines a predicate for filtering based on a numeric value. - `comparisonOperator` 'COMPARISON_OPERATOR_UNSPECIFIED' | 'LESS' | 'LESS_OR_EQUAL' | 'EQUAL' | 'NOT_EQUAL' | 'GREATER_OR_EQUAL' | 'GREATER': Required. The comparison operator to apply. - `value` number, float: Required. The value to compare against. - `totalTokenUsage` GoogleCloudAiplatformV1OnlineEvaluatorCloudObservabilityNumericPredicate: Defines a predicate for filtering based on a numeric value. - `comparisonOperator` 'COMPARISON_OPERATOR_UNSPECIFIED' | 'LESS' | 'LESS_OR_EQUAL' | 'EQUAL' | 'NOT_EQUAL' | 'GREATER_OR_EQUAL' | 'GREATER': Required. The comparison operator to apply. - `value` number, float: Required. The value to compare against. - `userTurns` GoogleCloudAiplatformV1OnlineEvaluatorCloudObservabilityNumericPredicate: Defines a predicate for filtering based on a numeric value. - `comparisonOperator` 'COMPARISON_OPERATOR_UNSPECIFIED' | 'LESS' | 'LESS_OR_EQUAL' | 'EQUAL' | 'NOT_EQUAL' | 'GREATER_OR_EQUAL' | 'GREATER': Required. The comparison operator to apply. - `value` number, float: Required. The value to compare against. - `inactivityTrigger` GoogleCloudAiplatformV1OnlineEvaluatorCloudObservabilitySessionScopeInactivityTrigger: Configuration for inactivity based session completion. - `threshold` string, google-duration: Required. The amount of time that must pass with no new traces before a session is considered ready for evaluation. This is a required field if InactivityTrigger is used. The value must be a positive duration no greater than 7 days (604800 seconds). - `traceScope` GoogleCloudAiplatformV1OnlineEvaluatorCloudObservabilityTraceScope: If chosen, the online evaluator will evaluate single traces matching specified `filter`. - `filter` GoogleCloudAiplatformV1OnlineEvaluatorCloudObservabilityTraceScopePredicate[]: Optional. A list of predicates to filter traces. Multiple predicates are combined using AND. The maximum number of predicates is 10. - `duration` GoogleCloudAiplatformV1OnlineEvaluatorCloudObservabilityNumericPredicate: Defines a predicate for filtering based on a numeric value. - `comparisonOperator` 'COMPARISON_OPERATOR_UNSPECIFIED' | 'LESS' | 'LESS_OR_EQUAL' | 'EQUAL' | 'NOT_EQUAL' | 'GREATER_OR_EQUAL' | 'GREATER': Required. The comparison operator to apply. - `value` number, float: Required. The value to compare against. - `serviceVersion` GoogleCloudAiplatformV1OnlineEvaluatorCloudObservabilityStringPredicate: Defines a predicate for filtering based on a string value. - `values` string[]: Required. The values to match exactly (case-sensitive). Requires 1 to 20 values, each at most 128 characters long. - `totalTokenUsage` GoogleCloudAiplatformV1OnlineEvaluatorCloudObservabilityNumericPredicate: Defines a predicate for filtering based on a numeric value. - `comparisonOperator` 'COMPARISON_OPERATOR_UNSPECIFIED' | 'LESS' | 'LESS_OR_EQUAL' | 'EQUAL' | 'NOT_EQUAL' | 'GREATER_OR_EQUAL' | 'GREATER': Required. The comparison operator to apply. - `value` number, float: Required. The value to compare against. - `traceView` string: Optional. Optional trace view that will be used to query traces. If empty, the `_AllSpans` view from `_Trace` US bucket will be used, i.e. `projects/{project_id}/locations/us/buckets/_Trace/datasets/Spans/views/_AllSpans`. - `config` GoogleCloudAiplatformV1OnlineEvaluatorConfig: Configuration for sampling behavior of the OnlineEvaluator. The OnlineEvaluator runs at a fixed interval of 10 minutes. - `maxEvaluatedSamplesPerRun` string, int64: Optional. The maximum number of evaluations to perform per run. If set to 0, the number is unbounded. - `randomSampling` GoogleCloudAiplatformV1OnlineEvaluatorConfigRandomSampling: Configuration for random sampling. - `percentage` integer: Required. The percentage of traces to sample for evaluation. Must be an integer between `1` and `100`. - `createTime` string, google-datetime: Output only. Timestamp when the OnlineEvaluator was created. - `displayName` string: Optional. Human-readable name for the OnlineEvaluator. The name doesn't have to be unique. The name can consist of any UTF-8 characters. The maximum length is `63` characters. If the display name exceeds max characters, an `INVALID_ARGUMENT` error is returned. - `metricSources` GoogleCloudAiplatformV1MetricSource[]: Required. A list of metric sources to be used for evaluating samples. At least one MetricSource must be provided. Right now, only predefined metrics and registered metrics are supported. Every registered metric must have `display_name` (or `title`) and `score_range` defined. Otherwise, the evaluations will fail. The maximum number of `metric_sources` is 25. - `metric` GoogleCloudAiplatformV1Metric: The metric used for running evaluations. - `aggregationMetrics` string[]: Optional. The aggregation metrics to use. - `bleuSpec` GoogleCloudAiplatformV1BleuSpec: Spec for bleu score metric - calculates the precision of n-grams in the prediction as compared to reference - returns a score ranging between 0 to 1. - `useEffectiveOrder` boolean: Optional. Whether to use_effective_order to compute bleu score. - `computationBasedMetricSpec` GoogleCloudAiplatformV1ComputationBasedMetricSpec: Specification for a computation based metric. - `parameters` object: Optional. A map of parameters for the metric, e.g. {"rouge_type": "rougeL"}. - `type` 'COMPUTATION_BASED_METRIC_TYPE_UNSPECIFIED' | 'EXACT_MATCH' | 'BLEU' | 'ROUGE': Required. The type of the computation based metric. - `customCodeExecutionSpec` GoogleCloudAiplatformV1CustomCodeExecutionSpec: Specificies a metric that is populated by evaluating user-defined Python code. - `evaluationFunction` string: Required. Python function. Expected user to define the following function, e.g.: def evaluate(instance: dict[str, Any]) -> float: Please include this function signature in the code snippet. Instance is the evaluation instance, any fields populated in the instance are available to the function as instance[field_name]. Example: Example input: ``` instance= EvaluationInstance( response=EvaluationInstance.InstanceData(text="The answer is 4."), reference=EvaluationInstance.InstanceData(text="4") ) ``` Example converted input: ``` { 'response': {'text': 'The answer is 4.'}, 'reference': {'text': '4'} } ``` Example python function: ``` def evaluate(instance: dict[str, Any]) -> float: if instance'response' == instance'reference': return 1.0 return 0.0 ``` CustomCodeExecutionSpec is also supported in Batch Evaluation (EvalDataset RPC) and Tuning Evaluation. Each line in the input jsonl file will be converted to dict[str, Any] and passed to the evaluation function. - `exactMatchSpec` GoogleCloudAiplatformV1ExactMatchSpec: Spec for exact match metric - returns 1 if prediction and reference exactly matches, otherwise 0. - `llmBasedMetricSpec` GoogleCloudAiplatformV1LLMBasedMetricSpec: Specification for an LLM based metric. - `additionalConfig` object: Optional. Optional additional configuration for the metric. - `judgeAutoraterConfig` GoogleCloudAiplatformV1AutoraterConfig: The configs for autorater. This is applicable to both EvaluateInstances and EvaluateDataset. - `autoraterModel` string: Optional. The fully qualified name of the publisher model or tuned autorater endpoint to use. Publisher model format: `projects/{project}/locations/{location}/publishers/*/models/*` Tuned model endpoint format: `projects/{project}/locations/{location}/endpoints/{endpoint}` - `flipEnabled` boolean: Optional. Default is true. Whether to flip the candidate and baseline responses. This is only applicable to the pairwise metric. If enabled, also provide PairwiseMetricSpec.candidate_response_field_name and PairwiseMetricSpec.baseline_response_field_name. When rendering PairwiseMetricSpec.metric_prompt_template, the candidate and baseline fields will be flipped for half of the samples to reduce bias. - `generationConfig` GoogleCloudAiplatformV1GenerationConfig: Configuration for content generation. This message contains all the parameters that control how the model generates content. It allows you to influence the randomness, length, and structure of the output. - … - `samplingCount` integer: Optional. Number of samples for each instance in the dataset. If not specified, the default is 4. Minimum value is 1, maximum value is 32. - `metricPromptTemplate` string: Required. Template for the prompt sent to the judge model. - `predefinedRubricGenerationSpec` GoogleCloudAiplatformV1PredefinedMetricSpec: The spec for a pre-defined metric. - `metricSpecName` string: Required. The name of a pre-defined metric, such as "instruction_following_v1" or "text_quality_v1". - `metricSpecParameters` object: Optional. The parameters needed to run the pre-defined metric. - `resultParserConfig` GoogleCloudAiplatformV1EvaluationParserConfig: Config for parsing LLM responses. It can be used to parse the LLM response to be evaluated, or the LLM response from LLM-based metrics/Autoraters. - `customCodeParserConfig` GoogleCloudAiplatformV1EvaluationParserConfigCustomCodeParserConfig: Configuration for parsing the LLM response using custom code. - … - `rubricGenerationSpec` GoogleCloudAiplatformV1RubricGenerationSpec: Specification for how rubrics should be generated. - `modelConfig` GoogleCloudAiplatformV1AutoraterConfig: The configs for autorater. This is applicable to both EvaluateInstances and EvaluateDataset. - … - `promptTemplate` string: Template for the prompt used to generate rubrics. The details should be updated based on the most-recent recipe requirements. - `rubricContentType` 'RUBRIC_CONTENT_TYPE_UNSPECIFIED' | 'PROPERTY' | 'NL_QUESTION_ANSWER' | 'PYTHON_CODE_ASSERTION': The type of rubric content to be generated. - `rubricTypeOntology` string[]: Optional. An optional, pre-defined list of allowed types for generated rubrics. If this field is provided, it implies `include_rubric_type` should be true, and the generated rubric types should be chosen from this ontology. - `rubricGroupKey` string: Use a pre-defined group of rubrics associated with the input. Refers to a key in the rubric_groups map of EvaluationInstance. - `systemInstruction` string: Optional. System instructions for the judge model. - `metadata` GoogleCloudAiplatformV1MetricMetadata: Metadata about the metric, used for visualization and organization. - `otherMetadata` object: Optional. Flexible metadata for user-defined attributes. - `scoreRange` GoogleCloudAiplatformV1MetricMetadataScoreRange: The range of possible scores for this metric, used for plotting. - `description` string: Optional. The description of the score explaining the directionality etc. - `max` number, double: Required. The maximum value of the score range (inclusive). - `min` number, double: Required. The minimum value of the score range (inclusive). - `step` number, double: Optional. The distance between discrete steps in the range. If unset, the range is assumed to be continuous. - `title` string: Optional. The user-friendly name for the metric. If not set for a registered metric, it will default to the metric's display name. - `pairwiseMetricSpec` GoogleCloudAiplatformV1PairwiseMetricSpec: Spec for pairwise metric. - `baselineResponseFieldName` string: Optional. The field name of the baseline response. - `candidateResponseFieldName` string: Optional. The field name of the candidate response. - `customOutputFormatConfig` GoogleCloudAiplatformV1CustomOutputFormatConfig: Spec for custom output format configuration. - `returnRawOutput` boolean: Optional. Whether to return raw output. - `metricPromptTemplate` string: Required. Metric prompt template for pairwise metric. - `systemInstruction` string: Optional. System instructions for pairwise metric. - `pointwiseMetricSpec` GoogleCloudAiplatformV1PointwiseMetricSpec: Spec for pointwise metric. - `customOutputFormatConfig` GoogleCloudAiplatformV1CustomOutputFormatConfig: Spec for custom output format configuration. - `returnRawOutput` boolean: Optional. Whether to return raw output. - `metricPromptTemplate` string: Required. Metric prompt template for pointwise metric. - `systemInstruction` string: Optional. System instructions for pointwise metric. - `predefinedMetricSpec` GoogleCloudAiplatformV1PredefinedMetricSpec: The spec for a pre-defined metric. - `metricSpecName` string: Required. The name of a pre-defined metric, such as "instruction_following_v1" or "text_quality_v1". - `metricSpecParameters` object: Optional. The parameters needed to run the pre-defined metric. - `rougeSpec` GoogleCloudAiplatformV1RougeSpec: Spec for rouge score metric - calculates the recall of n-grams in prediction as compared to reference - returns a score ranging between 0 and 1. - `rougeType` string: Optional. Supported rouge types are rougen[1-9], rougeL, and rougeLsum. - `splitSummaries` boolean: Optional. Whether to split summaries while using rougeLsum. - `useStemmer` boolean: Optional. Whether to use stemmer to compute rouge score. - `metricResourceName` string: Optional. Resource name for registered metric. - `name` string: Identifier. The resource name of the OnlineEvaluator. Format: projects/{project}/locations/{location}/onlineEvaluators/{id}. - `state` 'STATE_UNSPECIFIED' | 'ACTIVE' | 'SUSPENDED' | 'FAILED' | 'WARNING': Output only. The state of the OnlineEvaluator. - `stateDetails` GoogleCloudAiplatformV1OnlineEvaluatorStateDetails[]: Output only. Contains additional information about the state of the OnlineEvaluator. This is used to provide more details in the event of a failure. - `message` string: Output only. Human-readable message describing the state of the OnlineEvaluator. - `updateTime` string, google-datetime: Output only. Timestamp when the OnlineEvaluator was last updated. --- [API](https://skmtc.dev/google/apis/aiplatform.md) - [All operations](https://skmtc.dev/google/apis/aiplatform/llms.txt) - [OpenAPI document](https://skmtc.dev/google/apis/aiplatform/revisions/3aca3b348f0c?raw)