Class: Google::Apis::AiplatformV1beta1::GenaiVertexV1beta1FileCitation

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

A file citation annotation.

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(**args) ⇒ GenaiVertexV1beta1FileCitation

Returns a new instance of GenaiVertexV1beta1FileCitation.



2018
2019
2020
 
# File 'lib/google/apis/aiplatform_v1beta1/classes.rb', line 2018

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

Instance Attribute Details

#custom_metadata ⇒ Google::Apis::AiplatformV1beta1::GenaiStruct

Struct represents a structured data value, consisting of fields which map to dynamically typed values. Corresponds to the JSON property custom_metadata

Returns:



1991
1992
1993
 
# File 'lib/google/apis/aiplatform_v1beta1/classes.rb', line 1991

def custom_metadata
  @custom_metadata
end

#document_uri ⇒ String

The URI of the file. Corresponds to the JSON property document_uri

Returns:

  • (String) 


1996
1997
1998
 
# File 'lib/google/apis/aiplatform_v1beta1/classes.rb', line 1996

def document_uri
  @document_uri
end

#file_name ⇒ String

The name of the file. Corresponds to the JSON property file_name

Returns:

  • (String) 


2001
2002
2003
 
# File 'lib/google/apis/aiplatform_v1beta1/classes.rb', line 2001

def file_name
  @file_name
end

#media_id ⇒ String

Media ID in-case of image citations, if applicable. Corresponds to the JSON property media_id

Returns:

  • (String) 


2006
2007
2008
 
# File 'lib/google/apis/aiplatform_v1beta1/classes.rb', line 2006

def media_id
  @media_id
end

#page_number ⇒ Fixnum

Page number of the cited document, if applicable. Corresponds to the JSON property page_number

Returns:

  • (Fixnum) 


2011
2012
2013
 
# File 'lib/google/apis/aiplatform_v1beta1/classes.rb', line 2011

def page_number
  @page_number
end

#source ⇒ String

Source attributed for a portion of the text. Corresponds to the JSON property source

Returns:

  • (String) 


2016
2017
2018
 
# File 'lib/google/apis/aiplatform_v1beta1/classes.rb', line 2016

def source
  @source
end

Instance Method Details

#update!(**args) ⇒ Object

Update properties of this object



2023
2024
2025
2026
2027
2028
2029
2030
 
# File 'lib/google/apis/aiplatform_v1beta1/classes.rb', line 2023

def update!(**args)
  @custom_metadata = args[:custom_metadata] if args.key?(:custom_metadata)
  @document_uri = args[:document_uri] if args.key?(:document_uri)
  @file_name = args[:file_name] if args.key?(:file_name)
  @media_id = args[:media_id] if args.key?(:media_id)
  @page_number = args[:page_number] if args.key?(:page_number)
  @source = args[:source] if args.key?(:source)
end