(::String) — Unique chunk ID of the current chunk.
#id=
defid=(value)->::String
Parameter
value (::String) — Unique chunk ID of the current chunk.
Returns
(::String) — Unique chunk ID of the current chunk.
#name
defname()->::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=
defname=(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.
(::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][].
[[["Easy to understand","easyToUnderstand","thumb-up"],["Solved my problem","solvedMyProblem","thumb-up"],["Other","otherUp","thumb-up"]],[["Hard to understand","hardToUnderstand","thumb-down"],["Incorrect information or sample code","incorrectInformationOrSampleCode","thumb-down"],["Missing the information/samples I need","missingTheInformationSamplesINeed","thumb-down"],["Other","otherDown","thumb-down"]],["Last updated 2025-09-04 UTC."],[],[],null,["# Discovery Engine V1BETA API - Class Google::Cloud::DiscoveryEngine::V1beta::Chunk (v0.21.0)\n\nVersion latestkeyboard_arrow_down\n\n- [0.21.0 (latest)](/ruby/docs/reference/google-cloud-discovery_engine-v1beta/latest/Google-Cloud-DiscoveryEngine-V1beta-Chunk)\n- [0.20.1](/ruby/docs/reference/google-cloud-discovery_engine-v1beta/0.20.1/Google-Cloud-DiscoveryEngine-V1beta-Chunk)\n- [0.19.1](/ruby/docs/reference/google-cloud-discovery_engine-v1beta/0.19.1/Google-Cloud-DiscoveryEngine-V1beta-Chunk)\n- [0.18.0](/ruby/docs/reference/google-cloud-discovery_engine-v1beta/0.18.0/Google-Cloud-DiscoveryEngine-V1beta-Chunk)\n- [0.17.0](/ruby/docs/reference/google-cloud-discovery_engine-v1beta/0.17.0/Google-Cloud-DiscoveryEngine-V1beta-Chunk)\n- [0.16.0](/ruby/docs/reference/google-cloud-discovery_engine-v1beta/0.16.0/Google-Cloud-DiscoveryEngine-V1beta-Chunk)\n- [0.15.0](/ruby/docs/reference/google-cloud-discovery_engine-v1beta/0.15.0/Google-Cloud-DiscoveryEngine-V1beta-Chunk)\n- [0.14.2](/ruby/docs/reference/google-cloud-discovery_engine-v1beta/0.14.2/Google-Cloud-DiscoveryEngine-V1beta-Chunk)\n- [0.13.0](/ruby/docs/reference/google-cloud-discovery_engine-v1beta/0.13.0/Google-Cloud-DiscoveryEngine-V1beta-Chunk)\n- [0.12.0](/ruby/docs/reference/google-cloud-discovery_engine-v1beta/0.12.0/Google-Cloud-DiscoveryEngine-V1beta-Chunk)\n- [0.11.0](/ruby/docs/reference/google-cloud-discovery_engine-v1beta/0.11.0/Google-Cloud-DiscoveryEngine-V1beta-Chunk)\n- [0.10.0](/ruby/docs/reference/google-cloud-discovery_engine-v1beta/0.10.0/Google-Cloud-DiscoveryEngine-V1beta-Chunk)\n- [0.9.0](/ruby/docs/reference/google-cloud-discovery_engine-v1beta/0.9.0/Google-Cloud-DiscoveryEngine-V1beta-Chunk)\n- [0.8.0](/ruby/docs/reference/google-cloud-discovery_engine-v1beta/0.8.0/Google-Cloud-DiscoveryEngine-V1beta-Chunk)\n- [0.7.2](/ruby/docs/reference/google-cloud-discovery_engine-v1beta/0.7.2/Google-Cloud-DiscoveryEngine-V1beta-Chunk)\n- [0.6.0](/ruby/docs/reference/google-cloud-discovery_engine-v1beta/0.6.0/Google-Cloud-DiscoveryEngine-V1beta-Chunk)\n- [0.5.0](/ruby/docs/reference/google-cloud-discovery_engine-v1beta/0.5.0/Google-Cloud-DiscoveryEngine-V1beta-Chunk)\n- [0.4.0](/ruby/docs/reference/google-cloud-discovery_engine-v1beta/0.4.0/Google-Cloud-DiscoveryEngine-V1beta-Chunk)\n- [0.3.0](/ruby/docs/reference/google-cloud-discovery_engine-v1beta/0.3.0/Google-Cloud-DiscoveryEngine-V1beta-Chunk)\n- [0.2.1](/ruby/docs/reference/google-cloud-discovery_engine-v1beta/0.2.1/Google-Cloud-DiscoveryEngine-V1beta-Chunk)\n- [0.1.0](/ruby/docs/reference/google-cloud-discovery_engine-v1beta/0.1.0/Google-Cloud-DiscoveryEngine-V1beta-Chunk) \nReference documentation and code samples for the Discovery Engine V1BETA API class Google::Cloud::DiscoveryEngine::V1beta::Chunk.\n\nChunk captures all raw metadata information of items to be recommended or\nsearched in the chunk mode. \n\nInherits\n--------\n\n- Object \n\nExtended By\n-----------\n\n- Google::Protobuf::MessageExts::ClassMethods \n\nIncludes\n--------\n\n- Google::Protobuf::MessageExts\n\nMethods\n-------\n\n### #chunk_metadata\n\n def chunk_metadata() -\u003e ::Google::Cloud::DiscoveryEngine::V1beta::Chunk::ChunkMetadata\n\n**Returns**\n\n- ([::Google::Cloud::DiscoveryEngine::V1beta::Chunk::ChunkMetadata](./Google-Cloud-DiscoveryEngine-V1beta-Chunk-ChunkMetadata)) --- Output only. Metadata of the current chunk.\n\n### #content\n\n def content() -\u003e ::String\n\n**Returns**\n\n- (::String) --- Content is a string from a document (parsed content).\n\n### #content=\n\n def content=(value) -\u003e ::String\n\n**Parameter**\n\n- **value** (::String) --- Content is a string from a document (parsed content). \n**Returns**\n\n- (::String) --- Content is a string from a document (parsed content).\n\n### #derived_struct_data\n\n def derived_struct_data() -\u003e ::Google::Protobuf::Struct\n\n**Returns**\n\n- ([::Google::Protobuf::Struct](./Google-Protobuf-Struct)) --- Output only. This field is OUTPUT_ONLY. It contains derived data that are not in the original input document.\n\n### #document_metadata\n\n def document_metadata() -\u003e ::Google::Cloud::DiscoveryEngine::V1beta::Chunk::DocumentMetadata\n\n**Returns**\n\n- ([::Google::Cloud::DiscoveryEngine::V1beta::Chunk::DocumentMetadata](./Google-Cloud-DiscoveryEngine-V1beta-Chunk-DocumentMetadata)) --- Metadata of the document from the current chunk.\n\n### #document_metadata=\n\n def document_metadata=(value) -\u003e ::Google::Cloud::DiscoveryEngine::V1beta::Chunk::DocumentMetadata\n\n**Parameter**\n\n- **value** ([::Google::Cloud::DiscoveryEngine::V1beta::Chunk::DocumentMetadata](./Google-Cloud-DiscoveryEngine-V1beta-Chunk-DocumentMetadata)) --- Metadata of the document from the current chunk. \n**Returns**\n\n- ([::Google::Cloud::DiscoveryEngine::V1beta::Chunk::DocumentMetadata](./Google-Cloud-DiscoveryEngine-V1beta-Chunk-DocumentMetadata)) --- Metadata of the document from the current chunk.\n\n### #id\n\n def id() -\u003e ::String\n\n**Returns**\n\n- (::String) --- Unique chunk ID of the current chunk.\n\n### #id=\n\n def id=(value) -\u003e ::String\n\n**Parameter**\n\n- **value** (::String) --- Unique chunk ID of the current chunk. \n**Returns**\n\n- (::String) --- Unique chunk ID of the current chunk.\n\n### #name\n\n def name() -\u003e ::String\n\n**Returns**\n\n- (::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}`.\n\n\n This field must be a UTF-8 encoded string with a length limit of 1024\n characters.\n\n### #name=\n\n def name=(value) -\u003e ::String\n\n**Parameter**\n\n- **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}`.\n\n\n This field must be a UTF-8 encoded string with a length limit of 1024\ncharacters. \n**Returns**\n\n- (::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}`.\n\n\n This field must be a UTF-8 encoded string with a length limit of 1024\n characters.\n\n### #page_span\n\n def page_span() -\u003e ::Google::Cloud::DiscoveryEngine::V1beta::Chunk::PageSpan\n\n**Returns**\n\n- ([::Google::Cloud::DiscoveryEngine::V1beta::Chunk::PageSpan](./Google-Cloud-DiscoveryEngine-V1beta-Chunk-PageSpan)) --- Page span of the chunk.\n\n### #page_span=\n\n def page_span=(value) -\u003e ::Google::Cloud::DiscoveryEngine::V1beta::Chunk::PageSpan\n\n**Parameter**\n\n- **value** ([::Google::Cloud::DiscoveryEngine::V1beta::Chunk::PageSpan](./Google-Cloud-DiscoveryEngine-V1beta-Chunk-PageSpan)) --- Page span of the chunk. \n**Returns**\n\n- ([::Google::Cloud::DiscoveryEngine::V1beta::Chunk::PageSpan](./Google-Cloud-DiscoveryEngine-V1beta-Chunk-PageSpan)) --- Page span of the chunk.\n\n### #relevance_score\n\n def relevance_score() -\u003e ::Float\n\n**Returns**\n\n- (::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\\]\\[\\]."]]
