OpenAPI 3.0 spesifikasyonunda tanımlanan şekilde bir işlev bildiriminin yapılandırılmış gösterimi. İşlev adı ve parametreleri bu bildirime dahildir. Bu FunctionDeclaration
, model tarafından Araç olarak kullanılabilecek ve istemci tarafından çalıştırılabilen bir kod bloğunu temsil eder.
İmza:
export declare interface FunctionDeclaration
Özellikler
Özellik | Tür | Açıklama |
---|---|---|
description | dize | İsteğe bağlı. İşlevin açıklaması ve amacı. Model, işlevin nasıl çağrılacağına ve çağrılıp çağrılamayacağına karar vermek için bunu kullanır. |
name | dize | Çağrılacak işlevin adı. Harfle veya alt çizgiyle başlamalıdır. A-z, A-Z, 0-9 karakterli veya alt çizgi ve kısa çizgi içermeli ve maksimum 64 karakter uzunluğunda olmalıdır. |
parametreler | FunctionDeclarationSchema | İsteğe bağlı. Bu işlevin parametrelerini JSON Şema Nesnesi biçiminde açıklar. Open API 3.03 Parametre Nesnesini yansıtır. Parametre adları büyük/küçük harfe duyarlıdır. Parametresiz bir işlev için bu, ayarlanmadan bırakılabilir. |
FunctionDeclaration.açıklama
İsteğe bağlı. İşlevin açıklaması ve amacı. Model, işlevin nasıl çağrılacağına ve çağrılıp çağrılamayacağına karar vermek için bunu kullanır.
İmza:
description?: string;
İşlevDeclaration.name
Çağrılacak işlevin adı. Harfle veya alt çizgiyle başlamalıdır. A-z, A-Z, 0-9 karakterli veya alt çizgi ve kısa çizgi içermeli ve maksimum 64 karakter uzunluğunda olmalıdır.
İmza:
name: string;
FunctionDeclaration.parameters
İsteğe bağlı. Bu işlevin parametrelerini JSON Şema Nesnesi biçiminde açıklar. Open API 3.03 Parametre Nesnesini yansıtır. Parametre adları büyük/küçük harfe duyarlıdır. Parametresiz bir işlev için bu, ayarlanmadan bırakılabilir.
İmza:
parameters?: FunctionDeclarationSchema;