| Name | Type | Description |
|---|---|---|
azure_search_endpoint* | str | The endpoint URL for Azure Cognitive Search. |
azure_search_key* | Optional[str] | The API key for Azure Cognitive Search. |
index_name* | str | The name of the index to use. |
embedding_function* | Union[Callable, Embeddings] | |
search_type | str | Default: 'hybrid' |
semantic_configuration_name | Optional[str] | Default: None |
fields | Optional[List[SearchField]] | Default: None |
vector_search | Optional[VectorSearch] | Default: None |
semantic_configurations | Optional[Union[SemanticConfiguration, List[SemanticConfiguration]]] | Default: None |
scoring_profiles | Optional[List[ScoringProfile]] | Default: None |
default_scoring_profile | Optional[str] | Default: None |
cors_options | Optional[CorsOptions] | Default: None |
vector_search_dimensions | Optional[int] | Default: None |
additional_search_client_options | Optional[Dict[str, Any]] | Default: None |
azure_ad_access_token | Optional[str] | Default: None |
azure_credential | Optional[TokenCredential] | Default: None |
azure_async_credential | Optional[AsyncTokenCredential] | Default: None |
**kwargs | Any | Default: {} |
| Name | Type |
|---|---|
| azure_search_endpoint | str |
| azure_search_key | Optional[str] |
| index_name | str |
| embedding_function | Union[Callable, Embeddings] |
| search_type | str |
| semantic_configuration_name | Optional[str] |
| fields | Optional[List[SearchField]] |
| vector_search | Optional[VectorSearch] |
| semantic_configurations | Optional[Union[SemanticConfiguration, List[SemanticConfiguration]]] |
| scoring_profiles | Optional[List[ScoringProfile]] |
| default_scoring_profile | Optional[str] |
| cors_options | Optional[CorsOptions] |
| vector_search_dimensions | Optional[int] |
| additional_search_client_options | Optional[Dict[str, Any]] |
| azure_ad_access_token | Optional[str] |
| azure_credential | Optional[TokenCredential] |
| azure_async_credential | Optional[AsyncTokenCredential] |
Returns the most similar indexed documents to the query text.
Azure Cognitive Search vector store.
The embedding function or object.
The type of search to perform (default: "hybrid").
Optional semantic configuration name.
Optional list of search fields.
Optional vector search configuration.
Optional semantic configurations.
Optional scoring profiles.
Optional default scoring profile.
Optional CORS options.
Optional vector search dimensions.
Additional options for the search client.
Optional Azure AD access token.
Optional Azure credential.
Optional async Azure credential.
Additional keyword arguments.