Class: Google::Apis::AiplatformV1beta1::LearningGenaiRecitationDocAttribution

Inherits:
Object
  • Object
show all
Includes:
Core::Hashable, Core::JsonObjectSupport
Defined in:
lib/google/apis/aiplatform_v1beta1/classes.rb,
lib/google/apis/aiplatform_v1beta1/representations.rb,
lib/google/apis/aiplatform_v1beta1/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) ⇒ LearningGenaiRecitationDocAttribution

Returns a new instance of LearningGenaiRecitationDocAttribution.



30473
30474
30475
 
# File 'lib/google/apis/aiplatform_v1beta1/classes.rb', line 30473

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

Instance Attribute Details

#amarna_id ⇒ String

Corresponds to the JSON property amarnaId

Returns:

  • (String) 


30310
30311
30312
 
# File 'lib/google/apis/aiplatform_v1beta1/classes.rb', line 30310

def amarna_id
  @amarna_id
end

#arxiv_id ⇒ String

Corresponds to the JSON property arxivId

Returns:

  • (String) 


30315
30316
30317
 
# File 'lib/google/apis/aiplatform_v1beta1/classes.rb', line 30315

def arxiv_id
  @arxiv_id
end

#author ⇒ String

Corresponds to the JSON property author

Returns:

  • (String) 


30320
30321
30322
 
# File 'lib/google/apis/aiplatform_v1beta1/classes.rb', line 30320

def author
  @author
end

#bibkey ⇒ String

Corresponds to the JSON property bibkey

Returns:

  • (String) 


30325
30326
30327
 
# File 'lib/google/apis/aiplatform_v1beta1/classes.rb', line 30325

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) 


30331
30332
30333
 
# File 'lib/google/apis/aiplatform_v1beta1/classes.rb', line 30331

def biorxiv_id
  @biorxiv_id
end

#book_title ⇒ String

Corresponds to the JSON property bookTitle

Returns:

  • (String) 


30336
30337
30338
 
# File 'lib/google/apis/aiplatform_v1beta1/classes.rb', line 30336

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) 


30345
30346
30347
 
# File 'lib/google/apis/aiplatform_v1beta1/classes.rb', line 30345

def book_volume_id
  @book_volume_id
end

#conversation_id ⇒ String

Corresponds to the JSON property conversationId

Returns:

  • (String) 


30350
30351
30352
 
# File 'lib/google/apis/aiplatform_v1beta1/classes.rb', line 30350

def conversation_id
  @conversation_id
end

#dataset ⇒ String

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

Returns:

  • (String) 


30355
30356
30357
 
# File 'lib/google/apis/aiplatform_v1beta1/classes.rb', line 30355

def dataset
  @dataset
end

#filepath ⇒ String

Corresponds to the JSON property filepath

Returns:

  • (String) 


30360
30361
30362
 
# File 'lib/google/apis/aiplatform_v1beta1/classes.rb', line 30360

def filepath
  @filepath
end

#gemini_id ⇒ String

Corresponds to the JSON property geminiId

Returns:

  • (String) 


30365
30366
30367
 
# File 'lib/google/apis/aiplatform_v1beta1/classes.rb', line 30365

def gemini_id
  @gemini_id
end

#gnews_article_title ⇒ String

Corresponds to the JSON property gnewsArticleTitle

Returns:

  • (String) 


30370
30371
30372
 
# File 'lib/google/apis/aiplatform_v1beta1/classes.rb', line 30370

def gnews_article_title
  @gnews_article_title
end

#goodall_example_id ⇒ String

Corresponds to the JSON property goodallExampleId

Returns:

  • (String) 


30375
30376
30377
 
# File 'lib/google/apis/aiplatform_v1beta1/classes.rb', line 30375

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) 


30380
30381
30382
 
# File 'lib/google/apis/aiplatform_v1beta1/classes.rb', line 30380

def is_opt_out
  @is_opt_out
end

#is_prompt ⇒ Boolean Also known as: is_prompt?

When true, this attribution came from the user's prompt. Corresponds to the JSON property isPrompt

Returns:

  • (Boolean) 


30386
30387
30388
 
# File 'lib/google/apis/aiplatform_v1beta1/classes.rb', line 30386

def is_prompt
  @is_prompt
end

#lamda_example_id ⇒ String

Corresponds to the JSON property lamdaExampleId

Returns:

  • (String) 


30392
30393
30394
 
# File 'lib/google/apis/aiplatform_v1beta1/classes.rb', line 30392

def lamda_example_id
  @lamda_example_id
end

#license ⇒ String

Corresponds to the JSON property license

Returns:

  • (String) 


30397
30398
30399
 
# File 'lib/google/apis/aiplatform_v1beta1/classes.rb', line 30397

def license
  @license
end

#meena_conversation_id ⇒ String

Corresponds to the JSON property meenaConversationId

Returns:

  • (String) 


30402
30403
30404
 
# File 'lib/google/apis/aiplatform_v1beta1/classes.rb', line 30402

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) 


30410
30411
30412
 
# File 'lib/google/apis/aiplatform_v1beta1/classes.rb', line 30410

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) 


30419
30420
30421
 
# File 'lib/google/apis/aiplatform_v1beta1/classes.rb', line 30419

def no_attribution
  @no_attribution
end

#podcast_utterance_id ⇒ String

Corresponds to the JSON property podcastUtteranceId

Returns:

  • (String) 


30425
30426
30427
 
# File 'lib/google/apis/aiplatform_v1beta1/classes.rb', line 30425

def podcast_utterance_id
  @podcast_utterance_id
end

#publication_date ⇒ Google::Apis::AiplatformV1beta1::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:



30437
30438
30439
 
# File 'lib/google/apis/aiplatform_v1beta1/classes.rb', line 30437

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) 


30443
30444
30445
 
# File 'lib/google/apis/aiplatform_v1beta1/classes.rb', line 30443

def quality_score_experiment_only
  @quality_score_experiment_only
end

#repo ⇒ String

Github repository Corresponds to the JSON property repo

Returns:

  • (String) 


30448
30449
30450
 
# File 'lib/google/apis/aiplatform_v1beta1/classes.rb', line 30448

def repo
  @repo
end

#url ⇒ String

URL of a webdoc Corresponds to the JSON property url

Returns:

  • (String) 


30453
30454
30455
 
# File 'lib/google/apis/aiplatform_v1beta1/classes.rb', line 30453

def url
  @url
end

#volume_id ⇒ String

Corresponds to the JSON property volumeId

Returns:

  • (String) 


30458
30459
30460
 
# File 'lib/google/apis/aiplatform_v1beta1/classes.rb', line 30458

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) 


30466
30467
30468
 
# File 'lib/google/apis/aiplatform_v1beta1/classes.rb', line 30466

def wikipedia_article_title
  @wikipedia_article_title
end

#youtube_video_id ⇒ String

Corresponds to the JSON property youtubeVideoId

Returns:

  • (String) 


30471
30472
30473
 
# File 'lib/google/apis/aiplatform_v1beta1/classes.rb', line 30471

def youtube_video_id
  @youtube_video_id
end

Instance Method Details

#update!(**args) ⇒ Object

Update properties of this object



30478
30479
30480
30481
30482
30483
30484
30485
30486
30487
30488
30489
30490
30491
30492
30493
30494
30495
30496
30497
30498
30499
30500
30501
30502
30503
30504
30505
30506
30507
 
# File 'lib/google/apis/aiplatform_v1beta1/classes.rb', line 30478

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)
  @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