Skip to content

Commit 3be95c8

Browse files
committed
docs: add vector search configuration for Azure AI Search
1 parent 4da5756 commit 3be95c8

File tree

2 files changed

+21
-3
lines changed

2 files changed

+21
-3
lines changed

pages/docs/configuration/dotenv.mdx

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -435,6 +435,7 @@ This plugin supports searching Azure AI Search for answers to your questions. Se
435435
['AZURE_AI_SEARCH_SEARCH_OPTION_QUERY_TYPE', 'string', 'The query type for Azure AI Search.','AZURE_AI_SEARCH_SEARCH_OPTION_QUERY_TYPE='],
436436
['AZURE_AI_SEARCH_SEARCH_OPTION_TOP', 'number', 'The top count for Azure AI Search.','AZURE_AI_SEARCH_SEARCH_OPTION_TOP='],
437437
['AZURE_AI_SEARCH_SEARCH_OPTION_SELECT', 'string', 'The select fields for Azure AI Search.','AZURE_AI_SEARCH_SEARCH_OPTION_SELECT='],
438+
['AZURE_AI_SEARCH_VECTOR_FIELDS', 'string', 'The names of the vector fields in your Azure AI Search index to use for vector search queries. Multiple fields can be specified as comma-separated values (e.g., \'field1,field2\'). Leave empty if you don\'t use vector search.','AZURE_AI_SEARCH_VECTOR_FIELDS='],
438439
]}
439440
/>
440441

pages/docs/configuration/tools/azure_ai_search.mdx

Lines changed: 20 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -103,7 +103,11 @@ Now select the free option or select your preferred option (may incur charges).
103103
![image](/images/azure-ai-search/librechat_settings.png)
104104

105105

106-
**2.** Fill in the Endpoint, Index Name, and API Key, and click on `Save`.
106+
**2.** Fill in the Endpoint, Index Name, and API Key.
107+
108+
**3.** (Optional) If you're using integrated vectorization, specify the Azure AI Search Vector Fields field with the comma-separated names of your vector fields (e.g., `vectorField1,vectorField2`). See [AZURE_AI_SEARCH_VECTOR_FIELDS](#azure_ai_search_vector_fields) for more details on vector search configuration.
109+
110+
**4.** Click on `Save` to save your configuration.
107111

108112
# Conclusion
109113

@@ -121,15 +125,16 @@ For details on each parameter, please refer to the following document:
121125
**[https://learn.microsoft.com/en-us/rest/api/searchservice/search-documents](https://learn.microsoft.com/en-us/rest/api/searchservice/search-documents)**
122126

123127
```env
124-
AZURE_AI_SEARCH_API_VERSION=2023-10-01-Preview
128+
AZURE_AI_SEARCH_API_VERSION=2025-09-01
125129
AZURE_AI_SEARCH_SEARCH_OPTION_QUERY_TYPE=simple
126130
AZURE_AI_SEARCH_SEARCH_OPTION_TOP=3
127131
AZURE_AI_SEARCH_SEARCH_OPTION_SELECT=field1, field2, field3
132+
AZURE_AI_SEARCH_VECTOR_FIELDS=vectorField1,vectorField2
128133
```
129134

130135
#### AZURE_AI_SEARCH_API_VERSION
131136

132-
Specify the version of the search API. When using new features such as semantic search or vector search, you may need to specify the preview version. The default value is `2023-11-1`.
137+
Specify the version of the search API. When using new features such as semantic search or vector search, you may need to specify the preview version. The default value is `2025-09-01`.
133138

134139
#### AZURE_AI_SEARCH_SEARCH_OPTION_QUERY_TYPE
135140

@@ -142,3 +147,15 @@ Specify the number of items to search for. The default value is 5.
142147
#### AZURE_AI_SEARCH_SEARCH_OPTION_SELECT
143148

144149
Specify the fields of the index to be retrieved, separated by commas. Please note that these are not the fields to be searched.
150+
151+
#### AZURE_AI_SEARCH_VECTOR_FIELDS
152+
153+
Specify the names of the vector fields in your Azure AI Search index to use for vector search queries. Multiple fields can be specified as comma-separated values (e.g., `field1,field2`). Leave empty if you don't use vector search.
154+
155+
When configured, this enables vector search capabilities in the Azure AI Search tool. The tool will accept a `vectorQueryText` parameter that will be vectorized and used to perform semantic similarity searches across the specified vector fields. You can use both keyword search (`query`) and vector search (`vectorQueryText`) together for hybrid search scenarios.
156+
157+
**Prerequisite:** Your Azure AI Search index must have [integrated vectorization](https://learn.microsoft.com/en-us/azure/search/vector-search-integrated-vectorization#using-integrated-vectorization-in-queries) configured with vectorizers assigned to your vector fields. The field names specified in `AZURE_AI_SEARCH_VECTOR_FIELDS` must match the actual vector field names in your index that have vectorizers assigned.
158+
159+
For more information on setting up vector search in Azure AI Search, see:
160+
- [Azure AI Search vector search overview](https://learn.microsoft.com/en-us/azure/search/vector-search-overview)
161+
- [Integrated vectorization in queries](https://learn.microsoft.com/en-us/azure/search/vector-search-integrated-vectorization#using-integrated-vectorization-in-queries)

0 commit comments

Comments
 (0)