Skip to content

Commit

Permalink
Browse files Browse the repository at this point in the history
  • Loading branch information
pelikhan committed Mar 22, 2024
2 parents 5d08c49 + 7c2393d commit bb5af70
Show file tree
Hide file tree
Showing 8 changed files with 22 additions and 36 deletions.
2 changes: 1 addition & 1 deletion docs/package.json
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@
"name": "docs",
"type": "module",
"private": true,
"version": "1.15.10",
"version": "1.15.11",
"license": "MIT",
"scripts": {
"dev": "astro dev --host",
Expand Down
2 changes: 2 additions & 0 deletions docs/src/content/docs/index.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -52,6 +52,8 @@ extract data to JSON using the ${schema} schema.`
</Card>
</CardGrid>

![A script, the output and the trace](/genaiscript/images/visual-studio-code.png)

## Features

GenAIScript brings essential LLM prompt tooling into a cohesive scripting environment.
Expand Down
2 changes: 1 addition & 1 deletion package.json
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
{
"name": "genaiscript",
"version": "1.15.10",
"version": "1.15.11",
"license": "MIT",
"private": true,
"workspaces": {
Expand Down
2 changes: 1 addition & 1 deletion packages/cli/package.json
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
{
"name": "genaiscript-cli",
"version": "1.15.10",
"version": "1.15.11",
"main": "built/genaiscript.cjs",
"bin": {
"genaiscript": "./built/genaiscript.cjs",
Expand Down
2 changes: 1 addition & 1 deletion packages/core/package.json
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
{
"name": "genaiscript-core",
"version": "1.15.10",
"version": "1.15.11",
"main": "src/index.ts",
"license": "MIT",
"private": true,
Expand Down
2 changes: 1 addition & 1 deletion packages/sample/package.json
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
{
"name": "genaiscript-sample",
"version": "1.15.10",
"version": "1.15.11",
"license": "MIT",
"private": true,
"devDependencies": {
Expand Down
44 changes: 14 additions & 30 deletions packages/vscode/README.md
Original file line number Diff line number Diff line change
@@ -1,14 +1,12 @@
Scripting environment with convinient tooling for file ingestion, prompt development and structured data extraction.

![Debugging a script](https://microsoft.github.io/genaiscript/images/visual-studio-code.png)
[![Authoring a script, analyzing the output and the trace](https://microsoft.github.io/genaiscript/images/visual-studio-code.png)](https://microsoft.github.io/genaiscript/images/visual-studio-code.png)

- **Read the online documentation at https://microsoft.github.io/genaiscript/**
- 👀 **Read the documentation at https://microsoft.github.io/genaiscript/**

## Features

### Stylized Javascript

Build prompts programmatically using [JavaScript](https://microsoft.github.io/genaiscript/genaiscript/reference/scripts/).
- 💵 Prompt programmatically using stylized [JavaScript](https://microsoft.github.io/genaiscript/genaiscript/reference/scripts/).

```js
// define the context
Expand All @@ -20,57 +18,43 @@ $`Analyze FILE and
extract titles to JSON compliant with ${schema}.`
```

### Fast Development Loop

Edit, [debug](https://microsoft.github.io/genaiscript/genaiscript/getting-started/debugging-scripts/), [run](https://microsoft.github.io/genaiscript/genaiscript/getting-started/running-scripts/) your scripts in [Visual Studio Code](https://microsoft.github.io/genaiscript/genaiscript/getting-started/installation).
- ⚡️ Edit, [debug](https://microsoft.github.io/genaiscript/genaiscript/getting-started/debugging-scripts/), [run](https://microsoft.github.io/genaiscript/genaiscript/getting-started/running-scripts/) your scripts

![Debugging a script](https://microsoft.github.io/genaiscript/images/vscode-debugger.png)

### $euse and Share Scripts

Scripts are [files](https://microsoft.github.io/genaiscript/reference/scripts/)! They can be versioned, shared, forked, ...

### Data Schemas
- 📁 Scripts are [files](https://microsoft.github.io/genaiscript/reference/scripts/)! They can be versioned, shared, forked, ...

Define, validate, repair data using [schemas](https://microsoft.github.io/genaiscript/reference/scripts/schemas).
- 📊 Define, validate, repair data using [schemas](https://microsoft.github.io/genaiscript/reference/scripts/schemas).

```js wrap
const data = defSchema("MY_DATA",
{ type: "array", items: { ... }, })
$`Extract data from files using ${data} schema.`
```

### Ingest PDFs, DOCX, CSV, ...

Seamlessly ingest and manipulate
[PDFs](https://microsoft.github.io/genaiscript/reference/scripts/pdf),
[DOCX](https://microsoft.github.io/genaiscript/reference/scripts/docx),
[CSV](https://microsoft.github.io/genaiscript/reference/scripts/csv), ...
- 📄 Ingest PDFs, DOCX, CSV, ...
[PDFs](https://microsoft.github.io/genaiscript/reference/scripts/pdf),
[DOCX](https://microsoft.github.io/genaiscript/reference/scripts/docx),
[CSV](https://microsoft.github.io/genaiscript/reference/scripts/csv), ...

```js
const { pages } = await parsers.PDF(env.files[0])
```

### RAG built-in

[Vector search](https://microsoft.github.io/genaiscript/reference/scripts/embeddings-search/) powered by [LLamaIndex](https://ts.llamaindex.ai/).
- 🔍 [Vector search](https://microsoft.github.io/genaiscript/reference/scripts/embeddings-search/) powered by [LLamaIndex](https://ts.llamaindex.ai/).

```js wrap
// embedding vector index and search
const { files } = await retreival.search("cats", env.files)
```

### Automate

Automate using the [CLI](https://microsoft.github.io/genaiscript/reference/cli).
- 🚀 Automate using the [CLI](https://microsoft.github.io/genaiscript/reference/cli).

```bash frame="none" wrap
genaiscript run my-script "*.pdf"
npx genaiscript-cli run my-script "*.pdf"
```

### LLM Composition

[Run LLMs](https://microsoft.github.io/genaiscript/reference/scripts/inline-prompts/) to build your LLM prompts.
- 👯 [compose prompts](https://microsoft.github.io/genaiscript/reference/scripts/inline-prompts/) within prompts

```js wrap
// summarize each files individually
Expand Down
2 changes: 1 addition & 1 deletion packages/vscode/package.json
Original file line number Diff line number Diff line change
Expand Up @@ -7,7 +7,7 @@
},
"displayName": "GenAIScript Insiders",
"description": "Generative AI Scripting.",
"version": "1.15.10",
"version": "1.15.11",
"icon": "icon.png",
"engines": {
"vscode": "^1.86.0"
Expand Down

0 comments on commit bb5af70

Please sign in to comment.