Skip to content

Commit 2fb0bcc

Browse files
authored
Remove api_key authentication section
The api_key is not supported by Elasticsearch. The `encoded_api_key` and `key_and_key_id` are the only two authenticated options
1 parent 2a41314 commit 2fb0bcc

File tree

1 file changed

+1
-10
lines changed

1 file changed

+1
-10
lines changed

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

Lines changed: 1 addition & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -71,7 +71,7 @@ The details of the vectorization source, used by Azure OpenAI On Your Data when
7171
|Name | Type | Required | Description |
7272
|--- | --- | --- | --- |
7373
| `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](#api-key-authentication-options)|True | Specifies the authentication options to use when retrieving embeddings from the specified endpoint.|
74+
| `authentication`| [ApiKeyAuthenticationOptions](#key-and-key-id-authentication-options)|True | Specifies the authentication options to use when retrieving embeddings from the specified endpoint.|
7575
| `type`|string|True| Must be `endpoint`.|
7676

7777
## Model ID vectorization source
@@ -83,15 +83,6 @@ The details of the vectorization source, used by Azure OpenAI On Your Data when
8383
| `model_id`|string|True| Specifies the model ID to use for vectorization. This model ID must be defined in Elasticsearch.|
8484
| `type`|string|True| Must be `model_id`.|
8585

86-
## API key authentication options
87-
88-
The authentication options for Azure OpenAI On Your Data when using an API key.
89-
90-
|Name | Type | Required | Description |
91-
|--- | --- | --- | --- |
92-
| `key`|string|True|The API key to use for authentication.|
93-
| `type`|string|True| Must be `api_key`.|
94-
9586
## Fields mapping options
9687

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

0 commit comments

Comments
 (0)