Share via


AzureAISearchDataSourceParameters Class

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.

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

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)]