Skip to content

Commit 52cc33d

Browse files
Merge pull request #209139 from DenKenMSFT/UserStory1974326
Removed references to Search API
2 parents 2b002ab + f710f54 commit 52cc33d

File tree

7 files changed

+25
-25
lines changed

7 files changed

+25
-25
lines changed

articles/cognitive-services/openai/concepts/models.md

Lines changed: 7 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -55,13 +55,13 @@ Another area where Davinci excels is in understanding the intent of text. Davinc
5555

5656
### Curie
5757

58-
Curie is extremely powerful, yet very fast. While Davinci is stronger when it comes to analyzing complicated text, Curie is quite capable for many nuanced tasks like sentiment classification and summarization. Curie is also good at answering questions and performing Q&A and as a general service chatbot.
58+
Curie is powerful, yet fast. While Davinci is stronger when it comes to analyzing complicated text, Curie is capable for many nuanced tasks like sentiment classification and summarization. Curie is also good at answering questions and performing Q&A and as a general service chatbot.
5959

6060
**Use for**: Language translation, complex classification, text sentiment, summarization
6161

6262
### Babbage
6363

64-
Babbage can perform straightforward tasks like simple classification. It’s also quite capable when it comes to Semantic Search ranking how well documents match up with search queries.
64+
Babbage can perform straightforward tasks like simple classification. It’s also capable when it comes to semantic search ranking how well documents match up with search queries.
6565

6666
**Use for**: Moderate classification, semantic search classification
6767

@@ -78,7 +78,7 @@ Ada is usually the fastest model and can perform tasks like parsing text, addres
7878

7979
The Codex models are descendants of our base GPT-3 models that can understand and generate code. Their training data contains both natural language and billions of lines of public code from GitHub.
8080

81-
They’re most capable in Python and proficient in over a dozen languages including JavaScript, Go, Perl, PHP, Ruby, Swift, TypeScript, SQL, and even Shell.
81+
They’re most capable in Python and proficient in over a dozen languages, including C#, JavaScript, Go, Perl, PHP, Ruby, Swift, TypeScript, SQL, and even Shell.
8282

8383
Currently we only offer one Codex model: `code-cushman-001`.
8484

@@ -90,7 +90,7 @@ Ada (1024 dimensions),
9090
Babbage (2048 dimensions),
9191
Curie (4096 dimensions),
9292
Davinci (12,288 dimensions).
93-
Davinci is the most capable, but is slower and more expensive than the other models. Ada is the least capable, but is significantly faster and cheaper.
93+
Davinci is the most capable, but is slower and more expensive than the other models. Ada is the least capable, but is both faster and cheaper.
9494

9595
These embedding models are specifically created to be good at a particular task.
9696

@@ -112,17 +112,17 @@ These models help measure whether long documents are relevant to a short search
112112

113113
### Code search embeddings
114114

115-
Similarly to search embeddings, there are two types: one for embedding code snippets to be retrieved and one for embedding natural language search queries.
115+
Similar to text search embeddings, there are two types: one for embedding code snippets to be retrieved and one for embedding natural language search queries.
116116

117117
| USE CASES | AVAILABLE MODELS |
118118
|---|---|
119119
| Code search and relevance | code-search-ada-code-001, <br> code-search-ada-text-001, <br> code-search-babbage-code-001, <br> code-search-babbage-text-001 |
120120

121-
When using our embedding models, please keep in mind their limitations and risks.
121+
When using our embedding models, keep in mind their limitations and risks.
122122

123123
## Finding the right model
124124

125-
We recommend starting with our Davinci model since it will be the best way to understand what the service is capable of. After you have an idea of what you want to accomplish, you can either stay with Davinci if you’re not concerned about cost and speed or move onto Curie or another model and try to optimize around its capabilities.
125+
We recommend starting with our Davinci model since it will be the best way to understand what the service is capable of. After you have an idea of what you want to accomplish, you can either stay with Davinci if you’re not concerned about cost and speed, or you can move onto Curie or another model and try to optimize around its capabilities.
126126

127127
## Next steps
128128

articles/cognitive-services/openai/how-to/embeddings.md

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -20,7 +20,7 @@ An embedding is a special format of data representation that can be easily utili
2020

2121
## How to get embeddings
2222

23-
To obtain an embedding vector for a piece of text we make a request to the embeddings endpoint as shown in the following code snippets:
23+
To obtain an embedding vector for a piece of text, we make a request to the embeddings endpoint as shown in the following code snippets:
2424

2525
```console
2626
curl https://YOUR_RESOURCE_NAME.openai.azure.com/openai/deployments/YOUR_DEPLOYMENT_NAME/embeddings?api-version=2022-06-01-preview\
@@ -33,19 +33,19 @@ curl https://YOUR_RESOURCE_NAME.openai.azure.com/openai/deployments/YOUR_DEPLOYM
3333

3434
### Verify inputs don't exceed the maximum length
3535

36-
The maximum length of input text for our embedding models are 2048 tokens (approximately equivalent to around 2-3 pages of text). You should verify that your inputs don't exceed this limit before making a request.
36+
The maximum length of input text for our embedding models is 2048 tokens (equivalent to around 2-3 pages of text). You should verify that your inputs don't exceed this limit before making a request.
3737

3838
### Choose the best model for your task
3939

40-
For the search models you can obtain embeddings in two ways. The `<search_model>-doc` model is used for longer pieces of text (to be searched over) and the `<search_model>-query` model is used for shorter pieces of text, typically queries or class labels in zero shot classification. You can read more about all of the embeddings models in our [Models](../concepts/models.md) guide.
40+
For the search models, you can obtain embeddings in two ways. The `<search_model>-doc` model is used for longer pieces of text (to be searched over) and the `<search_model>-query` model is used for shorter pieces of text, typically queries or class labels in zero shot classification. You can read more about all of the Embeddings models in our [Models](../concepts/models.md) guide.
4141

4242
### Replace newlines with a single space
4343

44-
Unless you are embedding code, we suggest replacing newlines (\n) in your input with a single space, as we have observed inferior results when newlines are present.
44+
Unless you're embedding code, we suggest replacing newlines (\n) in your input with a single space, as we have observed inferior results when newlines are present.
4545

4646
## Limitations & risks
4747

48-
Our embedding models may be unreliable or pose social risks in certain cases, and may cause harm in the absence of mitigations. Please review our Responsible AI content for more information on how to approach their use responsibly.
48+
Our embedding models may be unreliable or pose social risks in certain cases, and may cause harm in the absence of mitigations. Review our Responsible AI content for more information on how to approach their use responsibly.
4949

5050
## Next steps
5151

articles/cognitive-services/openai/how-to/managed-identity.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -63,10 +63,10 @@ Assigning yourself to the Cognitive Services User role will allow you to use you
6363
Use the access token to authorize your API call by setting the `Authorization` header value.
6464
6565
```bash
66-
curl ${endpoint%/}/openai/deployment/YOUR_DEPLOYMNET_NAME/search?api-version=2022-06-01-preview \
66+
curl ${endpoint%/}/openai/deployment/YOUR_DEPLOYMENT_NAME/completions?api-version=2022-06-01-preview \
6767
-H "Content-Type: application/json" \
6868
-H "Authorization: Bearer $accessToken" \
69-
-d '{ "documents": ["White House", "hospital", "school"], "query": "the president"}'
69+
-d '{ "prompt": "Once upon a time" }'
7070
```
7171
7272
## Authorize access to managed identities

articles/cognitive-services/openai/includes/python.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
11
---
22
title: 'Quickstart: Use the OpenAI Service via the Python SDK'
33
titleSuffix: Azure OpenAI
4-
description: Walkthrough on how to get started with Azure OpenAI and make your first completions and search calls with the Python SDK.
4+
description: Walkthrough on how to get started with Azure OpenAI and make your first completions call with the Python SDK.
55
services: cognitive-services
66
manager: nitinme
77
ms.service: cognitive-services

articles/cognitive-services/openai/includes/rest.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
11
---
2-
title: 'Quickstart: Use the OpenAI Service to make your first completions and search calls with the REST API'
2+
title: 'Quickstart: Use the OpenAI Service to make your first completions call with the REST API'
33
titleSuffix: Azure OpenAI
4-
description: Walkthrough on how to get started with Azure OpenAI and make your first completions and search calls with the REST API.
4+
description: Walkthrough on how to get started with Azure OpenAI and make your first completions call with the REST API.
55
services: cognitive-services
66
manager: nitinme
77
ms.service: cognitive-services

articles/cognitive-services/openai/includes/studio.md

Lines changed: 7 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
11
---
22
title: 'Quickstart: Use the OpenAI Service via the Azure OpenAI Studio'
33
titleSuffix: Azure OpenAI
4-
description: Walkthrough on how to get started with Azure OpenAI and make your first completions and search calls with Azure OpenAI Studio.
4+
description: Walkthrough on how to get started with Azure OpenAI and make your first completions call with Azure OpenAI Studio.
55
services: cognitive-services
66
manager: nitinme
77
ms.service: cognitive-services
@@ -14,8 +14,8 @@ keywords:
1414
## Prerequisites
1515

1616
- An Azure subscription - <a href="https://azure.microsoft.com/free/cognitive-services" target="_blank">Create one for free</a>
17-
- Access granted to service in the desired Azure subscription. This service is currently invite only. You can fill out a new use case request here: <a href="https://aka.ms/oai/access" target="_blank">https://aka.ms/oai/access</a>
18-
- An Azure OpenAI Service resource with a model deployed. If you don't have a resource/model the process is documented in our [resource deployment guide](../how-to/create-resource.md)
17+
- Access granted to service in the desired Azure subscription. Currently, this service is available only by invitation. You can fill out a new use case request here: <a href="https://aka.ms/oai/access" target="_blank">https://aka.ms/oai/access</a>
18+
- An Azure OpenAI Service resource with a model deployed. If you don't have a resource/model, the process is documented in our [resource deployment guide](../how-to/create-resource.md)
1919

2020
## Go to the Azure OpenAI Studio
2121

@@ -27,22 +27,22 @@ You'll first land on our main page for the Azure OpenAI Studio and from here you
2727

2828
:::image type="content" source="../media/quickstarts/studio-start.png" alt-text="Screenshot of the landing page of the Azure OpenAI Studio with sections highlighted." lightbox="../media/quickstarts/studio-start.png":::
2929

30-
- Resources without a deployment will be prompted to create one. This is required to be able to inference with your models
30+
- Resources without a deployment will be prompted to create one. A deployment is required to be able to inference with your models
3131
- Get started with a few simple examples that demonstrate the capabilities of the service
3232
- Navigate to different parts of the Studio including the **Playground** for experimentation and our fine-tuning workflow
3333
- Find quick links to other helpful resources like documentation and community forums
3434

35-
From here, select the **create new deployment** button in the banner at the top. If you don't see this, you already have a deployment and can proceed to the 'playground' step.
35+
From here, select the **create new deployment** button in the banner at the top. If you don't see this button, you already have a deployment and can proceed to the [Playground](#playground) step.
3636

3737
## Deployments
3838

39-
Before you can generate text or inference, you need to deploy a model. This is done by clicking the **create new deployment** on the deployments page. From here you can select from one of our many available models. For getting started we recommend `text-davinci-002` for users in South Central and `text-davinci-001` for users in West Europe (`text-davinci-002` isn't available in this region).
39+
Before you can generate text or inference, you need to deploy a model by clicking the **create new deployment** button on the deployments page. From here you can select from one of our many available models. For getting started we recommend selecting the `text-davinci-002` model.
4040

4141
Once this is complete, select the 'Playground' button on the left nav to start experimenting.
4242

4343
## Playground
4444

45-
The best way to start exploring completions is through our Playground. It's simply a text box where you can submit a prompt to generate a completion. From this page you can easily iterate and experiment with the capabilities. The following is an overview of the features available to you on this page:
45+
The best way to start exploring completions is through our Playground. It's simply a text box where you can submit a prompt to generate a completion. From this page, you can easily iterate and experiment with the capabilities. The following list is an overview of the features available to you on this page:
4646

4747
:::image type="content" source="../media/quickstarts/playground-load.png" alt-text="Screenshot of the playground page of the Azure OpenAI Studio with sections highlighted." lightbox="../media/quickstarts/playground-load.png":::
4848

articles/cognitive-services/openai/quickstart.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
11
---
22
title: 'Quickstart - Deploy a model and generate text using Azure OpenAI'
33
titleSuffix: Azure OpenAI
4-
description: Walkthrough on how to get started with Azure OpenAI and make your first completions and search calls.
4+
description: Walkthrough on how to get started with Azure OpenAI and make your first completions call.
55
services: cognitive-services
66
manager: nitinme
77
ms.service: cognitive-services

0 commit comments

Comments
 (0)