Class: Google::Cloud::DiscoveryEngine::V1::Chunk

Inherits:
Object
  • Object
show all
Extended by:
Protobuf::MessageExts::ClassMethods
Includes:
Protobuf::MessageExts
Defined in:
proto_docs/google/cloud/discoveryengine/v1/chunk.rb

Overview

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

Defined Under Namespace

Modules: StructureType Classes: AnnotationMetadata, ChunkMetadata, DocumentMetadata, PageSpan, StructuredContent

Instance Attribute Summary collapse

Instance Attribute Details

#annotation_contents ⇒ ::Array<::String> (readonly)

Returns Output only. Annotation contents if the current chunk contains annotations.

Returns:

  • (::Array<::String>) —

    Output only. Annotation contents if the current chunk contains annotations.



74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
 
# File 'proto_docs/google/cloud/discoveryengine/v1/chunk.rb', line 74

class Chunk
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods

  # Document metadata contains the information of the document of the current
  # chunk.
  # @!attribute [rw] uri
  #   @return [::String]
  #     Uri of the document.
  # @!attribute [rw] title
  #   @return [::String]
  #     Title of the document.
  # @!attribute [rw] struct_data
  #   @return [::Google::Protobuf::Struct]
  #     Data representation.
  #     The structured JSON data for the document. It should conform to the
  #     registered {::Google::Cloud::DiscoveryEngine::V1::Schema Schema} or an
  #     `INVALID_ARGUMENT` error is thrown.
  class DocumentMetadata
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # Page span of the chunk.
  # @!attribute [rw] page_start
  #   @return [::Integer]
  #     The start page of the chunk.
  # @!attribute [rw] page_end
  #   @return [::Integer]
  #     The end page of the chunk.
  class PageSpan
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # Metadata of the current chunk. This field is only populated on
  # {::Google::Cloud::DiscoveryEngine::V1::SearchService::Client#search SearchService.Search}
  # API.
  # @!attribute [rw] previous_chunks
  #   @return [::Array<::Google::Cloud::DiscoveryEngine::V1::Chunk>]
  #     The previous chunks of the current chunk. The number is controlled by
  #     {::Google::Cloud::DiscoveryEngine::V1::SearchRequest::ContentSearchSpec::ChunkSpec#num_previous_chunks SearchRequest.ContentSearchSpec.ChunkSpec.num_previous_chunks}.
  #     This field is only populated on
  #     {::Google::Cloud::DiscoveryEngine::V1::SearchService::Client#search SearchService.Search}
  #     API.
  # @!attribute [rw] next_chunks
  #   @return [::Array<::Google::Cloud::DiscoveryEngine::V1::Chunk>]
  #     The next chunks of the current chunk. The number is controlled by
  #     {::Google::Cloud::DiscoveryEngine::V1::SearchRequest::ContentSearchSpec::ChunkSpec#num_next_chunks SearchRequest.ContentSearchSpec.ChunkSpec.num_next_chunks}.
  #     This field is only populated on
  #     {::Google::Cloud::DiscoveryEngine::V1::SearchService::Client#search SearchService.Search}
  #     API.
  class ChunkMetadata
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # The structured content information.
  # @!attribute [r] structure_type
  #   @return [::Google::Cloud::DiscoveryEngine::V1::Chunk::StructureType]
  #     Output only. The structure type of the structured content.
  # @!attribute [r] content
  #   @return [::String]
  #     Output only. The content of the structured content.
  class StructuredContent
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # The annotation metadata includes structured content in the current chunk.
  # @!attribute [r] structured_content
  #   @return [::Google::Cloud::DiscoveryEngine::V1::Chunk::StructuredContent]
  #     Output only. The structured content information.
  # @!attribute [r] image_id
  #   @return [::String]
  #     Output only. Image id is provided if the structured content is based on
  #     an image.
  class AnnotationMetadata
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # Defines the types of the structured content that can be extracted.
  module StructureType
    # Default value.
    STRUCTURE_TYPE_UNSPECIFIED = 0

    # Shareholder structure.
    SHAREHOLDER_STRUCTURE = 1

    # Signature structure.
    SIGNATURE_STRUCTURE = 2

    # Checkbox structure.
    CHECKBOX_STRUCTURE = 3
  end
end

#annotation_metadata ⇒ ::Array<::Google::Cloud::DiscoveryEngine::V1::Chunk::AnnotationMetadata> (readonly)

Returns Output only. The annotation metadata includes structured content in the current chunk.

Returns:



74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
 
# File 'proto_docs/google/cloud/discoveryengine/v1/chunk.rb', line 74

class Chunk
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods

  # Document metadata contains the information of the document of the current
  # chunk.
  # @!attribute [rw] uri
  #   @return [::String]
  #     Uri of the document.
  # @!attribute [rw] title
  #   @return [::String]
  #     Title of the document.
  # @!attribute [rw] struct_data
  #   @return [::Google::Protobuf::Struct]
  #     Data representation.
  #     The structured JSON data for the document. It should conform to the
  #     registered {::Google::Cloud::DiscoveryEngine::V1::Schema Schema} or an
  #     `INVALID_ARGUMENT` error is thrown.
  class DocumentMetadata
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # Page span of the chunk.
  # @!attribute [rw] page_start
  #   @return [::Integer]
  #     The start page of the chunk.
  # @!attribute [rw] page_end
  #   @return [::Integer]
  #     The end page of the chunk.
  class PageSpan
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # Metadata of the current chunk. This field is only populated on
  # {::Google::Cloud::DiscoveryEngine::V1::SearchService::Client#search SearchService.Search}
  # API.
  # @!attribute [rw] previous_chunks
  #   @return [::Array<::Google::Cloud::DiscoveryEngine::V1::Chunk>]
  #     The previous chunks of the current chunk. The number is controlled by
  #     {::Google::Cloud::DiscoveryEngine::V1::SearchRequest::ContentSearchSpec::ChunkSpec#num_previous_chunks SearchRequest.ContentSearchSpec.ChunkSpec.num_previous_chunks}.
  #     This field is only populated on
  #     {::Google::Cloud::DiscoveryEngine::V1::SearchService::Client#search SearchService.Search}
  #     API.
  # @!attribute [rw] next_chunks
  #   @return [::Array<::Google::Cloud::DiscoveryEngine::V1::Chunk>]
  #     The next chunks of the current chunk. The number is controlled by
  #     {::Google::Cloud::DiscoveryEngine::V1::SearchRequest::ContentSearchSpec::ChunkSpec#num_next_chunks SearchRequest.ContentSearchSpec.ChunkSpec.num_next_chunks}.
  #     This field is only populated on
  #     {::Google::Cloud::DiscoveryEngine::V1::SearchService::Client#search SearchService.Search}
  #     API.
  class ChunkMetadata
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # The structured content information.
  # @!attribute [r] structure_type
  #   @return [::Google::Cloud::DiscoveryEngine::V1::Chunk::StructureType]
  #     Output only. The structure type of the structured content.
  # @!attribute [r] content
  #   @return [::String]
  #     Output only. The content of the structured content.
  class StructuredContent
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # The annotation metadata includes structured content in the current chunk.
  # @!attribute [r] structured_content
  #   @return [::Google::Cloud::DiscoveryEngine::V1::Chunk::StructuredContent]
  #     Output only. The structured content information.
  # @!attribute [r] image_id
  #   @return [::String]
  #     Output only. Image id is provided if the structured content is based on
  #     an image.
  class AnnotationMetadata
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # Defines the types of the structured content that can be extracted.
  module StructureType
    # Default value.
    STRUCTURE_TYPE_UNSPECIFIED = 0

    # Shareholder structure.
    SHAREHOLDER_STRUCTURE = 1

    # Signature structure.
    SIGNATURE_STRUCTURE = 2

    # Checkbox structure.
    CHECKBOX_STRUCTURE = 3
  end
end

#chunk_metadata ⇒ ::Google::Cloud::DiscoveryEngine::V1::Chunk::ChunkMetadata (readonly)

Returns Output only. Metadata of the current chunk.

Returns:



74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
 
# File 'proto_docs/google/cloud/discoveryengine/v1/chunk.rb', line 74

class Chunk
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods

  # Document metadata contains the information of the document of the current
  # chunk.
  # @!attribute [rw] uri
  #   @return [::String]
  #     Uri of the document.
  # @!attribute [rw] title
  #   @return [::String]
  #     Title of the document.
  # @!attribute [rw] struct_data
  #   @return [::Google::Protobuf::Struct]
  #     Data representation.
  #     The structured JSON data for the document. It should conform to the
  #     registered {::Google::Cloud::DiscoveryEngine::V1::Schema Schema} or an
  #     `INVALID_ARGUMENT` error is thrown.
  class DocumentMetadata
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # Page span of the chunk.
  # @!attribute [rw] page_start
  #   @return [::Integer]
  #     The start page of the chunk.
  # @!attribute [rw] page_end
  #   @return [::Integer]
  #     The end page of the chunk.
  class PageSpan
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # Metadata of the current chunk. This field is only populated on
  # {::Google::Cloud::DiscoveryEngine::V1::SearchService::Client#search SearchService.Search}
  # API.
  # @!attribute [rw] previous_chunks
  #   @return [::Array<::Google::Cloud::DiscoveryEngine::V1::Chunk>]
  #     The previous chunks of the current chunk. The number is controlled by
  #     {::Google::Cloud::DiscoveryEngine::V1::SearchRequest::ContentSearchSpec::ChunkSpec#num_previous_chunks SearchRequest.ContentSearchSpec.ChunkSpec.num_previous_chunks}.
  #     This field is only populated on
  #     {::Google::Cloud::DiscoveryEngine::V1::SearchService::Client#search SearchService.Search}
  #     API.
  # @!attribute [rw] next_chunks
  #   @return [::Array<::Google::Cloud::DiscoveryEngine::V1::Chunk>]
  #     The next chunks of the current chunk. The number is controlled by
  #     {::Google::Cloud::DiscoveryEngine::V1::SearchRequest::ContentSearchSpec::ChunkSpec#num_next_chunks SearchRequest.ContentSearchSpec.ChunkSpec.num_next_chunks}.
  #     This field is only populated on
  #     {::Google::Cloud::DiscoveryEngine::V1::SearchService::Client#search SearchService.Search}
  #     API.
  class ChunkMetadata
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # The structured content information.
  # @!attribute [r] structure_type
  #   @return [::Google::Cloud::DiscoveryEngine::V1::Chunk::StructureType]
  #     Output only. The structure type of the structured content.
  # @!attribute [r] content
  #   @return [::String]
  #     Output only. The content of the structured content.
  class StructuredContent
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # The annotation metadata includes structured content in the current chunk.
  # @!attribute [r] structured_content
  #   @return [::Google::Cloud::DiscoveryEngine::V1::Chunk::StructuredContent]
  #     Output only. The structured content information.
  # @!attribute [r] image_id
  #   @return [::String]
  #     Output only. Image id is provided if the structured content is based on
  #     an image.
  class AnnotationMetadata
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # Defines the types of the structured content that can be extracted.
  module StructureType
    # Default value.
    STRUCTURE_TYPE_UNSPECIFIED = 0

    # Shareholder structure.
    SHAREHOLDER_STRUCTURE = 1

    # Signature structure.
    SIGNATURE_STRUCTURE = 2

    # Checkbox structure.
    CHECKBOX_STRUCTURE = 3
  end
end

#content ⇒ ::String

Returns Content is a string from a document (parsed content).

Returns:

  • (::String) —

    Content is a string from a document (parsed content).



74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
 
# File 'proto_docs/google/cloud/discoveryengine/v1/chunk.rb', line 74

class Chunk
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods

  # Document metadata contains the information of the document of the current
  # chunk.
  # @!attribute [rw] uri
  #   @return [::String]
  #     Uri of the document.
  # @!attribute [rw] title
  #   @return [::String]
  #     Title of the document.
  # @!attribute [rw] struct_data
  #   @return [::Google::Protobuf::Struct]
  #     Data representation.
  #     The structured JSON data for the document. It should conform to the
  #     registered {::Google::Cloud::DiscoveryEngine::V1::Schema Schema} or an
  #     `INVALID_ARGUMENT` error is thrown.
  class DocumentMetadata
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # Page span of the chunk.
  # @!attribute [rw] page_start
  #   @return [::Integer]
  #     The start page of the chunk.
  # @!attribute [rw] page_end
  #   @return [::Integer]
  #     The end page of the chunk.
  class PageSpan
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # Metadata of the current chunk. This field is only populated on
  # {::Google::Cloud::DiscoveryEngine::V1::SearchService::Client#search SearchService.Search}
  # API.
  # @!attribute [rw] previous_chunks
  #   @return [::Array<::Google::Cloud::DiscoveryEngine::V1::Chunk>]
  #     The previous chunks of the current chunk. The number is controlled by
  #     {::Google::Cloud::DiscoveryEngine::V1::SearchRequest::ContentSearchSpec::ChunkSpec#num_previous_chunks SearchRequest.ContentSearchSpec.ChunkSpec.num_previous_chunks}.
  #     This field is only populated on
  #     {::Google::Cloud::DiscoveryEngine::V1::SearchService::Client#search SearchService.Search}
  #     API.
  # @!attribute [rw] next_chunks
  #   @return [::Array<::Google::Cloud::DiscoveryEngine::V1::Chunk>]
  #     The next chunks of the current chunk. The number is controlled by
  #     {::Google::Cloud::DiscoveryEngine::V1::SearchRequest::ContentSearchSpec::ChunkSpec#num_next_chunks SearchRequest.ContentSearchSpec.ChunkSpec.num_next_chunks}.
  #     This field is only populated on
  #     {::Google::Cloud::DiscoveryEngine::V1::SearchService::Client#search SearchService.Search}
  #     API.
  class ChunkMetadata
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # The structured content information.
  # @!attribute [r] structure_type
  #   @return [::Google::Cloud::DiscoveryEngine::V1::Chunk::StructureType]
  #     Output only. The structure type of the structured content.
  # @!attribute [r] content
  #   @return [::String]
  #     Output only. The content of the structured content.
  class StructuredContent
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # The annotation metadata includes structured content in the current chunk.
  # @!attribute [r] structured_content
  #   @return [::Google::Cloud::DiscoveryEngine::V1::Chunk::StructuredContent]
  #     Output only. The structured content information.
  # @!attribute [r] image_id
  #   @return [::String]
  #     Output only. Image id is provided if the structured content is based on
  #     an image.
  class AnnotationMetadata
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # Defines the types of the structured content that can be extracted.
  module StructureType
    # Default value.
    STRUCTURE_TYPE_UNSPECIFIED = 0

    # Shareholder structure.
    SHAREHOLDER_STRUCTURE = 1

    # Signature structure.
    SIGNATURE_STRUCTURE = 2

    # Checkbox structure.
    CHECKBOX_STRUCTURE = 3
  end
end

#data_urls ⇒ ::Array<::String> (readonly)

Returns Output only. Image Data URLs if the current chunk contains images. Data URLs are composed of four parts: a prefix (data:), a MIME type indicating the type of data, an optional base64 token if non-textual, and the data itself: data:[][;base64],.

Returns:

  • (::Array<::String>) —

    Output only. Image Data URLs if the current chunk contains images. Data URLs are composed of four parts: a prefix (data:), a MIME type indicating the type of data, an optional base64 token if non-textual, and the data itself: data:[][;base64],



74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
 
# File 'proto_docs/google/cloud/discoveryengine/v1/chunk.rb', line 74

class Chunk
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods

  # Document metadata contains the information of the document of the current
  # chunk.
  # @!attribute [rw] uri
  #   @return [::String]
  #     Uri of the document.
  # @!attribute [rw] title
  #   @return [::String]
  #     Title of the document.
  # @!attribute [rw] struct_data
  #   @return [::Google::Protobuf::Struct]
  #     Data representation.
  #     The structured JSON data for the document. It should conform to the
  #     registered {::Google::Cloud::DiscoveryEngine::V1::Schema Schema} or an
  #     `INVALID_ARGUMENT` error is thrown.
  class DocumentMetadata
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # Page span of the chunk.
  # @!attribute [rw] page_start
  #   @return [::Integer]
  #     The start page of the chunk.
  # @!attribute [rw] page_end
  #   @return [::Integer]
  #     The end page of the chunk.
  class PageSpan
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # Metadata of the current chunk. This field is only populated on
  # {::Google::Cloud::DiscoveryEngine::V1::SearchService::Client#search SearchService.Search}
  # API.
  # @!attribute [rw] previous_chunks
  #   @return [::Array<::Google::Cloud::DiscoveryEngine::V1::Chunk>]
  #     The previous chunks of the current chunk. The number is controlled by
  #     {::Google::Cloud::DiscoveryEngine::V1::SearchRequest::ContentSearchSpec::ChunkSpec#num_previous_chunks SearchRequest.ContentSearchSpec.ChunkSpec.num_previous_chunks}.
  #     This field is only populated on
  #     {::Google::Cloud::DiscoveryEngine::V1::SearchService::Client#search SearchService.Search}
  #     API.
  # @!attribute [rw] next_chunks
  #   @return [::Array<::Google::Cloud::DiscoveryEngine::V1::Chunk>]
  #     The next chunks of the current chunk. The number is controlled by
  #     {::Google::Cloud::DiscoveryEngine::V1::SearchRequest::ContentSearchSpec::ChunkSpec#num_next_chunks SearchRequest.ContentSearchSpec.ChunkSpec.num_next_chunks}.
  #     This field is only populated on
  #     {::Google::Cloud::DiscoveryEngine::V1::SearchService::Client#search SearchService.Search}
  #     API.
  class ChunkMetadata
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # The structured content information.
  # @!attribute [r] structure_type
  #   @return [::Google::Cloud::DiscoveryEngine::V1::Chunk::StructureType]
  #     Output only. The structure type of the structured content.
  # @!attribute [r] content
  #   @return [::String]
  #     Output only. The content of the structured content.
  class StructuredContent
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # The annotation metadata includes structured content in the current chunk.
  # @!attribute [r] structured_content
  #   @return [::Google::Cloud::DiscoveryEngine::V1::Chunk::StructuredContent]
  #     Output only. The structured content information.
  # @!attribute [r] image_id
  #   @return [::String]
  #     Output only. Image id is provided if the structured content is based on
  #     an image.
  class AnnotationMetadata
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # Defines the types of the structured content that can be extracted.
  module StructureType
    # Default value.
    STRUCTURE_TYPE_UNSPECIFIED = 0

    # Shareholder structure.
    SHAREHOLDER_STRUCTURE = 1

    # Signature structure.
    SIGNATURE_STRUCTURE = 2

    # Checkbox structure.
    CHECKBOX_STRUCTURE = 3
  end
end

#derived_struct_data ⇒ ::Google::Protobuf::Struct (readonly)

Returns Output only. This field is OUTPUT_ONLY. It contains derived data that are not in the original input document.

Returns:

  • (::Google::Protobuf::Struct) —

    Output only. This field is OUTPUT_ONLY. It contains derived data that are not in the original input document.



74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
 
# File 'proto_docs/google/cloud/discoveryengine/v1/chunk.rb', line 74

class Chunk
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods

  # Document metadata contains the information of the document of the current
  # chunk.
  # @!attribute [rw] uri
  #   @return [::String]
  #     Uri of the document.
  # @!attribute [rw] title
  #   @return [::String]
  #     Title of the document.
  # @!attribute [rw] struct_data
  #   @return [::Google::Protobuf::Struct]
  #     Data representation.
  #     The structured JSON data for the document. It should conform to the
  #     registered {::Google::Cloud::DiscoveryEngine::V1::Schema Schema} or an
  #     `INVALID_ARGUMENT` error is thrown.
  class DocumentMetadata
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # Page span of the chunk.
  # @!attribute [rw] page_start
  #   @return [::Integer]
  #     The start page of the chunk.
  # @!attribute [rw] page_end
  #   @return [::Integer]
  #     The end page of the chunk.
  class PageSpan
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # Metadata of the current chunk. This field is only populated on
  # {::Google::Cloud::DiscoveryEngine::V1::SearchService::Client#search SearchService.Search}
  # API.
  # @!attribute [rw] previous_chunks
  #   @return [::Array<::Google::Cloud::DiscoveryEngine::V1::Chunk>]
  #     The previous chunks of the current chunk. The number is controlled by
  #     {::Google::Cloud::DiscoveryEngine::V1::SearchRequest::ContentSearchSpec::ChunkSpec#num_previous_chunks SearchRequest.ContentSearchSpec.ChunkSpec.num_previous_chunks}.
  #     This field is only populated on
  #     {::Google::Cloud::DiscoveryEngine::V1::SearchService::Client#search SearchService.Search}
  #     API.
  # @!attribute [rw] next_chunks
  #   @return [::Array<::Google::Cloud::DiscoveryEngine::V1::Chunk>]
  #     The next chunks of the current chunk. The number is controlled by
  #     {::Google::Cloud::DiscoveryEngine::V1::SearchRequest::ContentSearchSpec::ChunkSpec#num_next_chunks SearchRequest.ContentSearchSpec.ChunkSpec.num_next_chunks}.
  #     This field is only populated on
  #     {::Google::Cloud::DiscoveryEngine::V1::SearchService::Client#search SearchService.Search}
  #     API.
  class ChunkMetadata
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # The structured content information.
  # @!attribute [r] structure_type
  #   @return [::Google::Cloud::DiscoveryEngine::V1::Chunk::StructureType]
  #     Output only. The structure type of the structured content.
  # @!attribute [r] content
  #   @return [::String]
  #     Output only. The content of the structured content.
  class StructuredContent
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # The annotation metadata includes structured content in the current chunk.
  # @!attribute [r] structured_content
  #   @return [::Google::Cloud::DiscoveryEngine::V1::Chunk::StructuredContent]
  #     Output only. The structured content information.
  # @!attribute [r] image_id
  #   @return [::String]
  #     Output only. Image id is provided if the structured content is based on
  #     an image.
  class AnnotationMetadata
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # Defines the types of the structured content that can be extracted.
  module StructureType
    # Default value.
    STRUCTURE_TYPE_UNSPECIFIED = 0

    # Shareholder structure.
    SHAREHOLDER_STRUCTURE = 1

    # Signature structure.
    SIGNATURE_STRUCTURE = 2

    # Checkbox structure.
    CHECKBOX_STRUCTURE = 3
  end
end

#document_metadata ⇒ ::Google::Cloud::DiscoveryEngine::V1::Chunk::DocumentMetadata

Returns Metadata of the document from the current chunk.

Returns:



74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
 
# File 'proto_docs/google/cloud/discoveryengine/v1/chunk.rb', line 74

class Chunk
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods

  # Document metadata contains the information of the document of the current
  # chunk.
  # @!attribute [rw] uri
  #   @return [::String]
  #     Uri of the document.
  # @!attribute [rw] title
  #   @return [::String]
  #     Title of the document.
  # @!attribute [rw] struct_data
  #   @return [::Google::Protobuf::Struct]
  #     Data representation.
  #     The structured JSON data for the document. It should conform to the
  #     registered {::Google::Cloud::DiscoveryEngine::V1::Schema Schema} or an
  #     `INVALID_ARGUMENT` error is thrown.
  class DocumentMetadata
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # Page span of the chunk.
  # @!attribute [rw] page_start
  #   @return [::Integer]
  #     The start page of the chunk.
  # @!attribute [rw] page_end
  #   @return [::Integer]
  #     The end page of the chunk.
  class PageSpan
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # Metadata of the current chunk. This field is only populated on
  # {::Google::Cloud::DiscoveryEngine::V1::SearchService::Client#search SearchService.Search}
  # API.
  # @!attribute [rw] previous_chunks
  #   @return [::Array<::Google::Cloud::DiscoveryEngine::V1::Chunk>]
  #     The previous chunks of the current chunk. The number is controlled by
  #     {::Google::Cloud::DiscoveryEngine::V1::SearchRequest::ContentSearchSpec::ChunkSpec#num_previous_chunks SearchRequest.ContentSearchSpec.ChunkSpec.num_previous_chunks}.
  #     This field is only populated on
  #     {::Google::Cloud::DiscoveryEngine::V1::SearchService::Client#search SearchService.Search}
  #     API.
  # @!attribute [rw] next_chunks
  #   @return [::Array<::Google::Cloud::DiscoveryEngine::V1::Chunk>]
  #     The next chunks of the current chunk. The number is controlled by
  #     {::Google::Cloud::DiscoveryEngine::V1::SearchRequest::ContentSearchSpec::ChunkSpec#num_next_chunks SearchRequest.ContentSearchSpec.ChunkSpec.num_next_chunks}.
  #     This field is only populated on
  #     {::Google::Cloud::DiscoveryEngine::V1::SearchService::Client#search SearchService.Search}
  #     API.
  class ChunkMetadata
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # The structured content information.
  # @!attribute [r] structure_type
  #   @return [::Google::Cloud::DiscoveryEngine::V1::Chunk::StructureType]
  #     Output only. The structure type of the structured content.
  # @!attribute [r] content
  #   @return [::String]
  #     Output only. The content of the structured content.
  class StructuredContent
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # The annotation metadata includes structured content in the current chunk.
  # @!attribute [r] structured_content
  #   @return [::Google::Cloud::DiscoveryEngine::V1::Chunk::StructuredContent]
  #     Output only. The structured content information.
  # @!attribute [r] image_id
  #   @return [::String]
  #     Output only. Image id is provided if the structured content is based on
  #     an image.
  class AnnotationMetadata
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # Defines the types of the structured content that can be extracted.
  module StructureType
    # Default value.
    STRUCTURE_TYPE_UNSPECIFIED = 0

    # Shareholder structure.
    SHAREHOLDER_STRUCTURE = 1

    # Signature structure.
    SIGNATURE_STRUCTURE = 2

    # Checkbox structure.
    CHECKBOX_STRUCTURE = 3
  end
end

#id ⇒ ::String

Returns Unique chunk ID of the current chunk.

Returns:

  • (::String) —

    Unique chunk ID of the current chunk.



74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
 
# File 'proto_docs/google/cloud/discoveryengine/v1/chunk.rb', line 74

class Chunk
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods

  # Document metadata contains the information of the document of the current
  # chunk.
  # @!attribute [rw] uri
  #   @return [::String]
  #     Uri of the document.
  # @!attribute [rw] title
  #   @return [::String]
  #     Title of the document.
  # @!attribute [rw] struct_data
  #   @return [::Google::Protobuf::Struct]
  #     Data representation.
  #     The structured JSON data for the document. It should conform to the
  #     registered {::Google::Cloud::DiscoveryEngine::V1::Schema Schema} or an
  #     `INVALID_ARGUMENT` error is thrown.
  class DocumentMetadata
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # Page span of the chunk.
  # @!attribute [rw] page_start
  #   @return [::Integer]
  #     The start page of the chunk.
  # @!attribute [rw] page_end
  #   @return [::Integer]
  #     The end page of the chunk.
  class PageSpan
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # Metadata of the current chunk. This field is only populated on
  # {::Google::Cloud::DiscoveryEngine::V1::SearchService::Client#search SearchService.Search}
  # API.
  # @!attribute [rw] previous_chunks
  #   @return [::Array<::Google::Cloud::DiscoveryEngine::V1::Chunk>]
  #     The previous chunks of the current chunk. The number is controlled by
  #     {::Google::Cloud::DiscoveryEngine::V1::SearchRequest::ContentSearchSpec::ChunkSpec#num_previous_chunks SearchRequest.ContentSearchSpec.ChunkSpec.num_previous_chunks}.
  #     This field is only populated on
  #     {::Google::Cloud::DiscoveryEngine::V1::SearchService::Client#search SearchService.Search}
  #     API.
  # @!attribute [rw] next_chunks
  #   @return [::Array<::Google::Cloud::DiscoveryEngine::V1::Chunk>]
  #     The next chunks of the current chunk. The number is controlled by
  #     {::Google::Cloud::DiscoveryEngine::V1::SearchRequest::ContentSearchSpec::ChunkSpec#num_next_chunks SearchRequest.ContentSearchSpec.ChunkSpec.num_next_chunks}.
  #     This field is only populated on
  #     {::Google::Cloud::DiscoveryEngine::V1::SearchService::Client#search SearchService.Search}
  #     API.
  class ChunkMetadata
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # The structured content information.
  # @!attribute [r] structure_type
  #   @return [::Google::Cloud::DiscoveryEngine::V1::Chunk::StructureType]
  #     Output only. The structure type of the structured content.
  # @!attribute [r] content
  #   @return [::String]
  #     Output only. The content of the structured content.
  class StructuredContent
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # The annotation metadata includes structured content in the current chunk.
  # @!attribute [r] structured_content
  #   @return [::Google::Cloud::DiscoveryEngine::V1::Chunk::StructuredContent]
  #     Output only. The structured content information.
  # @!attribute [r] image_id
  #   @return [::String]
  #     Output only. Image id is provided if the structured content is based on
  #     an image.
  class AnnotationMetadata
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # Defines the types of the structured content that can be extracted.
  module StructureType
    # Default value.
    STRUCTURE_TYPE_UNSPECIFIED = 0

    # Shareholder structure.
    SHAREHOLDER_STRUCTURE = 1

    # Signature structure.
    SIGNATURE_STRUCTURE = 2

    # Checkbox structure.
    CHECKBOX_STRUCTURE = 3
  end
end

#name ⇒ ::String

Returns 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.



74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
 
# File 'proto_docs/google/cloud/discoveryengine/v1/chunk.rb', line 74

class Chunk
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods

  # Document metadata contains the information of the document of the current
  # chunk.
  # @!attribute [rw] uri
  #   @return [::String]
  #     Uri of the document.
  # @!attribute [rw] title
  #   @return [::String]
  #     Title of the document.
  # @!attribute [rw] struct_data
  #   @return [::Google::Protobuf::Struct]
  #     Data representation.
  #     The structured JSON data for the document. It should conform to the
  #     registered {::Google::Cloud::DiscoveryEngine::V1::Schema Schema} or an
  #     `INVALID_ARGUMENT` error is thrown.
  class DocumentMetadata
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # Page span of the chunk.
  # @!attribute [rw] page_start
  #   @return [::Integer]
  #     The start page of the chunk.
  # @!attribute [rw] page_end
  #   @return [::Integer]
  #     The end page of the chunk.
  class PageSpan
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # Metadata of the current chunk. This field is only populated on
  # {::Google::Cloud::DiscoveryEngine::V1::SearchService::Client#search SearchService.Search}
  # API.
  # @!attribute [rw] previous_chunks
  #   @return [::Array<::Google::Cloud::DiscoveryEngine::V1::Chunk>]
  #     The previous chunks of the current chunk. The number is controlled by
  #     {::Google::Cloud::DiscoveryEngine::V1::SearchRequest::ContentSearchSpec::ChunkSpec#num_previous_chunks SearchRequest.ContentSearchSpec.ChunkSpec.num_previous_chunks}.
  #     This field is only populated on
  #     {::Google::Cloud::DiscoveryEngine::V1::SearchService::Client#search SearchService.Search}
  #     API.
  # @!attribute [rw] next_chunks
  #   @return [::Array<::Google::Cloud::DiscoveryEngine::V1::Chunk>]
  #     The next chunks of the current chunk. The number is controlled by
  #     {::Google::Cloud::DiscoveryEngine::V1::SearchRequest::ContentSearchSpec::ChunkSpec#num_next_chunks SearchRequest.ContentSearchSpec.ChunkSpec.num_next_chunks}.
  #     This field is only populated on
  #     {::Google::Cloud::DiscoveryEngine::V1::SearchService::Client#search SearchService.Search}
  #     API.
  class ChunkMetadata
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # The structured content information.
  # @!attribute [r] structure_type
  #   @return [::Google::Cloud::DiscoveryEngine::V1::Chunk::StructureType]
  #     Output only. The structure type of the structured content.
  # @!attribute [r] content
  #   @return [::String]
  #     Output only. The content of the structured content.
  class StructuredContent
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # The annotation metadata includes structured content in the current chunk.
  # @!attribute [r] structured_content
  #   @return [::Google::Cloud::DiscoveryEngine::V1::Chunk::StructuredContent]
  #     Output only. The structured content information.
  # @!attribute [r] image_id
  #   @return [::String]
  #     Output only. Image id is provided if the structured content is based on
  #     an image.
  class AnnotationMetadata
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # Defines the types of the structured content that can be extracted.
  module StructureType
    # Default value.
    STRUCTURE_TYPE_UNSPECIFIED = 0

    # Shareholder structure.
    SHAREHOLDER_STRUCTURE = 1

    # Signature structure.
    SIGNATURE_STRUCTURE = 2

    # Checkbox structure.
    CHECKBOX_STRUCTURE = 3
  end
end

#page_span ⇒ ::Google::Cloud::DiscoveryEngine::V1::Chunk::PageSpan

Returns Page span of the chunk.

Returns:



74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
 
# File 'proto_docs/google/cloud/discoveryengine/v1/chunk.rb', line 74

class Chunk
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods

  # Document metadata contains the information of the document of the current
  # chunk.
  # @!attribute [rw] uri
  #   @return [::String]
  #     Uri of the document.
  # @!attribute [rw] title
  #   @return [::String]
  #     Title of the document.
  # @!attribute [rw] struct_data
  #   @return [::Google::Protobuf::Struct]
  #     Data representation.
  #     The structured JSON data for the document. It should conform to the
  #     registered {::Google::Cloud::DiscoveryEngine::V1::Schema Schema} or an
  #     `INVALID_ARGUMENT` error is thrown.
  class DocumentMetadata
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # Page span of the chunk.
  # @!attribute [rw] page_start
  #   @return [::Integer]
  #     The start page of the chunk.
  # @!attribute [rw] page_end
  #   @return [::Integer]
  #     The end page of the chunk.
  class PageSpan
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # Metadata of the current chunk. This field is only populated on
  # {::Google::Cloud::DiscoveryEngine::V1::SearchService::Client#search SearchService.Search}
  # API.
  # @!attribute [rw] previous_chunks
  #   @return [::Array<::Google::Cloud::DiscoveryEngine::V1::Chunk>]
  #     The previous chunks of the current chunk. The number is controlled by
  #     {::Google::Cloud::DiscoveryEngine::V1::SearchRequest::ContentSearchSpec::ChunkSpec#num_previous_chunks SearchRequest.ContentSearchSpec.ChunkSpec.num_previous_chunks}.
  #     This field is only populated on
  #     {::Google::Cloud::DiscoveryEngine::V1::SearchService::Client#search SearchService.Search}
  #     API.
  # @!attribute [rw] next_chunks
  #   @return [::Array<::Google::Cloud::DiscoveryEngine::V1::Chunk>]
  #     The next chunks of the current chunk. The number is controlled by
  #     {::Google::Cloud::DiscoveryEngine::V1::SearchRequest::ContentSearchSpec::ChunkSpec#num_next_chunks SearchRequest.ContentSearchSpec.ChunkSpec.num_next_chunks}.
  #     This field is only populated on
  #     {::Google::Cloud::DiscoveryEngine::V1::SearchService::Client#search SearchService.Search}
  #     API.
  class ChunkMetadata
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # The structured content information.
  # @!attribute [r] structure_type
  #   @return [::Google::Cloud::DiscoveryEngine::V1::Chunk::StructureType]
  #     Output only. The structure type of the structured content.
  # @!attribute [r] content
  #   @return [::String]
  #     Output only. The content of the structured content.
  class StructuredContent
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # The annotation metadata includes structured content in the current chunk.
  # @!attribute [r] structured_content
  #   @return [::Google::Cloud::DiscoveryEngine::V1::Chunk::StructuredContent]
  #     Output only. The structured content information.
  # @!attribute [r] image_id
  #   @return [::String]
  #     Output only. Image id is provided if the structured content is based on
  #     an image.
  class AnnotationMetadata
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # Defines the types of the structured content that can be extracted.
  module StructureType
    # Default value.
    STRUCTURE_TYPE_UNSPECIFIED = 0

    # Shareholder structure.
    SHAREHOLDER_STRUCTURE = 1

    # Signature structure.
    SIGNATURE_STRUCTURE = 2

    # Checkbox structure.
    CHECKBOX_STRUCTURE = 3
  end
end

#relevance_score ⇒ ::Float (readonly)

Returns 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 SearchResponse.

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 SearchResponse.



74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
 
# File 'proto_docs/google/cloud/discoveryengine/v1/chunk.rb', line 74

class Chunk
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods

  # Document metadata contains the information of the document of the current
  # chunk.
  # @!attribute [rw] uri
  #   @return [::String]
  #     Uri of the document.
  # @!attribute [rw] title
  #   @return [::String]
  #     Title of the document.
  # @!attribute [rw] struct_data
  #   @return [::Google::Protobuf::Struct]
  #     Data representation.
  #     The structured JSON data for the document. It should conform to the
  #     registered {::Google::Cloud::DiscoveryEngine::V1::Schema Schema} or an
  #     `INVALID_ARGUMENT` error is thrown.
  class DocumentMetadata
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # Page span of the chunk.
  # @!attribute [rw] page_start
  #   @return [::Integer]
  #     The start page of the chunk.
  # @!attribute [rw] page_end
  #   @return [::Integer]
  #     The end page of the chunk.
  class PageSpan
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # Metadata of the current chunk. This field is only populated on
  # {::Google::Cloud::DiscoveryEngine::V1::SearchService::Client#search SearchService.Search}
  # API.
  # @!attribute [rw] previous_chunks
  #   @return [::Array<::Google::Cloud::DiscoveryEngine::V1::Chunk>]
  #     The previous chunks of the current chunk. The number is controlled by
  #     {::Google::Cloud::DiscoveryEngine::V1::SearchRequest::ContentSearchSpec::ChunkSpec#num_previous_chunks SearchRequest.ContentSearchSpec.ChunkSpec.num_previous_chunks}.
  #     This field is only populated on
  #     {::Google::Cloud::DiscoveryEngine::V1::SearchService::Client#search SearchService.Search}
  #     API.
  # @!attribute [rw] next_chunks
  #   @return [::Array<::Google::Cloud::DiscoveryEngine::V1::Chunk>]
  #     The next chunks of the current chunk. The number is controlled by
  #     {::Google::Cloud::DiscoveryEngine::V1::SearchRequest::ContentSearchSpec::ChunkSpec#num_next_chunks SearchRequest.ContentSearchSpec.ChunkSpec.num_next_chunks}.
  #     This field is only populated on
  #     {::Google::Cloud::DiscoveryEngine::V1::SearchService::Client#search SearchService.Search}
  #     API.
  class ChunkMetadata
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # The structured content information.
  # @!attribute [r] structure_type
  #   @return [::Google::Cloud::DiscoveryEngine::V1::Chunk::StructureType]
  #     Output only. The structure type of the structured content.
  # @!attribute [r] content
  #   @return [::String]
  #     Output only. The content of the structured content.
  class StructuredContent
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # The annotation metadata includes structured content in the current chunk.
  # @!attribute [r] structured_content
  #   @return [::Google::Cloud::DiscoveryEngine::V1::Chunk::StructuredContent]
  #     Output only. The structured content information.
  # @!attribute [r] image_id
  #   @return [::String]
  #     Output only. Image id is provided if the structured content is based on
  #     an image.
  class AnnotationMetadata
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # Defines the types of the structured content that can be extracted.
  module StructureType
    # Default value.
    STRUCTURE_TYPE_UNSPECIFIED = 0

    # Shareholder structure.
    SHAREHOLDER_STRUCTURE = 1

    # Signature structure.
    SIGNATURE_STRUCTURE = 2

    # Checkbox structure.
    CHECKBOX_STRUCTURE = 3
  end
end