Documentation

Developer Area

Welcome to the developer area. We're here to help you get started building tomorrow's AI solutions today. The Smarter platform serves a global community of prompt engineers from around the world. The prompt engineers on the Smarter platform are a highly engaged, intellectually curious community of data scientists and machine learning engineers who have an active interest in learning more about your products and services, and putting them to work in their AI solutions. These are the people who are responsible for building and maintaining today's vanguard of generative AI solutions for private sector companies, governments and educational institutions.

What Are You Waiting For?

3rd party developers and OEMs can build a variety of custom solutions on top of the Smarter platform using popular programming languages including Python, JavaScript, PHP, Swift, C#, Java, Golang and more. Moreover, a broad range of platform ecosystems are available to OEM developers. Common application scenarios include:

  • Plugins for content management systems like Wordpress, Drupal and Joomla
  • Extensions for code editors like VS Code, Atom and Sublime
  • high-level REST Api's and Saas solutions
  • Extensions for web browsers like Chrome, Firefox, Safari and Mozilla
  • Integrations for CRM systems like salesforce.com
  • Custom chatbot UI's for websites and in-house enterprise applications
  • Mobile applications for iOS and Android
  • Custom chatbot integrations for mobile apps, IoT devices and smart speakers
-- ADD A VISUAL THAT INCLUDES LOTS OF PLATFORM LOGOS --

Smarter is an extensible platform that developers can leverage to build custom solutions across a broad range of device types and platform ecosystems. Members of the Smarter Developer Program (and all on-premise installations) enjoy privileged access to multiple environments, including alpha & beta (development), next (staging/pre-production), and production.

The Smarter platform is built on a microservices architecture and is designed to be secure, resilient and highly scalable. The platform is built on a modern technology stack that includes Python-Django, React, MySQL, Redis, Docker and Kubernetes managed by Helm. Smarter leverages tight integration to AWS cloud resources, including VPC, IAM, S3, RDS, EKS, ECR, Route53, CloudFront, and more; all managed by Terraform. And, Smarter will also be available for Azure and Google Compute Cloud in the near future.

Join the Smarter Developer Program

The Smarter Developer Program is our pet project. We've gone to great pains to ensure that this is a community of like-minded developers who strive for excellence. They're the kinds of people that we're glad that we know. They're our peers, and our mentors. They're the kinds of people that we'd like to have a coffee with, and learn more about what they're working on.

Get involved!

And gain privileged access to the resources that you need in order to make your next product a success.

  • Get promoted on Smarter
  • Get earl access to new platform features
  • Promote your products across the Smarter ecosystem
  • Become a certified Smarter developer

Build On Top of the Smarter CLI

Smarter CLI is a powerful tool that runs reliably on popular desktop operating systems including Windows, MacOS and Linux. Build your own custom solutions on top of the Smarter CLI. Detailed technical documentation is available in the API Technical Documentation area. The Smarter CLI is built on top of the Smarter API and provides a rich set of features for managing the complete lifecycle of Smarter AI cloud resources.

Build On Top of the Smarter API

The Smarter API provides developers with resilient and scalable access to the Smarter platform. It is a device and platform independent strategy for building custom solutions on top of the Smarter platform. Built on the Django REST framework, the Smarter API is designed to be secure, resilient and highly scalable. It provides a rich and future-proofed set of endpoints for managing the complete lifecycle of Smarter AI cloud resources as well as account management, billing, user management and more. It is designed to be secure, resilient and highly scalable. Detailed technical documentation is available in the API Technical Documentation area.

Build On Top of the Json Schemas

Smarter's published Json Schemas are built on top of Pydantic and are tightly bound to the full suite of Smarter API data models, the foundation for all Smarter AI resources. The schemas are performant, highly available and are designed for high throughput and low latency. They make an excellent foundation for building code extension tools for real-time syntax checking, code completion, and more. Detailed technical documentation is available in the Json Schemas area.

Developer Resources

Straight from our codebase to yours. Here are some resources to help you get started building on top of the Smarter platform.

weather-function.py This is Smarter's implementation of the get_current_weather() function referenced in the OpenAI API Function Calling documentation .
Makefile This is the Makefile that Smarter developers use for local development. You can use this is a reference for the version of Python that we're using in local development, as well as to see how we initialize our local development environment.
Python Requirements This is the complete set of open source PyPi packages that the Smarter platform uses. This file is being read real-time from the running Docker container, meaning the version pins presented are what is currently running. Note that Version pins are updated monthly on the 1st of each month.
Smarter Dockerfile This is the build procedure for the Smarter app server Docker container. This file is being read real-time from the running Docker container, meaning the build procedure that you see here is what is currently running on the platform.
Smarter docker-compose.yml This is the docker-compose.yaml file that Smarter developers use for local development. It very closely approximates the production environment. If for any reason you need to replicate the Smarter production environment locally, this is the file your should use.
Application Architecture Diagram This is a high level diagram of the Smarter application architecture. It is a high-level overview of the Smarter platform, and is intended to be used as an onboarding tool for developers who are new to the Smarter platform.
Chatbot API This is a technical reference for the Smarter Chatbot API that backs the Smarter Chat web app.
CLI Technical Documentation This is a technical reference document for the Smarter CLI.
Django-ReactJS Integration This is a technical reference document for the Smarter Django-ReactJS integration strategy.
OpenAI API Getting Started Guide This is an internal training document that we use for anyone who is new to the OpenAI API.
Smarter Good Coding Practice This is an internal training document that we use for onboarding new developers. It covers the basics of what we consider to be good coding practices, and is intended to be used as a reference.
Smarter Semantic Versioning Guide This is an internal training document that we use for onboarding new developers. It covers how we use git comment prefixes for automated semantic versioning. It is intended to be used as a reference.
Smarter 12-Factor Development Practices This document outlines and formalizes how we approach the 12-factor development methodology in the Smarter platform. It is intended to be used as a reference.

Smarter Platform Developer Onboarding

These resources are designed to help internal Querium developers and Smarter Developer Program members get up to speed quickly on our workflows surrounding the Smarter platform. If you intend create pull requests in any repository in https://github.com/smarter-sh, then this is good starting point.

Developer Onboarding Video 1 - 2
Developer Onboarding Video 2 - 2