-
Notifications
You must be signed in to change notification settings - Fork 288
feat: add Zendesk document store guide and update folder structure #194
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.
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
Open
davehamptonusa
wants to merge
4
commits into
FlowiseAI:main
Choose a base branch
from
davehamptonusa:feature/zendesk-document-loader
base: main
Could not load branches
Branch not found: {{ refName }}
Loading
Could not load tags
Nothing to show
Loading
Are you sure you want to change the base?
Some commits from the old base branch may be removed from the timeline,
and old review comments may become outdated.
Open
Changes from 1 commit
Commits
Show all changes
4 commits
Select commit
Hold shift + click to select a range
ae990eb
feat: add Zendesk document store guide and update folder structure
davehamptonusa 5f44161
Update en/using-flowise/document-stores/zendesk.md
davehamptonusa 22ff648
Update en/using-flowise/document-stores/zendesk.md
davehamptonusa aba3e0d
Update en/using-flowise/document-stores/zendesk.md
davehamptonusa File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
File renamed without changes.
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
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,40 @@ | ||
| --- | ||
| description: Learn how to use Zendesk with Flowise Document Stores | ||
| --- | ||
|
|
||
| # Zendesk | ||
|
|
||
| *** | ||
|
|
||
| Pulling information from Zendesk is a common use case for document stores. This focuses on pulling information from a Zendesk Knowledge store as opposed to from the ticketing system. | ||
|
|
||
| ## Setup | ||
|
|
||
| Make sure that you have the information that you will need from Zendesk including: | ||
|
|
||
| - base_url | ||
| - api_key | ||
| - brand_id | ||
| - locale | ||
|
|
||
| ## Steps | ||
|
|
||
| ### 1. Create a new document store | ||
| Following the normal process of creating a document store, name it something that makes sense for your use case. Or select an existing one. | ||
| <figure><img src="../.gitbook/assets/datastore-zendesk/add-loader.png" alt=""><figcaption></figcaption></figure> | ||
|
|
||
| ### 2. Select Zendesk as the document store type | ||
| Add an initial or a new document loader. Then select Zendesk as the document loader type. | ||
| <figure><img src="../.gitbook/assets/datastore-zendesk/select-zendesk.png" alt=""><figcaption></figcaption></figure> | ||
|
|
||
| ### 3. Enter the information from above | ||
| <figure><img src="../.gitbook/assets/datastore-zendesk/zendesk-form-fields.png" alt=""><figcaption></figcaption></figure> | ||
|
|
||
| * Give it a name | ||
| * Enter the api key is the connection credential. | ||
davehamptonusa marked this conversation as resolved.
Outdated
Show resolved
Hide resolved
|
||
| * Enter the zendesk domain. An example is given below, but you may have a non-zendesk domain. That's fine. | ||
davehamptonusa marked this conversation as resolved.
Outdated
Show resolved
Hide resolved
|
||
| * Enter the brand_id. If you don't have a brand_id, you can leave it blank | ||
| * Enter the locale as a comma separated list of locales. For example, en-us, en-gb, en-ca. You can choose to create a document store for each locale or a single document store for all locales. | ||
| * The characters per token can help you to adjust the number of tokens that are used per document. Entering a larger number will create larger documents. | ||
| ### 4. Save the document store | ||
| Save and preview. Adjust any of the form fields as needed. | ||
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.
Uh oh!
There was an error while loading. Please reload this page.