vertexai-preview package

pakiet internetowy Vertex AI dla Firebase.

Funkcje

Funkcja Opis
funkcja(aplikacja, ...)
getVertexAI(aplikacja, opcje) Zwraca instancję VertexAI danej aplikacji.
funkcja(vertexAI, ...)
getGenerativeModel(vertexAI, modelParams, requestOptions) Zwraca klasę GenerativeModel z metodami wnioskowania i innych funkcji.

Zajęcia

Klasa Opis
Sesja czatu Zajęcia ChatSession, które umożliwiają wysyłanie wiadomości na czacie oraz przechowywanie dotychczasowej historii wysłanych i odebranych wiadomości.
GenerativeModel Klasa interfejsów API modelu generatywnego.

Wyliczenia

Wyliczenie Opis
BlockReason (Powód zablokowania) Przyczyna zablokowania promptu.
FinishReason (Powód zakończenia) Przyczyna zakończenia wyboru kandydata.
TrybWywołania funkcji
FunctionDefinitionationSchemaType, Zawiera listę typów danych OpenAPI zdefiniowanych na stronie https://swagger.io/docs/specification/data-models/data-types/
HarmBlockMethod
HarmBlockThreshold Próg blokowania prośby lub kandydata.
Kategoria szkód Kategorie szkodliwych treści, które mogłyby powodować blokowanie podpowiedzi lub kandydatów.
Prawdopodobieństwo szkodliwości Prawdopodobieństwo, że prompt lub kandydat pasują do kategorii zagrożenia.
Szkodliwość Poziomy nasilenia szkód.

Interfejsy

Interfejs Opis
Elementy podstawowe Parametry podstawowe wielu metod.
Cytowania Pojedyncze cytaty.
CitationMetadata Metadane cytowania, które można znaleźć w elemencie GenerateContentCandidate.
Content Typ treści dla promptów i kandydatów na odpowiedzi.
CountTokensRequest (Żądanie liczby tokenów) Parametry do wywoływania GenerativeModel.countTokens()
CountTokensResponse (Odpowiedź CountTokensResponse) Odpowiedź wywołana przez wywołanie GenerativeModel.countTokens().
Data_2 Protobuf google.type.Date
EnhancedGenerateContentResponse Obiekt odpowiedzi z metodami pomocniczymi.
FileData (Dane pliku) Dane wskazujące plik przesłany do Google Cloud Storage.
FileDataPart (Część danych pliku) Interfejs części z treścią, jeśli część reprezentuje FileData
Wywołanie funkcji Prognozowana funkcja FunctionCall została zwrócona przez model zawierający ciąg znaków reprezentujący element FunctionDefinition.name oraz uporządkowany obiekt JSON zawierający parametry i ich wartości.
FunctionCallingConfig (Konfiguracja wywoływania funkcji)
FunkcjaWywołania funkcji Interfejs treści, jeśli część reprezentuje FunctionCall.
Deklaracja funkcji Uporządkowana deklaracja funkcji zgodnie z definicją w specyfikacji OpenAPI 3.0. Deklaracja zawiera nazwę funkcji i jej parametry. Ten element FunctionDeclaration to blok kodu, którego model może użyć jako narzędzia i wykonać go przez klienta.
FunctionDeklaracjaSchema Schemat parametrów przekazanych do FunctionDefinition.parameters.
FunctionIndexationSchemaProperty Schemat służy do określania formatu danych wejściowych i wyjściowych. Reprezentuje wybrany podzbiór obiektu schematu OpenAPI 3.0. W przyszłości można dodać więcej pól.
FunctionDefinitionationsTool FunctionDeclarationsTool to fragment kodu, który umożliwia systemowi interakcję z systemami zewnętrznymi w celu wykonania działania lub zestawu działań wykraczających poza wiedzę i zakres modelu.
FunctionResponse Wynik z funkcji FunctionCall, który zawiera ciąg znaków reprezentujący element FunctionDefinition.name, oraz uporządkowany obiekt JSON zawierający wszelkie dane wyjściowe z funkcji są używane jako kontekst dla modelu. Powinien zawierać wynik wywołania FunctionCall na podstawie prognozy modelu.
Część_funkcji_funkcji Interfejs części z treścią, jeśli jej część reprezentuje FunctionResponse.
GenerateContentCandidate Kandydat zwrócony w ramach GenerateContentResponse.
GenerateContentRequest (Wygeneruj żądanie treści) Żądanie wysłane przez metodę GenerativeModel.generateContent()
GenerateContentResponse Indywidualna odpowiedź z metod GenerativeModel.generateContent() i GenerativeModel.generateContentStream(). generateContentStream() będzie zwracać po jednej w każdym fragmencie, dopóki strumień nie zostanie ukończony.
GenerateContentResult Obiekt wyniku zwrócony przez wywołanie funkcji GenerativeModel.generateContent().
GenerateContentStreamResult Obiekt wyniku zwrócony przez wywołanie funkcji GenerativeModel.generateContentStream(). Przesyłaj iteracje ponad stream, aby pobierać fragmenty na bieżąco, lub użyj funkcji response, aby uzyskać zagregowaną odpowiedź po zakończeniu strumienia.
GenerationConfig (GenerationConfig) Opcje konfiguracji żądań związanych z treścią
GenerativeContentBlob, Interfejs do wysyłania obrazu.
Atrybucja oparta na danych
groundingMetadata, Metadane zwracane klientowi, gdy włączone jest umocowanie.
Wbudowana część danych Interfejs części z treścią, jeśli część reprezentuje obraz.
ModelParams Parametry przekazane do funkcji getGenerativeModel().
PromptFeedback Jeśli prompt został zablokowany, w tym miejscu pojawi się wartość blockReason i odpowiednia wartość safetyRatings.
RequestOptions Parametry przekazane do funkcji getGenerativeModel().
Pobrane informacje o kontekstie
Bezpieczeństwo Ocena bezpieczeństwa powiązana z elementem GenerateContentCandidate
Ustawienia bezpieczeństwa Ustawienie bezpieczeństwa, które może być wysyłane jako część parametrów żądania.
Segment
StartChatParams Parametry funkcji GenerativeModel.startChat().
TextPart Interfejs części z treścią, jeśli część reprezentuje ciąg znaków.
Konfiguracja Narzędzia Konfiguracja narzędzia. Ta konfiguracja jest udostępniana wszystkich narzędzi wymienionych w żądaniu.
UsageMetadata, Metadane użytkowania dotyczące GenerateContentResponse.
VertexAI Instancja pakietu SDK Vertex AI dla Firebase.
Opcje VertexAI Opcje inicjowania pakietu SDK Vertex AI dla Firebase.
Metadane filmu Opisuje wejściowe treści wideo.
Atrybucja w internecie

Zmienne

Zmienna Opis
POSSIBLE_ROLES Możliwe role.

Typ aliasów

Typ aliasu Opis
Część Część z treścią – zawiera tekst, obraz/film lub typ części wywołania/odpowiedzi funkcji.
Role Rola to producent treści.
Narzędzie Definiuje narzędzie, które model może wywołać, aby uzyskać dostęp do wiedzy zewnętrznej.

funkcja(aplikacja, ...)

getVertexAI(aplikacja; opcje)

Zwraca instancję VertexAI danej aplikacji.

Podpis:

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

Parametry

Parametr Typ Opis
aplikacja Aplikacja Firebase Aplikacja Firebase, której chcesz użyć.
opcje Opcje VertexAI

Zwroty:

VertexAI

funkcja(vertexAI, ...)

getGenerativeModel(vertexAI, modelParams, requestOptions)

Zwraca klasę GenerativeModel z metodami wnioskowania i innych funkcji.

Podpis:

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

Parametry

Parametr Typ Opis
vertexAI VertexAI
parametry modelu ModelParams
requestOptions RequestOptions

Zwroty:

GenerativeModel

POSSIBLE_ROLES

Możliwe role.

Podpis:

POSSIBLE_ROLES: readonly ["user", "model", "function", "system"]

Część

Część z treścią – zawiera tekst, obraz/film lub typ części wywołania/odpowiedzi funkcji.

Podpis:

export declare type Part = TextPart | InlineDataPart | FunctionCallPart | FunctionResponsePart | FileDataPart;

Rola

Rola to producent treści.

Podpis:

export declare type Role = (typeof POSSIBLE_ROLES)[number];

Narzędzie

Definiuje narzędzie, które model może wywołać, aby uzyskać dostęp do wiedzy zewnętrznej.

Podpis:

export declare type Tool = FunctionDeclarationsTool;

Przyczyna zablokowania

Przyczyna zablokowania promptu.

Podpis:

export declare enum BlockReason

Członkowie wyliczenia

Użytkownik Wartość Opis
BLOCKED_REASON_UNSPECIFIED "BLOCKED_REASON_UNSPECIFIED"
INNE "OTHER"
BEZPIECZEŃSTWO "SAFETY"

Przyczyna zakończenia

Przyczyna zakończenia wyboru kandydata.

Podpis:

export declare enum FinishReason

Członkowie wyliczenia

Użytkownik Wartość Opis
FINISH_REASON_UNSPECIFIED (POWÓD_ZAKOŃCZENIA) "FINISH_REASON_UNSPECIFIED"
MAX_TOKENS "MAX_TOKENS"
INNE "OTHER"
RECYTACJA "RECITATION"
BEZPIECZEŃSTWO "SAFETY"
PRZERWIJ "STOP"

TrybWywołania funkcji

Podpis:

export declare enum FunctionCallingMode

Członkowie wyliczenia

Użytkownik Wartość Opis
DOWOLNA "ANY"
AUTOMATYCZNIE "AUTO"
MODE_UNSPECIFIED "MODE_UNSPECIFIED"
BRAK "NONE"

Typ_deklaracji_funkcji

Zawiera listę typów danych OpenAPI zdefiniowanych na stronie https://swagger.io/docs/specification/data-models/data-types/

Podpis:

export declare enum FunctionDeclarationSchemaType

Członkowie wyliczenia

Użytkownik Wartość Opis
ARRAFIKACJA "ARRAY" Typ tablicy.
WARTOŚĆ LOGICZNA "BOOLEAN" Typ wartości logicznej.
LICZBA CAŁKOWITA "INTEGER" Typ liczby całkowitej.
LICZBA "NUMBER" Typ liczby.
OBIEKT "OBJECT" Typ obiektu.
CIĄG ZNAKÓW "STRING" Typ ciągu znaków.

HarmBlockMethod

Podpis:

export declare enum HarmBlockMethod

Członkowie wyliczenia

Użytkownik Wartość Opis
HARM_BLOCK_METODA_UNSPECIFIED "HARM_BLOCK_METHOD_UNSPECIFIED"
Prawdopodobieństwo "PROBABILITY"
WAGA "SEVERITY"

Próg blokowania HarmBlock

Próg blokowania prośby lub kandydata.

Podpis:

export declare enum HarmBlockThreshold

Członkowie wyliczenia

Użytkownik Wartość Opis
BLOK_NISKIE_I_POWYŻSZE "BLOCK_LOW_AND_ABOVE"
BLOK_ŚREDNIE_I_POWYŻEJ "BLOCK_MEDIUM_AND_ABOVE"
BLOKADA_BRAK "BLOCK_NONE"
TYLKO_BLOKADY "BLOCK_ONLY_HIGH"
HARM_BLOCK_THRESHOLD_UNSPECIFIED "HARM_BLOCK_THRESHOLD_UNSPECIFIED"

Kategoria szkód

Kategorie szkodliwych treści, które mogłyby powodować blokowanie podpowiedzi lub kandydatów.

Podpis:

export declare enum HarmCategory

Członkowie wyliczenia

Użytkownik Wartość Opis
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 "HARM_CATEGORY_UNSPECIFIED"

Prawdopodobieństwo szkód

Prawdopodobieństwo, że prompt lub kandydat pasują do kategorii zagrożenia.

Podpis:

export declare enum HarmProbability

Członkowie wyliczenia

Użytkownik Wartość Opis
HARM_PROBABILITY_UNSPECIFIED "HARM_PROBABILITY_UNSPECIFIED"
WYSOKI "HIGH"
NISKI "LOW"
ŚREDNI "MEDIUM"
NIEZMIANY "NEGLIGIBLE"

Szkodliwość

Poziomy nasilenia szkód.

Podpis:

export declare enum HarmSeverity

Członkowie wyliczenia

Użytkownik Wartość Opis
HARM_SEVERITY_HIGH "HARM_SEVERITY_HIGH"
HARM_SEVERITY_LOW "HARM_SEVERITY_LOW"
HARM_SEVERITY_MEDIUM "HARM_SEVERITY_MEDIUM"
HARM_SEVERITY_NEGLIGIBLE "HARM_SEVERITY_NEGLIGIBLE"
HARM_SEVERITY_UNSPECIFIED "HARM_SEVERITY_UNSPECIFIED"