Search icon CANCEL
Subscription
0
Cart icon
Your Cart (0 item)
Close icon
You have no products in your basket yet
Save more on your purchases now! discount-offer-chevron-icon
Savings automatically calculated. No voucher code required.
Arrow left icon
Explore Products
Best Sellers
New Releases
Books
Videos
Audiobooks
Learning Hub
Conferences
Free Learning
Arrow right icon
OpenAI API Cookbook
OpenAI API Cookbook

OpenAI API Cookbook: Build intelligent applications including chatbots, virtual assistants, and content generators

eBook
€15.99 €23.99
Paperback
€20.98 €29.99
Subscription
Free Trial
Renews at €18.99p/m

What do you get with Print?

Product feature icon Instant access to your digital eBook copy whilst your Print order is Shipped
Product feature icon Colour book shipped to your preferred address
Product feature icon Download this book in EPUB and PDF formats
Product feature icon Access this title in our online reader with advanced features
Product feature icon DRM FREE - Read whenever, wherever and however you want
Product feature icon AI Assistant (beta) to help accelerate your learning
Table of content icon View table of contents Preview book icon Preview Book

OpenAI API Cookbook

OpenAI API Endpoints Explained

The OpenAI API is not just one endpoint, but instead a collection of different endpoints that can be used to generate text completions, images, and even transcribe audio. In this chapter, we dive into all these use cases covering the main endpoints that are used by developers when integrating the OpenAI API into their applications. By the end of this chapter, you will know how to use the diverse capabilities of the OpenAI API, the first step in building intelligent applications. You’ll understand the nuances of each endpoint, ensuring that you can tailor your integration to your specific needs. Whether you’re aiming to create dynamic text content, generate captivating visuals, or transcribe audio, you will learn how to accomplish these tasks all using the API.

Specifically, we will cover the following recipes in this chapter:

  • Generating customized responses using the Chat Completions endpoint
  • Creating pictures using the Images...

Technical requirements

This chapter requires you to have access to the OpenAI API (via a generated API key) and have an API client installed, such as Postman. You can refer to the Making OpenAI API requests with Postman recipe in Chapter 1 for more information on how to obtain your API key and set up Postman.

Generating customized responses using the Chat Completions endpoint

We previously explored the Chat Completions endpoint at the end of Chapter 1, but our request body was fairly simple and did not make use of the important parameters that we also discussed in the Running a completion request in the OpenAI Playground recipe. For example, we learned how the Chat Log could be used to fine-tune the responses that are generated. Additionally, the Chat Log feature can be used to deploy a chat bot inside your application.

In this recipe, we will cover how to generate responses using the Chat Completions endpoint while using the Chat Log parameters.

Getting ready

Ensure you have an OpenAI Platform account with available usage credits. If you don’t, please follow the Setting up your OpenAI Playground environment recipe in Chapter 1.

Furthermore, ensure you have Postman installed, you have created a new workspace, you have created a new HTTP request, and that the Headers for...

Creating pictures using the Images endpoint

The OpenAI API can do more than generate text (although that is its main purpose); it can also create images. It does this with a similar methodology to text generation, but instead of predicting characters, it predicts pixels. The inner workings of the model are complex (it involves the use of encoders, decoders, and embeddings), but that doesn’t stop us from actually using the model.

This significantly opens up the types of applications you can create with the OpenAI API. For example, you can create an application that produces stock images based on a user prompt. In this recipe, we will use the OpenAI API to generate several types of images.

How to do it…

  1. In Postman, create a new request by selecting the New button on the top-left menu bar, and then select HTTP.
  2. Change the HTTP request type from GET to POST in the Method drop-down menu (by default, it will be set to GET).
  3. Enter the following URL as the...

Generating transcripts using the Audio endpoint

In this recipe, we will learn how to use the OpenAI API’s Audio endpoint, which converts audio into text. This enables developers to create voice applications, such as voice agents and speech conversational bots.

Getting ready

This recipe will also use Postman, but the typical set of Headers that we use will need to be modified so that the HTTP client uses form data instead of typical JSON. In addition, we must have a sample audio file that we can use as an example to convert speech to text. Form data is a way to encode and send data as key-value pairs in HTTP requests instead of JSON-formatted strings. Form data is often used for uploading files.

After opening a new request in Postman, navigate to the Headers menu and delete the Content-Type application/json entry. This will force Postman to default to the Content-Type of the request based on what is passed in the request Body.

Next, we need an audio file. Any short...

Left arrow icon Right arrow icon
Download code icon Download Code

Key benefits

  • Understand the different elements, endpoints, and parameters of the OpenAI API
  • Build tailored intelligent applications and workflows with the OpenAI API
  • Create versatile assistants with for a multitude of tasks
  • Purchase of the print or Kindle book includes a free PDF eBook

Description

As artificial intelligence continues to reshape industries with OpenAI at the forefront of AI research, knowing how to create innovative applications such as chatbots, virtual assistants, content generators, and productivity enhancers is a game-changer. This book takes a practical, recipe-based approach to unlocking the power of OpenAI API to build high-performance intelligent applications in diverse industries and seamlessly integrate ChatGPT in your workflows to increase productivity. You’ll begin with the OpenAI API fundamentals, covering setup, authentication, and key parameters, and quickly progress to the different elements of the OpenAI API. Once you’ve learned how to use it effectively and tweak parameters for better results, you’ll follow advanced recipes for enhancing user experience and refining outputs. The book guides your transition from development to live application deployment, setting up the API for public use and application backend. Further, you’ll discover step-by-step recipes for building knowledge-based assistants and multi-model applications tailored to your specific needs. By the end of this book, you’ll have worked through recipes involving various OpenAI API endpoints and built a variety of intelligent applications, ready to apply this experience to building AI-powered solutions of your own.

Who is this book for?

This book is perfect for developers, data scientists, AI/tech enthusiasts, citizen developers, and no-code aficionados keen on using and mastering the OpenAI API. Whether you’re a beginner or experienced professional, this book is ideal for quickly creating intelligent applications such as chatbots or content generators, through step-by-step recipes that take you from the basics of the API to creating sophisticated applications systematically. The OpenAI API is accessed with Python in this book, so familiarity with Python and APIs is preferred but not mandatory.

What you will learn

  • Grasp the fundamentals of the OpenAI API
  • Navigate the API's capabilities and limitations of the API
  • Set up the OpenAI API with step-by-step instructions, from obtaining your API key to making your first call
  • Explore advanced features such as system messages, fine-tuning, and the effects of different parameters
  • Integrate the OpenAI API into existing applications and workflows to enhance their functionality with AI
  • Design and build applications that fully harness the power of ChatGPT
Estimated delivery fee Deliver to Slovenia

Premium delivery 7 - 10 business days

€25.95
(Includes tracking information)

Product Details

Country selected
Publication date, Length, Edition, Language, ISBN-13
Publication date : Mar 12, 2024
Length: 192 pages
Edition : 1st
Language : English
ISBN-13 : 9781805121350
Vendor :
OpenAI
Category :
Concepts :
Tools :

What do you get with Print?

Product feature icon Instant access to your digital eBook copy whilst your Print order is Shipped
Product feature icon Colour book shipped to your preferred address
Product feature icon Download this book in EPUB and PDF formats
Product feature icon Access this title in our online reader with advanced features
Product feature icon DRM FREE - Read whenever, wherever and however you want
Product feature icon AI Assistant (beta) to help accelerate your learning
Estimated delivery fee Deliver to Slovenia

Premium delivery 7 - 10 business days

€25.95
(Includes tracking information)

Product Details

Publication date : Mar 12, 2024
Length: 192 pages
Edition : 1st
Language : English
ISBN-13 : 9781805121350
Vendor :
OpenAI
Category :
Concepts :
Tools :

Packt Subscriptions

See our plans and pricing
Modal Close icon
€18.99 billed monthly
Feature tick icon Unlimited access to Packt's library of 7,000+ practical books and videos
Feature tick icon Constantly refreshed with 50+ new titles a month
Feature tick icon Exclusive Early access to books as they're written
Feature tick icon Solve problems while you work with advanced search and reference features
Feature tick icon Offline reading on the mobile app
Feature tick icon Simple pricing, no contract
€189.99 billed annually
Feature tick icon Unlimited access to Packt's library of 7,000+ practical books and videos
Feature tick icon Constantly refreshed with 50+ new titles a month
Feature tick icon Exclusive Early access to books as they're written
Feature tick icon Solve problems while you work with advanced search and reference features
Feature tick icon Offline reading on the mobile app
Feature tick icon Choose a DRM-free eBook or Video every month to keep
Feature tick icon PLUS own as many other DRM-free eBooks or Videos as you like for just €5 each
Feature tick icon Exclusive print discounts
€264.99 billed in 18 months
Feature tick icon Unlimited access to Packt's library of 7,000+ practical books and videos
Feature tick icon Constantly refreshed with 50+ new titles a month
Feature tick icon Exclusive Early access to books as they're written
Feature tick icon Solve problems while you work with advanced search and reference features
Feature tick icon Offline reading on the mobile app
Feature tick icon Choose a DRM-free eBook or Video every month to keep
Feature tick icon PLUS own as many other DRM-free eBooks or Videos as you like for just €5 each
Feature tick icon Exclusive print discounts

Frequently bought together


Stars icon
Total 77.96 112.97 35.01 saved
OpenAI API Cookbook
€20.98 €29.99
Building LLM Powered  Applications
€25.99 €37.99
Solutions Architect's Handbook
€30.99 €44.99
Total 77.96 112.97 35.01 saved Stars icon

Table of Contents

9 Chapters
Chapter 1: Unlocking OpenAI and Setting Up Your API Playground Environment Chevron down icon Chevron up icon
Chapter 2: OpenAI API Endpoints Explained Chevron down icon Chevron up icon
Chapter 3: Understanding Key Parameters and Their Impact on Generated Responses Chevron down icon Chevron up icon
Chapter 4: Incorporating Additional Features from the OpenAI API Chevron down icon Chevron up icon
Chapter 5: Staging the OpenAI API for Application Development Chevron down icon Chevron up icon
Chapter 6: Building Intelligent Applications with the OpenAI API Chevron down icon Chevron up icon
Chapter 7: Building Assistants with the OpenAI API Chevron down icon Chevron up icon
Index Chevron down icon Chevron up icon
Other Books You May Enjoy Chevron down icon Chevron up icon

Customer reviews

Most Recent
Rating distribution
Full star icon Full star icon Full star icon Full star icon Half star icon 4.8
(16 Ratings)
5 star 81.3%
4 star 18.8%
3 star 0%
2 star 0%
1 star 0%
Filter icon Filter
Most Recent

Filter reviews by




S.Kundu Sep 26, 2024
Full star icon Full star icon Full star icon Full star icon Full star icon 5
"𝐎𝐩𝐞𝐧𝐀𝐈 𝐀𝐏𝐈 𝐂𝐨𝐨𝐤𝐛𝐨𝐨𝐤" assists developers by providing clear guidance on setting up and utilizing the OpenAI API. It explains key endpoints and parameters, demonstrates advanced features, and offers practical examples for building intelligent applications and conversational agents, ultimately helping developers create effective and innovative AI solutions.Few points that I want to highlight are as below:The book begins by setting up the environment for using the OpenAI API and introduces the API playground.It then explores various API endpoints, such as those for image and audio processing and explains their specific functions.Next, the book delves into key parameters, including the model and temperature settings and discusses their impact on API responses.Following this, advanced features and functionalities of the API are covered, including using embedding models for text comparison and fine-tuning completion models.The book provides guidance on integrating the API into application development and managing different development environments.It then focuses on creating intelligent applications with the API, such as a wrapper application for generating email replies and a multimodal application for generating travel itineraries.The final section is dedicated to building conversational assistants using the OpenAI API.
Amazon Verified review Amazon
Subhasish Ghosh Aug 28, 2024
Full star icon Full star icon Full star icon Full star icon Full star icon 5
*Reading Reco*: This weekend, completed perusing "𝑶𝒑𝒆𝒏𝑨𝑰 𝑨𝑷𝑰 𝑪𝒐𝒐𝒌𝒃𝒐𝒐𝒌 - 𝑩𝒖𝒊𝒍𝒅 𝒊𝒏𝒕𝒆𝒍𝒍𝒊𝒈𝒆𝒏𝒕 𝒂𝒑𝒑𝒍𝒊𝒄𝒂𝒕𝒊𝒐𝒏𝒔 𝒊𝒏𝒄𝒍𝒖𝒅𝒊𝒏𝒈 𝒄𝒉𝒂𝒕𝒃𝒐𝒕𝒔, 𝒗𝒊𝒓𝒕𝒖𝒂𝒍 𝒂𝒔𝒔𝒊𝒔𝒕𝒂𝒏𝒕𝒔, 𝒂𝒏𝒅 𝒄𝒐𝒏𝒕𝒆𝒏𝒕 𝒈𝒆𝒏𝒆𝒓𝒂𝒕𝒐𝒓𝒔", authored by Henry Habib, Packt Publications. An excellent read, this book is a must-have / read for those specifically looking to deep-dive into OpenAI LLM APIs and building LLM-based applications.✌️𝐓𝐚𝐫𝐠𝐞𝐭 𝐚𝐮𝐝𝐢𝐞𝐧𝐜𝐞: Aspiring Cloud Architects, Data Analysts, Cloud Developers, Data Scientists, AI Researchers, Tech Business Leaders, and Tech Evangelists.✅ 5 things that makes this book an excellent read:1️⃣ Each chapter builds from basics, with recipes (working examples) that you can follow to get started, up and running in no time at all. I checked out all the examples using Postman, Bubble, Google Colab (for Notebooks), the Serverless functions - which are in Google Cloud, but you could use Azure or AWS for executing the same.2️⃣ Get started with the essentials of how to leverage Postman for using OpenAI APIs. It is assumed you have access to either an OpenAI or in my case, Azure OpenAI LLM/SLM to test the exercises.3️⃣ The Chapter on using the Python Library to call OpenAI API, fine-tuning a completion model is excellent.4️⃣ The Chapter which covers creating a public endpoint server that calls the OpenAI API, extending the endpoint server to accept parameters and return data, and finally calling the user-created endpoint from no-code application is a good read.5️⃣ The Chapter 6 & 7 are excellent in terms of providing a step-by-step guidance on building real-life applications. You learn hands-on on creating a travel itinerary (multi-modal) application where a user can type in any location and the application creates a 1-day itinerary specific to that location, along with AI-generated photos that correspond to that itinerary. Works with an integration of Google Functions (serverless code acting as Backend server) + Postman (API test) + Bubble (front-end) + API Connector (integration between front-end & back-end).Overall, this is an excellent book - short, but powerful.
Amazon Verified review Amazon
Robodoc Aug 11, 2024
Full star icon Full star icon Full star icon Full star icon Full star icon 5
My interest is robotics with a side interest in AI. I turned to the OpenAI Cookbook to see how my robot might be able to make use of the wealth of AI out there. Although I'm only part way through, I can already see the possibilities. Raj lays out very clear "recipes" with the necessary ingredients and procedures to achieve the goal. There's no jargon or special knowlege needed. Anybody who can surf the net can follow this book to great advantage. Like all rapidly changing technology, web sites like Chat Playground or Postman used in the book may have a slightly different appearance or procedure than described in the book but it's easy enough to figure out. Personal API keys have been replaced by Project keys, an easy transition.
Amazon Verified review Amazon
Michael W. Jul 24, 2024
Full star icon Full star icon Full star icon Full star icon Full star icon 5
I've only gone through half of the book so far, but I found this to be an excellent resource. It quickly got me up writing real code, doing useful things. I look forward to going through the last half of the book.
Amazon Verified review Amazon
Thomas Jul 23, 2024
Full star icon Full star icon Full star icon Full star icon Full star icon 5
For individuals commencing their inaugural exploration of the OpenAI API, Habib’s OpenAI Cookbook stands as an indispensable guide. It offers a robust foundation for those seeking to harness OpenAI’s technologies in AI-driven endeavors. The cookbook’s clear and concise instructions ensure an accelerated learning trajectory for neophytes, rendering it especially advantageous for those aspiring to develop their inaugural generative AI application utilizing the API.
Amazon Verified review Amazon
Get free access to Packt library with over 7500+ books and video courses for 7 days!
Start Free Trial

FAQs

What is the delivery time and cost of print book? Chevron down icon Chevron up icon

Shipping Details

USA:

'

Economy: Delivery to most addresses in the US within 10-15 business days

Premium: Trackable Delivery to most addresses in the US within 3-8 business days

UK:

Economy: Delivery to most addresses in the U.K. within 7-9 business days.
Shipments are not trackable

Premium: Trackable delivery to most addresses in the U.K. within 3-4 business days!
Add one extra business day for deliveries to Northern Ireland and Scottish Highlands and islands

EU:

Premium: Trackable delivery to most EU destinations within 4-9 business days.

Australia:

Economy: Can deliver to P. O. Boxes and private residences.
Trackable service with delivery to addresses in Australia only.
Delivery time ranges from 7-9 business days for VIC and 8-10 business days for Interstate metro
Delivery time is up to 15 business days for remote areas of WA, NT & QLD.

Premium: Delivery to addresses in Australia only
Trackable delivery to most P. O. Boxes and private residences in Australia within 4-5 days based on the distance to a destination following dispatch.

India:

Premium: Delivery to most Indian addresses within 5-6 business days

Rest of the World:

Premium: Countries in the American continent: Trackable delivery to most countries within 4-7 business days

Asia:

Premium: Delivery to most Asian addresses within 5-9 business days

Disclaimer:
All orders received before 5 PM U.K time would start printing from the next business day. So the estimated delivery times start from the next day as well. Orders received after 5 PM U.K time (in our internal systems) on a business day or anytime on the weekend will begin printing the second to next business day. For example, an order placed at 11 AM today will begin printing tomorrow, whereas an order placed at 9 PM tonight will begin printing the day after tomorrow.


Unfortunately, due to several restrictions, we are unable to ship to the following countries:

  1. Afghanistan
  2. American Samoa
  3. Belarus
  4. Brunei Darussalam
  5. Central African Republic
  6. The Democratic Republic of Congo
  7. Eritrea
  8. Guinea-bissau
  9. Iran
  10. Lebanon
  11. Libiya Arab Jamahriya
  12. Somalia
  13. Sudan
  14. Russian Federation
  15. Syrian Arab Republic
  16. Ukraine
  17. Venezuela
What is custom duty/charge? Chevron down icon Chevron up icon

Customs duty are charges levied on goods when they cross international borders. It is a tax that is imposed on imported goods. These duties are charged by special authorities and bodies created by local governments and are meant to protect local industries, economies, and businesses.

Do I have to pay customs charges for the print book order? Chevron down icon Chevron up icon

The orders shipped to the countries that are listed under EU27 will not bear custom charges. They are paid by Packt as part of the order.

List of EU27 countries: www.gov.uk/eu-eea:

A custom duty or localized taxes may be applicable on the shipment and would be charged by the recipient country outside of the EU27 which should be paid by the customer and these duties are not included in the shipping charges been charged on the order.

How do I know my custom duty charges? Chevron down icon Chevron up icon

The amount of duty payable varies greatly depending on the imported goods, the country of origin and several other factors like the total invoice amount or dimensions like weight, and other such criteria applicable in your country.

For example:

  • If you live in Mexico, and the declared value of your ordered items is over $ 50, for you to receive a package, you will have to pay additional import tax of 19% which will be $ 9.50 to the courier service.
  • Whereas if you live in Turkey, and the declared value of your ordered items is over € 22, for you to receive a package, you will have to pay additional import tax of 18% which will be € 3.96 to the courier service.
How can I cancel my order? Chevron down icon Chevron up icon

Cancellation Policy for Published Printed Books:

You can cancel any order within 1 hour of placing the order. Simply contact customercare@packt.com with your order details or payment transaction id. If your order has already started the shipment process, we will do our best to stop it. However, if it is already on the way to you then when you receive it, you can contact us at customercare@packt.com using the returns and refund process.

Please understand that Packt Publishing cannot provide refunds or cancel any order except for the cases described in our Return Policy (i.e. Packt Publishing agrees to replace your printed book because it arrives damaged or material defect in book), Packt Publishing will not accept returns.

What is your returns and refunds policy? Chevron down icon Chevron up icon

Return Policy:

We want you to be happy with your purchase from Packtpub.com. We will not hassle you with returning print books to us. If the print book you receive from us is incorrect, damaged, doesn't work or is unacceptably late, please contact Customer Relations Team on customercare@packt.com with the order number and issue details as explained below:

  1. If you ordered (eBook, Video or Print Book) incorrectly or accidentally, please contact Customer Relations Team on customercare@packt.com within one hour of placing the order and we will replace/refund you the item cost.
  2. Sadly, if your eBook or Video file is faulty or a fault occurs during the eBook or Video being made available to you, i.e. during download then you should contact Customer Relations Team within 14 days of purchase on customercare@packt.com who will be able to resolve this issue for you.
  3. You will have a choice of replacement or refund of the problem items.(damaged, defective or incorrect)
  4. Once Customer Care Team confirms that you will be refunded, you should receive the refund within 10 to 12 working days.
  5. If you are only requesting a refund of one book from a multiple order, then we will refund you the appropriate single item.
  6. Where the items were shipped under a free shipping offer, there will be no shipping costs to refund.

On the off chance your printed book arrives damaged, with book material defect, contact our Customer Relation Team on customercare@packt.com within 14 days of receipt of the book with appropriate evidence of damage and we will work with you to secure a replacement copy, if necessary. Please note that each printed book you order from us is individually made by Packt's professional book-printing partner which is on a print-on-demand basis.

What tax is charged? Chevron down icon Chevron up icon

Currently, no tax is charged on the purchase of any print book (subject to change based on the laws and regulations). A localized VAT fee is charged only to our European and UK customers on eBooks, Video and subscriptions that they buy. GST is charged to Indian customers for eBooks and video purchases.

What payment methods can I use? Chevron down icon Chevron up icon

You can pay with the following card types:

  1. Visa Debit
  2. Visa Credit
  3. MasterCard
  4. PayPal
What is the delivery time and cost of print books? Chevron down icon Chevron up icon

Shipping Details

USA:

'

Economy: Delivery to most addresses in the US within 10-15 business days

Premium: Trackable Delivery to most addresses in the US within 3-8 business days

UK:

Economy: Delivery to most addresses in the U.K. within 7-9 business days.
Shipments are not trackable

Premium: Trackable delivery to most addresses in the U.K. within 3-4 business days!
Add one extra business day for deliveries to Northern Ireland and Scottish Highlands and islands

EU:

Premium: Trackable delivery to most EU destinations within 4-9 business days.

Australia:

Economy: Can deliver to P. O. Boxes and private residences.
Trackable service with delivery to addresses in Australia only.
Delivery time ranges from 7-9 business days for VIC and 8-10 business days for Interstate metro
Delivery time is up to 15 business days for remote areas of WA, NT & QLD.

Premium: Delivery to addresses in Australia only
Trackable delivery to most P. O. Boxes and private residences in Australia within 4-5 days based on the distance to a destination following dispatch.

India:

Premium: Delivery to most Indian addresses within 5-6 business days

Rest of the World:

Premium: Countries in the American continent: Trackable delivery to most countries within 4-7 business days

Asia:

Premium: Delivery to most Asian addresses within 5-9 business days

Disclaimer:
All orders received before 5 PM U.K time would start printing from the next business day. So the estimated delivery times start from the next day as well. Orders received after 5 PM U.K time (in our internal systems) on a business day or anytime on the weekend will begin printing the second to next business day. For example, an order placed at 11 AM today will begin printing tomorrow, whereas an order placed at 9 PM tonight will begin printing the day after tomorrow.


Unfortunately, due to several restrictions, we are unable to ship to the following countries:

  1. Afghanistan
  2. American Samoa
  3. Belarus
  4. Brunei Darussalam
  5. Central African Republic
  6. The Democratic Republic of Congo
  7. Eritrea
  8. Guinea-bissau
  9. Iran
  10. Lebanon
  11. Libiya Arab Jamahriya
  12. Somalia
  13. Sudan
  14. Russian Federation
  15. Syrian Arab Republic
  16. Ukraine
  17. Venezuela