2.90:Collation Provider (Property) - Revision history

Dgreenwood at 16:17, 5 February 2026

2026-02-05T16:17:17Z

← Older revision		Revision as of 11:17, 5 February 2026
Line 1:		Line 1:
	__NOINDEX__		__NOINDEX__
	~~{{stubs}}~~

	{{AutoVersion}}		{{AutoVersion}}

Dgreenwood at 15:57, 5 August 2025

2025-08-05T15:57:31Z

← Older revision		Revision as of 10:57, 5 August 2025
Line 1:		Line 1:
			__NOINDEX__
	{{stubs}}		{{stubs}}

Randallkinard at 16:01, 22 April 2024

2024-04-22T16:01:52Z

← Older revision		Revision as of 11:01, 22 April 2024
Line 1:		Line 1:
	{{stubs}}		{{stubs}}

	{{AutoVersion}}		{{AutoVersion}}

	<blockquote ~~style="font-size~~:~~14pt">~~		<blockquote>{{#lst:Glossary\|Collation Provider}}</blockquote>
	~~'''''~~Collation ~~Providers''''' allow '''[[Data Type]]''' extractor results to be combined, organized, or utilized in specific ways.~~
	</blockquote>

	Results can be combined, organized into arrays, returned as a key-value pair's value, and more.		Results can be combined, organized into arrays, returned as a key-value pair's value, and more.
Line 22:		Line 21:

	== About ==		== About ==

	'''[[Data Type]]''' extractors in Grooper use regular expression to match a document's text data in order to return a particular piece of information. Extractors serve a variety of purposes. They can be used to populate fields in a [[Data Model]], to separate and classify documents, to break up a document into sections, and more. For the most part, any time part of document's text data is needed or useful to do something, you need an extractor to find and return it.		'''[[Data Type]]''' extractors in Grooper use regular expression to match a document's text data in order to return a particular piece of information. Extractors serve a variety of purposes. They can be used to populate fields in a [[Data Model]], to separate and classify documents, to break up a document into sections, and more. For the most part, any time part of document's text data is needed or useful to do something, you need an extractor to find and return it.

Line 29:		Line 27:
	For example, the ''Individual'', ''Array'', and ''Ordered Array'' Collation Providers all collate results differently.		For example, the ''Individual'', ''Array'', and ''Ordered Array'' Collation Providers all collate results differently.

	~~=== Individual, Array, and Ordered Array ===~~

	~~<tabs style="margin:20px">~~
	~~<tab name="Individual" style="margin:20px">~~
	=== Individual ===		=== Individual ===

	The ''Individual'' Collation Provider returns all extraction results individually. This is the default Collation Provider for '''Data Type''' extractors.		The ''Individual'' Collation Provider returns all extraction results individually. This is the default Collation Provider for '''Data Type''' extractors.

	~~{\|cellpadding=10 cellspacing=5~~
	~~\|style="width:40%" valign=top\|~~
	#This '''Data Type''' extractor, whose results are seen here, has five child extractors, all passing their own results up to the parent extractor. The child extractors are as follows:		#This '''Data Type''' extractor, whose results are seen here, has five child extractors, all passing their own results up to the parent extractor. The child extractors are as follows:
	#* Name - This '''Data Type''' extractor returns names on the document. Here, US presidents.		#* Name - This '''Data Type''' extractor returns names on the document. Here, US presidents.
Line 48:		Line 39:
	#* The '''''Collation''''' property determines the Collation Provider used.		#* The '''''Collation''''' property determines the Collation Provider used.
	# You can see in the "Results" panel, everything each child extractor returns to the parent '''Data Type''' is listed as a distinct, individual result. A total of 56 results with the first item physically on the page listed first.		# You can see in the "Results" panel, everything each child extractor returns to the parent '''Data Type''' is listed as a distinct, individual result. A total of 56 results with the first item physically on the page listed first.
	\|
	[[File:Collation Provider - About 01.png]]		[[File:Collation Provider - About 01.png]]
	\|}
	~~</tab>~~
	~~<tab name="Array" style="margin:20px">~~
	=== Array ===		=== Array ===

	The ''Array'' Collation Provider organizes and returns results much differently.		The ''Array'' Collation Provider organizes and returns results much differently.
	* First, it will only return results if multiple extraction results are lined up in a particular order on the page, according to the "layout" set for this provider. For example, an ''Array'' collated extractor using a '''''Horizontal Layout''''' will only return results if they are aligned horizontally, one result after another from left to right.		* First, it will only return results if multiple extraction results are lined up in a particular order on the page, according to the "layout" set for this provider. For example, an ''Array'' collated extractor using a '''''Horizontal Layout''''' will only return results if they are aligned horizontally, one result after another from left to right.
Line 61:		Line 49:
	Essentially, an ''Array'' collated result is a collection of results who share a layout relationship, that are all lined up together (either horizontally, vertically, or in the left/right and top/bottom text flow of the document).		Essentially, an ''Array'' collated result is a collection of results who share a layout relationship, that are all lined up together (either horizontally, vertically, or in the left/right and top/bottom text flow of the document).

	~~{\|cellpadding=10 cellspacing=5~~
	~~\|style="width:40%" valign=top\|~~
	# This '''Data Type''' extractor has the exact same child extractors, but uses the ''Array'' Collation Provider instead of ''Individual''.		# This '''Data Type''' extractor has the exact same child extractors, but uses the ''Array'' Collation Provider instead of ''Individual''.
	# The parent '''Data Type's''' '''''Collation''''' property is set to ''Array''.		# The parent '''Data Type's''' '''''Collation''''' property is set to ''Array''.
Line 71:		Line 57:
	# Notice we now only return 12 results. Rather than each individual result from each child extractor, results are ordered and returned according to the ''Array'' Collation Provider and its configuration.		# Notice we now only return 12 results. Rather than each individual result from each child extractor, results are ordered and returned according to the ''Array'' Collation Provider and its configuration.
	#* Results are combined into a single result, as long as they are aligned horizontally with each other.		#* Results are combined into a single result, as long as they are aligned horizontally with each other.
	\|
	[[File:Collation Provider - About 02.png]]		[[File:Collation Provider - About 02.png]]
	\|}
	~~</tab>~~
	~~<tab name="Ordered Array" style="margin:20px">~~
	=== Ordered Array ===		=== Ordered Array ===

	The ''Ordered Array'' Collation Provider is similar to the ''Array'' provider, but it is much more restrictive about how allowable results can be organized. ''Only'' arrays whose extracted elements are in the listed order of the children extractors are returned.		The ''Ordered Array'' Collation Provider is similar to the ''Array'' provider, but it is much more restrictive about how allowable results can be organized. ''Only'' arrays whose extracted elements are in the listed order of the children extractors are returned.

	~~{\|cellpadding=10 cellspacing=5~~
	~~\|style="width:40%" valign=top\|~~
	# This '''Data Type''' extractor has the exact same child extractors, but uses the ''Ordered Array'' Collation Provider.		# This '''Data Type''' extractor has the exact same child extractors, but uses the ''Ordered Array'' Collation Provider.
	#* Notice the order of each child extractor. First "Name" then "Date" then "City/State" then "Number of Days" and last, "Party"		#* Notice the order of each child extractor. First "Name" then "Date" then "City/State" then "Number of Days" and last, "Party"
Line 89:		Line 70:
	#* The second table has the "Days in Office" column ''before'' the "Birthplace". When it came time to finding that array, all the elements are there, but they are not in the order of the child elements in the Node Tree. The "Number of Days" extractor comes ''after'' the "City/State" extractor.		#* The second table has the "Days in Office" column ''before'' the "Birthplace". When it came time to finding that array, all the elements are there, but they are not in the order of the child elements in the Node Tree. The "Number of Days" extractor comes ''after'' the "City/State" extractor.
	#* The third table has four out of the five elements present, and in the right order, but is missing the "Political Party" column (picked up by the "Party" extractor). Not only must the array's extracted elements match the order of the child extractors locating them, but ''all'' elements must be present.		#* The third table has four out of the five elements present, and in the right order, but is missing the "Political Party" column (picked up by the "Party" extractor). Not only must the array's extracted elements match the order of the child extractors locating them, but ''all'' elements must be present.
	\|
	[[File:Collation Provider - About 03.png]]		[[File:Collation Provider - About 03.png]]
	~~</tab>~~
	~~</tabs>~~

	=== Key-Value Pair and Key-Value List ===		=== Key-Value Pair and Key-Value List ===
Line 105:		Line 84:

	=== Multi-Column ===		=== Multi-Column ===

	~~== Version Differences ==~~

	=== The AND Collation Provider ===		=== The AND Collation Provider ===

	The ''AND'' Collation Provider is a brand new provider in version 2.90. Aspects of this collation could have been approximated using the ''Combine'' or ''Array'' providers, in some cases. However, it's functionality is unique and distinct from these two Collation Providers.		The ''AND'' Collation Provider is a brand new provider in version 2.90. Aspects of this collation could have been approximated using the ''Combine'' or ''Array'' providers, in some cases. However, it's functionality is unique and distinct from these two Collation Providers.

	=== Confidence Mode ===		=== Confidence Mode ===

	The '''''Confidence Mode''''' property is new to the ''Combine'', ''AND'', ''Array'', ''Ordered Array'', ''Key-Value Pair'' and ''Key-Value List'' Collation Providers in version 2.90. Each of these providers orders and/or combines multiple extraction results in various ways. If any of results are matched using ''FuzzyRegEx'', the overall confidence score of the collated result must be determined, in some way, based on the confidence of each individual result.		The '''''Confidence Mode''''' property is new to the ''Combine'', ''AND'', ''Array'', ''Ordered Array'', ''Key-Value Pair'' and ''Key-Value List'' Collation Providers in version 2.90. Each of these providers orders and/or combines multiple extraction results in various ways. If any of results are matched using ''FuzzyRegEx'', the overall confidence score of the collated result must be determined, in some way, based on the confidence of each individual result.

Randallkinard: Randallkinard moved page 2.90:Collation Provider to 2.90:Collation Provider (Property) without leaving a redirect: new naming convention

2024-04-18T19:38:40Z

Randallkinard moved page 2.90:Collation Provider to 2.90:Collation Provider (Property) without leaving a redirect: new naming convention

← Older revision	Revision as of 14:38, 18 April 2024
(No difference)

Dgreenwood at 18:59, 28 December 2023

2023-12-28T18:59:54Z

← Older revision		Revision as of 13:59, 28 December 2023
Line 1:		Line 1:
	{~~\|cellpadding=10 cellspacing=5 style="margin:12px"~~		{{stubs}}
	~~\|-style="background-color:#ed2330; color:white"~~		{{AutoVersion}}
	~~\|style="font-size:14pt"\|'''WIP'''~~
	\|
	~~This article is a work-in-progress or created as a placeholder for testing purposes. This article is subject to change and/or expansion. It may be incomplete, inaccurate, or stop abruptly.~~

	~~This tag will be removed upon draft completion.~~
	\|}

	~~<onlyinclude>~~
	<blockquote style="font-size:14pt">		<blockquote style="font-size:14pt">
	'''''Collation Providers''''' allow '''[[Data Type]]''' extractor results to be combined, organized, or utilized in specific ways.		'''''Collation Providers''''' allow '''[[Data Type]]''' extractor results to be combined, organized, or utilized in specific ways.
Line 27:		Line 20:
	* Pattern-Based		* Pattern-Based
	* Multi-Column		* Multi-Column
	~~</onlyinclude>~~

	== About ==		== About ==
Line 127:		Line 119:

	Previously, the collated result would always take the average of the individual results's confidence scores. The '''''Confidence Mode''''' property allows you to choose ''Average'' to take the average confidence score of the individual results, ''Min'' to take the smallest confidence score of all the individual results, or ''Max'' to take the largest confidence score.		Previously, the collated result would always take the average of the individual results's confidence scores. The '''''Confidence Mode''''' property allows you to choose ''Average'' to take the average confidence score of the individual results, ''Min'' to take the smallest confidence score of all the individual results, or ''Max'' to take the largest confidence score.

	~~[[Category:Articles]]~~
	~~[[Category:Stub]]~~

Dgreenwood: Dgreenwood moved page Collation Provider to 2.90:Collation Provider

2023-12-28T18:59:21Z

Dgreenwood moved page Collation Provider to 2.90:Collation Provider

← Older revision	Revision as of 13:59, 28 December 2023
(No difference)

Rpatton at 15:21, 27 January 2023

2023-01-27T15:21:19Z

← Older revision		Revision as of 10:21, 27 January 2023
Line 1:		Line 1:
			{\|cellpadding=10 cellspacing=5 style="margin:12px"
			\|-style="background-color:#ed2330; color:white"
			\|style="font-size:14pt"\|'''WIP'''
			\|
			This article is a work-in-progress or created as a placeholder for testing purposes. This article is subject to change and/or expansion. It may be incomplete, inaccurate, or stop abruptly.

			This tag will be removed upon draft completion.
			\|}

	<onlyinclude>		<onlyinclude>
	<blockquote style="font-size:14pt">		<blockquote style="font-size:14pt">

Dgreenwood at 18:17, 9 December 2022

2022-12-09T18:17:05Z

← Older revision		Revision as of 13:17, 9 December 2022
Line 118:		Line 118:

	Previously, the collated result would always take the average of the individual results's confidence scores. The '''''Confidence Mode''''' property allows you to choose ''Average'' to take the average confidence score of the individual results, ''Min'' to take the smallest confidence score of all the individual results, or ''Max'' to take the largest confidence score.		Previously, the collated result would always take the average of the individual results's confidence scores. The '''''Confidence Mode''''' property allows you to choose ''Average'' to take the average confidence score of the individual results, ''Min'' to take the smallest confidence score of all the individual results, or ''Max'' to take the largest confidence score.

			[[Category:Articles]]
			[[Category:Stub]]

Dgreenwood at 16:00, 23 November 2020

2020-11-23T16:00:28Z

← Older revision		Revision as of 11:00, 23 November 2020
Line 6:		Line 6:
	Results can be combined, organized into arrays, returned as a key-value pair's value, and more.		Results can be combined, organized into arrays, returned as a key-value pair's value, and more.

	The following ''''Collation Providers'''' are available in Grooper:		The following '''''Collation Providers''''' are available in Grooper:

	* Individual		* Individual

Dgreenwood at 16:00, 23 November 2020

2020-11-23T16:00:17Z

← Older revision		Revision as of 11:00, 23 November 2020
Line 1:		Line 1:
			<onlyinclude>
	<blockquote style="font-size:14pt">		<blockquote style="font-size:14pt">
	Collation Providers allow '''[[Data Type]]''' extractor results to be combined, organized, or utilized in specific ways.		'''''Collation Providers''''' allow '''[[Data Type]]''' extractor results to be combined, organized, or utilized in specific ways.
	</blockquote>		</blockquote>

	Results can be combined, ~~made~~ into arrays, returned as a key-value pair's value, and more.		Results can be combined, organized into arrays, returned as a key-value pair's value, and more.

	The following Collation Providers are available in Grooper:		The following ''''Collation Providers'''' are available in Grooper:

	* Individual		* Individual
Line 17:		Line 18:
	* Pattern-Based		* Pattern-Based
	* Multi-Column		* Multi-Column
			</onlyinclude>

	== About ==		== About ==