Ruajtja në memorje e kontekstit ju lejon të ruani dhe ripërdorni token-e hyrës të parallogaritur që dëshironi të përdorni në mënyrë të përsëritur, për shembull kur bëni pyetje të ndryshme në lidhje me të njëjtin skedar mediatik. Kjo mund të çojë në kursime në kosto dhe shpejtësi, varësisht nga përdorimi. Për një hyrje të detajuar, shihni udhëzuesin e Ruajtjes në Memorje të Kontekstit .
Metoda: cachedContents.create
Krijon burimin CachedContent.
Pika e Fundit
postohttps: / /generativelanguage.googleapis.com /v1beta /cachedContentsTrupi i kërkesës
Trupi i kërkesës përmban një instancë të CachedContent .
contents[]object ( Content )Opsionale. Vetëm hyrje. E pandryshueshme. Përmbajtja në memorien e përkohshme.
tools[]object ( Tool ) Opsionale. Vetëm hyrje. I pandryshueshëm. Një listë Tools që modeli mund të përdorë për të gjeneruar përgjigjen tjetër.
Union type expirationexpiration mund të jetë vetëm një nga të mëposhtmet: expireTimestring ( Timestamp format)Vula kohore në UTC e kohës kur ky burim konsiderohet i skaduar. Kjo jepet gjithmonë në dalje, pavarësisht se çfarë është dërguar në hyrje.
Përdor RFC 3339, ku rezultati i gjeneruar do të jetë gjithmonë i normalizuar sipas Z-së dhe do të përdorë 0, 3, 6 ose 9 shifra thyesore. Pranohen edhe zhvendosje të tjera përveç "Z". Shembuj: "2014-10-02T15:01:23Z" , "2014-10-02T15:01:23.045123456Z" ose "2014-10-02T15:01:23+05:30" .
ttlstring ( Duration format)Vetëm hyrje. TTL e re për këtë burim, vetëm hyrje.
Një kohëzgjatje në sekonda me deri në nëntë shifra thyesore, që mbaron me ' s '. Shembull: "3.5s" .
string displayNameOpsionale. I pandryshueshëm. Emri i shfaqjes kuptimplotë i gjeneruar nga përdoruesi i përmbajtjes së ruajtur në memorien e përkohshme. Maksimumi 128 karaktere Unicode.
string model E detyrueshme. I pandryshueshëm. Emri i Model që do të përdoret për përmbajtjen e ruajtur në memorje. Formati: models/{model}
systemInstructionobject ( Content )Opsionale. Vetëm hyrje. I pandryshueshëm. Zhvilluesi vendosi udhëzimet e sistemit. Aktualisht vetëm tekst.
object ( ToolConfig ) toolConfigOpsionale. Vetëm hyrje. I pandryshueshëm. Konfigurimi i mjetit. Ky konfigurim ndahet për të gjitha mjetet.
Shembull kërkese
Bazë
Python
Node.js
Shko
Guaskë
Nga emri
Python
Node.js
Shko
Nga biseda
Python
Node.js
Shko
Trupi i përgjigjes
Nëse është e suksesshme, trupi i përgjigjes përmban një instancë të sapokrijuar të CachedContent .
Metoda: cachedContents.list
Listat e Përmbajtjeve të Ruajtura në Memorje.
Pika e Fundit
merrnihttps: / /generativelanguage.googleapis.com /v1beta /cachedContentsParametrat e pyetjes
pageSizeintegerOpsionale. Numri maksimal i përmbajtjeve të ruajtura në memorje për t'u kthyer. Shërbimi mund të kthejë më pak se kjo vlerë. Nëse nuk specifikohet, do të kthehet një numër i parazgjedhur (nën maksimumin) i artikujve. Vlera maksimale është 1000; vlerat mbi 1000 do të detyrohen në 1000.
string pageToken Opsionale. Një shenjë faqeje, e marrë nga një thirrje e mëparshme cachedContents.list . Jepni këtë për të marrë faqen pasuese.
Gjatë faqosjes, të gjithë parametrat e tjerë të dhënë për cachedContents.list duhet të përputhen me thirrjen që ofroi tokenin e faqes.
Trupi i kërkesës
Trupi i kërkesës duhet të jetë bosh.
Trupi i përgjigjes
Përgjigje me listën CachedContents.
Nëse është i suksesshëm, trupi i përgjigjes përmban të dhëna me strukturën e mëposhtme:
cachedContents[]object ( CachedContent )Lista e përmbajtjeve të ruajtura në memorien e përkohshme.
string nextPageToken Një shenjë, e cila mund të dërgohet si pageToken për të marrë faqen tjetër. Nëse kjo fushë lihet jashtë, nuk ka faqe pasuese.
| Përfaqësimi JSON |
|---|
{
"cachedContents": [
{
object ( |
Metoda: cachedContents.get
Lexon burimin CachedContent.
Pika e Fundit
merrnihttps: / /generativelanguage.googleapis.com /v1beta /{name=cachedContents /*}Parametrat e shtegut
string name E detyrueshme. Emri i burimit që i referohet hyrjes në memorien e përkohshme të përmbajtjes. Formati: cachedContents/{id} Merr formën cachedContents/{cachedcontent} .
Trupi i kërkesës
Trupi i kërkesës duhet të jetë bosh.
Shembull kërkese
Python
Node.js
Shko
Guaskë
Trupi i përgjigjes
Nëse është e suksesshme, trupi i përgjigjes përmban një instancë të CachedContent .
Metoda: cachedContents.patch
- Pika e Fundit
- Parametrat e shtegut
- Parametrat e pyetjes
- Trupi i kërkesës
- Trupi i përgjigjes
- Shembull kërkese
Përditëson burimin CachedContent (vetëm data e skadimit mund të përditësohet).
Pika e Fundit
përditësimhttps: / /generativelanguage.googleapis.com /v1beta /{cachedContent.name=cachedContents /*}PATCH https://generativelanguage.googleapis.com/v1beta/{cachedContent.name=cachedContents/*} Parametrat e shtegut
string cachedContent.name Vetëm rezultati. Identifikuesi. Emri i burimit që i referohet përmbajtjes së ruajtur në memorje. Formati: cachedContents/{id} Merr formën cachedContents/{cachedcontent} .
Parametrat e pyetjes
updateMaskstring ( FieldMask format)Lista e fushave që duhen përditësuar.
Kjo është një listë e ndarë me presje e emrave të fushave plotësisht të kualifikuara. Shembull: "user.displayName,photo" .
Trupi i kërkesës
Trupi i kërkesës përmban një instancë të CachedContent .
Union type expirationexpiration mund të jetë vetëm një nga të mëposhtmet: expireTimestring ( Timestamp format)Vula kohore në UTC e kohës kur ky burim konsiderohet i skaduar. Kjo jepet gjithmonë në dalje, pavarësisht se çfarë është dërguar në hyrje.
Përdor RFC 3339, ku rezultati i gjeneruar do të jetë gjithmonë i normalizuar sipas Z-së dhe do të përdorë 0, 3, 6 ose 9 shifra thyesore. Pranohen edhe zhvendosje të tjera përveç "Z". Shembuj: "2014-10-02T15:01:23Z" , "2014-10-02T15:01:23.045123456Z" ose "2014-10-02T15:01:23+05:30" .
ttlstring ( Duration format)Vetëm hyrje. TTL e re për këtë burim, vetëm hyrje.
Një kohëzgjatje në sekonda me deri në nëntë shifra thyesore, që mbaron me ' s '. Shembull: "3.5s" .
Shembull kërkese
Python
Node.js
Shko
Guaskë
Trupi i përgjigjes
Nëse është e suksesshme, trupi i përgjigjes përmban një instancë të CachedContent .
Metoda: cachedContents.delete
Fshin burimin CachedContent.
Pika e Fundit
fshihttps: / /generativelanguage.googleapis.com /v1beta /{name=cachedContents /*}Parametrat e shtegut
string name E detyrueshme. Emri i burimit që i referohet hyrjes në memorien e përkohshme të përmbajtjes. Formati: cachedContents/{id} Merr formën cachedContents/{cachedcontent} .
Trupi i kërkesës
Trupi i kërkesës duhet të jetë bosh.
Shembull kërkese
Python
Node.js
Shko
Guaskë
Trupi i përgjigjes
Nëse është i suksesshëm, trupi i përgjigjes është një objekt JSON bosh.
Burimi REST: cachedContents
- Burimi: CachedContent
- Përmbajtja
- Pjesë
- Pikë
- Thirrja e Funksionit
- FunksioniPërgjigja
- FunctionResponsePjesa
- FunksioniResponseBlob
- Planifikimi
- Të Dhënat e Skedarit
- Kodi i Ekzekutueshëm
- Gjuha
- Rezultati i Ekzekutimit të Kodit
- Rezultati
- Meta të dhëna video
- Mjet
- Deklarata e Funksionit
- Skema
- Lloji
- Sjellje
- Kërkimi në Google
- Konfigurimi i Rikthimit Dinamike
- Modaliteti
- Ekzekutimi i Kodit
- Kërkimi në Google
- Intervali
- Përdorimi i Kompjuterit
- Mjedisi
- Konteksti i Url-it
- Kërkimi i skedarëve
- Burimi i Rikthimit
- RetrievalConfig
- GoogleMaps
- Konfigurimi i Veglave
- Konfigurimi i Thirrjes së Funksionit
- Modaliteti
- RetrievalConfig
- LatLng
- PërdorimiMeta të dhëna
- Metodat
Burimi: CachedContent
Përmbajtje që është përpunuar paraprakisht dhe mund të përdoret në kërkesën pasuese drejtuar GenerativeService.
Përmbajtja e ruajtur në memorien e përkohshme mund të përdoret vetëm me modelin për të cilin është krijuar.
contents[]object ( Content )Opsionale. Vetëm hyrje. E pandryshueshme. Përmbajtja në memorien e përkohshme.
tools[]object ( Tool ) Opsionale. Vetëm hyrje. I pandryshueshëm. Një listë Tools që modeli mund të përdorë për të gjeneruar përgjigjen tjetër.
createTimestring ( Timestamp format)Vetëm rezultati. Koha e krijimit të hyrjes në memorien e përkohshme.
Përdor RFC 3339, ku rezultati i gjeneruar do të jetë gjithmonë i normalizuar sipas Z-së dhe do të përdorë 0, 3, 6 ose 9 shifra thyesore. Pranohen edhe zhvendosje të tjera përveç "Z". Shembuj: "2014-10-02T15:01:23Z" , "2014-10-02T15:01:23.045123456Z" ose "2014-10-02T15:01:23+05:30" .
updateTimestring ( Timestamp format)Vetëm dalje. Kur hyrja e memories së përkohshme është përditësuar për herë të fundit në kohën UTC.
Përdor RFC 3339, ku rezultati i gjeneruar do të jetë gjithmonë i normalizuar sipas Z-së dhe do të përdorë 0, 3, 6 ose 9 shifra thyesore. Pranohen edhe zhvendosje të tjera përveç "Z". Shembuj: "2014-10-02T15:01:23Z" , "2014-10-02T15:01:23.045123456Z" ose "2014-10-02T15:01:23+05:30" .
object ( UsageMetadata ) usageMetadataVetëm rezultate. Meta të dhëna mbi përdorimin e përmbajtjes së ruajtur në memorien e përkohshme.
Union type expirationexpiration mund të jetë vetëm një nga të mëposhtmet: expireTimestring ( Timestamp format)Vula kohore në UTC e kohës kur ky burim konsiderohet i skaduar. Kjo jepet gjithmonë në dalje, pavarësisht se çfarë është dërguar në hyrje.
Përdor RFC 3339, ku rezultati i gjeneruar do të jetë gjithmonë i normalizuar sipas Z-së dhe do të përdorë 0, 3, 6 ose 9 shifra thyesore. Pranohen edhe zhvendosje të tjera përveç "Z". Shembuj: "2014-10-02T15:01:23Z" , "2014-10-02T15:01:23.045123456Z" ose "2014-10-02T15:01:23+05:30" .
ttlstring ( Duration format)Vetëm hyrje. TTL e re për këtë burim, vetëm hyrje.
Një kohëzgjatje në sekonda me deri në nëntë shifra thyesore, që mbaron me ' s '. Shembull: "3.5s" .
string name Vetëm rezultat. Identifikues. Emri i burimit që i referohet përmbajtjes së ruajtur në memorje. Formati: cachedContents/{id}
string displayNameOpsionale. I pandryshueshëm. Emri i shfaqjes kuptimplotë i gjeneruar nga përdoruesi i përmbajtjes së ruajtur në memorien e përkohshme. Maksimumi 128 karaktere Unicode.
string model E detyrueshme. I pandryshueshëm. Emri i Model që do të përdoret për përmbajtjen e ruajtur në memorje. Formati: models/{model}
systemInstructionobject ( Content )Opsionale. Vetëm hyrje. I pandryshueshëm. Zhvilluesi vendosi udhëzimet e sistemit. Aktualisht vetëm tekst.
object ( ToolConfig ) toolConfigOpsionale. Vetëm hyrje. I pandryshueshëm. Konfigurimi i mjetit. Ky konfigurim ndahet për të gjitha mjetet.
| Përfaqësimi JSON |
|---|
{ "contents": [ { object ( |
Përmbajtja
Lloji i të dhënave të strukturuara bazë që përmban përmbajtje shumëpjesëshe të një mesazhi.
Një Content përfshin një fushë role që përcakton prodhuesin e Content dhe një fushë parts që përmban të dhëna shumëpjesëshe që përmbajnë përmbajtjen e mesazhit të radhës.
parts[]object ( Part ) Parts të renditura që përbëjnë një mesazh të vetëm. Pjesët mund të kenë lloje të ndryshme MIME.
string roleOpsionale. Prodhuesi i përmbajtjes. Duhet të jetë ose 'përdorues' ose 'model'.
E dobishme për t'u vendosur për biseda me shumë kthesa, përndryshe mund të lihet bosh ose e pacaktuar.
| Përfaqësimi JSON |
|---|
{
"parts": [
{
object ( |
Pjesë
Një lloj të dhënash që përmban media që është pjesë e një mesazhi Content me shumë pjesë.
Një Part përbëhet nga të dhëna që kanë një lloj të dhënash të shoqëruar. Një Part mund të përmbajë vetëm një nga llojet e pranuara në Part.data .
Një Part duhet të ketë një lloj fiks IANA MIME që identifikon llojin dhe nëntipin e medias nëse fusha inlineData është e mbushur me bajt të papërpunuar.
thoughtbooleanOpsionale. Tregon nëse pjesa është menduar nga modeli.
thoughtSignaturestring ( bytes format)Opsionale. Një nënshkrim i errët për mendimin në mënyrë që të mund të ripërdoret në kërkesat pasuese.
Një varg i koduar me base64.
object ( Struct format) partMetadataMeta të dhënat e personalizuara të shoqëruara me Pjesën. Agjentët që përdorin genai.Part si përfaqësim të përmbajtjes mund të kenë nevojë të mbajnë gjurmët e informacionit shtesë. Për shembull, mund të jetë emri i një skedari/burimi nga i cili buron Pjesa ose një mënyrë për të shumëfishuar rrjedha të shumëfishta Pjesësh.
Union type datadata mund të jenë vetëm një nga të mëposhtmet:string textTekst i integruar.
inlineDataobject ( Blob )Bajt mediash të integruara.
object ( FunctionCall ) functionCall Një FunctionCall i parashikuar i kthyer nga modeli që përmban një varg që përfaqëson FunctionDeclaration.name me argumentet dhe vlerat e tyre.
object ( FunctionResponse ) functionResponse Rezultati i një FunctionCall që përmban një varg që përfaqëson FunctionDeclaration.name dhe një objekt të strukturuar JSON që përmban çdo rezultat nga funksioni përdoret si kontekst për modelin.
object ( FileData ) fileDataTë dhëna të bazuara në URI.
object ( ExecutableCode ) executableCodeKodi i gjeneruar nga modeli që është menduar të ekzekutohet.
object ( CodeExecutionResult ) codeExecutionResult Rezultati i ekzekutimit të ExecutableCode .
Union type metadatametadata mund të jenë vetëm një nga të mëposhtmet:object ( VideoMetadata ) videoMetadataOpsionale. Meta të dhënat e videos. Meta të dhënat duhet të specifikohen vetëm kur të dhënat e videos paraqiten në inlineData ose fileData.
| Përfaqësimi JSON |
|---|
{ "thought": boolean, "thoughtSignature": string, "partMetadata": { object }, // data "text": string, "inlineData": { object ( |
Pikë
Bajt të medias së papërpunuar.
Teksti nuk duhet të dërgohet si bajt i papërpunuar, përdorni fushën 'tekst'.
string mimeTypeLloji standard MIME IANA i të dhënave burimore. Shembuj: - image/png - image/jpeg Nëse jepet një lloj MIME i pambështetur, do të kthehet një gabim. Për një listë të plotë të llojeve të mbështetura, shihni Formatet e skedarëve të mbështetura .
datastring ( bytes format)Bajt të papërpunuar për formatet mediatike.
Një varg i koduar me base64.
| Përfaqësimi JSON |
|---|
{ "mimeType": string, "data": string } |
Thirrja e Funksionit
Një FunctionCall i parashikuar i kthyer nga modeli që përmban një varg që përfaqëson FunctionDeclaration.name me argumentet dhe vlerat e tyre.
string id Opsionale. ID-ja unike e thirrjes së funksionit. Nëse plotësohet, klienti duhet të ekzekutojë functionCall dhe të kthejë përgjigjen me id në përkatëse.
string nameE detyrueshme. Emri i funksionit që do të thirret. Duhet të jetë az, AZ, 0-9, ose të përmbajë nënvizime dhe viza, me një gjatësi maksimale prej 64.
argsobject ( Struct format)Opsionale. Parametrat dhe vlerat e funksionit në formatin e objektit JSON.
| Përfaqësimi JSON |
|---|
{ "id": string, "name": string, "args": { object } } |
FunksioniPërgjigja
Rezultati i dhënë nga një FunctionCall që përmban një varg që përfaqëson FunctionDeclaration.name dhe një objekt të strukturuar JSON që përmban çdo rezultat nga funksioni përdoret si kontekst për modelin. Ky duhet të përmbajë rezultatin e një FunctionCall të bërë bazuar në parashikimin e modelit.
string id Opsionale. ID-ja e thirrjes së funksionit për të cilën është kjo përgjigje. Plotësohet nga klienti për t'u përputhur id në përkatëse të thirrjes së funksionit.
string nameE detyrueshme. Emri i funksionit që do të thirret. Duhet të jetë az, AZ, 0-9, ose të përmbajë nënvizime dhe viza, me një gjatësi maksimale prej 64.
object ( Struct format) responseE detyrueshme. Përgjigja e funksionit në formatin e objektit JSON. Thirrësit mund të përdorin çdo çelës sipas zgjedhjes së tyre që i përshtatet sintaksës së funksionit për të kthyer rezultatin e funksionit, p.sh. "output", "result", etj. Në veçanti, nëse thirrja e funksionit dështoi të ekzekutohej, përgjigjja mund të ketë një çelës "gabim" për të kthyer detajet e gabimit në model.
parts[]object ( FunctionResponsePart ) Opsionale. Parts të porositura që përbëjnë një përgjigje funksioni. Pjesët mund të kenë lloje të ndryshme IANA MIME.
willContinueboolean Opsionale. Sinjalizon që thirrja e funksionit vazhdon dhe do të kthehen më shumë përgjigje, duke e shndërruar thirrjen e funksionit në një gjenerator. I zbatueshëm vetëm për thirrjet e funksionit NON_BLOCKING, përndryshe injorohet. Nëse vendoset në false, përgjigjet e ardhshme nuk do të merren në konsideratë. Lejohet të kthehet response boshe me willContinue=False për të sinjalizuar se thirrja e funksionit ka mbaruar. Kjo mund të shkaktojë ende gjenerimin e modelit. Për të shmangur shkaktimin e gjenerimit dhe për të përfunduar thirrjen e funksionit, vendosni gjithashtu scheduling në SILENT .
schedulingenum ( Scheduling )Opsionale. Specifikon se si duhet të planifikohet përgjigja në bisedë. I zbatueshëm vetëm për thirrjet e funksioneve NON_BLOCKING, përndryshe injorohet. Parazgjedhja është WHEN_IDLE.
| Përfaqësimi JSON |
|---|
{ "id": string, "name": string, "response": { object }, "parts": [ { object ( |
FunctionResponsePjesa
Një lloj të dhënash që përmban media që është pjesë e një mesazhi FunctionResponse .
Një FunctionResponsePart përbëhet nga të dhëna që kanë një lloj të dhënash të shoqëruar. Një FunctionResponsePart mund të përmbajë vetëm një nga llojet e pranuara në FunctionResponsePart.data .
Një FunctionResponsePart duhet të ketë një lloj IANA MIME të fiksuar që identifikon llojin dhe nëntipin e medias nëse fusha inlineData është e mbushur me bajt të papërpunuar.
Union type datadata mund të jenë vetëm një nga të mëposhtmet: inlineDataobject ( FunctionResponseBlob )Bajt mediash të integruara.
| Përfaqësimi JSON |
|---|
{
// data
"inlineData": {
object ( |
FunksioniResponseBlob
Bajt të medias së papërpunuar për përgjigjen e funksionit.
Teksti nuk duhet të dërgohet si bajt i papërpunuar, përdorni fushën 'FunctionResponse.response'.
string mimeTypeLloji standard MIME IANA i të dhënave burimore. Shembuj: - image/png - image/jpeg Nëse jepet një lloj MIME i pambështetur, do të kthehet një gabim. Për një listë të plotë të llojeve të mbështetura, shihni Formatet e skedarëve të mbështetura .
datastring ( bytes format)Bajt të papërpunuar për formatet mediatike.
Një varg i koduar me base64.
| Përfaqësimi JSON |
|---|
{ "mimeType": string, "data": string } |
Planifikimi
Specifikon se si duhet të planifikohet përgjigja në bisedë.
| Numërime | |
|---|---|
SCHEDULING_UNSPECIFIED | Kjo vlerë nuk përdoret. |
SILENT | Shtoni rezultatin vetëm në kontekstin e bisedës, mos e ndërprisni ose mos aktivizoni gjenerimin. |
WHEN_IDLE | Shtoni rezultatin në kontekstin e bisedës dhe kërkoni që të gjenerohet rezultati pa ndërprerë gjenerimin në vazhdim. |
INTERRUPT | Shtoni rezultatin në kontekstin e bisedës, ndërpritni gjenerimin e vazhdueshëm dhe nxitni për të gjeneruar rezultate. |
Të Dhënat e Skedarit
Të dhëna të bazuara në URI.
string mimeTypeOpsionale. Lloji standard MIME IANA i të dhënave burimore.
string fileUriE detyrueshme. URI.
| Përfaqësimi JSON |
|---|
{ "mimeType": string, "fileUri": string } |
Kodi i Ekzekutueshëm
Kodi i gjeneruar nga modeli që është menduar të ekzekutohet dhe rezultati i kthyer te modeli.
Gjenerohet vetëm kur përdoret mjeti CodeExecution , në të cilin kodi do të ekzekutohet automatikisht dhe do të gjenerohet gjithashtu një CodeExecutionResult përkatës.
languageenum ( Language ) E detyrueshme. Gjuha e programimit të code .
string codeE detyrueshme. Kodi që do të ekzekutohet.
| Përfaqësimi JSON |
|---|
{
"language": enum ( |
Gjuha
Gjuhët e programimit të mbështetura për kodin e gjeneruar.
| Numërime | |
|---|---|
LANGUAGE_UNSPECIFIED | Gjuhë e paspecifikuar. Kjo vlerë nuk duhet të përdoret. |
PYTHON | Python >= 3.10, me numpy dhe simpy të disponueshëm. |
Rezultati i Ekzekutimit të Kodit
Rezultati i ekzekutimit të ExecutableCode .
Gjenerohet vetëm kur përdoret CodeExecution dhe gjithmonë vjen pas një part që përmban ExecutableCode .
outcomeenum ( Outcome )E detyrueshme. Rezultati i ekzekutimit të kodit.
outputstringOpsionale. Përmban stdout kur ekzekutimi i kodit është i suksesshëm, stderr ose përshkrim tjetër ndryshe.
| Përfaqësimi JSON |
|---|
{
"outcome": enum ( |
Rezultati
Numërimi i rezultateve të mundshme të ekzekutimit të kodit.
| Numërime | |
|---|---|
OUTCOME_UNSPECIFIED | Status i papërcaktuar. Kjo vlerë nuk duhet të përdoret. |
OUTCOME_OK | Ekzekutimi i kodit përfundoi me sukses. |
OUTCOME_FAILED | Ekzekutimi i kodit përfundoi, por me një dështim. stderr duhet të përmbajë arsyen. |
OUTCOME_DEADLINE_EXCEEDED | Ekzekutimi i kodit u zhvillua për një kohë shumë të gjatë dhe u anulua. Mund të ketë ose jo një rezultat të pjesshëm. |
Meta të dhëna video
Metadatat përshkruajnë përmbajtjen e videos së futur.
startOffsetstring ( Duration format)Opsionale. Zhvendosja fillestare e videos.
Një kohëzgjatje në sekonda me deri në nëntë shifra thyesore, që mbaron me ' s '. Shembull: "3.5s" .
endOffsetstring ( Duration format)Opsionale. Zhvendosja në fund të videos.
Një kohëzgjatje në sekonda me deri në nëntë shifra thyesore, që mbaron me ' s '. Shembull: "3.5s" .
number fpsOpsionale. Shpejtësia e kuadrove të videos së dërguar te modeli. Nëse nuk specifikohet, vlera e parazgjedhur do të jetë 1.0. Diapazoni i kuadrove për sekondë është (0.0, 24.0].
| Përfaqësimi JSON |
|---|
{ "startOffset": string, "endOffset": string, "fps": number } |
Mjet
Detajet e mjetit që modeli mund të përdorë për të gjeneruar përgjigje.
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.
ID-ja tjetër: 12
functionDeclarations[]object ( FunctionDeclaration ) Opsionale. Një listë e FunctionDeclarations të disponueshme për modelin që mund të përdoren për thirrjen e funksioneve.
Modeli ose sistemi nuk e ekzekuton funksionin. Në vend të kësaj, funksioni i përcaktuar mund të kthehet si një FunctionCall me argumente në anën e klientit për ekzekutim. Modeli mund të vendosë të thërrasë një nëngrup të këtyre funksioneve duke plotësuar FunctionCall në përgjigje. Raundi tjetër i bisedës mund të përmbajë një FunctionResponse me kontekstin e gjenerimit të "funksionit" Content.role për raundin tjetër të modelit.
googleSearchRetrievalobject ( GoogleSearchRetrieval )Opsionale. Mjet kërkimi që mundësohet nga kërkimi në Google.
object ( CodeExecution ) codeExecutionOpsionale. I mundëson modelit të ekzekutojë kodin si pjesë të gjenerimit.
object ( GoogleSearch ) googleSearchOpsionale. Lloji i mjetit GoogleSearch. Mjet për të mbështetur Kërkimin Google në Model. Mundësuar nga Google.
computerUseobject ( ComputerUse )Opsionale. Mjet për të mbështetur modelin që bashkëvepron drejtpërdrejt me kompjuterin. Nëse aktivizohet, ai automatikisht plotëson Deklaratat e Funksioneve specifike për përdorimin e kompjuterit.
object ( UrlContext ) urlContextOpsionale. Mjet për të mbështetur rikthimin e kontekstit të URL-së.
object ( FileSearch ) fileSearchOpsionale. Lloji i mjetit FileSearch. Mjet për të rikuperuar njohuri nga korpuset e Rikthimit Semantik.
googleMapsobject ( GoogleMaps )Opsionale. Mjet që lejon bazën e përgjigjes së modelit me kontekst gjeohapësinor që lidhet me pyetjen e përdoruesit.
| Përfaqësimi JSON |
|---|
{ "functionDeclarations": [ { object ( |
Deklarata e Funksionit
Përfaqësim i strukturuar i një deklarate funksioni siç përcaktohet nga specifikimi OpenAPI 3.03 . Në këtë deklaratë përfshihen emri dhe parametrat e funksionit. Kjo Deklaratë Funksioni është një përfaqësim i një blloku kodi që mund të përdoret si një Tool nga modeli dhe të ekzekutohet nga klienti.
string nameE detyrueshme. Emri i funksionit. Duhet të jetë az, AZ, 0-9, ose të përmbajë nënvizime, dy pika, pika dhe viza, me një gjatësi maksimale prej 64.
string descriptionE detyrueshme. Një përshkrim i shkurtër i funksionit.
behaviorenum ( Behavior )Opsionale. Specifikon funksionin Sjellja. Aktualisht mbështetet vetëm nga metoda BidiGenerateContent.
parametersobject ( Schema )Opsionale. Përshkruan parametrat e këtij funksioni. Pasqyron vargun e objektit të parametrit Open API 3.03. Çelësi: emri i parametrit. Emrat e parametrave janë të ndjeshëm ndaj shkronjave të mëdha dhe të vogla. Vlera e skemës: Skema që përcakton llojin e përdorur për parametrin.
parametersJsonSchemavalue ( Value format)Opsionale. Përshkruan parametrat e funksionit në formatin JSON Schema. Skema duhet të përshkruajë një objekt ku vetitë janë parametrat e funksionit. Për shembull:
{
"type": "object",
"properties": {
"name": { "type": "string" },
"age": { "type": "integer" }
},
"additionalProperties": false,
"required": ["name", "age"],
"propertyOrdering": ["name", "age"]
}
Kjo fushë është reciprokisht ekskluzive me parameters .
object ( Schema ) responseOpsionale. Përshkruan rezultatin nga ky funksion në formatin JSON Schema. Pasqyron Objektin e Përgjigjes së Open API 3.03. Skema përcakton llojin e përdorur për vlerën e përgjigjes së funksionit.
value ( Value format) responseJsonSchemaOpsionale. Përshkruan rezultatin nga ky funksion në formatin JSON Schema. Vlera e specifikuar nga skema është vlera e përgjigjes së funksionit.
Kjo fushë është reciprokisht ekskluzive me response .
Skema
Objekti Schema lejon përcaktimin e llojeve të të dhënave hyrëse dhe dalëse. Këto lloje mund të jenë objekte, por edhe primitive dhe vargje. Përfaqëson një nëngrup të zgjedhur të një objekti skeme OpenAPI 3.0 .
typeenum ( Type )E detyrueshme. Lloji i të dhënave.
formatstringOpsionale. Formati i të dhënave. Lejohet çdo vlerë, por shumica nuk aktivizojnë ndonjë funksionalitet të veçantë.
string titleOpsionale. Titulli i skemës.
string descriptionOpsionale. Një përshkrim i shkurtër i parametrit. Ky mund të përmbajë shembuj përdorimi. Përshkrimi i parametrit mund të formatohet si Markdown.
boolean nullableOpsionale. Tregon nëse vlera mund të jetë null.
string enum[]Opsionale. Vlerat e mundshme të elementit Type.STRING me formatin enum. Për shembull, mund të përcaktojmë një Drejtim Enum si: {type:STRING, format:enum, enum:["LINDJE", VERI", "JUG", "PERËNDIM"]}
maxItemsstring ( int64 format)Opsionale. Numri maksimal i elementeve për Type.ARRAY.
minItemsstring ( int64 format)Opsionale. Numri minimal i elementeve për Type.ARRAY.
propertiesmap (key: string, value: object ( Schema ))Opsionale. Vetitë e Tipit.OBJECT.
Një objekt që përmban një listë çiftesh "key": value :. Shembull: { "name": "wrench", "mass": "1.3kg", "count": "3" } .
string required[]Opsionale. Vetitë e kërkuara të Type.OBJECT.
minPropertiesstring ( int64 format)Opsionale. Numri minimal i vetive për Type.OBJECT.
maxPropertiesstring ( int64 format)Opsionale. Numri maksimal i vetive për Type.OBJECT.
minLengthstring ( int64 format)Opsionale. FUSHAT E SKEMËS PËR TIPIN STRING Gjatësia minimale e Tipit.STRING
maxLengthstring ( int64 format)Opsionale. Gjatësia maksimale e Llojit.STRING
string patternOpsionale. Modeli i Tipit.STRING për të kufizuar një varg në një shprehje të rregullt.
examplevalue ( Value format)Opsionale. Shembull i objektit. Do të plotësohet vetëm kur objekti është rrënja.
anyOf[]object ( Schema )Opsionale. Vlera duhet të validohet kundrejt çdo (një ose më shumë) nënskemave në listë.
string propertyOrdering[]Opsionale. Renditja e vetive. Nuk është një fushë standarde në specifikimin e hapur të api-t. Përdoret për të përcaktuar renditjen e vetive në përgjigje.
value ( Value format) default Opsionale. Vlera e parazgjedhur e fushës. Sipas Skemës JSON, kjo fushë është menduar për gjeneratorët e dokumentacionit dhe nuk ndikon në validim. Kështu, përfshihet këtu dhe injorohet në mënyrë që zhvilluesit që dërgojnë skema me një fushë default të mos marrin gabime të fushës së panjohur.
itemsobject ( Schema )Opsionale. Skema e elementeve të Type.ARRAY.
number minimumOpsionale. FUSHAT E SKEMËS PËR TIPIN INTEGER dhe NUMËR Vlera minimale e TIPI.INTEGER dhe TIPI.NUMËR
number maximumOpsionale. Vlera maksimale e Type.INTEGER dhe Type.NUMBER
| Përfaqësimi JSON |
|---|
{ "type": enum ( |
Lloji
Lloji përmban listën e llojeve të të dhënave OpenAPI siç përcaktohen nga https://spec.openapis.org/oas/v3.0.3#data-types
| Numërime | |
|---|---|
TYPE_UNSPECIFIED | Nuk specifikohet, nuk duhet të përdoret. |
STRING | Lloji i vargut. |
NUMBER | Lloji i numrit. |
INTEGER | Lloji i numrit të plotë. |
BOOLEAN | Lloji boolean. |
ARRAY | Lloji i vargut. |
OBJECT | Lloji i objektit. |
NULL | Lloji Null. |
Sjellje
Përcakton sjelljen e funksionit. Vlera e parazgjedhur është BLOCKING .
| Numërime | |
|---|---|
UNSPECIFIED | Kjo vlerë nuk përdoret. |
BLOCKING | Nëse është vendosur, sistemi do të presë për të marrë përgjigjen e funksionit përpara se të vazhdojë bisedën. |
NON_BLOCKING | Nëse vendoset, sistemi nuk do të presë për të marrë përgjigjen e funksionit. Në vend të kësaj, ai do të përpiqet të trajtojë përgjigjet e funksionit kur ato bëhen të disponueshme, duke ruajtur njëkohësisht bisedën midis përdoruesit dhe modelit. |
Kërkimi në Google
Mjet për të marrë të dhëna publike të uebit për tokëzim, mundësuar nga Google.
dynamicRetrievalConfigobject ( DynamicRetrievalConfig )Specifikon konfigurimin dinamik të rikthimit për burimin e dhënë.
| Përfaqësimi JSON |
|---|
{
"dynamicRetrievalConfig": {
object ( |
Konfigurimi i Rikthimit Dinamike
Përshkruan opsionet për të personalizuar rikthimin dinamik.
modeenum ( Mode )Modaliteti i parashikuesit që do të përdoret në rikthimin dinamik.
number dynamicThresholdPragu që do të përdoret në rikthimin dinamik. Nëse nuk është vendosur, përdoret një vlerë e parazgjedhur e sistemit.
| Përfaqësimi JSON |
|---|
{
"mode": enum ( |
Modaliteti
Modaliteti i parashikuesit që do të përdoret në rikthimin dinamik.
| Numërime | |
|---|---|
MODE_UNSPECIFIED | Gjithmonë aktivizo rikthimin. |
MODE_DYNAMIC | Ekzekutoni rikuperimin vetëm kur sistemi vendos se është e nevojshme. |
Ekzekutimi i Kodit
Ky lloj nuk ka fusha.
Mjet që ekzekuton kodin e gjeneruar nga modeli dhe automatikisht e kthen rezultatin në model.
Shihni gjithashtu ExecutableCode dhe CodeExecutionResult të cilat gjenerohen vetëm kur përdoret ky mjet.
Kërkimi në Google
Lloji i mjetit të Kërkimit në Google. Mjet për të mbështetur Kërkimin në Google në Model. Mundësuar nga Google.
object ( Interval ) timeRangeFilterOpsionale. Filtroni rezultatet e kërkimit në një interval kohor specifik. Nëse klientët caktojnë një kohë fillimi, ata duhet të caktojnë një kohë mbarimi (dhe anasjelltas).
| Përfaqësimi JSON |
|---|
{
"timeRangeFilter": {
object ( |
Intervali
Përfaqëson një interval kohor, të koduar si një fillim i Timestamp (gjithëpërfshirës) dhe një fund i Timestamp (përjashtues).
Fillimi duhet të jetë më i vogël ose i barabartë me fundin. Kur fillimi është i barabartë me fundin, intervali është bosh (nuk përputhet me kohën). Kur si fillimi ashtu edhe mbarimi nuk janë të specifikuar, intervali përputhet me çdo kohë.
startTimestring ( Timestamp format)Opsionale. Fillimi gjithëpërfshirës i intervalit.
Nëse specifikohet, një Timestamp që përputhet me këtë interval do të duhet të jetë i njëjtë ose pas fillimit.
Përdor RFC 3339, ku rezultati i gjeneruar do të jetë gjithmonë i normalizuar sipas Z-së dhe do të përdorë 0, 3, 6 ose 9 shifra thyesore. Pranohen edhe zhvendosje të tjera përveç "Z". Shembuj: "2014-10-02T15:01:23Z" , "2014-10-02T15:01:23.045123456Z" ose "2014-10-02T15:01:23+05:30" .
endTimestring ( Timestamp format)Opsionale. Fundi ekskluziv i intervalit.
Nëse specifikohet, një Timestamp që përputhet me këtë interval do të duhet të jetë para fundit.
Përdor RFC 3339, ku rezultati i gjeneruar do të jetë gjithmonë i normalizuar sipas Z-së dhe do të përdorë 0, 3, 6 ose 9 shifra thyesore. Pranohen edhe zhvendosje të tjera përveç "Z". Shembuj: "2014-10-02T15:01:23Z" , "2014-10-02T15:01:23.045123456Z" ose "2014-10-02T15:01:23+05:30" .
| Përfaqësimi JSON |
|---|
{ "startTime": string, "endTime": string } |
Përdorimi i Kompjuterit
Lloji i mjetit të përdorimit të kompjuterit.
environmentenum ( Environment )E detyrueshme. Mjedisi që po operohet.
string excludedPredefinedFunctions[]Opsionale. Si parazgjedhje, funksionet e paracaktuara përfshihen në thirrjen përfundimtare të modelit. Disa prej tyre mund të përjashtohen në mënyrë të qartë nga përfshirja automatike. Kjo mund të shërbejë për dy qëllime: 1. Përdorimin e një hapësire veprimi më të kufizuar/të ndryshme. 2. Përmirësimin e përkufizimeve/udhëzimeve të funksioneve të paracaktuara.
| Përfaqësimi JSON |
|---|
{
"environment": enum ( |
Mjedisi
Përfaqëson mjedisin që operohet, siç është një shfletues interneti.
| Numërime | |
|---|---|
ENVIRONMENT_UNSPECIFIED | Parazgjedhur në shfletues. |
ENVIRONMENT_BROWSER | Operon në një shfletues interneti. |
Konteksti i Url-it
Ky lloj nuk ka fusha.
Mjet për të mbështetur rikthimin e kontekstit të URL-së.
Kërkimi i skedarëve
Mjeti FileSearch që rikuperon njohuri nga korpuset Semantic Retrieval. Skedarët importohen në korpuset Semantic Retrieval duke përdorur ImportFile API.
retrievalResources[]object ( RetrievalResource )E nevojshme. Burime të rikuperimit semantik nga të cilat mund të rikuperohet. Aktualisht mbështet vetëm një korpus. Në të ardhmen mund të hapim mbështetje për shumë korpuse.
object ( RetrievalConfig ) retrievalConfigOpsionale. Konfigurimi për rikthimin.
| Përfaqësimi JSON |
|---|
{ "retrievalResources": [ { object ( |
Burimi i Rikthimit
Burimi i rikthimit semantik nga i cili do të rikthehet.
string ragStoreName E detyrueshme. Emri i burimit të rikthimit semantik nga i cili do të rikthehet. Shembull: ragStores/my-rag-store-123
| Përfaqësimi JSON |
|---|
{ "ragStoreName": string } |
RetrievalConfig
Konfigurimi i rikthimit semantik.
metadataFilterstringOpsionale. Filtër metadatash për t'u aplikuar në dokumentet dhe pjesët e rikthimit semantik.
integer topKOpsionale. Numri i pjesëve të rikuperimit semantik që duhen rikuperuar.
| Përfaqësimi JSON |
|---|
{ "metadataFilter": string, "topK": integer } |
GoogleMaps
Mjeti GoogleMaps që ofron kontekst gjeohapësinor për pyetjen e përdoruesit.
enableWidgetbooleanOpsionale. Nëse duhet të kthehet një token konteksti i widget-it në GroundingMetadata të përgjigjes. Zhvilluesit mund ta përdorin tokenin e kontekstit të widget-it për të paraqitur një widget të Google Maps me kontekst gjeohapësinor që lidhet me vendet që modeli i referohet në përgjigje.
| Përfaqësimi JSON |
|---|
{ "enableWidget": boolean } |
Konfigurimi i Veglave
Konfigurimi i Mjetit që përmban parametrat për specifikimin e përdorimit Tool në kërkesë.
object ( FunctionCallingConfig ) functionCallingConfigOpsionale. Konfigurimi i thirrjes së funksionit.
object ( RetrievalConfig ) retrievalConfigOpsionale. Konfigurimi i rikuperimit.
| Përfaqësimi JSON |
|---|
{ "functionCallingConfig": { object ( |
Konfigurimi i Thirrjes së Funksionit
Konfigurimi për specifikimin e sjelljes së thirrjes së funksionit.
modeenum ( Mode )Opsionale. Specifikon mënyrën në të cilën duhet të ekzekutohet thirrja e funksionit. Nëse nuk specifikohet, vlera e parazgjedhur do të vendoset në AUTO.
string allowedFunctionNames[]Opsionale. Një grup emrash funksionesh që, kur ofrohen, kufizon funksionet që modeli do të thërrasë.
Kjo duhet të caktohet vetëm kur Moda është ÇDO ose E VALIDUAR. Emrat e funksioneve duhet të përputhen me [FunctionDeclaration.name]. Kur caktohet, modeli do të parashikojë një thirrje funksioni vetëm nga emrat e funksioneve të lejuara.
| Përfaqësimi JSON |
|---|
{
"mode": enum ( |
Modaliteti
Përcakton sjelljen e ekzekutimit për thirrjen e funksionit duke përcaktuar mënyrën e ekzekutimit.
| Numërime | |
|---|---|
MODE_UNSPECIFIED | Modalitet i paspecifikuar i thirrjes së funksionit. Kjo vlerë nuk duhet të përdoret. |
AUTO | Sjellja e parazgjedhur e modelit, modeli vendos të parashikojë ose një thirrje funksioni ose një përgjigje në gjuhën natyrore. |
ANY | Modeli është i kufizuar të parashikojë gjithmonë vetëm një thirrje funksioni. Nëse caktohen "allowedFunctionNames", thirrja e parashikuar e funksionit do të kufizohet në cilindo prej "allowedFunctionNames", përndryshe thirrja e parashikuar e funksionit do të jetë cilado prej "functionDeclarations" të dhëna. |
NONE | Modeli nuk do të parashikojë asnjë thirrje funksioni. Sjellja e modelit është e njëjtë me atë kur nuk kalon asnjë deklaratë funksioni. |
VALIDATED | Modeli vendos të parashikojë ose një thirrje funksioni ose një përgjigje në gjuhën natyrore, por do të validojë thirrjet e funksioneve me dekodim të kufizuar. Nëse caktohen "allowedFunctionNames", thirrja e parashikuar e funksionit do të kufizohet në cilindo prej "allowedFunctionNames", përndryshe thirrja e parashikuar e funksionit do të jetë cilado prej "functionDeclarations" të dhëna. |
RetrievalConfig
Konfigurimi i rikuperimit.
latLngobject ( LatLng )Opsionale. Vendndodhja e përdoruesit.
string languageCodeOpsionale. Kodi i gjuhës së përdoruesit. Kodi i gjuhës për përmbajtjen. Përdorni etiketat gjuhësore të përcaktuara nga BCP47 .
| Përfaqësimi JSON |
|---|
{
"latLng": {
object ( |
LatLng
Një objekt që përfaqëson një çift gjerësie/gjatësie. Kjo shprehet si një çift dyshesh për të përfaqësuar gradë gjerësie dhe gradë gjatësie. Nëse nuk specifikohet ndryshe, ky objekt duhet të jetë në përputhje me standardin WGS84 . Vlerat duhet të jenë brenda diapazoneve të normalizuara.
number latitudeGjerësia gjeografike në gradë. Duhet të jetë në diapazonin [-90.0, +90.0].
number longitudeGjatësia gjeografike në gradë. Duhet të jetë në diapazonin [-180.0, +180.0].
| Përfaqësimi JSON |
|---|
{ "latitude": number, "longitude": number } |
PërdorimiMeta të dhëna
Meta të dhëna mbi përdorimin e përmbajtjes së ruajtur në memorien e përkohshme.
totalTokenCountintegerNumri total i tokenëve që konsumon përmbajtja e ruajtur në memorien e përkohshme.
| Përfaqësimi JSON |
|---|
{ "totalTokenCount": integer } |