PaLM (decommissioned)

Metodo: models.generateText

Genera una risposta dal modello dato un messaggio di input.

Endpoint

post https://generativelanguage.googleapis.com/v1beta/{model=models/*}:generateText

Parametri del percorso

model string

Obbligatorio. Il nome di Model o TunedModel da utilizzare per generare il completamento. Esempi: models/text-bison-001 tunedModels/sentence-translator-u3b7m Assume la forma models/{model}.

Corpo della richiesta

Il corpo della richiesta contiene dati con la seguente struttura:

Campi
prompt object (TextPrompt)

Obbligatorio. Il testo di input in formato libero fornito al modello come prompt.

Dato un prompt, il modello genera una risposta TextCompletion che prevede come completamento del testo di input.

safetySettings[] object (SafetySetting)

(Facoltativo) Un elenco di istanze SafetySetting uniche per bloccare i contenuti non sicuri.

che verranno applicate il giorno GenerateTextRequest.prompt e GenerateTextResponse.candidates. Non deve esserci più di un'impostazione per ogni tipo di SafetyCategory. L'API bloccherà tutti i prompt e le risposte che non soddisfano le soglie impostate da queste impostazioni. Questo elenco sostituisce le impostazioni predefinite per ogni SafetyCategory specificato in safetySettings. Se nell'elenco non è presente SafetySetting per un determinato SafetyCategory, l'API utilizzerà l'impostazione di sicurezza predefinita per quella categoria. Le categorie di contenuti dannosi HARM_CATEGORY_DEROGATORY, HARM_CATEGORY_TOXICITY, HARM_CATEGORY_VIOLENCE, HARM_CATEGORY_SEXUAL, HARM_CATEGORY_MEDICAL, HARM_CATEGORY_DANGEROUS sono supportate nel servizio di testo.

stopSequences[] string

Il set di sequenze di caratteri (fino a 5) che interromperanno la generazione dell'output. Se specificata, l'API si interromperà alla prima occorrenza di una sequenza di interruzione. La sequenza di fermate non verrà inclusa nella risposta.

temperature number

(Facoltativo) Controlla la casualità dell'output. Nota: il valore predefinito varia in base al modello. Consulta l'attributo Model.temperature della funzione Model restituita dalla funzione getModel.

I valori possono variare da [0.0,1.0], inclusi. Un valore più vicino a 1,0 produrrà risposte più varie e creative, mentre un valore più vicino a 0,0 in genere genererà risposte più dirette da parte del modello.

candidateCount integer

(Facoltativo) Numero di risposte generate da restituire.

Questo valore deve essere compreso tra 1 e 8 inclusi. Se non viene impostato, il valore predefinito è 1.

maxOutputTokens integer

(Facoltativo) Il numero massimo di token da includere in un candidato.

Se non impostato, il valore predefinito sarà outputTokenLimit specificato nella specifica Model.

topP number

(Facoltativo) La probabilità cumulativa massima dei token da considerare durante il campionamento.

Il modello utilizza il campionamento combinato Top-k e nucleus.

I token vengono ordinati in base alle probabilità assegnate, in modo che vengano presi in considerazione solo i token più probabili. Il campionamento top-k limita direttamente il numero massimo di token da considerare, mentre il campionamento Nucleus limita il numero di token in base alla probabilità cumulativa.

Nota: il valore predefinito varia in base al modello. Consulta l'attributo Model.top_p della funzione Model restituita dalla funzione getModel.

topK integer

(Facoltativo) Il numero massimo di token da considerare durante il campionamento.

Il modello utilizza il campionamento combinato Top-k e nucleus.

Il campionamento Top-k considera l'insieme dei topK token più probabili. Il valore predefinito è 40.

Nota: il valore predefinito varia in base al modello. Consulta l'attributo Model.top_k della funzione Model restituita dalla funzione getModel.

Corpo della risposta

In caso di esito positivo, il corpo della risposta contiene un'istanza di GenerateTextResponse.

Metodo: models.countTextTokens

Esegue il tokenizer di un modello su un testo e restituisce il conteggio dei token.

Endpoint

post https://generativelanguage.googleapis.com/v1beta/{model=models/*}:countTextTokens

Parametri del percorso

model string

Obbligatorio. Il nome della risorsa del modello. che funge da ID da utilizzare per il modello.

Questo nome deve corrispondere a un nome di modello restituito dal metodo models.list.

Formato: models/{model}. Assume la forma models/{model}.

Corpo della richiesta

Il corpo della richiesta contiene dati con la seguente struttura:

Campi
prompt object (TextPrompt)

Obbligatorio. Il testo di input in formato libero fornito al modello come prompt.

Corpo della risposta

Una risposta da models.countTextTokens.

Restituisce il tokenCount del modello per prompt.

In caso di esito positivo, il corpo della risposta contiene dati con la seguente struttura:

Campi
tokenCount integer

Il numero di token in cui model suddivide prompt.

Sempre non negativi.

Rappresentazione JSON 
{
  "tokenCount": integer
}

Metodo: models.generateMessage

Genera una risposta dal modello dato un input MessagePrompt.

Endpoint

post https://generativelanguage.googleapis.com/v1beta/{model=models/*}:generateMessage

Parametri del percorso

model string

Obbligatorio. Il nome del modello da utilizzare.

Formato: name=models/{model}. Assume la forma models/{model}.

Corpo della richiesta

Il corpo della richiesta contiene dati con la seguente struttura:

Campi
prompt object (MessagePrompt)

Obbligatorio. L'input testuale strutturato fornito al modello come prompt.

Dato un prompt, il modello restituirà quello che prevede essere il messaggio successivo nella discussione.

temperature number

(Facoltativo) Controlla la casualità dell'output.

I valori possono variare in un intervallo di [0.0,1.0], inclusi. Un valore più vicino a 1.0 produrrà risposte più varie, mentre un valore più vicino a 0.0 in genere genererà risposte meno sorprendenti da parte del modello.

candidateCount integer

(Facoltativo) Il numero di messaggi di risposta generati da restituire.

Questo valore deve essere compreso tra [1, 8] incluso. Se non viene impostato, il valore predefinito è 1.

topP number

(Facoltativo) La probabilità cumulativa massima dei token da considerare durante il campionamento.

Il modello utilizza il campionamento combinato Top-k e nucleus.

Il campionamento del nucleo considera il più piccolo insieme di token la cui somma di probabilità è almeno topP.

topK integer

(Facoltativo) Il numero massimo di token da considerare durante il campionamento.

Il modello utilizza il campionamento combinato Top-k e nucleus.

Il campionamento Top-k considera l'insieme dei topK token più probabili.

Corpo della risposta

La risposta del modello.

Sono inclusi i messaggi dei candidati e la cronologia delle conversazioni sotto forma di messaggi ordinati cronologicamente.

In caso di esito positivo, il corpo della risposta contiene dati con la seguente struttura:

Campi
candidates[] object (Message)

Messaggi di risposta candidati del modello.

messages[] object (Message)

La cronologia delle conversazioni utilizzata dal modello.

filters[] object (ContentFilter)

Un insieme di metadati di filtraggio dei contenuti per il testo del prompt e della risposta.

Indica quali SafetyCategoryhanno bloccato un candidato da questa risposta, il HarmProbability più basso che ha attivato un blocco e l'impostazione HarmThreshold per quella categoria.

Rappresentazione JSON 
{
  "candidates": [
    {
      object (Message)
    }
  ],
  "messages": [
    {
      object (Message)
    }
  ],
  "filters": [
    {
      object (ContentFilter)
    }
  ]
}

Metodo: models.countMessageTokens

Esegue il tokenizer di un modello su una stringa e restituisce il conteggio dei token.

Endpoint

post https://generativelanguage.googleapis.com/v1beta/{model=models/*}:countMessageTokens

Parametri del percorso

model string

Obbligatorio. Il nome della risorsa del modello. che funge da ID da utilizzare per il modello.

Questo nome deve corrispondere a un nome di modello restituito dal metodo models.list.

Formato: models/{model}. Assume la forma models/{model}.

Corpo della richiesta

Il corpo della richiesta contiene dati con la seguente struttura:

Campi
prompt object (MessagePrompt)

Obbligatorio. Il prompt di cui deve essere restituito il conteggio dei token.

Corpo della risposta

Una risposta da models.countMessageTokens.

Restituisce il tokenCount del modello per prompt.

In caso di esito positivo, il corpo della risposta contiene dati con la seguente struttura:

Campi
tokenCount integer

Il numero di token in cui model suddivide prompt.

Sempre non negativi.

Rappresentazione JSON 
{
  "tokenCount": integer
}

Metodo: models.embedText

Genera un embedding dal modello dato un messaggio di input.

Endpoint

post https://generativelanguage.googleapis.com/v1beta/{model=models/*}:embedText

Parametri del percorso

model string

Obbligatorio. Il nome del modello da utilizzare con il formato model=models/{model}. Assume la forma models/{model}.

Corpo della richiesta

Il corpo della richiesta contiene dati con la seguente struttura:

Campi
text string

(Facoltativo) Il testo di input in formato libero che il modello trasformerà in un embedding.

Corpo della risposta

La risposta a una EmbedTextRequest.

In caso di esito positivo, il corpo della risposta contiene dati con la seguente struttura:

Campi
embedding object (Embedding)

Solo output. L'incorporamento generato dal testo di input.

Rappresentazione JSON 
{
  "embedding": {
    object (Embedding)
  }
}

Metodo: models.batchEmbedText

Genera più incorporamenti dal modello dato il testo di input in una chiamata sincrona.

Endpoint

post https://generativelanguage.googleapis.com/v1beta/{model=models/*}:batchEmbedText

Parametri del percorso

model string

Obbligatorio. Il nome di Model da utilizzare per generare l'incorporamento. Esempi: models/embedding-gecko-001 Assume il formato models/{model}.

Corpo della richiesta

Il corpo della richiesta contiene dati con la seguente struttura:

Campi
texts[] string

(Facoltativo) I testi di input in formato libero che il modello trasformerà in un embedding. Il limite attuale è di 100 testi, oltre il quale verrà generato un errore.

requests[] object (EmbedTextRequest)

(Facoltativo) Incorpora le richieste per il batch. È possibile impostare solo uno tra texts o requests.

Corpo della risposta

La risposta a una EmbedTextRequest.

In caso di esito positivo, il corpo della risposta contiene dati con la seguente struttura:

Campi
embeddings[] object (Embedding)

Solo output. Gli incorporamenti generati dal testo di input.

Rappresentazione JSON 
{
  "embeddings": [
    {
      object (Embedding)
    }
  ]
}

EmbedTextRequest

Richiesta per ottenere un embedding di testo dal modello.

Campi
model string

Obbligatorio. Il nome del modello da utilizzare con il formato model=models/{model}.

text string

(Facoltativo) Il testo di input in formato libero che il modello trasformerà in un embedding.

Rappresentazione JSON 
{
  "model": string,
  "text": string
}

ContentFilter

Metadati di filtraggio dei contenuti associati all'elaborazione di una singola richiesta.

ContentFilter contiene un motivo e una stringa di supporto facoltativa. Il motivo potrebbe non essere specificato.

Campi
reason enum (BlockedReason)

Il motivo per cui i contenuti sono stati bloccati durante l'elaborazione della richiesta.

message string

Una stringa che descrive in modo più dettagliato il comportamento di filtraggio.

Rappresentazione JSON 
{
  "reason": enum (BlockedReason),
  "message": string
}

BlockedReason

Un elenco dei motivi per cui i contenuti potrebbero essere stati bloccati.

Enum
BLOCKED_REASON_UNSPECIFIED Non è stato specificato un motivo di blocco.
SAFETY I contenuti sono stati bloccati dalle impostazioni di sicurezza.
OTHER I contenuti sono stati bloccati, ma il motivo non è classificato.

Incorporamento

Un elenco di numeri in virgola mobile che rappresentano l'incorporamento.

Campi
value[] number

I valori di incorporamento.

Rappresentazione JSON 
{
  "value": [
    number
  ]
}

Messaggio

L'unità di base del testo strutturato.

Un Message include un author e il content del Message.

Il author viene utilizzato per taggare i messaggi quando vengono inseriti nel modello come testo.

Campi
author string

(Facoltativo) L'autore di questo messaggio.

che funge da chiave per taggare i contenuti di questo messaggio quando vengono inseriti nel modello come testo.

L'autore può essere qualsiasi stringa alfanumerica.

content string

Obbligatorio. Il contenuto testuale di Message strutturato.

citationMetadata object (CitationMetadata)

Solo output. Informazioni sulle citazioni per content generato dal modello in questo Message.

Se questo Message è stato generato come output dal modello, questo campo potrebbe essere compilato con le informazioni sull'attribuzione per qualsiasi testo incluso in content. Questo campo viene utilizzato solo nell'output.

Rappresentazione JSON 
{
  "author": string,
  "content": string,
  "citationMetadata": {
    object (CitationMetadata)
  }
}

MessagePrompt

Tutto il testo di input strutturato passato al modello come prompt.

Un MessagePrompt contiene un insieme strutturato di campi che forniscono il contesto della conversazione, esempi di coppie di messaggi di input dell'utente/output del modello che preparano il modello a rispondere in modi diversi e la cronologia della conversazione o l'elenco dei messaggi che rappresentano i turni alternati della conversazione tra l'utente e il modello.

Campi
context string

(Facoltativo) Testo che deve essere fornito per primo al modello per basare la risposta.

Se non è vuoto, questo context verrà fornito prima al modello, prima di examples e messages. Quando utilizzi un context, assicurati di fornirlo con ogni richiesta per mantenere la continuità.

Questo campo può contenere una descrizione del prompt per il modello, in modo da fornire contesto e guidare le risposte. Esempi: "Traduci la frase dall'inglese al francese" o "Data un'affermazione, classifica il sentimento come felice, triste o neutro".

Qualsiasi elemento incluso in questo campo avrà la precedenza sulla cronologia dei messaggi se le dimensioni totali dell'input superano il valore inputTokenLimit del modello e la richiesta di input viene troncata.

examples[] object (Example)

(Facoltativo) Esempi di ciò che il modello deve generare.

Sono inclusi sia l'input dell'utente sia la risposta che il modello deve emulare.

Questi examples vengono trattati in modo identico ai messaggi della conversazione, tranne per il fatto che hanno la precedenza sulla cronologia in messages: se le dimensioni totali dell'input superano il inputTokenLimit del modello, l'input verrà troncato. Gli articoli verranno eliminati da messages prima del giorno examples.

messages[] object (Message)

Obbligatorio. Uno snapshot della cronologia delle conversazioni recenti ordinata cronologicamente.

I turni si alternano tra due autori.

Se le dimensioni totali dell'input superano inputTokenLimit del modello, l'input verrà troncato: gli elementi più vecchi verranno eliminati da messages.

Rappresentazione JSON 
{
  "context": string,
  "examples": [
    {
      object (Example)
    }
  ],
  "messages": [
    {
      object (Message)
    }
  ]
}

Esempio

Un esempio di input/output utilizzato per istruire il modello.

Mostra come il modello dovrebbe rispondere o formattare la risposta.

Campi
input object (Message)

Obbligatorio. Un esempio di input Message dell'utente.

output object (Message)

Obbligatorio. Un esempio di ciò che il modello dovrebbe restituire dato l'input.

Rappresentazione JSON 
{
  "input": {
    object (Message)
  },
  "output": {
    object (Message)
  }
}

GenerateTextResponse

La risposta del modello, inclusi i completamenti candidati.

Campi
candidates[] object (TextCompletion)

Risposte candidate del modello.

filters[] object (ContentFilter)

Un insieme di metadati di filtraggio dei contenuti per il testo del prompt e della risposta.

Indica quali SafetyCategoryhanno bloccato un candidato da questa risposta, il HarmProbability più basso che ha attivato un blocco e l'impostazione HarmThreshold per quella categoria. Indica la più piccola modifica al SafetySettings necessaria per sbloccare almeno una risposta.

Il blocco viene configurato da SafetySettings nella richiesta (o da SafetySettings predefinito dell'API).

safetyFeedback[] object (SafetyFeedback)

Restituisce eventuali feedback sulla sicurezza relativi al filtro dei contenuti.

Rappresentazione JSON 
{
  "candidates": [
    {
      object (TextCompletion)
    }
  ],
  "filters": [
    {
      object (ContentFilter)
    }
  ],
  "safetyFeedback": [
    {
      object (SafetyFeedback)
    }
  ]
}

TextCompletion

Testo di output restituito da un modello.

Campi
output string

Solo output. Il testo generato restituito dal modello.

safetyRatings[] object (SafetyRating)

Valutazioni della sicurezza di una risposta.

È presente al massimo una classificazione per categoria.

citationMetadata object (CitationMetadata)

Solo output. Informazioni sulle citazioni per output generato dal modello in questo TextCompletion.

Questo campo può essere compilato con le informazioni sull'attribuzione per qualsiasi testo incluso in output.

Rappresentazione JSON 
{
  "output": string,
  "safetyRatings": [
    {
      object (SafetyRating)
    }
  ],
  "citationMetadata": {
    object (CitationMetadata)
  }
}

SafetyFeedback

Feedback sulla sicurezza per un'intera richiesta.

Questo campo viene compilato se i contenuti nell'input e/o nella risposta vengono bloccati a causa delle impostazioni di sicurezza. SafetyFeedback potrebbe non esistere per ogni HarmCategory. Ogni SafetyFeedback restituirà le impostazioni di sicurezza utilizzate dalla richiesta, nonché la probabilità di danno più bassa che deve essere consentita per restituire un risultato.

Campi
rating object (SafetyRating)

Valutazione della sicurezza valutata in base ai contenuti.

setting object (SafetySetting)

Impostazioni di sicurezza applicate alla richiesta.

Rappresentazione JSON 
{
  "rating": {
    object (SafetyRating)
  },
  "setting": {
    object (SafetySetting)
  }
}

TextPrompt

Testo fornito al modello come prompt.

Il modello utilizzerà questo TextPrompt per generare il completamento del testo.

Campi
text string

Obbligatorio. Il testo del prompt.

Rappresentazione JSON 
{
  "text": string
}