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: docs/source/guide/prompts_create.md
+15-9
Original file line number
Diff line number
Diff line change
@@ -108,25 +108,18 @@ From the Prompts page, click **Create Prompt** in the upper right and then compl
108
108
| --- | --- |
109
109
| Name | Enter a name for the Prompt. |
110
110
| Description | Enter a description for the Prompt. |
111
-
| Type | Select the Prompt model type: [Text Classification](#Text-classification) or [Named Entity Recognition](#Named-entity-recognition-NER)|
112
-
| Target Project| Select the project you want to use. If you don't have any eligible projects, you will see an error message. <br><br>See the note below. |
113
-
| Classes | This list is automatically generated from the labeling configuration of the target project. |
111
+
| Target Project| Select the project you want to use. If you don't have any eligible projects, you will see an error message. <br>See the note below. <br><br>When you select a project, additional information about the labeling config appears. This includes the classes that will be used when applying the prompt. |
114
112
115
113
</div>
116
114
117
115
!!! note Eligible projects
118
116
Target projects must meet the following criteria:
119
-
* The labeling configuration for the project must be compatible with the **Type** you selected above:
120
-
* For text classification, this means that the labeling configuration for the project must use `Choice` tags.
121
-
* For NER, this means that the labeling configuration for the project must use `Label` tags.
122
-
* The project must have one output type (`Choice` or `Label`) and not a mix of both.
123
-
* The project cannot include multiple `Choices` or `Labels` blocks in its labeling configuration.
124
117
* The project must include text data. While it can include other data types such as images or video, it must include `<Text>`.
125
118
* 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.
126
119
* The project cannot be located in your Personal Sandbox workspace.
127
120
* 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 as this can interfere with how accuracy and score are calculated when evaluating the prompt.
128
121
129
-
## Types
122
+
## Example project types
130
123
131
124
### Text classification
132
125
@@ -154,3 +147,16 @@ Some examples include:
154
147
***Intelligence and Risk Analysis**: By extracting entities such as personal names, organizations, IP addresses, and financial transactions from suspicious activity reports or communications, organizations can better assess risks and detect fraud or criminal activity.
155
148
***Specialized Document Review**: Once trained, NER can help extract industry-specific key entities for better document review, searching, and classification.
156
149
***Customer Feedback and Product Review**: Extract named entities like product names, companies, or services from customer feedback or reviews. This allows businesses to categorize and analyze feedback based on specific products, people, or regions, helping them make data-driven improvements.
150
+
151
+
### Text summarization
152
+
153
+
Text summarization involves condensing large amounts of information into concise, meaningful summaries.
154
+
155
+
Models can be trained or fine-tuned to recognize essential information within a document and generate summaries that retain the core ideas while omitting less critical details. This capability is especially valuable in today’s information-heavy landscape, where professionals across various fields are often overwhelmed by the sheer volume of text data.
156
+
157
+
Some examples include:
158
+
159
+
***Customer Support and Feedback Analysis**: Companies receive vast volumes of customer support tickets, reviews, and feedback that are often repetitive or lengthy. Auto-labeling can help summarize these inputs, focusing on core issues or themes, such as “billing issues” or “technical support.”
160
+
***News Aggregation and Media Monitoring**: News organizations and media monitoring platforms need to process and distribute news stories efficiently. Auto-labeling can summarize articles while tagging them with labels like “politics,” “economy,” or “health,” making it easier for users to find relevant stories.
161
+
***Document Summarization**: Professionals often need to quickly understand the key points in lengthy contracts, research papers, and files.
162
+
***Educational Content Summarization**: EEducators and e-learning platforms need to distill complex material into accessible summaries for students. Auto-labeling can summarize key topics and categorize them under labels like “concept,” “example,” or “important fact.”
Copy file name to clipboardexpand all lines: docs/source/guide/prompts_draft.md
+6-14
Original file line number
Diff line number
Diff line change
@@ -60,7 +60,7 @@ When you evaluate a prompt, you will see the following metrics:
60
60
<tr>
61
61
<th>Metric</th>
62
62
<th>Tasks</th>
63
-
<th>Type</th>
63
+
<th>Config</th>
64
64
<th>Description</th>
65
65
</tr>
66
66
</thead>
@@ -76,9 +76,7 @@ Ground Truths
76
76
</td>
77
77
<td>
78
78
79
-
Text classification
80
-
81
-
NER
79
+
All labeling configs
82
80
83
81
</td>
84
82
<td>
@@ -101,9 +99,7 @@ All task types
101
99
</td>
102
100
<td>
103
101
104
-
Text classification
105
-
106
-
NER
102
+
All labeling configs
107
103
108
104
</td>
109
105
<td>
@@ -124,9 +120,9 @@ Ground Truths
124
120
</td>
125
121
<td>
126
122
127
-
Text classification
123
+
Single `<Choices>`
128
124
129
-
NER
125
+
Single `<Labels>`
130
126
131
127
</td>
132
128
<td>
@@ -159,9 +155,7 @@ All task types
159
155
</td>
160
156
<td>
161
157
162
-
Text classification
163
-
164
-
NER
158
+
All labeling configs
165
159
166
160
</td>
167
161
<td>
@@ -195,8 +189,6 @@ Auto-refinement applies your initial prompt and the Teacher Model to generate pr
195
189
Your Teacher Model evaluates the initial prompt’s predictions against the ground truth (or sample task output) and identifies areas for improvement. It then suggests a refined prompt, aimed at achieving closer alignment with the desired outcomes.
196
190
197
191
198
-
199
-
200
192
## Drafting effective prompts
201
193
202
194
For a comprehensive guide to drafting prompts, see [The Prompt Report: A Systematic Survey of Prompting Techniques](https://arxiv.org/abs/2406.06608) or OpenAI's guide to [Prompt Engineering](https://platform.openai.com/docs/guides/prompt-engineering).
|**Supported base models**| OpenAI gpt-3.5-turbo-16k* <br>OpenAI gpt-3.5-turbo* <br>OpenAI gpt-4 <br>OpenAI gpt-4-turbo <br>OpenAI gpt-4o <br>OpenAI gpt-4o-mini<br>[Azure OpenAI chat-based models](https://learn.microsoft.com/en-us/azure/ai-services/openai/concepts/models)<br>[Custom LLM](prompts_create#Add-OpenAI-Azure-OpenAI-or-a-custom-model)<br><br>**Note:** We recommend against using GPT 3.5 models, as these can sometimes be prone to rate limit errors. |
139
139
|**Text compatibility**| Task text must be utf-8 compatible |
140
140
|**Task size**| Total size of each task can be no more than 1MB (approximately 200-500 pages of text) |
141
141
|**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 |
0 commit comments