integration

Fonksiyon Şeması

Fonksiyon şeması bir aracın makine tarafından okunabilir tanımıdır: adı, ne yaptığı ve parametreleri için hangi alanların zorunlu olduğunu ve hangi değerlere izin verildiğini içeren bir JSON Schema. Model, bir şeyi çağırıp çağırmayacağına ve nasıl çağıracağına karar vermeden önce bunu okur. Aynı anda iki iş yapar, bu yüzden dikkatle yazmaya değer. Açıklayıcı soru soramayan bir okura yönelik dokümantasyondur ve kodunuzun çalıştırmadan önce uygulayabileceği bir doğrulama sözleşmesidir. Enum'lar serbest metinden, zorunlu alanlar varsayılanlı isteğe bağlı alanlardan iyidir; yalnızca üç değeri anlamlı olan bir parametre bunu açıklamada değil şemada söylemelidir. Yaygın hata, teknik olarak geçerli ama anlamca belirsiz şemadır. 'query: string' modele iyi bir sorgunun neye benzediğini anlatmaz; 'query: string — fatura kalemlerinde tam metin arama, örn. "mart ayından ödenmemiş faturalar"' ise gerçekten karşılayabileceğiniz çağrılar üretir. Şemaları API gibi sürümleyin: anlamı sessizce değişen bir alan, eski anlamı öğrenmiş her promptu bozar.

İlgili terimler

Daha fazla Entegrasyonlar terimi