Documentation
¶
Index ¶
- Constants
- Variables
- type AndExpression
- type Comparison
- type EntityMappingFunctions
- type EntityPropertyMap
- type EntityType
- type EqualityExpander
- type Expression
- type FilterExpression
- type OrExpression
- type PropertyDefinition
- type PropertyLocation
- type PropertyRef
- type PropertyReference
- type QueryBuilder
- type RelatedEntityType
- type RestEntityType
- type SingleValue
- type Term
- type Value
- type ValueList
- type WhereClause
Constants ¶
const ( StringValueType = platformfilter.StringValueType DoubleValueType = platformfilter.DoubleValueType IntValueType = platformfilter.IntValueType BoolValueType = platformfilter.BoolValueType ArrayValueType = platformfilter.ArrayValueType )
Value type constants
const ( EntityTable = platformfilter.EntityTable PropertyTable = platformfilter.PropertyTable Custom = platformfilter.Custom RelatedEntity = platformfilter.RelatedEntity )
const ( RelatedEntityArtifact = platformfilter.RelatedEntityArtifact RelatedEntityContext = platformfilter.RelatedEntityContext RelatedEntityExecution = platformfilter.RelatedEntityExecution )
const ( EntityTypeContext = platformfilter.EntityTypeContext EntityTypeArtifact = platformfilter.EntityTypeArtifact EntityTypeExecution = platformfilter.EntityTypeExecution )
Variables ¶
var GetPropertyDefinition = platformfilter.GetPropertyDefinition
GetPropertyDefinition returns the property definition for a given entity type and property name
var Parse = platformfilter.Parse
Parse parses a filter query string and returns the root expression
var RestEntityPropertyMap = map[RestEntityType]map[string]bool{ RestEntityRegisteredModel: { "id": true, "name": true, "externalId": true, "createTimeSinceEpoch": true, "lastUpdateTimeSinceEpoch": true, "state": true, "owner": true, }, RestEntityModelVersion: { "id": true, "name": true, "externalId": true, "createTimeSinceEpoch": true, "lastUpdateTimeSinceEpoch": true, "registeredModelId": true, "state": true, "author": true, }, RestEntityInferenceService: { "id": true, "name": true, "externalId": true, "createTimeSinceEpoch": true, "lastUpdateTimeSinceEpoch": true, "registeredModelId": true, "modelVersionId": true, "servingEnvironmentId": true, "runtime": true, "desiredState": true, }, RestEntityServingEnvironment: { "id": true, "name": true, "externalId": true, "createTimeSinceEpoch": true, "lastUpdateTimeSinceEpoch": true, }, RestEntityExperiment: { "id": true, "name": true, "externalId": true, "createTimeSinceEpoch": true, "lastUpdateTimeSinceEpoch": true, "state": true, "owner": true, }, RestEntityExperimentRun: { "id": true, "name": true, "externalId": true, "createTimeSinceEpoch": true, "lastUpdateTimeSinceEpoch": true, "experimentId": true, "startTimeSinceEpoch": true, "endTimeSinceEpoch": true, "status": true, "state": true, "owner": true, }, RestEntityModelArtifact: { "id": true, "name": true, "externalId": true, "createTimeSinceEpoch": true, "lastUpdateTimeSinceEpoch": true, "uri": true, "state": true, "modelFormatName": true, "modelFormatVersion": true, "storageKey": true, "storagePath": true, "serviceAccountName": true, "modelSourceKind": true, "modelSourceClass": true, "modelSourceGroup": true, "modelSourceId": true, "modelSourceName": true, "experimentId": true, "experimentRunId": true, }, RestEntityDocArtifact: { "id": true, "name": true, "externalId": true, "createTimeSinceEpoch": true, "lastUpdateTimeSinceEpoch": true, "uri": true, "state": true, "experimentId": true, "experimentRunId": true, }, RestEntityDataSet: { "id": true, "name": true, "externalId": true, "createTimeSinceEpoch": true, "lastUpdateTimeSinceEpoch": true, "uri": true, "state": true, "digest": true, "sourceType": true, "source": true, "schema": true, "profile": true, "experimentId": true, "experimentRunId": true, }, RestEntityMetric: { "id": true, "name": true, "externalId": true, "createTimeSinceEpoch": true, "lastUpdateTimeSinceEpoch": true, "uri": true, "state": true, "value": true, "timestamp": true, "step": true, "experimentId": true, "experimentRunId": true, }, RestEntityParameter: { "id": true, "name": true, "externalId": true, "createTimeSinceEpoch": true, "lastUpdateTimeSinceEpoch": true, "uri": true, "state": true, "value": true, "parameterType": true, "experimentId": true, "experimentRunId": true, }, RestEntityServeModel: { "id": true, "name": true, "externalId": true, "createTimeSinceEpoch": true, "lastUpdateTimeSinceEpoch": true, "lastKnownState": true, "modelVersionId": true, "inferenceServiceId": true, "registeredModelId": true, "servingEnvironmentId": true, }, }
RestEntityPropertyMap maps REST entity types to their allowed properties
Functions ¶
This section is empty.
Types ¶
type AndExpression ¶
type AndExpression = platformfilter.AndExpression
type Comparison ¶
type Comparison = platformfilter.Comparison
type EntityMappingFunctions ¶
type EntityMappingFunctions = platformfilter.EntityMappingFunctions
Interfaces
func DefaultEntityMappingFuncs ¶
func DefaultEntityMappingFuncs() EntityMappingFunctions
DefaultEntityMappingFuncs returns the default MR entity mapping functions.
type EntityPropertyMap ¶
type EntityPropertyMap = platformfilter.EntityPropertyMap
type EntityType ¶
type EntityType = platformfilter.EntityType
Entity type constants and types
func GetMLMDEntityType ¶
func GetMLMDEntityType(restEntityType RestEntityType) EntityType
GetMLMDEntityType maps REST entity types to their underlying MLMD entity type
type EqualityExpander ¶
type EqualityExpander = platformfilter.EqualityExpander
type Expression ¶
type Expression = platformfilter.Expression
type OrExpression ¶
type OrExpression = platformfilter.OrExpression
type PropertyDefinition ¶
type PropertyDefinition = platformfilter.PropertyDefinition
Property definition types
func GetPropertyDefinitionForRestEntity ¶
func GetPropertyDefinitionForRestEntity(restEntityType RestEntityType, propertyName string) PropertyDefinition
GetPropertyDefinitionForRestEntity returns property definition for a REST entity type This function determines the correct data type and storage location for properties
type PropertyLocation ¶
type PropertyLocation = platformfilter.PropertyLocation
Property location types
type PropertyRef ¶
type PropertyRef = platformfilter.PropertyRef
type PropertyReference ¶
type PropertyReference = platformfilter.PropertyReference
type QueryBuilder ¶
type QueryBuilder = platformfilter.QueryBuilder
QueryBuilder type
func NewQueryBuilderForRestEntity ¶
func NewQueryBuilderForRestEntity(restEntityType RestEntityType, mappingFuncs EntityMappingFunctions) *QueryBuilder
NewQueryBuilderForRestEntity creates a new query builder for the specified REST entity type. If mappingFuncs is nil, it falls back to the model-registry default entity mappings.
type RelatedEntityType ¶
type RelatedEntityType = platformfilter.RelatedEntityType
Related entity types
type RestEntityType ¶
type RestEntityType = platformfilter.RestEntityType
RestEntityType is an alias for the platform type
const ( // Context-based REST entities RestEntityRegisteredModel RestEntityType = "RegisteredModel" RestEntityModelVersion RestEntityType = "ModelVersion" RestEntityInferenceService RestEntityType = "InferenceService" RestEntityServingEnvironment RestEntityType = "ServingEnvironment" RestEntityExperiment RestEntityType = "Experiment" RestEntityExperimentRun RestEntityType = "ExperimentRun" // Artifact-based REST entities RestEntityModelArtifact RestEntityType = "ModelArtifact" RestEntityDocArtifact RestEntityType = "DocArtifact" RestEntityDataSet RestEntityType = "DataSet" RestEntityMetric RestEntityType = "Metric" RestEntityParameter RestEntityType = "Parameter" // Execution-based REST entities RestEntityServeModel RestEntityType = "ServeModel" )
type SingleValue ¶
type SingleValue = platformfilter.SingleValue
type Term ¶
type Term = platformfilter.Term
type Value ¶
type Value = platformfilter.Value
type ValueList ¶
type ValueList = platformfilter.ValueList