Class: Google::Cloud::AIPlatform::V1::NearestNeighborSearchOperationMetadata

Inherits:

Object

Object
Google::Cloud::AIPlatform::V1::NearestNeighborSearchOperationMetadata

show all

Extended by:: Protobuf::MessageExts::ClassMethods

Includes:: Protobuf::MessageExts

Defined in:: proto_docs/google/cloud/aiplatform/v1/index_service.rb

Overview

Runtime operation metadata with regard to Matching Engine Index.

Defined Under Namespace

Classes: ContentValidationStats, RecordError

Instance Attribute Summary collapse

#content_validation_stats ⇒ ::Array<::Google::Cloud::AIPlatform::V1::NearestNeighborSearchOperationMetadata::ContentValidationStats>
The validation stats of the content (per file) to be inserted or updated on the Matching Engine Index resource.
#data_bytes_count ⇒ ::Integer
The ingested data size in bytes.

Instance Attribute Details

#content_validation_stats ⇒ `::Array<::Google::Cloud::AIPlatform::V1::NearestNeighborSearchOperationMetadata::ContentValidationStats>`

Returns The validation stats of the content (per file) to be inserted or updated on the Matching Engine Index resource. Populated if contentsDeltaUri is provided as part of Index.metadata. Please note that, currently for those files that are broken or has unsupported file format, we will not have the stats for those files.

Returns:

(::Array<::Google::Cloud::AIPlatform::V1::NearestNeighborSearchOperationMetadata::ContentValidationStats>) —
The validation stats of the content (per file) to be inserted or updated on the Matching Engine Index resource. Populated if contentsDeltaUri is provided as part of Index.metadata. Please note that, currently for those files that are broken or has unsupported file format, we will not have the stats for those files.

# File 'proto_docs/google/cloud/aiplatform/v1/index_service.rb', line 145

class NearestNeighborSearchOperationMetadata
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods

  # @!attribute [rw] error_type
  #   @return [::Google::Cloud::AIPlatform::V1::NearestNeighborSearchOperationMetadata::RecordError::RecordErrorType]
  #     The error type of this record.
  # @!attribute [rw] error_message
  #   @return [::String]
  #     A human-readable message that is shown to the user to help them fix the
  #     error. Note that this message may change from time to time, your code
  #     should check against error_type as the source of truth.
  # @!attribute [rw] source_gcs_uri
  #   @return [::String]
  #     Cloud Storage URI pointing to the original file in user's bucket.
  # @!attribute [rw] embedding_id
  #   @return [::String]
  #     Empty if the embedding id is failed to parse.
  # @!attribute [rw] raw_record
  #   @return [::String]
  #     The original content of this record.
  class RecordError
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods

    module RecordErrorType
      # Default, shall not be used.
      ERROR_TYPE_UNSPECIFIED = 0

      # The record is empty.
      EMPTY_LINE = 1

      # Invalid json format.
      INVALID_JSON_SYNTAX = 2

      # Invalid csv format.
      INVALID_CSV_SYNTAX = 3

      # Invalid avro format.
      INVALID_AVRO_SYNTAX = 4

      # The embedding id is not valid.
      INVALID_EMBEDDING_ID = 5

      # The size of the embedding vectors does not match with the specified
      # dimension.
      EMBEDDING_SIZE_MISMATCH = 6

      # The `namespace` field is missing.
      NAMESPACE_MISSING = 7
    end
  end

  # @!attribute [rw] source_gcs_uri
  #   @return [::String]
  #     Cloud Storage URI pointing to the original file in user's bucket.
  # @!attribute [rw] valid_record_count
  #   @return [::Integer]
  #     Number of records in this file that were successfully processed.
  # @!attribute [rw] invalid_record_count
  #   @return [::Integer]
  #     Number of records in this file we skipped due to validate errors.
  # @!attribute [rw] partial_errors
  #   @return [::Array<::Google::Cloud::AIPlatform::V1::NearestNeighborSearchOperationMetadata::RecordError>]
  #     The detail information of the partial failures encountered for those
  #     invalid records that couldn't be parsed.
  #     Up to 50 partial errors will be reported.
  class ContentValidationStats
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end
end

#data_bytes_count ⇒ `::Integer`

Returns The ingested data size in bytes.