Gemini API

API-ja Gemini Interactions është një API eksperimentale që u lejon zhvilluesve të ndërtojnë aplikacione gjeneruese të IA-së duke përdorur modelet Gemini. Gemini është modeli ynë më i aftë, i ndërtuar nga themeli për të qenë multimodal. Mund të përgjithësojë dhe të kuptojë, të funksionojë dhe të kombinojë pa probleme lloje të ndryshme informacioni, duke përfshirë gjuhën, imazhet, audion, videon dhe kodin. Ju mund ta përdorni API-në Gemini për raste përdorimi si arsyetimi nëpër tekst dhe imazhe, gjenerimi i përmbajtjes, agjentët e dialogut, sistemet e përmbledhjes dhe klasifikimit dhe më shumë.

Shiko si ulje Shikoni Specifikimin OpenAPI

Krijo Webhook

posto https://generativelanguage.googleapis.com/v1beta/webhooks

Krijon një Webhook të ri.

Trupi i kërkesës

Trupi i kërkesës përmban të dhëna me strukturën e mëposhtme:

varg emri (opsional)

Opsionale. Emri i dhënë nga përdoruesi i webhook-ut.

vargu uri (i detyrueshëm)

E detyrueshme. URI-ja ku do të dërgohen ngjarjet e webhook-ut.

vargu subscribed_events (objekt ose varg) (i detyrueshëm)

E detyrueshme. Ngjarjet në të cilat është abonuar webhook-u. Ngjarjet e disponueshme: - batch.succeeded - batch.expired - batch.failed - interaction.requires_action - interaction.completed - interaction.failed - video.generated

Përgjigje

Nëse është i suksesshëm, trupi i përgjigjes përmban të dhëna me strukturën e mëposhtme:

varg emri (opsional)

Opsionale. Emri i dhënë nga përdoruesi i webhook-ut.

vargu uri (opsional)

E detyrueshme. URI-ja ku do të dërgohen ngjarjet e webhook-ut.

vargu subscribed_events (objekt ose varg) (opsional)

E detyrueshme. Ngjarjet në të cilat është abonuar webhook-u. Ngjarjet e disponueshme: - batch.succeeded - batch.expired - batch.failed - interaction.requires_action - interaction.completed - interaction.failed - video.generated

vargu create_time (opsional)

Vetëm rezultati. Vula kohore kur u krijua webhook-u.

vargu i kohës_përditësimit (opsional)

Vetëm rezultati. Vula kohore kur u përditësua webhook-u për herë të fundit.

signing_secrets Sekreti i Nënshkrimit (opsional)

Vetëm rezultate. Sekretet e nënshkrimit të lidhura me këtë webhook.

Përfaqëson një sekret nënshkrimi të përdorur për të verifikuar ngarkesat e webhook-ut.

Fushat

vargu i cruncated_secret (opsional)

Vetëm rezultati. Versioni i shkurtuar i sekretit të nënshkrimit.

vargu expire_time (opsional)

Vetëm rezultate. Data e skadimit të sekretit të nënshkrimit.

enum i gjendjes (string) (opsionale)

Vetëm rezultati. Gjendja e webhook-ut.

Vlerat e mundshme:

  • enabled
  • disabled
  • disabled_due_to_failed_deliveries
vargu new_signing_secret (opsional)

Vetëm rezultate. Sekreti i ri i nënshkrimit për webhook-un. Plotësohet vetëm në create.

vargu i identifikimit (opsional)

Vetëm rezultate. ID-ja e webhook-ut.

Shembull

Shembull Përgjigjeje 

{
  "name": "string",
  "uri": "string",
  "subscribed_events": [
    "string"
  ],
  "create_time": "string",
  "update_time": "string",
  "signing_secrets": [
    {
      "truncated_secret": "string",
      "expire_time": "string"
    }
  ],
  "state": "enabled",
  "new_signing_secret": "string",
  "id": "string"
}

ListWebhooks

merrni https://generativelanguage.googleapis.com/v1beta/webhooks

Liston të gjitha Webhook-et.

Parametrat e Shtegut / Pyetjes

numër i plotë i madhësisë së faqes (opsional)

Opsionale. Numri maksimal i webhook-eve që duhen kthyer. Shërbimi mund të kthejë më pak se kjo vlerë. Nëse nuk specifikohet, do të kthehen maksimumi 50 webhook-e. Vlera maksimale është 1000.

vargu i shenjës së faqes (opsional)

Opsionale. Një shenjë faqeje, e marrë nga një thirrje e mëparshme `ListWebhooks`. Jepni këtë për të marrë faqen pasuese.

Përgjigje

Nëse është i suksesshëm, trupi i përgjigjes përmban të dhëna me strukturën e mëposhtme:

vargu webhooks ( Webhook ) (opsional)

Webhook-et.

vargu i shenjës së faqes_next_page (opsional)

Një shenjë, e cila mund të dërgohet si `page_token` për të marrë faqen tjetër. Nëse kjo fushë lihet jashtë, nuk ka faqe pasuese.

Shembull

Shembull Përgjigjeje 

{
  "webhooks": [
    {
      "name": "string",
      "uri": "string",
      "subscribed_events": [
        "string"
      ],
      "create_time": "string",
      "update_time": "string",
      "signing_secrets": [
        {
          "truncated_secret": "string",
          "expire_time": "string"
        }
      ],
      "state": "enabled",
      "new_signing_secret": "string",
      "id": "string"
    }
  ],
  "next_page_token": "string"
}

GetWebhook

merrni https://generativelanguage.googleapis.com/v1beta/webhooks/{id}

Merr një Webhook specifik.

Parametrat e Shtegut / Pyetjes

vargu i identifikimit (i detyrueshëm)

E detyrueshme. ID-ja e webhook-ut që do të rikuperohet.

Përgjigje

Nëse është i suksesshëm, trupi i përgjigjes përmban të dhëna me strukturën e mëposhtme:

varg emri (opsional)

Opsionale. Emri i dhënë nga përdoruesi i webhook-ut.

vargu uri (opsional)

E detyrueshme. URI-ja ku do të dërgohen ngjarjet e webhook-ut.

vargu subscribed_events (objekt ose varg) (opsional)

E detyrueshme. Ngjarjet në të cilat është abonuar webhook-u. Ngjarjet e disponueshme: - batch.succeeded - batch.expired - batch.failed - interaction.requires_action - interaction.completed - interaction.failed - video.generated

vargu create_time (opsional)

Vetëm rezultati. Vula kohore kur u krijua webhook-u.

vargu i kohës_përditësimit (opsional)

Vetëm rezultati. Vula kohore kur u përditësua webhook-u për herë të fundit.

signing_secrets Sekreti i Nënshkrimit (opsional)

Vetëm rezultate. Sekretet e nënshkrimit të lidhura me këtë webhook.

Përfaqëson një sekret nënshkrimi të përdorur për të verifikuar ngarkesat e webhook-ut.

Fushat

vargu i cruncated_secret (opsional)

Vetëm rezultati. Versioni i shkurtuar i sekretit të nënshkrimit.

vargu expire_time (opsional)

Vetëm rezultate. Data e skadimit të sekretit të nënshkrimit.

enum i gjendjes (string) (opsionale)

Vetëm rezultati. Gjendja e webhook-ut.

Vlerat e mundshme:

  • enabled
  • disabled
  • disabled_due_to_failed_deliveries
vargu new_signing_secret (opsional)

Vetëm rezultate. Sekreti i ri i nënshkrimit për webhook-un. Plotësohet vetëm në create.

vargu i identifikimit (opsional)

Vetëm rezultate. ID-ja e webhook-ut.

Shembull

Shembull Përgjigjeje 

{
  "name": "string",
  "uri": "string",
  "subscribed_events": [
    "string"
  ],
  "create_time": "string",
  "update_time": "string",
  "signing_secrets": [
    {
      "truncated_secret": "string",
      "expire_time": "string"
    }
  ],
  "state": "enabled",
  "new_signing_secret": "string",
  "id": "string"
}

Përditëso Webhook-un

patch https://generativelanguage.googleapis.com/v1beta/webhooks/{id}

Përditëson një Webhook ekzistues.

Parametrat e Shtegut / Pyetjes

vargu i identifikimit (i detyrueshëm)

E detyrueshme. ID-ja e webhook-ut që do të përditësohet.

vargu i maskës_përditësim (opsional)

Opsionale. Lista e fushave që do të përditësohen.

Trupi i kërkesës

Trupi i kërkesës përmban të dhëna me strukturën e mëposhtme:

varg emri (opsional)

Opsionale. Emri i dhënë nga përdoruesi i webhook-ut.

vargu uri (opsional)

Opsionale. URI-ja ku do të dërgohen ngjarjet e webhook-ut.

vargu subscribed_events (objekt ose varg) (opsional)

Opsionale. Ngjarjet në të cilat është abonuar webhook-u. Ngjarjet e disponueshme: - batch.succeeded - batch.expired - batch.failed - interaction.requires_action - interaction.completed - interaction.failed - video.generated

enum i gjendjes (string) (opsionale)

Opsionale. Gjendja e webhook-ut.

Vlerat e mundshme:

  • enabled
  • disabled
  • disabled_due_to_failed_deliveries

Përgjigje

Nëse është i suksesshëm, trupi i përgjigjes përmban të dhëna me strukturën e mëposhtme:

varg emri (opsional)

Opsionale. Emri i dhënë nga përdoruesi i webhook-ut.

vargu uri (opsional)

E detyrueshme. URI-ja ku do të dërgohen ngjarjet e webhook-ut.

vargu subscribed_events (objekt ose varg) (opsional)

E detyrueshme. Ngjarjet në të cilat është abonuar webhook-u. Ngjarjet e disponueshme: - batch.succeeded - batch.expired - batch.failed - interaction.requires_action - interaction.completed - interaction.failed - video.generated

vargu create_time (opsional)

Vetëm rezultati. Vula kohore kur u krijua webhook-u.

vargu i kohës_përditësimit (opsional)

Vetëm rezultati. Vula kohore kur u përditësua webhook-u për herë të fundit.

signing_secrets Sekreti i Nënshkrimit (opsional)

Vetëm rezultate. Sekretet e nënshkrimit të lidhura me këtë webhook.

Përfaqëson një sekret nënshkrimi të përdorur për të verifikuar ngarkesat e webhook-ut.

Fushat

vargu i cruncated_secret (opsional)

Vetëm rezultati. Versioni i shkurtuar i sekretit të nënshkrimit.

vargu expire_time (opsional)

Vetëm rezultate. Data e skadimit të sekretit të nënshkrimit.

enum i gjendjes (string) (opsionale)

Vetëm rezultati. Gjendja e webhook-ut.

Vlerat e mundshme:

  • enabled
  • disabled
  • disabled_due_to_failed_deliveries
vargu new_signing_secret (opsional)

Vetëm rezultate. Sekreti i ri i nënshkrimit për webhook-un. Plotësohet vetëm në create.

vargu i identifikimit (opsional)

Vetëm rezultate. ID-ja e webhook-ut.

Shembull

Shembull Përgjigjeje 

{
  "name": "string",
  "uri": "string",
  "subscribed_events": [
    "string"
  ],
  "create_time": "string",
  "update_time": "string",
  "signing_secrets": [
    {
      "truncated_secret": "string",
      "expire_time": "string"
    }
  ],
  "state": "enabled",
  "new_signing_secret": "string",
  "id": "string"
}

DeleteWebhook

fshi https://generativelanguage.googleapis.com/v1beta/webhooks/{id}

Fshin një Webhook.

Parametrat e Shtegut / Pyetjes

vargu i identifikimit (i detyrueshëm)

E detyrueshme. ID-ja e webhook-ut që do të fshihet. Formati: `{webhook_id}`

Përgjigje

Nëse ka sukses, përgjigja është bosh.

Shembull

RotateSigningSecret

posto https://generativelanguage.googleapis.com/v1beta/webhooks/{id}:rotateSigningSecret

Gjeneron një sekret të ri nënshkrimi për një Webhook.

Parametrat e Shtegut / Pyetjes

vargu i identifikimit (i detyrueshëm)

E detyrueshme. ID-ja e webhook-ut për të cilin do të gjenerohet një sekret nënshkrimi. Formati: `{webhook_id}`

Trupi i kërkesës

Trupi i kërkesës përmban të dhëna me strukturën e mëposhtme:

enum i sjelljes_revokimit (string) (opsionale)

Opsionale. Sjellja e revokimit për sekretet e nënshkrimit të mëparshëm.

Vlerat e mundshme:

  • revoke_previous_secrets_after_h24
  • revoke_previous_secrets_immediately

Përgjigje

Nëse është i suksesshëm, trupi i përgjigjes përmban të dhëna me strukturën e mëposhtme:

varg sekret (opsional)

Vetëm rezultate. Sekreti i nënshkrimit i gjeneruar rishtazi.

Shembull

Shembull Përgjigjeje 

{
  "secret": "string"
}

PingWebhook

posto https://generativelanguage.googleapis.com/v1beta/webhooks/{id}:ping

Dërgon një ngjarje ping në një Webhook.

Parametrat e Shtegut / Pyetjes

vargu i identifikimit (i detyrueshëm)

E detyrueshme. ID-ja e webhook-ut që do të pingohet. Formati: `{webhook_id}`

Trupi i kërkesës

Trupi i kërkesës përmban të dhëna me strukturën e mëposhtme:

Përgjigje

Nëse ka sukses, përgjigja është bosh.

Shembull

Burimet

Webhook

Një burim Webhook.

Fushat

varg emri (opsional)

Opsionale. Emri i dhënë nga përdoruesi i webhook-ut.

vargu uri (opsional)

E detyrueshme. URI-ja ku do të dërgohen ngjarjet e webhook-ut.

vargu subscribed_events (objekt ose varg) (opsional)

E detyrueshme. Ngjarjet në të cilat është abonuar webhook-u. Ngjarjet e disponueshme: - batch.succeeded - batch.expired - batch.failed - interaction.requires_action - interaction.completed - interaction.failed - video.generated

vargu create_time (opsional)

Vetëm rezultati. Vula kohore kur u krijua webhook-u.

vargu i kohës_përditësimit (opsional)

Vetëm rezultati. Vula kohore kur u përditësua webhook-u për herë të fundit.

signing_secrets Sekreti i Nënshkrimit (opsional)

Vetëm rezultate. Sekretet e nënshkrimit të lidhura me këtë webhook.

Përfaqëson një sekret nënshkrimi të përdorur për të verifikuar ngarkesat e webhook-ut.

Fushat

vargu i cruncated_secret (opsional)

Vetëm rezultati. Versioni i shkurtuar i sekretit të nënshkrimit.

vargu expire_time (opsional)

Vetëm rezultate. Data e skadimit të sekretit të nënshkrimit.

enum i gjendjes (string) (opsionale)

Vetëm rezultati. Gjendja e webhook-ut.

Vlerat e mundshme:

  • enabled
  • disabled
  • disabled_due_to_failed_deliveries
vargu new_signing_secret (opsional)

Vetëm rezultate. Sekreti i ri i nënshkrimit për webhook-un. Plotësohet vetëm në create.

vargu i identifikimit (opsional)

Vetëm rezultate. ID-ja e webhook-ut.

Modelet e të dhënave

Ngjarje NdërveprimiSse

Llojet e mundshme

Diskriminuesi polimorfik: event_type

Ngjarje e Krijuar nga Ndërveprimi

objekti i tipit_event_type (i detyrueshëm)

Nuk është dhënë përshkrim.

Gjithmonë i vendosur në "interaction.created" .

ndërveprim Ndërveprim (i detyrueshëm)

Nuk është dhënë përshkrim.

Burimi i Ndërveprimit.

Fushat

modeli ModelOpsioni (opsional)

Emri i `Modelit` të përdorur për gjenerimin e ndërveprimit.

Vlerat e mundshme:

  • gemini-2.5-computer-use-preview-10-2025

    Një model i aftësive agjentike i projektuar për bashkëveprim të drejtpërdrejtë të ndërfaqes, duke i lejuar Gemini-t të perceptojë dhe të lundrojë në mjedise dixhitale.

  • gemini-2.5-flash

    Modeli ynë i parë hibrid i arsyetimit i cili mbështet një dritare konteksti prej 1M token dhe ka buxhete të të menduarit.

  • gemini-2.5-flash-image

    Modeli ynë i gjenerimit të imazheve vendase, i optimizuar për shpejtësi, fleksibilitet dhe kuptim kontekstual. Futja dhe dalja e tekstit ka të njëjtin çmim si në Flash 2.5.

  • gemini-2.5-flash-lite

    Modeli ynë më i vogël dhe më ekonomik, i ndërtuar për përdorim në shkallë të gjerë.

  • gemini-2.5-flash-lite-preview-09-2025

    Modeli më i fundit i bazuar në Gemini 2.5 Flash lite i optimizuar për efikasitet në kosto, rendiment të lartë dhe cilësi të lartë.

  • gemini-2.5-flash-native-audio-preview-12-2025

    Modelet tona audio vendase janë optimizuar për dalje audio me cilësi më të lartë me ritëm, natyrshmëri zëri, fjalëshmëri dhe humor më të mirë.

  • gemini-2.5-flash-preview-09-2025

    Modeli më i fundit i bazuar në modelin 2.5 Flash. 2.5 Flash Preview është më i miri për përpunim në shkallë të gjerë, detyra me vonesë të ulët, me vëllim të lartë që kërkojnë të menduarit dhe raste përdorimi agjentësh.

  • gemini-2.5-flash-preview-tts

    Modeli ynë 2.5 Flash i konvertimit tekst-në-fjalë është optimizuar për gjenerim të fuqishëm të të folurit dhe të kontrollueshëm me vonesë të ulët.

  • gemini-2.5-pro

    Modeli ynë shumëfunksional i teknologjisë së fundit, i cili shkëlqen në kodim dhe detyra komplekse arsyetimi.

  • gemini-2.5-pro-preview-tts

    Modeli ynë audio 2.5 Pro i konvertimit tekst-në-fjalë është i optimizuar për gjenerim të fuqishëm të të folurit me vonesë të ulët për rezultate më natyrale dhe udhëzime më të lehta për t'u drejtuar.

  • gemini-3-flash-preview

    Modeli ynë më inteligjent i ndërtuar për shpejtësi, duke kombinuar inteligjencën kufitare me kërkimin dhe tokëzimin superior.

  • gemini-3-pro-image-preview

    Model i gjenerimit dhe redaktimit të imazheve sipas teknologjisë së fundit.

  • gemini-3-pro-preview

    Modeli ynë më inteligjent me arsyetim SOTA dhe kuptim multimodal, si dhe aftësi të fuqishme kodimi agjentik dhe vibrues.

  • gemini-3.1-pro-preview

    Modeli ynë më i fundit i arsyetimit SOTA me thellësi dhe nuancë të paparë, si dhe aftësi të fuqishme të të kuptuarit dhe kodimit multimodal.

  • gemini-3.1-flash-image-preview

    Inteligjencë vizuale e nivelit profesional me efikasitet me shpejtësinë e Flash-it dhe aftësi gjenerimi të bazuara në realitet.

  • gemini-3.1-flash-lite-preview

    Modeli ynë më me kosto efektive, i optimizuar për detyra agjentike me vëllim të lartë, përkthim dhe përpunim të thjeshtë të të dhënave.

  • gemini-3.1-flash-tts-preview

    Gemini 3.1 Flash TTS: Gjenerim i fuqishëm i të folurit me vonesë të ulët. Shijoni dalje natyrale, udhëzime të kontrollueshme dhe etiketa të reja audio ekspresive për kontroll të saktë të rrëfimit.

  • lyria-3-clip-preview

    Modeli ynë i gjenerimit të muzikës me latencë të ulët është i optimizuar për klipe audio me besnikëri të lartë dhe kontroll të saktë ritmik.

  • lyria-3-pro-preview

    Modeli ynë i avancuar, gjenerues i këngëve të plota, me kuptim të thellë kompozicioni, i optimizuar për kontroll të saktë strukturor dhe tranzicione komplekse nëpër stile të ndryshme muzikore.

Modeli që do të plotësojë kërkesën tuaj.\n\nShihni [models](https://ai.google.dev/gemini-api/docs/models) për detaje shtesë.

agjenti i agjentit (opsionale)

Emri i `Agjentit` të përdorur për gjenerimin e ndërveprimit.

Vlerat e mundshme:

  • deep-research-pro-preview-12-2025

    Agjent i Kërkimeve të Thellë Gemini

  • deep-research-preview-04-2026

    Agjent i Kërkimeve të Thellë Gemini

  • deep-research-max-preview-04-2026

    Agjenti Maksimal i Kërkimeve të Thellë Gemini

Agjenti me të cilin duhet të ndërveprohet.

vargu i identifikimit (opsional)

E detyrueshme. Vetëm rezultat. Një identifikues unik për përfundimin e ndërveprimit.

numërimi i statusit (varg) (opsional)

E detyrueshme. Vetëm rezultat. Statusi i ndërveprimit.

Vlerat e mundshme:

  • in_progress
  • requires_action
  • completed
  • failed
  • cancelled
  • incomplete
varg i krijuar (opsional)

E detyrueshme. Vetëm rezultati. Ora në të cilën u krijua përgjigja në formatin ISO 8601 (YYYY-MM-DDThh:mm:ssZ).

varg i përditësuar (opsional)

E detyrueshme. Vetëm rezultati. Ora në të cilën përgjigja është përditësuar për herë të fundit në formatin ISO 8601 (YYYY-MM-DDThh:mm:ssZ).

varg roli (opsional)

Vetëm rezultati. Roli i ndërveprimit.

vargu i udhëzimit_të_sistem-it (opsional)

Udhëzime sistemi për bashkëveprimin.

mjete Mjet (opsional)

Një listë e deklarimeve të mjeteve që modeli mund të thërrasë gjatë ndërveprimit.

Një mjet që mund të përdoret nga modeli.

Llojet e mundshme

Diskriminuesi polimorfik: type

Funksioni

Një mjet që mund të përdoret nga modeli.

lloji i objektit (i detyrueshëm)

Nuk është dhënë përshkrim.

Gjithmonë i vendosur në "function" .

varg emri (opsional)

Emri i funksionit.

varg përshkrimi (opsional)

Një përshkrim i funksionit.

objekt parametrash (opsional)

Skema JSON për parametrat e funksionit.

Ekzekutimi i Kodit

Një mjet që mund të përdoret nga modeli për të ekzekutuar kodin.

lloji i objektit (i detyrueshëm)

Nuk është dhënë përshkrim.

Gjithmonë i vendosur në "code_execution" .

Konteksti i Url-it

Një mjet që mund të përdoret nga modeli për të marrë kontekstin e URL-së.

lloji i objektit (i detyrueshëm)

Nuk është dhënë përshkrim.

Gjithmonë i vendosur në "url_context" .

Përdorimi i Kompjuterit

Një mjet që mund të përdoret nga modeli për të bashkëvepruar me kompjuterin.

lloji i objektit (i detyrueshëm)

Nuk është dhënë përshkrim.

Gjithmonë i vendosur në "computer_use" .

enum i mjedisit (string) (opsionale)

Mjedisi që operohet.

Vlerat e mundshme:

  • browser
vargu i funksioneve_të_paracaktuara_të_përjashtuara (varg) (opsional)

Lista e funksioneve të paracaktuara që përjashtohen nga thirrja e modelit.

McpServer

Një MCPServer është një server që mund të thirret nga modeli për të kryer veprime.

lloji i objektit (i detyrueshëm)

Nuk është dhënë përshkrim.

Gjithmonë i vendosur në "mcp_server" .

varg emri (opsional)

Emri i MCPServer-it.

vargu i url- së (opsional)

URL-ja e plotë për pikën fundore të MCPServer. Shembull: "https://api.example.com/mcp"

objekti i headers (opsional)

Opsionale: Fushat për titujt e vërtetimit, afatet kohore, etj., nëse është e nevojshme.

allowed_tools Mjetet e Lejuara (opsionale)

Mjetet e lejuara.

Konfigurimi për mjetet e lejuara.

Fushat

modaliteti ToolChoiceType (opsionale)

Mënyra e zgjedhjes së mjetit.

Vlerat e mundshme:

  • auto
  • any
  • none
  • validated

varg mjetesh (varg) (opsional)

Emrat e mjeteve të lejuara.

Kërkimi në Google

Një mjet që mund të përdoret nga modeli për të kërkuar në Google.

lloji i objektit (i detyrueshëm)

Nuk është dhënë përshkrim.

Gjithmonë i vendosur në "google_search" .

vargu search_types (enum (string)) (opsional)

Llojet e tokëzimit të kërkimit që duhen aktivizuar.

Vlerat e mundshme:

  • web_search
  • image_search
  • enterprise_web_search
Kërkimi i skedarëve

Një mjet që mund të përdoret nga modeli për të kërkuar skedarë.

lloji i objektit (i detyrueshëm)

Nuk është dhënë përshkrim.

Gjithmonë i vendosur në "file_search" .

vargu file_search_store_names (string) (opsional)

Kërkimi i skedarëve ruan emrat që duhen kërkuar.

numër i plotë top_k (opsional)

Numri i pjesëve të rikthimit semantik që duhen rikuperuar.

vargu i filtrit_të_metadata- ve (opsional)

Filtri i meta të dhënave për t'u aplikuar në dokumentet dhe pjesët e rikthimit semantik.

GoogleMaps

Një mjet që mund të përdoret nga modeli për të thirrur Google Maps.

lloji i objektit (i detyrueshëm)

Nuk është dhënë përshkrim.

Gjithmonë i vendosur në "google_maps" .

enable_widget boolean (opsionale)

Nëse duhet të kthehet një shenjë konteksti e widget-it në rezultatin e thirrjes së mjetit të përgjigjes.

numri i gjerësisë gjeografike (opsional)

Gjerësia gjeografike e vendndodhjes së përdoruesit.

numri i gjatësisë gjeografike (opsional)

Gjatësia gjeografike e vendndodhjes së përdoruesit.

Rikthim

Një mjet që mund të përdoret nga modeli për të rikuperuar skedarët.

lloji i objektit (i detyrueshëm)

Nuk është dhënë përshkrim.

Gjithmonë i vendosur në "retrieval" .

retrieval_types matrica (enum (string)) (opsionale)

Llojet e rikthimit të skedarëve që duhen aktivizuar.

Vlerat e mundshme:

  • vertex_ai_search
vertex_ai_search_config VertexAISearchConfig (opsionale)

Përdoret për të specifikuar konfigurimin për VertexAISearch.

Përdoret për të specifikuar konfigurimin për VertexAISearch.

Fushat

varg motori (opsional)

Opsionale. Përdoret për të specifikuar motorin e kërkimit Vertex AI.

vargu i datastores (string) (opsional)

Opsionale. Përdoret për të specifikuar të dhënat e Vertex AI Search.

Përdorimi Përdorimi (opsional)

Vetëm rezultate. Statistikat mbi përdorimin e tokenit të kërkesës së ndërveprimit.

Statistikat mbi përdorimin e tokenit të kërkesës së ndërveprimit.

Fushat

total_input_tokens numër i plotë (opsional)

Numri i tokenëve në kërkesë (konteksti).

input_tokens_by_modality ModalityTokens (opsionale)

Një ndarje e përdorimit të tokenit të hyrjes sipas modalitetit.

Numërimi i tokenëve për një modalitet të vetëm përgjigjeje.

Fushat

modaliteti ResponseModality (opsionale)

Modaliteti i lidhur me numërimin e tokenëve.

Vlerat e mundshme:

  • text
  • image
  • audio
  • video
  • document

numër i plotë i tokenëve (opsionale)

Numri i tokenëve për modalitetin.

total_cached_tokens numër i plotë (opsional)

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

cached_tokens_by_modality ModalityTokens (opsionale)

Një ndarje e përdorimit të tokenëve të ruajtur në memorje sipas modalitetit.

Numërimi i tokenëve për një modalitet të vetëm përgjigjeje.

Fushat

modaliteti ResponseModality (opsionale)

Modaliteti i lidhur me numërimin e tokenëve.

Vlerat e mundshme:

  • text
  • image
  • audio
  • video
  • document

numër i plotë i tokenëve (opsionale)

Numri i tokenëve për modalitetin.

total_output_tokens numër i plotë (opsional)

Numri total i tokenëve në të gjitha përgjigjet e gjeneruara.

output_tokens_by_modality ModalityTokens (opsionale)

Një ndarje e përdorimit të tokenit të daljes sipas modalitetit.

Numërimi i tokenëve për një modalitet të vetëm përgjigjeje.

Fushat

modaliteti ResponseModality (opsionale)

Modaliteti i lidhur me numërimin e tokenëve.

Vlerat e mundshme:

  • text
  • image
  • audio
  • video
  • document

numër i plotë i tokenëve (opsionale)

Numri i tokenëve për modalitetin.

total_tool_use_tokens numër i plotë (opsional)

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

tool_use_tokens_by_modality ModalityTokens (opsionale)

Një ndarje e përdorimit të tokenëve të përdorimit të mjeteve sipas modalitetit.

Numërimi i tokenëve për një modalitet të vetëm përgjigjeje.

Fushat

modaliteti ResponseModality (opsionale)

Modaliteti i lidhur me numërimin e tokenëve.

Vlerat e mundshme:

  • text
  • image
  • audio
  • video
  • document

numër i plotë i tokenëve (opsionale)

Numri i tokenëve për modalitetin.

total_thought_tokens numër i plotë (opsional)

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

total_tokens numër i plotë (opsional)

Numri total i tokenëve për kërkesën e ndërveprimit (kërkesa + përgjigjet + tokenët e tjerë të brendshëm).

grounding_tool_count GroundingToolCount (opsionale)

Numri i mjeteve të tokëzimit.

Numri i mjeteve të tokëzimit numërohet.

Fushat

tipi enum (string) (opsionale)

Lloji i mjetit të tokëzimit i lidhur me numërimin.

Vlerat e mundshme:

  • google_search
  • google_maps
  • retrieval
numër i plotë (opsional)

Numri i mjeteve të tokëzimit numërohet.

response_modalities ResponseModality (opsionale)

Modalitetet e kërkuara të përgjigjes (TEKSTI, IMAZHI, AUDIO).

Vlerat e mundshme:

  • text
  • image
  • audio
  • video
  • document

vargu i tipit të përgjigjes_mime (opsional)

Lloji mime i përgjigjes. Kjo kërkohet nëse është vendosur response_format.

vargu previous_interaction_id (opsional)

ID-ja e ndërveprimit të mëparshëm, nëse ka.

niveli_i_shërbimit Niveli_i_Shërbimit (opsional)

Niveli i shërbimit për bashkëveprimin.

Vlerat e mundshme:

  • flex
  • standard
  • priority

webhook_config WebhookConfig (opsionale)

Opsionale. Konfigurimi i Webhook për marrjen e njoftimeve kur ndërveprimi përfundon.

Mesazh për konfigurimin e ngjarjeve të webhook për një kërkesë.

Fushat

vargu uris (string) (opsional)

Opsionale. Nëse caktohet, këto URI të webhook-ut do të përdoren për ngjarjet e webhook-ut në vend të webhook-ut të regjistruar.

objekti user_metadata (opsional)

Opsionale. Meta të dhënat e përdoruesit që do të kthehen në çdo transmetim ngjarjeje te webhook-et.

hapat Hapi (opsional)

Vetëm rezultati. Hapat që përbëjnë bashkëveprimin.

Një hap në bashkëveprim.

Llojet e mundshme

Diskriminuesi polimorfik: type

Hapi i Hyrjes së Përdoruesit

Të dhëna të dhëna nga përdoruesi.

lloji i objektit (i detyrueshëm)

Nuk është dhënë përshkrim.

Gjithmonë i vendosur në "user_input" .

Përmbajtja Përmbajtja (opsionale)

Nuk është dhënë përshkrim.

Përmbajtja e përgjigjes.

Llojet e mundshme

Diskriminuesi polimorfik: type

Përmbajtje Teksti

Një bllok përmbajtjeje teksti.

lloji i objektit (i detyrueshëm)

Nuk është dhënë përshkrim.

Gjithmonë i vendosur në "text" .

varg teksti (i detyrueshëm)

E detyrueshme. Përmbajtja e tekstit.

shënime Shënim (opsional)

Informacion mbi citimin për përmbajtjen e gjeneruar nga modeli.

Informacion mbi citimin për përmbajtjen e gjeneruar nga modeli.

Llojet e mundshme

Diskriminuesi polimorfik: type

Citimi i Url-it

Një shënim citimi URL-je.

lloji i objektit (i detyrueshëm)

Nuk është dhënë përshkrim.

Gjithmonë i vendosur në "url_citation" .

vargu i url- së (opsional)

URL-ja.

vargu i titullit (opsional)

Titulli i URL-së.

numër i plotë i indeksit_fillues (opsional)

Fillimi i segmentit të përgjigjes që i atribuohet këtij burimi. Indeksi tregon fillimin e segmentit, i matur në bajt.

numër i plotë end_index (opsional)

Fundi i segmentit të atribuuar, ekskluziv.

FileCitation

Një shënim citimi i skedarit.

lloji i objektit (i detyrueshëm)

Nuk është dhënë përshkrim.

Gjithmonë i vendosur në "file_citation" .

vargu document_uri (opsional)

URI-ja e skedarit.

vargu i emrit të skedarit (opsional)

Emri i skedarit.

vargu burimor (opsional)

Burimi i atribuuar për një pjesë të tekstit.

objekti custom_metadata (opsional)

Përdoruesi dha meta të dhëna rreth kontekstit të marrë.

numër i plotë i faqes (opsional)

Numri i faqes së dokumentit të cituar, nëse ka.

vargu media_id (opsional)

ID e medias në rast të citimeve të imazheve, nëse ka.

numër i plotë i indeksit_fillues (opsional)

Fillimi i segmentit të përgjigjes që i atribuohet këtij burimi. Indeksi tregon fillimin e segmentit, i matur në bajt.

numër i plotë end_index (opsional)

Fundi i segmentit të atribuuar, ekskluziv.

Citimi i Vendit

Një shënim citimi vendi.

lloji i objektit (i detyrueshëm)

Nuk është dhënë përshkrim.

Gjithmonë i vendosur në "place_citation" .

vargu place_id (opsional)

ID-ja e vendit, në formatin `places/{place_id}`.

varg emri (opsional)

Titulli i vendit.

vargu i url- së (opsional)

Referenca URI e vendit.

review_snippets ReviewSnippet (opsionale)

Fragmente të vlerësimeve që përdoren për të gjeneruar përgjigje rreth karakteristikave të një vendi të caktuar në Google Maps.

Përmban një fragment të një vlerësimi përdoruesi që përgjigjet një pyetjeje në lidhje me veçoritë e një vendi specifik në Google Maps.

Fushat

vargu i titullit (opsional)

Titulli i rishikimit.

vargu i url- së (opsional)

Një lidhje që korrespondon me vlerësimin e përdoruesit në Google Maps.

vargu review_id (opsional)

ID-ja e fragmentit të rishikimit.

numër i plotë i indeksit_fillues (opsional)

Fillimi i segmentit të përgjigjes që i atribuohet këtij burimi. Indeksi tregon fillimin e segmentit, i matur në bajt.

numër i plotë end_index (opsional)

Fundi i segmentit të atribuuar, ekskluziv.

Përmbajtje Imazhesh

Një bllok përmbajtjeje imazhi.

lloji i objektit (i detyrueshëm)

Nuk është dhënë përshkrim.

Gjithmonë i vendosur në "image" .

varg të dhënash (opsionale)

Përmbajtja e imazhit.

vargu uri (opsional)

URI-ja e imazhit.

mime_type enum (string) (opsionale)

Lloji i mimikës së imazhit.

Vlerat e mundshme:

  • image/png
  • image/jpeg
  • image/webp
  • image/heic
  • image/heif
  • image/gif
  • image/bmp
  • image/tiff
rezolucioni i MediaResolution (opsional)

Zgjidhja e mediave.

Vlerat e mundshme:

  • low
  • medium
  • high
  • ultra_high

Përmbajtje Audio

Një bllok përmbajtjeje audio.

lloji i objektit (i detyrueshëm)

Nuk është dhënë përshkrim.

Gjithmonë i vendosur në "audio" .

varg të dhënash (opsionale)

Përmbajtja audio.

vargu uri (opsional)

URI-ja e audios.

mime_type enum (string) (opsionale)

Lloji i mimikës i audios.

Vlerat e mundshme:

  • audio/wav
  • audio/mp3
  • audio/aiff
  • audio/aac
  • audio/ogg
  • audio/flac
  • audio/mpeg
  • audio/m4a
  • audio/l16
  • audio/opus
  • audio/alaw
  • audio/mulaw
numër i plotë i kanaleve (opsionale)

Numri i kanaleve audio.

numër i plotë i shkallës së_sample-it (opsional)

Shpejtësia e mostrës së audios.

Përmbajtja e Dokumentit

Një bllok përmbajtjeje dokumenti.

lloji i objektit (i detyrueshëm)

Nuk është dhënë përshkrim.

Gjithmonë i vendosur në "document" .

varg të dhënash (opsionale)

Përmbajtja e dokumentit.

vargu uri (opsional)

URI-ja e dokumentit.

mime_type enum (string) (opsionale)

Lloji mime i dokumentit.

Vlerat e mundshme:

  • application/pdf
Përmbajtje Video

Një bllok përmbajtjeje video.

lloji i objektit (i detyrueshëm)

Nuk është dhënë përshkrim.

Gjithmonë i vendosur në "video" .

varg të dhënash (opsionale)

Përmbajtja e videos.

vargu uri (opsional)

URI-ja e videos.

mime_type enum (string) (opsionale)

Lloji i mimikës së videos.

Vlerat e mundshme:

  • video/mp4
  • video/mpeg
  • video/mpg
  • video/mov
  • video/avi
  • video/x-flv
  • video/webm
  • video/wmv
  • video/3gpp
rezolucioni i MediaResolution (opsional)

Zgjidhja e mediave.

Vlerat e mundshme:

  • low
  • medium
  • high
  • ultra_high

Hapi i Prodhimit të Modelit

Rezultati i gjeneruar nga modeli.

lloji i objektit (i detyrueshëm)

Nuk është dhënë përshkrim.

Gjithmonë i vendosur në "model_output" .

Përmbajtja Përmbajtja (opsionale)

Nuk është dhënë përshkrim.

Përmbajtja e përgjigjes.

Llojet e mundshme

Diskriminuesi polimorfik: type

Përmbajtje Teksti

Një bllok përmbajtjeje teksti.

lloji i objektit (i detyrueshëm)

Nuk është dhënë përshkrim.

Gjithmonë i vendosur në "text" .

varg teksti (i detyrueshëm)

E detyrueshme. Përmbajtja e tekstit.

shënime Shënim (opsional)

Informacion mbi citimin për përmbajtjen e gjeneruar nga modeli.

Informacion mbi citimin për përmbajtjen e gjeneruar nga modeli.

Llojet e mundshme

Diskriminuesi polimorfik: type

Citimi i Url-it

Një shënim citimi URL-je.

lloji i objektit (i detyrueshëm)

Nuk është dhënë përshkrim.

Gjithmonë i vendosur në "url_citation" .

vargu i url- së (opsional)

URL-ja.

vargu i titullit (opsional)

Titulli i URL-së.

numër i plotë i indeksit_fillues (opsional)

Fillimi i segmentit të përgjigjes që i atribuohet këtij burimi. Indeksi tregon fillimin e segmentit, i matur në bajt.

numër i plotë end_index (opsional)

Fundi i segmentit të atribuuar, ekskluziv.

FileCitation

Një shënim citimi i skedarit.

lloji i objektit (i detyrueshëm)

Nuk është dhënë përshkrim.

Gjithmonë i vendosur në "file_citation" .

vargu document_uri (opsional)

URI-ja e skedarit.

vargu i emrit të skedarit (opsional)

Emri i skedarit.

vargu burimor (opsional)

Burimi i atribuuar për një pjesë të tekstit.

objekti custom_metadata (opsional)

Përdoruesi dha meta të dhëna rreth kontekstit të marrë.

numër i plotë i faqes (opsional)

Numri i faqes së dokumentit të cituar, nëse ka.

vargu media_id (opsional)

ID e medias në rast të citimeve të imazheve, nëse ka.

numër i plotë i indeksit_fillues (opsional)

Fillimi i segmentit të përgjigjes që i atribuohet këtij burimi. Indeksi tregon fillimin e segmentit, i matur në bajt.

numër i plotë end_index (opsional)

Fundi i segmentit të atribuuar, ekskluziv.

Citimi i Vendit

Një shënim citimi vendi.

lloji i objektit (i detyrueshëm)

Nuk është dhënë përshkrim.

Gjithmonë i vendosur në "place_citation" .

vargu place_id (opsional)

ID-ja e vendit, në formatin `places/{place_id}`.

varg emri (opsional)

Titulli i vendit.

vargu i url- së (opsional)

Referenca URI e vendit.

review_snippets ReviewSnippet (opsionale)

Fragmente të vlerësimeve që përdoren për të gjeneruar përgjigje rreth karakteristikave të një vendi të caktuar në Google Maps.

Përmban një fragment të një vlerësimi përdoruesi që përgjigjet një pyetjeje në lidhje me veçoritë e një vendi specifik në Google Maps.

Fushat

vargu i titullit (opsional)

Titulli i rishikimit.

vargu i url- së (opsional)

Një lidhje që korrespondon me vlerësimin e përdoruesit në Google Maps.

vargu review_id (opsional)

ID-ja e fragmentit të rishikimit.

numër i plotë i indeksit_fillues (opsional)

Fillimi i segmentit të përgjigjes që i atribuohet këtij burimi. Indeksi tregon fillimin e segmentit, i matur në bajt.

numër i plotë end_index (opsional)

Fundi i segmentit të atribuuar, ekskluziv.

Përmbajtje Imazhesh

Një bllok përmbajtjeje imazhi.

lloji i objektit (i detyrueshëm)

Nuk është dhënë përshkrim.

Gjithmonë i vendosur në "image" .

varg të dhënash (opsionale)

Përmbajtja e imazhit.

vargu uri (opsional)

URI-ja e imazhit.

mime_type enum (string) (opsionale)

Lloji i mimikës së imazhit.

Vlerat e mundshme:

  • image/png
  • image/jpeg
  • image/webp
  • image/heic
  • image/heif
  • image/gif
  • image/bmp
  • image/tiff
rezolucioni i MediaResolution (opsional)

Zgjidhja e mediave.

Vlerat e mundshme:

  • low
  • medium
  • high
  • ultra_high

Përmbajtje Audio

Një bllok përmbajtjeje audio.

lloji i objektit (i detyrueshëm)

Nuk është dhënë përshkrim.

Gjithmonë i vendosur në "audio" .

varg të dhënash (opsionale)

Përmbajtja audio.

vargu uri (opsional)

URI-ja e audios.

mime_type enum (string) (opsionale)

Lloji i mimikës i audios.

Vlerat e mundshme:

  • audio/wav
  • audio/mp3
  • audio/aiff
  • audio/aac
  • audio/ogg
  • audio/flac
  • audio/mpeg
  • audio/m4a
  • audio/l16
  • audio/opus
  • audio/alaw
  • audio/mulaw
numër i plotë i kanaleve (opsionale)

Numri i kanaleve audio.

numër i plotë i shkallës së_sample-it (opsional)

Shpejtësia e mostrës së audios.

Përmbajtja e Dokumentit

Një bllok përmbajtjeje dokumenti.

lloji i objektit (i detyrueshëm)

Nuk është dhënë përshkrim.

Gjithmonë i vendosur në "document" .

varg të dhënash (opsionale)

Përmbajtja e dokumentit.

vargu uri (opsional)

URI-ja e dokumentit.

mime_type enum (string) (opsionale)

Lloji mime i dokumentit.

Vlerat e mundshme:

  • application/pdf
Përmbajtje Video

Një bllok përmbajtjeje video.

lloji i objektit (i detyrueshëm)

Nuk është dhënë përshkrim.

Gjithmonë i vendosur në "video" .

varg të dhënash (opsionale)

Përmbajtja e videos.

vargu uri (opsional)

URI-ja e videos.

mime_type enum (string) (opsionale)

Lloji i mimikës së videos.

Vlerat e mundshme:

  • video/mp4
  • video/mpeg
  • video/mpg
  • video/mov
  • video/avi
  • video/x-flv
  • video/webm
  • video/wmv
  • video/3gpp
rezolucioni i MediaResolution (opsional)

Zgjidhja e mediave.

Vlerat e mundshme:

  • low
  • medium
  • high
  • ultra_high

ThoughtStep

Një hap i menduar.

lloji i objektit (i detyrueshëm)

Nuk është dhënë përshkrim.

Gjithmonë i vendosur në "thought" .

varg nënshkrimi (opsional)

Një hash nënshkrimi për validimin e backend-it.

përmbledhje ThoughtSummaryContent (opsionale)

Një përmbledhje e mendimit.

Llojet e mundshme

Diskriminuesi polimorfik: type

Përmbajtje Teksti

Një bllok përmbajtjeje teksti.

lloji i objektit (i detyrueshëm)

Nuk është dhënë përshkrim.

Gjithmonë i vendosur në "text" .

varg teksti (i detyrueshëm)

E detyrueshme. Përmbajtja e tekstit.

shënime Shënim (opsional)

Informacion mbi citimin për përmbajtjen e gjeneruar nga modeli.

Informacion mbi citimin për përmbajtjen e gjeneruar nga modeli.

Llojet e mundshme

Diskriminuesi polimorfik: type

Citimi i Url-it

Një shënim citimi URL-je.

lloji i objektit (i detyrueshëm)

Nuk është dhënë përshkrim.

Gjithmonë i vendosur në "url_citation" .

vargu i url- së (opsional)

URL-ja.

vargu i titullit (opsional)

Titulli i URL-së.

numër i plotë i indeksit_fillues (opsional)

Fillimi i segmentit të përgjigjes që i atribuohet këtij burimi. Indeksi tregon fillimin e segmentit, i matur në bajt.

numër i plotë end_index (opsional)

Fundi i segmentit të atribuuar, ekskluziv.

FileCitation

Një shënim citimi i skedarit.

lloji i objektit (i detyrueshëm)

Nuk është dhënë përshkrim.

Gjithmonë i vendosur në "file_citation" .

vargu document_uri (opsional)

URI-ja e skedarit.

vargu i emrit të skedarit (opsional)

Emri i skedarit.

vargu burimor (opsional)

Burimi i atribuuar për një pjesë të tekstit.

objekti custom_metadata (opsional)

Përdoruesi dha meta të dhëna rreth kontekstit të marrë.

numër i plotë i faqes (opsional)

Numri i faqes së dokumentit të cituar, nëse ka.

vargu media_id (opsional)

ID e medias në rast të citimeve të imazheve, nëse ka.

numër i plotë i indeksit_fillues (opsional)

Fillimi i segmentit të përgjigjes që i atribuohet këtij burimi. Indeksi tregon fillimin e segmentit, i matur në bajt.

numër i plotë end_index (opsional)

Fundi i segmentit të atribuuar, ekskluziv.

Citimi i Vendit

Një shënim citimi vendi.

lloji i objektit (i detyrueshëm)

Nuk është dhënë përshkrim.

Gjithmonë i vendosur në "place_citation" .

vargu place_id (opsional)

ID-ja e vendit, në formatin `places/{place_id}`.

varg emri (opsional)

Titulli i vendit.

vargu i url- së (opsional)

Referenca URI e vendit.

review_snippets ReviewSnippet (opsionale)

Fragmente të vlerësimeve që përdoren për të gjeneruar përgjigje rreth karakteristikave të një vendi të caktuar në Google Maps.

Përmban një fragment të një vlerësimi përdoruesi që përgjigjet një pyetjeje në lidhje me veçoritë e një vendi specifik në Google Maps.

Fushat

vargu i titullit (opsional)

Titulli i rishikimit.

vargu i url- së (opsional)

Një lidhje që korrespondon me vlerësimin e përdoruesit në Google Maps.

vargu review_id (opsional)

ID-ja e fragmentit të rishikimit.

numër i plotë i indeksit_fillues (opsional)

Fillimi i segmentit të përgjigjes që i atribuohet këtij burimi. Indeksi tregon fillimin e segmentit, i matur në bajt.

numër i plotë end_index (opsional)

Fundi i segmentit të atribuuar, ekskluziv.

Përmbajtje Imazhesh

Një bllok përmbajtjeje imazhi.

lloji i objektit (i detyrueshëm)

Nuk është dhënë përshkrim.

Gjithmonë i vendosur në "image" .

varg të dhënash (opsionale)

Përmbajtja e imazhit.

vargu uri (opsional)

URI-ja e imazhit.

mime_type enum (string) (opsionale)

Lloji i mimikës së imazhit.

Vlerat e mundshme:

  • image/png
  • image/jpeg
  • image/webp
  • image/heic
  • image/heif
  • image/gif
  • image/bmp
  • image/tiff
rezolucioni i MediaResolution (opsional)

Zgjidhja e mediave.

Vlerat e mundshme:

  • low
  • medium
  • high
  • ultra_high

Hapi i Thirrjes së Funksionit

Një hap i thirrjes së mjetit të funksionit.

lloji i objektit (i detyrueshëm)

Nuk është dhënë përshkrim.

Gjithmonë i vendosur në "function_call" .

varg emri (i detyrueshëm)

Required. The name of the tool to call.

arguments object (required)

Required. The arguments to pass to the function.

id string (required)

Required. A unique ID for this specific tool call.

signature string (optional)

A signature hash for backend validation.

CodeExecutionCallStep

Code execution call step.

type object (required)

No description provided.

Always set to "code_execution_call" .

arguments CodeExecutionCallStepArguments (required)

Required. The arguments to pass to the code execution.

The arguments to pass to the code execution.

Fushat

language enum (string) (optional)

Programming language of the `code`.

Possible values:

  • python
code string (optional)

The code to be executed.

id string (required)

Required. A unique ID for this specific tool call.

signature string (optional)

A signature hash for backend validation.

UrlContextCallStep

URL context call step.

type object (required)

No description provided.

Always set to "url_context_call" .

arguments UrlContextCallStepArguments (required)

Required. The arguments to pass to the URL context.

The arguments to pass to the URL context.

Fushat

urls array (string) (optional)

The URLs to fetch.

id string (required)

Required. A unique ID for this specific tool call.

signature string (optional)

A signature hash for backend validation.

McpServerToolCallStep

MCPServer tool call step.

type object (required)

No description provided.

Always set to "mcp_server_tool_call" .

name string (required)

Required. The name of the tool which was called.

server_name string (required)

Required. The name of the used MCP server.

arguments object (required)

Required. The JSON object of arguments for the function.

id string (required)

Required. A unique ID for this specific tool call.

signature string (optional)

A signature hash for backend validation.

GoogleSearchCallStep

Google Search call step.

type object (required)

No description provided.

Always set to "google_search_call" .

arguments GoogleSearchCallStepArguments (required)

Required. The arguments to pass to Google Search.

The arguments to pass to Google Search.

Fushat

queries array (string) (optional)

Web search queries for the following-up web search.

search_type enum (string) (optional)

The type of search grounding enabled.

Possible values:

  • web_search
  • image_search
  • enterprise_web_search
id string (required)

Required. A unique ID for this specific tool call.

signature string (optional)

A signature hash for backend validation.

FileSearchCallStep

File Search call step.

type object (required)

No description provided.

Always set to "file_search_call" .

id string (required)

Required. A unique ID for this specific tool call.

signature string (optional)

A signature hash for backend validation.

GoogleMapsCallStep

Google Maps call step.

type object (required)

No description provided.

Always set to "google_maps_call" .

arguments GoogleMapsCallStepArguments (optional)

The arguments to pass to the Google Maps tool.

The arguments to pass to the Google Maps tool.

Fushat

queries array (string) (optional)

The queries to be executed.

id string (required)

Required. A unique ID for this specific tool call.

signature string (optional)

A signature hash for backend validation.

FunctionResultStep

Result of a function tool call.

type object (required)

No description provided.

Always set to "function_result" .

name string (optional)

The name of the tool that was called.

is_error boolean (optional)

Whether the tool call resulted in an error.

call_id string (required)

Required. ID to match the ID from the function call block.

signature string (optional)

A signature hash for backend validation.

result array ( FunctionResultSubcontent ) or string (required)

The result of the tool call.

CodeExecutionResultStep

Code execution result step.

type object (required)

No description provided.

Always set to "code_execution_result" .

result string (required)

Required. The output of the code execution.

is_error boolean (optional)

Whether the code execution resulted in an error.

call_id string (required)

Required. ID to match the ID from the function call block.

signature string (optional)

A signature hash for backend validation.

UrlContextResultStep

URL context result step.

type object (required)

No description provided.

Always set to "url_context_result" .

result UrlContextResultItem (required)

Required. The results of the URL context.

The result of the URL context.

Fushat

url string (optional)

The URL that was fetched.

status enum (string) (optional)

The status of the URL retrieval.

Possible values:

  • success
  • error
  • paywall
  • unsafe
is_error boolean (optional)

Whether the URL context resulted in an error.

call_id string (required)

Required. ID to match the ID from the function call block.

signature string (optional)

A signature hash for backend validation.

GoogleSearchResultStep

Google Search result step.

type object (required)

No description provided.

Always set to "google_search_result" .

result GoogleSearchResultItem (required)

Required. The results of the Google Search.

The result of the Google Search.

Fushat

search_suggestions string (optional)

Web content snippet that can be embedded in a web page or an app webview.

is_error boolean (optional)

Whether the Google Search resulted in an error.

call_id string (required)

Required. ID to match the ID from the function call block.

signature string (optional)

A signature hash for backend validation.

McpServerToolResultStep

MCPServer tool result step.

type object (required)

No description provided.

Always set to "mcp_server_tool_result" .

name string (optional)

Name of the tool which is called for this specific tool call.

server_name string (optional)

The name of the used MCP server.

call_id string (required)

Required. ID to match the ID from the function call block.

signature string (optional)

A signature hash for backend validation.

result array ( FunctionResultSubcontent ) or string (required)

The output from the MCP server call. Can be simple text or rich content.

FileSearchResultStep

File Search result step.

type object (required)

No description provided.

Always set to "file_search_result" .

call_id string (required)

Required. ID to match the ID from the function call block.

signature string (optional)

A signature hash for backend validation.

GoogleMapsResultStep

Google Maps result step.

type object (required)

No description provided.

Always set to "google_maps_result" .

result GoogleMapsResultItem (required)

No description provided.

The result of the Google Maps.

Fushat

places GoogleMapsResultPlaces (optional)

No description provided.

Fushat

place_id string (optional)

No description provided.

name string (optional)

No description provided.

url string (optional)

No description provided.

review_snippets ReviewSnippet (optional)

No description provided.

Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps.

Fushat

title string (optional)

Title of the review.

url string (optional)

A link that corresponds to the user review on Google Maps.

review_id string (optional)

The ID of the review snippet.

widget_context_token string (optional)

No description provided.

call_id string (required)

Required. ID to match the ID from the function call block.

signature string (optional)

A signature hash for backend validation.

input Content or array ( Content ) or array ( Step ) or string (optional)

The input for the interaction.

response_format ResponseFormat or ResponseFormatList (optional)

Enforces that the generated response is a JSON object that complies with the JSON schema specified in this field.

agent_config object (optional)

Configuration parameters for the agent interaction.

Possible Types

Polymorphic discriminator: type

DynamicAgentConfig

Configuration for dynamic agents.

type object (required)

No description provided.

Always set to "dynamic" .

DeepResearchAgentConfig

Configuration for the Deep Research agent.

type object (required)

No description provided.

Always set to "deep-research" .

thinking_summaries ThinkingSummaries (optional)

Whether to include thought summaries in the response.

Possible values:

  • auto
  • none

visualization enum (string) (optional)

Whether to include visualizations in the response.

Possible values:

  • off
  • auto
collaborative_planning boolean (optional)

Enables human-in-the-loop planning for the Deep Research agent. If set to true, the Deep Research agent will provide a research plan in its response. The agent will then proceed only if the user confirms the plan in the next turn.

event_id string (optional)

The event_id token to be used to resume the interaction stream, from this event.

InteractionCompletedEvent

event_type object (required)

No description provided.

Always set to "interaction.completed" .

interaction Interaction (required)

Required. The completed interaction with empty outputs to reduce the payload size. Use the preceding ContentDelta events for the actual output.

The Interaction resource.

Fushat

model ModelOption (optional)

The name of the `Model` used for generating the interaction.

Possible values:

  • gemini-2.5-computer-use-preview-10-2025

    An agentic capability model designed for direct interface interaction, allowing Gemini to perceive and navigate digital environments.

  • gemini-2.5-flash

    Our first hybrid reasoning model which supports a 1M token context window and has thinking budgets.

  • gemini-2.5-flash-image

    Our native image generation model, optimized for speed, flexibility, and contextual understanding. Text input and output is priced the same as 2.5 Flash.

  • gemini-2.5-flash-lite

    Our smallest and most cost effective model, built for at scale usage.

  • gemini-2.5-flash-lite-preview-09-2025

    The latest model based on Gemini 2.5 Flash lite optimized for cost-efficiency, high throughput and high quality.

  • gemini-2.5-flash-native-audio-preview-12-2025

    Our native audio models optimized for higher quality audio outputs with better pacing, voice naturalness, verbosity, and mood.

  • gemini-2.5-flash-preview-09-2025

    The latest model based on the 2.5 Flash model. 2.5 Flash Preview is best for large scale processing, low-latency, high volume tasks that require thinking, and agentic use cases.

  • gemini-2.5-flash-preview-tts

    Our 2.5 Flash text-to-speech model optimized for powerful, low-latency controllable speech generation.

  • gemini-2.5-pro

    Our state-of-the-art multipurpose model, which excels at coding and complex reasoning tasks.

  • gemini-2.5-pro-preview-tts

    Our 2.5 Pro text-to-speech audio model optimized for powerful, low-latency speech generation for more natural outputs and easier to steer prompts.

  • gemini-3-flash-preview

    Our most intelligent model built for speed, combining frontier intelligence with superior search and grounding.

  • gemini-3-pro-image-preview

    State-of-the-art image generation and editing model.

  • gemini-3-pro-preview

    Our most intelligent model with SOTA reasoning and multimodal understanding, and powerful agentic and vibe coding capabilities.

  • gemini-3.1-pro-preview

    Our latest SOTA reasoning model with unprecedented depth and nuance, and powerful multimodal understanding and coding capabilities.

  • gemini-3.1-flash-image-preview

    Pro-level visual intelligence with Flash-speed efficiency and reality-grounded generation capabilities.

  • gemini-3.1-flash-lite-preview

    Our most cost-efficient model, optimized for high-volume agentic tasks, translation, and simple data processing.

  • gemini-3.1-flash-tts-preview

    Gemini 3.1 Flash TTS: Powerful, low-latency speech generation. Enjoy natural outputs, steerable prompts, and new expressive audio tags for precise narration control.

  • lyria-3-clip-preview

    Our low-latency, music generation model optimized for high-fidelity audio clips and precise rhythmic control.

  • lyria-3-pro-preview

    Our advanced, full-song generative model with deep compositional understanding, optimized for precise structural control and complex transitions across diverse musical styles.

The model that will complete your prompt.\n\nSee [models](https://ai.google.dev/gemini-api/docs/models) for additional details.

agent AgentOption (optional)

The name of the `Agent` used for generating the interaction.

Possible values:

  • deep-research-pro-preview-12-2025

    Gemini Deep Research Agent

  • deep-research-preview-04-2026

    Gemini Deep Research Agent

  • deep-research-max-preview-04-2026

    Gemini Deep Research Max Agent

The agent to interact with.

id string (optional)

Required. Output only. A unique identifier for the interaction completion.

status enum (string) (optional)

Required. Output only. The status of the interaction.

Possible values:

  • in_progress
  • requires_action
  • completed
  • failed
  • cancelled
  • incomplete
created string (optional)

Required. Output only. The time at which the response was created in ISO 8601 format (YYYY-MM-DDThh:mm:ssZ).

updated string (optional)

Required. Output only. The time at which the response was last updated in ISO 8601 format (YYYY-MM-DDThh:mm:ssZ).

role string (optional)

Output only. The role of the interaction.

system_instruction string (optional)

System instruction for the interaction.

tools Tool (optional)

A list of tool declarations the model may call during interaction.

A tool that can be used by the model.

Possible Types

Polymorphic discriminator: type

Funksioni

A tool that can be used by the model.

type object (required)

No description provided.

Always set to "function" .

name string (optional)

The name of the function.

description string (optional)

A description of the function.

parameters object (optional)

The JSON Schema for the function's parameters.

CodeExecution

A tool that can be used by the model to execute code.

type object (required)

No description provided.

Always set to "code_execution" .

UrlContext

A tool that can be used by the model to fetch URL context.

type object (required)

No description provided.

Always set to "url_context" .

ComputerUse

A tool that can be used by the model to interact with the computer.

type object (required)

No description provided.

Always set to "computer_use" .

environment enum (string) (optional)

The environment being operated.

Possible values:

  • browser
excluded_predefined_functions array (string) (optional)

The list of predefined functions that are excluded from the model call.

McpServer

A MCPServer is a server that can be called by the model to perform actions.

type object (required)

No description provided.

Always set to "mcp_server" .

name string (optional)

The name of the MCPServer.

url string (optional)

The full URL for the MCPServer endpoint. Example: "https://api.example.com/mcp"

headers object (optional)

Optional: Fields for authentication headers, timeouts, etc., if needed.

allowed_tools AllowedTools (optional)

The allowed tools.

The configuration for allowed tools.

Fushat

mode ToolChoiceType (optional)

The mode of the tool choice.

Possible values:

  • auto
  • any
  • none
  • validated

tools array (string) (optional)

The names of the allowed tools.

GoogleSearch

A tool that can be used by the model to search Google.

type object (required)

No description provided.

Always set to "google_search" .

search_types array (enum (string)) (optional)

The types of search grounding to enable.

Possible values:

  • web_search
  • image_search
  • enterprise_web_search
FileSearch

A tool that can be used by the model to search files.

type object (required)

No description provided.

Always set to "file_search" .

file_search_store_names array (string) (optional)

The file search store names to search.

top_k integer (optional)

The number of semantic retrieval chunks to retrieve.

metadata_filter string (optional)

Metadata filter to apply to the semantic retrieval documents and chunks.

GoogleMaps

A tool that can be used by the model to call Google Maps.

type object (required)

No description provided.

Always set to "google_maps" .

enable_widget boolean (optional)

Whether to return a widget context token in the tool call result of the response.

latitude number (optional)

The latitude of the user's location.

longitude number (optional)

The longitude of the user's location.

Retrieval

A tool that can be used by the model to retrieve files.

type object (required)

No description provided.

Always set to "retrieval" .

retrieval_types array (enum (string)) (optional)

The types of file retrieval to enable.

Possible values:

  • vertex_ai_search
vertex_ai_search_config VertexAISearchConfig (optional)

Used to specify configuration for VertexAISearch.

Used to specify configuration for VertexAISearch.

Fushat

engine string (optional)

Optional. Used to specify Vertex AI Search engine.

datastores array (string) (optional)

Optional. Used to specify Vertex AI Search datastores.

usage Usage (optional)

Output only. Statistics on the interaction request's token usage.

Statistics on the interaction request's token usage.

Fushat

total_input_tokens integer (optional)

Number of tokens in the prompt (context).

input_tokens_by_modality ModalityTokens (optional)

A breakdown of input token usage by modality.

The token count for a single response modality.

Fushat

modality ResponseModality (optional)

The modality associated with the token count.

Possible values:

  • text
  • image
  • audio
  • video
  • document

tokens integer (optional)

Number of tokens for the modality.

total_cached_tokens integer (optional)

Number of tokens in the cached part of the prompt (the cached content).

cached_tokens_by_modality ModalityTokens (optional)

A breakdown of cached token usage by modality.

The token count for a single response modality.

Fushat

modality ResponseModality (optional)

The modality associated with the token count.

Possible values:

  • text
  • image
  • audio
  • video
  • document

tokens integer (optional)

Number of tokens for the modality.

total_output_tokens integer (optional)

Total number of tokens across all the generated responses.

output_tokens_by_modality ModalityTokens (optional)

A breakdown of output token usage by modality.

The token count for a single response modality.

Fushat

modality ResponseModality (optional)

The modality associated with the token count.

Possible values:

  • text
  • image
  • audio
  • video
  • document

tokens integer (optional)

Number of tokens for the modality.

total_tool_use_tokens integer (optional)

Number of tokens present in tool-use prompt(s).

tool_use_tokens_by_modality ModalityTokens (optional)

A breakdown of tool-use token usage by modality.

The token count for a single response modality.

Fushat

modality ResponseModality (optional)

The modality associated with the token count.

Possible values:

  • text
  • image
  • audio
  • video
  • document

tokens integer (optional)

Number of tokens for the modality.

total_thought_tokens integer (optional)

Number of tokens of thoughts for thinking models.

total_tokens integer (optional)

Total token count for the interaction request (prompt + responses + other internal tokens).

grounding_tool_count GroundingToolCount (optional)

Grounding tool count.

The number of grounding tool counts.

Fushat

type enum (string) (optional)

The grounding tool type associated with the count.

Possible values:

  • google_search
  • google_maps
  • retrieval
count integer (optional)

The number of grounding tool counts.

response_modalities ResponseModality (optional)

The requested modalities of the response (TEXT, IMAGE, AUDIO).

Possible values:

  • text
  • image
  • audio
  • video
  • document

response_mime_type string (optional)

The mime type of the response. This is required if response_format is set.

previous_interaction_id string (optional)

The ID of the previous interaction, if any.

service_tier ServiceTier (optional)

The service tier for the interaction.

Possible values:

  • flex
  • standard
  • priority

webhook_config WebhookConfig (optional)

Optional. Webhook configuration for receiving notifications when the interaction completes.

Message for configuring webhook events for a request.

Fushat

uris array (string) (optional)

Optional. If set, these webhook URIs will be used for webhook events instead of the registered webhooks.

user_metadata object (optional)

Optional. The user metadata that will be returned on each event emission to the webhooks.

steps Step (optional)

Output only. The steps that make up the interaction.

A step in the interaction.

Possible Types

Polymorphic discriminator: type

UserInputStep

Input provided by the user.

type object (required)

No description provided.

Always set to "user_input" .

content Content (optional)

No description provided.

The content of the response.

Possible Types

Polymorphic discriminator: type

TextContent

A text content block.

type object (required)

No description provided.

Always set to "text" .

text string (required)

Required. The text content.

annotations Annotation (optional)

Citation information for model-generated content.

Citation information for model-generated content.

Possible Types

Polymorphic discriminator: type

UrlCitation

A URL citation annotation.

type object (required)

No description provided.

Always set to "url_citation" .

url string (optional)

The URL.

title string (optional)

The title of the URL.

start_index integer (optional)

Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes.

end_index integer (optional)

End of the attributed segment, exclusive.

FileCitation

A file citation annotation.

type object (required)

No description provided.

Always set to "file_citation" .

document_uri string (optional)

The URI of the file.

file_name string (optional)

The name of the file.

source string (optional)

Source attributed for a portion of the text.

custom_metadata object (optional)

User provided metadata about the retrieved context.

page_number integer (optional)

Page number of the cited document, if applicable.

media_id string (optional)

Media ID in-case of image citations, if applicable.

start_index integer (optional)

Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes.

end_index integer (optional)

End of the attributed segment, exclusive.

PlaceCitation

A place citation annotation.

type object (required)

No description provided.

Always set to "place_citation" .

place_id string (optional)

The ID of the place, in `places/{place_id}` format.

name string (optional)

Title of the place.

url string (optional)

URI reference of the place.

review_snippets ReviewSnippet (optional)

Snippets of reviews that are used to generate answers about the features of a given place in Google Maps.

Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps.

Fushat

title string (optional)

Title of the review.

url string (optional)

A link that corresponds to the user review on Google Maps.

review_id string (optional)

The ID of the review snippet.

start_index integer (optional)

Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes.

end_index integer (optional)

End of the attributed segment, exclusive.

ImageContent

An image content block.

type object (required)

No description provided.

Always set to "image" .

data string (optional)

The image content.

uri string (optional)

The URI of the image.

mime_type enum (string) (optional)

The mime type of the image.

Possible values:

  • image/png
  • image/jpeg
  • image/webp
  • image/heic
  • image/heif
  • image/gif
  • image/bmp
  • image/tiff
resolution MediaResolution (optional)

The resolution of the media.

Possible values:

  • low
  • medium
  • high
  • ultra_high

AudioContent

An audio content block.

type object (required)

No description provided.

Always set to "audio" .

data string (optional)

The audio content.

uri string (optional)

The URI of the audio.

mime_type enum (string) (optional)

The mime type of the audio.

Possible values:

  • audio/wav
  • audio/mp3
  • audio/aiff
  • audio/aac
  • audio/ogg
  • audio/flac
  • audio/mpeg
  • audio/m4a
  • audio/l16
  • audio/opus
  • audio/alaw
  • audio/mulaw
channels integer (optional)

The number of audio channels.

sample_rate integer (optional)

The sample rate of the audio.

DocumentContent

A document content block.

type object (required)

No description provided.

Always set to "document" .

data string (optional)

The document content.

uri string (optional)

The URI of the document.

mime_type enum (string) (optional)

The mime type of the document.

Possible values:

  • application/pdf
VideoContent

A video content block.

type object (required)

No description provided.

Always set to "video" .

data string (optional)

The video content.

uri string (optional)

The URI of the video.

mime_type enum (string) (optional)

The mime type of the video.

Possible values:

  • video/mp4
  • video/mpeg
  • video/mpg
  • video/mov
  • video/avi
  • video/x-flv
  • video/webm
  • video/wmv
  • video/3gpp
resolution MediaResolution (optional)

The resolution of the media.

Possible values:

  • low
  • medium
  • high
  • ultra_high

ModelOutputStep

Output generated by the model.

type object (required)

No description provided.

Always set to "model_output" .

content Content (optional)

No description provided.

The content of the response.

Possible Types

Polymorphic discriminator: type

TextContent

A text content block.

type object (required)

No description provided.

Always set to "text" .

text string (required)

Required. The text content.

annotations Annotation (optional)

Citation information for model-generated content.

Citation information for model-generated content.

Possible Types

Polymorphic discriminator: type

UrlCitation

A URL citation annotation.

type object (required)

No description provided.

Always set to "url_citation" .

url string (optional)

The URL.

title string (optional)

The title of the URL.

start_index integer (optional)

Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes.

end_index integer (optional)

End of the attributed segment, exclusive.

FileCitation

A file citation annotation.

type object (required)

No description provided.

Always set to "file_citation" .

document_uri string (optional)

The URI of the file.

file_name string (optional)

The name of the file.

source string (optional)

Source attributed for a portion of the text.

custom_metadata object (optional)

User provided metadata about the retrieved context.

page_number integer (optional)

Page number of the cited document, if applicable.

media_id string (optional)

Media ID in-case of image citations, if applicable.

start_index integer (optional)

Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes.

end_index integer (optional)

End of the attributed segment, exclusive.

PlaceCitation

A place citation annotation.

type object (required)

No description provided.

Always set to "place_citation" .

place_id string (optional)

The ID of the place, in `places/{place_id}` format.

name string (optional)

Title of the place.

url string (optional)

URI reference of the place.

review_snippets ReviewSnippet (optional)

Snippets of reviews that are used to generate answers about the features of a given place in Google Maps.

Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps.

Fushat

title string (optional)

Title of the review.

url string (optional)

A link that corresponds to the user review on Google Maps.

review_id string (optional)

The ID of the review snippet.

start_index integer (optional)

Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes.

end_index integer (optional)

End of the attributed segment, exclusive.

ImageContent

An image content block.

type object (required)

No description provided.

Always set to "image" .

data string (optional)

The image content.

uri string (optional)

The URI of the image.

mime_type enum (string) (optional)

The mime type of the image.

Possible values:

  • image/png
  • image/jpeg
  • image/webp
  • image/heic
  • image/heif
  • image/gif
  • image/bmp
  • image/tiff
resolution MediaResolution (optional)

The resolution of the media.

Possible values:

  • low
  • medium
  • high
  • ultra_high

AudioContent

An audio content block.

type object (required)

No description provided.

Always set to "audio" .

data string (optional)

The audio content.

uri string (optional)

The URI of the audio.

mime_type enum (string) (optional)

The mime type of the audio.

Possible values:

  • audio/wav
  • audio/mp3
  • audio/aiff
  • audio/aac
  • audio/ogg
  • audio/flac
  • audio/mpeg
  • audio/m4a
  • audio/l16
  • audio/opus
  • audio/alaw
  • audio/mulaw
channels integer (optional)

The number of audio channels.

sample_rate integer (optional)

The sample rate of the audio.

DocumentContent

A document content block.

type object (required)

No description provided.

Always set to "document" .

data string (optional)

The document content.

uri string (optional)

The URI of the document.

mime_type enum (string) (optional)

The mime type of the document.

Possible values:

  • application/pdf
VideoContent

A video content block.

type object (required)

No description provided.

Always set to "video" .

data string (optional)

The video content.

uri string (optional)

The URI of the video.

mime_type enum (string) (optional)

The mime type of the video.

Possible values:

  • video/mp4
  • video/mpeg
  • video/mpg
  • video/mov
  • video/avi
  • video/x-flv
  • video/webm
  • video/wmv
  • video/3gpp
resolution MediaResolution (optional)

The resolution of the media.

Possible values:

  • low
  • medium
  • high
  • ultra_high

ThoughtStep

A thought step.

type object (required)

No description provided.

Always set to "thought" .

signature string (optional)

A signature hash for backend validation.

summary ThoughtSummaryContent (optional)

A summary of the thought.

Possible Types

Polymorphic discriminator: type

TextContent

A text content block.

type object (required)

No description provided.

Always set to "text" .

text string (required)

Required. The text content.

annotations Annotation (optional)

Citation information for model-generated content.

Citation information for model-generated content.

Possible Types

Polymorphic discriminator: type

UrlCitation

A URL citation annotation.

type object (required)

No description provided.

Always set to "url_citation" .

url string (optional)

The URL.

title string (optional)

The title of the URL.

start_index integer (optional)

Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes.

end_index integer (optional)

End of the attributed segment, exclusive.

FileCitation

A file citation annotation.

type object (required)

No description provided.

Always set to "file_citation" .

document_uri string (optional)

The URI of the file.

file_name string (optional)

The name of the file.

source string (optional)

Source attributed for a portion of the text.

custom_metadata object (optional)

User provided metadata about the retrieved context.

page_number integer (optional)

Page number of the cited document, if applicable.

media_id string (optional)

Media ID in-case of image citations, if applicable.

start_index integer (optional)

Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes.

end_index integer (optional)

End of the attributed segment, exclusive.

PlaceCitation

A place citation annotation.

type object (required)

No description provided.

Always set to "place_citation" .

place_id string (optional)

The ID of the place, in `places/{place_id}` format.

name string (optional)

Title of the place.

url string (optional)

URI reference of the place.

review_snippets ReviewSnippet (optional)

Snippets of reviews that are used to generate answers about the features of a given place in Google Maps.

Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps.

Fushat

title string (optional)

Title of the review.

url string (optional)

A link that corresponds to the user review on Google Maps.

review_id string (optional)

The ID of the review snippet.

start_index integer (optional)

Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes.

end_index integer (optional)

End of the attributed segment, exclusive.

ImageContent

An image content block.

type object (required)

No description provided.

Always set to "image" .

data string (optional)

The image content.

uri string (optional)

The URI of the image.

mime_type enum (string) (optional)

The mime type of the image.

Possible values:

  • image/png
  • image/jpeg
  • image/webp
  • image/heic
  • image/heif
  • image/gif
  • image/bmp
  • image/tiff
resolution MediaResolution (optional)

The resolution of the media.

Possible values:

  • low
  • medium
  • high
  • ultra_high

FunctionCallStep

A function tool call step.

type object (required)

No description provided.

Always set to "function_call" .

name string (required)

Required. The name of the tool to call.

arguments object (required)

Required. The arguments to pass to the function.

id string (required)

Required. A unique ID for this specific tool call.

signature string (optional)

A signature hash for backend validation.

CodeExecutionCallStep

Code execution call step.

type object (required)

No description provided.

Always set to "code_execution_call" .

arguments CodeExecutionCallStepArguments (required)

Required. The arguments to pass to the code execution.

The arguments to pass to the code execution.

Fushat

language enum (string) (optional)

Programming language of the `code`.

Possible values:

  • python
code string (optional)

The code to be executed.

id string (required)

Required. A unique ID for this specific tool call.

signature string (optional)

A signature hash for backend validation.

UrlContextCallStep

URL context call step.

type object (required)

No description provided.

Always set to "url_context_call" .

arguments UrlContextCallStepArguments (required)

Required. The arguments to pass to the URL context.

The arguments to pass to the URL context.

Fushat

urls array (string) (optional)

The URLs to fetch.

id string (required)

Required. A unique ID for this specific tool call.

signature string (optional)

A signature hash for backend validation.

McpServerToolCallStep

MCPServer tool call step.

type object (required)

No description provided.

Always set to "mcp_server_tool_call" .

name string (required)

Required. The name of the tool which was called.

server_name string (required)

Required. The name of the used MCP server.

arguments object (required)

Required. The JSON object of arguments for the function.

id string (required)

Required. A unique ID for this specific tool call.

signature string (optional)

A signature hash for backend validation.

GoogleSearchCallStep

Google Search call step.

type object (required)

No description provided.

Always set to "google_search_call" .

arguments GoogleSearchCallStepArguments (required)

Required. The arguments to pass to Google Search.

The arguments to pass to Google Search.

Fushat

queries array (string) (optional)

Web search queries for the following-up web search.

search_type enum (string) (optional)

The type of search grounding enabled.

Possible values:

  • web_search
  • image_search
  • enterprise_web_search
id string (required)

Required. A unique ID for this specific tool call.

signature string (optional)

A signature hash for backend validation.

FileSearchCallStep

File Search call step.

type object (required)

No description provided.

Always set to "file_search_call" .

id string (required)

Required. A unique ID for this specific tool call.

signature string (optional)

A signature hash for backend validation.

GoogleMapsCallStep

Google Maps call step.

type object (required)

No description provided.

Always set to "google_maps_call" .

arguments GoogleMapsCallStepArguments (optional)

The arguments to pass to the Google Maps tool.

The arguments to pass to the Google Maps tool.

Fushat

queries array (string) (optional)

The queries to be executed.

id string (required)

Required. A unique ID for this specific tool call.

signature string (optional)

A signature hash for backend validation.

FunctionResultStep

Result of a function tool call.

type object (required)

No description provided.

Always set to "function_result" .

name string (optional)

The name of the tool that was called.

is_error boolean (optional)

Whether the tool call resulted in an error.

call_id string (required)

Required. ID to match the ID from the function call block.

signature string (optional)

A signature hash for backend validation.

result array ( FunctionResultSubcontent ) or string (required)

The result of the tool call.

CodeExecutionResultStep

Code execution result step.

type object (required)

No description provided.

Always set to "code_execution_result" .

result string (required)

Required. The output of the code execution.

is_error boolean (optional)

Whether the code execution resulted in an error.

call_id string (required)

Required. ID to match the ID from the function call block.

signature string (optional)

A signature hash for backend validation.

UrlContextResultStep

URL context result step.

type object (required)

No description provided.

Always set to "url_context_result" .

result UrlContextResultItem (required)

Required. The results of the URL context.

The result of the URL context.

Fushat

url string (optional)

The URL that was fetched.

status enum (string) (optional)

The status of the URL retrieval.

Possible values:

  • success
  • error
  • paywall
  • unsafe
is_error boolean (optional)

Whether the URL context resulted in an error.

call_id string (required)

Required. ID to match the ID from the function call block.

signature string (optional)

A signature hash for backend validation.

GoogleSearchResultStep

Google Search result step.

type object (required)

No description provided.

Always set to "google_search_result" .

result GoogleSearchResultItem (required)

Required. The results of the Google Search.

The result of the Google Search.

Fushat

search_suggestions string (optional)

Web content snippet that can be embedded in a web page or an app webview.

is_error boolean (optional)

Whether the Google Search resulted in an error.

call_id string (required)

Required. ID to match the ID from the function call block.

signature string (optional)

A signature hash for backend validation.

McpServerToolResultStep

MCPServer tool result step.

type object (required)

No description provided.

Always set to "mcp_server_tool_result" .

name string (optional)

Name of the tool which is called for this specific tool call.

server_name string (optional)

The name of the used MCP server.

call_id string (required)

Required. ID to match the ID from the function call block.

signature string (optional)

A signature hash for backend validation.

result array ( FunctionResultSubcontent ) or string (required)

The output from the MCP server call. Can be simple text or rich content.

FileSearchResultStep

File Search result step.

type object (required)

No description provided.

Always set to "file_search_result" .

call_id string (required)

Required. ID to match the ID from the function call block.

signature string (optional)

A signature hash for backend validation.

GoogleMapsResultStep

Google Maps result step.

type object (required)

No description provided.

Always set to "google_maps_result" .

result GoogleMapsResultItem (required)

No description provided.

The result of the Google Maps.

Fushat

places GoogleMapsResultPlaces (optional)

No description provided.

Fushat

place_id string (optional)

No description provided.

name string (optional)

No description provided.

url string (optional)

No description provided.

review_snippets ReviewSnippet (optional)

No description provided.

Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps.

Fushat

title string (optional)

Title of the review.

url string (optional)

A link that corresponds to the user review on Google Maps.

review_id string (optional)

The ID of the review snippet.

widget_context_token string (optional)

No description provided.

call_id string (required)

Required. ID to match the ID from the function call block.

signature string (optional)

A signature hash for backend validation.

input Content or array ( Content ) or array ( Step ) or string (optional)

The input for the interaction.

response_format ResponseFormat or ResponseFormatList (optional)

Enforces that the generated response is a JSON object that complies with the JSON schema specified in this field.

agent_config object (optional)

Configuration parameters for the agent interaction.

Possible Types

Polymorphic discriminator: type

DynamicAgentConfig

Configuration for dynamic agents.

type object (required)

No description provided.

Always set to "dynamic" .

DeepResearchAgentConfig

Configuration for the Deep Research agent.

type object (required)

No description provided.

Always set to "deep-research" .

thinking_summaries ThinkingSummaries (optional)

Whether to include thought summaries in the response.

Possible values:

  • auto
  • none

visualization enum (string) (optional)

Whether to include visualizations in the response.

Possible values:

  • off
  • auto
collaborative_planning boolean (optional)

Enables human-in-the-loop planning for the Deep Research agent. If set to true, the Deep Research agent will provide a research plan in its response. The agent will then proceed only if the user confirms the plan in the next turn.

event_id string (optional)

The event_id token to be used to resume the interaction stream, from this event.

InteractionStatusUpdate

event_type object (required)

No description provided.

Always set to "interaction.status_update" .

interaction_id string (required)

No description provided.

status enum (string) (required)

No description provided.

Possible values:

  • in_progress
  • requires_action
  • completed
  • failed
  • cancelled
  • incomplete
event_id string (optional)

The event_id token to be used to resume the interaction stream, from this event.

ErrorEvent

event_type object (required)

No description provided.

Always set to "error" .

error Error (optional)

No description provided.

Error message from an interaction.

Fushat

code string (optional)

A URI that identifies the error type.

message string (optional)

A human-readable error message.

event_id string (optional)

The event_id token to be used to resume the interaction stream, from this event.

StepStart

event_type object (required)

No description provided.

Always set to "step.start" .

index integer (required)

No description provided.

step Step (required)

No description provided.

A step in the interaction.

Possible Types

Polymorphic discriminator: type

UserInputStep

Input provided by the user.

type object (required)

No description provided.

Always set to "user_input" .

content Content (optional)

No description provided.

The content of the response.

Possible Types

Polymorphic discriminator: type

TextContent

A text content block.

type object (required)

No description provided.

Always set to "text" .

text string (required)

Required. The text content.

annotations Annotation (optional)

Citation information for model-generated content.

Citation information for model-generated content.

Possible Types

Polymorphic discriminator: type

UrlCitation

A URL citation annotation.

type object (required)

No description provided.

Always set to "url_citation" .

url string (optional)

The URL.

title string (optional)

The title of the URL.

start_index integer (optional)

Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes.

end_index integer (optional)

End of the attributed segment, exclusive.

FileCitation

A file citation annotation.

type object (required)

No description provided.

Always set to "file_citation" .

document_uri string (optional)

The URI of the file.

file_name string (optional)

The name of the file.

source string (optional)

Source attributed for a portion of the text.

custom_metadata object (optional)

User provided metadata about the retrieved context.

page_number integer (optional)

Page number of the cited document, if applicable.

media_id string (optional)

Media ID in-case of image citations, if applicable.

start_index integer (optional)

Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes.

end_index integer (optional)

End of the attributed segment, exclusive.

PlaceCitation

A place citation annotation.

type object (required)

No description provided.

Always set to "place_citation" .

place_id string (optional)

The ID of the place, in `places/{place_id}` format.

name string (optional)

Title of the place.

url string (optional)

URI reference of the place.

review_snippets ReviewSnippet (optional)

Snippets of reviews that are used to generate answers about the features of a given place in Google Maps.

Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps.

Fushat

title string (optional)

Title of the review.

url string (optional)

A link that corresponds to the user review on Google Maps.

review_id string (optional)

The ID of the review snippet.

start_index integer (optional)

Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes.

end_index integer (optional)

End of the attributed segment, exclusive.

ImageContent

An image content block.

type object (required)

No description provided.

Always set to "image" .

data string (optional)

The image content.

uri string (optional)

The URI of the image.

mime_type enum (string) (optional)

The mime type of the image.

Possible values:

  • image/png
  • image/jpeg
  • image/webp
  • image/heic
  • image/heif
  • image/gif
  • image/bmp
  • image/tiff
resolution MediaResolution (optional)

The resolution of the media.

Possible values:

  • low
  • medium
  • high
  • ultra_high

AudioContent

An audio content block.

type object (required)

No description provided.

Always set to "audio" .

data string (optional)

The audio content.

uri string (optional)

The URI of the audio.

mime_type enum (string) (optional)

The mime type of the audio.

Possible values:

  • audio/wav
  • audio/mp3
  • audio/aiff
  • audio/aac
  • audio/ogg
  • audio/flac
  • audio/mpeg
  • audio/m4a
  • audio/l16
  • audio/opus
  • audio/alaw
  • audio/mulaw
channels integer (optional)

The number of audio channels.

sample_rate integer (optional)

The sample rate of the audio.

DocumentContent

A document content block.

type object (required)

No description provided.

Always set to "document" .

data string (optional)

The document content.

uri string (optional)

The URI of the document.

mime_type enum (string) (optional)

The mime type of the document.

Possible values:

  • application/pdf
VideoContent

A video content block.

type object (required)

No description provided.

Always set to "video" .

data string (optional)

The video content.

uri string (optional)

The URI of the video.

mime_type enum (string) (optional)

The mime type of the video.

Possible values:

  • video/mp4
  • video/mpeg
  • video/mpg
  • video/mov
  • video/avi
  • video/x-flv
  • video/webm
  • video/wmv
  • video/3gpp
resolution MediaResolution (optional)

The resolution of the media.

Possible values:

  • low
  • medium
  • high
  • ultra_high

ModelOutputStep

Output generated by the model.

type object (required)

No description provided.

Always set to "model_output" .

content Content (optional)

No description provided.

The content of the response.

Possible Types

Polymorphic discriminator: type

TextContent

A text content block.

type object (required)

No description provided.

Always set to "text" .

text string (required)

Required. The text content.

annotations Annotation (optional)

Citation information for model-generated content.

Citation information for model-generated content.

Possible Types

Polymorphic discriminator: type

UrlCitation

A URL citation annotation.

type object (required)

No description provided.

Always set to "url_citation" .

url string (optional)

The URL.

title string (optional)

The title of the URL.

start_index integer (optional)

Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes.

end_index integer (optional)

End of the attributed segment, exclusive.

FileCitation

A file citation annotation.

type object (required)

No description provided.

Always set to "file_citation" .

document_uri string (optional)

The URI of the file.

file_name string (optional)

The name of the file.

source string (optional)

Source attributed for a portion of the text.

custom_metadata object (optional)

User provided metadata about the retrieved context.

page_number integer (optional)

Page number of the cited document, if applicable.

media_id string (optional)

Media ID in-case of image citations, if applicable.

start_index integer (optional)

Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes.

end_index integer (optional)

End of the attributed segment, exclusive.

PlaceCitation

A place citation annotation.

type object (required)

No description provided.

Always set to "place_citation" .

place_id string (optional)

The ID of the place, in `places/{place_id}` format.

name string (optional)

Title of the place.

url string (optional)

URI reference of the place.

review_snippets ReviewSnippet (optional)

Snippets of reviews that are used to generate answers about the features of a given place in Google Maps.

Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps.

Fushat

title string (optional)

Title of the review.

url string (optional)

A link that corresponds to the user review on Google Maps.

review_id string (optional)

The ID of the review snippet.

start_index integer (optional)

Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes.

end_index integer (optional)

End of the attributed segment, exclusive.

ImageContent

An image content block.

type object (required)

No description provided.

Always set to "image" .

data string (optional)

The image content.

uri string (optional)

The URI of the image.

mime_type enum (string) (optional)

The mime type of the image.

Possible values:

  • image/png
  • image/jpeg
  • image/webp
  • image/heic
  • image/heif
  • image/gif
  • image/bmp
  • image/tiff
resolution MediaResolution (optional)

The resolution of the media.

Possible values:

  • low
  • medium
  • high
  • ultra_high

AudioContent

An audio content block.

type object (required)

No description provided.

Always set to "audio" .

data string (optional)

The audio content.

uri string (optional)

The URI of the audio.

mime_type enum (string) (optional)

The mime type of the audio.

Possible values:

  • audio/wav
  • audio/mp3
  • audio/aiff
  • audio/aac
  • audio/ogg
  • audio/flac
  • audio/mpeg
  • audio/m4a
  • audio/l16
  • audio/opus
  • audio/alaw
  • audio/mulaw
channels integer (optional)

The number of audio channels.

sample_rate integer (optional)

The sample rate of the audio.

DocumentContent

A document content block.

type object (required)

No description provided.

Always set to "document" .

data string (optional)

The document content.

uri string (optional)

The URI of the document.

mime_type enum (string) (optional)

The mime type of the document.

Possible values:

  • application/pdf
VideoContent

A video content block.

type object (required)

No description provided.

Always set to "video" .

data string (optional)

The video content.

uri string (optional)

The URI of the video.

mime_type enum (string) (optional)

The mime type of the video.

Possible values:

  • video/mp4
  • video/mpeg
  • video/mpg
  • video/mov
  • video/avi
  • video/x-flv
  • video/webm
  • video/wmv
  • video/3gpp
resolution MediaResolution (optional)

The resolution of the media.

Possible values:

  • low
  • medium
  • high
  • ultra_high

ThoughtStep

A thought step.

type object (required)

No description provided.

Always set to "thought" .

signature string (optional)

A signature hash for backend validation.

summary ThoughtSummaryContent (optional)

A summary of the thought.

Possible Types

Polymorphic discriminator: type

TextContent

A text content block.

type object (required)

No description provided.

Always set to "text" .

text string (required)

Required. The text content.

annotations Annotation (optional)

Citation information for model-generated content.

Citation information for model-generated content.

Possible Types

Polymorphic discriminator: type

UrlCitation

A URL citation annotation.

type object (required)

No description provided.

Always set to "url_citation" .

url string (optional)

The URL.

title string (optional)

The title of the URL.

start_index integer (optional)

Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes.

end_index integer (optional)

End of the attributed segment, exclusive.

FileCitation

A file citation annotation.

type object (required)

No description provided.

Always set to "file_citation" .

document_uri string (optional)

The URI of the file.

file_name string (optional)

The name of the file.

source string (optional)

Source attributed for a portion of the text.

custom_metadata object (optional)

User provided metadata about the retrieved context.

page_number integer (optional)

Page number of the cited document, if applicable.

media_id string (optional)

Media ID in-case of image citations, if applicable.

start_index integer (optional)

Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes.

end_index integer (optional)

End of the attributed segment, exclusive.

PlaceCitation

A place citation annotation.

type object (required)

No description provided.

Always set to "place_citation" .

place_id string (optional)

The ID of the place, in `places/{place_id}` format.

name string (optional)

Title of the place.

url string (optional)

URI reference of the place.

review_snippets ReviewSnippet (optional)

Snippets of reviews that are used to generate answers about the features of a given place in Google Maps.

Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps.

Fushat

title string (optional)

Title of the review.

url string (optional)

A link that corresponds to the user review on Google Maps.

review_id string (optional)

The ID of the review snippet.

start_index integer (optional)

Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes.

end_index integer (optional)

End of the attributed segment, exclusive.

ImageContent

An image content block.

type object (required)

No description provided.

Always set to "image" .

data string (optional)

The image content.

uri string (optional)

The URI of the image.

mime_type enum (string) (optional)

The mime type of the image.

Possible values:

  • image/png
  • image/jpeg
  • image/webp
  • image/heic
  • image/heif
  • image/gif
  • image/bmp
  • image/tiff
resolution MediaResolution (optional)

The resolution of the media.

Possible values:

  • low
  • medium
  • high
  • ultra_high

FunctionCallStep

A function tool call step.

type object (required)

No description provided.

Always set to "function_call" .

name string (required)

Required. The name of the tool to call.

arguments object (required)

Required. The arguments to pass to the function.

id string (required)

Required. A unique ID for this specific tool call.

signature string (optional)

A signature hash for backend validation.

CodeExecutionCallStep

Code execution call step.

type object (required)

No description provided.

Always set to "code_execution_call" .

arguments CodeExecutionCallStepArguments (required)

Required. The arguments to pass to the code execution.

The arguments to pass to the code execution.

Fushat

language enum (string) (optional)

Programming language of the `code`.

Possible values:

  • python
code string (optional)

The code to be executed.

id string (required)

Required. A unique ID for this specific tool call.

signature string (optional)

A signature hash for backend validation.

UrlContextCallStep

URL context call step.

type object (required)

No description provided.

Always set to "url_context_call" .

arguments UrlContextCallStepArguments (required)

Required. The arguments to pass to the URL context.

The arguments to pass to the URL context.

Fushat

urls array (string) (optional)

The URLs to fetch.

id string (required)

Required. A unique ID for this specific tool call.

signature string (optional)

A signature hash for backend validation.

McpServerToolCallStep

MCPServer tool call step.

type object (required)

No description provided.

Always set to "mcp_server_tool_call" .

name string (required)

Required. The name of the tool which was called.

server_name string (required)

Required. The name of the used MCP server.

arguments object (required)

Required. The JSON object of arguments for the function.

id string (required)

Required. A unique ID for this specific tool call.

signature string (optional)

A signature hash for backend validation.

GoogleSearchCallStep

Google Search call step.

type object (required)

No description provided.

Always set to "google_search_call" .

arguments GoogleSearchCallStepArguments (required)

Required. The arguments to pass to Google Search.

The arguments to pass to Google Search.

Fushat

queries array (string) (optional)

Web search queries for the following-up web search.

search_type enum (string) (optional)

The type of search grounding enabled.

Possible values:

  • web_search
  • image_search
  • enterprise_web_search
id string (required)

Required. A unique ID for this specific tool call.

signature string (optional)

A signature hash for backend validation.

FileSearchCallStep

File Search call step.

type object (required)

No description provided.

Always set to "file_search_call" .

id string (required)

Required. A unique ID for this specific tool call.

signature string (optional)

A signature hash for backend validation.

GoogleMapsCallStep

Google Maps call step.

type object (required)

No description provided.

Always set to "google_maps_call" .

arguments GoogleMapsCallStepArguments (optional)

The arguments to pass to the Google Maps tool.

The arguments to pass to the Google Maps tool.

Fushat

queries array (string) (optional)

The queries to be executed.

id string (required)

Required. A unique ID for this specific tool call.

signature string (optional)

A signature hash for backend validation.

FunctionResultStep

Result of a function tool call.

type object (required)

No description provided.

Always set to "function_result" .

name string (optional)

The name of the tool that was called.

is_error boolean (optional)

Whether the tool call resulted in an error.

call_id string (required)

Required. ID to match the ID from the function call block.

signature string (optional)

A signature hash for backend validation.

result array ( FunctionResultSubcontent ) or string (required)

The result of the tool call.

CodeExecutionResultStep

Code execution result step.

type object (required)

No description provided.

Always set to "code_execution_result" .

result string (required)

Required. The output of the code execution.

is_error boolean (optional)

Whether the code execution resulted in an error.

call_id string (required)

Required. ID to match the ID from the function call block.

signature string (optional)

A signature hash for backend validation.

UrlContextResultStep

URL context result step.

type object (required)

No description provided.

Always set to "url_context_result" .

result UrlContextResultItem (required)

Required. The results of the URL context.

The result of the URL context.

Fushat

url string (optional)

The URL that was fetched.

status enum (string) (optional)

The status of the URL retrieval.

Possible values:

  • success
  • error
  • paywall
  • unsafe
is_error boolean (optional)

Whether the URL context resulted in an error.

call_id string (required)

Required. ID to match the ID from the function call block.

signature string (optional)

A signature hash for backend validation.

GoogleSearchResultStep

Google Search result step.

type object (required)

No description provided.

Always set to "google_search_result" .

result GoogleSearchResultItem (required)

Required. The results of the Google Search.

The result of the Google Search.

Fushat

search_suggestions string (optional)

Web content snippet that can be embedded in a web page or an app webview.

is_error boolean (optional)

Whether the Google Search resulted in an error.

call_id string (required)

Required. ID to match the ID from the function call block.

signature string (optional)

A signature hash for backend validation.

McpServerToolResultStep

MCPServer tool result step.

type object (required)

No description provided.

Always set to "mcp_server_tool_result" .

name string (optional)

Name of the tool which is called for this specific tool call.

server_name string (optional)

The name of the used MCP server.

call_id string (required)

Required. ID to match the ID from the function call block.

signature string (optional)

A signature hash for backend validation.

result array ( FunctionResultSubcontent ) or string (required)

The output from the MCP server call. Can be simple text or rich content.

FileSearchResultStep

File Search result step.

type object (required)

No description provided.

Always set to "file_search_result" .

call_id string (required)

Required. ID to match the ID from the function call block.

signature string (optional)

A signature hash for backend validation.

GoogleMapsResultStep

Google Maps result step.

type object (required)

No description provided.

Always set to "google_maps_result" .

result GoogleMapsResultItem (required)

No description provided.

The result of the Google Maps.

Fushat

places GoogleMapsResultPlaces (optional)

No description provided.

Fushat

place_id string (optional)

No description provided.

name string (optional)

No description provided.

url string (optional)

No description provided.

review_snippets ReviewSnippet (optional)

No description provided.

Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps.

Fushat

title string (optional)

Title of the review.

url string (optional)

A link that corresponds to the user review on Google Maps.

review_id string (optional)

The ID of the review snippet.

widget_context_token string (optional)

No description provided.

call_id string (required)

Required. ID to match the ID from the function call block.

signature string (optional)

A signature hash for backend validation.

event_id string (optional)

The event_id token to be used to resume the interaction stream, from this event.

StepDelta

event_type object (required)

No description provided.

Always set to "step.delta" .

index integer (required)

No description provided.

delta StepDeltaData (required)

No description provided.

Possible Types

Polymorphic discriminator: type

TextDelta

type object (required)

No description provided.

Always set to "text" .

text string (required)

No description provided.

ImageDelta

type object (required)

No description provided.

Always set to "image" .

data string (optional)

No description provided.

uri string (optional)

No description provided.

mime_type enum (string) (optional)

No description provided.

Possible values:

  • image/png
  • image/jpeg
  • image/webp
  • image/heic
  • image/heif
  • image/gif
  • image/bmp
  • image/tiff
resolution MediaResolution (optional)

The resolution of the media.

Possible values:

  • low
  • medium
  • high
  • ultra_high

AudioDelta

type object (required)

No description provided.

Always set to "audio" .

data string (optional)

No description provided.

uri string (optional)

No description provided.

mime_type enum (string) (optional)

No description provided.

Possible values:

  • audio/wav
  • audio/mp3
  • audio/aiff
  • audio/aac
  • audio/ogg
  • audio/flac
  • audio/mpeg
  • audio/m4a
  • audio/l16
  • audio/opus
  • audio/alaw
  • audio/mulaw
rate integer (optional)

Deprecated. Use sample_rate instead. The value is ignored.

sample_rate integer (optional)

The sample rate of the audio.

channels integer (optional)

The number of audio channels.

DocumentDelta

type object (required)

No description provided.

Always set to "document" .

data string (optional)

No description provided.

uri string (optional)

No description provided.

mime_type enum (string) (optional)

No description provided.

Possible values:

  • application/pdf
VideoDelta

type object (required)

No description provided.

Always set to "video" .

data string (optional)

No description provided.

uri string (optional)

No description provided.

mime_type enum (string) (optional)

No description provided.

Possible values:

  • video/mp4
  • video/mpeg
  • video/mpg
  • video/mov
  • video/avi
  • video/x-flv
  • video/webm
  • video/wmv
  • video/3gpp
resolution MediaResolution (optional)

The resolution of the media.

Possible values:

  • low
  • medium
  • high
  • ultra_high

ThoughtSummaryDelta

type object (required)

No description provided.

Always set to "thought_summary" .

content ThoughtSummaryContent (optional)

A new summary item to be added to the thought.

Possible Types

Polymorphic discriminator: type

TextContent

A text content block.

type object (required)

No description provided.

Always set to "text" .

text string (required)

Required. The text content.

annotations Annotation (optional)

Citation information for model-generated content.

Citation information for model-generated content.

Possible Types

Polymorphic discriminator: type

UrlCitation

A URL citation annotation.

type object (required)

No description provided.

Always set to "url_citation" .

url string (optional)

The URL.

title string (optional)

The title of the URL.

start_index integer (optional)

Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes.

end_index integer (optional)

End of the attributed segment, exclusive.

FileCitation

A file citation annotation.

type object (required)

No description provided.

Always set to "file_citation" .

document_uri string (optional)

The URI of the file.

file_name string (optional)

The name of the file.

source string (optional)

Source attributed for a portion of the text.

custom_metadata object (optional)

User provided metadata about the retrieved context.

page_number integer (optional)

Page number of the cited document, if applicable.

media_id string (optional)

Media ID in-case of image citations, if applicable.

start_index integer (optional)

Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes.

end_index integer (optional)

End of the attributed segment, exclusive.

PlaceCitation

A place citation annotation.

type object (required)

No description provided.

Always set to "place_citation" .

place_id string (optional)

The ID of the place, in `places/{place_id}` format.

name string (optional)

Title of the place.

url string (optional)

URI reference of the place.

review_snippets ReviewSnippet (optional)

Snippets of reviews that are used to generate answers about the features of a given place in Google Maps.

Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps.

Fushat

title string (optional)

Title of the review.

url string (optional)

A link that corresponds to the user review on Google Maps.

review_id string (optional)

The ID of the review snippet.

start_index integer (optional)

Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes.

end_index integer (optional)

End of the attributed segment, exclusive.

ImageContent

An image content block.

type object (required)

No description provided.

Always set to "image" .

data string (optional)

The image content.

uri string (optional)

The URI of the image.

mime_type enum (string) (optional)

The mime type of the image.

Possible values:

  • image/png
  • image/jpeg
  • image/webp
  • image/heic
  • image/heif
  • image/gif
  • image/bmp
  • image/tiff
resolution MediaResolution (optional)

The resolution of the media.

Possible values:

  • low
  • medium
  • high
  • ultra_high

ThoughtSignatureDelta

type object (required)

No description provided.

Always set to "thought_signature" .

signature string (optional)

Signature to match the backend source to be part of the generation.

TextAnnotationDelta

type object (required)

No description provided.

Always set to "text_annotation_delta" .

annotations Annotation (optional)

Citation information for model-generated content.

Citation information for model-generated content.

Possible Types

Polymorphic discriminator: type

UrlCitation

A URL citation annotation.

type object (required)

No description provided.

Always set to "url_citation" .

url string (optional)

The URL.

title string (optional)

The title of the URL.

start_index integer (optional)

Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes.

end_index integer (optional)

End of the attributed segment, exclusive.

FileCitation

A file citation annotation.

type object (required)

No description provided.

Always set to "file_citation" .

document_uri string (optional)

The URI of the file.

file_name string (optional)

The name of the file.

source string (optional)

Source attributed for a portion of the text.

custom_metadata object (optional)

User provided metadata about the retrieved context.

page_number integer (optional)

Page number of the cited document, if applicable.

media_id string (optional)

Media ID in-case of image citations, if applicable.

start_index integer (optional)

Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes.

end_index integer (optional)

End of the attributed segment, exclusive.

PlaceCitation

A place citation annotation.

type object (required)

No description provided.

Always set to "place_citation" .

place_id string (optional)

The ID of the place, in `places/{place_id}` format.

name string (optional)

Title of the place.

url string (optional)

URI reference of the place.

review_snippets ReviewSnippet (optional)

Snippets of reviews that are used to generate answers about the features of a given place in Google Maps.

Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps.

Fushat

title string (optional)

Title of the review.

url string (optional)

A link that corresponds to the user review on Google Maps.

review_id string (optional)

The ID of the review snippet.

start_index integer (optional)

Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes.

end_index integer (optional)

End of the attributed segment, exclusive.

ArgumentsDelta

type object (required)

No description provided.

Always set to "arguments_delta" .

partial_arguments string (optional)

No description provided.

event_id string (optional)

The event_id token to be used to resume the interaction stream, from this event.

StepStop

event_type object (required)

No description provided.

Always set to "step.stop" .

index integer (required)

No description provided.

event_id string (optional)

The event_id token to be used to resume the interaction stream, from this event.

Shembuj

Interaction Created 

{
  "event_type": "interaction.created",
  "interaction": {
    "id": "v1_ChdXS0l4YWZXTk9xbk0xZThQczhEcmlROBIXV0tJeGFmV05PcW5NMWU4UHM4RHJpUTg",
    "model": "gemini-3-flash-preview",
    "status": "in_progress",
    "created": "2025-12-04T15:01:45Z",
    "updated": "2025-12-04T15:01:45Z"
  },
  "event_id": "evt_123"
}

Interaction Completed 

{
  "event_type": "interaction.completed",
  "interaction": {
    "id": "v1_ChdXS0l4YWZXTk9xbk0xZThQczhEcmlROBIXV0tJeGFmV05PcW5NMWU4UHM4RHJpUTg",
    "model": "gemini-3-flash-preview",
    "status": "completed",
    "created": "2025-12-04T15:01:45Z",
    "updated": "2025-12-04T15:01:45Z"
  },
  "event_id": "evt_123"
}

Interaction Status Update 

{
  "event_type": "interaction.status_update",
  "interaction_id": "v1_ChdTMjQ0YWJ5TUF1TzcxZThQdjRpcnFRcxIXUzI0NGFieU1BdU83MWU4UHY0aXJxUXM",
  "status": "in_progress"
}

Error Event 

{
  "event_type": "error",
  "error": {
    "message": "Failed to get completed interaction: Result not found.",
    "code": "not_found"
  }
}

Step Start 

{
  "event_type": "step.start",
  "index": 0,
  "step": {
    "type": "model_output"
  }
}

Step Delta 

{
  "event_type": "step.delta",
  "index": 0,
  "delta": {
    "type": "text",
    "text": "Hello"
  }
}

Ndalesë hapi 

{
  "event_type": "step.stop",
  "index": 0
}