2023.1:Key-Value List (Collation Provider) - Revision history

Dgreenwood at 20:42, 27 August 2025

2025-08-27T20:42:07Z

← Older revision		Revision as of 15:42, 27 August 2025
Line 31:		Line 31:
	The "Key" '''Value Reader''' will be used to collect the label or title of the list.		The "Key" '''Value Reader''' will be used to collect the label or title of the list.

	#<li value=2> Set your '''''Extractor''''' property for the Key '''Value Reader'''. In this example we have set it to a [[~~List Match (Extractor Type)\|~~List Match]].		#<li value=2> Set your '''''Extractor''''' property for the Key '''Value Reader'''. In this example we have set it to a [[List Match]].

	[[File:2023.1 Key-Value-List-(Collation-Provider) 02 Key-Value-List-Configuration 02.png]]		[[File:2023.1 Key-Value-List-(Collation-Provider) 02 Key-Value-List-Configuration 02.png]]

Randallkinard: Randallkinard moved page Key-Value List (Collation Provider) to 2023.1:Key-Value List (Collation Provider)

2024-08-28T16:26:16Z

Randallkinard moved page Key-Value List (Collation Provider) to 2023.1:Key-Value List (Collation Provider)

← Older revision	Revision as of 11:26, 28 August 2024
(No difference)

Randallkinard at 15:51, 22 April 2024

2024-04-22T15:51:36Z

← Older revision		Revision as of 10:51, 22 April 2024
Line 1:		Line 1:
	{{AutoVersion}}		{{AutoVersion}}

	<blockquote>		<blockquote>{{#lst:Glossary\|Key-Value List}}</blockquote>
	~~A '''''~~Key-Value List''''' is one of many '''''Collation Providers''''' you can use in Grooper to combine or organize extracted data based on the data's layout relationship. A '''''Key-Value List''''' collects a "list" of information with a spatial relationship to a label or a "Key".
	</blockquote>

	{\|class="download-box"		{\|class="download-box"

Rpatton: final // via Wikitext Extension for VSCode

2024-04-18T18:20:16Z

final // via Wikitext Extension for VSCode

← Older revision		Revision as of 13:20, 18 April 2024
Line 1:		Line 1:
	{{AutoVersion}}		{{AutoVersion}}

	~~{\|class="wip-box"~~
	\|
	~~'''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.~~
	\|}

	<blockquote>		<blockquote>
Line 18:		Line 9:
	[[File:Asset 22@4x.png]]		[[File:Asset 22@4x.png]]
	\|		\|
	You may download the ZIP(s) below and upload it into your own Grooper environment (version 2023). The first contains a '''~~Project~~''' ~~with resources used in examples throughout this article~~. The second contains one or more '''~~Batches~~''' ~~of sample documents~~.		You may download the ZIP(s) below and upload it into your own Grooper environment (version 2023.1). The first contains one or more '''Batches''' of sample documents. The second contains one or more '''Projects''' with resources used in examples throughout this article.
	* [[Media:2023 Wiki Key-Value List ~~Project~~.zip]]		* [[Media:2023.1 Wiki Key-Value-List Batches.zip]]
	* [[Media:2023 Wiki Key-Value List ~~Batches~~.zip]]		* [[Media:2023.1 Wiki Key-Value-List Project.zip]]
	\|}		\|}

	== About ==		== About ==

	The ''Key-Value List'' '''''Collation Provider''''' is designed to collect a list of things that follow a label of some kind. Similar to the [[Key-Value Pair (Collation Provider)\|Key-Value Pair]] '''''Collation Provider''''', it is configured by having a "Key" and a "Value" extracted in a '''Data Type''''s child objects. When collated, the parent '''Data Type''' will first locate the "Key" and then look either vertically or horizontally for a list of text as extracted by the "Value" extractor object. Only the list of terms from the "Value" extractor object will be returned as a result.		The ''Key-Value List'' '''''Collation Provider''''' is designed to collect a list of things that follow a label of some kind. Similar to the [[Key-Value Pair (Collation Provider)\|Key-Value Pair]] '''''Collation Provider''''', it is configured by having a "Key" and a "Value" extracted in a '''Data Type''''s child objects. When collated, the parent '''Data Type''' will first locate the "Key" and then look either vertically or horizontally (based on how you configure its properties) for a list of text as extracted by the "Value" extractor object. Only the list of terms from the "Value" extractor object will be returned as a result.

	The ''Key-Value List'' is also useful in Table Extraction via [[Row Match (Table Extract Method)\|Row Match]] when not every cell in the table contains data.		The ''Key-Value List'' is also useful in Table Extraction via [[Row Match (Table Extract Method)\|Row Match]] when not every cell in the table contains data.

Rpatton: update // via Wikitext Extension for VSCode

2024-04-18T16:09:16Z

update // via Wikitext Extension for VSCode

← Older revision		Revision as of 11:09, 18 April 2024
Line 65:		Line 65:

	[[File:2023.1 Key-Value-List-(Collation-Provider) 02 Key-Value-List-Configuration 05.png]]		[[File:2023.1 Key-Value-List-(Collation-Provider) 02 Key-Value-List-Configuration 05.png]]


	Now we need to go back to the parent object and set the '''''Collation''''' to collect the ''Key-Value List''.		Now we need to go back to the parent object and set the '''''Collation''''' to collect the ''Key-Value List''.
Line 80:		Line 81:

	[[File:2023.1 Key-Value-List-(Collation-Provider) 02 Key-Value-List-Configuration 07.png]]		[[File:2023.1 Key-Value-List-(Collation-Provider) 02 Key-Value-List-Configuration 07.png]]


	=== Key-Value Lists and Data Tables ===		=== Key-Value Lists and Data Tables ===

			There are times when a ''Key-Value List'' can be useful in Table Extraction. In the first example below, we have a table that is being collected using an ''Ordered Array'' '''''Collation Provider''''' (See the [[Ordered Array (Collation Provider)\|Ordered Array]] wiki article for how to extract a table using a ''Row Match'' '''''Extract Method''''' with an ''Ordered Array'').

	# We have created a '''Data Type''' with multiple child extractors to collect information on a table.		# We have created a '''Data Type''' with multiple child extractors to collect information on a table.
Line 91:		Line 94:


	#<li value=4> ~~However, for this~~ table, ~~our current configuration falls short~~.		The first page in our '''Batch''' is being extracted appropriately, however on the second page we run into a problem. The table on the second page does not have data in each of the cells of the table. ''Ordered Array'' does not work well with incomplete data. Using a ''Key-Value List'' on the child extractors with incomplete data can help us overcome this issue.

			#<li value=4> You can see in the table on the page, only three rows are being returned because they are the only rows that have complete data.

	[[File:2023.1 Key-Value-List-(Collation-Provider) 03 Tables 02.png]]		[[File:2023.1 Key-Value-List-(Collation-Provider) 03 Tables 02.png]]


			#<li value=5> Going back to the '''Data Table''' object, we can see that using a ''Row Match'' '''''Extract Method''''' referencing the '''Data Type''' with the ''Ordered Array'' only returns the complete rows on the table.

	[[File:2023.1 Key-Value-List-(Collation-Provider) 03 Tables 03.png]]		[[File:2023.1 Key-Value-List-(Collation-Provider) 03 Tables 03.png]]


			<big>'''Using Key-Value List with Array'''</big>

			# As you can see in the screenshot below, we have made a few changes to the referenced '''Data Type''''s children objects. Now we have added a "Key" and "Value" '''Value Reader''' for each child '''Data Type''' that corresponds to a column with missing data on the page.
			# Each '''Data Type''' with a child "Key" and "Value" '''Value Reader''' has the '''''Collation''''' property configured to a ''Key-Value List''.
			# As we can see in the Document Viewer, for the "Dry Hole" '''Data Type''', now all dollar amounts under the "Dry Hole" label on the page are being returned.

	[[File:2023.1 Key-Value-List-(Collation-Provider) 03 Tables 04.png]]		[[File:2023.1 Key-Value-List-(Collation-Provider) 03 Tables 04.png]]


			#<li value=4> On the parent '''Data Type''' where all the results are collated...
			# ... we still have the '''''Collation''''' property set to ''Ordered Array''.
			# An ''Ordered Array'' will not work because all child objects will need to return a value for ''Ordered Array'' to return the row. Since we have incomplete data in the table, not all rows return.

	[[File:2023.1 Key-Value-List-(Collation-Provider) 03 Tables 05.png]]		[[File:2023.1 Key-Value-List-(Collation-Provider) 03 Tables 05.png]]


			#<li value=7> If we change the '''''Collation''''' property to an ''Array'', then all of our rows are returned because an ''Array'' does not require all child extractors to return a result to collect the row information.

	[[File:2023.1 Key-Value-List-(Collation-Provider) 03 Tables 06.png]]		[[File:2023.1 Key-Value-List-(Collation-Provider) 03 Tables 06.png]]


			<big>'''Testing the Table Extraction'''</big>

			# Click on the '''Data Table''' object.
			# The table is configured for a ''Row Match'' and the '''''Row Extractor''''' is still referencing the same '''Data Type''' (now configured with an ''Array'' instead of an ''Ordered Array'').

	[[File:2023.1 Key-Value-List-(Collation-Provider) 03 Tables 07.png]]		[[File:2023.1 Key-Value-List-(Collation-Provider) 03 Tables 07.png]]


			#<li value=3> If we test the extraction, now we can see that the full table is returned even though some cells are missing data.

	[[File:2023.1 Key-Value-List-(Collation-Provider) 03 Tables 08.png]]		[[File:2023.1 Key-Value-List-(Collation-Provider) 03 Tables 08.png]]

Rpatton: update // via Wikitext Extension for VSCode

2024-04-18T14:24:20Z

update // via Wikitext Extension for VSCode

← Older revision		Revision as of 09:24, 18 April 2024
Line 27:		Line 27:
	The ''Key-Value List'' '''''Collation Provider''''' is designed to collect a list of things that follow a label of some kind. Similar to the [[Key-Value Pair (Collation Provider)\|Key-Value Pair]] '''''Collation Provider''''', it is configured by having a "Key" and a "Value" extracted in a '''Data Type''''s child objects. When collated, the parent '''Data Type''' will first locate the "Key" and then look either vertically or horizontally for a list of text as extracted by the "Value" extractor object. Only the list of terms from the "Value" extractor object will be returned as a result.		The ''Key-Value List'' '''''Collation Provider''''' is designed to collect a list of things that follow a label of some kind. Similar to the [[Key-Value Pair (Collation Provider)\|Key-Value Pair]] '''''Collation Provider''''', it is configured by having a "Key" and a "Value" extracted in a '''Data Type''''s child objects. When collated, the parent '''Data Type''' will first locate the "Key" and then look either vertically or horizontally for a list of text as extracted by the "Value" extractor object. Only the list of terms from the "Value" extractor object will be returned as a result.

	The ''Key-Value List'' is also useful in ~~extracting~~ Table ~~information~~ via [[Row Match (Table Extract Method)\|Row Match]] when not every ~~row~~ contains data.		The ''Key-Value List'' is also useful in Table Extraction via [[Row Match (Table Extract Method)\|Row Match]] when not every cell in the table contains data.

	== How To ==		== How To ==

			Configuring a ''Key-Value List'' involves creating a '''Data Type''' with two child extractors: a Key and a Value. The Key will collect the title or label of your list, while the Value will collect all text segments in your list. Then the ''Key-Value List'' '''''Collation Provider''''' will need to be configured on the '''Data Type''' itself.

			=== Configuring a Key-Value List ===

	# Create a '''Data Type''' with two child '''Value Readers''': one for the Key, and one for the Value.		# Create a '''Data Type''' with two child '''Value Readers''': one for the Key, and one for the Value.
Line 36:		Line 40:


	#<li value=2> Set your '''''Extractor''''' property for the Key '''Value Reader'''. In this example we have set it to a ''List Match''.		The "Key" '''Value Reader''' will be used to collect the label or title of the list.

			#<li value=2> Set your '''''Extractor''''' property for the Key '''Value Reader'''. In this example we have set it to a [[List Match (Extractor Type)\|List Match]].

	[[File:2023.1 Key-Value-List-(Collation-Provider) 02 Key-Value-List-Configuration 02.png]]		[[File:2023.1 Key-Value-List-(Collation-Provider) 02 Key-Value-List-Configuration 02.png]]


	#<li value=3> Configure the extractor to return the label of your list.		On the page there are two lists. We want to collect the list on the right labeled "Cryptids" and not the list on the left labeled "Groceries". For the "Key", we need to collect the label for the list we want to return.

			#<li value=3> Configure the extractor to return the label of your list. In this case we have configured our ''List Match'' to return the word "Cryptids".

	[[File:2023.1 Key-Value-List-(Collation-Provider) 02 Key-Value-List-Configuration 03.png]]		[[File:2023.1 Key-Value-List-(Collation-Provider) 02 Key-Value-List-Configuration 03.png]]


			Now that the "Key" has been configured, we want to set up the "Value" '''Value Reader''' to collect all items in the list.

	#<li value=4> Set your '''''Extractor''''' property for the Value '''Value Reader'''. In this example we have set it to a ''Pattern Match''.		#<li value=4> Set your '''''Extractor''''' property for the Value '''Value Reader'''. In this example we have set it to a ''Pattern Match''.
Line 56:		Line 66:
	[[File:2023.1 Key-Value-List-(Collation-Provider) 02 Key-Value-List-Configuration 05.png]]		[[File:2023.1 Key-Value-List-(Collation-Provider) 02 Key-Value-List-Configuration 05.png]]

			Now we need to go back to the parent object and set the '''''Collation''''' to collect the ''Key-Value List''.

	#<li value=6> Click back on the parent '''Data Type'''.		#<li value=6> Click back on the parent '''Data Type'''.

Rpatton: update // via Wikitext Extension for VSCode

2024-04-17T21:10:49Z

update // via Wikitext Extension for VSCode

← Older revision		Revision as of 16:10, 17 April 2024
Line 25:		Line 25:
	== About ==		== About ==

			The ''Key-Value List'' '''''Collation Provider''''' is designed to collect a list of things that follow a label of some kind. Similar to the [[Key-Value Pair (Collation Provider)\|Key-Value Pair]] '''''Collation Provider''''', it is configured by having a "Key" and a "Value" extracted in a '''Data Type''''s child objects. When collated, the parent '''Data Type''' will first locate the "Key" and then look either vertically or horizontally for a list of text as extracted by the "Value" extractor object. Only the list of terms from the "Value" extractor object will be returned as a result.

			The ''Key-Value List'' is also useful in extracting Table information via [[Row Match (Table Extract Method)\|Row Match]] when not every row contains data.

	== How To ==		== How To ==

Rpatton: update // via Wikitext Extension for VSCode

2024-04-17T19:29:51Z

update // via Wikitext Extension for VSCode

@@ Line 11: / Line 11: @@
 <blockquote>
-A '''''Key-Value List''''' is one of many '''''Collation Providers''''' you can use in Grooper to combine or organize extracted data based on the data's layout relationship.
+A '''''Key-Value List''''' is one of many '''''Collation Providers''''' you can use in Grooper to combine or organize extracted data based on the data's layout relationship. A '''''Key-Value List''''' collects a "list" of information with a spatial relationship to a label or a "Key".
 </blockquote>
@@ Line 24: / Line 24: @@
 == About ==
 == How To ==
@@ Line 48: / Line 50: @@
 #<li value=5> Configure your extractor to return all text you are wanting to collect near your label.
-#* It is fine if the extractor collects mroe than just the terms you want to return. Here we are collecting all generic text on the page.
+#* It is fine if the extractor collects more than just the terms you want to return. Here we are collecting all generic text on the page.
 [[File:2023.1 Key-Value-List-(Collation-Provider) 02 Key-Value-List-Configuration 05.png]]
@@ Line 65: / Line 67: @@
 [[File:2023.1 Key-Value-List-(Collation-Provider) 02 Key-Value-List-Configuration 07.png]]

Rpatton: How To start // via Wikitext Extension for VSCode

2024-04-16T20:51:17Z

How To start // via Wikitext Extension for VSCode

@@ Line 23: / Line 23: @@
 |}
-{{#lst:Grooper Colloquialisms|Glossary}}
+== About ==
-== About ==
+[[File:2023.1 Key-Value-List-(Collation-Provider) 02 Key-Value-List-Configuration 05.png]]

Rpatton: Created page with "{{AutoVersion}} {|class="wip-box" | '''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. |}
A '''''Key-Value List''''' is one of many '''''Collation Providers''''' you can use in Grooper to combine or organize extracted data based on the data's layout relations..."

2024-04-15T18:42:29Z

Created page with "{{AutoVersion}} {|class="wip-box" | '''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. |} <blockquote> A '''''Key-Value List''''' is one of many '''''Collation Providers''''' you can use in Grooper to combine or organize extracted data based on the data's layout relations..."

New page

{{AutoVersion}}

{|class="wip-box"
|
'''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.
|}

<blockquote>
A '''''Key-Value List''''' is one of many '''''Collation Providers''''' you can use in Grooper to combine or organize extracted data based on the data's layout relationship.
</blockquote>

{|class="download-box"
|
[[File:Asset 22@4x.png]]
|
You may download the ZIP(s) below and upload it into your own Grooper environment (version 2023). The first contains a '''Project''' with resources used in examples throughout this article. The second contains one or more '''Batches''' of sample documents.
* [[Media:2023 Wiki Key-Value List Project.zip]]
* [[Media:2023 Wiki Key-Value List Batches.zip]]
|}

{{#lst:Grooper Colloquialisms|Glossary}}

== About ==