Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/alessiogr/payload-plugin-ai
Currently just does embeddings!
https://github.com/alessiogr/payload-plugin-ai
ai embeddings openai payload payload-plugin payloadcms
Last synced: 2 months ago
JSON representation
Currently just does embeddings!
- Host: GitHub
- URL: https://github.com/alessiogr/payload-plugin-ai
- Owner: AlessioGr
- License: mit
- Created: 2023-04-04T18:11:32.000Z (almost 2 years ago)
- Default Branch: master
- Last Pushed: 2023-04-18T14:40:55.000Z (over 1 year ago)
- Last Synced: 2024-11-02T15:06:05.544Z (2 months ago)
- Topics: ai, embeddings, openai, payload, payload-plugin, payloadcms
- Language: JavaScript
- Homepage:
- Size: 536 KB
- Stars: 15
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# Payload AI plugin
[](https://badge.fury.io/js/payload-plugin-ai)
ATTENTION: This plugin currently requires a custom fork of payload to work (replace `payload` with `yarn add alessiogr/payload#production-with-custom`). This is because this plugins depends on two PRs which haven't been merged into payload yet:
- [PR 1 (custom property)](https://github.com/payloadcms/payload/pull/2436)
- [PR 2 (hasMany numbers)](https://github.com/payloadcms/payload/pull/2517)
In this repository I will add a bunch of AI stuff! Currently, it can just generate embeddings for fields using the OpenAI API. Expect things to break with updates without notice.
## Installation
`yarn add payload-plugin-ai`
Add this to your payload.config.ts:
```ts
import { ai } from 'payload-plugin-ai';
...
plugins: [
ai({
OPENAI_SECRET: process.env.OPENAI_SECRET,
NLPCLOUD_API_KEY: process.env.NLP_CLOUD_API_KEY,
embeddings: {
provider: "nlpcloud", // Nlpcloud is recommended
},
}),
]
```
## Embeddings
To enable embeddings on a field, simply add this property to the field:
```ts
import { genEmbeddings } from 'payload-plugin-ai';
...
yourField: {
...
custom: {
...genEmbeddings({ visible: true }),
},
}
```
Now, every time you save the collection, embeddings for that field will be generated.
## Search through embeddings
You can use MongoDB atlas search to search through embeddings. In MongoDB Atlas, create a search index which looks like this:
```json
{
"mappings": {
"fields": {
"textArea_embeddings": [
{
"dimensions": 768,
"similarity": "euclidean",
"type": "knnVector"
}
]
}
}
}
```
Replace `textArea_embeddings` with the name of the embeddings field generated by this plugins.
Once the index is created, you can search through your documents using something like mongoose. There's an example in the payload.config.ts in the demo folder (make sure you adjust the `index` name and the `path`).
## Other
Project structure inspired by [payload-plugin-cloud-storage](https://github.com/payloadcms/plugin-cloud-storage) and [pcms-backpop](https://github.com/TimHal/pcms-backpop)