Dela via

Referens för API-assistenter (förhandsversion)

  • Artikel

Kommentar

  • Filsökning kan mata in upp till 10 000 filer per assistent – 500 gånger mer än tidigare. Den är snabb, stöder parallella frågor via sökningar med flera trådar och funktioner för förbättrad omrankning och omskrivning av frågor.
    • Vector Store är ett nytt objekt i API:et. När en fil har lagts till i ett vektorlager parsas den automatiskt, segmenteras och bäddas in och görs redo att sökas igenom. Vektorlager kan användas mellan assistenter och trådar, vilket förenklar filhantering och fakturering.
  • Vi har lagt till stöd för parametern tool_choice som kan användas för att tvinga fram användningen av ett specifikt verktyg (till exempel filsökning, kodtolkare eller en funktion) i en viss körning.

Den här artikeln innehåller referensdokumentation för Python och REST för det nya ASSISTENT-API:et (förhandsversion). Mer detaljerad stegvis vägledning finns i komma igång-guiden.

Skapa en tråd

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

Skapa en tråd.

Begärandetext

Namn Typ Obligatoriskt Beskrivning
messages matris Valfritt En lista över meddelanden att starta tråden med.
metadata map Valfritt Uppsättning med 16 nyckel/värde-par som kan kopplas till ett objekt. Detta kan vara användbart för att lagra ytterligare information om objektet i ett strukturerat format. Nycklar kan vara högst 64 tecken långa och värden kan vara högst 512 tecken långa.
tool_resources objekt Valfritt En uppsättning resurser som görs tillgängliga för assistentens verktyg i den här tråden. Resurserna är specifika för typen av verktyg. Verktyget kräver till exempel code_interpreter en lista över fil-ID:t, medan file_search verktyget kräver en lista över vektorarkiv-ID:t.

tool_resources egenskaper

code_interpreter

Namn Type Beskrivning Standard
file_ids matris En lista över fil-ID:t som gjorts tillgängliga för verktyget code_interpreter. Det kan finnas högst 20 filer som är associerade med verktyget. []

file_search

Namn Type Beskrivning Standard
vector_store_ids matris Vektorarkivet som är kopplat till den här tråden. Det kan finnas högst 1 vektorlager kopplat till tråden. []
vector_stores matris En hjälp för att skapa ett vektorlager med file_ids och koppla det till den här tråden. Det kan finnas högst 1 vektorlager kopplat till tråden. []

Returer

Ett trådobjekt.

Exempel: skapa trådbegäran

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)

Hämta tråd

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

Hämtar en tråd.

Sökvägsparametrar

Parameter Type Obligatoriskt Beskrivning
thread_id sträng Obligatoriskt ID:t för den tråd som ska hämtas

Returer

Trådobjektet som matchar det angivna ID:t.

Exempel: hämta trådbegäran

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)

Ändra tråd

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

Ändrar en tråd.

Sökvägsparametrar

Parameter Type Obligatoriskt Beskrivning
thread_id sträng Obligatoriskt ID:t för den tråd som ska ändras.

Begärandetext

Namn Typ Obligatoriskt Beskrivning
metadata map Valfritt Uppsättning med 16 nyckel/värde-par som kan kopplas till ett objekt. Detta kan vara användbart för att lagra ytterligare information om objektet i ett strukturerat format. Nycklar kan vara högst 64 tecken långa och värden kan vara högst 512 tecken långa.
tool_resources objekt Valfritt En uppsättning resurser som görs tillgängliga för assistentens verktyg i den här tråden. Resurserna är specifika för typen av verktyg. Verktyget kräver till exempel code_interpreter en lista över fil-ID:t, medan file_search verktyget kräver en lista över vektorarkiv-ID:t.

Returer

Det ändrade trådobjektet som matchar det angivna ID:t.

Exempel: ändra trådbegäran

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)

Ta bort tråd

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

Ta bort en tråd.

Sökvägsparametrar

Parameter Type Obligatoriskt Beskrivning
thread_id sträng Obligatoriskt ID för den tråd som ska tas bort.

Returer

Borttagningsstatus.

Exempel: ta bort trådbegäran

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)

Trådobjekt

Fält Type Description
id sträng Identifieraren, som kan refereras till i API-slutpunkter.
object sträng Objekttypen, som alltid är tråd.
created_at integer Unix-tidsstämpeln (i sekunder) för när tråden skapades.
metadata map Uppsättning med 16 nyckel/värde-par som kan kopplas till ett objekt. Detta kan vara användbart för att lagra ytterligare information om objektet i ett strukturerat format. Nycklar kan vara högst 64 tecken långa och värden kan vara högst 512 tecken långa.