AzureAISearchDataSourceParameters Class

Reference

Azure AI Search data source parameters.

Create a new model by parsing and validating input data from keyword arguments.

Raises [ValidationError][pydantic_core.ValidationError] if the input data cannot be validated to form a valid model.

self is explicitly positional-only to allow self as a field name.

Inheritance: AzureDataSourceParameters

AzureAISearchDataSourceParameters

Constructor

AzureAISearchDataSourceParameters(*, indexName: str, indexLanguage: str | None = None, fieldsMapping: DataSourceFieldsMapping | None = None, inScope: bool | None = True, topNDocuments: int | None = 5, semanticConfiguration: str | None = None, roleInformation: str | None = None, filter: str | None = None, strictness: int = 3, embeddingDependency: AzureEmbeddingDependency | None = None, endpoint: str | None = None, queryType: Annotated[Literal['simple', 'semantic', 'vector', 'vectorSimpleHybrid', 'vectorSemanticHybrid'], AfterValidator(func=to_snake)] = 'simple', authentication: ApiKeyAuthentication | SystemAssignedManagedIdentityAuthentication | UserAssignedManagedIdentityAuthentication | AccessTokenAuthentication | None = None, **extra_data: Any)

Keyword-Only Parameters

Name	Description
indexName Required
indexLanguage Required
fieldsMapping Required
inScope	Default value: True
topNDocuments	Default value: 5
semanticConfiguration Required
roleInformation Required
filter Required
strictness	Default value: 3
embeddingDependency Required
endpoint Required
queryType	Default value: simple
authentication Required

Attributes

model_computed_fields

A dictionary of computed field names and their corresponding ComputedFieldInfo objects.

model_computed_fields: ClassVar[Dict[str, ComputedFieldInfo]] = {}

model_config

Configuration for the model, should be a dictionary conforming to [ConfigDict][pydantic.config.ConfigDict].

model_config: ClassVar[ConfigDict] = {'alias_generator': AliasGenerator(alias=None, validation_alias=<function to_camel>, serialization_alias=<function to_snake>), 'arbitrary_types_allowed': True, 'extra': 'allow', 'populate_by_name': True, 'use_enum_values': True, 'validate_assignment': True}

model_fields

Metadata about the fields defined on the model, mapping of field names to [FieldInfo][pydantic.fields.FieldInfo] objects.

This replaces Model.fields from Pydantic V1.

model_fields: ClassVar[Dict[str, FieldInfo]] = {'authentication': FieldInfo(annotation=Union[ApiKeyAuthentication, SystemAssignedManagedIdentityAuthentication, UserAssignedManagedIdentityAuthentication, AccessTokenAuthentication, NoneType], required=False, default=None, alias_priority=1, validation_alias='authentication', serialization_alias='authentication'), 'embedding_dependency': FieldInfo(annotation=Union[AzureEmbeddingDependency, NoneType], required=False, default=None, alias_priority=1, validation_alias='embeddingDependency', serialization_alias='embedding_dependency'), 'endpoint': FieldInfo(annotation=Union[str, NoneType], required=False, default=None, alias_priority=1, validation_alias='endpoint', serialization_alias='endpoint'), 'fields_mapping': FieldInfo(annotation=Union[DataSourceFieldsMapping, NoneType], required=False, default=None, alias_priority=1, validation_alias='fieldsMapping', serialization_alias='fields_mapping'), 'filter': FieldInfo(annotation=Union[str, NoneType], required=False, default=None, alias_priority=1, validation_alias='filter', serialization_alias='filter'), 'in_scope': FieldInfo(annotation=Union[bool, NoneType], required=False, default=True, alias_priority=1, validation_alias='inScope', serialization_alias='in_scope'), 'index_language': FieldInfo(annotation=Union[str, NoneType], required=False, default=None, alias_priority=1, validation_alias='indexLanguage', serialization_alias='index_language'), 'index_name': FieldInfo(annotation=str, required=True, alias_priority=1, validation_alias='indexName', serialization_alias='index_name'), 'query_type': FieldInfo(annotation=Literal['simple', 'semantic', 'vector', 'vectorSimpleHybrid', 'vectorSemanticHybrid'], required=False, default='simple', alias_priority=1, validation_alias='queryType', serialization_alias='query_type', metadata=[AfterValidator(func=<function to_snake>)]), 'role_information': FieldInfo(annotation=Union[str, NoneType], required=False, default=None, alias_priority=1, validation_alias='roleInformation', serialization_alias='role_information'), 'semantic_configuration': FieldInfo(annotation=Union[str, NoneType], required=False, default=None, alias_priority=1, validation_alias='semanticConfiguration', serialization_alias='semantic_configuration'), 'strictness': FieldInfo(annotation=int, required=False, default=3, alias_priority=1, validation_alias='strictness', serialization_alias='strictness'), 'top_n_documents': FieldInfo(annotation=Union[int, NoneType], required=False, default=5, alias_priority=1, validation_alias='topNDocuments', serialization_alias='top_n_documents')}

authentication

authentication: ApiKeyAuthentication | SystemAssignedManagedIdentityAuthentication | UserAssignedManagedIdentityAuthentication | AccessTokenAuthentication | None

endpoint

endpoint: str | None

query_type

query_type: Annotated[Literal['simple', 'semantic', 'vector', 'vectorSimpleHybrid', 'vectorSemanticHybrid'], AfterValidator(func=to_snake)]

Share via