Class: Google::Apis::DiscoveryengineV1::GoogleCloudDiscoveryengineV1Chunk
- Inherits:
-
Object
- Object
- Google::Apis::DiscoveryengineV1::GoogleCloudDiscoveryengineV1Chunk
- Includes:
- Core::Hashable, Core::JsonObjectSupport
- Defined in:
- lib/google/apis/discoveryengine_v1/classes.rb,
lib/google/apis/discoveryengine_v1/representations.rb,
lib/google/apis/discoveryengine_v1/representations.rb
Overview
Chunk captures all raw metadata information of items to be recommended or searched in the chunk mode.
Instance Attribute Summary collapse
-
#chunk_metadata ⇒ Google::Apis::DiscoveryengineV1::GoogleCloudDiscoveryengineV1ChunkChunkMetadata
Metadata of the current chunk.
-
#content ⇒ String
Content is a string from a document (parsed content).
-
#derived_struct_data ⇒ Hash<String,Object>
Output only.
-
#document_metadata ⇒ Google::Apis::DiscoveryengineV1::GoogleCloudDiscoveryengineV1ChunkDocumentMetadata
Document metadata contains the information of the document of the current chunk.
-
#id ⇒ String
Unique chunk ID of the current chunk.
-
#name ⇒ String
The full resource name of the chunk.
-
#page_span ⇒ Google::Apis::DiscoveryengineV1::GoogleCloudDiscoveryengineV1ChunkPageSpan
Page span of the chunk.
-
#relevance_score ⇒ Float
Output only.
Instance Method Summary collapse
-
#initialize(**args) ⇒ GoogleCloudDiscoveryengineV1Chunk
constructor
A new instance of GoogleCloudDiscoveryengineV1Chunk.
-
#update!(**args) ⇒ Object
Update properties of this object.
Constructor Details
#initialize(**args) ⇒ GoogleCloudDiscoveryengineV1Chunk
Returns a new instance of GoogleCloudDiscoveryengineV1Chunk.
2280 2281 2282 |
# File 'lib/google/apis/discoveryengine_v1/classes.rb', line 2280 def initialize(**args) update!(**args) end |
Instance Attribute Details
#chunk_metadata ⇒ Google::Apis::DiscoveryengineV1::GoogleCloudDiscoveryengineV1ChunkChunkMetadata
Metadata of the current chunk. This field is only populated on SearchService.
Search API.
Corresponds to the JSON property chunkMetadata
2236 2237 2238 |
# File 'lib/google/apis/discoveryengine_v1/classes.rb', line 2236 def @chunk_metadata end |
#content ⇒ String
Content is a string from a document (parsed content).
Corresponds to the JSON property content
2241 2242 2243 |
# File 'lib/google/apis/discoveryengine_v1/classes.rb', line 2241 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
2247 2248 2249 |
# File 'lib/google/apis/discoveryengine_v1/classes.rb', line 2247 def derived_struct_data @derived_struct_data end |
#document_metadata ⇒ Google::Apis::DiscoveryengineV1::GoogleCloudDiscoveryengineV1ChunkDocumentMetadata
Document metadata contains the information of the document of the current
chunk.
Corresponds to the JSON property documentMetadata
2253 2254 2255 |
# File 'lib/google/apis/discoveryengine_v1/classes.rb', line 2253 def @document_metadata end |
#id ⇒ String
Unique chunk ID of the current chunk.
Corresponds to the JSON property id
2258 2259 2260 |
# File 'lib/google/apis/discoveryengine_v1/classes.rb', line 2258 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 property
name`
2266 2267 2268 |
# File 'lib/google/apis/discoveryengine_v1/classes.rb', line 2266 def name @name end |
#page_span ⇒ Google::Apis::DiscoveryengineV1::GoogleCloudDiscoveryengineV1ChunkPageSpan
Page span of the chunk.
Corresponds to the JSON property pageSpan
2271 2272 2273 |
# File 'lib/google/apis/discoveryengine_v1/classes.rb', line 2271 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 SearchService.SearchResponse.
Corresponds to the JSON property relevanceScore
2278 2279 2280 |
# File 'lib/google/apis/discoveryengine_v1/classes.rb', line 2278 def relevance_score @relevance_score end |
Instance Method Details
#update!(**args) ⇒ Object
Update properties of this object
2285 2286 2287 2288 2289 2290 2291 2292 2293 2294 |
# File 'lib/google/apis/discoveryengine_v1/classes.rb', line 2285 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 |