You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: articles/ai-services/openai/references/elasticsearch.md
+17-3Lines changed: 17 additions & 3 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -36,7 +36,11 @@ The configurable options for Elasticsearch when using Azure OpenAI On Your Data.
36
36
|`strictness`| integer | False | The configured strictness of the search relevance filtering. The higher of strictness, the higher of the precision but lower recall of the answer. Default is `3`.|
37
37
|`top_n_documents`| integer | False | The configured top number of documents to feature for the configured query. Default is `5`. |
38
38
39
-
## Key and key ID authentication options
39
+
## Authentication Options
40
+
41
+
Azure OpenAI On Your Data supports multiple authentication types:
42
+
43
+
### Key and key ID authentication options
40
44
41
45
The authentication options for Azure OpenAI On Your Data when using an API key.
42
46
@@ -46,7 +50,7 @@ The authentication options for Azure OpenAI On Your Data when using an API key.
46
50
|`key_id`|string|True|The Elasticsearch key ID to use for authentication.|
47
51
|`type`|string|True| Must be `key_and_key_id`.|
48
52
49
-
## Encoded API key authentication options
53
+
###Encoded API key authentication options
50
54
51
55
The authentication options for Azure OpenAI On Your Data when using an Elasticsearch encoded API key.
52
56
@@ -71,9 +75,18 @@ The details of the vectorization source, used by Azure OpenAI On Your Data when
71
75
|Name | Type | Required | Description |
72
76
|--- | --- | --- | --- |
73
77
|`endpoint`|string|True|Specifies the resource endpoint URL from which embeddings should be retrieved. It should be in the format of `https://{YOUR_RESOURCE_NAME}.openai.azure.com/openai/deployments/YOUR_DEPLOYMENT_NAME/embeddings`. The api-version query parameter isn't allowed.|
74
-
|`authentication`|[ApiKeyAuthenticationOptions](#key-and-key-id-authentication-options)|True | Specifies the authentication options to use when retrieving embeddings from the specified endpoint.|
78
+
|`authentication`|[ApiKeyAuthenticationOptions](#api-key-authentication-options)|True | Specifies the authentication options to use when retrieving embeddings from the specified endpoint.|
75
79
|`type`|string|True| Must be `endpoint`.|
76
80
81
+
### API key authentication options
82
+
83
+
The authentication options for Azure OpenAI On Your Data when using an API key.
84
+
85
+
|Name | Type | Required | Description |
86
+
|--- | --- | --- | --- |
87
+
|`key`|string|True|The API key to use for authentication.|
88
+
|`type`|string|True| Must be `api_key`.|
89
+
77
90
## Model ID vectorization source
78
91
79
92
The details of the vectorization source, used by Azure OpenAI On Your Data when applying vector search. This vectorization source is based on Elasticsearch model ID.
@@ -83,6 +96,7 @@ The details of the vectorization source, used by Azure OpenAI On Your Data when
83
96
|`model_id`|string|True| Specifies the model ID to use for vectorization. This model ID must be defined in Elasticsearch.|
84
97
|`type`|string|True| Must be `model_id`.|
85
98
99
+
86
100
## Fields mapping options
87
101
88
102
Optional settings to control how fields are processed when using a configured Elasticsearch resource.
0 commit comments