Batch Mode

Gemini API mbështet modalitetin e grupit, i cili ju lejon të përpunoni kërkesa të shumta në një telefonatë të vetme. Për më shumë detaje, shihni udhëzuesin e modalitetit të grupit .

Kandidati

Një kandidat përgjigjeje i krijuar nga modeli.

Fushat
objekti content object ( Content )

Vetëm dalje. Përmbajtja e gjeneruar e kthyer nga modeli.

finishReason enum ( FinishReason )

Fakultative. Vetëm dalje. Arsyeja pse modeli ndaloi gjenerimin e argumenteve.

Nëse është bosh, modeli nuk ka ndaluar së gjeneruari shenja.

Objekt safetyRatings[] object ( SafetyRating )

Lista e vlerësimeve për sigurinë e një kandidati të përgjigjes.

Ka më së shumti një vlerësim për kategori.

citationMetadata object ( CitationMetadata )

Vetëm dalje. Informacioni i citimit për kandidatin e krijuar nga modeli.

Kjo fushë mund të plotësohet me informacion recitimi për çdo tekst të përfshirë në content . Këto janë pasazhe që janë "recituar" nga materiali me të drejtë autori në të dhënat e trajnimit të LLM-së.

tokenCount integer

Vetëm dalje. Numërimi simbolik për këtë kandidat.

groundingAttributions[] object ( GroundingAttribution )

Vetëm dalje. Informacioni i atribuimit për burimet që kontribuan në një përgjigje të bazuar.

Kjo fushë është e mbushur për thirrjet GenerateAnswer .

object ( GroundingMetadata ) groundingMetadata ( GroundingMetadata )

Vetëm dalje. Meta të dhënat bazë për kandidatin.

Kjo fushë është e mbushur për thirrjet GenerateContent .

number avgLogprobs

Vetëm dalje. Rezultati mesatar i probabilitetit log të kandidatit.

logprobsResult object ( LogprobsResult )

Vetëm dalje. Rezultatet e gjasave të regjistrit për argumentet e përgjigjes dhe shenjat kryesore

urlContextMetadata object ( UrlContextMetadata )

Vetëm dalje. Të dhënat meta të lidhura me mjetin e rikthimit të kontekstit url.

index integer

Vetëm dalje. Indeksi i kandidatit në listën e kandidatëve të përgjigjeve.

Përfaqësimi JSON 
{
  "content": {
    object (Content)
  },
  "finishReason": enum (FinishReason),
  "safetyRatings": [
    {
      object (SafetyRating)
    }
  ],
  "citationMetadata": {
    object (CitationMetadata)
  },
  "tokenCount": integer,
  "groundingAttributions": [
    {
      object (GroundingAttribution)
    }
  ],
  "groundingMetadata": {
    object (GroundingMetadata)
  },
  "avgLogprobs": number,
  "logprobsResult": {
    object (LogprobsResult)
  },
  "urlContextMetadata": {
    object (UrlContextMetadata)
  },
  "index": integer
}

PërfundoArsyeja

Përcakton arsyen pse modeli ndaloi gjenerimin e argumenteve.

Enums
FINISH_REASON_UNSPECIFIED Vlera e paracaktuar. Kjo vlerë është e papërdorur.
STOP Pika natyrore e ndalimit të modelit ose sekuenca e parashikuar e ndalimit.
MAX_TOKENS U arrit numri maksimal i argumenteve siç specifikohet në kërkesë.
SAFETY Përmbajtja e kandidatit të përgjigjes u raportua për arsye sigurie.
RECITATION Përmbajtja e kandidatit të përgjigjes u shënua për arsye recitimi.
LANGUAGE Përmbajtja e kandidatit të përgjigjes u raportua për përdorimin e një gjuhe të pambështetur.
OTHER Arsyeja e panjohur.
BLOCKLIST Gjenerimi i tokenit u ndal sepse përmbajtja përmban terma të ndaluar.
PROHIBITED_CONTENT Prodhimi i tokenit u ndal për përmbajtje potencialisht të ndaluar.
SPII Gjenerimi i tokenit u ndal sepse përmbajtja potencialisht përmban informacione të ndjeshme personale të identifikueshme (SPII).
MALFORMED_FUNCTION_CALL Thirrja e funksionit e krijuar nga modeli është e pavlefshme.
IMAGE_SAFETY Prodhimi i tokenit u ndal sepse imazhet e krijuara përmbajnë shkelje të sigurisë.

Atribuimi i themelimit

Atribuimi për një burim që kontribuoi në një përgjigje.

Fushat
objekti sourceId object ( AttributionSourceId )

Vetëm dalje. Identifikuesi për burimin që kontribuon në këtë atribuim.

objekti content object ( Content )

Përmbajtja e burimit bazë që përbën këtë atribut.

Përfaqësimi JSON 
{
  "sourceId": {
    object (AttributionSourceId)
  },
  "content": {
    object (Content)
  }
}

AttributionSourceId

Identifikuesi për burimin që kontribuon në këtë atribuim.

Fushat
source Union type
source mund të jetë vetëm një nga sa vijon:
object ( GroundingPassageId ) groundingPassage ( GroundingPassageId )

Identifikuesi për një pasazh në linjë.

objekt semanticRetrieverChunk object ( SemanticRetrieverChunk )

Identifikuesi për një Chunk të marrë nëpërmjet Semantic Retriever.

Përfaqësimi JSON 
{

  // source
  "groundingPassage": {
    object (GroundingPassageId)
  },
  "semanticRetrieverChunk": {
    object (SemanticRetrieverChunk)
  }
  // Union type
}

GroundingPassageId

Identifikues për një pjesë brenda një GroundingPassage .

Fushat
string passageId

Vetëm dalje. ID e pasazhit që përputhet me GenerateAnswerRequest 's GroundingPassage.id .

partIndex integer

Vetëm dalje. Indeksi i pjesës brenda GenerateAnswerRequest 's GroundingPassage.content .

Përfaqësimi JSON 
{
  "passageId": string,
  "partIndex": integer
}

SemanticRetrieverChunk

Identifikuesi për një Chunk të marrë nëpërmjet Retriever Semantic të specifikuar në GenerateAnswerRequest duke përdorur SemanticRetrieverConfig .

Fushat
source string

Vetëm dalje. Emri i burimit që përputhet me SemanticRetrieverConfig.source të kërkesës. Shembull: corpora/123 ose corpora/123/documents/abc

string chunk

Vetëm dalje. Emri i Chunk që përmban tekstin e atribuar. Shembull: corpora/123/documents/abc/chunks/xyz

Përfaqësimi JSON 
{
  "source": string,
  "chunk": string
}

GroundingMetadata

Metadatat i kthehen klientit kur aktivizohet tokëzimi.

Fushat
object ( GroundingChunk ) groundingChunks[] ( GroundingChunk )

Lista e referencave mbështetëse të marra nga burimi i specifikuar i tokëzimit.

objekti groundingSupports[] object ( GroundingSupport )

Lista e mbështetjes së tokëzimit.

string webSearchQueries[]

Pyetjet e kërkimit në ueb për kërkimin vijues në ueb.

objekt searchEntryPoint object ( SearchEntryPoint )

Fakultative. Hyrja e kërkimit në Google për kërkimet vijuese në ueb.

retrievalMetadata object ( RetrievalMetadata )

Meta të dhënat që lidhen me marrjen në rrjedhën e tokëzimit.

Përfaqësimi JSON 
{
  "groundingChunks": [
    {
      object (GroundingChunk)
    }
  ],
  "groundingSupports": [
    {
      object (GroundingSupport)
    }
  ],
  "webSearchQueries": [
    string
  ],
  "searchEntryPoint": {
    object (SearchEntryPoint)
  },
  "retrievalMetadata": {
    object (RetrievalMetadata)
  }
}

SearchEntryPoint

Pika hyrëse e kërkimit në Google.

Fushat
renderedContent string përmbajtjes

Fakultative. Pjesë e përmbajtjes së uebit që mund të futet në një faqe interneti ose në një pamje ueb aplikacioni.

vargu sdkBlob string ( bytes format)

Fakultative. Base64 i koduar JSON që përfaqëson grupin e <term kërkimi, url kërkimi> tuple.

Një varg i koduar me bazë 64.

Përfaqësimi JSON 
{
  "renderedContent": string,
  "sdkBlob": string
}

GroundingChunk

Copë e tokëzimit.

Fushat
chunk_type Union type
Lloji i copës. chunk_type mund të jetë vetëm një nga sa vijon:
objekt web object ( Web )

Një pjesë e tokëzimit nga uebi.

Përfaqësimi JSON 
{

  // chunk_type
  "web": {
    object (Web)
  }
  // Union type
}

Web

Pjesë nga uebi.

Fushat
string uri

Referenca URI e pjesës.

string title

Titulli i pjesës.

Përfaqësimi JSON 
{
  "uri": string,
  "title": string
}

Mbështetja e Tokës

Mbështetja e tokëzimit.

Fushat
groundingChunkIndices[] integer

Një listë indeksesh (në 'grounding_chunk') që specifikon citimet që lidhen me pretendimin. Për shembull, [1,3,4] do të thotë që tokëzimi_copë[1], tokëzimi_copë[3], tokëzimi_copë[4] janë përmbajtja e marrë që i atribuohet pretendimit.

number confidenceScores[]

Rezultati i besimit të referencave mbështetëse. Vargjet nga 0 në 1. 1 është më i sigurti. Kjo listë duhet të ketë të njëjtën madhësi si indekset e tokëzimitChunk.

objekt segment object ( Segment )

Segmenti i përmbajtjes së cilës i përket kjo mbështetje.

Përfaqësimi JSON 
{
  "groundingChunkIndices": [
    integer
  ],
  "confidenceScores": [
    number
  ],
  "segment": {
    object (Segment)
  }
}

Segmenti

Segmenti i përmbajtjes.

Fushat
partIndex integer

Vetëm dalje. Indeksi i një objekti Part brenda objektit të tij mëmë Përmbajtje.

startIndex integer

Vetëm dalje. Indeksi i fillimit në pjesën e dhënë, i matur në bajt. Kompensimi nga fillimi i Pjesës, përfshirëse, duke filluar nga zero.

endIndex integer

Vetëm dalje. Indeksi i fundit në pjesën e dhënë, i matur në bajt. Kompensimi nga fillimi i Pjesës, ekskluziv, duke filluar nga zero.

string text

Vetëm dalje. Teksti që korrespondon me segmentin nga përgjigja.

Përfaqësimi JSON 
{
  "partIndex": integer,
  "startIndex": integer,
  "endIndex": integer,
  "text": string
}

RetrievalMetadata

Meta të dhënat që lidhen me marrjen në rrjedhën e tokëzimit.

Fushat
number googleSearchDynamicRetrievalScore

Fakultative. Rezultati që tregon se sa e mundshme informacioni nga kërkimi në Google mund të ndihmojë në përgjigjen e kërkesës. Rezultati është në intervalin [0, 1], ku 0 është më pak e mundshme dhe 1 është më e mundshme. Ky rezultat plotësohet vetëm kur aktivizohet baza e kërkimit në Google dhe rikthimi dinamik. Do të krahasohet me pragun për të përcaktuar nëse do të aktivizohet kërkimi në Google.

Përfaqësimi JSON 
{
  "googleSearchDynamicRetrievalScore": number
}

Rezultati i problemeve të ditarit

Rezultati i problemit të ditarit

Fushat
topCandidates[] object ( TopCandidates )

Gjatësia = numri i përgjithshëm i hapave të dekodimit.

chosenCandidates[] object ( Candidate )

Gjatësia = numri i përgjithshëm i hapave të dekodimit. Kandidatët e zgjedhur mund të jenë ose jo në topKandidatët.

Përfaqësimi JSON 
{
  "topCandidates": [
    {
      object (TopCandidates)
    }
  ],
  "chosenCandidates": [
    {
      object (Candidate)
    }
  ]
}

Top Kandidatët

Kandidatët me probabilitete të regjistrit kryesor në çdo hap të dekodimit.

Fushat
candidates[] object ( Candidate )

Renditur sipas probabilitetit të regjistrit në rend zbritës.

Përfaqësimi JSON 
{
  "candidates": [
    {
      object (Candidate)
    }
  ]
}

Kandidati

Kandidati për shenjën dhe pikën logprobs.

Fushat
string token

Vlera e vargut token të kandidatit.

integer tokenId

Vlera e ID-së së kandidatit.

log number logProbability

Probabiliteti i regjistrit të kandidatit.

Përfaqësimi JSON 
{
  "token": string,
  "tokenId": integer,
  "logProbability": number
}

UrlContextMetadata

Të dhënat meta të lidhura me mjetin e rikthimit të kontekstit url.

Fushat
urlMetadata[] object ( UrlMetadata )

Lista e kontekstit url.

Përfaqësimi JSON 
{
  "urlMetadata": [
    {
      object (UrlMetadata)
    }
  ]
}

UrlMetadata

Konteksti i rikthimit të një url të vetëm.

Fushat
vargu i retrievedUrl string

Url-ja e marrë nga mjeti.

urlRetrievalStatus enum ( UrlRetrievalStatus )

Statusi i marrjes së URL-së.

Përfaqësimi JSON 
{
  "retrievedUrl": string,
  "urlRetrievalStatus": enum (UrlRetrievalStatus)
}

UrlRetrieval Status

Statusi i marrjes së URL-së.

Enums
URL_RETRIEVAL_STATUS_UNSPECIFIED Vlera e paracaktuar. Kjo vlerë është e papërdorur.
URL_RETRIEVAL_STATUS_SUCCESS Rikthimi i URL-së është i suksesshëm.
URL_RETRIEVAL_STATUS_ERROR Rikthimi i URL-së dështoi për shkak të gabimit.

Metadatat e Citimit

Një koleksion i atributeve burimore për një pjesë të përmbajtjes.

Fushat
citationSources[] object ( CitationSource )

Citime në burime për një përgjigje specifike.

Përfaqësimi JSON 
{
  "citationSources": [
    {
      object (CitationSource)
    }
  ]
}

Burimi i Citimit

Një citim në një burim për një pjesë të një përgjigje specifike.

Fushat
startIndex integer

Fakultative. Fillimi i segmentit të përgjigjes që i atribuohet këtij burimi.

Indeksi tregon fillimin e segmentit, i matur në bajt.

endIndex integer

Fakultative. Fundi i segmentit të atribuar, ekskluziv.

string uri

Fakultative. URI që atribuohet si burim për një pjesë të tekstit.

string license

Fakultative. Licenca për projektin GitHub që i atribuohet si burim për segmentin.

Informacioni i licencës kërkohet për citimet e kodit.

Përfaqësimi JSON 
{
  "startIndex": integer,
  "endIndex": integer,
  "uri": string,
  "license": string
}

Burimi REST: tufa

Burimi: Operacioni

Ky burim përfaqëson një operacion afatgjatë që është rezultat i një thirrjeje API të rrjetit.

Fushat
string name

Emri i caktuar nga serveri, i cili është unik vetëm brenda të njëjtit shërbim që e kthen fillimisht. Nëse përdorni hartën e paracaktuar HTTP, name duhet të jetë një emër burimi që përfundon me operations/{unique_id} .

object metadata

Të dhënat meta specifike të shërbimit të lidhura me operacionin. Zakonisht përmban informacione për përparimin dhe meta të dhëna të zakonshme, siç është koha e krijimit. Disa shërbime mund të mos ofrojnë të dhëna të tilla. Çdo metodë që kthen një operacion afatgjatë duhet të dokumentojë llojin e meta të dhënave, nëse ka.

Një objekt që përmban fusha të një lloji arbitrar. Një fushë shtesë "@type" përmban një URI që identifikon llojin. Shembull: { "id": 1234, "@type": "types.example.com/standard/id" } .

done boolean

Nëse vlera është false , do të thotë se operacioni është ende në proces. Nëse true , operacioni përfundon dhe ka error ose response .

result Union type
Rezultati i operacionit, i cili mund të jetë ose një error ose një response e vlefshme. Nëse done == false , nuk vendoset as error dhe as response . Nëse done == true , mund të vendoset saktësisht një nga error ose response . Disa shërbime mund të mos japin rezultat. result mund të jetë vetëm një nga sa vijon:
error object ( Status )

Rezultati i gabimit të operacionit në rast dështimi ose anulimi.

object response

Përgjigja normale, e suksesshme e operacionit. Nëse metoda origjinale nuk kthen të dhëna për sukses, si p.sh. Delete , përgjigja është google.protobuf.Empty . Nëse metoda origjinale është standarde Get / Create / Update , përgjigja duhet të jetë burimi. Për metodat e tjera, përgjigja duhet të ketë llojin XxxResponse , ku Xxx është emri origjinal i metodës. Për shembull, nëse emri origjinal i metodës është TakeSnapshot() , lloji i përgjigjes së supozuar është TakeSnapshotResponse .

Një objekt që përmban fusha të një lloji arbitrar. Një fushë shtesë "@type" përmban një URI që identifikon llojin. Shembull: { "id": 1234, "@type": "types.example.com/standard/id" } .

Përfaqësimi JSON 
{
  "name": string,
  "metadata": {
    "@type": string,
    field1: ...,
    ...
  },
  "done": boolean,

  // result
  "error": {
    object (Status)
  },
  "response": {
    "@type": string,
    field1: ...,
    ...
  }
  // Union type
}

Metoda: tufa.merr

Merr gjendjen më të fundit të një operacioni afatgjatë. Klientët mund ta përdorin këtë metodë për të anketuar rezultatin e operacionit në intervale, siç rekomandohet nga shërbimi API.

Pika përfundimtare

merrni https: / /generativelanguage.googleapis.com /v1beta /{name=batches /*}

Parametrat e rrugës

string name

Emri i burimit të operacionit. Ajo merr formën batches/{batches} .

Trupi i kërkesës

Trupi i kërkesës duhet të jetë bosh.

Trupi i reagimit

Nëse është i suksesshëm, trupi i përgjigjes përmban një shembull të Operation .

Metoda: tufa.lista

Liston operacionet që përputhen me filtrin e specifikuar në kërkesë. Nëse serveri nuk e mbështet këtë metodë, ai kthehet UNIMPLEMENTED .

Pika përfundimtare

merrni https: / /generativelanguage.googleapis.com /v1beta /{name=batches}

Parametrat e rrugës

string name

Emri i burimit mëmë të operacionit. Ajo merr formën batches .

Parametrat e pyetjes

string filter

Filtri standard i listës.

integer pageSize

Madhësia standarde e faqes së listës.

vargu string pageToken

Shenja standarde e faqes së listës.

Trupi i kërkesës

Trupi i kërkesës duhet të jetë bosh.

Trupi i reagimit

Nëse është i suksesshëm, trupi i përgjigjes përmban një shembull të ListOperationsResponse .

Metoda: tufa.anuloj

Fillon anulimin asinkron në një operacion afatgjatë. Serveri bën përpjekjet më të mira për të anuluar operacionin, por suksesi nuk është i garantuar. Nëse serveri nuk e mbështet këtë metodë, ai kthen google.rpc.Code.UNIMPLEMENTED . Klientët mund të përdorin Operations.GetOperation ose metoda të tjera për të kontrolluar nëse anulimi pati sukses ose nëse operacioni përfundoi pavarësisht anulimit. Me anulim të suksesshëm, operacioni nuk fshihet; në vend të kësaj, ai bëhet një operacion me një vlerë Operation.error me një 1 google.rpc.Status.code , që korrespondon me Code.CANCELLED .

Pika përfundimtare

postoni https: / /generativelanguage.googleapis.com /v1beta /{name=batches /*}:cancel

Parametrat e rrugës

string name

Emri i burimit të operacionit që do të anulohet. Ajo merr formën batches/{batches} .

Trupi i kërkesës

Trupi i kërkesës duhet të jetë bosh.

Trupi i reagimit

Nëse është i suksesshëm, trupi i përgjigjes është një objekt JSON bosh.

Metoda: tufa.fshij

Fshin një operacion të gjatë. Kjo metodë tregon se klienti nuk është më i interesuar për rezultatin e operacionit. Nuk e anulon operacionin. Nëse serveri nuk e mbështet këtë metodë, ai kthen google.rpc.Code.UNIMPLEMENTED .

Pika përfundimtare

fshi https: / /generativelanguage.googleapis.com /v1beta /{name=batches /*}

Parametrat e rrugës

string name

Emri i burimit të operacionit që do të fshihet. Ajo merr formën batches/{batches} .

Trupi i kërkesës

Trupi i kërkesës duhet të jetë bosh.

Trupi i reagimit

Nëse është i suksesshëm, trupi i përgjigjes është një objekt JSON bosh.

,

Gemini API mbështet modalitetin e grupit, i cili ju lejon të përpunoni kërkesa të shumta në një telefonatë të vetme. Për më shumë detaje, shihni udhëzuesin e modalitetit të grupit .

Kandidati

Një kandidat përgjigjeje i krijuar nga modeli.

Fushat
objekti content object ( Content )

Vetëm dalje. Përmbajtja e gjeneruar e kthyer nga modeli.

finishReason enum ( FinishReason )

Fakultative. Vetëm dalje. Arsyeja pse modeli ndaloi gjenerimin e argumenteve.

Nëse është bosh, modeli nuk ka ndaluar së gjeneruari shenja.

Objekt safetyRatings[] object ( SafetyRating )

Lista e vlerësimeve për sigurinë e një kandidati të përgjigjes.

Ka më së shumti një vlerësim për kategori.

citationMetadata object ( CitationMetadata )

Vetëm dalje. Informacioni i citimit për kandidatin e krijuar nga modeli.

Kjo fushë mund të plotësohet me informacion recitimi për çdo tekst të përfshirë në content . Këto janë pasazhe që janë "recituar" nga materiali me të drejtë autori në të dhënat e trajnimit të LLM-së.

tokenCount integer

Vetëm dalje. Numërimi simbolik për këtë kandidat.

groundingAttributions[] object ( GroundingAttribution )

Vetëm dalje. Informacioni i atribuimit për burimet që kontribuan në një përgjigje të bazuar.

Kjo fushë është e mbushur për thirrjet GenerateAnswer .

object ( GroundingMetadata ) groundingMetadata ( GroundingMetadata )

Vetëm dalje. Meta të dhënat bazë për kandidatin.

Kjo fushë është e mbushur për thirrjet GenerateContent .

number avgLogprobs

Vetëm dalje. Rezultati mesatar i probabilitetit log të kandidatit.

logprobsResult object ( LogprobsResult )

Vetëm dalje. Rezultatet e gjasave të regjistrit për argumentet e përgjigjes dhe shenjat kryesore

urlContextMetadata object ( UrlContextMetadata )

Vetëm dalje. Të dhënat meta të lidhura me mjetin e rikthimit të kontekstit url.

index integer

Vetëm dalje. Indeksi i kandidatit në listën e kandidatëve të përgjigjeve.

Përfaqësimi JSON 
{
  "content": {
    object (Content)
  },
  "finishReason": enum (FinishReason),
  "safetyRatings": [
    {
      object (SafetyRating)
    }
  ],
  "citationMetadata": {
    object (CitationMetadata)
  },
  "tokenCount": integer,
  "groundingAttributions": [
    {
      object (GroundingAttribution)
    }
  ],
  "groundingMetadata": {
    object (GroundingMetadata)
  },
  "avgLogprobs": number,
  "logprobsResult": {
    object (LogprobsResult)
  },
  "urlContextMetadata": {
    object (UrlContextMetadata)
  },
  "index": integer
}

PërfundoArsyeja

Përcakton arsyen pse modeli ndaloi gjenerimin e argumenteve.

Enums
FINISH_REASON_UNSPECIFIED Vlera e paracaktuar. Kjo vlerë është e papërdorur.
STOP Pika natyrore e ndalimit të modelit ose sekuenca e parashikuar e ndalimit.
MAX_TOKENS U arrit numri maksimal i argumenteve siç specifikohet në kërkesë.
SAFETY Përmbajtja e kandidatit të përgjigjes u raportua për arsye sigurie.
RECITATION Përmbajtja e kandidatit të përgjigjes u shënua për arsye recitimi.
LANGUAGE Përmbajtja e kandidatit të përgjigjes u raportua për përdorimin e një gjuhe të pambështetur.
OTHER Arsyeja e panjohur.
BLOCKLIST Gjenerimi i tokenit u ndal sepse përmbajtja përmban terma të ndaluar.
PROHIBITED_CONTENT Prodhimi i tokenit u ndal për përmbajtje potencialisht të ndaluar.
SPII Gjenerimi i tokenit u ndal sepse përmbajtja potencialisht përmban informacione të ndjeshme personale të identifikueshme (SPII).
MALFORMED_FUNCTION_CALL Thirrja e funksionit e krijuar nga modeli është e pavlefshme.
IMAGE_SAFETY Prodhimi i tokenit u ndal sepse imazhet e krijuara përmbajnë shkelje të sigurisë.

Atribuimi i themelimit

Atribuimi për një burim që kontribuoi në një përgjigje.

Fushat
objekti sourceId object ( AttributionSourceId )

Vetëm dalje. Identifikuesi për burimin që kontribuon në këtë atribuim.

objekti content object ( Content )

Përmbajtja e burimit bazë që përbën këtë atribut.

Përfaqësimi JSON 
{
  "sourceId": {
    object (AttributionSourceId)
  },
  "content": {
    object (Content)
  }
}

AttributionSourceId

Identifikuesi për burimin që kontribuon në këtë atribuim.

Fushat
source Union type
source mund të jetë vetëm një nga sa vijon:
object ( GroundingPassageId ) groundingPassage ( GroundingPassageId )

Identifikuesi për një pasazh në linjë.

objekt semanticRetrieverChunk object ( SemanticRetrieverChunk )

Identifikuesi për një Chunk të marrë nëpërmjet Semantic Retriever.

Përfaqësimi JSON 
{

  // source
  "groundingPassage": {
    object (GroundingPassageId)
  },
  "semanticRetrieverChunk": {
    object (SemanticRetrieverChunk)
  }
  // Union type
}

GroundingPassageId

Identifikues për një pjesë brenda një GroundingPassage .

Fushat
string passageId

Vetëm dalje. ID e pasazhit që përputhet me GenerateAnswerRequest 's GroundingPassage.id .

partIndex integer

Vetëm dalje. Indeksi i pjesës brenda GenerateAnswerRequest 's GroundingPassage.content .

Përfaqësimi JSON 
{
  "passageId": string,
  "partIndex": integer
}

SemanticRetrieverChunk

Identifikuesi për një Chunk të marrë nëpërmjet Retriever Semantic të specifikuar në GenerateAnswerRequest duke përdorur SemanticRetrieverConfig .

Fushat
source string

Vetëm dalje. Emri i burimit që përputhet me SemanticRetrieverConfig.source të kërkesës. Shembull: corpora/123 ose corpora/123/documents/abc

string chunk

Vetëm dalje. Emri i Chunk që përmban tekstin e atribuar. Shembull: corpora/123/documents/abc/chunks/xyz

Përfaqësimi JSON 
{
  "source": string,
  "chunk": string
}

GroundingMetadata

Metadatat i kthehen klientit kur aktivizohet tokëzimi.

Fushat
object ( GroundingChunk ) groundingChunks[] ( GroundingChunk )

Lista e referencave mbështetëse të marra nga burimi i specifikuar i tokëzimit.

objekti groundingSupports[] object ( GroundingSupport )

Lista e mbështetjes së tokëzimit.

string webSearchQueries[]

Pyetjet e kërkimit në ueb për kërkimin vijues në ueb.

objekt searchEntryPoint object ( SearchEntryPoint )

Fakultative. Hyrja e kërkimit në Google për kërkimet vijuese në ueb.

retrievalMetadata object ( RetrievalMetadata )

Meta të dhënat që lidhen me marrjen në rrjedhën e tokëzimit.

Përfaqësimi JSON 
{
  "groundingChunks": [
    {
      object (GroundingChunk)
    }
  ],
  "groundingSupports": [
    {
      object (GroundingSupport)
    }
  ],
  "webSearchQueries": [
    string
  ],
  "searchEntryPoint": {
    object (SearchEntryPoint)
  },
  "retrievalMetadata": {
    object (RetrievalMetadata)
  }
}

SearchEntryPoint

Pika hyrëse e kërkimit në Google.

Fushat
renderedContent string përmbajtjes

Fakultative. Pjesë e përmbajtjes së uebit që mund të futet në një faqe interneti ose në një pamje ueb aplikacioni.

vargu sdkBlob string ( bytes format)

Fakultative. Base64 i koduar JSON që përfaqëson grupin e <term kërkimi, url kërkimi> tuple.

Një varg i koduar me bazë 64.

Përfaqësimi JSON 
{
  "renderedContent": string,
  "sdkBlob": string
}

GroundingChunk

Copë e tokëzimit.

Fushat
chunk_type Union type
Lloji i copës. chunk_type mund të jetë vetëm një nga sa vijon:
objekt web object ( Web )

Një pjesë e tokëzimit nga uebi.

Përfaqësimi JSON 
{

  // chunk_type
  "web": {
    object (Web)
  }
  // Union type
}

Web

Pjesë nga uebi.

Fushat
string uri

Referenca URI e pjesës.

string title

Titulli i pjesës.

Përfaqësimi JSON 
{
  "uri": string,
  "title": string
}

Mbështetja e Tokës

Mbështetja e tokëzimit.

Fushat
groundingChunkIndices[] integer

Një listë indeksesh (në 'grounding_chunk') që specifikon citimet që lidhen me pretendimin. Për shembull, [1,3,4] do të thotë që tokëzimi_copë[1], tokëzimi_copë[3], tokëzimi_copë[4] janë përmbajtja e marrë që i atribuohet pretendimit.

number confidenceScores[]

Rezultati i besimit të referencave mbështetëse. Vargjet nga 0 në 1. 1 është më i sigurti. Kjo listë duhet të ketë të njëjtën madhësi si indekset e tokëzimitChunk.

objekt segment object ( Segment )

Segmenti i përmbajtjes së cilës i përket kjo mbështetje.

Përfaqësimi JSON 
{
  "groundingChunkIndices": [
    integer
  ],
  "confidenceScores": [
    number
  ],
  "segment": {
    object (Segment)
  }
}

Segmenti

Segmenti i përmbajtjes.

Fushat
partIndex integer

Vetëm dalje. Indeksi i një objekti Part brenda objektit të tij mëmë Përmbajtje.

startIndex integer

Vetëm dalje. Indeksi i fillimit në pjesën e dhënë, i matur në bajt. Kompensimi nga fillimi i Pjesës, përfshirëse, duke filluar nga zero.

endIndex integer

Vetëm dalje. Indeksi i fundit në pjesën e dhënë, i matur në bajt. Kompensimi nga fillimi i Pjesës, ekskluziv, duke filluar nga zero.

string text

Vetëm dalje. Teksti që korrespondon me segmentin nga përgjigja.

Përfaqësimi JSON 
{
  "partIndex": integer,
  "startIndex": integer,
  "endIndex": integer,
  "text": string
}

RetrievalMetadata

Meta të dhënat që lidhen me marrjen në rrjedhën e tokëzimit.

Fushat
number googleSearchDynamicRetrievalScore

Fakultative. Rezultati që tregon se sa e mundshme informacioni nga kërkimi në Google mund të ndihmojë në përgjigjen e kërkesës. Rezultati është në intervalin [0, 1], ku 0 është më pak e mundshme dhe 1 është më e mundshme. Ky rezultat plotësohet vetëm kur aktivizohet baza e kërkimit në Google dhe rikthimi dinamik. Do të krahasohet me pragun për të përcaktuar nëse do të aktivizohet kërkimi në Google.

Përfaqësimi JSON 
{
  "googleSearchDynamicRetrievalScore": number
}

Rezultati i problemeve të ditarit

Rezultati i problemit të ditarit

Fushat
topCandidates[] object ( TopCandidates )

Gjatësia = numri i përgjithshëm i hapave të dekodimit.

chosenCandidates[] object ( Candidate )

Gjatësia = numri i përgjithshëm i hapave të dekodimit. Kandidatët e zgjedhur mund të jenë ose jo në topKandidatët.

Përfaqësimi JSON 
{
  "topCandidates": [
    {
      object (TopCandidates)
    }
  ],
  "chosenCandidates": [
    {
      object (Candidate)
    }
  ]
}

Top Kandidatët

Kandidatët me probabilitete të regjistrit kryesor në çdo hap të dekodimit.

Fushat
candidates[] object ( Candidate )

Renditur sipas probabilitetit të regjistrit në rend zbritës.

Përfaqësimi JSON 
{
  "candidates": [
    {
      object (Candidate)
    }
  ]
}

Kandidati

Kandidati për shenjën dhe pikën logprobs.

Fushat
string token

Vlera e vargut token të kandidatit.

integer tokenId

Vlera e ID-së së kandidatit.

log number logProbability

Probabiliteti i regjistrit të kandidatit.

Përfaqësimi JSON 
{
  "token": string,
  "tokenId": integer,
  "logProbability": number
}

UrlContextMetadata

Të dhënat meta të lidhura me mjetin e rikthimit të kontekstit url.

Fushat
urlMetadata[] object ( UrlMetadata )

Lista e kontekstit url.

Përfaqësimi JSON 
{
  "urlMetadata": [
    {
      object (UrlMetadata)
    }
  ]
}

UrlMetadata

Konteksti i rikthimit të një url të vetëm.

Fushat
vargu i retrievedUrl string

Url-ja e marrë nga mjeti.

urlRetrievalStatus enum ( UrlRetrievalStatus )

Statusi i marrjes së URL-së.

Përfaqësimi JSON 
{
  "retrievedUrl": string,
  "urlRetrievalStatus": enum (UrlRetrievalStatus)
}

UrlRetrieval Status

Statusi i marrjes së URL-së.

Enums
URL_RETRIEVAL_STATUS_UNSPECIFIED Vlera e paracaktuar. Kjo vlerë është e papërdorur.
URL_RETRIEVAL_STATUS_SUCCESS Rikthimi i URL-së është i suksesshëm.
URL_RETRIEVAL_STATUS_ERROR Rikthimi i URL-së dështoi për shkak të gabimit.

Metadatat e Citimit

Një koleksion i atributeve burimore për një pjesë të përmbajtjes.

Fushat
citationSources[] object ( CitationSource )

Citime në burime për një përgjigje specifike.

Përfaqësimi JSON 
{
  "citationSources": [
    {
      object (CitationSource)
    }
  ]
}

Burimi i Citimit

Një citim në një burim për një pjesë të një përgjigje specifike.

Fushat
startIndex integer

Fakultative. Fillimi i segmentit të përgjigjes që i atribuohet këtij burimi.

Indeksi tregon fillimin e segmentit, i matur në bajt.

endIndex integer

Fakultative. Fundi i segmentit të atribuar, ekskluziv.

string uri

Fakultative. URI që atribuohet si burim për një pjesë të tekstit.

string license

Fakultative. Licenca për projektin GitHub që i atribuohet si burim për segmentin.

Informacioni i licencës kërkohet për citimet e kodit.

Përfaqësimi JSON 
{
  "startIndex": integer,
  "endIndex": integer,
  "uri": string,
  "license": string
}

Burimi REST: tufa

Burimi: Operacioni

Ky burim përfaqëson një operacion afatgjatë që është rezultat i një thirrjeje API të rrjetit.

Fushat
string name

Emri i caktuar nga serveri, i cili është unik vetëm brenda të njëjtit shërbim që e kthen fillimisht. Nëse përdorni hartën e paracaktuar HTTP, name duhet të jetë një emër burimi që përfundon me operations/{unique_id} .

object metadata

Të dhënat meta specifike të shërbimit të lidhura me operacionin. Zakonisht përmban informacione për përparimin dhe meta të dhëna të zakonshme, siç është koha e krijimit. Disa shërbime mund të mos ofrojnë të dhëna të tilla. Çdo metodë që kthen një operacion afatgjatë duhet të dokumentojë llojin e meta të dhënave, nëse ka.

Një objekt që përmban fusha të një lloji arbitrar. Një fushë shtesë "@type" përmban një URI që identifikon llojin. Shembull: { "id": 1234, "@type": "types.example.com/standard/id" } .

done boolean

Nëse vlera është false , do të thotë se operacioni është ende në proces. Nëse true , operacioni përfundon dhe ka error ose response .

result Union type
Rezultati i operacionit, i cili mund të jetë ose një error ose një response e vlefshme. Nëse done == false , nuk vendoset as error dhe as response . Nëse done == true , mund të vendoset saktësisht një nga error ose response . Disa shërbime mund të mos japin rezultat. result mund të jetë vetëm një nga sa vijon:
error object ( Status )

Rezultati i gabimit të operacionit në rast dështimi ose anulimi.

object response

Përgjigja normale, e suksesshme e operacionit. Nëse metoda origjinale nuk kthen të dhëna për sukses, si p.sh. Delete , përgjigja është google.protobuf.Empty . Nëse metoda origjinale është standarde Get / Create / Update , përgjigja duhet të jetë burimi. Për metodat e tjera, përgjigja duhet të ketë llojin XxxResponse , ku Xxx është emri origjinal i metodës. Për shembull, nëse emri origjinal i metodës është TakeSnapshot() , lloji i përgjigjes së supozuar është TakeSnapshotResponse .

Një objekt që përmban fusha të një lloji arbitrar. Një fushë shtesë "@type" përmban një URI që identifikon llojin. Shembull: { "id": 1234, "@type": "types.example.com/standard/id" } .

Përfaqësimi JSON 
{
  "name": string,
  "metadata": {
    "@type": string,
    field1: ...,
    ...
  },
  "done": boolean,

  // result
  "error": {
    object (Status)
  },
  "response": {
    "@type": string,
    field1: ...,
    ...
  }
  // Union type
}

Metoda: tufa.merr

Merr gjendjen më të fundit të një operacioni afatgjatë. Klientët mund ta përdorin këtë metodë për të anketuar rezultatin e operacionit në intervale, siç rekomandohet nga shërbimi API.

Pika përfundimtare

merrni https: / /generativelanguage.googleapis.com /v1beta /{name=batches /*}

Parametrat e rrugës

string name

Emri i burimit të operacionit. Ajo merr formën batches/{batches} .

Trupi i kërkesës

Trupi i kërkesës duhet të jetë bosh.

Trupi i reagimit

Nëse është i suksesshëm, trupi i përgjigjes përmban një shembull të Operation .

Metoda: tufa.lista

Liston operacionet që përputhen me filtrin e specifikuar në kërkesë. Nëse serveri nuk e mbështet këtë metodë, ai kthehet UNIMPLEMENTED .

Pika përfundimtare

merrni https: / /generativelanguage.googleapis.com /v1beta /{name=batches}

Parametrat e rrugës

string name

Emri i burimit mëmë të operacionit. Ajo merr formën batches .

Parametrat e pyetjes

string filter

Filtri standard i listës.

integer pageSize

Madhësia standarde e faqes së listës.

vargu string pageToken

Shenja standarde e faqes së listës.

Trupi i kërkesës

Trupi i kërkesës duhet të jetë bosh.

Trupi i reagimit

Nëse është i suksesshëm, trupi i përgjigjes përmban një shembull të ListOperationsResponse .

Metoda: tufa.anuloj

Fillon anulimin asinkron në një operacion afatgjatë. Serveri bën përpjekjet më të mira për të anuluar operacionin, por suksesi nuk është i garantuar. Nëse serveri nuk e mbështet këtë metodë, ai kthen google.rpc.Code.UNIMPLEMENTED . Klientët mund të përdorin Operations.GetOperation ose metoda të tjera për të kontrolluar nëse anulimi pati sukses ose nëse operacioni përfundoi pavarësisht anulimit. Me anulim të suksesshëm, operacioni nuk fshihet; në vend të kësaj, ai bëhet një operacion me një vlerë Operation.error me një 1 google.rpc.Status.code , që korrespondon me Code.CANCELLED .

Pika përfundimtare

postoni https: / /generativelanguage.googleapis.com /v1beta /{name=batches /*}:cancel

Parametrat e rrugës

string name

Emri i burimit të operacionit që do të anulohet. Ajo merr formën batches/{batches} .

Trupi i kërkesës

Trupi i kërkesës duhet të jetë bosh.

Trupi i reagimit

Nëse është i suksesshëm, trupi i përgjigjes është një objekt JSON bosh.

Metoda: tufa.fshij

Fshin një operacion të gjatë. Kjo metodë tregon se klienti nuk është më i interesuar për rezultatin e operacionit. Nuk e anulon operacionin. Nëse serveri nuk e mbështet këtë metodë, ai kthen google.rpc.Code.UNIMPLEMENTED .

Pika përfundimtare

fshi https: / /generativelanguage.googleapis.com /v1beta /{name=batches /*}

Parametrat e rrugës

string name

Emri i burimit të operacionit që do të fshihet. Ajo merr formën batches/{batches} .

Trupi i kërkesës

Trupi i kërkesës duhet të jetë bosh.

Trupi i reagimit

Nëse është i suksesshëm, trupi i përgjigjes është një objekt JSON bosh.