Skip to content

Commit

Permalink
fixes
Browse files Browse the repository at this point in the history
  • Loading branch information
fscelliott committed Jun 27, 2024
1 parent df87574 commit 96ef6f1
Show file tree
Hide file tree
Showing 7 changed files with 123 additions and 120 deletions.
2 changes: 1 addition & 1 deletion api-guides/api-reference.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -2,4 +2,4 @@
title: "API reference"
---

To integrate Sensible with your application, see the [API reference](/api-reference/introduction).
To integrate Sensible with your application, see the [API reference](/api-reference/choosing-an-endpoint).
File renamed without changes.
File renamed without changes.
16 changes: 8 additions & 8 deletions integrations/quickstart.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -4,15 +4,15 @@ title: "API quickstart"

## Introduction

In this quickstart, use an example SenseML configuration and example document to get a quick "hello world" API response.
In this quickstart, use an example SenseML configuration and example document to get a quick "hello world" API response.

* To get started with extracting from your custom documents, see [Getting Started](/welcome/getting-started-ai).

## Extract example document data

To run an API call and return extracted, structured data from a downloaded example document:
To run an API call and return extracted, structured data from a downloaded example document:

1. Get an account at [sensible.so](https://app.sensible.so/register).
1. Get an account at [sensible.so](https://app.sensible.so/register).
**NOTE** In the Sensible app, don't rename the default doc type (**senseml\_basics**) or delete the **1\_extract\_your\_first\_data** config, or this example fails.
2. Copy your API key from your [account page](https://app.sensible.so/account/).
3. Copy the following code example into a plain-text application and replace `*YOUR_API_KEY*` with your API key:
Expand All @@ -28,7 +28,7 @@ curl --request POST \
--header "Authorization: Bearer YOUR_API_KEY" \
--header "Content-Type: application/pdf" \
--data-binary "@1_extract_your_first_data.pdf"
```
```
</Tab>

<Tab title="Windows">
Expand All @@ -40,7 +40,7 @@ curl --request POST ^
--header "Authorization: Bearer YOUR_API_KEY" ^
--header "Content-Type: application/pdf" ^
--data-binary "@1_extract_your_first_data.pdf"
```
```
</Tab>

</Tabs>
Expand Down Expand Up @@ -69,10 +69,10 @@ To see this example in the Sensible app:
2. Navigate to the [first tutorial](https://app.sensible.so/editor/?d=senseml%5Fbasics&c=1%5Fextract%5Fyour%5Ffirst%5Fdata&g=1%5Fextract%5Fyour%5Ffirst%5Fdata) config.
3. Visually examine the example document (middle pane), config (left pane), and extracted data (right pane) to better understand the API call you just ran:

![q](/assets/v0/images/screenshots/quick_1.png)
![q](/assets/v0/images/screenshots/quick_1.png)

## Next

* See the [API reference](/api-reference/introduction) and [example code](https://github.com/sensible-hq/sensible-code-examples)
* See the [API reference](/api-reference/choosing-an-endpoint) and [example code](https://github.com/sensible-hq/sensible-code-examples)
* If you're new to APIs, see [API tutorials](/api-guides/api-tutorial/index-api-tutorial)
* To get started with authoring extraction configurations, or configs, for your custom documents, see [Getting Started](/welcome/getting-started-ai).
* To get started with authoring extraction configurations, or configs, for your custom documents, see [Getting Started](/welcome/getting-started-ai).
85 changes: 42 additions & 43 deletions mint.json
Original file line number Diff line number Diff line change
Expand Up @@ -87,7 +87,7 @@
"llm-based-extractions/prompt-tips/index-prompt-tips",
"llm-based-extractions/prompt-tips/query-group-tips",
"llm-based-extractions/prompt-tips/list-tips",
"llm-based-extractions/prompt-tips/table-tips"
"llm-based-extractions/prompt-tips/table-tips"
]
},
"llm-based-extractions/prompt"
Expand All @@ -107,7 +107,7 @@
"layout-based-extractions/app-guide/color",
"layout-based-extractions/app-guide/ui"
]
}
}
]
},
{
Expand Down Expand Up @@ -137,7 +137,7 @@
}
]
},

{
"group": "SenseML Reference",
"pages": [
Expand Down Expand Up @@ -258,16 +258,16 @@
{
"group": "Advanced computed field methods",
"pages": [
"senseml-reference/advanced-computed-field-methods/index-computed-field-methods",
"senseml-reference/advanced-computed-field-methods/index-advanced-computed-field-methods",
"senseml-reference/advanced-computed-field-methods/add-computed-fields",
"senseml-reference/advanced-computed-field-methods/copy-from-sections",
"senseml-reference/advanced-computed-field-methods/copy-to-section",
"senseml-reference/advanced-computed-field-methods/custom-computation",
"senseml-reference/advanced-computed-field-methods/get-file-metadata"
]
},


{
"group": "Concepts",
"pages": [
Expand All @@ -287,8 +287,8 @@
"senseml-reference/concepts/table-methods"
]
}


]
},

Expand Down Expand Up @@ -316,20 +316,20 @@
"api-reference/authentication"
]
},

{
"group": "Extraction",
"pages": [

{
"group": "Document",
"pages": [
"api-reference/extraction/document/extract-data-from-a-document",
"api-reference/extraction/document/generate-upload-url",
"api-reference/extraction/document/extract-from-url",
"api-reference/extraction/document/extract-data-from-a-document-with-config",
"api-reference/extraction/document/extract-from-url-using-config",
"api-reference/extraction/document/generate-upload-url-using-specified-config"
"api-reference/extraction/document/provide-a-download-url-with-config",
"api-reference/extraction/document/generate-an-upload-url-with-config"
]
},
{
Expand Down Expand Up @@ -412,8 +412,8 @@
}
]
},


{
"group": "Changelog",
"pages": [
Expand All @@ -439,11 +439,11 @@
},

{
"source": "/docs/author",
"source": "/docs/author",
"destination": "/welcome/author"
},
{
"source": "/docs/integrate",
"source": "/docs/integrate",
"destination": "/welcome/integrate"
},
{
Expand Down Expand Up @@ -756,8 +756,8 @@
"source": "/docs/senseml-reference-introduction",
"destination": "/senseml-reference/senseml-reference-introduction"
},


{
"source": "/docs/table-tips",
"destination": "/llm-based-extractions/prompt-tips/table-tips"
Expand Down Expand Up @@ -819,7 +819,7 @@
"source": "/docs/classify",
"destination": "/document-type-classification/classify"
},

{
"source": "/docs/troubleshoot",
"destination": "/best-practices/tutorials/troubleshoot"
Expand Down Expand Up @@ -881,7 +881,7 @@
"destination": "/api-guides/examples"
},


{
"source": "/docs/deprecated-table",
"destination": "/senseml-reference/deprecated-features/deprecated-table"
Expand Down Expand Up @@ -921,7 +921,7 @@




{
"source": "/docs/api-reference",
"destination": "/api-guides/api-reference"
Expand All @@ -938,7 +938,7 @@
},
{
"source": "/reference/choosing-an-endpoint",
"destination": "/api-reference/introduction"
"destination": "/api-reference/choosing-an-endpoint"
},
{
"source": "/reference/authentication",
Expand Down Expand Up @@ -978,15 +978,15 @@
},
{
"source": "/reference/provide-a-download-url-with-config",
"destination": "/api-reference/extraction/document/extract-from-url-using-config"
"destination": "/api-reference/extraction/document/provide-a-download-url-with-config"
},
{
"source": "/reference/generate-upload-url",
"destination": "/api-reference/extraction/document/generate-upload-url"
},
{
"source": "/reference/generate-an-upload-url-with-config",
"destination": "/api-reference/extraction/document/generate-upload-url-using-specified-config"
"destination": "/api-reference/extraction/document/generate-an-upload-url-with-config"
},
{
"source": "/reference/extract-data-from-a-document-with-config",
Expand Down Expand Up @@ -1082,71 +1082,70 @@
},



{
"source": "/methods",
"source": "/docs/methods",
"destination": "/senseml-reference/methods/index-methods"
},
{
"source": "/llm-based-methods",
"source": "/docs/llm-based-methods",
"destination": "/senseml-reference/llm-based-methods/index-llm-based-methods"
},
{
"source": "/field-query-object",
"source": "/docs/field-query-object",
"destination": "/senseml-reference/field-query-object/index-field-query-object"
},
{
"source": "/document-type-settings",
"source": "/docs/document-type-settings",
"destination": "/senseml-reference/document-type-settings/index-document-type-settings"
},
{
"source": "/config-settings",
"source": "/docs/config-settings",
"destination": "/senseml-reference/config-settings/index-config-settings"
},
{
"source": "/concepts",
"source": "/docs/concepts",
"destination": "/senseml-reference/concepts/index-concepts"
},
{
"source": "/computed-field-methods",
"source": "/docs/computed-field-methods",
"destination": "/senseml-reference/computed-field-methods/index-computed-field-methods"
},
{
"source": "/advanced-computed-field-methods",
"source": "/docs/advanced-computed-field-methods",
"destination": "/senseml-reference/advanced-computed-field-methods/index-advanced-computed-field-methods"
},
{
"source": "/prompt-tips",
"source": "/docs/prompt-tips",
"destination": "/llm-based-extractions/prompt-tips/index-prompt-tips"
},
{
"source": "/app-guide",
"source": "/docs/app-guide",
"destination": "/layout-based-extractions/app-guide/index-app-guide"
},
{
"source": "/zapier",

"source": "/docs/zapier",
"destination": "/integrations/zapier/index-zapier"
},
{
"source": "/quick-extraction",
"source": "/docs/quick-extraction",
"destination": "/integrations/quick-extraction/index-quick-extraction"
},

{
"source": "/tutorials",
"source": "/docs/tutorials",
"destination": "/best-practices/tutorials/index-tutorials"
},
{
"source": "/api-tutorial",
"source": "/docs/api-tutorial",
"destination": "/api-guides/api-tutorial/index-api-tutorial"
},
{
"source": "/sections",
"source": "/docs/sections",
"destination": "/senseml-reference/sections/index-sections"
},
{
"source": "/preprocessors",
"source": "/docs/preprocessors",
"destination": "/senseml-reference/preprocessors/index-preprocessors"
}
]
Expand Down
Loading

0 comments on commit 96ef6f1

Please sign in to comment.