Skip to content

Commit

Permalink
Sync with txtai 6.0 API, closes #24
Browse files Browse the repository at this point in the history
  • Loading branch information
davidmezzetti committed Aug 9, 2023
1 parent ffab55d commit 97ead50
Show file tree
Hide file tree
Showing 3 changed files with 30 additions and 14 deletions.
38 changes: 27 additions & 11 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,13 +1,29 @@
# txtai: Semantic search and workflows in JavaScript

[![Version](https://img.shields.io/github/release/neuml/txtai.js.svg?style=flat&color=success)](https://github.com/neuml/txtai.js/releases)
[![GitHub Release Date](https://img.shields.io/github/release-date/neuml/txtai.js.svg?style=flat&color=blue)](https://github.com/neuml/txtai.js/releases)
[![GitHub issues](https://img.shields.io/github/issues/neuml/txtai.js.svg?style=flat&color=success)](https://github.com/neuml/txtai.js/issues)
[![GitHub last commit](https://img.shields.io/github/last-commit/neuml/txtai.js.svg?style=flat&color=blue)](https://github.com/neuml/txtai.js)

[txtai](https://github.com/neuml/txtai) is an open-source platform for semantic search and workflows powered by language models.

This repository contains JavaScript bindings for the txtai API. Full txtai functionality is supported.
<p align="center">
<img src="https://github.com/raw/neuml/txtai/master/logo.png"/>
</p>

<p align="center">
<b>JavaScript client for txtai</b>
</p>

<p align="center">
<a href="https://github.com/neuml/txtai.js/releases">
<img src="https://img.shields.io/github/release/neuml/txtai.js.svg?style=flat&color=success" alt="Version"/>
</a>
<a href="https://github.com/neuml/txtai.js/releases">
<img src="https://img.shields.io/github/release-date/neuml/txtai.js.svg?style=flat&color=blue" alt="GitHub Release Date"/>
</a>
<a href="https://github.com/neuml/txtai.js/issues">
<img src="https://img.shields.io/github/issues/neuml/txtai.js.svg?style=flat&color=success" alt="GitHub Issues"/>
</a>
<a href="https://github.com/neuml/txtai.js">
<img src="https://img.shields.io/github/last-commit/neuml/txtai.js.svg?style=flat&color=blue" alt="GitHub Last Commit"/>
</a>
</p>

[txtai](https://github.com/neuml/txtai) is an all-in-one embeddings database for semantic search, LLM orchestration and language model workflows.

This repository contains JavaScript bindings for the txtai API.

## Installation
txtai.js can be installed via npm
Expand All @@ -24,7 +40,7 @@ The examples directory has a series of examples that give an overview of txtai.
| [Labeling with zero-shot classification](https://github.com/neuml/txtai.js/blob/master/examples/node/src/labels.js) | Labeling with zero-shot classification |
| [Pipelines and workflows](https://github.com/neuml/txtai.js/blob/master/examples/node/src/pipelines.js) | Pipelines and workflows |

txtai.js connects to a txtai api instance. See [this link](https://github.com/neuml/txtai#api) for details on how to start a new api instance.
txtai.js connects to a txtai api instance. See [this link](https://neuml.github.io/txtai/api/) for details on how to start a new api instance.

Once an api instance is running, do the following to run the examples.

Expand Down
2 changes: 1 addition & 1 deletion examples/node/package.json
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@
"name": "txtai-node",
"dependencies": {
"sprintf-js": ">=1.1.2",
"txtai": ">=5.5.0"
"txtai": ">=6.0.0"
},
"devDependencies": {
"@babel/cli": ">=7.10.5",
Expand Down
4 changes: 2 additions & 2 deletions package.json
Original file line number Diff line number Diff line change
@@ -1,8 +1,8 @@
{
"name": "txtai",
"version": "5.5.0",
"version": "6.0.0",
"author": "NeuML",
"description": "Semantic search and workflows in JavaScript",
"description": "JavaScript client for txtai",
"license": "Apache-2.0",
"keywords": ["search", "nlp", "machine-learning", "similarity"],
"repository": "neuml/txtai.js",
Expand Down

0 comments on commit 97ead50

Please sign in to comment.