Class: Google::Apis::DiscoveryengineV1alpha::GoogleCloudDiscoveryengineV1alphaChunk

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

Returns a new instance of GoogleCloudDiscoveryengineV1alphaChunk.



3340
3341
3342
 
# File 'lib/google/apis/discoveryengine_v1alpha/classes.rb', line 3340

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

Instance Attribute Details

#chunk_metadata ⇒ Google::Apis::DiscoveryengineV1alpha::GoogleCloudDiscoveryengineV1alphaChunkChunkMetadata

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

Returns:



3296
3297
3298
 
# File 'lib/google/apis/discoveryengine_v1alpha/classes.rb', line 3296

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) 


3301
3302
3303
 
# File 'lib/google/apis/discoveryengine_v1alpha/classes.rb', line 3301

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


3307
3308
3309
 
# File 'lib/google/apis/discoveryengine_v1alpha/classes.rb', line 3307

def derived_struct_data
  @derived_struct_data
end

#document_metadata ⇒ Google::Apis::DiscoveryengineV1alpha::GoogleCloudDiscoveryengineV1alphaChunkDocumentMetadata

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

Returns:



3313
3314
3315
 
# File 'lib/google/apis/discoveryengine_v1alpha/classes.rb', line 3313

def document_metadata
  @document_metadata
end

#id ⇒ String

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

Returns:

  • (String) 


3318
3319
3320
 
# File 'lib/google/apis/discoveryengine_v1alpha/classes.rb', line 3318

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) 


3326
3327
3328
 
# File 'lib/google/apis/discoveryengine_v1alpha/classes.rb', line 3326

def name
  @name
end

#page_span ⇒ Google::Apis::DiscoveryengineV1alpha::GoogleCloudDiscoveryengineV1alphaChunkPageSpan

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

Returns:



3331
3332
3333
 
# File 'lib/google/apis/discoveryengine_v1alpha/classes.rb', line 3331

def page_span
  @page_span
end

#relevance_score ⇒ Float

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

Returns:

  • (Float) 


3338
3339
3340
 
# File 'lib/google/apis/discoveryengine_v1alpha/classes.rb', line 3338

def relevance_score
  @relevance_score
end

Instance Method Details

#update!(**args) ⇒ Object

Update properties of this object



3345
3346
3347
3348
3349
3350
3351
3352
3353
3354
 
# File 'lib/google/apis/discoveryengine_v1alpha/classes.rb', line 3345

def update!(**args)
  @chunk_metadata = args[:chunk_metadata] if args.key?(:chunk_metadata)
  @content = args[:content] if args.key?(:content)
  @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