Skip to content

Commit 414af9b

Browse files
committed
On
1 parent 88a27be commit 414af9b

File tree

6 files changed

+36
-36
lines changed

6 files changed

+36
-36
lines changed

articles/ai-services/openai/references/azure-ml.md

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -14,7 +14,7 @@ ms.custom:
1414

1515
# Data source - Azure Machine Learning index
1616

17-
The configurable options of Azure Machine Learning index when using Azure OpenAI on your data. This data source is supported in API version `2024-02-15-preview`.
17+
The configurable options of Azure Machine Learning index when using Azure OpenAI On Your Data. This data source is supported in API version `2024-02-15-preview`.
1818

1919
|Name | Type | Required | Description |
2020
|--- | --- | --- | --- |
@@ -38,7 +38,7 @@ The configurable options of Azure Machine Learning index when using Azure OpenAI
3838

3939
## Access token authentication options
4040

41-
The authentication options for Azure OpenAI on your data when using access token.
41+
The authentication options for Azure OpenAI On Your Data when using access token.
4242

4343
|Name | Type | Required | Description |
4444
|--- | --- | --- | --- |
@@ -47,15 +47,15 @@ The authentication options for Azure OpenAI on your data when using access token
4747

4848
## System assigned managed identity authentication options
4949

50-
The authentication options for Azure OpenAI on your data when using a system-assigned managed identity.
50+
The authentication options for Azure OpenAI On Your Data when using a system-assigned managed identity.
5151

5252
|Name | Type | Required | Description |
5353
|--- | --- | --- | --- |
5454
| `type`|string|True| Must be `system_assigned_managed_identity`.|
5555

5656
## User assigned managed identity authentication options
5757

58-
The authentication options for Azure OpenAI on your data when using a user-assigned managed identity.
58+
The authentication options for Azure OpenAI On Your Data when using a user-assigned managed identity.
5959

6060
|Name | Type | Required | Description |
6161
|--- | --- | --- | --- |

articles/ai-services/openai/references/azure-search.md

Lines changed: 7 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -14,7 +14,7 @@ ms.custom:
1414

1515
# Data source - Azure AI Search
1616

17-
The configurable options of Azure AI Search when using Azure OpenAI on your data. This data source is supported in API version `2024-02-15-preview`.
17+
The configurable options of Azure AI Search when using Azure OpenAI On Your Data. This data source is supported in API version `2024-02-15-preview`.
1818

1919
|Name | Type | Required | Description |
2020
|--- | --- | --- | --- |
@@ -40,7 +40,7 @@ The configurable options of Azure AI Search when using Azure OpenAI on your data
4040

4141
## API key authentication options
4242

43-
The authentication options for Azure OpenAI on your data when using an API key.
43+
The authentication options for Azure OpenAI On Your Data when using an API key.
4444

4545
|Name | Type | Required | Description |
4646
|--- | --- | --- | --- |
@@ -49,15 +49,15 @@ The authentication options for Azure OpenAI on your data when using an API key.
4949

5050
## System assigned managed identity authentication options
5151

52-
The authentication options for Azure OpenAI on your data when using a system-assigned managed identity.
52+
The authentication options for Azure OpenAI On Your Data when using a system-assigned managed identity.
5353

5454
|Name | Type | Required | Description |
5555
|--- | --- | --- | --- |
5656
| `type`|string|True| Must be `system_assigned_managed_identity`.|
5757

5858
## User assigned managed identity authentication options
5959

60-
The authentication options for Azure OpenAI on your data when using a user-assigned managed identity.
60+
The authentication options for Azure OpenAI On Your Data when using a user-assigned managed identity.
6161

6262
|Name | Type | Required | Description |
6363
|--- | --- | --- | --- |
@@ -66,7 +66,7 @@ The authentication options for Azure OpenAI on your data when using a user-assig
6666

6767
## Deployment name vectorization source
6868

69-
The details of the vectorization source, used by Azure OpenAI on your data when applying vector search. This vectorization source is based on an internal embeddings model deployment name in the same Azure OpenAI resource. This vectorization source enables you to use vector search without Azure OpenAI api-key and without Azure OpenAI public network access.
69+
The details of the vectorization source, used by Azure OpenAI On Your Data when applying vector search. This vectorization source is based on an internal embeddings model deployment name in the same Azure OpenAI resource. This vectorization source enables you to use vector search without Azure OpenAI api-key and without Azure OpenAI public network access.
7070

7171
|Name | Type | Required | Description |
7272
|--- | --- | --- | --- |
@@ -75,7 +75,7 @@ The details of the vectorization source, used by Azure OpenAI on your data when
7575

7676
## Endpoint vectorization source
7777

78-
The details of the vectorization source, used by Azure OpenAI on your data when applying vector search. This vectorization source is based on the Azure OpenAI embedding API endpoint.
78+
The details of the vectorization source, used by Azure OpenAI On Your Data when applying vector search. This vectorization source is based on the Azure OpenAI embedding API endpoint.
7979

8080
|Name | Type | Required | Description |
8181
|--- | --- | --- | --- |
@@ -98,7 +98,7 @@ Optional settings to control how fields are processed when using a configured Az
9898

9999
## Query type
100100

101-
The type of Azure Search retrieval query that should be executed when using it as an Azure OpenAI on your data.
101+
The type of Azure Search retrieval query that should be executed when using it as an Azure OpenAI On Your Data.
102102

103103
|Enum Value | Description |
104104
|---|---|

articles/ai-services/openai/references/cosmos-db.md

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -14,7 +14,7 @@ ms.custom:
1414

1515
# Data source - Azure Cosmos DB for MongoDB vCore
1616

17-
The configurable options of Azure Cosmos DB for MongoDB vCore when using Azure OpenAI on your data. This data source is supported in API version `2024-02-15-preview`.
17+
The configurable options of Azure Cosmos DB for MongoDB vCore when using Azure OpenAI On Your Data. This data source is supported in API version `2024-02-15-preview`.
1818

1919
|Name | Type | Required | Description |
2020
|--- | --- | --- | --- |
@@ -38,7 +38,7 @@ The configurable options of Azure Cosmos DB for MongoDB vCore when using Azure O
3838

3939
## Connection string authentication options
4040

41-
The authentication options for Azure OpenAI on your data when using a connection string.
41+
The authentication options for Azure OpenAI On Your Data when using a connection string.
4242

4343
|Name | Type | Required | Description |
4444
|--- | --- | --- | --- |
@@ -48,7 +48,7 @@ The authentication options for Azure OpenAI on your data when using a connection
4848

4949
## Deployment name vectorization source
5050

51-
The details of the vectorization source, used by Azure OpenAI on your data when applying vector search. This vectorization source is based on an internal embeddings model deployment name in the same Azure OpenAI resource. This vectorization source enables you to use vector search without Azure OpenAI api-key and without Azure OpenAI public network access.
51+
The details of the vectorization source, used by Azure OpenAI On Your Data when applying vector search. This vectorization source is based on an internal embeddings model deployment name in the same Azure OpenAI resource. This vectorization source enables you to use vector search without Azure OpenAI api-key and without Azure OpenAI public network access.
5252

5353
|Name | Type | Required | Description |
5454
|--- | --- | --- | --- |
@@ -57,7 +57,7 @@ The details of the vectorization source, used by Azure OpenAI on your data when
5757

5858
## Endpoint vectorization source
5959

60-
The details of the vectorization source, used by Azure OpenAI on your data when applying vector search. This vectorization source is based on the Azure OpenAI embedding API endpoint.
60+
The details of the vectorization source, used by Azure OpenAI On Your Data when applying vector search. This vectorization source is based on the Azure OpenAI embedding API endpoint.
6161

6262
|Name | Type | Required | Description |
6363
|--- | --- | --- | --- |
@@ -67,7 +67,7 @@ The details of the vectorization source, used by Azure OpenAI on your data when
6767

6868
## API key authentication options
6969

70-
The authentication options for Azure OpenAI on your data when using an API key.
70+
The authentication options for Azure OpenAI On Your Data when using an API key.
7171

7272
|Name | Type | Required | Description |
7373
|--- | --- | --- | --- |

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

Lines changed: 8 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -14,7 +14,7 @@ ms.custom:
1414

1515
# Data source - Elasticsearch
1616

17-
The configurable options for Elasticsearch when using Azure OpenAI on your data. This data source is supported in API version `2024-02-15-preview`.
17+
The configurable options for Elasticsearch when using Azure OpenAI On Your Data. This data source is supported in API version `2024-02-15-preview`.
1818

1919
|Name | Type | Required | Description |
2020
|--- | --- | --- | --- |
@@ -38,7 +38,7 @@ The configurable options for Elasticsearch when using Azure OpenAI on your data.
3838

3939
## Key and key ID authentication options
4040

41-
The authentication options for Azure OpenAI on your data when using an API key.
41+
The authentication options for Azure OpenAI On Your Data when using an API key.
4242

4343
|Name | Type | Required | Description |
4444
|--- | --- | --- | --- |
@@ -48,7 +48,7 @@ The authentication options for Azure OpenAI on your data when using an API key.
4848

4949
## Encoded API key authentication options
5050

51-
The authentication options for Azure OpenAI on your data when using an Elasticsearch encoded API key.
51+
The authentication options for Azure OpenAI On Your Data when using an Elasticsearch encoded API key.
5252

5353
|Name | Type | Required | Description |
5454
|--- | --- | --- | --- |
@@ -57,7 +57,7 @@ The authentication options for Azure OpenAI on your data when using an Elasticse
5757

5858
## Deployment name vectorization source
5959

60-
The details of the vectorization source, used by Azure OpenAI on your data when applying vector search. This vectorization source is based on an internal embeddings model deployment name in the same Azure OpenAI resource. This vectorization source enables you to use vector search without Azure OpenAI api-key and without Azure OpenAI public network access.
60+
The details of the vectorization source, used by Azure OpenAI On Your Data when applying vector search. This vectorization source is based on an internal embeddings model deployment name in the same Azure OpenAI resource. This vectorization source enables you to use vector search without Azure OpenAI api-key and without Azure OpenAI public network access.
6161

6262
|Name | Type | Required | Description |
6363
|--- | --- | --- | --- |
@@ -66,7 +66,7 @@ The details of the vectorization source, used by Azure OpenAI on your data when
6666

6767
## Endpoint vectorization source
6868

69-
The details of the vectorization source, used by Azure OpenAI on your data when applying vector search. This vectorization source is based on the Azure OpenAI embedding API endpoint.
69+
The details of the vectorization source, used by Azure OpenAI On Your Data when applying vector search. This vectorization source is based on the Azure OpenAI embedding API endpoint.
7070

7171
|Name | Type | Required | Description |
7272
|--- | --- | --- | --- |
@@ -76,7 +76,7 @@ The details of the vectorization source, used by Azure OpenAI on your data when
7676

7777
## Model ID vectorization source
7878

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.
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.
8080

8181
|Name | Type | Required | Description |
8282
|--- | --- | --- | --- |
@@ -85,7 +85,7 @@ The details of the vectorization source, used by Azure OpenAI on your data when
8585

8686
## API key authentication options
8787

88-
The authentication options for Azure OpenAI on your data when using an API key.
88+
The authentication options for Azure OpenAI On Your Data when using an API key.
8989

9090
|Name | Type | Required | Description |
9191
|--- | --- | --- | --- |
@@ -107,7 +107,7 @@ Optional settings to control how fields are processed when using a configured El
107107

108108
## Query type
109109

110-
The type of Elasticsearch retrieval query that should be executed when using it with Azure OpenAI on your data.
110+
The type of Elasticsearch retrieval query that should be executed when using it with Azure OpenAI On Your Data.
111111

112112
|Enum Value | Description |
113113
|---|---|

articles/ai-services/openai/references/on-your-data.md

Lines changed: 9 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
11
---
2-
title: Azure OpenAI on your data Python & REST API reference
2+
title: Azure OpenAI On Your Data Python & REST API reference
33
titleSuffix: Azure OpenAI
4-
description: Learn how to use Azure OpenAI on your data Python & REST API.
4+
description: Learn how to use Azure OpenAI On Your Data Python & REST API.
55
manager: nitinme
66
ms.service: azure-ai-openai
77
ms.topic: conceptual
@@ -12,9 +12,9 @@ recommendations: false
1212
ms.custom:
1313
---
1414

15-
# Azure OpenAI on your data API Reference
15+
# Azure OpenAI On Your Data API Reference
1616

17-
This article provides reference documentation for Python and REST for the new Azure OpenAI on your data API. The latest preview api-version is `2024-02-15-preview`.
17+
This article provides reference documentation for Python and REST for the new Azure OpenAI On Your Data API. The latest preview api-version is `2024-02-15-preview`.
1818

1919
> [!NOTE]
2020
> Since `2024-02-15-preview` we introduced the following breaking changes comparing to earlier API versions:
@@ -37,24 +37,24 @@ POST {endpoint}/openai/deployments/{deployment-id}/chat/completions?api-version=
3737

3838
## Request body
3939

40-
The request body inherits the same schema of chat completions API request. This table shows the parameters unique for Azure OpenAI on your data.
40+
The request body inherits the same schema of chat completions API request. This table shows the parameters unique for Azure OpenAI On Your Data.
4141

4242
|Name | Type | Required | Description |
4343
|--- | --- | --- | --- |
44-
| `messages` | [ChatMessage](#chat-message)[] | True | The array of messages to generate chat completions for, in the chat format. The [request chat message](#chat-message) has a `context` property, which is added for Azure OpenAI on your data.|
45-
| `data_sources` | [DataSource](#data-source)[] | True | The configuration entries for Azure OpenAI on your data. There must be exactly one element in the array. If `data_sources` is not provided, the service uses chat completions model directly, and does not use Azure OpenAI on your data.|
44+
| `messages` | [ChatMessage](#chat-message)[] | True | The array of messages to generate chat completions for, in the chat format. The [request chat message](#chat-message) has a `context` property, which is added for Azure OpenAI On Your Data.|
45+
| `data_sources` | [DataSource](#data-source)[] | True | The configuration entries for Azure OpenAI On Your Data. There must be exactly one element in the array. If `data_sources` is not provided, the service uses chat completions model directly, and does not use Azure OpenAI On Your Data.|
4646

4747
## Response body
4848

49-
The response body inherits the same schema of chat completions API response. The [response chat message](#chat-message) has a `context` property, which is added for Azure OpenAI on your data.
49+
The response body inherits the same schema of chat completions API response. The [response chat message](#chat-message) has a `context` property, which is added for Azure OpenAI On Your Data.
5050

5151
## Chat message
5252

5353
In both request and response, when the chat message `role` is `assistant`, the chat message schema inherits from the chat completions assistant chat message, and is extended with the property `context`.
5454

5555
|Name | Type | Required | Description |
5656
|--- | --- | --- | --- |
57-
| `context` | [Context](#context) | False | Represents the incremental steps performed by the Azure OpenAI on your data while processing the request, including the detected search intent and the retrieved documents. |
57+
| `context` | [Context](#context) | False | Represents the incremental steps performed by the Azure OpenAI On Your Data while processing the request, including the detected search intent and the retrieved documents. |
5858

5959
## Context
6060
|Name | Type | Required | Description |

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

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -14,7 +14,7 @@ ms.custom:
1414

1515
# Data source - Pinecone
1616

17-
The configurable options of Pinecone when using Azure OpenAI on your data. This data source is supported in API version `2024-02-15-preview`.
17+
The configurable options of Pinecone when using Azure OpenAI On Your Data. This data source is supported in API version `2024-02-15-preview`.
1818

1919
|Name | Type | Required | Description |
2020
|--- | --- | --- | --- |
@@ -37,7 +37,7 @@ The configurable options of Pinecone when using Azure OpenAI on your data. This
3737

3838
## API key authentication options
3939

40-
The authentication options for Azure OpenAI on your data when using an API key.
40+
The authentication options for Azure OpenAI On Your Data when using an API key.
4141

4242
|Name | Type | Required | Description |
4343
|--- | --- | --- | --- |
@@ -47,7 +47,7 @@ The authentication options for Azure OpenAI on your data when using an API key.
4747

4848
## Deployment name vectorization source
4949

50-
The details of the vectorization source, used by Azure OpenAI on your data when applying vector search. This vectorization source is based on an internal embeddings model deployment name in the same Azure OpenAI resource. This vectorization source enables you to use vector search without Azure OpenAI api-key and without Azure OpenAI public network access.
50+
The details of the vectorization source, used by Azure OpenAI On Your Data when applying vector search. This vectorization source is based on an internal embeddings model deployment name in the same Azure OpenAI resource. This vectorization source enables you to use vector search without Azure OpenAI api-key and without Azure OpenAI public network access.
5151

5252
|Name | Type | Required | Description |
5353
|--- | --- | --- | --- |

0 commit comments

Comments
 (0)