Firebase Web SDK'sında Vertex AI.
İşlevler
İşlev | Açıklama |
---|---|
fonksiyon(uygulama, ...) | |
getVertexAI(uygulama; seçenekler) | Belirtilen uygulama için VertexAI örneğini döndürür. |
function(vertexAI, ...) | |
getGenerativeModel(vertexAI, modelParams, requestOptions) | Çıkarım ve diğer işlevlerle ilgili yöntemler içeren bir GenerativeModel sınıfını döndürür. |
Sınıflar
Sınıf | Açıklama |
---|---|
ChatOturum | Sohbet mesajı göndermeyi sağlayan ve o ana kadar gönderilen ve alınan mesajların geçmişini saklayan ChatSession sınıfı. |
ÜreticiModel | Üretken model API'leri sınıfı. |
VertexAIHatası | Firebase SDK'sında Vertex AI hata sınıfı. |
Numaralandırmalar
Numaralandırma | Açıklama |
---|---|
BlockNedeni | İstemin engellenme nedeni. |
Bitiş Nedeni | Bir adayın bitirme nedeni. |
İşlev ÇağrısıModu | |
FunctionDeclarationSchemaType | https://swagger.io/docs/specification/data-models/data-types/ tarafından tanımlanan OpenAPI veri türlerinin listesini içerir |
HarmBlockMethod | |
HarmBlockThreshold | Üstünde bir istemin veya adayın engelleneceği eşik. |
Zarar Kategorisi | İstemlerin veya adayların engellenmesine neden olabilecek zarar kategorileri |
Zararlı olma olasılığı | Bir istemin veya adayın zarar verici bir kategoriyle eşleşme olasılığı. |
Zararlı İçerik | Zarar veren önem düzeyleri. |
VertexAIHata Kodu | VertexAIError'da bulunabilecek standartlaştırılmış hata kodları. |
Arayüzler
Arayüz | Açıklama |
---|---|
BaseParams | Çeşitli yöntemler için temel parametreler. |
Alıntı | Tek bir alıntı. |
Alıntı Meta Verisi | GenerateContentCandidate üzerinde bulunabilecek alıntı meta verileri. |
Content | Hem istemler hem de yanıt adayları için içerik türü. |
CountTokensRequest | GenerativeModel.countTokens() çağrısına ilişkin parametreler |
CountTokensResponse | GenerativeModel.countTokens() çağrısının yanıtı. |
Özel HataVerisi | Kötü bir HTTP yanıtından gelen verileri içeren ayrıntılar nesnesi. |
Tarih_2 | Protobuf google.type.Date |
AdvancedGenerateContentResponse | Yardımcı yöntemlerle sarmalanmış yanıt nesnesi. |
ErrorDetails | Hata yanıtında yer alabilecek ayrıntılar nesnesi. |
Dosya Verileri | Google Cloud Storage'a yüklenmiş bir dosyaya işaret eden veriler. |
DosyaVeriBölümü | Parça FileData'yı temsil ediyorsa içerik bölümü arayüzü |
FunctionCall | FunctionDeclaration.name öğesini temsil eden bir dizenin yanı sıra parametreleri ve bunların değerlerini içeren yapılandırılmış bir JSON nesnesini içeren modelden döndürülen, tahmin edilen bir FunctionCall. |
FunctionCallingConfig | |
İşlev ÇağrısıBölümü | Parça bir FunctionCall öğesini temsil ediyorsa içerik kısmı arayüzü. |
İşlev Beyanı | OpenAPI 3.0 spesifikasyonu ile tanımlanan şekilde bir işlev bildiriminin yapılandırılmış temsili. Bu bildirime işlev adı ve parametreler de dahildir. Bu FunctionDeclaration , model tarafından Araç olarak kullanılabilen ve istemci tarafından yürütülen bir kod bloğunu temsil eder. |
FunctionDeclarationSchema | FunctionDeclaration.parameters parametresine iletilen parametreler için şema. |
FunctionDeclarationSchemaMülk | Şema, giriş/çıkış verilerinin biçimini tanımlamak için kullanılır. Bir OpenAPI 3.0 şema nesnesinin seçili alt kümesini temsil eder. İleride gerekirse daha fazla alan eklenebilir. |
FunctionDeclarationsTool | FunctionDeclarationsTool , modelin bilgisi ve kapsamı dışında bir işlem veya işlem kümesi gerçekleştirmek için sistemin harici sistemlerle etkileşime girmesini sağlayan bir kod parçasıdır. |
İşlev Yanıtı | FunctionDeclaration.name işlevini temsil eden bir dizeyi ve işlevin herhangi bir çıkışını içeren yapılandırılmış bir JSON nesnesini içeren FunctionCall çıktısı, modelin bağlamı olarak kullanılır. Bu, model tahminine dayalı olarak yapılan bir FunctionCall sonucunu içermelidir. |
İşlevYanıtıBölümü | Parça FunctionResponse öğesini temsil ediyorsa içerik kısmı arayüzü. |
GenerateContentCandidate | Bir aday, GenerateContentResponse işleminin bir parçası olarak geri döndü. |
GenerateContentRequest | İstek GenerativeModel.generateContent() aracılığıyla gönderildi |
GenerateContentResponse | GenerativeModel.generateContent() ve GenerativeModel.generateContentStream() tarafından oluşturulan bireysel yanıt. generateContentStream() , akış tamamlanana kadar her bir yığında bir tane döndürecektir. |
GenerateContentResult | GenerativeModel.generateContent() çağrısından döndürülen sonuç nesnesi. |
GenerateContentStreamResult | GenerativeModel.generateContentStream() çağrısından döndürülen sonuç nesnesi. Parçalar geldikçe almak için stream üzerinde yineleme gerçekleştirin ve/veya akış tamamlandığında toplu yanıt almak için response taahhüdünü kullanın. |
GenerationConfig | İçerikle ilgili istekler için yapılandırma seçenekleri |
Üretkenİçerik Blobu | Resim gönderme arayüzü. |
İlişkilendirmeyi temel alma | |
GroundingMetadata | Topraklama etkinleştirildiğinde istemciye döndürülen meta veriler. |
Satır İçiVeriBölümü | Bölüm bir resmi temsil ediyorsa içerik bölümünün arayüzü. |
ModelParams | getGenerativeModel() işlevine aktarılan parametreler. |
PromptFeedback | İstem engellendiyse bu alan blockReason ve ilgili safetyRatings ile doldurulur. |
RequestOptions (İstek Seçenekleri) | getGenerativeModel() işlevine aktarılan parametreler. |
RetrievedContextAttribution | |
GüvenlikDerecesi | GenerateContentCandidate ile ilişkili güvenlik derecelendirmesi |
Güvenlik Ayarı | İstek parametrelerinin bir parçası olarak gönderilebilecek güvenlik ayarı. |
Segment | |
StartChatParams | GenerativeModel.startChat() için parametreler. |
MetinBölümü | Bölüm bir metin dizesini temsil ediyorsa içerik bölümü arayüzü. |
ToolConfig | Araç yapılandırması. Bu yapılandırma, istekte sağlanan tüm araçlar için paylaşılır. |
KullanımMeta Verileri | GenerateContentResponse ile ilgili kullanım meta verileri. |
VertexAI | Firebase SDK'daki Vertex AI örneği. |
VertexAIOptions | Firebase SDK'sında Vertex AI'ı başlatma seçenekleri |
VideoMeta Verileri | Girilen video içeriğini açıklar. |
Web İlişkilendirmesi |
Değişkenler
Değişken | Açıklama |
---|---|
OLASI_OLLAR | Olası roller. |
Tür Takma Adları
Takma Ad yazın | Açıklama |
---|---|
Bölüm | İçerik bölümü - metin, resim/video veya işlev çağrısı/yanıt parçası türlerini içerir. |
Rol | Rol, içeriğin yapımcısıdır. |
Araç | Modelin harici bilgilere erişmek için çağırabileceği bir aracı tanımlar. |
function(uygulama; ...)
getVertexAI(uygulama; seçenekler)
Belirtilen uygulama için VertexAI örneğini döndürür.
İmza:
export declare function getVertexAI(app?: FirebaseApp, options?: VertexAIOptions): VertexAI;
Parametreler
Parametre | Tür | Açıklama |
---|---|---|
uygulama | FirebaseUygulaması | Kullanılacak FirebaseApp. |
seçenekler | VertexAIOptions |
Şunu döndürür:
function(vertexAI; ...)
getGenerativeModel(vertexAI, modelParams, requestOptions)
Çıkarım ve diğer işlevlerle ilgili yöntemler içeren bir GenerativeModel sınıfını döndürür.
İmza:
export declare function getGenerativeModel(vertexAI: VertexAI, modelParams: ModelParams, requestOptions?: RequestOptions): GenerativeModel;
Parametreler
Parametre | Tür | Açıklama |
---|---|---|
köşe yapay zeka | VertexAI | |
modelParam'lar | ModelParams | |
requestOptions | RequestOptions (İstek Seçenekleri) |
Şunu döndürür:
OLASI_OLLAR
Olası roller.
İmza:
POSSIBLE_ROLES: readonly ["user", "model", "function", "system"]
Bölüm
İçerik bölümü - metin, resim/video veya işlev çağrısı/yanıt parçası türlerini içerir.
İmza:
export declare type Part = TextPart | InlineDataPart | FunctionCallPart | FunctionResponsePart | FileDataPart;
Rol
Rol, içeriğin yapımcısıdır.
İmza:
export declare type Role = (typeof POSSIBLE_ROLES)[number];
Araç
Modelin harici bilgilere erişmek için çağırabileceği bir aracı tanımlar.
İmza:
export declare type Tool = FunctionDeclarationsTool;
Engelleme Nedeni
İstemin engellenme nedeni.
İmza:
export declare enum BlockReason
Numaralandırma Üyeleri
Üye | Değer | Açıklama |
---|---|---|
BLOCKED_REASON_UNSPECIFIED | "BLOCKED_REASON_UNSPECIFIED" |
|
DİĞER | "OTHER" |
|
GÜVENLİK | "SAFETY" |
Bitiş Nedeni
Bir adayın bitirme nedeni.
İmza:
export declare enum FinishReason
Numaralandırma Üyeleri
Üye | Değer | Açıklama |
---|---|---|
FINISH_REASON_UNSPECIFIED (SONA ERDİ) | "FINISH_REASON_UNSPECIFIED" |
|
MAK_TOKENS | "MAX_TOKENS" |
|
DİĞER | "OTHER" |
|
TALEP | "RECITATION" |
|
GÜVENLİK | "SAFETY" |
|
DURDUR | "STOP" |
İşlev ÇağrısıModu
İmza:
export declare enum FunctionCallingMode
Numaralandırma Üyeleri
Üye | Değer | Açıklama |
---|---|---|
TÜM FİYATLAR | "ANY" |
|
OTOMATİK | "AUTO" |
|
MOD_BELİRTİLMEMİŞ | "MODE_UNSPECIFIED" |
|
YOK | "NONE" |
FunctionDeclarationSchemaType
https://swagger.io/docs/specification/data-models/data-types/ tarafından tanımlanan OpenAPI veri türlerinin listesini içerir
İmza:
export declare enum FunctionDeclarationSchemaType
Numaralandırma Üyeleri
Üye | Değer | Açıklama |
---|---|---|
DİZİ | "ARRAY" |
Dizi türü. |
BOOLE | "BOOLEAN" |
Boole türü. |
TAM SAYI | "INTEGER" |
Tam sayı türü. |
SAYI | "NUMBER" |
Numara türü. |
NESNE | "OBJECT" |
Nesne türü. |
DİZE | "STRING" |
Dize türü. |
HarmBlockMethod
İmza:
export declare enum HarmBlockMethod
Numaralandırma Üyeleri
Üye | Değer | Açıklama |
---|---|---|
HARM_ENGELLEME_YÖNTEMİ_BELİRTİLMEDİ | "HARM_BLOCK_METHOD_UNSPECIFIED" |
|
OLASILIK | "PROBABILITY" |
|
ÖNEM | "SEVERITY" |
HarmBlockThreshold
Üstünde bir istemin veya adayın engelleneceği eşik.
İmza:
export declare enum HarmBlockThreshold
Numaralandırma Üyeleri
Üye | Değer | Açıklama |
---|---|---|
ENG_DÜŞÜK_VE_YUKARI | "BLOCK_LOW_AND_ABOVE" |
|
ENG_ORTA_VE_YUKARI | "BLOCK_MEDIUM_AND_ABOVE" |
|
ENGELLE_YOK | "BLOCK_NONE" |
|
ENGELLEME_YALNIZCA_YÜKSEK | "BLOCK_ONLY_HIGH" |
|
HARM_ENGELLEME_EŞİKASI_BELİRTİLMEDİ | "HARM_BLOCK_THRESHOLD_UNSPECIFIED" |
Zarar Kategorisi
İstemlerin veya adayların engellenmesine neden olabilecek zarar kategorileri
İmza:
export declare enum HarmCategory
Numaralandırma Üyeleri
Üye | Değer | Açıklama |
---|---|---|
HARM_CATEGORY_DANGEROUS_CONTENT | "HARM_CATEGORY_DANGEROUS_CONTENT" |
|
HARM_CATEGORY_HARASSMENT | "HARM_CATEGORY_HARASSMENT" |
|
HARM_CATEGORY_HATE_SPEECH | "HARM_CATEGORY_HATE_SPEECH" |
|
HARM_CATEGORY_SEXUALLY_EXPLICIT | "HARM_CATEGORY_SEXUALLY_EXPLICIT" |
|
HARM_CATEGORY_UNSPECIFIED (BELİRTİLMEMİŞ) | "HARM_CATEGORY_UNSPECIFIED" |
Zarar Verme Olasılığı
Bir istemin veya adayın zarar verici bir kategoriyle eşleşme olasılığı.
İmza:
export declare enum HarmProbability
Numaralandırma Üyeleri
Üye | Değer | Açıklama |
---|---|---|
HARM_PROBABILITY_UNSPECIFIED (BELİRTİLMEMİŞ) | "HARM_PROBABILITY_UNSPECIFIED" |
|
YÜKSEK | "HIGH" |
|
DÜŞÜK | "LOW" |
|
ORTA | "MEDIUM" |
|
İHMAL | "NEGLIGIBLE" |
Zararın şiddeti
Zarar veren önem düzeyleri.
İmza:
export declare enum HarmSeverity
Numaralandırma Üyeleri
Üye | Değer | Açıklama |
---|---|---|
HARM_SEVERITY_YÜKSEK | "HARM_SEVERITY_HIGH" |
|
HARM_SEVERITY_DÜŞÜK | "HARM_SEVERITY_LOW" |
|
HARM_SEVERITY_ORTA | "HARM_SEVERITY_MEDIUM" |
|
HARM_SEVERITY_NEGLIGIBLE (HARM_SEVERITY_NEGLIGIBLE) | "HARM_SEVERITY_NEGLIGIBLE" |
|
HARM_SEVERITY_UNSPECIFIED (BELİRTİLMEMİŞ) | "HARM_SEVERITY_UNSPECIFIED" |
VertexAIHata Kodu
VertexAIError'da bulunabilecek standartlaştırılmış hata kodları.
İmza:
export declare const enum VertexAIErrorCode
Numaralandırma Üyeleri
Üye | Değer | Açıklama |
---|---|---|
HATA | "error" |
Genel bir hata oluştu. |
FETCH_ERROR | "fetch-error" |
Getirme işlemi gerçekleştirilirken bir hata oluştu. |
GEÇERSİZ_İÇERİK | "invalid-content" |
İçerik nesnesiyle ilişkili hata. |
API_YOK | "no-api-key" |
Firebase API anahtarının eksik olması nedeniyle hata oluştu. |
MODEL YOK | "no-model" |
Başlatma sırasında bir model adının belirtilmemesi nedeniyle hata oluştu. |
PROJE_KİMLİĞİ YOK | "no-project-id" |
Proje kimliği eksik olduğundan hata oluştu. |
PARSE_BAŞARISIZ | "parse-failed" |
Ayrıştırılırken bir hata oluştu. |
İSTEK_HATASI | "request-error" |
Bir istekte hata oluştu. |
TEPKİ_HATASI | "response-error" |
Yanıtta bir hata oluştu. |