Delen via

Naslaginformatie over api's voor assistenten (preview)

  • Artikel

Notitie

  • Bestanden zoeken kan maximaal 10.000 bestanden per assistent opnemen - 500 keer meer dan voorheen. Het is snel, ondersteunt parallelle query's via zoekopdrachten met meerdere threads en biedt uitgebreide herrankering en herschrijven van query's.
    • Vectoropslag is een nieuw object in de API. Zodra een bestand is toegevoegd aan een vectoropslag, wordt het automatisch geparseerd, gesegmenteerd en ingesloten, zodat het kan worden doorzocht. Vectoropslag kunnen worden gebruikt voor assistenten en threads, waardoor bestandsbeheer en facturering worden vereenvoudigd.
  • We hebben ondersteuning toegevoegd voor de tool_choice parameter die kan worden gebruikt om het gebruik van een specifiek hulpprogramma (zoals het zoeken van bestanden, code-interpreter of een functie) in een bepaalde uitvoering af te dwingen.

Dit artikel bevat referentiedocumentatie voor Python en REST voor de nieuwe Assistants-API (preview). Meer uitgebreide stapsgewijze richtlijnen vindt u in de introductiehandleiding.

Een thread maken

POST https://YOUR_RESOURCE_NAME.openai.azure.com/openai/threads?api-version=2024-08-01-preview

Een thread maken.

Aanvraagbody

Name Type Vereist Beschrijving
messages matrix Optioneel Een lijst met berichten waarmee de thread moet worden gestart.
metadata map Optioneel Set van 16 sleutel-waardeparen die aan een object kunnen worden gekoppeld. Dit kan handig zijn voor het opslaan van aanvullende informatie over het object in een gestructureerde indeling. Sleutels mogen maximaal 64 tekens lang zijn en waarden mogen maximaal 512 tekens lang zijn.
tool_resources object Optioneel Een set resources die beschikbaar worden gesteld aan de hulpprogramma's van de assistent in deze thread. De resources zijn specifiek voor het type hulpprogramma. Voor het code_interpreter hulpprogramma is bijvoorbeeld een lijst met bestands-id's vereist, terwijl voor het file_search hulpprogramma een lijst met vectoropslag-id's is vereist.

tool_resources eigenschappen

code_interpreter

Name Type Description Standaard
file_ids matrix Een lijst met bestands-id's die beschikbaar worden gesteld aan het hulpprogramma code_interpreter. Er kunnen maximaal 20 bestanden aan het hulpprogramma zijn gekoppeld. []

file_search

Name Type Description Standaard
vector_store_ids matrix Het vectorarchief dat aan deze thread is gekoppeld. Er kan maximaal 1 vectoropslag aan de thread zijn gekoppeld. []
vector_stores matrix Een helper voor het maken van een vectorarchief met file_ids en deze aan deze thread koppelen. Er kan maximaal 1 vectoropslag aan de thread zijn gekoppeld. []

Retouren

Een threadobject.

Voorbeeld: threadaanvraag maken

from openai import AzureOpenAI
    
client = AzureOpenAI(
    api_key=os.getenv("AZURE_OPENAI_API_KEY"),  
    api_version="2024-08-01-preview",
    azure_endpoint = os.getenv("AZURE_OPENAI_ENDPOINT")
    )

empty_thread = client.beta.threads.create()
print(empty_thread)

Thread ophalen

GET https://YOUR_RESOURCE_NAME.openai.azure.com/openai/threads/{thread_id}?api-version=2024-08-01-preview

Hiermee wordt een thread opgehaald.

Padparameters

Parameter Type Vereist Beschrijving
thread_id tekenreeks Vereist De id van de thread die moet worden opgehaald

Retouren

Het threadobject dat overeenkomt met de opgegeven id.

Voorbeeld: threadaanvraag ophalen

from openai import AzureOpenAI
    
client = AzureOpenAI(
    api_key=os.getenv("AZURE_OPENAI_API_KEY"),  
    api_version="2024-08-01-preview",
    azure_endpoint = os.getenv("AZURE_OPENAI_ENDPOINT")
    )

my_thread = client.beta.threads.retrieve("thread_abc123")
print(my_thread)

Thread wijzigen

POST https://YOUR_RESOURCE_NAME.openai.azure.com/openai/threads/{thread_id}?api-version=2024-08-01-preview

Hiermee wijzigt u een thread.

Padparameters

Parameter Type Vereist Beschrijving
thread_id tekenreeks Vereist De id van de thread die moet worden gewijzigd.

Aanvraagbody

Name Type Vereist Beschrijving
metadata map Optioneel Set van 16 sleutel-waardeparen die aan een object kunnen worden gekoppeld. Dit kan handig zijn voor het opslaan van aanvullende informatie over het object in een gestructureerde indeling. Sleutels mogen maximaal 64 tekens lang zijn en waarden mogen maximaal 512 tekens lang zijn.
tool_resources object Optioneel Een set resources die beschikbaar worden gesteld aan de hulpprogramma's van de assistent in deze thread. De resources zijn specifiek voor het type hulpprogramma. Voor het code_interpreter hulpprogramma is bijvoorbeeld een lijst met bestands-id's vereist, terwijl voor het file_search hulpprogramma een lijst met vectoropslag-id's is vereist.

Retouren

Het gewijzigde threadobject dat overeenkomt met de opgegeven id.

Voorbeeld: threadaanvraag wijzigen

from openai import AzureOpenAI
    
client = AzureOpenAI(
    api_key=os.getenv("AZURE_OPENAI_API_KEY"),  
    api_version="2024-08-01-preview",
    azure_endpoint = os.getenv("AZURE_OPENAI_ENDPOINT")
    )

my_updated_thread = client.beta.threads.update(
  "thread_abc123",
  metadata={
    "modified": "true",
    "user": "abc123"
  }
)
print(my_updated_thread)

Thread verwijderen

DELETE https://YOUR_RESOURCE_NAME.openai.azure.com/openai/threads/{thread_id}?api-version=2024-05-01-preview

Een thread verwijderen.

Padparameters

Parameter Type Vereist Beschrijving
thread_id tekenreeks Vereist De id van de thread die moet worden verwijderd.

Retouren

Verwijderingsstatus.

Voorbeeld: threadaanvraag verwijderen

from openai import AzureOpenAI
    
client = AzureOpenAI(
    api_key=os.getenv("AZURE_OPENAI_API_KEY"),  
    api_version="2024-05-01-preview",
    azure_endpoint = os.getenv("AZURE_OPENAI_ENDPOINT")
    )

response = client.beta.threads.delete("thread_abc123")
print(response)

Thread-object

Veld Type Omschrijving
id tekenreeks De id waarnaar kan worden verwezen in API-eindpunten.
object tekenreeks Het objecttype, dat altijd thread is.
created_at geheel getal De Unix-tijdstempel (in seconden) voor het moment waarop de thread is gemaakt.
metadata map Set van 16 sleutel-waardeparen die aan een object kunnen worden gekoppeld. Dit kan handig zijn voor het opslaan van aanvullende informatie over het object in een gestructureerde indeling. Sleutels mogen maximaal 64 tekens lang zijn en waarden mogen maximaal 512 tekens lang zijn.