Vertex AI V1 API - Class Google::Cloud::AIPlatform::V1::Dataset (v0.58.0)

Reference documentation and code samples for the Vertex AI V1 API class Google::Cloud::AIPlatform::V1::Dataset.

A collection of DataItems and Annotations on them.

Inherits

  • Object

Extended By

  • Google::Protobuf::MessageExts::ClassMethods

Includes

  • Google::Protobuf::MessageExts

Methods

#create_time

def create_time() -> ::Google::Protobuf::Timestamp
Returns

#data_item_count

def data_item_count() -> ::Integer
Returns
  • (::Integer) — Output only. The number of DataItems in this Dataset. Only apply for non-structured Dataset.

#description

def description() -> ::String
Returns
  • (::String) — The description of the Dataset.

#description=

def description=(value) -> ::String
Parameter
  • value (::String) — The description of the Dataset.
Returns
  • (::String) — The description of the Dataset.

#display_name

def display_name() -> ::String
Returns
  • (::String) — Required. The user-defined name of the Dataset. The name can be up to 128 characters long and can consist of any UTF-8 characters.

#display_name=

def display_name=(value) -> ::String
Parameter
  • value (::String) — Required. The user-defined name of the Dataset. The name can be up to 128 characters long and can consist of any UTF-8 characters.
Returns
  • (::String) — Required. The user-defined name of the Dataset. The name can be up to 128 characters long and can consist of any UTF-8 characters.

#encryption_spec

def encryption_spec() -> ::Google::Cloud::AIPlatform::V1::EncryptionSpec
Returns

#encryption_spec=

def encryption_spec=(value) -> ::Google::Cloud::AIPlatform::V1::EncryptionSpec
Parameter
Returns

#etag

def etag() -> ::String
Returns
  • (::String) — Used to perform consistent read-modify-write updates. If not set, a blind "overwrite" update happens.

#etag=

def etag=(value) -> ::String
Parameter
  • value (::String) — Used to perform consistent read-modify-write updates. If not set, a blind "overwrite" update happens.
Returns
  • (::String) — Used to perform consistent read-modify-write updates. If not set, a blind "overwrite" update happens.

#labels

def labels() -> ::Google::Protobuf::Map{::String => ::String}
Returns
  • (::Google::Protobuf::Map{::String => ::String}) —

    The labels with user-defined metadata to organize your Datasets.

    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. No more than 64 user labels can be associated with one Dataset (System labels are excluded).

    See https://goo.gl/xmQnxf for more information and examples of labels. System reserved label keys are prefixed with "aiplatform.googleapis.com/" and are immutable. Following system labels exist for each Dataset:

    • "aiplatform.googleapis.com/dataset_metadata_schema": output only, its value is the [metadata_schema's][google.cloud.aiplatform.v1.Dataset.metadata_schema_uri] title.

#labels=

def labels=(value) -> ::Google::Protobuf::Map{::String => ::String}
Parameter
  • value (::Google::Protobuf::Map{::String => ::String}) —

    The labels with user-defined metadata to organize your Datasets.

    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. No more than 64 user labels can be associated with one Dataset (System labels are excluded).

    See https://goo.gl/xmQnxf for more information and examples of labels. System reserved label keys are prefixed with "aiplatform.googleapis.com/" and are immutable. Following system labels exist for each Dataset:

    • "aiplatform.googleapis.com/dataset_metadata_schema": output only, its value is the [metadata_schema's][google.cloud.aiplatform.v1.Dataset.metadata_schema_uri] title.
Returns
  • (::Google::Protobuf::Map{::String => ::String}) —

    The labels with user-defined metadata to organize your Datasets.

    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. No more than 64 user labels can be associated with one Dataset (System labels are excluded).

    See https://goo.gl/xmQnxf for more information and examples of labels. System reserved label keys are prefixed with "aiplatform.googleapis.com/" and are immutable. Following system labels exist for each Dataset:

    • "aiplatform.googleapis.com/dataset_metadata_schema": output only, its value is the [metadata_schema's][google.cloud.aiplatform.v1.Dataset.metadata_schema_uri] title.

#metadata

def metadata() -> ::Google::Protobuf::Value
Returns

#metadata=

def metadata=(value) -> ::Google::Protobuf::Value
Parameter
Returns

#metadata_artifact

def metadata_artifact() -> ::String
Returns
  • (::String) — Output only. The resource name of the Artifact that was created in MetadataStore when creating the Dataset. The Artifact resource name pattern is projects/{project}/locations/{location}/metadataStores/{metadata_store}/artifacts/{artifact}.

#metadata_schema_uri

def metadata_schema_uri() -> ::String
Returns
  • (::String) — Required. Points to a YAML file stored on Google Cloud Storage describing additional information about the Dataset. The schema is defined as an OpenAPI 3.0.2 Schema Object. The schema files that can be used here are found in gs://google-cloud-aiplatform/schema/dataset/metadata/.

#metadata_schema_uri=

def metadata_schema_uri=(value) -> ::String
Parameter
  • value (::String) — Required. Points to a YAML file stored on Google Cloud Storage describing additional information about the Dataset. The schema is defined as an OpenAPI 3.0.2 Schema Object. The schema files that can be used here are found in gs://google-cloud-aiplatform/schema/dataset/metadata/.
Returns
  • (::String) — Required. Points to a YAML file stored on Google Cloud Storage describing additional information about the Dataset. The schema is defined as an OpenAPI 3.0.2 Schema Object. The schema files that can be used here are found in gs://google-cloud-aiplatform/schema/dataset/metadata/.

#model_reference

def model_reference() -> ::String
Returns
  • (::String) — Optional. Reference to the public base model last used by the dataset. Only set for prompt datasets.

#model_reference=

def model_reference=(value) -> ::String
Parameter
  • value (::String) — Optional. Reference to the public base model last used by the dataset. Only set for prompt datasets.
Returns
  • (::String) — Optional. Reference to the public base model last used by the dataset. Only set for prompt datasets.

#name

def name() -> ::String
Returns
  • (::String) — Output only. Identifier. The resource name of the Dataset.

#satisfies_pzi

def satisfies_pzi() -> ::Boolean
Returns
  • (::Boolean) — Output only. Reserved for future use.

#satisfies_pzs

def satisfies_pzs() -> ::Boolean
Returns
  • (::Boolean) — Output only. Reserved for future use.

#saved_queries

def saved_queries() -> ::Array<::Google::Cloud::AIPlatform::V1::SavedQuery>
Returns
  • (::Array<::Google::Cloud::AIPlatform::V1::SavedQuery>) — All SavedQueries belong to the Dataset will be returned in List/Get Dataset response. The annotation_specs field will not be populated except for UI cases which will only use annotation_spec_count. In CreateDataset request, a SavedQuery is created together if this field is set, up to one SavedQuery can be set in CreateDatasetRequest. The SavedQuery should not contain any AnnotationSpec.

#saved_queries=

def saved_queries=(value) -> ::Array<::Google::Cloud::AIPlatform::V1::SavedQuery>
Parameter
  • value (::Array<::Google::Cloud::AIPlatform::V1::SavedQuery>) — All SavedQueries belong to the Dataset will be returned in List/Get Dataset response. The annotation_specs field will not be populated except for UI cases which will only use annotation_spec_count. In CreateDataset request, a SavedQuery is created together if this field is set, up to one SavedQuery can be set in CreateDatasetRequest. The SavedQuery should not contain any AnnotationSpec.
Returns
  • (::Array<::Google::Cloud::AIPlatform::V1::SavedQuery>) — All SavedQueries belong to the Dataset will be returned in List/Get Dataset response. The annotation_specs field will not be populated except for UI cases which will only use annotation_spec_count. In CreateDataset request, a SavedQuery is created together if this field is set, up to one SavedQuery can be set in CreateDatasetRequest. The SavedQuery should not contain any AnnotationSpec.

#update_time

def update_time() -> ::Google::Protobuf::Timestamp
Returns