evaluation_sets

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

Overview

Name	evaluation_sets
Type	Resource
Id	google.aiplatform.evaluation_sets

Fields

The following fields are returned by SELECT queries:

get

Name	Datatype	Description
name	string	Identifier. The resource name of the EvaluationSet. Format: projects/{project}/locations/{location}/evaluationSets/{evaluation_set}
createTime	string (google-datetime)	Output only. Timestamp when this item was created.
displayName	string	Required. The display name of the EvaluationSet.
evaluationItems	array	Required. The EvaluationItems that are part of this dataset.
metadata	any	Optional. Metadata for the EvaluationSet.
updateTime	string (google-datetime)	Output only. Timestamp when this item was last updated.

list

Name	Datatype	Description
name	string	Identifier. The resource name of the EvaluationSet. Format: projects/{project}/locations/{location}/evaluationSets/{evaluation_set}
createTime	string (google-datetime)	Output only. Timestamp when this item was created.
displayName	string	Required. The display name of the EvaluationSet.
evaluationItems	array	Required. The EvaluationItems that are part of this dataset.
metadata	any	Optional. Metadata for the EvaluationSet.
updateTime	string (google-datetime)	Output only. Timestamp when this item was last updated.

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
get	select	projectsId, locationsId, evaluationSetsId		Gets an Evaluation Set.
list	select	projectsId, locationsId	pageToken, pageSize, filter, orderBy	Lists Evaluation Sets.
create	insert	projectsId, locationsId		Creates an Evaluation Set.
patch	update	projectsId, locationsId, evaluationSetsId	updateMask	Updates an Evaluation Set.
delete	delete	projectsId, locationsId, evaluationSetsId		Deletes an Evaluation Set.

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
evaluationSetsId	string
locationsId	string
projectsId	string
filter	string
orderBy	string
pageSize	integer (int32)
pageToken	string
updateMask	string (google-fieldmask)

SELECT examples

get

Gets an Evaluation Set.

SELECT
name,
createTime,
displayName,
evaluationItems,
metadata,
updateTime
FROM google.aiplatform.evaluation_sets
WHERE projectsId = '{{ projectsId }}' -- required
AND locationsId = '{{ locationsId }}' -- required
AND evaluationSetsId = '{{ evaluationSetsId }}' -- required
;

list

Lists Evaluation Sets.

SELECT
name,
createTime,
displayName,
evaluationItems,
metadata,
updateTime
FROM google.aiplatform.evaluation_sets
WHERE projectsId = '{{ projectsId }}' -- required
AND locationsId = '{{ locationsId }}' -- required
AND pageToken = '{{ pageToken }}'
AND pageSize = '{{ pageSize }}'
AND filter = '{{ filter }}'
AND orderBy = '{{ orderBy }}'
;

INSERT examples

create

Creates an Evaluation Set.

INSERT INTO google.aiplatform.evaluation_sets (
data__evaluationItems,
data__name,
data__metadata,
data__displayName,
projectsId,
locationsId
)
SELECT 
'{{ evaluationItems }}',
'{{ name }}',
'{{ metadata }}',
'{{ displayName }}',
'{{ projectsId }}',
'{{ locationsId }}'
RETURNING
name,
createTime,
displayName,
evaluationItems,
metadata,
updateTime
;

Manifest

# Description fields are for documentation purposes
- name: evaluation_sets
  props:
    - name: projectsId
      value: string
      description: Required parameter for the evaluation_sets resource.
    - name: locationsId
      value: string
      description: Required parameter for the evaluation_sets resource.
    - name: evaluationItems
      value: array
      description: >
        Required. The EvaluationItems that are part of this dataset.
        
    - name: name
      value: string
      description: >
        Identifier. The resource name of the EvaluationSet. Format: `projects/{project}/locations/{location}/evaluationSets/{evaluation_set}`
        
    - name: metadata
      value: any
      description: >
        Optional. Metadata for the EvaluationSet.
        
    - name: displayName
      value: string
      description: >
        Required. The display name of the EvaluationSet.
        

UPDATE examples

patch

Updates an Evaluation Set.

UPDATE google.aiplatform.evaluation_sets
SET 
data__evaluationItems = '{{ evaluationItems }}',
data__name = '{{ name }}',
data__metadata = '{{ metadata }}',
data__displayName = '{{ displayName }}'
WHERE 
projectsId = '{{ projectsId }}' --required
AND locationsId = '{{ locationsId }}' --required
AND evaluationSetsId = '{{ evaluationSetsId }}' --required
AND updateMask = '{{ updateMask}}'
RETURNING
name,
createTime,
displayName,
evaluationItems,
metadata,
updateTime;

DELETE examples

delete

Deletes an Evaluation Set.

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