Discovery Engine V1BETA API - Class Google::Cloud::DiscoveryEngine::V1beta::Chunk (v0.13.0)

Reference documentation and code samples for the Discovery Engine V1BETA API class Google::Cloud::DiscoveryEngine::V1beta::Chunk.

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

Inherits

  • Object

Extended By

  • Google::Protobuf::MessageExts::ClassMethods

Includes

  • Google::Protobuf::MessageExts

Methods

#chunk_metadata

def chunk_metadata() -> ::Google::Cloud::DiscoveryEngine::V1beta::Chunk::ChunkMetadata
Returns

#content

def content() -> ::String
Returns
  • (::String) — Content is a string from a document (parsed content).

#content=

def content=(value) -> ::String
Parameter
  • value (::String) — Content is a string from a document (parsed content).
Returns
  • (::String) — Content is a string from a document (parsed content).

#derived_struct_data

def derived_struct_data() -> ::Google::Protobuf::Struct
Returns
  • (::Google::Protobuf::Struct) — Output only. This field is OUTPUT_ONLY. It contains derived data that are not in the original input document.

#document_metadata

def document_metadata() -> ::Google::Cloud::DiscoveryEngine::V1beta::Chunk::DocumentMetadata
Returns

#document_metadata=

def document_metadata=(value) -> ::Google::Cloud::DiscoveryEngine::V1beta::Chunk::DocumentMetadata
Parameter
Returns

#id

def id() -> ::String
Returns
  • (::String) — Unique chunk ID of the current chunk.

#id=

def id=(value) -> ::String
Parameter
  • value (::String) — Unique chunk ID of the current chunk.
Returns
  • (::String) — Unique chunk ID of the current chunk.

#name

def name() -> ::String
Returns
  • (::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.

#name=

def name=(value) -> ::String
Parameter
  • value (::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.

Returns
  • (::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.

#page_span

def page_span() -> ::Google::Cloud::DiscoveryEngine::V1beta::Chunk::PageSpan
Returns

#page_span=

def page_span=(value) -> ::Google::Cloud::DiscoveryEngine::V1beta::Chunk::PageSpan
Parameter
Returns

#relevance_score

def relevance_score() -> ::Float
Returns
  • (::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][].