WP Manifestindependent plugin directory
manifest / ai / travel-buddy-ai

Travel Buddy AI

NLP to JSON

by OneClickContent · github.com/jwilson529/travel-buddy-ai · website

★ 1stars

Install

Download source zip No release zip yet

This is the repository archive. It installs, but the folder name will carry the branch suffix and updates will not flow.

Install straight from GitHub with WP-CLI:

wp plugin install https://github.com/jwilson529/travel-buddy-ai/archive/refs/heads/main.zip
No built-in updater. New versions won't appear under Dashboard → Updates. Install new releases yourself, or let Git Updater track the repository.
Readme github.com/jwilson529/travel-buddy-ai ↗

This plugin was made as a proof of concept based on a Reddit post asking for natural language to JSON. The example given was something like:

Input: "Looking for a storage unit in Seattle for 3 months starting in November. It should be 5x5 in size, have good security features, and be accessible during evenings. My budget is $100 per month."

Output (JSON): { "destination": "Seattle", "duration": 3, "start_date": "2024-11-01", "price_per_month": 100, "size": "5x5", "access_hours": "Evenings", "security_features": [ "good security" ] }

Travel Buddy AI is a WordPress plugin that helps users search for rental properties by leveraging OpenAI's API. Users can input their rental preferences, and the plugin will return structured JSON data based on the input.

Features

  • Search for various types of rental properties, including apartments, storage units, and vacation rentals.
  • Uses OpenAI API for parsing rental preferences and returning structured data.
  • Configurable API key and assistant ID for personalized usage.

Installation

  1. Download the Plugin

    • Download the latest version of the plugin from the releases page.

  2. Install via WordPress Admin

    • Go to your WordPress admin dashboard.
    • Navigate to Plugins > Add New.
    • Click on Upload Plugin and select the downloaded ZIP file.
    • Click Install Now and then Activate.

  3. Configure the Plugin

    • Go to Settings > TravelBuddy AI.
    • Enter your OpenAI API key.
    • Enter a custom Assistant ID, or use the demo, asst_lxwL4703F04vWwEpwgu2pKm3.

Usage

  1. Add the Search Form to Your Site

    • Use the shortcode [travelbuddy_search] to add the search form to any post or page.
    • Example: echo do_shortcode('[travelbuddy_search]');

  2. Enter Your Query

    • Input your rental preferences in the search form and click Search.
    • The plugin will display the results in a structured JSON format.

Settings

OpenAI API Key

  • Description: The API key for authenticating with the OpenAI API.
  • Default: None (must be configured by the user).

Assistant ID

  • Description: The ID of the assistant to use for parsing rental preferences.
  • Default: asst_lxwL4703F04vWwEpwgu2pKm3

Note: The provided default Assistant ID is configured to handle rental property queries. You can use this ID or set up your own assistant with similar configurations for personalized use.

Contributing

Contributions are welcome! Please follow these steps to contribute:

  1. Fork the repository.
  2. Create a new branch with a descriptive name.
  3. Make your changes and commit them with clear messages.
  4. Push your changes to your fork.
  5. Create a pull request with a description of your changes.

Contact

For inquiries, please contact OneClickContent.

This plugin was developed by OneClickContent.