IndexedSqlKnowledgeSourceParameters Class

Parameters for indexed SQL knowledge source.

Constructor

IndexedSqlKnowledgeSourceParameters(*args: Any, **kwargs: Any)

Variables

Name Description
connection_string
str

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

table_or_view
str

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

high_water_mark_column_name
str

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

content_columns

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

embedding_columns

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

ingestion_parameters

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

query_hints

Default hints that guide query planning toward useful filters and boosts for this index-backed knowledge source. Request-time query hints replace these defaults as a complete object.

created_resources

Resources created by the knowledge source.

Methods

as_dict

Return a dict that can be turned into json using json.dump.

clear

Remove all items from the dictionary.

copy
get

Get the value for key if key is in the dictionary, else default. :param str key: The key to look up. :param any default: The value to return if key is not in the dictionary. Defaults to None :returns: The value for key if key is in the dictionary, else default. :rtype: any

items
keys
pop

Removes specified key and return the corresponding value. :param str key: The key to pop. :param any default: The value to return if key is not in the dictionary :returns: The value corresponding to the key. :rtype: any :raises KeyError: If key is not found and default is not given.

popitem

Removes and returns some (key, value) pair :returns: The (key, value) pair. :rtype: tuple :raises KeyError: if the dictionary is empty.

setdefault

Return the value for key if key is in the dictionary; otherwise set the key to default and return default. :param str key: The key to look up. :param any default: The value to set if key is not in the dictionary :returns: The value for key if key is in the dictionary, else default. :rtype: any

update

Update the dictionary from a mapping or an iterable of key-value pairs. :param any args: Either a mapping object or an iterable of key-value pairs.

values

as_dict

Return a dict that can be turned into json using json.dump.

as_dict(*, exclude_readonly: bool = False) -> dict[str, Any]

Keyword-Only Parameters

Name Description
exclude_readonly

Whether to remove the readonly properties.

Default value: False

Returns

Type Description

A dict JSON compatible object

clear

Remove all items from the dictionary.

clear() -> None

copy

copy() -> Model

get

Get the value for key if key is in the dictionary, else default. :param str key: The key to look up. :param any default: The value to return if key is not in the dictionary. Defaults to None :returns: The value for key if key is in the dictionary, else default. :rtype: any

get(key: str, default: Any = None) -> Any

Parameters

Name Description
key
Required
default
Default value: None

items

items() -> ItemsView[str, Any]

Returns

Type Description

a set-like object providing a view on the mapping's items

keys

keys() -> KeysView[str]

Returns

Type Description

a set-like object providing a view on the mapping's keys

pop

Removes specified key and return the corresponding value. :param str key: The key to pop. :param any default: The value to return if key is not in the dictionary :returns: The value corresponding to the key. :rtype: any :raises KeyError: If key is not found and default is not given.

pop(key: str, default: ~typing.Any = <object object>) -> Any

Parameters

Name Description
key
Required
default

popitem

Removes and returns some (key, value) pair :returns: The (key, value) pair. :rtype: tuple :raises KeyError: if the dictionary is empty.

popitem() -> tuple[str, Any]

setdefault

Return the value for key if key is in the dictionary; otherwise set the key to default and return default. :param str key: The key to look up. :param any default: The value to set if key is not in the dictionary :returns: The value for key if key is in the dictionary, else default. :rtype: any

setdefault(key: str, default: ~typing.Any = <object object>) -> Any

Parameters

Name Description
key
Required
default

update

Update the dictionary from a mapping or an iterable of key-value pairs. :param any args: Either a mapping object or an iterable of key-value pairs.

update(*args: Any, **kwargs: Any) -> None

values

values() -> ValuesView[Any]

Returns

Type Description

an object providing a view on the mapping's values

Attributes

connection_string

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

connection_string: str

content_columns

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

content_columns: list['_models.ContentColumnMapping'] | None

created_resources

Resources created by the knowledge source.

created_resources: _models.CreatedResources | None

embedding_columns

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

embedding_columns: list['_models.EmbeddingColumnMapping'] | None

high_water_mark_column_name

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

high_water_mark_column_name: str | None

ingestion_parameters

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

ingestion_parameters: _knowledgebases_models3.KnowledgeSourceIngestionParameters | None

query_hints

Default hints that guide query planning toward useful filters and boosts for this index-backed knowledge source. Request-time query hints replace these defaults as a complete object.

query_hints: _models.SearchIndexKnowledgeSourceQueryHints | None

table_or_view

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

table_or_view: str