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.



1861
1862
1863
# File 'lib/google/apis/discoveryengine_v1alpha/classes.rb', line 1861

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

Instance Attribute Details

#contentString

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

Returns:

  • (String)


1834
1835
1836
# File 'lib/google/apis/discoveryengine_v1alpha/classes.rb', line 1834

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


1840
1841
1842
# File 'lib/google/apis/discoveryengine_v1alpha/classes.rb', line 1840

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



1846
1847
1848
# File 'lib/google/apis/discoveryengine_v1alpha/classes.rb', line 1846

def 
  @document_metadata
end

#idString

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

Returns:

  • (String)


1851
1852
1853
# File 'lib/google/apis/discoveryengine_v1alpha/classes.rb', line 1851

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)


1859
1860
1861
# File 'lib/google/apis/discoveryengine_v1alpha/classes.rb', line 1859

def name
  @name
end

Instance Method Details

#update!(**args) ⇒ Object

Update properties of this object



1866
1867
1868
1869
1870
1871
1872
# File 'lib/google/apis/discoveryengine_v1alpha/classes.rb', line 1866

def update!(**args)
  @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)
end