Skip to content

Commit fc514c4

Browse files
authored
fix indentation for clarification
1 parent 2fb0bcc commit fc514c4

File tree

1 file changed

+17
-3
lines changed

1 file changed

+17
-3
lines changed

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

Lines changed: 17 additions & 3 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

@@ -71,9 +75,18 @@ The details of the vectorization source, used by Azure OpenAI On Your Data when
7175
|Name | Type | Required | Description |
7276
|--- | --- | --- | --- |
7377
| `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.|
7579
| `type`|string|True| Must be `endpoint`.|
7680

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+
7790
## Model ID vectorization source
7891

7992
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
8396
| `model_id`|string|True| Specifies the model ID to use for vectorization. This model ID must be defined in Elasticsearch.|
8497
| `type`|string|True| Must be `model_id`.|
8598

99+
86100
## Fields mapping options
87101

88102
Optional settings to control how fields are processed when using a configured Elasticsearch resource.

0 commit comments

Comments
 (0)