Skip to content

Commit

Permalink
docs: Add experimental callout OAPI / GraphQL docs
Browse files Browse the repository at this point in the history
  • Loading branch information
johnjcsmith committed Dec 5, 2024
1 parent e920297 commit 34043aa
Show file tree
Hide file tree
Showing 3 changed files with 17 additions and 11 deletions.
20 changes: 9 additions & 11 deletions data-connector/README.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
![Inferable Data Connector](./assets/hero.png)

Inferable Data Connector is a bridge between your data systems and Inferable. Configure your data sources in a json file and start conversing with your data in natural language. Works locally, and in any dockerized environment allowing connection to private resources (DB connection / API endpoints) without exposing them to the public internet.
Inferable Data Connector is a bridge between your data systems and [Inferable](https://.inferable.ai). Configure your data sources in a json file and start conversing with your data in natural language. Works locally, and in any dockerized environment allowing connection to private resources (DB connection / API endpoints) without exposing them to the public internet.

## Features

Expand All @@ -11,6 +11,10 @@ Inferable Data Connector is a bridge between your data systems and Inferable. Co
- 🤿 **Optional Privacy Mode**: Query outputs are never sent to the model. Instead, the function returns results directly to the end user without any model involvement.
- 🔍 **Optional Approval Mode**: Adds an additional safety layer by requiring manual approval before executing any query so you can review the query and data before it is executed.

<div align="center">
<a target="_blank" href="https://youtu.be/v0oKldk7KBc"><img width="60%" alt="walkthrough video" src="https://img.youtube.com/vi/v0oKldk7KBc/0.jpg"></a>
</div>

## Connectors

- [x] [Postgres](./src/postgres)
Expand All @@ -22,16 +26,10 @@ Inferable Data Connector is a bridge between your data systems and Inferable. Co
- [ ] [Big Query](./src/big-query)
- [ ] [Google Sheets](./src/google-sheets)

## Walkthrough

<div align="center">
<a target="_blank" href="https://youtu.be/v0oKldk7KBc"><img width="60%" alt="walkthrough video" src="https://img.youtube.com/vi/v0oKldk7KBc/0.jpg"></a>
</div>

## Quick Start

> 🔑 You will need an Inferable [Cluster API Key](https://docs.inferable.ai/pages/auth#cluster-api-keys) in order to use this connector.
> Create an [Inferable Cloud key](https://app.inferable.ai) or follow the [self-hosting guide](https://docs.inferable.ai/pages/self-hosting).
> Create an [Inferable Cloud key](https://app.inferable.ai) or follow the Inferable [self-hosting guide](https://docs.inferable.ai/pages/self-hosting).
### Running with your own Postgres DB

Expand All @@ -51,7 +49,7 @@ docker run -e INFERABLE_API_SECRET="sk_xxxx" \
inferable/data-connector
```

3. Open the [Inferable Playground](https://app.inferable.ai) (Or `localhost` if you're running [locally](https://docs.inferable.ai/pages/self-hosting)).
3. Open the [Inferable Playground](https://app.inferable.ai) (Or `localhost` if you're running [Inferable locally](https://docs.inferable.ai/pages/self-hosting)).

### Running with a Demo Postgres DB

Expand Down Expand Up @@ -79,9 +77,9 @@ This will:
- Launch the Inferable connector service
- Provide you with a direct link to the Inferable playground where you can start querying

4. Open the [Inferable Playground](https://app.inferable.ai) (Or `localhost` if you're running [locally](https://docs.inferable.ai/pages/self-hosting)).
4. Open the [Inferable Playground](https://app.inferable.ai) (Or `localhost` if you're running [Inferable locally](https://docs.inferable.ai/pages/self-hosting)).

## Sample Data
#### Sample Data

The demo database comes pre-loaded with sample data (defined in `example_data/seed.ts`). You can use this to experiment with queries and understand how the connector works.

Expand Down
3 changes: 3 additions & 0 deletions data-connector/src/graphql/README.md
Original file line number Diff line number Diff line change
@@ -1,5 +1,8 @@
# GraphQL Data Connector

> 📝 The GraphQL Data Connector is experimental and still under development.
> If you encounter any issues, please [open an issue](https://github.com/inferablehq/inferable/issues/).
The GraphQL Data Connector enables LLMs to interact with GraphQL APIs through Inferable by automatically generating functions from GraphQL schemas and providing schema introspection capabilities.

## Configuration
Expand Down
5 changes: 5 additions & 0 deletions data-connector/src/open-api/README.md
Original file line number Diff line number Diff line change
@@ -1,5 +1,10 @@
# OpenAPI Data Connector

> 📝 The OpenAPI Data Connector is experimental and still under development.
> You may run into issues with large OpenAPI schemas and function selection performance.
> We are working on this currently, in the mean time we recommend [limiting the operations](#large-schemas) as nescessary.
> If you encounter any issues, please [open an issue](https://github.com/inferablehq/inferable/issues/).
The OpenAPI Data Connector enables LLMs to interact with REST APIs through Inferable by automatically generating functions from OpenAPI/Swagger specifications.

## Request Configuration
Expand Down

0 comments on commit 34043aa

Please sign in to comment.