vertexai-preview package

pakiet SDK usługi internetowej Vertex AI dla Firebase.

Funkcje

Funkcja Opis
function(aplikacja, ...)
getVertexAI(aplikacja; opcje) Zwraca instancję VertexAI dla danej aplikacji.
function(vertexAI, ...)
getGenerativeModel(vertexAI, modelParams, requestOptions) Zwraca klasę GenerativeModel z metodami wnioskowania i innymi funkcjami.

Zajęcia

Klasa Opis
Sesja czatu Klasa ChatSession, która umożliwia wysyłanie wiadomości czatu i przechowuje historię wysłanych i odebranych wiadomości.
GenerativeModel, Klasa interfejsów API modeli generatywnych.
Błąd Vertex AI Klasa błędu pakietu SDK Vertex AI dla Firebase.

Wyliczenia

Wyliczenie Opis
BlockReason (w języku angielskim) Przyczyna zablokowania promptu.
FinishReason (Zakończony powód) Powód zakończenia kandydata.
tryb wywoływania funkcji
FunctionDeklaracjaSchemaType Zawiera listę typów danych OpenAPI zgodnie z definicją podaną na https://swagger.io/docs/specification/data-models/data-types/
HarmBlockMethod
HarmBlockThreshold Próg, powyżej którego prompt lub kandydat zostanie zablokowany.
Kategoria szkody Kategorie szkodliwe, które mogą powodować blokowanie promptów lub kandydatów.
Prawdopodobieństwo szkody Prawdopodobieństwo, że prompt lub kandydat pasuje do kategorii szkody.
Poziom ważności Poziomy wagi szkód.
Kod błędu VertexAI Ustandaryzowane kody błędów, które może wystąpić VertexAIError.

Interfejsy

Interfejs Opis
Parametry podstawowe Parametry podstawowe dla wielu metod.
Cytowania Jeden cytat.
Metadane cytatów Metadane cytowania, które można znaleźć w elemencie GenerateContentCandidate.
Content Typ treści zarówno promptów, jak i kandydatów na odpowiedzi.
CountTokensRequest Parametry wywoływania GenerativeModel.countTokens()
CountTokensResponse Odpowiedź dotycząca wywołania GenerativeModel.countTokens().
Niestandardowy błąd danych Obiekt details zawierający dane pochodzące z nieprawidłowej odpowiedzi HTTP.
Data_2 Protobuf google.type.Date
EnhancedGenerateContentResponse Obiekt odpowiedzi opakowany metodami pomocniczymi.
ErrorDetails Obiekt szczegółów, który może być zawarty w odpowiedzi na błąd.
FileData (Dane plików) Dane wskazujące plik przesłany do Google Cloud Storage.
Część danych pliku Interfejs z treścią, jeśli część reprezentuje plik FileData.
Wywołanie funkcji Prognozowana funkcja FunctionCall zwrócona z modelu, która zawiera ciąg znaków reprezentujący obiekt FunctionDetectation.name i uporządkowany obiekt JSON zawierający parametry i ich wartości.
FunctionCallingConfig
Część wywołania funkcji Interfejs części treści, jeśli część reprezentuje wywołanie funkcji FunctionCall.
Deklaracja funkcji Uporządkowane przedstawienie deklaracji funkcji zgodnie ze specyfikacją OpenAPI 3.0. Ta deklaracja zawiera nazwę funkcji i jej parametry. Ten element FunctionDeclaration to reprezentacja bloku kodu, który może być używany przez model jako narzędzie i wykonywany przez klienta.
Schemat deklaracji funkcji Schemat parametrów przekazywanych do parametru Functiondekation.parameters.
FunctionDetectationSchema Property Schemat służy do definiowania formatu danych wejściowych/wyjściowych. Reprezentuje wybrany podzbiór obiektu schematu OpenAPI 3.0. W przyszłości możemy dodać więcej pól.
FunctionDetectationsTool FunctionDeclarationsTool to fragment kodu, który umożliwia systemowi wchodzenie w interakcję z zewnętrznymi systemami w celu wykonania działania lub zestawu działań poza zakresem wiedzy i zakresu modelu.
Odpowiedź funkcji Wynikowe dane wyjściowe funkcji FunctionCall, które zawierają ciąg znaków reprezentujący właściwość FunctionDetectation.name i uporządkowany obiekt JSON zawierający dowolne dane wyjściowe funkcji, są używane jako kontekst dla modelu. Powinien on zawierać wynik wywołania funkcji FunctionCall na podstawie prognozy modelu.
Część odpowiedzi funkcji Interfejs sekcji z treścią, jeśli część reprezentuje odpowiedź funkcji.
Generowanie treści jako kandydata kandydat zwrócony w ramach GenerateContentResponse.
GenerateContentRequest Żądanie wysłane przez GenerativeModel.generateContent()
GenerateContentResponse Indywidualna odpowiedź z GenerativeModel.generateContent() i GenerativeModel.generateContentStream(). Dopóki przesyłanie strumieniowe się nie zakończy, generateContentStream() zwróci po jednej w każdym fragmencie.
GenerateContentResult Obiekt wyniku zwrócony z wywołania GenerativeModel.generateContent().
GenerateContentStreamResult Obiekt wyniku zwrócony z wywołania GenerativeModel.generateContentStream(). Wykonaj iterację w ciągu stream, aby otrzymywać fragmenty na bieżąco, lub wykorzystaj obietnicę response do uzyskania zagregowanej odpowiedzi po zakończeniu transmisji.
GenerationConfig Opcje konfiguracji dla żądań związanych z treścią
GenerativeContentBlob, Interfejs do wysyłania obrazu.
Umocowanie atrybucji
Metadane umocowania Metadane zwracane do klienta, gdy włączone jest umocowanie.
InlineDataPart (Wbudowana część danych) Interfejs sekcji z treścią, jeśli część reprezentuje obraz.
ModelParams Parametry przekazywane do funkcji getGenerativeModel().
Promptfeedback Jeśli prośba została zablokowana, w tym polu pojawi się wartość blockReason i odpowiednia wartość safetyRatings.
RequestOptions Parametry przekazywane do funkcji getGenerativeModel().
DownloaddContextAttribution
Ocena bezpieczeństwa Ocena bezpieczeństwa powiązana z atrybutem GenerateContentCandidate
Ustawienia zabezpieczeń Ustawienie bezpieczeństwa, które może być wysyłane w ramach parametrów żądania.
Segment
StartChatParams Parametry GenerativeModel.startChat().
Część tekstowa Interfejs dotyczący części treści, jeśli część reprezentuje ciąg tekstowy.
ToolConfig Konfiguracja narzędzia. Ta konfiguracja jest współdzielona dla wszystkich narzędzi dostarczonych w żądaniu.
Metadane użytkowania Metadane wykorzystania dotyczące odpowiedzi GenerateContentResponse.
Vertex AI, Instancja pakietu SDK Vertex AI dla Firebase.
VertexAIOptions Opcje dostępne podczas inicjowania pakietu SDK Vertex AI dla Firebase.
VideoMetadata, Opisuje wejściowe treści wideo.
WebAttribution (w języku angielskim)

Zmienne

Zmienna Opis
POSSIBLE_ROLES ( możliwe role) Możliwe role.

Aliasy typu

Wpisz alias Opis
Część Część związana z treścią – obejmuje elementy tekstowe, graficzne/wideo oraz typy części związanych z połączeniem/odpowiedzią na funkcję.
Role Rola to producent treści.
Narzędzie Definiuje narzędzie, które model może wywoływać, aby uzyskać dostęp do wiedzy zewnętrznej.

funkcja(aplikacja, ...)

getVertexAI(aplikacja; opcje)

Zwraca instancję VertexAI dla danej aplikacji.

Podpis:

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

Parametry

Parametr Typ Opis
aplikacja Aplikacja Firebase FirebaseApp, która ma być używana.
opcje VertexAIOptions

Zwroty:

Vertex AI,

funkcja(vertexAI, ...)

getGenerativeModel(vertexAI, modelParams, requestOptions)

Zwraca klasę GenerativeModel z metodami wnioskowania i innymi funkcjami.

Podpis:

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

Parametry

Parametr Typ Opis
vertexAI Vertex AI,
parametry modelu ModelParams
requestOptions RequestOptions

Zwroty:

GenerativeModel,

POSSIBLE_ROLES:

Możliwe role.

Podpis:

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

Część

Część związana z treścią – obejmuje elementy tekstowe, graficzne/wideo oraz typy części związanych z połączeniem/odpowiedzią na funkcję.

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ływać, 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 "BLOCKED_REASON_UNSPECIFIED"
INNE "OTHER"
BEZPIECZEŃSTWO "SAFETY"

FinishReason

Powód zakończenia kandydata.

Podpis:

export declare enum FinishReason

Członkowie wyliczenia

Użytkownik Wartość Opis
FINISH_REASON_UNSPECIFIED: "FINISH_REASON_UNSPECIFIED"
MAX_TOKENS "MAX_TOKENS"
INNE "OTHER"
PRZEPIS "RECITATION"
BEZPIECZEŃSTWO "SAFETY"
PRZERWIJ "STOP"

Tryb wywoływania funkcji

Podpis:

export declare enum FunctionCallingMode

Członkowie wyliczenia

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

Typ schematu deklaracji funkcji

Zawiera listę typów danych OpenAPI zgodnie z definicją podaną na https://swagger.io/docs/specification/data-models/data-types/

Podpis:

export declare enum FunctionDeclarationSchemaType

Członkowie wyliczenia

Użytkownik Wartość Opis
ARRAY "ARRAY" Typ tablicy.
WARTOŚĆ LOGICZNA "BOOLEAN" Typ wartości logicznej.
LICZBA CAŁKOWITA "INTEGER" Typ liczby całkowitej.
LICZBA "NUMBER" Typ numeru.
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_FORMACJA_NIEOKREŚLONA "HARM_BLOCK_METHOD_UNSPECIFIED"
PRÓBNOŚĆ "PROBABILITY"
WAGA "SEVERITY"

Próg blokad luk w zabezpieczeniach

Próg, powyżej którego prompt lub kandydat zostanie zablokowany.

Podpis:

export declare enum HarmBlockThreshold

Członkowie wyliczenia

Użytkownik Wartość Opis
BLOCK_LOW_I_PONAD "BLOCK_LOW_AND_ABOVE"
BLOKOWANIE_ŚREDNIE_I_POWYŻSZE "BLOCK_MEDIUM_AND_ABOVE"
BLOKOWANIE_NONE "BLOCK_NONE"
BLOCK_ONLY_HIGH "BLOCK_ONLY_HIGH"
HARM_BLOCK_THRESHOLD_UNSPECIFIED: "HARM_BLOCK_THRESHOLD_UNSPECIFIED"

Kategoria szkody

Kategorie szkodliwe, które mogą powodować blokowanie promptów lub kandydatów.

Podpis:

export declare enum HarmCategory

Członkowie wyliczenia

Użytkownik Wartość Opis
HARM_CATEGORY_TREŚCI NIEBEZPIECZNE "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"
KATEGORIA_HARM_UNSPECIFIED "HARM_CATEGORY_UNSPECIFIED"

Prawdopodobieństwo szkodliwości

Prawdopodobieństwo, że prompt lub kandydat pasuje do kategorii szkody.

Podpis:

export declare enum HarmProbability

Członkowie wyliczenia

Użytkownik Wartość Opis
HARM_PROBABILITY_UNSPECIFIED: "HARM_PROBABILITY_UNSPECIFIED"
WYSOKI "HIGH"
NISKI "LOW"
ŚREDNI "MEDIUM"
NIEPRAWIDŁOWE "NEGLIGIBLE"

Waga zagrożenia

Poziomy wagi 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_ŚREDNI "HARM_SEVERITY_MEDIUM"
HARM_SEVERITY_NEGLIGIBLE "HARM_SEVERITY_NEGLIGIBLE"
HARM_SEVERITY_UNSPECIFIED: HARM_SEVERITY_UNSPECIFIED "HARM_SEVERITY_UNSPECIFIED"

Kod błędu VertexAI

Ustandaryzowane kody błędów, które może wystąpić VertexAIError.

Podpis:

export declare const enum VertexAIErrorCode

Członkowie wyliczenia

Użytkownik Wartość Opis
BŁĄD "error" Wystąpił błąd ogólny.
BŁĄD_FETCH "fetch-error" Podczas pobierania wystąpił błąd.
NIEPRAWIDŁOWE_TREŚCI "invalid-content" Błąd powiązany z obiektem Content.
NO_API_KEY "no-api-key" Z powodu braku klucza interfejsu API Firebase wystąpił błąd.
NO_MODEL "no-model" Wystąpił błąd, ponieważ podczas inicjowania nie określono nazwy modelu.
NO_PROJECT_ID "no-project-id" Wystąpił błąd z powodu braku identyfikatora projektu.
PARSE_FAILED (NIEPOWODZENIE) "parse-failed" Podczas analizowania wystąpił błąd.
BŁĄD_ŻĄDANIA "request-error" Wystąpił błąd w żądaniu.
Response_ERROR (błąd) "response-error" W odpowiedzi wystąpił błąd.