Class: Google::Apis::DiscoveryengineV1beta::GoogleCloudDiscoveryengineV1betaChunk

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

Overview

Chunk captures all raw metadata information of items to be recommended or searched in the chunk mode.

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(**args) ⇒ GoogleCloudDiscoveryengineV1betaChunk

Returns a new instance of GoogleCloudDiscoveryengineV1betaChunk.



22454
22455
22456
 
# File 'lib/google/apis/discoveryengine_v1beta/classes.rb', line 22454

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

Instance Attribute Details

#annotation_contents ⇒ Array<String>

Output only. Annotation contents if the current chunk contains annotations. Corresponds to the JSON property annotationContents

Returns:

  • (Array<String>) 


22391
22392
22393
 
# File 'lib/google/apis/discoveryengine_v1beta/classes.rb', line 22391

def annotation_contents
  @annotation_contents
end

#annotation_metadata ⇒ Array<Google::Apis::DiscoveryengineV1beta::GoogleCloudDiscoveryengineV1betaChunkAnnotationMetadata>

Output only. The annotation metadata includes structured content in the current chunk. Corresponds to the JSON property annotationMetadata

Returns:



22397
22398
22399
 
# File 'lib/google/apis/discoveryengine_v1beta/classes.rb', line 22397

def annotation_metadata
  @annotation_metadata
end

#chunk_metadata ⇒ Google::Apis::DiscoveryengineV1beta::GoogleCloudDiscoveryengineV1betaChunkChunkMetadata

Metadata of the current chunk. This field is only populated on SearchService. Search API. Corresponds to the JSON property chunkMetadata

Returns:



22403
22404
22405
 
# File 'lib/google/apis/discoveryengine_v1beta/classes.rb', line 22403

def chunk_metadata
  @chunk_metadata
end

#content ⇒ String

Content is a string from a document (parsed content). Corresponds to the JSON property content

Returns:

  • (String) 


22408
22409
22410
 
# File 'lib/google/apis/discoveryengine_v1beta/classes.rb', line 22408

def content
  @content
end

#data_urls ⇒ Array<String>

Output only. Image Data URLs if the current chunk contains images. Data URLs are composed of four parts: a prefix (data:), a MIME type indicating the type of data, an optional base64 token if non-textual, and the data itself: data:, Corresponds to the JSON property dataUrls

Returns:

  • (Array<String>) 


22415
22416
22417
 
# File 'lib/google/apis/discoveryengine_v1beta/classes.rb', line 22415

def data_urls
  @data_urls
end

#derived_struct_data ⇒ Hash<String,Object>

Output only. This field is OUTPUT_ONLY. It contains derived data that are not in the original input document. Corresponds to the JSON property derivedStructData

Returns:

  • (Hash<String,Object>) 


22421
22422
22423
 
# File 'lib/google/apis/discoveryengine_v1beta/classes.rb', line 22421

def derived_struct_data
  @derived_struct_data
end

#document_metadata ⇒ Google::Apis::DiscoveryengineV1beta::GoogleCloudDiscoveryengineV1betaChunkDocumentMetadata

Document metadata contains the information of the document of the current chunk. Corresponds to the JSON property documentMetadata

Returns:



22427
22428
22429
 
# File 'lib/google/apis/discoveryengine_v1beta/classes.rb', line 22427

def document_metadata
  @document_metadata
end

#id ⇒ String

Unique chunk ID of the current chunk. Corresponds to the JSON property id

Returns:

  • (String) 


22432
22433
22434
 
# File 'lib/google/apis/discoveryengine_v1beta/classes.rb', line 22432

def id
  @id
end

#name ⇒ String

The full resource name of the chunk. Format: projects/project/locations/ location/collections/collection/dataStores/data_store/branches/branch/ documents/document_id/chunks/chunk_id`. This field must be a UTF-8 encoded string with a length limit of 1024 characters. Corresponds to the JSON propertyname`

Returns:

  • (String) 


22440
22441
22442
 
# File 'lib/google/apis/discoveryengine_v1beta/classes.rb', line 22440

def name
  @name
end

#page_span ⇒ Google::Apis::DiscoveryengineV1beta::GoogleCloudDiscoveryengineV1betaChunkPageSpan

Page span of the chunk. Corresponds to the JSON property pageSpan

Returns:



22445
22446
22447
 
# File 'lib/google/apis/discoveryengine_v1beta/classes.rb', line 22445

def page_span
  @page_span
end

#relevance_score ⇒ Float

Output only. Represents the relevance score based on similarity. Higher score indicates higher chunk relevance. The score is in range [-1.0, 1.0]. Only populated on SearchResponse. Corresponds to the JSON property relevanceScore

Returns:

  • (Float) 


22452
22453
22454
 
# File 'lib/google/apis/discoveryengine_v1beta/classes.rb', line 22452

def relevance_score
  @relevance_score
end

Instance Method Details

#update!(**args) ⇒ Object

Update properties of this object



22459
22460
22461
22462
22463
22464
22465
22466
22467
22468
22469
22470
22471
 
# File 'lib/google/apis/discoveryengine_v1beta/classes.rb', line 22459

def update!(**args)
  @annotation_contents = args[:annotation_contents] if args.key?(:annotation_contents)
  @annotation_metadata = args[:annotation_metadata] if args.key?(:annotation_metadata)
  @chunk_metadata = args[:chunk_metadata] if args.key?(:chunk_metadata)
  @content = args[:content] if args.key?(:content)
  @data_urls = args[:data_urls] if args.key?(:data_urls)
  @derived_struct_data = args[:derived_struct_data] if args.key?(:derived_struct_data)
  @document_metadata = args[:document_metadata] if args.key?(:document_metadata)
  @id = args[:id] if args.key?(:id)
  @name = args[:name] if args.key?(:name)
  @page_span = args[:page_span] if args.key?(:page_span)
  @relevance_score = args[:relevance_score] if args.key?(:relevance_score)
end