LangStream Documentation
Langstream.aiLangStream GitHub RepoChangelog
  • LangStream Documentation
  • ❤️Langstream.ai
  • ⭐LangStream GitHub Repo
  • 📜Changelog
  • about
    • What is LangStream?
    • License
  • Get Started
  • installation
    • LangStream CLI
    • Docker
    • Minikube (mini-langstream)
    • Kubernetes
    • Build and install from source
  • Building Applications
    • Vector Databases
    • Application structure
      • Pipelines
      • Instances
      • Configuration
      • Topics
      • Assets
      • Secrets
      • YAML templating
      • Error Handling
      • Stateful agents
      • .langstreamignore
    • Sample App
    • Develop, test and deploy
    • Application Lifecycle
    • Expression Language
    • API Gateways
      • Websocket
      • HTTP
      • Message filtering
      • Gateway authentication
    • API Reference
      • Agents
      • Resources
      • Assets
  • LangStream CLI
    • CLI Commands
    • CLI Configuration
    • Web interface
  • Integrations
    • Large Language Models (LLMs)
      • OpenAI
      • Hugging Face
      • Google Vertex AI
      • Amazon Bedrock
      • Ollama
    • Data storage
      • Astra Vector DB
      • Astra
      • Cassandra
      • Pinecone
      • Milvus
      • Solr
      • JDBC
      • OpenSearch
    • Integrations
      • Apache Kafka Connect
      • Apache Camel
    • LangServe
  • Pipeline Agents
    • Agent Messaging
    • Builtin agents
      • Input & Output
        • webcrawler-source
        • s3-source
        • azure-blob-storage-source
        • sink
        • vector-db-sink
        • camel-source
      • AI Agents
        • ai-chat-completions
        • ai-text-completions
        • compute-ai-embeddings
        • flare-controller
      • Text Processors
        • document-to-json
        • language-detector
        • query
        • query-vector-db
        • re-rank
        • text-normaliser
        • text-extractor
        • text-splitter
        • http-request
      • Data Transform
        • cast
        • compute
        • drop
        • drop-fields
        • merge-key-value
        • unwrap-key-value
      • Flow control
        • dispatch
        • timer-source
        • trigger-event
    • Custom Agents
      • Python sink
      • Python source
      • Python processor
      • Python service
    • Agent Developer Guide
      • Agent Types
      • Agent Creation
      • Configuration and Testing
      • Environment variables
  • Messaging
    • Messaging
      • Apache Pulsar
      • Apache Kafka
      • Pravega.io
  • Patterns
    • RAG pattern
    • FLARE pattern
  • Examples
    • LangServe chatbot
    • LlamaIndex Cassandra sink
Powered by GitBook
On this page
  • Installation
  • Your first application
Edit on GitHub

Get Started

PreviousLicenseNextLangStream CLI

Last updated 1 year ago

You can get started with LangStream in 5 minutes or less. This guide will walk you through the steps to get LangStream running on your local machine.

This guide uses Docker to run all the components of LangStream locally. If you want to learn how to deploy a full LangStream cluster locally using minikube, see

Installation

  1. Install the LangStream CLI:

brew install LangStream/langstream/langstream

If you are on Linux or Windows please refer to the .

  1. Run the sample application

Let's run a simple LangStream Application that implements a ChatBot using OpenAI's API.

You need to get an OpenAI API key from .

export OPEN_AI_ACCESS_KEY=<your-openai-api-key>
langstream docker run test -app https://github.com/LangStream/langstream/tree/main/examples/applications/openai-completions -s https://github.com/LangStream/langstream/blob/main/examples/secrets/secrets.yaml

The first time you run the application, it will take a few minutes to download the Docker images.

  1. Chat with the bot

Once the application is running, chat with the bot using the LangStream CLI:

langstream gateway chat test -cg consume-output -pg produce-input -p sessionId=$(uuidgen)

If you see an 'application not found' error, LangStream is still not ready to accept the connections. Wait a few seconds and try again.

With LangStream installed and your environment set up, you're ready to build an application.

Your first application

Here are a few ways to get started building LangStream applications:

to quickly create an OpenAI query with LangStream.

and learn how to build the needed manifests

and use the provided starter applications & agent snippets

here.
installation guide
here
Build a sample application
Set up your development environment
Install the VSCode extension