{"id":18324706,"url":"https://github.com/tchoutri/botfuel-elixir-sdk","last_synced_at":"2025-04-06T00:31:01.374Z","repository":{"id":57480453,"uuid":"118901120","full_name":"tchoutri/botfuel-elixir-sdk","owner":"tchoutri","description":"An Elixir SDK for the Botfuel NLP chatbot platform.","archived":false,"fork":false,"pushed_at":"2018-11-24T13:21:20.000Z","size":23,"stargazers_count":12,"open_issues_count":0,"forks_count":0,"subscribers_count":5,"default_branch":"master","last_synced_at":"2025-03-21T13:53:13.784Z","etag":null,"topics":["botfuel","chatbot","elixir","nlp","sdk"],"latest_commit_sha":null,"homepage":"https://hexdocs.pm/botfuel","language":"Elixir","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"mit","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/tchoutri.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":"LICENSE","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null}},"created_at":"2018-01-25T10:51:49.000Z","updated_at":"2024-04-22T05:28:17.000Z","dependencies_parsed_at":"2022-09-26T17:41:40.793Z","dependency_job_id":null,"html_url":"https://github.com/tchoutri/botfuel-elixir-sdk","commit_stats":null,"previous_names":[],"tags_count":1,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/tchoutri%2Fbotfuel-elixir-sdk","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/tchoutri%2Fbotfuel-elixir-sdk/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/tchoutri%2Fbotfuel-elixir-sdk/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/tchoutri%2Fbotfuel-elixir-sdk/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/tchoutri","download_url":"https://codeload.github.com/tchoutri/botfuel-elixir-sdk/tar.gz/refs/heads/master","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":247419597,"owners_count":20936009,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":["botfuel","chatbot","elixir","nlp","sdk"],"created_at":"2024-11-05T18:35:35.251Z","updated_at":"2025-04-06T00:31:00.688Z","avatar_url":"https://github.com/tchoutri.png","language":"Elixir","readme":"# Botfuel ![Made in Elixir](https://cdn.rawgit.com/tchoutri/botfuel-elixir-sdk/master/elixir.svg) ![Hex.pm](https://img.shields.io/hexpm/v/botfuel.svg) ![Hex.pm](https://img.shields.io/hexpm/l/botfuel.svg)\n\nWARNING: This project is not actively maintained. I'll accept PRs but don't except the library to follow the API changes.\n\nThis is an (unofficial) Elixir SDK for the [Botfuel.io](https://app.botfuel.io/docs) NLP bot platform.\nFeedback and contributions are of course welcome.\n\n## Installation\n\nYou can use `botfuel` directly from [Hex](https://hex.pm). Just add the corresponding line to your `mix.exs`:\n\n```Elixir\ndef deps do\n  [\n    {:botfuel, \"~\u003e 0.1\"}\n  ]\nend\n```\n\nOr (recommended)\n\n```Elixir\ndef deps do\n  [\n    {:botfuel, github: \"tchoutri/botfuel-elixir-sdk\"}\n  ]\nend\n```\n\n## Usage\n\nYou can start the `Botfuel.Client` module manually in your Supervision tree, like that:\n\n```Elixir\ndefmodule Application do\n  # See https://hexdocs.pm/elixir/Application.html\n  # for more information on OTP Applications\n  @moduledoc false\n\n  use Application\n\n  def start(_type, _args) do\n    {app_id = System.get_env(\"BTFL_APPID\"), app_key = System.get_env(\"BTFL_APPKEY\")}\n\n    children = [\n      {Botfuel.Client, %{app_id: app_id, app_key: app_key}}\n    ]\n\n    # See https://hexdocs.pm/elixir/Supervisor.html\n    # for other strategies and supported options\n    opts = [strategy: :one_for_one, name: Gazoline.Supervisor]\n    Supervisor.start_link(children, opts)\n  end\nend\n```\n\nor use `Botfuel.new_client(%{app_id: \u003cyour app ID\u003e, app_key: \u003cyour app key\u003e})`.\n\n```Elixir\niex(1)\u003e Botfuel.new_client(%{app_id: app_id, app_key: app_key})\n{:ok, #PID\u003c0.189.0\u003e}\n```\n\nMoreover, the top-level module exports 3 functions to interact with the platform:\n\n* `extract_entity/1`\n* `spellcheck/3`\n* `classify/1`\n\n[Read the docs ;)](https://hexdocs.pm/botfuel)\n\nI want to take great care of the documentation, but everyone's different so don't hesitate and reach to me if you feel it could be improved!  \nThanks :heart:\n\n## Licence\n\nThis software is licenced under the MIT licence.  \nSee [LICENSE](LICENSE).  \nYou can alternatively buy me a drink IRL if you're grateful for my work. :)\n","funding_links":[],"categories":[],"sub_categories":[],"project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Ftchoutri%2Fbotfuel-elixir-sdk","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Ftchoutri%2Fbotfuel-elixir-sdk","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Ftchoutri%2Fbotfuel-elixir-sdk/lists"}