Overview Use Cases Connectors Authentication Getting Started with the Python SDK API API Reference API Classes API Inputs AIAgentBatchPredictionArgs AIAgentTrainingConfig AbacusUsageMetricsDatasetConfig AccuracyBelowThresholdConditionConfig AgentConversationMessage AgentFlowButtonResponseSection AlertActionConfig AlertConditionConfig ApplicationConnectorDatasetConfig AttachmentParsingConfig Base64ImageResponseSection BatchPredictionArgs BiasViolationConditionConfig Blob BlobInput ChartResponseSection ChatLLMBatchPredictionArgs ChatLLMPredictionArguments ChatLLMTrainingConfig ClusteringTimeseriesTrainingConfig ClusteringTrainingConfig CodeResponseSection CollapseResponseSection ConfluenceDatasetConfig ConstraintConfig ConstraintProjectFeatureGroupConfig CrawlerTransformConfig CumulativeForecastingPredictionArguments CumulativeForecastingTrainingConfig CustomAlgorithmTrainingConfig CustomTrainedModelTrainingConfig DataGenerationConfig DataIntegrityViolationConditionConfig DatabaseConnectorExportConfig DataframeResponseSection DatasetConfig DatasetDocumentProcessingConfig DeployableAlgorithm DocumentClassificationTrainingConfig DocumentProcessingConfig DocumentRetrieverConfig DocumentSummarizationTrainingConfig DocumentVisualizationTrainingConfig EmailActionConfig EventAnomalyTrainingConfig ExtractDocumentDataConfig FeatureDriftConditionConfig FeatureGroupExportConfig FeatureMappingConfig FeatureStorePredictionArguments FieldDescriptor FileConnectorExportConfig ForecastingBatchPredictionArgs ForecastingMonitorConfig ForecastingPredictionArguments ForecastingTrainingConfig FreshserviceDatasetConfig GoogleAnalyticsDatasetConfig GoogleDriveDatasetConfig HistoryLengthDriftConditionConfig HotkeyPrompt ImageUrlResponseSection IncrementalDatabaseConnectorConfig ItemAttributesStdDevThreshold JSONSchema JiraDatasetConfig KafkaDatasetConfig LastNMergeConfig ListResponseSection MarkdownConfig MergeConfig MonitorFilteringConfig MonitorThresholdConfig NSamplingConfig NamedEntityExtractionBatchPredictionArgs NamedEntityExtractionTrainingConfig NaturalLanguageSearchPredictionArguments NaturalLanguageSearchTrainingConfig OneDriveDatasetConfig OperatorConfig OptimizationPredictionArguments OptimizationTrainingConfig OutputVariableMapping ParsingConfig PercentSamplingConfig PersonalizationBatchPredictionArgs PersonalizationTrainingConfig PredictionArguments PredictionCountConditionConfig PredictiveModelingBatchPredictionArgs PretrainedModelsBatchPredictionArgs ProjectFeatureGroupConfig ProjectFeatureGroupTypeMappingsConfig PythonFunctionArgument RegressionPredictionArguments RegressionTrainingConfig ResponseSection RestrictFeatureMappings ReviewModeProjectFeatureGroupConfig RuntimeSchemaResponseSection SamplingConfig Segment SentenceBoundaryDetectionBatchPredictionArgs SentenceBoundaryDetectionTrainingConfig SentimentDetectionTrainingConfig SharepointDatasetConfig StdDevThreshold StreamingConnectorDatasetConfig TargetDriftConditionConfig TeamsScraperDatasetConfig TextResponseSection ThemeAnalysisBatchPredictionArgs ThemeAnalysisTrainingConfig TimeWindowConfig TimeWindowMergeConfig TimeseriesAnomalyPredictionArguments TimeseriesAnomalyTrainingConfig TrainablePlugAndPlayBatchPredictionArgs TrainingConfig UnionTransformConfig UnpivotConfig VectorStoreConfig WorkflowGraph WorkflowGraphEdge WorkflowGraphNode WorkflowNodeInputMapping WorkflowNodeInputSchema WorkflowNodeOutputMapping WorkflowNodeOutputSchema WorkflowNodeTemplateConfig WorkflowNodeTemplateInput WorkflowNodeTemplateOutput ZendeskDatasetConfig Documentation Chat Bot API Search How to

FieldDescriptor

Configs for vector store indexing.

KEY	TYPE	Description
type	FieldDescriptorType	The type of this field. If not provided, the default type is STRING.
field	str	The field to be extracted. This will be used as the key in the response.
description	str	The description of this field. If not included, the response_field will be used.
exampleExtraction	Union[str, int, bool, float]	An example of this extracted field.