Firebase 웹 SDK의 Vertex AI
함수
함수 | 설명 |
---|---|
function(앱, ...) | |
getVertexAI(앱, 옵션) | 지정된 앱의 VertexAI 인스턴스를 반환합니다. |
함수(vertexAI, ...) | |
getGenerativeModel(vertexAI, modelParams, requestOptions) | 추론 및 기타 기능을 위한 메서드가 있는 GenerativeModel 클래스를 반환합니다. |
클래스
클래스 | 설명 |
---|---|
ChatSession | ChatSession 클래스로, 채팅 메시지 전송을 사용 설정하고 지금까지 주고받은 메시지 기록을 저장합니다. |
생성 모델 | 생성 모델 API의 클래스입니다. |
VertexAIError | Firebase SDK의 Vertex AI 오류 클래스입니다. |
열거
열거 | 설명 |
---|---|
BlockReason | 메시지가 차단된 이유입니다. |
FinishReason | 후보가 이수한 이유입니다. |
FunctionCallingMode | |
FunctionDeclarationSchemaType | https://swagger.io/docs/specification/data-models/data-types/에 정의된 OpenAPI 데이터 유형 목록을 포함합니다. |
HarmBlockMethod | |
HarmBlockThreshold | 프롬프트 또는 후보가 차단되는 기준점입니다. |
HarmCategory | 메시지 또는 후보가 차단될 수 있는 유해한 카테고리 |
유해 확률 | 프롬프트 또는 후보가 피해 카테고리와 일치할 확률입니다. |
유해 심각도 | 피해 심각도 수준 |
VertexAIErrorCode | VertexAIError에 포함될 수 있는 표준화된 오류 코드입니다. |
인터페이스
인터페이스 | 설명 |
---|---|
BaseParams | 여러 메서드의 기본 매개변수입니다. |
인용 | 단일 인용 |
인용 메타데이터 | GenerateContentCandidate에서 찾을 수 있는 인용 메타데이터입니다. |
Content | 프롬프트 및 응답 후보 모두의 콘텐츠 유형입니다. |
CountTokensRequest | GenerativeModel.countTokens()를 호출하기 위한 매개변수 |
CountTokensResponse | GenerativeModel.countTokens() 호출의 응답입니다. |
맞춤 오류 데이터 | 잘못된 HTTP 응답에서 발생한 데이터가 포함된 세부정보 객체입니다. |
날짜_2 | Protobuf google.type.Date |
EnhancedGenerateContentResponse | 도우미 메서드로 래핑된 응답 객체. |
오류 세부정보 | 오류 응답에 포함될 수 있는 세부정보 객체입니다. |
파일 데이터 | Google Cloud Storage에 업로드된 파일을 가리키는 데이터입니다. |
FileDataPart | 부분이 FileData를 나타내는 경우 콘텐츠 파트 인터페이스 |
함수 호출 | 모델에서 반환된 예측 FunctionCall로, FunctionDeclaration.name을 나타내는 문자열과 매개변수 및 해당 값을 포함하는 구조화된 JSON 객체를 포함합니다. |
FunctionCallingConfig | |
함수 호출부 | 부분이 FunctionCall을 나타내는 경우 콘텐츠 부분 인터페이스입니다. |
함수 선언 | OpenAPI 3.0 사양에 정의된 함수 선언의 구조화된 표현 이 선언에는 함수 이름과 매개변수가 포함됩니다. 이 FunctionDeclaration 는 모델에서 도구로 사용하고 클라이언트에서 실행할 수 있는 코드 블록을 나타냅니다. |
FunctionDeclarationSchema | FunctionDeclaration.parameters에 전달되는 매개변수의 스키마입니다. |
FunctionDeclarationSchemaProperty | 스키마는 입력/출력 데이터의 형식을 정의하는 데 사용됩니다. OpenAPI 3.0 스키마 객체의 선택된 하위 집합을 나타냅니다. 향후 필요에 따라 더 많은 필드가 추가될 수 있습니다. |
FunctionDeclarationsTool | FunctionDeclarationsTool 는 시스템이 외부 시스템과 상호작용하여 모델의 지식과 범위를 벗어난 작업 또는 작업 집합을 실행할 수 있도록 하는 코드입니다. |
함수 응답 | FunctionDeclaration.name을 나타내는 문자열과 함수의 출력을 포함하는 구조화된 JSON 객체를 포함하는 FunctionCall의 결과 출력은 모델에 대한 컨텍스트로 사용됩니다. 여기에는 모델 예측을 기반으로 한 FunctionCall의 결과가 포함되어야 합니다. |
FunctionResponsePart | 부분이 FunctionResponse를 나타내는 경우 콘텐츠 파트 인터페이스입니다. |
GenerateContentCandidate | GenerateContentResponse의 일부로 반환되는 후보입니다. |
GenerateContentRequest | GenerativeModel.generateContent()를 통해 요청이 전송됨 |
GenerateContentResponse | GenerativeModel.generateContent() 및 GenerativeModel.generateContentStream()의 개별 응답입니다. generateContentStream() 는 스트림이 완료될 때까지 각 청크에 하나씩 반환합니다. |
GenerateContentResult | GenerativeModel.generateContent() 호출에서 반환된 결과 객체입니다. |
GenerateContentStreamResult | GenerativeModel.generateContentStream() 호출에서 반환된 결과 객체입니다. stream 를 반복하여 청크가 들어올 때 청크를 가져오거나 response 프로미스를 사용하여 스트림이 완료될 때 집계된 응답을 얻습니다. |
생성 구성 | 콘텐츠 관련 요청의 구성 옵션 |
GenerativeContentBlob | 이미지 전송을 위한 인터페이스입니다. |
그라운딩 속성 | |
GroundingMetadata | 그라운딩이 사용 설정되면 클라이언트에 반환되는 메타데이터입니다. |
InlineDataPart | 부분이 이미지를 나타내는 경우 콘텐츠 파트 인터페이스입니다. |
ModelParams | getGenerativeModel()에 전달된 매개변수입니다. |
PromptFeedback | 프롬프트가 차단된 경우 blockReason 및 관련 safetyRatings 가 입력됩니다. |
RequestOptions에 대한 요청 | getGenerativeModel()에 전달된 매개변수입니다. |
RetrievedContextAttribution | |
SafetyRating | GenerateContentCandidate와 관련된 안전 등급 |
SafetySetting | 요청 매개변수의 일부로 전송할 수 있는 안전 설정입니다. |
Segment | |
StartChatParams | GenerativeModel.startChat()의 매개변수입니다. |
텍스트 부분 | 부분이 텍스트 문자열을 나타내는 경우 콘텐츠 부분 인터페이스입니다. |
도구 구성 | 도구 구성 이 구성은 요청에 제공된 모든 도구에 공유됩니다. |
UsageMetadata | GenerateContentResponse에 대한 사용 메타데이터입니다. |
VertexAI | Firebase SDK의 Vertex AI 인스턴스입니다. |
VertexAIOptions | Firebase SDK에서 Vertex AI를 초기화할 때의 옵션입니다. |
VideoMetadata | 입력 동영상 콘텐츠를 설명합니다. |
웹 저작자 표시 |
변수
변수 | 설명 |
---|---|
POSSIBLE_ROLES | 가능한 역할 |
유형 별칭
별칭 입력 | 설명 |
---|---|
부품 | 콘텐츠 부분 - 텍스트, 이미지/동영상 또는 함수 호출/응답 부분 유형 포함 |
역할 | 역할은 콘텐츠의 제작자입니다. |
도구 | 모델이 외부 지식에 액세스하기 위해 호출할 수 있는 도구를 정의합니다. |
함수(앱, ...)
getVertexAI(앱, 옵션)
지정된 앱의 VertexAI 인스턴스를 반환합니다.
서명:
export declare function getVertexAI(app?: FirebaseApp, options?: VertexAIOptions): VertexAI;
매개변수
매개변수 | 유형 | 설명 |
---|---|---|
앱 | Firebase 앱 | 사용할 FirebaseApp입니다. |
옵션 | VertexAIOptions |
반환:
함수(꼭짓점 AI, ...)
getGenerativeModel(vertexAI, modelParams, requestOptions)
추론 및 기타 기능을 위한 메서드가 있는 GenerativeModel 클래스를 반환합니다.
서명:
export declare function getGenerativeModel(vertexAI: VertexAI, modelParams: ModelParams, requestOptions?: RequestOptions): GenerativeModel;
매개변수
매개변수 | 유형 | 설명 |
---|---|---|
Vertex AI | VertexAI | |
modelParams | ModelParams | |
요청 옵션 | RequestOptions에 대한 요청 |
반환:
POSSIBLE_ROLES
가능한 역할
서명:
POSSIBLE_ROLES: readonly ["user", "model", "function", "system"]
일부
콘텐츠 부분 - 텍스트, 이미지/동영상 또는 함수 호출/응답 부분 유형 포함
서명:
export declare type Part = TextPart | InlineDataPart | FunctionCallPart | FunctionResponsePart | FileDataPart;
역할
역할은 콘텐츠의 제작자입니다.
서명:
export declare type Role = (typeof POSSIBLE_ROLES)[number];
도구
모델이 외부 지식에 액세스하기 위해 호출할 수 있는 도구를 정의합니다.
서명:
export declare type Tool = FunctionDeclarationsTool;
차단 사유
메시지가 차단된 이유입니다.
서명:
export declare enum BlockReason
열거형 구성원
구성원 | 값 | 설명 |
---|---|---|
BLOCKED_REASON_UNSPECIFIED(차단됨_이유_지정되지 않음) | "BLOCKED_REASON_UNSPECIFIED" |
|
기타 | "OTHER" |
|
안전 | "SAFETY" |
FinishReason
후보가 이수한 이유입니다.
서명:
export declare enum FinishReason
열거형 구성원
구성원 | 값 | 설명 |
---|---|---|
FINISH_REASON_UNSPECIFIED(완료_이유_지정되지 않음) | "FINISH_REASON_UNSPECIFIED" |
|
최대 토큰 | "MAX_TOKENS" |
|
기타 | "OTHER" |
|
녹음 | "RECITATION" |
|
안전 | "SAFETY" |
|
중지 | "STOP" |
함수 호출 모드
서명:
export declare enum FunctionCallingMode
열거형 구성원
구성원 | 값 | 설명 |
---|---|---|
모두 | "ANY" |
|
자동 | "AUTO" |
|
미지정 모드 | "MODE_UNSPECIFIED" |
|
없음 | "NONE" |
함수 선언 스키마 유형
https://swagger.io/docs/specification/data-models/data-types/에 정의된 OpenAPI 데이터 유형 목록을 포함합니다.
서명:
export declare enum FunctionDeclarationSchemaType
열거형 구성원
구성원 | 값 | 설명 |
---|---|---|
ARRAY | "ARRAY" |
배열 유형입니다. |
부울 | "BOOLEAN" |
불리언 유형. |
정수 | "INTEGER" |
정수 유형입니다. |
숫자 | "NUMBER" |
숫자 유형입니다. |
객체 | "OBJECT" |
객체 유형입니다. |
STRING | "STRING" |
문자열 유형입니다. |
HarmBlockMethod
서명:
export declare enum HarmBlockMethod
열거형 구성원
구성원 | 값 | 설명 |
---|---|---|
HARM_BLOCK_METHOD_UNSPECIFIED | "HARM_BLOCK_METHOD_UNSPECIFIED" |
|
가능성 | "PROBABILITY" |
|
심각도 | "SEVERITY" |
HarmBlockThreshold
프롬프트 또는 후보가 차단되는 기준점입니다.
서명:
export declare enum HarmBlockThreshold
열거형 구성원
구성원 | 값 | 설명 |
---|---|---|
BLOCK_LOW_AND_ABOVE | "BLOCK_LOW_AND_ABOVE" |
|
중간_중간_위로_차단 | "BLOCK_MEDIUM_AND_ABOVE" |
|
BLOCK_NONE | "BLOCK_NONE" |
|
BLOCK_ONLY_HIGH | "BLOCK_ONLY_HIGH" |
|
HARM_BLOCK_THRESHOLD_UNSPECIFIED | "HARM_BLOCK_THRESHOLD_UNSPECIFIED" |
HarmCategory
메시지 또는 후보가 차단될 수 있는 유해한 카테고리
서명:
export declare enum HarmCategory
열거형 구성원
구성원 | 값 | 설명 |
---|---|---|
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" |
위해 확률
프롬프트 또는 후보가 피해 카테고리와 일치할 확률입니다.
서명:
export declare enum HarmProbability
열거형 구성원
구성원 | 값 | 설명 |
---|---|---|
HARM_PROBABILITY_UNSPECIFIED | "HARM_PROBABILITY_UNSPECIFIED" |
|
높음 | "HIGH" |
|
낮음 | "LOW" |
|
중간 | "MEDIUM" |
|
무시할 수 있음 | "NEGLIGIBLE" |
피해심각도
유해 심각도 수준
서명:
export declare enum HarmSeverity
열거형 구성원
구성원 | 값 | 설명 |
---|---|---|
위험 높음 | "HARM_SEVERITY_HIGH" |
|
위험_SEVERITY_LOW | "HARM_SEVERITY_LOW" |
|
HARM_SEVERITY_MEDIUM | "HARM_SEVERITY_MEDIUM" |
|
유해_SEVERITY_NEGLIGIBLE | "HARM_SEVERITY_NEGLIGIBLE" |
|
해킹_SEVERITY_UNSPECIFIED | "HARM_SEVERITY_UNSPECIFIED" |
Vertex AI 오류 코드
VertexAIError에 포함될 수 있는 표준화된 오류 코드입니다.
서명:
export declare const enum VertexAIErrorCode
열거형 구성원
구성원 | 값 | 설명 |
---|---|---|
오류 | "error" |
일반 오류가 발생했습니다. |
FETCH_ERROR(FETCH_ERROR) | "fetch-error" |
가져오기를 수행하는 중에 오류가 발생했습니다. |
잘못된 콘텐츠 | "invalid-content" |
콘텐츠 객체와 관련된 오류입니다. |
NO_API_KEY | "no-api-key" |
Firebase API 키가 누락되어 오류가 발생했습니다. |
모델 없음 | "no-model" |
초기화 중에 모델 이름이 지정되지 않아 오류가 발생했습니다. |
NO_PROJECT_ID | "no-project-id" |
프로젝트 ID 누락으로 인해 오류가 발생했습니다. |
PARSE_FAILED | "parse-failed" |
파싱하는 중에 오류가 발생했습니다. |
요청_오류 | "request-error" |
요청에 오류가 발생했습니다. |
응답 오류 | "response-error" |
응답에 오류가 발생했습니다. |