Skip to content

Commit 5431323

Browse files
authored
Merge pull request #377 from MikeAlhayek/patch-1
Fix formatting and add authentication section
2 parents b14f8cd + fc514c4 commit 5431323

File tree

1 file changed

+15
-10
lines changed

1 file changed

+15
-10
lines changed

articles/ai-services/openai/references/elasticsearch.md

Lines changed: 15 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -36,7 +36,11 @@ The configurable options for Elasticsearch when using Azure OpenAI On Your Data.
3636
| `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`.|
3737
| `top_n_documents` | integer | False | The configured top number of documents to feature for the configured query. Default is `5`. |
3838

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
4044

4145
The authentication options for Azure OpenAI On Your Data when using an API key.
4246

@@ -46,7 +50,7 @@ The authentication options for Azure OpenAI On Your Data when using an API key.
4650
| `key_id`|string|True|The Elasticsearch key ID to use for authentication.|
4751
| `type`|string|True| Must be `key_and_key_id`.|
4852

49-
## Encoded API key authentication options
53+
### Encoded API key authentication options
5054

5155
The authentication options for Azure OpenAI On Your Data when using an Elasticsearch encoded API key.
5256

@@ -74,23 +78,24 @@ The details of the vectorization source, used by Azure OpenAI On Your Data when
7478
| `authentication`| [ApiKeyAuthenticationOptions](#api-key-authentication-options)|True | Specifies the authentication options to use when retrieving embeddings from the specified endpoint.|
7579
| `type`|string|True| Must be `endpoint`.|
7680

77-
## Model ID vectorization source
81+
### API key authentication options
7882

79-
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+
The authentication options for Azure OpenAI On Your Data when using an API key.
8084

8185
|Name | Type | Required | Description |
8286
|--- | --- | --- | --- |
83-
| `model_id`|string|True| Specifies the model ID to use for vectorization. This model ID must be defined in Elasticsearch.|
84-
| `type`|string|True| Must be `model_id`.|
87+
| `key`|string|True|The API key to use for authentication.|
88+
| `type`|string|True| Must be `api_key`.|
8589

86-
## API key authentication options
90+
## Model ID vectorization source
8791

88-
The authentication options for Azure OpenAI On Your Data when using an API key.
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.
8993

9094
|Name | Type | Required | Description |
9195
|--- | --- | --- | --- |
92-
| `key`|string|True|The API key to use for authentication.|
93-
| `type`|string|True| Must be `api_key`.|
96+
| `model_id`|string|True| Specifies the model ID to use for vectorization. This model ID must be defined in Elasticsearch.|
97+
| `type`|string|True| Must be `model_id`.|
98+
9499

95100
## Fields mapping options
96101

0 commit comments

Comments
 (0)