Yardımcılar API'leri (Önizleme) iş parçacıkları başvurusu

  • Makale

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 derecelendirme ve sorguyu 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, öbeklere ayrılır, eklenir ve aramaya hazır hale getirilir. Vektör depolarının birden fazla yardımcı ve iş parçacığı arasında kullanılabilmesi, dosya yönetimini ve faturalamayı basitleştirir.
  • Belirli bir çalıştırmada tool_choice belirli 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.

İş parçacığı oluşturma

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

bir iş parçacığı oluşturun.

İstek gövdesi

Adı Tür Zorunlu Açıklama
messages dizi İsteğe bağlı İş parçacığını başlatacak iletilerin listesi.
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.
tool_resources object İsteğe bağlı Bu iş parçacığında yardımcının araçlarının kullanımına sunulan bir kaynak kümesi. Kaynaklar araç türüne özeldir. Örneğin, code_interpreter araç bir dosya kimlikleri listesi gerektirirken file_search , araç vektör deposu kimliklerinin listesini gerektirir.

tool_resources özellikleri

code_interpreter

Adı Tür Açıklama Varsayılan
file_ids dizi code_interpreter aracının kullanımına sunulan dosya kimliklerinin listesi. Araçla ilişkili en fazla 20 dosya olabilir. []

file_search

Adı Tür Açıklama Varsayılan
vector_store_ids dizi Bu iş parçacığına bağlı vektör deposu. İş parçacığına en fazla 1 vektör deposu eklenebilir. []
vector_stores dizi file_ids ile bir vektör deposu oluşturmak ve bunu bu iş parçacığına eklemek için bir yardımcı. İş parçacığına en fazla 1 vektör deposu eklenebilir. []

Döndürülenler

İş parçacığı nesnesi.

Örnek: iş parçacığı isteği oluşturma

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)

İş parçacığını alma

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

bir iş parçacığı alır.

Yol parametreleri

Parametre Türü Zorunlu Açıklama
thread_id Dize Zorunlu Alınacak iş parçacığının kimliği

Döndürülenler

Belirtilen kimlikle eşleşen iş parçacığı nesnesi.

Örnek: iş parçacığı isteği alma

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)

İş parçacığını değiştirme

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

bir iş parçacığını değiştirir.

Yol Parametreleri

Parametre Türü Zorunlu Açıklama
thread_id Dize Zorunlu Değiştirebileceğiniz iş parçacığının kimliği.

İstek gövdesi

Adı Tür Zorunlu Açıklama
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.
tool_resources object İsteğe bağlı Bu iş parçacığında yardımcının araçlarının kullanımına sunulan bir kaynak kümesi. Kaynaklar araç türüne özeldir. Örneğin, code_interpreter araç bir dosya kimlikleri listesi gerektirirken file_search , araç vektör deposu kimliklerinin listesini gerektirir.

Döndürülenler

Belirtilen kimlikle eşleşen değiştirilmiş iş parçacığı nesnesi .

Örnek: iş parçacığı isteğini değiştirme

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)

İş parçacığını silme

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

bir iş parçacığını silin.

Yol Parametreleri

Parametre Türü Zorunlu Açıklama
thread_id Dize Zorunlu Silinecek iş parçacığının kimliği.

Döndürülenler

Silme durumu.

Örnek: iş parçacığı isteğini silme

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)

İş parçacığı nesnesi

Alan Tür Veri Akışı Açıklaması
id Dize API uç noktalarında başvurulabilen tanımlayıcı.
object Dize Her zaman iş parçacığı olan nesne türü.
created_at integer İş parçacığının oluşturulduğu zaman için Unix zaman damgası (saniye olarak).
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.