-
Notifications
You must be signed in to change notification settings - Fork 7
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Merge pull request #177 from zeus-fyi/add-search-indexer-docs
Add search indexer docs
- Loading branch information
Showing
7 changed files
with
107 additions
and
4 deletions.
There are no files selected for viewing
2 changes: 1 addition & 1 deletion
2
apps/docusaurus/zeusfyi/docs/mockingbird/actions/_category_.json
This file contains 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
This file contains 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
2 changes: 1 addition & 1 deletion
2
apps/docusaurus/zeusfyi/docs/mockingbird/builder/_category_.json
This file contains 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
This file contains 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
8 changes: 8 additions & 0 deletions
8
apps/docusaurus/zeusfyi/docs/mockingbird/search/_category_.json
This file contains 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,8 @@ | ||
| { | ||
| "label": "Search", | ||
| "position": 4, | ||
| "link": { | ||
| "type": "generated-index", | ||
| "description": "How to mock, preview, and index data." | ||
| } | ||
| } |
48 changes: 48 additions & 0 deletions
48
apps/docusaurus/zeusfyi/docs/mockingbird/search/indexer.md
This file contains 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,48 @@ | ||
| --- | ||
| sidebar_position: 2 | ||
| displayed_sidebar: mockingbird | ||
| --- | ||
|
|
||
| # Indexer | ||
|
|
||
| The indexers will use your search parameters and accounts to create a time series of the fetched data every few minutes. | ||
| It only requests the latest data since the last time it was run, and should not fetch the same data twice within the | ||
| same search group. The indexer will also store the data in the database for archiving and retrieval. | ||
|
|
||
|
|
||
|  | ||
|
|
||
| Set the Twitter API OAuth2 credentials in the platform secrets to start indexing tweets, | ||
| then set the platform search query using the v2 Twitter search API format. | ||
|
|
||
| ### Platform Search Query | ||
|
|
||
|  | ||
|
|
||
|  | ||
|
|
||
|  | ||
|
|
||
|  | ||
|
|
||
|  | ||
|
|
||
| Full | ||
| Documentation: https://developer.twitter.com/en/docs/twitter-api/tweets/search/api-reference/get-tweets-search-recent | ||
|
|
||
|
|
||
|  | ||
|
|
||
| Set the Reddit API OAuth2 credentials, user, and password, in the platform secrets to start indexing subreddits. | ||
| Also set the routing table as well for reddit retrievals/api calls. If you don't want to use your primary reddit | ||
| account, that's fine, you can create a new account and use that for the API credentials as well. | ||
|
|
||
|  | ||
|
|
||
| ## Activate / Deactivate Indexing | ||
|
|
||
|  | ||
|
|
||
| Select the relevant search query row, and click the Activate/Deactivate button to start/stop indexing data. |
This file contains 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,47 @@ | ||
| --- | ||
| sidebar_position: 1 | ||
| displayed_sidebar: mockingbird | ||
| --- | ||
|
|
||
| # Search | ||
|
|
||
| This section allows you to preview and mock API retrievals, and search indexer results, that you can filter | ||
| and sort by date, and filter by negative and positive keywords. | ||
|
|
||
| ### Search Response Format | ||
|
|
||
| Timestamp | Platform | Tweet Body | ||
|
|
||
| ### Global Indexer Search | ||
|
|
||
|  | ||
|
|
||
| Leaving platform and groups blank will search all platforms and groups you are indexing over the given time period. | ||
|
|
||
|
|
||
|  | ||
|
|
||
| ### Search Response Format | ||
|
|
||
| Timestamp | Platform | Tweet Body | ||
|
|
||
|
|
||
|  | ||
|
|
||
| ### Search Response Format | ||
|
|
||
| Timestamp | Platform | Subreddit | Post ID | Author | URL | Title | Body | ||
|
|
||
| Though it may contain additional field headers for now as we evaluate which should be the defaults, | ||
| the search response format will always include the timestamp, platform, and the body of the post. | ||
|
|
||
| ## API Retrieval Mocking | ||
|
|
||
| Here you can verify the API calls using the API platform option and setting the route path. It will | ||
| use your authentication credentials to make the API call, if any are set in the platform secrets for the table, | ||
| and return the response. | ||
|
|
||
|  | ||
|
|