You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
<p>Aify is very easy to get started with. Following this guide you can begin using Aify in under 15 minutes! Let’s dive in!</p>
113
+
<h2id="Step-1-Create-your-account-on-Aify-Dashboard">Step 1 - Create your account on Aify Dashboard</h2>
112
114
<ol>
113
-
<li>Log on to <ahref="https://aify.thecodefoundation.dev/" target="_blank" rel="noopener">Aify Dashboard</a> and Login or Create Account. After account creation, Login to your account.</li>
115
+
<li>Head over to <ahref="https://thecodefoundation.dev" target="_blank" rel="noopener">aify.thecodefoundation.dev</a>. You’ll be presented with the login screen as shown below -</li>
116
+
<li>Click on Create an Account to register a new account. If you already have an account, skip to step 4.</li>
117
+
<li>Fill in the required details on the registration page. Click on Register to button to complete registration.</li>
118
+
<li>You’ll be taken back to the login screen. Enter your credentials and submit the form to login.</li>
119
+
</ol>
120
+
<h2id="Step-2-Add-your-website">Step 2 - Add your website</h2>
121
+
<olstart="5">
114
122
<li>On the left menu, Click on Websites > Add</li>
115
123
<li>Add your website, enter any name for your website and enter the root URL of the site.</li>
116
-
<li>Ensure that your website has a publicly accessible sitemap file, preferably at <ahref="https://example.com/sitemap.xml" target="_blank" rel="noopener">/sitemap.xml</a> location. Our Aify Crawler will use this sitemap to crawl your website.</li>
117
-
<li>Wait for 10-15 mins for the Aify Crawler to visit your website and work its magic in the background.</li>
118
-
<li>On your web page, include the following line to import the AifyJS package into your application -</li>
<p>Ensure that your website has a publicly accessible sitemap file, preferably at [/sitemap.xml](https://example.com/sitemap.xml) location. Our Aify Crawler will use this sitemap to crawl your website.</p>
127
+
</blockquote>
128
+
<p>Wait for a few minutes for the Aify Crawler to visit your website and work its magic in the background. Meanwhile, you can move to the next steps and grab your API keys!</p>
129
+
<h2id="Step-3-Get-your-API-Keys">Step 3 - Get your API Keys</h2>
121
130
<olstart="7">
122
-
<li>In your web page, use the following line to instantiate a connection to the Aify API -</li>
123
-
</ol>
124
-
<figureclass="highlight plain"><table><tr><tdclass="gutter"><pre><spanclass="line">1</span><br></pre></td><tdclass="code"><pre><spanclass="line">var ai = new aifyjs();</span><br></pre></td></tr></table></figure>
125
-
<olstart="8">
126
-
<li>To generate element labels on the web page, use the following line -</li>
<li>When your page loads, it will silently cause an update of the page source to reflect the labels and captions fetched from the Aify API.</li>
135
-
<li>Voila! Your website is more accessible to people with visual challenges now!</li>
131
+
<li>On the top right of any page in the Aify Dashboard, Click on the user profile picture to open your personal information and settings menu.</li>
132
+
<li>Click on <ahref="https://aify.thecodefoundation.dev/settings" target="_blank" rel="noopener">Settings</a> to open up your account settings page.</li>
133
+
<li>To create a New API Key, enter any string as per your wish as a name for the Key. Click on Create API Key button.</li>
134
+
<li>Note down the API key displayed in a safe location. You will not be shown in this API key again.</li>
136
135
</ol>
136
+
<h2id="Step-4-Play-with-the-APIs">Step 4 - Play with the APIs</h2>
137
+
<p>Now that you’ve got your API keys, you can play around with your API key using Postman or any other equivalent tool for making calls to the REST API.</p>
138
+
<p>if you do not have Postman on your system, you can download it using the link below -</p>
<h1id="Introduction-to-Aify">Introduction to Aify</h1>
112
-
<p>In the simplest terms, Aify is a platform-independent library of REST APIs which can be used on web pages, mobile apps, server side code and pretty much anywhere to quickly add the power of artificial intelligence to your website, without you having to invest in any backend or machine learning costs. Aify packs some of the most powerful research based, state of the art models, delivered to you instantly in any environment.</p>
113
-
<h2id="Current-Models">Current Models</h2>
112
+
<p>Are you worried about losing out on the benefits of a recommendation engine by using static web hosting? Or maybe your hosting provider does not provide you with shell access? Oh, and to just imagine having to host Python/R files on your hosting!</p>
113
+
<p>We solve these for you!</p>
114
+
<p>Aify is a platform-independent library of REST APIs which can be used on web pages, mobile apps, server side code and pretty much anywhere to quickly add the power of artificial intelligence to your website, without you having to invest in any backend or machine learning costs. Aify packs some of the most powerful research based, state of the art models, delivered to you instantly in any environment.</p>
115
+
<h2id="Features">Features</h2>
114
116
<ul>
115
-
<li>Captioning for images</li>
117
+
<li>REST API</li>
118
+
<li>Recommendation Engine</li>
119
+
<li>Auto Website Crawl</li>
120
+
<li>High quality generated captions for images</li>
116
121
<li>Label determination for webpage elements</li>
117
122
<li>Summary of any given text</li>
118
-
<li>Voice UX</li>
119
-
<li>Recommendation Engine</li>
123
+
<li>Voice UX on Web Browsers and Mobile app</li>
120
124
</ul>
121
-
<h2id="How-to-use">How to use</h2>
122
-
<p>There are two ways you can use aify.js -</p>
123
-
<ol>
124
-
<li>Hope that the developer of the website you are on has included the aify.js library on their web page. If you’re a developer, you can too! Details in below sections.</li>
125
-
<li>Get yourself our browser extension. <ahref="https://github.com/aifyjs/extension" target="_blank" rel="noopener">Download it here!</a></li>
126
-
</ol>
127
125
<h2id="Quickstart-for-Developers">Quickstart for Developers</h2>
128
126
<ol>
129
-
<li>Get your API keys from <ahref="https://aify.thecodefoundation.dev" target="_blank" rel="noopener">aify.thecodefoundation.dev</a>.</li>
127
+
<li>Get your API keys from <ahref="https://aify.thecodefoundation.dev" target="_blank" rel="noopener">Aify Dashboard</a>.</li>
130
128
<li>Use APIs as listed in the <ahref="/api/overview">API Reference</a> or <ahref="/getting-started#libraries">Get a Library</a>.</li>
<h1id="Introduction-to-Aify">Introduction to Aify</h1>
112
-
<p>In the simplest terms, Aify is a platform-independent library of REST APIs which can be used on web pages, mobile apps, server side code and pretty much anywhere to quickly add the power of artificial intelligence to your website, without you having to invest in any backend or machine learning costs. Aify packs some of the most powerful research based, state of the art models, delivered to you instantly in any environment.</p>
113
-
<h2id="Current-Models">Current Models</h2>
112
+
<p>Are you worried about losing out on the benefits of a recommendation engine by using static web hosting? Or maybe your hosting provider does not provide you with shell access? Oh, and to just imagine having to host Python/R files on your hosting!</p>
113
+
<p>We solve these for you!</p>
114
+
<p>Aify is a platform-independent library of REST APIs which can be used on web pages, mobile apps, server side code and pretty much anywhere to quickly add the power of artificial intelligence to your website, without you having to invest in any backend or machine learning costs. Aify packs some of the most powerful research based, state of the art models, delivered to you instantly in any environment.</p>
115
+
<h2id="Features">Features</h2>
114
116
<ul>
115
-
<li>Captioning for images</li>
117
+
<li>REST API</li>
118
+
<li>Recommendation Engine</li>
119
+
<li>Auto Website Crawl</li>
120
+
<li>High quality generated captions for images</li>
116
121
<li>Label determination for webpage elements</li>
117
122
<li>Summary of any given text</li>
118
-
<li>Voice UX</li>
119
-
<li>Recommendation Engine</li>
123
+
<li>Voice UX on Web Browsers and Mobile app</li>
120
124
</ul>
121
-
<h2id="How-to-use">How to use</h2>
122
-
<p>There are two ways you can use aify.js -</p>
123
-
<ol>
124
-
<li>Hope that the developer of the website you are on has included the aify.js library on their web page. If you’re a developer, you can too! Details in below sections.</li>
125
-
<li>Get yourself our browser extension. <ahref="https://github.com/aifyjs/extension" target="_blank" rel="noopener">Download it here!</a></li>
126
-
</ol>
127
125
<h2id="Quickstart-for-Developers">Quickstart for Developers</h2>
128
126
<ol>
129
-
<li>Get your API keys from <ahref="https://aify.thecodefoundation.dev" target="_blank" rel="noopener">aify.thecodefoundation.dev</a>.</li>
127
+
<li>Get your API keys from <ahref="https://aify.thecodefoundation.dev" target="_blank" rel="noopener">Aify Dashboard</a>.</li>
130
128
<li>Use APIs as listed in the <ahref="/api/overview">API Reference</a> or <ahref="/getting-started#libraries">Get a Library</a>.</li>
<li>In your web page, use the following line to instantiate a connection to the Aify API -</li>
117
+
</ol>
118
+
<figureclass="highlight plain"><table><tr><tdclass="gutter"><pre><spanclass="line">1</span><br></pre></td><tdclass="code"><pre><spanclass="line">var ai = new aifyjs();</span><br></pre></td></tr></table></figure>
119
+
<olstart="8">
120
+
<li>To generate element labels on the web page, use the following line -</li>
0 commit comments