Overview Use Cases Connectors Authentication Getting Started with the Python SDK API Reference API Classes AbacusApi Address Agent AgentChatMessage AgentConversation AgentDataDocumentInfo AgentDataExecutionResult AgentVersion AiBuildingTask Algorithm Annotation AnnotationConfig AnnotationDocument AnnotationEntry AnnotationsStatus ApiEndpoint ApiKey AppUserGroup ApplicationConnector BatchPrediction BatchPredictionVersion BatchPredictionVersionLogs BotInfo CategoricalRangeViolation ChatMessage ChatSession ChatllmReferralInvite CodeAutocompleteResponse NlpChatResponse CodeEditResponse CodeSource ComputePointInfo ConcatenationConfig CustomChatInstructions CustomLossFunction CustomMetric CustomMetricVersion CustomTrainFunctionInfo DataConsistencyDuplication DataMetrics DataPrepLogs DataQualityResults DataUploadResult DatabaseColumnFeatureMapping DatabaseConnector DatabaseConnectorColumn DatabaseConnectorSchema Dataset DatasetColumn DatasetVersion DatasetVersionLogs Deployment DeploymentAuthToken DeploymentConversation DeploymentConversationEvent DeploymentConversationExport DeploymentStatistics DocumentData DocumentRetriever DocumentRetrieverConfig DocumentRetrieverLookupResult DocumentRetrieverVersion DriftDistribution DriftDistributions Eda EdaChartDescription EdaCollinearity EdaDataConsistency EdaFeatureAssociation EdaFeatureCollinearity EdaForecastingAnalysis EdaVersion EmbeddingFeatureDriftDistribution ExecuteFeatureGroupOperation ExternalApplication ExternalInvite ExtractedFields Feature FeatureDistribution FeatureDriftRecord FeatureDriftSummary FeatureGroup FeatureGroupDocument FeatureGroupExport FeatureGroupExportConfig FeatureGroupRefreshExportConfig FeatureGroupExportDownloadUrl IndexingConfig FeatureGroupLineage FeatureGroupRow FeatureGroupRowProcess FeatureGroupRowProcessLogs FeatureGroupRowProcessSummary FeatureGroupTemplate FeatureGroupTemplateVariableOptions FeatureGroupVersion FeatureGroupVersionLogs FeatureImportance FeatureMapping FeaturePerformanceAnalysis FeatureRecord Schema FileConnector FileConnectorInstructions FileConnectorVerification FinetunedPretrainedModel ForecastingAnalysisGraphData ForecastingMonitorItemAnalysis ForecastingMonitorSummary FunctionLogs GeneratedPitFeatureConfigOption GraphDashboard HoldoutAnalysis HoldoutAnalysisVersion HostedModelToken ImageGenSettings InferredDatabaseColumnToFeatureMappings InferredFeatureMappings ItemStatistics LlmApp LlmCodeBlock LlmExecutionPreview LlmExecutionResult LlmGeneratedCode LlmInput LlmParameters LlmResponse MemoryOptions CpuGpuMemorySpecs MessagingConnectorResponse Model ModelArtifactsExport ModelBlueprintExport ModelBlueprintStage ModelLocation ModelMetrics ModelMonitor ModelMonitorOrgSummary ModelMonitorSummary ModelMonitorSummaryFromOrg ModelMonitorVersion ModelMonitorVersionMetricData ModelTrainingTypeForDeployment ModelUpload ModelVersion ModelVersionFeatureGroupSchema ModificationLockInfo Module MonitorAlert MonitorAlertVersion MonitorDriftAndDistributions NaturalLanguageExplanation NestedFeature NestedFeatureSchema NewsSearchResult NotebookCompletion NotebookTemplate NullViolation OrganizationExternalApplicationSettings OrganizationGroup OrganizationSearchResult OrganizationSecret PageData Pipeline PipelineReference PipelineStep PipelineStepVersion PipelineStepVersionReference PipelineVersion PipelineVersionLogs PlaygroundText PointInTimeFeature PointInTimeFeatureInfo PointInTimeGroup PointInTimeGroupFeature PredictionDataset PredictionFeatureGroup PredictionInput PredictionLogRecord PredictionOperator PredictionOperatorVersion ProblemType Project ProjectConfig ProjectFeatureGroup ProjectFeatureGroupSchema ProjectValidation PythonFunction PythonPlotFunction RangeViolation RealtimeMonitor RefreshPipelineRun RefreshPolicy RefreshSchedule RegenerateLlmExternalApplication ResolvedFeatureGroupTemplate RoutingAction ProjectFeatureGroupSchemaVersion PipelineStepVersionLogs StreamingAuthToken StreamingConnector StreamingRowCount StreamingSampleCode TemplateNodeDetails TestPointPredictions ToneDetails TrainingConfigOptions TwitterSearchResult Upload UploadPart UseCase UseCaseRequirements User UserException VideoGenSettings VideoSearchResult WebSearchResponse WebSearchResult Webhook WorkflowNodeTemplate API Inputs Documentation Chat Bot API Search Video Tutorials ChatLLM

DocumentRetriever

A vector store that stores embeddings for a list of document trunks.

KEY	TYPE	Description
name	str	The name of the document retriever.
documentRetrieverId	str	The unique identifier of the vector store.
createdAt	str	When the vector store was created.
featureGroupId	str	The feature group id associated with the document retriever.
featureGroupName	str	The feature group name associated with the document retriever.
indexingRequired	bool	Whether the document retriever is required to be indexed due to changes in underlying data.
latestDocumentRetrieverVersion	DocumentRetrieverVersion	The latest version of vector store.
documentRetrieverConfig	DocumentRetrieverConfig	The config for vector store creation.