Pacchetto @google-cloud/vertexai (0.2.1)

Corsi

ChatSession

Sessione di chat per effettuare una richiesta di invio di messaggi in più passaggi. Il metodo sendMessage esegue una chiamata asincrona per ricevere la risposta a un messaggio di chat. Il metodo sendMessageStream esegue una chiamata asincrona alla risposta dello stream di un messaggio di chat.

ClientError

ClientError viene generato alla ricezione dello stato http 4XX. Per maggiori dettagli, visita la pagina https://developer.mozilla.org/en-US/docs/Web/HTTP/Status#client_error_responses

GenerativeModel

Classe base per i modelli generativi. NOTA: non è necessario creare un'istanza direttamente di questa classe. Usa invece il criterio vertexai.preview.getGenerativeModel().

GoogleAuthError

GoogleAuthError viene generato in caso di problemi di autenticazione con la richiesta

GoogleGenerativeAIError

GoogleGenerativeAIError viene generato quando la risposta http non va bene e il codice di stato non è 4XX. Per maggiori dettagli, fai riferimento all'indirizzo https://developer.mozilla.org/en-US/docs/Web/HTTP/Status

VertexAI_Preview

Implementazione interna della classe Vertex AI per l'autenticazione.

VertexAI

Una classe base per l'autenticazione in Vertex crea lo spazio dei nomi di anteprima.

Interfacce

BaseModelParams

Parametri di base per inizializzare un modello o chiamare generateContent. {SafetySetting[]} - [safety_settings] Array di SafetySetting {GenerationConfig} - [generation_config] GenerationConfig

BasePart

Una parte di una svolta in una conversazione con il modello con un tipo MIME fisso. Ha uno dei seguenti campi che si escludono a vicenda: 1. text 2. inline_data 3. file_data

CitationMetadata

Una raccolta di attribuzioni di fonti per un contenuto. {CitationSource[]} - citationSources. Array di CitationSource

CitationSource

Attribuzioni delle fonti per i contenuti. {number} - [startIndex] Avvia l'indice nel contenuto. {number} - [endIndex] termina l'indice nei contenuti. {string} - [url] Riferimento URL dell'attribuzione. {string} - [license] Licenza dell'attribuzione.

Contenuti

Il tipo di dati strutturati di base contenente contenuti in più parti di un messaggio. {Part[]}: parti. Array della parte {string} - [role]. Il produttore dei contenuti. Deve essere "user" o "model". Utile da impostare per le conversazioni a turni multipli, altrimenti può essere lasciato vuoto o non impostato.

CountTokensRequest

Parametri utilizzati per chiamare il metodo countTokens. {Content[]} - contenuti. Array di contenuti

CountTokensResponse

Risposta restituita dal metodo countTokens. {number} - totalTokens. Il numero totale di token conteggiati in tutte le istanze dalla richiesta. {number} - [totalBillableCharacters]. Il numero totale di caratteri fatturabili conteggiati in tutte le istanze della richiesta.

FileData

Dati basati su URI. {string} - mime_type. Il tipo MIME standard IANA dei dati di origine. {string} - file_uri. URI del file.

FileDataPart

Una parte di dati del file di una conversazione con il modello. {never} - [text]. non è previsto per FileDataPart. {never} - [inline_data]. L'attributo inline_data non è previsto per FileDataPart. {FileData}: file_data. Per FileDataPart è prevista solo questa proprietà. FileData

GenerateContentCandidate

Un candidato di risposta generato dal modello. {Content} - contenuti. Contenuti {number} - [indice]. L'indice del candidato nel campo GenerateContentResponse {FinishReason} - [finishReason]. FinishReason {string} - [finishMessage]. {SafetyRating[]} - [safetyRatings]. Array di SafetyRating {CitationMetadata} - [citationMetadata]. CitationMetadata

GenerateContentRequest

Parametri utilizzati per chiamare il metodo generateContent. {Content[]} - contenuti. Array di contenuti

GenerateContentResponse

Risposta dal modello che supporta più candidati {GenerateContentCandidate} - candidati. GenerateContentCandidate {PromptFeedback} - [promptFeedback]. Il campo viene compilato solo se non sono presenti candidati a causa di un blocco di sicurezza PromptFeedback {UsageMetadata} - [usageMetadata]. UsageMetadata

GenerateContentResult

Wrapper per le risposte a una risposta generateContent {GenerateContentResponse} per richiesta. Tutti GeneraContentResponses hanno ricevuto finora GenerateContentResponse

GenerationConfig

Opzioni di configurazione per la generazione e gli output del modello {number} - [candidate_count] Numero di candidati da generare. {string[]} - [stop_repeats] Interrompi le sequenze. {number} - [max_output_tokens] Il numero massimo di token di output da generare per messaggio. {number} - [temperature] Controlla la casualità delle previsioni. {number} - [top_p] Se specificato, verrà utilizzato il campionamento del nucleo. {number} - [top_k] Se specificato, verrà utilizzato il campionamento top-k.

GenerativeContentBlob

Byte multimediali non elaborati inviati direttamente nella richiesta. Il testo non deve essere inviato come byte non elaborati. {string} - mime_type. Il tipo MIME dei dati di origine. Gli unici valori accettati: "image/png" o "image/jpeg". {string}: dati. I dati devono essere una stringa base64

InlineDataPart

Una parte di dati in linea di una conversazione con il modello. {never} - [text]. testo non previsto per InlineDataPart. {GenerativeContentBlob} - inline_data. Per InlineDataPart è prevista solo questa proprietà. GenerativeContentBlob {never} - [file_data]. file_data non è previsto per InlineDataPart.

ModelParams

Configurazione per l'inizializzazione di un modello, ad esempio tramite modello getGenerativeModel {string} - nome del modello.

PromptFeedback

Risultati del filtro dei contenuti per un prompt inviato nella richiesta. {BlockReason}: motivo del blocco. {SafetyRating[]} - safety_ratings. Array di SafetyRating {string} - block_reason_message. Un messaggio leggibile con il motivo del blocco.

SafetyRating

Valutazione di sicurezza corrispondente ai contenuti generati. {HarmCategory} - categoria. HarmCategory {HarmProbability} - probabilità. HarmProbability

SafetySetting

Feedback sulla sicurezza per un'intera richiesta. {HarmCategory} - categoria. HarmCategory {HarmBlockThreshold} - soglia. HarmBlockThreshold

StartChatParams

Parametri per avviare una chat in più passaggi con il modello tramite startChat {Content[]} - [cronologia] della sessione di chat. Content {SafetySetting[]} - Array [safety_settings] di SafetySetting {GenerationConfig} - [generation_config] GenerationConfig

StartChatSessionRequest

Tutti i parametri sono stati passati per avviare la chat multigiro tramite startChat {VertexAI_Preview} - _vertex_instance VertexAI_Preview {GenerativeModel} - _model_instance GenerativeModel

StreamGenerateContentResult

Wrapper per le risposte da un metodo generateContent quando il parametro steam è true {Promise

TextPart

Un testo che fa parte di una conversazione con il modello. {string}: testo. È prevista solo questa proprietà per TextPart. {never} - [inline_data]. L'attributo inline_data non è previsto per TextPart. {never} - [file_data]. file_data non è previsto per TextPart.

UsageMetadata

Metadati di utilizzo relativi alle risposte. {number} - [prompt_token_count]. Numero di token nella richiesta. {number} - [candidati_conteggio_token]. Numero di token nelle risposte. {number} - [totalTokenCount]. Numero totale di token.

VertexInit

Parametri utilizzati per inizializzare il progetto Vertex SDK @param{string}, che è il nome del tuo progetto Google Cloud. Non è l'ID progetto numerico. @param{string} località: la località del progetto. @param{string} [apiEndpoint]: se non specificato, un valore predefinito verrà risolto dall'SDK.

Enum

BlockedReason

{string} Il motivo per cui la risposta è bloccata. Valori: BLOCKED_REASON_UNSPECIFIED Motivo del blocco non specificato. Candidati per la SICUREZZA bloccati per motivi di sicurezza. OTHER Candidati bloccati per altri motivi.

FinishReason

{string} Il motivo per cui il modello ha smesso di generare token. Se è vuoto, il modello non ha smesso di generare i token. Valori: FINISH_REASON_UNSPECIFIED Il motivo della fine non è specificato. STOP: punto di arresto naturale del modello o sequenza di interruzioni fornita. MAX_TOKENS: è stato raggiunto il numero massimo di token specificato nella richiesta. SICUREZZA: la generazione del token è stata interrotta in quanto la risposta è stata segnalata per motivi di sicurezza. NOTA: durante lo streaming, il file Candidate.content sarà vuoto se i filtri dei contenuti hanno bloccato l'output. RECITATION: la generazione del token è stata interrotta in quanto la risposta è stata segnalata per citazioni non autorizzate. ALTRO: tutti gli altri motivi che hanno interrotto la generazione del token

HarmBlockThreshold

{string} Livelli di soglia basati sulla probabilità per il blocco. Valori: HARM_BLOCK_THRESHOLD_UNSPECIFIED: soglia del blocco danno non specificata. BLOCK_LOW_AND_ABOVE: blocca soglia bassa e oltre (ad es. blocca altri). BLOCK_MEDIUM_AND_ABOVE: blocca soglia media e superiore. BLOCK_ONLY_HIGH: blocca solo la soglia alta (ossia blocca meno). BLOCK_NONE: nessun blocco.

HarmCategory

{string} Categorie dannose che bloccheranno i contenuti. Valori: HARM_CATEGORY_UNSPECIFIED: la categoria dei danni non è specificata. HARM_CATEGORY_HATE_SPEECH: La categoria dannosa è l'incitamento all'odio. HARM_CATEGORY_DANGEROUS_CONTENT: la categoria dei contenuti dannosi è costituita da contenuti pericolosi. HARM_CATEGORY_HARASSMENT: la categoria dei danni è molestie. HARM_CATEGORY_SEXUALLY_EXPLICIT: la categoria dei danni include contenuti sessualmente espliciti.

HarmProbability

{string} Livelli di probabilità di danneggiamento nei contenuti. Valori: HARM_PROBABILITY_UNSPECIFIED: probabilità di danno non specificata. NEGLIGIBILE: livello di danno trascurabile. BASSO: livello basso di danni. MEDIO: livello di danno medio. ALTO: livello elevato di danni.

Digita alias

Parte

export declare type Part = TextPart | InlineDataPart | FileDataPart;

Un tipo di dati contenente un elemento multimediale che fa parte di un messaggio Content in più parti. Un Part è un tipo di unione di TextPart, InlineDataPart e FileDataPart Un Part ha uno dei seguenti campi che si escludono a vicenda: 1. text 2. inline_data 3. file_data