Skip to content

Commit 04e92a4

Browse files
authored
Doc updates for Azure Search datastore (#294)
1 parent 602de33 commit 04e92a4

File tree

1 file changed

+21
-1
lines changed

1 file changed

+21
-1
lines changed

docs/providers/azuresearch/setup.md

Lines changed: 21 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -4,6 +4,10 @@
44

55
You can find the Azure Cognitive Search documentation [here](https://learn.microsoft.com/azure/search/search-what-is-azure-search). If you don't have an Azure account, you can start setting one up [here](https://azure.microsoft.com/).
66

7+
## Signing up for vector search
8+
9+
Azure Cognitive Search supports searching using pure vectors, pure text, or hybrid mode where both are combined. For the vector-based cases, you'll need to sign up for vector search private preview. To sign up, please fill in this form: https://aka.ms/VectorSearchSignUp
10+
711
## Environment variables
812

913
| Name | Required | Description | Default |
@@ -26,4 +30,20 @@ You can find the Azure Cognitive Search documentation [here](https://learn.micro
2630

2731
## Re-ranking
2832

29-
Azure Cognitive Search offers the option to enable a second (L2) ranking step after retrieval to further improve results quality. This only applies when using text or hybrid search. Since it has latency and cost implications, if you want to try this option you need to explicitly [enable "semantic search"](https://learn.microsoft.com/azure/search/semantic-search-overview#enable-semantic-search) in your Cognitive Search service, and [create a semantic search configuration](https://learn.microsoft.com/azure/search/semantic-how-to-query-request#2---create-a-semantic-configuration) for your index.
33+
Azure Cognitive Search offers the option to enable a second (L2) ranking step after retrieval to further improve results quality. This only applies when using text or hybrid search. Since it has latency and cost implications, if you want to try this option you need to explicitly [enable "semantic search"](https://learn.microsoft.com/azure/search/semantic-search-overview#enable-semantic-search) in your Cognitive Search service, and [create a semantic search configuration](https://learn.microsoft.com/azure/search/semantic-how-to-query-request#2---create-a-semantic-configuration) for your index.
34+
35+
## Using existing search indexes
36+
37+
If an existing index has fields that align with what's needed by the retrieval plugin but just differ in names, you can map your fields to the plugin fields using the following environment variables:
38+
39+
|Plugin field name|Environment variable to override it|
40+
|-----------------|-----------------------------------|
41+
|id |AZURESEARCH_FIELDS_ID |
42+
|text |AZURESEARCH_FIELDS_TEXT |
43+
|embedding |AZURESEARCH_FIELDS_EMBEDDING |
44+
|document_id |AZURESEARCH_FIELDS_DOCUMENT_ID |
45+
|source |AZURESEARCH_FIELDS_SOURCE |
46+
|source_id |AZURESEARCH_FIELDS_SOURCE_ID |
47+
|url |AZURESEARCH_FIELDS_URL |
48+
|created_at |AZURESEARCH_FIELDS_CREATED_AT |
49+
|author |AZURESEARCH_FIELDS_AUTHOR |

0 commit comments

Comments
 (0)