Skip to content

Commit 06d823d

Browse files
committed
fixes
1 parent 50b83f7 commit 06d823d

File tree

4 files changed

+19
-16
lines changed

4 files changed

+19
-16
lines changed

README.md

Lines changed: 5 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -4,6 +4,9 @@
44

55
Vectorize Iris is an advanced document extraction service that uses AI to accurately extract text, structure, and metadata from PDFs, images, and other document formats. Unlike traditional OCR tools, Iris understands document structure, preserves formatting, and can extract specific information using natural language instructions.
66

7+
Documentation: [docs.vectorize.io](https://docs.vectorize.io/build-deploy/extract-information/extraction-tester/#vectorize-iris)
8+
9+
710
## Why Iris?
811

912
Traditional text extraction tools struggle with:
@@ -36,7 +39,7 @@ print(result.text)
3639

3740
### 📦 Node.js/TypeScript API
3841
```typescript
39-
import { extractTextFromFile } from 'vectorize-iris';
42+
import { extractTextFromFile } from '@vectorize-io/iris';
4043

4144
const result = await extractTextFromFile('document.pdf');
4245
console.log(result.text);
@@ -60,7 +63,7 @@ pip install vectorize-iris
6063

6164
**Node.js:**
6265
```bash
63-
npm install vectorize-iris
66+
npm install @vectorize-io/iris
6467
```
6568

6669
**Rust CLI:**

nodejs-api/README.md

Lines changed: 12 additions & 12 deletions
Original file line numberDiff line numberDiff line change
@@ -5,7 +5,7 @@ Simple TypeScript library for extracting text from documents using Vectorize Iri
55
## Installation
66

77
```bash
8-
npm install vectorize-iris
8+
npm install @vectorize-io/iris
99
```
1010

1111
Set your credentials:
@@ -17,7 +17,7 @@ export VECTORIZE_ORG_ID="your-org-id"
1717
## Basic Text Extraction
1818

1919
```typescript
20-
import { extractTextFromFile } from 'vectorize-iris';
20+
import { extractTextFromFile } from '@vectorize-io/iris';
2121

2222
const result = await extractTextFromFile('document.pdf');
2323
console.log(result.text);
@@ -34,7 +34,7 @@ Tables, lists, and other elements are properly extracted.
3434
## Extract from Buffer
3535

3636
```typescript
37-
import { extractText } from 'vectorize-iris';
37+
import { extractText } from '@vectorize-io/iris';
3838
import * as fs from 'fs';
3939

4040
const fileBuffer = fs.readFileSync('document.pdf');
@@ -51,8 +51,8 @@ Extracted 5536 characters
5151
## Chunking for RAG
5252

5353
```typescript
54-
import { extractTextFromFile } from 'vectorize-iris';
55-
import type { ExtractionOptions } from 'vectorize-iris';
54+
import { extractTextFromFile } from '@vectorize-io/iris';
55+
import type { ExtractionOptions } from '@vectorize-io/iris';
5656

5757
const options: ExtractionOptions = {
5858
chunkSize: 512
@@ -80,7 +80,7 @@ The training process involves adjusting weights...
8080
## Custom Parsing Instructions
8181

8282
```typescript
83-
import { extractTextFromFile } from 'vectorize-iris';
83+
import { extractTextFromFile } from '@vectorize-io/iris';
8484

8585
const result = await extractTextFromFile('report.pdf', {
8686
parsingInstructions: 'Extract only tables and numerical data, ignore narrative text'
@@ -106,7 +106,7 @@ West | $380K | +10%
106106
## Inferred Metadata Schema
107107

108108
```typescript
109-
import { extractTextFromFile } from 'vectorize-iris';
109+
import { extractTextFromFile } from '@vectorize-io/iris';
110110

111111
const result = await extractTextFromFile('invoice.pdf', {
112112
inferMetadataSchema: true
@@ -133,7 +133,7 @@ console.log(JSON.stringify(metadata, null, 2));
133133
```typescript
134134
import express from 'express';
135135
import multer from 'multer';
136-
import { extractText } from 'vectorize-iris';
136+
import { extractText } from '@vectorize-io/iris';
137137
import * as fs from 'fs';
138138

139139
const app = express();
@@ -179,7 +179,7 @@ curl -F "file=@document.pdf" http://localhost:3000/extract
179179
## Batch Processing
180180

181181
```typescript
182-
import { extractTextFromFile } from 'vectorize-iris';
182+
import { extractTextFromFile } from '@vectorize-io/iris';
183183
import * as fs from 'fs/promises';
184184
import * as path from 'path';
185185

@@ -215,7 +215,7 @@ Processing report-q3.pdf...
215215
## Parallel Processing
216216

217217
```typescript
218-
import { extractTextFromFile } from 'vectorize-iris';
218+
import { extractTextFromFile } from '@vectorize-io/iris';
219219

220220
const files = ['doc1.pdf', 'doc2.pdf', 'doc3.pdf'];
221221

@@ -238,7 +238,7 @@ doc3.pdf: 2156 chars
238238
## Error Handling
239239

240240
```typescript
241-
import { extractTextFromFile, VectorizeIrisError } from 'vectorize-iris';
241+
import { extractTextFromFile, VectorizeIrisError } from '@vectorize-io/iris';
242242

243243
try {
244244
const result = await extractTextFromFile('document.pdf');
@@ -264,7 +264,7 @@ import type {
264264
ExtractionOptions,
265265
ExtractionResultData,
266266
MetadataExtractionStrategySchema
267-
} from 'vectorize-iris';
267+
} from '@vectorize-io/iris';
268268

269269
// Type-safe options
270270
const options: ExtractionOptions = {

nodejs-api/package.json

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,5 @@
11
{
2-
"name": "vectorize-iris",
2+
"name": "@vectorize-io/iris",
33
"version": "0.1.0",
44
"description": "Simple text extraction from files using Vectorize Iris",
55
"main": "dist/index.js",

nodejs-api/tests/index.test.ts

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,5 @@
11
/**
2-
* Unit tests for vectorize-iris module
2+
* Unit tests for @vectorize-io/iris module
33
*/
44

55
import * as fs from 'fs/promises';

0 commit comments

Comments
 (0)