Package Genai è un client per il modello generativo Vertex AI.
Blob
type Blob struct {
// Required. The IANA standard MIME type of the source data.
MIMEType string
// Required. Raw bytes for media formats.
Data []byte
}Il BLOB contiene byte multimediali non elaborati.
Il testo non deve essere inviato come byte non elaborati, utilizza il campo "testo".
func ImageData
ImageData è una funzione di convenienza per creare un BLOB di immagine da inserire in un modello. Il formato deve essere la seconda parte del tipo MIME, dopo "image/". Ad esempio, per un'immagine PNG, aggiungi "png".
BlockedError
type BlockedError struct {
// If non-nil, the model's response was blocked.
// Consult the Candidate and SafetyRatings fields for details.
Candidate *Candidate
// If non-nil, there was a problem with the prompt.
PromptFeedback *PromptFeedback
}Un errore BLOCKEDError indica che la risposta del modello è stata bloccata. Le cause possono essere due: il prompt o la risposta di un candidato.
func (*BlockedError) Error
func (e *BlockedError) Error() stringBlockedReason
type BlockedReason int32L'enumerazione dei motivi bloccata è bloccata.
BLOCKEDReasonUnspecified, RestrictedReasonSafety, AllowedReasonOther
const (
// BlockedReasonUnspecified means unspecified blocked reason.
BlockedReasonUnspecified BlockedReason = 0
// BlockedReasonSafety means candidates blocked due to safety.
BlockedReasonSafety BlockedReason = 1
// BlockedReasonOther means candidates blocked due to other reason.
BlockedReasonOther BlockedReason = 2
)func (BlockedReason) String
func (v BlockedReason) String() stringCandidato
type Candidate struct {
// Output only. Index of the candidate.
Index int32
// Output only. Content parts of the candidate.
Content *Content
// Output only. The reason why the model stopped generating tokens.
// If empty, the model has not stopped generating the tokens.
FinishReason FinishReason
// Output only. List of ratings for the safety of a response candidate.
//
// There is at most one rating per category.
SafetyRatings []*SafetyRating
// Output only. Describes the reason the mode stopped generating tokens in
// more detail. This is only filled when `finish_reason` is set.
FinishMessage string
// Output only. Source attribution of the generated content.
CitationMetadata *CitationMetadata
}Il candidato è un candidato di risposta generato dal modello.
ChatSession
type ChatSession struct {
History []*Content
// contains filtered or unexported fields
}Una ChatSession offre una chat interattiva.
Esempio
package main
import (
"context"
"fmt"
"log"
"cloud.google.com/go/vertexai/genai"
"google.golang.org/api/iterator"
)
// Your GCP project
const projectID = "your-project"
// A GCP location like "us-central1"
const location = "some-gcp-location"
// A model name like "gemini-pro"
const model = "some-model"
func main() {
ctx := context.Background()
client, err := genai.NewClient(ctx, projectID, location)
if err != nil {
log.Fatal(err)
}
defer client.Close()
model := client.GenerativeModel(model)
cs := model.StartChat()
send := func(msg string) *genai.GenerateContentResponse {
fmt.Printf("== Me: %s\n== Model:\n", msg)
res, err := cs.SendMessage(ctx, genai.Text(msg))
if err != nil {
log.Fatal(err)
}
return res
}
res := send("Can you name some brands of air fryer?")
printResponse(res)
iter := cs.SendMessageStream(ctx, genai.Text("Which one of those do you recommend?"))
for {
res, err := iter.Next()
if err == iterator.Done {
break
}
if err != nil {
log.Fatal(err)
}
printResponse(res)
}
for i, c := range cs.History {
log.Printf(" %d: %+v", i, c)
}
res = send("Why do you like the Philips?")
if err != nil {
log.Fatal(err)
}
printResponse(res)
}
func printResponse(resp *genai.GenerateContentResponse) {
for _, cand := range resp.Candidates {
for _, part := range cand.Content.Parts {
fmt.Println(part)
}
}
fmt.Println("---")
}
func (*ChatSession) SendMessage
func (cs *ChatSession) SendMessage(ctx context.Context, parts ...Part) (*GenerateContentResponse, error)SendMessage invia una richiesta al modello come parte di una sessione di chat.
func (*ChatSession) SendMessageStream
func (cs *ChatSession) SendMessageStream(ctx context.Context, parts ...Part) *GenerateContentResponseIteratorSendMessageStream è come SendMessage, ma con una richiesta di streaming.
Citazione
type Citation struct {
// Output only. Start index into the content.
StartIndex int32
// Output only. End index into the content.
EndIndex int32
// Output only. Url reference of the attribution.
URI string
// Output only. Title of the attribution.
Title string
// Output only. License of the attribution.
License string
// Output only. Publication date of the attribution.
PublicationDate civil.Date
}La citazione contiene le attribuzioni della fonte dei contenuti.
CitationMetadata
type CitationMetadata struct {
// Output only. List of citations.
Citations []*Citation
}CitationMetadata è una raccolta di attribuzioni di fonti per un contenuto.
Client
type Client struct {
// contains filtered or unexported fields
}Un client è un client di Google Vertex AI.
func NewClient
func NewClient(ctx context.Context, projectID, location string, opts ...option.ClientOption) (*Client, error)Nuovo Client crea un nuovo client Google Vertex AI.
I client dovrebbero essere riutilizzati anziché creati in base alle esigenze. I metodi del client sono sicuri per l'uso simultaneo da più severi.
Puoi configurare il client passando le opzioni dal pacchetto [google.golang.org/api/option].
func (*Client) Close
Chiudi consente di chiudere il client.
func (*Client) GenerativeModel
func (c *Client) GenerativeModel(name string) *GenerativeModelGenerativeModel crea una nuova istanza del modello denominato.
Contenuti
type Content struct {
// Optional. The producer of the content. Must be either 'user' or 'model'.
//
// Useful to set for multi-turn conversations, otherwise can be left blank
// or unset.
Role string
// Required. Ordered `Parts` that constitute a single message. Parts may have
// different IANA MIME types.
Parts []Part
}Con "contenuti" si intende il tipo di dati strutturati di base che include contenuti in più parti di un messaggio.
Un Content include un campo role che designa il produttore del campo Content e un campo parts contenente dati in più parti con i contenuti del turno del messaggio.
CountTokensResponse
type CountTokensResponse struct {
// The total number of tokens counted across all instances from the request.
TotalTokens int32
// The total number of billable characters counted across all instances from
// the request.
TotalBillableCharacters int32
}CountTokensResponse è un messaggio di risposta per [PredictionService.CountTokens][google.cloud.aiplatform.v1beta1.PredictionService.CountTokens].
FileData
type FileData struct {
// Required. The IANA standard MIME type of the source data.
MIMEType string
// Required. URI.
FileURI string
}FileData sono dati basati su URI.
FinishReason
type FinishReason int32FinishReason è il motivo per cui il modello ha smesso di generare token. Se è vuoto, il modello non ha smesso di generare i token.
FinishReasonUnspecified, FinishReasonStop, FinishReasonMaxTokens, FinishReasonSafety, FinishReasonRecitation, FinishReasonOther
const (
// FinishReasonUnspecified means the finish reason is unspecified.
FinishReasonUnspecified FinishReason = 0
// FinishReasonStop means natural stop point of the model or provided stop sequence.
FinishReasonStop FinishReason = 1
// FinishReasonMaxTokens means the maximum number of tokens as specified in the request was reached.
FinishReasonMaxTokens FinishReason = 2
// FinishReasonSafety means the token generation was stopped as the response was flagged for safety
// reasons. NOTE: When streaming the Candidate.content will be empty if
// content filters blocked the output.
FinishReasonSafety FinishReason = 3
// FinishReasonRecitation means the token generation was stopped as the response was flagged for
// unauthorized citations.
FinishReasonRecitation FinishReason = 4
// FinishReasonOther means all other reasons that stopped the token generation
FinishReasonOther FinishReason = 5
)func (FinishReason) String
func (v FinishReason) String() stringFunctionCall
type FunctionCall struct {
// Required. The name of the function to call.
// Matches [FunctionDeclaration.name].
Name string
// Optional. Required. The function parameters and values in JSON object
// format. See [FunctionDeclaration.parameters] for parameter details.
Args map[string]any
}FunctionCall è un valore [FunctionCall] previsto restituito dal modello che contiene una stringa che rappresenta [FunctionDeclaration.name] e un oggetto JSON strutturato contenente i parametri e i relativi valori.
FunctionDeclaration
type FunctionDeclaration struct {
// Required. The name of the function to call.
// Must start with a letter or an underscore.
// Must be a-z, A-Z, 0-9, or contain underscores and dashes, with a maximum
// length of 64.
Name string
// Optional. Description and purpose of the function.
// Model uses it to decide how and whether to call the function.
Description string
// Optional. Describes the parameters to this function in JSON Schema Object
// format. Reflects the Open API 3.03 Parameter Object. string Key: the name
// of the parameter. Parameter names are case sensitive. Schema Value: the
// Schema defining the type used for the parameter. For function with no
// parameters, this can be left unset. Example with 1 required and 1 optional
// parameter: type: OBJECT properties:
// param1:
// type: STRING
// param2:
// type: INTEGER
// required:
// - param1
Parameters *Schema
}FunctionDeclaration è una rappresentazione strutturata di una dichiarazione di funzione come definito dalla specifica OpenAPI 3.0. Questa dichiarazione include il nome e i parametri della funzione. Questa dichiarazione di funzione è una rappresentazione di un blocco di codice che può essere utilizzato come Tool dal modello ed eseguito dal client.
FunctionResponse
type FunctionResponse struct {
// Required. The name of the function to call.
// Matches [FunctionDeclaration.name] and [FunctionCall.name].
Name string
// Required. The function response in JSON object format.
Response map[string]any
}FunctionResponse è l'output del risultato di una funzione [FunctionCall] contenente una stringa che rappresenta [FunctionDeclaration.name], mentre un oggetto JSON strutturato contenente qualsiasi output della funzione viene utilizzato come contesto per il modello. Deve contenere il risultato di una funzione [FunctionCall] in base alla previsione del modello.
GenerateContentResponse
type GenerateContentResponse struct {
// Output only. Generated candidates.
Candidates []*Candidate
// Output only. Content filter results for a prompt sent in the request.
// Note: Sent only in the first stream chunk.
// Only happens when no candidates were generated due to content violations.
PromptFeedback *PromptFeedback
// Usage metadata about the response(s).
UsageMetadata *UsageMetadata
}GeneraContentResponse è la risposta a una chiamata GeneraContent o GeneraContentStream.
GenerateContentResponseIterator
type GenerateContentResponseIterator struct {
// contains filtered or unexported fields
}GeneraContentResponseIterator è un iteratore di GnerateContentResponse.
func (*GenerateContentResponseIterator) Next
func (iter *GenerateContentResponseIterator) Next() (*GenerateContentResponse, error)Next restituisce la risposta successiva.
GenerationConfig
type GenerationConfig struct {
// Optional. Controls the randomness of predictions.
Temperature float32
// Optional. If specified, nucleus sampling will be used.
TopP float32
// Optional. If specified, top-k sampling will be used.
TopK float32
// Optional. Number of candidates to generate.
CandidateCount int32
// Optional. The maximum number of output tokens to generate per message.
MaxOutputTokens int32
// Optional. Stop sequences.
StopSequences []string
}GenerationConfig è una configurazione di generazione.
GenerativeModel
type GenerativeModel struct {
GenerationConfig
SafetySettings []*SafetySetting
Tools []*Tool
// contains filtered or unexported fields
}GenerativeModel è un modello in grado di generare testo. Creane una con [Client.GenerativeModel] e configurala impostando i campi esportati.
Il modello contiene tutte le configurazioni per una richiesta ManageContentRequest, quindi il metodo metodoGenerateContent può utilizzare un vararg per i contenuti.
func (*GenerativeModel) CountTokens
func (m *GenerativeModel) CountTokens(ctx context.Context, parts ...Part) (*CountTokensResponse, error)CountTokens conteggia il numero di token nel contenuto.
Esempio
package main
import (
"context"
"fmt"
"log"
"cloud.google.com/go/vertexai/genai"
)
// Your GCP project
const projectID = "your-project"
// A GCP location like "us-central1"
const location = "some-gcp-location"
// A model name like "gemini-pro"
const model = "some-model"
func main() {
ctx := context.Background()
client, err := genai.NewClient(ctx, projectID, location)
if err != nil {
log.Fatal(err)
}
defer client.Close()
model := client.GenerativeModel(model)
resp, err := model.CountTokens(ctx, genai.Text("What kind of fish is this?"))
if err != nil {
log.Fatal(err)
}
fmt.Println("Num tokens:", resp.TotalTokens)
}
func (*GenerativeModel) GenerateContent
func (m *GenerativeModel) GenerateContent(ctx context.Context, parts ...Part) (*GenerateContentResponse, error)GeneraContent produce una singola richiesta e risposta.
Esempio
package main
import (
"context"
"fmt"
"log"
"cloud.google.com/go/vertexai/genai"
)
// Your GCP project
const projectID = "your-project"
// A GCP location like "us-central1"
const location = "some-gcp-location"
// A model name like "gemini-pro"
const model = "some-model"
func main() {
ctx := context.Background()
client, err := genai.NewClient(ctx, projectID, location)
if err != nil {
log.Fatal(err)
}
defer client.Close()
model := client.GenerativeModel(model)
model.Temperature = 0.9
resp, err := model.GenerateContent(ctx, genai.Text("What is the average size of a swallow?"))
if err != nil {
log.Fatal(err)
}
printResponse(resp)
}
func printResponse(resp *genai.GenerateContentResponse) {
for _, cand := range resp.Candidates {
for _, part := range cand.Content.Parts {
fmt.Println(part)
}
}
fmt.Println("---")
}
func (*GenerativeModel) GenerateContentStream
func (m *GenerativeModel) GenerateContentStream(ctx context.Context, parts ...Part) *GenerateContentResponseIteratorGeneraContentStream restituisce un iteratore che elenca le risposte.
Esempio
package main
import (
"context"
"fmt"
"log"
"cloud.google.com/go/vertexai/genai"
"google.golang.org/api/iterator"
)
// Your GCP project
const projectID = "your-project"
// A GCP location like "us-central1"
const location = "some-gcp-location"
// A model name like "gemini-pro"
const model = "some-model"
func main() {
ctx := context.Background()
client, err := genai.NewClient(ctx, projectID, location)
if err != nil {
log.Fatal(err)
}
defer client.Close()
model := client.GenerativeModel(model)
iter := model.GenerateContentStream(ctx, genai.Text("Tell me a story about a lumberjack and his giant ox. Keep it very short."))
for {
resp, err := iter.Next()
if err == iterator.Done {
break
}
if err != nil {
log.Fatal(err)
}
printResponse(resp)
}
}
func printResponse(resp *genai.GenerateContentResponse) {
for _, cand := range resp.Candidates {
for _, part := range cand.Content.Parts {
fmt.Println(part)
}
}
fmt.Println("---")
}
func (*GenerativeModel) Name
func (m *GenerativeModel) Name() stringNome restituisce il nome del modello.
func (*GenerativeModel) StartChat
func (m *GenerativeModel) StartChat() *ChatSessionStartChat avvia una sessione di chat.
HarmBlockThreshold
type HarmBlockThreshold int32HarmBlockThreshold specifica i livelli soglia basati sulla probabilità per il blocco.
HarmBlockNon specificato, HarmBlockLowAndAbove, HarmBlockMediumAndAbove, HarmBlockOnlyHigh, HarmBlockNone
const (
// HarmBlockUnspecified means unspecified harm block threshold.
HarmBlockUnspecified HarmBlockThreshold = 0
// HarmBlockLowAndAbove means block low threshold and above (i.e. block more).
HarmBlockLowAndAbove HarmBlockThreshold = 1
// HarmBlockMediumAndAbove means block medium threshold and above.
HarmBlockMediumAndAbove HarmBlockThreshold = 2
// HarmBlockOnlyHigh means block only high threshold (i.e. block less).
HarmBlockOnlyHigh HarmBlockThreshold = 3
// HarmBlockNone means block none.
HarmBlockNone HarmBlockThreshold = 4
)func (HarmBlockThreshold) String
func (v HarmBlockThreshold) String() stringHarmCategory
type HarmCategory int32HarmCategory specifica le categorie di danni che bloccano i contenuti.
Categoria di dannoNon specificata, Categoria di danni incitamento all'odio, Categoria Contenuti pericolosi, Categoria di danni Molestie, Categoria di danni sessualmente esplicita
const (
// HarmCategoryUnspecified means the harm category is unspecified.
HarmCategoryUnspecified HarmCategory = 0
// HarmCategoryHateSpeech means the harm category is hate speech.
HarmCategoryHateSpeech HarmCategory = 1
// HarmCategoryDangerousContent means the harm category is dangerous content.
HarmCategoryDangerousContent HarmCategory = 2
// HarmCategoryHarassment means the harm category is harassment.
HarmCategoryHarassment HarmCategory = 3
// HarmCategorySexuallyExplicit means the harm category is sexually explicit content.
HarmCategorySexuallyExplicit HarmCategory = 4
)func (HarmCategory) String
func (v HarmCategory) String() stringHarmProbability
type HarmProbability int32HarmProbability specifica i livelli di probabilità di danno nei contenuti.
Probabilità di HarmNon specificata, Probabilità di danni trascurabile, Probabilità di HarmProbabilityBassa, Probabilità di danni media, Probabilità di danni elevata
const (
// HarmProbabilityUnspecified means harm probability unspecified.
HarmProbabilityUnspecified HarmProbability = 0
// HarmProbabilityNegligible means negligible level of harm.
HarmProbabilityNegligible HarmProbability = 1
// HarmProbabilityLow means low level of harm.
HarmProbabilityLow HarmProbability = 2
// HarmProbabilityMedium means medium level of harm.
HarmProbabilityMedium HarmProbability = 3
// HarmProbabilityHigh means high level of harm.
HarmProbabilityHigh HarmProbability = 4
)func (HarmProbability) String
func (v HarmProbability) String() stringParte
type Part interface {
// contains filtered or unexported methods
}Una parte è un Text, un Blob o un FileData.
PromptFeedback
type PromptFeedback struct {
// Output only. Blocked reason.
BlockReason BlockedReason
// Output only. Safety ratings.
SafetyRatings []*SafetyRating
// Output only. A readable block reason message.
BlockReasonMessage string
}PromptFeedback contiene i risultati del filtro dei contenuti per un prompt inviato nella richiesta.
SafetyRating
type SafetyRating struct {
// Output only. Harm category.
Category HarmCategory
// Output only. Harm probability levels in the content.
Probability HarmProbability
// Output only. Indicates whether the content was filtered out because of this
// rating.
Blocked bool
}SafetyRating è la valutazione di sicurezza corrispondente ai contenuti generati.
SafetySetting
type SafetySetting struct {
// Required. Harm category.
Category HarmCategory
// Required. The harm block threshold.
Threshold HarmBlockThreshold
}Impostazioni di sicurezza sono impostazioni di sicurezza.
Schema
type Schema struct {
// Optional. The type of the data.
Type Type
// Optional. The format of the data.
// Supported formats:
// for NUMBER type: float, double
// for INTEGER type: int32, int64
Format string
// Optional. The description of the data.
Description string
// Optional. Indicates if the value may be null.
Nullable bool
// Optional. Schema of the elements of Type.ARRAY.
Items *Schema
// Optional. Possible values of the element of Type.STRING with enum format.
// For example we can define an Enum Direction as :
// {type:STRING, format:enum, enum:["EAST", NORTH", "SOUTH", "WEST"]}
Enum []string
// Optional. Properties of Type.OBJECT.
Properties map[string]*Schema
// Optional. Required properties of Type.OBJECT.
Required []string
}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à.
Testo
type Text stringUn testo è un pezzo di testo, ad esempio una domanda o una frase.
Strumento
type Tool struct {
// Optional. One or more function declarations to be passed to the model along
// with the current user query. Model may decide to call a subset of these
// functions by populating [FunctionCall][content.part.function_call] in the
// response. User should provide a
// [FunctionResponse][content.part.function_response] for each function call
// in the next turn. Based on the function responses, Model will generate the
// final response back to the user. Maximum 64 function declarations can be
// provided.
FunctionDeclarations []*FunctionDeclaration
}Dettagli dello strumento che il modello può utilizzare per generare la risposta.
Un Tool è 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 delle
informazioni e dell'ambito del modello.
Tipo
type Type int32Il tipo contiene l'elenco dei tipi di dati OpenAPI come definito da https://swagger.io/docs/specification/data-models/data-types/
TypeUnspecified, TypeString, TypeNumber, TypeInteger, TypeBoolean, TypeArray, TypeObject
const (
// TypeUnspecified means not specified, should not be used.
TypeUnspecified Type = 0
// TypeString means openAPI string type
TypeString Type = 1
// TypeNumber means openAPI number type
TypeNumber Type = 2
// TypeInteger means openAPI integer type
TypeInteger Type = 3
// TypeBoolean means openAPI boolean type
TypeBoolean Type = 4
// TypeArray means openAPI array type
TypeArray Type = 5
// TypeObject means openAPI object type
TypeObject Type = 6
)func (Type) String
UsageMetadata
type UsageMetadata struct {
// Number of tokens in the request.
PromptTokenCount int32
// Number of tokens in the response(s).
CandidatesTokenCount int32
TotalTokenCount int32
}UsageMetadata è un metadati di utilizzo relativi alle risposte.