Reference documentation and code samples for the Document AI V1beta3 API class Google::Cloud::DocumentAI::V1beta3::Document::ShardInfo.
For a large document, sharding may be performed to produce several
document shards. Each document shard contains this field to detail which
shard it is.
Inherits
Object
Extended By
Google::Protobuf::MessageExts::ClassMethods
Includes
Google::Protobuf::MessageExts
Methods
#shard_count
defshard_count()->::Integer
Returns
(::Integer) — Total number of shards.
#shard_count=
defshard_count=(value)->::Integer
Parameter
value (::Integer) — Total number of shards.
Returns
(::Integer) — Total number of shards.
#shard_index
defshard_index()->::Integer
Returns
(::Integer) — The 0-based index of this shard.
#shard_index=
defshard_index=(value)->::Integer
Parameter
value (::Integer) — The 0-based index of this shard.
Returns
(::Integer) — The 0-based index of this shard.
#text_offset
deftext_offset()->::Integer
Returns
(::Integer) — The index of the first character in
Document.text in the
overall document global text.
#text_offset=
deftext_offset=(value)->::Integer
Parameter
value (::Integer) — The index of the first character in
Document.text in the
overall document global text.
Returns
(::Integer) — The index of the first character in
Document.text in the
overall document global text.
[[["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,["# Document AI V1beta3 API - Class Google::Cloud::DocumentAI::V1beta3::Document::ShardInfo (v0.43.1)\n\nVersion latestkeyboard_arrow_down\n\n- [0.43.1 (latest)](/ruby/docs/reference/google-cloud-document_ai-v1beta3/latest/Google-Cloud-DocumentAI-V1beta3-Document-ShardInfo)\n- [0.43.0](/ruby/docs/reference/google-cloud-document_ai-v1beta3/0.43.0/Google-Cloud-DocumentAI-V1beta3-Document-ShardInfo)\n- [0.42.0](/ruby/docs/reference/google-cloud-document_ai-v1beta3/0.42.0/Google-Cloud-DocumentAI-V1beta3-Document-ShardInfo)\n- [0.41.0](/ruby/docs/reference/google-cloud-document_ai-v1beta3/0.41.0/Google-Cloud-DocumentAI-V1beta3-Document-ShardInfo)\n- [0.40.0](/ruby/docs/reference/google-cloud-document_ai-v1beta3/0.40.0/Google-Cloud-DocumentAI-V1beta3-Document-ShardInfo)\n- [0.39.1](/ruby/docs/reference/google-cloud-document_ai-v1beta3/0.39.1/Google-Cloud-DocumentAI-V1beta3-Document-ShardInfo)\n- [0.38.0](/ruby/docs/reference/google-cloud-document_ai-v1beta3/0.38.0/Google-Cloud-DocumentAI-V1beta3-Document-ShardInfo)\n- [0.37.0](/ruby/docs/reference/google-cloud-document_ai-v1beta3/0.37.0/Google-Cloud-DocumentAI-V1beta3-Document-ShardInfo)\n- [0.36.1](/ruby/docs/reference/google-cloud-document_ai-v1beta3/0.36.1/Google-Cloud-DocumentAI-V1beta3-Document-ShardInfo)\n- [0.35.0](/ruby/docs/reference/google-cloud-document_ai-v1beta3/0.35.0/Google-Cloud-DocumentAI-V1beta3-Document-ShardInfo)\n- [0.34.0](/ruby/docs/reference/google-cloud-document_ai-v1beta3/0.34.0/Google-Cloud-DocumentAI-V1beta3-Document-ShardInfo)\n- [0.33.1](/ruby/docs/reference/google-cloud-document_ai-v1beta3/0.33.1/Google-Cloud-DocumentAI-V1beta3-Document-ShardInfo)\n- [0.32.0](/ruby/docs/reference/google-cloud-document_ai-v1beta3/0.32.0/Google-Cloud-DocumentAI-V1beta3-Document-ShardInfo)\n- [0.31.0](/ruby/docs/reference/google-cloud-document_ai-v1beta3/0.31.0/Google-Cloud-DocumentAI-V1beta3-Document-ShardInfo)\n- [0.30.2](/ruby/docs/reference/google-cloud-document_ai-v1beta3/0.30.2/Google-Cloud-DocumentAI-V1beta3-Document-ShardInfo)\n- [0.29.0](/ruby/docs/reference/google-cloud-document_ai-v1beta3/0.29.0/Google-Cloud-DocumentAI-V1beta3-Document-ShardInfo)\n- [0.28.0](/ruby/docs/reference/google-cloud-document_ai-v1beta3/0.28.0/Google-Cloud-DocumentAI-V1beta3-Document-ShardInfo)\n- [0.27.0](/ruby/docs/reference/google-cloud-document_ai-v1beta3/0.27.0/Google-Cloud-DocumentAI-V1beta3-Document-ShardInfo)\n- [0.26.0](/ruby/docs/reference/google-cloud-document_ai-v1beta3/0.26.0/Google-Cloud-DocumentAI-V1beta3-Document-ShardInfo)\n- [0.25.0](/ruby/docs/reference/google-cloud-document_ai-v1beta3/0.25.0/Google-Cloud-DocumentAI-V1beta3-Document-ShardInfo)\n- [0.24.0](/ruby/docs/reference/google-cloud-document_ai-v1beta3/0.24.0/Google-Cloud-DocumentAI-V1beta3-Document-ShardInfo)\n- [0.23.0](/ruby/docs/reference/google-cloud-document_ai-v1beta3/0.23.0/Google-Cloud-DocumentAI-V1beta3-Document-ShardInfo)\n- [0.22.0](/ruby/docs/reference/google-cloud-document_ai-v1beta3/0.22.0/Google-Cloud-DocumentAI-V1beta3-Document-ShardInfo)\n- [0.21.0](/ruby/docs/reference/google-cloud-document_ai-v1beta3/0.21.0/Google-Cloud-DocumentAI-V1beta3-Document-ShardInfo)\n- [0.20.0](/ruby/docs/reference/google-cloud-document_ai-v1beta3/0.20.0/Google-Cloud-DocumentAI-V1beta3-Document-ShardInfo)\n- [0.19.0](/ruby/docs/reference/google-cloud-document_ai-v1beta3/0.19.0/Google-Cloud-DocumentAI-V1beta3-Document-ShardInfo)\n- [0.18.0](/ruby/docs/reference/google-cloud-document_ai-v1beta3/0.18.0/Google-Cloud-DocumentAI-V1beta3-Document-ShardInfo)\n- [0.17.0](/ruby/docs/reference/google-cloud-document_ai-v1beta3/0.17.0/Google-Cloud-DocumentAI-V1beta3-Document-ShardInfo)\n- [0.16.0](/ruby/docs/reference/google-cloud-document_ai-v1beta3/0.16.0/Google-Cloud-DocumentAI-V1beta3-Document-ShardInfo)\n- [0.15.0](/ruby/docs/reference/google-cloud-document_ai-v1beta3/0.15.0/Google-Cloud-DocumentAI-V1beta3-Document-ShardInfo)\n- [0.14.0](/ruby/docs/reference/google-cloud-document_ai-v1beta3/0.14.0/Google-Cloud-DocumentAI-V1beta3-Document-ShardInfo)\n- [0.13.0](/ruby/docs/reference/google-cloud-document_ai-v1beta3/0.13.0/Google-Cloud-DocumentAI-V1beta3-Document-ShardInfo)\n- [0.12.0](/ruby/docs/reference/google-cloud-document_ai-v1beta3/0.12.0/Google-Cloud-DocumentAI-V1beta3-Document-ShardInfo)\n- [0.11.0](/ruby/docs/reference/google-cloud-document_ai-v1beta3/0.11.0/Google-Cloud-DocumentAI-V1beta3-Document-ShardInfo)\n- [0.10.0](/ruby/docs/reference/google-cloud-document_ai-v1beta3/0.10.0/Google-Cloud-DocumentAI-V1beta3-Document-ShardInfo)\n- [0.9.4](/ruby/docs/reference/google-cloud-document_ai-v1beta3/0.9.4/Google-Cloud-DocumentAI-V1beta3-Document-ShardInfo) \nReference documentation and code samples for the Document AI V1beta3 API class Google::Cloud::DocumentAI::V1beta3::Document::ShardInfo.\n\nFor a large document, sharding may be performed to produce several\ndocument shards. Each document shard contains this field to detail which\nshard it is. \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### #shard_count\n\n def shard_count() -\u003e ::Integer\n\n**Returns**\n\n- (::Integer) --- Total number of shards.\n\n### #shard_count=\n\n def shard_count=(value) -\u003e ::Integer\n\n**Parameter**\n\n- **value** (::Integer) --- Total number of shards. \n**Returns**\n\n- (::Integer) --- Total number of shards.\n\n### #shard_index\n\n def shard_index() -\u003e ::Integer\n\n**Returns**\n\n- (::Integer) --- The 0-based index of this shard.\n\n### #shard_index=\n\n def shard_index=(value) -\u003e ::Integer\n\n**Parameter**\n\n- **value** (::Integer) --- The 0-based index of this shard. \n**Returns**\n\n- (::Integer) --- The 0-based index of this shard.\n\n### #text_offset\n\n def text_offset() -\u003e ::Integer\n\n**Returns**\n\n- (::Integer) --- The index of the first character in [Document.text](/ruby/docs/reference/google-cloud-document_ai-v1beta3/latest/Google-Cloud-DocumentAI-V1beta3-Document#Google__Cloud__DocumentAI__V1beta3__Document_text_instance_ \"Google::Cloud::DocumentAI::V1beta3::Document#text (method)\") in the overall document global text.\n\n### #text_offset=\n\n def text_offset=(value) -\u003e ::Integer\n\n**Parameter**\n\n- **value** (::Integer) --- The index of the first character in [Document.text](/ruby/docs/reference/google-cloud-document_ai-v1beta3/latest/Google-Cloud-DocumentAI-V1beta3-Document#Google__Cloud__DocumentAI__V1beta3__Document_text_instance_ \"Google::Cloud::DocumentAI::V1beta3::Document#text (method)\") in the overall document global text. \n**Returns**\n\n- (::Integer) --- The index of the first character in [Document.text](/ruby/docs/reference/google-cloud-document_ai-v1beta3/latest/Google-Cloud-DocumentAI-V1beta3-Document#Google__Cloud__DocumentAI__V1beta3__Document_text_instance_ \"Google::Cloud::DocumentAI::V1beta3::Document#text (method)\") in the overall document global text."]]