Skip to content

Commit 1e16960

Browse files
committed
Merge branch 'main' of https://github.com/MicrosoftDocs/azure-docs-pr into patricka-module-dev-feedback
2 parents d3b87c5 + 10fc071 commit 1e16960

File tree

48 files changed

+245
-166
lines changed

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

48 files changed

+245
-166
lines changed

articles/ai-services/openai/reference.md

Lines changed: 25 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -486,7 +486,6 @@ The following parameters can be used inside of the `parameters` field inside of
486486
|--|--|--|--|--|
487487
| `type` | string | Required | null | The data source to be used for the Azure OpenAI on your data feature. For Azure AI Search the value is `AzureCognitiveSearch`. For Azure Cosmos DB for MongoDB vCore, the value is `AzureCosmosDB`. |
488488
| `indexName` | string | Required | null | The search index to be used. |
489-
| `fieldsMapping` | dictionary | Optional for Azure AI Search. Required for Azure Cosmos DB for MongoDB vCore. | null | Index data column mapping. When using Azure Cosmos DB for MongoDB vCore, the value `vectorFields` is required, which indicates the fields that store vectors. |
490489
| `inScope` | boolean | Optional | true | If set, this value will limit responses specific to the grounding data content. |
491490
| `topNDocuments` | number | Optional | 5 | Specifies the number of top-scoring documents from your data index used to generate responses. You might want to increase the value when you have short documents or want to provide more context. This is the *retrieved documents* parameter in Azure OpenAI studio. |
492491
| `semanticConfiguration` | string | Optional | null | The semantic search configuration. Only required when `queryType` is set to `semantic` or `vectorSemanticHybrid`. |
@@ -498,13 +497,36 @@ The following parameters can be used inside of the `parameters` field inside of
498497
| `strictness` | number | Optional | 3 | Sets the threshold to categorize documents as relevant to your queries. Raising the value means a higher threshold for relevance and filters out more less-relevant documents for responses. Setting this value too high might cause the model to fail to generate responses due to limited available documents. |
499498

500499

501-
**The following parameters are used for Azure AI Search only**
500+
**The following parameters are used for Azure AI Search**
502501

503502
| Parameters | Type | Required? | Default | Description |
504503
|--|--|--|--|--|
505504
| `endpoint` | string | Required | null | Azure AI Search only. The data source endpoint. |
506505
| `key` | string | Required | null | Azure AI Search only. One of the Azure AI Search admin keys for your service. |
507506
| `queryType` | string | Optional | simple | Indicates which query option will be used for Azure AI Search. Available types: `simple`, `semantic`, `vector`, `vectorSimpleHybrid`, `vectorSemanticHybrid`. |
507+
| `fieldsMapping` | dictionary | Optional for Azure AI Search. | null | defines which [fields](./concepts/use-your-data.md?tabs=ai-search#index-field-mapping) you want to map when you add your data source. |
508+
509+
The following parameters are used inside of the `fieldsMapping` field.
510+
511+
| Parameters | Type | Required? | Default | Description |
512+
|--|--|--|--|--|
513+
| `titleField` | string | Optional | null | The field in your index that contains the original title of each document. |
514+
| `urlField` | string | Optional | null | The field in your index that contains the original URL of each document. |
515+
| `filepathField` | string | Optional | null | The field in your index that contains the original file name of each document. |
516+
| `contentFields` | dictionary | Optional | null | The fields in your index that contain the main text content of each document. |
517+
| `contentFieldsSeparator` | string | Optional | null | The separator for the your content fields. Use `\n` by default. |
518+
519+
```json
520+
"fieldsMapping": {
521+
"titleField": "myTitleField",
522+
"urlField": "myUrlField",
523+
"filepathField": "myFilePathField",
524+
"contentFields": [
525+
"myContentField"
526+
],
527+
"contentFieldsSeparator": "\n"
528+
}
529+
```
508530

509531
**The following parameters are used for Azure Cosmos DB for MongoDB vCore**
510532

@@ -516,6 +538,7 @@ The following parameters can be used inside of the `parameters` field inside of
516538
| `containerName` | string | Required | null | Azure Cosmos DB for MongoDB vCore only. The Azure Cosmos Mongo vCore container name in the database. |
517539
| `type` (found inside of`embeddingDependencyType`) | string | Required | null | Indicates the embedding model dependency. |
518540
| `deploymentName` (found inside of`embeddingDependencyType`) | string | Required | null | The embedding model deployment name. |
541+
| `fieldsMapping` | dictionary | Required for Azure Cosmos DB for MongoDB vCore. | null | Index data column mapping. When using Azure Cosmos DB for MongoDB vCore, the value `vectorFields` is required, which indicates the fields that store vectors. |
519542

520543
### Start an ingestion job
521544

articles/ai-studio/how-to/data-add.md

Lines changed: 6 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -114,7 +114,7 @@ These steps explain how to create a File typed data in the Azure AI Studio:
114114
To create a data that is a File type, use the following code and update the `<>` placeholders with your information.
115115

116116
```python
117-
from azure.ai.generative import AIClient
117+
from azure.ai.resources.client import AIClient
118118
from azure.ai.generative.entities import Data
119119
from azure.ai.generative.constants import AssetTypes
120120
from azure.identity import DefaultAzureCredential
@@ -174,7 +174,7 @@ Use these steps to create a Folder typed data in the Azure AI Studio:
174174
To create a data that is a Folder type use the following code and update the `<>` placeholders with your information.
175175

176176
```python
177-
from azure.ai.generative import AIClient
177+
from azure.ai.resources.client import AIClient
178178
from azure.ai.generative.entities import Data
179179
from azure.ai.generative.constants import AssetTypes
180180
from azure.identity import DefaultAzureCredential
@@ -240,7 +240,7 @@ To archive *all versions* of the data under a given name, use:
240240
# [Python SDK](#tab/python)
241241

242242
```python
243-
from azure.ai.generative import AIClient
243+
from azure.ai.resources.client import AIClient
244244
from azure.ai.generative.entities import Data
245245
from azure.ai.generative.constants import AssetTypes
246246
from azure.identity import DefaultAzureCredential
@@ -265,7 +265,7 @@ To archive a specific data version, use:
265265
# [Python SDK](#tab/python)
266266

267267
```python
268-
from azure.ai.generative import AIClient
268+
from azure.ai.resources.client import AIClient
269269
from azure.ai.generative.entities import Data
270270
from azure.ai.generative.constants import AssetTypes
271271
from azure.identity import DefaultAzureCredential
@@ -294,7 +294,7 @@ To restore *all versions* of the data under a given name, use:
294294
# [Python SDK](#tab/python)
295295

296296
```python
297-
from azure.ai.generative import AIClient
297+
from azure.ai.resources.client import AIClient
298298
from azure.ai.generative.entities import Data
299299
from azure.ai.generative.constants import AssetTypes
300300
from azure.identity import DefaultAzureCredential
@@ -321,7 +321,7 @@ To restore a specific data version, use:
321321
# [Python SDK](#tab/python)
322322

323323
```python
324-
from azure.ai.generative import AIClient
324+
from azure.ai.resources.client import AIClient
325325
from azure.ai.generative.entities import Data
326326
from azure.ai.generative.constants import AssetTypes
327327
from azure.identity import DefaultAzureCredential

articles/ai-studio/how-to/flow-deploy.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -83,7 +83,7 @@ You can use the Azure AI Generative SDK to deploy a prompt flow as an online end
8383

8484
```python
8585
# Import required dependencies
86-
from azure.ai.generative import AIClient
86+
from azure.ai.resources.client import AIClient
8787
from azure.ai.generative.entities.deployment import Deployment
8888
from azure.ai.generative.entities.models import PromptflowModel
8989
from azure.identity import InteractiveBrowserCredential as Credential

articles/ai-studio/how-to/simulator-interaction-data.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -37,7 +37,7 @@ First we set up the system large language model, which acts as the "agent" simul
3737

3838
```python
3939
from azure.identity import DefaultAzureCredential
40-
from azure.ai.generative import AIClient
40+
from azure.ai.resources.client import AIClient
4141
from azure.ai.generative.entities import AzureOpenAIModelConfiguration
4242

4343
credential = DefaultAzureCredential()

articles/ai-studio/includes/evaluations/from-data/python.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -134,7 +134,7 @@ Before you call the `evaluate()` function, your environment needs to set up your
134134

135135
```python
136136
from azure.identity import DefaultAzureCredential
137-
from azure.ai.generative import AIClient
137+
from azure.ai.resources.client import AIClient
138138

139139
client = AIClient.from_config(DefaultAzureCredential())
140140
```

articles/azure-relay/includes/relay-create-hybrid-connection-portal.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -2,7 +2,7 @@
22
author: spelluru
33
ms.service: service-bus-relay
44
ms.topic: include
5-
ms.date: 08/10/2023
5+
ms.date: 01/04/2024
66
ms.author: spelluru
77
---
88
On the **Relay** page for your namespace, follow these steps to create a hybrid connection.

articles/azure-relay/includes/relay-create-namespace-portal.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -2,7 +2,7 @@
22
author: spelluru
33
ms.service: service-bus-relay
44
ms.topic: include
5-
ms.date: 08/10/2023
5+
ms.date: 01/04/2024
66
ms.author: spelluru
77
---
88
1. Sign in to the [Azure portal].

articles/azure-relay/includes/relay-hybrid-connections-node-get-started-client.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -2,7 +2,7 @@
22
author: clemensv
33
ms.service: service-bus-relay
44
ms.topic: include
5-
ms.date: 11/09/2018
5+
ms.date: 01/04/2024
66
ms.author: clemensv
77
---
88
### Create a Node.js application
@@ -51,7 +51,7 @@ Run `npm install hyco-ws` from a Node command prompt in your project folder.
5151
}
5252
);
5353
```
54-
Here is what your sender.js file should look like:
54+
Here's what your sender.js file should look like:
5555
5656
```js
5757
const WebSocket = require('hyco-ws');

articles/azure-relay/includes/relay-hybrid-connections-node-get-started-server.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -2,7 +2,7 @@
22
author: clemensv
33
ms.service: service-bus-relay
44
ms.topic: include
5-
ms.date: 08/10/2023
5+
ms.date: 01/04/2024
66
ms.author: clemensv
77
---
88
### Create a Node.js application
@@ -51,7 +51,7 @@ Run `npm install hyco-ws` from a Node command prompt in your project folder.
5151
console.log('error' + err);
5252
});
5353
```
54-
Here is what your listener.js file should look like:
54+
Here's what your listener.js file should look like:
5555
5656
```js
5757
const WebSocket = require('hyco-ws');

articles/azure-relay/relay-hybrid-connections-http-requests-node-get-started.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -2,7 +2,7 @@
22
title: Azure Relay Hybrid Connections - HTTP requests in Node.js
33
description: Write a Node.js console application for Azure Relay Hybrid Connections HTTP requests.
44
ms.topic: tutorial
5-
ms.date: 06/21/2022
5+
ms.date: 01/04/2024
66
ms.custom: devx-track-js, mode-ui, mode-api
77
---
88

0 commit comments

Comments
 (0)