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

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(**args) ⇒ LanguageLabsAidaTrustRecitationProtoDocAttribution

Returns a new instance of LanguageLabsAidaTrustRecitationProtoDocAttribution.



35188
35189
35190
 
# File 'lib/google/apis/aiplatform_v1beta1/classes.rb', line 35188

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

Instance Attribute Details

#amarna_id ⇒ String

Corresponds to the JSON property amarnaId

Returns:

  • (String) 


35020
35021
35022
 
# File 'lib/google/apis/aiplatform_v1beta1/classes.rb', line 35020

def amarna_id
  @amarna_id
end

#arxiv_id ⇒ String

Corresponds to the JSON property arxivId

Returns:

  • (String) 


35025
35026
35027
 
# File 'lib/google/apis/aiplatform_v1beta1/classes.rb', line 35025

def arxiv_id
  @arxiv_id
end

#author ⇒ String

Corresponds to the JSON property author

Returns:

  • (String) 


35030
35031
35032
 
# File 'lib/google/apis/aiplatform_v1beta1/classes.rb', line 35030

def author
  @author
end

#bibkey ⇒ String

Corresponds to the JSON property bibkey

Returns:

  • (String) 


35035
35036
35037
 
# File 'lib/google/apis/aiplatform_v1beta1/classes.rb', line 35035

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) 


35041
35042
35043
 
# File 'lib/google/apis/aiplatform_v1beta1/classes.rb', line 35041

def biorxiv_id
  @biorxiv_id
end

#book_title ⇒ String

Corresponds to the JSON property bookTitle

Returns:

  • (String) 


35046
35047
35048
 
# File 'lib/google/apis/aiplatform_v1beta1/classes.rb', line 35046

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) 


35055
35056
35057
 
# File 'lib/google/apis/aiplatform_v1beta1/classes.rb', line 35055

def book_volume_id
  @book_volume_id
end

#category ⇒ String

Corresponds to the JSON property category

Returns:

  • (String) 


35060
35061
35062
 
# File 'lib/google/apis/aiplatform_v1beta1/classes.rb', line 35060

def category
  @category
end

#conversation_id ⇒ String

Corresponds to the JSON property conversationId

Returns:

  • (String) 


35065
35066
35067
 
# File 'lib/google/apis/aiplatform_v1beta1/classes.rb', line 35065

def conversation_id
  @conversation_id
end

#dataset ⇒ String

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

Returns:

  • (String) 


35070
35071
35072
 
# File 'lib/google/apis/aiplatform_v1beta1/classes.rb', line 35070

def dataset
  @dataset
end

#filepath ⇒ String

Corresponds to the JSON property filepath

Returns:

  • (String) 


35075
35076
35077
 
# File 'lib/google/apis/aiplatform_v1beta1/classes.rb', line 35075

def filepath
  @filepath
end

#gemini_id ⇒ String

Corresponds to the JSON property geminiId

Returns:

  • (String) 


35080
35081
35082
 
# File 'lib/google/apis/aiplatform_v1beta1/classes.rb', line 35080

def gemini_id
  @gemini_id
end

#gnews_article_title ⇒ String

Corresponds to the JSON property gnewsArticleTitle

Returns:

  • (String) 


35085
35086
35087
 
# File 'lib/google/apis/aiplatform_v1beta1/classes.rb', line 35085

def gnews_article_title
  @gnews_article_title
end

#goodall_example_id ⇒ String

Corresponds to the JSON property goodallExampleId

Returns:

  • (String) 


35090
35091
35092
 
# File 'lib/google/apis/aiplatform_v1beta1/classes.rb', line 35090

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) 


35095
35096
35097
 
# File 'lib/google/apis/aiplatform_v1beta1/classes.rb', line 35095

def is_opt_out
  @is_opt_out
end

#is_prompt ⇒ Boolean Also known as: is_prompt?

Corresponds to the JSON property isPrompt

Returns:

  • (Boolean) 


35101
35102
35103
 
# File 'lib/google/apis/aiplatform_v1beta1/classes.rb', line 35101

def is_prompt
  @is_prompt
end

#lamda_example_id ⇒ String

Corresponds to the JSON property lamdaExampleId

Returns:

  • (String) 


35107
35108
35109
 
# File 'lib/google/apis/aiplatform_v1beta1/classes.rb', line 35107

def lamda_example_id
  @lamda_example_id
end

#license ⇒ String

Corresponds to the JSON property license

Returns:

  • (String) 


35112
35113
35114
 
# File 'lib/google/apis/aiplatform_v1beta1/classes.rb', line 35112

def license
  @license
end

#meena_conversation_id ⇒ String

Corresponds to the JSON property meenaConversationId

Returns:

  • (String) 


35117
35118
35119
 
# File 'lib/google/apis/aiplatform_v1beta1/classes.rb', line 35117

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) 


35125
35126
35127
 
# File 'lib/google/apis/aiplatform_v1beta1/classes.rb', line 35125

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) 


35134
35135
35136
 
# File 'lib/google/apis/aiplatform_v1beta1/classes.rb', line 35134

def no_attribution
  @no_attribution
end

#podcast_utterance_id ⇒ String

Corresponds to the JSON property podcastUtteranceId

Returns:

  • (String) 


35140
35141
35142
 
# File 'lib/google/apis/aiplatform_v1beta1/classes.rb', line 35140

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:



35152
35153
35154
 
# File 'lib/google/apis/aiplatform_v1beta1/classes.rb', line 35152

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) 


35158
35159
35160
 
# File 'lib/google/apis/aiplatform_v1beta1/classes.rb', line 35158

def quality_score_experiment_only
  @quality_score_experiment_only
end

#repo ⇒ String

Github repository Corresponds to the JSON property repo

Returns:

  • (String) 


35163
35164
35165
 
# File 'lib/google/apis/aiplatform_v1beta1/classes.rb', line 35163

def repo
  @repo
end

#url ⇒ String

URL of a webdoc Corresponds to the JSON property url

Returns:

  • (String) 


35168
35169
35170
 
# File 'lib/google/apis/aiplatform_v1beta1/classes.rb', line 35168

def url
  @url
end

#volume_id ⇒ String

Corresponds to the JSON property volumeId

Returns:

  • (String) 


35173
35174
35175
 
# File 'lib/google/apis/aiplatform_v1beta1/classes.rb', line 35173

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) 


35181
35182
35183
 
# File 'lib/google/apis/aiplatform_v1beta1/classes.rb', line 35181

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) 


35186
35187
35188
 
# File 'lib/google/apis/aiplatform_v1beta1/classes.rb', line 35186

def youtube_video_id
  @youtube_video_id
end

Instance Method Details

#update!(**args) ⇒ Object

Update properties of this object



35193
35194
35195
35196
35197
35198
35199
35200
35201
35202
35203
35204
35205
35206
35207
35208
35209
35210
35211
35212
35213
35214
35215
35216
35217
35218
35219
35220
35221
35222
35223
 
# File 'lib/google/apis/aiplatform_v1beta1/classes.rb', line 35193

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