Corsi
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
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
Una classe base per l'autenticazione in Vertex crea lo spazio dei nomi di anteprima. Gli utenti usano il metodo getGenerativeModel per iniziare a utilizzare i modelli generativi di Google in GA.
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 4. functionResponse 5. functionCall
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 {never} - [functionResponse]. La risposta con funzione non è prevista per FileDataPart. {never} - [functionCall]. La chiamata di funzione non è prevista per FileDataPart.
FunctionCall
Una funzione FunctionCall prevista restituita dal modello contenente una stringa che rappresenta la FunctionDeclaration.name con i parametri e i relativi valori. {string} - name Il nome della funzione specificata in FunctionDeclaration.name. {object} - args Gli argomenti da passare alla funzione.
FunctionCallPart
Una chiamata di funzione che fa parte di una conversazione con il modello. {never} - [text]. testo non previsto per FunctionResponsePart. {never} - [inline_data]. L'attributo inline_data non è previsto per FunctionResponsePart. {never} - [file_data]. file_data non è previsto per FunctionResponsePart. FileData {never} - [functionResponse]. La risposta di funzione non è prevista per FunctionResponsePart. {FunctionCall} - funzione solo funzione Call. è prevista la chiamata per FunctionCallPart.
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. {string} - name Il nome della funzione da chiamare. Deve iniziare con una lettera o un trattino basso. Deve essere a-z, A-Z, 0-9 o contenere trattini bassi e trattini, con una lunghezza massima di 64. {string} - descrizione della descrizione e scopo della funzione. Il modello la utilizza per decidere come e se chiamare la funzione. {FunctionDeclarationSchema} - Parametri Descrive i parametri di questa funzione nel formato JSON Schema Object. Riflette l'oggetto parametro Open API 3.03. string Chiave: il nome del parametro. I nomi dei parametri sono sensibili alle maiuscole. Valore schema: lo schema che definisce il tipo utilizzato per il parametro. Per una funzione senza parametri, è possibile lasciarla non impostata. Esempio con 1 parametro obbligatorio e 1 facoltativo: tipo: proprietà OBJECT:
parametro1:
tipo: STRING param2:
tipo: INTEGER obbligatorio:
- param1
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. {object} - Functions_declarations Una o più dichiarazioni di funzione da passare al modello insieme alla query utente corrente. Il modello può decidere di chiamare un sottoinsieme di queste funzioni inserendo [FunctionCall][content.part.function_call] nella risposta. L'utente deve fornire una [FunctionResponse][content.part.function_response] per ogni chiamata di funzione nel prossimo turno. In base alle risposte della funzione, il modello genera la risposta finale all'utente. È possibile fornire un massimo di 64 dichiarazioni di funzione.
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. {string} - name Il nome della funzione specificata in FunctionDeclaration.name. {object} - response La risposta prevista dal modello.
FunctionResponsePart
Una risposta funzione che fa parte di una conversazione con il modello. {never} - [text]. testo non previsto per FunctionResponsePart. {never} - [inline_data]. L'attributo inline_data non è previsto per FunctionResponsePart. {FileData} - [file_data]. file_data non è previsto per FunctionResponsePart. FileData {never} - functionResponse. Per FunctionResponsePart è prevista solo funzioneResponse. {never} - [functionCall]. La chiamata di funzione non è prevista per FunctionResponsePart.
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 {GroundingMetadata} - [groundingMetadata]. GroundingMetadata
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
GetGenerativeModelParams
Modello {string} - nome del modello {string} progetto - progetto Il progetto Google Cloud da utilizzare per la località della richiesta {string} - La località del progetto Google Cloud da utilizzare per la richiesta {GoogleAuth} googleAuth - Istanza della classe GoogleAuth che gestisce l'autenticazione. I dettagli relativi a GoogleAuth sono indicati nell'articolo https://github.com/googleapis/google-auth-library-nodejs/blob/main/src/auth/googleauth.ts {string} - [apiEndpoint] L'endpoint Vertex AI di base da utilizzare per la richiesta. Se non viene specificato, verrà utilizzato l'endpoint regionalizzato predefinito (ad es. us-central1-aiplatform.googleapis.com). {GenerationConfig} [generation_config] - GenerationConfig {SafetySetting[]} [safety_settings] - SafetySetting {Tool[]} [strumenti] - Strumento
GoogleSearchRetrieval
Strumento fornito da Google per recuperare dati web pubblici per il grounding. {boolean} - [disableAttribution] Disattiva l'utilizzo dei risultati di questo strumento per rilevare l'attribuzione dei valori di grounding. Questo non influisce sul modo in cui il risultato viene assegnato al modello per la generazione.
GoogleSearchRetrievalTool
GroundingAttribution
Attribuzione di grounding. {GroundingAttributionWeb} - [web] L'attribuzione dal web. {GroundingAttributionSegment} - [segment] Segmento dei contenuti a cui appartiene l'attribuzione. {number} - [confidenceScore] Punteggio di affidabilità dell'attribuzione. L'intervallo è compreso tra 0 e 1. 1 rappresenta il livello di sicurezza più elevato.
GroundingAttributionSegment
Segmento dei contenuti a cui appartiene l'attribuzione. {number} - [part_index] L'indice di un oggetto Part all'interno dell'oggetto Content principale. {number} - [startIndex] Indice iniziale nella parte specificata, misurato in byte. Offset dall'inizio della parte inclusa, a partire da zero. {number} - [endIndex] Indice finale nella parte specificata, misurato in byte. Offset dall'inizio della parte, esclusivo, a partire da zero.
GroundingAttributionWeb
Attribuzione dal web. {string} - [uri] Riferimento URI dell'attribuzione. {string} - [title] Titolo dell'attribuzione.
GroundingMetadata
Una raccolta di attribuzioni di grounding per un contenuto. {string[]} - [webSearchQueries]. Query di ricerca web per la successiva ricerca web. {GroundingAttribution[]} - [groundingAttributions]. Array di GroundingAttribution
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. {never} - [functionResponse]. La funzione non è prevista per InlineDataPart. {never} - [functionCall]. La chiamata di funzione non è prevista 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.
Recupero
Definisce uno strumento di recupero che il modello può chiamare per accedere a conoscenze esterne. {VertexAISearch} - [vertexAiSearch] Impostazione per l'utilizzo dell'origine dati basata su Vertex AI Search. {boolean} - [disableAttribution] Disattiva l'utilizzo dei risultati di questo strumento per rilevare l'attribuzione dei valori di grounding. Questo non influisce sul modo in cui il risultato viene assegnato al modello per la generazione.
RetrievalTool
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 una chat in più passaggi tramite il progetto startChat {string} - Progetto Google Cloud da utilizzare per la località {string} della richiesta - La località del progetto Google Cloud da utilizzare per la richiesta
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. {never} - [functionResponse]. Non è prevista una funzione FunctionsResponse per TextPart. {never} - [functionCall]. La chiamata di funzione non è prevista 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.
VertexAISearch
Recupera dal datastore Vertex AI Search per il grounding. Consulta https://cloud.google.com/vertex-ai-search-and-conversation {string} - [datastore] ID risorsa datastore completo di Vertex AI Search. projects/<>/locations/<>/collections/<>/dataStores/<>
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
FunctionDeclarationSchemaType
Contiene l'elenco dei tipi di dati OpenAPI come definiti da https://swagger.io/docs/specification/data-models/data-types/
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 | 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 presenta uno dei seguenti campi che si escludono a vicenda: 1. text 2. inline_data 3. file_data 4. FunctionsResponse
Strumento
export declare type Tool = FunctionDeclarationsTool | RetrievalTool | GoogleSearchRetrievalTool;