JUMP TOEssentialsStructure and AuthorizationChange ManagementQuick ReferenceStatus and Error CodesPagination, Timeouts, and Date-Time FormatDeepset CloudhealthRedirectgetHealthgethaystackGet Available Components [beta]getGet Components Input Output [beta]getCreate Components Dynamic Input Output [beta]postinfrastructureList OpenSearch credentialsgetAdd OpenSearch credentialspostDelete OpenSearch credentialsdeleteList Available S3 CredentialsgetAdd S3 CredentialspostDelete S3 CredentialsdeleteuserRead Users MegetGet UsersgetDelete UserdeleteGet UsergetUpdate User PermissionpatchmodelsGet Modelgetmodel_registry_tokenRemove Token DeprecateddeleteGet Token DeprecatedgetSave Token DeprecatedpostUpdate Token DeprecatedputGet TokensgetRemove TokendeleteGet TokengetSave TokenpostUpdate TokenputnotebookPost NotebookpostGet Jupyter LabgetStart Jupyter LabpostorganizationGet OrganizationgetInvite User To OrganizationpostCreate Support RequestpostpromptsList Public Prompt TemplatesgetTrigger Prompthub SyncpostList Prompt TemplatesgetCreate Prompt TemplatepostDelete Prompt TemplatesdeleteUpdate Prompt Templateputapi_tokenGet TokensgetCreate TokenpostRemove TokendeleteworkspaceList WorkspacesgetCreate WorkspacepostDelete WorkspacedeleteGet WorkspacegetSearch CountgetSearch HistorygetGet Workspace Statsgeteval_runGet Eval RunsgetCreate Eval RunpostDelete Eval RundeleteGet Eval RungetEdit Eval RunpatchGet Node Eval PredictionsgetStart Eval RunpostGet TagsgetCreate TagpostDelete TagdeleteUpdate Tagpatchevaluation_setGet Evaluation SetsgetImport Evaluation SetpostDelete Evaluation SetdeleteGet Evaluation SetgetGet Evaluation Set Csv FilegetRetrigger Label MatchingpostfileDelete FilesdeleteList FilesgetUpload FilepostDelete FiledeleteGet FilegetGet File MetagetUpdate File Metapatchdocument_storeCheck ConnectiongetCount DocumentspostQuery DocumentspostGet All Documents StreampostGet Documentgetlabeling_projectGet Labeling ProjectsgetCreate Labeling ProjectpostDelete Labeling ProjectdeleteGet Labeling ProjectgetUpdate Labeling Projectputpipeline_templatesList Pipeline TemplatesgetGet Pipeline TemplategetpipelineValidate PipelinepostList PipelinesgetCreate PipelinepostDelete PipelinedeleteGet PipelinegetUpdate PipelinepatchActivate PipelinepostChatpostChat StreampostSet Default PipelinepostDeploy PipelinepostGet Pipeline FeedbackgetAdd FeedbackpostGet Pipeline FilesgetGet Pipeline IndexinggetGet Pipeline IssuesgetGet Pipeline Yaml As JsongetGet Pipeline LogsgetGet Pipeline Index MetadatagetGet Pipeline Metadata Field ValuesgetGet Pipeline Min Max Aggregation MetadatagetGet PromptgetGet PromptsgetSearchpostSearch StreampostPipeline Search HistorygetPipeline Search History ArchivegetGet Pipeline StatsgetUndeploy PipelinepostGet Pipeline Yaml ConfigsgetUpdate Pipeline YamlputPipeline Search History Resultgetsearch_sessionGet Search SessionsgetCreate Search SessionpostDelete Search Sessiondeleteshared_prototypeList PrototypesgetCreate PrototypepostRevoke Shared PrototypedeleteGet Shared PrototypegetEdit Shared Prototypepatchupload_sessionGet Upload SessionsgetCreate Upload SessionpostGet Session StatusgetClose SessionputGet Session FilesgetJobsjobsGet Jobs [private]getCreate Job [private]postDelete Job [private]deleteGet Job [private]getUpdate Job [private]patchGet Job Results [private]getGet Export Job Results To Csv [private]getStart Job [private]postshared_jobCreate Shared Job [private]postGet Shared Jobs [private]getGet Shared Job [private]getEdit Shared Job [private]patchRevoke Shared Job [private]postquery_setsGet Query Sets [private]getImport Query Set [private]postGet Query Set [private]getFeedbackfeedbackGet Paginated FeedbackgetCreate FeedbackpostExport FeedbackgetGet Pipeline Feedback StatsgetDelete FeedbackdeleteUpdate FeedbackpatchtagsGet Paginated TagsgetCreate TagspostDelete TagsdeleteCustom Componentscustom_componentsGet Custom ComponentsgetImport Custom ComponentspostGet Custom ComponentgetComponents ParametersConfiguring Components' ParametersAugmenters ParametersSnowflakeExecutor ParametersBuilders ParametersAnswerBuilder ParametersDeepsetAnswerBuilder ParametersPromptBuilder ParametersCleaners and Splitters ParametersDocumentCleaner ParametersDocumentSplitter ParametersConverters ParametersAzureOCRDocumentConverter ParametersHTMLToDocument ParametersMarkdownToDocument ParametersOutputAdapter ParametersPyPDFToDocument ParametersTextFileToDocument ParametersUnstructuredFileConverter ParametersClassifiers ParametersDocumentLanguageClassifier ParametersContent Fetchers ParametersLinkContentFetcher ParametersData Extractors ParametersExtractiveReader ParametersNamedEntityExtractor ParametersDocumentWriter ParametersEmbedders ParametersAmazonBedrockDocumentEmbedder ParametersAmazonBedrockTextEmbedder ParametersAzureOpenAIDocumentEmbedder ParametersAzureOpenAITextEmbedder ParametersCohereDocumentEmbedder ParametersCohereTextEmbedder ParametersNvidiaTextEmbedder ParametersNvidiaDocumentEmbedder ParametersOpenAIDocumentEmbedder ParametersOpenAITextEmbedder ParametersSentenceTransformersDocumentEmbedder ParametersSentenceTransformersTextEmbedder ParametersGenerators ParametersAmazonBedrockGenerator ParametersAzureOpenAIGenerator ParametersCohereGenerator ParametersDeepsetAmazonBedrockGenerator ParametersNvidiaGenerator ParametersOpenAIGenerator ParametersSagemakerGenerator ParametersJoiners ParametersBranchJoiner ParametersDocumentJoiner ParametersGoogleAIGeminiGenerator ParametersRankers ParametersCohereRanker ParametersLostInTheMiddleRanker ParametersMetaFieldRanker ParametersSentenceTransformersDiversityRanker ParametersTopPSampler ParametersTransformersSimilarityRanker ParametersRetrievers ParametersFilterRetriever ParametersOpenSearchBM25Retriever ParametersOpenSearchEmbeddingRetriever ParametersOpenSearchDocumentStore ParametersRouters ParametersConditionalRouter ParametersFileTypeRouter ParametersMetadataRouter ParametersTransformersTextRouter ParametersTransformersZeroShotTextRouter ParametersTextLanguageRouter ParametersReferencePredictor ParametersOPEN SOURCE SDKData ClassesAsynchronous ClientSynchronous Clientdeepset Cloud CLIRetrievers ParametersFilterRetriever Parameters OpenSearchBM25Retriever Parameters OpenSearchEmbeddingRetriever Parameters OpenSearchDocumentStore Parameters
