Reference documentation and code samples for the Vision AI V1 API class Google::Cloud::VisionAI::V1::Collection.
A collection is a resource in a corpus. It serves as a container of
references to original resources.
Inherits
Object
Extended By
Google::Protobuf::MessageExts::ClassMethods
Includes
Google::Protobuf::MessageExts
Methods
#description
defdescription()->::String
Returns
(::String) — Optional. Description of the collection. Can be up to 25000 characters
long.
#description=
defdescription=(value)->::String
Parameter
value (::String) — Optional. Description of the collection. Can be up to 25000 characters
long.
Returns
(::String) — Optional. Description of the collection. Can be up to 25000 characters
long.
#display_name
defdisplay_name()->::String
Returns
(::String) — Optional. The collection name for displaying.
The name can be up to 256 characters long.
#display_name=
defdisplay_name=(value)->::String
Parameter
value (::String) — Optional. The collection name for displaying.
The name can be up to 256 characters long.
Returns
(::String) — Optional. The collection name for displaying.
The name can be up to 256 characters long.
#name
defname()->::String
Returns
(::String) — Output only. Resource name of the collection. Format:
projects/{project_number}/locations/{location}/corpora/{corpus}/collections/{collection}
[[["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-09 UTC."],[],[],null,["# Vision AI V1 API - Class Google::Cloud::VisionAI::V1::Collection (v1.1.1)\n\nVersion latestkeyboard_arrow_down\n\n- [1.1.1 (latest)](/ruby/docs/reference/google-cloud-vision_ai-v1/latest/Google-Cloud-VisionAI-V1-Collection)\n- [1.1.0](/ruby/docs/reference/google-cloud-vision_ai-v1/1.1.0/Google-Cloud-VisionAI-V1-Collection)\n- [1.0.1](/ruby/docs/reference/google-cloud-vision_ai-v1/1.0.1/Google-Cloud-VisionAI-V1-Collection)\n- [0.4.0](/ruby/docs/reference/google-cloud-vision_ai-v1/0.4.0/Google-Cloud-VisionAI-V1-Collection)\n- [0.3.0](/ruby/docs/reference/google-cloud-vision_ai-v1/0.3.0/Google-Cloud-VisionAI-V1-Collection)\n- [0.2.0](/ruby/docs/reference/google-cloud-vision_ai-v1/0.2.0/Google-Cloud-VisionAI-V1-Collection)\n- [0.1.0](/ruby/docs/reference/google-cloud-vision_ai-v1/0.1.0/Google-Cloud-VisionAI-V1-Collection) \nReference documentation and code samples for the Vision AI V1 API class Google::Cloud::VisionAI::V1::Collection.\n\nA collection is a resource in a corpus. It serves as a container of\nreferences to original resources. \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### #description\n\n def description() -\u003e ::String\n\n**Returns**\n\n- (::String) --- Optional. Description of the collection. Can be up to 25000 characters long.\n\n### #description=\n\n def description=(value) -\u003e ::String\n\n**Parameter**\n\n- **value** (::String) --- Optional. Description of the collection. Can be up to 25000 characters long. \n**Returns**\n\n- (::String) --- Optional. Description of the collection. Can be up to 25000 characters long.\n\n### #display_name\n\n def display_name() -\u003e ::String\n\n**Returns**\n\n- (::String) --- Optional. The collection name for displaying. The name can be up to 256 characters long.\n\n### #display_name=\n\n def display_name=(value) -\u003e ::String\n\n**Parameter**\n\n- **value** (::String) --- Optional. The collection name for displaying. The name can be up to 256 characters long. \n**Returns**\n\n- (::String) --- Optional. The collection name for displaying. The name can be up to 256 characters long.\n\n### #name\n\n def name() -\u003e ::String\n\n**Returns**\n\n- (::String) --- Output only. Resource name of the collection. Format: `projects/{project_number}/locations/{location}/corpora/{corpus}/collections/{collection}`"]]