ibl-data-manager (3.59.0-ai-plus)
API for iblai
Request
Create a new mentor using the wizard interface.
Args: request: The HTTP request containing the mentor data. org: The organization/tenant identifier. user_id: The ID of the user creating the mentor.
Returns: Response: The created mentor.
Raises: BadRequest: If the provided data is invalid.
- application/json
- application/x-www-form-urlencoded
- multipart/form-data
- Mock server
https://docs.ibl.ai/_mock/apis/ibl/api/ai-mentor/orgs/{org}/users/{user_id}/create-mentor-wizard/
https://base.manager.iblai.app/api/ai-mentor/orgs/{org}/users/{user_id}/create-mentor-wizard/
- curl
- JavaScript
- Node.js
- Python
- Java
- C#
- PHP
- Go
- Ruby
- R
- Payload
curl -i -X POST \
'https://docs.ibl.ai/_mock/apis/ibl/api/ai-mentor/orgs/{org}/users/{user_id}/create-mentor-wizard/' \
-H 'Authorization: YOUR_API_KEY_HERE' \
-H 'Content-Type: application/json' \
-d '{
"name": "Data Science Mentor",
"description": "A mentor specialized in data science and machine learning concepts."
}'Whether to force mentor to only use information within the provided documents.
Whether to show suggested prompts for the mentor or not. Note: Suggested prompts are created by tenant admins.
Whether to show suggested prompts for the mentor or not. Note: Guided prompts are created with an llm based on chat history.
Prompt template used to start a conversation with the user when greeting_type is proactive_prompt. This will be sent to the LLM so it can respond naturally
The prompt for the moderation system. This prompt must clearly distinguish between 'Approapriate' and 'Not Appropriate' queries.
Prompt to be used to alter or modify final llm response into any desired form.
Desired feedback to return to the user when their prompt is deemed inappropriate.
proactive_prompt- Proactive Promptproactive_response- Proactive Response
{ "id": 1, "name": "Data Science Mentor", "description": "A mentor specialized in data science and machine learning concepts.", "platform": "main", "categories": [], "unique_id": "937d3d46-3048-4f9d-aa5c-ce7c51d85332", "created_by": "admin", "date_created": "2023-01-01T12:00:00Z" }
Request
Retrieve custom instructions for a specific user.
Args: request: The HTTP request. org: The organization/tenant identifier. user_id: The ID of the user to retrieve custom instructions for.
Returns: Response: The custom instructions for the user.
Raises: NotFound: If no custom instructions exist for the user.
- Mock server
https://docs.ibl.ai/_mock/apis/ibl/api/ai-mentor/orgs/{org}/users/{user_id}/custom-instruction/
https://base.manager.iblai.app/api/ai-mentor/orgs/{org}/users/{user_id}/custom-instruction/
- curl
- JavaScript
- Node.js
- Python
- Java
- C#
- PHP
- Go
- Ruby
- R
- Payload
curl -i -X GET \
'https://docs.ibl.ai/_mock/apis/ibl/api/ai-mentor/orgs/{org}/users/{user_id}/custom-instruction/' \
-H 'Authorization: YOUR_API_KEY_HERE'{ "id": 1, "username": "johndoe", "platform_key": "main", "content": "Always explain concepts in simple terms with examples.", "created_at": "2023-01-01T12:00:00Z", "updated_at": "2023-01-02T14:30:00Z" }
Request
Create a new custom instruction for a user.
Args: request: The HTTP request containing the custom instruction data. org: The organization/tenant identifier. user_id: The ID of the user to create custom instructions for.
Returns: Response: The created custom instruction.
Raises: BadRequest: If the provided data is invalid.
- application/json
- application/x-www-form-urlencoded
- multipart/form-data
- Mock server
https://docs.ibl.ai/_mock/apis/ibl/api/ai-mentor/orgs/{org}/users/{user_id}/custom-instruction/
https://base.manager.iblai.app/api/ai-mentor/orgs/{org}/users/{user_id}/custom-instruction/
- curl
- JavaScript
- Node.js
- Python
- Java
- C#
- PHP
- Go
- Ruby
- R
- Payload
curl -i -X POST \
'https://docs.ibl.ai/_mock/apis/ibl/api/ai-mentor/orgs/{org}/users/{user_id}/custom-instruction/' \
-H 'Authorization: YOUR_API_KEY_HERE' \
-H 'Content-Type: application/json' \
-d '{
"content": "Always explain concepts in simple terms with examples."
}'{ "id": 1, "username": "johndoe", "platform_key": "main", "content": "Always explain concepts in simple terms with examples.", "created_at": "2023-01-01T12:00:00Z", "updated_at": "2023-01-01T12:00:00Z" }