Naslaginformatie over assistenten-API-berichten (preview)

Artikel
09/27/2024

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.

Bericht maken

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

Maak een bericht.

Padparameter

Parameter	Type	Vereist	Beschrijving
`thread_id`	tekenreeks	Vereist	De id van de thread waarvoor u een bericht wilt maken.

Aanvraagbody

Name	Type	Vereist	Beschrijving
`role`	tekenreeks	Vereist	De rol van de entiteit die het bericht maakt. Deze waarde kan `user` of `assistant` zijn. `user` geeft aan dat het bericht wordt verzonden door een werkelijke gebruiker en in de meeste gevallen moet worden gebruikt om door de gebruiker gegenereerde berichten weer te geven. `assistant` geeft aan dat het bericht wordt gegenereerd door de assistent. Gebruik deze waarde om berichten van de assistent in te voegen in het gesprek.
`content`	tekenreeks	Vereist	De inhoud van het bericht.
`attachments`	matrix	Optioneel	Een lijst met bestanden die zijn toegevoegd aan het bericht en de hulpmiddelen waaraan ze moeten worden toegevoegd.
`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.

Retouren

Een berichtobject .

Voorbeeld van het maken van een berichtaanvraag

Python 1.x
REST

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")
    )

thread_message = client.beta.threads.messages.create(
  "thread_abc123",
  role="user",
  content="How does AI work? Explain it in simple terms.",
)
print(thread_message)

curl https://YOUR_RESOURCE_NAME.openai.azure.com/openai/threads/{thread_id}/messages?api-version=2024-08-01-preview \
  -H "api-key: $AZURE_OPENAI_API_KEY" \
  -H 'Content-Type: application/json' \
  -d '{
      "role": "user",
      "content": "How does AI work? Explain it in simple terms."
    }'

Berichten weergeven

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

Retourneert een lijst met berichten voor een bepaalde thread.

Padparameters

Parameter	Type	Vereist	Beschrijving
`thread_id`	tekenreeks	Vereist	De id van de thread waartoe berichten behoren.

Queryparameters

Name	Type	Vereist	Beschrijving
`limit`	geheel getal	Optioneel : standaard ingesteld op 20	Een limiet voor het aantal objecten dat moet worden geretourneerd. De limiet kan variëren tussen 1 en 100 en de standaardwaarde is 20.
`order`	tekenreeks	Optioneel : standaardwaarden voor desc	Sorteervolgorde op de created_at tijdstempel van de objecten. asc voor oplopende volgorde en desc voor aflopende volgorde.
`after`	tekenreeks	Optioneel	Een cursor voor gebruik in paginering. na is een object-id die uw plaats in de lijst definieert. Als u bijvoorbeeld een lijstaanvraag indient en 100 objecten ontvangt die eindigen op obj_foo, kan de volgende aanroep na=obj_foo worden opgenomen om de volgende pagina van de lijst op te halen.
`run_id`	tekenreeks	Optionanl	Filter berichten op de uitvoerings-id die ze heeft gegenereerd.
`before`	tekenreeks	Optioneel	Een cursor voor gebruik in paginering. vóór is een object-id die uw plaats in de lijst definieert. Als u bijvoorbeeld een lijstaanvraag indient en 100 objecten ontvangt die eindigen op obj_foo, kan de volgende aanroep vóór=obj_foo worden opgenomen om de vorige pagina van de lijst op te halen.

Retouren

Een lijst met berichtobjecten .

Voorbeeld van een aanvraag voor lijstberichten

Python 1.x
REST

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")
    )

thread_messages = client.beta.threads.messages.list("thread_abc123")
print(thread_messages.data)

curl https://YOUR_RESOURCE_NAME.openai.azure.com/openai/threads/{thread_id}/messages?api-version=2024-08-01-preview \
  -H "api-key: $AZURE_OPENAI_API_KEY" \
  -H 'Content-Type: application/json'

Bericht ophalen

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

Hiermee haalt u een berichtbestand op.

Padparameters

Parameter	Type	Vereist	Beschrijving
`thread_id`	tekenreeks	Vereist	De id van de thread waartoe het bericht behoort.
`message_id`	tekenreeks	Vereist	De id van het bericht dat moet worden opgehaald.

Retouren

Het berichtobject dat overeenkomt met de opgegeven id.

Voorbeeld van het ophalen van een berichtaanvraag

Python 1.x
REST

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")
    )

message = client.beta.threads.messages.retrieve(
  message_id="msg_abc123",
  thread_id="thread_abc123",
)
print(message)

curl https://YOUR_RESOURCE_NAME.openai.azure.com/openai/threads/{thread_id}/messages/{message_id}?api-version=2024-08-01-preview \
  -H "api-key: $AZURE_OPENAI_API_KEY" \
  -H 'Content-Type: application/json'

Bericht wijzigen

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

Hiermee wijzigt u een bericht.

Padparameters

Parameter	Type	Vereist	Beschrijving
`thread_id`	tekenreeks	Vereist	De id van de thread waartoe het bericht behoort.
`message_id`	tekenreeks	Vereist	De id van het bericht dat u wilt wijzigen.

Aanvraagbody

Parameter	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.

Retouren

Het gewijzigde berichtobject .

Python 1.x
REST

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")
    )

message = client.beta.threads.messages.update(
  message_id="msg_abc12",
  thread_id="thread_abc123",
  metadata={
    "modified": "true",
    "user": "abc123",
  },
)
print(message)

curl https://YOUR_RESOURCE_NAME.openai.azure.com/openai/threads/{thread_id}/messages/{message_id}?api-version=2024-08-01-preview
``` \
  -H "api-key: $AZURE_OPENAI_API_KEY" \
  -H 'Content-Type: application/json' \
  -d '{
      "metadata": {
        "modified": "true",
        "user": "abc123"
      }
    }'

Bericht verwijderen

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

Hiermee verwijdert u een bericht.

Padparameters

Parameter	Type	Vereist	Beschrijving
`thread_id`	tekenreeks	Vereist	De id van de thread waartoe het bericht behoort.
`message_id`	tekenreeks	Vereist	De id van het bericht dat u wilt wijzigen.

Retouren

De verwijderingsstatus van het berichtobject .

Python 1.x
REST

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")
    )

deleted_message = client.beta.threads.messages.delete(
  message_id="msg_abc12",
  thread_id="thread_abc123",
)
print(deleted_message)

curl -x DELETE https://YOUR_RESOURCE_NAME.openai.azure.com/openai/threads/{thread_id}/messages/{message_id}?api-version=2024-08-01-preview \
  -H "api-key: $AZURE_OPENAI_API_KEY" \
  -H 'Content-Type: application/json'

Berichtobject

Vertegenwoordigt een bericht in een thread.

Name	Type	Omschrijving
`id`	tekenreeks	De id waarnaar kan worden verwezen in API-eindpunten.
`object`	tekenreeks	Het objecttype, dat altijd thread.message is.
`created_at`	geheel getal	De Unix-tijdstempel (in seconden) voor het moment waarop het bericht is gemaakt.
`thread_id`	tekenreeks	De thread-id waartoe dit bericht behoort.
`role`	tekenreeks	De entiteit die het bericht heeft geproduceerd. Een van `user` of `assistant`.
`content`	matrix	De inhoud van het bericht in matrix met tekst en/of afbeeldingen.
`assistant_id`	tekenreeks of null	Indien van toepassing, de id van de assistent die dit bericht heeft geschreven.
`run_id`	tekenreeks of null	Indien van toepassing, de id van de uitvoering die is gekoppeld aan de creatie van dit bericht.
`file_ids`	matrix	Een lijst met bestands-id's die de assistent moet gebruiken. Handig voor hulpprogramma's zoals ophalen en code_interpreter die toegang hebben tot bestanden. Er kunnen maximaal 10 bestanden aan een bericht worden toegevoegd.
`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.

Delen via

Naslaginformatie over assistenten-API-berichten (preview)

Bericht maken

Retouren

Voorbeeld van het maken van een berichtaanvraag

Berichten weergeven

Retouren

Voorbeeld van een aanvraag voor lijstberichten

Bericht ophalen

Retouren

Voorbeeld van het ophalen van een berichtaanvraag

Bericht wijzigen

Retouren

Bericht verwijderen

Retouren

Berichtobject

Feedback

Aanvullende resources