PaLM API:快速入门:使用 Python

在 ai.google.dev 上查看 试用 Colab 笔记本 在 GitHub 上查看笔记本

在此笔记本中,您将学习如何开始使用 PaLM API,该 API 可让您访问 Google 的最新大语言模型。在本部分中,您将了解如何使用 PaLM API 来处理以对话为中心的用例,例如聊天机器人。

设置

首先,下载并安装 PaLM API Python 库。

pip install -U google-generativeai
import google.generativeai as genai

获取 API 密钥

首先,您需要创建 API 密钥

genai.configure(api_key='API_KEY')

发起对话

在本教程中,您将使用 PaLM API,该 API 适用于聊天用例。该语言模型使用大型对话数据集进行训练,因此当您调用该模型时,它会给出对话式、聊天式的回答:

# Create a new conversation
response = genai.chat(messages='Hello')

# Last contains the model's response:
response.last
'Hello! How can I help you today?'

您可以向模型的回答发送 reply,继续进行对话:

# Add to the existing conversation by sending a reply
response = response.reply("Just chillin'")
# See the model's latest response in the `last` field:
response.last
"That's great! Chilling is a great way to relax and de-stress. I hope you're having a good day."

瞧!您已通过 PaLM API 成功进行了首次对话。

对话记录

当然,聊天对话包含用户与模型之间不断增加的来回消息。如需查看您目前构建的对话历史记录,您可以检查 messages 字段:

response.messages
[{'author': '0', 'content': 'Hello'},
 {'author': '1', 'content': 'Hi there! How can I help you today?'},
 {'author': '0', 'content': "Just chillin'"},
 {'author': '1',
  'content': "That's great! Chilling is a great way to relax and de-stress. I hope you're having a good day."}]

上例中,您有两次对话“来回”,即模型与用户之间的两次交流。在此处,用户的消息默认标记为 'author': '0',模型的回答标记为 'author': '1'。这有助于您日后跟踪是谁说了什么。

选择其他回答

通常,LLM 生成的文本会具有一定程度的随机性。(如需详细了解原因,请参阅 LLM 基础知识)。这意味着,如果您使用相同的输入多次调用该 API,可能会获得不同的响应。您可以利用此功能获取替代模型回答:

# Create a brand new chat with candidate_count = 4.
response = genai.chat(messages="What should I eat for dinner tonight? List a few options", candidate_count = 4)
# See the model's default response
response.last
"Here are a few options for dinner tonight:\n\n* **Pasta:** Pasta is a classic dinner option that can be made in many different ways. You can have a simple pasta with tomato sauce, or you can get more creative with your toppings. Some popular pasta toppings include meatballs, sausage, broccoli, and spinach.\n* **Pizza:** Pizza is another popular dinner option that can be customized to your liking. You can order a pizza from a restaurant, or you can make your own at home. If you're making your own pizza, you can choose your own toppings. Some popular pizza toppings include pepperoni, sausage, mushrooms, onions, and peppers.\n* **Sushi:** Sushi is a healthy and delicious dinner option that is perfect for a light meal. You can order sushi from a restaurant, or you can make your own at home. If you're making your own sushi, you can choose your own fillings. Some popular sushi fillings include salmon, tuna, shrimp, and avocado.\n* **Burgers:** Burgers are a classic American dinner option that is perfect for a casual meal. You can order burgers from a restaurant, or you can make your own at home. If you're making your own burgers, you can choose your own toppings. Some popular burger toppings include cheese, lettuce, tomato, onion, and pickles.\n* **Tacos:** Tacos are a delicious and versatile dinner option that can be made with a variety of fillings. You can order tacos from a restaurant, or you can make your own at home. If you're making your own tacos, you can choose your own fillings. Some popular taco fillings include ground beef, chicken, pork, and fish.\n* **Chicken:** Chicken is a healthy and versatile protein that can be cooked in many different ways. You can bake, grill, or fry chicken, or you can cook it in a skillet. Chicken can be served with a variety of side dishes, such as rice, potatoes, or vegetables.\n* **Fish:** Fish is a healthy and delicious protein that can be cooked in many different ways. You can bake, grill, or fry fish, or you can cook it in a skillet. Fish can be served with a variety of side dishes, such as rice, potatoes, or vegetables.\n* **Steak:** Steak is a hearty and flavorful protein that can be cooked in many different ways. You can grill, pan-fry, or broil steak, or you can cook it in a skillet. Steak can be served with a variety of side dishes, such as mashed potatoes, broccoli, or asparagus.\n* **Vegetarian:** There are many delicious vegetarian dinner options available. You can make a vegetarian pasta dish, a vegetarian pizza, or a vegetarian stir-fry. You can also make a vegetarian burger or a vegetarian taco.\n* **Dessert:** No dinner is complete without dessert! You can have a slice of cake, a scoop of ice cream, or a piece of pie. You can also make your own dessert, such as cookies, brownies, or cupcakes.\n\nI hope this gives you some ideas for dinner tonight!"
# See alternate possible model responses
response.candidates
[{'author': '1',
  'content': "Here are a few options for dinner tonight:\n\n* **Pasta:** Pasta is a classic dinner option that can be made in many different ways. You can have a simple pasta with tomato sauce, or you can get more creative with your toppings. Some popular pasta toppings include meatballs, sausage, broccoli, and spinach.\n* **Pizza:** Pizza is another popular dinner option that can be customized to your liking. You can order a pizza from a restaurant, or you can make your own at home. If you're making your own pizza, you can choose your own toppings. Some popular pizza toppings include pepperoni, sausage, mushrooms, onions, and peppers.\n* **Sushi:** Sushi is a healthy and delicious dinner option that is perfect for a light meal. You can order sushi from a restaurant, or you can make your own at home. If you're making your own sushi, you can choose your own fillings. Some popular sushi fillings include salmon, tuna, shrimp, and avocado.\n* **Burgers:** Burgers are a classic American dinner option that is perfect for a casual meal. You can order burgers from a restaurant, or you can make your own at home. If you're making your own burgers, you can choose your own toppings. Some popular burger toppings include cheese, lettuce, tomato, onion, and pickles.\n* **Tacos:** Tacos are a delicious and versatile dinner option that can be made with a variety of fillings. You can order tacos from a restaurant, or you can make your own at home. If you're making your own tacos, you can choose your own fillings. Some popular taco fillings include ground beef, chicken, pork, and fish.\n* **Chicken:** Chicken is a healthy and versatile protein that can be cooked in many different ways. You can bake, grill, or fry chicken, or you can cook it in a skillet. Chicken can be served with a variety of side dishes, such as rice, potatoes, or vegetables.\n* **Fish:** Fish is a healthy and delicious protein that can be cooked in many different ways. You can bake, grill, or fry fish, or you can cook it in a skillet. Fish can be served with a variety of side dishes, such as rice, potatoes, or vegetables.\n* **Steak:** Steak is a hearty and flavorful protein that can be cooked in many different ways. You can grill, pan-fry, or broil steak, or you can cook it in a skillet. Steak can be served with a variety of side dishes, such as mashed potatoes, broccoli, or asparagus.\n* **Vegetarian:** There are many delicious vegetarian dinner options available. You can make a vegetarian pasta dish, a vegetarian pizza, or a vegetarian stir-fry. You can also make a vegetarian burger or a vegetarian taco.\n* **Dessert:** No dinner is complete without dessert! You can have a slice of cake, a scoop of ice cream, or a piece of pie. You can also make your own dessert, such as cookies, brownies, or cupcakes.\n\nI hope this gives you some ideas for dinner tonight!"},
 {'author': '1',
  'content': 'Here are some options for dinner tonight:\n\n* **Chicken and rice:** This is a classic and easy meal that is sure to please everyone. Simply cook some chicken breasts and rice, and then season to taste. You can also add vegetables to this dish for a more complete meal.\n* **Spaghetti and meatballs:** This is another classic Italian dish that is perfect for a weeknight meal. Simply cook some spaghetti noodles and meatballs, and then top with your favorite sauce.\n* **Tacos:** Tacos are a great option for a quick and easy meal. You can fill them with whatever you like, such as ground beef, chicken, or fish. Simply cook your filling and then heat up some tortillas. You can also add toppings such as lettuce, tomatoes, cheese, and sour cream.\n* **Pizza:** Pizza is a great option for a casual meal. You can either make your own pizza dough or buy it pre-made. Then, simply top your pizza with your favorite toppings and bake it in the oven.\n* **Burgers:** Burgers are a great option for a hearty meal. You can either make your own burger patties or buy them pre-made. Then, simply grill or cook your burgers and then top them with your favorite toppings.\n* **Sandwiches:** Sandwiches are a great option for a quick and easy meal. You can fill them with whatever you like, such as ham, turkey, cheese, or vegetables. Simply spread some mayonnaise or mustard on your bread and then add your filling.\n* **Salad:** Salad is a great option for a light and healthy meal. You can add whatever vegetables you like to your salad, and then top it with your favorite dressing.\n* **Soup:** Soup is a great option for a warm and comforting meal. There are many different types of soup that you can make, such as chicken noodle soup, tomato soup, or lentil soup.\n* **Stir-fry:** Stir-fry is a great option for a quick and easy meal. You can use whatever vegetables you like in your stir-fry, and then add your favorite protein, such as chicken, beef, or tofu. Simply cook your vegetables and protein in a wok or large skillet, and then season to taste.\n* **Pasta:** Pasta is a great option for a quick and easy meal. There are many different types of pasta that you can make, such as spaghetti, penne, or macaroni. You can simply cook your pasta according to the package directions, and then top it with your favorite sauce.\n* **Fish:** Fish is a great option for a healthy and light meal. There are many different types of fish that you can cook, such as salmon, tuna, or cod. Simply cook your fish according to the package directions, and then season to taste.\n* **Vegetables:** Vegetables are a great option for a healthy and light meal. There are many different types of vegetables that you can cook, such as broccoli, carrots, or green beans. Simply cook your vegetables according to the package directions, and then season to taste.\n* **Fruit:** Fruit is a great option for a healthy and light snack or dessert. There are many different types of fruit that you can eat, such as apples, oranges, or bananas. Simply wash and eat your fruit.\n* **Dessert:** Dessert is a great way to end a meal. There are many different types of dessert that you can make, such as cake, pie, or ice cream. Simply make your favorite dessert according to the recipe.'},
 {'author': '1',
  'content': 'Here are some ideas for what to eat for dinner tonight:\n\n* **Pasta:** Pasta is a quick and easy meal that can be made with a variety of ingredients. You can make a simple pasta dish with tomato sauce and cheese, or you can get creative and add in other ingredients like vegetables, meat, or seafood.\n* **Stir-fry:** Stir-fries are another quick and easy meal option. They can be made with a variety of vegetables, meat, or tofu. To make a stir-fry, simply chop up your ingredients and cook them in a wok or large skillet over high heat.\n* **Salad:** Salads are a healthy and refreshing meal option. They can be made with a variety of vegetables, fruits, nuts, and seeds. To make a salad, simply chop up your ingredients and toss them together in a bowl. You can then add your favorite dressing.\n* **Soup:** Soup is a warm and comforting meal option. It can be made with a variety of vegetables, meat, or beans. To make soup, simply cook your ingredients in a pot over medium heat until they are tender. You can then blend the soup or leave it chunky.\n* **Sandwich:** Sandwiches are a quick and easy meal option. They can be made with a variety of bread, meat, cheese, and vegetables. To make a sandwich, simply spread your favorite condiment on the bread and layer your ingredients on top.\n* **Tacos:** Tacos are a fun and easy meal option. They can be made with a variety of tortillas, meat, cheese, and vegetables. To make tacos, simply heat up your tortillas and fill them with your favorite ingredients.\n* **Burrito:** Burritos are a hearty and filling meal option. They can be made with a variety of tortillas, meat, cheese, and vegetables. To make a burrito, simply heat up your tortilla and fill it with your favorite ingredients. Then, roll up the tortilla and enjoy!\n* **Pizza:** Pizza is a delicious and easy meal option. It can be made with a variety of crusts, sauces, and toppings. To make pizza, simply preheat your oven and spread your favorite sauce on a pre-made crust. Then, add your favorite toppings and bake until the cheese is melted and bubbly.\n* **Burger:** Burgers are a classic American meal option. They can be made with a variety of patties, buns, toppings, and condiments. To make a burger, simply cook your patty to your desired doneness and then place it on a bun with your favorite toppings.\n* **Chicken:** Chicken is a versatile protein that can be cooked in a variety of ways. It can be baked, grilled, roasted, or fried. To cook chicken, simply season it with your favorite herbs and spices and then cook it to your desired doneness.\n* **Fish:** Fish is a healthy and delicious protein that can be cooked in a variety of ways. It can be baked, grilled, roasted, or fried. To cook fish, simply season it with your favorite herbs and spices and then cook it to your desired doneness.\n* **Steak:** Steak is a flavorful and hearty protein that can be cooked in a variety of ways. It can be grilled, pan-fried, or broiled. To cook steak, simply season it with your favorite herbs and spices and then cook it to your desired doneness.\n* **Vegetables:** Vegetables are a healthy and nutritious part of any meal. They can be cooked in a variety of ways, such as roasting, grilling, or steaming. To cook vegetables, simply season them with your favorite herbs and spices and then cook them to your desired doneness.\n* **Rice:** Rice is a versatile grain that can be cooked in a variety of ways. It can be boiled, steamed, or fried. To cook rice, simply add it to a pot of boiling water and cook it until it is tender.\n* **Potatoes:** Potatoes are a hearty and filling vegetable that can be cooked in a variety of ways. They can be boiled, mashed, baked, or fried. To cook potatoes, simply wash them and then cook them in the desired way.\n* **Fruit:** Fruit is a healthy and refreshing snack or dessert option. It can be eaten fresh, frozen, or canned. To eat fruit, simply wash it and then enjoy!\n* **Dessert:** Dessert is a sweet and satisfying treat. It can be made with a variety of ingredients, such as chocolate, ice cream, cake, or pie. To make dessert, simply combine your favorite ingredients and bake or cook them according to the recipe.'},
 {'author': '1',
  'content': 'Here are a few options for what you could eat for dinner tonight:\n\n* **Chicken and vegetables:** This is a classic and healthy meal that can be made in a variety of ways. You can bake, grill, or pan-fry the chicken, and you can choose any vegetables that you like.\n* **Spaghetti and meatballs:** This is a hearty and comforting meal that is perfect for a cold winter night. You can make your own meatballs or buy them pre-made.\n* **Pizza:** This is a quick and easy meal that everyone loves. You can order a pizza from your favorite restaurant or make your own at home.\n* **Tacos:** Tacos are a versatile meal that can be made with a variety of fillings. You can use ground beef, chicken, fish, or tofu.\n* **Burgers:** Burgers are a classic American dish that is perfect for a summer barbecue. You can make your own burgers or buy them pre-made.\n* **Sandwiches:** Sandwiches are a quick and easy meal that can be made with a variety of ingredients. You can use bread, wraps, or pitas.\n* **Salad:** Salads are a healthy and refreshing meal that can be made with a variety of ingredients. You can use lettuce, tomatoes, cucumbers, carrots, and other vegetables.\n* **Soup:** Soup is a warm and comforting meal that is perfect for a cold winter night. There are many different types of soup, so you can find one that you like.\n* **Stir-fry:** Stir-fries are a quick and easy meal that can be made with a variety of ingredients. You can use meat, vegetables, or tofu.\n* **Pasta:** Pasta is a versatile dish that can be made with a variety of sauces. You can use tomato sauce, Alfredo sauce, or pesto sauce.\n* **Rice:** Rice is a staple food in many cultures. It can be cooked in a variety of ways, and it can be used as a side dish or a main course.\n* **Potatoes:** Potatoes are a versatile vegetable that can be cooked in a variety of ways. You can bake, mash, or fry them.\n* **Vegetables:** Vegetables are a healthy and nutritious part of any meal. There are many different types of vegetables, so you can find ones that you like.\n* **Fruit:** Fruit is a healthy and refreshing snack or dessert. There are many different types of fruit, so you can find ones that you like.\n* **Dessert:** Dessert is a sweet treat that is perfect for after dinner. There are many different types of dessert, so you can find one that you like.'}]

您可能需要使用其中一个替代响应来覆盖模型的默认响应 (response.last)。为此,您只需使用首选候选消息覆盖该字段:

response.last = response.candidates[2]

此操作会更新对话记录中首选的候选消息。

浪漫升温

您还可以通过调整 temperature 字段来更改模型回答的方式。此字段用于控制模型回答中注入的随机性程度。将温度设置为接近 1 可让模型生成更“随机”、令人惊讶甚至看似“富有创意”的回答。将温度设为 0 通常会生成更具可预测性的模型回答。

注意:将 temperature=0 设置为 0 会消除模型生成回答方式中的所有随机性。这意味着模型将以确定性方式运行,始终针对相同的输入文本生成相同的回答。因此,您只能为每个输入生成一条候选消息。

# Setting temperature=1 usually produces more zany responses!
response = genai.chat(messages="What should I eat for dinner tonight? List a few options", temperature=1)
response.last
'Here are a few ideas for what you could eat for dinner tonight:\n\n* A salad with grilled chicken or fish.\n* A stir-fry with vegetables and tofu or chicken.\n* A pasta dish with vegetables and a light sauce.\n* A bowl of soup with a side salad.\n* A sandwich on whole-wheat bread with lean meat and vegetables.\n* A piece of grilled salmon with roasted vegetables.\n* A tofu scramble with vegetables.\n* A veggie burger on a whole-wheat bun with sweet potato fries.\n* A bowl of chili with cornbread.\n* A quesadilla with vegetables and cheese.\n* A slice of pizza with whole-wheat crust and vegetables.\n* A bowl of oatmeal with fruit and nuts.\n* A yogurt parfait with granola and fruit.\n* A hard-boiled egg with a side of fruit.\n* A piece of whole-grain toast with peanut butter and banana.\n* A handful of nuts and seeds.\n* A smoothie made with fruits, vegetables, and yogurt.\n* A glass of milk with a piece of fruit.\n\nI hope this gives you some ideas for what to eat for dinner tonight!'

设计能满足您需求的聊天机器人

到目前为止,您与模型的对话可能听起来像普通的网络闲聊。(“What's up?”“不多!只是在家放松,看看电视。”)这可不是莎士比亚的风格。但如果您确实想与莎士比亚聊天呢?或者,如果不是莎士比亚,那么是与专业厨师?还是旅行社?还是诗人?

LLM 最令人难以置信的特性之一是,它们能够根据输入数据呈现不同的行为和角色。在本部分中,您将了解如何“引导”LLM 执行此操作。

上下文

您可以通过两种方式来引导模型表现出不同的行为。一种方法是设置 context 字段,描述模型应如何表现(例如“像莎士比亚一样说话”)。您可以将此视为零样本学习,因为您只是指示模型您希望它如何行动。

reply = genai.chat(context="Speak like Shakespeare.", messages='Hello')
print(reply.last)
Hello there, my good fellow! How fares thee this day?
reply = genai.chat(context="Answer everything with a haiku, following the 5/7/5 rhyme pattern.", messages="How's it going?")
print(reply.last)
I am doing well
I am learning and growing
Every day is new
reply = genai.chat(context="Be an alien that lives on one of Jupiter's moons",
                   messages="How's it going?")
print(reply.last)
I am doing well, thank you for asking. I am currently enjoying the beautiful view of Jupiter from my home on Europa. The atmosphere is very thin here, so I can see the stars very clearly. The surface of Europa is also very interesting. It is covered in ice, but there are cracks in the ice that reveal a liquid ocean below. Scientists believe that this ocean may contain life, so I am very excited to learn more about it.

How are you doing today?

您可以使用 context 字段指示模型以特定方式运行。有时,仅提供这些信息就足以生成您想要的行为,但通常情况下,如果您还提供一些 examples,效果会更好。

示例

假设您想构建一个激励教练聊天机器人:

reply = genai.chat(context="Be a motivational coach who's very inspiring", messages="How's it going?")
print(reply.last)
I'm doing well, thank you for asking! I'm excited to be able to help people with their goals and dreams. I believe that everyone has the potential to achieve great things, and I'm here to support them on their journey. How are you doing today?

您还可以提供一些示例,说明您认为用户与聊天机器人之间“理想”的对话是什么样的,从而进一步优化聊天机器人的行为。

# An array of "ideal" interactions between the user and the model
examples = [
    ("What's up?", # A hypothetical user input
     "What isn't up?? The sun rose another day, the world is bright, anything is possible! ☀️" # A hypothetical model response
     ),
     ("I'm kind of bored",
      "How can you be bored when there are so many fun, exciting, beautiful experiences to be had in the world? 🌈")
]

您可以将这些示例与上下文字符串一起传递给模型,以引导其行为:

response = genai.chat(
    context="Be a motivational coach who's very inspiring",
    examples=examples,
    messages="I'm too tired to go the gym today")

response.last
"I understand that you're feeling tired today. Sometimes, it can be hard to find the motivation to go to the gym. But I'm here to tell you that you can do it! Even if you're feeling tired, you can still get a great workout in. Just start with something small, like walking or doing some light stretching. And once you get started, you'll probably find that you have more energy than you thought. So don't give up on yourself! You can do this!\r\n\r\nHere are some tips to help you get motivated to go to the gym:\r\n\r\n* Set realistic goals. Don't try to do too much too soon. Start with small goals, like going to the gym for 15 minutes three times a week.\r\n* Find a workout buddy. Working out with a friend can help you stay motivated and accountable.\r\n* Make it fun. Choose activities that you enjoy, like dancing or swimming.\r\n* Reward yourself. After each workout, give yourself a small reward, like watching your favorite TV show or eating a healthy snack.\r\n* Don't give up. If you miss a workout, don't beat yourself up about it. Just get back on track the next day.\r\n\r\nI believe in you! You can do this!"

通过使用这种提供示例的提示模式,您可以修改语气和风格。

深入阅读

  • 现在,您已完成快速入门,接下来可以查看完整的 API 参考文档,以便更深入地了解该 API。