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
  • AWS Bedrock (bedrock-configuration)
  • Astra (datasource)
  • Astra Vector DB (datasource)
  • Cassandra (datasource)
  • JDBC (datasource)
  • OpenSearch (datasource)
  • Hugging Face (hugging-face-configuration)
  • Ollama (ollama-configuration)
  • Open AI (open-ai-configuration)
  • Astra (vector-database)
  • Astra Vector DB (vector-database)
  • Cassandra (vector-database)
  • Milvus (vector-database)
  • OpenSearch (vector-database)
  • Pinecone (vector-database)
  • Solr (vector-database)
  • Vertex AI (vertex-configuration)
Edit on GitHub
  1. Building Applications
  2. API Reference

Resources

LangStream Version: 0.6.2

AWS Bedrock (bedrock-configuration)

Connect to AWS Bedrock API.

Description
Type
Required
Default Value

access-key

Aws access key.

string

✓

endpoint-override

Override default AWS endpoint. Useful for testing and debugging. If using AWS, please only set the region.

string

region

AWS region for Bedrock endpoints.

string

us-east-1

secret-key

Aws secret key.

string

✓

Astra (datasource)

Connect to DataStax Astra Database service.

Description
Type
Required
Default Value

clientId

Astra Token clientId to use.

string

✓

database

Astra Database name to connect to. If secureBundle is provided, this field is ignored.

string

database-id

Astra Database ID name to connect to. If secureBundle is provided, this field is ignored.

string

environment

Astra environment.

string

PROD

password

DEPRECATED: use secret instead.

string

secret

Astra Token secret to use.

string

✓

secureBundle

Secure bundle of the database. Must be encoded in base64.

string

service

Service type. Set to 'astra'

string

✓

token

Astra Token (AstraCS:xxx) for connecting to the database. If secureBundle is provided, this field is ignored.

string

username

DEPRECATED: use clientId instead.

string

Astra Vector DB (datasource)

Connect to DataStax Astra Vector DB service.

Description
Type
Required
Default Value

endpoint

API Endpoint.

string

service

Service type. Set to 'astra-vector-db'

string

✓

token

Astra Token (AstraCS:xxx) for connecting to the database.

string

Cassandra (datasource)

Connect to Apache cassandra.

Description
Type
Required
Default Value

contact-points

Contact points of the cassandra cluster.

string

✓

loadBalancing-localDc

Load balancing local datacenter.

string

✓

password

User password.

string

port

Cassandra port.

integer

9042

service

Service type. Set to 'cassandra'

string

✓

username

User username.

string

JDBC (datasource)

Connect to any JDBC compatible database. The driver must be provided as dependency. All the extra configuration properties are passed as is to the JDBC driver.

Description
Type
Required
Default Value

driverClass

JDBC entry-point driver class.

string

✓

service

Service type. Set to 'jdbc'

string

✓

url

JDBC connection url.

string

✓

OpenSearch (datasource)

Connect to OpenSearch service or AWS OpenSearch Service/Serverless.

Description
Type
Required
Default Value

host

Host parameter for connecting to OpenSearch. Valid both for OpenSearch and AWS OpenSearch Service/Serverless.

string

✓

https

Whether to use https or not.

boolean

true

index-name

Name of the index to to connect to.

string

✓

password

Basic authentication for connecting to OpenSearch. In case of AWS OpenSearch Service/Serverless, this is the secret key.

string

port

Port parameter for connecting to OpenSearch service.

integer

9200

region

Region parameter for connecting to AWS OpenSearch Service/Serveless.

string

service

Service type. Set to 'opensearch'

string

✓

username

Basic authentication for connecting to OpenSearch. In case of AWS OpenSearch Service/Serverless, this is the access key.

string

Hugging Face (hugging-face-configuration)

Connect to Hugging Face service.

Description
Type
Required
Default Value

access-key

The access key to use for "api" provider.

string

api-url

The URL of the Hugging Face API. Relevant only if provider is "api".

string

https://api-inference.huggingface.co/pipeline/feature-extraction/

model-check-url

The model url to use. Relevant only if provider is "api".

string

https://huggingface.co/api/models/

provider

The provider to use. Either "local" or "api".

string

api

Ollama (ollama-configuration)

Connect to Ollama API.

Description
Type
Required
Default Value

url

URL for the Ollama service.

string

✓

Open AI (open-ai-configuration)

Connect to OpenAI API or Azure OpenAI API.

Description
Type
Required
Default Value

access-key

The access key to use.

string

✓

provider

The provider to use. Either "openai" or "azure".

string

openai

url

Url for Azure OpenAI API. Required only if provider is "azure".

string

Astra (vector-database)

Connect to DataStax Astra Database service.

Description
Type
Required
Default Value

clientId

Astra Token clientId to use.

string

✓

database

Astra Database name to connect to. If secureBundle is provided, this field is ignored.

string

database-id

Astra Database ID name to connect to. If secureBundle is provided, this field is ignored.

string

environment

Astra environment.

string

PROD

password

DEPRECATED: use secret instead.

string

secret

Astra Token secret to use.

string

✓

secureBundle

Secure bundle of the database. Must be encoded in base64.

string

service

Service type. Set to 'astra'

string

✓

token

Astra Token (AstraCS:xxx) for connecting to the database. If secureBundle is provided, this field is ignored.

string

username

DEPRECATED: use clientId instead.

string

Astra Vector DB (vector-database)

Connect to DataStax Astra Vector DB service.

Description
Type
Required
Default Value

endpoint

API Endpoint.

string

service

Service type. Set to 'astra-vector-db'

string

✓

token

Astra Token (AstraCS:xxx) for connecting to the database.

string

Cassandra (vector-database)

Connect to Apache cassandra.

Description
Type
Required
Default Value

contact-points

Contact points of the cassandra cluster.

string

✓

loadBalancing-localDc

Load balancing local datacenter.

string

✓

password

User password.

string

port

Cassandra port.

integer

9042

service

Service type. Set to 'cassandra'

string

✓

username

User username.

string

Milvus (vector-database)

Connect to Milvus/Zillis service.

Description
Type
Required
Default Value

host

Host parameter for connecting to Milvus.

string

password

Password parameter for connecting to Milvus.

string

port

Port parameter for connecting to Milvus.

integer

19530

service

Service type. Set to 'milvus'

string

✓

token

Token parameter for connecting to Zillis service.

string

url

Url parameter for connecting to Zillis service.

string

user

User parameter for connecting to Milvus.

string

default

OpenSearch (vector-database)

Connect to OpenSearch service or AWS OpenSearch Service/Serverless.

Description
Type
Required
Default Value

host

Host parameter for connecting to OpenSearch. Valid both for OpenSearch and AWS OpenSearch Service/Serverless.

string

✓

https

Whether to use https or not.

boolean

true

index-name

Name of the index to to connect to.

string

✓

password

Basic authentication for connecting to OpenSearch. In case of AWS OpenSearch Service/Serverless, this is the secret key.

string

port

Port parameter for connecting to OpenSearch service.

integer

9200

region

Region parameter for connecting to AWS OpenSearch Service/Serveless.

string

service

Service type. Set to 'opensearch'

string

✓

username

Basic authentication for connecting to OpenSearch. In case of AWS OpenSearch Service/Serverless, this is the access key.

string

Pinecone (vector-database)

Connect to Pinecone service.

Description
Type
Required
Default Value

api-key

Api key for connecting to the Pinecone service.

string

✓

endpoint

Endpoint of the Pinecone service.

string

environment

Environment parameter for connecting to the Pinecone service.

string

✓

index-name

Index name parameter for connecting to the Pinecone service.

string

✓

project-name

Project name parameter for connecting to the Pinecone service.

string

✓

server-side-timeout-sec

Server side timeout parameter for connecting to the Pinecone service.

integer

10

service

Service type. Set to 'pinecone'

string

✓

Solr (vector-database)

Connect to Solr or Solr Cloud service.

Description
Type
Required
Default Value

collection-name

Collection to use in Solr.

string

host

Host parameter for connecting to Solr.

string

password

Password parameter for connecting to Solr.

string

port

Port parameter for connecting to Solr.

integer

8983

service

Service type. Set to 'solr'

string

✓

user

Username parameter for connecting to Solr.

string

Vertex AI (vertex-configuration)

Connect to VertexAI API.

Description
Type
Required
Default Value

project

GCP project name for the Vertex API.

string

✓

region

GCP region for the Vertex API.

string

✓

serviceAccountJson

Specify service account credentials. Refer to the GCP documentation on how to download it

string

token

Access key for the Vertex API.

string

url

URL connection for the Vertex API.

string

✓

PreviousAgentsNextAssets

Last updated 1 year ago