evaluation_items

Creates, updates, deletes, gets or lists an evaluation_items resource.

Overview

Name	evaluation_items
Type	Resource
Id	google.aiplatform.evaluation_items

Fields

The following fields are returned by SELECT queries:

get

Name	Datatype	Description
name	string	Identifier. The resource name of the EvaluationItem. Format: projects/{project}/locations/{location}/evaluationItems/{evaluation_item}
createTime	string (google-datetime)	Output only. Timestamp when this item was created.
displayName	string	Required. The display name of the EvaluationItem.
error	object	The Status type defines a logical error model that is suitable for different programming environments, including REST APIs and RPC APIs. It is used by gRPC. Each Status message contains three pieces of data: error code, error message, and error details. You can find out more about this error model and how to work with it in the API Design Guide. (id: GoogleRpcStatus)
evaluationItemType	string	Required. The type of the EvaluationItem. (EVALUATION_ITEM_TYPE_UNSPECIFIED, REQUEST, RESULT)
evaluationRequest	object	The request to evaluate. (id: GoogleCloudAiplatformV1EvaluationRequest)
evaluationResponse	object	Output only. The response from evaluation. (id: GoogleCloudAiplatformV1EvaluationResult)
gcsUri	string	The Cloud Storage object where the request or response is stored.
labels	object	Optional. Labels for the EvaluationItem.
metadata	any	Optional. Metadata for the EvaluationItem.

list

Name	Datatype	Description
name	string	Identifier. The resource name of the EvaluationItem. Format: projects/{project}/locations/{location}/evaluationItems/{evaluation_item}
createTime	string (google-datetime)	Output only. Timestamp when this item was created.
displayName	string	Required. The display name of the EvaluationItem.
error	object	The Status type defines a logical error model that is suitable for different programming environments, including REST APIs and RPC APIs. It is used by gRPC. Each Status message contains three pieces of data: error code, error message, and error details. You can find out more about this error model and how to work with it in the API Design Guide. (id: GoogleRpcStatus)
evaluationItemType	string	Required. The type of the EvaluationItem. (EVALUATION_ITEM_TYPE_UNSPECIFIED, REQUEST, RESULT)
evaluationRequest	object	The request to evaluate. (id: GoogleCloudAiplatformV1EvaluationRequest)
evaluationResponse	object	Output only. The response from evaluation. (id: GoogleCloudAiplatformV1EvaluationResult)
gcsUri	string	The Cloud Storage object where the request or response is stored.
labels	object	Optional. Labels for the EvaluationItem.
metadata	any	Optional. Metadata for the EvaluationItem.

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
get	select	projectsId, locationsId, evaluationItemsId		Gets an Evaluation Item.
list	select	projectsId, locationsId	filter, orderBy, pageSize, pageToken	Lists Evaluation Items.
create	insert	projectsId, locationsId		Creates an Evaluation Item.
delete	delete	projectsId, locationsId, evaluationItemsId		Deletes an Evaluation Item.

Parameters

Parameters can be passed in the WHERE clause of a query. Check the Methods section to see which parameters are required or optional for each operation.

Name	Datatype	Description
evaluationItemsId	string
locationsId	string
projectsId	string
filter	string
orderBy	string
pageSize	integer (int32)
pageToken	string

SELECT examples

get

Gets an Evaluation Item.

SELECT
name,
createTime,
displayName,
error,
evaluationItemType,
evaluationRequest,
evaluationResponse,
gcsUri,
labels,
metadata
FROM google.aiplatform.evaluation_items
WHERE projectsId = '{{ projectsId }}' -- required
AND locationsId = '{{ locationsId }}' -- required
AND evaluationItemsId = '{{ evaluationItemsId }}' -- required
;

list

Lists Evaluation Items.

SELECT
name,
createTime,
displayName,
error,
evaluationItemType,
evaluationRequest,
evaluationResponse,
gcsUri,
labels,
metadata
FROM google.aiplatform.evaluation_items
WHERE projectsId = '{{ projectsId }}' -- required
AND locationsId = '{{ locationsId }}' -- required
AND filter = '{{ filter }}'
AND orderBy = '{{ orderBy }}'
AND pageSize = '{{ pageSize }}'
AND pageToken = '{{ pageToken }}'
;

INSERT examples

create

Creates an Evaluation Item.

INSERT INTO google.aiplatform.evaluation_items (
data__displayName,
data__evaluationItemType,
data__evaluationRequest,
data__gcsUri,
data__labels,
data__metadata,
data__name,
projectsId,
locationsId
)
SELECT 
'{{ displayName }}',
'{{ evaluationItemType }}',
'{{ evaluationRequest }}',
'{{ gcsUri }}',
'{{ labels }}',
'{{ metadata }}',
'{{ name }}',
'{{ projectsId }}',
'{{ locationsId }}'
RETURNING
name,
createTime,
displayName,
error,
evaluationItemType,
evaluationRequest,
evaluationResponse,
gcsUri,
labels,
metadata
;

Manifest

# Description fields are for documentation purposes
- name: evaluation_items
props:
  - name: projectsId
    value: "{{ projectsId }}"
    description: Required parameter for the evaluation_items resource.
  - name: locationsId
    value: "{{ locationsId }}"
    description: Required parameter for the evaluation_items resource.
  - name: displayName
    value: "{{ displayName }}"
    description: |
      Required. The display name of the EvaluationItem.
  - name: evaluationItemType
    value: "{{ evaluationItemType }}"
    description: |
      Required. The type of the EvaluationItem.
    valid_values: ['EVALUATION_ITEM_TYPE_UNSPECIFIED', 'REQUEST', 'RESULT']
  - name: evaluationRequest
    description: |
      The request to evaluate.
    value:
      candidateResponses:
        - agentData:
            agents: "{{ agents }}"
            turns:
              - events: "{{ events }}"
                turnId: "{{ turnId }}"
                turnIndex: {{ turnIndex }}
          candidate: "{{ candidate }}"
          error:
            code: {{ code }}
            details: "{{ details }}"
            message: "{{ message }}"
          text: "{{ text }}"
          value: "{{ value }}"
      goldenResponse:
        agentData:
          agents: "{{ agents }}"
          turns:
            - events: "{{ events }}"
              turnId: "{{ turnId }}"
              turnIndex: {{ turnIndex }}
        candidate: "{{ candidate }}"
        error:
          code: {{ code }}
          details: "{{ details }}"
          message: "{{ message }}"
        text: "{{ text }}"
        value: "{{ value }}"
      prompt:
        agentData:
          agents: "{{ agents }}"
          turns:
            - events: "{{ events }}"
              turnId: "{{ turnId }}"
              turnIndex: {{ turnIndex }}
        promptTemplateData:
          values: "{{ values }}"
        text: "{{ text }}"
        userScenario:
          conversationPlan: "{{ conversationPlan }}"
          startingPrompt: "{{ startingPrompt }}"
        value: "{{ value }}"
      rubrics: "{{ rubrics }}"
  - name: gcsUri
    value: "{{ gcsUri }}"
    description: |
      The Cloud Storage object where the request or response is stored.
  - name: labels
    value: "{{ labels }}"
    description: |
      Optional. Labels for the EvaluationItem.
  - name: metadata
    value: "{{ metadata }}"
    description: |
      Optional. Metadata for the EvaluationItem.
  - name: name
    value: "{{ name }}"
    description: |
      Identifier. The resource name of the EvaluationItem. Format: `projects/{project}/locations/{location}/evaluationItems/{evaluation_item}`

DELETE examples

delete

Deletes an Evaluation Item.

DELETE FROM google.aiplatform.evaluation_items
WHERE projectsId = '{{ projectsId }}' --required
AND locationsId = '{{ locationsId }}' --required
AND evaluationItemsId = '{{ evaluationItemsId }}' --required
;