Pacchetto @google-cloud/vertexai (1.1.0)

Corsi

ChatSession

La classe ChatSession viene utilizzata per effettuare richieste di invio di messaggi in più passaggi. Puoi creare un'istanza di questa classe utilizzando il metodo startChat nella classe GenerativeModel. Il metodo sendMessage esegue una chiamata asincrona per ricevere contemporaneamente la risposta a un messaggio di chat. Il metodo sendMessageStream esegue una chiamata asincrona per trasmettere la risposta di un messaggio di chat durante la sua generazione.

ChatSessionPreview

La classe ChatSessionPreview viene utilizzata per effettuare richieste di invio di messaggi in più passaggi. Puoi creare un'istanza di questa classe utilizzando il metodo startChat nella classe GenerativeModelPreview. Il metodo sendMessage esegue una chiamata asincrona per ricevere contemporaneamente la risposta a un messaggio di chat. Il metodo sendMessageStream esegue una chiamata asincrona per trasmettere la risposta di un messaggio di chat durante la sua generazione.

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

GenerateContentResponseHandler

Classe di supporto per visualizzare eventuali proprietà aggiuntive di GenerateContentResponse o di GenerateContentResponse.

GenerativeModel

La classe GenerativeModel è la classe base per i modelli generativi su Vertex AI. NOTA: non creare un'istanza direttamente per questa classe. Usa invece il criterio vertexai.getGenerativeModel().

GenerativeModelPreview

La classe GenerativeModelPreview è la classe base per i modelli generativi in anteprima. NOTA: non creare un'istanza direttamente per 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

La classe VertexAI è la classe base per l'autenticazione in Vertex AI. Per utilizzare i modelli di IA generativa di Vertex AI, usa il metodo getGenerativeModel. Per utilizzare le funzionalità di AI generativa in anteprima, utilizza lo spazio dei nomi preview.

Interfacce

BaseModelParams

Parametri di base per inizializzare un modello o chiamare generateContent.

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. inlineData 3. fileData 4. FunctionsResponse 5. funzioneCall

Citazione

Attribuzioni delle fonti per i contenuti.

CitationMetadata

Una raccolta di attribuzioni di fonti per un contenuto.

Contenuti

Il tipo di dati strutturati di base contenente contenuti in più parti di un messaggio.

CountTokensRequest

Parametri utilizzati per chiamare il metodo countTokens.

CountTokensResponse

Risposta restituita dal metodo countTokens.

FileData

Dati basati su URI.

FileDataPart

Una parte di dati del file di una conversazione con il modello.

FunctionCall

Una funzione FunctionCall prevista restituita dal modello contenente una stringa che rappresenta la FunctionDeclaration.name con i parametri e i relativi valori.

FunctionCallPart

Una chiamata di funzione che fa parte di una conversazione con il modello.

FunctionDeclaration

Rappresentazione strutturata di una dichiarazione di funzione come definita dalla [specifica OpenAPI 3.0](https://spec.openapis.org/oas/v3.0.3). Questa dichiarazione include il nome e i parametri della funzione. Questa FunctionDeclaration è una rappresentazione di un blocco di codice che può essere utilizzato come strumento dal modello ed eseguito dal client.

FunctionDeclarationSchema

Schema dei parametri passati a FunctionDeclaration.parameters.

FunctionDeclarationSchemaProperty

Lo schema viene utilizzato per definire il formato dei dati di input/output. Rappresenta un sottoinsieme selezionato di un oggetto schema OpenAPI 3.0. In futuro è possibile aggiungere altri campi in base alle necessità.

FunctionDeclarationsTool

Una FunctionDeclarationsTool è una porzione di codice che consente al sistema di interagire con sistemi esterni per eseguire un'azione o un insieme di azioni, al di fuori della conoscenza e dell'ambito del modello.

FunctionResponse

L'output del risultato di una funzione FunctionCall che contiene una stringa che rappresenta la FunctionDeclaration.name e un oggetto JSON strutturato contenente qualsiasi output della chiamata di funzione. Viene utilizzato come contesto del modello.

FunctionResponsePart

Una risposta funzione che fa parte di una conversazione con il modello.

GenerateContentCandidate

Un candidato di risposta generato dal modello.

GenerateContentRequest

Parametri utilizzati per chiamare il metodo generateContent.

GenerateContentResponse

Risposta dal modello che supporta più candidati.

GenerateContentResult

Wrapper per le risposte a una richiesta generateContent.

GenerationConfig

Opzioni di configurazione per la generazione e gli output del modello.

GenerativeContentBlob

Byte multimediali non elaborati inviati direttamente nella richiesta. Il testo non deve essere inviato come byte non elaborati.

GetGenerativeModelParams

Parametri utilizzati per chiamare il metodo getGenerativeModel.

GoogleDate

Rappresenta una data di calendario intera o parziale, ad esempio un compleanno. L'ora del giorno e il fuso orario sono specificati altrove o non sono significativi. La data è relativa al calendario gregoriano. Può rappresentare uno dei seguenti elementi:

Una data completa, con valori di anno, mese e giorno diversi da zero. Un mese e un giorno con zero anno (ad esempio, un anniversario). Un anno a sé, con un mese e uno zero. Un anno e un mese, con un giorno zero (ad esempio, la data di scadenza di una carta di credito).

GoogleSearchRetrieval

Strumento fornito da Google per recuperare dati web pubblici per il grounding.

GoogleSearchRetrievalTool

Definisce uno strumento di recupero che il modello può chiamare per accedere a conoscenze esterne.

GroundingAttribution

Attribuzione di grounding.

GroundingAttributionRetrievedContext

Attribuzione dal contesto recuperato dagli strumenti di recupero.

GroundingAttributionSegment

Segmento dei contenuti a cui appartiene l'attribuzione.

GroundingAttributionWeb

Attribuzione dal web.

GroundingMetadata

Una raccolta di attribuzioni di grounding per un contenuto.

InlineDataPart

Una parte di dati in linea di una conversazione con il modello.

ModelParams

Configurazione per l'inizializzazione di un modello, ad esempio tramite getGenerativeModel nella classe VertexAI.

PromptFeedback

Risultati del filtro dei contenuti per un prompt inviato nella richiesta.

RequestOptions

Parametri delle opzioni di richiesta passati al metodo getGenerativeModel nella classe VertexAI.

Recupero

Definisce uno strumento di recupero che il modello può chiamare per accedere a conoscenze esterne.

RetrievalTool

Definisce uno strumento di recupero che il modello può chiamare per accedere a conoscenze esterne.

SafetyRating

Valutazione di sicurezza corrispondente ai contenuti generati.

SafetySetting

Feedback sulla sicurezza per un'intera richiesta.

StartChatParams

Parametri per avviare una chat multigiro con il modello tramite startChat.

StartChatSessionRequest

Tutti i parametri sono stati superati per avviare la chat multigiro tramite startChat.

StreamGenerateContentResult

Wrapper per le risposte da un metodo generateContentStream.

TextPart

Un testo che fa parte di una conversazione con il modello.

UsageMetadata

Metadati di utilizzo relativi alle risposte.

VertexAISearch

Recupera dal datastore Vertex AI Search per il grounding.

VertexInit

Parametri utilizzati per inizializzare l'SDK Vertex.

Enum

BlockedReason

Il motivo per cui la risposta è bloccata.

FinishReason

Il motivo per cui il modello ha smesso di generare token. Se è vuoto, il modello non ha smesso di generare i token.

FunctionDeclarationSchemaType

Contiene l'elenco dei tipi di dati OpenAPI come definiti da https://swagger.io/docs/specification/data-models/data-types/

HarmBlockThreshold

Livelli di soglia di blocco basati sulla probabilità.

HarmCategory

Categorie di danni che bloccano i contenuti.

HarmProbability

Livelli di probabilità di danno nei contenuti.

HarmSeverity

Livelli di gravità del danno

Digita alias

Parte

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

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, FileDataPart e FunctionResponsePart. Un elemento Part ha uno dei seguenti campi che si escludono a vicenda: 1. text 2. inlineData 3. fileData 4. FunctionsResponse

Strumento

export declare type Tool = FunctionDeclarationsTool | RetrievalTool | GoogleSearchRetrievalTool;

Definisce uno strumento che il modello può chiamare per accedere alle conoscenze esterne.