KnowledgeSourceIngestionParameters Class
Definition
Important
Some information relates to prerelease product that may be substantially modified before it’s released. Microsoft makes no warranties, express or implied, with respect to the information provided here.
Consolidates all general ingestion settings for knowledge sources.
public class KnowledgeSourceIngestionParameters : System.ClientModel.Primitives.IJsonModel<Azure.Search.Documents.Indexes.Models.KnowledgeSourceIngestionParameters>, System.ClientModel.Primitives.IPersistableModel<Azure.Search.Documents.Indexes.Models.KnowledgeSourceIngestionParameters>type KnowledgeSourceIngestionParameters = class
interface IJsonModel<KnowledgeSourceIngestionParameters>
interface IPersistableModel<KnowledgeSourceIngestionParameters>Public Class KnowledgeSourceIngestionParameters
Implements IJsonModel(Of KnowledgeSourceIngestionParameters), IPersistableModel(Of KnowledgeSourceIngestionParameters)- Inheritance
-
KnowledgeSourceIngestionParameters
- Implements
Constructors
| Name | Description |
|---|---|
| KnowledgeSourceIngestionParameters() |
Initializes a new instance of KnowledgeSourceIngestionParameters. |
Properties
| Name | Description |
|---|---|
| AiServices |
Optional AI Services configuration for content processing. |
| ChatCompletionModel |
Optional chat completion model for image verbalization or context extraction. Please note KnowledgeBaseModel is the base class. According to the scenario, a derived class of the base class might need to be assigned here, or this property needs to be casted to one of the possible derived classes. The available derived classes include KnowledgeBaseAzureOpenAIModel. |
| ContentExtractionMode |
Optional content extraction mode. Default is 'minimal'. |
| DisableImageVerbalization |
Indicates whether image verbalization should be disabled. Default is false. |
| EmbeddingModel |
Optional vectorizer configuration for vectorizing content. Please note KnowledgeSourceVectorizer is the base class. According to the scenario, a derived class of the base class might need to be assigned here, or this property needs to be casted to one of the possible derived classes. The available derived classes include KnowledgeSourceAzureOpenAIVectorizer. |
| Identity |
An explicit identity to use for this knowledge source. Please note SearchIndexerDataIdentity is the base class. According to the scenario, a derived class of the base class might need to be assigned here, or this property needs to be casted to one of the possible derived classes. The available derived classes include SearchIndexerDataNoneIdentity and SearchIndexerDataUserAssignedIdentity. |
| IngestionPermissionOptions |
Optional list of permission types to ingest together with document content. If specified, it will set the indexer permission options for the data source. |
| IngestionSchedule |
Optional schedule for data ingestion. |
Methods
| Name | Description |
|---|---|
| JsonModelWriteCore(Utf8JsonWriter, ModelReaderWriterOptions) | |
Explicit Interface Implementations
| Name | Description |
|---|---|
| IJsonModel<KnowledgeSourceIngestionParameters>.Create(Utf8JsonReader, ModelReaderWriterOptions) |
Reads one JSON value (including objects or arrays) from the provided reader and converts it to a model. |
| IJsonModel<KnowledgeSourceIngestionParameters>.Write(Utf8JsonWriter, ModelReaderWriterOptions) |
Writes the model to the provided Utf8JsonWriter. |
| IPersistableModel<KnowledgeSourceIngestionParameters>.Create(BinaryData, ModelReaderWriterOptions) |
Converts the provided BinaryData into a model. |
| IPersistableModel<KnowledgeSourceIngestionParameters>.GetFormatFromOptions(ModelReaderWriterOptions) |
Gets the data interchange format (JSON, Xml, etc) that the model uses when communicating with the service. |
| IPersistableModel<KnowledgeSourceIngestionParameters>.Write(ModelReaderWriterOptions) |
Writes the model into a BinaryData. |
