Neura AI v0.1.91 - API v1.1 - Interact Endpoint Enhanced - Support For Multipart/Form-Data

Significant enhancements to the `Interact-with-llm` endpoint. This release brings advanced single point functionalities that improve the interaction capabilities with FANA Large Language Model (LLM).

What’s New in v1.1

Enhanced Multipart/Form-Data Support

• Unified Interaction: Developers can now use this endpoint to send text, upload files or both in a single API call through the enhanced support for multipart/form-data. This integration allows for seamless interactions whether developers are sending text, files, or both.

Improved Model Definitions with Pydantic

• Stronger Data Validation: Leveraging Pydantic models, the endpoint now includes robust validation and serialization to ensure data integrity and streamline error handling.

• Better Examples in Documentation: Utilizing Pydantic’s schema_extra, we have enriched our Swagger UI documentation with clear examples and descriptions to guide API usage effectively.

Upgraded Swagger UI Documentation

• Detailed Endpoint Documentation: Despite Swagger UI’s limitations with complex multipart requests, our documentation now includes comprehensive details and examples to assist developers in crafting correct API calls.

Advanced Error Handling

• Enhanced Feedback Mechanisms: The endpoint provides more specific error messages for validation failures and handling scenarios, such as incorrect data formats or missing required fields.

Increased API Flexibility

• Versatile API Usage: The endpoint’s design now accommodates a wider range of interactions with the LLM, supporting diverse application needs from text processing to image handling.

How to Use the Updated Endpoint:

Postman Configuration:

POST: https://backend.fana.ai/aimagine/api/v1/interact-with-llm/

Content-Type: Always use 'multipart/form-data' for text, file upload or both

• Text Input:

  • Content-Type: multipart/form-data

  • Key: text

  • Type: text

  • Value: Your input text here

• File Upload:

  • Content-Type: multipart/form-data

  • Key: file

  • Type: file

  • Value: Select a file to upload

Example cURL Usage:

• You can also use cURL to interact with the endpoint as follows:

Content-Type: Always use 'multipart/form-data' for text, file upload or both

curl -X POST "https://backend.fana.ai/aimagine/api/v1/interact-with-llm/" \
     -H "Content-Type: multipart/form-data" \
     -H "Authorization: Bearer YOUR_BEARER_TOKEN_HERE" \
     -F "text=some text" \
     -F "file=@path_to_your_file"

Note: Replace "path_to_your_file" with the actual path to the file you wish to upload.

Future Plans

• Continuous Improvement: Based on developer feedback, we will continue to enhance the API’s usability and functionality in upcoming releases.

How to Upgrade

• Endpoint Update: Developers are encouraged to review the updated documentation and adjust their API interactions to leverage the new capabilities.

• Feedback Submission: Please submit any feedback or issues through our support channels or directly via your customer success representative.

---

For detailed API documentation, visit: [https://docs.fana.ai/llm_framework/documentation/api-endpoints]