Skip to content

Commit

Permalink
docs: DOCS-252: Update Prompts for multi-class selection (#6451)
Browse files Browse the repository at this point in the history
Co-authored-by: caitlinwheeless <[email protected]>
  • Loading branch information
caitlinwheeless and caitlinwheeless authored Sep 30, 2024
1 parent b648cb5 commit 2d1775d
Show file tree
Hide file tree
Showing 2 changed files with 6 additions and 7 deletions.
10 changes: 4 additions & 6 deletions docs/source/guide/prompts_create.md
Original file line number Diff line number Diff line change
Expand Up @@ -15,10 +15,7 @@ date: 2024-06-11 16:53:16
## Prerequisites

* An OpenAI API key or an Azure OpenAI key.
* A project that meets the following criteria:
* Text-based data set (meaning you are annotating text and not image or video files).
* The labeling configuration for the project must be set up to use single-class classification (`choice="single"`).
* (Optional, depending on your [use case](prompts_overview#Use-cases) and if you want to evaluate the accuracy of your prompt): At least one task with a [ground truth annotation](quality#Define-ground-truth-annotations-for-a-project).
* A project that meets the [criteria noted below](#Create-a-Prompt).

## Model provider API keys

Expand Down Expand Up @@ -99,11 +96,12 @@ From the Prompts page, click **Create Prompt** in the upper right and then compl
Target projects must meet the following criteria:
* The labeling configuration for the project must be compatible with the **Type** you selected above:
* For text classification, this means that the labeling configuration for the project must use `Choice` tags.
* For NER, this means that the labeling configuration for the project must use `Label` tags.
* The labeling configuration cannot include multi-class classification. This means that setting the `choice="multiple"` parameter is not supported for either the `<Labels>` or `<Choices>` tags.
* For NER, this means that the labeling configuration for the project must use `Label` tags.
* The project must have one output type (`Choice` or `Label`) and not a mix of both.
* The project must include text data. While it can include other data types such as images or video, it must include `<Text>`.
* You must have access to the project. If you are in the Manager role, you need to be added to the project to have access.
* The project cannot be located in your Personal Sandbox workspace.
* While projects connected to an ML backend will still appear in the list of eligible projects, we do not recommend using Prompts with an ML backend.

## Types

Expand Down
3 changes: 2 additions & 1 deletion docs/source/guide/prompts_overview.md
Original file line number Diff line number Diff line change
Expand Up @@ -134,12 +134,13 @@ This feedback loop allows you to iteratively fine-tune your prompts, optimizing
| --- | --- |
| **Supported data types** | Text |
| **Supported model types** | Text Classification <br>Named Entity Recognition (NER) |
| **Class selection** | Single selection (the LLM can apply one label per task)|
| **Class selection** | Multi-selection (the LLM can apply multiple labels per task)|
| **Supported base models** | OpenAI gpt-3.5-turbo-16k <br>OpenAI gpt-3.5-turbo-instruct* <br>OpenAI gpt-4-turbo <br>OpenAI gpt-3.5-turbo <br>OpenAI gpt-4o <br>OpenAI gpt-4<br>[Azure OpenAI chat-based models](https://learn.microsoft.com/en-us/azure/ai-services/openai/concepts/models) |
| **Text compatibility** | Task text must be utf-8 compatible |
| **Task size** | Total size of each task can be no more than 1MB (approximately 200-500 pages of text) |
| **Network access** | If you are using a firewall or restricting network access to your OpenAI models, you will need to allow the following IPs: <br>3.219.3.197 <br>34.237.73.3 <br>4.216.17.242 |
| **Required permissions** | **Owners, Administrators, Managers** -- Can create Prompt models and update projects with auto-annotations. Managers can only apply models to projects in which they are already a member. <br><br>**Reviewers and Annotators** -- No access to the Prompts tool, but can see the predictions generated by the prompts from within the project (depending on your [project settings](project_settings_lse)). |
| **ML backend support** | Prompts should not be used with a project that is connected to an ML backend. |
| **Enterprise vs. Open Source** | Label Studio Enterprise (Cloud only)|

</div>
Expand Down

0 comments on commit 2d1775d

Please sign in to comment.