Api-referens för 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_choicesom 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 assistent
POST https://YOUR_RESOURCE_NAME.openai.azure.com/openai/assistants?api-version=2024-05-01-preview
Skapa en assistent med en modell och instruktioner.
Begärandetext
| Namn | Typ | Obligatoriskt | Beskrivning |
|---|---|---|---|
| modell | sträng | Obligatoriskt | Modelldistributionsnamn för den modell som ska användas. |
| name | sträng eller null | Valfritt | Namnet på assistenten. Den maximala längden är 256 tecken. |
| description | sträng eller null | Valfritt | Beskrivningen av assistenten. Den maximala längden är 512 tecken. |
| instruktioner | sträng eller null | Valfritt | Systeminstruktionerna som assistenten använder. Den maximala längden är 256 000 tecken. |
| verktyg | matris | Valfritt | Standardvärdet är []. En lista över verktyg som är aktiverade på assistenten. Det kan finnas högst 128 verktyg per assistent. Verktyg kan för närvarande vara av typer code_interpreter, eller function. En function beskrivning kan vara högst 1 024 tecken. |
| file_ids | matris | Valfritt | Standardvärdet är []. En lista över fil-ID:t som är kopplade till den här assistenten. Det kan finnas högst 20 filer kopplade till assistenten. Filerna sorteras efter deras skapandedatum i stigande ordning. |
| 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. |
| temperatur | tal eller null | Valfritt | Standardvärdet är 1. Avgör vilken samplingstemperatur som ska användas, mellan 0 och 2. Högre värden som 0,8 gör utdata mer slumpmässiga, medan lägre värden som 0,2 gör det mer fokuserat och deterministiskt. |
| top_p | tal eller null | Valfritt | Standardvärdet är 1. Ett alternativ till sampling med temperatur, som kallas kärnsampling, där modellen tar hänsyn till resultatet av token med top_p sannolikhetsmassa. Så 0,1 innebär att endast token som består av den översta 10 % sannolikhetsmassan beaktas. Vi rekommenderar vanligtvis att du ändrar detta eller temperatur men inte båda. |
| response_format | sträng eller objekt | Valfritt | Anger det format som modellen måste mata ut. Kompatibel med GPT-4 Turbo och alla GPT-3.5 Turbo modeller sedan gpt-3.5-turbo-1106. Om du anger den här parametern till { "type": "json_object" } aktiverar du JSON-läge, vilket garanterar att meddelandet som modellen genererar är giltigt JSON. När du använder JSON-läge måste du också instruera modellen att skapa JSON själv med hjälp av ett system- eller användarmeddelande. Utan den här instruktionen kan modellen generera en avaktiverande ström av blanksteg tills genereringen når tokengränsen, vilket resulterar i en tidskrävande och till synes "fast" begäran. Dessutom kan meddelandeinnehållet vara delvis avskuret om du använder finish_reason="length", vilket indikerar att genereringen överskreds max_tokens eller att konversationen överskred den maximala kontextlängden. |
Returer
Ett assistentobjekt .
Exempel på begäran om att skapa assistent
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")
)
assistant = client.beta.assistants.create(
instructions="You are an AI assistant that can write code to help answer math questions",
model="<REPLACE WITH MODEL DEPLOYMENT NAME>", # replace with model deployment name.
tools=[{"type": "code_interpreter"}]
)
Skapa assistentfil
POST https://YOUR_RESOURCE_NAME.openai.azure.com/openai/assistants/{assistant_id}/files?api-version=2024-05-01-preview
Skapa en assistentfil genom att koppla en File till en assistant.
Sökvägsparametrar
| Parameter | Type | Obligatoriskt | Beskrivning |
|---|---|---|---|
assistant_id |
sträng | Obligatoriskt | ID:t för assistenten som filen ska kopplas till. |
Begärandetext
| Namn | Typ | Obligatoriskt | Beskrivning |
|---|---|---|---|
| file_id | sträng | Obligatoriskt | Ett fil-ID (med purpose="assistants") som assistenten ska använda. Användbart för verktyg som code_interpreter som kan komma åt filer. |
Returer
Ett assistentfilobjekt .
Exempel på filbegäran för att skapa assistent
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")
)
assistant_file = client.beta.assistants.files.create(
assistant_id="asst_abc123",
file_id="assistant-abc123"
)
print(assistant_file)
Lista assistenter
GET https://YOUR_RESOURCE_NAME.openai.azure.com/openai/assistants?api-version=2024-05-01-preview
Returnerar en lista över alla assistenter.
Frågeparametrar
| Parameter | Type | Obligatoriskt | Beskrivning |
|---|---|---|---|
limit |
integer | Valfritt | En gräns för hur många objekt som ska returneras. Gränsen kan vara mellan 1 och 100 och standardvärdet är 20. |
order |
sträng | Valfritt – Standardinställningar för desc | Sortera ordning efter objektens created_at tidsstämpel. asc för stigande ordning och desc för fallande ordning. |
after |
sträng | Valfritt | En markör för användning i sidnumrering. after är ett objekt-ID som definierar din plats i listan. Om du till exempel gör en listbegäran och tar emot 100 objekt, som slutar med obj_foo, kan ditt efterföljande anrop inkludera after=obj_foo för att hämta nästa sida i listan. |
before |
sträng | Valfritt | En markör för användning i sidnumrering. before är ett objekt-ID som definierar din plats i listan. Om du till exempel gör en listbegäran och tar emot 100 objekt, som slutar med obj_foo, kan ditt efterföljande anrop inkludera före =obj_foo för att hämta föregående sida i listan. |
Returer
En lista över assistentobjekt
Exempel på listassistenter
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_assistants = client.beta.assistants.list(
order="desc",
limit="20",
)
print(my_assistants.data)
Lista assistentfiler
GET https://YOUR_RESOURCE_NAME.openai.azure.com/openai/assistants/{assistant_id}/files?api-version=2024-05-01-preview
Returnerar en lista över assistentfiler.
Sökvägsparametrar
| Parameter | Type | Obligatoriskt | Beskrivning |
|---|---|---|---|
| assistant_id | sträng | Obligatoriskt | ID:t för assistenten som filen tillhör. |
Frågeparametrar
| Parameter | Type | Obligatoriskt | Beskrivning |
|---|---|---|---|
limit |
integer | Valfritt | En gräns för hur många objekt som ska returneras. Gränsen kan vara mellan 1 och 100 och standardvärdet är 20. |
order |
sträng | Valfritt – Standardinställningar för desc | Sortera ordning efter objektens created_at tidsstämpel. asc för stigande ordning och desc för fallande ordning. |
after |
sträng | Valfritt | En markör för användning i sidnumrering. after är ett objekt-ID som definierar din plats i listan. Om du till exempel gör en listbegäran och tar emot 100 objekt, som slutar med obj_foo, kan ditt efterföljande anrop inkludera after=obj_foo för att hämta nästa sida i listan. |
before |
sträng | Valfritt | En markör för användning i sidnumrering. before är ett objekt-ID som definierar din plats i listan. Om du till exempel gör en listbegäran och tar emot 100 objekt, som slutar med obj_foo, kan ditt efterföljande anrop inkludera före =obj_foo för att hämta föregående sida i listan. |
Returer
En lista över assistentfilobjekt
Exempel på listassistentfiler
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")
)
assistant_files = client.beta.assistants.files.list(
assistant_id="asst_abc123"
)
print(assistant_files)
Hämta assistent
GET https://YOUR_RESOURCE_NAME.openai.azure.com/openai/assistants/{assistant_id}?api-version=2024-05-01-preview
Hämtar en assistent.
Sökvägsparametrar
| Parameter | Type | Obligatoriskt | Beskrivning |
|---|---|---|---|
assistant_id |
sträng | Obligatoriskt | ID:t för assistenten som ska hämtas. |
Returer
Assistentobjektet som matchar det angivna ID:t.
Exempel på hämtningsassistent
client = AzureOpenAI(
api_key=os.getenv("AZURE_OPENAI_API_KEY"),
api_version="2024-05-01-preview",
azure_endpoint = os.getenv("AZURE_OPENAI_ENDPOINT")
)
my_assistant = client.beta.assistants.retrieve("asst_abc123")
print(my_assistant)
Hämta assistentfil
GET https://YOUR_RESOURCE_NAME.openai.azure.com/openai/assistants/{assistant_id}/files/{file-id}?api-version=2024-05-01-preview
Hämtar en assistentfil.
Sökvägsparametrar
| Parameter | Type | Obligatoriskt | Beskrivning |
|---|---|---|---|
| assistant_id | sträng | Obligatoriskt | ID:t för assistenten som filen tillhör. |
| file_id | sträng | Obligatoriskt | ID:t för filen som vi får |
Returer
Det assistentfilobjekt som matchar det angivna ID:t
Exempel på hämta assistentfil
client = AzureOpenAI(
api_key=os.getenv("AZURE_OPENAI_API_KEY"),
api_version="2024-05-01-preview",
azure_endpoint = os.getenv("AZURE_OPENAI_ENDPOINT")
)
assistant_file = client.beta.assistants.files.retrieve(
assistant_id="asst_abc123",
file_id="assistant-abc123"
)
print(assistant_file)
Ändra assistent
POST https://YOUR_RESOURCE_NAME.openai.azure.com/openai/assistants/{assistant_id}?api-version=2024-05-01-preview
Ändrar en assistent.
Sökvägsparametrar
| Parameter | Type | Obligatoriskt | Beskrivning |
|---|---|---|---|
| assistant_id | sträng | Obligatoriskt | ID:t för assistenten som filen tillhör. |
Begärandetext
| Parameter | Type | Obligatoriskt | Beskrivning |
|---|---|---|---|
model |
Valfritt | Modelldistributionsnamnet för den modell som ska användas. | |
name |
sträng eller null | Valfritt | Namnet på assistenten. Den maximala längden är 256 tecken. |
description |
sträng eller null | Valfritt | Beskrivningen av assistenten. Den maximala längden är 512 tecken. |
instructions |
sträng eller null | Valfritt | Systeminstruktionerna som assistenten använder. Den maximala längden är 32768 tecken. |
tools |
matris | Valfritt | Standardvärdet är []. En lista över verktyg som är aktiverade på assistenten. Det kan finnas högst 128 verktyg per assistent. Verktyg kan vara av typer code_interpreter eller funktion. En function beskrivning kan vara högst 1 024 tecken. |
file_ids |
matris | Valfritt | Standardvärdet är []. En lista över fil-ID:t som är kopplade till den här assistenten. Det kan finnas högst 20 filer kopplade till assistenten. Filerna sorteras efter deras skapandedatum i stigande ordning. Om en fil tidigare har kopplats till listan men inte visas i listan tas den bort från assistenten. |
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 assistentobjektet.
Exempel på ändringsassistent
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_assistant = client.beta.assistants.update(
"asst_abc123",
instructions="You are an HR bot, and you have access to files to answer employee questions about company policies. Always respond with info from either of the files.",
name="HR Helper",
tools=[{"type": "code-interpreter"}],
model="gpt-4", #model = model deployment name
file_ids=["assistant-abc123", "assistant-abc456"],
)
print(my_updated_assistant)
Ta bort assistent
DELETE https://YOUR_RESOURCE_NAME.openai.azure.com/openai/assistants/{assistant_id}?api-version=2024-05-01-preview
Ta bort en assistent.
Sökvägsparametrar
| Parameter | Type | Obligatoriskt | Beskrivning |
|---|---|---|---|
assistant_id |
sträng | Obligatoriskt | ID:t för assistenten som filen tillhör. |
Returer
Borttagningsstatus.
Exempel på borttagningsassistent
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.assistants.delete("asst_abc123")
print(response)
Ta bort assistentfil
DELETE https://YOUR_RESOURCE_NAME.openai.azure.com/openai/assistants/{assistant_id}/files/{file-id}?api-version=2024-05-01-preview
Ta bort en assistentfil.
Sökvägsparametrar
| Parameter | Type | Obligatoriskt | Beskrivning |
|---|---|---|---|
assistant_id |
sträng | Obligatoriskt | ID:t för assistenten som filen tillhör. |
file_id |
sträng | Obligatoriskt | ID:t för filen som ska tas bort |
Returer
Status för borttagning av fil
Exempel på borttagningsassistentfil
client = AzureOpenAI(
api_key=os.getenv("AZURE_OPENAI_API_KEY"),
api_version="2024-05-01-preview",
azure_endpoint = os.getenv("AZURE_OPENAI_ENDPOINT")
)
deleted_assistant_file = client.beta.assistants.files.delete(
assistant_id="asst_abc123",
file_id="assistant-abc123"
)
print(deleted_assistant_file)
Api-referens för filuppladdning
Assistenter använder samma API för filuppladdning som finjustering. När du laddar upp en fil måste du ange ett lämpligt värde för syftesparametern.
Assistentobjekt
| Fält | Type | Description |
|---|---|---|
id |
sträng | Identifieraren, som kan refereras till i API-slutpunkter. |
object |
sträng | Objekttypen, som alltid är assistent. |
created_at |
integer | Unix-tidsstämpeln (i sekunder) för när assistenten skapades. |
name |
sträng eller null | Namnet på assistenten. Den maximala längden är 256 tecken. |
description |
sträng eller null | Beskrivningen av assistenten. Den maximala längden är 512 tecken. |
model |
sträng | Namnet på modelldistributionsnamnet som ska användas. |
instructions |
sträng eller null | Systeminstruktionerna som assistenten använder. Den maximala längden är 32768 tecken. |
tools |
matris | En lista över verktyg som är aktiverade på assistenten. Det kan finnas högst 128 verktyg per assistent. Verktyg kan vara av typer code_interpreter eller funktion. En function beskrivning kan vara högst 1 024 tecken. |
file_ids |
matris | En lista över fil-ID:t som är kopplade till den här assistenten. Det kan finnas högst 20 filer kopplade till assistenten. Filerna sorteras efter deras skapandedatum i stigande ordning. |
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. |
Assistentfilobjekt
| Fält | Type | Description |
|---|---|---|
id |
sträng | Identifieraren, som kan refereras till i API-slutpunkter. |
object |
sträng | Objekttypen, som alltid är assistant.file |
created_at |
integer | Unix-tidsstämpeln (i sekunder) för när assistentfilen skapades. |
assistant_id |
sträng | Det assistent-ID som filen är kopplad till. |
Feedback
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: https://aka.ms/ContentUserFeedback.
Skicka och visa feedback för