Live API - WebSockets API reference

Live API është një API me gjendje stateful që përdor WebSockets . Në këtë seksion, do të gjeni detaje shtesë në lidhje me WebSockets API.

Sesione

Një lidhje WebSocket krijon një seancë midis klientit dhe serverit Gemini. Pasi një klient fillon një lidhje të re, seanca mund të shkëmbejë mesazhe me serverin për të:

  • Dërgoni tekst, audio ose video në serverin Gemini.
  • Merrni kërkesa për audio, tekst ose thirrje funksioni nga serveri Gemini.

Lidhja WebSocket

Për të filluar një seancë, lidheni me këtë pikë fundore të websocket:

wss://generativelanguage.googleapis.com/ws/google.ai.generativelanguage.v1beta.GenerativeService.BidiGenerateContent

Konfigurimi i sesionit

Mesazhi fillestar i dërguar pas vendosjes së lidhjes WebSocket përcakton konfigurimin e sesionit, i cili përfshin modelin, parametrat e gjenerimit, udhëzimet e sistemit dhe mjetet.

Nuk mund ta përditësoni konfigurimin ndërsa lidhja është e hapur. Megjithatë, mund të ndryshoni parametrat e konfigurimit, përveç modelit, gjatë pauzës dhe rifillimit nëpërmjet mekanizmit të rifillimit të seancës .

Shihni shembullin e mëposhtëm të konfigurimit. Vini re se shkronjat e mëdha dhe të mëdha të emrit në SDK mund të ndryshojnë. Mund të shikoni opsionet e konfigurimit të SDK-së së Python këtu .


{
  "model": string,
  "generationConfig": {
    "candidateCount": integer,
    "maxOutputTokens": integer,
    "temperature": number,
    "topP": number,
    "topK": integer,
    "presencePenalty": number,
    "frequencyPenalty": number,
    "responseModalities": [string],
    "speechConfig": object,
    "mediaResolution": object
  },
  "systemInstruction": string,
  "tools": [object]
}

Për më shumë informacion mbi fushën API, shihni generationConfig .

Dërgo mesazhe

Për të shkëmbyer mesazhe nëpërmjet lidhjes WebSocket, klienti duhet të dërgojë një objekt JSON nëpërmjet një lidhjeje të hapur WebSocket. Objekti JSON duhet të ketë saktësisht një nga fushat nga grupi i mëposhtëm i objekteve:


{
  "setup": BidiGenerateContentSetup,
  "clientContent": BidiGenerateContentClientContent,
  "realtimeInput": BidiGenerateContentRealtimeInput,
  "toolResponse": BidiGenerateContentToolResponse
}

Mesazhet e mbështetura të klientit

Shihni mesazhet e mbështetura të klientit në tabelën e mëposhtme:

Mesazh Përshkrimi
BidiGenerateContentSetup Konfigurimi i sesionit që do të dërgohet në mesazhin e parë
BidiGenerateContentClientContent Përditësim gradual i përmbajtjes së bisedës aktuale të dorëzuar nga klienti
BidiGenerateContentRealtimeInput Futje audio, video ose teksti në kohë reale
BidiGenerateContentToolResponse Përgjigje ndaj një ToolCallMessage të marrë nga serveri

Merr mesazhe

Për të marrë mesazhe nga Gemini, dëgjoni ngjarjen 'mesazh' të WebSocket dhe më pas analizoni rezultatin sipas përkufizimit të mesazheve të serverit të mbështetur.

Shihni sa vijon:

async with client.aio.live.connect(model='...', config=config) as session:
    await session.send(input='Hello world!', end_of_turn=True)
    async for message in session.receive():
        print(message)

Mesazhet e serverit mund të kenë një fushë usageMetadata , por përndryshe do të përfshijnë saktësisht një nga fushat e tjera nga mesazhi BidiGenerateContentServerMessage . (Bashkimi messageType nuk shprehet në JSON, kështu që fusha do të shfaqet në nivelin më të lartë të mesazhit.)

Mesazhe dhe ngjarje

Fundi i Aktivitetit

Ky lloj nuk ka fusha.

Shënon fundin e aktivitetit të përdoruesit.

Trajtimi i Aktivitetit

Mënyra të ndryshme për të menaxhuar aktivitetin e përdoruesit.

Numërime
ACTIVITY_HANDLING_UNSPECIFIED Nëse nuk specifikohet, sjellja e parazgjedhur është START_OF_ACTIVITY_INTERRUPTS .
START_OF_ACTIVITY_INTERRUPTS Nëse është e vërtetë, fillimi i aktivitetit do të ndërpresë përgjigjen e modelit (i quajtur edhe "hyrje me barkë"). Përgjigja aktuale e modelit do të ndërpritet në momentin e ndërprerjes. Kjo është sjellja e parazgjedhur.
NO_INTERRUPTION Përgjigja e modelit nuk do të ndërpritet.

Fillimi i Aktivitetit

Ky lloj nuk ka fusha.

Shënon fillimin e aktivitetit të përdoruesit.

Konfigurimi i Transkriptimit Audio

Ky lloj nuk ka fusha.

Konfigurimi i transkriptimit të audios.

Zbulimi Automatik i Aktivitetit

Konfiguron zbulimin automatik të aktivitetit.

Fushat
disabled

bool

Opsionale. Nëse aktivizohet (parazgjedhja), zëri dhe teksti i zbuluar llogariten si aktivitet. Nëse çaktivizohet, klienti duhet të dërgojë sinjale aktiviteti.

startOfSpeechSensitivity

StartSensitivity

Opsionale. Përcakton se sa e mundshme është që të zbulohet të folurit.

prefixPaddingMs

int32

Opsionale. Kohëzgjatja e kërkuar e të folurit të zbuluar para fillimit të të folurit është e fiksuar. Sa më e ulët kjo vlerë, aq më e ndjeshme është zbulimi i fillimit të të folurit dhe mund të njihet një të folur më e shkurtër. Megjithatë, kjo gjithashtu rrit probabilitetin e pozitiveve të rreme.

endOfSpeechSensitivity

EndSensitivity

Opsionale. Përcakton se sa gjasa ka që të ndërpritet të folurit e zbuluar.

silenceDurationMs

int32

Opsionale. Kohëzgjatja e kërkuar e mos-fjalës së zbuluar (p.sh. heshtje) para përfundimit të të folurit. Sa më e madhe kjo vlerë, aq më të gjata mund të jenë boshllëqet e të folurit pa ndërprerë aktivitetin e përdoruesit, por kjo do të rrisë vonesën e modelit.

BidiGenerateContentClientContent

Përditësim gradual i bisedës aktuale të dorëzuar nga klienti. I gjithë përmbajtja këtu i shtohet pa kushte historikut të bisedës dhe përdoret si pjesë e kërkesës për modelin për të gjeneruar përmbajtje.

Një mesazh këtu do të ndërpresë çdo gjenerim aktual të modelit.

Fushat
turns[]

Content

Opsionale. Përmbajtja e shtuar në bisedën aktuale me modelin.

Për pyetjet me një kthesë, kjo është një instancë e vetme. Për pyetjet me shumë kthesa, kjo është një fushë e përsëritur që përmban historikun e bisedave dhe kërkesën e fundit.

turnComplete

bool

Opsionale. Nëse është e vërtetë, tregon që gjenerimi i përmbajtjes së serverit duhet të fillojë me kërkesën e akumuluar aktualisht. Përndryshe, serveri pret mesazhe shtesë përpara se të fillojë gjenerimin.

BidiGenerateContentInputRealtime

Të dhënat e përdoruesit dërgohen në kohë reale.

Modalitetet e ndryshme (audio, video dhe tekst) trajtohen si transmetime të njëkohshme. Renditja në këto transmetime nuk është e garantuar.

Kjo ndryshon nga BidiGenerateContentClientContent në disa mënyra:

  • Mund të dërgohet vazhdimisht pa ndërprerje në gjenerimin e modelit.
  • Nëse ka nevojë të përzihen të dhënat e ndërthurura midis BidiGenerateContentClientContent dhe BidiGenerateContentRealtimeInput , serveri përpiqet të optimizojë për përgjigjen më të mirë, por nuk ka garanci.
  • Fundi i radhës nuk specifikohet në mënyrë të qartë, por rrjedh nga aktiviteti i përdoruesit (për shembull, fundi i të folurit).
  • Edhe para përfundimit të kthesës, të dhënat përpunohen në mënyrë graduale për të optimizuar një fillim të shpejtë të përgjigjes nga modeli.
Fushat
mediaChunks[]

Blob

Opsionale. Të dhëna bajtesh të integruara për hyrjen e medias. Nuk mbështeten shumë mediaChunks , të gjitha përveç të parit do të injorohen.

I JEPUR NGA E DEMOKRACIONI: Përdorni një nga opsionet audio , video ose text .

audio

Blob

Opsionale. Këto formojnë rrjedhën hyrëse audio në kohë reale.

video

Blob

Opsionale. Këto formojnë rrjedhën hyrëse të videos në kohë reale.

activityStart

ActivityStart

Opsionale. Shënon fillimin e aktivitetit të përdoruesit. Kjo mund të dërgohet vetëm nëse zbulimi automatik i aktivitetit (p.sh., nga ana e serverit) është i çaktivizuar.

activityEnd

ActivityEnd

Opsionale. Shënon fundin e aktivitetit të përdoruesit. Kjo mund të dërgohet vetëm nëse zbulimi automatik i aktivitetit (p.sh., nga ana e serverit) është i çaktivizuar.

audioStreamEnd

bool

Opsionale. Tregon që transmetimi audio ka mbaruar, p.sh. sepse mikrofoni është fikur.

Kjo duhet të dërgohet vetëm kur është aktivizuar zbulimi automatik i aktivitetit (që është parazgjedhja).

Klienti mund ta rihapë transmetimin duke dërguar një mesazh audio.

text

string

Opsionale. Këto formojnë rrjedhën e futjes së tekstit në kohë reale.

BidiGenerateContentServerContent

Përditësim shtesë i serverit i gjeneruar nga modeli në përgjigje të mesazheve të klientit.

Përmbajtja gjenerohet sa më shpejt të jetë e mundur dhe jo në kohë reale. Klientët mund të zgjedhin ta ruajnë në memorje dhe ta luajnë atë në kohë reale.

Fushat
generationComplete

bool

Vetëm rezultati. Nëse është e vërtetë, tregon që modeli ka mbaruar gjenerimin.

Kur modeli ndërpritet gjatë gjenerimit, nuk do të ketë mesazh 'generation_complete' në kthesën e ndërprerë, por do të kalojë nëpër 'interrupted > turn_complete'.

Kur modeli supozon riprodhim në kohë reale, do të ketë vonesë midis generation_complete dhe turn_complete që shkaktohet nga fakti që modeli pret që riprodhimi të përfundojë.

turnComplete

bool

Vetëm rezultati. Nëse është e vërtetë, tregon që modeli ka përfunduar raundin e tij. Gjenerimi do të fillojë vetëm në përgjigje të mesazheve shtesë të klientit.

interrupted

bool

Vetëm dalje. Nëse është e vërtetë, tregon se një mesazh i klientit ka ndërprerë gjenerimin aktual të modelit. Nëse klienti po luan përmbajtjen në kohë reale, ky është një sinjal i mirë për të ndaluar dhe zbrazur radhën aktuale të luajtjes.

groundingMetadata

GroundingMetadata

Vetëm rezultate. Metadata bazë për përmbajtjen e gjeneruar.

inputTranscription

BidiGenerateContentTranscription

Vetëm dalje. Transkriptim audio hyrës. Transkriptimi dërgohet në mënyrë të pavarur nga mesazhet e tjera të serverit dhe nuk ka renditje të garantuar.

outputTranscription

BidiGenerateContentTranscription

Vetëm dalje. Transkriptimi i audios së daljes. Transkriptimi dërgohet në mënyrë të pavarur nga mesazhet e tjera të serverit dhe nuk ka renditje të garantuar, veçanërisht jo midis serverContent dhe këtij outputTranscription .

urlContextMetadata

UrlContextMetadata

modelTurn

Content

Vetëm rezultati. Përmbajtja që modeli ka gjeneruar si pjesë e bisedës aktuale me përdoruesin.

BidiGenerateContentServerMessage

Mesazh përgjigjeje për thirrjen BidiGenerateContent.

Fushat
usageMetadata

UsageMetadata

Vetëm rezultate. Përdorimi i meta të dhënave rreth përgjigjes/përgjigjeve.

Fusha e bashkimit messageType . Lloji i mesazhit. messageType mund të jetë vetëm një nga të mëposhtmet:
setupComplete

BidiGenerateContentSetupComplete

Vetëm rezultat. Dërgohet në përgjigje të një mesazhi BidiGenerateContentSetup nga klienti kur konfigurimi është i plotë.

serverContent

BidiGenerateContentServerContent

Vetëm rezultate. Përmbajtja gjenerohet nga modeli në përgjigje të mesazheve të klientit.

toolCall

BidiGenerateContentToolCall

Vetëm rezultati. Kërkesë që klienti të ekzekutojë functionCalls dhe të kthejë përgjigjet me id të përkatëse.

toolCallCancellation

BidiGenerateContentToolCallCancellation

Vetëm dalje. Njoftim për klientin se një ToolCallMessage i lëshuar më parë me id -të e specifikuara duhet të anulohet.

goAway

GoAway

Vetëm dalje. Një njoftim se serveri do të shkëputet së shpejti.

sessionResumptionUpdate

SessionResumptionUpdate

Vetëm rezultat. Përditësimi i gjendjes së rifillimit të seancës.

Konfigurimi i Përmbajtjes BidiGenerate

Mesazhi që do të dërgohet në BidiGenerateContentClientMessage të parë (dhe vetëm në të parin). Përmban konfigurimin që do të zbatohet për kohëzgjatjen e RPC-së së transmetimit.

Klientët duhet të presin për një mesazh BidiGenerateContentSetupComplete përpara se të dërgojnë ndonjë mesazh tjetër.

Fushat
model

string

E detyrueshme. Emri i burimit të modelit. Ky shërben si një ID që Modeli do të përdorë.

Formati: models/{model}

generationConfig

GenerationConfig

Opsionale. Konfigurimi i gjenerimit.

Fushat e mëposhtme nuk mbështeten:

  • responseLogprobs
  • responseMimeType
  • logprobs
  • responseSchema
  • stopSequence
  • routingConfig
  • audioTimestamp
systemInstruction

Content

Opsionale. Përdoruesi dha udhëzime të sistemit për modelin.

Shënim: Vetëm teksti duhet të përdoret në pjesë dhe përmbajtja në secilën pjesë do të jetë në një paragraf të veçantë.

tools[]

Tool

Opsionale. Një listë e Tools që modeli mund të përdorë për të gjeneruar përgjigjen tjetër.

Një Tool është një pjesë kodi që i mundëson sistemit të bashkëveprojë me sisteme të jashtme për të kryer një veprim, ose një sërë veprimesh, jashtë njohurive dhe fushëveprimit të modelit.

realtimeInputConfig

RealtimeInputConfig

Opsionale. Konfiguron trajtimin e të dhënave hyrëse në kohë reale.

sessionResumption

SessionResumptionConfig

Opsionale. Konfiguron mekanizmin e rifillimit të sesionit.

Nëse përfshihet, serveri do të dërgojë mesazhe SessionResumptionUpdate .

contextWindowCompression

ContextWindowCompressionConfig

Opsionale. Konfiguron një mekanizëm kompresimi të dritares së kontekstit.

Nëse përfshihet, serveri do ta zvogëlojë automatikisht madhësinë e kontekstit kur ai tejkalon gjatësinë e konfiguruar.

inputAudioTranscription

AudioTranscriptionConfig

Opsionale. Nëse caktohet, aktivizon transkriptimin e hyrjes zanore. Transkriptimi përputhet me gjuhën audio të hyrjes, nëse është konfiguruar.

outputAudioTranscription

AudioTranscriptionConfig

Opsionale. Nëse vendoset, aktivizon transkriptimin e daljes audio të modelit. Transkriptimi përputhet me kodin e gjuhës së specifikuar për audion e daljes, nëse është konfiguruar.

proactivity

ProactivityConfig

Opsionale. Konfiguron proaktivitetin e modelit.

Kjo i lejon modelit të përgjigjet në mënyrë proaktive ndaj të dhënave hyrëse dhe të injorojë të dhënat hyrëse të parëndësishme.

BidiGenerateContentSetupComplete

Ky lloj nuk ka fusha.

Dërguar në përgjigje të një mesazhi BidiGenerateContentSetup nga klienti.

BidiGenerateContentToolCall

Kërkesë që klienti të ekzekutojë functionCalls dhe të kthejë përgjigjet me id -të përkatëse.

Fushat
functionCalls[]

FunctionCall

Vetëm dalje. Thirrja e funksionit që do të ekzekutohet.

BidiGenerateContentToolCallCancellation

Njoftim për klientin se një ToolCallMessage i lëshuar më parë me id -të e specifikuara nuk duhej të ishte ekzekutuar dhe duhet të anulohej. Nëse ka pasur efekte anësore nga ato thirrje të mjeteve, klientët mund të përpiqen t'i anulojnë thirrjet e mjeteve. Ky mesazh shfaqet vetëm në rastet kur klientët ndërpresin kthesat e serverit.

Fushat
ids[]

string

Vetëm dalje. ID-të e thirrjeve të mjetit do të anulohen.

BidiGenerateContentToolResponse

Përgjigje e gjeneruar nga klienti ndaj një ToolCall të marrë nga serveri. Objektet individuale FunctionResponse përputhen me objektet përkatëse FunctionCall nga fusha e id .

Vini re se në API-të unare dhe ato që transmetojnë në server, thirrja e funksionit ndodh duke shkëmbyer pjesët e Content , ndërsa në API-të bidi GenerateContent thirrja e funksionit ndodh mbi këto grupe të dedikuara mesazhesh.

Fushat
functionResponses[]

FunctionResponse

Opsionale. Përgjigja ndaj thirrjeve të funksionit.

BidiGenerateContentTranscription

Transkriptimi i audios (hyrje ose dalje).

Fushat
text

string

Teksti i transkriptimit.

Konfigurimi i Dritares së Kontekstit

Aktivizon kompresimin e dritares së kontekstit — një mekanizëm për menaxhimin e dritares së kontekstit të modelit në mënyrë që ajo të mos kalojë një gjatësi të caktuar.

Fushat
compressionMechanism të fushës së bashkimit. Mekanizmi i kompresimit të dritares së kontekstit i përdorur. compressionMechanism mund të jetë vetëm një nga të mëposhtmet:
slidingWindow

SlidingWindow

Një mekanizëm me dritare rrëshqitëse.

triggerTokens

int64

Numri i tokenëve (para se të ekzekutohet një raund) i nevojshëm për të aktivizuar një kompresim të dritares së kontekstit.

Kjo mund të përdoret për të balancuar cilësinë kundrejt vonesës, pasi dritaret më të shkurtra të kontekstit mund të rezultojnë në përgjigje më të shpejta të modelit. Megjithatë, çdo operacion kompresimi do të shkaktojë një rritje të përkohshme të vonesës, kështu që ato nuk duhet të aktivizohen shpesh.

Nëse nuk është caktuar, vlera e parazgjedhur është 80% e limitit të dritares së kontekstit të modelit. Kjo lë 20% për kërkesën/përgjigjen e modelit të ardhshëm të përdoruesit.

EndSensitivity

Përcakton se si zbulohet fundi i të folurit.

Numërime
END_SENSITIVITY_UNSPECIFIED Vlera parazgjedhur është END_SENSITIVITY_HIGH.
END_SENSITIVITY_HIGH Zbulimi automatik e ndërpret të folurit më shpesh.
END_SENSITIVITY_LOW Zbulimi automatik e ndërpret të folurit më rrallë.

Largohuni

Një njoftim se serveri do të shkëputet së shpejti.

Fushat
timeLeft

Duration

Koha e mbetur para se lidhja të ndërpritet si E NDËRPRERË.

Kjo kohëzgjatje nuk do të jetë kurrë më e vogël se një minimum specifik për modelin, i cili do të specifikohet së bashku me kufijtë e normës për modelin.

ProactivityConfig

Konfiguro për veçoritë e proaktivitetit.

Fushat
proactiveAudio

bool

Opsionale. Nëse aktivizohet, modeli mund të refuzojë përgjigjen ndaj kërkesës së fundit. Për shembull, kjo i lejon modelit të injorojë fjalimin jashtë kontekstit ose të qëndrojë i heshtur nëse përdoruesi nuk ka bërë ende një kërkesë.

RealtimeInputConfig

Konfiguron sjelljen e të dhënave hyrëse në kohë reale në BidiGenerateContent .

Fushat
automaticActivityDetection

AutomaticActivityDetection

Opsionale. Nëse nuk është caktuar, zbulimi automatik i aktivitetit aktivizohet si parazgjedhje. Nëse zbulimi automatik i zërit është i çaktivizuar, klienti duhet të dërgojë sinjale aktiviteti.

activityHandling

ActivityHandling

Opsionale. Përcakton efektin që ka aktiviteti.

turnCoverage

TurnCoverage

Opsionale. Përcakton se cili input përfshihet në radhën e përdoruesit.

Konfigurimi i Ripërtëritjes së Sesionit

Konfigurimi i rifillimit të sesionit.

Ky mesazh përfshihet në konfigurimin e sesionit si BidiGenerateContentSetup.sessionResumption . Nëse konfigurohet, serveri do të dërgojë mesazhe SessionResumptionUpdate .

Fushat
handle

string

Doreza e një sesioni të mëparshëm. Nëse nuk është e pranishme, atëherë krijohet një sesion i ri.

Dorezat e sesionit vijnë nga vlerat SessionResumptionUpdate.token në lidhjet e mëparshme.

Përditësimi i Rifillimit të Sesionit

Përditësim i gjendjes së rifillimit të seancës.

Dërgohet vetëm nëse është vendosur BidiGenerateContentSetup.sessionResumption .

Fushat
newHandle

string

Dorezë e re që përfaqëson një gjendje që mund të rifillohet. Bosh nëse resumable = e gabuar.

resumable

bool

E vërtetë nëse seanca aktuale mund të rifillojë në këtë pikë.

Rifillimi nuk është i mundur në disa pika të seancës. Për shembull, kur modeli po ekzekuton thirrje funksionesh ose po gjeneron. Rifillimi i seancës (duke përdorur një token të seancës së mëparshme) në një gjendje të tillë do të rezultojë në humbje të disa të dhënave. Në këto raste, newHandle do të jetë bosh dhe resumable do të jetë i gabuar.

Dritare rrëshqitëse

Metoda SlidingWindow funksionon duke hedhur poshtë përmbajtjen në fillim të dritares së kontekstit. Konteksti që rezulton do të fillojë gjithmonë në fillim të një kthese të rolit PËRDORUES. Udhëzimet e sistemit dhe çdo BidiGenerateContentSetup.prefixTurns do të mbeten gjithmonë në fillim të rezultatit.

Fushat
targetTokens

int64

Numri i synuar i tokenëve që duhen mbajtur. Vlera e parazgjedhur është trigger_tokens/2.

Heqja dorë nga pjesë të dritares së kontekstit shkakton një rritje të përkohshme të latencës, kështu që kjo vlerë duhet të kalibrohet për të shmangur operacionet e shpeshta të kompresimit.

Ndjeshmëria e Fillimit

Përcakton se si zbulohet fillimi i të folurit.

Numërime
START_SENSITIVITY_UNSPECIFIED Vlera parazgjedhur është START_SENSITIVITY_HIGH.
START_SENSITIVITY_HIGH Zbulimi automatik do ta zbulojë fillimin e të folurit më shpesh.
START_SENSITIVITY_LOW Zbulimi automatik do ta zbulojë fillimin e të folurit më rrallë.

TurnCoverage

Opsione rreth asaj se cilat të dhëna përfshihen në radhën e përdoruesit.

Numërime
TURN_COVERAGE_UNSPECIFIED Nëse nuk specifikohet, sjellja e parazgjedhur është TURN_INCLUDES_ONLY_ACTIVITY .
TURN_INCLUDES_ONLY_ACTIVITY Radha e përdoruesit përfshin vetëm aktivitetin që nga radha e fundit, duke përjashtuar pasivitetin (p.sh. heshtja në transmetimin audio). Kjo është sjellja e parazgjedhur.
TURN_INCLUDES_ALL_INPUT Radha e përdoruesit përfshin të gjitha të dhënat në kohë reale që nga radha e fundit, duke përfshirë edhe mosaktivitetin (p.sh. heshtja në transmetimin audio).

Metadata e Kontekstit Url

Meta të dhëna që lidhen me mjetin e rikthimit të kontekstit të URL-së.

Fushat
urlMetadata[]

UrlMetadata

Lista e kontekstit të URL-së.

PërdorimiMeta të dhëna

Meta të dhënat e përdorimit rreth përgjigjes(ave)

Fushat
promptTokenCount

int32

Vetëm rezultati. Numri i tokenëve në kërkesë. Kur vendoset cachedContent , kjo është ende madhësia totale efektive e kërkesës, që do të thotë se përfshin numrin e tokenëve në përmbajtjen e ruajtur në memorien e përkohshme.

cachedContentTokenCount

int32

Numri i tokenëve në pjesën e ruajtur në memorje të kërkesës (përmbajtja e ruajtur në memorje)

responseTokenCount

int32

Vetëm rezultati. Numri total i tokenëve në të gjithë kandidatët e përgjigjes së gjeneruar.

toolUsePromptTokenCount

int32

Vetëm rezultat. Numri i tokenëve të pranishëm në kërkesën/kërkesat e përdorimit të mjetit.

thoughtsTokenCount

int32

Vetëm rezultati. Numri i tokenëve të mendimeve për modelet e të menduarit.

totalTokenCount

int32

Vetëm rezultati. Numri total i tokenëve për kërkesën e gjenerimit (kërkesa + kandidatët për përgjigje).

promptTokensDetails[]

ModalityTokenCount

Vetëm rezultati. Lista e modaliteteve që u përpunuan në të dhënat hyrëse të kërkesës.

cacheTokensDetails[]

ModalityTokenCount

Vetëm rezultati. Lista e modaliteteve të përmbajtjes së ruajtur në memorien e përkohshme në të dhënat hyrëse të kërkesës.

responseTokensDetails[]

ModalityTokenCount

Vetëm rezultati. Lista e modaliteteve që u kthyen në përgjigje.

toolUsePromptTokensDetails[]

ModalityTokenCount

Vetëm rezultate. Lista e modaliteteve që u përpunuan për hyrjet e kërkesave për përdorimin e mjetit.

Shenjat e vërtetimit të përkohshëm

Tokenët e autentifikimit kalimtar mund të merren duke thirrur AuthTokenService.CreateToken dhe më pas të përdoren me GenerativeService.BidiGenerateContentConstrained , ose duke e kaluar tokenin në një parametër pytësori access_token , ose në një kokë Authorization HTTP me " Token " të parashtesuar pranë tij.

KrijoKërkesëAuthToken

Krijo një token vërtetimi kalimtar.

Fushat
authToken

AuthToken

E detyrueshme. Tokeni që do të krijohet.

AuthToken

Një kërkesë për të krijuar një token vërtetimi kalimtar.

Fushat
name

string

Vetëm rezultat. Identifikues. Vetë tokeni.

expireTime

Timestamp

Opsionale. Vetëm hyrje. I pandryshueshëm. Një kohë opsionale pas së cilës, kur përdoret tokeni që rezulton, mesazhet në seancat BidiGenerateContent do të refuzohen. (Gemini mund ta mbyllë paraprakisht seancën pas kësaj kohe.)

Nëse nuk është caktuar, atëherë kjo vlerë parazgjedhur do të jetë 30 minuta në të ardhmen. Nëse është caktuar, kjo vlerë duhet të jetë më pak se 20 orë në të ardhmen.

newSessionExpireTime

Timestamp

Opsionale. Vetëm hyrje. E pandryshueshme. Koha pas së cilës seancat e reja të API-t Live që përdorin tokenin që rezulton nga kjo kërkesë do të refuzohen.

Nëse nuk është caktuar, kjo vlerë parazgjedhur do të jetë 60 sekonda në të ardhmen. Nëse është caktuar, kjo vlerë duhet të jetë më pak se 20 orë në të ardhmen.

fieldMask

FieldMask

Opsionale. Vetëm hyrje. E pandryshueshme. Nëse field_mask është bosh dhe bidiGenerateContentSetup nuk është i pranishëm, atëherë mesazhi efektiv BidiGenerateContentSetup merret nga lidhja Live API.

Nëse field_mask është bosh dhe bidiGenerateContentSetup është i pranishëm, atëherë mesazhi efektiv BidiGenerateContentSetup merret tërësisht nga bidiGenerateContentSetup në këtë kërkesë. Mesazhi i konfigurimit nga lidhja Live API injorohet.

Nëse field_mask nuk është bosh, atëherë fushat përkatëse nga bidiGenerateContentSetup do të mbishkruajnë fushat nga mesazhi i konfigurimit në lidhjen Live API.

config i fushës së bashkimit. Konfigurimi specifik i metodës për tokenin që rezulton. config mund të jetë vetëm një nga të mëposhtmet:
bidiGenerateContentSetup

BidiGenerateContentSetup

Opsionale. Vetëm hyrje. I pandryshueshëm. Konfigurim specifik për BidiGenerateContent .

uses

int32

Opsionale. Vetëm të dhëna. I pandryshueshëm. Numri i herëve që mund të përdoret tokeni. Nëse kjo vlerë është zero, atëherë nuk zbatohet asnjë kufizim. Rifillimi i një sesioni Live API nuk llogaritet si përdorim. Nëse nuk specifikohet, vlera parazgjedhur është 1.

Më shumë informacion mbi llojet e zakonshme

Për më shumë informacion mbi llojet e burimeve të API-t që përdoren zakonisht Blob , Content , FunctionCall , FunctionResponse , GenerationConfig , GroundingMetadata , ModalityTokenCount dhe Tool , shihni Gjenerimi i përmbajtjes .