OpenAI Assistants API-tutorial

OpenAI Dev Day was een belangrijke mijlpaal voor kunstmatige intelligentie, met de onthulling van een reeks baanbrekende AI-diensten, waaronder GPTs, de GPTs App Store, GPT-4 Turbo en de innovatieve Assistants API.

Met deze API krijgen ontwikkelaars toegang tot geavanceerde AI-tools waarmee ze aangepaste AI-assistenten kunnen bouwen die bedreven zijn in uiteenlopende taken.

In deze tutorial duiken we in de wereld van Assistants. We verkennen hun mogelijkheden, bespreken praktische toepassingen in verschillende sectoren en geven een stapsgewijze handleiding voor implementatie met Python. Ga met ons mee terwijl we de fijne kneepjes doorlopen van het bouwen van je eigen persoonlijke AI-assistent.

Een overzicht van de Assistants API

Op het moment van schrijven is de Assistants API in bèta en werkt het OpenAI-ontwikkelingsteam actief aan extra functies. Laten we eerst bekijken wat de huidige versie al te bieden heeft!

In deze sectie krijg je meer inzicht in hoe Assistants werken en hoe de onderliggende componenten met elkaar samenwerken.

Hoe werkt de Assistants API?

De twee belangrijkste pijlers van Assistants zijn de modellen en tools van OpenAI.

• Er is een divers aanbod aan modellen, waaronder maar niet beperkt tot: GPT-4, GPT-4 Turbo, GPT-3.5, GPT-3, DALL-E, TTS, Whisper, Embeddings, Moderation. Deze modellen worden door Assistants gebruikt om een specifieke slimme taak uit te voeren.

• De tools geven Assistants toegang tot door OpenAI gehoste hulpmiddelen zoals Code Interpreter en Knowledge Retrieval. Je kunt zelfs je eigen tools bouwen met de functie Function Calling.

How Assistants work

Laten we nu de vijf belangrijkste stappen bekijken die komen kijken bij de implementatie van een Assistant.

• Maak en beschrijf een Assistant: een Assistant is een gespecialiseerde AI die is ontwikkeld met behulp van modellen, richtlijnen en diverse tools.
• Start een Thread: een thread is een door de gebruiker gestart dialoogtraject waarin berichten kunnen worden toegevoegd, waardoor een betrokken uitwisseling ontstaat.
• Voeg berichten toe: berichten bestaan uit de tekstuele input van de gebruiker en kunnen tekst, bestanden en afbeeldingen bevatten.
• Activeer de Assistant: de Assistant wordt geactiveerd om de Thread te analyseren, specifieke tools te gebruiken indien nodig en een passend antwoord te genereren.

Use-cases per sector voor de Assistants API

De Assistant API inzetten is een krachtige manier om AI in verschillende bedrijfsprocessen te integreren. Zo verhoog je de efficiëntie, automatiseer je saaie taken en geef je gebruikers sneller en nauwkeuriger antwoord op hun vragen.

Hieronder vind je vijf overtuigende use-cases per sector voor de Assistant API.

Ondersteuning voor development

De Assistant kan fungeren als een on-demand codeerassistent. Met de code interpreter kan hij codefragmenten van de ene programmeertaal naar de andere vertalen, wat helpt bij softwareontwikkeling en de leercurve voor nieuwe talen verkleint. Dit is vooral handig voor teams die met meerdere programmeertalen werken of in onderwijssettings voor het aanleren van programmeren.

Enterprise-kennisbeheer

De retrieval-functie kan worden ingezet voor kennisbeheer binnen organisaties. Door interne documenten, rapporten en handleidingen te uploaden en te verwerken, wordt de Assistant een gecentraliseerde kennisbank. Medewerkers kunnen de Assistant bevragen voor specifieke informatie, wat de efficiëntie verhoogt en de zoektijd in grote documentensets verkort.

Automatisering van klantenondersteuning

De Assistant kan worden geïntegreerd in systemen voor klantondersteuning. Met function calling kan hij klantvragen beantwoorden door informatie op te halen uit externe API’s of databases, waardoor antwoorden op veelgestelde vragen worden geautomatiseerd. Deze integratie verbetert de klantervaring met snelle, accurate reacties en verlaagt de werkdruk voor menselijke supportmedewerkers.

Data-analyse

Door functies voor data-analyse te beschrijven, kunnen gebruikers de Assistant vragen om complexe datatransformaties uit te voeren en rapporten te genereren, waarbij natuurlijke taalvragen worden vertaald naar gestructureerde analysetaken.

Automatisering van IT-operaties

IT-teams kunnen de Assistant inzetten om routinetaken te automatiseren. Door functies te definiëren die overeenkomen met veelvoorkomende IT-taken, zoals systeemdiagnoses, netwerkcontroles of software-updates, kan de Assistant deze taken uitvoeren op commando. Dit kan de tijd die IT-professionals aan onderhoud besteden aanzienlijk verminderen, zodat ze zich op complexere vraagstukken kunnen richten.

Hands-on: Aan de slag met de OpenAI Assistants API

Met dit begrip van de OpenAI API gaan we nu naar een praktischer use-case. In deze sectie begeleiden we je bij het maken van een assistant die kennis ophaalt uit PDF-bestanden.

De complete end-to-end-notebook is beschikbaar op DataLab.

Workflow voor knowledge retrieval

Voor elke technische implementatie is het beter om een visuele workflow te geven die de interactie tussen de hoofdcomponenten van de te ontwikkelen applicatie laat zien.

Deze workflow belicht de vijf belangrijkste stappen bij de implementatie van de assistant, van het uploaden van het bestand tot het genereren van het uiteindelijke antwoord.

Vijf belangrijkste stappen van de workflow voor knowledge retrieval

• Bestanden uploaden: het proces begint met het uploaden van de PDF-bestanden waarmee gebruikers willen werken.
• Assistant aanmaken: de assistant is specifiek ontworpen om de informatie uit de geüploade PDF-bestanden te verwerken en te begrijpen.
• Interactie starten: dit is het startpunt van de conversatiethread, waar gebruikers invoerberichten geven die door de assistant worden verwerkt.
• Assistant activeren: nu verwerkt de assistant de invoerberichten om een relevant antwoord te genereren.
• Antwoord tonen: in deze laatste fase toont de assistant de antwoorden op de berichten van de gebruikers.

Stel de OpenAI KEY in

De belangrijkste tools die je nodig hebt om de resultaten van deze tutorial te reproduceren, zijn:

• Python: dit is de belangrijkste programmeertaal die we in deze tutorial gebruiken. Een alternatief is NodeJS.
• OpenAI: het pakket om met OpenAI-diensten te werken. Onze OpenAI API in Python-cheatsheet geeft een compleet overzicht om de basis van de OpenAI API onder de knie te krijgen.
• OS: het operating system-pakket om de omgevingsvariabele te configureren.

De eerste stap is het verkrijgen van de OpenAI KEY, die helpt bij het toegang krijgen tot het DALL-E 3-model. De belangrijkste stappen staan hieronder weergegeven:

Vier belangrijkste stappen om een OpenAI KEY te maken

De vier bovenstaande stappen spreken voor zich. Het is echter belangrijk om een account aan te maken via de officiële OpenAI-website.

Je kunt de OpenAI API verder verkennen met onze Beginner’s Guide to The OpenAI API: Hands-On Tutorial and Best Practices. Deze gids introduceert de OpenAI API, de use-cases, een hands-on aanpak voor het gebruik van de API en alle best practices om te volgen.

Begin met het bouwen van de assistant

Zodra je de KEY hebt, deel hem met niemand. De key moet privé blijven. Stel vervolgens de key in als omgevingsvariabele zoals hieronder, zodat je ermee kunt werken:

import os
OPENAI_API_KEY= "<YOUR PRIVATE KEY>"
os.environ["OPENAI_API_KEY"] = OPENAI_API_KEY

Bestand uploaden

De volgende helperfunctie gebruikt de functie “create” om automatisch het bestand te uploaden waarmee gebruikers willen werken naar hun OpenAI-account.

De functie “create” heeft twee hoofdparameters:

• Het pad naar het te uploaden bestand
• Het doel van het gebruik van dat bestand, in dit geval “assistants”

def upload_file(file_path):
    
	# Upload a file with an "assistants" purpose
	file_to_upload = client.files.create(
  	file=open(file_path, "rb"),
  	purpose='assistants'
	)
     return file_to_upload

Met de helperfunctie starten we uiteindelijk het uploadproces van het transformer-paper in de map data.

transformer_paper_path = "./data/transformer_paper.pdf"
file_to_upload = upload_file(transformer_paper_path)

Na succesvolle uitvoering van de functie is transformer_paper.pdf geüpload en zichtbaar op het tabblad Files, zoals hieronder weergegeven.

Transformer-paper geüpload naar het OpenAI-account

Assistant aanmaken

Het aanmaken van de assistant gebeurt met de functie create uit de module client.beta.assistants, en gebruikt vijf hoofdparameters:

• Naam: de naam die de maker aan de assistant geeft. Laten we die van ons Scientific Paper Assistant noemen.
• Instructies: beschrijft hoe de assistant zich moet gedragen of vragen moet beantwoorden. In deze use-case gebruikt de assistant de volgende instructie: “You are a polite and expert knowledge retrieval assistant. Use the documents provided as a knowledge base to answer questions.”
• Model: het onderliggende model voor knowledge retrieval. Je kunt elk GPT-3- of GPT-4-model gebruiken. Dit artikel gebruikt het nieuwste model op het moment van schrijven: gpt-4-1106-preview.
• Tools: het type tool dat wordt gebruikt. De twee mogelijke keuzes zijn code interpreter en retrieval. We focussen in dit artikel op retrieval en laten de interpreter buiten beschouwing.
• File_ids: een lijst met unieke identifiers van elk bestand in de kennisbank.

De helperfunctie create_assistant combineert al deze informatie om de assistant te maken, zoals hieronder geïllustreerd:

def create_assistant(assistant_name,
                 	my_instruction,
                 	uploaded_file,
                 	model="gpt-4-1106-preview"):
    
	my_assistant = client.beta.assistants.create(
	name = assistant_name,
	instructions = my_instruction,
	model="gpt-4-1106-preview",
	tools=[{"type": "retrieval"}],
	file_ids=[uploaded_file.id]
	)
    
	return my_assistant

Nu kunnen we de functie uitvoeren om de assistant te maken met de instructie en de naam:

inst="You are a polite and expert knowledge retrieval assistant. Use the documents provided as a knowledge base to answer questions"
assistant_name="Scientific Paper Assistant"

my_assistant = create_assistant(assistant_name, inst, uploaded_file)

Interactie starten

Zodra de assistant is aangemaakt, is de logische volgende stap het starten van een interactiethread met het bericht of verzoek van de gebruiker.

De thread en het bericht worden gemaakt met de functies create uit respectievelijk client.beta.threads en client.beta.threads.messages.

Deze twee onderdelen zijn gecombineerd in de helperfunctie initiate_interaction.

def initiate_interaction(user_message, uploaded_file):
    
	my_thread = client.beta.threads.create()
	message = client.beta.threads.messages.create(thread_id=my_thread.id,
                                              	role="user",
                                              	content=user_message,
                                              	file_ids=[uploaded_file.id]
	)
    
	return my_thread

Een interactie kan worden gestart met de variabele user_message:

user_message = "Why do authors use the self-attention strategy in the paper?"
my_thread = initiate_interaction(user_message, uploaded_file)

Activeer de assistant en genereer een antwoord

Vanuit de bovenstaande thread kan de assistant worden geactiveerd om te reageren op het bericht van de gebruiker. De triggeractie is gedefinieerd in de helperfunctie trigger_assistant en het antwoord wordt gegeven door de variabele response.

def trigger_assistant():
	run = client.beta.threads.runs.create(
  	thread_id = my_thread.id,
  	assistant_id = my_assistant.id,
	)


trigger_assistant()

messages = client.beta.threads.messages.list(
  thread_id = my_thread.id
)

response = messages.data[0].content[0].text.value
response

Na succesvolle uitvoering van de bovenstaande code wordt het volgende antwoord gegenereerd.

Antwoord van de assistant op het bericht van de gebruiker

Dit antwoord komt precies overeen met wat de auteurs noemen als antwoord op de vraag op pagina 6.

Passage waarin het antwoord uit het transformer-paper wordt genoemd

Best practices voor het gebruik van de OpenAI Assistants API

Als je de Assistant API in een project inzet, is het belangrijk om best practices te volgen om optimale prestaties en een goede gebruikerservaring te garanderen. Hieronder staan enkele belangrijke aandachtspunten.

• Formuleer duidelijke doelen: stel specifieke doelen voor de Assistant om ervoor te zorgen dat die effectief aan het beoogde doel en de behoeften van gebruikers voldoet.

• Optimaliseer de data-invoer: de kwaliteit en relevantie van de gebruikte data, zoals geüploade bestanden, zijn cruciaal voor de nauwkeurigheid en efficiëntie van de reacties van de Assistant.

• Geef prioriteit aan privacy: implementeer robuuste protocollen voor gegevensbescherming om gebruikersinformatie te beveiligen en te voldoen aan relevante privacywetgeving.

• Test en iteratief verbeteren: test de Assistant regelmatig in praktijksituaties en verbeter op basis van feedback om prestaties en gebruikerservaring te verhogen.

• Bied duidelijke documentatie: geef uitgebreide richtlijnen voor het gebruik van de Assistant, zodat gebruikers de functionaliteiten en beperkingen begrijpen.


Conclusie

Samengevat hebben we in dit artikel de Assistants API verkend: hoe die werkt en hoe je hem in verschillende sectoren kunt gebruiken. We zijn begonnen met een introductie van de API en de belangrijkste functies, als basis voor een dieper begrip.

Vervolgens hebben we de specifieke kenmerken van de Assistants API bekeken en besproken hoe je die in diverse bedrijfssectoren kunt toepassen, wat de brede bruikbaarheid laat zien.

We gaven ook een stapsgewijze handleiding om met de Assistants API aan de slag te gaan, zodat je hem makkelijker kunt instellen voor jouw behoeften.

Daarnaast deelden we enkele belangrijke best practices om in gedachten te houden bij het gebruik van de API, zodat je er het maximale uit haalt.

Kortom, de Assistants API is een veelzijdige en waardevolle tool die voor veel doeleinden kan worden ingezet en aanzienlijke voordelen biedt voor wie leert er effectief mee te werken.

Ben je klaar om je ervaring met de API’s van OpenAI te verbeteren en een creatievere aanpak te omarmen? Onze Complete gids voor de DALL-E 3 API helpt je de transformerende kracht van de DALL-E 3 API te ontdekken, met de belangrijkste functies, toepassingen per sector en tips om je creatieve potentieel te ontsluiten.

Ben je compleet nieuw in dit onderwerp? Begin dan met onze cursus Working with the OpenAI API.