[Feature] OpenAI Function Calling

[maccuryj]

Description

This pull request includes primarily the implementation of a solution for OpenAI function calling.

To achieve better consistency in the OpenAILlm code, the Langchain package has been upgraded to version 0.1.4. In this context, a set of imports across the code has been amended for compatbility and preparation for incoming deprecations. No impact could be identified on the package functionality.

The Function calling has been implemented to allow for the passing of a single function structure to an OpenAILlm instance. This instance will be limited to trying to map the query to the provided function structure.
Pydantic models, Python functions and OpenAI format dicts are accepted as input.
When queried, the model returns a string, with either a JSON-formatted output of the method arguments, or a default message documenting the failure.

A test has been developed for the OpenAILlm querying functionality, when passing a "tools" object representing the function structure. The documentation has been adjusted to reflect the feature as now implemented.

It must be noted that the previous implementation which had been merged into the repository is faulty. It does not even leverage OpenAIs Function calling interface (it simply sends a normal query), nor does it result in the output that is expected from this feature (no method argument matching). It also made use of a legacy Langchain interface (function_call instead of tools_call).

Fixes #796

Type of change

Please delete options that are not relevant.

• Bug fix (non-breaking change which fixes an issue)
• New feature (non-breaking change which adds functionality)
• Documentation update

How Has This Been Tested?

During development, a script running the functionality with different types of input was created and used. This also included negative tests. Furthermore, a pytest has been developed to make sure the function is executed as expected.

The functionality can be tested by running the code that has been added to the docs/components/llms.mdx file.

Please delete options that are not relevant.

• Unit Test
• Test Script (see updated documentation)

Test script:

"""
This file provides multiple input types to test the Function Calling functionality developed in the Embedchain project.
Simply add your OpenAI API key and uncomment the input type you wish to test and run the file.
"""

import os

from pydantic import BaseModel, Field

from embedchain import App
from embedchain.llm.openai import OpenAILlm

os.environ["OPENAI_API_KEY"] = "sk-xxx"


class multiply(BaseModel):
    """Multiply two integers together."""

    a: int = Field(..., description="First integer")
    b: int = Field(..., description="Second integer")


# def multiply(a: int, b: int) -> int:
#     """Multiply two integers together.

#     Args:
#         a: First integer
#         b: Second integer
#     """
#     return a * b


# multiply = {
#     "type": "function",
#     "function": {
#         "name": "multiply",
#         "description": "Multiply two integers together.",
#         "parameters": {
#             "type": "object",
#             "properties": {
#                 "a": {"description": "First integer", "type": "integer"},
#                 "b": {"description": "Second integer", "type": "integer"},
#             },
#             "required": ["a", "b"],
#         },
#     },
# }

llm = OpenAILlm(tools=multiply)
app = App(llm=llm)

result = app.query("What is the result of 125 multiplied by fifteen?")
print(result)

Checklist:

• My code follows the style guidelines of this project

• I have performed a self-review of my own code

• I have made corresponding changes to the documentation

• My changes generate no new warnings

• I have added tests that prove my fix is effective or that my feature works

• New and existing unit tests pass locally with my changes

• I have checked my code and corrected any misspellings

Maintainer Checklist

• closes #xxxx (Replace xxxx with the GitHub issue number)
• Made sure Checks passed

[codecov]

Codecov Report

Attention: 2 lines in your changes are missing coverage. Please review.

Comparison is base (d94aee8) 56.52% compared to head (48f354a) 56.75%.
Report is 2 commits behind head on main.

❗ Current head 48f354a differs from pull request most recent head 91cfc7e. Consider uploading reports for the commit 91cfc7e to get more accurate results

Files	Patch %	Lines
embedchain/loaders/rss_feed.py	0.00%	1 Missing ⚠️
embedchain/loaders/unstructured_file.py	0.00%	1 Missing ⚠️

Additional details and impacted files

@@            Coverage Diff             @@
##             main    #1224      +/-   ##
==========================================
+ Coverage   56.52%   56.75%   +0.22%     
==========================================
  Files         146      146              
  Lines        5935     5929       -6     
==========================================
+ Hits         3355     3365      +10     
+ Misses       2580     2564      -16     

☔ View full report in Codecov by Sentry.
📢 Have feedback on the report? Share it here.

[maccuryj]

The attached script can be used to test the functionality with different inputs.
function_call_test.txt

[deshraj]

This is awesome. Thanks for upgrading the version and fixing the function calling.