Create documentation for Quin AI source integration #6983
Merged
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Comment on lines
1
to
5
| # Quin AI Documentation | ||
|
|
||
| --- | ||
| Quin AI Source | ||
| --- |
There was a problem hiding this comment.
Suggested change
| # Quin AI Documentation | |
| --- | |
| Quin AI Source | |
| --- | |
| --- | |
| title: Quin AI Source | |
| id: | |
| --- |
| Quin AI Source | ||
| --- | ||
|
|
||
| Quin AI is the first deep learning, real-time behaviour prediction system dedicated to e-commerce conversion optimisation, for growth and profitability. |
There was a problem hiding this comment.
Suggested change
| Quin AI is the first deep learning, real-time behaviour prediction system dedicated to e-commerce conversion optimisation, for growth and profitability. | |
| Quin AI is the first deep learning, real-time behavior prediction system dedicated to e-commerce conversion optimization, for growth and profitability. |
|
|
||
| Quin AI is the first deep learning, real-time behaviour prediction system dedicated to e-commerce conversion optimisation, for growth and profitability. | ||
|
|
||
| This source is maintained by Quin Audience Engine. For any issues with the source, [contact their Support team](mailto:hello@quinengine.com). |
There was a problem hiding this comment.
Suggested change
| This source is maintained by Quin Audience Engine. For any issues with the source, [contact their Support team](mailto:hello@quinengine.com). | |
| This source is maintained by Quin Audience Engine. For any issues with the source, [contact the Quin Audience Engine Support team](mailto:hello@quinengine.com). |
Comment on lines
15
to
18
| 3. On the next screen, give the Source a name configure any other settings. | ||
|
|
||
| - The name is used as a label in the Segment app, and Segment creates a related schema name in your warehouse. The name can be anything, but we recommend using something that reflects the source itself and distinguishes amongst your environments (eg. SourceName_Prod, SourceName_Staging, SourceName_Dev). | ||
|
|
There was a problem hiding this comment.
Suggested change
| 3. On the next screen, give the Source a name configure any other settings. | |
| - The name is used as a label in the Segment app, and Segment creates a related schema name in your warehouse. The name can be anything, but we recommend using something that reflects the source itself and distinguishes amongst your environments (eg. SourceName_Prod, SourceName_Staging, SourceName_Dev). | |
| 3. On the next screen, give the Source a name configure any other settings. | |
| - The name is used as a label in the Segment app, and Segment creates a related schema name in your warehouse. The name can be anything, but we recommend using something that reflects the source itself and distinguishes amongst your environments (eg. SourceName_Prod, SourceName_Staging, SourceName_Dev). |
|
|
||
| 4. Click **Add Source** to save your settings. | ||
| 5. Copy the Write key from the Segment UI. | ||
| 6. Log in to your [Quin account](https://portal.quinengine.com/) - navigate to Integrations > Segment > Settings and paste the write key to connect. |
There was a problem hiding this comment.
Suggested change
| 6. Log in to your [Quin account](https://portal.quinengine.com/) - navigate to Integrations > Segment > Settings and paste the write key to connect. | |
| 6. Log in to your [Quin account](https://portal.quinengine.com/){:target="_blank”} and navigate to Integrations > Segment > Settings. | |
| 7. On the Settings page, paste your Segment write key to connect. |
|
|
||
| ## Adding Destinations | ||
|
|
||
| Now that your Source is set up, you can connect it with Destinations. |
There was a problem hiding this comment.
Suggested change
| Now that your Source is set up, you can connect it with Destinations. | |
| Now that your Source is set up, you can connect to Destinations. |
|
|
||
| ## Stream | ||
|
|
||
| Quin AI uses our stream Source component to send Segment event data. It uses a server-side `track` and `identify` method(s) to send data to Segment. These events are then available in any destination that accepts server-side events, and available in a schema in your data warehouse, so you can query using SQL. |
There was a problem hiding this comment.
Suggested change
| Quin AI uses our stream Source component to send Segment event data. It uses a server-side `track` and `identify` method(s) to send data to Segment. These events are then available in any destination that accepts server-side events, and available in a schema in your data warehouse, so you can query using SQL. | |
| Quin AI uses a stream Source component to send Segment event data. It uses server-side Track and Identify methods to send data to Segment. These events are then available in any destination that accepts server-side events and available in a schema in your data warehouse that you can query using SQL. |
Comment on lines
1
to
2
|
|
||
| ### Quin AI Source |
There was a problem hiding this comment.
Suggested change
| ### Quin AI Source | |
| --- | |
| title: Quin AI Source | |
| id: WGp9SQFRVu | |
| --- |
There was a problem hiding this comment.
hi - this frontmatter helps the documentation render correctly. Without it, the page will not render properly on the site.
|
|
||
| ### Quin AI Source | ||
|
|
||
| Quin AI is the first deep learning, real-time behavior prediction system dedicated to e-commerce conversion optimization, for growth and profitability. |
There was a problem hiding this comment.
Suggested change
| Quin AI is the first deep learning, real-time behavior prediction system dedicated to e-commerce conversion optimization, for growth and profitability. | |
| Quin AI is the first deep learning, real-time behavior prediction system dedicated to e-commerce conversion optimization for growth and profitability. |
| 1. From your workspace's Source page, click **Add Source**. | ||
| 2. Search for "Quin AI" in the Sources Catalog, select Quin AI, and click **Add Source**. | ||
| 3. On the next screen, give the Source a name configure any other settings. | ||
| - The name is used as a label in the Segment app, and Segment creates a related schema name in your warehouse. The name can be anything, but we recommend using something that reflects the source itself and distinguishes amongst your environments (eg. SourceName_Prod, SourceName_Staging, SourceName_Dev). |
There was a problem hiding this comment.
Suggested change
| - The name is used as a label in the Segment app, and Segment creates a related schema name in your warehouse. The name can be anything, but we recommend using something that reflects the source itself and distinguishes amongst your environments (eg. SourceName_Prod, SourceName_Staging, SourceName_Dev). | |
| - The name is used as a label in the Segment app, and Segment creates a related schema name in your warehouse. The name can be anything, but we recommend using something that reflects the source itself and distinguishes amongst your environments (eg. QuinAI_Prod, QuinAI_Staging, QuinAI_Dev). |
| - The name is used as a label in the Segment app, and Segment creates a related schema name in your warehouse. The name can be anything, but we recommend using something that reflects the source itself and distinguishes amongst your environments (eg. SourceName_Prod, SourceName_Staging, SourceName_Dev). | ||
| 4. Click **Add Source** to save your settings. | ||
| 5. Copy the Write key from the Segment UI. | ||
| 6. Log in to your [Quin account](https://portal.quinengine.com/) and navigate to Integrations > Segment > Settings. |
There was a problem hiding this comment.
We add the {:target="_blank”} attribute to ensure all links external to the segment.com/docs/ subdomain open in a new tab - this way, our mutual customers won't have to find these docs while they're halfway through setting up this source!
Suggested change
| 6. Log in to your [Quin account](https://portal.quinengine.com/) and navigate to Integrations > Segment > Settings. | |
| 6. Log in to your [Quin account](https://portal.quinengine.com/){:target="_blank”} and navigate to Integrations > Segment > Settings. |
|
|
||
| ## Stream | ||
|
|
||
| Quin AI uses a stream Source component to send Segment event data. It uses server-side Track and Identify methods to send data to Segment. These events are then available in any destination that accepts server-side events and available in a schema in your data warehouse that you can query using SQL. |
There was a problem hiding this comment.
Suggested change
| Quin AI uses a stream Source component to send Segment event data. It uses server-side Track and Identify methods to send data to Segment. These events are then available in any destination that accepts server-side events and available in a schema in your data warehouse that you can query using SQL. | |
| Quin AI uses a stream Source component and Track and Identify methods to send event data to Segment. These events are then available in any destination that accepts server-side events and as a schema in your data warehouse that you can query using SQL. |
|
|
||
| Quin AI uses a stream Source component to send Segment event data. It uses server-side Track and Identify methods to send data to Segment. These events are then available in any destination that accepts server-side events and available in a schema in your data warehouse that you can query using SQL. | ||
|
|
||
| The default behavior is for Quin AI to pass the event data associated with the anonymous userId. |
There was a problem hiding this comment.
The term anonymousId is something that Segment refers to in the Identify Spec: https://segment.com/docs/connections/spec/identify/#anonymous-id
Suggested change
| The default behavior is for Quin AI to pass the event data associated with the anonymous userId. | |
| The default behavior is for Quin AI to pass the event data associated with the anonymousId. |
|
|
||
| ## Events | ||
|
|
||
| The table below lists events that Quin sends to Segment. These events appear as tables in your warehouse, and as regular events in other Destinations. |
There was a problem hiding this comment.
Suggested change
| The table below lists events that Quin sends to Segment. These events appear as tables in your warehouse, and as regular events in other Destinations. | |
| The table below lists events that Quin sends to Segment. These events appear as tables in your warehouse and as regular events in other Destinations. |
|
|
||
| Log into your downstream tools and check to see that your events appear as expected, and that they contain all of the properties you expect. | ||
|
|
||
| If there are any issues with how the events are arriving to Segment, [contact the Quin AI support team](mailto:hello@<quinengine.com). |
There was a problem hiding this comment.
Suggested change
| If there are any issues with how the events are arriving to Segment, [contact the Quin AI support team](mailto:hello@<quinengine.com). | |
| If there are any issues with how the events are arriving to Segment, [contact the Quin AI support team](mailto:hello@quinengine.com). |
|
Hi @eren-quinengine - please take another look at this PR, I'd love to help you get these docs published! |
forstisabella
approved these changes
Sep 16, 2024
|
Thank you for your contribution! Your pull request is merged, but may take a day or two to appear on the site. |
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Proposed changes
Created a documentation for new source integration called Quin AI.
Merge timing
ASAP once approved.