diff --git a/data-connector/README.md b/data-connector/README.md index fef65ae2..13a8813e 100644 --- a/data-connector/README.md +++ b/data-connector/README.md @@ -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 @@ -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. +
+ walkthrough video +
+ ## Connectors - [x] [Postgres](./src/postgres) @@ -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 - -
- walkthrough video -
- ## 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 @@ -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 @@ -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. diff --git a/data-connector/src/graphql/README.md b/data-connector/src/graphql/README.md index a147544e..dd60d866 100644 --- a/data-connector/src/graphql/README.md +++ b/data-connector/src/graphql/README.md @@ -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 diff --git a/data-connector/src/open-api/README.md b/data-connector/src/open-api/README.md index a521ca0e..88761fa2 100644 --- a/data-connector/src/open-api/README.md +++ b/data-connector/src/open-api/README.md @@ -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