Yardımcılar API'si (Önizleme) başvurusu
Not
- Dosya arama , yardımcı başına 10.000'e kadar dosya alabilir - öncekinden 500 kat daha fazla. Hızlıdır, çok iş parçacıklı aramalar aracılığıyla paralel sorguları destekler ve gelişmiş yeniden boyutlandırma ve sorgu yeniden yazma özellikleri sunar.
- Vektör deposu API'de yeni bir nesnedir. Bir dosya bir vektör deposuna eklendikten sonra otomatik olarak ayrıştırılır, öbeklenip eklenir ve aranmaya hazır hale getirilir. Vektör depoları yardımcılar ve iş parçacıkları arasında kullanılabilir ve bu da dosya yönetimini ve faturalamayı basitleştirir.
- Belirli bir çalıştırmada
tool_choicebelirli bir aracın (dosya arama, kod yorumlayıcı veya işlev gibi) kullanılmasını zorlamak için kullanılabilecek parametre desteği ekledik.
Bu makalede, yeni Yardımcılar API'sine (Önizleme) yönelik Python ve REST için başvuru belgeleri sağlanır. Başlangıç kılavuzunda daha ayrıntılı adım adım yönergeler sağlanır.
Yardımcı oluşturma
POST https://YOUR_RESOURCE_NAME.openai.azure.com/openai/assistants?api-version=2024-05-01-preview
Model ve yönergeler içeren bir yardımcı oluşturun.
Request body
| Adı | Tür | Zorunlu | Açıklama |
|---|---|---|---|
| model | Dize | Zorunlu | Kullanılacak modelin model dağıtım adı. |
| Adı | dize veya null | İsteğe bağlı | Asistanın adı. Uzunluk üst sınırı 256 karakterdir. |
| açıklama | dize veya null | İsteğe bağlı | Asistanın açıklaması. Uzunluk üst sınırı 512 karakterdir. |
| yönergeler | dize veya null | İsteğe bağlı | Yardımcının kullandığı sistem yönergeleri. Uzunluk üst sınırı 256.000 karakterdir. |
| araçlar | dizi | İsteğe bağlı | Varsayılan olarak []. Yardımcıda etkinleştirilen araçların listesi. Yardımcı başına en fazla 128 araç olabilir. Araçlar şu anda veya functiontüründe code_interpreterolabilir. Açıklama function en fazla 1.024 karakter olabilir. |
| file_ids | dizi | İsteğe bağlı | Varsayılan olarak []. Bu yardımcıya eklenmiş dosya kimliklerinin listesi. Yardımcıya en fazla 20 dosya eklenebilir. Dosyalar oluşturma tarihlerine göre artan düzende sıralanır. |
| meta veriler | map | İsteğe bağlı | Bir nesneye eklenebilen 16 anahtar-değer çifti kümesi. Bu, nesne hakkında ek bilgileri yapılandırılmış biçimde depolamak için yararlı olabilir. Anahtarlar en fazla 64 karakter uzunluğunda ve değerler en fazla 512 karakter uzunluğunda olabilir. |
| sıcaklık | sayı veya null | İsteğe bağlı | Varsayılan değer 1'tir. 0 ile 2 arasında hangi örnekleme sıcaklığının kullanılacağını belirler. 0,8 gibi daha yüksek değerler çıkışı daha rastgele hale getirirken, 0,2 gibi daha düşük değerler daha odaklanmış ve belirleyici hale getirir. |
| top_p | sayı veya null | İsteğe bağlı | Varsayılan değer 1'tir. Modelin top_p olasılık kütlesine sahip belirteçlerin sonuçlarını dikkate aldığı, çekirdek örneklemesi olarak adlandırılan sıcaklıkla örneklemeye alternatiftir. Bu nedenle 0,1 yalnızca ilk %10 olasılık kütlesinden oluşan belirteçlerin dikkate alınması anlamına gelir. Genellikle bunu veya sıcaklığı değiştirmenizi öneririz, ancak ikisini birden değiştirmemenizi öneririz. |
| response_format | dize veya nesne | İsteğe bağlı | Modelin çıkış yapması gereken biçimi belirtir. GPT-4 Turbo ve gpt-3.5-turbo-1106'dan bu yana tüm GPT-3.5 Turbo modelleri ile uyumludur. Bu parametreyi JSON modunu etkinleştirecek şekilde { "type": "json_object" } ayarlamak, modelin oluşturduğu iletinin geçerli JSON olduğunu garanti eder. Önemli olan, JSON modunu kullanırken modele bir sistem veya kullanıcı iletisi kullanarak JSON üretmesini de belirtmeniz gerekir. Bu yönerge olmadan model, nesil belirteç sınırına ulaşana kadar bitmeyen bir boşluk akışı oluşturabilir ve bu da uzun süre çalışan ve görünüşe göre "takılmış" bir istekle sonuçlanır. Ayrıca, kullanırsanız finish_reason="length"ileti içeriği kısmen kesilebilir. Bu, neslin aştığını max_tokens veya konuşmanın bağlam uzunluğunun üst sınırını aştığını gösterir. |
Döndürülenler
Bir yardımcı nesnesi.
Örnek yardımcı oluşturma isteği
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"}]
)
Yardımcı dosyası oluşturma
POST https://YOUR_RESOURCE_NAME.openai.azure.com/openai/assistants/{assistant_id}/files?api-version=2024-05-01-preview
öğesine ekleyerek Fileassistantbir yardımcı dosyası oluşturun.
Yol parametreleri
| Parametre | Türü | Zorunlu | Açıklama |
|---|---|---|---|
assistant_id |
Dize | Zorunlu | Dosyanın eklenmesi gereken yardımcının kimliği. |
İstek gövdesi
| Adı | Tür | Zorunlu | Açıklama |
|---|---|---|---|
| file_id | Dize | Zorunlu | Yardımcının kullanması gereken bir Dosya Kimliği (purpose="assistants ile). Dosyalara erişebilen code_interpreter gibi araçlar için kullanışlıdır. |
Döndürülenler
Yardımcı dosya nesnesi.
Örnek yardımcı dosya isteği oluşturma
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)
Yardımcıları listeleme
GET https://YOUR_RESOURCE_NAME.openai.azure.com/openai/assistants?api-version=2024-05-01-preview
Tüm yardımcıların listesini döndürür.
Sorgu parametreleri
| Parametre | Türü | Zorunlu | Açıklama |
|---|---|---|---|
limit |
integer | İsteğe bağlı | Döndürülecek nesne sayısıyla ilgili bir sınır. Sınır 1 ile 100 arasında olabilir ve varsayılan değer 20'dir. |
order |
Dize | İsteğe bağlı - Desc varsayılanları | Düzeni nesnelerin created_at zaman damgasına göre sıralayın. artan düzen için asc ve azalan düzen için desc. |
after |
Dize | İsteğe bağlı | Sayfalandırmada kullanılacak bir imleç. after , listedeki yerinizi tanımlayan bir nesne kimliğidir. Örneğin, bir liste isteğinde bulunur ve obj_foo ile biten 100 nesne alırsanız, listenin sonraki sayfasını getirmek için sonraki çağrınız after=obj_foo içerebilir. |
before |
Dize | İsteğe bağlı | Sayfalandırmada kullanılacak bir imleç. before , listedeki yerinizi tanımlayan bir nesne kimliğidir. Örneğin, bir liste isteğinde bulunur ve obj_foo ile biten 100 nesne alırsanız, listenin önceki sayfasını getirmek için sonraki çağrınız before=obj_foo içerebilir. |
Döndürülenler
Yardımcı nesnelerin listesi
Örnek liste yardımcıları
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)
Yardımcı dosyalarını listeleme
GET https://YOUR_RESOURCE_NAME.openai.azure.com/openai/assistants/{assistant_id}/files?api-version=2024-05-01-preview
Yardımcı dosyalarının listesini döndürür.
Yol parametreleri
| Parametre | Türü | Zorunlu | Açıklama |
|---|---|---|---|
| assistant_id | Dize | Zorunlu | Dosyanın ait olduğu yardımcının kimliği. |
Sorgu parametreleri
| Parametre | Türü | Zorunlu | Açıklama |
|---|---|---|---|
limit |
integer | İsteğe bağlı | Döndürülecek nesne sayısıyla ilgili bir sınır. Sınır 1 ile 100 arasında olabilir ve varsayılan değer 20'dir. |
order |
Dize | İsteğe bağlı - Desc varsayılanları | Düzeni nesnelerin created_at zaman damgasına göre sıralayın. artan düzen için asc ve azalan düzen için desc. |
after |
Dize | İsteğe bağlı | Sayfalandırmada kullanılacak bir imleç. after , listedeki yerinizi tanımlayan bir nesne kimliğidir. Örneğin, bir liste isteğinde bulunur ve obj_foo ile biten 100 nesne alırsanız, listenin sonraki sayfasını getirmek için sonraki çağrınız after=obj_foo içerebilir. |
before |
Dize | İsteğe bağlı | Sayfalandırmada kullanılacak bir imleç. before , listedeki yerinizi tanımlayan bir nesne kimliğidir. Örneğin, bir liste isteğinde bulunur ve obj_foo ile biten 100 nesne alırsanız, listenin önceki sayfasını getirmek için sonraki çağrınız before=obj_foo içerebilir. |
Döndürülenler
Yardımcı dosya nesnelerinin listesi
Örnek liste yardımcısı dosyaları
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)
Yardımcıyı alma
GET https://YOUR_RESOURCE_NAME.openai.azure.com/openai/assistants/{assistant_id}?api-version=2024-05-01-preview
Bir yardımcı alır.
Yol parametreleri
| Parametre | Türü | Zorunlu | Açıklama |
|---|---|---|---|
assistant_id |
Dize | Zorunlu | Alınacak yardımcının kimliği. |
İadeler
Belirtilen kimlikle eşleşen yardımcı nesnesi.
Örnek alma yardımcısı
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)
Yardımcı dosyasını alma
GET https://YOUR_RESOURCE_NAME.openai.azure.com/openai/assistants/{assistant_id}/files/{file-id}?api-version=2024-05-01-preview
Bir Yardımcı dosyası alır.
Yol parametreleri
| Parametre | Türü | Zorunlu | Açıklama |
|---|---|---|---|
| assistant_id | Dize | Zorunlu | Dosyanın ait olduğu yardımcının kimliği. |
| file_id | Dize | Zorunlu | Aldığımız dosyanın kimliği |
Döndürülenler
Belirtilen kimlikle eşleşen yardımcı dosya nesnesi
Örnek yardımcı dosyasını alma
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)
Yardımcıyı değiştir
POST https://YOUR_RESOURCE_NAME.openai.azure.com/openai/assistants/{assistant_id}?api-version=2024-05-01-preview
Bir yardımcıyı değiştirir.
Yol parametreleri
| Parametre | Türü | Zorunlu | Açıklama |
|---|---|---|---|
| assistant_id | Dize | Zorunlu | Dosyanın ait olduğu yardımcının kimliği. |
İstek Gövdesi
| Parametre | Türü | Zorunlu | Açıklama |
|---|---|---|---|
model |
İsteğe bağlı | Kullanılacak modelin model dağıtım adı. | |
name |
dize veya null | İsteğe bağlı | Asistanın adı. Uzunluk üst sınırı 256 karakterdir. |
description |
dize veya null | İsteğe bağlı | Asistanın açıklaması. Uzunluk üst sınırı 512 karakterdir. |
instructions |
dize veya null | İsteğe bağlı | Yardımcının kullandığı sistem yönergeleri. Uzunluk üst sınırı 32768 karakterdir. |
tools |
dizi | İsteğe bağlı | Varsayılan olarak []. Yardımcıda etkinleştirilen araçların listesi. Yardımcı başına en fazla 128 araç olabilir. Araçlar code_interpreter veya işlev türünde olabilir. Açıklama function en fazla 1.024 karakter olabilir. |
file_ids |
dizi | İsteğe bağlı | Varsayılan olarak []. Bu yardımcıya eklenmiş Dosya Kimliklerinin listesi. Yardımcıya en fazla 20 dosya eklenebilir. Dosyalar oluşturma tarihlerine göre artan düzende sıralanır. Bir dosya daha önce listeye eklenmişse ancak listede görünmüyorsa, yardımcıdan silinir. |
metadata |
map | İsteğe bağlı | Bir nesneye eklenebilen 16 anahtar-değer çifti kümesi. Bu, nesne hakkında ek bilgileri yapılandırılmış biçimde depolamak için yararlı olabilir. Anahtarlar en fazla 64 karakter uzunluğunda ve değerler en fazla 512 karakter uzunluğunda olabilir. |
İadeler
Değiştirilen yardımcı nesnesi.
Örnek değiştirme yardımcısı
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)
Yardımcıyı sil
DELETE https://YOUR_RESOURCE_NAME.openai.azure.com/openai/assistants/{assistant_id}?api-version=2024-05-01-preview
Bir yardımcıyı silin.
Yol parametreleri
| Parametre | Türü | Zorunlu | Açıklama |
|---|---|---|---|
assistant_id |
Dize | Zorunlu | Dosyanın ait olduğu yardımcının kimliği. |
İadeler
Silme durumu.
Örnek silme yardımcısı
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)
Yardımcı dosyasını silme
DELETE https://YOUR_RESOURCE_NAME.openai.azure.com/openai/assistants/{assistant_id}/files/{file-id}?api-version=2024-05-01-preview
Yardımcı dosyasını silin.
Yol parametreleri
| Parametre | Türü | Zorunlu | Açıklama |
|---|---|---|---|
assistant_id |
Dize | Zorunlu | Dosyanın ait olduğu yardımcının kimliği. |
file_id |
Dize | Zorunlu | Silinecek dosyanın kimliği |
İadeler
Dosya silme durumu
Örnek silme yardımcısı dosyası
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)
Dosya yükleme API'si başvurusu
Yardımcılar, dosya yükleme için ince ayar ile aynı API'yi kullanır. Bir dosyayı karşıya yüklerken, amaç parametresi için uygun bir değer belirtmeniz gerekir.
Yardımcı nesnesi
| Alan | Tür | Veri Akışı Açıklaması |
|---|---|---|
id |
Dize | API uç noktalarında başvurulabilen tanımlayıcı. |
object |
Dize | Her zaman yardımcı olan nesne türü. |
created_at |
integer | Yardımcının oluşturulduğu zaman için Unix zaman damgası (saniye olarak). |
name |
dize veya null | Asistanın adı. Uzunluk üst sınırı 256 karakterdir. |
description |
dize veya null | Asistanın açıklaması. Uzunluk üst sınırı 512 karakterdir. |
model |
Dize | Kullanılacak model dağıtım adının adı. |
instructions |
dize veya null | Yardımcının kullandığı sistem yönergeleri. Uzunluk üst sınırı 32768 karakterdir. |
tools |
dizi | Yardımcıda etkinleştirilen aracın listesi. Yardımcı başına en fazla 128 araç olabilir. Araçlar code_interpreter veya işlev türünde olabilir. Açıklama function en fazla 1.024 karakter olabilir. |
file_ids |
dizi | Bu yardımcıya eklenmiş dosya kimliklerinin listesi. Yardımcıya en fazla 20 dosya eklenebilir. Dosyalar oluşturma tarihlerine göre artan düzende sıralanır. |
metadata |
map | Bir nesneye eklenebilen 16 anahtar-değer çifti kümesi. Bu, nesne hakkında ek bilgileri yapılandırılmış biçimde depolamak için yararlı olabilir. Anahtarlar en fazla 64 karakter uzunluğunda ve değerler en fazla 512 karakter uzunluğunda olabilir. |
Yardımcı dosya nesnesi
| Alan | Tür | Veri Akışı Açıklaması |
|---|---|---|
id |
Dize | API uç noktalarında başvurulabilen tanımlayıcı. |
object |
Dize | Her zaman olan nesne türü assistant.file |
created_at |
integer | Yardımcı dosyasının oluşturulduğu zaman için Unix zaman damgası (saniye olarak). |
assistant_id |
Dize | Dosyanın eklendiği yardımcı kimliği. |
Geri Bildirim
Çok yakında: 2024 boyunca, içerik için geri bildirim mekanizması olarak GitHub Sorunları’nı kullanımdan kaldıracak ve yeni bir geri bildirim sistemiyle değiştireceğiz. Daha fazla bilgi için bkz. https://aka.ms/ContentUserFeedback.
Gönderin ve geri bildirimi görüntüleyin