Skip to content

suggested mappings [DOC-993] #7008

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 6 commits into from
Sep 19, 2024
Merged

suggested mappings [DOC-993] #7008

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
6 commits
Select commit Hold shift + click to select a range
b8c1aba
suggested mappings [netlify-build]
stayseesong Sep 4, 2024
a7b4c8a
add to destination actions
stayseesong Sep 5, 2024
4528f4a
Apply suggestions from code review
stayseesong Sep 5, 2024
24d602e
[netlify-build]
stayseesong Sep 5, 2024
fc0ed98
Merge branch 'develop' into DOC-993
stayseesong Sep 16, 2024
ebabea6
Apply suggestions from code review
stayseesong Sep 16, 2024
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
143 changes: 143 additions & 0 deletions src/_includes/content/suggested-mappings-nutrition-facts.html
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,143 @@
<style type="text/css">
@font-face {
font-family: 'SF Pro Text';
src: url('fonts/sf-pro/SFProText-Regular.eot');
src: url('fonts/sf-pro/SFProText-Regular.eot?#iefix') format('embedded-opentype');
font-style: normal;
}
doc-content.ol{margin:0;padding:0}
doc-content.table td,table th{padding:0}
.c9{border-right-style:solid;padding:5pt 5pt 5pt 5pt;border-bottom-color:#000000;border-top-width:1pt;border-right-width:3pt;border-left-color:#000000;vertical-align:top;border-right-color:#000000;border-left-width:3pt;border-top-style:solid;border-left-style:solid;border-bottom-width:3pt;width:468pt;border-top-color:#000000;border-bottom-style:solid}
.c28{border-right-style:solid;padding:5pt 5pt 5pt 5pt;border-bottom-color:#000000;border-top-width:3pt;border-right-width:3pt;border-left-color:#000000;vertical-align:top;border-right-color:#000000;border-left-width:3pt;border-top-style:solid;border-left-style:solid;border-bottom-width:6pt;width:468pt;border-top-color:#000000;border-bottom-style:solid}
.c6{border-right-style:solid;padding:5pt 5pt 5pt 5pt;border-bottom-color:#000000;border-top-width:1pt;border-right-width:3pt;border-left-color:#000000;vertical-align:top;border-right-color:#000000;border-left-width:3pt;border-top-style:solid;border-left-style:solid;border-bottom-width:1pt;width:468pt;border-top-color:#000000;border-bottom-style:solid}
.c26{border-right-style:solid;padding:5pt 5pt 5pt 5pt;border-bottom-color:#000000;border-top-width:6pt;border-right-width:3pt;border-left-color:#000000;vertical-align:top;border-right-color:#000000;border-left-width:3pt;border-top-style:solid;border-left-style:solid;border-bottom-width:1pt;width:468pt;border-top-color:#000000;border-bottom-style:solid}
.c0{color:#000000;font-weight:400;text-decoration:none;vertical-align:baseline;font-size:12pt;font-family:"SF Pro Text";font-style:normal}
.c7{color:#000000;font-weight:400;text-decoration:none;vertical-align:baseline;font-size:11pt;font-family:"SF Pro Text";font-style:normal}
.c8{color:#000000;font-weight:700;text-decoration:none;vertical-align:baseline;font-size:12pt;font-family:"SF Pro Text";font-style:normal}
.c11{padding-top:0pt;padding-bottom:10pt;line-height:1.0;orphans:2;widows:2;text-align:left;height:11pt}
.c20{margin-left:216pt;padding-top:0pt;padding-bottom:10pt;line-height:1.0;orphans:2;widows:2;text-align:left}
.c3{margin-left:13.5pt;padding-top:0pt;padding-bottom:0pt;line-height:1.15;text-align:left}
.c12{color:#000000;text-decoration:none;vertical-align:baseline;font-style:normal}
.c10{padding-top:0pt;padding-bottom:0pt;line-height:1.0;text-align:left}
.c2{border-spacing:0;border-collapse:collapse;margin-right:auto}
.c14{padding-top:0pt;padding-bottom:0pt;line-height:1.15;text-align:left}
.c27{color:#ffffff;text-decoration:none;vertical-align:baseline;font-style:normal}
.c23{background-color:#ffffff;max-width:468pt;padding:72pt 72pt 72pt 72pt}
.c15{font-weight:400;font-size:11pt;font-family:"SF Pro Text"}
.c25{font-size:25pt;font-family:"SF Pro Text";font-weight:700}
.c18{orphans:2;widows:2;height:11pt}
.c21{font-size:10pt;font-family:"SF Pro Text";font-weight:700}
.c24{font-weight:400;font-size:11pt;font-family:"SF Pro Text"}
.c13{font-size:12pt;font-family:"SF Pro Text";font-weight:700}
.c22{font-size:12pt;font-family:"SF Pro Text";font-weight:400}
.c1{font-size:9pt;font-family:"SF Pro Text";font-weight:400}
.c17{font-weight:400;font-size:18pt;font-family:"SF Pro Text"}
.c29{font-weight:400;font-size:10pt;font-family:"SF Pro Text"}
.c16{font-weight:400;font-size:10pt;font-family:"SF Pro Text"}
.c19{background-color:#000000}
.c5{height:63.5pt}.c4{height:0pt}
.c4{height:0pt}
doc-content.title{padding-top:0pt;color:#000000;font-size:26pt;padding-bottom:3pt;font-family:"SF Pro Text";line-height:1.15;page-break-after:avoid;orphans:2;widows:2;text-align:left}
doc-content.subtitle{padding-top:0pt;color:#666666;font-size:15pt;padding-bottom:16pt;font-family:"SF Pro Text";line-height:1.15;page-break-after:avoid;orphans:2;widows:2;text-align:left}
doc-content.li{color:#000000;font-size:11pt;font-family:"SF Pro Text"}
doc-content.p{margin:0;color:#000000;font-size:11pt;font-family:"SF Pro Text"}
doc-content.h1{padding-top:20pt;color:#000000;font-size:20pt;padding-bottom:6pt;font-family:"SF Pro Text";line-height:1.15;page-break-after:avoid;orphans:2;widows:2;text-align:left}
doc-content.h2{padding-top:18pt;color:#000000;font-size:16pt;padding-bottom:6pt;font-family:"SF Pro Text";line-height:1.15;page-break-after:avoid;orphans:2;widows:2;text-align:left}
doc-content.h3{padding-top:16pt;color:#434343;font-size:14pt;padding-bottom:4pt;font-family:"SF Pro Text";line-height:1.15;page-break-after:avoid;orphans:2;widows:2;text-align:left}
doc-content.h4{padding-top:14pt;color:#666666;font-size:12pt;padding-bottom:4pt;font-family:"SF Pro Text";line-height:1.15;page-break-after:avoid;orphans:2;widows:2;text-align:left}
doc-content.h5{padding-top:12pt;color:#666666;font-size:11pt;padding-bottom:4pt;font-family:"SF Pro Text";line-height:1.15;page-break-after:avoid;orphans:2;widows:2;text-align:left}
doc-content.h6{padding-top:12pt;color:#666666;font-size:11pt;padding-bottom:4pt;font-family:"SF Pro Text";line-height:1.15;page-break-after:avoid;font-style:italic;orphans:2;widows:2;text-align:left}
.nf-right-align{float:right;width:50%;text-align:right}
.nf-indent{padding-left:1.5em}
</style>
<html>
<p class="c11"><span class="c7"></span></p><a id="t.454197d3f7d8252a28377abc8231c14367b7f8e7"></a><a id="t.0"></a>
<table class="c2"><tr class="c5">
<td class="c28" colspan="1" rowspan="1">
<p class="c14"><span class="c25">AI Nutrition Facts</span>
<br />
<br />
<span class="c0">Suggested Mappings</span></p>
</td>
</tr><tr class="c4">
<td class="c26" colspan="1" rowspan="1">
<p class="c10"><span class="c8">Description</span>
<br />
<br />
<span class="c1">Suggested Mappings automates the mapping of a source (ex: data warehouse, event streams, and connections to destination fields, providing you with smart suggestions while allowing you to tweak and perfect each mapping.</span></p>
</td>
</tr>
<tr class="c4">
<td class="c6" colspan="1" rowspan="1"><p class="c10"><span class="c13">Privacy Ladder Level </span>
<span class="c0 nf-right-align">1</span></p>
</td>
</tr>
<tr class="c4">
<td class="c6" colspan="1" rowspan="1"><p class="c10">
<span class="c13">Feature is Optional</span>
<span class="c0 nf-right-align" >Yes</span></p>
</td>
</tr><tr class="c4">
<td class="c6" colspan="1" rowspan="1"><p class="c10"><span class="c13">Model Type </span>
<span class="c12 c15 nf-right-align">Generative </span></p>
</td>
</tr>
<tr class="c4">
<td class="c6" colspan="1" rowspan="1"><p class="c10"><span class="c13">Base Model </span>
<span class="c12 c15 nf-right-align">OpenAI - GPT-3.5</span></p>
</td>
</tr>
<tr class="c4">
<td class="c6 c19" colspan="1" rowspan="1"><p class="c10"><span class="c13 c27">Trust Ingredients</span></p>
</td>
</tr>
<tr class="c4">
<td class="c6" colspan="1" rowspan="1">
<p class="c10"><span class="c13">Base Model Trained with Customer Data</span>
<span class="c0 nf-right-align">No</span></p>
</td>
</tr>
<tr class="c4">
<td class="c6" colspan="1" rowspan="1"><p class="c10"><span class="c13">Customer Data is Shared with Model Vendor</span>
<span class="c0 nf-right-align">Yes</span> </p>
</td>
</tr>
<tr class="c4">
<td class="c6" colspan="1" rowspan="1"><p class="c10"><span class="c13">Training Data Anonymized &nbsp; </span>
<span class="c0 nf-right-align"> N/A</span></p>
</td>
</tr>
<tr class="c4">
<td class="c6" colspan="1" rowspan="1"><p class="c10"><span class="c13">Data Deletion</span>
<span class="c0 nf-right-align">Yes</span></p>
</td>
</tr>
<tr class="c4">
<td class="c6" colspan="1" rowspan="1"><p class="c14"><span class="c13">Human in the Loop </span>
<span class="c0 nf-right-align">Yes</span></p>
</td>
</tr>
<tr class="c4">
<td class="c6" colspan="1" rowspan="1"><p class="c10"><span class="c13">Data Retention </span>
<span class="c22 nf-right-align">30 days</span></p>
</td>
</tr>
<tr class="c4">
<td class="c6" colspan="1" rowspan="1"><span class="c8">Compliance &nbsp; &nbsp; </span><br />
<span class="c13 nf-indent">Logging &amp; Auditing </span>
<span class="c0 nf-right-align">No</span><br />
<span class="c13 nf-indent">Guardrails</span>
<span class="c0 nf-right-align">Yes</span>
</td>
</tr>
<tr class="c4">
<td class="c6" colspan="1" rowspan="1"><p class="c10"><span class="c13">Input/Output Consistency</span>
<span class="c0 nf-right-align">No</span></p>
</td>
</tr>
<tr class="c4">
<td class="c9" colspan="1" rowspan="1"><p class="c10"><span class="c8">Other Resources</span></p>
</td>
</tr>
</table>
</html>
13 changes: 12 additions & 1 deletion src/connections/destinations/actions.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -57,7 +57,8 @@ To set up a new Actions-framework destination for the first time:
4. If prompted, select the source you want to connect to the new destination.
5. Enter your credentials. This could be an API Key and secret key, or similar information that allows the destination to connect to your account.
6. Next, choose how you want to set up the destination, and click **Configure Actions**.
You can choose **Quick Setup** to use the default mappings, or choose **Customized Setup** (if available) to create new mappings and conditions from a blank state. You can always edit these mappings later.
* You can choose **Quick Setup** to use the default mappings, or choose **Customized Setup** (if available) to create new mappings and conditions from a blank state. You can always edit these mappings later.
* *(Optional)* Click **Suggest Mappings** to get suggested mappings. Learn more about [suggested mappings](#suggested-mappings).
7. Once you're satisfied with your mappings, click **Create Destination**.

> info ""
Expand Down Expand Up @@ -188,6 +189,16 @@ If necessary, click **New Mapping** to create a new, blank action.
> info ""
> The required fields for a destination mapping appear automatically. Click the + sign to see optional fields.

## Suggested mappings

> info ""
> Suggested mappings is fully available for RETL mappings, and is in public beta for event streams and connections.

Segment offers suggested mappings that automatically propose relevant destination fields for both model columns and payload elements. For example, if your model includes a column or payload field named `transaction_amount`, the feature might suggest mapping it to a destination field like `Amount` or `TransactionValue`. This automation, powered by intelligent autocompletion, matches and identifies near-matching field names to streamline the setup. For more information, see [Segment's suggested mappings blogpost](https://segment.com/blog/ai-assisted-magical-mappings/){:target="_blank”} and the [Suggested Mappings Nutrition Label](/docs/connections/reverse-etl/suggested-mappings-nutrition-facts).

> warning ""
> Review the suggested mappings for accuracy before finalizing them as the suggestions aren't guaranteed to be 100% accurate.

### Coalesce function

The coalesce function takes a primary value and uses it if it is available. If the value isn't available, the function uses the fallback value instead.
Expand Down
12 changes: 11 additions & 1 deletion src/connections/reverse-etl/setup.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -88,7 +88,7 @@ To create a mapping:
* Deleted records
7. In the **Map fields** section, define how to map the record columns from your model to your destination. Map the fields that come from your source to fields that the destination expects to find. Fields on the destination side depend on the type of Action selected.
* If you’re setting up a Destination Action, some mapping fields might require data to be in the form of an object or array. See the [supported objects and arrays for mapping](/docs/connections/reverse-etl/manage-retl/#supported-object-and-arrays) for more information.
<!---* _(Optional)_ Use the [Suggested Mappings](#suggested-mappings) feature to identify and match near-matching field names to streamline the field mapping process. -->
* _(Optional)_ Use the [Suggested Mappings](#suggested-mappings) feature to identify and match near-matching field names to streamline the field mapping process.
8. In the **Send test record section**, select a test record to preview the fields that you mapped to your destination. When you've verified that the records appear as expected, click **Next**.
9. Enter a name for your mapping. The name initially defaults to the Action's name, for example, `Track Event`, but you can make changes to this default name.
10. Select how often you want Segment to sync your data under **Schedule configuration**.
Expand Down Expand Up @@ -196,6 +196,16 @@ To edit your model:
4. Click the **Settings** tab to edit the model name or change the schedule settings.


### Suggested mappings

> info ""
> Suggested mappings is fully available for RETL mappings.

Segment offers suggested mappings that automatically propose relevant destination fields for model columns and payload elements. For example, if your model includes a column or payload field named `transaction_amount`, the feature might suggest mapping it to a destination field like `Amount` or `TransactionValue`. This automation, powered by intelligent autocompletion, matches and identifies near-matching field names to streamline the mappings setup process. For more information, see [Segment's suggested mappings blog post](https://segment.com/blog/ai-assisted-magical-mappings/){:target="_blank”} and the [Suggested Mappings Nutrition Facts Label](/docs/connections/reverse-etl/suggested-mappings-nutrition-facts).

> warning ""
> Review the suggested mappings for accuracy before finalizing them, as Segment can't guarantee all of the suggested mappings are accurate.

### Edit your mapping

To edit your mapping:
Expand Down
7 changes: 7 additions & 0 deletions src/connections/reverse-etl/suggested-mappings-nutrition-facts.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,7 @@
---
title: Suggested Mappings Nutrition Facts Label
---

Twilio’s [AI Nutrition Facts](https://nutrition-facts.ai/){:target="_blank"} provide an overview of the AI feature you’re using, so you can better understand how the AI is working with your data. Suggested Mappings's AI qualities are outlined in the following Nutrition Facts label. For more information, including the glossary regarding the AI Nutrition Facts label, refer to the [AI Nutrition Facts](https://nutrition-facts.ai/){:target="_blank"} page.

{% include content/suggested-mappings-nutrition-facts.html %}
Loading