Batch API

Gemini API mbështet grupe API, të cilat ju lejojnë të përpunoni kërkesa të shumta në një telefonatë të vetme. Për më shumë detaje, shihni udhëzuesin Batch API .

Metoda: modele.batchGenerateContent

Vendos në radhë një grup models.generateContent kërkesa për përmbajtje për përpunim grupor.

Pika përfundimtare

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

Parametrat e rrugës

batch.model string

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

Formati: models/{model} . Ajo 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
batch.name string

Vetëm dalje. Identifikues. Emri i burimit të grupit.

Formati: batches/{batchId} .

string batch.displayName Emri

E detyrueshme. Emri i përcaktuar nga përdoruesi i kësaj baze.

object ( InputConfig ) batch.inputConfig (InputConfig)

E detyrueshme. Konfigurimi i hyrjes së rasteve në të cilat kryhet përpunimi në grup.

object ( GenerateContentBatchOutput ) batch.output ( GenerateContentBatchOutput )

Vetëm dalje. Prodhimi i kërkesës së grupit.

vargu batch.createTime string ( Timestamp format)

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

Përdor RFC 3339, ku prodhimi i gjeneruar gjithmonë do të normalizohet me Z dhe do të përdorë 0, 3, 6 ose 9 shifra të pjesshme. Kompensimet e tjera përveç "Z" pranohen gjithashtu. Shembuj: "2014-10-02T15:01:23Z" , "2014-10-02T15:01:23.045123456Z" ose "2014-10-02T15:01:23+05:30" .

Vargu batch.endTime string ( Timestamp format)

Vetëm dalje. Koha në të cilën përfundoi përpunimi i grupit.

Përdor RFC 3339, ku prodhimi i gjeneruar gjithmonë do të normalizohet me Z dhe do të përdorë 0, 3, 6 ose 9 shifra të pjesshme. Kompensimet e tjera përveç "Z" pranohen gjithashtu. Shembuj: "2014-10-02T15:01:23Z" , "2014-10-02T15:01:23.045123456Z" ose "2014-10-02T15:01:23+05:30" .

batch.updateTime string ( Timestamp format)

Vetëm dalje. Koha në të cilën grupi u përditësua për herë të fundit.

Përdor RFC 3339, ku prodhimi i gjeneruar gjithmonë do të normalizohet me Z dhe do të përdorë 0, 3, 6 ose 9 shifra të pjesshme. Kompensimet e tjera përveç "Z" pranohen gjithashtu. 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 dalje. Statistikat në lidhje me grupin.

numër batch.state enum ( BatchState )

Vetëm dalje. Gjendja e grupit.

vargu batch.priority string ( int64 format)

Fakultative. Prioriteti i grupit. Grupet me vlerë prioritare më të lartë do të përpunohen përpara grupeve me vlerë prioritare më të ulët. Vlerat negative janë të lejuara. Parazgjedhja është 0.

Trupi i reagimit

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

GenerateContentRequest

Kërkoni 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 modelen.

Për pyetjet me një kthesë, ky është një shembull i vetëm. Për pyetjet me shumë kthesa si chat , kjo është një fushë e përsëritur që përmban historikun e bisedave dhe kërkesën më të fundit.

tools[] object ( Tool )

Fakultative. Një listë e Tools Model mund të përdorë për të gjeneruar përgjigjen e radhës.

Një Tool është një pjesë kodi që i mundëson sistemit të ndërveprojë me sisteme të jashtme për të kryer një veprim, ose grup veprimesh, jashtë njohurive dhe qëllimit të Model . Tool e mbështetura janë Function dhe codeExecution . Referojuni thirrjes së funksionit dhe udhëzuesve të ekzekutimit të kodit për të mësuar më shumë.

Objekti toolConfig object ( ToolConfig )

Fakultative. Konfigurimi i mjetit për çdo Tool të specifikuar në kërkesë. Referojuni udhëzuesit për thirrjen e funksionit për një shembull përdorimi.

objekti safetySettings[] object ( SafetySetting )

Fakultative. Një listë e rasteve unike të 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 çdo lloj SafetyCategory . API do të bllokojë çdo përmbajtje dhe përgjigje që nuk arrin të përmbushë kufijtë e vendosur nga këto cilësime. Kjo listë anashkalon cilësimet e paracaktuara për secilën SafetyCategory të specifikuar në Cilësimet e sigurisë. Nëse nuk ka SafetySetting për një SafetyCategory të dhënë në listë, API do të përdorë cilësimin e paracaktuar të sigurisë për atë kategori. Kategoritë e dëmtimit HARM_CATEGORY_HATE_SPEECH, HARM_CATEGORY_SEXUALLY_EXPLICIT, HARM_CATEGORY_DANGEROUS_CONTENT, HARM_CATEGORY_HARASSMENT, HARM_CATEGORY_CIVIC_INTEGRITY mbështeten. Referojuni udhëzuesit për informacion të detajuar mbi cilësimet e disponueshme të sigurisë. Referojuni gjithashtu udhëzimit të sigurisë për të mësuar se si të përfshini konsideratat e sigurisë në aplikacionet tuaja të AI.

Sistemi i objektit systemInstruction object ( Content )

Fakultative. Udhëzimet e sistemit të grupit të zhvilluesit. Aktualisht, vetëm tekst.

generationConfig object ( GenerationConfig )

Fakultative. Opsionet e konfigurimit për gjenerimin e modelit dhe daljet.

string cachedContent

Fakultative. Emri i përmbajtjes së memorizuar për t'u përdorur 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
}

Metoda: modele.asyncBatchEmbedContent

Vendos në radhë një grup models.embedContent për përmbajtje për përpunim grupor. Ne kemi një mbajtës models.batchEmbedContents në GenerativeService , por ai u sinkronizua. Pra, ne e quajmë këtë të jetë Async për të shmangur konfuzionin.

Pika përfundimtare

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

Parametrat e rrugës

batch.model string

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

Formati: models/{model} . Ajo 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
batch.name string

Vetëm dalje. Identifikues. Emri i burimit të grupit.

Formati: batches/{batchId} .

string batch.displayName Emri

E detyrueshme. Emri i përcaktuar nga përdoruesi i kësaj baze.

Objekti batch.inputConfig object ( InputEmbedContentConfig )

E detyrueshme. Konfigurimi i hyrjes së rasteve në të cilat kryhet përpunimi në grup.

object ( EmbedContentBatchOutput ) batch.output ( EmbedContentBatchOutput )

Vetëm dalje. Prodhimi i kërkesës së grupit.

vargu batch.createTime string ( Timestamp format)

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

Përdor RFC 3339, ku prodhimi i gjeneruar gjithmonë do të normalizohet me Z dhe do të përdorë 0, 3, 6 ose 9 shifra të pjesshme. Kompensimet e tjera përveç "Z" pranohen gjithashtu. Shembuj: "2014-10-02T15:01:23Z" , "2014-10-02T15:01:23.045123456Z" ose "2014-10-02T15:01:23+05:30" .

Vargu batch.endTime string ( Timestamp format)

Vetëm dalje. Koha në të cilën përfundoi përpunimi i grupit.

Përdor RFC 3339, ku prodhimi i gjeneruar gjithmonë do të normalizohet me Z dhe do të përdorë 0, 3, 6 ose 9 shifra të pjesshme. Kompensimet e tjera përveç "Z" pranohen gjithashtu. Shembuj: "2014-10-02T15:01:23Z" , "2014-10-02T15:01:23.045123456Z" ose "2014-10-02T15:01:23+05:30" .

batch.updateTime string ( Timestamp format)

Vetëm dalje. Koha në të cilën grupi u përditësua për herë të fundit.

Përdor RFC 3339, ku prodhimi i gjeneruar gjithmonë do të normalizohet me Z dhe do të përdorë 0, 3, 6 ose 9 shifra të pjesshme. Kompensimet e tjera përveç "Z" pranohen gjithashtu. 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 dalje. Statistikat në lidhje me grupin.

numër batch.state enum ( BatchState )

Vetëm dalje. Gjendja e grupit.

vargu batch.priority string ( int64 format)

Fakultative. Prioriteti i grupit. Grupet me vlerë prioritare më të lartë do të përpunohen përpara grupeve me vlerë prioritare më të ulët. Vlerat negative janë të lejuara. Parazgjedhja është 0.

Trupi i reagimit

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

EmbedContentRequest

Kërkesë që përmban Content që modeli të futet.

Fushat
string model

E detyrueshme. Emri i burimit të modelit. Kjo shërben si një ID për Modelin për t'u përdorur.

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

Formati: models/{model}

objekti content object ( Content )

E detyrueshme. Përmbajtja për t'u integruar. Do të numërohen vetëm parts.text e tekstit.

taskType enum ( TaskType )

Fakultative. Lloji opsional i detyrës për të cilin do të përdoren futjet. Nuk mbështetet në modelet e mëparshme ( models/embedding-001 ).

string title

Fakultative. Një titull opsional për tekstin. Zbatohet vetëm kur lloji i detyrës është RETRIEVAL_DOCUMENT .

Shënim: Përcaktimi i një title për RETRIEVAL_DOCUMENT ofron ngulitje me cilësi më të mirë për rikthim.

outputDimensionality integer

Fakultative. Dimensioni opsional i reduktuar për futjen e daljes. Nëse vendoset, vlerat e tepërta në futjen e daljes shkurtohen nga fundi. Mbështetur nga modele më të reja vetëm që nga viti 2024. Ju nuk mund ta vendosni 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: 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.

GenerateContentBatch

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 dalje. Identifikues. Emri i burimit të grupit.

Formati: batches/{batchId} .

string displayName

E detyrueshme. Emri i përcaktuar nga përdoruesi i kësaj baze.

object ( InputConfig ) inputConfig (InputConfig)

E detyrueshme. Konfigurimi i hyrjes së rasteve në të cilat kryhet përpunimi në grup.

objekti output object ( GenerateContentBatchOutput )

Vetëm dalje. Prodhimi i kërkesës së grupit.

createTime string ( Timestamp format)

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

Përdor RFC 3339, ku prodhimi i gjeneruar gjithmonë do të normalizohet me Z dhe do të përdorë 0, 3, 6 ose 9 shifra të pjesshme. Kompensimet e tjera përveç "Z" pranohen gjithashtu. Shembuj: "2014-10-02T15:01:23Z" , "2014-10-02T15:01:23.045123456Z" ose "2014-10-02T15:01:23+05:30" .

vargu endTime string ( Timestamp format)

Vetëm dalje. Koha në të cilën përfundoi përpunimi i grupit.

Përdor RFC 3339, ku prodhimi i gjeneruar gjithmonë do të normalizohet me Z dhe do të përdorë 0, 3, 6 ose 9 shifra të pjesshme. Kompensimet e tjera përveç "Z" pranohen gjithashtu. 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 dalje. Koha në të cilën grupi u përditësua për herë të fundit.

Përdor RFC 3339, ku prodhimi i gjeneruar gjithmonë do të normalizohet me Z dhe do të përdorë 0, 3, 6 ose 9 shifra të pjesshme. Kompensimet e tjera përveç "Z" pranohen gjithashtu. 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 dalje. Statistikat në lidhje me grupin.

numri i state enum ( BatchState )

Vetëm dalje. Gjendja e grupit.

vargu priority string ( int64 format)

Fakultative. Prioriteti i grupit. Grupet me vlerë prioritare më të lartë do të përpunohen përpara grupeve me vlerë prioritare më të ulët. Vlerat negative janë të lejuara. Parazgjedhja ë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 hyrjen në kërkesën e grupit.

Fushat
source Union type
E detyrueshme. Burimi i hyrjes. source mund të jetë vetëm një nga sa vijon:
fileName string

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

objekti requests object ( InlinedRequests )

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

Përfaqësimi JSON 
{

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

InlinedRequests

Kërkesat për t'u përpunuar në grup nëse ofrohen si pjesë e kërkesës për krijimin e grupit.

Fushat
requests[] object ( InlinedRequest )

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

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

InlinedRequest

Kërkesa për t'u përpunuar në grup.

Fushat
objekti request object ( GenerateContentRequest )

E detyrueshme. Kërkesa për t'u përpunuar në grup.

object ( Struct format) metadata (Formati i strukturës)

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

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

GenerateContentBatchOutput

Prodhimi i një kërkese grupi. Kjo kthehet në fushën BatchGenerateContentResponse ose GenerateContentBatch.output .

Fushat
Union type output
Prodhimi i kërkesës së grupit. output mund të jetë vetëm një nga sa vijon:
responsesFile string

Vetëm dalje. ID-ja e skedarit të 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 mënyrë si kërkesat hyrëse.

object ( InlinedResponses ) inlinedResponses (InlinedResponses)

Vetëm dalje. Përgjigjet ndaj kërkesave në grup. U kthye kur grupi u ndërtua duke përdorur kërkesa të rreshtuara. Përgjigjet do të jenë në të njëjtin rend si kërkesat e hyrjes.

Përfaqësimi JSON 
{

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

Inlined Responses

Përgjigjet ndaj kërkesave në grup.

Fushat
inlinedResponses[] object ( InlinedResponse )

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

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

Inlined Response

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

Fushat
object ( Struct format) metadata (Formati i strukturës)

Vetëm dalje. Meta të dhënat e lidhura me kërkesën.

Union type output
Prodhimi i kërkesës. output mund të jetë vetëm një nga sa vijon:
error object ( Status )

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

objekti response object ( GenerateContentResponse )

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

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

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

BatchStats

Statistikat në lidhje me grupin.

Fushat
Vargu i requestCount string ( int64 format)

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

vargu successfulRequestCount string ( int64 format)

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

string ( int64 format) failedRequestCount (format int64)

Vetëm dalje. Numri i kërkesave që nuk u përpunuan.

pendingRequestCount string ( int64 format)

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

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

EmbedContentBatch

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

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 dalje. Identifikues. Emri i burimit të grupit.

Formati: batches/{batchId} .

string displayName

E detyrueshme. Emri i përcaktuar nga përdoruesi i kësaj baze.

object ( InputEmbedContentConfig ) inputConfig (InputEmbedContentConfig)

E detyrueshme. Konfigurimi i hyrjes së rasteve në të cilat kryhet përpunimi në grup.

objekti output object ( EmbedContentBatchOutput )

Vetëm dalje. Prodhimi i kërkesës së grupit.

createTime string ( Timestamp format)

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

Përdor RFC 3339, ku prodhimi i gjeneruar gjithmonë do të normalizohet me Z dhe do të përdorë 0, 3, 6 ose 9 shifra të pjesshme. Kompensimet e tjera përveç "Z" pranohen gjithashtu. Shembuj: "2014-10-02T15:01:23Z" , "2014-10-02T15:01:23.045123456Z" ose "2014-10-02T15:01:23+05:30" .

vargu endTime string ( Timestamp format)

Vetëm dalje. Koha në të cilën përfundoi përpunimi i grupit.

Përdor RFC 3339, ku prodhimi i gjeneruar gjithmonë do të normalizohet me Z dhe do të përdorë 0, 3, 6 ose 9 shifra të pjesshme. Kompensimet e tjera përveç "Z" pranohen gjithashtu. 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 dalje. Koha në të cilën grupi u përditësua për herë të fundit.

Përdor RFC 3339, ku prodhimi i gjeneruar gjithmonë do të normalizohet me Z dhe do të përdorë 0, 3, 6 ose 9 shifra të pjesshme. Kompensimet e tjera përveç "Z" pranohen gjithashtu. Shembuj: "2014-10-02T15:01:23Z" , "2014-10-02T15:01:23.045123456Z" ose "2014-10-02T15:01:23+05:30" .

object ( EmbedContentBatchStats ) batchStats ( EmbedContentBatchStats )

Vetëm dalje. Statistikat në lidhje me grupin.

numri i state enum ( BatchState )

Vetëm dalje. Gjendja e grupit.

vargu priority string ( int64 format)

Fakultative. Prioriteti i grupit. Grupet me vlerë prioritare më të lartë do të përpunohen përpara grupeve me vlerë prioritare më të ulët. Vlerat negative janë të lejuara. Parazgjedhja është 0.

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

InputEmbedContentConfig

Konfiguron hyrjen në kërkesën e grupit.

Fushat
source Union type
E detyrueshme. Burimi i hyrjes. source mund të jetë vetëm një nga sa vijon:
fileName string

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

objekti requests object ( InlinedEmbedContentRequests )

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

Përfaqësimi JSON 
{

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

InlinedEmbedContentRequests

Kërkesat për t'u përpunuar në grup nëse ofrohen si pjesë e kërkesës për krijimin e grupit.

Fushat
requests[] object ( InlinedEmbedContentRequest )

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

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

InlinedEmbedContentRequest

Kërkesa për t'u përpunuar në grup.

Fushat
objekti request object ( EmbedContentRequest )

E detyrueshme. Kërkesa për t'u përpunuar në grup.

object ( Struct format) metadata (Formati i strukturës)

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

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

EmbedContentBatchOutput

Prodhimi i një kërkese grupi. Kjo kthehet në fushën AsyncBatchEmbedContentResponse ose në fushën EmbedContentBatch.output .

Fushat
Union type output
Prodhimi i kërkesës së grupit. output mund të jetë vetëm një nga sa vijon:
responsesFile string

Vetëm dalje. ID-ja e skedarit të 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 EmbedContentResponse të formatuara si JSON. Përgjigjet do të shkruhen në të njëjtën mënyrë si kërkesat hyrëse.

object ( InlinedEmbedContentResponses ) inlinedResponses (InlinedEmbedContentResponses)

Vetëm dalje. Përgjigjet ndaj kërkesave në grup. U kthye kur grupi u ndërtua duke përdorur kërkesa të rreshtuara. Përgjigjet do të jenë në të njëjtin rend si kërkesat e hyrjes.

Përfaqësimi JSON 
{

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

InlinedEmbedContent Responses

Përgjigjet ndaj kërkesave në grup.

Fushat
inlinedResponses[] object ( InlinedEmbedContentResponse )

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

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

InlinedEmbedContentResponse

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

Fushat
object ( Struct format) metadata (Formati i strukturës)

Vetëm dalje. Meta të dhënat e lidhura me kërkesën.

Union type output
Prodhimi i kërkesës. output mund të jetë vetëm një nga sa vijon:
error object ( Status )

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

objekti response object ( EmbedContentResponse )

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

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

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

EmbedContentBatchStats

Statistikat në lidhje me grupin.

Fushat
Vargu i requestCount string ( int64 format)

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

vargu successfulRequestCount string ( int64 format)

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

string ( int64 format) failedRequestCount (format int64)

Vetëm dalje. Numri i kërkesave që nuk u përpunuan.

pendingRequestCount string ( int64 format)

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

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

BatchState

Gjendja e grupit.

Enums
BATCH_STATE_UNSPECIFIED Gjendja e grupit është e paspecifikuar.
BATCH_STATE_PENDING Shërbimi po përgatitet të ekzekutojë grupin.
BATCH_STATE_RUNNING Grupi është në proces.
BATCH_STATE_SUCCEEDED Grupi përfundoi me sukses.
BATCH_STATE_FAILED Grupi dështoi.
BATCH_STATE_CANCELLED Grupi është anuluar.
BATCH_STATE_EXPIRED Grupi ka skaduar.

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
}