Skip to content

Commit cae0a93

Browse files
committed
updated README
1 parent 3395513 commit cae0a93

File tree

1 file changed

+21
-37
lines changed

1 file changed

+21
-37
lines changed

README.md

+21-37
Original file line numberDiff line numberDiff line change
@@ -1,52 +1,36 @@
1-
# Simple Echo Connector
1+
# LangChain-Exa Connector
22

3-
This repository contains a simplified connector that uses an echo function to simulate responses from a chat model. It's designed to mimic the behavior of more complex connectors (like those interfacing with models such as Ollama), but without the need for external API calls. This can be particularly useful for testing, development, or educational purposes.
3+
This connector allows you to access LangChain's conversational AI capabilities from within Exa.
44

55
## Features
66

7-
- Echo function that simulates chat responses
8-
- Mapping of chat completions to a standardized response format
9-
- Simple integration into existing TypeScript projects
10-
- Configurable to simulate different model types
7+
- Send prompts to LangChain models and display responses
8+
- Supports text completion, text classification, and other language tasks
9+
- Configure timeouts, max tokens, temperature, and other parameters
10+
- View usage statistics for your Exa account
1111

12-
## Installation
12+
## Getting Started
1313

14-
Before installing this connector, ensure you have [Node.js](https://nodejs.org/) installed on your system.
14+
1. Sign up for an API key at [Exa](https://www.exa.ai/)
15+
2. Install this connector in Exa
16+
- Open the Connectors sidebar
17+
- Search for "LangChain Exa Connector"
18+
- Install
19+
3. Configure your API key
20+
- Open the connector settings
21+
- Paste in your Exa API key
22+
4. Start using LangChain with models in your prompts
1523

16-
1. **Clone the repository**
24+
## Usage
1725

18-
```bash
19-
git clone https://github.com/PromptMixerDev/prompt-mixer-sample-connector.git
20-
cd prompt-mixer-sample-connector
21-
```
26+
Once configured, you can access Open AI models with LangChain and Exa by:
2227

23-
2. **Install dependencies**
24-
25-
```bash
26-
npm install
27-
```
28-
29-
This will install all necessary dependencies, including TypeScript and any types required for development.
30-
31-
## Configuration
32-
33-
The `config` object can be adjusted to suit your needs. It's located in `config.ts`. By default, it might include placeholders for various configurations. Ensure you review and update it as necessary for your project.
28+
- Selecting "LangChain Exa Connector" models from the models dropdown
3429

3530
## Contributing
3631

37-
Contributions are welcome! If you have improvements or bug fixes, please follow these steps:
38-
39-
1. Fork the repository
40-
2. Create your feature branch (`git checkout -b feature/AmazingFeature`)
41-
3. Commit your changes (`git commit -am 'Add some AmazingFeature'`)
42-
4. Push to the branch (`git push origin feature/AmazingFeature`)
43-
5. Open a Pull Request
32+
Pull requests welcome!
4433

4534
## License
4635

47-
This project is licensed under the MIT License
48-
49-
## Acknowledgments
50-
51-
- This project is inspired by the need for simple, mock connectors in development environments.
52-
- Thanks to all contributors and users for their interest and feedback.
36+
This project is licensed under the MIT license.

0 commit comments

Comments
 (0)