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.



6448
6449
6450
# File 'lib/google/apis/discoveryengine_v1alpha/classes.rb', line 6448

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

Instance Attribute Details

#chunk_metadataGoogle::Apis::DiscoveryengineV1alpha::GoogleCloudDiscoveryengineV1alphaChunkChunkMetadata

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



6404
6405
6406
# File 'lib/google/apis/discoveryengine_v1alpha/classes.rb', line 6404

def 
  @chunk_metadata
end

#contentString

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

Returns:

  • (String)


6409
6410
6411
# File 'lib/google/apis/discoveryengine_v1alpha/classes.rb', line 6409

def content
  @content
end

#derived_struct_dataHash<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>)


6415
6416
6417
# File 'lib/google/apis/discoveryengine_v1alpha/classes.rb', line 6415

def derived_struct_data
  @derived_struct_data
end

#document_metadataGoogle::Apis::DiscoveryengineV1alpha::GoogleCloudDiscoveryengineV1alphaChunkDocumentMetadata

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



6421
6422
6423
# File 'lib/google/apis/discoveryengine_v1alpha/classes.rb', line 6421

def 
  @document_metadata
end

#idString

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

Returns:

  • (String)


6426
6427
6428
# File 'lib/google/apis/discoveryengine_v1alpha/classes.rb', line 6426

def id
  @id
end

#nameString

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)


6434
6435
6436
# File 'lib/google/apis/discoveryengine_v1alpha/classes.rb', line 6434

def name
  @name
end

#page_spanGoogle::Apis::DiscoveryengineV1alpha::GoogleCloudDiscoveryengineV1alphaChunkPageSpan

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



6439
6440
6441
# File 'lib/google/apis/discoveryengine_v1alpha/classes.rb', line 6439

def page_span
  @page_span
end

#relevance_scoreFloat

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)


6446
6447
6448
# File 'lib/google/apis/discoveryengine_v1alpha/classes.rb', line 6446

def relevance_score
  @relevance_score
end

Instance Method Details

#update!(**args) ⇒ Object

Update properties of this object



6453
6454
6455
6456
6457
6458
6459
6460
6461
6462
# File 'lib/google/apis/discoveryengine_v1alpha/classes.rb', line 6453

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