upstash search js
- Repo stars 20
- License MIT
- Author repo search-js
- Domain
- Other
- Author-declared agents
- No explicit declaration found; this is not inferred or tested compatibility
- Static check
- 94 / 100 · heuristic scan, not runtime safety proof
- Runtime evidence
- Not run; no isolated runtime test evidence is currently recorded
- Author / version / license
- @upstash · MIT
- Token usage
- Lean
- Setup complexity
- Plug-and-play
- External API key
- Not required
- Operating systems
- macOS · Linux · Windows
- Runtime requirements
- No explicit requirements detected
- Detected file/system behavior
-
- Read-only
- Write / modify
- Env read
- Network behavior
- External requests
- Install commands
- None (reference only)
Heads up: Tool permissions are not declared; actual access depends on the runtime.
# Upstash Search Documentation
## Quick Start
Install the TS SDK:
```
npm install @upstash/search
```
Create a client and perform a simple upsert + search:
```
import { Search } from "@upstash/search";
const client = new Search({ url: process.env.UPSTASH_SEARCH_REST_URL, token: [REDACTED:credential] });
const index = client.index("my-index");
await index.upsert({ id: "1", content: { text: "hello world" } });
const results = await index.search({ query: "hello" });
```
Basic steps:
- Create an index
- Insert or update documents
- Run searches or filtered queries
## Other Skill Files
### sdk-overview
Provides detailed documentation for all TypeScript SDK commands. Includes:
- delete: Deleting documents
- fetch: Retrieving a document
- info: Index info
- range: Range queries
- reset: Clearing an index
- search: Search queries
- upsert: Adding/updating documents
- getting-started: Setup steps for the SDK
### quick-start
Provides a fast, end-to-end workflow for creating a Search database, adding documents, and querying them. Covers essential concepts including:
- Creating a database and storing credentials
- Adding documents with content and metadata
- Understanding content vs metadata (searchability and filterability)
- Performing searches with optional reranking
- Filtering syntax with SQL-like or structured filters
- Common pitfalls and best practices
Sections and files
Listed in source order.
sections -> Quick Start → Other Skill Files → sdk-overview → quick-start
terms -> No English key terms available
files/cmd -> upstash/search · Adding/updating
body sha256 -> 91261a08acab
Quick Start
Install the TS SDK: Create a client and perform a simple upsert + search: Basic steps: Create an index Insert or update documents
sdk-overview
Provides detailed documentation for all TypeScript SDK commands. Includes: delete: Deleting documents fetch: Retrieving a document info: Index info range: Range queries
quick-start
Provides a fast, end-to-end workflow for creating a Search database, adding documents, and querying them. Covers essential concepts including: Creating a database and storing credentials Adding documents with content and metadata Understanding content vs metadata (searchability and filterability) Performing searches with optional reranking