- 1.73.0 (latest)
- 1.72.0
- 1.71.1
- 1.70.0
- 1.69.0
- 1.68.0
- 1.67.1
- 1.66.0
- 1.65.0
- 1.63.0
- 1.62.0
- 1.60.0
- 1.59.0
- 1.58.0
- 1.57.0
- 1.56.0
- 1.55.0
- 1.54.1
- 1.53.0
- 1.52.0
- 1.51.0
- 1.50.0
- 1.49.0
- 1.48.0
- 1.47.0
- 1.46.0
- 1.45.0
- 1.44.0
- 1.43.0
- 1.39.0
- 1.38.1
- 1.37.0
- 1.36.4
- 1.35.0
- 1.34.0
- 1.33.1
- 1.32.0
- 1.31.1
- 1.30.1
- 1.29.0
- 1.28.1
- 1.27.1
- 1.26.1
- 1.25.0
- 1.24.1
- 1.23.0
- 1.22.1
- 1.21.0
- 1.20.0
- 1.19.1
- 1.18.3
- 1.17.1
- 1.16.1
- 1.15.1
- 1.14.0
- 1.13.1
- 1.12.1
- 1.11.0
- 1.10.0
- 1.9.0
- 1.8.1
- 1.7.1
- 1.6.2
- 1.5.0
- 1.4.3
- 1.3.0
- 1.2.0
- 1.1.1
- 1.0.1
- 0.9.0
- 0.8.0
- 0.7.1
- 0.6.0
- 0.5.1
- 0.4.0
- 0.3.1
EntityType(
entity_type_name: str,
featurestore_id: Optional[str] = None,
project: Optional[str] = None,
location: Optional[str] = None,
credentials: Optional[google.auth.credentials.Credentials] = None,
)
Managed entityType resource for Vertex AI.
Inheritance
builtins.object > google.cloud.aiplatform.base.VertexAiResourceNoun > builtins.object > google.cloud.aiplatform.base.FutureManager > google.cloud.aiplatform.base.VertexAiResourceNounWithFutureManager > EntityTypeProperties
featurestore_name
Full qualified resource name of the managed featurestore in which this EntityType is.
Methods
EntityType
EntityType(
entity_type_name: str,
featurestore_id: Optional[str] = None,
project: Optional[str] = None,
location: Optional[str] = None,
credentials: Optional[google.auth.credentials.Credentials] = None,
)
Retrieves an existing managed entityType given an entityType resource name or an entity_type ID.
Example Usage:
my_entity_type = aiplatform.EntityType(
entity_type_name='projects/123/locations/us-central1/featurestores/my_featurestore_id/ entityTypes/my_entity_type_id'
)
or
my_entity_type = aiplatform.EntityType(
entity_type_name='my_entity_type_id',
featurestore_id='my_featurestore_id',
)
Name | Description |
entity_type_name |
str
Required. A fully-qualified entityType resource name or an entity_type ID. Example: "projects/123/locations/us-central1/featurestores/my_featurestore_id/entityTypes/my_entity_type_id" or "my_entity_type_id" when project and location are initialized or passed, with featurestore_id passed. |
featurestore_id |
str
Optional. Featurestore ID to retrieve entityType from, when entity_type_name is passed as entity_type ID. |
project |
str
Optional. Project to retrieve entityType from. If not set, project set in aiplatform.init will be used. |
location |
str
Optional. Location to retrieve entityType from. If not set, location set in aiplatform.init will be used. |
credentials |
auth_credentials.Credentials
Optional. Custom credentials to use to retrieve this EntityType. Overrides credentials set in aiplatform.init. |
delete_features
delete_features(feature_ids: List[str], sync: bool = True)
Deletes feature resources in this EntityType given their feature IDs. WARNING: This deletion is permanent.
Name | Description |
feature_ids |
List[str]
Required. The list of feature IDs to be deleted. |
sync |
bool
Optional. Whether to execute this deletion synchronously. If False, this method will be executed in concurrent Future and any downstream object will be immediately returned and synced when the Future has completed. |
get_feature
get_feature(feature_id: str)
Retrieves an existing managed feature in this EntityType.
Name | Description |
feature_id |
str
Required. The managed feature resource ID in this EntityType. |
get_featurestore
get_featurestore()
Retrieves the managed featurestore in which this EntityType is.
list
list(
featurestore_name: str,
filter: Optional[str] = None,
order_by: Optional[str] = None,
project: Optional[str] = None,
location: Optional[str] = None,
credentials: Optional[google.auth.credentials.Credentials] = None,
)
Lists existing managed entityType resources in a featurestore, given a featurestore resource name or a featurestore ID.
Example Usage:
my_entityTypes = aiplatform.EntityType.list(
featurestore_name='projects/123/locations/us-central1/featurestores/my_featurestore_id'
)
or
my_entityTypes = aiplatform.EntityType.list(
featurestore_name='my_featurestore_id'
)
Name | Description |
featurestore_name |
str
Required. A fully-qualified featurestore resource name or a featurestore ID to list entityTypes in Example: "projects/123/locations/us-central1/featurestores/my_featurestore_id" or "my_featurestore_id" when project and location are initialized or passed. |
filter |
str
Optional. Lists the EntityTypes that match the filter expression. The following filters are supported: - |
order_by |
str
Optional. A comma-separated list of fields to order by, sorted in ascending order. Use "desc" after a field name for descending. Supported fields: - |
project |
str
Optional. Project to list entityTypes in. If not set, project set in aiplatform.init will be used. |
location |
str
Optional. Location to list entityTypes in. If not set, location set in aiplatform.init will be used. |
credentials |
auth_credentials.Credentials
Optional. Custom credentials to use to list entityTypes. Overrides credentials set in aiplatform.init. |
list_features
list_features(filter: Optional[str] = None, order_by: Optional[str] = None)
Lists existing managed feature resources in this EntityType.
Example Usage:
my_entity_type = aiplatform.EntityType(
entity_type_name='my_entity_type_id',
featurestore_id='my_featurestore_id',
)
my_entityType.list_features()
Name | Description |
filter |
str
Optional. Lists the Features that match the filter expression. The following filters are supported: - |
order_by |
str
Optional. A comma-separated list of fields to order by, sorted in ascending order. Use "desc" after a field name for descending. Supported fields: - |
update
update(
description: Optional[str] = None,
labels: Optional[Dict[str, str]] = None,
request_metadata: Optional[Sequence[Tuple[str, str]]] = (),
)
Updates an existing managed entityType resource.
Example Usage:
my_entity_type = aiplatform.EntityType(
entity_type_name='my_entity_type_id',
featurestore_id='my_featurestore_id',
)
my_entity_type.update(
description='update my description',
)
Name | Description |
description |
str
Optional. Description of the EntityType. |
labels |
Dict[str, str]
Optional. The labels with user-defined metadata to organize your EntityTypes. Label keys and values can be no longer than 64 characters (Unicode codepoints), can only contain lowercase letters, numeric characters, underscores and dashes. International characters are allowed. See https://goo.gl/xmQnxf for more information on and examples of labels. No more than 64 user labels can be associated with one Feature (System labels are excluded)." System reserved label keys are prefixed with "aiplatform.googleapis.com/" and are immutable. |
request_metadata |
Sequence[Tuple[str, str]]
Optional. Strings which should be sent along with the request as metadata. |