Qodex.ai

Travel Adviser AI Assistant Workspace

Welcome to the Travel Adviser AI Assistant workspace! This workspace is designed to help you interact with the Travel Adviser API, which provides travel recommendations and information based on user queries. The API supports Persian language responses and can answer various travel-related questions, including attraction recommendations, travel plans, and general inquiries.

Purpose

The purpose of this API is to provide users with personalized travel recommendations and information. It uses a machine learning model trained on various travel-related queries and responses in Persian.

Setup

To get started with the Travel Adviser API, ensure you have the following setup:

  • The API server is running (use Docker Compose to start the services).

  • You have the necessary environment variables configured (see below).

Environment Variables

Create an environment in Qodex to store your environment variables. Below are the key variables needed:

  • BASE_URL: The base URL of your API, typically http://localhost:8000.

API Endpoints

Read Root

  • Endpoint: /

  • Method: GET

  • Summary: Read Root

  • Operation ID: read_root__get

  • Responses:

    • 200: Successful Response

Health

  • Endpoint: /health

  • Method: GET

  • Summary: Health

  • Operation ID: health_health_get

  • Responses:

    • 200: Successful Response

Readiness Check

  • Endpoint: /ready

  • Method: GET

  • Summary: Readiness Check

  • Operation ID: readiness_check_ready_get

  • Responses:

    • 200: Successful Response

Generate Session Id

  • Endpoint: /generate_session_id

  • Method: POST

  • Summary: Generate Session Id

  • Operation ID: generate_session_id_generate_session_id_post

  • Responses:

    • 200: Successful Response

Get Similars

  • Endpoint: /similars

  • Method: POST

  • Summary: Get Similars

  • Operation ID: get_similars_similars_post

  • Request Body:

    • Content Type: application/json
    • { question: string, session_id: string, model_name: string or null}

  • Responses:

    • 200: Successful Response
    • 422: Validation Error

Get Chat History

  • Endpoint: /chat_history

  • Method: GET

  • Summary: Get Chat History

  • Operation ID: get_chat_history_chat_history_get

  • Parameters:

    • session_id (query): string (required)

  • Responses:

    • 200: Successful Response
    • 422: Validation Error

Clear Chat History

  • Endpoint: /chat_history

  • Method: DELETE

  • Summary: Clear Chat History

  • Operation ID: clear_chat_history_chat_history_delete

  • Parameters:

    • session_id (query): string (required)

  • Responses:

    • 200: Successful Response
    • 422: Validation Error

  • Contributing
    We welcome contributions to improve the Travel Adviser API. If you have suggestions or find issues, please submit a pull request or open an issue on our repository.

  • Steps to Use the MarkdownThis markdown provides a concise yet comprehensive description of your Qodex workspace, making it easy for users to understand how to interact with your API.

1. Open Qodex.

2. Click on the **Workspaces** tab.

3. Click **Create Workspace**.

4. Name your workspace (e.g., "Travel Adviser AI Assistant").

5. In the workspace description, click **Markdown** or **Raw text**.

6. Copy and paste the above markdown content.

7. Click **Save**.