Jump to Content
deepset Cloud
GuidesAPI and SDK Reference
RegisterLog indeepset Cloud
API and SDK Reference
RegisterLog in
GuidesAPI and SDK Reference

Essentials

  • Structure and Authorization
  • Change Management
  • Quick Reference
  • Status and Error Codes
  • Pagination, Timeouts, and Date-Time Format

deepset AI Platform

  • haystack
    • Get Available Componentsget
    • Get Components Input Outputget
    • Create Components Dynamic Input Outputpost
  • infrastructure
    • List OpenSearch credentialsget
    • Add OpenSearch credentialspost
    • Delete OpenSearch credentialsdelete
    • List Available S3 Credentialsget
    • Add S3 Credentialspost
    • Delete S3 Credentialsdelete
  • user
    • Read Users Meget
    • Get Usersget
    • Delete Userdelete
    • Get Userget
    • Update User Permissionpatch
    • Assign Rolepost
    • Remove Rolepost
  • models
    • Get Modelget
  • model_registry_token
    • Remove Token Deprecateddelete
    • Get Token Deprecatedget
    • Save Token Deprecatedpost
    • Update Token Deprecatedput
    • Get Tokensget
    • Remove Tokendelete
    • Get Tokenget
    • Save Tokenpost
    • Update Tokenput
  • organization
    • Get Organizationget
    • Invite User To Organizationpost
    • Create Support Requestpost
  • pipeline_utils
    • Generate Integrated Pipeline Yamlpost
  • prompts
    • List Public Prompt Templatesget
    • Trigger Prompthub Syncpost
    • List Prompt Templatesget
    • Create Prompt Templatepost
    • Delete Prompt Templatesdelete
    • Update Prompt Templateput
  • api_token
    • Get Tokensget
    • Create Tokenpost
    • Remove Tokendelete
  • workspace
    • List Workspacesget
    • Create Workspacepost
    • Delete Workspacedelete
    • Get Workspaceget
    • Search Countget
    • Search Historyget
    • Get Workspace Statsget
  • datasets
    • List Datasetsget
    • Add Filespost
  • file
    • Delete Filesdelete
    • List Filesget
    • Upload Filepost
    • Search Filespost
    • Update File Meta Bulkpost
    • Delete Filedelete
    • Get Fileget
    • Get File Metaget
    • Update File Metapatch
  • document_store
    • Get Indexesget
    • Create Indexpost
    • Delete Indexdelete
    • Get Index By Nameget
    • Update Indexpatch
    • Deploy Indexpost
    • Count Documentsget
    • Count Documents Deprecatedpost
    • Query Documentspost
    • Get All Documents Streampost
    • Get Documentget
    • Get Indexed Files By Statusget
    • Schedule Single File For Indexingpost
    • Get Pipeline Index Logsget
    • Undeploy Indexpost
  • pipeline_templates
    • List Pipeline Templatesget
    • Get Pipeline Templateget
  • pipeline
    • Validate Pipelinepost
    • List Pipelinesget
    • Create Pipelinepost
    • Delete Pipelinedelete
    • Get Pipelineget
    • Update Pipelinepatch
    • Activate Pipelinepost
    • Chatpost
    • Chat Streampost
    • Set Default Pipelinepost
    • Deploy Pipelinepost
    • Get Pipeline Filesget
    • Get Pipeline Indexingget
    • Get Pipeline Issuesget
    • Get Pipeline Logsget
    • Get Pipeline Index Metadataget
    • Get Pipeline Metadata Field Valuesget
    • Get Pipeline Min Max Aggregation Metadataget
    • Get Promptget
    • Get Promptsget
    • Searchpost
    • Search Streampost
    • Pipeline Search Historyget
    • Pipeline Search History Archiveget
    • Get Pipeline Statsget
    • Undeploy Pipelinepost
    • Get Pipeline Yaml Configsget
    • Update Pipeline Yamlput
    • Delete Pipeline Search Historydelete
    • Pipeline Search History Resultget
  • search_session
    • Get Search Sessionsget
    • Create Search Sessionpost
    • Delete Search Sessiondelete
  • shared_prototype
    • List Prototypesget
    • Create Prototypepost
    • Revoke Shared Prototypedelete
    • Get Shared Prototypeget
    • Edit Shared Prototypepatch
  • upload_session
    • Get Upload Sessionsget
    • Create Upload Sessionpost
    • Get Session Statusget
    • Close Sessionput
    • Get Session Filesget
  • custom_components
    • Get Custom Componentsget
    • Import Custom Componentspost
    • Get Custom Component Logsget
    • Get Custom Componentget
  • secrets
    • Get Secretsget
    • Create Secretpost
    • Remove Secretdelete
    • Get Secretget
  • debug_tunnel
    • Start Debug Tunnelpost
  • health
    • Healthget

Jobs

  • jobs
    • Get Jobsget
    • Create Jobpost
    • Delete Jobdelete
    • Get Jobget
    • Update Jobpatch
    • Get Job Resultsget
    • Get Export Job Results To Csvget
    • Start Jobpost
  • shared_job
    • Create Shared Jobpost
    • Get Shared Jobsget
    • Get Shared Jobget
    • Edit Shared Jobpatch
    • Revoke Shared Jobpost
  • query_sets
    • Get Query Setsget
    • Import Query Setpost
    • Get Query Setget

Feedback

  • feedback
    • Get Paginated Feedbackget
    • Create Feedbackpost
    • Export Feedbackget
    • Get Pipeline Feedback Statsget
    • Delete Feedbackdelete
    • Update Feedbackpatch
  • tags
    • Get Paginated Tagsget
    • Create Tagspost
    • Delete Tagsdelete

Custom Components

  • custom_components
    • Get Custom Componentsget
    • Import Custom Componentspost
    • Get Custom Component Logsget
    • Get Custom Componentget

OPEN SOURCE SDK

  • Data Classes
  • Asynchronous Client
  • Synchronous Client
  • deepset AI Platform CLI

Generators Parameters

AmazonBedrockGenerator Parameters

AzureOpenAIGenerator Parameters

CohereGenerator Parameters

DeepsetAmazonBedrockGenerator Parameters

NvidiaGenerator

OpenAIGenerator Parameters

SagemakerGenerator Parameters

  • Open Source
  • Haystack
  • 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.