Referens för API-assistenter (förhandsversion)
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-05-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. |
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-05-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-05-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-05-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-05-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. |
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-05-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. |
Feedback
https://aka.ms/ContentUserFeedback.
Kommer snart: Under hela 2024 kommer vi att fasa ut GitHub-problem som feedbackmekanism för innehåll och ersätta det med ett nytt feedbacksystem. Mer information finns i:Skicka och visa feedback för