Skip to content

Commit

Permalink
revert
Browse files Browse the repository at this point in the history
  • Loading branch information
@fscelliott
fscelliott committed Jun 27, 2024
1 parent 4b1e4be commit eff20ce
Showing 1 changed file with 65 additions and 68 deletions.
133 changes: 65 additions & 68 deletions welcome/getting-started-ai.mdx
View file
Original file line number Diff line number Diff line change
Expand Up @@ -2,135 +2,132 @@
title: "Getting started"
---

## Overview
### Overview

Welcome! Sensible is a developer-first platform for extracting structured data from documents, for example, business forms in PDF format. Sensible is highly configurable. You can get simple data about text and images in documents in minutes by leveraging GPT-4 and other large language models (LLMs), or you can tackle complex and idiosyncratic document formatting with Sensible's powerful layout-based document primitives.
Welcome! Sensible is a developer-first platform for extracting structured data from documents, for example, business forms in PDF format. It's highly configurable: you can get simple data in minutes by leveraging GPT-4 and other large-language models (LLMs), or you can tackle complex and idiosyncratic document formatting with Sensible's powerful layout-based document primitives.



![Click to enlarge](https://raw.githubusercontent.com/sensible-hq/sensible-docs/main/readme-sync/assets/v0/images/screenshots/platform.png)
![Click to enlarge](/assets/v0/images/screenshots/platform.png)

See the following list for an overview of going live with Sensible:

- **Learn** to extract data, or use out-of-the-box supported document types
- [**Integrate**](/welcome/integrate) using Sensible's API, SDKs, quick-extract UI, or other tools
- [**Quality control**](/best-practices/validate-extractions) extracted data
- [**Monitor**](/best-practices/metrics) extracted data in production
* **Learn** to extract data, or use out-of-the-box supported document types
* [**Integrate**](/welcome/integrate) using Sensible's API, quick-extract UI, or other tools
* [**Quality control**](/best-practices/validate-extractions) extracted data
* [**Monitor**](/best-practices/metrics) extracted data in production

This guide gets you started with the first step, extracting data.

## Learn to extract data
### Learn to extract data

Let's get started with extracting document data from an example bank statement. We'll author a prompt for a large language model (LLM) to extract a checking account number in minutes.
Let's get started with extracting document data from an example bank statement. We'll use a large-language model (LLM) prompt to extract a checking account number in minutes.

In this guide, you'll:

- Extract data from an example document using a natural-language description of your target data, for example, a checking bank account number.
- Publish your prompt as part of a "config."
- Test your config against a second, similar document to ensure it extracts the same target data.

## Get an account
* Extract data from an example document using a natural-language description of your target data
* Publish your prompt as part of a "config."
* Test your config against a second, similar document to ensure it extracts the same target data.

1. Get an account at [sensible.so](https://app.sensible.so/register). If you don't have an account, you can still read along to get a rough idea of how things work.
### Get an account

2. Log into the [Sensible app](https://app.sensible.so/signin/). Complete the registration process.
1. Get an account at [sensible.so](https://app.sensible.so/register). If you don't have an account, you can still read along to get a rough idea of how things work.
2. Log into the [Sensible app](https://app.sensible.so/signin/).

## View an example
### View an example

1. To view an example bank statement extraction, navigate to <https://app.sensible.so/editor/instruct/?d=sensible_instruct_basics&c=bank_statement&g=bank_statement>.
1. To view an example bank statement extraction, navigate to [https://app.sensible.so/editor/instruct/?d=sensible\_instruct\_basics&c=bank\_statement&g=bank\_statement](https://app.sensible.so/editor/instruct/?d=sensible%5Finstruct%5Fbasics&c=bank%5Fstatement&g=bank%5Fstatement).
Sensible displays an example document in the left pane, and fields of extracted data in the right pane.

Sensible displays an example document in the left pane, and fields of extracted data in the right pane.

![Click to enlarge](https://raw.githubusercontent.com/sensible-hq/sensible-docs/main/readme-sync/assets/v0/images/screenshots/quickstart_instruct_1.png)
![Click to enlarge](/assets/v0/images/screenshots/auto-extract1.png)

Take the following steps to create a prompt to extract more data from the document.

## Auto-extract data

### Auto-extract data
To extract document data automatically, take the following steps:

1. Click **Query group**:
<Steps>
<Step title="Click Query group:">
![Click to enlarge](/assets/v0/images/screenshots/quickstart_instruct_2.png)
</Step>
<Step title="Edit the query group as shown in the following screenshot by entering checking account number (not savings) in the query field. Click Extract.">
![Click to enlarge](/assets/v0/images/screenshots/auto-extract2.png)

![Click to enlarge](https://raw.githubusercontent.com/sensible-hq/sensible-docs/main/readme-sync/assets/v0/images/screenshots/quickstart_instruct_2.png)

2. Click **Auto generate**, then click **Generate**:
</Step>
<Step title="Sensible displays the extracted account number, 8347-32348, in the Extracted data section:">
![Click to enlarge](/assets/v0/images/screenshots/auto-extract3.png)

![Click to enlarge](https://raw.githubusercontent.com/sensible-hq/sensible-docs/main/readme-sync/assets/v0/images/screenshots/quickstart_instruct_auto.png)
</Step>

3. Sensible automatically generates queries and extracts their answers from the document:
<Step title="Click Back to fields.">
![Click to enlarge](/assets/v0/images/screenshots/auto-extract4.png)

![Click to enlarge](https://raw.githubusercontent.com/sensible-hq/sensible-docs/main/readme-sync/assets/v0/images/screenshots/quickstart_instruct_auto_2.png)
</Step>
</Steps>

4. (Optional) Add more queries by clicking **Suggest queries**, selecting the field IDs that interest you, and clicking **Add selected queries**:

![Click to enlarge](https://raw.githubusercontent.com/sensible-hq/sensible-docs/main/readme-sync/assets/v0/images/screenshots/quickstart_instruct_auto_3.png)
### Manually configure extraction
1. To author your own LLM prompts to extract data points from the document, click Query group.
![](/assets/v0/images/screenshots/manually-configure1.png)

To test the automatically generated extraction configuration with another document, see [Test the prompt](welcome/getting-started-ai#test-the-prompt). To author your own extraction configurations, see the following steps.
2. Edit the query group as shown in the following screenshot by entering `checking account number (not savings)` in the query field. **Click Extract**.

## Manually configure extraction
3. Sensible displays the extracted account number, `8347-32348`, in the Extracted data section:

1. To author your own LLM prompts to extract data points from the document, click **Query group**.

![Click to enlarge](https://raw.githubusercontent.com/sensible-hq/sensible-docs/main/readme-sync/assets/v0/images/screenshots/quickstart_instruct_2.png)

2. Edit the query group as shown in the following screenshot by entering `checking account number (not savings)` in the query field. Click **Extract**.
2. Sensible displays the extracted account number, `8347-32348`, in the **Extracted data** section:

![Click to enlarge](https://raw.githubusercontent.com/sensible-hq/sensible-docs/main/readme-sync/assets/v0/images/screenshots/quickstart_instruct_3.png)
![](/assets/v0/images/screenshots/manually-configure2.png)

4. Click **Back to fields**.

Congratulations! You extracted the checking account number from the bank statement.
<Check>Congratulations! You extracted the checking account number from the bank statement.</Check>

## Publish the prompt
### Publish the prompt

To extract checking account numbers from other bank statements in production, publish the "config" containing your prompt.
To extract checking account numbers from other bank statements, you'll need to publish the "config" containing your prompt.

Click **Publish configuration**, click **Production**, then click **Publish to production**:

![Click to enlarge](https://raw.githubusercontent.com/sensible-hq/sensible-docs/main/readme-sync/assets/v0/images/screenshots/quickstart_instruct_10.png)
![Click to enlarge](/assets/v0/images/screenshots/quickstart_instruct_10.png)

## Test the prompt
### Test the prompt

Let's see if the config containing your prompt works with other bank statements. To test the prompt, take the following steps:

1. Navigate to <https://app.sensible.so/editor/instruct/?d=sensible_instruct_basics&c=bank_statement&g=bank_statement_2>. Notice that the left pane now displays a statement for a different customer.
1. Navigate to [https://app.sensible.so/editor/instruct/?d=sensible\_instruct\_basics&c=bank\_statement&g=bank\_statement\_2](https://app.sensible.so/editor/instruct/?d=sensible%5Finstruct%5Fbasics&c=bank%5Fstatement&g=bank%5Fstatement%5F2). Notice that the left pane now displays a statement for a different customer.

![Click to enlarge](https://raw.githubusercontent.com/sensible-hq/sensible-docs/main/readme-sync/assets/v0/images/screenshots/quickstart_instruct_8.png)
![Click to enlarge](/assets/v0/images/screenshots/quickstart_instruct_8.png)

2. In the right pane, scroll down to the checking account number field you authored in previous steps. Verify that the extracted information automatically updated to reflect the second example document. For example, the account number updated from `8347-32348` to `9876-12345`:
2. In the right pane, scroll down to the `account_num_checking` field you authored in previous steps. Verify that the extracted information automatically updated to reflect the second example document. For example, the account number updated from `8347-32348` to `9876-12345`:

![Click to enlarge](https://raw.githubusercontent.com/sensible-hq/sensible-docs/main/readme-sync/assets/v0/images/screenshots/quickstart_instruct_9.png)
![Click to enlarge](/assets/v0/images/screenshots/quickstart_instruct_9.png)

It looks like your prompt was successful at extracting the checking account number from another document. Great!
It looks like your prompt was successful at extracting the checking account number from another document. Great!

## (Optional) Extract more data
### (Optional) Extract more data

Try extracting more complex pieces of information. For example, try extracting the time period for each account using the [List method](/llm-based-extractions/prompt-tips/list-tips). See the `accounts_list` field in this config for an example of using the List method.
Try extracting more complex pieces of information. For example, try extracting the time period for each account using the [List method](llm-based-extractions/prompt-tips/list-tips). See the `accounts_list` field in this config for an example of using the List method.

Publish the config to save your changes.

## (Optional) Extract from your own documents

Sensible recommends grouping similar documents, for example, bank statements, into a *document type*. To extract data from your documents, first check if they're on Sensible's list of out-of-the-box [supported document types](/layout-based-extractions/library-quickstart). If not, create document types and configure your custom extractions by using the interactive [tutorial](https://app.sensible.so/tutorial/) or taking the following steps:
### (Optional) Extract from your own documents

Sensible recommends grouping similar documents, for example, bank statments, into a document type. To extract data from your documents, first check if they're on Sensible's list of out-of-the-box [supported document types](/layout-based-extractions/library-quickstart). If not, configure your custom extractions by using the interactive [tutorial](https://app.sensible.so/tutorial/) or taking the following steps:

1. To exit the Sensible Instruct editor, click **Sensible** in the upper left corner.
2. Click the **Document types** tab. Create a new document type, then click the type you created to edit it.
3. In the document type's **Reference documents** tab, upload your own example document.
4. In the document type's **Configurations** tab, create a new test configuration, and click the configuration you created to edit it.
5. Write prompts in the configuration editor to extract data using what you learned in previous steps.

## Next
5. Write prompts in the configuration editor to extract data using what you learned in previous steps.

### Learn more about extraction
### Next

- See [prompt authoring tips](/llm-based-extractions/prompt-tips/)
- Explore extracting lists, tables, and single data points with other interactive examples:
- [Resume](https://app.sensible.so/editor/instruct/?d=sensible_instruct_basics&c=resume&g=resume&v=)
- [Purchase contract](https://app.sensible.so/editor/instruct/?d=sensible_instruct_basics&c=contract&g=contract&v=)
#### Learn more about extraction

- For advanced extraction strategies, see [Choosing an extraction approach](/welcome/author).
* See [prompt authoring tips](/llm-based-extractions/prompt-tips/index-prompt-tips)
* Explore extracting lists, tables, and single data points with other interactive examples:
* [Resume](https://app.sensible.so/editor/instruct/?d=sensible%5Finstruct%5Fbasics&c=resume&g=resume&v=)
* [Purchase contract](https://app.sensible.so/editor/instruct/?d=sensible%5Finstruct%5Fbasics&c=contract&g=contract&v=)
* For advanced extraction strategies, see [Choosing an extraction approach](/welcome/author)

### Integrate
#### Integrate

Get extracted document data out of Sensible and put it to work in Excel files, databases, and other destinations. See [Integrating](/welcome/integrate).
Get extracted document data out of Sensible and put it to work in Excel files, databases, and other destinations. See [Integrating](/welcome/integrate).

0 comments on commit eff20ce

Please sign in to comment.