Skip to main content

VectorShift Python SDK

Project description

VectorShift SDK

The Python SDK for building, saving, and running AI pipelines and agents on the VectorShift platform.

Prerequisites: Python 3.10+ and a VectorShift account.

Quickstart

1. Install the SDK

pip install vectorshift

2. Set your API key

Generate one at Account → API Keys, then export it:

export VECTORSHIFT_API_KEY="vs-..."

3. Build, save, and run

Paste this into a file (hello.py) and run it.

from vectorshift import Pipeline

p = Pipeline.new(name="Hello pipeline")
query = p.add(name="query").input(input_type="string")
llm = p.add(name="llm").llm(provider="openai", model="gpt-5.4", prompt=query.text)
p.add(name="answer").output(value=llm.response)

p.save()
result = p.run({"query": "What is VectorShift in one sentence?"})
print(result["outputs"]["answer"])
python hello.py

4. See it in the editor

Open the platform — your new pipeline is editable in the visual editor, identical to one built there.

For the best developer experience, enable the mypy plugin. It catches wrong field names on node builders, mismatched types between wired nodes, and agent tools missing required inputs — at edit time, before you save. Drop a mypy.ini with plugins = vectorshift.mypy_plugin and most editors (VS Code, Cursor, PyCharm, Zed) light up SDK-aware errors inline as you type.

Build with ChatGPT or Claude

Paste this at the start of a ChatGPT or Claude chat, then describe what you want. It points the model at the SDK docs so it builds the right VectorShift object — pipeline, agent, knowledge base, or table — correctly.

You are building with the VectorShift Python SDK. Before writing code, read
https://docs.vectorshift.ai/llms.txt and the SDK reference pages it links.
Follow the documented patterns exactly: use the builder API, correct node and
field names, and the right object type for my request (pipeline, agent,
knowledge base, or table). Install with `pip install vectorshift` and
authenticate via the VECTORSHIFT_API_KEY environment variable. Then build,
save, and run what I describe, returning one complete runnable script.

My request:

Documentation

Full documentation — streaming, background runs, agents, knowledge bases, and the complete API reference — lives at docs.vectorshift.ai/sdk.

Project details


Release history Release notifications | RSS feed

Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

vectorshift-0.1.13.tar.gz (2.4 MB view details)

Uploaded Source

Built Distribution

If you're not sure about the file name format, learn more about wheel file names.

vectorshift-0.1.13-py3-none-any.whl (2.9 MB view details)

Uploaded Python 3

File details

Details for the file vectorshift-0.1.13.tar.gz.

File metadata

  • Download URL: vectorshift-0.1.13.tar.gz
  • Upload date:
  • Size: 2.4 MB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/6.1.0 CPython/3.13.7

File hashes

Hashes for vectorshift-0.1.13.tar.gz
Algorithm Hash digest
SHA256 efae02f4f5c784cc47391552f51c9fcb374d88ba79cf9262689471ac99713e13
MD5 cf08310319741c6547a36d5c2943c7b9
BLAKE2b-256 b9b69399dbad6b0a6429835baa0ffa272fc18d18add44a3abe0f8b5049023d53

See more details on using hashes here.

File details

Details for the file vectorshift-0.1.13-py3-none-any.whl.

File metadata

  • Download URL: vectorshift-0.1.13-py3-none-any.whl
  • Upload date:
  • Size: 2.9 MB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/6.1.0 CPython/3.13.7

File hashes

Hashes for vectorshift-0.1.13-py3-none-any.whl
Algorithm Hash digest
SHA256 4d4f2ed0e1a04e2abd84b95205562b4471197035e7ec6c35377d0e874a178016
MD5 6468d6d5112f42b863a4a4fe2402360f
BLAKE2b-256 081e6f33814549e0675dea0d04d035e328c082519a1bd163948a4e9bb15d2708

See more details on using hashes here.

Supported by

AWS Cloud computing and Security Sponsor Datadog Monitoring Depot Continuous Integration Fastly CDN Google Download Analytics Pingdom Monitoring Sentry Error logging StatusPage Status page