openai/README.md

ChatBot with OpenAI

author: Jael, Yuchen

Description

A chat-bot operator returns answer in text given input text. This operator is implemented with Completion method from OpenAI. Please note you need an OpenAI API key to access OpenAI.

Code Example

Use the default model to answer the question "Who are you?".

Write a pipeline with explicit inputs/outputs name specifications:

from towhee import pipe, ops, DataCollection

p = (
    pipe.input('question')
        .map('question', 'answer', 
             ops.chatbot.openai(api_key=OPENAI_API_KEY))
        .output('question', 'answer')
)

DataCollection(p('Who are you?')).show()

Factory Constructor

Create the operator via the following factory method:

chatbot.openai(model_name: str, api_key: str)

Parameters:

model_name: str

The model name in string, defaults to 'text-davinci-003'. Refer to OpenAI List Models for all supported model names.

api_key: str=None

The OpenAI API key in string, defaults to None.

Interface

The operator takes a piece of text in string as input. It returns a text answer.

__call__(txt)

Parameters:

text: str

​ The text in string.

Returns:

answer: str

​ The answer in string generated by model.

supported_model_names()

Get a list of supported model names.

More Resources

• OpenAI's ChatGPT - Zilliz blog: A guide to the new AI Stack - ChatGPT, your Vector Database, and Prompt as code
• Building Open Source Chatbots with LangChain and Milvus in 5m - Zilliz blog: A start-to-finish tutorial for RAG retrieval and question-answering chatbot on custom documents using Milvus, LangChain, and an open-source LLM.
• Exploring OpenAI CLIP: The Future of Multi-Modal AI Learning - Zilliz blog: Multimodal AI learning can get input and understand information from various modalities like text, images, and audio together, leading to a deeper understanding of the world. Learn more about OpenAI's CLIP (Contrastive Language-Image Pre-training), a popular multimodal model for text and image data.
• Building a Chatbot for Toward the Science with Zilliz Cloud (Part I) - Zilliz blog: Building a chatbot for the Towards Data Science publication using the Zilliz vector database
• OpenAI Whisper: Transforming Speech-to-Text with Advanced AI - Zilliz blog: Understand Open AI Whisper and follow this step-by-step article to implement it in projects that can significantly enhance the efficiency of speech-to-text tasks.
• How to Build an AI Chatbot with Milvus and Towhee - Zilliz blog: Learn how to build a simple chatbot with Python using Milvus and Towhee.