2023:GPT Complete (Value Extractor) - Revision history

Dgreenwood at 21:42, 27 August 2025

2025-08-27T21:42:24Z

← Older revision		Revision as of 16:42, 27 August 2025
Line 1:		Line 1:
			__NOINDEX__
	{{AutoVersion}}		{{AutoVersion}}

Dgreenwood at 21:01, 27 August 2025

2025-08-27T21:01:16Z

← Older revision		Revision as of 16:01, 27 August 2025
Line 13:		Line 13:

	== About ==		== About ==
	''GPT Complete'' is an '''''Extractor ~~Type~~''''' that was added to Grooper 2023. It is the setting you choose to leverage GPT integration on an extractor. Below are some examples of configuration and use. You should be able to follow along using the '''GPT Integration''' zip files ('''Batch''' and '''Project''' are included) that are included in this article. Begin by following along with the instructions. The details of the properties will be explained after.		''GPT Complete'' is a '''''Value Extractor''''' that was added to Grooper 2023. It is the setting you choose to leverage GPT integration on an extractor. Below are some examples of configuration and use. You should be able to follow along using the '''GPT Integration''' zip files ('''Batch''' and '''Project''' are included) that are included in this article. Begin by following along with the instructions. The details of the properties will be explained after.

	It is also worth noting that the examples given below ARE NOT a comprehensive list. Provided are only a few examples of prompts used in extraction to get you thinking about what can be done. It is ''highly'' recommended that you not only reference the materials linked above, but also spend time experimenting and testing. Good luck!		It is also worth noting that the examples given below ARE NOT a comprehensive list. Provided are only a few examples of prompts used in extraction to get you thinking about what can be done. It is ''highly'' recommended that you not only reference the materials linked above, but also spend time experimenting and testing. Good luck!

	=== Extractor ~~Type~~ Properties ===		=== Extractor Properties ===
	Before moving on to seeing how the GPT model is used for classification in '''Grooper''' let's take a look at the properties used in the ''GPT Complete'' extractor ~~type~~.		Before moving on to seeing how the GPT model is used for classification in '''Grooper''' let's take a look at the properties used in the ''GPT Complete'' extractor.

	[[image:2023_GPT-Complete-(Extractor-Type)_01_01.png]]		[[image:2023_GPT-Complete-(Extractor-Type)_01_01.png]]

Dgreenwood: Dgreenwood moved page 2023:GPT Complete (Extractor Type) to 2023:GPT Complete (Value Extractor)

2025-08-27T19:47:57Z

Dgreenwood moved page 2023:GPT Complete (Extractor Type) to 2023:GPT Complete (Value Extractor)

← Older revision	Revision as of 14:47, 27 August 2025
(No difference)

Dgreenwood at 13:34, 27 August 2025

2025-08-27T13:34:00Z

← Older revision		Revision as of 08:34, 27 August 2025
Line 38:		Line 38:

	==== Preprocessing ====		==== Preprocessing ====
	Please visit the ~~'''''~~[[~~Preprocessing (Property)\|Preprocessing~~]]~~'''''~~ article for more information.		Please visit the [[Text Preprocessor]] article for more information.

	==== Overflow Disposition ====		==== Overflow Disposition ====

Randallkinard: /* Preprocessing */

2024-07-24T16:23:51Z

Preprocessing

← Older revision		Revision as of 11:23, 24 July 2024
Line 38:		Line 38:

	==== Preprocessing ====		==== Preprocessing ====
	~~To put simply, these tools were provided to allow~~ the ~~insertion~~ (~~or deletion~~) ~~of control characters to give textual context to~~ information that would otherwise be spatial. GPT does not have an awareness of the location of text you feed it. As a person you can look at a table of information and understand it visually. GPT cannot. However, if you were to have control characters like tabs or paragraph markings, it increases the chance that GPT might understand those things.		Please visit the '''''[[Preprocessing (Property)\|Preprocessing]]''''' article for more information.

	==== Overflow Disposition ====		==== Overflow Disposition ====

Randallkinard: /* Parameters */

2024-07-23T17:40:24Z

Parameters

@@ Line 29: / Line 29: @@
 ==== Parameters ====
-===== Temperature =====
+Please see the [[Parameters (Property)|Parameters]] article for more information.
 ==== Timeout ====

Randallkinard at 22:05, 24 April 2024

2024-04-24T22:05:51Z

← Older revision		Revision as of 17:05, 24 April 2024
Line 1:		Line 1:
	{{AutoVersion}}		{{AutoVersion}}

			<blockquote>{{#lst:Glossary\|GPT Complete}}</blockquote>

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

Randallkinard: Created page with "{{AutoVersion}} {|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 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_GPT-Integration_Batch.zip * Media:2023_Wiki_GPT-Integration_Project.zip |} == About == ''GPT Complete'' is an..."

2024-04-24T17:23:54Z

Created page with "{{AutoVersion}} {|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 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_GPT-Integration_Batch.zip * Media:2023_Wiki_GPT-Integration_Project.zip |} == About == ''GPT Complete'' is an..."

New page

{{AutoVersion}}

{|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 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_GPT-Integration_Batch.zip]]
* [[Media:2023_Wiki_GPT-Integration_Project.zip]]
|}

== About ==
''GPT Complete'' is an '''''Extractor Type''''' that was added to Grooper 2023. It is the setting you choose to leverage GPT integration on an extractor. Below are some examples of configuration and use. You should be able to follow along using the '''GPT Integration''' zip files ('''Batch''' and '''Project''' are included) that are included in this article. Begin by following along with the instructions. The details of the properties will be explained after.

It is also worth noting that the examples given below ARE NOT a comprehensive list. Provided are only a few examples of prompts used in extraction to get you thinking about what can be done. It is ''highly'' recommended that you not only reference the materials linked above, but also spend time experimenting and testing. Good luck!

=== Extractor Type Properties ===
Before moving on to seeing how the GPT model is used for classification in '''Grooper''' let's take a look at the properties used in the ''GPT Complete'' extractor type.

[[image:2023_GPT-Complete-(Extractor-Type)_01_01.png]]

==== API Key ====
You must fill this property with a valid API key from OpenAI in order to leverage GPT integration with Grooper. See the '''[[GPT Integration (Concept)#Obtain an API Key|Obtain an API Key]]''' section of the [[GPT Integration (Concept)|GPT Integration]] article for instruction on how to get a key.

==== Model ====
The API Key you use will determine which GPT models are available to you. The different GPT models can affect the text generated based on their size, training data, capabilities, prompt engineering, and fine-tuning potential. GPT-3's larger size and training data, in particular, can potentially result in more sophisticated, diverse, and contextually appropriate text compared to GPT-2. However, the actual performance and quality of the generated text also depend on various other factors, such as prompt engineering, input provided, and specific use case requirements. GPT-4 is the latest version, as of this writing, and takes the GPT model even further.

==== Parameters ====
===== Temperature =====
In the context of text generation using language models like ChatGPT, the temperature parameter is a setting that controls the randomness or randomness of the generated text. It is used during the sampling process, where the model selects the next word or token to generate based on its predicted probabilities.

When generating text, the language model assigns probabilities to different words or tokens based on their likelihood of occurring next in the context of the input text. The temperature parameter is used to scale these probabilities before sampling from them. A higher temperature value (e.g., 1.0) makes the probabilities more uniform and increases randomness, resulting in more varied and diverse text. On the other hand, a lower temperature value (e.g., 0.2) makes the probabilities more concentrated and biased towards the most likely word, resulting in more deterministic and focused text.

For example, with a higher temperature setting, the model may generate sentences like:
: ''"The weather is hot and sunny. I love to go swimming or hiking."''

With a lower temperature setting, the model may generate sentences like:
: ''"The weather is hot. I love to go swimming."''

The choice of temperature parameter depends on the desired output. Higher values are useful when you want more creativity and diversity in the generated text, but it may lead to less coherent or nonsensical sentences. Lower values are useful when you want more deterministic and focused text, but it may result in repetitive or overly conservative output. It's a hyperparameter that can be tuned to achieve the desired balance between randomness and coherence in the generated text.

===== TopP =====
TopP, also known as "nucleus sampling" or "stochastic decoding with dynamic vocabulary," is a text generation technique that is used to improve the diversity and randomness of generated text. It is often used as an alternative to traditional approaches like random sampling or greedy decoding in language models, such as GPT-2 and GPT-3.

In TopP sampling, instead of sampling from the entire probability distribution of possible next words or tokens, the model narrows down the choices to a subset of the most likely options. The subset is determined dynamically based on a predefined probability threshold, denoted as "p". The model considers only the words or tokens whose cumulative probability mass (probability of occurrence) falls within the top "p" value. The remaining words or tokens with lower probabilities are pruned from the selection.

Mathematically, given a probability distribution over all possible words or tokens, TopP sampling works as follows:

# Compute the cumulative distribution function (CDF) of the probabilities for the given distribution.
# Sort the probabilities in descending order and calculate the cumulative sum of probabilities from highest to lowest.
# Stop when the cumulative sum exceeds the threshold "p". So 0.1 means only the tokens comprising the top 10% probability mass are considered.
# The remaining set of words or tokens whose probabilities fall within the threshold "p" is considered for sampling.
By using TopP sampling, the model can generate text that is more diverse, as it allows for the possibility of selecting less frequent or rarer words or tokens, and it introduces randomness in the selection process. It can prevent the model from becoming overly deterministic or repetitive in its generated output, leading to more creative and varied text generation results.

===== Presence Penalty =====
The "presence penalty" is a technique used in text generation to encourage the model to generate more concise and focused outputs by penalizing the repetition of the same words or tokens in the generated text. It is a regularization technique that aims to reduce redundancy and promote diversity in the generated output.

The presence penalty is typically implemented as an additional term in the loss function during the training process of a language model. This term penalizes the model for generating the same words or tokens multiple times within a short span of text. The presence penalty can be formulated in different ways, depending on the specific model architecture and objectives, but the general idea is to assign a higher loss or penalty when the model generates repetitive or redundant text.

The presence penalty encourages the model to generate text that is more concise, avoids repetitive patterns, and promotes the use of a wider vocabulary. It helps prevent the model from generating overly verbose or redundant text, which can be undesirable in certain text generation tasks, such as story generation or summarization.

The magnitude of the presence penalty can be tuned to control the level of repetition allowed in the generated text. A higher penalty value would result in stricter avoidance of repetition, while a lower penalty value would allow for more repetition. The presence penalty is one of the techniques that can be used in combination with other regularization methods, such as temperature scaling, top-k sampling, or fine-tuning, to improve the quality and diversity of generated text.

===== Frequency Penalty =====
Frequency-based regularization techniques in text generation can refer to methods that aim to control the distribution of word or token frequencies in the generated text. This can be achieved by adding penalties or constraints to the model during training, such as limiting the occurrence of certain words or tokens, promoting the use of less frequent words or tokens, or controlling the balance of word or token frequencies in the generated text.

==== Timeout ====
The amount of time, in seconds, to wait for a response from the web service before raising a timeout error.

==== Instructions ====
The instructions or question to include in the prompt. The prompt sent to OpenAI consists of text content from the document, which provides context, plus the text entered here. This property should ask a question about the content or provide instructions for generating output. For example, "what is the effective date?", "summarize this document", or "Your task is to generate a comma-separated list of assignors".

==== Preprocessing ====
To put simply, these tools were provided to allow the insertion (or deletion) of control characters to give textual context to information that would otherwise be spatial. GPT does not have an awareness of the location of text you feed it. As a person you can look at a table of information and understand it visually. GPT cannot. However, if you were to have control characters like tabs or paragraph markings, it increases the chance that GPT might understand those things.

==== Overflow Disposition ====
Specifies the behavior when the document content is longer than the context length of the selected model.

May be one of the following:
* ''Truncate'' - The content will be truncated to fit the model's context length.
* ''Split'' - The content will be split into chunks which fit the model's context length. One result will be returned for each chunk.

==== Context Extractor ====
An optional extractor which filters the document content included in the prompt. All '''''Value Extractor''''' types are available.

==== Max Response Length ====
The maximum length of the output, in tokens. 1 token is equivalent to approximately 4 characters for English text. Increasing this value decreases the maximum size of the context.

==== Maximum Content Length ====
The maximum amount of content from the document to be included, in tokens.

== How To ==
# After importing the '''Grooper''' ZIP files provided with this course, expand the Node Tree out and select the '''Data Field''' named "Lessor".
# Click the drop-down menu for the '''''Value Extractor''''' property.
# Select the ''GPT Complete'' option from the menu.

[[Image:GPT Integration 004.png]]

# <li value=4> With the '''''Value Extractor''''' property set, click the ellipsis button to open its configuration window (if you prefer, you can instead click the drop-down arrow to the left of the property to edit its properties without a pop-up window).

[[Image:GPT Integration 005.png]]

# <li value=5> Start by entering your API key into the '''''API Key''''' property.
# Click the "Browse Batches" button.
# Select "GPT Complete Examples" '''Batch''' in the "GPT Integration - Batches" folder from the menu.

[[Image:GPT Integration 006.png]]

# <li value=8> Select "Lease (1)" from the '''Batch Viewer'''.
# Click the ellipsis button for the '''''Instructions''''' property to open its configuration window (if you prefer, you can instead simply type into the entry field of the property.)

[[Image:GPT Integration 007.png]]

# <li value=10> Type the string value <code>Who is the lessor?</code> into the editor.
# Click the "OK" button to accept and close this window.

[[Image:GPT Integration 008.png]]

# <li value=12> When the previous window closes the extractor will immediately fire (assuming you have automatic testing enabled), and you will see a result returned in the "Results" list view.

From a "prompt engineering" perspective the input we gave it is as basic as you can get. A result is returned, which is great, but it may not be the exact result that is desired. The value supplied is very conversational, which isn't necessarily a bad thing and is typical of an AI that's trained to emulate language, but considering how data is typically constructed in '''Grooper''', it's not quite right. If you break it down, the result given is really four values: the lessor's name, their marital status, their gender, and their location. In this case the name of the lessor only will suffice.

The next thing to tackle will be using some prompt engineering to get a more specific result.

[[Image:GPT Integration 009.png]]

==== Getting a More Specific Result with Prompt Engineering ====
# Working with the same material as before, select the '''Data Field''' named "Lessee".
# Click the drop-down menu for the '''''Value Extractor''''' property.
# Select ''GPT Complete'' from the drop-down menu.

[[Image:GPT Integration 010.png]]

# <li value=4> With the '''''Value Extractor''''' set, click the ellipsis button to open its configuration window (if you prefer, you can instead click the drop-down arrow to the left of the property to edit its properties without a pop-up window).

[[Image:GPT Integration 011.png]]

# <li value=5> Start by entering your API key into the '''''API Key''''' property.
# Make sure "Lease (1)" is still selected in the '''Batch Viewer'''.
# Click the ellipsis button for the '''''Instructions''''' property to open its configuration window (if you prefer, you can instead simply type into the entry field of the property.)

[[Image:GPT Integration 012.png]]

# <li value=8> Type the string value <code>Who is the lessee?</code> into the editor.
# Click the "OK" button to accept and close this window.

[[Image:GPT Integration 013.png]]

# <li value=10> When the previous window closes the extractor will immediately fire (assuming you have automatic testing enabled), and you will see a result returned in the "Results" list view.
#* This is clearly a different result form the "Lessor", which is good, but let's address the issue mentioned previously. Let's use some simple "prompt engineer" to get the specific result desired.
# Click the ellipsis button for the '''''Instructions''''' property to open its configuration window (if you prefer, you can instead simply type into the entry field of the property.)

[[Image:GPT Integration 014.png]]

# <li value=12> Add to the string value <code>Respond only with the lessee's name.</code>
# Click the "OK" button to accept and close this window.

[[Image:GPT Integration 015.png]]

# <li value=14> This is a much better result than before. However, the period at the end is unnecessary and can be removed, again, by prompting the AI appropriately.
# Click the ellipsis button for the '''''Instructions''''' property to open its configuration window (if you prefer, you can instead simply type into the entry field of the property.)

[[Image:GPT Integration 016.png]]

# <li value=16> Add to the string value <code>Don't include control characters.</code>
# Click the "OK" button to accept and close this window.

[[Image:GPT Integration 017.png]]

# <li value=18> Perfect! This is the exact value needed.

This is by no means anything but a simple prompt, but notice how giving context and being more specific alters the result. As a user learning this new technology, it's now time to start experimenting with your prompts and getting creative to get the results you're looking for.

[[Image:GPT Integration 018.png]]

==== Example: Full and Brief Document Summary ====
# Working with the same material as before, select the '''Data Field''' named "Full Summary".
# Click the drop-down menu for the '''''Value Extractor''''' property.
# Select ''GPT Complete'' from the drop-down menu.

[[Image:GPT Integration 019.png]]

# <li value=4> With the '''''Value Extractor''''' set, click the ellipsis button to open its configuration window (if you prefer, you can instead click the drop-down arrow to the left of the property to edit its properties without a pop-up window).

[[Image:GPT Integration 020.png]]

# <li value=5> Start by entering your API key into the '''''API Key''''' property.
# Type <code>tldr</code> into the '''''Instructions''''' property.
# Assuming you have automatic testing enabled, you will see a result returned in the "Results" list view. Click this result.
# Click the "Inspect" button.

[[Image:GPT Integration 021.png]]

# <li value=9> In the "Data Inspector" you will see the number of characters in the result.
# You will also see the full text of the summary.
# Right-click in a blank space to get a list of commands.
# Make sure "Text Wrap" is enabled so that the text will wrap like it is in the screenshot.

[[Image:GPT Integration 022.png]]

# <li value=13> After confirming the previous settings and closing windows, right-click the "Full Summary" '''Data Field''' to get a list of commands.
# Select the "Clone..." command.

[[Image:GPT Integration 023.png]]

# <li value=15> Name the clone "Brief Summary".
# Confirm the clone by clicking the "Execute" button.

[[Image:GPT Integration 024.png]]

# <li value=17> With the clone made, click the ellipsis button of the '''''Value Extractor''''' property to open its configuration window (if you prefer, you can instead click the drop-down arrow to the left of the property to edit its properties without a pop-up window).

[[Image:GPT Integration 025.png]]

# <li value=18> Add <code> in 100 words or less</code> to the '''''Instructions''''' property.
# A result will be returned in the "Results" list view. Select this result.
# Click the "Inspect" button.

[[Image:GPT Integration 026.png]]

# <li value=21> In the "Data Inspector" you will now notice this result's length is much shorter.
# The summary given is much shorter than the previous due to the additional instruction given in the prompt.

[[Image:GPT Integration 027.png]]

==== Example: Sentiment Analysis ====
# Working with the same material as before, select the '''Data Field''' named "Sentiment Analysis".
# Click the drop-down menu for the '''''Value Extractor''''' property.
# Select ''GPT Complete'' from the drop-down menu.

[[Image:GPT Integration 028.png]]

# <li value=4> With the '''''Value Extractor''''' set, click the ellipsis button to open its configuration window (if you prefer, you can instead click the drop-down arrow to the left of the property to edit its properties without a pop-up window).

[[Image:GPT Integration 029.png]]

# <li value=5> Start by entering your API key into the '''''API Key''''' property.
# Click the ellipsis button for the '''''Instructions''''' property to open its configuration window (if you prefer, you can instead simply type into the entry field of the property.)

[[Image:GPT Integration 030.png]]

# <li value=7> Type the string <code>Is this document's sentiment positive, negative, or neutral? Respond with only the sentiment and no control characters.</code> into the editor.
# Click the "OK" button to accept and close this window.

[[Image:GPT Integration 031.png]]

# <li value=9> When the previous window closes, click on "Document (4)" in the '''Batch Viewer'''.
# Assuming you have automatic testing enabled, you will see a result ("negative") returned in the "Results" list view.

[[Image:GPT Integration 032.png]]

# <li value=11> Click on "Document (5)" in the '''Batch Viewer'''.
# Assuming you have automatic testing enabled, you will see a result ("positive") returned in the "Results" list view.

[[Image:GPT Integration 033.png]]