Batch API

API-ja Gemini mbështet API-të e grupeve, të cilat ju lejojnë të përpunoni kërkesa të shumëfishta në një thirrje të vetme. Për më shumë detaje, shihni udhëzuesin e API-t të grupeve .

Metoda: models.batchGenerateContent

Vendos në radhë një grumbull kërkesash models.generateContent për përpunim grumbull.

Pika e Fundit

posto https: / /generativelanguage.googleapis.com /v1beta /{batch.model=models /*}:batchGenerateContent

Parametrat e shtegut

string batch.model

E detyrueshme. Emri i Model që do të përdoret për gjenerimin e përfundimit.

Formati: models/{model} . Merr formën models/{model} .

Trupi i kërkesës

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

Fushat
string batch.name

Vetëm rezultati. Identifikuesi. Emri i burimit të grupit.

Formati: batches/{batchId} .

string batch.displayName

E detyrueshme. Emri i përcaktuar nga përdoruesi i këtij grupi.

object ( InputConfig ) batch.inputConfig (InputConfig)

E detyrueshme. Futja e konfigurimit të instancave në të cilat kryhet përpunimi në grup.

object ( GenerateContentBatchOutput ) batch.output (GenerateContentBatchOutput)

Vetëm rezultati. Rezultati i kërkesës së grupit.

varg batch.createTime string ( Timestamp format)

Vetëm rezultati. Koha në të cilën u krijua grupi.

Përdor RFC 3339, ku rezultati i gjeneruar do të jetë gjithmonë i normalizuar sipas Z-së dhe do të përdorë 0, 3, 6 ose 9 shifra thyesore. Pranohen edhe zhvendosje të tjera përveç "Z". Shembuj: "2014-10-02T15:01:23Z" , "2014-10-02T15:01:23.045123456Z" ose "2014-10-02T15:01:23+05:30" .

varg batch.endTime string ( Timestamp format)

Vetëm rezultati. Koha në të cilën përfundoi përpunimi në grup.

Përdor RFC 3339, ku rezultati i gjeneruar do të jetë gjithmonë i normalizuar sipas Z-së dhe do të përdorë 0, 3, 6 ose 9 shifra thyesore. Pranohen edhe zhvendosje të tjera përveç "Z". Shembuj: "2014-10-02T15:01:23Z" , "2014-10-02T15:01:23.045123456Z" ose "2014-10-02T15:01:23+05:30" .

varg batch.updateTime string ( Timestamp format)

Vetëm rezultati. Ora në të cilën grupi është përditësuar për herë të fundit.

Përdor RFC 3339, ku rezultati i gjeneruar do të jetë gjithmonë i normalizuar sipas Z-së dhe do të përdorë 0, 3, 6 ose 9 shifra thyesore. Pranohen edhe zhvendosje të tjera përveç "Z". Shembuj: "2014-10-02T15:01:23Z" , "2014-10-02T15:01:23.045123456Z" ose "2014-10-02T15:01:23+05:30" .

object ( BatchStats ) batch.batchStats (BatchStats)

Vetëm rezultate. Statistikat rreth grupit.

numërimi i batch.state enum ( BatchState )

Vetëm rezultati. Gjendja e serisë.

batch.priority string ( int64 format)

Opsionale. Prioriteti i grupit. Grupimet me një vlerë më të lartë prioriteti do të përpunohen përpara grupit me një vlerë më të ulët prioriteti. Lejohen vlera negative. Vlera parazgjedhur është 0.

Trupi i përgjigjes

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

Metoda: models.asyncBatchEmbedContent

Vendos në radhë një grumbull kërkesash models.embedContent për përpunim grumbull. Ne kemi një trajtues models.batchEmbedContents në GenerativeService , por ishte i sinkronizuar. Kështu që e quajmë këtë Async për të shmangur ngatërresën.

Pika e Fundit

posto https: / /generativelanguage.googleapis.com /v1beta /{batch.model=models /*}:asyncBatchEmbedContent

Parametrat e shtegut

string batch.model

E detyrueshme. Emri i Model që do të përdoret për gjenerimin e përfundimit.

Formati: models/{model} . Merr formën models/{model} .

Trupi i kërkesës

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

Fushat
string batch.name

Vetëm rezultati. Identifikuesi. Emri i burimit të grupit.

Formati: batches/{batchId} .

string batch.displayName

E detyrueshme. Emri i përcaktuar nga përdoruesi i këtij grupi.

object ( InputEmbedContentConfig ) batch.inputConfig (InputEmbedContentConfig)

E detyrueshme. Futja e konfigurimit të instancave në të cilat kryhet përpunimi në grup.

object ( EmbedContentBatchOutput ) batch.output (EmbedContentBatchOutput)

Vetëm rezultati. Rezultati i kërkesës së grupit.

varg batch.createTime string ( Timestamp format)

Vetëm rezultati. Koha në të cilën u krijua grupi.

Përdor RFC 3339, ku rezultati i gjeneruar do të jetë gjithmonë i normalizuar sipas Z-së dhe do të përdorë 0, 3, 6 ose 9 shifra thyesore. Pranohen edhe zhvendosje të tjera përveç "Z". Shembuj: "2014-10-02T15:01:23Z" , "2014-10-02T15:01:23.045123456Z" ose "2014-10-02T15:01:23+05:30" .

varg batch.endTime string ( Timestamp format)

Vetëm rezultati. Koha në të cilën përfundoi përpunimi në grup.

Përdor RFC 3339, ku rezultati i gjeneruar do të jetë gjithmonë i normalizuar sipas Z-së dhe do të përdorë 0, 3, 6 ose 9 shifra thyesore. Pranohen edhe zhvendosje të tjera përveç "Z". Shembuj: "2014-10-02T15:01:23Z" , "2014-10-02T15:01:23.045123456Z" ose "2014-10-02T15:01:23+05:30" .

varg batch.updateTime string ( Timestamp format)

Vetëm rezultati. Ora në të cilën grupi është përditësuar për herë të fundit.

Përdor RFC 3339, ku rezultati i gjeneruar do të jetë gjithmonë i normalizuar sipas Z-së dhe do të përdorë 0, 3, 6 ose 9 shifra thyesore. Pranohen edhe zhvendosje të tjera përveç "Z". Shembuj: "2014-10-02T15:01:23Z" , "2014-10-02T15:01:23.045123456Z" ose "2014-10-02T15:01:23+05:30" .

object ( EmbedContentBatchStats ) batch.batchStats (EmbedContentBatchStats)

Vetëm rezultate. Statistikat rreth grupit.

numërimi i batch.state enum ( BatchState )

Vetëm rezultati. Gjendja e serisë.

batch.priority string ( int64 format)

Opsionale. Prioriteti i grupit. Grupimet me një vlerë më të lartë prioriteti do të përpunohen përpara grupit me një vlerë më të ulët prioriteti. Lejohen vlera negative. Vlera parazgjedhur është 0.

Trupi i përgjigjes

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

Metoda: batches.get

Merr gjendjen më të fundit të një operacioni që është në ekzekutim të gjatë. Klientët mund ta përdorin këtë metodë për të anketuar rezultatin e operacionit në intervale të rekomanduara nga shërbimi API.

Pika e Fundit

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

Parametrat e shtegut

string name

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

Trupi i kërkesës

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

Trupi i përgjigjes

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

Metoda: batches.list

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

Pika e Fundit

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

Parametrat e shtegut

string name

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

Parametrat e pyetjes

string filter

Filtri standard i listës.

pageSize integer

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

string pageToken it

Tokeni standard i faqes së listës.

boolean returnPartialSuccess

Kur vendoset në true , operacionet që janë të arritshme kthehen si normale, dhe ato që janë të paarritshme kthehen në fushën [ListOperationsResponse.unreachable].

Kjo mund të jetë true vetëm kur lexohet nëpër koleksione, p.sh. kur parent është vendosur në "projects/example/locations/-" .

Kjo fushë nuk mbështetet si parazgjedhje dhe do të rezultojë në një gabim UNIMPLEMENTED nëse vendoset, përveç nëse dokumentohet ndryshe në mënyrë të qartë në dokumentacionin specifik të shërbimit ose produktit.

Trupi i kërkesës

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

Trupi i përgjigjes

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

Metoda: batches.cancel

Fillon anulimin asinkron në një operacion afatgjatë. Serveri bën çdo përpjekje 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. Pas anulimit të suksesshëm, operacioni nuk fshihet; në vend të kësaj, ai bëhet një operacion me një vlerë Operation.error me një google.rpc.Status.code prej 1 , që korrespondon me Code.CANCELLED .

Pika e Fundit

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

Parametrat e shtegut

string name

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

Trupi i kërkesës

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

Trupi i përgjigjes

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

Metoda: batches.delete

Fshin një operacion që është në ekzekutim të gjatë. Kjo metodë tregon që 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 e Fundit

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

Parametrat e shtegut

string name

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

Trupi i kërkesës

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

Trupi i përgjigjes

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

Gjeneroni Batch-in e Përmbajtjes

Një burim që përfaqëson një grup kërkesash GenerateContent .

Fushat
string model

E detyrueshme. Emri i Model që do të përdoret për gjenerimin e përfundimit.

Formati: models/{model} .

string name

Vetëm rezultati. Identifikuesi. Emri i burimit të grupit.

Formati: batches/{batchId} .

string displayName të Shfaqjes

E detyrueshme. Emri i përcaktuar nga përdoruesi i këtij grupi.

object ( InputConfig ) inputConfig (InputConfig)

E detyrueshme. Futja e konfigurimit të instancave në të cilat kryhet përpunimi në grup.

objekti output object ( GenerateContentBatchOutput )

Vetëm rezultati. Rezultati i kërkesës së grupit.

createTime string ( Timestamp format)

Vetëm rezultati. Koha në të cilën u krijua grupi.

Përdor RFC 3339, ku rezultati i gjeneruar do të jetë gjithmonë i normalizuar sipas Z-së dhe do të përdorë 0, 3, 6 ose 9 shifra thyesore. Pranohen edhe zhvendosje të tjera përveç "Z". Shembuj: "2014-10-02T15:01:23Z" , "2014-10-02T15:01:23.045123456Z" ose "2014-10-02T15:01:23+05:30" .

endTime Kohës së string ( Timestamp format)

Vetëm rezultati. Koha në të cilën përfundoi përpunimi në grup.

Përdor RFC 3339, ku rezultati i gjeneruar do të jetë gjithmonë i normalizuar sipas Z-së dhe do të përdorë 0, 3, 6 ose 9 shifra thyesore. Pranohen edhe zhvendosje të tjera përveç "Z". Shembuj: "2014-10-02T15:01:23Z" , "2014-10-02T15:01:23.045123456Z" ose "2014-10-02T15:01:23+05:30" .

vargu updateTime string ( Timestamp format)

Vetëm rezultati. Ora në të cilën grupi është përditësuar për herë të fundit.

Përdor RFC 3339, ku rezultati i gjeneruar do të jetë gjithmonë i normalizuar sipas Z-së dhe do të përdorë 0, 3, 6 ose 9 shifra thyesore. Pranohen edhe zhvendosje të tjera përveç "Z". Shembuj: "2014-10-02T15:01:23Z" , "2014-10-02T15:01:23.045123456Z" ose "2014-10-02T15:01:23+05:30" .

object ( BatchStats ) batchStats (BatchStats)

Vetëm rezultate. Statistikat rreth grupit.

numërimi i state enum ( BatchState )

Vetëm rezultati. Gjendja e serisë.

varg priority string ( int64 format)

Opsionale. Prioriteti i grupit. Grupimet me një vlerë më të lartë prioriteti do të përpunohen përpara grupit me një vlerë më të ulët prioriteti. Lejohen vlera negative. Vlera parazgjedhur është 0.

Përfaqësimi JSON 
{
  "model": string,
  "name": string,
  "displayName": string,
  "inputConfig": {
    object (InputConfig)
  },
  "output": {
    object (GenerateContentBatchOutput)
  },
  "createTime": string,
  "endTime": string,
  "updateTime": string,
  "batchStats": {
    object (BatchStats)
  },
  "state": enum (BatchState),
  "priority": string
}

InputConfig

Konfiguron të dhënat hyrëse për kërkesën në grup.

Fushat
Union type source
E detyrueshme. Burimi i të dhënave hyrëse. source mund të jetë vetëm një nga të mëposhtmet:
fileName string

Emri i File që përmban kërkesat e hyrjes.

objekti requests object ( InlinedRequests )

Kërkesat që do të përpunohen në grup.

Përfaqësimi JSON 
{

  // source
  "fileName": string,
  "requests": {
    object (InlinedRequests)
  }
  // Union type
}

Kërkesa të Inlineduara

Kërkesat që do të përpunohen në grup nëse ofrohen si pjesë e kërkesës për krijim të grupit.

Fushat
objekti requests[] object ( InlinedRequest )

E detyrueshme. Kërkesat që do të përpunohen në grup.

Përfaqësimi JSON 
{
  "requests": [
    {
      object (InlinedRequest)
    }
  ]
}

Kërkesë e integruar

Kërkesa që do të përpunohet në grup.

Fushat
objekti request object ( GenerateContentRequest )

E detyrueshme. Kërkesa do të përpunohet në grup.

objekti metadata object ( Struct format)

Opsionale. Meta të dhënat që do të shoqërohen me kërkesën.

Përfaqësimi JSON 
{
  "request": {
    object (GenerateContentRequest)
  },
  "metadata": {
    object
  }
}

Gjeneroni Përmbajtje BatchOutput

Rezultati i një kërkese batch. Ky rezultat kthehet në fushën BatchGenerateContentResponse ose GenerateContentBatch.output .

Fushat
Union type output
output i kërkesës së grupit mund të jetë vetëm një nga të mëposhtmet:
string i skedarit responsesFile

Vetëm rezultati. ID-ja e skedarit që përmban përgjigjet. Skedari do të jetë një skedar JSONL me një përgjigje të vetme për rresht. Përgjigjet do të jenë mesazhe GenerateContentResponse të formatuara si JSON. Përgjigjet do të shkruhen në të njëjtën renditje si kërkesat e hyrjes.

object ( InlinedResponses ) inlinedResponses (InlinedResponses)

Vetëm rezultati. Përgjigjet ndaj kërkesave në grup. Kthehet kur grupi është ndërtuar duke përdorur kërkesa të integruara. Përgjigjet do të jenë në të njëjtën renditje si kërkesat e hyrjes.

Përfaqësimi JSON 
{

  // output
  "responsesFile": string,
  "inlinedResponses": {
    object (InlinedResponses)
  }
  // Union type
}

Përgjigje të integruara

Përgjigjet ndaj kërkesave në grup.

Fushat
inlinedResponses[] object ( InlinedResponse )

Vetëm rezultate. Përgjigjet ndaj kërkesave në grup.

Përfaqësimi JSON 
{
  "inlinedResponses": [
    {
      object (InlinedResponse)
    }
  ]
}

Përgjigje e integruar

Përgjigja ndaj një kërkese të vetme në grup.

Fushat
objekti metadata object ( Struct format)

Vetëm rezultate. Meta të dhënat e shoqëruara me kërkesën.

Union type output
Rezultati i output mund të jetë vetëm një nga të mëposhtmet:
error object ( Status )

Vetëm rezultati. Gabimi i hasur gjatë përpunimit të kërkesës.

objekti response object ( GenerateContentResponse )

Vetëm rezultati. Përgjigja ndaj kërkesës.

Përfaqësimi JSON 
{
  "metadata": {
    object
  },

  // output
  "error": {
    object (Status)
  },
  "response": {
    object (GenerateContentResponse)
  }
  // Union type
}

BatchStats

Statistikat rreth grupit.

Fushat
vargu requestCount string ( int64 format)

Vetëm rezultati. Numri i kërkesave në grup.

vargu successfulRequestCount string ( int64 format)

Vetëm rezultate. Numri i kërkesave që u përpunuan me sukses.

vargu failedRequestCount string ( int64 format)

Vetëm rezultate. Numri i kërkesave që dështuan të përpunoheshin.

vargu pendingRequestCount string ( int64 format)

Vetëm rezultate. Numri i kërkesave që janë ende në pritje të përpunimit.

Përfaqësimi JSON 
{
  "requestCount": string,
  "successfulRequestCount": string,
  "failedRequestCount": string,
  "pendingRequestCount": string
}

Metoda: batches.updateEmbedContentBatch

Përditëson një grup kërkesash EmbedContent për përpunim në grup.

Pika e Fundit

përditësim https: / /generativelanguage.googleapis.com /v1beta /{embedContentBatch.name=batches /*}:updateEmbedContentBatch
PATCH https://generativelanguage.googleapis.com/v1beta/{embedContentBatch.name=batches/*}:updateEmbedContentBatch

Parametrat e shtegut

string embedContentBatch.name

Vetëm rezultati. Identifikuesi. Emri i burimit të grupit.

Formati: batches/{batchId} . Merr formën batches/{batches} .

Parametrat e pyetjes

vargu updateMask string ( FieldMask format)

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

Kjo është një listë e ndarë me presje e emrave të fushave plotësisht të kualifikuara. Shembull: "user.displayName,photo" .

Trupi i kërkesës

Trupi i kërkesës përmban një instancë të EmbedContentBatch .

Fushat
string model

E detyrueshme. Emri i Model që do të përdoret për gjenerimin e përfundimit.

Formati: models/{model} .

string displayName të Shfaqjes

E detyrueshme. Emri i përcaktuar nga përdoruesi i këtij grupi.

object ( InputEmbedContentConfig ) inputConfig (InputEmbedContentConfig)

E detyrueshme. Futja e konfigurimit të instancave në të cilat kryhet përpunimi në grup.

varg priority string ( int64 format)

Opsionale. Prioriteti i grupit. Grupimet me një vlerë më të lartë prioriteti do të përpunohen përpara grupit me një vlerë më të ulët prioriteti. Lejohen vlera negative. Vlera parazgjedhur është 0.

Trupi i përgjigjes

Nëse është e suksesshme, trupi i përgjigjes përmban një instancë të EmbedContentBatch .

Kërkesë për EmbedContent

Kërkesë që përmban Content që modeli do të integrohet.

Fushat
string model

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

Ky emër duhet të përputhet me një emër modeli të kthyer nga metoda ListModels .

Formati: models/{model}

objekti content object ( Content )

E detyrueshme. Përmbajtja që do të integrohet. Vetëm fushat parts.text do të llogariten.

taskType enum ( TaskType )

Opsionale. Lloji i detyrës opsionale për të cilën do të përdoren ngulitje. Nuk mbështetet në modelet e mëparshme ( models/embedding-001 ).

string title

Opsionale. Një titull opsional për tekstin. I zbatueshëm vetëm kur Tipi i Detyrës është RETRIEVAL_DOCUMENT .

Shënim: Specifikimi i një title për RETRIEVAL_DOCUMENT ofron ngulitje me cilësi më të mirë për rikuperim.

integer outputDimensionality

Opsionale. Dimension i reduktuar opsional për ngulitjen e daljes. Nëse vendoset, vlerat e tepërta në ngulitjen e daljes shkurtohen nga fundi. Mbështetet vetëm nga modelet më të reja që nga viti 2024. Nuk mund ta caktoni këtë vlerë nëse përdorni modelin e mëparshëm ( models/embedding-001 ).

Përfaqësimi JSON 
{
  "model": string,
  "content": {
    object (Content)
  },
  "taskType": enum (TaskType),
  "title": string,
  "outputDimensionality": integer
}

Metoda: batches.updateGenerateContentBatch

Përditëson një grup kërkesash GenerateContent për përpunim në grup.

Pika e Fundit

përditësim https: / /generativelanguage.googleapis.com /v1beta /{generateContentBatch.name=batches /*}:updateGenerateContentBatch
PATCH https://generativelanguage.googleapis.com/v1beta/{generateContentBatch.name=batches/*}:updateGenerateContentBatch

Parametrat e shtegut

string generateContentBatch.name

Vetëm rezultati. Identifikuesi. Emri i burimit të grupit.

Formati: batches/{batchId} . Merr formën batches/{batches} .

Parametrat e pyetjes

vargu updateMask string ( FieldMask format)

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

Kjo është një listë e ndarë me presje e emrave të fushave plotësisht të kualifikuara. Shembull: "user.displayName,photo" .

Trupi i kërkesës

Trupi i kërkesës përmban një instancë të GenerateContentBatch .

Fushat
string model

E detyrueshme. Emri i Model që do të përdoret për gjenerimin e përfundimit.

Formati: models/{model} .

string displayName të Shfaqjes

E detyrueshme. Emri i përcaktuar nga përdoruesi i këtij grupi.

object ( InputConfig ) inputConfig (InputConfig)

E detyrueshme. Futja e konfigurimit të instancave në të cilat kryhet përpunimi në grup.

varg priority string ( int64 format)

Opsionale. Prioriteti i grupit. Grupimet me një vlerë më të lartë prioriteti do të përpunohen përpara grupit me një vlerë më të ulët prioriteti. Lejohen vlera negative. Vlera parazgjedhur është 0.

Trupi i përgjigjes

Nëse është i suksesshëm, trupi i përgjigjes përmban një instancë të GenerateContentBatch .

Gjeneroni Kërkesë për Përmbajtje

Kërkesë për të gjeneruar një përfundim nga modeli.

Fushat
string model

E detyrueshme. Emri i Model që do të përdoret për gjenerimin e përfundimit.

Formati: models/{model} .

contents[] object ( Content )

E detyrueshme. Përmbajtja e bisedës aktuale me modelin.

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

tools[] object ( Tool )

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

Një Tool është një pjesë kodi që i mundëson sistemit të bashkëveprojë me sisteme të jashtme për të kryer një veprim, ose një sërë veprimesh, jashtë njohurive dhe fushëveprimit të Model . Tool e mbështetura janë Function dhe codeExecution . Referojuni udhëzuesve të Thirrjes së Funksionit dhe Ekzekutimit të Kodit për të mësuar më shumë.

object ( ToolConfig ) toolConfig (ToolConfig)

Opsionale. Konfigurimi i mjetit për çdo Tool të specifikuar në kërkesë. Referojuni udhëzuesit të thirrjes së funksionit për një shembull përdorimi.

objekti safetySettings[] object ( SafetySetting )

Opsionale. Një listë e instancave unike SafetySetting për bllokimin e përmbajtjes së pasigurt.

Kjo do të zbatohet në GenerateContentRequest.contents dhe GenerateContentResponse.candidates . Nuk duhet të ketë më shumë se një cilësim për secilin lloj SafetyCategory . API do të bllokojë çdo përmbajtje dhe përgjigje që nuk arrin pragjet e vendosura nga këto cilësime. Kjo listë mbivendos cilësimet fillestare për secilën SafetyCategory të specifikuar në safetyCettings. Nëse nuk ka SafetySetting për një SafetyCategory të caktuar të dhënë në listë, API do të përdorë cilësimin fillestar të sigurisë për atë kategori. Mbështeten kategoritë e dëmit HARM_CATEGORY_HATE_SPEECH, HARM_CATEGORY_SEXUALLY_EXPLICIT, HARM_CATEGORY_DANGEROUS_CONTENT, HARM_CATEGORY_HARASSMENT, HARM_CATEGORY_CIVIC_INTEGRITY. Referojuni udhëzuesit për informacion të detajuar mbi cilësimet e sigurisë në dispozicion. Referojuni gjithashtu udhëzuesit të Sigurisë për të mësuar se si të përfshini konsideratat e sigurisë në aplikacionet tuaja të IA-së.

objekti systemInstruction object ( Content )

Opsionale. Zhvilluesi ka vendosur udhëzimet e sistemit . Aktualisht, vetëm tekst.

object ( GenerationConfig ) generationConfig (GenerationConfig)

Opsionale. Opsione konfigurimi për gjenerimin e modelit dhe rezultatet.

string cachedContent

Opsionale. Emri i përmbajtjes së ruajtur në memorien e përkohshme që do të përdoret si kontekst për të shërbyer parashikimin. Formati: cachedContents/{cachedContent}

Përfaqësimi JSON 
{
  "model": string,
  "contents": [
    {
      object (Content)
    }
  ],
  "tools": [
    {
      object (Tool)
    }
  ],
  "toolConfig": {
    object (ToolConfig)
  },
  "safetySettings": [
    {
      object (SafetySetting)
    }
  ],
  "systemInstruction": {
    object (Content)
  },
  "generationConfig": {
    object (GenerationConfig)
  },
  "cachedContent": string
}

BatchState

Gjendja e serisë.

Numërime
BATCH_STATE_UNSPECIFIED Gjendja e serisë është e paspecifikuar.
BATCH_STATE_PENDING Shërbimi po përgatitet për të ekzekutuar grupin.
BATCH_STATE_RUNNING Grupi është në proces.
BATCH_STATE_SUCCEEDED Grupi u përfundua me sukses.
BATCH_STATE_FAILED Grupi dështoi.
BATCH_STATE_CANCELLED Grupi është anuluar.
BATCH_STATE_EXPIRED Grupi ka skaduar.

Burimi REST: grupe

Burimi: Operacioni

Ky burim përfaqëson një operacion afatgjatë që është rezultat i një thirrjeje të API-t 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ëzimin HTTP të parazgjedhur, name duhet të jetë një emër burimi që mbaron me operations/{unique_id} .

object metadata

Meta të dhëna specifike për shërbimin që lidhen me operacionin. Ato zakonisht përmbajnë informacion mbi progresin dhe meta të dhëna të zakonshme, siç është koha e krijimit. Disa shërbime mund të mos ofrojnë meta 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 , kjo do të thotë që operacioni është ende në vazhdim. Nëse true , operacioni ka përfunduar dhe është i disponueshëm ose 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 , as error dhe as response nuk caktohen. Nëse done == true , mund të caktohet saktësisht një nga error ose response . Disa shërbime mund të mos e japin rezultatin. result mund të jetë vetëm një nga të mëposhtmet:
error object ( Status )

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

object response

Përgjigja normale dhe e suksesshme e operacionit. Nëse metoda origjinale nuk kthen të dhëna mbi suksesin, 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 i metodës origjinale. Për shembull, nëse emri i metodës origjinale është TakeSnapshot() , lloji i përgjigjes së nxjerrë ë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
}