Skip to content

Commit bcf5156

Browse files
ohltylerohltyler
authored
Final wording updates (#589)
* Wording updates Signed-off-by: Tyler Ohlsen <ohltyler@amazon.com> * More changes Signed-off-by: Tyler Ohlsen <ohltyler@amazon.com> * more changes Signed-off-by: Tyler Ohlsen <ohltyler@amazon.com> * more changes Signed-off-by: Tyler Ohlsen <ohltyler@amazon.com> * more updates Signed-off-by: Tyler Ohlsen <ohltyler@amazon.com> * More updates Signed-off-by: Tyler Ohlsen <ohltyler@amazon.com> * Update UT Signed-off-by: Tyler Ohlsen <ohltyler@amazon.com> * add learn more link Signed-off-by: Tyler Ohlsen <ohltyler@amazon.com> --------- Signed-off-by: Tyler Ohlsen <ohltyler@amazon.com>
1 parent fb7b64d commit bcf5156

39 files changed

+300
-235
lines changed

‎common/constants.ts

+24-20
Original file line numberDiff line numberDiff line change
@@ -162,12 +162,12 @@ export const UI_METADATA_SCHEMA_VERSION = 1;
162162

163163
// frontend-specific workflow types, derived from the available preset templates
164164
export enum WORKFLOW_TYPE {
165-
SEMANTIC_SEARCH = 'Semantic search',
166-
MULTIMODAL_SEARCH = 'Multimodal search',
167-
HYBRID_SEARCH = 'Hybrid search',
168-
RAG = 'Retrieval-augmented generation',
169-
VECTOR_SEARCH_WITH_RAG = 'Vector search with retrieval-augmented generation',
170-
CUSTOM = 'Custom',
165+
SEMANTIC_SEARCH = 'Semantic Search',
166+
MULTIMODAL_SEARCH = 'Multimodal Search',
167+
HYBRID_SEARCH = 'Hybrid Search',
168+
RAG = 'RAG with Lexical Retrieval',
169+
VECTOR_SEARCH_WITH_RAG = 'RAG with Vector Retrieval',
170+
CUSTOM = 'Custom Search',
171171
UNKNOWN = 'Unknown',
172172
}
173173
// If no datasource version is found, we default to 2.17.0
@@ -579,43 +579,46 @@ export enum TRANSFORM_CONTEXT {
579579
OUTPUT = 'output',
580580
}
581581
export enum TRANSFORM_TYPE {
582-
STRING = 'String',
583-
FIELD = 'Field',
584-
EXPRESSION = 'JSONPath Expression',
582+
STRING = 'Custom string',
583+
FIELD = 'Data field',
584+
EXPRESSION = 'JSONPath expression',
585585
TEMPLATE = 'Prompt',
586586
}
587587

588588
export const INPUT_TRANSFORM_OPTIONS = [
589589
{
590590
id: TRANSFORM_TYPE.FIELD,
591-
description: 'Map an existing field from your data.',
591+
description:
592+
'Use an existing field from your data as the model input field.',
592593
},
593594
{
594595
id: TRANSFORM_TYPE.EXPRESSION,
595-
description: 'Extract data before mapping to the input field.',
596+
description:
597+
'Extract data from a JSON structure and map the extracted data to the model input field.',
596598
},
597599
{
598600
id: TRANSFORM_TYPE.TEMPLATE,
599-
description: 'Configure a prompt and map to the input field.',
601+
description: 'Configure a prompt to map data to the model input field.',
600602
},
601603
{
602604
id: TRANSFORM_TYPE.STRING,
603-
description: 'Declare a string to the input field.',
605+
description: 'Use a custom string in the model input field.',
604606
},
605607
];
606608

607609
export const OUTPUT_TRANSFORM_OPTIONS = [
608610
{
609-
id: TRANSFORM_TYPE.FIELD,
610-
description: 'Map an existing field from your data.',
611+
id: NO_TRANSFORMATION,
612+
description: '',
611613
},
612614
{
613-
id: TRANSFORM_TYPE.EXPRESSION,
614-
description: 'Extract data before mapping to the input field.',
615+
id: TRANSFORM_TYPE.FIELD,
616+
description: 'Copy the model output into a new document field.',
615617
},
616618
{
617-
id: NO_TRANSFORMATION,
618-
description: 'Leave the output field as-is.',
619+
id: TRANSFORM_TYPE.EXPRESSION,
620+
description:
621+
'Extract data from a JSON structure and map the extracted data to a new document field.',
619622
},
620623
];
621624

@@ -647,6 +650,7 @@ export const MAX_DESCRIPTION_LENGTH = 1000;
647650
export const MAX_JSON_STRING_LENGTH = 10000;
648651
export const MAX_TEMPLATE_STRING_LENGTH = 10000;
649652
export const MAX_BYTES = 1048576; // OSD REST request payload size limit
653+
export const MAX_BYTES_FORMATTED = '1,048,576';
650654
export const MAX_WORKFLOW_NAME_TO_DISPLAY = 40;
651655
export const WORKFLOW_NAME_REGEXP = RegExp('^[a-zA-Z0-9_-]*$');
652656
export const INDEX_NAME_REGEXP = WORKFLOW_NAME_REGEXP;
@@ -670,7 +674,7 @@ export const MODEL_OUTPUT_SCHEMA_NESTED_PATH =
670674
'output.properties.inference_results.items.properties.output.items.properties.dataAsMap.properties';
671675
export const MODEL_OUTPUT_SCHEMA_FULL_PATH = 'output.properties';
672676
export enum CONFIG_STEP {
673-
INGEST = 'Ingestion pipeline',
677+
INGEST = 'Ingest pipeline',
674678
SEARCH = 'Search pipeline',
675679
}
676680
export enum SOURCE_OPTIONS {

‎documentation/tutorial.md

+3-3
Original file line numberDiff line numberDiff line change
@@ -75,11 +75,11 @@ Click "Save" to return to the form.
7575

7676
### Aside: advanced data transformations
7777

78-
Continuing with the above example, let's suppose the input data (the document) is more complex, and a simple field-level mapping is not sufficient. Maybe you need to parse out some nested field's value. This can be done by changing the transform type to `Expression`
78+
Continuing with the above example, let's suppose the input data (the document) is more complex, and a simple field-level mapping is not sufficient. Maybe you need to parse out some nested field's value. This can be done by changing the transformation type to `Expression`
7979

8080
![expression-ingest](./images/expression-ingest.png)
8181

82-
From there, click "Configure" to open the "Extract data with expression" modal. On the right-hand side, you can click "Run preview" to fetch the input data to this processor.
82+
From there, click "Configure" to open the "Configure JSONPath expression" modal. On the right-hand side, you can click "Run preview" to fetch the input data to this processor.
8383

8484
![expression-modal-ingest](./images/expression-modal-ingest.png)
8585

@@ -282,7 +282,7 @@ Nothing special needs to be configured.
282282

283283
### Search pipeline
284284

285-
Single ML inference **search response** processor. Choose `Template` as the transform type for the `prompt` input field. Open up the template configuration by clicking "Configure". Select a preset to start with for your convenience. Then, create an input variable that parses out the list of reviews, something like `review`. Inject the variable into the prompt by copying and pasting it. Click "Run preview" to test that the final transformed prompt with sample dynamic data looks as expected. Click "Save" to save and exit.
285+
Single ML inference **search response** processor. Choose `Template` as the transformation type for the `prompt` input field. Open up the template configuration by clicking "Configure". Select a preset to start with for your convenience. Then, create an input variable that parses out the list of reviews, something like `review`. Inject the variable into the prompt by copying and pasting it. Click "Run preview" to test that the final transformed prompt with sample dynamic data looks as expected. Click "Save" to save and exit.
286286

287287
---
288288

‎public/component_types/indices/base_index.ts

+1-1
Original file line numberDiff line numberDiff line change
@@ -17,7 +17,7 @@ export class BaseIndex extends BaseComponent {
1717
this.label = 'Index';
1818
this.description =
1919
category === COMPONENT_CATEGORY.INGEST
20-
? 'Ingest index'
20+
? 'Index for ingesting data'
2121
: 'Retrieval index';
2222
this.inputs = [
2323
{

‎public/pages/workflow_detail/components/edit_workflow_metadata_modal.tsx

+1-1
Original file line numberDiff line numberDiff line change
@@ -216,7 +216,7 @@ export function EditWorkflowMetadataModal(
216216
fullWidth={true}
217217
fieldPath={`description`}
218218
showError={true}
219-
placeholder="Provide a description for identifying this workflow."
219+
placeholder="Provide a description for this workflow."
220220
textArea={true}
221221
/>
222222
</EuiFlexItem>

‎public/pages/workflow_detail/components/export_modal.tsx

+3-3
Original file line numberDiff line numberDiff line change
@@ -106,16 +106,16 @@ export function ExportModal(props: ExportModalProps) {
106106
)}
107107
<EuiFlexItem grow={false}>
108108
<EuiText size="s">
109-
{`To build out identical resources in other environments, create and provision a workflow using the below template.`}{' '}
109+
{`To build identical resources in other environments, create and provision a workflow following the below template.`}{' '}
110110
<EuiLink href={CREATE_WORKFLOW_LINK} target="_blank">
111111
Learn more
112112
</EuiLink>
113113
</EuiText>
114114
<EuiText
115115
size="s"
116116
color="subdued"
117-
>{`Note: certain resource IDs in the template, such as model IDs, may be cluster-specific and not work out-of-the-box
118-
in other environments. Ensure these values are updated before attempting to provision in other environments.`}</EuiText>
117+
>{`Note: Certain resource IDs in the template, such as model IDs, may be specific to a cluster and not function properly
118+
in other clusters. Make sure to update these values before provisioning the workflow in a new cluster.`}</EuiText>
119119
</EuiFlexItem>
120120
<EuiFlexItem>
121121
<EuiFlexGroup direction="row" justifyContent="spaceBetween">

0 commit comments

Comments
 (0)