Интеграция с вызовом функций

Вы уже узнали немало из предыдущих уроков. Однако, мы можем улучшить еще больше. Некоторые вопросы, которые мы можем решить, касаются того, как получить более последовательный формат ответа, чтобы было проще работать с ним в дальнейшем. Также, возможно, мы захотим добавить данные из других источников для дальнейшего обогащения нашего приложения.

Эти проблемы рассматриваются в данной главе.

Введение

Этот урок охватывает:

Объяснение, что такое вызов функций и его варианты использования.
Создание вызова функции с использованием Azure OpenAI.
Как интегрировать вызов функции в приложение.

Цели обучения

К концу этого урока вы сможете:

Объяснить цель использования вызова функций.
Настроить вызов функции с помощью Azure OpenAI Service.
Разрабатывать эффективные вызовы функций для вашего приложения.

Сценарий: Улучшение нашего чат-бота с помощью функций

В этом уроке мы хотим создать функцию для нашего образовательного стартапа, которая позволит пользователям использовать чат-бота для поиска технических курсов. Мы будем рекомендовать курсы, соответствующие их уровню навыков, текущей роли и интересующей технологии.

Для выполнения этого сценария мы будем использовать комбинацию:

Azure OpenAI для создания чата с пользователем.
Microsoft Learn Catalog API для помощи пользователям в поиске курсов на основе их запроса.
Function Calling для получения запроса пользователя и отправки его в функцию для выполнения API-запроса.

Чтобы начать, давайте рассмотрим, почему мы вообще хотим использовать вызов функций:

Зачем нужен вызов функций

До вызова функций ответы от LLM были неструктурированными и непоследовательными. Разработчикам приходилось писать сложный код проверки, чтобы убедиться, что они могут обрабатывать каждую вариацию ответа. Пользователи не могли получать ответы, такие как "Какова текущая погода в Стокгольме?". Это потому, что модели ограничены временем, на которое были обучены данные.

Вызов функций - это функция Azure OpenAI Service, чтобы преодолеть следующие ограничения:

Последовательный формат ответа. Если мы можем лучше контролировать формат ответа, мы можем легче интегрировать ответ в другие системы.
Внешние данные. Возможность использования данных из других источников приложения в контексте чата.

Иллюстрация проблемы через сценарий

Мы рекомендуем вам использовать включенный ноутбук, если вы хотите запустить приведенный ниже сценарий. Вы также можете просто прочитать, так как мы пытаемся проиллюстрировать проблему, которую функции могут помочь решить.

Давайте рассмотрим пример, иллюстрирующий проблему с форматом ответа:

Предположим, мы хотим создать базу данных данных студентов, чтобы мы могли предложить им подходящий курс. Ниже у нас есть два описания студентов, которые очень похожи по содержанию данных.

Создайте соединение с нашим ресурсом Azure OpenAI:

import os
import json
from openai import AzureOpenAI
from dotenv import load_dotenv
load_dotenv()

client = AzureOpenAI(
api_key=os.environ['AZURE_OPENAI_API_KEY'],  # this is also the default, it can be omitted
api_version = "2023-07-01-preview"
)

deployment=os.environ['AZURE_OPENAI_DEPLOYMENT']

Ниже приведен код на Python для настройки нашего соединения с Azure OpenAI, где мы устанавливаем api_type, api_base, api_version and api_key.

Creating two student descriptions using variables student_1_description and student_2_description.

student_1_description="Emily Johnson is a sophomore majoring in computer science at Duke University. She has a 3.7 GPA. Emily is an active member of the university's Chess Club and Debate Team. She hopes to pursue a career in software engineering after graduating."

student_2_description = "Michael Lee is a sophomore majoring in computer science at Stanford University. He has a 3.8 GPA. Michael is known for his programming skills and is an active member of the university's Robotics Club. He hopes to pursue a career in artificial intelligence after finishing his studies."

Мы хотим отправить вышеупомянутые описания студентов в LLM для разбора данных. Эти данные позже могут быть использованы в нашем приложении и отправлены в API или сохранены в базе данных.

Давайте создадим два идентичных запроса, в которых мы инструктируем LLM, какая информация нас интересует:

prompt1 = f'''
Please extract the following information from the given text and return it as a JSON object:

name
major
school
grades
club

This is the body of text to extract the information from:
{student_1_description}
'''

prompt2 = f'''
Please extract the following information from the given text and return it as a JSON object:

name
major
school
grades
club

This is the body of text to extract the information from:
{student_2_description}
'''

Вышеприведенные запросы инструктируют LLM извлечь информацию и вернуть ответ в формате JSON.

После настройки запросов и соединения с Azure OpenAI, мы теперь отправим запросы в LLM, используя openai.ChatCompletion. We store the prompt in the messages variable and assign the role to user. Это имитирует сообщение от пользователя, написанное в чат-боте.

# response from prompt one
openai_response1 = client.chat.completions.create(
model=deployment,
messages = [{'role': 'user', 'content': prompt1}]
)
openai_response1.choices[0].message.content

# response from prompt two
openai_response2 = client.chat.completions.create(
model=deployment,
messages = [{'role': 'user', 'content': prompt2}]
)
openai_response2.choices[0].message.content

Теперь мы можем отправить оба запроса в LLM и изучить полученный ответ, найдя его следующим образом openai_response1['choices'][0]['message']['content'].

Lastly, we can convert the response to JSON format by calling json.loads:
```
# Loading the response as a JSON object
json_response1 = json.loads(openai_response1.choices[0].message.content)
json_response1
```
Ответ 1:
```
{
  "name": "Emily Johnson",
  "major": "computer science",
  "school": "Duke University",
  "grades": "3.7",
  "club": "Chess Club"
}
```
Ответ 2:
```
{
  "name": "Michael Lee",
  "major": "computer science",
  "school": "Stanford University",
  "grades": "3.8 GPA",
  "club": "Robotics Club"
}
```
Хотя запросы одинаковы и описания схожи, мы видим значения Grades property formatted differently, as we can sometimes get the format 3.7 or 3.7 GPA for example.

This result is because the LLM takes unstructured data in the form of the written prompt and returns also unstructured data. We need to have a structured format so that we know what to expect when storing or using this data

So how do we solve the formatting problem then? By using functional calling, we can make sure that we receive structured data back. When using function calling, the LLM does not actually call or run any functions. Instead, we create a structure for the LLM to follow for its responses. We then use those structured responses to know what function to run in our applications.

We can then take what is returned from the function and send this back to the LLM. The LLM will then respond using natural language to answer the user's query.

Use Cases for using function calls

There are many different use cases where function calls can improve your app like:

Calling External Tools. Chatbots are great at providing answers to questions from users. By using function calling, the chatbots can use messages from users to complete certain tasks. For example, a student can ask the chatbot to "Send an email to my instructor saying I need more assistance with this subject". This can make a function call to send_email(to: string, body: string)
Create API or Database Queries. Users can find information using natural language that gets converted into a formatted query or API request. An example of this could be a teacher who requests "Who are the students that completed the last assignment" which could call a function named get_completed(student_name: string, assignment: int, current_status: string)
Creating Structured Data. Users can take a block of text or CSV and use the LLM to extract important information from it. For example, a student can convert a Wikipedia article about peace agreements to create AI flashcards. This can be done by using a function called get_important_facts(agreement_name: string, date_signed: string, parties_involved: list)

Creating Your First Function Call

The process of creating a function call includes 3 main steps:

Calling the Chat Completions API with a list of your functions and a user message.
Reading the model's response to perform an action i.e. execute a function or API Call.
Making another call to Chat Completions API with the response from your function to use that information to create a response to the user.

Step 1 - creating messages

The first step is to create a user message. This can be dynamically assigned by taking the value of a text input or you can assign a value here. If this is your first time working with the Chat Completions API, we need to define the role and the content of the message.

The role can be either system (creating rules), assistant (the model) or user (the end-user). For function calling, we will assign this as user и пример вопроса.

messages= [ {"role": "user", "content": "Find me a good course for a beginner student to learn Azure."} ]

Назначая различные роли, становится ясно для LLM, говорит ли что-то система или пользователь, что помогает создать историю разговора, на которой LLM может основываться.

Шаг 2 - создание функций

Далее мы определим функцию и параметры этой функции. Мы будем использовать всего одну функцию здесь, называемую search_courses but you can create multiple functions.

Important : Functions are included in the system message to the LLM and will be included in the amount of available tokens you have available.

Below, we create the functions as an array of items. Each item is a function and has properties name, description and parameters:

functions = [
   {
      "name":"search_courses",
      "description":"Retrieves courses from the search index based on the parameters provided",
      "parameters":{
         "type":"object",
         "properties":{
            "role":{
               "type":"string",
               "description":"The role of the learner (i.e. developer, data scientist, student, etc.)"
            },
            "product":{
               "type":"string",
               "description":"The product that the lesson is covering (i.e. Azure, Power BI, etc.)"
            },
            "level":{
               "type":"string",
               "description":"The level of experience the learner has prior to taking the course (i.e. beginner, intermediate, advanced)"
            }
         },
         "required":[
            "role"
         ]
      }
   }
]

Давайте подробнее опишем каждый экземпляр функции ниже:

name - The name of the function that we want to have called.
description - This is the description of how the function works. Here it's important to be specific and clear.
parameters - A list of values and format that you want the model to produce in its response. The parameters array consists of items where the items have the following properties:
1. type - The data type of the properties will be stored in.
2. properties - List of the specific values that the model will use for its response
  1. name - The key is the name of the property that the model will use in its formatted response, for example, product.
  2. type - The data type of this property, for example, string.
  3. description - Description of the specific property.

There's also an optional property required - required property for the function call to be completed.

Step 3 - Making the function call

After defining a function, we now need to include it in the call to the Chat Completion API. We do this by adding functions to the request. In this case functions=functions.

There is also an option to set function_call to auto. This means we will let the LLM decide which function should be called based on the user message rather than assigning it ourselves.

Here's some code below where we call ChatCompletion.create, note how we set functions=functions and function_call="auto" и, таким образом, даем LLM выбор, когда вызывать предоставленные нами функции:

response = client.chat.completions.create(model=deployment,
                                        messages=messages,
                                        functions=functions,
                                        function_call="auto")

print(response.choices[0].message)

Ответ, который приходит обратно, выглядит следующим образом:

{
  "role": "assistant",
  "function_call": {
    "name": "search_courses",
    "arguments": "{\n  \"role\": \"student\",\n  \"product\": \"Azure\",\n  \"level\": \"beginner\"\n}"
  }
}

Здесь мы можем увидеть, как функция search_courses was called and with what arguments, as listed in the arguments property in the JSON response.

The conclusion the LLM was able to find the data to fit the arguments of the function as it was extracting it from the value provided to the messages parameter in the chat completion call. Below is a reminder of the messages значение:

messages= [ {"role": "user", "content": "Find me a good course for a beginner student to learn Azure."} ]

Как вы видите, student, Azure and beginner was extracted from messages and set as input to the function. Using functions this way is a great way to extract information from a prompt but also to provide structure to the LLM and have reusable functionality.

Next, we need to see how we can use this in our app.

Integrating Function Calls into an Application

After we have tested the formatted response from the LLM, we can now integrate this into an application.

Managing the flow

To integrate this into our application, let's take the following steps:

First, let's make the call to the OpenAI services and store the message in a variable called response_message.
```
response_message = response.choices[0].message
```
Теперь мы определим функцию, которая будет вызывать Microsoft Learn API для получения списка курсов:
```
import requests

def search_courses(role, product, level):
  url = "https://learn.microsoft.com/api/catalog/"
  params = {
     "role": role,
     "product": product,
     "level": level
  }
  response = requests.get(url, params=params)
  modules = response.json()["modules"]
  results = []
  for module in modules[:5]:
     title = module["title"]
     url = module["url"]
     results.append({"title": title, "url": url})
  return str(results)
```
Обратите внимание, как мы теперь создаем фактическую функцию на Python, которая соответствует именам функций, введенным в functions variable. We're also making real external API calls to fetch the data we need. In this case, we go against the Microsoft Learn API to search for training modules.

Ok, so we created functions variables and a corresponding Python function, how do we tell the LLM how to map these two together so our Python function is called?

To see if we need to call a Python function, we need to look into the LLM response and see if function_call, и является частью этого, и вызываем указанную функцию. Вот как вы можете сделать упомянутую проверку ниже:

# Check if the model wants to call a function
if response_message.function_call.name:
 print("Recommended Function call:")
 print(response_message.function_call.name)
 print()

 # Call the function.
 function_name = response_message.function_call.name

 available_functions = {
         "search_courses": search_courses,
 }
 function_to_call = available_functions[function_name]

 function_args = json.loads(response_message.function_call.arguments)
 function_response = function_to_call(**function_args)

 print("Output of function call:")
 print(function_response)
 print(type(function_response))


 # Add the assistant response and function response to the messages
 messages.append( # adding assistant response to messages
     {
         "role": response_message.role,
         "function_call": {
             "name": function_name,
             "arguments": response_message.function_call.arguments,
         },
         "content": None
     }
 )
 messages.append( # adding function response to messages
     {
         "role": "function",
         "name": function_name,
         "content":function_response,
     }
 )

Эти три строки обеспечивают извлечение имени функции, аргументов и выполнение вызова:

function_to_call = available_functions[function_name]

function_args = json.loads(response_message.function_call.arguments)
function_response = function_to_call(**function_args)

Ниже приведен вывод из выполнения нашего кода:

Вывод

{
  "name": "search_courses",
  "arguments": "{\n  \"role\": \"student\",\n  \"product\": \"Azure\",\n  \"level\": \"beginner\"\n}"
}

Output of function call:
[{'title': 'Describe concepts of cryptography', 'url': 'https://learn.microsoft.com/training/modules/describe-concepts-of-cryptography/?
WT.mc_id=api_CatalogApi'}, {'title': 'Introduction to audio classification with TensorFlow', 'url': 'https://learn.microsoft.com/en-
us/training/modules/intro-audio-classification-tensorflow/?WT.mc_id=api_CatalogApi'}, {'title': 'Design a Performant Data Model in Azure SQL
Database with Azure Data Studio', 'url': 'https://learn.microsoft.com/training/modules/design-a-data-model-with-ads/?
WT.mc_id=api_CatalogApi'}, {'title': 'Getting started with the Microsoft Cloud Adoption Framework for Azure', 'url':
'https://learn.microsoft.com/training/modules/cloud-adoption-framework-getting-started/?WT.mc_id=api_CatalogApi'}, {'title': 'Set up the
Rust development environment', 'url': 'https://learn.microsoft.com/training/modules/rust-set-up-environment/?WT.mc_id=api_CatalogApi'}]
<class 'str'>

Теперь мы отправим обновленное сообщение, messages, в LLM, чтобы мы могли получить ответ на естественном языке вместо ответа в формате JSON API.

print("Messages in next request:")
print(messages)
print()

second_response = client.chat.completions.create(
   messages=messages,
   model=deployment,
   function_call="auto",
   functions=functions,
   temperature=0
      )  # get a new response from GPT where it can see the function response


print(second_response.choices[0].message)

Вывод

{
  "role": "assistant",
  "content": "I found some good courses for beginner students to learn Azure:\n\n1. [Describe concepts of cryptography] (https://learn.microsoft.com/training/modules/describe-concepts-of-cryptography/?WT.mc_id=api_CatalogApi)\n2. [Introduction to audio classification with TensorFlow](https://learn.microsoft.com/training/modules/intro-audio-classification-tensorflow/?WT.mc_id=api_CatalogApi)\n3. [Design a Performant Data Model in Azure SQL Database with Azure Data Studio](https://learn.microsoft.com/training/modules/design-a-data-model-with-ads/?WT.mc_id=api_CatalogApi)\n4. [Getting started with the Microsoft Cloud Adoption Framework for Azure](https://learn.microsoft.com/training/modules/cloud-adoption-framework-getting-started/?WT.mc_id=api_CatalogApi)\n5. [Set up the Rust development environment](https://learn.microsoft.com/training/modules/rust-set-up-environment/?WT.mc_id=api_CatalogApi)\n\nYou can click on the links to access the courses."
}

Задание

Чтобы продолжить изучение вызова функций Azure OpenAI, вы можете создать:

Больше параметров функции, которые могут помочь учащимся найти больше курсов.
Создать другой вызов функции, который принимает больше информации от учащегося, например, его родной язык.
Создать обработку ошибок, когда вызов функции и/или API не возвращает подходящих курсов.

Подсказка: следуйте документации по API, чтобы увидеть, как и где доступны эти данные.

Отличная работа! Продолжайте путешествие

После завершения этого урока ознакомьтесь с нашей коллекцией обучения генеративному ИИ, чтобы продолжить повышение своих знаний о генеративном ИИ!

Перейдите к уроку 12, где мы рассмотрим, как разрабатывать UX для AI приложений!

Отказ от ответственности:
Этот документ был переведен с помощью службы автоматического перевода Co-op Translator. Хотя мы стремимся к точности, имейте в виду, что автоматические переводы могут содержать ошибки или неточности. Оригинальный документ на родном языке следует считать авторитетным источником. Для получения критически важной информации рекомендуется профессиональный перевод человеком. Мы не несем ответственности за любые недоразумения или неправильные интерпретации, возникшие в результате использования этого перевода.

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Интеграция с вызовом функций

Введение

Цели обучения

Сценарий: Улучшение нашего чат-бота с помощью функций

Зачем нужен вызов функций

Иллюстрация проблемы через сценарий

Use Cases for using function calls

Creating Your First Function Call

Step 1 - creating messages

Шаг 2 - создание функций

Step 3 - Making the function call

Integrating Function Calls into an Application

Managing the flow

Задание

Отличная работа! Продолжайте путешествие

FilesExpand file tree

README.md

Latest commit

History

README.md

File metadata and controls

Интеграция с вызовом функций

Введение

Цели обучения

Сценарий: Улучшение нашего чат-бота с помощью функций

Зачем нужен вызов функций

Иллюстрация проблемы через сценарий

Use Cases for using function calls

Creating Your First Function Call

Step 1 - creating messages

Шаг 2 - создание функций

Step 3 - Making the function call

Integrating Function Calls into an Application

Managing the flow

Задание

Отличная работа! Продолжайте путешествие