You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: articles/ai-studio/how-to/deploy-models-cohere-rerank.md
+25-30Lines changed: 25 additions & 30 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -5,7 +5,7 @@ description: Learn to deploy and use Cohere Rerank models with Azure AI Foundry.
5
5
manager: scottpolly
6
6
ms.service: azure-ai-studio
7
7
ms.topic: how-to
8
-
ms.date: 07/24/2024
8
+
ms.date: 12/06/2024
9
9
ms.reviewer: shubhiraj
10
10
ms.author: mopeakande
11
11
author: msakande
@@ -24,12 +24,12 @@ In this article, you learn about the Cohere Rerank models, how to use Azure AI F
24
24
25
25
Cohere offers two Rerank models in [Azure AI Foundry](https://ai.azure.com). These models are available in the model catalog for deployment as serverless APIs:
26
26
27
-
* Cohere Rerank 3 - English
28
-
* Cohere Rerank 3 - Multilingual
27
+
* Cohere Rerank v3 - English
28
+
* Cohere Rerank v3 - Multilingual
29
29
30
30
You can browse the Cohere family of models in the [Model Catalog](model-catalog.md) by filtering on the Cohere collection.
31
31
32
-
### Cohere Rerank 3 - English
32
+
### Cohere Rerank v3 - English
33
33
34
34
Cohere Rerank English is a reranking model used for semantic search and retrieval-augmented generation (RAG). Rerank enables you to significantly improve search quality by augmenting traditional keyword-based search systems with a semantic-based reranking system that can contextualize the meaning of a user's query beyond keyword relevance. Cohere's Rerank delivers higher quality results than embedding-based search, lexical search, and even hybrid search, and it requires only adding a single line of code into your application.
35
35
@@ -42,7 +42,7 @@ Rerank supports JSON objects as documents where users can specify, at query time
42
42
43
43
Rerank English works well for code retrieval, semi-structured data retrieval, and long context.
44
44
45
-
### Cohere Rerank 3 - Multilingual
45
+
### Cohere Rerank v3 - Multilingual
46
46
47
47
Cohere Rerank Multilingual is a reranking model used for semantic search and retrieval-augmented generation (RAG). Rerank Multilingual supports more than 100 languages and can be used to search within a language (for example, to search with a French query on French documents) and across languages (for example, to search with an English query on Chinese documents). Rerank enables you to significantly improve search quality by augmenting traditional keyword-based search systems with a semantic-based reranking system that can contextualize the meaning of a user's query beyond keyword relevance. Cohere's Rerank delivers higher quality results than embedding-based search, lexical search, and even hybrid search, and it requires only adding a single line of code into your application.
48
48
@@ -64,49 +64,44 @@ You can deploy the previously mentioned Cohere models as a service with pay-as-y
64
64
### Prerequisites
65
65
66
66
- An Azure subscription with a valid payment method. Free or trial Azure subscriptions won't work. If you don't have an Azure subscription, create a [paid Azure account](https://azure.microsoft.com/pricing/purchase-options/pay-as-you-go) to begin.
67
-
- An [AI Foundry hub](../how-to/create-azure-ai-resource.md). The serverless API model deployment offering for Cohere Rerank is only available with hubs created in these regions:
68
-
69
-
* East US
70
-
* East US 2
71
-
* North Central US
72
-
* South Central US
73
-
* West US
74
-
* West US 3
75
-
* Sweden Central
76
-
77
-
For a list of regions that are available for each of the models supporting serverless API endpoint deployments, see [Region availability for models in serverless API endpoints](deploy-models-serverless-availability.md).
67
+
68
+
- An [Azure AI Foundry hub](../how-to/create-azure-ai-resource.md). The serverless API model deployment offering for Cohere Rerank is only available with hubs created in specific regions. For a list of regions that are available for each of the Cohere models that support serverless API endpoint deployments, see [Region availability for models in serverless API endpoints](deploy-models-serverless-availability.md#cohere-models).
78
69
79
70
- An [Azure AI Foundry project](../how-to/create-projects.md).
71
+
80
72
- Azure role-based access controls are used to grant access to operations in Azure AI Foundry portal. To perform the steps in this article, your user account must be assigned the __Azure AI Developer role__ on the resource group. For more information on permissions, see [Role-based access control in Azure AI Foundry portal](../concepts/rbac-ai-studio.md).
81
73
82
74
83
75
### Create a new deployment
84
76
85
-
The following steps demonstrate the deployment of Cohere Rerank 3 - English, but you can use the same steps to deploy Cohere Rerank 3 - Multilingual by replacing the model name.
77
+
The following steps demonstrate the deployment of Cohere Rerank v3 - English, but you can use the same steps to deploy Cohere Rerank v3 - Multilingual by replacing the model name.
86
78
87
79
To create a deployment:
88
80
89
-
1. Sign in to [Azure AI Foundry](https://ai.azure.com).
90
-
1. Select **Model catalog** from the left sidebar.
91
-
1. Search for *Cohere*.
92
-
1. Select **cohere-rerank-3-english** to open the Model Details page.
4. Select the model card of the model you want to deploy. In this article, you select **Cohere-rerank-v3-english** to open the Model Details page.
84
+
93
85
1. Select **Deploy** to open a serverless API deployment window for the model.
94
-
1. Alternatively, you can initiate a deployment by starting from your project in AI Foundry portal.
86
+
1. Alternatively, you can initiate a deployment from your project in the AI Foundry portal as follows:
95
87
96
88
1. From the left sidebar of your project, select **Models + Endpoints**.
97
-
1. Select **+ Deploy model**.
98
-
1. Search for and select **Cohere-rerank-3-english**. to open the Model Details page.
89
+
1. Select **+ Deploy model** > **Deploy base model**.
90
+
1. Search for and select **Cohere-rerank-v3-english** to open the Model Details page.
99
91
1. Select **Confirm** to open a serverless API deployment window for the model.
100
92
101
-
1. Select the project in which you want to deploy your model.
102
93
1. In the deployment wizard, select the link to **Azure Marketplace Terms** to learn more about the terms of use.
103
94
1. Select the **Pricing and terms** tab to learn about pricing for the selected model.
104
-
1. Select the **Subscribe and Deploy** button. If this is your first time deploying the model in the project, you have to subscribe your project for the particular offering. This step requires that your account has the **Azure AI Developer role** permissions on the resource group, as listed in the prerequisites. Each project has its own subscription to the particular Azure Marketplace offering of the model, which allows you to control and monitor spending. Currently, you can have only one deployment for each model within a project.
95
+
1. Select the **Subscribe and Deploy** button. If this is your first time deploying the model in the project, you have to subscribe your project for the particular offering.
96
+
97
+
> [!NOTE]
98
+
> This step requires that your account has the **Azure AI Developer role** permissions on the resource group, as listed in the prerequisites. Models that are offered by non-Microsoft providers (for example, Cohere models) are billed through the Azure Marketplace. For such models, you're required to subscribe your project to the particular model offering. Each project has its own subscription to the particular Azure Marketplace offering of the model, which allows you to control and monitor spending. Currently, you can have only one deployment for each model within a project.
99
+
105
100
1. Once you subscribe the project for the particular Azure Marketplace offering, subsequent deployments of the _same_ offering in the _same_ project don't require subscribing again. If this scenario applies to you, there's a **Continue to deploy** option to select.
106
101
107
102
1. Give the deployment a name. This name becomes part of the deployment API URL. This URL must be unique in each Azure region.
108
103
109
-
1. Select **Deploy**. Wait until the deployment is ready and you're redirected to the Deployments page.
104
+
1. Select **Deploy**. Wait until the deployment is ready and you're redirected to the **Model deployments** page.
110
105
1. On the Deployments page, select the deployment, and note the endpoint's **Target** URL and the Secret **Key**. For more information on using the APIs, see the [reference](#rerank-api-reference-for-cohere-rerank-models-deployed-as-a-service) section.
111
106
1.[!INCLUDE [Find your deployment details](../includes/find-deployments.md)]
112
107
@@ -122,11 +117,11 @@ Cohere Rerank models deployed as serverless APIs can be consumed using the Reran
122
117
123
118
1. Copy the **Target** URL and the **Key** value.
124
119
125
-
1. Cohere currently exposes `v1/rerank` for inference with the Rerank 3 - English and Rerank 3 - Multilingual models schema. For more information on using the APIs, see the [reference](#rerank-api-reference-for-cohere-rerank-models-deployed-as-a-service) section.
120
+
1. Cohere currently exposes `v1/rerank` for inference with the Rerank v3 - English and Rerank v3 - Multilingual models schema. For more information on using the APIs, see the [reference](#rerank-api-reference-for-cohere-rerank-models-deployed-as-a-service) section.
126
121
127
122
## Rerank API reference for Cohere Rerank models deployed as a service
128
123
129
-
Cohere Rerank 3 - English and Rerank 3 - Multilingual accept the native Cohere Rerank API on `v1/rerank`. This section contains details about the Cohere Rerank API.
124
+
Cohere Rerank v3 - English and Rerank v3 - Multilingual accept the native Cohere Rerank API on `v1/rerank`. This section contains details about the Cohere Rerank API.
130
125
131
126
#### v1/rerank request
132
127
@@ -139,7 +134,7 @@ Cohere Rerank 3 - English and Rerank 3 - Multilingual accept the native Cohere R
139
134
140
135
#### v1/rerank request schema
141
136
142
-
Cohere Rerank 3 - English and Rerank 3 - Multilingual accept the following parameters for a `v1/rerank` API call:
137
+
Cohere Rerank v3 - English and Rerank v3 - Multilingual accept the following parameters for a `v1/rerank` API call:
Cohere Command R 08-2024 | [Microsoft Managed Countries](/partner-center/marketplace/tax-details-marketplace#microsoft-managed-countriesregions) |East US <br> East US 2 <br> North Central US <br> South Central US <br> Sweden Central <br> West US <br> West US 3 | Not available |
20
20
Cohere Command R+ | [Microsoft Managed Countries](/partner-center/marketplace/tax-details-marketplace#microsoft-managed-countriesregions) <br> Japan <br> Qatar |East US <br> East US 2 <br> North Central US <br> South Central US <br> Sweden Central <br> West US <br> West US 3 | Not available |
21
21
Cohere Command R | [Microsoft Managed Countries](/partner-center/marketplace/tax-details-marketplace#microsoft-managed-countriesregions) <br> Japan <br> Qatar | East US <br> East US 2 <br> North Central US <br> South Central US <br> Sweden Central <br> West US <br> West US 3 | Not available |
22
-
Cohere Rerank 3 - English | [Microsoft Managed Countries](/partner-center/marketplace/tax-details-marketplace#microsoft-managed-countriesregions) <br> Japan <br> Qatar | East US <br> East US 2 <br> North Central US <br> South Central US <br> Sweden Central <br> West US <br> West US 3 | Not available |
23
-
Cohere Rerank 3 - Multilingual | [Microsoft Managed Countries](/partner-center/marketplace/tax-details-marketplace#microsoft-managed-countriesregions) <br> Japan <br> Qatar | East US <br> East US 2 <br> North Central US <br> South Central US <br> Sweden Central <br> West US <br> West US 3 | Not available |
24
-
Cohere Embed 3 - English | [Microsoft Managed Countries](/partner-center/marketplace/tax-details-marketplace#microsoft-managed-countriesregions) <br> Japan <br> Qatar |East US <br> East US 2 <br> North Central US <br> South Central US <br> Sweden Central <br> West US <br> West US 3 | Not available |
25
-
Cohere Embed 3 - Multilingual | [Microsoft Managed Countries](/partner-center/marketplace/tax-details-marketplace#microsoft-managed-countriesregions) <br> Japan <br> Qatar |East US <br> East US 2 <br> North Central US <br> South Central US <br> Sweden Central <br> West US <br> West US 3 | Not available |
22
+
Cohere Rerank v3 - English | [Microsoft Managed Countries](/partner-center/marketplace/tax-details-marketplace#microsoft-managed-countriesregions) <br> Japan <br> Qatar | East US <br> East US 2 <br> North Central US <br> South Central US <br> Sweden Central <br> West US <br> West US 3 | Not available |
23
+
Cohere Rerank v3 - Multilingual | [Microsoft Managed Countries](/partner-center/marketplace/tax-details-marketplace#microsoft-managed-countriesregions) <br> Japan <br> Qatar | East US <br> East US 2 <br> North Central US <br> South Central US <br> Sweden Central <br> West US <br> West US 3 | Not available |
24
+
Cohere Embed v3 - English | [Microsoft Managed Countries](/partner-center/marketplace/tax-details-marketplace#microsoft-managed-countriesregions) <br> Japan <br> Qatar |East US <br> East US 2 <br> North Central US <br> South Central US <br> Sweden Central <br> West US <br> West US 3 | Not available |
25
+
Cohere Embed v3 - Multilingual | [Microsoft Managed Countries](/partner-center/marketplace/tax-details-marketplace#microsoft-managed-countriesregions) <br> Japan <br> Qatar |East US <br> East US 2 <br> North Central US <br> South Central US <br> Sweden Central <br> West US <br> West US 3 | Not available |
Copy file name to clipboardExpand all lines: articles/search/cognitive-search-concept-image-scenarios.md
+1-1Lines changed: 1 addition & 1 deletion
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -149,7 +149,7 @@ This section supplements the [skill reference](cognitive-search-predefined-skill
149
149
150
150
1.[Create or update a skillset](/rest/api/searchservice/skillsets/create) to add skills.
151
151
152
-
1. Add templates for OCR and Image Analysis from the portal, or copy the definitions from the [skill reference](cognitive-search-predefined-skills.md) documentation. Insert them into the skills array of your skillset definition.
152
+
1. Add templates for OCR and Image Analysis from the Azure portal, or copy the definitions from the [skill reference](cognitive-search-predefined-skills.md) documentation. Insert them into the skills array of your skillset definition.
153
153
154
154
1. If necessary, [include a multi-service key](cognitive-search-attach-cognitive-services.md) in the Azure AI services property of the skillset. Azure AI Search makes calls to a billable Azure AI services resource for OCR and image analysis for transactions that exceed the free limit (20 per indexer per day). Azure AI services must be in the same region as your search service.
Copy file name to clipboardExpand all lines: articles/search/cognitive-search-defining-skillset.md
+3-3Lines changed: 3 additions & 3 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -8,7 +8,7 @@ ms.service: azure-ai-search
8
8
ms.custom:
9
9
- ignite-2023
10
10
ms.topic: conceptual
11
-
ms.date: 10/04/2024
11
+
ms.date: 12/06/2024
12
12
---
13
13
14
14
# Create a skillset in Azure AI Search
@@ -269,9 +269,9 @@ Although skill output can be optionally cached for reuse purposes, it's usually
269
269
270
270
## Tips for a first skillset
271
271
272
-
+ Try the [Import data wizard](search-import-data-portal.md).
272
+
+ Try the [Import data wizard](search-get-started-portal.md) or [Import and vectorize data wizard](search-get-started-portal-import-vectors.md).
273
273
274
-
The wizard automates several steps that can be challenging the first time around. It defines the skillset, index, and indexer, including field mappings and output field mappings. It also defines projections in a knowledge store if you're using one. For some skills, such as OCR or image analysis, the wizard adds utility skills that merge the image and text content that was separated during document cracking.
274
+
The wizards automate several steps that can be challenging the first time around. It defines the skillset, index, and indexer, including field mappings and output field mappings. It also defines projections in a knowledge store if you're using one. For some skills, such as OCR or image analysis, the wizard adds utility skills that merge the image and text content that was separated during document cracking.
275
275
276
276
After the wizard runs, you can open each object in the Azure portal to view its JSON definition.
Copy file name to clipboardExpand all lines: articles/search/cognitive-search-how-to-debug-skillset.md
+3-3Lines changed: 3 additions & 3 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -57,15 +57,15 @@ Debug sessions work with all generally available [indexer data sources](search-d
57
57
58
58
1. On the action bar at the top, select **Add debug session**.
59
59
60
-
:::image type="content" source="media/cognitive-search-debug/new-debug-session.png" lightbox="media/cognitive-search-debug/new-debug-session.png" alt-text="Screenshot of the debug sessions commands in the portal page." border="true":::
60
+
:::image type="content" source="media/cognitive-search-debug/new-debug-session.png" lightbox="media/cognitive-search-debug/new-debug-session.png" alt-text="Screenshot of the debug sessions commands in the Azure portal page." border="true":::
61
61
62
62
1. In **Debug session name**, provide a name that will help you remember which skillset, indexer, and data source the debug session is about.
63
63
64
64
1. In **Indexer template**, select the indexer that drives the skillset you want to debug. Copies of both the indexer and skillset are used to initialize the session.
65
65
66
66
1. In **Document to debug**, choose the first document in the index or select a specific document. If you select a specific document, depending on the data source, you're asked for a URI or a row ID.
67
67
68
-
If your specific document is a blob, provide the blob URI. You can find the URI in the blob property page in the portal.
68
+
If your specific document is a blob, provide the blob URI. You can find the URI in the blob property page in the Azure portal.
69
69
70
70
:::image type="content" source="media/cognitive-search-debug/copy-blob-url.png" lightbox="media/cognitive-search-debug/copy-blob-url.png" alt-text="Screenshot of the URI property in blob storage." border="true":::
71
71
@@ -87,7 +87,7 @@ It's expected for a debug session to take longer to execute than the indexer sin
87
87
88
88
## Start with errors and warnings
89
89
90
-
Indexer execution history in the portal gives you the full error and warning list for all documents. In a debug session, the errors and warnings are limited to one document. You can work through this list, make your changes, and then return to the list to verify whether issues are resolved.
90
+
Indexer execution history in the Azure portal gives you the full error and warning list for all documents. In a debug session, the errors and warnings are limited to one document. You can work through this list, make your changes, and then return to the list to verify whether issues are resolved.
91
91
92
92
Remember that a debug session is based on one document from the entire index. If an input or output looks wrong, the problem could be specific to that document. You can choose a different document to confirm whether errors and warnings are pervasive or specific to a single document.
0 commit comments