diff --git a/_sources/api.rst.txt b/_sources/api.rst.txt index e75a50c..d38426e 100644 --- a/_sources/api.rst.txt +++ b/_sources/api.rst.txt @@ -18,13 +18,17 @@ Health Recommendations "query": "I need mental health support", "latitude": 43.6532, "longitude": -79.3832, - "radius": 5000 + "radius": 5000, + "rerank": false } :json string recommendation: Generated recommendation text + :>json array services: List of relevant health services **Response Body** diff --git a/api.html b/api.html index c6a94c4..118d3ef 100644 --- a/api.html +++ b/api.html @@ -274,7 +274,8 @@

Health Recommendations "query": "I need mental health support", "latitude": 43.6532, "longitude": -79.3832, - "radius": 5000 + "radius": 5000, + "rerank": false } @@ -284,7 +285,14 @@

Health Recommendations

query (string) – The user’s health-related query (required)

  • latitude (number) – Optional latitude for location-based search

  • longitude (number) – Optional longitude for location-based search

    • -

  • radius (number) – Optional search radius in meters

    • +

  • radius (number) – Optional search radius in meters (default: 5000)

    • +

  • rerank (boolean) – Optional flag to enable/disable reranking of the services (default: false)

    • + + +
    Response JSON Object:
    +
      +

    • recommendation (string) – Generated recommendation text

      • +

    • services (array) – List of relevant health services

    diff --git a/searchindex.js b/searchindex.js index fc8f4b4..7394080 100644 --- a/searchindex.js +++ b/searchindex.js @@ -1 +1 @@ -Search.setIndex({"alltitles": {"API Reference": [[0, null]], "Common HTTP Status Codes": [[0, "common-http-status-codes"]], "Download service data (211 API)": [[1, "download-service-data-211-api"]], "Error Responses": [[0, "error-responses"]], "Health Recommendation System": [[1, null]], "Health Recommendations": [[0, "health-recommendations"]], "In case, you wish to update frontend dependencies, run the following commands in the ui directory:": [[1, "in-case-you-wish-to-update-frontend-dependencies-run-the-following-commands-in-the-ui-directory"]], "Navigate to the UI on the browser": [[1, "navigate-to-the-ui-on-the-browser"]], "Prerequisites": [[1, "prerequisites"]], "Question Generation": [[0, "question-generation"]], "Recommendation Refinement": [[0, "recommendation-refinement"]], "Service Information": [[0, "service-information"]], "Upload data and embeddings": [[1, "upload-data-and-embeddings"]], "\ud83c\udf1f Overview": [[1, "overview"]], "\ud83c\udfc3\u200d\u2642\ufe0f Running the services": [[1, "running-the-services"]], "\ud83d\udce5 Data setup": [[1, "data-setup"]], "\ud83d\udd11 API keys setup": [[1, "api-keys-setup"]], "\ud83d\ude80 Getting started": [[1, "getting-started"]], "\ud83d\udee0\ufe0f Installation": [[1, "installation"]]}, "docnames": ["api", "index"], "envversion": {"sphinx": 62, "sphinx.domains.c": 3, "sphinx.domains.changeset": 1, "sphinx.domains.citation": 1, "sphinx.domains.cpp": 9, "sphinx.domains.index": 1, "sphinx.domains.javascript": 3, "sphinx.domains.math": 2, "sphinx.domains.python": 4, "sphinx.domains.rst": 2, "sphinx.domains.std": 2}, "filenames": ["api.rst", "index.md"], "indexentries": {}, "objects": {"": [[0, 0, 1, "get--questions", "/questions"], [0, 1, 1, "post--recommend", "/recommend"], [0, 1, 1, "post--refine_recommendations", "/refine_recommendations"], [0, 0, 1, "get--services-all", "/services/all"], [0, 0, 1, "get--services-count", "/services/count"]]}, "objnames": {"0": ["http", "get", "HTTP get"], "1": ["http", "post", "HTTP post"]}, "objtypes": {"0": "http:get", "1": "http:post"}, "terms": {"": 0, "0": 1, "1": [0, 1], "10": 1, "11": 1, "123": 0, "150": 0, "18": 1, "200": 0, "211_api_kei": 1, "3": 1, "3832": 0, "4": 1, "400": 0, "422": 0, "43": 0, "456": 0, "500": 0, "5000": 0, "5pm": 0, "6532": 0, "7890": 0, "79": 0, "9am": 0, "For": 1, "On": 1, "The": [0, 1], "Then": 1, "about": [0, 1], "activ": 1, "address": 0, "ai": 1, "all": [0, 1], "amount": 1, "an": [0, 1], "answer": 0, "ar": 0, "architectur": 1, "arrai": 0, "avail": 0, "backend": 1, "bad": 0, "base": 0, "bash": 1, "bin": 1, "bodi": 0, "boolean": 0, "built": 1, "can": 1, "care": [0, 1], "categori": 0, "category1": 0, "category2": 0, "cd": 1, "check": 1, "chromadb": 1, "clone": 1, "collection_nam": 1, "com": [0, 1], "commit": 1, "commun": 1, "compon": 1, "compos": 1, "connect": 1, "contain": [0, 1], "correct": 1, "count": 0, "creat": 1, "data": 0, "data_dir": 1, "databas": [0, 1], "dataset": 1, "describ": 0, "descript": 0, "detail": 0, "dev": 1, "develop": 1, "dir": 1, "do": 0, "doc": 1, "docker": 1, "document": 1, "download_data": 1, "emerg": 0, "endpoint": 0, "engin": 1, "entiti": 0, "env": 1, "environ": 1, "exampl": 0, "f": 1, "fals": 0, "fastapi": 1, "file": 1, "first": 1, "follow": 0, "found": 0, "fridai": 0, "from": 0, "frontend_port": 1, "get": 0, "git": 1, "github": 1, "gta": 1, "have": 1, "health_rec": 1, "help": 1, "henc": 1, "hour": 0, "http": 1, "i": [0, 1], "id": 0, "ignor": 1, "indic": 0, "initi": 0, "input": 0, "insecur": 1, "integ": 0, "interact": 1, "interfac": 1, "intern": 0, "invalid": 0, "is_emerg": 0, "is_out_of_scop": 0, "j": 1, "json": 0, "latest": 1, "latitud": 0, "list": [0, 1], "load": 1, "load_embed": 1, "localhost": 1, "locat": 0, "longitud": 0, "look": 0, "m": 1, "mai": 0, "main": 0, "make": 1, "manage_data": 1, "mapbox_api_kei": 1, "match": 0, "mental": 0, "messag": 0, "meter": 0, "microservic": 1, "modern": 1, "mondai": 0, "name": [0, 1], "need": 0, "network": 1, "next": 1, "next_public_google_maps_api_kei": 1, "no_services_found": 0, "node": 1, "note": 1, "npm": 1, "number": 0, "object": 0, "ok": 0, "onli": 1, "ontario": 1, "openai": 1, "openai_api_kei": 1, "option": [0, 1], "origin": 0, "outsid": 0, "package_nam": 1, "paramet": 0, "path": 1, "path_to_data_dir": 1, "path_to_data_dir_with_json_fil": 1, "peopl": 1, "person": 0, "phone_numb": 0, "poetri": 1, "post": 0, "power": 1, "pre": 1, "prefer": 0, "previou": 0, "previous": 0, "proce": 1, "profil": 1, "project": 1, "provid": 0, "purpos": 1, "pwd": 1, "py": 1, "python": 1, "python3": 1, "queri": 0, "radiu": 0, "rec": 1, "rec_app": 1, "refer": 1, "refine_recommend": 0, "relat": 0, "relev": 0, "repositori": 1, "request": 0, "requir": [0, 1], "retriev": 0, "return": 0, "root": 1, "scope": 0, "script": 1, "search": 0, "section": 0, "see": 1, "server": 0, "service_id": 0, "side": 0, "small": 1, "sourc": 1, "st": 0, "storag": 1, "string": 0, "success": 0, "successfulli": 0, "suggest": 0, "support": 0, "sure": 1, "system": 0, "technologi": 1, "test": 1, "text": 0, "thi": [0, 1], "tool": 1, "total": 0, "type": 0, "unprocess": 0, "up": [0, 1], "updat": 0, "url": 1, "us": 1, "user": [0, 1], "v": 1, "v20": 1, "vector": 1, "vectorinstitut": 1, "venv": 1, "virtual": [0, 1], "w": 1, "want": 1, "warn": 1, "we": 1, "websit": 0, "welcom": 1, "went": 0, "were": 0, "what": 0, "while": 1, "wide": 1, "window": 1, "workspac": 1, "wrong": 0, "yml": 1, "you": 0, "your": 0, "your_211_api_kei": 1, "your_211_kei": 1, "your_collection_nam": 1, "your_google_maps_kei": 1, "your_mapbox_kei": 1, "your_openai_api_kei": 1, "your_openai_kei": 1}, "titles": ["API Reference", "Health Recommendation System"], "titleterms": {"211": 1, "In": 1, "api": [0, 1], "browser": 1, "case": 1, "code": 0, "command": 1, "common": 0, "data": 1, "depend": 1, "directori": 1, "download": 1, "embed": 1, "error": 0, "follow": 1, "frontend": 1, "gener": 0, "get": 1, "health": [0, 1], "http": 0, "inform": 0, "instal": 1, "kei": 1, "navig": 1, "overview": 1, "prerequisit": 1, "question": 0, "recommend": [0, 1], "refer": 0, "refin": 0, "respons": 0, "run": 1, "servic": [0, 1], "setup": 1, "start": 1, "statu": 0, "system": 1, "ui": 1, "updat": 1, "upload": 1, "wish": 1, "you": 1}}) \ No newline at end of file +Search.setIndex({"alltitles": {"API Reference": [[0, null]], "Common HTTP Status Codes": [[0, "common-http-status-codes"]], "Download service data (211 API)": [[1, "download-service-data-211-api"]], "Error Responses": [[0, "error-responses"]], "Health Recommendation System": [[1, null]], "Health Recommendations": [[0, "health-recommendations"]], "In case, you wish to update frontend dependencies, run the following commands in the ui directory:": [[1, "in-case-you-wish-to-update-frontend-dependencies-run-the-following-commands-in-the-ui-directory"]], "Navigate to the UI on the browser": [[1, "navigate-to-the-ui-on-the-browser"]], "Prerequisites": [[1, "prerequisites"]], "Question Generation": [[0, "question-generation"]], "Recommendation Refinement": [[0, "recommendation-refinement"]], "Service Information": [[0, "service-information"]], "Upload data and embeddings": [[1, "upload-data-and-embeddings"]], "\ud83c\udf1f Overview": [[1, "overview"]], "\ud83c\udfc3\u200d\u2642\ufe0f Running the services": [[1, "running-the-services"]], "\ud83d\udce5 Data setup": [[1, "data-setup"]], "\ud83d\udd11 API keys setup": [[1, "api-keys-setup"]], "\ud83d\ude80 Getting started": [[1, "getting-started"]], "\ud83d\udee0\ufe0f Installation": [[1, "installation"]]}, "docnames": ["api", "index"], "envversion": {"sphinx": 62, "sphinx.domains.c": 3, "sphinx.domains.changeset": 1, "sphinx.domains.citation": 1, "sphinx.domains.cpp": 9, "sphinx.domains.index": 1, "sphinx.domains.javascript": 3, "sphinx.domains.math": 2, "sphinx.domains.python": 4, "sphinx.domains.rst": 2, "sphinx.domains.std": 2}, "filenames": ["api.rst", "index.md"], "indexentries": {}, "objects": {"": [[0, 0, 1, "get--questions", "/questions"], [0, 1, 1, "post--recommend", "/recommend"], [0, 1, 1, "post--refine_recommendations", "/refine_recommendations"], [0, 0, 1, "get--services-all", "/services/all"], [0, 0, 1, "get--services-count", "/services/count"]]}, "objnames": {"0": ["http", "get", "HTTP get"], "1": ["http", "post", "HTTP post"]}, "objtypes": {"0": "http:get", "1": "http:post"}, "terms": {"": 0, "0": 1, "1": [0, 1], "10": 1, "11": 1, "123": 0, "150": 0, "18": 1, "200": 0, "211_api_kei": 1, "3": 1, "3832": 0, "4": 1, "400": 0, "422": 0, "43": 0, "456": 0, "500": 0, "5000": 0, "5pm": 0, "6532": 0, "7890": 0, "79": 0, "9am": 0, "For": 1, "On": 1, "The": [0, 1], "Then": 1, "about": [0, 1], "activ": 1, "address": 0, "ai": 1, "all": [0, 1], "amount": 1, "an": [0, 1], "answer": 0, "ar": 0, "architectur": 1, "arrai": 0, "avail": 0, "backend": 1, "bad": 0, "base": 0, "bash": 1, "bin": 1, "bodi": 0, "boolean": 0, "built": 1, "can": 1, "care": [0, 1], "categori": 0, "category1": 0, "category2": 0, "cd": 1, "check": 1, "chromadb": 1, "clone": 1, "collection_nam": 1, "com": [0, 1], "commit": 1, "commun": 1, "compon": 1, "compos": 1, "connect": 1, "contain": [0, 1], "correct": 1, "count": 0, "creat": 1, "data": 0, "data_dir": 1, "databas": [0, 1], "dataset": 1, "default": 0, "describ": 0, "descript": 0, "detail": 0, "dev": 1, "develop": 1, "dir": 1, "disabl": 0, "do": 0, "doc": 1, "docker": 1, "document": 1, "download_data": 1, "emerg": 0, "enabl": 0, "endpoint": 0, "engin": 1, "entiti": 0, "env": 1, "environ": 1, "exampl": 0, "f": 1, "fals": 0, "fastapi": 1, "file": 1, "first": 1, "flag": 0, "follow": 0, "found": 0, "fridai": 0, "from": 0, "frontend_port": 1, "get": 0, "git": 1, "github": 1, "gta": 1, "have": 1, "health_rec": 1, "help": 1, "henc": 1, "hour": 0, "http": 1, "i": [0, 1], "id": 0, "ignor": 1, "indic": 0, "initi": 0, "input": 0, "insecur": 1, "integ": 0, "interact": 1, "interfac": 1, "intern": 0, "invalid": 0, "is_emerg": 0, "is_out_of_scop": 0, "j": 1, "json": 0, "latest": 1, "latitud": 0, "list": [0, 1], "load": 1, "load_embed": 1, "localhost": 1, "locat": 0, "longitud": 0, "look": 0, "m": 1, "mai": 0, "main": 0, "make": 1, "manage_data": 1, "mapbox_api_kei": 1, "match": 0, "mental": 0, "messag": 0, "meter": 0, "microservic": 1, "modern": 1, "mondai": 0, "name": [0, 1], "need": 0, "network": 1, "next": 1, "next_public_google_maps_api_kei": 1, "no_services_found": 0, "node": 1, "note": 1, "npm": 1, "number": 0, "object": 0, "ok": 0, "onli": 1, "ontario": 1, "openai": 1, "openai_api_kei": 1, "option": [0, 1], "origin": 0, "outsid": 0, "package_nam": 1, "paramet": 0, "path": 1, "path_to_data_dir": 1, "path_to_data_dir_with_json_fil": 1, "peopl": 1, "person": 0, "phone_numb": 0, "poetri": 1, "post": 0, "power": 1, "pre": 1, "prefer": 0, "previou": 0, "previous": 0, "proce": 1, "profil": 1, "project": 1, "provid": 0, "purpos": 1, "pwd": 1, "py": 1, "python": 1, "python3": 1, "queri": 0, "radiu": 0, "rec": 1, "rec_app": 1, "refer": 1, "refine_recommend": 0, "relat": 0, "relev": 0, "repositori": 1, "request": 0, "requir": [0, 1], "rerank": 0, "retriev": 0, "return": 0, "root": 1, "scope": 0, "script": 1, "search": 0, "section": 0, "see": 1, "server": 0, "service_id": 0, "side": 0, "small": 1, "sourc": 1, "st": 0, "storag": 1, "string": 0, "success": 0, "successfulli": 0, "suggest": 0, "support": 0, "sure": 1, "system": 0, "technologi": 1, "test": 1, "text": 0, "thi": [0, 1], "tool": 1, "total": 0, "type": 0, "unprocess": 0, "up": [0, 1], "updat": 0, "url": 1, "us": 1, "user": [0, 1], "v": 1, "v20": 1, "vector": 1, "vectorinstitut": 1, "venv": 1, "virtual": [0, 1], "w": 1, "want": 1, "warn": 1, "we": 1, "websit": 0, "welcom": 1, "went": 0, "were": 0, "what": 0, "while": 1, "wide": 1, "window": 1, "workspac": 1, "wrong": 0, "yml": 1, "you": 0, "your": 0, "your_211_api_kei": 1, "your_211_kei": 1, "your_collection_nam": 1, "your_google_maps_kei": 1, "your_mapbox_kei": 1, "your_openai_api_kei": 1, "your_openai_kei": 1}, "titles": ["API Reference", "Health Recommendation System"], "titleterms": {"211": 1, "In": 1, "api": [0, 1], "browser": 1, "case": 1, "code": 0, "command": 1, "common": 0, "data": 1, "depend": 1, "directori": 1, "download": 1, "embed": 1, "error": 0, "follow": 1, "frontend": 1, "gener": 0, "get": 1, "health": [0, 1], "http": 0, "inform": 0, "instal": 1, "kei": 1, "navig": 1, "overview": 1, "prerequisit": 1, "question": 0, "recommend": [0, 1], "refer": 0, "refin": 0, "respons": 0, "run": 1, "servic": [0, 1], "setup": 1, "start": 1, "statu": 0, "system": 1, "ui": 1, "updat": 1, "upload": 1, "wish": 1, "you": 1}}) \ No newline at end of file