Jump to Content
deepset Cloud
GuidesAPI and SDK Reference
Register to deepset CloudLog in to deepset Clouddeepset Cloud
Guides
Register to deepset CloudLog in to deepset Cloud
GuidesAPI and SDK Reference

Getting Started

  • What's deepset Cloud?
    • Feature List
  • What's New
    • Release 2024.7
    • Release 2024.4
    • Release 2024.3
    • Release 2024.2
    • Release 2024.1
    • Release 2023.12
    • Release 2023.11
    • Release 2023.8
    • Release 2023.7
  • Quick Start Guide
  • Working in deepset Cloud
  • Basic Concepts
  • Use Cases
    • Use Case: Generative AI Systems
    • Use Case: An Extractive Question Answering System
    • Use Case: A Document Search System
    • Use Case: Optimizing Knowledge Extraction with Batch QA
  • Pipeline Examples
    • Retrieval Augmented Generation (RAG) Question Answering Answering Pipelines
    • Document Search Pipelines
    • Extractive Question Answering Pipelines
    • Summarization Pipelines
  • Third-Party Software

Tutorials

  • Learn the Basics
    • Tutorial: Building Your First Question Answering App
    • Tutorial: Building Your First Document Search App
    • Tutorial: Building a Summarization System with a Large Language Model
    • Tutorial: Uploading Files with Metadata through SDK CLI
    • Tutorial: Creating an Experiment for a QA Pipeline
    • Tutorial: Creating an Evaluation Dataset for Document Search
    • Tutorial: Integrating deepset Cloud API with Your Frontend App
  • Learn More Advanced Features
    • Tutorial: Building a Robust RAG System
    • Tutorial: Uploading Files with Python Methods
    • Tutorial: Demoing Your App

How-To Guides

  • Designing Your Pipeline
    • Upload Files
    • Working with Metadata
      • Add Metadata to Your Files
      • Use Metadata in Your Search System
      • Filtering Logic
    • PreProcessing Data with Pipeline Nodes
    • Create a Pipeline
    • Edit a Pipeline
    • Using Large Language Models (LLMs)
      • Using Hosted LLMs in Your Pipelines
      • Enable References for Generated Answers
    • Using External Services
      • Use Azure Document Intelligence
      • Use Snowflake Database
    • Change the Pipeline's Service Level
    • Deploy a Pipeline
    • Troubleshoot Pipeline Deployment
  • Evaluating Your Pipeline
    • Upload an Evaluation Set
    • Create an Experiment Run
    • Review Your Experiments
    • Update an Experiment Run
    • Share a Pipeline Prototype
    • Collect User Feedback
    • Guidelines for Onboarding Your Users
    • Export Users' Feedback
    • Label Your Data
    • Label Answers
  • Optimizing Your Pipeline
    • Improving Your Document Search Pipeline
    • Engineering Prompts
      • Prompt Engineering Guidelines
    • Improving Your Question Answering Pipeline
    • Handling Different Query Types
    • Boosting Retrieval with OpenSearch Queries
  • Testing Your Pipeline
    • Test Your Pipeline in Playground
    • Set Default Pipeline
  • Productionizing Your Pipeline
    • Use Your Pipeline in Your Target App
    • Monitor Pipeline Performance
    • Synchronize Your Data
    • Check the Groundedness Score
    • Understand Your Pipeline Usage
  • Setting Up Your VPC
    • Connect Your OpenSearch Cluster
    • Connect Your S3 Bucket
  • Working with the SDK
    • Install the SDK
    • Using the Command-Line Interface (CLI)
      • Set Up the SDK CLI
      • Upload Files with CLI
      • Download Files with CLI
      • List Existing Files with CLI
    • Using Python Methods
      • Upload Files with Python
      • List Existing Files with Python
      • Get Upload Sessions Details
      • Download Files with Python
  • Working with Jobs
    • Prepare a Query Set
    • Create a Job
    • Share a Job
  • Managing Access
    • Manage Users
    • Connect to Service Providers
    • Generate an API Key

Concepts

  • About Pipelines
    • Pipeline Templates
  • Pipeline Nodes
    • AnswerDeduplication
    • Converters
    • InterleaveDocuments
    • DeepsetCloudDocumentStore
    • EntityExtractor
    • FileDownloader
    • FileTypeClassifier
    • JoinAnswers
    • JoinDocuments
    • PreProcessor
    • PromptNode
    • QueryClassifier
    • RetrievalScoreAdjuster
    • ReturnError
    • Ranker
    • Reader
    • ReferencePredictor
    • SnowflakeExecutor
    • Retriever
    • Shaper
  • About Experiments
    • Evaluation Metrics
    • Evaluation Datasets
    • Labeling Projects
    • Guidelines for Labeling Data
    • Relevance Scores
  • About Jobs
  • Data Flow in deepset Cloud
  • Language Models in deepset Cloud

Learn

  • Retrieval Augmented Generation (RAG) Question Answering
  • Document Search
  • Extractive Question Answering
  • Building an AI-Based App
    • Components of an AI-Based App
    • 5-Step Guide to Building a Successful Prototype
  • Language Models
    • Large Language Models Overview

Managing Access

Grant access to your deepset Cloud workspace to users and apps. Connect to model providers and learn how to obtain the API key.

Suggest Edits

Manage Users

Connect to Model Providers

Generate an API Key

Updated about 1 year ago


  • Open Source
  • Haystack
  • Annotation Tool
  • Resources
  • Models
  • Datasets
  • FARM
  • Company
  • Blog
  • About
  • Jobs

Building a semantic layer for the modern tech stack — driven by the latest NLP and open source.

  • Privacy
  • Imprint
© 2024 deepset GmbH. All rights reserved.