Class: Google::Apis::AiplatformV1::LanguageLabsAidaTrustRecitationProtoDocAttribution

Inherits:
Object
  • Object
show all
Includes:
Core::Hashable, Core::JsonObjectSupport
Defined in:
lib/google/apis/aiplatform_v1/classes.rb,
lib/google/apis/aiplatform_v1/representations.rb,
lib/google/apis/aiplatform_v1/representations.rb

Overview

The proto defines the attribution information for a document using whatever fields are most applicable for that document's datasource. For example, a Wikipedia article's attribution is in the form of its article title, a website is in the form of a URL, and a Github repo is in the form of a repo name. Next id: 30

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(**args) ⇒ LanguageLabsAidaTrustRecitationProtoDocAttribution

Returns a new instance of LanguageLabsAidaTrustRecitationProtoDocAttribution.



29269
29270
29271
 
# File 'lib/google/apis/aiplatform_v1/classes.rb', line 29269

def initialize(**args)
   update!(**args)
end

Instance Attribute Details

#amarna_id ⇒ String

Corresponds to the JSON property amarnaId

Returns:

  • (String) 


29101
29102
29103
 
# File 'lib/google/apis/aiplatform_v1/classes.rb', line 29101

def amarna_id
  @amarna_id
end

#arxiv_id ⇒ String

Corresponds to the JSON property arxivId

Returns:

  • (String) 


29106
29107
29108
 
# File 'lib/google/apis/aiplatform_v1/classes.rb', line 29106

def arxiv_id
  @arxiv_id
end

#author ⇒ String

Corresponds to the JSON property author

Returns:

  • (String) 


29111
29112
29113
 
# File 'lib/google/apis/aiplatform_v1/classes.rb', line 29111

def author
  @author
end

#bibkey ⇒ String

Corresponds to the JSON property bibkey

Returns:

  • (String) 


29116
29117
29118
 
# File 'lib/google/apis/aiplatform_v1/classes.rb', line 29116

def bibkey
  @bibkey
end

#biorxiv_id ⇒ String

ID of the paper in bioarxiv like ddoi.org/biorxiv_id eg: https://doi.org/10. 1101/343517 Corresponds to the JSON property biorxivId

Returns:

  • (String) 


29122
29123
29124
 
# File 'lib/google/apis/aiplatform_v1/classes.rb', line 29122

def biorxiv_id
  @biorxiv_id
end

#book_title ⇒ String

Corresponds to the JSON property bookTitle

Returns:

  • (String) 


29127
29128
29129
 
# File 'lib/google/apis/aiplatform_v1/classes.rb', line 29127

def book_title
  @book_title
end

#book_volume_id ⇒ Fixnum

The Oceanographers full-view books dataset uses a 'volume id' as the unique ID of a book. There is a deterministic function from a volume id to a URL under the books.google.com domain. Marked as 'optional' since a volume ID of zero is potentially possible and we want to distinguish that from the volume ID not being set. Corresponds to the JSON property bookVolumeId

Returns:

  • (Fixnum) 


29136
29137
29138
 
# File 'lib/google/apis/aiplatform_v1/classes.rb', line 29136

def book_volume_id
  @book_volume_id
end

#category ⇒ String

Corresponds to the JSON property category

Returns:

  • (String) 


29141
29142
29143
 
# File 'lib/google/apis/aiplatform_v1/classes.rb', line 29141

def category
  @category
end

#conversation_id ⇒ String

Corresponds to the JSON property conversationId

Returns:

  • (String) 


29146
29147
29148
 
# File 'lib/google/apis/aiplatform_v1/classes.rb', line 29146

def conversation_id
  @conversation_id
end

#dataset ⇒ String

The dataset this document comes from. Corresponds to the JSON property dataset

Returns:

  • (String) 


29151
29152
29153
 
# File 'lib/google/apis/aiplatform_v1/classes.rb', line 29151

def dataset
  @dataset
end

#filepath ⇒ String

Corresponds to the JSON property filepath

Returns:

  • (String) 


29156
29157
29158
 
# File 'lib/google/apis/aiplatform_v1/classes.rb', line 29156

def filepath
  @filepath
end

#gemini_id ⇒ String

Corresponds to the JSON property geminiId

Returns:

  • (String) 


29161
29162
29163
 
# File 'lib/google/apis/aiplatform_v1/classes.rb', line 29161

def gemini_id
  @gemini_id
end

#gnews_article_title ⇒ String

Corresponds to the JSON property gnewsArticleTitle

Returns:

  • (String) 


29166
29167
29168
 
# File 'lib/google/apis/aiplatform_v1/classes.rb', line 29166

def gnews_article_title
  @gnews_article_title
end

#goodall_example_id ⇒ String

Corresponds to the JSON property goodallExampleId

Returns:

  • (String) 


29171
29172
29173
 
# File 'lib/google/apis/aiplatform_v1/classes.rb', line 29171

def goodall_example_id
  @goodall_example_id
end

#is_opt_out ⇒ Boolean Also known as: is_opt_out?

Whether the document is opted out. Corresponds to the JSON property isOptOut

Returns:

  • (Boolean) 


29176
29177
29178
 
# File 'lib/google/apis/aiplatform_v1/classes.rb', line 29176

def is_opt_out
  @is_opt_out
end

#is_prompt ⇒ Boolean Also known as: is_prompt?

Corresponds to the JSON property isPrompt

Returns:

  • (Boolean) 


29182
29183
29184
 
# File 'lib/google/apis/aiplatform_v1/classes.rb', line 29182

def is_prompt
  @is_prompt
end

#lamda_example_id ⇒ String

Corresponds to the JSON property lamdaExampleId

Returns:

  • (String) 


29188
29189
29190
 
# File 'lib/google/apis/aiplatform_v1/classes.rb', line 29188

def lamda_example_id
  @lamda_example_id
end

#license ⇒ String

Corresponds to the JSON property license

Returns:

  • (String) 


29193
29194
29195
 
# File 'lib/google/apis/aiplatform_v1/classes.rb', line 29193

def license
  @license
end

#meena_conversation_id ⇒ String

Corresponds to the JSON property meenaConversationId

Returns:

  • (String) 


29198
29199
29200
 
# File 'lib/google/apis/aiplatform_v1/classes.rb', line 29198

def meena_conversation_id
  @meena_conversation_id
end

#natural_language_code ⇒ String

Natural (not programming) language of the document. Language code as defined by http://www.unicode.org/reports/tr35/#Identifiers and https://tools.ietf.org/ html/bcp47. Currently applicable to full-view books. Use docinfo-util.h to set & read language fields. See go/iii. Corresponds to the JSON property naturalLanguageCode

Returns:

  • (String) 


29206
29207
29208
 
# File 'lib/google/apis/aiplatform_v1/classes.rb', line 29206

def natural_language_code
  @natural_language_code
end

#no_attribution ⇒ Boolean Also known as: no_attribution?

True if this doc has no attribution information available. We use an explicit field for this instead of just implicitly leaving all the DocAttribution fields blank to distinguish a case where a bug/oversight has left the attribution information empty vs when we really have no attribution information available. Corresponds to the JSON property noAttribution

Returns:

  • (Boolean) 


29215
29216
29217
 
# File 'lib/google/apis/aiplatform_v1/classes.rb', line 29215

def no_attribution
  @no_attribution
end

#podcast_utterance_id ⇒ String

Corresponds to the JSON property podcastUtteranceId

Returns:

  • (String) 


29221
29222
29223
 
# File 'lib/google/apis/aiplatform_v1/classes.rb', line 29221

def podcast_utterance_id
  @podcast_utterance_id
end

#publication_date ⇒ Google::Apis::AiplatformV1::GoogleTypeDate

Represents a whole or partial calendar date, such as a birthday. The time of day and time zone are either specified elsewhere or are insignificant. The date is relative to the Gregorian Calendar. This can represent one of the following: * A full date, with non-zero year, month, and day values. * A month and day, with a zero year (for example, an anniversary). * A year on its own, with a zero month and a zero day. * A year and month, with a zero day (for example, a credit card expiration date). Related types: * google.type. TimeOfDay * google.type.DateTime * google.protobuf.Timestamp Corresponds to the JSON property publicationDate

Returns:



29233
29234
29235
 
# File 'lib/google/apis/aiplatform_v1/classes.rb', line 29233

def publication_date
  @publication_date
end

#quality_score_experiment_only ⇒ Float

This field is for opt-out experiment only, MUST never be used during actual production/serving. Corresponds to the JSON property qualityScoreExperimentOnly

Returns:

  • (Float) 


29239
29240
29241
 
# File 'lib/google/apis/aiplatform_v1/classes.rb', line 29239

def quality_score_experiment_only
  @quality_score_experiment_only
end

#repo ⇒ String

Github repository Corresponds to the JSON property repo

Returns:

  • (String) 


29244
29245
29246
 
# File 'lib/google/apis/aiplatform_v1/classes.rb', line 29244

def repo
  @repo
end

#url ⇒ String

URL of a webdoc Corresponds to the JSON property url

Returns:

  • (String) 


29249
29250
29251
 
# File 'lib/google/apis/aiplatform_v1/classes.rb', line 29249

def url
  @url
end

#volume_id ⇒ String

Corresponds to the JSON property volumeId

Returns:

  • (String) 


29254
29255
29256
 
# File 'lib/google/apis/aiplatform_v1/classes.rb', line 29254

def volume_id
  @volume_id
end

#wikipedia_article_title ⇒ String

Wikipedia article title. The Wikipedia TFDS dataset includes article titles but not URLs. While a URL is to the best of our knowledge a deterministic function of the title, we store the original title to reflect the information in the original dataset. Corresponds to the JSON property wikipediaArticleTitle

Returns:

  • (String) 


29262
29263
29264
 
# File 'lib/google/apis/aiplatform_v1/classes.rb', line 29262

def wikipedia_article_title
  @wikipedia_article_title
end

#youtube_video_id ⇒ String

The unique video id from Youtube. Example: AkoGsW52Ir0 Corresponds to the JSON property youtubeVideoId

Returns:

  • (String) 


29267
29268
29269
 
# File 'lib/google/apis/aiplatform_v1/classes.rb', line 29267

def youtube_video_id
  @youtube_video_id
end

Instance Method Details

#update!(**args) ⇒ Object

Update properties of this object



29274
29275
29276
29277
29278
29279
29280
29281
29282
29283
29284
29285
29286
29287
29288
29289
29290
29291
29292
29293
29294
29295
29296
29297
29298
29299
29300
29301
29302
29303
29304
 
# File 'lib/google/apis/aiplatform_v1/classes.rb', line 29274

def update!(**args)
  @amarna_id = args[:amarna_id] if args.key?(:amarna_id)
  @arxiv_id = args[:arxiv_id] if args.key?(:arxiv_id)
  @author = args[:author] if args.key?(:author)
  @bibkey = args[:bibkey] if args.key?(:bibkey)
  @biorxiv_id = args[:biorxiv_id] if args.key?(:biorxiv_id)
  @book_title = args[:book_title] if args.key?(:book_title)
  @book_volume_id = args[:book_volume_id] if args.key?(:book_volume_id)
  @category = args[:category] if args.key?(:category)
  @conversation_id = args[:conversation_id] if args.key?(:conversation_id)
  @dataset = args[:dataset] if args.key?(:dataset)
  @filepath = args[:filepath] if args.key?(:filepath)
  @gemini_id = args[:gemini_id] if args.key?(:gemini_id)
  @gnews_article_title = args[:gnews_article_title] if args.key?(:gnews_article_title)
  @goodall_example_id = args[:goodall_example_id] if args.key?(:goodall_example_id)
  @is_opt_out = args[:is_opt_out] if args.key?(:is_opt_out)
  @is_prompt = args[:is_prompt] if args.key?(:is_prompt)
  @lamda_example_id = args[:lamda_example_id] if args.key?(:lamda_example_id)
  @license = args[:license] if args.key?(:license)
  @meena_conversation_id = args[:meena_conversation_id] if args.key?(:meena_conversation_id)
  @natural_language_code = args[:natural_language_code] if args.key?(:natural_language_code)
  @no_attribution = args[:no_attribution] if args.key?(:no_attribution)
  @podcast_utterance_id = args[:podcast_utterance_id] if args.key?(:podcast_utterance_id)
  @publication_date = args[:publication_date] if args.key?(:publication_date)
  @quality_score_experiment_only = args[:quality_score_experiment_only] if args.key?(:quality_score_experiment_only)
  @repo = args[:repo] if args.key?(:repo)
  @url = args[:url] if args.key?(:url)
  @volume_id = args[:volume_id] if args.key?(:volume_id)
  @wikipedia_article_title = args[:wikipedia_article_title] if args.key?(:wikipedia_article_title)
  @youtube_video_id = args[:youtube_video_id] if args.key?(:youtube_video_id)
end