Class Artifact (1.15.1)

Artifact(
    artifact_name: str,
    *,
    metadata_store_id: str = "default",
    project: Optional[str] = None,
    location: Optional[str] = None,
    credentials: Optional[google.auth.credentials.Credentials] = None
)

Metadata Artifact resource for Vertex AI

Inheritance

builtins.object > google.cloud.aiplatform.base.VertexAiResourceNoun > builtins.object > google.cloud.aiplatform.base.FutureManager > google.cloud.aiplatform.base.VertexAiResourceNounWithFutureManager > builtins.object > abc.ABC > google.cloud.aiplatform.metadata.resource._Resource > Artifact

Properties

lineage_console_uri

Cloud console uri to view this Artifact Lineage.

uri

Uri for this Artifact.

Methods

Artifact

Artifact(
    artifact_name: str,
    *,
    metadata_store_id: str = "default",
    project: Optional[str] = None,
    location: Optional[str] = None,
    credentials: Optional[google.auth.credentials.Credentials] = None
)

Retrieves an existing Metadata Artifact given a resource name or ID.

Parameters

Name	Description
artifact_name	`str` Required. A fully-qualified resource name or resource ID of the Artifact. Example: "projects/123/locations/us-central1/metadataStores/default/artifacts/my-resource". or "my-resource" when project and location are initialized or passed.
metadata_store_id	`str` Optional. MetadataStore to retrieve Artifact from. If not set, metadata_store_id is set to "default". If artifact_name is a fully-qualified resource, its metadata_store_id overrides this one.
project	`str` Optional. Project to retrieve the artifact from. If not set, project set in aiplatform.init will be used.
location	`str` Optional. Location to retrieve the Artifact from. If not set, location set in aiplatform.init will be used.
credentials	`auth_credentials.Credentials` Optional. Custom credentials to use to retrieve this Artifact. Overrides credentials set in aiplatform.init.

create

create(schema_title: str, *, resource_id: Optional[str] = None, uri: Optional[str] = None, display_name: Optional[str] = None, schema_version: Optional[str] = None, description: Optional[str] = None, metadata: Optional[Dict] = None, state: google.cloud.aiplatform_v1.types.artifact.Artifact.State = <State.LIVE: 2>, metadata_store_id: Optional[str] = 'default', project: Optional[str] = None, location: Optional[str] = None, credentials: Optional[google.auth.credentials.Credentials] = None)

Creates a new Metadata Artifact.

Parameters

Name	Description
schema_title	`str` Required. schema_title identifies the schema title used by the Artifact. Please reference https://cloud.google.com/vertex-ai/docs/ml-metadata/system-schemas.
resource_id	`str` Optional. The <resource_id> portion of the Artifact name with the format. This is globally unique in a metadataStore: projects/123/locations/us-central1/metadataStores/<metadata_store_id>/artifacts/<resource_id>.
uri	`str` Optional. The uniform resource identifier of the artifact file. May be empty if there is no actual artifact file.
display_name	`str` Optional. The user-defined name of the Artifact.
schema_version	`str` Optional. schema_version specifies the version used by the Artifact. If not set, defaults to use the latest version.
description	`str` Optional. Describes the purpose of the Artifact to be created.
metadata	`Dict` Optional. Contains the metadata information that will be stored in the Artifact.
state	`google.cloud.gapic.types.Artifact.State` Optional. The state of this Artifact. This is a property of the Artifact, and does not imply or capture any ongoing process. This property is managed by clients (such as Vertex AI Pipelines), and the system does not prescribe or check the validity of state transitions.
metadata_store_id	`str` Optional. The <metadata_store_id> portion of the resource name with the format: projects/123/locations/us-central1/metadataStores/<metadata_store_id>/artifacts/<resource_id> If not provided, the MetadataStore's ID will be set to "default".
project	`str` Optional. Project used to create this Artifact. Overrides project set in aiplatform.init.
location	`str` Optional. Location used to create this Artifact. Overrides location set in aiplatform.init.
credentials	`auth_credentials.Credentials` Optional. Custom credentials used to create this Artifact. Overrides credentials set in aiplatform.init.

Returns

Type	Description
Artifact	Instantiated representation of the managed Metadata Artifact.

create_from_base_artifact_schema

create_from_base_artifact_schema(
    *,
    base_artifact_schema: google.cloud.aiplatform.metadata.schema.base_artifact.BaseArtifactSchema,
    metadata_store_id: Optional[str] = "default",
    project: Optional[str] = None,
    location: Optional[str] = None,
    credentials: Optional[google.auth.credentials.Credentials] = None
)

Creates a new Metadata Artifact from a BaseArtifactSchema class instance.

Parameters

Name	Description
base_artifact_schema	`BaseArtifactSchema` Required. An instance of the BaseArtifactType class that can be provided instead of providing artifact specific parameters.
metadata_store_id	`str` Optional. The <metadata_store_id> portion of the resource name with the format: projects/123/locations/us-central1/metadataStores/<metadata_store_id>/artifacts/<resource_id> If not provided, the MetadataStore's ID will be set to "default".
project	`str` Optional. Project used to create this Artifact. Overrides project set in aiplatform.init.
location	`str` Optional. Location used to create this Artifact. Overrides location set in aiplatform.init.
credentials	`auth_credentials.Credentials` Optional. Custom credentials used to create this Artifact. Overrides credentials set in aiplatform.init.

Returns

Type	Description
Artifact	Instantiated representation of the managed Metadata Artifact.

get_with_uri

get_with_uri(
    uri: str,
    *,
    metadata_store_id: Optional[str] = "default",
    project: Optional[str] = None,
    location: Optional[str] = None,
    credentials: Optional[google.auth.credentials.Credentials] = None
)

Get an Artifact by it's uri.

If more than one Artifact with this uri is in the metadata store then the Artifact with the latest create_time is returned.

Parameters

Name	Description
uri	`str` Required. Uri of the Artifact to retrieve.
metadata_store_id	`str` Optional. MetadataStore to retrieve Artifact from. If not set, metadata_store_id is set to "default". If artifact_name is a fully-qualified resource, its metadata_store_id overrides this one.
project	`str` Optional. Project to retrieve the artifact from. If not set, project set in aiplatform.init will be used.
location	`str` Optional. Location to retrieve the Artifact from. If not set, location set in aiplatform.init will be used.
credentials	`auth_credentials.Credentials` Optional. Custom credentials to use to retrieve this Artifact. Overrides credentials set in aiplatform.init.

Exceptions

Type	Description
ValueError	If no Artifact exists with the provided uri.

Returns

Type	Description
Artifact	Artifact with given uri.