IndexedSqlKnowledgeSourceParameters Class

Definition

Parameters for indexed SQL knowledge source.

public class IndexedSqlKnowledgeSourceParameters : System.ClientModel.Primitives.IJsonModel<Azure.Search.Documents.Indexes.Models.IndexedSqlKnowledgeSourceParameters>, System.ClientModel.Primitives.IPersistableModel<Azure.Search.Documents.Indexes.Models.IndexedSqlKnowledgeSourceParameters>
type IndexedSqlKnowledgeSourceParameters = class
    interface IJsonModel<IndexedSqlKnowledgeSourceParameters>
    interface IPersistableModel<IndexedSqlKnowledgeSourceParameters>
Public Class IndexedSqlKnowledgeSourceParameters
Implements IJsonModel(Of IndexedSqlKnowledgeSourceParameters), IPersistableModel(Of IndexedSqlKnowledgeSourceParameters)
Inheritance
IndexedSqlKnowledgeSourceParameters
Implements

Constructors

Name Description
IndexedSqlKnowledgeSourceParameters(String, String)

Initializes a new instance of IndexedSqlKnowledgeSourceParameters.

Properties

Name Description
ConnectionString

The connection string for the Azure SQL Database or SQL Managed Instance.

ContentColumns

Optional column mappings for content fields. If omitted, all columns are auto-discovered.

CreatedResources

Resources created by the knowledge source.

EmbeddingColumns

Optional column mappings for embedding vector fields. If omitted, no vector fields are created.

HighWaterMarkColumnName

Optional column name for high water mark change detection. If provided, uses HighWaterMarkChangeDetectionPolicy.

IngestionParameters

Consolidates all general ingestion settings including embedding model, schedule, and identity.

TableOrView

The name of the table or view to index. Can be schema-qualified (e.g., 'dbo.MyTable').

Methods

Name Description
JsonModelCreateCore(Utf8JsonReader, ModelReaderWriterOptions)
JsonModelWriteCore(Utf8JsonWriter, ModelReaderWriterOptions)
PersistableModelCreateCore(BinaryData, ModelReaderWriterOptions)
PersistableModelWriteCore(ModelReaderWriterOptions)

Explicit Interface Implementations

Name Description
IJsonModel<IndexedSqlKnowledgeSourceParameters>.Create(Utf8JsonReader, ModelReaderWriterOptions)
IJsonModel<IndexedSqlKnowledgeSourceParameters>.Write(Utf8JsonWriter, ModelReaderWriterOptions)
IPersistableModel<IndexedSqlKnowledgeSourceParameters>.Create(BinaryData, ModelReaderWriterOptions)
IPersistableModel<IndexedSqlKnowledgeSourceParameters>.GetFormatFromOptions(ModelReaderWriterOptions)
IPersistableModel<IndexedSqlKnowledgeSourceParameters>.Write(ModelReaderWriterOptions)

Applies to