vertexai-preview package

Firebase Web SDK'sı için Vertex AI.

İşlevler

İşlev Açıklama
function(uygulama; ...)
getVertexAI(uygulama; seçenekler) Belirli bir uygulama için VertexAI örneği döndürür.
function(vertexAI, ...)
getGenerativeModel(vertexAI, modelParams, requestOptions) Çıkarım ve diğer işlevlere ilişkin yöntemleri içeren bir GenerativeModel sınıfı döndürür.

Sınıflar

Sınıf Açıklama
ChatSession Sohbet mesajı gönderilmesine olanak tanıyan, şimdiye kadar gönderilen ve alınan mesajların geçmişini depolayan ChatSession sınıfı.
ÜretkenModel Üretken model API'leri sınıfı.

Numaralandırmalar

Sıralama Açıklama
Engelleme nedeni İstemin engellenme nedeni.
Sonlandırma Nedeni Adayın bitirme nedeni.
İşlev Çağrı Modu
FunctionDeclarationSchemaType https://swagger.io/docs/specification/data-models/data-types/ tarafından tanımlanan OpenAPI veri türlerinin listesini içerir
HarmBlockMethod
HarmBlockThreshold Bir istemin veya adayın engelleneceği eşik.
HarmCategory İstemlerin veya adayların engellenmesine neden olacak zarar kategorileri.
HarmProbability (Harm Olasılığı) Bir istemin veya adayın bir zarar kategorisiyle eşleşme olasılığı.
Zararlı Önem Derecesi Zararın şiddet düzeyleri.

Arayüzler

Arayüz Açıklama
BaseParams Çeşitli yöntemler için temel parametreler.
Alıntı Tek bir alıntı.
AlıntıMeta Verileri 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ı.
Tarih_2 Protobuf google.type.Date
EnhancedGenerateContentResponse Yardımcı yöntemlerle sarmalanmış yanıt nesnesi.
Dosya Verileri Google Cloud Storage'a yüklenmiş bir dosyaya işaret eden veriler.
FileDataPart Bir parça FileData'yı temsil ediyorsa içerik bölümünün arayüzü
İşlev Çağrısı FunctionDeclaration.name ifadesini temsil eden bir dize ve parametreler ile bunların değerlerini içeren yapılandırılmış bir JSON nesnesi içeren modelden döndürülen, tahmini bir FunctionCall.
FunctionCallingConfig
FunctionCallPart İçerik, bir FunctionCall'u temsil ediyorsa içerik bölümünün arayüzü.
FunctionDeclaration 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.
FunctionDeclarationSchema FunctionDeclaration.parameters parametresine iletilen parametrelerin şeması.
FunctionDeclarationSchemaProperty Ş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, sistemin bilgi ve modelin kapsamı dışında bir işlem veya işlem kümesi gerçekleştirmek için harici sistemlerle etkileşim kurmasını sağlayan bir kod parçasıdır.
İşlev Yanıtı FunctionDeclaration.name öğesini temsil eden bir dize içeren FunctionCall'dan elde edilen sonuç çıkışı ve işlevden herhangi bir çıkışı içeren yapılandırılmış bir JSON nesnesi, modelin bağlamı olarak kullanılır. Bu değer, model tahminine dayalı olarak yapılan bir FunctionCall sonucunu içermelidir.
FunctionResponsePart Bölüm FunctionResponse'u temsil ediyorsa içerik bölümünün arayüzü.
GenerateContentCandidate GenerateContentResponse kapsamında döndürülen adaylar.
GenerateContentRequest İstek GenerativeModel.generateContent() aracılığıyla gönderildi
GenerateContentResponse GenerativeModel.generateContent() ve GenerativeModel.generateContentStream() kaynağından alınan bağımsız yanıt. generateContentStream(), akış tamamlanana kadar her bir parçada bir tane döndürür.
GenerateContentResult (Oluşturulan İçerik Sonuç) 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. Gelen parçaları almak için stream üzerinde yineleme yapın ve/veya akış tamamlandığında toplu yanıt almak için response sözünü kullanın.
GenerationConfig İçerikle ilgili istekler için yapılandırma seçenekleri
GenerativeContentBlob Resim gönderme arayüzü.
Temel İlişkilendirme
GroundingMetadata Temelleme etkinleştirildiğinde istemciye meta veri döndürüldü.
InlineDataPart Bir resim bir resmi temsil ediyorsa içerik bölümünün arayüzü.
ModelParams getGenerativeModel() parametresine iletilen parametreler.
PromptFeedback İstem engellendiyse bu alan, blockReason ve ilgili safetyRatings ile doldurulur.
RequestOptions (İstekSeçenekleri) getGenerativeModel() parametresine iletilen parametreler.
RetrievedContextAttribution
SafetyRating GenerateContentCandidate ile ilişkili güvenlik derecelendirmesi
GüvenlikAyarı İstek parametrelerinin bir parçası olarak gönderilebilen güvenlik ayarı.
Segment
StartChatParams GenerativeModel.startChat() parametreleri.
TextPart İçerik, metin dizesini temsil eden içerik bölümünün arayüzü.
Araç Yapılandırması 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 için Vertex AI SDK'sının bir örneği.
VertexAIOptions Firebase için Vertex AI SDK'sını ilk kullanıma hazırlarken sunulan seçenekler.
VideoMeta Verileri Giriş video içeriğini açıklar.
WebAttribution

Değişkenler

Değişken Açıklama
OLASI_ROLLER Olası roller.

Takma Adları Yazın

Takma Ad Yazın Açıklama
Bölüm İçerik bölümü: Metin, resim/video veya işlev çağrısı/yanıt bölümü 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.

Functions(uygulama; ...)

getVertexAI(uygulama; seçenekler)

Belirli bir uygulama için VertexAI örneği döndürür.

İmza:

export declare function getVertexAI(app?: FirebaseApp, options?: VertexAIOptions): VertexAI;

Parametreler

Parametre Tür Açıklama
uygulama FirebaseApp Kullanılacak FirebaseApp.
seçenekler VertexAIOptions

İadeler:

VertexAI

fonksiyon(vertexAI; ...)

getGenerativeModel(vertexAI, modelParams, requestOptions)

Çıkarım ve diğer işlevlere ilişkin yöntemleri içeren bir GenerativeModel sınıfı döndürür.

İmza:

export declare function getGenerativeModel(vertexAI: VertexAI, modelParams: ModelParams, requestOptions?: RequestOptions): GenerativeModel;

Parametreler

Parametre Tür Açıklama
vertexAI VertexAI
modelParams ModelParams
istekSeçenekleri RequestOptions (İstekSeçenekleri)

İadeler:

ÜretkenModel

OLASI_ROLLER

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 bölümü 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

Sıralama Üyeleri

Üye Değer Açıklama
BLOCKED_REASON_UNSPECIFIED "BLOCKED_REASON_UNSPECIFIED"
DİĞER "OTHER"
GÜVENLİK "SAFETY"

Son Nedeni

Adayın bitirme nedeni.

İmza:

export declare enum FinishReason

Sıralama Üyeleri

Üye Değer Açıklama
FINISH_REASON_UNSPECIFIED "FINISH_REASON_UNSPECIFIED"
MAK_TOKENS "MAX_TOKENS"
DİĞER "OTHER"
TESLİM "RECITATION"
GÜVENLİK "SAFETY"
DURDUR "STOP"

İşlev Çağrı Modu

İmza:

export declare enum FunctionCallingMode

Sıralama Üyeleri

Üye Değer Açıklama
TÜM FİYATLAR "ANY"
AUTO "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

Sıralama Ü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" Sayı türü.
NESNE "OBJECT" Nesne türü.
DİZE "STRING" Dize türü.

Zarar Bloğu Yöntemi

İmza:

export declare enum HarmBlockMethod

Sıralama Üyeleri

Üye Değer Açıklama
HARM_ENGELLE_YÖNTEM_BELİRTİLMEMİŞ "HARM_BLOCK_METHOD_UNSPECIFIED"
OLASILIK "PROBABILITY"
ÖNEM SAYISI "SEVERITY"

Zarar BloğuEşi

Bir istemin veya adayın engelleneceği eşik.

İmza:

export declare enum HarmBlockThreshold

Sıralama Üyeleri

Üye Değer Açıklama
ENGELLE_DÜŞÜK_AND_YUKARIDA "BLOCK_LOW_AND_ABOVE"
ENGELLE_ORTA_VE_ÜSTÜNDE "BLOCK_MEDIUM_AND_ABOVE"
ENGELLE_YOK "BLOCK_NONE"
ENGELLE_ONLY_YÜKSEK "BLOCK_ONLY_HIGH"
HARM_BLOCK_THRESHOLD_UNSPECIFIED "HARM_BLOCK_THRESHOLD_UNSPECIFIED"

Zarar Kategorisi

İstemlerin veya adayların engellenmesine neden olacak zarar kategorileri.

İmza:

export declare enum HarmCategory

Sıralama Üyeleri

Üye Değer Açıklama
HARM_KATEGORİ_TEHLİKELİ_İÇERİK "HARM_CATEGORY_DANGEROUS_CONTENT"
HARM_KATEGORİ_YARARLANMA "HARM_CATEGORY_HARASSMENT"
HARM_CATEGORY_HATE_KONUŞMASI "HARM_CATEGORY_HATE_SPEECH"
HARM_KATEGORİ_SEXUALLY_EXPLICIT "HARM_CATEGORY_SEXUALLY_EXPLICIT"
HARM_KATEGORİ_BELİRTİLMEMİŞ "HARM_CATEGORY_UNSPECIFIED"

Zarar olasılığı

Bir istemin veya adayın bir zarar kategorisiyle eşleşme olasılığı.

İmza:

export declare enum HarmProbability

Sıralama Üyeleri

Üye Değer Açıklama
HARM_PROBABILITY_UNSPECIFIED "HARM_PROBABILITY_UNSPECIFIED"
YÜKSEK "HIGH"
DÜŞÜK "LOW"
ORTA "MEDIUM"
İHMAL EDİLMEMİŞ "NEGLIGIBLE"

Zarar Verme Şiddeti

Zararın şiddet düzeyleri.

İmza:

export declare enum HarmSeverity

Sıralama Üyeleri

Üye Değer Açıklama
HARM_SEVERITY_YÜKSEK "HARM_SEVERITY_HIGH"
HARM_SEVERITY_LOW "HARM_SEVERITY_LOW"
HARM_SEVERITY_ORTA "HARM_SEVERITY_MEDIUM"
HARM_SEVERITY_NEGLIGIBLE "HARM_SEVERITY_NEGLIGIBLE"
HARM_SEVERITY_UNSPECIFIED (BELİRTİLMEMİŞ) "HARM_SEVERITY_UNSPECIFIED"