Class: Google::Apis::AiplatformV1beta1::LanguageLabsAidaTrustRecitationProtoDocAttribution

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:28

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(**args) ⇒ LanguageLabsAidaTrustRecitationProtoDocAttribution

Returns a new instance of LanguageLabsAidaTrustRecitationProtoDocAttribution.



29928
29929
29930
 
# File 'lib/google/apis/aiplatform_v1beta1/classes.rb', line 29928

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

Instance Attribute Details

#amarna_id ⇒ String

Corresponds to the JSON property amarnaId

Returns:

  • (String) 


29771
29772
29773
 
# File 'lib/google/apis/aiplatform_v1beta1/classes.rb', line 29771

def amarna_id
  @amarna_id
end

#arxiv_id ⇒ String

Corresponds to the JSON property arxivId

Returns:

  • (String) 


29776
29777
29778
 
# File 'lib/google/apis/aiplatform_v1beta1/classes.rb', line 29776

def arxiv_id
  @arxiv_id
end

#author ⇒ String

Corresponds to the JSON property author

Returns:

  • (String) 


29781
29782
29783
 
# File 'lib/google/apis/aiplatform_v1beta1/classes.rb', line 29781

def author
  @author
end

#bibkey ⇒ String

Corresponds to the JSON property bibkey

Returns:

  • (String) 


29786
29787
29788
 
# File 'lib/google/apis/aiplatform_v1beta1/classes.rb', line 29786

def bibkey
  @bibkey
end

#book_title ⇒ String

Corresponds to the JSON property bookTitle

Returns:

  • (String) 


29791
29792
29793
 
# File 'lib/google/apis/aiplatform_v1beta1/classes.rb', line 29791

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) 


29800
29801
29802
 
# File 'lib/google/apis/aiplatform_v1beta1/classes.rb', line 29800

def book_volume_id
  @book_volume_id
end

#category ⇒ String

Corresponds to the JSON property category

Returns:

  • (String) 


29805
29806
29807
 
# File 'lib/google/apis/aiplatform_v1beta1/classes.rb', line 29805

def category
  @category
end

#conversation_id ⇒ String

Corresponds to the JSON property conversationId

Returns:

  • (String) 


29810
29811
29812
 
# File 'lib/google/apis/aiplatform_v1beta1/classes.rb', line 29810

def conversation_id
  @conversation_id
end

#dataset ⇒ String

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

Returns:

  • (String) 


29815
29816
29817
 
# File 'lib/google/apis/aiplatform_v1beta1/classes.rb', line 29815

def dataset
  @dataset
end

#filepath ⇒ String

Corresponds to the JSON property filepath

Returns:

  • (String) 


29820
29821
29822
 
# File 'lib/google/apis/aiplatform_v1beta1/classes.rb', line 29820

def filepath
  @filepath
end

#gemini_id ⇒ String

Corresponds to the JSON property geminiId

Returns:

  • (String) 


29825
29826
29827
 
# File 'lib/google/apis/aiplatform_v1beta1/classes.rb', line 29825

def gemini_id
  @gemini_id
end

#gnews_article_title ⇒ String

Corresponds to the JSON property gnewsArticleTitle

Returns:

  • (String) 


29830
29831
29832
 
# File 'lib/google/apis/aiplatform_v1beta1/classes.rb', line 29830

def gnews_article_title
  @gnews_article_title
end

#goodall_example_id ⇒ String

Corresponds to the JSON property goodallExampleId

Returns:

  • (String) 


29835
29836
29837
 
# File 'lib/google/apis/aiplatform_v1beta1/classes.rb', line 29835

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) 


29840
29841
29842
 
# File 'lib/google/apis/aiplatform_v1beta1/classes.rb', line 29840

def is_opt_out
  @is_opt_out
end

#is_prompt ⇒ Boolean Also known as: is_prompt?

Corresponds to the JSON property isPrompt

Returns:

  • (Boolean) 


29846
29847
29848
 
# File 'lib/google/apis/aiplatform_v1beta1/classes.rb', line 29846

def is_prompt
  @is_prompt
end

#lamda_example_id ⇒ String

Corresponds to the JSON property lamdaExampleId

Returns:

  • (String) 


29852
29853
29854
 
# File 'lib/google/apis/aiplatform_v1beta1/classes.rb', line 29852

def lamda_example_id
  @lamda_example_id
end

#license ⇒ String

Corresponds to the JSON property license

Returns:

  • (String) 


29857
29858
29859
 
# File 'lib/google/apis/aiplatform_v1beta1/classes.rb', line 29857

def license
  @license
end

#meena_conversation_id ⇒ String

Corresponds to the JSON property meenaConversationId

Returns:

  • (String) 


29862
29863
29864
 
# File 'lib/google/apis/aiplatform_v1beta1/classes.rb', line 29862

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) 


29870
29871
29872
 
# File 'lib/google/apis/aiplatform_v1beta1/classes.rb', line 29870

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) 


29879
29880
29881
 
# File 'lib/google/apis/aiplatform_v1beta1/classes.rb', line 29879

def no_attribution
  @no_attribution
end

#podcast_utterance_id ⇒ String

Corresponds to the JSON property podcastUtteranceId

Returns:

  • (String) 


29885
29886
29887
 
# File 'lib/google/apis/aiplatform_v1beta1/classes.rb', line 29885

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:



29897
29898
29899
 
# File 'lib/google/apis/aiplatform_v1beta1/classes.rb', line 29897

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) 


29903
29904
29905
 
# File 'lib/google/apis/aiplatform_v1beta1/classes.rb', line 29903

def quality_score_experiment_only
  @quality_score_experiment_only
end

#repo ⇒ String

Github repository Corresponds to the JSON property repo

Returns:

  • (String) 


29908
29909
29910
 
# File 'lib/google/apis/aiplatform_v1beta1/classes.rb', line 29908

def repo
  @repo
end

#url ⇒ String

URL of a webdoc Corresponds to the JSON property url

Returns:

  • (String) 


29913
29914
29915
 
# File 'lib/google/apis/aiplatform_v1beta1/classes.rb', line 29913

def url
  @url
end

#volume_id ⇒ String

Corresponds to the JSON property volumeId

Returns:

  • (String) 


29918
29919
29920
 
# File 'lib/google/apis/aiplatform_v1beta1/classes.rb', line 29918

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) 


29926
29927
29928
 
# File 'lib/google/apis/aiplatform_v1beta1/classes.rb', line 29926

def wikipedia_article_title
  @wikipedia_article_title
end

Instance Method Details

#update!(**args) ⇒ Object

Update properties of this object



29933
29934
29935
29936
29937
29938
29939
29940
29941
29942
29943
29944
29945
29946
29947
29948
29949
29950
29951
29952
29953
29954
29955
29956
29957
29958
29959
29960
29961
 
# File 'lib/google/apis/aiplatform_v1beta1/classes.rb', line 29933

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